summaryrefslogtreecommitdiff
path: root/insns.h
blob: 8b725ae3cca03759ff0ea765d8f2f7e531138f71 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
/* insns.h   header file for insns.c
 *
 * The Netwide Assembler is copyright (C) 1996 Simon Tatham and
 * Julian Hall. All rights reserved. The software is
 * redistributable under the license given in the file "LICENSE"
 * distributed in the NASM archive.
 */

#ifndef NASM_INSNS_H
#define NASM_INSNS_H

#include "nasm.h"
#include "tokens.h"

/* if changed, ITEMPLATE_END should be also changed accordingly */
struct itemplate {
    enum opcode     opcode;             /* the token, passed from "parser.c" */
    int             operands;           /* number of operands */
    opflags_t       opd[MAX_OPERANDS];  /* bit flags for operand types */
    decoflags_t     deco[MAX_OPERANDS]; /* bit flags for operand decorators */
    const uint8_t   *code;              /* the code it assembles to */
    iflags_t        flags;              /* some flags */
};

/* Disassembler table structure */

/*
 * If n == -1, then p points to another table of 256
 * struct disasm_index, otherwise p points to a list of n
 * struct itemplates to consider.
 */
struct disasm_index {
    const void *p;
    int n;
};

/* Tables for the assembler and disassembler, respectively */
extern const struct itemplate * const nasm_instructions[];
extern const struct disasm_index itable[256];
extern const struct disasm_index * const itable_vex[NASM_VEX_CLASSES][32][4];

/* Common table for the byte codes */
extern const uint8_t nasm_bytecodes[];

/*
 * this define is used to signify the end of an itemplate
 */
#define ITEMPLATE_END {-1,-1,{-1,-1,-1,-1,-1},{-1,-1,-1,-1,-1},NULL,0}

/*
 * Instruction template flags. These specify which processor
 * targets the instruction is eligible for, whether it is
 * privileged or undocumented, and also specify extra error
 * checking on the matching of the instruction.
 *
 * IF_SM stands for Size Match: any operand whose size is not
 * explicitly specified by the template is `really' intended to be
 * the same size as the first size-specified operand.
 * Non-specification is tolerated in the input instruction, but
 * _wrong_ specification is not.
 *
 * IF_SM2 invokes Size Match on only the first _two_ operands, for
 * three-operand instructions such as SHLD: it implies that the
 * first two operands must match in size, but that the third is
 * required to be _unspecified_.
 *
 * IF_SB invokes Size Byte: operands with unspecified size in the
 * template are really bytes, and so no non-byte specification in
 * the input instruction will be tolerated. IF_SW similarly invokes
 * Size Word, and IF_SD invokes Size Doubleword.
 *
 * (The default state if neither IF_SM nor IF_SM2 is specified is
 * that any operand with unspecified size in the template is
 * required to have unspecified size in the instruction too...)
 *
 * iflags_t is defined to store these flags.
 */

