gimli/
constants.rs

1// This file originally from https://github.com/philipc/rust-dwarf/ and
2// distributed under either MIT or Apache 2.0 licenses.
3//
4// Copyright 2016 The rust-dwarf Developers
5//
6// Licensed under the Apache License, Version 2.0 (the "License");
7// you may not use this file except in compliance with the License.
8// You may obtain a copy of the License at
9//
10//     https://www.apache.org/licenses/LICENSE-2.0
11//
12// Unless required by applicable law or agreed to in writing, software
13// distributed under the License is distributed on an "AS IS" BASIS,
14// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15// See the License for the specific language governing permissions and
16// limitations under the License.
17
18//! Constant definitions.
19//!
20//! The DWARF spec's `DW_AT_*` type is represented as `struct DwAt(u16)`,
21//! `DW_FORM_*` as `DwForm(u16)`, etc.
22//!
23//! There are also exported const definitions for each constant.
24
25#![allow(non_upper_case_globals)]
26#![allow(missing_docs)]
27
28use core::{fmt, ops};
29
30// The `dw!` macro turns this:
31//
32//     dw!(DwFoo(u32) {
33//         DW_FOO_bar = 0,
34//         DW_FOO_baz = 1,
35//         DW_FOO_bang = 2,
36//     });
37//
38// into this:
39//
40//     #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]
41//     pub struct DwFoo(pub u32);
42//
43//     pub const DW_FOO_bar: DwFoo = DwFoo(0);
44//     pub const DW_FOO_baz: DwFoo = DwFoo(1);
45//     pub const DW_FOO_bang: DwFoo = DwFoo(2);
46//
47//     impl DwFoo {
48//         pub fn static_string(&self) -> Option<&'static str> {
49//             ...
50//         }
51//     }
52//
53//     impl fmt::Display for DwFoo {
54//         fn fmt(&self, f: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> {
55//             ...
56//         }
57//     }
58macro_rules! dw {
59    ($(#[$meta:meta])* $struct_name:ident($struct_type:ty)
60        { $($name:ident = $val:expr),+ $(,)? }
61        $(, aliases { $($alias_name:ident = $alias_val:expr),+ $(,)? })?
62    ) => {
63        $(#[$meta])*
64        #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]
65        pub struct $struct_name(pub $struct_type);
66
67        $(
68            pub const $name: $struct_name = $struct_name($val);
69        )+
70        $($(
71            pub const $alias_name: $struct_name = $struct_name($alias_val);
72        )+)*
73
74        impl $struct_name {
75            pub fn static_string(&self) -> Option<&'static str> {
76                Some(match *self {
77                    $(
78                        $name => stringify!($name),
79                    )+
80                    _ => return None,
81                })
82            }
83        }
84
85        impl fmt::Display for $struct_name {
86            fn fmt(&self, f: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> {
87                if let Some(s) = self.static_string() {
88                    f.pad(s)
89                } else {
90                    #[cfg(feature = "read")]
91                    {
92                        f.pad(&format!("Unknown {}: {}", stringify!($struct_name), self.0))
93                    }
94                    #[cfg(not(feature = "read"))]
95                    {
96                        write!(f, "Unknown {}: {}", stringify!($struct_name), self.0)
97                    }
98                }
99            }
100        }
101    };
102}
103
104dw!(
105/// The section type field in a `.dwp` unit index.
106///
107/// This is used for version 5 and later.
108///
109/// See Section 7.3.5.
110DwSect(u32) {
111    DW_SECT_INFO = 1,
112    DW_SECT_ABBREV = 3,
113    DW_SECT_LINE = 4,
114    DW_SECT_LOCLISTS = 5,
115    DW_SECT_STR_OFFSETS = 6,
116    DW_SECT_MACRO = 7,
117    DW_SECT_RNGLISTS = 8,
118});
119
120dw!(
121/// The section type field in a `.dwp` unit index with version 2.
122DwSectV2(u32) {
123    DW_SECT_V2_INFO = 1,
124    DW_SECT_V2_TYPES = 2,
125    DW_SECT_V2_ABBREV = 3,
126    DW_SECT_V2_LINE = 4,
127    DW_SECT_V2_LOC = 5,
128    DW_SECT_V2_STR_OFFSETS = 6,
129    DW_SECT_V2_MACINFO = 7,
130    DW_SECT_V2_MACRO = 8,
131});
132
133dw!(
134/// The unit type field in a unit header.
135///
136/// See Section 7.5.1, Table 7.2.
137DwUt(u8) {
138    DW_UT_compile = 0x01,
139    DW_UT_type = 0x02,
140    DW_UT_partial = 0x03,
141    DW_UT_skeleton = 0x04,
142    DW_UT_split_compile = 0x05,
143    DW_UT_split_type = 0x06,
144    DW_UT_lo_user = 0x80,
145    DW_UT_hi_user = 0xff,
146});
147
148dw!(
149/// The opcode for a call frame instruction.
150///
151/// Section 7.24:
152/// > Call frame instructions are encoded in one or more bytes. The primary
153/// > opcode is encoded in the high order two bits of the first byte (that is,
154/// > opcode = byte >> 6). An operand or extended opcode may be encoded in the
155/// > low order 6 bits. Additional operands are encoded in subsequent bytes.
156DwCfa(u8) {
157    DW_CFA_advance_loc = 0x01 << 6,
158    DW_CFA_offset = 0x02 << 6,
159    DW_CFA_restore = 0x03 << 6,
160    DW_CFA_nop = 0,
161    DW_CFA_set_loc = 0x01,
162    DW_CFA_advance_loc1 = 0x02,
163    DW_CFA_advance_loc2 = 0x03,
164    DW_CFA_advance_loc4 = 0x04,
165    DW_CFA_offset_extended = 0x05,
166    DW_CFA_restore_extended = 0x06,
167    DW_CFA_undefined = 0x07,
168    DW_CFA_same_value = 0x08,
169    DW_CFA_register = 0x09,
170    DW_CFA_remember_state = 0x0a,
171    DW_CFA_restore_state = 0x0b,
172    DW_CFA_def_cfa = 0x0c,
173    DW_CFA_def_cfa_register = 0x0d,
174    DW_CFA_def_cfa_offset = 0x0e,
175    DW_CFA_def_cfa_expression = 0x0f,
176    DW_CFA_expression = 0x10,
177    DW_CFA_offset_extended_sf = 0x11,
178    DW_CFA_def_cfa_sf = 0x12,
179    DW_CFA_def_cfa_offset_sf = 0x13,
180    DW_CFA_val_offset = 0x14,
181    DW_CFA_val_offset_sf = 0x15,
182    DW_CFA_val_expression = 0x16,
183
184    DW_CFA_lo_user = 0x1c,
185    DW_CFA_hi_user = 0x3f,
186
187    DW_CFA_MIPS_advance_loc8 = 0x1d,
188    DW_CFA_GNU_window_save = 0x2d,
189    DW_CFA_GNU_args_size = 0x2e,
190    DW_CFA_GNU_negative_offset_extended = 0x2f,
191},
192aliases {
193    DW_CFA_AARCH64_negate_ra_state = 0x2d,
194});
195
196dw!(
197/// The child determination encodings for DIE attributes.
198///
199/// See Section 7.5.3, Table 7.4.
200DwChildren(u8) {
201    DW_CHILDREN_no = 0,
202    DW_CHILDREN_yes = 1,
203});
204
205dw!(
206/// The tag encodings for DIE attributes.
207///
208/// See Section 7.5.3, Table 7.3.
209DwTag(u16) {
210    DW_TAG_null = 0x00,
211
212// DWARF 1 only, obsolete in DWARF 2+.
213    DW_TAG_global_subroutine = 0x06,
214    DW_TAG_global_variable = 0x07,
215    DW_TAG_local_variable = 0x0c,
216    DW_TAG_subroutine = 0x14,
217
218// DWARF 1.
219    DW_TAG_array_type = 0x01,
220    DW_TAG_class_type = 0x02,
221    DW_TAG_entry_point = 0x03,
222    DW_TAG_enumeration_type = 0x04,
223    DW_TAG_formal_parameter = 0x05,
224    DW_TAG_imported_declaration = 0x08,
225    DW_TAG_label = 0x0a,
226    DW_TAG_lexical_block = 0x0b,
227    DW_TAG_member = 0x0d,
228    DW_TAG_pointer_type = 0x0f,
229    DW_TAG_reference_type = 0x10,
230    DW_TAG_compile_unit = 0x11,
231    DW_TAG_string_type = 0x12,
232    DW_TAG_structure_type = 0x13,
233    DW_TAG_subroutine_type = 0x15,
234    DW_TAG_typedef = 0x16,
235    DW_TAG_union_type = 0x17,
236    DW_TAG_unspecified_parameters = 0x18,
237    DW_TAG_variant = 0x19,
238    DW_TAG_common_block = 0x1a,
239    DW_TAG_common_inclusion = 0x1b,
240    DW_TAG_inheritance = 0x1c,
241    DW_TAG_inlined_subroutine = 0x1d,
242    DW_TAG_module = 0x1e,
243    DW_TAG_ptr_to_member_type = 0x1f,
244    DW_TAG_set_type = 0x20,
245    DW_TAG_subrange_type = 0x21,
246    DW_TAG_with_stmt = 0x22,
247
248// DWARF 2.
249    DW_TAG_access_declaration = 0x23,
250    DW_TAG_base_type = 0x24,
251    DW_TAG_catch_block = 0x25,
252    DW_TAG_const_type = 0x26,
253    DW_TAG_constant = 0x27,
254    DW_TAG_enumerator = 0x28,
255    DW_TAG_file_type = 0x29,
256    DW_TAG_friend = 0x2a,
257    DW_TAG_namelist = 0x2b,
258    DW_TAG_namelist_item = 0x2c,
259    DW_TAG_packed_type = 0x2d,
260    DW_TAG_subprogram = 0x2e,
261    DW_TAG_template_type_parameter = 0x2f,
262    DW_TAG_template_value_parameter = 0x30,
263    DW_TAG_thrown_type = 0x31,
264    DW_TAG_try_block = 0x32,
265    DW_TAG_variant_part = 0x33,
266    DW_TAG_variable = 0x34,
267    DW_TAG_volatile_type = 0x35,
268
269// DWARF 3.
270    DW_TAG_dwarf_procedure = 0x36,
271    DW_TAG_restrict_type = 0x37,
272    DW_TAG_interface_type = 0x38,
273    DW_TAG_namespace = 0x39,
274    DW_TAG_imported_module = 0x3a,
275    DW_TAG_unspecified_type = 0x3b,
276    DW_TAG_partial_unit = 0x3c,
277    DW_TAG_imported_unit = 0x3d,
278    DW_TAG_condition = 0x3f,
279    DW_TAG_shared_type = 0x40,
280
281// DWARF 4.
282    DW_TAG_type_unit = 0x41,
283    DW_TAG_rvalue_reference_type = 0x42,
284    DW_TAG_template_alias = 0x43,
285
286// DWARF 5.
287    DW_TAG_coarray_type = 0x44,
288    DW_TAG_generic_subrange = 0x45,
289    DW_TAG_dynamic_type = 0x46,
290    DW_TAG_atomic_type = 0x47,
291    DW_TAG_call_site = 0x48,
292    DW_TAG_call_site_parameter = 0x49,
293    DW_TAG_skeleton_unit = 0x4a,
294    DW_TAG_immutable_type = 0x4b,
295
296    DW_TAG_lo_user = 0x4080,
297    DW_TAG_hi_user = 0xffff,
298
299// SGI/MIPS extensions.
300    DW_TAG_MIPS_loop = 0x4081,
301
302// HP extensions.
303    DW_TAG_HP_array_descriptor = 0x4090,
304    DW_TAG_HP_Bliss_field = 0x4091,
305    DW_TAG_HP_Bliss_field_set = 0x4092,
306
307// GNU extensions.
308    DW_TAG_format_label = 0x4101,
309    DW_TAG_function_template = 0x4102,
310    DW_TAG_class_template = 0x4103,
311    DW_TAG_GNU_BINCL = 0x4104,
312    DW_TAG_GNU_EINCL = 0x4105,
313    DW_TAG_GNU_template_template_param = 0x4106,
314    DW_TAG_GNU_template_parameter_pack = 0x4107,
315    DW_TAG_GNU_formal_parameter_pack = 0x4108,
316    DW_TAG_GNU_call_site = 0x4109,
317    DW_TAG_GNU_call_site_parameter = 0x410a,
318
319    DW_TAG_APPLE_property = 0x4200,
320
321// SUN extensions.
322    DW_TAG_SUN_function_template = 0x4201,
323    DW_TAG_SUN_class_template = 0x4202,
324    DW_TAG_SUN_struct_template = 0x4203,
325    DW_TAG_SUN_union_template = 0x4204,
326    DW_TAG_SUN_indirect_inheritance = 0x4205,
327    DW_TAG_SUN_codeflags = 0x4206,
328    DW_TAG_SUN_memop_info = 0x4207,
329    DW_TAG_SUN_omp_child_func = 0x4208,
330    DW_TAG_SUN_rtti_descriptor = 0x4209,
331    DW_TAG_SUN_dtor_info = 0x420a,
332    DW_TAG_SUN_dtor = 0x420b,
333    DW_TAG_SUN_f90_interface = 0x420c,
334    DW_TAG_SUN_fortran_vax_structure = 0x420d,
335
336// ALTIUM extensions.
337    DW_TAG_ALTIUM_circ_type = 0x5101,
338    DW_TAG_ALTIUM_mwa_circ_type = 0x5102,
339    DW_TAG_ALTIUM_rev_carry_type = 0x5103,
340    DW_TAG_ALTIUM_rom = 0x5111,
341
342// Extensions for UPC.
343    DW_TAG_upc_shared_type = 0x8765,
344    DW_TAG_upc_strict_type = 0x8766,
345    DW_TAG_upc_relaxed_type = 0x8767,
346
347// PGI (STMicroelectronics) extensions.
348    DW_TAG_PGI_kanji_type = 0xa000,
349    DW_TAG_PGI_interface_block = 0xa020,
350
351// Borland extensions.
352    DW_TAG_BORLAND_property = 0xb000,
353    DW_TAG_BORLAND_Delphi_string = 0xb001,
354    DW_TAG_BORLAND_Delphi_dynamic_array = 0xb002,
355    DW_TAG_BORLAND_Delphi_set = 0xb003,
356    DW_TAG_BORLAND_Delphi_variant = 0xb004,
357});
358
359dw!(
360/// The attribute encodings for DIE attributes.
361///
362/// See Section 7.5.4, Table 7.5.
363DwAt(u16) {
364    DW_AT_null = 0x00,
365
366// DWARF 1 only, obsolete in DWARF 2+.
367    DW_AT_fund_type = 0x05,
368    DW_AT_mod_fund_type = 0x06,
369    DW_AT_user_def_type = 0x07,
370    DW_AT_mod_u_d_type = 0x08,
371    DW_AT_subscr_data = 0x0a,
372    DW_AT_element_list = 0x0f,
373    DW_AT_member = 0x14,
374    DW_AT_friends = 0x1f,
375    DW_AT_program = 0x23,
376    DW_AT_private = 0x24,
377    DW_AT_protected = 0x26,
378    DW_AT_public = 0x28,
379    DW_AT_pure_virtual = 0x29,
380    DW_AT_virtual = 0x30,
381
382// Moved to 0x47 in DWARF 2+.
383    DW_AT_specification_v1 = 0x2b,
384
385// DWARF 1.
386    DW_AT_sibling = 0x01,
387    DW_AT_location = 0x02,
388    DW_AT_name = 0x03,
389    DW_AT_ordering = 0x09,
390    DW_AT_byte_size = 0x0b,
391    DW_AT_bit_offset = 0x0c,
392    DW_AT_bit_size = 0x0d,
393    DW_AT_stmt_list = 0x10,
394    DW_AT_low_pc = 0x11,
395    DW_AT_high_pc = 0x12,
396    DW_AT_language = 0x13,
397    DW_AT_discr = 0x15,
398    DW_AT_discr_value = 0x16,
399    DW_AT_visibility = 0x17,
400    DW_AT_import = 0x18,
401    DW_AT_string_length = 0x19,
402    DW_AT_common_reference = 0x1a,
403    DW_AT_comp_dir = 0x1b,
404    DW_AT_const_value = 0x1c,
405    DW_AT_containing_type = 0x1d,
406    DW_AT_default_value = 0x1e,
407    DW_AT_inline = 0x20,
408    DW_AT_is_optional = 0x21,
409    DW_AT_lower_bound = 0x22,
410    DW_AT_producer = 0x25,
411    DW_AT_prototyped = 0x27,
412    DW_AT_return_addr = 0x2a,
413    DW_AT_start_scope = 0x2c,
414    DW_AT_bit_stride = 0x2e,
415    DW_AT_upper_bound = 0x2f,
416
417// DWARF 2.
418    DW_AT_abstract_origin = 0x31,
419    DW_AT_accessibility = 0x32,
420    DW_AT_address_class = 0x33,
421    DW_AT_artificial = 0x34,
422    DW_AT_base_types = 0x35,
423    DW_AT_calling_convention = 0x36,
424    DW_AT_count = 0x37,
425    DW_AT_data_member_location = 0x38,
426    DW_AT_decl_column = 0x39,
427    DW_AT_decl_file = 0x3a,
428    DW_AT_decl_line = 0x3b,
429    DW_AT_declaration = 0x3c,
430    DW_AT_discr_list = 0x3d,
431    DW_AT_encoding = 0x3e,
432    DW_AT_external = 0x3f,
433    DW_AT_frame_base = 0x40,
434    DW_AT_friend = 0x41,
435    DW_AT_identifier_case = 0x42,
436    DW_AT_macro_info = 0x43,
437    DW_AT_namelist_item = 0x44,
438    DW_AT_priority = 0x45,
439    DW_AT_segment = 0x46,
440    DW_AT_specification = 0x47,
441    DW_AT_static_link = 0x48,
442    DW_AT_type = 0x49,
443    DW_AT_use_location = 0x4a,
444    DW_AT_variable_parameter = 0x4b,
445    DW_AT_virtuality = 0x4c,
446    DW_AT_vtable_elem_location = 0x4d,
447
448// DWARF 3.
449    DW_AT_allocated = 0x4e,
450    DW_AT_associated = 0x4f,
451    DW_AT_data_location = 0x50,
452    DW_AT_byte_stride = 0x51,
453    DW_AT_entry_pc = 0x52,
454    DW_AT_use_UTF8 = 0x53,
455    DW_AT_extension = 0x54,
456    DW_AT_ranges = 0x55,
457    DW_AT_trampoline = 0x56,
458    DW_AT_call_column = 0x57,
459    DW_AT_call_file = 0x58,
460    DW_AT_call_line = 0x59,
461    DW_AT_description = 0x5a,
462    DW_AT_binary_scale = 0x5b,
463    DW_AT_decimal_scale = 0x5c,
464    DW_AT_small = 0x5d,
465    DW_AT_decimal_sign = 0x5e,
466    DW_AT_digit_count = 0x5f,
467    DW_AT_picture_string = 0x60,
468    DW_AT_mutable = 0x61,
469    DW_AT_threads_scaled = 0x62,
470    DW_AT_explicit = 0x63,
471    DW_AT_object_pointer = 0x64,
472    DW_AT_endianity = 0x65,
473    DW_AT_elemental = 0x66,
474    DW_AT_pure = 0x67,
475    DW_AT_recursive = 0x68,
476
477// DWARF 4.
478    DW_AT_signature = 0x69,
479    DW_AT_main_subprogram = 0x6a,
480    DW_AT_data_bit_offset = 0x6b,
481    DW_AT_const_expr = 0x6c,
482    DW_AT_enum_class = 0x6d,
483    DW_AT_linkage_name = 0x6e,
484
485// DWARF 5.
486    DW_AT_string_length_bit_size = 0x6f,
487    DW_AT_string_length_byte_size = 0x70,
488    DW_AT_rank = 0x71,
489    DW_AT_str_offsets_base = 0x72,
490    DW_AT_addr_base = 0x73,
491    DW_AT_rnglists_base = 0x74,
492    DW_AT_dwo_name = 0x76,
493    DW_AT_reference = 0x77,
494    DW_AT_rvalue_reference = 0x78,
495    DW_AT_macros = 0x79,
496    DW_AT_call_all_calls = 0x7a,
497    DW_AT_call_all_source_calls = 0x7b,
498    DW_AT_call_all_tail_calls = 0x7c,
499    DW_AT_call_return_pc = 0x7d,
500    DW_AT_call_value = 0x7e,
501    DW_AT_call_origin = 0x7f,
502    DW_AT_call_parameter = 0x80,
503    DW_AT_call_pc = 0x81,
504    DW_AT_call_tail_call = 0x82,
505    DW_AT_call_target = 0x83,
506    DW_AT_call_target_clobbered = 0x84,
507    DW_AT_call_data_location = 0x85,
508    DW_AT_call_data_value = 0x86,
509    DW_AT_noreturn = 0x87,
510    DW_AT_alignment = 0x88,
511    DW_AT_export_symbols = 0x89,
512    DW_AT_deleted = 0x8a,
513    DW_AT_defaulted = 0x8b,
514    DW_AT_loclists_base = 0x8c,
515
516    DW_AT_lo_user = 0x2000,
517    DW_AT_hi_user = 0x3fff,
518
519// SGI/MIPS extensions.
520    DW_AT_MIPS_fde = 0x2001,
521    DW_AT_MIPS_loop_begin = 0x2002,
522    DW_AT_MIPS_tail_loop_begin = 0x2003,
523    DW_AT_MIPS_epilog_begin = 0x2004,
524    DW_AT_MIPS_loop_unroll_factor = 0x2005,
525    DW_AT_MIPS_software_pipeline_depth = 0x2006,
526    DW_AT_MIPS_linkage_name = 0x2007,
527    DW_AT_MIPS_stride = 0x2008,
528    DW_AT_MIPS_abstract_name = 0x2009,
529    DW_AT_MIPS_clone_origin = 0x200a,
530    DW_AT_MIPS_has_inlines = 0x200b,
531    DW_AT_MIPS_stride_byte = 0x200c,
532    DW_AT_MIPS_stride_elem = 0x200d,
533    DW_AT_MIPS_ptr_dopetype = 0x200e,
534    DW_AT_MIPS_allocatable_dopetype = 0x200f,
535    DW_AT_MIPS_assumed_shape_dopetype = 0x2010,
536
537// This one appears to have only been implemented by Open64 for
538// fortran and may conflict with other extensions.
539    DW_AT_MIPS_assumed_size = 0x2011,
540
541// TODO: HP/CPQ extensions.
542// These conflict with the MIPS extensions.
543
544    DW_AT_INTEL_other_endian = 0x2026,
545
546// GNU extensions
547    DW_AT_sf_names = 0x2101,
548    DW_AT_src_info = 0x2102,
549    DW_AT_mac_info = 0x2103,
550    DW_AT_src_coords = 0x2104,
551    DW_AT_body_begin = 0x2105,
552    DW_AT_body_end = 0x2106,
553    DW_AT_GNU_vector = 0x2107,
554    DW_AT_GNU_guarded_by = 0x2108,
555    DW_AT_GNU_pt_guarded_by = 0x2109,
556    DW_AT_GNU_guarded = 0x210a,
557    DW_AT_GNU_pt_guarded = 0x210b,
558    DW_AT_GNU_locks_excluded = 0x210c,
559    DW_AT_GNU_exclusive_locks_required = 0x210d,
560    DW_AT_GNU_shared_locks_required = 0x210e,
561    DW_AT_GNU_odr_signature = 0x210f,
562    DW_AT_GNU_template_name = 0x2110,
563    DW_AT_GNU_call_site_value = 0x2111,
564    DW_AT_GNU_call_site_data_value = 0x2112,
565    DW_AT_GNU_call_site_target = 0x2113,
566    DW_AT_GNU_call_site_target_clobbered = 0x2114,
567    DW_AT_GNU_tail_call = 0x2115,
568    DW_AT_GNU_all_tail_call_sites = 0x2116,
569    DW_AT_GNU_all_call_sites = 0x2117,
570    DW_AT_GNU_all_source_call_sites = 0x2118,
571    DW_AT_GNU_macros = 0x2119,
572    DW_AT_GNU_deleted = 0x211a,
573
574// Extensions for Fission proposal.
575    DW_AT_GNU_dwo_name = 0x2130,
576    DW_AT_GNU_dwo_id = 0x2131,
577    DW_AT_GNU_ranges_base = 0x2132,
578    DW_AT_GNU_addr_base = 0x2133,
579    DW_AT_GNU_pubnames = 0x2134,
580    DW_AT_GNU_pubtypes = 0x2135,
581    DW_AT_GNU_discriminator = 0x2136,
582    DW_AT_GNU_locviews = 0x2137,
583    DW_AT_GNU_entry_view = 0x2138,
584
585// Conflict with Sun.
586// DW_AT_VMS_rtnbeg_pd_address = 0x2201,
587
588// Sun extensions.
589    DW_AT_SUN_template = 0x2201,
590    DW_AT_SUN_alignment = 0x2202,
591    DW_AT_SUN_vtable = 0x2203,
592    DW_AT_SUN_count_guarantee = 0x2204,
593    DW_AT_SUN_command_line = 0x2205,
594    DW_AT_SUN_vbase = 0x2206,
595    DW_AT_SUN_compile_options = 0x2207,
596    DW_AT_SUN_language = 0x2208,
597    DW_AT_SUN_browser_file = 0x2209,
598    DW_AT_SUN_vtable_abi = 0x2210,
599    DW_AT_SUN_func_offsets = 0x2211,
600    DW_AT_SUN_cf_kind = 0x2212,
601    DW_AT_SUN_vtable_index = 0x2213,
602    DW_AT_SUN_omp_tpriv_addr = 0x2214,
603    DW_AT_SUN_omp_child_func = 0x2215,
604    DW_AT_SUN_func_offset = 0x2216,
605    DW_AT_SUN_memop_type_ref = 0x2217,
606    DW_AT_SUN_profile_id = 0x2218,
607    DW_AT_SUN_memop_signature = 0x2219,
608    DW_AT_SUN_obj_dir = 0x2220,
609    DW_AT_SUN_obj_file = 0x2221,
610    DW_AT_SUN_original_name = 0x2222,
611    DW_AT_SUN_hwcprof_signature = 0x2223,
612    DW_AT_SUN_amd64_parmdump = 0x2224,
613    DW_AT_SUN_part_link_name = 0x2225,
614    DW_AT_SUN_link_name = 0x2226,
615    DW_AT_SUN_pass_with_const = 0x2227,
616    DW_AT_SUN_return_with_const = 0x2228,
617    DW_AT_SUN_import_by_name = 0x2229,
618    DW_AT_SUN_f90_pointer = 0x222a,
619    DW_AT_SUN_pass_by_ref = 0x222b,
620    DW_AT_SUN_f90_allocatable = 0x222c,
621    DW_AT_SUN_f90_assumed_shape_array = 0x222d,
622    DW_AT_SUN_c_vla = 0x222e,
623    DW_AT_SUN_return_value_ptr = 0x2230,
624    DW_AT_SUN_dtor_start = 0x2231,
625    DW_AT_SUN_dtor_length = 0x2232,
626    DW_AT_SUN_dtor_state_initial = 0x2233,
627    DW_AT_SUN_dtor_state_final = 0x2234,
628    DW_AT_SUN_dtor_state_deltas = 0x2235,
629    DW_AT_SUN_import_by_lname = 0x2236,
630    DW_AT_SUN_f90_use_only = 0x2237,
631    DW_AT_SUN_namelist_spec = 0x2238,
632    DW_AT_SUN_is_omp_child_func = 0x2239,
633    DW_AT_SUN_fortran_main_alias = 0x223a,
634    DW_AT_SUN_fortran_based = 0x223b,
635
636    DW_AT_ALTIUM_loclist = 0x2300,
637
638    DW_AT_use_GNAT_descriptive_type = 0x2301,
639    DW_AT_GNAT_descriptive_type = 0x2302,
640    DW_AT_GNU_numerator = 0x2303,
641    DW_AT_GNU_denominator = 0x2304,
642    DW_AT_GNU_bias = 0x2305,
643
644    DW_AT_upc_threads_scaled = 0x3210,
645
646// PGI (STMicroelectronics) extensions.
647    DW_AT_PGI_lbase = 0x3a00,
648    DW_AT_PGI_soffset = 0x3a01,
649    DW_AT_PGI_lstride = 0x3a02,
650
651// Borland extensions.
652    DW_AT_BORLAND_property_read = 0x3b11,
653    DW_AT_BORLAND_property_write = 0x3b12,
654    DW_AT_BORLAND_property_implements = 0x3b13,
655    DW_AT_BORLAND_property_index = 0x3b14,
656    DW_AT_BORLAND_property_default = 0x3b15,
657    DW_AT_BORLAND_Delphi_unit = 0x3b20,
658    DW_AT_BORLAND_Delphi_class = 0x3b21,
659    DW_AT_BORLAND_Delphi_record = 0x3b22,
660    DW_AT_BORLAND_Delphi_metaclass = 0x3b23,
661    DW_AT_BORLAND_Delphi_constructor = 0x3b24,
662    DW_AT_BORLAND_Delphi_destructor = 0x3b25,
663    DW_AT_BORLAND_Delphi_anonymous_method = 0x3b26,
664    DW_AT_BORLAND_Delphi_interface = 0x3b27,
665    DW_AT_BORLAND_Delphi_ABI = 0x3b28,
666    DW_AT_BORLAND_Delphi_return = 0x3b29,
667    DW_AT_BORLAND_Delphi_frameptr = 0x3b30,
668    DW_AT_BORLAND_closure = 0x3b31,
669
670// LLVM project extensions.
671    DW_AT_LLVM_include_path = 0x3e00,
672    DW_AT_LLVM_config_macros = 0x3e01,
673    DW_AT_LLVM_isysroot = 0x3e02,
674
675// Apple extensions.
676    DW_AT_APPLE_optimized = 0x3fe1,
677    DW_AT_APPLE_flags = 0x3fe2,
678    DW_AT_APPLE_isa = 0x3fe3,
679    DW_AT_APPLE_block = 0x3fe4,
680    DW_AT_APPLE_major_runtime_vers = 0x3fe5,
681    DW_AT_APPLE_runtime_class = 0x3fe6,
682    DW_AT_APPLE_omit_frame_ptr = 0x3fe7,
683    DW_AT_APPLE_property_name = 0x3fe8,
684    DW_AT_APPLE_property_getter = 0x3fe9,
685    DW_AT_APPLE_property_setter = 0x3fea,
686    DW_AT_APPLE_property_attribute = 0x3feb,
687    DW_AT_APPLE_objc_complete_type = 0x3fec,
688    DW_AT_APPLE_property = 0x3fed
689});
690
691dw!(
692/// The attribute form encodings for DIE attributes.
693///
694/// See Section 7.5.6, Table 7.6.
695DwForm(u16) {
696    DW_FORM_null = 0x00,
697
698// DWARF 1 only, obsolete in DWARF 2+.
699    DW_FORM_ref = 0x02,
700
701// DWARF 1.
702    DW_FORM_addr = 0x01,
703    DW_FORM_block2 = 0x03,
704    DW_FORM_block4 = 0x04,
705    DW_FORM_data2 = 0x05,
706    DW_FORM_data4 = 0x06,
707    DW_FORM_data8 = 0x07,
708    DW_FORM_string = 0x08,
709
710// DWARF 2.
711    DW_FORM_block = 0x09,
712    DW_FORM_block1 = 0x0a,
713    DW_FORM_data1 = 0x0b,
714    DW_FORM_flag = 0x0c,
715    DW_FORM_sdata = 0x0d,
716    DW_FORM_strp = 0x0e,
717    DW_FORM_udata = 0x0f,
718    DW_FORM_ref_addr = 0x10,
719    DW_FORM_ref1 = 0x11,
720    DW_FORM_ref2 = 0x12,
721    DW_FORM_ref4 = 0x13,
722    DW_FORM_ref8 = 0x14,
723    DW_FORM_ref_udata = 0x15,
724    DW_FORM_indirect = 0x16,
725
726// DWARF 4.
727    DW_FORM_sec_offset = 0x17,
728    DW_FORM_exprloc = 0x18,
729    DW_FORM_flag_present = 0x19,
730    DW_FORM_ref_sig8 = 0x20,
731
732// DWARF 5.
733    DW_FORM_strx = 0x1a,
734    DW_FORM_addrx = 0x1b,
735    DW_FORM_ref_sup4 = 0x1c,
736    DW_FORM_strp_sup = 0x1d,
737    DW_FORM_data16 = 0x1e,
738    DW_FORM_line_strp = 0x1f,
739    DW_FORM_implicit_const = 0x21,
740    DW_FORM_loclistx = 0x22,
741    DW_FORM_rnglistx = 0x23,
742    DW_FORM_ref_sup8 = 0x24,
743    DW_FORM_strx1 = 0x25,
744    DW_FORM_strx2 = 0x26,
745    DW_FORM_strx3 = 0x27,
746    DW_FORM_strx4 = 0x28,
747    DW_FORM_addrx1 = 0x29,
748    DW_FORM_addrx2 = 0x2a,
749    DW_FORM_addrx3 = 0x2b,
750    DW_FORM_addrx4 = 0x2c,
751
752// Extensions for Fission proposal
753    DW_FORM_GNU_addr_index = 0x1f01,
754    DW_FORM_GNU_str_index = 0x1f02,
755
756// Alternate debug sections proposal (output of "dwz" tool).
757    DW_FORM_GNU_ref_alt = 0x1f20,
758    DW_FORM_GNU_strp_alt = 0x1f21
759});
760
761dw!(
762/// The encodings of the constants used in the `DW_AT_encoding` attribute.
763///
764/// See Section 7.8, Table 7.11.
765DwAte(u8) {
766    DW_ATE_address = 0x01,
767    DW_ATE_boolean = 0x02,
768    DW_ATE_complex_float = 0x03,
769    DW_ATE_float = 0x04,
770    DW_ATE_signed = 0x05,
771    DW_ATE_signed_char = 0x06,
772    DW_ATE_unsigned = 0x07,
773    DW_ATE_unsigned_char = 0x08,
774
775// DWARF 3.
776    DW_ATE_imaginary_float = 0x09,
777    DW_ATE_packed_decimal = 0x0a,
778    DW_ATE_numeric_string = 0x0b,
779    DW_ATE_edited = 0x0c,
780    DW_ATE_signed_fixed = 0x0d,
781    DW_ATE_unsigned_fixed = 0x0e,
782    DW_ATE_decimal_float = 0x0f ,
783
784// DWARF 4.
785    DW_ATE_UTF = 0x10,
786    DW_ATE_UCS = 0x11,
787    DW_ATE_ASCII = 0x12,
788
789    DW_ATE_lo_user = 0x80,
790    DW_ATE_hi_user = 0xff,
791});
792
793dw!(
794/// The encodings of the constants used in location list entries.
795///
796/// See Section 7.7.3, Table 7.10.
797DwLle(u8) {
798    DW_LLE_end_of_list = 0x00,
799    DW_LLE_base_addressx = 0x01,
800    DW_LLE_startx_endx = 0x02,
801    DW_LLE_startx_length = 0x03,
802    DW_LLE_offset_pair = 0x04,
803    DW_LLE_default_location = 0x05,
804    DW_LLE_base_address = 0x06,
805    DW_LLE_start_end = 0x07,
806    DW_LLE_start_length = 0x08,
807    DW_LLE_GNU_view_pair = 0x09,
808});
809
810dw!(
811/// The encodings of the constants used in the `DW_AT_decimal_sign` attribute.
812///
813/// See Section 7.8, Table 7.12.
814DwDs(u8) {
815    DW_DS_unsigned = 0x01,
816    DW_DS_leading_overpunch = 0x02,
817    DW_DS_trailing_overpunch = 0x03,
818    DW_DS_leading_separate = 0x04,
819    DW_DS_trailing_separate = 0x05,
820});
821
822dw!(
823/// The encodings of the constants used in the `DW_AT_endianity` attribute.
824///
825/// See Section 7.8, Table 7.13.
826DwEnd(u8) {
827    DW_END_default = 0x00,
828    DW_END_big = 0x01,
829    DW_END_little = 0x02,
830    DW_END_lo_user = 0x40,
831    DW_END_hi_user = 0xff,
832});
833
834dw!(
835/// The encodings of the constants used in the `DW_AT_accessibility` attribute.
836///
837/// See Section 7.9, Table 7.14.
838DwAccess(u8) {
839    DW_ACCESS_public = 0x01,
840    DW_ACCESS_protected = 0x02,
841    DW_ACCESS_private = 0x03,
842});
843
844dw!(
845/// The encodings of the constants used in the `DW_AT_visibility` attribute.
846///
847/// See Section 7.10, Table 7.15.
848DwVis(u8) {
849    DW_VIS_local = 0x01,
850    DW_VIS_exported = 0x02,
851    DW_VIS_qualified = 0x03,
852});
853
854dw!(
855/// The encodings of the constants used in the `DW_AT_virtuality` attribute.
856///
857/// See Section 7.11, Table 7.16.
858DwVirtuality(u8) {
859    DW_VIRTUALITY_none = 0x00,
860    DW_VIRTUALITY_virtual = 0x01,
861    DW_VIRTUALITY_pure_virtual = 0x02,
862});
863
864dw!(
865/// The encodings of the constants used in the `DW_AT_language` attribute.
866///
867/// See Section 7.12, Table 7.17.
868DwLang(u16) {
869    DW_LANG_C89 = 0x0001,
870    DW_LANG_C = 0x0002,
871    DW_LANG_Ada83 = 0x0003,
872    DW_LANG_C_plus_plus = 0x0004,
873    DW_LANG_Cobol74 = 0x0005,
874    DW_LANG_Cobol85 = 0x0006,
875    DW_LANG_Fortran77 = 0x0007,
876    DW_LANG_Fortran90 = 0x0008,
877    DW_LANG_Pascal83 = 0x0009,
878    DW_LANG_Modula2 = 0x000a,
879    DW_LANG_Java = 0x000b,
880    DW_LANG_C99 = 0x000c,
881    DW_LANG_Ada95 = 0x000d,
882    DW_LANG_Fortran95 = 0x000e,
883    DW_LANG_PLI = 0x000f,
884    DW_LANG_ObjC = 0x0010,
885    DW_LANG_ObjC_plus_plus = 0x0011,
886    DW_LANG_UPC = 0x0012,
887    DW_LANG_D = 0x0013,
888    DW_LANG_Python = 0x0014,
889    DW_LANG_OpenCL = 0x0015,
890    DW_LANG_Go = 0x0016,
891    DW_LANG_Modula3 = 0x0017,
892    DW_LANG_Haskell = 0x0018,
893    DW_LANG_C_plus_plus_03 = 0x0019,
894    DW_LANG_C_plus_plus_11 = 0x001a,
895    DW_LANG_OCaml = 0x001b,
896    DW_LANG_Rust = 0x001c,
897    DW_LANG_C11 = 0x001d,
898    DW_LANG_Swift = 0x001e,
899    DW_LANG_Julia = 0x001f,
900    DW_LANG_Dylan = 0x0020,
901    DW_LANG_C_plus_plus_14 = 0x0021,
902    DW_LANG_Fortran03 = 0x0022,
903    DW_LANG_Fortran08 = 0x0023,
904    DW_LANG_RenderScript = 0x0024,
905    DW_LANG_BLISS = 0x0025,
906    DW_LANG_Kotlin = 0x0026,
907    DW_LANG_Zig = 0x0027,
908    DW_LANG_Crystal = 0x0028,
909    DW_LANG_C_plus_plus_17 = 0x002a,
910    DW_LANG_C_plus_plus_20 = 0x002b,
911    DW_LANG_C17 = 0x002c,
912    DW_LANG_Fortran18 = 0x002d,
913    DW_LANG_Ada2005 = 0x002e,
914    DW_LANG_Ada2012 = 0x002f,
915
916    DW_LANG_lo_user = 0x8000,
917    DW_LANG_hi_user = 0xffff,
918
919    DW_LANG_Mips_Assembler = 0x8001,
920    DW_LANG_GOOGLE_RenderScript = 0x8e57,
921    DW_LANG_SUN_Assembler = 0x9001,
922    DW_LANG_ALTIUM_Assembler = 0x9101,
923    DW_LANG_BORLAND_Delphi = 0xb000,
924});
925
926impl DwLang {
927    /// Get the default DW_AT_lower_bound for this language.
928    pub fn default_lower_bound(self) -> Option<usize> {
929        match self {
930            DW_LANG_C89
931            | DW_LANG_C
932            | DW_LANG_C_plus_plus
933            | DW_LANG_Java
934            | DW_LANG_C99
935            | DW_LANG_ObjC
936            | DW_LANG_ObjC_plus_plus
937            | DW_LANG_UPC
938            | DW_LANG_D
939            | DW_LANG_Python
940            | DW_LANG_OpenCL
941            | DW_LANG_Go
942            | DW_LANG_Haskell
943            | DW_LANG_C_plus_plus_03
944            | DW_LANG_C_plus_plus_11
945            | DW_LANG_OCaml
946            | DW_LANG_Rust
947            | DW_LANG_C11
948            | DW_LANG_Swift
949            | DW_LANG_Dylan
950            | DW_LANG_C_plus_plus_14
951            | DW_LANG_RenderScript
952            | DW_LANG_BLISS => Some(0),
953            DW_LANG_Ada83 | DW_LANG_Cobol74 | DW_LANG_Cobol85 | DW_LANG_Fortran77
954            | DW_LANG_Fortran90 | DW_LANG_Pascal83 | DW_LANG_Modula2 | DW_LANG_Ada95
955            | DW_LANG_Fortran95 | DW_LANG_PLI | DW_LANG_Modula3 | DW_LANG_Julia
956            | DW_LANG_Fortran03 | DW_LANG_Fortran08 => Some(1),
957            _ => None,
958        }
959    }
960}
961
962dw!(
963/// The encodings of the constants used in the `DW_AT_address_class` attribute.
964///
965/// There is only one value that is common to all target architectures.
966/// See Section 7.13.
967DwAddr(u64) {
968    DW_ADDR_none = 0x00,
969});
970
971dw!(
972/// The encodings of the constants used in the `DW_AT_identifier_case` attribute.
973///
974/// See Section 7.14, Table 7.18.
975DwId(u8) {
976    DW_ID_case_sensitive = 0x00,
977    DW_ID_up_case = 0x01,
978    DW_ID_down_case = 0x02,
979    DW_ID_case_insensitive = 0x03,
980});
981
982dw!(
983/// The encodings of the constants used in the `DW_AT_calling_convention` attribute.
984///
985/// See Section 7.15, Table 7.19.
986DwCc(u8) {
987    DW_CC_normal = 0x01,
988    DW_CC_program = 0x02,
989    DW_CC_nocall = 0x03,
990    DW_CC_pass_by_reference = 0x04,
991    DW_CC_pass_by_value = 0x05,
992    DW_CC_lo_user = 0x40,
993    DW_CC_hi_user = 0xff,
994});
995
996dw!(
997/// The encodings of the constants used in the `DW_AT_inline` attribute.
998///
999/// See Section 7.16, Table 7.20.
1000DwInl(u8) {
1001    DW_INL_not_inlined = 0x00,
1002    DW_INL_inlined = 0x01,
1003    DW_INL_declared_not_inlined = 0x02,
1004    DW_INL_declared_inlined = 0x03,
1005});
1006
1007dw!(
1008/// The encodings of the constants used in the `DW_AT_ordering` attribute.
1009///
1010/// See Section 7.17, Table 7.17.
1011DwOrd(u8) {
1012    DW_ORD_row_major = 0x00,
1013    DW_ORD_col_major = 0x01,
1014});
1015
1016dw!(
1017/// The encodings of the constants used in the `DW_AT_discr_list` attribute.
1018///
1019/// See Section 7.18, Table 7.22.
1020DwDsc(u8) {
1021    DW_DSC_label = 0x00,
1022    DW_DSC_range = 0x01,
1023});
1024
1025dw!(
1026/// Name index attribute encodings.
1027///
1028/// See Section 7.19, Table 7.23.
1029DwIdx(u16) {
1030    DW_IDX_compile_unit = 1,
1031    DW_IDX_type_unit = 2,
1032    DW_IDX_die_offset = 3,
1033    DW_IDX_parent = 4,
1034    DW_IDX_type_hash = 5,
1035    DW_IDX_lo_user = 0x2000,
1036    DW_IDX_hi_user = 0x3fff,
1037});
1038
1039dw!(
1040/// The encodings of the constants used in the `DW_AT_defaulted` attribute.
1041///
1042/// See Section 7.20, Table 7.24.
1043DwDefaulted(u8) {
1044    DW_DEFAULTED_no = 0x00,
1045    DW_DEFAULTED_in_class = 0x01,
1046    DW_DEFAULTED_out_of_class = 0x02,
1047});
1048
1049dw!(
1050/// The encodings for the standard opcodes for line number information.
1051///
1052/// See Section 7.22, Table 7.25.
1053DwLns(u8) {
1054    DW_LNS_copy = 0x01,
1055    DW_LNS_advance_pc = 0x02,
1056    DW_LNS_advance_line = 0x03,
1057    DW_LNS_set_file = 0x04,
1058    DW_LNS_set_column = 0x05,
1059    DW_LNS_negate_stmt = 0x06,
1060    DW_LNS_set_basic_block = 0x07,
1061    DW_LNS_const_add_pc = 0x08,
1062    DW_LNS_fixed_advance_pc = 0x09,
1063    DW_LNS_set_prologue_end = 0x0a,
1064    DW_LNS_set_epilogue_begin = 0x0b,
1065    DW_LNS_set_isa = 0x0c,
1066});
1067
1068dw!(
1069/// The encodings for the extended opcodes for line number information.
1070///
1071/// See Section 7.22, Table 7.26.
1072DwLne(u8) {
1073    DW_LNE_end_sequence = 0x01,
1074    DW_LNE_set_address = 0x02,
1075    DW_LNE_define_file = 0x03,
1076    DW_LNE_set_discriminator = 0x04,
1077
1078    DW_LNE_lo_user = 0x80,
1079    DW_LNE_hi_user = 0xff,
1080});
1081
1082dw!(
1083/// The encodings for the line number header entry formats.
1084///
1085/// See Section 7.22, Table 7.27.
1086DwLnct(u16) {
1087    DW_LNCT_path = 0x1,
1088    DW_LNCT_directory_index = 0x2,
1089    DW_LNCT_timestamp = 0x3,
1090    DW_LNCT_size = 0x4,
1091    DW_LNCT_MD5 = 0x5,
1092    // DW_LNCT_source = 0x6,
1093    DW_LNCT_lo_user = 0x2000,
1094    // We currently only implement the LLVM embedded source code extension for DWARF v5.
1095    DW_LNCT_LLVM_source = 0x2001,
1096    DW_LNCT_hi_user = 0x3fff,
1097});
1098
1099dw!(
1100/// Type codes for macro definitions in the `.debug_macinfo` section.
1101///
1102/// See Section 7.22, Figure 39 for DWARF 4.
1103DwMacinfo(u8) {
1104    DW_MACINFO_define = 0x01,
1105    DW_MACINFO_undef = 0x02,
1106    DW_MACINFO_start_file = 0x03,
1107    DW_MACINFO_end_file = 0x04,
1108    DW_MACINFO_vendor_ext = 0xff,
1109});
1110
1111dw!(
1112/// The encodings for macro information entry types.
1113///
1114/// See Section 7.23, Table 7.28 for DWARF 5.
1115DwMacro(u8) {
1116    DW_MACRO_define = 0x01,
1117    DW_MACRO_undef = 0x02,
1118    DW_MACRO_start_file = 0x03,
1119    DW_MACRO_end_file = 0x04,
1120    DW_MACRO_define_strp = 0x05,
1121    DW_MACRO_undef_strp = 0x06,
1122    DW_MACRO_import = 0x07,
1123    DW_MACRO_define_sup = 0x08,
1124    DW_MACRO_undef_sup = 0x09,
1125    DW_MACRO_import_sup = 0x0a,
1126    DW_MACRO_define_strx = 0x0b,
1127    DW_MACRO_undef_strx = 0x0c,
1128    DW_MACRO_lo_user = 0xe0,
1129    DW_MACRO_hi_user = 0xff,
1130});
1131
1132dw!(
1133/// Range list entry encoding values.
1134///
1135/// See Section 7.25, Table 7.30.
1136DwRle(u8) {
1137    DW_RLE_end_of_list = 0x00,
1138    DW_RLE_base_addressx = 0x01,
1139    DW_RLE_startx_endx = 0x02,
1140    DW_RLE_startx_length = 0x03,
1141    DW_RLE_offset_pair = 0x04,
1142    DW_RLE_base_address = 0x05,
1143    DW_RLE_start_end = 0x06,
1144    DW_RLE_start_length = 0x07,
1145});
1146
1147dw!(
1148/// The encodings for DWARF expression operations.
1149///
1150/// See Section 7.7.1, Table 7.9.
1151DwOp(u8) {
1152    DW_OP_addr = 0x03,
1153    DW_OP_deref = 0x06,
1154    DW_OP_const1u = 0x08,
1155    DW_OP_const1s = 0x09,
1156    DW_OP_const2u = 0x0a,
1157    DW_OP_const2s = 0x0b,
1158    DW_OP_const4u = 0x0c,
1159    DW_OP_const4s = 0x0d,
1160    DW_OP_const8u = 0x0e,
1161    DW_OP_const8s = 0x0f,
1162    DW_OP_constu = 0x10,
1163    DW_OP_consts = 0x11,
1164    DW_OP_dup = 0x12,
1165    DW_OP_drop = 0x13,
1166    DW_OP_over = 0x14,
1167    DW_OP_pick = 0x15,
1168    DW_OP_swap = 0x16,
1169    DW_OP_rot = 0x17,
1170    DW_OP_xderef = 0x18,
1171    DW_OP_abs = 0x19,
1172    DW_OP_and = 0x1a,
1173    DW_OP_div = 0x1b,
1174    DW_OP_minus = 0x1c,
1175    DW_OP_mod = 0x1d,
1176    DW_OP_mul = 0x1e,
1177    DW_OP_neg = 0x1f,
1178    DW_OP_not = 0x20,
1179    DW_OP_or = 0x21,
1180    DW_OP_plus = 0x22,
1181    DW_OP_plus_uconst = 0x23,
1182    DW_OP_shl = 0x24,
1183    DW_OP_shr = 0x25,
1184    DW_OP_shra = 0x26,
1185    DW_OP_xor = 0x27,
1186    DW_OP_bra = 0x28,
1187    DW_OP_eq = 0x29,
1188    DW_OP_ge = 0x2a,
1189    DW_OP_gt = 0x2b,
1190    DW_OP_le = 0x2c,
1191    DW_OP_lt = 0x2d,
1192    DW_OP_ne = 0x2e,
1193    DW_OP_skip = 0x2f,
1194    DW_OP_lit0 = 0x30,
1195    DW_OP_lit1 = 0x31,
1196    DW_OP_lit2 = 0x32,
1197    DW_OP_lit3 = 0x33,
1198    DW_OP_lit4 = 0x34,
1199    DW_OP_lit5 = 0x35,
1200    DW_OP_lit6 = 0x36,
1201    DW_OP_lit7 = 0x37,
1202    DW_OP_lit8 = 0x38,
1203    DW_OP_lit9 = 0x39,
1204    DW_OP_lit10 = 0x3a,
1205    DW_OP_lit11 = 0x3b,
1206    DW_OP_lit12 = 0x3c,
1207    DW_OP_lit13 = 0x3d,
1208    DW_OP_lit14 = 0x3e,
1209    DW_OP_lit15 = 0x3f,
1210    DW_OP_lit16 = 0x40,
1211    DW_OP_lit17 = 0x41,
1212    DW_OP_lit18 = 0x42,
1213    DW_OP_lit19 = 0x43,
1214    DW_OP_lit20 = 0x44,
1215    DW_OP_lit21 = 0x45,
1216    DW_OP_lit22 = 0x46,
1217    DW_OP_lit23 = 0x47,
1218    DW_OP_lit24 = 0x48,
1219    DW_OP_lit25 = 0x49,
1220    DW_OP_lit26 = 0x4a,
1221    DW_OP_lit27 = 0x4b,
1222    DW_OP_lit28 = 0x4c,
1223    DW_OP_lit29 = 0x4d,
1224    DW_OP_lit30 = 0x4e,
1225    DW_OP_lit31 = 0x4f,
1226    DW_OP_reg0 = 0x50,
1227    DW_OP_reg1 = 0x51,
1228    DW_OP_reg2 = 0x52,
1229    DW_OP_reg3 = 0x53,
1230    DW_OP_reg4 = 0x54,
1231    DW_OP_reg5 = 0x55,
1232    DW_OP_reg6 = 0x56,
1233    DW_OP_reg7 = 0x57,
1234    DW_OP_reg8 = 0x58,
1235    DW_OP_reg9 = 0x59,
1236    DW_OP_reg10 = 0x5a,
1237    DW_OP_reg11 = 0x5b,
1238    DW_OP_reg12 = 0x5c,
1239    DW_OP_reg13 = 0x5d,
1240    DW_OP_reg14 = 0x5e,
1241    DW_OP_reg15 = 0x5f,
1242    DW_OP_reg16 = 0x60,
1243    DW_OP_reg17 = 0x61,
1244    DW_OP_reg18 = 0x62,
1245    DW_OP_reg19 = 0x63,
1246    DW_OP_reg20 = 0x64,
1247    DW_OP_reg21 = 0x65,
1248    DW_OP_reg22 = 0x66,
1249    DW_OP_reg23 = 0x67,
1250    DW_OP_reg24 = 0x68,
1251    DW_OP_reg25 = 0x69,
1252    DW_OP_reg26 = 0x6a,
1253    DW_OP_reg27 = 0x6b,
1254    DW_OP_reg28 = 0x6c,
1255    DW_OP_reg29 = 0x6d,
1256    DW_OP_reg30 = 0x6e,
1257    DW_OP_reg31 = 0x6f,
1258    DW_OP_breg0 = 0x70,
1259    DW_OP_breg1 = 0x71,
1260    DW_OP_breg2 = 0x72,
1261    DW_OP_breg3 = 0x73,
1262    DW_OP_breg4 = 0x74,
1263    DW_OP_breg5 = 0x75,
1264    DW_OP_breg6 = 0x76,
1265    DW_OP_breg7 = 0x77,
1266    DW_OP_breg8 = 0x78,
1267    DW_OP_breg9 = 0x79,
1268    DW_OP_breg10 = 0x7a,
1269    DW_OP_breg11 = 0x7b,
1270    DW_OP_breg12 = 0x7c,
1271    DW_OP_breg13 = 0x7d,
1272    DW_OP_breg14 = 0x7e,
1273    DW_OP_breg15 = 0x7f,
1274    DW_OP_breg16 = 0x80,
1275    DW_OP_breg17 = 0x81,
1276    DW_OP_breg18 = 0x82,
1277    DW_OP_breg19 = 0x83,
1278    DW_OP_breg20 = 0x84,
1279    DW_OP_breg21 = 0x85,
1280    DW_OP_breg22 = 0x86,
1281    DW_OP_breg23 = 0x87,
1282    DW_OP_breg24 = 0x88,
1283    DW_OP_breg25 = 0x89,
1284    DW_OP_breg26 = 0x8a,
1285    DW_OP_breg27 = 0x8b,
1286    DW_OP_breg28 = 0x8c,
1287    DW_OP_breg29 = 0x8d,
1288    DW_OP_breg30 = 0x8e,
1289    DW_OP_breg31 = 0x8f,
1290    DW_OP_regx = 0x90,
1291    DW_OP_fbreg = 0x91,
1292    DW_OP_bregx = 0x92,
1293    DW_OP_piece = 0x93,
1294    DW_OP_deref_size = 0x94,
1295    DW_OP_xderef_size = 0x95,
1296    DW_OP_nop = 0x96,
1297    DW_OP_push_object_address = 0x97,
1298    DW_OP_call2 = 0x98,
1299    DW_OP_call4 = 0x99,
1300    DW_OP_call_ref = 0x9a,
1301    DW_OP_form_tls_address = 0x9b,
1302    DW_OP_call_frame_cfa = 0x9c,
1303    DW_OP_bit_piece = 0x9d,
1304    DW_OP_implicit_value = 0x9e,
1305    DW_OP_stack_value = 0x9f,
1306    DW_OP_implicit_pointer = 0xa0,
1307    DW_OP_addrx = 0xa1,
1308    DW_OP_constx = 0xa2,
1309    DW_OP_entry_value = 0xa3,
1310    DW_OP_const_type = 0xa4,
1311    DW_OP_regval_type = 0xa5,
1312    DW_OP_deref_type = 0xa6,
1313    DW_OP_xderef_type = 0xa7,
1314    DW_OP_convert = 0xa8,
1315    DW_OP_reinterpret = 0xa9,
1316
1317    // GNU extensions
1318    DW_OP_GNU_push_tls_address = 0xe0,
1319    DW_OP_GNU_implicit_pointer = 0xf2,
1320    DW_OP_GNU_entry_value = 0xf3,
1321    DW_OP_GNU_const_type = 0xf4,
1322    DW_OP_GNU_regval_type = 0xf5,
1323    DW_OP_GNU_deref_type = 0xf6,
1324    DW_OP_GNU_convert = 0xf7,
1325    DW_OP_GNU_reinterpret = 0xf9,
1326    DW_OP_GNU_parameter_ref = 0xfa,
1327    DW_OP_GNU_addr_index = 0xfb,
1328    DW_OP_GNU_const_index = 0xfc,
1329
1330    // Wasm extensions
1331    DW_OP_WASM_location = 0xed,
1332});
1333
1334dw!(
1335/// Pointer encoding used by `.eh_frame`.
1336///
1337/// The four lower bits describe the
1338/// format of the pointer, the upper four bits describe how the encoding should
1339/// be applied.
1340///
1341/// Defined in `<https://refspecs.linuxfoundation.org/LSB_4.0.0/LSB-Core-generic/LSB-Core-generic/dwarfext.html>`
1342DwEhPe(u8) {
1343// Format of pointer encoding.
1344
1345// "Unsigned value is encoded using the Little Endian Base 128"
1346    DW_EH_PE_uleb128 = 0x1,
1347// "A 2 bytes unsigned value."
1348    DW_EH_PE_udata2 = 0x2,
1349// "A 4 bytes unsigned value."
1350    DW_EH_PE_udata4 = 0x3,
1351// "An 8 bytes unsigned value."
1352    DW_EH_PE_udata8 = 0x4,
1353// "Signed value is encoded using the Little Endian Base 128"
1354    DW_EH_PE_sleb128 = 0x9,
1355// "A 2 bytes signed value."
1356    DW_EH_PE_sdata2 = 0x0a,
1357// "A 4 bytes signed value."
1358    DW_EH_PE_sdata4 = 0x0b,
1359// "An 8 bytes signed value."
1360    DW_EH_PE_sdata8 = 0x0c,
1361
1362// How the pointer encoding should be applied.
1363
1364// `DW_EH_PE_pcrel` pointers are relative to their own location.
1365    DW_EH_PE_pcrel = 0x10,
1366// "Value is relative to the beginning of the .text section."
1367    DW_EH_PE_textrel = 0x20,
1368// "Value is relative to the beginning of the .got or .eh_frame_hdr section."
1369    DW_EH_PE_datarel = 0x30,
1370// "Value is relative to the beginning of the function."
1371    DW_EH_PE_funcrel = 0x40,
1372// "Value is aligned to an address unit sized boundary."
1373    DW_EH_PE_aligned = 0x50,
1374
1375// This bit can be set for any of the above encoding applications. When set,
1376// the encoded value is the address of the real pointer result, not the
1377// pointer result itself.
1378//
1379// This isn't defined in the DWARF or the `.eh_frame` standards, but is
1380// generated by both GNU/Linux and macOS tooling.
1381    DW_EH_PE_indirect = 0x80,
1382
1383// These constants apply to both the lower and upper bits.
1384
1385// "The Value is a literal pointer whose size is determined by the
1386// architecture."
1387    DW_EH_PE_absptr = 0x0,
1388// The absence of a pointer and encoding.
1389    DW_EH_PE_omit = 0xff,
1390});
1391
1392const DW_EH_PE_FORMAT_MASK: u8 = 0b0000_1111;
1393
1394// Ignores indirection bit.
1395const DW_EH_PE_APPLICATION_MASK: u8 = 0b0111_0000;
1396
1397impl ops::BitOr for DwEhPe {
1398    type Output = DwEhPe;
1399
1400    fn bitor(self, rhs: DwEhPe) -> DwEhPe {
1401        DwEhPe(self.0 | rhs.0)
1402    }
1403}
1404
1405impl DwEhPe {
1406    /// Get the pointer encoding's format.
1407    #[inline]
1408    pub fn format(self) -> DwEhPe {
1409        DwEhPe(self.0 & DW_EH_PE_FORMAT_MASK)
1410    }
1411
1412    /// Get the pointer encoding's application.
1413    #[inline]
1414    pub fn application(self) -> DwEhPe {
1415        DwEhPe(self.0 & DW_EH_PE_APPLICATION_MASK)
1416    }
1417
1418    /// Is this encoding the absent pointer encoding?
1419    #[inline]
1420    pub fn is_absent(self) -> bool {
1421        self == DW_EH_PE_omit
1422    }
1423
1424    /// Is this coding indirect? If so, its encoded value is the address of the
1425    /// real pointer result, not the pointer result itself.
1426    #[inline]
1427    pub fn is_indirect(self) -> bool {
1428        self.0 & DW_EH_PE_indirect.0 != 0
1429    }
1430
1431    /// Is this a known, valid pointer encoding?
1432    pub fn is_valid_encoding(self) -> bool {
1433        if self.is_absent() {
1434            return true;
1435        }
1436
1437        match self.format() {
1438            DW_EH_PE_absptr | DW_EH_PE_uleb128 | DW_EH_PE_udata2 | DW_EH_PE_udata4
1439            | DW_EH_PE_udata8 | DW_EH_PE_sleb128 | DW_EH_PE_sdata2 | DW_EH_PE_sdata4
1440            | DW_EH_PE_sdata8 => {}
1441            _ => return false,
1442        }
1443
1444        match self.application() {
1445            DW_EH_PE_absptr | DW_EH_PE_pcrel | DW_EH_PE_textrel | DW_EH_PE_datarel
1446            | DW_EH_PE_funcrel | DW_EH_PE_aligned => {}
1447            _ => return false,
1448        }
1449
1450        true
1451    }
1452}
1453
1454#[cfg(test)]
1455mod tests {
1456    use super::*;
1457
1458    #[test]
1459    fn test_dw_eh_pe_format() {
1460        let encoding = DW_EH_PE_pcrel | DW_EH_PE_uleb128;
1461        assert_eq!(encoding.format(), DW_EH_PE_uleb128);
1462    }
1463
1464    #[test]
1465    fn test_dw_eh_pe_application() {
1466        let encoding = DW_EH_PE_pcrel | DW_EH_PE_uleb128;
1467        assert_eq!(encoding.application(), DW_EH_PE_pcrel);
1468    }
1469
1470    #[test]
1471    fn test_dw_eh_pe_is_absent() {
1472        assert!(!DW_EH_PE_absptr.is_absent());
1473        assert!(DW_EH_PE_omit.is_absent());
1474    }
1475
1476    #[test]
1477    fn test_dw_eh_pe_is_valid_encoding_ok() {
1478        let encoding = DW_EH_PE_uleb128 | DW_EH_PE_pcrel;
1479        assert!(encoding.is_valid_encoding());
1480        assert!(DW_EH_PE_absptr.is_valid_encoding());
1481        assert!(DW_EH_PE_omit.is_valid_encoding());
1482    }
1483
1484    #[test]
1485    fn test_dw_eh_pe_is_valid_encoding_bad_format() {
1486        let encoding = DwEhPe((DW_EH_PE_sdata8.0 + 1) | DW_EH_PE_pcrel.0);
1487        assert!(!encoding.is_valid_encoding());
1488    }
1489
1490    #[test]
1491    fn test_dw_eh_pe_is_valid_encoding_bad_application() {
1492        let encoding = DwEhPe(DW_EH_PE_sdata8.0 | (DW_EH_PE_aligned.0 + 1));
1493        assert!(!encoding.is_valid_encoding());
1494    }
1495}
gimli/constants.rs

gimli/
constants.rs
