src/compiler/x86-64/insts.lisp

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