d4cda7266985bd4590099c9b3cbc9781895ab046
[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 (file-comment
17  "$Header$")
18
19 ;;; ### Note: we simultaneously use ``word'' to mean a 32 bit quantity
20 ;;; and a 16 bit quantity depending on context. This is because Intel
21 ;;; insists on calling 16 bit things words and 32 bit things
22 ;;; double-words (or dwords). Therefore, in the instruction definition
23 ;;; and register specs, we use the Intel convention. But whenever we
24 ;;; are talking about stuff the rest of the lisp system might be
25 ;;; interested in, we use ``word'' to mean the size of a descriptor
26 ;;; object, which is 32 bits.
27 \f
28 ;;;; machine architecture parameters
29
30 (eval-when (:compile-toplevel :load-toplevel :execute)
31
32 (defconstant word-bits 32
33   #!+sb-doc
34   "Number of bits per word where a word holds one lisp descriptor.")
35
36 (defconstant byte-bits 8
37   #!+sb-doc
38   "Number of bits per byte where a byte is the smallest addressable object.")
39
40 (defconstant word-shift (1- (integer-length (/ word-bits byte-bits)))
41   #!+sb-doc
42   "Number of bits to shift between word addresses and byte addresses.")
43
44 (defconstant word-bytes (/ word-bits byte-bits)
45   #!+sb-doc
46   "Number of bytes in a word.")
47
48 ) ; EVAL-WHEN
49
50 (eval-when (:compile-toplevel :load-toplevel :execute)
51 (defconstant float-sign-shift 31)
52
53 ;; These values were taken from the alpha code. The values for
54 ;; bias and exponent min/max are not the same as shown in the 486 book.
55 ;; They may be correct for how Python uses them.
56 (defconstant single-float-bias 126)     ; Intel says 127
57 (defconstant single-float-exponent-byte (byte 8 23))
58 (defconstant single-float-significand-byte (byte 23 0))
59 ;; The 486 book shows the exponent range -126 to +127. The Lisp
60 ;; code that uses these values seems to want already biased numbers.
61 (defconstant single-float-normal-exponent-min 1)
62 (defconstant single-float-normal-exponent-max 254)
63 (defconstant single-float-hidden-bit (ash 1 23))
64 (defconstant single-float-trapping-nan-bit (ash 1 22))
65
66 (defconstant double-float-bias 1022)
67 (defconstant double-float-exponent-byte (byte 11 20))
68 (defconstant double-float-significand-byte (byte 20 0))
69 (defconstant double-float-normal-exponent-min 1)
70 (defconstant double-float-normal-exponent-max #x7FE)
71 (defconstant double-float-hidden-bit (ash 1 20))
72 (defconstant double-float-trapping-nan-bit (ash 1 19))
73
74 (defconstant long-float-bias 16382)
75 (defconstant long-float-exponent-byte (byte 15 0))
76 (defconstant long-float-significand-byte (byte 31 0))
77 (defconstant long-float-normal-exponent-min 1)
78 (defconstant long-float-normal-exponent-max #x7FFE)
79 (defconstant long-float-hidden-bit (ash 1 31))          ; Actually not hidden
80 (defconstant long-float-trapping-nan-bit (ash 1 30))
81
82 (defconstant single-float-digits
83   (+ (byte-size single-float-significand-byte) 1))
84
85 (defconstant double-float-digits
86   (+ (byte-size double-float-significand-byte) word-bits 1))
87
88 (defconstant long-float-digits
89   (+ (byte-size long-float-significand-byte) word-bits 1))
90
91 ;;; pfw -- from i486 microprocessor programmers reference manual
92 (defconstant float-invalid-trap-bit     (ash 1 0))
93 (defconstant float-denormal-trap-bit       (ash 1 1))
94 (defconstant float-divide-by-zero-trap-bit (ash 1 2))
95 (defconstant float-overflow-trap-bit       (ash 1 3))
96 (defconstant float-underflow-trap-bit      (ash 1 4))
97 (defconstant float-inexact-trap-bit     (ash 1 5))
98
99 (defconstant float-round-to-nearest  0)
100 (defconstant float-round-to-negative 1)
101 (defconstant float-round-to-positive 2)
102 (defconstant float-round-to-zero     3)
103
104 (defconstant float-rounding-mode   (byte 2 10))
105 (defconstant float-sticky-bits     (byte 6 16))
106 (defconstant float-traps-byte      (byte 6  0))
107 (defconstant float-exceptions-byte (byte 6 16))
108 (defconstant float-precision-control (byte 2 8))
109 (defconstant float-fast-bit 0) ; No fast mode on x86
110
111 ); EVAL-WHEN
112 \f
113 ;;;; description of the target address space
114
115 ;;; where to put the different spaces
116 ;;;
117 ;;; FIXME: Couldn't/shouldn't these be DEFCONSTANT instead of DEFPARAMETER?
118 ;;;
119 ;;; FIXME: Since SBCL has a different way of distinguishing between target
120 ;;; and host than the old CMU CL code used, the "TARGET-" prefix is
121 ;;; redundant. Perhaps each *TARGET-FOO* should become *FOO*, probably
122 ;;; at the same time that we unscrew the kludgy way that constants are
123 ;;; duplicated between this file and runtime/x86-validate.h.
124 ;;;
125 ;;; Note: Mostly these values are black magic, inherited from CMU CL
126 ;;; without any documentation. However, there were a few explanatory
127 ;;; comments in the CMU CL sources:
128 ;;;   * On Linux,
129 ;;;     ** The space 0x08000000-0x10000000 is "C program and memory allocation".
130 ;;;     ** The space 0x40000000-0x48000000 is reserved for shared libs.
131 ;;;     ** The space >0xE0000000 is "C stack - Alien stack".
132 ;;;   * On FreeBSD,
133 ;;;     ** The space 0x0E000000-0x10000000 is "Foreign segment".
134 ;;;     ** The space 0x20000000-0x30000000 is reserved for shared libs.
135 ;;; And there have been a few changes since the fork:
136 ;;;   * The FreeBSD STATIC-SPACE-START value was bumped up from
137 ;;;     #x28000000 to #x30000000 when FreeBSD ld.so dynamic linking
138 ;;;     support was added for FreeBSD ca. 20000910. This was to keep from
139 ;;;     stomping on an address range that the dynamic libraries want to use. 
140 ;;;     (They want to use this address range even if we try to reserve it
141 ;;;     with a call to validate() as the first operation in main().)
142
143 #!+linux
144 (progn
145
146   (defconstant read-only-space-start #x01000000)
147   (defconstant read-only-space-end   #x037ff000)
148
149   (defconstant static-space-start    #x05000000)
150   (defconstant static-space-end      #x07fff000)
151
152   (defconstant dynamic-space-start   #x09000000)
153   (defconstant dynamic-space-end     #x29000000)
154
155   (defconstant control-stack-start   #x50000000)
156   (defconstant control-stack-end     #x57fff000)
157
158   (defconstant binding-stack-start   #x60000000)
159   (defconstant binding-stack-end     #x67fff000))
160
161 #!+bsd
162 (progn
163
164   (defconstant read-only-space-start #x10000000)
165   (defconstant read-only-space-end   #x1ffff000)
166
167   (defconstant static-space-start
168     #!+freebsd #x30000000
169     #!+openbsd #x28000000)
170   (defconstant static-space-end      #x37fff000)
171
172   (defconstant binding-stack-start   #x38000000)
173   (defconstant binding-stack-end     #x3ffff000)
174
175   (defconstant control-stack-start   #x40000000)
176   (defconstant control-stack-end     #x47fff000)
177
178   (defconstant dynamic-space-start   #x48000000)
179   (defconstant dynamic-space-end     #x88000000))
180
181 ;;; Given that NIL is the first thing allocated in static space, we
182 ;;; know its value at compile time:
183 (defconstant nil-value (+ static-space-start #xb))
184 \f
185 ;;;; other miscellaneous constants
186
187 (defenum (:suffix -trap :start 8)
188   halt
189   pending-interrupt
190   error
191   cerror
192   breakpoint
193   function-end-breakpoint
194   single-step-breakpoint)
195 ;;; FIXME: It'd be nice to replace all the DEFENUMs with something
196 ;;; a la
197 ;;;   (WITH-DEF-ENUM (:START 8)
198 ;;;     (DEF-ENUM HALT-TRAP)
199 ;;;     (DEF-ENUM PENDING-INTERRUPT-TRAP)
200 ;;;     ..)
201 ;;; for the benefit of anyone doing a lexical search for definitions
202 ;;; of these symbols.
203
204 (defenum (:prefix object-not- :suffix -trap :start 16)
205   list
206   instance)
207
208 (defenum (:prefix trace-table-)
209   normal
210   call-site
211   function-prologue
212   function-epilogue)
213 \f
214 ;;;; static symbols
215
216 ;;; These symbols are loaded into static space directly after NIL so
217 ;;; that the system can compute their address by adding a constant
218 ;;; amount to NIL.
219 ;;;
220 ;;; The fdefn objects for the static functions are loaded into static
221 ;;; space directly after the static symbols. That way, the raw-addr
222 ;;; can be loaded directly out of them by indirecting relative to NIL.
223 ;;;
224 ;;; pfw X86 doesn't have enough registers to keep these things there.
225 ;;;     Note these spaces grow from low to high addresses.
226 (defvar *allocation-pointer*)
227 (defvar *binding-stack-pointer*)
228 (defvar *x86-cgc-active-p*) ; FIXME: Document this.
229 (defvar *static-blue-bag* nil)
230
231 ;;; FIXME: *!INITIAL-FDEFN-OBJECTS* and !COLD-INIT probably don't need
232 ;;; to be in the static symbols table any more. Also, if
233 ;;; *INTERNAL-GC-TRIGGER* really is not used, we can punt it.
234 (defparameter *static-symbols*
235   '(t
236
237     ;; The C startup code must fill these in.
238     *posix-argv*
239     sb!impl::*!initial-fdefn-objects*
240
241     ;; functions that the C code needs to call
242     sb!impl::!cold-init
243     sb!impl::maybe-gc
244     sb!kernel::internal-error
245     sb!di::handle-breakpoint
246     sb!impl::fdefinition-object
247
248     ;; free pointers
249     ;; 
250     ;; Note that these are FIXNUM word counts, not (as one might
251     ;; expect) byte counts or SAPs. The reason seems to be that by
252     ;; representing them this way, we can avoid consing bignums. 
253     ;; -- WHN 2000-10-02
254     *read-only-space-free-pointer*
255     *static-space-free-pointer*
256     *initial-dynamic-space-free-pointer*
257
258     ;; things needed for non-local exit
259     sb!impl::*current-catch-block*
260     sb!impl::*current-unwind-protect-block*
261     sb!c::*eval-stack-top*
262     sb!vm::*alien-stack*
263
264     ;; interrupt handling
265     sb!impl::*pseudo-atomic-atomic*
266     sb!impl::*pseudo-atomic-interrupted*
267     sb!unix::*interrupts-enabled*
268     sb!unix::*interrupt-pending*
269     sb!impl::*free-interrupt-context-index*
270
271     sb!vm::*allocation-pointer*
272     sb!vm::*binding-stack-pointer*
273     sb!vm::*internal-gc-trigger*   ; Not used.
274
275     ;; the floating point constants
276     sb!vm::*fp-constant-0d0*
277     sb!vm::*fp-constant-1d0*
278     sb!vm::*fp-constant-0s0*
279     sb!vm::*fp-constant-1s0*
280     ;; The following are all long-floats.
281     sb!vm::*fp-constant-0l0*
282     sb!vm::*fp-constant-1l0*
283     sb!vm::*fp-constant-pi*
284     sb!vm::*fp-constant-l2t*
285     sb!vm::*fp-constant-l2e*
286     sb!vm::*fp-constant-lg2*
287     sb!vm::*fp-constant-ln2*
288
289     ;; used by gencgc
290     sb!vm::*scavenge-read-only-space*
291
292     ;; The ..SLOT-UNBOUND.. symbol is static in order to optimise the
293     ;; common slot unbound check.
294     sb!pcl::..slot-unbound..
295
296     ;; spare symbols
297     sb!vm::spare-10
298     sb!vm::spare-9
299     sb!vm::spare-8
300     sb!vm::spare-7
301     sb!vm::spare-6
302     sb!vm::spare-5
303     sb!vm::spare-4
304     sb!vm::spare-3
305     sb!vm::spare-2
306     sb!vm::spare-1
307
308     ;; used by cgc
309     sb!vm::*x86-cgc-active-p*
310     sb!vm::*static-blue-bag*            ; must be last or change C code
311     ))
312
313 (defparameter *static-functions*
314   '(length
315     sb!kernel:two-arg-+
316     sb!kernel:two-arg--
317     sb!kernel:two-arg-*
318     sb!kernel:two-arg-/
319     sb!kernel:two-arg-<
320     sb!kernel:two-arg->
321     sb!kernel:two-arg-=
322     eql
323     sb!kernel:%negate
324     sb!kernel:two-arg-and
325     sb!kernel:two-arg-ior
326     sb!kernel:two-arg-xor
327     sb!kernel:two-arg-gcd
328     sb!kernel:two-arg-lcm))
329 \f
330 ;;;; stuff added by jrd
331
332 ;;; FIXME: Is this used? Delete it or document it.
333 ;;; cf the sparc PARMS.LISP
334 (defparameter *assembly-unit-length* 8)