[binutils.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;

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

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

  /* 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*));
/* start-sanitize-arc */
extern disassembler_ftype arc_get_disassembler PARAMS ((int, int));
/* end-sanitize-arc */
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*));
/* start-sanitize-m32r */
extern int print_insn_m32r		PARAMS ((bfd_vma, disassemble_info*));
/* end-sanitize-m32r */
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*));
/* start-sanitize-d10v */
extern int print_insn_d10v		PARAMS ((bfd_vma, disassemble_info*));
/* end-sanitize-d10v */
/* start-sanitize-v850 */
extern int print_insn_v850		PARAMS ((bfd_vma, disassemble_info*));
/* end-sanitize-v850 */

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

/* 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).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).flags = 0, \
  (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;
	54
	55	/* For use by the disassembler.
	56	The top 16 bits are reserved for public use (and are documented here).
	57	The bottom 16 bits are for the internal use of the disassembler. */
	58	unsigned long flags;
5d0734a7 JK	59	PTR private_data;
	60
	61	/* Function used to get bytes to disassemble. MEMADDR is the
	62	address of the stuff to be disassembled, MYADDR is the address to
	63	put the bytes in, and LENGTH is the number of bytes to read.
	64	INFO is a pointer to this struct.
	65	Returns an errno value or 0 for success. */
	66	int (*read_memory_func)
	67	PARAMS ((bfd_vma memaddr, bfd_byte *myaddr, int length,
	68	struct disassemble_info *info));
	69
	70	/* Function which should be called if we get an error that we can't
	71	recover from. STATUS is the errno value from read_memory_func and
	72	MEMADDR is the address that we were trying to read. INFO is a
	73	pointer to this struct. */
	74	void (*memory_error_func)
	75	PARAMS ((int status, bfd_vma memaddr, struct disassemble_info *info));
	76
482d6747 ILT	77	/* Function called to print ADDR. */
	78	void (*print_address_func)
	79	PARAMS ((bfd_vma addr, struct disassemble_info *info));
	80
5d0734a7 JK	81	/* These are for buffer_read_memory. */
	82	bfd_byte *buffer;
	83	bfd_vma buffer_vma;
	84	int buffer_length;
308a5981 JG	85
	86	/* Results from instruction decoders. Not all decoders yet support
	87	this information. This info is set each time an instruction is
	88	decoded, and is only valid for the last such instruction.
	89
	90	To determine whether this decoder supports this information, set
	91	insn_info_valid to 0, decode an instruction, then check it. */
	92
308a5981 JG	93	char insn_info_valid; /* Branch info has been set. */
	94	char branch_delay_insns; /* How many sequential insn's will run before
	95	a branch takes effect. (0 = normal) */
	96	char data_size; /* Size of data reference in insn, in bytes */
	97	enum dis_insn_type insn_type; /* Type of instruction */
	98	bfd_vma target; /* Target address of branch or dref, if known;
	99	zero if unknown. */
	100	bfd_vma target2; /* Second target address for dref2 */
	101
d7e1be46 PB	102	} disassemble_info;
d7e1be46 PB	103
308a5981 JG	104	\f
	105	/* Standard disassemblers. Disassemble one instruction at the given
	106	target address. Return number of bytes processed. */
	107	typedef int (*disassembler_ftype)
	108	PARAMS((bfd_vma, disassemble_info *));
	109
	110	extern int print_insn_big_mips PARAMS ((bfd_vma, disassemble_info*));
	111	extern int print_insn_little_mips PARAMS ((bfd_vma, disassemble_info*));
	112	extern int print_insn_i386 PARAMS ((bfd_vma, disassemble_info*));
	113	extern int print_insn_m68k PARAMS ((bfd_vma, disassemble_info*));
	114	extern int print_insn_z8001 PARAMS ((bfd_vma, disassemble_info*));
	115	extern int print_insn_z8002 PARAMS ((bfd_vma, disassemble_info*));
	116	extern int print_insn_h8300 PARAMS ((bfd_vma, disassemble_info*));
	117	extern int print_insn_h8300h PARAMS ((bfd_vma, disassemble_info*));
16cf520e	118	extern int print_insn_h8300s PARAMS ((bfd_vma, disassemble_info*));
308a5981	119	extern int print_insn_h8500 PARAMS ((bfd_vma, disassemble_info*));
cad8350f	120	extern int print_insn_alpha PARAMS ((bfd_vma, disassemble_info*));
dc7d3f0c	121	/* start-sanitize-arc */
3e496fff	122	extern disassembler_ftype arc_get_disassembler PARAMS ((int, int));
dc7d3f0c	123	/* end-sanitize-arc */
3e496fff DE	124	extern int print_insn_big_arm PARAMS ((bfd_vma, disassemble_info*));
3e496fff DE	125	extern int print_insn_little_arm PARAMS ((bfd_vma, disassemble_info*));
308a5981 JG	126	extern int print_insn_sparc PARAMS ((bfd_vma, disassemble_info*));
	127	extern int print_insn_big_a29k PARAMS ((bfd_vma, disassemble_info*));
	128	extern int print_insn_little_a29k PARAMS ((bfd_vma, disassemble_info*));
	129	extern int print_insn_i960 PARAMS ((bfd_vma, disassemble_info*));
	130	extern int print_insn_sh PARAMS ((bfd_vma, disassemble_info*));
