OpenCores
URL https://opencores.org/ocsvn/or1k_old/or1k_old/trunk

Subversion Repositories or1k_old

[/] [or1k_old/] [trunk/] [insight/] [include/] [dis-asm.h] - Blame information for rev 1782

Details | Compare with Previous | View Log

Line No. Rev Author Line
1 578 markom
/* Interface between the opcode library and its callers.
2
 
3
   Copyright 2001 Free Software Foundation, Inc.
4
 
5
   This program is free software; you can redistribute it and/or modify
6
   it under the terms of the GNU General Public License as published by
7
   the Free Software Foundation; either version 2, or (at your option)
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
17
   Foundation, Inc., 59 Temple Place - Suite 330,
18
   Boston, MA 02111-1307, USA.
19
 
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
 
30
#ifdef __cplusplus
31
extern "C" {
32
#endif
33
 
34
#include <stdio.h>
35
#include "bfd.h"
36
 
37
typedef int (*fprintf_ftype) PARAMS((PTR, const char*, ...));
38
 
39
enum dis_insn_type {
40
  dis_noninsn,                  /* Not a valid instruction */
41
  dis_nonbranch,                /* Not a branch instruction */
42
  dis_branch,                   /* Unconditional branch */
43
  dis_condbranch,               /* Conditional branch */
44
  dis_jsr,                      /* Jump to subroutine */
45
  dis_condjsr,                  /* Conditional jump to subroutine */
46
  dis_dref,                     /* Data reference instruction */
47
  dis_dref2                     /* Two data references in instruction */
48
};
49
 
50
/* This struct is passed into the instruction decoding routine,
51
   and is passed back out into each callback.  The various fields are used
52
   for conveying information from your main routine into your callbacks,
53
   for passing information into the instruction decoders (such as the
54
   addresses of the callback functions), or for passing information
55
   back from the instruction decoders to their callers.
56
 
57
   It must be initialized before it is first passed; this can be done
58
   by hand, or using one of the initialization macros below.  */
59
 
