xref: /freebsd/contrib/llvm-project/clang/lib/Frontend/FrontendActions.cpp (revision e40139ff33b48b56a24c808b166b04b8ee6f5b21) 
1 //===--- FrontendActions.cpp ----------------------------------------------===//
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 "clang/Frontend/FrontendActions.h"
10 #include "clang/AST/ASTConsumer.h"
11 #include "clang/Basic/FileManager.h"
12 #include "clang/Basic/LangStandard.h"
13 #include "clang/Frontend/ASTConsumers.h"
14 #include "clang/Frontend/CompilerInstance.h"
15 #include "clang/Frontend/FrontendDiagnostic.h"
16 #include "clang/Frontend/MultiplexConsumer.h"
17 #include "clang/Frontend/Utils.h"
18 #include "clang/Lex/DependencyDirectivesSourceMinimizer.h"
19 #include "clang/Lex/HeaderSearch.h"
20 #include "clang/Lex/Preprocessor.h"
21 #include "clang/Lex/PreprocessorOptions.h"
22 #include "clang/Sema/TemplateInstCallback.h"
23 #include "clang/Serialization/ASTReader.h"
24 #include "clang/Serialization/ASTWriter.h"
25 #include "llvm/Support/FileSystem.h"
26 #include "llvm/Support/MemoryBuffer.h"
27 #include "llvm/Support/Path.h"
28 #include "llvm/Support/YAMLTraits.h"
29 #include "llvm/Support/raw_ostream.h"
30 #include <memory>
31 #include <system_error>
32 
33 using namespace clang;
34 
35 namespace {
36 CodeCompleteConsumer *GetCodeCompletionConsumer(CompilerInstance &CI) {
37   return CI.hasCodeCompletionConsumer() ? &CI.getCodeCompletionConsumer()
38                                         : nullptr;
39 }
40 
41 void EnsureSemaIsCreated(CompilerInstance &CI, FrontendAction &Action) {
42   if (Action.hasCodeCompletionSupport() &&
43       !CI.getFrontendOpts().CodeCompletionAt.FileName.empty())
44     CI.createCodeCompletionConsumer();
45 
46   if (!CI.hasSema())
47     CI.createSema(Action.getTranslationUnitKind(),
48                   GetCodeCompletionConsumer(CI));
49 }
50 } // namespace
51 
52 //===----------------------------------------------------------------------===//
53 // Custom Actions
54 //===----------------------------------------------------------------------===//
55 
56 std::unique_ptr<ASTConsumer>
57 InitOnlyAction::CreateASTConsumer(CompilerInstance &CI, StringRef InFile) {
58   return std::make_unique<ASTConsumer>();
59 }
60 
61 void InitOnlyAction::ExecuteAction() {
62 }
63 
64 //===----------------------------------------------------------------------===//
65 // AST Consumer Actions
66 //===----------------------------------------------------------------------===//
67 
68 std::unique_ptr<ASTConsumer>
69 ASTPrintAction::CreateASTConsumer(CompilerInstance &CI, StringRef InFile) {
70   if (std::unique_ptr<raw_ostream> OS =
71           CI.createDefaultOutputFile(false, InFile))
72     return CreateASTPrinter(std::move(OS), CI.getFrontendOpts().ASTDumpFilter);
73   return nullptr;
74 }
75 
76 std::unique_ptr<ASTConsumer>
77 ASTDumpAction::CreateASTConsumer(CompilerInstance &CI, StringRef InFile) {
78   const FrontendOptions &Opts = CI.getFrontendOpts();
79   return CreateASTDumper(nullptr /*Dump to stdout.*/, Opts.ASTDumpFilter,
80                          Opts.ASTDumpDecls, Opts.ASTDumpAll,
81                          Opts.ASTDumpLookups, Opts.ASTDumpFormat);
82 }
83 
84 std::unique_ptr<ASTConsumer>
85 ASTDeclListAction::CreateASTConsumer(CompilerInstance &CI, StringRef InFile) {
86   return CreateASTDeclNodeLister();
87 }
88 
89 std::unique_ptr<ASTConsumer>
90 ASTViewAction::CreateASTConsumer(CompilerInstance &CI, StringRef InFile) {
91   return CreateASTViewer();
92 }
93 
94 std::unique_ptr<ASTConsumer>
95 GeneratePCHAction::CreateASTConsumer(CompilerInstance &CI, StringRef InFile) {
96   std::string Sysroot;
97   if (!ComputeASTConsumerArguments(CI, /*ref*/ Sysroot))
98     return nullptr;
99 
100   std::string OutputFile;
101   std::unique_ptr<raw_pwrite_stream> OS =
102       CreateOutputFile(CI, InFile, /*ref*/ OutputFile);
103   if (!OS)
104     return nullptr;
105 
106   if (!CI.getFrontendOpts().RelocatablePCH)
107     Sysroot.clear();
108 
109   const auto &FrontendOpts = CI.getFrontendOpts();
110   auto Buffer = std::make_shared<PCHBuffer>();
111   std::vector<std::unique_ptr<ASTConsumer>> Consumers;
112   Consumers.push_back(std::make_unique<PCHGenerator>(
113       CI.getPreprocessor(), CI.getModuleCache(), OutputFile, Sysroot, Buffer,
114       FrontendOpts.ModuleFileExtensions,
115       CI.getPreprocessorOpts().AllowPCHWithCompilerErrors,
116       FrontendOpts.IncludeTimestamps, +CI.getLangOpts().CacheGeneratedPCH));
117   Consumers.push_back(CI.getPCHContainerWriter().CreatePCHContainerGenerator(
118       CI, InFile, OutputFile, std::move(OS), Buffer));
119 
120   return std::make_unique<MultiplexConsumer>(std::move(Consumers));
121 }
122 
123 bool GeneratePCHAction::ComputeASTConsumerArguments(CompilerInstance &CI,
124                                                     std::string &Sysroot) {
125   Sysroot = CI.getHeaderSearchOpts().Sysroot;
126   if (CI.getFrontendOpts().RelocatablePCH && Sysroot.empty()) {
127     CI.getDiagnostics().Report(diag::err_relocatable_without_isysroot);
128     return false;
129   }
130 
131   return true;
132 }
133 
134 std::unique_ptr<llvm::raw_pwrite_stream>
135 GeneratePCHAction::CreateOutputFile(CompilerInstance &CI, StringRef InFile,
136                                     std::string &OutputFile) {
137   // We use createOutputFile here because this is exposed via libclang, and we
138   // must disable the RemoveFileOnSignal behavior.
139   // We use a temporary to avoid race conditions.
140   std::unique_ptr<raw_pwrite_stream> OS =
141       CI.createOutputFile(CI.getFrontendOpts().OutputFile, /*Binary=*/true,
142                           /*RemoveFileOnSignal=*/false, InFile,
143                           /*Extension=*/"", /*UseTemporary=*/true);
144   if (!OS)
145     return nullptr;
146 
147   OutputFile = CI.getFrontendOpts().OutputFile;
148   return OS;
149 }
150 
151 bool GeneratePCHAction::shouldEraseOutputFiles() {
152   if (getCompilerInstance().getPreprocessorOpts().AllowPCHWithCompilerErrors)
153     return false;
154   return ASTFrontendAction::shouldEraseOutputFiles();
155 }
156 
157 bool GeneratePCHAction::BeginSourceFileAction(CompilerInstance &CI) {
158   CI.getLangOpts().CompilingPCH = true;
159   return true;
160 }
161 
162 std::unique_ptr<ASTConsumer>
163 GenerateModuleAction::CreateASTConsumer(CompilerInstance &CI,
164                                         StringRef InFile) {
165   std::unique_ptr<raw_pwrite_stream> OS = CreateOutputFile(CI, InFile);
166   if (!OS)
167     return nullptr;
168 
169   std::string OutputFile = CI.getFrontendOpts().OutputFile;
170   std::string Sysroot;
171 
172   auto Buffer = std::make_shared<PCHBuffer>();
173   std::vector<std::unique_ptr<ASTConsumer>> Consumers;
174 
175   Consumers.push_back(std::make_unique<PCHGenerator>(
176       CI.getPreprocessor(), CI.getModuleCache(), OutputFile, Sysroot, Buffer,
177       CI.getFrontendOpts().ModuleFileExtensions,
178       /*AllowASTWithErrors=*/false,
179       /*IncludeTimestamps=*/
180       +CI.getFrontendOpts().BuildingImplicitModule,
181       /*ShouldCacheASTInMemory=*/
182       +CI.getFrontendOpts().BuildingImplicitModule));
183   Consumers.push_back(CI.getPCHContainerWriter().CreatePCHContainerGenerator(
184       CI, InFile, OutputFile, std::move(OS), Buffer));
185   return std::make_unique<MultiplexConsumer>(std::move(Consumers));
186 }
187 
188 bool GenerateModuleFromModuleMapAction::BeginSourceFileAction(
189     CompilerInstance &CI) {
190   if (!CI.getLangOpts().Modules) {
191     CI.getDiagnostics().Report(diag::err_module_build_requires_fmodules);
192     return false;
193   }
194 
195   return GenerateModuleAction::BeginSourceFileAction(CI);
196 }
197 
198 std::unique_ptr<raw_pwrite_stream>
199 GenerateModuleFromModuleMapAction::CreateOutputFile(CompilerInstance &CI,
200                                                     StringRef InFile) {
201   // If no output file was provided, figure out where this module would go
202   // in the module cache.
203   if (CI.getFrontendOpts().OutputFile.empty()) {
204     StringRef ModuleMapFile = CI.getFrontendOpts().OriginalModuleMap;
205     if (ModuleMapFile.empty())
206       ModuleMapFile = InFile;
207 
208     HeaderSearch &HS = CI.getPreprocessor().getHeaderSearchInfo();
209     CI.getFrontendOpts().OutputFile =
210         HS.getCachedModuleFileName(CI.getLangOpts().CurrentModule,
211                                    ModuleMapFile);
212   }
213 
214   // We use createOutputFile here because this is exposed via libclang, and we
215   // must disable the RemoveFileOnSignal behavior.
216   // We use a temporary to avoid race conditions.
217   return CI.createOutputFile(CI.getFrontendOpts().OutputFile, /*Binary=*/true,
218                              /*RemoveFileOnSignal=*/false, InFile,
219                              /*Extension=*/"", /*UseTemporary=*/true,
220                              /*CreateMissingDirectories=*/true);
221 }
222 
223 bool GenerateModuleInterfaceAction::BeginSourceFileAction(
224     CompilerInstance &CI) {
225   if (!CI.getLangOpts().ModulesTS && !CI.getLangOpts().CPlusPlusModules) {
226     CI.getDiagnostics().Report(diag::err_module_interface_requires_cpp_modules);
227     return false;
228   }
229 
230   CI.getLangOpts().setCompilingModule(LangOptions::CMK_ModuleInterface);
231 
232   return GenerateModuleAction::BeginSourceFileAction(CI);
233 }
234 
235 std::unique_ptr<raw_pwrite_stream>
236 GenerateModuleInterfaceAction::CreateOutputFile(CompilerInstance &CI,
237                                                 StringRef InFile) {
238   return CI.createDefaultOutputFile(/*Binary=*/true, InFile, "pcm");
239 }
240 
241 bool GenerateHeaderModuleAction::PrepareToExecuteAction(
242     CompilerInstance &CI) {
243   if (!CI.getLangOpts().Modules) {
244     CI.getDiagnostics().Report(diag::err_header_module_requires_modules);
245     return false;
246   }
247 
248   auto &Inputs = CI.getFrontendOpts().Inputs;
249   if (Inputs.empty())
250     return GenerateModuleAction::BeginInvocation(CI);
251 
252   auto Kind = Inputs[0].getKind();
253 
254   // Convert the header file inputs into a single module input buffer.
255   SmallString<256> HeaderContents;
256   ModuleHeaders.reserve(Inputs.size());
257   for (const FrontendInputFile &FIF : Inputs) {
258     // FIXME: We should support re-compiling from an AST file.
259     if (FIF.getKind().getFormat() != InputKind::Source || !FIF.isFile()) {
260       CI.getDiagnostics().Report(diag::err_module_header_file_not_found)
261           << (FIF.isFile() ? FIF.getFile()
262                            : FIF.getBuffer()->getBufferIdentifier());
263       return true;
264     }
265 
266     HeaderContents += "#include \"";
267     HeaderContents += FIF.getFile();
268     HeaderContents += "\"\n";
269     ModuleHeaders.push_back(FIF.getFile());
270   }
271   Buffer = llvm::MemoryBuffer::getMemBufferCopy(
272       HeaderContents, Module::getModuleInputBufferName());
273 
274   // Set that buffer up as our "real" input.
275   Inputs.clear();
276   Inputs.push_back(FrontendInputFile(Buffer.get(), Kind, /*IsSystem*/false));
277 
278   return GenerateModuleAction::PrepareToExecuteAction(CI);
279 }
280 
281 bool GenerateHeaderModuleAction::BeginSourceFileAction(
282     CompilerInstance &CI) {
283   CI.getLangOpts().setCompilingModule(LangOptions::CMK_HeaderModule);
284 
285   // Synthesize a Module object for the given headers.
286   auto &HS = CI.getPreprocessor().getHeaderSearchInfo();
287   SmallVector<Module::Header, 16> Headers;
288   for (StringRef Name : ModuleHeaders) {
289     const DirectoryLookup *CurDir = nullptr;
290     Optional<FileEntryRef> FE = HS.LookupFile(
291         Name, SourceLocation(), /*Angled*/ false, nullptr, CurDir, None,
292         nullptr, nullptr, nullptr, nullptr, nullptr, nullptr);
293     if (!FE) {
294       CI.getDiagnostics().Report(diag::err_module_header_file_not_found)
295         << Name;
296       continue;
297     }
298     Headers.push_back({Name, &FE->getFileEntry()});
299   }
300   HS.getModuleMap().createHeaderModule(CI.getLangOpts().CurrentModule, Headers);
301 
302   return GenerateModuleAction::BeginSourceFileAction(CI);
303 }
304 
305 std::unique_ptr<raw_pwrite_stream>
306 GenerateHeaderModuleAction::CreateOutputFile(CompilerInstance &CI,
307                                              StringRef InFile) {
308   return CI.createDefaultOutputFile(/*Binary=*/true, InFile, "pcm");
309 }
310 
311 SyntaxOnlyAction::~SyntaxOnlyAction() {
312 }
313 
314 std::unique_ptr<ASTConsumer>
315 SyntaxOnlyAction::CreateASTConsumer(CompilerInstance &CI, StringRef InFile) {
316   return std::make_unique<ASTConsumer>();
317 }
318 
319 std::unique_ptr<ASTConsumer>
320 DumpModuleInfoAction::CreateASTConsumer(CompilerInstance &CI,
321                                         StringRef InFile) {
322   return std::make_unique<ASTConsumer>();
323 }
324 
325 std::unique_ptr<ASTConsumer>
326 VerifyPCHAction::CreateASTConsumer(CompilerInstance &CI, StringRef InFile) {
327   return std::make_unique<ASTConsumer>();
328 }
329 
330 void VerifyPCHAction::ExecuteAction() {
331   CompilerInstance &CI = getCompilerInstance();
332   bool Preamble = CI.getPreprocessorOpts().PrecompiledPreambleBytes.first != 0;
333   const std::string &Sysroot = CI.getHeaderSearchOpts().Sysroot;
334   std::unique_ptr<ASTReader> Reader(new ASTReader(
335       CI.getPreprocessor(), CI.getModuleCache(), &CI.getASTContext(),
336       CI.getPCHContainerReader(), CI.getFrontendOpts().ModuleFileExtensions,
337       Sysroot.empty() ? "" : Sysroot.c_str(),
338       /*DisableValidation*/ false,
339       /*AllowPCHWithCompilerErrors*/ false,
340       /*AllowConfigurationMismatch*/ true,
341       /*ValidateSystemInputs*/ true));
342 
343   Reader->ReadAST(getCurrentFile(),
344                   Preamble ? serialization::MK_Preamble
345                            : serialization::MK_PCH,
346                   SourceLocation(),
347                   ASTReader::ARR_ConfigurationMismatch);
348 }
349 
350 namespace {
351 struct TemplightEntry {
352   std::string Name;
353   std::string Kind;
354   std::string Event;
355   std::string DefinitionLocation;
356   std::string PointOfInstantiation;
357 };
358 } // namespace
359 
360 namespace llvm {
361 namespace yaml {
362 template <> struct MappingTraits<TemplightEntry> {
363   static void mapping(IO &io, TemplightEntry &fields) {
364     io.mapRequired("name", fields.Name);
365     io.mapRequired("kind", fields.Kind);
366     io.mapRequired("event", fields.Event);
367     io.mapRequired("orig", fields.DefinitionLocation);
368     io.mapRequired("poi", fields.PointOfInstantiation);
369   }
370 };
371 } // namespace yaml
372 } // namespace llvm
373 
374 namespace {
375 class DefaultTemplateInstCallback : public TemplateInstantiationCallback {
376   using CodeSynthesisContext = Sema::CodeSynthesisContext;
377 
378 public:
379   void initialize(const Sema &) override {}
380 
381   void finalize(const Sema &) override {}
382 
383   void atTemplateBegin(const Sema &TheSema,
384                        const CodeSynthesisContext &Inst) override {
385     displayTemplightEntry<true>(llvm::outs(), TheSema, Inst);
386   }
387 
388   void atTemplateEnd(const Sema &TheSema,
389                      const CodeSynthesisContext &Inst) override {
390     displayTemplightEntry<false>(llvm::outs(), TheSema, Inst);
391   }
392 
393 private:
394   static std::string toString(CodeSynthesisContext::SynthesisKind Kind) {
395     switch (Kind) {
396     case CodeSynthesisContext::TemplateInstantiation:
397       return "TemplateInstantiation";
398     case CodeSynthesisContext::DefaultTemplateArgumentInstantiation:
399       return "DefaultTemplateArgumentInstantiation";
400     case CodeSynthesisContext::DefaultFunctionArgumentInstantiation:
401       return "DefaultFunctionArgumentInstantiation";
402     case CodeSynthesisContext::ExplicitTemplateArgumentSubstitution:
403       return "ExplicitTemplateArgumentSubstitution";
404     case CodeSynthesisContext::DeducedTemplateArgumentSubstitution:
405       return "DeducedTemplateArgumentSubstitution";
406     case CodeSynthesisContext::PriorTemplateArgumentSubstitution:
407       return "PriorTemplateArgumentSubstitution";
408     case CodeSynthesisContext::DefaultTemplateArgumentChecking:
409       return "DefaultTemplateArgumentChecking";
410     case CodeSynthesisContext::ExceptionSpecEvaluation:
411       return "ExceptionSpecEvaluation";
412     case CodeSynthesisContext::ExceptionSpecInstantiation:
413       return "ExceptionSpecInstantiation";
414     case CodeSynthesisContext::DeclaringSpecialMember:
415       return "DeclaringSpecialMember";
416     case CodeSynthesisContext::DefiningSynthesizedFunction:
417       return "DefiningSynthesizedFunction";
418     case CodeSynthesisContext::RewritingOperatorAsSpaceship:
419       return "RewritingOperatorAsSpaceship";
420     case CodeSynthesisContext::Memoization:
421       return "Memoization";
422     case CodeSynthesisContext::ConstraintsCheck:
423       return "ConstraintsCheck";
424     case CodeSynthesisContext::ConstraintSubstitution:
425       return "ConstraintSubstitution";
426     }
427     return "";
428   }
429 
430   template <bool BeginInstantiation>
431   static void displayTemplightEntry(llvm::raw_ostream &Out, const Sema &TheSema,
432                                     const CodeSynthesisContext &Inst) {
433     std::string YAML;
434     {
435       llvm::raw_string_ostream OS(YAML);
436       llvm::yaml::Output YO(OS);
437       TemplightEntry Entry =
438           getTemplightEntry<BeginInstantiation>(TheSema, Inst);
439       llvm::yaml::EmptyContext Context;
440       llvm::yaml::yamlize(YO, Entry, true, Context);
441     }
442     Out << "---" << YAML << "\n";
443   }
444 
445   template <bool BeginInstantiation>
446   static TemplightEntry getTemplightEntry(const Sema &TheSema,
447                                           const CodeSynthesisContext &Inst) {
448     TemplightEntry Entry;
449     Entry.Kind = toString(Inst.Kind);
450     Entry.Event = BeginInstantiation ? "Begin" : "End";
451     if (auto *NamedTemplate = dyn_cast_or_null<NamedDecl>(Inst.Entity)) {
452       llvm::raw_string_ostream OS(Entry.Name);
453       NamedTemplate->getNameForDiagnostic(OS, TheSema.getLangOpts(), true);
454       const PresumedLoc DefLoc =
455         TheSema.getSourceManager().getPresumedLoc(Inst.Entity->getLocation());
456       if(!DefLoc.isInvalid())
457         Entry.DefinitionLocation = std::string(DefLoc.getFilename()) + ":" +
458                                    std::to_string(DefLoc.getLine()) + ":" +
459                                    std::to_string(DefLoc.getColumn());
460     }
461     const PresumedLoc PoiLoc =
462         TheSema.getSourceManager().getPresumedLoc(Inst.PointOfInstantiation);
463     if (!PoiLoc.isInvalid()) {
464       Entry.PointOfInstantiation = std::string(PoiLoc.getFilename()) + ":" +
465                                    std::to_string(PoiLoc.getLine()) + ":" +
466                                    std::to_string(PoiLoc.getColumn());
467     }
468     return Entry;
469   }
470 };
471 } // namespace
472 
473 std::unique_ptr<ASTConsumer>
474 TemplightDumpAction::CreateASTConsumer(CompilerInstance &CI, StringRef InFile) {
475   return std::make_unique<ASTConsumer>();
476 }
477 
478 void TemplightDumpAction::ExecuteAction() {
479   CompilerInstance &CI = getCompilerInstance();
480 
481   // This part is normally done by ASTFrontEndAction, but needs to happen
482   // before Templight observers can be created
483   // FIXME: Move the truncation aspect of this into Sema, we delayed this till
484   // here so the source manager would be initialized.
485   EnsureSemaIsCreated(CI, *this);
486 
487   CI.getSema().TemplateInstCallbacks.push_back(
488       std::make_unique<DefaultTemplateInstCallback>());
489   ASTFrontendAction::ExecuteAction();
490 }
491 
492 namespace {
493   /// AST reader listener that dumps module information for a module
494   /// file.
495   class DumpModuleInfoListener : public ASTReaderListener {
496     llvm::raw_ostream &Out;
497 
498   public:
499     DumpModuleInfoListener(llvm::raw_ostream &Out) : Out(Out) { }
500 
501 #define DUMP_BOOLEAN(Value, Text)                       \
502     Out.indent(4) << Text << ": " << (Value? "Yes" : "No") << "\n"
503 
504     bool ReadFullVersionInformation(StringRef FullVersion) override {
505       Out.indent(2)
506         << "Generated by "
507         << (FullVersion == getClangFullRepositoryVersion()? "this"
508                                                           : "a different")
509         << " Clang: " << FullVersion << "\n";
510       return ASTReaderListener::ReadFullVersionInformation(FullVersion);
511     }
512 
513     void ReadModuleName(StringRef ModuleName) override {
514       Out.indent(2) << "Module name: " << ModuleName << "\n";
515     }
516     void ReadModuleMapFile(StringRef ModuleMapPath) override {
517       Out.indent(2) << "Module map file: " << ModuleMapPath << "\n";
518     }
519 
520     bool ReadLanguageOptions(const LangOptions &LangOpts, bool Complain,
521                              bool AllowCompatibleDifferences) override {
522       Out.indent(2) << "Language options:\n";
523 #define LANGOPT(Name, Bits, Default, Description) \
524       DUMP_BOOLEAN(LangOpts.Name, Description);
525 #define ENUM_LANGOPT(Name, Type, Bits, Default, Description) \
526       Out.indent(4) << Description << ": "                   \
527                     << static_cast<unsigned>(LangOpts.get##Name()) << "\n";
528 #define VALUE_LANGOPT(Name, Bits, Default, Description) \
529       Out.indent(4) << Description << ": " << LangOpts.Name << "\n";
530 #define BENIGN_LANGOPT(Name, Bits, Default, Description)
531 #define BENIGN_ENUM_LANGOPT(Name, Type, Bits, Default, Description)
532 #include "clang/Basic/LangOptions.def"
533 
534       if (!LangOpts.ModuleFeatures.empty()) {
535         Out.indent(4) << "Module features:\n";
536         for (StringRef Feature : LangOpts.ModuleFeatures)
537           Out.indent(6) << Feature << "\n";
538       }
539 
540       return false;
541     }
542 
543     bool ReadTargetOptions(const TargetOptions &TargetOpts, bool Complain,
544                            bool AllowCompatibleDifferences) override {
545       Out.indent(2) << "Target options:\n";
546       Out.indent(4) << "  Triple: " << TargetOpts.Triple << "\n";
547       Out.indent(4) << "  CPU: " << TargetOpts.CPU << "\n";
548       Out.indent(4) << "  ABI: " << TargetOpts.ABI << "\n";
549 
550       if (!TargetOpts.FeaturesAsWritten.empty()) {
551         Out.indent(4) << "Target features:\n";
552         for (unsigned I = 0, N = TargetOpts.FeaturesAsWritten.size();
553              I != N; ++I) {
554           Out.indent(6) << TargetOpts.FeaturesAsWritten[I] << "\n";
555         }
556       }
557 
558       return false;
559     }
560 
561     bool ReadDiagnosticOptions(IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts,
562                                bool Complain) override {
563       Out.indent(2) << "Diagnostic options:\n";
564 #define DIAGOPT(Name, Bits, Default) DUMP_BOOLEAN(DiagOpts->Name, #Name);
565 #define ENUM_DIAGOPT(Name, Type, Bits, Default) \
566       Out.indent(4) << #Name << ": " << DiagOpts->get##Name() << "\n";
567 #define VALUE_DIAGOPT(Name, Bits, Default) \
568       Out.indent(4) << #Name << ": " << DiagOpts->Name << "\n";
569 #include "clang/Basic/DiagnosticOptions.def"
570 
571       Out.indent(4) << "Diagnostic flags:\n";
572       for (const std::string &Warning : DiagOpts->Warnings)
573         Out.indent(6) << "-W" << Warning << "\n";
574       for (const std::string &Remark : DiagOpts->Remarks)
575         Out.indent(6) << "-R" << Remark << "\n";
576 
577       return false;
578     }
579 
580     bool ReadHeaderSearchOptions(const HeaderSearchOptions &HSOpts,
581                                  StringRef SpecificModuleCachePath,
582                                  bool Complain) override {
583       Out.indent(2) << "Header search options:\n";
584       Out.indent(4) << "System root [-isysroot=]: '" << HSOpts.Sysroot << "'\n";
585       Out.indent(4) << "Resource dir [ -resource-dir=]: '" << HSOpts.ResourceDir << "'\n";
586       Out.indent(4) << "Module Cache: '" << SpecificModuleCachePath << "'\n";
587       DUMP_BOOLEAN(HSOpts.UseBuiltinIncludes,
588                    "Use builtin include directories [-nobuiltininc]");
589       DUMP_BOOLEAN(HSOpts.UseStandardSystemIncludes,
590                    "Use standard system include directories [-nostdinc]");
591       DUMP_BOOLEAN(HSOpts.UseStandardCXXIncludes,
592                    "Use standard C++ include directories [-nostdinc++]");
593       DUMP_BOOLEAN(HSOpts.UseLibcxx,
594                    "Use libc++ (rather than libstdc++) [-stdlib=]");
595       return false;
596     }
597 
598     bool ReadPreprocessorOptions(const PreprocessorOptions &PPOpts,
599                                  bool Complain,
600                                  std::string &SuggestedPredefines) override {
601       Out.indent(2) << "Preprocessor options:\n";
602       DUMP_BOOLEAN(PPOpts.UsePredefines,
603                    "Uses compiler/target-specific predefines [-undef]");
604       DUMP_BOOLEAN(PPOpts.DetailedRecord,
605                    "Uses detailed preprocessing record (for indexing)");
606 
607       if (!PPOpts.Macros.empty()) {
608         Out.indent(4) << "Predefined macros:\n";
609       }
610 
611       for (std::vector<std::pair<std::string, bool/*isUndef*/> >::const_iterator
612              I = PPOpts.Macros.begin(), IEnd = PPOpts.Macros.end();
613            I != IEnd; ++I) {
614         Out.indent(6);
615         if (I->second)
616           Out << "-U";
617         else
618           Out << "-D";
619         Out << I->first << "\n";
620       }
621       return false;
622     }
623 
624     /// Indicates that a particular module file extension has been read.
625     void readModuleFileExtension(
626            const ModuleFileExtensionMetadata &Metadata) override {
627       Out.indent(2) << "Module file extension '"
628                     << Metadata.BlockName << "' " << Metadata.MajorVersion
629                     << "." << Metadata.MinorVersion;
630       if (!Metadata.UserInfo.empty()) {
631         Out << ": ";
632         Out.write_escaped(Metadata.UserInfo);
633       }
634 
635       Out << "\n";
636     }
637 
638     /// Tells the \c ASTReaderListener that we want to receive the
639     /// input files of the AST file via \c visitInputFile.
640     bool needsInputFileVisitation() override { return true; }
641 
642     /// Tells the \c ASTReaderListener that we want to receive the
643     /// input files of the AST file via \c visitInputFile.
644     bool needsSystemInputFileVisitation() override { return true; }
645 
646     /// Indicates that the AST file contains particular input file.
647     ///
648     /// \returns true to continue receiving the next input file, false to stop.
649     bool visitInputFile(StringRef Filename, bool isSystem,
650                         bool isOverridden, bool isExplicitModule) override {
651 
652       Out.indent(2) << "Input file: " << Filename;
653 
654       if (isSystem || isOverridden || isExplicitModule) {
655         Out << " [";
656         if (isSystem) {
657           Out << "System";
658           if (isOverridden || isExplicitModule)
659             Out << ", ";
660         }
661         if (isOverridden) {
662           Out << "Overridden";
663           if (isExplicitModule)
664             Out << ", ";
665         }
666         if (isExplicitModule)
667           Out << "ExplicitModule";
668 
669         Out << "]";
670       }
671 
672       Out << "\n";
673 
674       return true;
675     }
676 
677     /// Returns true if this \c ASTReaderListener wants to receive the
678     /// imports of the AST file via \c visitImport, false otherwise.
679     bool needsImportVisitation() const override { return true; }
680 
681     /// If needsImportVisitation returns \c true, this is called for each
682     /// AST file imported by this AST file.
683     void visitImport(StringRef ModuleName, StringRef Filename) override {
684       Out.indent(2) << "Imports module '" << ModuleName
685                     << "': " << Filename.str() << "\n";
686     }
687 #undef DUMP_BOOLEAN
688   };
689 }
690 
691 bool DumpModuleInfoAction::BeginInvocation(CompilerInstance &CI) {
692   // The Object file reader also supports raw ast files and there is no point in
693   // being strict about the module file format in -module-file-info mode.
694   CI.getHeaderSearchOpts().ModuleFormat = "obj";
695   return true;
696 }
697 
698 void DumpModuleInfoAction::ExecuteAction() {
699   // Set up the output file.
700   std::unique_ptr<llvm::raw_fd_ostream> OutFile;
701   StringRef OutputFileName = getCompilerInstance().getFrontendOpts().OutputFile;
702   if (!OutputFileName.empty() && OutputFileName != "-") {
703     std::error_code EC;
704     OutFile.reset(new llvm::raw_fd_ostream(OutputFileName.str(), EC,
705                                            llvm::sys::fs::OF_Text));
706   }
707   llvm::raw_ostream &Out = OutFile.get()? *OutFile.get() : llvm::outs();
708 
709   Out << "Information for module file '" << getCurrentFile() << "':\n";
710   auto &FileMgr = getCompilerInstance().getFileManager();
711   auto Buffer = FileMgr.getBufferForFile(getCurrentFile());
712   StringRef Magic = (*Buffer)->getMemBufferRef().getBuffer();
713   bool IsRaw = (Magic.size() >= 4 && Magic[0] == 'C' && Magic[1] == 'P' &&
714                 Magic[2] == 'C' && Magic[3] == 'H');
715   Out << "  Module format: " << (IsRaw ? "raw" : "obj") << "\n";
716 
717   Preprocessor &PP = getCompilerInstance().getPreprocessor();
718   DumpModuleInfoListener Listener(Out);
719   HeaderSearchOptions &HSOpts =
720       PP.getHeaderSearchInfo().getHeaderSearchOpts();
721   ASTReader::readASTFileControlBlock(
722       getCurrentFile(), FileMgr, getCompilerInstance().getPCHContainerReader(),
723       /*FindModuleFileExtensions=*/true, Listener,
724       HSOpts.ModulesValidateDiagnosticOptions);
725 }
726 
727 //===----------------------------------------------------------------------===//
728 // Preprocessor Actions
729 //===----------------------------------------------------------------------===//
730 
731 void DumpRawTokensAction::ExecuteAction() {
732   Preprocessor &PP = getCompilerInstance().getPreprocessor();
733   SourceManager &SM = PP.getSourceManager();
734 
735   // Start lexing the specified input file.
736   const llvm::MemoryBuffer *FromFile = SM.getBuffer(SM.getMainFileID());
737   Lexer RawLex(SM.getMainFileID(), FromFile, SM, PP.getLangOpts());
738   RawLex.SetKeepWhitespaceMode(true);
739 
740   Token RawTok;
741   RawLex.LexFromRawLexer(RawTok);
742   while (RawTok.isNot(tok::eof)) {
743     PP.DumpToken(RawTok, true);
744     llvm::errs() << "\n";
745     RawLex.LexFromRawLexer(RawTok);
746   }
747 }
748 
749 void DumpTokensAction::ExecuteAction() {
750   Preprocessor &PP = getCompilerInstance().getPreprocessor();
751   // Start preprocessing the specified input file.
752   Token Tok;
753   PP.EnterMainSourceFile();
754   do {
755     PP.Lex(Tok);
756     PP.DumpToken(Tok, true);
757     llvm::errs() << "\n";
758   } while (Tok.isNot(tok::eof));
759 }
760 
761 void PreprocessOnlyAction::ExecuteAction() {
762   Preprocessor &PP = getCompilerInstance().getPreprocessor();
763 
764   // Ignore unknown pragmas.
765   PP.IgnorePragmas();
766 
767   Token Tok;
768   // Start parsing the specified input file.
769   PP.EnterMainSourceFile();
770   do {
771     PP.Lex(Tok);
772   } while (Tok.isNot(tok::eof));
773 }
774 
775 void PrintPreprocessedAction::ExecuteAction() {
776   CompilerInstance &CI = getCompilerInstance();
777   // Output file may need to be set to 'Binary', to avoid converting Unix style
778   // line feeds (<LF>) to Microsoft style line feeds (<CR><LF>).
779   //
780   // Look to see what type of line endings the file uses. If there's a
781   // CRLF, then we won't open the file up in binary mode. If there is
782   // just an LF or CR, then we will open the file up in binary mode.
783   // In this fashion, the output format should match the input format, unless
784   // the input format has inconsistent line endings.
785   //
786   // This should be a relatively fast operation since most files won't have
787   // all of their source code on a single line. However, that is still a
788   // concern, so if we scan for too long, we'll just assume the file should
789   // be opened in binary mode.
790   bool BinaryMode = true;
791   bool InvalidFile = false;
792   const SourceManager& SM = CI.getSourceManager();
793   const llvm::MemoryBuffer *Buffer = SM.getBuffer(SM.getMainFileID(),
794                                                      &InvalidFile);
795   if (!InvalidFile) {
796     const char *cur = Buffer->getBufferStart();
797     const char *end = Buffer->getBufferEnd();
798     const char *next = (cur != end) ? cur + 1 : end;
799 
800     // Limit ourselves to only scanning 256 characters into the source
801     // file.  This is mostly a sanity check in case the file has no
802     // newlines whatsoever.
803     if (end - cur > 256) end = cur + 256;
804 
805     while (next < end) {
806       if (*cur == 0x0D) {  // CR
807         if (*next == 0x0A)  // CRLF
808           BinaryMode = false;
809 
810         break;
811       } else if (*cur == 0x0A)  // LF
812         break;
813 
814       ++cur;
815       ++next;
816     }
817   }
818 
819   std::unique_ptr<raw_ostream> OS =
820       CI.createDefaultOutputFile(BinaryMode, getCurrentFileOrBufferName());
821   if (!OS) return;
822 
823   // If we're preprocessing a module map, start by dumping the contents of the
824   // module itself before switching to the input buffer.
825   auto &Input = getCurrentInput();
826   if (Input.getKind().getFormat() == InputKind::ModuleMap) {
827     if (Input.isFile()) {
828       (*OS) << "# 1 \"";
829       OS->write_escaped(Input.getFile());
830       (*OS) << "\"\n";
831     }
832     getCurrentModule()->print(*OS);
833     (*OS) << "#pragma clang module contents\n";
834   }
835 
836   DoPrintPreprocessedInput(CI.getPreprocessor(), OS.get(),
837                            CI.getPreprocessorOutputOpts());
838 }
839 
840 void PrintPreambleAction::ExecuteAction() {
841   switch (getCurrentFileKind().getLanguage()) {
842   case Language::C:
843   case Language::CXX:
844   case Language::ObjC:
845   case Language::ObjCXX:
846   case Language::OpenCL:
847   case Language::CUDA:
848   case Language::HIP:
849     break;
850 
851   case Language::Unknown:
852   case Language::Asm:
853   case Language::LLVM_IR:
854   case Language::RenderScript:
855     // We can't do anything with these.
856     return;
857   }
858 
859   // We don't expect to find any #include directives in a preprocessed input.
860   if (getCurrentFileKind().isPreprocessed())
861     return;
862 
863   CompilerInstance &CI = getCompilerInstance();
864   auto Buffer = CI.getFileManager().getBufferForFile(getCurrentFile());
865   if (Buffer) {
866     unsigned Preamble =
867         Lexer::ComputePreamble((*Buffer)->getBuffer(), CI.getLangOpts()).Size;
868     llvm::outs().write((*Buffer)->getBufferStart(), Preamble);
869   }
870 }
871 
872 void DumpCompilerOptionsAction::ExecuteAction() {
873   CompilerInstance &CI = getCompilerInstance();
874   std::unique_ptr<raw_ostream> OSP =
875       CI.createDefaultOutputFile(false, getCurrentFile());
876   if (!OSP)
877     return;
878 
879   raw_ostream &OS = *OSP;
880   const Preprocessor &PP = CI.getPreprocessor();
881   const LangOptions &LangOpts = PP.getLangOpts();
882 
883   // FIXME: Rather than manually format the JSON (which is awkward due to
884   // needing to remove trailing commas), this should make use of a JSON library.
885   // FIXME: Instead of printing enums as an integral value and specifying the
886   // type as a separate field, use introspection to print the enumerator.
887 
888   OS << "{\n";
889   OS << "\n\"features\" : [\n";
890   {
891     llvm::SmallString<128> Str;
892 #define FEATURE(Name, Predicate)                                               \
893   ("\t{\"" #Name "\" : " + llvm::Twine(Predicate ? "true" : "false") + "},\n") \
894       .toVector(Str);
895 #include "clang/Basic/Features.def"
896 #undef FEATURE
897     // Remove the newline and comma from the last entry to ensure this remains
898     // valid JSON.
899     OS << Str.substr(0, Str.size() - 2);
900   }
901   OS << "\n],\n";
902 
903   OS << "\n\"extensions\" : [\n";
904   {
905     llvm::SmallString<128> Str;
906 #define EXTENSION(Name, Predicate)                                             \
907   ("\t{\"" #Name "\" : " + llvm::Twine(Predicate ? "true" : "false") + "},\n") \
908       .toVector(Str);
909 #include "clang/Basic/Features.def"
910 #undef EXTENSION
911     // Remove the newline and comma from the last entry to ensure this remains
912     // valid JSON.
913     OS << Str.substr(0, Str.size() - 2);
914   }
915   OS << "\n]\n";
916 
917   OS << "}";
918 }
919 
920 void PrintDependencyDirectivesSourceMinimizerAction::ExecuteAction() {
921   CompilerInstance &CI = getCompilerInstance();
922   SourceManager &SM = CI.getPreprocessor().getSourceManager();
923   const llvm::MemoryBuffer *FromFile = SM.getBuffer(SM.getMainFileID());
924 
925   llvm::SmallString<1024> Output;
926   llvm::SmallVector<minimize_source_to_dependency_directives::Token, 32> Toks;
927   if (minimizeSourceToDependencyDirectives(
928           FromFile->getBuffer(), Output, Toks, &CI.getDiagnostics(),
929           SM.getLocForStartOfFile(SM.getMainFileID()))) {
930     assert(CI.getDiagnostics().hasErrorOccurred() &&
931            "no errors reported for failure");
932 
933     // Preprocess the source when verifying the diagnostics to capture the
934     // 'expected' comments.
935     if (CI.getDiagnosticOpts().VerifyDiagnostics) {
936       // Make sure we don't emit new diagnostics!
937       CI.getDiagnostics().setSuppressAllDiagnostics(true);
938       Preprocessor &PP = getCompilerInstance().getPreprocessor();
939       PP.EnterMainSourceFile();
940       Token Tok;
941       do {
942         PP.Lex(Tok);
943       } while (Tok.isNot(tok::eof));
944     }
945     return;
946   }
947   llvm::outs() << Output;
948 }
949