Initial revision
[binutils.git] / include / elf / dwarf2.h
blobb2cbb24d95d84dd16d822bc7989c14fff9347199
1 /* Declarations and definitions of codes relating to the DWARF symbolic
2 debugging information format.
3 Copyright (C) 1992, 1993, 1995, 1996, 1999 Free Software Foundation, Inc.
5 Written by Gary Funck (gary@intrepid.com) The Ada Joint Program
6 Office (AJPO), Florida State Unviversity and Silicon Graphics Inc.
7 provided support for this effort -- June 21, 1995.
9 Derived from the DWARF 1 implementation written by Ron Guilmette
10 (rfg@netcom.com), November 1990.
12 This file is part of GNU CC.
14 GNU CC is free software; you can redistribute it and/or modify it
15 under the terms of the GNU General Public License as published by the
16 Free Software Foundation; either version 2, or (at your option) any
17 later version.
19 GNU CC is distributed in the hope that it will be useful, but WITHOUT
20 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22 for more details.
24 You should have received a copy of the GNU General Public License
25 along with GNU CC; see the file COPYING. If not, write to the Free
26 Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
28 /* This file is derived from the DWARF specification (a public document)
29 Revision 2.0.0 (July 27, 1993) developed by the UNIX International
30 Programming Languages Special Interest Group (UI/PLSIG) and distributed
31 by UNIX International. Copies of this specification are available from
32 UNIX International, 20 Waterview Boulevard, Parsippany, NJ, 07054. */
34 #ifndef _ELF_DWARF2_H
35 #define _ELF_DWARF2_H
37 /* Structure found in the .debug_line section. */
38 typedef struct
40 unsigned char li_length [4];
41 unsigned char li_version [2];
42 unsigned char li_prologue_length [4];
43 unsigned char li_min_insn_length [1];
44 unsigned char li_default_is_stmt [1];
45 unsigned char li_line_base [1];
46 unsigned char li_line_range [1];
47 unsigned char li_opcode_base [1];
49 DWARF2_External_LineInfo;
51 typedef struct
53 unsigned long li_length;
54 unsigned short li_version;
55 unsigned int li_prologue_length;
56 unsigned char li_min_insn_length;
57 unsigned char li_default_is_stmt;
58 int li_line_base;
59 unsigned char li_line_range;
60 unsigned char li_opcode_base;
62 DWARF2_Internal_LineInfo;
64 /* Structure found in .debug_pubnames section. */
65 typedef struct
67 unsigned char pn_length [4];
68 unsigned char pn_version [2];
69 unsigned char pn_offset [4];
70 unsigned char pn_size [4];
72 DWARF2_External_PubNames;
74 typedef struct
76 unsigned long pn_length;
77 unsigned short pn_version;
78 unsigned long pn_offset;
79 unsigned long pn_size;
81 DWARF2_Internal_PubNames;
83 /* Strcuture found in .debug_info section. */
84 typedef struct
86 unsigned char cu_length [4];
87 unsigned char cu_version [2];
88 unsigned char cu_abbrev_offset [4];
89 unsigned char cu_pointer_size [1];
91 DWARF2_External_CompUnit;
93 typedef struct
95 unsigned long cu_length;
96 unsigned short cu_version;
97 unsigned long cu_abbrev_offset;
98 unsigned char cu_pointer_size;
100 DWARF2_Internal_CompUnit;
102 typedef struct
104 unsigned char ar_length [4];
105 unsigned char ar_version [2];
106 unsigned char ar_info_offset [4];
107 unsigned char ar_pointer_size [1];
108 unsigned char ar_segment_size [1];
110 DWARF2_External_ARange;
112 typedef struct
114 unsigned long ar_length;
115 unsigned short ar_version;
116 unsigned long ar_info_offset;
117 unsigned char ar_pointer_size;
118 unsigned char ar_segment_size;
120 DWARF2_Internal_ARange;
123 /* Tag names and codes. */
125 enum dwarf_tag
127 DW_TAG_padding = 0x00,
128 DW_TAG_array_type = 0x01,
129 DW_TAG_class_type = 0x02,
130 DW_TAG_entry_point = 0x03,
131 DW_TAG_enumeration_type = 0x04,
132 DW_TAG_formal_parameter = 0x05,
133 DW_TAG_imported_declaration = 0x08,
134 DW_TAG_label = 0x0a,
135 DW_TAG_lexical_block = 0x0b,
136 DW_TAG_member = 0x0d,
137 DW_TAG_pointer_type = 0x0f,
138 DW_TAG_reference_type = 0x10,
139 DW_TAG_compile_unit = 0x11,
140 DW_TAG_string_type = 0x12,
141 DW_TAG_structure_type = 0x13,
142 DW_TAG_subroutine_type = 0x15,
143 DW_TAG_typedef = 0x16,
144 DW_TAG_union_type = 0x17,
145 DW_TAG_unspecified_parameters = 0x18,
146 DW_TAG_variant = 0x19,
147 DW_TAG_common_block = 0x1a,
148 DW_TAG_common_inclusion = 0x1b,
149 DW_TAG_inheritance = 0x1c,
150 DW_TAG_inlined_subroutine = 0x1d,
151 DW_TAG_module = 0x1e,
152 DW_TAG_ptr_to_member_type = 0x1f,
153 DW_TAG_set_type = 0x20,
154 DW_TAG_subrange_type = 0x21,
155 DW_TAG_with_stmt = 0x22,
156 DW_TAG_access_declaration = 0x23,
157 DW_TAG_base_type = 0x24,
158 DW_TAG_catch_block = 0x25,
159 DW_TAG_const_type = 0x26,
160 DW_TAG_constant = 0x27,
161 DW_TAG_enumerator = 0x28,
162 DW_TAG_file_type = 0x29,
163 DW_TAG_friend = 0x2a,
164 DW_TAG_namelist = 0x2b,
165 DW_TAG_namelist_item = 0x2c,
166 DW_TAG_packed_type = 0x2d,
167 DW_TAG_subprogram = 0x2e,
168 DW_TAG_template_type_param = 0x2f,
169 DW_TAG_template_value_param = 0x30,
170 DW_TAG_thrown_type = 0x31,
171 DW_TAG_try_block = 0x32,
172 DW_TAG_variant_part = 0x33,
173 DW_TAG_variable = 0x34,
174 DW_TAG_volatile_type = 0x35,
175 /* SGI/MIPS Extensions */
176 DW_TAG_MIPS_loop = 0x4081,
177 /* GNU extensions */
178 DW_TAG_format_label = 0x4101, /* for FORTRAN 77 and Fortran 90 */
179 DW_TAG_function_template = 0x4102, /* for C++ */
180 DW_TAG_class_template = 0x4103 /* for C++ */
183 #define DW_TAG_lo_user 0x4080
184 #define DW_TAG_hi_user 0xffff
186 /* flag that tells whether entry has a child or not */
187 #define DW_children_no 0
188 #define DW_children_yes 1
190 /* Form names and codes. */
191 enum dwarf_form
193 DW_FORM_addr = 0x01,
194 DW_FORM_block2 = 0x03,
195 DW_FORM_block4 = 0x04,
196 DW_FORM_data2 = 0x05,
197 DW_FORM_data4 = 0x06,
198 DW_FORM_data8 = 0x07,
199 DW_FORM_string = 0x08,
200 DW_FORM_block = 0x09,
201 DW_FORM_block1 = 0x0a,
202 DW_FORM_data1 = 0x0b,
203 DW_FORM_flag = 0x0c,
204 DW_FORM_sdata = 0x0d,
205 DW_FORM_strp = 0x0e,
206 DW_FORM_udata = 0x0f,
207 DW_FORM_ref_addr = 0x10,
208 DW_FORM_ref1 = 0x11,
209 DW_FORM_ref2 = 0x12,
210 DW_FORM_ref4 = 0x13,
211 DW_FORM_ref8 = 0x14,
212 DW_FORM_ref_udata = 0x15,
213 DW_FORM_indirect = 0x16
216 /* Attribute names and codes. */
218 enum dwarf_attribute
220 DW_AT_sibling = 0x01,
221 DW_AT_location = 0x02,
222 DW_AT_name = 0x03,
223 DW_AT_ordering = 0x09,
224 DW_AT_subscr_data = 0x0a,
225 DW_AT_byte_size = 0x0b,
226 DW_AT_bit_offset = 0x0c,
227 DW_AT_bit_size = 0x0d,
228 DW_AT_element_list = 0x0f,
229 DW_AT_stmt_list = 0x10,
230 DW_AT_low_pc = 0x11,
231 DW_AT_high_pc = 0x12,
232 DW_AT_language = 0x13,
233 DW_AT_member = 0x14,
234 DW_AT_discr = 0x15,
235 DW_AT_discr_value = 0x16,
236 DW_AT_visibility = 0x17,
237 DW_AT_import = 0x18,
238 DW_AT_string_length = 0x19,
239 DW_AT_common_reference = 0x1a,
240 DW_AT_comp_dir = 0x1b,
241 DW_AT_const_value = 0x1c,
242 DW_AT_containing_type = 0x1d,
243 DW_AT_default_value = 0x1e,
244 DW_AT_inline = 0x20,
245 DW_AT_is_optional = 0x21,
246 DW_AT_lower_bound = 0x22,
247 DW_AT_producer = 0x25,
248 DW_AT_prototyped = 0x27,
249 DW_AT_return_addr = 0x2a,
250 DW_AT_start_scope = 0x2c,
251 DW_AT_stride_size = 0x2e,
252 DW_AT_upper_bound = 0x2f,
253 DW_AT_abstract_origin = 0x31,
254 DW_AT_accessibility = 0x32,
255 DW_AT_address_class = 0x33,
256 DW_AT_artificial = 0x34,
257 DW_AT_base_types = 0x35,
258 DW_AT_calling_convention = 0x36,
259 DW_AT_count = 0x37,
260 DW_AT_data_member_location = 0x38,
261 DW_AT_decl_column = 0x39,
262 DW_AT_decl_file = 0x3a,
263 DW_AT_decl_line = 0x3b,
264 DW_AT_declaration = 0x3c,
265 DW_AT_discr_list = 0x3d,
266 DW_AT_encoding = 0x3e,
267 DW_AT_external = 0x3f,
268 DW_AT_frame_base = 0x40,
269 DW_AT_friend = 0x41,
270 DW_AT_identifier_case = 0x42,
271 DW_AT_macro_info = 0x43,
272 DW_AT_namelist_items = 0x44,
273 DW_AT_priority = 0x45,
274 DW_AT_segment = 0x46,
275 DW_AT_specification = 0x47,
276 DW_AT_static_link = 0x48,
277 DW_AT_type = 0x49,
278 DW_AT_use_location = 0x4a,
279 DW_AT_variable_parameter = 0x4b,
280 DW_AT_virtuality = 0x4c,
281 DW_AT_vtable_elem_location = 0x4d,
282 /* SGI/MIPS Extensions */
283 DW_AT_MIPS_fde = 0x2001,
284 DW_AT_MIPS_loop_begin = 0x2002,
285 DW_AT_MIPS_tail_loop_begin = 0x2003,
286 DW_AT_MIPS_epilog_begin = 0x2004,
287 DW_AT_MIPS_loop_unroll_factor = 0x2005,
288 DW_AT_MIPS_software_pipeline_depth = 0x2006,
289 DW_AT_MIPS_linkage_name = 0x2007,
290 DW_AT_MIPS_stride = 0x2008,
291 DW_AT_MIPS_abstract_name = 0x2009,
292 DW_AT_MIPS_clone_origin = 0x200a,
293 DW_AT_MIPS_has_inlines = 0x200b,
294 /* GNU extensions. */
295 DW_AT_sf_names = 0x2101,
296 DW_AT_src_info = 0x2102,
297 DW_AT_mac_info = 0x2103,
298 DW_AT_src_coords = 0x2104,
299 DW_AT_body_begin = 0x2105,
300 DW_AT_body_end = 0x2106
303 #define DW_AT_lo_user 0x2000 /* implementation-defined range start */
304 #define DW_AT_hi_user 0x3ff0 /* implementation-defined range end */
306 /* Location atom names and codes. */
308 enum dwarf_location_atom
310 DW_OP_addr = 0x03,
311 DW_OP_deref = 0x06,
312 DW_OP_const1u = 0x08,
313 DW_OP_const1s = 0x09,
314 DW_OP_const2u = 0x0a,
315 DW_OP_const2s = 0x0b,
316 DW_OP_const4u = 0x0c,
317 DW_OP_const4s = 0x0d,
318 DW_OP_const8u = 0x0e,
319 DW_OP_const8s = 0x0f,
320 DW_OP_constu = 0x10,
321 DW_OP_consts = 0x11,
322 DW_OP_dup = 0x12,
323 DW_OP_drop = 0x13,
324 DW_OP_over = 0x14,
325 DW_OP_pick = 0x15,
326 DW_OP_swap = 0x16,
327 DW_OP_rot = 0x17,
328 DW_OP_xderef = 0x18,
329 DW_OP_abs = 0x19,
330 DW_OP_and = 0x1a,
331 DW_OP_div = 0x1b,
332 DW_OP_minus = 0x1c,
333 DW_OP_mod = 0x1d,
334 DW_OP_mul = 0x1e,
335 DW_OP_neg = 0x1f,
336 DW_OP_not = 0x20,
337 DW_OP_or = 0x21,
338 DW_OP_plus = 0x22,
339 DW_OP_plus_uconst = 0x23,
340 DW_OP_shl = 0x24,
341 DW_OP_shr = 0x25,
342 DW_OP_shra = 0x26,
343 DW_OP_xor = 0x27,
344 DW_OP_bra = 0x28,
345 DW_OP_eq = 0x29,
346 DW_OP_ge = 0x2a,
347 DW_OP_gt = 0x2b,
348 DW_OP_le = 0x2c,
349 DW_OP_lt = 0x2d,
350 DW_OP_ne = 0x2e,
351 DW_OP_skip = 0x2f,
352 DW_OP_lit0 = 0x30,
353 DW_OP_lit1 = 0x31,
354 DW_OP_lit2 = 0x32,
355 DW_OP_lit3 = 0x33,
356 DW_OP_lit4 = 0x34,
357 DW_OP_lit5 = 0x35,
358 DW_OP_lit6 = 0x36,
359 DW_OP_lit7 = 0x37,
360 DW_OP_lit8 = 0x38,
361 DW_OP_lit9 = 0x39,
362 DW_OP_lit10 = 0x3a,
363 DW_OP_lit11 = 0x3b,
364 DW_OP_lit12 = 0x3c,
365 DW_OP_lit13 = 0x3d,
366 DW_OP_lit14 = 0x3e,
367 DW_OP_lit15 = 0x3f,
368 DW_OP_lit16 = 0x40,
369 DW_OP_lit17 = 0x41,
370 DW_OP_lit18 = 0x42,
371 DW_OP_lit19 = 0x43,
372 DW_OP_lit20 = 0x44,
373 DW_OP_lit21 = 0x45,
374 DW_OP_lit22 = 0x46,
375 DW_OP_lit23 = 0x47,
376 DW_OP_lit24 = 0x48,
377 DW_OP_lit25 = 0x49,
378 DW_OP_lit26 = 0x4a,
379 DW_OP_lit27 = 0x4b,
380 DW_OP_lit28 = 0x4c,
381 DW_OP_lit29 = 0x4d,
382 DW_OP_lit30 = 0x4e,
383 DW_OP_lit31 = 0x4f,
384 DW_OP_reg0 = 0x50,
385 DW_OP_reg1 = 0x51,
386 DW_OP_reg2 = 0x52,
387 DW_OP_reg3 = 0x53,
388 DW_OP_reg4 = 0x54,
389 DW_OP_reg5 = 0x55,
390 DW_OP_reg6 = 0x56,
391 DW_OP_reg7 = 0x57,
392 DW_OP_reg8 = 0x58,
393 DW_OP_reg9 = 0x59,
394 DW_OP_reg10 = 0x5a,
395 DW_OP_reg11 = 0x5b,
396 DW_OP_reg12 = 0x5c,
397 DW_OP_reg13 = 0x5d,
398 DW_OP_reg14 = 0x5e,
399 DW_OP_reg15 = 0x5f,
400 DW_OP_reg16 = 0x60,
401 DW_OP_reg17 = 0x61,
402 DW_OP_reg18 = 0x62,
403 DW_OP_reg19 = 0x63,
404 DW_OP_reg20 = 0x64,
405 DW_OP_reg21 = 0x65,
406 DW_OP_reg22 = 0x66,
407 DW_OP_reg23 = 0x67,
408 DW_OP_reg24 = 0x68,
409 DW_OP_reg25 = 0x69,
410 DW_OP_reg26 = 0x6a,
411 DW_OP_reg27 = 0x6b,
412 DW_OP_reg28 = 0x6c,
413 DW_OP_reg29 = 0x6d,
414 DW_OP_reg30 = 0x6e,
415 DW_OP_reg31 = 0x6f,
416 DW_OP_breg0 = 0x70,
417 DW_OP_breg1 = 0x71,
418 DW_OP_breg2 = 0x72,
419 DW_OP_breg3 = 0x73,
420 DW_OP_breg4 = 0x74,
421 DW_OP_breg5 = 0x75,
422 DW_OP_breg6 = 0x76,
423 DW_OP_breg7 = 0x77,
424 DW_OP_breg8 = 0x78,
425 DW_OP_breg9 = 0x79,
426 DW_OP_breg10 = 0x7a,
427 DW_OP_breg11 = 0x7b,
428 DW_OP_breg12 = 0x7c,
429 DW_OP_breg13 = 0x7d,
430 DW_OP_breg14 = 0x7e,
431 DW_OP_breg15 = 0x7f,
432 DW_OP_breg16 = 0x80,
433 DW_OP_breg17 = 0x81,
434 DW_OP_breg18 = 0x82,
435 DW_OP_breg19 = 0x83,
436 DW_OP_breg20 = 0x84,
437 DW_OP_breg21 = 0x85,
438 DW_OP_breg22 = 0x86,
439 DW_OP_breg23 = 0x87,
440 DW_OP_breg24 = 0x88,
441 DW_OP_breg25 = 0x89,
442 DW_OP_breg26 = 0x8a,
443 DW_OP_breg27 = 0x8b,
444 DW_OP_breg28 = 0x8c,
445 DW_OP_breg29 = 0x8d,
446 DW_OP_breg30 = 0x8e,
447 DW_OP_breg31 = 0x8f,
448 DW_OP_regx = 0x90,
449 DW_OP_fbreg = 0x91,
450 DW_OP_bregx = 0x92,
451 DW_OP_piece = 0x93,
452 DW_OP_deref_size = 0x94,
453 DW_OP_xderef_size = 0x95,
454 DW_OP_nop = 0x96
457 #define DW_OP_lo_user 0x80 /* implementation-defined range start */
458 #define DW_OP_hi_user 0xff /* implementation-defined range end */
460 /* Type encodings. */
462 enum dwarf_type
464 DW_ATE_void = 0x0,
465 DW_ATE_address = 0x1,
466 DW_ATE_boolean = 0x2,
467 DW_ATE_complex_float = 0x3,
468 DW_ATE_float = 0x4,
469 DW_ATE_signed = 0x5,
470 DW_ATE_signed_char = 0x6,
471 DW_ATE_unsigned = 0x7,
472 DW_ATE_unsigned_char = 0x8
475 #define DW_ATE_lo_user 0x80
476 #define DW_ATE_hi_user 0xff
478 /* Array ordering names and codes. */
479 enum dwarf_array_dim_ordering
481 DW_ORD_row_major = 0,
482 DW_ORD_col_major = 1
485 /* access attribute */
486 enum dwarf_access_attribute
488 DW_ACCESS_public = 1,
489 DW_ACCESS_protected = 2,
490 DW_ACCESS_private = 3
493 /* visibility */
494 enum dwarf_visibility_attribute
496 DW_VIS_local = 1,
497 DW_VIS_exported = 2,
498 DW_VIS_qualified = 3
501 /* virtuality */
502 enum dwarf_virtuality_attribute
504 DW_VIRTUALITY_none = 0,
505 DW_VIRTUALITY_virtual = 1,
506 DW_VIRTUALITY_pure_virtual = 2
509 /* case sensitivity */
510 enum dwarf_id_case
512 DW_ID_case_sensitive = 0,
513 DW_ID_up_case = 1,
514 DW_ID_down_case = 2,
515 DW_ID_case_insensitive = 3
518 /* calling convention */
519 enum dwarf_calling_convention
521 DW_CC_normal = 0x1,
522 DW_CC_program = 0x2,
523 DW_CC_nocall = 0x3
526 #define DW_CC_lo_user 0x40
527 #define DW_CC_hi_user 0xff
529 /* inline attribute */
530 enum dwarf_inline_attribute
532 DW_INL_not_inlined = 0,
533 DW_INL_inlined = 1,
534 DW_INL_declared_not_inlined = 2,
535 DW_INL_declared_inlined = 3
538 /* descriminant lists */
539 enum dwarf_descrim_list
541 DW_DSC_label = 0,
542 DW_DSC_range = 1
545 /* line number opcodes */
546 enum dwarf_line_number_ops
548 DW_LNS_extended_op = 0,
549 DW_LNS_copy = 1,
550 DW_LNS_advance_pc = 2,
551 DW_LNS_advance_line = 3,
552 DW_LNS_set_file = 4,
553 DW_LNS_set_column = 5,
554 DW_LNS_negate_stmt = 6,
555 DW_LNS_set_basic_block = 7,
556 DW_LNS_const_add_pc = 8,
557 DW_LNS_fixed_advance_pc = 9
560 /* line number extended opcodes */
561 enum dwarf_line_number_x_ops
563 DW_LNE_end_sequence = 1,
564 DW_LNE_set_address = 2,
565 DW_LNE_define_file = 3
568 /* call frame information */
569 enum dwarf_call_frame_info
571 DW_CFA_advance_loc = 0x40,
572 DW_CFA_offset = 0x80,
573 DW_CFA_restore = 0xc0,
574 DW_CFA_nop = 0x00,
575 DW_CFA_set_loc = 0x01,
576 DW_CFA_advance_loc1 = 0x02,
577 DW_CFA_advance_loc2 = 0x03,
578 DW_CFA_advance_loc4 = 0x04,
579 DW_CFA_offset_extended = 0x05,
580 DW_CFA_restore_extended = 0x06,
581 DW_CFA_undefined = 0x07,
582 DW_CFA_same_value = 0x08,
583 DW_CFA_register = 0x09,
584 DW_CFA_remember_state = 0x0a,
585 DW_CFA_restore_state = 0x0b,
586 DW_CFA_def_cfa = 0x0c,
587 DW_CFA_def_cfa_register = 0x0d,
588 DW_CFA_def_cfa_offset = 0x0e,
589 /* SGI/MIPS specific */
590 DW_CFA_MIPS_advance_loc8 = 0x1d
593 #define DW_CIE_ID 0xffffffff
594 #define DW_CIE_VERSION 1
596 #define DW_CFA_extended 0
597 #define DW_CFA_low_user 0x1c
598 #define DW_CFA_high_user 0x3f
600 #define DW_CHILDREN_no 0x00
601 #define DW_CHILDREN_yes 0x01
603 #define DW_ADDR_none 0
605 /* Source language names and codes. */
607 enum dwarf_source_language
609 DW_LANG_C89 = 0x0001,
610 DW_LANG_C = 0x0002,
611 DW_LANG_Ada83 = 0x0003,
612 DW_LANG_C_plus_plus = 0x0004,
613 DW_LANG_Cobol74 = 0x0005,
614 DW_LANG_Cobol85 = 0x0006,
615 DW_LANG_Fortran77 = 0x0007,
616 DW_LANG_Fortran90 = 0x0008,
617 DW_LANG_Pascal83 = 0x0009,
618 DW_LANG_Modula2 = 0x000a,
619 DW_LANG_Mips_Assembler = 0x8001
623 #define DW_LANG_lo_user 0x8000 /* implementation-defined range start */
624 #define DW_LANG_hi_user 0xffff /* implementation-defined range start */
626 /* Names and codes for macro information. */
628 enum dwarf_macinfo_record_type
630 DW_MACINFO_define = 1,
631 DW_MACINFO_undef = 2,
632 DW_MACINFO_start_file = 3,
633 DW_MACINFO_end_file = 4,
634 DW_MACINFO_vendor_ext = 255
637 #endif /* _ELF_DWARF2_H */