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