1.0.2.1: DATA-VECTOR-{REF,SET}-WITH-OFFSET for the x86
[sbcl.git] / 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
156 #!+win32
157 (progn
158
159   (def!constant read-only-space-start #x02000000)
160   (def!constant read-only-space-end   #x047ff000)
161
162   (def!constant static-space-start    #x05000000)
163   (def!constant static-space-end      #x07fff000)
164
165   (def!constant dynamic-space-start   #x09000000)
166   (def!constant dynamic-space-end     #x29000000)
167
168   (def!constant linkage-table-space-start #x30000000)
169   (def!constant linkage-table-space-end   #x40000000))
170
171 #!+linux
172 (progn
173   (def!constant read-only-space-start     #x01000000)
174   (def!constant read-only-space-end       #x037ff000)
175
176   (def!constant static-space-start        #x05000000)
177   (def!constant static-space-end          #x07fff000)
178
179   (def!constant dynamic-space-start       #x09000000)
180   (def!constant dynamic-space-end         #x29000000)
181
182   (def!constant linkage-table-space-start #x70000000)
183   (def!constant linkage-table-space-end   #x7ffff000))
184
185 #!+sunos
186 (progn
187   (def!constant read-only-space-start     #x20000000)
188   (def!constant read-only-space-end       #x2ffff000)
189
190   (def!constant static-space-start        #x40000000)
191   (def!constant static-space-end          #x42fff000)
192
193   (def!constant dynamic-space-start       #x48000000)
194   (def!constant dynamic-space-end         #xA0000000)
195
196   (def!constant linkage-table-space-start #xA2000000)
197   (def!constant linkage-table-space-end   #xA3000000))
198
199 #!+freebsd
200 (progn
201   (def!constant read-only-space-start     #x10000000)
202   (def!constant read-only-space-end       #x1ffff000)
203
204   (def!constant static-space-start        #x30000000)
205   (def!constant static-space-end          #x37fff000)
206
207   (def!constant dynamic-space-start       #x48000000)
208   (def!constant dynamic-space-end         #x88000000)
209
210   ;; In CMUCL:  0xB0000000->0xB1000000
211   (def!constant linkage-table-space-start #x90000000)
212   (def!constant linkage-table-space-end   #x91000000))
213
214 #!+openbsd
215 (progn
216   (def!constant read-only-space-start     #x40000000)
217   (def!constant read-only-space-end       #x47fff000)
218
219   (def!constant static-space-start        #x50000000)
220   (def!constant static-space-end          #x5ffff000)
221
222   (def!constant dynamic-space-start       #x80000000)
223   (def!constant dynamic-space-end         #xA0000000)
224
225   ;; In CMUCL: 0xB0000000->0xB1000000
226   (def!constant linkage-table-space-start #xA0000000)
227   (def!constant linkage-table-space-end   #xA1000000))
228
229 #!+netbsd
230 (progn
231   (def!constant read-only-space-start     #x20000000)
232   (def!constant read-only-space-end       #x2ffff000)
233
234   (def!constant static-space-start        #x30000000)
235   (def!constant static-space-end          #x37fff000)
236
237   (def!constant dynamic-space-start       #x60000000)
238   (def!constant dynamic-space-end         #x98000000)
239
240   ;; In CMUCL: 0xB0000000->0xB1000000
241   (def!constant linkage-table-space-start #xA0000000)
242   (def!constant linkage-table-space-end   #xA1000000))
243
244
245 #!+darwin
246 (progn
247   (def!constant read-only-space-start #x04000000)
248   (def!constant read-only-space-end   #x07ff8000)
249
250   (def!constant static-space-start    #x08000000)
251   (def!constant static-space-end      #x097fff00)
252
253   (def!constant dynamic-space-start #x10000000)
254   (def!constant dynamic-space-end   #x6ffff000)
255
256   (def!constant linkage-table-space-start #x0a000000)
257   (def!constant linkage-table-space-end   #x0b000000))
258
259 ;;; Size of one linkage-table entry in bytes.
260 (def!constant linkage-table-entry-size 8)
261
262 ;;; Given that NIL is the first thing allocated in static space, we
263 ;;; know its value at compile time:
264 (def!constant nil-value (+ static-space-start #xb))
265 \f
266 ;;;; other miscellaneous constants
267
268 (defenum (:suffix -trap :start 8)
269   halt
270   pending-interrupt
271   error
272   cerror
273   breakpoint
274   fun-end-breakpoint
275   single-step-around
276   single-step-before)
277 ;;; FIXME: It'd be nice to replace all the DEFENUMs with something like
278 ;;;   (WITH-DEF-ENUM (:START 8)
279 ;;;     (DEF-ENUM HALT-TRAP)
280 ;;;     (DEF-ENUM PENDING-INTERRUPT-TRAP)
281 ;;;     ..)
282 ;;; for the benefit of anyone doing a lexical search for definitions
283 ;;; of these symbols.
284
285 (defenum (:prefix object-not- :suffix -trap :start 24)
286   list
287   instance)
288
289 (defenum (:prefix trace-table-)
290   normal
291   call-site
292   fun-prologue
293   fun-epilogue)
294 \f
295 ;;;; static symbols
296
297 ;;; These symbols are loaded into static space directly after NIL so
298 ;;; that the system can compute their address by adding a constant
299 ;;; amount to NIL.
300 ;;;
301 ;;; The fdefn objects for the static functions are loaded into static
302 ;;; space directly after the static symbols. That way, the raw-addr
303 ;;; can be loaded directly out of them by indirecting relative to NIL.
304 ;;;
305 ;;; pfw X86 doesn't have enough registers to keep these things there.
306 ;;;     Note these spaces grow from low to high addresses.
307 (defvar *allocation-pointer*)
308 (defvar *binding-stack-pointer*)
309
310 (defparameter *static-symbols*
311   (append
312    *common-static-symbols*
313    *c-callable-static-symbols*
314    '(*alien-stack*
315
316      ;; interrupt handling
317      *pseudo-atomic-bits*
318      #!+sb-thread *stop-for-gc-pending*
319      #!+sb-thread *free-tls-index*
320      #!+sb-thread *tls-index-lock*
321
322      *allocation-pointer*
323      *binding-stack-pointer*
324
325      ;; the floating point constants
326      *fp-constant-0d0*
327      *fp-constant-1d0*
328      *fp-constant-0f0*
329      *fp-constant-1f0*
330      ;; The following are all long-floats.
331      *fp-constant-0l0*
332      *fp-constant-1l0*
333      *fp-constant-pi*
334      *fp-constant-l2t*
335      *fp-constant-l2e*
336      *fp-constant-lg2*
337      *fp-constant-ln2*
338
339      ;; For GC-AND-SAVE
340      *restart-lisp-function*
341
342      ;; Needed for callbacks to work across saving cores. see
343      ;; ALIEN-CALLBACK-ASSEMBLER-WRAPPER in c-call.lisp for gory
344      ;; details.
345      sb!alien::*enter-alien-callback*
346
347      ;; see comments in ../x86-64/parms.lisp
348      sb!pcl::..slot-unbound..)))
349
350 (defparameter *static-funs*
351   '(length
352     sb!kernel:two-arg-+
353     sb!kernel:two-arg--
354     sb!kernel:two-arg-*
355     sb!kernel:two-arg-/
356     sb!kernel:two-arg-<
357     sb!kernel:two-arg->
358     sb!kernel:two-arg-=
359     eql
360     sb!kernel:%negate
361     sb!kernel:two-arg-and
362     sb!kernel:two-arg-ior
363     sb!kernel:two-arg-xor
364     sb!kernel:two-arg-gcd
365     sb!kernel:two-arg-lcm))
366 \f
367 ;;;; stuff added by jrd
368
369 ;;; FIXME: Is this used? Delete it or document it.
370 ;;; cf the sparc PARMS.LISP
371 (defparameter *assembly-unit-length* 8)