Search
lxdream.org :: lxdream/src/x86dasm/dis-asm.h
lxdream 0.9.1
released Jun 29
Download Now
filename src/x86dasm/dis-asm.h
changeset 755:ab873907b00e
prev362:dc40e2064dc4
author nkeynes
date Mon Jul 21 00:08:34 2008 +0000 (13 years ago)
permissions -rw-r--r--
last change Add gettext.h and build sanely without libintl if it's not available
Remove x86dasm's config.h & opintl.h (no longer needed and actually wrong)
file annotate diff log raw
nkeynes@362
     1
/* Interface between the opcode library and its callers.
nkeynes@362
     2
nkeynes@362
     3
   Copyright 1999, 2000, 2001, 2002, 2003, 2004, 2005
nkeynes@362
     4
   Free Software Foundation, Inc.
nkeynes@362
     5
   
nkeynes@362
     6
   This program is free software; you can redistribute it and/or modify
nkeynes@362
     7
   it under the terms of the GNU General Public License as published by
nkeynes@362
     8
   the Free Software Foundation; either version 2, or (at your option)
nkeynes@362
     9
   any later version.
nkeynes@362
    10
nkeynes@362
    11
   This program is distributed in the hope that it will be useful,
nkeynes@362
    12
   but WITHOUT ANY WARRANTY; without even the implied warranty of
nkeynes@362
    13
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
nkeynes@362
    14
   GNU General Public License for more details.
nkeynes@362
    15
nkeynes@362
    16
   You should have received a copy of the GNU General Public License
nkeynes@362
    17
   along with this program; if not, write to the Free Software
nkeynes@362
    18
   Foundation, Inc., 59 Temple Place - Suite 330,
nkeynes@362
    19
   Boston, MA 02111-1307, USA.
nkeynes@362
    20
   
nkeynes@362
    21
   Written by Cygnus Support, 1993.
nkeynes@362
    22
nkeynes@362
    23
   The opcode library (libopcodes.a) provides instruction decoders for
nkeynes@362
    24
   a large variety of instruction sets, callable with an identical
nkeynes@362
    25
   interface, for making instruction-processing programs more independent
nkeynes@362
    26
   of the instruction set being processed.  */
nkeynes@362
    27
nkeynes@362
    28
#ifndef DIS_ASM_H
nkeynes@362
    29
#define DIS_ASM_H
nkeynes@362
    30
nkeynes@362
    31
#ifdef __cplusplus
nkeynes@362
    32
