[thirdparty/binutils-gdb.git] / include / dis-asm.h

/* Interface between the opcode library and its callers.

   Copyright (C) 1999-2015 Free Software Foundation, Inc.

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 3, or (at your option)
   any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 51 Franklin Street - Fifth Floor,
   Boston, MA 02110-1301, USA.

   Written by Cygnus Support, 1993.

   The opcode library (libopcodes.a) provides instruction decoders for
   a large variety of instruction sets, callable with an identical
   interface, for making instruction-processing programs more independent
   of the instruction set being processed.  */

#ifndef DIS_ASM_H
#define DIS_ASM_H

#ifdef __cplusplus
extern "C" {
#endif

#include <stdio.h>
#include "bfd.h"

  typedef int (*fprintf_ftype) (void *, const char*, ...) ATTRIBUTE_FPTR_PRINTF_2;

enum dis_insn_type
{
  dis_noninsn,			/* Not a valid instruction.  */
  dis_nonbranch,		/* Not a branch instruction.  */
  dis_branch,			/* Unconditional branch.  */
  dis_condbranch,		/* Conditional branch.  */
  dis_jsr,			/* Jump to subroutine.  */
  dis_condjsr,			/* Conditional jump to subroutine.  */
  dis_dref,			/* Data reference instruction.  */
  dis_dref2			/* Two data references in instruction.  */
};

/* This struct is passed into the instruction decoding routine,
   and is passed back out into each callback.  The various fields are used
   for conveying information from your main routine into your callbacks,
   for passing information into the instruction decoders (such as the
   addresses of the callback functions), or for passing information
   back from the instruction decoders to their callers.

   It must be initialized before it is first passed; this can be done
   by hand, or using one of the initialization macros below.  */

typedef struct disassemble_info
{
  fprintf_ftype fprintf_func;
  void *stream;
  void *application_data;

  /* Target description.  We could replace this with a pointer to the bfd,
     but that would require one.  There currently isn't any such requirement
     so to avoid introducing one we record these explicitly.  */
  /* The bfd_flavour.  This can be bfd_target_unknown_flavour.  */
  enum bfd_flavour flavour;
  /* The bfd_arch value.  */
  enum bfd_architecture arch;
  /* The bfd_mach value.  */
  unsigned long mach;
  /* Endianness (for bi-endian cpus).  Mono-endian cpus can ignore this.  */
  enum bfd_endian endian;
  /* Endianness of code, for mixed-endian situations such as ARM BE8.  */
  enum bfd_endian endian_code;
  /* An arch/mach-specific bitmask of selected instruction subsets, mainly
     for processors with run-time-switchable instruction sets.  The default,
     zero, means that there is no constraint.  CGEN-based opcodes ports
     may use ISA_foo masks.  */
  void *insn_sets;

  /* Some targets need information about the current section to accurately
     display insns.  If this is NULL, the target disassembler function
     will have to make its best guess.  */
  asection *section;

  /* An array of pointers to symbols either at the location being disassembled
     or at the start of the function being disassembled.  The array is sorted
     so that the first symbol is intended to be the one used.  The others are
     present for any misc. purposes.  This is not set reliably, but if it is
     not NULL, it is correct.  */
  asymbol **symbols;
  /* Number of symbols in array.  */
  int num_symbols;

  /* Symbol table provided for targets that want to look at it.  This is
     used on Arm to find mapping symbols and determine Arm/Thumb code.  */
  asymbol **symtab;
  int symtab_pos;
  int symtab_size;

  /* For use by the disassembler.
     The top 16 bits are reserved for public use (and are documented here).
     The bottom 16 bits are for the internal use of the disassembler.  */
  unsigned long flags;
  /* Set if the disassembler has determined that there are one or more
     relocations associated with the instruction being disassembled.  */
#define INSN_HAS_RELOC	 (1 << 31)
  /* Set if the user has requested the disassembly of data as well as code.  */
#define DISASSEMBLE_DATA (1 << 30)
  /* Set if the user has specifically set the machine type encoded in the
     mach field of this structure.  */
#define USER_SPECIFIED_MACHINE_TYPE (1 << 29)

  /* Use internally by the target specific disassembly code.  */
  void *private_data;

  /* Function used to get bytes to disassemble.  MEMADDR is the
     address of the stuff to be disassembled, MYADDR is the address to
     put the bytes in, and LENGTH is the number of bytes to read.
     INFO is a pointer to this struct.
     Returns an errno value or 0 for success.  */
  int (*read_memory_func)
    (bfd_vma memaddr, bfd_byte *myaddr, unsigned int length,
     struct disassemble_info *dinfo);

  /* Function which should be called if we get an error that we can't
     recover from.  STATUS is the errno value from read_memory_func and
     MEMADDR is the address that we were trying to read.  INFO is a
     pointer to this struct.  */
  void (*memory_error_func)
    (int status, bfd_vma memaddr, struct disassemble_info *dinfo);

  /* Function called to print ADDR.  */
  void (*print_address_func)
    (bfd_vma addr, struct disassemble_info *dinfo);

  /* Function called to determine if there is a symbol at the given ADDR.
     If there is, the function returns 1, otherwise it returns 0.
     This is used by ports which support an overlay manager where
     the overlay number is held in the top part of an address.  In
     some circumstances we want to include the overlay number in the
     address, (normally because there is a symbol associated with
     that address), but sometimes we want to mask out the overlay bits.  */
  int (* symbol_at_address_func)
    (bfd_vma addr, struct disassemble_info *dinfo);

  /* Function called to check if a SYMBOL is can be displayed to the user.
     This is used by some ports that want to hide special symbols when
     displaying debugging outout.  */
  bfd_boolean (* symbol_is_valid)
    (asymbol *, struct disassemble_info *dinfo);

  /* These are for buffer_read_memory.  */
  bfd_byte *buffer;
  bfd_vma buffer_vma;
  unsigned int buffer_length;

  /* This variable may be set by the instruction decoder.  It suggests
      the number of bytes objdump should display on a single line.  If
      the instruction decoder sets this, it should always set it to
      the same value in order to get reasonable looking output.  */
  int bytes_per_line;

  /* The next two variables control the way objdump displays the raw data.  */
  /* For example, if bytes_per_line is 8 and bytes_per_chunk is 4, the */
  /* output will look like this:
     00:   00000000 00000000
     with the chunks displayed according to "display_endian". */
  int bytes_per_chunk;
  enum bfd_endian display_endian;

  /* Number of octets per incremented target address
     Normally one, but some DSPs have byte sizes of 16 or 32 bits.  */
  unsigned int octets_per_byte;

  /* The number of zeroes we want to see at the end of a section before we
     start skipping them.  */
  unsigned int skip_zeroes;

  /* The number of zeroes to skip at the end of a section.  If the number
     of zeroes at the end is between SKIP_ZEROES_AT_END and SKIP_ZEROES,
     they will be disassembled.  If there are fewer than
     SKIP_ZEROES_AT_END, they will be skipped.  This is a heuristic
     attempt to avoid disassembling zeroes inserted by section
     alignment.  */
  unsigned int skip_zeroes_at_end;

  /* Whether the disassembler always needs the relocations.  */
  bfd_boolean disassembler_needs_relocs;

  /* Results from instruction decoders.  Not all decoders yet support
     this information.  This info is set each time an instruction is
     decoded, and is only valid for the last such instruction.

     To determine whether this decoder supports this information, set
     insn_info_valid to 0, decode an instruction, then check it.  */

  char insn_info_valid;		/* Branch info has been set. */
  char branch_delay_insns;	/* How many sequential insn's will run before
				   a branch takes effect.  (0 = normal) */
  char data_size;		/* Size of data reference in insn, in bytes */
  enum dis_insn_type insn_type;	/* Type of instruction */
  bfd_vma target;		/* Target address of branch or dref, if known;
				   zero if unknown.  */
  bfd_vma target2;		/* Second target address for dref2 */

  /* Command line options specific to the target disassembler.  */
  char * disassembler_options;

} disassemble_info;

\f
/* Standard disassemblers.  Disassemble one instruction at the given
   target address.  Return number of octets processed.  */
typedef int (*disassembler_ftype) (bfd_vma, disassemble_info *);

extern int print_insn_aarch64		(bfd_vma, disassemble_info *);
extern int print_insn_alpha		(bfd_vma, disassemble_info *);
extern int print_insn_avr		(bfd_vma, disassemble_info *);
extern int print_insn_bfin		(bfd_vma, disassemble_info *);
extern int print_insn_big_arm		(bfd_vma, disassemble_info *);
extern int print_insn_big_mips		(bfd_vma, disassemble_info *);
extern int print_insn_big_nios2		(bfd_vma, disassemble_info *);
extern int print_insn_big_powerpc	(bfd_vma, disassemble_info *);
extern int print_insn_big_score         (bfd_vma, disassemble_info *);
extern int print_insn_cr16              (bfd_vma, disassemble_info *);
extern int print_insn_crx               (bfd_vma, disassemble_info *);
extern int print_insn_d10v		(bfd_vma, disassemble_info *);
extern int print_insn_d30v		(bfd_vma, disassemble_info *);
extern int print_insn_dlx 		(bfd_vma, disassemble_info *);
extern int print_insn_epiphany		(bfd_vma, disassemble_info *);
extern int print_insn_fr30		(bfd_vma, disassemble_info *);
extern int print_insn_frv		(bfd_vma, disassemble_info *);
extern int print_insn_ft32  		(bfd_vma, disassemble_info *);
extern int print_insn_h8300		(bfd_vma, disassemble_info *);
extern int print_insn_h8300h		(bfd_vma, disassemble_info *);
extern int print_insn_h8300s		(bfd_vma, disassemble_info *);
extern int print_insn_h8500		(bfd_vma, disassemble_info *);
extern int print_insn_hppa		(bfd_vma, disassemble_info *);
extern int print_insn_i370		(bfd_vma, disassemble_info *);
extern int print_insn_i386		(bfd_vma, disassemble_info *);
extern int print_insn_i386_att		(bfd_vma, disassemble_info *);
extern int print_insn_i386_intel	(bfd_vma, disassemble_info *);
extern int print_insn_i860		(bfd_vma, disassemble_info *);
extern int print_insn_i960		(bfd_vma, disassemble_info *);
extern int print_insn_ia64		(bfd_vma, disassemble_info *);
extern int print_insn_ip2k		(bfd_vma, disassemble_info *);
extern int print_insn_iq2000		(bfd_vma, disassemble_info *);
extern int print_insn_little_arm	(bfd_vma, disassemble_info *);
extern int print_insn_little_mips	(bfd_vma, disassemble_info *);
extern int print_insn_little_nios2	(bfd_vma, disassemble_info *);
extern int print_insn_little_powerpc	(bfd_vma, disassemble_info *);
extern int print_insn_little_score      (bfd_vma, disassemble_info *); 
extern int print_insn_lm32		(bfd_vma, disassemble_info *);
extern int print_insn_m32c	        (bfd_vma, disassemble_info *);
extern int print_insn_m32r		(bfd_vma, disassemble_info *);
extern int print_insn_m68hc11		(bfd_vma, disassemble_info *);
extern int print_insn_m68hc12		(bfd_vma, disassemble_info *);
extern int print_insn_m9s12x		(bfd_vma, disassemble_info *);
extern int print_insn_m9s12xg		(bfd_vma, disassemble_info *);
extern int print_insn_m68k		(bfd_vma, disassemble_info *);
extern int print_insn_m88k		(bfd_vma, disassemble_info *);
extern int print_insn_mcore		(bfd_vma, disassemble_info *);
extern int print_insn_mep		(bfd_vma, disassemble_info *);
extern int print_insn_metag		(bfd_vma, disassemble_info *);
extern int print_insn_microblaze	(bfd_vma, disassemble_info *);
extern int print_insn_mmix		(bfd_vma, disassemble_info *);
extern int print_insn_mn10200		(bfd_vma, disassemble_info *);
extern int print_insn_mn10300		(bfd_vma, disassemble_info *);
extern int print_insn_moxie		(bfd_vma, disassemble_info *);
extern int print_insn_msp430		(bfd_vma, disassemble_info *);
extern int print_insn_mt                (bfd_vma, disassemble_info *);
extern int print_insn_nds32		(bfd_vma, disassemble_info *);
extern int print_insn_ns32k		(bfd_vma, disassemble_info *);
extern int print_insn_or1k		(bfd_vma, disassemble_info *);
extern int print_insn_pdp11		(bfd_vma, disassemble_info *);
extern int print_insn_pj		(bfd_vma, disassemble_info *);
extern int print_insn_rs6000		(bfd_vma, disassemble_info *);
extern int print_insn_s390		(bfd_vma, disassemble_info *);
extern int print_insn_sh		(bfd_vma, disassemble_info *);
extern int print_insn_sh64		(bfd_vma, disassemble_info *);
extern int print_insn_sh64x_media	(bfd_vma, disassemble_info *);
extern int print_insn_sparc		(bfd_vma, disassemble_info *);
extern int print_insn_spu		(bfd_vma, disassemble_info *);
extern int print_insn_tic30		(bfd_vma, disassemble_info *);
extern int print_insn_tic4x		(bfd_vma, disassemble_info *);
extern int print_insn_tic54x		(bfd_vma, disassemble_info *);
extern int print_insn_tic6x		(bfd_vma, disassemble_info *);
extern int print_insn_tic80		(bfd_vma, disassemble_info *);
extern int print_insn_tilegx		(bfd_vma, disassemble_info *);
extern int print_insn_tilepro		(bfd_vma, disassemble_info *);
extern int print_insn_v850		(bfd_vma, disassemble_info *);
extern int print_insn_vax		(bfd_vma, disassemble_info *);
extern int print_insn_visium		(bfd_vma, disassemble_info *);
extern int print_insn_w65		(bfd_vma, disassemble_info *);
extern int print_insn_xc16x		(bfd_vma, disassemble_info *);
extern int print_insn_xgate             (bfd_vma, disassemble_info *);
extern int print_insn_xstormy16		(bfd_vma, disassemble_info *);
extern int print_insn_xtensa		(bfd_vma, disassemble_info *);
extern int print_insn_z80		(bfd_vma, disassemble_info *);
extern int print_insn_z8001		(bfd_vma, disassemble_info *);
extern int print_insn_z8002		(bfd_vma, disassemble_info *);
extern int print_insn_rx		(bfd_vma, disassemble_info *);
extern int print_insn_rl78		(bfd_vma, disassemble_info *);
extern int print_insn_rl78_g10		(bfd_vma, disassemble_info *);
extern int print_insn_rl78_g13		(bfd_vma, disassemble_info *);
extern int print_insn_rl78_g14		(bfd_vma, disassemble_info *);

extern disassembler_ftype arc_get_disassembler (void *);
extern disassembler_ftype cris_get_disassembler (bfd *);
extern disassembler_ftype rl78_get_disassembler (bfd *);

extern void print_aarch64_disassembler_options (FILE *);
extern void print_i386_disassembler_options (FILE *);
extern void print_mips_disassembler_options (FILE *);
extern void print_ppc_disassembler_options (FILE *);
extern void print_arm_disassembler_options (FILE *);
extern void parse_arm_disassembler_option (char *);
extern void print_s390_disassembler_options (FILE *);
extern int  get_arm_regname_num_options (void);
extern int  set_arm_regname_option (int);
extern int  get_arm_regnames (int, const char **, const char **, const char *const **);
extern bfd_boolean aarch64_symbol_is_valid (asymbol *, struct disassemble_info *);
extern bfd_boolean arm_symbol_is_valid (asymbol *, struct disassemble_info *);
extern void disassemble_init_powerpc (struct disassemble_info *);

/* Fetch the disassembler for a given BFD, if that support is available.  */
extern disassembler_ftype disassembler (bfd *);

/* Amend the disassemble_info structure as necessary for the target architecture.
   Should only be called after initialising the info->arch field.  */
extern void disassemble_init_for_target (struct disassemble_info * dinfo);

/* Document any target specific options available from the disassembler.  */
extern void disassembler_usage (FILE *);

\f
/* This block of definitions is for particular callers who read instructions
   into a buffer before calling the instruction decoder.  */

/* Here is a function which callers may wish to use for read_memory_func.
   It gets bytes from a buffer.  */
extern int buffer_read_memory
  (bfd_vma, bfd_byte *, unsigned int, struct disassemble_info *);

/* This function goes with buffer_read_memory.
   It prints a message using info->fprintf_func and info->stream.  */
extern void perror_memory (int, bfd_vma, struct disassemble_info *);


/* Just print the address in hex.  This is included for completeness even
   though both GDB and objdump provide their own (to print symbolic
   addresses).  */
extern void generic_print_address
  (bfd_vma, struct disassemble_info *);

/* Always true.  */
extern int generic_symbol_at_address
  (bfd_vma, struct disassemble_info *);

/* Also always true.  */
extern bfd_boolean generic_symbol_is_valid
  (asymbol *, struct disassemble_info *);

/* Method to initialize a disassemble_info struct.  This should be
   called by all applications creating such a struct.  */
extern void init_disassemble_info (struct disassemble_info *dinfo, void *stream,
				   fprintf_ftype fprintf_func);

/* For compatibility with existing code.  */
#define INIT_DISASSEMBLE_INFO(INFO, STREAM, FPRINTF_FUNC) \
  init_disassemble_info (&(INFO), (STREAM), (fprintf_ftype) (FPRINTF_FUNC))
#define INIT_DISASSEMBLE_INFO_NO_ARCH(INFO, STREAM, FPRINTF_FUNC) \
  init_disassemble_info (&(INFO), (STREAM), (fprintf_ftype) (FPRINTF_FUNC))


#ifdef __cplusplus
}
#endif

