20 #include "llvm/ADT/DenseMap.h"
21 #include "llvm/ADT/MapVector.h"
22 #include "llvm/ADT/SmallString.h"
23 #include "llvm/ADT/StringRef.h"
24 #include "llvm/Bitstream/BitstreamReader.h"
25 #include "llvm/Bitstream/BitstreamWriter.h"
26 #include "llvm/Support/DJB.h"
27 #include "llvm/Support/FileSystem.h"
28 #include "llvm/Support/FileUtilities.h"
29 #include "llvm/Support/LockFileManager.h"
30 #include "llvm/Support/MemoryBuffer.h"
31 #include "llvm/Support/OnDiskHashTable.h"
32 #include "llvm/Support/Path.h"
33 #include "llvm/Support/TimeProfiler.h"
35 using namespace clang;
36 using namespace serialization;
44 GLOBAL_INDEX_BLOCK_ID = llvm::bitc::FIRST_APPLICATION_BLOCKID
48 enum IndexRecordTypes {
73 class IdentifierIndexReaderTrait {
75 typedef StringRef external_key_type;
76 typedef StringRef internal_key_type;
78 typedef unsigned hash_value_type;
79 typedef unsigned offset_type;
81 static bool EqualKey(
const internal_key_type& a,
const internal_key_type&
b) {
85 static hash_value_type
ComputeHash(
const internal_key_type& a) {
86 return llvm::djbHash(a);
89 static std::pair<unsigned, unsigned>
90 ReadKeyDataLength(
const unsigned char*& d) {
91 using namespace llvm::support;
92 unsigned KeyLen = endian::readNext<uint16_t, little, unaligned>(d);
93 unsigned DataLen = endian::readNext<uint16_t, little, unaligned>(d);
94 return std::make_pair(KeyLen, DataLen);
97 static const internal_key_type&
98 GetInternalKey(
const external_key_type&
x) {
return x; }
100 static const external_key_type&
101 GetExternalKey(
const internal_key_type&
x) {
return x; }
103 static internal_key_type ReadKey(
const unsigned char* d,
unsigned n) {
104 return StringRef((
const char *)d, n);
107 static data_type ReadData(
const internal_key_type& k,
108 const unsigned char* d,
110 using namespace llvm::support;
113 while (DataLen > 0) {
114 unsigned ID = endian::readNext<uint32_t, little, unaligned>(d);
115 Result.push_back(
ID);
123 typedef llvm::OnDiskIterableChainedHashTable<IdentifierIndexReaderTrait>
124 IdentifierIndexTable;
128 GlobalModuleIndex::GlobalModuleIndex(
129 std::unique_ptr<llvm::MemoryBuffer> IndexBuffer,
130 llvm::BitstreamCursor
Cursor)
131 : Buffer(
std::move(IndexBuffer)), IdentifierIndex(), NumIdentifierLookups(),
132 NumIdentifierLookupHits() {
133 auto Fail = [&](llvm::Error &&Err) {
134 report_fatal_error(
"Module index '" + Buffer->getBufferIdentifier() +
135 "' failed: " +
toString(std::move(Err)));
138 llvm::TimeTraceScope TimeScope(
"Module LoadIndex");
140 bool InGlobalIndexBlock =
false;
143 llvm::BitstreamEntry Entry;
147 Fail(Res.takeError());
149 switch (Entry.Kind) {
153 case llvm::BitstreamEntry::EndBlock:
154 if (InGlobalIndexBlock) {
155 InGlobalIndexBlock =
false;
162 case llvm::BitstreamEntry::Record:
164 if (InGlobalIndexBlock)
169 case llvm::BitstreamEntry::SubBlock:
170 if (!InGlobalIndexBlock && Entry.ID == GLOBAL_INDEX_BLOCK_ID) {
171 if (llvm::Error Err =
Cursor.EnterSubBlock(GLOBAL_INDEX_BLOCK_ID))
172 Fail(std::move(Err));
173 InGlobalIndexBlock =
true;
174 }
else if (llvm::Error Err =
Cursor.SkipBlock())
175 Fail(std::move(Err));
182 Cursor.readRecord(Entry.ID, Record, &Blob);
183 if (!MaybeIndexRecord)
184 Fail(MaybeIndexRecord.takeError());
185 IndexRecordTypes IndexRecord =
186 static_cast<IndexRecordTypes
>(MaybeIndexRecord.get());
187 switch (IndexRecord) {
196 unsigned ID = Record[Idx++];
199 if (
ID == Modules.size())
200 Modules.push_back(ModuleInfo());
202 Modules.resize(
ID + 1);
206 Modules[
ID].Size = Record[Idx++];
207 Modules[
ID].ModTime = Record[Idx++];
210 unsigned NameLen = Record[Idx++];
211 Modules[
ID].FileName.assign(Record.begin() + Idx,
212 Record.begin() + Idx + NameLen);
216 unsigned NumDeps = Record[Idx++];
217 Modules[
ID].Dependencies.insert(Modules[
ID].Dependencies.end(),
218 Record.begin() + Idx,
219 Record.begin() + Idx + NumDeps);
223 assert(Idx == Record.size() &&
"More module info?");
228 StringRef ModuleName = llvm::sys::path::stem(Modules[
ID].FileName);
230 ModuleName = ModuleName.rsplit(
'-').first;
231 UnresolvedModules[ModuleName] =
ID;
235 case IDENTIFIER_INDEX:
238 IdentifierIndex = IdentifierIndexTable::Create(
239 (
const unsigned char *)Blob.data() + Record[0],
240 (
const unsigned char *)Blob.data() +
sizeof(uint32_t),
241 (
const unsigned char *)Blob.data(), IdentifierIndexReaderTrait());
248 GlobalModuleIndex::~GlobalModuleIndex() {
249 delete static_cast<IdentifierIndexTable *
>(IdentifierIndex);
252 std::pair<GlobalModuleIndex *, llvm::Error>
259 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> BufferOrErr =
260 llvm::MemoryBuffer::getFile(IndexPath.c_str());
262 return std::make_pair(
nullptr,
263 llvm::errorCodeToError(BufferOrErr.getError()));
264 std::unique_ptr<llvm::MemoryBuffer> Buffer = std::move(BufferOrErr.get());
267 llvm::BitstreamCursor
Cursor(*Buffer);
270 for (
unsigned char C : {
'B',
'C',
'G',
'I'}) {
273 return std::make_pair(
274 nullptr, llvm::createStringError(std::errc::illegal_byte_sequence,
275 "expected signature BCGI"));
277 return std::make_pair(
nullptr, Res.takeError());
281 llvm::Error::success());
287 for (
unsigned I = 0, N = Modules.size(); I != N; ++I) {
289 ModuleFiles.push_back(MF);
297 llvm::DenseMap<ModuleFile *, unsigned>::iterator Known
298 = ModulesByFile.find(
File);
299 if (Known == ModulesByFile.end())
303 Dependencies.clear();
305 for (
unsigned I = 0, N = StoredDependencies.size(); I != N; ++I) {
307 Dependencies.push_back(MF);
315 if (!IdentifierIndex)
319 ++NumIdentifierLookups;
320 IdentifierIndexTable &Table
321 = *
static_cast<IdentifierIndexTable *
>(IdentifierIndex);
322 IdentifierIndexTable::iterator Known = Table.find(Name);
323 if (Known == Table.end()) {
328 for (
unsigned I = 0, N = ModuleIDs.size(); I != N; ++I) {
333 ++NumIdentifierLookupHits;
339 StringRef Name =
File->ModuleName;
340 llvm::StringMap<unsigned>::iterator Known = UnresolvedModules.find(Name);
341 if (Known == UnresolvedModules.end()) {
346 ModuleInfo &Info = Modules[Known->second];
351 if (
File->File->getSize() == Info.Size &&
352 File->File->getModificationTime() == Info.ModTime) {
354 ModulesByFile[
File] = Known->second;
360 UnresolvedModules.erase(Known);
365 std::fprintf(stderr,
"*** Global Module Index Statistics:\n");
366 if (NumIdentifierLookups) {
367 fprintf(stderr,
" %u / %u identifier lookups succeeded (%f%%)\n",
368 NumIdentifierLookupHits, NumIdentifierLookups,
369 (
double)NumIdentifierLookupHits*100.0/NumIdentifierLookups);
371 std::fprintf(stderr,
"\n");
375 llvm::errs() <<
"*** Global Module Index Dump:\n";
376 llvm::errs() <<
"Module files:\n";
377 for (
auto &MI : Modules) {
378 llvm::errs() <<
"** " << MI.FileName <<
"\n";
382 llvm::errs() <<
"\n";
384 llvm::errs() <<
"\n";
403 struct ImportedModuleFileInfo {
405 time_t StoredModTime;
408 : StoredSize(Size), StoredModTime(ModTime), StoredSignature(Sig) {}
412 class GlobalModuleIndexBuilder {
417 typedef llvm::MapVector<const FileEntry *, ModuleFileInfo> ModuleFilesMap;
420 ModuleFilesMap ModuleFiles;
424 typedef std::multimap<const FileEntry *, ImportedModuleFileInfo>
425 ImportedModuleFilesMap;
428 ImportedModuleFilesMap ImportedModuleFiles;
432 typedef llvm::StringMap<SmallVector<unsigned, 2> > InterestingIdentifierMap;
436 InterestingIdentifierMap InterestingIdentifiers;
439 void emitBlockInfoBlock(llvm::BitstreamWriter &Stream);
443 llvm::MapVector<const FileEntry *, ModuleFileInfo>::iterator Known
444 = ModuleFiles.find(File);
445 if (Known != ModuleFiles.end())
446 return Known->second;
448 unsigned NewID = ModuleFiles.size();
455 explicit GlobalModuleIndexBuilder(
457 : FileMgr(FileMgr), PCHContainerRdr(PCHContainerRdr) {}
460 llvm::Error loadModuleFile(
const FileEntry *File);
464 bool writeIndex(llvm::BitstreamWriter &Stream);
469 llvm::BitstreamWriter &Stream,
472 Record.push_back(
ID);
473 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETBID, Record);
476 if (!Name || Name[0] == 0)
return;
479 Record.push_back(*Name++);
480 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_BLOCKNAME, Record);
484 llvm::BitstreamWriter &Stream,
487 Record.push_back(
ID);
489 Record.push_back(*Name++);
490 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETRECORDNAME, Record);
494 GlobalModuleIndexBuilder::emitBlockInfoBlock(llvm::BitstreamWriter &Stream) {
496 Stream.EnterBlockInfoBlock();
498 #define BLOCK(X) emitBlockID(X ## _ID, #X, Stream, Record)
499 #define RECORD(X) emitRecordID(X, #X, Stream, Record)
500 BLOCK(GLOBAL_INDEX_BLOCK);
511 class InterestingASTIdentifierLookupTrait
516 typedef std::pair<StringRef, bool> data_type;
518 data_type ReadData(
const internal_key_type& k,
519 const unsigned char* d,
523 using namespace llvm::support;
524 unsigned RawID = endian::readNext<uint32_t, little, unaligned>(d);
525 bool IsInteresting = RawID & 0x01;
526 return std::make_pair(k, IsInteresting);
531 llvm::Error GlobalModuleIndexBuilder::loadModuleFile(
const FileEntry *File) {
536 return llvm::createStringError(Buffer.getError(),
537 "failed getting buffer for module file");
540 llvm::BitstreamCursor InStream(PCHContainerRdr.
ExtractPCH(**Buffer));
543 for (
unsigned char C : {
'C',
'P',
'C',
'H'})
546 return llvm::createStringError(std::errc::illegal_byte_sequence,
547 "expected signature CPCH");
549 return Res.takeError();
553 unsigned ID = getModuleFileInfo(File).ID;
556 enum { Other, ControlBlock, ASTBlock, DiagnosticOptionsBlock }
State = Other;
561 return MaybeEntry.takeError();
562 llvm::BitstreamEntry Entry = MaybeEntry.get();
564 switch (Entry.Kind) {
569 case llvm::BitstreamEntry::Record:
571 if (
State == Other) {
575 return Skipped.takeError();
581 case llvm::BitstreamEntry::SubBlock:
587 State = ControlBlock;
592 if (llvm::Error Err = InStream.EnterSubBlock(
AST_BLOCK_ID))
605 State = DiagnosticOptionsBlock;
609 if (llvm::Error Err = InStream.SkipBlock())
614 case llvm::BitstreamEntry::EndBlock:
624 return MaybeCode.takeError();
625 unsigned Code = MaybeCode.get();
630 unsigned Idx = 0, N = Record.size();
641 off_t StoredSize = (off_t)Record[Idx++];
642 time_t StoredModTime = (time_t)Record[Idx++];
646 auto FirstSignatureByte = Record.begin() + Idx;
653 Idx += Record[Idx] + 1;
656 unsigned Length = Record[Idx++];
658 Record.begin() + Idx + Length);
663 = FileMgr.
getFile(ImportedFile,
false,
667 return llvm::createStringError(std::errc::bad_file_descriptor,
668 "imported file \"%s\" not found",
669 ImportedFile.c_str());
673 ImportedModuleFiles.insert(std::make_pair(
674 *DependsOnFile, ImportedModuleFileInfo(StoredSize, StoredModTime,
678 unsigned DependsOnID = getModuleFileInfo(*DependsOnFile).ID;
679 getModuleFileInfo(File).Dependencies.push_back(DependsOnID);
687 typedef llvm::OnDiskIterableChainedHashTable<
688 InterestingASTIdentifierLookupTrait> InterestingIdentifierTable;
689 std::unique_ptr<InterestingIdentifierTable> Table(
690 InterestingIdentifierTable::Create(
691 (
const unsigned char *)Blob.data() + Record[0],
692 (
const unsigned char *)Blob.data() +
sizeof(uint32_t),
693 (
const unsigned char *)Blob.data()));
694 for (InterestingIdentifierTable::data_iterator D = Table->data_begin(),
695 DEnd = Table->data_end();
697 std::pair<StringRef, bool> Ident = *D;
699 InterestingIdentifiers[Ident.first].push_back(
ID);
701 (
void)InterestingIdentifiers[Ident.first];
713 return llvm::Error::success();
720 class IdentifierIndexWriterTrait {
722 typedef StringRef key_type;
723 typedef StringRef key_type_ref;
726 typedef unsigned hash_value_type;
727 typedef unsigned offset_type;
729 static hash_value_type
ComputeHash(key_type_ref Key) {
730 return llvm::djbHash(Key);
733 std::pair<unsigned,unsigned>
734 EmitKeyDataLength(raw_ostream& Out, key_type_ref Key, data_type_ref Data) {
735 using namespace llvm::support;
736 endian::Writer
LE(Out, little);
737 unsigned KeyLen = Key.size();
738 unsigned DataLen = Data.size() * 4;
739 LE.write<uint16_t>(KeyLen);
740 LE.write<uint16_t>(DataLen);
741 return std::make_pair(KeyLen, DataLen);
744 void EmitKey(raw_ostream& Out, key_type_ref Key,
unsigned KeyLen) {
745 Out.write(Key.data(), KeyLen);
748 void EmitData(raw_ostream& Out, key_type_ref Key, data_type_ref Data,
750 using namespace llvm::support;
751 for (
unsigned I = 0, N = Data.size(); I != N; ++I)
752 endian::write<uint32_t>(Out, Data[I], little);
758 bool GlobalModuleIndexBuilder::writeIndex(llvm::BitstreamWriter &Stream) {
759 for (
auto MapEntry : ImportedModuleFiles) {
760 auto *
File = MapEntry.first;
761 ImportedModuleFileInfo &Info = MapEntry.second;
762 if (getModuleFileInfo(File).Signature) {
763 if (getModuleFileInfo(File).Signature != Info.StoredSignature)
766 }
else if (Info.StoredSize !=
File->getSize() ||
767 Info.StoredModTime !=
File->getModificationTime())
772 using namespace llvm;
773 llvm::TimeTraceScope TimeScope(
"Module WriteIndex");
776 Stream.Emit((
unsigned)
'B', 8);
777 Stream.Emit((
unsigned)
'C', 8);
778 Stream.Emit((
unsigned)
'G', 8);
779 Stream.Emit((
unsigned)
'I', 8);
783 emitBlockInfoBlock(Stream);
785 Stream.EnterSubblock(GLOBAL_INDEX_BLOCK_ID, 3);
790 Stream.EmitRecord(INDEX_METADATA, Record);
793 for (ModuleFilesMap::iterator M = ModuleFiles.begin(),
794 MEnd = ModuleFiles.end();
797 Record.push_back(M->second.ID);
798 Record.push_back(M->first->getSize());
799 Record.push_back(M->first->getModificationTime());
802 StringRef Name(M->first->getName());
803 Record.push_back(Name.size());
804 Record.append(Name.begin(), Name.end());
807 Record.push_back(M->second.Dependencies.size());
808 Record.append(M->second.Dependencies.begin(), M->second.Dependencies.end());
809 Stream.EmitRecord(MODULE, Record);
814 llvm::OnDiskChainedHashTableGenerator<IdentifierIndexWriterTrait>
Generator;
815 IdentifierIndexWriterTrait Trait;
818 for (InterestingIdentifierMap::iterator I = InterestingIdentifiers.begin(),
819 IEnd = InterestingIdentifiers.end();
821 Generator.insert(I->first(), I->second, Trait);
826 uint32_t BucketOffset;
828 using namespace llvm::support;
831 endian::write<uint32_t>(Out, 0, little);
832 BucketOffset =
Generator.Emit(Out, Trait);
836 auto Abbrev = std::make_shared<BitCodeAbbrev>();
837 Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_INDEX));
838 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
839 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
840 unsigned IDTableAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
843 uint64_t Record[] = {IDENTIFIER_INDEX, BucketOffset};
861 llvm::LockFileManager Locked(IndexPath);
863 case llvm::LockFileManager::LFS_Error:
864 return llvm::createStringError(std::errc::io_error,
"LFS error");
866 case llvm::LockFileManager::LFS_Owned:
870 case llvm::LockFileManager::LFS_Shared:
873 return llvm::createStringError(std::errc::device_or_resource_busy,
874 "someone else is building the index");
878 GlobalModuleIndexBuilder Builder(FileMgr, PCHContainerRdr);
882 for (llvm::sys::fs::directory_iterator D(Path, EC), DEnd;
886 if (llvm::sys::path::extension(D->path()) !=
".pcm") {
890 if (llvm::sys::path::extension(D->path()) ==
".pcm.lock")
891 return llvm::createStringError(std::errc::device_or_resource_busy,
892 "someone else is building the index");
903 if (llvm::Error Err = Builder.loadModuleFile(*
ModuleFile))
910 llvm::BitstreamWriter OutputStream(OutputBuffer);
911 if (Builder.writeIndex(OutputStream))
912 return llvm::createStringError(std::errc::io_error,
913 "failed writing index");
916 return llvm::writeFileAtomically((IndexPath +
"-%%%%%%%%").str(), IndexPath,
923 IdentifierIndexTable::key_iterator Current;
926 IdentifierIndexTable::key_iterator
End;
929 explicit GlobalIndexIdentifierIterator(IdentifierIndexTable &Idx) {
930 Current = Idx.key_begin();
934 StringRef Next()
override {
938 StringRef Result = *Current;
946 IdentifierIndexTable &Table =
947 *
static_cast<IdentifierIndexTable *
>(IdentifierIndex);
948 return new GlobalIndexIdentifierIterator(Table);