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

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

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


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

  /* For use by the disassembler.  */
  int 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.  */

  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 */
  };
  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_h8500		PARAMS ((bfd_vma, disassemble_info*));
extern int print_insn_alpha		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_hppa		PARAMS ((bfd_vma, disassemble_info*));
extern int print_insn_m88k		PARAMS ((bfd_vma, disassemble_info*));


\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 is 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 *));

#define INIT_DISASSEMBLE_INFO(INFO, STREAM) \
  (INFO).fprintf_func = (fprintf_ftype)fprintf, \
  (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).insn_info_valid = 0


\f
/* This block of definitions is for calling the instruction decoders
   from GDB.  */

/* GDB--Like target_read_memory, but slightly different parameters.  */
extern int
dis_asm_read_memory PARAMS ((bfd_vma memaddr, bfd_byte *myaddr, int len,
			     disassemble_info *info));

/* GDB--Like memory_error with slightly different parameters.  */
extern void
dis_asm_memory_error
  PARAMS ((int status, bfd_vma memaddr, disassemble_info *info));

/* GDB--Like print_address with slightly different parameters.  */
extern void
dis_asm_print_address PARAMS ((bfd_vma addr, disassemble_info *info));

#define GDB_INIT_DISASSEMBLE_INFO(INFO, STREAM) \
  (INFO).fprintf_func = (fprintf_ftype)fprintf_filtered, \
  (INFO).stream = (STREAM), \
  (INFO).read_memory_func = dis_asm_read_memory, \
  (INFO).memory_error_func = dis_asm_memory_error, \
  (INFO).print_address_func = dis_asm_print_address, \
  (INFO).insn_info_valid = 0
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
d7e1be46	9	#include <stdio.h>
d7e1be46 PB	10	#include "bfd.h"
	11
	12	typedef int (fprintf_ftype) PARAMS((FILE, const char*, ...));
	13
308a5981 JG	14
	15	/* This struct is passed into the instruction decoding routine,
	16	and is passed back out into each callback. The various fields are used
	17	for conveying information from your main routine into your callbacks,
	18	for passing information into the instruction decoders (such as the
	19	addresses of the callback functions), or for passing information
	20	back from the instruction decoders to their callers.
	21
	22	It must be initialized before it is first passed; this can be done
	23	by hand, or using one of the initialization macros below. */
	24
d7e1be46 PB	25	typedef struct disassemble_info {
	26	fprintf_ftype fprintf_func;
	27	FILE *stream;
308a5981	28	PTR application_data;
5d0734a7 JK	29
5d0734a7 JK	30	/* For use by the disassembler. */
d7e1be46	31	int flags;
5d0734a7 JK	32	PTR private_data;
	33
	34	/* Function used to get bytes to disassemble. MEMADDR is the
	35	address of the stuff to be disassembled, MYADDR is the address to
	36	put the bytes in, and LENGTH is the number of bytes to read.
	37	INFO is a pointer to this struct.
	38	Returns an errno value or 0 for success. */
	39	int (*read_memory_func)
	40	PARAMS ((bfd_vma memaddr, bfd_byte *myaddr, int length,
	41	struct disassemble_info *info));
	42
	43	/* Function which should be called if we get an error that we can't
	44	recover from. STATUS is the errno value from read_memory_func and
	45	MEMADDR is the address that we were trying to read. INFO is a
	46	pointer to this struct. */
	47	void (*memory_error_func)
	48	PARAMS ((int status, bfd_vma memaddr, struct disassemble_info *info));
	49
482d6747 ILT	50	/* Function called to print ADDR. */
	51	void (*print_address_func)
	52	PARAMS ((bfd_vma addr, struct disassemble_info *info));
	53
5d0734a7 JK	54	/* These are for buffer_read_memory. */
	55	bfd_byte *buffer;
	56	bfd_vma buffer_vma;
	57	int buffer_length;
308a5981 JG	58
	59	/* Results from instruction decoders. Not all decoders yet support
	60	this information. This info is set each time an instruction is
	61	decoded, and is only valid for the last such instruction.
	62
	63	To determine whether this decoder supports this information, set
	64	insn_info_valid to 0, decode an instruction, then check it. */
	65
	66	enum dis_insn_type {
	67	dis_noninsn, /* Not a valid instruction */
	68	dis_nonbranch, /* Not a branch instruction */
	69	dis_branch, /* Unconditional branch */
	70	dis_condbranch, /* Conditional branch */
	71	dis_jsr, /* Jump to subroutine */
	72	dis_condjsr, /* Conditional jump to subroutine */
	73	dis_dref, /* Data reference instruction */
	74	dis_dref2, /* Two data references in instruction */
	75	};
	76	char insn_info_valid; /* Branch info has been set. */
	77	char branch_delay_insns; /* How many sequential insn's will run before
	78	a branch takes effect. (0 = normal) */
	79	char data_size; /* Size of data reference in insn, in bytes */
	80	enum dis_insn_type insn_type; /* Type of instruction */
	81	bfd_vma target; /* Target address of branch or dref, if known;
	82	zero if unknown. */
	83	bfd_vma target2; /* Second target address for dref2 */
	84
d7e1be46 PB	85	} disassemble_info;
d7e1be46 PB	86
308a5981 JG	87
	88
	89
	90
	91	\f
	92	/* Standard disassemblers. Disassemble one instruction at the given
	93	target address. Return number of bytes processed. */
	94	typedef int (*disassembler_ftype)
	95	PARAMS((bfd_vma, disassemble_info *));
	96
	97	extern int print_insn_big_mips PARAMS ((bfd_vma, disassemble_info*));
	98	extern int print_insn_little_mips PARAMS ((bfd_vma, disassemble_info*));
	99	extern int print_insn_i386 PARAMS ((bfd_vma, disassemble_info*));
	100	extern int print_insn_m68k PARAMS ((bfd_vma, disassemble_info*));
	101	extern int print_insn_z8001 PARAMS ((bfd_vma, disassemble_info*));
	102	extern int print_insn_z8002 PARAMS ((bfd_vma, disassemble_info*));
	103	extern int print_insn_h8300 PARAMS ((bfd_vma, disassemble_info*));
	104	extern int print_insn_h8300h PARAMS ((bfd_vma, disassemble_info*));
	105	extern int print_insn_h8500 PARAMS ((bfd_vma, disassemble_info*));
	106	extern int print_insn_alpha PARAMS ((bfd_vma, disassemble_info*));
	107	extern int print_insn_sparc PARAMS ((bfd_vma, disassemble_info*));
	108	extern int print_insn_big_a29k PARAMS ((bfd_vma, disassemble_info*));
	109	extern int print_insn_little_a29k PARAMS ((bfd_vma, disassemble_info*));
	110	extern int print_insn_i960 PARAMS ((bfd_vma, disassemble_info*));
	111	extern int print_insn_sh PARAMS ((bfd_vma, disassemble_info*));
	112	extern int print_insn_hppa PARAMS ((bfd_vma, disassemble_info*));
	113	extern int print_insn_m88k PARAMS ((bfd_vma, disassemble_info*));
	114
	115
	116
	117
	118
	119	\f
	120	/* This block of definitions is for particular callers who read instructions
	121	into a buffer before calling the instruction decoder. */
	122
