1130812Smarcel/* Interface between the opcode library and its callers. 2130812Smarcel 3130812Smarcel Copyright 2001, 2002, 2003 Free Software Foundation, Inc. 4130812Smarcel 5130812Smarcel This program is free software; you can redistribute it and/or modify 6130812Smarcel it under the terms of the GNU General Public License as published by 7130812Smarcel the Free Software Foundation; either version 2, or (at your option) 8130812Smarcel any later version. 9130812Smarcel 10130812Smarcel This program is distributed in the hope that it will be useful, 11130812Smarcel but WITHOUT ANY WARRANTY; without even the implied warranty of 12130812Smarcel MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13130812Smarcel GNU General Public License for more details. 14130812Smarcel 15130812Smarcel You should have received a copy of the GNU General Public License 16130812Smarcel along with this program; if not, write to the Free Software 17130812Smarcel Foundation, Inc., 59 Temple Place - Suite 330, 18130812Smarcel Boston, MA 02111-1307, USA. 19130812Smarcel 20130812Smarcel Written by Cygnus Support, 1993. 21130812Smarcel 22130812Smarcel The opcode library (libopcodes.a) provides instruction decoders for 23130812Smarcel a large variety of instruction sets, callable with an identical 24130812Smarcel interface, for making instruction-processing programs more independent 25130812Smarcel of the instruction set being processed. */ 26130812Smarcel 27130812Smarcel#ifndef DIS_ASM_H 28130812Smarcel#define DIS_ASM_H 29130812Smarcel 30130812Smarcel#ifdef __cplusplus 31130812Smarcelextern "C" { 32130812Smarcel#endif 33130812Smarcel 34130812Smarcel#include <stdio.h> 35130812Smarcel#include "bfd.h" 36130812Smarcel 37130812Smarceltypedef int (*fprintf_ftype) (void *, const char*, ...); 38130812Smarcel 39130812Smarcelenum dis_insn_type { 40130812Smarcel dis_noninsn, /* Not a valid instruction */ 41130812Smarcel dis_nonbranch, /* Not a branch instruction */ 42130812Smarcel dis_branch, /* Unconditional branch */ 43130812Smarcel dis_condbranch, /* Conditional branch */ 44130812Smarcel dis_jsr, /* Jump to subroutine */ 45130812Smarcel dis_condjsr, /* Conditional jump to subroutine */ 46130812Smarcel dis_dref, /* Data reference instruction */ 47130812Smarcel dis_dref2 /* Two data references in instruction */ 48130812Smarcel}; 49130812Smarcel 50130812Smarcel/* This struct is passed into the instruction decoding routine, 51130812Smarcel and is passed back out into each callback. The various fields are used 52130812Smarcel for conveying information from your main routine into your callbacks, 53130812Smarcel for passing information into the instruction decoders (such as the 54130812Smarcel addresses of the callback functions), or for passing information 55130812Smarcel back from the instruction decoders to their callers. 56130812Smarcel 57130812Smarcel It must be initialized before it is first passed; this can be done 58130812Smarcel by hand, or using one of the initialization macros below. */ 59130812Smarcel 60130812Smarceltypedef struct disassemble_info { 61130812Smarcel fprintf_ftype fprintf_func; 62130812Smarcel void *stream; 63130812Smarcel void *application_data; 64130812Smarcel 65130812Smarcel /* Target description. We could replace this with a pointer to the bfd, 66130812Smarcel but that would require one. There currently isn't any such requirement 67130812Smarcel so to avoid introducing one we record these explicitly. */ 68130812Smarcel /* The bfd_flavour. This can be bfd_target_unknown_flavour. */ 69130812Smarcel enum bfd_flavour flavour; 70130812Smarcel /* The bfd_arch value. */ 71130812Smarcel enum bfd_architecture arch; 72130812Smarcel /* The bfd_mach value. */ 73130812Smarcel unsigned long mach; 74130812Smarcel /* Endianness (for bi-endian cpus). Mono-endian cpus can ignore this. */ 75130812Smarcel enum bfd_endian endian; 76130812Smarcel /* An arch/mach-specific bitmask of selected instruction subsets, mainly 77130812Smarcel for processors with run-time-switchable instruction sets. The default, 78130812Smarcel zero, means that there is no constraint. CGEN-based opcodes ports 79130812Smarcel may use ISA_foo masks. */ 80130812Smarcel unsigned long insn_sets; 81130812Smarcel 82130812Smarcel /* Some targets need information about the current section to accurately 83130812Smarcel display insns. If this is NULL, the target disassembler function 84130812Smarcel will have to make its best guess. */ 85130812Smarcel asection *section; 86130812Smarcel 87130812Smarcel /* An array of pointers to symbols either at the location being disassembled 88130812Smarcel or at the start of the function being disassembled. The array is sorted 89130812Smarcel so that the first symbol is intended to be the one used. The others are 90130812Smarcel present for any misc. purposes. This is not set reliably, but if it is 91130812Smarcel not NULL, it is correct. */ 92130812Smarcel asymbol **symbols; 93130812Smarcel /* Number of symbols in array. */ 94130812Smarcel int num_symbols; 95130812Smarcel 96130812Smarcel /* For use by the disassembler. 97130812Smarcel The top 16 bits are reserved for public use (and are documented here). 98130812Smarcel The bottom 16 bits are for the internal use of the disassembler. */ 99130812Smarcel unsigned long flags; 100130812Smarcel#define INSN_HAS_RELOC 0x80000000 101130812Smarcel void *private_data; 102130812Smarcel 103130812Smarcel /* Function used to get bytes to disassemble. MEMADDR is the 104130812Smarcel address of the stuff to be disassembled, MYADDR is the address to 105130812Smarcel put the bytes in, and LENGTH is the number of bytes to read. 106130812Smarcel INFO is a pointer to this struct. 107130812Smarcel Returns an errno value or 0 for success. */ 108130812Smarcel int (*read_memory_func) 109130812Smarcel (bfd_vma memaddr, bfd_byte *myaddr, unsigned int length, 110130812Smarcel struct disassemble_info *info); 111130812Smarcel 112130812Smarcel /* Function which should be called if we get an error that we can't 113130812Smarcel recover from. STATUS is the errno value from read_memory_func and 114130812Smarcel MEMADDR is the address that we were trying to read. INFO is a 115130812Smarcel pointer to this struct. */ 116130812Smarcel void (*memory_error_func) 117130812Smarcel (int status, bfd_vma memaddr, struct disassemble_info *info); 118130812Smarcel 119130812Smarcel /* Function called to print ADDR. */ 120130812Smarcel void (*print_address_func) 121130812Smarcel (bfd_vma addr, struct disassemble_info *info); 122130812Smarcel 123130812Smarcel /* Function called to determine if there is a symbol at the given ADDR. 124130812Smarcel If there is, the function returns 1, otherwise it returns 0. 125130812Smarcel This is used by ports which support an overlay manager where 126130812Smarcel the overlay number is held in the top part of an address. In 127130812Smarcel some circumstances we want to include the overlay number in the 128130812Smarcel address, (normally because there is a symbol associated with 129130812Smarcel that address), but sometimes we want to mask out the overlay bits. */ 130130812Smarcel int (* symbol_at_address_func) 131130812Smarcel (bfd_vma addr, struct disassemble_info * info); 132130812Smarcel 133130812Smarcel /* Function called to check if a SYMBOL is can be displayed to the user. 134130812Smarcel This is used by some ports that want to hide special symbols when 135130812Smarcel displaying debugging outout. */ 136130812Smarcel bfd_boolean (* symbol_is_valid) 137130812Smarcel (asymbol *, struct disassemble_info * info); 138130812Smarcel 139130812Smarcel /* These are for buffer_read_memory. */ 140130812Smarcel bfd_byte *buffer; 141130812Smarcel bfd_vma buffer_vma; 142130812Smarcel unsigned int buffer_length; 143130812Smarcel 144130812Smarcel /* This variable may be set by the instruction decoder. It suggests 145130812Smarcel the number of bytes objdump should display on a single line. If 146130812Smarcel the instruction decoder sets this, it should always set it to 147130812Smarcel the same value in order to get reasonable looking output. */ 148130812Smarcel int bytes_per_line; 149130812Smarcel 150130812Smarcel /* The next two variables control the way objdump displays the raw data. */ 151130812Smarcel /* For example, if bytes_per_line is 8 and bytes_per_chunk is 4, the */ 152130812Smarcel /* output will look like this: 153130812Smarcel 00: 00000000 00000000 154130812Smarcel with the chunks displayed according to "display_endian". */ 155130812Smarcel int bytes_per_chunk; 156130812Smarcel enum bfd_endian display_endian; 157130812Smarcel 158130812Smarcel /* Number of octets per incremented target address 159130812Smarcel Normally one, but some DSPs have byte sizes of 16 or 32 bits. */ 160130812Smarcel unsigned int octets_per_byte; 161130812Smarcel 162130812Smarcel /* Results from instruction decoders. Not all decoders yet support 163130812Smarcel this information. This info is set each time an instruction is 164130812Smarcel decoded, and is only valid for the last such instruction. 165130812Smarcel 166130812Smarcel To determine whether this decoder supports this information, set 167130812Smarcel insn_info_valid to 0, decode an instruction, then check it. */ 168130812Smarcel 169130812Smarcel char insn_info_valid; /* Branch info has been set. */ 170130812Smarcel char branch_delay_insns; /* How many sequential insn's will run before 171130812Smarcel a branch takes effect. (0 = normal) */ 172130812Smarcel char data_size; /* Size of data reference in insn, in bytes */ 173130812Smarcel enum dis_insn_type insn_type; /* Type of instruction */ 174130812Smarcel bfd_vma target; /* Target address of branch or dref, if known; 175130812Smarcel zero if unknown. */ 176130812Smarcel bfd_vma target2; /* Second target address for dref2 */ 177130812Smarcel 178130812Smarcel /* Command line options specific to the target disassembler. */ 179130812Smarcel char * disassembler_options; 180130812Smarcel 181130812Smarcel} disassemble_info; 182130812Smarcel 183130812Smarcel 184130812Smarcel/* Standard disassemblers. Disassemble one instruction at the given 185130812Smarcel target address. Return number of octets processed. */ 186130812Smarceltypedef int (*disassembler_ftype) (bfd_vma, disassemble_info *); 187130812Smarcel 188130812Smarcelextern int print_insn_big_mips (bfd_vma, disassemble_info *); 189130812Smarcelextern int print_insn_little_mips (bfd_vma, disassemble_info *); 190130812Smarcelextern int print_insn_i386 (bfd_vma, disassemble_info *); 191130812Smarcelextern int print_insn_i386_att (bfd_vma, disassemble_info *); 192130812Smarcelextern int print_insn_i386_intel (bfd_vma, disassemble_info *); 193130812Smarcelextern int print_insn_ia64 (bfd_vma, disassemble_info *); 194130812Smarcelextern int print_insn_i370 (bfd_vma, disassemble_info *); 195130812Smarcelextern int print_insn_m68hc11 (bfd_vma, disassemble_info *); 196130812Smarcelextern int print_insn_m68hc12 (bfd_vma, disassemble_info *); 197130812Smarcelextern int print_insn_m68k (bfd_vma, disassemble_info *); 198130812Smarcelextern int print_insn_z8001 (bfd_vma, disassemble_info *); 199130812Smarcelextern int print_insn_z8002 (bfd_vma, disassemble_info *); 200130812Smarcelextern int print_insn_h8300 (bfd_vma, disassemble_info *); 201130812Smarcelextern int print_insn_h8300h (bfd_vma, disassemble_info *); 202130812Smarcelextern int print_insn_h8300s (bfd_vma, disassemble_info *); 203130812Smarcelextern int print_insn_h8500 (bfd_vma, disassemble_info *); 204130812Smarcelextern int print_insn_alpha (bfd_vma, disassemble_info *); 205130812Smarcelextern int print_insn_big_arm (bfd_vma, disassemble_info *); 206130812Smarcelextern int print_insn_little_arm (bfd_vma, disassemble_info *); 207130812Smarcelextern int print_insn_sparc (bfd_vma, disassemble_info *); 208130812Smarcelextern int print_insn_big_a29k (bfd_vma, disassemble_info *); 209130812Smarcelextern int print_insn_little_a29k (bfd_vma, disassemble_info *); 210130812Smarcelextern int print_insn_avr (bfd_vma, disassemble_info *); 211130812Smarcelextern int print_insn_d10v (bfd_vma, disassemble_info *); 212130812Smarcelextern int print_insn_d30v (bfd_vma, disassemble_info *); 213130812Smarcelextern int print_insn_dlx (bfd_vma, disassemble_info *); 214130812Smarcelextern int print_insn_fr30 (bfd_vma, disassemble_info *); 215130812Smarcelextern int print_insn_hppa (bfd_vma, disassemble_info *); 216130812Smarcelextern int print_insn_i860 (bfd_vma, disassemble_info *); 217130812Smarcelextern int print_insn_i960 (bfd_vma, disassemble_info *); 218130812Smarcelextern int print_insn_ip2k (bfd_vma, disassemble_info *); 219130812Smarcelextern int print_insn_m32r (bfd_vma, disassemble_info *); 220130812Smarcelextern int print_insn_m88k (bfd_vma, disassemble_info *); 221130812Smarcelextern int print_insn_mcore (bfd_vma, disassemble_info *); 222130812Smarcelextern int print_insn_mmix (bfd_vma, disassemble_info *); 223130812Smarcelextern int print_insn_mn10200 (bfd_vma, disassemble_info *); 224130812Smarcelextern int print_insn_mn10300 (bfd_vma, disassemble_info *); 225130812Smarcelextern int print_insn_msp430 (bfd_vma, disassemble_info *); 226130812Smarcelextern int print_insn_ns32k (bfd_vma, disassemble_info *); 227130812Smarcelextern int print_insn_openrisc (bfd_vma, disassemble_info *); 228130812Smarcelextern int print_insn_big_or32 (bfd_vma, disassemble_info *); 229130812Smarcelextern int print_insn_little_or32 (bfd_vma, disassemble_info *); 230130812Smarcelextern int print_insn_pdp11 (bfd_vma, disassemble_info *); 231130812Smarcelextern int print_insn_pj (bfd_vma, disassemble_info *); 232130812Smarcelextern int print_insn_big_powerpc (bfd_vma, disassemble_info *); 233130812Smarcelextern int print_insn_little_powerpc (bfd_vma, disassemble_info *); 234130812Smarcelextern int print_insn_rs6000 (bfd_vma, disassemble_info *); 235130812Smarcelextern int print_insn_s390 (bfd_vma, disassemble_info *); 236130812Smarcelextern int print_insn_sh (bfd_vma, disassemble_info *); 237130812Smarcelextern int print_insn_tic30 (bfd_vma, disassemble_info *); 238130812Smarcelextern int print_insn_tic4x (bfd_vma, disassemble_info *); 239130812Smarcelextern int print_insn_tic54x (bfd_vma, disassemble_info *); 240130812Smarcelextern int print_insn_tic80 (bfd_vma, disassemble_info *); 241130812Smarcelextern int print_insn_v850 (bfd_vma, disassemble_info *); 242130812Smarcelextern int print_insn_vax (bfd_vma, disassemble_info *); 243130812Smarcelextern int print_insn_w65 (bfd_vma, disassemble_info *); 244130812Smarcelextern int print_insn_xstormy16 (bfd_vma, disassemble_info *); 245130812Smarcelextern int print_insn_xtensa (bfd_vma, disassemble_info *); 246130812Smarcelextern int print_insn_sh64 (bfd_vma, disassemble_info *); 247130812Smarcelextern int print_insn_sh64x_media (bfd_vma, disassemble_info *); 248130812Smarcelextern int print_insn_frv (bfd_vma, disassemble_info *); 249130812Smarcelextern int print_insn_iq2000 (bfd_vma, disassemble_info *); 250130812Smarcel 251130812Smarcelextern disassembler_ftype arc_get_disassembler (void *); 252130812Smarcelextern disassembler_ftype cris_get_disassembler (bfd *); 253130812Smarcel 254130812Smarcelextern void print_mips_disassembler_options (FILE *); 255130812Smarcelextern void print_ppc_disassembler_options (FILE *); 256130812Smarcelextern void print_arm_disassembler_options (FILE *); 257130812Smarcelextern void parse_arm_disassembler_option (char *); 258130812Smarcelextern int get_arm_regname_num_options (void); 259130812Smarcelextern int set_arm_regname_option (int); 260130812Smarcelextern int get_arm_regnames (int, const char **, const char **, const char ***); 261130812Smarcelextern bfd_boolean arm_symbol_is_valid (asymbol *, struct disassemble_info *); 262130812Smarcel 263130812Smarcel/* Fetch the disassembler for a given BFD, if that support is available. */ 264130812Smarcelextern disassembler_ftype disassembler (bfd *); 265130812Smarcel 266130812Smarcel/* Amend the disassemble_info structure as necessary for the target architecture. 267130812Smarcel Should only be called after initialising the info->arch field. */ 268130812Smarcelextern void disassemble_init_for_target (struct disassemble_info * info); 269130812Smarcel 270130812Smarcel/* Document any target specific options available from the disassembler. */ 271130812Smarcelextern void disassembler_usage (FILE *); 272130812Smarcel 273130812Smarcel 274130812Smarcel/* This block of definitions is for particular callers who read instructions 275130812Smarcel into a buffer before calling the instruction decoder. */ 276130812Smarcel 277130812Smarcel/* Here is a function which callers may wish to use for read_memory_func. 278130812Smarcel It gets bytes from a buffer. */ 279130812Smarcelextern int buffer_read_memory 280130812Smarcel (bfd_vma, bfd_byte *, unsigned int, struct disassemble_info *); 281130812Smarcel 282130812Smarcel/* This function goes with buffer_read_memory. 283130812Smarcel It prints a message using info->fprintf_func and info->stream. */ 284130812Smarcelextern void perror_memory (int, bfd_vma, struct disassemble_info *); 285130812Smarcel 286130812Smarcel 287130812Smarcel/* Just print the address in hex. This is included for completeness even 288130812Smarcel though both GDB and objdump provide their own (to print symbolic 289130812Smarcel addresses). */ 290130812Smarcelextern void generic_print_address 291130812Smarcel (bfd_vma, struct disassemble_info *); 292130812Smarcel 293130812Smarcel/* Always true. */ 294130812Smarcelextern int generic_symbol_at_address 295130812Smarcel (bfd_vma, struct disassemble_info *); 296130812Smarcel 297130812Smarcel/* Also always true. */ 298130812Smarcelextern bfd_boolean generic_symbol_is_valid 299130812Smarcel (asymbol *, struct disassemble_info *); 300130812Smarcel 301130812Smarcel/* Method to initialize a disassemble_info struct. This should be 302130812Smarcel called by all applications creating such a struct. */ 303130812Smarcelextern void init_disassemble_info (struct disassemble_info *info, void *stream, 304130812Smarcel fprintf_ftype fprintf_func); 305130812Smarcel 306130812Smarcel/* For compatibility with existing code. */ 307130812Smarcel#define INIT_DISASSEMBLE_INFO(INFO, STREAM, FPRINTF_FUNC) \ 308130812Smarcel init_disassemble_info (&(INFO), (STREAM), (fprintf_ftype) (FPRINTF_FUNC)) 309130812Smarcel#define INIT_DISASSEMBLE_INFO_NO_ARCH(INFO, STREAM, FPRINTF_FUNC) \ 310130812Smarcel init_disassemble_info (&(INFO), (STREAM), (fprintf_ftype) (FPRINTF_FUNC)) 311130812Smarcel 312130812Smarcel 313130812Smarcel#ifdef __cplusplus 314130812Smarcel} 315130812Smarcel#endif 316130812Smarcel 317130812Smarcel#endif /* ! defined (DIS_ASM_H) */ 318