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

/* Interface between the opcode library and its callers.
   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

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

typedef int (*fprintf_ftype) PARAMS((FILE*, const char*, ...));

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;
  FILE *stream;
  PTR 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;
  /* The symbol at the start of the function being disassembled.  This
     is not set reliably, but if it is not NULL, it is correct.  */
  asymbol *symbol;

  /* 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
  PTR 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)
    PARAMS ((bfd_vma memaddr, bfd_byte *myaddr, 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)
    PARAMS ((int status, bfd_vma memaddr, struct disassemble_info *info));

  /* Function called to print ADDR.  */
  void (*print_address_func)
    PARAMS ((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)
    PARAMS ((bfd_vma addr, struct disassemble_info * info));

  /* These are for buffer_read_memory.  */
  bfd_byte *buffer;
  bfd_vma buffer_vma;
  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;

  /* 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 */

} disassemble_info;

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

extern int print_insn_big_mips		PARAMS ((bfd_vma, disassemble_info*));
extern int print_insn_little_mips	PARAMS ((bfd_vma, disassemble_info*));
extern int print_insn_i386		PARAMS ((bfd_vma, disassemble_info*));
extern int print_insn_m68k		PARAMS ((bfd_vma, disassemble_info*));
extern int print_insn_z8001		PARAMS ((bfd_vma, disassemble_info*));
extern int print_insn_z8002		PARAMS ((bfd_vma, disassemble_info*));
extern int print_insn_h8300		PARAMS ((bfd_vma, disassemble_info*));
extern int print_insn_h8300h		PARAMS ((bfd_vma, disassemble_info*));
extern int print_insn_h8300s		PARAMS ((bfd_vma, disassemble_info*));
extern int print_insn_h8500		PARAMS ((bfd_vma, disassemble_info*));
extern int print_insn_alpha		PARAMS ((bfd_vma, disassemble_info*));
extern disassembler_ftype arc_get_disassembler PARAMS ((int, int));
extern int print_insn_big_arm		PARAMS ((bfd_vma, disassemble_info*));
extern int print_insn_little_arm	PARAMS ((bfd_vma, disassemble_info*));
extern int print_insn_sparc		PARAMS ((bfd_vma, disassemble_info*));
extern int print_insn_big_a29k		PARAMS ((bfd_vma, disassemble_info*));
extern int print_insn_little_a29k	PARAMS ((bfd_vma, disassemble_info*));
extern int print_insn_i960		PARAMS ((bfd_vma, disassemble_info*));
extern int print_insn_sh		PARAMS ((bfd_vma, disassemble_info*));
extern int print_insn_shl		PARAMS ((bfd_vma, disassemble_info*));
extern int print_insn_hppa		PARAMS ((bfd_vma, disassemble_info*));
extern int print_insn_m32r		PARAMS ((bfd_vma, disassemble_info*));
extern int print_insn_m88k		PARAMS ((bfd_vma, disassemble_info*));
extern int print_insn_mn10200		PARAMS ((bfd_vma, disassemble_info*));
extern int print_insn_mn10300		PARAMS ((bfd_vma, disassemble_info*));
extern int print_insn_ns32k		PARAMS ((bfd_vma, disassemble_info*));
extern int print_insn_big_powerpc	PARAMS ((bfd_vma, disassemble_info*));
extern int print_insn_little_powerpc	PARAMS ((bfd_vma, disassemble_info*));
extern int print_insn_rs6000		PARAMS ((bfd_vma, disassemble_info*));
extern int print_insn_w65		PARAMS ((bfd_vma, disassemble_info*));
extern int print_insn_d10v		PARAMS ((bfd_vma, disassemble_info*));
/* start-sanitize-d30v */
extern int print_insn_d30v		PARAMS ((bfd_vma, disassemble_info*));
/* end-sanitize-d30v */
extern int print_insn_v850		PARAMS ((bfd_vma, disassemble_info*));
/* start-sanitize-tic80 */
extern int print_insn_tic80		PARAMS ((bfd_vma, disassemble_info*));
/* end-sanitize-tic80 */
/* start-sanitize-sky */
extern int print_insn_txvu		PARAMS ((bfd_vma, disassemble_info*));
/* end-sanitize-sky */

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

