Open64: osprey/cygnus/include/dis-asm.h Source File

00001 /*
00002  * Copyright 2003, 2004, 2005, 2006 PathScale, Inc.  All Rights Reserved.
00003  */
00004 
00005 /* Interface between the opcode library and its callers.
00006 
00007    Copyright 1999, 2000, 2001, 2002, 2003, 2004, 2005
00008    Free Software Foundation, Inc.
00009    
00010    This program is free software; you can redistribute it and/or modify
00011    it under the terms of the GNU General Public License as published by
00012    the Free Software Foundation; either version 2, or (at your option)
00013    any later version.
00014 
00015    This program is distributed in the hope that it will be useful,
00016    but WITHOUT ANY WARRANTY; without even the implied warranty of
00017    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00018    GNU General Public License for more details.
00019 
00020    You should have received a copy of the GNU General Public License
00021    along with this program; if not, write to the Free Software
00022    Foundation, Inc., 59 Temple Place - Suite 330,
00023    Boston, MA 02111-1307, USA.
00024    
00025    Written by Cygnus Support, 1993.
00026 
00027    The opcode library (libopcodes.a) provides instruction decoders for
00028    a large variety of instruction sets, callable with an identical
00029    interface, for making instruction-processing programs more independent
00030    of the instruction set being processed.  */
00031 
00032 #ifndef DIS_ASM_H
00033 #define DIS_ASM_H
00034 
00035 #ifdef __cplusplus
00036 extern "C" {
00037 #endif
00038 
00039 #include <stdio.h>
00040 #include "bfd.h"
00041 
00042 typedef int (*fprintf_ftype) (void *, const char*, ...);
00043 
00044 enum dis_insn_type {
00045   dis_noninsn,      /* Not a valid instruction */
00046   dis_nonbranch,    /* Not a branch instruction */
00047   dis_branch,     /* Unconditional branch */
00048   dis_condbranch,   /* Conditional branch */
00049   dis_jsr,      /* Jump to subroutine */
00050   dis_condjsr,      /* Conditional jump to subroutine */
00051   dis_dref,     /* Data reference instruction */
00052   dis_dref2     /* Two data references in instruction */
00053 };
00054 
00055 /* This struct is passed into the instruction decoding routine, 
00056    and is passed back out into each callback.  The various fields are used
00057    for conveying information from your main routine into your callbacks,
00058    for passing information into the instruction decoders (such as the
00059    addresses of the callback functions), or for passing information
00060    back from the instruction decoders to their callers.
00061 
00062    It must be initialized before it is first passed; this can be done
00063    by hand, or using one of the initialization macros below.  */
00064 
00065 typedef struct disassemble_info {
00066   fprintf_ftype fprintf_func;
00067   void *stream;
00068   void *application_data;
00069 
00070   /* Target description.  We could replace this with a pointer to the bfd,
00071      but that would require one.  There currently isn't any such requirement
00072      so to avoid introducing one we record these explicitly.  */
00073   /* The bfd_flavour.  This can be bfd_target_unknown_flavour.  */
00074   enum bfd_flavour flavour;
00075   /* The bfd_arch value.  */
00076   enum bfd_architecture arch;
00077   /* The bfd_mach value.  */
00078   unsigned long mach;
00079   /* Endianness (for bi-endian cpus).  Mono-endian cpus can ignore this.  */
00080   enum bfd_endian endian;
00081   /* An arch/mach-specific bitmask of selected instruction subsets, mainly
00082      for processors with run-time-switchable instruction sets.  The default,
00083      zero, means that there is no constraint.  CGEN-based opcodes ports
00084      may use ISA_foo masks.  */
00085   unsigned long insn_sets;
00086 
00087   /* Some targets need information about the current section to accurately
00088      display insns.  If this is NULL, the target disassembler function
00089      will have to make its best guess.  */
00090   asection *section;
00091 
00092   /* An array of pointers to symbols either at the location being disassembled
00093      or at the start of the function being disassembled.  The array is sorted
00094      so that the first symbol is intended to be the one used.  The others are
00095      present for any misc. purposes.  This is not set reliably, but if it is
00096      not NULL, it is correct.  */
00097   asymbol **symbols;
00098   /* Number of symbols in array.  */
00099   int num_symbols;
00100 
00101   /* For use by the disassembler.
00102      The top 16 bits are reserved for public use (and are documented here).
00103      The bottom 16 bits are for the internal use of the disassembler.  */
00104   unsigned long flags;
00105 #define INSN_HAS_RELOC  0x80000000
00106   void *private_data;
00107 
00108   /* Function used to get bytes to disassemble.  MEMADDR is the
00109      address of the stuff to be disassembled, MYADDR is the address to
00110      put the bytes in, and LENGTH is the number of bytes to read.
00111      INFO is a pointer to this struct.
00112      Returns an errno value or 0 for success.  */
00113   int (*read_memory_func)
00114     (bfd_vma memaddr, bfd_byte *myaddr, unsigned int length,
00115      struct disassemble_info *info);
00116 
00117   /* Function which should be called if we get an error that we can't
00118      recover from.  STATUS is the errno value from read_memory_func and
00119      MEMADDR is the address that we were trying to read.  INFO is a
00120      pointer to this struct.  */
00121   void (*memory_error_func)
00122     (int status, bfd_vma memaddr, struct disassemble_info *info);
00123 
00124   /* Function called to print ADDR.  */
00125   void (*print_address_func)
00126     (bfd_vma addr, struct disassemble_info *info);
00127 
00128   /* Function called to determine if there is a symbol at the given ADDR.
00129      If there is, the function returns 1, otherwise it returns 0.
00130      This is used by ports which support an overlay manager where
00131      the overlay number is held in the top part of an address.  In
00132      some circumstances we want to include the overlay number in the
00133      address, (normally because there is a symbol associated with
00134      that address), but sometimes we want to mask out the overlay bits.  */
00135   int (* symbol_at_address_func)
00136     (bfd_vma addr, struct disassemble_info * info);
00137 
00138   /* Function called to check if a SYMBOL is can be displayed to the user.
00139      This is used by some ports that want to hide special symbols when
00140      displaying debugging outout.  */
00141   bfd_boolean (* symbol_is_valid)
00142     (asymbol *, struct disassemble_info * info);
00143     
00144   /* These are for buffer_read_memory.  */
00145   bfd_byte *buffer;
00146   bfd_vma buffer_vma;
00147   unsigned int buffer_length;
00148 
00149   /* This variable may be set by the instruction decoder.  It suggests
00150       the number of bytes objdump should display on a single line.  If
00151       the instruction decoder sets this, it should always set it to
00152       the same value in order to get reasonable looking output.  */
00153   int bytes_per_line;
00154 
00155   /* The next two variables control the way objdump displays the raw data.  */
00156   /* For example, if bytes_per_line is 8 and bytes_per_chunk is 4, the */
00157   /* output will look like this:
00158      00:   00000000 00000000
00159      with the chunks displayed according to "display_endian". */
00160   int bytes_per_chunk;
00161   enum bfd_endian display_endian;
00162 
00163   /* Number of octets per incremented target address 
00164      Normally one, but some DSPs have byte sizes of 16 or 32 bits.  */
00165   unsigned int octets_per_byte;
00166 
00167   /* The number of zeroes we want to see at the end of a section before we
00168      start skipping them.  */
00169   unsigned int skip_zeroes;
00170 
00171   /* The number of zeroes to skip at the end of a section.  If the number
00172      of zeroes at the end is between SKIP_ZEROES_AT_END and SKIP_ZEROES,
00173      they will be disassembled.  If there are fewer than
00174      SKIP_ZEROES_AT_END, they will be skipped.  This is a heuristic
00175      attempt to avoid disassembling zeroes inserted by section
00176      alignment.  */
00177   unsigned int skip_zeroes_at_end;
00178 
00179   /* Results from instruction decoders.  Not all decoders yet support
00180      this information.  This info is set each time an instruction is
00181      decoded, and is only valid for the last such instruction.
00182 
00183      To determine whether this decoder supports this information, set
00184      insn_info_valid to 0, decode an instruction, then check it.  */
00185 
00186   char insn_info_valid;   /* Branch info has been set. */
00187   char branch_delay_insns;  /* How many sequential insn's will run before
00188            a branch takes effect.  (0 = normal) */
00189   char data_size;   /* Size of data reference in insn, in bytes */
00190   enum dis_insn_type insn_type; /* Type of instruction */
00191   bfd_vma target;   /* Target address of branch or dref, if known;
00192            zero if unknown.  */
00193   bfd_vma target2;    /* Second target address for dref2 */
00194 
00195   /* Command line options specific to the target disassembler.  */
00196   char * disassembler_options;
00197 
00198 } disassemble_info;
00199 
00200 
00201 /* Standard disassemblers.  Disassemble one instruction at the given
00202    target address.  Return number of octets processed.  */
00203 typedef int (*disassembler_ftype) (bfd_vma, disassemble_info *);
00204 
00205 extern int print_insn_big_mips    (bfd_vma, disassemble_info *);
00206 extern int print_insn_little_mips (bfd_vma, disassemble_info *);
00207 extern int print_insn_i386    (bfd_vma, disassemble_info *);
00208 extern int print_insn_i386_att    (bfd_vma, disassemble_info *);
00209 extern int print_insn_i386_intel  (bfd_vma, disassemble_info *);
00210 extern int print_insn_ia64    (bfd_vma, disassemble_info *);
00211 extern int print_insn_i370    (bfd_vma, disassemble_info *);
00212 extern int print_insn_m68hc11   (bfd_vma, disassemble_info *);
00213 extern int print_insn_m68hc12   (bfd_vma, disassemble_info *);
00214 extern int print_insn_m68k    (bfd_vma, disassemble_info *);
00215 extern int print_insn_z8001   (bfd_vma, disassemble_info *);
00216 extern int print_insn_z8002   (bfd_vma, disassemble_info *);
00217 extern int print_insn_h8300   (bfd_vma, disassemble_info *);
00218 extern int print_insn_h8300h    (bfd_vma, disassemble_info *);
00219 extern int print_insn_h8300s    (bfd_vma, disassemble_info *);
00220 extern int print_insn_h8500   (bfd_vma, disassemble_info *);
00221 extern int print_insn_alpha   (bfd_vma, disassemble_info *);
00222 extern int print_insn_big_arm   (bfd_vma, disassemble_info *);
00223 extern int print_insn_little_arm  (bfd_vma, disassemble_info *);
00224 extern int print_insn_sparc   (bfd_vma, disassemble_info *);
00225 extern int print_insn_big_a29k    (bfd_vma, disassemble_info *);
00226 extern int print_insn_little_a29k (bfd_vma, disassemble_info *);
00227 extern int print_insn_avr   (bfd_vma, disassemble_info *);
00228 extern int print_insn_d10v    (bfd_vma, disassemble_info *);
00229 extern int print_insn_d30v    (bfd_vma, disassemble_info *);
00230 extern int print_insn_dlx     (bfd_vma, disassemble_info *);
00231 extern int print_insn_fr30    (bfd_vma, disassemble_info *);
00232 extern int print_insn_hppa    (bfd_vma, disassemble_info *);
00233 extern int print_insn_i860    (bfd_vma, disassemble_info *);
00234 extern int print_insn_i960    (bfd_vma, disassemble_info *);
00235 extern int print_insn_ip2k    (bfd_vma, disassemble_info *);
00236 extern int print_insn_m32r    (bfd_vma, disassemble_info *);
00237 extern int print_insn_m88k    (bfd_vma, disassemble_info *);
00238 extern int print_insn_maxq_little (bfd_vma, disassemble_info *);
00239 extern int print_insn_maxq_big    (bfd_vma, disassemble_info *);
00240 extern int print_insn_mcore   (bfd_vma, disassemble_info *);
00241 extern int print_insn_mmix    (bfd_vma, disassemble_info *);
00242 extern int print_insn_mn10200   (bfd_vma, disassemble_info *);
00243 extern int print_insn_mn10300   (bfd_vma, disassemble_info *);
00244 extern int print_insn_msp430    (bfd_vma, disassemble_info *);
00245 extern int print_insn_ns32k   (bfd_vma, disassemble_info *);
00246 extern int print_insn_crx               (bfd_vma, disassemble_info *);
00247 extern int print_insn_openrisc    (bfd_vma, disassemble_info *);
00248 extern int print_insn_big_or32    (bfd_vma, disassemble_info *);
00249 extern int print_insn_little_or32 (bfd_vma, disassemble_info *);
00250 extern int print_insn_pdp11   (bfd_vma, disassemble_info *);
00251 extern int print_insn_pj    (bfd_vma, disassemble_info *);
00252 extern int print_insn_big_powerpc (bfd_vma, disassemble_info *);
00253 extern int print_insn_little_powerpc  (bfd_vma, disassemble_info *);
00254 extern int print_insn_rs6000    (bfd_vma, disassemble_info *);
00255 extern int print_insn_s390    (bfd_vma, disassemble_info *); 
00256 extern int print_insn_sh    (bfd_vma, disassemble_info *);
00257 extern int print_insn_tic30   (bfd_vma, disassemble_info *);
00258 extern int print_insn_tic4x   (bfd_vma, disassemble_info *);
00259 extern int print_insn_tic54x    (bfd_vma, disassemble_info *);
00260 extern int print_insn_tic80   (bfd_vma, disassemble_info *);
00261 extern int print_insn_v850    (bfd_vma, disassemble_info *);
00262 extern int print_insn_vax   (bfd_vma, disassemble_info *);
00263 extern int print_insn_w65   (bfd_vma, disassemble_info *);
00264 extern int print_insn_xstormy16   (bfd_vma, disassemble_info *);
00265 extern int print_insn_xtensa    (bfd_vma, disassemble_info *);
00266 extern int print_insn_sh64    (bfd_vma, disassemble_info *);
00267 extern int print_insn_sh64x_media (bfd_vma, disassemble_info *);
00268 extern int print_insn_frv   (bfd_vma, disassemble_info *);
00269 extern int print_insn_iq2000    (bfd_vma, disassemble_info *);
00270 
00271 extern disassembler_ftype arc_get_disassembler (void *);
00272 extern disassembler_ftype cris_get_disassembler (bfd *);
00273 
00274 extern void print_mips_disassembler_options (FILE *);
00275 extern void print_ppc_disassembler_options (FILE *);
00276 extern void print_arm_disassembler_options (FILE *);
00277 extern void parse_arm_disassembler_option (char *);
00278 extern int get_arm_regname_num_options (void);
00279 extern int set_arm_regname_option (int);
00280 extern int get_arm_regnames (int, const char **, const char **, const char ***);
00281 extern bfd_boolean arm_symbol_is_valid (asymbol *, struct disassemble_info *);
00282 
00283 /* Fetch the disassembler for a given BFD, if that support is available.  */
00284 extern disassembler_ftype disassembler (bfd *);
00285 
00286 /* Amend the disassemble_info structure as necessary for the target architecture.
00287    Should only be called after initialising the info->arch field.  */
00288 extern void disassemble_init_for_target (struct disassemble_info * info);
00289 
00290 /* Document any target specific options available from the disassembler.  */
00291 extern void disassembler_usage (FILE *);
00292 
00293 
00294 /* This block of definitions is for particular callers who read instructions
00295    into a buffer before calling the instruction decoder.  */
00296 
00297 /* Here is a function which callers may wish to use for read_memory_func.
00298    It gets bytes from a buffer.  */
00299 extern int buffer_read_memory
00300   (bfd_vma, bfd_byte *, unsigned int, struct disassemble_info *);
00301 
00302 /* This function goes with buffer_read_memory.
00303    It prints a message using info->fprintf_func and info->stream.  */
00304 extern void perror_memory (int, bfd_vma, struct disassemble_info *);
00305 
00306 
00307 /* Just print the address in hex.  This is included for completeness even
00308    though both GDB and objdump provide their own (to print symbolic
00309    addresses).  */
00310 extern void generic_print_address
00311   (bfd_vma, struct disassemble_info *);
00312 
00313 /* Always true.  */
00314 extern int generic_symbol_at_address
00315   (bfd_vma, struct disassemble_info *);
00316 
00317 /* Also always true.  */  
00318 extern bfd_boolean generic_symbol_is_valid
00319   (asymbol *, struct disassemble_info *);
00320   
00321 /* Method to initialize a disassemble_info struct.  This should be
00322    called by all applications creating such a struct.  */
00323 extern void init_disassemble_info (struct disassemble_info *info, void *stream,
00324            fprintf_ftype fprintf_func);
00325 
00326 /* For compatibility with existing code.  */
00327 #define INIT_DISASSEMBLE_INFO(INFO, STREAM, FPRINTF_FUNC) \
00328   init_disassemble_info (&(INFO), (STREAM), (fprintf_ftype) (FPRINTF_FUNC))
00329 #define INIT_DISASSEMBLE_INFO_NO_ARCH(INFO, STREAM, FPRINTF_FUNC) \
00330   init_disassemble_info (&(INFO), (STREAM), (fprintf_ftype) (FPRINTF_FUNC))
00331 
00332 
00333 #ifdef __cplusplus
00334 }
00335 #endif
00336 
00337 #endif /* ! defined (DIS_ASM_H) */