811b15ef	131	extern int print_insn_shl PARAMS ((bfd_vma, disassemble_info*));
308a5981	132	extern int print_insn_hppa PARAMS ((bfd_vma, disassemble_info*));
db2d85c6 DE	133	/* start-sanitize-m32r */
	134	extern int print_insn_m32r PARAMS ((bfd_vma, disassemble_info*));
	135	/* end-sanitize-m32r */
308a5981	136	extern int print_insn_m88k PARAMS ((bfd_vma, disassemble_info*));
ae1b99e4 JL	137	extern int print_insn_mn10200 PARAMS ((bfd_vma, disassemble_info*));
ae1b99e4 JL	138	extern int print_insn_mn10300 PARAMS ((bfd_vma, disassemble_info*));
811b15ef SC	139	extern int print_insn_ns32k PARAMS ((bfd_vma, disassemble_info*));
	140	extern int print_insn_big_powerpc PARAMS ((bfd_vma, disassemble_info*));
	141	extern int print_insn_little_powerpc PARAMS ((bfd_vma, disassemble_info*));
	142	extern int print_insn_rs6000 PARAMS ((bfd_vma, disassemble_info*));
66032a39	143	extern int print_insn_w65 PARAMS ((bfd_vma, disassemble_info*));
770e0827 MH	144	/* start-sanitize-d10v */
	145	extern int print_insn_d10v PARAMS ((bfd_vma, disassemble_info*));
	146	/* end-sanitize-d10v */
cad8350f JL	147	/* start-sanitize-v850 */
	148	extern int print_insn_v850 PARAMS ((bfd_vma, disassemble_info*));
	149	/* end-sanitize-v850 */
308a5981	150
811b15ef SC	151	/* Fetch the disassembler for a given BFD, if that support is available. */
811b15ef SC	152	extern disassembler_ftype disassembler PARAMS ((bfd *));
308a5981 JG	153
	154	\f
	155	/* This block of definitions is for particular callers who read instructions
	156	into a buffer before calling the instruction decoder. */
	157
5d0734a7 JK	158	/* Here is a function which callers may wish to use for read_memory_func.
	159	It gets bytes from a buffer. */
	160	extern int buffer_read_memory
	161	PARAMS ((bfd_vma, bfd_byte , int, struct disassemble_info ));
	162
	163	/* This function goes with buffer_read_memory.
	164	It prints a message using info->fprintf_func and info->stream. */
	165	extern void perror_memory PARAMS ((int, bfd_vma, struct disassemble_info *));
d7e1be46	166
308a5981	167
3e496fff	168	/* Just print the address in hex. This is included for completeness even
482d6747 ILT	169	though both GDB and objdump provide their own (to print symbolic
	170	addresses). */
	171	extern void generic_print_address
	172	PARAMS ((bfd_vma, struct disassemble_info *));
	173
16cf520e JL	174	/* Macro to initialize a disassemble_info struct. This should be called
16cf520e JL	175	by all applications creating such a struct. */
f29a36c0	176	#define INIT_DISASSEMBLE_INFO(INFO, STREAM, FPRINTF_FUNC) \
cad8350f	177	(INFO).flavour = bfd_target_unknown_flavour, \
a29322f7 SG	178	(INFO).arch = bfd_arch_unknown, \
	179	(INFO).mach = 0, \
	180	(INFO).endian = BFD_ENDIAN_UNKNOWN, \
	181	INIT_DISASSEMBLE_INFO_NO_ARCH(INFO, STREAM, FPRINTF_FUNC)
	182
	183	/* Call this macro to initialize only the internal variables for the
	184	disassembler. Architecture dependent things such as byte order, or machine
	185	variant are not touched by this macro. This makes things much easier for
	186	GDB which must initialize these things seperatly. */
	187
	188	#define INIT_DISASSEMBLE_INFO_NO_ARCH(INFO, STREAM, FPRINTF_FUNC) \
f29a36c0	189	(INFO).fprintf_func = (FPRINTF_FUNC), \
5d0734a7 JK	190	(INFO).stream = (STREAM), \
	191	(INFO).buffer = NULL, \
	192	(INFO).buffer_vma = 0, \
	193	(INFO).buffer_length = 0, \
	194	(INFO).read_memory_func = buffer_read_memory, \
482d6747	195	(INFO).memory_error_func = perror_memory, \
308a5981	196	(INFO).print_address_func = generic_print_address, \
3e496fff	197	(INFO).flags = 0, \
308a5981	198	(INFO).insn_info_valid = 0
dc7d3f0c ILT	199
dc7d3f0c ILT	200	#endif /* ! defined (DIS_ASM_H) */