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