xref: /xnu-11215.41.3/bsd/i386/dis_tables.h (revision 33de042d024d46de5ff4e89f2471de6608e37fa4)
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 2007 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 /*	Copyright (c) 1988 AT&T	*/
27 /*	  All Rights Reserved   */
28 
29 
30 #ifndef _DIS_TABLES_H
31 #define _DIS_TABLES_H
32 
33 /*
34  * Constants and prototypes for the IA32 disassembler backend.  See dis_tables.c
35  * for usage information and documentation.
36  */
37 
38 /*
39  * APPLE NOTE: There is a copy of this file for userspace in
40  * dtrace:sys_dis_tables.h
41  *
42  * It needs to be in sync with this file.
43  */
44 
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48 
49 #include <sys/types.h>
50 #include <stdint.h>
51 #include <sys/param.h>
52 
53 /*
54  * values for cpu mode
55  */
56 #define SIZE16  1
57 #define SIZE32  2
58 #define SIZE64  3
59 
60 #define OPLEN   256
61 #define PFIXLEN   8
62 #define NCPS    20      /* number of chars per symbol	*/
63 
64 /*
65  * data structures that must be provided to dtrace_dis86()
66  */
67 typedef struct d86opnd {
68 	char            d86_opnd[OPLEN];        /* symbolic rep of operand */
69 	char            d86_prefix[PFIXLEN];    /* any prefix string or "" */
70 	uint_t          d86_mode;               /* mode for immediate */
71 	uint_t          d86_value_size;         /* size in bytes of d86_value */
72 	uint64_t        d86_value;              /* immediate value of opnd */
73 } d86opnd_t;
74 
75 typedef struct dis86 {
76 	uint_t          d86_mode;
77 	uint_t          d86_error;
78 	uint_t          d86_len;                /* instruction length */
79 	int             d86_rmindex;            /* index of modrm byte or -1 */
80 	uint_t          d86_memsize;            /* size of memory referenced */
81 	char            d86_bytes[16];          /* bytes of instruction */
82 	char            d86_mnem[OPLEN];
83 	uint_t          d86_numopnds;
84 	uint_t          d86_rex_prefix;         /* value of REX prefix if !0 */
85 	char            *d86_seg_prefix;        /* segment prefix, if any */
86 	uint_t          d86_opnd_size;
87 	uint_t          d86_addr_size;
88 	uint_t          d86_got_modrm;
89 	uint_t          d86_vsib;               /* Has a VSIB */
90 	struct d86opnd  d86_opnd[4];            /* up to 4 operands */
91 	int             (*d86_check_func)(void *);
92 	int             (*d86_get_byte)(void *);
93 #ifdef DIS_TEXT
94 	int             (*d86_sym_lookup)(void *, uint64_t, char *, size_t);
95 	int             (*d86_sprintf_func)(char *, size_t, const char *, ...);
96 	int             d86_flags;
97 	uint_t          d86_imm_bytes;
98 #endif
99 	void            *d86_data;
100 } dis86_t;
101 
102 extern int dtrace_disx86(dis86_t *x, uint_t cpu_mode);
103 
104 #define DIS_F_OCTAL     0x1     /* Print all numbers in octal */
105 #define DIS_F_NOIMMSYM  0x2     /* Don't print symbols for immediates (.o) */
106 
107 #ifdef DIS_TEXT
108 extern void dtrace_disx86_str(dis86_t *x, uint_t cpu_mode, uint64_t pc,
109     char *buf, size_t len);
110 #endif
111 
112 #ifdef __cplusplus
113 }
114 #endif
115 
116 #endif /* _DIS_TABLES_H */
117