x86: Instruction decoder API

#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 <asm/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 instruction prefixes */

#define INAT_PFX_OPNDSZ	1	/* 0x66 */ /* LPFX1 */

#define INAT_PFX_REPNE	2	/* 0xF2 */ /* LPFX2 */

#define INAT_PFX_REPE	3	/* 0xF3 */ /* LPFX3 */

#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 */

#define INAT_LPREFIX_MAX	3

/* 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_REXPFX	(1 << INAT_FLAG_OFFS)

#define INAT_MODRM	(1 << (INAT_FLAG_OFFS + 1))

#define INAT_FORCE64	(1 << (INAT_FLAG_OFFS + 2))

#define INAT_SCNDIMM	(1 << (INAT_FLAG_OFFS + 3))

#define INAT_MOFFSET	(1 << (INAT_FLAG_OFFS + 4))

#define INAT_VARIANT	(1 << (INAT_FLAG_OFFS + 5))

/* 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 insn_attr_t inat_get_escape_attribute(insn_byte_t opcode,

					     insn_byte_t last_pfx,

					     insn_attr_t esc_attr);

extern insn_attr_t inat_get_group_attribute(insn_byte_t modrm,

					    insn_byte_t last_pfx,

					    insn_attr_t esc_attr);

/* Attribute checking functions */

static inline int inat_is_prefix(insn_attr_t attr)

{

	return attr & INAT_PFX_MASK;

}

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_last_prefix_id(insn_attr_t attr)

{

	if ((attr & INAT_PFX_MASK) > INAT_LPREFIX_MAX)

		return 0;

	else

		return attr & INAT_PFX_MASK;

}

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_is_rex_prefix(insn_attr_t attr)

{

	return attr & INAT_REXPFX;

}

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;

}

#endif

#ifndef _ASM_X86_INAT_TYPES_H

#define _ASM_X86_INAT_TYPES_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.

 *

 */

/* Instruction attributes */

typedef unsigned int insn_attr_t;

typedef unsigned char insn_byte_t;

typedef signed int insn_value_t;

#endif

#ifndef _ASM_X86_INSN_H

#define _ASM_X86_INSN_H

/*

 * x86 instruction analysis

 *

 * 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.

 *

 * Copyright (C) IBM Corporation, 2009

 */

/* insn_attr_t is defined in inat.h */

#include <asm/inat.h>

struct insn_field {

	union {

		insn_value_t value;

		insn_byte_t bytes[4];

	};

	/* !0 if we've run insn_get_xxx() for this field */

	unsigned char got;

	unsigned char nbytes;

};

struct insn {

	struct insn_field prefixes;	/*

					 * Prefixes

					 * prefixes.bytes[3]: last prefix

					 */

	struct insn_field rex_prefix;	/* REX prefix */

	struct insn_field opcode;	/*

					 * opcode.bytes[0]: opcode1

					 * opcode.bytes[1]: opcode2

					 * opcode.bytes[2]: opcode3

					 */

	struct insn_field modrm;

	struct insn_field sib;

	struct insn_field displacement;

	union {

		struct insn_field immediate;

		struct insn_field moffset1;	/* for 64bit MOV */

		struct insn_field immediate1;	/* for 64bit imm or off16/32 */

	};

	union {

		struct insn_field moffset2;	/* for 64bit MOV */

		struct insn_field immediate2;	/* for 64bit imm or seg16 */

	};

	insn_attr_t attr;

	unsigned char opnd_bytes;

	unsigned char addr_bytes;

	unsigned char length;

	unsigned char x86_64;

	const insn_byte_t *kaddr;	/* kernel address of insn to analyze */

	const insn_byte_t *next_byte;

};

#define X86_MODRM_MOD(modrm) (((modrm) & 0xc0) >> 6)

#define X86_MODRM_REG(modrm) (((modrm) & 0x38) >> 3)

#define X86_MODRM_RM(modrm) ((modrm) & 0x07)

#define X86_SIB_SCALE(sib) (((sib) & 0xc0) >> 6)

#define X86_SIB_INDEX(sib) (((sib) & 0x38) >> 3)

#define X86_SIB_BASE(sib) ((sib) & 0x07)

#define X86_REX_W(rex) ((rex) & 8)

#define X86_REX_R(rex) ((rex) & 4)

#define X86_REX_X(rex) ((rex) & 2)

#define X86_REX_B(rex) ((rex) & 1)

/* The last prefix is needed for two-byte and three-byte opcodes */

static inline insn_byte_t insn_last_prefix(struct insn *insn)

{

	return insn->prefixes.bytes[3];

}

extern void insn_init(struct insn *insn, const void *kaddr, int x86_64);

extern void insn_get_prefixes(struct insn *insn);

