1 ;;;; miscellaneous VM definition noise for the x86-64
3 ;;;; This software is part of the SBCL system. See the README file for
6 ;;;; This software is derived from the CMU CL system, which was
7 ;;;; written at Carnegie Mellon University and released into the
8 ;;;; public domain. The software is in the public domain and is
9 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
10 ;;;; files for more information.
14 ;;; the size of an INTEGER representation of a SYSTEM-AREA-POINTER, i.e.
15 ;;; size of a native memory address
16 (deftype sap-int
() '(unsigned-byte 64))
20 (eval-when (:compile-toplevel
:load-toplevel
:execute
)
21 (defvar *byte-register-names
* (make-array 32 :initial-element nil
))
22 (defvar *word-register-names
* (make-array 32 :initial-element nil
))
23 (defvar *dword-register-names
* (make-array 32 :initial-element nil
))
24 (defvar *qword-register-names
* (make-array 32 :initial-element nil
))
25 (defvar *float-register-names
* (make-array 16 :initial-element nil
)))
27 (macrolet ((defreg (name offset size
)
28 (let ((offset-sym (symbolicate name
"-OFFSET"))
29 (names-vector (symbolicate "*" size
"-REGISTER-NAMES*")))
31 (eval-when (:compile-toplevel
:load-toplevel
:execute
)
32 ;; EVAL-WHEN is necessary because stuff like #.EAX-OFFSET
33 ;; (in the same file) depends on compile-time evaluation
34 ;; of the DEFCONSTANT. -- AL 20010224
35 (def!constant
,offset-sym
,offset
))
36 (setf (svref ,names-vector
,offset-sym
)
37 ,(symbol-name name
)))))
38 ;; FIXME: It looks to me as though DEFREGSET should also
39 ;; define the related *FOO-REGISTER-NAMES* variable.
40 (defregset (name &rest regs
)
41 `(eval-when (:compile-toplevel
:load-toplevel
:execute
)
43 (list ,@(mapcar (lambda (name)
44 (symbolicate name
"-OFFSET"))
49 ;; Note: the encoding here is different than that used by the chip.
50 ;; We use this encoding so that the compiler thinks that AX (and
51 ;; EAX) overlap AL and AH instead of AL and CL.
53 ;; High-byte are registers disabled on AMD64, since they can't be
54 ;; encoded for an op that has a REX-prefix and we don't want to
55 ;; add special cases into the code generation. The overlap doesn't
56 ;; therefore exist anymore, but the numbering hasn't been changed
66 (defreg r10b
20 :byte
)
67 (defreg r11b
22 :byte
)
68 (defreg r12b
24 :byte
)
69 (defreg r13b
26 :byte
)
70 (defreg r14b
28 :byte
)
71 (defreg r15b
30 :byte
)
72 (defregset *byte-regs
*
73 al cl dl bl sil dil r8b r9b r10b
74 #+nil r11b
#+nil r12b r13b r14b r15b
)
87 (defreg r10w
20 :word
)
88 (defreg r11w
22 :word
)
89 (defreg r12w
24 :word
)
90 (defreg r13w
26 :word
)
91 (defreg r14w
28 :word
)
92 (defreg r15w
30 :word
)
93 (defregset *word-regs
* ax cx dx bx si di r8w r9w r10w
94 #+nil r11w
#+nil r12w r13w r14w r15w
)
96 ;; double word registers
100 (defreg ebx
6 :dword
)
101 (defreg esp
8 :dword
)
102 (defreg ebp
10 :dword
)
103 (defreg esi
12 :dword
)
104 (defreg edi
14 :dword
)
105 (defreg r8d
16 :dword
)
106 (defreg r9d
18 :dword
)
107 (defreg r10d
20 :dword
)
108 (defreg r11d
22 :dword
)
109 (defreg r12d
24 :dword
)
110 (defreg r13d
26 :dword
)
111 (defreg r14d
28 :dword
)
112 (defreg r15d
30 :dword
)
113 (defregset *dword-regs
* eax ecx edx ebx esi edi r8d r9d r10d
114 #+nil r11d
#+nil r12w r13d r14d r15d
)
116 ;; quadword registers
117 (defreg rax
0 :qword
)
118 (defreg rcx
2 :qword
)
119 (defreg rdx
4 :qword
)
120 (defreg rbx
6 :qword
)
121 (defreg rsp
8 :qword
)
122 (defreg rbp
10 :qword
)
123 (defreg rsi
12 :qword
)
124 (defreg rdi
14 :qword
)
125 (defreg r8
16 :qword
)
126 (defreg r9
18 :qword
)
127 (defreg r10
20 :qword
)
128 (defreg r11
22 :qword
)
129 (defreg r12
24 :qword
)
130 (defreg r13
26 :qword
)
131 (defreg r14
28 :qword
)
132 (defreg r15
30 :qword
)
133 ;; for no good reason at the time, r12 and r13 were missed from the
134 ;; list of qword registers. However
135 ;; <jsnell> r13 is already used as temporary [#lisp irc 2005/01/30]
136 ;; and we're now going to use r12 for the struct thread*
138 ;; Except that now we use r11 instead of r13 as the temporary,
139 ;; since it's got a more compact encoding than r13, and experimentally
140 ;; the temporary gets used more than the other registers that are never
141 ;; wired. -- JES, 2005-11-02
142 (defregset *qword-regs
* rax rcx rdx rbx rsi rdi
143 r8 r9 r10
#+nil r11
#+nil r12 r13 r14 r15
)
145 ;; floating point registers
146 (defreg float0
0 :float
)
147 (defreg float1
1 :float
)
148 (defreg float2
2 :float
)
149 (defreg float3
3 :float
)
150 (defreg float4
4 :float
)
151 (defreg float5
5 :float
)
152 (defreg float6
6 :float
)
153 (defreg float7
7 :float
)
154 (defreg float8
8 :float
)
155 (defreg float9
9 :float
)
156 (defreg float10
10 :float
)
157 (defreg float11
11 :float
)
158 (defreg float12
12 :float
)
159 (defreg float13
13 :float
)
160 (defreg float14
14 :float
)
161 (defreg float15
15 :float
)
162 (defregset *float-regs
* float0 float1 float2 float3 float4 float5 float6 float7
163 float8 float9 float10 float11 float12 float13 float14 float15
)
165 ;; registers used to pass arguments
167 ;; the number of arguments/return values passed in registers
168 (def!constant register-arg-count
3)
169 ;; names and offsets for registers used to pass arguments
170 (eval-when (:compile-toplevel
:load-toplevel
:execute
)
171 (defparameter *register-arg-names
* '(rdx rdi rsi
)))
172 (defregset *register-arg-offsets
* rdx rdi rsi
)
173 (defregset *c-call-register-arg-offsets
* rdi rsi rdx rcx r8 r9
))
177 ;;; There are 16 registers really, but we consider them 32 in order to
178 ;;; describe the overlap of byte registers. The only thing we need to
179 ;;; represent is what registers overlap. Therefore, we consider bytes
180 ;;; to take one unit, and [dq]?words to take two. We don't need to
181 ;;; tell the difference between [dq]?words, because you can't put two
182 ;;; words in a dword register.
183 (define-storage-base registers
:finite
:size
32)
185 (define-storage-base float-registers
:finite
:size
16)
187 (define-storage-base stack
:unbounded
:size
8)
188 (define-storage-base constant
:non-packed
)
189 (define-storage-base immediate-constant
:non-packed
)
190 (define-storage-base noise
:unbounded
:size
2)
194 ;;; a handy macro so we don't have to keep changing all the numbers whenever
195 ;;; we insert a new storage class
197 (defmacro !define-storage-classes
(&rest classes
)
200 (dolist (class classes
)
201 (let* ((sc-name (car class
))
202 (constant-name (symbolicate sc-name
"-SC-NUMBER")))
203 (forms `(define-storage-class ,sc-name
,index
205 (forms `(def!constant
,constant-name
,index
))
210 ;;; The DEFINE-STORAGE-CLASS call for CATCH-BLOCK refers to the size
211 ;;; of CATCH-BLOCK. The size of CATCH-BLOCK isn't calculated until
212 ;;; later in the build process, and the calculation is entangled with
213 ;;; code which has lots of predependencies, including dependencies on
214 ;;; the prior call of DEFINE-STORAGE-CLASS. The proper way to
215 ;;; unscramble this would be to untangle the code, so that the code
216 ;;; which calculates the size of CATCH-BLOCK can be separated from the
217 ;;; other lots-of-dependencies code, so that the code which calculates
218 ;;; the size of CATCH-BLOCK can be executed early, so that this value
219 ;;; is known properly at this point in compilation. However, that
220 ;;; would be a lot of editing of code that I (WHN 19990131) can't test
221 ;;; until the project is complete. So instead, I set the correct value
222 ;;; by hand here (a sort of nondeterministic guess of the right
223 ;;; answer:-) and add an assertion later, after the value is
224 ;;; calculated, that the original guess was correct.
226 ;;; (What a KLUDGE! Anyone who wants to come in and clean up this mess
227 ;;; has my gratitude.) (FIXME: Maybe this should be me..)
228 (eval-when (:compile-toplevel
:load-toplevel
:execute
)
229 (def!constant kludge-nondeterministic-catch-block-size
5))
231 (!define-storage-classes
233 ;; non-immediate constants in the constant pool
236 (fp-single-zero immediate-constant
)
237 (fp-double-zero immediate-constant
)
238 (fp-complex-single-zero immediate-constant
)
239 (fp-complex-double-zero immediate-constant
)
241 (fp-single-immediate immediate-constant
)
242 (fp-double-immediate immediate-constant
)
243 (fp-complex-single-immediate immediate-constant
)
244 (fp-complex-double-immediate immediate-constant
)
246 (immediate immediate-constant
)
253 (control-stack stack
) ; may be pointers, scanned by GC
255 ;; the non-descriptor stacks
256 ;; XXX alpha backend has :element-size 2 :alignment 2 in these entries
257 (signed-stack stack
) ; (signed-byte 64)
258 (unsigned-stack stack
) ; (unsigned-byte 64)
259 (character-stack stack
) ; non-descriptor characters.
260 (sap-stack stack
) ; System area pointers.
261 (single-stack stack
) ; single-floats
263 (complex-single-stack stack
) ; complex-single-floats
264 (complex-double-stack stack
:element-size
2) ; complex-double-floats
265 (sse-stack stack
:element-size
2)
274 ;; things that can go in the integer registers
277 ;; On the X86, we don't have to distinguish between descriptor and
278 ;; non-descriptor registers, because of the conservative GC.
279 ;; Therefore, we use different scs only to distinguish between
280 ;; descriptor and non-descriptor values and to specify size.
282 ;; immediate descriptor objects. Don't have to be seen by GC, but nothing
283 ;; bad will happen if they are. (fixnums, characters, header values, etc).
285 :locations
#.
*qword-regs
*
286 :element-size
2 ; I think this is for the al/ah overlap thing
287 :constant-scs
(immediate)
289 :alternate-scs
(control-stack))
291 ;; pointer descriptor objects -- must be seen by GC
292 (descriptor-reg registers
293 :locations
#.
*qword-regs
*
295 ; :reserve-locations (#.eax-offset)
296 :constant-scs
(constant immediate
)
298 :alternate-scs
(control-stack))
300 ;; non-descriptor characters
301 (character-reg registers
302 :locations
#!-sb-unicode
#.
*byte-regs
*
303 #!+sb-unicode
#.
*qword-regs
*
304 #!+sb-unicode
#!+sb-unicode
306 #!-sb-unicode
#!-sb-unicode
307 :reserve-locations
(#.al-offset
)
308 :constant-scs
(immediate)
310 :alternate-scs
(character-stack))
312 ;; non-descriptor SAPs (arbitrary pointers into address space)
314 :locations
#.
*qword-regs
*
316 ; :reserve-locations (#.eax-offset)
317 :constant-scs
(immediate)
319 :alternate-scs
(sap-stack))
321 ;; non-descriptor (signed or unsigned) numbers
322 (signed-reg registers
323 :locations
#.
*qword-regs
*
325 :constant-scs
(immediate)
327 :alternate-scs
(signed-stack))
328 (unsigned-reg registers
329 :locations
#.
*qword-regs
*
331 :constant-scs
(immediate)
333 :alternate-scs
(unsigned-stack))
335 ;; miscellaneous objects that must not be seen by GC. Used only as
338 :locations
#.
*word-regs
*
342 :locations
#.
*dword-regs
*
346 :locations
#.
*byte-regs
*
349 ;; that can go in the floating point registers
351 ;; non-descriptor SINGLE-FLOATs
352 (single-reg float-registers
353 :locations
#.
*float-regs
*
354 :constant-scs
(fp-single-zero fp-single-immediate
)
356 :alternate-scs
(single-stack))
358 ;; non-descriptor DOUBLE-FLOATs
359 (double-reg float-registers
360 :locations
#.
*float-regs
*
361 :constant-scs
(fp-double-zero fp-double-immediate
)
363 :alternate-scs
(double-stack))
365 (complex-single-reg float-registers
366 :locations
#.
*float-regs
*
367 :constant-scs
(fp-complex-single-zero fp-complex-single-immediate
)
369 :alternate-scs
(complex-single-stack))
371 (complex-double-reg float-registers
372 :locations
#.
*float-regs
*
373 :constant-scs
(fp-complex-double-zero fp-complex-double-immediate
)
375 :alternate-scs
(complex-double-stack))
377 (sse-reg float-registers
378 :locations
#.
*float-regs
*
381 :alternate-scs
(sse-stack))
383 ;; a catch or unwind block
384 (catch-block stack
:element-size kludge-nondeterministic-catch-block-size
))
386 (eval-when (:compile-toplevel
:load-toplevel
:execute
)
387 (defparameter *byte-sc-names
*
388 '(#!-sb-unicode character-reg byte-reg
#!-sb-unicode character-stack
))
389 (defparameter *word-sc-names
* '(word-reg))
390 (defparameter *dword-sc-names
* '(dword-reg))
391 (defparameter *qword-sc-names
*
392 '(any-reg descriptor-reg sap-reg signed-reg unsigned-reg control-stack
393 signed-stack unsigned-stack sap-stack single-stack
394 #!+sb-unicode character-reg
#!+sb-unicode character-stack constant
))
395 ;;; added by jrd. I guess the right thing to do is to treat floats
396 ;;; as a separate size...
398 ;;; These are used to (at least) determine operand size.
399 (defparameter *float-sc-names
* '(single-reg))
400 (defparameter *double-sc-names
* '(double-reg double-stack
))
401 (defparameter *complex-sc-names
* '(complex-single-reg complex-single-stack
402 complex-double-reg complex-double-stack
))
403 (defparameter *oword-sc-names
* '(sse-reg sse-stack
))
406 ;;;; miscellaneous TNs for the various registers
408 (macrolet ((def-misc-reg-tns (sc-name &rest reg-names
)
410 (dolist (reg-name reg-names
)
411 (let ((tn-name (symbolicate reg-name
"-TN"))
412 (offset-name (symbolicate reg-name
"-OFFSET")))
413 ;; FIXME: It'd be good to have the special
414 ;; variables here be named with the *FOO*
416 (forms `(defparameter ,tn-name
417 (make-random-tn :kind
:normal
418 :sc
(sc-or-lose ',sc-name
)
421 `(progn ,@(forms)))))
423 (def-misc-reg-tns unsigned-reg rax rbx rcx rdx rbp rsp rdi rsi
424 r8 r9 r10 r11 r12 r13 r14 r15
)
425 (def-misc-reg-tns dword-reg eax ebx ecx edx ebp esp edi esi
426 r8d r9d r10d r11d r12d r13d r14d r15d
)
427 (def-misc-reg-tns word-reg ax bx cx dx bp sp di si
428 r8w r9w r10w r11w r12w r13w r14w r15w
)
429 (def-misc-reg-tns byte-reg al cl dl bl sil dil r8b r9b r10b
430 r11b r12b r13b r14b r15b
)
431 (def-misc-reg-tns single-reg
432 float0 float1 float2 float3 float4 float5 float6 float7
433 float8 float9 float10 float11 float12 float13 float14 float15
))
435 (defun reg-in-size (tn size
)
436 (make-random-tn :kind
:normal
442 (:qword
'unsigned-reg
)))
443 :offset
(tn-offset tn
)))
445 ;; A register that's never used by the code generator, and can therefore
446 ;; be used as an assembly temporary in cases where a VOP :TEMPORARY can't
448 (defparameter temp-reg-tn r11-tn
)
450 ;;; TNs for registers used to pass arguments
451 (defparameter *register-arg-tns
*
452 (mapcar (lambda (register-arg-name)
453 (symbol-value (symbolicate register-arg-name
"-TN")))
454 *register-arg-names
*))
456 (defparameter thread-base-tn
457 (make-random-tn :kind
:normal
:sc
(sc-or-lose 'unsigned-reg
)
460 ;;; If value can be represented as an immediate constant, then return
461 ;;; the appropriate SC number, otherwise return NIL.
462 (!def-vm-support-routine immediate-constant-sc
(value)
464 ((or (integer #.sb
!xc
:most-negative-fixnum
#.sb
!xc
:most-positive-fixnum
)
466 (sc-number-or-lose 'immediate
))
468 (when (static-symbol-p value
)
469 (sc-number-or-lose 'immediate
)))
472 (if (eql value
0f0
) 'fp-single-zero
'fp-single-immediate
)))
475 (if (eql value
0d0
) 'fp-double-zero
'fp-double-immediate
)))
476 ((complex single-float
)
478 (if (eql value
#c
(0f0 0f0
))
479 'fp-complex-single-zero
480 'fp-complex-single-immediate
)))
481 ((complex double-float
)
483 (if (eql value
#c
(0d0 0d0
))
484 'fp-complex-double-zero
485 'fp-complex-double-immediate
)))))
488 ;;;; miscellaneous function call parameters
490 ;;; Offsets of special stack frame locations relative to RBP.
492 ;;; Consider the standard prologue PUSH RBP; MOV RBP, RSP: the return
493 ;;; address is at RBP+8, the old control stack frame pointer is at
494 ;;; RBP, the magic 3rd slot is at RBP-8. Then come the locals from
496 (def!constant return-pc-save-offset
0)
497 (def!constant ocfp-save-offset
1)
498 (def!constant code-save-offset
2)
499 ;;; Let SP be the stack pointer before CALLing, and FP is the frame
500 ;;; pointer after the standard prologue. SP +
501 ;;; FRAME-WORD-OFFSET(SP->FP-OFFSET + I) = FP + FRAME-WORD-OFFSET(I).
502 (def!constant sp-
>fp-offset
2)
504 (declaim (inline frame-word-offset
))
505 (defun frame-word-offset (index)
508 (declaim (inline frame-byte-offset
))
509 (defun frame-byte-offset (index)
510 (* (frame-word-offset index
) n-word-bytes
))
512 (def!constant lra-save-offset return-pc-save-offset
) ; ?
514 ;;; This is used by the debugger.
515 (def!constant single-value-return-byte-offset
3)
517 ;;; This function is called by debug output routines that want a pretty name
518 ;;; for a TN's location. It returns a thing that can be printed with PRINC.
519 (!def-vm-support-routine location-print-name
(tn)
520 (declare (type tn tn
))
521 (let* ((sc (tn-sc tn
))
522 (sb (sb-name (sc-sb sc
)))
523 (offset (tn-offset tn
)))
526 (let* ((sc-name (sc-name sc
))
527 (name-vec (cond ((member sc-name
*byte-sc-names
*)
528 *byte-register-names
*)
529 ((member sc-name
*word-sc-names
*)
530 *word-register-names
*)
531 ((member sc-name
*dword-sc-names
*)
532 *dword-register-names
*)
533 ((member sc-name
*qword-sc-names
*)
534 *qword-register-names
*))))
536 (< -
1 offset
(length name-vec
))
537 (svref name-vec offset
))
538 ;; FIXME: Shouldn't this be an ERROR?
539 (format nil
"<unknown reg: off=~W, sc=~A>" offset sc-name
))))
540 (float-registers (format nil
"FLOAT~D" offset
))
541 (stack (format nil
"S~D" offset
))
542 (constant (format nil
"Const~D" offset
))
543 (immediate-constant "Immed")
544 (noise (symbol-name (sc-name sc
))))))
545 ;;; FIXME: Could this, and everything that uses it, be made #!+SB-SHOW?
547 (defun dwords-for-quad (value)
548 (let* ((lo (logand value
(1- (ash 1 32))))
549 (hi (ash value -
32)))
552 (defun words-for-dword (value)
553 (let* ((lo (logand value
(1- (ash 1 16))))
554 (hi (ash value -
16)))
557 (def!constant cfp-offset rbp-offset
) ; pfw - needed by stuff in /code
559 (!def-vm-support-routine combination-implementation-style
(node)
560 (declare (type sb
!c
::combination node
) (ignore node
))
561 (values :default nil
))