binutils/dwarf.h

   1 /* dwarf.h - DWARF support header file
   2    Copyright 2005, 2007, 2008, 2009, 2010
   3    Free Software Foundation, Inc.
   4
   5    This file is part of GNU Binutils.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program; if not, write to the Free Software
  19    Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
  20    MA 02110-1301, USA.  */
  21
  22 #if __STDC_VERSION__ >= 199901L || (defined(__GNUC__) && __GNUC__ >= 2)
  23 /* We can't use any bfd types here since readelf may define BFD64 and
  24    objdump may not.  */
  25 typedef unsigned long long dwarf_vma;
  26 typedef unsigned long long dwarf_size_type;
  27 #else
  28 typedef unsigned long dwarf_vma;
  29 typedef unsigned long dwarf_size_type;
  30 #endif
  31
  32 struct dwarf_section
  33 {
  34   /* A debug section has a different name when it's stored compressed
  35      or not.  COMPRESSED_NAME and UNCOMPRESSED_NAME are the two
  36      possibilities.  NAME is set to whichever one is used for this
  37      input file, as determined by load_debug_section().  */
  38   const char *uncompressed_name;
  39   const char *compressed_name;
  40   const char *name;
  41   unsigned char *start;
  42   dwarf_vma address;
  43   dwarf_size_type size;
  44 };
  45
  46 /* A structure containing the name of a debug section
  47    and a pointer to a function that can decode it.  */
  48 struct dwarf_section_display
  49 {
  50   struct dwarf_section section;
  51   int (*display) (struct dwarf_section *, void *);
  52   int *enabled;
  53   unsigned int relocate : 1;
  54 };
  55
  56 enum dwarf_section_display_enum
  57 {
  58   abbrev = 0,
  59   aranges,
  60   frame,
  61   info,
  62   line,
  63   pubnames,
  64   eh_frame,
  65   macinfo,
  66   str,
  67   loc,
  68   pubtypes,
  69   ranges,
  70   static_func,
  71   static_vars,
  72   types,
  73   weaknames,
  74   trace_info,
  75   trace_abbrev,
  76   trace_aranges,
  77   max
  78 };
  79
  80 extern struct dwarf_section_display debug_displays [];
  81
  82 /* This structure records the information that
  83    we extract from the.debug_info section.  */
  84 typedef struct
  85 {
  86   unsigned int   pointer_size;
  87   unsigned int   offset_size;
  88   int            dwarf_version;
  89   unsigned long  cu_offset;
  90   unsigned long  base_address;
  91   /* This is an array of offsets to the location list table.  */
  92   unsigned long *loc_offsets;
  93   int           *have_frame_base;
  94   unsigned int   num_loc_offsets;
  95   unsigned int   max_loc_offsets;
  96   /* List of .debug_ranges offsets seen in this .debug_info.  */
  97   unsigned long *range_lists;
  98   unsigned int   num_range_lists;
  99   unsigned int   max_range_lists;
 100 }
 101 debug_info;
 102
 103 extern dwarf_vma (*byte_get) (unsigned char *, int);
 104 extern dwarf_vma byte_get_little_endian (unsigned char *, int);
 105 extern dwarf_vma byte_get_big_endian (unsigned char *, int);
 106
 107 extern int eh_addr_size;
 108
 109 extern int do_debug_info;
 110 extern int do_debug_abbrevs;
 111 extern int do_debug_lines;
 112 extern int do_debug_pubnames;
 113 extern int do_debug_pubtypes;
 114 extern int do_debug_aranges;
 115 extern int do_debug_ranges;
 116 extern int do_debug_frames;
 117 extern int do_debug_frames_interp;
 118 extern int do_debug_macinfo;
 119 extern int do_debug_str;
 120 extern int do_debug_loc;
 121 extern int do_trace_info;
 122 extern int do_trace_abbrevs;
 123 extern int do_trace_aranges;
 124 extern int do_wide;
 125
 126 extern void init_dwarf_regnames (unsigned int);
 127 extern void init_dwarf_regnames_i386 (void);
 128 extern void init_dwarf_regnames_x86_64 (void);
 129
 130 extern int load_debug_section (enum dwarf_section_display_enum,
 131                                void *);
 132 extern void free_debug_section (enum dwarf_section_display_enum);
 133
 134 extern void free_debug_memory (void);
 135
 136 extern void dwarf_select_sections_by_names (const char *);
 137 extern void dwarf_select_sections_by_letters (const char *);
 138 extern void dwarf_select_sections_all (void);
 139
 140 void *cmalloc (size_t, size_t);
 141 void *xcmalloc (size_t, size_t);
 142 void *xcrealloc (void *, size_t, size_t);
 143
 144 void error (const char *, ...) ATTRIBUTE_PRINTF_1;
 145 void warn (const char *, ...) ATTRIBUTE_PRINTF_1;
 146
 147 unsigned long int read_leb128 (unsigned char *data,
 148                                unsigned int *length_return, int sign);