]> CyberLeo.Net >> Repos - FreeBSD/releng/10.2.git/blob - contrib/llvm/tools/clang/lib/Frontend/FrontendActions.cpp
- Copy stable/10@285827 to releng/10.2 in preparation for 10.2-RC1
[FreeBSD/releng/10.2.git] / contrib / llvm / tools / clang / lib / Frontend / FrontendActions.cpp
1 //===--- FrontendActions.cpp ----------------------------------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9
10 #include "clang/Frontend/FrontendActions.h"
11 #include "clang/AST/ASTConsumer.h"
12 #include "clang/Basic/FileManager.h"
13 #include "clang/Frontend/ASTConsumers.h"
14 #include "clang/Frontend/ASTUnit.h"
15 #include "clang/Frontend/CompilerInstance.h"
16 #include "clang/Frontend/FrontendDiagnostic.h"
17 #include "clang/Frontend/Utils.h"
18 #include "clang/Lex/HeaderSearch.h"
19 #include "clang/Lex/Pragma.h"
20 #include "clang/Lex/Preprocessor.h"
21 #include "clang/Parse/Parser.h"
22 #include "clang/Serialization/ASTReader.h"
23 #include "clang/Serialization/ASTWriter.h"
24 #include "llvm/ADT/OwningPtr.h"
25 #include "llvm/Support/FileSystem.h"
26 #include "llvm/Support/MemoryBuffer.h"
27 #include "llvm/Support/raw_ostream.h"
28 #include "llvm/Support/system_error.h"
29
30 using namespace clang;
31
32 //===----------------------------------------------------------------------===//
33 // Custom Actions
34 //===----------------------------------------------------------------------===//
35
36 ASTConsumer *InitOnlyAction::CreateASTConsumer(CompilerInstance &CI,
37                                                StringRef InFile) {
38   return new ASTConsumer();
39 }
40
41 void InitOnlyAction::ExecuteAction() {
42 }
43
44 //===----------------------------------------------------------------------===//
45 // AST Consumer Actions
46 //===----------------------------------------------------------------------===//
47
48 ASTConsumer *ASTPrintAction::CreateASTConsumer(CompilerInstance &CI,
49                                                StringRef InFile) {
50   if (raw_ostream *OS = CI.createDefaultOutputFile(false, InFile))
51     return CreateASTPrinter(OS, CI.getFrontendOpts().ASTDumpFilter);
52   return 0;
53 }
54
55 ASTConsumer *ASTDumpAction::CreateASTConsumer(CompilerInstance &CI,
56                                               StringRef InFile) {
57   return CreateASTDumper(CI.getFrontendOpts().ASTDumpFilter,
58                          CI.getFrontendOpts().ASTDumpLookups);
59 }
60
61 ASTConsumer *ASTDeclListAction::CreateASTConsumer(CompilerInstance &CI,
62                                                   StringRef InFile) {
63   return CreateASTDeclNodeLister();
64 }
65
66 ASTConsumer *ASTViewAction::CreateASTConsumer(CompilerInstance &CI,
67                                               StringRef InFile) {
68   return CreateASTViewer();
69 }
70
71 ASTConsumer *DeclContextPrintAction::CreateASTConsumer(CompilerInstance &CI,
72                                                        StringRef InFile) {
73   return CreateDeclContextPrinter();
74 }
75
76 ASTConsumer *GeneratePCHAction::CreateASTConsumer(CompilerInstance &CI,
77                                                   StringRef InFile) {
78   std::string Sysroot;
79   std::string OutputFile;
80   raw_ostream *OS = 0;
81   if (ComputeASTConsumerArguments(CI, InFile, Sysroot, OutputFile, OS))
82     return 0;
83
84   if (!CI.getFrontendOpts().RelocatablePCH)
85     Sysroot.clear();
86   return new PCHGenerator(CI.getPreprocessor(), OutputFile, 0, Sysroot, OS);
87 }
88
89 bool GeneratePCHAction::ComputeASTConsumerArguments(CompilerInstance &CI,
90                                                     StringRef InFile,
91                                                     std::string &Sysroot,
92                                                     std::string &OutputFile,
93                                                     raw_ostream *&OS) {
94   Sysroot = CI.getHeaderSearchOpts().Sysroot;
95   if (CI.getFrontendOpts().RelocatablePCH && Sysroot.empty()) {
96     CI.getDiagnostics().Report(diag::err_relocatable_without_isysroot);
97     return true;
98   }
99
100   // We use createOutputFile here because this is exposed via libclang, and we
101   // must disable the RemoveFileOnSignal behavior.
102   // We use a temporary to avoid race conditions.
103   OS = CI.createOutputFile(CI.getFrontendOpts().OutputFile, /*Binary=*/true,
104                            /*RemoveFileOnSignal=*/false, InFile,
105                            /*Extension=*/"", /*useTemporary=*/true);
106   if (!OS)
107     return true;
108
109   OutputFile = CI.getFrontendOpts().OutputFile;
110   return false;
111 }
112
113 ASTConsumer *GenerateModuleAction::CreateASTConsumer(CompilerInstance &CI,
114                                                      StringRef InFile) {
115   std::string Sysroot;
116   std::string OutputFile;
117   raw_ostream *OS = 0;
118   if (ComputeASTConsumerArguments(CI, InFile, Sysroot, OutputFile, OS))
119     return 0;
120   
121   return new PCHGenerator(CI.getPreprocessor(), OutputFile, Module, 
122                           Sysroot, OS);
123 }
124
125 static SmallVectorImpl<char> &
126 operator+=(SmallVectorImpl<char> &Includes, StringRef RHS) {
127   Includes.append(RHS.begin(), RHS.end());
128   return Includes;
129 }
130
131 static void addHeaderInclude(StringRef HeaderName,
132                              SmallVectorImpl<char> &Includes,
133                              const LangOptions &LangOpts) {
134   if (LangOpts.ObjC1)
135     Includes += "#import \"";
136   else
137     Includes += "#include \"";
138   Includes += HeaderName;
139   Includes += "\"\n";
140 }
141
142 static void addHeaderInclude(const FileEntry *Header,
143                              SmallVectorImpl<char> &Includes,
144                              const LangOptions &LangOpts) {
145   addHeaderInclude(Header->getName(), Includes, LangOpts);
146 }
147
148 /// \brief Collect the set of header includes needed to construct the given 
149 /// module and update the TopHeaders file set of the module.
150 ///
151 /// \param Module The module we're collecting includes from.
152 ///
153 /// \param Includes Will be augmented with the set of \#includes or \#imports
154 /// needed to load all of the named headers.
155 static void collectModuleHeaderIncludes(const LangOptions &LangOpts,
156                                         FileManager &FileMgr,
157                                         ModuleMap &ModMap,
158                                         clang::Module *Module,
159                                         SmallVectorImpl<char> &Includes) {
160   // Don't collect any headers for unavailable modules.
161   if (!Module->isAvailable())
162     return;
163
164   // Add includes for each of these headers.
165   for (unsigned I = 0, N = Module->NormalHeaders.size(); I != N; ++I) {
166     const FileEntry *Header = Module->NormalHeaders[I];
167     Module->addTopHeader(Header);
168     addHeaderInclude(Header, Includes, LangOpts);
169   }
170   // Note that Module->PrivateHeaders will not be a TopHeader.
171
172   if (const FileEntry *UmbrellaHeader = Module->getUmbrellaHeader()) {
173     Module->addTopHeader(UmbrellaHeader);
174     if (Module->Parent) {
175       // Include the umbrella header for submodules.
176       addHeaderInclude(UmbrellaHeader, Includes, LangOpts);
177     }
178   } else if (const DirectoryEntry *UmbrellaDir = Module->getUmbrellaDir()) {
179     // Add all of the headers we find in this subdirectory.
180     llvm::error_code EC;
181     SmallString<128> DirNative;
182     llvm::sys::path::native(UmbrellaDir->getName(), DirNative);
183     for (llvm::sys::fs::recursive_directory_iterator Dir(DirNative.str(), EC), 
184                                                      DirEnd;
185          Dir != DirEnd && !EC; Dir.increment(EC)) {
186       // Check whether this entry has an extension typically associated with 
187       // headers.
188       if (!llvm::StringSwitch<bool>(llvm::sys::path::extension(Dir->path()))
189           .Cases(".h", ".H", ".hh", ".hpp", true)
190           .Default(false))
191         continue;
192       
193       // If this header is marked 'unavailable' in this module, don't include 
194       // it.
195       if (const FileEntry *Header = FileMgr.getFile(Dir->path())) {
196         if (ModMap.isHeaderInUnavailableModule(Header))
197           continue;
198         Module->addTopHeader(Header);
199       }
200       
201       // Include this header umbrella header for submodules.
202       addHeaderInclude(Dir->path(), Includes, LangOpts);
203     }
204   }
205   
206   // Recurse into submodules.
207   for (clang::Module::submodule_iterator Sub = Module->submodule_begin(),
208                                       SubEnd = Module->submodule_end();
209        Sub != SubEnd; ++Sub)
210     collectModuleHeaderIncludes(LangOpts, FileMgr, ModMap, *Sub, Includes);
211 }
212
213 bool GenerateModuleAction::BeginSourceFileAction(CompilerInstance &CI, 
214                                                  StringRef Filename) {
215   // Find the module map file.  
216   const FileEntry *ModuleMap = CI.getFileManager().getFile(Filename);
217   if (!ModuleMap)  {
218     CI.getDiagnostics().Report(diag::err_module_map_not_found)
219       << Filename;
220     return false;
221   }
222   
223   // Parse the module map file.
224   HeaderSearch &HS = CI.getPreprocessor().getHeaderSearchInfo();
225   if (HS.loadModuleMapFile(ModuleMap, IsSystem))
226     return false;
227   
228   if (CI.getLangOpts().CurrentModule.empty()) {
229     CI.getDiagnostics().Report(diag::err_missing_module_name);
230     
231     // FIXME: Eventually, we could consider asking whether there was just
232     // a single module described in the module map, and use that as a 
233     // default. Then it would be fairly trivial to just "compile" a module
234     // map with a single module (the common case).
235     return false;
236   }
237   
238   // Dig out the module definition.
239   Module = HS.lookupModule(CI.getLangOpts().CurrentModule, 
240                            /*AllowSearch=*/false);
241   if (!Module) {
242     CI.getDiagnostics().Report(diag::err_missing_module)
243       << CI.getLangOpts().CurrentModule << Filename;
244     
245     return false;
246   }
247
248   // Check whether we can build this module at all.
249   clang::Module::Requirement Requirement;
250   if (!Module->isAvailable(CI.getLangOpts(), CI.getTarget(), Requirement)) {
251     CI.getDiagnostics().Report(diag::err_module_unavailable)
252       << Module->getFullModuleName()
253       << Requirement.second << Requirement.first;
254
255     return false;
256   }
257
258   FileManager &FileMgr = CI.getFileManager();
259
260   // Collect the set of #includes we need to build the module.
261   SmallString<256> HeaderContents;
262   if (const FileEntry *UmbrellaHeader = Module->getUmbrellaHeader())
263     addHeaderInclude(UmbrellaHeader, HeaderContents, CI.getLangOpts());
264   collectModuleHeaderIncludes(CI.getLangOpts(), FileMgr,
265     CI.getPreprocessor().getHeaderSearchInfo().getModuleMap(),
266     Module, HeaderContents);
267
268   llvm::MemoryBuffer *InputBuffer =
269       llvm::MemoryBuffer::getMemBufferCopy(HeaderContents,
270                                            Module::getModuleInputBufferName());
271   // Ownership of InputBuffer will be transfered to the SourceManager.
272   setCurrentInput(FrontendInputFile(InputBuffer, getCurrentFileKind(),
273                                     Module->IsSystem));
274   return true;
275 }
276
277 bool GenerateModuleAction::ComputeASTConsumerArguments(CompilerInstance &CI,
278                                                        StringRef InFile,
279                                                        std::string &Sysroot,
280                                                        std::string &OutputFile,
281                                                        raw_ostream *&OS) {
282   // If no output file was provided, figure out where this module would go
283   // in the module cache.
284   if (CI.getFrontendOpts().OutputFile.empty()) {
285     HeaderSearch &HS = CI.getPreprocessor().getHeaderSearchInfo();
286     SmallString<256> ModuleFileName(HS.getModuleCachePath());
287     llvm::sys::path::append(ModuleFileName, 
288                             CI.getLangOpts().CurrentModule + ".pcm");
289     CI.getFrontendOpts().OutputFile = ModuleFileName.str();
290   }
291   
292   // We use createOutputFile here because this is exposed via libclang, and we
293   // must disable the RemoveFileOnSignal behavior.
294   // We use a temporary to avoid race conditions.
295   OS = CI.createOutputFile(CI.getFrontendOpts().OutputFile, /*Binary=*/true,
296                            /*RemoveFileOnSignal=*/false, InFile,
297                            /*Extension=*/"", /*useTemporary=*/true,
298                            /*CreateMissingDirectories=*/true);
299   if (!OS)
300     return true;
301   
302   OutputFile = CI.getFrontendOpts().OutputFile;
303   return false;
304 }
305
306 ASTConsumer *SyntaxOnlyAction::CreateASTConsumer(CompilerInstance &CI,
307                                                  StringRef InFile) {
308   return new ASTConsumer();
309 }
310
311 ASTConsumer *DumpModuleInfoAction::CreateASTConsumer(CompilerInstance &CI,
312                                                      StringRef InFile) {
313   return new ASTConsumer();
314 }
315
316 namespace {
317   /// \brief AST reader listener that dumps module information for a module
318   /// file.
319   class DumpModuleInfoListener : public ASTReaderListener {
320     llvm::raw_ostream &Out;
321
322   public:
323     DumpModuleInfoListener(llvm::raw_ostream &Out) : Out(Out) { }
324
325 #define DUMP_BOOLEAN(Value, Text)                       \
326     Out.indent(4) << Text << ": " << (Value? "Yes" : "No") << "\n"
327
328     virtual bool ReadFullVersionInformation(StringRef FullVersion) {
329       Out.indent(2)
330         << "Generated by "
331         << (FullVersion == getClangFullRepositoryVersion()? "this"
332                                                           : "a different")
333         << " Clang: " << FullVersion << "\n";
334       return ASTReaderListener::ReadFullVersionInformation(FullVersion);
335     }
336
337     virtual bool ReadLanguageOptions(const LangOptions &LangOpts,
338                                      bool Complain) {
339       Out.indent(2) << "Language options:\n";
340 #define LANGOPT(Name, Bits, Default, Description) \
341       DUMP_BOOLEAN(LangOpts.Name, Description);
342 #define ENUM_LANGOPT(Name, Type, Bits, Default, Description) \
343       Out.indent(4) << Description << ": "                   \
344                     << static_cast<unsigned>(LangOpts.get##Name()) << "\n";
345 #define VALUE_LANGOPT(Name, Bits, Default, Description) \
346       Out.indent(4) << Description << ": " << LangOpts.Name << "\n";
347 #define BENIGN_LANGOPT(Name, Bits, Default, Description)
348 #define BENIGN_ENUM_LANGOPT(Name, Type, Bits, Default, Description)
349 #include "clang/Basic/LangOptions.def"
350       return false;
351     }
352
353     virtual bool ReadTargetOptions(const TargetOptions &TargetOpts,
354                                    bool Complain) {
355       Out.indent(2) << "Target options:\n";
356       Out.indent(4) << "  Triple: " << TargetOpts.Triple << "\n";
357       Out.indent(4) << "  CPU: " << TargetOpts.CPU << "\n";
358       Out.indent(4) << "  ABI: " << TargetOpts.ABI << "\n";
359       Out.indent(4) << "  C++ ABI: " << TargetOpts.CXXABI << "\n";
360       Out.indent(4) << "  Linker version: " << TargetOpts.LinkerVersion << "\n";
361
362       if (!TargetOpts.FeaturesAsWritten.empty()) {
363         Out.indent(4) << "Target features:\n";
364         for (unsigned I = 0, N = TargetOpts.FeaturesAsWritten.size();
365              I != N; ++I) {
366           Out.indent(6) << TargetOpts.FeaturesAsWritten[I] << "\n";
367         }
368       }
369
370       return false;
371     }
372
373     virtual bool ReadHeaderSearchOptions(const HeaderSearchOptions &HSOpts,
374                                          bool Complain) {
375       Out.indent(2) << "Header search options:\n";
376       Out.indent(4) << "System root [-isysroot=]: '" << HSOpts.Sysroot << "'\n";
377       DUMP_BOOLEAN(HSOpts.UseBuiltinIncludes,
378                    "Use builtin include directories [-nobuiltininc]");
379       DUMP_BOOLEAN(HSOpts.UseStandardSystemIncludes,
380                    "Use standard system include directories [-nostdinc]");
381       DUMP_BOOLEAN(HSOpts.UseStandardCXXIncludes,
382                    "Use standard C++ include directories [-nostdinc++]");
383       DUMP_BOOLEAN(HSOpts.UseLibcxx,
384                    "Use libc++ (rather than libstdc++) [-stdlib=]");
385       return false;
386     }
387
388     virtual bool ReadPreprocessorOptions(const PreprocessorOptions &PPOpts,
389                                          bool Complain,
390                                          std::string &SuggestedPredefines) {
391       Out.indent(2) << "Preprocessor options:\n";
392       DUMP_BOOLEAN(PPOpts.UsePredefines,
393                    "Uses compiler/target-specific predefines [-undef]");
394       DUMP_BOOLEAN(PPOpts.DetailedRecord,
395                    "Uses detailed preprocessing record (for indexing)");
396
397       if (!PPOpts.Macros.empty()) {
398         Out.indent(4) << "Predefined macros:\n";
399       }
400
401       for (std::vector<std::pair<std::string, bool/*isUndef*/> >::const_iterator
402              I = PPOpts.Macros.begin(), IEnd = PPOpts.Macros.end();
403            I != IEnd; ++I) {
404         Out.indent(6);
405         if (I->second)
406           Out << "-U";
407         else
408           Out << "-D";
409         Out << I->first << "\n";
410       }
411       return false;
412     }
413 #undef DUMP_BOOLEAN
414   };
415 }
416
417 void DumpModuleInfoAction::ExecuteAction() {
418   // Set up the output file.
419   llvm::OwningPtr<llvm::raw_fd_ostream> OutFile;
420   StringRef OutputFileName = getCompilerInstance().getFrontendOpts().OutputFile;
421   if (!OutputFileName.empty() && OutputFileName != "-") {
422     std::string ErrorInfo;
423     OutFile.reset(new llvm::raw_fd_ostream(OutputFileName.str().c_str(),
424                                            ErrorInfo));
425   }
426   llvm::raw_ostream &Out = OutFile.get()? *OutFile.get() : llvm::outs();
427
428   Out << "Information for module file '" << getCurrentFile() << "':\n";
429   DumpModuleInfoListener Listener(Out);
430   ASTReader::readASTFileControlBlock(getCurrentFile(),
431                                      getCompilerInstance().getFileManager(),
432                                      Listener);
433 }
434
435 //===----------------------------------------------------------------------===//
436 // Preprocessor Actions
437 //===----------------------------------------------------------------------===//
438
439 void DumpRawTokensAction::ExecuteAction() {
440   Preprocessor &PP = getCompilerInstance().getPreprocessor();
441   SourceManager &SM = PP.getSourceManager();
442
443   // Start lexing the specified input file.
444   const llvm::MemoryBuffer *FromFile = SM.getBuffer(SM.getMainFileID());
445   Lexer RawLex(SM.getMainFileID(), FromFile, SM, PP.getLangOpts());
446   RawLex.SetKeepWhitespaceMode(true);
447
448   Token RawTok;
449   RawLex.LexFromRawLexer(RawTok);
450   while (RawTok.isNot(tok::eof)) {
451     PP.DumpToken(RawTok, true);
452     llvm::errs() << "\n";
453     RawLex.LexFromRawLexer(RawTok);
454   }
455 }
456
457 void DumpTokensAction::ExecuteAction() {
458   Preprocessor &PP = getCompilerInstance().getPreprocessor();
459   // Start preprocessing the specified input file.
460   Token Tok;
461   PP.EnterMainSourceFile();
462   do {
463     PP.Lex(Tok);
464     PP.DumpToken(Tok, true);
465     llvm::errs() << "\n";
466   } while (Tok.isNot(tok::eof));
467 }
468
469 void GeneratePTHAction::ExecuteAction() {
470   CompilerInstance &CI = getCompilerInstance();
471   if (CI.getFrontendOpts().OutputFile.empty() ||
472       CI.getFrontendOpts().OutputFile == "-") {
473     // FIXME: Don't fail this way.
474     // FIXME: Verify that we can actually seek in the given file.
475     llvm::report_fatal_error("PTH requires a seekable file for output!");
476   }
477   llvm::raw_fd_ostream *OS =
478     CI.createDefaultOutputFile(true, getCurrentFile());
479   if (!OS) return;
480
481   CacheTokens(CI.getPreprocessor(), OS);
482 }
483
484 void PreprocessOnlyAction::ExecuteAction() {
485   Preprocessor &PP = getCompilerInstance().getPreprocessor();
486
487   // Ignore unknown pragmas.
488   PP.AddPragmaHandler(new EmptyPragmaHandler());
489
490   Token Tok;
491   // Start parsing the specified input file.
492   PP.EnterMainSourceFile();
493   do {
494     PP.Lex(Tok);
495   } while (Tok.isNot(tok::eof));
496 }
497
498 void PrintPreprocessedAction::ExecuteAction() {
499   CompilerInstance &CI = getCompilerInstance();
500   // Output file may need to be set to 'Binary', to avoid converting Unix style
501   // line feeds (<LF>) to Microsoft style line feeds (<CR><LF>).
502   //
503   // Look to see what type of line endings the file uses. If there's a
504   // CRLF, then we won't open the file up in binary mode. If there is
505   // just an LF or CR, then we will open the file up in binary mode.
506   // In this fashion, the output format should match the input format, unless
507   // the input format has inconsistent line endings.
508   //
509   // This should be a relatively fast operation since most files won't have
510   // all of their source code on a single line. However, that is still a 
511   // concern, so if we scan for too long, we'll just assume the file should
512   // be opened in binary mode.
513   bool BinaryMode = true;
514   bool InvalidFile = false;
515   const SourceManager& SM = CI.getSourceManager();
516   const llvm::MemoryBuffer *Buffer = SM.getBuffer(SM.getMainFileID(), 
517                                                      &InvalidFile);
518   if (!InvalidFile) {
519     const char *cur = Buffer->getBufferStart();
520     const char *end = Buffer->getBufferEnd();
521     const char *next = (cur != end) ? cur + 1 : end;
522
523     // Limit ourselves to only scanning 256 characters into the source
524     // file.  This is mostly a sanity check in case the file has no 
525     // newlines whatsoever.
526     if (end - cur > 256) end = cur + 256;
527           
528     while (next < end) {
529       if (*cur == 0x0D) {  // CR
530         if (*next == 0x0A)  // CRLF
531           BinaryMode = false;
532
533         break;
534       } else if (*cur == 0x0A)  // LF
535         break;
536
537       ++cur, ++next;
538     }
539   }
540
541   raw_ostream *OS = CI.createDefaultOutputFile(BinaryMode, getCurrentFile());
542   if (!OS) return;
543
544   DoPrintPreprocessedInput(CI.getPreprocessor(), OS,
545                            CI.getPreprocessorOutputOpts());
546 }
547
548 void PrintPreambleAction::ExecuteAction() {
549   switch (getCurrentFileKind()) {
550   case IK_C:
551   case IK_CXX:
552   case IK_ObjC:
553   case IK_ObjCXX:
554   case IK_OpenCL:
555   case IK_CUDA:
556     break;
557       
558   case IK_None:
559   case IK_Asm:
560   case IK_PreprocessedC:
561   case IK_PreprocessedCXX:
562   case IK_PreprocessedObjC:
563   case IK_PreprocessedObjCXX:
564   case IK_AST:
565   case IK_LLVM_IR:
566     // We can't do anything with these.
567     return;
568   }
569   
570   CompilerInstance &CI = getCompilerInstance();
571   llvm::MemoryBuffer *Buffer
572       = CI.getFileManager().getBufferForFile(getCurrentFile());
573   if (Buffer) {
574     unsigned Preamble = Lexer::ComputePreamble(Buffer, CI.getLangOpts()).first;
575     llvm::outs().write(Buffer->getBufferStart(), Preamble);
576     delete Buffer;
577   }
578 }