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