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

/* Interface between the opcode library and its callers.

   Copyright 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006
   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 2, 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;
#define INSN_HAS_RELOC	0x80000000
  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 *info);

  /* 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 *info);

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

  /* 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 * info);

  /* 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 * info);

  /* 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_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_or32		(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_fr30		(bfd_vma, disassemble_info *);
extern int print_insn_frv		(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_or32	(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_m68k		(bfd_vma, disassemble_info *);
extern int print_insn_m88k		(bfd_vma, disassemble_info *);
extern int print_insn_maxq_big		(bfd_vma, disassemble_info *);
extern int print_insn_maxq_little	(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_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_msp430		(bfd_vma, disassemble_info *);
extern int print_insn_mt                (bfd_vma, disassemble_info *);
extern int print_insn_ns32k		(bfd_vma, disassemble_info *);
extern int print_insn_openrisc		(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_tic80		(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_w65		(bfd_vma, disassemble_info *);
extern int print_insn_xc16x		(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 disassembler_ftype arc_get_disassembler (void *);
extern disassembler_ftype cris_get_disassembler (bfd *);

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 arm_symbol_is_valid (asymbol *, 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 * info);

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