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