1 /* dwarf2out.h - Various declarations for functions found in dwarf2out.c
2 Copyright (C) 1998-2014 Free Software Foundation, Inc.
4 This file is part of GCC.
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
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
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/>. */
20 #ifndef GCC_DWARF2OUT_H
21 #define GCC_DWARF2OUT_H 1
23 #include "dwarf2.h" /* ??? Remove this once only used by dwarf2foo.c. */
26 typedef struct die_struct
*dw_die_ref
;
27 typedef const struct die_struct
*const_dw_die_ref
;
29 typedef struct dw_val_node
*dw_val_ref
;
30 typedef struct dw_cfi_node
*dw_cfi_ref
;
31 typedef struct dw_loc_descr_node
*dw_loc_descr_ref
;
32 typedef struct dw_loc_list_struct
*dw_loc_list_ref
;
33 typedef wide_int
*wide_int_ptr
;
36 /* Call frames are described using a sequence of Call Frame
37 Information instructions. The register number, offset
38 and address fields are provided as possible operands;
39 their use is selected by the opcode field. */
41 enum dw_cfi_oprnd_type
{
49 typedef union GTY(()) {
50 unsigned int GTY ((tag ("dw_cfi_oprnd_reg_num"))) dw_cfi_reg_num
;
51 HOST_WIDE_INT
GTY ((tag ("dw_cfi_oprnd_offset"))) dw_cfi_offset
;
52 const char * GTY ((tag ("dw_cfi_oprnd_addr"))) dw_cfi_addr
;
53 struct dw_loc_descr_node
* GTY ((tag ("dw_cfi_oprnd_loc"))) dw_cfi_loc
;
56 struct GTY(()) dw_cfi_node
{
57 enum dwarf_call_frame_info dw_cfi_opc
;
58 dw_cfi_oprnd
GTY ((desc ("dw_cfi_oprnd1_desc (%1.dw_cfi_opc)")))
60 dw_cfi_oprnd
GTY ((desc ("dw_cfi_oprnd2_desc (%1.dw_cfi_opc)")))
65 typedef vec
<dw_cfi_ref
, va_gc
> *cfi_vec
;
67 typedef struct dw_fde_node
*dw_fde_ref
;
69 /* All call frame descriptions (FDE's) in the GCC generated DWARF
70 refer to a single Common Information Entry (CIE), defined at
71 the beginning of the .debug_frame section. This use of a single
72 CIE obviates the need to keep track of multiple CIE's
73 in the DWARF generation routines below. */
75 struct GTY(()) dw_fde_node
{
77 const char *dw_fde_begin
;
78 const char *dw_fde_current_label
;
79 const char *dw_fde_end
;
80 const char *dw_fde_vms_end_prologue
;
81 const char *dw_fde_vms_begin_epilogue
;
82 const char *dw_fde_second_begin
;
83 const char *dw_fde_second_end
;
85 int dw_fde_switch_cfi_index
; /* Last CFI before switching sections. */
86 HOST_WIDE_INT stack_realignment
;
88 unsigned funcdef_number
;
91 /* Dynamic realign argument pointer register. */
92 unsigned int drap_reg
;
93 /* Virtual dynamic realign argument pointer register. */
94 unsigned int vdrap_reg
;
95 /* These 3 flags are copied from rtl_data in function.h. */
96 unsigned all_throwers_are_sibcalls
: 1;
97 unsigned uses_eh_lsda
: 1;
99 /* Whether we did stack realign in this call frame. */
100 unsigned stack_realign
: 1;
101 /* Whether dynamic realign argument pointer register has been saved. */
102 unsigned drap_reg_saved
: 1;
103 /* True iff dw_fde_begin label is in text_section or cold_text_section. */
104 unsigned in_std_section
: 1;
105 /* True iff dw_fde_second_begin label is in text_section or
106 cold_text_section. */
107 unsigned second_in_std_section
: 1;
111 /* This is how we define the location of the CFA. We use to handle it
112 as REG + OFFSET all the time, but now it can be more complex.
113 It can now be either REG + CFA_OFFSET or *(REG + BASE_OFFSET) + CFA_OFFSET.
114 Instead of passing around REG and OFFSET, we pass a copy
115 of this structure. */
116 struct GTY(()) dw_cfa_location
{
117 HOST_WIDE_INT offset
;
118 HOST_WIDE_INT base_offset
;
119 /* REG is in DWARF_FRAME_REGNUM space, *not* normal REGNO space. */
121 BOOL_BITFIELD indirect
: 1; /* 1 if CFA is accessed via a dereference. */
122 BOOL_BITFIELD in_use
: 1; /* 1 if a saved cfa is stored here. */
126 /* Each DIE may have a series of attribute/value pairs. Values
127 can take on several forms. The forms that are used in this
128 implementation are listed below. */
136 dw_val_class_loc_list
,
137 dw_val_class_range_list
,
139 dw_val_class_unsigned_const
,
140 dw_val_class_const_double
,
141 dw_val_class_wide_int
,
144 dw_val_class_die_ref
,
145 dw_val_class_fde_ref
,
147 dw_val_class_lineptr
,
152 dw_val_class_decl_ref
,
153 dw_val_class_vms_delta
,
157 /* Describe a floating point constant value, or a vector constant value. */
159 struct GTY(()) dw_vec_const
{
160 unsigned char * GTY((atomic
)) array
;
165 struct addr_table_entry_struct
;
167 /* The dw_val_node describes an attribute's value, as it is
168 represented internally. */
170 struct GTY(()) dw_val_node
{
171 enum dw_val_class val_class
;
172 struct addr_table_entry_struct
* GTY(()) val_entry
;
173 union dw_val_struct_union
175 rtx
GTY ((tag ("dw_val_class_addr"))) val_addr
;
176 unsigned HOST_WIDE_INT
GTY ((tag ("dw_val_class_offset"))) val_offset
;
177 dw_loc_list_ref
GTY ((tag ("dw_val_class_loc_list"))) val_loc_list
;
178 dw_loc_descr_ref
GTY ((tag ("dw_val_class_loc"))) val_loc
;
179 HOST_WIDE_INT
GTY ((default)) val_int
;
180 unsigned HOST_WIDE_INT
GTY ((tag ("dw_val_class_unsigned_const"))) val_unsigned
;
181 double_int
GTY ((tag ("dw_val_class_const_double"))) val_double
;
182 wide_int_ptr
GTY ((tag ("dw_val_class_wide_int"))) val_wide
;
183 dw_vec_const
GTY ((tag ("dw_val_class_vec"))) val_vec
;
184 struct dw_val_die_union
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
200 } GTY ((tag ("dw_val_class_vms_delta"))) val_vms_delta
;
202 GTY ((desc ("%1.val_class"))) v
;
205 /* Locations in memory are described using a sequence of stack machine
208 struct GTY(()) dw_loc_descr_node
{
209 dw_loc_descr_ref dw_loc_next
;
210 ENUM_BITFIELD (dwarf_location_atom
) dw_loc_opc
: 8;
211 /* Used to distinguish DW_OP_addr with a direct symbol relocation
212 from DW_OP_addr with a dtp-relative symbol relocation. */
213 unsigned int dtprel
: 1;
215 dw_val_node dw_loc_oprnd1
;
216 dw_val_node dw_loc_oprnd2
;
220 /* Interface from dwarf2out.c to dwarf2cfi.c. */
221 extern struct dw_loc_descr_node
*build_cfa_loc
222 (dw_cfa_location
*, HOST_WIDE_INT
);
223 extern struct dw_loc_descr_node
*build_cfa_aligned_loc
224 (dw_cfa_location
*, HOST_WIDE_INT offset
, HOST_WIDE_INT alignment
);
225 extern struct dw_loc_descr_node
*mem_loc_descriptor
226 (rtx
, machine_mode mode
, machine_mode mem_mode
,
227 enum var_init_status
);
228 extern bool loc_descr_equal_p (dw_loc_descr_ref
, dw_loc_descr_ref
);
229 extern dw_fde_ref
dwarf2out_alloc_current_fde (void);
231 extern unsigned long size_of_locs (dw_loc_descr_ref
);
232 extern void output_loc_sequence (dw_loc_descr_ref
, int);
233 extern void output_loc_sequence_raw (dw_loc_descr_ref
);
235 /* Interface from dwarf2cfi.c to dwarf2out.c. */
236 extern void lookup_cfa_1 (dw_cfi_ref cfi
, dw_cfa_location
*loc
,
237 dw_cfa_location
*remember
);
238 extern bool cfa_equal_p (const dw_cfa_location
*, const dw_cfa_location
*);
240 extern void output_cfi (dw_cfi_ref
, dw_fde_ref
, int);
242 extern GTY(()) cfi_vec cie_cfi_vec
;
244 /* Interface from dwarf2*.c to the rest of the compiler. */
245 extern enum dw_cfi_oprnd_type dw_cfi_oprnd1_desc
246 (enum dwarf_call_frame_info cfi
);
247 extern enum dw_cfi_oprnd_type dw_cfi_oprnd2_desc
248 (enum dwarf_call_frame_info cfi
);
250 extern void output_cfi_directive (FILE *f
, struct dw_cfi_node
*cfi
);
252 extern void dwarf2out_emit_cfi (dw_cfi_ref cfi
);
254 extern void debug_dwarf (void);
256 extern void debug_dwarf_die (struct die_struct
*);
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);
264 enum array_descr_ordering
266 array_descr_ordering_default
,
267 array_descr_ordering_row_major
,
268 array_descr_ordering_column_major
271 struct array_descr_info
274 enum array_descr_ordering ordering
;
280 struct array_descr_dimen
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. */
292 void dwarf2out_c_finalize (void);
294 #endif /* GCC_DWARF2OUT_H */