FrontendAction.cpp revision 5f9e272e632e951b1efe824cd16acb4d96077930 
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"
28using namespace clang;
29
30namespace {
31
32/// \brief Dumps deserialized declarations.
33class DeserializedDeclsDumper : public ASTDeserializationListener {
34  ASTDeserializationListener *Previous;
35
36public:
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
81FrontendAction::FrontendAction() : Instance(0) {}
82
83FrontendAction::~FrontendAction() {}
84
85void FrontendAction::setCurrentFile(StringRef Value, InputKind Kind,
86                                    ASTUnit *AST) {
87  CurrentFile = Value;
88  CurrentFileKind = Kind;
89  CurrentASTUnit.reset(AST);
90}
91
92ASTConsumer* FrontendAction::CreateWrappedASTConsumer(CompilerInstance &CI,
93                                                      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
125bool FrontendAction::BeginSourceFile(CompilerInstance &CI,
126                                     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  if (!BeginInvocation(CI))
134    goto failure;
135
136  // AST files follow a very different path, since they share objects via the
137  // AST unit.
138  if (InputKind == IK_AST) {
139    assert(!usesPreprocessorOnly() &&
140           "Attempt to pass AST file to preprocessor only action!");
141    assert(hasASTFileSupport() &&
142           "This action does not have AST file support!");
143
144    llvm::IntrusiveRefCntPtr<Diagnostic> Diags(&CI.getDiagnostics());
145    std::string Error;
146    ASTUnit *AST = ASTUnit::LoadFromASTFile(Filename, Diags,
147                                            CI.getFileSystemOpts());
148    if (!AST)
149      goto failure;
150
151    setCurrentFile(Filename, InputKind, AST);
152
153    // Set the shared objects, these are reset when we finish processing the
154    // file, otherwise the CompilerInstance will happily destroy them.
155    CI.setFileManager(&AST->getFileManager());
156    CI.setSourceManager(&AST->getSourceManager());
157    CI.setPreprocessor(&AST->getPreprocessor());
158    CI.setASTContext(&AST->getASTContext());
159
160    // Initialize the action.
161    if (!BeginSourceFileAction(CI, Filename))
162      goto failure;
163
164    /// Create the AST consumer.
165    CI.setASTConsumer(CreateWrappedASTConsumer(CI, Filename));
166    if (!CI.hasASTConsumer())
167      goto failure;
168
169    return true;
170  }
171
172  // Set up the file and source managers, if needed.
173  if (!CI.hasFileManager())
174    CI.createFileManager();
175  if (!CI.hasSourceManager())
176    CI.createSourceManager(CI.getFileManager());
177
178  // IR files bypass the rest of initialization.
179  if (InputKind == IK_LLVM_IR) {
180    assert(hasIRSupport() &&
181           "This action does not have IR file support!");
182
183    // Inform the diagnostic client we are processing a source file.
184    CI.getDiagnosticClient().BeginSourceFile(CI.getLangOpts(), 0);
185
186    // Initialize the action.
187    if (!BeginSourceFileAction(CI, Filename))
188      goto failure;
189
190    return true;
191  }
192
193  // Set up the preprocessor.
194  CI.createPreprocessor();
195
196  // Inform the diagnostic client we are processing a source file.
197  CI.getDiagnosticClient().BeginSourceFile(CI.getLangOpts(),
198                                           &CI.getPreprocessor());
199
200  // Initialize the action.
201  if (!BeginSourceFileAction(CI, Filename))
202    goto failure;
203
204  /// Create the AST context and consumer unless this is a preprocessor only
205  /// action.
206  if (!usesPreprocessorOnly()) {
207    CI.createASTContext();
208
209    llvm::OwningPtr<ASTConsumer> Consumer(
210        CreateWrappedASTConsumer(CI, Filename));
211    if (!Consumer)
212      goto failure;
213
214    CI.getASTContext().setASTMutationListener(Consumer->GetASTMutationListener());
215
216    if (!CI.getPreprocessorOpts().ChainedIncludes.empty()) {
217      // Convert headers to PCH and chain them.
218      llvm::OwningPtr<ExternalASTSource> source;
219      source.reset(ChainedIncludesSource::create(CI));
220      if (!source)
221        goto failure;
222      CI.getASTContext().setExternalSource(source);
223
224    } else if (!CI.getPreprocessorOpts().ImplicitPCHInclude.empty()) {
225      // Use PCH.
226      assert(hasPCHSupport() && "This action does not have PCH support!");
227      ASTDeserializationListener *DeserialListener =
228          Consumer->GetASTDeserializationListener();
229      if (CI.getPreprocessorOpts().DumpDeserializedPCHDecls)
230        DeserialListener = new DeserializedDeclsDumper(DeserialListener);
231      if (!CI.getPreprocessorOpts().DeserializedPCHDeclsToErrorOn.empty())
232        DeserialListener = new DeserializedDeclsChecker(CI.getASTContext(),
233                         CI.getPreprocessorOpts().DeserializedPCHDeclsToErrorOn,
234                                                        DeserialListener);
235      CI.createPCHExternalASTSource(
236                                CI.getPreprocessorOpts().ImplicitPCHInclude,
237                                CI.getPreprocessorOpts().DisablePCHValidation,
238                                CI.getPreprocessorOpts().DisableStatCache,
239                                DeserialListener);
240      if (!CI.getASTContext().getExternalSource())
241        goto failure;
242    }
243
244    CI.setASTConsumer(Consumer.take());
245    if (!CI.hasASTConsumer())
246      goto failure;
247  }
248
249  // Initialize builtin info as long as we aren't using an external AST
250  // source.
251  if (!CI.hasASTContext() || !CI.getASTContext().getExternalSource()) {
252    Preprocessor &PP = CI.getPreprocessor();
253    PP.getBuiltinInfo().InitializeBuiltins(PP.getIdentifierTable(),
254                                           PP.getLangOptions());
255  }
256
257  return true;
258
259  // If we failed, reset state since the client will not end up calling the
260  // matching EndSourceFile().
261  failure:
262  if (isCurrentFileAST()) {
263    CI.setASTContext(0);
264    CI.setPreprocessor(0);
265    CI.setSourceManager(0);
266    CI.setFileManager(0);
267  }
268
269  CI.getDiagnosticClient().EndSourceFile();
270  setCurrentFile("", IK_None);
271  setCompilerInstance(0);
272  return false;
273}
274
275void FrontendAction::Execute() {
276  CompilerInstance &CI = getCompilerInstance();
277
278  // Initialize the main file entry. This needs to be delayed until after PCH
279  // has loaded.
280  if (isCurrentFileAST()) {
281    // Set the main file ID to an empty file.
282    //
283    // FIXME: We probably shouldn't need this, but for now this is the
284    // simplest way to reuse the logic in ParseAST.
285    const char *EmptyStr = "";
286    llvm::MemoryBuffer *SB =
287      llvm::MemoryBuffer::getMemBuffer(EmptyStr, "<dummy input>");
288    CI.getSourceManager().createMainFileIDForMemBuffer(SB);
289  } else {
290    if (!CI.InitializeSourceManager(getCurrentFile()))
291      return;
292  }
293
294  if (CI.hasFrontendTimer()) {
295    llvm::TimeRegion Timer(CI.getFrontendTimer());
296    ExecuteAction();
297  }
298  else ExecuteAction();
299}
300
301void FrontendAction::EndSourceFile() {
302  CompilerInstance &CI = getCompilerInstance();
303
304  // Inform the diagnostic client we are done with this source file.
305  CI.getDiagnosticClient().EndSourceFile();
306
307  // Finalize the action.
308  EndSourceFileAction();
309
310  // Release the consumer and the AST, in that order since the consumer may
311  // perform actions in its destructor which require the context.
312  //
313  // FIXME: There is more per-file stuff we could just drop here?
314  if (CI.getFrontendOpts().DisableFree) {
315    CI.takeASTConsumer();
316    if (!isCurrentFileAST()) {
317      CI.takeSema();
318      CI.resetAndLeakASTContext();
319    }
320  } else {
321    if (!isCurrentFileAST()) {
322      CI.setSema(0);
323      CI.setASTContext(0);
324    }
325    CI.setASTConsumer(0);
326  }
327
328  // Inform the preprocessor we are done.
329  if (CI.hasPreprocessor())
330    CI.getPreprocessor().EndSourceFile();
331
332  if (CI.getFrontendOpts().ShowStats) {
333    llvm::errs() << "\nSTATISTICS FOR '" << getCurrentFile() << "':\n";
334    CI.getPreprocessor().PrintStats();
335    CI.getPreprocessor().getIdentifierTable().PrintStats();
336    CI.getPreprocessor().getHeaderSearchInfo().PrintStats();
337    CI.getSourceManager().PrintStats();
338    llvm::errs() << "\n";
339  }
340
341  // Cleanup the output streams, and erase the output files if we encountered
342  // an error.
343  CI.clearOutputFiles(/*EraseFiles=*/CI.getDiagnostics().hasErrorOccurred());
344
345  if (isCurrentFileAST()) {
346    CI.takeSema();
347    CI.resetAndLeakASTContext();
348    CI.resetAndLeakPreprocessor();
349    CI.resetAndLeakSourceManager();
350    CI.resetAndLeakFileManager();
351  }
352
353  setCompilerInstance(0);
354  setCurrentFile("", IK_None);
355}
356
357//===----------------------------------------------------------------------===//
358// Utility Actions
359//===----------------------------------------------------------------------===//
360
361void ASTFrontendAction::ExecuteAction() {
362  CompilerInstance &CI = getCompilerInstance();
363
364  // FIXME: Move the truncation aspect of this into Sema, we delayed this till
365  // here so the source manager would be initialized.
366  if (hasCodeCompletionSupport() &&
367      !CI.getFrontendOpts().CodeCompletionAt.FileName.empty())
368    CI.createCodeCompletionConsumer();
369
370  // Use a code completion consumer?
371  CodeCompleteConsumer *CompletionConsumer = 0;
372  if (CI.hasCodeCompletionConsumer())
373    CompletionConsumer = &CI.getCodeCompletionConsumer();
374
375  if (!CI.hasSema())
376    CI.createSema(usesCompleteTranslationUnit(), CompletionConsumer);
377
378  ParseAST(CI.getSema(), CI.getFrontendOpts().ShowStats);
379}
380
381ASTConsumer *
382PreprocessorFrontendAction::CreateASTConsumer(CompilerInstance &CI,
383                                              StringRef InFile) {
384  llvm_unreachable("Invalid CreateASTConsumer on preprocessor action!");
385}
386
387ASTConsumer *WrapperFrontendAction::CreateASTConsumer(CompilerInstance &CI,
388                                                      StringRef InFile) {
389  return WrappedAction->CreateASTConsumer(CI, InFile);
390}
391bool WrapperFrontendAction::BeginInvocation(CompilerInstance &CI) {
392  return WrappedAction->BeginInvocation(CI);
393}
394bool WrapperFrontendAction::BeginSourceFileAction(CompilerInstance &CI,
395                                                  StringRef Filename) {
396  WrappedAction->setCurrentFile(getCurrentFile(), getCurrentFileKind());
397  WrappedAction->setCompilerInstance(&CI);
398  return WrappedAction->BeginSourceFileAction(CI, Filename);
399}
400void WrapperFrontendAction::ExecuteAction() {
401  WrappedAction->ExecuteAction();
402}
403void WrapperFrontendAction::EndSourceFileAction() {
404  WrappedAction->EndSourceFileAction();
405}
406
407bool WrapperFrontendAction::usesPreprocessorOnly() const {
408  return WrappedAction->usesPreprocessorOnly();
409}
410bool WrapperFrontendAction::usesCompleteTranslationUnit() {
411  return WrappedAction->usesCompleteTranslationUnit();
412}
413bool WrapperFrontendAction::hasPCHSupport() const {
414  return WrappedAction->hasPCHSupport();
415}
416bool WrapperFrontendAction::hasASTFileSupport() const {
417  return WrappedAction->hasASTFileSupport();
418}
419bool WrapperFrontendAction::hasIRSupport() const {
420  return WrappedAction->hasIRSupport();
421}
422bool WrapperFrontendAction::hasCodeCompletionSupport() const {
423  return WrappedAction->hasCodeCompletionSupport();
424}
425
426WrapperFrontendAction::WrapperFrontendAction(FrontendAction *WrappedAction)
427  : WrappedAction(WrappedAction) {}
428
429