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