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