extern void insn_get_opcode(struct insn *insn);

extern void insn_get_modrm(struct insn *insn);

extern void insn_get_sib(struct insn *insn);

extern void insn_get_displacement(struct insn *insn);

extern void insn_get_immediate(struct insn *insn);

extern void insn_get_length(struct insn *insn);

/* Attribute will be determined after getting ModRM (for opcode groups) */

static inline void insn_get_attribute(struct insn *insn)

{

	insn_get_modrm(insn);

}

/* Instruction uses RIP-relative addressing */

extern int insn_rip_relative(struct insn *insn);

/* Init insn for kernel text */

static inline void kernel_insn_init(struct insn *insn, const void *kaddr)

{

#ifdef CONFIG_X86_64

	insn_init(insn, kaddr, 1);

#else /* CONFIG_X86_32 */

	insn_init(insn, kaddr, 0);

#endif

}

/* Offset of each field from kaddr */

static inline int insn_offset_rex_prefix(struct insn *insn)

{

	return insn->prefixes.nbytes;

}

static inline int insn_offset_opcode(struct insn *insn)

{

	return insn_offset_rex_prefix(insn) + insn->rex_prefix.nbytes;

}

static inline int insn_offset_modrm(struct insn *insn)

{

	return insn_offset_opcode(insn) + insn->opcode.nbytes;

}

static inline int insn_offset_sib(struct insn *insn)

{

	return insn_offset_modrm(insn) + insn->modrm.nbytes;

}

static inline int insn_offset_displacement(struct insn *insn)

{

	return insn_offset_sib(insn) + insn->sib.nbytes;

}

static inline int insn_offset_immediate(struct insn *insn)

{

	return insn_offset_displacement(insn) + insn->displacement.nbytes;

}

#endif /* _ASM_X86_INSN_H */

# Makefile for x86 specific library files.

#

inat_tables_script = $(srctree)/arch/x86/tools/gen-insn-attr-x86.awk

inat_tables_maps = $(srctree)/arch/x86/lib/x86-opcode-map.txt

quiet_cmd_inat_tables = GEN     $@

      cmd_inat_tables = $(AWK) -f $(inat_tables_script) $(inat_tables_maps) > $@

$(obj)/inat-tables.c: $(inat_tables_script) $(inat_tables_maps)

	$(call cmd,inat_tables)

$(obj)/inat.o: $(obj)/inat-tables.c

clean-files := inat-tables.c

obj-$(CONFIG_SMP) := msr.o

lib-y := delay.o

lib-y += thunk_$(BITS).o

lib-y += usercopy_$(BITS).o getuser.o putuser.o

lib-y += memcpy_$(BITS).o

lib-y += insn.o inat.o

ifeq ($(CONFIG_X86_32),y)

        obj-y += atomic64_32.o

/*

 * x86 instruction attribute tables

 *

 * 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 <asm/insn.h>

/* Attribute tables are generated from opcode map */

#include "inat-tables.c"

/* Attribute search APIs */

insn_attr_t inat_get_opcode_attribute(insn_byte_t opcode)

{

	return inat_primary_table[opcode];

}

insn_attr_t inat_get_escape_attribute(insn_byte_t opcode, insn_byte_t last_pfx,

				      insn_attr_t esc_attr)

{

	const insn_attr_t *table;

	insn_attr_t lpfx_attr;

	int n, m = 0;

	n = inat_escape_id(esc_attr);

	if (last_pfx) {

		lpfx_attr = inat_get_opcode_attribute(last_pfx);

		m = inat_last_prefix_id(lpfx_attr);

	}

	table = inat_escape_tables[n][0];

	if (!table)

		return 0;

	if (inat_has_variant(table[opcode]) && m) {

		table = inat_escape_tables[n][m];

		if (!table)

			return 0;

	}

	return table[opcode];

}

insn_attr_t inat_get_group_attribute(insn_byte_t modrm, insn_byte_t last_pfx,

				     insn_attr_t grp_attr)

{

	const insn_attr_t *table;

	insn_attr_t lpfx_attr;

	int n, m = 0;

	n = inat_group_id(grp_attr);

	if (last_pfx) {

		lpfx_attr = inat_get_opcode_attribute(last_pfx);

		m = inat_last_prefix_id(lpfx_attr);

	}

	table = inat_group_tables[n][0];

	if (!table)

		return inat_group_common_attribute(grp_attr);

	if (inat_has_variant(table[X86_MODRM_REG(modrm)]) && m) {

		table = inat_escape_tables[n][m];

		if (!table)

			return inat_group_common_attribute(grp_attr);

	}

	return table[X86_MODRM_REG(modrm)] |

	       inat_group_common_attribute(grp_attr);

}