home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 1999 March / PCWK3A99.iso / Linux / DDD331 / DDD-3_1_.000 / DDD-3_1_ / ddd-3.1.1 / include / dis-asm.h < prev    next >
Encoding:
C/C++ Source or Header  |  1998-04-30  |  10.1 KB  |  231 lines
  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. #define INSN_HAS_RELOC    0x80000000
  63.   PTR private_data;
  64.  
  65.   /* Function used to get bytes to disassemble.  MEMADDR is the
  66.      address of the stuff to be disassembled, MYADDR is the address to
  67.      put the bytes in, and LENGTH is the number of bytes to read.
  68.      INFO is a pointer to this struct.
  69.      Returns an errno value or 0 for success.  */
  70.   int (*read_memory_func)
  71.     PARAMS ((bfd_vma memaddr, bfd_byte *myaddr, int length,
  72.          struct disassemble_info *info));
  73.  
  74.   /* Function which should be called if we get an error that we can't
  75.      recover from.  STATUS is the errno value from read_memory_func and
  76.      MEMADDR is the address that we were trying to read.  INFO is a
  77.      pointer to this struct.  */
  78.   void (*memory_error_func)
  79.     PARAMS ((int status, bfd_vma memaddr, struct disassemble_info *info));
  80.  
  81.   /* Function called to print ADDR.  */
  82.   void (*print_address_func)
  83.     PARAMS ((bfd_vma addr, struct disassemble_info *info));
  84.  
  85.   /* Function called to determine if there is a symbol at the given ADDR.
  86.      If there is, the function returns 1, otherwise it returns 0.
  87.      This is used by ports which support an overlay manager where
  88.      the overlay number is held in the top part of an address.  In
  89.      some circumstances we want to include the overlay number in the
  90.      address, (normally because there is a symbol associated with
  91.      that address), but sometimes we want to mask out the overlay bits.  */
  92.   int (* symbol_at_address_func)
  93.     PARAMS ((bfd_vma addr, struct disassemble_info * info));
  94.  
  95.   /* These are for buffer_read_memory.  */
  96.   bfd_byte *buffer;
  97.   bfd_vma buffer_vma;
  98.   int buffer_length;
  99.  
  100.   /* This variable may be set by the instruction decoder.  It suggests
  101.       the number of bytes objdump should display on a single line.  If
  102.       the instruction decoder sets this, it should always set it to
  103.       the same value in order to get reasonable looking output.  */
  104.   int bytes_per_line;
  105.  
  106.   /* the next two variables control the way objdump displays the raw data */
  107.   /* For example, if bytes_per_line is 8 and bytes_per_chunk is 4, the */
  108.   /* output will look like this:
  109.      00:   00000000 00000000
  110.      with the chunks displayed according to "display_endian". */
  111.   int bytes_per_chunk;
  112.   enum bfd_endian display_endian;
  113.  
  114.   /* Results from instruction decoders.  Not all decoders yet support
  115.      this information.  This info is set each time an instruction is
  116.      decoded, and is only valid for the last such instruction.
  117.  
  118.      To determine whether this decoder supports this information, set
  119.      insn_info_valid to 0, decode an instruction, then check it.  */
  120.  
  121.   char insn_info_valid;        /* Branch info has been set. */
  122.   char branch_delay_insns;    /* How many sequential insn's will run before
  123.                    a branch takes effect.  (0 = normal) */
  124.   char data_size;        /* Size of data reference in insn, in bytes */
  125.   enum dis_insn_type insn_type;    /* Type of instruction */
  126.   bfd_vma target;        /* Target address of branch or dref, if known;
  127.                    zero if unknown.  */
  128.   bfd_vma target2;        /* Second target address for dref2 */
  129.  
  130. } disassemble_info;
  131.  
  132.  
  133. /* Standard disassemblers.  Disassemble one instruction at the given
  134.    target address.  Return number of bytes processed.  */
  135. typedef int (*disassembler_ftype)
  136.      PARAMS((bfd_vma, disassemble_info *));
  137.  
  138. extern int print_insn_big_mips        PARAMS ((bfd_vma, disassemble_info*));
  139. extern int print_insn_little_mips    PARAMS ((bfd_vma, disassemble_info*));
  140. extern int print_insn_i386        PARAMS ((bfd_vma, disassemble_info*));
  141. extern int print_insn_m68k        PARAMS ((bfd_vma, disassemble_info*));
  142. extern int print_insn_z8001        PARAMS ((bfd_vma, disassemble_info*));
  143. extern int print_insn_z8002        PARAMS ((bfd_vma, disassemble_info*));
  144. extern int print_insn_h8300        PARAMS ((bfd_vma, disassemble_info*));
  145. extern int print_insn_h8300h        PARAMS ((bfd_vma, disassemble_info*));
  146. extern int print_insn_h8300s        PARAMS ((bfd_vma, disassemble_info*));
  147. extern int print_insn_h8500        PARAMS ((bfd_vma, disassemble_info*));
  148. extern int print_insn_alpha        PARAMS ((bfd_vma, disassemble_info*));
  149. extern disassembler_ftype arc_get_disassembler PARAMS ((int, int));
  150. extern int print_insn_big_arm        PARAMS ((bfd_vma, disassemble_info*));
  151. extern int print_insn_little_arm    PARAMS ((bfd_vma, disassemble_info*));
  152. extern int print_insn_sparc        PARAMS ((bfd_vma, disassemble_info*));
  153. extern int print_insn_big_a29k        PARAMS ((bfd_vma, disassemble_info*));
  154. extern int print_insn_little_a29k    PARAMS ((bfd_vma, disassemble_info*));
  155. extern int print_insn_i960        PARAMS ((bfd_vma, disassemble_info*));
  156. extern int print_insn_sh        PARAMS ((bfd_vma, disassemble_info*));
  157. extern int print_insn_shl        PARAMS ((bfd_vma, disassemble_info*));
  158. extern int print_insn_hppa        PARAMS ((bfd_vma, disassemble_info*));
  159. extern int print_insn_m32r        PARAMS ((bfd_vma, disassemble_info*));
  160. extern int print_insn_m88k        PARAMS ((bfd_vma, disassemble_info*));
  161. extern int print_insn_mn10200        PARAMS ((bfd_vma, disassemble_info*));
  162. extern int print_insn_mn10300        PARAMS ((bfd_vma, disassemble_info*));
  163. extern int print_insn_ns32k        PARAMS ((bfd_vma, disassemble_info*));
  164. extern int print_insn_big_powerpc    PARAMS ((bfd_vma, disassemble_info*));
  165. extern int print_insn_little_powerpc    PARAMS ((bfd_vma, disassemble_info*));
  166. extern int print_insn_rs6000        PARAMS ((bfd_vma, disassemble_info*));
  167. extern int print_insn_w65        PARAMS ((bfd_vma, disassemble_info*));
  168. extern int print_insn_d10v        PARAMS ((bfd_vma, disassemble_info*));
  169. extern int print_insn_v850        PARAMS ((bfd_vma, disassemble_info*));
  170. extern int print_insn_tic30        PARAMS ((bfd_vma, disassemble_info*));
  171.  
  172. /* Fetch the disassembler for a given BFD, if that support is available.  */
  173. extern disassembler_ftype disassembler    PARAMS ((bfd *));
  174.  
  175.  
  176. /* This block of definitions is for particular callers who read instructions
  177.    into a buffer before calling the instruction decoder.  */
  178.  
  179. /* Here is a function which callers may wish to use for read_memory_func.
  180.    It gets bytes from a buffer.  */
  181. extern int buffer_read_memory
  182.   PARAMS ((bfd_vma, bfd_byte *, int, struct disassemble_info *));
  183.  
  184. /* This function goes with buffer_read_memory.
  185.    It prints a message using info->fprintf_func and info->stream.  */
  186. extern void perror_memory PARAMS ((int, bfd_vma, struct disassemble_info *));
  187.  
  188.  
  189. /* Just print the address in hex.  This is included for completeness even
  190.    though both GDB and objdump provide their own (to print symbolic
  191.    addresses).  */
  192. extern void generic_print_address
  193.   PARAMS ((bfd_vma, struct disassemble_info *));
  194.  
  195. /* Always true.  */
  196. extern int generic_symbol_at_address
  197.   PARAMS ((bfd_vma, struct disassemble_info *));
  198.  
  199. /* Macro to initialize a disassemble_info struct.  This should be called
  200.    by all applications creating such a struct.  */
  201. #define INIT_DISASSEMBLE_INFO(INFO, STREAM, FPRINTF_FUNC) \
  202.   (INFO).flavour = bfd_target_unknown_flavour, \
  203.   (INFO).arch = bfd_arch_unknown, \
  204.   (INFO).mach = 0, \
  205.   (INFO).endian = BFD_ENDIAN_UNKNOWN, \
  206.   INIT_DISASSEMBLE_INFO_NO_ARCH(INFO, STREAM, FPRINTF_FUNC)
  207.  
  208. /* Call this macro to initialize only the internal variables for the
  209.    disassembler.  Architecture dependent things such as byte order, or machine
  210.    variant are not touched by this macro.  This makes things much easier for
  211.    GDB which must initialize these things seperatly.  */
  212.  
  213. #define INIT_DISASSEMBLE_INFO_NO_ARCH(INFO, STREAM, FPRINTF_FUNC) \
  214.   (INFO).fprintf_func = (FPRINTF_FUNC), \
  215.   (INFO).stream = (STREAM), \
  216.   (INFO).symbol = NULL, \
  217.   (INFO).buffer = NULL, \
  218.   (INFO).buffer_vma = 0, \
  219.   (INFO).buffer_length = 0, \
  220.   (INFO).read_memory_func = buffer_read_memory, \
  221.   (INFO).memory_error_func = perror_memory, \
  222.   (INFO).print_address_func = generic_print_address, \
  223.   (INFO).symbol_at_address_func = generic_symbol_at_address, \
  224.   (INFO).flags = 0, \
  225.   (INFO).bytes_per_line = 0, \
  226.   (INFO).bytes_per_chunk = 0, \
  227.   (INFO).display_endian = BFD_ENDIAN_UNKNOWN, \
  228.   (INFO).insn_info_valid = 0
  229.  
  230. #endif /* ! defined (DIS_ASM_H) */
  231.