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_arch value.  */
  47   enum bfd_architecture arch;
  48   /* The bfd_mach value.  */
  49   unsigned long mach;
  50   /* Endianness (for bi-endian cpus).  Mono-endian cpus can ignore this.  */
  51   enum bfd_endian endian;
  52
  53   /* For use by the disassembler.
  54      The top 16 bits are reserved for public use (and are documented here).
  55      The bottom 16 bits are for the internal use of the disassembler.  */
  56   unsigned long flags;
  57   PTR private_data;
  58
  59   /* Non-zero if an instruction is to be displayed in raw form (eg: hex)
  60      (along with the symbolic form which is always printed).
  61      ??? Not all targets support this yet and not all have the same default
  62      (which they should).  */
  63 #define DISASM_RAW_INSN_FLAG    0x10000
  64 #define DISASM_RAW_INSN(INFO)   ((INFO)->flags & DISASM_RAW_INSN_FLAG)
  65
  66   /* Function used to get bytes to disassemble.  MEMADDR is the
  67      address of the stuff to be disassembled, MYADDR is the address to
  68      put the bytes in, and LENGTH is the number of bytes to read.
  69      INFO is a pointer to this struct.
  70      Returns an errno value or 0 for success.  */
  71   int (*read_memory_func)
  72     PARAMS ((bfd_vma memaddr, bfd_byte *myaddr, int length,
  73              struct disassemble_info *info));
  74
  75   /* Function which should be called if we get an error that we can't
  76      recover from.  STATUS is the errno value from read_memory_func and
  77      MEMADDR is the address that we were trying to read.  INFO is a
  78      pointer to this struct.  */
  79   void (*memory_error_func)
  80     PARAMS ((int status, bfd_vma memaddr, struct disassemble_info *info));
  81
  82   /* Function called to print ADDR.  */
  83   void (*print_address_func)
  84     PARAMS ((bfd_vma addr, struct disassemble_info *info));
  85
  86   /* These are for buffer_read_memory.  */
  87   bfd_byte *buffer;
  88   bfd_vma buffer_vma;
  89   int buffer_length;
  90
  91   /* Results from instruction decoders.  Not all decoders yet support
  92      this information.  This info is set each time an instruction is
  93      decoded, and is only valid for the last such instruction.
  94
  95      To determine whether this decoder supports this information, set
  96      insn_info_valid to 0, decode an instruction, then check it.  */
  97
  98   char insn_info_valid;         /* Branch info has been set. */
  99   char branch_delay_insns;      /* How many sequential insn's will run before
 100                                    a branch takes effect.  (0 = normal) */
 101   char data_size;               /* Size of data reference in insn, in bytes */
 102   enum dis_insn_type insn_type; /* Type of instruction */
 103   bfd_vma target;               /* Target address of branch or dref, if known;
 104                                    zero if unknown.  */
 105   bfd_vma target2;              /* Second target address for dref2 */
 106
 107 } disassemble_info;
 108
 109 \f
 110 /* Standard disassemblers.  Disassemble one instruction at the given
 111    target address.  Return number of bytes processed.  */
 112 typedef int (*disassembler_ftype)
 113      PARAMS((bfd_vma, disassemble_info *));
 114
 115 extern int print_insn_big_mips          PARAMS ((bfd_vma, disassemble_info*));
 116 extern int print_insn_little_mips       PARAMS ((bfd_vma, disassemble_info*));
 117 extern int print_insn_i386              PARAMS ((bfd_vma, disassemble_info*));
 118 extern int print_insn_m68k              PARAMS ((bfd_vma, disassemble_info*));
 119 extern int print_insn_z8001             PARAMS ((bfd_vma, disassemble_info*));
 120 extern int print_insn_z8002             PARAMS ((bfd_vma, disassemble_info*));
 121 extern int print_insn_h8300             PARAMS ((bfd_vma, disassemble_info*));
 122 extern int print_insn_h8300h            PARAMS ((bfd_vma, disassemble_info*));
 123 extern int print_insn_h8500             PARAMS ((bfd_vma, disassemble_info*));
 124 extern int print_insn_alpha             PARAMS ((bfd_vma, disassemble_info*));
 125 /* start-sanitize-arc */
 126 extern disassembler_ftype arc_get_disassembler PARAMS ((int, int));
 127 /* end-sanitize-arc */
 128 extern int print_insn_big_arm           PARAMS ((bfd_vma, disassemble_info*));
 129 extern int print_insn_little_arm        PARAMS ((bfd_vma, disassemble_info*));
 130 extern int print_insn_sparc             PARAMS ((bfd_vma, disassemble_info*));
 131 extern int print_insn_sparc64           PARAMS ((bfd_vma, disassemble_info*));
 132 extern int print_insn_big_a29k          PARAMS ((bfd_vma, disassemble_info*));
 133 extern int print_insn_little_a29k       PARAMS ((bfd_vma, disassemble_info*));
 134 extern int print_insn_i960              PARAMS ((bfd_vma, disassemble_info*));
 135 extern int print_insn_sh                PARAMS ((bfd_vma, disassemble_info*));
 136 extern int print_insn_shl               PARAMS ((bfd_vma, disassemble_info*));
 137 extern int print_insn_hppa              PARAMS ((bfd_vma, disassemble_info*));
 138 extern int print_insn_m88k              PARAMS ((bfd_vma, disassemble_info*));
 139 extern int print_insn_ns32k             PARAMS ((bfd_vma, disassemble_info*));
 140 extern int print_insn_big_powerpc       PARAMS ((bfd_vma, disassemble_info*));
 141 extern int print_insn_little_powerpc    PARAMS ((bfd_vma, disassemble_info*));
 142 extern int print_insn_rs6000            PARAMS ((bfd_vma, disassemble_info*));
 143 extern int print_insn_w65               PARAMS ((bfd_vma, disassemble_info*));
 144
 145 /* Fetch the disassembler for a given BFD, if that support is available.  */
 146 extern disassembler_ftype disassembler  PARAMS ((bfd *));
 147
 148 \f
 149 /* This block of definitions is for particular callers who read instructions
 150    into a buffer before calling the instruction decoder.  */
 151
 152 /* Here is a function which callers may wish to use for read_memory_func.
 153    It gets bytes from a buffer.  */
 154 extern int buffer_read_memory
 155   PARAMS ((bfd_vma, bfd_byte *, int, struct disassemble_info *));
 156
 157 /* This function goes with buffer_read_memory.
 158    It prints a message using info->fprintf_func and info->stream.  */
 159 extern void perror_memory PARAMS ((int, bfd_vma, struct disassemble_info *));
 160
 161
 162 /* Just print the address in hex.  This is included for completeness even
 163    though both GDB and objdump provide their own (to print symbolic
 164    addresses).  */
 165 extern void generic_print_address
 166   PARAMS ((bfd_vma, struct disassemble_info *));
 167
 168 #define INIT_DISASSEMBLE_INFO(INFO, STREAM) \
 169   (INFO).fprintf_func = (fprintf_ftype)fprintf, \
 170   (INFO).stream = (STREAM), \
 171   (INFO).buffer = NULL, \
 172   (INFO).buffer_vma = 0, \
 173   (INFO).buffer_length = 0, \
 174   (INFO).read_memory_func = buffer_read_memory, \
 175   (INFO).memory_error_func = perror_memory, \
 176   (INFO).print_address_func = generic_print_address, \
 177   (INFO).arch = bfd_arch_unknown, \
 178   (INFO).mach = 0, \
 179   (INFO).endian = BFD_ENDIAN_BIG, \
 180   (INFO).flags = 0, \
 181   (INFO).insn_info_valid = 0
 182
 183 #endif /* ! defined (DIS_ASM_H) */