| 1 |
1181 |
sfurman |
/* Interface between the opcode library and its callers.
|
| 2 |
|
|
|
| 3 |
|
|
Copyright 2001, 2002 Free Software Foundation, Inc.
|
| 4 |
|
|
|
| 5 |
|
|
This program is free software; you can redistribute it and/or modify
|
| 6 |
|
|
it under the terms of the GNU General Public License as published by
|
| 7 |
|
|
the Free Software Foundation; either version 2, or (at your option)
|
| 8 |
|
|
any later version.
|
| 9 |
|
|
|
| 10 |
|
|
This program is distributed in the hope that it will be useful,
|
| 11 |
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
| 12 |
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
| 13 |
|
|
GNU General Public License for more details.
|
| 14 |
|
|
|
| 15 |
|
|
You should have received a copy of the GNU General Public License
|
| 16 |
|
|
along with this program; if not, write to the Free Software
|
| 17 |
|
|
Foundation, Inc., 59 Temple Place - Suite 330,
|
| 18 |
|
|
Boston, MA 02111-1307, USA.
|
| 19 |
|
|
|
| 20 |
|
|
Written by Cygnus Support, 1993.
|
| 21 |
|
|
|
| 22 |
|
|
The opcode library (libopcodes.a) provides instruction decoders for
|
| 23 |
|
|
a large variety of instruction sets, callable with an identical
|
| 24 |
|
|
interface, for making instruction-processing programs more independent
|
| 25 |
|
|
of the instruction set being processed. */
|
| 26 |
|
|
|
| 27 |
|
|
#ifndef DIS_ASM_H
|
| 28 |
|
|
#define DIS_ASM_H
|
| 29 |
|
|
|
| 30 |
|
|
#ifdef __cplusplus
|
| 31 |
|
|
extern "C" {
|
| 32 |
|
|
#endif
|
| 33 |
|
|
|
| 34 |
|
|
#include <stdio.h>
|
| 35 |
|
|
#include "bfd.h"
|
| 36 |
|
|
|
| 37 |
|
|
typedef int (*fprintf_ftype) PARAMS((PTR, const char*, ...));
|
| 38 |
|
|
|
| 39 |
|
|
enum dis_insn_type {
|
| 40 |
|
|
dis_noninsn, /* Not a valid instruction */
|
| 41 |
|
|
dis_nonbranch, /* Not a branch instruction */
|
| 42 |
|
|
dis_branch, /* Unconditional branch */
|
| 43 |
|
|
dis_condbranch, /* Conditional branch */
|
| 44 |
|
|
dis_jsr, /* Jump to subroutine */
|
| 45 |
|
|
dis_condjsr, /* Conditional jump to subroutine */
|
| 46 |
|
|
dis_dref, /* Data reference instruction */
|
| 47 |
|
|
dis_dref2 /* Two data references in instruction */
|
| 48 |
|
|
};
|
| 49 |
|
|
|
| 50 |
|
|
/* This struct is passed into the instruction decoding routine,
|
| 51 |
|
|
and is passed back out into each callback. The various fields are used
|
| 52 |
|
|
for conveying information from your main routine into your callbacks,
|
| 53 |
|
|
for passing information into the instruction decoders (such as the
|
| 54 |
|
|
addresses of the callback functions), or for passing information
|
| 55 |
|
|
back from the instruction decoders to their callers.
|
| 56 |
|
|
|
| 57 |
|
|
It must be initialized before it is first passed; this can be done
|
| 58 |
|
|
by hand, or using one of the initialization macros below. */
|
| 59 |
|
|
|
| 60 |
|
|
typedef struct disassemble_info {
|
| 61 |
|
|
fprintf_ftype fprintf_func;
|
| 62 |
|
|
PTR stream;
|
| 63 |
|
|
PTR application_data;
|
| 64 |
|
|
|
| 65 |
|
|
/* Target description. We could replace this with a pointer to the bfd,
|
| 66 |
|
|
but that would require one. There currently isn't any such requirement
|
| 67 |
|
|
so to avoid introducing one we record these explicitly. */
|
| 68 |
|
|
/* The bfd_flavour. This can be bfd_target_unknown_flavour. */
|
| 69 |
|
|
enum bfd_flavour flavour;
|
| 70 |
|
|
/* The bfd_arch value. */
|
| 71 |
|
|
enum bfd_architecture arch;
|
| 72 |
|
|
/* The bfd_mach value. */
|
| 73 |
|
|
unsigned long mach;
|
| 74 |
|
|
/* Endianness (for bi-endian cpus). Mono-endian cpus can ignore this. */
|
| 75 |
|
|
enum bfd_endian endian;
|
| 76 |
|
|
/* An arch/mach-specific bitmask of selected instruction subsets, mainly
|
| 77 |
|
|
for processors with run-time-switchable instruction sets. The default,
|
| 78 |
|
|
zero, means that there is no constraint. CGEN-based opcodes ports
|
| 79 |
|
|
may use ISA_foo masks. */
|
| 80 |
|
|
unsigned long insn_sets;
|
| 81 |
|
|
|
| 82 |
|
|
/* Some targets need information about the current section to accurately
|
| 83 |
|
|
display insns. If this is NULL, the target disassembler function
|
| 84 |
|
|
will have to make its best guess. */
|
| 85 |
|
|
asection *section;
|
| 86 |
|
|
|
| 87 |
|
|
/* An array of pointers to symbols either at the location being disassembled
|
| 88 |
|
|
or at the start of the function being disassembled. The array is sorted
|
| 89 |
|
|
so that the first symbol is intended to be the one used. The others are
|
| 90 |
|
|
present for any misc. purposes. This is not set reliably, but if it is
|
| 91 |
|
|
not NULL, it is correct. */
|
| 92 |
|
|
asymbol **symbols;
|
| 93 |
|
|
/* Number of symbols in array. */
|
| 94 |
|
|
int num_symbols;
|
| 95 |
|
|
|
| 96 |
|
|
/* For use by the disassembler.
|
| 97 |
|
|
The top 16 bits are reserved for public use (and are documented here).
|
| 98 |
|
|
The bottom 16 bits are for the internal use of the disassembler. */
|
| 99 |
|
|
unsigned long flags;
|
| 100 |
|
|
#define INSN_HAS_RELOC 0x80000000
|
| 101 |
|
|
PTR private_data;
|
| 102 |
|
|
|
| 103 |
|
|
/* Function used to get bytes to disassemble. MEMADDR is the
|
| 104 |
|
|
address of the stuff to be disassembled, MYADDR is the address to
|
| 105 |
|
|
put the bytes in, and LENGTH is the number of bytes to read.
|
| 106 |
|
|
INFO is a pointer to this struct.
|
| 107 |
|
|
Returns an errno value or 0 for success. */
|
| 108 |
|
|
int (*read_memory_func)
|
| 109 |
|
|
PARAMS ((bfd_vma memaddr, bfd_byte *myaddr, unsigned int length,
|
| 110 |
|
|
struct disassemble_info *info));
|
| 111 |
|
|
|
| 112 |
|
|
/* Function which should be called if we get an error that we can't
|
| 113 |
|
|
recover from. STATUS is the errno value from read_memory_func and
|
| 114 |
|
|
MEMADDR is the address that we were trying to read. INFO is a
|
| 115 |
|
|
pointer to this struct. */
|
| 116 |
|
|
void (*memory_error_func)
|
| 117 |
|
|
PARAMS ((int status, bfd_vma memaddr, struct disassemble_info *info));
|
| 118 |
|
|
|
| 119 |
|
|
/* Function called to print ADDR. */
|
| 120 |
|
|
void (*print_address_func)
|
| 121 |
|
|
PARAMS ((bfd_vma addr, struct disassemble_info *info));
|
| 122 |
|
|
|
| 123 |
|
|
/* Function called to determine if there is a symbol at the given ADDR.
|
| 124 |
|
|
If there is, the function returns 1, otherwise it returns 0.
|
| 125 |
|
|
This is used by ports which support an overlay manager where
|
| 126 |
|
|
the overlay number is held in the top part of an address. In
|
| 127 |
|
|
some circumstances we want to include the overlay number in the
|
| 128 |
|
|
address, (normally because there is a symbol associated with
|
| 129 |
|
|
that address), but sometimes we want to mask out the overlay bits. */
|
| 130 |
|
|
int (* symbol_at_address_func)
|
| 131 |
|
|
PARAMS ((bfd_vma addr, struct disassemble_info * info));
|
| 132 |
|
|
|
| 133 |
|
|
/* These are for buffer_read_memory. */
|
| 134 |
|
|
bfd_byte *buffer;
|
| 135 |
|
|
bfd_vma buffer_vma;
|
| 136 |
|
|
unsigned int buffer_length;
|
| 137 |
|
|
|
| 138 |
|
|
/* This variable may be set by the instruction decoder. It suggests
|
| 139 |
|
|
the number of bytes objdump should display on a single line. If
|
| 140 |
|
|
the instruction decoder sets this, it should always set it to
|
| 141 |
|
|
the same value in order to get reasonable looking output. */
|
| 142 |
|
|
int bytes_per_line;
|
| 143 |
|
|
|
| 144 |
|
|
/* the next two variables control the way objdump displays the raw data */
|
| 145 |
|
|
/* For example, if bytes_per_line is 8 and bytes_per_chunk is 4, the */
|
| 146 |
|
|
/* output will look like this:
|
| 147 |
|
|
00: 00000000 00000000
|
| 148 |
|
|
with the chunks displayed according to "display_endian". */
|
| 149 |
|
|
int bytes_per_chunk;
|
| 150 |
|
|
enum bfd_endian display_endian;
|
| 151 |
|
|
|
| 152 |
|
|
/* Number of octets per incremented target address
|
| 153 |
|
|
Normally one, but some DSPs have byte sizes of 16 or 32 bits. */
|
| 154 |
|
|
unsigned int octets_per_byte;
|
| 155 |
|
|
|
| 156 |
|
|
/* Results from instruction decoders. Not all decoders yet support
|
| 157 |
|
|
this information. This info is set each time an instruction is
|
| 158 |
|
|
decoded, and is only valid for the last such instruction.
|
| 159 |
|
|
|
| 160 |
|
|
To determine whether this decoder supports this information, set
|
| 161 |
|
|
insn_info_valid to 0, decode an instruction, then check it. */
|
| 162 |
|
|
|
| 163 |
|
|
char insn_info_valid; /* Branch info has been set. */
|
| 164 |
|
|
char branch_delay_insns; /* How many sequential insn's will run before
|
| 165 |
|
|
a branch takes effect. (0 = normal) */
|
| 166 |
|
|
char data_size; /* Size of data reference in insn, in bytes */
|
| 167 |
|
|
enum dis_insn_type insn_type; /* Type of instruction */
|
| 168 |
|
|
bfd_vma target; /* Target address of branch or dref, if known;
|
| 169 |
|
|
zero if unknown. */
|
| 170 |
|
|
bfd_vma target2; /* Second target address for dref2 */
|
| 171 |
|
|
|
| 172 |
|
|
/* Command line options specific to the target disassembler. */
|
| 173 |
|
|
char * disassembler_options;
|
| 174 |
|
|
|
| 175 |
|
|
} disassemble_info;
|
| 176 |
|
|
|
| 177 |
|
|
|
| 178 |
|
|
/* Standard disassemblers. Disassemble one instruction at the given
|
| 179 |
|
|
target address. Return number of octets processed. */
|
| 180 |
|
|
typedef int (*disassembler_ftype)
|
| 181 |
|
|
PARAMS((bfd_vma, disassemble_info *));
|
| 182 |
|
|
|
| 183 |
|
|
extern int print_insn_big_mips PARAMS ((bfd_vma, disassemble_info*));
|
| 184 |
|
|
extern int print_insn_little_mips PARAMS ((bfd_vma, disassemble_info*));
|
| 185 |
|
|
extern int print_insn_i386 PARAMS ((bfd_vma, disassemble_info *));
|
| 186 |
|
|
extern int print_insn_i386_att PARAMS ((bfd_vma, disassemble_info*));
|
| 187 |
|
|
extern int print_insn_i386_intel PARAMS ((bfd_vma, disassemble_info*));
|
| 188 |
|
|
extern int print_insn_ia64 PARAMS ((bfd_vma, disassemble_info*));
|
| 189 |
|
|
extern int print_insn_i370 PARAMS ((bfd_vma, disassemble_info*));
|
| 190 |
|
|
extern int print_insn_m68hc11 PARAMS ((bfd_vma, disassemble_info*));
|
| 191 |
|
|
extern int print_insn_m68hc12 PARAMS ((bfd_vma, disassemble_info*));
|
| 192 |
|
|
extern int print_insn_m68k PARAMS ((bfd_vma, disassemble_info*));
|
| 193 |
|
|
extern int print_insn_z8001 PARAMS ((bfd_vma, disassemble_info*));
|
| 194 |
|
|
extern int print_insn_z8002 PARAMS ((bfd_vma, disassemble_info*));
|
| 195 |
|
|
extern int print_insn_h8300 PARAMS ((bfd_vma, disassemble_info*));
|
| 196 |
|
|
extern int print_insn_h8300h PARAMS ((bfd_vma, disassemble_info*));
|
| 197 |
|
|
extern int print_insn_h8300s PARAMS ((bfd_vma, disassemble_info*));
|
| 198 |
|
|
extern int print_insn_h8500 PARAMS ((bfd_vma, disassemble_info*));
|
| 199 |
|
|
extern int print_insn_alpha PARAMS ((bfd_vma, disassemble_info*));
|
| 200 |
|
|
extern int print_insn_big_arm PARAMS ((bfd_vma, disassemble_info*));
|
| 201 |
|
|
extern int print_insn_little_arm PARAMS ((bfd_vma, disassemble_info*));
|
| 202 |
|
|
extern int print_insn_sparc PARAMS ((bfd_vma, disassemble_info*));
|
| 203 |
|
|
extern int print_insn_big_a29k PARAMS ((bfd_vma, disassemble_info*));
|
| 204 |
|
|
extern int print_insn_little_a29k PARAMS ((bfd_vma, disassemble_info*));
|
| 205 |
|
|
extern int print_insn_avr PARAMS ((bfd_vma, disassemble_info*));
|
| 206 |
|
|
extern int print_insn_d10v PARAMS ((bfd_vma, disassemble_info*));
|
| 207 |
|
|
extern int print_insn_d30v PARAMS ((bfd_vma, disassemble_info*));
|
| 208 |
|
|
extern int print_insn_dlx PARAMS ((bfd_vma, disassemble_info*));
|
| 209 |
|
|
extern int print_insn_fr30 PARAMS ((bfd_vma, disassemble_info*));
|
| 210 |
|
|
extern int print_insn_hppa PARAMS ((bfd_vma, disassemble_info*));
|
| 211 |
|
|
extern int print_insn_i860 PARAMS ((bfd_vma, disassemble_info*));
|
| 212 |
|
|
extern int print_insn_i960 PARAMS ((bfd_vma, disassemble_info*));
|
| 213 |
|
|
extern int print_insn_ip2k PARAMS ((bfd_vma, disassemble_info*));
|
| 214 |
|
|
extern int print_insn_m32r PARAMS ((bfd_vma, disassemble_info*));
|
| 215 |
|
|
extern int print_insn_m88k PARAMS ((bfd_vma, disassemble_info*));
|
| 216 |
|
|
extern int print_insn_mcore PARAMS ((bfd_vma, disassemble_info*));
|
| 217 |
|
|
extern int print_insn_mmix PARAMS ((bfd_vma, disassemble_info*));
|
| 218 |
|
|
extern int print_insn_mn10200 PARAMS ((bfd_vma, disassemble_info*));
|
| 219 |
|
|
extern int print_insn_mn10300 PARAMS ((bfd_vma, disassemble_info*));
|
| 220 |
|
|
extern int print_insn_ns32k PARAMS ((bfd_vma, disassemble_info*));
|
| 221 |
|
|
extern int print_insn_openrisc PARAMS ((bfd_vma, disassemble_info*));
|
| 222 |
|
|
extern int print_insn_big_or32 PARAMS ((bfd_vma, disassemble_info*));
|
| 223 |
|
|
extern int print_insn_little_or32 PARAMS ((bfd_vma, disassemble_info*));
|
| 224 |
1183 |
sfurman |
extern int print_insn_big_or16 PARAMS ((bfd_vma, disassemble_info*));
|
| 225 |
|
|
extern int print_insn_little_or16 PARAMS ((bfd_vma, disassemble_info*));
|
| 226 |
1181 |
sfurman |
extern int print_insn_pdp11 PARAMS ((bfd_vma, disassemble_info*));
|
| 227 |
|
|
extern int print_insn_pj PARAMS ((bfd_vma, disassemble_info*));
|
| 228 |
|
|
extern int print_insn_big_powerpc PARAMS ((bfd_vma, disassemble_info*));
|
| 229 |
|
|
extern int print_insn_little_powerpc PARAMS ((bfd_vma, disassemble_info*));
|
| 230 |
|
|
extern int print_insn_rs6000 PARAMS ((bfd_vma, disassemble_info*));
|
| 231 |
|
|
extern int print_insn_s390 PARAMS ((bfd_vma, disassemble_info*));
|
| 232 |
|
|
extern int print_insn_sh PARAMS ((bfd_vma, disassemble_info*));
|
| 233 |
|
|
extern int print_insn_tic30 PARAMS ((bfd_vma, disassemble_info*));
|
| 234 |
|
|
extern int print_insn_tic4x PARAMS ((bfd_vma, disassemble_info*));
|
| 235 |
|
|
extern int print_insn_tic54x PARAMS ((bfd_vma, disassemble_info*));
|
| 236 |
|
|
extern int print_insn_tic80 PARAMS ((bfd_vma, disassemble_info*));
|
| 237 |
|
|
extern int print_insn_v850 PARAMS ((bfd_vma, disassemble_info*));
|
| 238 |
|
|
extern int print_insn_vax PARAMS ((bfd_vma, disassemble_info*));
|
| 239 |
|
|
extern int print_insn_w65 PARAMS ((bfd_vma, disassemble_info*));
|
| 240 |
|
|
extern int print_insn_xstormy16 PARAMS ((bfd_vma, disassemble_info*));
|
| 241 |
|
|
extern int print_insn_sh64 PARAMS ((bfd_vma, disassemble_info *));
|
| 242 |
|
|
extern int print_insn_sh64x_media PARAMS ((bfd_vma, disassemble_info *));
|
| 243 |
|
|
extern int print_insn_frv PARAMS ((bfd_vma, disassemble_info *));
|
| 244 |
|
|
|
| 245 |
|
|
extern disassembler_ftype arc_get_disassembler PARAMS ((void *));
|
| 246 |
|
|
extern disassembler_ftype cris_get_disassembler PARAMS ((bfd *));
|
| 247 |
|
|
|
| 248 |
|
|
extern void print_arm_disassembler_options PARAMS ((FILE *));
|
| 249 |
|
|
extern void parse_arm_disassembler_option PARAMS ((char *));
|
| 250 |
|
|
extern int get_arm_regname_num_options PARAMS ((void));
|
| 251 |
|
|
extern int set_arm_regname_option PARAMS ((int));
|
| 252 |
|
|
extern int get_arm_regnames PARAMS ((int, const char **, const char **, const char ***));
|
| 253 |
|
|
|
| 254 |
|
|
/* Fetch the disassembler for a given BFD, if that support is available. */
|
| 255 |
|
|
extern disassembler_ftype disassembler PARAMS ((bfd *));
|
| 256 |
|
|
|
| 257 |
|
|
/* Document any target specific options available from the disassembler. */
|
| 258 |
|
|
extern void disassembler_usage PARAMS ((FILE *));
|
| 259 |
|
|
|
| 260 |
|
|
|
| 261 |
|
|
/* This block of definitions is for particular callers who read instructions
|
| 262 |
|
|
into a buffer before calling the instruction decoder. */
|
| 263 |
|
|
|
| 264 |
|
|
/* Here is a function which callers may wish to use for read_memory_func.
|
| 265 |
|
|
It gets bytes from a buffer. */
|
| 266 |
|
|
extern int buffer_read_memory
|
| 267 |
|
|
PARAMS ((bfd_vma, bfd_byte *, unsigned int, struct disassemble_info *));
|
| 268 |
|
|
|
| 269 |
|
|
/* This function goes with buffer_read_memory.
|
| 270 |
|
|
It prints a message using info->fprintf_func and info->stream. */
|
| 271 |
|
|
extern void perror_memory PARAMS ((int, bfd_vma, struct disassemble_info *));
|
| 272 |
|
|
|
| 273 |
|
|
|
| 274 |
|
|
/* Just print the address in hex. This is included for completeness even
|
| 275 |
|
|
though both GDB and objdump provide their own (to print symbolic
|
| 276 |
|
|
addresses). */
|
| 277 |
|
|
extern void generic_print_address
|
| 278 |
|
|
PARAMS ((bfd_vma, struct disassemble_info *));
|
| 279 |
|
|
|
| 280 |
|
|
/* Always true. */
|
| 281 |
|
|
extern int generic_symbol_at_address
|
| 282 |
|
|
PARAMS ((bfd_vma, struct disassemble_info *));
|
| 283 |
|
|
|
| 284 |
|
|
/* Macro to initialize a disassemble_info struct. This should be called
|
| 285 |
|
|
by all applications creating such a struct. */
|
| 286 |
|
|
#define INIT_DISASSEMBLE_INFO(INFO, STREAM, FPRINTF_FUNC) \
|
| 287 |
|
|
(INFO).flavour = bfd_target_unknown_flavour, \
|
| 288 |
|
|
(INFO).arch = bfd_arch_unknown, \
|
| 289 |
|
|
(INFO).mach = 0, \
|
| 290 |
|
|
(INFO).insn_sets = 0, \
|
| 291 |
|
|
(INFO).endian = BFD_ENDIAN_UNKNOWN, \
|
| 292 |
|
|
(INFO).octets_per_byte = 1, \
|
| 293 |
|
|
INIT_DISASSEMBLE_INFO_NO_ARCH(INFO, STREAM, FPRINTF_FUNC)
|
| 294 |
|
|
|
| 295 |
|
|
/* Call this macro to initialize only the internal variables for the
|
| 296 |
|
|
disassembler. Architecture dependent things such as byte order, or machine
|
| 297 |
|
|
variant are not touched by this macro. This makes things much easier for
|
| 298 |
|
|
GDB which must initialize these things separately. */
|
| 299 |
|
|
|
| 300 |
|
|
#define INIT_DISASSEMBLE_INFO_NO_ARCH(INFO, STREAM, FPRINTF_FUNC) \
|
| 301 |
|
|
(INFO).fprintf_func = (fprintf_ftype)(FPRINTF_FUNC), \
|
| 302 |
|
|
(INFO).stream = (PTR)(STREAM), \
|
| 303 |
|
|
(INFO).section = NULL, \
|
| 304 |
|
|
(INFO).symbols = NULL, \
|
| 305 |
|
|
(INFO).num_symbols = 0, \
|
| 306 |
|
|
(INFO).private_data = NULL, \
|
| 307 |
|
|
(INFO).buffer = NULL, \
|
| 308 |
|
|
(INFO).buffer_vma = 0, \
|
| 309 |
|
|
(INFO).buffer_length = 0, \
|
| 310 |
|
|
(INFO).read_memory_func = buffer_read_memory, \
|
| 311 |
|
|
(INFO).memory_error_func = perror_memory, \
|
| 312 |
|
|
(INFO).print_address_func = generic_print_address, \
|
| 313 |
|
|
(INFO).symbol_at_address_func = generic_symbol_at_address, \
|
| 314 |
|
|
(INFO).flags = 0, \
|
| 315 |
|
|
(INFO).bytes_per_line = 0, \
|
| 316 |
|
|
(INFO).bytes_per_chunk = 0, \
|
| 317 |
|
|
(INFO).display_endian = BFD_ENDIAN_UNKNOWN, \
|
| 318 |
|
|
(INFO).disassembler_options = NULL, \
|
| 319 |
|
|
(INFO).insn_info_valid = 0
|
| 320 |
|
|
|
| 321 |
|
|
#ifdef __cplusplus
|
| 322 |
|
|
};
|
| 323 |
|
|
#endif
|
| 324 |
|
|
|
| 325 |
|
|
#endif /* ! defined (DIS_ASM_H) */
|
