1 //===- ASTUnit.cpp - ASTUnit utility --------------------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // ASTUnit Implementation.
10 //
11 //===----------------------------------------------------------------------===//
12
13 #include "clang/Frontend/ASTUnit.h"
14 #include "clang/AST/ASTConsumer.h"
15 #include "clang/AST/ASTContext.h"
16 #include "clang/AST/CommentCommandTraits.h"
17 #include "clang/AST/Decl.h"
18 #include "clang/AST/DeclBase.h"
19 #include "clang/AST/DeclCXX.h"
20 #include "clang/AST/DeclGroup.h"
21 #include "clang/AST/DeclObjC.h"
22 #include "clang/AST/DeclTemplate.h"
23 #include "clang/AST/DeclarationName.h"
24 #include "clang/AST/ExternalASTSource.h"
25 #include "clang/AST/PrettyPrinter.h"
26 #include "clang/AST/Type.h"
27 #include "clang/AST/TypeOrdering.h"
28 #include "clang/Basic/Diagnostic.h"
29 #include "clang/Basic/FileManager.h"
30 #include "clang/Basic/IdentifierTable.h"
31 #include "clang/Basic/LLVM.h"
32 #include "clang/Basic/LangOptions.h"
33 #include "clang/Basic/LangStandard.h"
34 #include "clang/Basic/Module.h"
35 #include "clang/Basic/SourceLocation.h"
36 #include "clang/Basic/SourceManager.h"
37 #include "clang/Basic/TargetInfo.h"
38 #include "clang/Basic/TargetOptions.h"
39 #include "clang/Frontend/CompilerInstance.h"
40 #include "clang/Frontend/CompilerInvocation.h"
41 #include "clang/Frontend/FrontendAction.h"
42 #include "clang/Frontend/FrontendActions.h"
43 #include "clang/Frontend/FrontendDiagnostic.h"
44 #include "clang/Frontend/FrontendOptions.h"
45 #include "clang/Frontend/MultiplexConsumer.h"
46 #include "clang/Frontend/PrecompiledPreamble.h"
47 #include "clang/Frontend/Utils.h"
48 #include "clang/Lex/HeaderSearch.h"
49 #include "clang/Lex/HeaderSearchOptions.h"
50 #include "clang/Lex/Lexer.h"
51 #include "clang/Lex/PPCallbacks.h"
52 #include "clang/Lex/PreprocessingRecord.h"
53 #include "clang/Lex/Preprocessor.h"
54 #include "clang/Lex/PreprocessorOptions.h"
55 #include "clang/Lex/Token.h"
56 #include "clang/Sema/CodeCompleteConsumer.h"
57 #include "clang/Sema/CodeCompleteOptions.h"
58 #include "clang/Sema/Sema.h"
59 #include "clang/Serialization/ASTBitCodes.h"
60 #include "clang/Serialization/ASTReader.h"
61 #include "clang/Serialization/ASTWriter.h"
62 #include "clang/Serialization/ContinuousRangeMap.h"
63 #include "clang/Serialization/InMemoryModuleCache.h"
64 #include "clang/Serialization/ModuleFile.h"
65 #include "clang/Serialization/PCHContainerOperations.h"
66 #include "llvm/ADT/ArrayRef.h"
67 #include "llvm/ADT/DenseMap.h"
68 #include "llvm/ADT/IntrusiveRefCntPtr.h"
69 #include "llvm/ADT/None.h"
70 #include "llvm/ADT/Optional.h"
71 #include "llvm/ADT/STLExtras.h"
72 #include "llvm/ADT/ScopeExit.h"
73 #include "llvm/ADT/SmallString.h"
74 #include "llvm/ADT/SmallVector.h"
75 #include "llvm/ADT/StringMap.h"
76 #include "llvm/ADT/StringRef.h"
77 #include "llvm/ADT/StringSet.h"
78 #include "llvm/ADT/Twine.h"
79 #include "llvm/ADT/iterator_range.h"
80 #include "llvm/Bitstream/BitstreamWriter.h"
81 #include "llvm/Support/Allocator.h"
82 #include "llvm/Support/Casting.h"
83 #include "llvm/Support/CrashRecoveryContext.h"
84 #include "llvm/Support/DJB.h"
85 #include "llvm/Support/ErrorHandling.h"
86 #include "llvm/Support/ErrorOr.h"
87 #include "llvm/Support/FileSystem.h"
88 #include "llvm/Support/FileUtilities.h"
89 #include "llvm/Support/MemoryBuffer.h"
90 #include "llvm/Support/Timer.h"
91 #include "llvm/Support/VirtualFileSystem.h"
92 #include "llvm/Support/raw_ostream.h"
93 #include <algorithm>
94 #include <atomic>
95 #include <cassert>
96 #include <cstdint>
97 #include <cstdio>
98 #include <cstdlib>
99 #include <memory>
100 #include <mutex>
101 #include <string>
102 #include <tuple>
103 #include <utility>
104 #include <vector>
105
106 using namespace clang;
107
108 using llvm::TimeRecord;
109
110 namespace {
111
112 class SimpleTimer {
113 bool WantTiming;
114 TimeRecord Start;
115 std::string Output;
116
117 public:
SimpleTimer(bool WantTiming)118 explicit SimpleTimer(bool WantTiming) : WantTiming(WantTiming) {
119 if (WantTiming)
120 Start = TimeRecord::getCurrentTime();
121 }
122
~SimpleTimer()123 ~SimpleTimer() {
124 if (WantTiming) {
125 TimeRecord Elapsed = TimeRecord::getCurrentTime();
126 Elapsed -= Start;
127 llvm::errs() << Output << ':';
128 Elapsed.print(Elapsed, llvm::errs());
129 llvm::errs() << '\n';
130 }
131 }
132
setOutput(const Twine & Output)133 void setOutput(const Twine &Output) {
134 if (WantTiming)
135 this->Output = Output.str();
136 }
137 };
138
139 } // namespace
140
141 template <class T>
valueOrNull(llvm::ErrorOr<std::unique_ptr<T>> Val)142 static std::unique_ptr<T> valueOrNull(llvm::ErrorOr<std::unique_ptr<T>> Val) {
143 if (!Val)
144 return nullptr;
145 return std::move(*Val);
146 }
147
148 template <class T>
moveOnNoError(llvm::ErrorOr<T> Val,T & Output)149 static bool moveOnNoError(llvm::ErrorOr<T> Val, T &Output) {
150 if (!Val)
151 return false;
152 Output = std::move(*Val);
153 return true;
154 }
155
156 /// Get a source buffer for \p MainFilePath, handling all file-to-file
157 /// and file-to-buffer remappings inside \p Invocation.
158 static std::unique_ptr<llvm::MemoryBuffer>
getBufferForFileHandlingRemapping(const CompilerInvocation & Invocation,llvm::vfs::FileSystem * VFS,StringRef FilePath,bool isVolatile)159 getBufferForFileHandlingRemapping(const CompilerInvocation &Invocation,
160 llvm::vfs::FileSystem *VFS,
161 StringRef FilePath, bool isVolatile) {
162 const auto &PreprocessorOpts = Invocation.getPreprocessorOpts();
163
164 // Try to determine if the main file has been remapped, either from the
165 // command line (to another file) or directly through the compiler
166 // invocation (to a memory buffer).
167 llvm::MemoryBuffer *Buffer = nullptr;
168 std::unique_ptr<llvm::MemoryBuffer> BufferOwner;
169 auto FileStatus = VFS->status(FilePath);
170 if (FileStatus) {
171 llvm::sys::fs::UniqueID MainFileID = FileStatus->getUniqueID();
172
173 // Check whether there is a file-file remapping of the main file
174 for (const auto &RF : PreprocessorOpts.RemappedFiles) {
175 std::string MPath(RF.first);
176 auto MPathStatus = VFS->status(MPath);
177 if (MPathStatus) {
178 llvm::sys::fs::UniqueID MID = MPathStatus->getUniqueID();
179 if (MainFileID == MID) {
180 // We found a remapping. Try to load the resulting, remapped source.
181 BufferOwner = valueOrNull(VFS->getBufferForFile(RF.second, -1, true, isVolatile));
182 if (!BufferOwner)
183 return nullptr;
184 }
185 }
186 }
187
188 // Check whether there is a file-buffer remapping. It supercedes the
189 // file-file remapping.
190 for (const auto &RB : PreprocessorOpts.RemappedFileBuffers) {
191 std::string MPath(RB.first);
192 auto MPathStatus = VFS->status(MPath);
193 if (MPathStatus) {
194 llvm::sys::fs::UniqueID MID = MPathStatus->getUniqueID();
195 if (MainFileID == MID) {
196 // We found a remapping.
197 BufferOwner.reset();
198 Buffer = const_cast<llvm::MemoryBuffer *>(RB.second);
199 }
200 }
201 }
202 }
203
204 // If the main source file was not remapped, load it now.
205 if (!Buffer && !BufferOwner) {
206 BufferOwner = valueOrNull(VFS->getBufferForFile(FilePath, -1, true, isVolatile));
207 if (!BufferOwner)
208 return nullptr;
209 }
210
211 if (BufferOwner)
212 return BufferOwner;
213 if (!Buffer)
214 return nullptr;
215 return llvm::MemoryBuffer::getMemBufferCopy(Buffer->getBuffer(), FilePath);
216 }
217
218 struct ASTUnit::ASTWriterData {
219 SmallString<128> Buffer;
220 llvm::BitstreamWriter Stream;
221 ASTWriter Writer;
222
ASTWriterDataASTUnit::ASTWriterData223 ASTWriterData(InMemoryModuleCache &ModuleCache)
224 : Stream(Buffer), Writer(Stream, Buffer, ModuleCache, {}) {}
225 };
226
clearFileLevelDecls()227 void ASTUnit::clearFileLevelDecls() {
228 FileDecls.clear();
229 }
230
231 /// After failing to build a precompiled preamble (due to
232 /// errors in the source that occurs in the preamble), the number of
233 /// reparses during which we'll skip even trying to precompile the
234 /// preamble.
235 const unsigned DefaultPreambleRebuildInterval = 5;
236
237 /// Tracks the number of ASTUnit objects that are currently active.
238 ///
239 /// Used for debugging purposes only.
240 static std::atomic<unsigned> ActiveASTUnitObjects;
241
ASTUnit(bool _MainFileIsAST)242 ASTUnit::ASTUnit(bool _MainFileIsAST)
243 : MainFileIsAST(_MainFileIsAST), WantTiming(getenv("LIBCLANG_TIMING")),
244 ShouldCacheCodeCompletionResults(false),
245 IncludeBriefCommentsInCodeCompletion(false), UserFilesAreVolatile(false),
246 UnsafeToFree(false) {
247 if (getenv("LIBCLANG_OBJTRACKING"))
248 fprintf(stderr, "+++ %u translation units\n", ++ActiveASTUnitObjects);
249 }
250
~ASTUnit()251 ASTUnit::~ASTUnit() {
252 // If we loaded from an AST file, balance out the BeginSourceFile call.
253 if (MainFileIsAST && getDiagnostics().getClient()) {
254 getDiagnostics().getClient()->EndSourceFile();
255 }
256
257 clearFileLevelDecls();
258
259 // Free the buffers associated with remapped files. We are required to
260 // perform this operation here because we explicitly request that the
261 // compiler instance *not* free these buffers for each invocation of the
262 // parser.
263 if (Invocation && OwnsRemappedFileBuffers) {
264 PreprocessorOptions &PPOpts = Invocation->getPreprocessorOpts();
265 for (const auto &RB : PPOpts.RemappedFileBuffers)
266 delete RB.second;
267 }
268
269 ClearCachedCompletionResults();
270
271 if (getenv("LIBCLANG_OBJTRACKING"))
272 fprintf(stderr, "--- %u translation units\n", --ActiveASTUnitObjects);
273 }
274
setPreprocessor(std::shared_ptr<Preprocessor> PP)275 void ASTUnit::setPreprocessor(std::shared_ptr<Preprocessor> PP) {
276 this->PP = std::move(PP);
277 }
278
enableSourceFileDiagnostics()279 void ASTUnit::enableSourceFileDiagnostics() {
280 assert(getDiagnostics().getClient() && Ctx &&
281 "Bad context for source file");
282 getDiagnostics().getClient()->BeginSourceFile(Ctx->getLangOpts(), PP.get());
283 }
284
285 /// Determine the set of code-completion contexts in which this
286 /// declaration should be shown.
getDeclShowContexts(const NamedDecl * ND,const LangOptions & LangOpts,bool & IsNestedNameSpecifier)287 static uint64_t getDeclShowContexts(const NamedDecl *ND,
288 const LangOptions &LangOpts,
289 bool &IsNestedNameSpecifier) {
290 IsNestedNameSpecifier = false;
291
292 if (isa<UsingShadowDecl>(ND))
293 ND = ND->getUnderlyingDecl();
294 if (!ND)
295 return 0;
296
297 uint64_t Contexts = 0;
298 if (isa<TypeDecl>(ND) || isa<ObjCInterfaceDecl>(ND) ||
299 isa<ClassTemplateDecl>(ND) || isa<TemplateTemplateParmDecl>(ND) ||
300 isa<TypeAliasTemplateDecl>(ND)) {
301 // Types can appear in these contexts.
302 if (LangOpts.CPlusPlus || !isa<TagDecl>(ND))
303 Contexts |= (1LL << CodeCompletionContext::CCC_TopLevel)
304 | (1LL << CodeCompletionContext::CCC_ObjCIvarList)
305 | (1LL << CodeCompletionContext::CCC_ClassStructUnion)
306 | (1LL << CodeCompletionContext::CCC_Statement)
307 | (1LL << CodeCompletionContext::CCC_Type)
308 | (1LL << CodeCompletionContext::CCC_ParenthesizedExpression);
309
310 // In C++, types can appear in expressions contexts (for functional casts).
311 if (LangOpts.CPlusPlus)
312 Contexts |= (1LL << CodeCompletionContext::CCC_Expression);
313
314 // In Objective-C, message sends can send interfaces. In Objective-C++,
315 // all types are available due to functional casts.
316 if (LangOpts.CPlusPlus || isa<ObjCInterfaceDecl>(ND))
317 Contexts |= (1LL << CodeCompletionContext::CCC_ObjCMessageReceiver);
318
319 // In Objective-C, you can only be a subclass of another Objective-C class
320 if (const auto *ID = dyn_cast<ObjCInterfaceDecl>(ND)) {
321 // Objective-C interfaces can be used in a class property expression.
322 if (ID->getDefinition())
323 Contexts |= (1LL << CodeCompletionContext::CCC_Expression);
324 Contexts |= (1LL << CodeCompletionContext::CCC_ObjCInterfaceName);
325 }
326
327 // Deal with tag names.
328 if (isa<EnumDecl>(ND)) {
329 Contexts |= (1LL << CodeCompletionContext::CCC_EnumTag);
330
331 // Part of the nested-name-specifier in C++0x.
332 if (LangOpts.CPlusPlus11)
333 IsNestedNameSpecifier = true;
334 } else if (const auto *Record = dyn_cast<RecordDecl>(ND)) {
335 if (Record->isUnion())
336 Contexts |= (1LL << CodeCompletionContext::CCC_UnionTag);
337 else
338 Contexts |= (1LL << CodeCompletionContext::CCC_ClassOrStructTag);
339
340 if (LangOpts.CPlusPlus)
341 IsNestedNameSpecifier = true;
342 } else if (isa<ClassTemplateDecl>(ND))
343 IsNestedNameSpecifier = true;
344 } else if (isa<ValueDecl>(ND) || isa<FunctionTemplateDecl>(ND)) {
345 // Values can appear in these contexts.
346 Contexts = (1LL << CodeCompletionContext::CCC_Statement)
347 | (1LL << CodeCompletionContext::CCC_Expression)
348 | (1LL << CodeCompletionContext::CCC_ParenthesizedExpression)
349 | (1LL << CodeCompletionContext::CCC_ObjCMessageReceiver);
350 } else if (isa<ObjCProtocolDecl>(ND)) {
351 Contexts = (1LL << CodeCompletionContext::CCC_ObjCProtocolName);
352 } else if (isa<ObjCCategoryDecl>(ND)) {
353 Contexts = (1LL << CodeCompletionContext::CCC_ObjCCategoryName);
354 } else if (isa<NamespaceDecl>(ND) || isa<NamespaceAliasDecl>(ND)) {
355 Contexts = (1LL << CodeCompletionContext::CCC_Namespace);
356
357 // Part of the nested-name-specifier.
358 IsNestedNameSpecifier = true;
359 }
360
361 return Contexts;
362 }
363
CacheCodeCompletionResults()364 void ASTUnit::CacheCodeCompletionResults() {
365 if (!TheSema)
366 return;
367
368 SimpleTimer Timer(WantTiming);
369 Timer.setOutput("Cache global code completions for " + getMainFileName());
370
371 // Clear out the previous results.
372 ClearCachedCompletionResults();
373
374 // Gather the set of global code completions.
375 using Result = CodeCompletionResult;
376 SmallVector<Result, 8> Results;
377 CachedCompletionAllocator = std::make_shared<GlobalCodeCompletionAllocator>();
378 CodeCompletionTUInfo CCTUInfo(CachedCompletionAllocator);
379 TheSema->GatherGlobalCodeCompletions(*CachedCompletionAllocator,
380 CCTUInfo, Results);
381
382 // Translate global code completions into cached completions.
383 llvm::DenseMap<CanQualType, unsigned> CompletionTypes;
384 CodeCompletionContext CCContext(CodeCompletionContext::CCC_TopLevel);
385
386 for (auto &R : Results) {
387 switch (R.Kind) {
388 case Result::RK_Declaration: {
389 bool IsNestedNameSpecifier = false;
390 CachedCodeCompletionResult CachedResult;
391 CachedResult.Completion = R.CreateCodeCompletionString(
392 *TheSema, CCContext, *CachedCompletionAllocator, CCTUInfo,
393 IncludeBriefCommentsInCodeCompletion);
394 CachedResult.ShowInContexts = getDeclShowContexts(
395 R.Declaration, Ctx->getLangOpts(), IsNestedNameSpecifier);
396 CachedResult.Priority = R.Priority;
397 CachedResult.Kind = R.CursorKind;
398 CachedResult.Availability = R.Availability;
399
400 // Keep track of the type of this completion in an ASTContext-agnostic
401 // way.
402 QualType UsageType = getDeclUsageType(*Ctx, R.Declaration);
403 if (UsageType.isNull()) {
404 CachedResult.TypeClass = STC_Void;
405 CachedResult.Type = 0;
406 } else {
407 CanQualType CanUsageType
408 = Ctx->getCanonicalType(UsageType.getUnqualifiedType());
409 CachedResult.TypeClass = getSimplifiedTypeClass(CanUsageType);
410
411 // Determine whether we have already seen this type. If so, we save
412 // ourselves the work of formatting the type string by using the
413 // temporary, CanQualType-based hash table to find the associated value.
414 unsigned &TypeValue = CompletionTypes[CanUsageType];
415 if (TypeValue == 0) {
416 TypeValue = CompletionTypes.size();
417 CachedCompletionTypes[QualType(CanUsageType).getAsString()]
418 = TypeValue;
419 }
420
421 CachedResult.Type = TypeValue;
422 }
423
424 CachedCompletionResults.push_back(CachedResult);
425
426 /// Handle nested-name-specifiers in C++.
427 if (TheSema->Context.getLangOpts().CPlusPlus && IsNestedNameSpecifier &&
428 !R.StartsNestedNameSpecifier) {
429 // The contexts in which a nested-name-specifier can appear in C++.
430 uint64_t NNSContexts
431 = (1LL << CodeCompletionContext::CCC_TopLevel)
432 | (1LL << CodeCompletionContext::CCC_ObjCIvarList)
433 | (1LL << CodeCompletionContext::CCC_ClassStructUnion)
434 | (1LL << CodeCompletionContext::CCC_Statement)
435 | (1LL << CodeCompletionContext::CCC_Expression)
436 | (1LL << CodeCompletionContext::CCC_ObjCMessageReceiver)
437 | (1LL << CodeCompletionContext::CCC_EnumTag)
438 | (1LL << CodeCompletionContext::CCC_UnionTag)
439 | (1LL << CodeCompletionContext::CCC_ClassOrStructTag)
440 | (1LL << CodeCompletionContext::CCC_Type)
441 | (1LL << CodeCompletionContext::CCC_SymbolOrNewName)
442 | (1LL << CodeCompletionContext::CCC_ParenthesizedExpression);
443
444 if (isa<NamespaceDecl>(R.Declaration) ||
445 isa<NamespaceAliasDecl>(R.Declaration))
446 NNSContexts |= (1LL << CodeCompletionContext::CCC_Namespace);
447
448 if (uint64_t RemainingContexts
449 = NNSContexts & ~CachedResult.ShowInContexts) {
450 // If there any contexts where this completion can be a
451 // nested-name-specifier but isn't already an option, create a
452 // nested-name-specifier completion.
453 R.StartsNestedNameSpecifier = true;
454 CachedResult.Completion = R.CreateCodeCompletionString(
455 *TheSema, CCContext, *CachedCompletionAllocator, CCTUInfo,
456 IncludeBriefCommentsInCodeCompletion);
457 CachedResult.ShowInContexts = RemainingContexts;
458 CachedResult.Priority = CCP_NestedNameSpecifier;
459 CachedResult.TypeClass = STC_Void;
460 CachedResult.Type = 0;
461 CachedCompletionResults.push_back(CachedResult);
462 }
463 }
464 break;
465 }
466
467 case Result::RK_Keyword:
468 case Result::RK_Pattern:
469 // Ignore keywords and patterns; we don't care, since they are so
470 // easily regenerated.
471 break;
472
473 case Result::RK_Macro: {
474 CachedCodeCompletionResult CachedResult;
475 CachedResult.Completion = R.CreateCodeCompletionString(
476 *TheSema, CCContext, *CachedCompletionAllocator, CCTUInfo,
477 IncludeBriefCommentsInCodeCompletion);
478 CachedResult.ShowInContexts
479 = (1LL << CodeCompletionContext::CCC_TopLevel)
480 | (1LL << CodeCompletionContext::CCC_ObjCInterface)
481 | (1LL << CodeCompletionContext::CCC_ObjCImplementation)
482 | (1LL << CodeCompletionContext::CCC_ObjCIvarList)
483 | (1LL << CodeCompletionContext::CCC_ClassStructUnion)
484 | (1LL << CodeCompletionContext::CCC_Statement)
485 | (1LL << CodeCompletionContext::CCC_Expression)
486 | (1LL << CodeCompletionContext::CCC_ObjCMessageReceiver)
487 | (1LL << CodeCompletionContext::CCC_MacroNameUse)
488 | (1LL << CodeCompletionContext::CCC_PreprocessorExpression)
489 | (1LL << CodeCompletionContext::CCC_ParenthesizedExpression)
490 | (1LL << CodeCompletionContext::CCC_OtherWithMacros);
491
492 CachedResult.Priority = R.Priority;
493 CachedResult.Kind = R.CursorKind;
494 CachedResult.Availability = R.Availability;
495 CachedResult.TypeClass = STC_Void;
496 CachedResult.Type = 0;
497 CachedCompletionResults.push_back(CachedResult);
498 break;
499 }
500 }
501 }
502
503 // Save the current top-level hash value.
504 CompletionCacheTopLevelHashValue = CurrentTopLevelHashValue;
505 }
506
ClearCachedCompletionResults()507 void ASTUnit::ClearCachedCompletionResults() {
508 CachedCompletionResults.clear();
509 CachedCompletionTypes.clear();
510 CachedCompletionAllocator = nullptr;
511 }
512
513 namespace {
514
515 /// Gathers information from ASTReader that will be used to initialize
516 /// a Preprocessor.
517 class ASTInfoCollector : public ASTReaderListener {
518 Preprocessor &PP;
519 ASTContext *Context;
520 HeaderSearchOptions &HSOpts;
521 PreprocessorOptions &PPOpts;
522 LangOptions &LangOpt;
523 std::shared_ptr<TargetOptions> &TargetOpts;
524 IntrusiveRefCntPtr<TargetInfo> &Target;
525 unsigned &Counter;
526 bool InitializedLanguage = false;
527
528 public:
ASTInfoCollector(Preprocessor & PP,ASTContext * Context,HeaderSearchOptions & HSOpts,PreprocessorOptions & PPOpts,LangOptions & LangOpt,std::shared_ptr<TargetOptions> & TargetOpts,IntrusiveRefCntPtr<TargetInfo> & Target,unsigned & Counter)529 ASTInfoCollector(Preprocessor &PP, ASTContext *Context,
530 HeaderSearchOptions &HSOpts, PreprocessorOptions &PPOpts,
531 LangOptions &LangOpt,
532 std::shared_ptr<TargetOptions> &TargetOpts,
533 IntrusiveRefCntPtr<TargetInfo> &Target, unsigned &Counter)
534 : PP(PP), Context(Context), HSOpts(HSOpts), PPOpts(PPOpts),
535 LangOpt(LangOpt), TargetOpts(TargetOpts), Target(Target),
536 Counter(Counter) {}
537
ReadLanguageOptions(const LangOptions & LangOpts,bool Complain,bool AllowCompatibleDifferences)538 bool ReadLanguageOptions(const LangOptions &LangOpts, bool Complain,
539 bool AllowCompatibleDifferences) override {
540 if (InitializedLanguage)
541 return false;
542
543 LangOpt = LangOpts;
544 InitializedLanguage = true;
545
546 updated();
547 return false;
548 }
549
ReadHeaderSearchOptions(const HeaderSearchOptions & HSOpts,StringRef SpecificModuleCachePath,bool Complain)550 bool ReadHeaderSearchOptions(const HeaderSearchOptions &HSOpts,
551 StringRef SpecificModuleCachePath,
552 bool Complain) override {
553 this->HSOpts = HSOpts;
554 return false;
555 }
556
ReadPreprocessorOptions(const PreprocessorOptions & PPOpts,bool Complain,std::string & SuggestedPredefines)557 bool ReadPreprocessorOptions(const PreprocessorOptions &PPOpts, bool Complain,
558 std::string &SuggestedPredefines) override {
559 this->PPOpts = PPOpts;
560 return false;
561 }
562
ReadTargetOptions(const TargetOptions & TargetOpts,bool Complain,bool AllowCompatibleDifferences)563 bool ReadTargetOptions(const TargetOptions &TargetOpts, bool Complain,
564 bool AllowCompatibleDifferences) override {
565 // If we've already initialized the target, don't do it again.
566 if (Target)
567 return false;
568
569 this->TargetOpts = std::make_shared<TargetOptions>(TargetOpts);
570 Target =
571 TargetInfo::CreateTargetInfo(PP.getDiagnostics(), this->TargetOpts);
572
573 updated();
574 return false;
575 }
576
ReadCounter(const serialization::ModuleFile & M,unsigned Value)577 void ReadCounter(const serialization::ModuleFile &M,
578 unsigned Value) override {
579 Counter = Value;
580 }
581
582 private:
updated()583 void updated() {
584 if (!Target || !InitializedLanguage)
585 return;
586
587 // Inform the target of the language options.
588 //
589 // FIXME: We shouldn't need to do this, the target should be immutable once
590 // created. This complexity should be lifted elsewhere.
591 Target->adjust(PP.getDiagnostics(), LangOpt);
592
593 // Initialize the preprocessor.
594 PP.Initialize(*Target);
595
596 if (!Context)
597 return;
598
599 // Initialize the ASTContext
600 Context->InitBuiltinTypes(*Target);
601
602 // Adjust printing policy based on language options.
603 Context->setPrintingPolicy(PrintingPolicy(LangOpt));
604
605 // We didn't have access to the comment options when the ASTContext was
606 // constructed, so register them now.
607 Context->getCommentCommandTraits().registerCommentOptions(
608 LangOpt.CommentOpts);
609 }
610 };
611
612 /// Diagnostic consumer that saves each diagnostic it is given.
613 class FilterAndStoreDiagnosticConsumer : public DiagnosticConsumer {
614 SmallVectorImpl<StoredDiagnostic> *StoredDiags;
615 SmallVectorImpl<ASTUnit::StandaloneDiagnostic> *StandaloneDiags;
616 bool CaptureNonErrorsFromIncludes = true;
617 const LangOptions *LangOpts = nullptr;
618 SourceManager *SourceMgr = nullptr;
619
620 public:
FilterAndStoreDiagnosticConsumer(SmallVectorImpl<StoredDiagnostic> * StoredDiags,SmallVectorImpl<ASTUnit::StandaloneDiagnostic> * StandaloneDiags,bool CaptureNonErrorsFromIncludes)621 FilterAndStoreDiagnosticConsumer(
622 SmallVectorImpl<StoredDiagnostic> *StoredDiags,
623 SmallVectorImpl<ASTUnit::StandaloneDiagnostic> *StandaloneDiags,
624 bool CaptureNonErrorsFromIncludes)
625 : StoredDiags(StoredDiags), StandaloneDiags(StandaloneDiags),
626 CaptureNonErrorsFromIncludes(CaptureNonErrorsFromIncludes) {
627 assert((StoredDiags || StandaloneDiags) &&
628 "No output collections were passed to StoredDiagnosticConsumer.");
629 }
630
BeginSourceFile(const LangOptions & LangOpts,const Preprocessor * PP=nullptr)631 void BeginSourceFile(const LangOptions &LangOpts,
632 const Preprocessor *PP = nullptr) override {
633 this->LangOpts = &LangOpts;
634 if (PP)
635 SourceMgr = &PP->getSourceManager();
636 }
637
638 void HandleDiagnostic(DiagnosticsEngine::Level Level,
639 const Diagnostic &Info) override;
640 };
641
642 /// RAII object that optionally captures and filters diagnostics, if
643 /// there is no diagnostic client to capture them already.
644 class CaptureDroppedDiagnostics {
645 DiagnosticsEngine &Diags;
646 FilterAndStoreDiagnosticConsumer Client;
647 DiagnosticConsumer *PreviousClient = nullptr;
648 std::unique_ptr<DiagnosticConsumer> OwningPreviousClient;
649
650 public:
CaptureDroppedDiagnostics(CaptureDiagsKind CaptureDiagnostics,DiagnosticsEngine & Diags,SmallVectorImpl<StoredDiagnostic> * StoredDiags,SmallVectorImpl<ASTUnit::StandaloneDiagnostic> * StandaloneDiags)651 CaptureDroppedDiagnostics(
652 CaptureDiagsKind CaptureDiagnostics, DiagnosticsEngine &Diags,
653 SmallVectorImpl<StoredDiagnostic> *StoredDiags,
654 SmallVectorImpl<ASTUnit::StandaloneDiagnostic> *StandaloneDiags)
655 : Diags(Diags),
656 Client(StoredDiags, StandaloneDiags,
657 CaptureDiagnostics !=
658 CaptureDiagsKind::AllWithoutNonErrorsFromIncludes) {
659 if (CaptureDiagnostics != CaptureDiagsKind::None ||
660 Diags.getClient() == nullptr) {
661 OwningPreviousClient = Diags.takeClient();
662 PreviousClient = Diags.getClient();
663 Diags.setClient(&Client, false);
664 }
665 }
666
~CaptureDroppedDiagnostics()667 ~CaptureDroppedDiagnostics() {
668 if (Diags.getClient() == &Client)
669 Diags.setClient(PreviousClient, !!OwningPreviousClient.release());
670 }
671 };
672
673 } // namespace
674
675 static ASTUnit::StandaloneDiagnostic
676 makeStandaloneDiagnostic(const LangOptions &LangOpts,
677 const StoredDiagnostic &InDiag);
678
isInMainFile(const clang::Diagnostic & D)679 static bool isInMainFile(const clang::Diagnostic &D) {
680 if (!D.hasSourceManager() || !D.getLocation().isValid())
681 return false;
682
683 auto &M = D.getSourceManager();
684 return M.isWrittenInMainFile(M.getExpansionLoc(D.getLocation()));
685 }
686
HandleDiagnostic(DiagnosticsEngine::Level Level,const Diagnostic & Info)687 void FilterAndStoreDiagnosticConsumer::HandleDiagnostic(
688 DiagnosticsEngine::Level Level, const Diagnostic &Info) {
689 // Default implementation (Warnings/errors count).
690 DiagnosticConsumer::HandleDiagnostic(Level, Info);
691
692 // Only record the diagnostic if it's part of the source manager we know
693 // about. This effectively drops diagnostics from modules we're building.
694 // FIXME: In the long run, ee don't want to drop source managers from modules.
695 if (!Info.hasSourceManager() || &Info.getSourceManager() == SourceMgr) {
696 if (!CaptureNonErrorsFromIncludes && Level <= DiagnosticsEngine::Warning &&
697 !isInMainFile(Info)) {
698 return;
699 }
700
701 StoredDiagnostic *ResultDiag = nullptr;
702 if (StoredDiags) {
703 StoredDiags->emplace_back(Level, Info);
704 ResultDiag = &StoredDiags->back();
705 }
706
707 if (StandaloneDiags) {
708 llvm::Optional<StoredDiagnostic> StoredDiag = None;
709 if (!ResultDiag) {
710 StoredDiag.emplace(Level, Info);
711 ResultDiag = StoredDiag.getPointer();
712 }
713 StandaloneDiags->push_back(
714 makeStandaloneDiagnostic(*LangOpts, *ResultDiag));
715 }
716 }
717 }
718
getASTReader() const719 IntrusiveRefCntPtr<ASTReader> ASTUnit::getASTReader() const {
720 return Reader;
721 }
722
getASTMutationListener()723 ASTMutationListener *ASTUnit::getASTMutationListener() {
724 if (WriterData)
725 return &WriterData->Writer;
726 return nullptr;
727 }
728
getDeserializationListener()729 ASTDeserializationListener *ASTUnit::getDeserializationListener() {
730 if (WriterData)
731 return &WriterData->Writer;
732 return nullptr;
733 }
734
735 std::unique_ptr<llvm::MemoryBuffer>
getBufferForFile(StringRef Filename,std::string * ErrorStr)736 ASTUnit::getBufferForFile(StringRef Filename, std::string *ErrorStr) {
737 assert(FileMgr);
738 auto Buffer = FileMgr->getBufferForFile(Filename, UserFilesAreVolatile);
739 if (Buffer)
740 return std::move(*Buffer);
741 if (ErrorStr)
742 *ErrorStr = Buffer.getError().message();
743 return nullptr;
744 }
745
746 /// Configure the diagnostics object for use with ASTUnit.
ConfigureDiags(IntrusiveRefCntPtr<DiagnosticsEngine> Diags,ASTUnit & AST,CaptureDiagsKind CaptureDiagnostics)747 void ASTUnit::ConfigureDiags(IntrusiveRefCntPtr<DiagnosticsEngine> Diags,
748 ASTUnit &AST,
749 CaptureDiagsKind CaptureDiagnostics) {
750 assert(Diags.get() && "no DiagnosticsEngine was provided");
751 if (CaptureDiagnostics != CaptureDiagsKind::None)
752 Diags->setClient(new FilterAndStoreDiagnosticConsumer(
753 &AST.StoredDiagnostics, nullptr,
754 CaptureDiagnostics != CaptureDiagsKind::AllWithoutNonErrorsFromIncludes));
755 }
756
LoadFromASTFile(const std::string & Filename,const PCHContainerReader & PCHContainerRdr,WhatToLoad ToLoad,IntrusiveRefCntPtr<DiagnosticsEngine> Diags,const FileSystemOptions & FileSystemOpts,bool UseDebugInfo,bool OnlyLocalDecls,CaptureDiagsKind CaptureDiagnostics,bool AllowASTWithCompilerErrors,bool UserFilesAreVolatile)757 std::unique_ptr<ASTUnit> ASTUnit::LoadFromASTFile(
758 const std::string &Filename, const PCHContainerReader &PCHContainerRdr,
759 WhatToLoad ToLoad, IntrusiveRefCntPtr<DiagnosticsEngine> Diags,
760 const FileSystemOptions &FileSystemOpts, bool UseDebugInfo,
761 bool OnlyLocalDecls, CaptureDiagsKind CaptureDiagnostics,
762 bool AllowASTWithCompilerErrors, bool UserFilesAreVolatile) {
763 std::unique_ptr<ASTUnit> AST(new ASTUnit(true));
764
765 // Recover resources if we crash before exiting this method.
766 llvm::CrashRecoveryContextCleanupRegistrar<ASTUnit>
767 ASTUnitCleanup(AST.get());
768 llvm::CrashRecoveryContextCleanupRegistrar<DiagnosticsEngine,
769 llvm::CrashRecoveryContextReleaseRefCleanup<DiagnosticsEngine>>
770 DiagCleanup(Diags.get());
771
772 ConfigureDiags(Diags, *AST, CaptureDiagnostics);
773
774 AST->LangOpts = std::make_shared<LangOptions>();
775 AST->OnlyLocalDecls = OnlyLocalDecls;
776 AST->CaptureDiagnostics = CaptureDiagnostics;
777 AST->Diagnostics = Diags;
778 IntrusiveRefCntPtr<llvm::vfs::FileSystem> VFS =
779 llvm::vfs::getRealFileSystem();
780 AST->FileMgr = new FileManager(FileSystemOpts, VFS);
781 AST->UserFilesAreVolatile = UserFilesAreVolatile;
782 AST->SourceMgr = new SourceManager(AST->getDiagnostics(),
783 AST->getFileManager(),
784 UserFilesAreVolatile);
785 AST->ModuleCache = new InMemoryModuleCache;
786 AST->HSOpts = std::make_shared<HeaderSearchOptions>();
787 AST->HSOpts->ModuleFormat = std::string(PCHContainerRdr.getFormat());
788 AST->HeaderInfo.reset(new HeaderSearch(AST->HSOpts,
789 AST->getSourceManager(),
790 AST->getDiagnostics(),
791 AST->getLangOpts(),
792 /*Target=*/nullptr));
793 AST->PPOpts = std::make_shared<PreprocessorOptions>();
794
795 // Gather Info for preprocessor construction later on.
796
797 HeaderSearch &HeaderInfo = *AST->HeaderInfo;
798 unsigned Counter;
799
800 AST->PP = std::make_shared<Preprocessor>(
801 AST->PPOpts, AST->getDiagnostics(), *AST->LangOpts,
802 AST->getSourceManager(), HeaderInfo, AST->ModuleLoader,
803 /*IILookup=*/nullptr,
804 /*OwnsHeaderSearch=*/false);
805 Preprocessor &PP = *AST->PP;
806
807 if (ToLoad >= LoadASTOnly)
808 AST->Ctx = new ASTContext(*AST->LangOpts, AST->getSourceManager(),
809 PP.getIdentifierTable(), PP.getSelectorTable(),
810 PP.getBuiltinInfo(),
811 AST->getTranslationUnitKind());
812
813 DisableValidationForModuleKind disableValid =
814 DisableValidationForModuleKind::None;
815 if (::getenv("LIBCLANG_DISABLE_PCH_VALIDATION"))
816 disableValid = DisableValidationForModuleKind::All;
817 AST->Reader = new ASTReader(
818 PP, *AST->ModuleCache, AST->Ctx.get(), PCHContainerRdr, {},
819 /*isysroot=*/"",
820 /*DisableValidation=*/disableValid, AllowASTWithCompilerErrors);
821
822 AST->Reader->setListener(std::make_unique<ASTInfoCollector>(
823 *AST->PP, AST->Ctx.get(), *AST->HSOpts, *AST->PPOpts, *AST->LangOpts,
824 AST->TargetOpts, AST->Target, Counter));
825
826 // Attach the AST reader to the AST context as an external AST
827 // source, so that declarations will be deserialized from the
828 // AST file as needed.
829 // We need the external source to be set up before we read the AST, because
830 // eagerly-deserialized declarations may use it.
831 if (AST->Ctx)
832 AST->Ctx->setExternalSource(AST->Reader);
833
834 switch (AST->Reader->ReadAST(Filename, serialization::MK_MainFile,
835 SourceLocation(), ASTReader::ARR_None)) {
836 case ASTReader::Success:
837 break;
838
839 case ASTReader::Failure:
840 case ASTReader::Missing:
841 case ASTReader::OutOfDate:
842 case ASTReader::VersionMismatch:
843 case ASTReader::ConfigurationMismatch:
844 case ASTReader::HadErrors:
845 AST->getDiagnostics().Report(diag::err_fe_unable_to_load_pch);
846 return nullptr;
847 }
848
849 AST->OriginalSourceFile = std::string(AST->Reader->getOriginalSourceFile());
850
851 PP.setCounterValue(Counter);
852
853 // Create an AST consumer, even though it isn't used.
854 if (ToLoad >= LoadASTOnly)
855 AST->Consumer.reset(new ASTConsumer);
856
857 // Create a semantic analysis object and tell the AST reader about it.
858 if (ToLoad >= LoadEverything) {
859 AST->TheSema.reset(new Sema(PP, *AST->Ctx, *AST->Consumer));
860 AST->TheSema->Initialize();
861 AST->Reader->InitializeSema(*AST->TheSema);
862 }
863
864 // Tell the diagnostic client that we have started a source file.
865 AST->getDiagnostics().getClient()->BeginSourceFile(PP.getLangOpts(), &PP);
866
867 return AST;
868 }
869
870 /// Add the given macro to the hash of all top-level entities.
AddDefinedMacroToHash(const Token & MacroNameTok,unsigned & Hash)871 static void AddDefinedMacroToHash(const Token &MacroNameTok, unsigned &Hash) {
872 Hash = llvm::djbHash(MacroNameTok.getIdentifierInfo()->getName(), Hash);
873 }
874
875 namespace {
876
877 /// Preprocessor callback class that updates a hash value with the names
878 /// of all macros that have been defined by the translation unit.
879 class MacroDefinitionTrackerPPCallbacks : public PPCallbacks {
880 unsigned &Hash;
881
882 public:
MacroDefinitionTrackerPPCallbacks(unsigned & Hash)883 explicit MacroDefinitionTrackerPPCallbacks(unsigned &Hash) : Hash(Hash) {}
884
MacroDefined(const Token & MacroNameTok,const MacroDirective * MD)885 void MacroDefined(const Token &MacroNameTok,
886 const MacroDirective *MD) override {
887 AddDefinedMacroToHash(MacroNameTok, Hash);
888 }
889 };
890
891 } // namespace
892
893 /// Add the given declaration to the hash of all top-level entities.
AddTopLevelDeclarationToHash(Decl * D,unsigned & Hash)894 static void AddTopLevelDeclarationToHash(Decl *D, unsigned &Hash) {
895 if (!D)
896 return;
897
898 DeclContext *DC = D->getDeclContext();
899 if (!DC)
900 return;
901
902 if (!(DC->isTranslationUnit() || DC->getLookupParent()->isTranslationUnit()))
903 return;
904
905 if (const auto *ND = dyn_cast<NamedDecl>(D)) {
906 if (const auto *EnumD = dyn_cast<EnumDecl>(D)) {
907 // For an unscoped enum include the enumerators in the hash since they
908 // enter the top-level namespace.
909 if (!EnumD->isScoped()) {
910 for (const auto *EI : EnumD->enumerators()) {
911 if (EI->getIdentifier())
912 Hash = llvm::djbHash(EI->getIdentifier()->getName(), Hash);
913 }
914 }
915 }
916
917 if (ND->getIdentifier())
918 Hash = llvm::djbHash(ND->getIdentifier()->getName(), Hash);
919 else if (DeclarationName Name = ND->getDeclName()) {
920 std::string NameStr = Name.getAsString();
921 Hash = llvm::djbHash(NameStr, Hash);
922 }
923 return;
924 }
925
926 if (const auto *ImportD = dyn_cast<ImportDecl>(D)) {
927 if (const Module *Mod = ImportD->getImportedModule()) {
928 std::string ModName = Mod->getFullModuleName();
929 Hash = llvm::djbHash(ModName, Hash);
930 }
931 return;
932 }
933 }
934
935 namespace {
936
937 class TopLevelDeclTrackerConsumer : public ASTConsumer {
938 ASTUnit &Unit;
939 unsigned &Hash;
940
941 public:
TopLevelDeclTrackerConsumer(ASTUnit & _Unit,unsigned & Hash)942 TopLevelDeclTrackerConsumer(ASTUnit &_Unit, unsigned &Hash)
943 : Unit(_Unit), Hash(Hash) {
944 Hash = 0;
945 }
946
handleTopLevelDecl(Decl * D)947 void handleTopLevelDecl(Decl *D) {
948 if (!D)
949 return;
950
951 // FIXME: Currently ObjC method declarations are incorrectly being
952 // reported as top-level declarations, even though their DeclContext
953 // is the containing ObjC @interface/@implementation. This is a
954 // fundamental problem in the parser right now.
955 if (isa<ObjCMethodDecl>(D))
956 return;
957
958 AddTopLevelDeclarationToHash(D, Hash);
959 Unit.addTopLevelDecl(D);
960
961 handleFileLevelDecl(D);
962 }
963
handleFileLevelDecl(Decl * D)964 void handleFileLevelDecl(Decl *D) {
965 Unit.addFileLevelDecl(D);
966 if (auto *NSD = dyn_cast<NamespaceDecl>(D)) {
967 for (auto *I : NSD->decls())
968 handleFileLevelDecl(I);
969 }
970 }
971
HandleTopLevelDecl(DeclGroupRef D)972 bool HandleTopLevelDecl(DeclGroupRef D) override {
973 for (auto *TopLevelDecl : D)
974 handleTopLevelDecl(TopLevelDecl);
975 return true;
976 }
977
978 // We're not interested in "interesting" decls.
HandleInterestingDecl(DeclGroupRef)979 void HandleInterestingDecl(DeclGroupRef) override {}
980
HandleTopLevelDeclInObjCContainer(DeclGroupRef D)981 void HandleTopLevelDeclInObjCContainer(DeclGroupRef D) override {
982 for (auto *TopLevelDecl : D)
983 handleTopLevelDecl(TopLevelDecl);
984 }
985
GetASTMutationListener()986 ASTMutationListener *GetASTMutationListener() override {
987 return Unit.getASTMutationListener();
988 }
989
GetASTDeserializationListener()990 ASTDeserializationListener *GetASTDeserializationListener() override {
991 return Unit.getDeserializationListener();
992 }
993 };
994
995 class TopLevelDeclTrackerAction : public ASTFrontendAction {
996 public:
997 ASTUnit &Unit;
998
CreateASTConsumer(CompilerInstance & CI,StringRef InFile)999 std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
1000 StringRef InFile) override {
1001 CI.getPreprocessor().addPPCallbacks(
1002 std::make_unique<MacroDefinitionTrackerPPCallbacks>(
1003 Unit.getCurrentTopLevelHashValue()));
1004 return std::make_unique<TopLevelDeclTrackerConsumer>(
1005 Unit, Unit.getCurrentTopLevelHashValue());
1006 }
1007
1008 public:
TopLevelDeclTrackerAction(ASTUnit & _Unit)1009 TopLevelDeclTrackerAction(ASTUnit &_Unit) : Unit(_Unit) {}
1010
hasCodeCompletionSupport() const1011 bool hasCodeCompletionSupport() const override { return false; }
1012
getTranslationUnitKind()1013 TranslationUnitKind getTranslationUnitKind() override {
1014 return Unit.getTranslationUnitKind();
1015 }
1016 };
1017
1018 class ASTUnitPreambleCallbacks : public PreambleCallbacks {
1019 public:
getHash() const1020 unsigned getHash() const { return Hash; }
1021
takeTopLevelDecls()1022 std::vector<Decl *> takeTopLevelDecls() { return std::move(TopLevelDecls); }
1023
takeTopLevelDeclIDs()1024 std::vector<serialization::DeclID> takeTopLevelDeclIDs() {
1025 return std::move(TopLevelDeclIDs);
1026 }
1027
AfterPCHEmitted(ASTWriter & Writer)1028 void AfterPCHEmitted(ASTWriter &Writer) override {
1029 TopLevelDeclIDs.reserve(TopLevelDecls.size());
1030 for (const auto *D : TopLevelDecls) {
1031 // Invalid top-level decls may not have been serialized.
1032 if (D->isInvalidDecl())
1033 continue;
1034 TopLevelDeclIDs.push_back(Writer.getDeclID(D));
1035 }
1036 }
1037
HandleTopLevelDecl(DeclGroupRef DG)1038 void HandleTopLevelDecl(DeclGroupRef DG) override {
1039 for (auto *D : DG) {
1040 // FIXME: Currently ObjC method declarations are incorrectly being
1041 // reported as top-level declarations, even though their DeclContext
1042 // is the containing ObjC @interface/@implementation. This is a
1043 // fundamental problem in the parser right now.
1044 if (isa<ObjCMethodDecl>(D))
1045 continue;
1046 AddTopLevelDeclarationToHash(D, Hash);
1047 TopLevelDecls.push_back(D);
1048 }
1049 }
1050
createPPCallbacks()1051 std::unique_ptr<PPCallbacks> createPPCallbacks() override {
1052 return std::make_unique<MacroDefinitionTrackerPPCallbacks>(Hash);
1053 }
1054
1055 private:
1056 unsigned Hash = 0;
1057 std::vector<Decl *> TopLevelDecls;
1058 std::vector<serialization::DeclID> TopLevelDeclIDs;
1059 llvm::SmallVector<ASTUnit::StandaloneDiagnostic, 4> PreambleDiags;
1060 };
1061
1062 } // namespace
1063
isNonDriverDiag(const StoredDiagnostic & StoredDiag)1064 static bool isNonDriverDiag(const StoredDiagnostic &StoredDiag) {
1065 return StoredDiag.getLocation().isValid();
1066 }
1067
1068 static void
checkAndRemoveNonDriverDiags(SmallVectorImpl<StoredDiagnostic> & StoredDiags)1069 checkAndRemoveNonDriverDiags(SmallVectorImpl<StoredDiagnostic> &StoredDiags) {
1070 // Get rid of stored diagnostics except the ones from the driver which do not
1071 // have a source location.
1072 StoredDiags.erase(
1073 std::remove_if(StoredDiags.begin(), StoredDiags.end(), isNonDriverDiag),
1074 StoredDiags.end());
1075 }
1076
checkAndSanitizeDiags(SmallVectorImpl<StoredDiagnostic> & StoredDiagnostics,SourceManager & SM)1077 static void checkAndSanitizeDiags(SmallVectorImpl<StoredDiagnostic> &
1078 StoredDiagnostics,
1079 SourceManager &SM) {
1080 // The stored diagnostic has the old source manager in it; update
1081 // the locations to refer into the new source manager. Since we've
1082 // been careful to make sure that the source manager's state
1083 // before and after are identical, so that we can reuse the source
1084 // location itself.
1085 for (auto &SD : StoredDiagnostics) {
1086 if (SD.getLocation().isValid()) {
1087 FullSourceLoc Loc(SD.getLocation(), SM);
1088 SD.setLocation(Loc);
1089 }
1090 }
1091 }
1092
1093 /// Parse the source file into a translation unit using the given compiler
1094 /// invocation, replacing the current translation unit.
1095 ///
1096 /// \returns True if a failure occurred that causes the ASTUnit not to
1097 /// contain any translation-unit information, false otherwise.
Parse(std::shared_ptr<PCHContainerOperations> PCHContainerOps,std::unique_ptr<llvm::MemoryBuffer> OverrideMainBuffer,IntrusiveRefCntPtr<llvm::vfs::FileSystem> VFS)1098 bool ASTUnit::Parse(std::shared_ptr<PCHContainerOperations> PCHContainerOps,
1099 std::unique_ptr<llvm::MemoryBuffer> OverrideMainBuffer,
1100 IntrusiveRefCntPtr<llvm::vfs::FileSystem> VFS) {
1101 if (!Invocation)
1102 return true;
1103
1104 if (VFS && FileMgr)
1105 assert(VFS == &FileMgr->getVirtualFileSystem() &&
1106 "VFS passed to Parse and VFS in FileMgr are different");
1107
1108 auto CCInvocation = std::make_shared<CompilerInvocation>(*Invocation);
1109 if (OverrideMainBuffer) {
1110 assert(Preamble &&
1111 "No preamble was built, but OverrideMainBuffer is not null");
1112 Preamble->AddImplicitPreamble(*CCInvocation, VFS, OverrideMainBuffer.get());
1113 // VFS may have changed...
1114 }
1115
1116 // Create the compiler instance to use for building the AST.
1117 std::unique_ptr<CompilerInstance> Clang(
1118 new CompilerInstance(std::move(PCHContainerOps)));
1119
1120 // Clean up on error, disengage it if the function returns successfully.
1121 auto CleanOnError = llvm::make_scope_exit([&]() {
1122 // Remove the overridden buffer we used for the preamble.
1123 SavedMainFileBuffer = nullptr;
1124
1125 // Keep the ownership of the data in the ASTUnit because the client may
1126 // want to see the diagnostics.
1127 transferASTDataFromCompilerInstance(*Clang);
1128 FailedParseDiagnostics.swap(StoredDiagnostics);
1129 StoredDiagnostics.clear();
1130 NumStoredDiagnosticsFromDriver = 0;
1131 });
1132
1133 // Ensure that Clang has a FileManager with the right VFS, which may have
1134 // changed above in AddImplicitPreamble. If VFS is nullptr, rely on
1135 // createFileManager to create one.
1136 if (VFS && FileMgr && &FileMgr->getVirtualFileSystem() == VFS)
1137 Clang->setFileManager(&*FileMgr);
1138 else
1139 FileMgr = Clang->createFileManager(std::move(VFS));
1140
1141 // Recover resources if we crash before exiting this method.
1142 llvm::CrashRecoveryContextCleanupRegistrar<CompilerInstance>
1143 CICleanup(Clang.get());
1144
1145 Clang->setInvocation(CCInvocation);
1146 OriginalSourceFile =
1147 std::string(Clang->getFrontendOpts().Inputs[0].getFile());
1148
1149 // Set up diagnostics, capturing any diagnostics that would
1150 // otherwise be dropped.
1151 Clang->setDiagnostics(&getDiagnostics());
1152
1153 // Create the target instance.
1154 if (!Clang->createTarget())
1155 return true;
1156
1157 assert(Clang->getFrontendOpts().Inputs.size() == 1 &&
1158 "Invocation must have exactly one source file!");
1159 assert(Clang->getFrontendOpts().Inputs[0].getKind().getFormat() ==
1160 InputKind::Source &&
1161 "FIXME: AST inputs not yet supported here!");
1162 assert(Clang->getFrontendOpts().Inputs[0].getKind().getLanguage() !=
1163 Language::LLVM_IR &&
1164 "IR inputs not support here!");
1165
1166 // Configure the various subsystems.
1167 LangOpts = Clang->getInvocation().LangOpts;
1168 FileSystemOpts = Clang->getFileSystemOpts();
1169
1170 ResetForParse();
1171
1172 SourceMgr = new SourceManager(getDiagnostics(), *FileMgr,
1173 UserFilesAreVolatile);
1174 if (!OverrideMainBuffer) {
1175 checkAndRemoveNonDriverDiags(StoredDiagnostics);
1176 TopLevelDeclsInPreamble.clear();
1177 }
1178
1179 // Create the source manager.
1180 Clang->setSourceManager(&getSourceManager());
1181
1182 // If the main file has been overridden due to the use of a preamble,
1183 // make that override happen and introduce the preamble.
1184 if (OverrideMainBuffer) {
1185 // The stored diagnostic has the old source manager in it; update
1186 // the locations to refer into the new source manager. Since we've
1187 // been careful to make sure that the source manager's state
1188 // before and after are identical, so that we can reuse the source
1189 // location itself.
1190 checkAndSanitizeDiags(StoredDiagnostics, getSourceManager());
1191
1192 // Keep track of the override buffer;
1193 SavedMainFileBuffer = std::move(OverrideMainBuffer);
1194 }
1195
1196 std::unique_ptr<TopLevelDeclTrackerAction> Act(
1197 new TopLevelDeclTrackerAction(*this));
1198
1199 // Recover resources if we crash before exiting this method.
1200 llvm::CrashRecoveryContextCleanupRegistrar<TopLevelDeclTrackerAction>
1201 ActCleanup(Act.get());
1202
1203 if (!Act->BeginSourceFile(*Clang.get(), Clang->getFrontendOpts().Inputs[0]))
1204 return true;
1205
1206 if (SavedMainFileBuffer)
1207 TranslateStoredDiagnostics(getFileManager(), getSourceManager(),
1208 PreambleDiagnostics, StoredDiagnostics);
1209 else
1210 PreambleSrcLocCache.clear();
1211
1212 if (llvm::Error Err = Act->Execute()) {
1213 consumeError(std::move(Err)); // FIXME this drops errors on the floor.
1214 return true;
1215 }
1216
1217 transferASTDataFromCompilerInstance(*Clang);
1218
1219 Act->EndSourceFile();
1220
1221 FailedParseDiagnostics.clear();
1222
1223 CleanOnError.release();
1224
1225 return false;
1226 }
1227
1228 static std::pair<unsigned, unsigned>
makeStandaloneRange(CharSourceRange Range,const SourceManager & SM,const LangOptions & LangOpts)1229 makeStandaloneRange(CharSourceRange Range, const SourceManager &SM,
1230 const LangOptions &LangOpts) {
1231 CharSourceRange FileRange = Lexer::makeFileCharRange(Range, SM, LangOpts);
1232 unsigned Offset = SM.getFileOffset(FileRange.getBegin());
1233 unsigned EndOffset = SM.getFileOffset(FileRange.getEnd());
1234 return std::make_pair(Offset, EndOffset);
1235 }
1236
makeStandaloneFixIt(const SourceManager & SM,const LangOptions & LangOpts,const FixItHint & InFix)1237 static ASTUnit::StandaloneFixIt makeStandaloneFixIt(const SourceManager &SM,
1238 const LangOptions &LangOpts,
1239 const FixItHint &InFix) {
1240 ASTUnit::StandaloneFixIt OutFix;
1241 OutFix.RemoveRange = makeStandaloneRange(InFix.RemoveRange, SM, LangOpts);
1242 OutFix.InsertFromRange = makeStandaloneRange(InFix.InsertFromRange, SM,
1243 LangOpts);
1244 OutFix.CodeToInsert = InFix.CodeToInsert;
1245 OutFix.BeforePreviousInsertions = InFix.BeforePreviousInsertions;
1246 return OutFix;
1247 }
1248
1249 static ASTUnit::StandaloneDiagnostic
makeStandaloneDiagnostic(const LangOptions & LangOpts,const StoredDiagnostic & InDiag)1250 makeStandaloneDiagnostic(const LangOptions &LangOpts,
1251 const StoredDiagnostic &InDiag) {
1252 ASTUnit::StandaloneDiagnostic OutDiag;
1253 OutDiag.ID = InDiag.getID();
1254 OutDiag.Level = InDiag.getLevel();
1255 OutDiag.Message = std::string(InDiag.getMessage());
1256 OutDiag.LocOffset = 0;
1257 if (InDiag.getLocation().isInvalid())
1258 return OutDiag;
1259 const SourceManager &SM = InDiag.getLocation().getManager();
1260 SourceLocation FileLoc = SM.getFileLoc(InDiag.getLocation());
1261 OutDiag.Filename = std::string(SM.getFilename(FileLoc));
1262 if (OutDiag.Filename.empty())
1263 return OutDiag;
1264 OutDiag.LocOffset = SM.getFileOffset(FileLoc);
1265 for (const auto &Range : InDiag.getRanges())
1266 OutDiag.Ranges.push_back(makeStandaloneRange(Range, SM, LangOpts));
1267 for (const auto &FixIt : InDiag.getFixIts())
1268 OutDiag.FixIts.push_back(makeStandaloneFixIt(SM, LangOpts, FixIt));
1269
1270 return OutDiag;
1271 }
1272
1273 /// Attempt to build or re-use a precompiled preamble when (re-)parsing
1274 /// the source file.
1275 ///
1276 /// This routine will compute the preamble of the main source file. If a
1277 /// non-trivial preamble is found, it will precompile that preamble into a
1278 /// precompiled header so that the precompiled preamble can be used to reduce
1279 /// reparsing time. If a precompiled preamble has already been constructed,
1280 /// this routine will determine if it is still valid and, if so, avoid
1281 /// rebuilding the precompiled preamble.
1282 ///
1283 /// \param AllowRebuild When true (the default), this routine is
1284 /// allowed to rebuild the precompiled preamble if it is found to be
1285 /// out-of-date.
1286 ///
1287 /// \param MaxLines When non-zero, the maximum number of lines that
1288 /// can occur within the preamble.
1289 ///
1290 /// \returns If the precompiled preamble can be used, returns a newly-allocated
1291 /// buffer that should be used in place of the main file when doing so.
1292 /// Otherwise, returns a NULL pointer.
1293 std::unique_ptr<llvm::MemoryBuffer>
getMainBufferWithPrecompiledPreamble(std::shared_ptr<PCHContainerOperations> PCHContainerOps,CompilerInvocation & PreambleInvocationIn,IntrusiveRefCntPtr<llvm::vfs::FileSystem> VFS,bool AllowRebuild,unsigned MaxLines)1294 ASTUnit::getMainBufferWithPrecompiledPreamble(
1295 std::shared_ptr<PCHContainerOperations> PCHContainerOps,
1296 CompilerInvocation &PreambleInvocationIn,
1297 IntrusiveRefCntPtr<llvm::vfs::FileSystem> VFS, bool AllowRebuild,
1298 unsigned MaxLines) {
1299 auto MainFilePath =
1300 PreambleInvocationIn.getFrontendOpts().Inputs[0].getFile();
1301 std::unique_ptr<llvm::MemoryBuffer> MainFileBuffer =
1302 getBufferForFileHandlingRemapping(PreambleInvocationIn, VFS.get(),
1303 MainFilePath, UserFilesAreVolatile);
1304 if (!MainFileBuffer)
1305 return nullptr;
1306
1307 PreambleBounds Bounds = ComputePreambleBounds(
1308 *PreambleInvocationIn.getLangOpts(), *MainFileBuffer, MaxLines);
1309 if (!Bounds.Size)
1310 return nullptr;
1311
1312 if (Preamble) {
1313 if (Preamble->CanReuse(PreambleInvocationIn, *MainFileBuffer, Bounds,
1314 *VFS)) {
1315 // Okay! We can re-use the precompiled preamble.
1316
1317 // Set the state of the diagnostic object to mimic its state
1318 // after parsing the preamble.
1319 getDiagnostics().Reset();
1320 ProcessWarningOptions(getDiagnostics(),
1321 PreambleInvocationIn.getDiagnosticOpts());
1322 getDiagnostics().setNumWarnings(NumWarningsInPreamble);
1323
1324 PreambleRebuildCountdown = 1;
1325 return MainFileBuffer;
1326 } else {
1327 Preamble.reset();
1328 PreambleDiagnostics.clear();
1329 TopLevelDeclsInPreamble.clear();
1330 PreambleSrcLocCache.clear();
1331 PreambleRebuildCountdown = 1;
1332 }
1333 }
1334
1335 // If the preamble rebuild counter > 1, it's because we previously
1336 // failed to build a preamble and we're not yet ready to try
1337 // again. Decrement the counter and return a failure.
1338 if (PreambleRebuildCountdown > 1) {
1339 --PreambleRebuildCountdown;
1340 return nullptr;
1341 }
1342
1343 assert(!Preamble && "No Preamble should be stored at that point");
1344 // If we aren't allowed to rebuild the precompiled preamble, just
1345 // return now.
1346 if (!AllowRebuild)
1347 return nullptr;
1348
1349 ++PreambleCounter;
1350
1351 SmallVector<StandaloneDiagnostic, 4> NewPreambleDiagsStandalone;
1352 SmallVector<StoredDiagnostic, 4> NewPreambleDiags;
1353 ASTUnitPreambleCallbacks Callbacks;
1354 {
1355 llvm::Optional<CaptureDroppedDiagnostics> Capture;
1356 if (CaptureDiagnostics != CaptureDiagsKind::None)
1357 Capture.emplace(CaptureDiagnostics, *Diagnostics, &NewPreambleDiags,
1358 &NewPreambleDiagsStandalone);
1359
1360 // We did not previously compute a preamble, or it can't be reused anyway.
1361 SimpleTimer PreambleTimer(WantTiming);
1362 PreambleTimer.setOutput("Precompiling preamble");
1363
1364 const bool PreviousSkipFunctionBodies =
1365 PreambleInvocationIn.getFrontendOpts().SkipFunctionBodies;
1366 if (SkipFunctionBodies == SkipFunctionBodiesScope::Preamble)
1367 PreambleInvocationIn.getFrontendOpts().SkipFunctionBodies = true;
1368
1369 llvm::ErrorOr<PrecompiledPreamble> NewPreamble = PrecompiledPreamble::Build(
1370 PreambleInvocationIn, MainFileBuffer.get(), Bounds, *Diagnostics, VFS,
1371 PCHContainerOps, /*StoreInMemory=*/false, Callbacks);
1372
1373 PreambleInvocationIn.getFrontendOpts().SkipFunctionBodies =
1374 PreviousSkipFunctionBodies;
1375
1376 if (NewPreamble) {
1377 Preamble = std::move(*NewPreamble);
1378 PreambleRebuildCountdown = 1;
1379 } else {
1380 switch (static_cast<BuildPreambleError>(NewPreamble.getError().value())) {
1381 case BuildPreambleError::CouldntCreateTempFile:
1382 // Try again next time.
1383 PreambleRebuildCountdown = 1;
1384 return nullptr;
1385 case BuildPreambleError::CouldntCreateTargetInfo:
1386 case BuildPreambleError::BeginSourceFileFailed:
1387 case BuildPreambleError::CouldntEmitPCH:
1388 case BuildPreambleError::BadInputs:
1389 // These erros are more likely to repeat, retry after some period.
1390 PreambleRebuildCountdown = DefaultPreambleRebuildInterval;
1391 return nullptr;
1392 }
1393 llvm_unreachable("unexpected BuildPreambleError");
1394 }
1395 }
1396
1397 assert(Preamble && "Preamble wasn't built");
1398
1399 TopLevelDecls.clear();
1400 TopLevelDeclsInPreamble = Callbacks.takeTopLevelDeclIDs();
1401 PreambleTopLevelHashValue = Callbacks.getHash();
1402
1403 NumWarningsInPreamble = getDiagnostics().getNumWarnings();
1404
1405 checkAndRemoveNonDriverDiags(NewPreambleDiags);
1406 StoredDiagnostics = std::move(NewPreambleDiags);
1407 PreambleDiagnostics = std::move(NewPreambleDiagsStandalone);
1408
1409 // If the hash of top-level entities differs from the hash of the top-level
1410 // entities the last time we rebuilt the preamble, clear out the completion
1411 // cache.
1412 if (CurrentTopLevelHashValue != PreambleTopLevelHashValue) {
1413 CompletionCacheTopLevelHashValue = 0;
1414 PreambleTopLevelHashValue = CurrentTopLevelHashValue;
1415 }
1416
1417 return MainFileBuffer;
1418 }
1419
RealizeTopLevelDeclsFromPreamble()1420 void ASTUnit::RealizeTopLevelDeclsFromPreamble() {
1421 assert(Preamble && "Should only be called when preamble was built");
1422
1423 std::vector<Decl *> Resolved;
1424 Resolved.reserve(TopLevelDeclsInPreamble.size());
1425 ExternalASTSource &Source = *getASTContext().getExternalSource();
1426 for (const auto TopLevelDecl : TopLevelDeclsInPreamble) {
1427 // Resolve the declaration ID to an actual declaration, possibly
1428 // deserializing the declaration in the process.
1429 if (Decl *D = Source.GetExternalDecl(TopLevelDecl))
1430 Resolved.push_back(D);
1431 }
1432 TopLevelDeclsInPreamble.clear();
1433 TopLevelDecls.insert(TopLevelDecls.begin(), Resolved.begin(), Resolved.end());
1434 }
1435
transferASTDataFromCompilerInstance(CompilerInstance & CI)1436 void ASTUnit::transferASTDataFromCompilerInstance(CompilerInstance &CI) {
1437 // Steal the created target, context, and preprocessor if they have been
1438 // created.
1439 assert(CI.hasInvocation() && "missing invocation");
1440 LangOpts = CI.getInvocation().LangOpts;
1441 TheSema = CI.takeSema();
1442 Consumer = CI.takeASTConsumer();
1443 if (CI.hasASTContext())
1444 Ctx = &CI.getASTContext();
1445 if (CI.hasPreprocessor())
1446 PP = CI.getPreprocessorPtr();
1447 CI.setSourceManager(nullptr);
1448 CI.setFileManager(nullptr);
1449 if (CI.hasTarget())
1450 Target = &CI.getTarget();
1451 Reader = CI.getASTReader();
1452 HadModuleLoaderFatalFailure = CI.hadModuleLoaderFatalFailure();
1453 }
1454
getMainFileName() const1455 StringRef ASTUnit::getMainFileName() const {
1456 if (Invocation && !Invocation->getFrontendOpts().Inputs.empty()) {
1457 const FrontendInputFile &Input = Invocation->getFrontendOpts().Inputs[0];
1458 if (Input.isFile())
1459 return Input.getFile();
1460 else
1461 return Input.getBuffer().getBufferIdentifier();
1462 }
1463
1464 if (SourceMgr) {
1465 if (const FileEntry *
1466 FE = SourceMgr->getFileEntryForID(SourceMgr->getMainFileID()))
1467 return FE->getName();
1468 }
1469
1470 return {};
1471 }
1472
getASTFileName() const1473 StringRef ASTUnit::getASTFileName() const {
1474 if (!isMainFileAST())
1475 return {};
1476
1477 serialization::ModuleFile &
1478 Mod = Reader->getModuleManager().getPrimaryModule();
1479 return Mod.FileName;
1480 }
1481
1482 std::unique_ptr<ASTUnit>
create(std::shared_ptr<CompilerInvocation> CI,IntrusiveRefCntPtr<DiagnosticsEngine> Diags,CaptureDiagsKind CaptureDiagnostics,bool UserFilesAreVolatile)1483 ASTUnit::create(std::shared_ptr<CompilerInvocation> CI,
1484 IntrusiveRefCntPtr<DiagnosticsEngine> Diags,
1485 CaptureDiagsKind CaptureDiagnostics,
1486 bool UserFilesAreVolatile) {
1487 std::unique_ptr<ASTUnit> AST(new ASTUnit(false));
1488 ConfigureDiags(Diags, *AST, CaptureDiagnostics);
1489 IntrusiveRefCntPtr<llvm::vfs::FileSystem> VFS =
1490 createVFSFromCompilerInvocation(*CI, *Diags);
1491 AST->Diagnostics = Diags;
1492 AST->FileSystemOpts = CI->getFileSystemOpts();
1493 AST->Invocation = std::move(CI);
1494 AST->FileMgr = new FileManager(AST->FileSystemOpts, VFS);
1495 AST->UserFilesAreVolatile = UserFilesAreVolatile;
1496 AST->SourceMgr = new SourceManager(AST->getDiagnostics(), *AST->FileMgr,
1497 UserFilesAreVolatile);
1498 AST->ModuleCache = new InMemoryModuleCache;
1499
1500 return AST;
1501 }
1502
LoadFromCompilerInvocationAction(std::shared_ptr<CompilerInvocation> CI,std::shared_ptr<PCHContainerOperations> PCHContainerOps,IntrusiveRefCntPtr<DiagnosticsEngine> Diags,FrontendAction * Action,ASTUnit * Unit,bool Persistent,StringRef ResourceFilesPath,bool OnlyLocalDecls,CaptureDiagsKind CaptureDiagnostics,unsigned PrecompilePreambleAfterNParses,bool CacheCodeCompletionResults,bool UserFilesAreVolatile,std::unique_ptr<ASTUnit> * ErrAST)1503 ASTUnit *ASTUnit::LoadFromCompilerInvocationAction(
1504 std::shared_ptr<CompilerInvocation> CI,
1505 std::shared_ptr<PCHContainerOperations> PCHContainerOps,
1506 IntrusiveRefCntPtr<DiagnosticsEngine> Diags, FrontendAction *Action,
1507 ASTUnit *Unit, bool Persistent, StringRef ResourceFilesPath,
1508 bool OnlyLocalDecls, CaptureDiagsKind CaptureDiagnostics,
1509 unsigned PrecompilePreambleAfterNParses, bool CacheCodeCompletionResults,
1510 bool UserFilesAreVolatile, std::unique_ptr<ASTUnit> *ErrAST) {
1511 assert(CI && "A CompilerInvocation is required");
1512
1513 std::unique_ptr<ASTUnit> OwnAST;
1514 ASTUnit *AST = Unit;
1515 if (!AST) {
1516 // Create the AST unit.
1517 OwnAST = create(CI, Diags, CaptureDiagnostics, UserFilesAreVolatile);
1518 AST = OwnAST.get();
1519 if (!AST)
1520 return nullptr;
1521 }
1522
1523 if (!ResourceFilesPath.empty()) {
1524 // Override the resources path.
1525 CI->getHeaderSearchOpts().ResourceDir = std::string(ResourceFilesPath);
1526 }
1527 AST->OnlyLocalDecls = OnlyLocalDecls;
1528 AST->CaptureDiagnostics = CaptureDiagnostics;
1529 if (PrecompilePreambleAfterNParses > 0)
1530 AST->PreambleRebuildCountdown = PrecompilePreambleAfterNParses;
1531 AST->TUKind = Action ? Action->getTranslationUnitKind() : TU_Complete;
1532 AST->ShouldCacheCodeCompletionResults = CacheCodeCompletionResults;
1533 AST->IncludeBriefCommentsInCodeCompletion = false;
1534
1535 // Recover resources if we crash before exiting this method.
1536 llvm::CrashRecoveryContextCleanupRegistrar<ASTUnit>
1537 ASTUnitCleanup(OwnAST.get());
1538 llvm::CrashRecoveryContextCleanupRegistrar<DiagnosticsEngine,
1539 llvm::CrashRecoveryContextReleaseRefCleanup<DiagnosticsEngine>>
1540 DiagCleanup(Diags.get());
1541
1542 // We'll manage file buffers ourselves.
1543 CI->getPreprocessorOpts().RetainRemappedFileBuffers = true;
1544 CI->getFrontendOpts().DisableFree = false;
1545 ProcessWarningOptions(AST->getDiagnostics(), CI->getDiagnosticOpts());
1546
1547 // Create the compiler instance to use for building the AST.
1548 std::unique_ptr<CompilerInstance> Clang(
1549 new CompilerInstance(std::move(PCHContainerOps)));
1550
1551 // Recover resources if we crash before exiting this method.
1552 llvm::CrashRecoveryContextCleanupRegistrar<CompilerInstance>
1553 CICleanup(Clang.get());
1554
1555 Clang->setInvocation(std::move(CI));
1556 AST->OriginalSourceFile =
1557 std::string(Clang->getFrontendOpts().Inputs[0].getFile());
1558
1559 // Set up diagnostics, capturing any diagnostics that would
1560 // otherwise be dropped.
1561 Clang->setDiagnostics(&AST->getDiagnostics());
1562
1563 // Create the target instance.
1564 if (!Clang->createTarget())
1565 return nullptr;
1566
1567 assert(Clang->getFrontendOpts().Inputs.size() == 1 &&
1568 "Invocation must have exactly one source file!");
1569 assert(Clang->getFrontendOpts().Inputs[0].getKind().getFormat() ==
1570 InputKind::Source &&
1571 "FIXME: AST inputs not yet supported here!");
1572 assert(Clang->getFrontendOpts().Inputs[0].getKind().getLanguage() !=
1573 Language::LLVM_IR &&
1574 "IR inputs not support here!");
1575
1576 // Configure the various subsystems.
1577 AST->TheSema.reset();
1578 AST->Ctx = nullptr;
1579 AST->PP = nullptr;
1580 AST->Reader = nullptr;
1581
1582 // Create a file manager object to provide access to and cache the filesystem.
1583 Clang->setFileManager(&AST->getFileManager());
1584
1585 // Create the source manager.
1586 Clang->setSourceManager(&AST->getSourceManager());
1587
1588 FrontendAction *Act = Action;
1589
1590 std::unique_ptr<TopLevelDeclTrackerAction> TrackerAct;
1591 if (!Act) {
1592 TrackerAct.reset(new TopLevelDeclTrackerAction(*AST));
1593 Act = TrackerAct.get();
1594 }
1595
1596 // Recover resources if we crash before exiting this method.
1597 llvm::CrashRecoveryContextCleanupRegistrar<TopLevelDeclTrackerAction>
1598 ActCleanup(TrackerAct.get());
1599
1600 if (!Act->BeginSourceFile(*Clang.get(), Clang->getFrontendOpts().Inputs[0])) {
1601 AST->transferASTDataFromCompilerInstance(*Clang);
1602 if (OwnAST && ErrAST)
1603 ErrAST->swap(OwnAST);
1604
1605 return nullptr;
1606 }
1607
1608 if (Persistent && !TrackerAct) {
1609 Clang->getPreprocessor().addPPCallbacks(
1610 std::make_unique<MacroDefinitionTrackerPPCallbacks>(
1611 AST->getCurrentTopLevelHashValue()));
1612 std::vector<std::unique_ptr<ASTConsumer>> Consumers;
1613 if (Clang->hasASTConsumer())
1614 Consumers.push_back(Clang->takeASTConsumer());
1615 Consumers.push_back(std::make_unique<TopLevelDeclTrackerConsumer>(
1616 *AST, AST->getCurrentTopLevelHashValue()));
1617 Clang->setASTConsumer(
1618 std::make_unique<MultiplexConsumer>(std::move(Consumers)));
1619 }
1620 if (llvm::Error Err = Act->Execute()) {
1621 consumeError(std::move(Err)); // FIXME this drops errors on the floor.
1622 AST->transferASTDataFromCompilerInstance(*Clang);
1623 if (OwnAST && ErrAST)
1624 ErrAST->swap(OwnAST);
1625
1626 return nullptr;
1627 }
1628
1629 // Steal the created target, context, and preprocessor.
1630 AST->transferASTDataFromCompilerInstance(*Clang);
1631
1632 Act->EndSourceFile();
1633
1634 if (OwnAST)
1635 return OwnAST.release();
1636 else
1637 return AST;
1638 }
1639
LoadFromCompilerInvocation(std::shared_ptr<PCHContainerOperations> PCHContainerOps,unsigned PrecompilePreambleAfterNParses,IntrusiveRefCntPtr<llvm::vfs::FileSystem> VFS)1640 bool ASTUnit::LoadFromCompilerInvocation(
1641 std::shared_ptr<PCHContainerOperations> PCHContainerOps,
1642 unsigned PrecompilePreambleAfterNParses,
1643 IntrusiveRefCntPtr<llvm::vfs::FileSystem> VFS) {
1644 if (!Invocation)
1645 return true;
1646
1647 assert(VFS && "VFS is null");
1648
1649 // We'll manage file buffers ourselves.
1650 Invocation->getPreprocessorOpts().RetainRemappedFileBuffers = true;
1651 Invocation->getFrontendOpts().DisableFree = false;
1652 getDiagnostics().Reset();
1653 ProcessWarningOptions(getDiagnostics(), Invocation->getDiagnosticOpts());
1654
1655 std::unique_ptr<llvm::MemoryBuffer> OverrideMainBuffer;
1656 if (PrecompilePreambleAfterNParses > 0) {
1657 PreambleRebuildCountdown = PrecompilePreambleAfterNParses;
1658 OverrideMainBuffer =
1659 getMainBufferWithPrecompiledPreamble(PCHContainerOps, *Invocation, VFS);
1660 getDiagnostics().Reset();
1661 ProcessWarningOptions(getDiagnostics(), Invocation->getDiagnosticOpts());
1662 }
1663
1664 SimpleTimer ParsingTimer(WantTiming);
1665 ParsingTimer.setOutput("Parsing " + getMainFileName());
1666
1667 // Recover resources if we crash before exiting this method.
1668 llvm::CrashRecoveryContextCleanupRegistrar<llvm::MemoryBuffer>
1669 MemBufferCleanup(OverrideMainBuffer.get());
1670
1671 return Parse(std::move(PCHContainerOps), std::move(OverrideMainBuffer), VFS);
1672 }
1673
LoadFromCompilerInvocation(std::shared_ptr<CompilerInvocation> CI,std::shared_ptr<PCHContainerOperations> PCHContainerOps,IntrusiveRefCntPtr<DiagnosticsEngine> Diags,FileManager * FileMgr,bool OnlyLocalDecls,CaptureDiagsKind CaptureDiagnostics,unsigned PrecompilePreambleAfterNParses,TranslationUnitKind TUKind,bool CacheCodeCompletionResults,bool IncludeBriefCommentsInCodeCompletion,bool UserFilesAreVolatile)1674 std::unique_ptr<ASTUnit> ASTUnit::LoadFromCompilerInvocation(
1675 std::shared_ptr<CompilerInvocation> CI,
1676 std::shared_ptr<PCHContainerOperations> PCHContainerOps,
1677 IntrusiveRefCntPtr<DiagnosticsEngine> Diags, FileManager *FileMgr,
1678 bool OnlyLocalDecls, CaptureDiagsKind CaptureDiagnostics,
1679 unsigned PrecompilePreambleAfterNParses, TranslationUnitKind TUKind,
1680 bool CacheCodeCompletionResults, bool IncludeBriefCommentsInCodeCompletion,
1681 bool UserFilesAreVolatile) {
1682 // Create the AST unit.
1683 std::unique_ptr<ASTUnit> AST(new ASTUnit(false));
1684 ConfigureDiags(Diags, *AST, CaptureDiagnostics);
1685 AST->Diagnostics = Diags;
1686 AST->OnlyLocalDecls = OnlyLocalDecls;
1687 AST->CaptureDiagnostics = CaptureDiagnostics;
1688 AST->TUKind = TUKind;
1689 AST->ShouldCacheCodeCompletionResults = CacheCodeCompletionResults;
1690 AST->IncludeBriefCommentsInCodeCompletion
1691 = IncludeBriefCommentsInCodeCompletion;
1692 AST->Invocation = std::move(CI);
1693 AST->FileSystemOpts = FileMgr->getFileSystemOpts();
1694 AST->FileMgr = FileMgr;
1695 AST->UserFilesAreVolatile = UserFilesAreVolatile;
1696
1697 // Recover resources if we crash before exiting this method.
1698 llvm::CrashRecoveryContextCleanupRegistrar<ASTUnit>
1699 ASTUnitCleanup(AST.get());
1700 llvm::CrashRecoveryContextCleanupRegistrar<DiagnosticsEngine,
1701 llvm::CrashRecoveryContextReleaseRefCleanup<DiagnosticsEngine>>
1702 DiagCleanup(Diags.get());
1703
1704 if (AST->LoadFromCompilerInvocation(std::move(PCHContainerOps),
1705 PrecompilePreambleAfterNParses,
1706 &AST->FileMgr->getVirtualFileSystem()))
1707 return nullptr;
1708 return AST;
1709 }
1710
LoadFromCommandLine(const char ** ArgBegin,const char ** ArgEnd,std::shared_ptr<PCHContainerOperations> PCHContainerOps,IntrusiveRefCntPtr<DiagnosticsEngine> Diags,StringRef ResourceFilesPath,bool OnlyLocalDecls,CaptureDiagsKind CaptureDiagnostics,ArrayRef<RemappedFile> RemappedFiles,bool RemappedFilesKeepOriginalName,unsigned PrecompilePreambleAfterNParses,TranslationUnitKind TUKind,bool CacheCodeCompletionResults,bool IncludeBriefCommentsInCodeCompletion,bool AllowPCHWithCompilerErrors,SkipFunctionBodiesScope SkipFunctionBodies,bool SingleFileParse,bool UserFilesAreVolatile,bool ForSerialization,bool RetainExcludedConditionalBlocks,llvm::Optional<StringRef> ModuleFormat,std::unique_ptr<ASTUnit> * ErrAST,IntrusiveRefCntPtr<llvm::vfs::FileSystem> VFS)1711 ASTUnit *ASTUnit::LoadFromCommandLine(
1712 const char **ArgBegin, const char **ArgEnd,
1713 std::shared_ptr<PCHContainerOperations> PCHContainerOps,
1714 IntrusiveRefCntPtr<DiagnosticsEngine> Diags, StringRef ResourceFilesPath,
1715 bool OnlyLocalDecls, CaptureDiagsKind CaptureDiagnostics,
1716 ArrayRef<RemappedFile> RemappedFiles, bool RemappedFilesKeepOriginalName,
1717 unsigned PrecompilePreambleAfterNParses, TranslationUnitKind TUKind,
1718 bool CacheCodeCompletionResults, bool IncludeBriefCommentsInCodeCompletion,
1719 bool AllowPCHWithCompilerErrors, SkipFunctionBodiesScope SkipFunctionBodies,
1720 bool SingleFileParse, bool UserFilesAreVolatile, bool ForSerialization,
1721 bool RetainExcludedConditionalBlocks,
1722 llvm::Optional<StringRef> ModuleFormat, std::unique_ptr<ASTUnit> *ErrAST,
1723 IntrusiveRefCntPtr<llvm::vfs::FileSystem> VFS) {
1724 assert(Diags.get() && "no DiagnosticsEngine was provided");
1725
1726 SmallVector<StoredDiagnostic, 4> StoredDiagnostics;
1727
1728 std::shared_ptr<CompilerInvocation> CI;
1729
1730 {
1731 CaptureDroppedDiagnostics Capture(CaptureDiagnostics, *Diags,
1732 &StoredDiagnostics, nullptr);
1733
1734 CI = createInvocationFromCommandLine(
1735 llvm::makeArrayRef(ArgBegin, ArgEnd), Diags, VFS);
1736 if (!CI)
1737 return nullptr;
1738 }
1739
1740 // Override any files that need remapping
1741 for (const auto &RemappedFile : RemappedFiles) {
1742 CI->getPreprocessorOpts().addRemappedFile(RemappedFile.first,
1743 RemappedFile.second);
1744 }
1745 PreprocessorOptions &PPOpts = CI->getPreprocessorOpts();
1746 PPOpts.RemappedFilesKeepOriginalName = RemappedFilesKeepOriginalName;
1747 PPOpts.AllowPCHWithCompilerErrors = AllowPCHWithCompilerErrors;
1748 PPOpts.SingleFileParseMode = SingleFileParse;
1749 PPOpts.RetainExcludedConditionalBlocks = RetainExcludedConditionalBlocks;
1750
1751 // Override the resources path.
1752 CI->getHeaderSearchOpts().ResourceDir = std::string(ResourceFilesPath);
1753
1754 CI->getFrontendOpts().SkipFunctionBodies =
1755 SkipFunctionBodies == SkipFunctionBodiesScope::PreambleAndMainFile;
1756
1757 if (ModuleFormat)
1758 CI->getHeaderSearchOpts().ModuleFormat =
1759 std::string(ModuleFormat.getValue());
1760
1761 // Create the AST unit.
1762 std::unique_ptr<ASTUnit> AST;
1763 AST.reset(new ASTUnit(false));
1764 AST->NumStoredDiagnosticsFromDriver = StoredDiagnostics.size();
1765 AST->StoredDiagnostics.swap(StoredDiagnostics);
1766 ConfigureDiags(Diags, *AST, CaptureDiagnostics);
1767 AST->Diagnostics = Diags;
1768 AST->FileSystemOpts = CI->getFileSystemOpts();
1769 if (!VFS)
1770 VFS = llvm::vfs::getRealFileSystem();
1771 VFS = createVFSFromCompilerInvocation(*CI, *Diags, VFS);
1772 AST->FileMgr = new FileManager(AST->FileSystemOpts, VFS);
1773 AST->ModuleCache = new InMemoryModuleCache;
1774 AST->OnlyLocalDecls = OnlyLocalDecls;
1775 AST->CaptureDiagnostics = CaptureDiagnostics;
1776 AST->TUKind = TUKind;
1777 AST->ShouldCacheCodeCompletionResults = CacheCodeCompletionResults;
1778 AST->IncludeBriefCommentsInCodeCompletion
1779 = IncludeBriefCommentsInCodeCompletion;
1780 AST->UserFilesAreVolatile = UserFilesAreVolatile;
1781 AST->Invocation = CI;
1782 AST->SkipFunctionBodies = SkipFunctionBodies;
1783 if (ForSerialization)
1784 AST->WriterData.reset(new ASTWriterData(*AST->ModuleCache));
1785 // Zero out now to ease cleanup during crash recovery.
1786 CI = nullptr;
1787 Diags = nullptr;
1788
1789 // Recover resources if we crash before exiting this method.
1790 llvm::CrashRecoveryContextCleanupRegistrar<ASTUnit>
1791 ASTUnitCleanup(AST.get());
1792
1793 if (AST->LoadFromCompilerInvocation(std::move(PCHContainerOps),
1794 PrecompilePreambleAfterNParses,
1795 VFS)) {
1796 // Some error occurred, if caller wants to examine diagnostics, pass it the
1797 // ASTUnit.
1798 if (ErrAST) {
1799 AST->StoredDiagnostics.swap(AST->FailedParseDiagnostics);
1800 ErrAST->swap(AST);
1801 }
1802 return nullptr;
1803 }
1804
1805 return AST.release();
1806 }
1807
Reparse(std::shared_ptr<PCHContainerOperations> PCHContainerOps,ArrayRef<RemappedFile> RemappedFiles,IntrusiveRefCntPtr<llvm::vfs::FileSystem> VFS)1808 bool ASTUnit::Reparse(std::shared_ptr<PCHContainerOperations> PCHContainerOps,
1809 ArrayRef<RemappedFile> RemappedFiles,
1810 IntrusiveRefCntPtr<llvm::vfs::FileSystem> VFS) {
1811 if (!Invocation)
1812 return true;
1813
1814 if (!VFS) {
1815 assert(FileMgr && "FileMgr is null on Reparse call");
1816 VFS = &FileMgr->getVirtualFileSystem();
1817 }
1818
1819 clearFileLevelDecls();
1820
1821 SimpleTimer ParsingTimer(WantTiming);
1822 ParsingTimer.setOutput("Reparsing " + getMainFileName());
1823
1824 // Remap files.
1825 PreprocessorOptions &PPOpts = Invocation->getPreprocessorOpts();
1826 for (const auto &RB : PPOpts.RemappedFileBuffers)
1827 delete RB.second;
1828
1829 Invocation->getPreprocessorOpts().clearRemappedFiles();
1830 for (const auto &RemappedFile : RemappedFiles) {
1831 Invocation->getPreprocessorOpts().addRemappedFile(RemappedFile.first,
1832 RemappedFile.second);
1833 }
1834
1835 // If we have a preamble file lying around, or if we might try to
1836 // build a precompiled preamble, do so now.
1837 std::unique_ptr<llvm::MemoryBuffer> OverrideMainBuffer;
1838 if (Preamble || PreambleRebuildCountdown > 0)
1839 OverrideMainBuffer =
1840 getMainBufferWithPrecompiledPreamble(PCHContainerOps, *Invocation, VFS);
1841
1842 // Clear out the diagnostics state.
1843 FileMgr.reset();
1844 getDiagnostics().Reset();
1845 ProcessWarningOptions(getDiagnostics(), Invocation->getDiagnosticOpts());
1846 if (OverrideMainBuffer)
1847 getDiagnostics().setNumWarnings(NumWarningsInPreamble);
1848
1849 // Parse the sources
1850 bool Result =
1851 Parse(std::move(PCHContainerOps), std::move(OverrideMainBuffer), VFS);
1852
1853 // If we're caching global code-completion results, and the top-level
1854 // declarations have changed, clear out the code-completion cache.
1855 if (!Result && ShouldCacheCodeCompletionResults &&
1856 CurrentTopLevelHashValue != CompletionCacheTopLevelHashValue)
1857 CacheCodeCompletionResults();
1858
1859 // We now need to clear out the completion info related to this translation
1860 // unit; it'll be recreated if necessary.
1861 CCTUInfo.reset();
1862
1863 return Result;
1864 }
1865
ResetForParse()1866 void ASTUnit::ResetForParse() {
1867 SavedMainFileBuffer.reset();
1868
1869 SourceMgr.reset();
1870 TheSema.reset();
1871 Ctx.reset();
1872 PP.reset();
1873 Reader.reset();
1874
1875 TopLevelDecls.clear();
1876 clearFileLevelDecls();
1877 }
1878
1879 //----------------------------------------------------------------------------//
1880 // Code completion
1881 //----------------------------------------------------------------------------//
1882
1883 namespace {
1884
1885 /// Code completion consumer that combines the cached code-completion
1886 /// results from an ASTUnit with the code-completion results provided to it,
1887 /// then passes the result on to
1888 class AugmentedCodeCompleteConsumer : public CodeCompleteConsumer {
1889 uint64_t NormalContexts;
1890 ASTUnit &AST;
1891 CodeCompleteConsumer &Next;
1892
1893 public:
AugmentedCodeCompleteConsumer(ASTUnit & AST,CodeCompleteConsumer & Next,const CodeCompleteOptions & CodeCompleteOpts)1894 AugmentedCodeCompleteConsumer(ASTUnit &AST, CodeCompleteConsumer &Next,
1895 const CodeCompleteOptions &CodeCompleteOpts)
1896 : CodeCompleteConsumer(CodeCompleteOpts), AST(AST), Next(Next) {
1897 // Compute the set of contexts in which we will look when we don't have
1898 // any information about the specific context.
1899 NormalContexts
1900 = (1LL << CodeCompletionContext::CCC_TopLevel)
1901 | (1LL << CodeCompletionContext::CCC_ObjCInterface)
1902 | (1LL << CodeCompletionContext::CCC_ObjCImplementation)
1903 | (1LL << CodeCompletionContext::CCC_ObjCIvarList)
1904 | (1LL << CodeCompletionContext::CCC_Statement)
1905 | (1LL << CodeCompletionContext::CCC_Expression)
1906 | (1LL << CodeCompletionContext::CCC_ObjCMessageReceiver)
1907 | (1LL << CodeCompletionContext::CCC_DotMemberAccess)
1908 | (1LL << CodeCompletionContext::CCC_ArrowMemberAccess)
1909 | (1LL << CodeCompletionContext::CCC_ObjCPropertyAccess)
1910 | (1LL << CodeCompletionContext::CCC_ObjCProtocolName)
1911 | (1LL << CodeCompletionContext::CCC_ParenthesizedExpression)
1912 | (1LL << CodeCompletionContext::CCC_Recovery);
1913
1914 if (AST.getASTContext().getLangOpts().CPlusPlus)
1915 NormalContexts |= (1LL << CodeCompletionContext::CCC_EnumTag)
1916 | (1LL << CodeCompletionContext::CCC_UnionTag)
1917 | (1LL << CodeCompletionContext::CCC_ClassOrStructTag);
1918 }
1919
1920 void ProcessCodeCompleteResults(Sema &S, CodeCompletionContext Context,
1921 CodeCompletionResult *Results,
1922 unsigned NumResults) override;
1923
ProcessOverloadCandidates(Sema & S,unsigned CurrentArg,OverloadCandidate * Candidates,unsigned NumCandidates,SourceLocation OpenParLoc)1924 void ProcessOverloadCandidates(Sema &S, unsigned CurrentArg,
1925 OverloadCandidate *Candidates,
1926 unsigned NumCandidates,
1927 SourceLocation OpenParLoc) override {
1928 Next.ProcessOverloadCandidates(S, CurrentArg, Candidates, NumCandidates,
1929 OpenParLoc);
1930 }
1931
getAllocator()1932 CodeCompletionAllocator &getAllocator() override {
1933 return Next.getAllocator();
1934 }
1935
getCodeCompletionTUInfo()1936 CodeCompletionTUInfo &getCodeCompletionTUInfo() override {
1937 return Next.getCodeCompletionTUInfo();
1938 }
1939 };
1940
1941 } // namespace
1942
1943 /// Helper function that computes which global names are hidden by the
1944 /// local code-completion results.
CalculateHiddenNames(const CodeCompletionContext & Context,CodeCompletionResult * Results,unsigned NumResults,ASTContext & Ctx,llvm::StringSet<llvm::BumpPtrAllocator> & HiddenNames)1945 static void CalculateHiddenNames(const CodeCompletionContext &Context,
1946 CodeCompletionResult *Results,
1947 unsigned NumResults,
1948 ASTContext &Ctx,
1949 llvm::StringSet<llvm::BumpPtrAllocator> &HiddenNames){
1950 bool OnlyTagNames = false;
1951 switch (Context.getKind()) {
1952 case CodeCompletionContext::CCC_Recovery:
1953 case CodeCompletionContext::CCC_TopLevel:
1954 case CodeCompletionContext::CCC_ObjCInterface:
1955 case CodeCompletionContext::CCC_ObjCImplementation:
1956 case CodeCompletionContext::CCC_ObjCIvarList:
1957 case CodeCompletionContext::CCC_ClassStructUnion:
1958 case CodeCompletionContext::CCC_Statement:
1959 case CodeCompletionContext::CCC_Expression:
1960 case CodeCompletionContext::CCC_ObjCMessageReceiver:
1961 case CodeCompletionContext::CCC_DotMemberAccess:
1962 case CodeCompletionContext::CCC_ArrowMemberAccess:
1963 case CodeCompletionContext::CCC_ObjCPropertyAccess:
1964 case CodeCompletionContext::CCC_Namespace:
1965 case CodeCompletionContext::CCC_Type:
1966 case CodeCompletionContext::CCC_Symbol:
1967 case CodeCompletionContext::CCC_SymbolOrNewName:
1968 case CodeCompletionContext::CCC_ParenthesizedExpression:
1969 case CodeCompletionContext::CCC_ObjCInterfaceName:
1970 break;
1971
1972 case CodeCompletionContext::CCC_EnumTag:
1973 case CodeCompletionContext::CCC_UnionTag:
1974 case CodeCompletionContext::CCC_ClassOrStructTag:
1975 OnlyTagNames = true;
1976 break;
1977
1978 case CodeCompletionContext::CCC_ObjCProtocolName:
1979 case CodeCompletionContext::CCC_MacroName:
1980 case CodeCompletionContext::CCC_MacroNameUse:
1981 case CodeCompletionContext::CCC_PreprocessorExpression:
1982 case CodeCompletionContext::CCC_PreprocessorDirective:
1983 case CodeCompletionContext::CCC_NaturalLanguage:
1984 case CodeCompletionContext::CCC_SelectorName:
1985 case CodeCompletionContext::CCC_TypeQualifiers:
1986 case CodeCompletionContext::CCC_Other:
1987 case CodeCompletionContext::CCC_OtherWithMacros:
1988 case CodeCompletionContext::CCC_ObjCInstanceMessage:
1989 case CodeCompletionContext::CCC_ObjCClassMessage:
1990 case CodeCompletionContext::CCC_ObjCCategoryName:
1991 case CodeCompletionContext::CCC_IncludedFile:
1992 case CodeCompletionContext::CCC_NewName:
1993 // We're looking for nothing, or we're looking for names that cannot
1994 // be hidden.
1995 return;
1996 }
1997
1998 using Result = CodeCompletionResult;
1999 for (unsigned I = 0; I != NumResults; ++I) {
2000 if (Results[I].Kind != Result::RK_Declaration)
2001 continue;
2002
2003 unsigned IDNS
2004 = Results[I].Declaration->getUnderlyingDecl()->getIdentifierNamespace();
2005
2006 bool Hiding = false;
2007 if (OnlyTagNames)
2008 Hiding = (IDNS & Decl::IDNS_Tag);
2009 else {
2010 unsigned HiddenIDNS = (Decl::IDNS_Type | Decl::IDNS_Member |
2011 Decl::IDNS_Namespace | Decl::IDNS_Ordinary |
2012 Decl::IDNS_NonMemberOperator);
2013 if (Ctx.getLangOpts().CPlusPlus)
2014 HiddenIDNS |= Decl::IDNS_Tag;
2015 Hiding = (IDNS & HiddenIDNS);
2016 }
2017
2018 if (!Hiding)
2019 continue;
2020
2021 DeclarationName Name = Results[I].Declaration->getDeclName();
2022 if (IdentifierInfo *Identifier = Name.getAsIdentifierInfo())
2023 HiddenNames.insert(Identifier->getName());
2024 else
2025 HiddenNames.insert(Name.getAsString());
2026 }
2027 }
2028
ProcessCodeCompleteResults(Sema & S,CodeCompletionContext Context,CodeCompletionResult * Results,unsigned NumResults)2029 void AugmentedCodeCompleteConsumer::ProcessCodeCompleteResults(Sema &S,
2030 CodeCompletionContext Context,
2031 CodeCompletionResult *Results,
2032 unsigned NumResults) {
2033 // Merge the results we were given with the results we cached.
2034 bool AddedResult = false;
2035 uint64_t InContexts =
2036 Context.getKind() == CodeCompletionContext::CCC_Recovery
2037 ? NormalContexts : (1LL << Context.getKind());
2038 // Contains the set of names that are hidden by "local" completion results.
2039 llvm::StringSet<llvm::BumpPtrAllocator> HiddenNames;
2040 using Result = CodeCompletionResult;
2041 SmallVector<Result, 8> AllResults;
2042 for (ASTUnit::cached_completion_iterator
2043 C = AST.cached_completion_begin(),
2044 CEnd = AST.cached_completion_end();
2045 C != CEnd; ++C) {
2046 // If the context we are in matches any of the contexts we are
2047 // interested in, we'll add this result.
2048 if ((C->ShowInContexts & InContexts) == 0)
2049 continue;
2050
2051 // If we haven't added any results previously, do so now.
2052 if (!AddedResult) {
2053 CalculateHiddenNames(Context, Results, NumResults, S.Context,
2054 HiddenNames);
2055 AllResults.insert(AllResults.end(), Results, Results + NumResults);
2056 AddedResult = true;
2057 }
2058
2059 // Determine whether this global completion result is hidden by a local
2060 // completion result. If so, skip it.
2061 if (C->Kind != CXCursor_MacroDefinition &&
2062 HiddenNames.count(C->Completion->getTypedText()))
2063 continue;
2064
2065 // Adjust priority based on similar type classes.
2066 unsigned Priority = C->Priority;
2067 CodeCompletionString *Completion = C->Completion;
2068 if (!Context.getPreferredType().isNull()) {
2069 if (C->Kind == CXCursor_MacroDefinition) {
2070 Priority = getMacroUsagePriority(C->Completion->getTypedText(),
2071 S.getLangOpts(),
2072 Context.getPreferredType()->isAnyPointerType());
2073 } else if (C->Type) {
2074 CanQualType Expected
2075 = S.Context.getCanonicalType(
2076 Context.getPreferredType().getUnqualifiedType());
2077 SimplifiedTypeClass ExpectedSTC = getSimplifiedTypeClass(Expected);
2078 if (ExpectedSTC == C->TypeClass) {
2079 // We know this type is similar; check for an exact match.
2080 llvm::StringMap<unsigned> &CachedCompletionTypes
2081 = AST.getCachedCompletionTypes();
2082 llvm::StringMap<unsigned>::iterator Pos
2083 = CachedCompletionTypes.find(QualType(Expected).getAsString());
2084 if (Pos != CachedCompletionTypes.end() && Pos->second == C->Type)
2085 Priority /= CCF_ExactTypeMatch;
2086 else
2087 Priority /= CCF_SimilarTypeMatch;
2088 }
2089 }
2090 }
2091
2092 // Adjust the completion string, if required.
2093 if (C->Kind == CXCursor_MacroDefinition &&
2094 Context.getKind() == CodeCompletionContext::CCC_MacroNameUse) {
2095 // Create a new code-completion string that just contains the
2096 // macro name, without its arguments.
2097 CodeCompletionBuilder Builder(getAllocator(), getCodeCompletionTUInfo(),
2098 CCP_CodePattern, C->Availability);
2099 Builder.AddTypedTextChunk(C->Completion->getTypedText());
2100 Priority = CCP_CodePattern;
2101 Completion = Builder.TakeString();
2102 }
2103
2104 AllResults.push_back(Result(Completion, Priority, C->Kind,
2105 C->Availability));
2106 }
2107
2108 // If we did not add any cached completion results, just forward the
2109 // results we were given to the next consumer.
2110 if (!AddedResult) {
2111 Next.ProcessCodeCompleteResults(S, Context, Results, NumResults);
2112 return;
2113 }
2114
2115 Next.ProcessCodeCompleteResults(S, Context, AllResults.data(),
2116 AllResults.size());
2117 }
2118
CodeComplete(StringRef File,unsigned Line,unsigned Column,ArrayRef<RemappedFile> RemappedFiles,bool IncludeMacros,bool IncludeCodePatterns,bool IncludeBriefComments,CodeCompleteConsumer & Consumer,std::shared_ptr<PCHContainerOperations> PCHContainerOps,DiagnosticsEngine & Diag,LangOptions & LangOpts,SourceManager & SourceMgr,FileManager & FileMgr,SmallVectorImpl<StoredDiagnostic> & StoredDiagnostics,SmallVectorImpl<const llvm::MemoryBuffer * > & OwnedBuffers)2119 void ASTUnit::CodeComplete(
2120 StringRef File, unsigned Line, unsigned Column,
2121 ArrayRef<RemappedFile> RemappedFiles, bool IncludeMacros,
2122 bool IncludeCodePatterns, bool IncludeBriefComments,
2123 CodeCompleteConsumer &Consumer,
2124 std::shared_ptr<PCHContainerOperations> PCHContainerOps,
2125 DiagnosticsEngine &Diag, LangOptions &LangOpts, SourceManager &SourceMgr,
2126 FileManager &FileMgr, SmallVectorImpl<StoredDiagnostic> &StoredDiagnostics,
2127 SmallVectorImpl<const llvm::MemoryBuffer *> &OwnedBuffers) {
2128 if (!Invocation)
2129 return;
2130
2131 SimpleTimer CompletionTimer(WantTiming);
2132 CompletionTimer.setOutput("Code completion @ " + File + ":" +
2133 Twine(Line) + ":" + Twine(Column));
2134
2135 auto CCInvocation = std::make_shared<CompilerInvocation>(*Invocation);
2136
2137 FrontendOptions &FrontendOpts = CCInvocation->getFrontendOpts();
2138 CodeCompleteOptions &CodeCompleteOpts = FrontendOpts.CodeCompleteOpts;
2139 PreprocessorOptions &PreprocessorOpts = CCInvocation->getPreprocessorOpts();
2140
2141 CodeCompleteOpts.IncludeMacros = IncludeMacros &&
2142 CachedCompletionResults.empty();
2143 CodeCompleteOpts.IncludeCodePatterns = IncludeCodePatterns;
2144 CodeCompleteOpts.IncludeGlobals = CachedCompletionResults.empty();
2145 CodeCompleteOpts.IncludeBriefComments = IncludeBriefComments;
2146 CodeCompleteOpts.LoadExternal = Consumer.loadExternal();
2147 CodeCompleteOpts.IncludeFixIts = Consumer.includeFixIts();
2148
2149 assert(IncludeBriefComments == this->IncludeBriefCommentsInCodeCompletion);
2150
2151 FrontendOpts.CodeCompletionAt.FileName = std::string(File);
2152 FrontendOpts.CodeCompletionAt.Line = Line;
2153 FrontendOpts.CodeCompletionAt.Column = Column;
2154
2155 // Set the language options appropriately.
2156 LangOpts = *CCInvocation->getLangOpts();
2157
2158 // Spell-checking and warnings are wasteful during code-completion.
2159 LangOpts.SpellChecking = false;
2160 CCInvocation->getDiagnosticOpts().IgnoreWarnings = true;
2161
2162 std::unique_ptr<CompilerInstance> Clang(
2163 new CompilerInstance(PCHContainerOps));
2164
2165 // Recover resources if we crash before exiting this method.
2166 llvm::CrashRecoveryContextCleanupRegistrar<CompilerInstance>
2167 CICleanup(Clang.get());
2168
2169 auto &Inv = *CCInvocation;
2170 Clang->setInvocation(std::move(CCInvocation));
2171 OriginalSourceFile =
2172 std::string(Clang->getFrontendOpts().Inputs[0].getFile());
2173
2174 // Set up diagnostics, capturing any diagnostics produced.
2175 Clang->setDiagnostics(&Diag);
2176 CaptureDroppedDiagnostics Capture(CaptureDiagsKind::All,
2177 Clang->getDiagnostics(),
2178 &StoredDiagnostics, nullptr);
2179 ProcessWarningOptions(Diag, Inv.getDiagnosticOpts());
2180
2181 // Create the target instance.
2182 if (!Clang->createTarget()) {
2183 Clang->setInvocation(nullptr);
2184 return;
2185 }
2186
2187 assert(Clang->getFrontendOpts().Inputs.size() == 1 &&
2188 "Invocation must have exactly one source file!");
2189 assert(Clang->getFrontendOpts().Inputs[0].getKind().getFormat() ==
2190 InputKind::Source &&
2191 "FIXME: AST inputs not yet supported here!");
2192 assert(Clang->getFrontendOpts().Inputs[0].getKind().getLanguage() !=
2193 Language::LLVM_IR &&
2194 "IR inputs not support here!");
2195
2196 // Use the source and file managers that we were given.
2197 Clang->setFileManager(&FileMgr);
2198 Clang->setSourceManager(&SourceMgr);
2199
2200 // Remap files.
2201 PreprocessorOpts.clearRemappedFiles();
2202 PreprocessorOpts.RetainRemappedFileBuffers = true;
2203 for (const auto &RemappedFile : RemappedFiles) {
2204 PreprocessorOpts.addRemappedFile(RemappedFile.first, RemappedFile.second);
2205 OwnedBuffers.push_back(RemappedFile.second);
2206 }
2207
2208 // Use the code completion consumer we were given, but adding any cached
2209 // code-completion results.
2210 AugmentedCodeCompleteConsumer *AugmentedConsumer
2211 = new AugmentedCodeCompleteConsumer(*this, Consumer, CodeCompleteOpts);
2212 Clang->setCodeCompletionConsumer(AugmentedConsumer);
2213
2214 auto getUniqueID =
2215 [&FileMgr](StringRef Filename) -> Optional<llvm::sys::fs::UniqueID> {
2216 if (auto Status = FileMgr.getVirtualFileSystem().status(Filename))
2217 return Status->getUniqueID();
2218 return None;
2219 };
2220
2221 auto hasSameUniqueID = [getUniqueID](StringRef LHS, StringRef RHS) {
2222 if (LHS == RHS)
2223 return true;
2224 if (auto LHSID = getUniqueID(LHS))
2225 if (auto RHSID = getUniqueID(RHS))
2226 return *LHSID == *RHSID;
2227 return false;
2228 };
2229
2230 // If we have a precompiled preamble, try to use it. We only allow
2231 // the use of the precompiled preamble if we're if the completion
2232 // point is within the main file, after the end of the precompiled
2233 // preamble.
2234 std::unique_ptr<llvm::MemoryBuffer> OverrideMainBuffer;
2235 if (Preamble && Line > 1 && hasSameUniqueID(File, OriginalSourceFile)) {
2236 OverrideMainBuffer = getMainBufferWithPrecompiledPreamble(
2237 PCHContainerOps, Inv, &FileMgr.getVirtualFileSystem(), false, Line - 1);
2238 }
2239
2240 // If the main file has been overridden due to the use of a preamble,
2241 // make that override happen and introduce the preamble.
2242 if (OverrideMainBuffer) {
2243 assert(Preamble &&
2244 "No preamble was built, but OverrideMainBuffer is not null");
2245
2246 IntrusiveRefCntPtr<llvm::vfs::FileSystem> VFS =
2247 &FileMgr.getVirtualFileSystem();
2248 Preamble->AddImplicitPreamble(Clang->getInvocation(), VFS,
2249 OverrideMainBuffer.get());
2250 // FIXME: there is no way to update VFS if it was changed by
2251 // AddImplicitPreamble as FileMgr is accepted as a parameter by this method.
2252 // We use on-disk preambles instead and rely on FileMgr's VFS to ensure the
2253 // PCH files are always readable.
2254 OwnedBuffers.push_back(OverrideMainBuffer.release());
2255 } else {
2256 PreprocessorOpts.PrecompiledPreambleBytes.first = 0;
2257 PreprocessorOpts.PrecompiledPreambleBytes.second = false;
2258 }
2259
2260 // Disable the preprocessing record if modules are not enabled.
2261 if (!Clang->getLangOpts().Modules)
2262 PreprocessorOpts.DetailedRecord = false;
2263
2264 std::unique_ptr<SyntaxOnlyAction> Act;
2265 Act.reset(new SyntaxOnlyAction);
2266 if (Act->BeginSourceFile(*Clang.get(), Clang->getFrontendOpts().Inputs[0])) {
2267 if (llvm::Error Err = Act->Execute()) {
2268 consumeError(std::move(Err)); // FIXME this drops errors on the floor.
2269 }
2270 Act->EndSourceFile();
2271 }
2272 }
2273
Save(StringRef File)2274 bool ASTUnit::Save(StringRef File) {
2275 if (HadModuleLoaderFatalFailure)
2276 return true;
2277
2278 // Write to a temporary file and later rename it to the actual file, to avoid
2279 // possible race conditions.
2280 SmallString<128> TempPath;
2281 TempPath = File;
2282 TempPath += "-%%%%%%%%";
2283 // FIXME: Can we somehow regenerate the stat cache here, or do we need to
2284 // unconditionally create a stat cache when we parse the file?
2285
2286 if (llvm::Error Err = llvm::writeFileAtomically(
2287 TempPath, File, [this](llvm::raw_ostream &Out) {
2288 return serialize(Out) ? llvm::make_error<llvm::StringError>(
2289 "ASTUnit serialization failed",
2290 llvm::inconvertibleErrorCode())
2291 : llvm::Error::success();
2292 })) {
2293 consumeError(std::move(Err));
2294 return true;
2295 }
2296 return false;
2297 }
2298
serializeUnit(ASTWriter & Writer,SmallVectorImpl<char> & Buffer,Sema & S,bool hasErrors,raw_ostream & OS)2299 static bool serializeUnit(ASTWriter &Writer,
2300 SmallVectorImpl<char> &Buffer,
2301 Sema &S,
2302 bool hasErrors,
2303 raw_ostream &OS) {
2304 Writer.WriteAST(S, std::string(), nullptr, "", hasErrors);
2305
2306 // Write the generated bitstream to "Out".
2307 if (!Buffer.empty())
2308 OS.write(Buffer.data(), Buffer.size());
2309
2310 return false;
2311 }
2312
serialize(raw_ostream & OS)2313 bool ASTUnit::serialize(raw_ostream &OS) {
2314 // For serialization we are lenient if the errors were only warn-as-error kind.
2315 bool hasErrors = getDiagnostics().hasUncompilableErrorOccurred();
2316
2317 if (WriterData)
2318 return serializeUnit(WriterData->Writer, WriterData->Buffer,
2319 getSema(), hasErrors, OS);
2320
2321 SmallString<128> Buffer;
2322 llvm::BitstreamWriter Stream(Buffer);
2323 InMemoryModuleCache ModuleCache;
2324 ASTWriter Writer(Stream, Buffer, ModuleCache, {});
2325 return serializeUnit(Writer, Buffer, getSema(), hasErrors, OS);
2326 }
2327
2328 using SLocRemap = ContinuousRangeMap<unsigned, int, 2>;
2329
TranslateStoredDiagnostics(FileManager & FileMgr,SourceManager & SrcMgr,const SmallVectorImpl<StandaloneDiagnostic> & Diags,SmallVectorImpl<StoredDiagnostic> & Out)2330 void ASTUnit::TranslateStoredDiagnostics(
2331 FileManager &FileMgr,
2332 SourceManager &SrcMgr,
2333 const SmallVectorImpl<StandaloneDiagnostic> &Diags,
2334 SmallVectorImpl<StoredDiagnostic> &Out) {
2335 // Map the standalone diagnostic into the new source manager. We also need to
2336 // remap all the locations to the new view. This includes the diag location,
2337 // any associated source ranges, and the source ranges of associated fix-its.
2338 // FIXME: There should be a cleaner way to do this.
2339 SmallVector<StoredDiagnostic, 4> Result;
2340 Result.reserve(Diags.size());
2341
2342 for (const auto &SD : Diags) {
2343 // Rebuild the StoredDiagnostic.
2344 if (SD.Filename.empty())
2345 continue;
2346 auto FE = FileMgr.getFile(SD.Filename);
2347 if (!FE)
2348 continue;
2349 SourceLocation FileLoc;
2350 auto ItFileID = PreambleSrcLocCache.find(SD.Filename);
2351 if (ItFileID == PreambleSrcLocCache.end()) {
2352 FileID FID = SrcMgr.translateFile(*FE);
2353 FileLoc = SrcMgr.getLocForStartOfFile(FID);
2354 PreambleSrcLocCache[SD.Filename] = FileLoc;
2355 } else {
2356 FileLoc = ItFileID->getValue();
2357 }
2358
2359 if (FileLoc.isInvalid())
2360 continue;
2361 SourceLocation L = FileLoc.getLocWithOffset(SD.LocOffset);
2362 FullSourceLoc Loc(L, SrcMgr);
2363
2364 SmallVector<CharSourceRange, 4> Ranges;
2365 Ranges.reserve(SD.Ranges.size());
2366 for (const auto &Range : SD.Ranges) {
2367 SourceLocation BL = FileLoc.getLocWithOffset(Range.first);
2368 SourceLocation EL = FileLoc.getLocWithOffset(Range.second);
2369 Ranges.push_back(CharSourceRange::getCharRange(BL, EL));
2370 }
2371
2372 SmallVector<FixItHint, 2> FixIts;
2373 FixIts.reserve(SD.FixIts.size());
2374 for (const auto &FixIt : SD.FixIts) {
2375 FixIts.push_back(FixItHint());
2376 FixItHint &FH = FixIts.back();
2377 FH.CodeToInsert = FixIt.CodeToInsert;
2378 SourceLocation BL = FileLoc.getLocWithOffset(FixIt.RemoveRange.first);
2379 SourceLocation EL = FileLoc.getLocWithOffset(FixIt.RemoveRange.second);
2380 FH.RemoveRange = CharSourceRange::getCharRange(BL, EL);
2381 }
2382
2383 Result.push_back(StoredDiagnostic(SD.Level, SD.ID,
2384 SD.Message, Loc, Ranges, FixIts));
2385 }
2386 Result.swap(Out);
2387 }
2388
addFileLevelDecl(Decl * D)2389 void ASTUnit::addFileLevelDecl(Decl *D) {
2390 assert(D);
2391
2392 // We only care about local declarations.
2393 if (D->isFromASTFile())
2394 return;
2395
2396 SourceManager &SM = *SourceMgr;
2397 SourceLocation Loc = D->getLocation();
2398 if (Loc.isInvalid() || !SM.isLocalSourceLocation(Loc))
2399 return;
2400
2401 // We only keep track of the file-level declarations of each file.
2402 if (!D->getLexicalDeclContext()->isFileContext())
2403 return;
2404
2405 SourceLocation FileLoc = SM.getFileLoc(Loc);
2406 assert(SM.isLocalSourceLocation(FileLoc));
2407 FileID FID;
2408 unsigned Offset;
2409 std::tie(FID, Offset) = SM.getDecomposedLoc(FileLoc);
2410 if (FID.isInvalid())
2411 return;
2412
2413 std::unique_ptr<LocDeclsTy> &Decls = FileDecls[FID];
2414 if (!Decls)
2415 Decls = std::make_unique<LocDeclsTy>();
2416
2417 std::pair<unsigned, Decl *> LocDecl(Offset, D);
2418
2419 if (Decls->empty() || Decls->back().first <= Offset) {
2420 Decls->push_back(LocDecl);
2421 return;
2422 }
2423
2424 LocDeclsTy::iterator I =
2425 llvm::upper_bound(*Decls, LocDecl, llvm::less_first());
2426
2427 Decls->insert(I, LocDecl);
2428 }
2429
findFileRegionDecls(FileID File,unsigned Offset,unsigned Length,SmallVectorImpl<Decl * > & Decls)2430 void ASTUnit::findFileRegionDecls(FileID File, unsigned Offset, unsigned Length,
2431 SmallVectorImpl<Decl *> &Decls) {
2432 if (File.isInvalid())
2433 return;
2434
2435 if (SourceMgr->isLoadedFileID(File)) {
2436 assert(Ctx->getExternalSource() && "No external source!");
2437 return Ctx->getExternalSource()->FindFileRegionDecls(File, Offset, Length,
2438 Decls);
2439 }
2440
2441 FileDeclsTy::iterator I = FileDecls.find(File);
2442 if (I == FileDecls.end())
2443 return;
2444
2445 LocDeclsTy &LocDecls = *I->second;
2446 if (LocDecls.empty())
2447 return;
2448
2449 LocDeclsTy::iterator BeginIt =
2450 llvm::partition_point(LocDecls, [=](std::pair<unsigned, Decl *> LD) {
2451 return LD.first < Offset;
2452 });
2453 if (BeginIt != LocDecls.begin())
2454 --BeginIt;
2455
2456 // If we are pointing at a top-level decl inside an objc container, we need
2457 // to backtrack until we find it otherwise we will fail to report that the
2458 // region overlaps with an objc container.
2459 while (BeginIt != LocDecls.begin() &&
2460 BeginIt->second->isTopLevelDeclInObjCContainer())
2461 --BeginIt;
2462
2463 LocDeclsTy::iterator EndIt = llvm::upper_bound(
2464 LocDecls, std::make_pair(Offset + Length, (Decl *)nullptr),
2465 llvm::less_first());
2466 if (EndIt != LocDecls.end())
2467 ++EndIt;
2468
2469 for (LocDeclsTy::iterator DIt = BeginIt; DIt != EndIt; ++DIt)
2470 Decls.push_back(DIt->second);
2471 }
2472
getLocation(const FileEntry * File,unsigned Line,unsigned Col) const2473 SourceLocation ASTUnit::getLocation(const FileEntry *File,
2474 unsigned Line, unsigned Col) const {
2475 const SourceManager &SM = getSourceManager();
2476 SourceLocation Loc = SM.translateFileLineCol(File, Line, Col);
2477 return SM.getMacroArgExpandedLocation(Loc);
2478 }
2479
getLocation(const FileEntry * File,unsigned Offset) const2480 SourceLocation ASTUnit::getLocation(const FileEntry *File,
2481 unsigned Offset) const {
2482 const SourceManager &SM = getSourceManager();
2483 SourceLocation FileLoc = SM.translateFileLineCol(File, 1, 1);
2484 return SM.getMacroArgExpandedLocation(FileLoc.getLocWithOffset(Offset));
2485 }
2486
2487 /// If \arg Loc is a loaded location from the preamble, returns
2488 /// the corresponding local location of the main file, otherwise it returns
2489 /// \arg Loc.
mapLocationFromPreamble(SourceLocation Loc) const2490 SourceLocation ASTUnit::mapLocationFromPreamble(SourceLocation Loc) const {
2491 FileID PreambleID;
2492 if (SourceMgr)
2493 PreambleID = SourceMgr->getPreambleFileID();
2494
2495 if (Loc.isInvalid() || !Preamble || PreambleID.isInvalid())
2496 return Loc;
2497
2498 unsigned Offs;
2499 if (SourceMgr->isInFileID(Loc, PreambleID, &Offs) && Offs < Preamble->getBounds().Size) {
2500 SourceLocation FileLoc
2501 = SourceMgr->getLocForStartOfFile(SourceMgr->getMainFileID());
2502 return FileLoc.getLocWithOffset(Offs);
2503 }
2504
2505 return Loc;
2506 }
2507
2508 /// If \arg Loc is a local location of the main file but inside the
2509 /// preamble chunk, returns the corresponding loaded location from the
2510 /// preamble, otherwise it returns \arg Loc.
mapLocationToPreamble(SourceLocation Loc) const2511 SourceLocation ASTUnit::mapLocationToPreamble(SourceLocation Loc) const {
2512 FileID PreambleID;
2513 if (SourceMgr)
2514 PreambleID = SourceMgr->getPreambleFileID();
2515
2516 if (Loc.isInvalid() || !Preamble || PreambleID.isInvalid())
2517 return Loc;
2518
2519 unsigned Offs;
2520 if (SourceMgr->isInFileID(Loc, SourceMgr->getMainFileID(), &Offs) &&
2521 Offs < Preamble->getBounds().Size) {
2522 SourceLocation FileLoc = SourceMgr->getLocForStartOfFile(PreambleID);
2523 return FileLoc.getLocWithOffset(Offs);
2524 }
2525
2526 return Loc;
2527 }
2528
isInPreambleFileID(SourceLocation Loc) const2529 bool ASTUnit::isInPreambleFileID(SourceLocation Loc) const {
2530 FileID FID;
2531 if (SourceMgr)
2532 FID = SourceMgr->getPreambleFileID();
2533
2534 if (Loc.isInvalid() || FID.isInvalid())
2535 return false;
2536
2537 return SourceMgr->isInFileID(Loc, FID);
2538 }
2539
isInMainFileID(SourceLocation Loc) const2540 bool ASTUnit::isInMainFileID(SourceLocation Loc) const {
2541 FileID FID;
2542 if (SourceMgr)
2543 FID = SourceMgr->getMainFileID();
2544
2545 if (Loc.isInvalid() || FID.isInvalid())
2546 return false;
2547
2548 return SourceMgr->isInFileID(Loc, FID);
2549 }
2550
getEndOfPreambleFileID() const2551 SourceLocation ASTUnit::getEndOfPreambleFileID() const {
2552 FileID FID;
2553 if (SourceMgr)
2554 FID = SourceMgr->getPreambleFileID();
2555
2556 if (FID.isInvalid())
2557 return {};
2558
2559 return SourceMgr->getLocForEndOfFile(FID);
2560 }
2561
getStartOfMainFileID() const2562 SourceLocation ASTUnit::getStartOfMainFileID() const {
2563 FileID FID;
2564 if (SourceMgr)
2565 FID = SourceMgr->getMainFileID();
2566
2567 if (FID.isInvalid())
2568 return {};
2569
2570 return SourceMgr->getLocForStartOfFile(FID);
2571 }
2572
2573 llvm::iterator_range<PreprocessingRecord::iterator>
getLocalPreprocessingEntities() const2574 ASTUnit::getLocalPreprocessingEntities() const {
2575 if (isMainFileAST()) {
2576 serialization::ModuleFile &
2577 Mod = Reader->getModuleManager().getPrimaryModule();
2578 return Reader->getModulePreprocessedEntities(Mod);
2579 }
2580
2581 if (PreprocessingRecord *PPRec = PP->getPreprocessingRecord())
2582 return llvm::make_range(PPRec->local_begin(), PPRec->local_end());
2583
2584 return llvm::make_range(PreprocessingRecord::iterator(),
2585 PreprocessingRecord::iterator());
2586 }
2587
visitLocalTopLevelDecls(void * context,DeclVisitorFn Fn)2588 bool ASTUnit::visitLocalTopLevelDecls(void *context, DeclVisitorFn Fn) {
2589 if (isMainFileAST()) {
2590 serialization::ModuleFile &
2591 Mod = Reader->getModuleManager().getPrimaryModule();
2592 for (const auto *D : Reader->getModuleFileLevelDecls(Mod)) {
2593 if (!Fn(context, D))
2594 return false;
2595 }
2596
2597 return true;
2598 }
2599
2600 for (ASTUnit::top_level_iterator TL = top_level_begin(),
2601 TLEnd = top_level_end();
2602 TL != TLEnd; ++TL) {
2603 if (!Fn(context, *TL))
2604 return false;
2605 }
2606
2607 return true;
2608 }
2609
getPCHFile()2610 const FileEntry *ASTUnit::getPCHFile() {
2611 if (!Reader)
2612 return nullptr;
2613
2614 serialization::ModuleFile *Mod = nullptr;
2615 Reader->getModuleManager().visit([&Mod](serialization::ModuleFile &M) {
2616 switch (M.Kind) {
2617 case serialization::MK_ImplicitModule:
2618 case serialization::MK_ExplicitModule:
2619 case serialization::MK_PrebuiltModule:
2620 return true; // skip dependencies.
2621 case serialization::MK_PCH:
2622 Mod = &M;
2623 return true; // found it.
2624 case serialization::MK_Preamble:
2625 return false; // look in dependencies.
2626 case serialization::MK_MainFile:
2627 return false; // look in dependencies.
2628 }
2629
2630 return true;
2631 });
2632 if (Mod)
2633 return Mod->File;
2634
2635 return nullptr;
2636 }
2637
isModuleFile() const2638 bool ASTUnit::isModuleFile() const {
2639 return isMainFileAST() && getLangOpts().isCompilingModule();
2640 }
2641
getInputKind() const2642 InputKind ASTUnit::getInputKind() const {
2643 auto &LangOpts = getLangOpts();
2644
2645 Language Lang;
2646 if (LangOpts.OpenCL)
2647 Lang = Language::OpenCL;
2648 else if (LangOpts.CUDA)
2649 Lang = Language::CUDA;
2650 else if (LangOpts.RenderScript)
2651 Lang = Language::RenderScript;
2652 else if (LangOpts.CPlusPlus)
2653 Lang = LangOpts.ObjC ? Language::ObjCXX : Language::CXX;
2654 else
2655 Lang = LangOpts.ObjC ? Language::ObjC : Language::C;
2656
2657 InputKind::Format Fmt = InputKind::Source;
2658 if (LangOpts.getCompilingModule() == LangOptions::CMK_ModuleMap)
2659 Fmt = InputKind::ModuleMap;
2660
2661 // We don't know if input was preprocessed. Assume not.
2662 bool PP = false;
2663
2664 return InputKind(Lang, Fmt, PP);
2665 }
2666
2667 #ifndef NDEBUG
ConcurrencyState()2668 ASTUnit::ConcurrencyState::ConcurrencyState() {
2669 Mutex = new std::recursive_mutex;
2670 }
2671
~ConcurrencyState()2672 ASTUnit::ConcurrencyState::~ConcurrencyState() {
2673 delete static_cast<std::recursive_mutex *>(Mutex);
2674 }
2675
start()2676 void ASTUnit::ConcurrencyState::start() {
2677 bool acquired = static_cast<std::recursive_mutex *>(Mutex)->try_lock();
2678 assert(acquired && "Concurrent access to ASTUnit!");
2679 }
2680
finish()2681 void ASTUnit::ConcurrencyState::finish() {
2682 static_cast<std::recursive_mutex *>(Mutex)->unlock();
2683 }
2684
2685 #else // NDEBUG
2686
ConcurrencyState()2687 ASTUnit::ConcurrencyState::ConcurrencyState() { Mutex = nullptr; }
~ConcurrencyState()2688 ASTUnit::ConcurrencyState::~ConcurrencyState() {}
start()2689 void ASTUnit::ConcurrencyState::start() {}
finish()2690 void ASTUnit::ConcurrencyState::finish() {}
2691
2692 #endif // NDEBUG
2693