[mirror_ubuntu-focal-kernel.git] / tools / objtool / arch / x86 / insn / inat.h

#ifndef _ASM_X86_INAT_H
#define _ASM_X86_INAT_H
/*
 * x86 instruction attributes
 *
 * Written by Masami Hiramatsu <mhiramat@redhat.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 */
#include "inat_types.h"

/*
 * Internal bits. Don't use bitmasks directly, because these bits are
 * unstable. You should use checking functions.
 */

#define INAT_OPCODE_TABLE_SIZE 256
#define INAT_GROUP_TABLE_SIZE 8

/* Legacy last prefixes */
#define INAT_PFX_OPNDSZ	1	/* 0x66 */ /* LPFX1 */
#define INAT_PFX_REPE	2	/* 0xF3 */ /* LPFX2 */
#define INAT_PFX_REPNE	3	/* 0xF2 */ /* LPFX3 */
/* Other Legacy prefixes */
#define INAT_PFX_LOCK	4	/* 0xF0 */
#define INAT_PFX_CS	5	/* 0x2E */
#define INAT_PFX_DS	6	/* 0x3E */
#define INAT_PFX_ES	7	/* 0x26 */
#define INAT_PFX_FS	8	/* 0x64 */
#define INAT_PFX_GS	9	/* 0x65 */
#define INAT_PFX_SS	10	/* 0x36 */
#define INAT_PFX_ADDRSZ	11	/* 0x67 */
/* x86-64 REX prefix */
#define INAT_PFX_REX	12	/* 0x4X */
/* AVX VEX prefixes */
#define INAT_PFX_VEX2	13	/* 2-bytes VEX prefix */
#define INAT_PFX_VEX3	14	/* 3-bytes VEX prefix */

#define INAT_LSTPFX_MAX	3
#define INAT_LGCPFX_MAX	11

/* Immediate size */
#define INAT_IMM_BYTE		1
#define INAT_IMM_WORD		2
#define INAT_IMM_DWORD		3
#define INAT_IMM_QWORD		4
#define INAT_IMM_PTR		5
#define INAT_IMM_VWORD32	6
#define INAT_IMM_VWORD		7

/* Legacy prefix */
#define INAT_PFX_OFFS	0
#define INAT_PFX_BITS	4
#define INAT_PFX_MAX    ((1 << INAT_PFX_BITS) - 1)
#define INAT_PFX_MASK	(INAT_PFX_MAX << INAT_PFX_OFFS)
/* Escape opcodes */
#define INAT_ESC_OFFS	(INAT_PFX_OFFS + INAT_PFX_BITS)
#define INAT_ESC_BITS	2
#define INAT_ESC_MAX	((1 << INAT_ESC_BITS) - 1)
#define INAT_ESC_MASK	(INAT_ESC_MAX << INAT_ESC_OFFS)
/* Group opcodes (1-16) */
#define INAT_GRP_OFFS	(INAT_ESC_OFFS + INAT_ESC_BITS)
#define INAT_GRP_BITS	5
#define INAT_GRP_MAX	((1 << INAT_GRP_BITS) - 1)
#define INAT_GRP_MASK	(INAT_GRP_MAX << INAT_GRP_OFFS)
/* Immediates */
#define INAT_IMM_OFFS	(INAT_GRP_OFFS + INAT_GRP_BITS)
#define INAT_IMM_BITS	3
#define INAT_IMM_MASK	(((1 << INAT_IMM_BITS) - 1) << INAT_IMM_OFFS)
/* Flags */
#define INAT_FLAG_OFFS	(INAT_IMM_OFFS + INAT_IMM_BITS)
#define INAT_MODRM	(1 << (INAT_FLAG_OFFS))
#define INAT_FORCE64	(1 << (INAT_FLAG_OFFS + 1))
#define INAT_SCNDIMM	(1 << (INAT_FLAG_OFFS + 2))
#define INAT_MOFFSET	(1 << (INAT_FLAG_OFFS + 3))
#define INAT_VARIANT	(1 << (INAT_FLAG_OFFS + 4))
#define INAT_VEXOK	(1 << (INAT_FLAG_OFFS + 5))
#define INAT_VEXONLY	(1 << (INAT_FLAG_OFFS + 6))
/* Attribute making macros for attribute tables */
#define INAT_MAKE_PREFIX(pfx)	(pfx << INAT_PFX_OFFS)
#define INAT_MAKE_ESCAPE(esc)	(esc << INAT_ESC_OFFS)
#define INAT_MAKE_GROUP(grp)	((grp << INAT_GRP_OFFS) | INAT_MODRM)
#define INAT_MAKE_IMM(imm)	(imm << INAT_IMM_OFFS)

