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