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