Coverage Report

Created: 2021-04-24 07:00

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