/* Attribute search APIs */
extern insn_attr_t inat_get_opcode_attribute(insn_byte_t opcode);
extern int inat_get_last_prefix_id(insn_byte_t last_pfx);
extern insn_attr_t inat_get_escape_attribute(insn_byte_t opcode,
					     int lpfx_id,
					     insn_attr_t esc_attr);
extern insn_attr_t inat_get_group_attribute(insn_byte_t modrm,
					    int lpfx_id,
					    insn_attr_t esc_attr);
extern insn_attr_t inat_get_avx_attribute(insn_byte_t opcode,
					  insn_byte_t vex_m,
					  insn_byte_t vex_pp);

/* Attribute checking functions */
static inline int inat_is_legacy_prefix(insn_attr_t attr)
{
	attr &= INAT_PFX_MASK;
	return attr && attr <= INAT_LGCPFX_MAX;
}

static inline int inat_is_address_size_prefix(insn_attr_t attr)
{
	return (attr & INAT_PFX_MASK) == INAT_PFX_ADDRSZ;
}

static inline int inat_is_operand_size_prefix(insn_attr_t attr)
{
	return (attr & INAT_PFX_MASK) == INAT_PFX_OPNDSZ;
}

static inline int inat_is_rex_prefix(insn_attr_t attr)
{
	return (attr & INAT_PFX_MASK) == INAT_PFX_REX;
}

static inline int inat_last_prefix_id(insn_attr_t attr)
{
	if ((attr & INAT_PFX_MASK) > INAT_LSTPFX_MAX)
		return 0;
	else
		return attr & INAT_PFX_MASK;
}

static inline int inat_is_vex_prefix(insn_attr_t attr)
{
	attr &= INAT_PFX_MASK;
	return attr == INAT_PFX_VEX2 || attr == INAT_PFX_VEX3;
}

static inline int inat_is_vex3_prefix(insn_attr_t attr)
{
	return (attr & INAT_PFX_MASK) == INAT_PFX_VEX3;
}

static inline int inat_is_escape(insn_attr_t attr)
{
	return attr & INAT_ESC_MASK;
}

static inline int inat_escape_id(insn_attr_t attr)
{
	return (attr & INAT_ESC_MASK) >> INAT_ESC_OFFS;
}

static inline int inat_is_group(insn_attr_t attr)
{
	return attr & INAT_GRP_MASK;
}

static inline int inat_group_id(insn_attr_t attr)
{
	return (attr & INAT_GRP_MASK) >> INAT_GRP_OFFS;
}

static inline int inat_group_common_attribute(insn_attr_t attr)
{
	return attr & ~INAT_GRP_MASK;
}

static inline int inat_has_immediate(insn_attr_t attr)
{
	return attr & INAT_IMM_MASK;
}

static inline int inat_immediate_size(insn_attr_t attr)
{
	return (attr & INAT_IMM_MASK) >> INAT_IMM_OFFS;
}

static inline int inat_has_modrm(insn_attr_t attr)
{
	return attr & INAT_MODRM;
}

static inline int inat_is_force64(insn_attr_t attr)
{
	return attr & INAT_FORCE64;
}

static inline int inat_has_second_immediate(insn_attr_t attr)
{
	return attr & INAT_SCNDIMM;
}

static inline int inat_has_moffset(insn_attr_t attr)
{
	return attr & INAT_MOFFSET;
}

static inline int inat_has_variant(insn_attr_t attr)
{
	return attr & INAT_VARIANT;
}

static inline int inat_accept_vex(insn_attr_t attr)
{
	return attr & INAT_VEXOK;
}

