702b3349a1eaa5fea41a3d20bb7be27859f63259
[sbcl.git] / 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 64)
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 64)
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) 32 1))
82
83 (def!constant long-float-digits
84   (+ (byte-size long-float-significand-byte) 32 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 (defconstant-eqx float-rounding-mode     (byte 2 10) #'equalp)
100 (defconstant-eqx float-sticky-bits       (byte 6 16) #'equalp)
101 (defconstant-eqx float-traps-byte        (byte 6  0) #'equalp)
102 (defconstant-eqx float-exceptions-byte   (byte 6 16) #'equalp)
103 (defconstant-eqx float-precision-control (byte 2  8) #'equalp)
104 (def!constant float-fast-bit 0) ; no fast mode on x86
105 \f
106 ;;;; description of the target address space
107
108 ;;; where to put the different spaces.  untested (copied from x86, in fact)
109
110
111 (def!constant read-only-space-start #x01000000)
112 (def!constant read-only-space-end   #x037ff000)
113
114 (def!constant static-space-start    #x05000000)
115 (def!constant static-space-end      #x07fff000)
116
117 (def!constant dynamic-space-start   #x09000000)
118 (def!constant dynamic-space-end     #x29000000)
119
120 \f
121 ;;;; other miscellaneous constants
122
123 (defenum (:suffix -trap :start 8)
124   halt
125   pending-interrupt
126   error
127   cerror
128   breakpoint
129   fun-end-breakpoint
130   single-step-breakpoint)
131 ;;; FIXME: It'd be nice to replace all the DEFENUMs with something like
132 ;;;   (WITH-DEF-ENUM (:START 8)
133 ;;;     (DEF-ENUM HALT-TRAP)
134 ;;;     (DEF-ENUM PENDING-INTERRUPT-TRAP)
135 ;;;     ..)
136 ;;; for the benefit of anyone doing a lexical search for definitions
137 ;;; of these symbols.
138
139 (defenum (:prefix object-not- :suffix -trap :start 16)
140   list
141   instance)
142
143 (defenum (:prefix trace-table-)
144   normal
145   call-site
146   fun-prologue
147   fun-epilogue)
148 \f
149 ;;;; static symbols
150
151 ;;; These symbols are loaded into static space directly after NIL so
152 ;;; that the system can compute their address by adding a constant
153 ;;; amount to NIL.
154 ;;;
155 ;;; The fdefn objects for the static functions are loaded into static
156 ;;; space directly after the static symbols. That way, the raw-addr
157 ;;; can be loaded directly out of them by indirecting relative to NIL.
158 ;;;
159 ;;; we could profitably keep these in registers on x86-64 now we have
160 ;;; r8-r15 as well
161 ;;;     Note these spaces grow from low to high addresses.
162 (defvar *allocation-pointer*)
163 (defvar *binding-stack-pointer*)
164
165 ;;; FIXME: !COLD-INIT probably doesn't need
166 ;;; to be in the static symbols table any more.
167 (defparameter *static-symbols*
168   '(t
169
170     ;; The C startup code must fill these in.
171     *posix-argv*
172
173     ;; functions that the C code needs to call.  When adding to this list,
174     ;; also add a `frob' form in genesis.lisp finish-symbols.
175     sub-gc
176     sb!kernel::internal-error
177     sb!kernel::control-stack-exhausted-error
178     sb!di::handle-breakpoint
179     fdefinition-object
180     #!+sb-thread sb!thread::handle-thread-exit
181
182     ;; free pointers
183     ;; 
184     ;; Note that these are FIXNUM word counts, not (as one might
185     ;; expect) byte counts or SAPs. The reason seems to be that by
186     ;; representing them this way, we can avoid consing bignums. 
187     ;; -- WHN 2000-10-02
188     *read-only-space-free-pointer*
189     *static-space-free-pointer*
190     *initial-dynamic-space-free-pointer*
191
192     ;; things needed for non-local exit
193     *current-catch-block*
194     *current-unwind-protect-block*
195     *alien-stack*
196
197     ;; interrupt handling
198     *pseudo-atomic-atomic*
199     *pseudo-atomic-interrupted*
200     sb!unix::*interrupts-enabled*
201     sb!unix::*interrupt-pending*
202     *free-interrupt-context-index*
203
204     *free-tls-index*
205     
206     *allocation-pointer*
207     *binding-stack-pointer*
208     *binding-stack-start*
209     *control-stack-start*
210     *control-stack-end*
211
212     ;; the floating point constants
213     *fp-constant-0d0*
214     *fp-constant-1d0*
215     *fp-constant-0f0*
216     *fp-constant-1f0*
217     ;; The following are all long-floats.
218     *fp-constant-0l0*
219     *fp-constant-1l0*
220     *fp-constant-pi*
221     *fp-constant-l2t*
222     *fp-constant-l2e*
223     *fp-constant-lg2*
224     *fp-constant-ln2*
225
226     ;; The ..SLOT-UNBOUND.. symbol is static in order to optimise the
227     ;; common slot unbound check.
228     ;;
229     ;; FIXME: In SBCL, the CLOS code has become sufficiently tightly
230     ;; integrated into the system that it'd probably make sense to use
231     ;; the ordinary unbound marker for this.
232     sb!pcl::..slot-unbound..))
233
234 (defparameter *static-funs*
235   '(length
236     sb!kernel:two-arg-+
237     sb!kernel:two-arg--
238     sb!kernel:two-arg-*
239     sb!kernel:two-arg-/
240     sb!kernel:two-arg-<
241     sb!kernel:two-arg->
242     sb!kernel:two-arg-=
243     eql
244     sb!kernel:%negate
245     sb!kernel:two-arg-and
246     sb!kernel:two-arg-ior
247     sb!kernel:two-arg-xor
248     sb!kernel:two-arg-gcd
249     sb!kernel:two-arg-lcm))
250 \f
251 ;;;; stuff added by jrd
252
253 ;;; FIXME: Is this used? Delete it or document it.
254 ;;; cf the sparc PARMS.LISP
255 (defparameter *assembly-unit-length* 8)