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
log(DiagnosticsEngine::Level DiagLevel,const clang::Diagnostic & Info)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
HandleDiagnostic(DiagnosticsEngine::Level DiagLevel,const clang::Diagnostic & Info)39 void IgnoreDiagnostics::HandleDiagnostic(DiagnosticsEngine::Level DiagLevel,
40 const clang::Diagnostic &Info) {
41 IgnoreDiagnostics::log(DiagLevel, Info);
42 }
43
44 std::unique_ptr<CompilerInvocation>
buildCompilerInvocation(const ParseInputs & Inputs,clang::DiagnosticConsumer & D,std::vector<std::string> * CC1Args)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 if (Inputs.Opts.BuildRecoveryAST)
89 CI->getLangOpts()->RecoveryAST = true;
90 if (Inputs.Opts.PreserveRecoveryASTType)
91 CI->getLangOpts()->RecoveryASTType = true;
92
93 return CI;
94 }
95
96 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)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 Clang->setTarget(TargetInfo::CreateTargetInfo(
127 Clang->getDiagnostics(), Clang->getInvocation().TargetOpts));
128 if (!Clang->hasTarget())
129 return nullptr;
130
131 // RemappedFileBuffers will handle the lifetime of the Buffer pointer,
132 // release it.
133 Buffer.release();
134 return Clang;
135 }
136
137 } // namespace clangd
138 } // namespace clang
139