daily update
[binutils.git] / include / dis-asm.h
blob63366d9e5577ed062df3f09e2bcfbd842af2a2a2
1 /* Interface between the opcode library and its callers.
3 Copyright 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2009, 2010
4 Free Software Foundation, Inc.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3, or (at your option)
9 any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 51 Franklin Street - Fifth Floor,
19 Boston, MA 02110-1301, USA.
21 Written by Cygnus Support, 1993.
23 The opcode library (libopcodes.a) provides instruction decoders for
24 a large variety of instruction sets, callable with an identical
25 interface, for making instruction-processing programs more independent
26 of the instruction set being processed. */
28 #ifndef DIS_ASM_H
29 #define DIS_ASM_H
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
35 #include <stdio.h>
36 #include "bfd.h"
38 typedef int (*fprintf_ftype) (void *, const char*, ...) /*ATTRIBUTE_FPTR_PRINTF_2*/;
40 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. */
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.
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. */
62 typedef struct disassemble_info
64 fprintf_ftype fprintf_func;
65 void *stream;
66 void *application_data;
68 /* Target description. We could replace this with a pointer to the bfd,
69 but that would require one. There currently isn't any such requirement
70 so to avoid introducing one we record these explicitly. */
71 /* The bfd_flavour. This can be bfd_target_unknown_flavour. */
72 enum bfd_flavour flavour;
73 /* The bfd_arch value. */
74 enum bfd_architecture arch;
75 /* The bfd_mach value. */
76 unsigned long mach;
77 /* Endianness (for bi-endian cpus). Mono-endian cpus can ignore this. */
78 enum bfd_endian endian;
79 /* Endianness of code, for mixed-endian situations such as ARM BE8. */
80 enum bfd_endian endian_code;
81 /* An arch/mach-specific bitmask of selected instruction subsets, mainly
82 for processors with run-time-switchable instruction sets. The default,
83 zero, means that there is no constraint. CGEN-based opcodes ports
84 may use ISA_foo masks. */
85 void *insn_sets;
87 /* Some targets need information about the current section to accurately
88 display insns. If this is NULL, the target disassembler function
89 will have to make its best guess. */
90 asection *section;
92 /* An array of pointers to symbols either at the location being disassembled
93 or at the start of the function being disassembled. The array is sorted
94 so that the first symbol is intended to be the one used. The others are
95 present for any misc. purposes. This is not set reliably, but if it is
96 not NULL, it is correct. */
97 asymbol **symbols;
98 /* Number of symbols in array. */
99 int num_symbols;
101 /* Symbol table provided for targets that want to look at it. This is
102 used on Arm to find mapping symbols and determine Arm/Thumb code. */
103 asymbol **symtab;
104 int symtab_pos;
105 int symtab_size;
107 /* For use by the disassembler.
108 The top 16 bits are reserved for public use (and are documented here).
109 The bottom 16 bits are for the internal use of the disassembler. */
110 unsigned long flags;
111 /* Set if the disassembler has determined that there are one or more
112 relocations associated with the instruction being disassembled. */
113 #define INSN_HAS_RELOC (1 << 31)
114 /* Set if the user has requested the disassembly of data as well as code. */
115 #define DISASSEMBLE_DATA (1 << 30)
116 /* Set if the user has specifically set the machine type encoded in the
117 mach field of this structure. */
118 #define USER_SPECIFIED_MACHINE_TYPE (1 << 29)
120 /* Use internally by the target specific disassembly code. */
121 void *private_data;
123 /* Function used to get bytes to disassemble. MEMADDR is the
124 address of the stuff to be disassembled, MYADDR is the address to
125 put the bytes in, and LENGTH is the number of bytes to read.
126 INFO is a pointer to this struct.
127 Returns an errno value or 0 for success. */
128 int (*read_memory_func)
129 (bfd_vma memaddr, bfd_byte *myaddr, unsigned int length,
130 struct disassemble_info *dinfo);
132 /* Function which should be called if we get an error that we can't
133 recover from. STATUS is the errno value from read_memory_func and
134 MEMADDR is the address that we were trying to read. INFO is a
135 pointer to this struct. */
136 void (*memory_error_func)
137 (int status, bfd_vma memaddr, struct disassemble_info *dinfo);
139 /* Function called to print ADDR. */
140 void (*print_address_func)
141 (bfd_vma addr, struct disassemble_info *dinfo);
143 /* Function called to determine if there is a symbol at the given ADDR.
144 If there is, the function returns 1, otherwise it returns 0.
145 This is used by ports which support an overlay manager where
146 the overlay number is held in the top part of an address. In
147 some circumstances we want to include the overlay number in the
148 address, (normally because there is a symbol associated with
149 that address), but sometimes we want to mask out the overlay bits. */
150 int (* symbol_at_address_func)
151 (bfd_vma addr, struct disassemble_info *dinfo);
153 /* Function called to check if a SYMBOL is can be displayed to the user.
154 This is used by some ports that want to hide special symbols when
155 displaying debugging outout. */
156 bfd_boolean (* symbol_is_valid)
157 (asymbol *, struct disassemble_info *dinfo);
159 /* These are for buffer_read_memory. */
160 bfd_byte *buffer;
161 bfd_vma buffer_vma;
162 unsigned int buffer_length;
164 /* This variable may be set by the instruction decoder. It suggests
165 the number of bytes objdump should display on a single line. If
166 the instruction decoder sets this, it should always set it to
167 the same value in order to get reasonable looking output. */
168 int bytes_per_line;
170 /* The next two variables control the way objdump displays the raw data. */
171 /* For example, if bytes_per_line is 8 and bytes_per_chunk is 4, the */
172 /* output will look like this:
173 00: 00000000 00000000
174 with the chunks displayed according to "display_endian". */
175 int bytes_per_chunk;
176 enum bfd_endian display_endian;
178 /* Number of octets per incremented target address
179 Normally one, but some DSPs have byte sizes of 16 or 32 bits. */
180 unsigned int octets_per_byte;
182 /* The number of zeroes we want to see at the end of a section before we
183 start skipping them. */
184 unsigned int skip_zeroes;
186 /* The number of zeroes to skip at the end of a section. If the number
187 of zeroes at the end is between SKIP_ZEROES_AT_END and SKIP_ZEROES,
188 they will be disassembled. If there are fewer than
189 SKIP_ZEROES_AT_END, they will be skipped. This is a heuristic
190 attempt to avoid disassembling zeroes inserted by section
191 alignment. */
192 unsigned int skip_zeroes_at_end;
194 /* Whether the disassembler always needs the relocations. */
195 bfd_boolean disassembler_needs_relocs;
197 /* Results from instruction decoders. Not all decoders yet support
198 this information. This info is set each time an instruction is
199 decoded, and is only valid for the last such instruction.
201 To determine whether this decoder supports this information, set
202 insn_info_valid to 0, decode an instruction, then check it. */
204 char insn_info_valid; /* Branch info has been set. */
205 char branch_delay_insns; /* How many sequential insn's will run before
206 a branch takes effect. (0 = normal) */
207 char data_size; /* Size of data reference in insn, in bytes */
208 enum dis_insn_type insn_type; /* Type of instruction */
209 bfd_vma target; /* Target address of branch or dref, if known;
210 zero if unknown. */
211 bfd_vma target2; /* Second target address for dref2 */
213 /* Command line options specific to the target disassembler. */
214 char * disassembler_options;
216 } disassemble_info;
219 /* Standard disassemblers. Disassemble one instruction at the given
220 target address. Return number of octets processed. */
221 typedef int (*disassembler_ftype) (bfd_vma, disassemble_info *);
223 extern int print_insn_alpha (bfd_vma, disassemble_info *);
224 extern int print_insn_avr (bfd_vma, disassemble_info *);
225 extern int print_insn_bfin (bfd_vma, disassemble_info *);
226 extern int print_insn_big_arm (bfd_vma, disassemble_info *);
227 extern int print_insn_big_mips (bfd_vma, disassemble_info *);
228 extern int print_insn_big_or32 (bfd_vma, disassemble_info *);
229 extern int print_insn_big_powerpc (bfd_vma, disassemble_info *);
230 extern int print_insn_big_score (bfd_vma, disassemble_info *);
231 extern int print_insn_cr16 (bfd_vma, disassemble_info *);
232 extern int print_insn_crx (bfd_vma, disassemble_info *);
233 extern int print_insn_d10v (bfd_vma, disassemble_info *);
234 extern int print_insn_d30v (bfd_vma, disassemble_info *);
235 extern int print_insn_dlx (bfd_vma, disassemble_info *);
236 extern int print_insn_fr30 (bfd_vma, disassemble_info *);
237 extern int print_insn_frv (bfd_vma, disassemble_info *);
238 extern int print_insn_h8300 (bfd_vma, disassemble_info *);
239 extern int print_insn_h8300h (bfd_vma, disassemble_info *);
240 extern int print_insn_h8300s (bfd_vma, disassemble_info *);
241 extern int print_insn_h8500 (bfd_vma, disassemble_info *);
242 extern int print_insn_hppa (bfd_vma, disassemble_info *);
243 extern int print_insn_i370 (bfd_vma, disassemble_info *);
244 extern int print_insn_i386 (bfd_vma, disassemble_info *);
245 extern int print_insn_i386_att (bfd_vma, disassemble_info *);
246 extern int print_insn_i386_intel (bfd_vma, disassemble_info *);
247 extern int print_insn_i860 (bfd_vma, disassemble_info *);
248 extern int print_insn_i960 (bfd_vma, disassemble_info *);
249 extern int print_insn_ia64 (bfd_vma, disassemble_info *);
250 extern int print_insn_ip2k (bfd_vma, disassemble_info *);
251 extern int print_insn_iq2000 (bfd_vma, disassemble_info *);
252 extern int print_insn_little_arm (bfd_vma, disassemble_info *);
253 extern int print_insn_little_mips (bfd_vma, disassemble_info *);
254 extern int print_insn_little_or32 (bfd_vma, disassemble_info *);
255 extern int print_insn_little_powerpc (bfd_vma, disassemble_info *);
256 extern int print_insn_little_score (bfd_vma, disassemble_info *);
257 extern int print_insn_lm32 (bfd_vma, disassemble_info *);
258 extern int print_insn_m32c (bfd_vma, disassemble_info *);
259 extern int print_insn_m32r (bfd_vma, disassemble_info *);
260 extern int print_insn_m68hc11 (bfd_vma, disassemble_info *);
261 extern int print_insn_m68hc12 (bfd_vma, disassemble_info *);
262 extern int print_insn_m68k (bfd_vma, disassemble_info *);
263 extern int print_insn_m88k (bfd_vma, disassemble_info *);
264 extern int print_insn_mcore (bfd_vma, disassemble_info *);
265 extern int print_insn_mep (bfd_vma, disassemble_info *);
266 extern int print_insn_microblaze (bfd_vma, disassemble_info *);
267 extern int print_insn_mmix (bfd_vma, disassemble_info *);
268 extern int print_insn_mn10200 (bfd_vma, disassemble_info *);
269 extern int print_insn_mn10300 (bfd_vma, disassemble_info *);
270 extern int print_insn_moxie (bfd_vma, disassemble_info *);
271 extern int print_insn_msp430 (bfd_vma, disassemble_info *);
272 extern int print_insn_mt (bfd_vma, disassemble_info *);
273 extern int print_insn_ns32k (bfd_vma, disassemble_info *);
274 extern int print_insn_openrisc (bfd_vma, disassemble_info *);
275 extern int print_insn_pdp11 (bfd_vma, disassemble_info *);
276 extern int print_insn_pj (bfd_vma, disassemble_info *);
277 extern int print_insn_rs6000 (bfd_vma, disassemble_info *);
278 extern int print_insn_s390 (bfd_vma, disassemble_info *);
279 extern int print_insn_sh (bfd_vma, disassemble_info *);
280 extern int print_insn_sh64 (bfd_vma, disassemble_info *);
281 extern int print_insn_sh64x_media (bfd_vma, disassemble_info *);
282 extern int print_insn_sparc (bfd_vma, disassemble_info *);
283 extern int print_insn_spu (bfd_vma, disassemble_info *);
284 extern int print_insn_tic30 (bfd_vma, disassemble_info *);
285 extern int print_insn_tic4x (bfd_vma, disassemble_info *);
286 extern int print_insn_tic54x (bfd_vma, disassemble_info *);
287 extern int print_insn_tic6x (bfd_vma, disassemble_info *);
288 extern int print_insn_tic80 (bfd_vma, disassemble_info *);
289 extern int print_insn_v850 (bfd_vma, disassemble_info *);
290 extern int print_insn_vax (bfd_vma, disassemble_info *);
291 extern int print_insn_w65 (bfd_vma, disassemble_info *);
292 extern int print_insn_xc16x (bfd_vma, disassemble_info *);
293 extern int print_insn_xstormy16 (bfd_vma, disassemble_info *);
294 extern int print_insn_xtensa (bfd_vma, disassemble_info *);
295 extern int print_insn_z80 (bfd_vma, disassemble_info *);
296 extern int print_insn_z8001 (bfd_vma, disassemble_info *);
297 extern int print_insn_z8002 (bfd_vma, disassemble_info *);
298 extern int print_insn_rx (bfd_vma, disassemble_info *);
300 extern disassembler_ftype arc_get_disassembler (void *);
301 extern disassembler_ftype cris_get_disassembler (bfd *);
303 extern void print_i386_disassembler_options (FILE *);
304 extern void print_mips_disassembler_options (FILE *);
305 extern void print_ppc_disassembler_options (FILE *);
306 extern void print_arm_disassembler_options (FILE *);
307 extern void parse_arm_disassembler_option (char *);
308 extern void print_s390_disassembler_options (FILE *);
309 extern int get_arm_regname_num_options (void);
310 extern int set_arm_regname_option (int);
311 extern int get_arm_regnames (int, const char **, const char **, const char *const **);
312 extern bfd_boolean arm_symbol_is_valid (asymbol *, struct disassemble_info *);
314 /* Fetch the disassembler for a given BFD, if that support is available. */
315 extern disassembler_ftype disassembler (bfd *);
317 /* Amend the disassemble_info structure as necessary for the target architecture.
318 Should only be called after initialising the info->arch field. */
319 extern void disassemble_init_for_target (struct disassemble_info * dinfo);
321 /* Document any target specific options available from the disassembler. */
322 extern void disassembler_usage (FILE *);
325 /* This block of definitions is for particular callers who read instructions
326 into a buffer before calling the instruction decoder. */
328 /* Here is a function which callers may wish to use for read_memory_func.
329 It gets bytes from a buffer. */
330 extern int buffer_read_memory
331 (bfd_vma, bfd_byte *, unsigned int, struct disassemble_info *);
333 /* This function goes with buffer_read_memory.
334 It prints a message using info->fprintf_func and info->stream. */
335 extern void perror_memory (int, bfd_vma, struct disassemble_info *);
338 /* Just print the address in hex. This is included for completeness even
339 though both GDB and objdump provide their own (to print symbolic
340 addresses). */
341 extern void generic_print_address
342 (bfd_vma, struct disassemble_info *);
344 /* Always true. */
345 extern int generic_symbol_at_address
346 (bfd_vma, struct disassemble_info *);
348 /* Also always true. */
349 extern bfd_boolean generic_symbol_is_valid
350 (asymbol *, struct disassemble_info *);
352 /* Method to initialize a disassemble_info struct. This should be
353 called by all applications creating such a struct. */
354 extern void init_disassemble_info (struct disassemble_info *dinfo, void *stream,
355 fprintf_ftype fprintf_func);
357 /* For compatibility with existing code. */
358 #define INIT_DISASSEMBLE_INFO(INFO, STREAM, FPRINTF_FUNC) \
359 init_disassemble_info (&(INFO), (STREAM), (fprintf_ftype) (FPRINTF_FUNC))
360 #define INIT_DISASSEMBLE_INFO_NO_ARCH(INFO, STREAM, FPRINTF_FUNC) \
361 init_disassemble_info (&(INFO), (STREAM), (fprintf_ftype) (FPRINTF_FUNC))
364 #ifdef __cplusplus
366 #endif
368 #endif /* ! defined (DIS_ASM_H) */