60
typedef struct disassemble_info {
61
  fprintf_ftype fprintf_func;
62
  PTR stream;
63
  PTR application_data;
64
 
65
  /* Target description.  We could replace this with a pointer to the bfd,
66
     but that would require one.  There currently isn't any such requirement
67
     so to avoid introducing one we record these explicitly.  */
68
  /* The bfd_flavour.  This can be bfd_target_unknown_flavour.  */
69
  enum bfd_flavour flavour;
70
  /* The bfd_arch value.  */
71
  enum bfd_architecture arch;
72
  /* The bfd_mach value.  */
73
  unsigned long mach;
74
  /* Endianness (for bi-endian cpus).  Mono-endian cpus can ignore this.  */
75
  enum bfd_endian endian;
76
 
77
  /* Some targets need information about the current section to accurately
78
     display insns.  If this is NULL, the target disassembler function
79
     will have to make its best guess.  */
80
  asection *section;
81
 
82
  /* An array of pointers to symbols either at the location being disassembled
83
     or at the start of the function being disassembled.  The array is sorted
84
     so that the first symbol is intended to be the one used.  The others are
85
     present for any misc. purposes.  This is not set reliably, but if it is
86
     not NULL, it is correct.  */
87
  asymbol **symbols;
88
  /* Number of symbols in array.  */
89
  int num_symbols;
90
 
91
  /* For use by the disassembler.
92
     The top 16 bits are reserved for public use (and are documented here).
93
     The bottom 16 bits are for the internal use of the disassembler.  */
94
  unsigned long flags;
95
#define INSN_HAS_RELOC  0x80000000
96
  PTR private_data;
97
 
98
  /* Function used to get bytes to disassemble.  MEMADDR is the
99
     address of the stuff to be disassembled, MYADDR is the address to
100
     put the bytes in, and LENGTH is the number of bytes to read.
101
     INFO is a pointer to this struct.
102
     Returns an errno value or 0 for success.  */
103
  int (*read_memory_func)
104
    PARAMS ((bfd_vma memaddr, bfd_byte *myaddr, unsigned int length,
105
             struct disassemble_info *info));
106
 
107
  /* Function which should be called if we get an error that we can't
108
     recover from.  STATUS is the errno value from read_memory_func and
109
     MEMADDR is the address that we were trying to read.  INFO is a
110
     pointer to this struct.  */
111
  void (*memory_error_func)
112
    PARAMS ((int status, bfd_vma memaddr, struct disassemble_info *info));
113
 
114
  /* Function called to print ADDR.  */
115
  void (*print_address_func)
116
    PARAMS ((bfd_vma addr, struct disassemble_info *info));
117
 
118
  /* Function called to determine if there is a symbol at the given ADDR.
119
     If there is, the function returns 1, otherwise it returns 0.
120
     This is used by ports which support an overlay manager where
121
     the overlay number is held in the top part of an address.  In
122
     some circumstances we want to include the overlay number in the
123
     address, (normally because there is a symbol associated with
124
     that address), but sometimes we want to mask out the overlay bits.  */
125
  int (* symbol_at_address_func)
126
    PARAMS ((bfd_vma addr, struct disassemble_info * info));
127
 
128
  /* These are for buffer_read_memory.  */
129
  bfd_byte *buffer;
130
  bfd_vma buffer_vma;
131
  unsigned int buffer_length;
132
 
133
  /* This variable may be set by the instruction decoder.  It suggests
134
      the number of bytes objdump should display on a single line.  If
135
      the instruction decoder sets this, it should always set it to
136
      the same value in order to get reasonable looking output.  */
137
  int bytes_per_line;
138
 
139
  /* the next two variables control the way objdump displays the raw data */
140
  /* For example, if bytes_per_line is 8 and bytes_per_chunk is 4, the */
141
  /* output will look like this:
142
     00:   00000000 00000000
143
     with the chunks displayed according to "display_endian". */
144
  int bytes_per_chunk;
145
  enum bfd_endian display_endian;
146
 
147
  /* Number of octets per incremented target address
148
     Normally one, but some DSPs have byte sizes of 16 or 32 bits
149
   */
150
  unsigned int octets_per_byte;
151
 
152
  /* Results from instruction decoders.  Not all decoders yet support
153
     this information.  This info is set each time an instruction is
154
     decoded, and is only valid for the last such instruction.
155
 
156
     To determine whether this decoder supports this information, set
157
     insn_info_valid to 0, decode an instruction, then check it.  */
158
 
159
  char insn_info_valid;         /* Branch info has been set. */
160
  char branch_delay_insns;      /* How many sequential insn's will run before
161
                                   a branch takes effect.  (0 = normal) */
162
  char data_size;               /* Size of data reference in insn, in bytes */
163
  enum dis_insn_type insn_type; /* Type of instruction */
164
  bfd_vma target;               /* Target address of branch or dref, if known;
165
                                   zero if unknown.  */
166
  bfd_vma target2;              /* Second target address for dref2 */
167
 
168
  /* Command line options specific to the target disassembler.  */
169
  char * disassembler_options;
170
 
171
} disassemble_info;
172
 
173
 
174
/* Standard disassemblers.  Disassemble one instruction at the given
175
   target address.  Return number of bytes processed.  */
176
typedef int (*disassembler_ftype)
177
     PARAMS((bfd_vma, disassemble_info *));
178
 
