src/compiler/x86-64/insts.lisp

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