include/dis-asm.h

   1 /* Interface between the opcode library and its callers.
   2
   3    Copyright (C) 1999-2021 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 3, 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., 51 Franklin Street - Fifth Floor,
  18    Boston, MA 02110-1301, 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 <string.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   /* Endianness of code, for mixed-endian situations such as ARM BE8.  */
  80   enum bfd_endian endian_code;
  81
  82   /* Some targets need information about the current section to accurately
  83      display insns.  If this is NULL, the target disassembler function
  84      will have to make its best guess.  */
  85   asection *section;
  86
  87   /* An array of pointers to symbols either at the location being disassembled
  88      or at the start of the function being disassembled.  The array is sorted
  89      so that the first symbol is intended to be the one used.  The others are
  90      present for any misc. purposes.  This is not set reliably, but if it is
  91      not NULL, it is correct.  */
  92   asymbol **symbols;
  93   /* Number of symbols in array.  */
  94   int num_symbols;
  95
  96   /* Symbol table provided for targets that want to look at it.  This is
  97      used on Arm to find mapping symbols and determine Arm/Thumb code.  */
  98   asymbol **symtab;
  99   int symtab_pos;
 100   int symtab_size;
 101
 102   /* For use by the disassembler.
 103      The top 16 bits are reserved for public use (and are documented here).
 104      The bottom 16 bits are for the internal use of the disassembler.  */
 105   unsigned long flags;
 106   /* Set if the disassembler has determined that there are one or more
 107      relocations associated with the instruction being disassembled.  */
 108 #define INSN_HAS_RELOC   (1u << 31)
 109   /* Set if the user has requested the disassembly of data as well as code.  */
 110 #define DISASSEMBLE_DATA (1u << 30)
 111   /* Set if the user has specifically set the machine type encoded in the
 112      mach field of this structure.  */
 113 #define USER_SPECIFIED_MACHINE_TYPE (1u << 29)
 114   /* Set if the user has requested wide output.  */
 115 #define WIDE_OUTPUT (1u << 28)
 116
 117   /* Dynamic relocations, if they have been loaded.  */
 118   arelent **dynrelbuf;
 119   long dynrelcount;
 120
 121   /* Use internally by the target specific disassembly code.  */
 122   void *private_data;
 123
 124   /* Function used to get bytes to disassemble.  MEMADDR is the
 125      address of the stuff to be disassembled, MYADDR is the address to
 126      put the bytes in, and LENGTH is the number of bytes to read.
 127      INFO is a pointer to this struct.
 128      Returns an errno value or 0 for success.  */
 129   int (*read_memory_func)
 130     (bfd_vma memaddr, bfd_byte *myaddr, unsigned int length,
 131      struct disassemble_info *dinfo);
 132
 133   /* Function which should be called if we get an error that we can't
 134      recover from.  STATUS is the errno value from read_memory_func and
 135      MEMADDR is the address that we were trying to read.  INFO is a
 136      pointer to this struct.  */
 137   void (*memory_error_func)
 138     (int status, bfd_vma memaddr, struct disassemble_info *dinfo);
 139
 140   /* Function called to print ADDR.  */
 141   void (*print_address_func)
 142     (bfd_vma addr, struct disassemble_info *dinfo);
 143
 144   /* Function called to determine if there is a symbol at the given ADDR.
 145      If there is, the function returns 1, otherwise it returns 0.
 146      This is used by ports which support an overlay manager where
 147      the overlay number is held in the top part of an address.  In
 148      some circumstances we want to include the overlay number in the
 149      address, (normally because there is a symbol associated with
 150      that address), but sometimes we want to mask out the overlay bits.  */
 151   asymbol * (*symbol_at_address_func)
 152     (bfd_vma addr, struct disassemble_info *dinfo);
 153
 154   /* Function called to check if a SYMBOL is can be displayed to the user.
 155      This is used by some ports that want to hide special symbols when
 156      displaying debugging outout.  */
 157   bool (*symbol_is_valid)
 158     (asymbol *, struct disassemble_info *dinfo);
 159
 160   /* These are for buffer_read_memory.  */
 161   bfd_byte *buffer;
 162   bfd_vma buffer_vma;
 163   size_t buffer_length;
 164
 165   /* This variable may be set by the instruction decoder.  It suggests
 166       the number of bytes objdump should display on a single line.  If
 167       the instruction decoder sets this, it should always set it to
 168       the same value in order to get reasonable looking output.  */
 169   int bytes_per_line;
 170
 171   /* The next two variables control the way objdump displays the raw data.  */
 172   /* For example, if bytes_per_line is 8 and bytes_per_chunk is 4, the */
 173   /* output will look like this:
 174      00:   00000000 00000000
 175      with the chunks displayed according to "display_endian". */
 176   int bytes_per_chunk;
 177   enum bfd_endian display_endian;
 178
 179   /* Number of octets per incremented target address
 180      Normally one, but some DSPs have byte sizes of 16 or 32 bits.  */
 181   unsigned int octets_per_byte;
 182
 183   /* The number of zeroes we want to see at the end of a section before we
 184      start skipping them.  */
 185   unsigned int skip_zeroes;
 186
 187   /* The number of zeroes to skip at the end of a section.  If the number
 188      of zeroes at the end is between SKIP_ZEROES_AT_END and SKIP_ZEROES,
 189      they will be disassembled.  If there are fewer than
 190      SKIP_ZEROES_AT_END, they will be skipped.  This is a heuristic
 191      attempt to avoid disassembling zeroes inserted by section
 192      alignment.  */
 193   unsigned int skip_zeroes_at_end;
 194
 195   /* Whether the disassembler always needs the relocations.  */
 196   bool disassembler_needs_relocs;
 197
 198   /* Results from instruction decoders.  Not all decoders yet support
 199      this information.  This info is set each time an instruction is
 200      decoded, and is only valid for the last such instruction.
 201
 202      To determine whether this decoder supports this information, set
 203      insn_info_valid to 0, decode an instruction, then check it.  */
 204
 205   char insn_info_valid;         /* Branch info has been set. */
 206   char branch_delay_insns;      /* How many sequential insn's will run before
 207                                    a branch takes effect.  (0 = normal) */
 208   char data_size;               /* Size of data reference in insn, in bytes */
 209   enum dis_insn_type insn_type; /* Type of instruction */
 210   bfd_vma target;               /* Target address of branch or dref, if known;
 211                                    zero if unknown.  */
 212   bfd_vma target2;              /* Second target address for dref2 */
 213
 214   /* Command line options specific to the target disassembler.  */
 215   const char *disassembler_options;
 216
 217   /* If non-zero then try not disassemble beyond this address, even if
 218      there are values left in the buffer.  This address is the address
 219      of the nearest symbol forwards from the start of the disassembly,
 220      and it is assumed that it lies on the boundary between instructions.
 221      If an instruction spans this address then this is an error in the
 222      file being disassembled.  */
 223   bfd_vma stop_vma;
 224
 225   /* The end range of the current range being disassembled.  This is required
 226      in order to notify the disassembler when it's currently handling a
 227      different range than it was before.  This prevent unsafe optimizations when
 228      disassembling such as the way mapping symbols are found on AArch64.  */
 229   bfd_vma stop_offset;
 230
 231 } disassemble_info;
 232
 233 /* This struct is used to pass information about valid disassembler
 234    option arguments from the target to the generic GDB functions
 235    that set and display them.  */
 236
 237 typedef struct
 238 {
 239   /* Option argument name to use in descriptions.  */
 240   const char *name;
 241
 242   /* Vector of acceptable option argument values, NULL-terminated.  */
 243   const char **values;
 244 } disasm_option_arg_t;
 245
 246 /* This struct is used to pass information about valid disassembler
 247    options, their descriptions and arguments from the target to the
 248    generic GDB functions that set and display them.  Options are
 249    defined by tuples of vector entries at each index.  */
 250
 251 typedef struct
 252 {
 253   /* Vector of option names, NULL-terminated.  */
 254   const char **name;
 255
 256   /* Vector of option descriptions or NULL if none to be shown.  */
 257   const char **description;
 258
 259   /* Vector of option argument information pointers or NULL if no
 260      option accepts an argument.  NULL entries denote individual
 261      options that accept no argument.  */
 262   const disasm_option_arg_t **arg;
 263 } disasm_options_t;
 264
 265 /* This struct is used to pass information about valid disassembler
 266    options and arguments from the target to the generic GDB functions
 267    that set and display them.  */
 268
 269 typedef struct
 270 {
 271   /* Valid disassembler options.  Individual options that support
 272      an argument will refer to entries in the ARGS vector.  */
 273   disasm_options_t options;
 274
 275   /* Vector of acceptable option arguments, NULL-terminated.  This
 276      collects all possible option argument choices, some of which
 277      may be shared by different options from the OPTIONS member.  */
 278   disasm_option_arg_t *args;
 279 } disasm_options_and_args_t;
 280 \f
 281 /* Standard disassemblers.  Disassemble one instruction at the given
 282    target address.  Return number of octets processed.  */
 283 typedef int (*disassembler_ftype) (bfd_vma, disassemble_info *);
 284
 285 /* Disassemblers used out side of opcodes library.  */
 286 extern int print_insn_m32c              (bfd_vma, disassemble_info *);
 287 extern int print_insn_mep               (bfd_vma, disassemble_info *);
 288 extern int print_insn_s12z              (bfd_vma, disassemble_info *);
 289 extern int print_insn_sh                (bfd_vma, disassemble_info *);
 290 extern int print_insn_sparc             (bfd_vma, disassemble_info *);
 291 extern int print_insn_rx                (bfd_vma, disassemble_info *);
 292 extern int print_insn_rl78              (bfd_vma, disassemble_info *);
 293 extern int print_insn_rl78_g10          (bfd_vma, disassemble_info *);
 294 extern int print_insn_rl78_g13          (bfd_vma, disassemble_info *);
 295 extern int print_insn_rl78_g14          (bfd_vma, disassemble_info *);
 296
 297 extern disassembler_ftype arc_get_disassembler (bfd *);
 298 extern disassembler_ftype cris_get_disassembler (bfd *);
 299
 300 extern void print_aarch64_disassembler_options (FILE *);
 301 extern void print_i386_disassembler_options (FILE *);
 302 extern void print_mips_disassembler_options (FILE *);
 303 extern void print_nfp_disassembler_options (FILE *);
 304 extern void print_ppc_disassembler_options (FILE *);
 305 extern void print_riscv_disassembler_options (FILE *);
 306 extern void print_arm_disassembler_options (FILE *);
 307 extern void print_arc_disassembler_options (FILE *);
 308 extern void print_s390_disassembler_options (FILE *);
 309 extern void print_wasm32_disassembler_options (FILE *);
 310 extern bool aarch64_symbol_is_valid (asymbol *, struct disassemble_info *);
 311 extern bool arm_symbol_is_valid (asymbol *, struct disassemble_info *);
 312 extern bool csky_symbol_is_valid (asymbol *, struct disassemble_info *);
 313 extern bool riscv_symbol_is_valid (asymbol *, struct disassemble_info *);
 314 extern void disassemble_init_powerpc (struct disassemble_info *);
 315 extern void disassemble_init_s390 (struct disassemble_info *);
 316 extern void disassemble_init_wasm32 (struct disassemble_info *);
 317 extern void disassemble_init_nds32 (struct disassemble_info *);
 318 extern const disasm_options_and_args_t *disassembler_options_arm (void);
 319 extern const disasm_options_and_args_t *disassembler_options_mips (void);
 320 extern const disasm_options_and_args_t *disassembler_options_powerpc (void);
 321 extern const disasm_options_and_args_t *disassembler_options_s390 (void);
 322
 323 /* Fetch the disassembler for a given architecture ARC, endianess (big
 324    endian if BIG is true), bfd_mach value MACH, and ABFD, if that support
 325    is available.  ABFD may be NULL.  */
 326 extern disassembler_ftype disassembler (enum bfd_architecture arc,
 327                                         bool big, unsigned long mach,
 328                                         bfd *abfd);
 329
 330 /* Amend the disassemble_info structure as necessary for the target architecture.
 331    Should only be called after initialising the info->arch field.  */
 332 extern void disassemble_init_for_target (struct disassemble_info *);
 333
 334 /* Tidy any memory allocated by targets, such as info->private_data.  */
 335 extern void disassemble_free_target (struct disassemble_info *);
 336
 337 /* Document any target specific options available from the disassembler.  */
 338 extern void disassembler_usage (FILE *);
 339
 340 /* Remove whitespace and consecutive commas.  */
 341 extern char *remove_whitespace_and_extra_commas (char *);
 342
 343 /* Like STRCMP, but treat ',' the same as '\0' so that we match
 344    strings like "foobar" against "foobar,xxyyzz,...".  */
 345 extern int disassembler_options_cmp (const char *, const char *);
 346
 347 /* A helper function for FOR_EACH_DISASSEMBLER_OPTION.  */
 348 static inline const char *
 349 next_disassembler_option (const char *options)
 350 {
 351   const char *opt = strchr (options, ',');
 352   if (opt != NULL)
 353     opt++;
 354   return opt;
 355 }
 356
 357 /* A macro for iterating over each comma separated option in OPTIONS.  */
 358 #define FOR_EACH_DISASSEMBLER_OPTION(OPT, OPTIONS) \
 359   for ((OPT) = (OPTIONS); \
 360        (OPT) != NULL; \
 361        (OPT) = next_disassembler_option (OPT))
 362
 363 \f
 364 /* This block of definitions is for particular callers who read instructions
 365    into a buffer before calling the instruction decoder.  */
 366
 367 /* Here is a function which callers may wish to use for read_memory_func.
 368    It gets bytes from a buffer.  */
 369 extern int buffer_read_memory
 370   (bfd_vma, bfd_byte *, unsigned int, struct disassemble_info *);
 371
 372 /* This function goes with buffer_read_memory.
 373    It prints a message using info->fprintf_func and info->stream.  */
 374 extern void perror_memory (int, bfd_vma, struct disassemble_info *);
 375
 376
 377 /* Just print the address in hex.  This is included for completeness even
 378    though both GDB and objdump provide their own (to print symbolic
 379    addresses).  */
 380 extern void generic_print_address
 381   (bfd_vma, struct disassemble_info *);
 382
 383 /* Always NULL.  */
 384 extern asymbol *generic_symbol_at_address
 385   (bfd_vma, struct disassemble_info *);
 386
 387 /* Always true.  */
 388 extern bool generic_symbol_is_valid
 389   (asymbol *, struct disassemble_info *);
 390
 391 /* Method to initialize a disassemble_info struct.  This should be
 392    called by all applications creating such a struct.  */
 393 extern void init_disassemble_info (struct disassemble_info *dinfo, void *stream,
 394                                    fprintf_ftype fprintf_func);
 395
 396 /* For compatibility with existing code.  */
 397 #define INIT_DISASSEMBLE_INFO(INFO, STREAM, FPRINTF_FUNC) \
 398   init_disassemble_info (&(INFO), (STREAM), (fprintf_ftype) (FPRINTF_FUNC))
 399
 400 #ifdef __cplusplus
 401 }
 402 #endif
 403
 404 #endif /* ! defined (DIS_ASM_H) */