static inline int inat_must_vex(insn_attr_t attr)
{
	return attr & INAT_VEXONLY;
}
#endif
Commit	Line	Data
442f04c3 JP	1	#ifndef _ASM_X86_INAT_H
	2	#define _ASM_X86_INAT_H
	3	/*
	4	* x86 instruction attributes
	5	*
	6	* Written by Masami Hiramatsu <mhiramat@redhat.com>
	7	*
	8	* This program is free software; you can redistribute it and/or modify
	9	* it under the terms of the GNU General Public License as published by
	10	* the Free Software Foundation; either version 2 of the License, or
	11	* (at your option) any later version.
	12	*
	13	* This program is distributed in the hope that it will be useful,
	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	* GNU General Public License for more details.
	17	*
	18	* You should have received a copy of the GNU General Public License
	19	* along with this program; if not, write to the Free Software
	20	* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	21	*
	22	*/
	23	#include "inat_types.h"
	24
	25	/*
	26	* Internal bits. Don't use bitmasks directly, because these bits are
	27	* unstable. You should use checking functions.
	28	*/
	29
	30	#define INAT_OPCODE_TABLE_SIZE 256
	31	#define INAT_GROUP_TABLE_SIZE 8
	32
	33	/* Legacy last prefixes */
	34	#define INAT_PFX_OPNDSZ 1 /* 0x66 / / LPFX1 */
	35	#define INAT_PFX_REPE 2 /* 0xF3 / / LPFX2 */
	36	#define INAT_PFX_REPNE 3 /* 0xF2 / / LPFX3 */
	37	/* Other Legacy prefixes */
	38	#define INAT_PFX_LOCK 4 /* 0xF0 */
	39	#define INAT_PFX_CS 5 /* 0x2E */
	40	#define INAT_PFX_DS 6 /* 0x3E */
	41	#define INAT_PFX_ES 7 /* 0x26 */
	42	#define INAT_PFX_FS 8 /* 0x64 */
	43	#define INAT_PFX_GS 9 /* 0x65 */
	44	#define INAT_PFX_SS 10 /* 0x36 */
	45	#define INAT_PFX_ADDRSZ 11 /* 0x67 */
	46	/* x86-64 REX prefix */
	47	#define INAT_PFX_REX 12 /* 0x4X */
	48	/* AVX VEX prefixes */
	49	#define INAT_PFX_VEX2 13 /* 2-bytes VEX prefix */
	50	#define INAT_PFX_VEX3 14 /* 3-bytes VEX prefix */
	51
	52	#define INAT_LSTPFX_MAX 3
	53	#define INAT_LGCPFX_MAX 11
	54
	55	/* Immediate size */
	56	#define INAT_IMM_BYTE 1
	57	#define INAT_IMM_WORD 2
	58	#define INAT_IMM_DWORD 3
	59	#define INAT_IMM_QWORD 4
	60	#define INAT_IMM_PTR 5
	61	#define INAT_IMM_VWORD32 6
	62	#define INAT_IMM_VWORD 7
	63
	64	/* Legacy prefix */
