1 /* Interface between the opcode library and its callers.
2 Written by Cygnus Support, 1993.
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. */
15 typedef int (*fprintf_ftype
) PARAMS((FILE*, const char*, ...));
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 */
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.
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. */
38 typedef struct disassemble_info
{
39 fprintf_ftype fprintf_func
;
43 /* For use by the disassembler. */
47 /* Function used to get bytes to disassemble. MEMADDR is the
48 address of the stuff to be disassembled, MYADDR is the address to
49 put the bytes in, and LENGTH is the number of bytes to read.
50 INFO is a pointer to this struct.
51 Returns an errno value or 0 for success. */
52 int (*read_memory_func
)
53 PARAMS ((bfd_vma memaddr
, bfd_byte
*myaddr
, int length
,
54 struct disassemble_info
*info
));
56 /* Function which should be called if we get an error that we can't
57 recover from. STATUS is the errno value from read_memory_func and
58 MEMADDR is the address that we were trying to read. INFO is a
59 pointer to this struct. */
60 void (*memory_error_func
)
61 PARAMS ((int status
, bfd_vma memaddr
, struct disassemble_info
*info
));
63 /* Function called to print ADDR. */
64 void (*print_address_func
)
65 PARAMS ((bfd_vma addr
, struct disassemble_info
*info
));
67 /* These are for buffer_read_memory. */
72 /* Results from instruction decoders. Not all decoders yet support
73 this information. This info is set each time an instruction is
74 decoded, and is only valid for the last such instruction.
76 To determine whether this decoder supports this information, set
77 insn_info_valid to 0, decode an instruction, then check it. */
79 char insn_info_valid
; /* Branch info has been set. */
80 char branch_delay_insns
; /* How many sequential insn's will run before
81 a branch takes effect. (0 = normal) */
82 char data_size
; /* Size of data reference in insn, in bytes */
83 enum dis_insn_type insn_type
; /* Type of instruction */
84 bfd_vma target
; /* Target address of branch or dref, if known;
86 bfd_vma target2
; /* Second target address for dref2 */
91 /* Standard disassemblers. Disassemble one instruction at the given
92 target address. Return number of bytes processed. */
93 typedef int (*disassembler_ftype
)
94 PARAMS((bfd_vma
, disassemble_info
*));
96 extern int print_insn_big_mips
PARAMS ((bfd_vma
, disassemble_info
*));
97 extern int print_insn_little_mips
PARAMS ((bfd_vma
, disassemble_info
*));
98 extern int print_insn_i386
PARAMS ((bfd_vma
, disassemble_info
*));
99 extern int print_insn_m68k
PARAMS ((bfd_vma
, disassemble_info
*));
100 extern int print_insn_z8001
PARAMS ((bfd_vma
, disassemble_info
*));
101 extern int print_insn_z8002
PARAMS ((bfd_vma
, disassemble_info
*));
102 extern int print_insn_h8300
PARAMS ((bfd_vma
, disassemble_info
*));
103 extern int print_insn_h8300h
PARAMS ((bfd_vma
, disassemble_info
*));
104 extern int print_insn_h8500
PARAMS ((bfd_vma
, disassemble_info
*));
105 extern int print_insn_alpha
PARAMS ((bfd_vma
, disassemble_info
*));
106 /* start-sanitize-arc */
107 extern int print_insn_arc
PARAMS ((bfd_vma
, disassemble_info
*));
108 /* end-sanitize-arc */
109 extern int print_insn_arm
PARAMS ((bfd_vma
, disassemble_info
*));
110 extern int print_insn_sparc
PARAMS ((bfd_vma
, disassemble_info
*));
111 extern int print_insn_big_a29k
PARAMS ((bfd_vma
, disassemble_info
*));
112 extern int print_insn_little_a29k
PARAMS ((bfd_vma
, disassemble_info
*));
113 extern int print_insn_i960
PARAMS ((bfd_vma
, disassemble_info
*));
114 extern int print_insn_sh
PARAMS ((bfd_vma
, disassemble_info
*));
115 extern int print_insn_shl
PARAMS ((bfd_vma
, disassemble_info
*));
116 extern int print_insn_hppa
PARAMS ((bfd_vma
, disassemble_info
*));
117 extern int print_insn_m88k
PARAMS ((bfd_vma
, disassemble_info
*));
118 extern int print_insn_ns32k
PARAMS ((bfd_vma
, disassemble_info
*));
119 extern int print_insn_big_powerpc
PARAMS ((bfd_vma
, disassemble_info
*));
120 extern int print_insn_little_powerpc
PARAMS ((bfd_vma
, disassemble_info
*));
121 extern int print_insn_rs6000
PARAMS ((bfd_vma
, disassemble_info
*));
122 extern int print_insn_w65
PARAMS ((bfd_vma
, disassemble_info
*));
124 /* Fetch the disassembler for a given BFD, if that support is available. */
125 extern disassembler_ftype disassembler
PARAMS ((bfd
*));
128 /* This block of definitions is for particular callers who read instructions
129 into a buffer before calling the instruction decoder. */
131 /* Here is a function which callers may wish to use for read_memory_func.
132 It gets bytes from a buffer. */
133 extern int buffer_read_memory
134 PARAMS ((bfd_vma
, bfd_byte
*, int, struct disassemble_info
*));
136 /* This function goes with buffer_read_memory.
137 It prints a message using info->fprintf_func and info->stream. */
138 extern void perror_memory
PARAMS ((int, bfd_vma
, struct disassemble_info
*));
141 /* Just print the address is hex. This is included for completeness even
142 though both GDB and objdump provide their own (to print symbolic
144 extern void generic_print_address
145 PARAMS ((bfd_vma
, struct disassemble_info
*));
147 #define INIT_DISASSEMBLE_INFO(INFO, STREAM) \
148 (INFO).fprintf_func = (fprintf_ftype)fprintf, \
149 (INFO).stream = (STREAM), \
150 (INFO).buffer = NULL, \
151 (INFO).buffer_vma = 0, \
152 (INFO).buffer_length = 0, \
153 (INFO).read_memory_func = buffer_read_memory, \
154 (INFO).memory_error_func = perror_memory, \
155 (INFO).print_address_func = generic_print_address, \
156 (INFO).insn_info_valid = 0
161 /* This block of definitions is for calling the instruction decoders
164 /* GDB--Like target_read_memory, but slightly different parameters. */
166 dis_asm_read_memory
PARAMS ((bfd_vma memaddr
, bfd_byte
*myaddr
, int len
,
167 disassemble_info
*info
));
169 /* GDB--Like memory_error with slightly different parameters. */
172 PARAMS ((int status
, bfd_vma memaddr
, disassemble_info
*info
));
174 /* GDB--Like print_address with slightly different parameters. */
176 dis_asm_print_address
PARAMS ((bfd_vma addr
, disassemble_info
*info
));
178 #define GDB_INIT_DISASSEMBLE_INFO(INFO, STREAM) \
179 (INFO).fprintf_func = (fprintf_ftype)fprintf_filtered, \
180 (INFO).stream = (STREAM), \
181 (INFO).read_memory_func = dis_asm_read_memory, \
182 (INFO).memory_error_func = dis_asm_memory_error, \
183 (INFO).print_address_func = dis_asm_print_address, \
184 (INFO).insn_info_valid = 0
186 #endif /* ! defined (DIS_ASM_H) */