Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 410 lines (360 sloc) 16.44 kb
dc99065 added flags computation optimization
bellard authored
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
c27004e 64 bit target support
bellard authored
12 #include <stdlib.h>
dc99065 added flags computation optimization
bellard authored
13 #include <stdio.h>
04369ff ppc port
bellard authored
14 #include <string.h>
43d4145 bfd.h dependancy removed
bellard authored
15 #include <inttypes.h>
16
17 #define PARAMS(x) x
18 typedef void *PTR;
19 typedef uint64_t bfd_vma;
bc51c5c initial x86-64 host support (Gwenole Beauchesne)
bellard authored
20 typedef int64_t bfd_signed_vma;
43d4145 bfd.h dependancy removed
bellard authored
21 typedef uint8_t bfd_byte;
bc51c5c initial x86-64 host support (Gwenole Beauchesne)
bellard authored
22 #define sprintf_vma(s,x) sprintf (s, "%0" PRIx64, x)
43d4145 bfd.h dependancy removed
bellard authored
23
c27004e 64 bit target support
bellard authored
24 #define BFD64
25
43d4145 bfd.h dependancy removed
bellard authored
26 enum bfd_flavour {
27 bfd_target_unknown_flavour,
28 bfd_target_aout_flavour,
29 bfd_target_coff_flavour,
30 bfd_target_ecoff_flavour,
31 bfd_target_elf_flavour,
32 bfd_target_ieee_flavour,
33 bfd_target_nlm_flavour,
34 bfd_target_oasys_flavour,
35 bfd_target_tekhex_flavour,
36 bfd_target_srec_flavour,
37 bfd_target_ihex_flavour,
38 bfd_target_som_flavour,
39 bfd_target_os9k_flavour,
40 bfd_target_versados_flavour,
41 bfd_target_msdos_flavour,
42 bfd_target_evax_flavour
43 };
44
45 enum bfd_endian { BFD_ENDIAN_BIG, BFD_ENDIAN_LITTLE, BFD_ENDIAN_UNKNOWN };
46
47 enum bfd_architecture
48 {
49 bfd_arch_unknown, /* File arch not known */
50 bfd_arch_obscure, /* Arch known, not one of these */
51 bfd_arch_m68k, /* Motorola 68xxx */
52 #define bfd_mach_m68000 1
53 #define bfd_mach_m68008 2
54 #define bfd_mach_m68010 3
55 #define bfd_mach_m68020 4
56 #define bfd_mach_m68030 5
57 #define bfd_mach_m68040 6
58 #define bfd_mach_m68060 7
59 bfd_arch_vax, /* DEC Vax */
60 bfd_arch_i960, /* Intel 960 */
61 /* The order of the following is important.
62 lower number indicates a machine type that
63 only accepts a subset of the instructions
64 available to machines with higher numbers.
65 The exception is the "ca", which is
66 incompatible with all other machines except
67 "core". */
68
69 #define bfd_mach_i960_core 1
70 #define bfd_mach_i960_ka_sa 2
71 #define bfd_mach_i960_kb_sb 3
72 #define bfd_mach_i960_mc 4
73 #define bfd_mach_i960_xa 5
74 #define bfd_mach_i960_ca 6
75 #define bfd_mach_i960_jx 7
76 #define bfd_mach_i960_hx 8
77
78 bfd_arch_a29k, /* AMD 29000 */
79 bfd_arch_sparc, /* SPARC */
80 #define bfd_mach_sparc 1
aa0aa4f added ARM and Sparc disassemblers
bellard authored
81 /* The difference between v8plus and v9 is that v9 is a true 64 bit env. */
43d4145 bfd.h dependancy removed
bellard authored
82 #define bfd_mach_sparc_sparclet 2
83 #define bfd_mach_sparc_sparclite 3
84 #define bfd_mach_sparc_v8plus 4
aa0aa4f added ARM and Sparc disassemblers
bellard authored
85 #define bfd_mach_sparc_v8plusa 5 /* with ultrasparc add'ns. */
86 #define bfd_mach_sparc_sparclite_le 6
87 #define bfd_mach_sparc_v9 7
88 #define bfd_mach_sparc_v9a 8 /* with ultrasparc add'ns. */
89 #define bfd_mach_sparc_v8plusb 9 /* with cheetah add'ns. */
90 #define bfd_mach_sparc_v9b 10 /* with cheetah add'ns. */
91 /* Nonzero if MACH has the v9 instruction set. */
43d4145 bfd.h dependancy removed
bellard authored
92 #define bfd_mach_sparc_v9_p(mach) \
aa0aa4f added ARM and Sparc disassemblers
bellard authored
93 ((mach) >= bfd_mach_sparc_v8plus && (mach) <= bfd_mach_sparc_v9b \
94 && (mach) != bfd_mach_sparc_sparclite_le)
43d4145 bfd.h dependancy removed
bellard authored
95 bfd_arch_mips, /* MIPS Rxxxx */
96 #define bfd_mach_mips3000 3000
97 #define bfd_mach_mips3900 3900
98 #define bfd_mach_mips4000 4000
99 #define bfd_mach_mips4010 4010
100 #define bfd_mach_mips4100 4100
101 #define bfd_mach_mips4300 4300
102 #define bfd_mach_mips4400 4400
103 #define bfd_mach_mips4600 4600
104 #define bfd_mach_mips4650 4650
105 #define bfd_mach_mips5000 5000
106 #define bfd_mach_mips6000 6000
107 #define bfd_mach_mips8000 8000
108 #define bfd_mach_mips10000 10000
109 #define bfd_mach_mips16 16
110 bfd_arch_i386, /* Intel 386 */
111 #define bfd_mach_i386_i386 0
112 #define bfd_mach_i386_i8086 1
bc51c5c initial x86-64 host support (Gwenole Beauchesne)
bellard authored
113 #define bfd_mach_i386_i386_intel_syntax 2
114 #define bfd_mach_x86_64 3
115 #define bfd_mach_x86_64_intel_syntax 4
43d4145 bfd.h dependancy removed
bellard authored
116 bfd_arch_we32k, /* AT&T WE32xxx */
117 bfd_arch_tahoe, /* CCI/Harris Tahoe */
118 bfd_arch_i860, /* Intel 860 */
119 bfd_arch_romp, /* IBM ROMP PC/RT */
120 bfd_arch_alliant, /* Alliant */
121 bfd_arch_convex, /* Convex */
122 bfd_arch_m88k, /* Motorola 88xxx */
123 bfd_arch_pyramid, /* Pyramid Technology */
124 bfd_arch_h8300, /* Hitachi H8/300 */
125 #define bfd_mach_h8300 1
126 #define bfd_mach_h8300h 2
127 #define bfd_mach_h8300s 3
128 bfd_arch_powerpc, /* PowerPC */
129 bfd_arch_rs6000, /* IBM RS/6000 */
130 bfd_arch_hppa, /* HP PA RISC */
131 bfd_arch_d10v, /* Mitsubishi D10V */
132 bfd_arch_z8k, /* Zilog Z8000 */
133 #define bfd_mach_z8001 1
134 #define bfd_mach_z8002 2
135 bfd_arch_h8500, /* Hitachi H8/500 */
136 bfd_arch_sh, /* Hitachi SH */
137 #define bfd_mach_sh 0
138 #define bfd_mach_sh3 0x30
139 #define bfd_mach_sh3e 0x3e
140 #define bfd_mach_sh4 0x40
141 bfd_arch_alpha, /* Dec Alpha */
142 bfd_arch_arm, /* Advanced Risc Machines ARM */
143 #define bfd_mach_arm_2 1
144 #define bfd_mach_arm_2a 2
145 #define bfd_mach_arm_3 3
146 #define bfd_mach_arm_3M 4
147 #define bfd_mach_arm_4 5
148 #define bfd_mach_arm_4T 6
149 bfd_arch_ns32k, /* National Semiconductors ns32000 */
150 bfd_arch_w65, /* WDC 65816 */
151 bfd_arch_tic30, /* Texas Instruments TMS320C30 */
152 bfd_arch_v850, /* NEC V850 */
153 #define bfd_mach_v850 0
154 bfd_arch_arc, /* Argonaut RISC Core */
155 #define bfd_mach_arc_base 0
156 bfd_arch_m32r, /* Mitsubishi M32R/D */
157 #define bfd_mach_m32r 0 /* backwards compatibility */
158 bfd_arch_mn10200, /* Matsushita MN10200 */
159 bfd_arch_mn10300, /* Matsushita MN10300 */
160 bfd_arch_last
161 };
162
163 typedef struct symbol_cache_entry
164 {
165 const char *name;
166 union
167 {
168 PTR p;
169 bfd_vma i;
170 } udata;
171 } asymbol;
dc99065 added flags computation optimization
bellard authored
172
173 typedef int (*fprintf_ftype) PARAMS((FILE*, const char*, ...));
174
175 enum dis_insn_type {
176 dis_noninsn, /* Not a valid instruction */
177 dis_nonbranch, /* Not a branch instruction */
178 dis_branch, /* Unconditional branch */
179 dis_condbranch, /* Conditional branch */
180 dis_jsr, /* Jump to subroutine */
181 dis_condjsr, /* Conditional jump to subroutine */
182 dis_dref, /* Data reference instruction */
183 dis_dref2 /* Two data references in instruction */
184 };
185
186 /* This struct is passed into the instruction decoding routine,
187 and is passed back out into each callback. The various fields are used
188 for conveying information from your main routine into your callbacks,
189 for passing information into the instruction decoders (such as the
190 addresses of the callback functions), or for passing information
191 back from the instruction decoders to their callers.
192
193 It must be initialized before it is first passed; this can be done
194 by hand, or using one of the initialization macros below. */
195
196 typedef struct disassemble_info {
197 fprintf_ftype fprintf_func;
198 FILE *stream;
199 PTR application_data;
200
201 /* Target description. We could replace this with a pointer to the bfd,
202 but that would require one. There currently isn't any such requirement
203 so to avoid introducing one we record these explicitly. */
204 /* The bfd_flavour. This can be bfd_target_unknown_flavour. */
205 enum bfd_flavour flavour;
206 /* The bfd_arch value. */
207 enum bfd_architecture arch;
208 /* The bfd_mach value. */
209 unsigned long mach;
210 /* Endianness (for bi-endian cpus). Mono-endian cpus can ignore this. */
211 enum bfd_endian endian;
212
213 /* An array of pointers to symbols either at the location being disassembled
214 or at the start of the function being disassembled. The array is sorted
215 so that the first symbol is intended to be the one used. The others are
216 present for any misc. purposes. This is not set reliably, but if it is
217 not NULL, it is correct. */
218 asymbol **symbols;
219 /* Number of symbols in array. */
220 int num_symbols;
221
222 /* For use by the disassembler.
223 The top 16 bits are reserved for public use (and are documented here).
224 The bottom 16 bits are for the internal use of the disassembler. */
225 unsigned long flags;
226 #define INSN_HAS_RELOC 0x80000000
227 PTR private_data;
228
229 /* Function used to get bytes to disassemble. MEMADDR is the
230 address of the stuff to be disassembled, MYADDR is the address to
231 put the bytes in, and LENGTH is the number of bytes to read.
232 INFO is a pointer to this struct.
233 Returns an errno value or 0 for success. */
234 int (*read_memory_func)
235 PARAMS ((bfd_vma memaddr, bfd_byte *myaddr, int length,
236 struct disassemble_info *info));
237
238 /* Function which should be called if we get an error that we can't
239 recover from. STATUS is the errno value from read_memory_func and
240 MEMADDR is the address that we were trying to read. INFO is a
241 pointer to this struct. */
242 void (*memory_error_func)
243 PARAMS ((int status, bfd_vma memaddr, struct disassemble_info *info));
244
245 /* Function called to print ADDR. */
246 void (*print_address_func)
247 PARAMS ((bfd_vma addr, struct disassemble_info *info));
248
249 /* Function called to determine if there is a symbol at the given ADDR.
250 If there is, the function returns 1, otherwise it returns 0.
251 This is used by ports which support an overlay manager where
252 the overlay number is held in the top part of an address. In
253 some circumstances we want to include the overlay number in the
254 address, (normally because there is a symbol associated with
255 that address), but sometimes we want to mask out the overlay bits. */
256 int (* symbol_at_address_func)
257 PARAMS ((bfd_vma addr, struct disassemble_info * info));
258
259 /* These are for buffer_read_memory. */
260 bfd_byte *buffer;
261 bfd_vma buffer_vma;
262 int buffer_length;
263
264 /* This variable may be set by the instruction decoder. It suggests
265 the number of bytes objdump should display on a single line. If
266 the instruction decoder sets this, it should always set it to
267 the same value in order to get reasonable looking output. */
268 int bytes_per_line;
269
270 /* the next two variables control the way objdump displays the raw data */
271 /* For example, if bytes_per_line is 8 and bytes_per_chunk is 4, the */
272 /* output will look like this:
273 00: 00000000 00000000
274 with the chunks displayed according to "display_endian". */
275 int bytes_per_chunk;
276 enum bfd_endian display_endian;
277
278 /* Results from instruction decoders. Not all decoders yet support
279 this information. This info is set each time an instruction is
280 decoded, and is only valid for the last such instruction.
281
282 To determine whether this decoder supports this information, set
283 insn_info_valid to 0, decode an instruction, then check it. */
284
285 char insn_info_valid; /* Branch info has been set. */
286 char branch_delay_insns; /* How many sequential insn's will run before
287 a branch takes effect. (0 = normal) */
288 char data_size; /* Size of data reference in insn, in bytes */
289 enum dis_insn_type insn_type; /* Type of instruction */
290 bfd_vma target; /* Target address of branch or dref, if known;
291 zero if unknown. */
292 bfd_vma target2; /* Second target address for dref2 */
293
aa0aa4f added ARM and Sparc disassemblers
bellard authored
294 /* Command line options specific to the target disassembler. */
295 char * disassembler_options;
296
dc99065 added flags computation optimization
bellard authored
297 } disassemble_info;
298
299
300 /* Standard disassemblers. Disassemble one instruction at the given
301 target address. Return number of bytes processed. */
302 typedef int (*disassembler_ftype)
303 PARAMS((bfd_vma, disassemble_info *));
304
305 extern int print_insn_big_mips PARAMS ((bfd_vma, disassemble_info*));
306 extern int print_insn_little_mips PARAMS ((bfd_vma, disassemble_info*));
307 extern int print_insn_i386 PARAMS ((bfd_vma, disassemble_info*));
308 extern int print_insn_m68k PARAMS ((bfd_vma, disassemble_info*));
309 extern int print_insn_z8001 PARAMS ((bfd_vma, disassemble_info*));
310 extern int print_insn_z8002 PARAMS ((bfd_vma, disassemble_info*));
311 extern int print_insn_h8300 PARAMS ((bfd_vma, disassemble_info*));
312 extern int print_insn_h8300h PARAMS ((bfd_vma, disassemble_info*));
313 extern int print_insn_h8300s PARAMS ((bfd_vma, disassemble_info*));
314 extern int print_insn_h8500 PARAMS ((bfd_vma, disassemble_info*));
315 extern int print_insn_alpha PARAMS ((bfd_vma, disassemble_info*));
316 extern disassembler_ftype arc_get_disassembler PARAMS ((int, int));
aa0aa4f added ARM and Sparc disassemblers
bellard authored
317 extern int print_insn_arm PARAMS ((bfd_vma, disassemble_info*));
dc99065 added flags computation optimization
bellard authored
318 extern int print_insn_sparc PARAMS ((bfd_vma, disassemble_info*));
319 extern int print_insn_big_a29k PARAMS ((bfd_vma, disassemble_info*));
320 extern int print_insn_little_a29k PARAMS ((bfd_vma, disassemble_info*));
321 extern int print_insn_i960 PARAMS ((bfd_vma, disassemble_info*));
322 extern int print_insn_sh PARAMS ((bfd_vma, disassemble_info*));
323 extern int print_insn_shl PARAMS ((bfd_vma, disassemble_info*));
324 extern int print_insn_hppa PARAMS ((bfd_vma, disassemble_info*));
325 extern int print_insn_m32r PARAMS ((bfd_vma, disassemble_info*));
326 extern int print_insn_m88k PARAMS ((bfd_vma, disassemble_info*));
327 extern int print_insn_mn10200 PARAMS ((bfd_vma, disassemble_info*));
328 extern int print_insn_mn10300 PARAMS ((bfd_vma, disassemble_info*));
329 extern int print_insn_ns32k PARAMS ((bfd_vma, disassemble_info*));
330 extern int print_insn_big_powerpc PARAMS ((bfd_vma, disassemble_info*));
331 extern int print_insn_little_powerpc PARAMS ((bfd_vma, disassemble_info*));
332 extern int print_insn_rs6000 PARAMS ((bfd_vma, disassemble_info*));
333 extern int print_insn_w65 PARAMS ((bfd_vma, disassemble_info*));
334 extern int print_insn_d10v PARAMS ((bfd_vma, disassemble_info*));
335 extern int print_insn_v850 PARAMS ((bfd_vma, disassemble_info*));
336 extern int print_insn_tic30 PARAMS ((bfd_vma, disassemble_info*));
b9adb4a PowerPC disas code
bellard authored
337 extern int print_insn_ppc PARAMS ((bfd_vma, disassemble_info*));
dc99065 added flags computation optimization
bellard authored
338
43d4145 bfd.h dependancy removed
bellard authored
339 #if 0
dc99065 added flags computation optimization
bellard authored
340 /* Fetch the disassembler for a given BFD, if that support is available. */
341 extern disassembler_ftype disassembler PARAMS ((bfd *));
43d4145 bfd.h dependancy removed
bellard authored
342 #endif
dc99065 added flags computation optimization
bellard authored
343
344
345 /* This block of definitions is for particular callers who read instructions
346 into a buffer before calling the instruction decoder. */
347
348 /* Here is a function which callers may wish to use for read_memory_func.
349 It gets bytes from a buffer. */
350 extern int buffer_read_memory
351 PARAMS ((bfd_vma, bfd_byte *, int, struct disassemble_info *));
352
353 /* This function goes with buffer_read_memory.
354 It prints a message using info->fprintf_func and info->stream. */
355 extern void perror_memory PARAMS ((int, bfd_vma, struct disassemble_info *));
356
357
358 /* Just print the address in hex. This is included for completeness even
359 though both GDB and objdump provide their own (to print symbolic
360 addresses). */
361 extern void generic_print_address
362 PARAMS ((bfd_vma, struct disassemble_info *));
363
364 /* Always true. */
365 extern int generic_symbol_at_address
366 PARAMS ((bfd_vma, struct disassemble_info *));
367
368 /* Macro to initialize a disassemble_info struct. This should be called
369 by all applications creating such a struct. */
370 #define INIT_DISASSEMBLE_INFO(INFO, STREAM, FPRINTF_FUNC) \
371 (INFO).flavour = bfd_target_unknown_flavour, \
372 (INFO).arch = bfd_arch_unknown, \
373 (INFO).mach = 0, \
374 (INFO).endian = BFD_ENDIAN_UNKNOWN, \
375 INIT_DISASSEMBLE_INFO_NO_ARCH(INFO, STREAM, FPRINTF_FUNC)
376
377 /* Call this macro to initialize only the internal variables for the
378 disassembler. Architecture dependent things such as byte order, or machine
379 variant are not touched by this macro. This makes things much easier for
380 GDB which must initialize these things seperatly. */
381
382 #define INIT_DISASSEMBLE_INFO_NO_ARCH(INFO, STREAM, FPRINTF_FUNC) \
383 (INFO).fprintf_func = (FPRINTF_FUNC), \
384 (INFO).stream = (STREAM), \
385 (INFO).symbols = NULL, \
386 (INFO).num_symbols = 0, \
387 (INFO).buffer = NULL, \
388 (INFO).buffer_vma = 0, \
389 (INFO).buffer_length = 0, \
390 (INFO).read_memory_func = buffer_read_memory, \
391 (INFO).memory_error_func = perror_memory, \
392 (INFO).print_address_func = generic_print_address, \
393 (INFO).symbol_at_address_func = generic_symbol_at_address, \
394 (INFO).flags = 0, \
395 (INFO).bytes_per_line = 0, \
396 (INFO).bytes_per_chunk = 0, \
397 (INFO).display_endian = BFD_ENDIAN_UNKNOWN, \
aa0aa4f added ARM and Sparc disassemblers
bellard authored
398 (INFO).disassembler_options = NULL, \
dc99065 added flags computation optimization
bellard authored
399 (INFO).insn_info_valid = 0
400
aa0aa4f added ARM and Sparc disassemblers
bellard authored
401 #define _(x) x
402
403 /* from libbfd */
404
405 bfd_vma bfd_getl32 (const bfd_byte *addr);
406 bfd_vma bfd_getb32 (const bfd_byte *addr);
407 typedef enum bfd_boolean {false, true} boolean;
408
dc99065 added flags computation optimization
bellard authored
409 #endif /* ! defined (DIS_ASM_H) */
Something went wrong with that request. Please try again.