LLVM API Documentation

Dwarf.h

Go to the documentation of this file.
00001 //===-- llvm/Support/Dwarf.h ---Dwarf Constants------------------*- C++ -*-===//
00002 //
00003 //                     The LLVM Compiler Infrastructure
00004 //
00005 // This file was developed by James M. Laskey and is distributed under the
00006 // University of Illinois Open Source License. See LICENSE.TXT for details.
00007 //
00008 //===----------------------------------------------------------------------===//
00009 //
00010 // This file contains constants used for implementing Dwarf debug support.  For
00011 // Details on the Dwarf 3 specfication see DWARF Debugging Information Format
00012 // V.3 reference manual http://dwarf.freestandards.org ,
00013 // 
00014 //===----------------------------------------------------------------------===//
00015 
00016 #ifndef LLVM_SUPPORT_DWARF_H
00017 #define LLVM_SUPPORT_DWARF_H
00018 
00019 #include "llvm/System/IncludeFile.h"
00020 
00021 namespace llvm {
00022 
00023 namespace dwarf {
00024 
00025 //===----------------------------------------------------------------------===//
00026 // Dwarf constants as gleaned from the DWARF Debugging Information Format V.3
00027 // reference manual http://dwarf.freestandards.org .
00028 //
00029 
00030 // Do not mix the following two enumerations sets.  DW_TAG_invalid changes the
00031 // enumeration base type.
00032 
00033 enum llvm_dwarf_constants {
00034   // llvm mock tags
00035   DW_TAG_invalid = ~0U,                 // Tag for invalid results.
00036   
00037   DW_TAG_anchor = 0,                    // Tag for descriptor anchors.
00038   DW_TAG_auto_variable = 0x100,         // Tag for local (auto) variables.
00039   DW_TAG_arg_variable = 0x101,          // Tag for argument variables.
00040   DW_TAG_return_variable = 0x102,       // Tag for return variables.
00041   
00042   DW_TAG_vector_type = 0x103,           // Tag for vector types.
00043   
00044   DW_TAG_user_base = 0x1000,            // Recommended base for user tags.
00045   
00046   DW_CIE_VERSION = 1,                   // Common frame information version.
00047   DW_CIE_ID  = 0xffffffff               // Common frame information mark.
00048 };
00049 
00050 enum dwarf_constants {
00051   DWARF_VERSION = 2,
00052   
00053   // Tags
00054   DW_TAG_array_type = 0x01,
00055   DW_TAG_class_type = 0x02,
00056   DW_TAG_entry_point = 0x03,
00057   DW_TAG_enumeration_type = 0x04,
00058   DW_TAG_formal_parameter = 0x05,
00059   DW_TAG_imported_declaration = 0x08,
00060   DW_TAG_label = 0x0a,
00061   DW_TAG_lexical_block = 0x0b,
00062   DW_TAG_member = 0x0d,
00063   DW_TAG_pointer_type = 0x0f,
00064   DW_TAG_reference_type = 0x10,
00065   DW_TAG_compile_unit = 0x11,
00066   DW_TAG_string_type = 0x12,
00067   DW_TAG_structure_type = 0x13,
00068   DW_TAG_subroutine_type = 0x15,
00069   DW_TAG_typedef = 0x16,
00070   DW_TAG_union_type = 0x17,
00071   DW_TAG_unspecified_parameters = 0x18,
00072   DW_TAG_variant = 0x19,
00073   DW_TAG_common_block = 0x1a,
00074   DW_TAG_common_inclusion = 0x1b,
00075   DW_TAG_inheritance = 0x1c,
00076   DW_TAG_inlined_subroutine = 0x1d,
00077   DW_TAG_module = 0x1e,
00078   DW_TAG_ptr_to_member_type = 0x1f,
00079   DW_TAG_set_type = 0x20,
00080   DW_TAG_subrange_type = 0x21,
00081   DW_TAG_with_stmt = 0x22,
00082   DW_TAG_access_declaration = 0x23,
00083   DW_TAG_base_type = 0x24,
00084   DW_TAG_catch_block = 0x25,
00085   DW_TAG_const_type = 0x26,
00086   DW_TAG_constant = 0x27,
00087   DW_TAG_enumerator = 0x28,
00088   DW_TAG_file_type = 0x29,
00089   DW_TAG_friend = 0x2a,
00090   DW_TAG_namelist = 0x2b,
00091   DW_TAG_namelist_item = 0x2c,
00092   DW_TAG_packed_type = 0x2d,
00093   DW_TAG_subprogram = 0x2e,
00094   DW_TAG_template_type_parameter = 0x2f,
00095   DW_TAG_template_value_parameter = 0x30,
00096   DW_TAG_thrown_type = 0x31,
00097   DW_TAG_try_block = 0x32,
00098   DW_TAG_variant_part = 0x33,
00099   DW_TAG_variable = 0x34,
00100   DW_TAG_volatile_type = 0x35,
00101   DW_TAG_dwarf_procedure = 0x36,
00102   DW_TAG_restrict_type = 0x37,
00103   DW_TAG_interface_type = 0x38,
00104   DW_TAG_namespace = 0x39,
00105   DW_TAG_imported_module = 0x3a,
00106   DW_TAG_unspecified_type = 0x3b,
00107   DW_TAG_partial_unit = 0x3c,
00108   DW_TAG_imported_unit = 0x3d,
00109   DW_TAG_condition = 0x3f,
00110   DW_TAG_shared_type = 0x40,
00111   DW_TAG_lo_user = 0x4080,
00112   DW_TAG_hi_user = 0xffff,
00113 
00114   // Children flag
00115   DW_CHILDREN_no = 0x00,
00116   DW_CHILDREN_yes = 0x01,
00117 
00118   // Attributes
00119   DW_AT_sibling = 0x01,
00120   DW_AT_location = 0x02,
00121   DW_AT_name = 0x03,
00122   DW_AT_ordering = 0x09,
00123   DW_AT_byte_size = 0x0b,
00124   DW_AT_bit_offset = 0x0c,
00125   DW_AT_bit_size = 0x0d,
00126   DW_AT_stmt_list = 0x10,
00127   DW_AT_low_pc = 0x11,
00128   DW_AT_high_pc = 0x12,
00129   DW_AT_language = 0x13,
00130   DW_AT_discr = 0x15,
00131   DW_AT_discr_value = 0x16,
00132   DW_AT_visibility = 0x17,
00133   DW_AT_import = 0x18,
00134   DW_AT_string_length = 0x19,
00135   DW_AT_common_reference = 0x1a,
00136   DW_AT_comp_dir = 0x1b,
00137   DW_AT_const_value = 0x1c,
00138   DW_AT_containing_type = 0x1d,
00139   DW_AT_default_value = 0x1e,
00140   DW_AT_inline = 0x20,
00141   DW_AT_is_optional = 0x21,
00142   DW_AT_lower_bound = 0x22,
00143   DW_AT_producer = 0x25,
00144   DW_AT_prototyped = 0x27,
00145   DW_AT_return_addr = 0x2a,
00146   DW_AT_start_scope = 0x2c,
00147   DW_AT_bit_stride = 0x2e,
00148   DW_AT_upper_bound = 0x2f,
00149   DW_AT_abstract_origin = 0x31,
00150   DW_AT_accessibility = 0x32,
00151   DW_AT_address_class = 0x33,
00152   DW_AT_artificial = 0x34,
00153   DW_AT_base_types = 0x35,
00154   DW_AT_calling_convention = 0x36,
00155   DW_AT_count = 0x37,
00156   DW_AT_data_member_location = 0x38,
00157   DW_AT_decl_column = 0x39,
00158   DW_AT_decl_file = 0x3a,
00159   DW_AT_decl_line = 0x3b,
00160   DW_AT_declaration = 0x3c,
00161   DW_AT_discr_list = 0x3d,
00162   DW_AT_encoding = 0x3e,
00163   DW_AT_external = 0x3f,
00164   DW_AT_frame_base = 0x40,
00165   DW_AT_friend = 0x41,
00166   DW_AT_identifier_case = 0x42,
00167   DW_AT_macro_info = 0x43,
00168   DW_AT_namelist_item = 0x44,
00169   DW_AT_priority = 0x45,
00170   DW_AT_segment = 0x46,
00171   DW_AT_specification = 0x47,
00172   DW_AT_static_link = 0x48,
00173   DW_AT_type = 0x49,
00174   DW_AT_use_location = 0x4a,
00175   DW_AT_variable_parameter = 0x4b,
00176   DW_AT_virtuality = 0x4c,
00177   DW_AT_vtable_elem_location = 0x4d,
00178   DW_AT_allocated = 0x4e,
00179   DW_AT_associated = 0x4f,
00180   DW_AT_data_location = 0x50,
00181   DW_AT_byte_stride = 0x51,
00182   DW_AT_entry_pc = 0x52,
00183   DW_AT_use_UTF8 = 0x53,
00184   DW_AT_extension = 0x54,
00185   DW_AT_ranges = 0x55,
00186   DW_AT_trampoline = 0x56,
00187   DW_AT_call_column = 0x57,
00188   DW_AT_call_file = 0x58,
00189   DW_AT_call_line = 0x59,
00190   DW_AT_description = 0x5a,
00191   DW_AT_binary_scale = 0x5b,
00192   DW_AT_decimal_scale = 0x5c,
00193   DW_AT_small = 0x5d,
00194   DW_AT_decimal_sign = 0x5e,
00195   DW_AT_digit_count = 0x5f,
00196   DW_AT_picture_string = 0x60,
00197   DW_AT_mutable = 0x61,
00198   DW_AT_threads_scaled = 0x62,
00199   DW_AT_explicit = 0x63,
00200   DW_AT_object_pointer = 0x64,
00201   DW_AT_endianity = 0x65,
00202   DW_AT_elemental = 0x66,
00203   DW_AT_pure = 0x67,
00204   DW_AT_recursive = 0x68,
00205   DW_AT_sf_names = 0x2101,
00206   DW_AT_src_info = 0x2102,
00207   DW_AT_mac_info = 0x2103,
00208   DW_AT_src_coords = 0x2104,
00209   DW_AT_body_begin = 0x2105,
00210   DW_AT_body_end = 0x2106,
00211   DW_AT_GNU_vector = 0x2107,
00212   DW_AT_lo_user = 0x2000,
00213   DW_AT_hi_user = 0x3fff,
00214 
00215   // Attribute form encodings
00216   DW_FORM_addr = 0x01,
00217   DW_FORM_block2 = 0x03,
00218   DW_FORM_block4 = 0x04,
00219   DW_FORM_data2 = 0x05,
00220   DW_FORM_data4 = 0x06,
00221   DW_FORM_data8 = 0x07,
00222   DW_FORM_string = 0x08,
00223   DW_FORM_block = 0x09,
00224   DW_FORM_block1 = 0x0a,
00225   DW_FORM_data1 = 0x0b,
00226   DW_FORM_flag = 0x0c,
00227   DW_FORM_sdata = 0x0d,
00228   DW_FORM_strp = 0x0e,
00229   DW_FORM_udata = 0x0f,
00230   DW_FORM_ref_addr = 0x10,
00231   DW_FORM_ref1 = 0x11,
00232   DW_FORM_ref2 = 0x12,
00233   DW_FORM_ref4 = 0x13,
00234   DW_FORM_ref8 = 0x14,
00235   DW_FORM_ref_udata = 0x15,
00236   DW_FORM_indirect = 0x16,
00237 
00238   // Operation encodings
00239   DW_OP_addr = 0x03,
00240   DW_OP_deref = 0x06,
00241   DW_OP_const1u = 0x08,
00242   DW_OP_const1s = 0x09,
00243   DW_OP_const2u = 0x0a,
00244   DW_OP_const2s = 0x0b,
00245   DW_OP_const4u = 0x0c,
00246   DW_OP_const4s = 0x0d,
00247   DW_OP_const8u = 0x0e,
00248   DW_OP_const8s = 0x0f,
00249   DW_OP_constu = 0x10,
00250   DW_OP_consts = 0x11,
00251   DW_OP_dup = 0x12,
00252   DW_OP_drop = 0x13,
00253   DW_OP_over = 0x14,
00254   DW_OP_pick = 0x15,
00255   DW_OP_swap = 0x16,
00256   DW_OP_rot = 0x17,
00257   DW_OP_xderef = 0x18,
00258   DW_OP_abs = 0x19,
00259   DW_OP_and = 0x1a,
00260   DW_OP_div = 0x1b,
00261   DW_OP_minus = 0x1c,
00262   DW_OP_mod = 0x1d,
00263   DW_OP_mul = 0x1e,
00264   DW_OP_neg = 0x1f,
00265   DW_OP_not = 0x20,
00266   DW_OP_or = 0x21,
00267   DW_OP_plus = 0x22,
00268   DW_OP_plus_uconst = 0x23,
00269   DW_OP_shl = 0x24,
00270   DW_OP_shr = 0x25,
00271   DW_OP_shra = 0x26,
00272   DW_OP_xor = 0x27,
00273   DW_OP_skip = 0x2f,
00274   DW_OP_bra = 0x28,
00275   DW_OP_eq = 0x29,
00276   DW_OP_ge = 0x2a,
00277   DW_OP_gt = 0x2b,
00278   DW_OP_le = 0x2c,
00279   DW_OP_lt = 0x2d,
00280   DW_OP_ne = 0x2e,
00281   DW_OP_lit0 = 0x30,
00282   DW_OP_lit1 = 0x31,
00283   DW_OP_lit31 = 0x4f,
00284   DW_OP_reg0 = 0x50,
00285   DW_OP_reg1 = 0x51,
00286   DW_OP_reg31 = 0x6f,
00287   DW_OP_breg0 = 0x70,
00288   DW_OP_breg1 = 0x71,
00289   DW_OP_breg31 = 0x8f,
00290   DW_OP_regx = 0x90,
00291   DW_OP_fbreg = 0x91,
00292   DW_OP_bregx = 0x92,
00293   DW_OP_piece = 0x93,
00294   DW_OP_deref_size = 0x94,
00295   DW_OP_xderef_size = 0x95,
00296   DW_OP_nop = 0x96,
00297   DW_OP_push_object_address = 0x97,
00298   DW_OP_call2 = 0x98,
00299   DW_OP_call4 = 0x99,
00300   DW_OP_call_ref = 0x9a,
00301   DW_OP_form_tls_address = 0x9b,
00302   DW_OP_call_frame_cfa = 0x9c,
00303   DW_OP_lo_user = 0xe0,
00304   DW_OP_hi_user = 0xff,
00305 
00306   // Encoding attribute values
00307   DW_ATE_address = 0x01,
00308   DW_ATE_boolean = 0x02,
00309   DW_ATE_complex_float = 0x03,
00310   DW_ATE_float = 0x04,
00311   DW_ATE_signed = 0x05,
00312   DW_ATE_signed_char = 0x06,
00313   DW_ATE_unsigned = 0x07,
00314   DW_ATE_unsigned_char = 0x08,
00315   DW_ATE_imaginary_float = 0x09,
00316   DW_ATE_packed_decimal = 0x0a,
00317   DW_ATE_numeric_string = 0x0b,
00318   DW_ATE_edited = 0x0c,
00319   DW_ATE_signed_fixed = 0x0d,
00320   DW_ATE_unsigned_fixed = 0x0e,
00321   DW_ATE_decimal_float = 0x0f,
00322   DW_ATE_lo_user = 0x80,
00323   DW_ATE_hi_user = 0xff,
00324 
00325   // Decimal sign attribute values
00326   DW_DS_unsigned = 0x01,
00327   DW_DS_leading_overpunch = 0x02,
00328   DW_DS_trailing_overpunch = 0x03,
00329   DW_DS_leading_separate = 0x04,
00330   DW_DS_trailing_separate = 0x05,
00331 
00332   // Endianity attribute values
00333   DW_END_default = 0x00,
00334   DW_END_big = 0x01,
00335   DW_END_little = 0x02,
00336   DW_END_lo_user = 0x40,
00337   DW_END_hi_user = 0xff,
00338 
00339   // Accessibility codes
00340   DW_ACCESS_public = 0x01,
00341   DW_ACCESS_protected = 0x02,
00342   DW_ACCESS_private = 0x03,
00343 
00344   // Visibility codes 
00345   DW_VIS_local = 0x01,
00346   DW_VIS_exported = 0x02,
00347   DW_VIS_qualified = 0x03,
00348 
00349   // Virtuality codes
00350   DW_VIRTUALITY_none = 0x00,
00351   DW_VIRTUALITY_virtual = 0x01,
00352   DW_VIRTUALITY_pure_virtual = 0x02,
00353   
00354   // Language names
00355   DW_LANG_C89 = 0x0001,
00356   DW_LANG_C = 0x0002,
00357   DW_LANG_Ada83 = 0x0003,
00358   DW_LANG_C_plus_plus = 0x0004,
00359   DW_LANG_Cobol74 = 0x0005,
00360   DW_LANG_Cobol85 = 0x0006,
00361   DW_LANG_Fortran77 = 0x0007,
00362   DW_LANG_Fortran90 = 0x0008,
00363   DW_LANG_Pascal83 = 0x0009,
00364   DW_LANG_Modula2 = 0x000a,
00365   DW_LANG_Java = 0x000b,
00366   DW_LANG_C99 = 0x000c,
00367   DW_LANG_Ada95 = 0x000d,
00368   DW_LANG_Fortran95 = 0x000e,
00369   DW_LANG_PLI = 0x000f,
00370   DW_LANG_ObjC = 0x0010,
00371   DW_LANG_ObjC_plus_plus = 0x0011,
00372   DW_LANG_UPC = 0x0012,
00373   DW_LANG_D = 0x0013,
00374   DW_LANG_lo_user = 0x8000,
00375   DW_LANG_hi_user = 0xffff,
00376   
00377   // Identifier case codes
00378   DW_ID_case_sensitive = 0x00,
00379   DW_ID_up_case = 0x01,
00380   DW_ID_down_case = 0x02,
00381   DW_ID_case_insensitive = 0x03,
00382 
00383   // Calling convention codes
00384   DW_CC_normal = 0x01,
00385   DW_CC_program = 0x02,
00386   DW_CC_nocall = 0x03,
00387   DW_CC_lo_user = 0x40,
00388   DW_CC_hi_user = 0xff,
00389 
00390   // Inline codes
00391   DW_INL_not_inlined = 0x00,
00392   DW_INL_inlined = 0x01,
00393   DW_INL_declared_not_inlined = 0x02,
00394   DW_INL_declared_inlined = 0x03,
00395 
00396   // Array ordering 
00397   DW_ORD_row_major = 0x00,
00398   DW_ORD_col_major = 0x01,
00399 
00400   // Discriminant descriptor values
00401   DW_DSC_label = 0x00,
00402   DW_DSC_range = 0x01,
00403 
00404   // Line Number Standard Opcode Encodings
00405   DW_LNS_copy = 0x01,
00406   DW_LNS_advance_pc = 0x02,
00407   DW_LNS_advance_line = 0x03,
00408   DW_LNS_set_file = 0x04,
00409   DW_LNS_set_column = 0x05,
00410   DW_LNS_negate_stmt = 0x06,
00411   DW_LNS_set_basic_block = 0x07,
00412   DW_LNS_const_add_pc = 0x08,
00413   DW_LNS_fixed_advance_pc = 0x09,
00414   DW_LNS_set_prologue_end = 0x0a,
00415   DW_LNS_set_epilogue_begin = 0x0b,
00416   DW_LNS_set_isa = 0x0c,
00417 
00418   // Line Number Extended Opcode Encodings
00419   DW_LNE_end_sequence = 0x01,
00420   DW_LNE_set_address = 0x02,
00421   DW_LNE_define_file = 0x03,
00422   DW_LNE_lo_user = 0x80,
00423   DW_LNE_hi_user = 0xff,
00424 
00425   // Macinfo Type Encodings
00426   DW_MACINFO_define = 0x01,
00427   DW_MACINFO_undef = 0x02,
00428   DW_MACINFO_start_file = 0x03,
00429   DW_MACINFO_end_file = 0x04,
00430   DW_MACINFO_vendor_ext = 0xff,
00431 
00432   // Call frame instruction encodings
00433   DW_CFA_extended = 0x00,
00434   DW_CFA_advance_loc = 0x40,
00435   DW_CFA_offset = 0x80,
00436   DW_CFA_restore = 0xc0,
00437   DW_CFA_set_loc = 0x01,
00438   DW_CFA_advance_loc1 = 0x02,
00439   DW_CFA_advance_loc2 = 0x03,
00440   DW_CFA_advance_loc4 = 0x04,
00441   DW_CFA_offset_extended = 0x05,
00442   DW_CFA_restore_extended = 0x06,
00443   DW_CFA_undefined = 0x07,
00444   DW_CFA_same_value = 0x08,
00445   DW_CFA_register = 0x09,
00446   DW_CFA_remember_state = 0x0a,
00447   DW_CFA_restore_state = 0x0b,
00448   DW_CFA_def_cfa = 0x0c,
00449   DW_CFA_def_cfa_register = 0x0d,
00450   DW_CFA_def_cfa_offset = 0x0e,
00451   DW_CFA_def_cfa_expression = 0x0f,
00452   DW_CFA_expression = 0x10,
00453   DW_CFA_offset_extended_sf = 0x11,
00454   DW_CFA_def_cfa_sf = 0x12,
00455   DW_CFA_def_cfa_offset_sf = 0x13,
00456   DW_CFA_val_offset = 0x14,
00457   DW_CFA_val_offset_sf = 0x15,
00458   DW_CFA_val_expression = 0x16,
00459   DW_CFA_lo_user = 0x1c,
00460   DW_CFA_hi_user = 0x3f
00461 };
00462 
00463 /// TagString - Return the string for the specified tag.
00464 ///
00465 const char *TagString(unsigned Tag);
00466 
00467 /// ChildrenString - Return the string for the specified children flag.
00468 ///
00469 const char *ChildrenString(unsigned Children);
00470 
00471 /// AttributeString - Return the string for the specified attribute.
00472 ///
00473 const char *AttributeString(unsigned Attribute);
00474 
00475 /// FormEncodingString - Return the string for the specified form encoding.
00476 ///
00477 const char *FormEncodingString(unsigned Encoding);
00478 
00479 /// OperationEncodingString - Return the string for the specified operation
00480 /// encoding.
00481 const char *OperationEncodingString(unsigned Encoding);
00482 
00483 /// AttributeEncodingString - Return the string for the specified attribute
00484 /// encoding.
00485 const char *AttributeEncodingString(unsigned Encoding);
00486 
00487 /// DecimalSignString - Return the string for the specified decimal sign
00488 /// attribute.
00489 const char *DecimalSignString(unsigned Sign);
00490 
00491 /// EndianityString - Return the string for the specified endianity.
00492 ///
00493 const char *EndianityString(unsigned Endian);
00494 
00495 /// AccessibilityString - Return the string for the specified accessibility.
00496 ///
00497 const char *AccessibilityString(unsigned Access);
00498 
00499 /// VisibilityString - Return the string for the specified visibility.
00500 ///
00501 const char *VisibilityString(unsigned Visibility);
00502 
00503 /// VirtualityString - Return the string for the specified virtuality.
00504 ///
00505 const char *VirtualityString(unsigned Virtuality);
00506 
00507 /// LanguageString - Return the string for the specified language.
00508 ///
00509 const char *LanguageString(unsigned Language);
00510 
00511 /// CaseString - Return the string for the specified identifier case.
00512 ///
00513 const char *CaseString(unsigned Case);
00514 
00515 /// ConventionString - Return the string for the specified calling convention.
00516 ///
00517 const char *ConventionString(unsigned Convention);
00518 
00519 /// InlineCodeString - Return the string for the specified inline code.
00520 ///
00521 const char *InlineCodeString(unsigned Code);
00522 
00523 /// ArrayOrderString - Return the string for the specified array order.
00524 ///
00525 const char *ArrayOrderString(unsigned Order);
00526 
00527 /// DiscriminantString - Return the string for the specified discriminant
00528 /// descriptor.
00529 const char *DiscriminantString(unsigned Discriminant);
00530 
00531 /// LNStandardString - Return the string for the specified line number standard.
00532 ///
00533 const char *LNStandardString(unsigned Standard);
00534  
00535 /// LNExtendedString - Return the string for the specified line number extended
00536 /// opcode encodings.
00537 const char *LNExtendedString(unsigned Encoding);
00538 
00539 /// MacinfoString - Return the string for the specified macinfo type encodings.
00540 ///
00541 const char *MacinfoString(unsigned Encoding);
00542 
00543 /// CallFrameString - Return the string for the specified call frame instruction
00544 /// encodings.
00545 const char *CallFrameString(unsigned Encoding);
00546 
00547 } // End of namespace dwarf
00548 
00549 } // End of namespace llvm
00550 
00551 FORCE_DEFINING_FILE_TO_BE_LINKED(SupportDwarf)
00552 
00553 #endif