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::Memoization:
419       return "Memoization";
420     case CodeSynthesisContext::ConstraintsCheck:
421       return "ConstraintsCheck";
422     case CodeSynthesisContext::ConstraintSubstitution:
423       return "ConstraintSubstitution";
424     }
425     return "";
426   }
427 
428   template <bool BeginInstantiation>
429   static void displayTemplightEntry(llvm::raw_ostream &Out, const Sema &TheSema,
430                                     const CodeSynthesisContext &Inst) {
431     std::string YAML;
432     {
433       llvm::raw_string_ostream OS(YAML);
434       llvm::yaml::Output YO(OS);
435       TemplightEntry Entry =
436           getTemplightEntry<BeginInstantiation>(TheSema, Inst);
437       llvm::yaml::EmptyContext Context;
438       llvm::yaml::yamlize(YO, Entry, true, Context);
439     }
440     Out << "---" << YAML << "\n";
441   }
442 
443   template <bool BeginInstantiation>
444   static TemplightEntry getTemplightEntry(const Sema &TheSema,
445                                           const CodeSynthesisContext &Inst) {
446     TemplightEntry Entry;
447     Entry.Kind = toString(Inst.Kind);
448     Entry.Event = BeginInstantiation ? "Begin" : "End";
449     if (auto *NamedTemplate = dyn_cast_or_null<NamedDecl>(Inst.Entity)) {
450       llvm::raw_string_ostream OS(Entry.Name);
451       NamedTemplate->getNameForDiagnostic(OS, TheSema.getLangOpts(), true);
452       const PresumedLoc DefLoc =
453         TheSema.getSourceManager().getPresumedLoc(Inst.Entity->getLocation());
454       if(!DefLoc.isInvalid())
455         Entry.DefinitionLocation = std::string(DefLoc.getFilename()) + ":" +
456                                    std::to_string(DefLoc.getLine()) + ":" +
457                                    std::to_string(DefLoc.getColumn());
458     }
459     const PresumedLoc PoiLoc =
460         TheSema.getSourceManager().getPresumedLoc(Inst.PointOfInstantiation);
461     if (!PoiLoc.isInvalid()) {
462       Entry.PointOfInstantiation = std::string(PoiLoc.getFilename()) + ":" +
463                                    std::to_string(PoiLoc.getLine()) + ":" +
464                                    std::to_string(PoiLoc.getColumn());
465     }
466     return Entry;
467   }
468 };
469 } // namespace
470 
471 std::unique_ptr<ASTConsumer>
472 TemplightDumpAction::CreateASTConsumer(CompilerInstance &CI, StringRef InFile) {
473   return std::make_unique<ASTConsumer>();
474 }
475 
476 void TemplightDumpAction::ExecuteAction() {
477   CompilerInstance &CI = getCompilerInstance();
478 
479   // This part is normally done by ASTFrontEndAction, but needs to happen
480   // before Templight observers can be created
481   // FIXME: Move the truncation aspect of this into Sema, we delayed this till
482   // here so the source manager would be initialized.
483   EnsureSemaIsCreated(CI, *this);
484 
485   CI.getSema().TemplateInstCallbacks.push_back(
486       std::make_unique<DefaultTemplateInstCallback>());
487   ASTFrontendAction::ExecuteAction();
488 }
489 
490 namespace {
491   /// AST reader listener that dumps module information for a module
492   /// file.
493   class DumpModuleInfoListener : public ASTReaderListener {
494     llvm::raw_ostream &Out;
495 
496   public:
497     DumpModuleInfoListener(llvm::raw_ostream &Out) : Out(Out) { }
498 
499 #define DUMP_BOOLEAN(Value, Text)                       \
500     Out.indent(4) << Text << ": " << (Value? "Yes" : "No") << "\n"
501 
502     bool ReadFullVersionInformation(StringRef FullVersion) override {
503       Out.indent(2)
504         << "Generated by "
505         << (FullVersion == getClangFullRepositoryVersion()? "this"
506                                                           : "a different")
507         << " Clang: " << FullVersion << "\n";
508       return ASTReaderListener::ReadFullVersionInformation(FullVersion);
509     }
510 
511     void ReadModuleName(StringRef ModuleName) override {
512       Out.indent(2) << "Module name: " << ModuleName << "\n";
513     }
514     void ReadModuleMapFile(StringRef ModuleMapPath) override {
515       Out.indent(2) << "Module map file: " << ModuleMapPath << "\n";
516     }
517 
518     bool ReadLanguageOptions(const LangOptions &LangOpts, bool Complain,
519                              bool AllowCompatibleDifferences) override {
520       Out.indent(2) << "Language options:\n";
521 #define LANGOPT(Name, Bits, Default, Description) \
522       DUMP_BOOLEAN(LangOpts.Name, Description);
523 #define ENUM_LANGOPT(Name, Type, Bits, Default, Description) \
524       Out.indent(4) << Description << ": "                   \
525                     << static_cast<unsigned>(LangOpts.get##Name()) << "\n";
526 #define VALUE_LANGOPT(Name, Bits, Default, Description) \
527       Out.indent(4) << Description << ": " << LangOpts.Name << "\n";
528 #define BENIGN_LANGOPT(Name, Bits, Default, Description)
529 #define BENIGN_ENUM_LANGOPT(Name, Type, Bits, Default, Description)
530 #include "clang/Basic/LangOptions.def"
531 
532       if (!LangOpts.ModuleFeatures.empty()) {
533         Out.indent(4) << "Module features:\n";
534         for (StringRef Feature : LangOpts.ModuleFeatures)
535           Out.indent(6) << Feature << "\n";
536       }
537 
538       return false;
539     }
540 
541     bool ReadTargetOptions(const TargetOptions &TargetOpts, bool Complain,
542                            bool AllowCompatibleDifferences) override {
543       Out.indent(2) << "Target options:\n";
544       Out.indent(4) << "  Triple: " << TargetOpts.Triple << "\n";
545       Out.indent(4) << "  CPU: " << TargetOpts.CPU << "\n";
546       Out.indent(4) << "  ABI: " << TargetOpts.ABI << "\n";
547 
548       if (!TargetOpts.FeaturesAsWritten.empty()) {
549         Out.indent(4) << "Target features:\n";
550         for (unsigned I = 0, N = TargetOpts.FeaturesAsWritten.size();
551              I != N; ++I) {
552           Out.indent(6) << TargetOpts.FeaturesAsWritten[I] << "\n";
553         }
554       }
555 
556       return false;
557     }
558 
559     bool ReadDiagnosticOptions(IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts,
560                                bool Complain) override {
561       Out.indent(2) << "Diagnostic options:\n";
562 #define DIAGOPT(Name, Bits, Default) DUMP_BOOLEAN(DiagOpts->Name, #Name);
563 #define ENUM_DIAGOPT(Name, Type, Bits, Default) \
564       Out.indent(4) << #Name << ": " << DiagOpts->get##Name() << "\n";
565 #define VALUE_DIAGOPT(Name, Bits, Default) \
566       Out.indent(4) << #Name << ": " << DiagOpts->Name << "\n";
567 #include "clang/Basic/DiagnosticOptions.def"
568 
569       Out.indent(4) << "Diagnostic flags:\n";
570       for (const std::string &Warning : DiagOpts->Warnings)
571         Out.indent(6) << "-W" << Warning << "\n";
572       for (const std::string &Remark : DiagOpts->Remarks)
573         Out.indent(6) << "-R" << Remark << "\n";
574 
575       return false;
576     }
577 
578     bool ReadHeaderSearchOptions(const HeaderSearchOptions &HSOpts,
579                                  StringRef SpecificModuleCachePath,
580                                  bool Complain) override {
581       Out.indent(2) << "Header search options:\n";
582       Out.indent(4) << "System root [-isysroot=]: '" << HSOpts.Sysroot << "'\n";
583       Out.indent(4) << "Resource dir [ -resource-dir=]: '" << HSOpts.ResourceDir << "'\n";
584       Out.indent(4) << "Module Cache: '" << SpecificModuleCachePath << "'\n";
585       DUMP_BOOLEAN(HSOpts.UseBuiltinIncludes,
586                    "Use builtin include directories [-nobuiltininc]");
587       DUMP_BOOLEAN(HSOpts.UseStandardSystemIncludes,
588                    "Use standard system include directories [-nostdinc]");
589       DUMP_BOOLEAN(HSOpts.UseStandardCXXIncludes,
590                    "Use standard C++ include directories [-nostdinc++]");
591       DUMP_BOOLEAN(HSOpts.UseLibcxx,
592                    "Use libc++ (rather than libstdc++) [-stdlib=]");
593       return false;
594     }
595 
596     bool ReadPreprocessorOptions(const PreprocessorOptions &PPOpts,
597                                  bool Complain,
598                                  std::string &SuggestedPredefines) override {
599       Out.indent(2) << "Preprocessor options:\n";
600       DUMP_BOOLEAN(PPOpts.UsePredefines,
601                    "Uses compiler/target-specific predefines [-undef]");
602       DUMP_BOOLEAN(PPOpts.DetailedRecord,
603                    "Uses detailed preprocessing record (for indexing)");
604 
605       if (!PPOpts.Macros.empty()) {
606         Out.indent(4) << "Predefined macros:\n";
607       }
608 
609       for (std::vector<std::pair<std::string, bool/*isUndef*/> >::const_iterator
610              I = PPOpts.Macros.begin(), IEnd = PPOpts.Macros.end();
611            I != IEnd; ++I) {
612         Out.indent(6);
613         if (I->second)
614           Out << "-U";
615         else
616           Out << "-D";
617         Out << I->first << "\n";
618       }
619       return false;
620     }
621 
622     /// Indicates that a particular module file extension has been read.
623     void readModuleFileExtension(
624            const ModuleFileExtensionMetadata &Metadata) override {
625       Out.indent(2) << "Module file extension '"
626                     << Metadata.BlockName << "' " << Metadata.MajorVersion
627                     << "." << Metadata.MinorVersion;
628       if (!Metadata.UserInfo.empty()) {
629         Out << ": ";
630         Out.write_escaped(Metadata.UserInfo);
631       }
632 
633       Out << "\n";
634     }
635 
636     /// Tells the \c ASTReaderListener that we want to receive the
637     /// input files of the AST file via \c visitInputFile.
638     bool needsInputFileVisitation() override { return true; }
639 
640     /// Tells the \c ASTReaderListener that we want to receive the
641     /// input files of the AST file via \c visitInputFile.
642     bool needsSystemInputFileVisitation() override { return true; }
643 
644     /// Indicates that the AST file contains particular input file.
645     ///
646     /// \returns true to continue receiving the next input file, false to stop.
647     bool visitInputFile(StringRef Filename, bool isSystem,
648                         bool isOverridden, bool isExplicitModule) override {
649 
650       Out.indent(2) << "Input file: " << Filename;
651 
652       if (isSystem || isOverridden || isExplicitModule) {
653         Out << " [";
654         if (isSystem) {
655           Out << "System";
656           if (isOverridden || isExplicitModule)
657             Out << ", ";
658         }
659         if (isOverridden) {
660           Out << "Overridden";
661           if (isExplicitModule)
662             Out << ", ";
663         }
664         if (isExplicitModule)
665           Out << "ExplicitModule";
666 
667         Out << "]";
668       }
669 
670       Out << "\n";
671 
672       return true;
673     }
674 
675     /// Returns true if this \c ASTReaderListener wants to receive the
676     /// imports of the AST file via \c visitImport, false otherwise.
677     bool needsImportVisitation() const override { return true; }
678 
679     /// If needsImportVisitation returns \c true, this is called for each
680     /// AST file imported by this AST file.
681     void visitImport(StringRef ModuleName, StringRef Filename) override {
682       Out.indent(2) << "Imports module '" << ModuleName
683                     << "': " << Filename.str() << "\n";
684     }
685 #undef DUMP_BOOLEAN
686   };
687 }
688 
689 bool DumpModuleInfoAction::BeginInvocation(CompilerInstance &CI) {
690   // The Object file reader also supports raw ast files and there is no point in
691   // being strict about the module file format in -module-file-info mode.
692   CI.getHeaderSearchOpts().ModuleFormat = "obj";
693   return true;
694 }
695 
696 void DumpModuleInfoAction::ExecuteAction() {
697   // Set up the output file.
698   std::unique_ptr<llvm::raw_fd_ostream> OutFile;
699   StringRef OutputFileName = getCompilerInstance().getFrontendOpts().OutputFile;
700   if (!OutputFileName.empty() && OutputFileName != "-") {
701     std::error_code EC;
702     OutFile.reset(new llvm::raw_fd_ostream(OutputFileName.str(), EC,
703                                            llvm::sys::fs::OF_Text));
704   }
705   llvm::raw_ostream &Out = OutFile.get()? *OutFile.get() : llvm::outs();
706 
707   Out << "Information for module file '" << getCurrentFile() << "':\n";
708   auto &FileMgr = getCompilerInstance().getFileManager();
709   auto Buffer = FileMgr.getBufferForFile(getCurrentFile());
710   StringRef Magic = (*Buffer)->getMemBufferRef().getBuffer();
711   bool IsRaw = (Magic.size() >= 4 && Magic[0] == 'C' && Magic[1] == 'P' &&
712                 Magic[2] == 'C' && Magic[3] == 'H');
713   Out << "  Module format: " << (IsRaw ? "raw" : "obj") << "\n";
714 
715   Preprocessor &PP = getCompilerInstance().getPreprocessor();
716   DumpModuleInfoListener Listener(Out);
717   HeaderSearchOptions &HSOpts =
718       PP.getHeaderSearchInfo().getHeaderSearchOpts();
719   ASTReader::readASTFileControlBlock(
720       getCurrentFile(), FileMgr, getCompilerInstance().getPCHContainerReader(),
721       /*FindModuleFileExtensions=*/true, Listener,
722       HSOpts.ModulesValidateDiagnosticOptions);
723 }
724 
725 //===----------------------------------------------------------------------===//
726 // Preprocessor Actions
727 //===----------------------------------------------------------------------===//
728 
729 void DumpRawTokensAction::ExecuteAction() {
730   Preprocessor &PP = getCompilerInstance().getPreprocessor();
731   SourceManager &SM = PP.getSourceManager();
732 
733   // Start lexing the specified input file.
734   const llvm::MemoryBuffer *FromFile = SM.getBuffer(SM.getMainFileID());
735   Lexer RawLex(SM.getMainFileID(), FromFile, SM, PP.getLangOpts());
736   RawLex.SetKeepWhitespaceMode(true);
737 
738   Token RawTok;
739   RawLex.LexFromRawLexer(RawTok);
740   while (RawTok.isNot(tok::eof)) {
741     PP.DumpToken(RawTok, true);
742     llvm::errs() << "\n";
743     RawLex.LexFromRawLexer(RawTok);
744   }
745 }
746 
747 void DumpTokensAction::ExecuteAction() {
748   Preprocessor &PP = getCompilerInstance().getPreprocessor();
749   // Start preprocessing the specified input file.
750   Token Tok;
751   PP.EnterMainSourceFile();
752   do {
753     PP.Lex(Tok);
754     PP.DumpToken(Tok, true);
755     llvm::errs() << "\n";
756   } while (Tok.isNot(tok::eof));
757 }
758 
759 void PreprocessOnlyAction::ExecuteAction() {
760   Preprocessor &PP = getCompilerInstance().getPreprocessor();
761 
762   // Ignore unknown pragmas.
763   PP.IgnorePragmas();
764 
765   Token Tok;
766   // Start parsing the specified input file.
767   PP.EnterMainSourceFile();
768   do {
769     PP.Lex(Tok);
770   } while (Tok.isNot(tok::eof));
771 }
772 
773 void PrintPreprocessedAction::ExecuteAction() {
774   CompilerInstance &CI = getCompilerInstance();
775   // Output file may need to be set to 'Binary', to avoid converting Unix style
776   // line feeds (<LF>) to Microsoft style line feeds (<CR><LF>).
777   //
778   // Look to see what type of line endings the file uses. If there's a
779   // CRLF, then we won't open the file up in binary mode. If there is
780   // just an LF or CR, then we will open the file up in binary mode.
781   // In this fashion, the output format should match the input format, unless
782   // the input format has inconsistent line endings.
783   //
784   // This should be a relatively fast operation since most files won't have
785   // all of their source code on a single line. However, that is still a
786   // concern, so if we scan for too long, we'll just assume the file should
787   // be opened in binary mode.
788   bool BinaryMode = true;
789   bool InvalidFile = false;
790   const SourceManager& SM = CI.getSourceManager();
791   const llvm::MemoryBuffer *Buffer = SM.getBuffer(SM.getMainFileID(),
792                                                      &InvalidFile);
793   if (!InvalidFile) {
794     const char *cur = Buffer->getBufferStart();
795     const char *end = Buffer->getBufferEnd();
796     const char *next = (cur != end) ? cur + 1 : end;
797 
798     // Limit ourselves to only scanning 256 characters into the source
799     // file.  This is mostly a sanity check in case the file has no
800     // newlines whatsoever.
801     if (end - cur > 256) end = cur + 256;
802 
803     while (next < end) {
804       if (*cur == 0x0D) {  // CR
805         if (*next == 0x0A)  // CRLF
806           BinaryMode = false;
807 
808         break;
809       } else if (*cur == 0x0A)  // LF
810         break;
811 
812       ++cur;
813       ++next;
814     }
815   }
816 
817   std::unique_ptr<raw_ostream> OS =
818       CI.createDefaultOutputFile(BinaryMode, getCurrentFileOrBufferName());
819   if (!OS) return;
820 
821   // If we're preprocessing a module map, start by dumping the contents of the
822   // module itself before switching to the input buffer.
823   auto &Input = getCurrentInput();
824   if (Input.getKind().getFormat() == InputKind::ModuleMap) {
825     if (Input.isFile()) {
826       (*OS) << "# 1 \"";
827       OS->write_escaped(Input.getFile());
828       (*OS) << "\"\n";
829     }
830     getCurrentModule()->print(*OS);
831     (*OS) << "#pragma clang module contents\n";
832   }
833 
834   DoPrintPreprocessedInput(CI.getPreprocessor(), OS.get(),
835                            CI.getPreprocessorOutputOpts());
836 }
837 
838 void PrintPreambleAction::ExecuteAction() {
839   switch (getCurrentFileKind().getLanguage()) {
840   case Language::C:
841   case Language::CXX:
842   case Language::ObjC:
843   case Language::ObjCXX:
844   case Language::OpenCL:
845   case Language::CUDA:
846   case Language::HIP:
847     break;
848 
849   case Language::Unknown:
850   case Language::Asm:
851   case Language::LLVM_IR:
852   case Language::RenderScript:
853     // We can't do anything with these.
854     return;
855   }
856 
857   // We don't expect to find any #include directives in a preprocessed input.
858   if (getCurrentFileKind().isPreprocessed())
859     return;
860 
861   CompilerInstance &CI = getCompilerInstance();
862   auto Buffer = CI.getFileManager().getBufferForFile(getCurrentFile());
863   if (Buffer) {
864     unsigned Preamble =
865         Lexer::ComputePreamble((*Buffer)->getBuffer(), CI.getLangOpts()).Size;
866     llvm::outs().write((*Buffer)->getBufferStart(), Preamble);
867   }
868 }
869 
870 void DumpCompilerOptionsAction::ExecuteAction() {
871   CompilerInstance &CI = getCompilerInstance();
872   std::unique_ptr<raw_ostream> OSP =
873       CI.createDefaultOutputFile(false, getCurrentFile());
874   if (!OSP)
875     return;
876 
877   raw_ostream &OS = *OSP;
878   const Preprocessor &PP = CI.getPreprocessor();
879   const LangOptions &LangOpts = PP.getLangOpts();
880 
881   // FIXME: Rather than manually format the JSON (which is awkward due to
882   // needing to remove trailing commas), this should make use of a JSON library.
883   // FIXME: Instead of printing enums as an integral value and specifying the
884   // type as a separate field, use introspection to print the enumerator.
885 
886   OS << "{\n";
887   OS << "\n\"features\" : [\n";
888   {
889     llvm::SmallString<128> Str;
890 #define FEATURE(Name, Predicate)                                               \
891   ("\t{\"" #Name "\" : " + llvm::Twine(Predicate ? "true" : "false") + "},\n") \
892       .toVector(Str);
893 #include "clang/Basic/Features.def"
894 #undef FEATURE
895     // Remove the newline and comma from the last entry to ensure this remains
896     // valid JSON.
897     OS << Str.substr(0, Str.size() - 2);
898   }
899   OS << "\n],\n";
900 
901   OS << "\n\"extensions\" : [\n";
902   {
903     llvm::SmallString<128> Str;
904 #define EXTENSION(Name, Predicate)                                             \
905   ("\t{\"" #Name "\" : " + llvm::Twine(Predicate ? "true" : "false") + "},\n") \
906       .toVector(Str);
907 #include "clang/Basic/Features.def"
908 #undef EXTENSION
909     // Remove the newline and comma from the last entry to ensure this remains
910     // valid JSON.
911     OS << Str.substr(0, Str.size() - 2);
912   }
913   OS << "\n]\n";
914 
915   OS << "}";
916 }
917 
918 void PrintDependencyDirectivesSourceMinimizerAction::ExecuteAction() {
919   CompilerInstance &CI = getCompilerInstance();
920   SourceManager &SM = CI.getPreprocessor().getSourceManager();
921   const llvm::MemoryBuffer *FromFile = SM.getBuffer(SM.getMainFileID());
922 
923   llvm::SmallString<1024> Output;
924   llvm::SmallVector<minimize_source_to_dependency_directives::Token, 32> Toks;
925   if (minimizeSourceToDependencyDirectives(
926           FromFile->getBuffer(), Output, Toks, &CI.getDiagnostics(),
927           SM.getLocForStartOfFile(SM.getMainFileID()))) {
928     assert(CI.getDiagnostics().hasErrorOccurred() &&
929            "no errors reported for failure");
930 
931     // Preprocess the source when verifying the diagnostics to capture the
932     // 'expected' comments.
933     if (CI.getDiagnosticOpts().VerifyDiagnostics) {
934       // Make sure we don't emit new diagnostics!
935       CI.getDiagnostics().setSuppressAllDiagnostics(true);
936       Preprocessor &PP = getCompilerInstance().getPreprocessor();
937       PP.EnterMainSourceFile();
938       Token Tok;
939       do {
940         PP.Lex(Tok);
941       } while (Tok.isNot(tok::eof));
942     }
943     return;
944   }
945   llvm::outs() << Output;
946 }
947