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