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