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/ADT/STLExtras.h"
21 #include "llvm/Support/Compiler.h"
22 #include "llvm/Support/MemoryBuffer.h"
23 #include "llvm/Support/raw_ostream.h"
24 #include "llvm/Support/Path.h"
25 #include "llvm/Support/Capacity.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 assert(B != Buffer.getPointer());
76 if (shouldFreeBuffer())
77 delete Buffer.getPointer();
79 Buffer.setInt(DoNotFree? DoNotFreeFlag : 0);
82 const llvm::MemoryBuffer *ContentCache::getBuffer(DiagnosticsEngine &Diag,
83 const SourceManager &SM,
85 bool *Invalid) const {
86 // Lazily create the Buffer for ContentCaches that wrap files. If we already
87 // computed it, just return what we have.
88 if (Buffer.getPointer() || ContentsEntry == 0) {
90 *Invalid = isBufferInvalid();
92 return Buffer.getPointer();
96 Buffer.setPointer(SM.getFileManager().getBufferForFile(ContentsEntry, &ErrorStr));
98 // If we were unable to open the file, then we are in an inconsistent
99 // situation where the content cache referenced a file which no longer
100 // exists. Most likely, we were using a stat cache with an invalid entry but
101 // the file could also have been removed during processing. Since we can't
102 // really deal with this situation, just create an empty buffer.
104 // FIXME: This is definitely not ideal, but our immediate clients can't
105 // currently handle returning a null entry here. Ideally we should detect
106 // that we are in an inconsistent situation and error out as quickly as
108 if (!Buffer.getPointer()) {
109 const StringRef FillStr("<<<MISSING SOURCE FILE>>>\n");
110 Buffer.setPointer(MemoryBuffer::getNewMemBuffer(ContentsEntry->getSize(),
112 char *Ptr = const_cast<char*>(Buffer.getPointer()->getBufferStart());
113 for (unsigned i = 0, e = ContentsEntry->getSize(); i != e; ++i)
114 Ptr[i] = FillStr[i % FillStr.size()];
116 if (Diag.isDiagnosticInFlight())
117 Diag.SetDelayedDiagnostic(diag::err_cannot_open_file,
118 ContentsEntry->getName(), ErrorStr);
120 Diag.Report(Loc, diag::err_cannot_open_file)
121 << ContentsEntry->getName() << ErrorStr;
123 Buffer.setInt(Buffer.getInt() | InvalidFlag);
125 if (Invalid) *Invalid = true;
126 return Buffer.getPointer();
129 // Check that the file's size is the same as in the file entry (which may
130 // have come from a stat cache).
131 if (getRawBuffer()->getBufferSize() != (size_t)ContentsEntry->getSize()) {
132 if (Diag.isDiagnosticInFlight())
133 Diag.SetDelayedDiagnostic(diag::err_file_modified,
134 ContentsEntry->getName());
136 Diag.Report(Loc, diag::err_file_modified)
137 << ContentsEntry->getName();
139 Buffer.setInt(Buffer.getInt() | InvalidFlag);
140 if (Invalid) *Invalid = true;
141 return Buffer.getPointer();
144 // If the buffer is valid, check to see if it has a UTF Byte Order Mark
145 // (BOM). We only support UTF-8 with and without a BOM right now. See
146 // http://en.wikipedia.org/wiki/Byte_order_mark for more information.
147 StringRef BufStr = Buffer.getPointer()->getBuffer();
148 const char *InvalidBOM = llvm::StringSwitch<const char *>(BufStr)
149 .StartsWith("\xFE\xFF", "UTF-16 (BE)")
150 .StartsWith("\xFF\xFE", "UTF-16 (LE)")
151 .StartsWith("\x00\x00\xFE\xFF", "UTF-32 (BE)")
152 .StartsWith("\xFF\xFE\x00\x00", "UTF-32 (LE)")
153 .StartsWith("\x2B\x2F\x76", "UTF-7")
154 .StartsWith("\xF7\x64\x4C", "UTF-1")
155 .StartsWith("\xDD\x73\x66\x73", "UTF-EBCDIC")
156 .StartsWith("\x0E\xFE\xFF", "SDSU")
157 .StartsWith("\xFB\xEE\x28", "BOCU-1")
158 .StartsWith("\x84\x31\x95\x33", "GB-18030")
162 Diag.Report(Loc, diag::err_unsupported_bom)
163 << InvalidBOM << ContentsEntry->getName();
164 Buffer.setInt(Buffer.getInt() | InvalidFlag);
168 *Invalid = isBufferInvalid();
170 return Buffer.getPointer();
173 unsigned LineTableInfo::getLineTableFilenameID(StringRef Name) {
174 // Look up the filename in the string table, returning the pre-existing value
176 llvm::StringMapEntry<unsigned> &Entry =
177 FilenameIDs.GetOrCreateValue(Name, ~0U);
178 if (Entry.getValue() != ~0U)
179 return Entry.getValue();
181 // Otherwise, assign this the next available ID.
182 Entry.setValue(FilenamesByID.size());
183 FilenamesByID.push_back(&Entry);
184 return FilenamesByID.size()-1;
187 /// AddLineNote - Add a line note to the line table that indicates that there
188 /// is a #line at the specified FID/Offset location which changes the presumed
189 /// location to LineNo/FilenameID.
190 void LineTableInfo::AddLineNote(int FID, unsigned Offset,
191 unsigned LineNo, int FilenameID) {
192 std::vector<LineEntry> &Entries = LineEntries[FID];
194 assert((Entries.empty() || Entries.back().FileOffset < Offset) &&
195 "Adding line entries out of order!");
197 SrcMgr::CharacteristicKind Kind = SrcMgr::C_User;
198 unsigned IncludeOffset = 0;
200 if (!Entries.empty()) {
201 // If this is a '#line 4' after '#line 42 "foo.h"', make sure to remember
202 // that we are still in "foo.h".
203 if (FilenameID == -1)
204 FilenameID = Entries.back().FilenameID;
206 // If we are after a line marker that switched us to system header mode, or
207 // that set #include information, preserve it.
208 Kind = Entries.back().FileKind;
209 IncludeOffset = Entries.back().IncludeOffset;
212 Entries.push_back(LineEntry::get(Offset, LineNo, FilenameID, Kind,
216 /// AddLineNote This is the same as the previous version of AddLineNote, but is
217 /// used for GNU line markers. If EntryExit is 0, then this doesn't change the
218 /// presumed #include stack. If it is 1, this is a file entry, if it is 2 then
219 /// this is a file exit. FileKind specifies whether this is a system header or
220 /// extern C system header.
221 void LineTableInfo::AddLineNote(int FID, unsigned Offset,
222 unsigned LineNo, int FilenameID,
224 SrcMgr::CharacteristicKind FileKind) {
225 assert(FilenameID != -1 && "Unspecified filename should use other accessor");
227 std::vector<LineEntry> &Entries = LineEntries[FID];
229 assert((Entries.empty() || Entries.back().FileOffset < Offset) &&
230 "Adding line entries out of order!");
232 unsigned IncludeOffset = 0;
233 if (EntryExit == 0) { // No #include stack change.
234 IncludeOffset = Entries.empty() ? 0 : Entries.back().IncludeOffset;
235 } else if (EntryExit == 1) {
236 IncludeOffset = Offset-1;
237 } else if (EntryExit == 2) {
238 assert(!Entries.empty() && Entries.back().IncludeOffset &&
239 "PPDirectives should have caught case when popping empty include stack");
241 // Get the include loc of the last entries' include loc as our include loc.
243 if (const LineEntry *PrevEntry =
244 FindNearestLineEntry(FID, Entries.back().IncludeOffset))
245 IncludeOffset = PrevEntry->IncludeOffset;
248 Entries.push_back(LineEntry::get(Offset, LineNo, FilenameID, FileKind,
253 /// FindNearestLineEntry - Find the line entry nearest to FID that is before
254 /// it. If there is no line entry before Offset in FID, return null.
255 const LineEntry *LineTableInfo::FindNearestLineEntry(int FID,
257 const std::vector<LineEntry> &Entries = LineEntries[FID];
258 assert(!Entries.empty() && "No #line entries for this FID after all!");
260 // It is very common for the query to be after the last #line, check this
262 if (Entries.back().FileOffset <= Offset)
263 return &Entries.back();
265 // Do a binary search to find the maximal element that is still before Offset.
266 std::vector<LineEntry>::const_iterator I =
267 std::upper_bound(Entries.begin(), Entries.end(), Offset);
268 if (I == Entries.begin()) return 0;
272 /// \brief Add a new line entry that has already been encoded into
273 /// the internal representation of the line table.
274 void LineTableInfo::AddEntry(int FID,
275 const std::vector<LineEntry> &Entries) {
276 LineEntries[FID] = Entries;
279 /// getLineTableFilenameID - Return the uniqued ID for the specified filename.
281 unsigned SourceManager::getLineTableFilenameID(StringRef Name) {
283 LineTable = new LineTableInfo();
284 return LineTable->getLineTableFilenameID(Name);
288 /// AddLineNote - Add a line note to the line table for the FileID and offset
289 /// specified by Loc. If FilenameID is -1, it is considered to be
291 void SourceManager::AddLineNote(SourceLocation Loc, unsigned LineNo,
293 std::pair<FileID, unsigned> LocInfo = getDecomposedExpansionLoc(Loc);
295 bool Invalid = false;
296 const SLocEntry &Entry = getSLocEntry(LocInfo.first, &Invalid);
297 if (!Entry.isFile() || Invalid)
300 const SrcMgr::FileInfo &FileInfo = Entry.getFile();
302 // Remember that this file has #line directives now if it doesn't already.
303 const_cast<SrcMgr::FileInfo&>(FileInfo).setHasLineDirectives();
306 LineTable = new LineTableInfo();
307 LineTable->AddLineNote(LocInfo.first.ID, LocInfo.second, LineNo, FilenameID);
310 /// AddLineNote - Add a GNU line marker to the line table.
311 void SourceManager::AddLineNote(SourceLocation Loc, unsigned LineNo,
312 int FilenameID, bool IsFileEntry,
313 bool IsFileExit, bool IsSystemHeader,
314 bool IsExternCHeader) {
315 // If there is no filename and no flags, this is treated just like a #line,
316 // which does not change the flags of the previous line marker.
317 if (FilenameID == -1) {
318 assert(!IsFileEntry && !IsFileExit && !IsSystemHeader && !IsExternCHeader &&
319 "Can't set flags without setting the filename!");
320 return AddLineNote(Loc, LineNo, FilenameID);
323 std::pair<FileID, unsigned> LocInfo = getDecomposedExpansionLoc(Loc);
325 bool Invalid = false;
326 const SLocEntry &Entry = getSLocEntry(LocInfo.first, &Invalid);
327 if (!Entry.isFile() || Invalid)
330 const SrcMgr::FileInfo &FileInfo = Entry.getFile();
332 // Remember that this file has #line directives now if it doesn't already.
333 const_cast<SrcMgr::FileInfo&>(FileInfo).setHasLineDirectives();
336 LineTable = new LineTableInfo();
338 SrcMgr::CharacteristicKind FileKind;
340 FileKind = SrcMgr::C_ExternCSystem;
341 else if (IsSystemHeader)
342 FileKind = SrcMgr::C_System;
344 FileKind = SrcMgr::C_User;
346 unsigned EntryExit = 0;
352 LineTable->AddLineNote(LocInfo.first.ID, LocInfo.second, LineNo, FilenameID,
353 EntryExit, FileKind);
356 LineTableInfo &SourceManager::getLineTable() {
358 LineTable = new LineTableInfo();
362 //===----------------------------------------------------------------------===//
363 // Private 'Create' methods.
364 //===----------------------------------------------------------------------===//
366 SourceManager::SourceManager(DiagnosticsEngine &Diag, FileManager &FileMgr)
367 : Diag(Diag), FileMgr(FileMgr), OverridenFilesKeepOriginalName(true),
368 ExternalSLocEntries(0), LineTable(0), NumLinearScans(0),
369 NumBinaryProbes(0), FakeBufferForRecovery(0) {
371 Diag.setSourceManager(this);
374 SourceManager::~SourceManager() {
377 // Delete FileEntry objects corresponding to content caches. Since the actual
378 // content cache objects are bump pointer allocated, we just have to run the
379 // dtors, but we call the deallocate method for completeness.
380 for (unsigned i = 0, e = MemBufferInfos.size(); i != e; ++i) {
381 MemBufferInfos[i]->~ContentCache();
382 ContentCacheAlloc.Deallocate(MemBufferInfos[i]);
384 for (llvm::DenseMap<const FileEntry*, SrcMgr::ContentCache*>::iterator
385 I = FileInfos.begin(), E = FileInfos.end(); I != E; ++I) {
386 I->second->~ContentCache();
387 ContentCacheAlloc.Deallocate(I->second);
390 delete FakeBufferForRecovery;
392 for (llvm::DenseMap<FileID, MacroArgsMap *>::iterator
393 I = MacroArgsCacheMap.begin(),E = MacroArgsCacheMap.end(); I!=E; ++I) {
398 void SourceManager::clearIDTables() {
399 MainFileID = FileID();
400 LocalSLocEntryTable.clear();
401 LoadedSLocEntryTable.clear();
402 SLocEntryLoaded.clear();
403 LastLineNoFileIDQuery = FileID();
404 LastLineNoContentCache = 0;
405 LastFileIDLookup = FileID();
410 // Use up FileID #0 as an invalid expansion.
412 CurrentLoadedOffset = MaxLoadedOffset;
413 createExpansionLoc(SourceLocation(),SourceLocation(),SourceLocation(), 1);
416 /// getOrCreateContentCache - Create or return a cached ContentCache for the
419 SourceManager::getOrCreateContentCache(const FileEntry *FileEnt) {
420 assert(FileEnt && "Didn't specify a file entry to use?");
422 // Do we already have information about this file?
423 ContentCache *&Entry = FileInfos[FileEnt];
424 if (Entry) return Entry;
426 // Nope, create a new Cache entry. Make sure it is at least 8-byte aligned
427 // so that FileInfo can use the low 3 bits of the pointer for its own
428 // nefarious purposes.
429 unsigned EntryAlign = llvm::AlignOf<ContentCache>::Alignment;
430 EntryAlign = std::max(8U, EntryAlign);
431 Entry = ContentCacheAlloc.Allocate<ContentCache>(1, EntryAlign);
433 // If the file contents are overridden with contents from another file,
434 // pass that file to ContentCache.
435 llvm::DenseMap<const FileEntry *, const FileEntry *>::iterator
436 overI = OverriddenFiles.find(FileEnt);
437 if (overI == OverriddenFiles.end())
438 new (Entry) ContentCache(FileEnt);
440 new (Entry) ContentCache(OverridenFilesKeepOriginalName ? FileEnt
448 /// createMemBufferContentCache - Create a new ContentCache for the specified
449 /// memory buffer. This does no caching.
451 SourceManager::createMemBufferContentCache(const MemoryBuffer *Buffer) {
452 // Add a new ContentCache to the MemBufferInfos list and return it. Make sure
453 // it is at least 8-byte aligned so that FileInfo can use the low 3 bits of
454 // the pointer for its own nefarious purposes.
455 unsigned EntryAlign = llvm::AlignOf<ContentCache>::Alignment;
456 EntryAlign = std::max(8U, EntryAlign);
457 ContentCache *Entry = ContentCacheAlloc.Allocate<ContentCache>(1, EntryAlign);
458 new (Entry) ContentCache();
459 MemBufferInfos.push_back(Entry);
460 Entry->setBuffer(Buffer);
464 std::pair<int, unsigned>
465 SourceManager::AllocateLoadedSLocEntries(unsigned NumSLocEntries,
466 unsigned TotalSize) {
467 assert(ExternalSLocEntries && "Don't have an external sloc source");
468 LoadedSLocEntryTable.resize(LoadedSLocEntryTable.size() + NumSLocEntries);
469 SLocEntryLoaded.resize(LoadedSLocEntryTable.size());
470 CurrentLoadedOffset -= TotalSize;
471 assert(CurrentLoadedOffset >= NextLocalOffset && "Out of source locations");
472 int ID = LoadedSLocEntryTable.size();
473 return std::make_pair(-ID - 1, CurrentLoadedOffset);
476 /// \brief As part of recovering from missing or changed content, produce a
477 /// fake, non-empty buffer.
478 const llvm::MemoryBuffer *SourceManager::getFakeBufferForRecovery() const {
479 if (!FakeBufferForRecovery)
480 FakeBufferForRecovery
481 = llvm::MemoryBuffer::getMemBuffer("<<<INVALID BUFFER>>");
483 return FakeBufferForRecovery;
486 //===----------------------------------------------------------------------===//
487 // Methods to create new FileID's and macro expansions.
488 //===----------------------------------------------------------------------===//
490 /// createFileID - Create a new FileID for the specified ContentCache and
491 /// include position. This works regardless of whether the ContentCache
492 /// corresponds to a file or some other input source.
493 FileID SourceManager::createFileID(const ContentCache *File,
494 SourceLocation IncludePos,
495 SrcMgr::CharacteristicKind FileCharacter,
496 int LoadedID, unsigned LoadedOffset) {
498 assert(LoadedID != -1 && "Loading sentinel FileID");
499 unsigned Index = unsigned(-LoadedID) - 2;
500 assert(Index < LoadedSLocEntryTable.size() && "FileID out of range");
501 assert(!SLocEntryLoaded[Index] && "FileID already loaded");
502 LoadedSLocEntryTable[Index] = SLocEntry::get(LoadedOffset,
503 FileInfo::get(IncludePos, File, FileCharacter));
504 SLocEntryLoaded[Index] = true;
505 return FileID::get(LoadedID);
507 LocalSLocEntryTable.push_back(SLocEntry::get(NextLocalOffset,
508 FileInfo::get(IncludePos, File,
510 unsigned FileSize = File->getSize();
511 assert(NextLocalOffset + FileSize + 1 > NextLocalOffset &&
512 NextLocalOffset + FileSize + 1 <= CurrentLoadedOffset &&
513 "Ran out of source locations!");
514 // We do a +1 here because we want a SourceLocation that means "the end of the
515 // file", e.g. for the "no newline at the end of the file" diagnostic.
516 NextLocalOffset += FileSize + 1;
518 // Set LastFileIDLookup to the newly created file. The next getFileID call is
519 // almost guaranteed to be from that file.
520 FileID FID = FileID::get(LocalSLocEntryTable.size()-1);
521 return LastFileIDLookup = FID;
525 SourceManager::createMacroArgExpansionLoc(SourceLocation SpellingLoc,
526 SourceLocation ExpansionLoc,
527 unsigned TokLength) {
528 ExpansionInfo Info = ExpansionInfo::createForMacroArg(SpellingLoc,
530 return createExpansionLocImpl(Info, TokLength);
534 SourceManager::createExpansionLoc(SourceLocation SpellingLoc,
535 SourceLocation ExpansionLocStart,
536 SourceLocation ExpansionLocEnd,
539 unsigned LoadedOffset) {
540 ExpansionInfo Info = ExpansionInfo::create(SpellingLoc, ExpansionLocStart,
542 return createExpansionLocImpl(Info, TokLength, LoadedID, LoadedOffset);
546 SourceManager::createExpansionLocImpl(const ExpansionInfo &Info,
549 unsigned LoadedOffset) {
551 assert(LoadedID != -1 && "Loading sentinel FileID");
552 unsigned Index = unsigned(-LoadedID) - 2;
553 assert(Index < LoadedSLocEntryTable.size() && "FileID out of range");
554 assert(!SLocEntryLoaded[Index] && "FileID already loaded");
555 LoadedSLocEntryTable[Index] = SLocEntry::get(LoadedOffset, Info);
556 SLocEntryLoaded[Index] = true;
557 return SourceLocation::getMacroLoc(LoadedOffset);
559 LocalSLocEntryTable.push_back(SLocEntry::get(NextLocalOffset, Info));
560 assert(NextLocalOffset + TokLength + 1 > NextLocalOffset &&
561 NextLocalOffset + TokLength + 1 <= CurrentLoadedOffset &&
562 "Ran out of source locations!");
563 // See createFileID for that +1.
564 NextLocalOffset += TokLength + 1;
565 return SourceLocation::getMacroLoc(NextLocalOffset - (TokLength + 1));
568 const llvm::MemoryBuffer *
569 SourceManager::getMemoryBufferForFile(const FileEntry *File,
571 const SrcMgr::ContentCache *IR = getOrCreateContentCache(File);
572 assert(IR && "getOrCreateContentCache() cannot return NULL");
573 return IR->getBuffer(Diag, *this, SourceLocation(), Invalid);
576 void SourceManager::overrideFileContents(const FileEntry *SourceFile,
577 const llvm::MemoryBuffer *Buffer,
579 const SrcMgr::ContentCache *IR = getOrCreateContentCache(SourceFile);
580 assert(IR && "getOrCreateContentCache() cannot return NULL");
582 const_cast<SrcMgr::ContentCache *>(IR)->replaceBuffer(Buffer, DoNotFree);
585 void SourceManager::overrideFileContents(const FileEntry *SourceFile,
586 const FileEntry *NewFile) {
587 assert(SourceFile->getSize() == NewFile->getSize() &&
588 "Different sizes, use the FileManager to create a virtual file with "
590 assert(FileInfos.count(SourceFile) == 0 &&
591 "This function should be called at the initialization stage, before "
592 "any parsing occurs.");
593 OverriddenFiles[SourceFile] = NewFile;
596 StringRef SourceManager::getBufferData(FileID FID, bool *Invalid) const {
597 bool MyInvalid = false;
598 const SLocEntry &SLoc = getSLocEntry(FID, &MyInvalid);
599 if (!SLoc.isFile() || MyInvalid) {
602 return "<<<<<INVALID SOURCE LOCATION>>>>>";
605 const llvm::MemoryBuffer *Buf
606 = SLoc.getFile().getContentCache()->getBuffer(Diag, *this, SourceLocation(),
609 *Invalid = MyInvalid;
612 return "<<<<<INVALID SOURCE LOCATION>>>>>";
614 return Buf->getBuffer();
617 //===----------------------------------------------------------------------===//
618 // SourceLocation manipulation methods.
619 //===----------------------------------------------------------------------===//
621 /// \brief Return the FileID for a SourceLocation.
623 /// This is the cache-miss path of getFileID. Not as hot as that function, but
624 /// still very important. It is responsible for finding the entry in the
625 /// SLocEntry tables that contains the specified location.
626 FileID SourceManager::getFileIDSlow(unsigned SLocOffset) const {
628 return FileID::get(0);
630 // Now it is time to search for the correct file. See where the SLocOffset
631 // sits in the global view and consult local or loaded buffers for it.
632 if (SLocOffset < NextLocalOffset)
633 return getFileIDLocal(SLocOffset);
634 return getFileIDLoaded(SLocOffset);
637 /// \brief Return the FileID for a SourceLocation with a low offset.
639 /// This function knows that the SourceLocation is in a local buffer, not a
641 FileID SourceManager::getFileIDLocal(unsigned SLocOffset) const {
642 assert(SLocOffset < NextLocalOffset && "Bad function choice");
644 // After the first and second level caches, I see two common sorts of
645 // behavior: 1) a lot of searched FileID's are "near" the cached file
646 // location or are "near" the cached expansion location. 2) others are just
647 // completely random and may be a very long way away.
649 // To handle this, we do a linear search for up to 8 steps to catch #1 quickly
650 // then we fall back to a less cache efficient, but more scalable, binary
651 // search to find the location.
653 // See if this is near the file point - worst case we start scanning from the
654 // most newly created FileID.
655 std::vector<SrcMgr::SLocEntry>::const_iterator I;
657 if (LastFileIDLookup.ID < 0 ||
658 LocalSLocEntryTable[LastFileIDLookup.ID].getOffset() < SLocOffset) {
659 // Neither loc prunes our search.
660 I = LocalSLocEntryTable.end();
662 // Perhaps it is near the file point.
663 I = LocalSLocEntryTable.begin()+LastFileIDLookup.ID;
666 // Find the FileID that contains this. "I" is an iterator that points to a
667 // FileID whose offset is known to be larger than SLocOffset.
668 unsigned NumProbes = 0;
671 if (I->getOffset() <= SLocOffset) {
672 FileID Res = FileID::get(int(I - LocalSLocEntryTable.begin()));
674 // If this isn't an expansion, remember it. We have good locality across
676 if (!I->isExpansion())
677 LastFileIDLookup = Res;
678 NumLinearScans += NumProbes+1;
681 if (++NumProbes == 8)
685 // Convert "I" back into an index. We know that it is an entry whose index is
686 // larger than the offset we are looking for.
687 unsigned GreaterIndex = I - LocalSLocEntryTable.begin();
688 // LessIndex - This is the lower bound of the range that we're searching.
689 // We know that the offset corresponding to the FileID is is less than
691 unsigned LessIndex = 0;
694 bool Invalid = false;
695 unsigned MiddleIndex = (GreaterIndex-LessIndex)/2+LessIndex;
696 unsigned MidOffset = getLocalSLocEntry(MiddleIndex, &Invalid).getOffset();
698 return FileID::get(0);
702 // If the offset of the midpoint is too large, chop the high side of the
703 // range to the midpoint.
704 if (MidOffset > SLocOffset) {
705 GreaterIndex = MiddleIndex;
709 // If the middle index contains the value, succeed and return.
710 // FIXME: This could be made faster by using a function that's aware of
711 // being in the local area.
712 if (isOffsetInFileID(FileID::get(MiddleIndex), SLocOffset)) {
713 FileID Res = FileID::get(MiddleIndex);
715 // If this isn't a macro expansion, remember it. We have good locality
716 // across FileID lookups.
717 if (!LocalSLocEntryTable[MiddleIndex].isExpansion())
718 LastFileIDLookup = Res;
719 NumBinaryProbes += NumProbes;
723 // Otherwise, move the low-side up to the middle index.
724 LessIndex = MiddleIndex;
728 /// \brief Return the FileID for a SourceLocation with a high offset.
730 /// This function knows that the SourceLocation is in a loaded buffer, not a
732 FileID SourceManager::getFileIDLoaded(unsigned SLocOffset) const {
733 assert(SLocOffset >= CurrentLoadedOffset && "Bad function choice");
735 // Sanity checking, otherwise a bug may lead to hanging in release build.
736 if (SLocOffset < CurrentLoadedOffset)
739 // Essentially the same as the local case, but the loaded array is sorted
740 // in the other direction.
742 // First do a linear scan from the last lookup position, if possible.
744 int LastID = LastFileIDLookup.ID;
745 if (LastID >= 0 || getLoadedSLocEntryByID(LastID).getOffset() < SLocOffset)
748 I = (-LastID - 2) + 1;
751 for (NumProbes = 0; NumProbes < 8; ++NumProbes, ++I) {
752 // Make sure the entry is loaded!
753 const SrcMgr::SLocEntry &E = getLoadedSLocEntry(I);
754 if (E.getOffset() <= SLocOffset) {
755 FileID Res = FileID::get(-int(I) - 2);
757 if (!E.isExpansion())
758 LastFileIDLookup = Res;
759 NumLinearScans += NumProbes + 1;
764 // Linear scan failed. Do the binary search. Note the reverse sorting of the
765 // table: GreaterIndex is the one where the offset is greater, which is
766 // actually a lower index!
767 unsigned GreaterIndex = I;
768 unsigned LessIndex = LoadedSLocEntryTable.size();
772 unsigned MiddleIndex = (LessIndex - GreaterIndex) / 2 + GreaterIndex;
773 const SrcMgr::SLocEntry &E = getLoadedSLocEntry(MiddleIndex);
777 if (E.getOffset() > SLocOffset) {
778 GreaterIndex = MiddleIndex;
782 if (isOffsetInFileID(FileID::get(-int(MiddleIndex) - 2), SLocOffset)) {
783 FileID Res = FileID::get(-int(MiddleIndex) - 2);
784 if (!E.isExpansion())
785 LastFileIDLookup = Res;
786 NumBinaryProbes += NumProbes;
790 LessIndex = MiddleIndex;
794 SourceLocation SourceManager::
795 getExpansionLocSlowCase(SourceLocation Loc) const {
797 // Note: If Loc indicates an offset into a token that came from a macro
798 // expansion (e.g. the 5th character of the token) we do not want to add
799 // this offset when going to the expansion location. The expansion
800 // location is the macro invocation, which the offset has nothing to do
801 // with. This is unlike when we get the spelling loc, because the offset
802 // directly correspond to the token whose spelling we're inspecting.
803 Loc = getSLocEntry(getFileID(Loc)).getExpansion().getExpansionLocStart();
804 } while (!Loc.isFileID());
809 SourceLocation SourceManager::getSpellingLocSlowCase(SourceLocation Loc) const {
811 std::pair<FileID, unsigned> LocInfo = getDecomposedLoc(Loc);
812 Loc = getSLocEntry(LocInfo.first).getExpansion().getSpellingLoc();
813 Loc = Loc.getLocWithOffset(LocInfo.second);
814 } while (!Loc.isFileID());
818 SourceLocation SourceManager::getFileLocSlowCase(SourceLocation Loc) const {
820 if (isMacroArgExpansion(Loc))
821 Loc = getImmediateSpellingLoc(Loc);
823 Loc = getImmediateExpansionRange(Loc).first;
824 } while (!Loc.isFileID());
829 std::pair<FileID, unsigned>
830 SourceManager::getDecomposedExpansionLocSlowCase(
831 const SrcMgr::SLocEntry *E) const {
832 // If this is an expansion record, walk through all the expansion points.
837 Loc = E->getExpansion().getExpansionLocStart();
839 FID = getFileID(Loc);
840 E = &getSLocEntry(FID);
841 Offset = Loc.getOffset()-E->getOffset();
842 } while (!Loc.isFileID());
844 return std::make_pair(FID, Offset);
847 std::pair<FileID, unsigned>
848 SourceManager::getDecomposedSpellingLocSlowCase(const SrcMgr::SLocEntry *E,
849 unsigned Offset) const {
850 // If this is an expansion record, walk through all the expansion points.
854 Loc = E->getExpansion().getSpellingLoc();
855 Loc = Loc.getLocWithOffset(Offset);
857 FID = getFileID(Loc);
858 E = &getSLocEntry(FID);
859 Offset = Loc.getOffset()-E->getOffset();
860 } while (!Loc.isFileID());
862 return std::make_pair(FID, Offset);
865 /// getImmediateSpellingLoc - Given a SourceLocation object, return the
866 /// spelling location referenced by the ID. This is the first level down
867 /// towards the place where the characters that make up the lexed token can be
868 /// found. This should not generally be used by clients.
869 SourceLocation SourceManager::getImmediateSpellingLoc(SourceLocation Loc) const{
870 if (Loc.isFileID()) return Loc;
871 std::pair<FileID, unsigned> LocInfo = getDecomposedLoc(Loc);
872 Loc = getSLocEntry(LocInfo.first).getExpansion().getSpellingLoc();
873 return Loc.getLocWithOffset(LocInfo.second);
877 /// getImmediateExpansionRange - Loc is required to be an expansion location.
878 /// Return the start/end of the expansion information.
879 std::pair<SourceLocation,SourceLocation>
880 SourceManager::getImmediateExpansionRange(SourceLocation Loc) const {
881 assert(Loc.isMacroID() && "Not a macro expansion loc!");
882 const ExpansionInfo &Expansion = getSLocEntry(getFileID(Loc)).getExpansion();
883 return Expansion.getExpansionLocRange();
886 /// getExpansionRange - Given a SourceLocation object, return the range of
887 /// tokens covered by the expansion in the ultimate file.
888 std::pair<SourceLocation,SourceLocation>
889 SourceManager::getExpansionRange(SourceLocation Loc) const {
890 if (Loc.isFileID()) return std::make_pair(Loc, Loc);
892 std::pair<SourceLocation,SourceLocation> Res =
893 getImmediateExpansionRange(Loc);
895 // Fully resolve the start and end locations to their ultimate expansion
897 while (!Res.first.isFileID())
898 Res.first = getImmediateExpansionRange(Res.first).first;
899 while (!Res.second.isFileID())
900 Res.second = getImmediateExpansionRange(Res.second).second;
904 bool SourceManager::isMacroArgExpansion(SourceLocation Loc) const {
905 if (!Loc.isMacroID()) return false;
907 FileID FID = getFileID(Loc);
908 const SrcMgr::SLocEntry *E = &getSLocEntry(FID);
909 const SrcMgr::ExpansionInfo &Expansion = E->getExpansion();
910 return Expansion.isMacroArgExpansion();
914 //===----------------------------------------------------------------------===//
915 // Queries about the code at a SourceLocation.
916 //===----------------------------------------------------------------------===//
918 /// getCharacterData - Return a pointer to the start of the specified location
919 /// in the appropriate MemoryBuffer.
920 const char *SourceManager::getCharacterData(SourceLocation SL,
921 bool *Invalid) const {
922 // Note that this is a hot function in the getSpelling() path, which is
923 // heavily used by -E mode.
924 std::pair<FileID, unsigned> LocInfo = getDecomposedSpellingLoc(SL);
926 // Note that calling 'getBuffer()' may lazily page in a source file.
927 bool CharDataInvalid = false;
928 const SLocEntry &Entry = getSLocEntry(LocInfo.first, &CharDataInvalid);
929 if (CharDataInvalid || !Entry.isFile()) {
933 return "<<<<INVALID BUFFER>>>>";
935 const llvm::MemoryBuffer *Buffer
936 = Entry.getFile().getContentCache()
937 ->getBuffer(Diag, *this, SourceLocation(), &CharDataInvalid);
939 *Invalid = CharDataInvalid;
940 return Buffer->getBufferStart() + (CharDataInvalid? 0 : LocInfo.second);
944 /// getColumnNumber - Return the column # for the specified file position.
945 /// this is significantly cheaper to compute than the line number.
946 unsigned SourceManager::getColumnNumber(FileID FID, unsigned FilePos,
947 bool *Invalid) const {
948 bool MyInvalid = false;
949 const char *Buf = getBuffer(FID, &MyInvalid)->getBufferStart();
951 *Invalid = MyInvalid;
956 unsigned LineStart = FilePos;
957 while (LineStart && Buf[LineStart-1] != '\n' && Buf[LineStart-1] != '\r')
959 return FilePos-LineStart+1;
962 // isInvalid - Return the result of calling loc.isInvalid(), and
963 // if Invalid is not null, set its value to same.
964 static bool isInvalid(SourceLocation Loc, bool *Invalid) {
965 bool MyInvalid = Loc.isInvalid();
967 *Invalid = MyInvalid;
971 unsigned SourceManager::getSpellingColumnNumber(SourceLocation Loc,
972 bool *Invalid) const {
973 if (isInvalid(Loc, Invalid)) return 0;
974 std::pair<FileID, unsigned> LocInfo = getDecomposedSpellingLoc(Loc);
975 return getColumnNumber(LocInfo.first, LocInfo.second, Invalid);
978 unsigned SourceManager::getExpansionColumnNumber(SourceLocation Loc,
979 bool *Invalid) const {
980 if (isInvalid(Loc, Invalid)) return 0;
981 std::pair<FileID, unsigned> LocInfo = getDecomposedExpansionLoc(Loc);
982 return getColumnNumber(LocInfo.first, LocInfo.second, Invalid);
985 unsigned SourceManager::getPresumedColumnNumber(SourceLocation Loc,
986 bool *Invalid) const {
987 if (isInvalid(Loc, Invalid)) return 0;
988 return getPresumedLoc(Loc).getColumn();
991 static LLVM_ATTRIBUTE_NOINLINE void
992 ComputeLineNumbers(DiagnosticsEngine &Diag, ContentCache *FI,
993 llvm::BumpPtrAllocator &Alloc,
994 const SourceManager &SM, bool &Invalid);
995 static void ComputeLineNumbers(DiagnosticsEngine &Diag, ContentCache *FI,
996 llvm::BumpPtrAllocator &Alloc,
997 const SourceManager &SM, bool &Invalid) {
998 // Note that calling 'getBuffer()' may lazily page in the file.
999 const MemoryBuffer *Buffer = FI->getBuffer(Diag, SM, SourceLocation(),
1004 // Find the file offsets of all of the *physical* source lines. This does
1005 // not look at trigraphs, escaped newlines, or anything else tricky.
1006 SmallVector<unsigned, 256> LineOffsets;
1008 // Line #1 starts at char 0.
1009 LineOffsets.push_back(0);
1011 const unsigned char *Buf = (const unsigned char *)Buffer->getBufferStart();
1012 const unsigned char *End = (const unsigned char *)Buffer->getBufferEnd();
1015 // Skip over the contents of the line.
1016 // TODO: Vectorize this? This is very performance sensitive for programs
1017 // with lots of diagnostics and in -E mode.
1018 const unsigned char *NextBuf = (const unsigned char *)Buf;
1019 while (*NextBuf != '\n' && *NextBuf != '\r' && *NextBuf != '\0')
1021 Offs += NextBuf-Buf;
1024 if (Buf[0] == '\n' || Buf[0] == '\r') {
1025 // If this is \n\r or \r\n, skip both characters.
1026 if ((Buf[1] == '\n' || Buf[1] == '\r') && Buf[0] != Buf[1])
1029 LineOffsets.push_back(Offs);
1031 // Otherwise, this is a null. If end of file, exit.
1032 if (Buf == End) break;
1033 // Otherwise, skip the null.
1038 // Copy the offsets into the FileInfo structure.
1039 FI->NumLines = LineOffsets.size();
1040 FI->SourceLineCache = Alloc.Allocate<unsigned>(LineOffsets.size());
1041 std::copy(LineOffsets.begin(), LineOffsets.end(), FI->SourceLineCache);
1044 /// getLineNumber - Given a SourceLocation, return the spelling line number
1045 /// for the position indicated. This requires building and caching a table of
1046 /// line offsets for the MemoryBuffer, so this is not cheap: use only when
1047 /// about to emit a diagnostic.
1048 unsigned SourceManager::getLineNumber(FileID FID, unsigned FilePos,
1049 bool *Invalid) const {
1050 if (FID.isInvalid()) {
1056 ContentCache *Content;
1057 if (LastLineNoFileIDQuery == FID)
1058 Content = LastLineNoContentCache;
1060 bool MyInvalid = false;
1061 const SLocEntry &Entry = getSLocEntry(FID, &MyInvalid);
1062 if (MyInvalid || !Entry.isFile()) {
1068 Content = const_cast<ContentCache*>(Entry.getFile().getContentCache());
1071 // If this is the first use of line information for this buffer, compute the
1072 /// SourceLineCache for it on demand.
1073 if (Content->SourceLineCache == 0) {
1074 bool MyInvalid = false;
1075 ComputeLineNumbers(Diag, Content, ContentCacheAlloc, *this, MyInvalid);
1077 *Invalid = MyInvalid;
1083 // Okay, we know we have a line number table. Do a binary search to find the
1084 // line number that this character position lands on.
1085 unsigned *SourceLineCache = Content->SourceLineCache;
1086 unsigned *SourceLineCacheStart = SourceLineCache;
1087 unsigned *SourceLineCacheEnd = SourceLineCache + Content->NumLines;
1089 unsigned QueriedFilePos = FilePos+1;
1091 // FIXME: I would like to be convinced that this code is worth being as
1092 // complicated as it is, binary search isn't that slow.
1094 // If it is worth being optimized, then in my opinion it could be more
1095 // performant, simpler, and more obviously correct by just "galloping" outward
1096 // from the queried file position. In fact, this could be incorporated into a
1097 // generic algorithm such as lower_bound_with_hint.
1099 // If someone gives me a test case where this matters, and I will do it! - DWD
1101 // If the previous query was to the same file, we know both the file pos from
1102 // that query and the line number returned. This allows us to narrow the
1103 // search space from the entire file to something near the match.
1104 if (LastLineNoFileIDQuery == FID) {
1105 if (QueriedFilePos >= LastLineNoFilePos) {
1106 // FIXME: Potential overflow?
1107 SourceLineCache = SourceLineCache+LastLineNoResult-1;
1109 // The query is likely to be nearby the previous one. Here we check to
1110 // see if it is within 5, 10 or 20 lines. It can be far away in cases
1111 // where big comment blocks and vertical whitespace eat up lines but
1112 // contribute no tokens.
1113 if (SourceLineCache+5 < SourceLineCacheEnd) {
1114 if (SourceLineCache[5] > QueriedFilePos)
1115 SourceLineCacheEnd = SourceLineCache+5;
1116 else if (SourceLineCache+10 < SourceLineCacheEnd) {
1117 if (SourceLineCache[10] > QueriedFilePos)
1118 SourceLineCacheEnd = SourceLineCache+10;
1119 else if (SourceLineCache+20 < SourceLineCacheEnd) {
1120 if (SourceLineCache[20] > QueriedFilePos)
1121 SourceLineCacheEnd = SourceLineCache+20;
1126 if (LastLineNoResult < Content->NumLines)
1127 SourceLineCacheEnd = SourceLineCache+LastLineNoResult+1;
1131 // If the spread is large, do a "radix" test as our initial guess, based on
1132 // the assumption that lines average to approximately the same length.
1133 // NOTE: This is currently disabled, as it does not appear to be profitable in
1134 // initial measurements.
1135 if (0 && SourceLineCacheEnd-SourceLineCache > 20) {
1136 unsigned FileLen = Content->SourceLineCache[Content->NumLines-1];
1138 // Take a stab at guessing where it is.
1139 unsigned ApproxPos = Content->NumLines*QueriedFilePos / FileLen;
1141 // Check for -10 and +10 lines.
1142 unsigned LowerBound = std::max(int(ApproxPos-10), 0);
1143 unsigned UpperBound = std::min(ApproxPos+10, FileLen);
1145 // If the computed lower bound is less than the query location, move it in.
1146 if (SourceLineCache < SourceLineCacheStart+LowerBound &&
1147 SourceLineCacheStart[LowerBound] < QueriedFilePos)
1148 SourceLineCache = SourceLineCacheStart+LowerBound;
1150 // If the computed upper bound is greater than the query location, move it.
1151 if (SourceLineCacheEnd > SourceLineCacheStart+UpperBound &&
1152 SourceLineCacheStart[UpperBound] >= QueriedFilePos)
1153 SourceLineCacheEnd = SourceLineCacheStart+UpperBound;
1157 = std::lower_bound(SourceLineCache, SourceLineCacheEnd, QueriedFilePos);
1158 unsigned LineNo = Pos-SourceLineCacheStart;
1160 LastLineNoFileIDQuery = FID;
1161 LastLineNoContentCache = Content;
1162 LastLineNoFilePos = QueriedFilePos;
1163 LastLineNoResult = LineNo;
1167 unsigned SourceManager::getSpellingLineNumber(SourceLocation Loc,
1168 bool *Invalid) const {
1169 if (isInvalid(Loc, Invalid)) return 0;
1170 std::pair<FileID, unsigned> LocInfo = getDecomposedSpellingLoc(Loc);
1171 return getLineNumber(LocInfo.first, LocInfo.second);
1173 unsigned SourceManager::getExpansionLineNumber(SourceLocation Loc,
1174 bool *Invalid) const {
1175 if (isInvalid(Loc, Invalid)) return 0;
1176 std::pair<FileID, unsigned> LocInfo = getDecomposedExpansionLoc(Loc);
1177 return getLineNumber(LocInfo.first, LocInfo.second);
1179 unsigned SourceManager::getPresumedLineNumber(SourceLocation Loc,
1180 bool *Invalid) const {
1181 if (isInvalid(Loc, Invalid)) return 0;
1182 return getPresumedLoc(Loc).getLine();
1185 /// getFileCharacteristic - return the file characteristic of the specified
1186 /// source location, indicating whether this is a normal file, a system
1187 /// header, or an "implicit extern C" system header.
1189 /// This state can be modified with flags on GNU linemarker directives like:
1191 /// which changes all source locations in the current file after that to be
1192 /// considered to be from a system header.
1193 SrcMgr::CharacteristicKind
1194 SourceManager::getFileCharacteristic(SourceLocation Loc) const {
1195 assert(!Loc.isInvalid() && "Can't get file characteristic of invalid loc!");
1196 std::pair<FileID, unsigned> LocInfo = getDecomposedExpansionLoc(Loc);
1197 bool Invalid = false;
1198 const SLocEntry &SEntry = getSLocEntry(LocInfo.first, &Invalid);
1199 if (Invalid || !SEntry.isFile())
1202 const SrcMgr::FileInfo &FI = SEntry.getFile();
1204 // If there are no #line directives in this file, just return the whole-file
1206 if (!FI.hasLineDirectives())
1207 return FI.getFileCharacteristic();
1209 assert(LineTable && "Can't have linetable entries without a LineTable!");
1210 // See if there is a #line directive before the location.
1211 const LineEntry *Entry =
1212 LineTable->FindNearestLineEntry(LocInfo.first.ID, LocInfo.second);
1214 // If this is before the first line marker, use the file characteristic.
1216 return FI.getFileCharacteristic();
1218 return Entry->FileKind;
1221 /// Return the filename or buffer identifier of the buffer the location is in.
1222 /// Note that this name does not respect #line directives. Use getPresumedLoc
1223 /// for normal clients.
1224 const char *SourceManager::getBufferName(SourceLocation Loc,
1225 bool *Invalid) const {
1226 if (isInvalid(Loc, Invalid)) return "<invalid loc>";
1228 return getBuffer(getFileID(Loc), Invalid)->getBufferIdentifier();
1232 /// getPresumedLoc - This method returns the "presumed" location of a
1233 /// SourceLocation specifies. A "presumed location" can be modified by #line
1234 /// or GNU line marker directives. This provides a view on the data that a
1235 /// user should see in diagnostics, for example.
1237 /// Note that a presumed location is always given as the expansion point of an
1238 /// expansion location, not at the spelling location.
1239 PresumedLoc SourceManager::getPresumedLoc(SourceLocation Loc) const {
1240 if (Loc.isInvalid()) return PresumedLoc();
1242 // Presumed locations are always for expansion points.
1243 std::pair<FileID, unsigned> LocInfo = getDecomposedExpansionLoc(Loc);
1245 bool Invalid = false;
1246 const SLocEntry &Entry = getSLocEntry(LocInfo.first, &Invalid);
1247 if (Invalid || !Entry.isFile())
1248 return PresumedLoc();
1250 const SrcMgr::FileInfo &FI = Entry.getFile();
1251 const SrcMgr::ContentCache *C = FI.getContentCache();
1253 // To get the source name, first consult the FileEntry (if one exists)
1254 // before the MemBuffer as this will avoid unnecessarily paging in the
1256 const char *Filename;
1258 Filename = C->OrigEntry->getName();
1260 Filename = C->getBuffer(Diag, *this)->getBufferIdentifier();
1262 unsigned LineNo = getLineNumber(LocInfo.first, LocInfo.second, &Invalid);
1264 return PresumedLoc();
1265 unsigned ColNo = getColumnNumber(LocInfo.first, LocInfo.second, &Invalid);
1267 return PresumedLoc();
1269 SourceLocation IncludeLoc = FI.getIncludeLoc();
1271 // If we have #line directives in this file, update and overwrite the physical
1272 // location info if appropriate.
1273 if (FI.hasLineDirectives()) {
1274 assert(LineTable && "Can't have linetable entries without a LineTable!");
1275 // See if there is a #line directive before this. If so, get it.
1276 if (const LineEntry *Entry =
1277 LineTable->FindNearestLineEntry(LocInfo.first.ID, LocInfo.second)) {
1278 // If the LineEntry indicates a filename, use it.
1279 if (Entry->FilenameID != -1)
1280 Filename = LineTable->getFilename(Entry->FilenameID);
1282 // Use the line number specified by the LineEntry. This line number may
1283 // be multiple lines down from the line entry. Add the difference in
1284 // physical line numbers from the query point and the line marker to the
1286 unsigned MarkerLineNo = getLineNumber(LocInfo.first, Entry->FileOffset);
1287 LineNo = Entry->LineNo + (LineNo-MarkerLineNo-1);
1289 // Note that column numbers are not molested by line markers.
1291 // Handle virtual #include manipulation.
1292 if (Entry->IncludeOffset) {
1293 IncludeLoc = getLocForStartOfFile(LocInfo.first);
1294 IncludeLoc = IncludeLoc.getLocWithOffset(Entry->IncludeOffset);
1299 return PresumedLoc(Filename, LineNo, ColNo, IncludeLoc);
1302 /// \brief The size of the SLocEnty that \arg FID represents.
1303 unsigned SourceManager::getFileIDSize(FileID FID) const {
1304 bool Invalid = false;
1305 const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid);
1310 unsigned NextOffset;
1311 if ((ID > 0 && unsigned(ID+1) == local_sloc_entry_size()))
1312 NextOffset = getNextLocalOffset();
1313 else if (ID+1 == -1)
1314 NextOffset = MaxLoadedOffset;
1316 NextOffset = getSLocEntry(FileID::get(ID+1)).getOffset();
1318 return NextOffset - Entry.getOffset() - 1;
1321 //===----------------------------------------------------------------------===//
1322 // Other miscellaneous methods.
1323 //===----------------------------------------------------------------------===//
1325 /// \brief Retrieve the inode for the given file entry, if possible.
1327 /// This routine involves a system call, and therefore should only be used
1328 /// in non-performance-critical code.
1329 static llvm::Optional<ino_t> getActualFileInode(const FileEntry *File) {
1331 return llvm::Optional<ino_t>();
1333 struct stat StatBuf;
1334 if (::stat(File->getName(), &StatBuf))
1335 return llvm::Optional<ino_t>();
1337 return StatBuf.st_ino;
1340 /// \brief Get the source location for the given file:line:col triplet.
1342 /// If the source file is included multiple times, the source location will
1343 /// be based upon an arbitrary inclusion.
1344 SourceLocation SourceManager::translateFileLineCol(const FileEntry *SourceFile,
1346 unsigned Col) const {
1347 assert(SourceFile && "Null source file!");
1348 assert(Line && Col && "Line and column should start from 1!");
1350 FileID FirstFID = translateFile(SourceFile);
1351 return translateLineCol(FirstFID, Line, Col);
1354 /// \brief Get the FileID for the given file.
1356 /// If the source file is included multiple times, the FileID will be the
1357 /// first inclusion.
1358 FileID SourceManager::translateFile(const FileEntry *SourceFile) const {
1359 assert(SourceFile && "Null source file!");
1361 // Find the first file ID that corresponds to the given file.
1364 // First, check the main file ID, since it is common to look for a
1365 // location in the main file.
1366 llvm::Optional<ino_t> SourceFileInode;
1367 llvm::Optional<StringRef> SourceFileName;
1368 if (!MainFileID.isInvalid()) {
1369 bool Invalid = false;
1370 const SLocEntry &MainSLoc = getSLocEntry(MainFileID, &Invalid);
1374 if (MainSLoc.isFile()) {
1375 const ContentCache *MainContentCache
1376 = MainSLoc.getFile().getContentCache();
1377 if (!MainContentCache) {
1378 // Can't do anything
1379 } else if (MainContentCache->OrigEntry == SourceFile) {
1380 FirstFID = MainFileID;
1382 // Fall back: check whether we have the same base name and inode
1383 // as the main file.
1384 const FileEntry *MainFile = MainContentCache->OrigEntry;
1385 SourceFileName = llvm::sys::path::filename(SourceFile->getName());
1386 if (*SourceFileName == llvm::sys::path::filename(MainFile->getName())) {
1387 SourceFileInode = getActualFileInode(SourceFile);
1388 if (SourceFileInode) {
1389 if (llvm::Optional<ino_t> MainFileInode
1390 = getActualFileInode(MainFile)) {
1391 if (*SourceFileInode == *MainFileInode) {
1392 FirstFID = MainFileID;
1393 SourceFile = MainFile;
1402 if (FirstFID.isInvalid()) {
1403 // The location we're looking for isn't in the main file; look
1404 // through all of the local source locations.
1405 for (unsigned I = 0, N = local_sloc_entry_size(); I != N; ++I) {
1406 bool Invalid = false;
1407 const SLocEntry &SLoc = getLocalSLocEntry(I, &Invalid);
1411 if (SLoc.isFile() &&
1412 SLoc.getFile().getContentCache() &&
1413 SLoc.getFile().getContentCache()->OrigEntry == SourceFile) {
1414 FirstFID = FileID::get(I);
1418 // If that still didn't help, try the modules.
1419 if (FirstFID.isInvalid()) {
1420 for (unsigned I = 0, N = loaded_sloc_entry_size(); I != N; ++I) {
1421 const SLocEntry &SLoc = getLoadedSLocEntry(I);
1422 if (SLoc.isFile() &&
1423 SLoc.getFile().getContentCache() &&
1424 SLoc.getFile().getContentCache()->OrigEntry == SourceFile) {
1425 FirstFID = FileID::get(-int(I) - 2);
1432 // If we haven't found what we want yet, try again, but this time stat()
1433 // each of the files in case the files have changed since we originally
1435 if (FirstFID.isInvalid() &&
1437 (SourceFileName = llvm::sys::path::filename(SourceFile->getName()))) &&
1439 (SourceFileInode = getActualFileInode(SourceFile)))) {
1440 bool Invalid = false;
1441 for (unsigned I = 0, N = local_sloc_entry_size(); I != N; ++I) {
1444 const SLocEntry &SLoc = getSLocEntry(IFileID, &Invalid);
1448 if (SLoc.isFile()) {
1449 const ContentCache *FileContentCache
1450 = SLoc.getFile().getContentCache();
1451 const FileEntry *Entry =FileContentCache? FileContentCache->OrigEntry : 0;
1453 *SourceFileName == llvm::sys::path::filename(Entry->getName())) {
1454 if (llvm::Optional<ino_t> EntryInode = getActualFileInode(Entry)) {
1455 if (*SourceFileInode == *EntryInode) {
1456 FirstFID = FileID::get(I);
1469 /// \brief Get the source location in \arg FID for the given line:col.
1470 /// Returns null location if \arg FID is not a file SLocEntry.
1471 SourceLocation SourceManager::translateLineCol(FileID FID,
1473 unsigned Col) const {
1474 if (FID.isInvalid())
1475 return SourceLocation();
1477 bool Invalid = false;
1478 const SLocEntry &Entry = getSLocEntry(FID, &Invalid);
1480 return SourceLocation();
1482 if (!Entry.isFile())
1483 return SourceLocation();
1485 SourceLocation FileLoc = SourceLocation::getFileLoc(Entry.getOffset());
1487 if (Line == 1 && Col == 1)
1490 ContentCache *Content
1491 = const_cast<ContentCache *>(Entry.getFile().getContentCache());
1493 return SourceLocation();
1495 // If this is the first use of line information for this buffer, compute the
1496 // SourceLineCache for it on demand.
1497 if (Content->SourceLineCache == 0) {
1498 bool MyInvalid = false;
1499 ComputeLineNumbers(Diag, Content, ContentCacheAlloc, *this, MyInvalid);
1501 return SourceLocation();
1504 if (Line > Content->NumLines) {
1505 unsigned Size = Content->getBuffer(Diag, *this)->getBufferSize();
1508 return FileLoc.getLocWithOffset(Size);
1511 unsigned FilePos = Content->SourceLineCache[Line - 1];
1512 const char *Buf = Content->getBuffer(Diag, *this)->getBufferStart() + FilePos;
1513 unsigned BufLength = Content->getBuffer(Diag, *this)->getBufferEnd() - Buf;
1515 return FileLoc.getLocWithOffset(FilePos);
1519 // Check that the given column is valid.
1520 while (i < BufLength-1 && i < Col-1 && Buf[i] != '\n' && Buf[i] != '\r')
1523 return FileLoc.getLocWithOffset(FilePos + i);
1525 return FileLoc.getLocWithOffset(FilePos + Col - 1);
1528 /// \brief Compute a map of macro argument chunks to their expanded source
1529 /// location. Chunks that are not part of a macro argument will map to an
1530 /// invalid source location. e.g. if a file contains one macro argument at
1531 /// offset 100 with length 10, this is how the map will be formed:
1532 /// 0 -> SourceLocation()
1533 /// 100 -> Expanded macro arg location
1534 /// 110 -> SourceLocation()
1535 void SourceManager::computeMacroArgsCache(MacroArgsMap *&CachePtr,
1537 assert(!FID.isInvalid());
1540 CachePtr = new MacroArgsMap();
1541 MacroArgsMap &MacroArgsCache = *CachePtr;
1542 // Initially no macro argument chunk is present.
1543 MacroArgsCache.insert(std::make_pair(0, SourceLocation()));
1548 // Stop if there are no more FileIDs to check.
1550 if (unsigned(ID) >= local_sloc_entry_size())
1552 } else if (ID == -1) {
1556 const SrcMgr::SLocEntry &Entry = getSLocEntryByID(ID);
1557 if (Entry.isFile()) {
1558 SourceLocation IncludeLoc = Entry.getFile().getIncludeLoc();
1559 if (IncludeLoc.isInvalid())
1561 if (!isInFileID(IncludeLoc, FID))
1562 return; // No more files/macros that may be "contained" in this file.
1564 // Skip the files/macros of the #include'd file, we only care about macros
1565 // that lexed macro arguments from our file.
1566 if (Entry.getFile().NumCreatedFIDs)
1567 ID += Entry.getFile().NumCreatedFIDs - 1/*because of next ++ID*/;
1571 if (!Entry.getExpansion().isMacroArgExpansion())
1574 SourceLocation SpellLoc =
1575 getSpellingLoc(Entry.getExpansion().getSpellingLoc());
1577 if (!isInFileID(SpellLoc, FID, &BeginOffs))
1578 return; // No more files/macros that may be "contained" in this file.
1579 unsigned EndOffs = BeginOffs + getFileIDSize(FileID::get(ID));
1581 // Add a new chunk for this macro argument. A previous macro argument chunk
1582 // may have been lexed again, so e.g. if the map is
1583 // 0 -> SourceLocation()
1584 // 100 -> Expanded loc #1
1585 // 110 -> SourceLocation()
1586 // and we found a new macro FileID that lexed from offet 105 with length 3,
1587 // the new map will be:
1588 // 0 -> SourceLocation()
1589 // 100 -> Expanded loc #1
1590 // 105 -> Expanded loc #2
1591 // 108 -> Expanded loc #1
1592 // 110 -> SourceLocation()
1594 // Since re-lexed macro chunks will always be the same size or less of
1595 // previous chunks, we only need to find where the ending of the new macro
1596 // chunk is mapped to and update the map with new begin/end mappings.
1598 MacroArgsMap::iterator I = MacroArgsCache.upper_bound(EndOffs);
1600 SourceLocation EndOffsMappedLoc = I->second;
1601 MacroArgsCache[BeginOffs] = SourceLocation::getMacroLoc(Entry.getOffset());
1602 MacroArgsCache[EndOffs] = EndOffsMappedLoc;
1606 /// \brief If \arg Loc points inside a function macro argument, the returned
1607 /// location will be the macro location in which the argument was expanded.
1608 /// If a macro argument is used multiple times, the expanded location will
1609 /// be at the first expansion of the argument.
1613 /// Passing a file location pointing at 'foo', will yield a macro location
1614 /// where 'foo' was expanded into.
1616 SourceManager::getMacroArgExpandedLocation(SourceLocation Loc) const {
1617 if (Loc.isInvalid() || !Loc.isFileID())
1622 llvm::tie(FID, Offset) = getDecomposedLoc(Loc);
1623 if (FID.isInvalid())
1626 MacroArgsMap *&MacroArgsCache = MacroArgsCacheMap[FID];
1627 if (!MacroArgsCache)
1628 computeMacroArgsCache(MacroArgsCache, FID);
1630 assert(!MacroArgsCache->empty());
1631 MacroArgsMap::iterator I = MacroArgsCache->upper_bound(Offset);
1634 unsigned MacroArgBeginOffs = I->first;
1635 SourceLocation MacroArgExpandedLoc = I->second;
1636 if (MacroArgExpandedLoc.isValid())
1637 return MacroArgExpandedLoc.getLocWithOffset(Offset - MacroArgBeginOffs);
1642 /// Given a decomposed source location, move it up the include/expansion stack
1643 /// to the parent source location. If this is possible, return the decomposed
1644 /// version of the parent in Loc and return false. If Loc is the top-level
1645 /// entry, return true and don't modify it.
1646 static bool MoveUpIncludeHierarchy(std::pair<FileID, unsigned> &Loc,
1647 const SourceManager &SM) {
1648 SourceLocation UpperLoc;
1649 const SrcMgr::SLocEntry &Entry = SM.getSLocEntry(Loc.first);
1650 if (Entry.isExpansion())
1651 UpperLoc = Entry.getExpansion().getExpansionLocEnd();
1653 UpperLoc = Entry.getFile().getIncludeLoc();
1655 if (UpperLoc.isInvalid())
1656 return true; // We reached the top.
1658 Loc = SM.getDecomposedLoc(UpperLoc);
1663 /// \brief Determines the order of 2 source locations in the translation unit.
1665 /// \returns true if LHS source location comes before RHS, false otherwise.
1666 bool SourceManager::isBeforeInTranslationUnit(SourceLocation LHS,
1667 SourceLocation RHS) const {
1668 assert(LHS.isValid() && RHS.isValid() && "Passed invalid source location!");
1672 std::pair<FileID, unsigned> LOffs = getDecomposedLoc(LHS);
1673 std::pair<FileID, unsigned> ROffs = getDecomposedLoc(RHS);
1675 // If the source locations are in the same file, just compare offsets.
1676 if (LOffs.first == ROffs.first)
1677 return LOffs.second < ROffs.second;
1679 // If we are comparing a source location with multiple locations in the same
1680 // file, we get a big win by caching the result.
1681 if (IsBeforeInTUCache.isCacheValid(LOffs.first, ROffs.first))
1682 return IsBeforeInTUCache.getCachedResult(LOffs.second, ROffs.second);
1684 // Okay, we missed in the cache, start updating the cache for this query.
1685 IsBeforeInTUCache.setQueryFIDs(LOffs.first, ROffs.first,
1686 /*isLFIDBeforeRFID=*/LOffs.first.ID < ROffs.first.ID);
1688 // We need to find the common ancestor. The only way of doing this is to
1689 // build the complete include chain for one and then walking up the chain
1690 // of the other looking for a match.
1691 // We use a map from FileID to Offset to store the chain. Easier than writing
1692 // a custom set hash info that only depends on the first part of a pair.
1693 typedef llvm::DenseMap<FileID, unsigned> LocSet;
1696 LChain.insert(LOffs);
1697 // We catch the case where LOffs is in a file included by ROffs and
1698 // quit early. The other way round unfortunately remains suboptimal.
1699 } while (LOffs.first != ROffs.first && !MoveUpIncludeHierarchy(LOffs, *this));
1701 while((I = LChain.find(ROffs.first)) == LChain.end()) {
1702 if (MoveUpIncludeHierarchy(ROffs, *this))
1703 break; // Met at topmost file.
1705 if (I != LChain.end())
1708 // If we exited because we found a nearest common ancestor, compare the
1709 // locations within the common file and cache them.
1710 if (LOffs.first == ROffs.first) {
1711 IsBeforeInTUCache.setCommonLoc(LOffs.first, LOffs.second, ROffs.second);
1712 return IsBeforeInTUCache.getCachedResult(LOffs.second, ROffs.second);
1715 // This can happen if a location is in a built-ins buffer.
1717 // Clear the lookup cache, it depends on a common location.
1718 IsBeforeInTUCache.clear();
1719 bool LIsBuiltins = strcmp("<built-in>",
1720 getBuffer(LOffs.first)->getBufferIdentifier()) == 0;
1721 bool RIsBuiltins = strcmp("<built-in>",
1722 getBuffer(ROffs.first)->getBufferIdentifier()) == 0;
1723 // built-in is before non-built-in
1724 if (LIsBuiltins != RIsBuiltins)
1726 assert(LIsBuiltins && RIsBuiltins &&
1727 "Non-built-in locations must be rooted in the main file");
1728 // Both are in built-in buffers, but from different files. We just claim that
1729 // lower IDs come first.
1730 return LOffs.first < ROffs.first;
1733 /// PrintStats - Print statistics to stderr.
1735 void SourceManager::PrintStats() const {
1736 llvm::errs() << "\n*** Source Manager Stats:\n";
1737 llvm::errs() << FileInfos.size() << " files mapped, " << MemBufferInfos.size()
1738 << " mem buffers mapped.\n";
1739 llvm::errs() << LocalSLocEntryTable.size() << " local SLocEntry's allocated ("
1740 << llvm::capacity_in_bytes(LocalSLocEntryTable)
1741 << " bytes of capacity), "
1742 << NextLocalOffset << "B of Sloc address space used.\n";
1743 llvm::errs() << LoadedSLocEntryTable.size()
1744 << " loaded SLocEntries allocated, "
1745 << MaxLoadedOffset - CurrentLoadedOffset
1746 << "B of Sloc address space used.\n";
1748 unsigned NumLineNumsComputed = 0;
1749 unsigned NumFileBytesMapped = 0;
1750 for (fileinfo_iterator I = fileinfo_begin(), E = fileinfo_end(); I != E; ++I){
1751 NumLineNumsComputed += I->second->SourceLineCache != 0;
1752 NumFileBytesMapped += I->second->getSizeBytesMapped();
1754 unsigned NumMacroArgsComputed = MacroArgsCacheMap.size();
1756 llvm::errs() << NumFileBytesMapped << " bytes of files mapped, "
1757 << NumLineNumsComputed << " files with line #'s computed, "
1758 << NumMacroArgsComputed << " files with macro args computed.\n";
1759 llvm::errs() << "FileID scans: " << NumLinearScans << " linear, "
1760 << NumBinaryProbes << " binary.\n";
1763 ExternalSLocEntrySource::~ExternalSLocEntrySource() { }
1765 /// Return the amount of memory used by memory buffers, breaking down
1766 /// by heap-backed versus mmap'ed memory.
1767 SourceManager::MemoryBufferSizes SourceManager::getMemoryBufferSizes() const {
1768 size_t malloc_bytes = 0;
1769 size_t mmap_bytes = 0;
1771 for (unsigned i = 0, e = MemBufferInfos.size(); i != e; ++i)
1772 if (size_t sized_mapped = MemBufferInfos[i]->getSizeBytesMapped())
1773 switch (MemBufferInfos[i]->getMemoryBufferKind()) {
1774 case llvm::MemoryBuffer::MemoryBuffer_MMap:
1775 mmap_bytes += sized_mapped;
1777 case llvm::MemoryBuffer::MemoryBuffer_Malloc:
1778 malloc_bytes += sized_mapped;
1782 return MemoryBufferSizes(malloc_bytes, mmap_bytes);
1785 size_t SourceManager::getDataStructureSizes() const {
1786 return llvm::capacity_in_bytes(MemBufferInfos)
1787 + llvm::capacity_in_bytes(LocalSLocEntryTable)
1788 + llvm::capacity_in_bytes(LoadedSLocEntryTable)
1789 + llvm::capacity_in_bytes(SLocEntryLoaded)
1790 + llvm::capacity_in_bytes(FileInfos)
1791 + llvm::capacity_in_bytes(OverriddenFiles);