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