1. Wez Furlong
  2. gimli

Source

gimli / gimli_dwarf.h

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
/*
 * Copyright (c) 2009-2011 Message Systems, Inc. All rights reserved
 * For licensing information, see:
 * https://bitbucket.org/wez/gimli/src/tip/LICENSE
 */
#ifndef GIMLI_DWARF_H
#define GIMLI_DWARF_H

#ifdef __cplusplus
extern "C" {
#endif

/* These constants are taken from Table 6.2 of this document:
 * http://refspecs.freestandards.org/LSB_1.3.0/gLSB/gLSB/ehframehdr.html.
 * These specify pointer encodings used in the augmentation strings for
 * CIE/FDE blocks.
 */
#define DW_EH_PE_omit    0xff /* no value is present */
/* the lower 4-bits describe data format */
#define DW_EH_PE_uleb128 0x01
#define DW_EH_PE_sleb128 0x09
#define DW_EH_PE_udata2  0x02 /* uint16_t */
#define DW_EH_PE_udata4  0x03 /* uint32_t */
#define DW_EH_PE_udata8  0x04 /* uint64_t */
#define DW_EH_PE_sdata2  0x0a /* int16_t */
#define DW_EH_PE_sdata4  0x0b /* int32_t */
#define DW_EH_PE_sdata8  0x0c /* int64_t */
#define DW_EH_PE_APPL_MASK 0x70
#define DW_EH_PE_absptr  0x00 /* value used with no modification */
#define DW_EH_PE_pcrel   0x10 /* is relative to program counter */
#define DW_EH_PE_datarel 0x30 /* is relative to start of eh_frame_hdr section */
#define DW_EH_PE_indirect 0x80 /* result is address of value */

/* these apply to the rule value in the reg_column struct */
#define DW_RULE_UNDEF 0     /* register has no value in previous frame */
#define DW_RULE_SAME  1     /* reg unmodified since previous frame */
#define DW_RULE_OFFSET 2    /* reg saved at a CFA-rel address */
#define DW_RULE_VAL_OFFSET 3 /* reg saved as value of CFA-rel address */
#define DW_RULE_REG 4        /* reg saved in another reg */
#define DW_RULE_EXPR 5       /* reg saved at address produced by expr */
#define DW_RULE_VAL_EXPR 6   /* reg saved as value produced by expr */

/* these apply to CFA opcodes.
 * "The high 2 bits define the primary operation, an operand or extended
 * opcode may be encoded in the lower 6 bits".
 */
#define DW_CFA_advance_loc 0x40
#define DW_CFA_offset      0x80
#define DW_CFA_restore     0xc0

#define DW_CFA_nop              0x0
#define DW_CFA_set_loc          0x1 /* op1: address */
#define DW_CFA_advance_loc1     0x2 /* op1: 1-byte delta */
#define DW_CFA_advance_loc2     0x3 /* op1: 2-byte delta */
#define DW_CFA_advance_loc4     0x4 /* op1: 4-byte delta */
#define DW_CFA_offset_extended  0x5 /* op1: uleb128 reg, op2: uleb128 offs */
#define DW_CFA_restore_extended 0x6 /* op1: uleb128 reg */
#define DW_CFA_undefined        0x7 /* op1: uleb128 reg */
#define DW_CFA_same_value       0x8 /* op1: uleb128 reg */
#define DW_CFA_register         0x9 /* op1: uleb128 reg, op2: uleb128 reg */
#define DW_CFA_remember_state   0xa
#define DW_CFA_restore_state    0xb
#define DW_CFA_def_cfa          0xc /* op1: uleb128 reg, op2: uleb128 offs */
#define DW_CFA_def_cfa_register 0xd /* op1: uleb128 reg */
#define DW_CFA_def_cfa_offset   0xe /* op1: uleb128 offs */
  /* these are DWARF 3: */
#define DW_CFA_def_cfa_expression 0xf /* op1: BLOCK */
#define DW_CFA_expression         0x10 /* op1: uleb128 reg, BLOCK */
#define DW_CFA_offset_extended_sf 0x11 /* op1: uleb128 reg, sleb128 offset */
#define DW_CFA_def_cfa_sf         0x12 /* op1: uleb128 reg, sleb128 offset */
#define DW_CFA_def_cfa_offset_sf  0x13 /* op1: sleb128 offset */
#define DW_CFA_val_offset         0x14 /* uleb128, uleb128 */
#define DW_CFA_val_offset_sf      0x15 /* uleb128, sleb128 */
#define DW_CFA_val_expression     0x16 /* uleb128, BLOCK */

/* http://refspecs.freestandards.org/LSB_3.1.0/LSB-Core-generic/LSB-Core-generic/dwarfext.html */
#define DW_CFA_GNU_args_size   0x2e
#define DW_CFA_GNU_negative_offset_extended 0x2f

/* sparc */
#define DW_CFA_GNU_window_save 0x2d

/* pre-define line number program opcodes */
#define DW_LNS_copy 0x01
#define DW_LNS_advance_pc 0x02
#define DW_LNS_advance_line 0x03
#define DW_LNS_set_file 0x04
#define DW_LNS_set_column 0x05
#define DW_LNS_negate_stmt 0x06
#define DW_LNS_set_basic_block 0x07
#define DW_LNS_const_add_pc 0x08
#define DW_LNS_fixed_advance_pc 0x09
/* DWARF 3 */
#define DW_LNS_set_prologue_end 0x0a
#define DW_LNS_set_epilogue_begin 0x0b
#define DW_LNS_set_isa 0x0c

#define DW_LNE_end_sequence 0x01
#define DW_LNE_set_address 0x02
#define DW_LNE_define_file 0x03

#define DW_CHILDREN_no  0x00
#define DW_CHILDREN_yes 0x01

#define DW_TAG_array_type 0x01
#define DW_TAG_class_type 0x02
#define DW_TAG_entry_point 0x03
#define DW_TAG_enumeration_type 0x04
#define DW_TAG_formal_parameter 0x05
#define DW_TAG_imported_declaration 0x08
#define DW_TAG_label 0x0a
#define DW_TAG_lexical_block 0x0b
#define DW_TAG_member 0x0d
#define DW_TAG_pointer_type 0x0f
#define DW_TAG_reference_type 0x10
#define DW_TAG_compile_unit 0x11
#define DW_TAG_string_type 0x12
#define DW_TAG_structure_type 0x13
#define DW_TAG_subroutine_type 0x15
#define DW_TAG_typedef 0x16
#define DW_TAG_union_type 0x17
#define DW_TAG_unspecified_parameters 0x18
#define DW_TAG_variant 0x19
#define DW_TAG_common_block 0x1a
#define DW_TAG_common_inclusion 0x1b
#define DW_TAG_inheritance 0x1c
#define DW_TAG_inlined_subroutine 0x1d
#define DW_TAG_module 0x1e
#define DW_TAG_ptr_to_member_type 0x1f
#define DW_TAG_set_type 0x20
#define DW_TAG_subrange_type 0x21
#define DW_TAG_with_stmt 0x22
#define DW_TAG_access_declaration 0x23
#define DW_TAG_base_type 0x24
#define DW_TAG_catch_block 0x25
#define DW_TAG_const_type 0x26
#define DW_TAG_constant 0x27
#define DW_TAG_enumerator 0x28
#define DW_TAG_file_type 0x29
#define DW_TAG_friend 0x2a
#define DW_TAG_namelist 0x2b
#define DW_TAG_namelist_item 0x2c
#define DW_TAG_packed_type 0x2d
#define DW_TAG_subprogram 0x2e
#define DW_TAG_template_type_parameter 0x2f
#define DW_TAG_template_value_parameter 0x30
#define DW_TAG_thrown_type 0x31
#define DW_TAG_try_block 0x32
#define DW_TAG_variant_part 0x33
#define DW_TAG_variable 0x34
#define DW_TAG_volatile_type 0x35
/* DWARF 3 */
#define DW_TAG_dwarf_procedure 0x36
#define DW_TAG_restrict_type 0x37
#define DW_TAG_interface_type 0x38
#define DW_TAG_namespace 0x39
#define DW_TAG_imported_module 0x3a
#define DW_TAG_unspecified_type 0x3b
#define DW_TAG_partial_unit 0x3c
#define DW_TAG_imported_unit 0x3d
#define DW_TAG_condition 0x3f
#define DW_TAG_shared_type 0x40
#define DW_TAG_lo_user 0x4080
#define DW_TAG_hi_user 0xffff

#define DW_AT_sibling 0x01 // reference
#define DW_AT_location 0x02 // block, loclistptr
#define DW_AT_name 0x03 // string
#define DW_AT_ordering 0x09 // constant
#define DW_AT_byte_size 0x0b // block, constant, reference
#define DW_AT_bit_offset 0x0c // block, constant, reference
#define DW_AT_bit_size 0x0d // block, constant, reference
#define DW_AT_stmt_list 0x10 // lineptr
#define DW_AT_low_pc 0x11 // address
#define DW_AT_high_pc 0x12 // address
#define DW_AT_language 0x13 // constant
#define DW_AT_discr 0x15 // reference
#define DW_AT_discr_value 0x16 // constant
#define DW_AT_visibility 0x17 // constant
#define DW_AT_import 0x18 // reference
#define DW_AT_string_length 0x19 // block, loclistptr
#define DW_AT_common_reference 0x1a // reference
#define DW_AT_comp_dir 0x1b // string
#define DW_AT_const_value 0x1c // block, constant, string
#define DW_AT_containing_type 0x1d // reference
#define DW_AT_default_value 0x1e // reference
#define DW_AT_inline 0x20 // constant
#define DW_AT_is_optional 0x21 // flag
#define DW_AT_lower_bound 0x22 // block, constant, reference
#define DW_AT_producer 0x25 // string
#define DW_AT_prototyped 0x27 // flag
#define DW_AT_return_addr 0x2a // block, loclistptr
#define DW_AT_start_scope 0x2c // constant
#define DW_AT_bit_stride 0x2e // constant
#define DW_AT_upper_bound 0x2f // block, constant, reference
#define DW_AT_abstract_origin 0x31 // reference
#define DW_AT_accessibility 0x32 // constant
#define DW_AT_address_class 0x33 // constant
#define DW_AT_artificial 0x34 // flag
#define DW_AT_base_types 0x35 // reference
#define DW_AT_calling_convention 0x36 // constant
#define DW_AT_count 0x37 // block, constant, reference
#define DW_AT_data_member_location 0x38 // block, constant, loclistptr
#define DW_AT_decl_column 0x39 // constant
#define DW_AT_decl_file 0x3a // constant
#define DW_AT_decl_line 0x3b // constant
#define DW_AT_declaration 0x3c // flag
#define DW_AT_discr_list 0x3d // block
#define DW_AT_encoding 0x3e // constant
#define DW_AT_external 0x3f // flag
#define DW_AT_frame_base 0x40 // block, loclistptr
#define DW_AT_friend 0x41 // reference
#define DW_AT_identifier_case 0x42 // constant
#define DW_AT_macro_info 0x43 // macptr
#define DW_AT_namelist_item 0x44 // block
#define DW_AT_priority 0x45 // reference
#define DW_AT_segment 0x46 // block, loclistptr
#define DW_AT_specification 0x47 // reference
#define DW_AT_static_link 0x48 // block, loclistptr
#define DW_AT_type 0x49 // reference
#define DW_AT_use_location 0x4a // block, loclistptr
#define DW_AT_variable_parameter 0x4b // flag
#define DW_AT_virtuality 0x4c // constant
#define DW_AT_vtable_elem_location 0x4d // block, loclistptr
/* DWARF version 3 */
#define DW_AT_allocated 0x4e // block, constant, reference
#define DW_AT_associated 0x4f // block, constant, reference
#define DW_AT_data_location 0x50 // block
#define DW_AT_byte_stride 0x51 // block, constant, reference
#define DW_AT_entry_pc 0x52 // address
#define DW_AT_use_UTF8 0x53 // flag
#define DW_AT_extension 0x54 // reference
#define DW_AT_ranges 0x55 // rangelistptr
#define DW_AT_trampoline 0x56 // address, flag, reference, string
#define DW_AT_call_column 0x57 // constant
#define DW_AT_call_file 0x58 // constant
#define DW_AT_call_line 0x59 // constant
#define DW_AT_description 0x5a // string
#define DW_AT_binary_scale 0x5b // constant
#define DW_AT_decimal_scale 0x5c // constant
#define DW_AT_small 0x5d // reference
#define DW_AT_decimal_sign 0x5e // constant
#define DW_AT_digit_count 0x5f // constant
#define DW_AT_picture_string 0x60 // string
#define DW_AT_mutable 0x61 // flag
#define DW_AT_threads_scaled 0x62 // flag
#define DW_AT_explicit 0x63 // flag
#define DW_AT_object_pointer 0x64 // reference
#define DW_AT_endianity 0x65 // constant
#define DW_AT_elemental 0x66 // flag
#define DW_AT_pure 0x67 // flag
#define DW_AT_recursive 0x68 // flag
#define DW_AT_lo_user 0x2000 // ---
#define DW_AT_hi_user 0x3fff // ---
#define DW_FORM_addr 0x01 // address
#define DW_FORM_block2 0x03 // block
#define DW_FORM_block4 0x04 // block
#define DW_FORM_data2 0x05 // constant
#define DW_FORM_data4 0x06 // constant, lineptr, loclistptr, macptr, rangelistptr
#define DW_FORM_data8 0x07 // constant, lineptr, loclistptr, macptr, rangelistptr
#define DW_FORM_string 0x08 // string
#define DW_FORM_block 0x09 // block
#define DW_FORM_block1 0x0a // block
#define DW_FORM_data1 0x0b // constant
#define DW_FORM_flag 0x0c // flag
#define DW_FORM_sdata 0x0d // constant
#define DW_FORM_strp 0x0e // string
#define DW_FORM_udata 0x0f // constant
#define DW_FORM_ref_addr 0x10 // reference
#define DW_FORM_ref1 0x11 // reference
#define DW_FORM_ref2 0x12 // reference
#define DW_FORM_ref4 0x13 // reference
#define DW_FORM_ref8 0x14 // reference
#define DW_FORM_ref_udata 0x15 // reference
#define DW_FORM_indirect 0x16 // (see Section 7.5.3)

/* DWARF 4 */
#define DW_FORM_sec_offset   0x17
#define DW_FORM_exprloc      0x18
#define DW_FORM_flag_present 0x19
#define DW_FORM_ref_sig8     0x20

/* operation, code, no. operands, notes */
#define DW_OP_addr 0x03 // 1 constant address  (size target specific)
#define DW_OP_deref 0x06 // 0
#define DW_OP_const1u 0x08 // 1 1-byte constant
#define DW_OP_const1s 0x09 // 1 1-byte constant
#define DW_OP_const2u 0x0a // 1 2-byte constant
#define DW_OP_const2s 0x0b // 1 2-byte constant
#define DW_OP_const4u 0x0c // 1 4-byte constant
#define DW_OP_const4s 0x0d // 1 4-byte constant
#define DW_OP_const8u 0x0e // 1 8-byte constant
#define DW_OP_const8s 0x0f // 1 8-byte constant
#define DW_OP_constu 0x10 // 1 ULEB128 constant
#define DW_OP_consts 0x11 // 1 SLEB128 constant
#define DW_OP_dup 0x12 // 0
#define DW_OP_drop 0x13 // 0
#define DW_OP_over 0x14 // 0
#define DW_OP_pick 0x15 // 1 1-byte stack index
#define DW_OP_swap 0x16 // 0
#define DW_OP_rot 0x17 // 0
#define DW_OP_xderef 0x18 // 0
#define DW_OP_abs 0x19 // 0
#define DW_OP_and 0x1a // 0
#define DW_OP_div 0x1b // 0
#define DW_OP_minus 0x1c // 0
#define DW_OP_mod 0x1d // 0
#define DW_OP_mul 0x1e // 0
#define DW_OP_neg 0x1f // 0
#define DW_OP_not 0x20 // 0
#define DW_OP_or 0x21 // 0
#define DW_OP_plus 0x22 // 0
#define DW_OP_plus_uconst 0x23 // 1 ULEB128 addend
#define DW_OP_shl 0x24 // 0
#define DW_OP_shr 0x25 // 0
#define DW_OP_shra 0x26 // 0
#define DW_OP_xor 0x27 // 0
#define DW_OP_skip 0x2f // 1 signed 2-byte constant
#define DW_OP_bra 0x28 // 1 signed 2-byte constant
#define DW_OP_eq 0x29 // 0
#define DW_OP_ge 0x2a // 0
#define DW_OP_gt 0x2b // 0
#define DW_OP_le 0x2c // 0
#define DW_OP_lt 0x2d // 0
#define DW_OP_ne 0x2e // 0

/* lit0 .. lit31
 * literals 0..31 = (DW_OP_lit0 + literal)
 */
#define DW_OP_lit0 0x30 // 0
#define DW_OP_lit1 0x31 // 0
#define DW_OP_lit31 0x4f // 0

/* reg0 .. reg31
 * reg 0..31 = (DW_OP_reg0 + regnum)
 */
#define DW_OP_reg0 0x50 // 0
#define DW_OP_reg1 0x51 // 0
#define DW_OP_reg31 0x6f // 0

/* breg0 .. breg31:
 * SLEB128 offset
 * base register 0..31 = (DW_OP_breg0 + regnum)
 */
#define DW_OP_breg0 0x70 // 1
#define DW_OP_breg1 0x71 // 1
#define DW_OP_breg31 0x8f // 1


#define DW_OP_regx 0x90 // 1 ULEB128 register
#define DW_OP_fbreg 0x91 // 1 SLEB128 offset
#define DW_OP_bregx 0x92 // 2 ULEB128 register followed by SLEB128 offset
#define DW_OP_piece 0x93 // 1 ULEB128 size of piece addressed
#define DW_OP_deref_size 0x94 // 1 1-byte size of data retrieved
#define DW_OP_xderef_size 0x95 // 1 1-byte size of data retrieved
#define DW_OP_nop 0x96 // 0
// DWARF 3
#define DW_OP_push_object_address 0x97 // 0
#define DW_OP_call2 0x98 // 1 2-byte offset of DIE
#define DW_OP_call4 0x99 // 1 4-byte offset of DIE
#define DW_OP_call_ref 0x9a // 1 4- or 8-byte offset of DIE
#define DW_OP_form_tls_address 0x9b // 0
#define DW_OP_call_frame_cfa 0x9c // 0
#define DW_OP_bit_piece 0x9d // 2
#define DW_OP_lo_user 0xe0
#define DW_OP_hi_user 0xff

// DWARF 4
#define DW_OP_implicit_value 0x9e // uleb128 size encoded value here
#define DW_OP_stack_value 0x9f // result is on the expr stack

// GNU extensions
#define DW_OP_GNU_entry_value 0xf3


#define DW_ATE_address 0x01
#define DW_ATE_boolean 0x02
#define DW_ATE_complex_float 0x03
#define DW_ATE_float 0x04
#define DW_ATE_signed 0x05
#define DW_ATE_signed_char 0x06
#define DW_ATE_unsigned 0x07
#define DW_ATE_unsigned_char 0x08
#define DW_ATE_imaginary_float 0x09
#define DW_ATE_packed_decimal 0x0a
#define DW_ATE_numeric_string 0x0b
#define DW_ATE_edited 0x0c
#define DW_ATE_signed_fixed 0x0d
#define DW_ATE_unsigned_fixed 0x0e
#define DW_ATE_decimal_float 0x0f
#define DW_ATE_lo_user 0x80
#define DW_ATE_hi_user 0xff

struct gimli_dwarf_attr {
  struct gimli_dwarf_attr *next;
  uint64_t attr;
  uint64_t form;
  uint64_t code;
  const uint8_t *ptr;
};

/* compilation unit */
struct gimli_dwarf_cu {
  /** offset of CU within .debug_info */
  uint64_t offset, end;
  /** offset into abbrev */
  uint64_t da_offset;
  struct gimli_dwarf_cu *left, *right;
  STAILQ_HEAD(cudielist, gimli_dwarf_die) dies;
};

struct gimli_dwarf_die {
  uint64_t offset;
  uint64_t tag;
  STAILQ_ENTRY(gimli_dwarf_die) siblings;
  STAILQ_HEAD(dielist, gimli_dwarf_die) kids;
  struct gimli_dwarf_die *parent;
  struct gimli_dwarf_attr *attrs;
};

#ifdef __cplusplus
}
#endif

#endif

/* vim:ts=2:sw=2:et:
 */