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 minimum immediate offset in a memory-referencing instruction.
  39 (def!constant minimum-immediate-offset (- (expt 2 31)))
  40
  41 ;;; The maximum immediate offset in a memory-referencing instruction.
  42 (def!constant maximum-immediate-offset (1- (expt 2 31)))
  43
  44 (def!constant float-sign-shift 31)
  45
  46 ;;; comment from CMU CL:
  47 ;;;   These values were taken from the alpha code. The values for
  48 ;;;   bias and exponent min/max are not the same as shown in the 486 book.
  49 ;;;   They may be correct for how Python uses them.
  50 (def!constant single-float-bias 126)    ; Intel says 127.
  51 (defconstant-eqx single-float-exponent-byte    (byte 8 23) #'equalp)
  52 (defconstant-eqx single-float-significand-byte (byte 23 0) #'equalp)
  53 ;;; comment from CMU CL:
  54 ;;;   The 486 book shows the exponent range -126 to +127. The Lisp
  55 ;;;   code that uses these values seems to want already biased numbers.
  56 (def!constant single-float-normal-exponent-min 1)
  57 (def!constant single-float-normal-exponent-max 254)
  58 (def!constant single-float-hidden-bit (ash 1 23))
  59 (def!constant single-float-trapping-nan-bit (ash 1 22))
  60
  61 (def!constant double-float-bias 1022)
  62 (defconstant-eqx double-float-exponent-byte    (byte 11 20) #'equalp)
  63 (defconstant-eqx double-float-significand-byte (byte 20 0)  #'equalp)
  64 (def!constant double-float-normal-exponent-min 1)
  65 (def!constant double-float-normal-exponent-max #x7FE)
  66 (def!constant double-float-hidden-bit (ash 1 20))
  67 (def!constant double-float-trapping-nan-bit (ash 1 19))
  68
  69 (def!constant long-float-bias 16382)
  70 (defconstant-eqx long-float-exponent-byte    (byte 15 0) #'equalp)
  71 (defconstant-eqx long-float-significand-byte (byte 31 0) #'equalp)
  72 (def!constant long-float-normal-exponent-min 1)
  73 (def!constant long-float-normal-exponent-max #x7FFE)
  74 (def!constant long-float-hidden-bit (ash 1 31))         ; actually not hidden
  75 (def!constant long-float-trapping-nan-bit (ash 1 30))
  76
  77 (def!constant single-float-digits
  78   (+ (byte-size single-float-significand-byte) 1))
  79
  80 (def!constant double-float-digits
  81   (+ (byte-size double-float-significand-byte) n-word-bits 1))
  82
  83 (def!constant long-float-digits
  84   (+ (byte-size long-float-significand-byte) n-word-bits 1))
  85
  86 ;;; pfw -- from i486 microprocessor programmer's reference manual
  87 (def!constant float-invalid-trap-bit       (ash 1 0))
  88 (def!constant float-denormal-trap-bit       (ash 1 1))
  89 (def!constant float-divide-by-zero-trap-bit (ash 1 2))
  90 (def!constant float-overflow-trap-bit       (ash 1 3))
  91 (def!constant float-underflow-trap-bit      (ash 1 4))
  92 (def!constant float-inexact-trap-bit       (ash 1 5))
  93
  94 (def!constant float-round-to-nearest  0)
  95 (def!constant float-round-to-negative 1)
  96 (def!constant float-round-to-positive 2)
  97 (def!constant float-round-to-zero     3)
  98
  99 (def!constant float-precision-24-bit 0)
 100 (def!constant float-precision-53-bit 2)
 101 (def!constant float-precision-64-bit 3)
 102
 103 (defconstant-eqx float-rounding-mode     (byte 2 10) #'equalp)
 104 (defconstant-eqx float-sticky-bits       (byte 6 16) #'equalp)
 105 (defconstant-eqx float-traps-byte        (byte 6  0) #'equalp)
 106 (defconstant-eqx float-exceptions-byte   (byte 6 16) #'equalp)
 107 (defconstant-eqx float-precision-control (byte 2  8) #'equalp)
 108 (def!constant float-fast-bit 0) ; no fast mode on x86
 109 \f
 110 ;;;; description of the target address space
 111
 112 ;;; where to put the different spaces
 113 ;;;
 114 ;;; Note: Mostly these values are black magic, inherited from CMU CL
 115 ;;; without any documentation. However, there were a few explanatory
 116 ;;; comments in the CMU CL sources:
 117 ;;;   * On Linux,
 118 ;;;     ** The space 0x08000000-0x10000000 is "C program and memory allocation".
 119 ;;;     ** The space 0x40000000-0x48000000 is reserved for shared libs.
 120 ;;;     ** The space >0xE0000000 is "C stack - Alien stack".
 121 ;;;   * On FreeBSD,
 122 ;;;     ** The space 0x0E000000-0x10000000 is "Foreign segment".
 123 ;;;     ** The space 0x20000000-0x30000000 is reserved for shared libs.
 124 ;;; And there have been some changes since the fork from CMU CL:
 125 ;;;   * The OpenBSD port is new since the fork. We started with
 126 ;;;     the FreeBSD address map, which actually worked until the
 127 ;;;     Alpha port patches, for reasons which in retrospect are rather
 128 ;;;     mysterious. After the Alpha port patches were added, the
 129 ;;;     OpenBSD port suffered memory corruption problems. While
 130 ;;;     debugging those, it was discovered that src/runtime/trymap
 131 ;;;     failed for the control stack region #x40000000-#x47fff000.
 132 ;;;     After the control stack was moved upward out of this region
 133 ;;;     (stealing some bytes from dynamic space) the problems went
 134 ;;;     away.
 135 ;;;   * The FreeBSD STATIC-SPACE-START value was bumped up from
 136 ;;;     #x28000000 to #x30000000 when FreeBSD ld.so dynamic linking
 137 ;;;     support was added for FreeBSD ca. 20000910. This was to keep from
 138 ;;;     stomping on an address range that the dynamic libraries want to
 139 ;;;     use. (They want to use this address range even if we try to
 140 ;;;     reserve it with a call to validate() as the first operation in
 141 ;;;     main().)
 142 ;;;   * For NetBSD 2.0, the following ranges are used by normal
 143 ;;;     executables and mmap:
 144 ;;;     ** Executables are (by default) loaded at 0x08048000.
 145 ;;;     ** The break for the sbcl runtime seems to end around 0x08400000
 146 ;;;     We set read only space around 0x20000000, static
 147 ;;;     space around 0x30000000, all ending below 0x37fff000
 148 ;;;     ** ld.so and other mmap'ed stuff like shared libs start around
 149 ;;;        0x48000000
 150 ;;;     We set dynamic space between 0x60000000 and 0x98000000
 151 ;;;     ** Bottom of the stack is typically not below 0xb0000000
 152 ;;;     FYI, this can be looked at with the "pmap" program, and if you
 153 ;;;     set the top-down mmap allocation option in the kernel (not yet
 154 ;;;     the default), all bets are totally off!
 155 ;;;   * For FreeBSD, the requirement of user and kernel space are
 156 ;;;     getting larger, and users tend to extend them.
 157 ;;;     If MAXDSIZ is extended from 512MB to 1GB, we can't use up to
 158 ;;;     around 0x50000000.
 159 ;;;     And if KVA_PAGES is extended from 1GB to 1.5GB, we can't use
 160 ;;;     down to around 0xA0000000.
 161 ;;;     So we use 0x58000000--0x98000000 for dynamic space.
 162 ;;;   * OpenBSD address space changes for W^X as well as malloc
 163 ;;;     randomization made the old addresses unsafe. The only range
 164 ;;;     that is really safe is between the end of the text segment (it
 165 ;;;     starts at #x3C000000) and #x7C000000. However if the -Z linker
 166 ;;;     option is used then the safe range is (probably) #x00001000 to
 167 ;;;     #x48048000, with the text and data segments at #x08048000.
 168
 169 #!+win32
 170 (progn
 171
 172   (def!constant read-only-space-start #x22000000)
 173   (def!constant read-only-space-end   #x220ff000)
 174
 175   (def!constant static-space-start    #x22100000)
 176   (def!constant static-space-end      #x221ff000)
 177
 178   (def!constant dynamic-space-start   #x22300000)
 179   (def!constant dynamic-space-end     #x42300000)
 180
 181   (def!constant linkage-table-space-start #x22200000)
 182   (def!constant linkage-table-space-end   #x222ff000))
 183
 184 #!+linux
 185 (progn
 186   (def!constant read-only-space-start     #x01000000)
 187   (def!constant read-only-space-end       #x010ff000)
 188
 189   (def!constant static-space-start        #x01100000)
 190   (def!constant static-space-end          #x011ff000)
 191
 192   (def!constant dynamic-space-start       #x09000000)
 193   (def!constant dynamic-space-end         #x29000000)
 194
 195   (def!constant linkage-table-space-start #x01200000)
 196   (def!constant linkage-table-space-end   #x012ff000))
 197
 198 #!+sunos
 199 (progn
 200   (def!constant read-only-space-start     #x20000000)
 201   (def!constant read-only-space-end       #x200ff000)
 202
 203   (def!constant static-space-start        #x20100000)
 204   (def!constant static-space-end          #x201ff000)
 205
 206   (def!constant dynamic-space-start       #x48000000)
 207   (def!constant dynamic-space-end         #xA0000000)
 208
 209   (def!constant linkage-table-space-start #x20200000)
 210   (def!constant linkage-table-space-end   #x202ff000))
 211
 212 #!+freebsd
 213 (progn
 214   (def!constant read-only-space-start     #x01000000)
 215   (def!constant read-only-space-end       #x010ff000)
 216
 217   (def!constant static-space-start        #x01100000)
 218   (def!constant static-space-end          #x011ff000)
 219
 220   (def!constant dynamic-space-start       #x58000000)
 221   (def!constant dynamic-space-end         #x98000000)
 222
 223   (def!constant linkage-table-space-start #x01200000)
 224   (def!constant linkage-table-space-end   #x012ff000))
 225
 226 #!+openbsd
 227 (progn
 228   (def!constant read-only-space-start     #x7b000000)
 229   (def!constant read-only-space-end       #x7b0ff000)
 230
 231   (def!constant static-space-start        #x7b100000)
 232   (def!constant static-space-end          #x7b1ff000)
 233
 234   (def!constant dynamic-space-start       #x4c000000)
 235   (def!constant dynamic-space-end         #x7b0ff000)
 236
 237   ;; In CMUCL: 0xB0000000->0xB1000000
 238   (def!constant linkage-table-space-start #x7b200000)
 239   (def!constant linkage-table-space-end   #x7b2ff000))
 240
 241 #!+netbsd
 242 (progn
 243   (def!constant read-only-space-start     #x20000000)
 244   (def!constant read-only-space-end       #x200ff000)
 245
 246   (def!constant static-space-start        #x20100000)
 247   (def!constant static-space-end          #x201ff000)
 248
 249   (def!constant dynamic-space-start       #x60000000)
 250   (def!constant dynamic-space-end         #x98000000)
 251
 252   ;; In CMUCL: 0xB0000000->0xB1000000
 253   (def!constant linkage-table-space-start #x20200000)
 254   (def!constant linkage-table-space-end   #x202ff000))
 255
 256
 257 #!+darwin
 258 (progn
 259   (def!constant read-only-space-start #x04000000)
 260   (def!constant read-only-space-end   #x040ff000)
 261
 262   (def!constant static-space-start    #x04100000)
 263   (def!constant static-space-end      #x041ff000)
 264
 265   (def!constant dynamic-space-start #x10000000)
 266   (def!constant dynamic-space-end   #x6ffff000)
 267
 268   (def!constant linkage-table-space-start #x04200000)
 269   (def!constant linkage-table-space-end   #x042ff000))
 270
 271 ;;; Size of one linkage-table entry in bytes.
 272 (def!constant linkage-table-entry-size 8)
 273
 274 ;;; Given that NIL is the first thing allocated in static space, we
 275 ;;; know its value at compile time:
 276 (def!constant nil-value (+ static-space-start #xb))
 277 \f
 278 ;;;; other miscellaneous constants
 279
 280 (defenum (:suffix -trap :start 8)
 281   halt
 282   pending-interrupt
 283   error
 284   cerror
 285   breakpoint
 286   fun-end-breakpoint
 287   single-step-around
 288   single-step-before)
 289 ;;; FIXME: It'd be nice to replace all the DEFENUMs with something like
 290 ;;;   (WITH-DEF-ENUM (:START 8)
 291 ;;;     (DEF-ENUM HALT-TRAP)
 292 ;;;     (DEF-ENUM PENDING-INTERRUPT-TRAP)
 293 ;;;     ..)
 294 ;;; for the benefit of anyone doing a lexical search for definitions
 295 ;;; of these symbols.
 296
 297 (defenum (:prefix object-not- :suffix -trap :start 24)
 298   list
 299   instance)
 300
 301 (defenum (:prefix trace-table-)
 302   normal
 303   call-site
 304   fun-prologue
 305   fun-epilogue)
 306 \f
 307 ;;;; static symbols
 308
 309 ;;; These symbols are loaded into static space directly after NIL so
 310 ;;; that the system can compute their address by adding a constant
 311 ;;; amount to NIL.
 312 ;;;
 313 ;;; The fdefn objects for the static functions are loaded into static
 314 ;;; space directly after the static symbols. That way, the raw-addr
 315 ;;; can be loaded directly out of them by indirecting relative to NIL.
 316 ;;;
 317 ;;; pfw X86 doesn't have enough registers to keep these things there.
 318 ;;;     Note these spaces grow from low to high addresses.
 319 (defvar *allocation-pointer*)
 320 (defvar *binding-stack-pointer*)
 321
 322 (defparameter *static-symbols*
 323   (append
 324    *common-static-symbols*
 325    *c-callable-static-symbols*
 326    '(*alien-stack*
 327
 328      ;; interrupt handling
 329      *pseudo-atomic-bits*
 330      #!+sb-thread *stop-for-gc-pending*
 331      #!+sb-thread *free-tls-index*
 332      #!+sb-thread *tls-index-lock*
 333
 334      *allocation-pointer*
 335      *binding-stack-pointer*
 336
 337      ;; the floating point constants
 338      *fp-constant-0d0*
 339      *fp-constant-1d0*
 340      *fp-constant-0f0*
 341      *fp-constant-1f0*
 342      ;; The following are all long-floats.
 343      *fp-constant-0l0*
 344      *fp-constant-1l0*
 345      *fp-constant-pi*
 346      *fp-constant-l2t*
 347      *fp-constant-l2e*
 348      *fp-constant-lg2*
 349      *fp-constant-ln2*
 350
 351      ;; For GC-AND-SAVE
 352      *restart-lisp-function*
 353
 354      ;; For the UNWIND-TO-FRAME-AND-CALL VOP
 355      *unwind-to-frame-function*
 356
 357      ;; Needed for callbacks to work across saving cores. see
 358      ;; ALIEN-CALLBACK-ASSEMBLER-WRAPPER in c-call.lisp for gory
 359      ;; details.
 360      sb!alien::*enter-alien-callback*
 361
 362      ;; see comments in ../x86-64/parms.lisp
 363      sb!pcl::..slot-unbound..)))
 364
 365 (defparameter *static-funs*
 366   '(length
 367     sb!kernel:two-arg-+
 368     sb!kernel:two-arg--
 369     sb!kernel:two-arg-*
 370     sb!kernel:two-arg-/
 371     sb!kernel:two-arg-<
 372     sb!kernel:two-arg->
 373     sb!kernel:two-arg-=
 374     eql
 375     sb!kernel:%negate
 376     sb!kernel:two-arg-and
 377     sb!kernel:two-arg-ior
 378     sb!kernel:two-arg-xor
 379     sb!kernel:two-arg-gcd
 380     sb!kernel:two-arg-lcm))
 381 \f
 382 ;;;; stuff added by jrd
 383
 384 ;;; FIXME: Is this used? Delete it or document it.
 385 ;;; cf the sparc PARMS.LISP
 386 (defparameter *assembly-unit-length* 8)