src/compiler/x86-64/insts.lisp

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