0.9.13.15:
[sbcl.git] / src / compiler / x86-64 / insts.lisp
1 ;;;; that part of the description of the x86-64 instruction set
2 ;;;; which can live on the cross-compilation host
3
4 ;;;; This software is part of the SBCL system. See the README file for
5 ;;;; more information.
6 ;;;;
7 ;;;; This software is derived from the CMU CL system, which was
8 ;;;; written at Carnegie Mellon University and released into the
9 ;;;; public domain. The software is in the public domain and is
10 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
11 ;;;; files for more information.
12
13 (in-package "SB!VM")
14 ;;; FIXME: SB!DISASSEM: prefixes are used so widely in this file that
15 ;;; I wonder whether the separation of the disassembler from the
16 ;;; virtual machine is valid or adds value.
17
18 ;;; Note: In CMU CL, this used to be a call to SET-DISASSEM-PARAMS.
19 (setf sb!disassem:*disassem-inst-alignment-bytes* 1)
20
21 ;;; This type is used mostly in disassembly and represents legacy
22 ;;; registers only. R8-R15 are handled separately.
23 (deftype reg () '(unsigned-byte 3))
24
25 ;;; This includes legacy registers and R8-R15.
26 (deftype full-reg () '(unsigned-byte 4))
27
28 ;;; The XMM registers XMM0 - XMM15.
29 (deftype xmmreg () '(unsigned-byte 4))
30
31 ;;; Default word size for the chip: if the operand size /= :dword
32 ;;; we need to output #x66 (or REX) prefix
33 (def!constant +default-operand-size+ :dword)
34
35 ;;; The default address size for the chip. It could be overwritten
36 ;;; to :dword with a #x67 prefix, but this is never needed by SBCL
37 ;;; and thus not supported by this assembler/disassembler.
38 (def!constant +default-address-size+ :qword)
39 \f
40 (eval-when (#-sb-xc :compile-toplevel :load-toplevel :execute)
41
42 (defun offset-next (value dstate)
43   (declare (type integer value)
44            (type sb!disassem:disassem-state dstate))
45   (+ (sb!disassem:dstate-next-addr dstate) value))
46
47 (defparameter *byte-reg-names*
48   #(al cl dl bl spl bpl sil dil r8b r9b r10b r11b r12b r13b r14b r15b))
49 (defparameter *high-byte-reg-names*
50   #(ah ch dh bh))
51 (defparameter *word-reg-names*
52   #(ax cx dx bx sp bp si di r8w r9w r10w r11w r12w r13w r14w r15w))
53 (defparameter *dword-reg-names*
54   #(eax ecx edx ebx esp ebp esi edi r8d r9d r10d r11d r12d r13d r14d r15d))
55 (defparameter *qword-reg-names*
56   #(rax rcx rdx rbx rsp rbp rsi rdi r8 r9 r10 r11 r12 r13 r14 r15))
57
58 ;;; The printers for registers, memory references and immediates need to
59 ;;; take into account the width bit in the instruction, whether a #x66
60 ;;; or a REX prefix was issued, and the contents of the REX prefix.
61 ;;; This is implemented using prefilters to put flags into the slot
62 ;;; INST-PROPERTIES of the DSTATE.  These flags are the following
63 ;;; symbols:
64 ;;;
65 ;;; OPERAND-SIZE-8   The width bit was zero
66 ;;; OPERAND-SIZE-16  The "operand size override" prefix (#x66) was found
67 ;;; REX              A REX prefix was found
68 ;;; REX-W            A REX prefix with the "operand width" bit set was
69 ;;;                  found
70 ;;; REX-R            A REX prefix with the "register" bit set was found
71 ;;; REX-X            A REX prefix with the "index" bit set was found
72 ;;; REX-B            A REX prefix with the "base" bit set was found
73
74 ;;; Return the operand size depending on the prefixes and width bit as
75 ;;; stored in DSTATE.
76 (defun inst-operand-size (dstate)
77   (declare (type sb!disassem:disassem-state dstate))
78   (cond ((sb!disassem:dstate-get-inst-prop dstate 'operand-size-8)
79          :byte)
80         ((sb!disassem:dstate-get-inst-prop dstate 'rex-w)
81          :qword)
82         ((sb!disassem:dstate-get-inst-prop dstate 'operand-size-16)
83          :word)
84         (t
85          +default-operand-size+)))
86
87 ;;; The same as INST-OPERAND-SIZE, but for those instructions (e.g.
88 ;;; PUSH, JMP) that have a default operand size of :qword. It can only
89 ;;; be overwritten to :word.
90 (defun inst-operand-size-default-qword (dstate)
91   (declare (type sb!disassem:disassem-state dstate))
92   (if (sb!disassem:dstate-get-inst-prop dstate 'operand-size-16)
93       :word
94       :qword))
95
96 ;;; Print to STREAM the name of the general-purpose register encoded by
97 ;;; VALUE and of size WIDTH. For robustness, the high byte registers
98 ;;; (AH, BH, CH, DH) are correctly detected, too, although the compiler
99 ;;; does not use them.
100 (defun print-reg-with-width (value width stream dstate)
101   (declare (type full-reg value)
102            (type stream stream)
103            (type sb!disassem:disassem-state dstate))
104   (princ (if (and (eq width :byte)
105                   (<= 4 value 7)
106                   (not (sb!disassem:dstate-get-inst-prop dstate 'rex)))
107              (aref *high-byte-reg-names* (- value 4))
108              (aref (ecase width
109                      (:byte *byte-reg-names*)
110                      (:word *word-reg-names*)
111                      (:dword *dword-reg-names*)
112                      (:qword *qword-reg-names*))
113                    value))
114          stream)
115   ;; XXX plus should do some source-var notes
116   )
117
118 (defun print-reg (value stream dstate)
119   (declare (type full-reg value)
120            (type stream stream)
121            (type sb!disassem:disassem-state dstate))
122   (print-reg-with-width value
123                         (inst-operand-size dstate)
124                         stream
125                         dstate))
126
127 (defun print-reg-default-qword (value stream dstate)
128   (declare (type full-reg value)
129            (type stream stream)
130            (type sb!disassem:disassem-state dstate))
131   (print-reg-with-width value
132                         (inst-operand-size-default-qword dstate)
133                         stream
134                         dstate))
135
136 (defun print-byte-reg (value stream dstate)
137   (declare (type full-reg value)
138            (type stream stream)
139            (type sb!disassem:disassem-state dstate))
140   (print-reg-with-width value :byte stream dstate))
141
142 (defun print-addr-reg (value stream dstate)
143   (declare (type full-reg value)
144            (type stream stream)
145            (type sb!disassem:disassem-state dstate))
146   (print-reg-with-width value +default-address-size+ stream dstate))
147
148 ;;; Print a register or a memory reference of the given WIDTH.
149 ;;; If SIZED-P is true, add an explicit size indicator for memory
150 ;;; references.
151 (defun print-reg/mem-with-width (value width sized-p stream dstate)
152   (declare (type (or list full-reg) value)
153            (type (member :byte :word :dword :qword) width)
154            (type boolean sized-p)
155            (type stream stream)
156            (type sb!disassem:disassem-state dstate))
157   (if (typep value 'full-reg)
158       (print-reg-with-width value width stream dstate)
159     (print-mem-access value (and sized-p width) stream dstate)))
160
161 ;;; Print a register or a memory reference. The width is determined by
162 ;;; calling INST-OPERAND-SIZE.
163 (defun print-reg/mem (value stream dstate)
164   (declare (type (or list full-reg) value)
165            (type stream stream)
166            (type sb!disassem:disassem-state dstate))
167   (print-reg/mem-with-width
168    value (inst-operand-size dstate) nil stream dstate))
169
170 ;; Same as print-reg/mem, but prints an explicit size indicator for
171 ;; memory references.
172 (defun print-sized-reg/mem (value stream dstate)
173   (declare (type (or list full-reg) value)
174            (type stream stream)
175            (type sb!disassem:disassem-state dstate))
176   (print-reg/mem-with-width
177    value (inst-operand-size dstate) t stream dstate))
178
179 ;;; Same as print-sized-reg/mem, but with a default operand size of
180 ;;; :qword.
181 (defun print-sized-reg/mem-default-qword (value stream dstate)
182   (declare (type (or list full-reg) value)
183            (type stream stream)
184            (type sb!disassem:disassem-state dstate))
185   (print-reg/mem-with-width
186    value (inst-operand-size-default-qword dstate) t stream dstate))
187
188 (defun print-sized-byte-reg/mem (value stream dstate)
189   (declare (type (or list full-reg) value)
190            (type stream stream)
191            (type sb!disassem:disassem-state dstate))
192   (print-reg/mem-with-width value :byte t stream dstate))
193
194 (defun print-sized-word-reg/mem (value stream dstate)
195   (declare (type (or list full-reg) value)
196            (type stream stream)
197            (type sb!disassem:disassem-state dstate))
198   (print-reg/mem-with-width value :word t stream dstate))
199
200 (defun print-sized-dword-reg/mem (value stream dstate)
201   (declare (type (or list full-reg) value)
202            (type stream stream)
203            (type sb!disassem:disassem-state dstate))
204   (print-reg/mem-with-width value :dword t stream dstate))
205
206 (defun print-label (value stream dstate)
207   (declare (ignore dstate))
208   (sb!disassem:princ16 value stream))
209
210 (defun print-xmmreg (value stream dstate)
211   (declare (type xmmreg value)
212            (type stream stream)
213            (ignore dstate))
214   (format stream "XMM~d" value))
215
216 (defun print-xmmreg/mem (value stream dstate)
217   (declare (type (or list xmmreg) value)
218            (type stream stream)
219            (type sb!disassem:disassem-state dstate))
220   (if (typep value 'xmmreg)
221       (print-xmmreg value stream dstate)
222     (print-mem-access value nil stream dstate)))
223
224 ;; Same as print-xmmreg/mem, but prints an explicit size indicator for
225 ;; memory references.
226 (defun print-sized-xmmreg/mem (value stream dstate)
227   (declare (type (or list xmmreg) value)
228            (type stream stream)
229            (type sb!disassem:disassem-state dstate))
230   (if (typep value 'xmmreg)
231       (print-xmmreg value stream dstate)
232     (print-mem-access value (inst-operand-size dstate) stream dstate)))
233
234 ;;; This prefilter is used solely for its side effects, namely to put
235 ;;; the bits found in the REX prefix into the DSTATE for use by other
236 ;;; prefilters and by printers.
237 (defun prefilter-wrxb (value dstate)
238   (declare (type (unsigned-byte 4) value)
239            (type sb!disassem:disassem-state dstate))
240   (sb!disassem:dstate-put-inst-prop dstate 'rex)
241   (when (plusp (logand value #b1000))
242     (sb!disassem:dstate-put-inst-prop dstate 'rex-w))
243   (when (plusp (logand value #b0100))
244     (sb!disassem:dstate-put-inst-prop dstate 'rex-r))
245   (when (plusp (logand value #b0010))
246     (sb!disassem:dstate-put-inst-prop dstate 'rex-x))
247   (when (plusp (logand value #b0001))
248     (sb!disassem:dstate-put-inst-prop dstate 'rex-b))
249   value)
250
251 ;;; This prefilter is used solely for its side effect, namely to put
252 ;;; the property OPERAND-SIZE-8 into the DSTATE if VALUE is 0.
253 (defun prefilter-width (value dstate)
254   (declare (type bit value)
255            (type sb!disassem:disassem-state dstate))
256   (when (zerop value)
257     (sb!disassem:dstate-put-inst-prop dstate 'operand-size-8))
258   value)
259
260 ;;; This prefilter is used solely for its side effect, namely to put
261 ;;; the property OPERAND-SIZE-16 into the DSTATE.
262 (defun prefilter-x66 (value dstate)
263   (declare (type (eql #x66) value)
264            (ignore value)
265            (type sb!disassem:disassem-state dstate))
266   (sb!disassem:dstate-put-inst-prop dstate 'operand-size-16))
267
268 ;;; A register field that can be extended by REX.R.
269 (defun prefilter-reg-r (value dstate)
270   (declare (type reg value)
271            (type sb!disassem:disassem-state dstate))
272   (if (sb!disassem::dstate-get-inst-prop dstate 'rex-r)
273       (+ value 8)
274       value))
275
276 ;;; A register field that can be extended by REX.B.
277 (defun prefilter-reg-b (value dstate)
278   (declare (type reg value)
279            (type sb!disassem:disassem-state dstate))
280   (if (sb!disassem::dstate-get-inst-prop dstate 'rex-b)
281       (+ value 8)
282       value))
283
284 ;;; Returns either an integer, meaning a register, or a list of
285 ;;; (BASE-REG OFFSET INDEX-REG INDEX-SCALE), where any component
286 ;;; may be missing or nil to indicate that it's not used or has the
287 ;;; obvious default value (e.g., 1 for the index-scale). VALUE is a list
288 ;;; of the mod and r/m field of the ModRM byte of the instruction.
289 ;;; Depending on VALUE a SIB byte and/or an offset may be read. The
290 ;;; REX.B bit from DSTATE is used to extend the sole register or the
291 ;;; BASE-REG to a full register, the REX.X bit does the same for the
292 ;;; INDEX-REG.
293 (defun prefilter-reg/mem (value dstate)
294   (declare (type list value)
295            (type sb!disassem:disassem-state dstate))
296   (let ((mod (first value))
297         (r/m (second value)))
298     (declare (type (unsigned-byte 2) mod)
299              (type (unsigned-byte 3) r/m))
300     (let ((full-reg (if (sb!disassem:dstate-get-inst-prop dstate 'rex-b)
301                         (+ r/m 8)
302                         r/m)))
303       (declare (type full-reg full-reg))
304       (cond ((= mod #b11)
305              ;; registers
306              full-reg)
307             ((= r/m #b100)
308              ;; sib byte
309              (let ((sib (sb!disassem:read-suffix 8 dstate)))
310                (declare (type (unsigned-byte 8) sib))
311                (let ((base-reg (ldb (byte 3 0) sib))
312                      (index-reg (ldb (byte 3 3) sib))
313                      (index-scale (ldb (byte 2 6) sib)))
314                  (declare (type (unsigned-byte 3) base-reg index-reg)
315                           (type (unsigned-byte 2) index-scale))
316                  (let* ((offset
317                          (case mod
318                                (#b00
319                                 (if (= base-reg #b101)
320                                     (sb!disassem:read-signed-suffix 32 dstate)
321                                   nil))
322                                (#b01
323                                 (sb!disassem:read-signed-suffix 8 dstate))
324                                (#b10
325                                 (sb!disassem:read-signed-suffix 32 dstate)))))
326                    (list (unless (and (= mod #b00) (= base-reg #b101))
327                            (if (sb!disassem:dstate-get-inst-prop dstate 'rex-b)
328                                (+ base-reg 8)
329                                base-reg))
330                          offset
331                          (unless (= index-reg #b100)
332                            (if (sb!disassem:dstate-get-inst-prop dstate 'rex-x)
333                                (+ index-reg 8)
334                                index-reg))
335                          (ash 1 index-scale))))))
336             ((and (= mod #b00) (= r/m #b101))
337              (list 'rip (sb!disassem:read-signed-suffix 32 dstate)))
338             ((= mod #b00)
339              (list full-reg))
340             ((= mod #b01)
341            (list full-reg (sb!disassem:read-signed-suffix 8 dstate)))
342           (t                            ; (= mod #b10)
343            (list full-reg (sb!disassem:read-signed-suffix 32 dstate)))))))
344
345 (defun read-address (value dstate)
346   (declare (ignore value))              ; always nil anyway
347   (sb!disassem:read-suffix (width-bits (inst-operand-size dstate)) dstate))
348
349 (defun width-bits (width)
350   (ecase width
351     (:byte 8)
352     (:word 16)
353     (:dword 32)
354     (:qword 64)))
355
356 ) ; EVAL-WHEN
357 \f
358 ;;;; disassembler argument types
359
360 ;;; Used to capture the lower four bits of the REX prefix.
361 (sb!disassem:define-arg-type wrxb
362   :prefilter #'prefilter-wrxb)
363
364 (sb!disassem:define-arg-type width
365   :prefilter #'prefilter-width
366   :printer (lambda (value stream dstate)
367              (declare (ignore value))
368              (princ (schar (symbol-name (inst-operand-size dstate)) 0)
369                     stream)))
370
371 ;;; Used to capture the effect of the #x66 operand size override prefix.
372 (sb!disassem:define-arg-type x66
373   :prefilter #'prefilter-x66)
374
375 (sb!disassem:define-arg-type displacement
376   :sign-extend t
377   :use-label #'offset-next
378   :printer (lambda (value stream dstate)
379              (sb!disassem:maybe-note-assembler-routine value nil dstate)
380              (print-label value stream dstate)))
381
382 (sb!disassem:define-arg-type accum
383   :printer (lambda (value stream dstate)
384              (declare (ignore value)
385                       (type stream stream)
386                       (type sb!disassem:disassem-state dstate))
387              (print-reg 0 stream dstate)))
388
389 (sb!disassem:define-arg-type reg
390   :prefilter #'prefilter-reg-r
391   :printer #'print-reg)
392
393 (sb!disassem:define-arg-type reg-b
394   :prefilter #'prefilter-reg-b
395   :printer #'print-reg)
396
397 (sb!disassem:define-arg-type reg-b-default-qword
398   :prefilter #'prefilter-reg-b
399   :printer #'print-reg-default-qword)
400
401 (sb!disassem:define-arg-type imm-addr
402   :prefilter #'read-address
403   :printer #'print-label)
404
405 ;;; Normally, immediate values for an operand size of :qword are of size
406 ;;; :dword and are sign-extended to 64 bits. For an exception, see the
407 ;;; argument type definition following this one.
408 (sb!disassem:define-arg-type signed-imm-data
409   :prefilter (lambda (value dstate)
410                (declare (ignore value)) ; always nil anyway
411                (let ((width (width-bits (inst-operand-size dstate))))
412                  (when (= width 64)
413                    (setf width 32))
414                  (sb!disassem:read-signed-suffix width dstate))))
415
416 ;;; Used by the variant of the MOV instruction with opcode B8 which can
417 ;;; move immediates of all sizes (i.e. including :qword) into a
418 ;;; register.
419 (sb!disassem:define-arg-type signed-imm-data-upto-qword
420   :prefilter (lambda (value dstate)
421                (declare (ignore value)) ; always nil anyway
422                (sb!disassem:read-signed-suffix
423                 (width-bits (inst-operand-size dstate))
424                 dstate)))
425
426 ;;; Used by those instructions that have a default operand size of
427 ;;; :qword. Nevertheless the immediate is at most of size :dword.
428 ;;; The only instruction of this kind having a variant with an immediate
429 ;;; argument is PUSH.
430 (sb!disassem:define-arg-type signed-imm-data-default-qword
431   :prefilter (lambda (value dstate)
432                (declare (ignore value)) ; always nil anyway
433                (let ((width (width-bits
434                              (inst-operand-size-default-qword dstate))))
435                  (when (= width 64)
436                    (setf width 32))
437                  (sb!disassem:read-signed-suffix width dstate))))
438
439 (sb!disassem:define-arg-type signed-imm-byte
440   :prefilter (lambda (value dstate)
441                (declare (ignore value)) ; always nil anyway
442                (sb!disassem:read-signed-suffix 8 dstate)))
443
444 (sb!disassem:define-arg-type imm-byte
445   :prefilter (lambda (value dstate)
446                (declare (ignore value)) ; always nil anyway
447                (sb!disassem:read-suffix 8 dstate)))
448
449 ;;; needed for the ret imm16 instruction
450 (sb!disassem:define-arg-type imm-word-16
451   :prefilter (lambda (value dstate)
452                (declare (ignore value)) ; always nil anyway
453                (sb!disassem:read-suffix 16 dstate)))
454
455 (sb!disassem:define-arg-type reg/mem
456   :prefilter #'prefilter-reg/mem
457   :printer #'print-reg/mem)
458 (sb!disassem:define-arg-type sized-reg/mem
459   ;; Same as reg/mem, but prints an explicit size indicator for
460   ;; memory references.
461   :prefilter #'prefilter-reg/mem
462   :printer #'print-sized-reg/mem)
463
464 ;;; Arguments of type reg/mem with a fixed size.
465 (sb!disassem:define-arg-type sized-byte-reg/mem
466   :prefilter #'prefilter-reg/mem
467   :printer #'print-sized-byte-reg/mem)
468 (sb!disassem:define-arg-type sized-word-reg/mem
469   :prefilter #'prefilter-reg/mem
470   :printer #'print-sized-word-reg/mem)
471 (sb!disassem:define-arg-type sized-dword-reg/mem
472   :prefilter #'prefilter-reg/mem
473   :printer #'print-sized-dword-reg/mem)
474
475 ;;; Same as sized-reg/mem, but with a default operand size of :qword.
476 (sb!disassem:define-arg-type sized-reg/mem-default-qword
477   :prefilter #'prefilter-reg/mem
478   :printer #'print-sized-reg/mem-default-qword)
479
480 ;;; XMM registers
481 (sb!disassem:define-arg-type xmmreg
482   :prefilter #'prefilter-reg-r
483   :printer #'print-xmmreg)
484
485 (sb!disassem:define-arg-type xmmreg/mem
486   :prefilter #'prefilter-reg/mem
487   :printer #'print-xmmreg/mem)
488
489 (sb!disassem:define-arg-type sized-xmmreg/mem
490   :prefilter #'prefilter-reg/mem
491   :printer #'print-sized-xmmreg/mem)
492
493
494 (eval-when (:compile-toplevel :load-toplevel :execute)
495 (defparameter *conditions*
496   '((:o . 0)
497     (:no . 1)
498     (:b . 2) (:nae . 2) (:c . 2)
499     (:nb . 3) (:ae . 3) (:nc . 3)
500     (:eq . 4) (:e . 4) (:z . 4)
501     (:ne . 5) (:nz . 5)
502     (:be . 6) (:na . 6)
503     (:nbe . 7) (:a . 7)
504     (:s . 8)
505     (:ns . 9)
506     (:p . 10) (:pe . 10)
507     (:np . 11) (:po . 11)
508     (:l . 12) (:nge . 12)
509     (:nl . 13) (:ge . 13)
510     (:le . 14) (:ng . 14)
511     (:nle . 15) (:g . 15)))
512 (defparameter *condition-name-vec*
513   (let ((vec (make-array 16 :initial-element nil)))
514     (dolist (cond *conditions*)
515       (when (null (aref vec (cdr cond)))
516         (setf (aref vec (cdr cond)) (car cond))))
517     vec))
518 ) ; EVAL-WHEN
519
520 ;;; Set assembler parameters. (In CMU CL, this was done with
521 ;;; a call to a macro DEF-ASSEMBLER-PARAMS.)
522 (eval-when (:compile-toplevel :load-toplevel :execute)
523   (setf sb!assem:*assem-scheduler-p* nil))
524
525 (sb!disassem:define-arg-type condition-code
526   :printer *condition-name-vec*)
527
528 (defun conditional-opcode (condition)
529   (cdr (assoc condition *conditions* :test #'eq)))
530 \f
531 ;;;; disassembler instruction formats
532
533 (eval-when (:compile-toplevel :execute)
534   (defun swap-if (direction field1 separator field2)
535     `(:if (,direction :constant 0)
536           (,field1 ,separator ,field2)
537           (,field2 ,separator ,field1))))
538
539 (sb!disassem:define-instruction-format (byte 8 :default-printer '(:name))
540   (op    :field (byte 8 0))
541   ;; optional fields
542   (accum :type 'accum)
543   (imm))
544
545 ;;; A one-byte instruction with a #x66 prefix, used to indicate an
546 ;;; operand size of :word.
547 (sb!disassem:define-instruction-format (x66-byte 16
548                                         :default-printer '(:name))
549   (x66   :field (byte 8 0) :value #x66)
550   (op    :field (byte 8 8)))
551
552 ;;; A one-byte instruction with a REX prefix, used to indicate an
553 ;;; operand size of :qword. REX.W must be 1, the other three bits are
554 ;;; ignored.
555 (sb!disassem:define-instruction-format (rex-byte 16
556                                         :default-printer '(:name))
557   (rex   :field (byte 5 3) :value #b01001)
558   (op    :field (byte 8 8)))
559
560 (sb!disassem:define-instruction-format (simple 8)
561   (op    :field (byte 7 1))
562   (width :field (byte 1 0) :type 'width)
563   ;; optional fields
564   (accum :type 'accum)
565   (imm))
566
567 (sb!disassem:define-instruction-format (rex-simple 16)
568   (rex     :field (byte 4 4)    :value #b0100)
569   (wrxb    :field (byte 4 0)    :type 'wrxb)
570   (op    :field (byte 7 9))
571   (width :field (byte 1 8) :type 'width)
572   ;; optional fields
573   (accum :type 'accum)
574   (imm))
575
576 ;;; Same as simple, but with direction bit
577 (sb!disassem:define-instruction-format (simple-dir 8 :include 'simple)
578   (op :field (byte 6 2))
579   (dir :field (byte 1 1)))
580
581 ;;; Same as simple, but with the immediate value occurring by default,
582 ;;; and with an appropiate printer.
583 (sb!disassem:define-instruction-format (accum-imm 8
584                                      :include 'simple
585                                      :default-printer '(:name
586                                                         :tab accum ", " imm))
587   (imm :type 'signed-imm-data))
588
589 (sb!disassem:define-instruction-format (rex-accum-imm 16
590                                      :include 'rex-simple
591                                      :default-printer '(:name
592                                                         :tab accum ", " imm))
593   (imm :type 'signed-imm-data))
594
595 (sb!disassem:define-instruction-format (reg-no-width 8
596                                      :default-printer '(:name :tab reg))
597   (op    :field (byte 5 3))
598   (reg   :field (byte 3 0) :type 'reg-b)
599   ;; optional fields
600   (accum :type 'accum)
601   (imm))
602
603 (sb!disassem:define-instruction-format (rex-reg-no-width 16
604                                      :default-printer '(:name :tab reg))
605   (rex     :field (byte 4 4)    :value #b0100)
606   (wrxb    :field (byte 4 0)    :type 'wrxb)
607   (op      :field (byte 5 11))
608   (reg     :field (byte 3 8)    :type 'reg-b)
609   ;; optional fields
610   (accum :type 'accum)
611   (imm))
612
613 ;;; Same as reg-no-width, but with a default operand size of :qword.
614 (sb!disassem:define-instruction-format (reg-no-width-default-qword 8
615                                         :include 'reg-no-width
616                                         :default-printer '(:name :tab reg))
617   (reg   :type 'reg-b-default-qword))
618
619 ;;; Same as rex-reg-no-width, but with a default operand size of :qword.
620 (sb!disassem:define-instruction-format (rex-reg-no-width-default-qword 16
621                                         :include 'rex-reg-no-width
622                                         :default-printer '(:name :tab reg))
623   (reg     :type 'reg-b-default-qword))
624
625 (sb!disassem:define-instruction-format (modrm-reg-no-width 24
626                                      :default-printer '(:name :tab reg))
627   (rex     :field (byte 4 4)    :value #b0100)
628   (wrxb    :field (byte 4 0)    :type 'wrxb)
629   (ff   :field (byte 8 8)  :value #b11111111)
630   (mod   :field (byte 2 22))
631   (modrm-reg :field (byte 3 19))
632   (reg     :field (byte 3 16)   :type 'reg-b)
633   ;; optional fields
634   (accum :type 'accum)
635   (imm))
636
637 ;;; Adds a width field to reg-no-width. Note that we can't use
638 ;;; :INCLUDE 'REG-NO-WIDTH here to save typing because that would put
639 ;;; the WIDTH field last, but the prefilter for WIDTH must run before
640 ;;; the one for IMM to be able to determine the correct size of IMM.
641 (sb!disassem:define-instruction-format (reg 8
642                                         :default-printer '(:name :tab reg))
643   (op    :field (byte 4 4))
644   (width :field (byte 1 3) :type 'width)
645   (reg   :field (byte 3 0) :type 'reg-b)
646   ;; optional fields
647   (accum :type 'accum)
648   (imm))
649
650 (sb!disassem:define-instruction-format (rex-reg 16
651                                         :default-printer '(:name :tab reg))
652   (rex     :field (byte 4 4)    :value #b0100)
653   (wrxb    :field (byte 4 0)    :type 'wrxb)
654   (width   :field (byte 1 11)   :type 'width)
655   (op      :field (byte 4 12))
656   (reg     :field (byte 3 8)    :type 'reg-b)
657   ;; optional fields
658   (accum   :type 'accum)
659   (imm))
660
661 (sb!disassem:define-instruction-format (two-bytes 16
662                                         :default-printer '(:name))
663   (op :fields (list (byte 8 0) (byte 8 8))))
664
665 (sb!disassem:define-instruction-format (reg-reg/mem 16
666                                         :default-printer
667                                         `(:name :tab reg ", " reg/mem))
668   (op      :field (byte 7 1))
669   (width   :field (byte 1 0)    :type 'width)
670   (reg/mem :fields (list (byte 2 14) (byte 3 8))
671                                 :type 'reg/mem)
672   (reg     :field (byte 3 11)   :type 'reg)
673   ;; optional fields
674   (imm))
675
676 (sb!disassem:define-instruction-format (rex-reg-reg/mem 24
677                                         :default-printer
678                                         `(:name :tab reg ", " reg/mem))
679   (rex     :field (byte 4 4)    :value #b0100)
680   (wrxb    :field (byte 4 0)    :type 'wrxb)
681   (width   :field (byte 1 8)    :type 'width)
682   (op      :field (byte 7 9))
683   (reg/mem :fields (list (byte 2 22) (byte 3 16))
684                                 :type 'reg/mem)
685   (reg     :field (byte 3 19)   :type 'reg)
686   ;; optional fields
687   (imm))
688
689 ;;; same as reg-reg/mem, but with direction bit
690 (sb!disassem:define-instruction-format (reg-reg/mem-dir 16
691                                         :include 'reg-reg/mem
692                                         :default-printer
693                                         `(:name
694                                           :tab
695                                           ,(swap-if 'dir 'reg/mem ", " 'reg)))
696   (op  :field (byte 6 2))
697   (dir :field (byte 1 1)))
698
699 (sb!disassem:define-instruction-format (rex-reg-reg/mem-dir 24
700                                         :include 'rex-reg-reg/mem
701                                         :default-printer
702                                         `(:name
703                                           :tab
704                                           ,(swap-if 'dir 'reg/mem ", " 'reg)))
705   (op  :field (byte 6 10))
706   (dir :field (byte 1 9)))
707
708 (sb!disassem:define-instruction-format (x66-reg-reg/mem-dir 24
709                                         :default-printer
710                                         `(:name
711                                           :tab
712                                           ,(swap-if 'dir 'reg/mem ", " 'reg)))
713   (x66     :field (byte 8 0)    :type 'x66 :value #x66)
714   (op      :field (byte 6 10))
715   (dir     :field (byte 1 9))
716   (width   :field (byte 1 8)    :type 'width)
717   (reg/mem :fields (list (byte 2 22) (byte 3 16))
718                                 :type 'reg/mem)
719   (reg     :field (byte 3 19)   :type 'reg))
720
721 (sb!disassem:define-instruction-format (x66-rex-reg-reg/mem-dir 32
722                                         :default-printer
723                                         `(:name
724                                           :tab
725                                           ,(swap-if 'dir 'reg/mem ", " 'reg)))
726   (x66     :field (byte 8 0)    :type 'x66 :value #x66)
727   (rex     :field (byte 4 12)   :value #b0100)
728   (wrxb    :field (byte 4 8)    :type 'wrxb)
729   (op      :field (byte 6 18))
730   (dir     :field (byte 1 17))
731   (width   :field (byte 1 16)   :type 'width)
732   (reg/mem :fields (list (byte 2 30) (byte 3 24))
733                                 :type 'reg/mem)
734   (reg     :field (byte 3 27)   :type 'reg))
735
736 ;;; Same as reg-reg/mem, but uses the reg field as a second op code.
737 (sb!disassem:define-instruction-format (reg/mem 16
738                                         :default-printer '(:name :tab reg/mem))
739   (op      :fields (list (byte 7 1) (byte 3 11)))
740   (width   :field (byte 1 0)    :type 'width)
741   (reg/mem :fields (list (byte 2 14) (byte 3 8))
742                                 :type 'sized-reg/mem)
743   ;; optional fields
744   (imm))
745
746 (sb!disassem:define-instruction-format (rex-reg/mem 24
747                                         :default-printer '(:name :tab reg/mem))
748   (rex     :field (byte 4 4)    :value #b0100)
749   (wrxb    :field (byte 4 0)    :type 'wrxb)
750   (op      :fields (list (byte 7 9) (byte 3 19)))
751   (width   :field (byte 1 8)    :type 'width)
752   (reg/mem :fields (list (byte 2 22) (byte 3 16))
753                                 :type 'sized-reg/mem)
754   ;; optional fields
755   (imm))
756
757 ;;; Same as reg/mem, but without a width field and with a default
758 ;;; operand size of :qword.
759 (sb!disassem:define-instruction-format (reg/mem-default-qword 16
760                                         :default-printer '(:name :tab reg/mem))
761   (op      :fields (list (byte 8 0) (byte 3 11)))
762   (reg/mem :fields (list (byte 2 14) (byte 3 8))
763                                 :type 'sized-reg/mem-default-qword))
764
765 (sb!disassem:define-instruction-format (rex-reg/mem-default-qword 24
766                                         :default-printer '(:name :tab reg/mem))
767   (rex     :field (byte 4 4)    :value #b0100)
768   (wrxb    :field (byte 4 0)    :type 'wrxb)
769   (op      :fields (list (byte 8 8) (byte 3 19)))
770   (reg/mem :fields (list (byte 2 22) (byte 3 16))
771                                 :type 'sized-reg/mem-default-qword))
772
773 ;;; Same as reg/mem, but with the immediate value occurring by default,
774 ;;; and with an appropiate printer.
775 (sb!disassem:define-instruction-format (reg/mem-imm 16
776                                         :include 'reg/mem
777                                         :default-printer
778                                         '(:name :tab reg/mem ", " imm))
779   (reg/mem :type 'sized-reg/mem)
780   (imm     :type 'signed-imm-data))
781
782 (sb!disassem:define-instruction-format (rex-reg/mem-imm 24
783                                         :include 'rex-reg/mem
784                                         :default-printer
785                                         '(:name :tab reg/mem ", " imm))
786   (reg/mem :type 'sized-reg/mem)
787   (imm     :type 'signed-imm-data))
788
789 ;;; Same as reg/mem, but with using the accumulator in the default printer
790 (sb!disassem:define-instruction-format
791     (accum-reg/mem 16
792      :include 'reg/mem :default-printer '(:name :tab accum ", " reg/mem))
793   (reg/mem :type 'reg/mem)              ; don't need a size
794   (accum :type 'accum))
795
796 (sb!disassem:define-instruction-format (rex-accum-reg/mem 24
797                                         :include 'rex-reg/mem
798                                         :default-printer
799                                         '(:name :tab accum ", " reg/mem))
800   (reg/mem :type 'reg/mem)              ; don't need a size
801   (accum   :type 'accum))
802
803 ;;; Same as reg-reg/mem, but with a prefix of #b00001111
804 (sb!disassem:define-instruction-format (ext-reg-reg/mem 24
805                                         :default-printer
806                                         `(:name :tab reg ", " reg/mem))
807   (prefix  :field (byte 8 0)    :value #b00001111)
808   (op      :field (byte 7 9))
809   (width   :field (byte 1 8)    :type 'width)
810   (reg/mem :fields (list (byte 2 22) (byte 3 16))
811                                 :type 'reg/mem)
812   (reg     :field (byte 3 19)   :type 'reg)
813   ;; optional fields
814   (imm))
815
816 (sb!disassem:define-instruction-format (ext-reg-reg/mem-no-width 24
817                                         :default-printer
818                                         `(:name :tab reg ", " reg/mem))
819   (prefix  :field (byte 8 0)    :value #b00001111)
820   (op      :field (byte 8 8))
821   (reg/mem :fields (list (byte 2 22) (byte 3 16))
822                                 :type 'reg/mem)
823   (reg     :field (byte 3 19)   :type 'reg))
824
825 (sb!disassem:define-instruction-format (rex-ext-reg-reg/mem-no-width 32
826                                         :default-printer
827                                         `(:name :tab reg ", " reg/mem))
828   (rex     :field (byte 4 4)    :value #b0100)
829   (wrxb    :field (byte 4 0)    :type 'wrxb)
830   (prefix  :field (byte 8 8)    :value #b00001111)
831   (op      :field (byte 8 16))
832   (reg/mem :fields (list (byte 2 30) (byte 3 24))
833                                 :type 'reg/mem)
834   (reg     :field (byte 3 27)   :type 'reg))
835
836 ;;; reg-no-width with #x0f prefix
837 (sb!disassem:define-instruction-format (ext-reg-no-width 16
838                                         :default-printer '(:name :tab reg))
839   (prefix  :field (byte 8 0)    :value #b00001111)
840   (op    :field (byte 5 11))
841   (reg   :field (byte 3 8) :type 'reg-b))
842
843 ;;; Same as reg/mem, but with a prefix of #b00001111
844 (sb!disassem:define-instruction-format (ext-reg/mem 24
845                                         :default-printer '(:name :tab reg/mem))
846   (prefix  :field (byte 8 0)    :value #b00001111)
847   (op      :fields (list (byte 7 9) (byte 3 19)))
848   (width   :field (byte 1 8)    :type 'width)
849   (reg/mem :fields (list (byte 2 22) (byte 3 16))
850                                 :type 'sized-reg/mem)
851   ;; optional fields
852   (imm))
853
854 (sb!disassem:define-instruction-format (ext-reg/mem-imm 24
855                                         :include 'ext-reg/mem
856                                         :default-printer
857                                         '(:name :tab reg/mem ", " imm))
858   (imm :type 'signed-imm-data))
859 \f
860 ;;;; XMM instructions
861
862 ;;; All XMM instructions use an extended opcode (#x0F as the first
863 ;;; opcode byte). Therefore in the following "EXT" in the name of the
864 ;;; instruction formats refers to the formats that have an additional
865 ;;; prefix (#x66, #xF2 or #xF3).
866
867 ;;; Instructions having an XMM register as the destination operand
868 ;;; and an XMM register or a memory location as the source operand.
869 ;;; The size of the operands is implicitly given by the instruction.
870 (sb!disassem:define-instruction-format (xmm-xmm/mem 24
871                                         :default-printer
872                                         '(:name :tab reg ", " reg/mem))
873   (x0f     :field (byte 8 0)    :value #x0f)
874   (op      :field (byte 8 8))
875   (reg/mem :fields (list (byte 2 22) (byte 3 16))
876                                 :type 'xmmreg/mem)
877   (reg     :field (byte 3 19)   :type 'xmmreg))
878
879 (sb!disassem:define-instruction-format (rex-xmm-xmm/mem 32
880                                         :default-printer
881                                         '(:name :tab reg ", " reg/mem))
882   (x0f     :field (byte 8 0)    :value #x0f)
883   (rex     :field (byte 4 12)   :value #b0100)
884   (wrxb    :field (byte 4 8)    :type 'wrxb)
885   (op      :field (byte 8 16))
886   (reg/mem :fields (list (byte 2 30) (byte 3 24))
887                                 :type 'xmmreg/mem)
888   (reg     :field (byte 3 27)   :type 'xmmreg))
889
890 (sb!disassem:define-instruction-format (ext-xmm-xmm/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 'xmmreg/mem)
898   (reg     :field (byte 3 27)   :type 'xmmreg))
899
900 (sb!disassem:define-instruction-format (ext-rex-xmm-xmm/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 'xmmreg/mem)
910   (reg     :field (byte 3 35)   :type 'xmmreg))
911
912 ;;; Same as xmm-xmm/mem etc., but with direction bit.
913
914 (sb!disassem:define-instruction-format (ext-xmm-xmm/mem-dir 32
915                                         :include 'ext-xmm-xmm/mem
916                                         :default-printer
917                                         `(:name
918                                           :tab
919                                           ,(swap-if 'dir 'reg ", " 'reg/mem)))
920   (op      :field (byte 7 17))
921   (dir     :field (byte 1 16)))
922
923 (sb!disassem:define-instruction-format (ext-rex-xmm-xmm/mem-dir 40
924                                         :include 'ext-rex-xmm-xmm/mem
925                                         :default-printer
926                                         `(:name
927                                           :tab
928                                           ,(swap-if 'dir 'reg ", " 'reg/mem)))
929   (op      :field (byte 7 25))
930   (dir     :field (byte 1 24)))
931
932 ;;; Instructions having an XMM register as one operand and a general-
933 ;;; -purpose register or a memory location as the other operand.
934
935 (sb!disassem:define-instruction-format (ext-xmm-reg/mem 32
936                                         :default-printer
937                                         '(:name :tab reg ", " reg/mem))
938   (prefix  :field (byte 8 0))
939   (x0f     :field (byte 8 8)    :value #x0f)
940   (op      :field (byte 8 16))
941   (reg/mem :fields (list (byte 2 30) (byte 3 24))
942                                 :type 'sized-reg/mem)
943   (reg     :field (byte 3 27)   :type 'xmmreg))
944
945 (sb!disassem:define-instruction-format (ext-rex-xmm-reg/mem 40
946                                         :default-printer
947                                         '(:name :tab reg ", " reg/mem))
948   (prefix  :field (byte 8 0))
949   (rex     :field (byte 4 12)   :value #b0100)
950   (wrxb    :field (byte 4 8)    :type 'wrxb)
951   (x0f     :field (byte 8 16)   :value #x0f)
952   (op      :field (byte 8 24))
953   (reg/mem :fields (list (byte 2 38) (byte 3 32))
954                                 :type 'sized-reg/mem)
955   (reg     :field (byte 3 35)   :type 'xmmreg))
956
957 ;;; Instructions having a general-purpose register as one operand and an
958 ;;; XMM register or a memory location as the other operand.
959
960 (sb!disassem:define-instruction-format (ext-reg-xmm/mem 32
961                                         :default-printer
962                                         '(:name :tab reg ", " reg/mem))
963   (prefix  :field (byte 8 0))
964   (x0f     :field (byte 8 8)    :value #x0f)
965   (op      :field (byte 8 16))
966   (reg/mem :fields (list (byte 2 30) (byte 3 24))
967                                 :type 'sized-xmmreg/mem)
968   (reg     :field (byte 3 27)   :type 'reg))
969
970 (sb!disassem:define-instruction-format (ext-rex-reg-xmm/mem 40
971                                         :default-printer
972                                         '(:name :tab reg ", " reg/mem))
973   (prefix  :field (byte 8 0))
974   (rex     :field (byte 4 12)   :value #b0100)
975   (wrxb    :field (byte 4 8)    :type 'wrxb)
976   (x0f     :field (byte 8 16)   :value #x0f)
977   (op      :field (byte 8 24))
978   (reg/mem :fields (list (byte 2 38) (byte 3 32))
979                                 :type 'sized-xmmreg/mem)
980   (reg     :field (byte 3 35)   :type 'reg))
981
982 (sb!disassem:define-instruction-format (string-op 8
983                                      :include 'simple
984                                      :default-printer '(:name width)))
985
986 (sb!disassem:define-instruction-format (rex-string-op 16
987                                      :include 'rex-simple
988                                      :default-printer '(:name width)))
989
990 (sb!disassem:define-instruction-format (short-cond-jump 16)
991   (op    :field (byte 4 4))
992   (cc    :field (byte 4 0) :type 'condition-code)
993   (label :field (byte 8 8) :type 'displacement))
994
995 (sb!disassem:define-instruction-format (short-jump 16
996                                      :default-printer '(:name :tab label))
997   (const :field (byte 4 4) :value #b1110)
998   (op    :field (byte 4 0))
999   (label :field (byte 8 8) :type 'displacement))
1000
1001 (sb!disassem:define-instruction-format (near-cond-jump 16)
1002   (op    :fields (list (byte 8 0) (byte 4 12)) :value '(#b00001111 #b1000))
1003   (cc    :field (byte 4 8) :type 'condition-code)
1004   ;; The disassembler currently doesn't let you have an instruction > 32 bits
1005   ;; long, so we fake it by using a prefilter to read the offset.
1006   (label :type 'displacement
1007          :prefilter (lambda (value dstate)
1008                       (declare (ignore value)) ; always nil anyway
1009                       (sb!disassem:read-signed-suffix 32 dstate))))
1010
1011 (sb!disassem:define-instruction-format (near-jump 8
1012                                      :default-printer '(:name :tab label))
1013   (op    :field (byte 8 0))
1014   ;; The disassembler currently doesn't let you have an instruction > 32 bits
1015   ;; long, so we fake it by using a prefilter to read the address.
1016   (label :type 'displacement
1017          :prefilter (lambda (value dstate)
1018                       (declare (ignore value)) ; always nil anyway
1019                       (sb!disassem:read-signed-suffix 32 dstate))))
1020
1021
1022 (sb!disassem:define-instruction-format (cond-set 24
1023                                      :default-printer '('set cc :tab reg/mem))
1024   (prefix :field (byte 8 0) :value #b00001111)
1025   (op    :field (byte 4 12) :value #b1001)
1026   (cc    :field (byte 4 8) :type 'condition-code)
1027   (reg/mem :fields (list (byte 2 22) (byte 3 16))
1028            :type 'sized-byte-reg/mem)
1029   (reg     :field (byte 3 19)   :value #b000))
1030
1031 (sb!disassem:define-instruction-format (cond-move 24
1032                                      :default-printer
1033                                         '('cmov cc :tab reg ", " reg/mem))
1034   (prefix  :field (byte 8 0)    :value #b00001111)
1035   (op      :field (byte 4 12)   :value #b0100)
1036   (cc      :field (byte 4 8)    :type 'condition-code)
1037   (reg/mem :fields (list (byte 2 22) (byte 3 16))
1038                                 :type 'reg/mem)
1039   (reg     :field (byte 3 19)   :type 'reg))
1040
1041 (sb!disassem:define-instruction-format (rex-cond-move 32
1042                                      :default-printer
1043                                         '('cmov cc :tab reg ", " reg/mem))
1044   (rex     :field (byte 4 4)   :value #b0100)
1045   (wrxb    :field (byte 4 0)    :type 'wrxb)
1046   (prefix  :field (byte 8 8)    :value #b00001111)
1047   (op      :field (byte 4 20)   :value #b0100)
1048   (cc      :field (byte 4 16)    :type 'condition-code)
1049   (reg/mem :fields (list (byte 2 30) (byte 3 24))
1050                                 :type 'reg/mem)
1051   (reg     :field (byte 3 27)   :type 'reg))
1052
1053 (sb!disassem:define-instruction-format (enter-format 32
1054                                      :default-printer '(:name
1055                                                         :tab disp
1056                                                         (:unless (:constant 0)
1057                                                           ", " level)))
1058   (op :field (byte 8 0))
1059   (disp :field (byte 16 8))
1060   (level :field (byte 8 24)))
1061
1062 ;;; Single byte instruction with an immediate byte argument.
1063 (sb!disassem:define-instruction-format (byte-imm 16
1064                                      :default-printer '(:name :tab code))
1065  (op :field (byte 8 0))
1066  (code :field (byte 8 8)))
1067 \f
1068 ;;;; primitive emitters
1069
1070 (define-bitfield-emitter emit-word 16
1071   (byte 16 0))
1072
1073 (define-bitfield-emitter emit-dword 32
1074   (byte 32 0))
1075
1076 ;;; Most uses of dwords are as displacements or as immediate values in
1077 ;;; 64-bit operations. In these cases they are sign-extended to 64 bits.
1078 ;;; EMIT-DWORD is unsuitable there because it accepts values of type
1079 ;;; (OR (SIGNED-BYTE 32) (UNSIGNED-BYTE 32)), so we provide a more
1080 ;;; restricted emitter here.
1081 (defun emit-signed-dword (segment value)
1082   (declare (type segment segment)
1083            (type (signed-byte 32) value))
1084   (declare (inline emit-dword))
1085   (emit-dword segment value))
1086
1087 (define-bitfield-emitter emit-qword 64
1088   (byte 64 0))
1089
1090 (define-bitfield-emitter emit-byte-with-reg 8
1091   (byte 5 3) (byte 3 0))
1092
1093 (define-bitfield-emitter emit-mod-reg-r/m-byte 8
1094   (byte 2 6) (byte 3 3) (byte 3 0))
1095
1096 (define-bitfield-emitter emit-sib-byte 8
1097   (byte 2 6) (byte 3 3) (byte 3 0))
1098
1099 (define-bitfield-emitter emit-rex-byte 8
1100   (byte 4 4) (byte 1 3) (byte 1 2) (byte 1 1) (byte 1 0))
1101
1102
1103 \f
1104 ;;;; fixup emitters
1105
1106 (defun emit-absolute-fixup (segment fixup &optional quad-p)
1107   (note-fixup segment (if quad-p :absolute64 :absolute) fixup)
1108   (let ((offset (fixup-offset fixup)))
1109     (if (label-p offset)
1110         (emit-back-patch segment
1111                          (if quad-p 8 4)
1112                          (lambda (segment posn)
1113                            (declare (ignore posn))
1114                            (let ((val  (- (+ (component-header-length)
1115                                              (or (label-position offset)
1116                                                  0))
1117                                           other-pointer-lowtag)))
1118                              (if quad-p
1119                                  (emit-qword segment val)
1120                                  (emit-signed-dword segment val)))))
1121         (if quad-p
1122             (emit-qword segment (or offset 0))
1123             (emit-signed-dword segment (or offset 0))))))
1124
1125 (defun emit-relative-fixup (segment fixup)
1126   (note-fixup segment :relative fixup)
1127   (emit-signed-dword segment (or (fixup-offset fixup) 0)))
1128
1129 \f
1130 ;;;; the effective-address (ea) structure
1131
1132 (defun reg-tn-encoding (tn)
1133   (declare (type tn tn))
1134   ;; ea only has space for three bits of register number: regs r8
1135   ;; and up are selected by a REX prefix byte which caller is responsible
1136   ;; for having emitted where necessary already
1137   (ecase (sb-name (sc-sb (tn-sc tn)))
1138     (registers
1139      (let ((offset (mod (tn-offset tn) 16)))
1140        (logior (ash (logand offset 1) 2)
1141                (ash offset -1))))
1142     (float-registers
1143      (mod (tn-offset tn) 8))))
1144
1145 (defstruct (ea (:constructor make-ea (size &key base index scale disp))
1146                (:copier nil))
1147   ;; note that we can represent an EA with a QWORD size, but EMIT-EA
1148   ;; can't actually emit it on its own: caller also needs to emit REX
1149   ;; prefix
1150   (size nil :type (member :byte :word :dword :qword))
1151   (base nil :type (or tn null))
1152   (index nil :type (or tn null))
1153   (scale 1 :type (member 1 2 4 8))
1154   (disp 0 :type (or (unsigned-byte 32) (signed-byte 32) fixup)))
1155 (def!method print-object ((ea ea) stream)
1156   (cond ((or *print-escape* *print-readably*)
1157          (print-unreadable-object (ea stream :type t)
1158            (format stream
1159                    "~S~@[ base=~S~]~@[ index=~S~]~@[ scale=~S~]~@[ disp=~S~]"
1160                    (ea-size ea)
1161                    (ea-base ea)
1162                    (ea-index ea)
1163                    (let ((scale (ea-scale ea)))
1164                      (if (= scale 1) nil scale))
1165                    (ea-disp ea))))
1166         (t
1167          (format stream "~A PTR [" (symbol-name (ea-size ea)))
1168          (when (ea-base ea)
1169            (write-string (sb!c::location-print-name (ea-base ea)) stream)
1170            (when (ea-index ea)
1171              (write-string "+" stream)))
1172          (when (ea-index ea)
1173            (write-string (sb!c::location-print-name (ea-index ea)) stream))
1174          (unless (= (ea-scale ea) 1)
1175            (format stream "*~A" (ea-scale ea)))
1176          (typecase (ea-disp ea)
1177            (null)
1178            (integer
1179             (format stream "~@D" (ea-disp ea)))
1180            (t
1181             (format stream "+~A" (ea-disp ea))))
1182          (write-char #\] stream))))
1183
1184 (defun emit-constant-tn-rip (segment constant-tn reg)
1185   ;; AMD64 doesn't currently have a code object register to use as a
1186   ;; base register for constant access. Instead we use RIP-relative
1187   ;; addressing. The offset from the SIMPLE-FUN-HEADER to the instruction
1188   ;; is passed to the backpatch callback. In addition we need the offset
1189   ;; from the start of the function header to the slot in the CODE-HEADER
1190   ;; that stores the constant. Since we don't know where the code header
1191   ;; starts, instead count backwards from the function header.
1192   (let* ((2comp (component-info *component-being-compiled*))
1193          (constants (ir2-component-constants 2comp))
1194          (len (length constants))
1195          ;; Both CODE-HEADER and SIMPLE-FUN-HEADER are 16-byte aligned.
1196          ;; If there are an even amount of constants, there will be
1197          ;; an extra qword of padding before the function header, which
1198          ;; needs to be adjusted for. XXX: This will break if new slots
1199          ;; are added to the code header.
1200          (offset (* (- (+ len (if (evenp len)
1201                                   1
1202                                   2))
1203                        (tn-offset constant-tn))
1204                     n-word-bytes)))
1205     ;; RIP-relative addressing
1206     (emit-mod-reg-r/m-byte segment #b00 reg #b101)
1207     (emit-back-patch segment
1208                      4
1209                      (lambda (segment posn)
1210                        ;; The addressing is relative to end of instruction,
1211                        ;; i.e. the end of this dword. Hence the + 4.
1212                        (emit-signed-dword segment
1213                                           (+ 4 (- (+ offset posn)))))))
1214   (values))
1215
1216 (defun emit-label-rip (segment fixup reg)
1217   (let ((label (fixup-offset fixup)))
1218     ;; RIP-relative addressing
1219     (emit-mod-reg-r/m-byte segment #b00 reg #b101)
1220     (emit-back-patch segment
1221                      4
1222                      (lambda (segment posn)
1223                        (emit-signed-dword segment (- (label-position label)
1224                                                      (+ posn 4))))))
1225   (values))
1226
1227 (defun emit-ea (segment thing reg &optional allow-constants)
1228   (etypecase thing
1229     (tn
1230      ;; this would be eleganter if we had a function that would create
1231      ;; an ea given a tn
1232      (ecase (sb-name (sc-sb (tn-sc thing)))
1233        ((registers float-registers)
1234         (emit-mod-reg-r/m-byte segment #b11 reg (reg-tn-encoding thing)))
1235        (stack
1236         ;; Convert stack tns into an index off RBP.
1237         (let ((disp (- (* (1+ (tn-offset thing)) n-word-bytes))))
1238           (cond ((<= -128 disp 127)
1239                  (emit-mod-reg-r/m-byte segment #b01 reg #b101)
1240                  (emit-byte segment disp))
1241                 (t
1242                  (emit-mod-reg-r/m-byte segment #b10 reg #b101)
1243                  (emit-signed-dword segment disp)))))
1244        (constant
1245         (unless allow-constants
1246           ;; Why?
1247           (error
1248            "Constant TNs can only be directly used in MOV, PUSH, and CMP."))
1249         (emit-constant-tn-rip segment thing reg))))
1250     (ea
1251      (let* ((base (ea-base thing))
1252             (index (ea-index thing))
1253             (scale (ea-scale thing))
1254             (disp (ea-disp thing))
1255             (mod (cond ((or (null base)
1256                             (and (eql disp 0)
1257                                  (not (= (reg-tn-encoding base) #b101))))
1258                         #b00)
1259                        ((and (fixnump disp) (<= -128 disp 127))
1260                         #b01)
1261                        (t
1262                         #b10)))
1263             (r/m (cond (index #b100)
1264                        ((null base) #b101)
1265                        (t (reg-tn-encoding base)))))
1266        (when (and (= mod 0) (= r/m #b101))
1267          ;; this is rip-relative in amd64, so we'll use a sib instead
1268          (setf r/m #b100 scale 1))
1269        (emit-mod-reg-r/m-byte segment mod reg r/m)
1270        (when (= r/m #b100)
1271          (let ((ss (1- (integer-length scale)))
1272                (index (if (null index)
1273                           #b100
1274                           (let ((index (reg-tn-encoding index)))
1275                             (if (= index #b100)
1276                                 (error "can't index off of ESP")
1277                                 index))))
1278                (base (if (null base)
1279                          #b101
1280                          (reg-tn-encoding base))))
1281            (emit-sib-byte segment ss index base)))
1282        (cond ((= mod #b01)
1283               (emit-byte segment disp))
1284              ((or (= mod #b10) (null base))
1285               (if (fixup-p disp)
1286                   (emit-absolute-fixup segment disp)
1287                   (emit-signed-dword segment disp))))))
1288     (fixup
1289      (typecase (fixup-offset thing)
1290        (label
1291         (emit-label-rip segment thing reg))
1292        (t
1293         (emit-mod-reg-r/m-byte segment #b00 reg #b100)
1294         (emit-sib-byte segment 0 #b100 #b101)
1295         (emit-absolute-fixup segment thing))))))
1296
1297 (defun byte-reg-p (thing)
1298   (and (tn-p thing)
1299        (eq (sb-name (sc-sb (tn-sc thing))) 'registers)
1300        (member (sc-name (tn-sc thing)) *byte-sc-names*)
1301        t))
1302
1303 (defun byte-ea-p (thing)
1304   (typecase thing
1305     (ea (eq (ea-size thing) :byte))
1306     (tn
1307      (and (member (sc-name (tn-sc thing)) *byte-sc-names*) t))
1308     (t nil)))
1309
1310 (defun word-reg-p (thing)
1311   (and (tn-p thing)
1312        (eq (sb-name (sc-sb (tn-sc thing))) 'registers)
1313        (member (sc-name (tn-sc thing)) *word-sc-names*)
1314        t))
1315
1316 (defun word-ea-p (thing)
1317   (typecase thing
1318     (ea (eq (ea-size thing) :word))
1319     (tn (and (member (sc-name (tn-sc thing)) *word-sc-names*) t))
1320     (t nil)))
1321
1322 (defun dword-reg-p (thing)
1323   (and (tn-p thing)
1324        (eq (sb-name (sc-sb (tn-sc thing))) 'registers)
1325        (member (sc-name (tn-sc thing)) *dword-sc-names*)
1326        t))
1327
1328 (defun dword-ea-p (thing)
1329   (typecase thing
1330     (ea (eq (ea-size thing) :dword))
1331     (tn
1332      (and (member (sc-name (tn-sc thing)) *dword-sc-names*) t))
1333     (t nil)))
1334
1335 (defun qword-reg-p (thing)
1336   (and (tn-p thing)
1337        (eq (sb-name (sc-sb (tn-sc thing))) 'registers)
1338        (member (sc-name (tn-sc thing)) *qword-sc-names*)
1339        t))
1340
1341 (defun qword-ea-p (thing)
1342   (typecase thing
1343     (ea (eq (ea-size thing) :qword))
1344     (tn
1345      (and (member (sc-name (tn-sc thing)) *qword-sc-names*) t))
1346     (t nil)))
1347
1348 ;;; Return true if THING is a general-purpose register TN.
1349 (defun register-p (thing)
1350   (and (tn-p thing)
1351        (eq (sb-name (sc-sb (tn-sc thing))) 'registers)))
1352
1353 (defun accumulator-p (thing)
1354   (and (register-p thing)
1355        (= (tn-offset thing) 0)))
1356
1357 ;;; Return true if THING is an XMM register TN.
1358 (defun xmm-register-p (thing)
1359   (and (tn-p thing)
1360        (eq (sb-name (sc-sb (tn-sc thing))) 'float-registers)))
1361
1362 \f
1363 ;;;; utilities
1364
1365 (def!constant +operand-size-prefix-byte+ #b01100110)
1366
1367 (defun maybe-emit-operand-size-prefix (segment size)
1368   (unless (or (eq size :byte)
1369               (eq size :qword)          ; REX prefix handles this
1370               (eq size +default-operand-size+))
1371     (emit-byte segment +operand-size-prefix-byte+)))
1372
1373 ;;; A REX prefix must be emitted if at least one of the following
1374 ;;; conditions is true:
1375 ;;  1. The operand size is :QWORD and the default operand size of the
1376 ;;     instruction is not :QWORD.
1377 ;;; 2. The instruction references an extended register.
1378 ;;; 3. The instruction references one of the byte registers SIL, DIL,
1379 ;;;    SPL or BPL.
1380
1381 ;;; Emit a REX prefix if necessary. OPERAND-SIZE is used to determine
1382 ;;; whether to set REX.W. Callers pass it explicitly as :DO-NOT-SET if
1383 ;;; this should not happen, for example because the instruction's
1384 ;;; default operand size is qword. R, X and B are NIL or TNs specifying
1385 ;;; registers the encodings of which are extended with the REX.R, REX.X
1386 ;;; and REX.B bit, respectively. To determine whether one of the byte
1387 ;;; registers is used that can only be accessed using a REX prefix, we
1388 ;;; need only to test R and B, because X is only used for the index
1389 ;;; register of an effective address and therefore never byte-sized.
1390 ;;; For R we can avoid to calculate the size of the TN because it is
1391 ;;; always OPERAND-SIZE. The size of B must be calculated here because
1392 ;;; B can be address-sized (if it is the base register of an effective
1393 ;;; address), of OPERAND-SIZE (if the instruction operates on two
1394 ;;; registers) or of some different size (in the instructions that
1395 ;;; combine arguments of different sizes: MOVZX, MOVSX, MOVSXD and
1396 ;;; several SSE instructions, e.g. CVTSD2SI). We don't distinguish
1397 ;;; between general-purpose and floating point registers for this cause
1398 ;;; because only general-purpose registers can be byte-sized at all.
1399 (defun maybe-emit-rex-prefix (segment operand-size r x b)
1400   (declare (type (member nil :byte :word :dword :qword :do-not-set)
1401                  operand-size)
1402            (type (or null tn) r x b))
1403   (labels ((if-hi (r)
1404              (if (and r (> (tn-offset r)
1405                            ;; offset of r8 is 16, offset of xmm8 is 8
1406                            (if (eq (sb-name (sc-sb (tn-sc r)))
1407                                    'float-registers)
1408                                7
1409                                15)))
1410                  1
1411                  0))
1412            (reg-4-7-p (r)
1413              ;; Assuming R is a TN describing a general-purpose
1414              ;; register, return true if it references register
1415              ;; 4 upto 7.
1416              (<= 8 (tn-offset r) 15)))
1417     (let ((rex-w (if (eq operand-size :qword) 1 0))
1418           (rex-r (if-hi r))
1419           (rex-x (if-hi x))
1420           (rex-b (if-hi b)))
1421       (when (or (not (zerop (logior rex-w rex-r rex-x rex-b)))
1422                 (and r
1423                      (eq operand-size :byte)
1424                      (reg-4-7-p r))
1425                 (and b
1426                      (eq (operand-size b) :byte)
1427                      (reg-4-7-p b)))
1428         (emit-rex-byte segment #b0100 rex-w rex-r rex-x rex-b)))))
1429
1430 ;;; Emit a REX prefix if necessary. The operand size is determined from
1431 ;;; THING or can be overwritten by OPERAND-SIZE. This and REG are always
1432 ;;; passed to MAYBE-EMIT-REX-PREFIX. Additionally, if THING is an EA we
1433 ;;; pass its index and base registers, if it is a register TN, we pass
1434 ;;; only itself.
1435 ;;; In contrast to EMIT-EA above, neither stack TNs nor fixups need to
1436 ;;; be treated specially here: If THING is a stack TN, neither it nor
1437 ;;; any of its components are passed to MAYBE-EMIT-REX-PREFIX which
1438 ;;; works correctly because stack references always use RBP as the base
1439 ;;; register and never use an index register so no extended registers
1440 ;;; need to be accessed. Fixups are assembled using an addressing mode
1441 ;;; of displacement-only or RIP-plus-displacement (see EMIT-EA), so may
1442 ;;; not reference an extended register. The displacement-only addressing
1443 ;;; mode requires that REX.X is 0, which is ensured here.
1444 (defun maybe-emit-rex-for-ea (segment thing reg &key operand-size)
1445   (declare (type (or ea tn fixup) thing)
1446            (type (or null tn) reg)
1447            (type (member nil :byte :word :dword :qword :do-not-set)
1448                  operand-size))
1449   (let ((ea-p (ea-p thing)))
1450     (maybe-emit-rex-prefix segment
1451                            (or operand-size (operand-size thing))
1452                            reg
1453                            (and ea-p (ea-index thing))
1454                            (cond (ea-p (ea-base thing))
1455                                  ((and (tn-p thing)
1456                                        (member (sb-name (sc-sb (tn-sc thing)))
1457                                                '(float-registers registers)))
1458                                   thing)
1459                                  (t nil)))))
1460
1461 (defun operand-size (thing)
1462   (typecase thing
1463     (tn
1464      ;; FIXME: might as well be COND instead of having to use #. readmacro
1465      ;; to hack up the code
1466      (case (sc-name (tn-sc thing))
1467        (#.*qword-sc-names*
1468         :qword)
1469        (#.*dword-sc-names*
1470         :dword)
1471        (#.*word-sc-names*
1472         :word)
1473        (#.*byte-sc-names*
1474         :byte)
1475        ;; added by jrd: float-registers is a separate size (?)
1476        ;; The only place in the code where we are called with THING
1477        ;; being a float-register is in MAYBE-EMIT-REX-PREFIX when it
1478        ;; checks whether THING is a byte register. Thus our result in
1479        ;; these cases could as well be :dword and :qword. I leave it as
1480        ;; :float and :double which is more likely to trigger an aver
1481        ;; instead of silently doing the wrong thing in case this
1482        ;; situation should change. Lutz Euler, 2005-10-23.
1483        (#.*float-sc-names*
1484         :float)
1485        (#.*double-sc-names*
1486         :double)
1487        (t
1488         (error "can't tell the size of ~S ~S" thing (sc-name (tn-sc thing))))))
1489     (ea
1490      (ea-size thing))
1491     (fixup
1492      ;; GNA.  Guess who spelt "flavor" correctly first time round?
1493      ;; There's a strong argument in my mind to change all uses of
1494      ;; "flavor" to "kind": and similarly with some misguided uses of
1495      ;; "type" here and there.  -- CSR, 2005-01-06.
1496      (case (fixup-flavor thing)
1497        ((:foreign-dataref) :qword)))
1498     (t
1499      nil)))
1500
1501 (defun matching-operand-size (dst src)
1502   (let ((dst-size (operand-size dst))
1503         (src-size (operand-size src)))
1504     (if dst-size
1505         (if src-size
1506             (if (eq dst-size src-size)
1507                 dst-size
1508                 (error "size mismatch: ~S is a ~S and ~S is a ~S."
1509                        dst dst-size src src-size))
1510             dst-size)
1511         (if src-size
1512             src-size
1513             (error "can't tell the size of either ~S or ~S" dst src)))))
1514
1515 ;;; Except in a very few cases (MOV instructions A1, A3 and B8 - BF)
1516 ;;; we expect dword data bytes even when 64 bit work is being done.
1517 ;;; But A1 and A3 are currently unused and B8 - BF use EMIT-QWORD
1518 ;;; directly, so we emit all quad constants as dwords, additionally
1519 ;;; making sure that they survive the sign-extension to 64 bits
1520 ;;; unchanged.
1521 (defun emit-sized-immediate (segment size value)
1522   (ecase size
1523     (:byte
1524      (emit-byte segment value))
1525     (:word
1526      (emit-word segment value))
1527     (:dword
1528      (emit-dword segment value))
1529     (:qword
1530      (emit-signed-dword segment value))))
1531 \f
1532 ;;;; general data transfer
1533
1534 ;;; This is the part of the MOV instruction emitter that does moving
1535 ;;; of an immediate value into a qword register. We go to some length
1536 ;;; to achieve the shortest possible encoding.
1537 (defun emit-immediate-move-to-qword-register (segment dst src)
1538   (declare (type integer src))
1539   (cond ((typep src '(unsigned-byte 32))
1540          ;; We use the B8 - BF encoding with an operand size of 32 bits
1541          ;; here and let the implicit zero-extension fill the upper half
1542          ;; of the 64-bit destination register. Instruction size: five
1543          ;; or six bytes. (A REX prefix will be emitted only if the
1544          ;; destination is an extended register.)
1545          (maybe-emit-rex-prefix segment :dword nil nil dst)
1546          (emit-byte-with-reg segment #b10111 (reg-tn-encoding dst))
1547          (emit-dword segment src))
1548         (t
1549          (maybe-emit-rex-prefix segment :qword nil nil dst)
1550          (cond ((typep src '(signed-byte 32))
1551                 ;; Use the C7 encoding that takes a 32-bit immediate and
1552                 ;; sign-extends it to 64 bits. Instruction size: seven
1553                 ;; bytes.
1554                 (emit-byte segment #b11000111)
1555                 (emit-mod-reg-r/m-byte segment #b11 #b000
1556                                        (reg-tn-encoding dst))
1557                 (emit-signed-dword segment src))
1558                ((<= (- (expt 2 64) (expt 2 31))
1559                     src
1560                     (1- (expt 2 64)))
1561                 ;; This triggers on positive integers of 64 bits length
1562                 ;; with the most significant 33 bits being 1. We use the
1563                 ;; same encoding as in the previous clause.
1564                 (emit-byte segment #b11000111)
1565                 (emit-mod-reg-r/m-byte segment #b11 #b000
1566                                        (reg-tn-encoding dst))
1567                 (emit-signed-dword segment (- src (expt 2 64))))
1568                (t
1569                 ;; We need a full 64-bit immediate. Instruction size:
1570                 ;; ten bytes.
1571                 (emit-byte-with-reg segment #b10111 (reg-tn-encoding dst))
1572                 (emit-qword segment src))))))
1573
1574 (define-instruction mov (segment dst src)
1575   ;; immediate to register
1576   (:printer reg ((op #b1011) (imm nil :type 'signed-imm-data))
1577             '(:name :tab reg ", " imm))
1578   (:printer rex-reg ((op #b1011) (imm nil :type 'signed-imm-data-upto-qword))
1579             '(:name :tab reg ", " imm))
1580   ;; absolute mem to/from accumulator
1581   (:printer simple-dir ((op #b101000) (imm nil :type 'imm-addr))
1582             `(:name :tab ,(swap-if 'dir 'accum ", " '("[" imm "]"))))
1583   ;; register to/from register/memory
1584   (:printer reg-reg/mem-dir ((op #b100010)))
1585   (:printer rex-reg-reg/mem-dir ((op #b100010)))
1586   (:printer x66-reg-reg/mem-dir ((op #b100010)))
1587   (:printer x66-rex-reg-reg/mem-dir ((op #b100010)))
1588   ;; immediate to register/memory
1589   (:printer reg/mem-imm ((op '(#b1100011 #b000))))
1590   (:printer rex-reg/mem-imm ((op '(#b1100011 #b000))))
1591
1592   (:emitter
1593    (let ((size (matching-operand-size dst src)))
1594      (maybe-emit-operand-size-prefix segment size)
1595      (cond ((register-p dst)
1596             (cond ((integerp src)
1597                    (cond ((eq size :qword)
1598                           (emit-immediate-move-to-qword-register segment
1599                                                                  dst src))
1600                          (t
1601                           (maybe-emit-rex-prefix segment size nil nil dst)
1602                           (emit-byte-with-reg segment
1603                                               (if (eq size :byte)
1604                                                   #b10110
1605                                                   #b10111)
1606                                               (reg-tn-encoding dst))
1607                           (emit-sized-immediate segment size src))))
1608                   (t
1609                    (maybe-emit-rex-for-ea segment src dst)
1610                    (emit-byte segment
1611                               (if (eq size :byte)
1612                                   #b10001010
1613                                   #b10001011))
1614                    (emit-ea segment src (reg-tn-encoding dst) t))))
1615            ((integerp src)
1616             ;; C7 only deals with 32 bit immediates even if the
1617             ;; destination is a 64-bit location. The value is
1618             ;; sign-extended in this case.
1619             (maybe-emit-rex-for-ea segment dst nil)
1620             (emit-byte segment (if (eq size :byte) #b11000110 #b11000111))
1621             (emit-ea segment dst #b000)
1622             (emit-sized-immediate segment size src))
1623            ((register-p src)
1624             (maybe-emit-rex-for-ea segment dst src)
1625             (emit-byte segment (if (eq size :byte) #b10001000 #b10001001))
1626             (emit-ea segment dst (reg-tn-encoding src)))
1627            ((fixup-p src)
1628             ;; Generally we can't MOV a fixupped value into an EA, since
1629             ;; MOV on non-registers can only take a 32-bit immediate arg.
1630             ;; Make an exception for :FOREIGN fixups (pretty much just
1631             ;; the runtime asm, since other foreign calls go through the
1632             ;; the linkage table) and for linkage table references, since
1633             ;; these should always end up in low memory.
1634             (aver (or (eq (fixup-flavor src) :foreign)
1635                       (eq (fixup-flavor src) :foreign-dataref)
1636                       (eq (ea-size dst) :dword)))
1637             (maybe-emit-rex-for-ea segment dst nil)
1638             (emit-byte segment #b11000111)
1639             (emit-ea segment dst #b000)
1640             (emit-absolute-fixup segment src))
1641            (t
1642             (error "bogus arguments to MOV: ~S ~S" dst src))))))
1643
1644 (defun emit-move-with-extension (segment dst src signed-p)
1645   (aver (register-p dst))
1646   (let ((dst-size (operand-size dst))
1647         (src-size (operand-size src))
1648         (opcode (if signed-p  #b10111110 #b10110110)))
1649     (ecase dst-size
1650       (:word
1651        (aver (eq src-size :byte))
1652        (maybe-emit-operand-size-prefix segment :word)
1653        ;; REX prefix is needed if SRC is SIL, DIL, SPL or BPL.
1654        (maybe-emit-rex-for-ea segment src dst :operand-size :word)
1655        (emit-byte segment #b00001111)
1656        (emit-byte segment opcode)
1657        (emit-ea segment src (reg-tn-encoding dst)))
1658       ((:dword :qword)
1659        (ecase src-size
1660          (:byte
1661           (maybe-emit-rex-for-ea segment src dst :operand-size dst-size)
1662           (emit-byte segment #b00001111)
1663           (emit-byte segment opcode)
1664           (emit-ea segment src (reg-tn-encoding dst)))
1665          (:word
1666           (maybe-emit-rex-for-ea segment src dst :operand-size dst-size)
1667           (emit-byte segment #b00001111)
1668           (emit-byte segment (logior opcode 1))
1669           (emit-ea segment src (reg-tn-encoding dst)))
1670          (:dword
1671           (aver (eq dst-size :qword))
1672           ;; dst is in reg, src is in modrm
1673           (let ((ea-p (ea-p src)))
1674             (maybe-emit-rex-prefix segment (if signed-p :qword :dword) dst
1675                                    (and ea-p (ea-index src))
1676                                    (cond (ea-p (ea-base src))
1677                                          ((tn-p src) src)
1678                                          (t nil)))
1679             (emit-byte segment #x63)    ;movsxd
1680             ;;(emit-byte segment opcode)
1681             (emit-ea segment src (reg-tn-encoding dst)))))))))
1682
1683 (define-instruction movsx (segment dst src)
1684   (:printer ext-reg-reg/mem-no-width
1685             ((op #b10111110) (reg/mem nil :type 'sized-byte-reg/mem)))
1686   (:printer rex-ext-reg-reg/mem-no-width
1687             ((op #b10111110) (reg/mem nil :type 'sized-byte-reg/mem)))
1688   (:printer ext-reg-reg/mem-no-width
1689             ((op #b10111111) (reg/mem nil :type 'sized-word-reg/mem)))
1690   (:printer rex-ext-reg-reg/mem-no-width
1691             ((op #b10111111) (reg/mem nil :type 'sized-word-reg/mem)))
1692   (:emitter (emit-move-with-extension segment dst src :signed)))
1693
1694 (define-instruction movzx (segment dst src)
1695   (:printer ext-reg-reg/mem-no-width
1696             ((op #b10110110) (reg/mem nil :type 'sized-byte-reg/mem)))
1697   (:printer rex-ext-reg-reg/mem-no-width
1698             ((op #b10110110) (reg/mem nil :type 'sized-byte-reg/mem)))
1699   (:printer ext-reg-reg/mem-no-width
1700             ((op #b10110111) (reg/mem nil :type 'sized-word-reg/mem)))
1701   (:printer rex-ext-reg-reg/mem-no-width
1702             ((op #b10110111) (reg/mem nil :type 'sized-word-reg/mem)))
1703   (:emitter (emit-move-with-extension segment dst src nil)))
1704
1705 ;;; The regular use of MOVSXD is with an operand size of :qword. This
1706 ;;; sign-extends the dword source into the qword destination register.
1707 ;;; If the operand size is :dword the instruction zero-extends the dword
1708 ;;; source into the qword destination register, i.e. it does the same as
1709 ;;; a dword MOV into a register.
1710 (define-instruction movsxd (segment dst src)
1711   (:printer reg-reg/mem ((op #b0110001) (width 1)
1712                          (reg/mem nil :type 'sized-dword-reg/mem)))
1713   (:printer rex-reg-reg/mem ((op #b0110001) (width 1)
1714                              (reg/mem nil :type 'sized-dword-reg/mem)))
1715   (:emitter (emit-move-with-extension segment dst src :signed)))
1716
1717 ;;; this is not a real amd64 instruction, of course
1718 (define-instruction movzxd (segment dst src)
1719   ; (:printer reg-reg/mem ((op #x63) (reg nil :type 'reg)))
1720   (:emitter (emit-move-with-extension segment dst src nil)))
1721
1722 (define-instruction push (segment src)
1723   ;; register
1724   (:printer reg-no-width-default-qword ((op #b01010)))
1725   (:printer rex-reg-no-width-default-qword ((op #b01010)))
1726   ;; register/memory
1727   (:printer reg/mem-default-qword ((op '(#b11111111 #b110))))
1728   (:printer rex-reg/mem-default-qword ((op '(#b11111111 #b110))))
1729   ;; immediate
1730   (:printer byte ((op #b01101010) (imm nil :type 'signed-imm-byte))
1731             '(:name :tab imm))
1732   (:printer byte ((op #b01101000)
1733                   (imm nil :type 'signed-imm-data-default-qword))
1734             '(:name :tab imm))
1735   ;; ### segment registers?
1736
1737   (:emitter
1738    (cond ((integerp src)
1739           (cond ((<= -128 src 127)
1740                  (emit-byte segment #b01101010)
1741                  (emit-byte segment src))
1742                 (t
1743                  ;; A REX-prefix is not needed because the operand size
1744                  ;; defaults to 64 bits. The size of the immediate is 32
1745                  ;; bits and it is sign-extended.
1746                  (emit-byte segment #b01101000)
1747                  (emit-signed-dword segment src))))
1748          (t
1749           (let ((size (operand-size src)))
1750             (aver (or (eq size :qword) (eq size :word)))
1751             (maybe-emit-operand-size-prefix segment size)
1752             (maybe-emit-rex-for-ea segment src nil :operand-size :do-not-set)
1753             (cond ((register-p src)
1754                    (emit-byte-with-reg segment #b01010 (reg-tn-encoding src)))
1755                   (t
1756                    (emit-byte segment #b11111111)
1757                    (emit-ea segment src #b110 t))))))))
1758
1759 (define-instruction pop (segment dst)
1760   (:printer reg-no-width-default-qword ((op #b01011)))
1761   (:printer rex-reg-no-width-default-qword ((op #b01011)))
1762   (:printer reg/mem-default-qword ((op '(#b10001111 #b000))))
1763   (:printer rex-reg/mem-default-qword ((op '(#b10001111 #b000))))
1764   (:emitter
1765    (let ((size (operand-size dst)))
1766      (aver (or (eq size :qword) (eq size :word)))
1767      (maybe-emit-operand-size-prefix segment size)
1768      (maybe-emit-rex-for-ea segment dst nil :operand-size :do-not-set)
1769      (cond ((register-p dst)
1770             (emit-byte-with-reg segment #b01011 (reg-tn-encoding dst)))
1771            (t
1772             (emit-byte segment #b10001111)
1773             (emit-ea segment dst #b000))))))
1774
1775 (define-instruction xchg (segment operand1 operand2)
1776   ;; Register with accumulator.
1777   (:printer reg-no-width ((op #b10010)) '(:name :tab accum ", " reg))
1778   ;; Register/Memory with Register.
1779   (:printer reg-reg/mem ((op #b1000011)))
1780   (:printer rex-reg-reg/mem ((op #b1000011)))
1781   (:emitter
1782    (let ((size (matching-operand-size operand1 operand2)))
1783      (maybe-emit-operand-size-prefix segment size)
1784      (labels ((xchg-acc-with-something (acc something)
1785                 (if (and (not (eq size :byte)) (register-p something))
1786                     (progn
1787                       (maybe-emit-rex-for-ea segment acc something)
1788                       (emit-byte-with-reg segment
1789                                           #b10010
1790                                           (reg-tn-encoding something)))
1791                     (xchg-reg-with-something acc something)))
1792               (xchg-reg-with-something (reg something)
1793                 (maybe-emit-rex-for-ea segment something reg)
1794                 (emit-byte segment (if (eq size :byte) #b10000110 #b10000111))
1795                 (emit-ea segment something (reg-tn-encoding reg))))
1796        (cond ((accumulator-p operand1)
1797               (xchg-acc-with-something operand1 operand2))
1798              ((accumulator-p operand2)
1799               (xchg-acc-with-something operand2 operand1))
1800              ((register-p operand1)
1801               (xchg-reg-with-something operand1 operand2))
1802              ((register-p operand2)
1803               (xchg-reg-with-something operand2 operand1))
1804              (t
1805               (error "bogus args to XCHG: ~S ~S" operand1 operand2)))))))
1806
1807 (define-instruction lea (segment dst src)
1808   (:printer rex-reg-reg/mem ((op #b1000110)))
1809   (:printer reg-reg/mem ((op #b1000110) (width 1)))
1810   (:emitter
1811    (aver (or (dword-reg-p dst) (qword-reg-p dst)))
1812    (maybe-emit-rex-for-ea segment src dst
1813                           :operand-size :qword)
1814    (emit-byte segment #b10001101)
1815    (emit-ea segment src (reg-tn-encoding dst))))
1816
1817 (define-instruction cmpxchg (segment dst src)
1818   ;; Register/Memory with Register.
1819   (:printer ext-reg-reg/mem ((op #b1011000)) '(:name :tab reg/mem ", " reg))
1820   (:emitter
1821    (aver (register-p src))
1822    (let ((size (matching-operand-size src dst)))
1823      (maybe-emit-operand-size-prefix segment size)
1824      (maybe-emit-rex-for-ea segment dst src)
1825      (emit-byte segment #b00001111)
1826      (emit-byte segment (if (eq size :byte) #b10110000 #b10110001))
1827      (emit-ea segment dst (reg-tn-encoding src)))))
1828
1829 \f
1830
1831 (define-instruction fs-segment-prefix (segment)
1832   (:emitter
1833    (emit-byte segment #x64)))
1834
1835 ;;;; flag control instructions
1836
1837 ;;; CLC -- Clear Carry Flag.
1838 (define-instruction clc (segment)
1839   (:printer byte ((op #b11111000)))
1840   (:emitter
1841    (emit-byte segment #b11111000)))
1842
1843 ;;; CLD -- Clear Direction Flag.
1844 (define-instruction cld (segment)
1845   (:printer byte ((op #b11111100)))
1846   (:emitter
1847    (emit-byte segment #b11111100)))
1848
1849 ;;; CLI -- Clear Iterrupt Enable Flag.
1850 (define-instruction cli (segment)
1851   (:printer byte ((op #b11111010)))
1852   (:emitter
1853    (emit-byte segment #b11111010)))
1854
1855 ;;; CMC -- Complement Carry Flag.
1856 (define-instruction cmc (segment)
1857   (:printer byte ((op #b11110101)))
1858   (:emitter
1859    (emit-byte segment #b11110101)))
1860
1861 ;;; LAHF -- Load AH into flags.
1862 (define-instruction lahf (segment)
1863   (:printer byte ((op #b10011111)))
1864   (:emitter
1865    (emit-byte segment #b10011111)))
1866
1867 ;;; POPF -- Pop flags.
1868 (define-instruction popf (segment)
1869   (:printer byte ((op #b10011101)))
1870   (:emitter
1871    (emit-byte segment #b10011101)))
1872
1873 ;;; PUSHF -- push flags.
1874 (define-instruction pushf (segment)
1875   (:printer byte ((op #b10011100)))
1876   (:emitter
1877    (emit-byte segment #b10011100)))
1878
1879 ;;; SAHF -- Store AH into flags.
1880 (define-instruction sahf (segment)
1881   (:printer byte ((op #b10011110)))
1882   (:emitter
1883    (emit-byte segment #b10011110)))
1884
1885 ;;; STC -- Set Carry Flag.
1886 (define-instruction stc (segment)
1887   (:printer byte ((op #b11111001)))
1888   (:emitter
1889    (emit-byte segment #b11111001)))
1890
1891 ;;; STD -- Set Direction Flag.
1892 (define-instruction std (segment)
1893   (:printer byte ((op #b11111101)))
1894   (:emitter
1895    (emit-byte segment #b11111101)))
1896
1897 ;;; STI -- Set Interrupt Enable Flag.
1898 (define-instruction sti (segment)
1899   (:printer byte ((op #b11111011)))
1900   (:emitter
1901    (emit-byte segment #b11111011)))
1902 \f
1903 ;;;; arithmetic
1904
1905 (defun emit-random-arith-inst (name segment dst src opcode
1906                                     &optional allow-constants)
1907   (let ((size (matching-operand-size dst src)))
1908     (maybe-emit-operand-size-prefix segment size)
1909     (cond
1910      ((integerp src)
1911       (cond ((and (not (eq size :byte)) (<= -128 src 127))
1912              (maybe-emit-rex-for-ea segment dst nil)
1913              (emit-byte segment #b10000011)
1914              (emit-ea segment dst opcode allow-constants)
1915              (emit-byte segment src))
1916             ((accumulator-p dst)
1917              (maybe-emit-rex-for-ea segment dst nil)
1918              (emit-byte segment
1919                         (dpb opcode
1920                              (byte 3 3)
1921                              (if (eq size :byte)
1922                                  #b00000100
1923                                  #b00000101)))
1924              (emit-sized-immediate segment size src))
1925             (t
1926              (maybe-emit-rex-for-ea segment dst nil)
1927              (emit-byte segment (if (eq size :byte) #b10000000 #b10000001))
1928              (emit-ea segment dst opcode allow-constants)
1929              (emit-sized-immediate segment size src))))
1930      ((register-p src)
1931       (maybe-emit-rex-for-ea segment dst src)
1932       (emit-byte segment
1933                  (dpb opcode
1934                       (byte 3 3)
1935                       (if (eq size :byte) #b00000000 #b00000001)))
1936       (emit-ea segment dst (reg-tn-encoding src) allow-constants))
1937      ((register-p dst)
1938       (maybe-emit-rex-for-ea segment src dst)
1939       (emit-byte segment
1940                  (dpb opcode
1941                       (byte 3 3)
1942                       (if (eq size :byte) #b00000010 #b00000011)))
1943       (emit-ea segment src (reg-tn-encoding dst) allow-constants))
1944      (t
1945       (error "bogus operands to ~A" name)))))
1946
1947 (eval-when (:compile-toplevel :execute)
1948   (defun arith-inst-printer-list (subop)
1949     `((accum-imm ((op ,(dpb subop (byte 3 2) #b0000010))))
1950       (rex-accum-imm ((op ,(dpb subop (byte 3 2) #b0000010))))
1951       (reg/mem-imm ((op (#b1000000 ,subop))))
1952       (rex-reg/mem-imm ((op (#b1000000 ,subop))))
1953       ;; The redundant encoding #x82 is invalid in 64-bit mode,
1954       ;; therefore we force WIDTH to 1.
1955       (reg/mem-imm ((op (#b1000001 ,subop)) (width 1)
1956                     (imm nil :type signed-imm-byte)))
1957       (rex-reg/mem-imm ((op (#b1000001 ,subop)) (width 1)
1958                         (imm nil :type signed-imm-byte)))
1959       (reg-reg/mem-dir ((op ,(dpb subop (byte 3 1) #b000000))))
1960       (rex-reg-reg/mem-dir ((op ,(dpb subop (byte 3 1) #b000000))))))
1961   )
1962
1963 (define-instruction add (segment dst src)
1964   (:printer-list (arith-inst-printer-list #b000))
1965   (:emitter (emit-random-arith-inst "ADD" segment dst src #b000)))
1966
1967 (define-instruction adc (segment dst src)
1968   (:printer-list (arith-inst-printer-list #b010))
1969   (:emitter (emit-random-arith-inst "ADC" segment dst src #b010)))
1970
1971 (define-instruction sub (segment dst src)
1972   (:printer-list (arith-inst-printer-list #b101))
1973   (:emitter (emit-random-arith-inst "SUB" segment dst src #b101)))
1974
1975 (define-instruction sbb (segment dst src)
1976   (:printer-list (arith-inst-printer-list #b011))
1977   (:emitter (emit-random-arith-inst "SBB" segment dst src #b011)))
1978
1979 (define-instruction cmp (segment dst src)
1980   (:printer-list (arith-inst-printer-list #b111))
1981   (:emitter (emit-random-arith-inst "CMP" segment dst src #b111 t)))
1982
1983 (define-instruction inc (segment dst)
1984   ;; Register
1985   (:printer modrm-reg-no-width ((modrm-reg #b000)))
1986   ;; Register/Memory
1987   ;; (:printer rex-reg/mem ((op '(#b11111111 #b001))))
1988   (:printer reg/mem ((op '(#b1111111 #b000))))
1989   (:emitter
1990    (let ((size (operand-size dst)))
1991      (maybe-emit-operand-size-prefix segment size)
1992      (cond #+nil ; these opcodes become REX prefixes in x86-64
1993            ((and (not (eq size :byte)) (register-p dst))
1994             (emit-byte-with-reg segment #b01000 (reg-tn-encoding dst)))
1995            (t
1996             (maybe-emit-rex-for-ea segment dst nil)
1997             (emit-byte segment (if (eq size :byte) #b11111110 #b11111111))
1998             (emit-ea segment dst #b000))))))
1999
2000 (define-instruction dec (segment dst)
2001   ;; Register.
2002   (:printer modrm-reg-no-width ((modrm-reg #b001)))
2003   ;; Register/Memory
2004   (:printer reg/mem ((op '(#b1111111 #b001))))
2005   (:emitter
2006    (let ((size (operand-size dst)))
2007      (maybe-emit-operand-size-prefix segment size)
2008      (cond #+nil
2009            ((and (not (eq size :byte)) (register-p dst))
2010             (emit-byte-with-reg segment #b01001 (reg-tn-encoding dst)))
2011            (t
2012             (maybe-emit-rex-for-ea segment dst nil)
2013             (emit-byte segment (if (eq size :byte) #b11111110 #b11111111))
2014             (emit-ea segment dst #b001))))))
2015
2016 (define-instruction neg (segment dst)
2017   (:printer reg/mem ((op '(#b1111011 #b011))))
2018   (:printer rex-reg/mem ((op '(#b1111011 #b011))))
2019   (:emitter
2020    (let ((size (operand-size dst)))
2021      (maybe-emit-operand-size-prefix segment size)
2022      (maybe-emit-rex-for-ea segment dst nil)
2023      (emit-byte segment (if (eq size :byte) #b11110110 #b11110111))
2024      (emit-ea segment dst #b011))))
2025
2026 (define-instruction mul (segment dst src)
2027   (:printer accum-reg/mem ((op '(#b1111011 #b100))))
2028   (:printer rex-accum-reg/mem ((op '(#b1111011 #b100))))
2029   (:emitter
2030    (let ((size (matching-operand-size dst src)))
2031      (aver (accumulator-p dst))
2032      (maybe-emit-operand-size-prefix segment size)
2033      (maybe-emit-rex-for-ea segment src nil)
2034      (emit-byte segment (if (eq size :byte) #b11110110 #b11110111))
2035      (emit-ea segment src #b100))))
2036
2037 (define-instruction imul (segment dst &optional src1 src2)
2038   (:printer accum-reg/mem ((op '(#b1111011 #b101))))
2039   (:printer rex-accum-reg/mem ((op '(#b1111011 #b101))))
2040   (:printer ext-reg-reg/mem-no-width ((op #b10101111)))
2041   (:printer rex-ext-reg-reg/mem-no-width ((op #b10101111)))
2042   (:printer reg-reg/mem ((op #b0110100) (width 1)
2043                          (imm nil :type 'signed-imm-data))
2044             '(:name :tab reg ", " reg/mem ", " imm))
2045   (:printer rex-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   (:printer rex-reg-reg/mem ((op #b0110101) (width 1)
2052                              (imm nil :type 'signed-imm-byte))
2053             '(:name :tab reg ", " reg/mem ", " imm))
2054   (:emitter
2055    (flet ((r/m-with-immed-to-reg (reg r/m immed)
2056             (let* ((size (matching-operand-size reg r/m))
2057                    (sx (and (not (eq size :byte)) (<= -128 immed 127))))
2058               (maybe-emit-operand-size-prefix segment size)
2059               (maybe-emit-rex-for-ea segment r/m reg)
2060               (emit-byte segment (if sx #b01101011 #b01101001))
2061               (emit-ea segment r/m (reg-tn-encoding reg))
2062               (if sx
2063                   (emit-byte segment immed)
2064                   (emit-sized-immediate segment size immed)))))
2065      (cond (src2
2066             (r/m-with-immed-to-reg dst src1 src2))
2067            (src1
2068             (if (integerp src1)
2069                 (r/m-with-immed-to-reg dst dst src1)
2070                 (let ((size (matching-operand-size dst src1)))
2071                   (maybe-emit-operand-size-prefix segment size)
2072                   (maybe-emit-rex-for-ea segment src1 dst)
2073                   (emit-byte segment #b00001111)
2074                   (emit-byte segment #b10101111)
2075                   (emit-ea segment src1 (reg-tn-encoding dst)))))
2076            (t
2077             (let ((size (operand-size dst)))
2078               (maybe-emit-operand-size-prefix segment size)
2079               (maybe-emit-rex-for-ea segment dst nil)
2080               (emit-byte segment (if (eq size :byte) #b11110110 #b11110111))
2081               (emit-ea segment dst #b101)))))))
2082
2083 (define-instruction div (segment dst src)
2084   (:printer accum-reg/mem ((op '(#b1111011 #b110))))
2085   (:printer rex-accum-reg/mem ((op '(#b1111011 #b110))))
2086   (:emitter
2087    (let ((size (matching-operand-size dst src)))
2088      (aver (accumulator-p dst))
2089      (maybe-emit-operand-size-prefix segment size)
2090      (maybe-emit-rex-for-ea segment src nil)
2091      (emit-byte segment (if (eq size :byte) #b11110110 #b11110111))
2092      (emit-ea segment src #b110))))
2093
2094 (define-instruction idiv (segment dst src)
2095   (:printer accum-reg/mem ((op '(#b1111011 #b111))))
2096   (:printer rex-accum-reg/mem ((op '(#b1111011 #b111))))
2097   (:emitter
2098    (let ((size (matching-operand-size dst src)))
2099      (aver (accumulator-p dst))
2100      (maybe-emit-operand-size-prefix segment size)
2101      (maybe-emit-rex-for-ea segment src nil)
2102      (emit-byte segment (if (eq size :byte) #b11110110 #b11110111))
2103      (emit-ea segment src #b111))))
2104
2105 (define-instruction bswap (segment dst)
2106   (:printer ext-reg-no-width ((op #b11001)))
2107   (:emitter
2108    (let ((size (operand-size dst)))
2109      (maybe-emit-rex-prefix segment size nil nil dst)
2110      (emit-byte segment #x0f)
2111      (emit-byte-with-reg segment #b11001 (reg-tn-encoding dst)))))
2112
2113 ;;; CBW -- Convert Byte to Word. AX <- sign_xtnd(AL)
2114 (define-instruction cbw (segment)
2115   (:printer x66-byte ((op #b10011000)))
2116   (:emitter
2117    (maybe-emit-operand-size-prefix segment :word)
2118    (emit-byte segment #b10011000)))
2119
2120 ;;; CWDE -- Convert Word To Double Word Extended. EAX <- sign_xtnd(AX)
2121 (define-instruction cwde (segment)
2122   (:printer byte ((op #b10011000)))
2123   (:emitter
2124    (maybe-emit-operand-size-prefix segment :dword)
2125    (emit-byte segment #b10011000)))
2126
2127 ;;; CDQE -- Convert Double Word To Quad Word Extended. RAX <- sign_xtnd(EAX)
2128 (define-instruction cdqe (segment)
2129   (:printer rex-byte ((op #b10011000)))
2130   (:emitter
2131    (maybe-emit-rex-prefix segment :qword nil nil nil)
2132    (emit-byte segment #b10011000)))
2133
2134 ;;; CWD -- Convert Word to Double Word. DX:AX <- sign_xtnd(AX)
2135 (define-instruction cwd (segment)
2136   (:printer x66-byte ((op #b10011001)))
2137   (:emitter
2138    (maybe-emit-operand-size-prefix segment :word)
2139    (emit-byte segment #b10011001)))
2140
2141 ;;; CDQ -- Convert Double Word to Quad Word. EDX:EAX <- sign_xtnd(EAX)
2142 (define-instruction cdq (segment)
2143   (:printer byte ((op #b10011001)))
2144   (:emitter
2145    (maybe-emit-operand-size-prefix segment :dword)
2146    (emit-byte segment #b10011001)))
2147
2148 ;;; CQO -- Convert Quad Word to Octaword. RDX:RAX <- sign_xtnd(RAX)
2149 (define-instruction cqo (segment)
2150   (:printer rex-byte ((op #b10011001)))
2151   (:emitter
2152    (maybe-emit-rex-prefix segment :qword nil nil nil)
2153    (emit-byte segment #b10011001)))
2154
2155 (define-instruction xadd (segment dst src)
2156   ;; Register/Memory with Register.
2157   (:printer ext-reg-reg/mem ((op #b1100000)) '(:name :tab reg/mem ", " reg))
2158   (:emitter
2159    (aver (register-p src))
2160    (let ((size (matching-operand-size src dst)))
2161      (maybe-emit-operand-size-prefix segment size)
2162      (maybe-emit-rex-for-ea segment dst src)
2163      (emit-byte segment #b00001111)
2164      (emit-byte segment (if (eq size :byte) #b11000000 #b11000001))
2165      (emit-ea segment dst (reg-tn-encoding src)))))
2166
2167 \f
2168 ;;;; logic
2169
2170 (defun emit-shift-inst (segment dst amount opcode)
2171   (let ((size (operand-size dst)))
2172     (maybe-emit-operand-size-prefix segment size)
2173     (multiple-value-bind (major-opcode immed)
2174         (case amount
2175           (:cl (values #b11010010 nil))
2176           (1 (values #b11010000 nil))
2177           (t (values #b11000000 t)))
2178       (maybe-emit-rex-for-ea segment dst nil)
2179       (emit-byte segment
2180                  (if (eq size :byte) major-opcode (logior major-opcode 1)))
2181       (emit-ea segment dst opcode)
2182       (when immed
2183         (emit-byte segment amount)))))
2184
2185 (eval-when (:compile-toplevel :execute)
2186   (defun shift-inst-printer-list (subop)
2187     `((reg/mem ((op (#b1101000 ,subop)))
2188                (:name :tab reg/mem ", 1"))
2189       (rex-reg/mem ((op (#b1101000 ,subop)))
2190                    (:name :tab reg/mem ", 1"))
2191       (reg/mem ((op (#b1101001 ,subop)))
2192                (:name :tab reg/mem ", " 'cl))
2193       (rex-reg/mem ((op (#b1101001 ,subop)))
2194                (:name :tab reg/mem ", " 'cl))
2195       (reg/mem-imm ((op (#b1100000 ,subop))
2196                     (imm nil :type imm-byte)))
2197       (rex-reg/mem-imm ((op (#b1100000 ,subop))
2198                     (imm nil :type imm-byte))))))
2199
2200 (define-instruction rol (segment dst amount)
2201   (:printer-list
2202    (shift-inst-printer-list #b000))
2203   (:emitter
2204    (emit-shift-inst segment dst amount #b000)))
2205
2206 (define-instruction ror (segment dst amount)
2207   (:printer-list
2208    (shift-inst-printer-list #b001))
2209   (:emitter
2210    (emit-shift-inst segment dst amount #b001)))
2211
2212 (define-instruction rcl (segment dst amount)
2213   (:printer-list
2214    (shift-inst-printer-list #b010))
2215   (:emitter
2216    (emit-shift-inst segment dst amount #b010)))
2217
2218 (define-instruction rcr (segment dst amount)
2219   (:printer-list
2220    (shift-inst-printer-list #b011))
2221   (:emitter
2222    (emit-shift-inst segment dst amount #b011)))
2223
2224 (define-instruction shl (segment dst amount)
2225   (:printer-list
2226    (shift-inst-printer-list #b100))
2227   (:emitter
2228    (emit-shift-inst segment dst amount #b100)))
2229
2230 (define-instruction shr (segment dst amount)
2231   (:printer-list
2232    (shift-inst-printer-list #b101))
2233   (:emitter
2234    (emit-shift-inst segment dst amount #b101)))
2235
2236 (define-instruction sar (segment dst amount)
2237   (:printer-list
2238    (shift-inst-printer-list #b111))
2239   (:emitter
2240    (emit-shift-inst segment dst amount #b111)))
2241
2242 (defun emit-double-shift (segment opcode dst src amt)
2243   (let ((size (matching-operand-size dst src)))
2244     (when (eq size :byte)
2245       (error "Double shifts can only be used with words."))
2246     (maybe-emit-operand-size-prefix segment size)
2247     (maybe-emit-rex-for-ea segment dst src)
2248     (emit-byte segment #b00001111)
2249     (emit-byte segment (dpb opcode (byte 1 3)
2250                             (if (eq amt :cl) #b10100101 #b10100100)))
2251     (emit-ea segment dst (reg-tn-encoding src))
2252     (unless (eq amt :cl)
2253       (emit-byte segment amt))))
2254
2255 (eval-when (:compile-toplevel :execute)
2256   (defun double-shift-inst-printer-list (op)
2257     `(#+nil
2258       (ext-reg-reg/mem-imm ((op ,(logior op #b100))
2259                             (imm nil :type signed-imm-byte)))
2260       (ext-reg-reg/mem ((op ,(logior op #b101)))
2261          (:name :tab reg/mem ", " 'cl)))))
2262
2263 (define-instruction shld (segment dst src amt)
2264   (:declare (type (or (member :cl) (mod 32)) amt))
2265   (:printer-list (double-shift-inst-printer-list #b10100000))
2266   (:emitter
2267    (emit-double-shift segment #b0 dst src amt)))
2268
2269 (define-instruction shrd (segment dst src amt)
2270   (:declare (type (or (member :cl) (mod 32)) amt))
2271   (:printer-list (double-shift-inst-printer-list #b10101000))
2272   (:emitter
2273    (emit-double-shift segment #b1 dst src amt)))
2274
2275 (define-instruction and (segment dst src)
2276   (:printer-list
2277    (arith-inst-printer-list #b100))
2278   (:emitter
2279    (emit-random-arith-inst "AND" segment dst src #b100)))
2280
2281 (define-instruction test (segment this that)
2282   (:printer accum-imm ((op #b1010100)))
2283   (:printer rex-accum-imm ((op #b1010100)))
2284   (:printer reg/mem-imm ((op '(#b1111011 #b000))))
2285   (:printer rex-reg/mem-imm ((op '(#b1111011 #b000))))
2286   (:printer reg-reg/mem ((op #b1000010)))
2287   (:printer rex-reg-reg/mem ((op #b1000010)))
2288   (:emitter
2289    (let ((size (matching-operand-size this that)))
2290      (maybe-emit-operand-size-prefix segment size)
2291      (flet ((test-immed-and-something (immed something)
2292               (cond ((accumulator-p something)
2293                      (maybe-emit-rex-for-ea segment something nil)
2294                      (emit-byte segment
2295                                 (if (eq size :byte) #b10101000 #b10101001))
2296                      (emit-sized-immediate segment size immed))
2297                     (t
2298                      (maybe-emit-rex-for-ea segment something nil)
2299                      (emit-byte segment
2300                                 (if (eq size :byte) #b11110110 #b11110111))
2301                      (emit-ea segment something #b000)
2302                      (emit-sized-immediate segment size immed))))
2303             (test-reg-and-something (reg something)
2304               (maybe-emit-rex-for-ea segment something reg)
2305               (emit-byte segment (if (eq size :byte) #b10000100 #b10000101))
2306               (emit-ea segment something (reg-tn-encoding reg))))
2307        (cond ((integerp that)
2308               (test-immed-and-something that this))
2309              ((integerp this)
2310               (test-immed-and-something this that))
2311              ((register-p this)
2312               (test-reg-and-something this that))
2313              ((register-p that)
2314               (test-reg-and-something that this))
2315              (t
2316               (error "bogus operands for TEST: ~S and ~S" this that)))))))
2317
2318 (define-instruction or (segment dst src)
2319   (:printer-list
2320    (arith-inst-printer-list #b001))
2321   (:emitter
2322    (emit-random-arith-inst "OR" segment dst src #b001)))
2323
2324 (define-instruction xor (segment dst src)
2325   (:printer-list
2326    (arith-inst-printer-list #b110))
2327   (:emitter
2328    (emit-random-arith-inst "XOR" segment dst src #b110)))
2329
2330 (define-instruction not (segment dst)
2331   (:printer reg/mem ((op '(#b1111011 #b010))))
2332   (:printer rex-reg/mem ((op '(#b1111011 #b010))))
2333   (:emitter
2334    (let ((size (operand-size dst)))
2335      (maybe-emit-operand-size-prefix segment size)
2336      (maybe-emit-rex-for-ea segment dst nil)
2337      (emit-byte segment (if (eq size :byte) #b11110110 #b11110111))
2338      (emit-ea segment dst #b010))))
2339 \f
2340 ;;;; string manipulation
2341
2342 (define-instruction cmps (segment size)
2343   (:printer string-op ((op #b1010011)))
2344   (:printer rex-string-op ((op #b1010011)))
2345   (:emitter
2346    (maybe-emit-operand-size-prefix segment size)
2347    (maybe-emit-rex-prefix segment size nil nil nil)
2348    (emit-byte segment (if (eq size :byte) #b10100110 #b10100111))))
2349
2350 (define-instruction ins (segment acc)
2351   (:printer string-op ((op #b0110110)))
2352   (:printer rex-string-op ((op #b0110110)))
2353   (:emitter
2354    (let ((size (operand-size acc)))
2355      (aver (accumulator-p acc))
2356      (maybe-emit-operand-size-prefix segment size)
2357      (maybe-emit-rex-prefix segment size nil nil nil)
2358      (emit-byte segment (if (eq size :byte) #b01101100 #b01101101)))))
2359
2360 (define-instruction lods (segment acc)
2361   (:printer string-op ((op #b1010110)))
2362   (:printer rex-string-op ((op #b1010110)))
2363   (:emitter
2364    (let ((size (operand-size acc)))
2365      (aver (accumulator-p acc))
2366      (maybe-emit-operand-size-prefix segment size)
2367      (maybe-emit-rex-prefix segment size nil nil nil)
2368      (emit-byte segment (if (eq size :byte) #b10101100 #b10101101)))))
2369
2370 (define-instruction movs (segment size)
2371   (:printer string-op ((op #b1010010)))
2372   (:printer rex-string-op ((op #b1010010)))
2373   (:emitter
2374    (maybe-emit-operand-size-prefix segment size)
2375    (maybe-emit-rex-prefix segment size nil nil nil)
2376    (emit-byte segment (if (eq size :byte) #b10100100 #b10100101))))
2377
2378 (define-instruction outs (segment acc)
2379   (:printer string-op ((op #b0110111)))
2380   (:printer rex-string-op ((op #b0110111)))
2381   (:emitter
2382    (let ((size (operand-size acc)))
2383      (aver (accumulator-p acc))
2384      (maybe-emit-operand-size-prefix segment size)
2385      (maybe-emit-rex-prefix segment size nil nil nil)
2386      (emit-byte segment (if (eq size :byte) #b01101110 #b01101111)))))
2387
2388 (define-instruction scas (segment acc)
2389   (:printer string-op ((op #b1010111)))
2390   (:printer rex-string-op ((op #b1010111)))
2391   (:emitter
2392    (let ((size (operand-size acc)))
2393      (aver (accumulator-p acc))
2394      (maybe-emit-operand-size-prefix segment size)
2395      (maybe-emit-rex-prefix segment size nil nil nil)
2396      (emit-byte segment (if (eq size :byte) #b10101110 #b10101111)))))
2397
2398 (define-instruction stos (segment acc)
2399   (:printer string-op ((op #b1010101)))
2400   (:printer rex-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 (define-instruction rep (segment)
2414   (:emitter
2415    (emit-byte segment #b11110010)))
2416
2417 (define-instruction repe (segment)
2418   (:printer byte ((op #b11110011)))
2419   (:emitter
2420    (emit-byte segment #b11110011)))
2421
2422 (define-instruction repne (segment)
2423   (:printer byte ((op #b11110010)))
2424   (:emitter
2425    (emit-byte segment #b11110010)))
2426
2427 \f
2428 ;;;; bit manipulation
2429
2430 (define-instruction bsf (segment dst src)
2431   (:printer ext-reg-reg/mem-no-width ((op #b10111100)))
2432   (:printer rex-ext-reg-reg/mem-no-width ((op #b10111100)))
2433   (:emitter
2434    (let ((size (matching-operand-size dst src)))
2435      (when (eq size :byte)
2436        (error "can't scan bytes: ~S" src))
2437      (maybe-emit-operand-size-prefix segment size)
2438      (maybe-emit-rex-for-ea segment src dst)
2439      (emit-byte segment #b00001111)
2440      (emit-byte segment #b10111100)
2441      (emit-ea segment src (reg-tn-encoding dst)))))
2442
2443 (define-instruction bsr (segment dst src)
2444   (:printer ext-reg-reg/mem-no-width ((op #b10111101)))
2445   (:printer rex-ext-reg-reg/mem-no-width ((op #b10111101)))
2446   (:emitter
2447    (let ((size (matching-operand-size dst src)))
2448      (when (eq size :byte)
2449        (error "can't scan bytes: ~S" src))
2450      (maybe-emit-operand-size-prefix segment size)
2451      (maybe-emit-rex-for-ea segment src dst)
2452      (emit-byte segment #b00001111)
2453      (emit-byte segment #b10111101)
2454      (emit-ea segment src (reg-tn-encoding dst)))))
2455
2456 (defun emit-bit-test-and-mumble (segment src index opcode)
2457   (let ((size (operand-size src)))
2458     (when (eq size :byte)
2459       (error "can't scan bytes: ~S" src))
2460     (maybe-emit-operand-size-prefix segment size)
2461     (cond ((integerp index)
2462            (maybe-emit-rex-for-ea segment src nil)
2463            (emit-byte segment #b00001111)
2464            (emit-byte segment #b10111010)
2465            (emit-ea segment src opcode)
2466            (emit-byte segment index))
2467           (t
2468            (maybe-emit-rex-for-ea segment src index)
2469            (emit-byte segment #b00001111)
2470            (emit-byte segment (dpb opcode (byte 3 3) #b10000011))
2471            (emit-ea segment src (reg-tn-encoding index))))))
2472
2473 (eval-when (:compile-toplevel :execute)
2474   (defun bit-test-inst-printer-list (subop)
2475     `((ext-reg/mem-imm ((op (#b1011101 ,subop))
2476                         (reg/mem nil :type reg/mem)
2477                         (imm nil :type imm-byte)
2478                         (width 0)))
2479       (ext-reg-reg/mem ((op ,(dpb subop (byte 3 2) #b1000001))
2480                         (width 1))
2481                        (:name :tab reg/mem ", " reg)))))
2482
2483 (define-instruction bt (segment src index)
2484   (:printer-list (bit-test-inst-printer-list #b100))
2485   (:emitter
2486    (emit-bit-test-and-mumble segment src index #b100)))
2487
2488 (define-instruction btc (segment src index)
2489   (:printer-list (bit-test-inst-printer-list #b111))
2490   (:emitter
2491    (emit-bit-test-and-mumble segment src index #b111)))
2492
2493 (define-instruction btr (segment src index)
2494   (:printer-list (bit-test-inst-printer-list #b110))
2495   (:emitter
2496    (emit-bit-test-and-mumble segment src index #b110)))
2497
2498 (define-instruction bts (segment src index)
2499   (:printer-list (bit-test-inst-printer-list #b101))
2500   (:emitter
2501    (emit-bit-test-and-mumble segment src index #b101)))
2502
2503 \f
2504 ;;;; control transfer
2505
2506 (define-instruction call (segment where)
2507   (:printer near-jump ((op #b11101000)))
2508   (:printer reg/mem-default-qword ((op '(#b11111111 #b010))))
2509   (:printer rex-reg/mem-default-qword ((op '(#b11111111 #b010))))
2510   (:emitter
2511    (typecase where
2512      (label
2513       (emit-byte segment #b11101000) ; 32 bit relative
2514       (emit-back-patch segment
2515                        4
2516                        (lambda (segment posn)
2517                          (emit-signed-dword segment
2518                                             (- (label-position where)
2519                                                (+ posn 4))))))
2520      (fixup
2521       (emit-byte segment #b11101000)
2522       (emit-relative-fixup segment where))
2523      (t
2524       (maybe-emit-rex-for-ea segment where nil :operand-size :do-not-set)
2525       (emit-byte segment #b11111111)
2526       (emit-ea segment where #b010)))))
2527
2528 (defun emit-byte-displacement-backpatch (segment target)
2529   (emit-back-patch segment
2530                    1
2531                    (lambda (segment posn)
2532                      (let ((disp (- (label-position target) (1+ posn))))
2533                        (aver (<= -128 disp 127))
2534                        (emit-byte segment disp)))))
2535
2536 (define-instruction jmp (segment cond &optional where)
2537   ;; conditional jumps
2538   (:printer short-cond-jump ((op #b0111)) '('j cc :tab label))
2539   (:printer near-cond-jump () '('j cc :tab label))
2540   ;; unconditional jumps
2541   (:printer short-jump ((op #b1011)))
2542   (:printer near-jump ((op #b11101001)))
2543   (:printer reg/mem-default-qword ((op '(#b11111111 #b100))))
2544   (:printer rex-reg/mem-default-qword ((op '(#b11111111 #b100))))
2545   (:emitter
2546    (cond (where
2547           (emit-chooser
2548            segment 6 2
2549            (lambda (segment posn delta-if-after)
2550              (let ((disp (- (label-position where posn delta-if-after)
2551                             (+ posn 2))))
2552                (when (<= -128 disp 127)
2553                  (emit-byte segment
2554                             (dpb (conditional-opcode cond)
2555                                  (byte 4 0)
2556                                  #b01110000))
2557                  (emit-byte-displacement-backpatch segment where)
2558                  t)))
2559            (lambda (segment posn)
2560              (let ((disp (- (label-position where) (+ posn 6))))
2561                (emit-byte segment #b00001111)
2562                (emit-byte segment
2563                           (dpb (conditional-opcode cond)
2564                                (byte 4 0)
2565                                #b10000000))
2566                (emit-signed-dword segment disp)))))
2567          ((label-p (setq where cond))
2568           (emit-chooser
2569            segment 5 0
2570            (lambda (segment posn delta-if-after)
2571              (let ((disp (- (label-position where posn delta-if-after)
2572                             (+ posn 2))))
2573                (when (<= -128 disp 127)
2574                  (emit-byte segment #b11101011)
2575                  (emit-byte-displacement-backpatch segment where)
2576                  t)))
2577            (lambda (segment posn)
2578              (let ((disp (- (label-position where) (+ posn 5))))
2579                (emit-byte segment #b11101001)
2580                (emit-signed-dword segment disp)))))
2581          ((fixup-p where)
2582           (emit-byte segment #b11101001)
2583           (emit-relative-fixup segment where))
2584          (t
2585           (unless (or (ea-p where) (tn-p where))
2586             (error "don't know what to do with ~A" where))
2587           ;; near jump defaults to 64 bit
2588           ;; w-bit in rex prefix is unnecessary
2589           (maybe-emit-rex-for-ea segment where nil :operand-size :do-not-set)
2590           (emit-byte segment #b11111111)
2591           (emit-ea segment where #b100)))))
2592
2593 (define-instruction jmp-short (segment label)
2594   (:emitter
2595    (emit-byte segment #b11101011)
2596    (emit-byte-displacement-backpatch segment label)))
2597
2598 (define-instruction ret (segment &optional stack-delta)
2599   (:printer byte ((op #b11000011)))
2600   (:printer byte ((op #b11000010) (imm nil :type 'imm-word-16))
2601             '(:name :tab imm))
2602   (:emitter
2603    (cond (stack-delta
2604           (emit-byte segment #b11000010)
2605           (emit-word segment stack-delta))
2606          (t
2607           (emit-byte segment #b11000011)))))
2608
2609 (define-instruction jecxz (segment target)
2610   (:printer short-jump ((op #b0011)))
2611   (:emitter
2612    (emit-byte segment #b11100011)
2613    (emit-byte-displacement-backpatch segment target)))
2614
2615 (define-instruction loop (segment target)
2616   (:printer short-jump ((op #b0010)))
2617   (:emitter
2618    (emit-byte segment #b11100010)       ; pfw this was 11100011, or jecxz!!!!
2619    (emit-byte-displacement-backpatch segment target)))
2620
2621 (define-instruction loopz (segment target)
2622   (:printer short-jump ((op #b0001)))
2623   (:emitter
2624    (emit-byte segment #b11100001)
2625    (emit-byte-displacement-backpatch segment target)))
2626
2627 (define-instruction loopnz (segment target)
2628   (:printer short-jump ((op #b0000)))
2629   (:emitter
2630    (emit-byte segment #b11100000)
2631    (emit-byte-displacement-backpatch segment target)))
2632 \f
2633 ;;;; conditional move
2634 (define-instruction cmov (segment cond dst src)
2635   (:printer cond-move ())
2636   (:printer rex-cond-move ())
2637   (:emitter
2638    (aver (register-p dst))
2639    (let ((size (matching-operand-size dst src)))
2640      (aver (or (eq size :word) (eq size :dword) (eq size :qword)))
2641      (maybe-emit-operand-size-prefix segment size))
2642    (maybe-emit-rex-for-ea segment src dst)
2643    (emit-byte segment #b00001111)
2644    (emit-byte segment (dpb (conditional-opcode cond) (byte 4 0) #b01000000))
2645    (emit-ea segment src (reg-tn-encoding dst))))
2646
2647 ;;;; conditional byte set
2648
2649 (define-instruction set (segment dst cond)
2650   (:printer cond-set ())
2651   (:emitter
2652    (maybe-emit-rex-for-ea segment dst nil)
2653    (emit-byte segment #b00001111)
2654    (emit-byte segment (dpb (conditional-opcode cond) (byte 4 0) #b10010000))
2655    (emit-ea segment dst #b000)))
2656 \f
2657 ;;;; enter/leave
2658
2659 (define-instruction enter (segment disp &optional (level 0))
2660   (:declare (type (unsigned-byte 16) disp)
2661             (type (unsigned-byte 8) level))
2662   (:printer enter-format ((op #b11001000)))
2663   (:emitter
2664    (emit-byte segment #b11001000)
2665    (emit-word segment disp)
2666    (emit-byte segment level)))
2667
2668 (define-instruction leave (segment)
2669   (:printer byte ((op #b11001001)))
2670   (:emitter
2671    (emit-byte segment #b11001001)))
2672 \f
2673 ;;;; interrupt instructions
2674
2675 (defun snarf-error-junk (sap offset &optional length-only)
2676   (let* ((length (sb!sys:sap-ref-8 sap offset))
2677          (vector (make-array length :element-type '(unsigned-byte 8))))
2678     (declare (type sb!sys:system-area-pointer sap)
2679              (type (unsigned-byte 8) length)
2680              (type (simple-array (unsigned-byte 8) (*)) vector))
2681     (cond (length-only
2682            (values 0 (1+ length) nil nil))
2683           (t
2684            (sb!kernel:copy-ub8-from-system-area sap (1+ offset)
2685                                                 vector 0 length)
2686            (collect ((sc-offsets)
2687                      (lengths))
2688              (lengths 1)                ; the length byte
2689              (let* ((index 0)
2690                     (error-number (sb!c:read-var-integer vector index)))
2691                (lengths index)
2692                (loop
2693                  (when (>= index length)
2694                    (return))
2695                  (let ((old-index index))
2696                    (sc-offsets (sb!c:read-var-integer vector index))
2697                    (lengths (- index old-index))))
2698                (values error-number
2699                        (1+ length)
2700                        (sc-offsets)
2701                        (lengths))))))))
2702
2703 #|
2704 (defmacro break-cases (breaknum &body cases)
2705   (let ((bn-temp (gensym)))
2706     (collect ((clauses))
2707       (dolist (case cases)
2708         (clauses `((= ,bn-temp ,(car case)) ,@(cdr case))))
2709       `(let ((,bn-temp ,breaknum))
2710          (cond ,@(clauses))))))
2711 |#
2712
2713 (defun break-control (chunk inst stream dstate)
2714   (declare (ignore inst))
2715   (flet ((nt (x) (if stream (sb!disassem:note x dstate))))
2716     ;; FIXME: Make sure that BYTE-IMM-CODE is defined. The genesis
2717     ;; map has it undefined; and it should be easier to look in the target
2718     ;; Lisp (with (DESCRIBE 'BYTE-IMM-CODE)) than to definitively deduce
2719     ;; from first principles whether it's defined in some way that genesis
2720     ;; can't grok.
2721     (case (byte-imm-code chunk dstate)
2722       (#.error-trap
2723        (nt "error trap")
2724        (sb!disassem:handle-break-args #'snarf-error-junk stream dstate))
2725       (#.cerror-trap
2726        (nt "cerror trap")
2727        (sb!disassem:handle-break-args #'snarf-error-junk stream dstate))
2728       (#.breakpoint-trap
2729        (nt "breakpoint trap"))
2730       (#.pending-interrupt-trap
2731        (nt "pending interrupt trap"))
2732       (#.halt-trap
2733        (nt "halt trap"))
2734       (#.fun-end-breakpoint-trap
2735        (nt "function end breakpoint trap")))))
2736
2737 (define-instruction break (segment code)
2738   (:declare (type (unsigned-byte 8) code))
2739   (:printer byte-imm ((op #b11001100)) '(:name :tab code)
2740             :control #'break-control)
2741   (:emitter
2742    (emit-byte segment #b11001100)
2743    (emit-byte segment code)))
2744
2745 (define-instruction int (segment number)
2746   (:declare (type (unsigned-byte 8) number))
2747   (:printer byte-imm ((op #b11001101)))
2748   (:emitter
2749    (etypecase number
2750      ((member 3)
2751       (emit-byte segment #b11001100))
2752      ((unsigned-byte 8)
2753       (emit-byte segment #b11001101)
2754       (emit-byte segment number)))))
2755
2756 (define-instruction iret (segment)
2757   (:printer byte ((op #b11001111)))
2758   (:emitter
2759    (emit-byte segment #b11001111)))
2760 \f
2761 ;;;; processor control
2762
2763 (define-instruction hlt (segment)
2764   (:printer byte ((op #b11110100)))
2765   (:emitter
2766    (emit-byte segment #b11110100)))
2767
2768 (define-instruction nop (segment)
2769   (:printer byte ((op #b10010000)))
2770   (:emitter
2771    (emit-byte segment #b10010000)))
2772
2773 (define-instruction wait (segment)
2774   (:printer byte ((op #b10011011)))
2775   (:emitter
2776    (emit-byte segment #b10011011)))
2777
2778 (define-instruction lock (segment)
2779   (:printer byte ((op #b11110000)))
2780   (:emitter
2781    (emit-byte segment #b11110000)))
2782 \f
2783 ;;;; miscellaneous hackery
2784
2785 (define-instruction byte (segment byte)
2786   (:emitter
2787    (emit-byte segment byte)))
2788
2789 (define-instruction word (segment word)
2790   (:emitter
2791    (emit-word segment word)))
2792
2793 (define-instruction dword (segment dword)
2794   (:emitter
2795    (emit-dword segment dword)))
2796
2797 (defun emit-header-data (segment type)
2798   (emit-back-patch segment
2799                    n-word-bytes
2800                    (lambda (segment posn)
2801                      (emit-qword segment
2802                                  (logior type
2803                                          (ash (+ posn
2804                                                  (component-header-length))
2805                                               (- n-widetag-bits
2806                                                  word-shift)))))))
2807
2808 (define-instruction simple-fun-header-word (segment)
2809   (:emitter
2810    (emit-header-data segment simple-fun-header-widetag)))
2811
2812 (define-instruction lra-header-word (segment)
2813   (:emitter
2814    (emit-header-data segment return-pc-header-widetag)))
2815 \f
2816 ;;;; Instructions required to do floating point operations using SSE
2817
2818 (defun emit-sse-inst (segment dst src prefix opcode &key operand-size)
2819   (when prefix
2820     (emit-byte segment prefix))
2821   (if operand-size
2822       (maybe-emit-rex-for-ea segment src dst :operand-size operand-size)
2823       (maybe-emit-rex-for-ea segment src dst))
2824   (emit-byte segment #x0f)
2825   (emit-byte segment opcode)
2826   (emit-ea segment src (reg-tn-encoding dst)))
2827
2828 ;;; Emit an SSE instruction that has an XMM register as the destination
2829 ;;; operand and for which the size of the operands is implicitly given
2830 ;;; by the instruction.
2831 (defun emit-regular-sse-inst (segment dst src prefix opcode)
2832   (aver (xmm-register-p dst))
2833   (emit-sse-inst segment dst src prefix opcode
2834                  :operand-size :do-not-set))
2835
2836 ;;; Instructions having an XMM register as the destination operand
2837 ;;; and an XMM register or a memory location as the source operand.
2838 ;;; The operand size is implicitly given by the instruction.
2839
2840 (macrolet ((define-regular-sse-inst (name prefix opcode)
2841              `(define-instruction ,name (segment dst src)
2842                 ,@(if prefix
2843                       `((:printer ext-xmm-xmm/mem
2844                                   ((prefix ,prefix) (op ,opcode)))
2845                         (:printer ext-rex-xmm-xmm/mem
2846                                   ((prefix ,prefix) (op ,opcode))))
2847                       `((:printer xmm-xmm/mem ((op ,opcode)))
2848                         (:printer rex-xmm-xmm/mem ((op ,opcode)))))
2849                 (:emitter
2850                  (emit-regular-sse-inst segment dst src ,prefix ,opcode)))))
2851   ;; logical
2852   (define-regular-sse-inst andpd    #x66 #x54)
2853   (define-regular-sse-inst andps    nil  #x54)
2854   (define-regular-sse-inst xorpd    #x66 #x57)
2855   (define-regular-sse-inst xorps    nil  #x57)
2856   ;; comparison
2857   (define-regular-sse-inst comisd   #x66 #x2f)
2858   (define-regular-sse-inst comiss   nil  #x2f)
2859   ;; arithmetic
2860   (define-regular-sse-inst addsd    #xf2 #x58)
2861   (define-regular-sse-inst addss    #xf3 #x58)
2862   (define-regular-sse-inst divsd    #xf2 #x5e)
2863   (define-regular-sse-inst divss    #xf3 #x5e)
2864   (define-regular-sse-inst mulsd    #xf2 #x59)
2865   (define-regular-sse-inst mulss    #xf3 #x59)
2866   (define-regular-sse-inst subsd    #xf2 #x5c)
2867   (define-regular-sse-inst subss    #xf3 #x5c)
2868   (define-regular-sse-inst sqrtsd   #xf2 #x51)
2869   (define-regular-sse-inst sqrtss   #xf3 #x51)
2870   ;; conversion
2871   (define-regular-sse-inst cvtsd2ss #xf2 #x5a)
2872   (define-regular-sse-inst cvtss2sd #xf3 #x5a)
2873   (define-regular-sse-inst cvtdq2pd #xf3 #xe6)
2874   (define-regular-sse-inst cvtdq2ps nil  #x5b))
2875
2876 ;;; MOVSD, MOVSS
2877 (macrolet ((define-movsd/ss-sse-inst (name prefix)
2878              `(define-instruction ,name (segment dst src)
2879                 (:printer ext-xmm-xmm/mem-dir ((prefix ,prefix)
2880                                                (op #b0001000)))
2881                 (:printer ext-rex-xmm-xmm/mem-dir ((prefix ,prefix)
2882                                                    (op #b0001000)))
2883                 (:emitter
2884                  (cond ((xmm-register-p dst)
2885                         (emit-sse-inst segment dst src ,prefix #x10
2886                                        :operand-size :do-not-set))
2887                        (t
2888                         (aver (xmm-register-p src))
2889                         (emit-sse-inst segment src dst ,prefix #x11
2890                                        :operand-size :do-not-set)))))))
2891   (define-movsd/ss-sse-inst movsd #xf2)
2892   (define-movsd/ss-sse-inst movss #xf3))
2893
2894 ;;; MOVQ
2895 (define-instruction movq (segment dst src)
2896   (:printer ext-xmm-xmm/mem ((prefix #xf3) (op #x7e)))
2897   (:printer ext-rex-xmm-xmm/mem ((prefix #xf3) (op #x7e)))
2898   (:printer ext-xmm-xmm/mem ((prefix #x66) (op #xd6))
2899             '(:name :tab reg/mem ", " reg))
2900   (:printer ext-rex-xmm-xmm/mem ((prefix #x66) (op #xd6))
2901             '(:name :tab reg/mem ", " reg))
2902   (:emitter
2903    (cond ((xmm-register-p dst)
2904           (emit-sse-inst segment dst src #xf3 #x7e
2905                          :operand-size :do-not-set))
2906          (t
2907           (aver (xmm-register-p src))
2908           (emit-sse-inst segment src dst #x66 #xd6
2909                          :operand-size :do-not-set)))))
2910
2911 ;;; Instructions having an XMM register as the destination operand
2912 ;;; and a general-purpose register or a memory location as the source
2913 ;;; operand. The operand size is calculated from the source operand.
2914
2915 ;;; MOVD - Move a 32- or 64-bit value from a general-purpose register or
2916 ;;; a memory location to the low order 32 or 64 bits of an XMM register
2917 ;;; with zero extension or vice versa.
2918 ;;; We do not support the MMX version of this instruction.
2919 (define-instruction movd (segment dst src)
2920   (:printer ext-xmm-reg/mem ((prefix #x66) (op #x6e)))
2921   (:printer ext-rex-xmm-reg/mem ((prefix #x66) (op #x6e)))
2922   (:printer ext-xmm-reg/mem ((prefix #x66) (op #x7e))
2923             '(:name :tab reg/mem ", " reg))
2924   (:printer ext-rex-xmm-reg/mem ((prefix #x66) (op #x7e))
2925             '(:name :tab reg/mem ", " reg))
2926   (:emitter
2927    (cond ((xmm-register-p dst)
2928           (emit-sse-inst segment dst src #x66 #x6e))
2929          (t
2930           (aver (xmm-register-p src))
2931           (emit-sse-inst segment src dst #x66 #x7e)))))
2932
2933 (macrolet ((define-integer-source-sse-inst (name prefix opcode)
2934              `(define-instruction ,name (segment dst src)
2935                 (:printer ext-xmm-reg/mem ((prefix ,prefix) (op ,opcode)))
2936                 (:printer ext-rex-xmm-reg/mem ((prefix ,prefix) (op ,opcode)))
2937                 (:emitter
2938                  (aver (xmm-register-p dst))
2939                  (let ((src-size (operand-size src)))
2940                    (aver (or (eq src-size :qword) (eq src-size :dword))))
2941                  (emit-sse-inst segment dst src ,prefix ,opcode)))))
2942   (define-integer-source-sse-inst cvtsi2sd #xf2 #x2a)
2943   (define-integer-source-sse-inst cvtsi2ss #xf3 #x2a))
2944
2945 ;;; Instructions having a general-purpose register as the destination
2946 ;;; operand and an XMM register or a memory location as the source
2947 ;;; operand. The operand size is calculated from the destination
2948 ;;; operand.
2949
2950 (macrolet ((define-gpr-destination-sse-inst (name prefix opcode)
2951              `(define-instruction ,name (segment dst src)
2952                 (:printer ext-reg-xmm/mem ((prefix ,prefix) (op ,opcode)))
2953                 (:printer ext-rex-reg-xmm/mem ((prefix ,prefix) (op ,opcode)))
2954                 (:emitter
2955                  (aver (register-p dst))
2956                  (let ((dst-size (operand-size dst)))
2957                    (aver (or (eq dst-size :qword) (eq dst-size :dword)))
2958                    (emit-sse-inst segment dst src ,prefix ,opcode
2959                                   :operand-size dst-size))))))
2960   (define-gpr-destination-sse-inst cvtsd2si  #xf2 #x2d)
2961   (define-gpr-destination-sse-inst cvtss2si  #xf3 #x2d)
2962   (define-gpr-destination-sse-inst cvttsd2si #xf2 #x2c)
2963   (define-gpr-destination-sse-inst cvttss2si #xf3 #x2c))
2964
2965 ;;; Other SSE instructions
2966
2967 (define-instruction ldmxcsr (segment src)
2968   (:emitter
2969    (emit-byte segment #x0f)
2970    (emit-byte segment #xae)
2971    (emit-ea segment src 2)))
2972
2973 (define-instruction stmxcsr (segment dst)
2974   (:emitter
2975    (emit-byte segment #x0f)
2976    (emit-byte segment #xae)
2977    (emit-ea segment dst 3)))