include/linux/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 /* Hacked by Scott Lurndal at SGI (02/1999) for linux kernel debugger */
  10 /* Upgraded to cygnus CVS Keith Owens <kaos@sgi.com> 30 Oct 2000 */
  11
  12 #ifndef DIS_ASM_H
  13 #define DIS_ASM_H
  14
  15 #ifdef __cplusplus
  16 extern "C" {
  17 #endif
  18
  19         /*
  20          * Misc definitions
  21          */
  22 #ifndef PARAMS
  23 #define PARAMS(x)       x
  24 #endif
  25 #define PTR void *
  26 #define FILE int
  27 #if !defined(NULL)
  28 #define NULL 0
  29 #endif
  30
  31 #define abort()         dis_abort(__LINE__)
  32
  33 static inline void
  34 dis_abort(int line)
  35 {
  36         panic("Aborting disassembler @ line %d\n", line);
  37 }
  38
  39 #include <linux/slab.h>
  40 #include <asm/page.h>
  41 #define xstrdup(string) ({ char *res = kdb_strdup(string, GFP_ATOMIC); if (!res) BUG(); res; })
  42 #define xmalloc(size) ({ void *res = kmalloc(size, GFP_ATOMIC); if (!res) BUG(); res; })
  43 #define free(address) kfree(address)
  44
  45 #if 0   /* CONFIG_KDB */
  46 #include <bfd.h>
  47 #else
  48 #include <asm/bfd.h>
  49 #endif
  50
  51 typedef int (*fprintf_ftype) PARAMS((PTR, const char*, ...));
  52
  53 enum dis_insn_type {
  54   dis_noninsn,                  /* Not a valid instruction */
  55   dis_nonbranch,                /* Not a branch instruction */
  56   dis_branch,                   /* Unconditional branch */
  57   dis_condbranch,               /* Conditional branch */
  58   dis_jsr,                      /* Jump to subroutine */
  59   dis_condjsr,                  /* Conditional jump to subroutine */
  60   dis_dref,                     /* Data reference instruction */
  61   dis_dref2                     /* Two data references in instruction */
  62 };
  63
  64 /* This struct is passed into the instruction decoding routine,
  65    and is passed back out into each callback.  The various fields are used
  66    for conveying information from your main routine into your callbacks,
  67    for passing information into the instruction decoders (such as the
  68    addresses of the callback functions), or for passing information
  69    back from the instruction decoders to their callers.
  70
  71    It must be initialized before it is first passed; this can be done
  72    by hand, or using one of the initialization macros below.  */
  73
  74 typedef struct disassemble_info {
  75   fprintf_ftype fprintf_func;
  76   fprintf_ftype fprintf_dummy;
  77   PTR stream;
  78   PTR application_data;
  79
  80   /* Target description.  We could replace this with a pointer to the bfd,
  81      but that would require one.  There currently isn't any such requirement
  82      so to avoid introducing one we record these explicitly.  */
  83   /* The bfd_flavour.  This can be bfd_target_unknown_flavour.  */
  84   enum bfd_flavour flavour;
  85   /* The bfd_arch value.  */
  86   enum bfd_architecture arch;
  87   /* The bfd_mach value.  */
  88   unsigned long mach;
  89   /* Endianness (for bi-endian cpus).  Mono-endian cpus can ignore this.  */
  90   enum bfd_endian endian;
  91
  92   /* An array of pointers to symbols either at the location being disassembled
  93      or at the start of the function being disassembled.  The array is sorted
  94      so that the first symbol is intended to be the one used.  The others are
  95      present for any misc. purposes.  This is not set reliably, but if it is
  96      not NULL, it is correct.  */
  97   asymbol **symbols;
  98   /* Number of symbols in array.  */
  99   int num_symbols;
 100
 101   /* For use by the disassembler.
 102      The top 16 bits are reserved for public use (and are documented here).
 103      The bottom 16 bits are for the internal use of the disassembler.  */
 104   unsigned long flags;
 105 #define INSN_HAS_RELOC  0x80000000
 106   PTR private_data;
 107
 108   /* Function used to get bytes to disassemble.  MEMADDR is the
 109      address of the stuff to be disassembled, MYADDR is the address to
 110      put the bytes in, and LENGTH is the number of bytes to read.
 111      INFO is a pointer to this struct.
 112      Returns an errno value or 0 for success.  */
 113   int (*read_memory_func)
 114     PARAMS ((bfd_vma memaddr, bfd_byte *myaddr, unsigned int length,
 115              struct disassemble_info *info));
 116
 117   /* Function which should be called if we get an error that we can't
 118      recover from.  STATUS is the errno value from read_memory_func and
 119      MEMADDR is the address that we were trying to read.  INFO is a
 120      pointer to this struct.  */
 121   void (*memory_error_func)
 122     PARAMS ((int status, bfd_vma memaddr, struct disassemble_info *info));
 123
 124   /* Function called to print ADDR.  */
 125   void (*print_address_func)
 126     PARAMS ((bfd_vma addr, struct disassemble_info *info));
 127
 128   /* Function called to determine if there is a symbol at the given ADDR.
 129      If there is, the function returns 1, otherwise it returns 0.
 130      This is used by ports which support an overlay manager where
 131      the overlay number is held in the top part of an address.  In
 132      some circumstances we want to include the overlay number in the
 133      address, (normally because there is a symbol associated with
 134      that address), but sometimes we want to mask out the overlay bits.  */
 135   int (* symbol_at_address_func)
 136     PARAMS ((bfd_vma addr, struct disassemble_info * info));
 137
 138   /* These are for buffer_read_memory.  */
 139   bfd_byte *buffer;
 140   bfd_vma buffer_vma;
 141   unsigned int buffer_length;
 142
 143   /* This variable may be set by the instruction decoder.  It suggests
 144       the number of bytes objdump should display on a single line.  If
 145       the instruction decoder sets this, it should always set it to
 146       the same value in order to get reasonable looking output.  */
 147   int bytes_per_line;
 148
 149   /* the next two variables control the way objdump displays the raw data */
 150   /* For example, if bytes_per_line is 8 and bytes_per_chunk is 4, the */
 151   /* output will look like this:
 152      00:   00000000 00000000
 153      with the chunks displayed according to "display_endian". */
 154   int bytes_per_chunk;
 155   enum bfd_endian display_endian;
 156
 157   /* Number of octets per incremented target address
 158      Normally one, but some DSPs have byte sizes of 16 or 32 bits
 159    */
 160   unsigned int octets_per_byte;
 161
 162   /* Results from instruction decoders.  Not all decoders yet support
 163      this information.  This info is set each time an instruction is
 164      decoded, and is only valid for the last such instruction.
 165
 166      To determine whether this decoder supports this information, set
 167      insn_info_valid to 0, decode an instruction, then check it.  */
 168
 169   char insn_info_valid;         /* Branch info has been set. */
 170   char branch_delay_insns;      /* How many sequential insn's will run before
 171                                    a branch takes effect.  (0 = normal) */
 172   char data_size;               /* Size of data reference in insn, in bytes */
 173   enum dis_insn_type insn_type; /* Type of instruction */
 174   bfd_vma target;               /* Target address of branch or dref, if known;
 175                                    zero if unknown.  */
 176   bfd_vma target2;              /* Second target address for dref2 */
 177
 178   /* Command line options specific to the target disassembler.  */
 179   char * disassembler_options;
 180
 181 } disassemble_info;
 182
 183 \f
 184 /* Standard disassemblers.  Disassemble one instruction at the given
 185    target address.  Return number of bytes processed.  */
 186 typedef int (*disassembler_ftype)
 187      PARAMS((bfd_vma, disassemble_info *));
 188
 189 extern int print_insn_big_mips          PARAMS ((bfd_vma, disassemble_info*));
 190 extern int print_insn_little_mips       PARAMS ((bfd_vma, disassemble_info*));
 191 extern int print_insn_i386_att          PARAMS ((bfd_vma, disassemble_info*));
 192 extern int print_insn_i386_intel        PARAMS ((bfd_vma, disassemble_info*));
 193 extern int print_insn_ia64              PARAMS ((bfd_vma, disassemble_info*));
 194 extern int print_insn_i370              PARAMS ((bfd_vma, disassemble_info*));
 195 extern int print_insn_m68hc11           PARAMS ((bfd_vma, disassemble_info*));
 196 extern int print_insn_m68hc12           PARAMS ((bfd_vma, disassemble_info*));
 197 extern int print_insn_m68k              PARAMS ((bfd_vma, disassemble_info*));
 198 extern int print_insn_z8001             PARAMS ((bfd_vma, disassemble_info*));
 199 extern int print_insn_z8002             PARAMS ((bfd_vma, disassemble_info*));
 200 extern int print_insn_h8300             PARAMS ((bfd_vma, disassemble_info*));
 201 extern int print_insn_h8300h            PARAMS ((bfd_vma, disassemble_info*));
 202 extern int print_insn_h8300s            PARAMS ((bfd_vma, disassemble_info*));
 203 extern int print_insn_h8500             PARAMS ((bfd_vma, disassemble_info*));
 204 extern int print_insn_alpha             PARAMS ((bfd_vma, disassemble_info*));
 205 extern disassembler_ftype arc_get_disassembler PARAMS ((int, int));
 206 extern int print_insn_big_arm           PARAMS ((bfd_vma, disassemble_info*));
 207 extern int print_insn_little_arm        PARAMS ((bfd_vma, disassemble_info*));
 208 extern int print_insn_sparc             PARAMS ((bfd_vma, disassemble_info*));
 209 extern int print_insn_big_a29k          PARAMS ((bfd_vma, disassemble_info*));
 210 extern int print_insn_little_a29k       PARAMS ((bfd_vma, disassemble_info*));
 211 extern int print_insn_i860              PARAMS ((bfd_vma, disassemble_info*));
 212 extern int print_insn_i960              PARAMS ((bfd_vma, disassemble_info*));
 213 extern int print_insn_sh                PARAMS ((bfd_vma, disassemble_info*));
 214 extern int print_insn_shl               PARAMS ((bfd_vma, disassemble_info*));
 215 extern int print_insn_hppa              PARAMS ((bfd_vma, disassemble_info*));
 216 extern int print_insn_fr30              PARAMS ((bfd_vma, disassemble_info*));
 217 extern int print_insn_m32r              PARAMS ((bfd_vma, disassemble_info*));
 218 extern int print_insn_m88k              PARAMS ((bfd_vma, disassemble_info*));
 219 extern int print_insn_mcore             PARAMS ((bfd_vma, disassemble_info*));
 220 extern int print_insn_mn10200           PARAMS ((bfd_vma, disassemble_info*));
 221 extern int print_insn_mn10300           PARAMS ((bfd_vma, disassemble_info*));
 222 extern int print_insn_ns32k             PARAMS ((bfd_vma, disassemble_info*));
 223 extern int print_insn_big_powerpc       PARAMS ((bfd_vma, disassemble_info*));
 224 extern int print_insn_little_powerpc    PARAMS ((bfd_vma, disassemble_info*));
 225 extern int print_insn_rs6000            PARAMS ((bfd_vma, disassemble_info*));
 226 extern int print_insn_w65               PARAMS ((bfd_vma, disassemble_info*));
 227 extern disassembler_ftype cris_get_disassembler PARAMS ((bfd *));
 228 extern int print_insn_d10v              PARAMS ((bfd_vma, disassemble_info*));
 229 extern int print_insn_d30v              PARAMS ((bfd_vma, disassemble_info*));
 230 extern int print_insn_v850              PARAMS ((bfd_vma, disassemble_info*));
 231 extern int print_insn_tic30             PARAMS ((bfd_vma, disassemble_info*));
 232 extern int print_insn_vax               PARAMS ((bfd_vma, disassemble_info*));
 233 extern int print_insn_tic54x            PARAMS ((bfd_vma, disassemble_info*));
 234 extern int print_insn_tic80             PARAMS ((bfd_vma, disassemble_info*));
 235 extern int print_insn_pj                PARAMS ((bfd_vma, disassemble_info*));
 236 extern int print_insn_avr               PARAMS ((bfd_vma, disassemble_info*));
 237
 238 extern void print_arm_disassembler_options PARAMS ((FILE *));
 239 extern void parse_arm_disassembler_option  PARAMS ((char *));
 240 extern int  get_arm_regname_num_options    PARAMS ((void));
 241 extern int  set_arm_regname_option         PARAMS ((int));
 242 extern int  get_arm_regnames               PARAMS ((int, const char **, const char **, const char ***));
 243
 244 /* Fetch the disassembler for a given BFD, if that support is available.  */
 245 extern disassembler_ftype disassembler  PARAMS ((bfd *));
 246
 247 /* Document any target specific options available from the disassembler.  */
 248 extern void disassembler_usage          PARAMS ((FILE *));
 249
 250 \f
 251 /* This block of definitions is for particular callers who read instructions
 252    into a buffer before calling the instruction decoder.  */
 253
 254 /* Here is a function which callers may wish to use for read_memory_func.
 255    It gets bytes from a buffer.  */
 256 extern int buffer_read_memory
 257   PARAMS ((bfd_vma, bfd_byte *, unsigned int, struct disassemble_info *));
 258
 259 /* This function goes with buffer_read_memory.
 260    It prints a message using info->fprintf_func and info->stream.  */
 261 extern void perror_memory PARAMS ((int, bfd_vma, struct disassemble_info *));
 262
 263
 264 /* Just print the address in hex.  This is included for completeness even
 265    though both GDB and objdump provide their own (to print symbolic
 266    addresses).  */
 267 extern void generic_print_address
 268   PARAMS ((bfd_vma, struct disassemble_info *));
 269
 270 /* Always true.  */
 271 extern int generic_symbol_at_address
 272   PARAMS ((bfd_vma, struct disassemble_info *));
 273
 274 /* Macro to initialize a disassemble_info struct.  This should be called
 275    by all applications creating such a struct.  */
 276 #define INIT_DISASSEMBLE_INFO(INFO, STREAM, FPRINTF_FUNC) \
 277   (INFO).flavour = bfd_target_unknown_flavour, \
 278   (INFO).arch = bfd_arch_unknown, \
 279   (INFO).mach = 0, \
 280   (INFO).endian = BFD_ENDIAN_UNKNOWN, \
 281   (INFO).octets_per_byte = 1, \
 282   INIT_DISASSEMBLE_INFO_NO_ARCH(INFO, STREAM, FPRINTF_FUNC)
 283
 284 /* Call this macro to initialize only the internal variables for the
 285    disassembler.  Architecture dependent things such as byte order, or machine
 286    variant are not touched by this macro.  This makes things much easier for
 287    GDB which must initialize these things separately.  */
 288
 289 #define INIT_DISASSEMBLE_INFO_NO_ARCH(INFO, STREAM, FPRINTF_FUNC) \
 290   (INFO).fprintf_func = (fprintf_ftype)(FPRINTF_FUNC), \
 291   (INFO).stream = (PTR)(STREAM), \
 292   (INFO).symbols = NULL, \
 293   (INFO).num_symbols = 0, \
 294   (INFO).buffer = NULL, \
 295   (INFO).buffer_vma = 0, \
 296   (INFO).buffer_length = 0, \
 297   (INFO).read_memory_func = buffer_read_memory, \
 298   (INFO).memory_error_func = perror_memory, \
 299   (INFO).print_address_func = generic_print_address, \
 300   (INFO).symbol_at_address_func = generic_symbol_at_address, \
 301   (INFO).flags = 0, \
 302   (INFO).bytes_per_line = 0, \
 303   (INFO).bytes_per_chunk = 0, \
 304   (INFO).display_endian = BFD_ENDIAN_UNKNOWN, \
 305   (INFO).insn_info_valid = 0
 306
 307 #ifdef __cplusplus
 308 };
 309 #endif
 310
 311 #endif /* ! defined (DIS_ASM_H) */