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