include/dis-asm.h

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