gcc/dwarf2out.h

   1 /* dwarf2out.h - Various declarations for functions found in dwarf2out.c
   2    Copyright (C) 1998-2015 Free Software Foundation, Inc.
   3
   4 This file is part of GCC.
   5
   6 GCC is free software; you can redistribute it and/or modify it under
   7 the terms of the GNU General Public License as published by the Free
   8 Software Foundation; either version 3, or (at your option) any later
   9 version.
  10
  11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14 for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GCC; see the file COPYING3.  If not see
  18 <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef GCC_DWARF2OUT_H
  21 #define GCC_DWARF2OUT_H 1
  22
  23 #include "dwarf2.h"     /* ??? Remove this once only used by dwarf2foo.c.  */
  24
  25 typedef struct die_struct *dw_die_ref;
  26 typedef const struct die_struct *const_dw_die_ref;
  27
  28 typedef struct dw_val_node *dw_val_ref;
  29 typedef struct dw_cfi_node *dw_cfi_ref;
  30 typedef struct dw_loc_descr_node *dw_loc_descr_ref;
  31 typedef struct dw_loc_list_struct *dw_loc_list_ref;
  32 typedef wide_int *wide_int_ptr;
  33
  34
  35 /* Call frames are described using a sequence of Call Frame
  36    Information instructions.  The register number, offset
  37    and address fields are provided as possible operands;
  38    their use is selected by the opcode field.  */
  39
  40 enum dw_cfi_oprnd_type {
  41   dw_cfi_oprnd_unused,
  42   dw_cfi_oprnd_reg_num,
  43   dw_cfi_oprnd_offset,
  44   dw_cfi_oprnd_addr,
  45   dw_cfi_oprnd_loc
  46 };
  47
  48 typedef union GTY(()) {
  49   unsigned int GTY ((tag ("dw_cfi_oprnd_reg_num"))) dw_cfi_reg_num;
  50   HOST_WIDE_INT GTY ((tag ("dw_cfi_oprnd_offset"))) dw_cfi_offset;
  51   const char * GTY ((tag ("dw_cfi_oprnd_addr"))) dw_cfi_addr;
  52   struct dw_loc_descr_node * GTY ((tag ("dw_cfi_oprnd_loc"))) dw_cfi_loc;
  53 } dw_cfi_oprnd;
  54
  55 struct GTY(()) dw_cfi_node {
  56   enum dwarf_call_frame_info dw_cfi_opc;
  57   dw_cfi_oprnd GTY ((desc ("dw_cfi_oprnd1_desc (%1.dw_cfi_opc)")))
  58     dw_cfi_oprnd1;
  59   dw_cfi_oprnd GTY ((desc ("dw_cfi_oprnd2_desc (%1.dw_cfi_opc)")))
  60     dw_cfi_oprnd2;
  61 };
  62
  63
  64 typedef vec<dw_cfi_ref, va_gc> *cfi_vec;
  65
  66 typedef struct dw_fde_node *dw_fde_ref;
  67
  68 /* All call frame descriptions (FDE's) in the GCC generated DWARF
  69    refer to a single Common Information Entry (CIE), defined at
  70    the beginning of the .debug_frame section.  This use of a single
  71    CIE obviates the need to keep track of multiple CIE's
  72    in the DWARF generation routines below.  */
  73
  74 struct GTY(()) dw_fde_node {
  75   tree decl;
  76   const char *dw_fde_begin;
  77   const char *dw_fde_current_label;
  78   const char *dw_fde_end;
  79   const char *dw_fde_vms_end_prologue;
  80   const char *dw_fde_vms_begin_epilogue;
  81   const char *dw_fde_second_begin;
  82   const char *dw_fde_second_end;
  83   cfi_vec dw_fde_cfi;
  84   int dw_fde_switch_cfi_index; /* Last CFI before switching sections.  */
  85   HOST_WIDE_INT stack_realignment;
  86
  87   unsigned funcdef_number;
  88   unsigned fde_index;
  89
  90   /* Dynamic realign argument pointer register.  */
  91   unsigned int drap_reg;
  92   /* Virtual dynamic realign argument pointer register.  */
  93   unsigned int vdrap_reg;
  94   /* These 3 flags are copied from rtl_data in function.h.  */
  95   unsigned all_throwers_are_sibcalls : 1;
  96   unsigned uses_eh_lsda : 1;
  97   unsigned nothrow : 1;
  98   /* Whether we did stack realign in this call frame.  */
  99   unsigned stack_realign : 1;
 100   /* Whether dynamic realign argument pointer register has been saved.  */
 101   unsigned drap_reg_saved: 1;
 102   /* True iff dw_fde_begin label is in text_section or cold_text_section.  */
 103   unsigned in_std_section : 1;
 104   /* True iff dw_fde_second_begin label is in text_section or
 105      cold_text_section.  */
 106   unsigned second_in_std_section : 1;
 107 };
 108
 109
 110 /* This is how we define the location of the CFA. We use to handle it
 111    as REG + OFFSET all the time,  but now it can be more complex.
 112    It can now be either REG + CFA_OFFSET or *(REG + BASE_OFFSET) + CFA_OFFSET.
 113    Instead of passing around REG and OFFSET, we pass a copy
 114    of this structure.  */
 115 struct GTY(()) dw_cfa_location {
 116   HOST_WIDE_INT offset;
 117   HOST_WIDE_INT base_offset;
 118   /* REG is in DWARF_FRAME_REGNUM space, *not* normal REGNO space.  */
 119   unsigned int reg;
 120   BOOL_BITFIELD indirect : 1;  /* 1 if CFA is accessed via a dereference.  */
 121   BOOL_BITFIELD in_use : 1;    /* 1 if a saved cfa is stored here.  */
 122 };
 123
 124
 125 /* Each DIE may have a series of attribute/value pairs.  Values
 126    can take on several forms.  The forms that are used in this
 127    implementation are listed below.  */
 128
 129 enum dw_val_class
 130 {
 131   dw_val_class_none,
 132   dw_val_class_addr,
 133   dw_val_class_offset,
 134   dw_val_class_loc,
 135   dw_val_class_loc_list,
 136   dw_val_class_range_list,
 137   dw_val_class_const,
 138   dw_val_class_unsigned_const,
 139   dw_val_class_const_double,
 140   dw_val_class_wide_int,
 141   dw_val_class_vec,
 142   dw_val_class_flag,
 143   dw_val_class_die_ref,
 144   dw_val_class_fde_ref,
 145   dw_val_class_lbl_id,
 146   dw_val_class_lineptr,
 147   dw_val_class_str,
 148   dw_val_class_macptr,
 149   dw_val_class_file,
 150   dw_val_class_data8,
 151   dw_val_class_decl_ref,
 152   dw_val_class_vms_delta,
 153   dw_val_class_high_pc
 154 };
 155
 156 /* Describe a floating point constant value, or a vector constant value.  */
 157
 158 struct GTY(()) dw_vec_const {
 159   unsigned char * GTY((atomic)) array;
 160   unsigned length;
 161   unsigned elt_size;
 162 };
 163
 164 struct addr_table_entry_struct;
 165
 166 /* The dw_val_node describes an attribute's value, as it is
 167    represented internally.  */
 168
 169 struct GTY(()) dw_val_node {
 170   enum dw_val_class val_class;
 171   struct addr_table_entry_struct * GTY(()) val_entry;
 172   union dw_val_struct_union
 173     {
 174       rtx GTY ((tag ("dw_val_class_addr"))) val_addr;
 175       unsigned HOST_WIDE_INT GTY ((tag ("dw_val_class_offset"))) val_offset;
 176       dw_loc_list_ref GTY ((tag ("dw_val_class_loc_list"))) val_loc_list;
 177       dw_loc_descr_ref GTY ((tag ("dw_val_class_loc"))) val_loc;
 178       HOST_WIDE_INT GTY ((default)) val_int;
 179       unsigned HOST_WIDE_INT GTY ((tag ("dw_val_class_unsigned_const"))) val_unsigned;
 180       double_int GTY ((tag ("dw_val_class_const_double"))) val_double;
 181       wide_int_ptr GTY ((tag ("dw_val_class_wide_int"))) val_wide;
 182       dw_vec_const GTY ((tag ("dw_val_class_vec"))) val_vec;
 183       struct dw_val_die_union
 184         {
 185           dw_die_ref die;
 186           int external;
 187         } GTY ((tag ("dw_val_class_die_ref"))) val_die_ref;
 188       unsigned GTY ((tag ("dw_val_class_fde_ref"))) val_fde_index;
 189       struct indirect_string_node * GTY ((tag ("dw_val_class_str"))) val_str;
 190       char * GTY ((tag ("dw_val_class_lbl_id"))) val_lbl_id;
 191       unsigned char GTY ((tag ("dw_val_class_flag"))) val_flag;
 192       struct dwarf_file_data * GTY ((tag ("dw_val_class_file"))) val_file;
 193       unsigned char GTY ((tag ("dw_val_class_data8"))) val_data8[8];
 194       tree GTY ((tag ("dw_val_class_decl_ref"))) val_decl_ref;
 195       struct dw_val_vms_delta_union
 196         {
 197           char * lbl1;
 198           char * lbl2;
 199         } GTY ((tag ("dw_val_class_vms_delta"))) val_vms_delta;
 200     }
 201   GTY ((desc ("%1.val_class"))) v;
 202 };
 203
 204 /* Locations in memory are described using a sequence of stack machine
 205    operations.  */
 206
 207 struct GTY((chain_next ("%h.dw_loc_next"))) dw_loc_descr_node {
 208   dw_loc_descr_ref dw_loc_next;
 209   ENUM_BITFIELD (dwarf_location_atom) dw_loc_opc : 8;
 210   /* Used to distinguish DW_OP_addr with a direct symbol relocation
 211      from DW_OP_addr with a dtp-relative symbol relocation.  */
 212   unsigned int dtprel : 1;
 213   int dw_loc_addr;
 214   dw_val_node dw_loc_oprnd1;
 215   dw_val_node dw_loc_oprnd2;
 216 };
 217
 218
 219 /* Interface from dwarf2out.c to dwarf2cfi.c.  */
 220 extern struct dw_loc_descr_node *build_cfa_loc
 221   (dw_cfa_location *, HOST_WIDE_INT);
 222 extern struct dw_loc_descr_node *build_cfa_aligned_loc
 223   (dw_cfa_location *, HOST_WIDE_INT offset, HOST_WIDE_INT alignment);
 224 extern struct dw_loc_descr_node *mem_loc_descriptor
 225   (rtx, machine_mode mode, machine_mode mem_mode,
 226    enum var_init_status);
 227 extern bool loc_descr_equal_p (dw_loc_descr_ref, dw_loc_descr_ref);
 228 extern dw_fde_ref dwarf2out_alloc_current_fde (void);
 229
 230 extern unsigned long size_of_locs (dw_loc_descr_ref);
 231 extern void output_loc_sequence (dw_loc_descr_ref, int);
 232 extern void output_loc_sequence_raw (dw_loc_descr_ref);
 233
 234 /* Interface from dwarf2cfi.c to dwarf2out.c.  */
 235 extern void lookup_cfa_1 (dw_cfi_ref cfi, dw_cfa_location *loc,
 236                           dw_cfa_location *remember);
 237 extern bool cfa_equal_p (const dw_cfa_location *, const dw_cfa_location *);
 238
 239 extern void output_cfi (dw_cfi_ref, dw_fde_ref, int);
 240
 241 extern GTY(()) cfi_vec cie_cfi_vec;
 242
 243 /* Interface from dwarf2*.c to the rest of the compiler.  */
 244 extern enum dw_cfi_oprnd_type dw_cfi_oprnd1_desc
 245   (enum dwarf_call_frame_info cfi);
 246 extern enum dw_cfi_oprnd_type dw_cfi_oprnd2_desc
 247   (enum dwarf_call_frame_info cfi);
 248
 249 extern void output_cfi_directive (FILE *f, struct dw_cfi_node *cfi);
 250
 251 extern void dwarf2out_emit_cfi (dw_cfi_ref cfi);
 252
 253 extern void debug_dwarf (void);
 254 struct die_struct;
 255 extern void debug_dwarf_die (struct die_struct *);
 256 extern void debug_dwarf_loc_descr (dw_loc_descr_ref);
 257 extern void debug (die_struct &ref);
 258 extern void debug (die_struct *ptr);
 259 extern void dwarf2out_set_demangle_name_func (const char *(*) (const char *));
 260 #ifdef VMS_DEBUGGING_INFO
 261 extern void dwarf2out_vms_debug_main_pointer (void);
 262 #endif
 263
 264 enum array_descr_ordering
 265 {
 266   array_descr_ordering_default,
 267   array_descr_ordering_row_major,
 268   array_descr_ordering_column_major
 269 };
 270
 271 struct array_descr_info
 272 {
 273   int ndimensions;
 274   enum array_descr_ordering ordering;
 275   tree element_type;
 276   tree base_decl;
 277   tree data_location;
 278   tree allocated;
 279   tree associated;
 280   struct array_descr_dimen
 281     {
 282       /* GCC uses sizetype for array indices, so lower_bound and upper_bound
 283          will likely be "sizetype" values. However, bounds may have another
 284          type in the original source code.  */
 285       tree bounds_type;
 286       tree lower_bound;
 287       tree upper_bound;
 288       tree stride;
 289     } dimen[10];
 290 };
 291
 292 void dwarf2out_c_finalize (void);
 293
 294 #endif /* GCC_DWARF2OUT_H */