src/compiler/x86/parms.lisp

   1 ;;;; This file contains some parameterizations of various VM
   2 ;;;; attributes for the x86. This file is separate from other stuff so
   3 ;;;; that it can be compiled and loaded earlier.
   4
   5 ;;;; This software is part of the SBCL system. See the README file for
   6 ;;;; more information.
   7 ;;;;
   8 ;;;; This software is derived from the CMU CL system, which was
   9 ;;;; written at Carnegie Mellon University and released into the
  10 ;;;; public domain. The software is in the public domain and is
  11 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
  12 ;;;; files for more information.
  13
  14 (in-package "SB!VM")
  15
  16 ;;; ### Note: we simultaneously use ``word'' to mean a 32 bit quantity
  17 ;;; and a 16 bit quantity depending on context. This is because Intel
  18 ;;; insists on calling 16 bit things words and 32 bit things
  19 ;;; double-words (or dwords). Therefore, in the instruction definition
  20 ;;; and register specs, we use the Intel convention. But whenever we
  21 ;;; are talking about stuff the rest of the lisp system might be
  22 ;;; interested in, we use ``word'' to mean the size of a descriptor
  23 ;;; object, which is 32 bits.
  24 \f
  25 ;;;; machine architecture parameters
  26
  27 ;;; the number of bits per word, where a word holds one lisp descriptor
  28 (def!constant n-word-bits 32)
  29
  30 ;;; the natural width of a machine word (as seen in e.g. register width,
  31 ;;; address space)
  32 (def!constant n-machine-word-bits 32)
  33
  34 ;;; the number of bits per byte, where a byte is the smallest
  35 ;;; addressable object
  36 (def!constant n-byte-bits 8)
  37
  38 ;;; The size in bytes of the GENCGC pages. Should be a multiple of the
  39 ;;; architecture code size.
  40 (def!constant gencgc-page-size 4096)
  41
  42 (def!constant float-sign-shift 31)
  43
  44 ;;; comment from CMU CL:
  45 ;;;   These values were taken from the alpha code. The values for
  46 ;;;   bias and exponent min/max are not the same as shown in the 486 book.
  47 ;;;   They may be correct for how Python uses them.
  48 (def!constant single-float-bias 126)    ; Intel says 127.
  49 (defconstant-eqx single-float-exponent-byte    (byte 8 23) #'equalp)
  50 (defconstant-eqx single-float-significand-byte (byte 23 0) #'equalp)
  51 ;;; comment from CMU CL:
  52 ;;;   The 486 book shows the exponent range -126 to +127. The Lisp
  53 ;;;   code that uses these values seems to want already biased numbers.
  54 (def!constant single-float-normal-exponent-min 1)
  55 (def!constant single-float-normal-exponent-max 254)
  56 (def!constant single-float-hidden-bit (ash 1 23))
  57 (def!constant single-float-trapping-nan-bit (ash 1 22))
  58
  59 (def!constant double-float-bias 1022)
  60 (defconstant-eqx double-float-exponent-byte    (byte 11 20) #'equalp)
  61 (defconstant-eqx double-float-significand-byte (byte 20 0)  #'equalp)
  62 (def!constant double-float-normal-exponent-min 1)
  63 (def!constant double-float-normal-exponent-max #x7FE)
  64 (def!constant double-float-hidden-bit (ash 1 20))
  65 (def!constant double-float-trapping-nan-bit (ash 1 19))
  66
  67 (def!constant long-float-bias 16382)
  68 (defconstant-eqx long-float-exponent-byte    (byte 15 0) #'equalp)
  69 (defconstant-eqx long-float-significand-byte (byte 31 0) #'equalp)
  70 (def!constant long-float-normal-exponent-min 1)
  71 (def!constant long-float-normal-exponent-max #x7FFE)
  72 (def!constant long-float-hidden-bit (ash 1 31))         ; actually not hidden
  73 (def!constant long-float-trapping-nan-bit (ash 1 30))
  74
  75 (def!constant single-float-digits
  76   (+ (byte-size single-float-significand-byte) 1))
  77
  78 (def!constant double-float-digits
  79   (+ (byte-size double-float-significand-byte) n-word-bits 1))
  80
  81 (def!constant long-float-digits
  82   (+ (byte-size long-float-significand-byte) n-word-bits 1))
  83
  84 ;;; pfw -- from i486 microprocessor programmer's reference manual
  85 (def!constant float-invalid-trap-bit       (ash 1 0))
  86 (def!constant float-denormal-trap-bit       (ash 1 1))
  87 (def!constant float-divide-by-zero-trap-bit (ash 1 2))
  88 (def!constant float-overflow-trap-bit       (ash 1 3))
  89 (def!constant float-underflow-trap-bit      (ash 1 4))
  90 (def!constant float-inexact-trap-bit       (ash 1 5))
  91
  92 (def!constant float-round-to-nearest  0)
  93 (def!constant float-round-to-negative 1)
  94 (def!constant float-round-to-positive 2)
  95 (def!constant float-round-to-zero     3)
  96
  97 (def!constant float-precision-24-bit 0)
  98 (def!constant float-precision-53-bit 2)
  99 (def!constant float-precision-64-bit 3)
 100
 101 (defconstant-eqx float-rounding-mode     (byte 2 10) #'equalp)
 102 (defconstant-eqx float-sticky-bits       (byte 6 16) #'equalp)
 103 (defconstant-eqx float-traps-byte        (byte 6  0) #'equalp)
 104 (defconstant-eqx float-exceptions-byte   (byte 6 16) #'equalp)
 105 (defconstant-eqx float-precision-control (byte 2  8) #'equalp)
 106 (def!constant float-fast-bit 0) ; no fast mode on x86
 107 \f
 108 ;;;; description of the target address space
 109
 110 ;;; where to put the different spaces
 111 ;;;
 112 ;;; Note: Mostly these values are black magic, inherited from CMU CL
 113 ;;; without any documentation. However, there were a few explanatory
 114 ;;; comments in the CMU CL sources:
 115 ;;;   * On Linux,
 116 ;;;     ** The space 0x08000000-0x10000000 is "C program and memory allocation".
 117 ;;;     ** The space 0x40000000-0x48000000 is reserved for shared libs.
 118 ;;;     ** The space >0xE0000000 is "C stack - Alien stack".
 119 ;;;   * On FreeBSD,
 120 ;;;     ** The space 0x0E000000-0x10000000 is "Foreign segment".
 121 ;;;     ** The space 0x20000000-0x30000000 is reserved for shared libs.
 122 ;;; And there have been some changes since the fork from CMU CL:
 123 ;;;   * The OpenBSD port is new since the fork. We started with
 124 ;;;     the FreeBSD address map, which actually worked until the
 125 ;;;     Alpha port patches, for reasons which in retrospect are rather
 126 ;;;     mysterious. After the Alpha port patches were added, the
 127 ;;;     OpenBSD port suffered memory corruption problems. While
 128 ;;;     debugging those, it was discovered that src/runtime/trymap
 129 ;;;     failed for the control stack region #x40000000-#x47fff000.
 130 ;;;     After the control stack was moved upward out of this region
 131 ;;;     (stealing some bytes from dynamic space) the problems went
 132 ;;;     away.
 133 ;;;   * The FreeBSD STATIC-SPACE-START value was bumped up from
 134 ;;;     #x28000000 to #x30000000 when FreeBSD ld.so dynamic linking
 135 ;;;     support was added for FreeBSD ca. 20000910. This was to keep from
 136 ;;;     stomping on an address range that the dynamic libraries want to
 137 ;;;     use. (They want to use this address range even if we try to
 138 ;;;     reserve it with a call to validate() as the first operation in
 139 ;;;     main().)
 140 ;;;   * For NetBSD 2.0, the following ranges are used by normal
 141 ;;;     executables and mmap:
 142 ;;;     ** Executables are (by default) loaded at 0x08048000.
 143 ;;;     ** The break for the sbcl runtime seems to end around 0x08400000
 144 ;;;     We set read only space around 0x20000000, static
 145 ;;;     space around 0x30000000, all ending below 0x37fff000
 146 ;;;     ** ld.so and other mmap'ed stuff like shared libs start around
 147 ;;;        0x48000000
 148 ;;;     We set dynamic space between 0x60000000 and 0x98000000
 149 ;;;     ** Bottom of the stack is typically not below 0xb0000000
 150 ;;;     FYI, this can be looked at with the "pmap" program, and if you
 151 ;;;     set the top-down mmap allocation option in the kernel (not yet
 152 ;;;     the default), all bets are totally off!
 153
 154 #!+win32
 155 (progn
 156
 157   (def!constant read-only-space-start #x01000000)
 158   (def!constant read-only-space-end   #x037ff000)
 159
 160   (def!constant static-space-start    #x05000000)
 161   (def!constant static-space-end      #x07fff000)
 162
 163   (def!constant dynamic-space-start   #x09000000)
 164   (def!constant dynamic-space-end     #x29000000))
 165
 166 #!+linux
 167 (progn
 168   (def!constant read-only-space-start     #x01000000)
 169   (def!constant read-only-space-end       #x037ff000)
 170
 171   (def!constant static-space-start        #x05000000)
 172   (def!constant static-space-end          #x07fff000)
 173
 174   (def!constant dynamic-space-start       #x09000000)
 175   (def!constant dynamic-space-end         #x29000000)
 176
 177   (def!constant linkage-table-space-start #x70000000)
 178   (def!constant linkage-table-space-end   #x7ffff000))
 179
 180 #!+sunos
 181 (progn
 182   (def!constant read-only-space-start     #x20000000)
 183   (def!constant read-only-space-end       #x2ffff000)
 184
 185   (def!constant static-space-start        #x40000000)
 186   (def!constant static-space-end          #x42fff000)
 187
 188   (def!constant dynamic-space-start       #x48000000)
 189   (def!constant dynamic-space-end         #xA0000000)
 190
 191   (def!constant linkage-table-space-start #xA2000000)
 192   (def!constant linkage-table-space-end   #xA3000000))
 193
 194 #!+freebsd
 195 (progn
 196   (def!constant read-only-space-start     #x10000000)
 197   (def!constant read-only-space-end       #x1ffff000)
 198
 199   (def!constant static-space-start        #x30000000)
 200   (def!constant static-space-end          #x37fff000)
 201
 202   (def!constant dynamic-space-start       #x48000000)
 203   (def!constant dynamic-space-end         #x88000000)
 204
 205   ;; In CMUCL:  0xB0000000->0xB1000000
 206   (def!constant linkage-table-space-start #x90000000)
 207   (def!constant linkage-table-space-end   #x91000000))
 208
 209 #!+openbsd
 210 (progn
 211   (def!constant read-only-space-start     #x40000000)
 212   (def!constant read-only-space-end       #x47fff000)
 213
 214   (def!constant static-space-start        #x50000000)
 215   (def!constant static-space-end          #x5ffff000)
 216
 217   (def!constant dynamic-space-start       #x80000000)
 218   (def!constant dynamic-space-end         #xA0000000)
 219
 220   ;; In CMUCL: 0xB0000000->0xB1000000
 221   (def!constant linkage-table-space-start #xA0000000)
 222   (def!constant linkage-table-space-end   #xA1000000))
 223
 224 #!+netbsd
 225 (progn
 226   (def!constant read-only-space-start     #x20000000)
 227   (def!constant read-only-space-end       #x2ffff000)
 228
 229   (def!constant static-space-start        #x30000000)
 230   (def!constant static-space-end          #x37fff000)
 231
 232   (def!constant dynamic-space-start       #x60000000)
 233   (def!constant dynamic-space-end         #x98000000)
 234
 235   ;; In CMUCL: 0xB0000000->0xB1000000
 236   (def!constant linkage-table-space-start #xA0000000)
 237   (def!constant linkage-table-space-end   #xA1000000))
 238
 239
 240 #!+darwin
 241 (progn
 242   (def!constant read-only-space-start #x01000000)
 243   (def!constant read-only-space-end   #x04ff8000)
 244
 245   (def!constant static-space-start    #x08000000)
 246   (def!constant static-space-end      #x097fff00)
 247
 248   (def!constant dynamic-space-start #x10000000)
 249   (def!constant dynamic-space-end   #x6ffff000)
 250
 251   (def!constant linkage-table-space-start #x0a000000)
 252   (def!constant linkage-table-space-end   #x0b000000))
 253
 254 ;;; Size of one linkage-table entry in bytes.
 255 (def!constant linkage-table-entry-size 8)
 256
 257 ;;; Given that NIL is the first thing allocated in static space, we
 258 ;;; know its value at compile time:
 259 (def!constant nil-value (+ static-space-start #xb))
 260 \f
 261 ;;;; other miscellaneous constants
 262
 263 (defenum (:suffix -trap :start 8)
 264   halt
 265   pending-interrupt
 266   error
 267   cerror
 268   breakpoint
 269   fun-end-breakpoint
 270   single-step-breakpoint
 271   #!+win32 context-restore) ;; HACK: The Win32 exception handling system does wrong things with this.
 272 ;;; FIXME: It'd be nice to replace all the DEFENUMs with something like
 273 ;;;   (WITH-DEF-ENUM (:START 8)
 274 ;;;     (DEF-ENUM HALT-TRAP)
 275 ;;;     (DEF-ENUM PENDING-INTERRUPT-TRAP)
 276 ;;;     ..)
 277 ;;; for the benefit of anyone doing a lexical search for definitions
 278 ;;; of these symbols.
 279
 280 (defenum (:prefix object-not- :suffix -trap :start 16)
 281   list
 282   instance)
 283
 284 (defenum (:prefix trace-table-)
 285   normal
 286   call-site
 287   fun-prologue
 288   fun-epilogue)
 289 \f
 290 ;;;; static symbols
 291
 292 ;;; These symbols are loaded into static space directly after NIL so
 293 ;;; that the system can compute their address by adding a constant
 294 ;;; amount to NIL.
 295 ;;;
 296 ;;; The fdefn objects for the static functions are loaded into static
 297 ;;; space directly after the static symbols. That way, the raw-addr
 298 ;;; can be loaded directly out of them by indirecting relative to NIL.
 299 ;;;
 300 ;;; pfw X86 doesn't have enough registers to keep these things there.
 301 ;;;     Note these spaces grow from low to high addresses.
 302 (defvar *allocation-pointer*)
 303 (defvar *binding-stack-pointer*)
 304
 305 ;;; FIXME: !COLD-INIT probably doesn't need
 306 ;;; to be in the static symbols table any more.
 307 (defparameter *static-symbols*
 308   '(t
 309
 310     ;; The C startup code must fill these in.
 311     *posix-argv*
 312
 313     ;; functions that the C code needs to call.  When adding to this list,
 314     ;; also add a `frob' form in genesis.lisp finish-symbols.
 315     sub-gc
 316     sb!kernel::internal-error
 317     sb!kernel::control-stack-exhausted-error
 318     sb!kernel::undefined-alien-variable-error
 319     sb!kernel::undefined-alien-function-error
 320     sb!kernel::memory-fault-error
 321     sb!di::handle-breakpoint
 322     fdefinition-object
 323     #!+win32 sb!kernel::handle-win32-exception
 324
 325     ;; free pointers
 326     ;;
 327     ;; Note that these are FIXNUM word counts, not (as one might
 328     ;; expect) byte counts or SAPs. The reason seems to be that by
 329     ;; representing them this way, we can avoid consing bignums.
 330     ;; -- WHN 2000-10-02
 331     *read-only-space-free-pointer*
 332     *static-space-free-pointer*
 333     *initial-dynamic-space-free-pointer*
 334
 335     ;; things needed for non-local exit
 336     *current-catch-block*
 337     *current-unwind-protect-block*
 338     *alien-stack*
 339
 340     ;; interrupt handling
 341     *pseudo-atomic-atomic*
 342     *pseudo-atomic-interrupted*
 343     sb!unix::*interrupts-enabled*
 344     sb!unix::*interrupt-pending*
 345     *free-interrupt-context-index*
 346     *gc-inhibit*
 347     #!+sb-thread *stop-for-gc-pending*
 348     *gc-pending*
 349     #!+sb-thread sb!thread::run-interruption
 350
 351     *free-tls-index*
 352     *tls-index-lock*
 353
 354     *allocation-pointer*
 355     *binding-stack-pointer*
 356     *binding-stack-start*
 357     *control-stack-start*
 358     *control-stack-end*
 359
 360     ;; the floating point constants
 361     *fp-constant-0d0*
 362     *fp-constant-1d0*
 363     *fp-constant-0f0*
 364     *fp-constant-1f0*
 365     ;; The following are all long-floats.
 366     *fp-constant-0l0*
 367     *fp-constant-1l0*
 368     *fp-constant-pi*
 369     *fp-constant-l2t*
 370     *fp-constant-l2e*
 371     *fp-constant-lg2*
 372     *fp-constant-ln2*
 373
 374     ;; For GC-AND-SAVE
 375     *restart-lisp-function*
 376
 377     ;; Needed for callbacks to work across saving cores. see
 378     ;; ALIEN-CALLBACK-ASSEMBLER-WRAPPER in c-call.lisp for gory details.
 379     sb!alien::*enter-alien-callback*
 380
 381     ;; The ..SLOT-UNBOUND.. symbol is static in order to optimise the
 382     ;; common slot unbound check.
 383     ;;
 384     ;; FIXME: In SBCL, the CLOS code has become sufficiently tightly
 385     ;; integrated into the system that it'd probably make sense to use
 386     ;; the ordinary unbound marker for this.
 387     sb!pcl::..slot-unbound..
 388     ))
 389
 390 (defparameter *static-funs*
 391   '(length
 392     sb!kernel:two-arg-+
 393     sb!kernel:two-arg--
 394     sb!kernel:two-arg-*
 395     sb!kernel:two-arg-/
 396     sb!kernel:two-arg-<
 397     sb!kernel:two-arg->
 398     sb!kernel:two-arg-=
 399     eql
 400     sb!kernel:%negate
 401     sb!kernel:two-arg-and
 402     sb!kernel:two-arg-ior
 403     sb!kernel:two-arg-xor
 404     sb!kernel:two-arg-gcd
 405     sb!kernel:two-arg-lcm))
 406 \f
 407 ;;;; stuff added by jrd
 408
 409 ;;; FIXME: Is this used? Delete it or document it.
 410 ;;; cf the sparc PARMS.LISP
 411 (defparameter *assembly-unit-length* 8)