lib/CodeGen/AsmPrinter/DIEHash.cpp

   1 //===-- llvm/CodeGen/DIEHash.cpp - Dwarf Hashing Framework ----------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file contains support for DWARF4 hashing of DIEs.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #define DEBUG_TYPE "dwarfdebug"
  15
  16 #include "DIE.h"
  17 #include "DIEHash.h"
  18 #include "DwarfCompileUnit.h"
  19 #include "llvm/ADT/ArrayRef.h"
  20 #include "llvm/ADT/StringRef.h"
  21 #include "llvm/Support/Debug.h"
  22 #include "llvm/Support/Dwarf.h"
  23 #include "llvm/Support/Endian.h"
  24 #include "llvm/Support/MD5.h"
  25 #include "llvm/Support/raw_ostream.h"
  26
  27 using namespace llvm;
  28
  29 /// \brief Grabs the string in whichever attribute is passed in and returns
  30 /// a reference to it.
  31 static StringRef getDIEStringAttr(DIE *Die, uint16_t Attr) {
  32   const SmallVectorImpl<DIEValue *> &Values = Die->getValues();
  33   const DIEAbbrev &Abbrevs = Die->getAbbrev();
  34
  35   // Iterate through all the attributes until we find the one we're
  36   // looking for, if we can't find it return an empty string.
  37   for (size_t i = 0; i < Values.size(); ++i) {
  38     if (Abbrevs.getData()[i].getAttribute() == Attr) {
  39       DIEValue *V = Values[i];
  40       assert(isa<DIEString>(V) && "String requested. Not a string.");
  41       DIEString *S = cast<DIEString>(V);
  42       return S->getString();
  43     }
  44   }
  45   return StringRef("");
  46 }
  47
  48 /// \brief Adds the string in \p Str to the hash. This also hashes
  49 /// a trailing NULL with the string.
  50 void DIEHash::addString(StringRef Str) {
  51   DEBUG(dbgs() << "Adding string " << Str << " to hash.\n");
  52   Hash.update(Str);
  53   Hash.update(makeArrayRef((uint8_t)'\0'));
  54 }
  55
  56 // FIXME: The LEB128 routines are copied and only slightly modified out of
  57 // LEB128.h.
  58
  59 /// \brief Adds the unsigned in \p Value to the hash encoded as a ULEB128.
  60 void DIEHash::addULEB128(uint64_t Value) {
  61   DEBUG(dbgs() << "Adding ULEB128 " << Value << " to hash.\n");
  62   do {
  63     uint8_t Byte = Value & 0x7f;
  64     Value >>= 7;
  65     if (Value != 0)
  66       Byte |= 0x80; // Mark this byte to show that more bytes will follow.
  67     Hash.update(Byte);
  68   } while (Value != 0);
  69 }
  70
  71 void DIEHash::addSLEB128(int64_t Value) {
  72   DEBUG(dbgs() << "Adding ULEB128 " << Value << " to hash.\n");
  73   bool More;
  74   do {
  75     uint8_t Byte = Value & 0x7f;
  76     Value >>= 7;
  77     More = !((((Value == 0 ) && ((Byte & 0x40) == 0)) ||
  78               ((Value == -1) && ((Byte & 0x40) != 0))));
  79     if (More)
  80       Byte |= 0x80; // Mark this byte to show that more bytes will follow.
  81     Hash.update(Byte);
  82   } while (More);
  83 }
  84
  85 /// \brief Including \p Parent adds the context of Parent to the hash..
  86 void DIEHash::addParentContext(DIE *Parent) {
  87
  88   DEBUG(dbgs() << "Adding parent context to hash...\n");
  89
  90   // [7.27.2] For each surrounding type or namespace beginning with the
  91   // outermost such construct...
  92   SmallVector<DIE *, 1> Parents;
  93   while (Parent->getTag() != dwarf::DW_TAG_compile_unit) {
  94     Parents.push_back(Parent);
  95     Parent = Parent->getParent();
  96   }
  97
  98   // Reverse iterate over our list to go from the outermost construct to the
  99   // innermost.
 100   for (SmallVectorImpl<DIE *>::reverse_iterator I = Parents.rbegin(),
 101                                                 E = Parents.rend();
 102        I != E; ++I) {
 103     DIE *Die = *I;
 104
 105     // ... Append the letter "C" to the sequence...
 106     addULEB128('C');
 107
 108     // ... Followed by the DWARF tag of the construct...
 109     addULEB128(Die->getTag());
 110
 111     // ... Then the name, taken from the DW_AT_name attribute.
 112     StringRef Name = getDIEStringAttr(Die, dwarf::DW_AT_name);
 113     DEBUG(dbgs() << "... adding context: " << Name << "\n");
 114     if (!Name.empty())
 115       addString(Name);
 116   }
 117 }
 118
 119 // Collect all of the attributes for a particular DIE in single structure.
 120 void DIEHash::collectAttributes(DIE *Die, DIEAttrs &Attrs) {
 121   const SmallVectorImpl<DIEValue *> &Values = Die->getValues();
 122   const DIEAbbrev &Abbrevs = Die->getAbbrev();
 123
 124 #define COLLECT_ATTR(NAME)                                                     \
 125   case dwarf::NAME:                                                            \
 126     Attrs.NAME.Val = Values[i];                                                \
 127     Attrs.NAME.Desc = &Abbrevs.getData()[i];                                   \
 128     break
 129
 130   for (size_t i = 0, e = Values.size(); i != e; ++i) {
 131     DEBUG(dbgs() << "Attribute: "
 132                  << dwarf::AttributeString(Abbrevs.getData()[i].getAttribute())
 133                  << " added.\n");
 134     switch (Abbrevs.getData()[i].getAttribute()) {
 135     COLLECT_ATTR(DW_AT_name);
 136     COLLECT_ATTR(DW_AT_accessibility);
 137     COLLECT_ATTR(DW_AT_address_class);
 138     COLLECT_ATTR(DW_AT_allocated);
 139     COLLECT_ATTR(DW_AT_artificial);
 140     COLLECT_ATTR(DW_AT_associated);
 141     COLLECT_ATTR(DW_AT_binary_scale);
 142     COLLECT_ATTR(DW_AT_bit_offset);
 143     COLLECT_ATTR(DW_AT_bit_size);
 144     COLLECT_ATTR(DW_AT_bit_stride);
 145     COLLECT_ATTR(DW_AT_byte_size);
 146     COLLECT_ATTR(DW_AT_byte_stride);
 147     COLLECT_ATTR(DW_AT_const_expr);
 148     COLLECT_ATTR(DW_AT_const_value);
 149     COLLECT_ATTR(DW_AT_containing_type);
 150     COLLECT_ATTR(DW_AT_count);
 151     COLLECT_ATTR(DW_AT_data_bit_offset);
 152     COLLECT_ATTR(DW_AT_data_location);
 153     COLLECT_ATTR(DW_AT_data_member_location);
 154     COLLECT_ATTR(DW_AT_decimal_scale);
 155     COLLECT_ATTR(DW_AT_decimal_sign);
 156     COLLECT_ATTR(DW_AT_default_value);
 157     COLLECT_ATTR(DW_AT_digit_count);
 158     COLLECT_ATTR(DW_AT_discr);
 159     COLLECT_ATTR(DW_AT_discr_list);
 160     COLLECT_ATTR(DW_AT_discr_value);
 161     COLLECT_ATTR(DW_AT_encoding);
 162     COLLECT_ATTR(DW_AT_enum_class);
 163     COLLECT_ATTR(DW_AT_endianity);
 164     COLLECT_ATTR(DW_AT_explicit);
 165     COLLECT_ATTR(DW_AT_is_optional);
 166     COLLECT_ATTR(DW_AT_location);
 167     COLLECT_ATTR(DW_AT_lower_bound);
 168     COLLECT_ATTR(DW_AT_mutable);
 169     COLLECT_ATTR(DW_AT_ordering);
 170     COLLECT_ATTR(DW_AT_picture_string);
 171     COLLECT_ATTR(DW_AT_prototyped);
 172     COLLECT_ATTR(DW_AT_small);
 173     COLLECT_ATTR(DW_AT_segment);
 174     COLLECT_ATTR(DW_AT_string_length);
 175     COLLECT_ATTR(DW_AT_threads_scaled);
 176     COLLECT_ATTR(DW_AT_upper_bound);
 177     COLLECT_ATTR(DW_AT_use_location);
 178     COLLECT_ATTR(DW_AT_use_UTF8);
 179     COLLECT_ATTR(DW_AT_variable_parameter);
 180     COLLECT_ATTR(DW_AT_virtuality);
 181     COLLECT_ATTR(DW_AT_visibility);
 182     COLLECT_ATTR(DW_AT_vtable_elem_location);
 183     COLLECT_ATTR(DW_AT_type);
 184     default:
 185       break;
 186     }
 187   }
 188 }
 189
 190 // Hash an individual attribute \param Attr based on the type of attribute and
 191 // the form.
 192 void DIEHash::hashAttribute(AttrEntry Attr, dwarf::Tag Tag) {
 193   const DIEValue *Value = Attr.Val;
 194   const DIEAbbrevData *Desc = Attr.Desc;
 195
 196   // 7.27 Step 3
 197   // ... An attribute that refers to another type entry T is processed as
 198   // follows:
 199   if (const DIEEntry *EntryAttr = dyn_cast<DIEEntry>(Value)) {
 200     DIE *Entry = EntryAttr->getEntry();
 201
 202     // Step 5
 203     // If the tag in Step 3 is one of ...
 204     if (Tag == dwarf::DW_TAG_pointer_type ||
 205         Tag == dwarf::DW_TAG_reference_type ||
 206         Tag == dwarf::DW_TAG_rvalue_reference_type) {
 207       // ... and the referenced type (via the DW_AT_type or DW_AT_friend
 208       // attribute) ...
 209       assert(Desc->getAttribute() == dwarf::DW_AT_type ||
 210              Desc->getAttribute() == dwarf::DW_AT_friend);
 211       // [FIXME] ... has a DW_AT_name attribute,
 212       // append the letter 'N'
 213       addULEB128('N');
 214
 215       // the DWARF attribute code (DW_AT_type or DW_AT_friend),
 216       addULEB128(Desc->getAttribute());
 217
 218       // the context of the tag,
 219       if (DIE *Parent = Entry->getParent())
 220         addParentContext(Parent);
 221
 222       // the letter 'E',
 223       addULEB128('E');
 224
 225       // and the name of the type.
 226       addString(getDIEStringAttr(Entry, dwarf::DW_AT_name));
 227
 228       // FIXME:
 229       // For DW_TAG_friend, if the referenced entry is the DW_TAG_subprogram,
 230       // the context is omitted and the name to be used is the ABI-specific name
 231       // of the subprogram (e.g., the mangled linker name).
 232       return;
 233     }
 234
 235     unsigned &DieNumber = Numbering[Entry];
 236     if (DieNumber) {
 237       // a) If T is in the list of [previously hashed types], use the letter
 238       // 'R' as the marker
 239       addULEB128('R');
 240
 241       addULEB128(Desc->getAttribute());
 242
 243       // and use the unsigned LEB128 encoding of [the index of T in the
 244       // list] as the attribute value;
 245       addULEB128(DieNumber);
 246       return;
 247     }
 248
 249     // otherwise, b) use the letter 'T' as a the marker, ...
 250     addULEB128('T');
 251
 252     addULEB128(Desc->getAttribute());
 253
 254     // ... process the type T recursively by performing Steps 2 through 7, and
 255     // use the result as the attribute value.
 256     DieNumber = Numbering.size();
 257     computeHash(Entry);
 258     return;
 259   }
 260
 261   // Other attribute values use the letter 'A' as the marker, ...
 262   addULEB128('A');
 263
 264   addULEB128(Desc->getAttribute());
 265
 266   // ... and the value consists of the form code (encoded as an unsigned LEB128
 267   // value) followed by the encoding of the value according to the form code. To
 268   // ensure reproducibility of the signature, the set of forms used in the
 269   // signature computation is limited to the following: DW_FORM_sdata,
 270   // DW_FORM_flag, DW_FORM_string, and DW_FORM_block.
 271   switch (Desc->getForm()) {
 272   case dwarf::DW_FORM_string:
 273     llvm_unreachable(
 274         "Add support for DW_FORM_string if we ever start emitting them again");
 275   case dwarf::DW_FORM_GNU_str_index:
 276   case dwarf::DW_FORM_strp:
 277     addULEB128(dwarf::DW_FORM_string);
 278     addString(cast<DIEString>(Value)->getString());
 279     break;
 280   case dwarf::DW_FORM_data1:
 281   case dwarf::DW_FORM_data2:
 282   case dwarf::DW_FORM_data4:
 283   case dwarf::DW_FORM_data8:
 284   case dwarf::DW_FORM_udata:
 285     addULEB128(dwarf::DW_FORM_sdata);
 286     addSLEB128((int64_t)cast<DIEInteger>(Value)->getValue());
 287     break;
 288   default:
 289     llvm_unreachable("Add support for additional forms");
 290   }
 291 }
 292
 293 // Go through the attributes from \param Attrs in the order specified in 7.27.4
 294 // and hash them.
 295 void DIEHash::hashAttributes(const DIEAttrs &Attrs, dwarf::Tag Tag) {
 296 #define ADD_ATTR(ATTR)                                                         \
 297   {                                                                            \
 298     if (ATTR.Val != 0)                                                         \
 299       hashAttribute(ATTR, Tag);                                                \
 300   }
 301
 302   ADD_ATTR(Attrs.DW_AT_name);
 303   ADD_ATTR(Attrs.DW_AT_accessibility);
 304   ADD_ATTR(Attrs.DW_AT_address_class);
 305   ADD_ATTR(Attrs.DW_AT_allocated);
 306   ADD_ATTR(Attrs.DW_AT_artificial);
 307   ADD_ATTR(Attrs.DW_AT_associated);
 308   ADD_ATTR(Attrs.DW_AT_binary_scale);
 309   ADD_ATTR(Attrs.DW_AT_bit_offset);
 310   ADD_ATTR(Attrs.DW_AT_bit_size);
 311   ADD_ATTR(Attrs.DW_AT_bit_stride);
 312   ADD_ATTR(Attrs.DW_AT_byte_size);
 313   ADD_ATTR(Attrs.DW_AT_byte_stride);
 314   ADD_ATTR(Attrs.DW_AT_const_expr);
 315   ADD_ATTR(Attrs.DW_AT_const_value);
 316   ADD_ATTR(Attrs.DW_AT_containing_type);
 317   ADD_ATTR(Attrs.DW_AT_count);
 318   ADD_ATTR(Attrs.DW_AT_data_bit_offset);
 319   ADD_ATTR(Attrs.DW_AT_data_location);
 320   ADD_ATTR(Attrs.DW_AT_data_member_location);
 321   ADD_ATTR(Attrs.DW_AT_decimal_scale);
 322   ADD_ATTR(Attrs.DW_AT_decimal_sign);
 323   ADD_ATTR(Attrs.DW_AT_default_value);
 324   ADD_ATTR(Attrs.DW_AT_digit_count);
 325   ADD_ATTR(Attrs.DW_AT_discr);
 326   ADD_ATTR(Attrs.DW_AT_discr_list);
 327   ADD_ATTR(Attrs.DW_AT_discr_value);
 328   ADD_ATTR(Attrs.DW_AT_encoding);
 329   ADD_ATTR(Attrs.DW_AT_enum_class);
 330   ADD_ATTR(Attrs.DW_AT_endianity);
 331   ADD_ATTR(Attrs.DW_AT_explicit);
 332   ADD_ATTR(Attrs.DW_AT_is_optional);
 333   ADD_ATTR(Attrs.DW_AT_location);
 334   ADD_ATTR(Attrs.DW_AT_lower_bound);
 335   ADD_ATTR(Attrs.DW_AT_mutable);
 336   ADD_ATTR(Attrs.DW_AT_ordering);
 337   ADD_ATTR(Attrs.DW_AT_picture_string);
 338   ADD_ATTR(Attrs.DW_AT_prototyped);
 339   ADD_ATTR(Attrs.DW_AT_small);
 340   ADD_ATTR(Attrs.DW_AT_segment);
 341   ADD_ATTR(Attrs.DW_AT_string_length);
 342   ADD_ATTR(Attrs.DW_AT_threads_scaled);
 343   ADD_ATTR(Attrs.DW_AT_upper_bound);
 344   ADD_ATTR(Attrs.DW_AT_use_location);
 345   ADD_ATTR(Attrs.DW_AT_use_UTF8);
 346   ADD_ATTR(Attrs.DW_AT_variable_parameter);
 347   ADD_ATTR(Attrs.DW_AT_virtuality);
 348   ADD_ATTR(Attrs.DW_AT_visibility);
 349   ADD_ATTR(Attrs.DW_AT_vtable_elem_location);
 350   ADD_ATTR(Attrs.DW_AT_type);
 351
 352   // FIXME: Add the extended attributes.
 353 }
 354
 355 // Add all of the attributes for \param Die to the hash.
 356 void DIEHash::addAttributes(DIE *Die) {
 357   DIEAttrs Attrs = {};
 358   collectAttributes(Die, Attrs);
 359   hashAttributes(Attrs, Die->getTag());
 360 }
 361
 362 // Compute the hash of a DIE. This is based on the type signature computation
 363 // given in section 7.27 of the DWARF4 standard. It is the md5 hash of a
 364 // flattened description of the DIE.
 365 void DIEHash::computeHash(DIE *Die) {
 366   // Append the letter 'D', followed by the DWARF tag of the DIE.
 367   addULEB128('D');
 368   addULEB128(Die->getTag());
 369
 370   // Add each of the attributes of the DIE.
 371   addAttributes(Die);
 372
 373   // Then hash each of the children of the DIE.
 374   for (std::vector<DIE *>::const_iterator I = Die->getChildren().begin(),
 375                                           E = Die->getChildren().end();
 376        I != E; ++I)
 377     computeHash(*I);
 378
 379   // Following the last (or if there are no children), append a zero byte.
 380   Hash.update(makeArrayRef((uint8_t)'\0'));
 381 }
 382
 383 /// This is based on the type signature computation given in section 7.27 of the
 384 /// DWARF4 standard. It is the md5 hash of a flattened description of the DIE
 385 /// with the exception that we are hashing only the context and the name of the
 386 /// type.
 387 uint64_t DIEHash::computeDIEODRSignature(DIE *Die) {
 388
 389   // Add the contexts to the hash. We won't be computing the ODR hash for
 390   // function local types so it's safe to use the generic context hashing
 391   // algorithm here.
 392   // FIXME: If we figure out how to account for linkage in some way we could
 393   // actually do this with a slight modification to the parent hash algorithm.
 394   DIE *Parent = Die->getParent();
 395   if (Parent)
 396     addParentContext(Parent);
 397
 398   // Add the current DIE information.
 399
 400   // Add the DWARF tag of the DIE.
 401   addULEB128(Die->getTag());
 402
 403   // Add the name of the type to the hash.
 404   addString(getDIEStringAttr(Die, dwarf::DW_AT_name));
 405
 406   // Now get the result.
 407   MD5::MD5Result Result;
 408   Hash.final(Result);
 409
 410   // ... take the least significant 8 bytes and return those. Our MD5
 411   // implementation always returns its results in little endian, swap bytes
 412   // appropriately.
 413   return *reinterpret_cast<support::ulittle64_t *>(Result + 8);
 414 }
 415
 416 /// This is based on the type signature computation given in section 7.27 of the
 417 /// DWARF4 standard. It is an md5 hash of the flattened description of the DIE
 418 /// with the inclusion of the full CU and all top level CU entities.
 419 // TODO: Initialize the type chain at 0 instead of 1 for CU signatures.
 420 uint64_t DIEHash::computeCUSignature(DIE *Die) {
 421   Numbering.clear();
 422   Numbering[Die] = 1;
 423
 424   // Hash the DIE.
 425   computeHash(Die);
 426
 427   // Now return the result.
 428   MD5::MD5Result Result;
 429   Hash.final(Result);
 430
 431   // ... take the least significant 8 bytes and return those. Our MD5
 432   // implementation always returns its results in little endian, swap bytes
 433   // appropriately.
 434   return *reinterpret_cast<support::ulittle64_t *>(Result + 8);
 435 }
 436
 437 /// This is based on the type signature computation given in section 7.27 of the
 438 /// DWARF4 standard. It is an md5 hash of the flattened description of the DIE
 439 /// with the inclusion of additional forms not specifically called out in the
 440 /// standard.
 441 uint64_t DIEHash::computeTypeSignature(DIE *Die) {
 442   Numbering.clear();
 443   Numbering[Die] = 1;
 444
 445   if (DIE *Parent = Die->getParent())
 446     addParentContext(Parent);
 447
 448   // Hash the DIE.
 449   computeHash(Die);
 450
 451   // Now return the result.
 452   MD5::MD5Result Result;
 453   Hash.final(Result);
 454
 455   // ... take the least significant 8 bytes and return those. Our MD5
 456   // implementation always returns its results in little endian, swap bytes
 457   // appropriately.
 458   return *reinterpret_cast<support::ulittle64_t *>(Result + 8);
 459 }