|
150
|
1 //===- SourceManager.cpp - Track and cache source files -------------------===//
|
|
|
2 //
|
|
|
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
|
4 // See https://llvm.org/LICENSE.txt for license information.
|
|
|
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
|
6 //
|
|
|
7 //===----------------------------------------------------------------------===//
|
|
|
8 //
|
|
|
9 // This file implements the SourceManager interface.
|
|
|
10 //
|
|
|
11 //===----------------------------------------------------------------------===//
|
|
|
12
|
|
|
13 #include "clang/Basic/SourceManager.h"
|
|
|
14 #include "clang/Basic/Diagnostic.h"
|
|
|
15 #include "clang/Basic/FileManager.h"
|
|
|
16 #include "clang/Basic/LLVM.h"
|
|
|
17 #include "clang/Basic/SourceLocation.h"
|
|
|
18 #include "clang/Basic/SourceManagerInternals.h"
|
|
|
19 #include "llvm/ADT/DenseMap.h"
|
|
173
|
20 #include "llvm/ADT/None.h"
|
|
150
|
21 #include "llvm/ADT/Optional.h"
|
|
|
22 #include "llvm/ADT/STLExtras.h"
|
|
|
23 #include "llvm/ADT/SmallVector.h"
|
|
173
|
24 #include "llvm/ADT/StringRef.h"
|
|
150
|
25 #include "llvm/ADT/StringSwitch.h"
|
|
|
26 #include "llvm/Support/Allocator.h"
|
|
|
27 #include "llvm/Support/Capacity.h"
|
|
|
28 #include "llvm/Support/Compiler.h"
|
|
|
29 #include "llvm/Support/ErrorHandling.h"
|
|
|
30 #include "llvm/Support/FileSystem.h"
|
|
|
31 #include "llvm/Support/MathExtras.h"
|
|
|
32 #include "llvm/Support/MemoryBuffer.h"
|
|
|
33 #include "llvm/Support/Path.h"
|
|
|
34 #include "llvm/Support/raw_ostream.h"
|
|
|
35 #include <algorithm>
|
|
|
36 #include <cassert>
|
|
|
37 #include <cstddef>
|
|
|
38 #include <cstdint>
|
|
|
39 #include <memory>
|
|
|
40 #include <tuple>
|
|
|
41 #include <utility>
|
|
|
42 #include <vector>
|
|
|
43
|
|
|
44 using namespace clang;
|
|
|
45 using namespace SrcMgr;
|
|
|
46 using llvm::MemoryBuffer;
|
|
|
47
|
|
|
48 //===----------------------------------------------------------------------===//
|
|
|
49 // SourceManager Helper Classes
|
|
|
50 //===----------------------------------------------------------------------===//
|
|
|
51
|
|
|
52 ContentCache::~ContentCache() {
|
|
|
53 if (shouldFreeBuffer())
|
|
|
54 delete Buffer.getPointer();
|
|
|
55 }
|
|
|
56
|
|
|
57 /// getSizeBytesMapped - Returns the number of bytes actually mapped for this
|
|
|
58 /// ContentCache. This can be 0 if the MemBuffer was not actually expanded.
|
|
|
59 unsigned ContentCache::getSizeBytesMapped() const {
|
|
|
60 return Buffer.getPointer() ? Buffer.getPointer()->getBufferSize() : 0;
|
|
|
61 }
|
|
|
62
|
|
|
63 /// Returns the kind of memory used to back the memory buffer for
|
|
|
64 /// this content cache. This is used for performance analysis.
|
|
|
65 llvm::MemoryBuffer::BufferKind ContentCache::getMemoryBufferKind() const {
|
|
|
66 assert(Buffer.getPointer());
|
|
|
67
|
|
|
68 // Should be unreachable, but keep for sanity.
|
|
|
69 if (!Buffer.getPointer())
|
|
|
70 return llvm::MemoryBuffer::MemoryBuffer_Malloc;
|
|
|
71
|
|
|
72 const llvm::MemoryBuffer *buf = Buffer.getPointer();
|
|
|
73 return buf->getBufferKind();
|
|
|
74 }
|
|
|
75
|
|
|
76 /// getSize - Returns the size of the content encapsulated by this ContentCache.
|
|
|
77 /// This can be the size of the source file or the size of an arbitrary
|
|
|
78 /// scratch buffer. If the ContentCache encapsulates a source file, that
|
|
|
79 /// file is not lazily brought in from disk to satisfy this query.
|
|
|
80 unsigned ContentCache::getSize() const {
|
|
|
81 return Buffer.getPointer() ? (unsigned) Buffer.getPointer()->getBufferSize()
|
|
|
82 : (unsigned) ContentsEntry->getSize();
|
|
|
83 }
|
|
|
84
|
|
|
85 void ContentCache::replaceBuffer(const llvm::MemoryBuffer *B, bool DoNotFree) {
|
|
|
86 if (B && B == Buffer.getPointer()) {
|
|
|
87 assert(0 && "Replacing with the same buffer");
|
|
|
88 Buffer.setInt(DoNotFree? DoNotFreeFlag : 0);
|
|
|
89 return;
|
|
|
90 }
|
|
|
91
|
|
|
92 if (shouldFreeBuffer())
|
|
|
93 delete Buffer.getPointer();
|
|
|
94 Buffer.setPointer(B);
|
|
|
95 Buffer.setInt((B && DoNotFree) ? DoNotFreeFlag : 0);
|
|
|
96 }
|
|
|
97
|
|
|
98 const char *ContentCache::getInvalidBOM(StringRef BufStr) {
|
|
|
99 // If the buffer is valid, check to see if it has a UTF Byte Order Mark
|
|
|
100 // (BOM). We only support UTF-8 with and without a BOM right now. See
|
|
|
101 // http://en.wikipedia.org/wiki/Byte_order_mark for more information.
|
|
|
102 const char *InvalidBOM =
|
|
|
103 llvm::StringSwitch<const char *>(BufStr)
|
|
|
104 .StartsWith(llvm::StringLiteral::withInnerNUL("\x00\x00\xFE\xFF"),
|
|
|
105 "UTF-32 (BE)")
|
|
|
106 .StartsWith(llvm::StringLiteral::withInnerNUL("\xFF\xFE\x00\x00"),
|
|
|
107 "UTF-32 (LE)")
|
|
|
108 .StartsWith("\xFE\xFF", "UTF-16 (BE)")
|
|
|
109 .StartsWith("\xFF\xFE", "UTF-16 (LE)")
|
|
|
110 .StartsWith("\x2B\x2F\x76", "UTF-7")
|
|
|
111 .StartsWith("\xF7\x64\x4C", "UTF-1")
|
|
|
112 .StartsWith("\xDD\x73\x66\x73", "UTF-EBCDIC")
|
|
|
113 .StartsWith("\x0E\xFE\xFF", "SCSU")
|
|
|
114 .StartsWith("\xFB\xEE\x28", "BOCU-1")
|
|
|
115 .StartsWith("\x84\x31\x95\x33", "GB-18030")
|
|
|
116 .Default(nullptr);
|
|
|
117
|
|
|
118 return InvalidBOM;
|
|
|
119 }
|
|
|
120
|
|
|
121 const llvm::MemoryBuffer *ContentCache::getBuffer(DiagnosticsEngine &Diag,
|
|
|
122 FileManager &FM,
|
|
|
123 SourceLocation Loc,
|
|
|
124 bool *Invalid) const {
|
|
|
125 // Lazily create the Buffer for ContentCaches that wrap files. If we already
|
|
|
126 // computed it, just return what we have.
|
|
|
127 if (Buffer.getPointer() || !ContentsEntry) {
|
|
|
128 if (Invalid)
|
|
|
129 *Invalid = isBufferInvalid();
|
|
|
130
|
|
|
131 return Buffer.getPointer();
|
|
|
132 }
|
|
|
133
|
|
|
134 // Check that the file's size fits in an 'unsigned' (with room for a
|
|
|
135 // past-the-end value). This is deeply regrettable, but various parts of
|
|
|
136 // Clang (including elsewhere in this file!) use 'unsigned' to represent file
|
|
|
137 // offsets, line numbers, string literal lengths, and so on, and fail
|
|
|
138 // miserably on large source files.
|
|
|
139 if ((uint64_t)ContentsEntry->getSize() >=
|
|
|
140 std::numeric_limits<unsigned>::max()) {
|
|
|
141 // We can't make a memory buffer of the required size, so just make a small
|
|
|
142 // one. We should never hit a situation where we've already parsed to a
|
|
|
143 // later offset of the file, so it shouldn't matter that the buffer is
|
|
|
144 // smaller than the file.
|
|
|
145 Buffer.setPointer(
|
|
|
146 llvm::MemoryBuffer::getMemBuffer("", ContentsEntry->getName())
|
|
|
147 .release());
|
|
|
148 if (Diag.isDiagnosticInFlight())
|
|
|
149 Diag.SetDelayedDiagnostic(diag::err_file_too_large,
|
|
|
150 ContentsEntry->getName());
|
|
|
151 else
|
|
|
152 Diag.Report(Loc, diag::err_file_too_large)
|
|
|
153 << ContentsEntry->getName();
|
|
|
154
|
|
|
155 Buffer.setInt(Buffer.getInt() | InvalidFlag);
|
|
|
156 if (Invalid) *Invalid = true;
|
|
|
157 return Buffer.getPointer();
|
|
|
158 }
|
|
|
159
|
|
|
160 auto BufferOrError = FM.getBufferForFile(ContentsEntry, IsFileVolatile);
|
|
|
161
|
|
|
162 // If we were unable to open the file, then we are in an inconsistent
|
|
|
163 // situation where the content cache referenced a file which no longer
|
|
|
164 // exists. Most likely, we were using a stat cache with an invalid entry but
|
|
|
165 // the file could also have been removed during processing. Since we can't
|
|
|
166 // really deal with this situation, just create an empty buffer.
|
|
|
167 //
|
|
|
168 // FIXME: This is definitely not ideal, but our immediate clients can't
|
|
|
169 // currently handle returning a null entry here. Ideally we should detect
|
|
|
170 // that we are in an inconsistent situation and error out as quickly as
|
|
|
171 // possible.
|
|
|
172 if (!BufferOrError) {
|
|
|
173 StringRef FillStr("<<<MISSING SOURCE FILE>>>\n");
|
|
|
174 auto BackupBuffer = llvm::WritableMemoryBuffer::getNewUninitMemBuffer(
|
|
|
175 ContentsEntry->getSize(), "<invalid>");
|
|
|
176 char *Ptr = BackupBuffer->getBufferStart();
|
|
|
177 for (unsigned i = 0, e = ContentsEntry->getSize(); i != e; ++i)
|
|
|
178 Ptr[i] = FillStr[i % FillStr.size()];
|
|
|
179 Buffer.setPointer(BackupBuffer.release());
|
|
|
180
|
|
|
181 if (Diag.isDiagnosticInFlight())
|
|
|
182 Diag.SetDelayedDiagnostic(diag::err_cannot_open_file,
|
|
|
183 ContentsEntry->getName(),
|
|
|
184 BufferOrError.getError().message());
|
|
|
185 else
|
|
|
186 Diag.Report(Loc, diag::err_cannot_open_file)
|
|
|
187 << ContentsEntry->getName() << BufferOrError.getError().message();
|
|
|
188
|
|
|
189 Buffer.setInt(Buffer.getInt() | InvalidFlag);
|
|
|
190
|
|
|
191 if (Invalid) *Invalid = true;
|
|
|
192 return Buffer.getPointer();
|
|
|
193 }
|
|
|
194
|
|
|
195 Buffer.setPointer(BufferOrError->release());
|
|
|
196
|
|
|
197 // Check that the file's size is the same as in the file entry (which may
|
|
|
198 // have come from a stat cache).
|
|
|
199 if (getRawBuffer()->getBufferSize() != (size_t)ContentsEntry->getSize()) {
|
|
|
200 if (Diag.isDiagnosticInFlight())
|
|
|
201 Diag.SetDelayedDiagnostic(diag::err_file_modified,
|
|
|
202 ContentsEntry->getName());
|
|
|
203 else
|
|
|
204 Diag.Report(Loc, diag::err_file_modified)
|
|
|
205 << ContentsEntry->getName();
|
|
|
206
|
|
|
207 Buffer.setInt(Buffer.getInt() | InvalidFlag);
|
|
|
208 if (Invalid) *Invalid = true;
|
|
|
209 return Buffer.getPointer();
|
|
|
210 }
|
|
|
211
|
|
|
212 // If the buffer is valid, check to see if it has a UTF Byte Order Mark
|
|
|
213 // (BOM). We only support UTF-8 with and without a BOM right now. See
|
|
|
214 // http://en.wikipedia.org/wiki/Byte_order_mark for more information.
|
|
|
215 StringRef BufStr = Buffer.getPointer()->getBuffer();
|
|
|
216 const char *InvalidBOM = getInvalidBOM(BufStr);
|
|
|
217
|
|
|
218 if (InvalidBOM) {
|
|
|
219 Diag.Report(Loc, diag::err_unsupported_bom)
|
|
|
220 << InvalidBOM << ContentsEntry->getName();
|
|
|
221 Buffer.setInt(Buffer.getInt() | InvalidFlag);
|
|
|
222 }
|
|
|
223
|
|
|
224 if (Invalid)
|
|
|
225 *Invalid = isBufferInvalid();
|
|
|
226
|
|
|
227 return Buffer.getPointer();
|
|
|
228 }
|
|
|
229
|
|
|
230 unsigned LineTableInfo::getLineTableFilenameID(StringRef Name) {
|
|
|
231 auto IterBool = FilenameIDs.try_emplace(Name, FilenamesByID.size());
|
|
|
232 if (IterBool.second)
|
|
|
233 FilenamesByID.push_back(&*IterBool.first);
|
|
|
234 return IterBool.first->second;
|
|
|
235 }
|
|
|
236
|
|
|
237 /// Add a line note to the line table that indicates that there is a \#line or
|
|
|
238 /// GNU line marker at the specified FID/Offset location which changes the
|
|
|
239 /// presumed location to LineNo/FilenameID. If EntryExit is 0, then this doesn't
|
|
|
240 /// change the presumed \#include stack. If it is 1, this is a file entry, if
|
|
|
241 /// it is 2 then this is a file exit. FileKind specifies whether this is a
|
|
|
242 /// system header or extern C system header.
|
|
|
243 void LineTableInfo::AddLineNote(FileID FID, unsigned Offset, unsigned LineNo,
|
|
|
244 int FilenameID, unsigned EntryExit,
|
|
|
245 SrcMgr::CharacteristicKind FileKind) {
|
|
|
246 std::vector<LineEntry> &Entries = LineEntries[FID];
|
|
|
247
|
|
|
248 // An unspecified FilenameID means use the last filename if available, or the
|
|
|
249 // main source file otherwise.
|
|
|
250 if (FilenameID == -1 && !Entries.empty())
|
|
|
251 FilenameID = Entries.back().FilenameID;
|
|
|
252
|
|
|
253 assert((Entries.empty() || Entries.back().FileOffset < Offset) &&
|
|
|
254 "Adding line entries out of order!");
|
|
|
255
|
|
|
256 unsigned IncludeOffset = 0;
|
|
|
257 if (EntryExit == 0) { // No #include stack change.
|
|
|
258 IncludeOffset = Entries.empty() ? 0 : Entries.back().IncludeOffset;
|
|
|
259 } else if (EntryExit == 1) {
|
|
|
260 IncludeOffset = Offset-1;
|
|
|
261 } else if (EntryExit == 2) {
|
|
|
262 assert(!Entries.empty() && Entries.back().IncludeOffset &&
|
|
|
263 "PPDirectives should have caught case when popping empty include stack");
|
|
|
264
|
|
|
265 // Get the include loc of the last entries' include loc as our include loc.
|
|
|
266 IncludeOffset = 0;
|
|
|
267 if (const LineEntry *PrevEntry =
|
|
|
268 FindNearestLineEntry(FID, Entries.back().IncludeOffset))
|
|
|
269 IncludeOffset = PrevEntry->IncludeOffset;
|
|
|
270 }
|
|
|
271
|
|
|
272 Entries.push_back(LineEntry::get(Offset, LineNo, FilenameID, FileKind,
|
|
|
273 IncludeOffset));
|
|
|
274 }
|
|
|
275
|
|
|
276 /// FindNearestLineEntry - Find the line entry nearest to FID that is before
|
|
|
277 /// it. If there is no line entry before Offset in FID, return null.
|
|
|
278 const LineEntry *LineTableInfo::FindNearestLineEntry(FileID FID,
|
|
|
279 unsigned Offset) {
|
|
|
280 const std::vector<LineEntry> &Entries = LineEntries[FID];
|
|
|
281 assert(!Entries.empty() && "No #line entries for this FID after all!");
|
|
|
282
|
|
|
283 // It is very common for the query to be after the last #line, check this
|
|
|
284 // first.
|
|
|
285 if (Entries.back().FileOffset <= Offset)
|
|
|
286 return &Entries.back();
|
|
|
287
|
|
|
288 // Do a binary search to find the maximal element that is still before Offset.
|
|
|
289 std::vector<LineEntry>::const_iterator I = llvm::upper_bound(Entries, Offset);
|
|
|
290 if (I == Entries.begin())
|
|
|
291 return nullptr;
|
|
|
292 return &*--I;
|
|
|
293 }
|
|
|
294
|
|
|
295 /// Add a new line entry that has already been encoded into
|
|
|
296 /// the internal representation of the line table.
|
|
|
297 void LineTableInfo::AddEntry(FileID FID,
|
|
|
298 const std::vector<LineEntry> &Entries) {
|
|
|
299 LineEntries[FID] = Entries;
|
|
|
300 }
|
|
|
301
|
|
|
302 /// getLineTableFilenameID - Return the uniqued ID for the specified filename.
|
|
|
303 unsigned SourceManager::getLineTableFilenameID(StringRef Name) {
|
|
|
304 return getLineTable().getLineTableFilenameID(Name);
|
|
|
305 }
|
|
|
306
|
|
|
307 /// AddLineNote - Add a line note to the line table for the FileID and offset
|
|
|
308 /// specified by Loc. If FilenameID is -1, it is considered to be
|
|
|
309 /// unspecified.
|
|
|
310 void SourceManager::AddLineNote(SourceLocation Loc, unsigned LineNo,
|
|
|
311 int FilenameID, bool IsFileEntry,
|
|
|
312 bool IsFileExit,
|
|
|
313 SrcMgr::CharacteristicKind FileKind) {
|
|
|
314 std::pair<FileID, unsigned> LocInfo = getDecomposedExpansionLoc(Loc);
|
|
|
315
|
|
|
316 bool Invalid = false;
|
|
|
317 const SLocEntry &Entry = getSLocEntry(LocInfo.first, &Invalid);
|
|
|
318 if (!Entry.isFile() || Invalid)
|
|
|
319 return;
|
|
|
320
|
|
|
321 const SrcMgr::FileInfo &FileInfo = Entry.getFile();
|
|
|
322
|
|
|
323 // Remember that this file has #line directives now if it doesn't already.
|
|
|
324 const_cast<SrcMgr::FileInfo&>(FileInfo).setHasLineDirectives();
|
|
|
325
|
|
|
326 (void) getLineTable();
|
|
|
327
|
|
|
328 unsigned EntryExit = 0;
|
|
|
329 if (IsFileEntry)
|
|
|
330 EntryExit = 1;
|
|
|
331 else if (IsFileExit)
|
|
|
332 EntryExit = 2;
|
|
|
333
|
|
|
334 LineTable->AddLineNote(LocInfo.first, LocInfo.second, LineNo, FilenameID,
|
|
|
335 EntryExit, FileKind);
|
|
|
336 }
|
|
|
337
|
|
|
338 LineTableInfo &SourceManager::getLineTable() {
|
|
|
339 if (!LineTable)
|
|
|
340 LineTable.reset(new LineTableInfo());
|
|
|
341 return *LineTable;
|
|
|
342 }
|
|
|
343
|
|
|
344 //===----------------------------------------------------------------------===//
|
|
|
345 // Private 'Create' methods.
|
|
|
346 //===----------------------------------------------------------------------===//
|
|
|
347
|
|
|
348 SourceManager::SourceManager(DiagnosticsEngine &Diag, FileManager &FileMgr,
|
|
|
349 bool UserFilesAreVolatile)
|
|
|
350 : Diag(Diag), FileMgr(FileMgr), UserFilesAreVolatile(UserFilesAreVolatile) {
|
|
|
351 clearIDTables();
|
|
|
352 Diag.setSourceManager(this);
|
|
|
353 }
|
|
|
354
|
|
|
355 SourceManager::~SourceManager() {
|
|
|
356 // Delete FileEntry objects corresponding to content caches. Since the actual
|
|
|
357 // content cache objects are bump pointer allocated, we just have to run the
|
|
|
358 // dtors, but we call the deallocate method for completeness.
|
|
|
359 for (unsigned i = 0, e = MemBufferInfos.size(); i != e; ++i) {
|
|
|
360 if (MemBufferInfos[i]) {
|
|
|
361 MemBufferInfos[i]->~ContentCache();
|
|
|
362 ContentCacheAlloc.Deallocate(MemBufferInfos[i]);
|
|
|
363 }
|
|
|
364 }
|
|
|
365 for (llvm::DenseMap<const FileEntry*, SrcMgr::ContentCache*>::iterator
|
|
|
366 I = FileInfos.begin(), E = FileInfos.end(); I != E; ++I) {
|
|
|
367 if (I->second) {
|
|
|
368 I->second->~ContentCache();
|
|
|
369 ContentCacheAlloc.Deallocate(I->second);
|
|
|
370 }
|
|
|
371 }
|
|
|
372 }
|
|
|
373
|
|
|
374 void SourceManager::clearIDTables() {
|
|
|
375 MainFileID = FileID();
|
|
|
376 LocalSLocEntryTable.clear();
|
|
|
377 LoadedSLocEntryTable.clear();
|
|
|
378 SLocEntryLoaded.clear();
|
|
|
379 LastLineNoFileIDQuery = FileID();
|
|
|
380 LastLineNoContentCache = nullptr;
|
|
|
381 LastFileIDLookup = FileID();
|
|
|
382
|
|
|
383 if (LineTable)
|
|
|
384 LineTable->clear();
|
|
|
385
|
|
|
386 // Use up FileID #0 as an invalid expansion.
|
|
|
387 NextLocalOffset = 0;
|
|
|
388 CurrentLoadedOffset = MaxLoadedOffset;
|
|
|
389 createExpansionLoc(SourceLocation(), SourceLocation(), SourceLocation(), 1);
|
|
|
390 }
|
|
|
391
|
|
173
|
392 bool SourceManager::isMainFile(FileEntryRef SourceFile) {
|
|
|
393 assert(MainFileID.isValid() && "expected initialized SourceManager");
|
|
|
394 auto FE = getFileEntryRefForID(MainFileID);
|
|
|
395 if (!FE)
|
|
|
396 return false;
|
|
|
397 return FE->getUID() == SourceFile.getUID();
|
|
|
398 }
|
|
|
399
|
|
150
|
400 void SourceManager::initializeForReplay(const SourceManager &Old) {
|
|
|
401 assert(MainFileID.isInvalid() && "expected uninitialized SourceManager");
|
|
|
402
|
|
|
403 auto CloneContentCache = [&](const ContentCache *Cache) -> ContentCache * {
|
|
|
404 auto *Clone = new (ContentCacheAlloc.Allocate<ContentCache>()) ContentCache;
|
|
|
405 Clone->OrigEntry = Cache->OrigEntry;
|
|
|
406 Clone->ContentsEntry = Cache->ContentsEntry;
|
|
|
407 Clone->BufferOverridden = Cache->BufferOverridden;
|
|
|
408 Clone->IsFileVolatile = Cache->IsFileVolatile;
|
|
|
409 Clone->IsTransient = Cache->IsTransient;
|
|
|
410 Clone->replaceBuffer(Cache->getRawBuffer(), /*DoNotFree*/true);
|
|
|
411 return Clone;
|
|
|
412 };
|
|
|
413
|
|
|
414 // Ensure all SLocEntries are loaded from the external source.
|
|
|
415 for (unsigned I = 0, N = Old.LoadedSLocEntryTable.size(); I != N; ++I)
|
|
|
416 if (!Old.SLocEntryLoaded[I])
|
|
|
417 Old.loadSLocEntry(I, nullptr);
|
|
|
418
|
|
|
419 // Inherit any content cache data from the old source manager.
|
|
|
420 for (auto &FileInfo : Old.FileInfos) {
|
|
|
421 SrcMgr::ContentCache *&Slot = FileInfos[FileInfo.first];
|
|
|
422 if (Slot)
|
|
|
423 continue;
|
|
|
424 Slot = CloneContentCache(FileInfo.second);
|
|
|
425 }
|
|
|
426 }
|
|
|
427
|
|
|
428 /// getOrCreateContentCache - Create or return a cached ContentCache for the
|
|
|
429 /// specified file.
|
|
|
430 const ContentCache *
|
|
|
431 SourceManager::getOrCreateContentCache(const FileEntry *FileEnt,
|
|
|
432 bool isSystemFile) {
|
|
|
433 assert(FileEnt && "Didn't specify a file entry to use?");
|
|
|
434
|
|
|
435 // Do we already have information about this file?
|
|
|
436 ContentCache *&Entry = FileInfos[FileEnt];
|
|
|
437 if (Entry) return Entry;
|
|
|
438
|
|
|
439 // Nope, create a new Cache entry.
|
|
|
440 Entry = ContentCacheAlloc.Allocate<ContentCache>();
|
|
|
441
|
|
|
442 if (OverriddenFilesInfo) {
|
|
|
443 // If the file contents are overridden with contents from another file,
|
|
|
444 // pass that file to ContentCache.
|
|
|
445 llvm::DenseMap<const FileEntry *, const FileEntry *>::iterator
|
|
|
446 overI = OverriddenFilesInfo->OverriddenFiles.find(FileEnt);
|
|
|
447 if (overI == OverriddenFilesInfo->OverriddenFiles.end())
|
|
|
448 new (Entry) ContentCache(FileEnt);
|
|
|
449 else
|
|
|
450 new (Entry) ContentCache(OverridenFilesKeepOriginalName ? FileEnt
|
|
|
451 : overI->second,
|
|
|
452 overI->second);
|
|
|
453 } else {
|
|
|
454 new (Entry) ContentCache(FileEnt);
|
|
|
455 }
|
|
|
456
|
|
|
457 Entry->IsFileVolatile = UserFilesAreVolatile && !isSystemFile;
|
|
|
458 Entry->IsTransient = FilesAreTransient;
|
|
|
459
|
|
|
460 return Entry;
|
|
|
461 }
|
|
|
462
|
|
|
463 /// Create a new ContentCache for the specified memory buffer.
|
|
|
464 /// This does no caching.
|
|
|
465 const ContentCache *
|
|
|
466 SourceManager::createMemBufferContentCache(const llvm::MemoryBuffer *Buffer,
|
|
|
467 bool DoNotFree) {
|
|
|
468 // Add a new ContentCache to the MemBufferInfos list and return it.
|
|
|
469 ContentCache *Entry = ContentCacheAlloc.Allocate<ContentCache>();
|
|
|
470 new (Entry) ContentCache();
|
|
|
471 MemBufferInfos.push_back(Entry);
|
|
|
472 Entry->replaceBuffer(Buffer, DoNotFree);
|
|
|
473 return Entry;
|
|
|
474 }
|
|
|
475
|
|
|
476 const SrcMgr::SLocEntry &SourceManager::loadSLocEntry(unsigned Index,
|
|
|
477 bool *Invalid) const {
|
|
|
478 assert(!SLocEntryLoaded[Index]);
|
|
|
479 if (ExternalSLocEntries->ReadSLocEntry(-(static_cast<int>(Index) + 2))) {
|
|
|
480 if (Invalid)
|
|
|
481 *Invalid = true;
|
|
|
482 // If the file of the SLocEntry changed we could still have loaded it.
|
|
|
483 if (!SLocEntryLoaded[Index]) {
|
|
|
484 // Try to recover; create a SLocEntry so the rest of clang can handle it.
|
|
|
485 LoadedSLocEntryTable[Index] = SLocEntry::get(
|
|
|
486 0, FileInfo::get(SourceLocation(), getFakeContentCacheForRecovery(),
|
|
|
487 SrcMgr::C_User, ""));
|
|
|
488 }
|
|
|
489 }
|
|
|
490
|
|
|
491 return LoadedSLocEntryTable[Index];
|
|
|
492 }
|
|
|
493
|
|
|
494 std::pair<int, unsigned>
|
|
|
495 SourceManager::AllocateLoadedSLocEntries(unsigned NumSLocEntries,
|
|
|
496 unsigned TotalSize) {
|
|
|
497 assert(ExternalSLocEntries && "Don't have an external sloc source");
|
|
|
498 // Make sure we're not about to run out of source locations.
|
|
|
499 if (CurrentLoadedOffset - TotalSize < NextLocalOffset)
|
|
|
500 return std::make_pair(0, 0);
|
|
|
501 LoadedSLocEntryTable.resize(LoadedSLocEntryTable.size() + NumSLocEntries);
|
|
|
502 SLocEntryLoaded.resize(LoadedSLocEntryTable.size());
|
|
|
503 CurrentLoadedOffset -= TotalSize;
|
|
|
504 int ID = LoadedSLocEntryTable.size();
|
|
|
505 return std::make_pair(-ID - 1, CurrentLoadedOffset);
|
|
|
506 }
|
|
|
507
|
|
|
508 /// As part of recovering from missing or changed content, produce a
|
|
|
509 /// fake, non-empty buffer.
|
|
|
510 llvm::MemoryBuffer *SourceManager::getFakeBufferForRecovery() const {
|
|
|
511 if (!FakeBufferForRecovery)
|
|
|
512 FakeBufferForRecovery =
|
|
|
513 llvm::MemoryBuffer::getMemBuffer("<<<INVALID BUFFER>>");
|
|
|
514
|
|
|
515 return FakeBufferForRecovery.get();
|
|
|
516 }
|
|
|
517
|
|
|
518 /// As part of recovering from missing or changed content, produce a
|
|
|
519 /// fake content cache.
|
|
|
520 const SrcMgr::ContentCache *
|
|
|
521 SourceManager::getFakeContentCacheForRecovery() const {
|
|
|
522 if (!FakeContentCacheForRecovery) {
|
|
|
523 FakeContentCacheForRecovery = std::make_unique<SrcMgr::ContentCache>();
|
|
|
524 FakeContentCacheForRecovery->replaceBuffer(getFakeBufferForRecovery(),
|
|
|
525 /*DoNotFree=*/true);
|
|
|
526 }
|
|
|
527 return FakeContentCacheForRecovery.get();
|
|
|
528 }
|
|
|
529
|
|
|
530 /// Returns the previous in-order FileID or an invalid FileID if there
|
|
|
531 /// is no previous one.
|
|
|
532 FileID SourceManager::getPreviousFileID(FileID FID) const {
|
|
|
533 if (FID.isInvalid())
|
|
|
534 return FileID();
|
|
|
535
|
|
|
536 int ID = FID.ID;
|
|
|
537 if (ID == -1)
|
|
|
538 return FileID();
|
|
|
539
|
|
|
540 if (ID > 0) {
|
|
|
541 if (ID-1 == 0)
|
|
|
542 return FileID();
|
|
|
543 } else if (unsigned(-(ID-1) - 2) >= LoadedSLocEntryTable.size()) {
|
|
|
544 return FileID();
|
|
|
545 }
|
|
|
546
|
|
|
547 return FileID::get(ID-1);
|
|
|
548 }
|
|
|
549
|
|
|
550 /// Returns the next in-order FileID or an invalid FileID if there is
|
|
|
551 /// no next one.
|
|
|
552 FileID SourceManager::getNextFileID(FileID FID) const {
|
|
|
553 if (FID.isInvalid())
|
|
|
554 return FileID();
|
|
|
555
|
|
|
556 int ID = FID.ID;
|
|
|
557 if (ID > 0) {
|
|
|
558 if (unsigned(ID+1) >= local_sloc_entry_size())
|
|
|
559 return FileID();
|
|
|
560 } else if (ID+1 >= -1) {
|
|
|
561 return FileID();
|
|
|
562 }
|
|
|
563
|
|
|
564 return FileID::get(ID+1);
|
|
|
565 }
|
|
|
566
|
|
|
567 //===----------------------------------------------------------------------===//
|
|
|
568 // Methods to create new FileID's and macro expansions.
|
|
|
569 //===----------------------------------------------------------------------===//
|
|
|
570
|
|
173
|
571 /// Create a new FileID that represents the specified file
|
|
|
572 /// being \#included from the specified IncludePosition.
|
|
|
573 ///
|
|
|
574 /// This translates NULL into standard input.
|
|
|
575 FileID SourceManager::createFileID(const FileEntry *SourceFile,
|
|
|
576 SourceLocation IncludePos,
|
|
|
577 SrcMgr::CharacteristicKind FileCharacter,
|
|
|
578 int LoadedID, unsigned LoadedOffset) {
|
|
|
579 assert(SourceFile && "Null source file!");
|
|
|
580 const SrcMgr::ContentCache *IR =
|
|
|
581 getOrCreateContentCache(SourceFile, isSystem(FileCharacter));
|
|
|
582 assert(IR && "getOrCreateContentCache() cannot return NULL");
|
|
|
583 return createFileID(IR, SourceFile->getName(), IncludePos, FileCharacter,
|
|
|
584 LoadedID, LoadedOffset);
|
|
|
585 }
|
|
|
586
|
|
|
587 FileID SourceManager::createFileID(FileEntryRef SourceFile,
|
|
|
588 SourceLocation IncludePos,
|
|
|
589 SrcMgr::CharacteristicKind FileCharacter,
|
|
|
590 int LoadedID, unsigned LoadedOffset) {
|
|
|
591 const SrcMgr::ContentCache *IR = getOrCreateContentCache(
|
|
|
592 &SourceFile.getFileEntry(), isSystem(FileCharacter));
|
|
|
593 assert(IR && "getOrCreateContentCache() cannot return NULL");
|
|
|
594 return createFileID(IR, SourceFile.getName(), IncludePos, FileCharacter,
|
|
|
595 LoadedID, LoadedOffset);
|
|
|
596 }
|
|
|
597
|
|
|
598 /// Create a new FileID that represents the specified memory buffer.
|
|
|
599 ///
|
|
|
600 /// This does no caching of the buffer and takes ownership of the
|
|
|
601 /// MemoryBuffer, so only pass a MemoryBuffer to this once.
|
|
|
602 FileID SourceManager::createFileID(std::unique_ptr<llvm::MemoryBuffer> Buffer,
|
|
|
603 SrcMgr::CharacteristicKind FileCharacter,
|
|
|
604 int LoadedID, unsigned LoadedOffset,
|
|
|
605 SourceLocation IncludeLoc) {
|
|
|
606 StringRef Name = Buffer->getBufferIdentifier();
|
|
|
607 return createFileID(
|
|
|
608 createMemBufferContentCache(Buffer.release(), /*DoNotFree*/ false),
|
|
|
609 Name, IncludeLoc, FileCharacter, LoadedID, LoadedOffset);
|
|
|
610 }
|
|
|
611
|
|
|
612 /// Create a new FileID that represents the specified memory buffer.
|
|
|
613 ///
|
|
|
614 /// This does not take ownership of the MemoryBuffer. The memory buffer must
|
|
|
615 /// outlive the SourceManager.
|
|
|
616 FileID SourceManager::createFileID(UnownedTag, const llvm::MemoryBuffer *Buffer,
|
|
|
617 SrcMgr::CharacteristicKind FileCharacter,
|
|
|
618 int LoadedID, unsigned LoadedOffset,
|
|
|
619 SourceLocation IncludeLoc) {
|
|
|
620 return createFileID(createMemBufferContentCache(Buffer, /*DoNotFree*/ true),
|
|
|
621 Buffer->getBufferIdentifier(), IncludeLoc,
|
|
|
622 FileCharacter, LoadedID, LoadedOffset);
|
|
|
623 }
|
|
|
624
|
|
|
625 /// Get the FileID for \p SourceFile if it exists. Otherwise, create a
|
|
|
626 /// new FileID for the \p SourceFile.
|
|
|
627 FileID
|
|
|
628 SourceManager::getOrCreateFileID(const FileEntry *SourceFile,
|
|
|
629 SrcMgr::CharacteristicKind FileCharacter) {
|
|
|
630 FileID ID = translateFile(SourceFile);
|
|
|
631 return ID.isValid() ? ID : createFileID(SourceFile, SourceLocation(),
|
|
|
632 FileCharacter);
|
|
|
633 }
|
|
|
634
|
|
150
|
635 /// createFileID - Create a new FileID for the specified ContentCache and
|
|
|
636 /// include position. This works regardless of whether the ContentCache
|
|
|
637 /// corresponds to a file or some other input source.
|
|
|
638 FileID SourceManager::createFileID(const ContentCache *File, StringRef Filename,
|
|
|
639 SourceLocation IncludePos,
|
|
|
640 SrcMgr::CharacteristicKind FileCharacter,
|
|
|
641 int LoadedID, unsigned LoadedOffset) {
|
|
|
642 if (LoadedID < 0) {
|
|
|
643 assert(LoadedID != -1 && "Loading sentinel FileID");
|
|
|
644 unsigned Index = unsigned(-LoadedID) - 2;
|
|
|
645 assert(Index < LoadedSLocEntryTable.size() && "FileID out of range");
|
|
|
646 assert(!SLocEntryLoaded[Index] && "FileID already loaded");
|
|
|
647 LoadedSLocEntryTable[Index] = SLocEntry::get(
|
|
|
648 LoadedOffset, FileInfo::get(IncludePos, File, FileCharacter, Filename));
|
|
|
649 SLocEntryLoaded[Index] = true;
|
|
|
650 return FileID::get(LoadedID);
|
|
|
651 }
|
|
|
652 unsigned FileSize = File->getSize();
|
|
|
653 if (!(NextLocalOffset + FileSize + 1 > NextLocalOffset &&
|
|
|
654 NextLocalOffset + FileSize + 1 <= CurrentLoadedOffset)) {
|
|
|
655 Diag.Report(IncludePos, diag::err_include_too_large);
|
|
|
656 return FileID();
|
|
|
657 }
|
|
|
658 LocalSLocEntryTable.push_back(
|
|
|
659 SLocEntry::get(NextLocalOffset,
|
|
|
660 FileInfo::get(IncludePos, File, FileCharacter, Filename)));
|
|
|
661 // We do a +1 here because we want a SourceLocation that means "the end of the
|
|
|
662 // file", e.g. for the "no newline at the end of the file" diagnostic.
|
|
|
663 NextLocalOffset += FileSize + 1;
|
|
|
664
|
|
|
665 // Set LastFileIDLookup to the newly created file. The next getFileID call is
|
|
|
666 // almost guaranteed to be from that file.
|
|
|
667 FileID FID = FileID::get(LocalSLocEntryTable.size()-1);
|
|
|
668 return LastFileIDLookup = FID;
|
|
|
669 }
|
|
|
670
|
|
|
671 SourceLocation
|
|
|
672 SourceManager::createMacroArgExpansionLoc(SourceLocation SpellingLoc,
|
|
|
673 SourceLocation ExpansionLoc,
|
|
|
674 unsigned TokLength) {
|
|
|
675 ExpansionInfo Info = ExpansionInfo::createForMacroArg(SpellingLoc,
|
|
|
676 ExpansionLoc);
|
|
|
677 return createExpansionLocImpl(Info, TokLength);
|
|
|
678 }
|
|
|
679
|
|
|
680 SourceLocation
|
|
|
681 SourceManager::createExpansionLoc(SourceLocation SpellingLoc,
|
|
|
682 SourceLocation ExpansionLocStart,
|
|
|
683 SourceLocation ExpansionLocEnd,
|
|
|
684 unsigned TokLength,
|
|
|
685 bool ExpansionIsTokenRange,
|
|
|
686 int LoadedID,
|
|
|
687 unsigned LoadedOffset) {
|
|
|
688 ExpansionInfo Info = ExpansionInfo::create(
|
|
|
689 SpellingLoc, ExpansionLocStart, ExpansionLocEnd, ExpansionIsTokenRange);
|
|
|
690 return createExpansionLocImpl(Info, TokLength, LoadedID, LoadedOffset);
|
|
|
691 }
|
|
|
692
|
|
|
693 SourceLocation SourceManager::createTokenSplitLoc(SourceLocation Spelling,
|
|
|
694 SourceLocation TokenStart,
|
|
|
695 SourceLocation TokenEnd) {
|
|
|
696 assert(getFileID(TokenStart) == getFileID(TokenEnd) &&
|
|
|
697 "token spans multiple files");
|
|
|
698 return createExpansionLocImpl(
|
|
|
699 ExpansionInfo::createForTokenSplit(Spelling, TokenStart, TokenEnd),
|
|
|
700 TokenEnd.getOffset() - TokenStart.getOffset());
|
|
|
701 }
|
|
|
702
|
|
|
703 SourceLocation
|
|
|
704 SourceManager::createExpansionLocImpl(const ExpansionInfo &Info,
|
|
|
705 unsigned TokLength,
|
|
|
706 int LoadedID,
|
|
|
707 unsigned LoadedOffset) {
|
|
|
708 if (LoadedID < 0) {
|
|
|
709 assert(LoadedID != -1 && "Loading sentinel FileID");
|
|
|
710 unsigned Index = unsigned(-LoadedID) - 2;
|
|
|
711 assert(Index < LoadedSLocEntryTable.size() && "FileID out of range");
|
|
|
712 assert(!SLocEntryLoaded[Index] && "FileID already loaded");
|
|
|
713 LoadedSLocEntryTable[Index] = SLocEntry::get(LoadedOffset, Info);
|
|
|
714 SLocEntryLoaded[Index] = true;
|
|
|
715 return SourceLocation::getMacroLoc(LoadedOffset);
|
|
|
716 }
|
|
|
717 LocalSLocEntryTable.push_back(SLocEntry::get(NextLocalOffset, Info));
|
|
|
718 assert(NextLocalOffset + TokLength + 1 > NextLocalOffset &&
|
|
|
719 NextLocalOffset + TokLength + 1 <= CurrentLoadedOffset &&
|
|
|
720 "Ran out of source locations!");
|
|
|
721 // See createFileID for that +1.
|
|
|
722 NextLocalOffset += TokLength + 1;
|
|
|
723 return SourceLocation::getMacroLoc(NextLocalOffset - (TokLength + 1));
|
|
|
724 }
|
|
|
725
|
|
|
726 const llvm::MemoryBuffer *
|
|
|
727 SourceManager::getMemoryBufferForFile(const FileEntry *File, bool *Invalid) {
|
|
|
728 const SrcMgr::ContentCache *IR = getOrCreateContentCache(File);
|
|
|
729 assert(IR && "getOrCreateContentCache() cannot return NULL");
|
|
|
730 return IR->getBuffer(Diag, getFileManager(), SourceLocation(), Invalid);
|
|
|
731 }
|
|
|
732
|
|
|
733 void SourceManager::overrideFileContents(const FileEntry *SourceFile,
|
|
|
734 llvm::MemoryBuffer *Buffer,
|
|
|
735 bool DoNotFree) {
|
|
|
736 const SrcMgr::ContentCache *IR = getOrCreateContentCache(SourceFile);
|
|
|
737 assert(IR && "getOrCreateContentCache() cannot return NULL");
|
|
|
738
|
|
|
739 const_cast<SrcMgr::ContentCache *>(IR)->replaceBuffer(Buffer, DoNotFree);
|
|
|
740 const_cast<SrcMgr::ContentCache *>(IR)->BufferOverridden = true;
|
|
|
741
|
|
|
742 getOverriddenFilesInfo().OverriddenFilesWithBuffer.insert(SourceFile);
|
|
|
743 }
|
|
|
744
|
|
|
745 void SourceManager::overrideFileContents(const FileEntry *SourceFile,
|
|
|
746 const FileEntry *NewFile) {
|
|
|
747 assert(SourceFile->getSize() == NewFile->getSize() &&
|
|
|
748 "Different sizes, use the FileManager to create a virtual file with "
|
|
|
749 "the correct size");
|
|
|
750 assert(FileInfos.count(SourceFile) == 0 &&
|
|
|
751 "This function should be called at the initialization stage, before "
|
|
|
752 "any parsing occurs.");
|
|
|
753 getOverriddenFilesInfo().OverriddenFiles[SourceFile] = NewFile;
|
|
|
754 }
|
|
|
755
|
|
|
756 const FileEntry *
|
|
|
757 SourceManager::bypassFileContentsOverride(const FileEntry &File) {
|
|
|
758 assert(isFileOverridden(&File));
|
|
|
759 llvm::Optional<FileEntryRef> BypassFile =
|
|
|
760 FileMgr.getBypassFile(FileEntryRef(File.getName(), File));
|
|
|
761
|
|
|
762 // If the file can't be found in the FS, give up.
|
|
|
763 if (!BypassFile)
|
|
|
764 return nullptr;
|
|
|
765
|
|
|
766 const FileEntry *FE = &BypassFile->getFileEntry();
|
|
|
767 (void)getOrCreateContentCache(FE);
|
|
|
768 return FE;
|
|
|
769 }
|
|
|
770
|
|
|
771 void SourceManager::setFileIsTransient(const FileEntry *File) {
|
|
|
772 const SrcMgr::ContentCache *CC = getOrCreateContentCache(File);
|
|
|
773 const_cast<SrcMgr::ContentCache *>(CC)->IsTransient = true;
|
|
|
774 }
|
|
|
775
|
|
173
|
776 Optional<FileEntryRef> SourceManager::getFileEntryRefForID(FileID FID) const {
|
|
|
777 bool Invalid = false;
|
|
|
778 const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid);
|
|
|
779 if (Invalid || !Entry.isFile())
|
|
|
780 return None;
|
|
|
781
|
|
|
782 const SrcMgr::ContentCache *Content = Entry.getFile().getContentCache();
|
|
|
783 if (!Content || !Content->OrigEntry)
|
|
|
784 return None;
|
|
|
785 return FileEntryRef(Entry.getFile().getName(), *Content->OrigEntry);
|
|
|
786 }
|
|
|
787
|
|
150
|
788 StringRef SourceManager::getBufferData(FileID FID, bool *Invalid) const {
|
|
|
789 bool MyInvalid = false;
|
|
|
790 const SLocEntry &SLoc = getSLocEntry(FID, &MyInvalid);
|
|
|
791 if (!SLoc.isFile() || MyInvalid) {
|
|
|
792 if (Invalid)
|
|
|
793 *Invalid = true;
|
|
|
794 return "<<<<<INVALID SOURCE LOCATION>>>>>";
|
|
|
795 }
|
|
|
796
|
|
|
797 const llvm::MemoryBuffer *Buf = SLoc.getFile().getContentCache()->getBuffer(
|
|
|
798 Diag, getFileManager(), SourceLocation(), &MyInvalid);
|
|
|
799 if (Invalid)
|
|
|
800 *Invalid = MyInvalid;
|
|
|
801
|
|
|
802 if (MyInvalid)
|
|
|
803 return "<<<<<INVALID SOURCE LOCATION>>>>>";
|
|
|
804
|
|
|
805 return Buf->getBuffer();
|
|
|
806 }
|
|
|
807
|
|
|
808 //===----------------------------------------------------------------------===//
|
|
|
809 // SourceLocation manipulation methods.
|
|
|
810 //===----------------------------------------------------------------------===//
|
|
|
811
|
|
|
812 /// Return the FileID for a SourceLocation.
|
|
|
813 ///
|
|
|
814 /// This is the cache-miss path of getFileID. Not as hot as that function, but
|
|
|
815 /// still very important. It is responsible for finding the entry in the
|
|
|
816 /// SLocEntry tables that contains the specified location.
|
|
|
817 FileID SourceManager::getFileIDSlow(unsigned SLocOffset) const {
|
|
|
818 if (!SLocOffset)
|
|
|
819 return FileID::get(0);
|
|
|
820
|
|
|
821 // Now it is time to search for the correct file. See where the SLocOffset
|
|
|
822 // sits in the global view and consult local or loaded buffers for it.
|
|
|
823 if (SLocOffset < NextLocalOffset)
|
|
|
824 return getFileIDLocal(SLocOffset);
|
|
|
825 return getFileIDLoaded(SLocOffset);
|
|
|
826 }
|
|
|
827
|
|
|
828 /// Return the FileID for a SourceLocation with a low offset.
|
|
|
829 ///
|
|
|
830 /// This function knows that the SourceLocation is in a local buffer, not a
|
|
|
831 /// loaded one.
|
|
|
832 FileID SourceManager::getFileIDLocal(unsigned SLocOffset) const {
|
|
|
833 assert(SLocOffset < NextLocalOffset && "Bad function choice");
|
|
|
834
|
|
|
835 // After the first and second level caches, I see two common sorts of
|
|
|
836 // behavior: 1) a lot of searched FileID's are "near" the cached file
|
|
|
837 // location or are "near" the cached expansion location. 2) others are just
|
|
|
838 // completely random and may be a very long way away.
|
|
|
839 //
|
|
|
840 // To handle this, we do a linear search for up to 8 steps to catch #1 quickly
|
|
|
841 // then we fall back to a less cache efficient, but more scalable, binary
|
|
|
842 // search to find the location.
|
|
|
843
|
|
|
844 // See if this is near the file point - worst case we start scanning from the
|
|
|
845 // most newly created FileID.
|
|
|
846 const SrcMgr::SLocEntry *I;
|
|
|
847
|
|
|
848 if (LastFileIDLookup.ID < 0 ||
|
|
|
849 LocalSLocEntryTable[LastFileIDLookup.ID].getOffset() < SLocOffset) {
|
|
|
850 // Neither loc prunes our search.
|
|
|
851 I = LocalSLocEntryTable.end();
|
|
|
852 } else {
|
|
|
853 // Perhaps it is near the file point.
|
|
|
854 I = LocalSLocEntryTable.begin()+LastFileIDLookup.ID;
|
|
|
855 }
|
|
|
856
|
|
|
857 // Find the FileID that contains this. "I" is an iterator that points to a
|
|
|
858 // FileID whose offset is known to be larger than SLocOffset.
|
|
|
859 unsigned NumProbes = 0;
|
|
|
860 while (true) {
|
|
|
861 --I;
|
|
|
862 if (I->getOffset() <= SLocOffset) {
|
|
|
863 FileID Res = FileID::get(int(I - LocalSLocEntryTable.begin()));
|
|
|
864
|
|
|
865 // If this isn't an expansion, remember it. We have good locality across
|
|
|
866 // FileID lookups.
|
|
|
867 if (!I->isExpansion())
|
|
|
868 LastFileIDLookup = Res;
|
|
|
869 NumLinearScans += NumProbes+1;
|
|
|
870 return Res;
|
|
|
871 }
|
|
|
872 if (++NumProbes == 8)
|
|
|
873 break;
|
|
|
874 }
|
|
|
875
|
|
|
876 // Convert "I" back into an index. We know that it is an entry whose index is
|
|
|
877 // larger than the offset we are looking for.
|
|
|
878 unsigned GreaterIndex = I - LocalSLocEntryTable.begin();
|
|
|
879 // LessIndex - This is the lower bound of the range that we're searching.
|
|
|
880 // We know that the offset corresponding to the FileID is is less than
|
|
|
881 // SLocOffset.
|
|
|
882 unsigned LessIndex = 0;
|
|
|
883 NumProbes = 0;
|
|
|
884 while (true) {
|
|
|
885 bool Invalid = false;
|
|
|
886 unsigned MiddleIndex = (GreaterIndex-LessIndex)/2+LessIndex;
|
|
|
887 unsigned MidOffset = getLocalSLocEntry(MiddleIndex, &Invalid).getOffset();
|
|
|
888 if (Invalid)
|
|
|
889 return FileID::get(0);
|
|
|
890
|
|
|
891 ++NumProbes;
|
|
|
892
|
|
|
893 // If the offset of the midpoint is too large, chop the high side of the
|
|
|
894 // range to the midpoint.
|
|
|
895 if (MidOffset > SLocOffset) {
|
|
|
896 GreaterIndex = MiddleIndex;
|
|
|
897 continue;
|
|
|
898 }
|
|
|
899
|
|
|
900 // If the middle index contains the value, succeed and return.
|
|
|
901 // FIXME: This could be made faster by using a function that's aware of
|
|
|
902 // being in the local area.
|
|
|
903 if (isOffsetInFileID(FileID::get(MiddleIndex), SLocOffset)) {
|
|
|
904 FileID Res = FileID::get(MiddleIndex);
|
|
|
905
|
|
|
906 // If this isn't a macro expansion, remember it. We have good locality
|
|
|
907 // across FileID lookups.
|
|
|
908 if (!LocalSLocEntryTable[MiddleIndex].isExpansion())
|
|
|
909 LastFileIDLookup = Res;
|
|
|
910 NumBinaryProbes += NumProbes;
|
|
|
911 return Res;
|
|
|
912 }
|
|
|
913
|
|
|
914 // Otherwise, move the low-side up to the middle index.
|
|
|
915 LessIndex = MiddleIndex;
|
|
|
916 }
|
|
|
917 }
|
|
|
918
|
|
|
919 /// Return the FileID for a SourceLocation with a high offset.
|
|
|
920 ///
|
|
|
921 /// This function knows that the SourceLocation is in a loaded buffer, not a
|
|
|
922 /// local one.
|
|
|
923 FileID SourceManager::getFileIDLoaded(unsigned SLocOffset) const {
|
|
|
924 // Sanity checking, otherwise a bug may lead to hanging in release build.
|
|
|
925 if (SLocOffset < CurrentLoadedOffset) {
|
|
|
926 assert(0 && "Invalid SLocOffset or bad function choice");
|
|
|
927 return FileID();
|
|
|
928 }
|
|
|
929
|
|
|
930 // Essentially the same as the local case, but the loaded array is sorted
|
|
|
931 // in the other direction.
|
|
|
932
|
|
|
933 // First do a linear scan from the last lookup position, if possible.
|
|
|
934 unsigned I;
|
|
|
935 int LastID = LastFileIDLookup.ID;
|
|
|
936 if (LastID >= 0 || getLoadedSLocEntryByID(LastID).getOffset() < SLocOffset)
|
|
|
937 I = 0;
|
|
|
938 else
|
|
|
939 I = (-LastID - 2) + 1;
|
|
|
940
|
|
|
941 unsigned NumProbes;
|
|
|
942 for (NumProbes = 0; NumProbes < 8; ++NumProbes, ++I) {
|
|
|
943 // Make sure the entry is loaded!
|
|
|
944 const SrcMgr::SLocEntry &E = getLoadedSLocEntry(I);
|
|
|
945 if (E.getOffset() <= SLocOffset) {
|
|
|
946 FileID Res = FileID::get(-int(I) - 2);
|
|
|
947
|
|
|
948 if (!E.isExpansion())
|
|
|
949 LastFileIDLookup = Res;
|
|
|
950 NumLinearScans += NumProbes + 1;
|
|
|
951 return Res;
|
|
|
952 }
|
|
|
953 }
|
|
|
954
|
|
|
955 // Linear scan failed. Do the binary search. Note the reverse sorting of the
|
|
|
956 // table: GreaterIndex is the one where the offset is greater, which is
|
|
|
957 // actually a lower index!
|
|
|
958 unsigned GreaterIndex = I;
|
|
|
959 unsigned LessIndex = LoadedSLocEntryTable.size();
|
|
|
960 NumProbes = 0;
|
|
|
961 while (true) {
|
|
|
962 ++NumProbes;
|
|
|
963 unsigned MiddleIndex = (LessIndex - GreaterIndex) / 2 + GreaterIndex;
|
|
|
964 const SrcMgr::SLocEntry &E = getLoadedSLocEntry(MiddleIndex);
|
|
|
965 if (E.getOffset() == 0)
|
|
|
966 return FileID(); // invalid entry.
|
|
|
967
|
|
|
968 ++NumProbes;
|
|
|
969
|
|
|
970 if (E.getOffset() > SLocOffset) {
|
|
|
971 // Sanity checking, otherwise a bug may lead to hanging in release build.
|
|
|
972 if (GreaterIndex == MiddleIndex) {
|
|
|
973 assert(0 && "binary search missed the entry");
|
|
|
974 return FileID();
|
|
|
975 }
|
|
|
976 GreaterIndex = MiddleIndex;
|
|
|
977 continue;
|
|
|
978 }
|
|
|
979
|
|
|
980 if (isOffsetInFileID(FileID::get(-int(MiddleIndex) - 2), SLocOffset)) {
|
|
|
981 FileID Res = FileID::get(-int(MiddleIndex) - 2);
|
|
|
982 if (!E.isExpansion())
|
|
|
983 LastFileIDLookup = Res;
|
|
|
984 NumBinaryProbes += NumProbes;
|
|
|
985 return Res;
|
|
|
986 }
|
|
|
987
|
|
|
988 // Sanity checking, otherwise a bug may lead to hanging in release build.
|
|
|
989 if (LessIndex == MiddleIndex) {
|
|
|
990 assert(0 && "binary search missed the entry");
|
|
|
991 return FileID();
|
|
|
992 }
|
|
|
993 LessIndex = MiddleIndex;
|
|
|
994 }
|
|
|
995 }
|
|
|
996
|
|
|
997 SourceLocation SourceManager::
|
|
|
998 getExpansionLocSlowCase(SourceLocation Loc) const {
|
|
|
999 do {
|
|
|
1000 // Note: If Loc indicates an offset into a token that came from a macro
|
|
|
1001 // expansion (e.g. the 5th character of the token) we do not want to add
|
|
|
1002 // this offset when going to the expansion location. The expansion
|
|
|
1003 // location is the macro invocation, which the offset has nothing to do
|
|
|
1004 // with. This is unlike when we get the spelling loc, because the offset
|
|
|
1005 // directly correspond to the token whose spelling we're inspecting.
|
|
|
1006 Loc = getSLocEntry(getFileID(Loc)).getExpansion().getExpansionLocStart();
|
|
|
1007 } while (!Loc.isFileID());
|
|
|
1008
|
|
|
1009 return Loc;
|
|
|
1010 }
|
|
|
1011
|
|
|
1012 SourceLocation SourceManager::getSpellingLocSlowCase(SourceLocation Loc) const {
|
|
|
1013 do {
|
|
|
1014 std::pair<FileID, unsigned> LocInfo = getDecomposedLoc(Loc);
|
|
|
1015 Loc = getSLocEntry(LocInfo.first).getExpansion().getSpellingLoc();
|
|
|
1016 Loc = Loc.getLocWithOffset(LocInfo.second);
|
|
|
1017 } while (!Loc.isFileID());
|
|
|
1018 return Loc;
|
|
|
1019 }
|
|
|
1020
|
|
|
1021 SourceLocation SourceManager::getFileLocSlowCase(SourceLocation Loc) const {
|
|
|
1022 do {
|
|
|
1023 if (isMacroArgExpansion(Loc))
|
|
|
1024 Loc = getImmediateSpellingLoc(Loc);
|
|
|
1025 else
|
|
|
1026 Loc = getImmediateExpansionRange(Loc).getBegin();
|
|
|
1027 } while (!Loc.isFileID());
|
|
|
1028 return Loc;
|
|
|
1029 }
|
|
|
1030
|
|
|
1031
|
|
|
1032 std::pair<FileID, unsigned>
|
|
|
1033 SourceManager::getDecomposedExpansionLocSlowCase(
|
|
|
1034 const SrcMgr::SLocEntry *E) const {
|
|
|
1035 // If this is an expansion record, walk through all the expansion points.
|
|
|
1036 FileID FID;
|
|
|
1037 SourceLocation Loc;
|
|
|
1038 unsigned Offset;
|
|
|
1039 do {
|
|
|
1040 Loc = E->getExpansion().getExpansionLocStart();
|
|
|
1041
|
|
|
1042 FID = getFileID(Loc);
|
|
|
1043 E = &getSLocEntry(FID);
|
|
|
1044 Offset = Loc.getOffset()-E->getOffset();
|
|
|
1045 } while (!Loc.isFileID());
|
|
|
1046
|
|
|
1047 return std::make_pair(FID, Offset);
|
|
|
1048 }
|
|
|
1049
|
|
|
1050 std::pair<FileID, unsigned>
|
|
|
1051 SourceManager::getDecomposedSpellingLocSlowCase(const SrcMgr::SLocEntry *E,
|
|
|
1052 unsigned Offset) const {
|
|
|
1053 // If this is an expansion record, walk through all the expansion points.
|
|
|
1054 FileID FID;
|
|
|
1055 SourceLocation Loc;
|
|
|
1056 do {
|
|
|
1057 Loc = E->getExpansion().getSpellingLoc();
|
|
|
1058 Loc = Loc.getLocWithOffset(Offset);
|
|
|
1059
|
|
|
1060 FID = getFileID(Loc);
|
|
|
1061 E = &getSLocEntry(FID);
|
|
|
1062 Offset = Loc.getOffset()-E->getOffset();
|
|
|
1063 } while (!Loc.isFileID());
|
|
|
1064
|
|
|
1065 return std::make_pair(FID, Offset);
|
|
|
1066 }
|
|
|
1067
|
|
|
1068 /// getImmediateSpellingLoc - Given a SourceLocation object, return the
|
|
|
1069 /// spelling location referenced by the ID. This is the first level down
|
|
|
1070 /// towards the place where the characters that make up the lexed token can be
|
|
|
1071 /// found. This should not generally be used by clients.
|
|
|
1072 SourceLocation SourceManager::getImmediateSpellingLoc(SourceLocation Loc) const{
|
|
|
1073 if (Loc.isFileID()) return Loc;
|
|
|
1074 std::pair<FileID, unsigned> LocInfo = getDecomposedLoc(Loc);
|
|
|
1075 Loc = getSLocEntry(LocInfo.first).getExpansion().getSpellingLoc();
|
|
|
1076 return Loc.getLocWithOffset(LocInfo.second);
|
|
|
1077 }
|
|
|
1078
|
|
173
|
1079 /// Return the filename of the file containing a SourceLocation.
|
|
|
1080 StringRef SourceManager::getFilename(SourceLocation SpellingLoc) const {
|
|
|
1081 if (const FileEntry *F = getFileEntryForID(getFileID(SpellingLoc)))
|
|
|
1082 return F->getName();
|
|
|
1083 return StringRef();
|
|
|
1084 }
|
|
|
1085
|
|
150
|
1086 /// getImmediateExpansionRange - Loc is required to be an expansion location.
|
|
|
1087 /// Return the start/end of the expansion information.
|
|
|
1088 CharSourceRange
|
|
|
1089 SourceManager::getImmediateExpansionRange(SourceLocation Loc) const {
|
|
|
1090 assert(Loc.isMacroID() && "Not a macro expansion loc!");
|
|
|
1091 const ExpansionInfo &Expansion = getSLocEntry(getFileID(Loc)).getExpansion();
|
|
|
1092 return Expansion.getExpansionLocRange();
|
|
|
1093 }
|
|
|
1094
|
|
|
1095 SourceLocation SourceManager::getTopMacroCallerLoc(SourceLocation Loc) const {
|
|
|
1096 while (isMacroArgExpansion(Loc))
|
|
|
1097 Loc = getImmediateSpellingLoc(Loc);
|
|
|
1098 return Loc;
|
|
|
1099 }
|
|
|
1100
|
|
|
1101 /// getExpansionRange - Given a SourceLocation object, return the range of
|
|
|
1102 /// tokens covered by the expansion in the ultimate file.
|
|
|
1103 CharSourceRange SourceManager::getExpansionRange(SourceLocation Loc) const {
|
|
|
1104 if (Loc.isFileID())
|
|
|
1105 return CharSourceRange(SourceRange(Loc, Loc), true);
|
|
|
1106
|
|
|
1107 CharSourceRange Res = getImmediateExpansionRange(Loc);
|
|
|
1108
|
|
|
1109 // Fully resolve the start and end locations to their ultimate expansion
|
|
|
1110 // points.
|
|
|
1111 while (!Res.getBegin().isFileID())
|
|
|
1112 Res.setBegin(getImmediateExpansionRange(Res.getBegin()).getBegin());
|
|
|
1113 while (!Res.getEnd().isFileID()) {
|
|
|
1114 CharSourceRange EndRange = getImmediateExpansionRange(Res.getEnd());
|
|
|
1115 Res.setEnd(EndRange.getEnd());
|
|
|
1116 Res.setTokenRange(EndRange.isTokenRange());
|
|
|
1117 }
|
|
|
1118 return Res;
|
|
|
1119 }
|
|
|
1120
|
|
|
1121 bool SourceManager::isMacroArgExpansion(SourceLocation Loc,
|
|
|
1122 SourceLocation *StartLoc) const {
|
|
|
1123 if (!Loc.isMacroID()) return false;
|
|
|
1124
|
|
|
1125 FileID FID = getFileID(Loc);
|
|
|
1126 const SrcMgr::ExpansionInfo &Expansion = getSLocEntry(FID).getExpansion();
|
|
|
1127 if (!Expansion.isMacroArgExpansion()) return false;
|
|
|
1128
|
|
|
1129 if (StartLoc)
|
|
|
1130 *StartLoc = Expansion.getExpansionLocStart();
|
|
|
1131 return true;
|
|
|
1132 }
|
|
|
1133
|
|
|
1134 bool SourceManager::isMacroBodyExpansion(SourceLocation Loc) const {
|
|
|
1135 if (!Loc.isMacroID()) return false;
|
|
|
1136
|
|
|
1137 FileID FID = getFileID(Loc);
|
|
|
1138 const SrcMgr::ExpansionInfo &Expansion = getSLocEntry(FID).getExpansion();
|
|
|
1139 return Expansion.isMacroBodyExpansion();
|
|
|
1140 }
|
|
|
1141
|
|
|
1142 bool SourceManager::isAtStartOfImmediateMacroExpansion(SourceLocation Loc,
|
|
|
1143 SourceLocation *MacroBegin) const {
|
|
|
1144 assert(Loc.isValid() && Loc.isMacroID() && "Expected a valid macro loc");
|
|
|
1145
|
|
|
1146 std::pair<FileID, unsigned> DecompLoc = getDecomposedLoc(Loc);
|
|
|
1147 if (DecompLoc.second > 0)
|
|
|
1148 return false; // Does not point at the start of expansion range.
|
|
|
1149
|
|
|
1150 bool Invalid = false;
|
|
|
1151 const SrcMgr::ExpansionInfo &ExpInfo =
|
|
|
1152 getSLocEntry(DecompLoc.first, &Invalid).getExpansion();
|
|
|
1153 if (Invalid)
|
|
|
1154 return false;
|
|
|
1155 SourceLocation ExpLoc = ExpInfo.getExpansionLocStart();
|
|
|
1156
|
|
|
1157 if (ExpInfo.isMacroArgExpansion()) {
|
|
|
1158 // For macro argument expansions, check if the previous FileID is part of
|
|
|
1159 // the same argument expansion, in which case this Loc is not at the
|
|
|
1160 // beginning of the expansion.
|
|
|
1161 FileID PrevFID = getPreviousFileID(DecompLoc.first);
|
|
|
1162 if (!PrevFID.isInvalid()) {
|
|
|
1163 const SrcMgr::SLocEntry &PrevEntry = getSLocEntry(PrevFID, &Invalid);
|
|
|
1164 if (Invalid)
|
|
|
1165 return false;
|
|
|
1166 if (PrevEntry.isExpansion() &&
|
|
|
1167 PrevEntry.getExpansion().getExpansionLocStart() == ExpLoc)
|
|
|
1168 return false;
|
|
|
1169 }
|
|
|
1170 }
|
|
|
1171
|
|
|
1172 if (MacroBegin)
|
|
|
1173 *MacroBegin = ExpLoc;
|
|
|
1174 return true;
|
|
|
1175 }
|
|
|
1176
|
|
|
1177 bool SourceManager::isAtEndOfImmediateMacroExpansion(SourceLocation Loc,
|
|
|
1178 SourceLocation *MacroEnd) const {
|
|
|
1179 assert(Loc.isValid() && Loc.isMacroID() && "Expected a valid macro loc");
|
|
|
1180
|
|
|
1181 FileID FID = getFileID(Loc);
|
|
|
1182 SourceLocation NextLoc = Loc.getLocWithOffset(1);
|
|
|
1183 if (isInFileID(NextLoc, FID))
|
|
|
1184 return false; // Does not point at the end of expansion range.
|
|
|
1185
|
|
|
1186 bool Invalid = false;
|
|
|
1187 const SrcMgr::ExpansionInfo &ExpInfo =
|
|
|
1188 getSLocEntry(FID, &Invalid).getExpansion();
|
|
|
1189 if (Invalid)
|
|
|
1190 return false;
|
|
|
1191
|
|
|
1192 if (ExpInfo.isMacroArgExpansion()) {
|
|
|
1193 // For macro argument expansions, check if the next FileID is part of the
|
|
|
1194 // same argument expansion, in which case this Loc is not at the end of the
|
|
|
1195 // expansion.
|
|
|
1196 FileID NextFID = getNextFileID(FID);
|
|
|
1197 if (!NextFID.isInvalid()) {
|
|
|
1198 const SrcMgr::SLocEntry &NextEntry = getSLocEntry(NextFID, &Invalid);
|
|
|
1199 if (Invalid)
|
|
|
1200 return false;
|
|
|
1201 if (NextEntry.isExpansion() &&
|
|
|
1202 NextEntry.getExpansion().getExpansionLocStart() ==
|
|
|
1203 ExpInfo.getExpansionLocStart())
|
|
|
1204 return false;
|
|
|
1205 }
|
|
|
1206 }
|
|
|
1207
|
|
|
1208 if (MacroEnd)
|
|
|
1209 *MacroEnd = ExpInfo.getExpansionLocEnd();
|
|
|
1210 return true;
|
|
|
1211 }
|
|
|
1212
|
|
|
1213 //===----------------------------------------------------------------------===//
|
|
|
1214 // Queries about the code at a SourceLocation.
|
|
|
1215 //===----------------------------------------------------------------------===//
|
|
|
1216
|
|
|
1217 /// getCharacterData - Return a pointer to the start of the specified location
|
|
|
1218 /// in the appropriate MemoryBuffer.
|
|
|
1219 const char *SourceManager::getCharacterData(SourceLocation SL,
|
|
|
1220 bool *Invalid) const {
|
|
|
1221 // Note that this is a hot function in the getSpelling() path, which is
|
|
|
1222 // heavily used by -E mode.
|
|
|
1223 std::pair<FileID, unsigned> LocInfo = getDecomposedSpellingLoc(SL);
|
|
|
1224
|
|
|
1225 // Note that calling 'getBuffer()' may lazily page in a source file.
|
|
|
1226 bool CharDataInvalid = false;
|
|
|
1227 const SLocEntry &Entry = getSLocEntry(LocInfo.first, &CharDataInvalid);
|
|
|
1228 if (CharDataInvalid || !Entry.isFile()) {
|
|
|
1229 if (Invalid)
|
|
|
1230 *Invalid = true;
|
|
|
1231
|
|
|
1232 return "<<<<INVALID BUFFER>>>>";
|
|
|
1233 }
|
|
|
1234 const llvm::MemoryBuffer *Buffer =
|
|
|
1235 Entry.getFile().getContentCache()->getBuffer(
|
|
|
1236 Diag, getFileManager(), SourceLocation(), &CharDataInvalid);
|
|
|
1237 if (Invalid)
|
|
|
1238 *Invalid = CharDataInvalid;
|
|
|
1239 return Buffer->getBufferStart() + (CharDataInvalid? 0 : LocInfo.second);
|
|
|
1240 }
|
|
|
1241
|
|
|
1242 /// getColumnNumber - Return the column # for the specified file position.
|
|
|
1243 /// this is significantly cheaper to compute than the line number.
|
|
|
1244 unsigned SourceManager::getColumnNumber(FileID FID, unsigned FilePos,
|
|
|
1245 bool *Invalid) const {
|
|
|
1246 bool MyInvalid = false;
|
|
|
1247 const llvm::MemoryBuffer *MemBuf = getBuffer(FID, &MyInvalid);
|
|
|
1248 if (Invalid)
|
|
|
1249 *Invalid = MyInvalid;
|
|
|
1250
|
|
|
1251 if (MyInvalid)
|
|
|
1252 return 1;
|
|
|
1253
|
|
|
1254 // It is okay to request a position just past the end of the buffer.
|
|
|
1255 if (FilePos > MemBuf->getBufferSize()) {
|
|
|
1256 if (Invalid)
|
|
|
1257 *Invalid = true;
|
|
|
1258 return 1;
|
|
|
1259 }
|
|
|
1260
|
|
|
1261 const char *Buf = MemBuf->getBufferStart();
|
|
|
1262 // See if we just calculated the line number for this FilePos and can use
|
|
|
1263 // that to lookup the start of the line instead of searching for it.
|
|
|
1264 if (LastLineNoFileIDQuery == FID &&
|
|
|
1265 LastLineNoContentCache->SourceLineCache != nullptr &&
|
|
|
1266 LastLineNoResult < LastLineNoContentCache->NumLines) {
|
|
|
1267 unsigned *SourceLineCache = LastLineNoContentCache->SourceLineCache;
|
|
|
1268 unsigned LineStart = SourceLineCache[LastLineNoResult - 1];
|
|
|
1269 unsigned LineEnd = SourceLineCache[LastLineNoResult];
|
|
|
1270 if (FilePos >= LineStart && FilePos < LineEnd) {
|
|
|
1271 // LineEnd is the LineStart of the next line.
|
|
|
1272 // A line ends with separator LF or CR+LF on Windows.
|
|
|
1273 // FilePos might point to the last separator,
|
|
|
1274 // but we need a column number at most 1 + the last column.
|
|
|
1275 if (FilePos + 1 == LineEnd && FilePos > LineStart) {
|
|
|
1276 if (Buf[FilePos - 1] == '\r' || Buf[FilePos - 1] == '\n')
|
|
|
1277 --FilePos;
|
|
|
1278 }
|
|
|
1279 return FilePos - LineStart + 1;
|
|
|
1280 }
|
|
|
1281 }
|
|
|
1282
|
|
|
1283 unsigned LineStart = FilePos;
|
|
|
1284 while (LineStart && Buf[LineStart-1] != '\n' && Buf[LineStart-1] != '\r')
|
|
|
1285 --LineStart;
|
|
|
1286 return FilePos-LineStart+1;
|
|
|
1287 }
|
|
|
1288
|
|
|
1289 // isInvalid - Return the result of calling loc.isInvalid(), and
|
|
|
1290 // if Invalid is not null, set its value to same.
|
|
|
1291 template<typename LocType>
|
|
|
1292 static bool isInvalid(LocType Loc, bool *Invalid) {
|
|
|
1293 bool MyInvalid = Loc.isInvalid();
|
|
|
1294 if (Invalid)
|
|
|
1295 *Invalid = MyInvalid;
|
|
|
1296 return MyInvalid;
|
|
|
1297 }
|
|
|
1298
|
|
|
1299 unsigned SourceManager::getSpellingColumnNumber(SourceLocation Loc,
|
|
|
1300 bool *Invalid) const {
|
|
|
1301 if (isInvalid(Loc, Invalid)) return 0;
|
|
|
1302 std::pair<FileID, unsigned> LocInfo = getDecomposedSpellingLoc(Loc);
|
|
|
1303 return getColumnNumber(LocInfo.first, LocInfo.second, Invalid);
|
|
|
1304 }
|
|
|
1305
|
|
|
1306 unsigned SourceManager::getExpansionColumnNumber(SourceLocation Loc,
|
|
|
1307 bool *Invalid) const {
|
|
|
1308 if (isInvalid(Loc, Invalid)) return 0;
|
|
|
1309 std::pair<FileID, unsigned> LocInfo = getDecomposedExpansionLoc(Loc);
|
|
|
1310 return getColumnNumber(LocInfo.first, LocInfo.second, Invalid);
|
|
|
1311 }
|
|
|
1312
|
|
|
1313 unsigned SourceManager::getPresumedColumnNumber(SourceLocation Loc,
|
|
|
1314 bool *Invalid) const {
|
|
|
1315 PresumedLoc PLoc = getPresumedLoc(Loc);
|
|
|
1316 if (isInvalid(PLoc, Invalid)) return 0;
|
|
|
1317 return PLoc.getColumn();
|
|
|
1318 }
|
|
|
1319
|
|
|
1320 #ifdef __SSE2__
|
|
|
1321 #include <emmintrin.h>
|
|
|
1322 #endif
|
|
|
1323
|
|
|
1324 static LLVM_ATTRIBUTE_NOINLINE void
|
|
|
1325 ComputeLineNumbers(DiagnosticsEngine &Diag, ContentCache *FI,
|
|
|
1326 llvm::BumpPtrAllocator &Alloc,
|
|
|
1327 const SourceManager &SM, bool &Invalid);
|
|
|
1328 static void ComputeLineNumbers(DiagnosticsEngine &Diag, ContentCache *FI,
|
|
|
1329 llvm::BumpPtrAllocator &Alloc,
|
|
|
1330 const SourceManager &SM, bool &Invalid) {
|
|
|
1331 // Note that calling 'getBuffer()' may lazily page in the file.
|
|
|
1332 const MemoryBuffer *Buffer =
|
|
|
1333 FI->getBuffer(Diag, SM.getFileManager(), SourceLocation(), &Invalid);
|
|
|
1334 if (Invalid)
|
|
|
1335 return;
|
|
|
1336
|
|
|
1337 // Find the file offsets of all of the *physical* source lines. This does
|
|
|
1338 // not look at trigraphs, escaped newlines, or anything else tricky.
|
|
|
1339 SmallVector<unsigned, 256> LineOffsets;
|
|
|
1340
|
|
|
1341 // Line #1 starts at char 0.
|
|
|
1342 LineOffsets.push_back(0);
|
|
|
1343
|
|
|
1344 const unsigned char *Buf = (const unsigned char *)Buffer->getBufferStart();
|
|
|
1345 const unsigned char *End = (const unsigned char *)Buffer->getBufferEnd();
|
|
|
1346 const std::size_t BufLen = End - Buf;
|
|
|
1347 unsigned I = 0;
|
|
|
1348 while (I < BufLen) {
|
|
|
1349 if (Buf[I] == '\n') {
|
|
|
1350 LineOffsets.push_back(I + 1);
|
|
|
1351 } else if (Buf[I] == '\r') {
|
|
|
1352 // If this is \r\n, skip both characters.
|
|
|
1353 if (I + 1 < BufLen && Buf[I + 1] == '\n')
|
|
|
1354 ++I;
|
|
|
1355 LineOffsets.push_back(I + 1);
|
|
|
1356 }
|
|
|
1357 ++I;
|
|
|
1358 }
|
|
|
1359
|
|
|
1360 // Copy the offsets into the FileInfo structure.
|
|
|
1361 FI->NumLines = LineOffsets.size();
|
|
|
1362 FI->SourceLineCache = Alloc.Allocate<unsigned>(LineOffsets.size());
|
|
|
1363 std::copy(LineOffsets.begin(), LineOffsets.end(), FI->SourceLineCache);
|
|
|
1364 }
|
|
|
1365
|
|
|
1366 /// getLineNumber - Given a SourceLocation, return the spelling line number
|
|
|
1367 /// for the position indicated. This requires building and caching a table of
|
|
|
1368 /// line offsets for the MemoryBuffer, so this is not cheap: use only when
|
|
|
1369 /// about to emit a diagnostic.
|
|
|
1370 unsigned SourceManager::getLineNumber(FileID FID, unsigned FilePos,
|
|
|
1371 bool *Invalid) const {
|
|
|
1372 if (FID.isInvalid()) {
|
|
|
1373 if (Invalid)
|
|
|
1374 *Invalid = true;
|
|
|
1375 return 1;
|
|
|
1376 }
|
|
|
1377
|
|
|
1378 ContentCache *Content;
|
|
|
1379 if (LastLineNoFileIDQuery == FID)
|
|
|
1380 Content = LastLineNoContentCache;
|
|
|
1381 else {
|
|
|
1382 bool MyInvalid = false;
|
|
|
1383 const SLocEntry &Entry = getSLocEntry(FID, &MyInvalid);
|
|
|
1384 if (MyInvalid || !Entry.isFile()) {
|
|
|
1385 if (Invalid)
|
|
|
1386 *Invalid = true;
|
|
|
1387 return 1;
|
|
|
1388 }
|
|
|
1389
|
|
|
1390 Content = const_cast<ContentCache*>(Entry.getFile().getContentCache());
|
|
|
1391 }
|
|
|
1392
|
|
|
1393 // If this is the first use of line information for this buffer, compute the
|
|
|
1394 /// SourceLineCache for it on demand.
|
|
|
1395 if (!Content->SourceLineCache) {
|
|
|
1396 bool MyInvalid = false;
|
|
|
1397 ComputeLineNumbers(Diag, Content, ContentCacheAlloc, *this, MyInvalid);
|
|
|
1398 if (Invalid)
|
|
|
1399 *Invalid = MyInvalid;
|
|
|
1400 if (MyInvalid)
|
|
|
1401 return 1;
|
|
|
1402 } else if (Invalid)
|
|
|
1403 *Invalid = false;
|
|
|
1404
|
|
|
1405 // Okay, we know we have a line number table. Do a binary search to find the
|
|
|
1406 // line number that this character position lands on.
|
|
|
1407 unsigned *SourceLineCache = Content->SourceLineCache;
|
|
|
1408 unsigned *SourceLineCacheStart = SourceLineCache;
|
|
|
1409 unsigned *SourceLineCacheEnd = SourceLineCache + Content->NumLines;
|
|
|
1410
|
|
|
1411 unsigned QueriedFilePos = FilePos+1;
|
|
|
1412
|
|
|
1413 // FIXME: I would like to be convinced that this code is worth being as
|
|
|
1414 // complicated as it is, binary search isn't that slow.
|
|
|
1415 //
|
|
|
1416 // If it is worth being optimized, then in my opinion it could be more
|
|
|
1417 // performant, simpler, and more obviously correct by just "galloping" outward
|
|
|
1418 // from the queried file position. In fact, this could be incorporated into a
|
|
|
1419 // generic algorithm such as lower_bound_with_hint.
|
|
|
1420 //
|
|
|
1421 // If someone gives me a test case where this matters, and I will do it! - DWD
|
|
|
1422
|
|
|
1423 // If the previous query was to the same file, we know both the file pos from
|
|
|
1424 // that query and the line number returned. This allows us to narrow the
|
|
|
1425 // search space from the entire file to something near the match.
|
|
|
1426 if (LastLineNoFileIDQuery == FID) {
|
|
|
1427 if (QueriedFilePos >= LastLineNoFilePos) {
|
|
|
1428 // FIXME: Potential overflow?
|
|
|
1429 SourceLineCache = SourceLineCache+LastLineNoResult-1;
|
|
|
1430
|
|
|
1431 // The query is likely to be nearby the previous one. Here we check to
|
|
|
1432 // see if it is within 5, 10 or 20 lines. It can be far away in cases
|
|
|
1433 // where big comment blocks and vertical whitespace eat up lines but
|
|
|
1434 // contribute no tokens.
|
|
|
1435 if (SourceLineCache+5 < SourceLineCacheEnd) {
|
|
|
1436 if (SourceLineCache[5] > QueriedFilePos)
|
|
|
1437 SourceLineCacheEnd = SourceLineCache+5;
|
|
|
1438 else if (SourceLineCache+10 < SourceLineCacheEnd) {
|
|
|
1439 if (SourceLineCache[10] > QueriedFilePos)
|
|
|
1440 SourceLineCacheEnd = SourceLineCache+10;
|
|
|
1441 else if (SourceLineCache+20 < SourceLineCacheEnd) {
|
|
|
1442 if (SourceLineCache[20] > QueriedFilePos)
|
|
|
1443 SourceLineCacheEnd = SourceLineCache+20;
|
|
|
1444 }
|
|
|
1445 }
|
|
|
1446 }
|
|
|
1447 } else {
|
|
|
1448 if (LastLineNoResult < Content->NumLines)
|
|
|
1449 SourceLineCacheEnd = SourceLineCache+LastLineNoResult+1;
|
|
|
1450 }
|
|
|
1451 }
|
|
|
1452
|
|
|
1453 unsigned *Pos
|
|
|
1454 = std::lower_bound(SourceLineCache, SourceLineCacheEnd, QueriedFilePos);
|
|
|
1455 unsigned LineNo = Pos-SourceLineCacheStart;
|
|
|
1456
|
|
|
1457 LastLineNoFileIDQuery = FID;
|
|
|
1458 LastLineNoContentCache = Content;
|
|
|
1459 LastLineNoFilePos = QueriedFilePos;
|
|
|
1460 LastLineNoResult = LineNo;
|
|
|
1461 return LineNo;
|
|
|
1462 }
|
|
|
1463
|
|
|
1464 unsigned SourceManager::getSpellingLineNumber(SourceLocation Loc,
|
|
|
1465 bool *Invalid) const {
|
|
|
1466 if (isInvalid(Loc, Invalid)) return 0;
|
|
|
1467 std::pair<FileID, unsigned> LocInfo = getDecomposedSpellingLoc(Loc);
|
|
|
1468 return getLineNumber(LocInfo.first, LocInfo.second);
|
|
|
1469 }
|
|
|
1470 unsigned SourceManager::getExpansionLineNumber(SourceLocation Loc,
|
|
|
1471 bool *Invalid) const {
|
|
|
1472 if (isInvalid(Loc, Invalid)) return 0;
|
|
|
1473 std::pair<FileID, unsigned> LocInfo = getDecomposedExpansionLoc(Loc);
|
|
|
1474 return getLineNumber(LocInfo.first, LocInfo.second);
|
|
|
1475 }
|
|
|
1476 unsigned SourceManager::getPresumedLineNumber(SourceLocation Loc,
|
|
|
1477 bool *Invalid) const {
|
|
|
1478 PresumedLoc PLoc = getPresumedLoc(Loc);
|
|
|
1479 if (isInvalid(PLoc, Invalid)) return 0;
|
|
|
1480 return PLoc.getLine();
|
|
|
1481 }
|
|
|
1482
|
|
|
1483 /// getFileCharacteristic - return the file characteristic of the specified
|
|
|
1484 /// source location, indicating whether this is a normal file, a system
|
|
|
1485 /// header, or an "implicit extern C" system header.
|
|
|
1486 ///
|
|
|
1487 /// This state can be modified with flags on GNU linemarker directives like:
|
|
|
1488 /// # 4 "foo.h" 3
|
|
|
1489 /// which changes all source locations in the current file after that to be
|
|
|
1490 /// considered to be from a system header.
|
|
|
1491 SrcMgr::CharacteristicKind
|
|
|
1492 SourceManager::getFileCharacteristic(SourceLocation Loc) const {
|
|
|
1493 assert(Loc.isValid() && "Can't get file characteristic of invalid loc!");
|
|
|
1494 std::pair<FileID, unsigned> LocInfo = getDecomposedExpansionLoc(Loc);
|
|
|
1495 bool Invalid = false;
|
|
|
1496 const SLocEntry &SEntry = getSLocEntry(LocInfo.first, &Invalid);
|
|
|
1497 if (Invalid || !SEntry.isFile())
|
|
|
1498 return C_User;
|
|
|
1499
|
|
|
1500 const SrcMgr::FileInfo &FI = SEntry.getFile();
|
|
|
1501
|
|
|
1502 // If there are no #line directives in this file, just return the whole-file
|
|
|
1503 // state.
|
|
|
1504 if (!FI.hasLineDirectives())
|
|
|
1505 return FI.getFileCharacteristic();
|
|
|
1506
|
|
|
1507 assert(LineTable && "Can't have linetable entries without a LineTable!");
|
|
|
1508 // See if there is a #line directive before the location.
|
|
|
1509 const LineEntry *Entry =
|
|
|
1510 LineTable->FindNearestLineEntry(LocInfo.first, LocInfo.second);
|
|
|
1511
|
|
|
1512 // If this is before the first line marker, use the file characteristic.
|
|
|
1513 if (!Entry)
|
|
|
1514 return FI.getFileCharacteristic();
|
|
|
1515
|
|
|
1516 return Entry->FileKind;
|
|
|
1517 }
|
|
|
1518
|
|
|
1519 /// Return the filename or buffer identifier of the buffer the location is in.
|
|
|
1520 /// Note that this name does not respect \#line directives. Use getPresumedLoc
|
|
|
1521 /// for normal clients.
|
|
|
1522 StringRef SourceManager::getBufferName(SourceLocation Loc,
|
|
|
1523 bool *Invalid) const {
|
|
|
1524 if (isInvalid(Loc, Invalid)) return "<invalid loc>";
|
|
|
1525
|
|
|
1526 return getBuffer(getFileID(Loc), Invalid)->getBufferIdentifier();
|
|
|
1527 }
|
|
|
1528
|
|
|
1529 /// getPresumedLoc - This method returns the "presumed" location of a
|
|
|
1530 /// SourceLocation specifies. A "presumed location" can be modified by \#line
|
|
|
1531 /// or GNU line marker directives. This provides a view on the data that a
|
|
|
1532 /// user should see in diagnostics, for example.
|
|
|
1533 ///
|
|
|
1534 /// Note that a presumed location is always given as the expansion point of an
|
|
|
1535 /// expansion location, not at the spelling location.
|
|
|
1536 PresumedLoc SourceManager::getPresumedLoc(SourceLocation Loc,
|
|
|
1537 bool UseLineDirectives) const {
|
|
|
1538 if (Loc.isInvalid()) return PresumedLoc();
|
|
|
1539
|
|
|
1540 // Presumed locations are always for expansion points.
|
|
|
1541 std::pair<FileID, unsigned> LocInfo = getDecomposedExpansionLoc(Loc);
|
|
|
1542
|
|
|
1543 bool Invalid = false;
|
|
|
1544 const SLocEntry &Entry = getSLocEntry(LocInfo.first, &Invalid);
|
|
|
1545 if (Invalid || !Entry.isFile())
|
|
|
1546 return PresumedLoc();
|
|
|
1547
|
|
|
1548 const SrcMgr::FileInfo &FI = Entry.getFile();
|
|
|
1549 const SrcMgr::ContentCache *C = FI.getContentCache();
|
|
|
1550
|
|
|
1551 // To get the source name, first consult the FileEntry (if one exists)
|
|
|
1552 // before the MemBuffer as this will avoid unnecessarily paging in the
|
|
|
1553 // MemBuffer.
|
|
|
1554 FileID FID = LocInfo.first;
|
|
|
1555 StringRef Filename;
|
|
|
1556 if (C->OrigEntry)
|
|
|
1557 Filename = C->OrigEntry->getName();
|
|
|
1558 else
|
|
|
1559 Filename = C->getBuffer(Diag, getFileManager())->getBufferIdentifier();
|
|
|
1560
|
|
|
1561 unsigned LineNo = getLineNumber(LocInfo.first, LocInfo.second, &Invalid);
|
|
|
1562 if (Invalid)
|
|
|
1563 return PresumedLoc();
|
|
|
1564 unsigned ColNo = getColumnNumber(LocInfo.first, LocInfo.second, &Invalid);
|
|
|
1565 if (Invalid)
|
|
|
1566 return PresumedLoc();
|
|
|
1567
|
|
|
1568 SourceLocation IncludeLoc = FI.getIncludeLoc();
|
|
|
1569
|
|
|
1570 // If we have #line directives in this file, update and overwrite the physical
|
|
|
1571 // location info if appropriate.
|
|
|
1572 if (UseLineDirectives && FI.hasLineDirectives()) {
|
|
|
1573 assert(LineTable && "Can't have linetable entries without a LineTable!");
|
|
|
1574 // See if there is a #line directive before this. If so, get it.
|
|
|
1575 if (const LineEntry *Entry =
|
|
|
1576 LineTable->FindNearestLineEntry(LocInfo.first, LocInfo.second)) {
|
|
|
1577 // If the LineEntry indicates a filename, use it.
|
|
|
1578 if (Entry->FilenameID != -1) {
|
|
|
1579 Filename = LineTable->getFilename(Entry->FilenameID);
|
|
|
1580 // The contents of files referenced by #line are not in the
|
|
|
1581 // SourceManager
|
|
|
1582 FID = FileID::get(0);
|
|
|
1583 }
|
|
|
1584
|
|
|
1585 // Use the line number specified by the LineEntry. This line number may
|
|
|
1586 // be multiple lines down from the line entry. Add the difference in
|
|
|
1587 // physical line numbers from the query point and the line marker to the
|
|
|
1588 // total.
|
|
|
1589 unsigned MarkerLineNo = getLineNumber(LocInfo.first, Entry->FileOffset);
|
|
|
1590 LineNo = Entry->LineNo + (LineNo-MarkerLineNo-1);
|
|
|
1591
|
|
|
1592 // Note that column numbers are not molested by line markers.
|
|
|
1593
|
|
|
1594 // Handle virtual #include manipulation.
|
|
|
1595 if (Entry->IncludeOffset) {
|
|
|
1596 IncludeLoc = getLocForStartOfFile(LocInfo.first);
|
|
|
1597 IncludeLoc = IncludeLoc.getLocWithOffset(Entry->IncludeOffset);
|
|
|
1598 }
|
|
|
1599 }
|
|
|
1600 }
|
|
|
1601
|
|
|
1602 return PresumedLoc(Filename.data(), FID, LineNo, ColNo, IncludeLoc);
|
|
|
1603 }
|
|
|
1604
|
|
|
1605 /// Returns whether the PresumedLoc for a given SourceLocation is
|
|
|
1606 /// in the main file.
|
|
|
1607 ///
|
|
|
1608 /// This computes the "presumed" location for a SourceLocation, then checks
|
|
|
1609 /// whether it came from a file other than the main file. This is different
|
|
|
1610 /// from isWrittenInMainFile() because it takes line marker directives into
|
|
|
1611 /// account.
|
|
|
1612 bool SourceManager::isInMainFile(SourceLocation Loc) const {
|
|
|
1613 if (Loc.isInvalid()) return false;
|
|
|
1614
|
|
|
1615 // Presumed locations are always for expansion points.
|
|
|
1616 std::pair<FileID, unsigned> LocInfo = getDecomposedExpansionLoc(Loc);
|
|
|
1617
|
|
|
1618 bool Invalid = false;
|
|
|
1619 const SLocEntry &Entry = getSLocEntry(LocInfo.first, &Invalid);
|
|
|
1620 if (Invalid || !Entry.isFile())
|
|
|
1621 return false;
|
|
|
1622
|
|
|
1623 const SrcMgr::FileInfo &FI = Entry.getFile();
|
|
|
1624
|
|
|
1625 // Check if there is a line directive for this location.
|
|
|
1626 if (FI.hasLineDirectives())
|
|
|
1627 if (const LineEntry *Entry =
|
|
|
1628 LineTable->FindNearestLineEntry(LocInfo.first, LocInfo.second))
|
|
|
1629 if (Entry->IncludeOffset)
|
|
|
1630 return false;
|
|
|
1631
|
|
|
1632 return FI.getIncludeLoc().isInvalid();
|
|
|
1633 }
|
|
|
1634
|
|
|
1635 /// The size of the SLocEntry that \p FID represents.
|
|
|
1636 unsigned SourceManager::getFileIDSize(FileID FID) const {
|
|
|
1637 bool Invalid = false;
|
|
|
1638 const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid);
|
|
|
1639 if (Invalid)
|
|
|
1640 return 0;
|
|
|
1641
|
|
|
1642 int ID = FID.ID;
|
|
|
1643 unsigned NextOffset;
|
|
|
1644 if ((ID > 0 && unsigned(ID+1) == local_sloc_entry_size()))
|
|
|
1645 NextOffset = getNextLocalOffset();
|
|
|
1646 else if (ID+1 == -1)
|
|
|
1647 NextOffset = MaxLoadedOffset;
|
|
|
1648 else
|
|
|
1649 NextOffset = getSLocEntry(FileID::get(ID+1)).getOffset();
|
|
|
1650
|
|
|
1651 return NextOffset - Entry.getOffset() - 1;
|
|
|
1652 }
|
|
|
1653
|
|
|
1654 //===----------------------------------------------------------------------===//
|
|
|
1655 // Other miscellaneous methods.
|
|
|
1656 //===----------------------------------------------------------------------===//
|
|
|
1657
|
|
|
1658 /// Get the source location for the given file:line:col triplet.
|
|
|
1659 ///
|
|
|
1660 /// If the source file is included multiple times, the source location will
|
|
|
1661 /// be based upon an arbitrary inclusion.
|
|
|
1662 SourceLocation SourceManager::translateFileLineCol(const FileEntry *SourceFile,
|
|
|
1663 unsigned Line,
|
|
|
1664 unsigned Col) const {
|
|
|
1665 assert(SourceFile && "Null source file!");
|
|
|
1666 assert(Line && Col && "Line and column should start from 1!");
|
|
|
1667
|
|
|
1668 FileID FirstFID = translateFile(SourceFile);
|
|
|
1669 return translateLineCol(FirstFID, Line, Col);
|
|
|
1670 }
|
|
|
1671
|
|
|
1672 /// Get the FileID for the given file.
|
|
|
1673 ///
|
|
|
1674 /// If the source file is included multiple times, the FileID will be the
|
|
|
1675 /// first inclusion.
|
|
|
1676 FileID SourceManager::translateFile(const FileEntry *SourceFile) const {
|
|
|
1677 assert(SourceFile && "Null source file!");
|
|
|
1678
|
|
|
1679 // First, check the main file ID, since it is common to look for a
|
|
|
1680 // location in the main file.
|
|
|
1681 if (MainFileID.isValid()) {
|
|
|
1682 bool Invalid = false;
|
|
|
1683 const SLocEntry &MainSLoc = getSLocEntry(MainFileID, &Invalid);
|
|
|
1684 if (Invalid)
|
|
|
1685 return FileID();
|
|
|
1686
|
|
|
1687 if (MainSLoc.isFile()) {
|
|
|
1688 const ContentCache *MainContentCache =
|
|
|
1689 MainSLoc.getFile().getContentCache();
|
|
|
1690 if (MainContentCache && MainContentCache->OrigEntry == SourceFile)
|
|
|
1691 return MainFileID;
|
|
|
1692 }
|
|
|
1693 }
|
|
|
1694
|
|
|
1695 // The location we're looking for isn't in the main file; look
|
|
|
1696 // through all of the local source locations.
|
|
|
1697 for (unsigned I = 0, N = local_sloc_entry_size(); I != N; ++I) {
|
|
|
1698 bool Invalid = false;
|
|
|
1699 const SLocEntry &SLoc = getLocalSLocEntry(I, &Invalid);
|
|
|
1700 if (Invalid)
|
|
|
1701 return FileID();
|
|
|
1702
|
|
|
1703 if (SLoc.isFile() && SLoc.getFile().getContentCache() &&
|
|
|
1704 SLoc.getFile().getContentCache()->OrigEntry == SourceFile)
|
|
|
1705 return FileID::get(I);
|
|
|
1706 }
|
|
|
1707
|
|
|
1708 // If that still didn't help, try the modules.
|
|
|
1709 for (unsigned I = 0, N = loaded_sloc_entry_size(); I != N; ++I) {
|
|
|
1710 const SLocEntry &SLoc = getLoadedSLocEntry(I);
|
|
|
1711 if (SLoc.isFile() && SLoc.getFile().getContentCache() &&
|
|
|
1712 SLoc.getFile().getContentCache()->OrigEntry == SourceFile)
|
|
|
1713 return FileID::get(-int(I) - 2);
|
|
|
1714 }
|
|
|
1715
|
|
|
1716 return FileID();
|
|
|
1717 }
|
|
|
1718
|
|
|
1719 /// Get the source location in \arg FID for the given line:col.
|
|
|
1720 /// Returns null location if \arg FID is not a file SLocEntry.
|
|
|
1721 SourceLocation SourceManager::translateLineCol(FileID FID,
|
|
|
1722 unsigned Line,
|
|
|
1723 unsigned Col) const {
|
|
|
1724 // Lines are used as a one-based index into a zero-based array. This assert
|
|
|
1725 // checks for possible buffer underruns.
|
|
|
1726 assert(Line && Col && "Line and column should start from 1!");
|
|
|
1727
|
|
|
1728 if (FID.isInvalid())
|
|
|
1729 return SourceLocation();
|
|
|
1730
|
|
|
1731 bool Invalid = false;
|
|
|
1732 const SLocEntry &Entry = getSLocEntry(FID, &Invalid);
|
|
|
1733 if (Invalid)
|
|
|
1734 return SourceLocation();
|
|
|
1735
|
|
|
1736 if (!Entry.isFile())
|
|
|
1737 return SourceLocation();
|
|
|
1738
|
|
|
1739 SourceLocation FileLoc = SourceLocation::getFileLoc(Entry.getOffset());
|
|
|
1740
|
|
|
1741 if (Line == 1 && Col == 1)
|
|
|
1742 return FileLoc;
|
|
|
1743
|
|
|
1744 ContentCache *Content
|
|
|
1745 = const_cast<ContentCache *>(Entry.getFile().getContentCache());
|
|
|
1746 if (!Content)
|
|
|
1747 return SourceLocation();
|
|
|
1748
|
|
|
1749 // If this is the first use of line information for this buffer, compute the
|
|
|
1750 // SourceLineCache for it on demand.
|
|
|
1751 if (!Content->SourceLineCache) {
|
|
|
1752 bool MyInvalid = false;
|
|
|
1753 ComputeLineNumbers(Diag, Content, ContentCacheAlloc, *this, MyInvalid);
|
|
|
1754 if (MyInvalid)
|
|
|
1755 return SourceLocation();
|
|
|
1756 }
|
|
|
1757
|
|
|
1758 if (Line > Content->NumLines) {
|
|
|
1759 unsigned Size = Content->getBuffer(Diag, getFileManager())->getBufferSize();
|
|
|
1760 if (Size > 0)
|
|
|
1761 --Size;
|
|
|
1762 return FileLoc.getLocWithOffset(Size);
|
|
|
1763 }
|
|
|
1764
|
|
|
1765 const llvm::MemoryBuffer *Buffer = Content->getBuffer(Diag, getFileManager());
|
|
|
1766 unsigned FilePos = Content->SourceLineCache[Line - 1];
|
|
|
1767 const char *Buf = Buffer->getBufferStart() + FilePos;
|
|
|
1768 unsigned BufLength = Buffer->getBufferSize() - FilePos;
|
|
|
1769 if (BufLength == 0)
|
|
|
1770 return FileLoc.getLocWithOffset(FilePos);
|
|
|
1771
|
|
|
1772 unsigned i = 0;
|
|
|
1773
|
|
|
1774 // Check that the given column is valid.
|
|
|
1775 while (i < BufLength-1 && i < Col-1 && Buf[i] != '\n' && Buf[i] != '\r')
|
|
|
1776 ++i;
|
|
|
1777 return FileLoc.getLocWithOffset(FilePos + i);
|
|
|
1778 }
|
|
|
1779
|
|
|
1780 /// Compute a map of macro argument chunks to their expanded source
|
|
|
1781 /// location. Chunks that are not part of a macro argument will map to an
|
|
|
1782 /// invalid source location. e.g. if a file contains one macro argument at
|
|
|
1783 /// offset 100 with length 10, this is how the map will be formed:
|
|
|
1784 /// 0 -> SourceLocation()
|
|
|
1785 /// 100 -> Expanded macro arg location
|
|
|
1786 /// 110 -> SourceLocation()
|
|
|
1787 void SourceManager::computeMacroArgsCache(MacroArgsMap &MacroArgsCache,
|
|
|
1788 FileID FID) const {
|
|
|
1789 assert(FID.isValid());
|
|
|
1790
|
|
|
1791 // Initially no macro argument chunk is present.
|
|
|
1792 MacroArgsCache.insert(std::make_pair(0, SourceLocation()));
|
|
|
1793
|
|
|
1794 int ID = FID.ID;
|
|
|
1795 while (true) {
|
|
|
1796 ++ID;
|
|
|
1797 // Stop if there are no more FileIDs to check.
|
|
|
1798 if (ID > 0) {
|
|
|
1799 if (unsigned(ID) >= local_sloc_entry_size())
|
|
|
1800 return;
|
|
|
1801 } else if (ID == -1) {
|
|
|
1802 return;
|
|
|
1803 }
|
|
|
1804
|
|
|
1805 bool Invalid = false;
|
|
|
1806 const SrcMgr::SLocEntry &Entry = getSLocEntryByID(ID, &Invalid);
|
|
|
1807 if (Invalid)
|
|
|
1808 return;
|
|
|
1809 if (Entry.isFile()) {
|
|
|
1810 SourceLocation IncludeLoc = Entry.getFile().getIncludeLoc();
|
|
173
|
1811 bool IncludedInFID =
|
|
|
1812 (IncludeLoc.isValid() && isInFileID(IncludeLoc, FID)) ||
|
|
|
1813 // Predefined header doesn't have a valid include location in main
|
|
|
1814 // file, but any files created by it should still be skipped when
|
|
|
1815 // computing macro args expanded in the main file.
|
|
|
1816 (FID == MainFileID && Entry.getFile().Filename == "<built-in>");
|
|
|
1817 if (IncludedInFID) {
|
|
|
1818 // Skip the files/macros of the #include'd file, we only care about
|
|
|
1819 // macros that lexed macro arguments from our file.
|
|
|
1820 if (Entry.getFile().NumCreatedFIDs)
|
|
|
1821 ID += Entry.getFile().NumCreatedFIDs - 1 /*because of next ++ID*/;
|
|
150
|
1822 continue;
|
|
173
|
1823 } else if (IncludeLoc.isValid()) {
|
|
|
1824 // If file was included but not from FID, there is no more files/macros
|
|
|
1825 // that may be "contained" in this file.
|
|
|
1826 return;
|
|
|
1827 }
|
|
150
|
1828 continue;
|
|
|
1829 }
|
|
|
1830
|
|
|
1831 const ExpansionInfo &ExpInfo = Entry.getExpansion();
|
|
|
1832
|
|
|
1833 if (ExpInfo.getExpansionLocStart().isFileID()) {
|
|
|
1834 if (!isInFileID(ExpInfo.getExpansionLocStart(), FID))
|
|
|
1835 return; // No more files/macros that may be "contained" in this file.
|
|
|
1836 }
|
|
|
1837
|
|
|
1838 if (!ExpInfo.isMacroArgExpansion())
|
|
|
1839 continue;
|
|
|
1840
|
|
|
1841 associateFileChunkWithMacroArgExp(MacroArgsCache, FID,
|
|
|
1842 ExpInfo.getSpellingLoc(),
|
|
|
1843 SourceLocation::getMacroLoc(Entry.getOffset()),
|
|
|
1844 getFileIDSize(FileID::get(ID)));
|
|
|
1845 }
|
|
|
1846 }
|
|
|
1847
|
|
|
1848 void SourceManager::associateFileChunkWithMacroArgExp(
|
|
|
1849 MacroArgsMap &MacroArgsCache,
|
|
|
1850 FileID FID,
|
|
|
1851 SourceLocation SpellLoc,
|
|
|
1852 SourceLocation ExpansionLoc,
|
|
|
1853 unsigned ExpansionLength) const {
|
|
|
1854 if (!SpellLoc.isFileID()) {
|
|
|
1855 unsigned SpellBeginOffs = SpellLoc.getOffset();
|
|
|
1856 unsigned SpellEndOffs = SpellBeginOffs + ExpansionLength;
|
|
|
1857
|
|
|
1858 // The spelling range for this macro argument expansion can span multiple
|
|
|
1859 // consecutive FileID entries. Go through each entry contained in the
|
|
|
1860 // spelling range and if one is itself a macro argument expansion, recurse
|
|
|
1861 // and associate the file chunk that it represents.
|
|
|
1862
|
|
|
1863 FileID SpellFID; // Current FileID in the spelling range.
|
|
|
1864 unsigned SpellRelativeOffs;
|
|
|
1865 std::tie(SpellFID, SpellRelativeOffs) = getDecomposedLoc(SpellLoc);
|
|
|
1866 while (true) {
|
|
|
1867 const SLocEntry &Entry = getSLocEntry(SpellFID);
|
|
|
1868 unsigned SpellFIDBeginOffs = Entry.getOffset();
|
|
|
1869 unsigned SpellFIDSize = getFileIDSize(SpellFID);
|
|
|
1870 unsigned SpellFIDEndOffs = SpellFIDBeginOffs + SpellFIDSize;
|
|
|
1871 const ExpansionInfo &Info = Entry.getExpansion();
|
|
|
1872 if (Info.isMacroArgExpansion()) {
|
|
|
1873 unsigned CurrSpellLength;
|
|
|
1874 if (SpellFIDEndOffs < SpellEndOffs)
|
|
|
1875 CurrSpellLength = SpellFIDSize - SpellRelativeOffs;
|
|
|
1876 else
|
|
|
1877 CurrSpellLength = ExpansionLength;
|
|
|
1878 associateFileChunkWithMacroArgExp(MacroArgsCache, FID,
|
|
|
1879 Info.getSpellingLoc().getLocWithOffset(SpellRelativeOffs),
|
|
|
1880 ExpansionLoc, CurrSpellLength);
|
|
|
1881 }
|
|
|
1882
|
|
|
1883 if (SpellFIDEndOffs >= SpellEndOffs)
|
|
|
1884 return; // we covered all FileID entries in the spelling range.
|
|
|
1885
|
|
|
1886 // Move to the next FileID entry in the spelling range.
|
|
|
1887 unsigned advance = SpellFIDSize - SpellRelativeOffs + 1;
|
|
|
1888 ExpansionLoc = ExpansionLoc.getLocWithOffset(advance);
|
|
|
1889 ExpansionLength -= advance;
|
|
|
1890 ++SpellFID.ID;
|
|
|
1891 SpellRelativeOffs = 0;
|
|
|
1892 }
|
|
|
1893 }
|
|
|
1894
|
|
|
1895 assert(SpellLoc.isFileID());
|
|
|
1896
|
|
|
1897 unsigned BeginOffs;
|
|
|
1898 if (!isInFileID(SpellLoc, FID, &BeginOffs))
|
|
|
1899 return;
|
|
|
1900
|
|
|
1901 unsigned EndOffs = BeginOffs + ExpansionLength;
|
|
|
1902
|
|
|
1903 // Add a new chunk for this macro argument. A previous macro argument chunk
|
|
|
1904 // may have been lexed again, so e.g. if the map is
|
|
|
1905 // 0 -> SourceLocation()
|
|
|
1906 // 100 -> Expanded loc #1
|
|
|
1907 // 110 -> SourceLocation()
|
|
|
1908 // and we found a new macro FileID that lexed from offset 105 with length 3,
|
|
|
1909 // the new map will be:
|
|
|
1910 // 0 -> SourceLocation()
|
|
|
1911 // 100 -> Expanded loc #1
|
|
|
1912 // 105 -> Expanded loc #2
|
|
|
1913 // 108 -> Expanded loc #1
|
|
|
1914 // 110 -> SourceLocation()
|
|
|
1915 //
|
|
|
1916 // Since re-lexed macro chunks will always be the same size or less of
|
|
|
1917 // previous chunks, we only need to find where the ending of the new macro
|
|
|
1918 // chunk is mapped to and update the map with new begin/end mappings.
|
|
|
1919
|
|
|
1920 MacroArgsMap::iterator I = MacroArgsCache.upper_bound(EndOffs);
|
|
|
1921 --I;
|
|
|
1922 SourceLocation EndOffsMappedLoc = I->second;
|
|
|
1923 MacroArgsCache[BeginOffs] = ExpansionLoc;
|
|
|
1924 MacroArgsCache[EndOffs] = EndOffsMappedLoc;
|
|
|
1925 }
|
|
|
1926
|
|
|
1927 /// If \arg Loc points inside a function macro argument, the returned
|
|
|
1928 /// location will be the macro location in which the argument was expanded.
|
|
|
1929 /// If a macro argument is used multiple times, the expanded location will
|
|
|
1930 /// be at the first expansion of the argument.
|
|
|
1931 /// e.g.
|
|
|
1932 /// MY_MACRO(foo);
|
|
|
1933 /// ^
|
|
|
1934 /// Passing a file location pointing at 'foo', will yield a macro location
|
|
|
1935 /// where 'foo' was expanded into.
|
|
|
1936 SourceLocation
|
|
|
1937 SourceManager::getMacroArgExpandedLocation(SourceLocation Loc) const {
|
|
|
1938 if (Loc.isInvalid() || !Loc.isFileID())
|
|
|
1939 return Loc;
|
|
|
1940
|
|
|
1941 FileID FID;
|
|
|
1942 unsigned Offset;
|
|
|
1943 std::tie(FID, Offset) = getDecomposedLoc(Loc);
|
|
|
1944 if (FID.isInvalid())
|
|
|
1945 return Loc;
|
|
|
1946
|
|
|
1947 std::unique_ptr<MacroArgsMap> &MacroArgsCache = MacroArgsCacheMap[FID];
|
|
|
1948 if (!MacroArgsCache) {
|
|
|
1949 MacroArgsCache = std::make_unique<MacroArgsMap>();
|
|
|
1950 computeMacroArgsCache(*MacroArgsCache, FID);
|
|
|
1951 }
|
|
|
1952
|
|
|
1953 assert(!MacroArgsCache->empty());
|
|
|
1954 MacroArgsMap::iterator I = MacroArgsCache->upper_bound(Offset);
|
|
|
1955 --I;
|
|
|
1956
|
|
|
1957 unsigned MacroArgBeginOffs = I->first;
|
|
|
1958 SourceLocation MacroArgExpandedLoc = I->second;
|
|
|
1959 if (MacroArgExpandedLoc.isValid())
|
|
|
1960 return MacroArgExpandedLoc.getLocWithOffset(Offset - MacroArgBeginOffs);
|
|
|
1961
|
|
|
1962 return Loc;
|
|
|
1963 }
|
|
|
1964
|
|
|
1965 std::pair<FileID, unsigned>
|
|
|
1966 SourceManager::getDecomposedIncludedLoc(FileID FID) const {
|
|
|
1967 if (FID.isInvalid())
|
|
|
1968 return std::make_pair(FileID(), 0);
|
|
|
1969
|
|
|
1970 // Uses IncludedLocMap to retrieve/cache the decomposed loc.
|
|
|
1971
|
|
|
1972 using DecompTy = std::pair<FileID, unsigned>;
|
|
|
1973 auto InsertOp = IncludedLocMap.try_emplace(FID);
|
|
|
1974 DecompTy &DecompLoc = InsertOp.first->second;
|
|
|
1975 if (!InsertOp.second)
|
|
|
1976 return DecompLoc; // already in map.
|
|
|
1977
|
|
|
1978 SourceLocation UpperLoc;
|
|
|
1979 bool Invalid = false;
|
|
|
1980 const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid);
|
|
|
1981 if (!Invalid) {
|
|
|
1982 if (Entry.isExpansion())
|
|
|
1983 UpperLoc = Entry.getExpansion().getExpansionLocStart();
|
|
|
1984 else
|
|
|
1985 UpperLoc = Entry.getFile().getIncludeLoc();
|
|
|
1986 }
|
|
|
1987
|
|
|
1988 if (UpperLoc.isValid())
|
|
|
1989 DecompLoc = getDecomposedLoc(UpperLoc);
|
|
|
1990
|
|
|
1991 return DecompLoc;
|
|
|
1992 }
|
|
|
1993
|
|
|
1994 /// Given a decomposed source location, move it up the include/expansion stack
|
|
|
1995 /// to the parent source location. If this is possible, return the decomposed
|
|
|
1996 /// version of the parent in Loc and return false. If Loc is the top-level
|
|
|
1997 /// entry, return true and don't modify it.
|
|
|
1998 static bool MoveUpIncludeHierarchy(std::pair<FileID, unsigned> &Loc,
|
|
|
1999 const SourceManager &SM) {
|
|
|
2000 std::pair<FileID, unsigned> UpperLoc = SM.getDecomposedIncludedLoc(Loc.first);
|
|
|
2001 if (UpperLoc.first.isInvalid())
|
|
|
2002 return true; // We reached the top.
|
|
|
2003
|
|
|
2004 Loc = UpperLoc;
|
|
|
2005 return false;
|
|
|
2006 }
|
|
|
2007
|
|
|
2008 /// Return the cache entry for comparing the given file IDs
|
|
|
2009 /// for isBeforeInTranslationUnit.
|
|
|
2010 InBeforeInTUCacheEntry &SourceManager::getInBeforeInTUCache(FileID LFID,
|
|
|
2011 FileID RFID) const {
|
|
|
2012 // This is a magic number for limiting the cache size. It was experimentally
|
|
|
2013 // derived from a small Objective-C project (where the cache filled
|
|
|
2014 // out to ~250 items). We can make it larger if necessary.
|
|
|
2015 enum { MagicCacheSize = 300 };
|
|
|
2016 IsBeforeInTUCacheKey Key(LFID, RFID);
|
|
|
2017
|
|
|
2018 // If the cache size isn't too large, do a lookup and if necessary default
|
|
|
2019 // construct an entry. We can then return it to the caller for direct
|
|
|
2020 // use. When they update the value, the cache will get automatically
|
|
|
2021 // updated as well.
|
|
|
2022 if (IBTUCache.size() < MagicCacheSize)
|
|
|
2023 return IBTUCache[Key];
|
|
|
2024
|
|
|
2025 // Otherwise, do a lookup that will not construct a new value.
|
|
|
2026 InBeforeInTUCache::iterator I = IBTUCache.find(Key);
|
|
|
2027 if (I != IBTUCache.end())
|
|
|
2028 return I->second;
|
|
|
2029
|
|
|
2030 // Fall back to the overflow value.
|
|
|
2031 return IBTUCacheOverflow;
|
|
|
2032 }
|
|
|
2033
|
|
|
2034 /// Determines the order of 2 source locations in the translation unit.
|
|
|
2035 ///
|
|
|
2036 /// \returns true if LHS source location comes before RHS, false otherwise.
|
|
|
2037 bool SourceManager::isBeforeInTranslationUnit(SourceLocation LHS,
|
|
|
2038 SourceLocation RHS) const {
|
|
|
2039 assert(LHS.isValid() && RHS.isValid() && "Passed invalid source location!");
|
|
|
2040 if (LHS == RHS)
|
|
|
2041 return false;
|
|
|
2042
|
|
|
2043 std::pair<FileID, unsigned> LOffs = getDecomposedLoc(LHS);
|
|
|
2044 std::pair<FileID, unsigned> ROffs = getDecomposedLoc(RHS);
|
|
|
2045
|
|
|
2046 // getDecomposedLoc may have failed to return a valid FileID because, e.g. it
|
|
|
2047 // is a serialized one referring to a file that was removed after we loaded
|
|
|
2048 // the PCH.
|
|
|
2049 if (LOffs.first.isInvalid() || ROffs.first.isInvalid())
|
|
|
2050 return LOffs.first.isInvalid() && !ROffs.first.isInvalid();
|
|
|
2051
|
|
|
2052 std::pair<bool, bool> InSameTU = isInTheSameTranslationUnit(LOffs, ROffs);
|
|
|
2053 if (InSameTU.first)
|
|
|
2054 return InSameTU.second;
|
|
|
2055
|
|
|
2056 // If we arrived here, the location is either in a built-ins buffer or
|
|
|
2057 // associated with global inline asm. PR5662 and PR22576 are examples.
|
|
|
2058
|
|
|
2059 StringRef LB = getBuffer(LOffs.first)->getBufferIdentifier();
|
|
|
2060 StringRef RB = getBuffer(ROffs.first)->getBufferIdentifier();
|
|
|
2061 bool LIsBuiltins = LB == "<built-in>";
|
|
|
2062 bool RIsBuiltins = RB == "<built-in>";
|
|
|
2063 // Sort built-in before non-built-in.
|
|
|
2064 if (LIsBuiltins || RIsBuiltins) {
|
|
|
2065 if (LIsBuiltins != RIsBuiltins)
|
|
|
2066 return LIsBuiltins;
|
|
|
2067 // Both are in built-in buffers, but from different files. We just claim that
|
|
|
2068 // lower IDs come first.
|
|
|
2069 return LOffs.first < ROffs.first;
|
|
|
2070 }
|
|
|
2071 bool LIsAsm = LB == "<inline asm>";
|
|
|
2072 bool RIsAsm = RB == "<inline asm>";
|
|
|
2073 // Sort assembler after built-ins, but before the rest.
|
|
|
2074 if (LIsAsm || RIsAsm) {
|
|
|
2075 if (LIsAsm != RIsAsm)
|
|
|
2076 return RIsAsm;
|
|
|
2077 assert(LOffs.first == ROffs.first);
|
|
|
2078 return false;
|
|
|
2079 }
|
|
|
2080 bool LIsScratch = LB == "<scratch space>";
|
|
|
2081 bool RIsScratch = RB == "<scratch space>";
|
|
|
2082 // Sort scratch after inline asm, but before the rest.
|
|
|
2083 if (LIsScratch || RIsScratch) {
|
|
|
2084 if (LIsScratch != RIsScratch)
|
|
|
2085 return LIsScratch;
|
|
|
2086 return LOffs.second < ROffs.second;
|
|
|
2087 }
|
|
|
2088 llvm_unreachable("Unsortable locations found");
|
|
|
2089 }
|
|
|
2090
|
|
|
2091 std::pair<bool, bool> SourceManager::isInTheSameTranslationUnit(
|
|
|
2092 std::pair<FileID, unsigned> &LOffs,
|
|
|
2093 std::pair<FileID, unsigned> &ROffs) const {
|
|
|
2094 // If the source locations are in the same file, just compare offsets.
|
|
|
2095 if (LOffs.first == ROffs.first)
|
|
|
2096 return std::make_pair(true, LOffs.second < ROffs.second);
|
|
|
2097
|
|
|
2098 // If we are comparing a source location with multiple locations in the same
|
|
|
2099 // file, we get a big win by caching the result.
|
|
|
2100 InBeforeInTUCacheEntry &IsBeforeInTUCache =
|
|
|
2101 getInBeforeInTUCache(LOffs.first, ROffs.first);
|
|
|
2102
|
|
|
2103 // If we are comparing a source location with multiple locations in the same
|
|
|
2104 // file, we get a big win by caching the result.
|
|
|
2105 if (IsBeforeInTUCache.isCacheValid(LOffs.first, ROffs.first))
|
|
|
2106 return std::make_pair(
|
|
|
2107 true, IsBeforeInTUCache.getCachedResult(LOffs.second, ROffs.second));
|
|
|
2108
|
|
|
2109 // Okay, we missed in the cache, start updating the cache for this query.
|
|
|
2110 IsBeforeInTUCache.setQueryFIDs(LOffs.first, ROffs.first,
|
|
|
2111 /*isLFIDBeforeRFID=*/LOffs.first.ID < ROffs.first.ID);
|
|
|
2112
|
|
|
2113 // We need to find the common ancestor. The only way of doing this is to
|
|
|
2114 // build the complete include chain for one and then walking up the chain
|
|
|
2115 // of the other looking for a match.
|
|
|
2116 // We use a map from FileID to Offset to store the chain. Easier than writing
|
|
|
2117 // a custom set hash info that only depends on the first part of a pair.
|
|
|
2118 using LocSet = llvm::SmallDenseMap<FileID, unsigned, 16>;
|
|
|
2119 LocSet LChain;
|
|
|
2120 do {
|
|
|
2121 LChain.insert(LOffs);
|
|
|
2122 // We catch the case where LOffs is in a file included by ROffs and
|
|
|
2123 // quit early. The other way round unfortunately remains suboptimal.
|
|
|
2124 } while (LOffs.first != ROffs.first && !MoveUpIncludeHierarchy(LOffs, *this));
|
|
|
2125 LocSet::iterator I;
|
|
|
2126 while((I = LChain.find(ROffs.first)) == LChain.end()) {
|
|
|
2127 if (MoveUpIncludeHierarchy(ROffs, *this))
|
|
|
2128 break; // Met at topmost file.
|
|
|
2129 }
|
|
|
2130 if (I != LChain.end())
|
|
|
2131 LOffs = *I;
|
|
|
2132
|
|
|
2133 // If we exited because we found a nearest common ancestor, compare the
|
|
|
2134 // locations within the common file and cache them.
|
|
|
2135 if (LOffs.first == ROffs.first) {
|
|
|
2136 IsBeforeInTUCache.setCommonLoc(LOffs.first, LOffs.second, ROffs.second);
|
|
|
2137 return std::make_pair(
|
|
|
2138 true, IsBeforeInTUCache.getCachedResult(LOffs.second, ROffs.second));
|
|
|
2139 }
|
|
|
2140 // Clear the lookup cache, it depends on a common location.
|
|
|
2141 IsBeforeInTUCache.clear();
|
|
|
2142 return std::make_pair(false, false);
|
|
|
2143 }
|
|
|
2144
|
|
|
2145 void SourceManager::PrintStats() const {
|
|
|
2146 llvm::errs() << "\n*** Source Manager Stats:\n";
|
|
|
2147 llvm::errs() << FileInfos.size() << " files mapped, " << MemBufferInfos.size()
|
|
|
2148 << " mem buffers mapped.\n";
|
|
|
2149 llvm::errs() << LocalSLocEntryTable.size() << " local SLocEntry's allocated ("
|
|
|
2150 << llvm::capacity_in_bytes(LocalSLocEntryTable)
|
|
|
2151 << " bytes of capacity), "
|
|
|
2152 << NextLocalOffset << "B of Sloc address space used.\n";
|
|
|
2153 llvm::errs() << LoadedSLocEntryTable.size()
|
|
|
2154 << " loaded SLocEntries allocated, "
|
|
|
2155 << MaxLoadedOffset - CurrentLoadedOffset
|
|
|
2156 << "B of Sloc address space used.\n";
|
|
|
2157
|
|
|
2158 unsigned NumLineNumsComputed = 0;
|
|
|
2159 unsigned NumFileBytesMapped = 0;
|
|
|
2160 for (fileinfo_iterator I = fileinfo_begin(), E = fileinfo_end(); I != E; ++I){
|
|
|
2161 NumLineNumsComputed += I->second->SourceLineCache != nullptr;
|
|
|
2162 NumFileBytesMapped += I->second->getSizeBytesMapped();
|
|
|
2163 }
|
|
|
2164 unsigned NumMacroArgsComputed = MacroArgsCacheMap.size();
|
|
|
2165
|
|
|
2166 llvm::errs() << NumFileBytesMapped << " bytes of files mapped, "
|
|
|
2167 << NumLineNumsComputed << " files with line #'s computed, "
|
|
|
2168 << NumMacroArgsComputed << " files with macro args computed.\n";
|
|
|
2169 llvm::errs() << "FileID scans: " << NumLinearScans << " linear, "
|
|
|
2170 << NumBinaryProbes << " binary.\n";
|
|
|
2171 }
|
|
|
2172
|
|
|
2173 LLVM_DUMP_METHOD void SourceManager::dump() const {
|
|
|
2174 llvm::raw_ostream &out = llvm::errs();
|
|
|
2175
|
|
|
2176 auto DumpSLocEntry = [&](int ID, const SrcMgr::SLocEntry &Entry,
|
|
|
2177 llvm::Optional<unsigned> NextStart) {
|
|
|
2178 out << "SLocEntry <FileID " << ID << "> " << (Entry.isFile() ? "file" : "expansion")
|
|
|
2179 << " <SourceLocation " << Entry.getOffset() << ":";
|
|
|
2180 if (NextStart)
|
|
|
2181 out << *NextStart << ">\n";
|
|
|
2182 else
|
|
|
2183 out << "???\?>\n";
|
|
|
2184 if (Entry.isFile()) {
|
|
|
2185 auto &FI = Entry.getFile();
|
|
|
2186 if (FI.NumCreatedFIDs)
|
|
|
2187 out << " covers <FileID " << ID << ":" << int(ID + FI.NumCreatedFIDs)
|
|
|
2188 << ">\n";
|
|
|
2189 if (FI.getIncludeLoc().isValid())
|
|
|
2190 out << " included from " << FI.getIncludeLoc().getOffset() << "\n";
|
|
|
2191 if (auto *CC = FI.getContentCache()) {
|
|
|
2192 out << " for " << (CC->OrigEntry ? CC->OrigEntry->getName() : "<none>")
|
|
|
2193 << "\n";
|
|
|
2194 if (CC->BufferOverridden)
|
|
|
2195 out << " contents overridden\n";
|
|
|
2196 if (CC->ContentsEntry != CC->OrigEntry) {
|
|
|
2197 out << " contents from "
|
|
|
2198 << (CC->ContentsEntry ? CC->ContentsEntry->getName() : "<none>")
|
|
|
2199 << "\n";
|
|
|
2200 }
|
|
|
2201 }
|
|
|
2202 } else {
|
|
|
2203 auto &EI = Entry.getExpansion();
|
|
|
2204 out << " spelling from " << EI.getSpellingLoc().getOffset() << "\n";
|
|
|
2205 out << " macro " << (EI.isMacroArgExpansion() ? "arg" : "body")
|
|
|
2206 << " range <" << EI.getExpansionLocStart().getOffset() << ":"
|
|
|
2207 << EI.getExpansionLocEnd().getOffset() << ">\n";
|
|
|
2208 }
|
|
|
2209 };
|
|
|
2210
|
|
|
2211 // Dump local SLocEntries.
|
|
|
2212 for (unsigned ID = 0, NumIDs = LocalSLocEntryTable.size(); ID != NumIDs; ++ID) {
|
|
|
2213 DumpSLocEntry(ID, LocalSLocEntryTable[ID],
|
|
|
2214 ID == NumIDs - 1 ? NextLocalOffset
|
|
|
2215 : LocalSLocEntryTable[ID + 1].getOffset());
|
|
|
2216 }
|
|
|
2217 // Dump loaded SLocEntries.
|
|
|
2218 llvm::Optional<unsigned> NextStart;
|
|
|
2219 for (unsigned Index = 0; Index != LoadedSLocEntryTable.size(); ++Index) {
|
|
|
2220 int ID = -(int)Index - 2;
|
|
|
2221 if (SLocEntryLoaded[Index]) {
|
|
|
2222 DumpSLocEntry(ID, LoadedSLocEntryTable[Index], NextStart);
|
|
|
2223 NextStart = LoadedSLocEntryTable[Index].getOffset();
|
|
|
2224 } else {
|
|
|
2225 NextStart = None;
|
|
|
2226 }
|
|
|
2227 }
|
|
|
2228 }
|
|
|
2229
|
|
|
2230 ExternalSLocEntrySource::~ExternalSLocEntrySource() = default;
|
|
|
2231
|
|
|
2232 /// Return the amount of memory used by memory buffers, breaking down
|
|
|
2233 /// by heap-backed versus mmap'ed memory.
|
|
|
2234 SourceManager::MemoryBufferSizes SourceManager::getMemoryBufferSizes() const {
|
|
|
2235 size_t malloc_bytes = 0;
|
|
|
2236 size_t mmap_bytes = 0;
|
|
|
2237
|
|
|
2238 for (unsigned i = 0, e = MemBufferInfos.size(); i != e; ++i)
|
|
|
2239 if (size_t sized_mapped = MemBufferInfos[i]->getSizeBytesMapped())
|
|
|
2240 switch (MemBufferInfos[i]->getMemoryBufferKind()) {
|
|
|
2241 case llvm::MemoryBuffer::MemoryBuffer_MMap:
|
|
|
2242 mmap_bytes += sized_mapped;
|
|
|
2243 break;
|
|
|
2244 case llvm::MemoryBuffer::MemoryBuffer_Malloc:
|
|
|
2245 malloc_bytes += sized_mapped;
|
|
|
2246 break;
|
|
|
2247 }
|
|
|
2248
|
|
|
2249 return MemoryBufferSizes(malloc_bytes, mmap_bytes);
|
|
|
2250 }
|
|
|
2251
|
|
|
2252 size_t SourceManager::getDataStructureSizes() const {
|
|
|
2253 size_t size = llvm::capacity_in_bytes(MemBufferInfos)
|
|
|
2254 + llvm::capacity_in_bytes(LocalSLocEntryTable)
|
|
|
2255 + llvm::capacity_in_bytes(LoadedSLocEntryTable)
|
|
|
2256 + llvm::capacity_in_bytes(SLocEntryLoaded)
|
|
|
2257 + llvm::capacity_in_bytes(FileInfos);
|
|
|
2258
|
|
|
2259 if (OverriddenFilesInfo)
|
|
|
2260 size += llvm::capacity_in_bytes(OverriddenFilesInfo->OverriddenFiles);
|
|
|
2261
|
|
|
2262 return size;
|
|
|
2263 }
|
|
|
2264
|
|
|
2265 SourceManagerForFile::SourceManagerForFile(StringRef FileName,
|
|
|
2266 StringRef Content) {
|
|
|
2267 // This is referenced by `FileMgr` and will be released by `FileMgr` when it
|
|
|
2268 // is deleted.
|
|
|
2269 IntrusiveRefCntPtr<llvm::vfs::InMemoryFileSystem> InMemoryFileSystem(
|
|
|
2270 new llvm::vfs::InMemoryFileSystem);
|
|
|
2271 InMemoryFileSystem->addFile(
|
|
|
2272 FileName, 0,
|
|
|
2273 llvm::MemoryBuffer::getMemBuffer(Content, FileName,
|
|
|
2274 /*RequiresNullTerminator=*/false));
|
|
|
2275 // This is passed to `SM` as reference, so the pointer has to be referenced
|
|
|
2276 // in `Environment` so that `FileMgr` can out-live this function scope.
|
|
|
2277 FileMgr =
|
|
|
2278 std::make_unique<FileManager>(FileSystemOptions(), InMemoryFileSystem);
|
|
|
2279 // This is passed to `SM` as reference, so the pointer has to be referenced
|
|
|
2280 // by `Environment` due to the same reason above.
|
|
|
2281 Diagnostics = std::make_unique<DiagnosticsEngine>(
|
|
|
2282 IntrusiveRefCntPtr<DiagnosticIDs>(new DiagnosticIDs),
|
|
|
2283 new DiagnosticOptions);
|
|
|
2284 SourceMgr = std::make_unique<SourceManager>(*Diagnostics, *FileMgr);
|
|
|
2285 FileID ID = SourceMgr->createFileID(*FileMgr->getFile(FileName),
|
|
|
2286 SourceLocation(), clang::SrcMgr::C_User);
|
|
|
2287 assert(ID.isValid());
|
|
|
2288 SourceMgr->setMainFileID(ID);
|
|
|
2289 }
|
