Search
lxdream.org :: lxdream/src/x86dasm/dis-asm.h :: diff
lxdream 0.9.1
released Jun 29
Download Now
filename src/x86dasm/dis-asm.h
changeset 362:dc40e2064dc4
next755:ab873907b00e
author nkeynes
date Tue Aug 28 08:46:54 2007 +0000 (12 years ago)
permissions -rw-r--r--
last change Add the i386 disassembler from binutils (why write your own if you don't
have to) to use for translator validation
file annotate diff log raw
1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/x86dasm/dis-asm.h Tue Aug 28 08:46:54 2007 +0000
1.3 @@ -0,0 +1,333 @@
1.4 +/* Interface between the opcode library and its callers.
1.5 +
1.6 + Copyright 1999, 2000, 2001, 2002, 2003, 2004, 2005
1.7 + Free Software Foundation, Inc.
1.8 +
1.9 + This program is free software; you can redistribute it and/or modify
1.10 + it under the terms of the GNU General Public License as published by
1.11 + the Free Software Foundation; either version 2, or (at your option)
1.12 + any later version.
1.13 +
1.14 + This program is distributed in the hope that it will be useful,
1.15 + but WITHOUT ANY WARRANTY; without even the implied warranty of
1.16 + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1.17 + GNU General Public License for more details.
1.18 +
1.19 + You should have received a copy of the GNU General Public License
1.20 + along with this program; if not, write to the Free Software
1.21 + Foundation, Inc., 59 Temple Place - Suite 330,
1.22 + Boston, MA 02111-1307, USA.
1.23 +
1.24 + Written by Cygnus Support, 1993.
1.25 +
1.26 + The opcode library (libopcodes.a) provides instruction decoders for
1.27 + a large variety of instruction sets, callable with an identical
1.28 + interface, for making instruction-processing programs more independent
1.29 + of the instruction set being processed. */
1.30 +
1.31 +#ifndef DIS_ASM_H
1.32 +#define DIS_ASM_H
1.33 +
1.34 +#ifdef __cplusplus
1.35 +extern "C" {
1.36 +#endif
1.37 +
1.38 +#include <stdio.h>
1.39 +#include "bfd.h"
1.40 +
1.41 +typedef int (*fprintf_ftype) (void *, const char*, ...);
1.42 +
1.43 +enum dis_insn_type {
1.44 + dis_noninsn, /* Not a valid instruction */
1.45 + dis_nonbranch, /* Not a branch instruction */
1.46 + dis_branch, /* Unconditional branch */
1.47 + dis_condbranch, /* Conditional branch */
1.48 + dis_jsr, /* Jump to subroutine */
1.49 + dis_condjsr, /* Conditional jump to subroutine */
1.50 + dis_dref, /* Data reference instruction */
1.51 + dis_dref2 /* Two data references in instruction */
1.52 +};
1.53 +
1.54 +/* This struct is passed into the instruction decoding routine,
1.55 + and is passed back out into each callback. The various fields are used
1.56 + for conveying information from your main routine into your callbacks,
1.57 + for passing information into the instruction decoders (such as the
1.58 + addresses of the callback functions), or for passing information
1.59 + back from the instruction decoders to their callers.
1.60 +
1.61 + It must be initialized before it is first passed; this can be done
1.62 + by hand, or using one of the initialization macros below. */
1.63 +
1.64 +typedef struct disassemble_info {
1.65 + fprintf_ftype fprintf_func;
1.66 + void *stream;
1.67 + void *application_data;
1.68 +
1.69 + /* Target description. We could replace this with a pointer to the bfd,
1.70 + but that would require one. There currently isn't any such requirement
1.71 + so to avoid introducing one we record these explicitly. */
1.72 + /* The bfd_flavour. This can be bfd_target_unknown_flavour. */
1.73 + enum bfd_flavour flavour;
1.74 + /* The bfd_arch value. */
1.75 + enum bfd_architecture arch;
1.76 + /* The bfd_mach value. */
1.77 + unsigned long mach;
1.78 + /* Endianness (for bi-endian cpus). Mono-endian cpus can ignore this. */
1.79 + enum bfd_endian endian;
1.80 + /* An arch/mach-specific bitmask of selected instruction subsets, mainly
1.81 + for processors with run-time-switchable instruction sets. The default,
1.82 + zero, means that there is no constraint. CGEN-based opcodes ports
1.83 + may use ISA_foo masks. */
1.84 + unsigned long insn_sets;
1.85 +
1.86 + /* Some targets need information about the current section to accurately
1.87 + display insns. If this is NULL, the target disassembler function
1.88 + will have to make its best guess. */
1.89 + asection *section;
1.90 +
1.91 + /* An array of pointers to symbols either at the location being disassembled
1.92 + or at the start of the function being disassembled. The array is sorted
1.93 + so that the first symbol is intended to be the one used. The others are
1.94 + present for any misc. purposes. This is not set reliably, but if it is
1.95 + not NULL, it is correct. */
1.96 + asymbol **symbols;
1.97 + /* Number of symbols in array. */
1.98 + int num_symbols;
1.99 +
1.100 + /* For use by the disassembler.
1.101 + The top 16 bits are reserved for public use (and are documented here).
1.102 + The bottom 16 bits are for the internal use of the disassembler. */
1.103 + unsigned long flags;
1.104 +#define INSN_HAS_RELOC 0x80000000
1.105 + void *private_data;
1.106 +
1.107 + /* Function used to get bytes to disassemble. MEMADDR is the
1.108 + address of the stuff to be disassembled, MYADDR is the address to
1.109 + put the bytes in, and LENGTH is the number of bytes to read.
1.110 + INFO is a pointer to this struct.
1.111 + Returns an errno value or 0 for success. */
1.112 + int (*read_memory_func)
1.113 + (bfd_vma memaddr, bfd_byte *myaddr, unsigned int length,
1.114 + struct disassemble_info *info);
1.115 +
1.116 + /* Function which should be called if we get an error that we can't
1.117 + recover from. STATUS is the errno value from read_memory_func and
1.118 + MEMADDR is the address that we were trying to read. INFO is a
1.119 + pointer to this struct. */
1.120 + void (*memory_error_func)
1.121 + (int status, bfd_vma memaddr, struct disassemble_info *info);
1.122 +
1.123 + /* Function called to print ADDR. */
1.124 + void (*print_address_func)
1.125 + (bfd_vma addr, struct disassemble_info *info);
1.126 +
1.127 + /* Function called to determine if there is a symbol at the given ADDR.
1.128 + If there is, the function returns 1, otherwise it returns 0.
1.129 + This is used by ports which support an overlay manager where
1.130 + the overlay number is held in the top part of an address. In
1.131 + some circumstances we want to include the overlay number in the
1.132 + address, (normally because there is a symbol associated with
1.133 + that address), but sometimes we want to mask out the overlay bits. */
1.134 + int (* symbol_at_address_func)
1.135 + (bfd_vma addr, struct disassemble_info * info);
1.136 +
1.137 + /* Function called to check if a SYMBOL is can be displayed to the user.
1.138 + This is used by some ports that want to hide special symbols when
1.139 + displaying debugging outout. */
1.140 + bfd_boolean (* symbol_is_valid)
1.141 + (asymbol *, struct disassemble_info * info);
1.142 +
1.143 + /* These are for buffer_read_memory. */
1.144 + bfd_byte *buffer;
1.145 + bfd_vma buffer_vma;
1.146 + unsigned int buffer_length;
1.147 +
1.148 + /* This variable may be set by the instruction decoder. It suggests
1.149 + the number of bytes objdump should display on a single line. If
1.150 + the instruction decoder sets this, it should always set it to
1.151 + the same value in order to get reasonable looking output. */
1.152 + int bytes_per_line;
1.153 +
1.154 + /* The next two variables control the way objdump displays the raw data. */
1.155 + /* For example, if bytes_per_line is 8 and bytes_per_chunk is 4, the */
1.156 + /* output will look like this:
1.157 + 00: 00000000 00000000
1.158 + with the chunks displayed according to "display_endian". */
1.159 + int bytes_per_chunk;
1.160 + enum bfd_endian display_endian;
1.161 +
1.162 + /* Number of octets per incremented target address
1.163 + Normally one, but some DSPs have byte sizes of 16 or 32 bits. */
1.164 + unsigned int octets_per_byte;
1.165 +
1.166 + /* The number of zeroes we want to see at the end of a section before we
1.167 + start skipping them. */
1.168 + unsigned int skip_zeroes;
1.169 +
1.170 + /* The number of zeroes to skip at the end of a section. If the number
1.171 + of zeroes at the end is between SKIP_ZEROES_AT_END and SKIP_ZEROES,
1.172 + they will be disassembled. If there are fewer than
1.173 + SKIP_ZEROES_AT_END, they will be skipped. This is a heuristic
1.174 + attempt to avoid disassembling zeroes inserted by section
1.175 + alignment. */
1.176 + unsigned int skip_zeroes_at_end;
1.177 +
1.178 + /* Results from instruction decoders. Not all decoders yet support
1.179 + this information. This info is set each time an instruction is
1.180 + decoded, and is only valid for the last such instruction.
1.181 +
1.182 + To determine whether this decoder supports this information, set
1.183 + insn_info_valid to 0, decode an instruction, then check it. */
1.184 +
1.185 + char insn_info_valid; /* Branch info has been set. */
1.186 + char branch_delay_insns; /* How many sequential insn's will run before
1.187 + a branch takes effect. (0 = normal) */
1.188 + char data_size; /* Size of data reference in insn, in bytes */
1.189 + enum dis_insn_type insn_type; /* Type of instruction */
1.190 + bfd_vma target; /* Target address of branch or dref, if known;
1.191 + zero if unknown. */
1.192 + bfd_vma target2; /* Second target address for dref2 */
1.193 +
1.194 + /* Command line options specific to the target disassembler. */
1.195 + char * disassembler_options;
1.196 +
1.197 +} disassemble_info;
1.198 +
1.199 +
1.200 +/* Standard disassemblers. Disassemble one instruction at the given
1.201 + target address. Return number of octets processed. */
1.202 +typedef int (*disassembler_ftype) (bfd_vma, disassemble_info *);
1.203 +
1.204 +extern int print_insn_big_mips (bfd_vma, disassemble_info *);
1.205 +extern int print_insn_little_mips (bfd_vma, disassemble_info *);
1.206 +extern int print_insn_i386 (bfd_vma, disassemble_info *);
1.207 +extern int print_insn_i386_att (bfd_vma, disassemble_info *);
1.208 +extern int print_insn_i386_intel (bfd_vma, disassemble_info *);
1.209 +extern int print_insn_ia64 (bfd_vma, disassemble_info *);
1.210 +extern int print_insn_i370 (bfd_vma, disassemble_info *);
1.211 +extern int print_insn_m68hc11 (bfd_vma, disassemble_info *);
1.212 +extern int print_insn_m68hc12 (bfd_vma, disassemble_info *);
1.213 +extern int print_insn_m68k (bfd_vma, disassemble_info *);
1.214 +extern int print_insn_z8001 (bfd_vma, disassemble_info *);
1.215 +extern int print_insn_z8002 (bfd_vma, disassemble_info *);
1.216 +extern int print_insn_h8300 (bfd_vma, disassemble_info *);
1.217 +extern int print_insn_h8300h (bfd_vma, disassemble_info *);
1.218 +extern int print_insn_h8300s (bfd_vma, disassemble_info *);
1.219 +extern int print_insn_h8500 (bfd_vma, disassemble_info *);
1.220 +extern int print_insn_alpha (bfd_vma, disassemble_info *);
1.221 +extern int print_insn_big_arm (bfd_vma, disassemble_info *);
1.222 +extern int print_insn_little_arm (bfd_vma, disassemble_info *);
1.223 +extern int print_insn_sparc (bfd_vma, disassemble_info *);
1.224 +extern int print_insn_big_a29k (bfd_vma, disassemble_info *);
1.225 +extern int print_insn_little_a29k (bfd_vma, disassemble_info *);
1.226 +extern int print_insn_avr (bfd_vma, disassemble_info *);
1.227 +extern int print_insn_d10v (bfd_vma, disassemble_info *);
1.228 +extern int print_insn_d30v (bfd_vma, disassemble_info *);
1.229 +extern int print_insn_dlx (bfd_vma, disassemble_info *);
1.230 +extern int print_insn_fr30 (bfd_vma, disassemble_info *);
1.231 +extern int print_insn_hppa (bfd_vma, disassemble_info *);
1.232 +extern int print_insn_i860 (bfd_vma, disassemble_info *);
1.233 +extern int print_insn_i960 (bfd_vma, disassemble_info *);
1.234 +extern int print_insn_ip2k (bfd_vma, disassemble_info *);
1.235 +extern int print_insn_m32r (bfd_vma, disassemble_info *);
1.236 +extern int print_insn_m88k (bfd_vma, disassemble_info *);
1.237 +extern int print_insn_maxq_little (bfd_vma, disassemble_info *);
1.238 +extern int print_insn_maxq_big (bfd_vma, disassemble_info *);
1.239 +extern int print_insn_mcore (bfd_vma, disassemble_info *);
1.240 +extern int print_insn_mmix (bfd_vma, disassemble_info *);
1.241 +extern int print_insn_mn10200 (bfd_vma, disassemble_info *);
1.242 +extern int print_insn_mn10300 (bfd_vma, disassemble_info *);
1.243 +extern int print_insn_msp430 (bfd_vma, disassemble_info *);
1.244 +extern int print_insn_ns32k (bfd_vma, disassemble_info *);
1.245 +extern int print_insn_crx (bfd_vma, disassemble_info *);
1.246 +extern int print_insn_openrisc (bfd_vma, disassemble_info *);
1.247 +extern int print_insn_big_or32 (bfd_vma, disassemble_info *);
1.248 +extern int print_insn_little_or32 (bfd_vma, disassemble_info *);
1.249 +extern int print_insn_pdp11 (bfd_vma, disassemble_info *);
1.250 +extern int print_insn_pj (bfd_vma, disassemble_info *);
1.251 +extern int print_insn_big_powerpc (bfd_vma, disassemble_info *);
1.252 +extern int print_insn_little_powerpc (bfd_vma, disassemble_info *);
1.253 +extern int print_insn_rs6000 (bfd_vma, disassemble_info *);
1.254 +extern int print_insn_s390 (bfd_vma, disassemble_info *);
1.255 +extern int print_insn_sh (bfd_vma, disassemble_info *);
1.256 +extern int print_insn_tic30 (bfd_vma, disassemble_info *);
1.257 +extern int print_insn_tic4x (bfd_vma, disassemble_info *);
1.258 +extern int print_insn_tic54x (bfd_vma, disassemble_info *);
1.259 +extern int print_insn_tic80 (bfd_vma, disassemble_info *);
1.260 +extern int print_insn_v850 (bfd_vma, disassemble_info *);
1.261 +extern int print_insn_vax (bfd_vma, disassemble_info *);
1.262 +extern int print_insn_w65 (bfd_vma, disassemble_info *);
1.263 +extern int print_insn_xstormy16 (bfd_vma, disassemble_info *);
1.264 +extern int print_insn_xtensa (bfd_vma, disassemble_info *);
1.265 +extern int print_insn_sh64 (bfd_vma, disassemble_info *);
1.266 +extern int print_insn_sh64x_media (bfd_vma, disassemble_info *);
1.267 +extern int print_insn_frv (bfd_vma, disassemble_info *);
1.268 +extern int print_insn_iq2000 (bfd_vma, disassemble_info *);
1.269 +
1.270 +extern disassembler_ftype arc_get_disassembler (void *);
1.271 +extern disassembler_ftype cris_get_disassembler (bfd *);
1.272 +
1.273 +extern void print_mips_disassembler_options (FILE *);
1.274 +extern void print_ppc_disassembler_options (FILE *);
1.275 +extern void print_arm_disassembler_options (FILE *);
1.276 +extern void parse_arm_disassembler_option (char *);
1.277 +extern int get_arm_regname_num_options (void);
1.278 +extern int set_arm_regname_option (int);
1.279 +extern int get_arm_regnames (int, const char **, const char **, const char ***);
1.280 +extern bfd_boolean arm_symbol_is_valid (asymbol *, struct disassemble_info *);
1.281 +
1.282 +/* Fetch the disassembler for a given BFD, if that support is available. */
1.283 +extern disassembler_ftype disassembler (bfd *);
1.284 +
1.285 +/* Amend the disassemble_info structure as necessary for the target architecture.
1.286 + Should only be called after initialising the info->arch field. */
1.287 +extern void disassemble_init_for_target (struct disassemble_info * info);
1.288 +
1.289 +/* Document any target specific options available from the disassembler. */
1.290 +extern void disassembler_usage (FILE *);
1.291 +
1.292 +
1.293 +/* This block of definitions is for particular callers who read instructions
1.294 + into a buffer before calling the instruction decoder. */
1.295 +
1.296 +/* Here is a function which callers may wish to use for read_memory_func.
1.297 + It gets bytes from a buffer. */
1.298 +extern int buffer_read_memory
1.299 + (bfd_vma, bfd_byte *, unsigned int, struct disassemble_info *);
1.300 +
1.301 +/* This function goes with buffer_read_memory.
1.302 + It prints a message using info->fprintf_func and info->stream. */
1.303 +extern void perror_memory (int, bfd_vma, struct disassemble_info *);
1.304 +
1.305 +
1.306 +/* Just print the address in hex. This is included for completeness even
1.307 + though both GDB and objdump provide their own (to print symbolic
1.308 + addresses). */
1.309 +extern void generic_print_address
1.310 + (bfd_vma, struct disassemble_info *);
1.311 +
1.312 +/* Always true. */
1.313 +extern int generic_symbol_at_address
1.314 + (bfd_vma, struct disassemble_info *);
1.315 +
1.316 +/* Also always true. */
1.317 +extern bfd_boolean generic_symbol_is_valid
1.318 + (asymbol *, struct disassemble_info *);
1.319 +
1.320 +/* Method to initialize a disassemble_info struct. This should be
1.321 + called by all applications creating such a struct. */
1.322 +extern void init_disassemble_info (struct disassemble_info *info, void *stream,
1.323 + fprintf_ftype fprintf_func);
1.324 +
1.325 +/* For compatibility with existing code. */
1.326 +#define INIT_DISASSEMBLE_INFO(INFO, STREAM, FPRINTF_FUNC) \
1.327 + init_disassemble_info (&(INFO), (STREAM), (fprintf_ftype) (FPRINTF_FUNC))
1.328 +#define INIT_DISASSEMBLE_INFO_NO_ARCH(INFO, STREAM, FPRINTF_FUNC) \
1.329 + init_disassemble_info (&(INFO), (STREAM), (fprintf_ftype) (FPRINTF_FUNC))
1.330 +
1.331 +
1.332 +#ifdef __cplusplus
1.333 +}
1.334 +#endif
1.335 +
1.336 +#endif /* ! defined (DIS_ASM_H) */
.