clang-tools  13.0.0git
Compiler.cpp
Go to the documentation of this file.
1 //===--- Compiler.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 "Compiler.h"
10 #include "support/Logger.h"
11 #include "clang/Basic/TargetInfo.h"
12 #include "clang/Lex/PreprocessorOptions.h"
13 #include "clang/Serialization/PCHContainerOperations.h"
14 #include "llvm/ADT/StringRef.h"
15 #include "llvm/Support/Format.h"
16 #include "llvm/Support/FormatVariadic.h"
17 
18 namespace clang {
19 namespace clangd {
20 
21 void IgnoreDiagnostics::log(DiagnosticsEngine::Level DiagLevel,
22  const clang::Diagnostic &Info) {
23  // FIXME: format lazily, in case vlog is off.
24  llvm::SmallString<64> Message;
25  Info.FormatDiagnostic(Message);
26 
27  llvm::SmallString<64> Location;
28  if (Info.hasSourceManager() && Info.getLocation().isValid()) {
29  auto &SourceMgr = Info.getSourceManager();
30  auto Loc = SourceMgr.getFileLoc(Info.getLocation());
31  llvm::raw_svector_ostream OS(Location);
32  Loc.print(OS, SourceMgr);
33  OS << ":";
34  }
35 
36  clangd::vlog("Ignored diagnostic. {0}{1}", Location, Message);
37 }
38 
39 void IgnoreDiagnostics::HandleDiagnostic(DiagnosticsEngine::Level DiagLevel,
40  const clang::Diagnostic &Info) {
41  IgnoreDiagnostics::log(DiagLevel, Info);
42 }
43 
44 std::unique_ptr<CompilerInvocation>
45 buildCompilerInvocation(const ParseInputs &Inputs, clang::DiagnosticConsumer &D,
46  std::vector<std::string> *CC1Args) {
47  std::vector<const char *> ArgStrs;
48  for (const auto &S : Inputs.CompileCommand.CommandLine)
49  ArgStrs.push_back(S.c_str());
50 
51  auto VFS = Inputs.TFS->view(Inputs.CompileCommand.Directory);
52  llvm::IntrusiveRefCntPtr<DiagnosticsEngine> CommandLineDiagsEngine =
53  CompilerInstance::createDiagnostics(new DiagnosticOptions, &D, false);
54  std::unique_ptr<CompilerInvocation> CI = createInvocationFromCommandLine(
55  ArgStrs, CommandLineDiagsEngine, std::move(VFS),
56  /*ShouldRecoverOnErrors=*/true, CC1Args);
57  if (!CI)
58  return nullptr;
59  // createInvocationFromCommandLine sets DisableFree.
60  CI->getFrontendOpts().DisableFree = false;
61  CI->getLangOpts()->CommentOpts.ParseAllComments = true;
62  CI->getLangOpts()->RetainCommentsFromSystemHeaders = true;
63  // Disable "clang -verify" diagnostics, they are rarely useful in clangd, and
64  // our compiler invocation set-up doesn't seem to work with it (leading
65  // assertions in VerifyDiagnosticConsumer).
66  CI->getDiagnosticOpts().VerifyDiagnostics = false;
67 
68  // Disable any dependency outputting, we don't want to generate files or write
69  // to stdout/stderr.
70  CI->getDependencyOutputOpts().ShowIncludesDest =
71  ShowIncludesDestination::None;
72  CI->getDependencyOutputOpts().OutputFile.clear();
73  CI->getDependencyOutputOpts().HeaderIncludeOutputFile.clear();
74  CI->getDependencyOutputOpts().DOTOutputFile.clear();
75  CI->getDependencyOutputOpts().ModuleDependencyOutputDir.clear();
76 
77  // Disable any pch generation/usage operations. Since serialized preamble
78  // format is unstable, using an incompatible one might result in unexpected
79  // behaviours, including crashes.
80  CI->getPreprocessorOpts().ImplicitPCHInclude.clear();
81  CI->getPreprocessorOpts().PrecompiledPreambleBytes = {0, false};
82  CI->getPreprocessorOpts().PCHThroughHeader.clear();
83  CI->getPreprocessorOpts().PCHWithHdrStop = false;
84  CI->getPreprocessorOpts().PCHWithHdrStopCreate = false;
85  // Don't crash on `#pragma clang __debug parser_crash`
86  CI->getPreprocessorOpts().DisablePragmaDebugCrash = true;
87 
88  // Always default to raw container format as clangd doesn't registry any other
89  // and clang dies when faced with unknown formats.
90  CI->getHeaderSearchOpts().ModuleFormat =
91  PCHContainerOperations().getRawReader().getFormat().str();
92 
93  return CI;
94 }
95 
96 std::unique_ptr<CompilerInstance>
97 prepareCompilerInstance(std::unique_ptr<clang::CompilerInvocation> CI,
98  const PrecompiledPreamble *Preamble,
99  std::unique_ptr<llvm::MemoryBuffer> Buffer,
100  llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> VFS,
101  DiagnosticConsumer &DiagsClient) {
102  assert(VFS && "VFS is null");
103  assert(!CI->getPreprocessorOpts().RetainRemappedFileBuffers &&
104  "Setting RetainRemappedFileBuffers to true will cause a memory leak "
105  "of ContentsBuffer");
106 
107  // NOTE: we use Buffer.get() when adding remapped files, so we have to make
108  // sure it will be released if no error is emitted.
109  if (Preamble) {
110  Preamble->OverridePreamble(*CI, VFS, Buffer.get());
111  } else {
112  CI->getPreprocessorOpts().addRemappedFile(
113  CI->getFrontendOpts().Inputs[0].getFile(), Buffer.get());
114  }
115 
116  auto Clang = std::make_unique<CompilerInstance>(
117  std::make_shared<PCHContainerOperations>());
118  Clang->setInvocation(std::move(CI));
119  Clang->createDiagnostics(&DiagsClient, false);
120 
121  if (auto VFSWithRemapping = createVFSFromCompilerInvocation(
122  Clang->getInvocation(), Clang->getDiagnostics(), VFS))
123  VFS = VFSWithRemapping;
124  Clang->createFileManager(VFS);
125 
126  if (!Clang->createTarget())
127  return nullptr;
128 
129  // RemappedFileBuffers will handle the lifetime of the Buffer pointer,
130  // release it.
131  Buffer.release();
132  return Clang;
133 }
134 
135 } // namespace clangd
136 } // namespace clang
Loc
SourceLocation Loc
Definition: KernelNameRestrictionCheck.cpp:45
clang::clangd::prepareCompilerInstance
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:97
DiagnosticConsumer
clang::clangd::Location
Definition: Protocol.h:202
CI
std::unique_ptr< CompilerInvocation > CI
Definition: TUScheduler.cpp:450
clang::tidy::bugprone::Message
static const char Message[]
Definition: ReservedIdentifierCheck.cpp:31
SourceMgr
llvm::SourceMgr * SourceMgr
Definition: ConfigCompile.cpp:102
clang::clangd::ParseInputs::CompileCommand
tooling::CompileCommand CompileCommand
Definition: Compiler.h:48
Preamble
const PreambleData & Preamble
Definition: CodeComplete.cpp:1096
Inputs
ParseInputs Inputs
Definition: TUScheduler.cpp:451
clang::clangd::ParseInputs
Information required to run clang, e.g. to parse AST or do code completion.
Definition: Compiler.h:47
ns1::ns2::D
@ D
Definition: CategoricalFeature.h:3
Diagnostic
DiagnosticCallback Diagnostic
Definition: ConfigCompile.cpp:101
clang::clangd::IgnoreDiagnostics::HandleDiagnostic
void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel, const clang::Diagnostic &Info) override
Definition: Compiler.cpp:39
clang::clangd::ParseInputs::TFS
const ThreadsafeFS * TFS
Definition: Compiler.h:49
Logger.h
clang::clangd::vlog
void vlog(const char *Fmt, Ts &&... Vals)
Definition: Logger.h:73
clang::clangd::buildCompilerInvocation
std::unique_ptr< CompilerInvocation > buildCompilerInvocation(const ParseInputs &Inputs, clang::DiagnosticConsumer &D, std::vector< std::string > *CC1Args)
Builds compiler invocation that could be used to build AST or preamble.
Definition: Compiler.cpp:45
Compiler.h
Info
FunctionInfo Info
Definition: FunctionSizeCheck.cpp:120
clang::clangd::ThreadsafeFS::view
llvm::IntrusiveRefCntPtr< llvm::vfs::FileSystem > view(llvm::NoneType CWD) const
Obtain a vfs::FileSystem with an arbitrary initial working directory.
Definition: ThreadsafeFS.h:34
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
OS
llvm::raw_string_ostream OS
Definition: TraceTests.cpp:163
clang::clangd::IgnoreDiagnostics::log
static void log(DiagnosticsEngine::Level DiagLevel, const clang::Diagnostic &Info)
Definition: Compiler.cpp:21