[NTOS]: Implement MmDeleteTeb, VADs are now deleted/freed on thread exit as well...
[reactos.git] / reactos / ntoskrnl / kdbg / amd64 / dis-asm.h
1 /* Interface between the opcode library and its callers.
2
3 Copyright 2001, 2002 Free Software Foundation, Inc.
4
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
9
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18
19 Written by Cygnus Support, 1993.
20
21 The opcode library (libopcodes.a) provides instruction decoders for
22 a large variety of instruction sets, callable with an identical
23 interface, for making instruction-processing programs more independent
24 of the instruction set being processed. */
25
26 #ifndef DIS_ASM_H
27 #define DIS_ASM_H
28
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32
33 #if 0
34 /* #include <stdio.h> */
35 /* #include "bfd.h" */
36 #endif
37
38 typedef int (*fprintf_ftype) PARAMS((PTR, const char*, ...));
39
40 enum dis_insn_type {
41 dis_noninsn, /* Not a valid instruction */
42 dis_nonbranch, /* Not a branch instruction */
43 dis_branch, /* Unconditional branch */
44 dis_condbranch, /* Conditional branch */
45 dis_jsr, /* Jump to subroutine */
46 dis_condjsr, /* Conditional jump to subroutine */
47 dis_dref, /* Data reference instruction */
48 dis_dref2 /* Two data references in instruction */
49 };
50
51 /* This struct is passed into the instruction decoding routine,
52 and is passed back out into each callback. The various fields are used
53 for conveying information from your main routine into your callbacks,
54 for passing information into the instruction decoders (such as the
55 addresses of the callback functions), or for passing information
56 back from the instruction decoders to their callers.
57
58 It must be initialized before it is first passed; this can be done
59 by hand, or using one of the initialization macros below. */
60
61 typedef struct disassemble_info {
62 fprintf_ftype fprintf_func;
63 PTR stream;
64 PTR application_data;
65
66 /* Target description. We could replace this with a pointer to the bfd,
67 but that would require one. There currently isn't any such requirement
68 so to avoid introducing one we record these explicitly. */
69 /* The bfd_flavour. This can be bfd_target_unknown_flavour. */
70 enum bfd_flavour flavour;
71 /* The bfd_arch value. */
72 enum bfd_architecture arch;
73 /* The bfd_mach value. */
74 unsigned long mach;
75 #if 0
76 enum bfd_endian endian;
77 #endif
78 /* An arch/mach-specific bitmask of selected instruction subsets, mainly
79 for processors with run-time-switchable instruction sets. The default,
80 zero, means that there is no constraint. CGEN-based opcodes ports
81 may use ISA_foo masks. */
82 unsigned long insn_sets;
83
84 #if 0
85 /* Some targets need information about the current section to accurately
86 display insns. If this is NULL, the target disassembler function
87 will have to make its best guess. */
88 asection *section;
89
90 /* An array of pointers to symbols either at the location being disassembled
91 or at the start of the function being disassembled. The array is sorted
92 so that the first symbol is intended to be the one used. The others are
93 present for any misc. purposes. This is not set reliably, but if it is
94 not NULL, it is correct. */
95 asymbol **symbols;
96 /* Number of symbols in array. */
97 int num_symbols;
98 #endif
99 /* For use by the disassembler.
100 The top 16 bits are reserved for public use (and are documented here).
101 The bottom 16 bits are for the internal use of the disassembler. */
102 unsigned long flags;
103 #define INSN_HAS_RELOC 0x80000000
104 PTR private_data;
105
106 /* Function used to get bytes to disassemble. MEMADDR is the
107 address of the stuff to be disassembled, MYADDR is the address to
108 put the bytes in, and LENGTH is the number of bytes to read.
109 INFO is a pointer to this struct.
110 Returns an errno value or 0 for success. */
111 int (*read_memory_func)
112 PARAMS ((bfd_vma memaddr, bfd_byte *myaddr, unsigned int length,
113 struct disassemble_info *info));
114
115 /* Function which should be called if we get an error that we can't
116 recover from. STATUS is the errno value from read_memory_func and
117 MEMADDR is the address that we were trying to read. INFO is a
118 pointer to this struct. */
119 void (*memory_error_func)
120 PARAMS ((int status, bfd_vma memaddr, struct disassemble_info *info));
121
122 /* Function called to print ADDR. */
123 void (*print_address_func)
124 PARAMS ((bfd_vma addr, struct disassemble_info *info));
125
126 /* Function called to determine if there is a symbol at the given ADDR.
127 If there is, the function returns 1, otherwise it returns 0.
128 This is used by ports which support an overlay manager where
129 the overlay number is held in the top part of an address. In
130 some circumstances we want to include the overlay number in the
131 address, (normally because there is a symbol associated with
132 that address), but sometimes we want to mask out the overlay bits. */
133 int (* symbol_at_address_func)
134 PARAMS ((bfd_vma addr, struct disassemble_info * info));
135
136 /* These are for buffer_read_memory. */
137 bfd_byte *buffer;
138 bfd_vma buffer_vma;
139 unsigned int buffer_length;
140
141 /* This variable may be set by the instruction decoder. It suggests
142 the number of bytes objdump should display on a single line. If
143 the instruction decoder sets this, it should always set it to
144 the same value in order to get reasonable looking output. */
145 int bytes_per_line;
146
147 /* the next two variables control the way objdump displays the raw data */
148 /* For example, if bytes_per_line is 8 and bytes_per_chunk is 4, the */
149 /* output will look like this:
150 00: 00000000 00000000
151 with the chunks displayed according to "display_endian". */
152 int bytes_per_chunk;
153 enum bfd_endian display_endian;
154
155 /* Number of octets per incremented target address
156 Normally one, but some DSPs have byte sizes of 16 or 32 bits. */
157 unsigned int octets_per_byte;
158
159 /* Results from instruction decoders. Not all decoders yet support
160 this information. This info is set each time an instruction is
161 decoded, and is only valid for the last such instruction.
162
163 To determine whether this decoder supports this information, set
164 insn_info_valid to 0, decode an instruction, then check it. */
165
166 char insn_info_valid; /* Branch info has been set. */
167 char branch_delay_insns; /* How many sequential insn's will run before
168 a branch takes effect. (0 = normal) */
169 char data_size; /* Size of data reference in insn, in bytes */
170 enum dis_insn_type insn_type; /* Type of instruction */
171 bfd_vma target; /* Target address of branch or dref, if known;
172 zero if unknown. */
173 bfd_vma target2; /* Second target address for dref2 */
174
175 /* Command line options specific to the target disassembler. */
176 char * disassembler_options;
177
178 } disassemble_info;
179
180 \f
181 /* Standard disassemblers. Disassemble one instruction at the given
182 target address. Return number of octets processed. */
183 typedef int (*disassembler_ftype)
184 PARAMS((bfd_vma, disassemble_info *));
185
186 extern int print_insn_big_mips PARAMS ((bfd_vma, disassemble_info*));
187 extern int print_insn_little_mips PARAMS ((bfd_vma, disassemble_info*));
188 extern int print_insn_i386 PARAMS ((bfd_vma, disassemble_info *));
189 extern int print_insn_i386_att PARAMS ((bfd_vma, disassemble_info*));
190 extern int print_insn_i386_intel PARAMS ((bfd_vma, disassemble_info*));
191 extern int print_insn_ia64 PARAMS ((bfd_vma, disassemble_info*));
192 extern int print_insn_i370 PARAMS ((bfd_vma, disassemble_info*));
193 extern int print_insn_m68hc11 PARAMS ((bfd_vma, disassemble_info*));
194 extern int print_insn_m68hc12 PARAMS ((bfd_vma, disassemble_info*));
195 extern int print_insn_m68k PARAMS ((bfd_vma, disassemble_info*));
196 extern int print_insn_z8001 PARAMS ((bfd_vma, disassemble_info*));
197 extern int print_insn_z8002 PARAMS ((bfd_vma, disassemble_info*));
198 extern int print_insn_h8300 PARAMS ((bfd_vma, disassemble_info*));
199 extern int print_insn_h8300h PARAMS ((bfd_vma, disassemble_info*));
200 extern int print_insn_h8300s PARAMS ((bfd_vma, disassemble_info*));
201 extern int print_insn_h8500 PARAMS ((bfd_vma, disassemble_info*));
202 extern int print_insn_alpha PARAMS ((bfd_vma, disassemble_info*));
203 extern int print_insn_big_arm PARAMS ((bfd_vma, disassemble_info*));
204 extern int print_insn_little_arm PARAMS ((bfd_vma, disassemble_info*));
205 extern int print_insn_sparc PARAMS ((bfd_vma, disassemble_info*));
206 extern int print_insn_big_a29k PARAMS ((bfd_vma, disassemble_info*));
207 extern int print_insn_little_a29k PARAMS ((bfd_vma, disassemble_info*));
208 extern int print_insn_avr PARAMS ((bfd_vma, disassemble_info*));
209 extern int print_insn_d10v PARAMS ((bfd_vma, disassemble_info*));
210 extern int print_insn_d30v PARAMS ((bfd_vma, disassemble_info*));
211 extern int print_insn_dlx PARAMS ((bfd_vma, disassemble_info*));
212 extern int print_insn_fr30 PARAMS ((bfd_vma, disassemble_info*));
213 extern int print_insn_hppa PARAMS ((bfd_vma, disassemble_info*));
214 extern int print_insn_i860 PARAMS ((bfd_vma, disassemble_info*));
215 extern int print_insn_i960 PARAMS ((bfd_vma, disassemble_info*));
216 extern int print_insn_ip2k PARAMS ((bfd_vma, disassemble_info*));
217 extern int print_insn_m32r PARAMS ((bfd_vma, disassemble_info*));
218 extern int print_insn_m88k PARAMS ((bfd_vma, disassemble_info*));
219 extern int print_insn_mcore PARAMS ((bfd_vma, disassemble_info*));
220 extern int print_insn_mmix PARAMS ((bfd_vma, disassemble_info*));
221 extern int print_insn_mn10200 PARAMS ((bfd_vma, disassemble_info*));
222 extern int print_insn_mn10300 PARAMS ((bfd_vma, disassemble_info*));
223 extern int print_insn_msp430 PARAMS ((bfd_vma, disassemble_info*));
224 extern int print_insn_ns32k PARAMS ((bfd_vma, disassemble_info*));
225 extern int print_insn_openrisc PARAMS ((bfd_vma, disassemble_info*));
226 extern int print_insn_big_or32 PARAMS ((bfd_vma, disassemble_info*));
227 extern int print_insn_little_or32 PARAMS ((bfd_vma, disassemble_info*));
228 extern int print_insn_pdp11 PARAMS ((bfd_vma, disassemble_info*));
229 extern int print_insn_pj PARAMS ((bfd_vma, disassemble_info*));
230 extern int print_insn_big_powerpc PARAMS ((bfd_vma, disassemble_info*));
231 extern int print_insn_little_powerpc PARAMS ((bfd_vma, disassemble_info*));
232 extern int print_insn_rs6000 PARAMS ((bfd_vma, disassemble_info*));
233 extern int print_insn_s390 PARAMS ((bfd_vma, disassemble_info*));
234 extern int print_insn_sh PARAMS ((bfd_vma, disassemble_info*));
235 extern int print_insn_tic30 PARAMS ((bfd_vma, disassemble_info*));
236 extern int print_insn_tic4x PARAMS ((bfd_vma, disassemble_info*));
237 extern int print_insn_tic54x PARAMS ((bfd_vma, disassemble_info*));
238 extern int print_insn_tic80 PARAMS ((bfd_vma, disassemble_info*));
239 extern int print_insn_v850 PARAMS ((bfd_vma, disassemble_info*));
240 extern int print_insn_vax PARAMS ((bfd_vma, disassemble_info*));
241 extern int print_insn_w65 PARAMS ((bfd_vma, disassemble_info*));
242 extern int print_insn_xstormy16 PARAMS ((bfd_vma, disassemble_info*));
243 extern int print_insn_sh64 PARAMS ((bfd_vma, disassemble_info *));
244 extern int print_insn_sh64x_media PARAMS ((bfd_vma, disassemble_info *));
245 extern int print_insn_frv PARAMS ((bfd_vma, disassemble_info *));
246 extern int print_insn_iq2000 PARAMS ((bfd_vma, disassemble_info *));
247
248 extern disassembler_ftype arc_get_disassembler PARAMS ((void *));
249 extern disassembler_ftype cris_get_disassembler PARAMS ((bfd *));
250
251 extern void print_mips_disassembler_options PARAMS ((FILE *));
252 extern void print_ppc_disassembler_options PARAMS ((FILE *));
253 extern void print_arm_disassembler_options PARAMS ((FILE *));
254 extern void parse_arm_disassembler_option PARAMS ((char *));
255 extern int get_arm_regname_num_options PARAMS ((void));
256 extern int set_arm_regname_option PARAMS ((int));
257 extern int get_arm_regnames PARAMS ((int, const char **, const char **, const char ***));
258
259 /* Fetch the disassembler for a given BFD, if that support is available. */
260 extern disassembler_ftype disassembler PARAMS ((bfd *));
261
262 /* Document any target specific options available from the disassembler. */
263 extern void disassembler_usage PARAMS ((FILE *));
264
265 \f
266 /* This block of definitions is for particular callers who read instructions
267 into a buffer before calling the instruction decoder. */
268
269 /* Here is a function which callers may wish to use for read_memory_func.
270 It gets bytes from a buffer. */
271 extern int buffer_read_memory
272 PARAMS ((bfd_vma, bfd_byte *, unsigned int, struct disassemble_info *));
273
274 /* This function goes with buffer_read_memory.
275 It prints a message using info->fprintf_func and info->stream. */
276 extern void perror_memory PARAMS ((int, bfd_vma, struct disassemble_info *));
277
278
279 /* Just print the address in hex. This is included for completeness even
280 though both GDB and objdump provide their own (to print symbolic
281 addresses). */
282 extern void generic_print_address
283 PARAMS ((bfd_vma, struct disassemble_info *));
284
285 /* Always true. */
286 extern int generic_symbol_at_address
287 PARAMS ((bfd_vma, struct disassemble_info *));
288
289 /* Macro to initialize a disassemble_info struct. This should be called
290 by all applications creating such a struct. */
291 #define INIT_DISASSEMBLE_INFO(INFO, STREAM, FPRINTF_FUNC) \
292 (INFO).flavour = bfd_target_unknown_flavour, \
293 (INFO).arch = bfd_arch_unknown, \
294 (INFO).mach = 0, \
295 (INFO).insn_sets = 0, \
296 (INFO).endian = BFD_ENDIAN_UNKNOWN, \
297 (INFO).octets_per_byte = 1, \
298 INIT_DISASSEMBLE_INFO_NO_ARCH(INFO, STREAM, FPRINTF_FUNC)
299
300 /* Call this macro to initialize only the internal variables for the
301 disassembler. Architecture dependent things such as byte order, or machine
302 variant are not touched by this macro. This makes things much easier for
303 GDB which must initialize these things separately. */
304
305 #define INIT_DISASSEMBLE_INFO_NO_ARCH(INFO, STREAM, FPRINTF_FUNC) \
306 (INFO).fprintf_func = (fprintf_ftype)(FPRINTF_FUNC), \
307 (INFO).stream = (PTR)(STREAM), \
308 (INFO).section = NULL, \
309 (INFO).symbols = NULL, \
310 (INFO).num_symbols = 0, \
311 (INFO).private_data = NULL, \
312 (INFO).buffer = NULL, \
313 (INFO).buffer_vma = 0, \
314 (INFO).buffer_length = 0, \
315 (INFO).read_memory_func = buffer_read_memory, \
316 (INFO).memory_error_func = perror_memory, \
317 (INFO).print_address_func = generic_print_address, \
318 (INFO).symbol_at_address_func = generic_symbol_at_address, \
319 (INFO).flags = 0, \
320 (INFO).bytes_per_line = 0, \
321 (INFO).bytes_per_chunk = 0, \
322 (INFO).display_endian = BFD_ENDIAN_UNKNOWN, \
323 (INFO).disassembler_options = NULL, \
324 (INFO).insn_info_valid = 0
325
326 #ifdef __cplusplus
327 }
328 #endif
329
330 #endif /* ! defined (DIS_ASM_H) */