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