src/compiler/x86-64/insts.lisp

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