dwarf2out.h revision 1.1.1.2 
1/* dwarf2out.h - Various declarations for functions found in dwarf2out.c
2   Copyright (C) 1998-2013 Free Software Foundation, Inc.
3
4This file is part of GCC.
5
6GCC is free software; you can redistribute it and/or modify it under
7the terms of the GNU General Public License as published by the Free
8Software Foundation; either version 3, or (at your option) any later
9version.
10
11GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12WARRANTY; without even the implied warranty of MERCHANTABILITY or
13FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14for more details.
15
16You should have received a copy of the GNU General Public License
17along 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
25typedef struct die_struct *dw_die_ref;
26typedef const struct die_struct *const_dw_die_ref;
27
28typedef struct dw_val_struct *dw_val_ref;
29typedef struct dw_cfi_struct *dw_cfi_ref;
30typedef struct dw_loc_descr_struct *dw_loc_descr_ref;
31typedef struct dw_loc_list_struct *dw_loc_list_ref;
32
33
34/* Call frames are described using a sequence of Call Frame
35   Information instructions.  The register number, offset
36   and address fields are provided as possible operands;
37   their use is selected by the opcode field.  */
38
39enum dw_cfi_oprnd_type {
40  dw_cfi_oprnd_unused,
41  dw_cfi_oprnd_reg_num,
42  dw_cfi_oprnd_offset,
43  dw_cfi_oprnd_addr,
44  dw_cfi_oprnd_loc
45};
46
47typedef union GTY(()) dw_cfi_oprnd_struct {
48  unsigned int GTY ((tag ("dw_cfi_oprnd_reg_num"))) dw_cfi_reg_num;
49  HOST_WIDE_INT GTY ((tag ("dw_cfi_oprnd_offset"))) dw_cfi_offset;
50  const char * GTY ((tag ("dw_cfi_oprnd_addr"))) dw_cfi_addr;
51  struct dw_loc_descr_struct * GTY ((tag ("dw_cfi_oprnd_loc"))) dw_cfi_loc;
52}
53dw_cfi_oprnd;
54
55typedef struct GTY(()) dw_cfi_struct {
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}
62dw_cfi_node;
63
64
65typedef vec<dw_cfi_ref, va_gc> *cfi_vec;
66
67typedef struct dw_fde_struct *dw_fde_ref;
68
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.  */
74
75typedef struct GTY(()) dw_fde_struct {
76  tree decl;
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;
84  cfi_vec dw_fde_cfi;
85  int dw_fde_switch_cfi_index; /* Last CFI before switching sections.  */
86  HOST_WIDE_INT stack_realignment;
87
88  unsigned funcdef_number;
89  unsigned fde_index;
90
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;
98  unsigned nothrow : 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;
108}
109dw_fde_node;
110
111
112/* This is how we define the location of the CFA. We use to handle it
113   as REG + OFFSET all the time,  but now it can be more complex.
114   It can now be either REG + CFA_OFFSET or *(REG + BASE_OFFSET) + CFA_OFFSET.
115   Instead of passing around REG and OFFSET, we pass a copy
116   of this structure.  */
117typedef struct GTY(()) cfa_loc {
118  HOST_WIDE_INT offset;
119  HOST_WIDE_INT base_offset;
120  /* REG is in DWARF_FRAME_REGNUM space, *not* normal REGNO space.  */
121  unsigned int reg;
122  BOOL_BITFIELD indirect : 1;  /* 1 if CFA is accessed via a dereference.  */
123  BOOL_BITFIELD in_use : 1;    /* 1 if a saved cfa is stored here.  */
124} dw_cfa_location;
125
126
127/* Each DIE may have a series of attribute/value pairs.  Values
128   can take on several forms.  The forms that are used in this
129   implementation are listed below.  */
130
131enum dw_val_class
132{
133  dw_val_class_none,
134  dw_val_class_addr,
135  dw_val_class_offset,
136  dw_val_class_loc,
137  dw_val_class_loc_list,
138  dw_val_class_range_list,
139  dw_val_class_const,
140  dw_val_class_unsigned_const,
141  dw_val_class_const_double,
142  dw_val_class_vec,
143  dw_val_class_flag,
144  dw_val_class_die_ref,
145  dw_val_class_fde_ref,
146  dw_val_class_lbl_id,
147  dw_val_class_lineptr,
148  dw_val_class_str,
149  dw_val_class_macptr,
150  dw_val_class_file,
151  dw_val_class_data8,
152  dw_val_class_decl_ref,
153  dw_val_class_vms_delta,
154  dw_val_class_high_pc
155};
156
157/* Describe a floating point constant value, or a vector constant value.  */
158
159typedef struct GTY(()) dw_vec_struct {
160  unsigned char * GTY((atomic)) array;
161  unsigned length;
162  unsigned elt_size;
163}
164dw_vec_const;
165
166struct addr_table_entry_struct;
167
168/* The dw_val_node describes an attribute's value, as it is
169   represented internally.  */
170
171typedef struct GTY(()) dw_val_struct {
172  enum dw_val_class val_class;
173  struct addr_table_entry_struct * GTY(()) val_entry;
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}
204dw_val_node;
205
206/* Locations in memory are described using a sequence of stack machine
207   operations.  */
208
209typedef 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}
219dw_loc_descr_node;
220
221
222/* Interface from dwarf2out.c to dwarf2cfi.c.  */
223extern struct dw_loc_descr_struct *build_cfa_loc
224  (dw_cfa_location *, HOST_WIDE_INT);
225extern struct dw_loc_descr_struct *build_cfa_aligned_loc
226  (dw_cfa_location *, HOST_WIDE_INT offset, HOST_WIDE_INT alignment);
227extern struct dw_loc_descr_struct *mem_loc_descriptor
228  (rtx, enum machine_mode mode, enum machine_mode mem_mode,
229   enum var_init_status);
230extern bool loc_descr_equal_p (dw_loc_descr_ref, dw_loc_descr_ref);
231extern dw_fde_ref dwarf2out_alloc_current_fde (void);
232
233extern unsigned long size_of_locs (dw_loc_descr_ref);
234extern void output_loc_sequence (dw_loc_descr_ref, int);
235extern void output_loc_sequence_raw (dw_loc_descr_ref);
236
237/* Interface from dwarf2cfi.c to dwarf2out.c.  */
238extern void lookup_cfa_1 (dw_cfi_ref cfi, dw_cfa_location *loc,
239			  dw_cfa_location *remember);
240extern bool cfa_equal_p (const dw_cfa_location *, const dw_cfa_location *);
241
242extern void output_cfi (dw_cfi_ref, dw_fde_ref, int);
243
244extern GTY(()) cfi_vec cie_cfi_vec;
245
246/* Interface from dwarf2*.c to the rest of the compiler.  */
247extern enum dw_cfi_oprnd_type dw_cfi_oprnd1_desc
248  (enum dwarf_call_frame_info cfi);
249extern enum dw_cfi_oprnd_type dw_cfi_oprnd2_desc
250  (enum dwarf_call_frame_info cfi);
251
252extern void output_cfi_directive (FILE *f, struct dw_cfi_struct *cfi);
253
254extern void dwarf2out_decl (tree);
255extern void dwarf2out_emit_cfi (dw_cfi_ref cfi);
256
257extern void debug_dwarf (void);
258struct die_struct;
259extern void debug_dwarf_die (struct die_struct *);
260extern void dwarf2out_set_demangle_name_func (const char *(*) (const char *));
261#ifdef VMS_DEBUGGING_INFO
262extern void dwarf2out_vms_debug_main_pointer (void);
263#endif
264
265struct 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 */
282