blob: 8c8f6363279729afb96352f61394385fa00ec402 [file] [log] [blame]
Reid Spencer5f016e22007-07-11 17:01:13 +00001//===--- SourceManager.cpp - Track and cache source files -----------------===//
2//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner0bc735f2007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Reid Spencer5f016e22007-07-11 17:01:13 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This file implements the SourceManager interface.
11//
12//===----------------------------------------------------------------------===//
13
14#include "clang/Basic/SourceManager.h"
Douglas Gregord4f77aa2009-04-13 15:31:25 +000015#include "clang/Basic/SourceManagerInternals.h"
Douglas Gregoraea67db2010-03-15 22:54:52 +000016#include "clang/Basic/Diagnostic.h"
Reid Spencer5f016e22007-07-11 17:01:13 +000017#include "clang/Basic/FileManager.h"
Benjamin Kramer5807d9c2010-11-18 12:46:39 +000018#include "llvm/ADT/StringSwitch.h"
Douglas Gregor86a4d0d2011-02-03 17:17:35 +000019#include "llvm/ADT/Optional.h"
Argyrios Kyrtzidisd9d2b672011-08-21 23:33:04 +000020#include "llvm/ADT/STLExtras.h"
Chris Lattner5e36a7a2007-07-24 05:57:19 +000021#include "llvm/Support/Compiler.h"
Reid Spencer5f016e22007-07-11 17:01:13 +000022#include "llvm/Support/MemoryBuffer.h"
Chris Lattnerd57a7ef2009-08-23 22:45:33 +000023#include "llvm/Support/raw_ostream.h"
Michael J. Spencer03013fa2010-11-29 18:12:39 +000024#include "llvm/Support/Path.h"
Ted Kremenek6e36c122011-07-27 18:41:16 +000025#include "llvm/Support/Capacity.h"
Reid Spencer5f016e22007-07-11 17:01:13 +000026#include <algorithm>
Douglas Gregoraea67db2010-03-15 22:54:52 +000027#include <string>
Douglas Gregorf715ca12010-03-16 00:06:06 +000028#include <cstring>
Douglas Gregor86a4d0d2011-02-03 17:17:35 +000029#include <sys/stat.h>
Douglas Gregoraea67db2010-03-15 22:54:52 +000030
Reid Spencer5f016e22007-07-11 17:01:13 +000031using namespace clang;
32using namespace SrcMgr;
33using llvm::MemoryBuffer;
34
Chris Lattner23b5dc62009-02-04 00:40:31 +000035//===----------------------------------------------------------------------===//
Chris Lattnerde7aeef2009-01-26 00:43:02 +000036// SourceManager Helper Classes
Chris Lattner23b5dc62009-02-04 00:40:31 +000037//===----------------------------------------------------------------------===//
Chris Lattnerde7aeef2009-01-26 00:43:02 +000038
Ted Kremenek78d85f52007-10-30 21:08:08 +000039ContentCache::~ContentCache() {
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +000040 if (shouldFreeBuffer())
41 delete Buffer.getPointer();
Reid Spencer5f016e22007-07-11 17:01:13 +000042}
43
Chandler Carruth3201f382011-07-26 05:17:23 +000044/// getSizeBytesMapped - Returns the number of bytes actually mapped for this
45/// ContentCache. This can be 0 if the MemBuffer was not actually expanded.
Ted Kremenekc16c2082009-01-06 01:55:26 +000046unsigned ContentCache::getSizeBytesMapped() const {
Douglas Gregorc8151082010-03-16 22:53:51 +000047 return Buffer.getPointer() ? Buffer.getPointer()->getBufferSize() : 0;
Ted Kremenekc16c2082009-01-06 01:55:26 +000048}
49
Ted Kremenekf61b8312011-04-28 20:36:42 +000050/// Returns the kind of memory used to back the memory buffer for
51/// this content cache. This is used for performance analysis.
52llvm::MemoryBuffer::BufferKind ContentCache::getMemoryBufferKind() const {
53 assert(Buffer.getPointer());
54
55 // Should be unreachable, but keep for sanity.
56 if (!Buffer.getPointer())
57 return llvm::MemoryBuffer::MemoryBuffer_Malloc;
58
59 const llvm::MemoryBuffer *buf = Buffer.getPointer();
60 return buf->getBufferKind();
61}
62
Ted Kremenekc16c2082009-01-06 01:55:26 +000063/// getSize - Returns the size of the content encapsulated by this ContentCache.
64/// This can be the size of the source file or the size of an arbitrary
65/// scratch buffer. If the ContentCache encapsulates a source file, that
Douglas Gregor29684422009-12-02 06:49:09 +000066/// file is not lazily brought in from disk to satisfy this query.
Ted Kremenekc16c2082009-01-06 01:55:26 +000067unsigned ContentCache::getSize() const {
Douglas Gregorc8151082010-03-16 22:53:51 +000068 return Buffer.getPointer() ? (unsigned) Buffer.getPointer()->getBufferSize()
Argyrios Kyrtzidisb1c86492011-03-05 01:03:53 +000069 : (unsigned) ContentsEntry->getSize();
Ted Kremenekc16c2082009-01-06 01:55:26 +000070}
71
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +000072void ContentCache::replaceBuffer(const llvm::MemoryBuffer *B,
73 bool DoNotFree) {
Argyrios Kyrtzidisd54dff02012-05-03 21:50:39 +000074 if (B && B == Buffer.getPointer()) {
Argyrios Kyrtzidisa4288c42011-12-10 01:38:26 +000075 assert(0 && "Replacing with the same buffer");
76 Buffer.setInt(DoNotFree? DoNotFreeFlag : 0);
77 return;
78 }
Douglas Gregor29684422009-12-02 06:49:09 +000079
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +000080 if (shouldFreeBuffer())
81 delete Buffer.getPointer();
Douglas Gregorc8151082010-03-16 22:53:51 +000082 Buffer.setPointer(B);
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +000083 Buffer.setInt(DoNotFree? DoNotFreeFlag : 0);
Douglas Gregor29684422009-12-02 06:49:09 +000084}
85
David Blaikied6471f72011-09-25 23:23:43 +000086const llvm::MemoryBuffer *ContentCache::getBuffer(DiagnosticsEngine &Diag,
Chris Lattner5c5db4e2010-04-20 20:49:23 +000087 const SourceManager &SM,
Chris Lattnere127a0d2010-04-20 20:35:58 +000088 SourceLocation Loc,
Douglas Gregor36c35ba2010-03-16 00:35:39 +000089 bool *Invalid) const {
Chris Lattnerb088cd32010-11-23 08:50:03 +000090 // Lazily create the Buffer for ContentCaches that wrap files. If we already
Chris Lattnerfc8f0e12011-04-15 05:22:18 +000091 // computed it, just return what we have.
Argyrios Kyrtzidisb1c86492011-03-05 01:03:53 +000092 if (Buffer.getPointer() || ContentsEntry == 0) {
Chris Lattnerb088cd32010-11-23 08:50:03 +000093 if (Invalid)
94 *Invalid = isBufferInvalid();
Chris Lattner38caec42010-04-20 18:14:03 +000095
Chris Lattnerb088cd32010-11-23 08:50:03 +000096 return Buffer.getPointer();
97 }
Benjamin Kramer5807d9c2010-11-18 12:46:39 +000098
Chris Lattnerb088cd32010-11-23 08:50:03 +000099 std::string ErrorStr;
Argyrios Kyrtzidisb1c86492011-03-05 01:03:53 +0000100 Buffer.setPointer(SM.getFileManager().getBufferForFile(ContentsEntry, &ErrorStr));
Chris Lattnerb088cd32010-11-23 08:50:03 +0000101
102 // If we were unable to open the file, then we are in an inconsistent
103 // situation where the content cache referenced a file which no longer
104 // exists. Most likely, we were using a stat cache with an invalid entry but
105 // the file could also have been removed during processing. Since we can't
106 // really deal with this situation, just create an empty buffer.
107 //
108 // FIXME: This is definitely not ideal, but our immediate clients can't
109 // currently handle returning a null entry here. Ideally we should detect
110 // that we are in an inconsistent situation and error out as quickly as
111 // possible.
112 if (!Buffer.getPointer()) {
Chris Lattner5f9e2722011-07-23 10:55:15 +0000113 const StringRef FillStr("<<<MISSING SOURCE FILE>>>\n");
Argyrios Kyrtzidisb1c86492011-03-05 01:03:53 +0000114 Buffer.setPointer(MemoryBuffer::getNewMemBuffer(ContentsEntry->getSize(),
Chris Lattnerb088cd32010-11-23 08:50:03 +0000115 "<invalid>"));
116 char *Ptr = const_cast<char*>(Buffer.getPointer()->getBufferStart());
Argyrios Kyrtzidisb1c86492011-03-05 01:03:53 +0000117 for (unsigned i = 0, e = ContentsEntry->getSize(); i != e; ++i)
Chris Lattnerb088cd32010-11-23 08:50:03 +0000118 Ptr[i] = FillStr[i % FillStr.size()];
119
120 if (Diag.isDiagnosticInFlight())
121 Diag.SetDelayedDiagnostic(diag::err_cannot_open_file,
Argyrios Kyrtzidisb1c86492011-03-05 01:03:53 +0000122 ContentsEntry->getName(), ErrorStr);
Chris Lattnerb088cd32010-11-23 08:50:03 +0000123 else
124 Diag.Report(Loc, diag::err_cannot_open_file)
Argyrios Kyrtzidisb1c86492011-03-05 01:03:53 +0000125 << ContentsEntry->getName() << ErrorStr;
Chris Lattnerb088cd32010-11-23 08:50:03 +0000126
127 Buffer.setInt(Buffer.getInt() | InvalidFlag);
128
129 if (Invalid) *Invalid = true;
130 return Buffer.getPointer();
131 }
132
133 // Check that the file's size is the same as in the file entry (which may
134 // have come from a stat cache).
Argyrios Kyrtzidisb1c86492011-03-05 01:03:53 +0000135 if (getRawBuffer()->getBufferSize() != (size_t)ContentsEntry->getSize()) {
Chris Lattnerb088cd32010-11-23 08:50:03 +0000136 if (Diag.isDiagnosticInFlight())
137 Diag.SetDelayedDiagnostic(diag::err_file_modified,
Argyrios Kyrtzidisb1c86492011-03-05 01:03:53 +0000138 ContentsEntry->getName());
Chris Lattnerb088cd32010-11-23 08:50:03 +0000139 else
140 Diag.Report(Loc, diag::err_file_modified)
Argyrios Kyrtzidisb1c86492011-03-05 01:03:53 +0000141 << ContentsEntry->getName();
Chris Lattnerb088cd32010-11-23 08:50:03 +0000142
143 Buffer.setInt(Buffer.getInt() | InvalidFlag);
144 if (Invalid) *Invalid = true;
145 return Buffer.getPointer();
146 }
Eric Christopher156119d2011-04-09 00:01:04 +0000147
Chris Lattnerb088cd32010-11-23 08:50:03 +0000148 // If the buffer is valid, check to see if it has a UTF Byte Order Mark
Eric Christopher156119d2011-04-09 00:01:04 +0000149 // (BOM). We only support UTF-8 with and without a BOM right now. See
Chris Lattnerb088cd32010-11-23 08:50:03 +0000150 // http://en.wikipedia.org/wiki/Byte_order_mark for more information.
Chris Lattner5f9e2722011-07-23 10:55:15 +0000151 StringRef BufStr = Buffer.getPointer()->getBuffer();
Eric Christopher156119d2011-04-09 00:01:04 +0000152 const char *InvalidBOM = llvm::StringSwitch<const char *>(BufStr)
Chris Lattnerb088cd32010-11-23 08:50:03 +0000153 .StartsWith("\xFE\xFF", "UTF-16 (BE)")
154 .StartsWith("\xFF\xFE", "UTF-16 (LE)")
155 .StartsWith("\x00\x00\xFE\xFF", "UTF-32 (BE)")
156 .StartsWith("\xFF\xFE\x00\x00", "UTF-32 (LE)")
157 .StartsWith("\x2B\x2F\x76", "UTF-7")
158 .StartsWith("\xF7\x64\x4C", "UTF-1")
159 .StartsWith("\xDD\x73\x66\x73", "UTF-EBCDIC")
160 .StartsWith("\x0E\xFE\xFF", "SDSU")
161 .StartsWith("\xFB\xEE\x28", "BOCU-1")
162 .StartsWith("\x84\x31\x95\x33", "GB-18030")
163 .Default(0);
164
Eric Christopher156119d2011-04-09 00:01:04 +0000165 if (InvalidBOM) {
Chris Lattnerb088cd32010-11-23 08:50:03 +0000166 Diag.Report(Loc, diag::err_unsupported_bom)
Eric Christopher156119d2011-04-09 00:01:04 +0000167 << InvalidBOM << ContentsEntry->getName();
Chris Lattnerb088cd32010-11-23 08:50:03 +0000168 Buffer.setInt(Buffer.getInt() | InvalidFlag);
Ted Kremenek5b034ad2009-01-06 22:43:04 +0000169 }
Douglas Gregoraea67db2010-03-15 22:54:52 +0000170
Douglas Gregorc8151082010-03-16 22:53:51 +0000171 if (Invalid)
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000172 *Invalid = isBufferInvalid();
Douglas Gregorc8151082010-03-16 22:53:51 +0000173
174 return Buffer.getPointer();
Ted Kremenekc16c2082009-01-06 01:55:26 +0000175}
176
Chris Lattner5f9e2722011-07-23 10:55:15 +0000177unsigned LineTableInfo::getLineTableFilenameID(StringRef Name) {
Chris Lattner5b9a5042009-01-26 07:57:50 +0000178 // Look up the filename in the string table, returning the pre-existing value
179 // if it exists.
Mike Stump1eb44332009-09-09 15:08:12 +0000180 llvm::StringMapEntry<unsigned> &Entry =
Jay Foad65aa6882011-06-21 15:13:30 +0000181 FilenameIDs.GetOrCreateValue(Name, ~0U);
Chris Lattner5b9a5042009-01-26 07:57:50 +0000182 if (Entry.getValue() != ~0U)
183 return Entry.getValue();
Mike Stump1eb44332009-09-09 15:08:12 +0000184
Chris Lattner5b9a5042009-01-26 07:57:50 +0000185 // Otherwise, assign this the next available ID.
186 Entry.setValue(FilenamesByID.size());
187 FilenamesByID.push_back(&Entry);
188 return FilenamesByID.size()-1;
189}
190
Chris Lattnerac50e342009-02-03 22:13:05 +0000191/// AddLineNote - Add a line note to the line table that indicates that there
James Dennett7285a062012-06-15 21:28:23 +0000192/// is a \#line at the specified FID/Offset location which changes the presumed
Chris Lattnerac50e342009-02-03 22:13:05 +0000193/// location to LineNo/FilenameID.
Douglas Gregor47d9de62012-06-08 16:40:28 +0000194void LineTableInfo::AddLineNote(FileID FID, unsigned Offset,
Chris Lattnerac50e342009-02-03 22:13:05 +0000195 unsigned LineNo, int FilenameID) {
Chris Lattner23b5dc62009-02-04 00:40:31 +0000196 std::vector<LineEntry> &Entries = LineEntries[FID];
Mike Stump1eb44332009-09-09 15:08:12 +0000197
Chris Lattner23b5dc62009-02-04 00:40:31 +0000198 assert((Entries.empty() || Entries.back().FileOffset < Offset) &&
199 "Adding line entries out of order!");
Mike Stump1eb44332009-09-09 15:08:12 +0000200
Chris Lattner9d79eba2009-02-04 05:21:58 +0000201 SrcMgr::CharacteristicKind Kind = SrcMgr::C_User;
Chris Lattner137b6a62009-02-04 06:25:26 +0000202 unsigned IncludeOffset = 0;
Mike Stump1eb44332009-09-09 15:08:12 +0000203
Chris Lattner9d79eba2009-02-04 05:21:58 +0000204 if (!Entries.empty()) {
205 // If this is a '#line 4' after '#line 42 "foo.h"', make sure to remember
206 // that we are still in "foo.h".
207 if (FilenameID == -1)
208 FilenameID = Entries.back().FilenameID;
Mike Stump1eb44332009-09-09 15:08:12 +0000209
Chris Lattner137b6a62009-02-04 06:25:26 +0000210 // If we are after a line marker that switched us to system header mode, or
211 // that set #include information, preserve it.
Chris Lattner9d79eba2009-02-04 05:21:58 +0000212 Kind = Entries.back().FileKind;
Chris Lattner137b6a62009-02-04 06:25:26 +0000213 IncludeOffset = Entries.back().IncludeOffset;
Chris Lattner9d79eba2009-02-04 05:21:58 +0000214 }
Mike Stump1eb44332009-09-09 15:08:12 +0000215
Chris Lattner137b6a62009-02-04 06:25:26 +0000216 Entries.push_back(LineEntry::get(Offset, LineNo, FilenameID, Kind,
217 IncludeOffset));
Chris Lattnerac50e342009-02-03 22:13:05 +0000218}
219
Chris Lattner9d79eba2009-02-04 05:21:58 +0000220/// AddLineNote This is the same as the previous version of AddLineNote, but is
221/// used for GNU line markers. If EntryExit is 0, then this doesn't change the
222/// presumed #include stack. If it is 1, this is a file entry, if it is 2 then
223/// this is a file exit. FileKind specifies whether this is a system header or
224/// extern C system header.
Douglas Gregor47d9de62012-06-08 16:40:28 +0000225void LineTableInfo::AddLineNote(FileID FID, unsigned Offset,
Chris Lattner9d79eba2009-02-04 05:21:58 +0000226 unsigned LineNo, int FilenameID,
227 unsigned EntryExit,
228 SrcMgr::CharacteristicKind FileKind) {
229 assert(FilenameID != -1 && "Unspecified filename should use other accessor");
Mike Stump1eb44332009-09-09 15:08:12 +0000230
Chris Lattner9d79eba2009-02-04 05:21:58 +0000231 std::vector<LineEntry> &Entries = LineEntries[FID];
Mike Stump1eb44332009-09-09 15:08:12 +0000232
Chris Lattner9d79eba2009-02-04 05:21:58 +0000233 assert((Entries.empty() || Entries.back().FileOffset < Offset) &&
234 "Adding line entries out of order!");
235
Chris Lattner137b6a62009-02-04 06:25:26 +0000236 unsigned IncludeOffset = 0;
237 if (EntryExit == 0) { // No #include stack change.
238 IncludeOffset = Entries.empty() ? 0 : Entries.back().IncludeOffset;
239 } else if (EntryExit == 1) {
240 IncludeOffset = Offset-1;
241 } else if (EntryExit == 2) {
242 assert(!Entries.empty() && Entries.back().IncludeOffset &&
243 "PPDirectives should have caught case when popping empty include stack");
Mike Stump1eb44332009-09-09 15:08:12 +0000244
Chris Lattner137b6a62009-02-04 06:25:26 +0000245 // Get the include loc of the last entries' include loc as our include loc.
246 IncludeOffset = 0;
247 if (const LineEntry *PrevEntry =
248 FindNearestLineEntry(FID, Entries.back().IncludeOffset))
249 IncludeOffset = PrevEntry->IncludeOffset;
250 }
Mike Stump1eb44332009-09-09 15:08:12 +0000251
Chris Lattner137b6a62009-02-04 06:25:26 +0000252 Entries.push_back(LineEntry::get(Offset, LineNo, FilenameID, FileKind,
253 IncludeOffset));
Chris Lattner9d79eba2009-02-04 05:21:58 +0000254}
255
256
Chris Lattner3cd949c2009-02-04 01:55:42 +0000257/// FindNearestLineEntry - Find the line entry nearest to FID that is before
258/// it. If there is no line entry before Offset in FID, return null.
Douglas Gregor47d9de62012-06-08 16:40:28 +0000259const LineEntry *LineTableInfo::FindNearestLineEntry(FileID FID,
Chris Lattner3cd949c2009-02-04 01:55:42 +0000260 unsigned Offset) {
261 const std::vector<LineEntry> &Entries = LineEntries[FID];
262 assert(!Entries.empty() && "No #line entries for this FID after all!");
263
Chris Lattner6c1fbe02009-02-04 04:46:59 +0000264 // It is very common for the query to be after the last #line, check this
265 // first.
266 if (Entries.back().FileOffset <= Offset)
267 return &Entries.back();
Chris Lattner3cd949c2009-02-04 01:55:42 +0000268
Chris Lattner6c1fbe02009-02-04 04:46:59 +0000269 // Do a binary search to find the maximal element that is still before Offset.
270 std::vector<LineEntry>::const_iterator I =
271 std::upper_bound(Entries.begin(), Entries.end(), Offset);
272 if (I == Entries.begin()) return 0;
273 return &*--I;
Chris Lattner3cd949c2009-02-04 01:55:42 +0000274}
Chris Lattnerac50e342009-02-03 22:13:05 +0000275
Douglas Gregorbd945002009-04-13 16:31:14 +0000276/// \brief Add a new line entry that has already been encoded into
277/// the internal representation of the line table.
Douglas Gregor47d9de62012-06-08 16:40:28 +0000278void LineTableInfo::AddEntry(FileID FID,
Douglas Gregorbd945002009-04-13 16:31:14 +0000279 const std::vector<LineEntry> &Entries) {
280 LineEntries[FID] = Entries;
281}
Chris Lattnerac50e342009-02-03 22:13:05 +0000282
Chris Lattner5b9a5042009-01-26 07:57:50 +0000283/// getLineTableFilenameID - Return the uniqued ID for the specified filename.
Mike Stump1eb44332009-09-09 15:08:12 +0000284///
Chris Lattner5f9e2722011-07-23 10:55:15 +0000285unsigned SourceManager::getLineTableFilenameID(StringRef Name) {
Chris Lattner5b9a5042009-01-26 07:57:50 +0000286 if (LineTable == 0)
287 LineTable = new LineTableInfo();
Jay Foad65aa6882011-06-21 15:13:30 +0000288 return LineTable->getLineTableFilenameID(Name);
Chris Lattner5b9a5042009-01-26 07:57:50 +0000289}
290
291
Chris Lattner4c4ea172009-02-03 21:52:55 +0000292/// AddLineNote - Add a line note to the line table for the FileID and offset
293/// specified by Loc. If FilenameID is -1, it is considered to be
294/// unspecified.
295void SourceManager::AddLineNote(SourceLocation Loc, unsigned LineNo,
296 int FilenameID) {
Chandler Carruthe7b2b6e2011-07-25 20:52:32 +0000297 std::pair<FileID, unsigned> LocInfo = getDecomposedExpansionLoc(Loc);
Mike Stump1eb44332009-09-09 15:08:12 +0000298
Douglas Gregore23ac652011-04-20 00:21:03 +0000299 bool Invalid = false;
300 const SLocEntry &Entry = getSLocEntry(LocInfo.first, &Invalid);
301 if (!Entry.isFile() || Invalid)
302 return;
303
304 const SrcMgr::FileInfo &FileInfo = Entry.getFile();
Chris Lattnerac50e342009-02-03 22:13:05 +0000305
306 // Remember that this file has #line directives now if it doesn't already.
307 const_cast<SrcMgr::FileInfo&>(FileInfo).setHasLineDirectives();
Mike Stump1eb44332009-09-09 15:08:12 +0000308
Chris Lattnerac50e342009-02-03 22:13:05 +0000309 if (LineTable == 0)
310 LineTable = new LineTableInfo();
Douglas Gregor47d9de62012-06-08 16:40:28 +0000311 LineTable->AddLineNote(LocInfo.first, LocInfo.second, LineNo, FilenameID);
Chris Lattner4c4ea172009-02-03 21:52:55 +0000312}
313
Chris Lattner9d79eba2009-02-04 05:21:58 +0000314/// AddLineNote - Add a GNU line marker to the line table.
315void SourceManager::AddLineNote(SourceLocation Loc, unsigned LineNo,
316 int FilenameID, bool IsFileEntry,
317 bool IsFileExit, bool IsSystemHeader,
318 bool IsExternCHeader) {
319 // If there is no filename and no flags, this is treated just like a #line,
320 // which does not change the flags of the previous line marker.
321 if (FilenameID == -1) {
322 assert(!IsFileEntry && !IsFileExit && !IsSystemHeader && !IsExternCHeader &&
323 "Can't set flags without setting the filename!");
324 return AddLineNote(Loc, LineNo, FilenameID);
325 }
Mike Stump1eb44332009-09-09 15:08:12 +0000326
Chandler Carruthe7b2b6e2011-07-25 20:52:32 +0000327 std::pair<FileID, unsigned> LocInfo = getDecomposedExpansionLoc(Loc);
Douglas Gregore23ac652011-04-20 00:21:03 +0000328
329 bool Invalid = false;
330 const SLocEntry &Entry = getSLocEntry(LocInfo.first, &Invalid);
331 if (!Entry.isFile() || Invalid)
332 return;
333
334 const SrcMgr::FileInfo &FileInfo = Entry.getFile();
Mike Stump1eb44332009-09-09 15:08:12 +0000335
Chris Lattner9d79eba2009-02-04 05:21:58 +0000336 // Remember that this file has #line directives now if it doesn't already.
337 const_cast<SrcMgr::FileInfo&>(FileInfo).setHasLineDirectives();
Mike Stump1eb44332009-09-09 15:08:12 +0000338
Chris Lattner9d79eba2009-02-04 05:21:58 +0000339 if (LineTable == 0)
340 LineTable = new LineTableInfo();
Mike Stump1eb44332009-09-09 15:08:12 +0000341
Chris Lattner9d79eba2009-02-04 05:21:58 +0000342 SrcMgr::CharacteristicKind FileKind;
343 if (IsExternCHeader)
344 FileKind = SrcMgr::C_ExternCSystem;
345 else if (IsSystemHeader)
346 FileKind = SrcMgr::C_System;
347 else
348 FileKind = SrcMgr::C_User;
Mike Stump1eb44332009-09-09 15:08:12 +0000349
Chris Lattner9d79eba2009-02-04 05:21:58 +0000350 unsigned EntryExit = 0;
351 if (IsFileEntry)
352 EntryExit = 1;
353 else if (IsFileExit)
354 EntryExit = 2;
Mike Stump1eb44332009-09-09 15:08:12 +0000355
Douglas Gregor47d9de62012-06-08 16:40:28 +0000356 LineTable->AddLineNote(LocInfo.first, LocInfo.second, LineNo, FilenameID,
Chris Lattner9d79eba2009-02-04 05:21:58 +0000357 EntryExit, FileKind);
358}
359
Douglas Gregorbd945002009-04-13 16:31:14 +0000360LineTableInfo &SourceManager::getLineTable() {
361 if (LineTable == 0)
362 LineTable = new LineTableInfo();
363 return *LineTable;
364}
Chris Lattner4c4ea172009-02-03 21:52:55 +0000365
Chris Lattner23b5dc62009-02-04 00:40:31 +0000366//===----------------------------------------------------------------------===//
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000367// Private 'Create' methods.
Chris Lattner23b5dc62009-02-04 00:40:31 +0000368//===----------------------------------------------------------------------===//
Ted Kremenekc16c2082009-01-06 01:55:26 +0000369
David Blaikied6471f72011-09-25 23:23:43 +0000370SourceManager::SourceManager(DiagnosticsEngine &Diag, FileManager &FileMgr)
Argyrios Kyrtzidis299a4a92011-03-08 23:35:24 +0000371 : Diag(Diag), FileMgr(FileMgr), OverridenFilesKeepOriginalName(true),
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000372 ExternalSLocEntries(0), LineTable(0), NumLinearScans(0),
Argyrios Kyrtzidisa4c29b62012-02-20 23:58:07 +0000373 NumBinaryProbes(0), FakeBufferForRecovery(0),
374 FakeContentCacheForRecovery(0) {
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000375 clearIDTables();
376 Diag.setSourceManager(this);
377}
378
Chris Lattner5b9a5042009-01-26 07:57:50 +0000379SourceManager::~SourceManager() {
380 delete LineTable;
Mike Stump1eb44332009-09-09 15:08:12 +0000381
Chris Lattner0d0bf8c2009-02-03 07:30:45 +0000382 // Delete FileEntry objects corresponding to content caches. Since the actual
383 // content cache objects are bump pointer allocated, we just have to run the
384 // dtors, but we call the deallocate method for completeness.
385 for (unsigned i = 0, e = MemBufferInfos.size(); i != e; ++i) {
Argyrios Kyrtzidis99ee0852011-12-15 23:37:55 +0000386 if (MemBufferInfos[i]) {
387 MemBufferInfos[i]->~ContentCache();
388 ContentCacheAlloc.Deallocate(MemBufferInfos[i]);
389 }
Chris Lattner0d0bf8c2009-02-03 07:30:45 +0000390 }
391 for (llvm::DenseMap<const FileEntry*, SrcMgr::ContentCache*>::iterator
392 I = FileInfos.begin(), E = FileInfos.end(); I != E; ++I) {
Argyrios Kyrtzidis99ee0852011-12-15 23:37:55 +0000393 if (I->second) {
394 I->second->~ContentCache();
395 ContentCacheAlloc.Deallocate(I->second);
396 }
Chris Lattner0d0bf8c2009-02-03 07:30:45 +0000397 }
Douglas Gregore23ac652011-04-20 00:21:03 +0000398
399 delete FakeBufferForRecovery;
Argyrios Kyrtzidisa4c29b62012-02-20 23:58:07 +0000400 delete FakeContentCacheForRecovery;
Argyrios Kyrtzidisfb3612e2011-09-26 08:01:50 +0000401
402 for (llvm::DenseMap<FileID, MacroArgsMap *>::iterator
403 I = MacroArgsCacheMap.begin(),E = MacroArgsCacheMap.end(); I!=E; ++I) {
404 delete I->second;
405 }
Chris Lattner5b9a5042009-01-26 07:57:50 +0000406}
407
408void SourceManager::clearIDTables() {
409 MainFileID = FileID();
Jordan Rosed73ef132012-06-06 17:25:21 +0000410 PredefinesFileID = FileID();
Douglas Gregorf62d43d2011-07-19 16:10:42 +0000411 LocalSLocEntryTable.clear();
412 LoadedSLocEntryTable.clear();
413 SLocEntryLoaded.clear();
Chris Lattner5b9a5042009-01-26 07:57:50 +0000414 LastLineNoFileIDQuery = FileID();
415 LastLineNoContentCache = 0;
416 LastFileIDLookup = FileID();
Mike Stump1eb44332009-09-09 15:08:12 +0000417
Chris Lattner5b9a5042009-01-26 07:57:50 +0000418 if (LineTable)
419 LineTable->clear();
Mike Stump1eb44332009-09-09 15:08:12 +0000420
Chandler Carruth3201f382011-07-26 05:17:23 +0000421 // Use up FileID #0 as an invalid expansion.
Douglas Gregorf62d43d2011-07-19 16:10:42 +0000422 NextLocalOffset = 0;
Argyrios Kyrtzidisac836e42011-08-17 00:31:20 +0000423 CurrentLoadedOffset = MaxLoadedOffset;
Chandler Carruthbf340e42011-07-26 03:03:05 +0000424 createExpansionLoc(SourceLocation(),SourceLocation(),SourceLocation(), 1);
Chris Lattner5b9a5042009-01-26 07:57:50 +0000425}
426
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000427/// getOrCreateContentCache - Create or return a cached ContentCache for the
428/// specified file.
429const ContentCache *
430SourceManager::getOrCreateContentCache(const FileEntry *FileEnt) {
Reid Spencer5f016e22007-07-11 17:01:13 +0000431 assert(FileEnt && "Didn't specify a file entry to use?");
Mike Stump1eb44332009-09-09 15:08:12 +0000432
Reid Spencer5f016e22007-07-11 17:01:13 +0000433 // Do we already have information about this file?
Chris Lattner0d0bf8c2009-02-03 07:30:45 +0000434 ContentCache *&Entry = FileInfos[FileEnt];
435 if (Entry) return Entry;
Mike Stump1eb44332009-09-09 15:08:12 +0000436
Chris Lattner00282d62009-02-03 07:41:46 +0000437 // Nope, create a new Cache entry. Make sure it is at least 8-byte aligned
438 // so that FileInfo can use the low 3 bits of the pointer for its own
439 // nefarious purposes.
440 unsigned EntryAlign = llvm::AlignOf<ContentCache>::Alignment;
441 EntryAlign = std::max(8U, EntryAlign);
442 Entry = ContentCacheAlloc.Allocate<ContentCache>(1, EntryAlign);
Argyrios Kyrtzidisb1c86492011-03-05 01:03:53 +0000443
Argyrios Kyrtzidisd54dff02012-05-03 21:50:39 +0000444 if (OverriddenFilesInfo) {
445 // If the file contents are overridden with contents from another file,
446 // pass that file to ContentCache.
447 llvm::DenseMap<const FileEntry *, const FileEntry *>::iterator
448 overI = OverriddenFilesInfo->OverriddenFiles.find(FileEnt);
449 if (overI == OverriddenFilesInfo->OverriddenFiles.end())
450 new (Entry) ContentCache(FileEnt);
451 else
452 new (Entry) ContentCache(OverridenFilesKeepOriginalName ? FileEnt
453 : overI->second,
454 overI->second);
455 } else {
Argyrios Kyrtzidisb1c86492011-03-05 01:03:53 +0000456 new (Entry) ContentCache(FileEnt);
Argyrios Kyrtzidisd54dff02012-05-03 21:50:39 +0000457 }
Argyrios Kyrtzidisb1c86492011-03-05 01:03:53 +0000458
Chris Lattner0d0bf8c2009-02-03 07:30:45 +0000459 return Entry;
Reid Spencer5f016e22007-07-11 17:01:13 +0000460}
461
462
Ted Kremenekd1c0eee2007-10-31 17:53:38 +0000463/// createMemBufferContentCache - Create a new ContentCache for the specified
464/// memory buffer. This does no caching.
Ted Kremenek78d85f52007-10-30 21:08:08 +0000465const ContentCache*
466SourceManager::createMemBufferContentCache(const MemoryBuffer *Buffer) {
Chris Lattner00282d62009-02-03 07:41:46 +0000467 // Add a new ContentCache to the MemBufferInfos list and return it. Make sure
468 // it is at least 8-byte aligned so that FileInfo can use the low 3 bits of
469 // the pointer for its own nefarious purposes.
470 unsigned EntryAlign = llvm::AlignOf<ContentCache>::Alignment;
471 EntryAlign = std::max(8U, EntryAlign);
472 ContentCache *Entry = ContentCacheAlloc.Allocate<ContentCache>(1, EntryAlign);
Chris Lattner0d0bf8c2009-02-03 07:30:45 +0000473 new (Entry) ContentCache();
474 MemBufferInfos.push_back(Entry);
475 Entry->setBuffer(Buffer);
476 return Entry;
Reid Spencer5f016e22007-07-11 17:01:13 +0000477}
478
Argyrios Kyrtzidisa4c29b62012-02-20 23:58:07 +0000479const SrcMgr::SLocEntry &SourceManager::loadSLocEntry(unsigned Index,
480 bool *Invalid) const {
481 assert(!SLocEntryLoaded[Index]);
482 if (ExternalSLocEntries->ReadSLocEntry(-(static_cast<int>(Index) + 2))) {
483 if (Invalid)
484 *Invalid = true;
485 // If the file of the SLocEntry changed we could still have loaded it.
486 if (!SLocEntryLoaded[Index]) {
487 // Try to recover; create a SLocEntry so the rest of clang can handle it.
488 LoadedSLocEntryTable[Index] = SLocEntry::get(0,
489 FileInfo::get(SourceLocation(),
490 getFakeContentCacheForRecovery(),
491 SrcMgr::C_User));
492 }
493 }
494
495 return LoadedSLocEntryTable[Index];
496}
497
Douglas Gregorf62d43d2011-07-19 16:10:42 +0000498std::pair<int, unsigned>
499SourceManager::AllocateLoadedSLocEntries(unsigned NumSLocEntries,
500 unsigned TotalSize) {
501 assert(ExternalSLocEntries && "Don't have an external sloc source");
502 LoadedSLocEntryTable.resize(LoadedSLocEntryTable.size() + NumSLocEntries);
503 SLocEntryLoaded.resize(LoadedSLocEntryTable.size());
504 CurrentLoadedOffset -= TotalSize;
505 assert(CurrentLoadedOffset >= NextLocalOffset && "Out of source locations");
506 int ID = LoadedSLocEntryTable.size();
507 return std::make_pair(-ID - 1, CurrentLoadedOffset);
Douglas Gregor2bf1eb02009-04-27 21:28:04 +0000508}
509
Douglas Gregore23ac652011-04-20 00:21:03 +0000510/// \brief As part of recovering from missing or changed content, produce a
511/// fake, non-empty buffer.
512const llvm::MemoryBuffer *SourceManager::getFakeBufferForRecovery() const {
513 if (!FakeBufferForRecovery)
514 FakeBufferForRecovery
515 = llvm::MemoryBuffer::getMemBuffer("<<<INVALID BUFFER>>");
516
517 return FakeBufferForRecovery;
518}
Douglas Gregor7f94b0b2009-04-27 06:38:32 +0000519
Argyrios Kyrtzidisa4c29b62012-02-20 23:58:07 +0000520/// \brief As part of recovering from missing or changed content, produce a
521/// fake content cache.
522const SrcMgr::ContentCache *
523SourceManager::getFakeContentCacheForRecovery() const {
524 if (!FakeContentCacheForRecovery) {
525 FakeContentCacheForRecovery = new ContentCache();
526 FakeContentCacheForRecovery->replaceBuffer(getFakeBufferForRecovery(),
527 /*DoNotFree=*/true);
528 }
529 return FakeContentCacheForRecovery;
530}
531
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000532//===----------------------------------------------------------------------===//
Chandler Carruth3201f382011-07-26 05:17:23 +0000533// Methods to create new FileID's and macro expansions.
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000534//===----------------------------------------------------------------------===//
Reid Spencer5f016e22007-07-11 17:01:13 +0000535
Dan Gohman3f86b782010-08-26 21:27:06 +0000536/// createFileID - Create a new FileID for the specified ContentCache and
Ted Kremenek0d892d82007-10-30 22:57:35 +0000537/// include position. This works regardless of whether the ContentCache
538/// corresponds to a file or some other input source.
Chris Lattner2b2453a2009-01-17 06:22:33 +0000539FileID SourceManager::createFileID(const ContentCache *File,
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000540 SourceLocation IncludePos,
Douglas Gregor7f94b0b2009-04-27 06:38:32 +0000541 SrcMgr::CharacteristicKind FileCharacter,
Douglas Gregorf62d43d2011-07-19 16:10:42 +0000542 int LoadedID, unsigned LoadedOffset) {
543 if (LoadedID < 0) {
544 assert(LoadedID != -1 && "Loading sentinel FileID");
545 unsigned Index = unsigned(-LoadedID) - 2;
546 assert(Index < LoadedSLocEntryTable.size() && "FileID out of range");
547 assert(!SLocEntryLoaded[Index] && "FileID already loaded");
548 LoadedSLocEntryTable[Index] = SLocEntry::get(LoadedOffset,
549 FileInfo::get(IncludePos, File, FileCharacter));
550 SLocEntryLoaded[Index] = true;
551 return FileID::get(LoadedID);
Douglas Gregor7f94b0b2009-04-27 06:38:32 +0000552 }
Douglas Gregorf62d43d2011-07-19 16:10:42 +0000553 LocalSLocEntryTable.push_back(SLocEntry::get(NextLocalOffset,
554 FileInfo::get(IncludePos, File,
555 FileCharacter)));
Ted Kremenekc16c2082009-01-06 01:55:26 +0000556 unsigned FileSize = File->getSize();
Douglas Gregorf62d43d2011-07-19 16:10:42 +0000557 assert(NextLocalOffset + FileSize + 1 > NextLocalOffset &&
558 NextLocalOffset + FileSize + 1 <= CurrentLoadedOffset &&
559 "Ran out of source locations!");
560 // We do a +1 here because we want a SourceLocation that means "the end of the
561 // file", e.g. for the "no newline at the end of the file" diagnostic.
562 NextLocalOffset += FileSize + 1;
Mike Stump1eb44332009-09-09 15:08:12 +0000563
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000564 // Set LastFileIDLookup to the newly created file. The next getFileID call is
565 // almost guaranteed to be from that file.
Douglas Gregorf62d43d2011-07-19 16:10:42 +0000566 FileID FID = FileID::get(LocalSLocEntryTable.size()-1);
Argyrios Kyrtzidisea703f12009-06-23 00:42:06 +0000567 return LastFileIDLookup = FID;
Reid Spencer5f016e22007-07-11 17:01:13 +0000568}
569
Chandler Carruthc8d1ecc2011-07-07 23:56:36 +0000570SourceLocation
Chandler Carruthbf340e42011-07-26 03:03:05 +0000571SourceManager::createMacroArgExpansionLoc(SourceLocation SpellingLoc,
572 SourceLocation ExpansionLoc,
573 unsigned TokLength) {
Chandler Carruth78df8362011-07-26 04:41:47 +0000574 ExpansionInfo Info = ExpansionInfo::createForMacroArg(SpellingLoc,
575 ExpansionLoc);
576 return createExpansionLocImpl(Info, TokLength);
Chandler Carruthc8d1ecc2011-07-07 23:56:36 +0000577}
578
579SourceLocation
Chandler Carruthbf340e42011-07-26 03:03:05 +0000580SourceManager::createExpansionLoc(SourceLocation SpellingLoc,
581 SourceLocation ExpansionLocStart,
582 SourceLocation ExpansionLocEnd,
583 unsigned TokLength,
584 int LoadedID,
585 unsigned LoadedOffset) {
Chandler Carruth78df8362011-07-26 04:41:47 +0000586 ExpansionInfo Info = ExpansionInfo::create(SpellingLoc, ExpansionLocStart,
587 ExpansionLocEnd);
588 return createExpansionLocImpl(Info, TokLength, LoadedID, LoadedOffset);
Chandler Carruthbf340e42011-07-26 03:03:05 +0000589}
590
591SourceLocation
Chandler Carruth78df8362011-07-26 04:41:47 +0000592SourceManager::createExpansionLocImpl(const ExpansionInfo &Info,
Chandler Carruthbf340e42011-07-26 03:03:05 +0000593 unsigned TokLength,
594 int LoadedID,
595 unsigned LoadedOffset) {
Douglas Gregorf62d43d2011-07-19 16:10:42 +0000596 if (LoadedID < 0) {
597 assert(LoadedID != -1 && "Loading sentinel FileID");
598 unsigned Index = unsigned(-LoadedID) - 2;
599 assert(Index < LoadedSLocEntryTable.size() && "FileID out of range");
600 assert(!SLocEntryLoaded[Index] && "FileID already loaded");
Chandler Carruth78df8362011-07-26 04:41:47 +0000601 LoadedSLocEntryTable[Index] = SLocEntry::get(LoadedOffset, Info);
Douglas Gregorf62d43d2011-07-19 16:10:42 +0000602 SLocEntryLoaded[Index] = true;
603 return SourceLocation::getMacroLoc(LoadedOffset);
Douglas Gregor7f94b0b2009-04-27 06:38:32 +0000604 }
Chandler Carruth78df8362011-07-26 04:41:47 +0000605 LocalSLocEntryTable.push_back(SLocEntry::get(NextLocalOffset, Info));
Douglas Gregorf62d43d2011-07-19 16:10:42 +0000606 assert(NextLocalOffset + TokLength + 1 > NextLocalOffset &&
607 NextLocalOffset + TokLength + 1 <= CurrentLoadedOffset &&
608 "Ran out of source locations!");
609 // See createFileID for that +1.
610 NextLocalOffset += TokLength + 1;
611 return SourceLocation::getMacroLoc(NextLocalOffset - (TokLength + 1));
Reid Spencer5f016e22007-07-11 17:01:13 +0000612}
613
Douglas Gregor36c35ba2010-03-16 00:35:39 +0000614const llvm::MemoryBuffer *
Douglas Gregor50f6af72010-03-16 05:20:39 +0000615SourceManager::getMemoryBufferForFile(const FileEntry *File,
616 bool *Invalid) {
Douglas Gregor29684422009-12-02 06:49:09 +0000617 const SrcMgr::ContentCache *IR = getOrCreateContentCache(File);
Douglas Gregoraea67db2010-03-15 22:54:52 +0000618 assert(IR && "getOrCreateContentCache() cannot return NULL");
Chris Lattnere127a0d2010-04-20 20:35:58 +0000619 return IR->getBuffer(Diag, *this, SourceLocation(), Invalid);
Douglas Gregor29684422009-12-02 06:49:09 +0000620}
621
Dan Gohman0d06e992010-10-26 20:47:28 +0000622void SourceManager::overrideFileContents(const FileEntry *SourceFile,
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000623 const llvm::MemoryBuffer *Buffer,
624 bool DoNotFree) {
Douglas Gregor29684422009-12-02 06:49:09 +0000625 const SrcMgr::ContentCache *IR = getOrCreateContentCache(SourceFile);
Dan Gohman0d06e992010-10-26 20:47:28 +0000626 assert(IR && "getOrCreateContentCache() cannot return NULL");
Douglas Gregor29684422009-12-02 06:49:09 +0000627
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000628 const_cast<SrcMgr::ContentCache *>(IR)->replaceBuffer(Buffer, DoNotFree);
Douglas Gregora081da52011-11-16 20:05:18 +0000629 const_cast<SrcMgr::ContentCache *>(IR)->BufferOverridden = true;
Argyrios Kyrtzidisd54dff02012-05-03 21:50:39 +0000630
631 getOverriddenFilesInfo().OverriddenFilesWithBuffer.insert(SourceFile);
Douglas Gregor29684422009-12-02 06:49:09 +0000632}
633
Argyrios Kyrtzidisb1c86492011-03-05 01:03:53 +0000634void SourceManager::overrideFileContents(const FileEntry *SourceFile,
635 const FileEntry *NewFile) {
636 assert(SourceFile->getSize() == NewFile->getSize() &&
637 "Different sizes, use the FileManager to create a virtual file with "
638 "the correct size");
639 assert(FileInfos.count(SourceFile) == 0 &&
640 "This function should be called at the initialization stage, before "
641 "any parsing occurs.");
Argyrios Kyrtzidisd54dff02012-05-03 21:50:39 +0000642 getOverriddenFilesInfo().OverriddenFiles[SourceFile] = NewFile;
643}
644
645void SourceManager::disableFileContentsOverride(const FileEntry *File) {
646 if (!isFileOverridden(File))
647 return;
648
649 const SrcMgr::ContentCache *IR = getOrCreateContentCache(File);
650 const_cast<SrcMgr::ContentCache *>(IR)->replaceBuffer(0);
651 const_cast<SrcMgr::ContentCache *>(IR)->ContentsEntry = IR->OrigEntry;
652
653 assert(OverriddenFilesInfo);
654 OverriddenFilesInfo->OverriddenFiles.erase(File);
655 OverriddenFilesInfo->OverriddenFilesWithBuffer.erase(File);
Argyrios Kyrtzidisb1c86492011-03-05 01:03:53 +0000656}
657
Chris Lattner5f9e2722011-07-23 10:55:15 +0000658StringRef SourceManager::getBufferData(FileID FID, bool *Invalid) const {
Douglas Gregoraae58b02010-03-16 20:01:30 +0000659 bool MyInvalid = false;
Douglas Gregorf62d43d2011-07-19 16:10:42 +0000660 const SLocEntry &SLoc = getSLocEntry(FID, &MyInvalid);
Douglas Gregore23ac652011-04-20 00:21:03 +0000661 if (!SLoc.isFile() || MyInvalid) {
Douglas Gregor3de84242011-01-31 22:42:36 +0000662 if (Invalid)
663 *Invalid = true;
664 return "<<<<<INVALID SOURCE LOCATION>>>>>";
665 }
666
667 const llvm::MemoryBuffer *Buf
668 = SLoc.getFile().getContentCache()->getBuffer(Diag, *this, SourceLocation(),
669 &MyInvalid);
Douglas Gregorf715ca12010-03-16 00:06:06 +0000670 if (Invalid)
Douglas Gregoraae58b02010-03-16 20:01:30 +0000671 *Invalid = MyInvalid;
672
673 if (MyInvalid)
Douglas Gregor3de84242011-01-31 22:42:36 +0000674 return "<<<<<INVALID SOURCE LOCATION>>>>>";
Douglas Gregoraae58b02010-03-16 20:01:30 +0000675
Benjamin Kramerf6ac97b2010-03-16 14:14:31 +0000676 return Buf->getBuffer();
Douglas Gregoraea67db2010-03-15 22:54:52 +0000677}
Chris Lattner2b2453a2009-01-17 06:22:33 +0000678
Chris Lattner23b5dc62009-02-04 00:40:31 +0000679//===----------------------------------------------------------------------===//
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000680// SourceLocation manipulation methods.
Chris Lattner23b5dc62009-02-04 00:40:31 +0000681//===----------------------------------------------------------------------===//
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000682
Douglas Gregorf62d43d2011-07-19 16:10:42 +0000683/// \brief Return the FileID for a SourceLocation.
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000684///
Douglas Gregorf62d43d2011-07-19 16:10:42 +0000685/// This is the cache-miss path of getFileID. Not as hot as that function, but
686/// still very important. It is responsible for finding the entry in the
687/// SLocEntry tables that contains the specified location.
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000688FileID SourceManager::getFileIDSlow(unsigned SLocOffset) const {
Douglas Gregore23ac652011-04-20 00:21:03 +0000689 if (!SLocOffset)
690 return FileID::get(0);
Mike Stump1eb44332009-09-09 15:08:12 +0000691
Douglas Gregorf62d43d2011-07-19 16:10:42 +0000692 // Now it is time to search for the correct file. See where the SLocOffset
693 // sits in the global view and consult local or loaded buffers for it.
694 if (SLocOffset < NextLocalOffset)
695 return getFileIDLocal(SLocOffset);
696 return getFileIDLoaded(SLocOffset);
697}
698
699/// \brief Return the FileID for a SourceLocation with a low offset.
700///
701/// This function knows that the SourceLocation is in a local buffer, not a
702/// loaded one.
703FileID SourceManager::getFileIDLocal(unsigned SLocOffset) const {
704 assert(SLocOffset < NextLocalOffset && "Bad function choice");
705
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000706 // After the first and second level caches, I see two common sorts of
Chandler Carruth3201f382011-07-26 05:17:23 +0000707 // behavior: 1) a lot of searched FileID's are "near" the cached file
708 // location or are "near" the cached expansion location. 2) others are just
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000709 // completely random and may be a very long way away.
710 //
711 // To handle this, we do a linear search for up to 8 steps to catch #1 quickly
712 // then we fall back to a less cache efficient, but more scalable, binary
713 // search to find the location.
Mike Stump1eb44332009-09-09 15:08:12 +0000714
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000715 // See if this is near the file point - worst case we start scanning from the
716 // most newly created FileID.
717 std::vector<SrcMgr::SLocEntry>::const_iterator I;
Mike Stump1eb44332009-09-09 15:08:12 +0000718
Douglas Gregorf62d43d2011-07-19 16:10:42 +0000719 if (LastFileIDLookup.ID < 0 ||
720 LocalSLocEntryTable[LastFileIDLookup.ID].getOffset() < SLocOffset) {
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000721 // Neither loc prunes our search.
Douglas Gregorf62d43d2011-07-19 16:10:42 +0000722 I = LocalSLocEntryTable.end();
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000723 } else {
724 // Perhaps it is near the file point.
Douglas Gregorf62d43d2011-07-19 16:10:42 +0000725 I = LocalSLocEntryTable.begin()+LastFileIDLookup.ID;
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000726 }
727
728 // Find the FileID that contains this. "I" is an iterator that points to a
729 // FileID whose offset is known to be larger than SLocOffset.
730 unsigned NumProbes = 0;
731 while (1) {
732 --I;
733 if (I->getOffset() <= SLocOffset) {
Douglas Gregorf62d43d2011-07-19 16:10:42 +0000734 FileID Res = FileID::get(int(I - LocalSLocEntryTable.begin()));
Douglas Gregor7f94b0b2009-04-27 06:38:32 +0000735
Chandler Carruth3201f382011-07-26 05:17:23 +0000736 // If this isn't an expansion, remember it. We have good locality across
737 // FileID lookups.
Chandler Carruth17287622011-07-26 04:56:51 +0000738 if (!I->isExpansion())
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000739 LastFileIDLookup = Res;
740 NumLinearScans += NumProbes+1;
741 return Res;
742 }
743 if (++NumProbes == 8)
744 break;
745 }
Mike Stump1eb44332009-09-09 15:08:12 +0000746
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000747 // Convert "I" back into an index. We know that it is an entry whose index is
748 // larger than the offset we are looking for.
Douglas Gregorf62d43d2011-07-19 16:10:42 +0000749 unsigned GreaterIndex = I - LocalSLocEntryTable.begin();
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000750 // LessIndex - This is the lower bound of the range that we're searching.
751 // We know that the offset corresponding to the FileID is is less than
752 // SLocOffset.
753 unsigned LessIndex = 0;
754 NumProbes = 0;
755 while (1) {
Douglas Gregore23ac652011-04-20 00:21:03 +0000756 bool Invalid = false;
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000757 unsigned MiddleIndex = (GreaterIndex-LessIndex)/2+LessIndex;
Douglas Gregorf62d43d2011-07-19 16:10:42 +0000758 unsigned MidOffset = getLocalSLocEntry(MiddleIndex, &Invalid).getOffset();
Douglas Gregore23ac652011-04-20 00:21:03 +0000759 if (Invalid)
760 return FileID::get(0);
761
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000762 ++NumProbes;
Mike Stump1eb44332009-09-09 15:08:12 +0000763
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000764 // If the offset of the midpoint is too large, chop the high side of the
765 // range to the midpoint.
766 if (MidOffset > SLocOffset) {
767 GreaterIndex = MiddleIndex;
768 continue;
769 }
Mike Stump1eb44332009-09-09 15:08:12 +0000770
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000771 // If the middle index contains the value, succeed and return.
Douglas Gregorf62d43d2011-07-19 16:10:42 +0000772 // FIXME: This could be made faster by using a function that's aware of
773 // being in the local area.
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000774 if (isOffsetInFileID(FileID::get(MiddleIndex), SLocOffset)) {
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000775 FileID Res = FileID::get(MiddleIndex);
776
Chandler Carruth17287622011-07-26 04:56:51 +0000777 // If this isn't a macro expansion, remember it. We have good locality
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000778 // across FileID lookups.
Chandler Carruth17287622011-07-26 04:56:51 +0000779 if (!LocalSLocEntryTable[MiddleIndex].isExpansion())
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000780 LastFileIDLookup = Res;
781 NumBinaryProbes += NumProbes;
782 return Res;
783 }
Mike Stump1eb44332009-09-09 15:08:12 +0000784
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000785 // Otherwise, move the low-side up to the middle index.
786 LessIndex = MiddleIndex;
787 }
788}
789
Douglas Gregorf62d43d2011-07-19 16:10:42 +0000790/// \brief Return the FileID for a SourceLocation with a high offset.
791///
792/// This function knows that the SourceLocation is in a loaded buffer, not a
793/// local one.
794FileID SourceManager::getFileIDLoaded(unsigned SLocOffset) const {
Argyrios Kyrtzidisc3b45752011-10-03 23:43:01 +0000795 // Sanity checking, otherwise a bug may lead to hanging in release build.
Argyrios Kyrtzidis82ccbe72011-10-25 00:29:44 +0000796 if (SLocOffset < CurrentLoadedOffset) {
797 assert(0 && "Invalid SLocOffset or bad function choice");
Argyrios Kyrtzidisc3b45752011-10-03 23:43:01 +0000798 return FileID();
Argyrios Kyrtzidis82ccbe72011-10-25 00:29:44 +0000799 }
Argyrios Kyrtzidisc3b45752011-10-03 23:43:01 +0000800
Douglas Gregorf62d43d2011-07-19 16:10:42 +0000801 // Essentially the same as the local case, but the loaded array is sorted
802 // in the other direction.
803
804 // First do a linear scan from the last lookup position, if possible.
805 unsigned I;
806 int LastID = LastFileIDLookup.ID;
807 if (LastID >= 0 || getLoadedSLocEntryByID(LastID).getOffset() < SLocOffset)
808 I = 0;
809 else
810 I = (-LastID - 2) + 1;
811
812 unsigned NumProbes;
813 for (NumProbes = 0; NumProbes < 8; ++NumProbes, ++I) {
814 // Make sure the entry is loaded!
815 const SrcMgr::SLocEntry &E = getLoadedSLocEntry(I);
816 if (E.getOffset() <= SLocOffset) {
817 FileID Res = FileID::get(-int(I) - 2);
818
Chandler Carruth17287622011-07-26 04:56:51 +0000819 if (!E.isExpansion())
Douglas Gregorf62d43d2011-07-19 16:10:42 +0000820 LastFileIDLookup = Res;
821 NumLinearScans += NumProbes + 1;
822 return Res;
823 }
824 }
825
826 // Linear scan failed. Do the binary search. Note the reverse sorting of the
827 // table: GreaterIndex is the one where the offset is greater, which is
828 // actually a lower index!
829 unsigned GreaterIndex = I;
830 unsigned LessIndex = LoadedSLocEntryTable.size();
831 NumProbes = 0;
832 while (1) {
833 ++NumProbes;
834 unsigned MiddleIndex = (LessIndex - GreaterIndex) / 2 + GreaterIndex;
835 const SrcMgr::SLocEntry &E = getLoadedSLocEntry(MiddleIndex);
836
837 ++NumProbes;
838
839 if (E.getOffset() > SLocOffset) {
840 GreaterIndex = MiddleIndex;
841 continue;
842 }
843
844 if (isOffsetInFileID(FileID::get(-int(MiddleIndex) - 2), SLocOffset)) {
845 FileID Res = FileID::get(-int(MiddleIndex) - 2);
Chandler Carruth17287622011-07-26 04:56:51 +0000846 if (!E.isExpansion())
Douglas Gregorf62d43d2011-07-19 16:10:42 +0000847 LastFileIDLookup = Res;
848 NumBinaryProbes += NumProbes;
849 return Res;
850 }
851
852 LessIndex = MiddleIndex;
853 }
854}
855
Chris Lattneraddb7972009-01-26 20:04:19 +0000856SourceLocation SourceManager::
Chandler Carruthf84ef952011-07-25 20:52:26 +0000857getExpansionLocSlowCase(SourceLocation Loc) const {
Chris Lattneraddb7972009-01-26 20:04:19 +0000858 do {
Chris Lattnera5c6c582010-02-12 19:31:35 +0000859 // Note: If Loc indicates an offset into a token that came from a macro
860 // expansion (e.g. the 5th character of the token) we do not want to add
Chandler Carruth17287622011-07-26 04:56:51 +0000861 // this offset when going to the expansion location. The expansion
Chris Lattnera5c6c582010-02-12 19:31:35 +0000862 // location is the macro invocation, which the offset has nothing to do
863 // with. This is unlike when we get the spelling loc, because the offset
864 // directly correspond to the token whose spelling we're inspecting.
Chandler Carruth17287622011-07-26 04:56:51 +0000865 Loc = getSLocEntry(getFileID(Loc)).getExpansion().getExpansionLocStart();
Chris Lattneraddb7972009-01-26 20:04:19 +0000866 } while (!Loc.isFileID());
867
868 return Loc;
869}
870
871SourceLocation SourceManager::getSpellingLocSlowCase(SourceLocation Loc) const {
872 do {
873 std::pair<FileID, unsigned> LocInfo = getDecomposedLoc(Loc);
Chandler Carruth17287622011-07-26 04:56:51 +0000874 Loc = getSLocEntry(LocInfo.first).getExpansion().getSpellingLoc();
Argyrios Kyrtzidisa64ccef2011-09-19 20:40:19 +0000875 Loc = Loc.getLocWithOffset(LocInfo.second);
Chris Lattneraddb7972009-01-26 20:04:19 +0000876 } while (!Loc.isFileID());
877 return Loc;
878}
879
Argyrios Kyrtzidis796dbfb2011-10-12 07:07:40 +0000880SourceLocation SourceManager::getFileLocSlowCase(SourceLocation Loc) const {
881 do {
882 if (isMacroArgExpansion(Loc))
883 Loc = getImmediateSpellingLoc(Loc);
884 else
885 Loc = getImmediateExpansionRange(Loc).first;
886 } while (!Loc.isFileID());
887 return Loc;
888}
889
Chris Lattneraddb7972009-01-26 20:04:19 +0000890
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000891std::pair<FileID, unsigned>
Chandler Carruthe7b2b6e2011-07-25 20:52:32 +0000892SourceManager::getDecomposedExpansionLocSlowCase(
Argyrios Kyrtzidis8b86ef02011-07-07 03:40:27 +0000893 const SrcMgr::SLocEntry *E) const {
Chandler Carruth3201f382011-07-26 05:17:23 +0000894 // If this is an expansion record, walk through all the expansion points.
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000895 FileID FID;
896 SourceLocation Loc;
Argyrios Kyrtzidis8b86ef02011-07-07 03:40:27 +0000897 unsigned Offset;
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000898 do {
Chandler Carruth17287622011-07-26 04:56:51 +0000899 Loc = E->getExpansion().getExpansionLocStart();
Mike Stump1eb44332009-09-09 15:08:12 +0000900
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000901 FID = getFileID(Loc);
902 E = &getSLocEntry(FID);
Argyrios Kyrtzidis8b86ef02011-07-07 03:40:27 +0000903 Offset = Loc.getOffset()-E->getOffset();
Chris Lattnerbcd1a1b2009-01-26 19:41:58 +0000904 } while (!Loc.isFileID());
Mike Stump1eb44332009-09-09 15:08:12 +0000905
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000906 return std::make_pair(FID, Offset);
907}
908
909std::pair<FileID, unsigned>
910SourceManager::getDecomposedSpellingLocSlowCase(const SrcMgr::SLocEntry *E,
911 unsigned Offset) const {
Chandler Carruth3201f382011-07-26 05:17:23 +0000912 // If this is an expansion record, walk through all the expansion points.
Chris Lattnerbcd1a1b2009-01-26 19:41:58 +0000913 FileID FID;
914 SourceLocation Loc;
915 do {
Chandler Carruth17287622011-07-26 04:56:51 +0000916 Loc = E->getExpansion().getSpellingLoc();
Argyrios Kyrtzidisa64ccef2011-09-19 20:40:19 +0000917 Loc = Loc.getLocWithOffset(Offset);
Mike Stump1eb44332009-09-09 15:08:12 +0000918
Chris Lattnerbcd1a1b2009-01-26 19:41:58 +0000919 FID = getFileID(Loc);
920 E = &getSLocEntry(FID);
Argyrios Kyrtzidisb6c465e2011-08-23 21:02:41 +0000921 Offset = Loc.getOffset()-E->getOffset();
Chris Lattnerbcd1a1b2009-01-26 19:41:58 +0000922 } while (!Loc.isFileID());
Mike Stump1eb44332009-09-09 15:08:12 +0000923
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000924 return std::make_pair(FID, Offset);
925}
926
Chris Lattner387616e2009-02-17 08:04:48 +0000927/// getImmediateSpellingLoc - Given a SourceLocation object, return the
928/// spelling location referenced by the ID. This is the first level down
929/// towards the place where the characters that make up the lexed token can be
930/// found. This should not generally be used by clients.
931SourceLocation SourceManager::getImmediateSpellingLoc(SourceLocation Loc) const{
932 if (Loc.isFileID()) return Loc;
933 std::pair<FileID, unsigned> LocInfo = getDecomposedLoc(Loc);
Chandler Carruth17287622011-07-26 04:56:51 +0000934 Loc = getSLocEntry(LocInfo.first).getExpansion().getSpellingLoc();
Argyrios Kyrtzidisa64ccef2011-09-19 20:40:19 +0000935 return Loc.getLocWithOffset(LocInfo.second);
Chris Lattner387616e2009-02-17 08:04:48 +0000936}
937
938
Chandler Carruth3201f382011-07-26 05:17:23 +0000939/// getImmediateExpansionRange - Loc is required to be an expansion location.
940/// Return the start/end of the expansion information.
Chris Lattnere7fb4842009-02-15 20:52:18 +0000941std::pair<SourceLocation,SourceLocation>
Chandler Carruth999f7392011-07-25 20:52:21 +0000942SourceManager::getImmediateExpansionRange(SourceLocation Loc) const {
Chandler Carruth3201f382011-07-26 05:17:23 +0000943 assert(Loc.isMacroID() && "Not a macro expansion loc!");
Chandler Carruth17287622011-07-26 04:56:51 +0000944 const ExpansionInfo &Expansion = getSLocEntry(getFileID(Loc)).getExpansion();
Chandler Carruth78df8362011-07-26 04:41:47 +0000945 return Expansion.getExpansionLocRange();
Chris Lattnere7fb4842009-02-15 20:52:18 +0000946}
947
Chandler Carruthedc3dcc2011-07-25 16:56:02 +0000948/// getExpansionRange - Given a SourceLocation object, return the range of
949/// tokens covered by the expansion in the ultimate file.
Chris Lattner66781332009-02-15 21:26:50 +0000950std::pair<SourceLocation,SourceLocation>
Chandler Carruthedc3dcc2011-07-25 16:56:02 +0000951SourceManager::getExpansionRange(SourceLocation Loc) const {
Chris Lattner66781332009-02-15 21:26:50 +0000952 if (Loc.isFileID()) return std::make_pair(Loc, Loc);
Mike Stump1eb44332009-09-09 15:08:12 +0000953
Chris Lattner66781332009-02-15 21:26:50 +0000954 std::pair<SourceLocation,SourceLocation> Res =
Chandler Carruth999f7392011-07-25 20:52:21 +0000955 getImmediateExpansionRange(Loc);
Mike Stump1eb44332009-09-09 15:08:12 +0000956
Chandler Carruth3201f382011-07-26 05:17:23 +0000957 // Fully resolve the start and end locations to their ultimate expansion
Chris Lattner66781332009-02-15 21:26:50 +0000958 // points.
959 while (!Res.first.isFileID())
Chandler Carruth999f7392011-07-25 20:52:21 +0000960 Res.first = getImmediateExpansionRange(Res.first).first;
Chris Lattner66781332009-02-15 21:26:50 +0000961 while (!Res.second.isFileID())
Chandler Carruth999f7392011-07-25 20:52:21 +0000962 Res.second = getImmediateExpansionRange(Res.second).second;
Chris Lattner66781332009-02-15 21:26:50 +0000963 return Res;
964}
965
Chandler Carruth96d35892011-07-26 03:03:00 +0000966bool SourceManager::isMacroArgExpansion(SourceLocation Loc) const {
Chandler Carruthc8d1ecc2011-07-07 23:56:36 +0000967 if (!Loc.isMacroID()) return false;
968
969 FileID FID = getFileID(Loc);
970 const SrcMgr::SLocEntry *E = &getSLocEntry(FID);
Chandler Carruth17287622011-07-26 04:56:51 +0000971 const SrcMgr::ExpansionInfo &Expansion = E->getExpansion();
Chandler Carruth78df8362011-07-26 04:41:47 +0000972 return Expansion.isMacroArgExpansion();
Chandler Carruthc8d1ecc2011-07-07 23:56:36 +0000973}
Chris Lattnere7fb4842009-02-15 20:52:18 +0000974
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000975
976//===----------------------------------------------------------------------===//
977// Queries about the code at a SourceLocation.
978//===----------------------------------------------------------------------===//
Reid Spencer5f016e22007-07-11 17:01:13 +0000979
980/// getCharacterData - Return a pointer to the start of the specified location
981/// in the appropriate MemoryBuffer.
Douglas Gregor50f6af72010-03-16 05:20:39 +0000982const char *SourceManager::getCharacterData(SourceLocation SL,
983 bool *Invalid) const {
Reid Spencer5f016e22007-07-11 17:01:13 +0000984 // Note that this is a hot function in the getSpelling() path, which is
985 // heavily used by -E mode.
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000986 std::pair<FileID, unsigned> LocInfo = getDecomposedSpellingLoc(SL);
Mike Stump1eb44332009-09-09 15:08:12 +0000987
Ted Kremenekc16c2082009-01-06 01:55:26 +0000988 // Note that calling 'getBuffer()' may lazily page in a source file.
Douglas Gregor50f6af72010-03-16 05:20:39 +0000989 bool CharDataInvalid = false;
Douglas Gregore23ac652011-04-20 00:21:03 +0000990 const SLocEntry &Entry = getSLocEntry(LocInfo.first, &CharDataInvalid);
991 if (CharDataInvalid || !Entry.isFile()) {
992 if (Invalid)
993 *Invalid = true;
994
995 return "<<<<INVALID BUFFER>>>>";
996 }
Douglas Gregor50f6af72010-03-16 05:20:39 +0000997 const llvm::MemoryBuffer *Buffer
Douglas Gregore23ac652011-04-20 00:21:03 +0000998 = Entry.getFile().getContentCache()
999 ->getBuffer(Diag, *this, SourceLocation(), &CharDataInvalid);
Douglas Gregor50f6af72010-03-16 05:20:39 +00001000 if (Invalid)
1001 *Invalid = CharDataInvalid;
1002 return Buffer->getBufferStart() + (CharDataInvalid? 0 : LocInfo.second);
Reid Spencer5f016e22007-07-11 17:01:13 +00001003}
1004
Reid Spencer5f016e22007-07-11 17:01:13 +00001005
Chris Lattner9dc1f532007-07-20 16:37:10 +00001006/// getColumnNumber - Return the column # for the specified file position.
Chris Lattner7da5aea2009-02-04 00:55:58 +00001007/// this is significantly cheaper to compute than the line number.
Douglas Gregor50f6af72010-03-16 05:20:39 +00001008unsigned SourceManager::getColumnNumber(FileID FID, unsigned FilePos,
1009 bool *Invalid) const {
1010 bool MyInvalid = false;
Argyrios Kyrtzidisd5752542011-12-10 00:30:38 +00001011 const llvm::MemoryBuffer *MemBuf = getBuffer(FID, &MyInvalid);
Douglas Gregor50f6af72010-03-16 05:20:39 +00001012 if (Invalid)
1013 *Invalid = MyInvalid;
1014
1015 if (MyInvalid)
1016 return 1;
Mike Stump1eb44332009-09-09 15:08:12 +00001017
Dylan Noblesmith098eaff2011-12-19 08:51:05 +00001018 if (FilePos >= MemBuf->getBufferSize()) {
Argyrios Kyrtzidisd5752542011-12-10 00:30:38 +00001019 if (Invalid)
1020 *Invalid = MyInvalid;
1021 return 1;
1022 }
1023
Dylan Noblesmith098eaff2011-12-19 08:51:05 +00001024 const char *Buf = MemBuf->getBufferStart();
Reid Spencer5f016e22007-07-11 17:01:13 +00001025 unsigned LineStart = FilePos;
1026 while (LineStart && Buf[LineStart-1] != '\n' && Buf[LineStart-1] != '\r')
1027 --LineStart;
1028 return FilePos-LineStart+1;
1029}
1030
Zhanyong Wan1f24e112010-10-05 17:56:33 +00001031// isInvalid - Return the result of calling loc.isInvalid(), and
1032// if Invalid is not null, set its value to same.
1033static bool isInvalid(SourceLocation Loc, bool *Invalid) {
1034 bool MyInvalid = Loc.isInvalid();
1035 if (Invalid)
1036 *Invalid = MyInvalid;
1037 return MyInvalid;
1038}
1039
Douglas Gregor50f6af72010-03-16 05:20:39 +00001040unsigned SourceManager::getSpellingColumnNumber(SourceLocation Loc,
1041 bool *Invalid) const {
Zhanyong Wan1f24e112010-10-05 17:56:33 +00001042 if (isInvalid(Loc, Invalid)) return 0;
Chris Lattner7da5aea2009-02-04 00:55:58 +00001043 std::pair<FileID, unsigned> LocInfo = getDecomposedSpellingLoc(Loc);
Douglas Gregor50f6af72010-03-16 05:20:39 +00001044 return getColumnNumber(LocInfo.first, LocInfo.second, Invalid);
Chris Lattner7da5aea2009-02-04 00:55:58 +00001045}
1046
Chandler Carrutha77c0312011-07-25 20:57:57 +00001047unsigned SourceManager::getExpansionColumnNumber(SourceLocation Loc,
1048 bool *Invalid) const {
Zhanyong Wan1f24e112010-10-05 17:56:33 +00001049 if (isInvalid(Loc, Invalid)) return 0;
Chandler Carruthe7b2b6e2011-07-25 20:52:32 +00001050 std::pair<FileID, unsigned> LocInfo = getDecomposedExpansionLoc(Loc);
Douglas Gregor50f6af72010-03-16 05:20:39 +00001051 return getColumnNumber(LocInfo.first, LocInfo.second, Invalid);
Chris Lattner7da5aea2009-02-04 00:55:58 +00001052}
1053
Chandler Carruth5ef04ee2011-02-23 00:47:48 +00001054unsigned SourceManager::getPresumedColumnNumber(SourceLocation Loc,
1055 bool *Invalid) const {
1056 if (isInvalid(Loc, Invalid)) return 0;
1057 return getPresumedLoc(Loc).getColumn();
1058}
1059
Benjamin Kramerd2953ce2012-04-06 20:49:55 +00001060#ifdef __SSE2__
1061#include <emmintrin.h>
1062#endif
1063
Chandler Carruth14bd9652010-10-23 08:44:57 +00001064static LLVM_ATTRIBUTE_NOINLINE void
David Blaikied6471f72011-09-25 23:23:43 +00001065ComputeLineNumbers(DiagnosticsEngine &Diag, ContentCache *FI,
Chris Lattnere127a0d2010-04-20 20:35:58 +00001066 llvm::BumpPtrAllocator &Alloc,
1067 const SourceManager &SM, bool &Invalid);
David Blaikied6471f72011-09-25 23:23:43 +00001068static void ComputeLineNumbers(DiagnosticsEngine &Diag, ContentCache *FI,
Chris Lattnere127a0d2010-04-20 20:35:58 +00001069 llvm::BumpPtrAllocator &Alloc,
1070 const SourceManager &SM, bool &Invalid) {
Ted Kremenekc16c2082009-01-06 01:55:26 +00001071 // Note that calling 'getBuffer()' may lazily page in the file.
Chris Lattnere127a0d2010-04-20 20:35:58 +00001072 const MemoryBuffer *Buffer = FI->getBuffer(Diag, SM, SourceLocation(),
1073 &Invalid);
Douglas Gregor50f6af72010-03-16 05:20:39 +00001074 if (Invalid)
1075 return;
Mike Stump1eb44332009-09-09 15:08:12 +00001076
Chris Lattner5e36a7a2007-07-24 05:57:19 +00001077 // Find the file offsets of all of the *physical* source lines. This does
1078 // not look at trigraphs, escaped newlines, or anything else tricky.
Chris Lattner5f9e2722011-07-23 10:55:15 +00001079 SmallVector<unsigned, 256> LineOffsets;
Mike Stump1eb44332009-09-09 15:08:12 +00001080
Chris Lattner5e36a7a2007-07-24 05:57:19 +00001081 // Line #1 starts at char 0.
1082 LineOffsets.push_back(0);
Mike Stump1eb44332009-09-09 15:08:12 +00001083
Chris Lattner5e36a7a2007-07-24 05:57:19 +00001084 const unsigned char *Buf = (const unsigned char *)Buffer->getBufferStart();
1085 const unsigned char *End = (const unsigned char *)Buffer->getBufferEnd();
1086 unsigned Offs = 0;
1087 while (1) {
1088 // Skip over the contents of the line.
Chris Lattner5e36a7a2007-07-24 05:57:19 +00001089 const unsigned char *NextBuf = (const unsigned char *)Buf;
Benjamin Kramerd2953ce2012-04-06 20:49:55 +00001090
1091#ifdef __SSE2__
1092 // Try to skip to the next newline using SSE instructions. This is very
1093 // performance sensitive for programs with lots of diagnostics and in -E
1094 // mode.
1095 __m128i CRs = _mm_set1_epi8('\r');
1096 __m128i LFs = _mm_set1_epi8('\n');
1097
1098 // First fix up the alignment to 16 bytes.
1099 while (((uintptr_t)NextBuf & 0xF) != 0) {
1100 if (*NextBuf == '\n' || *NextBuf == '\r' || *NextBuf == '\0')
1101 goto FoundSpecialChar;
1102 ++NextBuf;
1103 }
1104
1105 // Scan 16 byte chunks for '\r' and '\n'. Ignore '\0'.
1106 while (NextBuf+16 <= End) {
1107 __m128i Chunk = *(__m128i*)NextBuf;
1108 __m128i Cmp = _mm_or_si128(_mm_cmpeq_epi8(Chunk, CRs),
1109 _mm_cmpeq_epi8(Chunk, LFs));
1110 unsigned Mask = _mm_movemask_epi8(Cmp);
1111
1112 // If we found a newline, adjust the pointer and jump to the handling code.
1113 if (Mask != 0) {
1114 NextBuf += llvm::CountTrailingZeros_32(Mask);
1115 goto FoundSpecialChar;
1116 }
1117 NextBuf += 16;
1118 }
1119#endif
1120
Chris Lattner5e36a7a2007-07-24 05:57:19 +00001121 while (*NextBuf != '\n' && *NextBuf != '\r' && *NextBuf != '\0')
1122 ++NextBuf;
Benjamin Kramerd2953ce2012-04-06 20:49:55 +00001123
1124#ifdef __SSE2__
1125FoundSpecialChar:
1126#endif
Chris Lattner5e36a7a2007-07-24 05:57:19 +00001127 Offs += NextBuf-Buf;
1128 Buf = NextBuf;
Mike Stump1eb44332009-09-09 15:08:12 +00001129
Chris Lattner5e36a7a2007-07-24 05:57:19 +00001130 if (Buf[0] == '\n' || Buf[0] == '\r') {
1131 // If this is \n\r or \r\n, skip both characters.
1132 if ((Buf[1] == '\n' || Buf[1] == '\r') && Buf[0] != Buf[1])
1133 ++Offs, ++Buf;
1134 ++Offs, ++Buf;
1135 LineOffsets.push_back(Offs);
1136 } else {
1137 // Otherwise, this is a null. If end of file, exit.
1138 if (Buf == End) break;
1139 // Otherwise, skip the null.
1140 ++Offs, ++Buf;
1141 }
1142 }
Mike Stump1eb44332009-09-09 15:08:12 +00001143
Chris Lattner5e36a7a2007-07-24 05:57:19 +00001144 // Copy the offsets into the FileInfo structure.
1145 FI->NumLines = LineOffsets.size();
Chris Lattner0d0bf8c2009-02-03 07:30:45 +00001146 FI->SourceLineCache = Alloc.Allocate<unsigned>(LineOffsets.size());
Chris Lattner5e36a7a2007-07-24 05:57:19 +00001147 std::copy(LineOffsets.begin(), LineOffsets.end(), FI->SourceLineCache);
1148}
Reid Spencer5f016e22007-07-11 17:01:13 +00001149
Chris Lattnerdf7c17a2009-01-16 07:00:02 +00001150/// getLineNumber - Given a SourceLocation, return the spelling line number
Reid Spencer5f016e22007-07-11 17:01:13 +00001151/// for the position indicated. This requires building and caching a table of
1152/// line offsets for the MemoryBuffer, so this is not cheap: use only when
1153/// about to emit a diagnostic.
Douglas Gregor50f6af72010-03-16 05:20:39 +00001154unsigned SourceManager::getLineNumber(FileID FID, unsigned FilePos,
1155 bool *Invalid) const {
Argyrios Kyrtzidis5adc0512011-05-17 22:09:53 +00001156 if (FID.isInvalid()) {
1157 if (Invalid)
1158 *Invalid = true;
1159 return 1;
1160 }
1161
Chris Lattner2b2453a2009-01-17 06:22:33 +00001162 ContentCache *Content;
Chris Lattner30fc9332009-02-04 01:06:56 +00001163 if (LastLineNoFileIDQuery == FID)
Ted Kremenek78d85f52007-10-30 21:08:08 +00001164 Content = LastLineNoContentCache;
Douglas Gregore23ac652011-04-20 00:21:03 +00001165 else {
1166 bool MyInvalid = false;
1167 const SLocEntry &Entry = getSLocEntry(FID, &MyInvalid);
1168 if (MyInvalid || !Entry.isFile()) {
1169 if (Invalid)
1170 *Invalid = true;
1171 return 1;
1172 }
1173
1174 Content = const_cast<ContentCache*>(Entry.getFile().getContentCache());
1175 }
1176
Reid Spencer5f016e22007-07-11 17:01:13 +00001177 // If this is the first use of line information for this buffer, compute the
Chris Lattner5e36a7a2007-07-24 05:57:19 +00001178 /// SourceLineCache for it on demand.
Douglas Gregor50f6af72010-03-16 05:20:39 +00001179 if (Content->SourceLineCache == 0) {
1180 bool MyInvalid = false;
Chris Lattnere127a0d2010-04-20 20:35:58 +00001181 ComputeLineNumbers(Diag, Content, ContentCacheAlloc, *this, MyInvalid);
Douglas Gregor50f6af72010-03-16 05:20:39 +00001182 if (Invalid)
1183 *Invalid = MyInvalid;
1184 if (MyInvalid)
1185 return 1;
1186 } else if (Invalid)
1187 *Invalid = false;
Reid Spencer5f016e22007-07-11 17:01:13 +00001188
1189 // Okay, we know we have a line number table. Do a binary search to find the
1190 // line number that this character position lands on.
Ted Kremenek78d85f52007-10-30 21:08:08 +00001191 unsigned *SourceLineCache = Content->SourceLineCache;
Chris Lattner5e36a7a2007-07-24 05:57:19 +00001192 unsigned *SourceLineCacheStart = SourceLineCache;
Ted Kremenek78d85f52007-10-30 21:08:08 +00001193 unsigned *SourceLineCacheEnd = SourceLineCache + Content->NumLines;
Mike Stump1eb44332009-09-09 15:08:12 +00001194
Chris Lattner30fc9332009-02-04 01:06:56 +00001195 unsigned QueriedFilePos = FilePos+1;
Chris Lattner5e36a7a2007-07-24 05:57:19 +00001196
Daniel Dunbar4106d692009-05-18 17:30:52 +00001197 // FIXME: I would like to be convinced that this code is worth being as
Mike Stump1eb44332009-09-09 15:08:12 +00001198 // complicated as it is, binary search isn't that slow.
Daniel Dunbar4106d692009-05-18 17:30:52 +00001199 //
1200 // If it is worth being optimized, then in my opinion it could be more
1201 // performant, simpler, and more obviously correct by just "galloping" outward
1202 // from the queried file position. In fact, this could be incorporated into a
1203 // generic algorithm such as lower_bound_with_hint.
1204 //
1205 // If someone gives me a test case where this matters, and I will do it! - DWD
1206
Chris Lattner5e36a7a2007-07-24 05:57:19 +00001207 // If the previous query was to the same file, we know both the file pos from
1208 // that query and the line number returned. This allows us to narrow the
1209 // search space from the entire file to something near the match.
Chris Lattner30fc9332009-02-04 01:06:56 +00001210 if (LastLineNoFileIDQuery == FID) {
Chris Lattner5e36a7a2007-07-24 05:57:19 +00001211 if (QueriedFilePos >= LastLineNoFilePos) {
Daniel Dunbar4106d692009-05-18 17:30:52 +00001212 // FIXME: Potential overflow?
Chris Lattner5e36a7a2007-07-24 05:57:19 +00001213 SourceLineCache = SourceLineCache+LastLineNoResult-1;
Mike Stump1eb44332009-09-09 15:08:12 +00001214
Chris Lattner5e36a7a2007-07-24 05:57:19 +00001215 // The query is likely to be nearby the previous one. Here we check to
1216 // see if it is within 5, 10 or 20 lines. It can be far away in cases
1217 // where big comment blocks and vertical whitespace eat up lines but
1218 // contribute no tokens.
1219 if (SourceLineCache+5 < SourceLineCacheEnd) {
1220 if (SourceLineCache[5] > QueriedFilePos)
1221 SourceLineCacheEnd = SourceLineCache+5;
1222 else if (SourceLineCache+10 < SourceLineCacheEnd) {
1223 if (SourceLineCache[10] > QueriedFilePos)
1224 SourceLineCacheEnd = SourceLineCache+10;
1225 else if (SourceLineCache+20 < SourceLineCacheEnd) {
1226 if (SourceLineCache[20] > QueriedFilePos)
1227 SourceLineCacheEnd = SourceLineCache+20;
1228 }
1229 }
1230 }
1231 } else {
Daniel Dunbar4106d692009-05-18 17:30:52 +00001232 if (LastLineNoResult < Content->NumLines)
1233 SourceLineCacheEnd = SourceLineCache+LastLineNoResult+1;
Chris Lattner5e36a7a2007-07-24 05:57:19 +00001234 }
1235 }
Mike Stump1eb44332009-09-09 15:08:12 +00001236
Chris Lattner1cf12bf2007-07-24 06:43:46 +00001237 // If the spread is large, do a "radix" test as our initial guess, based on
1238 // the assumption that lines average to approximately the same length.
1239 // NOTE: This is currently disabled, as it does not appear to be profitable in
1240 // initial measurements.
1241 if (0 && SourceLineCacheEnd-SourceLineCache > 20) {
Ted Kremenek78d85f52007-10-30 21:08:08 +00001242 unsigned FileLen = Content->SourceLineCache[Content->NumLines-1];
Mike Stump1eb44332009-09-09 15:08:12 +00001243
Chris Lattner1cf12bf2007-07-24 06:43:46 +00001244 // Take a stab at guessing where it is.
Ted Kremenek78d85f52007-10-30 21:08:08 +00001245 unsigned ApproxPos = Content->NumLines*QueriedFilePos / FileLen;
Mike Stump1eb44332009-09-09 15:08:12 +00001246
Chris Lattner1cf12bf2007-07-24 06:43:46 +00001247 // Check for -10 and +10 lines.
1248 unsigned LowerBound = std::max(int(ApproxPos-10), 0);
1249 unsigned UpperBound = std::min(ApproxPos+10, FileLen);
1250
1251 // If the computed lower bound is less than the query location, move it in.
1252 if (SourceLineCache < SourceLineCacheStart+LowerBound &&
1253 SourceLineCacheStart[LowerBound] < QueriedFilePos)
1254 SourceLineCache = SourceLineCacheStart+LowerBound;
Mike Stump1eb44332009-09-09 15:08:12 +00001255
Chris Lattner1cf12bf2007-07-24 06:43:46 +00001256 // If the computed upper bound is greater than the query location, move it.
1257 if (SourceLineCacheEnd > SourceLineCacheStart+UpperBound &&
1258 SourceLineCacheStart[UpperBound] >= QueriedFilePos)
1259 SourceLineCacheEnd = SourceLineCacheStart+UpperBound;
1260 }
Mike Stump1eb44332009-09-09 15:08:12 +00001261
Chris Lattner1cf12bf2007-07-24 06:43:46 +00001262 unsigned *Pos
1263 = std::lower_bound(SourceLineCache, SourceLineCacheEnd, QueriedFilePos);
Chris Lattner5e36a7a2007-07-24 05:57:19 +00001264 unsigned LineNo = Pos-SourceLineCacheStart;
Mike Stump1eb44332009-09-09 15:08:12 +00001265
Chris Lattner30fc9332009-02-04 01:06:56 +00001266 LastLineNoFileIDQuery = FID;
Ted Kremenek78d85f52007-10-30 21:08:08 +00001267 LastLineNoContentCache = Content;
Chris Lattner5e36a7a2007-07-24 05:57:19 +00001268 LastLineNoFilePos = QueriedFilePos;
1269 LastLineNoResult = LineNo;
1270 return LineNo;
Reid Spencer5f016e22007-07-11 17:01:13 +00001271}
1272
Chandler Carruth5ef04ee2011-02-23 00:47:48 +00001273unsigned SourceManager::getSpellingLineNumber(SourceLocation Loc,
1274 bool *Invalid) const {
1275 if (isInvalid(Loc, Invalid)) return 0;
1276 std::pair<FileID, unsigned> LocInfo = getDecomposedSpellingLoc(Loc);
1277 return getLineNumber(LocInfo.first, LocInfo.second);
1278}
Chandler Carruth64211622011-07-25 21:09:52 +00001279unsigned SourceManager::getExpansionLineNumber(SourceLocation Loc,
1280 bool *Invalid) const {
Zhanyong Wan1f24e112010-10-05 17:56:33 +00001281 if (isInvalid(Loc, Invalid)) return 0;
Chandler Carruthe7b2b6e2011-07-25 20:52:32 +00001282 std::pair<FileID, unsigned> LocInfo = getDecomposedExpansionLoc(Loc);
Chris Lattner30fc9332009-02-04 01:06:56 +00001283 return getLineNumber(LocInfo.first, LocInfo.second);
1284}
Chandler Carruth5ef04ee2011-02-23 00:47:48 +00001285unsigned SourceManager::getPresumedLineNumber(SourceLocation Loc,
Douglas Gregor50f6af72010-03-16 05:20:39 +00001286 bool *Invalid) const {
Zhanyong Wan1f24e112010-10-05 17:56:33 +00001287 if (isInvalid(Loc, Invalid)) return 0;
Chandler Carruth5ef04ee2011-02-23 00:47:48 +00001288 return getPresumedLoc(Loc).getLine();
Chris Lattner30fc9332009-02-04 01:06:56 +00001289}
1290
Chris Lattner6b306672009-02-04 05:33:01 +00001291/// getFileCharacteristic - return the file characteristic of the specified
Mike Stump1eb44332009-09-09 15:08:12 +00001292/// source location, indicating whether this is a normal file, a system
Chris Lattner6b306672009-02-04 05:33:01 +00001293/// header, or an "implicit extern C" system header.
1294///
1295/// This state can be modified with flags on GNU linemarker directives like:
1296/// # 4 "foo.h" 3
1297/// which changes all source locations in the current file after that to be
1298/// considered to be from a system header.
Mike Stump1eb44332009-09-09 15:08:12 +00001299SrcMgr::CharacteristicKind
Chris Lattner6b306672009-02-04 05:33:01 +00001300SourceManager::getFileCharacteristic(SourceLocation Loc) const {
1301 assert(!Loc.isInvalid() && "Can't get file characteristic of invalid loc!");
Chandler Carruthe7b2b6e2011-07-25 20:52:32 +00001302 std::pair<FileID, unsigned> LocInfo = getDecomposedExpansionLoc(Loc);
Douglas Gregore23ac652011-04-20 00:21:03 +00001303 bool Invalid = false;
1304 const SLocEntry &SEntry = getSLocEntry(LocInfo.first, &Invalid);
1305 if (Invalid || !SEntry.isFile())
1306 return C_User;
1307
1308 const SrcMgr::FileInfo &FI = SEntry.getFile();
Chris Lattner6b306672009-02-04 05:33:01 +00001309
1310 // If there are no #line directives in this file, just return the whole-file
1311 // state.
1312 if (!FI.hasLineDirectives())
1313 return FI.getFileCharacteristic();
Mike Stump1eb44332009-09-09 15:08:12 +00001314
Chris Lattner6b306672009-02-04 05:33:01 +00001315 assert(LineTable && "Can't have linetable entries without a LineTable!");
1316 // See if there is a #line directive before the location.
1317 const LineEntry *Entry =
Douglas Gregor47d9de62012-06-08 16:40:28 +00001318 LineTable->FindNearestLineEntry(LocInfo.first, LocInfo.second);
Mike Stump1eb44332009-09-09 15:08:12 +00001319
Chris Lattner6b306672009-02-04 05:33:01 +00001320 // If this is before the first line marker, use the file characteristic.
1321 if (!Entry)
1322 return FI.getFileCharacteristic();
1323
1324 return Entry->FileKind;
1325}
1326
Chris Lattnerbff5c512009-02-17 08:39:06 +00001327/// Return the filename or buffer identifier of the buffer the location is in.
1328/// Note that this name does not respect #line directives. Use getPresumedLoc
1329/// for normal clients.
Douglas Gregor50f6af72010-03-16 05:20:39 +00001330const char *SourceManager::getBufferName(SourceLocation Loc,
1331 bool *Invalid) const {
Zhanyong Wan1f24e112010-10-05 17:56:33 +00001332 if (isInvalid(Loc, Invalid)) return "<invalid loc>";
Mike Stump1eb44332009-09-09 15:08:12 +00001333
Douglas Gregor50f6af72010-03-16 05:20:39 +00001334 return getBuffer(getFileID(Loc), Invalid)->getBufferIdentifier();
Chris Lattnerbff5c512009-02-17 08:39:06 +00001335}
1336
Chris Lattner30fc9332009-02-04 01:06:56 +00001337
Chris Lattnerb9c3f962009-01-27 07:57:44 +00001338/// getPresumedLoc - This method returns the "presumed" location of a
1339/// SourceLocation specifies. A "presumed location" can be modified by #line
1340/// or GNU line marker directives. This provides a view on the data that a
1341/// user should see in diagnostics, for example.
1342///
Chandler Carruth3201f382011-07-26 05:17:23 +00001343/// Note that a presumed location is always given as the expansion point of an
1344/// expansion location, not at the spelling location.
Chris Lattnerb9c3f962009-01-27 07:57:44 +00001345PresumedLoc SourceManager::getPresumedLoc(SourceLocation Loc) const {
1346 if (Loc.isInvalid()) return PresumedLoc();
Mike Stump1eb44332009-09-09 15:08:12 +00001347
Chandler Carruth3201f382011-07-26 05:17:23 +00001348 // Presumed locations are always for expansion points.
Chandler Carruthe7b2b6e2011-07-25 20:52:32 +00001349 std::pair<FileID, unsigned> LocInfo = getDecomposedExpansionLoc(Loc);
Mike Stump1eb44332009-09-09 15:08:12 +00001350
Douglas Gregore23ac652011-04-20 00:21:03 +00001351 bool Invalid = false;
1352 const SLocEntry &Entry = getSLocEntry(LocInfo.first, &Invalid);
1353 if (Invalid || !Entry.isFile())
1354 return PresumedLoc();
1355
1356 const SrcMgr::FileInfo &FI = Entry.getFile();
Chris Lattnerb9c3f962009-01-27 07:57:44 +00001357 const SrcMgr::ContentCache *C = FI.getContentCache();
Mike Stump1eb44332009-09-09 15:08:12 +00001358
Chris Lattner3cd949c2009-02-04 01:55:42 +00001359 // To get the source name, first consult the FileEntry (if one exists)
1360 // before the MemBuffer as this will avoid unnecessarily paging in the
1361 // MemBuffer.
Chris Lattnere127a0d2010-04-20 20:35:58 +00001362 const char *Filename;
Argyrios Kyrtzidisb1c86492011-03-05 01:03:53 +00001363 if (C->OrigEntry)
1364 Filename = C->OrigEntry->getName();
Chris Lattnere127a0d2010-04-20 20:35:58 +00001365 else
1366 Filename = C->getBuffer(Diag, *this)->getBufferIdentifier();
Douglas Gregore23ac652011-04-20 00:21:03 +00001367
Douglas Gregorc417fa02010-11-02 00:39:22 +00001368 unsigned LineNo = getLineNumber(LocInfo.first, LocInfo.second, &Invalid);
1369 if (Invalid)
1370 return PresumedLoc();
1371 unsigned ColNo = getColumnNumber(LocInfo.first, LocInfo.second, &Invalid);
1372 if (Invalid)
1373 return PresumedLoc();
1374
Chris Lattner3cd949c2009-02-04 01:55:42 +00001375 SourceLocation IncludeLoc = FI.getIncludeLoc();
Mike Stump1eb44332009-09-09 15:08:12 +00001376
Chris Lattner3cd949c2009-02-04 01:55:42 +00001377 // If we have #line directives in this file, update and overwrite the physical
1378 // location info if appropriate.
1379 if (FI.hasLineDirectives()) {
1380 assert(LineTable && "Can't have linetable entries without a LineTable!");
1381 // See if there is a #line directive before this. If so, get it.
1382 if (const LineEntry *Entry =
Douglas Gregor47d9de62012-06-08 16:40:28 +00001383 LineTable->FindNearestLineEntry(LocInfo.first, LocInfo.second)) {
Chris Lattnerfc391332009-02-04 02:00:59 +00001384 // If the LineEntry indicates a filename, use it.
Chris Lattner3cd949c2009-02-04 01:55:42 +00001385 if (Entry->FilenameID != -1)
1386 Filename = LineTable->getFilename(Entry->FilenameID);
Chris Lattnerfc391332009-02-04 02:00:59 +00001387
1388 // Use the line number specified by the LineEntry. This line number may
1389 // be multiple lines down from the line entry. Add the difference in
1390 // physical line numbers from the query point and the line marker to the
1391 // total.
1392 unsigned MarkerLineNo = getLineNumber(LocInfo.first, Entry->FileOffset);
1393 LineNo = Entry->LineNo + (LineNo-MarkerLineNo-1);
Mike Stump1eb44332009-09-09 15:08:12 +00001394
Chris Lattner0e0e5da2009-02-04 02:15:40 +00001395 // Note that column numbers are not molested by line markers.
Mike Stump1eb44332009-09-09 15:08:12 +00001396
Chris Lattner137b6a62009-02-04 06:25:26 +00001397 // Handle virtual #include manipulation.
1398 if (Entry->IncludeOffset) {
1399 IncludeLoc = getLocForStartOfFile(LocInfo.first);
Argyrios Kyrtzidisa64ccef2011-09-19 20:40:19 +00001400 IncludeLoc = IncludeLoc.getLocWithOffset(Entry->IncludeOffset);
Chris Lattner137b6a62009-02-04 06:25:26 +00001401 }
Chris Lattner3cd949c2009-02-04 01:55:42 +00001402 }
1403 }
1404
1405 return PresumedLoc(Filename, LineNo, ColNo, IncludeLoc);
Chris Lattnerde7aeef2009-01-26 00:43:02 +00001406}
1407
Argyrios Kyrtzidis984e42c2011-08-23 21:02:28 +00001408/// \brief The size of the SLocEnty that \arg FID represents.
1409unsigned SourceManager::getFileIDSize(FileID FID) const {
1410 bool Invalid = false;
1411 const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid);
1412 if (Invalid)
1413 return 0;
1414
1415 int ID = FID.ID;
1416 unsigned NextOffset;
1417 if ((ID > 0 && unsigned(ID+1) == local_sloc_entry_size()))
1418 NextOffset = getNextLocalOffset();
1419 else if (ID+1 == -1)
1420 NextOffset = MaxLoadedOffset;
1421 else
1422 NextOffset = getSLocEntry(FileID::get(ID+1)).getOffset();
1423
1424 return NextOffset - Entry.getOffset() - 1;
1425}
1426
Chris Lattnerde7aeef2009-01-26 00:43:02 +00001427//===----------------------------------------------------------------------===//
1428// Other miscellaneous methods.
1429//===----------------------------------------------------------------------===//
1430
Douglas Gregor86a4d0d2011-02-03 17:17:35 +00001431/// \brief Retrieve the inode for the given file entry, if possible.
1432///
1433/// This routine involves a system call, and therefore should only be used
1434/// in non-performance-critical code.
1435static llvm::Optional<ino_t> getActualFileInode(const FileEntry *File) {
1436 if (!File)
1437 return llvm::Optional<ino_t>();
1438
1439 struct stat StatBuf;
1440 if (::stat(File->getName(), &StatBuf))
1441 return llvm::Optional<ino_t>();
1442
1443 return StatBuf.st_ino;
1444}
1445
Argyrios Kyrtzidis10b46d22009-06-20 08:09:57 +00001446/// \brief Get the source location for the given file:line:col triplet.
1447///
1448/// If the source file is included multiple times, the source location will
Douglas Gregorf62d43d2011-07-19 16:10:42 +00001449/// be based upon an arbitrary inclusion.
Argyrios Kyrtzidisac836e42011-08-17 00:31:20 +00001450SourceLocation SourceManager::translateFileLineCol(const FileEntry *SourceFile,
Argyrios Kyrtzidis507097e2011-09-19 20:40:35 +00001451 unsigned Line,
1452 unsigned Col) const {
Argyrios Kyrtzidis10b46d22009-06-20 08:09:57 +00001453 assert(SourceFile && "Null source file!");
1454 assert(Line && Col && "Line and column should start from 1!");
1455
Argyrios Kyrtzidisb201e162011-09-27 17:22:25 +00001456 FileID FirstFID = translateFile(SourceFile);
1457 return translateLineCol(FirstFID, Line, Col);
1458}
1459
1460/// \brief Get the FileID for the given file.
1461///
1462/// If the source file is included multiple times, the FileID will be the
1463/// first inclusion.
1464FileID SourceManager::translateFile(const FileEntry *SourceFile) const {
1465 assert(SourceFile && "Null source file!");
1466
Douglas Gregor86a4d0d2011-02-03 17:17:35 +00001467 // Find the first file ID that corresponds to the given file.
1468 FileID FirstFID;
Mike Stump1eb44332009-09-09 15:08:12 +00001469
Douglas Gregor86a4d0d2011-02-03 17:17:35 +00001470 // First, check the main file ID, since it is common to look for a
1471 // location in the main file.
1472 llvm::Optional<ino_t> SourceFileInode;
Chris Lattner5f9e2722011-07-23 10:55:15 +00001473 llvm::Optional<StringRef> SourceFileName;
Douglas Gregor86a4d0d2011-02-03 17:17:35 +00001474 if (!MainFileID.isInvalid()) {
Douglas Gregore23ac652011-04-20 00:21:03 +00001475 bool Invalid = false;
1476 const SLocEntry &MainSLoc = getSLocEntry(MainFileID, &Invalid);
1477 if (Invalid)
Argyrios Kyrtzidisb201e162011-09-27 17:22:25 +00001478 return FileID();
Douglas Gregore23ac652011-04-20 00:21:03 +00001479
Douglas Gregor86a4d0d2011-02-03 17:17:35 +00001480 if (MainSLoc.isFile()) {
1481 const ContentCache *MainContentCache
1482 = MainSLoc.getFile().getContentCache();
Douglas Gregorb7a18412011-02-11 18:08:15 +00001483 if (!MainContentCache) {
1484 // Can't do anything
Argyrios Kyrtzidisb1c86492011-03-05 01:03:53 +00001485 } else if (MainContentCache->OrigEntry == SourceFile) {
Douglas Gregor86a4d0d2011-02-03 17:17:35 +00001486 FirstFID = MainFileID;
Douglas Gregorb7a18412011-02-11 18:08:15 +00001487 } else {
Douglas Gregor86a4d0d2011-02-03 17:17:35 +00001488 // Fall back: check whether we have the same base name and inode
1489 // as the main file.
Argyrios Kyrtzidisb1c86492011-03-05 01:03:53 +00001490 const FileEntry *MainFile = MainContentCache->OrigEntry;
Douglas Gregor86a4d0d2011-02-03 17:17:35 +00001491 SourceFileName = llvm::sys::path::filename(SourceFile->getName());
1492 if (*SourceFileName == llvm::sys::path::filename(MainFile->getName())) {
1493 SourceFileInode = getActualFileInode(SourceFile);
Douglas Gregor37c02bf2011-02-16 19:09:24 +00001494 if (SourceFileInode) {
1495 if (llvm::Optional<ino_t> MainFileInode
1496 = getActualFileInode(MainFile)) {
1497 if (*SourceFileInode == *MainFileInode) {
1498 FirstFID = MainFileID;
1499 SourceFile = MainFile;
1500 }
1501 }
Douglas Gregor86a4d0d2011-02-03 17:17:35 +00001502 }
1503 }
1504 }
1505 }
1506 }
1507
1508 if (FirstFID.isInvalid()) {
1509 // The location we're looking for isn't in the main file; look
Douglas Gregorf62d43d2011-07-19 16:10:42 +00001510 // through all of the local source locations.
1511 for (unsigned I = 0, N = local_sloc_entry_size(); I != N; ++I) {
Douglas Gregore23ac652011-04-20 00:21:03 +00001512 bool Invalid = false;
Douglas Gregorf62d43d2011-07-19 16:10:42 +00001513 const SLocEntry &SLoc = getLocalSLocEntry(I, &Invalid);
Douglas Gregore23ac652011-04-20 00:21:03 +00001514 if (Invalid)
Argyrios Kyrtzidisb201e162011-09-27 17:22:25 +00001515 return FileID();
Douglas Gregore23ac652011-04-20 00:21:03 +00001516
Douglas Gregor86a4d0d2011-02-03 17:17:35 +00001517 if (SLoc.isFile() &&
1518 SLoc.getFile().getContentCache() &&
Argyrios Kyrtzidisb1c86492011-03-05 01:03:53 +00001519 SLoc.getFile().getContentCache()->OrigEntry == SourceFile) {
Douglas Gregor86a4d0d2011-02-03 17:17:35 +00001520 FirstFID = FileID::get(I);
1521 break;
1522 }
1523 }
Douglas Gregorf62d43d2011-07-19 16:10:42 +00001524 // If that still didn't help, try the modules.
1525 if (FirstFID.isInvalid()) {
1526 for (unsigned I = 0, N = loaded_sloc_entry_size(); I != N; ++I) {
1527 const SLocEntry &SLoc = getLoadedSLocEntry(I);
1528 if (SLoc.isFile() &&
1529 SLoc.getFile().getContentCache() &&
1530 SLoc.getFile().getContentCache()->OrigEntry == SourceFile) {
1531 FirstFID = FileID::get(-int(I) - 2);
1532 break;
1533 }
1534 }
1535 }
Douglas Gregor86a4d0d2011-02-03 17:17:35 +00001536 }
1537
1538 // If we haven't found what we want yet, try again, but this time stat()
1539 // each of the files in case the files have changed since we originally
1540 // parsed the file.
1541 if (FirstFID.isInvalid() &&
1542 (SourceFileName ||
1543 (SourceFileName = llvm::sys::path::filename(SourceFile->getName()))) &&
1544 (SourceFileInode ||
1545 (SourceFileInode = getActualFileInode(SourceFile)))) {
Douglas Gregore23ac652011-04-20 00:21:03 +00001546 bool Invalid = false;
Douglas Gregorf62d43d2011-07-19 16:10:42 +00001547 for (unsigned I = 0, N = local_sloc_entry_size(); I != N; ++I) {
1548 FileID IFileID;
1549 IFileID.ID = I;
1550 const SLocEntry &SLoc = getSLocEntry(IFileID, &Invalid);
Douglas Gregore23ac652011-04-20 00:21:03 +00001551 if (Invalid)
Argyrios Kyrtzidisb201e162011-09-27 17:22:25 +00001552 return FileID();
Douglas Gregore23ac652011-04-20 00:21:03 +00001553
Douglas Gregor86a4d0d2011-02-03 17:17:35 +00001554 if (SLoc.isFile()) {
1555 const ContentCache *FileContentCache
1556 = SLoc.getFile().getContentCache();
Argyrios Kyrtzidisb1c86492011-03-05 01:03:53 +00001557 const FileEntry *Entry =FileContentCache? FileContentCache->OrigEntry : 0;
Douglas Gregor86a4d0d2011-02-03 17:17:35 +00001558 if (Entry &&
Douglas Gregorb7a18412011-02-11 18:08:15 +00001559 *SourceFileName == llvm::sys::path::filename(Entry->getName())) {
1560 if (llvm::Optional<ino_t> EntryInode = getActualFileInode(Entry)) {
1561 if (*SourceFileInode == *EntryInode) {
1562 FirstFID = FileID::get(I);
1563 SourceFile = Entry;
1564 break;
1565 }
1566 }
Douglas Gregor86a4d0d2011-02-03 17:17:35 +00001567 }
1568 }
1569 }
1570 }
Argyrios Kyrtzidisb201e162011-09-27 17:22:25 +00001571
1572 return FirstFID;
Argyrios Kyrtzidisefa2ff82011-09-19 20:40:29 +00001573}
1574
1575/// \brief Get the source location in \arg FID for the given line:col.
1576/// Returns null location if \arg FID is not a file SLocEntry.
1577SourceLocation SourceManager::translateLineCol(FileID FID,
Argyrios Kyrtzidis507097e2011-09-19 20:40:35 +00001578 unsigned Line,
1579 unsigned Col) const {
Argyrios Kyrtzidisefa2ff82011-09-19 20:40:29 +00001580 if (FID.isInvalid())
1581 return SourceLocation();
1582
1583 bool Invalid = false;
1584 const SLocEntry &Entry = getSLocEntry(FID, &Invalid);
1585 if (Invalid)
1586 return SourceLocation();
1587
1588 if (!Entry.isFile())
Douglas Gregor86a4d0d2011-02-03 17:17:35 +00001589 return SourceLocation();
1590
Argyrios Kyrtzidis5e5e95d2011-09-20 22:14:54 +00001591 SourceLocation FileLoc = SourceLocation::getFileLoc(Entry.getOffset());
1592
Douglas Gregor86a4d0d2011-02-03 17:17:35 +00001593 if (Line == 1 && Col == 1)
Argyrios Kyrtzidis5e5e95d2011-09-20 22:14:54 +00001594 return FileLoc;
Douglas Gregor86a4d0d2011-02-03 17:17:35 +00001595
1596 ContentCache *Content
Argyrios Kyrtzidisefa2ff82011-09-19 20:40:29 +00001597 = const_cast<ContentCache *>(Entry.getFile().getContentCache());
Douglas Gregor86a4d0d2011-02-03 17:17:35 +00001598 if (!Content)
1599 return SourceLocation();
1600
Argyrios Kyrtzidis10b46d22009-06-20 08:09:57 +00001601 // If this is the first use of line information for this buffer, compute the
Douglas Gregorf62d43d2011-07-19 16:10:42 +00001602 // SourceLineCache for it on demand.
Douglas Gregor50f6af72010-03-16 05:20:39 +00001603 if (Content->SourceLineCache == 0) {
1604 bool MyInvalid = false;
Chris Lattnere127a0d2010-04-20 20:35:58 +00001605 ComputeLineNumbers(Diag, Content, ContentCacheAlloc, *this, MyInvalid);
Douglas Gregor50f6af72010-03-16 05:20:39 +00001606 if (MyInvalid)
1607 return SourceLocation();
1608 }
Argyrios Kyrtzidis10b46d22009-06-20 08:09:57 +00001609
Douglas Gregord1eabfb2010-02-27 02:42:25 +00001610 if (Line > Content->NumLines) {
Chris Lattnere127a0d2010-04-20 20:35:58 +00001611 unsigned Size = Content->getBuffer(Diag, *this)->getBufferSize();
Douglas Gregord1eabfb2010-02-27 02:42:25 +00001612 if (Size > 0)
1613 --Size;
Argyrios Kyrtzidis5e5e95d2011-09-20 22:14:54 +00001614 return FileLoc.getLocWithOffset(Size);
Douglas Gregord1eabfb2010-02-27 02:42:25 +00001615 }
1616
Dylan Noblesmith098eaff2011-12-19 08:51:05 +00001617 const llvm::MemoryBuffer *Buffer = Content->getBuffer(Diag, *this);
Douglas Gregord1eabfb2010-02-27 02:42:25 +00001618 unsigned FilePos = Content->SourceLineCache[Line - 1];
Dylan Noblesmith098eaff2011-12-19 08:51:05 +00001619 const char *Buf = Buffer->getBufferStart() + FilePos;
1620 unsigned BufLength = Buffer->getBufferSize() - FilePos;
Argyrios Kyrtzidis5e5e95d2011-09-20 22:14:54 +00001621 if (BufLength == 0)
1622 return FileLoc.getLocWithOffset(FilePos);
1623
Douglas Gregord1eabfb2010-02-27 02:42:25 +00001624 unsigned i = 0;
1625
1626 // Check that the given column is valid.
1627 while (i < BufLength-1 && i < Col-1 && Buf[i] != '\n' && Buf[i] != '\r')
1628 ++i;
1629 if (i < Col-1)
Argyrios Kyrtzidis5e5e95d2011-09-20 22:14:54 +00001630 return FileLoc.getLocWithOffset(FilePos + i);
Douglas Gregord1eabfb2010-02-27 02:42:25 +00001631
Argyrios Kyrtzidis5e5e95d2011-09-20 22:14:54 +00001632 return FileLoc.getLocWithOffset(FilePos + Col - 1);
Argyrios Kyrtzidis10b46d22009-06-20 08:09:57 +00001633}
1634
Argyrios Kyrtzidisd9d2b672011-08-21 23:33:04 +00001635/// \brief Compute a map of macro argument chunks to their expanded source
1636/// location. Chunks that are not part of a macro argument will map to an
1637/// invalid source location. e.g. if a file contains one macro argument at
1638/// offset 100 with length 10, this is how the map will be formed:
1639/// 0 -> SourceLocation()
1640/// 100 -> Expanded macro arg location
1641/// 110 -> SourceLocation()
Argyrios Kyrtzidisfb3612e2011-09-26 08:01:50 +00001642void SourceManager::computeMacroArgsCache(MacroArgsMap *&CachePtr,
Argyrios Kyrtzidis507097e2011-09-19 20:40:35 +00001643 FileID FID) const {
Argyrios Kyrtzidisd9d2b672011-08-21 23:33:04 +00001644 assert(!FID.isInvalid());
Argyrios Kyrtzidisfb3612e2011-09-26 08:01:50 +00001645 assert(!CachePtr);
Argyrios Kyrtzidisd9d2b672011-08-21 23:33:04 +00001646
Argyrios Kyrtzidisfb3612e2011-09-26 08:01:50 +00001647 CachePtr = new MacroArgsMap();
1648 MacroArgsMap &MacroArgsCache = *CachePtr;
Argyrios Kyrtzidisd9d2b672011-08-21 23:33:04 +00001649 // Initially no macro argument chunk is present.
1650 MacroArgsCache.insert(std::make_pair(0, SourceLocation()));
1651
1652 int ID = FID.ID;
1653 while (1) {
1654 ++ID;
1655 // Stop if there are no more FileIDs to check.
1656 if (ID > 0) {
1657 if (unsigned(ID) >= local_sloc_entry_size())
1658 return;
1659 } else if (ID == -1) {
1660 return;
1661 }
1662
1663 const SrcMgr::SLocEntry &Entry = getSLocEntryByID(ID);
1664 if (Entry.isFile()) {
1665 SourceLocation IncludeLoc = Entry.getFile().getIncludeLoc();
1666 if (IncludeLoc.isInvalid())
1667 continue;
1668 if (!isInFileID(IncludeLoc, FID))
1669 return; // No more files/macros that may be "contained" in this file.
1670
1671 // Skip the files/macros of the #include'd file, we only care about macros
1672 // that lexed macro arguments from our file.
1673 if (Entry.getFile().NumCreatedFIDs)
1674 ID += Entry.getFile().NumCreatedFIDs - 1/*because of next ++ID*/;
1675 continue;
1676 }
1677
Argyrios Kyrtzidiscee5ec92011-12-21 16:56:35 +00001678 const ExpansionInfo &ExpInfo = Entry.getExpansion();
1679
1680 if (ExpInfo.getExpansionLocStart().isFileID()) {
1681 if (!isInFileID(ExpInfo.getExpansionLocStart(), FID))
1682 return; // No more files/macros that may be "contained" in this file.
1683 }
1684
1685 if (!ExpInfo.isMacroArgExpansion())
Argyrios Kyrtzidisd9d2b672011-08-21 23:33:04 +00001686 continue;
Argyrios Kyrtzidiscee5ec92011-12-21 16:56:35 +00001687
1688 SourceLocation SpellLoc = ExpInfo.getSpellingLoc();
1689 while (!SpellLoc.isFileID()) {
1690 std::pair<FileID, unsigned> LocInfo = getDecomposedLoc(SpellLoc);
1691 const ExpansionInfo &Info = getSLocEntry(LocInfo.first).getExpansion();
1692 if (!Info.isMacroArgExpansion())
1693 break;
1694 SpellLoc = Info.getSpellingLoc().getLocWithOffset(LocInfo.second);
1695 }
1696 if (!SpellLoc.isFileID())
1697 continue;
1698
Argyrios Kyrtzidisd9d2b672011-08-21 23:33:04 +00001699 unsigned BeginOffs;
1700 if (!isInFileID(SpellLoc, FID, &BeginOffs))
Argyrios Kyrtzidiscee5ec92011-12-21 16:56:35 +00001701 continue;
1702
Argyrios Kyrtzidisd9d2b672011-08-21 23:33:04 +00001703 unsigned EndOffs = BeginOffs + getFileIDSize(FileID::get(ID));
1704
1705 // Add a new chunk for this macro argument. A previous macro argument chunk
1706 // may have been lexed again, so e.g. if the map is
1707 // 0 -> SourceLocation()
1708 // 100 -> Expanded loc #1
1709 // 110 -> SourceLocation()
1710 // and we found a new macro FileID that lexed from offet 105 with length 3,
1711 // the new map will be:
1712 // 0 -> SourceLocation()
1713 // 100 -> Expanded loc #1
1714 // 105 -> Expanded loc #2
1715 // 108 -> Expanded loc #1
1716 // 110 -> SourceLocation()
1717 //
1718 // Since re-lexed macro chunks will always be the same size or less of
1719 // previous chunks, we only need to find where the ending of the new macro
1720 // chunk is mapped to and update the map with new begin/end mappings.
1721
Argyrios Kyrtzidisfb3612e2011-09-26 08:01:50 +00001722 MacroArgsMap::iterator I = MacroArgsCache.upper_bound(EndOffs);
Argyrios Kyrtzidisd9d2b672011-08-21 23:33:04 +00001723 --I;
1724 SourceLocation EndOffsMappedLoc = I->second;
1725 MacroArgsCache[BeginOffs] = SourceLocation::getMacroLoc(Entry.getOffset());
1726 MacroArgsCache[EndOffs] = EndOffsMappedLoc;
1727 }
1728}
1729
Argyrios Kyrtzidisac836e42011-08-17 00:31:20 +00001730/// \brief If \arg Loc points inside a function macro argument, the returned
1731/// location will be the macro location in which the argument was expanded.
1732/// If a macro argument is used multiple times, the expanded location will
1733/// be at the first expansion of the argument.
1734/// e.g.
1735/// MY_MACRO(foo);
1736/// ^
1737/// Passing a file location pointing at 'foo', will yield a macro location
1738/// where 'foo' was expanded into.
Argyrios Kyrtzidis507097e2011-09-19 20:40:35 +00001739SourceLocation
1740SourceManager::getMacroArgExpandedLocation(SourceLocation Loc) const {
Argyrios Kyrtzidisd9d2b672011-08-21 23:33:04 +00001741 if (Loc.isInvalid() || !Loc.isFileID())
Argyrios Kyrtzidisac836e42011-08-17 00:31:20 +00001742 return Loc;
Argyrios Kyrtzidisd9d2b672011-08-21 23:33:04 +00001743
1744 FileID FID;
1745 unsigned Offset;
1746 llvm::tie(FID, Offset) = getDecomposedLoc(Loc);
Argyrios Kyrtzidisac836e42011-08-17 00:31:20 +00001747 if (FID.isInvalid())
1748 return Loc;
1749
Argyrios Kyrtzidisfb3612e2011-09-26 08:01:50 +00001750 MacroArgsMap *&MacroArgsCache = MacroArgsCacheMap[FID];
1751 if (!MacroArgsCache)
1752 computeMacroArgsCache(MacroArgsCache, FID);
Argyrios Kyrtzidisac836e42011-08-17 00:31:20 +00001753
Argyrios Kyrtzidisfb3612e2011-09-26 08:01:50 +00001754 assert(!MacroArgsCache->empty());
1755 MacroArgsMap::iterator I = MacroArgsCache->upper_bound(Offset);
Argyrios Kyrtzidisd9d2b672011-08-21 23:33:04 +00001756 --I;
Argyrios Kyrtzidisac836e42011-08-17 00:31:20 +00001757
Argyrios Kyrtzidisd9d2b672011-08-21 23:33:04 +00001758 unsigned MacroArgBeginOffs = I->first;
1759 SourceLocation MacroArgExpandedLoc = I->second;
1760 if (MacroArgExpandedLoc.isValid())
Argyrios Kyrtzidisa64ccef2011-09-19 20:40:19 +00001761 return MacroArgExpandedLoc.getLocWithOffset(Offset - MacroArgBeginOffs);
Argyrios Kyrtzidisac836e42011-08-17 00:31:20 +00001762
Argyrios Kyrtzidisd9d2b672011-08-21 23:33:04 +00001763 return Loc;
Argyrios Kyrtzidisac836e42011-08-17 00:31:20 +00001764}
1765
Chandler Carruth3201f382011-07-26 05:17:23 +00001766/// Given a decomposed source location, move it up the include/expansion stack
1767/// to the parent source location. If this is possible, return the decomposed
1768/// version of the parent in Loc and return false. If Loc is the top-level
1769/// entry, return true and don't modify it.
Chris Lattnerd3b8cc22010-05-07 20:35:24 +00001770static bool MoveUpIncludeHierarchy(std::pair<FileID, unsigned> &Loc,
1771 const SourceManager &SM) {
1772 SourceLocation UpperLoc;
1773 const SrcMgr::SLocEntry &Entry = SM.getSLocEntry(Loc.first);
Chandler Carruth17287622011-07-26 04:56:51 +00001774 if (Entry.isExpansion())
Argyrios Kyrtzidisd7711ec2011-12-21 16:56:29 +00001775 UpperLoc = Entry.getExpansion().getExpansionLocStart();
Chris Lattnerd3b8cc22010-05-07 20:35:24 +00001776 else
1777 UpperLoc = Entry.getFile().getIncludeLoc();
1778
1779 if (UpperLoc.isInvalid())
1780 return true; // We reached the top.
1781
1782 Loc = SM.getDecomposedLoc(UpperLoc);
1783 return false;
1784}
1785
1786
Argyrios Kyrtzidis2aa03d52009-06-23 22:01:48 +00001787/// \brief Determines the order of 2 source locations in the translation unit.
1788///
1789/// \returns true if LHS source location comes before RHS, false otherwise.
1790bool SourceManager::isBeforeInTranslationUnit(SourceLocation LHS,
1791 SourceLocation RHS) const {
1792 assert(LHS.isValid() && RHS.isValid() && "Passed invalid source location!");
1793 if (LHS == RHS)
1794 return false;
Mike Stump1eb44332009-09-09 15:08:12 +00001795
Argyrios Kyrtzidis2aa03d52009-06-23 22:01:48 +00001796 std::pair<FileID, unsigned> LOffs = getDecomposedLoc(LHS);
1797 std::pair<FileID, unsigned> ROffs = getDecomposedLoc(RHS);
Mike Stump1eb44332009-09-09 15:08:12 +00001798
Argyrios Kyrtzidis2aa03d52009-06-23 22:01:48 +00001799 // If the source locations are in the same file, just compare offsets.
1800 if (LOffs.first == ROffs.first)
1801 return LOffs.second < ROffs.second;
1802
1803 // If we are comparing a source location with multiple locations in the same
1804 // file, we get a big win by caching the result.
Chris Lattner66a915f2010-05-07 05:10:46 +00001805 if (IsBeforeInTUCache.isCacheValid(LOffs.first, ROffs.first))
1806 return IsBeforeInTUCache.getCachedResult(LOffs.second, ROffs.second);
Mike Stump1eb44332009-09-09 15:08:12 +00001807
Chris Lattnerdcb1d682010-05-07 01:17:07 +00001808 // Okay, we missed in the cache, start updating the cache for this query.
Argyrios Kyrtzidis37e59a12011-08-17 00:31:18 +00001809 IsBeforeInTUCache.setQueryFIDs(LOffs.first, ROffs.first,
1810 /*isLFIDBeforeRFID=*/LOffs.first.ID < ROffs.first.ID);
Mike Stump1eb44332009-09-09 15:08:12 +00001811
Douglas Gregorf62d43d2011-07-19 16:10:42 +00001812 // We need to find the common ancestor. The only way of doing this is to
1813 // build the complete include chain for one and then walking up the chain
1814 // of the other looking for a match.
1815 // We use a map from FileID to Offset to store the chain. Easier than writing
1816 // a custom set hash info that only depends on the first part of a pair.
1817 typedef llvm::DenseMap<FileID, unsigned> LocSet;
1818 LocSet LChain;
Chris Lattner48296ba2010-05-07 05:51:13 +00001819 do {
Douglas Gregorf62d43d2011-07-19 16:10:42 +00001820 LChain.insert(LOffs);
1821 // We catch the case where LOffs is in a file included by ROffs and
1822 // quit early. The other way round unfortunately remains suboptimal.
1823 } while (LOffs.first != ROffs.first && !MoveUpIncludeHierarchy(LOffs, *this));
1824 LocSet::iterator I;
1825 while((I = LChain.find(ROffs.first)) == LChain.end()) {
1826 if (MoveUpIncludeHierarchy(ROffs, *this))
1827 break; // Met at topmost file.
1828 }
1829 if (I != LChain.end())
1830 LOffs = *I;
Mike Stump1eb44332009-09-09 15:08:12 +00001831
Chris Lattner48296ba2010-05-07 05:51:13 +00001832 // If we exited because we found a nearest common ancestor, compare the
1833 // locations within the common file and cache them.
1834 if (LOffs.first == ROffs.first) {
1835 IsBeforeInTUCache.setCommonLoc(LOffs.first, LOffs.second, ROffs.second);
1836 return IsBeforeInTUCache.getCachedResult(LOffs.second, ROffs.second);
Argyrios Kyrtzidis2aa03d52009-06-23 22:01:48 +00001837 }
Mike Stump1eb44332009-09-09 15:08:12 +00001838
Douglas Gregorf62d43d2011-07-19 16:10:42 +00001839 // This can happen if a location is in a built-ins buffer.
1840 // But see PR5662.
1841 // Clear the lookup cache, it depends on a common location.
Argyrios Kyrtzidis37e59a12011-08-17 00:31:18 +00001842 IsBeforeInTUCache.clear();
Douglas Gregorf62d43d2011-07-19 16:10:42 +00001843 bool LIsBuiltins = strcmp("<built-in>",
1844 getBuffer(LOffs.first)->getBufferIdentifier()) == 0;
1845 bool RIsBuiltins = strcmp("<built-in>",
1846 getBuffer(ROffs.first)->getBufferIdentifier()) == 0;
1847 // built-in is before non-built-in
1848 if (LIsBuiltins != RIsBuiltins)
1849 return LIsBuiltins;
1850 assert(LIsBuiltins && RIsBuiltins &&
1851 "Non-built-in locations must be rooted in the main file");
1852 // Both are in built-in buffers, but from different files. We just claim that
1853 // lower IDs come first.
Chris Lattnerdcb1d682010-05-07 01:17:07 +00001854 return LOffs.first < ROffs.first;
Argyrios Kyrtzidis2aa03d52009-06-23 22:01:48 +00001855}
Chris Lattnerde7aeef2009-01-26 00:43:02 +00001856
Reid Spencer5f016e22007-07-11 17:01:13 +00001857/// PrintStats - Print statistics to stderr.
1858///
1859void SourceManager::PrintStats() const {
Benjamin Kramer6cb7c1a2009-08-23 12:08:50 +00001860 llvm::errs() << "\n*** Source Manager Stats:\n";
1861 llvm::errs() << FileInfos.size() << " files mapped, " << MemBufferInfos.size()
1862 << " mem buffers mapped.\n";
Douglas Gregorf62d43d2011-07-19 16:10:42 +00001863 llvm::errs() << LocalSLocEntryTable.size() << " local SLocEntry's allocated ("
Ted Kremenek6e36c122011-07-27 18:41:16 +00001864 << llvm::capacity_in_bytes(LocalSLocEntryTable)
Argyrios Kyrtzidisd410e742011-07-07 03:40:24 +00001865 << " bytes of capacity), "
Douglas Gregorf62d43d2011-07-19 16:10:42 +00001866 << NextLocalOffset << "B of Sloc address space used.\n";
1867 llvm::errs() << LoadedSLocEntryTable.size()
1868 << " loaded SLocEntries allocated, "
Argyrios Kyrtzidisac836e42011-08-17 00:31:20 +00001869 << MaxLoadedOffset - CurrentLoadedOffset
Douglas Gregorf62d43d2011-07-19 16:10:42 +00001870 << "B of Sloc address space used.\n";
1871
Reid Spencer5f016e22007-07-11 17:01:13 +00001872 unsigned NumLineNumsComputed = 0;
1873 unsigned NumFileBytesMapped = 0;
Chris Lattner0d0bf8c2009-02-03 07:30:45 +00001874 for (fileinfo_iterator I = fileinfo_begin(), E = fileinfo_end(); I != E; ++I){
1875 NumLineNumsComputed += I->second->SourceLineCache != 0;
1876 NumFileBytesMapped += I->second->getSizeBytesMapped();
Reid Spencer5f016e22007-07-11 17:01:13 +00001877 }
Argyrios Kyrtzidisfb3612e2011-09-26 08:01:50 +00001878 unsigned NumMacroArgsComputed = MacroArgsCacheMap.size();
Mike Stump1eb44332009-09-09 15:08:12 +00001879
Benjamin Kramer6cb7c1a2009-08-23 12:08:50 +00001880 llvm::errs() << NumFileBytesMapped << " bytes of files mapped, "
Argyrios Kyrtzidisd9d2b672011-08-21 23:33:04 +00001881 << NumLineNumsComputed << " files with line #'s computed, "
1882 << NumMacroArgsComputed << " files with macro args computed.\n";
Benjamin Kramer6cb7c1a2009-08-23 12:08:50 +00001883 llvm::errs() << "FileID scans: " << NumLinearScans << " linear, "
1884 << NumBinaryProbes << " binary.\n";
Reid Spencer5f016e22007-07-11 17:01:13 +00001885}
Douglas Gregor7f94b0b2009-04-27 06:38:32 +00001886
1887ExternalSLocEntrySource::~ExternalSLocEntrySource() { }
Ted Kremenekf61b8312011-04-28 20:36:42 +00001888
1889/// Return the amount of memory used by memory buffers, breaking down
1890/// by heap-backed versus mmap'ed memory.
1891SourceManager::MemoryBufferSizes SourceManager::getMemoryBufferSizes() const {
1892 size_t malloc_bytes = 0;
1893 size_t mmap_bytes = 0;
1894
1895 for (unsigned i = 0, e = MemBufferInfos.size(); i != e; ++i)
1896 if (size_t sized_mapped = MemBufferInfos[i]->getSizeBytesMapped())
1897 switch (MemBufferInfos[i]->getMemoryBufferKind()) {
1898 case llvm::MemoryBuffer::MemoryBuffer_MMap:
1899 mmap_bytes += sized_mapped;
1900 break;
1901 case llvm::MemoryBuffer::MemoryBuffer_Malloc:
1902 malloc_bytes += sized_mapped;
1903 break;
1904 }
1905
1906 return MemoryBufferSizes(malloc_bytes, mmap_bytes);
1907}
1908
Ted Kremenekca7dc2b2011-07-26 23:46:06 +00001909size_t SourceManager::getDataStructureSizes() const {
Argyrios Kyrtzidisd54dff02012-05-03 21:50:39 +00001910 size_t size = llvm::capacity_in_bytes(MemBufferInfos)
Ted Kremenek6e36c122011-07-27 18:41:16 +00001911 + llvm::capacity_in_bytes(LocalSLocEntryTable)
1912 + llvm::capacity_in_bytes(LoadedSLocEntryTable)
1913 + llvm::capacity_in_bytes(SLocEntryLoaded)
Argyrios Kyrtzidisd54dff02012-05-03 21:50:39 +00001914 + llvm::capacity_in_bytes(FileInfos);
1915
1916 if (OverriddenFilesInfo)
1917 size += llvm::capacity_in_bytes(OverriddenFilesInfo->OverriddenFiles);
1918
1919 return size;
Ted Kremenekca7dc2b2011-07-26 23:46:06 +00001920}