root / dis-asm.h @ b03c60f3
History | View | Annotate | Download (10.4 kB)
1 |
/* Interface between the opcode library and its callers.
|
---|---|
2 |
Written by Cygnus Support, 1993.
|
3 |
|
4 |
The opcode library (libopcodes.a) provides instruction decoders for
|
5 |
a large variety of instruction sets, callable with an identical
|
6 |
interface, for making instruction-processing programs more independent
|
7 |
of the instruction set being processed. */
|
8 |
|
9 |
#ifndef DIS_ASM_H
|
10 |
#define DIS_ASM_H
|
11 |
|
12 |
#include <stdio.h> |
13 |
#include <string.h> |
14 |
#include "bfd.h" |
15 |
|
16 |
typedef int (*fprintf_ftype) PARAMS((FILE*, const char*, ...)); |
17 |
|
18 |
enum dis_insn_type {
|
19 |
dis_noninsn, /* Not a valid instruction */
|
20 |
dis_nonbranch, /* Not a branch instruction */
|
21 |
dis_branch, /* Unconditional branch */
|
22 |
dis_condbranch, /* Conditional branch */
|
23 |
dis_jsr, /* Jump to subroutine */
|
24 |
dis_condjsr, /* Conditional jump to subroutine */
|
25 |
dis_dref, /* Data reference instruction */
|
26 |
dis_dref2 /* Two data references in instruction */
|
27 |
}; |
28 |
|
29 |
/* This struct is passed into the instruction decoding routine,
|
30 |
and is passed back out into each callback. The various fields are used
|
31 |
for conveying information from your main routine into your callbacks,
|
32 |
for passing information into the instruction decoders (such as the
|
33 |
addresses of the callback functions), or for passing information
|
34 |
back from the instruction decoders to their callers.
|
35 |
|
36 |
It must be initialized before it is first passed; this can be done
|
37 |
by hand, or using one of the initialization macros below. */
|
38 |
|
39 |
typedef struct disassemble_info { |
40 |
fprintf_ftype fprintf_func; |
41 |
FILE *stream; |
42 |
PTR application_data; |
43 |
|
44 |
/* Target description. We could replace this with a pointer to the bfd,
|
45 |
but that would require one. There currently isn't any such requirement
|
46 |
so to avoid introducing one we record these explicitly. */
|
47 |
/* The bfd_flavour. This can be bfd_target_unknown_flavour. */
|
48 |
enum bfd_flavour flavour;
|
49 |
/* The bfd_arch value. */
|
50 |
enum bfd_architecture arch;
|
51 |
/* The bfd_mach value. */
|
52 |
unsigned long mach; |
53 |
/* Endianness (for bi-endian cpus). Mono-endian cpus can ignore this. */
|
54 |
enum bfd_endian endian;
|
55 |
|
56 |
/* An array of pointers to symbols either at the location being disassembled
|
57 |
or at the start of the function being disassembled. The array is sorted
|
58 |
so that the first symbol is intended to be the one used. The others are
|
59 |
present for any misc. purposes. This is not set reliably, but if it is
|
60 |
not NULL, it is correct. */
|
61 |
asymbol **symbols; |
62 |
/* Number of symbols in array. */
|
63 |
int num_symbols;
|
64 |
|
65 |
/* For use by the disassembler.
|
66 |
The top 16 bits are reserved for public use (and are documented here).
|
67 |
The bottom 16 bits are for the internal use of the disassembler. */
|
68 |
unsigned long flags; |
69 |
#define INSN_HAS_RELOC 0x80000000 |
70 |
PTR private_data; |
71 |
|
72 |
/* Function used to get bytes to disassemble. MEMADDR is the
|
73 |
address of the stuff to be disassembled, MYADDR is the address to
|
74 |
put the bytes in, and LENGTH is the number of bytes to read.
|
75 |
INFO is a pointer to this struct.
|
76 |
Returns an errno value or 0 for success. */
|
77 |
int (*read_memory_func)
|
78 |
PARAMS ((bfd_vma memaddr, bfd_byte *myaddr, int length,
|
79 |
struct disassemble_info *info));
|
80 |
|
81 |
/* Function which should be called if we get an error that we can't
|
82 |
recover from. STATUS is the errno value from read_memory_func and
|
83 |
MEMADDR is the address that we were trying to read. INFO is a
|
84 |
pointer to this struct. */
|
85 |
void (*memory_error_func)
|
86 |
PARAMS ((int status, bfd_vma memaddr, struct disassemble_info *info)); |
87 |
|
88 |
/* Function called to print ADDR. */
|
89 |
void (*print_address_func)
|
90 |
PARAMS ((bfd_vma addr, struct disassemble_info *info));
|
91 |
|
92 |
/* Function called to determine if there is a symbol at the given ADDR.
|
93 |
If there is, the function returns 1, otherwise it returns 0.
|
94 |
This is used by ports which support an overlay manager where
|
95 |
the overlay number is held in the top part of an address. In
|
96 |
some circumstances we want to include the overlay number in the
|
97 |
address, (normally because there is a symbol associated with
|
98 |
that address), but sometimes we want to mask out the overlay bits. */
|
99 |
int (* symbol_at_address_func)
|
100 |
PARAMS ((bfd_vma addr, struct disassemble_info * info));
|
101 |
|
102 |
/* These are for buffer_read_memory. */
|
103 |
bfd_byte *buffer; |
104 |
bfd_vma buffer_vma; |
105 |
int buffer_length;
|
106 |
|
107 |
/* This variable may be set by the instruction decoder. It suggests
|
108 |
the number of bytes objdump should display on a single line. If
|
109 |
the instruction decoder sets this, it should always set it to
|
110 |
the same value in order to get reasonable looking output. */
|
111 |
int bytes_per_line;
|
112 |
|
113 |
/* the next two variables control the way objdump displays the raw data */
|
114 |
/* For example, if bytes_per_line is 8 and bytes_per_chunk is 4, the */
|
115 |
/* output will look like this:
|
116 |
00: 00000000 00000000
|
117 |
with the chunks displayed according to "display_endian". */
|
118 |
int bytes_per_chunk;
|
119 |
enum bfd_endian display_endian;
|
120 |
|
121 |
/* Results from instruction decoders. Not all decoders yet support
|
122 |
this information. This info is set each time an instruction is
|
123 |
decoded, and is only valid for the last such instruction.
|
124 |
|
125 |
To determine whether this decoder supports this information, set
|
126 |
insn_info_valid to 0, decode an instruction, then check it. */
|
127 |
|
128 |
char insn_info_valid; /* Branch info has been set. */ |
129 |
char branch_delay_insns; /* How many sequential insn's will run before |
130 |
a branch takes effect. (0 = normal) */
|
131 |
char data_size; /* Size of data reference in insn, in bytes */ |
132 |
enum dis_insn_type insn_type; /* Type of instruction */ |
133 |
bfd_vma target; /* Target address of branch or dref, if known;
|
134 |
zero if unknown. */
|
135 |
bfd_vma target2; /* Second target address for dref2 */
|
136 |
|
137 |
} disassemble_info; |
138 |
|
139 |
|
140 |
/* Standard disassemblers. Disassemble one instruction at the given
|
141 |
target address. Return number of bytes processed. */
|
142 |
typedef int (*disassembler_ftype) |
143 |
PARAMS((bfd_vma, disassemble_info *)); |
144 |
|
145 |
extern int print_insn_big_mips PARAMS ((bfd_vma, disassemble_info*)); |
146 |
extern int print_insn_little_mips PARAMS ((bfd_vma, disassemble_info*)); |
147 |
extern int print_insn_i386 PARAMS ((bfd_vma, disassemble_info*)); |
148 |
extern int print_insn_m68k PARAMS ((bfd_vma, disassemble_info*)); |
149 |
extern int print_insn_z8001 PARAMS ((bfd_vma, disassemble_info*)); |
150 |
extern int print_insn_z8002 PARAMS ((bfd_vma, disassemble_info*)); |
151 |
extern int print_insn_h8300 PARAMS ((bfd_vma, disassemble_info*)); |
152 |
extern int print_insn_h8300h PARAMS ((bfd_vma, disassemble_info*)); |
153 |
extern int print_insn_h8300s PARAMS ((bfd_vma, disassemble_info*)); |
154 |
extern int print_insn_h8500 PARAMS ((bfd_vma, disassemble_info*)); |
155 |
extern int print_insn_alpha PARAMS ((bfd_vma, disassemble_info*)); |
156 |
extern disassembler_ftype arc_get_disassembler PARAMS ((int, int)); |
157 |
extern int print_insn_big_arm PARAMS ((bfd_vma, disassemble_info*)); |
158 |
extern int print_insn_little_arm PARAMS ((bfd_vma, disassemble_info*)); |
159 |
extern int print_insn_sparc PARAMS ((bfd_vma, disassemble_info*)); |
160 |
extern int print_insn_big_a29k PARAMS ((bfd_vma, disassemble_info*)); |
161 |
extern int print_insn_little_a29k PARAMS ((bfd_vma, disassemble_info*)); |
162 |
extern int print_insn_i960 PARAMS ((bfd_vma, disassemble_info*)); |
163 |
extern int print_insn_sh PARAMS ((bfd_vma, disassemble_info*)); |
164 |
extern int print_insn_shl PARAMS ((bfd_vma, disassemble_info*)); |
165 |
extern int print_insn_hppa PARAMS ((bfd_vma, disassemble_info*)); |
166 |
extern int print_insn_m32r PARAMS ((bfd_vma, disassemble_info*)); |
167 |
extern int print_insn_m88k PARAMS ((bfd_vma, disassemble_info*)); |
168 |
extern int print_insn_mn10200 PARAMS ((bfd_vma, disassemble_info*)); |
169 |
extern int print_insn_mn10300 PARAMS ((bfd_vma, disassemble_info*)); |
170 |
extern int print_insn_ns32k PARAMS ((bfd_vma, disassemble_info*)); |
171 |
extern int print_insn_big_powerpc PARAMS ((bfd_vma, disassemble_info*)); |
172 |
extern int print_insn_little_powerpc PARAMS ((bfd_vma, disassemble_info*)); |
173 |
extern int print_insn_rs6000 PARAMS ((bfd_vma, disassemble_info*)); |
174 |
extern int print_insn_w65 PARAMS ((bfd_vma, disassemble_info*)); |
175 |
extern int print_insn_d10v PARAMS ((bfd_vma, disassemble_info*)); |
176 |
extern int print_insn_v850 PARAMS ((bfd_vma, disassemble_info*)); |
177 |
extern int print_insn_tic30 PARAMS ((bfd_vma, disassemble_info*)); |
178 |
|
179 |
/* Fetch the disassembler for a given BFD, if that support is available. */
|
180 |
extern disassembler_ftype disassembler PARAMS ((bfd *));
|
181 |
|
182 |
|
183 |
/* This block of definitions is for particular callers who read instructions
|
184 |
into a buffer before calling the instruction decoder. */
|
185 |
|
186 |
/* Here is a function which callers may wish to use for read_memory_func.
|
187 |
It gets bytes from a buffer. */
|
188 |
extern int buffer_read_memory |
189 |
PARAMS ((bfd_vma, bfd_byte *, int, struct disassemble_info *)); |
190 |
|
191 |
/* This function goes with buffer_read_memory.
|
192 |
It prints a message using info->fprintf_func and info->stream. */
|
193 |
extern void perror_memory PARAMS ((int, bfd_vma, struct disassemble_info *)); |
194 |
|
195 |
|
196 |
/* Just print the address in hex. This is included for completeness even
|
197 |
though both GDB and objdump provide their own (to print symbolic
|
198 |
addresses). */
|
199 |
extern void generic_print_address |
200 |
PARAMS ((bfd_vma, struct disassemble_info *));
|
201 |
|
202 |
/* Always true. */
|
203 |
extern int generic_symbol_at_address |
204 |
PARAMS ((bfd_vma, struct disassemble_info *));
|
205 |
|
206 |
/* Macro to initialize a disassemble_info struct. This should be called
|
207 |
by all applications creating such a struct. */
|
208 |
#define INIT_DISASSEMBLE_INFO(INFO, STREAM, FPRINTF_FUNC) \
|
209 |
(INFO).flavour = bfd_target_unknown_flavour, \ |
210 |
(INFO).arch = bfd_arch_unknown, \ |
211 |
(INFO).mach = 0, \
|
212 |
(INFO).endian = BFD_ENDIAN_UNKNOWN, \ |
213 |
INIT_DISASSEMBLE_INFO_NO_ARCH(INFO, STREAM, FPRINTF_FUNC) |
214 |
|
215 |
/* Call this macro to initialize only the internal variables for the
|
216 |
disassembler. Architecture dependent things such as byte order, or machine
|
217 |
variant are not touched by this macro. This makes things much easier for
|
218 |
GDB which must initialize these things seperatly. */
|
219 |
|
220 |
#define INIT_DISASSEMBLE_INFO_NO_ARCH(INFO, STREAM, FPRINTF_FUNC) \
|
221 |
(INFO).fprintf_func = (FPRINTF_FUNC), \ |
222 |
(INFO).stream = (STREAM), \ |
223 |
(INFO).symbols = NULL, \
|
224 |
(INFO).num_symbols = 0, \
|
225 |
(INFO).buffer = NULL, \
|
226 |
(INFO).buffer_vma = 0, \
|
227 |
(INFO).buffer_length = 0, \
|
228 |
(INFO).read_memory_func = buffer_read_memory, \ |
229 |
(INFO).memory_error_func = perror_memory, \ |
230 |
(INFO).print_address_func = generic_print_address, \ |
231 |
(INFO).symbol_at_address_func = generic_symbol_at_address, \ |
232 |
(INFO).flags = 0, \
|
233 |
(INFO).bytes_per_line = 0, \
|
234 |
(INFO).bytes_per_chunk = 0, \
|
235 |
(INFO).display_endian = BFD_ENDIAN_UNKNOWN, \ |
236 |
(INFO).insn_info_valid = 0
|
237 |
|
238 |
#endif /* ! defined (DIS_ASM_H) */ |