extern "C" {
nkeynes@362
    33
#endif
nkeynes@362
    34
nkeynes@362
    35
#include <stdio.h>
nkeynes@755
    36
#include "x86dasm/bfd.h"
nkeynes@362
    37
nkeynes@362
    38
typedef int (*fprintf_ftype) (void *, const char*, ...);
nkeynes@362
    39
nkeynes@362
    40
enum dis_insn_type {
nkeynes@362
    41
  dis_noninsn,			/* Not a valid instruction */
nkeynes@362
    42
  dis_nonbranch,		/* Not a branch instruction */
nkeynes@362
    43
  dis_branch,			/* Unconditional branch */
nkeynes@362
    44
  dis_condbranch,		/* Conditional branch */
nkeynes@362
    45
  dis_jsr,			/* Jump to subroutine */
nkeynes@362
    46
  dis_condjsr,			/* Conditional jump to subroutine */
nkeynes@362
    47
  dis_dref,			/* Data reference instruction */
nkeynes@362
    48
  dis_dref2			/* Two data references in instruction */
nkeynes@362
    49
};
nkeynes@362
    50
nkeynes@362
    51
/* This struct is passed into the instruction decoding routine, 
nkeynes@362
    52
   and is passed back out into each callback.  The various fields are used
nkeynes@362
    53
   for conveying information from your main routine into your callbacks,
nkeynes@362
    54
   for passing information into the instruction decoders (such as the
nkeynes@362
    55
   addresses of the callback functions), or for passing information
nkeynes@362
    56
   back from the instruction decoders to their callers.
nkeynes@362
    57
nkeynes@362
    58
   It must be initialized before it is first passed; this can be done
nkeynes@362
    59
   by hand, or using one of the initialization macros below.  */
nkeynes@362
    60
nkeynes@362
    61
typedef struct disassemble_info {
nkeynes@362
    62
  fprintf_ftype fprintf_func;
nkeynes@362
    63
  void *stream;
nkeynes@362
    64
  void *application_data;
nkeynes@362
    65
nkeynes@362
    66
  /* Target description.  We could replace this with a pointer to the bfd,
nkeynes@362
    67
     but that would require one.  There currently isn't any such requirement
nkeynes@362
    68
     so to avoid introducing one we record these explicitly.  */
nkeynes@362
    69
  /* The bfd_flavour.  This can be bfd_target_unknown_flavour.  */
nkeynes@362
    70
  enum bfd_flavour flavour;
nkeynes@362
    71
  /* The bfd_arch value.  */
nkeynes@362
    72
  enum bfd_architecture arch;
nkeynes@362
    73
  /* The bfd_mach value.  */
nkeynes@362
    74
  unsigned long mach;
nkeynes@362
    75
  /* Endianness (for bi-endian cpus).  Mono-endian cpus can ignore this.  */
nkeynes@362
    76
  enum bfd_endian endian;
nkeynes@362
    77
  /* An arch/mach-specific bitmask of selected instruction subsets, mainly
nkeynes@362
    78
     for processors with run-time-switchable instruction sets.  The default,
nkeynes@362
    79
     zero, means that there is no constraint.  CGEN-based opcodes ports
nkeynes@362
    80
     may use ISA_foo masks.  */
nkeynes@362
    81
  unsigned long insn_sets;
nkeynes@362
    82
nkeynes@362
    83
  /* Some targets need information about the current section to accurately
nkeynes@362
    84
     display insns.  If this is NULL, the target disassembler function
nkeynes@362
    85
     will have to make its best guess.  */
nkeynes@362
    86
  asection *section;
nkeynes@362
    87
nkeynes@362
    88
  /* An array of pointers to symbols either at the location being disassembled
nkeynes@362
    89
     or at the start of the function being disassembled.  The array is sorted
nkeynes@362
    90
     so that the first symbol is intended to be the one used.  The others are
nkeynes@362
    91
     present for any misc. purposes.  This is not set reliably, but if it is
nkeynes@362
    92
     not NULL, it is correct.  */
nkeynes@362
    93
  asymbol **symbols;
nkeynes@362
    94
  /* Number of symbols in array.  */
nkeynes@362
    95
  int num_symbols;
nkeynes@362
    96
nkeynes@362
    97
  /* For use by the disassembler.
nkeynes@362
    98
     The top 16 bits are reserved for public use (and are documented here).
nkeynes@362
    99
     The bottom 16 bits are for the internal use of the disassembler.  */
nkeynes@362
   100
  unsigned long flags;
nkeynes@362
   101
#define INSN_HAS_RELOC	0x80000000
nkeynes@362
   102
  void *private_data;
nkeynes@362
   103
nkeynes@362
   104
  /* Function used to get bytes to disassemble.  MEMADDR is the
nkeynes@362
   105
     address of the stuff to be disassembled, MYADDR is the address to
nkeynes@362
   106
     put the bytes in, and LENGTH is the number of bytes to read.
nkeynes@362
   107
     INFO is a pointer to this struct.
nkeynes@362
   108
     Returns an errno value or 0 for success.  */
nkeynes@362
   109
  int (*read_memory_func)
nkeynes@362
   110
    (bfd_vma memaddr, bfd_byte *myaddr, unsigned int length,
nkeynes@362
   111
     struct disassemble_info *info);
nkeynes@362
   112
nkeynes@362
   113
  /* Function which should be called if we get an error that we can't
nkeynes@362
   114
     recover from.  STATUS is the errno value from read_memory_func and
nkeynes@362
   115
     MEMADDR is the address that we were trying to read.  INFO is a
nkeynes@362
   116
     pointer to this struct.  */
nkeynes@362
   117
  void (*memory_error_func)
nkeynes@362
   118
    (int status, bfd_vma memaddr, struct disassemble_info *info);
nkeynes@362
   119
nkeynes@362
   120
  /* Function called to print ADDR.  */
nkeynes@362
   121
  void (*print_address_func)
nkeynes@362
   122
    (bfd_vma addr, struct disassemble_info *info);
nkeynes@362
   123
nkeynes@362
   124
  /* Function called to determine if there is a symbol at the given ADDR.
nkeynes@362
   125
     If there is, the function returns 1, otherwise it returns 0.
nkeynes@362
   126
     This is used by ports which support an overlay manager where
nkeynes@362
   127
     the overlay number is held in the top part of an address.  In
nkeynes@362
   128
     some circumstances we want to include the overlay number in the
nkeynes@362
   129
     address, (normally because there is a symbol associated with
nkeynes@362
   130
     that address), but sometimes we want to mask out the overlay bits.  */
nkeynes@362
   131
  int (* symbol_at_address_func)
nkeynes@362
   132
    (bfd_vma addr, struct disassemble_info * info);
nkeynes@362
   133
nkeynes@362
   134
  /* Function called to check if a SYMBOL is can be displayed to the user.
nkeynes@362
   135
     This is used by some ports that want to hide special symbols when
nkeynes@362
   136
     displaying debugging outout.  */
nkeynes@362
   137
  bfd_boolean (* symbol_is_valid)
nkeynes@362
   138
    (asymbol *, struct disassemble_info * info);
nkeynes@362
   139
    
nkeynes@362
   140
  /* These are for buffer_read_memory.  */
nkeynes@362
   141
  bfd_byte *buffer;
nkeynes@362
   142
  bfd_vma buffer_vma;
nkeynes@362
   143
  unsigned int buffer_length;
nkeynes@362
   144
nkeynes@362
   145
  /* This variable may be set by the instruction decoder.  It suggests
nkeynes@362
   146
      the number of bytes objdump should display on a single line.  If
nkeynes@362
   147
      the instruction decoder sets this, it should always set it to
nkeynes@362
   148
      the same value in order to get reasonable looking output.  */
nkeynes@362
   149
  int bytes_per_line;
nkeynes@362
   150
nkeynes@362
   151
  /* The next two variables control the way objdump displays the raw data.  */
nkeynes@362
   152
  /* For example, if bytes_per_line is 8 and bytes_per_chunk is 4, the */
nkeynes@362
   153
  /* output will look like this:
nkeynes@362
   154
     00:   00000000 00000000
nkeynes@362
   155
     with the chunks displayed according to "display_endian". */
nkeynes@362
   156
  int bytes_per_chunk;
nkeynes@362
   157
  enum bfd_endian display_endian;
nkeynes@362
   158
nkeynes@362
   159
  /* Number of octets per incremented target address 
nkeynes@362
   160
     Normally one, but some DSPs have byte sizes of 16 or 32 bits.  */
nkeynes@362
   161
  unsigned int octets_per_byte;
nkeynes@362
   162
nkeynes@362
   163
  /* The number of zeroes we want to see at the end of a section before we
nkeynes@362
   164
     start skipping them.  */
nkeynes@362
   165
  unsigned int skip_zeroes;
nkeynes@362
   166
nkeynes@362
   167
  /* The number of zeroes to skip at the end of a section.  If the number
nkeynes@362
   168
     of zeroes at the end is between SKIP_ZEROES_AT_END and SKIP_ZEROES,
nkeynes@362
   169
     they will be disassembled.  If there are fewer than
nkeynes@362
   170
     SKIP_ZEROES_AT_END, they will be skipped.  This is a heuristic
nkeynes@362
   171
     attempt to avoid disassembling zeroes inserted by section
nkeynes@362
   172
     alignment.  */
nkeynes@362
   173
  unsigned int skip_zeroes_at_end;
nkeynes@362
   174
nkeynes@362
   175
  /* Results from instruction decoders.  Not all decoders yet support
nkeynes@362
   176
     this information.  This info is set each time an instruction is
nkeynes@362
   177
     decoded, and is only valid for the last such instruction.
nkeynes@362
   178
nkeynes@362
   179
     To determine whether this decoder supports this information, set
nkeynes@362
   180
     insn_info_valid to 0, decode an instruction, then check it.  */
nkeynes@362
   181
nkeynes@362
   182
  char insn_info_valid;		/* Branch info has been set. */
nkeynes@362
   183
  char branch_delay_insns;	/* How many sequential insn's will run before
nkeynes@362
   184
				   a branch takes effect.  (0 = normal) */
nkeynes@362
   185
  char data_size;		/* Size of data reference in insn, in bytes */
nkeynes@362
   186
  enum dis_insn_type insn_type;	/* Type of instruction */
nkeynes@362
   187
  bfd_vma target;		/* Target address of branch or dref, if known;
nkeynes@362
   188
				   zero if unknown.  */
nkeynes@362
   189
  bfd_vma target2;		/* Second target address for dref2 */
nkeynes@362
   190
nkeynes@362
   191
  /* Command line options specific to the target disassembler.  */
nkeynes@362
   192
  char * disassembler_options;
nkeynes@362
   193
nkeynes@362
   194
} disassemble_info;
nkeynes@362
   195
nkeynes@362
   196

nkeynes@362
   197
/* Standard disassemblers.  Disassemble one instruction at the given
nkeynes@362
   198
   target address.  Return number of octets processed.  */
nkeynes@362
   199
typedef int (*disassembler_ftype) (bfd_vma, disassemble_info *);
nkeynes@362
   200
nkeynes@362
   201
extern int print_insn_big_mips		(bfd_vma, disassemble_info *);
nkeynes@362
   202
extern int print_insn_little_mips	(bfd_vma, disassemble_info *);
nkeynes@362
   203
extern int print_insn_i386		(bfd_vma, disassemble_info *);
nkeynes@362
   204
extern int print_insn_i386_att		(bfd_vma, disassemble_info *);
nkeynes@362
   205
extern int print_insn_i386_intel	(bfd_vma, disassemble_info *);
nkeynes@362
   206
extern int print_insn_ia64		(bfd_vma, disassemble_info *);
nkeynes@362
   207
extern int print_insn_i370		(bfd_vma, disassemble_info *);
nkeynes@362
   208
extern int print_insn_m68hc11		(bfd_vma, disassemble_info *);
nkeynes@362
   209
extern int print_insn_m68hc12		(bfd_vma, disassemble_info *);
nkeynes@362
   210
extern int print_insn_m68k		(bfd_vma, disassemble_info *);
nkeynes@362
   211
extern int print_insn_z8001		(bfd_vma, disassemble_info *);
nkeynes@362
   212
extern int print_insn_z8002		(bfd_vma, disassemble_info *);
nkeynes@362
   213
extern int print_insn_h8300		(bfd_vma, disassemble_info *);
nkeynes@362
   214
extern int print_insn_h8300h		(bfd_vma, disassemble_info *);
nkeynes@362
   215
extern int print_insn_h8300s		(bfd_vma, disassemble_info *);
nkeynes@362
   216
extern int print_insn_h8500		(bfd_vma, disassemble_info *);
nkeynes@362
   217
extern int print_insn_alpha		(bfd_vma, disassemble_info *);
nkeynes@362
   218
extern int print_insn_big_arm		(bfd_vma, disassemble_info *);
nkeynes@362
   219
extern int print_insn_little_arm	(bfd_vma, disassemble_info *);
nkeynes@362
   220
extern int print_insn_sparc		(bfd_vma, disassemble_info *);
nkeynes@362
   221
extern int print_insn_big_a29k		(bfd_vma, disassemble_info *);
nkeynes@362
   222
extern int print_insn_little_a29k	(bfd_vma, disassemble_info *);
nkeynes@362
   223
extern int print_insn_avr		(bfd_vma, disassemble_info *);
nkeynes@362
   224
extern int print_insn_d10v		(bfd_vma, disassemble_info *);
nkeynes@362
   225
extern int print_insn_d30v		(bfd_vma, disassemble_info *);
nkeynes@362
   226
extern int print_insn_dlx 		(bfd_vma, disassemble_info *);
nkeynes@362
   227
extern int print_insn_fr30		(bfd_vma, disassemble_info *);
nkeynes@362
   228
extern int print_insn_hppa		(bfd_vma, disassemble_info *);
nkeynes@362
   229
extern int print_insn_i860		(bfd_vma, disassemble_info *);
nkeynes@362
   230
extern int print_insn_i960		(bfd_vma, disassemble_info *);
nkeynes@362
   231
extern int print_insn_ip2k		(bfd_vma, disassemble_info *);
nkeynes@362
   232
extern int print_insn_m32r		(bfd_vma, disassemble_info *);
nkeynes@362
   233
extern int print_insn_m88k		(bfd_vma, disassemble_info *);
nkeynes@362
   234
extern int print_insn_maxq_little	(bfd_vma, disassemble_info *);
nkeynes@362
   235
extern int print_insn_maxq_big		(bfd_vma, disassemble_info *);
nkeynes@362
   236
extern int print_insn_mcore		(bfd_vma, disassemble_info *);
nkeynes@362
   237
extern int print_insn_mmix		(bfd_vma, disassemble_info *);
nkeynes@362
   238
extern int print_insn_mn10200		(bfd_vma, disassemble_info *);
nkeynes@362
   239
extern int print_insn_mn10300		(bfd_vma, disassemble_info *);
nkeynes@362
   240
extern int print_insn_msp430		(bfd_vma, disassemble_info *);
nkeynes@362
   241
extern int print_insn_ns32k		(bfd_vma, disassemble_info *);
nkeynes@362
   242
extern int print_insn_crx               (bfd_vma, disassemble_info *);
nkeynes@362
   243
extern int print_insn_openrisc		(bfd_vma, disassemble_info *);
nkeynes@362
   244
extern int print_insn_big_or32		(bfd_vma, disassemble_info *);
nkeynes@362
   245
extern int print_insn_little_or32	(bfd_vma, disassemble_info *);
nkeynes@362
   246
extern int print_insn_pdp11		(bfd_vma, disassemble_info *);
nkeynes@362
   247
extern int print_insn_pj		(bfd_vma, disassemble_info *);
nkeynes@362
   248
extern int print_insn_big_powerpc	(bfd_vma, disassemble_info *);
nkeynes@362
   249
extern int print_insn_little_powerpc	(bfd_vma, disassemble_info *);
nkeynes@362
   250
extern int print_insn_rs6000		(bfd_vma, disassemble_info *);
nkeynes@362
   251
extern int print_insn_s390		(bfd_vma, disassemble_info *); 
nkeynes@362
   252
extern int print_insn_sh		(bfd_vma, disassemble_info *);
nkeynes@362
   253
extern int print_insn_tic30		(bfd_vma, disassemble_info *);
nkeynes@362
   254
extern int print_insn_tic4x		(bfd_vma, disassemble_info *);
nkeynes@362
   255
extern int print_insn_tic54x		(bfd_vma, disassemble_info *);
nkeynes@362
   256
extern int print_insn_tic80		(bfd_vma, disassemble_info *);
nkeynes@362
   257
extern int print_insn_v850		(bfd_vma, disassemble_info *);
nkeynes@362
   258
extern int print_insn_vax		(bfd_vma, disassemble_info *);
nkeynes@362
   259
extern int print_insn_w65		(bfd_vma, disassemble_info *);
nkeynes@362
   260
extern int print_insn_xstormy16		(bfd_vma, disassemble_info *);
nkeynes@362
   261
extern int print_insn_xtensa		(bfd_vma, disassemble_info *);
nkeynes@362
   262
extern int print_insn_sh64		(bfd_vma, disassemble_info *);
nkeynes@362
   263
extern int print_insn_sh64x_media	(bfd_vma, disassemble_info *);
nkeynes@362
   264
extern int print_insn_frv		(bfd_vma, disassemble_info *);
nkeynes@362
   265
extern int print_insn_iq2000		(bfd_vma, disassemble_info *);
nkeynes@362
   266
nkeynes@362
   267
extern disassembler_ftype arc_get_disassembler (void *);
nkeynes@362
   268
extern disassembler_ftype cris_get_disassembler (bfd *);
nkeynes@362
   269
nkeynes@362
   270
extern void print_mips_disassembler_options (FILE *);
nkeynes@362
   271
extern void print_ppc_disassembler_options (FILE *);
nkeynes@362
   272
extern void print_arm_disassembler_options (FILE *);
nkeynes@362
   273
extern void parse_arm_disassembler_option (char *);
nkeynes@362
   274
extern int get_arm_regname_num_options (void);
nkeynes@362
   275
extern int set_arm_regname_option (int);
nkeynes@362
   276
extern int get_arm_regnames (int, const char **, const char **, const char ***);
nkeynes@362
   277
extern bfd_boolean arm_symbol_is_valid (asymbol *, struct disassemble_info *);
nkeynes@362
   278
nkeynes@362
   279
/* Fetch the disassembler for a given BFD, if that support is available.  */
nkeynes@362
   280
extern disassembler_ftype disassembler (bfd *);
nkeynes@362
   281
nkeynes@362
   282
/* Amend the disassemble_info structure as necessary for the target architecture.
nkeynes@362
   283
   Should only be called after initialising the info->arch field.  */
nkeynes@362
   284
extern void disassemble_init_for_target (struct disassemble_info * info);
nkeynes@362
   285
nkeynes@362
   286
/* Document any target specific options available from the disassembler.  */
nkeynes@362
   287
extern void disassembler_usage (FILE *);
nkeynes@362
   288
nkeynes@362
   289

nkeynes@362
   290
/* This block of definitions is for particular callers who read instructions
nkeynes@362
   291
   into a buffer before calling the instruction decoder.  */
nkeynes@362
   292
nkeynes@362
   293
/* Here is a function which callers may wish to use for read_memory_func.
nkeynes@362
   294
   It gets bytes from a buffer.  */
nkeynes@362
   295
extern int buffer_read_memory
nkeynes@362
   296
  (bfd_vma, bfd_byte *, unsigned int, struct disassemble_info *);
nkeynes@362
   297
nkeynes@362
   298
/* This function goes with buffer_read_memory.
nkeynes@362
   299
   It prints a message using info->fprintf_func and info->stream.  */
nkeynes@362
   300
extern void perror_memory (int, bfd_vma, struct disassemble_info *);
nkeynes@362
   301
nkeynes@362
   302
nkeynes@362
   303
/* Just print the address in hex.  This is included for completeness even
nkeynes@362
   304
   though both GDB and objdump provide their own (to print symbolic
nkeynes@362
   305
   addresses).  */
nkeynes@362
   306
extern void generic_print_address
nkeynes@362
   307
  (bfd_vma, struct disassemble_info *);
nkeynes@362
   308
nkeynes@362
   309
/* Always true.  */
nkeynes@362
   310
extern int generic_symbol_at_address
nkeynes@362
   311
  (bfd_vma, struct disassemble_info *);
nkeynes@362
   312
nkeynes@362
   313
/* Also always true.  */  
nkeynes@362
   314
extern bfd_boolean generic_symbol_is_valid
nkeynes@362
   315
  (asymbol *, struct disassemble_info *);
nkeynes@362
   316
  
nkeynes@362
   317
/* Method to initialize a disassemble_info struct.  This should be
nkeynes@362
   318
   called by all applications creating such a struct.  */
nkeynes@362
   319
extern void init_disassemble_info (struct disassemble_info *info, void *stream,
nkeynes@362
   320
				   fprintf_ftype fprintf_func);
nkeynes@362
   321
nkeynes@362
   322
/* For compatibility with existing code.  */
nkeynes@362
   323
#define INIT_DISASSEMBLE_INFO(INFO, STREAM, FPRINTF_FUNC) \
nkeynes@362
   324
  init_disassemble_info (&(INFO), (STREAM), (fprintf_ftype) (FPRINTF_FUNC))
nkeynes@362
   325
#define INIT_DISASSEMBLE_INFO_NO_ARCH(INFO, STREAM, FPRINTF_FUNC) \
nkeynes@362
   326
  init_disassemble_info (&(INFO), (STREAM), (fprintf_ftype) (FPRINTF_FUNC))
nkeynes@362
   327
nkeynes@362
   328
nkeynes@362
   329
#ifdef __cplusplus
nkeynes@362
   330
}
nkeynes@362
   331
#endif
nkeynes@362
   332
nkeynes@362
   333
#endif /* ! defined (DIS_ASM_H) */
.