65	#define INAT_PFX_OFFS 0
66	#define INAT_PFX_BITS 4
67	#define INAT_PFX_MAX ((1 << INAT_PFX_BITS) - 1)
68	#define INAT_PFX_MASK (INAT_PFX_MAX << INAT_PFX_OFFS)
69	/* Escape opcodes */
70	#define INAT_ESC_OFFS (INAT_PFX_OFFS + INAT_PFX_BITS)
71	#define INAT_ESC_BITS 2
72	#define INAT_ESC_MAX ((1 << INAT_ESC_BITS) - 1)
73	#define INAT_ESC_MASK (INAT_ESC_MAX << INAT_ESC_OFFS)
74	/* Group opcodes (1-16) */
75	#define INAT_GRP_OFFS (INAT_ESC_OFFS + INAT_ESC_BITS)
76	#define INAT_GRP_BITS 5
77	#define INAT_GRP_MAX ((1 << INAT_GRP_BITS) - 1)
78	#define INAT_GRP_MASK (INAT_GRP_MAX << INAT_GRP_OFFS)
79	/* Immediates */
80	#define INAT_IMM_OFFS (INAT_GRP_OFFS + INAT_GRP_BITS)
81	#define INAT_IMM_BITS 3
82	#define INAT_IMM_MASK (((1 << INAT_IMM_BITS) - 1) << INAT_IMM_OFFS)
83	/* Flags */
84	#define INAT_FLAG_OFFS (INAT_IMM_OFFS + INAT_IMM_BITS)
85	#define INAT_MODRM (1 << (INAT_FLAG_OFFS))
86	#define INAT_FORCE64 (1 << (INAT_FLAG_OFFS + 1))
87	#define INAT_SCNDIMM (1 << (INAT_FLAG_OFFS + 2))
88	#define INAT_MOFFSET (1 << (INAT_FLAG_OFFS + 3))
89	#define INAT_VARIANT (1 << (INAT_FLAG_OFFS + 4))
90	#define INAT_VEXOK (1 << (INAT_FLAG_OFFS + 5))
91	#define INAT_VEXONLY (1 << (INAT_FLAG_OFFS + 6))
92	/* Attribute making macros for attribute tables */
93	#define INAT_MAKE_PREFIX(pfx) (pfx << INAT_PFX_OFFS)
94	#define INAT_MAKE_ESCAPE(esc) (esc << INAT_ESC_OFFS)
95	#define INAT_MAKE_GROUP(grp) ((grp << INAT_GRP_OFFS) \| INAT_MODRM)
96	#define INAT_MAKE_IMM(imm) (imm << INAT_IMM_OFFS)
97
98	/* Attribute search APIs */
99	extern insn_attr_t inat_get_opcode_attribute(insn_byte_t opcode);
100	extern int inat_get_last_prefix_id(insn_byte_t last_pfx);
101	extern insn_attr_t inat_get_escape_attribute(insn_byte_t opcode,
102	int lpfx_id,
103	insn_attr_t esc_attr);
104	extern insn_attr_t inat_get_group_attribute(insn_byte_t modrm,
105	int lpfx_id,
106	insn_attr_t esc_attr);
107	extern insn_attr_t inat_get_avx_attribute(insn_byte_t opcode,
108	insn_byte_t vex_m,
109	insn_byte_t vex_pp);
110
111	/* Attribute checking functions */
112	static inline int inat_is_legacy_prefix(insn_attr_t attr)
113	{
114	attr &= INAT_PFX_MASK;
115	return attr && attr <= INAT_LGCPFX_MAX;
116	}
117
118	static inline int inat_is_address_size_prefix(insn_attr_t attr)
119	{
120	return (attr & INAT_PFX_MASK) == INAT_PFX_ADDRSZ;
121	}
122
123	static inline int inat_is_operand_size_prefix(insn_attr_t attr)
124	{
125	return (attr & INAT_PFX_MASK) == INAT_PFX_OPNDSZ;
126	}
127
128	static inline int inat_is_rex_prefix(insn_attr_t attr)
129	{
130	return (attr & INAT_PFX_MASK) == INAT_PFX_REX;
131	}
132
133	static inline int inat_last_prefix_id(insn_attr_t attr)
134	{
135	if ((attr & INAT_PFX_MASK) > INAT_LSTPFX_MAX)
136	return 0;
137	else
138	return attr & INAT_PFX_MASK;
139	}
140
141	static inline int inat_is_vex_prefix(insn_attr_t attr)
142	{
143	attr &= INAT_PFX_MASK;
144	return attr == INAT_PFX_VEX2 \|\| attr == INAT_PFX_VEX3;
145	}
146
147	static inline int inat_is_vex3_prefix(insn_attr_t attr)
148	{
149	return (attr & INAT_PFX_MASK) == INAT_PFX_VEX3;
150	}
151
152	static inline int inat_is_escape(insn_attr_t attr)
153	{
154	return attr & INAT_ESC_MASK;
155	}
156
157	static inline int inat_escape_id(insn_attr_t attr)
158	{
159	return (attr & INAT_ESC_MASK) >> INAT_ESC_OFFS;
160	}
161
162	static inline int inat_is_group(insn_attr_t attr)
163	{
164	return attr & INAT_GRP_MASK;
165	}
166
167	static inline int inat_group_id(insn_attr_t attr)
168	{
169	return (attr & INAT_GRP_MASK) >> INAT_GRP_OFFS;
170	}
171
172	static inline int inat_group_common_attribute(insn_attr_t attr)
173	{
174	return attr & ~INAT_GRP_MASK;
175	}
176
177	static inline int inat_has_immediate(insn_attr_t attr)
178	{
179	return attr & INAT_IMM_MASK;
180	}
181
182	static inline int inat_immediate_size(insn_attr_t attr)
183	{
184	return (attr & INAT_IMM_MASK) >> INAT_IMM_OFFS;
185	}
186
187	static inline int inat_has_modrm(insn_attr_t attr)
188	{
189	return attr & INAT_MODRM;
190	}
191
192	static inline int inat_is_force64(insn_attr_t attr)
193	{
194	return attr & INAT_FORCE64;
195	}
196
197	static inline int inat_has_second_immediate(insn_attr_t attr)
198	{
199	return attr & INAT_SCNDIMM;
200	}
201
202	static inline int inat_has_moffset(insn_attr_t attr)
203	{
204	return attr & INAT_MOFFSET;
205	}
206
207	static inline int inat_has_variant(insn_attr_t attr)
208	{
209	return attr & INAT_VARIANT;
210	}
211
212	static inline int inat_accept_vex(insn_attr_t attr)
213	{
214	return attr & INAT_VEXOK;
215	}
216
217	static inline int inat_must_vex(insn_attr_t attr)
218	{
219	return attr & INAT_VEXONLY;
220	}
221	#endif