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 #include <stdio.h>
  10 #include "bfd.h"
  11
  12 typedef int (*fprintf_ftype) PARAMS((FILE*, const char*, ...));
  13
  14 enum dis_insn_type {
  15   dis_noninsn,                  /* Not a valid instruction */
  16   dis_nonbranch,                /* Not a branch instruction */
  17   dis_branch,                   /* Unconditional branch */
  18   dis_condbranch,               /* Conditional branch */
  19   dis_jsr,                      /* Jump to subroutine */
  20   dis_condjsr,                  /* Conditional jump to subroutine */
  21   dis_dref,                     /* Data reference instruction */
  22   dis_dref2                     /* Two data references in instruction */
  23 };
  24
  25 /* This struct is passed into the instruction decoding routine,
  26    and is passed back out into each callback.  The various fields are used
  27    for conveying information from your main routine into your callbacks,
  28    for passing information into the instruction decoders (such as the
  29    addresses of the callback functions), or for passing information
  30    back from the instruction decoders to their callers.
  31
  32    It must be initialized before it is first passed; this can be done
  33    by hand, or using one of the initialization macros below.  */
  34
  35 typedef struct disassemble_info {
  36   fprintf_ftype fprintf_func;
  37   FILE *stream;
  38   PTR application_data;
  39
  40   /* For use by the disassembler.  */
  41   int flags;
  42   PTR private_data;
  43
  44   /* Function used to get bytes to disassemble.  MEMADDR is the
  45      address of the stuff to be disassembled, MYADDR is the address to
  46      put the bytes in, and LENGTH is the number of bytes to read.
  47      INFO is a pointer to this struct.
  48      Returns an errno value or 0 for success.  */
  49   int (*read_memory_func)
  50     PARAMS ((bfd_vma memaddr, bfd_byte *myaddr, int length,
  51              struct disassemble_info *info));
  52
  53   /* Function which should be called if we get an error that we can't
  54      recover from.  STATUS is the errno value from read_memory_func and
  55      MEMADDR is the address that we were trying to read.  INFO is a
  56      pointer to this struct.  */
  57   void (*memory_error_func)
  58     PARAMS ((int status, bfd_vma memaddr, struct disassemble_info *info));
  59
  60   /* Function called to print ADDR.  */
  61   void (*print_address_func)
  62     PARAMS ((bfd_vma addr, struct disassemble_info *info));
  63
  64   /* These are for buffer_read_memory.  */
  65   bfd_byte *buffer;
  66   bfd_vma buffer_vma;
  67   int buffer_length;
  68
  69   /* Results from instruction decoders.  Not all decoders yet support
  70      this information.  This info is set each time an instruction is
  71      decoded, and is only valid for the last such instruction.
  72
  73      To determine whether this decoder supports this information, set
  74      insn_info_valid to 0, decode an instruction, then check it.  */
  75
  76   char insn_info_valid;         /* Branch info has been set. */
  77   char branch_delay_insns;      /* How many sequential insn's will run before
  78                                    a branch takes effect.  (0 = normal) */
  79   char data_size;               /* Size of data reference in insn, in bytes */
  80   enum dis_insn_type insn_type; /* Type of instruction */
  81   bfd_vma target;               /* Target address of branch or dref, if known;
  82                                    zero if unknown.  */
  83   bfd_vma target2;              /* Second target address for dref2 */
  84
  85 } disassemble_info;
  86
  87
  88
  89
  90
  91 \f
  92 /* Standard disassemblers.  Disassemble one instruction at the given
  93    target address.  Return number of bytes processed.  */
  94 typedef int (*disassembler_ftype)
  95      PARAMS((bfd_vma, disassemble_info *));
  96
  97 extern int print_insn_big_mips          PARAMS ((bfd_vma, disassemble_info*));
  98 extern int print_insn_little_mips       PARAMS ((bfd_vma, disassemble_info*));
  99 extern int print_insn_i386              PARAMS ((bfd_vma, disassemble_info*));
 100 extern int print_insn_m68k              PARAMS ((bfd_vma, disassemble_info*));
 101 extern int print_insn_z8001             PARAMS ((bfd_vma, disassemble_info*));
 102 extern int print_insn_z8002             PARAMS ((bfd_vma, disassemble_info*));
 103 extern int print_insn_h8300             PARAMS ((bfd_vma, disassemble_info*));
 104 extern int print_insn_h8300h            PARAMS ((bfd_vma, disassemble_info*));
 105 extern int print_insn_h8500             PARAMS ((bfd_vma, disassemble_info*));
 106 extern int print_insn_alpha             PARAMS ((bfd_vma, disassemble_info*));
 107 extern int print_insn_arm               PARAMS ((bfd_vma, disassemble_info*));
 108 extern int print_insn_sparc             PARAMS ((bfd_vma, disassemble_info*));
 109 extern int print_insn_big_a29k          PARAMS ((bfd_vma, disassemble_info*));
 110 extern int print_insn_little_a29k       PARAMS ((bfd_vma, disassemble_info*));
 111 extern int print_insn_i960              PARAMS ((bfd_vma, disassemble_info*));
 112 extern int print_insn_sh                PARAMS ((bfd_vma, disassemble_info*));
 113 extern int print_insn_shl               PARAMS ((bfd_vma, disassemble_info*));
 114 extern int print_insn_hppa              PARAMS ((bfd_vma, disassemble_info*));
 115 extern int print_insn_m88k              PARAMS ((bfd_vma, disassemble_info*));
 116 extern int print_insn_ns32k             PARAMS ((bfd_vma, disassemble_info*));
 117 extern int print_insn_big_powerpc       PARAMS ((bfd_vma, disassemble_info*));
 118 extern int print_insn_little_powerpc    PARAMS ((bfd_vma, disassemble_info*));
 119 extern int print_insn_rs6000            PARAMS ((bfd_vma, disassemble_info*));
 120
 121 /* Fetch the disassembler for a given BFD, if that support is available.  */
 122 extern disassembler_ftype disassembler  PARAMS ((bfd *));
 123
 124 \f
 125 /* This block of definitions is for particular callers who read instructions
 126    into a buffer before calling the instruction decoder.  */
 127
 128 /* Here is a function which callers may wish to use for read_memory_func.
 129    It gets bytes from a buffer.  */
 130 extern int buffer_read_memory
 131   PARAMS ((bfd_vma, bfd_byte *, int, struct disassemble_info *));
 132
 133 /* This function goes with buffer_read_memory.
 134    It prints a message using info->fprintf_func and info->stream.  */
 135 extern void perror_memory PARAMS ((int, bfd_vma, struct disassemble_info *));
 136
 137
 138 /* Just print the address is hex.  This is included for completeness even
 139    though both GDB and objdump provide their own (to print symbolic
 140    addresses).  */
 141 extern void generic_print_address
 142   PARAMS ((bfd_vma, struct disassemble_info *));
 143
 144 #define INIT_DISASSEMBLE_INFO(INFO, STREAM) \
 145   (INFO).fprintf_func = (fprintf_ftype)fprintf, \
 146   (INFO).stream = (STREAM), \
 147   (INFO).buffer = NULL, \
 148   (INFO).buffer_vma = 0, \
 149   (INFO).buffer_length = 0, \
 150   (INFO).read_memory_func = buffer_read_memory, \
 151   (INFO).memory_error_func = perror_memory, \
 152   (INFO).print_address_func = generic_print_address, \
 153   (INFO).insn_info_valid = 0
 154
 155
 156
 157 \f
 158 /* This block of definitions is for calling the instruction decoders
 159    from GDB.  */
 160
 161 /* GDB--Like target_read_memory, but slightly different parameters.  */
 162 extern int
 163 dis_asm_read_memory PARAMS ((bfd_vma memaddr, bfd_byte *myaddr, int len,
 164                              disassemble_info *info));
 165
 166 /* GDB--Like memory_error with slightly different parameters.  */
 167 extern void
 168 dis_asm_memory_error
 169   PARAMS ((int status, bfd_vma memaddr, disassemble_info *info));
 170
 171 /* GDB--Like print_address with slightly different parameters.  */
 172 extern void
 173 dis_asm_print_address PARAMS ((bfd_vma addr, disassemble_info *info));
 174
 175 #define GDB_INIT_DISASSEMBLE_INFO(INFO, STREAM) \
 176   (INFO).fprintf_func = (fprintf_ftype)fprintf_filtered, \
 177   (INFO).stream = (STREAM), \
 178   (INFO).read_memory_func = dis_asm_read_memory, \
 179   (INFO).memory_error_func = dis_asm_memory_error, \
 180   (INFO).print_address_func = dis_asm_print_address, \
 181   (INFO).insn_info_valid = 0