dbghelp: Prepare module loading functions to be switched to Unicode module storage.
[wine] / dlls / dbghelp / dwarf.h
1 /*
2  * dwarf2 definitions
3  *
4  * Copyright (C) 2005, Raphael Junqueira
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19  */
20
21 typedef struct
22 {
23   unsigned char length[4];
24   unsigned char version[2];
25   unsigned char abbrev_offset[4];
26   unsigned char word_size[1];
27 } dwarf2_comp_unit_stream_t;
28
29 typedef struct
30 {
31   unsigned long  length;
32   unsigned short version;
33   unsigned long  abbrev_offset;
34   unsigned char  word_size;
35 } dwarf2_comp_unit_t;
36
37 typedef struct
38 {
39   unsigned int   length;
40   unsigned short version;
41   unsigned int   prologue_length;
42   unsigned char  min_insn_length;
43   unsigned char  default_is_stmt;
44   int            line_base;
45   unsigned char  line_range;
46   unsigned char  opcode_base;
47 } dwarf2_line_info_t;
48
49 typedef enum dwarf_tag_e
50 {
51   DW_TAG_padding                        = 0x00,
52   DW_TAG_array_type                     = 0x01,
53   DW_TAG_class_type                     = 0x02,
54   DW_TAG_entry_point                    = 0x03,
55   DW_TAG_enumeration_type               = 0x04,
56   DW_TAG_formal_parameter               = 0x05,
57   DW_TAG_imported_declaration           = 0x08,
58   DW_TAG_label                          = 0x0a,
59   DW_TAG_lexical_block                  = 0x0b,
60   DW_TAG_member                         = 0x0d,
61   DW_TAG_pointer_type                   = 0x0f,
62   DW_TAG_reference_type                 = 0x10,
63   DW_TAG_compile_unit                   = 0x11,
64   DW_TAG_string_type                    = 0x12,
65   DW_TAG_structure_type                 = 0x13,
66   DW_TAG_subroutine_type                = 0x15,
67   DW_TAG_typedef                        = 0x16,
68   DW_TAG_union_type                     = 0x17,
69   DW_TAG_unspecified_parameters         = 0x18,
70   DW_TAG_variant                        = 0x19,
71   DW_TAG_common_block                   = 0x1a,
72   DW_TAG_common_inclusion               = 0x1b,
73   DW_TAG_inheritance                    = 0x1c,
74   DW_TAG_inlined_subroutine             = 0x1d,
75   DW_TAG_module                         = 0x1e,
76   DW_TAG_ptr_to_member_type             = 0x1f,
77   DW_TAG_set_type                       = 0x20,
78   DW_TAG_subrange_type                  = 0x21,
79   DW_TAG_with_stmt                      = 0x22,
80   DW_TAG_access_declaration             = 0x23,
81   DW_TAG_base_type                      = 0x24,
82   DW_TAG_catch_block                    = 0x25,
83   DW_TAG_const_type                     = 0x26,
84   DW_TAG_constant                       = 0x27,
85   DW_TAG_enumerator                     = 0x28,
86   DW_TAG_file_type                      = 0x29,
87   DW_TAG_friend                         = 0x2a,
88   DW_TAG_namelist                       = 0x2b,
89   DW_TAG_namelist_item                  = 0x2c,
90   DW_TAG_packed_type                    = 0x2d,
91   DW_TAG_subprogram                     = 0x2e,
92   DW_TAG_template_type_param            = 0x2f,
93   DW_TAG_template_value_param           = 0x30,
94   DW_TAG_thrown_type                    = 0x31,
95   DW_TAG_try_block                      = 0x32,
96   DW_TAG_variant_part                   = 0x33,
97   DW_TAG_variable                       = 0x34,
98   DW_TAG_volatile_type                  = 0x35,
99   /** extensions */
100   DW_TAG_MIPS_loop                      = 0x4081,
101   DW_TAG_format_label                   = 0x4101,
102   DW_TAG_function_template              = 0x4102,
103   DW_TAG_class_template                 = 0x4103
104 } dwarf_tag_t;
105
106 typedef enum dwarf_attribute_e
107 {
108   DW_AT_sibling                         = 0x01,
109   DW_AT_location                        = 0x02,
110   DW_AT_name                            = 0x03,
111   DW_AT_ordering                        = 0x09,
112   DW_AT_subscr_data                     = 0x0a,
113   DW_AT_byte_size                       = 0x0b,
114   DW_AT_bit_offset                      = 0x0c,
115   DW_AT_bit_size                        = 0x0d,
116   DW_AT_element_list                    = 0x0f,
117   DW_AT_stmt_list                       = 0x10,
118   DW_AT_low_pc                          = 0x11,
119   DW_AT_high_pc                         = 0x12,
120   DW_AT_language                        = 0x13,
121   DW_AT_member                          = 0x14,
122   DW_AT_discr                           = 0x15,
123   DW_AT_discr_value                     = 0x16,
124   DW_AT_visibility                      = 0x17,
125   DW_AT_import                          = 0x18,
126   DW_AT_string_length                   = 0x19,
127   DW_AT_common_reference                = 0x1a,
128   DW_AT_comp_dir                        = 0x1b,
129   DW_AT_const_value                     = 0x1c,
130   DW_AT_containing_type                 = 0x1d,
131   DW_AT_default_value                   = 0x1e,
132   DW_AT_inline                          = 0x20,
133   DW_AT_is_optional                     = 0x21,
134   DW_AT_lower_bound                     = 0x22,
135   DW_AT_producer                        = 0x25,
136   DW_AT_prototyped                      = 0x27,
137   DW_AT_return_addr                     = 0x2a,
138   DW_AT_start_scope                     = 0x2c,
139   DW_AT_stride_size                     = 0x2e,
140   DW_AT_upper_bound                     = 0x2f,
141   DW_AT_abstract_origin                 = 0x31,
142   DW_AT_accessibility                   = 0x32,
143   DW_AT_address_class                   = 0x33,
144   DW_AT_artificial                      = 0x34,
145   DW_AT_base_types                      = 0x35,
146   DW_AT_calling_convention              = 0x36,
147   DW_AT_count                           = 0x37,
148   DW_AT_data_member_location            = 0x38,
149   DW_AT_decl_column                     = 0x39,
150   DW_AT_decl_file                       = 0x3a,
151   DW_AT_decl_line                       = 0x3b,
152   DW_AT_declaration                     = 0x3c,
153   DW_AT_discr_list                      = 0x3d,
154   DW_AT_encoding                        = 0x3e,
155   DW_AT_external                        = 0x3f,
156   DW_AT_frame_base                      = 0x40,
157   DW_AT_friend                          = 0x41,
158   DW_AT_identifier_case                 = 0x42,
159   DW_AT_macro_info                      = 0x43,
160   DW_AT_namelist_items                  = 0x44,
161   DW_AT_priority                        = 0x45,
162   DW_AT_segment                         = 0x46,
163   DW_AT_specification                   = 0x47,
164   DW_AT_static_link                     = 0x48,
165   DW_AT_type                            = 0x49,
166   DW_AT_use_location                    = 0x4a,
167   DW_AT_variable_parameter              = 0x4b,
168   DW_AT_virtuality                      = 0x4c,
169   DW_AT_vtable_elem_location            = 0x4d,
170
171   DW_AT_ranges                          = 0x55,
172   /* extensions */
173   DW_AT_MIPS_fde                        = 0x2001,
174   DW_AT_MIPS_loop_begin                 = 0x2002,
175   DW_AT_MIPS_tail_loop_begin            = 0x2003,
176   DW_AT_MIPS_epilog_begin               = 0x2004,
177   DW_AT_MIPS_loop_unroll_factor         = 0x2005,
178   DW_AT_MIPS_software_pipeline_depth    = 0x2006,
179   DW_AT_MIPS_linkage_name               = 0x2007,
180   DW_AT_MIPS_stride                     = 0x2008,
181   DW_AT_MIPS_abstract_name              = 0x2009,
182   DW_AT_MIPS_clone_origin               = 0x200a,
183   DW_AT_MIPS_has_inlines                = 0x200b,
184   DW_AT_sf_names                        = 0x2101,
185   DW_AT_src_info                        = 0x2102,
186   DW_AT_mac_info                        = 0x2103,
187   DW_AT_src_coords                      = 0x2104,
188   DW_AT_body_begin                      = 0x2105,
189   DW_AT_body_end                        = 0x2106
190 } dwarf_attribute_t;
191
192 typedef enum dwarf_form_e
193 {
194   DW_FORM_addr                          = 0x01,
195   DW_FORM_block2                        = 0x03,
196   DW_FORM_block4                        = 0x04,
197   DW_FORM_data2                         = 0x05,
198   DW_FORM_data4                         = 0x06,
199   DW_FORM_data8                         = 0x07,
200   DW_FORM_string                        = 0x08,
201   DW_FORM_block                         = 0x09,
202   DW_FORM_block1                        = 0x0a,
203   DW_FORM_data1                         = 0x0b,
204   DW_FORM_flag                          = 0x0c,
205   DW_FORM_sdata                         = 0x0d,
206   DW_FORM_strp                          = 0x0e,
207   DW_FORM_udata                         = 0x0f,
208   DW_FORM_ref_addr                      = 0x10,
209   DW_FORM_ref1                          = 0x11,
210   DW_FORM_ref2                          = 0x12,
211   DW_FORM_ref4                          = 0x13,
212   DW_FORM_ref8                          = 0x14,
213   DW_FORM_ref_udata                     = 0x15,
214   DW_FORM_indirect                      = 0x16
215 } dwarf_form_t;
216
217 /** type encoding */
218 typedef enum dwarf_type_e
219 {
220   DW_ATE_void                           = 0x0,
221   DW_ATE_address                        = 0x1,
222   DW_ATE_boolean                        = 0x2,
223   DW_ATE_complex_float                  = 0x3,
224   DW_ATE_float                          = 0x4,
225   DW_ATE_signed                         = 0x5,
226   DW_ATE_signed_char                    = 0x6,
227   DW_ATE_unsigned                       = 0x7,
228   DW_ATE_unsigned_char                  = 0x8
229 } dwarf_type_t;
230
231 typedef enum dwarf_operation_e
232 {
233   DW_OP_addr                            = 0x03,
234   DW_OP_deref                           = 0x06,
235   DW_OP_const1u                         = 0x08,
236   DW_OP_const1s                         = 0x09,
237   DW_OP_const2u                         = 0x0a,
238   DW_OP_const2s                         = 0x0b,
239   DW_OP_const4u                         = 0x0c,
240   DW_OP_const4s                         = 0x0d,
241   DW_OP_const8u                         = 0x0e,
242   DW_OP_const8s                         = 0x0f,
243   DW_OP_constu                          = 0x10,
244   DW_OP_consts                          = 0x11,
245   DW_OP_dup                             = 0x12,
246   DW_OP_drop                            = 0x13,
247   DW_OP_over                            = 0x14,
248   DW_OP_pick                            = 0x15,
249   DW_OP_swap                            = 0x16,
250   DW_OP_rot                             = 0x17,
251   DW_OP_xderef                          = 0x18,
252   DW_OP_abs                             = 0x19,
253   DW_OP_and                             = 0x1a,
254   DW_OP_div                             = 0x1b,
255   DW_OP_minus                           = 0x1c,
256   DW_OP_mod                             = 0x1d,
257   DW_OP_mul                             = 0x1e,
258   DW_OP_neg                             = 0x1f,
259   DW_OP_not                             = 0x20,
260   DW_OP_or                              = 0x21,
261   DW_OP_plus                            = 0x22,
262   DW_OP_plus_uconst                     = 0x23,
263   DW_OP_shl                             = 0x24,
264   DW_OP_shr                             = 0x25,
265   DW_OP_shra                            = 0x26,
266   DW_OP_xor                             = 0x27,
267   DW_OP_bra                             = 0x28,
268   DW_OP_eq                              = 0x29,
269   DW_OP_ge                              = 0x2a,
270   DW_OP_gt                              = 0x2b,
271   DW_OP_le                              = 0x2c,
272   DW_OP_lt                              = 0x2d,
273   DW_OP_ne                              = 0x2e,
274   DW_OP_skip                            = 0x2f,
275   DW_OP_lit0                            = 0x30,
276   DW_OP_lit1                            = 0x31,
277   DW_OP_lit2                            = 0x32,
278   DW_OP_lit3                            = 0x33,
279   DW_OP_lit4                            = 0x34,
280   DW_OP_lit5                            = 0x35,
281   DW_OP_lit6                            = 0x36,
282   DW_OP_lit7                            = 0x37,
283   DW_OP_lit8                            = 0x38,
284   DW_OP_lit9                            = 0x39,
285   DW_OP_lit10                           = 0x3a,
286   DW_OP_lit11                           = 0x3b,
287   DW_OP_lit12                           = 0x3c,
288   DW_OP_lit13                           = 0x3d,
289   DW_OP_lit14                           = 0x3e,
290   DW_OP_lit15                           = 0x3f,
291   DW_OP_lit16                           = 0x40,
292   DW_OP_lit17                           = 0x41,
293   DW_OP_lit18                           = 0x42,
294   DW_OP_lit19                           = 0x43,
295   DW_OP_lit20                           = 0x44,
296   DW_OP_lit21                           = 0x45,
297   DW_OP_lit22                           = 0x46,
298   DW_OP_lit23                           = 0x47,
299   DW_OP_lit24                           = 0x48,
300   DW_OP_lit25                           = 0x49,
301   DW_OP_lit26                           = 0x4a,
302   DW_OP_lit27                           = 0x4b,
303   DW_OP_lit28                           = 0x4c,
304   DW_OP_lit29                           = 0x4d,
305   DW_OP_lit30                           = 0x4e,
306   DW_OP_lit31                           = 0x4f,
307   DW_OP_reg0                            = 0x50,
308   DW_OP_reg1                            = 0x51,
309   DW_OP_reg2                            = 0x52,
310   DW_OP_reg3                            = 0x53,
311   DW_OP_reg4                            = 0x54,
312   DW_OP_reg5                            = 0x55,
313   DW_OP_reg6                            = 0x56,
314   DW_OP_reg7                            = 0x57,
315   DW_OP_reg8                            = 0x58,
316   DW_OP_reg9                            = 0x59,
317   DW_OP_reg10                           = 0x5a,
318   DW_OP_reg11                           = 0x5b,
319   DW_OP_reg12                           = 0x5c,
320   DW_OP_reg13                           = 0x5d,
321   DW_OP_reg14                           = 0x5e,
322   DW_OP_reg15                           = 0x5f,
323   DW_OP_reg16                           = 0x60,
324   DW_OP_reg17                           = 0x61,
325   DW_OP_reg18                           = 0x62,
326   DW_OP_reg19                           = 0x63,
327   DW_OP_reg20                           = 0x64,
328   DW_OP_reg21                           = 0x65,
329   DW_OP_reg22                           = 0x66,
330   DW_OP_reg23                           = 0x67,
331   DW_OP_reg24                           = 0x68,
332   DW_OP_reg25                           = 0x69,
333   DW_OP_reg26                           = 0x6a,
334   DW_OP_reg27                           = 0x6b,
335   DW_OP_reg28                           = 0x6c,
336   DW_OP_reg29                           = 0x6d,
337   DW_OP_reg30                           = 0x6e,
338   DW_OP_reg31                           = 0x6f,
339   DW_OP_breg0                           = 0x70,
340   DW_OP_breg1                           = 0x71,
341   DW_OP_breg2                           = 0x72,
342   DW_OP_breg3                           = 0x73,
343   DW_OP_breg4                           = 0x74,
344   DW_OP_breg5                           = 0x75,
345   DW_OP_breg6                           = 0x76,
346   DW_OP_breg7                           = 0x77,
347   DW_OP_breg8                           = 0x78,
348   DW_OP_breg9                           = 0x79,
349   DW_OP_breg10                          = 0x7a,
350   DW_OP_breg11                          = 0x7b,
351   DW_OP_breg12                          = 0x7c,
352   DW_OP_breg13                          = 0x7d,
353   DW_OP_breg14                          = 0x7e,
354   DW_OP_breg15                          = 0x7f,
355   DW_OP_breg16                          = 0x80,
356   DW_OP_breg17                          = 0x81,
357   DW_OP_breg18                          = 0x82,
358   DW_OP_breg19                          = 0x83,
359   DW_OP_breg20                          = 0x84,
360   DW_OP_breg21                          = 0x85,
361   DW_OP_breg22                          = 0x86,
362   DW_OP_breg23                          = 0x87,
363   DW_OP_breg24                          = 0x88,
364   DW_OP_breg25                          = 0x89,
365   DW_OP_breg26                          = 0x8a,
366   DW_OP_breg27                          = 0x8b,
367   DW_OP_breg28                          = 0x8c,
368   DW_OP_breg29                          = 0x8d,
369   DW_OP_breg30                          = 0x8e,
370   DW_OP_breg31                          = 0x8f,
371   DW_OP_regx                            = 0x90,
372   DW_OP_fbreg                           = 0x91,
373   DW_OP_bregx                           = 0x92,
374   DW_OP_piece                           = 0x93,
375   DW_OP_deref_size                      = 0x94,
376   DW_OP_xderef_size                     = 0x95,
377   DW_OP_nop                             = 0x96
378 } dwarf_operation_t;
379
380 enum dwarf_calling_convention
381 {
382     DW_CC_normal                        = 0x1,
383     DW_CC_program                       = 0x2,
384     DW_CC_nocall                        = 0x3
385 };
386
387 #define DW_CC_lo_user 0x40
388 #define DW_CC_hi_user 0xff
389
390 #define DW_LNS_extended_op              0x00
391 #define DW_LNS_copy                     0x01
392 #define DW_LNS_advance_pc               0x02
393 #define DW_LNS_advance_line             0x03
394 #define DW_LNS_set_file                 0x04
395 #define DW_LNS_set_column               0x05
396 #define DW_LNS_negate_stmt              0x06
397 #define DW_LNS_set_basic_block          0x07
398 #define DW_LNS_const_add_pc             0x08
399 #define DW_LNS_fixed_advance_pc         0x09
400
401 #define DW_LNE_end_sequence             0x01
402 #define DW_LNE_set_address              0x02
403 #define DW_LNE_define_file              0x03