CompilerInstance.cpp revision 2056048f0f619adadc9a5416a2c4cdf95c58eef7 
1//===--- CompilerInstance.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/CompilerInstance.h"
11#include "clang/AST/ASTConsumer.h"
12#include "clang/AST/ASTContext.h"
13#include "clang/Basic/Diagnostic.h"
14#include "clang/Basic/FileManager.h"
15#include "clang/Basic/SourceManager.h"
16#include "clang/Basic/TargetInfo.h"
17#include "clang/Basic/Version.h"
18#include "clang/Lex/HeaderSearch.h"
19#include "clang/Lex/Preprocessor.h"
20#include "clang/Lex/PTHManager.h"
21#include "clang/Frontend/ChainedDiagnosticClient.h"
22#include "clang/Frontend/FrontendAction.h"
23#include "clang/Frontend/PCHReader.h"
24#include "clang/Frontend/FrontendDiagnostic.h"
25#include "clang/Frontend/TextDiagnosticPrinter.h"
26#include "clang/Frontend/VerifyDiagnosticsClient.h"
27#include "clang/Frontend/Utils.h"
28#include "clang/Sema/CodeCompleteConsumer.h"
29#include "llvm/LLVMContext.h"
30#include "llvm/Support/MemoryBuffer.h"
31#include "llvm/Support/raw_ostream.h"
32#include "llvm/ADT/Statistic.h"
33#include "llvm/Support/Timer.h"
34#include "llvm/System/Host.h"
35#include "llvm/System/Path.h"
36#include "llvm/System/Program.h"
37using namespace clang;
38
39CompilerInstance::CompilerInstance()
40  : Invocation(new CompilerInvocation()) {
41}
42
43CompilerInstance::~CompilerInstance() {
44}
45
46void CompilerInstance::setLLVMContext(llvm::LLVMContext *Value) {
47  LLVMContext.reset(Value);
48}
49
50void CompilerInstance::setInvocation(CompilerInvocation *Value) {
51  Invocation.reset(Value);
52}
53
54void CompilerInstance::setDiagnostics(Diagnostic *Value) {
55  Diagnostics = Value;
56}
57
58void CompilerInstance::setDiagnosticClient(DiagnosticClient *Value) {
59  DiagClient.reset(Value);
60}
61
62void CompilerInstance::setTarget(TargetInfo *Value) {
63  Target.reset(Value);
64}
65
66void CompilerInstance::setFileManager(FileManager *Value) {
67  FileMgr.reset(Value);
68}
69
70void CompilerInstance::setSourceManager(SourceManager *Value) {
71  SourceMgr.reset(Value);
72}
73
74void CompilerInstance::setPreprocessor(Preprocessor *Value) {
75  PP.reset(Value);
76}
77
78void CompilerInstance::setASTContext(ASTContext *Value) {
79  Context.reset(Value);
80}
81
82void CompilerInstance::setASTConsumer(ASTConsumer *Value) {
83  Consumer.reset(Value);
84}
85
86void CompilerInstance::setCodeCompletionConsumer(CodeCompleteConsumer *Value) {
87  CompletionConsumer.reset(Value);
88}
89
90// Diagnostics
91namespace {
92  class BinaryDiagnosticSerializer : public DiagnosticClient {
93    llvm::raw_ostream &OS;
94    SourceManager *SourceMgr;
95  public:
96    explicit BinaryDiagnosticSerializer(llvm::raw_ostream &OS)
97      : OS(OS), SourceMgr(0) { }
98
99    virtual void HandleDiagnostic(Diagnostic::Level DiagLevel,
100                                  const DiagnosticInfo &Info);
101  };
102}
103
104void BinaryDiagnosticSerializer::HandleDiagnostic(Diagnostic::Level DiagLevel,
105                                                  const DiagnosticInfo &Info) {
106  StoredDiagnostic(DiagLevel, Info).Serialize(OS);
107}
108
109static void SetUpBuildDumpLog(const DiagnosticOptions &DiagOpts,
110                              unsigned argc, char **argv,
111                              Diagnostic &Diags) {
112  std::string ErrorInfo;
113  llvm::OwningPtr<llvm::raw_ostream> OS(
114    new llvm::raw_fd_ostream(DiagOpts.DumpBuildInformation.c_str(), ErrorInfo));
115  if (!ErrorInfo.empty()) {
116    Diags.Report(diag::err_fe_unable_to_open_logfile)
117                 << DiagOpts.DumpBuildInformation << ErrorInfo;
118    return;
119  }
120
121  (*OS) << "clang -cc1 command line arguments: ";
122  for (unsigned i = 0; i != argc; ++i)
123    (*OS) << argv[i] << ' ';
124  (*OS) << '\n';
125
126  // Chain in a diagnostic client which will log the diagnostics.
127  DiagnosticClient *Logger =
128    new TextDiagnosticPrinter(*OS.take(), DiagOpts, /*OwnsOutputStream=*/true);
129  Diags.setClient(new ChainedDiagnosticClient(Diags.getClient(), Logger));
130}
131
132void CompilerInstance::createDiagnostics(int Argc, char **Argv) {
133  Diagnostics = createDiagnostics(getDiagnosticOpts(), Argc, Argv);
134
135  if (Diagnostics)
136    DiagClient.reset(Diagnostics->getClient());
137}
138
139llvm::IntrusiveRefCntPtr<Diagnostic>
140CompilerInstance::createDiagnostics(const DiagnosticOptions &Opts,
141                                    int Argc, char **Argv) {
142  llvm::IntrusiveRefCntPtr<Diagnostic> Diags(new Diagnostic());
143
144  // Create the diagnostic client for reporting errors or for
145  // implementing -verify.
146  llvm::OwningPtr<DiagnosticClient> DiagClient;
147  if (Opts.BinaryOutput) {
148    if (llvm::sys::Program::ChangeStderrToBinary()) {
149      // We weren't able to set standard error to binary, which is a
150      // bit of a problem. So, just create a text diagnostic printer
151      // to complain about this problem, and pretend that the user
152      // didn't try to use binary output.
153      DiagClient.reset(new TextDiagnosticPrinter(llvm::errs(), Opts));
154      Diags->setClient(DiagClient.take());
155      Diags->Report(diag::err_fe_stderr_binary);
156      return Diags;
157    } else {
158      DiagClient.reset(new BinaryDiagnosticSerializer(llvm::errs()));
159    }
160  } else {
161    DiagClient.reset(new TextDiagnosticPrinter(llvm::errs(), Opts));
162  }
163
164  // Chain in -verify checker, if requested.
165  if (Opts.VerifyDiagnostics)
166    DiagClient.reset(new VerifyDiagnosticsClient(*Diags, DiagClient.take()));
167
168  Diags->setClient(DiagClient.take());
169  if (!Opts.DumpBuildInformation.empty())
170    SetUpBuildDumpLog(Opts, Argc, Argv, *Diags);
171
172  // Configure our handling of diagnostics.
173  ProcessWarningOptions(*Diags, Opts);
174
175  return Diags;
176}
177
178// File Manager
179
180void CompilerInstance::createFileManager() {
181  FileMgr.reset(new FileManager());
182}
183
184// Source Manager
185
186void CompilerInstance::createSourceManager() {
187  SourceMgr.reset(new SourceManager(getDiagnostics()));
188}
189
190// Preprocessor
191
192void CompilerInstance::createPreprocessor() {
193  PP.reset(createPreprocessor(getDiagnostics(), getLangOpts(),
194                              getPreprocessorOpts(), getHeaderSearchOpts(),
195                              getDependencyOutputOpts(), getTarget(),
196                              getFrontendOpts(), getSourceManager(),
197                              getFileManager()));
198}
199
200Preprocessor *
201CompilerInstance::createPreprocessor(Diagnostic &Diags,
202                                     const LangOptions &LangInfo,
203                                     const PreprocessorOptions &PPOpts,
204                                     const HeaderSearchOptions &HSOpts,
205                                     const DependencyOutputOptions &DepOpts,
206                                     const TargetInfo &Target,
207                                     const FrontendOptions &FEOpts,
208                                     SourceManager &SourceMgr,
209                                     FileManager &FileMgr) {
210  // Create a PTH manager if we are using some form of a token cache.
211  PTHManager *PTHMgr = 0;
212  if (!PPOpts.TokenCache.empty())
213    PTHMgr = PTHManager::Create(PPOpts.TokenCache, Diags);
214
215  // Create the Preprocessor.
216  HeaderSearch *HeaderInfo = new HeaderSearch(FileMgr);
217  Preprocessor *PP = new Preprocessor(Diags, LangInfo, Target,
218                                      SourceMgr, *HeaderInfo, PTHMgr,
219                                      /*OwnsHeaderSearch=*/true);
220
221  // Note that this is different then passing PTHMgr to Preprocessor's ctor.
222  // That argument is used as the IdentifierInfoLookup argument to
223  // IdentifierTable's ctor.
224  if (PTHMgr) {
225    PTHMgr->setPreprocessor(PP);
226    PP->setPTHManager(PTHMgr);
227  }
228
229  if (PPOpts.DetailedRecord)
230    PP->createPreprocessingRecord();
231
232  InitializePreprocessor(*PP, PPOpts, HSOpts, FEOpts);
233
234  // Handle generating dependencies, if requested.
235  if (!DepOpts.OutputFile.empty())
236    AttachDependencyFileGen(*PP, DepOpts);
237
238  return PP;
239}
240
241// ASTContext
242
243void CompilerInstance::createASTContext() {
244  Preprocessor &PP = getPreprocessor();
245  Context.reset(new ASTContext(getLangOpts(), PP.getSourceManager(),
246                               getTarget(), PP.getIdentifierTable(),
247                               PP.getSelectorTable(), PP.getBuiltinInfo(),
248                               /*FreeMemory=*/ !getFrontendOpts().DisableFree,
249                               /*size_reserve=*/ 0));
250}
251
252// ExternalASTSource
253
254void CompilerInstance::createPCHExternalASTSource(llvm::StringRef Path) {
255  llvm::OwningPtr<ExternalASTSource> Source;
256  Source.reset(createPCHExternalASTSource(Path, getHeaderSearchOpts().Sysroot,
257                                          getPreprocessor(), getASTContext()));
258  getASTContext().setExternalSource(Source);
259}
260
261ExternalASTSource *
262CompilerInstance::createPCHExternalASTSource(llvm::StringRef Path,
263                                             const std::string &Sysroot,
264                                             Preprocessor &PP,
265                                             ASTContext &Context) {
266  llvm::OwningPtr<PCHReader> Reader;
267  Reader.reset(new PCHReader(PP, &Context,
268                             Sysroot.empty() ? 0 : Sysroot.c_str()));
269
270  switch (Reader->ReadPCH(Path)) {
271  case PCHReader::Success:
272    // Set the predefines buffer as suggested by the PCH reader. Typically, the
273    // predefines buffer will be empty.
274    PP.setPredefines(Reader->getSuggestedPredefines());
275    return Reader.take();
276
277  case PCHReader::Failure:
278    // Unrecoverable failure: don't even try to process the input file.
279    break;
280
281  case PCHReader::IgnorePCH:
282    // No suitable PCH file could be found. Return an error.
283    break;
284  }
285
286  return 0;
287}
288
289// Code Completion
290
291void CompilerInstance::createCodeCompletionConsumer() {
292  const ParsedSourceLocation &Loc = getFrontendOpts().CodeCompletionAt;
293  CompletionConsumer.reset(
294    createCodeCompletionConsumer(getPreprocessor(),
295                                 Loc.FileName, Loc.Line, Loc.Column,
296                                 getFrontendOpts().DebugCodeCompletionPrinter,
297                                 getFrontendOpts().ShowMacrosInCodeCompletion,
298                             getFrontendOpts().ShowCodePatternsInCodeCompletion,
299                                 llvm::outs()));
300  if (!CompletionConsumer)
301    return;
302
303  if (CompletionConsumer->isOutputBinary() &&
304      llvm::sys::Program::ChangeStdoutToBinary()) {
305    getPreprocessor().getDiagnostics().Report(diag::err_fe_stdout_binary);
306    CompletionConsumer.reset();
307  }
308}
309
310void CompilerInstance::createFrontendTimer() {
311  FrontendTimer.reset(new llvm::Timer("Clang front-end timer"));
312}
313
314CodeCompleteConsumer *
315CompilerInstance::createCodeCompletionConsumer(Preprocessor &PP,
316                                               const std::string &Filename,
317                                               unsigned Line,
318                                               unsigned Column,
319                                               bool UseDebugPrinter,
320                                               bool ShowMacros,
321                                               bool ShowCodePatterns,
322                                               llvm::raw_ostream &OS) {
323  // Tell the source manager to chop off the given file at a specific
324  // line and column.
325  const FileEntry *Entry = PP.getFileManager().getFile(Filename);
326  if (!Entry) {
327    PP.getDiagnostics().Report(diag::err_fe_invalid_code_complete_file)
328      << Filename;
329    return 0;
330  }
331
332  // Truncate the named file at the given line/column.
333  PP.SetCodeCompletionPoint(Entry, Line, Column);
334
335  // Set up the creation routine for code-completion.
336  if (UseDebugPrinter)
337    return new PrintingCodeCompleteConsumer(ShowMacros, ShowCodePatterns, OS);
338  else
339    return new CIndexCodeCompleteConsumer(ShowMacros, ShowCodePatterns, OS);
340}
341
342// Output Files
343
344void CompilerInstance::addOutputFile(llvm::StringRef Path,
345                                     llvm::raw_ostream *OS) {
346  assert(OS && "Attempt to add empty stream to output list!");
347  OutputFiles.push_back(std::make_pair(Path, OS));
348}
349
350void CompilerInstance::clearOutputFiles(bool EraseFiles) {
351  for (std::list< std::pair<std::string, llvm::raw_ostream*> >::iterator
352         it = OutputFiles.begin(), ie = OutputFiles.end(); it != ie; ++it) {
353    delete it->second;
354    if (EraseFiles && !it->first.empty())
355      llvm::sys::Path(it->first).eraseFromDisk();
356  }
357  OutputFiles.clear();
358}
359
360llvm::raw_fd_ostream *
361CompilerInstance::createDefaultOutputFile(bool Binary,
362                                          llvm::StringRef InFile,
363                                          llvm::StringRef Extension) {
364  return createOutputFile(getFrontendOpts().OutputFile, Binary,
365                          InFile, Extension);
366}
367
368llvm::raw_fd_ostream *
369CompilerInstance::createOutputFile(llvm::StringRef OutputPath,
370                                   bool Binary,
371                                   llvm::StringRef InFile,
372                                   llvm::StringRef Extension) {
373  std::string Error, OutputPathName;
374  llvm::raw_fd_ostream *OS = createOutputFile(OutputPath, Error, Binary,
375                                              InFile, Extension,
376                                              &OutputPathName);
377  if (!OS) {
378    getDiagnostics().Report(diag::err_fe_unable_to_open_output)
379      << OutputPath << Error;
380    return 0;
381  }
382
383  // Add the output file -- but don't try to remove "-", since this means we are
384  // using stdin.
385  addOutputFile((OutputPathName != "-") ? OutputPathName : "", OS);
386
387  return OS;
388}
389
390llvm::raw_fd_ostream *
391CompilerInstance::createOutputFile(llvm::StringRef OutputPath,
392                                   std::string &Error,
393                                   bool Binary,
394                                   llvm::StringRef InFile,
395                                   llvm::StringRef Extension,
396                                   std::string *ResultPathName) {
397  std::string OutFile;
398  if (!OutputPath.empty()) {
399    OutFile = OutputPath;
400  } else if (InFile == "-") {
401    OutFile = "-";
402  } else if (!Extension.empty()) {
403    llvm::sys::Path Path(InFile);
404    Path.eraseSuffix();
405    Path.appendSuffix(Extension);
406    OutFile = Path.str();
407  } else {
408    OutFile = "-";
409  }
410
411  llvm::OwningPtr<llvm::raw_fd_ostream> OS(
412    new llvm::raw_fd_ostream(OutFile.c_str(), Error,
413                             (Binary ? llvm::raw_fd_ostream::F_Binary : 0)));
414  if (!Error.empty())
415    return 0;
416
417  if (ResultPathName)
418    *ResultPathName = OutFile;
419
420  return OS.take();
421}
422
423// Initialization Utilities
424
425bool CompilerInstance::InitializeSourceManager(llvm::StringRef InputFile) {
426  return InitializeSourceManager(InputFile, getDiagnostics(), getFileManager(),
427                                 getSourceManager(), getFrontendOpts());
428}
429
430bool CompilerInstance::InitializeSourceManager(llvm::StringRef InputFile,
431                                               Diagnostic &Diags,
432                                               FileManager &FileMgr,
433                                               SourceManager &SourceMgr,
434                                               const FrontendOptions &Opts) {
435  // Figure out where to get and map in the main file.
436  if (InputFile != "-") {
437    const FileEntry *File = FileMgr.getFile(InputFile);
438    if (File) SourceMgr.createMainFileID(File, SourceLocation());
439    if (SourceMgr.getMainFileID().isInvalid()) {
440      Diags.Report(diag::err_fe_error_reading) << InputFile;
441      return false;
442    }
443  } else {
444    llvm::MemoryBuffer *SB = llvm::MemoryBuffer::getSTDIN();
445    if (SB) SourceMgr.createMainFileIDForMemBuffer(SB);
446    if (SourceMgr.getMainFileID().isInvalid()) {
447      Diags.Report(diag::err_fe_error_reading_stdin);
448      return false;
449    }
450  }
451
452  return true;
453}
454
455// High-Level Operations
456
457bool CompilerInstance::ExecuteAction(FrontendAction &Act) {
458  assert(hasDiagnostics() && "Diagnostics engine is not initialized!");
459  assert(!getFrontendOpts().ShowHelp && "Client must handle '-help'!");
460  assert(!getFrontendOpts().ShowVersion && "Client must handle '-version'!");
461
462  // FIXME: Take this as an argument, once all the APIs we used have moved to
463  // taking it as an input instead of hard-coding llvm::errs.
464  llvm::raw_ostream &OS = llvm::errs();
465
466  // Create the target instance.
467  setTarget(TargetInfo::CreateTargetInfo(getDiagnostics(), getTargetOpts()));
468  if (!hasTarget())
469    return false;
470
471  // Inform the target of the language options.
472  //
473  // FIXME: We shouldn't need to do this, the target should be immutable once
474  // created. This complexity should be lifted elsewhere.
475  getTarget().setForcedLangOptions(getLangOpts());
476
477  // Validate/process some options.
478  if (getHeaderSearchOpts().Verbose)
479    OS << "clang -cc1 version " CLANG_VERSION_STRING
480       << " based upon " << PACKAGE_STRING
481       << " hosted on " << llvm::sys::getHostTriple() << "\n";
482
483  if (getFrontendOpts().ShowTimers)
484    createFrontendTimer();
485
486  if (getFrontendOpts().ShowStats)
487    llvm::EnableStatistics();
488
489  for (unsigned i = 0, e = getFrontendOpts().Inputs.size(); i != e; ++i) {
490    const std::string &InFile = getFrontendOpts().Inputs[i].second;
491
492    // Reset the ID tables if we are reusing the SourceManager.
493    if (hasSourceManager())
494      getSourceManager().clearIDTables();
495
496    if (Act.BeginSourceFile(*this, InFile, getFrontendOpts().Inputs[i].first)) {
497      Act.Execute();
498      Act.EndSourceFile();
499    }
500  }
501
502  if (getDiagnosticOpts().ShowCarets) {
503    unsigned NumWarnings = getDiagnostics().getNumWarnings();
504    unsigned NumErrors = getDiagnostics().getNumErrors() -
505                               getDiagnostics().getNumErrorsSuppressed();
506
507    if (NumWarnings)
508      OS << NumWarnings << " warning" << (NumWarnings == 1 ? "" : "s");
509    if (NumWarnings && NumErrors)
510      OS << " and ";
511    if (NumErrors)
512      OS << NumErrors << " error" << (NumErrors == 1 ? "" : "s");
513    if (NumWarnings || NumErrors)
514      OS << " generated.\n";
515  }
516
517  if (getFrontendOpts().ShowStats && hasFileManager()) {
518    getFileManager().PrintStats();
519    OS << "\n";
520  }
521
522  // Return the appropriate status when verifying diagnostics.
523  //
524  // FIXME: If we could make getNumErrors() do the right thing, we wouldn't need
525  // this.
526  if (getDiagnosticOpts().VerifyDiagnostics)
527    return !static_cast<VerifyDiagnosticsClient&>(
528      getDiagnosticClient()).HadErrors();
529
530  return !getDiagnostics().getNumErrors();
531}
532
533
534