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/Diagnostic.h"
16 #include "clang/Basic/FileManager.h"
17 #include "clang/Basic/SourceManagerInternals.h"
18 #include "llvm/ADT/Optional.h"
19 #include "llvm/ADT/STLExtras.h"
20 #include "llvm/ADT/StringSwitch.h"
21 #include "llvm/Support/Capacity.h"
22 #include "llvm/Support/Compiler.h"
23 #include "llvm/Support/MemoryBuffer.h"
24 #include "llvm/Support/Path.h"
25 #include "llvm/Support/raw_ostream.h"
31 using namespace clang;
32 using namespace SrcMgr;
33 using llvm::MemoryBuffer;
35 //===----------------------------------------------------------------------===//
36 // SourceManager Helper Classes
37 //===----------------------------------------------------------------------===//
39 ContentCache::~ContentCache() {
40 if (shouldFreeBuffer())
41 delete Buffer.getPointer();
44 /// getSizeBytesMapped - Returns the number of bytes actually mapped for this
45 /// ContentCache. This can be 0 if the MemBuffer was not actually expanded.
46 unsigned ContentCache::getSizeBytesMapped() const {
47 return Buffer.getPointer() ? Buffer.getPointer()->getBufferSize() : 0;
50 /// Returns the kind of memory used to back the memory buffer for
51 /// this content cache. This is used for performance analysis.
52 llvm::MemoryBuffer::BufferKind ContentCache::getMemoryBufferKind() const {
53 assert(Buffer.getPointer());
55 // Should be unreachable, but keep for sanity.
56 if (!Buffer.getPointer())
57 return llvm::MemoryBuffer::MemoryBuffer_Malloc;
59 const llvm::MemoryBuffer *buf = Buffer.getPointer();
60 return buf->getBufferKind();
63 /// getSize - Returns the size of the content encapsulated by this ContentCache.
64 /// This can be the size of the source file or the size of an arbitrary
65 /// scratch buffer. If the ContentCache encapsulates a source file, that
66 /// file is not lazily brought in from disk to satisfy this query.
67 unsigned ContentCache::getSize() const {
68 return Buffer.getPointer() ? (unsigned) Buffer.getPointer()->getBufferSize()
69 : (unsigned) ContentsEntry->getSize();
72 void ContentCache::replaceBuffer(const llvm::MemoryBuffer *B,
74 if (B && B == Buffer.getPointer()) {
75 assert(0 && "Replacing with the same buffer");
76 Buffer.setInt(DoNotFree? DoNotFreeFlag : 0);
80 if (shouldFreeBuffer())
81 delete Buffer.getPointer();
83 Buffer.setInt(DoNotFree? DoNotFreeFlag : 0);
86 const llvm::MemoryBuffer *ContentCache::getBuffer(DiagnosticsEngine &Diag,
87 const SourceManager &SM,
89 bool *Invalid) const {
90 // Lazily create the Buffer for ContentCaches that wrap files. If we already
91 // computed it, just return what we have.
92 if (Buffer.getPointer() || ContentsEntry == 0) {
94 *Invalid = isBufferInvalid();
96 return Buffer.getPointer();
100 bool isVolatile = SM.userFilesAreVolatile() && !IsSystemFile;
101 Buffer.setPointer(SM.getFileManager().getBufferForFile(ContentsEntry,
105 // If we were unable to open the file, then we are in an inconsistent
106 // situation where the content cache referenced a file which no longer
107 // exists. Most likely, we were using a stat cache with an invalid entry but
108 // the file could also have been removed during processing. Since we can't
109 // really deal with this situation, just create an empty buffer.
111 // FIXME: This is definitely not ideal, but our immediate clients can't
112 // currently handle returning a null entry here. Ideally we should detect
113 // that we are in an inconsistent situation and error out as quickly as
115 if (!Buffer.getPointer()) {
116 const StringRef FillStr("<<<MISSING SOURCE FILE>>>\n");
117 Buffer.setPointer(MemoryBuffer::getNewMemBuffer(ContentsEntry->getSize(),
119 char *Ptr = const_cast<char*>(Buffer.getPointer()->getBufferStart());
120 for (unsigned i = 0, e = ContentsEntry->getSize(); i != e; ++i)
121 Ptr[i] = FillStr[i % FillStr.size()];
123 if (Diag.isDiagnosticInFlight())
124 Diag.SetDelayedDiagnostic(diag::err_cannot_open_file,
125 ContentsEntry->getName(), ErrorStr);
127 Diag.Report(Loc, diag::err_cannot_open_file)
128 << ContentsEntry->getName() << ErrorStr;
130 Buffer.setInt(Buffer.getInt() | InvalidFlag);
132 if (Invalid) *Invalid = true;
133 return Buffer.getPointer();
136 // Check that the file's size is the same as in the file entry (which may
137 // have come from a stat cache).
138 if (getRawBuffer()->getBufferSize() != (size_t)ContentsEntry->getSize()) {
139 if (Diag.isDiagnosticInFlight())
140 Diag.SetDelayedDiagnostic(diag::err_file_modified,
141 ContentsEntry->getName());
143 Diag.Report(Loc, diag::err_file_modified)
144 << ContentsEntry->getName();
146 Buffer.setInt(Buffer.getInt() | InvalidFlag);
147 if (Invalid) *Invalid = true;
148 return Buffer.getPointer();
151 // If the buffer is valid, check to see if it has a UTF Byte Order Mark
152 // (BOM). We only support UTF-8 with and without a BOM right now. See
153 // http://en.wikipedia.org/wiki/Byte_order_mark for more information.
154 StringRef BufStr = Buffer.getPointer()->getBuffer();
155 const char *InvalidBOM = llvm::StringSwitch<const char *>(BufStr)
156 .StartsWith("\xFE\xFF", "UTF-16 (BE)")
157 .StartsWith("\xFF\xFE", "UTF-16 (LE)")
158 .StartsWith("\x00\x00\xFE\xFF", "UTF-32 (BE)")
159 .StartsWith("\xFF\xFE\x00\x00", "UTF-32 (LE)")
160 .StartsWith("\x2B\x2F\x76", "UTF-7")
161 .StartsWith("\xF7\x64\x4C", "UTF-1")
162 .StartsWith("\xDD\x73\x66\x73", "UTF-EBCDIC")
163 .StartsWith("\x0E\xFE\xFF", "SDSU")
164 .StartsWith("\xFB\xEE\x28", "BOCU-1")
165 .StartsWith("\x84\x31\x95\x33", "GB-18030")
169 Diag.Report(Loc, diag::err_unsupported_bom)
170 << InvalidBOM << ContentsEntry->getName();
171 Buffer.setInt(Buffer.getInt() | InvalidFlag);
175 *Invalid = isBufferInvalid();
177 return Buffer.getPointer();
180 unsigned LineTableInfo::getLineTableFilenameID(StringRef Name) {
181 // Look up the filename in the string table, returning the pre-existing value
183 llvm::StringMapEntry<unsigned> &Entry =
184 FilenameIDs.GetOrCreateValue(Name, ~0U);
185 if (Entry.getValue() != ~0U)
186 return Entry.getValue();
188 // Otherwise, assign this the next available ID.
189 Entry.setValue(FilenamesByID.size());
190 FilenamesByID.push_back(&Entry);
191 return FilenamesByID.size()-1;
194 /// AddLineNote - Add a line note to the line table that indicates that there
195 /// is a \#line at the specified FID/Offset location which changes the presumed
196 /// location to LineNo/FilenameID.
197 void LineTableInfo::AddLineNote(FileID FID, unsigned Offset,
198 unsigned LineNo, int FilenameID) {
199 std::vector<LineEntry> &Entries = LineEntries[FID];
201 assert((Entries.empty() || Entries.back().FileOffset < Offset) &&
202 "Adding line entries out of order!");
204 SrcMgr::CharacteristicKind Kind = SrcMgr::C_User;
205 unsigned IncludeOffset = 0;
207 if (!Entries.empty()) {
208 // If this is a '#line 4' after '#line 42 "foo.h"', make sure to remember
209 // that we are still in "foo.h".
210 if (FilenameID == -1)
211 FilenameID = Entries.back().FilenameID;
213 // If we are after a line marker that switched us to system header mode, or
214 // that set #include information, preserve it.
215 Kind = Entries.back().FileKind;
216 IncludeOffset = Entries.back().IncludeOffset;
219 Entries.push_back(LineEntry::get(Offset, LineNo, FilenameID, Kind,
223 /// AddLineNote This is the same as the previous version of AddLineNote, but is
224 /// used for GNU line markers. If EntryExit is 0, then this doesn't change the
225 /// presumed \#include stack. If it is 1, this is a file entry, if it is 2 then
226 /// this is a file exit. FileKind specifies whether this is a system header or
227 /// extern C system header.
228 void LineTableInfo::AddLineNote(FileID FID, unsigned Offset,
229 unsigned LineNo, int FilenameID,
231 SrcMgr::CharacteristicKind FileKind) {
232 assert(FilenameID != -1 && "Unspecified filename should use other accessor");
234 std::vector<LineEntry> &Entries = LineEntries[FID];
236 assert((Entries.empty() || Entries.back().FileOffset < Offset) &&
237 "Adding line entries out of order!");
239 unsigned IncludeOffset = 0;
240 if (EntryExit == 0) { // No #include stack change.
241 IncludeOffset = Entries.empty() ? 0 : Entries.back().IncludeOffset;
242 } else if (EntryExit == 1) {
243 IncludeOffset = Offset-1;
244 } else if (EntryExit == 2) {
245 assert(!Entries.empty() && Entries.back().IncludeOffset &&
246 "PPDirectives should have caught case when popping empty include stack");
248 // Get the include loc of the last entries' include loc as our include loc.
250 if (const LineEntry *PrevEntry =
251 FindNearestLineEntry(FID, Entries.back().IncludeOffset))
252 IncludeOffset = PrevEntry->IncludeOffset;
255 Entries.push_back(LineEntry::get(Offset, LineNo, FilenameID, FileKind,
260 /// FindNearestLineEntry - Find the line entry nearest to FID that is before
261 /// it. If there is no line entry before Offset in FID, return null.
262 const LineEntry *LineTableInfo::FindNearestLineEntry(FileID FID,
264 const std::vector<LineEntry> &Entries = LineEntries[FID];
265 assert(!Entries.empty() && "No #line entries for this FID after all!");
267 // It is very common for the query to be after the last #line, check this
269 if (Entries.back().FileOffset <= Offset)
270 return &Entries.back();
272 // Do a binary search to find the maximal element that is still before Offset.
273 std::vector<LineEntry>::const_iterator I =
274 std::upper_bound(Entries.begin(), Entries.end(), Offset);
275 if (I == Entries.begin()) return 0;
279 /// \brief Add a new line entry that has already been encoded into
280 /// the internal representation of the line table.
281 void LineTableInfo::AddEntry(FileID FID,
282 const std::vector<LineEntry> &Entries) {
283 LineEntries[FID] = Entries;
286 /// getLineTableFilenameID - Return the uniqued ID for the specified filename.
288 unsigned SourceManager::getLineTableFilenameID(StringRef Name) {
290 LineTable = new LineTableInfo();
291 return LineTable->getLineTableFilenameID(Name);
295 /// AddLineNote - Add a line note to the line table for the FileID and offset
296 /// specified by Loc. If FilenameID is -1, it is considered to be
298 void SourceManager::AddLineNote(SourceLocation Loc, unsigned LineNo,
300 std::pair<FileID, unsigned> LocInfo = getDecomposedExpansionLoc(Loc);
302 bool Invalid = false;
303 const SLocEntry &Entry = getSLocEntry(LocInfo.first, &Invalid);
304 if (!Entry.isFile() || Invalid)
307 const SrcMgr::FileInfo &FileInfo = Entry.getFile();
309 // Remember that this file has #line directives now if it doesn't already.
310 const_cast<SrcMgr::FileInfo&>(FileInfo).setHasLineDirectives();
313 LineTable = new LineTableInfo();
314 LineTable->AddLineNote(LocInfo.first, LocInfo.second, LineNo, FilenameID);
317 /// AddLineNote - Add a GNU line marker to the line table.
318 void SourceManager::AddLineNote(SourceLocation Loc, unsigned LineNo,
319 int FilenameID, bool IsFileEntry,
320 bool IsFileExit, bool IsSystemHeader,
321 bool IsExternCHeader) {
322 // If there is no filename and no flags, this is treated just like a #line,
323 // which does not change the flags of the previous line marker.
324 if (FilenameID == -1) {
325 assert(!IsFileEntry && !IsFileExit && !IsSystemHeader && !IsExternCHeader &&
326 "Can't set flags without setting the filename!");
327 return AddLineNote(Loc, LineNo, FilenameID);
330 std::pair<FileID, unsigned> LocInfo = getDecomposedExpansionLoc(Loc);
332 bool Invalid = false;
333 const SLocEntry &Entry = getSLocEntry(LocInfo.first, &Invalid);
334 if (!Entry.isFile() || Invalid)
337 const SrcMgr::FileInfo &FileInfo = Entry.getFile();
339 // Remember that this file has #line directives now if it doesn't already.
340 const_cast<SrcMgr::FileInfo&>(FileInfo).setHasLineDirectives();
343 LineTable = new LineTableInfo();
345 SrcMgr::CharacteristicKind FileKind;
347 FileKind = SrcMgr::C_ExternCSystem;
348 else if (IsSystemHeader)
349 FileKind = SrcMgr::C_System;
351 FileKind = SrcMgr::C_User;
353 unsigned EntryExit = 0;
359 LineTable->AddLineNote(LocInfo.first, LocInfo.second, LineNo, FilenameID,
360 EntryExit, FileKind);
363 LineTableInfo &SourceManager::getLineTable() {
365 LineTable = new LineTableInfo();
369 //===----------------------------------------------------------------------===//
370 // Private 'Create' methods.
371 //===----------------------------------------------------------------------===//
373 SourceManager::SourceManager(DiagnosticsEngine &Diag, FileManager &FileMgr,
374 bool UserFilesAreVolatile)
375 : Diag(Diag), FileMgr(FileMgr), OverridenFilesKeepOriginalName(true),
376 UserFilesAreVolatile(UserFilesAreVolatile),
377 ExternalSLocEntries(0), LineTable(0), NumLinearScans(0),
378 NumBinaryProbes(0), FakeBufferForRecovery(0),
379 FakeContentCacheForRecovery(0) {
381 Diag.setSourceManager(this);
384 SourceManager::~SourceManager() {
387 // Delete FileEntry objects corresponding to content caches. Since the actual
388 // content cache objects are bump pointer allocated, we just have to run the
389 // dtors, but we call the deallocate method for completeness.
390 for (unsigned i = 0, e = MemBufferInfos.size(); i != e; ++i) {
391 if (MemBufferInfos[i]) {
392 MemBufferInfos[i]->~ContentCache();
393 ContentCacheAlloc.Deallocate(MemBufferInfos[i]);
396 for (llvm::DenseMap<const FileEntry*, SrcMgr::ContentCache*>::iterator
397 I = FileInfos.begin(), E = FileInfos.end(); I != E; ++I) {
399 I->second->~ContentCache();
400 ContentCacheAlloc.Deallocate(I->second);
404 delete FakeBufferForRecovery;
405 delete FakeContentCacheForRecovery;
407 for (llvm::DenseMap<FileID, MacroArgsMap *>::iterator
408 I = MacroArgsCacheMap.begin(),E = MacroArgsCacheMap.end(); I!=E; ++I) {
413 void SourceManager::clearIDTables() {
414 MainFileID = FileID();
415 LocalSLocEntryTable.clear();
416 LoadedSLocEntryTable.clear();
417 SLocEntryLoaded.clear();
418 LastLineNoFileIDQuery = FileID();
419 LastLineNoContentCache = 0;
420 LastFileIDLookup = FileID();
425 // Use up FileID #0 as an invalid expansion.
427 CurrentLoadedOffset = MaxLoadedOffset;
428 createExpansionLoc(SourceLocation(),SourceLocation(),SourceLocation(), 1);
431 /// getOrCreateContentCache - Create or return a cached ContentCache for the
434 SourceManager::getOrCreateContentCache(const FileEntry *FileEnt,
436 assert(FileEnt && "Didn't specify a file entry to use?");
438 // Do we already have information about this file?
439 ContentCache *&Entry = FileInfos[FileEnt];
440 if (Entry) return Entry;
442 // Nope, create a new Cache entry. Make sure it is at least 8-byte aligned
443 // so that FileInfo can use the low 3 bits of the pointer for its own
444 // nefarious purposes.
445 unsigned EntryAlign = llvm::AlignOf<ContentCache>::Alignment;
446 EntryAlign = std::max(8U, EntryAlign);
447 Entry = ContentCacheAlloc.Allocate<ContentCache>(1, EntryAlign);
449 if (OverriddenFilesInfo) {
450 // If the file contents are overridden with contents from another file,
451 // pass that file to ContentCache.
452 llvm::DenseMap<const FileEntry *, const FileEntry *>::iterator
453 overI = OverriddenFilesInfo->OverriddenFiles.find(FileEnt);
454 if (overI == OverriddenFilesInfo->OverriddenFiles.end())
455 new (Entry) ContentCache(FileEnt);
457 new (Entry) ContentCache(OverridenFilesKeepOriginalName ? FileEnt
461 new (Entry) ContentCache(FileEnt);
464 Entry->IsSystemFile = isSystemFile;
470 /// createMemBufferContentCache - Create a new ContentCache for the specified
471 /// memory buffer. This does no caching.
473 SourceManager::createMemBufferContentCache(const MemoryBuffer *Buffer) {
474 // Add a new ContentCache to the MemBufferInfos list and return it. Make sure
475 // it is at least 8-byte aligned so that FileInfo can use the low 3 bits of
476 // the pointer for its own nefarious purposes.
477 unsigned EntryAlign = llvm::AlignOf<ContentCache>::Alignment;
478 EntryAlign = std::max(8U, EntryAlign);
479 ContentCache *Entry = ContentCacheAlloc.Allocate<ContentCache>(1, EntryAlign);
480 new (Entry) ContentCache();
481 MemBufferInfos.push_back(Entry);
482 Entry->setBuffer(Buffer);
486 const SrcMgr::SLocEntry &SourceManager::loadSLocEntry(unsigned Index,
487 bool *Invalid) const {
488 assert(!SLocEntryLoaded[Index]);
489 if (ExternalSLocEntries->ReadSLocEntry(-(static_cast<int>(Index) + 2))) {
492 // If the file of the SLocEntry changed we could still have loaded it.
493 if (!SLocEntryLoaded[Index]) {
494 // Try to recover; create a SLocEntry so the rest of clang can handle it.
495 LoadedSLocEntryTable[Index] = SLocEntry::get(0,
496 FileInfo::get(SourceLocation(),
497 getFakeContentCacheForRecovery(),
502 return LoadedSLocEntryTable[Index];
505 std::pair<int, unsigned>
506 SourceManager::AllocateLoadedSLocEntries(unsigned NumSLocEntries,
507 unsigned TotalSize) {
508 assert(ExternalSLocEntries && "Don't have an external sloc source");
509 LoadedSLocEntryTable.resize(LoadedSLocEntryTable.size() + NumSLocEntries);
510 SLocEntryLoaded.resize(LoadedSLocEntryTable.size());
511 CurrentLoadedOffset -= TotalSize;
512 assert(CurrentLoadedOffset >= NextLocalOffset && "Out of source locations");
513 int ID = LoadedSLocEntryTable.size();
514 return std::make_pair(-ID - 1, CurrentLoadedOffset);
517 /// \brief As part of recovering from missing or changed content, produce a
518 /// fake, non-empty buffer.
519 const llvm::MemoryBuffer *SourceManager::getFakeBufferForRecovery() const {
520 if (!FakeBufferForRecovery)
521 FakeBufferForRecovery
522 = llvm::MemoryBuffer::getMemBuffer("<<<INVALID BUFFER>>");
524 return FakeBufferForRecovery;
527 /// \brief As part of recovering from missing or changed content, produce a
528 /// fake content cache.
529 const SrcMgr::ContentCache *
530 SourceManager::getFakeContentCacheForRecovery() const {
531 if (!FakeContentCacheForRecovery) {
532 FakeContentCacheForRecovery = new ContentCache();
533 FakeContentCacheForRecovery->replaceBuffer(getFakeBufferForRecovery(),
536 return FakeContentCacheForRecovery;
539 /// \brief Returns the previous in-order FileID or an invalid FileID if there
540 /// is no previous one.
541 FileID SourceManager::getPreviousFileID(FileID FID) const {
552 } else if (unsigned(-(ID-1) - 2) >= LoadedSLocEntryTable.size()) {
556 return FileID::get(ID-1);
559 /// \brief Returns the next in-order FileID or an invalid FileID if there is
561 FileID SourceManager::getNextFileID(FileID FID) const {
567 if (unsigned(ID+1) >= local_sloc_entry_size())
569 } else if (ID+1 >= -1) {
573 return FileID::get(ID+1);
576 //===----------------------------------------------------------------------===//
577 // Methods to create new FileID's and macro expansions.
578 //===----------------------------------------------------------------------===//
580 /// createFileID - Create a new FileID for the specified ContentCache and
581 /// include position. This works regardless of whether the ContentCache
582 /// corresponds to a file or some other input source.
583 FileID SourceManager::createFileID(const ContentCache *File,
584 SourceLocation IncludePos,
585 SrcMgr::CharacteristicKind FileCharacter,
586 int LoadedID, unsigned LoadedOffset) {
588 assert(LoadedID != -1 && "Loading sentinel FileID");
589 unsigned Index = unsigned(-LoadedID) - 2;
590 assert(Index < LoadedSLocEntryTable.size() && "FileID out of range");
591 assert(!SLocEntryLoaded[Index] && "FileID already loaded");
592 LoadedSLocEntryTable[Index] = SLocEntry::get(LoadedOffset,
593 FileInfo::get(IncludePos, File, FileCharacter));
594 SLocEntryLoaded[Index] = true;
595 return FileID::get(LoadedID);
597 LocalSLocEntryTable.push_back(SLocEntry::get(NextLocalOffset,
598 FileInfo::get(IncludePos, File,
600 unsigned FileSize = File->getSize();
601 assert(NextLocalOffset + FileSize + 1 > NextLocalOffset &&
602 NextLocalOffset + FileSize + 1 <= CurrentLoadedOffset &&
603 "Ran out of source locations!");
604 // We do a +1 here because we want a SourceLocation that means "the end of the
605 // file", e.g. for the "no newline at the end of the file" diagnostic.
606 NextLocalOffset += FileSize + 1;
608 // Set LastFileIDLookup to the newly created file. The next getFileID call is
609 // almost guaranteed to be from that file.
610 FileID FID = FileID::get(LocalSLocEntryTable.size()-1);
611 return LastFileIDLookup = FID;
615 SourceManager::createMacroArgExpansionLoc(SourceLocation SpellingLoc,
616 SourceLocation ExpansionLoc,
617 unsigned TokLength) {
618 ExpansionInfo Info = ExpansionInfo::createForMacroArg(SpellingLoc,
620 return createExpansionLocImpl(Info, TokLength);
624 SourceManager::createExpansionLoc(SourceLocation SpellingLoc,
625 SourceLocation ExpansionLocStart,
626 SourceLocation ExpansionLocEnd,
629 unsigned LoadedOffset) {
630 ExpansionInfo Info = ExpansionInfo::create(SpellingLoc, ExpansionLocStart,
632 return createExpansionLocImpl(Info, TokLength, LoadedID, LoadedOffset);
636 SourceManager::createExpansionLocImpl(const ExpansionInfo &Info,
639 unsigned LoadedOffset) {
641 assert(LoadedID != -1 && "Loading sentinel FileID");
642 unsigned Index = unsigned(-LoadedID) - 2;
643 assert(Index < LoadedSLocEntryTable.size() && "FileID out of range");
644 assert(!SLocEntryLoaded[Index] && "FileID already loaded");
645 LoadedSLocEntryTable[Index] = SLocEntry::get(LoadedOffset, Info);
646 SLocEntryLoaded[Index] = true;
647 return SourceLocation::getMacroLoc(LoadedOffset);
649 LocalSLocEntryTable.push_back(SLocEntry::get(NextLocalOffset, Info));
650 assert(NextLocalOffset + TokLength + 1 > NextLocalOffset &&
651 NextLocalOffset + TokLength + 1 <= CurrentLoadedOffset &&
652 "Ran out of source locations!");
653 // See createFileID for that +1.
654 NextLocalOffset += TokLength + 1;
655 return SourceLocation::getMacroLoc(NextLocalOffset - (TokLength + 1));
658 const llvm::MemoryBuffer *
659 SourceManager::getMemoryBufferForFile(const FileEntry *File,
661 const SrcMgr::ContentCache *IR = getOrCreateContentCache(File);
662 assert(IR && "getOrCreateContentCache() cannot return NULL");
663 return IR->getBuffer(Diag, *this, SourceLocation(), Invalid);
666 void SourceManager::overrideFileContents(const FileEntry *SourceFile,
667 const llvm::MemoryBuffer *Buffer,
669 const SrcMgr::ContentCache *IR = getOrCreateContentCache(SourceFile);
670 assert(IR && "getOrCreateContentCache() cannot return NULL");
672 const_cast<SrcMgr::ContentCache *>(IR)->replaceBuffer(Buffer, DoNotFree);
673 const_cast<SrcMgr::ContentCache *>(IR)->BufferOverridden = true;
675 getOverriddenFilesInfo().OverriddenFilesWithBuffer.insert(SourceFile);
678 void SourceManager::overrideFileContents(const FileEntry *SourceFile,
679 const FileEntry *NewFile) {
680 assert(SourceFile->getSize() == NewFile->getSize() &&
681 "Different sizes, use the FileManager to create a virtual file with "
683 assert(FileInfos.count(SourceFile) == 0 &&
684 "This function should be called at the initialization stage, before "
685 "any parsing occurs.");
686 getOverriddenFilesInfo().OverriddenFiles[SourceFile] = NewFile;
689 void SourceManager::disableFileContentsOverride(const FileEntry *File) {
690 if (!isFileOverridden(File))
693 const SrcMgr::ContentCache *IR = getOrCreateContentCache(File);
694 const_cast<SrcMgr::ContentCache *>(IR)->replaceBuffer(0);
695 const_cast<SrcMgr::ContentCache *>(IR)->ContentsEntry = IR->OrigEntry;
697 assert(OverriddenFilesInfo);
698 OverriddenFilesInfo->OverriddenFiles.erase(File);
699 OverriddenFilesInfo->OverriddenFilesWithBuffer.erase(File);
702 StringRef SourceManager::getBufferData(FileID FID, bool *Invalid) const {
703 bool MyInvalid = false;
704 const SLocEntry &SLoc = getSLocEntry(FID, &MyInvalid);
705 if (!SLoc.isFile() || MyInvalid) {
708 return "<<<<<INVALID SOURCE LOCATION>>>>>";
711 const llvm::MemoryBuffer *Buf
712 = SLoc.getFile().getContentCache()->getBuffer(Diag, *this, SourceLocation(),
715 *Invalid = MyInvalid;
718 return "<<<<<INVALID SOURCE LOCATION>>>>>";
720 return Buf->getBuffer();
723 //===----------------------------------------------------------------------===//
724 // SourceLocation manipulation methods.
725 //===----------------------------------------------------------------------===//
727 /// \brief Return the FileID for a SourceLocation.
729 /// This is the cache-miss path of getFileID. Not as hot as that function, but
730 /// still very important. It is responsible for finding the entry in the
731 /// SLocEntry tables that contains the specified location.
732 FileID SourceManager::getFileIDSlow(unsigned SLocOffset) const {
734 return FileID::get(0);
736 // Now it is time to search for the correct file. See where the SLocOffset
737 // sits in the global view and consult local or loaded buffers for it.
738 if (SLocOffset < NextLocalOffset)
739 return getFileIDLocal(SLocOffset);
740 return getFileIDLoaded(SLocOffset);
743 /// \brief Return the FileID for a SourceLocation with a low offset.
745 /// This function knows that the SourceLocation is in a local buffer, not a
747 FileID SourceManager::getFileIDLocal(unsigned SLocOffset) const {
748 assert(SLocOffset < NextLocalOffset && "Bad function choice");
750 // After the first and second level caches, I see two common sorts of
751 // behavior: 1) a lot of searched FileID's are "near" the cached file
752 // location or are "near" the cached expansion location. 2) others are just
753 // completely random and may be a very long way away.
755 // To handle this, we do a linear search for up to 8 steps to catch #1 quickly
756 // then we fall back to a less cache efficient, but more scalable, binary
757 // search to find the location.
759 // See if this is near the file point - worst case we start scanning from the
760 // most newly created FileID.
761 const SrcMgr::SLocEntry *I;
763 if (LastFileIDLookup.ID < 0 ||
764 LocalSLocEntryTable[LastFileIDLookup.ID].getOffset() < SLocOffset) {
765 // Neither loc prunes our search.
766 I = LocalSLocEntryTable.end();
768 // Perhaps it is near the file point.
769 I = LocalSLocEntryTable.begin()+LastFileIDLookup.ID;
772 // Find the FileID that contains this. "I" is an iterator that points to a
773 // FileID whose offset is known to be larger than SLocOffset.
774 unsigned NumProbes = 0;
777 if (I->getOffset() <= SLocOffset) {
778 FileID Res = FileID::get(int(I - LocalSLocEntryTable.begin()));
780 // If this isn't an expansion, remember it. We have good locality across
782 if (!I->isExpansion())
783 LastFileIDLookup = Res;
784 NumLinearScans += NumProbes+1;
787 if (++NumProbes == 8)
791 // Convert "I" back into an index. We know that it is an entry whose index is
792 // larger than the offset we are looking for.
793 unsigned GreaterIndex = I - LocalSLocEntryTable.begin();
794 // LessIndex - This is the lower bound of the range that we're searching.
795 // We know that the offset corresponding to the FileID is is less than
797 unsigned LessIndex = 0;
800 bool Invalid = false;
801 unsigned MiddleIndex = (GreaterIndex-LessIndex)/2+LessIndex;
802 unsigned MidOffset = getLocalSLocEntry(MiddleIndex, &Invalid).getOffset();
804 return FileID::get(0);
808 // If the offset of the midpoint is too large, chop the high side of the
809 // range to the midpoint.
810 if (MidOffset > SLocOffset) {
811 GreaterIndex = MiddleIndex;
815 // If the middle index contains the value, succeed and return.
816 // FIXME: This could be made faster by using a function that's aware of
817 // being in the local area.
818 if (isOffsetInFileID(FileID::get(MiddleIndex), SLocOffset)) {
819 FileID Res = FileID::get(MiddleIndex);
821 // If this isn't a macro expansion, remember it. We have good locality
822 // across FileID lookups.
823 if (!LocalSLocEntryTable[MiddleIndex].isExpansion())
824 LastFileIDLookup = Res;
825 NumBinaryProbes += NumProbes;
829 // Otherwise, move the low-side up to the middle index.
830 LessIndex = MiddleIndex;
834 /// \brief Return the FileID for a SourceLocation with a high offset.
836 /// This function knows that the SourceLocation is in a loaded buffer, not a
838 FileID SourceManager::getFileIDLoaded(unsigned SLocOffset) const {
839 // Sanity checking, otherwise a bug may lead to hanging in release build.
840 if (SLocOffset < CurrentLoadedOffset) {
841 assert(0 && "Invalid SLocOffset or bad function choice");
845 // Essentially the same as the local case, but the loaded array is sorted
846 // in the other direction.
848 // First do a linear scan from the last lookup position, if possible.
850 int LastID = LastFileIDLookup.ID;
851 if (LastID >= 0 || getLoadedSLocEntryByID(LastID).getOffset() < SLocOffset)
854 I = (-LastID - 2) + 1;
857 for (NumProbes = 0; NumProbes < 8; ++NumProbes, ++I) {
858 // Make sure the entry is loaded!
859 const SrcMgr::SLocEntry &E = getLoadedSLocEntry(I);
860 if (E.getOffset() <= SLocOffset) {
861 FileID Res = FileID::get(-int(I) - 2);
863 if (!E.isExpansion())
864 LastFileIDLookup = Res;
865 NumLinearScans += NumProbes + 1;
870 // Linear scan failed. Do the binary search. Note the reverse sorting of the
871 // table: GreaterIndex is the one where the offset is greater, which is
872 // actually a lower index!
873 unsigned GreaterIndex = I;
874 unsigned LessIndex = LoadedSLocEntryTable.size();
878 unsigned MiddleIndex = (LessIndex - GreaterIndex) / 2 + GreaterIndex;
879 const SrcMgr::SLocEntry &E = getLoadedSLocEntry(MiddleIndex);
880 if (E.getOffset() == 0)
881 return FileID(); // invalid entry.
885 if (E.getOffset() > SLocOffset) {
886 // Sanity checking, otherwise a bug may lead to hanging in release build.
887 if (GreaterIndex == MiddleIndex) {
888 assert(0 && "binary search missed the entry");
891 GreaterIndex = MiddleIndex;
895 if (isOffsetInFileID(FileID::get(-int(MiddleIndex) - 2), SLocOffset)) {
896 FileID Res = FileID::get(-int(MiddleIndex) - 2);
897 if (!E.isExpansion())
898 LastFileIDLookup = Res;
899 NumBinaryProbes += NumProbes;
903 // Sanity checking, otherwise a bug may lead to hanging in release build.
904 if (LessIndex == MiddleIndex) {
905 assert(0 && "binary search missed the entry");
908 LessIndex = MiddleIndex;
912 SourceLocation SourceManager::
913 getExpansionLocSlowCase(SourceLocation Loc) const {
915 // Note: If Loc indicates an offset into a token that came from a macro
916 // expansion (e.g. the 5th character of the token) we do not want to add
917 // this offset when going to the expansion location. The expansion
918 // location is the macro invocation, which the offset has nothing to do
919 // with. This is unlike when we get the spelling loc, because the offset
920 // directly correspond to the token whose spelling we're inspecting.
921 Loc = getSLocEntry(getFileID(Loc)).getExpansion().getExpansionLocStart();
922 } while (!Loc.isFileID());
927 SourceLocation SourceManager::getSpellingLocSlowCase(SourceLocation Loc) const {
929 std::pair<FileID, unsigned> LocInfo = getDecomposedLoc(Loc);
930 Loc = getSLocEntry(LocInfo.first).getExpansion().getSpellingLoc();
931 Loc = Loc.getLocWithOffset(LocInfo.second);
932 } while (!Loc.isFileID());
936 SourceLocation SourceManager::getFileLocSlowCase(SourceLocation Loc) const {
938 if (isMacroArgExpansion(Loc))
939 Loc = getImmediateSpellingLoc(Loc);
941 Loc = getImmediateExpansionRange(Loc).first;
942 } while (!Loc.isFileID());
947 std::pair<FileID, unsigned>
948 SourceManager::getDecomposedExpansionLocSlowCase(
949 const SrcMgr::SLocEntry *E) const {
950 // If this is an expansion record, walk through all the expansion points.
955 Loc = E->getExpansion().getExpansionLocStart();
957 FID = getFileID(Loc);
958 E = &getSLocEntry(FID);
959 Offset = Loc.getOffset()-E->getOffset();
960 } while (!Loc.isFileID());
962 return std::make_pair(FID, Offset);
965 std::pair<FileID, unsigned>
966 SourceManager::getDecomposedSpellingLocSlowCase(const SrcMgr::SLocEntry *E,
967 unsigned Offset) const {
968 // If this is an expansion record, walk through all the expansion points.
972 Loc = E->getExpansion().getSpellingLoc();
973 Loc = Loc.getLocWithOffset(Offset);
975 FID = getFileID(Loc);
976 E = &getSLocEntry(FID);
977 Offset = Loc.getOffset()-E->getOffset();
978 } while (!Loc.isFileID());
980 return std::make_pair(FID, Offset);
983 /// getImmediateSpellingLoc - Given a SourceLocation object, return the
984 /// spelling location referenced by the ID. This is the first level down
985 /// towards the place where the characters that make up the lexed token can be
986 /// found. This should not generally be used by clients.
987 SourceLocation SourceManager::getImmediateSpellingLoc(SourceLocation Loc) const{
988 if (Loc.isFileID()) return Loc;
989 std::pair<FileID, unsigned> LocInfo = getDecomposedLoc(Loc);
990 Loc = getSLocEntry(LocInfo.first).getExpansion().getSpellingLoc();
991 return Loc.getLocWithOffset(LocInfo.second);
995 /// getImmediateExpansionRange - Loc is required to be an expansion location.
996 /// Return the start/end of the expansion information.
997 std::pair<SourceLocation,SourceLocation>
998 SourceManager::getImmediateExpansionRange(SourceLocation Loc) const {
999 assert(Loc.isMacroID() && "Not a macro expansion loc!");
1000 const ExpansionInfo &Expansion = getSLocEntry(getFileID(Loc)).getExpansion();
1001 return Expansion.getExpansionLocRange();
1004 /// getExpansionRange - Given a SourceLocation object, return the range of
1005 /// tokens covered by the expansion in the ultimate file.
1006 std::pair<SourceLocation,SourceLocation>
1007 SourceManager::getExpansionRange(SourceLocation Loc) const {
1008 if (Loc.isFileID()) return std::make_pair(Loc, Loc);
1010 std::pair<SourceLocation,SourceLocation> Res =
1011 getImmediateExpansionRange(Loc);
1013 // Fully resolve the start and end locations to their ultimate expansion
1015 while (!Res.first.isFileID())
1016 Res.first = getImmediateExpansionRange(Res.first).first;
1017 while (!Res.second.isFileID())
1018 Res.second = getImmediateExpansionRange(Res.second).second;
1022 bool SourceManager::isMacroArgExpansion(SourceLocation Loc) const {
1023 if (!Loc.isMacroID()) return false;
1025 FileID FID = getFileID(Loc);
1026 const SrcMgr::ExpansionInfo &Expansion = getSLocEntry(FID).getExpansion();
1027 return Expansion.isMacroArgExpansion();
1030 bool SourceManager::isMacroBodyExpansion(SourceLocation Loc) const {
1031 if (!Loc.isMacroID()) return false;
1033 FileID FID = getFileID(Loc);
1034 const SrcMgr::ExpansionInfo &Expansion = getSLocEntry(FID).getExpansion();
1035 return Expansion.isMacroBodyExpansion();
1038 bool SourceManager::isAtStartOfImmediateMacroExpansion(SourceLocation Loc,
1039 SourceLocation *MacroBegin) const {
1040 assert(Loc.isValid() && Loc.isMacroID() && "Expected a valid macro loc");
1042 std::pair<FileID, unsigned> DecompLoc = getDecomposedLoc(Loc);
1043 if (DecompLoc.second > 0)
1044 return false; // Does not point at the start of expansion range.
1046 bool Invalid = false;
1047 const SrcMgr::ExpansionInfo &ExpInfo =
1048 getSLocEntry(DecompLoc.first, &Invalid).getExpansion();
1051 SourceLocation ExpLoc = ExpInfo.getExpansionLocStart();
1053 if (ExpInfo.isMacroArgExpansion()) {
1054 // For macro argument expansions, check if the previous FileID is part of
1055 // the same argument expansion, in which case this Loc is not at the
1056 // beginning of the expansion.
1057 FileID PrevFID = getPreviousFileID(DecompLoc.first);
1058 if (!PrevFID.isInvalid()) {
1059 const SrcMgr::SLocEntry &PrevEntry = getSLocEntry(PrevFID, &Invalid);
1062 if (PrevEntry.isExpansion() &&
1063 PrevEntry.getExpansion().getExpansionLocStart() == ExpLoc)
1069 *MacroBegin = ExpLoc;
1073 bool SourceManager::isAtEndOfImmediateMacroExpansion(SourceLocation Loc,
1074 SourceLocation *MacroEnd) const {
1075 assert(Loc.isValid() && Loc.isMacroID() && "Expected a valid macro loc");
1077 FileID FID = getFileID(Loc);
1078 SourceLocation NextLoc = Loc.getLocWithOffset(1);
1079 if (isInFileID(NextLoc, FID))
1080 return false; // Does not point at the end of expansion range.
1082 bool Invalid = false;
1083 const SrcMgr::ExpansionInfo &ExpInfo =
1084 getSLocEntry(FID, &Invalid).getExpansion();
1088 if (ExpInfo.isMacroArgExpansion()) {
1089 // For macro argument expansions, check if the next FileID is part of the
1090 // same argument expansion, in which case this Loc is not at the end of the
1092 FileID NextFID = getNextFileID(FID);
1093 if (!NextFID.isInvalid()) {
1094 const SrcMgr::SLocEntry &NextEntry = getSLocEntry(NextFID, &Invalid);
1097 if (NextEntry.isExpansion() &&
1098 NextEntry.getExpansion().getExpansionLocStart() ==
1099 ExpInfo.getExpansionLocStart())
1105 *MacroEnd = ExpInfo.getExpansionLocEnd();
1110 //===----------------------------------------------------------------------===//
1111 // Queries about the code at a SourceLocation.
1112 //===----------------------------------------------------------------------===//
1114 /// getCharacterData - Return a pointer to the start of the specified location
1115 /// in the appropriate MemoryBuffer.
1116 const char *SourceManager::getCharacterData(SourceLocation SL,
1117 bool *Invalid) const {
1118 // Note that this is a hot function in the getSpelling() path, which is
1119 // heavily used by -E mode.
1120 std::pair<FileID, unsigned> LocInfo = getDecomposedSpellingLoc(SL);
1122 // Note that calling 'getBuffer()' may lazily page in a source file.
1123 bool CharDataInvalid = false;
1124 const SLocEntry &Entry = getSLocEntry(LocInfo.first, &CharDataInvalid);
1125 if (CharDataInvalid || !Entry.isFile()) {
1129 return "<<<<INVALID BUFFER>>>>";
1131 const llvm::MemoryBuffer *Buffer
1132 = Entry.getFile().getContentCache()
1133 ->getBuffer(Diag, *this, SourceLocation(), &CharDataInvalid);
1135 *Invalid = CharDataInvalid;
1136 return Buffer->getBufferStart() + (CharDataInvalid? 0 : LocInfo.second);
1140 /// getColumnNumber - Return the column # for the specified file position.
1141 /// this is significantly cheaper to compute than the line number.
1142 unsigned SourceManager::getColumnNumber(FileID FID, unsigned FilePos,
1143 bool *Invalid) const {
1144 bool MyInvalid = false;
1145 const llvm::MemoryBuffer *MemBuf = getBuffer(FID, &MyInvalid);
1147 *Invalid = MyInvalid;
1152 // It is okay to request a position just past the end of the buffer.
1153 if (FilePos > MemBuf->getBufferSize()) {
1159 // See if we just calculated the line number for this FilePos and can use
1160 // that to lookup the start of the line instead of searching for it.
1161 if (LastLineNoFileIDQuery == FID &&
1162 LastLineNoContentCache->SourceLineCache != 0 &&
1163 LastLineNoResult < LastLineNoContentCache->NumLines) {
1164 unsigned *SourceLineCache = LastLineNoContentCache->SourceLineCache;
1165 unsigned LineStart = SourceLineCache[LastLineNoResult - 1];
1166 unsigned LineEnd = SourceLineCache[LastLineNoResult];
1167 if (FilePos >= LineStart && FilePos < LineEnd)
1168 return FilePos - LineStart + 1;
1171 const char *Buf = MemBuf->getBufferStart();
1172 unsigned LineStart = FilePos;
1173 while (LineStart && Buf[LineStart-1] != '\n' && Buf[LineStart-1] != '\r')
1175 return FilePos-LineStart+1;
1178 // isInvalid - Return the result of calling loc.isInvalid(), and
1179 // if Invalid is not null, set its value to same.
1180 static bool isInvalid(SourceLocation Loc, bool *Invalid) {
1181 bool MyInvalid = Loc.isInvalid();
1183 *Invalid = MyInvalid;
1187 unsigned SourceManager::getSpellingColumnNumber(SourceLocation Loc,
1188 bool *Invalid) const {
1189 if (isInvalid(Loc, Invalid)) return 0;
1190 std::pair<FileID, unsigned> LocInfo = getDecomposedSpellingLoc(Loc);
1191 return getColumnNumber(LocInfo.first, LocInfo.second, Invalid);
1194 unsigned SourceManager::getExpansionColumnNumber(SourceLocation Loc,
1195 bool *Invalid) const {
1196 if (isInvalid(Loc, Invalid)) return 0;
1197 std::pair<FileID, unsigned> LocInfo = getDecomposedExpansionLoc(Loc);
1198 return getColumnNumber(LocInfo.first, LocInfo.second, Invalid);
1201 unsigned SourceManager::getPresumedColumnNumber(SourceLocation Loc,
1202 bool *Invalid) const {
1203 if (isInvalid(Loc, Invalid)) return 0;
1204 return getPresumedLoc(Loc).getColumn();
1208 #include <emmintrin.h>
1211 static LLVM_ATTRIBUTE_NOINLINE void
1212 ComputeLineNumbers(DiagnosticsEngine &Diag, ContentCache *FI,
1213 llvm::BumpPtrAllocator &Alloc,
1214 const SourceManager &SM, bool &Invalid);
1215 static void ComputeLineNumbers(DiagnosticsEngine &Diag, ContentCache *FI,
1216 llvm::BumpPtrAllocator &Alloc,
1217 const SourceManager &SM, bool &Invalid) {
1218 // Note that calling 'getBuffer()' may lazily page in the file.
1219 const MemoryBuffer *Buffer = FI->getBuffer(Diag, SM, SourceLocation(),
1224 // Find the file offsets of all of the *physical* source lines. This does
1225 // not look at trigraphs, escaped newlines, or anything else tricky.
1226 SmallVector<unsigned, 256> LineOffsets;
1228 // Line #1 starts at char 0.
1229 LineOffsets.push_back(0);
1231 const unsigned char *Buf = (const unsigned char *)Buffer->getBufferStart();
1232 const unsigned char *End = (const unsigned char *)Buffer->getBufferEnd();
1235 // Skip over the contents of the line.
1236 const unsigned char *NextBuf = (const unsigned char *)Buf;
1239 // Try to skip to the next newline using SSE instructions. This is very
1240 // performance sensitive for programs with lots of diagnostics and in -E
1242 __m128i CRs = _mm_set1_epi8('\r');
1243 __m128i LFs = _mm_set1_epi8('\n');
1245 // First fix up the alignment to 16 bytes.
1246 while (((uintptr_t)NextBuf & 0xF) != 0) {
1247 if (*NextBuf == '\n' || *NextBuf == '\r' || *NextBuf == '\0')
1248 goto FoundSpecialChar;
1252 // Scan 16 byte chunks for '\r' and '\n'. Ignore '\0'.
1253 while (NextBuf+16 <= End) {
1254 const __m128i Chunk = *(const __m128i*)NextBuf;
1255 __m128i Cmp = _mm_or_si128(_mm_cmpeq_epi8(Chunk, CRs),
1256 _mm_cmpeq_epi8(Chunk, LFs));
1257 unsigned Mask = _mm_movemask_epi8(Cmp);
1259 // If we found a newline, adjust the pointer and jump to the handling code.
1261 NextBuf += llvm::countTrailingZeros(Mask);
1262 goto FoundSpecialChar;
1268 while (*NextBuf != '\n' && *NextBuf != '\r' && *NextBuf != '\0')
1274 Offs += NextBuf-Buf;
1277 if (Buf[0] == '\n' || Buf[0] == '\r') {
1278 // If this is \n\r or \r\n, skip both characters.
1279 if ((Buf[1] == '\n' || Buf[1] == '\r') && Buf[0] != Buf[1])
1282 LineOffsets.push_back(Offs);
1284 // Otherwise, this is a null. If end of file, exit.
1285 if (Buf == End) break;
1286 // Otherwise, skip the null.
1291 // Copy the offsets into the FileInfo structure.
1292 FI->NumLines = LineOffsets.size();
1293 FI->SourceLineCache = Alloc.Allocate<unsigned>(LineOffsets.size());
1294 std::copy(LineOffsets.begin(), LineOffsets.end(), FI->SourceLineCache);
1297 /// getLineNumber - Given a SourceLocation, return the spelling line number
1298 /// for the position indicated. This requires building and caching a table of
1299 /// line offsets for the MemoryBuffer, so this is not cheap: use only when
1300 /// about to emit a diagnostic.
1301 unsigned SourceManager::getLineNumber(FileID FID, unsigned FilePos,
1302 bool *Invalid) const {
1303 if (FID.isInvalid()) {
1309 ContentCache *Content;
1310 if (LastLineNoFileIDQuery == FID)
1311 Content = LastLineNoContentCache;
1313 bool MyInvalid = false;
1314 const SLocEntry &Entry = getSLocEntry(FID, &MyInvalid);
1315 if (MyInvalid || !Entry.isFile()) {
1321 Content = const_cast<ContentCache*>(Entry.getFile().getContentCache());
1324 // If this is the first use of line information for this buffer, compute the
1325 /// SourceLineCache for it on demand.
1326 if (Content->SourceLineCache == 0) {
1327 bool MyInvalid = false;
1328 ComputeLineNumbers(Diag, Content, ContentCacheAlloc, *this, MyInvalid);
1330 *Invalid = MyInvalid;
1336 // Okay, we know we have a line number table. Do a binary search to find the
1337 // line number that this character position lands on.
1338 unsigned *SourceLineCache = Content->SourceLineCache;
1339 unsigned *SourceLineCacheStart = SourceLineCache;
1340 unsigned *SourceLineCacheEnd = SourceLineCache + Content->NumLines;
1342 unsigned QueriedFilePos = FilePos+1;
1344 // FIXME: I would like to be convinced that this code is worth being as
1345 // complicated as it is, binary search isn't that slow.
1347 // If it is worth being optimized, then in my opinion it could be more
1348 // performant, simpler, and more obviously correct by just "galloping" outward
1349 // from the queried file position. In fact, this could be incorporated into a
1350 // generic algorithm such as lower_bound_with_hint.
1352 // If someone gives me a test case where this matters, and I will do it! - DWD
1354 // If the previous query was to the same file, we know both the file pos from
1355 // that query and the line number returned. This allows us to narrow the
1356 // search space from the entire file to something near the match.
1357 if (LastLineNoFileIDQuery == FID) {
1358 if (QueriedFilePos >= LastLineNoFilePos) {
1359 // FIXME: Potential overflow?
1360 SourceLineCache = SourceLineCache+LastLineNoResult-1;
1362 // The query is likely to be nearby the previous one. Here we check to
1363 // see if it is within 5, 10 or 20 lines. It can be far away in cases
1364 // where big comment blocks and vertical whitespace eat up lines but
1365 // contribute no tokens.
1366 if (SourceLineCache+5 < SourceLineCacheEnd) {
1367 if (SourceLineCache[5] > QueriedFilePos)
1368 SourceLineCacheEnd = SourceLineCache+5;
1369 else if (SourceLineCache+10 < SourceLineCacheEnd) {
1370 if (SourceLineCache[10] > QueriedFilePos)
1371 SourceLineCacheEnd = SourceLineCache+10;
1372 else if (SourceLineCache+20 < SourceLineCacheEnd) {
1373 if (SourceLineCache[20] > QueriedFilePos)
1374 SourceLineCacheEnd = SourceLineCache+20;
1379 if (LastLineNoResult < Content->NumLines)
1380 SourceLineCacheEnd = SourceLineCache+LastLineNoResult+1;
1384 // If the spread is large, do a "radix" test as our initial guess, based on
1385 // the assumption that lines average to approximately the same length.
1386 // NOTE: This is currently disabled, as it does not appear to be profitable in
1387 // initial measurements.
1388 if (0 && SourceLineCacheEnd-SourceLineCache > 20) {
1389 unsigned FileLen = Content->SourceLineCache[Content->NumLines-1];
1391 // Take a stab at guessing where it is.
1392 unsigned ApproxPos = Content->NumLines*QueriedFilePos / FileLen;
1394 // Check for -10 and +10 lines.
1395 unsigned LowerBound = std::max(int(ApproxPos-10), 0);
1396 unsigned UpperBound = std::min(ApproxPos+10, FileLen);
1398 // If the computed lower bound is less than the query location, move it in.
1399 if (SourceLineCache < SourceLineCacheStart+LowerBound &&
1400 SourceLineCacheStart[LowerBound] < QueriedFilePos)
1401 SourceLineCache = SourceLineCacheStart+LowerBound;
1403 // If the computed upper bound is greater than the query location, move it.
1404 if (SourceLineCacheEnd > SourceLineCacheStart+UpperBound &&
1405 SourceLineCacheStart[UpperBound] >= QueriedFilePos)
1406 SourceLineCacheEnd = SourceLineCacheStart+UpperBound;
1410 = std::lower_bound(SourceLineCache, SourceLineCacheEnd, QueriedFilePos);
1411 unsigned LineNo = Pos-SourceLineCacheStart;
1413 LastLineNoFileIDQuery = FID;
1414 LastLineNoContentCache = Content;
1415 LastLineNoFilePos = QueriedFilePos;
1416 LastLineNoResult = LineNo;
1420 unsigned SourceManager::getSpellingLineNumber(SourceLocation Loc,
1421 bool *Invalid) const {
1422 if (isInvalid(Loc, Invalid)) return 0;
1423 std::pair<FileID, unsigned> LocInfo = getDecomposedSpellingLoc(Loc);
1424 return getLineNumber(LocInfo.first, LocInfo.second);
1426 unsigned SourceManager::getExpansionLineNumber(SourceLocation Loc,
1427 bool *Invalid) const {
1428 if (isInvalid(Loc, Invalid)) return 0;
1429 std::pair<FileID, unsigned> LocInfo = getDecomposedExpansionLoc(Loc);
1430 return getLineNumber(LocInfo.first, LocInfo.second);
1432 unsigned SourceManager::getPresumedLineNumber(SourceLocation Loc,
1433 bool *Invalid) const {
1434 if (isInvalid(Loc, Invalid)) return 0;
1435 return getPresumedLoc(Loc).getLine();
1438 /// getFileCharacteristic - return the file characteristic of the specified
1439 /// source location, indicating whether this is a normal file, a system
1440 /// header, or an "implicit extern C" system header.
1442 /// This state can be modified with flags on GNU linemarker directives like:
1444 /// which changes all source locations in the current file after that to be
1445 /// considered to be from a system header.
1446 SrcMgr::CharacteristicKind
1447 SourceManager::getFileCharacteristic(SourceLocation Loc) const {
1448 assert(!Loc.isInvalid() && "Can't get file characteristic of invalid loc!");
1449 std::pair<FileID, unsigned> LocInfo = getDecomposedExpansionLoc(Loc);
1450 bool Invalid = false;
1451 const SLocEntry &SEntry = getSLocEntry(LocInfo.first, &Invalid);
1452 if (Invalid || !SEntry.isFile())
1455 const SrcMgr::FileInfo &FI = SEntry.getFile();
1457 // If there are no #line directives in this file, just return the whole-file
1459 if (!FI.hasLineDirectives())
1460 return FI.getFileCharacteristic();
1462 assert(LineTable && "Can't have linetable entries without a LineTable!");
1463 // See if there is a #line directive before the location.
1464 const LineEntry *Entry =
1465 LineTable->FindNearestLineEntry(LocInfo.first, LocInfo.second);
1467 // If this is before the first line marker, use the file characteristic.
1469 return FI.getFileCharacteristic();
1471 return Entry->FileKind;
1474 /// Return the filename or buffer identifier of the buffer the location is in.
1475 /// Note that this name does not respect \#line directives. Use getPresumedLoc
1476 /// for normal clients.
1477 const char *SourceManager::getBufferName(SourceLocation Loc,
1478 bool *Invalid) const {
1479 if (isInvalid(Loc, Invalid)) return "<invalid loc>";
1481 return getBuffer(getFileID(Loc), Invalid)->getBufferIdentifier();
1485 /// getPresumedLoc - This method returns the "presumed" location of a
1486 /// SourceLocation specifies. A "presumed location" can be modified by \#line
1487 /// or GNU line marker directives. This provides a view on the data that a
1488 /// user should see in diagnostics, for example.
1490 /// Note that a presumed location is always given as the expansion point of an
1491 /// expansion location, not at the spelling location.
1492 PresumedLoc SourceManager::getPresumedLoc(SourceLocation Loc,
1493 bool UseLineDirectives) const {
1494 if (Loc.isInvalid()) return PresumedLoc();
1496 // Presumed locations are always for expansion points.
1497 std::pair<FileID, unsigned> LocInfo = getDecomposedExpansionLoc(Loc);
1499 bool Invalid = false;
1500 const SLocEntry &Entry = getSLocEntry(LocInfo.first, &Invalid);
1501 if (Invalid || !Entry.isFile())
1502 return PresumedLoc();
1504 const SrcMgr::FileInfo &FI = Entry.getFile();
1505 const SrcMgr::ContentCache *C = FI.getContentCache();
1507 // To get the source name, first consult the FileEntry (if one exists)
1508 // before the MemBuffer as this will avoid unnecessarily paging in the
1510 const char *Filename;
1512 Filename = C->OrigEntry->getName();
1514 Filename = C->getBuffer(Diag, *this)->getBufferIdentifier();
1516 unsigned LineNo = getLineNumber(LocInfo.first, LocInfo.second, &Invalid);
1518 return PresumedLoc();
1519 unsigned ColNo = getColumnNumber(LocInfo.first, LocInfo.second, &Invalid);
1521 return PresumedLoc();
1523 SourceLocation IncludeLoc = FI.getIncludeLoc();
1525 // If we have #line directives in this file, update and overwrite the physical
1526 // location info if appropriate.
1527 if (UseLineDirectives && FI.hasLineDirectives()) {
1528 assert(LineTable && "Can't have linetable entries without a LineTable!");
1529 // See if there is a #line directive before this. If so, get it.
1530 if (const LineEntry *Entry =
1531 LineTable->FindNearestLineEntry(LocInfo.first, LocInfo.second)) {
1532 // If the LineEntry indicates a filename, use it.
1533 if (Entry->FilenameID != -1)
1534 Filename = LineTable->getFilename(Entry->FilenameID);
1536 // Use the line number specified by the LineEntry. This line number may
1537 // be multiple lines down from the line entry. Add the difference in
1538 // physical line numbers from the query point and the line marker to the
1540 unsigned MarkerLineNo = getLineNumber(LocInfo.first, Entry->FileOffset);
1541 LineNo = Entry->LineNo + (LineNo-MarkerLineNo-1);
1543 // Note that column numbers are not molested by line markers.
1545 // Handle virtual #include manipulation.
1546 if (Entry->IncludeOffset) {
1547 IncludeLoc = getLocForStartOfFile(LocInfo.first);
1548 IncludeLoc = IncludeLoc.getLocWithOffset(Entry->IncludeOffset);
1553 return PresumedLoc(Filename, LineNo, ColNo, IncludeLoc);
1556 /// \brief Returns whether the PresumedLoc for a given SourceLocation is
1557 /// in the main file.
1559 /// This computes the "presumed" location for a SourceLocation, then checks
1560 /// whether it came from a file other than the main file. This is different
1561 /// from isWrittenInMainFile() because it takes line marker directives into
1563 bool SourceManager::isInMainFile(SourceLocation Loc) const {
1564 if (Loc.isInvalid()) return false;
1566 // Presumed locations are always for expansion points.
1567 std::pair<FileID, unsigned> LocInfo = getDecomposedExpansionLoc(Loc);
1569 bool Invalid = false;
1570 const SLocEntry &Entry = getSLocEntry(LocInfo.first, &Invalid);
1571 if (Invalid || !Entry.isFile())
1574 const SrcMgr::FileInfo &FI = Entry.getFile();
1576 // Check if there is a line directive for this location.
1577 if (FI.hasLineDirectives())
1578 if (const LineEntry *Entry =
1579 LineTable->FindNearestLineEntry(LocInfo.first, LocInfo.second))
1580 if (Entry->IncludeOffset)
1583 return FI.getIncludeLoc().isInvalid();
1586 /// \brief The size of the SLocEnty that \arg FID represents.
1587 unsigned SourceManager::getFileIDSize(FileID FID) const {
1588 bool Invalid = false;
1589 const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid);
1594 unsigned NextOffset;
1595 if ((ID > 0 && unsigned(ID+1) == local_sloc_entry_size()))
1596 NextOffset = getNextLocalOffset();
1597 else if (ID+1 == -1)
1598 NextOffset = MaxLoadedOffset;
1600 NextOffset = getSLocEntry(FileID::get(ID+1)).getOffset();
1602 return NextOffset - Entry.getOffset() - 1;
1605 //===----------------------------------------------------------------------===//
1606 // Other miscellaneous methods.
1607 //===----------------------------------------------------------------------===//
1609 /// \brief Retrieve the inode for the given file entry, if possible.
1611 /// This routine involves a system call, and therefore should only be used
1612 /// in non-performance-critical code.
1613 static Optional<llvm::sys::fs::UniqueID>
1614 getActualFileUID(const FileEntry *File) {
1618 llvm::sys::fs::UniqueID ID;
1619 if (llvm::sys::fs::getUniqueID(File->getName(), ID))
1625 /// \brief Get the source location for the given file:line:col triplet.
1627 /// If the source file is included multiple times, the source location will
1628 /// be based upon an arbitrary inclusion.
1629 SourceLocation SourceManager::translateFileLineCol(const FileEntry *SourceFile,
1631 unsigned Col) const {
1632 assert(SourceFile && "Null source file!");
1633 assert(Line && Col && "Line and column should start from 1!");
1635 FileID FirstFID = translateFile(SourceFile);
1636 return translateLineCol(FirstFID, Line, Col);
1639 /// \brief Get the FileID for the given file.
1641 /// If the source file is included multiple times, the FileID will be the
1642 /// first inclusion.
1643 FileID SourceManager::translateFile(const FileEntry *SourceFile) const {
1644 assert(SourceFile && "Null source file!");
1646 // Find the first file ID that corresponds to the given file.
1649 // First, check the main file ID, since it is common to look for a
1650 // location in the main file.
1651 Optional<llvm::sys::fs::UniqueID> SourceFileUID;
1652 Optional<StringRef> SourceFileName;
1653 if (!MainFileID.isInvalid()) {
1654 bool Invalid = false;
1655 const SLocEntry &MainSLoc = getSLocEntry(MainFileID, &Invalid);
1659 if (MainSLoc.isFile()) {
1660 const ContentCache *MainContentCache
1661 = MainSLoc.getFile().getContentCache();
1662 if (!MainContentCache) {
1663 // Can't do anything
1664 } else if (MainContentCache->OrigEntry == SourceFile) {
1665 FirstFID = MainFileID;
1667 // Fall back: check whether we have the same base name and inode
1668 // as the main file.
1669 const FileEntry *MainFile = MainContentCache->OrigEntry;
1670 SourceFileName = llvm::sys::path::filename(SourceFile->getName());
1671 if (*SourceFileName == llvm::sys::path::filename(MainFile->getName())) {
1672 SourceFileUID = getActualFileUID(SourceFile);
1673 if (SourceFileUID) {
1674 if (Optional<llvm::sys::fs::UniqueID> MainFileUID =
1675 getActualFileUID(MainFile)) {
1676 if (*SourceFileUID == *MainFileUID) {
1677 FirstFID = MainFileID;
1678 SourceFile = MainFile;
1687 if (FirstFID.isInvalid()) {
1688 // The location we're looking for isn't in the main file; look
1689 // through all of the local source locations.
1690 for (unsigned I = 0, N = local_sloc_entry_size(); I != N; ++I) {
1691 bool Invalid = false;
1692 const SLocEntry &SLoc = getLocalSLocEntry(I, &Invalid);
1696 if (SLoc.isFile() &&
1697 SLoc.getFile().getContentCache() &&
1698 SLoc.getFile().getContentCache()->OrigEntry == SourceFile) {
1699 FirstFID = FileID::get(I);
1703 // If that still didn't help, try the modules.
1704 if (FirstFID.isInvalid()) {
1705 for (unsigned I = 0, N = loaded_sloc_entry_size(); I != N; ++I) {
1706 const SLocEntry &SLoc = getLoadedSLocEntry(I);
1707 if (SLoc.isFile() &&
1708 SLoc.getFile().getContentCache() &&
1709 SLoc.getFile().getContentCache()->OrigEntry == SourceFile) {
1710 FirstFID = FileID::get(-int(I) - 2);
1717 // If we haven't found what we want yet, try again, but this time stat()
1718 // each of the files in case the files have changed since we originally
1720 if (FirstFID.isInvalid() &&
1722 (SourceFileName = llvm::sys::path::filename(SourceFile->getName()))) &&
1723 (SourceFileUID || (SourceFileUID = getActualFileUID(SourceFile)))) {
1724 bool Invalid = false;
1725 for (unsigned I = 0, N = local_sloc_entry_size(); I != N; ++I) {
1728 const SLocEntry &SLoc = getSLocEntry(IFileID, &Invalid);
1732 if (SLoc.isFile()) {
1733 const ContentCache *FileContentCache
1734 = SLoc.getFile().getContentCache();
1735 const FileEntry *Entry =FileContentCache? FileContentCache->OrigEntry : 0;
1737 *SourceFileName == llvm::sys::path::filename(Entry->getName())) {
1738 if (Optional<llvm::sys::fs::UniqueID> EntryUID =
1739 getActualFileUID(Entry)) {
1740 if (*SourceFileUID == *EntryUID) {
1741 FirstFID = FileID::get(I);
1755 /// \brief Get the source location in \arg FID for the given line:col.
1756 /// Returns null location if \arg FID is not a file SLocEntry.
1757 SourceLocation SourceManager::translateLineCol(FileID FID,
1759 unsigned Col) const {
1760 // Lines are used as a one-based index into a zero-based array. This assert
1761 // checks for possible buffer underruns.
1762 assert(Line != 0 && "Passed a zero-based line");
1764 if (FID.isInvalid())
1765 return SourceLocation();
1767 bool Invalid = false;
1768 const SLocEntry &Entry = getSLocEntry(FID, &Invalid);
1770 return SourceLocation();
1772 if (!Entry.isFile())
1773 return SourceLocation();
1775 SourceLocation FileLoc = SourceLocation::getFileLoc(Entry.getOffset());
1777 if (Line == 1 && Col == 1)
1780 ContentCache *Content
1781 = const_cast<ContentCache *>(Entry.getFile().getContentCache());
1783 return SourceLocation();
1785 // If this is the first use of line information for this buffer, compute the
1786 // SourceLineCache for it on demand.
1787 if (Content->SourceLineCache == 0) {
1788 bool MyInvalid = false;
1789 ComputeLineNumbers(Diag, Content, ContentCacheAlloc, *this, MyInvalid);
1791 return SourceLocation();
1794 if (Line > Content->NumLines) {
1795 unsigned Size = Content->getBuffer(Diag, *this)->getBufferSize();
1798 return FileLoc.getLocWithOffset(Size);
1801 const llvm::MemoryBuffer *Buffer = Content->getBuffer(Diag, *this);
1802 unsigned FilePos = Content->SourceLineCache[Line - 1];
1803 const char *Buf = Buffer->getBufferStart() + FilePos;
1804 unsigned BufLength = Buffer->getBufferSize() - FilePos;
1806 return FileLoc.getLocWithOffset(FilePos);
1810 // Check that the given column is valid.
1811 while (i < BufLength-1 && i < Col-1 && Buf[i] != '\n' && Buf[i] != '\r')
1813 return FileLoc.getLocWithOffset(FilePos + i);
1816 /// \brief Compute a map of macro argument chunks to their expanded source
1817 /// location. Chunks that are not part of a macro argument will map to an
1818 /// invalid source location. e.g. if a file contains one macro argument at
1819 /// offset 100 with length 10, this is how the map will be formed:
1820 /// 0 -> SourceLocation()
1821 /// 100 -> Expanded macro arg location
1822 /// 110 -> SourceLocation()
1823 void SourceManager::computeMacroArgsCache(MacroArgsMap *&CachePtr,
1825 assert(!FID.isInvalid());
1828 CachePtr = new MacroArgsMap();
1829 MacroArgsMap &MacroArgsCache = *CachePtr;
1830 // Initially no macro argument chunk is present.
1831 MacroArgsCache.insert(std::make_pair(0, SourceLocation()));
1836 // Stop if there are no more FileIDs to check.
1838 if (unsigned(ID) >= local_sloc_entry_size())
1840 } else if (ID == -1) {
1844 bool Invalid = false;
1845 const SrcMgr::SLocEntry &Entry = getSLocEntryByID(ID, &Invalid);
1848 if (Entry.isFile()) {
1849 SourceLocation IncludeLoc = Entry.getFile().getIncludeLoc();
1850 if (IncludeLoc.isInvalid())
1852 if (!isInFileID(IncludeLoc, FID))
1853 return; // No more files/macros that may be "contained" in this file.
1855 // Skip the files/macros of the #include'd file, we only care about macros
1856 // that lexed macro arguments from our file.
1857 if (Entry.getFile().NumCreatedFIDs)
1858 ID += Entry.getFile().NumCreatedFIDs - 1/*because of next ++ID*/;
1862 const ExpansionInfo &ExpInfo = Entry.getExpansion();
1864 if (ExpInfo.getExpansionLocStart().isFileID()) {
1865 if (!isInFileID(ExpInfo.getExpansionLocStart(), FID))
1866 return; // No more files/macros that may be "contained" in this file.
1869 if (!ExpInfo.isMacroArgExpansion())
1872 associateFileChunkWithMacroArgExp(MacroArgsCache, FID,
1873 ExpInfo.getSpellingLoc(),
1874 SourceLocation::getMacroLoc(Entry.getOffset()),
1875 getFileIDSize(FileID::get(ID)));
1879 void SourceManager::associateFileChunkWithMacroArgExp(
1880 MacroArgsMap &MacroArgsCache,
1882 SourceLocation SpellLoc,
1883 SourceLocation ExpansionLoc,
1884 unsigned ExpansionLength) const {
1885 if (!SpellLoc.isFileID()) {
1886 unsigned SpellBeginOffs = SpellLoc.getOffset();
1887 unsigned SpellEndOffs = SpellBeginOffs + ExpansionLength;
1889 // The spelling range for this macro argument expansion can span multiple
1890 // consecutive FileID entries. Go through each entry contained in the
1891 // spelling range and if one is itself a macro argument expansion, recurse
1892 // and associate the file chunk that it represents.
1894 FileID SpellFID; // Current FileID in the spelling range.
1895 unsigned SpellRelativeOffs;
1896 llvm::tie(SpellFID, SpellRelativeOffs) = getDecomposedLoc(SpellLoc);
1898 const SLocEntry &Entry = getSLocEntry(SpellFID);
1899 unsigned SpellFIDBeginOffs = Entry.getOffset();
1900 unsigned SpellFIDSize = getFileIDSize(SpellFID);
1901 unsigned SpellFIDEndOffs = SpellFIDBeginOffs + SpellFIDSize;
1902 const ExpansionInfo &Info = Entry.getExpansion();
1903 if (Info.isMacroArgExpansion()) {
1904 unsigned CurrSpellLength;
1905 if (SpellFIDEndOffs < SpellEndOffs)
1906 CurrSpellLength = SpellFIDSize - SpellRelativeOffs;
1908 CurrSpellLength = ExpansionLength;
1909 associateFileChunkWithMacroArgExp(MacroArgsCache, FID,
1910 Info.getSpellingLoc().getLocWithOffset(SpellRelativeOffs),
1911 ExpansionLoc, CurrSpellLength);
1914 if (SpellFIDEndOffs >= SpellEndOffs)
1915 return; // we covered all FileID entries in the spelling range.
1917 // Move to the next FileID entry in the spelling range.
1918 unsigned advance = SpellFIDSize - SpellRelativeOffs + 1;
1919 ExpansionLoc = ExpansionLoc.getLocWithOffset(advance);
1920 ExpansionLength -= advance;
1922 SpellRelativeOffs = 0;
1927 assert(SpellLoc.isFileID());
1930 if (!isInFileID(SpellLoc, FID, &BeginOffs))
1933 unsigned EndOffs = BeginOffs + ExpansionLength;
1935 // Add a new chunk for this macro argument. A previous macro argument chunk
1936 // may have been lexed again, so e.g. if the map is
1937 // 0 -> SourceLocation()
1938 // 100 -> Expanded loc #1
1939 // 110 -> SourceLocation()
1940 // and we found a new macro FileID that lexed from offet 105 with length 3,
1941 // the new map will be:
1942 // 0 -> SourceLocation()
1943 // 100 -> Expanded loc #1
1944 // 105 -> Expanded loc #2
1945 // 108 -> Expanded loc #1
1946 // 110 -> SourceLocation()
1948 // Since re-lexed macro chunks will always be the same size or less of
1949 // previous chunks, we only need to find where the ending of the new macro
1950 // chunk is mapped to and update the map with new begin/end mappings.
1952 MacroArgsMap::iterator I = MacroArgsCache.upper_bound(EndOffs);
1954 SourceLocation EndOffsMappedLoc = I->second;
1955 MacroArgsCache[BeginOffs] = ExpansionLoc;
1956 MacroArgsCache[EndOffs] = EndOffsMappedLoc;
1959 /// \brief If \arg Loc points inside a function macro argument, the returned
1960 /// location will be the macro location in which the argument was expanded.
1961 /// If a macro argument is used multiple times, the expanded location will
1962 /// be at the first expansion of the argument.
1966 /// Passing a file location pointing at 'foo', will yield a macro location
1967 /// where 'foo' was expanded into.
1969 SourceManager::getMacroArgExpandedLocation(SourceLocation Loc) const {
1970 if (Loc.isInvalid() || !Loc.isFileID())
1975 llvm::tie(FID, Offset) = getDecomposedLoc(Loc);
1976 if (FID.isInvalid())
1979 MacroArgsMap *&MacroArgsCache = MacroArgsCacheMap[FID];
1980 if (!MacroArgsCache)
1981 computeMacroArgsCache(MacroArgsCache, FID);
1983 assert(!MacroArgsCache->empty());
1984 MacroArgsMap::iterator I = MacroArgsCache->upper_bound(Offset);
1987 unsigned MacroArgBeginOffs = I->first;
1988 SourceLocation MacroArgExpandedLoc = I->second;
1989 if (MacroArgExpandedLoc.isValid())
1990 return MacroArgExpandedLoc.getLocWithOffset(Offset - MacroArgBeginOffs);
1995 std::pair<FileID, unsigned>
1996 SourceManager::getDecomposedIncludedLoc(FileID FID) const {
1997 if (FID.isInvalid())
1998 return std::make_pair(FileID(), 0);
2000 // Uses IncludedLocMap to retrieve/cache the decomposed loc.
2002 typedef std::pair<FileID, unsigned> DecompTy;
2003 typedef llvm::DenseMap<FileID, DecompTy> MapTy;
2004 std::pair<MapTy::iterator, bool>
2005 InsertOp = IncludedLocMap.insert(std::make_pair(FID, DecompTy()));
2006 DecompTy &DecompLoc = InsertOp.first->second;
2007 if (!InsertOp.second)
2008 return DecompLoc; // already in map.
2010 SourceLocation UpperLoc;
2011 bool Invalid = false;
2012 const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid);
2014 if (Entry.isExpansion())
2015 UpperLoc = Entry.getExpansion().getExpansionLocStart();
2017 UpperLoc = Entry.getFile().getIncludeLoc();
2020 if (UpperLoc.isValid())
2021 DecompLoc = getDecomposedLoc(UpperLoc);
2026 /// Given a decomposed source location, move it up the include/expansion stack
2027 /// to the parent source location. If this is possible, return the decomposed
2028 /// version of the parent in Loc and return false. If Loc is the top-level
2029 /// entry, return true and don't modify it.
2030 static bool MoveUpIncludeHierarchy(std::pair<FileID, unsigned> &Loc,
2031 const SourceManager &SM) {
2032 std::pair<FileID, unsigned> UpperLoc = SM.getDecomposedIncludedLoc(Loc.first);
2033 if (UpperLoc.first.isInvalid())
2034 return true; // We reached the top.
2040 /// Return the cache entry for comparing the given file IDs
2041 /// for isBeforeInTranslationUnit.
2042 InBeforeInTUCacheEntry &SourceManager::getInBeforeInTUCache(FileID LFID,
2043 FileID RFID) const {
2044 // This is a magic number for limiting the cache size. It was experimentally
2045 // derived from a small Objective-C project (where the cache filled
2046 // out to ~250 items). We can make it larger if necessary.
2047 enum { MagicCacheSize = 300 };
2048 IsBeforeInTUCacheKey Key(LFID, RFID);
2050 // If the cache size isn't too large, do a lookup and if necessary default
2051 // construct an entry. We can then return it to the caller for direct
2052 // use. When they update the value, the cache will get automatically
2054 if (IBTUCache.size() < MagicCacheSize)
2055 return IBTUCache[Key];
2057 // Otherwise, do a lookup that will not construct a new value.
2058 InBeforeInTUCache::iterator I = IBTUCache.find(Key);
2059 if (I != IBTUCache.end())
2062 // Fall back to the overflow value.
2063 return IBTUCacheOverflow;
2066 /// \brief Determines the order of 2 source locations in the translation unit.
2068 /// \returns true if LHS source location comes before RHS, false otherwise.
2069 bool SourceManager::isBeforeInTranslationUnit(SourceLocation LHS,
2070 SourceLocation RHS) const {
2071 assert(LHS.isValid() && RHS.isValid() && "Passed invalid source location!");
2075 std::pair<FileID, unsigned> LOffs = getDecomposedLoc(LHS);
2076 std::pair<FileID, unsigned> ROffs = getDecomposedLoc(RHS);
2078 // getDecomposedLoc may have failed to return a valid FileID because, e.g. it
2079 // is a serialized one referring to a file that was removed after we loaded
2081 if (LOffs.first.isInvalid() || ROffs.first.isInvalid())
2082 return LOffs.first.isInvalid() && !ROffs.first.isInvalid();
2084 // If the source locations are in the same file, just compare offsets.
2085 if (LOffs.first == ROffs.first)
2086 return LOffs.second < ROffs.second;
2088 // If we are comparing a source location with multiple locations in the same
2089 // file, we get a big win by caching the result.
2090 InBeforeInTUCacheEntry &IsBeforeInTUCache =
2091 getInBeforeInTUCache(LOffs.first, ROffs.first);
2093 // If we are comparing a source location with multiple locations in the same
2094 // file, we get a big win by caching the result.
2095 if (IsBeforeInTUCache.isCacheValid(LOffs.first, ROffs.first))
2096 return IsBeforeInTUCache.getCachedResult(LOffs.second, ROffs.second);
2098 // Okay, we missed in the cache, start updating the cache for this query.
2099 IsBeforeInTUCache.setQueryFIDs(LOffs.first, ROffs.first,
2100 /*isLFIDBeforeRFID=*/LOffs.first.ID < ROffs.first.ID);
2102 // We need to find the common ancestor. The only way of doing this is to
2103 // build the complete include chain for one and then walking up the chain
2104 // of the other looking for a match.
2105 // We use a map from FileID to Offset to store the chain. Easier than writing
2106 // a custom set hash info that only depends on the first part of a pair.
2107 typedef llvm::SmallDenseMap<FileID, unsigned, 16> LocSet;
2110 LChain.insert(LOffs);
2111 // We catch the case where LOffs is in a file included by ROffs and
2112 // quit early. The other way round unfortunately remains suboptimal.
2113 } while (LOffs.first != ROffs.first && !MoveUpIncludeHierarchy(LOffs, *this));
2115 while((I = LChain.find(ROffs.first)) == LChain.end()) {
2116 if (MoveUpIncludeHierarchy(ROffs, *this))
2117 break; // Met at topmost file.
2119 if (I != LChain.end())
2122 // If we exited because we found a nearest common ancestor, compare the
2123 // locations within the common file and cache them.
2124 if (LOffs.first == ROffs.first) {
2125 IsBeforeInTUCache.setCommonLoc(LOffs.first, LOffs.second, ROffs.second);
2126 return IsBeforeInTUCache.getCachedResult(LOffs.second, ROffs.second);
2129 // This can happen if a location is in a built-ins buffer.
2131 // Clear the lookup cache, it depends on a common location.
2132 IsBeforeInTUCache.clear();
2133 bool LIsBuiltins = strcmp("<built-in>",
2134 getBuffer(LOffs.first)->getBufferIdentifier()) == 0;
2135 bool RIsBuiltins = strcmp("<built-in>",
2136 getBuffer(ROffs.first)->getBufferIdentifier()) == 0;
2137 // built-in is before non-built-in
2138 if (LIsBuiltins != RIsBuiltins)
2140 assert(LIsBuiltins && RIsBuiltins &&
2141 "Non-built-in locations must be rooted in the main file");
2142 // Both are in built-in buffers, but from different files. We just claim that
2143 // lower IDs come first.
2144 return LOffs.first < ROffs.first;
2147 void SourceManager::PrintStats() const {
2148 llvm::errs() << "\n*** Source Manager Stats:\n";
2149 llvm::errs() << FileInfos.size() << " files mapped, " << MemBufferInfos.size()
2150 << " mem buffers mapped.\n";
2151 llvm::errs() << LocalSLocEntryTable.size() << " local SLocEntry's allocated ("
2152 << llvm::capacity_in_bytes(LocalSLocEntryTable)
2153 << " bytes of capacity), "
2154 << NextLocalOffset << "B of Sloc address space used.\n";
2155 llvm::errs() << LoadedSLocEntryTable.size()
2156 << " loaded SLocEntries allocated, "
2157 << MaxLoadedOffset - CurrentLoadedOffset
2158 << "B of Sloc address space used.\n";
2160 unsigned NumLineNumsComputed = 0;
2161 unsigned NumFileBytesMapped = 0;
2162 for (fileinfo_iterator I = fileinfo_begin(), E = fileinfo_end(); I != E; ++I){
2163 NumLineNumsComputed += I->second->SourceLineCache != 0;
2164 NumFileBytesMapped += I->second->getSizeBytesMapped();
2166 unsigned NumMacroArgsComputed = MacroArgsCacheMap.size();
2168 llvm::errs() << NumFileBytesMapped << " bytes of files mapped, "
2169 << NumLineNumsComputed << " files with line #'s computed, "
2170 << NumMacroArgsComputed << " files with macro args computed.\n";
2171 llvm::errs() << "FileID scans: " << NumLinearScans << " linear, "
2172 << NumBinaryProbes << " binary.\n";
2175 ExternalSLocEntrySource::~ExternalSLocEntrySource() { }
2177 /// Return the amount of memory used by memory buffers, breaking down
2178 /// by heap-backed versus mmap'ed memory.
2179 SourceManager::MemoryBufferSizes SourceManager::getMemoryBufferSizes() const {
2180 size_t malloc_bytes = 0;
2181 size_t mmap_bytes = 0;
2183 for (unsigned i = 0, e = MemBufferInfos.size(); i != e; ++i)
2184 if (size_t sized_mapped = MemBufferInfos[i]->getSizeBytesMapped())
2185 switch (MemBufferInfos[i]->getMemoryBufferKind()) {
2186 case llvm::MemoryBuffer::MemoryBuffer_MMap:
2187 mmap_bytes += sized_mapped;
2189 case llvm::MemoryBuffer::MemoryBuffer_Malloc:
2190 malloc_bytes += sized_mapped;
2194 return MemoryBufferSizes(malloc_bytes, mmap_bytes);
2197 size_t SourceManager::getDataStructureSizes() const {
2198 size_t size = llvm::capacity_in_bytes(MemBufferInfos)
2199 + llvm::capacity_in_bytes(LocalSLocEntryTable)
2200 + llvm::capacity_in_bytes(LoadedSLocEntryTable)
2201 + llvm::capacity_in_bytes(SLocEntryLoaded)
2202 + llvm::capacity_in_bytes(FileInfos);
2204 if (OverriddenFilesInfo)
2205 size += llvm::capacity_in_bytes(OverriddenFilesInfo->OverriddenFiles);