1.0.13.18: Revived OpenBSD support, contributed by Josh Elsasser
[sbcl.git] / src / compiler / x86 / parms.lisp
index d4cda72..67655cd 100644 (file)
@@ -13,9 +13,6 @@
 
 (in-package "SB!VM")
 
-(file-comment
- "$Header$")
-
 ;;; ### Note: we simultaneously use ``word'' to mean a 32 bit quantity
 ;;; and a 16 bit quantity depending on context. This is because Intel
 ;;; insists on calling 16 bit things words and 32 bit things
 \f
 ;;;; machine architecture parameters
 
-(eval-when (:compile-toplevel :load-toplevel :execute)
-
-(defconstant word-bits 32
-  #!+sb-doc
-  "Number of bits per word where a word holds one lisp descriptor.")
-
-(defconstant byte-bits 8
-  #!+sb-doc
-  "Number of bits per byte where a byte is the smallest addressable object.")
-
-(defconstant word-shift (1- (integer-length (/ word-bits byte-bits)))
-  #!+sb-doc
-  "Number of bits to shift between word addresses and byte addresses.")
-
-(defconstant word-bytes (/ word-bits byte-bits)
-  #!+sb-doc
-  "Number of bytes in a word.")
-
-) ; EVAL-WHEN
-
-(eval-when (:compile-toplevel :load-toplevel :execute)
-(defconstant float-sign-shift 31)
-
-;; These values were taken from the alpha code. The values for
-;; bias and exponent min/max are not the same as shown in the 486 book.
-;; They may be correct for how Python uses them.
-(defconstant single-float-bias 126)    ; Intel says 127
-(defconstant single-float-exponent-byte (byte 8 23))
-(defconstant single-float-significand-byte (byte 23 0))
-;; The 486 book shows the exponent range -126 to +127. The Lisp
-;; code that uses these values seems to want already biased numbers.
-(defconstant single-float-normal-exponent-min 1)
-(defconstant single-float-normal-exponent-max 254)
-(defconstant single-float-hidden-bit (ash 1 23))
-(defconstant single-float-trapping-nan-bit (ash 1 22))
-
-(defconstant double-float-bias 1022)
-(defconstant double-float-exponent-byte (byte 11 20))
-(defconstant double-float-significand-byte (byte 20 0))
-(defconstant double-float-normal-exponent-min 1)
-(defconstant double-float-normal-exponent-max #x7FE)
-(defconstant double-float-hidden-bit (ash 1 20))
-(defconstant double-float-trapping-nan-bit (ash 1 19))
-
-(defconstant long-float-bias 16382)
-(defconstant long-float-exponent-byte (byte 15 0))
-(defconstant long-float-significand-byte (byte 31 0))
-(defconstant long-float-normal-exponent-min 1)
-(defconstant long-float-normal-exponent-max #x7FFE)
-(defconstant long-float-hidden-bit (ash 1 31))         ; Actually not hidden
-(defconstant long-float-trapping-nan-bit (ash 1 30))
-
-(defconstant single-float-digits
+;;; the number of bits per word, where a word holds one lisp descriptor
+(def!constant n-word-bits 32)
+
+;;; the natural width of a machine word (as seen in e.g. register width,
+;;; address space)
+(def!constant n-machine-word-bits 32)
+
+;;; the number of bits per byte, where a byte is the smallest
+;;; addressable object
+(def!constant n-byte-bits 8)
+
+;;; The minimum immediate offset in a memory-referencing instruction.
+(def!constant minimum-immediate-offset (- (expt 2 31)))
+
+;;; The maximum immediate offset in a memory-referencing instruction.
+(def!constant maximum-immediate-offset (1- (expt 2 31)))
+
+(def!constant float-sign-shift 31)
+
+;;; comment from CMU CL:
+;;;   These values were taken from the alpha code. The values for
+;;;   bias and exponent min/max are not the same as shown in the 486 book.
+;;;   They may be correct for how Python uses them.
+(def!constant single-float-bias 126)    ; Intel says 127.
+(defconstant-eqx single-float-exponent-byte    (byte 8 23) #'equalp)
+(defconstant-eqx single-float-significand-byte (byte 23 0) #'equalp)
+;;; comment from CMU CL:
+;;;   The 486 book shows the exponent range -126 to +127. The Lisp
+;;;   code that uses these values seems to want already biased numbers.
+(def!constant single-float-normal-exponent-min 1)
+(def!constant single-float-normal-exponent-max 254)
+(def!constant single-float-hidden-bit (ash 1 23))
+(def!constant single-float-trapping-nan-bit (ash 1 22))
+
+(def!constant double-float-bias 1022)
+(defconstant-eqx double-float-exponent-byte    (byte 11 20) #'equalp)
+(defconstant-eqx double-float-significand-byte (byte 20 0)  #'equalp)
+(def!constant double-float-normal-exponent-min 1)
+(def!constant double-float-normal-exponent-max #x7FE)
+(def!constant double-float-hidden-bit (ash 1 20))
+(def!constant double-float-trapping-nan-bit (ash 1 19))
+
+(def!constant long-float-bias 16382)
+(defconstant-eqx long-float-exponent-byte    (byte 15 0) #'equalp)
+(defconstant-eqx long-float-significand-byte (byte 31 0) #'equalp)
+(def!constant long-float-normal-exponent-min 1)
+(def!constant long-float-normal-exponent-max #x7FFE)
+(def!constant long-float-hidden-bit (ash 1 31))         ; actually not hidden
+(def!constant long-float-trapping-nan-bit (ash 1 30))
+
+(def!constant single-float-digits
   (+ (byte-size single-float-significand-byte) 1))
 
-(defconstant double-float-digits
-  (+ (byte-size double-float-significand-byte) word-bits 1))
-
-(defconstant long-float-digits
-  (+ (byte-size long-float-significand-byte) word-bits 1))
-
-;;; pfw -- from i486 microprocessor programmers reference manual
-(defconstant float-invalid-trap-bit    (ash 1 0))
-(defconstant float-denormal-trap-bit       (ash 1 1))
-(defconstant float-divide-by-zero-trap-bit (ash 1 2))
-(defconstant float-overflow-trap-bit       (ash 1 3))
-(defconstant float-underflow-trap-bit      (ash 1 4))
-(defconstant float-inexact-trap-bit    (ash 1 5))
-
-(defconstant float-round-to-nearest  0)
-(defconstant float-round-to-negative 1)
-(defconstant float-round-to-positive 2)
-(defconstant float-round-to-zero     3)
-
-(defconstant float-rounding-mode   (byte 2 10))
-(defconstant float-sticky-bits     (byte 6 16))
-(defconstant float-traps-byte      (byte 6  0))
-(defconstant float-exceptions-byte (byte 6 16))
-(defconstant float-precision-control (byte 2 8))
-(defconstant float-fast-bit 0) ; No fast mode on x86
-
-); EVAL-WHEN
+(def!constant double-float-digits
+  (+ (byte-size double-float-significand-byte) n-word-bits 1))
+
+(def!constant long-float-digits
+  (+ (byte-size long-float-significand-byte) n-word-bits 1))
+
+;;; pfw -- from i486 microprocessor programmer's reference manual
+(def!constant float-invalid-trap-bit       (ash 1 0))
+(def!constant float-denormal-trap-bit       (ash 1 1))
+(def!constant float-divide-by-zero-trap-bit (ash 1 2))
+(def!constant float-overflow-trap-bit       (ash 1 3))
+(def!constant float-underflow-trap-bit      (ash 1 4))
+(def!constant float-inexact-trap-bit       (ash 1 5))
+
+(def!constant float-round-to-nearest  0)
+(def!constant float-round-to-negative 1)
+(def!constant float-round-to-positive 2)
+(def!constant float-round-to-zero     3)
+
+(def!constant float-precision-24-bit 0)
+(def!constant float-precision-53-bit 2)
+(def!constant float-precision-64-bit 3)
+
+(defconstant-eqx float-rounding-mode     (byte 2 10) #'equalp)
+(defconstant-eqx float-sticky-bits       (byte 6 16) #'equalp)
+(defconstant-eqx float-traps-byte        (byte 6  0) #'equalp)
+(defconstant-eqx float-exceptions-byte   (byte 6 16) #'equalp)
+(defconstant-eqx float-precision-control (byte 2  8) #'equalp)
+(def!constant float-fast-bit 0) ; no fast mode on x86
 \f
 ;;;; description of the target address space
 
 ;;; where to put the different spaces
 ;;;
-;;; FIXME: Couldn't/shouldn't these be DEFCONSTANT instead of DEFPARAMETER?
-;;;
-;;; FIXME: Since SBCL has a different way of distinguishing between target
-;;; and host than the old CMU CL code used, the "TARGET-" prefix is
-;;; redundant. Perhaps each *TARGET-FOO* should become *FOO*, probably
-;;; at the same time that we unscrew the kludgy way that constants are
-;;; duplicated between this file and runtime/x86-validate.h.
-;;;
 ;;; Note: Mostly these values are black magic, inherited from CMU CL
 ;;; without any documentation. However, there were a few explanatory
 ;;; comments in the CMU CL sources:
 ;;;   * On FreeBSD,
 ;;;     ** The space 0x0E000000-0x10000000 is "Foreign segment".
 ;;;     ** The space 0x20000000-0x30000000 is reserved for shared libs.
-;;; And there have been a few changes since the fork:
+;;; And there have been some changes since the fork from CMU CL:
+;;;   * The OpenBSD port is new since the fork. We started with
+;;;     the FreeBSD address map, which actually worked until the
+;;;     Alpha port patches, for reasons which in retrospect are rather
+;;;     mysterious. After the Alpha port patches were added, the
+;;;     OpenBSD port suffered memory corruption problems. While
+;;;     debugging those, it was discovered that src/runtime/trymap
+;;;     failed for the control stack region #x40000000-#x47fff000.
+;;;     After the control stack was moved upward out of this region
+;;;     (stealing some bytes from dynamic space) the problems went
+;;;     away.
 ;;;   * The FreeBSD STATIC-SPACE-START value was bumped up from
 ;;;     #x28000000 to #x30000000 when FreeBSD ld.so dynamic linking
 ;;;     support was added for FreeBSD ca. 20000910. This was to keep from
-;;;     stomping on an address range that the dynamic libraries want to use. 
-;;;     (They want to use this address range even if we try to reserve it
-;;;     with a call to validate() as the first operation in main().)
+;;;     stomping on an address range that the dynamic libraries want to
+;;;     use. (They want to use this address range even if we try to
+;;;     reserve it with a call to validate() as the first operation in
+;;;     main().)
+;;;   * For NetBSD 2.0, the following ranges are used by normal
+;;;     executables and mmap:
+;;;     ** Executables are (by default) loaded at 0x08048000.
+;;;     ** The break for the sbcl runtime seems to end around 0x08400000
+;;;     We set read only space around 0x20000000, static
+;;;     space around 0x30000000, all ending below 0x37fff000
+;;;     ** ld.so and other mmap'ed stuff like shared libs start around
+;;;        0x48000000
+;;;     We set dynamic space between 0x60000000 and 0x98000000
+;;;     ** Bottom of the stack is typically not below 0xb0000000
+;;;     FYI, this can be looked at with the "pmap" program, and if you
+;;;     set the top-down mmap allocation option in the kernel (not yet
+;;;     the default), all bets are totally off!
+;;;   * For FreeBSD, the requirement of user and kernel space are
+;;;     getting larger, and users tend to extend them.
+;;;     If MAXDSIZ is extended from 512MB to 1GB, we can't use up to
+;;;     around 0x50000000.
+;;;     And if KVA_PAGES is extended from 1GB to 1.5GB, we can't use
+;;;     down to around 0xA0000000.
+;;;     So we use 0x58000000--0x98000000 for dynamic space.
+;;;   * OpenBSD address space changes for W^X as well as malloc
+;;;     randomization made the old addresses unsafe. The only range
+;;;     that is really safe is between the end of the text segment (it
+;;;     starts at #x3C000000) and #x7C000000. However if the -Z linker
+;;;     option is used then the safe range is (probably) #x00001000 to
+;;;     #x48048000, with the text and data segments at #x08048000.
+
+#!+win32
+(progn
+
+  (def!constant read-only-space-start #x02000000)
+  (def!constant read-only-space-end   #x020ff000)
+
+  (def!constant static-space-start    #x02100000)
+  (def!constant static-space-end      #x021ff000)
+
+  (def!constant dynamic-space-start   #x09000000)
+  (def!constant dynamic-space-end     #x29000000)
+
+  (def!constant linkage-table-space-start #x02200000)
+  (def!constant linkage-table-space-end   #x022ff000))
 
 #!+linux
 (progn
+  (def!constant read-only-space-start     #x01000000)
+  (def!constant read-only-space-end       #x010ff000)
+
+  (def!constant static-space-start        #x01100000)
+  (def!constant static-space-end          #x011ff000)
+
+  (def!constant dynamic-space-start       #x09000000)
+  (def!constant dynamic-space-end         #x29000000)
+
+  (def!constant linkage-table-space-start #x01200000)
+  (def!constant linkage-table-space-end   #x012ff000))
+
+#!+sunos
+(progn
+  (def!constant read-only-space-start     #x20000000)
+  (def!constant read-only-space-end       #x200ff000)
 
-  (defconstant read-only-space-start #x01000000)
-  (defconstant read-only-space-end   #x037ff000)
+  (def!constant static-space-start        #x20100000)
+  (def!constant static-space-end          #x201ff000)
 
-  (defconstant static-space-start    #x05000000)
-  (defconstant static-space-end      #x07fff000)
+  (def!constant dynamic-space-start       #x48000000)
+  (def!constant dynamic-space-end         #xA0000000)
 
-  (defconstant dynamic-space-start   #x09000000)
-  (defconstant dynamic-space-end     #x29000000)
+  (def!constant linkage-table-space-start #x20200000)
+  (def!constant linkage-table-space-end   #x202ff000))
 
-  (defconstant control-stack-start   #x50000000)
-  (defconstant control-stack-end     #x57fff000)
+#!+freebsd
+(progn
+  (def!constant read-only-space-start     #x01000000)
+  (def!constant read-only-space-end       #x010ff000)
+
+  (def!constant static-space-start        #x01100000)
+  (def!constant static-space-end          #x011ff000)
 
-  (defconstant binding-stack-start   #x60000000)
-  (defconstant binding-stack-end     #x67fff000))
+  (def!constant dynamic-space-start       #x58000000)
+  (def!constant dynamic-space-end         #x98000000)
 
-#!+bsd
+  (def!constant linkage-table-space-start #x01200000)
+  (def!constant linkage-table-space-end   #x012ff000))
+
+#!+openbsd
 (progn
+  (def!constant read-only-space-start     #x7b000000)
+  (def!constant read-only-space-end       #x7b0ff000)
+
+  (def!constant static-space-start        #x7b100000)
+  (def!constant static-space-end          #x7b1ff000)
 
-  (defconstant read-only-space-start #x10000000)
-  (defconstant read-only-space-end   #x1ffff000)
+  (def!constant dynamic-space-start       #x4c000000)
+  (def!constant dynamic-space-end         #x7b0ff000)
+
+  ;; In CMUCL: 0xB0000000->0xB1000000
+  (def!constant linkage-table-space-start #x7b200000)
+  (def!constant linkage-table-space-end   #x7b2ff000))
+
+#!+netbsd
+(progn
+  (def!constant read-only-space-start     #x20000000)
+  (def!constant read-only-space-end       #x200ff000)
+
+  (def!constant static-space-start        #x20100000)
+  (def!constant static-space-end          #x201ff000)
+
+  (def!constant dynamic-space-start       #x60000000)
+  (def!constant dynamic-space-end         #x98000000)
+
+  ;; In CMUCL: 0xB0000000->0xB1000000
+  (def!constant linkage-table-space-start #x20200000)
+  (def!constant linkage-table-space-end   #x202ff000))
+
+
+#!+darwin
+(progn
+  (def!constant read-only-space-start #x04000000)
+  (def!constant read-only-space-end   #x040ff000)
 
-  (defconstant static-space-start
-    #!+freebsd #x30000000
-    #!+openbsd #x28000000)
-  (defconstant static-space-end      #x37fff000)
+  (def!constant static-space-start    #x04100000)
+  (def!constant static-space-end      #x041ff000)
 
-  (defconstant binding-stack-start   #x38000000)
-  (defconstant binding-stack-end     #x3ffff000)
+  (def!constant dynamic-space-start #x10000000)
+  (def!constant dynamic-space-end   #x6ffff000)
 
-  (defconstant control-stack-start   #x40000000)
-  (defconstant control-stack-end     #x47fff000)
+  (def!constant linkage-table-space-start #x04200000)
+  (def!constant linkage-table-space-end   #x042ff000))
 
-  (defconstant dynamic-space-start   #x48000000)
-  (defconstant dynamic-space-end     #x88000000))
+;;; Size of one linkage-table entry in bytes.
+(def!constant linkage-table-entry-size 8)
 
 ;;; Given that NIL is the first thing allocated in static space, we
 ;;; know its value at compile time:
-(defconstant nil-value (+ static-space-start #xb))
+(def!constant nil-value (+ static-space-start #xb))
 \f
 ;;;; other miscellaneous constants
 
   error
   cerror
   breakpoint
-  function-end-breakpoint
-  single-step-breakpoint)
-;;; FIXME: It'd be nice to replace all the DEFENUMs with something
-;;; a la
+  fun-end-breakpoint
+  single-step-around
+  single-step-before)
+;;; FIXME: It'd be nice to replace all the DEFENUMs with something like
 ;;;   (WITH-DEF-ENUM (:START 8)
 ;;;     (DEF-ENUM HALT-TRAP)
 ;;;     (DEF-ENUM PENDING-INTERRUPT-TRAP)
 ;;; for the benefit of anyone doing a lexical search for definitions
 ;;; of these symbols.
 
-(defenum (:prefix object-not- :suffix -trap :start 16)
+(defenum (:prefix object-not- :suffix -trap :start 24)
   list
   instance)
 
 (defenum (:prefix trace-table-)
   normal
   call-site
-  function-prologue
-  function-epilogue)
+  fun-prologue
+  fun-epilogue)
 \f
 ;;;; static symbols
 
 ;;;     Note these spaces grow from low to high addresses.
 (defvar *allocation-pointer*)
 (defvar *binding-stack-pointer*)
-(defvar *x86-cgc-active-p*) ; FIXME: Document this.
-(defvar *static-blue-bag* nil)
 
-;;; FIXME: *!INITIAL-FDEFN-OBJECTS* and !COLD-INIT probably don't need
-;;; to be in the static symbols table any more. Also, if
-;;; *INTERNAL-GC-TRIGGER* really is not used, we can punt it.
 (defparameter *static-symbols*
-  '(t
-
-    ;; The C startup code must fill these in.
-    *posix-argv*
-    sb!impl::*!initial-fdefn-objects*
-
-    ;; functions that the C code needs to call
-    sb!impl::!cold-init
-    sb!impl::maybe-gc
-    sb!kernel::internal-error
-    sb!di::handle-breakpoint
-    sb!impl::fdefinition-object
-
-    ;; free pointers
-    ;; 
-    ;; Note that these are FIXNUM word counts, not (as one might
-    ;; expect) byte counts or SAPs. The reason seems to be that by
-    ;; representing them this way, we can avoid consing bignums. 
-    ;; -- WHN 2000-10-02
-    *read-only-space-free-pointer*
-    *static-space-free-pointer*
-    *initial-dynamic-space-free-pointer*
-
-    ;; things needed for non-local exit
-    sb!impl::*current-catch-block*
-    sb!impl::*current-unwind-protect-block*
-    sb!c::*eval-stack-top*
-    sb!vm::*alien-stack*
-
-    ;; interrupt handling
-    sb!impl::*pseudo-atomic-atomic*
-    sb!impl::*pseudo-atomic-interrupted*
-    sb!unix::*interrupts-enabled*
-    sb!unix::*interrupt-pending*
-    sb!impl::*free-interrupt-context-index*
-
-    sb!vm::*allocation-pointer*
-    sb!vm::*binding-stack-pointer*
-    sb!vm::*internal-gc-trigger*   ; Not used.
-
-    ;; the floating point constants
-    sb!vm::*fp-constant-0d0*
-    sb!vm::*fp-constant-1d0*
-    sb!vm::*fp-constant-0s0*
-    sb!vm::*fp-constant-1s0*
-    ;; The following are all long-floats.
-    sb!vm::*fp-constant-0l0*
-    sb!vm::*fp-constant-1l0*
-    sb!vm::*fp-constant-pi*
-    sb!vm::*fp-constant-l2t*
-    sb!vm::*fp-constant-l2e*
-    sb!vm::*fp-constant-lg2*
-    sb!vm::*fp-constant-ln2*
-
-    ;; used by gencgc
-    sb!vm::*scavenge-read-only-space*
-
-    ;; The ..SLOT-UNBOUND.. symbol is static in order to optimise the
-    ;; common slot unbound check.
-    sb!pcl::..slot-unbound..
-
-    ;; spare symbols
-    sb!vm::spare-10
-    sb!vm::spare-9
-    sb!vm::spare-8
-    sb!vm::spare-7
-    sb!vm::spare-6
-    sb!vm::spare-5
-    sb!vm::spare-4
-    sb!vm::spare-3
-    sb!vm::spare-2
-    sb!vm::spare-1
-
-    ;; used by cgc
-    sb!vm::*x86-cgc-active-p*
-    sb!vm::*static-blue-bag*           ; must be last or change C code
-    ))
-
-(defparameter *static-functions*
+  (append
+   *common-static-symbols*
+   *c-callable-static-symbols*
+   '(*alien-stack*
+
+     ;; interrupt handling
+     *pseudo-atomic-bits*
+     #!+sb-thread *stop-for-gc-pending*
+     #!+sb-thread *free-tls-index*
+     #!+sb-thread *tls-index-lock*
+
+     *allocation-pointer*
+     *binding-stack-pointer*
+
+     ;; the floating point constants
+     *fp-constant-0d0*
+     *fp-constant-1d0*
+     *fp-constant-0f0*
+     *fp-constant-1f0*
+     ;; The following are all long-floats.
+     *fp-constant-0l0*
+     *fp-constant-1l0*
+     *fp-constant-pi*
+     *fp-constant-l2t*
+     *fp-constant-l2e*
+     *fp-constant-lg2*
+     *fp-constant-ln2*
+
+     ;; For GC-AND-SAVE
+     *restart-lisp-function*
+
+     ;; For the UNWIND-TO-FRAME-AND-CALL VOP
+     *unwind-to-frame-function*
+
+     ;; Needed for callbacks to work across saving cores. see
+     ;; ALIEN-CALLBACK-ASSEMBLER-WRAPPER in c-call.lisp for gory
+     ;; details.
+     sb!alien::*enter-alien-callback*
+
+     ;; see comments in ../x86-64/parms.lisp
+     sb!pcl::..slot-unbound..)))
+
+(defparameter *static-funs*
   '(length
     sb!kernel:two-arg-+
     sb!kernel:two-arg--