Coverage Report

Created: 2022-01-18 06:27

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