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