powerpc/dis-asm.h

   1 /* Interface between the opcode library and its callers.
   2
   3    Copyright 2001, 2002 Free Software Foundation, Inc.
   4
   5    This program is free software; you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 2, or (at your option)
   8    any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; if not, write to the Free Software
  17    Foundation, Inc., 59 Temple Place - Suite 330,
  18    Boston, MA 02111-1307, USA.
  19
  20    Written by Cygnus Support, 1993.
  21
  22    The opcode library (libopcodes.a) provides instruction decoders for
  23    a large variety of instruction sets, callable with an identical
  24    interface, for making instruction-processing programs more independent
  25    of the instruction set being processed.  */
  26
  27 #ifndef DIS_ASM_H
  28 #define DIS_ASM_H
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 #include <stdio.h>
  35
  36 #define PARAMS(a) a
  37
  38         /*
  39 typedef unsigned char u1;
  40 typedef unsigned int u4;
  41 typedef signed int s4;
  42         */
  43 typedef void *PTR;
  44 typedef void *bfd;
  45 typedef u4 bfd_vma;
  46 typedef s4 bfd_signed_vma;
  47 typedef u1 bfd_byte;
  48
  49 typedef int (*fprintf_ftype) PARAMS((PTR, const char*, ...));
  50
  51 enum dis_insn_type {
  52   dis_noninsn,                  /* Not a valid instruction */
  53   dis_nonbranch,                /* Not a branch instruction */
  54   dis_branch,                   /* Unconditional branch */
  55   dis_condbranch,               /* Conditional branch */
  56   dis_jsr,                      /* Jump to subroutine */
  57   dis_condjsr,                  /* Conditional jump to subroutine */
  58   dis_dref,                     /* Data reference instruction */
  59   dis_dref2                     /* Two data references in instruction */
  60 };
  61
  62 /* This struct is passed into the instruction decoding routine,
  63    and is passed back out into each callback.  The various fields are used
  64    for conveying information from your main routine into your callbacks,
  65    for passing information into the instruction decoders (such as the
  66    addresses of the callback functions), or for passing information
  67    back from the instruction decoders to their callers.
  68
  69    It must be initialized before it is first passed; this can be done
  70    by hand, or using one of the initialization macros below.  */
  71
  72 typedef struct disassemble_info {
  73   fprintf_ftype fprintf_func;
  74   PTR stream;
  75   PTR application_data;
  76
  77   /* An arch/mach-specific bitmask of selected instruction subsets, mainly
  78      for processors with run-time-switchable instruction sets.  The default,
  79      zero, means that there is no constraint.  CGEN-based opcodes ports
  80      may use ISA_foo masks.  */
  81   unsigned long insn_sets;
  82
  83
  84   /* For use by the disassembler.
  85      The top 16 bits are reserved for public use (and are documented here).
  86      The bottom 16 bits are for the internal use of the disassembler.  */
  87   unsigned long flags;
  88 #define INSN_HAS_RELOC  0x80000000
  89   PTR private_data;
  90
  91   /* Function used to get bytes to disassemble.  MEMADDR is the
  92      address of the stuff to be disassembled, MYADDR is the address to
  93      put the bytes in, and LENGTH is the number of bytes to read.
  94      INFO is a pointer to this struct.
  95      Returns an errno value or 0 for success.  */
  96   int (*read_memory_func)
  97     PARAMS ((bfd_vma memaddr, bfd_byte *myaddr, unsigned int length,
  98              struct disassemble_info *info));
  99
 100   /* Function which should be called if we get an error that we can't
 101      recover from.  STATUS is the errno value from read_memory_func and
 102      MEMADDR is the address that we were trying to read.  INFO is a
 103      pointer to this struct.  */
 104   void (*memory_error_func)
 105     PARAMS ((int status, bfd_vma memaddr, struct disassemble_info *info));
 106
 107   /* Function called to print ADDR.  */
 108   void (*print_address_func)
 109     PARAMS ((bfd_vma addr, struct disassemble_info *info));
 110
 111   /* Function called to determine if there is a symbol at the given ADDR.
 112      If there is, the function returns 1, otherwise it returns 0.
 113      This is used by ports which support an overlay manager where
 114      the overlay number is held in the top part of an address.  In
 115      some circumstances we want to include the overlay number in the
 116      address, (normally because there is a symbol associated with
 117      that address), but sometimes we want to mask out the overlay bits.  */
 118   int (* symbol_at_address_func)
 119     PARAMS ((bfd_vma addr, struct disassemble_info * info));
 120
 121   /* These are for buffer_read_memory.  */
 122   bfd_byte *buffer;
 123   bfd_vma buffer_vma;
 124   unsigned int buffer_length;
 125
 126   /* This variable may be set by the instruction decoder.  It suggests
 127       the number of bytes objdump should display on a single line.  If
 128       the instruction decoder sets this, it should always set it to
 129       the same value in order to get reasonable looking output.  */
 130   int bytes_per_line;
 131
 132   /* the next two variables control the way objdump displays the raw data */
 133   /* For example, if bytes_per_line is 8 and bytes_per_chunk is 4, the */
 134   /* output will look like this:
 135      00:   00000000 00000000
 136      with the chunks displayed according to "display_endian". */
 137   int bytes_per_chunk;
 138
 139   /* Number of octets per incremented target address
 140      Normally one, but some DSPs have byte sizes of 16 or 32 bits.  */
 141   unsigned int octets_per_byte;
 142
 143   /* Results from instruction decoders.  Not all decoders yet support
 144      this information.  This info is set each time an instruction is
 145      decoded, and is only valid for the last such instruction.
 146
 147      To determine whether this decoder supports this information, set
 148      insn_info_valid to 0, decode an instruction, then check it.  */
 149
 150   char insn_info_valid;         /* Branch info has been set. */
 151   char branch_delay_insns;      /* How many sequential insn's will run before
 152                                    a branch takes effect.  (0 = normal) */
 153   char data_size;               /* Size of data reference in insn, in bytes */
 154   enum dis_insn_type insn_type; /* Type of instruction */
 155   bfd_vma target;               /* Target address of branch or dref, if known;
 156                                    zero if unknown.  */
 157   bfd_vma target2;              /* Second target address for dref2 */
 158
 159   /* Command line options specific to the target disassembler.  */
 160   char * disassembler_options;
 161
 162 } disassemble_info;
 163
 164 \f
 165 /* Standard disassemblers.  Disassemble one instruction at the given
 166    target address.  Return number of octets processed.  */
 167 typedef int (*disassembler_ftype)
 168      PARAMS((bfd_vma, disassemble_info *));
 169
 170 extern int print_insn_big_mips          PARAMS ((bfd_vma, disassemble_info*));
 171 extern int print_insn_little_mips       PARAMS ((bfd_vma, disassemble_info*));
 172 extern int print_insn_i386              PARAMS ((bfd_vma, disassemble_info *));
 173 extern int print_insn_i386_att          PARAMS ((bfd_vma, disassemble_info*));
 174 extern int print_insn_i386_intel        PARAMS ((bfd_vma, disassemble_info*));
 175 extern int print_insn_ia64              PARAMS ((bfd_vma, disassemble_info*));
 176 extern int print_insn_i370              PARAMS ((bfd_vma, disassemble_info*));
 177 extern int print_insn_m68hc11           PARAMS ((bfd_vma, disassemble_info*));
 178 extern int print_insn_m68hc12           PARAMS ((bfd_vma, disassemble_info*));
 179 extern int print_insn_m68k              PARAMS ((bfd_vma, disassemble_info*));
 180 extern int print_insn_z8001             PARAMS ((bfd_vma, disassemble_info*));
 181 extern int print_insn_z8002             PARAMS ((bfd_vma, disassemble_info*));
 182 extern int print_insn_h8300             PARAMS ((bfd_vma, disassemble_info*));
 183 extern int print_insn_h8300h            PARAMS ((bfd_vma, disassemble_info*));
 184 extern int print_insn_h8300s            PARAMS ((bfd_vma, disassemble_info*));
 185 extern int print_insn_h8500             PARAMS ((bfd_vma, disassemble_info*));
 186 extern int print_insn_alpha             PARAMS ((bfd_vma, disassemble_info*));
 187 extern int print_insn_big_arm           PARAMS ((bfd_vma, disassemble_info*));
 188 extern int print_insn_little_arm        PARAMS ((bfd_vma, disassemble_info*));
 189 extern int print_insn_sparc             PARAMS ((bfd_vma, disassemble_info*));
 190 extern int print_insn_big_a29k          PARAMS ((bfd_vma, disassemble_info*));
 191 extern int print_insn_little_a29k       PARAMS ((bfd_vma, disassemble_info*));
 192 extern int print_insn_avr               PARAMS ((bfd_vma, disassemble_info*));
 193 extern int print_insn_d10v              PARAMS ((bfd_vma, disassemble_info*));
 194 extern int print_insn_d30v              PARAMS ((bfd_vma, disassemble_info*));
 195 extern int print_insn_dlx               PARAMS ((bfd_vma, disassemble_info*));
 196 extern int print_insn_fr30              PARAMS ((bfd_vma, disassemble_info*));
 197 extern int print_insn_hppa              PARAMS ((bfd_vma, disassemble_info*));
 198 extern int print_insn_i860              PARAMS ((bfd_vma, disassemble_info*));
 199 extern int print_insn_i960              PARAMS ((bfd_vma, disassemble_info*));
 200 extern int print_insn_ip2k              PARAMS ((bfd_vma, disassemble_info*));
 201 extern int print_insn_m32r              PARAMS ((bfd_vma, disassemble_info*));
 202 extern int print_insn_m88k              PARAMS ((bfd_vma, disassemble_info*));
 203 extern int print_insn_mcore             PARAMS ((bfd_vma, disassemble_info*));
 204 extern int print_insn_mmix              PARAMS ((bfd_vma, disassemble_info*));
 205 extern int print_insn_mn10200           PARAMS ((bfd_vma, disassemble_info*));
 206 extern int print_insn_mn10300           PARAMS ((bfd_vma, disassemble_info*));
 207 extern int print_insn_ns32k             PARAMS ((bfd_vma, disassemble_info*));
 208 extern int print_insn_openrisc          PARAMS ((bfd_vma, disassemble_info*));
 209 extern int print_insn_big_or32          PARAMS ((bfd_vma, disassemble_info*));
 210 extern int print_insn_little_or32       PARAMS ((bfd_vma, disassemble_info*));
 211 extern int print_insn_pdp11             PARAMS ((bfd_vma, disassemble_info*));
 212 extern int print_insn_pj                PARAMS ((bfd_vma, disassemble_info*));
 213 extern int print_insn_big_powerpc       PARAMS ((bfd_vma, disassemble_info*));
 214 extern int print_insn_little_powerpc    PARAMS ((bfd_vma, disassemble_info*));
 215 extern int print_insn_rs6000            PARAMS ((bfd_vma, disassemble_info*));
 216 extern int print_insn_s390              PARAMS ((bfd_vma, disassemble_info*));
 217 extern int print_insn_sh                PARAMS ((bfd_vma, disassemble_info*));
 218 extern int print_insn_tic30             PARAMS ((bfd_vma, disassemble_info*));
 219 extern int print_insn_tic4x             PARAMS ((bfd_vma, disassemble_info*));
 220 extern int print_insn_tic54x            PARAMS ((bfd_vma, disassemble_info*));
 221 extern int print_insn_tic80             PARAMS ((bfd_vma, disassemble_info*));
 222 extern int print_insn_v850              PARAMS ((bfd_vma, disassemble_info*));
 223 extern int print_insn_vax               PARAMS ((bfd_vma, disassemble_info*));
 224 extern int print_insn_w65               PARAMS ((bfd_vma, disassemble_info*));
 225 extern int print_insn_xstormy16         PARAMS ((bfd_vma, disassemble_info*));
 226 extern int print_insn_sh64              PARAMS ((bfd_vma, disassemble_info *));
 227 extern int print_insn_sh64x_media       PARAMS ((bfd_vma, disassemble_info *));
 228 extern int print_insn_frv               PARAMS ((bfd_vma, disassemble_info *));
 229
 230 extern disassembler_ftype arc_get_disassembler PARAMS ((void *));
 231 extern disassembler_ftype cris_get_disassembler PARAMS ((bfd *));
 232
 233 extern void print_arm_disassembler_options PARAMS ((FILE *));
 234 extern void parse_arm_disassembler_option  PARAMS ((char *));
 235 extern int  get_arm_regname_num_options    PARAMS ((void));
 236 extern int  set_arm_regname_option         PARAMS ((int));
 237 extern int  get_arm_regnames               PARAMS ((int, const char **, const char **, const char ***));
 238
 239 /* Fetch the disassembler for a given BFD, if that support is available.  */
 240 extern disassembler_ftype disassembler  PARAMS ((bfd *));
 241
 242 /* Document any target specific options available from the disassembler.  */
 243 extern void disassembler_usage          PARAMS ((FILE *));
 244
 245 \f
 246 /* This block of definitions is for particular callers who read instructions
 247    into a buffer before calling the instruction decoder.  */
 248
 249 /* Here is a function which callers may wish to use for read_memory_func.
 250    It gets bytes from a buffer.  */
 251 extern int buffer_read_memory
 252   PARAMS ((bfd_vma, bfd_byte *, unsigned int, struct disassemble_info *));
 253
 254 /* This function goes with buffer_read_memory.
 255    It prints a message using info->fprintf_func and info->stream.  */
 256 extern void perror_memory PARAMS ((int, bfd_vma, struct disassemble_info *));
 257
 258
 259 /* Just print the address in hex.  This is included for completeness even
 260    though both GDB and objdump provide their own (to print symbolic
 261    addresses).  */
 262 extern void generic_print_address
 263   PARAMS ((bfd_vma, struct disassemble_info *));
 264
 265 /* Always true.  */
 266 extern int generic_symbol_at_address
 267   PARAMS ((bfd_vma, struct disassemble_info *));
 268
 269 /* Macro to initialize a disassemble_info struct.  This should be called
 270    by all applications creating such a struct.  */
 271 #define INIT_DISASSEMBLE_INFO(INFO, STREAM, FPRINTF_FUNC) \
 272   (INFO).insn_sets = 0, \
 273   (INFO).octets_per_byte = 1, \
 274   INIT_DISASSEMBLE_INFO_NO_ARCH(INFO, STREAM, FPRINTF_FUNC)
 275
 276 /* Call this macro to initialize only the internal variables for the
 277    disassembler.  Architecture dependent things such as byte order, or machine
 278    variant are not touched by this macro.  This makes things much easier for
 279    GDB which must initialize these things separately.  */
 280
 281 #define INIT_DISASSEMBLE_INFO_NO_ARCH(INFO, STREAM, FPRINTF_FUNC) \
 282   (INFO).fprintf_func = (fprintf_ftype)(FPRINTF_FUNC), \
 283   (INFO).stream = (PTR)(STREAM), \
 284   (INFO).private_data = NULL, \
 285   (INFO).buffer = NULL, \
 286   (INFO).buffer_vma = 0, \
 287   (INFO).buffer_length = 0, \
 288   (INFO).read_memory_func = buffer_read_memory, \
 289   (INFO).memory_error_func = perror_memory, \
 290   (INFO).print_address_func = generic_print_address, \
 291   (INFO).symbol_at_address_func = generic_symbol_at_address, \
 292   (INFO).flags = 0, \
 293   (INFO).bytes_per_line = 0, \
 294   (INFO).bytes_per_chunk = 0, \
 295   (INFO).disassembler_options = NULL, \
 296   (INFO).insn_info_valid = 0
 297
 298 #ifdef __cplusplus
 299 };
 300 #endif
 301
 302 #endif /* ! defined (DIS_ASM_H) */