\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
  PARAMS ((bfd_vma, bfd_byte *, 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 PARAMS ((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
  PARAMS ((bfd_vma, struct disassemble_info *));

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

/* Macro to initialize a disassemble_info struct.  This should be called
   by all applications creating such a struct.  */
#define INIT_DISASSEMBLE_INFO(INFO, STREAM, FPRINTF_FUNC) \
  (INFO).flavour = bfd_target_unknown_flavour, \
  (INFO).arch = bfd_arch_unknown, \
  (INFO).mach = 0, \
  (INFO).endian = BFD_ENDIAN_UNKNOWN, \
  INIT_DISASSEMBLE_INFO_NO_ARCH(INFO, STREAM, FPRINTF_FUNC)

/* Call this macro to initialize only the internal variables for the
   disassembler.  Architecture dependent things such as byte order, or machine
   variant are not touched by this macro.  This makes things much easier for
   GDB which must initialize these things seperatly.  */

#define INIT_DISASSEMBLE_INFO_NO_ARCH(INFO, STREAM, FPRINTF_FUNC) \
  (INFO).fprintf_func = (FPRINTF_FUNC), \
  (INFO).stream = (STREAM), \
  (INFO).symbol = NULL, \
  (INFO).buffer = NULL, \
  (INFO).buffer_vma = 0, \
  (INFO).buffer_length = 0, \
  (INFO).read_memory_func = buffer_read_memory, \
  (INFO).memory_error_func = perror_memory, \
  (INFO).print_address_func = generic_print_address, \
  (INFO).symbol_at_address_func = generic_symbol_at_address, \
  (INFO).flags = 0, \
  (INFO).bytes_per_line = 0, \
  (INFO).bytes_per_chunk = 0, \
  (INFO).display_endian = BFD_ENDIAN_UNKNOWN, \
  (INFO).insn_info_valid = 0

#endif /* ! defined (DIS_ASM_H) */
Commit	Line	Data
308a5981 JG	1	/* Interface between the opcode library and its callers.
	2	Written by Cygnus Support, 1993.
	3
	4	The opcode library (libopcodes.a) provides instruction decoders for
	5	a large variety of instruction sets, callable with an identical
	6	interface, for making instruction-processing programs more independent
	7	of the instruction set being processed. */
	8
dc7d3f0c ILT	9	#ifndef DIS_ASM_H
	10	#define DIS_ASM_H
	11
d7e1be46	12	#include <stdio.h>
d7e1be46 PB	13	#include "bfd.h"
	14
	15	typedef int (fprintf_ftype) PARAMS((FILE, const char*, ...));
	16
811b15ef SC	17	enum dis_insn_type {
	18	dis_noninsn, /* Not a valid instruction */
	19	dis_nonbranch, /* Not a branch instruction */
	20	dis_branch, /* Unconditional branch */
	21	dis_condbranch, /* Conditional branch */
	22	dis_jsr, /* Jump to subroutine */
	23	dis_condjsr, /* Conditional jump to subroutine */
	24	dis_dref, /* Data reference instruction */
	25	dis_dref2 /* Two data references in instruction */
	26	};
308a5981 JG	27
	28	/* This struct is passed into the instruction decoding routine,
	29	and is passed back out into each callback. The various fields are used
	30	for conveying information from your main routine into your callbacks,
	31	for passing information into the instruction decoders (such as the
	32	addresses of the callback functions), or for passing information
	33	back from the instruction decoders to their callers.
	34
	35	It must be initialized before it is first passed; this can be done
	36	by hand, or using one of the initialization macros below. */
	37
d7e1be46 PB	38	typedef struct disassemble_info {
	39	fprintf_ftype fprintf_func;
	40	FILE *stream;
308a5981	41	PTR application_data;
5d0734a7	42
3e496fff DE	43	/* Target description. We could replace this with a pointer to the bfd,
	44	but that would require one. There currently isn't any such requirement
	45	so to avoid introducing one we record these explicitly. */
cad8350f JL	46	/* The bfd_flavour. This can be bfd_target_unknown_flavour. */
cad8350f JL	47	enum bfd_flavour flavour;
3e496fff DE	48	/* The bfd_arch value. */
	49	enum bfd_architecture arch;
	50	/* The bfd_mach value. */
	51	unsigned long mach;
	52	/* Endianness (for bi-endian cpus). Mono-endian cpus can ignore this. */
	53	enum bfd_endian endian;
ea16981a NC	54	/* The symbol at the start of the function being disassembled. This
	55	is not set reliably, but if it is not NULL, it is correct. */
	56	asymbol *symbol;
3e496fff DE	57
	58	/* For use by the disassembler.
	59	The top 16 bits are reserved for public use (and are documented here).
	60	The bottom 16 bits are for the internal use of the disassembler. */
	61	unsigned long flags;
962ac804	62	#define INSN_HAS_RELOC 0x80000000
5d0734a7 JK	63	PTR private_data;
	64
	65	/* Function used to get bytes to disassemble. MEMADDR is the
	66	address of the stuff to be disassembled, MYADDR is the address to
	67	put the bytes in, and LENGTH is the number of bytes to read.
	68	INFO is a pointer to this struct.
	69	Returns an errno value or 0 for success. */
	70	int (*read_memory_func)
	71	PARAMS ((bfd_vma memaddr, bfd_byte *myaddr, int length,
	72	struct disassemble_info *info));
	73
	74	/* Function which should be called if we get an error that we can't
	75	recover from. STATUS is the errno value from read_memory_func and
	76	MEMADDR is the address that we were trying to read. INFO is a
	77	pointer to this struct. */
	78	void (*memory_error_func)
	79	PARAMS ((int status, bfd_vma memaddr, struct disassemble_info *info));
	80
482d6747 ILT	81	/* Function called to print ADDR. */
	82	void (*print_address_func)
	83	PARAMS ((bfd_vma addr, struct disassemble_info *info));
	84
ea16981a NC	85	/* Function called to determine if there is a symbol at the given ADDR.
	86	If there is, the function returns 1, otherwise it returns 0.
	87	This is used by ports which support an overlay manager where
	88	the overlay number is held in the top part of an address. In
	89	some circumstances we want to include the overlay number in the
	90	address, (normally because there is a symbol associated with
	91	that address), but sometimes we want to mask out the overlay bits. */
	92	int (* symbol_at_address_func)
	93	PARAMS ((bfd_vma addr, struct disassemble_info * info));
	94
5d0734a7 JK	95	/* These are for buffer_read_memory. */
	96	bfd_byte *buffer;
	97	bfd_vma buffer_vma;
	98	int buffer_length;
308a5981	99
ea16981a NC	100	/* This variable may be set by the instruction decoder. It suggests
	101	the number of bytes objdump should display on a single line. If
	102	the instruction decoder sets this, it should always set it to
	103	the same value in order to get reasonable looking output. */
	104	int bytes_per_line;
	105
	106	/* the next two variables control the way objdump displays the raw data */
	107	/* For example, if bytes_per_line is 8 and bytes_per_chunk is 4, the */
	108	/* output will look like this:
	109	00: 00000000 00000000
	110	with the chunks displayed according to "display_endian". */
	111	int bytes_per_chunk;
	112	enum bfd_endian display_endian;
	113
308a5981 JG	114	/* Results from instruction decoders. Not all decoders yet support
	115	this information. This info is set each time an instruction is
	116	decoded, and is only valid for the last such instruction.
	117
	118	To determine whether this decoder supports this information, set
	119	insn_info_valid to 0, decode an instruction, then check it. */
	120
308a5981 JG	121	char insn_info_valid; /* Branch info has been set. */
	122	char branch_delay_insns; /* How many sequential insn's will run before
	123	a branch takes effect. (0 = normal) */
	124	char data_size; /* Size of data reference in insn, in bytes */
	125	enum dis_insn_type insn_type; /* Type of instruction */
	126	bfd_vma target; /* Target address of branch or dref, if known;
	127	zero if unknown. */
	128	bfd_vma target2; /* Second target address for dref2 */
	129
d7e1be46 PB	130	} disassemble_info;
d7e1be46 PB	131
308a5981 JG	132	\f
	133	/* Standard disassemblers. Disassemble one instruction at the given
	134	target address. Return number of bytes processed. */
	135	typedef int (*disassembler_ftype)
	136	PARAMS((bfd_vma, disassemble_info *));
	137
	138	extern int print_insn_big_mips PARAMS ((bfd_vma, disassemble_info*));
	139	extern int print_insn_little_mips PARAMS ((bfd_vma, disassemble_info*));
	140	extern int print_insn_i386 PARAMS ((bfd_vma, disassemble_info*));
	141	extern int print_insn_m68k PARAMS ((bfd_vma, disassemble_info*));
	142	extern int print_insn_z8001 PARAMS ((bfd_vma, disassemble_info*));
	143	extern int print_insn_z8002 PARAMS ((bfd_vma, disassemble_info*));
	144	extern int print_insn_h8300 PARAMS ((bfd_vma, disassemble_info*));
	145	extern int print_insn_h8300h PARAMS ((bfd_vma, disassemble_info*));
16cf520e	146	extern int print_insn_h8300s PARAMS ((bfd_vma, disassemble_info*));
308a5981	147	extern int print_insn_h8500 PARAMS ((bfd_vma, disassemble_info*));
cad8350f	148	extern int print_insn_alpha PARAMS ((bfd_vma, disassemble_info*));
3e496fff	149	extern disassembler_ftype arc_get_disassembler PARAMS ((int, int));
3e496fff DE	150	extern int print_insn_big_arm PARAMS ((bfd_vma, disassemble_info*));
3e496fff DE	151	extern int print_insn_little_arm PARAMS ((bfd_vma, disassemble_info*));
308a5981 JG	152	extern int print_insn_sparc PARAMS ((bfd_vma, disassemble_info*));
	153	extern int print_insn_big_a29k PARAMS ((bfd_vma, disassemble_info*));
	154	extern int print_insn_little_a29k PARAMS ((bfd_vma, disassemble_info*));
	155	extern int print_insn_i960 PARAMS ((bfd_vma, disassemble_info*));
	156	extern int print_insn_sh PARAMS ((bfd_vma, disassemble_info*));
811b15ef	157	extern int print_insn_shl PARAMS ((bfd_vma, disassemble_info*));
308a5981	158	extern int print_insn_hppa PARAMS ((bfd_vma, disassemble_info*));
db2d85c6	159	extern int print_insn_m32r PARAMS ((bfd_vma, disassemble_info*));
308a5981	160	extern int print_insn_m88k PARAMS ((bfd_vma, disassemble_info*));
ae1b99e4 JL	161	extern int print_insn_mn10200 PARAMS ((bfd_vma, disassemble_info*));
ae1b99e4 JL	162	extern int print_insn_mn10300 PARAMS ((bfd_vma, disassemble_info*));
811b15ef SC	163	extern int print_insn_ns32k PARAMS ((bfd_vma, disassemble_info*));
	164	extern int print_insn_big_powerpc PARAMS ((bfd_vma, disassemble_info*));
	165	extern int print_insn_little_powerpc PARAMS ((bfd_vma, disassemble_info*));
	166	extern int print_insn_rs6000 PARAMS ((bfd_vma, disassemble_info*));
66032a39	167	extern int print_insn_w65 PARAMS ((bfd_vma, disassemble_info*));
770e0827	168	extern int print_insn_d10v PARAMS ((bfd_vma, disassemble_info*));
ea16981a NC	169	/* start-sanitize-d30v */
	170	extern int print_insn_d30v PARAMS ((bfd_vma, disassemble_info*));
	171	/* end-sanitize-d30v */
cad8350f	172	extern int print_insn_v850 PARAMS ((bfd_vma, disassemble_info*));
ea16981a NC	173	/* start-sanitize-tic80 */
	174	extern int print_insn_tic80 PARAMS ((bfd_vma, disassemble_info*));
	175	/* end-sanitize-tic80 */
1eb4e377 DE	176	/* start-sanitize-sky */
	177	extern int print_insn_txvu PARAMS ((bfd_vma, disassemble_info*));
	178	/* end-sanitize-sky */
308a5981	179
811b15ef SC	180	/* Fetch the disassembler for a given BFD, if that support is available. */
811b15ef SC	181	extern disassembler_ftype disassembler PARAMS ((bfd *));
308a5981 JG	182
	183	\f
	184	/* This block of definitions is for particular callers who read instructions
	185	into a buffer before calling the instruction decoder. */
	186
5d0734a7 JK	187	/* Here is a function which callers may wish to use for read_memory_func.
	188	It gets bytes from a buffer. */
	189	extern int buffer_read_memory
	190	PARAMS ((bfd_vma, bfd_byte , int, struct disassemble_info ));
	191
	192	/* This function goes with buffer_read_memory.
	193	It prints a message using info->fprintf_func and info->stream. */
	194	extern void perror_memory PARAMS ((int, bfd_vma, struct disassemble_info *));
d7e1be46	195
308a5981	196
3e496fff	197	/* Just print the address in hex. This is included for completeness even
482d6747 ILT	198	though both GDB and objdump provide their own (to print symbolic
	199	addresses). */
	200	extern void generic_print_address
	201	PARAMS ((bfd_vma, struct disassemble_info *));
	202
ea16981a NC	203	/* Always true. */
	204	extern int generic_symbol_at_address
	205	PARAMS ((bfd_vma, struct disassemble_info *));
	206
16cf520e JL	207	/* Macro to initialize a disassemble_info struct. This should be called
16cf520e JL	208	by all applications creating such a struct. */
f29a36c0	209	#define INIT_DISASSEMBLE_INFO(INFO, STREAM, FPRINTF_FUNC) \
cad8350f	210	(INFO).flavour = bfd_target_unknown_flavour, \
a29322f7 SG	211	(INFO).arch = bfd_arch_unknown, \
	212	(INFO).mach = 0, \
	213	(INFO).endian = BFD_ENDIAN_UNKNOWN, \
	214	INIT_DISASSEMBLE_INFO_NO_ARCH(INFO, STREAM, FPRINTF_FUNC)
	215
	216	/* Call this macro to initialize only the internal variables for the
	217	disassembler. Architecture dependent things such as byte order, or machine
	218	variant are not touched by this macro. This makes things much easier for
	219	GDB which must initialize these things seperatly. */
	220
	221	#define INIT_DISASSEMBLE_INFO_NO_ARCH(INFO, STREAM, FPRINTF_FUNC) \
f29a36c0	222	(INFO).fprintf_func = (FPRINTF_FUNC), \
5d0734a7	223	(INFO).stream = (STREAM), \
ea16981a	224	(INFO).symbol = NULL, \
5d0734a7 JK	225	(INFO).buffer = NULL, \
	226	(INFO).buffer_vma = 0, \
	227	(INFO).buffer_length = 0, \
	228	(INFO).read_memory_func = buffer_read_memory, \
482d6747	229	(INFO).memory_error_func = perror_memory, \
308a5981	230	(INFO).print_address_func = generic_print_address, \
ea16981a	231	(INFO).symbol_at_address_func = generic_symbol_at_address, \
3e496fff	232	(INFO).flags = 0, \
ea16981a NC	233	(INFO).bytes_per_line = 0, \
	234	(INFO).bytes_per_chunk = 0, \
	235	(INFO).display_endian = BFD_ENDIAN_UNKNOWN, \
308a5981	236	(INFO).insn_info_valid = 0
dc7d3f0c ILT	237
dc7d3f0c ILT	238	#endif /* ! defined (DIS_ASM_H) */