#define IF_SM           0x00000001UL    /* size match */
#define IF_SM2          0x00000002UL    /* size match first two operands */
#define IF_SB           0x00000004UL    /* unsized operands can't be non-byte */
#define IF_SW           0x00000008UL    /* unsized operands can't be non-word */
#define IF_SD           0x0000000CUL    /* unsized operands can't be non-dword */
#define IF_SQ           0x00000010UL    /* unsized operands can't be non-qword */
#define IF_SO           0x00000014UL    /* unsized operands can't be non-oword */
#define IF_SY           0x00000018UL    /* unsized operands can't be non-yword */
#define IF_SZ           0x0000001CUL    /* unsized operands can't be non-zword */
#define IF_SIZE         0x00000038UL    /* unsized operands must match the bitsize */
#define IF_SX           0x0000003CUL    /* unsized operands not allowed */
#define IF_SMASK        0x0000003CUL    /* mask for unsized argument size */
#define IF_AR0          0x00000040UL    /* SB, SW, SD applies to argument 0 */
#define IF_AR1          0x00000080UL    /* SB, SW, SD applies to argument 1 */
#define IF_AR2          0x000000C0UL    /* SB, SW, SD applies to argument 2 */
#define IF_AR3          0x00000100UL    /* SB, SW, SD applies to argument 3 */
#define IF_AR4          0x00000140UL    /* SB, SW, SD applies to argument 4 */
#define IF_ARMASK       0x000001C0UL    /* mask for unsized argument spec */
#define IF_ARSHFT       6               /* LSB in IF_ARMASK */
#define IF_OPT          0x00000200UL    /* optimizing assembly only */
/* The next 3 bits aren't actually used for anything */
#define IF_PRIV         0x00000000UL    /* it's a privileged instruction */
#define IF_SMM          0x00000000UL    /* it's only valid in SMM */
#define IF_PROT         0x00000000UL    /* it's protected mode only */
#define IF_LOCK         0x00000400UL    /* lockable if operand 0 is memory */
#define IF_NOLONG       0x00000800UL    /* it's not available in long mode */
#define IF_LONG         0x00001000UL    /* long mode instruction */
#define IF_NOHLE	0x00002000UL    /* HLE prefixes forbidden */
#define IF_MIB		0x00004000UL    /* Disassemble with split EA */
/* These flags are currently not used for anything - intended for insn set */
#define IF_UNDOC        0x8000000000UL    /* it's an undocumented instruction */
#define IF_HLE          0x4000000000UL    /* HACK NEED TO REORGANIZE THESE BITS */
#define IF_AVX512       0x2000000000UL    /* it's an AVX-512F (512b) instruction */
#define IF_FPU          0x0100000000UL    /* it's an FPU instruction */
#define IF_MMX          0x0200000000UL    /* it's an MMX instruction */
#define IF_3DNOW        0x0300000000UL    /* it's a 3DNow! instruction */
#define IF_SSE          0x0400000000UL    /* it's a SSE (KNI, MMX2) instruction */
#define IF_SSE2         0x0500000000UL    /* it's a SSE2 instruction */
#define IF_SSE3         0x0600000000UL    /* it's a SSE3 (PNI) instruction */
#define IF_VMX          0x0700000000UL    /* it's a VMX instruction */
#define IF_SSSE3        0x0800000000UL    /* it's an SSSE3 instruction */
#define IF_SSE4A        0x0900000000UL    /* AMD SSE4a */
#define IF_SSE41        0x0A00000000UL    /* it's an SSE4.1 instruction */
#define IF_SSE42        0x0B00000000UL    /* HACK NEED TO REORGANIZE THESE BITS */
#define IF_SSE5         0x0C00000000UL    /* HACK NEED TO REORGANIZE THESE BITS */
#define IF_AVX          0x0D00000000UL    /* it's an AVX     (128b) instruction */
#define IF_AVX2         0x0E00000000UL    /* it's an AVX2    (256b) instruction */
#define IF_FMA          0x1000000000UL    /* HACK NEED TO REORGANIZE THESE BITS */
#define IF_BMI1         0x1100000000UL    /* HACK NEED TO REORGANIZE THESE BITS */
#define IF_BMI2         0x1200000000UL    /* HACK NEED TO REORGANIZE THESE BITS */
#define IF_TBM          0x1300000000UL    /* HACK NEED TO REORGANIZE THESE BITS */
#define IF_RTM          0x1400000000UL    /* HACK NEED TO REORGANIZE THESE BITS */
#define IF_INVPCID      0x1500000000UL    /* HACK NEED TO REORGANIZE THESE BITS */
#define IF_AVX512CD     (0x1600000000UL|IF_AVX512) /* AVX-512 Conflict Detection insns */
#define IF_AVX512ER     (0x1700000000UL|IF_AVX512) /* AVX-512 Exponential and Reciprocal */
#define IF_AVX512PF     (0x1800000000UL|IF_AVX512) /* AVX-512 Prefetch instructions */
#define IF_MPX          0x1900000000UL    /* MPX instructions */
#define IF_SHA          0x1A00000000UL    /* SHA instructions */
#define IF_INSMASK      0xFF00000000UL    /* the mask for instruction set types */
#define IF_PMASK        0xFF000000UL    /* the mask for processor types */
#define IF_PLEVEL       0x0F000000UL    /* the mask for processor instr. level */
                                        /* also the highest possible processor */
#define IF_8086         0x00000000UL    /* 8086 instruction */
#define IF_186          0x01000000UL    /* 186+ instruction */
#define IF_286          0x02000000UL    /* 286+ instruction */
#define IF_386          0x03000000UL    /* 386+ instruction */
#define IF_486          0x04000000UL    /* 486+ instruction */
#define IF_PENT         0x05000000UL    /* Pentium instruction */
#define IF_P6           0x06000000UL    /* P6 instruction */
#define IF_KATMAI       0x07000000UL    /* Katmai instructions */
#define IF_WILLAMETTE   0x08000000UL    /* Willamette instructions */
#define IF_PRESCOTT     0x09000000UL    /* Prescott instructions */
#define IF_X86_64       0x0A000000UL    /* x86-64 instruction (long or legacy mode) */
#define IF_NEHALEM      0x0B000000UL    /* Nehalem instruction */
#define IF_WESTMERE     0x0C000000UL    /* Westmere instruction */
#define IF_SANDYBRIDGE  0x0D000000UL    /* Sandy Bridge instruction */
#define IF_FUTURE       0x0E000000UL    /* Future processor (not yet disclosed) */
#define IF_X64          (IF_LONG|IF_X86_64)
#define IF_IA64         0x0F000000UL    /* IA64 instructions (in x86 mode) */
#define IF_CYRIX        0x10000000UL    /* Cyrix-specific instruction */
#define IF_AMD          0x20000000UL    /* AMD-specific instruction */
#define IF_SPMASK       0x30000000UL    /* specific processor types mask */
#define IF_PFMASK       (IF_INSMASK|IF_SPMASK) /* disassembly "prefer" mask */

#endif /* NASM_INSNS_H */