Kaveh Ghazi's printf format attribute checking patch.
[deliverable/binutils-gdb.git] / include / dis-asm.h
CommitLineData
252b5132 1/* Interface between the opcode library and its callers.
4f1d9bd8 2
c3aa17e9
AM
3 Copyright 1999, 2000, 2001, 2002, 2003, 2004, 2005
4 Free Software Foundation, Inc.
4f1d9bd8
NC
5
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 2, or (at your option)
9 any later version.
10
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.
15
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
e172dbf8
NC
18 Foundation, Inc., 51 Franklin Street - Fifth Floor,
19 Boston, MA 02110-1301, USA.
4f1d9bd8 20
252b5132
RH
21 Written by Cygnus Support, 1993.
22
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. */
27
28#ifndef DIS_ASM_H
29#define DIS_ASM_H
30
7d7a6736
ILT
31#ifdef __cplusplus
32extern "C" {
33#endif
34
252b5132
RH
35#include <stdio.h>
36#include "bfd.h"
37
0fd3a477 38typedef int (*fprintf_ftype) (void *, const char*, ...) ATTRIBUTE_FPTR_PRINTF_2;
252b5132
RH
39
40enum 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
61typedef struct disassemble_info {
62 fprintf_ftype fprintf_func;
8cf3f354
AM
63 void *stream;
64 void *application_data;
252b5132
RH
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 /* Endianness (for bi-endian cpus). Mono-endian cpus can ignore this. */
76 enum bfd_endian endian;
cadaa522
FCE
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;
252b5132 82
ca6d9fb3
HPN
83 /* Some targets need information about the current section to accurately
84 display insns. If this is NULL, the target disassembler function
85 will have to make its best guess. */
86 asection *section;
87
252b5132
RH
88 /* An array of pointers to symbols either at the location being disassembled
89 or at the start of the function being disassembled. The array is sorted
90 so that the first symbol is intended to be the one used. The others are
91 present for any misc. purposes. This is not set reliably, but if it is
92 not NULL, it is correct. */
93 asymbol **symbols;
94 /* Number of symbols in array. */
95 int num_symbols;
96
97 /* For use by the disassembler.
98 The top 16 bits are reserved for public use (and are documented here).
99 The bottom 16 bits are for the internal use of the disassembler. */
100 unsigned long flags;
101#define INSN_HAS_RELOC 0x80000000
8cf3f354 102 void *private_data;
252b5132
RH
103
104 /* Function used to get bytes to disassemble. MEMADDR is the
105 address of the stuff to be disassembled, MYADDR is the address to
106 put the bytes in, and LENGTH is the number of bytes to read.
107 INFO is a pointer to this struct.
108 Returns an errno value or 0 for success. */
109 int (*read_memory_func)
8cf3f354
AM
110 (bfd_vma memaddr, bfd_byte *myaddr, unsigned int length,
111 struct disassemble_info *info);
252b5132
RH
112
113 /* Function which should be called if we get an error that we can't
114 recover from. STATUS is the errno value from read_memory_func and
115 MEMADDR is the address that we were trying to read. INFO is a
116 pointer to this struct. */
117 void (*memory_error_func)
8cf3f354 118 (int status, bfd_vma memaddr, struct disassemble_info *info);
252b5132
RH
119
120 /* Function called to print ADDR. */
121 void (*print_address_func)
8cf3f354 122 (bfd_vma addr, struct disassemble_info *info);
252b5132
RH
123
124 /* Function called to determine if there is a symbol at the given ADDR.
125 If there is, the function returns 1, otherwise it returns 0.
126 This is used by ports which support an overlay manager where
127 the overlay number is held in the top part of an address. In
128 some circumstances we want to include the overlay number in the
129 address, (normally because there is a symbol associated with
130 that address), but sometimes we want to mask out the overlay bits. */
131 int (* symbol_at_address_func)
8cf3f354 132 (bfd_vma addr, struct disassemble_info * info);
252b5132 133
22a398e1
NC
134 /* Function called to check if a SYMBOL is can be displayed to the user.
135 This is used by some ports that want to hide special symbols when
136 displaying debugging outout. */
137 bfd_boolean (* symbol_is_valid)
138 (asymbol *, struct disassemble_info * info);
139
252b5132
RH
140 /* These are for buffer_read_memory. */
141 bfd_byte *buffer;
142 bfd_vma buffer_vma;
f6af82bd 143 unsigned int buffer_length;
252b5132
RH
144
145 /* This variable may be set by the instruction decoder. It suggests
146 the number of bytes objdump should display on a single line. If
147 the instruction decoder sets this, it should always set it to
148 the same value in order to get reasonable looking output. */
149 int bytes_per_line;
150
22a398e1 151 /* The next two variables control the way objdump displays the raw data. */
252b5132
RH
152 /* For example, if bytes_per_line is 8 and bytes_per_chunk is 4, the */
153 /* output will look like this:
154 00: 00000000 00000000
155 with the chunks displayed according to "display_endian". */
156 int bytes_per_chunk;
157 enum bfd_endian display_endian;
158
940b2b78 159 /* Number of octets per incremented target address
3c3bdf30 160 Normally one, but some DSPs have byte sizes of 16 or 32 bits. */
f6af82bd 161 unsigned int octets_per_byte;
940b2b78 162
0bcb06d2
AS
163 /* The number of zeroes we want to see at the end of a section before we
164 start skipping them. */
165 unsigned int skip_zeroes;
166
167 /* The number of zeroes to skip at the end of a section. If the number
168 of zeroes at the end is between SKIP_ZEROES_AT_END and SKIP_ZEROES,
169 they will be disassembled. If there are fewer than
170 SKIP_ZEROES_AT_END, they will be skipped. This is a heuristic
171 attempt to avoid disassembling zeroes inserted by section
172 alignment. */
173 unsigned int skip_zeroes_at_end;
174
252b5132
RH
175 /* Results from instruction decoders. Not all decoders yet support
176 this information. This info is set each time an instruction is
177 decoded, and is only valid for the last such instruction.
178
179 To determine whether this decoder supports this information, set
180 insn_info_valid to 0, decode an instruction, then check it. */
181
182 char insn_info_valid; /* Branch info has been set. */
183 char branch_delay_insns; /* How many sequential insn's will run before
184 a branch takes effect. (0 = normal) */
185 char data_size; /* Size of data reference in insn, in bytes */
186 enum dis_insn_type insn_type; /* Type of instruction */
187 bfd_vma target; /* Target address of branch or dref, if known;
188 zero if unknown. */
189 bfd_vma target2; /* Second target address for dref2 */
190
dd92f639
NC
191 /* Command line options specific to the target disassembler. */
192 char * disassembler_options;
193
252b5132
RH
194} disassemble_info;
195
196\f
197/* Standard disassemblers. Disassemble one instruction at the given
19222dc0 198 target address. Return number of octets processed. */
8cf3f354
AM
199typedef int (*disassembler_ftype) (bfd_vma, disassemble_info *);
200
201extern int print_insn_big_mips (bfd_vma, disassemble_info *);
202extern int print_insn_little_mips (bfd_vma, disassemble_info *);
203extern int print_insn_i386 (bfd_vma, disassemble_info *);
204extern int print_insn_i386_att (bfd_vma, disassemble_info *);
205extern int print_insn_i386_intel (bfd_vma, disassemble_info *);
206extern int print_insn_ia64 (bfd_vma, disassemble_info *);
207extern int print_insn_i370 (bfd_vma, disassemble_info *);
208extern int print_insn_m68hc11 (bfd_vma, disassemble_info *);
209extern int print_insn_m68hc12 (bfd_vma, disassemble_info *);
210extern int print_insn_m68k (bfd_vma, disassemble_info *);
211extern int print_insn_z8001 (bfd_vma, disassemble_info *);
212extern int print_insn_z8002 (bfd_vma, disassemble_info *);
213extern int print_insn_h8300 (bfd_vma, disassemble_info *);
214extern int print_insn_h8300h (bfd_vma, disassemble_info *);
215extern int print_insn_h8300s (bfd_vma, disassemble_info *);
216extern int print_insn_h8500 (bfd_vma, disassemble_info *);
217extern int print_insn_alpha (bfd_vma, disassemble_info *);
218extern int print_insn_big_arm (bfd_vma, disassemble_info *);
219extern int print_insn_little_arm (bfd_vma, disassemble_info *);
220extern int print_insn_sparc (bfd_vma, disassemble_info *);
221extern int print_insn_big_a29k (bfd_vma, disassemble_info *);
222extern int print_insn_little_a29k (bfd_vma, disassemble_info *);
223extern int print_insn_avr (bfd_vma, disassemble_info *);
224extern int print_insn_d10v (bfd_vma, disassemble_info *);
225extern int print_insn_d30v (bfd_vma, disassemble_info *);
226extern int print_insn_dlx (bfd_vma, disassemble_info *);
227extern int print_insn_fr30 (bfd_vma, disassemble_info *);
228extern int print_insn_hppa (bfd_vma, disassemble_info *);
229extern int print_insn_i860 (bfd_vma, disassemble_info *);
230extern int print_insn_i960 (bfd_vma, disassemble_info *);
231extern int print_insn_ip2k (bfd_vma, disassemble_info *);
232extern int print_insn_m32r (bfd_vma, disassemble_info *);
233extern int print_insn_m88k (bfd_vma, disassemble_info *);
7499d566
NC
234extern int print_insn_maxq_little (bfd_vma, disassemble_info *);
235extern int print_insn_maxq_big (bfd_vma, disassemble_info *);
8cf3f354
AM
236extern int print_insn_mcore (bfd_vma, disassemble_info *);
237extern int print_insn_mmix (bfd_vma, disassemble_info *);
238extern int print_insn_mn10200 (bfd_vma, disassemble_info *);
239extern int print_insn_mn10300 (bfd_vma, disassemble_info *);
3f1c9c12 240extern int print_insn_ms1 (bfd_vma, disassemble_info *);
8cf3f354
AM
241extern int print_insn_msp430 (bfd_vma, disassemble_info *);
242extern int print_insn_ns32k (bfd_vma, disassemble_info *);
1fe1f39c 243extern int print_insn_crx (bfd_vma, disassemble_info *);
8cf3f354
AM
244extern int print_insn_openrisc (bfd_vma, disassemble_info *);
245extern int print_insn_big_or32 (bfd_vma, disassemble_info *);
246extern int print_insn_little_or32 (bfd_vma, disassemble_info *);
247extern int print_insn_pdp11 (bfd_vma, disassemble_info *);
248extern int print_insn_pj (bfd_vma, disassemble_info *);
249extern int print_insn_big_powerpc (bfd_vma, disassemble_info *);
250extern int print_insn_little_powerpc (bfd_vma, disassemble_info *);
251extern int print_insn_rs6000 (bfd_vma, disassemble_info *);
252extern int print_insn_s390 (bfd_vma, disassemble_info *);
253extern int print_insn_sh (bfd_vma, disassemble_info *);
254extern int print_insn_tic30 (bfd_vma, disassemble_info *);
255extern int print_insn_tic4x (bfd_vma, disassemble_info *);
256extern int print_insn_tic54x (bfd_vma, disassemble_info *);
257extern int print_insn_tic80 (bfd_vma, disassemble_info *);
258extern int print_insn_v850 (bfd_vma, disassemble_info *);
259extern int print_insn_vax (bfd_vma, disassemble_info *);
260extern int print_insn_w65 (bfd_vma, disassemble_info *);
261extern int print_insn_xstormy16 (bfd_vma, disassemble_info *);
262extern int print_insn_xtensa (bfd_vma, disassemble_info *);
263extern int print_insn_sh64 (bfd_vma, disassemble_info *);
264extern int print_insn_sh64x_media (bfd_vma, disassemble_info *);
265extern int print_insn_frv (bfd_vma, disassemble_info *);
266extern int print_insn_iq2000 (bfd_vma, disassemble_info *);
267
268extern disassembler_ftype arc_get_disassembler (void *);
269extern disassembler_ftype cris_get_disassembler (bfd *);
270
271extern void print_mips_disassembler_options (FILE *);
272extern void print_ppc_disassembler_options (FILE *);
273extern void print_arm_disassembler_options (FILE *);
274extern void parse_arm_disassembler_option (char *);
275extern int get_arm_regname_num_options (void);
276extern int set_arm_regname_option (int);
6b5d3a4d 277extern int get_arm_regnames (int, const char **, const char **, const char *const **);
22a398e1 278extern bfd_boolean arm_symbol_is_valid (asymbol *, struct disassemble_info *);
dd92f639 279
252b5132 280/* Fetch the disassembler for a given BFD, if that support is available. */
8cf3f354 281extern disassembler_ftype disassembler (bfd *);
252b5132 282
22a398e1
NC
283/* Amend the disassemble_info structure as necessary for the target architecture.
284 Should only be called after initialising the info->arch field. */
285extern void disassemble_init_for_target (struct disassemble_info * info);
286
94470b23 287/* Document any target specific options available from the disassembler. */
8cf3f354 288extern void disassembler_usage (FILE *);
94470b23 289
252b5132
RH
290\f
291/* This block of definitions is for particular callers who read instructions
292 into a buffer before calling the instruction decoder. */
293
294/* Here is a function which callers may wish to use for read_memory_func.
295 It gets bytes from a buffer. */
296extern int buffer_read_memory
8cf3f354 297 (bfd_vma, bfd_byte *, unsigned int, struct disassemble_info *);
252b5132
RH
298
299/* This function goes with buffer_read_memory.
300 It prints a message using info->fprintf_func and info->stream. */
8cf3f354 301extern void perror_memory (int, bfd_vma, struct disassemble_info *);
252b5132
RH
302
303
304/* Just print the address in hex. This is included for completeness even
305 though both GDB and objdump provide their own (to print symbolic
306 addresses). */
307extern void generic_print_address
8cf3f354 308 (bfd_vma, struct disassemble_info *);
252b5132
RH
309
310/* Always true. */
311extern int generic_symbol_at_address
8cf3f354 312 (bfd_vma, struct disassemble_info *);
252b5132 313
22a398e1
NC
314/* Also always true. */
315extern bfd_boolean generic_symbol_is_valid
316 (asymbol *, struct disassemble_info *);
317
92c2346c
AC
318/* Method to initialize a disassemble_info struct. This should be
319 called by all applications creating such a struct. */
320extern void init_disassemble_info (struct disassemble_info *info, void *stream,
321 fprintf_ftype fprintf_func);
252b5132 322
92c2346c
AC
323/* For compatibility with existing code. */
324#define INIT_DISASSEMBLE_INFO(INFO, STREAM, FPRINTF_FUNC) \
325 init_disassemble_info (&(INFO), (STREAM), (fprintf_ftype) (FPRINTF_FUNC))
252b5132 326#define INIT_DISASSEMBLE_INFO_NO_ARCH(INFO, STREAM, FPRINTF_FUNC) \
92c2346c
AC
327 init_disassemble_info (&(INFO), (STREAM), (fprintf_ftype) (FPRINTF_FUNC))
328
252b5132 329
7d7a6736 330#ifdef __cplusplus
8418f5ff 331}
7d7a6736
ILT
332#endif
333
252b5132 334#endif /* ! defined (DIS_ASM_H) */
This page took 0.286064 seconds and 4 git commands to generate.