[apple/xnu.git] / bsd / i386 / fasttrap_isa.h

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */
/*
 * Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

#ifndef _FASTTRAP_ISA_H
#define _FASTTRAP_ISA_H

#include <sys/types.h>
#include <stdint.h>

#ifdef  __cplusplus
extern "C" {
#endif

#define FASTTRAP_MAX_INSTR_SIZE         15

#define FASTTRAP_INSTR                  0xcc

#define FASTTRAP_SUNWDTRACE_SIZE        64

typedef uint8_t         fasttrap_instr_t;

typedef struct fasttrap_machtp {
	uint8_t         ftmt_instr[FASTTRAP_MAX_INSTR_SIZE]; /* orig. instr. */
	uint8_t         ftmt_size;      /* instruction size */
	uint8_t         ftmt_ripmode;   /* %rip-relative handling mode */
	uint8_t         ftmt_modrm;     /* saved modrm byte */
	uint8_t         ftmt_type;      /* emulation type */
	uint8_t         ftmt_code;      /* branch condition */
	uint8_t         ftmt_base;      /* branch base */
	uint8_t         ftmt_index;     /* branch index */
	uint8_t         ftmt_scale;     /* branch scale */
	uint8_t         ftmt_segment;   /* segment for memory accesses */
	user_addr_t     ftmt_dest;      /* destination of control flow */
	uint8_t         ftmt_installed:1;
	uint8_t         ftmt_retired:1;
} fasttrap_machtp_t;

#define ftt_instr       ftt_mtp.ftmt_instr
#define ftt_ripmode     ftt_mtp.ftmt_ripmode
#define ftt_modrm       ftt_mtp.ftmt_modrm
#define ftt_size        ftt_mtp.ftmt_size
#define ftt_type        ftt_mtp.ftmt_type
#define ftt_code        ftt_mtp.ftmt_code
#define ftt_base        ftt_mtp.ftmt_base
#define ftt_index       ftt_mtp.ftmt_index
#define ftt_scale       ftt_mtp.ftmt_scale
#define ftt_segment     ftt_mtp.ftmt_segment
#define ftt_dest        ftt_mtp.ftmt_dest
#define ftt_installed   ftt_mtp.ftmt_installed
#define ftt_retired     ftt_mtp.ftmt_retired


#define FASTTRAP_T_COMMON       0x00    /* common case -- no emulation */
#define FASTTRAP_T_JCC          0x01    /* near and far conditional jumps */
#define FASTTRAP_T_LOOP         0x02    /* loop instructions */
#define FASTTRAP_T_JCXZ         0x03    /* jump if %ecx/%rcx is zero */
#define FASTTRAP_T_JMP          0x04    /* relative jump */
#define FASTTRAP_T_CALL         0x05    /* near call (and link) */
#define FASTTRAP_T_RET          0x06    /* ret */
#define FASTTRAP_T_RET16        0x07    /* ret <imm16> */

/*
 * For performance rather than correctness.
 */
#define FASTTRAP_T_PUSHL_EBP    0x10    /* pushl %ebp (for function entry) */
#define FASTTRAP_T_NOP          0x11    /* nop */

#define FASTTRAP_RIP_1          0x1
#define FASTTRAP_RIP_2          0x2
#define FASTTRAP_RIP_X          0x4

/*
 * Segment values.
 */
#define FASTTRAP_SEG_NONE               0
#define FASTTRAP_SEG_CS                 1
#define FASTTRAP_SEG_DS                 2
#define FASTTRAP_SEG_ES                 3
#define FASTTRAP_SEG_FS                 4
#define FASTTRAP_SEG_GS                 5
#define FASTTRAP_SEG_SS                 6

#define FASTTRAP_RETURN_AFRAMES         6
#define FASTTRAP_ENTRY_AFRAMES          5
#define FASTTRAP_OFFSET_AFRAMES         5

#ifdef  __cplusplus
}
#endif

#endif  /* _FASTTRAP_ISA_H */
Commit	Line	Data
2d21ac55 A	1	/*
	2	* CDDL HEADER START
	3	*
	4	* The contents of this file are subject to the terms of the
	5	* Common Development and Distribution License (the "License").
	6	* You may not use this file except in compliance with the License.
	7	*
	8	* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
	9	* or http://www.opensolaris.org/os/licensing.
	10	* See the License for the specific language governing permissions
	11	* and limitations under the License.
	12	*
	13	* When distributing Covered Code, include this CDDL HEADER in each
	14	* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
	15	* If applicable, add the following below this CDDL HEADER, with the
	16	* fields enclosed by brackets "[]" replaced with your own identifying
	17	* information: Portions Copyright [yyyy] [name of copyright owner]
	18	*
	19	* CDDL HEADER END
	20	*/
	21	/*
	22	* Copyright 2006 Sun Microsystems, Inc. All rights reserved.
	23	* Use is subject to license terms.
	24	*/
	25