179
extern int print_insn_big_mips          PARAMS ((bfd_vma, disassemble_info*));
180
extern int print_insn_little_mips       PARAMS ((bfd_vma, disassemble_info*));
181
extern int print_insn_i386_att          PARAMS ((bfd_vma, disassemble_info*));
182
extern int print_insn_i386_intel        PARAMS ((bfd_vma, disassemble_info*));
183
extern int print_insn_ia64              PARAMS ((bfd_vma, disassemble_info*));
184
extern int print_insn_i370              PARAMS ((bfd_vma, disassemble_info*));
185
extern int print_insn_m68hc11           PARAMS ((bfd_vma, disassemble_info*));
186
extern int print_insn_m68hc12           PARAMS ((bfd_vma, disassemble_info*));
187
extern int print_insn_m68k              PARAMS ((bfd_vma, disassemble_info*));
188
extern int print_insn_z8001             PARAMS ((bfd_vma, disassemble_info*));
189
extern int print_insn_z8002             PARAMS ((bfd_vma, disassemble_info*));
190
extern int print_insn_h8300             PARAMS ((bfd_vma, disassemble_info*));
191
extern int print_insn_h8300h            PARAMS ((bfd_vma, disassemble_info*));
192
extern int print_insn_h8300s            PARAMS ((bfd_vma, disassemble_info*));
193
extern int print_insn_h8500             PARAMS ((bfd_vma, disassemble_info*));
194
extern int print_insn_alpha             PARAMS ((bfd_vma, disassemble_info*));
195
extern disassembler_ftype arc_get_disassembler PARAMS ((void *));
196
extern int print_insn_big_arm           PARAMS ((bfd_vma, disassemble_info*));
197
extern int print_insn_little_arm        PARAMS ((bfd_vma, disassemble_info*));
198
extern int print_insn_sparc             PARAMS ((bfd_vma, disassemble_info*));
199
extern int print_insn_big_a29k          PARAMS ((bfd_vma, disassemble_info*));
200
extern int print_insn_little_a29k       PARAMS ((bfd_vma, disassemble_info*));
201
extern int print_insn_i860              PARAMS ((bfd_vma, disassemble_info*));
202
extern int print_insn_i960              PARAMS ((bfd_vma, disassemble_info*));
203
extern int print_insn_sh                PARAMS ((bfd_vma, disassemble_info*));
204
extern int print_insn_shl               PARAMS ((bfd_vma, disassemble_info*));
205
extern int print_insn_hppa              PARAMS ((bfd_vma, disassemble_info*));
206
extern int print_insn_fr30              PARAMS ((bfd_vma, disassemble_info*));
207
extern int print_insn_m32r              PARAMS ((bfd_vma, disassemble_info*));
208
extern int print_insn_m88k              PARAMS ((bfd_vma, disassemble_info*));
209
extern int print_insn_mcore             PARAMS ((bfd_vma, disassemble_info*));
210
extern int print_insn_mn10200           PARAMS ((bfd_vma, disassemble_info*));
211
extern int print_insn_mn10300           PARAMS ((bfd_vma, disassemble_info*));
212
extern int print_insn_ns32k             PARAMS ((bfd_vma, disassemble_info*));
213
extern int print_insn_openrisc          PARAMS ((bfd_vma, disassemble_info*));
214
extern int print_insn_pdp11             PARAMS ((bfd_vma, disassemble_info*));
215
extern int print_insn_big_powerpc       PARAMS ((bfd_vma, disassemble_info*));
216
extern int print_insn_little_powerpc    PARAMS ((bfd_vma, disassemble_info*));
217
extern int print_insn_rs6000            PARAMS ((bfd_vma, disassemble_info*));
218
extern int print_insn_w65               PARAMS ((bfd_vma, disassemble_info*));
219
extern disassembler_ftype cris_get_disassembler PARAMS ((bfd *));
220
extern int print_insn_d10v              PARAMS ((bfd_vma, disassemble_info*));
221
extern int print_insn_d30v              PARAMS ((bfd_vma, disassemble_info*));
222
extern int print_insn_v850              PARAMS ((bfd_vma, disassemble_info*));
223
extern int print_insn_tic30             PARAMS ((bfd_vma, disassemble_info*));
224
extern int print_insn_vax               PARAMS ((bfd_vma, disassemble_info*));
225
extern int print_insn_tic54x            PARAMS ((bfd_vma, disassemble_info*));
226
extern int print_insn_tic80             PARAMS ((bfd_vma, disassemble_info*));
227
extern int print_insn_pj                PARAMS ((bfd_vma, disassemble_info*));
228
extern int print_insn_avr               PARAMS ((bfd_vma, disassemble_info*));
229
extern int print_insn_s390            PARAMS ((bfd_vma, disassemble_info*));
230
extern int print_insn_big_or1k          PARAMS ((bfd_vma, disassemble_info*));
231
extern int print_insn_little_or32       PARAMS ((bfd_vma, disassemble_info*));
232
extern int print_insn_big_or32          PARAMS ((bfd_vma, disassemble_info*));
233
 
