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

Subversion Repositories socgen

[/] [socgen/] [trunk/] [tools/] [utils/] [or32-idecode/] [dis-asm.h] - Blame information for rev 123

Go to most recent revision | Details | Compare with Previous | View Log

Line No. Rev Author Line
1 101 jt_eaton
/* Interface between the opcode library and its callers.
2
 
3
   Copyright 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006
4
   Free Software Foundation, Inc.
5
 
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
18
   Foundation, Inc., 51 Franklin Street - Fifth Floor,
19
   Boston, MA 02110-1301, USA.
20
 
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
 
31
#ifdef __cplusplus
32
extern "C" {
33
#endif
34
 
35
#include <stdio.h>
36
#include "bfd.h"
37
 
38
  typedef int (*fprintf_ftype) (void *, const char*, ...) /*ATTRIBUTE_FPTR_PRINTF_2*/;
39
 
40
enum dis_insn_type
41
{
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
 
52
/* This struct is passed into the instruction decoding routine,
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
 
62
typedef struct disassemble_info
63
{
64
  fprintf_ftype fprintf_func;
65
  void *stream;
66
  void *application_data;
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;
79
  /* An arch/mach-specific bitmask of selected instruction subsets, mainly
80
     for processors with run-time-switchable instruction sets.  The default,
81
     zero, means that there is no constraint.  CGEN-based opcodes ports
82
     may use ISA_foo masks.  */
83
  void *insn_sets;
84
 
85
  /* Some targets need information about the current section to accurately
86
     display insns.  If this is NULL, the target disassembler function
87
     will have to make its best guess.  */
88
  asection *section;
89
 
90
  /* An array of pointers to symbols either at the location being disassembled
91
     or at the start of the function being disassembled.  The array is sorted
92
     so that the first symbol is intended to be the one used.  The others are
93
     present for any misc. purposes.  This is not set reliably, but if it is
94
     not NULL, it is correct.  */
95
  asymbol **symbols;
96
  /* Number of symbols in array.  */
97
  int num_symbols;
98
 
99
  /* Symbol table provided for targets that want to look at it.  This is
100
     used on Arm to find mapping symbols and determine Arm/Thumb code.  */
101
  asymbol **symtab;
102
  int symtab_pos;
103
  int symtab_size;
104
 
105
  /* For use by the disassembler.
106
     The top 16 bits are reserved for public use (and are documented here).
107
     The bottom 16 bits are for the internal use of the disassembler.  */
108
  unsigned long flags;
109
#define INSN_HAS_RELOC  0x80000000
110
  void *private_data;
111
 
112
  /* Function used to get bytes to disassemble.  MEMADDR is the
113
     address of the stuff to be disassembled, MYADDR is the address to
114
     put the bytes in, and LENGTH is the number of bytes to read.
115
     INFO is a pointer to this struct.
116
     Returns an errno value or 0 for success.  */
117
  int (*read_memory_func)
118
    (bfd_vma memaddr, bfd_byte *myaddr, unsigned int length,
119
     struct disassemble_info *info);
120
 
121
  /* Function which should be called if we get an error that we can't
122
     recover from.  STATUS is the errno value from read_memory_func and
123
     MEMADDR is the address that we were trying to read.  INFO is a
124
     pointer to this struct.  */
125
  void (*memory_error_func)
126
    (int status, bfd_vma memaddr, struct disassemble_info *info);
127
 
128
  /* Function called to print ADDR.  */
129
  void (*print_address_func)
130
    (bfd_vma addr, struct disassemble_info *info);
131
 
132
  /* Function called to determine if there is a symbol at the given ADDR.
133
     If there is, the function returns 1, otherwise it returns 0.
134
     This is used by ports which support an overlay manager where
135
     the overlay number is held in the top part of an address.  In
136
     some circumstances we want to include the overlay number in the
137
     address, (normally because there is a symbol associated with
138
     that address), but sometimes we want to mask out the overlay bits.  */
139
  int (* symbol_at_address_func)
140
    (bfd_vma addr, struct disassemble_info * info);
141
 
142
  /* Function called to check if a SYMBOL is can be displayed to the user.
143
     This is used by some ports that want to hide special symbols when
144
     displaying debugging outout.  */
145
  bfd_boolean (* symbol_is_valid)
146
    (asymbol *, struct disassemble_info * info);
147
 
148
  /* These are for buffer_read_memory.  */
149
  bfd_byte *buffer;
150
  bfd_vma buffer_vma;
151
  unsigned int buffer_length;
152
 
153
  /* This variable may be set by the instruction decoder.  It suggests
154
      the number of bytes objdump should display on a single line.  If
155
      the instruction decoder sets this, it should always set it to
156
      the same value in order to get reasonable looking output.  */
157
  int bytes_per_line;
158
 
159
  /* The next two variables control the way objdump displays the raw data.  */
160
  /* For example, if bytes_per_line is 8 and bytes_per_chunk is 4, the */
161
  /* output will look like this:
162
     00:   00000000 00000000
163
     with the chunks displayed according to "display_endian". */
164
  int bytes_per_chunk;
165
  enum bfd_endian display_endian;
166
 
167
  /* Number of octets per incremented target address
168
     Normally one, but some DSPs have byte sizes of 16 or 32 bits.  */
169
  unsigned int octets_per_byte;
170
 
171
  /* The number of zeroes we want to see at the end of a section before we
172
     start skipping them.  */
173
  unsigned int skip_zeroes;
174
 
175
  /* The number of zeroes to skip at the end of a section.  If the number
176
     of zeroes at the end is between SKIP_ZEROES_AT_END and SKIP_ZEROES,
177
     they will be disassembled.  If there are fewer than
178
     SKIP_ZEROES_AT_END, they will be skipped.  This is a heuristic
179
     attempt to avoid disassembling zeroes inserted by section
180
     alignment.  */
181
  unsigned int skip_zeroes_at_end;
182
 
183
  /* Whether the disassembler always needs the relocations.  */
184
  bfd_boolean disassembler_needs_relocs;
185
 
186
  /* Results from instruction decoders.  Not all decoders yet support
187
     this information.  This info is set each time an instruction is
188
     decoded, and is only valid for the last such instruction.
189
 
190
     To determine whether this decoder supports this information, set
191
     insn_info_valid to 0, decode an instruction, then check it.  */
192
 
193
  char insn_info_valid;         /* Branch info has been set. */
194
  char branch_delay_insns;      /* How many sequential insn's will run before
195
                                   a branch takes effect.  (0 = normal) */
196
  char data_size;               /* Size of data reference in insn, in bytes */
197
  enum dis_insn_type insn_type; /* Type of instruction */
198
  bfd_vma target;               /* Target address of branch or dref, if known;
199
                                   zero if unknown.  */
200
  bfd_vma target2;              /* Second target address for dref2 */
201
 
202
  /* Command line options specific to the target disassembler.  */
203
  char * disassembler_options;
204
 
205
} disassemble_info;
206
 
