Coverage Report

Created: 2020-09-15 12:33

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