]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blame - include/dis-asm.h
2006-10-31 Paul Brook <paul@codesourcery.com>
[thirdparty/binutils-gdb.git] / include / dis-asm.h
CommitLineData
252b5132 1/* Interface between the opcode library and its callers.
4f1d9bd8 2
1c0d3aa6 3 Copyright 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006
c3aa17e9 4 Free Software Foundation, Inc.
d70c5fc7 5
4f1d9bd8
NC
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.
d70c5fc7 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 39
1c0d3aa6
NC
40enum dis_insn_type
41{
252b5132
RH
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
d70c5fc7 52/* This struct is passed into the instruction decoding routine,
252b5132
RH
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
1c0d3aa6
NC
62typedef struct disassemble_info
63{
252b5132 64 fprintf_ftype fprintf_func;
8cf3f354
AM
65 void *stream;
66 void *application_data;
252b5132
RH
67
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;
cadaa522
FCE
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. */
16175d96 83 void *insn_sets;
252b5132 84
ca6d9fb3
HPN
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
252b5132
RH
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
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
8cf3f354 104 void *private_data;
252b5132
RH
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)
8cf3f354
AM
112 (bfd_vma memaddr, bfd_byte *myaddr, unsigned int length,
113 struct disassemble_info *info);
252b5132
RH
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)
8cf3f354 120 (int status, bfd_vma memaddr, struct disassemble_info *info);
252b5132
RH
121
122 /* Function called to print ADDR. */
123 void (*print_address_func)
8cf3f354 124 (bfd_vma addr, struct disassemble_info *info);
252b5132
RH
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)
8cf3f354 134 (bfd_vma addr, struct disassemble_info * info);
252b5132 135
22a398e1
NC
136 /* Function called to check if a SYMBOL is can be displayed to the user.
137 This is used by some ports that want to hide special symbols when
138 displaying debugging outout. */
139 bfd_boolean (* symbol_is_valid)
140 (asymbol *, struct disassemble_info * info);
d70c5fc7 141
252b5132
RH
142 /* These are for buffer_read_memory. */
143 bfd_byte *buffer;
144 bfd_vma buffer_vma;
f6af82bd 145 unsigned int buffer_length;
252b5132
RH
146
147 /* This variable may be set by the instruction decoder. It suggests
148 the number of bytes objdump should display on a single line. If
149 the instruction decoder sets this, it should always set it to
150 the same value in order to get reasonable looking output. */
151 int bytes_per_line;
152
22a398e1 153 /* The next two variables control the way objdump displays the raw data. */
252b5132
RH
154 /* For example, if bytes_per_line is 8 and bytes_per_chunk is 4, the */
155 /* output will look like this:
156 00: 00000000 00000000
157 with the chunks displayed according to "display_endian". */
158 int bytes_per_chunk;
159 enum bfd_endian display_endian;
160
d70c5fc7 161 /* Number of octets per incremented target address
3c3bdf30 162 Normally one, but some DSPs have byte sizes of 16 or 32 bits. */
f6af82bd 163 unsigned int octets_per_byte;
940b2b78 164
0bcb06d2
AS
165 /* The number of zeroes we want to see at the end of a section before we
166 start skipping them. */
167 unsigned int skip_zeroes;
168
169 /* The number of zeroes to skip at the end of a section. If the number
170 of zeroes at the end is between SKIP_ZEROES_AT_END and SKIP_ZEROES,
171 they will be disassembled. If there are fewer than
172 SKIP_ZEROES_AT_END, they will be skipped. This is a heuristic
173 attempt to avoid disassembling zeroes inserted by section
174 alignment. */
175 unsigned int skip_zeroes_at_end;
176
d99b6465
AS
177 /* Whether the disassembler always needs the relocations. */
178 bfd_boolean disassembler_needs_relocs;
179
252b5132
RH
180 /* Results from instruction decoders. Not all decoders yet support
181 this information. This info is set each time an instruction is
182 decoded, and is only valid for the last such instruction.
183
184 To determine whether this decoder supports this information, set
185 insn_info_valid to 0, decode an instruction, then check it. */
186
187 char insn_info_valid; /* Branch info has been set. */
188 char branch_delay_insns; /* How many sequential insn's will run before
189 a branch takes effect. (0 = normal) */
190 char data_size; /* Size of data reference in insn, in bytes */
191 enum dis_insn_type insn_type; /* Type of instruction */
192 bfd_vma target; /* Target address of branch or dref, if known;
193 zero if unknown. */
194 bfd_vma target2; /* Second target address for dref2 */
195
dd92f639
NC
196 /* Command line options specific to the target disassembler. */
197 char * disassembler_options;
198
252b5132
RH
199} disassemble_info;
200
201\f
202/* Standard disassemblers. Disassemble one instruction at the given
19222dc0 203 target address. Return number of octets processed. */
8cf3f354
AM
204typedef int (*disassembler_ftype) (bfd_vma, disassemble_info *);
205
8cf3f354 206extern int print_insn_alpha (bfd_vma, disassemble_info *);
8cf3f354 207extern int print_insn_avr (bfd_vma, disassemble_info *);
dc603df5 208extern int print_insn_bfin (bfd_vma, disassemble_info *);
1c0d3aa6
NC
209extern int print_insn_big_arm (bfd_vma, disassemble_info *);
210extern int print_insn_big_mips (bfd_vma, disassemble_info *);
211extern int print_insn_big_or32 (bfd_vma, disassemble_info *);
212extern int print_insn_big_powerpc (bfd_vma, disassemble_info *);
213extern int print_insn_big_score (bfd_vma, disassemble_info *);
214extern int print_insn_crx (bfd_vma, disassemble_info *);
8cf3f354
AM
215extern int print_insn_d10v (bfd_vma, disassemble_info *);
216extern int print_insn_d30v (bfd_vma, disassemble_info *);
217extern int print_insn_dlx (bfd_vma, disassemble_info *);
218extern int print_insn_fr30 (bfd_vma, disassemble_info *);
1c0d3aa6
NC
219extern int print_insn_frv (bfd_vma, disassemble_info *);
220extern int print_insn_h8300 (bfd_vma, disassemble_info *);
221extern int print_insn_h8300h (bfd_vma, disassemble_info *);
222extern int print_insn_h8300s (bfd_vma, disassemble_info *);
223extern int print_insn_h8500 (bfd_vma, disassemble_info *);
8cf3f354 224extern int print_insn_hppa (bfd_vma, disassemble_info *);
1c0d3aa6
NC
225extern int print_insn_i370 (bfd_vma, disassemble_info *);
226extern int print_insn_i386 (bfd_vma, disassemble_info *);
227extern int print_insn_i386_att (bfd_vma, disassemble_info *);
228extern int print_insn_i386_intel (bfd_vma, disassemble_info *);
8cf3f354
AM
229extern int print_insn_i860 (bfd_vma, disassemble_info *);
230extern int print_insn_i960 (bfd_vma, disassemble_info *);
1c0d3aa6 231extern int print_insn_ia64 (bfd_vma, disassemble_info *);
8cf3f354 232extern int print_insn_ip2k (bfd_vma, disassemble_info *);
1c0d3aa6
NC
233extern int print_insn_iq2000 (bfd_vma, disassemble_info *);
234extern int print_insn_little_arm (bfd_vma, disassemble_info *);
235extern int print_insn_little_mips (bfd_vma, disassemble_info *);
236extern int print_insn_little_or32 (bfd_vma, disassemble_info *);
237extern int print_insn_little_powerpc (bfd_vma, disassemble_info *);
238extern int print_insn_little_score (bfd_vma, disassemble_info *);
239extern int print_insn_m32c (bfd_vma, disassemble_info *);
8cf3f354 240extern int print_insn_m32r (bfd_vma, disassemble_info *);
1c0d3aa6
NC
241extern int print_insn_m68hc11 (bfd_vma, disassemble_info *);
242extern int print_insn_m68hc12 (bfd_vma, disassemble_info *);
243extern int print_insn_m68k (bfd_vma, disassemble_info *);
8cf3f354 244extern int print_insn_m88k (bfd_vma, disassemble_info *);
7499d566 245extern int print_insn_maxq_big (bfd_vma, disassemble_info *);
1c0d3aa6 246extern int print_insn_maxq_little (bfd_vma, disassemble_info *);
8cf3f354
AM
247extern int print_insn_mcore (bfd_vma, disassemble_info *);
248extern int print_insn_mmix (bfd_vma, disassemble_info *);
249extern int print_insn_mn10200 (bfd_vma, disassemble_info *);
250extern int print_insn_mn10300 (bfd_vma, disassemble_info *);
251extern int print_insn_msp430 (bfd_vma, disassemble_info *);
1c0d3aa6 252extern int print_insn_mt (bfd_vma, disassemble_info *);
8cf3f354
AM
253extern int print_insn_ns32k (bfd_vma, disassemble_info *);
254extern int print_insn_openrisc (bfd_vma, disassemble_info *);
8cf3f354
AM
255extern int print_insn_pdp11 (bfd_vma, disassemble_info *);
256extern int print_insn_pj (bfd_vma, disassemble_info *);
8cf3f354 257extern int print_insn_rs6000 (bfd_vma, disassemble_info *);
d70c5fc7 258extern int print_insn_s390 (bfd_vma, disassemble_info *);
8cf3f354 259extern int print_insn_sh (bfd_vma, disassemble_info *);
1c0d3aa6
NC
260extern int print_insn_sh64 (bfd_vma, disassemble_info *);
261extern int print_insn_sh64x_media (bfd_vma, disassemble_info *);
262extern int print_insn_sparc (bfd_vma, disassemble_info *);
e9f53129 263extern int print_insn_spu (bfd_vma, disassemble_info *);
8cf3f354
AM
264extern int print_insn_tic30 (bfd_vma, disassemble_info *);
265extern int print_insn_tic4x (bfd_vma, disassemble_info *);
266extern int print_insn_tic54x (bfd_vma, disassemble_info *);
267extern int print_insn_tic80 (bfd_vma, disassemble_info *);
268extern int print_insn_v850 (bfd_vma, disassemble_info *);
269extern int print_insn_vax (bfd_vma, disassemble_info *);
270extern int print_insn_w65 (bfd_vma, disassemble_info *);
1c0d3aa6 271extern int print_insn_xc16x (bfd_vma, disassemble_info *);
8cf3f354
AM
272extern int print_insn_xstormy16 (bfd_vma, disassemble_info *);
273extern int print_insn_xtensa (bfd_vma, disassemble_info *);
1c0d3aa6
NC
274extern int print_insn_z80 (bfd_vma, disassemble_info *);
275extern int print_insn_z8001 (bfd_vma, disassemble_info *);
276extern int print_insn_z8002 (bfd_vma, disassemble_info *);
8cf3f354
AM
277
278extern disassembler_ftype arc_get_disassembler (void *);
279extern disassembler_ftype cris_get_disassembler (bfd *);
280
281extern void print_mips_disassembler_options (FILE *);
282extern void print_ppc_disassembler_options (FILE *);
283extern void print_arm_disassembler_options (FILE *);
284extern void parse_arm_disassembler_option (char *);
1c0d3aa6
NC
285extern int get_arm_regname_num_options (void);
286extern int set_arm_regname_option (int);
287extern int get_arm_regnames (int, const char **, const char **, const char *const **);
22a398e1 288extern bfd_boolean arm_symbol_is_valid (asymbol *, struct disassemble_info *);
dd92f639 289
252b5132 290/* Fetch the disassembler for a given BFD, if that support is available. */
8cf3f354 291extern disassembler_ftype disassembler (bfd *);
252b5132 292
22a398e1
NC
293/* Amend the disassemble_info structure as necessary for the target architecture.
294 Should only be called after initialising the info->arch field. */
295extern void disassemble_init_for_target (struct disassemble_info * info);
296
94470b23 297/* Document any target specific options available from the disassembler. */
8cf3f354 298extern void disassembler_usage (FILE *);
94470b23 299
252b5132
RH
300\f
301/* This block of definitions is for particular callers who read instructions
302 into a buffer before calling the instruction decoder. */
303
304/* Here is a function which callers may wish to use for read_memory_func.
305 It gets bytes from a buffer. */
306extern int buffer_read_memory
8cf3f354 307 (bfd_vma, bfd_byte *, unsigned int, struct disassemble_info *);
252b5132
RH
308
309/* This function goes with buffer_read_memory.
310 It prints a message using info->fprintf_func and info->stream. */
8cf3f354 311extern void perror_memory (int, bfd_vma, struct disassemble_info *);
252b5132
RH
312
313
314/* Just print the address in hex. This is included for completeness even
315 though both GDB and objdump provide their own (to print symbolic
316 addresses). */
317extern void generic_print_address
8cf3f354 318 (bfd_vma, struct disassemble_info *);
252b5132
RH
319
320/* Always true. */
321extern int generic_symbol_at_address
8cf3f354 322 (bfd_vma, struct disassemble_info *);
252b5132 323
d70c5fc7 324/* Also always true. */
22a398e1
NC
325extern bfd_boolean generic_symbol_is_valid
326 (asymbol *, struct disassemble_info *);
d70c5fc7 327
92c2346c
AC
328/* Method to initialize a disassemble_info struct. This should be
329 called by all applications creating such a struct. */
330extern void init_disassemble_info (struct disassemble_info *info, void *stream,
331 fprintf_ftype fprintf_func);
252b5132 332
92c2346c
AC
333/* For compatibility with existing code. */
334#define INIT_DISASSEMBLE_INFO(INFO, STREAM, FPRINTF_FUNC) \
335 init_disassemble_info (&(INFO), (STREAM), (fprintf_ftype) (FPRINTF_FUNC))
252b5132 336#define INIT_DISASSEMBLE_INFO_NO_ARCH(INFO, STREAM, FPRINTF_FUNC) \
92c2346c
AC
337 init_disassemble_info (&(INFO), (STREAM), (fprintf_ftype) (FPRINTF_FUNC))
338
252b5132 339
7d7a6736 340#ifdef __cplusplus
8418f5ff 341}
7d7a6736
ILT
342#endif
343
252b5132 344#endif /* ! defined (DIS_ASM_H) */