#endif /* ! defined (DIS_ASM_H) */
Commit	Line	Data
252b5132	1	/* Interface between the opcode library and its callers.
4f1d9bd8	2
b90efa5b	3	Copyright (C) 1999-2015 Free Software Foundation, Inc.
d70c5fc7	4
4f1d9bd8 NC	5	This program is free software; you can redistribute it and/or modify
4f1d9bd8 NC	6	it under the terms of the GNU General Public License as published by
e4e42b45	7	the Free Software Foundation; either version 3, or (at your option)
4f1d9bd8 NC	8	any later version.
	9
	10	This program is distributed in the hope that it will be useful,
	11	but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	13	GNU General Public License for more details.
	14
	15	You should have received a copy of the GNU General Public License
	16	along with this program; if not, write to the Free Software
e172dbf8 NC	17	Foundation, Inc., 51 Franklin Street - Fifth Floor,
e172dbf8 NC	18	Boston, MA 02110-1301, USA.
d70c5fc7	19
252b5132 RH	20	Written by Cygnus Support, 1993.
	21
	22	The opcode library (libopcodes.a) provides instruction decoders for
	23	a large variety of instruction sets, callable with an identical
	24	interface, for making instruction-processing programs more independent
	25	of the instruction set being processed. */
	26
	27	#ifndef DIS_ASM_H
	28	#define DIS_ASM_H
	29