207
 
208
/* Standard disassemblers.  Disassemble one instruction at the given
209
   target address.  Return number of octets processed.  */
210
typedef int (*disassembler_ftype) (bfd_vma, disassemble_info *);
211
 
212
extern int print_insn_alpha             (bfd_vma, disassemble_info *);
213
extern int print_insn_avr               (bfd_vma, disassemble_info *);
214
extern int print_insn_bfin              (bfd_vma, disassemble_info *);
215
extern int print_insn_big_arm           (bfd_vma, disassemble_info *);
216
extern int print_insn_big_mips          (bfd_vma, disassemble_info *);
217
extern int print_insn_big_or32          (bfd_vma, disassemble_info *);
218
extern int print_insn_big_powerpc       (bfd_vma, disassemble_info *);
219
extern int print_insn_big_score         (bfd_vma, disassemble_info *);
220
extern int print_insn_cr16              (bfd_vma, disassemble_info *);
221
extern int print_insn_crx               (bfd_vma, disassemble_info *);
222
extern int print_insn_d10v              (bfd_vma, disassemble_info *);
223
extern int print_insn_d30v              (bfd_vma, disassemble_info *);
224
extern int print_insn_dlx               (bfd_vma, disassemble_info *);
225
extern int print_insn_fr30              (bfd_vma, disassemble_info *);
226
extern int print_insn_frv               (bfd_vma, disassemble_info *);
227
extern int print_insn_h8300             (bfd_vma, disassemble_info *);
228
extern int print_insn_h8300h            (bfd_vma, disassemble_info *);
229
extern int print_insn_h8300s            (bfd_vma, disassemble_info *);
230
extern int print_insn_h8500             (bfd_vma, disassemble_info *);
231
extern int print_insn_hppa              (bfd_vma, disassemble_info *);
232
extern int print_insn_i370              (bfd_vma, disassemble_info *);
233
extern int print_insn_i386              (bfd_vma, disassemble_info *);
234
extern int print_insn_i386_att          (bfd_vma, disassemble_info *);
235
extern int print_insn_i386_intel        (bfd_vma, disassemble_info *);
236
extern int print_insn_i860              (bfd_vma, disassemble_info *);
237
extern int print_insn_i960              (bfd_vma, disassemble_info *);
238
extern int print_insn_ia64              (bfd_vma, disassemble_info *);
239
extern int print_insn_ip2k              (bfd_vma, disassemble_info *);
240
extern int print_insn_iq2000            (bfd_vma, disassemble_info *);
241
extern int print_insn_little_arm        (bfd_vma, disassemble_info *);
242
extern int print_insn_little_mips       (bfd_vma, disassemble_info *);
243
extern int print_insn_little_or32       (bfd_vma, disassemble_info *);
244
extern int print_insn_little_powerpc    (bfd_vma, disassemble_info *);
245
extern int print_insn_little_score      (bfd_vma, disassemble_info *);
246
extern int print_insn_m32c              (bfd_vma, disassemble_info *);
247
extern int print_insn_m32r              (bfd_vma, disassemble_info *);
248
extern int print_insn_m68hc11           (bfd_vma, disassemble_info *);
249
extern int print_insn_m68hc12           (bfd_vma, disassemble_info *);
250
extern int print_insn_m68k              (bfd_vma, disassemble_info *);
251
extern int print_insn_m88k              (bfd_vma, disassemble_info *);
252
extern int print_insn_maxq_big          (bfd_vma, disassemble_info *);
253
extern int print_insn_maxq_little       (bfd_vma, disassemble_info *);
254
extern int print_insn_mcore             (bfd_vma, disassemble_info *);
255
extern int print_insn_mep               (bfd_vma, disassemble_info *);
256
extern int print_insn_mmix              (bfd_vma, disassemble_info *);
257
extern int print_insn_mn10200           (bfd_vma, disassemble_info *);
258
extern int print_insn_mn10300           (bfd_vma, disassemble_info *);
259
extern int print_insn_msp430            (bfd_vma, disassemble_info *);
260
extern int print_insn_mt                (bfd_vma, disassemble_info *);
261
extern int print_insn_ns32k             (bfd_vma, disassemble_info *);
262
extern int print_insn_openrisc          (bfd_vma, disassemble_info *);
263
extern int print_insn_pdp11             (bfd_vma, disassemble_info *);
264
extern int print_insn_pj                (bfd_vma, disassemble_info *);
265
extern int print_insn_rs6000            (bfd_vma, disassemble_info *);
266
extern int print_insn_s390              (bfd_vma, disassemble_info *);
267
extern int print_insn_sh                (bfd_vma, disassemble_info *);
268
extern int print_insn_sh64              (bfd_vma, disassemble_info *);
269
extern int print_insn_sh64x_media       (bfd_vma, disassemble_info *);
270
extern int print_insn_sparc             (bfd_vma, disassemble_info *);
271
extern int print_insn_spu               (bfd_vma, disassemble_info *);
272
extern int print_insn_tic30             (bfd_vma, disassemble_info *);
273
extern int print_insn_tic4x             (bfd_vma, disassemble_info *);
274
extern int print_insn_tic54x            (bfd_vma, disassemble_info *);
275
extern int print_insn_tic80             (bfd_vma, disassemble_info *);
276
extern int print_insn_v850              (bfd_vma, disassemble_info *);
277
extern int print_insn_vax               (bfd_vma, disassemble_info *);
278
extern int print_insn_w65               (bfd_vma, disassemble_info *);
279
extern int print_insn_xc16x             (bfd_vma, disassemble_info *);
280
extern int print_insn_xstormy16         (bfd_vma, disassemble_info *);
281
extern int print_insn_xtensa            (bfd_vma, disassemble_info *);
282
extern int print_insn_z80               (bfd_vma, disassemble_info *);
283
extern int print_insn_z8001             (bfd_vma, disassemble_info *);
284
extern int print_insn_z8002             (bfd_vma, disassemble_info *);
285
 
