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