include/llvm/Support/Dwarf.h

   1 //===-- llvm/Support/Dwarf.h ---Dwarf Constants------------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by James M. Laskey and is distributed under the
   6 // University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file contains constants used for implementing Dwarf debug support.  For
  11 // Details on the Dwarf 3 specfication see DWARF Debugging Information Format
  12 // V.3 reference manual http://dwarf.freestandards.org ,
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #ifndef LLVM_SUPPORT_DWARF_H
  17 #define LLVM_SUPPORT_DWARF_H
  18
  19 namespace llvm {
  20
  21 namespace dwarf {
  22
  23 //===----------------------------------------------------------------------===//
  24 // Dwarf constants as gleaned from the DWARF Debugging Information Format V.3
  25 // reference manual http://dwarf.freestandards.org .
  26 //
  27
  28 // Do not mix the following two enumerations sets.  DW_TAG_invalid changes the
  29 // enumeration base type.
  30
  31 enum llvm_dwarf_constants {
  32   // llvm mock tags
  33   DW_TAG_invalid = ~0U,                 // Tag for invalid results.
  34
  35   DW_TAG_anchor = 0,                    // Tag for descriptor anchors.
  36   DW_TAG_auto_variable = 0x100,         // Tag for local (auto) variables.
  37   DW_TAG_arg_variable = 0x101,          // Tag for argument variables.
  38   DW_TAG_return_variable = 0x102,       // Tag for return variables.
  39
  40   DW_TAG_user_base = 0x1000,             // Recommended base for user tags.
  41
  42   DW_CIE_VERSION = 1,                    // Common frame information version.
  43   DW_CIE_ID      = 0xffffffff                // Common frame information mark.
  44 };
  45
  46 enum dwarf_constants {
  47   DWARF_VERSION = 2,
  48
  49   // Tags
  50   DW_TAG_array_type = 0x01,
  51   DW_TAG_class_type = 0x02,
  52   DW_TAG_entry_point = 0x03,
  53   DW_TAG_enumeration_type = 0x04,
  54   DW_TAG_formal_parameter = 0x05,
  55   DW_TAG_imported_declaration = 0x08,
  56   DW_TAG_label = 0x0a,
  57   DW_TAG_lexical_block = 0x0b,
  58   DW_TAG_member = 0x0d,
  59   DW_TAG_pointer_type = 0x0f,
  60   DW_TAG_reference_type = 0x10,
  61   DW_TAG_compile_unit = 0x11,
  62   DW_TAG_string_type = 0x12,
  63   DW_TAG_structure_type = 0x13,
  64   DW_TAG_subroutine_type = 0x15,
  65   DW_TAG_typedef = 0x16,
  66   DW_TAG_union_type = 0x17,
  67   DW_TAG_unspecified_parameters = 0x18,
  68   DW_TAG_variant = 0x19,
  69   DW_TAG_common_block = 0x1a,
  70   DW_TAG_common_inclusion = 0x1b,
  71   DW_TAG_inheritance = 0x1c,
  72   DW_TAG_inlined_subroutine = 0x1d,
  73   DW_TAG_module = 0x1e,
  74   DW_TAG_ptr_to_member_type = 0x1f,
  75   DW_TAG_set_type = 0x20,
  76   DW_TAG_subrange_type = 0x21,
  77   DW_TAG_with_stmt = 0x22,
  78   DW_TAG_access_declaration = 0x23,
  79   DW_TAG_base_type = 0x24,
  80   DW_TAG_catch_block = 0x25,
  81   DW_TAG_const_type = 0x26,
  82   DW_TAG_constant = 0x27,
  83   DW_TAG_enumerator = 0x28,
  84   DW_TAG_file_type = 0x29,
  85   DW_TAG_friend = 0x2a,
  86   DW_TAG_namelist = 0x2b,
  87   DW_TAG_namelist_item = 0x2c,
  88   DW_TAG_packed_type = 0x2d,
  89   DW_TAG_subprogram = 0x2e,
  90   DW_TAG_template_type_parameter = 0x2f,
  91   DW_TAG_template_value_parameter = 0x30,
  92   DW_TAG_thrown_type = 0x31,
  93   DW_TAG_try_block = 0x32,
  94   DW_TAG_variant_part = 0x33,
  95   DW_TAG_variable = 0x34,
  96   DW_TAG_volatile_type = 0x35,
  97   DW_TAG_dwarf_procedure = 0x36,
  98   DW_TAG_restrict_type = 0x37,
  99   DW_TAG_interface_type = 0x38,
 100   DW_TAG_namespace = 0x39,
 101   DW_TAG_imported_module = 0x3a,
 102   DW_TAG_unspecified_type = 0x3b,
 103   DW_TAG_partial_unit = 0x3c,
 104   DW_TAG_imported_unit = 0x3d,
 105   DW_TAG_condition = 0x3f,
 106   DW_TAG_shared_type = 0x40,
 107   DW_TAG_lo_user = 0x4080,
 108   DW_TAG_hi_user = 0xffff,
 109
 110   // Children flag
 111   DW_CHILDREN_no = 0x00,
 112   DW_CHILDREN_yes = 0x01,
 113
 114   // Attributes
 115   DW_AT_sibling = 0x01,
 116   DW_AT_location = 0x02,
 117   DW_AT_name = 0x03,
 118   DW_AT_ordering = 0x09,
 119   DW_AT_byte_size = 0x0b,
 120   DW_AT_bit_offset = 0x0c,
 121   DW_AT_bit_size = 0x0d,
 122   DW_AT_stmt_list = 0x10,
 123   DW_AT_low_pc = 0x11,
 124   DW_AT_high_pc = 0x12,
 125   DW_AT_language = 0x13,
 126   DW_AT_discr = 0x15,
 127   DW_AT_discr_value = 0x16,
 128   DW_AT_visibility = 0x17,
 129   DW_AT_import = 0x18,
 130   DW_AT_string_length = 0x19,
 131   DW_AT_common_reference = 0x1a,
 132   DW_AT_comp_dir = 0x1b,
 133   DW_AT_const_value = 0x1c,
 134   DW_AT_containing_type = 0x1d,
 135   DW_AT_default_value = 0x1e,
 136   DW_AT_inline = 0x20,
 137   DW_AT_is_optional = 0x21,
 138   DW_AT_lower_bound = 0x22,
 139   DW_AT_producer = 0x25,
 140   DW_AT_prototyped = 0x27,
 141   DW_AT_return_addr = 0x2a,
 142   DW_AT_start_scope = 0x2c,
 143   DW_AT_bit_stride = 0x2e,
 144   DW_AT_upper_bound = 0x2f,
 145   DW_AT_abstract_origin = 0x31,
 146   DW_AT_accessibility = 0x32,
 147   DW_AT_address_class = 0x33,
 148   DW_AT_artificial = 0x34,
 149   DW_AT_base_types = 0x35,
 150   DW_AT_calling_convention = 0x36,
 151   DW_AT_count = 0x37,
 152   DW_AT_data_member_location = 0x38,
 153   DW_AT_decl_column = 0x39,
 154   DW_AT_decl_file = 0x3a,
 155   DW_AT_decl_line = 0x3b,
 156   DW_AT_declaration = 0x3c,
 157   DW_AT_discr_list = 0x3d,
 158   DW_AT_encoding = 0x3e,
 159   DW_AT_external = 0x3f,
 160   DW_AT_frame_base = 0x40,
 161   DW_AT_friend = 0x41,
 162   DW_AT_identifier_case = 0x42,
 163   DW_AT_macro_info = 0x43,
 164   DW_AT_namelist_item = 0x44,
 165   DW_AT_priority = 0x45,
 166   DW_AT_segment = 0x46,
 167   DW_AT_specification = 0x47,
 168   DW_AT_static_link = 0x48,
 169   DW_AT_type = 0x49,
 170   DW_AT_use_location = 0x4a,
 171   DW_AT_variable_parameter = 0x4b,
 172   DW_AT_virtuality = 0x4c,
 173   DW_AT_vtable_elem_location = 0x4d,
 174   DW_AT_allocated = 0x4e,
 175   DW_AT_associated = 0x4f,
 176   DW_AT_data_location = 0x50,
 177   DW_AT_byte_stride = 0x51,
 178   DW_AT_entry_pc = 0x52,
 179   DW_AT_use_UTF8 = 0x53,
 180   DW_AT_extension = 0x54,
 181   DW_AT_ranges = 0x55,
 182   DW_AT_trampoline = 0x56,
 183   DW_AT_call_column = 0x57,
 184   DW_AT_call_file = 0x58,
 185   DW_AT_call_line = 0x59,
 186   DW_AT_description = 0x5a,
 187   DW_AT_binary_scale = 0x5b,
 188   DW_AT_decimal_scale = 0x5c,
 189   DW_AT_small = 0x5d,
 190   DW_AT_decimal_sign = 0x5e,
 191   DW_AT_digit_count = 0x5f,
 192   DW_AT_picture_string = 0x60,
 193   DW_AT_mutable = 0x61,
 194   DW_AT_threads_scaled = 0x62,
 195   DW_AT_explicit = 0x63,
 196   DW_AT_object_pointer = 0x64,
 197   DW_AT_endianity = 0x65,
 198   DW_AT_elemental = 0x66,
 199   DW_AT_pure = 0x67,
 200   DW_AT_recursive = 0x68,
 201   DW_AT_lo_user = 0x2000,
 202   DW_AT_hi_user = 0x3fff,
 203
 204   // Attribute form encodings
 205   DW_FORM_addr = 0x01,
 206   DW_FORM_block2 = 0x03,
 207   DW_FORM_block4 = 0x04,
 208   DW_FORM_data2 = 0x05,
 209   DW_FORM_data4 = 0x06,
 210   DW_FORM_data8 = 0x07,
 211   DW_FORM_string = 0x08,
 212   DW_FORM_block = 0x09,
 213   DW_FORM_block1 = 0x0a,
 214   DW_FORM_data1 = 0x0b,
 215   DW_FORM_flag = 0x0c,
 216   DW_FORM_sdata = 0x0d,
 217   DW_FORM_strp = 0x0e,
 218   DW_FORM_udata = 0x0f,
 219   DW_FORM_ref_addr = 0x10,
 220   DW_FORM_ref1 = 0x11,
 221   DW_FORM_ref2 = 0x12,
 222   DW_FORM_ref4 = 0x13,
 223   DW_FORM_ref8 = 0x14,
 224   DW_FORM_ref_udata = 0x15,
 225   DW_FORM_indirect = 0x16,
 226
 227   // Operation encodings
 228   DW_OP_addr = 0x03,
 229   DW_OP_deref = 0x06,
 230   DW_OP_const1u = 0x08,
 231   DW_OP_const1s = 0x09,
 232   DW_OP_const2u = 0x0a,
 233   DW_OP_const2s = 0x0b,
 234   DW_OP_const4u = 0x0c,
 235   DW_OP_const4s = 0x0d,
 236   DW_OP_const8u = 0x0e,
 237   DW_OP_const8s = 0x0f,
 238   DW_OP_constu = 0x10,
 239   DW_OP_consts = 0x11,
 240   DW_OP_dup = 0x12,
 241   DW_OP_drop = 0x13,
 242   DW_OP_over = 0x14,
 243   DW_OP_pick = 0x15,
 244   DW_OP_swap = 0x16,
 245   DW_OP_rot = 0x17,
 246   DW_OP_xderef = 0x18,
 247   DW_OP_abs = 0x19,
 248   DW_OP_and = 0x1a,
 249   DW_OP_div = 0x1b,
 250   DW_OP_minus = 0x1c,
 251   DW_OP_mod = 0x1d,
 252   DW_OP_mul = 0x1e,
 253   DW_OP_neg = 0x1f,
 254   DW_OP_not = 0x20,
 255   DW_OP_or = 0x21,
 256   DW_OP_plus = 0x22,
 257   DW_OP_plus_uconst = 0x23,
 258   DW_OP_shl = 0x24,
 259   DW_OP_shr = 0x25,
 260   DW_OP_shra = 0x26,
 261   DW_OP_xor = 0x27,
 262   DW_OP_skip = 0x2f,
 263   DW_OP_bra = 0x28,
 264   DW_OP_eq = 0x29,
 265   DW_OP_ge = 0x2a,
 266   DW_OP_gt = 0x2b,
 267   DW_OP_le = 0x2c,
 268   DW_OP_lt = 0x2d,
 269   DW_OP_ne = 0x2e,
 270   DW_OP_lit0 = 0x30,
 271   DW_OP_lit1 = 0x31,
 272   DW_OP_lit31 = 0x4f,
 273   DW_OP_reg0 = 0x50,
 274   DW_OP_reg1 = 0x51,
 275   DW_OP_reg31 = 0x6f,
 276   DW_OP_breg0 = 0x70,
 277   DW_OP_breg1 = 0x71,
 278   DW_OP_breg31 = 0x8f,
 279   DW_OP_regx = 0x90,
 280   DW_OP_fbreg = 0x91,
 281   DW_OP_bregx = 0x92,
 282   DW_OP_piece = 0x93,
 283   DW_OP_deref_size = 0x94,
 284   DW_OP_xderef_size = 0x95,
 285   DW_OP_nop = 0x96,
 286   DW_OP_push_object_address = 0x97,
 287   DW_OP_call2 = 0x98,
 288   DW_OP_call4 = 0x99,
 289   DW_OP_call_ref = 0x9a,
 290   DW_OP_form_tls_address = 0x9b,
 291   DW_OP_call_frame_cfa = 0x9c,
 292   DW_OP_lo_user = 0xe0,
 293   DW_OP_hi_user = 0xff,
 294
 295   // Encoding attribute values
 296   DW_ATE_address = 0x01,
 297   DW_ATE_boolean = 0x02,
 298   DW_ATE_complex_float = 0x03,
 299   DW_ATE_float = 0x04,
 300   DW_ATE_signed = 0x05,
 301   DW_ATE_signed_char = 0x06,
 302   DW_ATE_unsigned = 0x07,
 303   DW_ATE_unsigned_char = 0x08,
 304   DW_ATE_imaginary_float = 0x09,
 305   DW_ATE_packed_decimal = 0x0a,
 306   DW_ATE_numeric_string = 0x0b,
 307   DW_ATE_edited = 0x0c,
 308   DW_ATE_signed_fixed = 0x0d,
 309   DW_ATE_unsigned_fixed = 0x0e,
 310   DW_ATE_decimal_float = 0x0f,
 311   DW_ATE_lo_user = 0x80,
 312   DW_ATE_hi_user = 0xff,
 313
 314   // Decimal sign attribute values
 315   DW_DS_unsigned = 0x01,
 316   DW_DS_leading_overpunch = 0x02,
 317   DW_DS_trailing_overpunch = 0x03,
 318   DW_DS_leading_separate = 0x04,
 319   DW_DS_trailing_separate = 0x05,
 320
 321   // Endianity attribute values
 322   DW_END_default = 0x00,
 323   DW_END_big = 0x01,
 324   DW_END_little = 0x02,
 325   DW_END_lo_user = 0x40,
 326   DW_END_hi_user = 0xff,
 327
 328   // Accessibility codes
 329   DW_ACCESS_public = 0x01,
 330   DW_ACCESS_protected = 0x02,
 331   DW_ACCESS_private = 0x03,
 332
 333   // Visibility codes
 334   DW_VIS_local = 0x01,
 335   DW_VIS_exported = 0x02,
 336   DW_VIS_qualified = 0x03,
 337
 338   // Virtuality codes
 339   DW_VIRTUALITY_none = 0x00,
 340   DW_VIRTUALITY_virtual = 0x01,
 341   DW_VIRTUALITY_pure_virtual = 0x02,
 342
 343   // Language names
 344   DW_LANG_C89 = 0x0001,
 345   DW_LANG_C = 0x0002,
 346   DW_LANG_Ada83 = 0x0003,
 347   DW_LANG_C_plus_plus = 0x0004,
 348   DW_LANG_Cobol74 = 0x0005,
 349   DW_LANG_Cobol85 = 0x0006,
 350   DW_LANG_Fortran77 = 0x0007,
 351   DW_LANG_Fortran90 = 0x0008,
 352   DW_LANG_Pascal83 = 0x0009,
 353   DW_LANG_Modula2 = 0x000a,
 354   DW_LANG_Java = 0x000b,
 355   DW_LANG_C99 = 0x000c,
 356   DW_LANG_Ada95 = 0x000d,
 357   DW_LANG_Fortran95 = 0x000e,
 358   DW_LANG_PLI = 0x000f,
 359   DW_LANG_ObjC = 0x0010,
 360   DW_LANG_ObjC_plus_plus = 0x0011,
 361   DW_LANG_UPC = 0x0012,
 362   DW_LANG_D = 0x0013,
 363   DW_LANG_lo_user = 0x8000,
 364   DW_LANG_hi_user = 0xffff,
 365
 366   // Identifier case codes
 367   DW_ID_case_sensitive = 0x00,
 368   DW_ID_up_case = 0x01,
 369   DW_ID_down_case = 0x02,
 370   DW_ID_case_insensitive = 0x03,
 371
 372   // Calling convention codes
 373   DW_CC_normal = 0x01,
 374   DW_CC_program = 0x02,
 375   DW_CC_nocall = 0x03,
 376   DW_CC_lo_user = 0x40,
 377   DW_CC_hi_user = 0xff,
 378
 379   // Inline codes
 380   DW_INL_not_inlined = 0x00,
 381   DW_INL_inlined = 0x01,
 382   DW_INL_declared_not_inlined = 0x02,
 383   DW_INL_declared_inlined = 0x03,
 384
 385   // Array ordering
 386   DW_ORD_row_major = 0x00,
 387   DW_ORD_col_major = 0x01,
 388
 389   // Discriminant descriptor values
 390   DW_DSC_label = 0x00,
 391   DW_DSC_range = 0x01,
 392
 393   // Line Number Standard Opcode Encodings
 394   DW_LNS_copy = 0x01,
 395   DW_LNS_advance_pc = 0x02,
 396   DW_LNS_advance_line = 0x03,
 397   DW_LNS_set_file = 0x04,
 398   DW_LNS_set_column = 0x05,
 399   DW_LNS_negate_stmt = 0x06,
 400   DW_LNS_set_basic_block = 0x07,
 401   DW_LNS_const_add_pc = 0x08,
 402   DW_LNS_fixed_advance_pc = 0x09,
 403   DW_LNS_set_prologue_end = 0x0a,
 404   DW_LNS_set_epilogue_begin = 0x0b,
 405   DW_LNS_set_isa = 0x0c,
 406
 407   // Line Number Extended Opcode Encodings
 408   DW_LNE_end_sequence = 0x01,
 409   DW_LNE_set_address = 0x02,
 410   DW_LNE_define_file = 0x03,
 411   DW_LNE_lo_user = 0x80,
 412   DW_LNE_hi_user = 0xff,
 413
 414   // Macinfo Type Encodings
 415   DW_MACINFO_define = 0x01,
 416   DW_MACINFO_undef = 0x02,
 417   DW_MACINFO_start_file = 0x03,
 418   DW_MACINFO_end_file = 0x04,
 419   DW_MACINFO_vendor_ext = 0xff,
 420
 421   // Call frame instruction encodings
 422   DW_CFA_extended = 0x00,
 423   DW_CFA_advance_loc = 0x40,
 424   DW_CFA_offset = 0x80,
 425   DW_CFA_restore = 0xc0,
 426   DW_CFA_set_loc = 0x01,
 427   DW_CFA_advance_loc1 = 0x02,
 428   DW_CFA_advance_loc2 = 0x03,
 429   DW_CFA_advance_loc4 = 0x04,
 430   DW_CFA_offset_extended = 0x05,
 431   DW_CFA_restore_extended = 0x06,
 432   DW_CFA_undefined = 0x07,
 433   DW_CFA_same_value = 0x08,
 434   DW_CFA_register = 0x09,
 435   DW_CFA_remember_state = 0x0a,
 436   DW_CFA_restore_state = 0x0b,
 437   DW_CFA_def_cfa = 0x0c,
 438   DW_CFA_def_cfa_register = 0x0d,
 439   DW_CFA_def_cfa_offset = 0x0e,
 440   DW_CFA_def_cfa_expression = 0x0f,
 441   DW_CFA_expression = 0x10,
 442   DW_CFA_offset_extended_sf = 0x11,
 443   DW_CFA_def_cfa_sf = 0x12,
 444   DW_CFA_def_cfa_offset_sf = 0x13,
 445   DW_CFA_val_offset = 0x14,
 446   DW_CFA_val_offset_sf = 0x15,
 447   DW_CFA_val_expression = 0x16,
 448   DW_CFA_lo_user = 0x1c,
 449   DW_CFA_hi_user = 0x3f
 450 };
 451
 452 /// TagString - Return the string for the specified tag.
 453 ///
 454 const char *TagString(unsigned Tag);
 455
 456 /// ChildrenString - Return the string for the specified children flag.
 457 ///
 458 const char *ChildrenString(unsigned Children);
 459
 460 /// AttributeString - Return the string for the specified attribute.
 461 ///
 462 const char *AttributeString(unsigned Attribute);
 463
 464 /// FormEncodingString - Return the string for the specified form encoding.
 465 ///
 466 const char *FormEncodingString(unsigned Encoding);
 467
 468 /// OperationEncodingString - Return the string for the specified operation
 469 /// encoding.
 470 const char *OperationEncodingString(unsigned Encoding);
 471
 472 /// AttributeEncodingString - Return the string for the specified attribute
 473 /// encoding.
 474 const char *AttributeEncodingString(unsigned Encoding);
 475
 476 /// DecimalSignString - Return the string for the specified decimal sign
 477 /// attribute.
 478 const char *DecimalSignString(unsigned Sign);
 479
 480 /// EndianityString - Return the string for the specified endianity.
 481 ///
 482 const char *EndianityString(unsigned Endian);
 483
 484 /// AccessibilityString - Return the string for the specified accessibility.
 485 ///
 486 const char *AccessibilityString(unsigned Access);
 487
 488 /// VisibilityString - Return the string for the specified visibility.
 489 ///
 490 const char *VisibilityString(unsigned Visibility);
 491
 492 /// VirtualityString - Return the string for the specified virtuality.
 493 ///
 494 const char *VirtualityString(unsigned Virtuality);
 495
 496 /// LanguageString - Return the string for the specified language.
 497 ///
 498 const char *LanguageString(unsigned Language);
 499
 500 /// CaseString - Return the string for the specified identifier case.
 501 ///
 502 const char *CaseString(unsigned Case);
 503
 504 /// ConventionString - Return the string for the specified calling convention.
 505 ///
 506 const char *ConventionString(unsigned Convention);
 507
 508 /// InlineCodeString - Return the string for the specified inline code.
 509 ///
 510 const char *InlineCodeString(unsigned Code);
 511
 512 /// ArrayOrderString - Return the string for the specified array order.
 513 ///
 514 const char *ArrayOrderString(unsigned Order);
 515
 516 /// DiscriminantString - Return the string for the specified discriminant
 517 /// descriptor.
 518 const char *DiscriminantString(unsigned Discriminant);
 519
 520 /// LNStandardString - Return the string for the specified line number standard.
 521 ///
 522 const char *LNStandardString(unsigned Standard);
 523
 524 /// LNExtendedString - Return the string for the specified line number extended
 525 /// opcode encodings.
 526 const char *LNExtendedString(unsigned Encoding);
 527
 528 /// MacinfoString - Return the string for the specified macinfo type encodings.
 529 ///
 530 const char *MacinfoString(unsigned Encoding);
 531
 532 /// CallFrameString - Return the string for the specified call frame instruction
 533 /// encodings.
 534 const char *CallFrameString(unsigned Encoding);
 535
 536 } // End of namespace dwarf
 537
 538 } // End of namespace llvm
 539
 540 #endif