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