SourceManager.cpp revision c3cd6f7a5d33ad44f6c9cf4faa7046c77baa128e
1//===--- SourceManager.cpp - Track and cache source files -----------------===// 2// 3// The LLVM Compiler Infrastructure 4// 5// This file is distributed under the University of Illinois Open Source 6// License. See LICENSE.TXT for details. 7// 8//===----------------------------------------------------------------------===// 9// 10// This file implements the SourceManager interface. 11// 12//===----------------------------------------------------------------------===// 13 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" 26#include <algorithm> 27#include <cstring> 28#include <string> 29#include <sys/stat.h> 30 31using namespace clang; 32using namespace SrcMgr; 33using llvm::MemoryBuffer; 34 35//===----------------------------------------------------------------------===// 36// SourceManager Helper Classes 37//===----------------------------------------------------------------------===// 38 39ContentCache::~ContentCache() { 40 if (shouldFreeBuffer()) 41 delete Buffer.getPointer(); 42} 43 44/// getSizeBytesMapped - Returns the number of bytes actually mapped for this 45/// ContentCache. This can be 0 if the MemBuffer was not actually expanded. 46unsigned ContentCache::getSizeBytesMapped() const { 47 return Buffer.getPointer() ? Buffer.getPointer()->getBufferSize() : 0; 48} 49 50/// Returns the kind of memory used to back the memory buffer for 51/// this content cache. This is used for performance analysis. 52llvm::MemoryBuffer::BufferKind ContentCache::getMemoryBufferKind() const { 53 assert(Buffer.getPointer()); 54 55 // Should be unreachable, but keep for sanity. 56 if (!Buffer.getPointer()) 57 return llvm::MemoryBuffer::MemoryBuffer_Malloc; 58 59 const llvm::MemoryBuffer *buf = Buffer.getPointer(); 60 return buf->getBufferKind(); 61} 62 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. 67unsigned ContentCache::getSize() const { 68 return Buffer.getPointer() ? (unsigned) Buffer.getPointer()->getBufferSize() 69 : (unsigned) ContentsEntry->getSize(); 70} 71 72void ContentCache::replaceBuffer(const llvm::MemoryBuffer *B, 73 bool DoNotFree) { 74 if (B && B == Buffer.getPointer()) { 75 assert(0 && "Replacing with the same buffer"); 76 Buffer.setInt(DoNotFree? DoNotFreeFlag : 0); 77 return; 78 } 79 80 if (shouldFreeBuffer()) 81 delete Buffer.getPointer(); 82 Buffer.setPointer(B); 83 Buffer.setInt(DoNotFree? DoNotFreeFlag : 0); 84} 85 86const llvm::MemoryBuffer *ContentCache::getBuffer(DiagnosticsEngine &Diag, 87 const SourceManager &SM, 88 SourceLocation Loc, 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) { 93 if (Invalid) 94 *Invalid = isBufferInvalid(); 95 96 return Buffer.getPointer(); 97 } 98 99 std::string ErrorStr; 100 bool isVolatile = SM.userFilesAreVolatile() && !IsSystemFile; 101 Buffer.setPointer(SM.getFileManager().getBufferForFile(ContentsEntry, 102 &ErrorStr, 103 isVolatile)); 104 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. 110 // 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 114 // possible. 115 if (!Buffer.getPointer()) { 116 const StringRef FillStr("<<<MISSING SOURCE FILE>>>\n"); 117 Buffer.setPointer(MemoryBuffer::getNewMemBuffer(ContentsEntry->getSize(), 118 "<invalid>")); 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()]; 122 123 if (Diag.isDiagnosticInFlight()) 124 Diag.SetDelayedDiagnostic(diag::err_cannot_open_file, 125 ContentsEntry->getName(), ErrorStr); 126 else 127 Diag.Report(Loc, diag::err_cannot_open_file) 128 << ContentsEntry->getName() << ErrorStr; 129 130 Buffer.setInt(Buffer.getInt() | InvalidFlag); 131 132 if (Invalid) *Invalid = true; 133 return Buffer.getPointer(); 134 } 135 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()); 142 else 143 Diag.Report(Loc, diag::err_file_modified) 144 << ContentsEntry->getName(); 145 146 Buffer.setInt(Buffer.getInt() | InvalidFlag); 147 if (Invalid) *Invalid = true; 148 return Buffer.getPointer(); 149 } 150 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") 166 .Default(0); 167 168 if (InvalidBOM) { 169 Diag.Report(Loc, diag::err_unsupported_bom) 170 << InvalidBOM << ContentsEntry->getName(); 171 Buffer.setInt(Buffer.getInt() | InvalidFlag); 172 } 173 174 if (Invalid) 175 *Invalid = isBufferInvalid(); 176 177 return Buffer.getPointer(); 178} 179 180unsigned LineTableInfo::getLineTableFilenameID(StringRef Name) { 181 // Look up the filename in the string table, returning the pre-existing value 182 // if it exists. 183 llvm::StringMapEntry<unsigned> &Entry = 184 FilenameIDs.GetOrCreateValue(Name, ~0U); 185 if (Entry.getValue() != ~0U) 186 return Entry.getValue(); 187 188 // Otherwise, assign this the next available ID. 189 Entry.setValue(FilenamesByID.size()); 190 FilenamesByID.push_back(&Entry); 191 return FilenamesByID.size()-1; 192} 193 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. 197void LineTableInfo::AddLineNote(FileID FID, unsigned Offset, 198 unsigned LineNo, int FilenameID) { 199 std::vector<LineEntry> &Entries = LineEntries[FID]; 200 201 assert((Entries.empty() || Entries.back().FileOffset < Offset) && 202 "Adding line entries out of order!"); 203 204 SrcMgr::CharacteristicKind Kind = SrcMgr::C_User; 205 unsigned IncludeOffset = 0; 206 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; 212 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; 217 } 218 219 Entries.push_back(LineEntry::get(Offset, LineNo, FilenameID, Kind, 220 IncludeOffset)); 221} 222 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. 228void LineTableInfo::AddLineNote(FileID FID, unsigned Offset, 229 unsigned LineNo, int FilenameID, 230 unsigned EntryExit, 231 SrcMgr::CharacteristicKind FileKind) { 232 assert(FilenameID != -1 && "Unspecified filename should use other accessor"); 233 234 std::vector<LineEntry> &Entries = LineEntries[FID]; 235 236 assert((Entries.empty() || Entries.back().FileOffset < Offset) && 237 "Adding line entries out of order!"); 238 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"); 247 248 // Get the include loc of the last entries' include loc as our include loc. 249 IncludeOffset = 0; 250 if (const LineEntry *PrevEntry = 251 FindNearestLineEntry(FID, Entries.back().IncludeOffset)) 252 IncludeOffset = PrevEntry->IncludeOffset; 253 } 254 255 Entries.push_back(LineEntry::get(Offset, LineNo, FilenameID, FileKind, 256 IncludeOffset)); 257} 258 259 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. 262const LineEntry *LineTableInfo::FindNearestLineEntry(FileID FID, 263 unsigned Offset) { 264 const std::vector<LineEntry> &Entries = LineEntries[FID]; 265 assert(!Entries.empty() && "No #line entries for this FID after all!"); 266 267 // It is very common for the query to be after the last #line, check this 268 // first. 269 if (Entries.back().FileOffset <= Offset) 270 return &Entries.back(); 271 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; 276 return &*--I; 277} 278 279/// \brief Add a new line entry that has already been encoded into 280/// the internal representation of the line table. 281void LineTableInfo::AddEntry(FileID FID, 282 const std::vector<LineEntry> &Entries) { 283 LineEntries[FID] = Entries; 284} 285 286/// getLineTableFilenameID - Return the uniqued ID for the specified filename. 287/// 288unsigned SourceManager::getLineTableFilenameID(StringRef Name) { 289 if (LineTable == 0) 290 LineTable = new LineTableInfo(); 291 return LineTable->getLineTableFilenameID(Name); 292} 293 294 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 297/// unspecified. 298void SourceManager::AddLineNote(SourceLocation Loc, unsigned LineNo, 299 int FilenameID) { 300 std::pair<FileID, unsigned> LocInfo = getDecomposedExpansionLoc(Loc); 301 302 bool Invalid = false; 303 const SLocEntry &Entry = getSLocEntry(LocInfo.first, &Invalid); 304 if (!Entry.isFile() || Invalid) 305 return; 306 307 const SrcMgr::FileInfo &FileInfo = Entry.getFile(); 308 309 // Remember that this file has #line directives now if it doesn't already. 310 const_cast<SrcMgr::FileInfo&>(FileInfo).setHasLineDirectives(); 311 312 if (LineTable == 0) 313 LineTable = new LineTableInfo(); 314 LineTable->AddLineNote(LocInfo.first, LocInfo.second, LineNo, FilenameID); 315} 316 317/// AddLineNote - Add a GNU line marker to the line table. 318void 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); 328 } 329 330 std::pair<FileID, unsigned> LocInfo = getDecomposedExpansionLoc(Loc); 331 332 bool Invalid = false; 333 const SLocEntry &Entry = getSLocEntry(LocInfo.first, &Invalid); 334 if (!Entry.isFile() || Invalid) 335 return; 336 337 const SrcMgr::FileInfo &FileInfo = Entry.getFile(); 338 339 // Remember that this file has #line directives now if it doesn't already. 340 const_cast<SrcMgr::FileInfo&>(FileInfo).setHasLineDirectives(); 341 342 if (LineTable == 0) 343 LineTable = new LineTableInfo(); 344 345 SrcMgr::CharacteristicKind FileKind; 346 if (IsExternCHeader) 347 FileKind = SrcMgr::C_ExternCSystem; 348 else if (IsSystemHeader) 349 FileKind = SrcMgr::C_System; 350 else 351 FileKind = SrcMgr::C_User; 352 353 unsigned EntryExit = 0; 354 if (IsFileEntry) 355 EntryExit = 1; 356 else if (IsFileExit) 357 EntryExit = 2; 358 359 LineTable->AddLineNote(LocInfo.first, LocInfo.second, LineNo, FilenameID, 360 EntryExit, FileKind); 361} 362 363LineTableInfo &SourceManager::getLineTable() { 364 if (LineTable == 0) 365 LineTable = new LineTableInfo(); 366 return *LineTable; 367} 368 369//===----------------------------------------------------------------------===// 370// Private 'Create' methods. 371//===----------------------------------------------------------------------===// 372 373SourceManager::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) { 380 clearIDTables(); 381 Diag.setSourceManager(this); 382} 383 384SourceManager::~SourceManager() { 385 delete LineTable; 386 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]); 394 } 395 } 396 for (llvm::DenseMap<const FileEntry*, SrcMgr::ContentCache*>::iterator 397 I = FileInfos.begin(), E = FileInfos.end(); I != E; ++I) { 398 if (I->second) { 399 I->second->~ContentCache(); 400 ContentCacheAlloc.Deallocate(I->second); 401 } 402 } 403 404 delete FakeBufferForRecovery; 405 delete FakeContentCacheForRecovery; 406 407 for (llvm::DenseMap<FileID, MacroArgsMap *>::iterator 408 I = MacroArgsCacheMap.begin(),E = MacroArgsCacheMap.end(); I!=E; ++I) { 409 delete I->second; 410 } 411} 412 413void SourceManager::clearIDTables() { 414 MainFileID = FileID(); 415 LocalSLocEntryTable.clear(); 416 LoadedSLocEntryTable.clear(); 417 SLocEntryLoaded.clear(); 418 LastLineNoFileIDQuery = FileID(); 419 LastLineNoContentCache = 0; 420 LastFileIDLookup = FileID(); 421 422 if (LineTable) 423 LineTable->clear(); 424 425 // Use up FileID #0 as an invalid expansion. 426 NextLocalOffset = 0; 427 CurrentLoadedOffset = MaxLoadedOffset; 428 createExpansionLoc(SourceLocation(),SourceLocation(),SourceLocation(), 1); 429} 430 431/// getOrCreateContentCache - Create or return a cached ContentCache for the 432/// specified file. 433const ContentCache * 434SourceManager::getOrCreateContentCache(const FileEntry *FileEnt, 435 bool isSystemFile) { 436 assert(FileEnt && "Didn't specify a file entry to use?"); 437 438 // Do we already have information about this file? 439 ContentCache *&Entry = FileInfos[FileEnt]; 440 if (Entry) return Entry; 441 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); 448 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); 456 else 457 new (Entry) ContentCache(OverridenFilesKeepOriginalName ? FileEnt 458 : overI->second, 459 overI->second); 460 } else { 461 new (Entry) ContentCache(FileEnt); 462 } 463 464 Entry->IsSystemFile = isSystemFile; 465 466 return Entry; 467} 468 469 470/// createMemBufferContentCache - Create a new ContentCache for the specified 471/// memory buffer. This does no caching. 472const ContentCache* 473SourceManager::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); 483 return Entry; 484} 485 486const SrcMgr::SLocEntry &SourceManager::loadSLocEntry(unsigned Index, 487 bool *Invalid) const { 488 assert(!SLocEntryLoaded[Index]); 489 if (ExternalSLocEntries->ReadSLocEntry(-(static_cast<int>(Index) + 2))) { 490 if (Invalid) 491 *Invalid = true; 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(), 498 SrcMgr::C_User)); 499 } 500 } 501 502 return LoadedSLocEntryTable[Index]; 503} 504 505std::pair<int, unsigned> 506SourceManager::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); 515} 516 517/// \brief As part of recovering from missing or changed content, produce a 518/// fake, non-empty buffer. 519const llvm::MemoryBuffer *SourceManager::getFakeBufferForRecovery() const { 520 if (!FakeBufferForRecovery) 521 FakeBufferForRecovery 522 = llvm::MemoryBuffer::getMemBuffer("<<<INVALID BUFFER>>"); 523 524 return FakeBufferForRecovery; 525} 526 527/// \brief As part of recovering from missing or changed content, produce a 528/// fake content cache. 529const SrcMgr::ContentCache * 530SourceManager::getFakeContentCacheForRecovery() const { 531 if (!FakeContentCacheForRecovery) { 532 FakeContentCacheForRecovery = new ContentCache(); 533 FakeContentCacheForRecovery->replaceBuffer(getFakeBufferForRecovery(), 534 /*DoNotFree=*/true); 535 } 536 return FakeContentCacheForRecovery; 537} 538 539//===----------------------------------------------------------------------===// 540// Methods to create new FileID's and macro expansions. 541//===----------------------------------------------------------------------===// 542 543/// createFileID - Create a new FileID for the specified ContentCache and 544/// include position. This works regardless of whether the ContentCache 545/// corresponds to a file or some other input source. 546FileID SourceManager::createFileID(const ContentCache *File, 547 SourceLocation IncludePos, 548 SrcMgr::CharacteristicKind FileCharacter, 549 int LoadedID, unsigned LoadedOffset) { 550 if (LoadedID < 0) { 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, 556 FileInfo::get(IncludePos, File, FileCharacter)); 557 SLocEntryLoaded[Index] = true; 558 return FileID::get(LoadedID); 559 } 560 LocalSLocEntryTable.push_back(SLocEntry::get(NextLocalOffset, 561 FileInfo::get(IncludePos, File, 562 FileCharacter))); 563 unsigned FileSize = File->getSize(); 564 assert(NextLocalOffset + FileSize + 1 > NextLocalOffset && 565 NextLocalOffset + FileSize + 1 <= CurrentLoadedOffset && 566 "Ran out of source locations!"); 567 // We do a +1 here because we want a SourceLocation that means "the end of the 568 // file", e.g. for the "no newline at the end of the file" diagnostic. 569 NextLocalOffset += FileSize + 1; 570 571 // Set LastFileIDLookup to the newly created file. The next getFileID call is 572 // almost guaranteed to be from that file. 573 FileID FID = FileID::get(LocalSLocEntryTable.size()-1); 574 return LastFileIDLookup = FID; 575} 576 577SourceLocation 578SourceManager::createMacroArgExpansionLoc(SourceLocation SpellingLoc, 579 SourceLocation ExpansionLoc, 580 unsigned TokLength) { 581 ExpansionInfo Info = ExpansionInfo::createForMacroArg(SpellingLoc, 582 ExpansionLoc); 583 return createExpansionLocImpl(Info, TokLength); 584} 585 586SourceLocation 587SourceManager::createExpansionLoc(SourceLocation SpellingLoc, 588 SourceLocation ExpansionLocStart, 589 SourceLocation ExpansionLocEnd, 590 unsigned TokLength, 591 int LoadedID, 592 unsigned LoadedOffset) { 593 ExpansionInfo Info = ExpansionInfo::create(SpellingLoc, ExpansionLocStart, 594 ExpansionLocEnd); 595 return createExpansionLocImpl(Info, TokLength, LoadedID, LoadedOffset); 596} 597 598SourceLocation 599SourceManager::createExpansionLocImpl(const ExpansionInfo &Info, 600 unsigned TokLength, 601 int LoadedID, 602 unsigned LoadedOffset) { 603 if (LoadedID < 0) { 604 assert(LoadedID != -1 && "Loading sentinel FileID"); 605 unsigned Index = unsigned(-LoadedID) - 2; 606 assert(Index < LoadedSLocEntryTable.size() && "FileID out of range"); 607 assert(!SLocEntryLoaded[Index] && "FileID already loaded"); 608 LoadedSLocEntryTable[Index] = SLocEntry::get(LoadedOffset, Info); 609 SLocEntryLoaded[Index] = true; 610 return SourceLocation::getMacroLoc(LoadedOffset); 611 } 612 LocalSLocEntryTable.push_back(SLocEntry::get(NextLocalOffset, Info)); 613 assert(NextLocalOffset + TokLength + 1 > NextLocalOffset && 614 NextLocalOffset + TokLength + 1 <= CurrentLoadedOffset && 615 "Ran out of source locations!"); 616 // See createFileID for that +1. 617 NextLocalOffset += TokLength + 1; 618 return SourceLocation::getMacroLoc(NextLocalOffset - (TokLength + 1)); 619} 620 621const llvm::MemoryBuffer * 622SourceManager::getMemoryBufferForFile(const FileEntry *File, 623 bool *Invalid) { 624 const SrcMgr::ContentCache *IR = getOrCreateContentCache(File); 625 assert(IR && "getOrCreateContentCache() cannot return NULL"); 626 return IR->getBuffer(Diag, *this, SourceLocation(), Invalid); 627} 628 629void SourceManager::overrideFileContents(const FileEntry *SourceFile, 630 const llvm::MemoryBuffer *Buffer, 631 bool DoNotFree) { 632 const SrcMgr::ContentCache *IR = getOrCreateContentCache(SourceFile); 633 assert(IR && "getOrCreateContentCache() cannot return NULL"); 634 635 const_cast<SrcMgr::ContentCache *>(IR)->replaceBuffer(Buffer, DoNotFree); 636 const_cast<SrcMgr::ContentCache *>(IR)->BufferOverridden = true; 637 638 getOverriddenFilesInfo().OverriddenFilesWithBuffer.insert(SourceFile); 639} 640 641void SourceManager::overrideFileContents(const FileEntry *SourceFile, 642 const FileEntry *NewFile) { 643 assert(SourceFile->getSize() == NewFile->getSize() && 644 "Different sizes, use the FileManager to create a virtual file with " 645 "the correct size"); 646 assert(FileInfos.count(SourceFile) == 0 && 647 "This function should be called at the initialization stage, before " 648 "any parsing occurs."); 649 getOverriddenFilesInfo().OverriddenFiles[SourceFile] = NewFile; 650} 651 652void SourceManager::disableFileContentsOverride(const FileEntry *File) { 653 if (!isFileOverridden(File)) 654 return; 655 656 const SrcMgr::ContentCache *IR = getOrCreateContentCache(File); 657 const_cast<SrcMgr::ContentCache *>(IR)->replaceBuffer(0); 658 const_cast<SrcMgr::ContentCache *>(IR)->ContentsEntry = IR->OrigEntry; 659 660 assert(OverriddenFilesInfo); 661 OverriddenFilesInfo->OverriddenFiles.erase(File); 662 OverriddenFilesInfo->OverriddenFilesWithBuffer.erase(File); 663} 664 665StringRef SourceManager::getBufferData(FileID FID, bool *Invalid) const { 666 bool MyInvalid = false; 667 const SLocEntry &SLoc = getSLocEntry(FID, &MyInvalid); 668 if (!SLoc.isFile() || MyInvalid) { 669 if (Invalid) 670 *Invalid = true; 671 return "<<<<<INVALID SOURCE LOCATION>>>>>"; 672 } 673 674 const llvm::MemoryBuffer *Buf 675 = SLoc.getFile().getContentCache()->getBuffer(Diag, *this, SourceLocation(), 676 &MyInvalid); 677 if (Invalid) 678 *Invalid = MyInvalid; 679 680 if (MyInvalid) 681 return "<<<<<INVALID SOURCE LOCATION>>>>>"; 682 683 return Buf->getBuffer(); 684} 685 686//===----------------------------------------------------------------------===// 687// SourceLocation manipulation methods. 688//===----------------------------------------------------------------------===// 689 690/// \brief Return the FileID for a SourceLocation. 691/// 692/// This is the cache-miss path of getFileID. Not as hot as that function, but 693/// still very important. It is responsible for finding the entry in the 694/// SLocEntry tables that contains the specified location. 695FileID SourceManager::getFileIDSlow(unsigned SLocOffset) const { 696 if (!SLocOffset) 697 return FileID::get(0); 698 699 // Now it is time to search for the correct file. See where the SLocOffset 700 // sits in the global view and consult local or loaded buffers for it. 701 if (SLocOffset < NextLocalOffset) 702 return getFileIDLocal(SLocOffset); 703 return getFileIDLoaded(SLocOffset); 704} 705 706/// \brief Return the FileID for a SourceLocation with a low offset. 707/// 708/// This function knows that the SourceLocation is in a local buffer, not a 709/// loaded one. 710FileID SourceManager::getFileIDLocal(unsigned SLocOffset) const { 711 assert(SLocOffset < NextLocalOffset && "Bad function choice"); 712 713 // After the first and second level caches, I see two common sorts of 714 // behavior: 1) a lot of searched FileID's are "near" the cached file 715 // location or are "near" the cached expansion location. 2) others are just 716 // completely random and may be a very long way away. 717 // 718 // To handle this, we do a linear search for up to 8 steps to catch #1 quickly 719 // then we fall back to a less cache efficient, but more scalable, binary 720 // search to find the location. 721 722 // See if this is near the file point - worst case we start scanning from the 723 // most newly created FileID. 724 std::vector<SrcMgr::SLocEntry>::const_iterator I; 725 726 if (LastFileIDLookup.ID < 0 || 727 LocalSLocEntryTable[LastFileIDLookup.ID].getOffset() < SLocOffset) { 728 // Neither loc prunes our search. 729 I = LocalSLocEntryTable.end(); 730 } else { 731 // Perhaps it is near the file point. 732 I = LocalSLocEntryTable.begin()+LastFileIDLookup.ID; 733 } 734 735 // Find the FileID that contains this. "I" is an iterator that points to a 736 // FileID whose offset is known to be larger than SLocOffset. 737 unsigned NumProbes = 0; 738 while (1) { 739 --I; 740 if (I->getOffset() <= SLocOffset) { 741 FileID Res = FileID::get(int(I - LocalSLocEntryTable.begin())); 742 743 // If this isn't an expansion, remember it. We have good locality across 744 // FileID lookups. 745 if (!I->isExpansion()) 746 LastFileIDLookup = Res; 747 NumLinearScans += NumProbes+1; 748 return Res; 749 } 750 if (++NumProbes == 8) 751 break; 752 } 753 754 // Convert "I" back into an index. We know that it is an entry whose index is 755 // larger than the offset we are looking for. 756 unsigned GreaterIndex = I - LocalSLocEntryTable.begin(); 757 // LessIndex - This is the lower bound of the range that we're searching. 758 // We know that the offset corresponding to the FileID is is less than 759 // SLocOffset. 760 unsigned LessIndex = 0; 761 NumProbes = 0; 762 while (1) { 763 bool Invalid = false; 764 unsigned MiddleIndex = (GreaterIndex-LessIndex)/2+LessIndex; 765 unsigned MidOffset = getLocalSLocEntry(MiddleIndex, &Invalid).getOffset(); 766 if (Invalid) 767 return FileID::get(0); 768 769 ++NumProbes; 770 771 // If the offset of the midpoint is too large, chop the high side of the 772 // range to the midpoint. 773 if (MidOffset > SLocOffset) { 774 GreaterIndex = MiddleIndex; 775 continue; 776 } 777 778 // If the middle index contains the value, succeed and return. 779 // FIXME: This could be made faster by using a function that's aware of 780 // being in the local area. 781 if (isOffsetInFileID(FileID::get(MiddleIndex), SLocOffset)) { 782 FileID Res = FileID::get(MiddleIndex); 783 784 // If this isn't a macro expansion, remember it. We have good locality 785 // across FileID lookups. 786 if (!LocalSLocEntryTable[MiddleIndex].isExpansion()) 787 LastFileIDLookup = Res; 788 NumBinaryProbes += NumProbes; 789 return Res; 790 } 791 792 // Otherwise, move the low-side up to the middle index. 793 LessIndex = MiddleIndex; 794 } 795} 796 797/// \brief Return the FileID for a SourceLocation with a high offset. 798/// 799/// This function knows that the SourceLocation is in a loaded buffer, not a 800/// local one. 801FileID SourceManager::getFileIDLoaded(unsigned SLocOffset) const { 802 // Sanity checking, otherwise a bug may lead to hanging in release build. 803 if (SLocOffset < CurrentLoadedOffset) { 804 assert(0 && "Invalid SLocOffset or bad function choice"); 805 return FileID(); 806 } 807 808 // Essentially the same as the local case, but the loaded array is sorted 809 // in the other direction. 810 811 // First do a linear scan from the last lookup position, if possible. 812 unsigned I; 813 int LastID = LastFileIDLookup.ID; 814 if (LastID >= 0 || getLoadedSLocEntryByID(LastID).getOffset() < SLocOffset) 815 I = 0; 816 else 817 I = (-LastID - 2) + 1; 818 819 unsigned NumProbes; 820 for (NumProbes = 0; NumProbes < 8; ++NumProbes, ++I) { 821 // Make sure the entry is loaded! 822 const SrcMgr::SLocEntry &E = getLoadedSLocEntry(I); 823 if (E.getOffset() <= SLocOffset) { 824 FileID Res = FileID::get(-int(I) - 2); 825 826 if (!E.isExpansion()) 827 LastFileIDLookup = Res; 828 NumLinearScans += NumProbes + 1; 829 return Res; 830 } 831 } 832 833 // Linear scan failed. Do the binary search. Note the reverse sorting of the 834 // table: GreaterIndex is the one where the offset is greater, which is 835 // actually a lower index! 836 unsigned GreaterIndex = I; 837 unsigned LessIndex = LoadedSLocEntryTable.size(); 838 NumProbes = 0; 839 while (1) { 840 ++NumProbes; 841 unsigned MiddleIndex = (LessIndex - GreaterIndex) / 2 + GreaterIndex; 842 const SrcMgr::SLocEntry &E = getLoadedSLocEntry(MiddleIndex); 843 844 ++NumProbes; 845 846 if (E.getOffset() > SLocOffset) { 847 GreaterIndex = MiddleIndex; 848 continue; 849 } 850 851 if (isOffsetInFileID(FileID::get(-int(MiddleIndex) - 2), SLocOffset)) { 852 FileID Res = FileID::get(-int(MiddleIndex) - 2); 853 if (!E.isExpansion()) 854 LastFileIDLookup = Res; 855 NumBinaryProbes += NumProbes; 856 return Res; 857 } 858 859 LessIndex = MiddleIndex; 860 } 861} 862 863SourceLocation SourceManager:: 864getExpansionLocSlowCase(SourceLocation Loc) const { 865 do { 866 // Note: If Loc indicates an offset into a token that came from a macro 867 // expansion (e.g. the 5th character of the token) we do not want to add 868 // this offset when going to the expansion location. The expansion 869 // location is the macro invocation, which the offset has nothing to do 870 // with. This is unlike when we get the spelling loc, because the offset 871 // directly correspond to the token whose spelling we're inspecting. 872 Loc = getSLocEntry(getFileID(Loc)).getExpansion().getExpansionLocStart(); 873 } while (!Loc.isFileID()); 874 875 return Loc; 876} 877 878SourceLocation SourceManager::getSpellingLocSlowCase(SourceLocation Loc) const { 879 do { 880 std::pair<FileID, unsigned> LocInfo = getDecomposedLoc(Loc); 881 Loc = getSLocEntry(LocInfo.first).getExpansion().getSpellingLoc(); 882 Loc = Loc.getLocWithOffset(LocInfo.second); 883 } while (!Loc.isFileID()); 884 return Loc; 885} 886 887SourceLocation SourceManager::getFileLocSlowCase(SourceLocation Loc) const { 888 do { 889 if (isMacroArgExpansion(Loc)) 890 Loc = getImmediateSpellingLoc(Loc); 891 else 892 Loc = getImmediateExpansionRange(Loc).first; 893 } while (!Loc.isFileID()); 894 return Loc; 895} 896 897 898std::pair<FileID, unsigned> 899SourceManager::getDecomposedExpansionLocSlowCase( 900 const SrcMgr::SLocEntry *E) const { 901 // If this is an expansion record, walk through all the expansion points. 902 FileID FID; 903 SourceLocation Loc; 904 unsigned Offset; 905 do { 906 Loc = E->getExpansion().getExpansionLocStart(); 907 908 FID = getFileID(Loc); 909 E = &getSLocEntry(FID); 910 Offset = Loc.getOffset()-E->getOffset(); 911 } while (!Loc.isFileID()); 912 913 return std::make_pair(FID, Offset); 914} 915 916std::pair<FileID, unsigned> 917SourceManager::getDecomposedSpellingLocSlowCase(const SrcMgr::SLocEntry *E, 918 unsigned Offset) const { 919 // If this is an expansion record, walk through all the expansion points. 920 FileID FID; 921 SourceLocation Loc; 922 do { 923 Loc = E->getExpansion().getSpellingLoc(); 924 Loc = Loc.getLocWithOffset(Offset); 925 926 FID = getFileID(Loc); 927 E = &getSLocEntry(FID); 928 Offset = Loc.getOffset()-E->getOffset(); 929 } while (!Loc.isFileID()); 930 931 return std::make_pair(FID, Offset); 932} 933 934/// getImmediateSpellingLoc - Given a SourceLocation object, return the 935/// spelling location referenced by the ID. This is the first level down 936/// towards the place where the characters that make up the lexed token can be 937/// found. This should not generally be used by clients. 938SourceLocation SourceManager::getImmediateSpellingLoc(SourceLocation Loc) const{ 939 if (Loc.isFileID()) return Loc; 940 std::pair<FileID, unsigned> LocInfo = getDecomposedLoc(Loc); 941 Loc = getSLocEntry(LocInfo.first).getExpansion().getSpellingLoc(); 942 return Loc.getLocWithOffset(LocInfo.second); 943} 944 945 946/// getImmediateExpansionRange - Loc is required to be an expansion location. 947/// Return the start/end of the expansion information. 948std::pair<SourceLocation,SourceLocation> 949SourceManager::getImmediateExpansionRange(SourceLocation Loc) const { 950 assert(Loc.isMacroID() && "Not a macro expansion loc!"); 951 const ExpansionInfo &Expansion = getSLocEntry(getFileID(Loc)).getExpansion(); 952 return Expansion.getExpansionLocRange(); 953} 954 955/// getExpansionRange - Given a SourceLocation object, return the range of 956/// tokens covered by the expansion in the ultimate file. 957std::pair<SourceLocation,SourceLocation> 958SourceManager::getExpansionRange(SourceLocation Loc) const { 959 if (Loc.isFileID()) return std::make_pair(Loc, Loc); 960 961 std::pair<SourceLocation,SourceLocation> Res = 962 getImmediateExpansionRange(Loc); 963 964 // Fully resolve the start and end locations to their ultimate expansion 965 // points. 966 while (!Res.first.isFileID()) 967 Res.first = getImmediateExpansionRange(Res.first).first; 968 while (!Res.second.isFileID()) 969 Res.second = getImmediateExpansionRange(Res.second).second; 970 return Res; 971} 972 973bool SourceManager::isMacroArgExpansion(SourceLocation Loc) const { 974 if (!Loc.isMacroID()) return false; 975 976 FileID FID = getFileID(Loc); 977 const SrcMgr::ExpansionInfo &Expansion = getSLocEntry(FID).getExpansion(); 978 return Expansion.isMacroArgExpansion(); 979} 980 981bool SourceManager::isMacroBodyExpansion(SourceLocation Loc) const { 982 if (!Loc.isMacroID()) return false; 983 984 FileID FID = getFileID(Loc); 985 const SrcMgr::ExpansionInfo &Expansion = getSLocEntry(FID).getExpansion(); 986 return Expansion.isMacroBodyExpansion(); 987} 988 989 990//===----------------------------------------------------------------------===// 991// Queries about the code at a SourceLocation. 992//===----------------------------------------------------------------------===// 993 994/// getCharacterData - Return a pointer to the start of the specified location 995/// in the appropriate MemoryBuffer. 996const char *SourceManager::getCharacterData(SourceLocation SL, 997 bool *Invalid) const { 998 // Note that this is a hot function in the getSpelling() path, which is 999 // heavily used by -E mode. 1000 std::pair<FileID, unsigned> LocInfo = getDecomposedSpellingLoc(SL); 1001 1002 // Note that calling 'getBuffer()' may lazily page in a source file. 1003 bool CharDataInvalid = false; 1004 const SLocEntry &Entry = getSLocEntry(LocInfo.first, &CharDataInvalid); 1005 if (CharDataInvalid || !Entry.isFile()) { 1006 if (Invalid) 1007 *Invalid = true; 1008 1009 return "<<<<INVALID BUFFER>>>>"; 1010 } 1011 const llvm::MemoryBuffer *Buffer 1012 = Entry.getFile().getContentCache() 1013 ->getBuffer(Diag, *this, SourceLocation(), &CharDataInvalid); 1014 if (Invalid) 1015 *Invalid = CharDataInvalid; 1016 return Buffer->getBufferStart() + (CharDataInvalid? 0 : LocInfo.second); 1017} 1018 1019 1020/// getColumnNumber - Return the column # for the specified file position. 1021/// this is significantly cheaper to compute than the line number. 1022unsigned SourceManager::getColumnNumber(FileID FID, unsigned FilePos, 1023 bool *Invalid) const { 1024 bool MyInvalid = false; 1025 const llvm::MemoryBuffer *MemBuf = getBuffer(FID, &MyInvalid); 1026 if (Invalid) 1027 *Invalid = MyInvalid; 1028 1029 if (MyInvalid) 1030 return 1; 1031 1032 // It is okay to request a position just past the end of the buffer. 1033 if (FilePos > MemBuf->getBufferSize()) { 1034 if (Invalid) 1035 *Invalid = true; 1036 return 1; 1037 } 1038 1039 // See if we just calculated the line number for this FilePos and can use 1040 // that to lookup the start of the line instead of searching for it. 1041 if (LastLineNoFileIDQuery == FID && 1042 LastLineNoContentCache->SourceLineCache != 0 && 1043 LastLineNoResult < LastLineNoContentCache->NumLines) { 1044 unsigned *SourceLineCache = LastLineNoContentCache->SourceLineCache; 1045 unsigned LineStart = SourceLineCache[LastLineNoResult - 1]; 1046 unsigned LineEnd = SourceLineCache[LastLineNoResult]; 1047 if (FilePos >= LineStart && FilePos < LineEnd) 1048 return FilePos - LineStart + 1; 1049 } 1050 1051 const char *Buf = MemBuf->getBufferStart(); 1052 unsigned LineStart = FilePos; 1053 while (LineStart && Buf[LineStart-1] != '\n' && Buf[LineStart-1] != '\r') 1054 --LineStart; 1055 return FilePos-LineStart+1; 1056} 1057 1058// isInvalid - Return the result of calling loc.isInvalid(), and 1059// if Invalid is not null, set its value to same. 1060static bool isInvalid(SourceLocation Loc, bool *Invalid) { 1061 bool MyInvalid = Loc.isInvalid(); 1062 if (Invalid) 1063 *Invalid = MyInvalid; 1064 return MyInvalid; 1065} 1066 1067unsigned SourceManager::getSpellingColumnNumber(SourceLocation Loc, 1068 bool *Invalid) const { 1069 if (isInvalid(Loc, Invalid)) return 0; 1070 std::pair<FileID, unsigned> LocInfo = getDecomposedSpellingLoc(Loc); 1071 return getColumnNumber(LocInfo.first, LocInfo.second, Invalid); 1072} 1073 1074unsigned SourceManager::getExpansionColumnNumber(SourceLocation Loc, 1075 bool *Invalid) const { 1076 if (isInvalid(Loc, Invalid)) return 0; 1077 std::pair<FileID, unsigned> LocInfo = getDecomposedExpansionLoc(Loc); 1078 return getColumnNumber(LocInfo.first, LocInfo.second, Invalid); 1079} 1080 1081unsigned SourceManager::getPresumedColumnNumber(SourceLocation Loc, 1082 bool *Invalid) const { 1083 if (isInvalid(Loc, Invalid)) return 0; 1084 return getPresumedLoc(Loc).getColumn(); 1085} 1086 1087#ifdef __SSE2__ 1088#include <emmintrin.h> 1089#endif 1090 1091static LLVM_ATTRIBUTE_NOINLINE void 1092ComputeLineNumbers(DiagnosticsEngine &Diag, ContentCache *FI, 1093 llvm::BumpPtrAllocator &Alloc, 1094 const SourceManager &SM, bool &Invalid); 1095static void ComputeLineNumbers(DiagnosticsEngine &Diag, ContentCache *FI, 1096 llvm::BumpPtrAllocator &Alloc, 1097 const SourceManager &SM, bool &Invalid) { 1098 // Note that calling 'getBuffer()' may lazily page in the file. 1099 const MemoryBuffer *Buffer = FI->getBuffer(Diag, SM, SourceLocation(), 1100 &Invalid); 1101 if (Invalid) 1102 return; 1103 1104 // Find the file offsets of all of the *physical* source lines. This does 1105 // not look at trigraphs, escaped newlines, or anything else tricky. 1106 SmallVector<unsigned, 256> LineOffsets; 1107 1108 // Line #1 starts at char 0. 1109 LineOffsets.push_back(0); 1110 1111 const unsigned char *Buf = (const unsigned char *)Buffer->getBufferStart(); 1112 const unsigned char *End = (const unsigned char *)Buffer->getBufferEnd(); 1113 unsigned Offs = 0; 1114 while (1) { 1115 // Skip over the contents of the line. 1116 const unsigned char *NextBuf = (const unsigned char *)Buf; 1117 1118#ifdef __SSE2__ 1119 // Try to skip to the next newline using SSE instructions. This is very 1120 // performance sensitive for programs with lots of diagnostics and in -E 1121 // mode. 1122 __m128i CRs = _mm_set1_epi8('\r'); 1123 __m128i LFs = _mm_set1_epi8('\n'); 1124 1125 // First fix up the alignment to 16 bytes. 1126 while (((uintptr_t)NextBuf & 0xF) != 0) { 1127 if (*NextBuf == '\n' || *NextBuf == '\r' || *NextBuf == '\0') 1128 goto FoundSpecialChar; 1129 ++NextBuf; 1130 } 1131 1132 // Scan 16 byte chunks for '\r' and '\n'. Ignore '\0'. 1133 while (NextBuf+16 <= End) { 1134 const __m128i Chunk = *(const __m128i*)NextBuf; 1135 __m128i Cmp = _mm_or_si128(_mm_cmpeq_epi8(Chunk, CRs), 1136 _mm_cmpeq_epi8(Chunk, LFs)); 1137 unsigned Mask = _mm_movemask_epi8(Cmp); 1138 1139 // If we found a newline, adjust the pointer and jump to the handling code. 1140 if (Mask != 0) { 1141 NextBuf += llvm::CountTrailingZeros_32(Mask); 1142 goto FoundSpecialChar; 1143 } 1144 NextBuf += 16; 1145 } 1146#endif 1147 1148 while (*NextBuf != '\n' && *NextBuf != '\r' && *NextBuf != '\0') 1149 ++NextBuf; 1150 1151#ifdef __SSE2__ 1152FoundSpecialChar: 1153#endif 1154 Offs += NextBuf-Buf; 1155 Buf = NextBuf; 1156 1157 if (Buf[0] == '\n' || Buf[0] == '\r') { 1158 // If this is \n\r or \r\n, skip both characters. 1159 if ((Buf[1] == '\n' || Buf[1] == '\r') && Buf[0] != Buf[1]) 1160 ++Offs, ++Buf; 1161 ++Offs, ++Buf; 1162 LineOffsets.push_back(Offs); 1163 } else { 1164 // Otherwise, this is a null. If end of file, exit. 1165 if (Buf == End) break; 1166 // Otherwise, skip the null. 1167 ++Offs, ++Buf; 1168 } 1169 } 1170 1171 // Copy the offsets into the FileInfo structure. 1172 FI->NumLines = LineOffsets.size(); 1173 FI->SourceLineCache = Alloc.Allocate<unsigned>(LineOffsets.size()); 1174 std::copy(LineOffsets.begin(), LineOffsets.end(), FI->SourceLineCache); 1175} 1176 1177/// getLineNumber - Given a SourceLocation, return the spelling line number 1178/// for the position indicated. This requires building and caching a table of 1179/// line offsets for the MemoryBuffer, so this is not cheap: use only when 1180/// about to emit a diagnostic. 1181unsigned SourceManager::getLineNumber(FileID FID, unsigned FilePos, 1182 bool *Invalid) const { 1183 if (FID.isInvalid()) { 1184 if (Invalid) 1185 *Invalid = true; 1186 return 1; 1187 } 1188 1189 ContentCache *Content; 1190 if (LastLineNoFileIDQuery == FID) 1191 Content = LastLineNoContentCache; 1192 else { 1193 bool MyInvalid = false; 1194 const SLocEntry &Entry = getSLocEntry(FID, &MyInvalid); 1195 if (MyInvalid || !Entry.isFile()) { 1196 if (Invalid) 1197 *Invalid = true; 1198 return 1; 1199 } 1200 1201 Content = const_cast<ContentCache*>(Entry.getFile().getContentCache()); 1202 } 1203 1204 // If this is the first use of line information for this buffer, compute the 1205 /// SourceLineCache for it on demand. 1206 if (Content->SourceLineCache == 0) { 1207 bool MyInvalid = false; 1208 ComputeLineNumbers(Diag, Content, ContentCacheAlloc, *this, MyInvalid); 1209 if (Invalid) 1210 *Invalid = MyInvalid; 1211 if (MyInvalid) 1212 return 1; 1213 } else if (Invalid) 1214 *Invalid = false; 1215 1216 // Okay, we know we have a line number table. Do a binary search to find the 1217 // line number that this character position lands on. 1218 unsigned *SourceLineCache = Content->SourceLineCache; 1219 unsigned *SourceLineCacheStart = SourceLineCache; 1220 unsigned *SourceLineCacheEnd = SourceLineCache + Content->NumLines; 1221 1222 unsigned QueriedFilePos = FilePos+1; 1223 1224 // FIXME: I would like to be convinced that this code is worth being as 1225 // complicated as it is, binary search isn't that slow. 1226 // 1227 // If it is worth being optimized, then in my opinion it could be more 1228 // performant, simpler, and more obviously correct by just "galloping" outward 1229 // from the queried file position. In fact, this could be incorporated into a 1230 // generic algorithm such as lower_bound_with_hint. 1231 // 1232 // If someone gives me a test case where this matters, and I will do it! - DWD 1233 1234 // If the previous query was to the same file, we know both the file pos from 1235 // that query and the line number returned. This allows us to narrow the 1236 // search space from the entire file to something near the match. 1237 if (LastLineNoFileIDQuery == FID) { 1238 if (QueriedFilePos >= LastLineNoFilePos) { 1239 // FIXME: Potential overflow? 1240 SourceLineCache = SourceLineCache+LastLineNoResult-1; 1241 1242 // The query is likely to be nearby the previous one. Here we check to 1243 // see if it is within 5, 10 or 20 lines. It can be far away in cases 1244 // where big comment blocks and vertical whitespace eat up lines but 1245 // contribute no tokens. 1246 if (SourceLineCache+5 < SourceLineCacheEnd) { 1247 if (SourceLineCache[5] > QueriedFilePos) 1248 SourceLineCacheEnd = SourceLineCache+5; 1249 else if (SourceLineCache+10 < SourceLineCacheEnd) { 1250 if (SourceLineCache[10] > QueriedFilePos) 1251 SourceLineCacheEnd = SourceLineCache+10; 1252 else if (SourceLineCache+20 < SourceLineCacheEnd) { 1253 if (SourceLineCache[20] > QueriedFilePos) 1254 SourceLineCacheEnd = SourceLineCache+20; 1255 } 1256 } 1257 } 1258 } else { 1259 if (LastLineNoResult < Content->NumLines) 1260 SourceLineCacheEnd = SourceLineCache+LastLineNoResult+1; 1261 } 1262 } 1263 1264 // If the spread is large, do a "radix" test as our initial guess, based on 1265 // the assumption that lines average to approximately the same length. 1266 // NOTE: This is currently disabled, as it does not appear to be profitable in 1267 // initial measurements. 1268 if (0 && SourceLineCacheEnd-SourceLineCache > 20) { 1269 unsigned FileLen = Content->SourceLineCache[Content->NumLines-1]; 1270 1271 // Take a stab at guessing where it is. 1272 unsigned ApproxPos = Content->NumLines*QueriedFilePos / FileLen; 1273 1274 // Check for -10 and +10 lines. 1275 unsigned LowerBound = std::max(int(ApproxPos-10), 0); 1276 unsigned UpperBound = std::min(ApproxPos+10, FileLen); 1277 1278 // If the computed lower bound is less than the query location, move it in. 1279 if (SourceLineCache < SourceLineCacheStart+LowerBound && 1280 SourceLineCacheStart[LowerBound] < QueriedFilePos) 1281 SourceLineCache = SourceLineCacheStart+LowerBound; 1282 1283 // If the computed upper bound is greater than the query location, move it. 1284 if (SourceLineCacheEnd > SourceLineCacheStart+UpperBound && 1285 SourceLineCacheStart[UpperBound] >= QueriedFilePos) 1286 SourceLineCacheEnd = SourceLineCacheStart+UpperBound; 1287 } 1288 1289 unsigned *Pos 1290 = std::lower_bound(SourceLineCache, SourceLineCacheEnd, QueriedFilePos); 1291 unsigned LineNo = Pos-SourceLineCacheStart; 1292 1293 LastLineNoFileIDQuery = FID; 1294 LastLineNoContentCache = Content; 1295 LastLineNoFilePos = QueriedFilePos; 1296 LastLineNoResult = LineNo; 1297 return LineNo; 1298} 1299 1300unsigned SourceManager::getSpellingLineNumber(SourceLocation Loc, 1301 bool *Invalid) const { 1302 if (isInvalid(Loc, Invalid)) return 0; 1303 std::pair<FileID, unsigned> LocInfo = getDecomposedSpellingLoc(Loc); 1304 return getLineNumber(LocInfo.first, LocInfo.second); 1305} 1306unsigned SourceManager::getExpansionLineNumber(SourceLocation Loc, 1307 bool *Invalid) const { 1308 if (isInvalid(Loc, Invalid)) return 0; 1309 std::pair<FileID, unsigned> LocInfo = getDecomposedExpansionLoc(Loc); 1310 return getLineNumber(LocInfo.first, LocInfo.second); 1311} 1312unsigned SourceManager::getPresumedLineNumber(SourceLocation Loc, 1313 bool *Invalid) const { 1314 if (isInvalid(Loc, Invalid)) return 0; 1315 return getPresumedLoc(Loc).getLine(); 1316} 1317 1318/// getFileCharacteristic - return the file characteristic of the specified 1319/// source location, indicating whether this is a normal file, a system 1320/// header, or an "implicit extern C" system header. 1321/// 1322/// This state can be modified with flags on GNU linemarker directives like: 1323/// # 4 "foo.h" 3 1324/// which changes all source locations in the current file after that to be 1325/// considered to be from a system header. 1326SrcMgr::CharacteristicKind 1327SourceManager::getFileCharacteristic(SourceLocation Loc) const { 1328 assert(!Loc.isInvalid() && "Can't get file characteristic of invalid loc!"); 1329 std::pair<FileID, unsigned> LocInfo = getDecomposedExpansionLoc(Loc); 1330 bool Invalid = false; 1331 const SLocEntry &SEntry = getSLocEntry(LocInfo.first, &Invalid); 1332 if (Invalid || !SEntry.isFile()) 1333 return C_User; 1334 1335 const SrcMgr::FileInfo &FI = SEntry.getFile(); 1336 1337 // If there are no #line directives in this file, just return the whole-file 1338 // state. 1339 if (!FI.hasLineDirectives()) 1340 return FI.getFileCharacteristic(); 1341 1342 assert(LineTable && "Can't have linetable entries without a LineTable!"); 1343 // See if there is a #line directive before the location. 1344 const LineEntry *Entry = 1345 LineTable->FindNearestLineEntry(LocInfo.first, LocInfo.second); 1346 1347 // If this is before the first line marker, use the file characteristic. 1348 if (!Entry) 1349 return FI.getFileCharacteristic(); 1350 1351 return Entry->FileKind; 1352} 1353 1354/// Return the filename or buffer identifier of the buffer the location is in. 1355/// Note that this name does not respect \#line directives. Use getPresumedLoc 1356/// for normal clients. 1357const char *SourceManager::getBufferName(SourceLocation Loc, 1358 bool *Invalid) const { 1359 if (isInvalid(Loc, Invalid)) return "<invalid loc>"; 1360 1361 return getBuffer(getFileID(Loc), Invalid)->getBufferIdentifier(); 1362} 1363 1364 1365/// getPresumedLoc - This method returns the "presumed" location of a 1366/// SourceLocation specifies. A "presumed location" can be modified by \#line 1367/// or GNU line marker directives. This provides a view on the data that a 1368/// user should see in diagnostics, for example. 1369/// 1370/// Note that a presumed location is always given as the expansion point of an 1371/// expansion location, not at the spelling location. 1372PresumedLoc SourceManager::getPresumedLoc(SourceLocation Loc, 1373 bool UseLineDirectives) const { 1374 if (Loc.isInvalid()) return PresumedLoc(); 1375 1376 // Presumed locations are always for expansion points. 1377 std::pair<FileID, unsigned> LocInfo = getDecomposedExpansionLoc(Loc); 1378 1379 bool Invalid = false; 1380 const SLocEntry &Entry = getSLocEntry(LocInfo.first, &Invalid); 1381 if (Invalid || !Entry.isFile()) 1382 return PresumedLoc(); 1383 1384 const SrcMgr::FileInfo &FI = Entry.getFile(); 1385 const SrcMgr::ContentCache *C = FI.getContentCache(); 1386 1387 // To get the source name, first consult the FileEntry (if one exists) 1388 // before the MemBuffer as this will avoid unnecessarily paging in the 1389 // MemBuffer. 1390 const char *Filename; 1391 if (C->OrigEntry) 1392 Filename = C->OrigEntry->getName(); 1393 else 1394 Filename = C->getBuffer(Diag, *this)->getBufferIdentifier(); 1395 1396 unsigned LineNo = getLineNumber(LocInfo.first, LocInfo.second, &Invalid); 1397 if (Invalid) 1398 return PresumedLoc(); 1399 unsigned ColNo = getColumnNumber(LocInfo.first, LocInfo.second, &Invalid); 1400 if (Invalid) 1401 return PresumedLoc(); 1402 1403 SourceLocation IncludeLoc = FI.getIncludeLoc(); 1404 1405 // If we have #line directives in this file, update and overwrite the physical 1406 // location info if appropriate. 1407 if (UseLineDirectives && FI.hasLineDirectives()) { 1408 assert(LineTable && "Can't have linetable entries without a LineTable!"); 1409 // See if there is a #line directive before this. If so, get it. 1410 if (const LineEntry *Entry = 1411 LineTable->FindNearestLineEntry(LocInfo.first, LocInfo.second)) { 1412 // If the LineEntry indicates a filename, use it. 1413 if (Entry->FilenameID != -1) 1414 Filename = LineTable->getFilename(Entry->FilenameID); 1415 1416 // Use the line number specified by the LineEntry. This line number may 1417 // be multiple lines down from the line entry. Add the difference in 1418 // physical line numbers from the query point and the line marker to the 1419 // total. 1420 unsigned MarkerLineNo = getLineNumber(LocInfo.first, Entry->FileOffset); 1421 LineNo = Entry->LineNo + (LineNo-MarkerLineNo-1); 1422 1423 // Note that column numbers are not molested by line markers. 1424 1425 // Handle virtual #include manipulation. 1426 if (Entry->IncludeOffset) { 1427 IncludeLoc = getLocForStartOfFile(LocInfo.first); 1428 IncludeLoc = IncludeLoc.getLocWithOffset(Entry->IncludeOffset); 1429 } 1430 } 1431 } 1432 1433 return PresumedLoc(Filename, LineNo, ColNo, IncludeLoc); 1434} 1435 1436/// \brief The size of the SLocEnty that \arg FID represents. 1437unsigned SourceManager::getFileIDSize(FileID FID) const { 1438 bool Invalid = false; 1439 const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid); 1440 if (Invalid) 1441 return 0; 1442 1443 int ID = FID.ID; 1444 unsigned NextOffset; 1445 if ((ID > 0 && unsigned(ID+1) == local_sloc_entry_size())) 1446 NextOffset = getNextLocalOffset(); 1447 else if (ID+1 == -1) 1448 NextOffset = MaxLoadedOffset; 1449 else 1450 NextOffset = getSLocEntry(FileID::get(ID+1)).getOffset(); 1451 1452 return NextOffset - Entry.getOffset() - 1; 1453} 1454 1455//===----------------------------------------------------------------------===// 1456// Other miscellaneous methods. 1457//===----------------------------------------------------------------------===// 1458 1459/// \brief Retrieve the inode for the given file entry, if possible. 1460/// 1461/// This routine involves a system call, and therefore should only be used 1462/// in non-performance-critical code. 1463static llvm::Optional<ino_t> getActualFileInode(const FileEntry *File) { 1464 if (!File) 1465 return llvm::Optional<ino_t>(); 1466 1467 struct stat StatBuf; 1468 if (::stat(File->getName(), &StatBuf)) 1469 return llvm::Optional<ino_t>(); 1470 1471 return StatBuf.st_ino; 1472} 1473 1474/// \brief Get the source location for the given file:line:col triplet. 1475/// 1476/// If the source file is included multiple times, the source location will 1477/// be based upon an arbitrary inclusion. 1478SourceLocation SourceManager::translateFileLineCol(const FileEntry *SourceFile, 1479 unsigned Line, 1480 unsigned Col) const { 1481 assert(SourceFile && "Null source file!"); 1482 assert(Line && Col && "Line and column should start from 1!"); 1483 1484 FileID FirstFID = translateFile(SourceFile); 1485 return translateLineCol(FirstFID, Line, Col); 1486} 1487 1488/// \brief Get the FileID for the given file. 1489/// 1490/// If the source file is included multiple times, the FileID will be the 1491/// first inclusion. 1492FileID SourceManager::translateFile(const FileEntry *SourceFile) const { 1493 assert(SourceFile && "Null source file!"); 1494 1495 // Find the first file ID that corresponds to the given file. 1496 FileID FirstFID; 1497 1498 // First, check the main file ID, since it is common to look for a 1499 // location in the main file. 1500 llvm::Optional<ino_t> SourceFileInode; 1501 llvm::Optional<StringRef> SourceFileName; 1502 if (!MainFileID.isInvalid()) { 1503 bool Invalid = false; 1504 const SLocEntry &MainSLoc = getSLocEntry(MainFileID, &Invalid); 1505 if (Invalid) 1506 return FileID(); 1507 1508 if (MainSLoc.isFile()) { 1509 const ContentCache *MainContentCache 1510 = MainSLoc.getFile().getContentCache(); 1511 if (!MainContentCache) { 1512 // Can't do anything 1513 } else if (MainContentCache->OrigEntry == SourceFile) { 1514 FirstFID = MainFileID; 1515 } else { 1516 // Fall back: check whether we have the same base name and inode 1517 // as the main file. 1518 const FileEntry *MainFile = MainContentCache->OrigEntry; 1519 SourceFileName = llvm::sys::path::filename(SourceFile->getName()); 1520 if (*SourceFileName == llvm::sys::path::filename(MainFile->getName())) { 1521 SourceFileInode = getActualFileInode(SourceFile); 1522 if (SourceFileInode) { 1523 if (llvm::Optional<ino_t> MainFileInode 1524 = getActualFileInode(MainFile)) { 1525 if (*SourceFileInode == *MainFileInode) { 1526 FirstFID = MainFileID; 1527 SourceFile = MainFile; 1528 } 1529 } 1530 } 1531 } 1532 } 1533 } 1534 } 1535 1536 if (FirstFID.isInvalid()) { 1537 // The location we're looking for isn't in the main file; look 1538 // through all of the local source locations. 1539 for (unsigned I = 0, N = local_sloc_entry_size(); I != N; ++I) { 1540 bool Invalid = false; 1541 const SLocEntry &SLoc = getLocalSLocEntry(I, &Invalid); 1542 if (Invalid) 1543 return FileID(); 1544 1545 if (SLoc.isFile() && 1546 SLoc.getFile().getContentCache() && 1547 SLoc.getFile().getContentCache()->OrigEntry == SourceFile) { 1548 FirstFID = FileID::get(I); 1549 break; 1550 } 1551 } 1552 // If that still didn't help, try the modules. 1553 if (FirstFID.isInvalid()) { 1554 for (unsigned I = 0, N = loaded_sloc_entry_size(); I != N; ++I) { 1555 const SLocEntry &SLoc = getLoadedSLocEntry(I); 1556 if (SLoc.isFile() && 1557 SLoc.getFile().getContentCache() && 1558 SLoc.getFile().getContentCache()->OrigEntry == SourceFile) { 1559 FirstFID = FileID::get(-int(I) - 2); 1560 break; 1561 } 1562 } 1563 } 1564 } 1565 1566 // If we haven't found what we want yet, try again, but this time stat() 1567 // each of the files in case the files have changed since we originally 1568 // parsed the file. 1569 if (FirstFID.isInvalid() && 1570 (SourceFileName || 1571 (SourceFileName = llvm::sys::path::filename(SourceFile->getName()))) && 1572 (SourceFileInode || 1573 (SourceFileInode = getActualFileInode(SourceFile)))) { 1574 bool Invalid = false; 1575 for (unsigned I = 0, N = local_sloc_entry_size(); I != N; ++I) { 1576 FileID IFileID; 1577 IFileID.ID = I; 1578 const SLocEntry &SLoc = getSLocEntry(IFileID, &Invalid); 1579 if (Invalid) 1580 return FileID(); 1581 1582 if (SLoc.isFile()) { 1583 const ContentCache *FileContentCache 1584 = SLoc.getFile().getContentCache(); 1585 const FileEntry *Entry =FileContentCache? FileContentCache->OrigEntry : 0; 1586 if (Entry && 1587 *SourceFileName == llvm::sys::path::filename(Entry->getName())) { 1588 if (llvm::Optional<ino_t> EntryInode = getActualFileInode(Entry)) { 1589 if (*SourceFileInode == *EntryInode) { 1590 FirstFID = FileID::get(I); 1591 SourceFile = Entry; 1592 break; 1593 } 1594 } 1595 } 1596 } 1597 } 1598 } 1599 1600 (void) SourceFile; 1601 return FirstFID; 1602} 1603 1604/// \brief Get the source location in \arg FID for the given line:col. 1605/// Returns null location if \arg FID is not a file SLocEntry. 1606SourceLocation SourceManager::translateLineCol(FileID FID, 1607 unsigned Line, 1608 unsigned Col) const { 1609 if (FID.isInvalid()) 1610 return SourceLocation(); 1611 1612 bool Invalid = false; 1613 const SLocEntry &Entry = getSLocEntry(FID, &Invalid); 1614 if (Invalid) 1615 return SourceLocation(); 1616 1617 if (!Entry.isFile()) 1618 return SourceLocation(); 1619 1620 SourceLocation FileLoc = SourceLocation::getFileLoc(Entry.getOffset()); 1621 1622 if (Line == 1 && Col == 1) 1623 return FileLoc; 1624 1625 ContentCache *Content 1626 = const_cast<ContentCache *>(Entry.getFile().getContentCache()); 1627 if (!Content) 1628 return SourceLocation(); 1629 1630 // If this is the first use of line information for this buffer, compute the 1631 // SourceLineCache for it on demand. 1632 if (Content->SourceLineCache == 0) { 1633 bool MyInvalid = false; 1634 ComputeLineNumbers(Diag, Content, ContentCacheAlloc, *this, MyInvalid); 1635 if (MyInvalid) 1636 return SourceLocation(); 1637 } 1638 1639 if (Line > Content->NumLines) { 1640 unsigned Size = Content->getBuffer(Diag, *this)->getBufferSize(); 1641 if (Size > 0) 1642 --Size; 1643 return FileLoc.getLocWithOffset(Size); 1644 } 1645 1646 const llvm::MemoryBuffer *Buffer = Content->getBuffer(Diag, *this); 1647 unsigned FilePos = Content->SourceLineCache[Line - 1]; 1648 const char *Buf = Buffer->getBufferStart() + FilePos; 1649 unsigned BufLength = Buffer->getBufferSize() - FilePos; 1650 if (BufLength == 0) 1651 return FileLoc.getLocWithOffset(FilePos); 1652 1653 unsigned i = 0; 1654 1655 // Check that the given column is valid. 1656 while (i < BufLength-1 && i < Col-1 && Buf[i] != '\n' && Buf[i] != '\r') 1657 ++i; 1658 if (i < Col-1) 1659 return FileLoc.getLocWithOffset(FilePos + i); 1660 1661 return FileLoc.getLocWithOffset(FilePos + Col - 1); 1662} 1663 1664/// \brief Compute a map of macro argument chunks to their expanded source 1665/// location. Chunks that are not part of a macro argument will map to an 1666/// invalid source location. e.g. if a file contains one macro argument at 1667/// offset 100 with length 10, this is how the map will be formed: 1668/// 0 -> SourceLocation() 1669/// 100 -> Expanded macro arg location 1670/// 110 -> SourceLocation() 1671void SourceManager::computeMacroArgsCache(MacroArgsMap *&CachePtr, 1672 FileID FID) const { 1673 assert(!FID.isInvalid()); 1674 assert(!CachePtr); 1675 1676 CachePtr = new MacroArgsMap(); 1677 MacroArgsMap &MacroArgsCache = *CachePtr; 1678 // Initially no macro argument chunk is present. 1679 MacroArgsCache.insert(std::make_pair(0, SourceLocation())); 1680 1681 int ID = FID.ID; 1682 while (1) { 1683 ++ID; 1684 // Stop if there are no more FileIDs to check. 1685 if (ID > 0) { 1686 if (unsigned(ID) >= local_sloc_entry_size()) 1687 return; 1688 } else if (ID == -1) { 1689 return; 1690 } 1691 1692 const SrcMgr::SLocEntry &Entry = getSLocEntryByID(ID); 1693 if (Entry.isFile()) { 1694 SourceLocation IncludeLoc = Entry.getFile().getIncludeLoc(); 1695 if (IncludeLoc.isInvalid()) 1696 continue; 1697 if (!isInFileID(IncludeLoc, FID)) 1698 return; // No more files/macros that may be "contained" in this file. 1699 1700 // Skip the files/macros of the #include'd file, we only care about macros 1701 // that lexed macro arguments from our file. 1702 if (Entry.getFile().NumCreatedFIDs) 1703 ID += Entry.getFile().NumCreatedFIDs - 1/*because of next ++ID*/; 1704 continue; 1705 } 1706 1707 const ExpansionInfo &ExpInfo = Entry.getExpansion(); 1708 1709 if (ExpInfo.getExpansionLocStart().isFileID()) { 1710 if (!isInFileID(ExpInfo.getExpansionLocStart(), FID)) 1711 return; // No more files/macros that may be "contained" in this file. 1712 } 1713 1714 if (!ExpInfo.isMacroArgExpansion()) 1715 continue; 1716 1717 associateFileChunkWithMacroArgExp(MacroArgsCache, FID, 1718 ExpInfo.getSpellingLoc(), 1719 SourceLocation::getMacroLoc(Entry.getOffset()), 1720 getFileIDSize(FileID::get(ID))); 1721 } 1722} 1723 1724void SourceManager::associateFileChunkWithMacroArgExp( 1725 MacroArgsMap &MacroArgsCache, 1726 FileID FID, 1727 SourceLocation SpellLoc, 1728 SourceLocation ExpansionLoc, 1729 unsigned ExpansionLength) const { 1730 if (!SpellLoc.isFileID()) { 1731 unsigned SpellBeginOffs = SpellLoc.getOffset(); 1732 unsigned SpellEndOffs = SpellBeginOffs + ExpansionLength; 1733 1734 // The spelling range for this macro argument expansion can span multiple 1735 // consecutive FileID entries. Go through each entry contained in the 1736 // spelling range and if one is itself a macro argument expansion, recurse 1737 // and associate the file chunk that it represents. 1738 1739 FileID SpellFID; // Current FileID in the spelling range. 1740 unsigned SpellRelativeOffs; 1741 llvm::tie(SpellFID, SpellRelativeOffs) = getDecomposedLoc(SpellLoc); 1742 while (1) { 1743 const SLocEntry &Entry = getSLocEntry(SpellFID); 1744 unsigned SpellFIDBeginOffs = Entry.getOffset(); 1745 unsigned SpellFIDSize = getFileIDSize(SpellFID); 1746 unsigned SpellFIDEndOffs = SpellFIDBeginOffs + SpellFIDSize; 1747 const ExpansionInfo &Info = Entry.getExpansion(); 1748 if (Info.isMacroArgExpansion()) { 1749 unsigned CurrSpellLength; 1750 if (SpellFIDEndOffs < SpellEndOffs) 1751 CurrSpellLength = SpellFIDSize - SpellRelativeOffs; 1752 else 1753 CurrSpellLength = ExpansionLength; 1754 associateFileChunkWithMacroArgExp(MacroArgsCache, FID, 1755 Info.getSpellingLoc().getLocWithOffset(SpellRelativeOffs), 1756 ExpansionLoc, CurrSpellLength); 1757 } 1758 1759 if (SpellFIDEndOffs >= SpellEndOffs) 1760 return; // we covered all FileID entries in the spelling range. 1761 1762 // Move to the next FileID entry in the spelling range. 1763 unsigned advance = SpellFIDSize - SpellRelativeOffs + 1; 1764 ExpansionLoc = ExpansionLoc.getLocWithOffset(advance); 1765 ExpansionLength -= advance; 1766 ++SpellFID.ID; 1767 SpellRelativeOffs = 0; 1768 } 1769 1770 } 1771 1772 assert(SpellLoc.isFileID()); 1773 1774 unsigned BeginOffs; 1775 if (!isInFileID(SpellLoc, FID, &BeginOffs)) 1776 return; 1777 1778 unsigned EndOffs = BeginOffs + ExpansionLength; 1779 1780 // Add a new chunk for this macro argument. A previous macro argument chunk 1781 // may have been lexed again, so e.g. if the map is 1782 // 0 -> SourceLocation() 1783 // 100 -> Expanded loc #1 1784 // 110 -> SourceLocation() 1785 // and we found a new macro FileID that lexed from offet 105 with length 3, 1786 // the new map will be: 1787 // 0 -> SourceLocation() 1788 // 100 -> Expanded loc #1 1789 // 105 -> Expanded loc #2 1790 // 108 -> Expanded loc #1 1791 // 110 -> SourceLocation() 1792 // 1793 // Since re-lexed macro chunks will always be the same size or less of 1794 // previous chunks, we only need to find where the ending of the new macro 1795 // chunk is mapped to and update the map with new begin/end mappings. 1796 1797 MacroArgsMap::iterator I = MacroArgsCache.upper_bound(EndOffs); 1798 --I; 1799 SourceLocation EndOffsMappedLoc = I->second; 1800 MacroArgsCache[BeginOffs] = ExpansionLoc; 1801 MacroArgsCache[EndOffs] = EndOffsMappedLoc; 1802} 1803 1804/// \brief If \arg Loc points inside a function macro argument, the returned 1805/// location will be the macro location in which the argument was expanded. 1806/// If a macro argument is used multiple times, the expanded location will 1807/// be at the first expansion of the argument. 1808/// e.g. 1809/// MY_MACRO(foo); 1810/// ^ 1811/// Passing a file location pointing at 'foo', will yield a macro location 1812/// where 'foo' was expanded into. 1813SourceLocation 1814SourceManager::getMacroArgExpandedLocation(SourceLocation Loc) const { 1815 if (Loc.isInvalid() || !Loc.isFileID()) 1816 return Loc; 1817 1818 FileID FID; 1819 unsigned Offset; 1820 llvm::tie(FID, Offset) = getDecomposedLoc(Loc); 1821 if (FID.isInvalid()) 1822 return Loc; 1823 1824 MacroArgsMap *&MacroArgsCache = MacroArgsCacheMap[FID]; 1825 if (!MacroArgsCache) 1826 computeMacroArgsCache(MacroArgsCache, FID); 1827 1828 assert(!MacroArgsCache->empty()); 1829 MacroArgsMap::iterator I = MacroArgsCache->upper_bound(Offset); 1830 --I; 1831 1832 unsigned MacroArgBeginOffs = I->first; 1833 SourceLocation MacroArgExpandedLoc = I->second; 1834 if (MacroArgExpandedLoc.isValid()) 1835 return MacroArgExpandedLoc.getLocWithOffset(Offset - MacroArgBeginOffs); 1836 1837 return Loc; 1838} 1839 1840/// Given a decomposed source location, move it up the include/expansion stack 1841/// to the parent source location. If this is possible, return the decomposed 1842/// version of the parent in Loc and return false. If Loc is the top-level 1843/// entry, return true and don't modify it. 1844static bool MoveUpIncludeHierarchy(std::pair<FileID, unsigned> &Loc, 1845 const SourceManager &SM) { 1846 SourceLocation UpperLoc; 1847 const SrcMgr::SLocEntry &Entry = SM.getSLocEntry(Loc.first); 1848 if (Entry.isExpansion()) 1849 UpperLoc = Entry.getExpansion().getExpansionLocStart(); 1850 else 1851 UpperLoc = Entry.getFile().getIncludeLoc(); 1852 1853 if (UpperLoc.isInvalid()) 1854 return true; // We reached the top. 1855 1856 Loc = SM.getDecomposedLoc(UpperLoc); 1857 return false; 1858} 1859 1860 1861/// \brief Determines the order of 2 source locations in the translation unit. 1862/// 1863/// \returns true if LHS source location comes before RHS, false otherwise. 1864bool SourceManager::isBeforeInTranslationUnit(SourceLocation LHS, 1865 SourceLocation RHS) const { 1866 assert(LHS.isValid() && RHS.isValid() && "Passed invalid source location!"); 1867 if (LHS == RHS) 1868 return false; 1869 1870 std::pair<FileID, unsigned> LOffs = getDecomposedLoc(LHS); 1871 std::pair<FileID, unsigned> ROffs = getDecomposedLoc(RHS); 1872 1873 // If the source locations are in the same file, just compare offsets. 1874 if (LOffs.first == ROffs.first) 1875 return LOffs.second < ROffs.second; 1876 1877 // If we are comparing a source location with multiple locations in the same 1878 // file, we get a big win by caching the result. 1879 if (IsBeforeInTUCache.isCacheValid(LOffs.first, ROffs.first)) 1880 return IsBeforeInTUCache.getCachedResult(LOffs.second, ROffs.second); 1881 1882 // Okay, we missed in the cache, start updating the cache for this query. 1883 IsBeforeInTUCache.setQueryFIDs(LOffs.first, ROffs.first, 1884 /*isLFIDBeforeRFID=*/LOffs.first.ID < ROffs.first.ID); 1885 1886 // We need to find the common ancestor. The only way of doing this is to 1887 // build the complete include chain for one and then walking up the chain 1888 // of the other looking for a match. 1889 // We use a map from FileID to Offset to store the chain. Easier than writing 1890 // a custom set hash info that only depends on the first part of a pair. 1891 typedef llvm::DenseMap<FileID, unsigned> LocSet; 1892 LocSet LChain; 1893 do { 1894 LChain.insert(LOffs); 1895 // We catch the case where LOffs is in a file included by ROffs and 1896 // quit early. The other way round unfortunately remains suboptimal. 1897 } while (LOffs.first != ROffs.first && !MoveUpIncludeHierarchy(LOffs, *this)); 1898 LocSet::iterator I; 1899 while((I = LChain.find(ROffs.first)) == LChain.end()) { 1900 if (MoveUpIncludeHierarchy(ROffs, *this)) 1901 break; // Met at topmost file. 1902 } 1903 if (I != LChain.end()) 1904 LOffs = *I; 1905 1906 // If we exited because we found a nearest common ancestor, compare the 1907 // locations within the common file and cache them. 1908 if (LOffs.first == ROffs.first) { 1909 IsBeforeInTUCache.setCommonLoc(LOffs.first, LOffs.second, ROffs.second); 1910 return IsBeforeInTUCache.getCachedResult(LOffs.second, ROffs.second); 1911 } 1912 1913 // This can happen if a location is in a built-ins buffer. 1914 // But see PR5662. 1915 // Clear the lookup cache, it depends on a common location. 1916 IsBeforeInTUCache.clear(); 1917 bool LIsBuiltins = strcmp("<built-in>", 1918 getBuffer(LOffs.first)->getBufferIdentifier()) == 0; 1919 bool RIsBuiltins = strcmp("<built-in>", 1920 getBuffer(ROffs.first)->getBufferIdentifier()) == 0; 1921 // built-in is before non-built-in 1922 if (LIsBuiltins != RIsBuiltins) 1923 return LIsBuiltins; 1924 assert(LIsBuiltins && RIsBuiltins && 1925 "Non-built-in locations must be rooted in the main file"); 1926 // Both are in built-in buffers, but from different files. We just claim that 1927 // lower IDs come first. 1928 return LOffs.first < ROffs.first; 1929} 1930 1931void SourceManager::PrintStats() const { 1932 llvm::errs() << "\n*** Source Manager Stats:\n"; 1933 llvm::errs() << FileInfos.size() << " files mapped, " << MemBufferInfos.size() 1934 << " mem buffers mapped.\n"; 1935 llvm::errs() << LocalSLocEntryTable.size() << " local SLocEntry's allocated (" 1936 << llvm::capacity_in_bytes(LocalSLocEntryTable) 1937 << " bytes of capacity), " 1938 << NextLocalOffset << "B of Sloc address space used.\n"; 1939 llvm::errs() << LoadedSLocEntryTable.size() 1940 << " loaded SLocEntries allocated, " 1941 << MaxLoadedOffset - CurrentLoadedOffset 1942 << "B of Sloc address space used.\n"; 1943 1944 unsigned NumLineNumsComputed = 0; 1945 unsigned NumFileBytesMapped = 0; 1946 for (fileinfo_iterator I = fileinfo_begin(), E = fileinfo_end(); I != E; ++I){ 1947 NumLineNumsComputed += I->second->SourceLineCache != 0; 1948 NumFileBytesMapped += I->second->getSizeBytesMapped(); 1949 } 1950 unsigned NumMacroArgsComputed = MacroArgsCacheMap.size(); 1951 1952 llvm::errs() << NumFileBytesMapped << " bytes of files mapped, " 1953 << NumLineNumsComputed << " files with line #'s computed, " 1954 << NumMacroArgsComputed << " files with macro args computed.\n"; 1955 llvm::errs() << "FileID scans: " << NumLinearScans << " linear, " 1956 << NumBinaryProbes << " binary.\n"; 1957} 1958 1959ExternalSLocEntrySource::~ExternalSLocEntrySource() { } 1960 1961/// Return the amount of memory used by memory buffers, breaking down 1962/// by heap-backed versus mmap'ed memory. 1963SourceManager::MemoryBufferSizes SourceManager::getMemoryBufferSizes() const { 1964 size_t malloc_bytes = 0; 1965 size_t mmap_bytes = 0; 1966 1967 for (unsigned i = 0, e = MemBufferInfos.size(); i != e; ++i) 1968 if (size_t sized_mapped = MemBufferInfos[i]->getSizeBytesMapped()) 1969 switch (MemBufferInfos[i]->getMemoryBufferKind()) { 1970 case llvm::MemoryBuffer::MemoryBuffer_MMap: 1971 mmap_bytes += sized_mapped; 1972 break; 1973 case llvm::MemoryBuffer::MemoryBuffer_Malloc: 1974 malloc_bytes += sized_mapped; 1975 break; 1976 } 1977 1978 return MemoryBufferSizes(malloc_bytes, mmap_bytes); 1979} 1980 1981size_t SourceManager::getDataStructureSizes() const { 1982 size_t size = llvm::capacity_in_bytes(MemBufferInfos) 1983 + llvm::capacity_in_bytes(LocalSLocEntryTable) 1984 + llvm::capacity_in_bytes(LoadedSLocEntryTable) 1985 + llvm::capacity_in_bytes(SLocEntryLoaded) 1986 + llvm::capacity_in_bytes(FileInfos); 1987 1988 if (OverriddenFilesInfo) 1989 size += llvm::capacity_in_bytes(OverriddenFilesInfo->OverriddenFiles); 1990 1991 return size; 1992} 1993