insns.h

   1 /* insns.h   header file for insns.c
   2  *
   3  * The Netwide Assembler is copyright (C) 1996 Simon Tatham and
   4  * Julian Hall. All rights reserved. The software is
   5  * redistributable under the license given in the file "LICENSE"
   6  * distributed in the NASM archive.
   7  */
   8
   9 #ifndef NASM_INSNS_H
  10 #define NASM_INSNS_H
  11
  12 #include "nasm.h"
  13 #include "tokens.h"
  14
  15 /* if changed, ITEMPLATE_END should be also changed accordingly */
  16 struct itemplate {
  17     enum opcode     opcode;             /* the token, passed from "parser.c" */
  18     int             operands;           /* number of operands */
  19     opflags_t       opd[MAX_OPERANDS];  /* bit flags for operand types */
  20     decoflags_t     deco[MAX_OPERANDS]; /* bit flags for operand decorators */
  21     const uint8_t   *code;              /* the code it assembles to */
  22     iflags_t        flags;              /* some flags */
  23 };
  24
  25 /* Disassembler table structure */
  26
  27 /*
  28  * If n == -1, then p points to another table of 256
  29  * struct disasm_index, otherwise p points to a list of n
  30  * struct itemplates to consider.
  31  */
  32 struct disasm_index {
  33     const void *p;
  34     int n;
  35 };
  36
  37 /* Tables for the assembler and disassembler, respectively */
  38 extern const struct itemplate * const nasm_instructions[];
  39 extern const struct disasm_index itable[256];
  40 extern const struct disasm_index * const itable_vex[NASM_VEX_CLASSES][32][4];
  41
  42 /* Common table for the byte codes */
  43 extern const uint8_t nasm_bytecodes[];
  44
  45 /*
  46  * this define is used to signify the end of an itemplate
  47  */
  48 #define ITEMPLATE_END {-1,-1,{-1,-1,-1,-1,-1},{-1,-1,-1,-1,-1},NULL,0}
  49
  50 /*
  51  * Instruction template flags. These specify which processor
  52  * targets the instruction is eligible for, whether it is
  53  * privileged or undocumented, and also specify extra error
  54  * checking on the matching of the instruction.
  55  *
  56  * IF_SM stands for Size Match: any operand whose size is not
  57  * explicitly specified by the template is `really' intended to be
  58  * the same size as the first size-specified operand.
  59  * Non-specification is tolerated in the input instruction, but
  60  * _wrong_ specification is not.
  61  *
  62  * IF_SM2 invokes Size Match on only the first _two_ operands, for
  63  * three-operand instructions such as SHLD: it implies that the
  64  * first two operands must match in size, but that the third is
  65  * required to be _unspecified_.
  66  *
  67  * IF_SB invokes Size Byte: operands with unspecified size in the
  68  * template are really bytes, and so no non-byte specification in
  69  * the input instruction will be tolerated. IF_SW similarly invokes
  70  * Size Word, and IF_SD invokes Size Doubleword.
  71  *
  72  * (The default state if neither IF_SM nor IF_SM2 is specified is
  73  * that any operand with unspecified size in the template is
  74  * required to have unspecified size in the instruction too...)
  75  *
  76  * iflags_t is defined to store these flags.
  77  */
  78
  79 #define IF_SM           UINT64_C(0x00000001)    /* size match */
  80 #define IF_SM2          UINT64_C(0x00000002)    /* size match first two operands */
  81 #define IF_SB           UINT64_C(0x00000004)    /* unsized operands can't be non-byte */
  82 #define IF_SW           UINT64_C(0x00000008)    /* unsized operands can't be non-word */
  83 #define IF_SD           UINT64_C(0x0000000C)    /* unsized operands can't be non-dword */
  84 #define IF_SQ           UINT64_C(0x00000010)    /* unsized operands can't be non-qword */
  85 #define IF_SO           UINT64_C(0x00000014)    /* unsized operands can't be non-oword */
  86 #define IF_SY           UINT64_C(0x00000018)    /* unsized operands can't be non-yword */
  87 #define IF_SZ           UINT64_C(0x0000001C)    /* unsized operands can't be non-zword */
  88 #define IF_SIZE         UINT64_C(0x00000038)    /* unsized operands must match the bitsize */
  89 #define IF_SX           UINT64_C(0x0000003C)    /* unsized operands not allowed */
  90 #define IF_SMASK        UINT64_C(0x0000003C)    /* mask for unsized argument size */
  91 #define IF_AR0          UINT64_C(0x00000040)    /* SB, SW, SD applies to argument 0 */
  92 #define IF_AR1          UINT64_C(0x00000080)    /* SB, SW, SD applies to argument 1 */
  93 #define IF_AR2          UINT64_C(0x000000C0)    /* SB, SW, SD applies to argument 2 */
  94 #define IF_AR3          UINT64_C(0x00000100)    /* SB, SW, SD applies to argument 3 */
  95 #define IF_AR4          UINT64_C(0x00000140)    /* SB, SW, SD applies to argument 4 */
  96 #define IF_ARMASK       UINT64_C(0x000001C0)    /* mask for unsized argument spec */
  97 #define IF_ARSHFT       6                         /* LSB in IF_ARMASK */
  98 #define IF_OPT          UINT64_C(0x00000200)    /* optimizing assembly only */
  99 /* The next 3 bits aren't actually used for anything */
 100 #define IF_PRIV         UINT64_C(0x00000000)    /* it's a privileged instruction */
 101 #define IF_SMM          UINT64_C(0x00000000)    /* it's only valid in SMM */
 102 #define IF_PROT         UINT64_C(0x00000000)    /* it's protected mode only */
 103 #define IF_LOCK         UINT64_C(0x00000400)    /* lockable if operand 0 is memory */
 104 #define IF_NOLONG       UINT64_C(0x00000800)    /* it's not available in long mode */
 105 #define IF_LONG         UINT64_C(0x00001000)    /* long mode instruction */
 106 #define IF_NOHLE        UINT64_C(0x00002000)    /* HLE prefixes forbidden */
 107 #define IF_MIB          UINT64_C(0x00004000)    /* Disassemble with split EA */
 108 #define IF_BND          UINT64_C(0x00008000)    /* BND (0xF2) prefix available */
 109 /* These flags are currently not used for anything - intended for insn set */
 110 #define IF_UNDOC        UINT64_C(0x8000000000)    /* it's an undocumented instruction */
 111 #define IF_HLE          UINT64_C(0x4000000000)    /* HACK NEED TO REORGANIZE THESE BITS */
 112 #define IF_AVX512       UINT64_C(0x2000000000)    /* it's an AVX-512F (512b) instruction */
 113 #define IF_FPU          UINT64_C(0x0100000000)    /* it's an FPU instruction */
 114 #define IF_MMX          UINT64_C(0x0200000000)    /* it's an MMX instruction */
 115 #define IF_3DNOW        UINT64_C(0x0300000000)    /* it's a 3DNow! instruction */
 116 #define IF_SSE          UINT64_C(0x0400000000)    /* it's a SSE (KNI, MMX2) instruction */
 117 #define IF_SSE2         UINT64_C(0x0500000000)    /* it's a SSE2 instruction */
 118 #define IF_SSE3         UINT64_C(0x0600000000)    /* it's a SSE3 (PNI) instruction */
 119 #define IF_VMX          UINT64_C(0x0700000000)    /* it's a VMX instruction */
 120 #define IF_SSSE3        UINT64_C(0x0800000000)    /* it's an SSSE3 instruction */
 121 #define IF_SSE4A        UINT64_C(0x0900000000)    /* AMD SSE4a */
 122 #define IF_SSE41        UINT64_C(0x0A00000000)    /* it's an SSE4.1 instruction */
 123 #define IF_SSE42        UINT64_C(0x0B00000000)    /* HACK NEED TO REORGANIZE THESE BITS */
 124 #define IF_SSE5         UINT64_C(0x0C00000000)    /* HACK NEED TO REORGANIZE THESE BITS */
 125 #define IF_AVX          UINT64_C(0x0D00000000)    /* it's an AVX     (128b) instruction */
 126 #define IF_AVX2         UINT64_C(0x0E00000000)    /* it's an AVX2    (256b) instruction */
 127 #define IF_FMA          UINT64_C(0x1000000000)    /* HACK NEED TO REORGANIZE THESE BITS */
 128 #define IF_BMI1         UINT64_C(0x1100000000)    /* HACK NEED TO REORGANIZE THESE BITS */
 129 #define IF_BMI2         UINT64_C(0x1200000000)    /* HACK NEED TO REORGANIZE THESE BITS */
 130 #define IF_TBM          UINT64_C(0x1300000000)    /* HACK NEED TO REORGANIZE THESE BITS */
 131 #define IF_RTM          UINT64_C(0x1400000000)    /* HACK NEED TO REORGANIZE THESE BITS */
 132 #define IF_INVPCID      UINT64_C(0x1500000000)    /* HACK NEED TO REORGANIZE THESE BITS */
 133 #define IF_AVX512CD     (UINT64_C(0x1600000000)|IF_AVX512) /* AVX-512 Conflict Detection insns */
 134 #define IF_AVX512ER     (UINT64_C(0x1700000000)|IF_AVX512) /* AVX-512 Exponential and Reciprocal */
 135 #define IF_AVX512PF     (UINT64_C(0x1800000000)|IF_AVX512) /* AVX-512 Prefetch instructions */
 136 #define IF_MPX          UINT64_C(0x1900000000)    /* MPX instructions */
 137 #define IF_SHA          UINT64_C(0x1A00000000)    /* SHA instructions */
 138 #define IF_PREFETCHWT1  UINT64_C(0x1F00000000)    /* PREFETCHWT1 instructions */
 139 #define IF_INSMASK      UINT64_C(0xFF00000000)    /* the mask for instruction set types */
 140 #define IF_PMASK        UINT64_C(0xFF000000)    /* the mask for processor types */
 141 #define IF_PLEVEL       UINT64_C(0x0F000000)    /* the mask for processor instr. level */
 142                                                   /* also the highest possible processor */
 143 #define IF_8086         UINT64_C(0x00000000)    /* 8086 instruction */
 144 #define IF_186          UINT64_C(0x01000000)    /* 186+ instruction */
 145 #define IF_286          UINT64_C(0x02000000)    /* 286+ instruction */
 146 #define IF_386          UINT64_C(0x03000000)    /* 386+ instruction */
 147 #define IF_486          UINT64_C(0x04000000)    /* 486+ instruction */
 148 #define IF_PENT         UINT64_C(0x05000000)    /* Pentium instruction */
 149 #define IF_P6           UINT64_C(0x06000000)    /* P6 instruction */
 150 #define IF_KATMAI       UINT64_C(0x07000000)    /* Katmai instructions */
 151 #define IF_WILLAMETTE   UINT64_C(0x08000000)    /* Willamette instructions */
 152 #define IF_PRESCOTT     UINT64_C(0x09000000)    /* Prescott instructions */
 153 #define IF_X86_64       UINT64_C(0x0A000000)    /* x86-64 instruction (long or legacy mode) */
 154 #define IF_NEHALEM      UINT64_C(0x0B000000)    /* Nehalem instruction */
 155 #define IF_WESTMERE     UINT64_C(0x0C000000)    /* Westmere instruction */
 156 #define IF_SANDYBRIDGE  UINT64_C(0x0D000000)    /* Sandy Bridge instruction */
 157 #define IF_FUTURE       UINT64_C(0x0E000000)    /* Future processor (not yet disclosed) */
 158 #define IF_X64          (IF_LONG|IF_X86_64)
 159 #define IF_IA64         UINT64_C(0x0F000000)    /* IA64 instructions (in x86 mode) */
 160 #define IF_CYRIX        UINT64_C(0x10000000)    /* Cyrix-specific instruction */
 161 #define IF_AMD          UINT64_C(0x20000000)    /* AMD-specific instruction */
 162 #define IF_SPMASK       UINT64_C(0x30000000)    /* specific processor types mask */
 163 #define IF_PFMASK       (IF_INSMASK|IF_SPMASK) /* disassembly "prefer" mask */
 164
 165 #endif /* NASM_INSNS_H */