include/llvm/CodeGen/DwarfWriter.h

   1 //===-- llvm/CodeGen/DwarfWriter.h - Dwarf Framework ------------*- 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 support for writing dwarf debug info into asm files.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_CODEGEN_DWARFPRINTER_H
  15 #define LLVM_CODEGEN_DWARFPRINTER_H
  16
  17 namespace llvm {
  18
  19   //===----------------------------------------------------------------------===//
  20   // Dwarf constants as gleaned from the DWARF Debugging Information Format V.3
  21   // reference manual http://dwarf.freestandards.org.
  22   //
  23   enum dwarf_constants {
  24    // Tags
  25     DW_TAG_array_type = 0x01,
  26     DW_TAG_class_type = 0x02,
  27     DW_TAG_entry_point = 0x03,
  28     DW_TAG_enumeration_type = 0x04,
  29     DW_TAG_formal_parameter = 0x05,
  30     DW_TAG_imported_declaration = 0x08,
  31     DW_TAG_label = 0x0a,
  32     DW_TAG_lexical_block = 0x0b,
  33     DW_TAG_member = 0x0d,
  34     DW_TAG_pointer_type = 0x0f,
  35     DW_TAG_reference_type = 0x10,
  36     DW_TAG_compile_unit = 0x11,
  37     DW_TAG_string_type = 0x12,
  38     DW_TAG_structure_type = 0x13,
  39     DW_TAG_subroutine_type = 0x15,
  40     DW_TAG_typedef = 0x16,
  41     DW_TAG_union_type = 0x17,
  42     DW_TAG_unspecified_parameters = 0x18,
  43     DW_TAG_variant = 0x19,
  44     DW_TAG_common_block = 0x1a,
  45     DW_TAG_common_inclusion = 0x1b,
  46     DW_TAG_inheritance = 0x1c,
  47     DW_TAG_inlined_subroutine = 0x1d,
  48     DW_TAG_module = 0x1e,
  49     DW_TAG_ptr_to_member_type = 0x1f,
  50     DW_TAG_set_type = 0x20,
  51     DW_TAG_subrange_type = 0x21,
  52     DW_TAG_with_stmt = 0x22,
  53     DW_TAG_access_declaration = 0x23,
  54     DW_TAG_base_type = 0x24,
  55     DW_TAG_catch_block = 0x25,
  56     DW_TAG_const_type = 0x26,
  57     DW_TAG_constant = 0x27,
  58     DW_TAG_enumerator = 0x28,
  59     DW_TAG_file_type = 0x29,
  60     DW_TAG_friend = 0x2a,
  61     DW_TAG_namelist = 0x2b,
  62     DW_TAG_namelist_item = 0x2c,
  63     DW_TAG_packed_type = 0x2d,
  64     DW_TAG_subprogram = 0x2e,
  65     DW_TAG_template_type_parameter = 0x2f,
  66     DW_TAG_template_value_parameter = 0x30,
  67     DW_TAG_thrown_type = 0x31,
  68     DW_TAG_try_block = 0x32,
  69     DW_TAG_variant_part = 0x33,
  70     DW_TAG_variable = 0x34,
  71     DW_TAG_volatile_type = 0x35,
  72     DW_TAG_dwarf_procedure = 0x36,
  73     DW_TAG_restrict_type = 0x37,
  74     DW_TAG_interface_type = 0x38,
  75     DW_TAG_namespace = 0x39,
  76     DW_TAG_imported_module = 0x3a,
  77     DW_TAG_unspecified_type = 0x3b,
  78     DW_TAG_partial_unit = 0x3c,
  79     DW_TAG_imported_unit = 0x3d,
  80     DW_TAG_condition = 0x3f,
  81     DW_TAG_shared_type = 0x40,
  82     DW_TAG_lo_user = 0x4080,
  83     DW_TAG_hi_user = 0xffff,
  84
  85     // Children flag
  86     DW_CHILDREN_no = 0x00,
  87     DW_CHILDREN_yes = 0x01,
  88
  89     // Attributes
  90     DW_AT_sibling = 0x01,
  91     DW_AT_location = 0x02,
  92     DW_AT_name = 0x03,
  93     DW_AT_ordering = 0x09,
  94     DW_AT_byte_size = 0x0b,
  95     DW_AT_bit_offset = 0x0c,
  96     DW_AT_bit_size = 0x0d,
  97     DW_AT_stmt_list = 0x10,
  98     DW_AT_low_pc = 0x11,
  99     DW_AT_high_pc = 0x12,
 100     DW_AT_language = 0x13,
 101     DW_AT_discr = 0x15,
 102     DW_AT_discr_value = 0x16,
 103     DW_AT_visibility = 0x17,
 104     DW_AT_import = 0x18,
 105     DW_AT_string_length = 0x19,
 106     DW_AT_common_reference = 0x1a,
 107     DW_AT_comp_dir = 0x1b,
 108     DW_AT_const_value = 0x1c,
 109     DW_AT_containing_type = 0x1d,
 110     DW_AT_default_value = 0x1e,
 111     DW_AT_inline = 0x20,
 112     DW_AT_is_optional = 0x21,
 113     DW_AT_lower_bound = 0x22,
 114     DW_AT_producer = 0x25,
 115     DW_AT_prototyped = 0x27,
 116     DW_AT_return_addr = 0x2a,
 117     DW_AT_start_scope = 0x2c,
 118     DW_AT_bit_stride = 0x2e,
 119     DW_AT_upper_bound = 0x2f,
 120     DW_AT_abstract_origin = 0x31,
 121     DW_AT_accessibility = 0x32,
 122     DW_AT_address_class = 0x33,
 123     DW_AT_artificial = 0x34,
 124     DW_AT_base_types = 0x35,
 125     DW_AT_calling_convention = 0x36,
 126     DW_AT_count = 0x37,
 127     DW_AT_data_member_location = 0x38,
 128     DW_AT_decl_column = 0x39,
 129     DW_AT_decl_file = 0x3a,
 130     DW_AT_decl_line = 0x3b,
 131     DW_AT_declaration = 0x3c,
 132     DW_AT_discr_list = 0x3d,
 133     DW_AT_encoding = 0x3e,
 134     DW_AT_external = 0x3f,
 135     DW_AT_frame_base = 0x40,
 136     DW_AT_friend = 0x41,
 137     DW_AT_identifier_case = 0x42,
 138     DW_AT_macro_info = 0x43,
 139     DW_AT_namelist_item = 0x44,
 140     DW_AT_priority = 0x45,
 141     DW_AT_segment = 0x46,
 142     DW_AT_specification = 0x47,
 143     DW_AT_static_link = 0x48,
 144     DW_AT_type = 0x49,
 145     DW_AT_use_location = 0x4a,
 146     DW_AT_variable_parameter = 0x4b,
 147     DW_AT_virtuality = 0x4c,
 148     DW_AT_vtable_elem_location = 0x4d,
 149     DW_AT_allocated = 0x4e,
 150     DW_AT_associated = 0x4f,
 151     DW_AT_data_location = 0x50,
 152     DW_AT_byte_stride = 0x51,
 153     DW_AT_entry_pc = 0x52,
 154     DW_AT_use_UTF8 = 0x53,
 155     DW_AT_extension = 0x54,
 156     DW_AT_ranges = 0x55,
 157     DW_AT_trampoline = 0x56,
 158     DW_AT_call_column = 0x57,
 159     DW_AT_call_file = 0x58,
 160     DW_AT_call_line = 0x59,
 161     DW_AT_description = 0x5a,
 162     DW_AT_binary_scale = 0x5b,
 163     DW_AT_decimal_scale = 0x5c,
 164     DW_AT_small = 0x5d,
 165     DW_AT_decimal_sign = 0x5e,
 166     DW_AT_digit_count = 0x5f,
 167     DW_AT_picture_string = 0x60,
 168     DW_AT_mutable = 0x61,
 169     DW_AT_threads_scaled = 0x62,
 170     DW_AT_explicit = 0x63,
 171     DW_AT_object_pointer = 0x64,
 172     DW_AT_endianity = 0x65,
 173     DW_AT_elemental = 0x66,
 174     DW_AT_pure = 0x67,
 175     DW_AT_recursive = 0x68,
 176     DW_AT_lo_user = 0x2000,
 177     DW_AT_hi_user = 0x3fff,
 178
 179     // Attribute form encodings
 180     DW_FORM_addr = 0x01,
 181     DW_FORM_block2 = 0x03,
 182     DW_FORM_block4 = 0x04,
 183     DW_FORM_data2 = 0x05,
 184     DW_FORM_data4 = 0x06,
 185     DW_FORM_data8 = 0x07,
 186     DW_FORM_string = 0x08,
 187     DW_FORM_block = 0x09,
 188     DW_FORM_block1 = 0x0a,
 189     DW_FORM_data1 = 0x0b,
 190     DW_FORM_flag = 0x0c,
 191     DW_FORM_sdata = 0x0d,
 192     DW_FORM_strp = 0x0e,
 193     DW_FORM_udata = 0x0f,
 194     DW_FORM_ref_addr = 0x10,
 195     DW_FORM_ref1 = 0x11,
 196     DW_FORM_ref2 = 0x12,
 197     DW_FORM_ref4 = 0x13,
 198     DW_FORM_ref8 = 0x14,
 199     DW_FORM_ref_udata = 0x15,
 200     DW_FORM_indirect = 0x16,
 201
 202     // Operation encodings
 203     DW_OP_addr = 0x03,
 204     DW_OP_deref = 0x06,
 205     DW_OP_const1u = 0x08,
 206     DW_OP_const1s = 0x09,
 207     DW_OP_const2u = 0x0a,
 208     DW_OP_const2s = 0x0b,
 209     DW_OP_const4u = 0x0c,
 210     DW_OP_const4s = 0x0d,
 211     DW_OP_const8u = 0x0e,
 212     DW_OP_const8s = 0x0f,
 213     DW_OP_constu = 0x10,
 214     DW_OP_consts = 0x11,
 215     DW_OP_dup = 0x12,
 216     DW_OP_drop = 0x13,
 217     DW_OP_over = 0x14,
 218     DW_OP_pick = 0x15,
 219     DW_OP_swap = 0x16,
 220     DW_OP_rot = 0x17,
 221     DW_OP_xderef = 0x18,
 222     DW_OP_abs = 0x19,
 223     DW_OP_and = 0x1a,
 224     DW_OP_div = 0x1b,
 225     DW_OP_minus = 0x1c,
 226     DW_OP_mod = 0x1d,
 227     DW_OP_mul = 0x1e,
 228     DW_OP_neg = 0x1f,
 229     DW_OP_not = 0x20,
 230     DW_OP_or = 0x21,
 231     DW_OP_plus = 0x22,
 232     DW_OP_plus_uconst = 0x23,
 233     DW_OP_shl = 0x24,
 234     DW_OP_shr = 0x25,
 235     DW_OP_shra = 0x26,
 236     DW_OP_xor = 0x27,
 237     DW_OP_skip = 0x2f,
 238     DW_OP_bra = 0x28,
 239     DW_OP_eq = 0x29,
 240     DW_OP_ge = 0x2a,
 241     DW_OP_gt = 0x2b,
 242     DW_OP_le = 0x2c,
 243     DW_OP_lt = 0x2d,
 244     DW_OP_ne = 0x2e,
 245     DW_OP_lit0 = 0x30,
 246     DW_OP_lit1 = 0x31,
 247     DW_OP_lit31 = 0x4f,
 248     DW_OP_reg0 = 0x50,
 249     DW_OP_reg1 = 0x51,
 250     DW_OP_reg31 = 0x6f,
 251     DW_OP_breg0 = 0x70,
 252     DW_OP_breg1 = 0x71,
 253     DW_OP_breg31 = 0x8f,
 254     DW_OP_regx = 0x90,
 255     DW_OP_fbreg = 0x91,
 256     DW_OP_bregx = 0x92,
 257     DW_OP_piece = 0x93,
 258     DW_OP_deref_size = 0x94,
 259     DW_OP_xderef_size = 0x95,
 260     DW_OP_nop = 0x96,
 261     DW_OP_push_object_address = 0x97,
 262     DW_OP_call2 = 0x98,
 263     DW_OP_call4 = 0x99,
 264     DW_OP_call_ref = 0x9a,
 265     DW_OP_form_tls_address = 0x9b,
 266     DW_OP_call_frame_cfa = 0x9c,
 267     DW_OP_lo_user = 0xe0,
 268     DW_OP_hi_user = 0xff,
 269
 270     // Encoding attribute values
 271     DW_ATE_address = 0x01,
 272     DW_ATE_boolean = 0x02,
 273     DW_ATE_complex_float = 0x03,
 274     DW_ATE_float = 0x04,
 275     DW_ATE_signed = 0x05,
 276     DW_ATE_signed_char = 0x06,
 277     DW_ATE_unsigned = 0x07,
 278     DW_ATE_unsigned_char = 0x08,
 279     DW_ATE_imaginary_float = 0x09,
 280     DW_ATE_packed_decimal = 0x0a,
 281     DW_ATE_numeric_string = 0x0b,
 282     DW_ATE_edited = 0x0c,
 283     DW_ATE_signed_fixed = 0x0d,
 284     DW_ATE_unsigned_fixed = 0x0e,
 285     DW_ATE_decimal_float = 0x0f,
 286     DW_ATE_lo_user = 0x80,
 287     DW_ATE_hi_user = 0xff,
 288
 289     // Decimal sign attribute values
 290     DW_DS_unsigned = 0x01,
 291     DW_DS_leading_overpunch = 0x02,
 292     DW_DS_trailing_overpunch = 0x03,
 293     DW_DS_leading_separate = 0x04,
 294     DW_DS_trailing_separate = 0x05,
 295
 296     // Endianity attribute values
 297     DW_END_default = 0x00,
 298     DW_END_big = 0x01,
 299     DW_END_little = 0x02,
 300     DW_END_lo_user = 0x40,
 301     DW_END_hi_user = 0xff,
 302
 303     // Accessibility codes
 304     DW_ACCESS_public = 0x01,
 305     DW_ACCESS_protected = 0x02,
 306     DW_ACCESS_private = 0x03,
 307
 308     // Visibility codes
 309     DW_VIS_local = 0x01,
 310     DW_VIS_exported = 0x02,
 311     DW_VIS_qualified = 0x03,
 312
 313     // Virtuality codes
 314     DW_VIRTUALITY_none = 0x00,
 315     DW_VIRTUALITY_virtual = 0x01,
 316     DW_VIRTUALITY_pure_virtual = 0x02,
 317
 318     // Language names
 319     DW_LANG_C89 = 0x0001,
 320     DW_LANG_C = 0x0002,
 321     DW_LANG_Ada83 = 0x0003,
 322     DW_LANG_C_plus_plus = 0x0004,
 323     DW_LANG_Cobol74 = 0x0005,
 324     DW_LANG_Cobol85 = 0x0006,
 325     DW_LANG_Fortran77 = 0x0007,
 326     DW_LANG_Fortran90 = 0x0008,
 327     DW_LANG_Pascal83 = 0x0009,
 328     DW_LANG_Modula2 = 0x000a,
 329     DW_LANG_Java = 0x000b,
 330     DW_LANG_C99 = 0x000c,
 331     DW_LANG_Ada95 = 0x000d,
 332     DW_LANG_Fortran95 = 0x000e,
 333     DW_LANG_PLI = 0x000f,
 334     DW_LANG_ObjC = 0x0010,
 335     DW_LANG_ObjC_plus_plus = 0x0011,
 336     DW_LANG_UPC = 0x0012,
 337     DW_LANG_D = 0x0013,
 338     DW_LANG_lo_user = 0x8000,
 339     DW_LANG_hi_user = 0xffff,
 340
 341     // Identifier case codes
 342     DW_ID_case_sensitive = 0x00,
 343     DW_ID_up_case = 0x01,
 344     DW_ID_down_case = 0x02,
 345     DW_ID_case_insensitive = 0x03,
 346
 347     // Calling convention codes
 348     DW_CC_normal = 0x01,
 349     DW_CC_program = 0x02,
 350     DW_CC_nocall = 0x03,
 351     DW_CC_lo_user = 0x40,
 352     DW_CC_hi_user = 0xff,
 353
 354     // Inline codes
 355     DW_INL_not_inlined = 0x00,
 356     DW_INL_inlined = 0x01,
 357     DW_INL_declared_not_inlined = 0x02,
 358     DW_INL_declared_inlined = 0x03,
 359
 360     // Array ordering
 361     DW_ORD_row_major = 0x00,
 362     DW_ORD_col_major = 0x01,
 363
 364     // Discriminant descriptor values
 365     DW_DSC_label = 0x00,
 366     DW_DSC_range = 0x01,
 367
 368     // Line Number Standard Opcode Encodings
 369     DW_LNS_copy = 0x01,
 370     DW_LNS_advance_pc = 0x02,
 371     DW_LNS_advance_line = 0x03,
 372     DW_LNS_set_file = 0x04,
 373     DW_LNS_set_column = 0x05,
 374     DW_LNS_negate_stmt = 0x06,
 375     DW_LNS_set_basic_block = 0x07,
 376     DW_LNS_const_add_pc = 0x08,
 377     DW_LNS_fixed_advance_pc = 0x09,
 378     DW_LNS_set_prologue_end = 0x0a,
 379     DW_LNS_set_epilogue_begin = 0x0b,
 380     DW_LNS_set_isa = 0x0c,
 381
 382     // Line Number Extended Opcode Encodings
 383     DW_LNE_end_sequence = 0x01,
 384     DW_LNE_set_address = 0x02,
 385     DW_LNE_define_file = 0x03,
 386     DW_LNE_lo_user = 0x80,
 387     DW_LNE_hi_user = 0xff,
 388
 389     // Macinfo Type Encodings
 390     DW_MACINFO_define = 0x01,
 391     DW_MACINFO_undef = 0x02,
 392     DW_MACINFO_start_file = 0x03,
 393     DW_MACINFO_end_file = 0x04,
 394     DW_MACINFO_vendor_ext = 0xff,
 395
 396     // Call frame instruction encodings
 397     DW_CFA_advance_loc = 0x40,
 398     DW_CFA_offset = 0x80,
 399     DW_CFA_restore = 0xc0,
 400     DW_CFA_set_loc = 0x01,
 401     DW_CFA_advance_loc1 = 0x02,
 402     DW_CFA_advance_loc2 = 0x03,
 403     DW_CFA_advance_loc4 = 0x04,
 404     DW_CFA_offset_extended = 0x05,
 405     DW_CFA_restore_extended = 0x06,
 406     DW_CFA_undefined = 0x07,
 407     DW_CFA_same_value = 0x08,
 408     DW_CFA_register = 0x09,
 409     DW_CFA_remember_state = 0x0a,
 410     DW_CFA_restore_state = 0x0b,
 411     DW_CFA_def_cfa = 0x0c,
 412     DW_CFA_def_cfa_register = 0x0d,
 413     DW_CFA_def_cfa_offset = 0x0e,
 414     DW_CFA_def_cfa_expression = 0x0f,
 415     DW_CFA_expression = 0x10,
 416     DW_CFA_offset_extended_sf = 0x11,
 417     DW_CFA_def_cfa_sf = 0x12,
 418     DW_CFA_def_cfa_offset_sf = 0x13,
 419     DW_CFA_val_offset = 0x14,
 420     DW_CFA_val_offset_sf = 0x15,
 421     DW_CFA_val_expression = 0x16,
 422     DW_CFA_lo_user = 0x1c,
 423     DW_CFA_hi_user = 0x3f
 424   };
 425
 426 } // end llvm namespace
 427
 428 #endif