1 //===--- SourceManager.cpp - Track and cache source files -----------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the SourceManager interface.
12 //===----------------------------------------------------------------------===//
14 #include "clang/Basic/SourceManager.h"
15 #include "clang/Basic/SourceManagerInternals.h"
16 #include "clang/Basic/Diagnostic.h"
17 #include "clang/Basic/FileManager.h"
18 #include "llvm/ADT/StringSwitch.h"
19 #include "llvm/ADT/Optional.h"
20 #include "llvm/Support/Compiler.h"
21 #include "llvm/Support/MemoryBuffer.h"
22 #include "llvm/Support/raw_ostream.h"
23 #include "llvm/Support/Path.h"
29 using namespace clang;
30 using namespace SrcMgr;
31 using llvm::MemoryBuffer;
33 //===----------------------------------------------------------------------===//
34 // SourceManager Helper Classes
35 //===----------------------------------------------------------------------===//
37 ContentCache::~ContentCache() {
38 if (shouldFreeBuffer())
39 delete Buffer.getPointer();
42 /// getSizeBytesMapped - Returns the number of bytes actually mapped for
43 /// this ContentCache. This can be 0 if the MemBuffer was not actually
45 unsigned ContentCache::getSizeBytesMapped() const {
46 return Buffer.getPointer() ? Buffer.getPointer()->getBufferSize() : 0;
49 /// Returns the kind of memory used to back the memory buffer for
50 /// this content cache. This is used for performance analysis.
51 llvm::MemoryBuffer::BufferKind ContentCache::getMemoryBufferKind() const {
52 assert(Buffer.getPointer());
54 // Should be unreachable, but keep for sanity.
55 if (!Buffer.getPointer())
56 return llvm::MemoryBuffer::MemoryBuffer_Malloc;
58 const llvm::MemoryBuffer *buf = Buffer.getPointer();
59 return buf->getBufferKind();
62 /// getSize - Returns the size of the content encapsulated by this ContentCache.
63 /// This can be the size of the source file or the size of an arbitrary
64 /// scratch buffer. If the ContentCache encapsulates a source file, that
65 /// file is not lazily brought in from disk to satisfy this query.
66 unsigned ContentCache::getSize() const {
67 return Buffer.getPointer() ? (unsigned) Buffer.getPointer()->getBufferSize()
68 : (unsigned) ContentsEntry->getSize();
71 void ContentCache::replaceBuffer(const llvm::MemoryBuffer *B,
73 assert(B != Buffer.getPointer());
75 if (shouldFreeBuffer())
76 delete Buffer.getPointer();
78 Buffer.setInt(DoNotFree? DoNotFreeFlag : 0);
81 const llvm::MemoryBuffer *ContentCache::getBuffer(Diagnostic &Diag,
82 const SourceManager &SM,
84 bool *Invalid) const {
85 // Lazily create the Buffer for ContentCaches that wrap files. If we already
86 // computed it, just return what we have.
87 if (Buffer.getPointer() || ContentsEntry == 0) {
89 *Invalid = isBufferInvalid();
91 return Buffer.getPointer();
95 Buffer.setPointer(SM.getFileManager().getBufferForFile(ContentsEntry, &ErrorStr));
97 // If we were unable to open the file, then we are in an inconsistent
98 // situation where the content cache referenced a file which no longer
99 // exists. Most likely, we were using a stat cache with an invalid entry but
100 // the file could also have been removed during processing. Since we can't
101 // really deal with this situation, just create an empty buffer.
103 // FIXME: This is definitely not ideal, but our immediate clients can't
104 // currently handle returning a null entry here. Ideally we should detect
105 // that we are in an inconsistent situation and error out as quickly as
107 if (!Buffer.getPointer()) {
108 const llvm::StringRef FillStr("<<<MISSING SOURCE FILE>>>\n");
109 Buffer.setPointer(MemoryBuffer::getNewMemBuffer(ContentsEntry->getSize(),
111 char *Ptr = const_cast<char*>(Buffer.getPointer()->getBufferStart());
112 for (unsigned i = 0, e = ContentsEntry->getSize(); i != e; ++i)
113 Ptr[i] = FillStr[i % FillStr.size()];
115 if (Diag.isDiagnosticInFlight())
116 Diag.SetDelayedDiagnostic(diag::err_cannot_open_file,
117 ContentsEntry->getName(), ErrorStr);
119 Diag.Report(Loc, diag::err_cannot_open_file)
120 << ContentsEntry->getName() << ErrorStr;
122 Buffer.setInt(Buffer.getInt() | InvalidFlag);
124 if (Invalid) *Invalid = true;
125 return Buffer.getPointer();
128 // Check that the file's size is the same as in the file entry (which may
129 // have come from a stat cache).
130 if (getRawBuffer()->getBufferSize() != (size_t)ContentsEntry->getSize()) {
131 if (Diag.isDiagnosticInFlight())
132 Diag.SetDelayedDiagnostic(diag::err_file_modified,
133 ContentsEntry->getName());
135 Diag.Report(Loc, diag::err_file_modified)
136 << ContentsEntry->getName();
138 Buffer.setInt(Buffer.getInt() | InvalidFlag);
139 if (Invalid) *Invalid = true;
140 return Buffer.getPointer();
143 // If the buffer is valid, check to see if it has a UTF Byte Order Mark
144 // (BOM). We only support UTF-8 with and without a BOM right now. See
145 // http://en.wikipedia.org/wiki/Byte_order_mark for more information.
146 llvm::StringRef BufStr = Buffer.getPointer()->getBuffer();
147 const char *InvalidBOM = llvm::StringSwitch<const char *>(BufStr)
148 .StartsWith("\xFE\xFF", "UTF-16 (BE)")
149 .StartsWith("\xFF\xFE", "UTF-16 (LE)")
150 .StartsWith("\x00\x00\xFE\xFF", "UTF-32 (BE)")
151 .StartsWith("\xFF\xFE\x00\x00", "UTF-32 (LE)")
152 .StartsWith("\x2B\x2F\x76", "UTF-7")
153 .StartsWith("\xF7\x64\x4C", "UTF-1")
154 .StartsWith("\xDD\x73\x66\x73", "UTF-EBCDIC")
155 .StartsWith("\x0E\xFE\xFF", "SDSU")
156 .StartsWith("\xFB\xEE\x28", "BOCU-1")
157 .StartsWith("\x84\x31\x95\x33", "GB-18030")
161 Diag.Report(Loc, diag::err_unsupported_bom)
162 << InvalidBOM << ContentsEntry->getName();
163 Buffer.setInt(Buffer.getInt() | InvalidFlag);
167 *Invalid = isBufferInvalid();
169 return Buffer.getPointer();
172 unsigned LineTableInfo::getLineTableFilenameID(llvm::StringRef Name) {
173 // Look up the filename in the string table, returning the pre-existing value
175 llvm::StringMapEntry<unsigned> &Entry =
176 FilenameIDs.GetOrCreateValue(Name, ~0U);
177 if (Entry.getValue() != ~0U)
178 return Entry.getValue();
180 // Otherwise, assign this the next available ID.
181 Entry.setValue(FilenamesByID.size());
182 FilenamesByID.push_back(&Entry);
183 return FilenamesByID.size()-1;
186 /// AddLineNote - Add a line note to the line table that indicates that there
187 /// is a #line at the specified FID/Offset location which changes the presumed
188 /// location to LineNo/FilenameID.
189 void LineTableInfo::AddLineNote(unsigned FID, unsigned Offset,
190 unsigned LineNo, int FilenameID) {
191 std::vector<LineEntry> &Entries = LineEntries[FID];
193 assert((Entries.empty() || Entries.back().FileOffset < Offset) &&
194 "Adding line entries out of order!");
196 SrcMgr::CharacteristicKind Kind = SrcMgr::C_User;
197 unsigned IncludeOffset = 0;
199 if (!Entries.empty()) {
200 // If this is a '#line 4' after '#line 42 "foo.h"', make sure to remember
201 // that we are still in "foo.h".
202 if (FilenameID == -1)
203 FilenameID = Entries.back().FilenameID;
205 // If we are after a line marker that switched us to system header mode, or
206 // that set #include information, preserve it.
207 Kind = Entries.back().FileKind;
208 IncludeOffset = Entries.back().IncludeOffset;
211 Entries.push_back(LineEntry::get(Offset, LineNo, FilenameID, Kind,
215 /// AddLineNote This is the same as the previous version of AddLineNote, but is
216 /// used for GNU line markers. If EntryExit is 0, then this doesn't change the
217 /// presumed #include stack. If it is 1, this is a file entry, if it is 2 then
218 /// this is a file exit. FileKind specifies whether this is a system header or
219 /// extern C system header.
220 void LineTableInfo::AddLineNote(unsigned FID, unsigned Offset,
221 unsigned LineNo, int FilenameID,
223 SrcMgr::CharacteristicKind FileKind) {
224 assert(FilenameID != -1 && "Unspecified filename should use other accessor");
226 std::vector<LineEntry> &Entries = LineEntries[FID];
228 assert((Entries.empty() || Entries.back().FileOffset < Offset) &&
229 "Adding line entries out of order!");
231 unsigned IncludeOffset = 0;
232 if (EntryExit == 0) { // No #include stack change.
233 IncludeOffset = Entries.empty() ? 0 : Entries.back().IncludeOffset;
234 } else if (EntryExit == 1) {
235 IncludeOffset = Offset-1;
236 } else if (EntryExit == 2) {
237 assert(!Entries.empty() && Entries.back().IncludeOffset &&
238 "PPDirectives should have caught case when popping empty include stack");
240 // Get the include loc of the last entries' include loc as our include loc.
242 if (const LineEntry *PrevEntry =
243 FindNearestLineEntry(FID, Entries.back().IncludeOffset))
244 IncludeOffset = PrevEntry->IncludeOffset;
247 Entries.push_back(LineEntry::get(Offset, LineNo, FilenameID, FileKind,
252 /// FindNearestLineEntry - Find the line entry nearest to FID that is before
253 /// it. If there is no line entry before Offset in FID, return null.
254 const LineEntry *LineTableInfo::FindNearestLineEntry(unsigned FID,
256 const std::vector<LineEntry> &Entries = LineEntries[FID];
257 assert(!Entries.empty() && "No #line entries for this FID after all!");
259 // It is very common for the query to be after the last #line, check this
261 if (Entries.back().FileOffset <= Offset)
262 return &Entries.back();
264 // Do a binary search to find the maximal element that is still before Offset.
265 std::vector<LineEntry>::const_iterator I =
266 std::upper_bound(Entries.begin(), Entries.end(), Offset);
267 if (I == Entries.begin()) return 0;
271 /// \brief Add a new line entry that has already been encoded into
272 /// the internal representation of the line table.
273 void LineTableInfo::AddEntry(unsigned FID,
274 const std::vector<LineEntry> &Entries) {
275 LineEntries[FID] = Entries;
278 /// getLineTableFilenameID - Return the uniqued ID for the specified filename.
280 unsigned SourceManager::getLineTableFilenameID(llvm::StringRef Name) {
282 LineTable = new LineTableInfo();
283 return LineTable->getLineTableFilenameID(Name);
287 /// AddLineNote - Add a line note to the line table for the FileID and offset
288 /// specified by Loc. If FilenameID is -1, it is considered to be
290 void SourceManager::AddLineNote(SourceLocation Loc, unsigned LineNo,
292 std::pair<FileID, unsigned> LocInfo = getDecomposedInstantiationLoc(Loc);
294 bool Invalid = false;
295 const SLocEntry &Entry = getSLocEntry(LocInfo.first, &Invalid);
296 if (!Entry.isFile() || Invalid)
299 const SrcMgr::FileInfo &FileInfo = Entry.getFile();
301 // Remember that this file has #line directives now if it doesn't already.
302 const_cast<SrcMgr::FileInfo&>(FileInfo).setHasLineDirectives();
305 LineTable = new LineTableInfo();
306 LineTable->AddLineNote(LocInfo.first.ID, LocInfo.second, LineNo, FilenameID);
309 /// AddLineNote - Add a GNU line marker to the line table.
310 void SourceManager::AddLineNote(SourceLocation Loc, unsigned LineNo,
311 int FilenameID, bool IsFileEntry,
312 bool IsFileExit, bool IsSystemHeader,
313 bool IsExternCHeader) {
314 // If there is no filename and no flags, this is treated just like a #line,
315 // which does not change the flags of the previous line marker.
316 if (FilenameID == -1) {
317 assert(!IsFileEntry && !IsFileExit && !IsSystemHeader && !IsExternCHeader &&
318 "Can't set flags without setting the filename!");
319 return AddLineNote(Loc, LineNo, FilenameID);
322 std::pair<FileID, unsigned> LocInfo = getDecomposedInstantiationLoc(Loc);
324 bool Invalid = false;
325 const SLocEntry &Entry = getSLocEntry(LocInfo.first, &Invalid);
326 if (!Entry.isFile() || Invalid)
329 const SrcMgr::FileInfo &FileInfo = Entry.getFile();
331 // Remember that this file has #line directives now if it doesn't already.
332 const_cast<SrcMgr::FileInfo&>(FileInfo).setHasLineDirectives();
335 LineTable = new LineTableInfo();
337 SrcMgr::CharacteristicKind FileKind;
339 FileKind = SrcMgr::C_ExternCSystem;
340 else if (IsSystemHeader)
341 FileKind = SrcMgr::C_System;
343 FileKind = SrcMgr::C_User;
345 unsigned EntryExit = 0;
351 LineTable->AddLineNote(LocInfo.first.ID, LocInfo.second, LineNo, FilenameID,
352 EntryExit, FileKind);
355 LineTableInfo &SourceManager::getLineTable() {
357 LineTable = new LineTableInfo();
361 //===----------------------------------------------------------------------===//
362 // Private 'Create' methods.
363 //===----------------------------------------------------------------------===//
365 SourceManager::SourceManager(Diagnostic &Diag, FileManager &FileMgr)
366 : Diag(Diag), FileMgr(FileMgr), OverridenFilesKeepOriginalName(true),
367 ExternalSLocEntries(0), LineTable(0), NumLinearScans(0),
368 NumBinaryProbes(0), FakeBufferForRecovery(0) {
370 Diag.setSourceManager(this);
373 SourceManager::~SourceManager() {
376 // Delete FileEntry objects corresponding to content caches. Since the actual
377 // content cache objects are bump pointer allocated, we just have to run the
378 // dtors, but we call the deallocate method for completeness.
379 for (unsigned i = 0, e = MemBufferInfos.size(); i != e; ++i) {
380 MemBufferInfos[i]->~ContentCache();
381 ContentCacheAlloc.Deallocate(MemBufferInfos[i]);
383 for (llvm::DenseMap<const FileEntry*, SrcMgr::ContentCache*>::iterator
384 I = FileInfos.begin(), E = FileInfos.end(); I != E; ++I) {
385 I->second->~ContentCache();
386 ContentCacheAlloc.Deallocate(I->second);
389 delete FakeBufferForRecovery;
392 void SourceManager::clearIDTables() {
393 MainFileID = FileID();
394 SLocEntryTable.clear();
395 LastLineNoFileIDQuery = FileID();
396 LastLineNoContentCache = 0;
397 LastFileIDLookup = FileID();
402 // Use up FileID #0 as an invalid instantiation.
404 createInstantiationLoc(SourceLocation(),SourceLocation(),SourceLocation(), 1);
407 /// getOrCreateContentCache - Create or return a cached ContentCache for the
410 SourceManager::getOrCreateContentCache(const FileEntry *FileEnt) {
411 assert(FileEnt && "Didn't specify a file entry to use?");
413 // Do we already have information about this file?
414 ContentCache *&Entry = FileInfos[FileEnt];
415 if (Entry) return Entry;
417 // Nope, create a new Cache entry. Make sure it is at least 8-byte aligned
418 // so that FileInfo can use the low 3 bits of the pointer for its own
419 // nefarious purposes.
420 unsigned EntryAlign = llvm::AlignOf<ContentCache>::Alignment;
421 EntryAlign = std::max(8U, EntryAlign);
422 Entry = ContentCacheAlloc.Allocate<ContentCache>(1, EntryAlign);
424 // If the file contents are overridden with contents from another file,
425 // pass that file to ContentCache.
426 llvm::DenseMap<const FileEntry *, const FileEntry *>::iterator
427 overI = OverriddenFiles.find(FileEnt);
428 if (overI == OverriddenFiles.end())
429 new (Entry) ContentCache(FileEnt);
431 new (Entry) ContentCache(OverridenFilesKeepOriginalName ? FileEnt
439 /// createMemBufferContentCache - Create a new ContentCache for the specified
440 /// memory buffer. This does no caching.
442 SourceManager::createMemBufferContentCache(const MemoryBuffer *Buffer) {
443 // Add a new ContentCache to the MemBufferInfos list and return it. Make sure
444 // it is at least 8-byte aligned so that FileInfo can use the low 3 bits of
445 // the pointer for its own nefarious purposes.
446 unsigned EntryAlign = llvm::AlignOf<ContentCache>::Alignment;
447 EntryAlign = std::max(8U, EntryAlign);
448 ContentCache *Entry = ContentCacheAlloc.Allocate<ContentCache>(1, EntryAlign);
449 new (Entry) ContentCache();
450 MemBufferInfos.push_back(Entry);
451 Entry->setBuffer(Buffer);
455 void SourceManager::PreallocateSLocEntries(ExternalSLocEntrySource *Source,
456 unsigned NumSLocEntries,
457 unsigned NextOffset) {
458 ExternalSLocEntries = Source;
459 this->NextOffset = NextOffset;
460 unsigned CurPrealloc = SLocEntryLoaded.size();
461 // If we've ever preallocated, we must not count the dummy entry.
462 if (CurPrealloc) --CurPrealloc;
463 SLocEntryLoaded.resize(NumSLocEntries + 1);
464 SLocEntryLoaded[0] = true;
465 SLocEntryTable.resize(SLocEntryTable.size() + NumSLocEntries - CurPrealloc);
468 void SourceManager::ClearPreallocatedSLocEntries() {
470 for (unsigned N = SLocEntryLoaded.size(); I != N; ++I)
471 if (!SLocEntryLoaded[I])
474 // We've already loaded all preallocated source location entries.
475 if (I == SLocEntryLoaded.size())
478 // Remove everything from location I onward.
479 SLocEntryTable.resize(I);
480 SLocEntryLoaded.clear();
481 ExternalSLocEntries = 0;
484 /// \brief As part of recovering from missing or changed content, produce a
485 /// fake, non-empty buffer.
486 const llvm::MemoryBuffer *SourceManager::getFakeBufferForRecovery() const {
487 if (!FakeBufferForRecovery)
488 FakeBufferForRecovery
489 = llvm::MemoryBuffer::getMemBuffer("<<<INVALID BUFFER>>");
491 return FakeBufferForRecovery;
494 //===----------------------------------------------------------------------===//
495 // Methods to create new FileID's and instantiations.
496 //===----------------------------------------------------------------------===//
498 /// createFileID - Create a new FileID for the specified ContentCache and
499 /// include position. This works regardless of whether the ContentCache
500 /// corresponds to a file or some other input source.
501 FileID SourceManager::createFileID(const ContentCache *File,
502 SourceLocation IncludePos,
503 SrcMgr::CharacteristicKind FileCharacter,
504 unsigned PreallocatedID,
506 if (PreallocatedID) {
507 // If we're filling in a preallocated ID, just load in the file
509 assert(PreallocatedID < SLocEntryLoaded.size() &&
510 "Preallocate ID out-of-range");
511 assert(!SLocEntryLoaded[PreallocatedID] &&
512 "Source location entry already loaded");
513 assert(Offset && "Preallocate source location cannot have zero offset");
514 SLocEntryTable[PreallocatedID]
515 = SLocEntry::get(Offset, FileInfo::get(IncludePos, File, FileCharacter));
516 SLocEntryLoaded[PreallocatedID] = true;
517 FileID FID = FileID::get(PreallocatedID);
521 SLocEntryTable.push_back(SLocEntry::get(NextOffset,
522 FileInfo::get(IncludePos, File,
524 unsigned FileSize = File->getSize();
525 assert(NextOffset+FileSize+1 > NextOffset && "Ran out of source locations!");
526 NextOffset += FileSize+1;
528 // Set LastFileIDLookup to the newly created file. The next getFileID call is
529 // almost guaranteed to be from that file.
530 FileID FID = FileID::get(SLocEntryTable.size()-1);
531 return LastFileIDLookup = FID;
535 SourceManager::createMacroArgInstantiationLoc(SourceLocation SpellingLoc,
537 unsigned TokLength) {
538 InstantiationInfo II =
539 InstantiationInfo::createForMacroArg(SpellingLoc, ILoc);
540 return createInstantiationLocImpl(II, TokLength);
543 SourceLocation SourceManager::createInstantiationLoc(SourceLocation SpellingLoc,
544 SourceLocation ILocStart,
545 SourceLocation ILocEnd,
547 unsigned PreallocatedID,
549 InstantiationInfo II =
550 InstantiationInfo::create(SpellingLoc, ILocStart, ILocEnd);
551 return createInstantiationLocImpl(II, TokLength, PreallocatedID, Offset);
555 SourceManager::createInstantiationLocImpl(const InstantiationInfo &II,
557 unsigned PreallocatedID,
559 if (PreallocatedID) {
560 // If we're filling in a preallocated ID, just load in the
561 // instantiation entry and return.
562 assert(PreallocatedID < SLocEntryLoaded.size() &&
563 "Preallocate ID out-of-range");
564 assert(!SLocEntryLoaded[PreallocatedID] &&
565 "Source location entry already loaded");
566 assert(Offset && "Preallocate source location cannot have zero offset");
567 SLocEntryTable[PreallocatedID] = SLocEntry::get(Offset, II);
568 SLocEntryLoaded[PreallocatedID] = true;
569 return SourceLocation::getMacroLoc(Offset);
571 SLocEntryTable.push_back(SLocEntry::get(NextOffset, II));
572 assert(NextOffset+TokLength+1 > NextOffset && "Ran out of source locations!");
573 NextOffset += TokLength+1;
574 return SourceLocation::getMacroLoc(NextOffset-(TokLength+1));
577 const llvm::MemoryBuffer *
578 SourceManager::getMemoryBufferForFile(const FileEntry *File,
580 const SrcMgr::ContentCache *IR = getOrCreateContentCache(File);
581 assert(IR && "getOrCreateContentCache() cannot return NULL");
582 return IR->getBuffer(Diag, *this, SourceLocation(), Invalid);
585 void SourceManager::overrideFileContents(const FileEntry *SourceFile,
586 const llvm::MemoryBuffer *Buffer,
588 const SrcMgr::ContentCache *IR = getOrCreateContentCache(SourceFile);
589 assert(IR && "getOrCreateContentCache() cannot return NULL");
591 const_cast<SrcMgr::ContentCache *>(IR)->replaceBuffer(Buffer, DoNotFree);
594 void SourceManager::overrideFileContents(const FileEntry *SourceFile,
595 const FileEntry *NewFile) {
596 assert(SourceFile->getSize() == NewFile->getSize() &&
597 "Different sizes, use the FileManager to create a virtual file with "
599 assert(FileInfos.count(SourceFile) == 0 &&
600 "This function should be called at the initialization stage, before "
601 "any parsing occurs.");
602 OverriddenFiles[SourceFile] = NewFile;
605 llvm::StringRef SourceManager::getBufferData(FileID FID, bool *Invalid) const {
606 bool MyInvalid = false;
607 const SLocEntry &SLoc = getSLocEntry(FID.ID, &MyInvalid);
608 if (!SLoc.isFile() || MyInvalid) {
611 return "<<<<<INVALID SOURCE LOCATION>>>>>";
614 const llvm::MemoryBuffer *Buf
615 = SLoc.getFile().getContentCache()->getBuffer(Diag, *this, SourceLocation(),
618 *Invalid = MyInvalid;
621 return "<<<<<INVALID SOURCE LOCATION>>>>>";
623 return Buf->getBuffer();
626 //===----------------------------------------------------------------------===//
627 // SourceLocation manipulation methods.
628 //===----------------------------------------------------------------------===//
630 /// getFileIDSlow - Return the FileID for a SourceLocation. This is a very hot
631 /// method that is used for all SourceManager queries that start with a
632 /// SourceLocation object. It is responsible for finding the entry in
633 /// SLocEntryTable which contains the specified location.
635 FileID SourceManager::getFileIDSlow(unsigned SLocOffset) const {
637 return FileID::get(0);
639 // After the first and second level caches, I see two common sorts of
640 // behavior: 1) a lot of searched FileID's are "near" the cached file location
641 // or are "near" the cached instantiation location. 2) others are just
642 // completely random and may be a very long way away.
644 // To handle this, we do a linear search for up to 8 steps to catch #1 quickly
645 // then we fall back to a less cache efficient, but more scalable, binary
646 // search to find the location.
648 // See if this is near the file point - worst case we start scanning from the
649 // most newly created FileID.
650 std::vector<SrcMgr::SLocEntry>::const_iterator I;
652 if (SLocEntryTable[LastFileIDLookup.ID].getOffset() < SLocOffset) {
653 // Neither loc prunes our search.
654 I = SLocEntryTable.end();
656 // Perhaps it is near the file point.
657 I = SLocEntryTable.begin()+LastFileIDLookup.ID;
660 // Find the FileID that contains this. "I" is an iterator that points to a
661 // FileID whose offset is known to be larger than SLocOffset.
662 unsigned NumProbes = 0;
665 if (ExternalSLocEntries) {
666 bool Invalid = false;
667 getSLocEntry(FileID::get(I - SLocEntryTable.begin()), &Invalid);
669 return FileID::get(0);
672 if (I->getOffset() <= SLocOffset) {
674 printf("lin %d -> %d [%s] %d %d\n", SLocOffset,
675 I-SLocEntryTable.begin(),
676 I->isInstantiation() ? "inst" : "file",
677 LastFileIDLookup.ID, int(SLocEntryTable.end()-I));
679 FileID Res = FileID::get(I-SLocEntryTable.begin());
681 // If this isn't an instantiation, remember it. We have good locality
682 // across FileID lookups.
683 if (!I->isInstantiation())
684 LastFileIDLookup = Res;
685 NumLinearScans += NumProbes+1;
688 if (++NumProbes == 8)
692 // Convert "I" back into an index. We know that it is an entry whose index is
693 // larger than the offset we are looking for.
694 unsigned GreaterIndex = I-SLocEntryTable.begin();
695 // LessIndex - This is the lower bound of the range that we're searching.
696 // We know that the offset corresponding to the FileID is is less than
698 unsigned LessIndex = 0;
701 bool Invalid = false;
702 unsigned MiddleIndex = (GreaterIndex-LessIndex)/2+LessIndex;
703 unsigned MidOffset = getSLocEntry(FileID::get(MiddleIndex), &Invalid)
706 return FileID::get(0);
710 // If the offset of the midpoint is too large, chop the high side of the
711 // range to the midpoint.
712 if (MidOffset > SLocOffset) {
713 GreaterIndex = MiddleIndex;
717 // If the middle index contains the value, succeed and return.
718 if (isOffsetInFileID(FileID::get(MiddleIndex), SLocOffset)) {
720 printf("bin %d -> %d [%s] %d %d\n", SLocOffset,
721 I-SLocEntryTable.begin(),
722 I->isInstantiation() ? "inst" : "file",
723 LastFileIDLookup.ID, int(SLocEntryTable.end()-I));
725 FileID Res = FileID::get(MiddleIndex);
727 // If this isn't an instantiation, remember it. We have good locality
728 // across FileID lookups.
729 if (!I->isInstantiation())
730 LastFileIDLookup = Res;
731 NumBinaryProbes += NumProbes;
735 // Otherwise, move the low-side up to the middle index.
736 LessIndex = MiddleIndex;
740 SourceLocation SourceManager::
741 getInstantiationLocSlowCase(SourceLocation Loc) const {
743 // Note: If Loc indicates an offset into a token that came from a macro
744 // expansion (e.g. the 5th character of the token) we do not want to add
745 // this offset when going to the instantiation location. The instatiation
746 // location is the macro invocation, which the offset has nothing to do
747 // with. This is unlike when we get the spelling loc, because the offset
748 // directly correspond to the token whose spelling we're inspecting.
749 Loc = getSLocEntry(getFileID(Loc)).getInstantiation()
750 .getInstantiationLocStart();
751 } while (!Loc.isFileID());
756 SourceLocation SourceManager::getSpellingLocSlowCase(SourceLocation Loc) const {
758 std::pair<FileID, unsigned> LocInfo = getDecomposedLoc(Loc);
759 Loc = getSLocEntry(LocInfo.first).getInstantiation().getSpellingLoc();
760 Loc = Loc.getFileLocWithOffset(LocInfo.second);
761 } while (!Loc.isFileID());
766 std::pair<FileID, unsigned>
767 SourceManager::getDecomposedInstantiationLocSlowCase(
768 const SrcMgr::SLocEntry *E) const {
769 // If this is an instantiation record, walk through all the instantiation
775 Loc = E->getInstantiation().getInstantiationLocStart();
777 FID = getFileID(Loc);
778 E = &getSLocEntry(FID);
779 Offset = Loc.getOffset()-E->getOffset();
780 } while (!Loc.isFileID());
782 return std::make_pair(FID, Offset);
785 std::pair<FileID, unsigned>
786 SourceManager::getDecomposedSpellingLocSlowCase(const SrcMgr::SLocEntry *E,
787 unsigned Offset) const {
788 // If this is an instantiation record, walk through all the instantiation
793 Loc = E->getInstantiation().getSpellingLoc();
795 FID = getFileID(Loc);
796 E = &getSLocEntry(FID);
797 Offset += Loc.getOffset()-E->getOffset();
798 } while (!Loc.isFileID());
800 return std::make_pair(FID, Offset);
803 /// getImmediateSpellingLoc - Given a SourceLocation object, return the
804 /// spelling location referenced by the ID. This is the first level down
805 /// towards the place where the characters that make up the lexed token can be
806 /// found. This should not generally be used by clients.
807 SourceLocation SourceManager::getImmediateSpellingLoc(SourceLocation Loc) const{
808 if (Loc.isFileID()) return Loc;
809 std::pair<FileID, unsigned> LocInfo = getDecomposedLoc(Loc);
810 Loc = getSLocEntry(LocInfo.first).getInstantiation().getSpellingLoc();
811 return Loc.getFileLocWithOffset(LocInfo.second);
815 /// getImmediateInstantiationRange - Loc is required to be an instantiation
816 /// location. Return the start/end of the instantiation information.
817 std::pair<SourceLocation,SourceLocation>
818 SourceManager::getImmediateInstantiationRange(SourceLocation Loc) const {
819 assert(Loc.isMacroID() && "Not an instantiation loc!");
820 const InstantiationInfo &II = getSLocEntry(getFileID(Loc)).getInstantiation();
821 return II.getInstantiationLocRange();
824 /// getInstantiationRange - Given a SourceLocation object, return the
825 /// range of tokens covered by the instantiation in the ultimate file.
826 std::pair<SourceLocation,SourceLocation>
827 SourceManager::getInstantiationRange(SourceLocation Loc) const {
828 if (Loc.isFileID()) return std::make_pair(Loc, Loc);
830 std::pair<SourceLocation,SourceLocation> Res =
831 getImmediateInstantiationRange(Loc);
833 // Fully resolve the start and end locations to their ultimate instantiation
835 while (!Res.first.isFileID())
836 Res.first = getImmediateInstantiationRange(Res.first).first;
837 while (!Res.second.isFileID())
838 Res.second = getImmediateInstantiationRange(Res.second).second;
842 bool SourceManager::isMacroArgInstantiation(SourceLocation Loc) const {
843 if (!Loc.isMacroID()) return false;
845 FileID FID = getFileID(Loc);
846 const SrcMgr::SLocEntry *E = &getSLocEntry(FID);
847 const SrcMgr::InstantiationInfo &II = E->getInstantiation();
848 return II.isMacroArgInstantiation();
852 //===----------------------------------------------------------------------===//
853 // Queries about the code at a SourceLocation.
854 //===----------------------------------------------------------------------===//
856 /// getCharacterData - Return a pointer to the start of the specified location
857 /// in the appropriate MemoryBuffer.
858 const char *SourceManager::getCharacterData(SourceLocation SL,
859 bool *Invalid) const {
860 // Note that this is a hot function in the getSpelling() path, which is
861 // heavily used by -E mode.
862 std::pair<FileID, unsigned> LocInfo = getDecomposedSpellingLoc(SL);
864 // Note that calling 'getBuffer()' may lazily page in a source file.
865 bool CharDataInvalid = false;
866 const SLocEntry &Entry = getSLocEntry(LocInfo.first, &CharDataInvalid);
867 if (CharDataInvalid || !Entry.isFile()) {
871 return "<<<<INVALID BUFFER>>>>";
873 const llvm::MemoryBuffer *Buffer
874 = Entry.getFile().getContentCache()
875 ->getBuffer(Diag, *this, SourceLocation(), &CharDataInvalid);
877 *Invalid = CharDataInvalid;
878 return Buffer->getBufferStart() + (CharDataInvalid? 0 : LocInfo.second);
882 /// getColumnNumber - Return the column # for the specified file position.
883 /// this is significantly cheaper to compute than the line number.
884 unsigned SourceManager::getColumnNumber(FileID FID, unsigned FilePos,
885 bool *Invalid) const {
886 bool MyInvalid = false;
887 const char *Buf = getBuffer(FID, &MyInvalid)->getBufferStart();
889 *Invalid = MyInvalid;
894 unsigned LineStart = FilePos;
895 while (LineStart && Buf[LineStart-1] != '\n' && Buf[LineStart-1] != '\r')
897 return FilePos-LineStart+1;
900 // isInvalid - Return the result of calling loc.isInvalid(), and
901 // if Invalid is not null, set its value to same.
902 static bool isInvalid(SourceLocation Loc, bool *Invalid) {
903 bool MyInvalid = Loc.isInvalid();
905 *Invalid = MyInvalid;
909 unsigned SourceManager::getSpellingColumnNumber(SourceLocation Loc,
910 bool *Invalid) const {
911 if (isInvalid(Loc, Invalid)) return 0;
912 std::pair<FileID, unsigned> LocInfo = getDecomposedSpellingLoc(Loc);
913 return getColumnNumber(LocInfo.first, LocInfo.second, Invalid);
916 unsigned SourceManager::getInstantiationColumnNumber(SourceLocation Loc,
917 bool *Invalid) const {
918 if (isInvalid(Loc, Invalid)) return 0;
919 std::pair<FileID, unsigned> LocInfo = getDecomposedInstantiationLoc(Loc);
920 return getColumnNumber(LocInfo.first, LocInfo.second, Invalid);
923 unsigned SourceManager::getPresumedColumnNumber(SourceLocation Loc,
924 bool *Invalid) const {
925 if (isInvalid(Loc, Invalid)) return 0;
926 return getPresumedLoc(Loc).getColumn();
929 static LLVM_ATTRIBUTE_NOINLINE void
930 ComputeLineNumbers(Diagnostic &Diag, ContentCache *FI,
931 llvm::BumpPtrAllocator &Alloc,
932 const SourceManager &SM, bool &Invalid);
933 static void ComputeLineNumbers(Diagnostic &Diag, ContentCache *FI,
934 llvm::BumpPtrAllocator &Alloc,
935 const SourceManager &SM, bool &Invalid) {
936 // Note that calling 'getBuffer()' may lazily page in the file.
937 const MemoryBuffer *Buffer = FI->getBuffer(Diag, SM, SourceLocation(),
942 // Find the file offsets of all of the *physical* source lines. This does
943 // not look at trigraphs, escaped newlines, or anything else tricky.
944 llvm::SmallVector<unsigned, 256> LineOffsets;
946 // Line #1 starts at char 0.
947 LineOffsets.push_back(0);
949 const unsigned char *Buf = (const unsigned char *)Buffer->getBufferStart();
950 const unsigned char *End = (const unsigned char *)Buffer->getBufferEnd();
953 // Skip over the contents of the line.
954 // TODO: Vectorize this? This is very performance sensitive for programs
955 // with lots of diagnostics and in -E mode.
956 const unsigned char *NextBuf = (const unsigned char *)Buf;
957 while (*NextBuf != '\n' && *NextBuf != '\r' && *NextBuf != '\0')
962 if (Buf[0] == '\n' || Buf[0] == '\r') {
963 // If this is \n\r or \r\n, skip both characters.
964 if ((Buf[1] == '\n' || Buf[1] == '\r') && Buf[0] != Buf[1])
967 LineOffsets.push_back(Offs);
969 // Otherwise, this is a null. If end of file, exit.
970 if (Buf == End) break;
971 // Otherwise, skip the null.
976 // Copy the offsets into the FileInfo structure.
977 FI->NumLines = LineOffsets.size();
978 FI->SourceLineCache = Alloc.Allocate<unsigned>(LineOffsets.size());
979 std::copy(LineOffsets.begin(), LineOffsets.end(), FI->SourceLineCache);
982 /// getLineNumber - Given a SourceLocation, return the spelling line number
983 /// for the position indicated. This requires building and caching a table of
984 /// line offsets for the MemoryBuffer, so this is not cheap: use only when
985 /// about to emit a diagnostic.
986 unsigned SourceManager::getLineNumber(FileID FID, unsigned FilePos,
987 bool *Invalid) const {
988 if (FID.isInvalid()) {
994 ContentCache *Content;
995 if (LastLineNoFileIDQuery == FID)
996 Content = LastLineNoContentCache;
998 bool MyInvalid = false;
999 const SLocEntry &Entry = getSLocEntry(FID, &MyInvalid);
1000 if (MyInvalid || !Entry.isFile()) {
1006 Content = const_cast<ContentCache*>(Entry.getFile().getContentCache());
1009 // If this is the first use of line information for this buffer, compute the
1010 /// SourceLineCache for it on demand.
1011 if (Content->SourceLineCache == 0) {
1012 bool MyInvalid = false;
1013 ComputeLineNumbers(Diag, Content, ContentCacheAlloc, *this, MyInvalid);
1015 *Invalid = MyInvalid;
1021 // Okay, we know we have a line number table. Do a binary search to find the
1022 // line number that this character position lands on.
1023 unsigned *SourceLineCache = Content->SourceLineCache;
1024 unsigned *SourceLineCacheStart = SourceLineCache;
1025 unsigned *SourceLineCacheEnd = SourceLineCache + Content->NumLines;
1027 unsigned QueriedFilePos = FilePos+1;
1029 // FIXME: I would like to be convinced that this code is worth being as
1030 // complicated as it is, binary search isn't that slow.
1032 // If it is worth being optimized, then in my opinion it could be more
1033 // performant, simpler, and more obviously correct by just "galloping" outward
1034 // from the queried file position. In fact, this could be incorporated into a
1035 // generic algorithm such as lower_bound_with_hint.
1037 // If someone gives me a test case where this matters, and I will do it! - DWD
1039 // If the previous query was to the same file, we know both the file pos from
1040 // that query and the line number returned. This allows us to narrow the
1041 // search space from the entire file to something near the match.
1042 if (LastLineNoFileIDQuery == FID) {
1043 if (QueriedFilePos >= LastLineNoFilePos) {
1044 // FIXME: Potential overflow?
1045 SourceLineCache = SourceLineCache+LastLineNoResult-1;
1047 // The query is likely to be nearby the previous one. Here we check to
1048 // see if it is within 5, 10 or 20 lines. It can be far away in cases
1049 // where big comment blocks and vertical whitespace eat up lines but
1050 // contribute no tokens.
1051 if (SourceLineCache+5 < SourceLineCacheEnd) {
1052 if (SourceLineCache[5] > QueriedFilePos)
1053 SourceLineCacheEnd = SourceLineCache+5;
1054 else if (SourceLineCache+10 < SourceLineCacheEnd) {
1055 if (SourceLineCache[10] > QueriedFilePos)
1056 SourceLineCacheEnd = SourceLineCache+10;
1057 else if (SourceLineCache+20 < SourceLineCacheEnd) {
1058 if (SourceLineCache[20] > QueriedFilePos)
1059 SourceLineCacheEnd = SourceLineCache+20;
1064 if (LastLineNoResult < Content->NumLines)
1065 SourceLineCacheEnd = SourceLineCache+LastLineNoResult+1;
1069 // If the spread is large, do a "radix" test as our initial guess, based on
1070 // the assumption that lines average to approximately the same length.
1071 // NOTE: This is currently disabled, as it does not appear to be profitable in
1072 // initial measurements.
1073 if (0 && SourceLineCacheEnd-SourceLineCache > 20) {
1074 unsigned FileLen = Content->SourceLineCache[Content->NumLines-1];
1076 // Take a stab at guessing where it is.
1077 unsigned ApproxPos = Content->NumLines*QueriedFilePos / FileLen;
1079 // Check for -10 and +10 lines.
1080 unsigned LowerBound = std::max(int(ApproxPos-10), 0);
1081 unsigned UpperBound = std::min(ApproxPos+10, FileLen);
1083 // If the computed lower bound is less than the query location, move it in.
1084 if (SourceLineCache < SourceLineCacheStart+LowerBound &&
1085 SourceLineCacheStart[LowerBound] < QueriedFilePos)
1086 SourceLineCache = SourceLineCacheStart+LowerBound;
1088 // If the computed upper bound is greater than the query location, move it.
1089 if (SourceLineCacheEnd > SourceLineCacheStart+UpperBound &&
1090 SourceLineCacheStart[UpperBound] >= QueriedFilePos)
1091 SourceLineCacheEnd = SourceLineCacheStart+UpperBound;
1095 = std::lower_bound(SourceLineCache, SourceLineCacheEnd, QueriedFilePos);
1096 unsigned LineNo = Pos-SourceLineCacheStart;
1098 LastLineNoFileIDQuery = FID;
1099 LastLineNoContentCache = Content;
1100 LastLineNoFilePos = QueriedFilePos;
1101 LastLineNoResult = LineNo;
1105 unsigned SourceManager::getSpellingLineNumber(SourceLocation Loc,
1106 bool *Invalid) const {
1107 if (isInvalid(Loc, Invalid)) return 0;
1108 std::pair<FileID, unsigned> LocInfo = getDecomposedSpellingLoc(Loc);
1109 return getLineNumber(LocInfo.first, LocInfo.second);
1111 unsigned SourceManager::getInstantiationLineNumber(SourceLocation Loc,
1112 bool *Invalid) const {
1113 if (isInvalid(Loc, Invalid)) return 0;
1114 std::pair<FileID, unsigned> LocInfo = getDecomposedInstantiationLoc(Loc);
1115 return getLineNumber(LocInfo.first, LocInfo.second);
1117 unsigned SourceManager::getPresumedLineNumber(SourceLocation Loc,
1118 bool *Invalid) const {
1119 if (isInvalid(Loc, Invalid)) return 0;
1120 return getPresumedLoc(Loc).getLine();
1123 /// getFileCharacteristic - return the file characteristic of the specified
1124 /// source location, indicating whether this is a normal file, a system
1125 /// header, or an "implicit extern C" system header.
1127 /// This state can be modified with flags on GNU linemarker directives like:
1129 /// which changes all source locations in the current file after that to be
1130 /// considered to be from a system header.
1131 SrcMgr::CharacteristicKind
1132 SourceManager::getFileCharacteristic(SourceLocation Loc) const {
1133 assert(!Loc.isInvalid() && "Can't get file characteristic of invalid loc!");
1134 std::pair<FileID, unsigned> LocInfo = getDecomposedInstantiationLoc(Loc);
1135 bool Invalid = false;
1136 const SLocEntry &SEntry = getSLocEntry(LocInfo.first, &Invalid);
1137 if (Invalid || !SEntry.isFile())
1140 const SrcMgr::FileInfo &FI = SEntry.getFile();
1142 // If there are no #line directives in this file, just return the whole-file
1144 if (!FI.hasLineDirectives())
1145 return FI.getFileCharacteristic();
1147 assert(LineTable && "Can't have linetable entries without a LineTable!");
1148 // See if there is a #line directive before the location.
1149 const LineEntry *Entry =
1150 LineTable->FindNearestLineEntry(LocInfo.first.ID, LocInfo.second);
1152 // If this is before the first line marker, use the file characteristic.
1154 return FI.getFileCharacteristic();
1156 return Entry->FileKind;
1159 /// Return the filename or buffer identifier of the buffer the location is in.
1160 /// Note that this name does not respect #line directives. Use getPresumedLoc
1161 /// for normal clients.
1162 const char *SourceManager::getBufferName(SourceLocation Loc,
1163 bool *Invalid) const {
1164 if (isInvalid(Loc, Invalid)) return "<invalid loc>";
1166 return getBuffer(getFileID(Loc), Invalid)->getBufferIdentifier();
1170 /// getPresumedLoc - This method returns the "presumed" location of a
1171 /// SourceLocation specifies. A "presumed location" can be modified by #line
1172 /// or GNU line marker directives. This provides a view on the data that a
1173 /// user should see in diagnostics, for example.
1175 /// Note that a presumed location is always given as the instantiation point
1176 /// of an instantiation location, not at the spelling location.
1177 PresumedLoc SourceManager::getPresumedLoc(SourceLocation Loc) const {
1178 if (Loc.isInvalid()) return PresumedLoc();
1180 // Presumed locations are always for instantiation points.
1181 std::pair<FileID, unsigned> LocInfo = getDecomposedInstantiationLoc(Loc);
1183 bool Invalid = false;
1184 const SLocEntry &Entry = getSLocEntry(LocInfo.first, &Invalid);
1185 if (Invalid || !Entry.isFile())
1186 return PresumedLoc();
1188 const SrcMgr::FileInfo &FI = Entry.getFile();
1189 const SrcMgr::ContentCache *C = FI.getContentCache();
1191 // To get the source name, first consult the FileEntry (if one exists)
1192 // before the MemBuffer as this will avoid unnecessarily paging in the
1194 const char *Filename;
1196 Filename = C->OrigEntry->getName();
1198 Filename = C->getBuffer(Diag, *this)->getBufferIdentifier();
1200 unsigned LineNo = getLineNumber(LocInfo.first, LocInfo.second, &Invalid);
1202 return PresumedLoc();
1203 unsigned ColNo = getColumnNumber(LocInfo.first, LocInfo.second, &Invalid);
1205 return PresumedLoc();
1207 SourceLocation IncludeLoc = FI.getIncludeLoc();
1209 // If we have #line directives in this file, update and overwrite the physical
1210 // location info if appropriate.
1211 if (FI.hasLineDirectives()) {
1212 assert(LineTable && "Can't have linetable entries without a LineTable!");
1213 // See if there is a #line directive before this. If so, get it.
1214 if (const LineEntry *Entry =
1215 LineTable->FindNearestLineEntry(LocInfo.first.ID, LocInfo.second)) {
1216 // If the LineEntry indicates a filename, use it.
1217 if (Entry->FilenameID != -1)
1218 Filename = LineTable->getFilename(Entry->FilenameID);
1220 // Use the line number specified by the LineEntry. This line number may
1221 // be multiple lines down from the line entry. Add the difference in
1222 // physical line numbers from the query point and the line marker to the
1224 unsigned MarkerLineNo = getLineNumber(LocInfo.first, Entry->FileOffset);
1225 LineNo = Entry->LineNo + (LineNo-MarkerLineNo-1);
1227 // Note that column numbers are not molested by line markers.
1229 // Handle virtual #include manipulation.
1230 if (Entry->IncludeOffset) {
1231 IncludeLoc = getLocForStartOfFile(LocInfo.first);
1232 IncludeLoc = IncludeLoc.getFileLocWithOffset(Entry->IncludeOffset);
1237 return PresumedLoc(Filename, LineNo, ColNo, IncludeLoc);
1240 //===----------------------------------------------------------------------===//
1241 // Other miscellaneous methods.
1242 //===----------------------------------------------------------------------===//
1244 /// \brief Retrieve the inode for the given file entry, if possible.
1246 /// This routine involves a system call, and therefore should only be used
1247 /// in non-performance-critical code.
1248 static llvm::Optional<ino_t> getActualFileInode(const FileEntry *File) {
1250 return llvm::Optional<ino_t>();
1252 struct stat StatBuf;
1253 if (::stat(File->getName(), &StatBuf))
1254 return llvm::Optional<ino_t>();
1256 return StatBuf.st_ino;
1259 /// \brief Get the source location for the given file:line:col triplet.
1261 /// If the source file is included multiple times, the source location will
1262 /// be based upon the first inclusion.
1263 SourceLocation SourceManager::getLocation(const FileEntry *SourceFile,
1264 unsigned Line, unsigned Col) {
1265 assert(SourceFile && "Null source file!");
1266 assert(Line && Col && "Line and column should start from 1!");
1268 // Find the first file ID that corresponds to the given file.
1271 // First, check the main file ID, since it is common to look for a
1272 // location in the main file.
1273 llvm::Optional<ino_t> SourceFileInode;
1274 llvm::Optional<llvm::StringRef> SourceFileName;
1275 if (!MainFileID.isInvalid()) {
1276 bool Invalid = false;
1277 const SLocEntry &MainSLoc = getSLocEntry(MainFileID, &Invalid);
1279 return SourceLocation();
1281 if (MainSLoc.isFile()) {
1282 const ContentCache *MainContentCache
1283 = MainSLoc.getFile().getContentCache();
1284 if (!MainContentCache) {
1285 // Can't do anything
1286 } else if (MainContentCache->OrigEntry == SourceFile) {
1287 FirstFID = MainFileID;
1289 // Fall back: check whether we have the same base name and inode
1290 // as the main file.
1291 const FileEntry *MainFile = MainContentCache->OrigEntry;
1292 SourceFileName = llvm::sys::path::filename(SourceFile->getName());
1293 if (*SourceFileName == llvm::sys::path::filename(MainFile->getName())) {
1294 SourceFileInode = getActualFileInode(SourceFile);
1295 if (SourceFileInode) {
1296 if (llvm::Optional<ino_t> MainFileInode
1297 = getActualFileInode(MainFile)) {
1298 if (*SourceFileInode == *MainFileInode) {
1299 FirstFID = MainFileID;
1300 SourceFile = MainFile;
1309 if (FirstFID.isInvalid()) {
1310 // The location we're looking for isn't in the main file; look
1311 // through all of the source locations.
1312 for (unsigned I = 0, N = sloc_entry_size(); I != N; ++I) {
1313 bool Invalid = false;
1314 const SLocEntry &SLoc = getSLocEntry(I, &Invalid);
1316 return SourceLocation();
1318 if (SLoc.isFile() &&
1319 SLoc.getFile().getContentCache() &&
1320 SLoc.getFile().getContentCache()->OrigEntry == SourceFile) {
1321 FirstFID = FileID::get(I);
1327 // If we haven't found what we want yet, try again, but this time stat()
1328 // each of the files in case the files have changed since we originally
1330 if (FirstFID.isInvalid() &&
1332 (SourceFileName = llvm::sys::path::filename(SourceFile->getName()))) &&
1334 (SourceFileInode = getActualFileInode(SourceFile)))) {
1335 bool Invalid = false;
1336 for (unsigned I = 0, N = sloc_entry_size(); I != N; ++I) {
1337 const SLocEntry &SLoc = getSLocEntry(I, &Invalid);
1339 return SourceLocation();
1341 if (SLoc.isFile()) {
1342 const ContentCache *FileContentCache
1343 = SLoc.getFile().getContentCache();
1344 const FileEntry *Entry =FileContentCache? FileContentCache->OrigEntry : 0;
1346 *SourceFileName == llvm::sys::path::filename(Entry->getName())) {
1347 if (llvm::Optional<ino_t> EntryInode = getActualFileInode(Entry)) {
1348 if (*SourceFileInode == *EntryInode) {
1349 FirstFID = FileID::get(I);
1359 if (FirstFID.isInvalid())
1360 return SourceLocation();
1362 if (Line == 1 && Col == 1)
1363 return getLocForStartOfFile(FirstFID);
1365 ContentCache *Content
1366 = const_cast<ContentCache *>(getOrCreateContentCache(SourceFile));
1368 return SourceLocation();
1370 // If this is the first use of line information for this buffer, compute the
1371 /// SourceLineCache for it on demand.
1372 if (Content->SourceLineCache == 0) {
1373 bool MyInvalid = false;
1374 ComputeLineNumbers(Diag, Content, ContentCacheAlloc, *this, MyInvalid);
1376 return SourceLocation();
1379 if (Line > Content->NumLines) {
1380 unsigned Size = Content->getBuffer(Diag, *this)->getBufferSize();
1383 return getLocForStartOfFile(FirstFID).getFileLocWithOffset(Size);
1386 unsigned FilePos = Content->SourceLineCache[Line - 1];
1387 const char *Buf = Content->getBuffer(Diag, *this)->getBufferStart() + FilePos;
1388 unsigned BufLength = Content->getBuffer(Diag, *this)->getBufferEnd() - Buf;
1391 // Check that the given column is valid.
1392 while (i < BufLength-1 && i < Col-1 && Buf[i] != '\n' && Buf[i] != '\r')
1395 return getLocForStartOfFile(FirstFID).getFileLocWithOffset(FilePos + i);
1397 return getLocForStartOfFile(FirstFID).getFileLocWithOffset(FilePos + Col - 1);
1400 /// Given a decomposed source location, move it up the include/instantiation
1401 /// stack to the parent source location. If this is possible, return the
1402 /// decomposed version of the parent in Loc and return false. If Loc is the
1403 /// top-level entry, return true and don't modify it.
1404 static bool MoveUpIncludeHierarchy(std::pair<FileID, unsigned> &Loc,
1405 const SourceManager &SM) {
1406 SourceLocation UpperLoc;
1407 const SrcMgr::SLocEntry &Entry = SM.getSLocEntry(Loc.first);
1408 if (Entry.isInstantiation())
1409 UpperLoc = Entry.getInstantiation().getInstantiationLocStart();
1411 UpperLoc = Entry.getFile().getIncludeLoc();
1413 if (UpperLoc.isInvalid())
1414 return true; // We reached the top.
1416 Loc = SM.getDecomposedLoc(UpperLoc);
1421 /// \brief Determines the order of 2 source locations in the translation unit.
1423 /// \returns true if LHS source location comes before RHS, false otherwise.
1424 bool SourceManager::isBeforeInTranslationUnit(SourceLocation LHS,
1425 SourceLocation RHS) const {
1426 assert(LHS.isValid() && RHS.isValid() && "Passed invalid source location!");
1430 // If both locations are macro instantiations, the order of their offsets
1431 // reflect the order that the tokens, pointed to by these locations, were
1432 // instantiated (during parsing each token that is instantiated by a macro,
1433 // expands the SLocEntries).
1435 std::pair<FileID, unsigned> LOffs = getDecomposedLoc(LHS);
1436 std::pair<FileID, unsigned> ROffs = getDecomposedLoc(RHS);
1438 // If the source locations are in the same file, just compare offsets.
1439 if (LOffs.first == ROffs.first)
1440 return LOffs.second < ROffs.second;
1442 // If we are comparing a source location with multiple locations in the same
1443 // file, we get a big win by caching the result.
1444 if (IsBeforeInTUCache.isCacheValid(LOffs.first, ROffs.first))
1445 return IsBeforeInTUCache.getCachedResult(LOffs.second, ROffs.second);
1447 // Okay, we missed in the cache, start updating the cache for this query.
1448 IsBeforeInTUCache.setQueryFIDs(LOffs.first, ROffs.first);
1450 // "Traverse" the include/instantiation stacks of both locations and try to
1451 // find a common "ancestor". FileIDs build a tree-like structure that
1452 // reflects the #include hierarchy, and this algorithm needs to find the
1453 // nearest common ancestor between the two locations. For example, if you
1454 // have a.c that includes b.h and c.h, and are comparing a location in b.h to
1455 // a location in c.h, we need to find that their nearest common ancestor is
1456 // a.c, and compare the locations of the two #includes to find their relative
1459 // SourceManager assigns FileIDs in order of parsing. This means that an
1460 // includee always has a larger FileID than an includer. While you might
1461 // think that we could just compare the FileID's here, that doesn't work to
1462 // compare a point at the end of a.c with a point within c.h. Though c.h has
1463 // a larger FileID, we have to compare the include point of c.h to the
1466 // Despite not being able to directly compare FileID's, we can tell that a
1467 // larger FileID is necessarily more deeply nested than a lower one and use
1468 // this information to walk up the tree to the nearest common ancestor.
1470 // If LOffs is larger than ROffs, then LOffs must be more deeply nested than
1471 // ROffs, walk up the #include chain.
1472 if (LOffs.first.ID > ROffs.first.ID) {
1473 if (MoveUpIncludeHierarchy(LOffs, *this))
1474 break; // We reached the top.
1477 // Otherwise, ROffs is larger than LOffs, so ROffs must be more deeply
1478 // nested than LOffs, walk up the #include chain.
1479 if (MoveUpIncludeHierarchy(ROffs, *this))
1480 break; // We reached the top.
1482 } while (LOffs.first != ROffs.first);
1484 // If we exited because we found a nearest common ancestor, compare the
1485 // locations within the common file and cache them.
1486 if (LOffs.first == ROffs.first) {
1487 IsBeforeInTUCache.setCommonLoc(LOffs.first, LOffs.second, ROffs.second);
1488 return IsBeforeInTUCache.getCachedResult(LOffs.second, ROffs.second);
1491 // There is no common ancestor, most probably because one location is in the
1492 // predefines buffer or an AST file.
1493 // FIXME: We should rearrange the external interface so this simply never
1494 // happens; it can't conceptually happen. Also see PR5662.
1495 IsBeforeInTUCache.setQueryFIDs(FileID(), FileID()); // Don't try caching.
1497 // Zip both entries up to the top level record.
1498 while (!MoveUpIncludeHierarchy(LOffs, *this)) /*empty*/;
1499 while (!MoveUpIncludeHierarchy(ROffs, *this)) /*empty*/;
1501 // If exactly one location is a memory buffer, assume it precedes the other.
1503 // Strip off macro instantation locations, going up to the top-level File
1505 bool LIsMB = getFileEntryForID(LOffs.first) == 0;
1506 bool RIsMB = getFileEntryForID(ROffs.first) == 0;
1510 // Otherwise, just assume FileIDs were created in order.
1511 return LOffs.first < ROffs.first;
1514 /// PrintStats - Print statistics to stderr.
1516 void SourceManager::PrintStats() const {
1517 llvm::errs() << "\n*** Source Manager Stats:\n";
1518 llvm::errs() << FileInfos.size() << " files mapped, " << MemBufferInfos.size()
1519 << " mem buffers mapped.\n";
1520 llvm::errs() << SLocEntryTable.size() << " SLocEntry's allocated ("
1521 << SLocEntryTable.capacity()*sizeof(SrcMgr::SLocEntry)
1522 << " bytes of capacity), "
1523 << NextOffset << "B of Sloc address space used.\n";
1525 unsigned NumLineNumsComputed = 0;
1526 unsigned NumFileBytesMapped = 0;
1527 for (fileinfo_iterator I = fileinfo_begin(), E = fileinfo_end(); I != E; ++I){
1528 NumLineNumsComputed += I->second->SourceLineCache != 0;
1529 NumFileBytesMapped += I->second->getSizeBytesMapped();
1532 llvm::errs() << NumFileBytesMapped << " bytes of files mapped, "
1533 << NumLineNumsComputed << " files with line #'s computed.\n";
1534 llvm::errs() << "FileID scans: " << NumLinearScans << " linear, "
1535 << NumBinaryProbes << " binary.\n";
1538 ExternalSLocEntrySource::~ExternalSLocEntrySource() { }
1540 /// Return the amount of memory used by memory buffers, breaking down
1541 /// by heap-backed versus mmap'ed memory.
1542 SourceManager::MemoryBufferSizes SourceManager::getMemoryBufferSizes() const {
1543 size_t malloc_bytes = 0;
1544 size_t mmap_bytes = 0;
1546 for (unsigned i = 0, e = MemBufferInfos.size(); i != e; ++i)
1547 if (size_t sized_mapped = MemBufferInfos[i]->getSizeBytesMapped())
1548 switch (MemBufferInfos[i]->getMemoryBufferKind()) {
1549 case llvm::MemoryBuffer::MemoryBuffer_MMap:
1550 mmap_bytes += sized_mapped;
1552 case llvm::MemoryBuffer::MemoryBuffer_Malloc:
1553 malloc_bytes += sized_mapped;
1557 return MemoryBufferSizes(malloc_bytes, mmap_bytes);