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