286
extern disassembler_ftype arc_get_disassembler (void *);
287
extern disassembler_ftype cris_get_disassembler (bfd *);
288
 
289
extern void print_i386_disassembler_options (FILE *);
290
extern void print_mips_disassembler_options (FILE *);
291
extern void print_ppc_disassembler_options (FILE *);
292
extern void print_arm_disassembler_options (FILE *);
293
extern void parse_arm_disassembler_option (char *);
294
extern void print_s390_disassembler_options (FILE *);
295
extern int  get_arm_regname_num_options (void);
296
extern int  set_arm_regname_option (int);
297
extern int  get_arm_regnames (int, const char **, const char **, const char *const **);
298
extern bfd_boolean arm_symbol_is_valid (asymbol *, struct disassemble_info *);
299
 
300
/* Fetch the disassembler for a given BFD, if that support is available.  */
301
extern disassembler_ftype disassembler (bfd *);
302
 
303
/* Amend the disassemble_info structure as necessary for the target architecture.
304
   Should only be called after initialising the info->arch field.  */
305
extern void disassemble_init_for_target (struct disassemble_info * info);
306
 
307
/* Document any target specific options available from the disassembler.  */
308
extern void disassembler_usage (FILE *);
309
 
310
 
311
/* This block of definitions is for particular callers who read instructions
312
   into a buffer before calling the instruction decoder.  */
