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