clang-tools 19.0.0git
ParsedAST.cpp
Go to the documentation of this file.
1//===--- ParsedAST.cpp -------------------------------------------*- C++-*-===//
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#include "ParsedAST.h"
10#include "../clang-tidy/ClangTidyCheck.h"
11#include "../clang-tidy/ClangTidyDiagnosticConsumer.h"
12#include "../clang-tidy/ClangTidyModule.h"
13#include "../clang-tidy/ClangTidyModuleRegistry.h"
14#include "../clang-tidy/ClangTidyOptions.h"
15#include "AST.h"
16#include "CollectMacros.h"
17#include "Compiler.h"
18#include "Config.h"
19#include "Diagnostics.h"
20#include "Feature.h"
21#include "FeatureModule.h"
22#include "Headers.h"
23#include "HeuristicResolver.h"
24#include "IncludeCleaner.h"
25#include "IncludeFixer.h"
26#include "Preamble.h"
27#include "SourceCode.h"
28#include "TidyProvider.h"
29#include "clang-include-cleaner/Record.h"
30#include "index/Symbol.h"
31#include "support/Logger.h"
32#include "support/Path.h"
33#include "support/Trace.h"
34#include "clang/AST/ASTContext.h"
35#include "clang/AST/Decl.h"
36#include "clang/AST/DeclGroup.h"
37#include "clang/AST/ExternalASTSource.h"
38#include "clang/ASTMatchers/ASTMatchFinder.h"
39#include "clang/Basic/Diagnostic.h"
40#include "clang/Basic/DiagnosticIDs.h"
41#include "clang/Basic/DiagnosticSema.h"
42#include "clang/Basic/FileEntry.h"
43#include "clang/Basic/LLVM.h"
44#include "clang/Basic/LangOptions.h"
45#include "clang/Basic/SourceLocation.h"
46#include "clang/Basic/SourceManager.h"
47#include "clang/Basic/TokenKinds.h"
48#include "clang/Frontend/CompilerInstance.h"
49#include "clang/Frontend/CompilerInvocation.h"
50#include "clang/Frontend/FrontendActions.h"
51#include "clang/Frontend/FrontendOptions.h"
52#include "clang/Frontend/PrecompiledPreamble.h"
53#include "clang/Lex/Lexer.h"
54#include "clang/Lex/PPCallbacks.h"
55#include "clang/Lex/Preprocessor.h"
56#include "clang/Serialization/ASTWriter.h"
57#include "clang/Tooling/CompilationDatabase.h"
58#include "clang/Tooling/Core/Diagnostic.h"
59#include "clang/Tooling/Syntax/Tokens.h"
60#include "llvm/ADT/ArrayRef.h"
61#include "llvm/ADT/DenseMap.h"
62#include "llvm/ADT/DenseSet.h"
63#include "llvm/ADT/STLExtras.h"
64#include "llvm/ADT/STLFunctionalExtras.h"
65#include "llvm/ADT/SmallVector.h"
66#include "llvm/ADT/StringRef.h"
67#include "llvm/Support/Error.h"
68#include "llvm/Support/MemoryBuffer.h"
69#include <cassert>
70#include <cstddef>
71#include <iterator>
72#include <memory>
73#include <optional>
74#include <string>
75#include <tuple>
76#include <utility>
77#include <vector>
78
79// Force the linker to link in Clang-tidy modules.
80// clangd doesn't support the static analyzer.
81#if CLANGD_TIDY_CHECKS
82#define CLANG_TIDY_DISABLE_STATIC_ANALYZER_CHECKS
83#include "../clang-tidy/ClangTidyForceLinker.h"
84#endif
85
86namespace clang {
87namespace clangd {
88namespace {
89
90template <class T> std::size_t getUsedBytes(const std::vector<T> &Vec) {
91 return Vec.capacity() * sizeof(T);
92}
93
94class DeclTrackingASTConsumer : public ASTConsumer {
95public:
96 DeclTrackingASTConsumer(std::vector<Decl *> &TopLevelDecls)
97 : TopLevelDecls(TopLevelDecls) {}
98
99 bool HandleTopLevelDecl(DeclGroupRef DG) override {
100 for (Decl *D : DG) {
101 auto &SM = D->getASTContext().getSourceManager();
102 if (!isInsideMainFile(D->getLocation(), SM))
103 continue;
104 if (const NamedDecl *ND = dyn_cast<NamedDecl>(D))
106 continue;
107
108 // ObjCMethodDecl are not actually top-level decls.
109 if (isa<ObjCMethodDecl>(D))
110 continue;
111
112 TopLevelDecls.push_back(D);
113 }
114 return true;
115 }
116
117private:
118 std::vector<Decl *> &TopLevelDecls;
119};
120
121class ClangdFrontendAction : public SyntaxOnlyAction {
122public:
123 std::vector<Decl *> takeTopLevelDecls() { return std::move(TopLevelDecls); }
124
125protected:
126 std::unique_ptr<ASTConsumer>
127 CreateASTConsumer(CompilerInstance &CI, llvm::StringRef InFile) override {
128 return std::make_unique<DeclTrackingASTConsumer>(/*ref*/ TopLevelDecls);
129 }
130
131private:
132 std::vector<Decl *> TopLevelDecls;
133};
134
135// When using a preamble, only preprocessor events outside its bounds are seen.
136// This is almost what we want: replaying transitive preprocessing wastes time.
137// However this confuses clang-tidy checks: they don't see any #includes!
138// So we replay the *non-transitive* #includes that appear in the main-file.
139// It would be nice to replay other events (macro definitions, ifdefs etc) but
140// this addresses the most common cases fairly cheaply.
141class ReplayPreamble : private PPCallbacks {
142public:
143 // Attach preprocessor hooks such that preamble events will be injected at
144 // the appropriate time.
145 // Events will be delivered to the *currently registered* PP callbacks.
146 static void attach(std::vector<Inclusion> Includes, CompilerInstance &Clang,
147 const PreambleBounds &PB) {
148 auto &PP = Clang.getPreprocessor();
149 auto *ExistingCallbacks = PP.getPPCallbacks();
150 // No need to replay events if nobody is listening.
151 if (!ExistingCallbacks)
152 return;
153 PP.addPPCallbacks(std::unique_ptr<PPCallbacks>(new ReplayPreamble(
154 std::move(Includes), ExistingCallbacks, Clang.getSourceManager(), PP,
155 Clang.getLangOpts(), PB)));
156 // We're relying on the fact that addPPCallbacks keeps the old PPCallbacks
157 // around, creating a chaining wrapper. Guard against other implementations.
158 assert(PP.getPPCallbacks() != ExistingCallbacks &&
159 "Expected chaining implementation");
160 }
161
162private:
163 ReplayPreamble(std::vector<Inclusion> Includes, PPCallbacks *Delegate,
164 const SourceManager &SM, Preprocessor &PP,
165 const LangOptions &LangOpts, const PreambleBounds &PB)
166 : Includes(std::move(Includes)), Delegate(Delegate), SM(SM), PP(PP) {
167 // Only tokenize the preamble section of the main file, as we are not
168 // interested in the rest of the tokens.
169 MainFileTokens = syntax::tokenize(
170 syntax::FileRange(SM.getMainFileID(), 0, PB.Size), SM, LangOpts);
171 }
172
173 // In a normal compile, the preamble traverses the following structure:
174 //
175 // mainfile.cpp
176 // <built-in>
177 // ... macro definitions like __cplusplus ...
178 // <command-line>
179 // ... macro definitions for args like -Dfoo=bar ...
180 // "header1.h"
181 // ... header file contents ...
182 // "header2.h"
183 // ... header file contents ...
184 // ... main file contents ...
185 //
186 // When using a preamble, the "header1" and "header2" subtrees get skipped.
187 // We insert them right after the built-in header, which still appears.
188 void FileChanged(SourceLocation Loc, FileChangeReason Reason,
189 SrcMgr::CharacteristicKind Kind, FileID PrevFID) override {
190 // It'd be nice if there was a better way to identify built-in headers...
191 if (Reason == FileChangeReason::ExitFile &&
192 SM.getBufferOrFake(PrevFID).getBufferIdentifier() == "<built-in>")
193 replay();
194 }
195
196 void replay() {
197 for (const auto &Inc : Includes) {
198 OptionalFileEntryRef File;
199 if (Inc.Resolved != "")
200 File = expectedToOptional(SM.getFileManager().getFileRef(Inc.Resolved));
201
202 // Re-lex the #include directive to find its interesting parts.
203 auto HashLoc = SM.getComposedLoc(SM.getMainFileID(), Inc.HashOffset);
204 auto HashTok = llvm::partition_point(MainFileTokens,
205 [&HashLoc](const syntax::Token &T) {
206 return T.location() < HashLoc;
207 });
208 assert(HashTok != MainFileTokens.end() && HashTok->kind() == tok::hash);
209
210 auto IncludeTok = std::next(HashTok);
211 assert(IncludeTok != MainFileTokens.end());
212
213 auto FileTok = std::next(IncludeTok);
214 assert(FileTok != MainFileTokens.end());
215
216 // Create a fake import/include token, none of the callers seem to care
217 // about clang::Token::Flags.
218 Token SynthesizedIncludeTok;
219 SynthesizedIncludeTok.startToken();
220 SynthesizedIncludeTok.setLocation(IncludeTok->location());
221 SynthesizedIncludeTok.setLength(IncludeTok->length());
222 SynthesizedIncludeTok.setKind(tok::raw_identifier);
223 SynthesizedIncludeTok.setRawIdentifierData(IncludeTok->text(SM).data());
224 PP.LookUpIdentifierInfo(SynthesizedIncludeTok);
225
226 // Same here, create a fake one for Filename, including angles or quotes.
227 Token SynthesizedFilenameTok;
228 SynthesizedFilenameTok.startToken();
229 SynthesizedFilenameTok.setLocation(FileTok->location());
230 // Note that we can't make use of FileTok->length/text in here as in the
231 // case of angled includes this will contain tok::less instead of
232 // filename. Whereas Inc.Written contains the full header name including
233 // quotes/angles.
234 SynthesizedFilenameTok.setLength(Inc.Written.length());
235 SynthesizedFilenameTok.setKind(tok::header_name);
236 SynthesizedFilenameTok.setLiteralData(Inc.Written.data());
237
238 llvm::StringRef WrittenFilename =
239 llvm::StringRef(Inc.Written).drop_front().drop_back();
240 Delegate->InclusionDirective(
241 HashTok->location(), SynthesizedIncludeTok, WrittenFilename,
242 Inc.Written.front() == '<',
243 syntax::FileRange(SM, SynthesizedFilenameTok.getLocation(),
244 SynthesizedFilenameTok.getEndLoc())
245 .toCharRange(SM),
246 File, "SearchPath", "RelPath",
247 /*SuggestedModule=*/nullptr, /*ModuleImported=*/false, Inc.FileKind);
248 if (File)
249 Delegate->FileSkipped(*File, SynthesizedFilenameTok, Inc.FileKind);
250 }
251 }
252
253 const std::vector<Inclusion> Includes;
254 PPCallbacks *Delegate;
255 const SourceManager &SM;
256 Preprocessor &PP;
257 std::vector<syntax::Token> MainFileTokens;
258};
259
260// Filter for clang diagnostics groups enabled by CTOptions.Checks.
261//
262// These are check names like clang-diagnostics-unused.
263// Note that unlike -Wunused, clang-diagnostics-unused does not imply
264// subcategories like clang-diagnostics-unused-function.
265//
266// This is used to determine which diagnostics can be enabled by ExtraArgs in
267// the clang-tidy configuration.
268class TidyDiagnosticGroups {
269 // Whether all diagnostic groups are enabled by default.
270 // True if we've seen clang-diagnostic-*.
271 bool Default = false;
272 // Set of diag::Group whose enablement != Default.
273 // If Default is false, this is foo where we've seen clang-diagnostic-foo.
274 llvm::DenseSet<unsigned> Exceptions;
275
276public:
277 TidyDiagnosticGroups(llvm::StringRef Checks) {
278 constexpr llvm::StringLiteral CDPrefix = "clang-diagnostic-";
279
280 llvm::StringRef Check;
281 while (!Checks.empty()) {
282 std::tie(Check, Checks) = Checks.split(',');
283 if (Check.empty())
284 continue;
285
286 bool Enable = !Check.consume_front("-");
287 bool Glob = Check.consume_back("*");
288 if (Glob) {
289 // Is this clang-diagnostic-*, or *, or so?
290 // (We ignore all other types of globs).
291 if (CDPrefix.starts_with(Check)) {
292 Default = Enable;
293 Exceptions.clear();
294 }
295 continue;
296 }
297
298 // In "*,clang-diagnostic-foo", the latter is a no-op.
299 if (Default == Enable)
300 continue;
301 // The only non-glob entries we care about are clang-diagnostic-foo.
302 if (!Check.consume_front(CDPrefix))
303 continue;
304
305 if (auto Group = DiagnosticIDs::getGroupForWarningOption(Check))
306 Exceptions.insert(static_cast<unsigned>(*Group));
307 }
308 }
309
310 bool operator()(diag::Group GroupID) const {
311 return Exceptions.contains(static_cast<unsigned>(GroupID)) ? !Default
312 : Default;
313 }
314};
315
316// Find -W<group> and -Wno-<group> options in ExtraArgs and apply them to Diags.
317//
318// This is used to handle ExtraArgs in clang-tidy configuration.
319// We don't use clang's standard handling of this as we want slightly different
320// behavior (e.g. we want to exclude these from -Wno-error).
321void applyWarningOptions(llvm::ArrayRef<std::string> ExtraArgs,
322 llvm::function_ref<bool(diag::Group)> EnabledGroups,
323 DiagnosticsEngine &Diags) {
324 for (llvm::StringRef Group : ExtraArgs) {
325 // Only handle args that are of the form -W[no-]<group>.
326 // Other flags are possible but rare and deliberately out of scope.
327 llvm::SmallVector<diag::kind> Members;
328 if (!Group.consume_front("-W") || Group.empty())
329 continue;
330 bool Enable = !Group.consume_front("no-");
331 if (Diags.getDiagnosticIDs()->getDiagnosticsInGroup(
332 diag::Flavor::WarningOrError, Group, Members))
333 continue;
334
335 // Upgrade (or downgrade) the severity of each diagnostic in the group.
336 // If -Werror is on, newly added warnings will be treated as errors.
337 // We don't want this, so keep track of them to fix afterwards.
338 bool NeedsWerrorExclusion = false;
339 for (diag::kind ID : Members) {
340 if (Enable) {
341 if (Diags.getDiagnosticLevel(ID, SourceLocation()) <
342 DiagnosticsEngine::Warning) {
343 auto Group = DiagnosticIDs::getGroupForDiag(ID);
344 if (!Group || !EnabledGroups(*Group))
345 continue;
346 Diags.setSeverity(ID, diag::Severity::Warning, SourceLocation());
347 if (Diags.getWarningsAsErrors())
348 NeedsWerrorExclusion = true;
349 }
350 } else {
351 Diags.setSeverity(ID, diag::Severity::Ignored, SourceLocation());
352 }
353 }
354 if (NeedsWerrorExclusion) {
355 // FIXME: there's no API to suppress -Werror for single diagnostics.
356 // In some cases with sub-groups, we may end up erroneously
357 // downgrading diagnostics that were -Werror in the compile command.
358 Diags.setDiagnosticGroupWarningAsError(Group, false);
359 }
360 }
361}
362
363std::vector<Diag> getIncludeCleanerDiags(ParsedAST &AST, llvm::StringRef Code,
364 const ThreadsafeFS &TFS) {
365 auto &Cfg = Config::current();
366 if (Cfg.Diagnostics.SuppressAll)
367 return {};
368 bool SuppressMissing =
369 Cfg.Diagnostics.Suppress.contains("missing-includes") ||
371 bool SuppressUnused =
372 Cfg.Diagnostics.Suppress.contains("unused-includes") ||
374 if (SuppressMissing && SuppressUnused)
375 return {};
376 auto Findings = computeIncludeCleanerFindings(AST);
377 if (SuppressMissing)
378 Findings.MissingIncludes.clear();
379 if (SuppressUnused)
380 Findings.UnusedIncludes.clear();
381 return issueIncludeCleanerDiagnostics(AST, Code, Findings, TFS,
383}
384
385tidy::ClangTidyCheckFactories
386filterFastTidyChecks(const tidy::ClangTidyCheckFactories &All,
388 if (Policy == Config::FastCheckPolicy::None)
389 return All;
390 bool AllowUnknown = Policy == Config::FastCheckPolicy::Loose;
391 tidy::ClangTidyCheckFactories Fast;
392 for (const auto &Factory : All) {
393 if (isFastTidyCheck(Factory.getKey()).value_or(AllowUnknown))
394 Fast.registerCheckFactory(Factory.first(), Factory.second);
395 }
396 return Fast;
397}
398
399} // namespace
400
401std::optional<ParsedAST>
402ParsedAST::build(llvm::StringRef Filename, const ParseInputs &Inputs,
403 std::unique_ptr<clang::CompilerInvocation> CI,
404 llvm::ArrayRef<Diag> CompilerInvocationDiags,
405 std::shared_ptr<const PreambleData> Preamble) {
406 trace::Span Tracer("BuildAST");
407 SPAN_ATTACH(Tracer, "File", Filename);
408 const Config &Cfg = Config::current();
409
410 auto VFS = Inputs.TFS->view(Inputs.CompileCommand.Directory);
411 if (Preamble && Preamble->StatCache)
412 VFS = Preamble->StatCache->getConsumingFS(std::move(VFS));
413
414 assert(CI);
415
416 if (CI->getFrontendOpts().Inputs.size() > 0) {
417 auto Lang = CI->getFrontendOpts().Inputs[0].getKind().getLanguage();
418 if (Lang == Language::Asm || Lang == Language::LLVM_IR) {
419 elog("Clangd does not support assembly or IR source files");
420 return std::nullopt;
421 }
422 }
423
424 // Command-line parsing sets DisableFree to true by default, but we don't want
425 // to leak memory in clangd.
426 CI->getFrontendOpts().DisableFree = false;
427 const PrecompiledPreamble *PreamblePCH =
428 Preamble ? &Preamble->Preamble : nullptr;
429
430 // This is on-by-default in windows to allow parsing SDK headers, but it
431 // breaks many features. Disable it for the main-file (not preamble).
432 CI->getLangOpts().DelayedTemplateParsing = false;
433
434 std::vector<std::unique_ptr<FeatureModule::ASTListener>> ASTListeners;
435 if (Inputs.FeatureModules) {
436 for (auto &M : *Inputs.FeatureModules) {
437 if (auto Listener = M.astListeners())
438 ASTListeners.emplace_back(std::move(Listener));
439 }
440 }
441 StoreDiags ASTDiags;
442 ASTDiags.setDiagCallback(
443 [&ASTListeners](const clang::Diagnostic &D, clangd::Diag &Diag) {
444 for (const auto &L : ASTListeners)
445 L->sawDiagnostic(D, Diag);
446 });
447
448 std::optional<PreamblePatch> Patch;
449 // We might use an ignoring diagnostic consumer if they are going to be
450 // dropped later on to not pay for extra latency by processing them.
451 DiagnosticConsumer *DiagConsumer = &ASTDiags;
452 IgnoreDiagnostics DropDiags;
453 if (Preamble) {
455 Patch->apply(*CI);
456 }
458 std::move(CI), PreamblePCH,
459 llvm::MemoryBuffer::getMemBufferCopy(Inputs.Contents, Filename), VFS,
460 *DiagConsumer);
461 if (!Clang) {
462 // The last diagnostic contains information about the reason of this
463 // failure.
464 std::vector<Diag> Diags(ASTDiags.take());
465 elog("Failed to prepare a compiler instance: {0}",
466 !Diags.empty() ? static_cast<DiagBase &>(Diags.back()).Message
467 : "unknown error");
468 return std::nullopt;
469 }
470 tidy::ClangTidyOptions ClangTidyOpts;
471 {
472 trace::Span Tracer("ClangTidyOpts");
473 ClangTidyOpts = getTidyOptionsForFile(Inputs.ClangTidyProvider, Filename);
474 dlog("ClangTidy configuration for file {0}: {1}", Filename,
475 tidy::configurationAsText(ClangTidyOpts));
476
477 // If clang-tidy is configured to emit clang warnings, we should too.
478 //
479 // Such clang-tidy configuration consists of two parts:
480 // - ExtraArgs: ["-Wfoo"] causes clang to produce the warnings
481 // - Checks: "clang-diagnostic-foo" prevents clang-tidy filtering them out
482 //
483 // In clang-tidy, diagnostics are emitted if they pass both checks.
484 // When groups contain subgroups, -Wparent includes the child, but
485 // clang-diagnostic-parent does not.
486 //
487 // We *don't* want to change the compile command directly. This can have
488 // too many unexpected effects: breaking the command, interactions with
489 // -- and -Werror, etc. Besides, we've already parsed the command.
490 // Instead we parse the -W<group> flags and handle them directly.
491 //
492 // Similarly, we don't want to use Checks to filter clang diagnostics after
493 // they are generated, as this spreads clang-tidy emulation everywhere.
494 // Instead, we just use these to filter which extra diagnostics we enable.
495 auto &Diags = Clang->getDiagnostics();
496 TidyDiagnosticGroups TidyGroups(ClangTidyOpts.Checks ? *ClangTidyOpts.Checks
497 : llvm::StringRef());
498 if (ClangTidyOpts.ExtraArgsBefore)
499 applyWarningOptions(*ClangTidyOpts.ExtraArgsBefore, TidyGroups, Diags);
500 if (ClangTidyOpts.ExtraArgs)
501 applyWarningOptions(*ClangTidyOpts.ExtraArgs, TidyGroups, Diags);
502 }
503
504 auto Action = std::make_unique<ClangdFrontendAction>();
505 const FrontendInputFile &MainInput = Clang->getFrontendOpts().Inputs[0];
506 if (!Action->BeginSourceFile(*Clang, MainInput)) {
507 log("BeginSourceFile() failed when building AST for {0}",
508 MainInput.getFile());
509 return std::nullopt;
510 }
511 // If we saw an include guard in the preamble section of the main file,
512 // mark the main-file as include-guarded.
513 // This information is part of the HeaderFileInfo but is not loaded from the
514 // preamble as the file's size is part of its identity and may have changed.
515 // (The rest of HeaderFileInfo is not relevant for our purposes).
516 if (Preamble && Preamble->MainIsIncludeGuarded) {
517 const SourceManager &SM = Clang->getSourceManager();
518 OptionalFileEntryRef MainFE = SM.getFileEntryRefForID(SM.getMainFileID());
519 Clang->getPreprocessor().getHeaderSearchInfo().MarkFileIncludeOnce(*MainFE);
520 }
521
522 // Set up ClangTidy. Must happen after BeginSourceFile() so ASTContext exists.
523 // Clang-tidy has some limitations to ensure reasonable performance:
524 // - checks don't see all preprocessor events in the preamble
525 // - matchers run only over the main-file top-level decls (and can't see
526 // ancestors outside this scope).
527 // In practice almost all checks work well without modifications.
528 std::vector<std::unique_ptr<tidy::ClangTidyCheck>> CTChecks;
529 ast_matchers::MatchFinder CTFinder;
530 std::optional<tidy::ClangTidyContext> CTContext;
531 // Must outlive FixIncludes.
532 auto BuildDir = VFS->getCurrentWorkingDirectory();
533 std::optional<IncludeFixer> FixIncludes;
534 llvm::DenseMap<diag::kind, DiagnosticsEngine::Level> OverriddenSeverity;
535 // No need to run clang-tidy or IncludeFixerif we are not going to surface
536 // diagnostics.
537 {
538 trace::Span Tracer("ClangTidyInit");
539 static const auto *AllCTFactories = [] {
540 auto *CTFactories = new tidy::ClangTidyCheckFactories;
541 for (const auto &E : tidy::ClangTidyModuleRegistry::entries())
542 E.instantiate()->addCheckFactories(*CTFactories);
543 return CTFactories;
544 }();
545 tidy::ClangTidyCheckFactories FastFactories = filterFastTidyChecks(
546 *AllCTFactories, Cfg.Diagnostics.ClangTidy.FastCheckFilter);
547 CTContext.emplace(std::make_unique<tidy::DefaultOptionsProvider>(
548 tidy::ClangTidyGlobalOptions(), ClangTidyOpts));
549 CTContext->setDiagnosticsEngine(&Clang->getDiagnostics());
550 CTContext->setASTContext(&Clang->getASTContext());
551 CTContext->setCurrentFile(Filename);
552 CTContext->setSelfContainedDiags(true);
553 CTChecks = FastFactories.createChecksForLanguage(&*CTContext);
554 Preprocessor *PP = &Clang->getPreprocessor();
555 for (const auto &Check : CTChecks) {
556 Check->registerPPCallbacks(Clang->getSourceManager(), PP, PP);
557 Check->registerMatchers(&CTFinder);
558 }
559
560 // Clang only corrects typos for use of undeclared functions in C if that
561 // use is an error. Include fixer relies on typo correction, so pretend
562 // this is an error. (The actual typo correction is nice too).
563 // We restore the original severity in the level adjuster.
564 // FIXME: It would be better to have a real API for this, but what?
565 for (auto ID : {diag::ext_implicit_function_decl_c99,
566 diag::ext_implicit_lib_function_decl,
567 diag::ext_implicit_lib_function_decl_c99,
568 diag::warn_implicit_function_decl}) {
569 OverriddenSeverity.try_emplace(
570 ID, Clang->getDiagnostics().getDiagnosticLevel(ID, SourceLocation()));
571 Clang->getDiagnostics().setSeverity(ID, diag::Severity::Error,
572 SourceLocation());
573 }
574
575 ASTDiags.setLevelAdjuster([&](DiagnosticsEngine::Level DiagLevel,
576 const clang::Diagnostic &Info) {
577 if (Cfg.Diagnostics.SuppressAll ||
578 isBuiltinDiagnosticSuppressed(Info.getID(), Cfg.Diagnostics.Suppress,
579 Clang->getLangOpts()))
580 return DiagnosticsEngine::Ignored;
581
582 auto It = OverriddenSeverity.find(Info.getID());
583 if (It != OverriddenSeverity.end())
584 DiagLevel = It->second;
585
586 if (!CTChecks.empty()) {
587 std::string CheckName = CTContext->getCheckName(Info.getID());
588 bool IsClangTidyDiag = !CheckName.empty();
589 if (IsClangTidyDiag) {
590 if (Cfg.Diagnostics.Suppress.contains(CheckName))
591 return DiagnosticsEngine::Ignored;
592 // Check for suppression comment. Skip the check for diagnostics not
593 // in the main file, because we don't want that function to query the
594 // source buffer for preamble files. For the same reason, we ask
595 // shouldSuppressDiagnostic to avoid I/O.
596 // We let suppression comments take precedence over warning-as-error
597 // to match clang-tidy's behaviour.
598 bool IsInsideMainFile =
599 Info.hasSourceManager() &&
600 isInsideMainFile(Info.getLocation(), Info.getSourceManager());
601 SmallVector<tooling::Diagnostic, 1> TidySuppressedErrors;
602 if (IsInsideMainFile && CTContext->shouldSuppressDiagnostic(
603 DiagLevel, Info, TidySuppressedErrors,
604 /*AllowIO=*/false,
605 /*EnableNolintBlocks=*/true)) {
606 // FIXME: should we expose the suppression error (invalid use of
607 // NOLINT comments)?
608 return DiagnosticsEngine::Ignored;
609 }
610 if (!CTContext->getOptions().SystemHeaders.value_or(false) &&
611 Info.hasSourceManager() &&
612 Info.getSourceManager().isInSystemMacro(Info.getLocation()))
613 return DiagnosticsEngine::Ignored;
614
615 // Check for warning-as-error.
616 if (DiagLevel == DiagnosticsEngine::Warning &&
617 CTContext->treatAsError(CheckName)) {
618 return DiagnosticsEngine::Error;
619 }
620 }
621 }
622 return DiagLevel;
623 });
624
625 // Add IncludeFixer which can recover diagnostics caused by missing includes
626 // (e.g. incomplete type) and attach include insertion fixes to diagnostics.
627 if (Inputs.Index && !BuildDir.getError()) {
628 auto Style =
629 getFormatStyleForFile(Filename, Inputs.Contents, *Inputs.TFS, false);
630 auto Inserter = std::make_shared<IncludeInserter>(
631 Filename, Inputs.Contents, Style, BuildDir.get(),
632 &Clang->getPreprocessor().getHeaderSearchInfo());
633 ArrayRef<Inclusion> MainFileIncludes;
634 if (Preamble) {
635 MainFileIncludes = Preamble->Includes.MainFileIncludes;
636 for (const auto &Inc : Preamble->Includes.MainFileIncludes)
637 Inserter->addExisting(Inc);
638 }
639 // FIXME: Consider piping through ASTSignals to fetch this to handle the
640 // case where a header file contains ObjC decls but no #imports.
642 Inputs.Opts.ImportInsertions
643 ? preferredIncludeDirective(Filename, Clang->getLangOpts(),
644 MainFileIncludes, {})
646 FixIncludes.emplace(Filename, Inserter, *Inputs.Index,
647 /*IndexRequestLimit=*/5, Directive);
648 ASTDiags.contributeFixes([&FixIncludes](DiagnosticsEngine::Level DiagLevl,
649 const clang::Diagnostic &Info) {
650 return FixIncludes->fix(DiagLevl, Info);
651 });
652 Clang->setExternalSemaSource(FixIncludes->unresolvedNameRecorder());
653 }
654 }
655
656 IncludeStructure Includes;
657 include_cleaner::PragmaIncludes PI;
658 // If we are using a preamble, copy existing includes.
659 if (Preamble) {
660 Includes = Preamble->Includes;
661 Includes.MainFileIncludes = Patch->preambleIncludes();
662 // Replay the preamble includes so that clang-tidy checks can see them.
663 ReplayPreamble::attach(Patch->preambleIncludes(), *Clang,
664 Patch->modifiedBounds());
665 PI = *Preamble->Pragmas;
666 }
667 // Important: collectIncludeStructure is registered *after* ReplayPreamble!
668 // Otherwise we would collect the replayed includes again...
669 // (We can't *just* use the replayed includes, they don't have Resolved path).
670 Includes.collect(*Clang);
671 // Same for pragma-includes, we're already inheriting preamble includes, so we
672 // should only receive callbacks for non-preamble mainfile includes.
673 PI.record(*Clang);
674 // Copy over the macros in the preamble region of the main file, and combine
675 // with non-preamble macros below.
676 MainFileMacros Macros;
677 std::vector<PragmaMark> Marks;
678 if (Preamble) {
679 Macros = Patch->mainFileMacros();
680 Marks = Patch->marks();
681 }
682 auto &PP = Clang->getPreprocessor();
683 PP.addPPCallbacks(std::make_unique<CollectMainFileMacros>(PP, Macros));
684
685 PP.addPPCallbacks(
686 collectPragmaMarksCallback(Clang->getSourceManager(), Marks));
687
688 // FIXME: Attach a comment handler to take care of
689 // keep/export/no_include etc. IWYU pragmas.
690
691 // Collect tokens of the main file.
692 syntax::TokenCollector CollectTokens(PP);
693
694 // To remain consistent with preamble builds, these callbacks must be called
695 // exactly here, after preprocessor is initialized and BeginSourceFile() was
696 // called already.
697 for (const auto &L : ASTListeners)
698 L->beforeExecute(*Clang);
699
700 if (llvm::Error Err = Action->Execute())
701 log("Execute() failed when building AST for {0}: {1}", MainInput.getFile(),
702 toString(std::move(Err)));
703
704 // We have to consume the tokens before running clang-tidy to avoid collecting
705 // tokens from running the preprocessor inside the checks (only
706 // modernize-use-trailing-return-type does that today).
707 syntax::TokenBuffer Tokens = std::move(CollectTokens).consume();
708 // Makes SelectionTree build much faster.
709 Tokens.indexExpandedTokens();
710 std::vector<Decl *> ParsedDecls = Action->takeTopLevelDecls();
711 // AST traversals should exclude the preamble, to avoid performance cliffs.
712 Clang->getASTContext().setTraversalScope(ParsedDecls);
713 if (!CTChecks.empty()) {
714 // Run the AST-dependent part of the clang-tidy checks.
715 // (The preprocessor part ran already, via PPCallbacks).
716 trace::Span Tracer("ClangTidyMatch");
717 CTFinder.matchAST(Clang->getASTContext());
718 }
719
720 // XXX: This is messy: clang-tidy checks flush some diagnostics at EOF.
721 // However Action->EndSourceFile() would destroy the ASTContext!
722 // So just inform the preprocessor of EOF, while keeping everything alive.
723 PP.EndSourceFile();
724 // UnitDiagsConsumer is local, we can not store it in CompilerInstance that
725 // has a longer lifetime.
726 Clang->getDiagnostics().setClient(new IgnoreDiagnostics);
727 // CompilerInstance won't run this callback, do it directly.
728 ASTDiags.EndSourceFile();
729
730 std::vector<Diag> Diags = CompilerInvocationDiags;
731 // FIXME: Also skip generation of diagnostics altogether to speed up ast
732 // builds when we are patching a stale preamble.
733 // Add diagnostics from the preamble, if any.
734 if (Preamble)
735 llvm::append_range(Diags, Patch->patchedDiags());
736 // Finally, add diagnostics coming from the AST.
737 {
738 std::vector<Diag> D = ASTDiags.take(&*CTContext);
739 Diags.insert(Diags.end(), D.begin(), D.end());
740 }
741 ParsedAST Result(Filename, Inputs.Version, std::move(Preamble),
742 std::move(Clang), std::move(Action), std::move(Tokens),
743 std::move(Macros), std::move(Marks), std::move(ParsedDecls),
744 std::move(Diags), std::move(Includes), std::move(PI));
745 llvm::move(getIncludeCleanerDiags(Result, Inputs.Contents, *Inputs.TFS),
746 std::back_inserter(Result.Diags));
747 return std::move(Result);
748}
749
750ParsedAST::ParsedAST(ParsedAST &&Other) = default;
751
752ParsedAST &ParsedAST::operator=(ParsedAST &&Other) = default;
753
754ParsedAST::~ParsedAST() {
755 if (Action) {
756 // We already notified the PP of end-of-file earlier, so detach it first.
757 // We must keep it alive until after EndSourceFile(), Sema relies on this.
758 auto PP = Clang->getPreprocessorPtr(); // Keep PP alive for now.
759 Clang->setPreprocessor(nullptr); // Detach so we don't send EOF again.
760 Action->EndSourceFile(); // Destroy ASTContext and Sema.
761 // Now Sema is gone, it's safe for PP to go out of scope.
762 }
763}
764
765ASTContext &ParsedAST::getASTContext() { return Clang->getASTContext(); }
766
767const ASTContext &ParsedAST::getASTContext() const {
768 return Clang->getASTContext();
769}
770
771Sema &ParsedAST::getSema() { return Clang->getSema(); }
772
773Preprocessor &ParsedAST::getPreprocessor() { return Clang->getPreprocessor(); }
774
775std::shared_ptr<Preprocessor> ParsedAST::getPreprocessorPtr() {
776 return Clang->getPreprocessorPtr();
777}
778
779const Preprocessor &ParsedAST::getPreprocessor() const {
780 return Clang->getPreprocessor();
781}
782
783llvm::ArrayRef<Decl *> ParsedAST::getLocalTopLevelDecls() {
784 return LocalTopLevelDecls;
785}
786
787llvm::ArrayRef<const Decl *> ParsedAST::getLocalTopLevelDecls() const {
788 return LocalTopLevelDecls;
789}
790
791const MainFileMacros &ParsedAST::getMacros() const { return Macros; }
792const std::vector<PragmaMark> &ParsedAST::getMarks() const { return Marks; }
793
794std::size_t ParsedAST::getUsedBytes() const {
795 auto &AST = getASTContext();
796 // FIXME(ibiryukov): we do not account for the dynamically allocated part of
797 // Message and Fixes inside each diagnostic.
798 std::size_t Total =
799 clangd::getUsedBytes(LocalTopLevelDecls) + clangd::getUsedBytes(Diags);
800
801 // FIXME: the rest of the function is almost a direct copy-paste from
802 // libclang's clang_getCXTUResourceUsage. We could share the implementation.
803
804 // Sum up various allocators inside the ast context and the preprocessor.
805 Total += AST.getASTAllocatedMemory();
806 Total += AST.getSideTableAllocatedMemory();
807 Total += AST.Idents.getAllocator().getTotalMemory();
808 Total += AST.Selectors.getTotalMemory();
809
810 Total += AST.getSourceManager().getContentCacheSize();
811 Total += AST.getSourceManager().getDataStructureSizes();
812 Total += AST.getSourceManager().getMemoryBufferSizes().malloc_bytes;
813
814 if (ExternalASTSource *Ext = AST.getExternalSource())
815 Total += Ext->getMemoryBufferSizes().malloc_bytes;
816
817 const Preprocessor &PP = getPreprocessor();
818 Total += PP.getTotalMemory();
819 if (PreprocessingRecord *PRec = PP.getPreprocessingRecord())
820 Total += PRec->getTotalMemory();
821 Total += PP.getHeaderSearchInfo().getTotalMemory();
822
823 return Total;
824}
825
826const IncludeStructure &ParsedAST::getIncludeStructure() const {
827 return Includes;
828}
829
830ParsedAST::ParsedAST(PathRef TUPath, llvm::StringRef Version,
831 std::shared_ptr<const PreambleData> Preamble,
832 std::unique_ptr<CompilerInstance> Clang,
833 std::unique_ptr<FrontendAction> Action,
834 syntax::TokenBuffer Tokens, MainFileMacros Macros,
835 std::vector<PragmaMark> Marks,
836 std::vector<Decl *> LocalTopLevelDecls,
837 std::vector<Diag> Diags, IncludeStructure Includes,
838 include_cleaner::PragmaIncludes PI)
839 : TUPath(TUPath), Version(Version), Preamble(std::move(Preamble)),
840 Clang(std::move(Clang)), Action(std::move(Action)),
841 Tokens(std::move(Tokens)), Macros(std::move(Macros)),
842 Marks(std::move(Marks)), Diags(std::move(Diags)),
843 LocalTopLevelDecls(std::move(LocalTopLevelDecls)),
844 Includes(std::move(Includes)), PI(std::move(PI)),
845 Resolver(std::make_unique<HeuristicResolver>(getASTContext())) {
846 assert(this->Clang);
847 assert(this->Action);
848}
849
850const include_cleaner::PragmaIncludes &ParsedAST::getPragmaIncludes() const {
851 return PI;
852}
853
854std::optional<llvm::StringRef> ParsedAST::preambleVersion() const {
855 if (!Preamble)
856 return std::nullopt;
857 return llvm::StringRef(Preamble->Version);
858}
859
860llvm::ArrayRef<Diag> ParsedAST::getDiagnostics() const { return Diags; }
861} // namespace clangd
862} // namespace clang
const Expr * E
const FunctionDecl * Decl
BindArgumentKind Kind
StringRef BuildDir
Definition: ClangTidy.cpp:305
const std::optional< PreamblePatch > Patch
const PreambleData & Preamble
std::string Code
std::unique_ptr< CompilerInstance > Clang
Include Cleaner is clangd functionality for providing diagnostics for misuse of transitive headers an...
std::string Filename
Filename as a string.
SourceLocation Loc
#define dlog(...)
Definition: Logger.h:101
const MacroDirective * Directive
FieldAction Action
const google::protobuf::Message & M
Definition: Server.cpp:309
std::string Lang
std::unique_ptr< CompilerInvocation > CI
#define SPAN_ATTACH(S, Name, Expr)
Attach a key-value pair to a Span event.
Definition: Trace.h:164
std::vector< Inclusion > MainFileIncludes
Definition: Headers.h:174
void collect(const CompilerInstance &CI)
Definition: Headers.cpp:178
std::optional< llvm::StringRef > preambleVersion() const
Returns the version of the ParseInputs used to build Preamble part of this AST.
Definition: ParsedAST.cpp:854
const include_cleaner::PragmaIncludes & getPragmaIncludes() const
Returns the PramaIncludes for preamble + main file includes.
Definition: ParsedAST.cpp:850
static std::optional< ParsedAST > build(llvm::StringRef Filename, const ParseInputs &Inputs, std::unique_ptr< clang::CompilerInvocation > CI, llvm::ArrayRef< Diag > CompilerInvocationDiags, std::shared_ptr< const PreambleData > Preamble)
Attempts to run Clang and store the parsed AST.
Definition: ParsedAST.cpp:402
llvm::ArrayRef< Diag > getDiagnostics() const
Definition: ParsedAST.cpp:860
static PreamblePatch createFullPatch(llvm::StringRef FileName, const ParseInputs &Modified, const PreambleData &Baseline)
Builds a patch that contains new PP directives introduced to the preamble section of Modified compare...
Definition: Preamble.cpp:904
StoreDiags collects the diagnostics that can later be reported by clangd.
Definition: Diagnostics.h:138
void contributeFixes(DiagFixer Fixer)
If set, possibly adds fixes for diagnostics using Fixer.
Definition: Diagnostics.h:158
void setLevelAdjuster(LevelAdjuster Adjuster)
If set, this allows the client of this class to adjust the level of diagnostics, such as promoting wa...
Definition: Diagnostics.h:162
std::vector< Diag > take(const clang::tidy::ClangTidyContext *Tidy=nullptr)
void setDiagCallback(DiagCallback CB)
Invokes a callback every time a diagnostics is completely formed.
Definition: Diagnostics.h:165
Records an event whose duration is the lifetime of the Span object.
Definition: Trace.h:143
A collection of ClangTidyCheckFactory instances.
std::vector< std::unique_ptr< ClangTidyCheck > > createChecksForLanguage(ClangTidyContext *Context) const
Create instances of checks that are enabled for the current Language.
@ Info
An information message.
IncludeCleanerFindings computeIncludeCleanerFindings(ParsedAST &AST)
bool isInsideMainFile(SourceLocation Loc, const SourceManager &SM)
Returns true iff Loc is inside the main file.
Definition: SourceCode.cpp:423
static const char * toString(OffsetEncoding OE)
Definition: Protocol.cpp:1553
bool isBuiltinDiagnosticSuppressed(unsigned ID, const llvm::StringSet<> &Suppress, const LangOptions &LangOpts)
Determine whether a (non-clang-tidy) diagnostic is suppressed by config.
std::unique_ptr< PPCallbacks > collectPragmaMarksCallback(const SourceManager &SM, std::vector< PragmaMark > &Out)
Collect all pragma marks from the main file.
std::optional< bool > isFastTidyCheck(llvm::StringRef Check)
Returns if Check is known-fast, known-slow, or its speed is unknown.
Symbol::IncludeDirective preferredIncludeDirective(llvm::StringRef FileName, const LangOptions &LangOpts, ArrayRef< Inclusion > MainFileIncludes, ArrayRef< const Decl * > TopLevelDecls)
Infer the include directive to use for the given FileName.
Definition: AST.cpp:363
std::vector< Diag > issueIncludeCleanerDiagnostics(ParsedAST &AST, llvm::StringRef Code, const IncludeCleanerFindings &Findings, const ThreadsafeFS &TFS, HeaderFilter IgnoreHeaders)
std::unique_ptr< CompilerInstance > prepareCompilerInstance(std::unique_ptr< clang::CompilerInvocation > CI, const PrecompiledPreamble *Preamble, std::unique_ptr< llvm::MemoryBuffer > Buffer, llvm::IntrusiveRefCntPtr< llvm::vfs::FileSystem > VFS, DiagnosticConsumer &DiagsClient)
Definition: Compiler.cpp:129
void log(const char *Fmt, Ts &&... Vals)
Definition: Logger.h:67
tidy::ClangTidyOptions getTidyOptionsForFile(TidyProviderRef Provider, llvm::StringRef Filename)
bool isImplicitTemplateInstantiation(const NamedDecl *D)
Indicates if D is a template instantiation implicitly generated by the compiler, e....
Definition: AST.cpp:154
llvm::StringRef PathRef
A typedef to represent a ref to file path.
Definition: Path.h:29
void elog(const char *Fmt, Ts &&... Vals)
Definition: Logger.h:61
format::FormatStyle getFormatStyleForFile(llvm::StringRef File, llvm::StringRef Content, const ThreadsafeFS &TFS, bool FormatFile)
Choose the clang-format style we should apply to a certain file.
Definition: SourceCode.cpp:583
std::string configurationAsText(const ClangTidyOptions &Options)
Serializes configuration to a YAML-encoded string.
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Settings that express user/project preferences and control clangd behavior.
Definition: Config.h:44
struct clang::clangd::Config::@4::@13 Includes
IncludeCleaner will not diagnose usages of these headers matched by these regexes.
static const Config & current()
Returns the Config of the current Context, or an empty configuration.
Definition: Config.cpp:17
llvm::StringSet Suppress
Definition: Config.h:100
std::vector< std::function< bool(llvm::StringRef)> > IgnoreHeader
Definition: Config.h:116
IncludesPolicy UnusedIncludes
Definition: Config.h:110
IncludesPolicy MissingIncludes
Definition: Config.h:111
struct clang::clangd::Config::@4 Diagnostics
Controls warnings and errors when parsing code.
Contains basic information about a diagnostic.
Definition: Diagnostics.h:58
A top-level diagnostic that may have Notes and Fixes.
Definition: Diagnostics.h:98
Information required to run clang, e.g. to parse AST or do code completion.
Definition: Compiler.h:48
const ThreadsafeFS * TFS
Definition: Compiler.h:50
@ Include
#include "header.h"
Definition: Symbol.h:93
Contains options for clang-tidy.
std::optional< std::string > Checks
Checks filter.
std::optional< ArgList > ExtraArgsBefore
Add extra compilation arguments to the start of the list.
std::optional< ArgList > ExtraArgs
Add extra compilation arguments to the end of the list.