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