contrib/llvm/tools/clang/lib/Frontend/FrontendAction.cpp

   1 //===--- FrontendAction.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/FrontendAction.h"
  11 #include "clang/AST/ASTConsumer.h"
  12 #include "clang/AST/ASTContext.h"
  13 #include "clang/AST/DeclGroup.h"
  14 #include "clang/Lex/HeaderSearch.h"
  15 #include "clang/Lex/Preprocessor.h"
  16 #include "clang/Frontend/ASTUnit.h"
  17 #include "clang/Frontend/CompilerInstance.h"
  18 #include "clang/Frontend/FrontendDiagnostic.h"
  19 #include "clang/Frontend/FrontendPluginRegistry.h"
  20 #include "clang/Frontend/MultiplexConsumer.h"
  21 #include "clang/Parse/ParseAST.h"
  22 #include "clang/Serialization/ASTDeserializationListener.h"
  23 #include "clang/Serialization/ChainedIncludesSource.h"
  24 #include "llvm/Support/MemoryBuffer.h"
  25 #include "llvm/Support/Timer.h"
  26 #include "llvm/Support/ErrorHandling.h"
  27 #include "llvm/Support/raw_ostream.h"
  28 using namespace clang;
  29
  30 namespace {
  31
  32 /// \brief Dumps deserialized declarations.
  33 class DeserializedDeclsDumper : public ASTDeserializationListener {
  34   ASTDeserializationListener *Previous;
  35
  36 public:
  37   DeserializedDeclsDumper(ASTDeserializationListener *Previous)
  38     : Previous(Previous) { }
  39
  40   virtual void DeclRead(serialization::DeclID ID, const Decl *D) {
  41     llvm::outs() << "PCH DECL: " << D->getDeclKindName();
  42     if (const NamedDecl *ND = dyn_cast<NamedDecl>(D))
  43       llvm::outs() << " - " << ND->getNameAsString();
  44     llvm::outs() << "\n";
  45
  46     if (Previous)
  47       Previous->DeclRead(ID, D);
  48   }
  49 };
  50
  51   /// \brief Checks deserialized declarations and emits error if a name
  52   /// matches one given in command-line using -error-on-deserialized-decl.
  53   class DeserializedDeclsChecker : public ASTDeserializationListener {
  54     ASTContext &Ctx;
  55     std::set<std::string> NamesToCheck;
  56     ASTDeserializationListener *Previous;
  57
  58   public:
  59     DeserializedDeclsChecker(ASTContext &Ctx,
  60                              const std::set<std::string> &NamesToCheck,
  61                              ASTDeserializationListener *Previous)
  62       : Ctx(Ctx), NamesToCheck(NamesToCheck), Previous(Previous) { }
  63
  64     virtual void DeclRead(serialization::DeclID ID, const Decl *D) {
  65       if (const NamedDecl *ND = dyn_cast<NamedDecl>(D))
  66         if (NamesToCheck.find(ND->getNameAsString()) != NamesToCheck.end()) {
  67           unsigned DiagID
  68             = Ctx.getDiagnostics().getCustomDiagID(Diagnostic::Error,
  69                                                    "%0 was deserialized");
  70           Ctx.getDiagnostics().Report(Ctx.getFullLoc(D->getLocation()), DiagID)
  71               << ND->getNameAsString();
  72         }
  73
  74       if (Previous)
  75         Previous->DeclRead(ID, D);
  76     }
  77 };
  78
  79 } // end anonymous namespace
  80
  81 FrontendAction::FrontendAction() : Instance(0) {}
  82
  83 FrontendAction::~FrontendAction() {}
  84
  85 void FrontendAction::setCurrentFile(llvm::StringRef Value, InputKind Kind,
  86                                     ASTUnit *AST) {
  87   CurrentFile = Value;
  88   CurrentFileKind = Kind;
  89   CurrentASTUnit.reset(AST);
  90 }
  91
  92 ASTConsumer* FrontendAction::CreateWrappedASTConsumer(CompilerInstance &CI,
  93                                                       llvm::StringRef InFile) {
  94   ASTConsumer* Consumer = CreateASTConsumer(CI, InFile);
  95   if (!Consumer)
  96     return 0;
  97
  98   if (CI.getFrontendOpts().AddPluginActions.size() == 0)
  99     return Consumer;
 100
 101   // Make sure the non-plugin consumer is first, so that plugins can't
 102   // modifiy the AST.
 103   std::vector<ASTConsumer*> Consumers(1, Consumer);
 104
 105   for (size_t i = 0, e = CI.getFrontendOpts().AddPluginActions.size();
 106        i != e; ++i) {
 107     // This is O(|plugins| * |add_plugins|), but since both numbers are
 108     // way below 50 in practice, that's ok.
 109     for (FrontendPluginRegistry::iterator
 110         it = FrontendPluginRegistry::begin(),
 111         ie = FrontendPluginRegistry::end();
 112         it != ie; ++it) {
 113       if (it->getName() == CI.getFrontendOpts().AddPluginActions[i]) {
 114         llvm::OwningPtr<PluginASTAction> P(it->instantiate());
 115         FrontendAction* c = P.get();
 116         if (P->ParseArgs(CI, CI.getFrontendOpts().AddPluginArgs[i]))
 117           Consumers.push_back(c->CreateASTConsumer(CI, InFile));
 118       }
 119     }
 120   }
 121
 122   return new MultiplexConsumer(Consumers);
 123 }
 124
 125 bool FrontendAction::BeginSourceFile(CompilerInstance &CI,
 126                                      llvm::StringRef Filename,
 127                                      InputKind InputKind) {
 128   assert(!Instance && "Already processing a source file!");
 129   assert(!Filename.empty() && "Unexpected empty filename!");
 130   setCurrentFile(Filename, InputKind);
 131   setCompilerInstance(&CI);
 132
 133   // AST files follow a very different path, since they share objects via the
 134   // AST unit.
 135   if (InputKind == IK_AST) {
 136     assert(!usesPreprocessorOnly() &&
 137            "Attempt to pass AST file to preprocessor only action!");
 138     assert(hasASTFileSupport() &&
 139            "This action does not have AST file support!");
 140
 141     llvm::IntrusiveRefCntPtr<Diagnostic> Diags(&CI.getDiagnostics());
 142     std::string Error;
 143     ASTUnit *AST = ASTUnit::LoadFromASTFile(Filename, Diags,
 144                                             CI.getFileSystemOpts());
 145     if (!AST)
 146       goto failure;
 147
 148     setCurrentFile(Filename, InputKind, AST);
 149
 150     // Set the shared objects, these are reset when we finish processing the
 151     // file, otherwise the CompilerInstance will happily destroy them.
 152     CI.setFileManager(&AST->getFileManager());
 153     CI.setSourceManager(&AST->getSourceManager());
 154     CI.setPreprocessor(&AST->getPreprocessor());
 155     CI.setASTContext(&AST->getASTContext());
 156
 157     // Initialize the action.
 158     if (!BeginSourceFileAction(CI, Filename))
 159       goto failure;
 160
 161     /// Create the AST consumer.
 162     CI.setASTConsumer(CreateWrappedASTConsumer(CI, Filename));
 163     if (!CI.hasASTConsumer())
 164       goto failure;
 165
 166     return true;
 167   }
 168
 169   // Set up the file and source managers, if needed.
 170   if (!CI.hasFileManager())
 171     CI.createFileManager();
 172   if (!CI.hasSourceManager())
 173     CI.createSourceManager(CI.getFileManager());
 174
 175   // IR files bypass the rest of initialization.
 176   if (InputKind == IK_LLVM_IR) {
 177     assert(hasIRSupport() &&
 178            "This action does not have IR file support!");
 179
 180     // Inform the diagnostic client we are processing a source file.
 181     CI.getDiagnosticClient().BeginSourceFile(CI.getLangOpts(), 0);
 182
 183     // Initialize the action.
 184     if (!BeginSourceFileAction(CI, Filename))
 185       goto failure;
 186
 187     return true;
 188   }
 189
 190   // Set up the preprocessor.
 191   CI.createPreprocessor();
 192
 193   // Inform the diagnostic client we are processing a source file.
 194   CI.getDiagnosticClient().BeginSourceFile(CI.getLangOpts(),
 195                                            &CI.getPreprocessor());
 196
 197   // Initialize the action.
 198   if (!BeginSourceFileAction(CI, Filename))
 199     goto failure;
 200
 201   /// Create the AST context and consumer unless this is a preprocessor only
 202   /// action.
 203   if (!usesPreprocessorOnly()) {
 204     CI.createASTContext();
 205
 206     llvm::OwningPtr<ASTConsumer> Consumer(
 207         CreateWrappedASTConsumer(CI, Filename));
 208     if (!Consumer)
 209       goto failure;
 210
 211     CI.getASTContext().setASTMutationListener(Consumer->GetASTMutationListener());
 212
 213     if (!CI.getPreprocessorOpts().ChainedIncludes.empty()) {
 214       // Convert headers to PCH and chain them.
 215       llvm::OwningPtr<ExternalASTSource> source;
 216       source.reset(ChainedIncludesSource::create(CI));
 217       if (!source)
 218         goto failure;
 219       CI.getASTContext().setExternalSource(source);
 220
 221     } else if (!CI.getPreprocessorOpts().ImplicitPCHInclude.empty()) {
 222       // Use PCH.
 223       assert(hasPCHSupport() && "This action does not have PCH support!");
 224       ASTDeserializationListener *DeserialListener
 225           = CI.getInvocation().getFrontendOpts().ChainedPCH ?
 226                   Consumer->GetASTDeserializationListener() : 0;
 227       if (CI.getPreprocessorOpts().DumpDeserializedPCHDecls)
 228         DeserialListener = new DeserializedDeclsDumper(DeserialListener);
 229       if (!CI.getPreprocessorOpts().DeserializedPCHDeclsToErrorOn.empty())
 230         DeserialListener = new DeserializedDeclsChecker(CI.getASTContext(),
 231                          CI.getPreprocessorOpts().DeserializedPCHDeclsToErrorOn,
 232                                                         DeserialListener);
 233       CI.createPCHExternalASTSource(
 234                                 CI.getPreprocessorOpts().ImplicitPCHInclude,
 235                                 CI.getPreprocessorOpts().DisablePCHValidation,
 236                                 CI.getPreprocessorOpts().DisableStatCache,
 237                                 DeserialListener);
 238       if (!CI.getASTContext().getExternalSource())
 239         goto failure;
 240     }
 241
 242     CI.setASTConsumer(Consumer.take());
 243     if (!CI.hasASTConsumer())
 244       goto failure;
 245   }
 246
 247   // Initialize builtin info as long as we aren't using an external AST
 248   // source.
 249   if (!CI.hasASTContext() || !CI.getASTContext().getExternalSource()) {
 250     Preprocessor &PP = CI.getPreprocessor();
 251     PP.getBuiltinInfo().InitializeBuiltins(PP.getIdentifierTable(),
 252                                            PP.getLangOptions());
 253   }
 254
 255   return true;
 256
 257   // If we failed, reset state since the client will not end up calling the
 258   // matching EndSourceFile().
 259   failure:
 260   if (isCurrentFileAST()) {
 261     CI.setASTContext(0);
 262     CI.setPreprocessor(0);
 263     CI.setSourceManager(0);
 264     CI.setFileManager(0);
 265   }
 266
 267   CI.getDiagnosticClient().EndSourceFile();
 268   setCurrentFile("", IK_None);
 269   setCompilerInstance(0);
 270   return false;
 271 }
 272
 273 void FrontendAction::Execute() {
 274   CompilerInstance &CI = getCompilerInstance();
 275
 276   // Initialize the main file entry. This needs to be delayed until after PCH
 277   // has loaded.
 278   if (isCurrentFileAST()) {
 279     // Set the main file ID to an empty file.
 280     //
 281     // FIXME: We probably shouldn't need this, but for now this is the
 282     // simplest way to reuse the logic in ParseAST.
 283     const char *EmptyStr = "";
 284     llvm::MemoryBuffer *SB =
 285       llvm::MemoryBuffer::getMemBuffer(EmptyStr, "<dummy input>");
 286     CI.getSourceManager().createMainFileIDForMemBuffer(SB);
 287   } else {
 288     if (!CI.InitializeSourceManager(getCurrentFile()))
 289       return;
 290   }
 291
 292   if (CI.hasFrontendTimer()) {
 293     llvm::TimeRegion Timer(CI.getFrontendTimer());
 294     ExecuteAction();
 295   }
 296   else ExecuteAction();
 297 }
 298
 299 void FrontendAction::EndSourceFile() {
 300   CompilerInstance &CI = getCompilerInstance();
 301
 302   // Inform the diagnostic client we are done with this source file.
 303   CI.getDiagnosticClient().EndSourceFile();
 304
 305   // Finalize the action.
 306   EndSourceFileAction();
 307
 308   // Release the consumer and the AST, in that order since the consumer may
 309   // perform actions in its destructor which require the context.
 310   //
 311   // FIXME: There is more per-file stuff we could just drop here?
 312   if (CI.getFrontendOpts().DisableFree) {
 313     CI.takeASTConsumer();
 314     if (!isCurrentFileAST()) {
 315       CI.takeSema();
 316       CI.resetAndLeakASTContext();
 317     }
 318   } else {
 319     if (!isCurrentFileAST()) {
 320       CI.setSema(0);
 321       CI.setASTContext(0);
 322     }
 323     CI.setASTConsumer(0);
 324   }
 325
 326   // Inform the preprocessor we are done.
 327   if (CI.hasPreprocessor())
 328     CI.getPreprocessor().EndSourceFile();
 329
 330   if (CI.getFrontendOpts().ShowStats) {
 331     llvm::errs() << "\nSTATISTICS FOR '" << getCurrentFile() << "':\n";
 332     CI.getPreprocessor().PrintStats();
 333     CI.getPreprocessor().getIdentifierTable().PrintStats();
 334     CI.getPreprocessor().getHeaderSearchInfo().PrintStats();
 335     CI.getSourceManager().PrintStats();
 336     llvm::errs() << "\n";
 337   }
 338
 339   // Cleanup the output streams, and erase the output files if we encountered
 340   // an error.
 341   CI.clearOutputFiles(/*EraseFiles=*/CI.getDiagnostics().hasErrorOccurred());
 342
 343   if (isCurrentFileAST()) {
 344     CI.takeSema();
 345     CI.resetAndLeakASTContext();
 346     CI.resetAndLeakPreprocessor();
 347     CI.resetAndLeakSourceManager();
 348     CI.resetAndLeakFileManager();
 349   }
 350
 351   setCompilerInstance(0);
 352   setCurrentFile("", IK_None);
 353 }
 354
 355 //===----------------------------------------------------------------------===//
 356 // Utility Actions
 357 //===----------------------------------------------------------------------===//
 358
 359 void ASTFrontendAction::ExecuteAction() {
 360   CompilerInstance &CI = getCompilerInstance();
 361
 362   // FIXME: Move the truncation aspect of this into Sema, we delayed this till
 363   // here so the source manager would be initialized.
 364   if (hasCodeCompletionSupport() &&
 365       !CI.getFrontendOpts().CodeCompletionAt.FileName.empty())
 366     CI.createCodeCompletionConsumer();
 367
 368   // Use a code completion consumer?
 369   CodeCompleteConsumer *CompletionConsumer = 0;
 370   if (CI.hasCodeCompletionConsumer())
 371     CompletionConsumer = &CI.getCodeCompletionConsumer();
 372
 373   if (!CI.hasSema())
 374     CI.createSema(usesCompleteTranslationUnit(), CompletionConsumer);
 375
 376   ParseAST(CI.getSema(), CI.getFrontendOpts().ShowStats);
 377 }
 378
 379 ASTConsumer *
 380 PreprocessorFrontendAction::CreateASTConsumer(CompilerInstance &CI,
 381                                               llvm::StringRef InFile) {
 382   llvm_unreachable("Invalid CreateASTConsumer on preprocessor action!");
 383 }