src/compiler/x86-64/insts.lisp

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