5d0734a7 JK	123	/* Here is a function which callers may wish to use for read_memory_func.
	124	It gets bytes from a buffer. */
	125	extern int buffer_read_memory
	126	PARAMS ((bfd_vma, bfd_byte , int, struct disassemble_info ));
	127
	128	/* This function goes with buffer_read_memory.
	129	It prints a message using info->fprintf_func and info->stream. */
	130	extern void perror_memory PARAMS ((int, bfd_vma, struct disassemble_info *));
d7e1be46	131
308a5981	132
482d6747 ILT	133	/* Just print the address is hex. This is included for completeness even
	134	though both GDB and objdump provide their own (to print symbolic
	135	addresses). */
	136	extern void generic_print_address
	137	PARAMS ((bfd_vma, struct disassemble_info *));
	138
d7e1be46	139	#define INIT_DISASSEMBLE_INFO(INFO, STREAM) \
5d0734a7 JK	140	(INFO).fprintf_func = (fprintf_ftype)fprintf, \
	141	(INFO).stream = (STREAM), \
	142	(INFO).buffer = NULL, \
	143	(INFO).buffer_vma = 0, \
	144	(INFO).buffer_length = 0, \
	145	(INFO).read_memory_func = buffer_read_memory, \
482d6747	146	(INFO).memory_error_func = perror_memory, \
308a5981 JG	147	(INFO).print_address_func = generic_print_address, \
	148	(INFO).insn_info_valid = 0
	149
	150
	151
	152	\f
	153	/* This block of definitions is for calling the instruction decoders
	154	from GDB. */
5d0734a7 JK	155
	156	/* GDB--Like target_read_memory, but slightly different parameters. */
	157	extern int
a6cead71 JK	158	dis_asm_read_memory PARAMS ((bfd_vma memaddr, bfd_byte *myaddr, int len,
a6cead71 JK	159	disassemble_info *info));
5d0734a7 JK	160
	161	/* GDB--Like memory_error with slightly different parameters. */
	162	extern void
	163	dis_asm_memory_error
5128f892	164	PARAMS ((int status, bfd_vma memaddr, disassemble_info *info));
d7e1be46	165
482d6747 ILT	166	/* GDB--Like print_address with slightly different parameters. */
	167	extern void
	168	dis_asm_print_address PARAMS ((bfd_vma addr, disassemble_info *info));
	169
d7e1be46	170	#define GDB_INIT_DISASSEMBLE_INFO(INFO, STREAM) \
5d0734a7 JK	171	(INFO).fprintf_func = (fprintf_ftype)fprintf_filtered, \
	172	(INFO).stream = (STREAM), \
	173	(INFO).read_memory_func = dis_asm_read_memory, \
482d6747	174	(INFO).memory_error_func = dis_asm_memory_error, \
308a5981 JG	175	(INFO).print_address_func = dis_asm_print_address, \
308a5981 JG	176	(INFO).insn_info_valid = 0