1f3cc0b3091ca92d7b9c096aca28b6e1b357e852
[sbcl.git] / src / compiler / x86-64 / insts.lisp
1 ;;;; that part of the description of the x86-64 instruction set
2 ;;;; which can live on the cross-compilation host
3
4 ;;;; This software is part of the SBCL system. See the README file for
5 ;;;; more information.
6 ;;;;
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.
12
13 (in-package "SB!VM")
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.
17
18 ;;; Note: In CMU CL, this used to be a call to SET-DISASSEM-PARAMS.
19 (setf sb!disassem:*disassem-inst-alignment-bytes* 1)
20
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))
24
25 ;;; This includes legacy registers and R8-R15.
26 (deftype full-reg () '(unsigned-byte 4))
27
28 ;;; The XMM registers XMM0 - XMM15.
29 (deftype xmmreg () '(unsigned-byte 4))
30
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)
34
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)
39 \f
40 (eval-when (#-sb-xc :compile-toplevel :load-toplevel :execute)
41
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))
46
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*
50   #(ah ch dh bh))
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))
57
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
63 ;;; symbols:
64 ;;;
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
69 ;;;                  found
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
73
74 ;;; Return the operand size depending on the prefixes and width bit as
75 ;;; stored in DSTATE.
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)
79          :byte)
80         ((sb!disassem:dstate-get-inst-prop dstate 'rex-w)
81          :qword)
82         ((sb!disassem:dstate-get-inst-prop dstate 'operand-size-16)
83          :word)
84         (t
85          +default-operand-size+)))
86
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)
93       :word
94       :qword))
95
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)
102            (type stream stream)
103            (type sb!disassem:disassem-state dstate))
104   (princ (if (and (eq width :byte)
105                   (<= 4 value 7)
106                   (not (sb!disassem:dstate-get-inst-prop dstate 'rex)))
107              (aref *high-byte-reg-names* (- value 4))
108              (aref (ecase width
109                      (:byte *byte-reg-names*)
110                      (:word *word-reg-names*)
111                      (:dword *dword-reg-names*)
112                      (:qword *qword-reg-names*))
113                    value))
114          stream)
115   ;; XXX plus should do some source-var notes
116   )
117
118 (defun print-reg (value stream dstate)
119   (declare (type full-reg value)
120            (type stream stream)
121            (type sb!disassem:disassem-state dstate))
122   (print-reg-with-width value
123                         (inst-operand-size dstate)
124                         stream
125                         dstate))
126
127 (defun print-reg-default-qword (value stream dstate)
128   (declare (type full-reg value)
129            (type stream stream)
130            (type sb!disassem:disassem-state dstate))
131   (print-reg-with-width value
132                         (inst-operand-size-default-qword dstate)
133                         stream
134                         dstate))
135
136 (defun print-byte-reg (value stream dstate)
137   (declare (type full-reg value)
138            (type stream stream)
139            (type sb!disassem:disassem-state dstate))
140   (print-reg-with-width value :byte stream dstate))
141
142 (defun print-addr-reg (value stream dstate)
143   (declare (type full-reg value)
144            (type stream stream)
145            (type sb!disassem:disassem-state dstate))
146   (print-reg-with-width value +default-address-size+ stream dstate))
147
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
150 ;;; references.
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)
155            (type stream stream)
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)))
160
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)
165            (type stream stream)
166            (type sb!disassem:disassem-state dstate))
167   (print-reg/mem-with-width
168    value (inst-operand-size dstate) nil stream dstate))
169
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)
174            (type stream stream)
175            (type sb!disassem:disassem-state dstate))
176   (print-reg/mem-with-width
177    value (inst-operand-size dstate) t stream dstate))
178
179 ;;; Same as print-sized-reg/mem, but with a default operand size of
180 ;;; :qword.
181 (defun print-sized-reg/mem-default-qword (value stream dstate)
182   (declare (type (or list full-reg) value)
183            (type stream stream)
184            (type sb!disassem:disassem-state dstate))
185   (print-reg/mem-with-width
186    value (inst-operand-size-default-qword dstate) t stream dstate))
187
188 (defun print-sized-byte-reg/mem (value stream dstate)
189   (declare (type (or list full-reg) value)
190            (type stream stream)
191            (type sb!disassem:disassem-state dstate))
192   (print-reg/mem-with-width value :byte t stream dstate))
193
194 (defun print-sized-word-reg/mem (value stream dstate)
195   (declare (type (or list full-reg) value)
196            (type stream stream)
197            (type sb!disassem:disassem-state dstate))
198   (print-reg/mem-with-width value :word t stream dstate))
199
200 (defun print-sized-dword-reg/mem (value stream dstate)
201   (declare (type (or list full-reg) value)
202            (type stream stream)
203            (type sb!disassem:disassem-state dstate))
204   (print-reg/mem-with-width value :dword t stream dstate))
205
206 (defun print-label (value stream dstate)
207   (declare (ignore dstate))
208   (sb!disassem:princ16 value stream))
209
210 (defun print-xmmreg (value stream dstate)
211   (declare (type xmmreg value)
212            (type stream stream)
213            (ignore dstate))
214   (format stream "XMM~d" value))
215
216 (defun print-xmmreg/mem (value stream dstate)
217   (declare (type (or list xmmreg) value)
218            (type stream stream)
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)))
223
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)
228            (type stream stream)
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)))
233
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))
249   value)
250
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))
256   (when (zerop value)
257     (sb!disassem:dstate-put-inst-prop dstate 'operand-size-8))
258   value)
259
260 ;;; This prefilter is used solely for its side effect, namely to put
261 ;;; the property OPERAND-SIZE-16 into the DSTATE.
262 (defun prefilter-x66 (value dstate)
263   (declare (type (eql #x66) value)
264            (ignore value)
265            (type sb!disassem:disassem-state dstate))
266   (sb!disassem:dstate-put-inst-prop dstate 'operand-size-16))
267
268 ;;; A register field that can be extended by REX.R.
269 (defun prefilter-reg-r (value dstate)
270   (declare (type reg value)
271            (type sb!disassem:disassem-state dstate))
272   (if (sb!disassem::dstate-get-inst-prop dstate 'rex-r)
273       (+ value 8)
274       value))
275
276 ;;; A register field that can be extended by REX.B.
277 (defun prefilter-reg-b (value dstate)
278   (declare (type reg value)
279            (type sb!disassem:disassem-state dstate))
280   (if (sb!disassem::dstate-get-inst-prop dstate 'rex-b)
281       (+ value 8)
282       value))
283
284 ;;; Returns either an integer, meaning a register, or a list of
285 ;;; (BASE-REG OFFSET INDEX-REG INDEX-SCALE), where any component
286 ;;; may be missing or nil to indicate that it's not used or has the
287 ;;; obvious default value (e.g., 1 for the index-scale). VALUE is a list
288 ;;; of the mod and r/m field of the ModRM byte of the instruction.
289 ;;; Depending on VALUE a SIB byte and/or an offset may be read. The
290 ;;; REX.B bit from DSTATE is used to extend the sole register or the
291 ;;; BASE-REG to a full register, the REX.X bit does the same for the
292 ;;; INDEX-REG.
293 (defun prefilter-reg/mem (value dstate)
294   (declare (type list value)
295            (type sb!disassem:disassem-state dstate))
296   (let ((mod (first value))
297         (r/m (second value)))
298     (declare (type (unsigned-byte 2) mod)
299              (type (unsigned-byte 3) r/m))
300     (let ((full-reg (if (sb!disassem:dstate-get-inst-prop dstate 'rex-b)
301                         (+ r/m 8)
302                         r/m)))
303       (declare (type full-reg full-reg))
304       (cond ((= mod #b11)
305              ;; registers
306              full-reg)
307             ((= r/m #b100)
308              ;; sib byte
309              (let ((sib (sb!disassem:read-suffix 8 dstate)))
310                (declare (type (unsigned-byte 8) sib))
311                (let ((base-reg (ldb (byte 3 0) sib))
312                      (index-reg (ldb (byte 3 3) sib))
313                      (index-scale (ldb (byte 2 6) sib)))
314                  (declare (type (unsigned-byte 3) base-reg index-reg)
315                           (type (unsigned-byte 2) index-scale))
316                  (let* ((offset
317                          (case mod
318                                (#b00
319                                 (if (= base-reg #b101)
320                                     (sb!disassem:read-signed-suffix 32 dstate)
321                                   nil))
322                                (#b01
323                                 (sb!disassem:read-signed-suffix 8 dstate))
324                                (#b10
325                                 (sb!disassem:read-signed-suffix 32 dstate)))))
326                    (list (unless (and (= mod #b00) (= base-reg #b101))
327                            (if (sb!disassem:dstate-get-inst-prop dstate 'rex-b)
328                                (+ base-reg 8)
329                                base-reg))
330                          offset
331                          (unless (= index-reg #b100)
332                            (if (sb!disassem:dstate-get-inst-prop dstate 'rex-x)
333                                (+ index-reg 8)
334                                index-reg))
335                          (ash 1 index-scale))))))
336             ((and (= mod #b00) (= r/m #b101))
337              (list 'rip (sb!disassem:read-signed-suffix 32 dstate)))
338             ((= mod #b00)
339              (list full-reg))
340             ((= mod #b01)
341            (list full-reg (sb!disassem:read-signed-suffix 8 dstate)))
342           (t                            ; (= mod #b10)
343            (list full-reg (sb!disassem:read-signed-suffix 32 dstate)))))))
344
345 (defun read-address (value dstate)
346   (declare (ignore value))              ; always nil anyway
347   (sb!disassem:read-suffix (width-bits (inst-operand-size dstate)) dstate))
348
349 (defun width-bits (width)
350   (ecase width
351     (:byte 8)
352     (:word 16)
353     (:dword 32)
354     (:qword 64)))
355
356 ) ; EVAL-WHEN
357 \f
358 ;;;; disassembler argument types
359
360 ;;; Used to capture the lower four bits of the REX prefix.
361 (sb!disassem:define-arg-type wrxb
362   :prefilter #'prefilter-wrxb)
363
364 (sb!disassem:define-arg-type width
365   :prefilter #'prefilter-width
366   :printer (lambda (value stream dstate)
367              (declare (ignore value))
368              (princ (schar (symbol-name (inst-operand-size dstate)) 0)
369                     stream)))
370
371 ;;; Used to capture the effect of the #x66 operand size override prefix.
372 (sb!disassem:define-arg-type x66
373   :prefilter #'prefilter-x66)
374
375 (sb!disassem:define-arg-type displacement
376   :sign-extend t
377   :use-label #'offset-next
378   :printer (lambda (value stream dstate)
379              (sb!disassem:maybe-note-assembler-routine value nil dstate)
380              (print-label value stream dstate)))
381
382 (sb!disassem:define-arg-type accum
383   :printer (lambda (value stream dstate)
384              (declare (ignore value)
385                       (type stream stream)
386                       (type sb!disassem:disassem-state dstate))
387              (print-reg 0 stream dstate)))
388
389 (sb!disassem:define-arg-type reg
390   :prefilter #'prefilter-reg-r
391   :printer #'print-reg)
392
393 (sb!disassem:define-arg-type reg-b
394   :prefilter #'prefilter-reg-b
395   :printer #'print-reg)
396
397 (sb!disassem:define-arg-type reg-b-default-qword
398   :prefilter #'prefilter-reg-b
399   :printer #'print-reg-default-qword)
400
401 (sb!disassem:define-arg-type imm-addr
402   :prefilter #'read-address
403   :printer #'print-label)
404
405 ;;; Normally, immediate values for an operand size of :qword are of size
406 ;;; :dword and are sign-extended to 64 bits. For an exception, see the
407 ;;; argument type definition following this one.
408 (sb!disassem:define-arg-type signed-imm-data
409   :prefilter (lambda (value dstate)
410                (declare (ignore value)) ; always nil anyway
411                (let ((width (width-bits (inst-operand-size dstate))))
412                  (when (= width 64)
413                    (setf width 32))
414                  (sb!disassem:read-signed-suffix width dstate))))
415
416 ;;; Used by the variant of the MOV instruction with opcode B8 which can
417 ;;; move immediates of all sizes (i.e. including :qword) into a
418 ;;; register.
419 (sb!disassem:define-arg-type signed-imm-data-upto-qword
420   :prefilter (lambda (value dstate)
421                (declare (ignore value)) ; always nil anyway
422                (sb!disassem:read-signed-suffix
423                 (width-bits (inst-operand-size dstate))
424                 dstate)))
425
426 ;;; Used by those instructions that have a default operand size of
427 ;;; :qword. Nevertheless the immediate is at most of size :dword.
428 ;;; The only instruction of this kind having a variant with an immediate
429 ;;; argument is PUSH.
430 (sb!disassem:define-arg-type signed-imm-data-default-qword
431   :prefilter (lambda (value dstate)
432                (declare (ignore value)) ; always nil anyway
433                (let ((width (width-bits
434                              (inst-operand-size-default-qword dstate))))
435                  (when (= width 64)
436                    (setf width 32))
437                  (sb!disassem:read-signed-suffix width dstate))))
438
439 (sb!disassem:define-arg-type signed-imm-byte
440   :prefilter (lambda (value dstate)
441                (declare (ignore value)) ; always nil anyway
442                (sb!disassem:read-signed-suffix 8 dstate)))
443
444 (sb!disassem:define-arg-type imm-byte
445   :prefilter (lambda (value dstate)
446                (declare (ignore value)) ; always nil anyway
447                (sb!disassem:read-suffix 8 dstate)))
448
449 ;;; needed for the ret imm16 instruction
450 (sb!disassem:define-arg-type imm-word-16
451   :prefilter (lambda (value dstate)
452                (declare (ignore value)) ; always nil anyway
453                (sb!disassem:read-suffix 16 dstate)))
454
455 (sb!disassem:define-arg-type reg/mem
456   :prefilter #'prefilter-reg/mem
457   :printer #'print-reg/mem)
458 (sb!disassem:define-arg-type sized-reg/mem
459   ;; Same as reg/mem, but prints an explicit size indicator for
460   ;; memory references.
461   :prefilter #'prefilter-reg/mem
462   :printer #'print-sized-reg/mem)
463
464 ;;; Arguments of type reg/mem with a fixed size.
465 (sb!disassem:define-arg-type sized-byte-reg/mem
466   :prefilter #'prefilter-reg/mem
467   :printer #'print-sized-byte-reg/mem)
468 (sb!disassem:define-arg-type sized-word-reg/mem
469   :prefilter #'prefilter-reg/mem
470   :printer #'print-sized-word-reg/mem)
471 (sb!disassem:define-arg-type sized-dword-reg/mem
472   :prefilter #'prefilter-reg/mem
473   :printer #'print-sized-dword-reg/mem)
474
475 ;;; Same as sized-reg/mem, but with a default operand size of :qword.
476 (sb!disassem:define-arg-type sized-reg/mem-default-qword
477   :prefilter #'prefilter-reg/mem
478   :printer #'print-sized-reg/mem-default-qword)
479
480 ;;; XMM registers
481 (sb!disassem:define-arg-type xmmreg
482   :prefilter #'prefilter-reg-r
483   :printer #'print-xmmreg)
484
485 (sb!disassem:define-arg-type xmmreg-b
486   :prefilter #'prefilter-reg-b
487   :printer #'print-xmmreg)
488
489 (sb!disassem:define-arg-type xmmreg/mem
490   :prefilter #'prefilter-reg/mem
491   :printer #'print-xmmreg/mem)
492
493 (sb!disassem:define-arg-type sized-xmmreg/mem
494   :prefilter #'prefilter-reg/mem
495   :printer #'print-sized-xmmreg/mem)
496
497
498 (eval-when (:compile-toplevel :load-toplevel :execute)
499 (defparameter *conditions*
500   '((:o . 0)
501     (:no . 1)
502     (:b . 2) (:nae . 2) (:c . 2)
503     (:nb . 3) (:ae . 3) (:nc . 3)
504     (:eq . 4) (:e . 4) (:z . 4)
505     (:ne . 5) (:nz . 5)
506     (:be . 6) (:na . 6)
507     (:nbe . 7) (:a . 7)
508     (:s . 8)
509     (:ns . 9)
510     (:p . 10) (:pe . 10)
511     (:np . 11) (:po . 11)
512     (:l . 12) (:nge . 12)
513     (:nl . 13) (:ge . 13)
514     (:le . 14) (:ng . 14)
515     (:nle . 15) (:g . 15)))
516 (defparameter *condition-name-vec*
517   (let ((vec (make-array 16 :initial-element nil)))
518     (dolist (cond *conditions*)
519       (when (null (aref vec (cdr cond)))
520         (setf (aref vec (cdr cond)) (car cond))))
521     vec))
522 ) ; EVAL-WHEN
523
524 ;;; Set assembler parameters. (In CMU CL, this was done with
525 ;;; a call to a macro DEF-ASSEMBLER-PARAMS.)
526 (eval-when (:compile-toplevel :load-toplevel :execute)
527   (setf sb!assem:*assem-scheduler-p* nil))
528
529 (sb!disassem:define-arg-type condition-code
530   :printer *condition-name-vec*)
531
532 (defun conditional-opcode (condition)
533   (cdr (assoc condition *conditions* :test #'eq)))
534 \f
535 ;;;; disassembler instruction formats
536
537 (eval-when (:compile-toplevel :execute)
538   (defun swap-if (direction field1 separator field2)
539     `(:if (,direction :constant 0)
540           (,field1 ,separator ,field2)
541           (,field2 ,separator ,field1))))
542
543 (sb!disassem:define-instruction-format (byte 8 :default-printer '(:name))
544   (op    :field (byte 8 0))
545   ;; optional fields
546   (accum :type 'accum)
547   (imm))
548
549 (sb!disassem:define-instruction-format (two-bytes 16
550                                         :default-printer '(:name))
551   (op :fields (list (byte 8 0) (byte 8 8))))
552
553 (sb!disassem:define-instruction-format (three-bytes 24
554                                         :default-printer '(:name))
555   (op :fields (list (byte 8 0) (byte 8 8) (byte 8 16))))
556
557 ;;; A one-byte instruction with a #x66 prefix, used to indicate an
558 ;;; operand size of :word.
559 (sb!disassem:define-instruction-format (x66-byte 16
560                                         :default-printer '(:name))
561   (x66   :field (byte 8 0) :value #x66)
562   (op    :field (byte 8 8)))
563
564 ;;; A one-byte instruction with a REX prefix, used to indicate an
565 ;;; operand size of :qword. REX.W must be 1, the other three bits are
566 ;;; ignored.
567 (sb!disassem:define-instruction-format (rex-byte 16
568                                         :default-printer '(:name))
569   (rex   :field (byte 5 3) :value #b01001)
570   (op    :field (byte 8 8)))
571
572 (sb!disassem:define-instruction-format (simple 8)
573   (op    :field (byte 7 1))
574   (width :field (byte 1 0) :type 'width)
575   ;; optional fields
576   (accum :type 'accum)
577   (imm))
578
579 (sb!disassem:define-instruction-format (rex-simple 16)
580   (rex     :field (byte 4 4)    :value #b0100)
581   (wrxb    :field (byte 4 0)    :type 'wrxb)
582   (op    :field (byte 7 9))
583   (width :field (byte 1 8) :type 'width)
584   ;; optional fields
585   (accum :type 'accum)
586   (imm))
587
588 ;;; Same as simple, but with direction bit
589 (sb!disassem:define-instruction-format (simple-dir 8 :include 'simple)
590   (op :field (byte 6 2))
591   (dir :field (byte 1 1)))
592
593 ;;; Same as simple, but with the immediate value occurring by default,
594 ;;; and with an appropiate printer.
595 (sb!disassem:define-instruction-format (accum-imm 8
596                                      :include 'simple
597                                      :default-printer '(:name
598                                                         :tab accum ", " imm))
599   (imm :type 'signed-imm-data))
600
601 (sb!disassem:define-instruction-format (rex-accum-imm 16
602                                      :include 'rex-simple
603                                      :default-printer '(:name
604                                                         :tab accum ", " imm))
605   (imm :type 'signed-imm-data))
606
607 (sb!disassem:define-instruction-format (reg-no-width 8
608                                      :default-printer '(:name :tab reg))
609   (op    :field (byte 5 3))
610   (reg   :field (byte 3 0) :type 'reg-b)
611   ;; optional fields
612   (accum :type 'accum)
613   (imm))
614
615 (sb!disassem:define-instruction-format (rex-reg-no-width 16
616                                      :default-printer '(:name :tab reg))
617   (rex     :field (byte 4 4)    :value #b0100)
618   (wrxb    :field (byte 4 0)    :type 'wrxb)
619   (op      :field (byte 5 11))
620   (reg     :field (byte 3 8)    :type 'reg-b)
621   ;; optional fields
622   (accum :type 'accum)
623   (imm))
624
625 ;;; Same as reg-no-width, but with a default operand size of :qword.
626 (sb!disassem:define-instruction-format (reg-no-width-default-qword 8
627                                         :include 'reg-no-width
628                                         :default-printer '(:name :tab reg))
629   (reg   :type 'reg-b-default-qword))
630
631 ;;; Same as rex-reg-no-width, but with a default operand size of :qword.
632 (sb!disassem:define-instruction-format (rex-reg-no-width-default-qword 16
633                                         :include 'rex-reg-no-width
634                                         :default-printer '(:name :tab reg))
635   (reg     :type 'reg-b-default-qword))
636
637 ;;; Adds a width field to reg-no-width. Note that we can't use
638 ;;; :INCLUDE 'REG-NO-WIDTH here to save typing because that would put
639 ;;; the WIDTH field last, but the prefilter for WIDTH must run before
640 ;;; the one for IMM to be able to determine the correct size of IMM.
641 (sb!disassem:define-instruction-format (reg 8
642                                         :default-printer '(:name :tab reg))
643   (op    :field (byte 4 4))
644   (width :field (byte 1 3) :type 'width)
645   (reg   :field (byte 3 0) :type 'reg-b)
646   ;; optional fields
647   (accum :type 'accum)
648   (imm))
649
650 (sb!disassem:define-instruction-format (rex-reg 16
651                                         :default-printer '(:name :tab reg))
652   (rex     :field (byte 4 4)    :value #b0100)
653   (wrxb    :field (byte 4 0)    :type 'wrxb)
654   (width   :field (byte 1 11)   :type 'width)
655   (op      :field (byte 4 12))
656   (reg     :field (byte 3 8)    :type 'reg-b)
657   ;; optional fields
658   (accum   :type 'accum)
659   (imm))
660
661 (sb!disassem:define-instruction-format (two-bytes 16
662                                         :default-printer '(:name))
663   (op :fields (list (byte 8 0) (byte 8 8))))
664
665 (sb!disassem:define-instruction-format (reg-reg/mem 16
666                                         :default-printer
667                                         `(:name :tab reg ", " reg/mem))
668   (op      :field (byte 7 1))
669   (width   :field (byte 1 0)    :type 'width)
670   (reg/mem :fields (list (byte 2 14) (byte 3 8))
671                                 :type 'reg/mem)
672   (reg     :field (byte 3 11)   :type 'reg)
673   ;; optional fields
674   (imm))
675
676 (sb!disassem:define-instruction-format (rex-reg-reg/mem 24
677                                         :default-printer
678                                         `(:name :tab reg ", " reg/mem))
679   (rex     :field (byte 4 4)    :value #b0100)
680   (wrxb    :field (byte 4 0)    :type 'wrxb)
681   (width   :field (byte 1 8)    :type 'width)
682   (op      :field (byte 7 9))
683   (reg/mem :fields (list (byte 2 22) (byte 3 16))
684                                 :type 'reg/mem)
685   (reg     :field (byte 3 19)   :type 'reg)
686   ;; optional fields
687   (imm))
688
689 ;;; same as reg-reg/mem, but with direction bit
690 (sb!disassem:define-instruction-format (reg-reg/mem-dir 16
691                                         :include 'reg-reg/mem
692                                         :default-printer
693                                         `(:name
694                                           :tab
695                                           ,(swap-if 'dir 'reg/mem ", " 'reg)))
696   (op  :field (byte 6 2))
697   (dir :field (byte 1 1)))
698
699 (sb!disassem:define-instruction-format (rex-reg-reg/mem-dir 24
700                                         :include 'rex-reg-reg/mem
701                                         :default-printer
702                                         `(:name
703                                           :tab
704                                           ,(swap-if 'dir 'reg/mem ", " 'reg)))
705   (op  :field (byte 6 10))
706   (dir :field (byte 1 9)))
707
708 (sb!disassem:define-instruction-format (x66-reg-reg/mem-dir 24
709                                         :default-printer
710                                         `(:name
711                                           :tab
712                                           ,(swap-if 'dir 'reg/mem ", " 'reg)))
713   (x66     :field (byte 8 0)    :type 'x66 :value #x66)
714   (op      :field (byte 6 10))
715   (dir     :field (byte 1 9))
716   (width   :field (byte 1 8)    :type 'width)
717   (reg/mem :fields (list (byte 2 22) (byte 3 16))
718                                 :type 'reg/mem)
719   (reg     :field (byte 3 19)   :type 'reg))
720
721 (sb!disassem:define-instruction-format (x66-rex-reg-reg/mem-dir 32
722                                         :default-printer
723                                         `(:name
724                                           :tab
725                                           ,(swap-if 'dir 'reg/mem ", " 'reg)))
726   (x66     :field (byte 8 0)    :type 'x66 :value #x66)
727   (rex     :field (byte 4 12)   :value #b0100)
728   (wrxb    :field (byte 4 8)    :type 'wrxb)
729   (op      :field (byte 6 18))
730   (dir     :field (byte 1 17))
731   (width   :field (byte 1 16)   :type 'width)
732   (reg/mem :fields (list (byte 2 30) (byte 3 24))
733                                 :type 'reg/mem)
734   (reg     :field (byte 3 27)   :type 'reg))
735
736 ;;; Same as reg-reg/mem, but uses the reg field as a second op code.
737 (sb!disassem:define-instruction-format (reg/mem 16
738                                         :default-printer '(:name :tab reg/mem))
739   (op      :fields (list (byte 7 1) (byte 3 11)))
740   (width   :field (byte 1 0)    :type 'width)
741   (reg/mem :fields (list (byte 2 14) (byte 3 8))
742                                 :type 'sized-reg/mem)
743   ;; optional fields
744   (imm))
745
746 (sb!disassem:define-instruction-format (rex-reg/mem 24
747                                         :default-printer '(:name :tab reg/mem))
748   (rex     :field (byte 4 4)    :value #b0100)
749   (wrxb    :field (byte 4 0)    :type 'wrxb)
750   (op      :fields (list (byte 7 9) (byte 3 19)))
751   (width   :field (byte 1 8)    :type 'width)
752   (reg/mem :fields (list (byte 2 22) (byte 3 16))
753                                 :type 'sized-reg/mem)
754   ;; optional fields
755   (imm))
756
757 ;;; Same as reg/mem, but without a width field and with a default
758 ;;; operand size of :qword.
759 (sb!disassem:define-instruction-format (reg/mem-default-qword 16
760                                         :default-printer '(:name :tab reg/mem))
761   (op      :fields (list (byte 8 0) (byte 3 11)))
762   (reg/mem :fields (list (byte 2 14) (byte 3 8))
763                                 :type 'sized-reg/mem-default-qword))
764
765 (sb!disassem:define-instruction-format (rex-reg/mem-default-qword 24
766                                         :default-printer '(:name :tab reg/mem))
767   (rex     :field (byte 4 4)    :value #b0100)
768   (wrxb    :field (byte 4 0)    :type 'wrxb)
769   (op      :fields (list (byte 8 8) (byte 3 19)))
770   (reg/mem :fields (list (byte 2 22) (byte 3 16))
771                                 :type 'sized-reg/mem-default-qword))
772
773 ;;; Same as reg/mem, but with the immediate value occurring by default,
774 ;;; and with an appropiate printer.
775 (sb!disassem:define-instruction-format (reg/mem-imm 16
776                                         :include 'reg/mem
777                                         :default-printer
778                                         '(:name :tab reg/mem ", " imm))
779   (reg/mem :type 'sized-reg/mem)
780   (imm     :type 'signed-imm-data))
781
782 (sb!disassem:define-instruction-format (rex-reg/mem-imm 24
783                                         :include 'rex-reg/mem
784                                         :default-printer
785                                         '(:name :tab reg/mem ", " imm))
786   (reg/mem :type 'sized-reg/mem)
787   (imm     :type 'signed-imm-data))
788
789 ;;; Same as reg/mem, but with using the accumulator in the default printer
790 (sb!disassem:define-instruction-format
791     (accum-reg/mem 16
792      :include 'reg/mem :default-printer '(:name :tab accum ", " reg/mem))
793   (reg/mem :type 'reg/mem)              ; don't need a size
794   (accum :type 'accum))
795
796 (sb!disassem:define-instruction-format (rex-accum-reg/mem 24
797                                         :include 'rex-reg/mem
798                                         :default-printer
799                                         '(:name :tab accum ", " reg/mem))
800   (reg/mem :type 'reg/mem)              ; don't need a size
801   (accum   :type 'accum))
802
803 ;;; Same as reg-reg/mem, but with a prefix of #b00001111
804 (sb!disassem:define-instruction-format (ext-reg-reg/mem 24
805                                         :default-printer
806                                         `(:name :tab reg ", " reg/mem))
807   (prefix  :field (byte 8 0)    :value #b00001111)
808   (op      :field (byte 7 9))
809   (width   :field (byte 1 8)    :type 'width)
810   (reg/mem :fields (list (byte 2 22) (byte 3 16))
811                                 :type 'reg/mem)
812   (reg     :field (byte 3 19)   :type 'reg)
813   ;; optional fields
814   (imm))
815
816 (sb!disassem:define-instruction-format (ext-reg-reg/mem-no-width 24
817                                         :default-printer
818                                         `(:name :tab reg ", " reg/mem))
819   (prefix  :field (byte 8 0)    :value #b00001111)
820   (op      :field (byte 8 8))
821   (reg/mem :fields (list (byte 2 22) (byte 3 16))
822                                 :type 'reg/mem)
823   (reg     :field (byte 3 19)   :type 'reg))
824
825 (sb!disassem:define-instruction-format (rex-ext-reg-reg/mem-no-width 32
826                                         :default-printer
827                                         `(:name :tab reg ", " reg/mem))
828   (rex     :field (byte 4 4)    :value #b0100)
829   (wrxb    :field (byte 4 0)    :type 'wrxb)
830   (prefix  :field (byte 8 8)    :value #b00001111)
831   (op      :field (byte 8 16))
832   (reg/mem :fields (list (byte 2 30) (byte 3 24))
833                                 :type 'reg/mem)
834   (reg     :field (byte 3 27)   :type 'reg))
835
836 (sb!disassem:define-instruction-format (ext-reg/mem-no-width 24
837                                         :default-printer
838                                         `(:name :tab reg/mem))
839   (prefix  :field (byte 8 0)    :value #b00001111)
840   (op      :fields (list (byte 8 8) (byte 3 19)))
841   (reg/mem :fields (list (byte 2 22) (byte 3 16))
842                                 :type 'reg/mem))
843
844 (sb!disassem:define-instruction-format (rex-ext-reg/mem-no-width 32
845                                         :default-printer
846                                         `(:name :tab reg/mem))
847   (rex     :field (byte 4 4)    :value #b0100)
848   (wrxb    :field (byte 4 0)    :type 'wrxb)
849   (prefix  :field (byte 8 8)    :value #b00001111)
850   (op      :fields (list (byte 8 16) (byte 3 27)))
851   (reg/mem :fields (list (byte 2 30) (byte 3 24))
852                                 :type 'reg/mem))
853
854 ;;; reg-no-width with #x0f prefix
855 (sb!disassem:define-instruction-format (ext-reg-no-width 16
856                                         :default-printer '(:name :tab reg))
857   (prefix  :field (byte 8 0)    :value #b00001111)
858   (op    :field (byte 5 11))
859   (reg   :field (byte 3 8) :type 'reg-b))
860
861 ;;; Same as reg/mem, but with a prefix of #b00001111
862 (sb!disassem:define-instruction-format (ext-reg/mem 24
863                                         :default-printer '(:name :tab reg/mem))
864   (prefix  :field (byte 8 0)    :value #b00001111)
865   (op      :fields (list (byte 7 9) (byte 3 19)))
866   (width   :field (byte 1 8)    :type 'width)
867   (reg/mem :fields (list (byte 2 22) (byte 3 16))
868                                 :type 'sized-reg/mem)
869   ;; optional fields
870   (imm))
871
872 (sb!disassem:define-instruction-format (ext-reg/mem-imm 24
873                                         :include 'ext-reg/mem
874                                         :default-printer
875                                         '(:name :tab reg/mem ", " imm))
876   (imm :type 'signed-imm-data))
877 \f
878 ;;;; XMM instructions
879
880 ;;; All XMM instructions use an extended opcode (#x0F as the first
881 ;;; opcode byte). Therefore in the following "EXT" in the name of the
882 ;;; instruction formats refers to the formats that have an additional
883 ;;; prefix (#x66, #xF2 or #xF3).
884
885 ;;; Instructions having an XMM register as the destination operand
886 ;;; and an XMM register or a memory location as the source operand.
887 ;;; The size of the operands is implicitly given by the instruction.
888 (sb!disassem:define-instruction-format (xmm-xmm/mem 24
889                                         :default-printer
890                                         '(:name :tab reg ", " reg/mem))
891   (x0f     :field (byte 8 0)    :value #x0f)
892   (op      :field (byte 8 8))
893   (reg/mem :fields (list (byte 2 22) (byte 3 16))
894                                 :type 'xmmreg/mem)
895   (reg     :field (byte 3 19)   :type 'xmmreg))
896
897 (sb!disassem:define-instruction-format (rex-xmm-xmm/mem 32
898                                         :default-printer
899                                         '(:name :tab reg ", " reg/mem))
900   (rex     :field (byte 4 4)    :value #b0100)
901   (wrxb    :field (byte 4 0)    :type 'wrxb)
902   (x0f     :field (byte 8 8)    :value #x0f)
903   (op      :field (byte 8 16))
904   (reg/mem :fields (list (byte 2 30) (byte 3 24))
905                                 :type 'xmmreg/mem)
906   (reg     :field (byte 3 27)   :type 'xmmreg))
907
908 (sb!disassem:define-instruction-format (ext-xmm-xmm/mem 32
909                                         :default-printer
910                                         '(:name :tab reg ", " reg/mem))
911   (prefix  :field (byte 8 0))
912   (x0f     :field (byte 8 8)    :value #x0f)
913   (op      :field (byte 8 16))
914   (reg/mem :fields (list (byte 2 30) (byte 3 24))
915                                 :type 'xmmreg/mem)
916   (reg     :field (byte 3 27)   :type 'xmmreg))
917
918 (sb!disassem:define-instruction-format (ext-rex-xmm-xmm/mem 40
919                                         :default-printer
920                                         '(:name :tab reg ", " reg/mem))
921   (prefix  :field (byte 8 0))
922   (rex     :field (byte 4 12)   :value #b0100)
923   (wrxb    :field (byte 4 8)    :type 'wrxb)
924   (x0f     :field (byte 8 16)   :value #x0f)
925   (op      :field (byte 8 24))
926   (reg/mem :fields (list (byte 2 38) (byte 3 32))
927                                 :type 'xmmreg/mem)
928   (reg     :field (byte 3 35)   :type 'xmmreg))
929
930 ;;; Same as xmm-xmm/mem etc., but with direction bit.
931
932 (sb!disassem:define-instruction-format (ext-xmm-xmm/mem-dir 32
933                                         :include 'ext-xmm-xmm/mem
934                                         :default-printer
935                                         `(:name
936                                           :tab
937                                           ,(swap-if 'dir 'reg ", " 'reg/mem)))
938   (op      :field (byte 7 17))
939   (dir     :field (byte 1 16)))
940
941 (sb!disassem:define-instruction-format (ext-rex-xmm-xmm/mem-dir 40
942                                         :include 'ext-rex-xmm-xmm/mem
943                                         :default-printer
944                                         `(:name
945                                           :tab
946                                           ,(swap-if 'dir 'reg ", " 'reg/mem)))
947   (op      :field (byte 7 25))
948   (dir     :field (byte 1 24)))
949
950 ;;; Instructions having an XMM register as one operand
951 ;;; and a constant (unsigned) byte as the other.
952
953 (sb!disassem:define-instruction-format (ext-xmm-imm 32
954                                         :default-printer
955                                         '(:name :tab reg/mem ", " imm))
956   (prefix  :field (byte 8 0))
957   (x0f     :field (byte 8 8)   :value #x0f)
958   (op      :field (byte 8 16))
959   (/i      :field (byte 3 27))
960   (b11     :field (byte 2 30) :value #b11)
961   (reg/mem :field (byte 3 24)
962            :type 'xmmreg-b)
963   (imm     :type 'imm-byte))
964
965 (sb!disassem:define-instruction-format (ext-rex-xmm-imm 40
966                                         :default-printer
967                                         '(:name :tab reg/mem ", " imm))
968   (prefix  :field (byte 8 0))
969   (rex     :field (byte 4 12)   :value #b0100)
970   (wrxb    :field (byte 4 8)    :type 'wrxb)
971   (x0f     :field (byte 8 16)   :value #x0f)
972   (op      :field (byte 8 24))
973   (/i      :field (byte 3 35))
974   (b11     :field (byte 2 38) :value #b11)
975   (reg/mem :field (byte 3 32)
976            :type 'xmmreg-b)
977   (imm     :type 'imm-byte))
978
979 ;;; Instructions having an XMM register as one operand and a general-
980 ;;; -purpose register or a memory location as the other operand.
981
982 (sb!disassem:define-instruction-format (xmm-reg/mem 24
983                                         :default-printer
984                                         '(:name :tab reg ", " reg/mem))
985   (x0f     :field (byte 8 0)    :value #x0f)
986   (op      :field (byte 8 8))
987   (reg/mem :fields (list (byte 2 22) (byte 3 16))
988            :type 'sized-reg/mem)
989   (reg     :field (byte 3 19)   :type 'xmmreg))
990
991 (sb!disassem:define-instruction-format (rex-xmm-reg/mem 32
992                                         :default-printer
993                                         '(:name :tab reg ", " reg/mem))
994   (rex     :field (byte 4 4)   :value #b0100)
995   (wrxb    :field (byte 4 0)    :type 'wrxb)
996   (x0f     :field (byte 8 8)   :value #x0f)
997   (op      :field (byte 8 16))
998   (reg/mem :fields (list (byte 2 30) (byte 3 24))
999                                 :type 'sized-reg/mem)
1000   (reg     :field (byte 3 27)   :type 'xmmreg))
1001
1002 (sb!disassem:define-instruction-format (ext-xmm-reg/mem 32
1003                                         :default-printer
1004                                         '(:name :tab reg ", " reg/mem))
1005   (prefix  :field (byte 8 0))
1006   (x0f     :field (byte 8 8)    :value #x0f)
1007   (op      :field (byte 8 16))
1008   (reg/mem :fields (list (byte 2 30) (byte 3 24))
1009                                 :type 'sized-reg/mem)
1010   (reg     :field (byte 3 27)   :type 'xmmreg))
1011
1012 (sb!disassem:define-instruction-format (ext-rex-xmm-reg/mem 40
1013                                         :default-printer
1014                                         '(:name :tab reg ", " reg/mem))
1015   (prefix  :field (byte 8 0))
1016   (rex     :field (byte 4 12)   :value #b0100)
1017   (wrxb    :field (byte 4 8)    :type 'wrxb)
1018   (x0f     :field (byte 8 16)   :value #x0f)
1019   (op      :field (byte 8 24))
1020   (reg/mem :fields (list (byte 2 38) (byte 3 32))
1021                                 :type 'sized-reg/mem)
1022   (reg     :field (byte 3 35)   :type 'xmmreg))
1023
1024 ;;; Instructions having a general-purpose register as one operand and an
1025 ;;; XMM register or a memory location as the other operand.
1026
1027 (sb!disassem:define-instruction-format (reg-xmm/mem 24
1028                                         :default-printer
1029                                         '(:name :tab reg ", " reg/mem))
1030   (x0f     :field (byte 8 0)    :value #x0f)
1031   (op      :field (byte 8 8))
1032   (reg/mem :fields (list (byte 2 22) (byte 3 16))
1033                                 :type 'sized-xmmreg/mem)
1034   (reg     :field (byte 3 19)   :type 'reg))
1035
1036 (sb!disassem:define-instruction-format (rex-reg-xmm/mem 32
1037                                         :default-printer
1038                                         '(:name :tab reg ", " reg/mem))
1039   (rex     :field (byte 4 4)   :value #b0100)
1040   (wrxb    :field (byte 4 0)    :type 'wrxb)
1041   (x0f     :field (byte 8 8)   :value #x0f)
1042   (op      :field (byte 8 16))
1043   (reg/mem :fields (list (byte 2 30) (byte 3 24))
1044                                 :type 'sized-xmmreg/mem)
1045   (reg     :field (byte 3 27)   :type 'reg))
1046
1047 (sb!disassem:define-instruction-format (ext-reg-xmm/mem 32
1048                                         :default-printer
1049                                         '(:name :tab reg ", " reg/mem))
1050   (prefix  :field (byte 8 0))
1051   (x0f     :field (byte 8 8)    :value #x0f)
1052   (op      :field (byte 8 16))
1053   (reg/mem :fields (list (byte 2 30) (byte 3 24))
1054                                 :type 'sized-xmmreg/mem)
1055   (reg     :field (byte 3 27)   :type 'reg))
1056
1057 (sb!disassem:define-instruction-format (ext-rex-reg-xmm/mem 40
1058                                         :default-printer
1059                                         '(:name :tab reg ", " reg/mem))
1060   (prefix  :field (byte 8 0))
1061   (rex     :field (byte 4 12)   :value #b0100)
1062   (wrxb    :field (byte 4 8)    :type 'wrxb)
1063   (x0f     :field (byte 8 16)   :value #x0f)
1064   (op      :field (byte 8 24))
1065   (reg/mem :fields (list (byte 2 38) (byte 3 32))
1066                                 :type 'sized-xmmreg/mem)
1067   (reg     :field (byte 3 35)   :type 'reg))
1068
1069 ;; XMM comparison instruction
1070
1071 (eval-when (:compile-toplevel :load-toplevel :execute)
1072   (defparameter *sse-conditions* #(:eq :lt :le :unord :neq :nlt :nle :ord)))
1073
1074 (sb!disassem:define-arg-type sse-condition-code
1075   :printer *sse-conditions*)
1076
1077 (sb!disassem:define-instruction-format (xmm-xmm/mem-cmp 32
1078                                         :default-printer
1079                                         '(:name " " cc :tab reg ", " reg/mem))
1080   (x0f     :field (byte 8 0)    :value #x0f)
1081   (op      :field (byte 8 8))
1082   (reg/mem :fields (list (byte 2 22) (byte 3 16))
1083                                 :type 'xmmreg/mem)
1084   (reg     :field (byte 3 19)   :type 'xmmreg)
1085   (cc      :field (byte 8 24)   :type 'sse-condition-code))
1086
1087 (sb!disassem:define-instruction-format (rex-xmm-xmm/mem-cmp 40
1088                                         :default-printer
1089                                         '(:name " " cc :tab reg ", " reg/mem))
1090   (rex     :field (byte 4 4)   :value #b0100)
1091   (wrxb    :field (byte 4 0)    :type 'wrxb)
1092   (x0f     :field (byte 8 8)    :value #x0f)
1093   (op      :field (byte 8 16))
1094   (reg/mem :fields (list (byte 2 30) (byte 3 24))
1095                                 :type 'xmmreg/mem)
1096   (reg     :field (byte 3 27)   :type 'xmmreg)
1097   (cc      :field (byte 8 32)   :type 'sse-condition-code))
1098
1099 (sb!disassem:define-instruction-format (ext-xmm-xmm/mem-cmp 40
1100                                         :default-printer
1101                                         '(:name " " cc :tab reg ", " reg/mem))
1102   (prefix  :field (byte 8 0))
1103   (x0f     :field (byte 8 8)    :value #x0f)
1104   (op      :field (byte 8 16))
1105   (reg/mem :fields (list (byte 2 30) (byte 3 24))
1106                                 :type 'xmmreg/mem)
1107   (reg     :field (byte 3 27)   :type 'xmmreg)
1108   (cc      :field (byte 8 32)   :type 'sse-condition-code))
1109
1110 (sb!disassem:define-instruction-format (ext-rex-xmm-xmm/mem-cmp 48
1111                                         :default-printer
1112                                         '(:name " " cc :tab reg ", " reg/mem))
1113   (prefix  :field (byte 8 0))
1114   (rex     :field (byte 4 12)   :value #b0100)
1115   (wrxb    :field (byte 4 8)    :type 'wrxb)
1116   (x0f     :field (byte 8 16)   :value #x0f)
1117   (op      :field (byte 8 24))
1118   (reg/mem :fields (list (byte 2 38) (byte 3 32))
1119                                 :type 'xmmreg/mem)
1120   (reg     :field (byte 3 35)   :type 'xmmreg)
1121   (cc      :field (byte 8 40)   :type 'sse-condition-code))
1122
1123 ;;; XMM instructions with 8 bit immediate data
1124
1125 (sb!disassem:define-instruction-format (xmm-xmm/mem-imm 24
1126                                         :default-printer
1127                                         '(:name :tab reg ", " reg/mem " " imm))
1128   (x0f     :field (byte 8 0)    :value #x0f)
1129   (op      :field (byte 8 8))
1130   (reg/mem :fields (list (byte 2 22) (byte 3 16))
1131                                 :type 'xmmreg/mem)
1132   (reg     :field (byte 3 19)   :type 'xmmreg)
1133   (imm     :type 'imm-byte))
1134
1135 (sb!disassem:define-instruction-format (rex-xmm-xmm/mem-imm 32
1136                                         :default-printer
1137                                         '(:name :tab reg ", " reg/mem " " imm))
1138   (rex     :field (byte 4 4)    :value #b0100)
1139   (wrxb    :field (byte 4 0)    :type 'wrxb)
1140   (x0f     :field (byte 8 8)    :value #x0f)
1141   (op      :field (byte 8 16))
1142   (reg/mem :fields (list (byte 2 30) (byte 3 24))
1143                                 :type 'xmmreg/mem)
1144   (reg     :field (byte 3 27)   :type 'xmmreg)
1145   (imm     :type 'imm-byte))
1146
1147 (sb!disassem:define-instruction-format (ext-xmm-xmm/mem-imm 32
1148                                         :default-printer
1149                                         '(:name :tab reg ", " reg/mem " " imm))
1150   (prefix  :field (byte 8 0))
1151   (x0f     :field (byte 8 8)    :value #x0f)
1152   (op      :field (byte 8 16))
1153   (reg/mem :fields (list (byte 2 30) (byte 3 24))
1154                                 :type 'xmmreg/mem)
1155   (reg     :field (byte 3 27)   :type 'xmmreg)
1156   (imm     :type 'imm-byte))
1157
1158 (sb!disassem:define-instruction-format (ext-rex-xmm-xmm/mem-imm 40
1159                                         :default-printer
1160                                         '(:name :tab reg ", " reg/mem " " imm))
1161   (prefix  :field (byte 8 0))
1162   (rex     :field (byte 4 12)   :value #b0100)
1163   (wrxb    :field (byte 4 8)    :type 'wrxb)
1164   (x0f     :field (byte 8 16)   :value #x0f)
1165   (op      :field (byte 8 24))
1166   (reg/mem :fields (list (byte 2 38) (byte 3 32))
1167                                 :type 'xmmreg/mem)
1168   (reg     :field (byte 3 35)   :type 'xmmreg)
1169   (imm     :type 'imm-byte))
1170
1171 (sb!disassem:define-instruction-format (string-op 8
1172                                      :include 'simple
1173                                      :default-printer '(:name width)))
1174
1175 (sb!disassem:define-instruction-format (rex-string-op 16
1176                                      :include 'rex-simple
1177                                      :default-printer '(:name width)))
1178
1179 (sb!disassem:define-instruction-format (short-cond-jump 16)
1180   (op    :field (byte 4 4))
1181   (cc    :field (byte 4 0) :type 'condition-code)
1182   (label :field (byte 8 8) :type 'displacement))
1183
1184 (sb!disassem:define-instruction-format (short-jump 16
1185                                      :default-printer '(:name :tab label))
1186   (const :field (byte 4 4) :value #b1110)
1187   (op    :field (byte 4 0))
1188   (label :field (byte 8 8) :type 'displacement))
1189
1190 (sb!disassem:define-instruction-format (near-cond-jump 16)
1191   (op    :fields (list (byte 8 0) (byte 4 12)) :value '(#b00001111 #b1000))
1192   (cc    :field (byte 4 8) :type 'condition-code)
1193   ;; The disassembler currently doesn't let you have an instruction > 32 bits
1194   ;; long, so we fake it by using a prefilter to read the offset.
1195   (label :type 'displacement
1196          :prefilter (lambda (value dstate)
1197                       (declare (ignore value)) ; always nil anyway
1198                       (sb!disassem:read-signed-suffix 32 dstate))))
1199
1200 (sb!disassem:define-instruction-format (near-jump 8
1201                                      :default-printer '(:name :tab label))
1202   (op    :field (byte 8 0))
1203   ;; The disassembler currently doesn't let you have an instruction > 32 bits
1204   ;; long, so we fake it by using a prefilter to read the address.
1205   (label :type 'displacement
1206          :prefilter (lambda (value dstate)
1207                       (declare (ignore value)) ; always nil anyway
1208                       (sb!disassem:read-signed-suffix 32 dstate))))
1209
1210
1211 (sb!disassem:define-instruction-format (cond-set 24
1212                                      :default-printer '('set cc :tab reg/mem))
1213   (prefix :field (byte 8 0) :value #b00001111)
1214   (op    :field (byte 4 12) :value #b1001)
1215   (cc    :field (byte 4 8) :type 'condition-code)
1216   (reg/mem :fields (list (byte 2 22) (byte 3 16))
1217            :type 'sized-byte-reg/mem)
1218   (reg     :field (byte 3 19)   :value #b000))
1219
1220 (sb!disassem:define-instruction-format (cond-move 24
1221                                      :default-printer
1222                                         '('cmov cc :tab reg ", " reg/mem))
1223   (prefix  :field (byte 8 0)    :value #b00001111)
1224   (op      :field (byte 4 12)   :value #b0100)
1225   (cc      :field (byte 4 8)    :type 'condition-code)
1226   (reg/mem :fields (list (byte 2 22) (byte 3 16))
1227                                 :type 'reg/mem)
1228   (reg     :field (byte 3 19)   :type 'reg))
1229
1230 (sb!disassem:define-instruction-format (rex-cond-move 32
1231                                      :default-printer
1232                                         '('cmov cc :tab reg ", " reg/mem))
1233   (rex     :field (byte 4 4)   :value #b0100)
1234   (wrxb    :field (byte 4 0)    :type 'wrxb)
1235   (prefix  :field (byte 8 8)    :value #b00001111)
1236   (op      :field (byte 4 20)   :value #b0100)
1237   (cc      :field (byte 4 16)    :type 'condition-code)
1238   (reg/mem :fields (list (byte 2 30) (byte 3 24))
1239                                 :type 'reg/mem)
1240   (reg     :field (byte 3 27)   :type 'reg))
1241
1242 (sb!disassem:define-instruction-format (enter-format 32
1243                                      :default-printer '(:name
1244                                                         :tab disp
1245                                                         (:unless (:constant 0)
1246                                                           ", " level)))
1247   (op :field (byte 8 0))
1248   (disp :field (byte 16 8))
1249   (level :field (byte 8 24)))
1250
1251 ;;; Single byte instruction with an immediate byte argument.
1252 (sb!disassem:define-instruction-format (byte-imm 16
1253                                      :default-printer '(:name :tab code))
1254  (op :field (byte 8 0))
1255  (code :field (byte 8 8)))
1256
1257 ;;; Two byte instruction with an immediate byte argument.
1258 ;;;
1259 (sb!disassem:define-instruction-format (word-imm 24
1260                                      :default-printer '(:name :tab code))
1261   (op :field (byte 16 0))
1262   (code :field (byte 8 16)))
1263
1264 \f
1265 ;;;; primitive emitters
1266
1267 (define-bitfield-emitter emit-word 16
1268   (byte 16 0))
1269
1270 (define-bitfield-emitter emit-dword 32
1271   (byte 32 0))
1272
1273 ;;; Most uses of dwords are as displacements or as immediate values in
1274 ;;; 64-bit operations. In these cases they are sign-extended to 64 bits.
1275 ;;; EMIT-DWORD is unsuitable there because it accepts values of type
1276 ;;; (OR (SIGNED-BYTE 32) (UNSIGNED-BYTE 32)), so we provide a more
1277 ;;; restricted emitter here.
1278 (defun emit-signed-dword (segment value)
1279   (declare (type segment segment)
1280            (type (signed-byte 32) value))
1281   (declare (inline emit-dword))
1282   (emit-dword segment value))
1283
1284 (define-bitfield-emitter emit-qword 64
1285   (byte 64 0))
1286
1287 (define-bitfield-emitter emit-byte-with-reg 8
1288   (byte 5 3) (byte 3 0))
1289
1290 (define-bitfield-emitter emit-mod-reg-r/m-byte 8
1291   (byte 2 6) (byte 3 3) (byte 3 0))
1292
1293 (define-bitfield-emitter emit-sib-byte 8
1294   (byte 2 6) (byte 3 3) (byte 3 0))
1295
1296 (define-bitfield-emitter emit-rex-byte 8
1297   (byte 4 4) (byte 1 3) (byte 1 2) (byte 1 1) (byte 1 0))
1298
1299
1300 \f
1301 ;;;; fixup emitters
1302
1303 (defun emit-absolute-fixup (segment fixup &optional quad-p)
1304   (note-fixup segment (if quad-p :absolute64 :absolute) fixup)
1305   (let ((offset (fixup-offset fixup)))
1306     (if (label-p offset)
1307         (emit-back-patch segment
1308                          (if quad-p 8 4)
1309                          (lambda (segment posn)
1310                            (declare (ignore posn))
1311                            (let ((val  (- (+ (component-header-length)
1312                                              (or (label-position offset)
1313                                                  0))
1314                                           other-pointer-lowtag)))
1315                              (if quad-p
1316                                  (emit-qword segment val)
1317                                  (emit-signed-dword segment val)))))
1318         (if quad-p
1319             (emit-qword segment (or offset 0))
1320             (emit-signed-dword segment (or offset 0))))))
1321
1322 (defun emit-relative-fixup (segment fixup)
1323   (note-fixup segment :relative fixup)
1324   (emit-signed-dword segment (or (fixup-offset fixup) 0)))
1325
1326 \f
1327 ;;;; the effective-address (ea) structure
1328
1329 (defun reg-tn-encoding (tn)
1330   (declare (type tn tn))
1331   ;; ea only has space for three bits of register number: regs r8
1332   ;; and up are selected by a REX prefix byte which caller is responsible
1333   ;; for having emitted where necessary already
1334   (ecase (sb-name (sc-sb (tn-sc tn)))
1335     (registers
1336      (let ((offset (mod (tn-offset tn) 16)))
1337        (logior (ash (logand offset 1) 2)
1338                (ash offset -1))))
1339     (float-registers
1340      (mod (tn-offset tn) 8))))
1341
1342 (defstruct (ea (:constructor make-ea (size &key base index scale disp))
1343                (:copier nil))
1344   ;; note that we can represent an EA with a QWORD size, but EMIT-EA
1345   ;; can't actually emit it on its own: caller also needs to emit REX
1346   ;; prefix
1347   (size nil :type (member :byte :word :dword :qword))
1348   (base nil :type (or tn null))
1349   (index nil :type (or tn null))
1350   (scale 1 :type (member 1 2 4 8))
1351   (disp 0 :type (or (unsigned-byte 32) (signed-byte 32) fixup)))
1352 (def!method print-object ((ea ea) stream)
1353   (cond ((or *print-escape* *print-readably*)
1354          (print-unreadable-object (ea stream :type t)
1355            (format stream
1356                    "~S~@[ base=~S~]~@[ index=~S~]~@[ scale=~S~]~@[ disp=~S~]"
1357                    (ea-size ea)
1358                    (ea-base ea)
1359                    (ea-index ea)
1360                    (let ((scale (ea-scale ea)))
1361                      (if (= scale 1) nil scale))
1362                    (ea-disp ea))))
1363         (t
1364          (format stream "~A PTR [" (symbol-name (ea-size ea)))
1365          (when (ea-base ea)
1366            (write-string (sb!c::location-print-name (ea-base ea)) stream)
1367            (when (ea-index ea)
1368              (write-string "+" stream)))
1369          (when (ea-index ea)
1370            (write-string (sb!c::location-print-name (ea-index ea)) stream))
1371          (unless (= (ea-scale ea) 1)
1372            (format stream "*~A" (ea-scale ea)))
1373          (typecase (ea-disp ea)
1374            (null)
1375            (integer
1376             (format stream "~@D" (ea-disp ea)))
1377            (t
1378             (format stream "+~A" (ea-disp ea))))
1379          (write-char #\] stream))))
1380
1381 (defun emit-constant-tn-rip (segment constant-tn reg)
1382   ;; AMD64 doesn't currently have a code object register to use as a
1383   ;; base register for constant access. Instead we use RIP-relative
1384   ;; addressing. The offset from the SIMPLE-FUN-HEADER to the instruction
1385   ;; is passed to the backpatch callback. In addition we need the offset
1386   ;; from the start of the function header to the slot in the CODE-HEADER
1387   ;; that stores the constant. Since we don't know where the code header
1388   ;; starts, instead count backwards from the function header.
1389   (let* ((2comp (component-info *component-being-compiled*))
1390          (constants (ir2-component-constants 2comp))
1391          (len (length constants))
1392          ;; Both CODE-HEADER and SIMPLE-FUN-HEADER are 16-byte aligned.
1393          ;; If there are an even amount of constants, there will be
1394          ;; an extra qword of padding before the function header, which
1395          ;; needs to be adjusted for. XXX: This will break if new slots
1396          ;; are added to the code header.
1397          (offset (* (- (+ len (if (evenp len)
1398                                   1
1399                                   2))
1400                        (tn-offset constant-tn))
1401                     n-word-bytes)))
1402     ;; RIP-relative addressing
1403     (emit-mod-reg-r/m-byte segment #b00 reg #b101)
1404     (emit-back-patch segment
1405                      4
1406                      (lambda (segment posn)
1407                        ;; The addressing is relative to end of instruction,
1408                        ;; i.e. the end of this dword. Hence the + 4.
1409                        (emit-signed-dword segment
1410                                           (+ 4 (- (+ offset posn)))))))
1411   (values))
1412
1413 (defun emit-label-rip (segment fixup reg)
1414   (let ((label (fixup-offset fixup)))
1415     ;; RIP-relative addressing
1416     (emit-mod-reg-r/m-byte segment #b00 reg #b101)
1417     (emit-back-patch segment
1418                      4
1419                      (lambda (segment posn)
1420                        (emit-signed-dword segment (- (label-position label)
1421                                                      (+ posn 4))))))
1422   (values))
1423
1424 (defun emit-ea (segment thing reg &optional allow-constants)
1425   (etypecase thing
1426     (tn
1427      ;; this would be eleganter if we had a function that would create
1428      ;; an ea given a tn
1429      (ecase (sb-name (sc-sb (tn-sc thing)))
1430        ((registers float-registers)
1431         (emit-mod-reg-r/m-byte segment #b11 reg (reg-tn-encoding thing)))
1432        (stack
1433         ;; Convert stack tns into an index off RBP.
1434         (let ((disp (frame-byte-offset (tn-offset thing))))
1435           (cond ((<= -128 disp 127)
1436                  (emit-mod-reg-r/m-byte segment #b01 reg #b101)
1437                  (emit-byte segment disp))
1438                 (t
1439                  (emit-mod-reg-r/m-byte segment #b10 reg #b101)
1440                  (emit-signed-dword segment disp)))))
1441        (constant
1442         (unless allow-constants
1443           ;; Why?
1444           (error
1445            "Constant TNs can only be directly used in MOV, PUSH, and CMP."))
1446         (emit-constant-tn-rip segment thing reg))))
1447     (ea
1448      (let* ((base (ea-base thing))
1449             (index (ea-index thing))
1450             (scale (ea-scale thing))
1451             (disp (ea-disp thing))
1452             (mod (cond ((or (null base)
1453                             (and (eql disp 0)
1454                                  (not (= (reg-tn-encoding base) #b101))))
1455                         #b00)
1456                        ((and (fixnump disp) (<= -128 disp 127))
1457                         #b01)
1458                        (t
1459                         #b10)))
1460             (r/m (cond (index #b100)
1461                        ((null base) #b101)
1462                        (t (reg-tn-encoding base)))))
1463        (when (and (= mod 0) (= r/m #b101))
1464          ;; this is rip-relative in amd64, so we'll use a sib instead
1465          (setf r/m #b100 scale 1))
1466        (emit-mod-reg-r/m-byte segment mod reg r/m)
1467        (when (= r/m #b100)
1468          (let ((ss (1- (integer-length scale)))
1469                (index (if (null index)
1470                           #b100
1471                           (let ((index (reg-tn-encoding index)))
1472                             (if (= index #b100)
1473                                 (error "can't index off of ESP")
1474                                 index))))
1475                (base (if (null base)
1476                          #b101
1477                          (reg-tn-encoding base))))
1478            (emit-sib-byte segment ss index base)))
1479        (cond ((= mod #b01)
1480               (emit-byte segment disp))
1481              ((or (= mod #b10) (null base))
1482               (if (fixup-p disp)
1483                   (emit-absolute-fixup segment disp)
1484                   (emit-signed-dword segment disp))))))
1485     (fixup
1486      (typecase (fixup-offset thing)
1487        (label
1488         (emit-label-rip segment thing reg))
1489        (t
1490         (emit-mod-reg-r/m-byte segment #b00 reg #b100)
1491         (emit-sib-byte segment 0 #b100 #b101)
1492         (emit-absolute-fixup segment thing))))))
1493
1494 (defun byte-reg-p (thing)
1495   (and (tn-p thing)
1496        (eq (sb-name (sc-sb (tn-sc thing))) 'registers)
1497        (member (sc-name (tn-sc thing)) *byte-sc-names*)
1498        t))
1499
1500 (defun byte-ea-p (thing)
1501   (typecase thing
1502     (ea (eq (ea-size thing) :byte))
1503     (tn
1504      (and (member (sc-name (tn-sc thing)) *byte-sc-names*) t))
1505     (t nil)))
1506
1507 (defun word-reg-p (thing)
1508   (and (tn-p thing)
1509        (eq (sb-name (sc-sb (tn-sc thing))) 'registers)
1510        (member (sc-name (tn-sc thing)) *word-sc-names*)
1511        t))
1512
1513 (defun word-ea-p (thing)
1514   (typecase thing
1515     (ea (eq (ea-size thing) :word))
1516     (tn (and (member (sc-name (tn-sc thing)) *word-sc-names*) t))
1517     (t nil)))
1518
1519 (defun dword-reg-p (thing)
1520   (and (tn-p thing)
1521        (eq (sb-name (sc-sb (tn-sc thing))) 'registers)
1522        (member (sc-name (tn-sc thing)) *dword-sc-names*)
1523        t))
1524
1525 (defun dword-ea-p (thing)
1526   (typecase thing
1527     (ea (eq (ea-size thing) :dword))
1528     (tn
1529      (and (member (sc-name (tn-sc thing)) *dword-sc-names*) t))
1530     (t nil)))
1531
1532 (defun qword-reg-p (thing)
1533   (and (tn-p thing)
1534        (eq (sb-name (sc-sb (tn-sc thing))) 'registers)
1535        (member (sc-name (tn-sc thing)) *qword-sc-names*)
1536        t))
1537
1538 (defun qword-ea-p (thing)
1539   (typecase thing
1540     (ea (eq (ea-size thing) :qword))
1541     (tn
1542      (and (member (sc-name (tn-sc thing)) *qword-sc-names*) t))
1543     (t nil)))
1544
1545 ;;; Return true if THING is a general-purpose register TN.
1546 (defun register-p (thing)
1547   (and (tn-p thing)
1548        (eq (sb-name (sc-sb (tn-sc thing))) 'registers)))
1549
1550 (defun accumulator-p (thing)
1551   (and (register-p thing)
1552        (= (tn-offset thing) 0)))
1553
1554 ;;; Return true if THING is an XMM register TN.
1555 (defun xmm-register-p (thing)
1556   (and (tn-p thing)
1557        (eq (sb-name (sc-sb (tn-sc thing))) 'float-registers)))
1558
1559 \f
1560 ;;;; utilities
1561
1562 (def!constant +operand-size-prefix-byte+ #b01100110)
1563
1564 (defun maybe-emit-operand-size-prefix (segment size)
1565   (unless (or (eq size :byte)
1566               (eq size :qword)          ; REX prefix handles this
1567               (eq size +default-operand-size+))
1568     (emit-byte segment +operand-size-prefix-byte+)))
1569
1570 ;;; A REX prefix must be emitted if at least one of the following
1571 ;;; conditions is true:
1572 ;;  1. The operand size is :QWORD and the default operand size of the
1573 ;;     instruction is not :QWORD.
1574 ;;; 2. The instruction references an extended register.
1575 ;;; 3. The instruction references one of the byte registers SIL, DIL,
1576 ;;;    SPL or BPL.
1577
1578 ;;; Emit a REX prefix if necessary. OPERAND-SIZE is used to determine
1579 ;;; whether to set REX.W. Callers pass it explicitly as :DO-NOT-SET if
1580 ;;; this should not happen, for example because the instruction's
1581 ;;; default operand size is qword. R, X and B are NIL or TNs specifying
1582 ;;; registers the encodings of which are extended with the REX.R, REX.X
1583 ;;; and REX.B bit, respectively. To determine whether one of the byte
1584 ;;; registers is used that can only be accessed using a REX prefix, we
1585 ;;; need only to test R and B, because X is only used for the index
1586 ;;; register of an effective address and therefore never byte-sized.
1587 ;;; For R we can avoid to calculate the size of the TN because it is
1588 ;;; always OPERAND-SIZE. The size of B must be calculated here because
1589 ;;; B can be address-sized (if it is the base register of an effective
1590 ;;; address), of OPERAND-SIZE (if the instruction operates on two
1591 ;;; registers) or of some different size (in the instructions that
1592 ;;; combine arguments of different sizes: MOVZX, MOVSX, MOVSXD and
1593 ;;; several SSE instructions, e.g. CVTSD2SI). We don't distinguish
1594 ;;; between general-purpose and floating point registers for this cause
1595 ;;; because only general-purpose registers can be byte-sized at all.
1596 (defun maybe-emit-rex-prefix (segment operand-size r x b)
1597   (declare (type (member nil :byte :word :dword :qword :do-not-set)
1598                  operand-size)
1599            (type (or null tn) r x b))
1600   (labels ((if-hi (r)
1601              (if (and r (> (tn-offset r)
1602                            ;; offset of r8 is 16, offset of xmm8 is 8
1603                            (if (eq (sb-name (sc-sb (tn-sc r)))
1604                                    'float-registers)
1605                                7
1606                                15)))
1607                  1
1608                  0))
1609            (reg-4-7-p (r)
1610              ;; Assuming R is a TN describing a general-purpose
1611              ;; register, return true if it references register
1612              ;; 4 upto 7.
1613              (<= 8 (tn-offset r) 15)))
1614     (let ((rex-w (if (eq operand-size :qword) 1 0))
1615           (rex-r (if-hi r))
1616           (rex-x (if-hi x))
1617           (rex-b (if-hi b)))
1618       (when (or (not (zerop (logior rex-w rex-r rex-x rex-b)))
1619                 (and r
1620                      (eq operand-size :byte)
1621                      (reg-4-7-p r))
1622                 (and b
1623                      (eq (operand-size b) :byte)
1624                      (reg-4-7-p b)))
1625         (emit-rex-byte segment #b0100 rex-w rex-r rex-x rex-b)))))
1626
1627 ;;; Emit a REX prefix if necessary. The operand size is determined from
1628 ;;; THING or can be overwritten by OPERAND-SIZE. This and REG are always
1629 ;;; passed to MAYBE-EMIT-REX-PREFIX. Additionally, if THING is an EA we
1630 ;;; pass its index and base registers, if it is a register TN, we pass
1631 ;;; only itself.
1632 ;;; In contrast to EMIT-EA above, neither stack TNs nor fixups need to
1633 ;;; be treated specially here: If THING is a stack TN, neither it nor
1634 ;;; any of its components are passed to MAYBE-EMIT-REX-PREFIX which
1635 ;;; works correctly because stack references always use RBP as the base
1636 ;;; register and never use an index register so no extended registers
1637 ;;; need to be accessed. Fixups are assembled using an addressing mode
1638 ;;; of displacement-only or RIP-plus-displacement (see EMIT-EA), so may
1639 ;;; not reference an extended register. The displacement-only addressing
1640 ;;; mode requires that REX.X is 0, which is ensured here.
1641 (defun maybe-emit-rex-for-ea (segment thing reg &key operand-size)
1642   (declare (type (or ea tn fixup) thing)
1643            (type (or null tn) reg)
1644            (type (member nil :byte :word :dword :qword :do-not-set)
1645                  operand-size))
1646   (let ((ea-p (ea-p thing)))
1647     (maybe-emit-rex-prefix segment
1648                            (or operand-size (operand-size thing))
1649                            reg
1650                            (and ea-p (ea-index thing))
1651                            (cond (ea-p (ea-base thing))
1652                                  ((and (tn-p thing)
1653                                        (member (sb-name (sc-sb (tn-sc thing)))
1654                                                '(float-registers registers)))
1655                                   thing)
1656                                  (t nil)))))
1657
1658 (defun operand-size (thing)
1659   (typecase thing
1660     (tn
1661      ;; FIXME: might as well be COND instead of having to use #. readmacro
1662      ;; to hack up the code
1663      (case (sc-name (tn-sc thing))
1664        (#.*qword-sc-names*
1665         :qword)
1666        (#.*dword-sc-names*
1667         :dword)
1668        (#.*word-sc-names*
1669         :word)
1670        (#.*byte-sc-names*
1671         :byte)
1672        ;; added by jrd: float-registers is a separate size (?)
1673        ;; The only place in the code where we are called with THING
1674        ;; being a float-register is in MAYBE-EMIT-REX-PREFIX when it
1675        ;; checks whether THING is a byte register. Thus our result in
1676        ;; these cases could as well be :dword and :qword. I leave it as
1677        ;; :float and :double which is more likely to trigger an aver
1678        ;; instead of silently doing the wrong thing in case this
1679        ;; situation should change. Lutz Euler, 2005-10-23.
1680        (#.*float-sc-names*
1681         :float)
1682        (#.*double-sc-names*
1683         :double)
1684        (#.*complex-sc-names*
1685         :complex)
1686        (t
1687         (error "can't tell the size of ~S ~S" thing (sc-name (tn-sc thing))))))
1688     (ea
1689      (ea-size thing))
1690     (fixup
1691      ;; GNA.  Guess who spelt "flavor" correctly first time round?
1692      ;; There's a strong argument in my mind to change all uses of
1693      ;; "flavor" to "kind": and similarly with some misguided uses of
1694      ;; "type" here and there.  -- CSR, 2005-01-06.
1695      (case (fixup-flavor thing)
1696        ((:foreign-dataref) :qword)))
1697     (t
1698      nil)))
1699
1700 (defun matching-operand-size (dst src)
1701   (let ((dst-size (operand-size dst))
1702         (src-size (operand-size src)))
1703     (if dst-size
1704         (if src-size
1705             (if (eq dst-size src-size)
1706                 dst-size
1707                 (error "size mismatch: ~S is a ~S and ~S is a ~S."
1708                        dst dst-size src src-size))
1709             dst-size)
1710         (if src-size
1711             src-size
1712             (error "can't tell the size of either ~S or ~S" dst src)))))
1713
1714 ;;; Except in a very few cases (MOV instructions A1, A3 and B8 - BF)
1715 ;;; we expect dword data bytes even when 64 bit work is being done.
1716 ;;; But A1 and A3 are currently unused and B8 - BF use EMIT-QWORD
1717 ;;; directly, so we emit all quad constants as dwords, additionally
1718 ;;; making sure that they survive the sign-extension to 64 bits
1719 ;;; unchanged.
1720 (defun emit-sized-immediate (segment size value)
1721   (ecase size
1722     (:byte
1723      (emit-byte segment value))
1724     (:word
1725      (emit-word segment value))
1726     (:dword
1727      (emit-dword segment value))
1728     (:qword
1729      (emit-signed-dword segment value))))
1730 \f
1731 ;;;; general data transfer
1732
1733 ;;; This is the part of the MOV instruction emitter that does moving
1734 ;;; of an immediate value into a qword register. We go to some length
1735 ;;; to achieve the shortest possible encoding.
1736 (defun emit-immediate-move-to-qword-register (segment dst src)
1737   (declare (type integer src))
1738   (cond ((typep src '(unsigned-byte 32))
1739          ;; We use the B8 - BF encoding with an operand size of 32 bits
1740          ;; here and let the implicit zero-extension fill the upper half
1741          ;; of the 64-bit destination register. Instruction size: five
1742          ;; or six bytes. (A REX prefix will be emitted only if the
1743          ;; destination is an extended register.)
1744          (maybe-emit-rex-prefix segment :dword nil nil dst)
1745          (emit-byte-with-reg segment #b10111 (reg-tn-encoding dst))
1746          (emit-dword segment src))
1747         (t
1748          (maybe-emit-rex-prefix segment :qword nil nil dst)
1749          (cond ((typep src '(signed-byte 32))
1750                 ;; Use the C7 encoding that takes a 32-bit immediate and
1751                 ;; sign-extends it to 64 bits. Instruction size: seven
1752                 ;; bytes.
1753                 (emit-byte segment #b11000111)
1754                 (emit-mod-reg-r/m-byte segment #b11 #b000
1755                                        (reg-tn-encoding dst))
1756                 (emit-signed-dword segment src))
1757                ((<= (- (expt 2 64) (expt 2 31))
1758                     src
1759                     (1- (expt 2 64)))
1760                 ;; This triggers on positive integers of 64 bits length
1761                 ;; with the most significant 33 bits being 1. We use the
1762                 ;; same encoding as in the previous clause.
1763                 (emit-byte segment #b11000111)
1764                 (emit-mod-reg-r/m-byte segment #b11 #b000
1765                                        (reg-tn-encoding dst))
1766                 (emit-signed-dword segment (- src (expt 2 64))))
1767                (t
1768                 ;; We need a full 64-bit immediate. Instruction size:
1769                 ;; ten bytes.
1770                 (emit-byte-with-reg segment #b10111 (reg-tn-encoding dst))
1771                 (emit-qword segment src))))))
1772
1773 (define-instruction mov (segment dst src)
1774   ;; immediate to register
1775   (:printer reg ((op #b1011) (imm nil :type 'signed-imm-data))
1776             '(:name :tab reg ", " imm))
1777   (:printer rex-reg ((op #b1011) (imm nil :type 'signed-imm-data-upto-qword))
1778             '(:name :tab reg ", " imm))
1779   ;; absolute mem to/from accumulator
1780   (:printer simple-dir ((op #b101000) (imm nil :type 'imm-addr))
1781             `(:name :tab ,(swap-if 'dir 'accum ", " '("[" imm "]"))))
1782   ;; register to/from register/memory
1783   (:printer reg-reg/mem-dir ((op #b100010)))
1784   (:printer rex-reg-reg/mem-dir ((op #b100010)))
1785   (:printer x66-reg-reg/mem-dir ((op #b100010)))
1786   (:printer x66-rex-reg-reg/mem-dir ((op #b100010)))
1787   ;; immediate to register/memory
1788   (:printer reg/mem-imm ((op '(#b1100011 #b000))))
1789   (:printer rex-reg/mem-imm ((op '(#b1100011 #b000))))
1790
1791   (:emitter
1792    (let ((size (matching-operand-size dst src)))
1793      (maybe-emit-operand-size-prefix segment size)
1794      (cond ((register-p dst)
1795             (cond ((integerp src)
1796                    (cond ((eq size :qword)
1797                           (emit-immediate-move-to-qword-register segment
1798                                                                  dst src))
1799                          (t
1800                           (maybe-emit-rex-prefix segment size nil nil dst)
1801                           (emit-byte-with-reg segment
1802                                               (if (eq size :byte)
1803                                                   #b10110
1804                                                   #b10111)
1805                                               (reg-tn-encoding dst))
1806                           (emit-sized-immediate segment size src))))
1807                   (t
1808                    (maybe-emit-rex-for-ea segment src dst)
1809                    (emit-byte segment
1810                               (if (eq size :byte)
1811                                   #b10001010
1812                                   #b10001011))
1813                    (emit-ea segment src (reg-tn-encoding dst) t))))
1814            ((integerp src)
1815             ;; C7 only deals with 32 bit immediates even if the
1816             ;; destination is a 64-bit location. The value is
1817             ;; sign-extended in this case.
1818             (maybe-emit-rex-for-ea segment dst nil)
1819             (emit-byte segment (if (eq size :byte) #b11000110 #b11000111))
1820             (emit-ea segment dst #b000)
1821             (emit-sized-immediate segment size src))
1822            ((register-p src)
1823             (maybe-emit-rex-for-ea segment dst src)
1824             (emit-byte segment (if (eq size :byte) #b10001000 #b10001001))
1825             (emit-ea segment dst (reg-tn-encoding src)))
1826            ((fixup-p src)
1827             ;; Generally we can't MOV a fixupped value into an EA, since
1828             ;; MOV on non-registers can only take a 32-bit immediate arg.
1829             ;; Make an exception for :FOREIGN fixups (pretty much just
1830             ;; the runtime asm, since other foreign calls go through the
1831             ;; the linkage table) and for linkage table references, since
1832             ;; these should always end up in low memory.
1833             (aver (or (eq (fixup-flavor src) :foreign)
1834                       (eq (fixup-flavor src) :foreign-dataref)
1835                       (eq (ea-size dst) :dword)))
1836             (maybe-emit-rex-for-ea segment dst nil)
1837             (emit-byte segment #b11000111)
1838             (emit-ea segment dst #b000)
1839             (emit-absolute-fixup segment src))
1840            (t
1841             (error "bogus arguments to MOV: ~S ~S" dst src))))))
1842
1843 (defun emit-move-with-extension (segment dst src signed-p)
1844   (aver (register-p dst))
1845   (let ((dst-size (operand-size dst))
1846         (src-size (operand-size src))
1847         (opcode (if signed-p  #b10111110 #b10110110)))
1848     (ecase dst-size
1849       (:word
1850        (aver (eq src-size :byte))
1851        (maybe-emit-operand-size-prefix segment :word)
1852        ;; REX prefix is needed if SRC is SIL, DIL, SPL or BPL.
1853        (maybe-emit-rex-for-ea segment src dst :operand-size :word)
1854        (emit-byte segment #b00001111)
1855        (emit-byte segment opcode)
1856        (emit-ea segment src (reg-tn-encoding dst)))
1857       ((:dword :qword)
1858        (ecase src-size
1859          (:byte
1860           (maybe-emit-rex-for-ea segment src dst :operand-size dst-size)
1861           (emit-byte segment #b00001111)
1862           (emit-byte segment opcode)
1863           (emit-ea segment src (reg-tn-encoding dst)))
1864          (:word
1865           (maybe-emit-rex-for-ea segment src dst :operand-size dst-size)
1866           (emit-byte segment #b00001111)
1867           (emit-byte segment (logior opcode 1))
1868           (emit-ea segment src (reg-tn-encoding dst)))
1869          (:dword
1870           (aver (eq dst-size :qword))
1871           ;; dst is in reg, src is in modrm
1872           (let ((ea-p (ea-p src)))
1873             (maybe-emit-rex-prefix segment (if signed-p :qword :dword) dst
1874                                    (and ea-p (ea-index src))
1875                                    (cond (ea-p (ea-base src))
1876                                          ((tn-p src) src)
1877                                          (t nil)))
1878             (emit-byte segment #x63)    ;movsxd
1879             ;;(emit-byte segment opcode)
1880             (emit-ea segment src (reg-tn-encoding dst)))))))))
1881
1882 (define-instruction movsx (segment dst src)
1883   (:printer ext-reg-reg/mem-no-width
1884             ((op #b10111110) (reg/mem nil :type 'sized-byte-reg/mem)))
1885   (:printer rex-ext-reg-reg/mem-no-width
1886             ((op #b10111110) (reg/mem nil :type 'sized-byte-reg/mem)))
1887   (:printer ext-reg-reg/mem-no-width
1888             ((op #b10111111) (reg/mem nil :type 'sized-word-reg/mem)))
1889   (:printer rex-ext-reg-reg/mem-no-width
1890             ((op #b10111111) (reg/mem nil :type 'sized-word-reg/mem)))
1891   (:emitter (emit-move-with-extension segment dst src :signed)))
1892
1893 (define-instruction movzx (segment dst src)
1894   (:printer ext-reg-reg/mem-no-width
1895             ((op #b10110110) (reg/mem nil :type 'sized-byte-reg/mem)))
1896   (:printer rex-ext-reg-reg/mem-no-width
1897             ((op #b10110110) (reg/mem nil :type 'sized-byte-reg/mem)))
1898   (:printer ext-reg-reg/mem-no-width
1899             ((op #b10110111) (reg/mem nil :type 'sized-word-reg/mem)))
1900   (:printer rex-ext-reg-reg/mem-no-width
1901             ((op #b10110111) (reg/mem nil :type 'sized-word-reg/mem)))
1902   (:emitter (emit-move-with-extension segment dst src nil)))
1903
1904 ;;; The regular use of MOVSXD is with an operand size of :qword. This
1905 ;;; sign-extends the dword source into the qword destination register.
1906 ;;; If the operand size is :dword the instruction zero-extends the dword
1907 ;;; source into the qword destination register, i.e. it does the same as
1908 ;;; a dword MOV into a register.
1909 (define-instruction movsxd (segment dst src)
1910   (:printer reg-reg/mem ((op #b0110001) (width 1)
1911                          (reg/mem nil :type 'sized-dword-reg/mem)))
1912   (:printer rex-reg-reg/mem ((op #b0110001) (width 1)
1913                              (reg/mem nil :type 'sized-dword-reg/mem)))
1914   (:emitter (emit-move-with-extension segment dst src :signed)))
1915
1916 ;;; this is not a real amd64 instruction, of course
1917 (define-instruction movzxd (segment dst src)
1918   ; (:printer reg-reg/mem ((op #x63) (reg nil :type 'reg)))
1919   (:emitter (emit-move-with-extension segment dst src nil)))
1920
1921 (define-instruction push (segment src)
1922   ;; register
1923   (:printer reg-no-width-default-qword ((op #b01010)))
1924   (:printer rex-reg-no-width-default-qword ((op #b01010)))
1925   ;; register/memory
1926   (:printer reg/mem-default-qword ((op '(#b11111111 #b110))))
1927   (:printer rex-reg/mem-default-qword ((op '(#b11111111 #b110))))
1928   ;; immediate
1929   (:printer byte ((op #b01101010) (imm nil :type 'signed-imm-byte))
1930             '(:name :tab imm))
1931   (:printer byte ((op #b01101000)
1932                   (imm nil :type 'signed-imm-data-default-qword))
1933             '(:name :tab imm))
1934   ;; ### segment registers?
1935
1936   (:emitter
1937    (cond ((integerp src)
1938           (cond ((<= -128 src 127)
1939                  (emit-byte segment #b01101010)
1940                  (emit-byte segment src))
1941                 (t
1942                  ;; A REX-prefix is not needed because the operand size
1943                  ;; defaults to 64 bits. The size of the immediate is 32
1944                  ;; bits and it is sign-extended.
1945                  (emit-byte segment #b01101000)
1946                  (emit-signed-dword segment src))))
1947          (t
1948           (let ((size (operand-size src)))
1949             (aver (or (eq size :qword) (eq size :word)))
1950             (maybe-emit-operand-size-prefix segment size)
1951             (maybe-emit-rex-for-ea segment src nil :operand-size :do-not-set)
1952             (cond ((register-p src)
1953                    (emit-byte-with-reg segment #b01010 (reg-tn-encoding src)))
1954                   (t
1955                    (emit-byte segment #b11111111)
1956                    (emit-ea segment src #b110 t))))))))
1957
1958 (define-instruction pop (segment dst)
1959   (:printer reg-no-width-default-qword ((op #b01011)))
1960   (:printer rex-reg-no-width-default-qword ((op #b01011)))
1961   (:printer reg/mem-default-qword ((op '(#b10001111 #b000))))
1962   (:printer rex-reg/mem-default-qword ((op '(#b10001111 #b000))))
1963   (:emitter
1964    (let ((size (operand-size dst)))
1965      (aver (or (eq size :qword) (eq size :word)))
1966      (maybe-emit-operand-size-prefix segment size)
1967      (maybe-emit-rex-for-ea segment dst nil :operand-size :do-not-set)
1968      (cond ((register-p dst)
1969             (emit-byte-with-reg segment #b01011 (reg-tn-encoding dst)))
1970            (t
1971             (emit-byte segment #b10001111)
1972             (emit-ea segment dst #b000))))))
1973
1974 (define-instruction xchg (segment operand1 operand2)
1975   ;; Register with accumulator.
1976   (:printer reg-no-width ((op #b10010)) '(:name :tab accum ", " reg))
1977   ;; Register/Memory with Register.
1978   (:printer reg-reg/mem ((op #b1000011)))
1979   (:printer rex-reg-reg/mem ((op #b1000011)))
1980   (:emitter
1981    (let ((size (matching-operand-size operand1 operand2)))
1982      (maybe-emit-operand-size-prefix segment size)
1983      (labels ((xchg-acc-with-something (acc something)
1984                 (if (and (not (eq size :byte)) (register-p something))
1985                     (progn
1986                       (maybe-emit-rex-for-ea segment acc something)
1987                       (emit-byte-with-reg segment
1988                                           #b10010
1989                                           (reg-tn-encoding something)))
1990                     (xchg-reg-with-something acc something)))
1991               (xchg-reg-with-something (reg something)
1992                 (maybe-emit-rex-for-ea segment something reg)
1993                 (emit-byte segment (if (eq size :byte) #b10000110 #b10000111))
1994                 (emit-ea segment something (reg-tn-encoding reg))))
1995        (cond ((accumulator-p operand1)
1996               (xchg-acc-with-something operand1 operand2))
1997              ((accumulator-p operand2)
1998               (xchg-acc-with-something operand2 operand1))
1999              ((register-p operand1)
2000               (xchg-reg-with-something operand1 operand2))
2001              ((register-p operand2)
2002               (xchg-reg-with-something operand2 operand1))
2003              (t
2004               (error "bogus args to XCHG: ~S ~S" operand1 operand2)))))))
2005
2006 (define-instruction lea (segment dst src)
2007   (:printer rex-reg-reg/mem ((op #b1000110)))
2008   (:printer reg-reg/mem ((op #b1000110) (width 1)))
2009   (:emitter
2010    (aver (or (dword-reg-p dst) (qword-reg-p dst)))
2011    (maybe-emit-rex-for-ea segment src dst
2012                           :operand-size :qword)
2013    (emit-byte segment #b10001101)
2014    (emit-ea segment src (reg-tn-encoding dst))))
2015
2016 (define-instruction cmpxchg (segment dst src &optional prefix)
2017   ;; Register/Memory with Register.
2018   (:printer ext-reg-reg/mem ((op #b1011000)) '(:name :tab reg/mem ", " reg))
2019   (:emitter
2020    (aver (register-p src))
2021    (emit-prefix segment prefix)
2022    (let ((size (matching-operand-size src dst)))
2023      (maybe-emit-operand-size-prefix segment size)
2024      (maybe-emit-rex-for-ea segment dst src)
2025      (emit-byte segment #b00001111)
2026      (emit-byte segment (if (eq size :byte) #b10110000 #b10110001))
2027      (emit-ea segment dst (reg-tn-encoding src)))))
2028
2029 \f
2030 ;;;; flag control instructions
2031
2032 ;;; CLC -- Clear Carry Flag.
2033 (define-instruction clc (segment)
2034   (:printer byte ((op #b11111000)))
2035   (:emitter
2036    (emit-byte segment #b11111000)))
2037
2038 ;;; CLD -- Clear Direction Flag.
2039 (define-instruction cld (segment)
2040   (:printer byte ((op #b11111100)))
2041   (:emitter
2042    (emit-byte segment #b11111100)))
2043
2044 ;;; CLI -- Clear Iterrupt Enable Flag.
2045 (define-instruction cli (segment)
2046   (:printer byte ((op #b11111010)))
2047   (:emitter
2048    (emit-byte segment #b11111010)))
2049
2050 ;;; CMC -- Complement Carry Flag.
2051 (define-instruction cmc (segment)
2052   (:printer byte ((op #b11110101)))
2053   (:emitter
2054    (emit-byte segment #b11110101)))
2055
2056 ;;; LAHF -- Load AH into flags.
2057 (define-instruction lahf (segment)
2058   (:printer byte ((op #b10011111)))
2059   (:emitter
2060    (emit-byte segment #b10011111)))
2061
2062 ;;; POPF -- Pop flags.
2063 (define-instruction popf (segment)
2064   (:printer byte ((op #b10011101)))
2065   (:emitter
2066    (emit-byte segment #b10011101)))
2067
2068 ;;; PUSHF -- push flags.
2069 (define-instruction pushf (segment)
2070   (:printer byte ((op #b10011100)))
2071   (:emitter
2072    (emit-byte segment #b10011100)))
2073
2074 ;;; SAHF -- Store AH into flags.
2075 (define-instruction sahf (segment)
2076   (:printer byte ((op #b10011110)))
2077   (:emitter
2078    (emit-byte segment #b10011110)))
2079
2080 ;;; STC -- Set Carry Flag.
2081 (define-instruction stc (segment)
2082   (:printer byte ((op #b11111001)))
2083   (:emitter
2084    (emit-byte segment #b11111001)))
2085
2086 ;;; STD -- Set Direction Flag.
2087 (define-instruction std (segment)
2088   (:printer byte ((op #b11111101)))
2089   (:emitter
2090    (emit-byte segment #b11111101)))
2091
2092 ;;; STI -- Set Interrupt Enable Flag.
2093 (define-instruction sti (segment)
2094   (:printer byte ((op #b11111011)))
2095   (:emitter
2096    (emit-byte segment #b11111011)))
2097 \f
2098 ;;;; arithmetic
2099
2100 (defun emit-random-arith-inst (name segment dst src opcode
2101                                     &optional allow-constants)
2102   (let ((size (matching-operand-size dst src)))
2103     (maybe-emit-operand-size-prefix segment size)
2104     (cond
2105      ((integerp src)
2106       (cond ((and (not (eq size :byte)) (<= -128 src 127))
2107              (maybe-emit-rex-for-ea segment dst nil)
2108              (emit-byte segment #b10000011)
2109              (emit-ea segment dst opcode allow-constants)
2110              (emit-byte segment src))
2111             ((accumulator-p dst)
2112              (maybe-emit-rex-for-ea segment dst nil)
2113              (emit-byte segment
2114                         (dpb opcode
2115                              (byte 3 3)
2116                              (if (eq size :byte)
2117                                  #b00000100
2118                                  #b00000101)))
2119              (emit-sized-immediate segment size src))
2120             (t
2121              (maybe-emit-rex-for-ea segment dst nil)
2122              (emit-byte segment (if (eq size :byte) #b10000000 #b10000001))
2123              (emit-ea segment dst opcode allow-constants)
2124              (emit-sized-immediate segment size src))))
2125      ((register-p src)
2126       (maybe-emit-rex-for-ea segment dst src)
2127       (emit-byte segment
2128                  (dpb opcode
2129                       (byte 3 3)
2130                       (if (eq size :byte) #b00000000 #b00000001)))
2131       (emit-ea segment dst (reg-tn-encoding src) allow-constants))
2132      ((register-p dst)
2133       (maybe-emit-rex-for-ea segment src dst)
2134       (emit-byte segment
2135                  (dpb opcode
2136                       (byte 3 3)
2137                       (if (eq size :byte) #b00000010 #b00000011)))
2138       (emit-ea segment src (reg-tn-encoding dst) allow-constants))
2139      (t
2140       (error "bogus operands to ~A" name)))))
2141
2142 (eval-when (:compile-toplevel :execute)
2143   (defun arith-inst-printer-list (subop)
2144     `((accum-imm ((op ,(dpb subop (byte 3 2) #b0000010))))
2145       (rex-accum-imm ((op ,(dpb subop (byte 3 2) #b0000010))))
2146       (reg/mem-imm ((op (#b1000000 ,subop))))
2147       (rex-reg/mem-imm ((op (#b1000000 ,subop))))
2148       ;; The redundant encoding #x82 is invalid in 64-bit mode,
2149       ;; therefore we force WIDTH to 1.
2150       (reg/mem-imm ((op (#b1000001 ,subop)) (width 1)
2151                     (imm nil :type signed-imm-byte)))
2152       (rex-reg/mem-imm ((op (#b1000001 ,subop)) (width 1)
2153                         (imm nil :type signed-imm-byte)))
2154       (reg-reg/mem-dir ((op ,(dpb subop (byte 3 1) #b000000))))
2155       (rex-reg-reg/mem-dir ((op ,(dpb subop (byte 3 1) #b000000))))))
2156   )
2157
2158 (define-instruction add (segment dst src &optional prefix)
2159   (:printer-list (arith-inst-printer-list #b000))
2160   (:emitter
2161    (emit-prefix segment prefix)
2162    (emit-random-arith-inst "ADD" segment dst src #b000)))
2163
2164 (define-instruction adc (segment dst src)
2165   (:printer-list (arith-inst-printer-list #b010))
2166   (:emitter (emit-random-arith-inst "ADC" segment dst src #b010)))
2167
2168 (define-instruction sub (segment dst src)
2169   (:printer-list (arith-inst-printer-list #b101))
2170   (:emitter (emit-random-arith-inst "SUB" segment dst src #b101)))
2171
2172 (define-instruction sbb (segment dst src)
2173   (:printer-list (arith-inst-printer-list #b011))
2174   (:emitter (emit-random-arith-inst "SBB" segment dst src #b011)))
2175
2176 (define-instruction cmp (segment dst src)
2177   (:printer-list (arith-inst-printer-list #b111))
2178   (:emitter (emit-random-arith-inst "CMP" segment dst src #b111 t)))
2179
2180 ;;; The one-byte encodings for INC and DEC are used as REX prefixes
2181 ;;; in 64-bit mode so we always use the two-byte form.
2182 (define-instruction inc (segment dst)
2183   (:printer reg/mem ((op '(#b1111111 #b000))))
2184   (:printer rex-reg/mem ((op '(#b1111111 #b000))))
2185   (:emitter
2186    (let ((size (operand-size dst)))
2187      (maybe-emit-operand-size-prefix segment size)
2188      (maybe-emit-rex-for-ea segment dst nil)
2189      (emit-byte segment (if (eq size :byte) #b11111110 #b11111111))
2190      (emit-ea segment dst #b000))))
2191
2192 (define-instruction dec (segment dst)
2193   (:printer reg/mem ((op '(#b1111111 #b001))))
2194   (:printer rex-reg/mem ((op '(#b1111111 #b001))))
2195   (:emitter
2196    (let ((size (operand-size dst)))
2197      (maybe-emit-operand-size-prefix segment size)
2198      (maybe-emit-rex-for-ea segment dst nil)
2199      (emit-byte segment (if (eq size :byte) #b11111110 #b11111111))
2200      (emit-ea segment dst #b001))))
2201
2202 (define-instruction neg (segment dst)
2203   (:printer reg/mem ((op '(#b1111011 #b011))))
2204   (:printer rex-reg/mem ((op '(#b1111011 #b011))))
2205   (:emitter
2206    (let ((size (operand-size dst)))
2207      (maybe-emit-operand-size-prefix segment size)
2208      (maybe-emit-rex-for-ea segment dst nil)
2209      (emit-byte segment (if (eq size :byte) #b11110110 #b11110111))
2210      (emit-ea segment dst #b011))))
2211
2212 (define-instruction mul (segment dst src)
2213   (:printer accum-reg/mem ((op '(#b1111011 #b100))))
2214   (:printer rex-accum-reg/mem ((op '(#b1111011 #b100))))
2215   (:emitter
2216    (let ((size (matching-operand-size dst src)))
2217      (aver (accumulator-p dst))
2218      (maybe-emit-operand-size-prefix segment size)
2219      (maybe-emit-rex-for-ea segment src nil)
2220      (emit-byte segment (if (eq size :byte) #b11110110 #b11110111))
2221      (emit-ea segment src #b100))))
2222
2223 (define-instruction imul (segment dst &optional src1 src2)
2224   (:printer accum-reg/mem ((op '(#b1111011 #b101))))
2225   (:printer rex-accum-reg/mem ((op '(#b1111011 #b101))))
2226   (:printer ext-reg-reg/mem-no-width ((op #b10101111)))
2227   (:printer rex-ext-reg-reg/mem-no-width ((op #b10101111)))
2228   (:printer reg-reg/mem ((op #b0110100) (width 1)
2229                          (imm nil :type 'signed-imm-data))
2230             '(:name :tab reg ", " reg/mem ", " imm))
2231   (:printer rex-reg-reg/mem ((op #b0110100) (width 1)
2232                              (imm nil :type 'signed-imm-data))
2233             '(:name :tab reg ", " reg/mem ", " imm))
2234   (:printer reg-reg/mem ((op #b0110101) (width 1)
2235                          (imm nil :type 'signed-imm-byte))
2236             '(:name :tab reg ", " reg/mem ", " imm))
2237   (:printer rex-reg-reg/mem ((op #b0110101) (width 1)
2238                              (imm nil :type 'signed-imm-byte))
2239             '(:name :tab reg ", " reg/mem ", " imm))
2240   (:emitter
2241    (flet ((r/m-with-immed-to-reg (reg r/m immed)
2242             (let* ((size (matching-operand-size reg r/m))
2243                    (sx (and (not (eq size :byte)) (<= -128 immed 127))))
2244               (maybe-emit-operand-size-prefix segment size)
2245               (maybe-emit-rex-for-ea segment r/m reg)
2246               (emit-byte segment (if sx #b01101011 #b01101001))
2247               (emit-ea segment r/m (reg-tn-encoding reg))
2248               (if sx
2249                   (emit-byte segment immed)
2250                   (emit-sized-immediate segment size immed)))))
2251      (cond (src2
2252             (r/m-with-immed-to-reg dst src1 src2))
2253            (src1
2254             (if (integerp src1)
2255                 (r/m-with-immed-to-reg dst dst src1)
2256                 (let ((size (matching-operand-size dst src1)))
2257                   (maybe-emit-operand-size-prefix segment size)
2258                   (maybe-emit-rex-for-ea segment src1 dst)
2259                   (emit-byte segment #b00001111)
2260                   (emit-byte segment #b10101111)
2261                   (emit-ea segment src1 (reg-tn-encoding dst)))))
2262            (t
2263             (let ((size (operand-size dst)))
2264               (maybe-emit-operand-size-prefix segment size)
2265               (maybe-emit-rex-for-ea segment dst nil)
2266               (emit-byte segment (if (eq size :byte) #b11110110 #b11110111))
2267               (emit-ea segment dst #b101)))))))
2268
2269 (define-instruction div (segment dst src)
2270   (:printer accum-reg/mem ((op '(#b1111011 #b110))))
2271   (:printer rex-accum-reg/mem ((op '(#b1111011 #b110))))
2272   (:emitter
2273    (let ((size (matching-operand-size dst src)))
2274      (aver (accumulator-p dst))
2275      (maybe-emit-operand-size-prefix segment size)
2276      (maybe-emit-rex-for-ea segment src nil)
2277      (emit-byte segment (if (eq size :byte) #b11110110 #b11110111))
2278      (emit-ea segment src #b110))))
2279
2280 (define-instruction idiv (segment dst src)
2281   (:printer accum-reg/mem ((op '(#b1111011 #b111))))
2282   (:printer rex-accum-reg/mem ((op '(#b1111011 #b111))))
2283   (:emitter
2284    (let ((size (matching-operand-size dst src)))
2285      (aver (accumulator-p dst))
2286      (maybe-emit-operand-size-prefix segment size)
2287      (maybe-emit-rex-for-ea segment src nil)
2288      (emit-byte segment (if (eq size :byte) #b11110110 #b11110111))
2289      (emit-ea segment src #b111))))
2290
2291 (define-instruction bswap (segment dst)
2292   (:printer ext-reg-no-width ((op #b11001)))
2293   (:emitter
2294    (let ((size (operand-size dst)))
2295      (maybe-emit-rex-prefix segment size nil nil dst)
2296      (emit-byte segment #x0f)
2297      (emit-byte-with-reg segment #b11001 (reg-tn-encoding dst)))))
2298
2299 ;;; CBW -- Convert Byte to Word. AX <- sign_xtnd(AL)
2300 (define-instruction cbw (segment)
2301   (:printer x66-byte ((op #b10011000)))
2302   (:emitter
2303    (maybe-emit-operand-size-prefix segment :word)
2304    (emit-byte segment #b10011000)))
2305
2306 ;;; CWDE -- Convert Word To Double Word Extended. EAX <- sign_xtnd(AX)
2307 (define-instruction cwde (segment)
2308   (:printer byte ((op #b10011000)))
2309   (:emitter
2310    (maybe-emit-operand-size-prefix segment :dword)
2311    (emit-byte segment #b10011000)))
2312
2313 ;;; CDQE -- Convert Double Word To Quad Word Extended. RAX <- sign_xtnd(EAX)
2314 (define-instruction cdqe (segment)
2315   (:printer rex-byte ((op #b10011000)))
2316   (:emitter
2317    (maybe-emit-rex-prefix segment :qword nil nil nil)
2318    (emit-byte segment #b10011000)))
2319
2320 ;;; CWD -- Convert Word to Double Word. DX:AX <- sign_xtnd(AX)
2321 (define-instruction cwd (segment)
2322   (:printer x66-byte ((op #b10011001)))
2323   (:emitter
2324    (maybe-emit-operand-size-prefix segment :word)
2325    (emit-byte segment #b10011001)))
2326
2327 ;;; CDQ -- Convert Double Word to Quad Word. EDX:EAX <- sign_xtnd(EAX)
2328 (define-instruction cdq (segment)
2329   (:printer byte ((op #b10011001)))
2330   (:emitter
2331    (maybe-emit-operand-size-prefix segment :dword)
2332    (emit-byte segment #b10011001)))
2333
2334 ;;; CQO -- Convert Quad Word to Octaword. RDX:RAX <- sign_xtnd(RAX)
2335 (define-instruction cqo (segment)
2336   (:printer rex-byte ((op #b10011001)))
2337   (:emitter
2338    (maybe-emit-rex-prefix segment :qword nil nil nil)
2339    (emit-byte segment #b10011001)))
2340
2341 (define-instruction xadd (segment dst src &optional prefix)
2342   ;; Register/Memory with Register.
2343   (:printer ext-reg-reg/mem ((op #b1100000)) '(:name :tab reg/mem ", " reg))
2344   (:emitter
2345    (aver (register-p src))
2346    (emit-prefix segment prefix)
2347    (let ((size (matching-operand-size src dst)))
2348      (maybe-emit-operand-size-prefix segment size)
2349      (maybe-emit-rex-for-ea segment dst src)
2350      (emit-byte segment #b00001111)
2351      (emit-byte segment (if (eq size :byte) #b11000000 #b11000001))
2352      (emit-ea segment dst (reg-tn-encoding src)))))
2353
2354 \f
2355 ;;;; logic
2356
2357 (defun emit-shift-inst (segment dst amount opcode)
2358   (let ((size (operand-size dst)))
2359     (maybe-emit-operand-size-prefix segment size)
2360     (multiple-value-bind (major-opcode immed)
2361         (case amount
2362           (:cl (values #b11010010 nil))
2363           (1 (values #b11010000 nil))
2364           (t (values #b11000000 t)))
2365       (maybe-emit-rex-for-ea segment dst nil)
2366       (emit-byte segment
2367                  (if (eq size :byte) major-opcode (logior major-opcode 1)))
2368       (emit-ea segment dst opcode)
2369       (when immed
2370         (emit-byte segment amount)))))
2371
2372 (eval-when (:compile-toplevel :execute)
2373   (defun shift-inst-printer-list (subop)
2374     `((reg/mem ((op (#b1101000 ,subop)))
2375                (:name :tab reg/mem ", 1"))
2376       (rex-reg/mem ((op (#b1101000 ,subop)))
2377                    (:name :tab reg/mem ", 1"))
2378       (reg/mem ((op (#b1101001 ,subop)))
2379                (:name :tab reg/mem ", " 'cl))
2380       (rex-reg/mem ((op (#b1101001 ,subop)))
2381                (:name :tab reg/mem ", " 'cl))
2382       (reg/mem-imm ((op (#b1100000 ,subop))
2383                     (imm nil :type imm-byte)))
2384       (rex-reg/mem-imm ((op (#b1100000 ,subop))
2385                     (imm nil :type imm-byte))))))
2386
2387 (define-instruction rol (segment dst amount)
2388   (:printer-list
2389    (shift-inst-printer-list #b000))
2390   (:emitter
2391    (emit-shift-inst segment dst amount #b000)))
2392
2393 (define-instruction ror (segment dst amount)
2394   (:printer-list
2395    (shift-inst-printer-list #b001))
2396   (:emitter
2397    (emit-shift-inst segment dst amount #b001)))
2398
2399 (define-instruction rcl (segment dst amount)
2400   (:printer-list
2401    (shift-inst-printer-list #b010))
2402   (:emitter
2403    (emit-shift-inst segment dst amount #b010)))
2404
2405 (define-instruction rcr (segment dst amount)
2406   (:printer-list
2407    (shift-inst-printer-list #b011))
2408   (:emitter
2409    (emit-shift-inst segment dst amount #b011)))
2410
2411 (define-instruction shl (segment dst amount)
2412   (:printer-list
2413    (shift-inst-printer-list #b100))
2414   (:emitter
2415    (emit-shift-inst segment dst amount #b100)))
2416
2417 (define-instruction shr (segment dst amount)
2418   (:printer-list
2419    (shift-inst-printer-list #b101))
2420   (:emitter
2421    (emit-shift-inst segment dst amount #b101)))
2422
2423 (define-instruction sar (segment dst amount)
2424   (:printer-list
2425    (shift-inst-printer-list #b111))
2426   (:emitter
2427    (emit-shift-inst segment dst amount #b111)))
2428
2429 (defun emit-double-shift (segment opcode dst src amt)
2430   (let ((size (matching-operand-size dst src)))
2431     (when (eq size :byte)
2432       (error "Double shifts can only be used with words."))
2433     (maybe-emit-operand-size-prefix segment size)
2434     (maybe-emit-rex-for-ea segment dst src)
2435     (emit-byte segment #b00001111)
2436     (emit-byte segment (dpb opcode (byte 1 3)
2437                             (if (eq amt :cl) #b10100101 #b10100100)))
2438     (emit-ea segment dst (reg-tn-encoding src))
2439     (unless (eq amt :cl)
2440       (emit-byte segment amt))))
2441
2442 (eval-when (:compile-toplevel :execute)
2443   (defun double-shift-inst-printer-list (op)
2444     `(#+nil
2445       (ext-reg-reg/mem-imm ((op ,(logior op #b100))
2446                             (imm nil :type signed-imm-byte)))
2447       (ext-reg-reg/mem ((op ,(logior op #b101)))
2448          (:name :tab reg/mem ", " 'cl)))))
2449
2450 (define-instruction shld (segment dst src amt)
2451   (:declare (type (or (member :cl) (mod 32)) amt))
2452   (:printer-list (double-shift-inst-printer-list #b10100000))
2453   (:emitter
2454    (emit-double-shift segment #b0 dst src amt)))
2455
2456 (define-instruction shrd (segment dst src amt)
2457   (:declare (type (or (member :cl) (mod 32)) amt))
2458   (:printer-list (double-shift-inst-printer-list #b10101000))
2459   (:emitter
2460    (emit-double-shift segment #b1 dst src amt)))
2461
2462 (define-instruction and (segment dst src)
2463   (:printer-list
2464    (arith-inst-printer-list #b100))
2465   (:emitter
2466    (emit-random-arith-inst "AND" segment dst src #b100)))
2467
2468 (define-instruction test (segment this that)
2469   (:printer accum-imm ((op #b1010100)))
2470   (:printer rex-accum-imm ((op #b1010100)))
2471   (:printer reg/mem-imm ((op '(#b1111011 #b000))))
2472   (:printer rex-reg/mem-imm ((op '(#b1111011 #b000))))
2473   (:printer reg-reg/mem ((op #b1000010)))
2474   (:printer rex-reg-reg/mem ((op #b1000010)))
2475   (:emitter
2476    (let ((size (matching-operand-size this that)))
2477      (maybe-emit-operand-size-prefix segment size)
2478      (flet ((test-immed-and-something (immed something)
2479               (cond ((accumulator-p something)
2480                      (maybe-emit-rex-for-ea segment something nil)
2481                      (emit-byte segment
2482                                 (if (eq size :byte) #b10101000 #b10101001))
2483                      (emit-sized-immediate segment size immed))
2484                     (t
2485                      (maybe-emit-rex-for-ea segment something nil)
2486                      (emit-byte segment
2487                                 (if (eq size :byte) #b11110110 #b11110111))
2488                      (emit-ea segment something #b000)
2489                      (emit-sized-immediate segment size immed))))
2490             (test-reg-and-something (reg something)
2491               (maybe-emit-rex-for-ea segment something reg)
2492               (emit-byte segment (if (eq size :byte) #b10000100 #b10000101))
2493               (emit-ea segment something (reg-tn-encoding reg))))
2494        (cond ((integerp that)
2495               (test-immed-and-something that this))
2496              ((integerp this)
2497               (test-immed-and-something this that))
2498              ((register-p this)
2499               (test-reg-and-something this that))
2500              ((register-p that)
2501               (test-reg-and-something that this))
2502              (t
2503               (error "bogus operands for TEST: ~S and ~S" this that)))))))
2504
2505 (define-instruction or (segment dst src)
2506   (:printer-list
2507    (arith-inst-printer-list #b001))
2508   (:emitter
2509    (emit-random-arith-inst "OR" segment dst src #b001)))
2510
2511 (define-instruction xor (segment dst src)
2512   (:printer-list
2513    (arith-inst-printer-list #b110))
2514   (:emitter
2515    (emit-random-arith-inst "XOR" segment dst src #b110)))
2516
2517 (define-instruction not (segment dst)
2518   (:printer reg/mem ((op '(#b1111011 #b010))))
2519   (:printer rex-reg/mem ((op '(#b1111011 #b010))))
2520   (:emitter
2521    (let ((size (operand-size dst)))
2522      (maybe-emit-operand-size-prefix segment size)
2523      (maybe-emit-rex-for-ea segment dst nil)
2524      (emit-byte segment (if (eq size :byte) #b11110110 #b11110111))
2525      (emit-ea segment dst #b010))))
2526 \f
2527 ;;;; string manipulation
2528
2529 (define-instruction cmps (segment size)
2530   (:printer string-op ((op #b1010011)))
2531   (:printer rex-string-op ((op #b1010011)))
2532   (:emitter
2533    (maybe-emit-operand-size-prefix segment size)
2534    (maybe-emit-rex-prefix segment size nil nil nil)
2535    (emit-byte segment (if (eq size :byte) #b10100110 #b10100111))))
2536
2537 (define-instruction ins (segment acc)
2538   (:printer string-op ((op #b0110110)))
2539   (:printer rex-string-op ((op #b0110110)))
2540   (:emitter
2541    (let ((size (operand-size acc)))
2542      (aver (accumulator-p acc))
2543      (maybe-emit-operand-size-prefix segment size)
2544      (maybe-emit-rex-prefix segment size nil nil nil)
2545      (emit-byte segment (if (eq size :byte) #b01101100 #b01101101)))))
2546
2547 (define-instruction lods (segment acc)
2548   (:printer string-op ((op #b1010110)))
2549   (:printer rex-string-op ((op #b1010110)))
2550   (:emitter
2551    (let ((size (operand-size acc)))
2552      (aver (accumulator-p acc))
2553      (maybe-emit-operand-size-prefix segment size)
2554      (maybe-emit-rex-prefix segment size nil nil nil)
2555      (emit-byte segment (if (eq size :byte) #b10101100 #b10101101)))))
2556
2557 (define-instruction movs (segment size)
2558   (:printer string-op ((op #b1010010)))
2559   (:printer rex-string-op ((op #b1010010)))
2560   (:emitter
2561    (maybe-emit-operand-size-prefix segment size)
2562    (maybe-emit-rex-prefix segment size nil nil nil)
2563    (emit-byte segment (if (eq size :byte) #b10100100 #b10100101))))
2564
2565 (define-instruction outs (segment acc)
2566   (:printer string-op ((op #b0110111)))
2567   (:printer rex-string-op ((op #b0110111)))
2568   (:emitter
2569    (let ((size (operand-size acc)))
2570      (aver (accumulator-p acc))
2571      (maybe-emit-operand-size-prefix segment size)
2572      (maybe-emit-rex-prefix segment size nil nil nil)
2573      (emit-byte segment (if (eq size :byte) #b01101110 #b01101111)))))
2574
2575 (define-instruction scas (segment acc)
2576   (:printer string-op ((op #b1010111)))
2577   (:printer rex-string-op ((op #b1010111)))
2578   (:emitter
2579    (let ((size (operand-size acc)))
2580      (aver (accumulator-p acc))
2581      (maybe-emit-operand-size-prefix segment size)
2582      (maybe-emit-rex-prefix segment size nil nil nil)
2583      (emit-byte segment (if (eq size :byte) #b10101110 #b10101111)))))
2584
2585 (define-instruction stos (segment acc)
2586   (:printer string-op ((op #b1010101)))
2587   (:printer rex-string-op ((op #b1010101)))
2588   (:emitter
2589    (let ((size (operand-size acc)))
2590      (aver (accumulator-p acc))
2591      (maybe-emit-operand-size-prefix segment size)
2592      (maybe-emit-rex-prefix segment size nil nil nil)
2593      (emit-byte segment (if (eq size :byte) #b10101010 #b10101011)))))
2594
2595 (define-instruction xlat (segment)
2596   (:printer byte ((op #b11010111)))
2597   (:emitter
2598    (emit-byte segment #b11010111)))
2599
2600 (define-instruction rep (segment)
2601   (:emitter
2602    (emit-byte segment #b11110011)))
2603
2604 (define-instruction repe (segment)
2605   (:printer byte ((op #b11110011)))
2606   (:emitter
2607    (emit-byte segment #b11110011)))
2608
2609 (define-instruction repne (segment)
2610   (:printer byte ((op #b11110010)))
2611   (:emitter
2612    (emit-byte segment #b11110010)))
2613
2614 \f
2615 ;;;; bit manipulation
2616
2617 (define-instruction bsf (segment dst src)
2618   (:printer ext-reg-reg/mem-no-width ((op #b10111100)))
2619   (:printer rex-ext-reg-reg/mem-no-width ((op #b10111100)))
2620   (:emitter
2621    (let ((size (matching-operand-size dst src)))
2622      (when (eq size :byte)
2623        (error "can't scan bytes: ~S" src))
2624      (maybe-emit-operand-size-prefix segment size)
2625      (maybe-emit-rex-for-ea segment src dst)
2626      (emit-byte segment #b00001111)
2627      (emit-byte segment #b10111100)
2628      (emit-ea segment src (reg-tn-encoding dst)))))
2629
2630 (define-instruction bsr (segment dst src)
2631   (:printer ext-reg-reg/mem-no-width ((op #b10111101)))
2632   (:printer rex-ext-reg-reg/mem-no-width ((op #b10111101)))
2633   (:emitter
2634    (let ((size (matching-operand-size dst src)))
2635      (when (eq size :byte)
2636        (error "can't scan bytes: ~S" src))
2637      (maybe-emit-operand-size-prefix segment size)
2638      (maybe-emit-rex-for-ea segment src dst)
2639      (emit-byte segment #b00001111)
2640      (emit-byte segment #b10111101)
2641      (emit-ea segment src (reg-tn-encoding dst)))))
2642
2643 (defun emit-bit-test-and-mumble (segment src index opcode)
2644   (let ((size (operand-size src)))
2645     (when (eq size :byte)
2646       (error "can't scan bytes: ~S" src))
2647     (maybe-emit-operand-size-prefix segment size)
2648     (cond ((integerp index)
2649            (maybe-emit-rex-for-ea segment src nil)
2650            (emit-byte segment #b00001111)
2651            (emit-byte segment #b10111010)
2652            (emit-ea segment src opcode)
2653            (emit-byte segment index))
2654           (t
2655            (maybe-emit-rex-for-ea segment src index)
2656            (emit-byte segment #b00001111)
2657            (emit-byte segment (dpb opcode (byte 3 3) #b10000011))
2658            (emit-ea segment src (reg-tn-encoding index))))))
2659
2660 (eval-when (:compile-toplevel :execute)
2661   (defun bit-test-inst-printer-list (subop)
2662     `((ext-reg/mem-imm ((op (#b1011101 ,subop))
2663                         (reg/mem nil :type reg/mem)
2664                         (imm nil :type imm-byte)
2665                         (width 0)))
2666       (ext-reg-reg/mem ((op ,(dpb subop (byte 3 2) #b1000001))
2667                         (width 1))
2668                        (:name :tab reg/mem ", " reg)))))
2669
2670 (define-instruction bt (segment src index)
2671   (:printer-list (bit-test-inst-printer-list #b100))
2672   (:emitter
2673    (emit-bit-test-and-mumble segment src index #b100)))
2674
2675 (define-instruction btc (segment src index)
2676   (:printer-list (bit-test-inst-printer-list #b111))
2677   (:emitter
2678    (emit-bit-test-and-mumble segment src index #b111)))
2679
2680 (define-instruction btr (segment src index)
2681   (:printer-list (bit-test-inst-printer-list #b110))
2682   (:emitter
2683    (emit-bit-test-and-mumble segment src index #b110)))
2684
2685 (define-instruction bts (segment src index)
2686   (:printer-list (bit-test-inst-printer-list #b101))
2687   (:emitter
2688    (emit-bit-test-and-mumble segment src index #b101)))
2689
2690 \f
2691 ;;;; control transfer
2692
2693 (define-instruction call (segment where)
2694   (:printer near-jump ((op #b11101000)))
2695   (:printer reg/mem-default-qword ((op '(#b11111111 #b010))))
2696   (:printer rex-reg/mem-default-qword ((op '(#b11111111 #b010))))
2697   (:emitter
2698    (typecase where
2699      (label
2700       (emit-byte segment #b11101000) ; 32 bit relative
2701       (emit-back-patch segment
2702                        4
2703                        (lambda (segment posn)
2704                          (emit-signed-dword segment
2705                                             (- (label-position where)
2706                                                (+ posn 4))))))
2707      (fixup
2708       ;; There is no CALL rel64...
2709       (error "Cannot CALL a fixup: ~S" where))
2710      (t
2711       (maybe-emit-rex-for-ea segment where nil :operand-size :do-not-set)
2712       (emit-byte segment #b11111111)
2713       (emit-ea segment where #b010)))))
2714
2715 (defun emit-byte-displacement-backpatch (segment target)
2716   (emit-back-patch segment
2717                    1
2718                    (lambda (segment posn)
2719                      (let ((disp (- (label-position target) (1+ posn))))
2720                        (aver (<= -128 disp 127))
2721                        (emit-byte segment disp)))))
2722
2723 (define-instruction jmp (segment cond &optional where)
2724   ;; conditional jumps
2725   (:printer short-cond-jump ((op #b0111)) '('j cc :tab label))
2726   (:printer near-cond-jump () '('j cc :tab label))
2727   ;; unconditional jumps
2728   (:printer short-jump ((op #b1011)))
2729   (:printer near-jump ((op #b11101001)))
2730   (:printer reg/mem-default-qword ((op '(#b11111111 #b100))))
2731   (:printer rex-reg/mem-default-qword ((op '(#b11111111 #b100))))
2732   (:emitter
2733    (cond (where
2734           (emit-chooser
2735            segment 6 2
2736            (lambda (segment posn delta-if-after)
2737              (let ((disp (- (label-position where posn delta-if-after)
2738                             (+ posn 2))))
2739                (when (<= -128 disp 127)
2740                  (emit-byte segment
2741                             (dpb (conditional-opcode cond)
2742                                  (byte 4 0)
2743                                  #b01110000))
2744                  (emit-byte-displacement-backpatch segment where)
2745                  t)))
2746            (lambda (segment posn)
2747              (let ((disp (- (label-position where) (+ posn 6))))
2748                (emit-byte segment #b00001111)
2749                (emit-byte segment
2750                           (dpb (conditional-opcode cond)
2751                                (byte 4 0)
2752                                #b10000000))
2753                (emit-signed-dword segment disp)))))
2754          ((label-p (setq where cond))
2755           (emit-chooser
2756            segment 5 0
2757            (lambda (segment posn delta-if-after)
2758              (let ((disp (- (label-position where posn delta-if-after)
2759                             (+ posn 2))))
2760                (when (<= -128 disp 127)
2761                  (emit-byte segment #b11101011)
2762                  (emit-byte-displacement-backpatch segment where)
2763                  t)))
2764            (lambda (segment posn)
2765              (let ((disp (- (label-position where) (+ posn 5))))
2766                (emit-byte segment #b11101001)
2767                (emit-signed-dword segment disp)))))
2768          ((fixup-p where)
2769           (emit-byte segment #b11101001)
2770           (emit-relative-fixup segment where))
2771          (t
2772           (unless (or (ea-p where) (tn-p where))
2773             (error "don't know what to do with ~A" where))
2774           ;; near jump defaults to 64 bit
2775           ;; w-bit in rex prefix is unnecessary
2776           (maybe-emit-rex-for-ea segment where nil :operand-size :do-not-set)
2777           (emit-byte segment #b11111111)
2778           (emit-ea segment where #b100)))))
2779
2780 (define-instruction ret (segment &optional stack-delta)
2781   (:printer byte ((op #b11000011)))
2782   (:printer byte ((op #b11000010) (imm nil :type 'imm-word-16))
2783             '(:name :tab imm))
2784   (:emitter
2785    (cond ((and stack-delta (not (zerop stack-delta)))
2786           (emit-byte segment #b11000010)
2787           (emit-word segment stack-delta))
2788          (t
2789           (emit-byte segment #b11000011)))))
2790
2791 (define-instruction jrcxz (segment target)
2792   (:printer short-jump ((op #b0011)))
2793   (:emitter
2794    (emit-byte segment #b11100011)
2795    (emit-byte-displacement-backpatch segment target)))
2796
2797 (define-instruction loop (segment target)
2798   (:printer short-jump ((op #b0010)))
2799   (:emitter
2800    (emit-byte segment #b11100010)       ; pfw this was 11100011, or jecxz!!!!
2801    (emit-byte-displacement-backpatch segment target)))
2802
2803 (define-instruction loopz (segment target)
2804   (:printer short-jump ((op #b0001)))
2805   (:emitter
2806    (emit-byte segment #b11100001)
2807    (emit-byte-displacement-backpatch segment target)))
2808
2809 (define-instruction loopnz (segment target)
2810   (:printer short-jump ((op #b0000)))
2811   (:emitter
2812    (emit-byte segment #b11100000)
2813    (emit-byte-displacement-backpatch segment target)))
2814 \f
2815 ;;;; conditional move
2816 (define-instruction cmov (segment cond dst src)
2817   (:printer cond-move ())
2818   (:printer rex-cond-move ())
2819   (:emitter
2820    (aver (register-p dst))
2821    (let ((size (matching-operand-size dst src)))
2822      (aver (or (eq size :word) (eq size :dword) (eq size :qword)))
2823      (maybe-emit-operand-size-prefix segment size))
2824    (maybe-emit-rex-for-ea segment src dst)
2825    (emit-byte segment #b00001111)
2826    (emit-byte segment (dpb (conditional-opcode cond) (byte 4 0) #b01000000))
2827    (emit-ea segment src (reg-tn-encoding dst))))
2828
2829 ;;;; conditional byte set
2830
2831 (define-instruction set (segment dst cond)
2832   (:printer cond-set ())
2833   (:emitter
2834    (maybe-emit-rex-for-ea segment dst nil)
2835    (emit-byte segment #b00001111)
2836    (emit-byte segment (dpb (conditional-opcode cond) (byte 4 0) #b10010000))
2837    (emit-ea segment dst #b000)))
2838 \f
2839 ;;;; enter/leave
2840
2841 (define-instruction enter (segment disp &optional (level 0))
2842   (:declare (type (unsigned-byte 16) disp)
2843             (type (unsigned-byte 8) level))
2844   (:printer enter-format ((op #b11001000)))
2845   (:emitter
2846    (emit-byte segment #b11001000)
2847    (emit-word segment disp)
2848    (emit-byte segment level)))
2849
2850 (define-instruction leave (segment)
2851   (:printer byte ((op #b11001001)))
2852   (:emitter
2853    (emit-byte segment #b11001001)))
2854 \f
2855 ;;;; interrupt instructions
2856
2857 (defun snarf-error-junk (sap offset &optional length-only)
2858   (let* ((length (sb!sys:sap-ref-8 sap offset))
2859          (vector (make-array length :element-type '(unsigned-byte 8))))
2860     (declare (type sb!sys:system-area-pointer sap)
2861              (type (unsigned-byte 8) length)
2862              (type (simple-array (unsigned-byte 8) (*)) vector))
2863     (cond (length-only
2864            (values 0 (1+ length) nil nil))
2865           (t
2866            (sb!kernel:copy-ub8-from-system-area sap (1+ offset)
2867                                                 vector 0 length)
2868            (collect ((sc-offsets)
2869                      (lengths))
2870              (lengths 1)                ; the length byte
2871              (let* ((index 0)
2872                     (error-number (sb!c:read-var-integer vector index)))
2873                (lengths index)
2874                (loop
2875                  (when (>= index length)
2876                    (return))
2877                  (let ((old-index index))
2878                    (sc-offsets (sb!c:read-var-integer vector index))
2879                    (lengths (- index old-index))))
2880                (values error-number
2881                        (1+ length)
2882                        (sc-offsets)
2883                        (lengths))))))))
2884
2885 #|
2886 (defmacro break-cases (breaknum &body cases)
2887   (let ((bn-temp (gensym)))
2888     (collect ((clauses))
2889       (dolist (case cases)
2890         (clauses `((= ,bn-temp ,(car case)) ,@(cdr case))))
2891       `(let ((,bn-temp ,breaknum))
2892          (cond ,@(clauses))))))
2893 |#
2894
2895 (defun break-control (chunk inst stream dstate)
2896   (declare (ignore inst))
2897   (flet ((nt (x) (if stream (sb!disassem:note x dstate))))
2898     ;; FIXME: Make sure that BYTE-IMM-CODE is defined. The genesis
2899     ;; map has it undefined; and it should be easier to look in the target
2900     ;; Lisp (with (DESCRIBE 'BYTE-IMM-CODE)) than to definitively deduce
2901     ;; from first principles whether it's defined in some way that genesis
2902     ;; can't grok.
2903     (case #!-darwin (byte-imm-code chunk dstate)
2904           #!+darwin (word-imm-code chunk dstate)
2905       (#.error-trap
2906        (nt "error trap")
2907        (sb!disassem:handle-break-args #'snarf-error-junk stream dstate))
2908       (#.cerror-trap
2909        (nt "cerror trap")
2910        (sb!disassem:handle-break-args #'snarf-error-junk stream dstate))
2911       (#.breakpoint-trap
2912        (nt "breakpoint trap"))
2913       (#.pending-interrupt-trap
2914        (nt "pending interrupt trap"))
2915       (#.halt-trap
2916        (nt "halt trap"))
2917       (#.fun-end-breakpoint-trap
2918        (nt "function end breakpoint trap"))
2919       (#.single-step-around-trap
2920        (nt "single-step trap (around)"))
2921       (#.single-step-before-trap
2922        (nt "single-step trap (before)")))))
2923
2924 (define-instruction break (segment code)
2925   (:declare (type (unsigned-byte 8) code))
2926   #!-darwin (:printer byte-imm ((op #b11001100)) '(:name :tab code)
2927                      :control #'break-control)
2928   #!+darwin (:printer word-imm ((op #b0000101100001111)) '(:name :tab code)
2929                      :control #'break-control)
2930   (:emitter
2931    #!-darwin (emit-byte segment #b11001100)
2932    ;; On darwin, trap handling via SIGTRAP is unreliable, therefore we
2933    ;; throw a sigill with 0x0b0f instead and check for this in the
2934    ;; SIGILL handler and pass it on to the sigtrap handler if
2935    ;; appropriate
2936    #!+darwin (emit-word segment #b0000101100001111)
2937    (emit-byte segment code)))
2938
2939 (define-instruction int (segment number)
2940   (:declare (type (unsigned-byte 8) number))
2941   (:printer byte-imm ((op #b11001101)))
2942   (:emitter
2943    (etypecase number
2944      ((member 3)
2945       (emit-byte segment #b11001100))
2946      ((unsigned-byte 8)
2947       (emit-byte segment #b11001101)
2948       (emit-byte segment number)))))
2949
2950 (define-instruction iret (segment)
2951   (:printer byte ((op #b11001111)))
2952   (:emitter
2953    (emit-byte segment #b11001111)))
2954 \f
2955 ;;;; processor control
2956
2957 (define-instruction hlt (segment)
2958   (:printer byte ((op #b11110100)))
2959   (:emitter
2960    (emit-byte segment #b11110100)))
2961
2962 (define-instruction nop (segment)
2963   (:printer byte ((op #b10010000)))
2964   (:emitter
2965    (emit-byte segment #b10010000)))
2966
2967 (define-instruction wait (segment)
2968   (:printer byte ((op #b10011011)))
2969   (:emitter
2970    (emit-byte segment #b10011011)))
2971
2972 (defun emit-prefix (segment name)
2973   (declare (ignorable segment))
2974   (ecase name
2975     ((nil))
2976     (:lock
2977      #!+sb-thread
2978      (emit-byte segment #xf0))))
2979
2980 ;;; FIXME: It would be better to make the disassembler understand the prefix as part
2981 ;;; of the instructions...
2982 (define-instruction lock (segment)
2983   (:printer byte ((op #b11110000)))
2984   (:emitter
2985    (bug "LOCK prefix used as a standalone instruction")))
2986 \f
2987 ;;;; miscellaneous hackery
2988
2989 (define-instruction byte (segment byte)
2990   (:emitter
2991    (emit-byte segment byte)))
2992
2993 (define-instruction word (segment word)
2994   (:emitter
2995    (emit-word segment word)))
2996
2997 (define-instruction dword (segment dword)
2998   (:emitter
2999    (emit-dword segment dword)))
3000
3001 (defun emit-header-data (segment type)
3002   (emit-back-patch segment
3003                    n-word-bytes
3004                    (lambda (segment posn)
3005                      (emit-qword segment
3006                                  (logior type
3007                                          (ash (+ posn
3008                                                  (component-header-length))
3009                                               (- n-widetag-bits
3010                                                  word-shift)))))))
3011
3012 (define-instruction simple-fun-header-word (segment)
3013   (:emitter
3014    (emit-header-data segment simple-fun-header-widetag)))
3015
3016 (define-instruction lra-header-word (segment)
3017   (:emitter
3018    (emit-header-data segment return-pc-header-widetag)))
3019 \f
3020 ;;;; Instructions required to do floating point operations using SSE
3021
3022 (defun emit-sse-inst (segment dst src prefix opcode &key operand-size)
3023   (when prefix
3024     (emit-byte segment prefix))
3025   (if operand-size
3026       (maybe-emit-rex-for-ea segment src dst :operand-size operand-size)
3027       (maybe-emit-rex-for-ea segment src dst))
3028   (emit-byte segment #x0f)
3029   (emit-byte segment opcode)
3030   (emit-ea segment src (reg-tn-encoding dst)))
3031
3032 ;; 0110 0110:0000 1111:0111 00gg: 11 010 xmmreg:imm8
3033
3034 (defun emit-sse-inst-with-imm (segment dst/src imm
3035                                prefix opcode /i
3036                                &key operand-size)
3037   (aver (<= 0 /i 7))
3038   (when prefix
3039     (emit-byte segment prefix))
3040   (maybe-emit-rex-prefix segment operand-size dst/src nil nil)
3041   (emit-byte segment #x0F)
3042   (emit-byte segment opcode)
3043   (emit-byte segment (logior (ash (logior #b11000 /i) 3)
3044                              (reg-tn-encoding dst/src)))
3045   (emit-byte segment imm))
3046
3047 (macrolet
3048     ((define-imm-sse-instruction (name opcode /i)
3049          `(define-instruction ,name (segment dst/src imm)
3050             (:printer ext-rex-xmm-imm ((prefix #x66) (op ,opcode) (/i ,/i)))
3051             (:printer ext-xmm-imm ((prefix #x66) (op ,opcode) (/i ,/i)))
3052             (:emitter
3053              (emit-sse-inst-with-imm segment dst/src imm
3054                                      #x66 ,opcode ,/i
3055                                      :operand-size :do-not-set)))))
3056   (define-imm-sse-instruction pslldq #x73 7)
3057   (define-imm-sse-instruction psllw #x71 6)
3058   (define-imm-sse-instruction pslld #x72 6)
3059   (define-imm-sse-instruction psllq #x73 6)
3060
3061   (define-imm-sse-instruction psraw-imm #x71 4)
3062   (define-imm-sse-instruction psrad-imm #x72 4)
3063
3064   (define-imm-sse-instruction psrldq #x73 3)
3065   (define-imm-sse-instruction psrlw #x71 2)
3066   (define-imm-sse-instruction psrld #x72 2)
3067   (define-imm-sse-instruction psrlq #x73 2))
3068
3069 ;;; Emit an SSE instruction that has an XMM register as the destination
3070 ;;; operand and for which the size of the operands is implicitly given
3071 ;;; by the instruction.
3072 (defun emit-regular-sse-inst (segment dst src prefix opcode)
3073   (aver (xmm-register-p dst))
3074   (emit-sse-inst segment dst src prefix opcode
3075                  :operand-size :do-not-set))
3076
3077 ;;; Instructions having an XMM register as the destination operand
3078 ;;; and an XMM register or a memory location as the source operand.
3079 ;;; The operand size is implicitly given by the instruction.
3080
3081 (macrolet ((define-regular-sse-inst (name prefix opcode)
3082              `(define-instruction ,name (segment dst src)
3083                 ,@(if prefix
3084                       `((:printer ext-xmm-xmm/mem
3085                                   ((prefix ,prefix) (op ,opcode)))
3086                         (:printer ext-rex-xmm-xmm/mem
3087                                   ((prefix ,prefix) (op ,opcode))))
3088                       `((:printer xmm-xmm/mem ((op ,opcode)))
3089                         (:printer rex-xmm-xmm/mem ((op ,opcode)))))
3090                 (:emitter
3091                  (emit-regular-sse-inst segment dst src ,prefix ,opcode)))))
3092   ;; logical
3093   (define-regular-sse-inst andpd    #x66 #x54)
3094   (define-regular-sse-inst andps    nil  #x54)
3095   (define-regular-sse-inst andnpd   #x66 #x55)
3096   (define-regular-sse-inst andnps   nil  #x55)
3097   (define-regular-sse-inst orpd     #x66 #x56)
3098   (define-regular-sse-inst orps     nil  #x56)
3099   (define-regular-sse-inst pand     #x66 #xdb)
3100   (define-regular-sse-inst pandn    #x66 #xdf)
3101   (define-regular-sse-inst por      #x66 #xeb)
3102   (define-regular-sse-inst pxor     #x66 #xef)
3103   (define-regular-sse-inst xorpd    #x66 #x57)
3104   (define-regular-sse-inst xorps    nil  #x57)
3105   ;; comparison
3106   (define-regular-sse-inst comisd   #x66 #x2f)
3107   (define-regular-sse-inst comiss   nil  #x2f)
3108   (define-regular-sse-inst ucomisd  #x66 #x2e)
3109   (define-regular-sse-inst ucomiss  nil  #x2e)
3110   ;; integer comparison
3111   (define-regular-sse-inst pcmpeqb  #x66 #x74)
3112   (define-regular-sse-inst pcmpeqw  #x66 #x75)
3113   (define-regular-sse-inst pcmpeqd  #x66 #x76)
3114   (define-regular-sse-inst pcmpgtb  #x66 #x64)
3115   (define-regular-sse-inst pcmpgtw  #x66 #x65)
3116   (define-regular-sse-inst pcmpgtd  #x66 #x66)
3117   ;; max/min
3118   (define-regular-sse-inst maxpd    #x66 #x5f)
3119   (define-regular-sse-inst maxps    nil  #x5f)
3120   (define-regular-sse-inst maxsd    #xf2 #x5f)
3121   (define-regular-sse-inst maxss    #xf3 #x5f)
3122   (define-regular-sse-inst minpd    #x66 #x5d)
3123   (define-regular-sse-inst minps    nil  #x5d)
3124   (define-regular-sse-inst minsd    #xf2 #x5d)
3125   (define-regular-sse-inst minss    #xf3 #x5d)
3126   ;; integer max/min
3127   (define-regular-sse-inst pmaxsw   #x66 #xee)
3128   (define-regular-sse-inst pmaxub   #x66 #xde)
3129   (define-regular-sse-inst pminsw   #x66 #xea)
3130   (define-regular-sse-inst pminub   #x66 #xda)
3131   ;; arithmetic
3132   (define-regular-sse-inst addpd    #x66 #x58)
3133   (define-regular-sse-inst addps    nil  #x58)
3134   (define-regular-sse-inst addsd    #xf2 #x58)
3135   (define-regular-sse-inst addss    #xf3 #x58)
3136   (define-regular-sse-inst divpd    #x66 #x5e)
3137   (define-regular-sse-inst divps    nil  #x5e)
3138   (define-regular-sse-inst divsd    #xf2 #x5e)
3139   (define-regular-sse-inst divss    #xf3 #x5e)
3140   (define-regular-sse-inst mulpd    #x66 #x59)
3141   (define-regular-sse-inst mulps    nil  #x59)
3142   (define-regular-sse-inst mulsd    #xf2 #x59)
3143   (define-regular-sse-inst mulss    #xf3 #x59)
3144   (define-regular-sse-inst rccps    nil  #x53)
3145   (define-regular-sse-inst rcpss    #xf3 #x53)
3146   (define-regular-sse-inst rsqrtps  nil  #x52)
3147   (define-regular-sse-inst rsqrtss  #xf3 #x52)
3148   (define-regular-sse-inst sqrtps   nil  #x51)
3149   (define-regular-sse-inst sqrtsd   #xf2 #x51)
3150   (define-regular-sse-inst sqrtss   #xf3 #x51)
3151   (define-regular-sse-inst subpd    #x66 #x5c)
3152   (define-regular-sse-inst subps    nil  #x5c)
3153   (define-regular-sse-inst subsd    #xf2 #x5c)
3154   (define-regular-sse-inst subss    #xf3 #x5c)
3155   (define-regular-sse-inst unpckhpd #x66 #x15)
3156   (define-regular-sse-inst unpckhps nil  #x15)
3157   (define-regular-sse-inst unpcklpd #x66 #x14)
3158   (define-regular-sse-inst unpcklps nil  #x14)
3159   ;; integer arithmetic
3160   (define-regular-sse-inst paddb    #x66 #xfc)
3161   (define-regular-sse-inst paddw    #x66 #xfd)
3162   (define-regular-sse-inst paddd    #x66 #xfe)
3163   (define-regular-sse-inst paddq    #x66 #xd4)
3164   (define-regular-sse-inst paddsb   #x66 #xec)
3165   (define-regular-sse-inst paddsw   #x66 #xed)
3166   (define-regular-sse-inst paddusb  #x66 #xdc)
3167   (define-regular-sse-inst padduwb  #x66 #xdd)
3168   (define-regular-sse-inst pavgb    #x66 #xe0)
3169   (define-regular-sse-inst pavgw    #x66 #xe3)
3170   (define-regular-sse-inst pmaddwd  #x66 #xf5)
3171   (define-regular-sse-inst pmulhuw  #x66 #xe4)
3172   (define-regular-sse-inst pmulhw   #x66 #xe5)
3173   (define-regular-sse-inst pmullw   #x66 #xd5)
3174   (define-regular-sse-inst pmuludq  #x66 #xf4)
3175   (define-regular-sse-inst psadbw   #x66 #xf6)
3176   (define-regular-sse-inst psraw    #x66 #xe1)
3177   (define-regular-sse-inst psrad    #x66 #xe2)
3178   (define-regular-sse-inst psubb    #x66 #xf8)
3179   (define-regular-sse-inst psubw    #x66 #xf9)
3180   (define-regular-sse-inst psubd    #x66 #xfa)
3181   (define-regular-sse-inst psubq    #x66 #xfb)
3182   (define-regular-sse-inst psubsb   #x66 #xd8)
3183   (define-regular-sse-inst psubsw   #x66 #xd9)
3184   ;; conversion
3185   (define-regular-sse-inst cvtdq2pd #xf3 #xe6)
3186   (define-regular-sse-inst cvtdq2ps nil  #x5b)
3187   (define-regular-sse-inst cvtpd2dq #xf2 #xe6)
3188   (define-regular-sse-inst cvtpd2ps #x66 #x5a)
3189   (define-regular-sse-inst cvtps2dq #x66 #x5b)
3190   (define-regular-sse-inst cvtps2pd nil  #x5a)
3191   (define-regular-sse-inst cvtsd2ss #xf2 #x5a)
3192   (define-regular-sse-inst cvtss2sd #xf3 #x5a)
3193   (define-regular-sse-inst cvttpd2dq #x66 #xe6)
3194   (define-regular-sse-inst cvttps2dq #xf3 #x5b)
3195   ;; moves
3196   (define-regular-sse-inst movntdq #x66 #xe7)
3197   (define-regular-sse-inst movntpd #x66 #x2b)
3198   (define-regular-sse-inst movntps nil #x2b)
3199   ;; integer
3200   (define-regular-sse-inst packsswb  #x66 #x63)
3201   (define-regular-sse-inst packssdw  #x66 #x6b)
3202   (define-regular-sse-inst punpckhbw #x66 #x68)
3203   (define-regular-sse-inst punpckhwd #x66 #x69)
3204   (define-regular-sse-inst punpckhdq #x66 #x6a)
3205   (define-regular-sse-inst punpckhqdq #x66 #x6d)
3206   (define-regular-sse-inst punpcklbw #x66 #x60)
3207   (define-regular-sse-inst punpcklwd #x66 #x61)
3208   (define-regular-sse-inst punpckldq #x66 #x62)
3209   (define-regular-sse-inst punpcklqdq #x66 #x6c))
3210
3211 (macrolet ((define-xmm-shuffle-sse-inst (name prefix opcode)
3212                `(define-instruction ,name (segment dst src pattern)
3213                   ,@(if prefix
3214                         `((:printer ext-xmm-xmm/mem-imm ; suboptimal
3215                                     ((prefix ,prefix) (op ,opcode)))
3216                           (:printer ext-rex-xmm-xmm/mem-imm
3217                                     ((prefix ,prefix) (op ,opcode))))
3218                         `((:printer xmm-xmm/mem-imm ((op ,opcode)))
3219                           (:printer rex-xmm-xmm/mem-imm ((op ,opcode)))))
3220                   (:emitter
3221                    (aver (typep pattern '(unsigned-byte 8)))
3222                    (emit-regular-sse-inst segment dst src ,prefix ,opcode)
3223                    (emit-byte segment pattern)))))
3224   (define-xmm-shuffle-sse-inst pshufd  #x66 #x70)
3225   (define-xmm-shuffle-sse-inst pshufhw #xf3 #x70)
3226   (define-xmm-shuffle-sse-inst pshuflw #xf2 #x70)
3227   (define-xmm-shuffle-sse-inst shufpd  #x66 #xc6)
3228   (define-xmm-shuffle-sse-inst shufps  nil  #xc6))
3229
3230 ;; MASKMOVDQU (dst is DS:RDI)
3231 (define-instruction maskmovdqu (segment src mask)
3232   (:printer ext-xmm-xmm/mem
3233             ((prefix #x66) (op #xf7)))
3234   (:printer ext-rex-xmm-xmm/mem
3235             ((prefix #x66) (op #xf7)))
3236   (:emitter
3237    (aver (xmm-register-p src))
3238    (aver (xmm-register-p mask))
3239    (emit-regular-sse-inst segment src mask #x66 #xf7)))
3240
3241 (macrolet ((define-xmm-comparison-sse-inst (name prefix opcode &optional name-prefix name-suffix)
3242                (let ((printer (when name-prefix
3243                                 `'(,name-prefix cc ,name-suffix :tab reg ", " reg/mem))))
3244                  `(define-instruction ,name (segment op x y)
3245                     ,@(if prefix
3246                           `((:printer ext-xmm-xmm/mem-cmp
3247                                       ((prefix ,prefix) (op ,opcode))
3248                                       ,@(and printer `(,printer)))
3249                             (:printer ext-rex-xmm-xmm/mem-cmp
3250                                       ((prefix ,prefix) (op ,opcode))
3251                                       ,@(and printer `(,printer))))
3252                           `((:printer xmm-xmm/mem-cmp ((op ,opcode))
3253                                       ,@(and printer `(,printer)))
3254                             (:printer rex-xmm-xmm/mem-cmp ((op ,opcode))
3255                                       ,@(and printer `(,printer)))))
3256                     (:emitter
3257                      (let ((code (position op *sse-conditions*)))
3258                        (aver code)
3259                        (emit-regular-sse-inst segment x y ,prefix ,opcode)
3260                        (emit-byte segment code)))))))
3261   (define-xmm-comparison-sse-inst cmppd #x66 #xc2 "CMP" "PD")
3262   (define-xmm-comparison-sse-inst cmpps nil  #xc2 "CMP" "PS")
3263   (define-xmm-comparison-sse-inst cmpsd #xf2 #xc2 "CMP" "SD")
3264   (define-xmm-comparison-sse-inst cmpss #xf3 #xc2 "CMP" "SS"))
3265
3266 ;;; MOVSD, MOVSS
3267 (macrolet ((define-movsd/ss-sse-inst (name prefix)
3268              `(define-instruction ,name (segment dst src)
3269                 (:printer ext-xmm-xmm/mem-dir ((prefix ,prefix)
3270                                                (op #b0001000)))
3271                 (:printer ext-rex-xmm-xmm/mem-dir ((prefix ,prefix)
3272                                                    (op #b0001000)))
3273                 (:emitter
3274                  (cond ((xmm-register-p dst)
3275                         (emit-sse-inst segment dst src ,prefix #x10
3276                                        :operand-size :do-not-set))
3277                        (t
3278                         (aver (xmm-register-p src))
3279                         (emit-sse-inst segment src dst ,prefix #x11
3280                                        :operand-size :do-not-set)))))))
3281   (define-movsd/ss-sse-inst movsd #xf2)
3282   (define-movsd/ss-sse-inst movss #xf3))
3283
3284 ;;; Packed MOVs
3285 (macrolet ((define-mov-sse-inst (name prefix opcode-from opcode-to
3286                                       &key force-to-mem reg-reg-name)
3287                `(progn
3288                   ,(when reg-reg-name
3289                      `(define-instruction ,reg-reg-name (segment dst src)
3290                         (:emitter
3291                          (aver (xmm-register-p dst))
3292                          (aver (xmm-register-p src))
3293                          (emit-regular-sse-inst segment dst src ,prefix ,opcode-from))))
3294                   (define-instruction ,name (segment dst src)
3295                     ,@(if prefix
3296                           `((:printer ext-xmm-xmm/mem
3297                                       ((prefix ,prefix) (op ,opcode-from)))
3298                             (:printer ext-rex-xmm-xmm/mem
3299                                       ((prefix ,prefix) (op ,opcode-from)))
3300                             (:printer ext-xmm-xmm/mem
3301                                       ((prefix ,prefix) (op ,opcode-to))
3302                                       '(:name :tab reg/mem ", " reg))
3303                             (:printer ext-rex-xmm-xmm/mem
3304                                       ((prefix ,prefix) (op ,opcode-to))
3305                                       '(:name :tab reg/mem ", " reg)))
3306                           `((:printer xmm-xmm/mem
3307                                       ((op ,opcode-from)))
3308                             (:printer rex-xmm-xmm/mem
3309                                       ((op ,opcode-from)))
3310                             (:printer xmm-xmm/mem
3311                                       ((op ,opcode-to))
3312                                       '(:name :tab reg/mem ", " reg))
3313                             (:printer rex-xmm-xmm/mem
3314                                       ((op ,opcode-to))
3315                                       '(:name :tab reg/mem ", " reg))))
3316                     (:emitter
3317                      (cond ((xmm-register-p dst)
3318                             ,(when force-to-mem
3319                                `(aver (not (or (register-p src)
3320                                                (xmm-register-p src)))))
3321                             (emit-regular-sse-inst segment dst src ,prefix ,opcode-from))
3322                            (t
3323                             (aver (xmm-register-p src))
3324                             ,(when force-to-mem
3325                                `(aver (not (or (register-p dst)
3326                                                (xmm-register-p dst)))))
3327                             (emit-regular-sse-inst segment src dst ,prefix ,opcode-to))))))))
3328   ;; direction bit?
3329   (define-mov-sse-inst movapd #x66 #x28 #x29)
3330   (define-mov-sse-inst movaps nil  #x28 #x29)
3331   (define-mov-sse-inst movdqa #x66 #x6f #x7f)
3332   (define-mov-sse-inst movdqu #xf3 #x6f #x7f)
3333
3334   ;; use movhps for movlhps and movlps for movhlps
3335   (define-mov-sse-inst movhpd #x66 #x16 #x17 :force-to-mem t)
3336   (define-mov-sse-inst movhps nil  #x16 #x17 :reg-reg-name movlhps)
3337   (define-mov-sse-inst movlpd #x66 #x12 #x13 :force-to-mem t)
3338   (define-mov-sse-inst movlps nil  #x12 #x13 :reg-reg-name movhlps)
3339   (define-mov-sse-inst movupd #x66 #x10 #x11)
3340   (define-mov-sse-inst movups nil  #x10 #x11))
3341
3342 ;;; MOVQ
3343 (define-instruction movq (segment dst src)
3344   (:printer ext-xmm-xmm/mem ((prefix #xf3) (op #x7e)))
3345   (:printer ext-rex-xmm-xmm/mem ((prefix #xf3) (op #x7e)))
3346   (:printer ext-xmm-xmm/mem ((prefix #x66) (op #xd6))
3347             '(:name :tab reg/mem ", " reg))
3348   (:printer ext-rex-xmm-xmm/mem ((prefix #x66) (op #xd6))
3349             '(:name :tab reg/mem ", " reg))
3350   (:emitter
3351    (cond ((xmm-register-p dst)
3352           (emit-sse-inst segment dst src #xf3 #x7e
3353                          :operand-size :do-not-set))
3354          (t
3355           (aver (xmm-register-p src))
3356           (emit-sse-inst segment src dst #x66 #xd6
3357                          :operand-size :do-not-set)))))
3358
3359 ;;; Instructions having an XMM register as the destination operand
3360 ;;; and a general-purpose register or a memory location as the source
3361 ;;; operand. The operand size is calculated from the source operand.
3362
3363 ;;; MOVD - Move a 32- or 64-bit value from a general-purpose register or
3364 ;;; a memory location to the low order 32 or 64 bits of an XMM register
3365 ;;; with zero extension or vice versa.
3366 ;;; We do not support the MMX version of this instruction.
3367 (define-instruction movd (segment dst src)
3368   (:printer ext-xmm-reg/mem ((prefix #x66) (op #x6e)))
3369   (:printer ext-rex-xmm-reg/mem ((prefix #x66) (op #x6e)))
3370   (:printer ext-xmm-reg/mem ((prefix #x66) (op #x7e))
3371             '(:name :tab reg/mem ", " reg))
3372   (:printer ext-rex-xmm-reg/mem ((prefix #x66) (op #x7e))
3373             '(:name :tab reg/mem ", " reg))
3374   (:emitter
3375    (cond ((xmm-register-p dst)
3376           (emit-sse-inst segment dst src #x66 #x6e))
3377          (t
3378           (aver (xmm-register-p src))
3379           (emit-sse-inst segment src dst #x66 #x7e)))))
3380
3381 (macrolet ((define-integer-source-sse-inst (name prefix opcode &key mem-only)
3382              `(define-instruction ,name (segment dst src)
3383                 ,@(if prefix
3384                       `((:printer ext-xmm-reg/mem ((prefix ,prefix) (op ,opcode)))
3385                         (:printer ext-rex-xmm-reg/mem ((prefix ,prefix) (op ,opcode))))
3386                       `((:printer xmm-reg/mem ((op ,opcode)))
3387                         (:printer rex-xmm-reg/mem ((op ,opcode)))))
3388
3389                 (:emitter
3390                  (aver (xmm-register-p dst))
3391                  ,(when mem-only
3392                     `(aver (not (or (register-p src)
3393                                     (xmm-register-p src)))))
3394                  (let ((src-size (operand-size src)))
3395                    (aver (or (eq src-size :qword) (eq src-size :dword))))
3396                  (emit-sse-inst segment dst src ,prefix ,opcode)))))
3397   (define-integer-source-sse-inst cvtsi2sd #xf2 #x2a)
3398   (define-integer-source-sse-inst cvtsi2ss #xf3 #x2a)
3399   ;; FIXME: memory operand is always a QWORD
3400   (define-integer-source-sse-inst cvtpi2pd #x66 #x2a :mem-only t)
3401   (define-integer-source-sse-inst cvtpi2ps nil  #x2a :mem-only t))
3402
3403 ;;; Instructions having a general-purpose register as the destination
3404 ;;; operand and an XMM register or a memory location as the source
3405 ;;; operand. The operand size is calculated from the destination
3406 ;;; operand.
3407
3408 (macrolet ((define-gpr-destination-sse-inst (name prefix opcode &key reg-only)
3409              `(define-instruction ,name (segment dst src)
3410                 ,@(if prefix
3411                       `((:printer ext-reg-xmm/mem ((prefix ,prefix) (op ,opcode)))
3412                         (:printer ext-rex-reg-xmm/mem ((prefix ,prefix) (op ,opcode))))
3413                       `((:printer reg-xmm/mem ((op ,opcode)))
3414                         (:printer rex-reg-xmm/mem ((op ,opcode)))))
3415                 (:emitter
3416                  (aver (register-p dst))
3417                  ,(when reg-only
3418                     `(aver (xmm-register-p src)))
3419                  (let ((dst-size (operand-size dst)))
3420                    (aver (or (eq dst-size :qword) (eq dst-size :dword)))
3421                    (emit-sse-inst segment dst src ,prefix ,opcode
3422                                   :operand-size dst-size))))))
3423   (define-gpr-destination-sse-inst cvtsd2si  #xf2 #x2d)
3424   (define-gpr-destination-sse-inst cvtss2si  #xf3 #x2d)
3425   (define-gpr-destination-sse-inst cvttsd2si #xf2 #x2c)
3426   (define-gpr-destination-sse-inst cvttss2si #xf3 #x2c)
3427   (define-gpr-destination-sse-inst movmskpd  #x66 #x50 :reg-only t)
3428   (define-gpr-destination-sse-inst movmskps  nil  #x50 :reg-only t)
3429   (define-gpr-destination-sse-inst pmovmskb  #x66 #xd7 :reg-only t))
3430
3431 ;;; Other SSE instructions
3432
3433 ;; FIXME: is that right!?
3434 (define-instruction movnti (segment dst src)
3435   (:printer ext-reg-reg/mem-no-width ((op #xc3)))
3436   (:printer rex-ext-reg-reg/mem-no-width ((op #xc3)))
3437   (:emitter
3438    (aver (not (or (register-p dst)
3439                   (xmm-register-p dst))))
3440    (aver (register-p src))
3441    (maybe-emit-rex-for-ea segment src dst)
3442    (emit-byte segment #x0f)
3443    (emit-byte segment #xc3)
3444    (emit-ea segment dst (reg-tn-encoding src))))
3445
3446 (define-instruction prefetch (segment type src)
3447   (:printer ext-reg/mem-no-width ((op '(#x18 0)))
3448             '("PREFETCHNTA" :tab reg/mem))
3449   (:printer ext-reg/mem-no-width ((op '(#x18 1)))
3450             '("PREFETCHT0" :tab reg/mem))
3451   (:printer ext-reg/mem-no-width ((op '(#x18 2)))
3452             '("PREFETCHT1" :tab reg/mem))
3453   (:printer ext-reg/mem-no-width ((op '(#x18 3)))
3454             '("PREFETCHT2" :tab reg/mem))
3455   (:printer rex-ext-reg/mem-no-width ((op '(#x18 0)))
3456             '("PREFETCHNTA" :tab reg/mem))
3457   (:printer rex-ext-reg/mem-no-width ((op '(#x18 1)))
3458             '("PREFETCHT0" :tab reg/mem))
3459   (:printer rex-ext-reg/mem-no-width ((op '(#x18 2)))
3460             '("PREFETCHT1" :tab reg/mem))
3461   (:printer rex-ext-reg/mem-no-width ((op '(#x18 3)))
3462             '("PREFETCHT2" :tab reg/mem))
3463   (:emitter
3464    (aver (not (or (register-p src)
3465                   (xmm-register-p src))))
3466    (aver (eq (operand-size src) :byte))
3467    (let ((type (position type #(:nta :t0 :t1 :t2))))
3468      (aver type)
3469      (maybe-emit-rex-for-ea segment src nil)
3470      (emit-byte segment #x0f)
3471      (emit-byte segment #x18)
3472      (emit-ea segment src type))))
3473
3474 (define-instruction clflush (segment src)
3475   (:printer ext-reg/mem-no-width ((op '(#xae 7))))
3476   (:printer rex-ext-reg/mem-no-width ((op '(#xae 7))))
3477   (:emitter
3478    (aver (not (or (register-p src)
3479                   (xmm-register-p src))))
3480    (aver (eq (operand-size src) :byte))
3481    (maybe-emit-rex-for-ea segment src nil)
3482    (emit-byte segment #x0f)
3483    (emit-byte segment #x18)
3484    (emit-ea segment src 7)))
3485
3486 (macrolet ((define-fence-instruction (name last-byte)
3487                `(define-instruction ,name (segment)
3488                   (:printer three-bytes ((op '(#x0f #xae ,last-byte))))
3489                   (:emitter
3490                    (emit-byte segment #x0f)
3491                    (emit-byte segment #xae)
3492                    (emit-byte segment ,last-byte)))))
3493   (define-fence-instruction lfence #b11101000)
3494   (define-fence-instruction mfence #b11110000)
3495   (define-fence-instruction sfence #b11111000))
3496
3497 (define-instruction pause (segment)
3498   (:printer two-bytes ((op '(#xf3 #x90))))
3499   (:emitter
3500    (emit-byte segment #xf3)
3501    (emit-byte segment #x90)))
3502
3503 (define-instruction ldmxcsr (segment src)
3504   (:printer ext-reg/mem-no-width ((op '(#xae 2))))
3505   (:printer rex-ext-reg/mem-no-width ((op '(#xae 2))))
3506   (:emitter
3507    (aver (not (or (register-p src)
3508                   (xmm-register-p src))))
3509    (aver (eq (operand-size src) :dword))
3510    (maybe-emit-rex-for-ea segment src nil)
3511    (emit-byte segment #x0f)
3512    (emit-byte segment #xae)
3513    (emit-ea segment src 2)))
3514
3515 (define-instruction stmxcsr (segment dst)
3516   (:printer ext-reg/mem-no-width ((op '(#xae 3))))
3517   (:printer rex-ext-reg/mem-no-width ((op '(#xae 3))))
3518   (:emitter
3519    (aver (not (or (register-p dst)
3520                   (xmm-register-p dst))))
3521    (aver (eq (operand-size dst) :dword))
3522    (maybe-emit-rex-for-ea segment dst nil)
3523    (emit-byte segment #x0f)
3524    (emit-byte segment #xae)
3525    (emit-ea segment dst 3)))
3526
3527 ;;;; Miscellany
3528
3529 (define-instruction cpuid (segment)
3530   (:printer two-bytes ((op '(#b00001111 #b10100010))))
3531   (:emitter
3532    (emit-byte segment #b00001111)
3533    (emit-byte segment #b10100010)))
3534
3535 (define-instruction rdtsc (segment)
3536   (:printer two-bytes ((op '(#b00001111 #b00110001))))
3537   (:emitter
3538    (emit-byte segment #b00001111)
3539    (emit-byte segment #b00110001)))