7d7a6736 ILT	30	#ifdef __cplusplus
	31	extern "C" {
	32	#endif
	33
252b5132 RH	34	#include <stdio.h>
	35	#include "bfd.h"
	36
d908c8af	37	typedef int (fprintf_ftype) (void , const char*, ...) ATTRIBUTE_FPTR_PRINTF_2;
252b5132	38
1c0d3aa6 NC	39	enum dis_insn_type
1c0d3aa6 NC	40	{
1316c8b3 NC	41	dis_noninsn, /* Not a valid instruction. */
	42	dis_nonbranch, /* Not a branch instruction. */
	43	dis_branch, /* Unconditional branch. */
	44	dis_condbranch, /* Conditional branch. */
	45	dis_jsr, /* Jump to subroutine. */
	46	dis_condjsr, /* Conditional jump to subroutine. */
	47	dis_dref, /* Data reference instruction. */
	48	dis_dref2 /* Two data references in instruction. */
252b5132 RH	49	};
252b5132 RH	50
d70c5fc7	51	/* This struct is passed into the instruction decoding routine,
252b5132 RH	52	and is passed back out into each callback. The various fields are used
	53	for conveying information from your main routine into your callbacks,
	54	for passing information into the instruction decoders (such as the
	55	addresses of the callback functions), or for passing information
	56	back from the instruction decoders to their callers.
	57
	58	It must be initialized before it is first passed; this can be done
	59	by hand, or using one of the initialization macros below. */
	60
1c0d3aa6 NC	61	typedef struct disassemble_info
1c0d3aa6 NC	62	{
252b5132	63	fprintf_ftype fprintf_func;
8cf3f354 AM	64	void *stream;
8cf3f354 AM	65	void *application_data;
252b5132 RH	66
	67	/* Target description. We could replace this with a pointer to the bfd,
	68	but that would require one. There currently isn't any such requirement
	69	so to avoid introducing one we record these explicitly. */
	70	/* The bfd_flavour. This can be bfd_target_unknown_flavour. */
	71	enum bfd_flavour flavour;
	72	/* The bfd_arch value. */
	73	enum bfd_architecture arch;
	74	/* The bfd_mach value. */
	75	unsigned long mach;
	76	/* Endianness (for bi-endian cpus). Mono-endian cpus can ignore this. */
	77	enum bfd_endian endian;
6a4fe770 SS	78	/* Endianness of code, for mixed-endian situations such as ARM BE8. */
6a4fe770 SS	79	enum bfd_endian endian_code;
cadaa522 FCE	80	/* An arch/mach-specific bitmask of selected instruction subsets, mainly
	81	for processors with run-time-switchable instruction sets. The default,
	82	zero, means that there is no constraint. CGEN-based opcodes ports
	83	may use ISA_foo masks. */
16175d96	84	void *insn_sets;
252b5132	85
ca6d9fb3 HPN	86	/* Some targets need information about the current section to accurately
	87	display insns. If this is NULL, the target disassembler function
	88	will have to make its best guess. */
	89	asection *section;
	90
252b5132 RH	91	/* An array of pointers to symbols either at the location being disassembled
	92	or at the start of the function being disassembled. The array is sorted
	93	so that the first symbol is intended to be the one used. The others are
	94	present for any misc. purposes. This is not set reliably, but if it is
	95	not NULL, it is correct. */
	96	asymbol **symbols;
	97	/* Number of symbols in array. */
	98	int num_symbols;
	99
2087ad84 PB	100	/* Symbol table provided for targets that want to look at it. This is
	101	used on Arm to find mapping symbols and determine Arm/Thumb code. */
	102	asymbol **symtab;
	103	int symtab_pos;
	104	int symtab_size;
	105
252b5132 RH	106	/* For use by the disassembler.
	107	The top 16 bits are reserved for public use (and are documented here).
	108	The bottom 16 bits are for the internal use of the disassembler. */
	109	unsigned long flags;
1316c8b3 NC	110	/* Set if the disassembler has determined that there are one or more
	111	relocations associated with the instruction being disassembled. */
	112	#define INSN_HAS_RELOC (1 << 31)
	113	/* Set if the user has requested the disassembly of data as well as code. */
	114	#define DISASSEMBLE_DATA (1 << 30)
0313a2b8 NC	115	/* Set if the user has specifically set the machine type encoded in the
	116	mach field of this structure. */
	117	#define USER_SPECIFIED_MACHINE_TYPE (1 << 29)
1316c8b3 NC	118
1316c8b3 NC	119	/* Use internally by the target specific disassembly code. */
8cf3f354	120	void *private_data;
252b5132 RH	121
	122	/* Function used to get bytes to disassemble. MEMADDR is the
	123	address of the stuff to be disassembled, MYADDR is the address to
	124	put the bytes in, and LENGTH is the number of bytes to read.
	125	INFO is a pointer to this struct.
	126	Returns an errno value or 0 for success. */
	127	int (*read_memory_func)
8cf3f354	128	(bfd_vma memaddr, bfd_byte *myaddr, unsigned int length,
e7f8eadb	129	struct disassemble_info *dinfo);
252b5132 RH	130
	131	/* Function which should be called if we get an error that we can't
	132	recover from. STATUS is the errno value from read_memory_func and
	133	MEMADDR is the address that we were trying to read. INFO is a
	134	pointer to this struct. */
	135	void (*memory_error_func)
e7f8eadb	136	(int status, bfd_vma memaddr, struct disassemble_info *dinfo);
252b5132 RH	137
	138	/* Function called to print ADDR. */
	139	void (*print_address_func)
e7f8eadb	140	(bfd_vma addr, struct disassemble_info *dinfo);
252b5132 RH	141
	142	/* Function called to determine if there is a symbol at the given ADDR.
	143	If there is, the function returns 1, otherwise it returns 0.
	144	This is used by ports which support an overlay manager where
	145	the overlay number is held in the top part of an address. In
	146	some circumstances we want to include the overlay number in the
	147	address, (normally because there is a symbol associated with
	148	that address), but sometimes we want to mask out the overlay bits. */
	149	int (* symbol_at_address_func)
e7f8eadb	150	(bfd_vma addr, struct disassemble_info *dinfo);
252b5132	151
22a398e1 NC	152	/* Function called to check if a SYMBOL is can be displayed to the user.
	153	This is used by some ports that want to hide special symbols when
	154	displaying debugging outout. */
	155	bfd_boolean (* symbol_is_valid)
e7f8eadb	156	(asymbol , struct disassemble_info dinfo);
d70c5fc7	157
252b5132 RH	158	/* These are for buffer_read_memory. */
	159	bfd_byte *buffer;
	160	bfd_vma buffer_vma;
f6af82bd	161	unsigned int buffer_length;
252b5132 RH	162
	163	/* This variable may be set by the instruction decoder. It suggests
	164	the number of bytes objdump should display on a single line. If
	165	the instruction decoder sets this, it should always set it to
	166	the same value in order to get reasonable looking output. */
	167	int bytes_per_line;
	168
22a398e1	169	/* The next two variables control the way objdump displays the raw data. */
252b5132 RH	170	/* For example, if bytes_per_line is 8 and bytes_per_chunk is 4, the */
	171	/* output will look like this:
	172	00: 00000000 00000000
	173	with the chunks displayed according to "display_endian". */
	174	int bytes_per_chunk;
	175	enum bfd_endian display_endian;
	176
d70c5fc7	177	/* Number of octets per incremented target address
3c3bdf30	178	Normally one, but some DSPs have byte sizes of 16 or 32 bits. */
f6af82bd	179	unsigned int octets_per_byte;
940b2b78	180
0bcb06d2 AS	181	/* The number of zeroes we want to see at the end of a section before we
	182	start skipping them. */
	183	unsigned int skip_zeroes;
	184
	185	/* The number of zeroes to skip at the end of a section. If the number
	186	of zeroes at the end is between SKIP_ZEROES_AT_END and SKIP_ZEROES,
	187	they will be disassembled. If there are fewer than
	188	SKIP_ZEROES_AT_END, they will be skipped. This is a heuristic
	189	attempt to avoid disassembling zeroes inserted by section
	190	alignment. */
	191	unsigned int skip_zeroes_at_end;
	192
d99b6465 AS	193	/* Whether the disassembler always needs the relocations. */
	194	bfd_boolean disassembler_needs_relocs;
	195
252b5132 RH	196	/* Results from instruction decoders. Not all decoders yet support
	197	this information. This info is set each time an instruction is
	198	decoded, and is only valid for the last such instruction.
	199
	200	To determine whether this decoder supports this information, set
	201	insn_info_valid to 0, decode an instruction, then check it. */
	202
	203	char insn_info_valid; /* Branch info has been set. */
	204	char branch_delay_insns; /* How many sequential insn's will run before
	205	a branch takes effect. (0 = normal) */
	206	char data_size; /* Size of data reference in insn, in bytes */
	207	enum dis_insn_type insn_type; /* Type of instruction */
	208	bfd_vma target; /* Target address of branch or dref, if known;
	209	zero if unknown. */
	210	bfd_vma target2; /* Second target address for dref2 */
	211
dd92f639 NC	212	/* Command line options specific to the target disassembler. */
	213	char * disassembler_options;
	214
252b5132 RH	215	} disassemble_info;
	216
	217	\f
	218	/* Standard disassemblers. Disassemble one instruction at the given
19222dc0	219	target address. Return number of octets processed. */
8cf3f354 AM	220	typedef int (disassembler_ftype) (bfd_vma, disassemble_info );
8cf3f354 AM	221
a06ea964	222	extern int print_insn_aarch64 (bfd_vma, disassemble_info *);
8cf3f354	223	extern int print_insn_alpha (bfd_vma, disassemble_info *);
8cf3f354	224	extern int print_insn_avr (bfd_vma, disassemble_info *);
dc603df5	225	extern int print_insn_bfin (bfd_vma, disassemble_info *);
1c0d3aa6 NC	226	extern int print_insn_big_arm (bfd_vma, disassemble_info *);
1c0d3aa6 NC	227	extern int print_insn_big_mips (bfd_vma, disassemble_info *);
36591ba1	228	extern int print_insn_big_nios2 (bfd_vma, disassemble_info *);
1c0d3aa6 NC	229	extern int print_insn_big_powerpc (bfd_vma, disassemble_info *);
1c0d3aa6 NC	230	extern int print_insn_big_score (bfd_vma, disassemble_info *);
3d3d428f	231	extern int print_insn_cr16 (bfd_vma, disassemble_info *);
1c0d3aa6	232	extern int print_insn_crx (bfd_vma, disassemble_info *);
8cf3f354 AM	233	extern int print_insn_d10v (bfd_vma, disassemble_info *);
	234	extern int print_insn_d30v (bfd_vma, disassemble_info *);
	235	extern int print_insn_dlx (bfd_vma, disassemble_info *);
cfb8c092	236	extern int print_insn_epiphany (bfd_vma, disassemble_info *);
8cf3f354	237	extern int print_insn_fr30 (bfd_vma, disassemble_info *);
1c0d3aa6	238	extern int print_insn_frv (bfd_vma, disassemble_info *);
3f8107ab	239	extern int print_insn_ft32 (bfd_vma, disassemble_info *);
1c0d3aa6 NC	240	extern int print_insn_h8300 (bfd_vma, disassemble_info *);
	241	extern int print_insn_h8300h (bfd_vma, disassemble_info *);
	242	extern int print_insn_h8300s (bfd_vma, disassemble_info *);
	243	extern int print_insn_h8500 (bfd_vma, disassemble_info *);
8cf3f354	244	extern int print_insn_hppa (bfd_vma, disassemble_info *);
1c0d3aa6 NC	245	extern int print_insn_i370 (bfd_vma, disassemble_info *);
	246	extern int print_insn_i386 (bfd_vma, disassemble_info *);
	247	extern int print_insn_i386_att (bfd_vma, disassemble_info *);
	248	extern int print_insn_i386_intel (bfd_vma, disassemble_info *);
8cf3f354 AM	249	extern int print_insn_i860 (bfd_vma, disassemble_info *);
8cf3f354 AM	250	extern int print_insn_i960 (bfd_vma, disassemble_info *);
1c0d3aa6	251	extern int print_insn_ia64 (bfd_vma, disassemble_info *);
8cf3f354	252	extern int print_insn_ip2k (bfd_vma, disassemble_info *);
1c0d3aa6 NC	253	extern int print_insn_iq2000 (bfd_vma, disassemble_info *);
	254	extern int print_insn_little_arm (bfd_vma, disassemble_info *);
	255	extern int print_insn_little_mips (bfd_vma, disassemble_info *);
36591ba1	256	extern int print_insn_little_nios2 (bfd_vma, disassemble_info *);
1c0d3aa6 NC	257	extern int print_insn_little_powerpc (bfd_vma, disassemble_info *);
1c0d3aa6 NC	258	extern int print_insn_little_score (bfd_vma, disassemble_info *);
84e94c90	259	extern int print_insn_lm32 (bfd_vma, disassemble_info *);
1c0d3aa6	260	extern int print_insn_m32c (bfd_vma, disassemble_info *);
8cf3f354	261	extern int print_insn_m32r (bfd_vma, disassemble_info *);
1c0d3aa6 NC	262	extern int print_insn_m68hc11 (bfd_vma, disassemble_info *);
1c0d3aa6 NC	263	extern int print_insn_m68hc12 (bfd_vma, disassemble_info *);
6927f982 NC	264	extern int print_insn_m9s12x (bfd_vma, disassemble_info *);
6927f982 NC	265	extern int print_insn_m9s12xg (bfd_vma, disassemble_info *);
1c0d3aa6	266	extern int print_insn_m68k (bfd_vma, disassemble_info *);
8cf3f354 AM	267	extern int print_insn_m88k (bfd_vma, disassemble_info *);
8cf3f354 AM	268	extern int print_insn_mcore (bfd_vma, disassemble_info *);
d6eafc3e	269	extern int print_insn_mep (bfd_vma, disassemble_info *);
a3c62988	270	extern int print_insn_metag (bfd_vma, disassemble_info *);
7ba29e2a	271	extern int print_insn_microblaze (bfd_vma, disassemble_info *);
8cf3f354 AM	272	extern int print_insn_mmix (bfd_vma, disassemble_info *);
	273	extern int print_insn_mn10200 (bfd_vma, disassemble_info *);
	274	extern int print_insn_mn10300 (bfd_vma, disassemble_info *);
20135e4c	275	extern int print_insn_moxie (bfd_vma, disassemble_info *);
8cf3f354	276	extern int print_insn_msp430 (bfd_vma, disassemble_info *);
1c0d3aa6	277	extern int print_insn_mt (bfd_vma, disassemble_info *);
35c08157	278	extern int print_insn_nds32 (bfd_vma, disassemble_info *);
8cf3f354	279	extern int print_insn_ns32k (bfd_vma, disassemble_info *);
73589c9d	280	extern int print_insn_or1k (bfd_vma, disassemble_info *);
8cf3f354 AM	281	extern int print_insn_pdp11 (bfd_vma, disassemble_info *);
8cf3f354 AM	282	extern int print_insn_pj (bfd_vma, disassemble_info *);
8cf3f354	283	extern int print_insn_rs6000 (bfd_vma, disassemble_info *);
d70c5fc7	284	extern int print_insn_s390 (bfd_vma, disassemble_info *);
8cf3f354	285	extern int print_insn_sh (bfd_vma, disassemble_info *);
1c0d3aa6 NC	286	extern int print_insn_sh64 (bfd_vma, disassemble_info *);
	287	extern int print_insn_sh64x_media (bfd_vma, disassemble_info *);
	288	extern int print_insn_sparc (bfd_vma, disassemble_info *);
e9f53129	289	extern int print_insn_spu (bfd_vma, disassemble_info *);
8cf3f354 AM	290	extern int print_insn_tic30 (bfd_vma, disassemble_info *);
	291	extern int print_insn_tic4x (bfd_vma, disassemble_info *);
	292	extern int print_insn_tic54x (bfd_vma, disassemble_info *);
40b36596	293	extern int print_insn_tic6x (bfd_vma, disassemble_info *);
8cf3f354	294	extern int print_insn_tic80 (bfd_vma, disassemble_info *);
aa137e4d NC	295	extern int print_insn_tilegx (bfd_vma, disassemble_info *);
aa137e4d NC	296	extern int print_insn_tilepro (bfd_vma, disassemble_info *);
8cf3f354 AM	297	extern int print_insn_v850 (bfd_vma, disassemble_info *);
8cf3f354 AM	298	extern int print_insn_vax (bfd_vma, disassemble_info *);
1945cfa5	299	extern int print_insn_visium (bfd_vma, disassemble_info *);
8cf3f354	300	extern int print_insn_w65 (bfd_vma, disassemble_info *);
1c0d3aa6	301	extern int print_insn_xc16x (bfd_vma, disassemble_info *);
f6c1a2d5	302	extern int print_insn_xgate (bfd_vma, disassemble_info *);
8cf3f354 AM	303	extern int print_insn_xstormy16 (bfd_vma, disassemble_info *);
8cf3f354 AM	304	extern int print_insn_xtensa (bfd_vma, disassemble_info *);
1c0d3aa6 NC	305	extern int print_insn_z80 (bfd_vma, disassemble_info *);
	306	extern int print_insn_z8001 (bfd_vma, disassemble_info *);
	307	extern int print_insn_z8002 (bfd_vma, disassemble_info *);
c7927a3c	308	extern int print_insn_rx (bfd_vma, disassemble_info *);
99c513f6	309	extern int print_insn_rl78 (bfd_vma, disassemble_info *);
0952813b DD	310	extern int print_insn_rl78_g10 (bfd_vma, disassemble_info *);
	311	extern int print_insn_rl78_g13 (bfd_vma, disassemble_info *);
	312	extern int print_insn_rl78_g14 (bfd_vma, disassemble_info *);
8cf3f354 AM	313
	314	extern disassembler_ftype arc_get_disassembler (void *);
	315	extern disassembler_ftype cris_get_disassembler (bfd *);
0952813b	316	extern disassembler_ftype rl78_get_disassembler (bfd *);
8cf3f354	317
a06ea964	318	extern void print_aarch64_disassembler_options (FILE *);
f59a29b9	319	extern void print_i386_disassembler_options (FILE *);
8cf3f354 AM	320	extern void print_mips_disassembler_options (FILE *);
	321	extern void print_ppc_disassembler_options (FILE *);
	322	extern void print_arm_disassembler_options (FILE *);
	323	extern void parse_arm_disassembler_option (char *);
112b7c50	324	extern void print_s390_disassembler_options (FILE *);
1c0d3aa6 NC	325	extern int get_arm_regname_num_options (void);
	326	extern int set_arm_regname_option (int);
	327	extern int get_arm_regnames (int, const char , const char , const char const *);
a06ea964	328	extern bfd_boolean aarch64_symbol_is_valid (asymbol , struct disassemble_info );
22a398e1	329	extern bfd_boolean arm_symbol_is_valid (asymbol , struct disassemble_info );
b240011a	330	extern void disassemble_init_powerpc (struct disassemble_info *);
dd92f639	331
252b5132	332	/* Fetch the disassembler for a given BFD, if that support is available. */
8cf3f354	333	extern disassembler_ftype disassembler (bfd *);
252b5132	334
22a398e1 NC	335	/* Amend the disassemble_info structure as necessary for the target architecture.
22a398e1 NC	336	Should only be called after initialising the info->arch field. */
e7f8eadb	337	extern void disassemble_init_for_target (struct disassemble_info * dinfo);
22a398e1	338
94470b23	339	/* Document any target specific options available from the disassembler. */
8cf3f354	340	extern void disassembler_usage (FILE *);
94470b23	341
252b5132 RH	342	\f
	343	/* This block of definitions is for particular callers who read instructions
	344	into a buffer before calling the instruction decoder. */
	345
	346	/* Here is a function which callers may wish to use for read_memory_func.
	347	It gets bytes from a buffer. */
	348	extern int buffer_read_memory
8cf3f354	349	(bfd_vma, bfd_byte , unsigned int, struct disassemble_info );
252b5132 RH	350
	351	/* This function goes with buffer_read_memory.
	352	It prints a message using info->fprintf_func and info->stream. */
8cf3f354	353	extern void perror_memory (int, bfd_vma, struct disassemble_info *);
252b5132 RH	354
	355
	356	/* Just print the address in hex. This is included for completeness even
	357	though both GDB and objdump provide their own (to print symbolic
	358	addresses). */
	359	extern void generic_print_address
8cf3f354	360	(bfd_vma, struct disassemble_info *);
252b5132 RH	361
	362	/* Always true. */
	363	extern int generic_symbol_at_address
8cf3f354	364	(bfd_vma, struct disassemble_info *);
252b5132	365
d70c5fc7	366	/* Also always true. */
22a398e1 NC	367	extern bfd_boolean generic_symbol_is_valid
22a398e1 NC	368	(asymbol , struct disassemble_info );
d70c5fc7	369
92c2346c AC	370	/* Method to initialize a disassemble_info struct. This should be
92c2346c AC	371	called by all applications creating such a struct. */
e7f8eadb	372	extern void init_disassemble_info (struct disassemble_info dinfo, void stream,
92c2346c	373	fprintf_ftype fprintf_func);
252b5132	374
92c2346c AC	375	/* For compatibility with existing code. */
	376	#define INIT_DISASSEMBLE_INFO(INFO, STREAM, FPRINTF_FUNC) \
	377	init_disassemble_info (&(INFO), (STREAM), (fprintf_ftype) (FPRINTF_FUNC))
252b5132	378	#define INIT_DISASSEMBLE_INFO_NO_ARCH(INFO, STREAM, FPRINTF_FUNC) \
92c2346c AC	379	init_disassemble_info (&(INFO), (STREAM), (fprintf_ftype) (FPRINTF_FUNC))
92c2346c AC	380
252b5132	381
7d7a6736	382	#ifdef __cplusplus
8418f5ff	383	}
7d7a6736 ILT	384	#endif
7d7a6736 ILT	385
252b5132	386	#endif /* ! defined (DIS_ASM_H) */