0.8.11.4:
[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 number of bits to shift between word addresses and byte addresses
39 (def!constant word-shift (1- (integer-length (/ n-word-bits n-byte-bits))))
40
41 ;;; the number of bytes in a word
42 (def!constant n-word-bytes (/ n-word-bits n-byte-bits))
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 #!+linux
157 (progn
158
159   (def!constant read-only-space-start #x01000000)
160   (def!constant read-only-space-end   #x037ff000)
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 #!+(or freebsd openbsd)
169 (progn
170
171   (def!constant read-only-space-start
172     #!+freebsd #x10000000
173     #!+openbsd #x40000000)
174   (def!constant read-only-space-end
175     #!+freebsd #x1ffff000
176     #!+openbsd #x47fff000)
177
178   (def!constant static-space-start
179     #!+freebsd #x30000000
180     #!+openbsd #x50000000)
181   (def!constant static-space-end
182     #!+freebsd #x37fff000
183     #!+openbsd #x5ffff000)
184
185   (def!constant dynamic-space-start
186     #!+freebsd  #x48000000
187     #!+openbsd  #x80000000)
188   (def!constant dynamic-space-end
189     #!+freebsd #x88000000
190     #!+openbsd #xA0000000))
191
192 #!+netbsd
193 (progn
194
195   (def!constant read-only-space-start #x20000000)
196   (def!constant read-only-space-end   #x2ffff000)
197
198   (def!constant static-space-start    #x30000000)
199   (def!constant static-space-end      #x37fff000)
200
201   (def!constant dynamic-space-start   #x60000000)
202   (def!constant dynamic-space-end     #x98000000))
203
204
205 ;;; Given that NIL is the first thing allocated in static space, we
206 ;;; know its value at compile time:
207 (def!constant nil-value (+ static-space-start #xb))
208 \f
209 ;;;; other miscellaneous constants
210
211 (defenum (:suffix -trap :start 8)
212   halt
213   pending-interrupt
214   error
215   cerror
216   breakpoint
217   fun-end-breakpoint
218   single-step-breakpoint)
219 ;;; FIXME: It'd be nice to replace all the DEFENUMs with something like
220 ;;;   (WITH-DEF-ENUM (:START 8)
221 ;;;     (DEF-ENUM HALT-TRAP)
222 ;;;     (DEF-ENUM PENDING-INTERRUPT-TRAP)
223 ;;;     ..)
224 ;;; for the benefit of anyone doing a lexical search for definitions
225 ;;; of these symbols.
226
227 (defenum (:prefix object-not- :suffix -trap :start 16)
228   list
229   instance)
230
231 (defenum (:prefix trace-table-)
232   normal
233   call-site
234   fun-prologue
235   fun-epilogue)
236 \f
237 ;;;; static symbols
238
239 ;;; These symbols are loaded into static space directly after NIL so
240 ;;; that the system can compute their address by adding a constant
241 ;;; amount to NIL.
242 ;;;
243 ;;; The fdefn objects for the static functions are loaded into static
244 ;;; space directly after the static symbols. That way, the raw-addr
245 ;;; can be loaded directly out of them by indirecting relative to NIL.
246 ;;;
247 ;;; pfw X86 doesn't have enough registers to keep these things there.
248 ;;;     Note these spaces grow from low to high addresses.
249 (defvar *allocation-pointer*)
250 (defvar *binding-stack-pointer*)
251
252 ;;; FIXME: !COLD-INIT probably doesn't need
253 ;;; to be in the static symbols table any more.
254 (defparameter *static-symbols*
255   '(t
256
257     ;; The C startup code must fill these in.
258     *posix-argv*
259
260     ;; functions that the C code needs to call.  When adding to this list,
261     ;; also add a `frob' form in genesis.lisp finish-symbols.
262     sub-gc
263     sb!kernel::internal-error
264     sb!kernel::control-stack-exhausted-error
265     sb!di::handle-breakpoint
266     fdefinition-object
267     #!+sb-thread sb!thread::handle-thread-exit
268
269     ;; free pointers
270     ;; 
271     ;; Note that these are FIXNUM word counts, not (as one might
272     ;; expect) byte counts or SAPs. The reason seems to be that by
273     ;; representing them this way, we can avoid consing bignums. 
274     ;; -- WHN 2000-10-02
275     *read-only-space-free-pointer*
276     *static-space-free-pointer*
277     *initial-dynamic-space-free-pointer*
278
279     ;; things needed for non-local exit
280     *current-catch-block*
281     *current-unwind-protect-block*
282     *alien-stack*
283
284     ;; interrupt handling
285     *pseudo-atomic-atomic*
286     *pseudo-atomic-interrupted*
287     sb!unix::*interrupts-enabled*
288     sb!unix::*interrupt-pending*
289     *free-interrupt-context-index*
290
291     *free-tls-index*
292     
293     *allocation-pointer*
294     *binding-stack-pointer*
295     *binding-stack-start*
296     *control-stack-start*
297     *control-stack-end*
298
299     ;; the floating point constants
300     *fp-constant-0d0*
301     *fp-constant-1d0*
302     *fp-constant-0f0*
303     *fp-constant-1f0*
304     ;; The following are all long-floats.
305     *fp-constant-0l0*
306     *fp-constant-1l0*
307     *fp-constant-pi*
308     *fp-constant-l2t*
309     *fp-constant-l2e*
310     *fp-constant-lg2*
311     *fp-constant-ln2*
312
313     ;; The ..SLOT-UNBOUND.. symbol is static in order to optimise the
314     ;; common slot unbound check.
315     ;;
316     ;; FIXME: In SBCL, the CLOS code has become sufficiently tightly
317     ;; integrated into the system that it'd probably make sense to use
318     ;; the ordinary unbound marker for this.
319     sb!pcl::..slot-unbound..))
320
321 (defparameter *static-funs*
322   '(length
323     sb!kernel:two-arg-+
324     sb!kernel:two-arg--
325     sb!kernel:two-arg-*
326     sb!kernel:two-arg-/
327     sb!kernel:two-arg-<
328     sb!kernel:two-arg->
329     sb!kernel:two-arg-=
330     eql
331     sb!kernel:%negate
332     sb!kernel:two-arg-and
333     sb!kernel:two-arg-ior
334     sb!kernel:two-arg-xor
335     sb!kernel:two-arg-gcd
336     sb!kernel:two-arg-lcm))
337 \f
338 ;;;; stuff added by jrd
339
340 ;;; FIXME: Is this used? Delete it or document it.
341 ;;; cf the sparc PARMS.LISP
342 (defparameter *assembly-unit-length* 8)