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