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