1 ;;;; that part of the description of the x86-64 instruction set
2 ;;;; which can live on the cross-compilation host
4 ;;;; This software is part of the SBCL system. See the README file for
7 ;;;; This software is derived from the CMU CL system, which was
8 ;;;; written at Carnegie Mellon University and released into the
9 ;;;; public domain. The software is in the public domain and is
10 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
11 ;;;; files for more information.
14 ;;; FIXME: SB!DISASSEM: prefixes are used so widely in this file that
15 ;;; I wonder whether the separation of the disassembler from the
16 ;;; virtual machine is valid or adds value.
18 ;;; Note: In CMU CL, this used to be a call to SET-DISASSEM-PARAMS.
19 (setf sb!disassem:*disassem-inst-alignment-bytes* 1)
21 ;;; This type is used mostly in disassembly and represents legacy
22 ;;; registers only. R8-R15 are handled separately.
23 (deftype reg () '(unsigned-byte 3))
25 ;;; This includes legacy registers and R8-R15.
26 (deftype full-reg () '(unsigned-byte 4))
28 ;;; The XMM registers XMM0 - XMM15.
29 (deftype xmmreg () '(unsigned-byte 4))
31 ;;; Default word size for the chip: if the operand size /= :dword
32 ;;; we need to output #x66 (or REX) prefix
33 (def!constant +default-operand-size+ :dword)
35 ;;; The default address size for the chip. It could be overwritten
36 ;;; to :dword with a #x67 prefix, but this is never needed by SBCL
37 ;;; and thus not supported by this assembler/disassembler.
38 (def!constant +default-address-size+ :qword)
40 (eval-when (#-sb-xc :compile-toplevel :load-toplevel :execute)
42 (defun offset-next (value dstate)
43 (declare (type integer value)
44 (type sb!disassem:disassem-state dstate))
45 (+ (sb!disassem:dstate-next-addr dstate) value))
47 (defparameter *byte-reg-names*
48 #(al cl dl bl spl bpl sil dil r8b r9b r10b r11b r12b r13b r14b r15b))
49 (defparameter *high-byte-reg-names*
51 (defparameter *word-reg-names*
52 #(ax cx dx bx sp bp si di r8w r9w r10w r11w r12w r13w r14w r15w))
53 (defparameter *dword-reg-names*
54 #(eax ecx edx ebx esp ebp esi edi r8d r9d r10d r11d r12d r13d r14d r15d))
55 (defparameter *qword-reg-names*
56 #(rax rcx rdx rbx rsp rbp rsi rdi r8 r9 r10 r11 r12 r13 r14 r15))
58 ;;; The printers for registers, memory references and immediates need to
59 ;;; take into account the width bit in the instruction, whether a #x66
60 ;;; or a REX prefix was issued, and the contents of the REX prefix.
61 ;;; This is implemented using prefilters to put flags into the slot
62 ;;; INST-PROPERTIES of the DSTATE. These flags are the following
65 ;;; OPERAND-SIZE-8 The width bit was zero
66 ;;; OPERAND-SIZE-16 The "operand size override" prefix (#x66) was found
67 ;;; REX A REX prefix was found
68 ;;; REX-W A REX prefix with the "operand width" bit set was
70 ;;; REX-R A REX prefix with the "register" bit set was found
71 ;;; REX-X A REX prefix with the "index" bit set was found
72 ;;; REX-B A REX prefix with the "base" bit set was found
74 ;;; Return the operand size depending on the prefixes and width bit as
76 (defun inst-operand-size (dstate)
77 (declare (type sb!disassem:disassem-state dstate))
78 (cond ((sb!disassem:dstate-get-inst-prop dstate 'operand-size-8)
80 ((sb!disassem:dstate-get-inst-prop dstate 'rex-w)
82 ((sb!disassem:dstate-get-inst-prop dstate 'operand-size-16)
85 +default-operand-size+)))
87 ;;; The same as INST-OPERAND-SIZE, but for those instructions (e.g.
88 ;;; PUSH, JMP) that have a default operand size of :qword. It can only
89 ;;; be overwritten to :word.
90 (defun inst-operand-size-default-qword (dstate)
91 (declare (type sb!disassem:disassem-state dstate))
92 (if (sb!disassem:dstate-get-inst-prop dstate 'operand-size-16)
96 ;;; Print to STREAM the name of the general-purpose register encoded by
97 ;;; VALUE and of size WIDTH. For robustness, the high byte registers
98 ;;; (AH, BH, CH, DH) are correctly detected, too, although the compiler
99 ;;; does not use them.
100 (defun print-reg-with-width (value width stream dstate)
101 (declare (type full-reg value)
103 (type sb!disassem:disassem-state dstate))
104 (princ (if (and (eq width :byte)
106 (not (sb!disassem:dstate-get-inst-prop dstate 'rex)))
107 (aref *high-byte-reg-names* (- value 4))
109 (:byte *byte-reg-names*)
110 (:word *word-reg-names*)
111 (:dword *dword-reg-names*)
112 (:qword *qword-reg-names*))
115 ;; XXX plus should do some source-var notes
118 (defun print-reg (value stream dstate)
119 (declare (type full-reg value)
121 (type sb!disassem:disassem-state dstate))
122 (print-reg-with-width value
123 (inst-operand-size dstate)
127 (defun print-reg-default-qword (value stream dstate)
128 (declare (type full-reg value)
130 (type sb!disassem:disassem-state dstate))
131 (print-reg-with-width value
132 (inst-operand-size-default-qword dstate)
136 (defun print-byte-reg (value stream dstate)
137 (declare (type full-reg value)
139 (type sb!disassem:disassem-state dstate))
140 (print-reg-with-width value :byte stream dstate))
142 (defun print-addr-reg (value stream dstate)
143 (declare (type full-reg value)
145 (type sb!disassem:disassem-state dstate))
146 (print-reg-with-width value +default-address-size+ stream dstate))
148 ;;; Print a register or a memory reference of the given WIDTH.
149 ;;; If SIZED-P is true, add an explicit size indicator for memory
151 (defun print-reg/mem-with-width (value width sized-p stream dstate)
152 (declare (type (or list full-reg) value)
153 (type (member :byte :word :dword :qword) width)
154 (type boolean sized-p)
156 (type sb!disassem:disassem-state dstate))
157 (if (typep value 'full-reg)
158 (print-reg-with-width value width stream dstate)
159 (print-mem-access value (and sized-p width) stream dstate)))
161 ;;; Print a register or a memory reference. The width is determined by
162 ;;; calling INST-OPERAND-SIZE.
163 (defun print-reg/mem (value stream dstate)
164 (declare (type (or list full-reg) value)
166 (type sb!disassem:disassem-state dstate))
167 (print-reg/mem-with-width
168 value (inst-operand-size dstate) nil stream dstate))
170 ;; Same as print-reg/mem, but prints an explicit size indicator for
171 ;; memory references.
172 (defun print-sized-reg/mem (value stream dstate)
173 (declare (type (or list full-reg) value)
175 (type sb!disassem:disassem-state dstate))
176 (print-reg/mem-with-width
177 value (inst-operand-size dstate) t stream dstate))
179 ;;; Same as print-sized-reg/mem, but with a default operand size of
181 (defun print-sized-reg/mem-default-qword (value stream dstate)
182 (declare (type (or list full-reg) value)
184 (type sb!disassem:disassem-state dstate))
185 (print-reg/mem-with-width
186 value (inst-operand-size-default-qword dstate) t stream dstate))
188 (defun print-sized-byte-reg/mem (value stream dstate)
189 (declare (type (or list full-reg) value)
191 (type sb!disassem:disassem-state dstate))
192 (print-reg/mem-with-width value :byte t stream dstate))
194 (defun print-sized-word-reg/mem (value stream dstate)
195 (declare (type (or list full-reg) value)
197 (type sb!disassem:disassem-state dstate))
198 (print-reg/mem-with-width value :word t stream dstate))
200 (defun print-sized-dword-reg/mem (value stream dstate)
201 (declare (type (or list full-reg) value)
203 (type sb!disassem:disassem-state dstate))
204 (print-reg/mem-with-width value :dword t stream dstate))
206 (defun print-label (value stream dstate)
207 (declare (ignore dstate))
208 (sb!disassem:princ16 value stream))
210 (defun print-xmmreg (value stream dstate)
211 (declare (type xmmreg value)
214 (format stream "XMM~d" value))
216 (defun print-xmmreg/mem (value stream dstate)
217 (declare (type (or list xmmreg) value)
219 (type sb!disassem:disassem-state dstate))
220 (if (typep value 'xmmreg)
221 (print-xmmreg value stream dstate)
222 (print-mem-access value nil stream dstate)))
224 ;; Same as print-xmmreg/mem, but prints an explicit size indicator for
225 ;; memory references.
226 (defun print-sized-xmmreg/mem (value stream dstate)
227 (declare (type (or list xmmreg) value)
229 (type sb!disassem:disassem-state dstate))
230 (if (typep value 'xmmreg)
231 (print-xmmreg value stream dstate)
232 (print-mem-access value (inst-operand-size dstate) stream dstate)))
234 ;;; This prefilter is used solely for its side effects, namely to put
235 ;;; the bits found in the REX prefix into the DSTATE for use by other
236 ;;; prefilters and by printers.
237 (defun prefilter-wrxb (value dstate)
238 (declare (type (unsigned-byte 4) value)
239 (type sb!disassem:disassem-state dstate))
240 (sb!disassem:dstate-put-inst-prop dstate 'rex)
241 (when (plusp (logand value #b1000))
242 (sb!disassem:dstate-put-inst-prop dstate 'rex-w))
243 (when (plusp (logand value #b0100))
244 (sb!disassem:dstate-put-inst-prop dstate 'rex-r))
245 (when (plusp (logand value #b0010))
246 (sb!disassem:dstate-put-inst-prop dstate 'rex-x))
247 (when (plusp (logand value #b0001))
248 (sb!disassem:dstate-put-inst-prop dstate 'rex-b))
251 ;;; This prefilter is used solely for its side effect, namely to put
252 ;;; the property OPERAND-SIZE-8 into the DSTATE if VALUE is 0.
253 (defun prefilter-width (value dstate)
254 (declare (type bit value)
255 (type sb!disassem:disassem-state dstate))
257 (sb!disassem:dstate-put-inst-prop dstate 'operand-size-8))
260 ;;; A register field that can be extended by REX.R.
261 (defun prefilter-reg-r (value dstate)
262 (declare (type reg value)
263 (type sb!disassem:disassem-state dstate))
264 (if (sb!disassem::dstate-get-inst-prop dstate 'rex-r)
268 ;;; A register field that can be extended by REX.B.
269 (defun prefilter-reg-b (value dstate)
270 (declare (type reg value)
271 (type sb!disassem:disassem-state dstate))
272 (if (sb!disassem::dstate-get-inst-prop dstate 'rex-b)
276 ;;; Returns either an integer, meaning a register, or a list of
277 ;;; (BASE-REG OFFSET INDEX-REG INDEX-SCALE), where any component
278 ;;; may be missing or nil to indicate that it's not used or has the
279 ;;; obvious default value (e.g., 1 for the index-scale). VALUE is a list
280 ;;; of the mod and r/m field of the ModRM byte of the instruction.
281 ;;; Depending on VALUE a SIB byte and/or an offset may be read. The
282 ;;; REX.B bit from DSTATE is used to extend the sole register or the
283 ;;; BASE-REG to a full register, the REX.X bit does the same for the
285 (defun prefilter-reg/mem (value dstate)
286 (declare (type list value)
287 (type sb!disassem:disassem-state dstate))
288 (let ((mod (first value))
289 (r/m (second value)))
290 (declare (type (unsigned-byte 2) mod)
291 (type (unsigned-byte 3) r/m))
292 (let ((full-reg (if (sb!disassem:dstate-get-inst-prop dstate 'rex-b)
295 (declare (type full-reg full-reg))
301 (let ((sib (sb!disassem:read-suffix 8 dstate)))
302 (declare (type (unsigned-byte 8) sib))
303 (let ((base-reg (ldb (byte 3 0) sib))
304 (index-reg (ldb (byte 3 3) sib))
305 (index-scale (ldb (byte 2 6) sib)))
306 (declare (type (unsigned-byte 3) base-reg index-reg)
307 (type (unsigned-byte 2) index-scale))
311 (if (= base-reg #b101)
312 (sb!disassem:read-signed-suffix 32 dstate)
315 (sb!disassem:read-signed-suffix 8 dstate))
317 (sb!disassem:read-signed-suffix 32 dstate)))))
318 (list (unless (and (= mod #b00) (= base-reg #b101))
319 (if (sb!disassem:dstate-get-inst-prop dstate 'rex-b)
323 (unless (= index-reg #b100)
324 (if (sb!disassem:dstate-get-inst-prop dstate 'rex-x)
327 (ash 1 index-scale))))))
328 ((and (= mod #b00) (= r/m #b101))
329 (list 'rip (sb!disassem:read-signed-suffix 32 dstate)))
333 (list full-reg (sb!disassem:read-signed-suffix 8 dstate)))
335 (list full-reg (sb!disassem:read-signed-suffix 32 dstate)))))))
337 (defun read-address (value dstate)
338 (declare (ignore value)) ; always nil anyway
339 (sb!disassem:read-suffix (width-bits (inst-operand-size dstate)) dstate))
341 (defun width-bits (width)
350 ;;;; disassembler argument types
352 ;;; Used to capture the lower four bits of the REX prefix.
353 (sb!disassem:define-arg-type wrxb
354 :prefilter #'prefilter-wrxb)
356 (sb!disassem:define-arg-type width
357 :prefilter #'prefilter-width
358 :printer (lambda (value stream dstate)
359 (declare (ignore value))
360 (princ (schar (symbol-name (inst-operand-size dstate)) 0)
363 (sb!disassem:define-arg-type displacement
365 :use-label #'offset-next
366 :printer (lambda (value stream dstate)
367 (sb!disassem:maybe-note-assembler-routine value nil dstate)
368 (print-label value stream dstate)))
370 (sb!disassem:define-arg-type accum
371 :printer (lambda (value stream dstate)
372 (declare (ignore value)
374 (type sb!disassem:disassem-state dstate))
375 (print-reg 0 stream dstate)))
377 (sb!disassem:define-arg-type reg
378 :prefilter #'prefilter-reg-r
379 :printer #'print-reg)
381 (sb!disassem:define-arg-type reg-b
382 :prefilter #'prefilter-reg-b
383 :printer #'print-reg)
385 (sb!disassem:define-arg-type reg-b-default-qword
386 :prefilter #'prefilter-reg-b
387 :printer #'print-reg-default-qword)
389 (sb!disassem:define-arg-type imm-addr
390 :prefilter #'read-address
391 :printer #'print-label)
393 ;;; Normally, immediate values for an operand size of :qword are of size
394 ;;; :dword and are sign-extended to 64 bits. For an exception, see the
395 ;;; argument type definition following this one.
396 (sb!disassem:define-arg-type signed-imm-data
397 :prefilter (lambda (value dstate)
398 (declare (ignore value)) ; always nil anyway
399 (let ((width (width-bits (inst-operand-size dstate))))
402 (sb!disassem:read-signed-suffix width dstate))))
404 ;;; Used by the variant of the MOV instruction with opcode B8 which can
405 ;;; move immediates of all sizes (i.e. including :qword) into a
407 (sb!disassem:define-arg-type signed-imm-data-upto-qword
408 :prefilter (lambda (value dstate)
409 (declare (ignore value)) ; always nil anyway
410 (sb!disassem:read-signed-suffix
411 (width-bits (inst-operand-size dstate))
414 ;;; Used by those instructions that have a default operand size of
415 ;;; :qword. Nevertheless the immediate is at most of size :dword.
416 ;;; The only instruction of this kind having a variant with an immediate
417 ;;; argument is PUSH.
418 (sb!disassem:define-arg-type signed-imm-data-default-qword
419 :prefilter (lambda (value dstate)
420 (declare (ignore value)) ; always nil anyway
421 (let ((width (width-bits
422 (inst-operand-size-default-qword dstate))))
425 (sb!disassem:read-signed-suffix width dstate))))
427 (sb!disassem:define-arg-type signed-imm-byte
428 :prefilter (lambda (value dstate)
429 (declare (ignore value)) ; always nil anyway
430 (sb!disassem:read-signed-suffix 8 dstate)))
432 (sb!disassem:define-arg-type imm-byte
433 :prefilter (lambda (value dstate)
434 (declare (ignore value)) ; always nil anyway
435 (sb!disassem:read-suffix 8 dstate)))
437 ;;; needed for the ret imm16 instruction
438 (sb!disassem:define-arg-type imm-word-16
439 :prefilter (lambda (value dstate)
440 (declare (ignore value)) ; always nil anyway
441 (sb!disassem:read-suffix 16 dstate)))
443 (sb!disassem:define-arg-type reg/mem
444 :prefilter #'prefilter-reg/mem
445 :printer #'print-reg/mem)
446 (sb!disassem:define-arg-type sized-reg/mem
447 ;; Same as reg/mem, but prints an explicit size indicator for
448 ;; memory references.
449 :prefilter #'prefilter-reg/mem
450 :printer #'print-sized-reg/mem)
452 ;;; Arguments of type reg/mem with a fixed size.
453 (sb!disassem:define-arg-type sized-byte-reg/mem
454 :prefilter #'prefilter-reg/mem
455 :printer #'print-sized-byte-reg/mem)
456 (sb!disassem:define-arg-type sized-word-reg/mem
457 :prefilter #'prefilter-reg/mem
458 :printer #'print-sized-word-reg/mem)
459 (sb!disassem:define-arg-type sized-dword-reg/mem
460 :prefilter #'prefilter-reg/mem
461 :printer #'print-sized-dword-reg/mem)
463 ;;; Same as sized-reg/mem, but with a default operand size of :qword.
464 (sb!disassem:define-arg-type sized-reg/mem-default-qword
465 :prefilter #'prefilter-reg/mem
466 :printer #'print-sized-reg/mem-default-qword)
469 (sb!disassem:define-arg-type xmmreg
470 :prefilter #'prefilter-reg-r
471 :printer #'print-xmmreg)
473 (sb!disassem:define-arg-type xmmreg/mem
474 :prefilter #'prefilter-reg/mem
475 :printer #'print-xmmreg/mem)
477 (sb!disassem:define-arg-type sized-xmmreg/mem
478 :prefilter #'prefilter-reg/mem
479 :printer #'print-sized-xmmreg/mem)
482 (eval-when (:compile-toplevel :load-toplevel :execute)
483 (defparameter *conditions*
486 (:b . 2) (:nae . 2) (:c . 2)
487 (:nb . 3) (:ae . 3) (:nc . 3)
488 (:eq . 4) (:e . 4) (:z . 4)
495 (:np . 11) (:po . 11)
496 (:l . 12) (:nge . 12)
497 (:nl . 13) (:ge . 13)
498 (:le . 14) (:ng . 14)
499 (:nle . 15) (:g . 15)))
500 (defparameter *condition-name-vec*
501 (let ((vec (make-array 16 :initial-element nil)))
502 (dolist (cond *conditions*)
503 (when (null (aref vec (cdr cond)))
504 (setf (aref vec (cdr cond)) (car cond))))
508 ;;; Set assembler parameters. (In CMU CL, this was done with
509 ;;; a call to a macro DEF-ASSEMBLER-PARAMS.)
510 (eval-when (:compile-toplevel :load-toplevel :execute)
511 (setf sb!assem:*assem-scheduler-p* nil))
513 (sb!disassem:define-arg-type condition-code
514 :printer *condition-name-vec*)
516 (defun conditional-opcode (condition)
517 (cdr (assoc condition *conditions* :test #'eq)))
519 ;;;; disassembler instruction formats
521 (eval-when (:compile-toplevel :execute)
522 (defun swap-if (direction field1 separator field2)
523 `(:if (,direction :constant 0)
524 (,field1 ,separator ,field2)
525 (,field2 ,separator ,field1))))
527 (sb!disassem:define-instruction-format (byte 8 :default-printer '(:name))
528 (op :field (byte 8 0))
533 ;;; A one-byte instruction with a #x66 prefix, used to indicate an
534 ;;; operand size of :word.
535 (sb!disassem:define-instruction-format (x66-byte 16
536 :default-printer '(:name))
537 (x66 :field (byte 8 0) :value #x66)
538 (op :field (byte 8 8)))
540 ;;; A one-byte instruction with a REX prefix, used to indicate an
541 ;;; operand size of :qword. REX.W must be 1, the other three bits are
543 (sb!disassem:define-instruction-format (rex-byte 16
544 :default-printer '(:name))
545 (rex :field (byte 5 3) :value #b01001)
546 (op :field (byte 8 8)))
548 (sb!disassem:define-instruction-format (simple 8)
549 (op :field (byte 7 1))
550 (width :field (byte 1 0) :type 'width)
555 (sb!disassem:define-instruction-format (rex-simple 16)
556 (rex :field (byte 4 4) :value #b0100)
557 (wrxb :field (byte 4 0) :type 'wrxb)
558 (op :field (byte 7 9))
559 (width :field (byte 1 8) :type 'width)
564 ;;; Same as simple, but with direction bit
565 (sb!disassem:define-instruction-format (simple-dir 8 :include 'simple)
566 (op :field (byte 6 2))
567 (dir :field (byte 1 1)))
569 ;;; Same as simple, but with the immediate value occurring by default,
570 ;;; and with an appropiate printer.
571 (sb!disassem:define-instruction-format (accum-imm 8
573 :default-printer '(:name
574 :tab accum ", " imm))
575 (imm :type 'signed-imm-data))
577 (sb!disassem:define-instruction-format (rex-accum-imm 16
579 :default-printer '(:name
580 :tab accum ", " imm))
581 (imm :type 'signed-imm-data))
583 (sb!disassem:define-instruction-format (reg-no-width 8
584 :default-printer '(:name :tab reg))
585 (op :field (byte 5 3))
586 (reg :field (byte 3 0) :type 'reg-b)
591 (sb!disassem:define-instruction-format (rex-reg-no-width 16
592 :default-printer '(:name :tab reg))
593 (rex :field (byte 4 4) :value #b0100)
594 (wrxb :field (byte 4 0) :type 'wrxb)
595 (op :field (byte 5 11))
596 (reg :field (byte 3 8) :type 'reg-b)
601 ;;; Same as reg-no-width, but with a default operand size of :qword.
602 (sb!disassem:define-instruction-format (reg-no-width-default-qword 8
603 :include 'reg-no-width
604 :default-printer '(:name :tab reg))
605 (reg :type 'reg-b-default-qword))
607 ;;; Same as rex-reg-no-width, but with a default operand size of :qword.
608 (sb!disassem:define-instruction-format (rex-reg-no-width-default-qword 16
609 :include 'rex-reg-no-width
610 :default-printer '(:name :tab reg))
611 (reg :type 'reg-b-default-qword))
613 (sb!disassem:define-instruction-format (modrm-reg-no-width 24
614 :default-printer '(:name :tab reg))
615 (rex :field (byte 4 4) :value #b0100)
616 (wrxb :field (byte 4 0) :type 'wrxb)
617 (ff :field (byte 8 8) :value #b11111111)
618 (mod :field (byte 2 22))
619 (modrm-reg :field (byte 3 19))
620 (reg :field (byte 3 16) :type 'reg-b)
625 ;;; Adds a width field to reg-no-width. Note that we can't use
626 ;;; :INCLUDE 'REG-NO-WIDTH here to save typing because that would put
627 ;;; the WIDTH field last, but the prefilter for WIDTH must run before
628 ;;; the one for IMM to be able to determine the correct size of IMM.
629 (sb!disassem:define-instruction-format (reg 8
630 :default-printer '(:name :tab reg))
631 (op :field (byte 4 4))
632 (width :field (byte 1 3) :type 'width)
633 (reg :field (byte 3 0) :type 'reg-b)
638 (sb!disassem:define-instruction-format (rex-reg 16
639 :default-printer '(:name :tab reg))
640 (rex :field (byte 4 4) :value #b0100)
641 (wrxb :field (byte 4 0) :type 'wrxb)
642 (width :field (byte 1 11) :type 'width)
643 (op :field (byte 4 12))
644 (reg :field (byte 3 8) :type 'reg-b)
649 (sb!disassem:define-instruction-format (two-bytes 16
650 :default-printer '(:name))
651 (op :fields (list (byte 8 0) (byte 8 8))))
653 (sb!disassem:define-instruction-format (reg-reg/mem 16
655 `(:name :tab reg ", " reg/mem))
656 (op :field (byte 7 1))
657 (width :field (byte 1 0) :type 'width)
658 (reg/mem :fields (list (byte 2 14) (byte 3 8))
660 (reg :field (byte 3 11) :type 'reg)
664 (sb!disassem:define-instruction-format (rex-reg-reg/mem 24
666 `(:name :tab reg ", " reg/mem))
667 (rex :field (byte 4 4) :value #b0100)
668 (wrxb :field (byte 4 0) :type 'wrxb)
669 (width :field (byte 1 8) :type 'width)
670 (op :field (byte 7 9))
671 (reg/mem :fields (list (byte 2 22) (byte 3 16))
673 (reg :field (byte 3 19) :type 'reg)
677 ;;; same as reg-reg/mem, but with direction bit
678 (sb!disassem:define-instruction-format (reg-reg/mem-dir 16
679 :include 'reg-reg/mem
683 ,(swap-if 'dir 'reg/mem ", " 'reg)))
684 (op :field (byte 6 2))
685 (dir :field (byte 1 1)))
687 (sb!disassem:define-instruction-format (rex-reg-reg/mem-dir 24
688 :include 'rex-reg-reg/mem
692 ,(swap-if 'dir 'reg/mem ", " 'reg)))
693 (op :field (byte 6 10))
694 (dir :field (byte 1 9)))
696 ;;; Same as reg-reg/mem, but uses the reg field as a second op code.
697 (sb!disassem:define-instruction-format (reg/mem 16
698 :default-printer '(:name :tab reg/mem))
699 (op :fields (list (byte 7 1) (byte 3 11)))
700 (width :field (byte 1 0) :type 'width)
701 (reg/mem :fields (list (byte 2 14) (byte 3 8))
702 :type 'sized-reg/mem)
706 (sb!disassem:define-instruction-format (rex-reg/mem 24
707 :default-printer '(:name :tab reg/mem))
708 (rex :field (byte 4 4) :value #b0100)
709 (wrxb :field (byte 4 0) :type 'wrxb)
710 (op :fields (list (byte 7 9) (byte 3 19)))
711 (width :field (byte 1 8) :type 'width)
712 (reg/mem :fields (list (byte 2 22) (byte 3 16))
713 :type 'sized-reg/mem)
717 ;;; Same as reg/mem, but without a width field and with a default
718 ;;; operand size of :qword.
719 (sb!disassem:define-instruction-format (reg/mem-default-qword 16
720 :default-printer '(:name :tab reg/mem))
721 (op :fields (list (byte 8 0) (byte 3 11)))
722 (reg/mem :fields (list (byte 2 14) (byte 3 8))
723 :type 'sized-reg/mem-default-qword))
725 (sb!disassem:define-instruction-format (rex-reg/mem-default-qword 24
726 :default-printer '(:name :tab reg/mem))
727 (rex :field (byte 4 4) :value #b0100)
728 (wrxb :field (byte 4 0) :type 'wrxb)
729 (op :fields (list (byte 8 8) (byte 3 19)))
730 (reg/mem :fields (list (byte 2 22) (byte 3 16))
731 :type 'sized-reg/mem-default-qword))
733 ;;; Same as reg/mem, but with the immediate value occurring by default,
734 ;;; and with an appropiate printer.
735 (sb!disassem:define-instruction-format (reg/mem-imm 16
738 '(:name :tab reg/mem ", " imm))
739 (reg/mem :type 'sized-reg/mem)
740 (imm :type 'signed-imm-data))
742 (sb!disassem:define-instruction-format (rex-reg/mem-imm 24
743 :include 'rex-reg/mem
745 '(:name :tab reg/mem ", " imm))
746 (reg/mem :type 'sized-reg/mem)
747 (imm :type 'signed-imm-data))
749 ;;; Same as reg/mem, but with using the accumulator in the default printer
750 (sb!disassem:define-instruction-format
752 :include 'reg/mem :default-printer '(:name :tab accum ", " reg/mem))
753 (reg/mem :type 'reg/mem) ; don't need a size
754 (accum :type 'accum))
756 (sb!disassem:define-instruction-format (rex-accum-reg/mem 24
757 :include 'rex-reg/mem
759 '(:name :tab accum ", " reg/mem))
760 (reg/mem :type 'reg/mem) ; don't need a size
761 (accum :type 'accum))
763 ;;; Same as reg-reg/mem, but with a prefix of #b00001111
764 (sb!disassem:define-instruction-format (ext-reg-reg/mem 24
766 `(:name :tab reg ", " reg/mem))
767 (prefix :field (byte 8 0) :value #b00001111)
768 (op :field (byte 7 9))
769 (width :field (byte 1 8) :type 'width)
770 (reg/mem :fields (list (byte 2 22) (byte 3 16))
772 (reg :field (byte 3 19) :type 'reg)
776 (sb!disassem:define-instruction-format (ext-reg-reg/mem-no-width 24
778 `(:name :tab reg ", " reg/mem))
779 (prefix :field (byte 8 0) :value #b00001111)
780 (op :field (byte 8 8))
781 (reg/mem :fields (list (byte 2 22) (byte 3 16))
783 (reg :field (byte 3 19) :type 'reg))
785 (sb!disassem:define-instruction-format (rex-ext-reg-reg/mem-no-width 32
787 `(:name :tab reg ", " reg/mem))
788 (rex :field (byte 4 4) :value #b0100)
789 (wrxb :field (byte 4 0) :type 'wrxb)
790 (prefix :field (byte 8 8) :value #b00001111)
791 (op :field (byte 8 16))
792 (reg/mem :fields (list (byte 2 30) (byte 3 24))
794 (reg :field (byte 3 27) :type 'reg))
796 ;;; reg-no-width with #x0f prefix
797 (sb!disassem:define-instruction-format (ext-reg-no-width 16
798 :default-printer '(:name :tab reg))
799 (prefix :field (byte 8 0) :value #b00001111)
800 (op :field (byte 5 11))
801 (reg :field (byte 3 8) :type 'reg-b))
803 ;;; Same as reg/mem, but with a prefix of #b00001111
804 (sb!disassem:define-instruction-format (ext-reg/mem 24
805 :default-printer '(:name :tab reg/mem))
806 (prefix :field (byte 8 0) :value #b00001111)
807 (op :fields (list (byte 7 9) (byte 3 19)))
808 (width :field (byte 1 8) :type 'width)
809 (reg/mem :fields (list (byte 2 22) (byte 3 16))
810 :type 'sized-reg/mem)
814 (sb!disassem:define-instruction-format (ext-reg/mem-imm 24
815 :include 'ext-reg/mem
817 '(:name :tab reg/mem ", " imm))
818 (imm :type 'signed-imm-data))
820 ;;;; XMM instructions
822 ;;; All XMM instructions use an extended opcode (#x0F as the first
823 ;;; opcode byte). Therefore in the following "EXT" in the name of the
824 ;;; instruction formats refers to the formats that have an additional
825 ;;; prefix (#x66, #xF2 or #xF3).
827 ;;; Instructions having an XMM register as the destination operand
828 ;;; and an XMM register or a memory location as the source operand.
829 ;;; The size of the operands is implicitly given by the instruction.
830 (sb!disassem:define-instruction-format (xmm-xmm/mem 24
832 '(:name :tab reg ", " reg/mem))
833 (x0f :field (byte 8 0) :value #x0f)
834 (op :field (byte 8 8))
835 (reg/mem :fields (list (byte 2 22) (byte 3 16))
837 (reg :field (byte 3 19) :type 'xmmreg))
839 (sb!disassem:define-instruction-format (rex-xmm-xmm/mem 32
841 '(:name :tab reg ", " reg/mem))
842 (x0f :field (byte 8 0) :value #x0f)
843 (rex :field (byte 4 12) :value #b0100)
844 (wrxb :field (byte 4 8) :type 'wrxb)
845 (op :field (byte 8 16))
846 (reg/mem :fields (list (byte 2 30) (byte 3 24))
848 (reg :field (byte 3 27) :type 'xmmreg))
850 (sb!disassem:define-instruction-format (ext-xmm-xmm/mem 32
852 '(:name :tab reg ", " reg/mem))
853 (prefix :field (byte 8 0))
854 (x0f :field (byte 8 8) :value #x0f)
855 (op :field (byte 8 16))
856 (reg/mem :fields (list (byte 2 30) (byte 3 24))
858 (reg :field (byte 3 27) :type 'xmmreg))
860 (sb!disassem:define-instruction-format (ext-rex-xmm-xmm/mem 40
862 '(:name :tab reg ", " reg/mem))
863 (prefix :field (byte 8 0))
864 (rex :field (byte 4 12) :value #b0100)
865 (wrxb :field (byte 4 8) :type 'wrxb)
866 (x0f :field (byte 8 16) :value #x0f)
867 (op :field (byte 8 24))
868 (reg/mem :fields (list (byte 2 38) (byte 3 32))
870 (reg :field (byte 3 35) :type 'xmmreg))
872 ;;; Same as xmm-xmm/mem etc., but with direction bit.
874 (sb!disassem:define-instruction-format (ext-xmm-xmm/mem-dir 32
875 :include 'ext-xmm-xmm/mem
879 ,(swap-if 'dir 'reg ", " 'reg/mem)))
880 (op :field (byte 7 17))
881 (dir :field (byte 1 16)))
883 (sb!disassem:define-instruction-format (ext-rex-xmm-xmm/mem-dir 40
884 :include 'ext-rex-xmm-xmm/mem
888 ,(swap-if 'dir 'reg ", " 'reg/mem)))
889 (op :field (byte 7 25))
890 (dir :field (byte 1 24)))
892 ;;; Instructions having an XMM register as one operand and a general-
893 ;;; -purpose register or a memory location as the other operand.
895 (sb!disassem:define-instruction-format (ext-xmm-reg/mem 32
897 '(:name :tab reg ", " reg/mem))
898 (prefix :field (byte 8 0))
899 (x0f :field (byte 8 8) :value #x0f)
900 (op :field (byte 8 16))
901 (reg/mem :fields (list (byte 2 30) (byte 3 24))
902 :type 'sized-reg/mem)
903 (reg :field (byte 3 27) :type 'xmmreg))
905 (sb!disassem:define-instruction-format (ext-rex-xmm-reg/mem 40
907 '(:name :tab reg ", " reg/mem))
908 (prefix :field (byte 8 0))
909 (rex :field (byte 4 12) :value #b0100)
910 (wrxb :field (byte 4 8) :type 'wrxb)
911 (x0f :field (byte 8 16) :value #x0f)
912 (op :field (byte 8 24))
913 (reg/mem :fields (list (byte 2 38) (byte 3 32))
914 :type 'sized-reg/mem)
915 (reg :field (byte 3 35) :type 'xmmreg))
917 ;;; Instructions having a general-purpose register as one operand and an
918 ;;; XMM register or a memory location as the other operand.
920 (sb!disassem:define-instruction-format (ext-reg-xmm/mem 32
922 '(:name :tab reg ", " reg/mem))
923 (prefix :field (byte 8 0))
924 (x0f :field (byte 8 8) :value #x0f)
925 (op :field (byte 8 16))
926 (reg/mem :fields (list (byte 2 30) (byte 3 24))
927 :type 'sized-xmmreg/mem)
928 (reg :field (byte 3 27) :type 'reg))
930 (sb!disassem:define-instruction-format (ext-rex-reg-xmm/mem 40
932 '(:name :tab reg ", " reg/mem))
933 (prefix :field (byte 8 0))
934 (rex :field (byte 4 12) :value #b0100)
935 (wrxb :field (byte 4 8) :type 'wrxb)
936 (x0f :field (byte 8 16) :value #x0f)
937 (op :field (byte 8 24))
938 (reg/mem :fields (list (byte 2 38) (byte 3 32))
939 :type 'sized-xmmreg/mem)
940 (reg :field (byte 3 35) :type 'reg))
942 (sb!disassem:define-instruction-format (string-op 8
944 :default-printer '(:name width)))
946 (sb!disassem:define-instruction-format (rex-string-op 16
948 :default-printer '(:name width)))
950 (sb!disassem:define-instruction-format (short-cond-jump 16)
951 (op :field (byte 4 4))
952 (cc :field (byte 4 0) :type 'condition-code)
953 (label :field (byte 8 8) :type 'displacement))
955 (sb!disassem:define-instruction-format (short-jump 16
956 :default-printer '(:name :tab label))
957 (const :field (byte 4 4) :value #b1110)
958 (op :field (byte 4 0))
959 (label :field (byte 8 8) :type 'displacement))
961 (sb!disassem:define-instruction-format (near-cond-jump 16)
962 (op :fields (list (byte 8 0) (byte 4 12)) :value '(#b00001111 #b1000))
963 (cc :field (byte 4 8) :type 'condition-code)
964 ;; The disassembler currently doesn't let you have an instruction > 32 bits
965 ;; long, so we fake it by using a prefilter to read the offset.
966 (label :type 'displacement
967 :prefilter (lambda (value dstate)
968 (declare (ignore value)) ; always nil anyway
969 (sb!disassem:read-signed-suffix 32 dstate))))
971 (sb!disassem:define-instruction-format (near-jump 8
972 :default-printer '(:name :tab label))
973 (op :field (byte 8 0))
974 ;; The disassembler currently doesn't let you have an instruction > 32 bits
975 ;; long, so we fake it by using a prefilter to read the address.
976 (label :type 'displacement
977 :prefilter (lambda (value dstate)
978 (declare (ignore value)) ; always nil anyway
979 (sb!disassem:read-signed-suffix 32 dstate))))
982 (sb!disassem:define-instruction-format (cond-set 24
983 :default-printer '('set cc :tab reg/mem))
984 (prefix :field (byte 8 0) :value #b00001111)
985 (op :field (byte 4 12) :value #b1001)
986 (cc :field (byte 4 8) :type 'condition-code)
987 (reg/mem :fields (list (byte 2 22) (byte 3 16))
988 :type 'sized-byte-reg/mem)
989 (reg :field (byte 3 19) :value #b000))
991 (sb!disassem:define-instruction-format (cond-move 24
993 '('cmov cc :tab reg ", " reg/mem))
994 (prefix :field (byte 8 0) :value #b00001111)
995 (op :field (byte 4 12) :value #b0100)
996 (cc :field (byte 4 8) :type 'condition-code)
997 (reg/mem :fields (list (byte 2 22) (byte 3 16))
999 (reg :field (byte 3 19) :type 'reg))
1001 (sb!disassem:define-instruction-format (rex-cond-move 32
1003 '('cmov cc :tab reg ", " reg/mem))
1004 (rex :field (byte 4 4) :value #b0100)
1005 (wrxb :field (byte 4 0) :type 'wrxb)
1006 (prefix :field (byte 8 8) :value #b00001111)
1007 (op :field (byte 4 20) :value #b0100)
1008 (cc :field (byte 4 16) :type 'condition-code)
1009 (reg/mem :fields (list (byte 2 30) (byte 3 24))
1011 (reg :field (byte 3 27) :type 'reg))
1013 (sb!disassem:define-instruction-format (enter-format 32
1014 :default-printer '(:name
1016 (:unless (:constant 0)
1018 (op :field (byte 8 0))
1019 (disp :field (byte 16 8))
1020 (level :field (byte 8 24)))
1022 ;;; Single byte instruction with an immediate byte argument.
1023 (sb!disassem:define-instruction-format (byte-imm 16
1024 :default-printer '(:name :tab code))
1025 (op :field (byte 8 0))
1026 (code :field (byte 8 8)))
1028 ;;;; primitive emitters
1030 (define-bitfield-emitter emit-word 16
1033 (define-bitfield-emitter emit-dword 32
1036 ;;; Most uses of dwords are as displacements or as immediate values in
1037 ;;; 64-bit operations. In these cases they are sign-extended to 64 bits.
1038 ;;; EMIT-DWORD is unsuitable there because it accepts values of type
1039 ;;; (OR (SIGNED-BYTE 32) (UNSIGNED-BYTE 32)), so we provide a more
1040 ;;; restricted emitter here.
1041 (defun emit-signed-dword (segment value)
1042 (declare (type segment segment)
1043 (type (signed-byte 32) value))
1044 (declare (inline emit-dword))
1045 (emit-dword segment value))
1047 (define-bitfield-emitter emit-qword 64
1050 (define-bitfield-emitter emit-byte-with-reg 8
1051 (byte 5 3) (byte 3 0))
1053 (define-bitfield-emitter emit-mod-reg-r/m-byte 8
1054 (byte 2 6) (byte 3 3) (byte 3 0))
1056 (define-bitfield-emitter emit-sib-byte 8
1057 (byte 2 6) (byte 3 3) (byte 3 0))
1059 (define-bitfield-emitter emit-rex-byte 8
1060 (byte 4 4) (byte 1 3) (byte 1 2) (byte 1 1) (byte 1 0))
1066 (defun emit-absolute-fixup (segment fixup &optional quad-p)
1067 (note-fixup segment (if quad-p :absolute64 :absolute) fixup)
1068 (let ((offset (fixup-offset fixup)))
1069 (if (label-p offset)
1070 (emit-back-patch segment
1072 (lambda (segment posn)
1073 (declare (ignore posn))
1074 (let ((val (- (+ (component-header-length)
1075 (or (label-position offset)
1077 other-pointer-lowtag)))
1079 (emit-qword segment val)
1080 (emit-signed-dword segment val)))))
1082 (emit-qword segment (or offset 0))
1083 (emit-signed-dword segment (or offset 0))))))
1085 (defun emit-relative-fixup (segment fixup)
1086 (note-fixup segment :relative fixup)
1087 (emit-signed-dword segment (or (fixup-offset fixup) 0)))
1090 ;;;; the effective-address (ea) structure
1092 (defun reg-tn-encoding (tn)
1093 (declare (type tn tn))
1094 ;; ea only has space for three bits of register number: regs r8
1095 ;; and up are selected by a REX prefix byte which caller is responsible
1096 ;; for having emitted where necessary already
1097 (ecase (sb-name (sc-sb (tn-sc tn)))
1099 (let ((offset (mod (tn-offset tn) 16)))
1100 (logior (ash (logand offset 1) 2)
1103 (mod (tn-offset tn) 8))))
1105 (defstruct (ea (:constructor make-ea (size &key base index scale disp))
1107 ;; note that we can represent an EA with a QWORD size, but EMIT-EA
1108 ;; can't actually emit it on its own: caller also needs to emit REX
1110 (size nil :type (member :byte :word :dword :qword))
1111 (base nil :type (or tn null))
1112 (index nil :type (or tn null))
1113 (scale 1 :type (member 1 2 4 8))
1114 (disp 0 :type (or (unsigned-byte 32) (signed-byte 32) fixup)))
1115 (def!method print-object ((ea ea) stream)
1116 (cond ((or *print-escape* *print-readably*)
1117 (print-unreadable-object (ea stream :type t)
1119 "~S~@[ base=~S~]~@[ index=~S~]~@[ scale=~S~]~@[ disp=~S~]"
1123 (let ((scale (ea-scale ea)))
1124 (if (= scale 1) nil scale))
1127 (format stream "~A PTR [" (symbol-name (ea-size ea)))
1129 (write-string (sb!c::location-print-name (ea-base ea)) stream)
1131 (write-string "+" stream)))
1133 (write-string (sb!c::location-print-name (ea-index ea)) stream))
1134 (unless (= (ea-scale ea) 1)
1135 (format stream "*~A" (ea-scale ea)))
1136 (typecase (ea-disp ea)
1139 (format stream "~@D" (ea-disp ea)))
1141 (format stream "+~A" (ea-disp ea))))
1142 (write-char #\] stream))))
1144 (defun emit-constant-tn-rip (segment constant-tn reg)
1145 ;; AMD64 doesn't currently have a code object register to use as a
1146 ;; base register for constant access. Instead we use RIP-relative
1147 ;; addressing. The offset from the SIMPLE-FUN-HEADER to the instruction
1148 ;; is passed to the backpatch callback. In addition we need the offset
1149 ;; from the start of the function header to the slot in the CODE-HEADER
1150 ;; that stores the constant. Since we don't know where the code header
1151 ;; starts, instead count backwards from the function header.
1152 (let* ((2comp (component-info *component-being-compiled*))
1153 (constants (ir2-component-constants 2comp))
1154 (len (length constants))
1155 ;; Both CODE-HEADER and SIMPLE-FUN-HEADER are 16-byte aligned.
1156 ;; If there are an even amount of constants, there will be
1157 ;; an extra qword of padding before the function header, which
1158 ;; needs to be adjusted for. XXX: This will break if new slots
1159 ;; are added to the code header.
1160 (offset (* (- (+ len (if (evenp len)
1163 (tn-offset constant-tn))
1165 ;; RIP-relative addressing
1166 (emit-mod-reg-r/m-byte segment #b00 reg #b101)
1167 (emit-back-patch segment
1169 (lambda (segment posn)
1170 ;; The addressing is relative to end of instruction,
1171 ;; i.e. the end of this dword. Hence the + 4.
1172 (emit-signed-dword segment
1173 (+ 4 (- (+ offset posn)))))))
1176 (defun emit-label-rip (segment fixup reg)
1177 (let ((label (fixup-offset fixup)))
1178 ;; RIP-relative addressing
1179 (emit-mod-reg-r/m-byte segment #b00 reg #b101)
1180 (emit-back-patch segment
1182 (lambda (segment posn)
1183 (emit-signed-dword segment (- (label-position label)
1187 (defun emit-ea (segment thing reg &optional allow-constants)
1190 ;; this would be eleganter if we had a function that would create
1192 (ecase (sb-name (sc-sb (tn-sc thing)))
1193 ((registers float-registers)
1194 (emit-mod-reg-r/m-byte segment #b11 reg (reg-tn-encoding thing)))
1196 ;; Convert stack tns into an index off RBP.
1197 (let ((disp (- (* (1+ (tn-offset thing)) n-word-bytes))))
1198 (cond ((< -128 disp 127)
1199 (emit-mod-reg-r/m-byte segment #b01 reg #b101)
1200 (emit-byte segment disp))
1202 (emit-mod-reg-r/m-byte segment #b10 reg #b101)
1203 (emit-signed-dword segment disp)))))
1205 (unless allow-constants
1208 "Constant TNs can only be directly used in MOV, PUSH, and CMP."))
1209 (emit-constant-tn-rip segment thing reg))))
1211 (let* ((base (ea-base thing))
1212 (index (ea-index thing))
1213 (scale (ea-scale thing))
1214 (disp (ea-disp thing))
1215 (mod (cond ((or (null base)
1217 (not (= (reg-tn-encoding base) #b101))))
1219 ((and (fixnump disp) (<= -128 disp 127))
1223 (r/m (cond (index #b100)
1225 (t (reg-tn-encoding base)))))
1226 (when (and (= mod 0) (= r/m #b101))
1227 ;; this is rip-relative in amd64, so we'll use a sib instead
1228 (setf r/m #b100 scale 1))
1229 (emit-mod-reg-r/m-byte segment mod reg r/m)
1231 (let ((ss (1- (integer-length scale)))
1232 (index (if (null index)
1234 (let ((index (reg-tn-encoding index)))
1236 (error "can't index off of ESP")
1238 (base (if (null base)
1240 (reg-tn-encoding base))))
1241 (emit-sib-byte segment ss index base)))
1243 (emit-byte segment disp))
1244 ((or (= mod #b10) (null base))
1246 (emit-absolute-fixup segment disp)
1247 (emit-signed-dword segment disp))))))
1249 (typecase (fixup-offset thing)
1251 (emit-label-rip segment thing reg))
1253 (emit-mod-reg-r/m-byte segment #b00 reg #b100)
1254 (emit-sib-byte segment 0 #b100 #b101)
1255 (emit-absolute-fixup segment thing))))))
1257 (defun byte-reg-p (thing)
1259 (eq (sb-name (sc-sb (tn-sc thing))) 'registers)
1260 (member (sc-name (tn-sc thing)) *byte-sc-names*)
1263 (defun byte-ea-p (thing)
1265 (ea (eq (ea-size thing) :byte))
1267 (and (member (sc-name (tn-sc thing)) *byte-sc-names*) t))
1270 (defun word-reg-p (thing)
1272 (eq (sb-name (sc-sb (tn-sc thing))) 'registers)
1273 (member (sc-name (tn-sc thing)) *word-sc-names*)
1276 (defun word-ea-p (thing)
1278 (ea (eq (ea-size thing) :word))
1279 (tn (and (member (sc-name (tn-sc thing)) *word-sc-names*) t))
1282 (defun dword-reg-p (thing)
1284 (eq (sb-name (sc-sb (tn-sc thing))) 'registers)
1285 (member (sc-name (tn-sc thing)) *dword-sc-names*)
1288 (defun dword-ea-p (thing)
1290 (ea (eq (ea-size thing) :dword))
1292 (and (member (sc-name (tn-sc thing)) *dword-sc-names*) t))
1295 (defun qword-reg-p (thing)
1297 (eq (sb-name (sc-sb (tn-sc thing))) 'registers)
1298 (member (sc-name (tn-sc thing)) *qword-sc-names*)
1301 (defun qword-ea-p (thing)
1303 (ea (eq (ea-size thing) :qword))
1305 (and (member (sc-name (tn-sc thing)) *qword-sc-names*) t))
1308 ;;; Return true if THING is a general-purpose register TN.
1309 (defun register-p (thing)
1311 (eq (sb-name (sc-sb (tn-sc thing))) 'registers)))
1313 (defun accumulator-p (thing)
1314 (and (register-p thing)
1315 (= (tn-offset thing) 0)))
1317 ;;; Return true if THING is an XMM register TN.
1318 (defun xmm-register-p (thing)
1320 (eq (sb-name (sc-sb (tn-sc thing))) 'float-registers)))
1325 (def!constant +operand-size-prefix-byte+ #b01100110)
1327 (defun maybe-emit-operand-size-prefix (segment size)
1328 (unless (or (eq size :byte)
1329 (eq size :qword) ; REX prefix handles this
1330 (eq size +default-operand-size+))
1331 (emit-byte segment +operand-size-prefix-byte+)))
1333 ;;; A REX prefix must be emitted if at least one of the following
1334 ;;; conditions is true:
1335 ;; 1. The operand size is :QWORD and the default operand size of the
1336 ;; instruction is not :QWORD.
1337 ;;; 2. The instruction references an extended register.
1338 ;;; 3. The instruction references one of the byte registers SIL, DIL,
1341 ;;; Emit a REX prefix if necessary. OPERAND-SIZE is used to determine
1342 ;;; whether to set REX.W. Callers pass it explicitly as :DO-NOT-SET if
1343 ;;; this should not happen, for example because the instruction's
1344 ;;; default operand size is qword. R, X and B are NIL or TNs specifying
1345 ;;; registers the encodings of which are extended with the REX.R, REX.X
1346 ;;; and REX.B bit, respectively. To determine whether one of the byte
1347 ;;; registers is used that can only be accessed using a REX prefix, we
1348 ;;; need only to test R and B, because X is only used for the index
1349 ;;; register of an effective address and therefore never byte-sized.
1350 ;;; For R we can avoid to calculate the size of the TN because it is
1351 ;;; always OPERAND-SIZE. The size of B must be calculated here because
1352 ;;; B can be address-sized (if it is the base register of an effective
1353 ;;; address), of OPERAND-SIZE (if the instruction operates on two
1354 ;;; registers) or of some different size (in the instructions that
1355 ;;; combine arguments of different sizes: MOVZX, MOVSX, MOVSXD and
1356 ;;; several SSE instructions, e.g. CVTSD2SI). We don't distinguish
1357 ;;; between general-purpose and floating point registers for this cause
1358 ;;; because only general-purpose registers can be byte-sized at all.
1359 (defun maybe-emit-rex-prefix (segment operand-size r x b)
1360 (declare (type (member nil :byte :word :dword :qword :do-not-set)
1362 (type (or null tn) r x b))
1364 (if (and r (> (tn-offset r)
1365 ;; offset of r8 is 16, offset of xmm8 is 8
1366 (if (eq (sb-name (sc-sb (tn-sc r)))
1373 ;; Assuming R is a TN describing a general-purpose
1374 ;; register, return true if it references register
1376 (<= 8 (tn-offset r) 15)))
1377 (let ((rex-w (if (eq operand-size :qword) 1 0))
1381 (when (or (not (zerop (logior rex-w rex-r rex-x rex-b)))
1383 (eq operand-size :byte)
1386 (eq (operand-size b) :byte)
1388 (emit-rex-byte segment #b0100 rex-w rex-r rex-x rex-b)))))
1390 ;;; Emit a REX prefix if necessary. The operand size is determined from
1391 ;;; THING or can be overwritten by OPERAND-SIZE. This and REG are always
1392 ;;; passed to MAYBE-EMIT-REX-PREFIX. Additionally, if THING is an EA we
1393 ;;; pass its index and base registers, if it is a register TN, we pass
1395 ;;; In contrast to EMIT-EA above, neither stack TNs nor fixups need to
1396 ;;; be treated specially here: If THING is a stack TN, neither it nor
1397 ;;; any of its components are passed to MAYBE-EMIT-REX-PREFIX which
1398 ;;; works correctly because stack references always use RBP as the base
1399 ;;; register and never use an index register so no extended registers
1400 ;;; need to be accessed. Fixups are assembled using an addressing mode
1401 ;;; of displacement-only or RIP-plus-displacement (see EMIT-EA), so may
1402 ;;; not reference an extended register. The displacement-only addressing
1403 ;;; mode requires that REX.X is 0, which is ensured here.
1404 (defun maybe-emit-rex-for-ea (segment thing reg &key operand-size)
1405 (declare (type (or ea tn fixup) thing)
1406 (type (or null tn) reg)
1407 (type (member nil :byte :word :dword :qword :do-not-set)
1409 (let ((ea-p (ea-p thing)))
1410 (maybe-emit-rex-prefix segment
1411 (or operand-size (operand-size thing))
1413 (and ea-p (ea-index thing))
1414 (cond (ea-p (ea-base thing))
1416 (member (sb-name (sc-sb (tn-sc thing)))
1417 '(float-registers registers)))
1421 (defun operand-size (thing)
1424 ;; FIXME: might as well be COND instead of having to use #. readmacro
1425 ;; to hack up the code
1426 (case (sc-name (tn-sc thing))
1435 ;; added by jrd: float-registers is a separate size (?)
1436 ;; The only place in the code where we are called with THING
1437 ;; being a float-register is in MAYBE-EMIT-REX-PREFIX when it
1438 ;; checks whether THING is a byte register. Thus our result in
1439 ;; these cases could as well be :dword and :qword. I leave it as
1440 ;; :float and :double which is more likely to trigger an aver
1441 ;; instead of silently doing the wrong thing in case this
1442 ;; situation should change. Lutz Euler, 2005-10-23.
1445 (#.*double-sc-names*
1448 (error "can't tell the size of ~S ~S" thing (sc-name (tn-sc thing))))))
1452 ;; GNA. Guess who spelt "flavor" correctly first time round?
1453 ;; There's a strong argument in my mind to change all uses of
1454 ;; "flavor" to "kind": and similarly with some misguided uses of
1455 ;; "type" here and there. -- CSR, 2005-01-06.
1456 (case (fixup-flavor thing)
1457 ((:foreign-dataref) :qword)))
1461 (defun matching-operand-size (dst src)
1462 (let ((dst-size (operand-size dst))
1463 (src-size (operand-size src)))
1466 (if (eq dst-size src-size)
1468 (error "size mismatch: ~S is a ~S and ~S is a ~S."
1469 dst dst-size src src-size))
1473 (error "can't tell the size of either ~S or ~S" dst src)))))
1475 ;;; Except in a very few cases (MOV instructions A1, A3 and B8 - BF)
1476 ;;; we expect dword data bytes even when 64 bit work is being done.
1477 ;;; But A1 and A3 are currently unused and B8 - BF use EMIT-QWORD
1478 ;;; directly, so we emit all quad constants as dwords, additionally
1479 ;;; making sure that they survive the sign-extension to 64 bits
1481 (defun emit-sized-immediate (segment size value)
1484 (emit-byte segment value))
1486 (emit-word segment value))
1488 (emit-dword segment value))
1490 (emit-signed-dword segment value))))
1492 ;;;; general data transfer
1494 ;;; This is the part of the MOV instruction emitter that does moving
1495 ;;; of an immediate value into a qword register. We go to some length
1496 ;;; to achieve the shortest possible encoding.
1497 (defun emit-immediate-move-to-qword-register (segment dst src)
1498 (declare (type integer src))
1499 (cond ((typep src '(unsigned-byte 32))
1500 ;; We use the B8 - BF encoding with an operand size of 32 bits
1501 ;; here and let the implicit zero-extension fill the upper half
1502 ;; of the 64-bit destination register. Instruction size: five
1503 ;; or six bytes. (A REX prefix will be emitted only if the
1504 ;; destination is an extended register.)
1505 (maybe-emit-rex-prefix segment :dword nil nil dst)
1506 (emit-byte-with-reg segment #b10111 (reg-tn-encoding dst))
1507 (emit-dword segment src))
1509 (maybe-emit-rex-prefix segment :qword nil nil dst)
1510 (cond ((typep src '(signed-byte 32))
1511 ;; Use the C7 encoding that takes a 32-bit immediate and
1512 ;; sign-extends it to 64 bits. Instruction size: seven
1514 (emit-byte segment #b11000111)
1515 (emit-mod-reg-r/m-byte segment #b11 #b000
1516 (reg-tn-encoding dst))
1517 (emit-signed-dword segment src))
1518 ((<= (- (expt 2 64) (expt 2 31))
1521 ;; This triggers on positive integers of 64 bits length
1522 ;; with the most significant 33 bits being 1. We use the
1523 ;; same encoding as in the previous clause.
1524 (emit-byte segment #b11000111)
1525 (emit-mod-reg-r/m-byte segment #b11 #b000
1526 (reg-tn-encoding dst))
1527 (emit-signed-dword segment (- src (expt 2 64))))
1529 ;; We need a full 64-bit immediate. Instruction size:
1531 (emit-byte-with-reg segment #b10111 (reg-tn-encoding dst))
1532 (emit-qword segment src))))))
1534 (define-instruction mov (segment dst src)
1535 ;; immediate to register
1536 (:printer reg ((op #b1011) (imm nil :type 'signed-imm-data))
1537 '(:name :tab reg ", " imm))
1538 (:printer rex-reg ((op #b1011) (imm nil :type 'signed-imm-data-upto-qword))
1539 '(:name :tab reg ", " imm))
1540 ;; absolute mem to/from accumulator
1541 (:printer simple-dir ((op #b101000) (imm nil :type 'imm-addr))
1542 `(:name :tab ,(swap-if 'dir 'accum ", " '("[" imm "]"))))
1543 ;; register to/from register/memory
1544 (:printer reg-reg/mem-dir ((op #b100010)))
1545 (:printer rex-reg-reg/mem-dir ((op #b100010)))
1546 ;; immediate to register/memory
1547 (:printer reg/mem-imm ((op '(#b1100011 #b000))))
1548 (:printer rex-reg/mem-imm ((op '(#b1100011 #b000))))
1551 (let ((size (matching-operand-size dst src)))
1552 (maybe-emit-operand-size-prefix segment size)
1553 (cond ((register-p dst)
1554 (cond ((integerp src)
1555 (cond ((eq size :qword)
1556 (emit-immediate-move-to-qword-register segment
1559 (maybe-emit-rex-prefix segment size nil nil dst)
1560 (emit-byte-with-reg segment
1564 (reg-tn-encoding dst))
1565 (emit-sized-immediate segment size src))))
1567 (maybe-emit-rex-for-ea segment src dst)
1572 (emit-ea segment src (reg-tn-encoding dst) t))))
1574 ;; C7 only deals with 32 bit immediates even if the
1575 ;; destination is a 64-bit location. The value is
1576 ;; sign-extended in this case.
1577 (maybe-emit-rex-for-ea segment dst nil)
1578 (emit-byte segment (if (eq size :byte) #b11000110 #b11000111))
1579 (emit-ea segment dst #b000)
1580 (emit-sized-immediate segment size src))
1582 (maybe-emit-rex-for-ea segment dst src)
1583 (emit-byte segment (if (eq size :byte) #b10001000 #b10001001))
1584 (emit-ea segment dst (reg-tn-encoding src)))
1586 ;; Generally we can't MOV a fixupped value into an EA, since
1587 ;; MOV on non-registers can only take a 32-bit immediate arg.
1588 ;; Make an exception for :FOREIGN fixups (pretty much just
1589 ;; the runtime asm, since other foreign calls go through the
1590 ;; the linkage table) and for linkage table references, since
1591 ;; these should always end up in low memory.
1592 (aver (or (eq (fixup-flavor src) :foreign)
1593 (eq (fixup-flavor src) :foreign-dataref)
1594 (eq (ea-size dst) :dword)))
1595 (maybe-emit-rex-for-ea segment dst nil)
1596 (emit-byte segment #b11000111)
1597 (emit-ea segment dst #b000)
1598 (emit-absolute-fixup segment src))
1600 (error "bogus arguments to MOV: ~S ~S" dst src))))))
1602 (defun emit-move-with-extension (segment dst src signed-p)
1603 (aver (register-p dst))
1604 (let ((dst-size (operand-size dst))
1605 (src-size (operand-size src))
1606 (opcode (if signed-p #b10111110 #b10110110)))
1609 (aver (eq src-size :byte))
1610 (maybe-emit-operand-size-prefix segment :word)
1611 ;; REX prefix is needed if SRC is SIL, DIL, SPL or BPL.
1612 (maybe-emit-rex-for-ea segment src dst :operand-size :word)
1613 (emit-byte segment #b00001111)
1614 (emit-byte segment opcode)
1615 (emit-ea segment src (reg-tn-encoding dst)))
1619 (maybe-emit-rex-for-ea segment src dst :operand-size dst-size)
1620 (emit-byte segment #b00001111)
1621 (emit-byte segment opcode)
1622 (emit-ea segment src (reg-tn-encoding dst)))
1624 (maybe-emit-rex-for-ea segment src dst :operand-size dst-size)
1625 (emit-byte segment #b00001111)
1626 (emit-byte segment (logior opcode 1))
1627 (emit-ea segment src (reg-tn-encoding dst)))
1629 (aver (eq dst-size :qword))
1630 ;; dst is in reg, src is in modrm
1631 (let ((ea-p (ea-p src)))
1632 (maybe-emit-rex-prefix segment (if signed-p :qword :dword) dst
1633 (and ea-p (ea-index src))
1634 (cond (ea-p (ea-base src))
1637 (emit-byte segment #x63) ;movsxd
1638 ;;(emit-byte segment opcode)
1639 (emit-ea segment src (reg-tn-encoding dst)))))))))
1641 (define-instruction movsx (segment dst src)
1642 (:printer ext-reg-reg/mem-no-width
1643 ((op #b10111110) (reg/mem nil :type 'sized-byte-reg/mem)))
1644 (:printer rex-ext-reg-reg/mem-no-width
1645 ((op #b10111110) (reg/mem nil :type 'sized-byte-reg/mem)))
1646 (:printer ext-reg-reg/mem-no-width
1647 ((op #b10111111) (reg/mem nil :type 'sized-word-reg/mem)))
1648 (:printer rex-ext-reg-reg/mem-no-width
1649 ((op #b10111111) (reg/mem nil :type 'sized-word-reg/mem)))
1650 (:emitter (emit-move-with-extension segment dst src :signed)))
1652 (define-instruction movzx (segment dst src)
1653 (:printer ext-reg-reg/mem-no-width
1654 ((op #b10110110) (reg/mem nil :type 'sized-byte-reg/mem)))
1655 (:printer rex-ext-reg-reg/mem-no-width
1656 ((op #b10110110) (reg/mem nil :type 'sized-byte-reg/mem)))
1657 (:printer ext-reg-reg/mem-no-width
1658 ((op #b10110111) (reg/mem nil :type 'sized-word-reg/mem)))
1659 (:printer rex-ext-reg-reg/mem-no-width
1660 ((op #b10110111) (reg/mem nil :type 'sized-word-reg/mem)))
1661 (:emitter (emit-move-with-extension segment dst src nil)))
1663 ;;; The regular use of MOVSXD is with an operand size of :qword. This
1664 ;;; sign-extends the dword source into the qword destination register.
1665 ;;; If the operand size is :dword the instruction zero-extends the dword
1666 ;;; source into the qword destination register, i.e. it does the same as
1667 ;;; a dword MOV into a register.
1668 (define-instruction movsxd (segment dst src)
1669 (:printer reg-reg/mem ((op #b0110001) (width 1)
1670 (reg/mem nil :type 'sized-dword-reg/mem)))
1671 (:printer rex-reg-reg/mem ((op #b0110001) (width 1)
1672 (reg/mem nil :type 'sized-dword-reg/mem)))
1673 (:emitter (emit-move-with-extension segment dst src :signed)))
1675 ;;; this is not a real amd64 instruction, of course
1676 (define-instruction movzxd (segment dst src)
1677 ; (:printer reg-reg/mem ((op #x63) (reg nil :type 'reg)))
1678 (:emitter (emit-move-with-extension segment dst src nil)))
1680 (define-instruction push (segment src)
1682 (:printer reg-no-width-default-qword ((op #b01010)))
1683 (:printer rex-reg-no-width-default-qword ((op #b01010)))
1685 (:printer reg/mem-default-qword ((op '(#b11111111 #b110))))
1686 (:printer rex-reg/mem-default-qword ((op '(#b11111111 #b110))))
1688 (:printer byte ((op #b01101010) (imm nil :type 'signed-imm-byte))
1690 (:printer byte ((op #b01101000)
1691 (imm nil :type 'signed-imm-data-default-qword))
1693 ;; ### segment registers?
1696 (cond ((integerp src)
1697 (cond ((<= -128 src 127)
1698 (emit-byte segment #b01101010)
1699 (emit-byte segment src))
1701 ;; A REX-prefix is not needed because the operand size
1702 ;; defaults to 64 bits. The size of the immediate is 32
1703 ;; bits and it is sign-extended.
1704 (emit-byte segment #b01101000)
1705 (emit-signed-dword segment src))))
1707 (let ((size (operand-size src)))
1708 (aver (or (eq size :qword) (eq size :word)))
1709 (maybe-emit-operand-size-prefix segment size)
1710 (maybe-emit-rex-for-ea segment src nil :operand-size :do-not-set)
1711 (cond ((register-p src)
1712 (emit-byte-with-reg segment #b01010 (reg-tn-encoding src)))
1714 (emit-byte segment #b11111111)
1715 (emit-ea segment src #b110 t))))))))
1717 (define-instruction pop (segment dst)
1718 (:printer reg-no-width-default-qword ((op #b01011)))
1719 (:printer rex-reg-no-width-default-qword ((op #b01011)))
1720 (:printer reg/mem-default-qword ((op '(#b10001111 #b000))))
1721 (:printer rex-reg/mem-default-qword ((op '(#b10001111 #b000))))
1723 (let ((size (operand-size dst)))
1724 (aver (or (eq size :qword) (eq size :word)))
1725 (maybe-emit-operand-size-prefix segment size)
1726 (maybe-emit-rex-for-ea segment dst nil :operand-size :do-not-set)
1727 (cond ((register-p dst)
1728 (emit-byte-with-reg segment #b01011 (reg-tn-encoding dst)))
1730 (emit-byte segment #b10001111)
1731 (emit-ea segment dst #b000))))))
1733 (define-instruction xchg (segment operand1 operand2)
1734 ;; Register with accumulator.
1735 (:printer reg-no-width ((op #b10010)) '(:name :tab accum ", " reg))
1736 ;; Register/Memory with Register.
1737 (:printer reg-reg/mem ((op #b1000011)))
1738 (:printer rex-reg-reg/mem ((op #b1000011)))
1740 (let ((size (matching-operand-size operand1 operand2)))
1741 (maybe-emit-operand-size-prefix segment size)
1742 (labels ((xchg-acc-with-something (acc something)
1743 (if (and (not (eq size :byte)) (register-p something))
1745 (maybe-emit-rex-for-ea segment acc something)
1746 (emit-byte-with-reg segment
1748 (reg-tn-encoding something)))
1749 (xchg-reg-with-something acc something)))
1750 (xchg-reg-with-something (reg something)
1751 (maybe-emit-rex-for-ea segment something reg)
1752 (emit-byte segment (if (eq size :byte) #b10000110 #b10000111))
1753 (emit-ea segment something (reg-tn-encoding reg))))
1754 (cond ((accumulator-p operand1)
1755 (xchg-acc-with-something operand1 operand2))
1756 ((accumulator-p operand2)
1757 (xchg-acc-with-something operand2 operand1))
1758 ((register-p operand1)
1759 (xchg-reg-with-something operand1 operand2))
1760 ((register-p operand2)
1761 (xchg-reg-with-something operand2 operand1))
1763 (error "bogus args to XCHG: ~S ~S" operand1 operand2)))))))
1765 (define-instruction lea (segment dst src)
1766 (:printer rex-reg-reg/mem ((op #b1000110)))
1767 (:printer reg-reg/mem ((op #b1000110) (width 1)))
1769 (aver (or (dword-reg-p dst) (qword-reg-p dst)))
1770 (maybe-emit-rex-for-ea segment src dst
1771 :operand-size :qword)
1772 (emit-byte segment #b10001101)
1773 (emit-ea segment src (reg-tn-encoding dst))))
1775 (define-instruction cmpxchg (segment dst src)
1776 ;; Register/Memory with Register.
1777 (:printer ext-reg-reg/mem ((op #b1011000)) '(:name :tab reg/mem ", " reg))
1779 (aver (register-p src))
1780 (let ((size (matching-operand-size src dst)))
1781 (maybe-emit-operand-size-prefix segment size)
1782 (maybe-emit-rex-for-ea segment dst src)
1783 (emit-byte segment #b00001111)
1784 (emit-byte segment (if (eq size :byte) #b10110000 #b10110001))
1785 (emit-ea segment dst (reg-tn-encoding src)))))
1789 (define-instruction fs-segment-prefix (segment)
1791 (emit-byte segment #x64)))
1793 ;;;; flag control instructions
1795 ;;; CLC -- Clear Carry Flag.
1796 (define-instruction clc (segment)
1797 (:printer byte ((op #b11111000)))
1799 (emit-byte segment #b11111000)))
1801 ;;; CLD -- Clear Direction Flag.
1802 (define-instruction cld (segment)
1803 (:printer byte ((op #b11111100)))
1805 (emit-byte segment #b11111100)))
1807 ;;; CLI -- Clear Iterrupt Enable Flag.
1808 (define-instruction cli (segment)
1809 (:printer byte ((op #b11111010)))
1811 (emit-byte segment #b11111010)))
1813 ;;; CMC -- Complement Carry Flag.
1814 (define-instruction cmc (segment)
1815 (:printer byte ((op #b11110101)))
1817 (emit-byte segment #b11110101)))
1819 ;;; LAHF -- Load AH into flags.
1820 (define-instruction lahf (segment)
1821 (:printer byte ((op #b10011111)))
1823 (emit-byte segment #b10011111)))
1825 ;;; POPF -- Pop flags.
1826 (define-instruction popf (segment)
1827 (:printer byte ((op #b10011101)))
1829 (emit-byte segment #b10011101)))
1831 ;;; PUSHF -- push flags.
1832 (define-instruction pushf (segment)
1833 (:printer byte ((op #b10011100)))
1835 (emit-byte segment #b10011100)))
1837 ;;; SAHF -- Store AH into flags.
1838 (define-instruction sahf (segment)
1839 (:printer byte ((op #b10011110)))
1841 (emit-byte segment #b10011110)))
1843 ;;; STC -- Set Carry Flag.
1844 (define-instruction stc (segment)
1845 (:printer byte ((op #b11111001)))
1847 (emit-byte segment #b11111001)))
1849 ;;; STD -- Set Direction Flag.
1850 (define-instruction std (segment)
1851 (:printer byte ((op #b11111101)))
1853 (emit-byte segment #b11111101)))
1855 ;;; STI -- Set Interrupt Enable Flag.
1856 (define-instruction sti (segment)
1857 (:printer byte ((op #b11111011)))
1859 (emit-byte segment #b11111011)))
1863 (defun emit-random-arith-inst (name segment dst src opcode
1864 &optional allow-constants)
1865 (let ((size (matching-operand-size dst src)))
1866 (maybe-emit-operand-size-prefix segment size)
1869 (cond ((and (not (eq size :byte)) (<= -128 src 127))
1870 (maybe-emit-rex-for-ea segment dst nil)
1871 (emit-byte segment #b10000011)
1872 (emit-ea segment dst opcode allow-constants)
1873 (emit-byte segment src))
1874 ((accumulator-p dst)
1875 (maybe-emit-rex-for-ea segment dst nil)
1882 (emit-sized-immediate segment size src))
1884 (maybe-emit-rex-for-ea segment dst nil)
1885 (emit-byte segment (if (eq size :byte) #b10000000 #b10000001))
1886 (emit-ea segment dst opcode allow-constants)
1887 (emit-sized-immediate segment size src))))
1889 (maybe-emit-rex-for-ea segment dst src)
1893 (if (eq size :byte) #b00000000 #b00000001)))
1894 (emit-ea segment dst (reg-tn-encoding src) allow-constants))
1896 (maybe-emit-rex-for-ea segment src dst)
1900 (if (eq size :byte) #b00000010 #b00000011)))
1901 (emit-ea segment src (reg-tn-encoding dst) allow-constants))
1903 (error "bogus operands to ~A" name)))))
1905 (eval-when (:compile-toplevel :execute)
1906 (defun arith-inst-printer-list (subop)
1907 `((accum-imm ((op ,(dpb subop (byte 3 2) #b0000010))))
1908 (rex-accum-imm ((op ,(dpb subop (byte 3 2) #b0000010))))
1909 (reg/mem-imm ((op (#b1000000 ,subop))))
1910 (rex-reg/mem-imm ((op (#b1000000 ,subop))))
1911 ;; The redundant encoding #x82 is invalid in 64-bit mode,
1912 ;; therefore we force WIDTH to 1.
1913 (reg/mem-imm ((op (#b1000001 ,subop)) (width 1)
1914 (imm nil :type signed-imm-byte)))
1915 (rex-reg/mem-imm ((op (#b1000001 ,subop)) (width 1)
1916 (imm nil :type signed-imm-byte)))
1917 (reg-reg/mem-dir ((op ,(dpb subop (byte 3 1) #b000000))))
1918 (rex-reg-reg/mem-dir ((op ,(dpb subop (byte 3 1) #b000000))))))
1921 (define-instruction add (segment dst src)
1922 (:printer-list (arith-inst-printer-list #b000))
1923 (:emitter (emit-random-arith-inst "ADD" segment dst src #b000)))
1925 (define-instruction adc (segment dst src)
1926 (:printer-list (arith-inst-printer-list #b010))
1927 (:emitter (emit-random-arith-inst "ADC" segment dst src #b010)))
1929 (define-instruction sub (segment dst src)
1930 (:printer-list (arith-inst-printer-list #b101))
1931 (:emitter (emit-random-arith-inst "SUB" segment dst src #b101)))
1933 (define-instruction sbb (segment dst src)
1934 (:printer-list (arith-inst-printer-list #b011))
1935 (:emitter (emit-random-arith-inst "SBB" segment dst src #b011)))
1937 (define-instruction cmp (segment dst src)
1938 (:printer-list (arith-inst-printer-list #b111))
1939 (:emitter (emit-random-arith-inst "CMP" segment dst src #b111 t)))
1941 (define-instruction inc (segment dst)
1943 (:printer modrm-reg-no-width ((modrm-reg #b000)))
1945 ;; (:printer rex-reg/mem ((op '(#b11111111 #b001))))
1946 (:printer reg/mem ((op '(#b1111111 #b000))))
1948 (let ((size (operand-size dst)))
1949 (maybe-emit-operand-size-prefix segment size)
1950 (cond #+nil ; these opcodes become REX prefixes in x86-64
1951 ((and (not (eq size :byte)) (register-p dst))
1952 (emit-byte-with-reg segment #b01000 (reg-tn-encoding dst)))
1954 (maybe-emit-rex-for-ea segment dst nil)
1955 (emit-byte segment (if (eq size :byte) #b11111110 #b11111111))
1956 (emit-ea segment dst #b000))))))
1958 (define-instruction dec (segment dst)
1960 (:printer modrm-reg-no-width ((modrm-reg #b001)))
1962 (:printer reg/mem ((op '(#b1111111 #b001))))
1964 (let ((size (operand-size dst)))
1965 (maybe-emit-operand-size-prefix segment size)
1967 ((and (not (eq size :byte)) (register-p dst))
1968 (emit-byte-with-reg segment #b01001 (reg-tn-encoding dst)))
1970 (maybe-emit-rex-for-ea segment dst nil)
1971 (emit-byte segment (if (eq size :byte) #b11111110 #b11111111))
1972 (emit-ea segment dst #b001))))))
1974 (define-instruction neg (segment dst)
1975 (:printer reg/mem ((op '(#b1111011 #b011))))
1976 (:printer rex-reg/mem ((op '(#b1111011 #b011))))
1978 (let ((size (operand-size dst)))
1979 (maybe-emit-operand-size-prefix segment size)
1980 (maybe-emit-rex-for-ea segment dst nil)
1981 (emit-byte segment (if (eq size :byte) #b11110110 #b11110111))
1982 (emit-ea segment dst #b011))))
1984 (define-instruction mul (segment dst src)
1985 (:printer accum-reg/mem ((op '(#b1111011 #b100))))
1986 (:printer rex-accum-reg/mem ((op '(#b1111011 #b100))))
1988 (let ((size (matching-operand-size dst src)))
1989 (aver (accumulator-p dst))
1990 (maybe-emit-operand-size-prefix segment size)
1991 (maybe-emit-rex-for-ea segment src nil)
1992 (emit-byte segment (if (eq size :byte) #b11110110 #b11110111))
1993 (emit-ea segment src #b100))))
1995 (define-instruction imul (segment dst &optional src1 src2)
1996 (:printer accum-reg/mem ((op '(#b1111011 #b101))))
1997 (:printer rex-accum-reg/mem ((op '(#b1111011 #b101))))
1998 (:printer ext-reg-reg/mem-no-width ((op #b10101111)))
1999 (:printer rex-ext-reg-reg/mem-no-width ((op #b10101111)))
2000 (:printer reg-reg/mem ((op #b0110100) (width 1)
2001 (imm nil :type 'signed-imm-data))
2002 '(:name :tab reg ", " reg/mem ", " imm))
2003 (:printer rex-reg-reg/mem ((op #b0110100) (width 1)
2004 (imm nil :type 'signed-imm-data))
2005 '(:name :tab reg ", " reg/mem ", " imm))
2006 (:printer reg-reg/mem ((op #b0110101) (width 1)
2007 (imm nil :type 'signed-imm-byte))
2008 '(:name :tab reg ", " reg/mem ", " imm))
2009 (:printer rex-reg-reg/mem ((op #b0110101) (width 1)
2010 (imm nil :type 'signed-imm-byte))
2011 '(:name :tab reg ", " reg/mem ", " imm))
2013 (flet ((r/m-with-immed-to-reg (reg r/m immed)
2014 (let* ((size (matching-operand-size reg r/m))
2015 (sx (and (not (eq size :byte)) (<= -128 immed 127))))
2016 (maybe-emit-operand-size-prefix segment size)
2017 (maybe-emit-rex-for-ea segment r/m reg)
2018 (emit-byte segment (if sx #b01101011 #b01101001))
2019 (emit-ea segment r/m (reg-tn-encoding reg))
2021 (emit-byte segment immed)
2022 (emit-sized-immediate segment size immed)))))
2024 (r/m-with-immed-to-reg dst src1 src2))
2027 (r/m-with-immed-to-reg dst dst src1)
2028 (let ((size (matching-operand-size dst src1)))
2029 (maybe-emit-operand-size-prefix segment size)
2030 (maybe-emit-rex-for-ea segment src1 dst)
2031 (emit-byte segment #b00001111)
2032 (emit-byte segment #b10101111)
2033 (emit-ea segment src1 (reg-tn-encoding dst)))))
2035 (let ((size (operand-size dst)))
2036 (maybe-emit-operand-size-prefix segment size)
2037 (maybe-emit-rex-for-ea segment dst nil)
2038 (emit-byte segment (if (eq size :byte) #b11110110 #b11110111))
2039 (emit-ea segment dst #b101)))))))
2041 (define-instruction div (segment dst src)
2042 (:printer accum-reg/mem ((op '(#b1111011 #b110))))
2043 (:printer rex-accum-reg/mem ((op '(#b1111011 #b110))))
2045 (let ((size (matching-operand-size dst src)))
2046 (aver (accumulator-p dst))
2047 (maybe-emit-operand-size-prefix segment size)
2048 (maybe-emit-rex-for-ea segment src nil)
2049 (emit-byte segment (if (eq size :byte) #b11110110 #b11110111))
2050 (emit-ea segment src #b110))))
2052 (define-instruction idiv (segment dst src)
2053 (:printer accum-reg/mem ((op '(#b1111011 #b111))))
2054 (:printer rex-accum-reg/mem ((op '(#b1111011 #b111))))
2056 (let ((size (matching-operand-size dst src)))
2057 (aver (accumulator-p dst))
2058 (maybe-emit-operand-size-prefix segment size)
2059 (maybe-emit-rex-for-ea segment src nil)
2060 (emit-byte segment (if (eq size :byte) #b11110110 #b11110111))
2061 (emit-ea segment src #b111))))
2063 (define-instruction bswap (segment dst)
2064 (:printer ext-reg-no-width ((op #b11001)))
2066 (let ((size (operand-size dst)))
2067 (maybe-emit-rex-prefix segment size nil nil dst)
2068 (emit-byte segment #x0f)
2069 (emit-byte-with-reg segment #b11001 (reg-tn-encoding dst)))))
2071 ;;; CBW -- Convert Byte to Word. AX <- sign_xtnd(AL)
2072 (define-instruction cbw (segment)
2073 (:printer x66-byte ((op #b10011000)))
2075 (maybe-emit-operand-size-prefix segment :word)
2076 (emit-byte segment #b10011000)))
2078 ;;; CWDE -- Convert Word To Double Word Extended. EAX <- sign_xtnd(AX)
2079 (define-instruction cwde (segment)
2080 (:printer byte ((op #b10011000)))
2082 (maybe-emit-operand-size-prefix segment :dword)
2083 (emit-byte segment #b10011000)))
2085 ;;; CDQE -- Convert Double Word To Quad Word Extended. RAX <- sign_xtnd(EAX)
2086 (define-instruction cdqe (segment)
2087 (:printer rex-byte ((op #b10011000)))
2089 (maybe-emit-rex-prefix segment :qword nil nil nil)
2090 (emit-byte segment #b10011000)))
2092 ;;; CWD -- Convert Word to Double Word. DX:AX <- sign_xtnd(AX)
2093 (define-instruction cwd (segment)
2094 (:printer x66-byte ((op #b10011001)))
2096 (maybe-emit-operand-size-prefix segment :word)
2097 (emit-byte segment #b10011001)))
2099 ;;; CDQ -- Convert Double Word to Quad Word. EDX:EAX <- sign_xtnd(EAX)
2100 (define-instruction cdq (segment)
2101 (:printer byte ((op #b10011001)))
2103 (maybe-emit-operand-size-prefix segment :dword)
2104 (emit-byte segment #b10011001)))
2106 ;;; CQO -- Convert Quad Word to Octaword. RDX:RAX <- sign_xtnd(RAX)
2107 (define-instruction cqo (segment)
2108 (:printer rex-byte ((op #b10011001)))
2110 (maybe-emit-rex-prefix segment :qword nil nil nil)
2111 (emit-byte segment #b10011001)))
2113 (define-instruction xadd (segment dst src)
2114 ;; Register/Memory with Register.
2115 (:printer ext-reg-reg/mem ((op #b1100000)) '(:name :tab reg/mem ", " reg))
2117 (aver (register-p src))
2118 (let ((size (matching-operand-size src dst)))
2119 (maybe-emit-operand-size-prefix segment size)
2120 (maybe-emit-rex-for-ea segment dst src)
2121 (emit-byte segment #b00001111)
2122 (emit-byte segment (if (eq size :byte) #b11000000 #b11000001))
2123 (emit-ea segment dst (reg-tn-encoding src)))))
2128 (defun emit-shift-inst (segment dst amount opcode)
2129 (let ((size (operand-size dst)))
2130 (maybe-emit-operand-size-prefix segment size)
2131 (multiple-value-bind (major-opcode immed)
2133 (:cl (values #b11010010 nil))
2134 (1 (values #b11010000 nil))
2135 (t (values #b11000000 t)))
2136 (maybe-emit-rex-for-ea segment dst nil)
2138 (if (eq size :byte) major-opcode (logior major-opcode 1)))
2139 (emit-ea segment dst opcode)
2141 (emit-byte segment amount)))))
2143 (eval-when (:compile-toplevel :execute)
2144 (defun shift-inst-printer-list (subop)
2145 `((reg/mem ((op (#b1101000 ,subop)))
2146 (:name :tab reg/mem ", 1"))
2147 (rex-reg/mem ((op (#b1101000 ,subop)))
2148 (:name :tab reg/mem ", 1"))
2149 (reg/mem ((op (#b1101001 ,subop)))
2150 (:name :tab reg/mem ", " 'cl))
2151 (rex-reg/mem ((op (#b1101001 ,subop)))
2152 (:name :tab reg/mem ", " 'cl))
2153 (reg/mem-imm ((op (#b1100000 ,subop))
2154 (imm nil :type imm-byte)))
2155 (rex-reg/mem-imm ((op (#b1100000 ,subop))
2156 (imm nil :type imm-byte))))))
2158 (define-instruction rol (segment dst amount)
2160 (shift-inst-printer-list #b000))
2162 (emit-shift-inst segment dst amount #b000)))
2164 (define-instruction ror (segment dst amount)
2166 (shift-inst-printer-list #b001))
2168 (emit-shift-inst segment dst amount #b001)))
2170 (define-instruction rcl (segment dst amount)
2172 (shift-inst-printer-list #b010))
2174 (emit-shift-inst segment dst amount #b010)))
2176 (define-instruction rcr (segment dst amount)
2178 (shift-inst-printer-list #b011))
2180 (emit-shift-inst segment dst amount #b011)))
2182 (define-instruction shl (segment dst amount)
2184 (shift-inst-printer-list #b100))
2186 (emit-shift-inst segment dst amount #b100)))
2188 (define-instruction shr (segment dst amount)
2190 (shift-inst-printer-list #b101))
2192 (emit-shift-inst segment dst amount #b101)))
2194 (define-instruction sar (segment dst amount)
2196 (shift-inst-printer-list #b111))
2198 (emit-shift-inst segment dst amount #b111)))
2200 (defun emit-double-shift (segment opcode dst src amt)
2201 (let ((size (matching-operand-size dst src)))
2202 (when (eq size :byte)
2203 (error "Double shifts can only be used with words."))
2204 (maybe-emit-operand-size-prefix segment size)
2205 (maybe-emit-rex-for-ea segment dst src)
2206 (emit-byte segment #b00001111)
2207 (emit-byte segment (dpb opcode (byte 1 3)
2208 (if (eq amt :cl) #b10100101 #b10100100)))
2209 (emit-ea segment dst (reg-tn-encoding src))
2210 (unless (eq amt :cl)
2211 (emit-byte segment amt))))
2213 (eval-when (:compile-toplevel :execute)
2214 (defun double-shift-inst-printer-list (op)
2216 (ext-reg-reg/mem-imm ((op ,(logior op #b100))
2217 (imm nil :type signed-imm-byte)))
2218 (ext-reg-reg/mem ((op ,(logior op #b101)))
2219 (:name :tab reg/mem ", " 'cl)))))
2221 (define-instruction shld (segment dst src amt)
2222 (:declare (type (or (member :cl) (mod 32)) amt))
2223 (:printer-list (double-shift-inst-printer-list #b10100000))
2225 (emit-double-shift segment #b0 dst src amt)))
2227 (define-instruction shrd (segment dst src amt)
2228 (:declare (type (or (member :cl) (mod 32)) amt))
2229 (:printer-list (double-shift-inst-printer-list #b10101000))
2231 (emit-double-shift segment #b1 dst src amt)))
2233 (define-instruction and (segment dst src)
2235 (arith-inst-printer-list #b100))
2237 (emit-random-arith-inst "AND" segment dst src #b100)))
2239 (define-instruction test (segment this that)
2240 (:printer accum-imm ((op #b1010100)))
2241 (:printer rex-accum-imm ((op #b1010100)))
2242 (:printer reg/mem-imm ((op '(#b1111011 #b000))))
2243 (:printer rex-reg/mem-imm ((op '(#b1111011 #b000))))
2244 (:printer reg-reg/mem ((op #b1000010)))
2245 (:printer rex-reg-reg/mem ((op #b1000010)))
2247 (let ((size (matching-operand-size this that)))
2248 (maybe-emit-operand-size-prefix segment size)
2249 (flet ((test-immed-and-something (immed something)
2250 (cond ((accumulator-p something)
2251 (maybe-emit-rex-for-ea segment something nil)
2253 (if (eq size :byte) #b10101000 #b10101001))
2254 (emit-sized-immediate segment size immed))
2256 (maybe-emit-rex-for-ea segment something nil)
2258 (if (eq size :byte) #b11110110 #b11110111))
2259 (emit-ea segment something #b000)
2260 (emit-sized-immediate segment size immed))))
2261 (test-reg-and-something (reg something)
2262 (maybe-emit-rex-for-ea segment something reg)
2263 (emit-byte segment (if (eq size :byte) #b10000100 #b10000101))
2264 (emit-ea segment something (reg-tn-encoding reg))))
2265 (cond ((integerp that)
2266 (test-immed-and-something that this))
2268 (test-immed-and-something this that))
2270 (test-reg-and-something this that))
2272 (test-reg-and-something that this))
2274 (error "bogus operands for TEST: ~S and ~S" this that)))))))
2276 (define-instruction or (segment dst src)
2278 (arith-inst-printer-list #b001))
2280 (emit-random-arith-inst "OR" segment dst src #b001)))
2282 (define-instruction xor (segment dst src)
2284 (arith-inst-printer-list #b110))
2286 (emit-random-arith-inst "XOR" segment dst src #b110)))
2288 (define-instruction not (segment dst)
2289 (:printer reg/mem ((op '(#b1111011 #b010))))
2290 (:printer rex-reg/mem ((op '(#b1111011 #b010))))
2292 (let ((size (operand-size dst)))
2293 (maybe-emit-operand-size-prefix segment size)
2294 (maybe-emit-rex-for-ea segment dst nil)
2295 (emit-byte segment (if (eq size :byte) #b11110110 #b11110111))
2296 (emit-ea segment dst #b010))))
2298 ;;;; string manipulation
2300 (define-instruction cmps (segment size)
2301 (:printer string-op ((op #b1010011)))
2302 (:printer rex-string-op ((op #b1010011)))
2304 (maybe-emit-operand-size-prefix segment size)
2305 (maybe-emit-rex-prefix segment size nil nil nil)
2306 (emit-byte segment (if (eq size :byte) #b10100110 #b10100111))))
2308 (define-instruction ins (segment acc)
2309 (:printer string-op ((op #b0110110)))
2310 (:printer rex-string-op ((op #b0110110)))
2312 (let ((size (operand-size acc)))
2313 (aver (accumulator-p acc))
2314 (maybe-emit-operand-size-prefix segment size)
2315 (maybe-emit-rex-prefix segment size nil nil nil)
2316 (emit-byte segment (if (eq size :byte) #b01101100 #b01101101)))))
2318 (define-instruction lods (segment acc)
2319 (:printer string-op ((op #b1010110)))
2320 (:printer rex-string-op ((op #b1010110)))
2322 (let ((size (operand-size acc)))
2323 (aver (accumulator-p acc))
2324 (maybe-emit-operand-size-prefix segment size)
2325 (maybe-emit-rex-prefix segment size nil nil nil)
2326 (emit-byte segment (if (eq size :byte) #b10101100 #b10101101)))))
2328 (define-instruction movs (segment size)
2329 (:printer string-op ((op #b1010010)))
2330 (:printer rex-string-op ((op #b1010010)))
2332 (maybe-emit-operand-size-prefix segment size)
2333 (maybe-emit-rex-prefix segment size nil nil nil)
2334 (emit-byte segment (if (eq size :byte) #b10100100 #b10100101))))
2336 (define-instruction outs (segment acc)
2337 (:printer string-op ((op #b0110111)))
2338 (:printer rex-string-op ((op #b0110111)))
2340 (let ((size (operand-size acc)))
2341 (aver (accumulator-p acc))
2342 (maybe-emit-operand-size-prefix segment size)
2343 (maybe-emit-rex-prefix segment size nil nil nil)
2344 (emit-byte segment (if (eq size :byte) #b01101110 #b01101111)))))
2346 (define-instruction scas (segment acc)
2347 (:printer string-op ((op #b1010111)))
2348 (:printer rex-string-op ((op #b1010111)))
2350 (let ((size (operand-size acc)))
2351 (aver (accumulator-p acc))
2352 (maybe-emit-operand-size-prefix segment size)
2353 (maybe-emit-rex-prefix segment size nil nil nil)
2354 (emit-byte segment (if (eq size :byte) #b10101110 #b10101111)))))
2356 (define-instruction stos (segment acc)
2357 (:printer string-op ((op #b1010101)))
2358 (:printer rex-string-op ((op #b1010101)))
2360 (let ((size (operand-size acc)))
2361 (aver (accumulator-p acc))
2362 (maybe-emit-operand-size-prefix segment size)
2363 (maybe-emit-rex-prefix segment size nil nil nil)
2364 (emit-byte segment (if (eq size :byte) #b10101010 #b10101011)))))
2366 (define-instruction xlat (segment)
2367 (:printer byte ((op #b11010111)))
2369 (emit-byte segment #b11010111)))
2371 (define-instruction rep (segment)
2373 (emit-byte segment #b11110010)))
2375 (define-instruction repe (segment)
2376 (:printer byte ((op #b11110011)))
2378 (emit-byte segment #b11110011)))
2380 (define-instruction repne (segment)
2381 (:printer byte ((op #b11110010)))
2383 (emit-byte segment #b11110010)))
2386 ;;;; bit manipulation
2388 (define-instruction bsf (segment dst src)
2389 (:printer ext-reg-reg/mem-no-width ((op #b10111100)))
2390 (:printer rex-ext-reg-reg/mem-no-width ((op #b10111100)))
2392 (let ((size (matching-operand-size dst src)))
2393 (when (eq size :byte)
2394 (error "can't scan bytes: ~S" src))
2395 (maybe-emit-operand-size-prefix segment size)
2396 (maybe-emit-rex-for-ea segment src dst)
2397 (emit-byte segment #b00001111)
2398 (emit-byte segment #b10111100)
2399 (emit-ea segment src (reg-tn-encoding dst)))))
2401 (define-instruction bsr (segment dst src)
2402 (:printer ext-reg-reg/mem-no-width ((op #b10111101)))
2403 (:printer rex-ext-reg-reg/mem-no-width ((op #b10111101)))
2405 (let ((size (matching-operand-size dst src)))
2406 (when (eq size :byte)
2407 (error "can't scan bytes: ~S" src))
2408 (maybe-emit-operand-size-prefix segment size)
2409 (maybe-emit-rex-for-ea segment src dst)
2410 (emit-byte segment #b00001111)
2411 (emit-byte segment #b10111101)
2412 (emit-ea segment src (reg-tn-encoding dst)))))
2414 (defun emit-bit-test-and-mumble (segment src index opcode)
2415 (let ((size (operand-size src)))
2416 (when (eq size :byte)
2417 (error "can't scan bytes: ~S" src))
2418 (maybe-emit-operand-size-prefix segment size)
2419 (cond ((integerp index)
2420 (maybe-emit-rex-for-ea segment src nil)
2421 (emit-byte segment #b00001111)
2422 (emit-byte segment #b10111010)
2423 (emit-ea segment src opcode)
2424 (emit-byte segment index))
2426 (maybe-emit-rex-for-ea segment src index)
2427 (emit-byte segment #b00001111)
2428 (emit-byte segment (dpb opcode (byte 3 3) #b10000011))
2429 (emit-ea segment src (reg-tn-encoding index))))))
2431 (eval-when (:compile-toplevel :execute)
2432 (defun bit-test-inst-printer-list (subop)
2433 `((ext-reg/mem-imm ((op (#b1011101 ,subop))
2434 (reg/mem nil :type reg/mem)
2435 (imm nil :type imm-byte)
2437 (ext-reg-reg/mem ((op ,(dpb subop (byte 3 2) #b1000001))
2439 (:name :tab reg/mem ", " reg)))))
2441 (define-instruction bt (segment src index)
2442 (:printer-list (bit-test-inst-printer-list #b100))
2444 (emit-bit-test-and-mumble segment src index #b100)))
2446 (define-instruction btc (segment src index)
2447 (:printer-list (bit-test-inst-printer-list #b111))
2449 (emit-bit-test-and-mumble segment src index #b111)))
2451 (define-instruction btr (segment src index)
2452 (:printer-list (bit-test-inst-printer-list #b110))
2454 (emit-bit-test-and-mumble segment src index #b110)))
2456 (define-instruction bts (segment src index)
2457 (:printer-list (bit-test-inst-printer-list #b101))
2459 (emit-bit-test-and-mumble segment src index #b101)))
2462 ;;;; control transfer
2464 (define-instruction call (segment where)
2465 (:printer near-jump ((op #b11101000)))
2466 (:printer reg/mem-default-qword ((op '(#b11111111 #b010))))
2467 (:printer rex-reg/mem-default-qword ((op '(#b11111111 #b010))))
2471 (emit-byte segment #b11101000) ; 32 bit relative
2472 (emit-back-patch segment
2474 (lambda (segment posn)
2475 (emit-signed-dword segment
2476 (- (label-position where)
2479 (emit-byte segment #b11101000)
2480 (emit-relative-fixup segment where))
2482 (maybe-emit-rex-for-ea segment where nil :operand-size :do-not-set)
2483 (emit-byte segment #b11111111)
2484 (emit-ea segment where #b010)))))
2486 (defun emit-byte-displacement-backpatch (segment target)
2487 (emit-back-patch segment
2489 (lambda (segment posn)
2490 (let ((disp (- (label-position target) (1+ posn))))
2491 (aver (<= -128 disp 127))
2492 (emit-byte segment disp)))))
2494 (define-instruction jmp (segment cond &optional where)
2495 ;; conditional jumps
2496 (:printer short-cond-jump ((op #b0111)) '('j cc :tab label))
2497 (:printer near-cond-jump () '('j cc :tab label))
2498 ;; unconditional jumps
2499 (:printer short-jump ((op #b1011)))
2500 (:printer near-jump ((op #b11101001)))
2501 (:printer reg/mem-default-qword ((op '(#b11111111 #b100))))
2502 (:printer rex-reg/mem-default-qword ((op '(#b11111111 #b100))))
2507 (lambda (segment posn delta-if-after)
2508 (let ((disp (- (label-position where posn delta-if-after)
2510 (when (<= -128 disp 127)
2512 (dpb (conditional-opcode cond)
2515 (emit-byte-displacement-backpatch segment where)
2517 (lambda (segment posn)
2518 (let ((disp (- (label-position where) (+ posn 6))))
2519 (emit-byte segment #b00001111)
2521 (dpb (conditional-opcode cond)
2524 (emit-signed-dword segment disp)))))
2525 ((label-p (setq where cond))
2528 (lambda (segment posn delta-if-after)
2529 (let ((disp (- (label-position where posn delta-if-after)
2531 (when (<= -128 disp 127)
2532 (emit-byte segment #b11101011)
2533 (emit-byte-displacement-backpatch segment where)
2535 (lambda (segment posn)
2536 (let ((disp (- (label-position where) (+ posn 5))))
2537 (emit-byte segment #b11101001)
2538 (emit-signed-dword segment disp)))))
2540 (emit-byte segment #b11101001)
2541 (emit-relative-fixup segment where))
2543 (unless (or (ea-p where) (tn-p where))
2544 (error "don't know what to do with ~A" where))
2545 ;; near jump defaults to 64 bit
2546 ;; w-bit in rex prefix is unnecessary
2547 (maybe-emit-rex-for-ea segment where nil :operand-size :do-not-set)
2548 (emit-byte segment #b11111111)
2549 (emit-ea segment where #b100)))))
2551 (define-instruction jmp-short (segment label)
2553 (emit-byte segment #b11101011)
2554 (emit-byte-displacement-backpatch segment label)))
2556 (define-instruction ret (segment &optional stack-delta)
2557 (:printer byte ((op #b11000011)))
2558 (:printer byte ((op #b11000010) (imm nil :type 'imm-word-16))
2562 (emit-byte segment #b11000010)
2563 (emit-word segment stack-delta))
2565 (emit-byte segment #b11000011)))))
2567 (define-instruction jecxz (segment target)
2568 (:printer short-jump ((op #b0011)))
2570 (emit-byte segment #b11100011)
2571 (emit-byte-displacement-backpatch segment target)))
2573 (define-instruction loop (segment target)
2574 (:printer short-jump ((op #b0010)))
2576 (emit-byte segment #b11100010) ; pfw this was 11100011, or jecxz!!!!
2577 (emit-byte-displacement-backpatch segment target)))
2579 (define-instruction loopz (segment target)
2580 (:printer short-jump ((op #b0001)))
2582 (emit-byte segment #b11100001)
2583 (emit-byte-displacement-backpatch segment target)))
2585 (define-instruction loopnz (segment target)
2586 (:printer short-jump ((op #b0000)))
2588 (emit-byte segment #b11100000)
2589 (emit-byte-displacement-backpatch segment target)))
2591 ;;;; conditional move
2592 (define-instruction cmov (segment cond dst src)
2593 (:printer cond-move ())
2594 (:printer rex-cond-move ())
2596 (aver (register-p dst))
2597 (let ((size (matching-operand-size dst src)))
2598 (aver (or (eq size :word) (eq size :dword) (eq size :qword)))
2599 (maybe-emit-operand-size-prefix segment size))
2600 (maybe-emit-rex-for-ea segment src dst)
2601 (emit-byte segment #b00001111)
2602 (emit-byte segment (dpb (conditional-opcode cond) (byte 4 0) #b01000000))
2603 (emit-ea segment src (reg-tn-encoding dst))))
2605 ;;;; conditional byte set
2607 (define-instruction set (segment dst cond)
2608 (:printer cond-set ())
2610 (maybe-emit-rex-for-ea segment dst nil)
2611 (emit-byte segment #b00001111)
2612 (emit-byte segment (dpb (conditional-opcode cond) (byte 4 0) #b10010000))
2613 (emit-ea segment dst #b000)))
2617 (define-instruction enter (segment disp &optional (level 0))
2618 (:declare (type (unsigned-byte 16) disp)
2619 (type (unsigned-byte 8) level))
2620 (:printer enter-format ((op #b11001000)))
2622 (emit-byte segment #b11001000)
2623 (emit-word segment disp)
2624 (emit-byte segment level)))
2626 (define-instruction leave (segment)
2627 (:printer byte ((op #b11001001)))
2629 (emit-byte segment #b11001001)))
2631 ;;;; interrupt instructions
2633 (defun snarf-error-junk (sap offset &optional length-only)
2634 (let* ((length (sb!sys:sap-ref-8 sap offset))
2635 (vector (make-array length :element-type '(unsigned-byte 8))))
2636 (declare (type sb!sys:system-area-pointer sap)
2637 (type (unsigned-byte 8) length)
2638 (type (simple-array (unsigned-byte 8) (*)) vector))
2640 (values 0 (1+ length) nil nil))
2642 (sb!kernel:copy-ub8-from-system-area sap (1+ offset)
2644 (collect ((sc-offsets)
2646 (lengths 1) ; the length byte
2648 (error-number (sb!c:read-var-integer vector index)))
2651 (when (>= index length)
2653 (let ((old-index index))
2654 (sc-offsets (sb!c:read-var-integer vector index))
2655 (lengths (- index old-index))))
2656 (values error-number
2662 (defmacro break-cases (breaknum &body cases)
2663 (let ((bn-temp (gensym)))
2664 (collect ((clauses))
2665 (dolist (case cases)
2666 (clauses `((= ,bn-temp ,(car case)) ,@(cdr case))))
2667 `(let ((,bn-temp ,breaknum))
2668 (cond ,@(clauses))))))
2671 (defun break-control (chunk inst stream dstate)
2672 (declare (ignore inst))
2673 (flet ((nt (x) (if stream (sb!disassem:note x dstate))))
2674 ;; FIXME: Make sure that BYTE-IMM-CODE is defined. The genesis
2675 ;; map has it undefined; and it should be easier to look in the target
2676 ;; Lisp (with (DESCRIBE 'BYTE-IMM-CODE)) than to definitively deduce
2677 ;; from first principles whether it's defined in some way that genesis
2679 (case (byte-imm-code chunk dstate)
2682 (sb!disassem:handle-break-args #'snarf-error-junk stream dstate))
2685 (sb!disassem:handle-break-args #'snarf-error-junk stream dstate))
2687 (nt "breakpoint trap"))
2688 (#.pending-interrupt-trap
2689 (nt "pending interrupt trap"))
2692 (#.fun-end-breakpoint-trap
2693 (nt "function end breakpoint trap")))))
2695 (define-instruction break (segment code)
2696 (:declare (type (unsigned-byte 8) code))
2697 (:printer byte-imm ((op #b11001100)) '(:name :tab code)
2698 :control #'break-control)
2700 (emit-byte segment #b11001100)
2701 (emit-byte segment code)))
2703 (define-instruction int (segment number)
2704 (:declare (type (unsigned-byte 8) number))
2705 (:printer byte-imm ((op #b11001101)))
2709 (emit-byte segment #b11001100))
2711 (emit-byte segment #b11001101)
2712 (emit-byte segment number)))))
2714 (define-instruction iret (segment)
2715 (:printer byte ((op #b11001111)))
2717 (emit-byte segment #b11001111)))
2719 ;;;; processor control
2721 (define-instruction hlt (segment)
2722 (:printer byte ((op #b11110100)))
2724 (emit-byte segment #b11110100)))
2726 (define-instruction nop (segment)
2727 (:printer byte ((op #b10010000)))
2729 (emit-byte segment #b10010000)))
2731 (define-instruction wait (segment)
2732 (:printer byte ((op #b10011011)))
2734 (emit-byte segment #b10011011)))
2736 (define-instruction lock (segment)
2737 (:printer byte ((op #b11110000)))
2739 (emit-byte segment #b11110000)))
2741 ;;;; miscellaneous hackery
2743 (define-instruction byte (segment byte)
2745 (emit-byte segment byte)))
2747 (define-instruction word (segment word)
2749 (emit-word segment word)))
2751 (define-instruction dword (segment dword)
2753 (emit-dword segment dword)))
2755 (defun emit-header-data (segment type)
2756 (emit-back-patch segment
2758 (lambda (segment posn)
2762 (component-header-length))
2766 (define-instruction simple-fun-header-word (segment)
2768 (emit-header-data segment simple-fun-header-widetag)))
2770 (define-instruction lra-header-word (segment)
2772 (emit-header-data segment return-pc-header-widetag)))
2774 ;;;; Instructions required to do floating point operations using SSE
2776 (defun emit-sse-inst (segment dst src prefix opcode &key operand-size)
2778 (emit-byte segment prefix))
2780 (maybe-emit-rex-for-ea segment src dst :operand-size operand-size)
2781 (maybe-emit-rex-for-ea segment src dst))
2782 (emit-byte segment #x0f)
2783 (emit-byte segment opcode)
2784 (emit-ea segment src (reg-tn-encoding dst)))
2786 ;;; Emit an SSE instruction that has an XMM register as the destination
2787 ;;; operand and for which the size of the operands is implicitly given
2788 ;;; by the instruction.
2789 (defun emit-regular-sse-inst (segment dst src prefix opcode)
2790 (aver (xmm-register-p dst))
2791 (emit-sse-inst segment dst src prefix opcode
2792 :operand-size :do-not-set))
2794 ;;; Instructions having an XMM register as the destination operand
2795 ;;; and an XMM register or a memory location as the source operand.
2796 ;;; The operand size is implicitly given by the instruction.
2798 (macrolet ((define-regular-sse-inst (name prefix opcode)
2799 `(define-instruction ,name (segment dst src)
2801 `((:printer ext-xmm-xmm/mem
2802 ((prefix ,prefix) (op ,opcode)))
2803 (:printer ext-rex-xmm-xmm/mem
2804 ((prefix ,prefix) (op ,opcode))))
2805 `((:printer xmm-xmm/mem ((op ,opcode)))
2806 (:printer rex-xmm-xmm/mem ((op ,opcode)))))
2808 (emit-regular-sse-inst segment dst src ,prefix ,opcode)))))
2810 (define-regular-sse-inst andpd #x66 #x54)
2811 (define-regular-sse-inst andps nil #x54)
2812 (define-regular-sse-inst xorpd #x66 #x57)
2813 (define-regular-sse-inst xorps nil #x57)
2815 (define-regular-sse-inst comisd #x66 #x2f)
2816 (define-regular-sse-inst comiss nil #x2f)
2818 (define-regular-sse-inst addsd #xf2 #x58)
2819 (define-regular-sse-inst addss #xf3 #x58)
2820 (define-regular-sse-inst divsd #xf2 #x5e)
2821 (define-regular-sse-inst divss #xf3 #x5e)
2822 (define-regular-sse-inst mulsd #xf2 #x59)
2823 (define-regular-sse-inst mulss #xf3 #x59)
2824 (define-regular-sse-inst subsd #xf2 #x5c)
2825 (define-regular-sse-inst subss #xf3 #x5c)
2826 (define-regular-sse-inst sqrtsd #xf2 #x51)
2827 (define-regular-sse-inst sqrtss #xf3 #x51)
2829 (define-regular-sse-inst cvtsd2ss #xf2 #x5a)
2830 (define-regular-sse-inst cvtss2sd #xf3 #x5a)
2831 (define-regular-sse-inst cvtdq2pd #xf3 #xe6)
2832 (define-regular-sse-inst cvtdq2ps nil #x5b))
2835 (macrolet ((define-movsd/ss-sse-inst (name prefix)
2836 `(define-instruction ,name (segment dst src)
2837 (:printer ext-xmm-xmm/mem-dir ((prefix ,prefix)
2839 (:printer ext-rex-xmm-xmm/mem-dir ((prefix ,prefix)
2842 (cond ((xmm-register-p dst)
2843 (emit-sse-inst segment dst src ,prefix #x10
2844 :operand-size :do-not-set))
2846 (aver (xmm-register-p src))
2847 (emit-sse-inst segment src dst ,prefix #x11
2848 :operand-size :do-not-set)))))))
2849 (define-movsd/ss-sse-inst movsd #xf2)
2850 (define-movsd/ss-sse-inst movss #xf3))
2853 (define-instruction movq (segment dst src)
2854 (:printer ext-xmm-xmm/mem ((prefix #xf3) (op #x7e)))
2855 (:printer ext-rex-xmm-xmm/mem ((prefix #xf3) (op #x7e)))
2856 (:printer ext-xmm-xmm/mem ((prefix #x66) (op #xd6))
2857 '(:name :tab reg/mem ", " reg))
2858 (:printer ext-rex-xmm-xmm/mem ((prefix #x66) (op #xd6))
2859 '(:name :tab reg/mem ", " reg))
2861 (cond ((xmm-register-p dst)
2862 (emit-sse-inst segment dst src #xf3 #x7e
2863 :operand-size :do-not-set))
2865 (aver (xmm-register-p src))
2866 (emit-sse-inst segment src dst #x66 #xd6
2867 :operand-size :do-not-set)))))
2869 ;;; Instructions having an XMM register as the destination operand
2870 ;;; and a general-purpose register or a memory location as the source
2871 ;;; operand. The operand size is calculated from the source operand.
2873 ;;; MOVD - Move a 32- or 64-bit value from a general-purpose register or
2874 ;;; a memory location to the low order 32 or 64 bits of an XMM register
2875 ;;; with zero extension or vice versa.
2876 ;;; We do not support the MMX version of this instruction.
2877 (define-instruction movd (segment dst src)
2878 (:printer ext-xmm-reg/mem ((prefix #x66) (op #x6e)))
2879 (:printer ext-rex-xmm-reg/mem ((prefix #x66) (op #x6e)))
2880 (:printer ext-xmm-reg/mem ((prefix #x66) (op #x7e))
2881 '(:name :tab reg/mem ", " reg))
2882 (:printer ext-rex-xmm-reg/mem ((prefix #x66) (op #x7e))
2883 '(:name :tab reg/mem ", " reg))
2885 (cond ((xmm-register-p dst)
2886 (emit-sse-inst segment dst src #x66 #x6e))
2888 (aver (xmm-register-p src))
2889 (emit-sse-inst segment src dst #x66 #x7e)))))
2891 (macrolet ((define-integer-source-sse-inst (name prefix opcode)
2892 `(define-instruction ,name (segment dst src)
2893 (:printer ext-xmm-reg/mem ((prefix ,prefix) (op ,opcode)))
2894 (:printer ext-rex-xmm-reg/mem ((prefix ,prefix) (op ,opcode)))
2896 (aver (xmm-register-p dst))
2897 (let ((src-size (operand-size src)))
2898 (aver (or (eq src-size :qword) (eq src-size :dword))))
2899 (emit-sse-inst segment dst src ,prefix ,opcode)))))
2900 (define-integer-source-sse-inst cvtsi2sd #xf2 #x2a)
2901 (define-integer-source-sse-inst cvtsi2ss #xf3 #x2a))
2903 ;;; Instructions having a general-purpose register as the destination
2904 ;;; operand and an XMM register or a memory location as the source
2905 ;;; operand. The operand size is calculated from the destination
2908 (macrolet ((define-gpr-destination-sse-inst (name prefix opcode)
2909 `(define-instruction ,name (segment dst src)
2910 (:printer ext-reg-xmm/mem ((prefix ,prefix) (op ,opcode)))
2911 (:printer ext-rex-reg-xmm/mem ((prefix ,prefix) (op ,opcode)))
2913 (aver (register-p dst))
2914 (let ((dst-size (operand-size dst)))
2915 (aver (or (eq dst-size :qword) (eq dst-size :dword)))
2916 (emit-sse-inst segment dst src ,prefix ,opcode
2917 :operand-size dst-size))))))
2918 (define-gpr-destination-sse-inst cvtsd2si #xf2 #x2d)
2919 (define-gpr-destination-sse-inst cvtss2si #xf3 #x2d)
2920 (define-gpr-destination-sse-inst cvttsd2si #xf2 #x2c)
2921 (define-gpr-destination-sse-inst cvttss2si #xf3 #x2c))
2923 ;;; Other SSE instructions
2925 (define-instruction ldmxcsr (segment src)
2927 (emit-byte segment #x0f)
2928 (emit-byte segment #xae)
2929 (emit-ea segment src 2)))
2931 (define-instruction stmxcsr (segment dst)
2933 (emit-byte segment #x0f)
2934 (emit-byte segment #xae)
2935 (emit-ea segment dst 3)))