Correct RIP-relative offset for strange x86-64 instructions
[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
1128                                           :tab reg ", " reg/mem ", " imm))
1129   (x0f     :field (byte 8 0)    :value #x0f)
1130   (op      :field (byte 8 8))
1131   (reg/mem :fields (list (byte 2 22) (byte 3 16))
1132                                 :type 'xmmreg/mem)
1133   (reg     :field (byte 3 19)   :type 'xmmreg)
1134   (imm     :type 'imm-byte))
1135
1136 (sb!disassem:define-instruction-format (rex-xmm-xmm/mem-imm 32
1137                                         :default-printer
1138                                         '(:name
1139                                           :tab reg ", " reg/mem ", " imm))
1140   (rex     :field (byte 4 4)    :value #b0100)
1141   (wrxb    :field (byte 4 0)    :type 'wrxb)
1142   (x0f     :field (byte 8 8)    :value #x0f)
1143   (op      :field (byte 8 16))
1144   (reg/mem :fields (list (byte 2 30) (byte 3 24))
1145                                 :type 'xmmreg/mem)
1146   (reg     :field (byte 3 27)   :type 'xmmreg)
1147   (imm     :type 'imm-byte))
1148
1149 (sb!disassem:define-instruction-format (ext-xmm-xmm/mem-imm 32
1150                                         :default-printer
1151                                         '(:name
1152                                           :tab reg ", " reg/mem ", " imm))
1153   (prefix  :field (byte 8 0))
1154   (x0f     :field (byte 8 8)    :value #x0f)
1155   (op      :field (byte 8 16))
1156   (reg/mem :fields (list (byte 2 30) (byte 3 24))
1157                                 :type 'xmmreg/mem)
1158   (reg     :field (byte 3 27)   :type 'xmmreg)
1159   (imm     :type 'imm-byte))
1160
1161 (sb!disassem:define-instruction-format (ext-rex-xmm-xmm/mem-imm 40
1162                                         :default-printer
1163                                         '(:name
1164                                           :tab reg ", " reg/mem ", " imm))
1165   (prefix  :field (byte 8 0))
1166   (rex     :field (byte 4 12)   :value #b0100)
1167   (wrxb    :field (byte 4 8)    :type 'wrxb)
1168   (x0f     :field (byte 8 16)   :value #x0f)
1169   (op      :field (byte 8 24))
1170   (reg/mem :fields (list (byte 2 38) (byte 3 32))
1171                                 :type 'xmmreg/mem)
1172   (reg     :field (byte 3 35)   :type 'xmmreg)
1173   (imm     :type 'imm-byte))
1174
1175 (sb!disassem:define-instruction-format (string-op 8
1176                                      :include 'simple
1177                                      :default-printer '(:name width)))
1178
1179 (sb!disassem:define-instruction-format (rex-string-op 16
1180                                      :include 'rex-simple
1181                                      :default-printer '(:name width)))
1182
1183 (sb!disassem:define-instruction-format (short-cond-jump 16)
1184   (op    :field (byte 4 4))
1185   (cc    :field (byte 4 0) :type 'condition-code)
1186   (label :field (byte 8 8) :type 'displacement))
1187
1188 (sb!disassem:define-instruction-format (short-jump 16
1189                                      :default-printer '(:name :tab label))
1190   (const :field (byte 4 4) :value #b1110)
1191   (op    :field (byte 4 0))
1192   (label :field (byte 8 8) :type 'displacement))
1193
1194 (sb!disassem:define-instruction-format (near-cond-jump 16)
1195   (op    :fields (list (byte 8 0) (byte 4 12)) :value '(#b00001111 #b1000))
1196   (cc    :field (byte 4 8) :type 'condition-code)
1197   ;; The disassembler currently doesn't let you have an instruction > 32 bits
1198   ;; long, so we fake it by using a prefilter to read the offset.
1199   (label :type 'displacement
1200          :prefilter (lambda (value dstate)
1201                       (declare (ignore value)) ; always nil anyway
1202                       (sb!disassem:read-signed-suffix 32 dstate))))
1203
1204 (sb!disassem:define-instruction-format (near-jump 8
1205                                      :default-printer '(:name :tab label))
1206   (op    :field (byte 8 0))
1207   ;; The disassembler currently doesn't let you have an instruction > 32 bits
1208   ;; long, so we fake it by using a prefilter to read the address.
1209   (label :type 'displacement
1210          :prefilter (lambda (value dstate)
1211                       (declare (ignore value)) ; always nil anyway
1212                       (sb!disassem:read-signed-suffix 32 dstate))))
1213
1214
1215 (sb!disassem:define-instruction-format (cond-set 24
1216                                      :default-printer '('set cc :tab reg/mem))
1217   (prefix :field (byte 8 0) :value #b00001111)
1218   (op    :field (byte 4 12) :value #b1001)
1219   (cc    :field (byte 4 8) :type 'condition-code)
1220   (reg/mem :fields (list (byte 2 22) (byte 3 16))
1221            :type 'sized-byte-reg/mem)
1222   (reg     :field (byte 3 19)   :value #b000))
1223
1224 (sb!disassem:define-instruction-format (cond-move 24
1225                                      :default-printer
1226                                         '('cmov cc :tab reg ", " reg/mem))
1227   (prefix  :field (byte 8 0)    :value #b00001111)
1228   (op      :field (byte 4 12)   :value #b0100)
1229   (cc      :field (byte 4 8)    :type 'condition-code)
1230   (reg/mem :fields (list (byte 2 22) (byte 3 16))
1231                                 :type 'reg/mem)
1232   (reg     :field (byte 3 19)   :type 'reg))
1233
1234 (sb!disassem:define-instruction-format (rex-cond-move 32
1235                                      :default-printer
1236                                         '('cmov cc :tab reg ", " reg/mem))
1237   (rex     :field (byte 4 4)   :value #b0100)
1238   (wrxb    :field (byte 4 0)    :type 'wrxb)
1239   (prefix  :field (byte 8 8)    :value #b00001111)
1240   (op      :field (byte 4 20)   :value #b0100)
1241   (cc      :field (byte 4 16)    :type 'condition-code)
1242   (reg/mem :fields (list (byte 2 30) (byte 3 24))
1243                                 :type 'reg/mem)
1244   (reg     :field (byte 3 27)   :type 'reg))
1245
1246 (sb!disassem:define-instruction-format (enter-format 32
1247                                      :default-printer '(:name
1248                                                         :tab disp
1249                                                         (:unless (:constant 0)
1250                                                           ", " level)))
1251   (op :field (byte 8 0))
1252   (disp :field (byte 16 8))
1253   (level :field (byte 8 24)))
1254
1255 ;;; Single byte instruction with an immediate byte argument.
1256 (sb!disassem:define-instruction-format (byte-imm 16
1257                                      :default-printer '(:name :tab code))
1258  (op :field (byte 8 0))
1259  (code :field (byte 8 8)))
1260
1261 ;;; Two byte instruction with an immediate byte argument.
1262 ;;;
1263 (sb!disassem:define-instruction-format (word-imm 24
1264                                      :default-printer '(:name :tab code))
1265   (op :field (byte 16 0))
1266   (code :field (byte 8 16)))
1267
1268 \f
1269 ;;;; primitive emitters
1270
1271 (define-bitfield-emitter emit-word 16
1272   (byte 16 0))
1273
1274 (define-bitfield-emitter emit-dword 32
1275   (byte 32 0))
1276
1277 ;;; Most uses of dwords are as displacements or as immediate values in
1278 ;;; 64-bit operations. In these cases they are sign-extended to 64 bits.
1279 ;;; EMIT-DWORD is unsuitable there because it accepts values of type
1280 ;;; (OR (SIGNED-BYTE 32) (UNSIGNED-BYTE 32)), so we provide a more
1281 ;;; restricted emitter here.
1282 (defun emit-signed-dword (segment value)
1283   (declare (type segment segment)
1284            (type (signed-byte 32) value))
1285   (declare (inline emit-dword))
1286   (emit-dword segment value))
1287
1288 (define-bitfield-emitter emit-qword 64
1289   (byte 64 0))
1290
1291 (define-bitfield-emitter emit-byte-with-reg 8
1292   (byte 5 3) (byte 3 0))
1293
1294 (define-bitfield-emitter emit-mod-reg-r/m-byte 8
1295   (byte 2 6) (byte 3 3) (byte 3 0))
1296
1297 (define-bitfield-emitter emit-sib-byte 8
1298   (byte 2 6) (byte 3 3) (byte 3 0))
1299
1300 (define-bitfield-emitter emit-rex-byte 8
1301   (byte 4 4) (byte 1 3) (byte 1 2) (byte 1 1) (byte 1 0))
1302
1303
1304 \f
1305 ;;;; fixup emitters
1306
1307 (defun emit-absolute-fixup (segment fixup &optional quad-p)
1308   (note-fixup segment (if quad-p :absolute64 :absolute) fixup)
1309   (let ((offset (fixup-offset fixup)))
1310     (if (label-p offset)
1311         (emit-back-patch segment
1312                          (if quad-p 8 4)
1313                          (lambda (segment posn)
1314                            (declare (ignore posn))
1315                            (let ((val  (- (+ (component-header-length)
1316                                              (or (label-position offset)
1317                                                  0))
1318                                           other-pointer-lowtag)))
1319                              (if quad-p
1320                                  (emit-qword segment val)
1321                                  (emit-signed-dword segment val)))))
1322         (if quad-p
1323             (emit-qword segment (or offset 0))
1324             (emit-signed-dword segment (or offset 0))))))
1325
1326 (defun emit-relative-fixup (segment fixup)
1327   (note-fixup segment :relative fixup)
1328   (emit-signed-dword segment (or (fixup-offset fixup) 0)))
1329
1330 \f
1331 ;;;; the effective-address (ea) structure
1332
1333 (defun reg-tn-encoding (tn)
1334   (declare (type tn tn))
1335   ;; ea only has space for three bits of register number: regs r8
1336   ;; and up are selected by a REX prefix byte which caller is responsible
1337   ;; for having emitted where necessary already
1338   (ecase (sb-name (sc-sb (tn-sc tn)))
1339     (registers
1340      (let ((offset (mod (tn-offset tn) 16)))
1341        (logior (ash (logand offset 1) 2)
1342                (ash offset -1))))
1343     (float-registers
1344      (mod (tn-offset tn) 8))))
1345
1346 (defstruct (ea (:constructor make-ea (size &key base index scale disp))
1347                (:copier nil))
1348   ;; note that we can represent an EA with a QWORD size, but EMIT-EA
1349   ;; can't actually emit it on its own: caller also needs to emit REX
1350   ;; prefix
1351   (size nil :type (member :byte :word :dword :qword))
1352   (base nil :type (or tn null))
1353   (index nil :type (or tn null))
1354   (scale 1 :type (member 1 2 4 8))
1355   (disp 0 :type (or (unsigned-byte 32) (signed-byte 32) fixup)))
1356 (def!method print-object ((ea ea) stream)
1357   (cond ((or *print-escape* *print-readably*)
1358          (print-unreadable-object (ea stream :type t)
1359            (format stream
1360                    "~S~@[ base=~S~]~@[ index=~S~]~@[ scale=~S~]~@[ disp=~S~]"
1361                    (ea-size ea)
1362                    (ea-base ea)
1363                    (ea-index ea)
1364                    (let ((scale (ea-scale ea)))
1365                      (if (= scale 1) nil scale))
1366                    (ea-disp ea))))
1367         (t
1368          (format stream "~A PTR [" (symbol-name (ea-size ea)))
1369          (when (ea-base ea)
1370            (write-string (sb!c::location-print-name (ea-base ea)) stream)
1371            (when (ea-index ea)
1372              (write-string "+" stream)))
1373          (when (ea-index ea)
1374            (write-string (sb!c::location-print-name (ea-index ea)) stream))
1375          (unless (= (ea-scale ea) 1)
1376            (format stream "*~A" (ea-scale ea)))
1377          (typecase (ea-disp ea)
1378            (null)
1379            (integer
1380             (format stream "~@D" (ea-disp ea)))
1381            (t
1382             (format stream "+~A" (ea-disp ea))))
1383          (write-char #\] stream))))
1384
1385 (defun emit-constant-tn-rip (segment constant-tn reg remaining-bytes)
1386   ;; AMD64 doesn't currently have a code object register to use as a
1387   ;; base register for constant access. Instead we use RIP-relative
1388   ;; addressing. The offset from the SIMPLE-FUN-HEADER to the instruction
1389   ;; is passed to the backpatch callback. In addition we need the offset
1390   ;; from the start of the function header to the slot in the CODE-HEADER
1391   ;; that stores the constant. Since we don't know where the code header
1392   ;; starts, instead count backwards from the function header.
1393   (let* ((2comp (component-info *component-being-compiled*))
1394          (constants (ir2-component-constants 2comp))
1395          (len (length constants))
1396          ;; Both CODE-HEADER and SIMPLE-FUN-HEADER are 16-byte aligned.
1397          ;; If there are an even amount of constants, there will be
1398          ;; an extra qword of padding before the function header, which
1399          ;; needs to be adjusted for. XXX: This will break if new slots
1400          ;; are added to the code header.
1401          (offset (* (- (+ len (if (evenp len)
1402                                   1
1403                                   2))
1404                        (tn-offset constant-tn))
1405                     n-word-bytes)))
1406     ;; RIP-relative addressing
1407     (emit-mod-reg-r/m-byte segment #b00 reg #b101)
1408     (emit-back-patch segment
1409                      4
1410                      (lambda (segment posn)
1411                        ;; The addressing is relative to end of instruction,
1412                        ;; i.e. the end of this dword. Hence the + 4.
1413                        (emit-signed-dword segment
1414                                           (+ 4 remaining-bytes
1415                                              (- (+ offset posn)))))))
1416   (values))
1417
1418 (defun emit-label-rip (segment fixup reg remaining-bytes)
1419   (let ((label (fixup-offset fixup)))
1420     ;; RIP-relative addressing
1421     (emit-mod-reg-r/m-byte segment #b00 reg #b101)
1422     (emit-back-patch segment
1423                      4
1424                      (lambda (segment posn)
1425                        (emit-signed-dword segment
1426                                           (- (label-position label)
1427                                              (+ posn 4 remaining-bytes))))))
1428   (values))
1429
1430 (defun emit-ea (segment thing reg &key allow-constants (remaining-bytes 0))
1431   (etypecase thing
1432     (tn
1433      ;; this would be eleganter if we had a function that would create
1434      ;; an ea given a tn
1435      (ecase (sb-name (sc-sb (tn-sc thing)))
1436        ((registers float-registers)
1437         (emit-mod-reg-r/m-byte segment #b11 reg (reg-tn-encoding thing)))
1438        (stack
1439         ;; Convert stack tns into an index off RBP.
1440         (let ((disp (frame-byte-offset (tn-offset thing))))
1441           (cond ((<= -128 disp 127)
1442                  (emit-mod-reg-r/m-byte segment #b01 reg #b101)
1443                  (emit-byte segment disp))
1444                 (t
1445                  (emit-mod-reg-r/m-byte segment #b10 reg #b101)
1446                  (emit-signed-dword segment disp)))))
1447        (constant
1448         (unless allow-constants
1449           ;; Why?
1450           (error
1451            "Constant TNs can only be directly used in MOV, PUSH, and CMP."))
1452         (emit-constant-tn-rip segment thing reg remaining-bytes))))
1453     (ea
1454      (let* ((base (ea-base thing))
1455             (index (ea-index thing))
1456             (scale (ea-scale thing))
1457             (disp (ea-disp thing))
1458             (mod (cond ((or (null base)
1459                             (and (eql disp 0)
1460                                  (not (= (reg-tn-encoding base) #b101))))
1461                         #b00)
1462                        ((and (fixnump disp) (<= -128 disp 127))
1463                         #b01)
1464                        (t
1465                         #b10)))
1466             (r/m (cond (index #b100)
1467                        ((null base) #b101)
1468                        (t (reg-tn-encoding base)))))
1469        (when (and (fixup-p disp)
1470                   (label-p (fixup-offset disp)))
1471          (aver (null base))
1472          (aver (null index))
1473          (return-from emit-ea (emit-ea segment disp reg
1474                                        :allow-constants allow-constants
1475                                        :remaining-bytes remaining-bytes)))
1476        (when (and (= mod 0) (= r/m #b101))
1477          ;; this is rip-relative in amd64, so we'll use a sib instead
1478          (setf r/m #b100 scale 1))
1479        (emit-mod-reg-r/m-byte segment mod reg r/m)
1480        (when (= r/m #b100)
1481          (let ((ss (1- (integer-length scale)))
1482                (index (if (null index)
1483                           #b100
1484                           (let ((index (reg-tn-encoding index)))
1485                             (if (= index #b100)
1486                                 (error "can't index off of ESP")
1487                                 index))))
1488                (base (if (null base)
1489                          #b101
1490                          (reg-tn-encoding base))))
1491            (emit-sib-byte segment ss index base)))
1492        (cond ((= mod #b01)
1493               (emit-byte segment disp))
1494              ((or (= mod #b10) (null base))
1495               (if (fixup-p disp)
1496                   (emit-absolute-fixup segment disp)
1497                   (emit-signed-dword segment disp))))))
1498     (fixup
1499      (typecase (fixup-offset thing)
1500        (label
1501         (emit-label-rip segment thing reg remaining-bytes))
1502        (t
1503         (emit-mod-reg-r/m-byte segment #b00 reg #b100)
1504         (emit-sib-byte segment 0 #b100 #b101)
1505         (emit-absolute-fixup segment thing))))))
1506
1507 (defun byte-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)) *byte-sc-names*)
1511        t))
1512
1513 (defun byte-ea-p (thing)
1514   (typecase thing
1515     (ea (eq (ea-size thing) :byte))
1516     (tn
1517      (and (member (sc-name (tn-sc thing)) *byte-sc-names*) t))
1518     (t nil)))
1519
1520 (defun word-reg-p (thing)
1521   (and (tn-p thing)
1522        (eq (sb-name (sc-sb (tn-sc thing))) 'registers)
1523        (member (sc-name (tn-sc thing)) *word-sc-names*)
1524        t))
1525
1526 (defun word-ea-p (thing)
1527   (typecase thing
1528     (ea (eq (ea-size thing) :word))
1529     (tn (and (member (sc-name (tn-sc thing)) *word-sc-names*) t))
1530     (t nil)))
1531
1532 (defun dword-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)) *dword-sc-names*)
1536        t))
1537
1538 (defun dword-ea-p (thing)
1539   (typecase thing
1540     (ea (eq (ea-size thing) :dword))
1541     (tn
1542      (and (member (sc-name (tn-sc thing)) *dword-sc-names*) t))
1543     (t nil)))
1544
1545 (defun qword-reg-p (thing)
1546   (and (tn-p thing)
1547        (eq (sb-name (sc-sb (tn-sc thing))) 'registers)
1548        (member (sc-name (tn-sc thing)) *qword-sc-names*)
1549        t))
1550
1551 (defun qword-ea-p (thing)
1552   (typecase thing
1553     (ea (eq (ea-size thing) :qword))
1554     (tn
1555      (and (member (sc-name (tn-sc thing)) *qword-sc-names*) t))
1556     (t nil)))
1557
1558 ;;; Return true if THING is a general-purpose register TN.
1559 (defun register-p (thing)
1560   (and (tn-p thing)
1561        (eq (sb-name (sc-sb (tn-sc thing))) 'registers)))
1562
1563 (defun accumulator-p (thing)
1564   (and (register-p thing)
1565        (= (tn-offset thing) 0)))
1566
1567 ;;; Return true if THING is an XMM register TN.
1568 (defun xmm-register-p (thing)
1569   (and (tn-p thing)
1570        (eq (sb-name (sc-sb (tn-sc thing))) 'float-registers)))
1571
1572 \f
1573 ;;;; utilities
1574
1575 (def!constant +operand-size-prefix-byte+ #b01100110)
1576
1577 (defun maybe-emit-operand-size-prefix (segment size)
1578   (unless (or (eq size :byte)
1579               (eq size :qword)          ; REX prefix handles this
1580               (eq size +default-operand-size+))
1581     (emit-byte segment +operand-size-prefix-byte+)))
1582
1583 ;;; A REX prefix must be emitted if at least one of the following
1584 ;;; conditions is true:
1585 ;;  1. The operand size is :QWORD and the default operand size of the
1586 ;;     instruction is not :QWORD.
1587 ;;; 2. The instruction references an extended register.
1588 ;;; 3. The instruction references one of the byte registers SIL, DIL,
1589 ;;;    SPL or BPL.
1590
1591 ;;; Emit a REX prefix if necessary. OPERAND-SIZE is used to determine
1592 ;;; whether to set REX.W. Callers pass it explicitly as :DO-NOT-SET if
1593 ;;; this should not happen, for example because the instruction's
1594 ;;; default operand size is qword. R, X and B are NIL or TNs specifying
1595 ;;; registers the encodings of which are extended with the REX.R, REX.X
1596 ;;; and REX.B bit, respectively. To determine whether one of the byte
1597 ;;; registers is used that can only be accessed using a REX prefix, we
1598 ;;; need only to test R and B, because X is only used for the index
1599 ;;; register of an effective address and therefore never byte-sized.
1600 ;;; For R we can avoid to calculate the size of the TN because it is
1601 ;;; always OPERAND-SIZE. The size of B must be calculated here because
1602 ;;; B can be address-sized (if it is the base register of an effective
1603 ;;; address), of OPERAND-SIZE (if the instruction operates on two
1604 ;;; registers) or of some different size (in the instructions that
1605 ;;; combine arguments of different sizes: MOVZX, MOVSX, MOVSXD and
1606 ;;; several SSE instructions, e.g. CVTSD2SI). We don't distinguish
1607 ;;; between general-purpose and floating point registers for this cause
1608 ;;; because only general-purpose registers can be byte-sized at all.
1609 (defun maybe-emit-rex-prefix (segment operand-size r x b)
1610   (declare (type (member nil :byte :word :dword :qword :do-not-set)
1611                  operand-size)
1612            (type (or null tn) r x b))
1613   (labels ((if-hi (r)
1614              (if (and r (> (tn-offset r)
1615                            ;; offset of r8 is 16, offset of xmm8 is 8
1616                            (if (eq (sb-name (sc-sb (tn-sc r)))
1617                                    'float-registers)
1618                                7
1619                                15)))
1620                  1
1621                  0))
1622            (reg-4-7-p (r)
1623              ;; Assuming R is a TN describing a general-purpose
1624              ;; register, return true if it references register
1625              ;; 4 upto 7.
1626              (<= 8 (tn-offset r) 15)))
1627     (let ((rex-w (if (eq operand-size :qword) 1 0))
1628           (rex-r (if-hi r))
1629           (rex-x (if-hi x))
1630           (rex-b (if-hi b)))
1631       (when (or (not (zerop (logior rex-w rex-r rex-x rex-b)))
1632                 (and r
1633                      (eq operand-size :byte)
1634                      (reg-4-7-p r))
1635                 (and b
1636                      (eq (operand-size b) :byte)
1637                      (reg-4-7-p b)))
1638         (emit-rex-byte segment #b0100 rex-w rex-r rex-x rex-b)))))
1639
1640 ;;; Emit a REX prefix if necessary. The operand size is determined from
1641 ;;; THING or can be overwritten by OPERAND-SIZE. This and REG are always
1642 ;;; passed to MAYBE-EMIT-REX-PREFIX. Additionally, if THING is an EA we
1643 ;;; pass its index and base registers, if it is a register TN, we pass
1644 ;;; only itself.
1645 ;;; In contrast to EMIT-EA above, neither stack TNs nor fixups need to
1646 ;;; be treated specially here: If THING is a stack TN, neither it nor
1647 ;;; any of its components are passed to MAYBE-EMIT-REX-PREFIX which
1648 ;;; works correctly because stack references always use RBP as the base
1649 ;;; register and never use an index register so no extended registers
1650 ;;; need to be accessed. Fixups are assembled using an addressing mode
1651 ;;; of displacement-only or RIP-plus-displacement (see EMIT-EA), so may
1652 ;;; not reference an extended register. The displacement-only addressing
1653 ;;; mode requires that REX.X is 0, which is ensured here.
1654 (defun maybe-emit-rex-for-ea (segment thing reg &key operand-size)
1655   (declare (type (or ea tn fixup) thing)
1656            (type (or null tn) reg)
1657            (type (member nil :byte :word :dword :qword :do-not-set)
1658                  operand-size))
1659   (let ((ea-p (ea-p thing)))
1660     (maybe-emit-rex-prefix segment
1661                            (or operand-size (operand-size thing))
1662                            reg
1663                            (and ea-p (ea-index thing))
1664                            (cond (ea-p (ea-base thing))
1665                                  ((and (tn-p thing)
1666                                        (member (sb-name (sc-sb (tn-sc thing)))
1667                                                '(float-registers registers)))
1668                                   thing)
1669                                  (t nil)))))
1670
1671 (defun operand-size (thing)
1672   (typecase thing
1673     (tn
1674      ;; FIXME: might as well be COND instead of having to use #. readmacro
1675      ;; to hack up the code
1676      (case (sc-name (tn-sc thing))
1677        (#.*qword-sc-names*
1678         :qword)
1679        (#.*dword-sc-names*
1680         :dword)
1681        (#.*word-sc-names*
1682         :word)
1683        (#.*byte-sc-names*
1684         :byte)
1685        ;; added by jrd: float-registers is a separate size (?)
1686        ;; The only place in the code where we are called with THING
1687        ;; being a float-register is in MAYBE-EMIT-REX-PREFIX when it
1688        ;; checks whether THING is a byte register. Thus our result in
1689        ;; these cases could as well be :dword and :qword. I leave it as
1690        ;; :float and :double which is more likely to trigger an aver
1691        ;; instead of silently doing the wrong thing in case this
1692        ;; situation should change. Lutz Euler, 2005-10-23.
1693        (#.*float-sc-names*
1694         :float)
1695        (#.*double-sc-names*
1696         :double)
1697        (#.*complex-sc-names*
1698         :complex)
1699        (t
1700         (error "can't tell the size of ~S ~S" thing (sc-name (tn-sc thing))))))
1701     (ea
1702      (ea-size thing))
1703     (fixup
1704      ;; GNA.  Guess who spelt "flavor" correctly first time round?
1705      ;; There's a strong argument in my mind to change all uses of
1706      ;; "flavor" to "kind": and similarly with some misguided uses of
1707      ;; "type" here and there.  -- CSR, 2005-01-06.
1708      (case (fixup-flavor thing)
1709        ((:foreign-dataref) :qword)))
1710     (t
1711      nil)))
1712
1713 (defun matching-operand-size (dst src)
1714   (let ((dst-size (operand-size dst))
1715         (src-size (operand-size src)))
1716     (if dst-size
1717         (if src-size
1718             (if (eq dst-size src-size)
1719                 dst-size
1720                 (error "size mismatch: ~S is a ~S and ~S is a ~S."
1721                        dst dst-size src src-size))
1722             dst-size)
1723         (if src-size
1724             src-size
1725             (error "can't tell the size of either ~S or ~S" dst src)))))
1726
1727 ;;; Except in a very few cases (MOV instructions A1, A3 and B8 - BF)
1728 ;;; we expect dword data bytes even when 64 bit work is being done.
1729 ;;; But A1 and A3 are currently unused and B8 - BF use EMIT-QWORD
1730 ;;; directly, so we emit all quad constants as dwords, additionally
1731 ;;; making sure that they survive the sign-extension to 64 bits
1732 ;;; unchanged.
1733 (defun emit-sized-immediate (segment size value)
1734   (ecase size
1735     (:byte
1736      (emit-byte segment value))
1737     (:word
1738      (emit-word segment value))
1739     (:dword
1740      (emit-dword segment value))
1741     (:qword
1742      (emit-signed-dword segment value))))
1743 \f
1744 ;;;; general data transfer
1745
1746 ;;; This is the part of the MOV instruction emitter that does moving
1747 ;;; of an immediate value into a qword register. We go to some length
1748 ;;; to achieve the shortest possible encoding.
1749 (defun emit-immediate-move-to-qword-register (segment dst src)
1750   (declare (type integer src))
1751   (cond ((typep src '(unsigned-byte 32))
1752          ;; We use the B8 - BF encoding with an operand size of 32 bits
1753          ;; here and let the implicit zero-extension fill the upper half
1754          ;; of the 64-bit destination register. Instruction size: five
1755          ;; or six bytes. (A REX prefix will be emitted only if the
1756          ;; destination is an extended register.)
1757          (maybe-emit-rex-prefix segment :dword nil nil dst)
1758          (emit-byte-with-reg segment #b10111 (reg-tn-encoding dst))
1759          (emit-dword segment src))
1760         (t
1761          (maybe-emit-rex-prefix segment :qword nil nil dst)
1762          (cond ((typep src '(signed-byte 32))
1763                 ;; Use the C7 encoding that takes a 32-bit immediate and
1764                 ;; sign-extends it to 64 bits. Instruction size: seven
1765                 ;; bytes.
1766                 (emit-byte segment #b11000111)
1767                 (emit-mod-reg-r/m-byte segment #b11 #b000
1768                                        (reg-tn-encoding dst))
1769                 (emit-signed-dword segment src))
1770                ((<= (- (expt 2 64) (expt 2 31))
1771                     src
1772                     (1- (expt 2 64)))
1773                 ;; This triggers on positive integers of 64 bits length
1774                 ;; with the most significant 33 bits being 1. We use the
1775                 ;; same encoding as in the previous clause.
1776                 (emit-byte segment #b11000111)
1777                 (emit-mod-reg-r/m-byte segment #b11 #b000
1778                                        (reg-tn-encoding dst))
1779                 (emit-signed-dword segment (- src (expt 2 64))))
1780                (t
1781                 ;; We need a full 64-bit immediate. Instruction size:
1782                 ;; ten bytes.
1783                 (emit-byte-with-reg segment #b10111 (reg-tn-encoding dst))
1784                 (emit-qword segment src))))))
1785
1786 (define-instruction mov (segment dst src)
1787   ;; immediate to register
1788   (:printer reg ((op #b1011) (imm nil :type 'signed-imm-data))
1789             '(:name :tab reg ", " imm))
1790   (:printer rex-reg ((op #b1011) (imm nil :type 'signed-imm-data-upto-qword))
1791             '(:name :tab reg ", " imm))
1792   ;; absolute mem to/from accumulator
1793   (:printer simple-dir ((op #b101000) (imm nil :type 'imm-addr))
1794             `(:name :tab ,(swap-if 'dir 'accum ", " '("[" imm "]"))))
1795   ;; register to/from register/memory
1796   (:printer reg-reg/mem-dir ((op #b100010)))
1797   (:printer rex-reg-reg/mem-dir ((op #b100010)))
1798   (:printer x66-reg-reg/mem-dir ((op #b100010)))
1799   (:printer x66-rex-reg-reg/mem-dir ((op #b100010)))
1800   ;; immediate to register/memory
1801   (:printer reg/mem-imm ((op '(#b1100011 #b000))))
1802   (:printer rex-reg/mem-imm ((op '(#b1100011 #b000))))
1803
1804   (:emitter
1805    (let ((size (matching-operand-size dst src)))
1806      (maybe-emit-operand-size-prefix segment size)
1807      (cond ((register-p dst)
1808             (cond ((integerp src)
1809                    (cond ((eq size :qword)
1810                           (emit-immediate-move-to-qword-register segment
1811                                                                  dst src))
1812                          (t
1813                           (maybe-emit-rex-prefix segment size nil nil dst)
1814                           (emit-byte-with-reg segment
1815                                               (if (eq size :byte)
1816                                                   #b10110
1817                                                   #b10111)
1818                                               (reg-tn-encoding dst))
1819                           (emit-sized-immediate segment size src))))
1820                   (t
1821                    (maybe-emit-rex-for-ea segment src dst)
1822                    (emit-byte segment
1823                               (if (eq size :byte)
1824                                   #b10001010
1825                                   #b10001011))
1826                    (emit-ea segment src (reg-tn-encoding dst) :allow-constants t))))
1827            ((integerp src)
1828             ;; C7 only deals with 32 bit immediates even if the
1829             ;; destination is a 64-bit location. The value is
1830             ;; sign-extended in this case.
1831             (maybe-emit-rex-for-ea segment dst nil)
1832             (emit-byte segment (if (eq size :byte) #b11000110 #b11000111))
1833             (emit-ea segment dst #b000)
1834             (emit-sized-immediate segment size src))
1835            ((register-p src)
1836             (maybe-emit-rex-for-ea segment dst src)
1837             (emit-byte segment (if (eq size :byte) #b10001000 #b10001001))
1838             (emit-ea segment dst (reg-tn-encoding src)))
1839            ((fixup-p src)
1840             ;; Generally we can't MOV a fixupped value into an EA, since
1841             ;; MOV on non-registers can only take a 32-bit immediate arg.
1842             ;; Make an exception for :FOREIGN fixups (pretty much just
1843             ;; the runtime asm, since other foreign calls go through the
1844             ;; the linkage table) and for linkage table references, since
1845             ;; these should always end up in low memory.
1846             (aver (or (eq (fixup-flavor src) :foreign)
1847                       (eq (fixup-flavor src) :foreign-dataref)
1848                       (eq (ea-size dst) :dword)))
1849             (maybe-emit-rex-for-ea segment dst nil)
1850             (emit-byte segment #b11000111)
1851             (emit-ea segment dst #b000)
1852             (emit-absolute-fixup segment src))
1853            (t
1854             (error "bogus arguments to MOV: ~S ~S" dst src))))))
1855
1856 (defun emit-move-with-extension (segment dst src signed-p)
1857   (aver (register-p dst))
1858   (let ((dst-size (operand-size dst))
1859         (src-size (operand-size src))
1860         (opcode (if signed-p  #b10111110 #b10110110)))
1861     (ecase dst-size
1862       (:word
1863        (aver (eq src-size :byte))
1864        (maybe-emit-operand-size-prefix segment :word)
1865        ;; REX prefix is needed if SRC is SIL, DIL, SPL or BPL.
1866        (maybe-emit-rex-for-ea segment src dst :operand-size :word)
1867        (emit-byte segment #b00001111)
1868        (emit-byte segment opcode)
1869        (emit-ea segment src (reg-tn-encoding dst)))
1870       ((:dword :qword)
1871        (ecase src-size
1872          (:byte
1873           (maybe-emit-rex-for-ea segment src dst :operand-size dst-size)
1874           (emit-byte segment #b00001111)
1875           (emit-byte segment opcode)
1876           (emit-ea segment src (reg-tn-encoding dst)))
1877          (:word
1878           (maybe-emit-rex-for-ea segment src dst :operand-size dst-size)
1879           (emit-byte segment #b00001111)
1880           (emit-byte segment (logior opcode 1))
1881           (emit-ea segment src (reg-tn-encoding dst)))
1882          (:dword
1883           (aver (eq dst-size :qword))
1884           ;; dst is in reg, src is in modrm
1885           (let ((ea-p (ea-p src)))
1886             (maybe-emit-rex-prefix segment (if signed-p :qword :dword) dst
1887                                    (and ea-p (ea-index src))
1888                                    (cond (ea-p (ea-base src))
1889                                          ((tn-p src) src)
1890                                          (t nil)))
1891             (emit-byte segment (if signed-p #x63 #x8b)) ;movsxd or straight mov
1892             ;;(emit-byte segment opcode)
1893             (emit-ea segment src (reg-tn-encoding dst)))))))))
1894
1895 (define-instruction movsx (segment dst src)
1896   (:printer ext-reg-reg/mem-no-width
1897             ((op #b10111110) (reg/mem nil :type 'sized-byte-reg/mem)))
1898   (:printer rex-ext-reg-reg/mem-no-width
1899             ((op #b10111110) (reg/mem nil :type 'sized-byte-reg/mem)))
1900   (:printer ext-reg-reg/mem-no-width
1901             ((op #b10111111) (reg/mem nil :type 'sized-word-reg/mem)))
1902   (:printer rex-ext-reg-reg/mem-no-width
1903             ((op #b10111111) (reg/mem nil :type 'sized-word-reg/mem)))
1904   (:emitter (emit-move-with-extension segment dst src :signed)))
1905
1906 (define-instruction movzx (segment dst src)
1907   (:printer ext-reg-reg/mem-no-width
1908             ((op #b10110110) (reg/mem nil :type 'sized-byte-reg/mem)))
1909   (:printer rex-ext-reg-reg/mem-no-width
1910             ((op #b10110110) (reg/mem nil :type 'sized-byte-reg/mem)))
1911   (:printer ext-reg-reg/mem-no-width
1912             ((op #b10110111) (reg/mem nil :type 'sized-word-reg/mem)))
1913   (:printer rex-ext-reg-reg/mem-no-width
1914             ((op #b10110111) (reg/mem nil :type 'sized-word-reg/mem)))
1915   (:emitter (emit-move-with-extension segment dst src nil)))
1916
1917 ;;; The regular use of MOVSXD is with an operand size of :qword. This
1918 ;;; sign-extends the dword source into the qword destination register.
1919 ;;; If the operand size is :dword the instruction zero-extends the dword
1920 ;;; source into the qword destination register, i.e. it does the same as
1921 ;;; a dword MOV into a register.
1922 (define-instruction movsxd (segment dst src)
1923   (:printer reg-reg/mem ((op #b0110001) (width 1)
1924                          (reg/mem nil :type 'sized-dword-reg/mem)))
1925   (:printer rex-reg-reg/mem ((op #b0110001) (width 1)
1926                              (reg/mem nil :type 'sized-dword-reg/mem)))
1927   (:emitter (emit-move-with-extension segment dst src :signed)))
1928
1929 ;;; this is not a real amd64 instruction, of course
1930 (define-instruction movzxd (segment dst src)
1931   ; (:printer reg-reg/mem ((op #x63) (reg nil :type 'reg)))
1932   (:emitter (emit-move-with-extension segment dst src nil)))
1933
1934 (define-instruction push (segment src)
1935   ;; register
1936   (:printer reg-no-width-default-qword ((op #b01010)))
1937   (:printer rex-reg-no-width-default-qword ((op #b01010)))
1938   ;; register/memory
1939   (:printer reg/mem-default-qword ((op '(#b11111111 #b110))))
1940   (:printer rex-reg/mem-default-qword ((op '(#b11111111 #b110))))
1941   ;; immediate
1942   (:printer byte ((op #b01101010) (imm nil :type 'signed-imm-byte))
1943             '(:name :tab imm))
1944   (:printer byte ((op #b01101000)
1945                   (imm nil :type 'signed-imm-data-default-qword))
1946             '(:name :tab imm))
1947   ;; ### segment registers?
1948
1949   (:emitter
1950    (cond ((integerp src)
1951           (cond ((<= -128 src 127)
1952                  (emit-byte segment #b01101010)
1953                  (emit-byte segment src))
1954                 (t
1955                  ;; A REX-prefix is not needed because the operand size
1956                  ;; defaults to 64 bits. The size of the immediate is 32
1957                  ;; bits and it is sign-extended.
1958                  (emit-byte segment #b01101000)
1959                  (emit-signed-dword segment src))))
1960          (t
1961           (let ((size (operand-size src)))
1962             (aver (or (eq size :qword) (eq size :word)))
1963             (maybe-emit-operand-size-prefix segment size)
1964             (maybe-emit-rex-for-ea segment src nil :operand-size :do-not-set)
1965             (cond ((register-p src)
1966                    (emit-byte-with-reg segment #b01010 (reg-tn-encoding src)))
1967                   (t
1968                    (emit-byte segment #b11111111)
1969                    (emit-ea segment src #b110 :allow-constants t))))))))
1970
1971 (define-instruction pop (segment dst)
1972   (:printer reg-no-width-default-qword ((op #b01011)))
1973   (:printer rex-reg-no-width-default-qword ((op #b01011)))
1974   (:printer reg/mem-default-qword ((op '(#b10001111 #b000))))
1975   (:printer rex-reg/mem-default-qword ((op '(#b10001111 #b000))))
1976   (:emitter
1977    (let ((size (operand-size dst)))
1978      (aver (or (eq size :qword) (eq size :word)))
1979      (maybe-emit-operand-size-prefix segment size)
1980      (maybe-emit-rex-for-ea segment dst nil :operand-size :do-not-set)
1981      (cond ((register-p dst)
1982             (emit-byte-with-reg segment #b01011 (reg-tn-encoding dst)))
1983            (t
1984             (emit-byte segment #b10001111)
1985             (emit-ea segment dst #b000))))))
1986
1987 (define-instruction xchg (segment operand1 operand2)
1988   ;; Register with accumulator.
1989   (:printer reg-no-width ((op #b10010)) '(:name :tab accum ", " reg))
1990   ;; Register/Memory with Register.
1991   (:printer reg-reg/mem ((op #b1000011)))
1992   (:printer rex-reg-reg/mem ((op #b1000011)))
1993   (:emitter
1994    (let ((size (matching-operand-size operand1 operand2)))
1995      (maybe-emit-operand-size-prefix segment size)
1996      (labels ((xchg-acc-with-something (acc something)
1997                 (if (and (not (eq size :byte)) (register-p something))
1998                     (progn
1999                       (maybe-emit-rex-for-ea segment acc something)
2000                       (emit-byte-with-reg segment
2001                                           #b10010
2002                                           (reg-tn-encoding something)))
2003                     (xchg-reg-with-something acc something)))
2004               (xchg-reg-with-something (reg something)
2005                 (maybe-emit-rex-for-ea segment something reg)
2006                 (emit-byte segment (if (eq size :byte) #b10000110 #b10000111))
2007                 (emit-ea segment something (reg-tn-encoding reg))))
2008        (cond ((accumulator-p operand1)
2009               (xchg-acc-with-something operand1 operand2))
2010              ((accumulator-p operand2)
2011               (xchg-acc-with-something operand2 operand1))
2012              ((register-p operand1)
2013               (xchg-reg-with-something operand1 operand2))
2014              ((register-p operand2)
2015               (xchg-reg-with-something operand2 operand1))
2016              (t
2017               (error "bogus args to XCHG: ~S ~S" operand1 operand2)))))))
2018
2019 (define-instruction lea (segment dst src)
2020   (:printer rex-reg-reg/mem ((op #b1000110)))
2021   (:printer reg-reg/mem ((op #b1000110) (width 1)))
2022   (:emitter
2023    (aver (or (dword-reg-p dst) (qword-reg-p dst)))
2024    (maybe-emit-rex-for-ea segment src dst
2025                           :operand-size :qword)
2026    (emit-byte segment #b10001101)
2027    (emit-ea segment src (reg-tn-encoding dst))))
2028
2029 (define-instruction cmpxchg (segment dst src &optional prefix)
2030   ;; Register/Memory with Register.
2031   (:printer ext-reg-reg/mem ((op #b1011000)) '(:name :tab reg/mem ", " reg))
2032   (:emitter
2033    (aver (register-p src))
2034    (emit-prefix segment prefix)
2035    (let ((size (matching-operand-size src dst)))
2036      (maybe-emit-operand-size-prefix segment size)
2037      (maybe-emit-rex-for-ea segment dst src)
2038      (emit-byte segment #b00001111)
2039      (emit-byte segment (if (eq size :byte) #b10110000 #b10110001))
2040      (emit-ea segment dst (reg-tn-encoding src)))))
2041
2042 \f
2043 ;;;; flag control instructions
2044
2045 ;;; CLC -- Clear Carry Flag.
2046 (define-instruction clc (segment)
2047   (:printer byte ((op #b11111000)))
2048   (:emitter
2049    (emit-byte segment #b11111000)))
2050
2051 ;;; CLD -- Clear Direction Flag.
2052 (define-instruction cld (segment)
2053   (:printer byte ((op #b11111100)))
2054   (:emitter
2055    (emit-byte segment #b11111100)))
2056
2057 ;;; CLI -- Clear Iterrupt Enable Flag.
2058 (define-instruction cli (segment)
2059   (:printer byte ((op #b11111010)))
2060   (:emitter
2061    (emit-byte segment #b11111010)))
2062
2063 ;;; CMC -- Complement Carry Flag.
2064 (define-instruction cmc (segment)
2065   (:printer byte ((op #b11110101)))
2066   (:emitter
2067    (emit-byte segment #b11110101)))
2068
2069 ;;; LAHF -- Load AH into flags.
2070 (define-instruction lahf (segment)
2071   (:printer byte ((op #b10011111)))
2072   (:emitter
2073    (emit-byte segment #b10011111)))
2074
2075 ;;; POPF -- Pop flags.
2076 (define-instruction popf (segment)
2077   (:printer byte ((op #b10011101)))
2078   (:emitter
2079    (emit-byte segment #b10011101)))
2080
2081 ;;; PUSHF -- push flags.
2082 (define-instruction pushf (segment)
2083   (:printer byte ((op #b10011100)))
2084   (:emitter
2085    (emit-byte segment #b10011100)))
2086
2087 ;;; SAHF -- Store AH into flags.
2088 (define-instruction sahf (segment)
2089   (:printer byte ((op #b10011110)))
2090   (:emitter
2091    (emit-byte segment #b10011110)))
2092
2093 ;;; STC -- Set Carry Flag.
2094 (define-instruction stc (segment)
2095   (:printer byte ((op #b11111001)))
2096   (:emitter
2097    (emit-byte segment #b11111001)))
2098
2099 ;;; STD -- Set Direction Flag.
2100 (define-instruction std (segment)
2101   (:printer byte ((op #b11111101)))
2102   (:emitter
2103    (emit-byte segment #b11111101)))
2104
2105 ;;; STI -- Set Interrupt Enable Flag.
2106 (define-instruction sti (segment)
2107   (:printer byte ((op #b11111011)))
2108   (:emitter
2109    (emit-byte segment #b11111011)))
2110 \f
2111 ;;;; arithmetic
2112
2113 (defun emit-random-arith-inst (name segment dst src opcode
2114                                     &optional allow-constants)
2115   (let ((size (matching-operand-size dst src)))
2116     (maybe-emit-operand-size-prefix segment size)
2117     (cond
2118      ((integerp src)
2119       (cond ((and (not (eq size :byte)) (<= -128 src 127))
2120              (maybe-emit-rex-for-ea segment dst nil)
2121              (emit-byte segment #b10000011)
2122              (emit-ea segment dst opcode :allow-constants allow-constants)
2123              (emit-byte segment src))
2124             ((accumulator-p dst)
2125              (maybe-emit-rex-for-ea segment dst nil)
2126              (emit-byte segment
2127                         (dpb opcode
2128                              (byte 3 3)
2129                              (if (eq size :byte)
2130                                  #b00000100
2131                                  #b00000101)))
2132              (emit-sized-immediate segment size src))
2133             (t
2134              (maybe-emit-rex-for-ea segment dst nil)
2135              (emit-byte segment (if (eq size :byte) #b10000000 #b10000001))
2136              (emit-ea segment dst opcode :allow-constants allow-constants)
2137              (emit-sized-immediate segment size src))))
2138      ((register-p src)
2139       (maybe-emit-rex-for-ea segment dst src)
2140       (emit-byte segment
2141                  (dpb opcode
2142                       (byte 3 3)
2143                       (if (eq size :byte) #b00000000 #b00000001)))
2144       (emit-ea segment dst (reg-tn-encoding src) :allow-constants allow-constants))
2145      ((register-p dst)
2146       (maybe-emit-rex-for-ea segment src dst)
2147       (emit-byte segment
2148                  (dpb opcode
2149                       (byte 3 3)
2150                       (if (eq size :byte) #b00000010 #b00000011)))
2151       (emit-ea segment src (reg-tn-encoding dst) :allow-constants allow-constants))
2152      (t
2153       (error "bogus operands to ~A" name)))))
2154
2155 (eval-when (:compile-toplevel :execute)
2156   (defun arith-inst-printer-list (subop)
2157     `((accum-imm ((op ,(dpb subop (byte 3 2) #b0000010))))
2158       (rex-accum-imm ((op ,(dpb subop (byte 3 2) #b0000010))))
2159       (reg/mem-imm ((op (#b1000000 ,subop))))
2160       (rex-reg/mem-imm ((op (#b1000000 ,subop))))
2161       ;; The redundant encoding #x82 is invalid in 64-bit mode,
2162       ;; therefore we force WIDTH to 1.
2163       (reg/mem-imm ((op (#b1000001 ,subop)) (width 1)
2164                     (imm nil :type signed-imm-byte)))
2165       (rex-reg/mem-imm ((op (#b1000001 ,subop)) (width 1)
2166                         (imm nil :type signed-imm-byte)))
2167       (reg-reg/mem-dir ((op ,(dpb subop (byte 3 1) #b000000))))
2168       (rex-reg-reg/mem-dir ((op ,(dpb subop (byte 3 1) #b000000))))))
2169   )
2170
2171 (define-instruction add (segment dst src &optional prefix)
2172   (:printer-list (arith-inst-printer-list #b000))
2173   (:emitter
2174    (emit-prefix segment prefix)
2175    (emit-random-arith-inst "ADD" segment dst src #b000)))
2176
2177 (define-instruction adc (segment dst src)
2178   (:printer-list (arith-inst-printer-list #b010))
2179   (:emitter (emit-random-arith-inst "ADC" segment dst src #b010)))
2180
2181 (define-instruction sub (segment dst src)
2182   (:printer-list (arith-inst-printer-list #b101))
2183   (:emitter (emit-random-arith-inst "SUB" segment dst src #b101)))
2184
2185 (define-instruction sbb (segment dst src)
2186   (:printer-list (arith-inst-printer-list #b011))
2187   (:emitter (emit-random-arith-inst "SBB" segment dst src #b011)))
2188
2189 (define-instruction cmp (segment dst src)
2190   (:printer-list (arith-inst-printer-list #b111))
2191   (:emitter (emit-random-arith-inst "CMP" segment dst src #b111 t)))
2192
2193 ;;; The one-byte encodings for INC and DEC are used as REX prefixes
2194 ;;; in 64-bit mode so we always use the two-byte form.
2195 (define-instruction inc (segment dst)
2196   (:printer reg/mem ((op '(#b1111111 #b000))))
2197   (:printer rex-reg/mem ((op '(#b1111111 #b000))))
2198   (:emitter
2199    (let ((size (operand-size dst)))
2200      (maybe-emit-operand-size-prefix segment size)
2201      (maybe-emit-rex-for-ea segment dst nil)
2202      (emit-byte segment (if (eq size :byte) #b11111110 #b11111111))
2203      (emit-ea segment dst #b000))))
2204
2205 (define-instruction dec (segment dst)
2206   (:printer reg/mem ((op '(#b1111111 #b001))))
2207   (:printer rex-reg/mem ((op '(#b1111111 #b001))))
2208   (:emitter
2209    (let ((size (operand-size dst)))
2210      (maybe-emit-operand-size-prefix segment size)
2211      (maybe-emit-rex-for-ea segment dst nil)
2212      (emit-byte segment (if (eq size :byte) #b11111110 #b11111111))
2213      (emit-ea segment dst #b001))))
2214
2215 (define-instruction neg (segment dst)
2216   (:printer reg/mem ((op '(#b1111011 #b011))))
2217   (:printer rex-reg/mem ((op '(#b1111011 #b011))))
2218   (:emitter
2219    (let ((size (operand-size dst)))
2220      (maybe-emit-operand-size-prefix segment size)
2221      (maybe-emit-rex-for-ea segment dst nil)
2222      (emit-byte segment (if (eq size :byte) #b11110110 #b11110111))
2223      (emit-ea segment dst #b011))))
2224
2225 (define-instruction mul (segment dst src)
2226   (:printer accum-reg/mem ((op '(#b1111011 #b100))))
2227   (:printer rex-accum-reg/mem ((op '(#b1111011 #b100))))
2228   (:emitter
2229    (let ((size (matching-operand-size dst src)))
2230      (aver (accumulator-p dst))
2231      (maybe-emit-operand-size-prefix segment size)
2232      (maybe-emit-rex-for-ea segment src nil)
2233      (emit-byte segment (if (eq size :byte) #b11110110 #b11110111))
2234      (emit-ea segment src #b100))))
2235
2236 (define-instruction imul (segment dst &optional src1 src2)
2237   (:printer accum-reg/mem ((op '(#b1111011 #b101))))
2238   (:printer rex-accum-reg/mem ((op '(#b1111011 #b101))))
2239   (:printer ext-reg-reg/mem-no-width ((op #b10101111)))
2240   (:printer rex-ext-reg-reg/mem-no-width ((op #b10101111)))
2241   (:printer reg-reg/mem ((op #b0110100) (width 1)
2242                          (imm nil :type 'signed-imm-data))
2243             '(:name :tab reg ", " reg/mem ", " imm))
2244   (:printer rex-reg-reg/mem ((op #b0110100) (width 1)
2245                              (imm nil :type 'signed-imm-data))
2246             '(:name :tab reg ", " reg/mem ", " imm))
2247   (:printer reg-reg/mem ((op #b0110101) (width 1)
2248                          (imm nil :type 'signed-imm-byte))
2249             '(:name :tab reg ", " reg/mem ", " imm))
2250   (:printer rex-reg-reg/mem ((op #b0110101) (width 1)
2251                              (imm nil :type 'signed-imm-byte))
2252             '(:name :tab reg ", " reg/mem ", " imm))
2253   (:emitter
2254    (flet ((r/m-with-immed-to-reg (reg r/m immed)
2255             (let* ((size (matching-operand-size reg r/m))
2256                    (sx (and (not (eq size :byte)) (<= -128 immed 127))))
2257               (maybe-emit-operand-size-prefix segment size)
2258               (maybe-emit-rex-for-ea segment r/m reg)
2259               (emit-byte segment (if sx #b01101011 #b01101001))
2260               (emit-ea segment r/m (reg-tn-encoding reg))
2261               (if sx
2262                   (emit-byte segment immed)
2263                   (emit-sized-immediate segment size immed)))))
2264      (cond (src2
2265             (r/m-with-immed-to-reg dst src1 src2))
2266            (src1
2267             (if (integerp src1)
2268                 (r/m-with-immed-to-reg dst dst src1)
2269                 (let ((size (matching-operand-size dst src1)))
2270                   (maybe-emit-operand-size-prefix segment size)
2271                   (maybe-emit-rex-for-ea segment src1 dst)
2272                   (emit-byte segment #b00001111)
2273                   (emit-byte segment #b10101111)
2274                   (emit-ea segment src1 (reg-tn-encoding dst)))))
2275            (t
2276             (let ((size (operand-size dst)))
2277               (maybe-emit-operand-size-prefix segment size)
2278               (maybe-emit-rex-for-ea segment dst nil)
2279               (emit-byte segment (if (eq size :byte) #b11110110 #b11110111))
2280               (emit-ea segment dst #b101)))))))
2281
2282 (define-instruction div (segment dst src)
2283   (:printer accum-reg/mem ((op '(#b1111011 #b110))))
2284   (:printer rex-accum-reg/mem ((op '(#b1111011 #b110))))
2285   (:emitter
2286    (let ((size (matching-operand-size dst src)))
2287      (aver (accumulator-p dst))
2288      (maybe-emit-operand-size-prefix segment size)
2289      (maybe-emit-rex-for-ea segment src nil)
2290      (emit-byte segment (if (eq size :byte) #b11110110 #b11110111))
2291      (emit-ea segment src #b110))))
2292
2293 (define-instruction idiv (segment dst src)
2294   (:printer accum-reg/mem ((op '(#b1111011 #b111))))
2295   (:printer rex-accum-reg/mem ((op '(#b1111011 #b111))))
2296   (:emitter
2297    (let ((size (matching-operand-size dst src)))
2298      (aver (accumulator-p dst))
2299      (maybe-emit-operand-size-prefix segment size)
2300      (maybe-emit-rex-for-ea segment src nil)
2301      (emit-byte segment (if (eq size :byte) #b11110110 #b11110111))
2302      (emit-ea segment src #b111))))
2303
2304 (define-instruction bswap (segment dst)
2305   (:printer ext-reg-no-width ((op #b11001)))
2306   (:emitter
2307    (let ((size (operand-size dst)))
2308      (maybe-emit-rex-prefix segment size nil nil dst)
2309      (emit-byte segment #x0f)
2310      (emit-byte-with-reg segment #b11001 (reg-tn-encoding dst)))))
2311
2312 ;;; CBW -- Convert Byte to Word. AX <- sign_xtnd(AL)
2313 (define-instruction cbw (segment)
2314   (:printer x66-byte ((op #b10011000)))
2315   (:emitter
2316    (maybe-emit-operand-size-prefix segment :word)
2317    (emit-byte segment #b10011000)))
2318
2319 ;;; CWDE -- Convert Word To Double Word Extended. EAX <- sign_xtnd(AX)
2320 (define-instruction cwde (segment)
2321   (:printer byte ((op #b10011000)))
2322   (:emitter
2323    (maybe-emit-operand-size-prefix segment :dword)
2324    (emit-byte segment #b10011000)))
2325
2326 ;;; CDQE -- Convert Double Word To Quad Word Extended. RAX <- sign_xtnd(EAX)
2327 (define-instruction cdqe (segment)
2328   (:printer rex-byte ((op #b10011000)))
2329   (:emitter
2330    (maybe-emit-rex-prefix segment :qword nil nil nil)
2331    (emit-byte segment #b10011000)))
2332
2333 ;;; CWD -- Convert Word to Double Word. DX:AX <- sign_xtnd(AX)
2334 (define-instruction cwd (segment)
2335   (:printer x66-byte ((op #b10011001)))
2336   (:emitter
2337    (maybe-emit-operand-size-prefix segment :word)
2338    (emit-byte segment #b10011001)))
2339
2340 ;;; CDQ -- Convert Double Word to Quad Word. EDX:EAX <- sign_xtnd(EAX)
2341 (define-instruction cdq (segment)
2342   (:printer byte ((op #b10011001)))
2343   (:emitter
2344    (maybe-emit-operand-size-prefix segment :dword)
2345    (emit-byte segment #b10011001)))
2346
2347 ;;; CQO -- Convert Quad Word to Octaword. RDX:RAX <- sign_xtnd(RAX)
2348 (define-instruction cqo (segment)
2349   (:printer rex-byte ((op #b10011001)))
2350   (:emitter
2351    (maybe-emit-rex-prefix segment :qword nil nil nil)
2352    (emit-byte segment #b10011001)))
2353
2354 (define-instruction xadd (segment dst src &optional prefix)
2355   ;; Register/Memory with Register.
2356   (:printer ext-reg-reg/mem ((op #b1100000)) '(:name :tab reg/mem ", " reg))
2357   (:emitter
2358    (aver (register-p src))
2359    (emit-prefix segment prefix)
2360    (let ((size (matching-operand-size src dst)))
2361      (maybe-emit-operand-size-prefix segment size)
2362      (maybe-emit-rex-for-ea segment dst src)
2363      (emit-byte segment #b00001111)
2364      (emit-byte segment (if (eq size :byte) #b11000000 #b11000001))
2365      (emit-ea segment dst (reg-tn-encoding src)))))
2366
2367 \f
2368 ;;;; logic
2369
2370 (defun emit-shift-inst (segment dst amount opcode)
2371   (let ((size (operand-size dst)))
2372     (maybe-emit-operand-size-prefix segment size)
2373     (multiple-value-bind (major-opcode immed)
2374         (case amount
2375           (:cl (values #b11010010 nil))
2376           (1 (values #b11010000 nil))
2377           (t (values #b11000000 t)))
2378       (maybe-emit-rex-for-ea segment dst nil)
2379       (emit-byte segment
2380                  (if (eq size :byte) major-opcode (logior major-opcode 1)))
2381       (emit-ea segment dst opcode)
2382       (when immed
2383         (emit-byte segment amount)))))
2384
2385 (eval-when (:compile-toplevel :execute)
2386   (defun shift-inst-printer-list (subop)
2387     `((reg/mem ((op (#b1101000 ,subop)))
2388                (:name :tab reg/mem ", 1"))
2389       (rex-reg/mem ((op (#b1101000 ,subop)))
2390                    (:name :tab reg/mem ", 1"))
2391       (reg/mem ((op (#b1101001 ,subop)))
2392                (:name :tab reg/mem ", " 'cl))
2393       (rex-reg/mem ((op (#b1101001 ,subop)))
2394                (:name :tab reg/mem ", " 'cl))
2395       (reg/mem-imm ((op (#b1100000 ,subop))
2396                     (imm nil :type imm-byte)))
2397       (rex-reg/mem-imm ((op (#b1100000 ,subop))
2398                     (imm nil :type imm-byte))))))
2399
2400 (define-instruction rol (segment dst amount)
2401   (:printer-list
2402    (shift-inst-printer-list #b000))
2403   (:emitter
2404    (emit-shift-inst segment dst amount #b000)))
2405
2406 (define-instruction ror (segment dst amount)
2407   (:printer-list
2408    (shift-inst-printer-list #b001))
2409   (:emitter
2410    (emit-shift-inst segment dst amount #b001)))
2411
2412 (define-instruction rcl (segment dst amount)
2413   (:printer-list
2414    (shift-inst-printer-list #b010))
2415   (:emitter
2416    (emit-shift-inst segment dst amount #b010)))
2417
2418 (define-instruction rcr (segment dst amount)
2419   (:printer-list
2420    (shift-inst-printer-list #b011))
2421   (:emitter
2422    (emit-shift-inst segment dst amount #b011)))
2423
2424 (define-instruction shl (segment dst amount)
2425   (:printer-list
2426    (shift-inst-printer-list #b100))
2427   (:emitter
2428    (emit-shift-inst segment dst amount #b100)))
2429
2430 (define-instruction shr (segment dst amount)
2431   (:printer-list
2432    (shift-inst-printer-list #b101))
2433   (:emitter
2434    (emit-shift-inst segment dst amount #b101)))
2435
2436 (define-instruction sar (segment dst amount)
2437   (:printer-list
2438    (shift-inst-printer-list #b111))
2439   (:emitter
2440    (emit-shift-inst segment dst amount #b111)))
2441
2442 (defun emit-double-shift (segment opcode dst src amt)
2443   (let ((size (matching-operand-size dst src)))
2444     (when (eq size :byte)
2445       (error "Double shifts can only be used with words."))
2446     (maybe-emit-operand-size-prefix segment size)
2447     (maybe-emit-rex-for-ea segment dst src)
2448     (emit-byte segment #b00001111)
2449     (emit-byte segment (dpb opcode (byte 1 3)
2450                             (if (eq amt :cl) #b10100101 #b10100100)))
2451     (emit-ea segment dst (reg-tn-encoding src))
2452     (unless (eq amt :cl)
2453       (emit-byte segment amt))))
2454
2455 (eval-when (:compile-toplevel :execute)
2456   (defun double-shift-inst-printer-list (op)
2457     `(#+nil
2458       (ext-reg-reg/mem-imm ((op ,(logior op #b100))
2459                             (imm nil :type signed-imm-byte)))
2460       (ext-reg-reg/mem ((op ,(logior op #b101)))
2461          (:name :tab reg/mem ", " 'cl)))))
2462
2463 (define-instruction shld (segment dst src amt)
2464   (:declare (type (or (member :cl) (mod 32)) amt))
2465   (:printer-list (double-shift-inst-printer-list #b10100000))
2466   (:emitter
2467    (emit-double-shift segment #b0 dst src amt)))
2468
2469 (define-instruction shrd (segment dst src amt)
2470   (:declare (type (or (member :cl) (mod 32)) amt))
2471   (:printer-list (double-shift-inst-printer-list #b10101000))
2472   (:emitter
2473    (emit-double-shift segment #b1 dst src amt)))
2474
2475 (define-instruction and (segment dst src)
2476   (:printer-list
2477    (arith-inst-printer-list #b100))
2478   (:emitter
2479    (emit-random-arith-inst "AND" segment dst src #b100)))
2480
2481 (define-instruction test (segment this that)
2482   (:printer accum-imm ((op #b1010100)))
2483   (:printer rex-accum-imm ((op #b1010100)))
2484   (:printer reg/mem-imm ((op '(#b1111011 #b000))))
2485   (:printer rex-reg/mem-imm ((op '(#b1111011 #b000))))
2486   (:printer reg-reg/mem ((op #b1000010)))
2487   (:printer rex-reg-reg/mem ((op #b1000010)))
2488   (:emitter
2489    (let ((size (matching-operand-size this that)))
2490      (maybe-emit-operand-size-prefix segment size)
2491      (flet ((test-immed-and-something (immed something)
2492               (cond ((accumulator-p something)
2493                      (maybe-emit-rex-for-ea segment something nil)
2494                      (emit-byte segment
2495                                 (if (eq size :byte) #b10101000 #b10101001))
2496                      (emit-sized-immediate segment size immed))
2497                     (t
2498                      (maybe-emit-rex-for-ea segment something nil)
2499                      (emit-byte segment
2500                                 (if (eq size :byte) #b11110110 #b11110111))
2501                      (emit-ea segment something #b000)
2502                      (emit-sized-immediate segment size immed))))
2503             (test-reg-and-something (reg something)
2504               (maybe-emit-rex-for-ea segment something reg)
2505               (emit-byte segment (if (eq size :byte) #b10000100 #b10000101))
2506               (emit-ea segment something (reg-tn-encoding reg))))
2507        (cond ((integerp that)
2508               (test-immed-and-something that this))
2509              ((integerp this)
2510               (test-immed-and-something this that))
2511              ((register-p this)
2512               (test-reg-and-something this that))
2513              ((register-p that)
2514               (test-reg-and-something that this))
2515              (t
2516               (error "bogus operands for TEST: ~S and ~S" this that)))))))
2517
2518 (define-instruction or (segment dst src)
2519   (:printer-list
2520    (arith-inst-printer-list #b001))
2521   (:emitter
2522    (emit-random-arith-inst "OR" segment dst src #b001)))
2523
2524 (define-instruction xor (segment dst src)
2525   (:printer-list
2526    (arith-inst-printer-list #b110))
2527   (:emitter
2528    (emit-random-arith-inst "XOR" segment dst src #b110)))
2529
2530 (define-instruction not (segment dst)
2531   (:printer reg/mem ((op '(#b1111011 #b010))))
2532   (:printer rex-reg/mem ((op '(#b1111011 #b010))))
2533   (:emitter
2534    (let ((size (operand-size dst)))
2535      (maybe-emit-operand-size-prefix segment size)
2536      (maybe-emit-rex-for-ea segment dst nil)
2537      (emit-byte segment (if (eq size :byte) #b11110110 #b11110111))
2538      (emit-ea segment dst #b010))))
2539 \f
2540 ;;;; string manipulation
2541
2542 (define-instruction cmps (segment size)
2543   (:printer string-op ((op #b1010011)))
2544   (:printer rex-string-op ((op #b1010011)))
2545   (:emitter
2546    (maybe-emit-operand-size-prefix segment size)
2547    (maybe-emit-rex-prefix segment size nil nil nil)
2548    (emit-byte segment (if (eq size :byte) #b10100110 #b10100111))))
2549
2550 (define-instruction ins (segment acc)
2551   (:printer string-op ((op #b0110110)))
2552   (:printer rex-string-op ((op #b0110110)))
2553   (:emitter
2554    (let ((size (operand-size acc)))
2555      (aver (accumulator-p acc))
2556      (maybe-emit-operand-size-prefix segment size)
2557      (maybe-emit-rex-prefix segment size nil nil nil)
2558      (emit-byte segment (if (eq size :byte) #b01101100 #b01101101)))))
2559
2560 (define-instruction lods (segment acc)
2561   (:printer string-op ((op #b1010110)))
2562   (:printer rex-string-op ((op #b1010110)))
2563   (:emitter
2564    (let ((size (operand-size acc)))
2565      (aver (accumulator-p acc))
2566      (maybe-emit-operand-size-prefix segment size)
2567      (maybe-emit-rex-prefix segment size nil nil nil)
2568      (emit-byte segment (if (eq size :byte) #b10101100 #b10101101)))))
2569
2570 (define-instruction movs (segment size)
2571   (:printer string-op ((op #b1010010)))
2572   (:printer rex-string-op ((op #b1010010)))
2573   (:emitter
2574    (maybe-emit-operand-size-prefix segment size)
2575    (maybe-emit-rex-prefix segment size nil nil nil)
2576    (emit-byte segment (if (eq size :byte) #b10100100 #b10100101))))
2577
2578 (define-instruction outs (segment acc)
2579   (:printer string-op ((op #b0110111)))
2580   (:printer rex-string-op ((op #b0110111)))
2581   (:emitter
2582    (let ((size (operand-size acc)))
2583      (aver (accumulator-p acc))
2584      (maybe-emit-operand-size-prefix segment size)
2585      (maybe-emit-rex-prefix segment size nil nil nil)
2586      (emit-byte segment (if (eq size :byte) #b01101110 #b01101111)))))
2587
2588 (define-instruction scas (segment acc)
2589   (:printer string-op ((op #b1010111)))
2590   (:printer rex-string-op ((op #b1010111)))
2591   (:emitter
2592    (let ((size (operand-size acc)))
2593      (aver (accumulator-p acc))
2594      (maybe-emit-operand-size-prefix segment size)
2595      (maybe-emit-rex-prefix segment size nil nil nil)
2596      (emit-byte segment (if (eq size :byte) #b10101110 #b10101111)))))
2597
2598 (define-instruction stos (segment acc)
2599   (:printer string-op ((op #b1010101)))
2600   (:printer rex-string-op ((op #b1010101)))
2601   (:emitter
2602    (let ((size (operand-size acc)))
2603      (aver (accumulator-p acc))
2604      (maybe-emit-operand-size-prefix segment size)
2605      (maybe-emit-rex-prefix segment size nil nil nil)
2606      (emit-byte segment (if (eq size :byte) #b10101010 #b10101011)))))
2607
2608 (define-instruction xlat (segment)
2609   (:printer byte ((op #b11010111)))
2610   (:emitter
2611    (emit-byte segment #b11010111)))
2612
2613 (define-instruction rep (segment)
2614   (:emitter
2615    (emit-byte segment #b11110011)))
2616
2617 (define-instruction repe (segment)
2618   (:printer byte ((op #b11110011)))
2619   (:emitter
2620    (emit-byte segment #b11110011)))
2621
2622 (define-instruction repne (segment)
2623   (:printer byte ((op #b11110010)))
2624   (:emitter
2625    (emit-byte segment #b11110010)))
2626
2627 \f
2628 ;;;; bit manipulation
2629
2630 (define-instruction bsf (segment dst src)
2631   (:printer ext-reg-reg/mem-no-width ((op #b10111100)))
2632   (:printer rex-ext-reg-reg/mem-no-width ((op #b10111100)))
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 #b10111100)
2641      (emit-ea segment src (reg-tn-encoding dst)))))
2642
2643 (define-instruction bsr (segment dst src)
2644   (:printer ext-reg-reg/mem-no-width ((op #b10111101)))
2645   (:printer rex-ext-reg-reg/mem-no-width ((op #b10111101)))
2646   (:emitter
2647    (let ((size (matching-operand-size dst src)))
2648      (when (eq size :byte)
2649        (error "can't scan bytes: ~S" src))
2650      (maybe-emit-operand-size-prefix segment size)
2651      (maybe-emit-rex-for-ea segment src dst)
2652      (emit-byte segment #b00001111)
2653      (emit-byte segment #b10111101)
2654      (emit-ea segment src (reg-tn-encoding dst)))))
2655
2656 (defun emit-bit-test-and-mumble (segment src index opcode)
2657   (let ((size (operand-size src)))
2658     (when (eq size :byte)
2659       (error "can't scan bytes: ~S" src))
2660     (maybe-emit-operand-size-prefix segment size)
2661     (cond ((integerp index)
2662            (maybe-emit-rex-for-ea segment src nil)
2663            (emit-byte segment #b00001111)
2664            (emit-byte segment #b10111010)
2665            (emit-ea segment src opcode)
2666            (emit-byte segment index))
2667           (t
2668            (maybe-emit-rex-for-ea segment src index)
2669            (emit-byte segment #b00001111)
2670            (emit-byte segment (dpb opcode (byte 3 3) #b10000011))
2671            (emit-ea segment src (reg-tn-encoding index))))))
2672
2673 (eval-when (:compile-toplevel :execute)
2674   (defun bit-test-inst-printer-list (subop)
2675     `((ext-reg/mem-imm ((op (#b1011101 ,subop))
2676                         (reg/mem nil :type reg/mem)
2677                         (imm nil :type imm-byte)
2678                         (width 0)))
2679       (ext-reg-reg/mem ((op ,(dpb subop (byte 3 2) #b1000001))
2680                         (width 1))
2681                        (:name :tab reg/mem ", " reg)))))
2682
2683 (define-instruction bt (segment src index)
2684   (:printer-list (bit-test-inst-printer-list #b100))
2685   (:emitter
2686    (emit-bit-test-and-mumble segment src index #b100)))
2687
2688 (define-instruction btc (segment src index)
2689   (:printer-list (bit-test-inst-printer-list #b111))
2690   (:emitter
2691    (emit-bit-test-and-mumble segment src index #b111)))
2692
2693 (define-instruction btr (segment src index)
2694   (:printer-list (bit-test-inst-printer-list #b110))
2695   (:emitter
2696    (emit-bit-test-and-mumble segment src index #b110)))
2697
2698 (define-instruction bts (segment src index)
2699   (:printer-list (bit-test-inst-printer-list #b101))
2700   (:emitter
2701    (emit-bit-test-and-mumble segment src index #b101)))
2702
2703 \f
2704 ;;;; control transfer
2705
2706 (define-instruction call (segment where)
2707   (:printer near-jump ((op #b11101000)))
2708   (:printer reg/mem-default-qword ((op '(#b11111111 #b010))))
2709   (:printer rex-reg/mem-default-qword ((op '(#b11111111 #b010))))
2710   (:emitter
2711    (typecase where
2712      (label
2713       (emit-byte segment #b11101000) ; 32 bit relative
2714       (emit-back-patch segment
2715                        4
2716                        (lambda (segment posn)
2717                          (emit-signed-dword segment
2718                                             (- (label-position where)
2719                                                (+ posn 4))))))
2720      (fixup
2721       ;; There is no CALL rel64...
2722       (error "Cannot CALL a fixup: ~S" where))
2723      (t
2724       (maybe-emit-rex-for-ea segment where nil :operand-size :do-not-set)
2725       (emit-byte segment #b11111111)
2726       (emit-ea segment where #b010)))))
2727
2728 (defun emit-byte-displacement-backpatch (segment target)
2729   (emit-back-patch segment
2730                    1
2731                    (lambda (segment posn)
2732                      (let ((disp (- (label-position target) (1+ posn))))
2733                        (aver (<= -128 disp 127))
2734                        (emit-byte segment disp)))))
2735
2736 (define-instruction jmp (segment cond &optional where)
2737   ;; conditional jumps
2738   (:printer short-cond-jump ((op #b0111)) '('j cc :tab label))
2739   (:printer near-cond-jump () '('j cc :tab label))
2740   ;; unconditional jumps
2741   (:printer short-jump ((op #b1011)))
2742   (:printer near-jump ((op #b11101001)))
2743   (:printer reg/mem-default-qword ((op '(#b11111111 #b100))))
2744   (:printer rex-reg/mem-default-qword ((op '(#b11111111 #b100))))
2745   (:emitter
2746    (cond (where
2747           (emit-chooser
2748            segment 6 2
2749            (lambda (segment posn delta-if-after)
2750              (let ((disp (- (label-position where posn delta-if-after)
2751                             (+ posn 2))))
2752                (when (<= -128 disp 127)
2753                  (emit-byte segment
2754                             (dpb (conditional-opcode cond)
2755                                  (byte 4 0)
2756                                  #b01110000))
2757                  (emit-byte-displacement-backpatch segment where)
2758                  t)))
2759            (lambda (segment posn)
2760              (let ((disp (- (label-position where) (+ posn 6))))
2761                (emit-byte segment #b00001111)
2762                (emit-byte segment
2763                           (dpb (conditional-opcode cond)
2764                                (byte 4 0)
2765                                #b10000000))
2766                (emit-signed-dword segment disp)))))
2767          ((label-p (setq where cond))
2768           (emit-chooser
2769            segment 5 0
2770            (lambda (segment posn delta-if-after)
2771              (let ((disp (- (label-position where posn delta-if-after)
2772                             (+ posn 2))))
2773                (when (<= -128 disp 127)
2774                  (emit-byte segment #b11101011)
2775                  (emit-byte-displacement-backpatch segment where)
2776                  t)))
2777            (lambda (segment posn)
2778              (let ((disp (- (label-position where) (+ posn 5))))
2779                (emit-byte segment #b11101001)
2780                (emit-signed-dword segment disp)))))
2781          ((fixup-p where)
2782           (emit-byte segment #b11101001)
2783           (emit-relative-fixup segment where))
2784          (t
2785           (unless (or (ea-p where) (tn-p where))
2786             (error "don't know what to do with ~A" where))
2787           ;; near jump defaults to 64 bit
2788           ;; w-bit in rex prefix is unnecessary
2789           (maybe-emit-rex-for-ea segment where nil :operand-size :do-not-set)
2790           (emit-byte segment #b11111111)
2791           (emit-ea segment where #b100)))))
2792
2793 (define-instruction ret (segment &optional stack-delta)
2794   (:printer byte ((op #b11000011)))
2795   (:printer byte ((op #b11000010) (imm nil :type 'imm-word-16))
2796             '(:name :tab imm))
2797   (:emitter
2798    (cond ((and stack-delta (not (zerop stack-delta)))
2799           (emit-byte segment #b11000010)
2800           (emit-word segment stack-delta))
2801          (t
2802           (emit-byte segment #b11000011)))))
2803
2804 (define-instruction jrcxz (segment target)
2805   (:printer short-jump ((op #b0011)))
2806   (:emitter
2807    (emit-byte segment #b11100011)
2808    (emit-byte-displacement-backpatch segment target)))
2809
2810 (define-instruction loop (segment target)
2811   (:printer short-jump ((op #b0010)))
2812   (:emitter
2813    (emit-byte segment #b11100010)       ; pfw this was 11100011, or jecxz!!!!
2814    (emit-byte-displacement-backpatch segment target)))
2815
2816 (define-instruction loopz (segment target)
2817   (:printer short-jump ((op #b0001)))
2818   (:emitter
2819    (emit-byte segment #b11100001)
2820    (emit-byte-displacement-backpatch segment target)))
2821
2822 (define-instruction loopnz (segment target)
2823   (:printer short-jump ((op #b0000)))
2824   (:emitter
2825    (emit-byte segment #b11100000)
2826    (emit-byte-displacement-backpatch segment target)))
2827 \f
2828 ;;;; conditional move
2829 (define-instruction cmov (segment cond dst src)
2830   (:printer cond-move ())
2831   (:printer rex-cond-move ())
2832   (:emitter
2833    (aver (register-p dst))
2834    (let ((size (matching-operand-size dst src)))
2835      (aver (or (eq size :word) (eq size :dword) (eq size :qword)))
2836      (maybe-emit-operand-size-prefix segment size))
2837    (maybe-emit-rex-for-ea segment src dst)
2838    (emit-byte segment #b00001111)
2839    (emit-byte segment (dpb (conditional-opcode cond) (byte 4 0) #b01000000))
2840    (emit-ea segment src (reg-tn-encoding dst))))
2841
2842 ;;;; conditional byte set
2843
2844 (define-instruction set (segment dst cond)
2845   (:printer cond-set ())
2846   (:emitter
2847    (maybe-emit-rex-for-ea segment dst nil)
2848    (emit-byte segment #b00001111)
2849    (emit-byte segment (dpb (conditional-opcode cond) (byte 4 0) #b10010000))
2850    (emit-ea segment dst #b000)))
2851 \f
2852 ;;;; enter/leave
2853
2854 (define-instruction enter (segment disp &optional (level 0))
2855   (:declare (type (unsigned-byte 16) disp)
2856             (type (unsigned-byte 8) level))
2857   (:printer enter-format ((op #b11001000)))
2858   (:emitter
2859    (emit-byte segment #b11001000)
2860    (emit-word segment disp)
2861    (emit-byte segment level)))
2862
2863 (define-instruction leave (segment)
2864   (:printer byte ((op #b11001001)))
2865   (:emitter
2866    (emit-byte segment #b11001001)))
2867 \f
2868 ;;;; interrupt instructions
2869
2870 (defun snarf-error-junk (sap offset &optional length-only)
2871   (let* ((length (sb!sys:sap-ref-8 sap offset))
2872          (vector (make-array length :element-type '(unsigned-byte 8))))
2873     (declare (type sb!sys:system-area-pointer sap)
2874              (type (unsigned-byte 8) length)
2875              (type (simple-array (unsigned-byte 8) (*)) vector))
2876     (cond (length-only
2877            (values 0 (1+ length) nil nil))
2878           (t
2879            (sb!kernel:copy-ub8-from-system-area sap (1+ offset)
2880                                                 vector 0 length)
2881            (collect ((sc-offsets)
2882                      (lengths))
2883              (lengths 1)                ; the length byte
2884              (let* ((index 0)
2885                     (error-number (sb!c:read-var-integer vector index)))
2886                (lengths index)
2887                (loop
2888                  (when (>= index length)
2889                    (return))
2890                  (let ((old-index index))
2891                    (sc-offsets (sb!c:read-var-integer vector index))
2892                    (lengths (- index old-index))))
2893                (values error-number
2894                        (1+ length)
2895                        (sc-offsets)
2896                        (lengths))))))))
2897
2898 #|
2899 (defmacro break-cases (breaknum &body cases)
2900   (let ((bn-temp (gensym)))
2901     (collect ((clauses))
2902       (dolist (case cases)
2903         (clauses `((= ,bn-temp ,(car case)) ,@(cdr case))))
2904       `(let ((,bn-temp ,breaknum))
2905          (cond ,@(clauses))))))
2906 |#
2907
2908 (defun break-control (chunk inst stream dstate)
2909   (declare (ignore inst))
2910   (flet ((nt (x) (if stream (sb!disassem:note x dstate))))
2911     ;; XXX: {BYTE,WORD}-IMM-CODE below is a macro defined by the
2912     ;; DEFINE-INSTRUCTION-FORMAT for {BYTE,WORD}-IMM above.  Due to
2913     ;; the spectacular design for DEFINE-INSTRUCTION-FORMAT (involving
2914     ;; a call to EVAL in order to define the macros at compile-time
2915     ;; only) they do not even show up as symbols in the target core.
2916     (case #!-ud2-breakpoints (byte-imm-code chunk dstate)
2917           #!+ud2-breakpoints (word-imm-code chunk dstate)
2918       (#.error-trap
2919        (nt "error trap")
2920        (sb!disassem:handle-break-args #'snarf-error-junk stream dstate))
2921       (#.cerror-trap
2922        (nt "cerror trap")
2923        (sb!disassem:handle-break-args #'snarf-error-junk stream dstate))
2924       (#.breakpoint-trap
2925        (nt "breakpoint trap"))
2926       (#.pending-interrupt-trap
2927        (nt "pending interrupt trap"))
2928       (#.halt-trap
2929        (nt "halt trap"))
2930       (#.fun-end-breakpoint-trap
2931        (nt "function end breakpoint trap"))
2932       (#.single-step-around-trap
2933        (nt "single-step trap (around)"))
2934       (#.single-step-before-trap
2935        (nt "single-step trap (before)")))))
2936
2937 (define-instruction break (segment code)
2938   (:declare (type (unsigned-byte 8) code))
2939   #!-ud2-breakpoints (:printer byte-imm ((op #b11001100)) '(:name :tab code)
2940                                :control #'break-control)
2941   #!+ud2-breakpoints (:printer word-imm ((op #b0000101100001111)) '(:name :tab code)
2942                                :control #'break-control)
2943   (:emitter
2944    #!-ud2-breakpoints (emit-byte segment #b11001100)
2945    ;; On darwin, trap handling via SIGTRAP is unreliable, therefore we
2946    ;; throw a sigill with 0x0b0f instead and check for this in the
2947    ;; SIGILL handler and pass it on to the sigtrap handler if
2948    ;; appropriate
2949    #!+ud2-breakpoints (emit-word segment #b0000101100001111)
2950    (emit-byte segment code)))
2951
2952 (define-instruction int (segment number)
2953   (:declare (type (unsigned-byte 8) number))
2954   (:printer byte-imm ((op #b11001101)))
2955   (:emitter
2956    (etypecase number
2957      ((member 3)
2958       (emit-byte segment #b11001100))
2959      ((unsigned-byte 8)
2960       (emit-byte segment #b11001101)
2961       (emit-byte segment number)))))
2962
2963 (define-instruction iret (segment)
2964   (:printer byte ((op #b11001111)))
2965   (:emitter
2966    (emit-byte segment #b11001111)))
2967 \f
2968 ;;;; processor control
2969
2970 (define-instruction hlt (segment)
2971   (:printer byte ((op #b11110100)))
2972   (:emitter
2973    (emit-byte segment #b11110100)))
2974
2975 (define-instruction nop (segment)
2976   (:printer byte ((op #b10010000)))
2977   (:emitter
2978    (emit-byte segment #b10010000)))
2979
2980 (define-instruction wait (segment)
2981   (:printer byte ((op #b10011011)))
2982   (:emitter
2983    (emit-byte segment #b10011011)))
2984
2985 (defun emit-prefix (segment name)
2986   (declare (ignorable segment))
2987   (ecase name
2988     ((nil))
2989     (:lock
2990      #!+sb-thread
2991      (emit-byte segment #xf0))))
2992
2993 ;;; FIXME: It would be better to make the disassembler understand the prefix as part
2994 ;;; of the instructions...
2995 (define-instruction lock (segment)
2996   (:printer byte ((op #b11110000)))
2997   (:emitter
2998    (bug "LOCK prefix used as a standalone instruction")))
2999 \f
3000 ;;;; miscellaneous hackery
3001
3002 (define-instruction byte (segment byte)
3003   (:emitter
3004    (emit-byte segment byte)))
3005
3006 (define-instruction word (segment word)
3007   (:emitter
3008    (emit-word segment word)))
3009
3010 (define-instruction dword (segment dword)
3011   (:emitter
3012    (emit-dword segment dword)))
3013
3014 (defun emit-header-data (segment type)
3015   (emit-back-patch segment
3016                    n-word-bytes
3017                    (lambda (segment posn)
3018                      (emit-qword segment
3019                                  (logior type
3020                                          (ash (+ posn
3021                                                  (component-header-length))
3022                                               (- n-widetag-bits
3023                                                  word-shift)))))))
3024
3025 (define-instruction simple-fun-header-word (segment)
3026   (:emitter
3027    (emit-header-data segment simple-fun-header-widetag)))
3028
3029 (define-instruction lra-header-word (segment)
3030   (:emitter
3031    (emit-header-data segment return-pc-header-widetag)))
3032 \f
3033 ;;;; Instructions required to do floating point operations using SSE
3034
3035 (defun emit-sse-inst (segment dst src prefix opcode
3036                       &key operand-size (remaining-bytes 0))
3037   (when prefix
3038     (emit-byte segment prefix))
3039   (if operand-size
3040       (maybe-emit-rex-for-ea segment src dst :operand-size operand-size)
3041       (maybe-emit-rex-for-ea segment src dst))
3042   (emit-byte segment #x0f)
3043   (emit-byte segment opcode)
3044   (emit-ea segment src (reg-tn-encoding dst) :remaining-bytes remaining-bytes))
3045
3046 ;; 0110 0110:0000 1111:0111 00gg: 11 010 xmmreg:imm8
3047
3048 (defun emit-sse-inst-with-imm (segment dst/src imm
3049                                prefix opcode /i
3050                                &key operand-size)
3051   (aver (<= 0 /i 7))
3052   (when prefix
3053     (emit-byte segment prefix))
3054   (maybe-emit-rex-prefix segment operand-size dst/src nil nil)
3055   (emit-byte segment #x0F)
3056   (emit-byte segment opcode)
3057   (emit-byte segment (logior (ash (logior #b11000 /i) 3)
3058                              (reg-tn-encoding dst/src)))
3059   (emit-byte segment imm))
3060
3061 (macrolet
3062     ((define-imm-sse-instruction (name opcode /i)
3063          `(define-instruction ,name (segment dst/src imm)
3064             (:printer ext-rex-xmm-imm ((prefix #x66) (op ,opcode) (/i ,/i)))
3065             (:printer ext-xmm-imm ((prefix #x66) (op ,opcode) (/i ,/i)))
3066             (:emitter
3067              (emit-sse-inst-with-imm segment dst/src imm
3068                                      #x66 ,opcode ,/i
3069                                      :operand-size :do-not-set)))))
3070   (define-imm-sse-instruction pslldq #x73 7)
3071   (define-imm-sse-instruction psllw #x71 6)
3072   (define-imm-sse-instruction pslld #x72 6)
3073   (define-imm-sse-instruction psllq #x73 6)
3074
3075   (define-imm-sse-instruction psraw-imm #x71 4)
3076   (define-imm-sse-instruction psrad-imm #x72 4)
3077
3078   (define-imm-sse-instruction psrldq #x73 3)
3079   (define-imm-sse-instruction psrlw #x71 2)
3080   (define-imm-sse-instruction psrld #x72 2)
3081   (define-imm-sse-instruction psrlq #x73 2))
3082
3083 ;;; Emit an SSE instruction that has an XMM register as the destination
3084 ;;; operand and for which the size of the operands is implicitly given
3085 ;;; by the instruction.
3086 (defun emit-regular-sse-inst (segment dst src prefix opcode
3087                               &key (remaining-bytes 0))
3088   (aver (xmm-register-p dst))
3089   (emit-sse-inst segment dst src prefix opcode
3090                  :operand-size :do-not-set
3091                  :remaining-bytes remaining-bytes))
3092
3093 ;;; Instructions having an XMM register as the destination operand
3094 ;;; and an XMM register or a memory location as the source operand.
3095 ;;; The operand size is implicitly given by the instruction.
3096
3097 (macrolet ((define-regular-sse-inst (name prefix opcode)
3098              `(define-instruction ,name (segment dst src)
3099                 ,@(if prefix
3100                       `((:printer ext-xmm-xmm/mem
3101                                   ((prefix ,prefix) (op ,opcode)))
3102                         (:printer ext-rex-xmm-xmm/mem
3103                                   ((prefix ,prefix) (op ,opcode))))
3104                       `((:printer xmm-xmm/mem ((op ,opcode)))
3105                         (:printer rex-xmm-xmm/mem ((op ,opcode)))))
3106                 (:emitter
3107                  (emit-regular-sse-inst segment dst src ,prefix ,opcode)))))
3108   ;; logical
3109   (define-regular-sse-inst andpd    #x66 #x54)
3110   (define-regular-sse-inst andps    nil  #x54)
3111   (define-regular-sse-inst andnpd   #x66 #x55)
3112   (define-regular-sse-inst andnps   nil  #x55)
3113   (define-regular-sse-inst orpd     #x66 #x56)
3114   (define-regular-sse-inst orps     nil  #x56)
3115   (define-regular-sse-inst pand     #x66 #xdb)
3116   (define-regular-sse-inst pandn    #x66 #xdf)
3117   (define-regular-sse-inst por      #x66 #xeb)
3118   (define-regular-sse-inst pxor     #x66 #xef)
3119   (define-regular-sse-inst xorpd    #x66 #x57)
3120   (define-regular-sse-inst xorps    nil  #x57)
3121   ;; comparison
3122   (define-regular-sse-inst comisd   #x66 #x2f)
3123   (define-regular-sse-inst comiss   nil  #x2f)
3124   (define-regular-sse-inst ucomisd  #x66 #x2e)
3125   (define-regular-sse-inst ucomiss  nil  #x2e)
3126   ;; integer comparison
3127   (define-regular-sse-inst pcmpeqb  #x66 #x74)
3128   (define-regular-sse-inst pcmpeqw  #x66 #x75)
3129   (define-regular-sse-inst pcmpeqd  #x66 #x76)
3130   (define-regular-sse-inst pcmpgtb  #x66 #x64)
3131   (define-regular-sse-inst pcmpgtw  #x66 #x65)
3132   (define-regular-sse-inst pcmpgtd  #x66 #x66)
3133   ;; max/min
3134   (define-regular-sse-inst maxpd    #x66 #x5f)
3135   (define-regular-sse-inst maxps    nil  #x5f)
3136   (define-regular-sse-inst maxsd    #xf2 #x5f)
3137   (define-regular-sse-inst maxss    #xf3 #x5f)
3138   (define-regular-sse-inst minpd    #x66 #x5d)
3139   (define-regular-sse-inst minps    nil  #x5d)
3140   (define-regular-sse-inst minsd    #xf2 #x5d)
3141   (define-regular-sse-inst minss    #xf3 #x5d)
3142   ;; integer max/min
3143   (define-regular-sse-inst pmaxsw   #x66 #xee)
3144   (define-regular-sse-inst pmaxub   #x66 #xde)
3145   (define-regular-sse-inst pminsw   #x66 #xea)
3146   (define-regular-sse-inst pminub   #x66 #xda)
3147   ;; arithmetic
3148   (define-regular-sse-inst addpd    #x66 #x58)
3149   (define-regular-sse-inst addps    nil  #x58)
3150   (define-regular-sse-inst addsd    #xf2 #x58)
3151   (define-regular-sse-inst addss    #xf3 #x58)
3152   (define-regular-sse-inst divpd    #x66 #x5e)
3153   (define-regular-sse-inst divps    nil  #x5e)
3154   (define-regular-sse-inst divsd    #xf2 #x5e)
3155   (define-regular-sse-inst divss    #xf3 #x5e)
3156   (define-regular-sse-inst mulpd    #x66 #x59)
3157   (define-regular-sse-inst mulps    nil  #x59)
3158   (define-regular-sse-inst mulsd    #xf2 #x59)
3159   (define-regular-sse-inst mulss    #xf3 #x59)
3160   (define-regular-sse-inst rccps    nil  #x53)
3161   (define-regular-sse-inst rcpss    #xf3 #x53)
3162   (define-regular-sse-inst rsqrtps  nil  #x52)
3163   (define-regular-sse-inst rsqrtss  #xf3 #x52)
3164   (define-regular-sse-inst sqrtps   nil  #x51)
3165   (define-regular-sse-inst sqrtsd   #xf2 #x51)
3166   (define-regular-sse-inst sqrtss   #xf3 #x51)
3167   (define-regular-sse-inst subpd    #x66 #x5c)
3168   (define-regular-sse-inst subps    nil  #x5c)
3169   (define-regular-sse-inst subsd    #xf2 #x5c)
3170   (define-regular-sse-inst subss    #xf3 #x5c)
3171   (define-regular-sse-inst unpckhpd #x66 #x15)
3172   (define-regular-sse-inst unpckhps nil  #x15)
3173   (define-regular-sse-inst unpcklpd #x66 #x14)
3174   (define-regular-sse-inst unpcklps nil  #x14)
3175   ;; integer arithmetic
3176   (define-regular-sse-inst paddb    #x66 #xfc)
3177   (define-regular-sse-inst paddw    #x66 #xfd)
3178   (define-regular-sse-inst paddd    #x66 #xfe)
3179   (define-regular-sse-inst paddq    #x66 #xd4)
3180   (define-regular-sse-inst paddsb   #x66 #xec)
3181   (define-regular-sse-inst paddsw   #x66 #xed)
3182   (define-regular-sse-inst paddusb  #x66 #xdc)
3183   (define-regular-sse-inst padduwb  #x66 #xdd)
3184   (define-regular-sse-inst pavgb    #x66 #xe0)
3185   (define-regular-sse-inst pavgw    #x66 #xe3)
3186   (define-regular-sse-inst pmaddwd  #x66 #xf5)
3187   (define-regular-sse-inst pmulhuw  #x66 #xe4)
3188   (define-regular-sse-inst pmulhw   #x66 #xe5)
3189   (define-regular-sse-inst pmullw   #x66 #xd5)
3190   (define-regular-sse-inst pmuludq  #x66 #xf4)
3191   (define-regular-sse-inst psadbw   #x66 #xf6)
3192   (define-regular-sse-inst psraw    #x66 #xe1)
3193   (define-regular-sse-inst psrad    #x66 #xe2)
3194   (define-regular-sse-inst psubb    #x66 #xf8)
3195   (define-regular-sse-inst psubw    #x66 #xf9)
3196   (define-regular-sse-inst psubd    #x66 #xfa)
3197   (define-regular-sse-inst psubq    #x66 #xfb)
3198   (define-regular-sse-inst psubsb   #x66 #xd8)
3199   (define-regular-sse-inst psubsw   #x66 #xd9)
3200   ;; conversion
3201   (define-regular-sse-inst cvtdq2pd #xf3 #xe6)
3202   (define-regular-sse-inst cvtdq2ps nil  #x5b)
3203   (define-regular-sse-inst cvtpd2dq #xf2 #xe6)
3204   (define-regular-sse-inst cvtpd2ps #x66 #x5a)
3205   (define-regular-sse-inst cvtps2dq #x66 #x5b)
3206   (define-regular-sse-inst cvtps2pd nil  #x5a)
3207   (define-regular-sse-inst cvtsd2ss #xf2 #x5a)
3208   (define-regular-sse-inst cvtss2sd #xf3 #x5a)
3209   (define-regular-sse-inst cvttpd2dq #x66 #xe6)
3210   (define-regular-sse-inst cvttps2dq #xf3 #x5b)
3211   ;; moves
3212   (define-regular-sse-inst movntdq #x66 #xe7)
3213   (define-regular-sse-inst movntpd #x66 #x2b)
3214   (define-regular-sse-inst movntps nil #x2b)
3215   ;; integer
3216   (define-regular-sse-inst packsswb  #x66 #x63)
3217   (define-regular-sse-inst packssdw  #x66 #x6b)
3218   (define-regular-sse-inst punpckhbw #x66 #x68)
3219   (define-regular-sse-inst punpckhwd #x66 #x69)
3220   (define-regular-sse-inst punpckhdq #x66 #x6a)
3221   (define-regular-sse-inst punpckhqdq #x66 #x6d)
3222   (define-regular-sse-inst punpcklbw #x66 #x60)
3223   (define-regular-sse-inst punpcklwd #x66 #x61)
3224   (define-regular-sse-inst punpckldq #x66 #x62)
3225   (define-regular-sse-inst punpcklqdq #x66 #x6c))
3226
3227 (macrolet ((define-xmm-shuffle-sse-inst (name prefix opcode)
3228                `(define-instruction ,name (segment dst src pattern)
3229                   ,@(if prefix
3230                         `((:printer ext-xmm-xmm/mem-imm ; suboptimal
3231                                     ((prefix ,prefix) (op ,opcode)))
3232                           (:printer ext-rex-xmm-xmm/mem-imm
3233                                     ((prefix ,prefix) (op ,opcode))))
3234                         `((:printer xmm-xmm/mem-imm ((op ,opcode)))
3235                           (:printer rex-xmm-xmm/mem-imm ((op ,opcode)))))
3236                   (:emitter
3237                    (aver (typep pattern '(unsigned-byte 8)))
3238                    (emit-regular-sse-inst segment dst src ,prefix ,opcode
3239                                           :remaining-bytes 1)
3240                    (emit-byte segment pattern)))))
3241   (define-xmm-shuffle-sse-inst pshufd  #x66 #x70)
3242   (define-xmm-shuffle-sse-inst pshufhw #xf3 #x70)
3243   (define-xmm-shuffle-sse-inst pshuflw #xf2 #x70)
3244   (define-xmm-shuffle-sse-inst shufpd  #x66 #xc6)
3245   (define-xmm-shuffle-sse-inst shufps  nil  #xc6))
3246
3247 ;; MASKMOVDQU (dst is DS:RDI)
3248 (define-instruction maskmovdqu (segment src mask)
3249   (:printer ext-xmm-xmm/mem
3250             ((prefix #x66) (op #xf7)))
3251   (:printer ext-rex-xmm-xmm/mem
3252             ((prefix #x66) (op #xf7)))
3253   (:emitter
3254    (aver (xmm-register-p src))
3255    (aver (xmm-register-p mask))
3256    (emit-regular-sse-inst segment src mask #x66 #xf7)))
3257
3258 (macrolet ((define-xmm-comparison-sse-inst (name prefix opcode &optional name-prefix name-suffix)
3259                (let ((printer (when name-prefix
3260                                 `'(,name-prefix cc ,name-suffix :tab reg ", " reg/mem))))
3261                  `(define-instruction ,name (segment op x y)
3262                     ,@(if prefix
3263                           `((:printer ext-xmm-xmm/mem-cmp
3264                                       ((prefix ,prefix) (op ,opcode))
3265                                       ,@(and printer `(,printer)))
3266                             (:printer ext-rex-xmm-xmm/mem-cmp
3267                                       ((prefix ,prefix) (op ,opcode))
3268                                       ,@(and printer `(,printer))))
3269                           `((:printer xmm-xmm/mem-cmp ((op ,opcode))
3270                                       ,@(and printer `(,printer)))
3271                             (:printer rex-xmm-xmm/mem-cmp ((op ,opcode))
3272                                       ,@(and printer `(,printer)))))
3273                     (:emitter
3274                      (let ((code (position op *sse-conditions*)))
3275                        (aver code)
3276                        (emit-regular-sse-inst segment x y ,prefix ,opcode
3277                                               :remaining-bytes 1)
3278                        (emit-byte segment code)))))))
3279   (define-xmm-comparison-sse-inst cmppd #x66 #xc2 "CMP" "PD")
3280   (define-xmm-comparison-sse-inst cmpps nil  #xc2 "CMP" "PS")
3281   (define-xmm-comparison-sse-inst cmpsd #xf2 #xc2 "CMP" "SD")
3282   (define-xmm-comparison-sse-inst cmpss #xf3 #xc2 "CMP" "SS"))
3283
3284 ;;; MOVSD, MOVSS
3285 (macrolet ((define-movsd/ss-sse-inst (name prefix)
3286              `(define-instruction ,name (segment dst src)
3287                 (:printer ext-xmm-xmm/mem-dir ((prefix ,prefix)
3288                                                (op #b0001000)))
3289                 (:printer ext-rex-xmm-xmm/mem-dir ((prefix ,prefix)
3290                                                    (op #b0001000)))
3291                 (:emitter
3292                  (cond ((xmm-register-p dst)
3293                         (emit-sse-inst segment dst src ,prefix #x10
3294                                        :operand-size :do-not-set))
3295                        (t
3296                         (aver (xmm-register-p src))
3297                         (emit-sse-inst segment src dst ,prefix #x11
3298                                        :operand-size :do-not-set)))))))
3299   (define-movsd/ss-sse-inst movsd #xf2)
3300   (define-movsd/ss-sse-inst movss #xf3))
3301
3302 ;;; Packed MOVs
3303 (macrolet ((define-mov-sse-inst (name prefix opcode-from opcode-to
3304                                       &key force-to-mem reg-reg-name)
3305                `(progn
3306                   ,(when reg-reg-name
3307                      `(define-instruction ,reg-reg-name (segment dst src)
3308                         (:emitter
3309                          (aver (xmm-register-p dst))
3310                          (aver (xmm-register-p src))
3311                          (emit-regular-sse-inst segment dst src ,prefix ,opcode-from))))
3312                   (define-instruction ,name (segment dst src)
3313                     ,@(if prefix
3314                           `((:printer ext-xmm-xmm/mem
3315                                       ((prefix ,prefix) (op ,opcode-from)))
3316                             (:printer ext-rex-xmm-xmm/mem
3317                                       ((prefix ,prefix) (op ,opcode-from)))
3318                             (:printer ext-xmm-xmm/mem
3319                                       ((prefix ,prefix) (op ,opcode-to))
3320                                       '(:name :tab reg/mem ", " reg))
3321                             (:printer ext-rex-xmm-xmm/mem
3322                                       ((prefix ,prefix) (op ,opcode-to))
3323                                       '(:name :tab reg/mem ", " reg)))
3324                           `((:printer xmm-xmm/mem
3325                                       ((op ,opcode-from)))
3326                             (:printer rex-xmm-xmm/mem
3327                                       ((op ,opcode-from)))
3328                             (:printer xmm-xmm/mem
3329                                       ((op ,opcode-to))
3330                                       '(:name :tab reg/mem ", " reg))
3331                             (:printer rex-xmm-xmm/mem
3332                                       ((op ,opcode-to))
3333                                       '(:name :tab reg/mem ", " reg))))
3334                     (:emitter
3335                      (cond ((xmm-register-p dst)
3336                             ,(when force-to-mem
3337                                `(aver (not (or (register-p src)
3338                                                (xmm-register-p src)))))
3339                             (emit-regular-sse-inst segment dst src ,prefix ,opcode-from))
3340                            (t
3341                             (aver (xmm-register-p src))
3342                             ,(when force-to-mem
3343                                `(aver (not (or (register-p dst)
3344                                                (xmm-register-p dst)))))
3345                             (emit-regular-sse-inst segment src dst ,prefix ,opcode-to))))))))
3346   ;; direction bit?
3347   (define-mov-sse-inst movapd #x66 #x28 #x29)
3348   (define-mov-sse-inst movaps nil  #x28 #x29)
3349   (define-mov-sse-inst movdqa #x66 #x6f #x7f)
3350   (define-mov-sse-inst movdqu #xf3 #x6f #x7f)
3351
3352   ;; use movhps for movlhps and movlps for movhlps
3353   (define-mov-sse-inst movhpd #x66 #x16 #x17 :force-to-mem t)
3354   (define-mov-sse-inst movhps nil  #x16 #x17 :reg-reg-name movlhps)
3355   (define-mov-sse-inst movlpd #x66 #x12 #x13 :force-to-mem t)
3356   (define-mov-sse-inst movlps nil  #x12 #x13 :reg-reg-name movhlps)
3357   (define-mov-sse-inst movupd #x66 #x10 #x11)
3358   (define-mov-sse-inst movups nil  #x10 #x11))
3359
3360 ;;; MOVQ
3361 (define-instruction movq (segment dst src)
3362   (:printer ext-xmm-xmm/mem ((prefix #xf3) (op #x7e)))
3363   (:printer ext-rex-xmm-xmm/mem ((prefix #xf3) (op #x7e)))
3364   (:printer ext-xmm-xmm/mem ((prefix #x66) (op #xd6))
3365             '(:name :tab reg/mem ", " reg))
3366   (:printer ext-rex-xmm-xmm/mem ((prefix #x66) (op #xd6))
3367             '(:name :tab reg/mem ", " reg))
3368   (:emitter
3369    (cond ((xmm-register-p dst)
3370           (emit-sse-inst segment dst src #xf3 #x7e
3371                          :operand-size :do-not-set))
3372          (t
3373           (aver (xmm-register-p src))
3374           (emit-sse-inst segment src dst #x66 #xd6
3375                          :operand-size :do-not-set)))))
3376
3377 ;;; Instructions having an XMM register as the destination operand
3378 ;;; and a general-purpose register or a memory location as the source
3379 ;;; operand. The operand size is calculated from the source operand.
3380
3381 ;;; MOVD - Move a 32- or 64-bit value from a general-purpose register or
3382 ;;; a memory location to the low order 32 or 64 bits of an XMM register
3383 ;;; with zero extension or vice versa.
3384 ;;; We do not support the MMX version of this instruction.
3385 (define-instruction movd (segment dst src)
3386   (:printer ext-xmm-reg/mem ((prefix #x66) (op #x6e)))
3387   (:printer ext-rex-xmm-reg/mem ((prefix #x66) (op #x6e)))
3388   (:printer ext-xmm-reg/mem ((prefix #x66) (op #x7e))
3389             '(:name :tab reg/mem ", " reg))
3390   (:printer ext-rex-xmm-reg/mem ((prefix #x66) (op #x7e))
3391             '(:name :tab reg/mem ", " reg))
3392   (:emitter
3393    (cond ((xmm-register-p dst)
3394           (emit-sse-inst segment dst src #x66 #x6e))
3395          (t
3396           (aver (xmm-register-p src))
3397           (emit-sse-inst segment src dst #x66 #x7e)))))
3398
3399 (macrolet ((define-integer-source-sse-inst (name prefix opcode &key mem-only)
3400              `(define-instruction ,name (segment dst src)
3401                 ,@(if prefix
3402                       `((:printer ext-xmm-reg/mem ((prefix ,prefix) (op ,opcode)))
3403                         (:printer ext-rex-xmm-reg/mem ((prefix ,prefix) (op ,opcode))))
3404                       `((:printer xmm-reg/mem ((op ,opcode)))
3405                         (:printer rex-xmm-reg/mem ((op ,opcode)))))
3406
3407                 (:emitter
3408                  (aver (xmm-register-p dst))
3409                  ,(when mem-only
3410                     `(aver (not (or (register-p src)
3411                                     (xmm-register-p src)))))
3412                  (let ((src-size (operand-size src)))
3413                    (aver (or (eq src-size :qword) (eq src-size :dword))))
3414                  (emit-sse-inst segment dst src ,prefix ,opcode)))))
3415   (define-integer-source-sse-inst cvtsi2sd #xf2 #x2a)
3416   (define-integer-source-sse-inst cvtsi2ss #xf3 #x2a)
3417   ;; FIXME: memory operand is always a QWORD
3418   (define-integer-source-sse-inst cvtpi2pd #x66 #x2a :mem-only t)
3419   (define-integer-source-sse-inst cvtpi2ps nil  #x2a :mem-only t))
3420
3421 ;;; Instructions having a general-purpose register as the destination
3422 ;;; operand and an XMM register or a memory location as the source
3423 ;;; operand. The operand size is calculated from the destination
3424 ;;; operand.
3425
3426 (macrolet ((define-gpr-destination-sse-inst (name prefix opcode &key reg-only)
3427              `(define-instruction ,name (segment dst src)
3428                 ,@(if prefix
3429                       `((:printer ext-reg-xmm/mem ((prefix ,prefix) (op ,opcode)))
3430                         (:printer ext-rex-reg-xmm/mem ((prefix ,prefix) (op ,opcode))))
3431                       `((:printer reg-xmm/mem ((op ,opcode)))
3432                         (:printer rex-reg-xmm/mem ((op ,opcode)))))
3433                 (:emitter
3434                  (aver (register-p dst))
3435                  ,(when reg-only
3436                     `(aver (xmm-register-p src)))
3437                  (let ((dst-size (operand-size dst)))
3438                    (aver (or (eq dst-size :qword) (eq dst-size :dword)))
3439                    (emit-sse-inst segment dst src ,prefix ,opcode
3440                                   :operand-size dst-size))))))
3441   (define-gpr-destination-sse-inst cvtsd2si  #xf2 #x2d)
3442   (define-gpr-destination-sse-inst cvtss2si  #xf3 #x2d)
3443   (define-gpr-destination-sse-inst cvttsd2si #xf2 #x2c)
3444   (define-gpr-destination-sse-inst cvttss2si #xf3 #x2c)
3445   (define-gpr-destination-sse-inst movmskpd  #x66 #x50 :reg-only t)
3446   (define-gpr-destination-sse-inst movmskps  nil  #x50 :reg-only t)
3447   (define-gpr-destination-sse-inst pmovmskb  #x66 #xd7 :reg-only t))
3448
3449 ;;; Other SSE instructions
3450
3451 ;; FIXME: is that right!?
3452 (define-instruction movnti (segment dst src)
3453   (:printer ext-reg-reg/mem-no-width ((op #xc3)))
3454   (:printer rex-ext-reg-reg/mem-no-width ((op #xc3)))
3455   (:emitter
3456    (aver (not (or (register-p dst)
3457                   (xmm-register-p dst))))
3458    (aver (register-p src))
3459    (maybe-emit-rex-for-ea segment src dst)
3460    (emit-byte segment #x0f)
3461    (emit-byte segment #xc3)
3462    (emit-ea segment dst (reg-tn-encoding src))))
3463
3464 (define-instruction prefetch (segment type src)
3465   (:printer ext-reg/mem-no-width ((op '(#x18 0)))
3466             '("PREFETCHNTA" :tab reg/mem))
3467   (:printer ext-reg/mem-no-width ((op '(#x18 1)))
3468             '("PREFETCHT0" :tab reg/mem))
3469   (:printer ext-reg/mem-no-width ((op '(#x18 2)))
3470             '("PREFETCHT1" :tab reg/mem))
3471   (:printer ext-reg/mem-no-width ((op '(#x18 3)))
3472             '("PREFETCHT2" :tab reg/mem))
3473   (:printer rex-ext-reg/mem-no-width ((op '(#x18 0)))
3474             '("PREFETCHNTA" :tab reg/mem))
3475   (:printer rex-ext-reg/mem-no-width ((op '(#x18 1)))
3476             '("PREFETCHT0" :tab reg/mem))
3477   (:printer rex-ext-reg/mem-no-width ((op '(#x18 2)))
3478             '("PREFETCHT1" :tab reg/mem))
3479   (:printer rex-ext-reg/mem-no-width ((op '(#x18 3)))
3480             '("PREFETCHT2" :tab reg/mem))
3481   (:emitter
3482    (aver (not (or (register-p src)
3483                   (xmm-register-p src))))
3484    (aver (eq (operand-size src) :byte))
3485    (let ((type (position type #(:nta :t0 :t1 :t2))))
3486      (aver type)
3487      (maybe-emit-rex-for-ea segment src nil)
3488      (emit-byte segment #x0f)
3489      (emit-byte segment #x18)
3490      (emit-ea segment src type))))
3491
3492 (define-instruction clflush (segment src)
3493   (:printer ext-reg/mem-no-width ((op '(#xae 7))))
3494   (:printer rex-ext-reg/mem-no-width ((op '(#xae 7))))
3495   (:emitter
3496    (aver (not (or (register-p src)
3497                   (xmm-register-p src))))
3498    (aver (eq (operand-size src) :byte))
3499    (maybe-emit-rex-for-ea segment src nil)
3500    (emit-byte segment #x0f)
3501    (emit-byte segment #x18)
3502    (emit-ea segment src 7)))
3503
3504 (macrolet ((define-fence-instruction (name last-byte)
3505                `(define-instruction ,name (segment)
3506                   (:printer three-bytes ((op '(#x0f #xae ,last-byte))))
3507                   (:emitter
3508                    (emit-byte segment #x0f)
3509                    (emit-byte segment #xae)
3510                    (emit-byte segment ,last-byte)))))
3511   (define-fence-instruction lfence #b11101000)
3512   (define-fence-instruction mfence #b11110000)
3513   (define-fence-instruction sfence #b11111000))
3514
3515 (define-instruction pause (segment)
3516   (:printer two-bytes ((op '(#xf3 #x90))))
3517   (:emitter
3518    (emit-byte segment #xf3)
3519    (emit-byte segment #x90)))
3520
3521 (define-instruction ldmxcsr (segment src)
3522   (:printer ext-reg/mem-no-width ((op '(#xae 2))))
3523   (:printer rex-ext-reg/mem-no-width ((op '(#xae 2))))
3524   (:emitter
3525    (aver (not (or (register-p src)
3526                   (xmm-register-p src))))
3527    (aver (eq (operand-size src) :dword))
3528    (maybe-emit-rex-for-ea segment src nil)
3529    (emit-byte segment #x0f)
3530    (emit-byte segment #xae)
3531    (emit-ea segment src 2)))
3532
3533 (define-instruction stmxcsr (segment dst)
3534   (:printer ext-reg/mem-no-width ((op '(#xae 3))))
3535   (:printer rex-ext-reg/mem-no-width ((op '(#xae 3))))
3536   (:emitter
3537    (aver (not (or (register-p dst)
3538                   (xmm-register-p dst))))
3539    (aver (eq (operand-size dst) :dword))
3540    (maybe-emit-rex-for-ea segment dst nil)
3541    (emit-byte segment #x0f)
3542    (emit-byte segment #xae)
3543    (emit-ea segment dst 3)))
3544
3545 ;;;; Miscellany
3546
3547 (define-instruction cpuid (segment)
3548   (:printer two-bytes ((op '(#b00001111 #b10100010))))
3549   (:emitter
3550    (emit-byte segment #b00001111)
3551    (emit-byte segment #b10100010)))
3552
3553 (define-instruction rdtsc (segment)
3554   (:printer two-bytes ((op '(#b00001111 #b00110001))))
3555   (:emitter
3556    (emit-byte segment #b00001111)
3557    (emit-byte segment #b00110001)))
3558
3559 ;;;; Late VM definitions
3560
3561 (defun canonicalize-inline-constant (constant &aux (alignedp nil))
3562   (let ((first (car constant)))
3563     (when (eql first :aligned)
3564       (setf alignedp t)
3565       (pop constant)
3566       (setf first (car constant)))
3567     (typecase first
3568       (single-float (setf constant (list :single-float first)))
3569       (double-float (setf constant (list :double-float first)))
3570       ((complex single-float)
3571          (setf constant (list :complex-single-float first)))
3572       ((complex double-float)
3573          (setf constant (list :complex-double-float first)))))
3574   (destructuring-bind (type value) constant
3575     (ecase type
3576       ((:byte :word :dword :qword)
3577          (aver (integerp value))
3578          (cons type value))
3579       ((:base-char)
3580          (aver (base-char-p value))
3581          (cons :byte (char-code value)))
3582       ((:character)
3583          (aver (characterp value))
3584          (cons :dword (char-code value)))
3585       ((:single-float)
3586          (aver (typep value 'single-float))
3587          (cons (if alignedp :oword :dword)
3588                (ldb (byte 32 0) (single-float-bits value))))
3589       ((:double-float)
3590          (aver (typep value 'double-float))
3591          (cons (if alignedp :oword :qword)
3592                (ldb (byte 64 0) (logior (ash (double-float-high-bits value) 32)
3593                                         (double-float-low-bits value)))))
3594       ((:complex-single-float)
3595          (aver (typep value '(complex single-float)))
3596          (cons (if alignedp :oword :qword)
3597                (ldb (byte 64 0)
3598                     (logior (ash (single-float-bits (imagpart value)) 32)
3599                             (ldb (byte 32 0)
3600                                  (single-float-bits (realpart value)))))))
3601       ((:oword :sse)
3602          (aver (integerp value))
3603          (cons :oword value))
3604       ((:complex-double-float)
3605          (aver (typep value '(complex double-float)))
3606          (cons :oword
3607                (logior (ash (double-float-high-bits (imagpart value)) 96)
3608                        (ash (double-float-low-bits (imagpart value)) 64)
3609                        (ash (ldb (byte 32 0)
3610                                  (double-float-high-bits (realpart value)))
3611                             32)
3612                        (double-float-low-bits (realpart value))))))))
3613
3614 (defun inline-constant-value (constant)
3615   (let ((label (gen-label))
3616         (size  (ecase (car constant)
3617                  ((:byte :word :dword :qword) (car constant))
3618                  ((:oword) :qword))))
3619     (values label (make-ea size
3620                            :disp (make-fixup nil :code-object label)))))
3621
3622 (defun emit-constant-segment-header (constants optimize)
3623   (declare (ignore constants))
3624   (loop repeat (if optimize 64 16) do (inst byte #x90)))
3625
3626 (defun size-nbyte (size)
3627   (ecase size
3628     (:byte  1)
3629     (:word  2)
3630     (:dword 4)
3631     (:qword 8)
3632     (:oword 16)))
3633
3634 (defun sort-inline-constants (constants)
3635   (stable-sort constants #'> :key (lambda (constant)
3636                                     (size-nbyte (caar constant)))))
3637
3638 (defun emit-inline-constant (constant label)
3639   (let ((size (size-nbyte (car constant))))
3640     (emit-alignment (integer-length (1- size)))
3641     (emit-label label)
3642     (let ((val (cdr constant)))
3643       (loop repeat size
3644             do (inst byte (ldb (byte 8 0) val))
3645                (setf val (ash val -8))))))