234
extern void print_arm_disassembler_options PARAMS ((FILE *));
235
extern void parse_arm_disassembler_option  PARAMS ((char *));
236
extern int  get_arm_regname_num_options    PARAMS ((void));
237
extern int  set_arm_regname_option         PARAMS ((int));
238
extern int  get_arm_regnames               PARAMS ((int, const char **, const char **, const char ***));
239
 
240
/* Fetch the disassembler for a given BFD, if that support is available.  */
241
extern disassembler_ftype disassembler  PARAMS ((bfd *));
242
 
243
/* Document any target specific options available from the disassembler.  */
244
extern void disassembler_usage          PARAMS ((FILE *));
245
 
246
 
247
/* This block of definitions is for particular callers who read instructions
248
   into a buffer before calling the instruction decoder.  */
249
 
250
/* Here is a function which callers may wish to use for read_memory_func.
251
   It gets bytes from a buffer.  */
252
extern int buffer_read_memory
253
  PARAMS ((bfd_vma, bfd_byte *, unsigned int, struct disassemble_info *));
254
 
255
/* This function goes with buffer_read_memory.
256
   It prints a message using info->fprintf_func and info->stream.  */
257
extern void perror_memory PARAMS ((int, bfd_vma, struct disassemble_info *));
258
 
259
 
260
/* Just print the address in hex.  This is included for completeness even
261
   though both GDB and objdump provide their own (to print symbolic
262
   addresses).  */
263
extern void generic_print_address
264
  PARAMS ((bfd_vma, struct disassemble_info *));
265
 
266
/* Always true.  */
267
extern int generic_symbol_at_address
268
  PARAMS ((bfd_vma, struct disassemble_info *));
269
 
270
/* Macro to initialize a disassemble_info struct.  This should be called
271
   by all applications creating such a struct.  */
272
#define INIT_DISASSEMBLE_INFO(INFO, STREAM, FPRINTF_FUNC) \
273
  (INFO).flavour = bfd_target_unknown_flavour, \
274
  (INFO).arch = bfd_arch_unknown, \
275
  (INFO).mach = 0, \
276
  (INFO).endian = BFD_ENDIAN_UNKNOWN, \
277
  (INFO).octets_per_byte = 1, \
278
  INIT_DISASSEMBLE_INFO_NO_ARCH(INFO, STREAM, FPRINTF_FUNC)
279
 
280
/* Call this macro to initialize only the internal variables for the
281
   disassembler.  Architecture dependent things such as byte order, or machine
282
   variant are not touched by this macro.  This makes things much easier for
283
   GDB which must initialize these things separately.  */
284
 
285
#define INIT_DISASSEMBLE_INFO_NO_ARCH(INFO, STREAM, FPRINTF_FUNC) \
286
  (INFO).fprintf_func = (fprintf_ftype)(FPRINTF_FUNC), \
287
  (INFO).stream = (PTR)(STREAM), \
288
  (INFO).section = NULL, \
289
  (INFO).symbols = NULL, \
290
  (INFO).num_symbols = 0, \
291
  (INFO).private_data = NULL, \
292
  (INFO).buffer = NULL, \
293
  (INFO).buffer_vma = 0, \
294
  (INFO).buffer_length = 0, \
295
  (INFO).read_memory_func = buffer_read_memory, \
296
  (INFO).memory_error_func = perror_memory, \
297
  (INFO).print_address_func = generic_print_address, \
298
  (INFO).symbol_at_address_func = generic_symbol_at_address, \
299
  (INFO).flags = 0, \
300
  (INFO).bytes_per_line = 0, \
301
  (INFO).bytes_per_chunk = 0, \
302
  (INFO).display_endian = BFD_ENDIAN_UNKNOWN, \
303
  (INFO).insn_info_valid = 0
304
 
305
#ifdef __cplusplus
306
};
307
#endif
308
 
309
#endif /* ! defined (DIS_ASM_H) */

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.