| blob | 60bbc8d177bf0856157f4bcde3faf499af9d96a5 |
1 /* Interface between the opcode library and its callers.
3 Copyright (C) 1999-2016 Free Software Foundation, Inc.
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 3, or (at your option)
8 any later version.
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.
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., 51 Franklin Street - Fifth Floor,
18 Boston, MA 02110-1301, USA.
20 Written by Cygnus Support, 1993.
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. */
27 #ifndef DIS_ASM_H
28 #define DIS_ASM_H
30 #ifdef __cplusplus
32 #endif
34 #include <stdio.h>
39 enum dis_insn_type
40 {
48 dis_dref2 /* Two data references in instruction. */
49 };
51 /* This struct is passed into the instruction decoding routine,
52 and is passed back out into each callback. The various fields are used
53 for conveying information from your main routine into your callbacks,
54 for passing information into the instruction decoders (such as the
55 addresses of the callback functions), or for passing information
56 back from the instruction decoders to their callers.
58 It must be initialized before it is first passed; this can be done
59 by hand, or using one of the initialization macros below. */
62 {
63 fprintf_ftype fprintf_func;
67 /* Target description. We could replace this with a pointer to the bfd,
68 but that would require one. There currently isn't any such requirement
69 so to avoid introducing one we record these explicitly. */
70 /* The bfd_flavour. This can be bfd_target_unknown_flavour. */
72 /* The bfd_arch value. */
74 /* The bfd_mach value. */
76 /* Endianness (for bi-endian cpus). Mono-endian cpus can ignore this. */
78 /* Endianness of code, for mixed-endian situations such as ARM BE8. */
80 /* An arch/mach-specific bitmask of selected instruction subsets, mainly
81 for processors with run-time-switchable instruction sets. The default,
82 zero, means that there is no constraint. CGEN-based opcodes ports
83 may use ISA_foo masks. */
86 /* Some targets need information about the current section to accurately
87 display insns. If this is NULL, the target disassembler function
88 will have to make its best guess. */
91 /* An array of pointers to symbols either at the location being disassembled
92 or at the start of the function being disassembled. The array is sorted
93 so that the first symbol is intended to be the one used. The others are
94 present for any misc. purposes. This is not set reliably, but if it is
95 not NULL, it is correct. */
97 /* Number of symbols in array. */
100 /* Symbol table provided for targets that want to look at it. This is
101 used on Arm to find mapping symbols and determine Arm/Thumb code. */
106 /* For use by the disassembler.
107 The top 16 bits are reserved for public use (and are documented here).
108 The bottom 16 bits are for the internal use of the disassembler. */
110 /* Set if the disassembler has determined that there are one or more
111 relocations associated with the instruction being disassembled. */
112 #define INSN_HAS_RELOC (1 << 31)
113 /* Set if the user has requested the disassembly of data as well as code. */
114 #define DISASSEMBLE_DATA (1 << 30)
115 /* Set if the user has specifically set the machine type encoded in the
116 mach field of this structure. */
117 #define USER_SPECIFIED_MACHINE_TYPE (1 << 29)
119 /* Use internally by the target specific disassembly code. */
122 /* Function used to get bytes to disassemble. MEMADDR is the
123 address of the stuff to be disassembled, MYADDR is the address to
124 put the bytes in, and LENGTH is the number of bytes to read.
125 INFO is a pointer to this struct.
126 Returns an errno value or 0 for success. */
131 /* Function which should be called if we get an error that we can't
132 recover from. STATUS is the errno value from read_memory_func and
133 MEMADDR is the address that we were trying to read. INFO is a
134 pointer to this struct. */
138 /* Function called to print ADDR. */
142 /* Function called to determine if there is a symbol at the given ADDR.
143 If there is, the function returns 1, otherwise it returns 0.
144 This is used by ports which support an overlay manager where
145 the overlay number is held in the top part of an address. In
146 some circumstances we want to include the overlay number in the
147 address, (normally because there is a symbol associated with
148 that address), but sometimes we want to mask out the overlay bits. */
152 /* Function called to check if a SYMBOL is can be displayed to the user.
153 This is used by some ports that want to hide special symbols when
154 displaying debugging outout. */
158 /* These are for buffer_read_memory. */
160 bfd_vma buffer_vma;
163 /* This variable may be set by the instruction decoder. It suggests
164 the number of bytes objdump should display on a single line. If
165 the instruction decoder sets this, it should always set it to
166 the same value in order to get reasonable looking output. */
169 /* The next two variables control the way objdump displays the raw data. */
170 /* For example, if bytes_per_line is 8 and bytes_per_chunk is 4, the */
171 /* output will look like this:
172 00: 00000000 00000000
173 with the chunks displayed according to "display_endian". */
177 /* Number of octets per incremented target address
178 Normally one, but some DSPs have byte sizes of 16 or 32 bits. */
181 /* The number of zeroes we want to see at the end of a section before we
182 start skipping them. */
185 /* The number of zeroes to skip at the end of a section. If the number
186 of zeroes at the end is between SKIP_ZEROES_AT_END and SKIP_ZEROES,
187 they will be disassembled. If there are fewer than
188 SKIP_ZEROES_AT_END, they will be skipped. This is a heuristic
189 attempt to avoid disassembling zeroes inserted by section
190 alignment. */
193 /* Whether the disassembler always needs the relocations. */
194 bfd_boolean disassembler_needs_relocs;
196 /* Results from instruction decoders. Not all decoders yet support
197 this information. This info is set each time an instruction is
198 decoded, and is only valid for the last such instruction.
200 To determine whether this decoder supports this information, set
201 insn_info_valid to 0, decode an instruction, then check it. */
205 a branch takes effect. (0 = normal) */
209 zero if unknown. */
212 /* Command line options specific to the target disassembler. */
215 /* If non-zero then try not disassemble beyond this address, even if
216 there are values left in the buffer. This address is the address
217 of the nearest symbol forwards from the start of the disassembly,
218 and it is assumed that it lies on the boundary between instructions.
219 If an instruction spans this address then this is an error in the
220 file being disassembled. */
221 bfd_vma stop_vma;
225 \f
226 /* Standard disassemblers. Disassemble one instruction at the given
227 target address. Return number of octets processed. */
340 /* Fetch the disassembler for a given BFD, if that support is available. */
343 /* Amend the disassemble_info structure as necessary for the target architecture.
344 Should only be called after initialising the info->arch field. */
347 /* Document any target specific options available from the disassembler. */
350 \f
351 /* This block of definitions is for particular callers who read instructions
352 into a buffer before calling the instruction decoder. */
354 /* Here is a function which callers may wish to use for read_memory_func.
355 It gets bytes from a buffer. */
359 /* This function goes with buffer_read_memory.
360 It prints a message using info->fprintf_func and info->stream. */
364 /* Just print the address in hex. This is included for completeness even
365 though both GDB and objdump provide their own (to print symbolic
366 addresses). */
370 /* Always true. */
374 /* Also always true. */
375 extern bfd_boolean generic_symbol_is_valid
378 /* Method to initialize a disassemble_info struct. This should be
379 called by all applications creating such a struct. */
381 fprintf_ftype fprintf_func);
383 /* For compatibility with existing code. */
384 #define INIT_DISASSEMBLE_INFO(INFO, STREAM, FPRINTF_FUNC) \
385 init_disassemble_info (&(INFO), (STREAM), (fprintf_ftype) (FPRINTF_FUNC))
386 #define INIT_DISASSEMBLE_INFO_NO_ARCH(INFO, STREAM, FPRINTF_FUNC) \
387 init_disassemble_info (&(INFO), (STREAM), (fprintf_ftype) (FPRINTF_FUNC))
390 #ifdef __cplusplus
391 }
392 #endif