gcc/dwarf2out.h

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