0a7de745 A	26	#ifndef _FASTTRAP_ISA_H
0a7de745 A	27	#define _FASTTRAP_ISA_H
2d21ac55	28
2d21ac55 A	29	#include <sys/types.h>
	30	#include <stdint.h>
	31
0a7de745	32	#ifdef __cplusplus
2d21ac55 A	33	extern "C" {
	34	#endif
	35
0a7de745	36	#define FASTTRAP_MAX_INSTR_SIZE 15
2d21ac55	37
0a7de745	38	#define FASTTRAP_INSTR 0xcc
2d21ac55	39
0a7de745	40	#define FASTTRAP_SUNWDTRACE_SIZE 64
2d21ac55	41
0a7de745	42	typedef uint8_t fasttrap_instr_t;
2d21ac55 A	43
2d21ac55 A	44	typedef struct fasttrap_machtp {
0a7de745 A	45	uint8_t ftmt_instr[FASTTRAP_MAX_INSTR_SIZE]; /* orig. instr. */
	46	uint8_t ftmt_size; /* instruction size */
	47	uint8_t ftmt_ripmode; /* %rip-relative handling mode */
	48	uint8_t ftmt_modrm; /* saved modrm byte */
	49	uint8_t ftmt_type; /* emulation type */
	50	uint8_t ftmt_code; /* branch condition */
	51	uint8_t ftmt_base; /* branch base */
	52	uint8_t ftmt_index; /* branch index */
	53	uint8_t ftmt_scale; /* branch scale */
	54	uint8_t ftmt_segment; /* segment for memory accesses */
	55	user_addr_t ftmt_dest; /* destination of control flow */
	56	uint8_t ftmt_installed:1;
	57	uint8_t ftmt_retired:1;
2d21ac55 A	58	} fasttrap_machtp_t;
2d21ac55 A	59
0a7de745 A	60	#define ftt_instr ftt_mtp.ftmt_instr
	61	#define ftt_ripmode ftt_mtp.ftmt_ripmode
	62	#define ftt_modrm ftt_mtp.ftmt_modrm
	63	#define ftt_size ftt_mtp.ftmt_size
	64	#define ftt_type ftt_mtp.ftmt_type
	65	#define ftt_code ftt_mtp.ftmt_code
	66	#define ftt_base ftt_mtp.ftmt_base
	67	#define ftt_index ftt_mtp.ftmt_index
	68	#define ftt_scale ftt_mtp.ftmt_scale
	69	#define ftt_segment ftt_mtp.ftmt_segment
	70	#define ftt_dest ftt_mtp.ftmt_dest
	71	#define ftt_installed ftt_mtp.ftmt_installed
	72	#define ftt_retired ftt_mtp.ftmt_retired
	73
	74
	75	#define FASTTRAP_T_COMMON 0x00 /* common case -- no emulation */
	76	#define FASTTRAP_T_JCC 0x01 /* near and far conditional jumps */
	77	#define FASTTRAP_T_LOOP 0x02 /* loop instructions */
	78	#define FASTTRAP_T_JCXZ 0x03 /* jump if %ecx/%rcx is zero */
	79	#define FASTTRAP_T_JMP 0x04 /* relative jump */
	80	#define FASTTRAP_T_CALL 0x05 /* near call (and link) */
	81	#define FASTTRAP_T_RET 0x06 /* ret */
	82	#define FASTTRAP_T_RET16 0x07 /* ret <imm16> */
2d21ac55 A	83
	84	/*
	85	* For performance rather than correctness.
	86	*/
0a7de745 A	87	#define FASTTRAP_T_PUSHL_EBP 0x10 /* pushl %ebp (for function entry) */
0a7de745 A	88	#define FASTTRAP_T_NOP 0x11 /* nop */
2d21ac55	89
0a7de745 A	90	#define FASTTRAP_RIP_1 0x1
	91	#define FASTTRAP_RIP_2 0x2
	92	#define FASTTRAP_RIP_X 0x4
2d21ac55 A	93
	94	/*
	95	* Segment values.
	96	*/
0a7de745 A	97	#define FASTTRAP_SEG_NONE 0
	98	#define FASTTRAP_SEG_CS 1
	99	#define FASTTRAP_SEG_DS 2
	100	#define FASTTRAP_SEG_ES 3
	101	#define FASTTRAP_SEG_FS 4
	102	#define FASTTRAP_SEG_GS 5
	103	#define FASTTRAP_SEG_SS 6
	104
	105	#define FASTTRAP_RETURN_AFRAMES 6
	106	#define FASTTRAP_ENTRY_AFRAMES 5
	107	#define FASTTRAP_OFFSET_AFRAMES 5
	108
	109	#ifdef __cplusplus
2d21ac55 A	110	}
	111	#endif
	112
0a7de745	113	#endif /* _FASTTRAP_ISA_H */