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