313
 
314
/* Here is a function which callers may wish to use for read_memory_func.
315
   It gets bytes from a buffer.  */
316
extern int buffer_read_memory
317
  (bfd_vma, bfd_byte *, unsigned int, struct disassemble_info *);
318
 
319
/* This function goes with buffer_read_memory.
320
   It prints a message using info->fprintf_func and info->stream.  */
321
extern void perror_memory (int, bfd_vma, struct disassemble_info *);
322
 
323
 
324
/* Just print the address in hex.  This is included for completeness even
325
   though both GDB and objdump provide their own (to print symbolic
326
   addresses).  */
327
extern void generic_print_address
328
  (bfd_vma, struct disassemble_info *);
329
 
330
/* Always true.  */
331
extern int generic_symbol_at_address
332
  (bfd_vma, struct disassemble_info *);
333
 
334
/* Also always true.  */
335
extern bfd_boolean generic_symbol_is_valid
336
  (asymbol *, struct disassemble_info *);
337
 
338
/* Method to initialize a disassemble_info struct.  This should be
339
   called by all applications creating such a struct.  */
340
extern void init_disassemble_info (struct disassemble_info *info, void *stream,
341
                                   fprintf_ftype fprintf_func);
342
 
343
/* For compatibility with existing code.  */
344
#define INIT_DISASSEMBLE_INFO(INFO, STREAM, FPRINTF_FUNC) \
345
  init_disassemble_info (&(INFO), (STREAM), (fprintf_ftype) (FPRINTF_FUNC))
346
#define INIT_DISASSEMBLE_INFO_NO_ARCH(INFO, STREAM, FPRINTF_FUNC) \
347
  init_disassemble_info (&(INFO), (STREAM), (fprintf_ftype) (FPRINTF_FUNC))
348
 
349
 
350
#ifdef __cplusplus
351
}
352
#endif
353
 
354
#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.