CompilerInstance.cpp revision 958bcaf3d4e0c1ae46de3e84e7c2a7638c3c5286 
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/Sema/Sema.h"
12#include "clang/AST/ASTConsumer.h"
13#include "clang/AST/ASTContext.h"
14#include "clang/AST/Decl.h"
15#include "clang/Basic/Diagnostic.h"
16#include "clang/Basic/FileManager.h"
17#include "clang/Basic/SourceManager.h"
18#include "clang/Basic/TargetInfo.h"
19#include "clang/Basic/Version.h"
20#include "clang/Lex/HeaderSearch.h"
21#include "clang/Lex/Preprocessor.h"
22#include "clang/Lex/PTHManager.h"
23#include "clang/Frontend/ChainedDiagnosticConsumer.h"
24#include "clang/Frontend/FrontendAction.h"
25#include "clang/Frontend/FrontendActions.h"
26#include "clang/Frontend/FrontendDiagnostic.h"
27#include "clang/Frontend/LogDiagnosticPrinter.h"
28#include "clang/Frontend/SerializedDiagnosticPrinter.h"
29#include "clang/Frontend/TextDiagnosticPrinter.h"
30#include "clang/Frontend/VerifyDiagnosticConsumer.h"
31#include "clang/Frontend/Utils.h"
32#include "clang/Serialization/ASTReader.h"
33#include "clang/Sema/CodeCompleteConsumer.h"
34#include "llvm/Support/FileSystem.h"
35#include "llvm/Support/MemoryBuffer.h"
36#include "llvm/Support/raw_ostream.h"
37#include "llvm/ADT/Statistic.h"
38#include "llvm/Support/Timer.h"
39#include "llvm/Support/Host.h"
40#include "llvm/Support/LockFileManager.h"
41#include "llvm/Support/Path.h"
42#include "llvm/Support/Program.h"
43#include "llvm/Support/Signals.h"
44#include "llvm/Support/system_error.h"
45#include "llvm/Support/CrashRecoveryContext.h"
46#include "llvm/Config/config.h"
47
48using namespace clang;
49
50CompilerInstance::CompilerInstance()
51  : Invocation(new CompilerInvocation()), ModuleManager(0) {
52}
53
54CompilerInstance::~CompilerInstance() {
55  assert(OutputFiles.empty() && "Still output files in flight?");
56}
57
58void CompilerInstance::setInvocation(CompilerInvocation *Value) {
59  Invocation = Value;
60}
61
62void CompilerInstance::setDiagnostics(DiagnosticsEngine *Value) {
63  Diagnostics = Value;
64}
65
66void CompilerInstance::setTarget(TargetInfo *Value) {
67  Target = Value;
68}
69
70void CompilerInstance::setFileManager(FileManager *Value) {
71  FileMgr = Value;
72}
73
74void CompilerInstance::setSourceManager(SourceManager *Value) {
75  SourceMgr = Value;
76}
77
78void CompilerInstance::setPreprocessor(Preprocessor *Value) { PP = Value; }
79
80void CompilerInstance::setASTContext(ASTContext *Value) { Context = Value; }
81
82void CompilerInstance::setSema(Sema *S) {
83  TheSema.reset(S);
84}
85
86void CompilerInstance::setASTConsumer(ASTConsumer *Value) {
87  Consumer.reset(Value);
88}
89
90void CompilerInstance::setCodeCompletionConsumer(CodeCompleteConsumer *Value) {
91  CompletionConsumer.reset(Value);
92}
93
94// Diagnostics
95static void SetUpBuildDumpLog(DiagnosticOptions *DiagOpts,
96                              unsigned argc, const char* const *argv,
97                              DiagnosticsEngine &Diags) {
98  std::string ErrorInfo;
99  OwningPtr<raw_ostream> OS(
100    new llvm::raw_fd_ostream(DiagOpts->DumpBuildInformation.c_str(),ErrorInfo));
101  if (!ErrorInfo.empty()) {
102    Diags.Report(diag::err_fe_unable_to_open_logfile)
103                 << DiagOpts->DumpBuildInformation << ErrorInfo;
104    return;
105  }
106
107  (*OS) << "clang -cc1 command line arguments: ";
108  for (unsigned i = 0; i != argc; ++i)
109    (*OS) << argv[i] << ' ';
110  (*OS) << '\n';
111
112  // Chain in a diagnostic client which will log the diagnostics.
113  DiagnosticConsumer *Logger =
114    new TextDiagnosticPrinter(*OS.take(), DiagOpts, /*OwnsOutputStream=*/true);
115  Diags.setClient(new ChainedDiagnosticConsumer(Diags.takeClient(), Logger));
116}
117
118static void SetUpDiagnosticLog(DiagnosticOptions *DiagOpts,
119                               const CodeGenOptions *CodeGenOpts,
120                               DiagnosticsEngine &Diags) {
121  std::string ErrorInfo;
122  bool OwnsStream = false;
123  raw_ostream *OS = &llvm::errs();
124  if (DiagOpts->DiagnosticLogFile != "-") {
125    // Create the output stream.
126    llvm::raw_fd_ostream *FileOS(
127      new llvm::raw_fd_ostream(DiagOpts->DiagnosticLogFile.c_str(),
128                               ErrorInfo, llvm::raw_fd_ostream::F_Append));
129    if (!ErrorInfo.empty()) {
130      Diags.Report(diag::warn_fe_cc_log_diagnostics_failure)
131        << DiagOpts->DumpBuildInformation << ErrorInfo;
132    } else {
133      FileOS->SetUnbuffered();
134      FileOS->SetUseAtomicWrites(true);
135      OS = FileOS;
136      OwnsStream = true;
137    }
138  }
139
140  // Chain in the diagnostic client which will log the diagnostics.
141  LogDiagnosticPrinter *Logger = new LogDiagnosticPrinter(*OS, DiagOpts,
142                                                          OwnsStream);
143  if (CodeGenOpts)
144    Logger->setDwarfDebugFlags(CodeGenOpts->DwarfDebugFlags);
145  Diags.setClient(new ChainedDiagnosticConsumer(Diags.takeClient(), Logger));
146}
147
148static void SetupSerializedDiagnostics(DiagnosticOptions *DiagOpts,
149                                       DiagnosticsEngine &Diags,
150                                       StringRef OutputFile) {
151  std::string ErrorInfo;
152  OwningPtr<llvm::raw_fd_ostream> OS;
153  OS.reset(new llvm::raw_fd_ostream(OutputFile.str().c_str(), ErrorInfo,
154                                    llvm::raw_fd_ostream::F_Binary));
155
156  if (!ErrorInfo.empty()) {
157    Diags.Report(diag::warn_fe_serialized_diag_failure)
158      << OutputFile << ErrorInfo;
159    return;
160  }
161
162  DiagnosticConsumer *SerializedConsumer =
163    clang::serialized_diags::create(OS.take(), DiagOpts);
164
165
166  Diags.setClient(new ChainedDiagnosticConsumer(Diags.takeClient(),
167                                                SerializedConsumer));
168}
169
170void CompilerInstance::createDiagnostics(int Argc, const char* const *Argv,
171                                         DiagnosticConsumer *Client,
172                                         bool ShouldOwnClient,
173                                         bool ShouldCloneClient) {
174  Diagnostics = createDiagnostics(&getDiagnosticOpts(), Argc, Argv, Client,
175                                  ShouldOwnClient, ShouldCloneClient,
176                                  &getCodeGenOpts());
177}
178
179IntrusiveRefCntPtr<DiagnosticsEngine>
180CompilerInstance::createDiagnostics(DiagnosticOptions *Opts,
181                                    int Argc, const char* const *Argv,
182                                    DiagnosticConsumer *Client,
183                                    bool ShouldOwnClient,
184                                    bool ShouldCloneClient,
185                                    const CodeGenOptions *CodeGenOpts) {
186  IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
187  IntrusiveRefCntPtr<DiagnosticsEngine>
188      Diags(new DiagnosticsEngine(DiagID, Opts));
189
190  // Create the diagnostic client for reporting errors or for
191  // implementing -verify.
192  if (Client) {
193    if (ShouldCloneClient)
194      Diags->setClient(Client->clone(*Diags), ShouldOwnClient);
195    else
196      Diags->setClient(Client, ShouldOwnClient);
197  } else
198    Diags->setClient(new TextDiagnosticPrinter(llvm::errs(), Opts));
199
200  // Chain in -verify checker, if requested.
201  if (Opts->VerifyDiagnostics)
202    Diags->setClient(new VerifyDiagnosticConsumer(*Diags));
203
204  // Chain in -diagnostic-log-file dumper, if requested.
205  if (!Opts->DiagnosticLogFile.empty())
206    SetUpDiagnosticLog(Opts, CodeGenOpts, *Diags);
207
208  if (!Opts->DumpBuildInformation.empty())
209    SetUpBuildDumpLog(Opts, Argc, Argv, *Diags);
210
211  if (!Opts->DiagnosticSerializationFile.empty())
212    SetupSerializedDiagnostics(Opts, *Diags,
213                               Opts->DiagnosticSerializationFile);
214
215  // Configure our handling of diagnostics.
216  ProcessWarningOptions(*Diags, *Opts);
217
218  return Diags;
219}
220
221// File Manager
222
223void CompilerInstance::createFileManager() {
224  FileMgr = new FileManager(getFileSystemOpts());
225}
226
227// Source Manager
228
229void CompilerInstance::createSourceManager(FileManager &FileMgr) {
230  SourceMgr = new SourceManager(getDiagnostics(), FileMgr);
231}
232
233// Preprocessor
234
235void CompilerInstance::createPreprocessor() {
236  const PreprocessorOptions &PPOpts = getPreprocessorOpts();
237
238  // Create a PTH manager if we are using some form of a token cache.
239  PTHManager *PTHMgr = 0;
240  if (!PPOpts.TokenCache.empty())
241    PTHMgr = PTHManager::Create(PPOpts.TokenCache, getDiagnostics());
242
243  // Create the Preprocessor.
244  HeaderSearch *HeaderInfo = new HeaderSearch(&getHeaderSearchOpts(),
245                                              getFileManager(),
246                                              getDiagnostics(),
247                                              getLangOpts(),
248                                              &getTarget());
249  PP = new Preprocessor(&getPreprocessorOpts(),
250                        getDiagnostics(), getLangOpts(), &getTarget(),
251                        getSourceManager(), *HeaderInfo, *this, PTHMgr,
252                        /*OwnsHeaderSearch=*/true);
253
254  // Note that this is different then passing PTHMgr to Preprocessor's ctor.
255  // That argument is used as the IdentifierInfoLookup argument to
256  // IdentifierTable's ctor.
257  if (PTHMgr) {
258    PTHMgr->setPreprocessor(&*PP);
259    PP->setPTHManager(PTHMgr);
260  }
261
262  if (PPOpts.DetailedRecord)
263    PP->createPreprocessingRecord(PPOpts.DetailedRecordConditionalDirectives);
264
265  InitializePreprocessor(*PP, PPOpts, getHeaderSearchOpts(), getFrontendOpts());
266
267  // Set up the module path, including the hash for the
268  // module-creation options.
269  SmallString<256> SpecificModuleCache(
270                           getHeaderSearchOpts().ModuleCachePath);
271  if (!getHeaderSearchOpts().DisableModuleHash)
272    llvm::sys::path::append(SpecificModuleCache,
273                            getInvocation().getModuleHash());
274  PP->getHeaderSearchInfo().setModuleCachePath(SpecificModuleCache);
275
276  // Handle generating dependencies, if requested.
277  const DependencyOutputOptions &DepOpts = getDependencyOutputOpts();
278  if (!DepOpts.OutputFile.empty())
279    AttachDependencyFileGen(*PP, DepOpts);
280  if (!DepOpts.DOTOutputFile.empty())
281    AttachDependencyGraphGen(*PP, DepOpts.DOTOutputFile,
282                             getHeaderSearchOpts().Sysroot);
283
284
285  // Handle generating header include information, if requested.
286  if (DepOpts.ShowHeaderIncludes)
287    AttachHeaderIncludeGen(*PP);
288  if (!DepOpts.HeaderIncludeOutputFile.empty()) {
289    StringRef OutputPath = DepOpts.HeaderIncludeOutputFile;
290    if (OutputPath == "-")
291      OutputPath = "";
292    AttachHeaderIncludeGen(*PP, /*ShowAllHeaders=*/true, OutputPath,
293                           /*ShowDepth=*/false);
294  }
295}
296
297// ASTContext
298
299void CompilerInstance::createASTContext() {
300  Preprocessor &PP = getPreprocessor();
301  Context = new ASTContext(getLangOpts(), PP.getSourceManager(),
302                           &getTarget(), PP.getIdentifierTable(),
303                           PP.getSelectorTable(), PP.getBuiltinInfo(),
304                           /*size_reserve=*/ 0);
305}
306
307// ExternalASTSource
308
309void CompilerInstance::createPCHExternalASTSource(StringRef Path,
310                                                  bool DisablePCHValidation,
311                                                bool AllowPCHWithCompilerErrors,
312                                                 void *DeserializationListener){
313  OwningPtr<ExternalASTSource> Source;
314  bool Preamble = getPreprocessorOpts().PrecompiledPreambleBytes.first != 0;
315  Source.reset(createPCHExternalASTSource(Path, getHeaderSearchOpts().Sysroot,
316                                          DisablePCHValidation,
317                                          AllowPCHWithCompilerErrors,
318                                          getPreprocessor(), getASTContext(),
319                                          DeserializationListener,
320                                          Preamble));
321  ModuleManager = static_cast<ASTReader*>(Source.get());
322  getASTContext().setExternalSource(Source);
323}
324
325ExternalASTSource *
326CompilerInstance::createPCHExternalASTSource(StringRef Path,
327                                             const std::string &Sysroot,
328                                             bool DisablePCHValidation,
329                                             bool AllowPCHWithCompilerErrors,
330                                             Preprocessor &PP,
331                                             ASTContext &Context,
332                                             void *DeserializationListener,
333                                             bool Preamble) {
334  OwningPtr<ASTReader> Reader;
335  Reader.reset(new ASTReader(PP, Context,
336                             Sysroot.empty() ? "" : Sysroot.c_str(),
337                             DisablePCHValidation,
338                             AllowPCHWithCompilerErrors));
339
340  Reader->setDeserializationListener(
341            static_cast<ASTDeserializationListener *>(DeserializationListener));
342  switch (Reader->ReadAST(Path,
343                          Preamble ? serialization::MK_Preamble
344                                   : serialization::MK_PCH,
345                          SourceLocation(),
346                          ASTReader::ARR_None)) {
347  case ASTReader::Success:
348    // Set the predefines buffer as suggested by the PCH reader. Typically, the
349    // predefines buffer will be empty.
350    PP.setPredefines(Reader->getSuggestedPredefines());
351    return Reader.take();
352
353  case ASTReader::Failure:
354    // Unrecoverable failure: don't even try to process the input file.
355    break;
356
357  case ASTReader::OutOfDate:
358  case ASTReader::VersionMismatch:
359  case ASTReader::ConfigurationMismatch:
360  case ASTReader::HadErrors:
361    // No suitable PCH file could be found. Return an error.
362    break;
363  }
364
365  return 0;
366}
367
368// Code Completion
369
370static bool EnableCodeCompletion(Preprocessor &PP,
371                                 const std::string &Filename,
372                                 unsigned Line,
373                                 unsigned Column) {
374  // Tell the source manager to chop off the given file at a specific
375  // line and column.
376  const FileEntry *Entry = PP.getFileManager().getFile(Filename);
377  if (!Entry) {
378    PP.getDiagnostics().Report(diag::err_fe_invalid_code_complete_file)
379      << Filename;
380    return true;
381  }
382
383  // Truncate the named file at the given line/column.
384  PP.SetCodeCompletionPoint(Entry, Line, Column);
385  return false;
386}
387
388void CompilerInstance::createCodeCompletionConsumer() {
389  const ParsedSourceLocation &Loc = getFrontendOpts().CodeCompletionAt;
390  if (!CompletionConsumer) {
391    setCodeCompletionConsumer(
392      createCodeCompletionConsumer(getPreprocessor(),
393                                   Loc.FileName, Loc.Line, Loc.Column,
394                                   getFrontendOpts().CodeCompleteOpts,
395                                   llvm::outs()));
396    if (!CompletionConsumer)
397      return;
398  } else if (EnableCodeCompletion(getPreprocessor(), Loc.FileName,
399                                  Loc.Line, Loc.Column)) {
400    setCodeCompletionConsumer(0);
401    return;
402  }
403
404  if (CompletionConsumer->isOutputBinary() &&
405      llvm::sys::Program::ChangeStdoutToBinary()) {
406    getPreprocessor().getDiagnostics().Report(diag::err_fe_stdout_binary);
407    setCodeCompletionConsumer(0);
408  }
409}
410
411void CompilerInstance::createFrontendTimer() {
412  FrontendTimer.reset(new llvm::Timer("Clang front-end timer"));
413}
414
415CodeCompleteConsumer *
416CompilerInstance::createCodeCompletionConsumer(Preprocessor &PP,
417                                               const std::string &Filename,
418                                               unsigned Line,
419                                               unsigned Column,
420                                               const CodeCompleteOptions &Opts,
421                                               raw_ostream &OS) {
422  if (EnableCodeCompletion(PP, Filename, Line, Column))
423    return 0;
424
425  // Set up the creation routine for code-completion.
426  return new PrintingCodeCompleteConsumer(Opts, OS);
427}
428
429void CompilerInstance::createSema(TranslationUnitKind TUKind,
430                                  CodeCompleteConsumer *CompletionConsumer) {
431  TheSema.reset(new Sema(getPreprocessor(), getASTContext(), getASTConsumer(),
432                         TUKind, CompletionConsumer));
433}
434
435// Output Files
436
437void CompilerInstance::addOutputFile(const OutputFile &OutFile) {
438  assert(OutFile.OS && "Attempt to add empty stream to output list!");
439  OutputFiles.push_back(OutFile);
440}
441
442void CompilerInstance::clearOutputFiles(bool EraseFiles) {
443  for (std::list<OutputFile>::iterator
444         it = OutputFiles.begin(), ie = OutputFiles.end(); it != ie; ++it) {
445    delete it->OS;
446    if (!it->TempFilename.empty()) {
447      if (EraseFiles) {
448        bool existed;
449        llvm::sys::fs::remove(it->TempFilename, existed);
450      } else {
451        SmallString<128> NewOutFile(it->Filename);
452
453        // If '-working-directory' was passed, the output filename should be
454        // relative to that.
455        FileMgr->FixupRelativePath(NewOutFile);
456        if (llvm::error_code ec = llvm::sys::fs::rename(it->TempFilename,
457                                                        NewOutFile.str())) {
458          getDiagnostics().Report(diag::err_unable_to_rename_temp)
459            << it->TempFilename << it->Filename << ec.message();
460
461          bool existed;
462          llvm::sys::fs::remove(it->TempFilename, existed);
463        }
464      }
465    } else if (!it->Filename.empty() && EraseFiles)
466      llvm::sys::Path(it->Filename).eraseFromDisk();
467
468  }
469  OutputFiles.clear();
470}
471
472llvm::raw_fd_ostream *
473CompilerInstance::createDefaultOutputFile(bool Binary,
474                                          StringRef InFile,
475                                          StringRef Extension) {
476  return createOutputFile(getFrontendOpts().OutputFile, Binary,
477                          /*RemoveFileOnSignal=*/true, InFile, Extension,
478                          /*UseTemporary=*/true);
479}
480
481llvm::raw_fd_ostream *
482CompilerInstance::createOutputFile(StringRef OutputPath,
483                                   bool Binary, bool RemoveFileOnSignal,
484                                   StringRef InFile,
485                                   StringRef Extension,
486                                   bool UseTemporary,
487                                   bool CreateMissingDirectories) {
488  std::string Error, OutputPathName, TempPathName;
489  llvm::raw_fd_ostream *OS = createOutputFile(OutputPath, Error, Binary,
490                                              RemoveFileOnSignal,
491                                              InFile, Extension,
492                                              UseTemporary,
493                                              CreateMissingDirectories,
494                                              &OutputPathName,
495                                              &TempPathName);
496  if (!OS) {
497    getDiagnostics().Report(diag::err_fe_unable_to_open_output)
498      << OutputPath << Error;
499    return 0;
500  }
501
502  // Add the output file -- but don't try to remove "-", since this means we are
503  // using stdin.
504  addOutputFile(OutputFile((OutputPathName != "-") ? OutputPathName : "",
505                TempPathName, OS));
506
507  return OS;
508}
509
510llvm::raw_fd_ostream *
511CompilerInstance::createOutputFile(StringRef OutputPath,
512                                   std::string &Error,
513                                   bool Binary,
514                                   bool RemoveFileOnSignal,
515                                   StringRef InFile,
516                                   StringRef Extension,
517                                   bool UseTemporary,
518                                   bool CreateMissingDirectories,
519                                   std::string *ResultPathName,
520                                   std::string *TempPathName) {
521  assert((!CreateMissingDirectories || UseTemporary) &&
522         "CreateMissingDirectories is only allowed when using temporary files");
523
524  std::string OutFile, TempFile;
525  if (!OutputPath.empty()) {
526    OutFile = OutputPath;
527  } else if (InFile == "-") {
528    OutFile = "-";
529  } else if (!Extension.empty()) {
530    llvm::sys::Path Path(InFile);
531    Path.eraseSuffix();
532    Path.appendSuffix(Extension);
533    OutFile = Path.str();
534  } else {
535    OutFile = "-";
536  }
537
538  OwningPtr<llvm::raw_fd_ostream> OS;
539  std::string OSFile;
540
541  if (UseTemporary && OutFile != "-") {
542    // Only create the temporary if the parent directory exists (or create
543    // missing directories is true) and we can actually write to OutPath,
544    // otherwise we want to fail early.
545    SmallString<256> AbsPath(OutputPath);
546    llvm::sys::fs::make_absolute(AbsPath);
547    llvm::sys::Path OutPath(AbsPath);
548    bool ParentExists = false;
549    if (llvm::sys::fs::exists(llvm::sys::path::parent_path(AbsPath.str()),
550                              ParentExists))
551      ParentExists = false;
552    bool Exists;
553    if ((CreateMissingDirectories || ParentExists) &&
554        ((llvm::sys::fs::exists(AbsPath.str(), Exists) || !Exists) ||
555         (OutPath.isRegularFile() && OutPath.canWrite()))) {
556      // Create a temporary file.
557      SmallString<128> TempPath;
558      TempPath = OutFile;
559      TempPath += "-%%%%%%%%";
560      int fd;
561      if (llvm::sys::fs::unique_file(TempPath.str(), fd, TempPath,
562                                     /*makeAbsolute=*/false, 0664)
563          == llvm::errc::success) {
564        OS.reset(new llvm::raw_fd_ostream(fd, /*shouldClose=*/true));
565        OSFile = TempFile = TempPath.str();
566      }
567    }
568  }
569
570  if (!OS) {
571    OSFile = OutFile;
572    OS.reset(
573      new llvm::raw_fd_ostream(OSFile.c_str(), Error,
574                               (Binary ? llvm::raw_fd_ostream::F_Binary : 0)));
575    if (!Error.empty())
576      return 0;
577  }
578
579  // Make sure the out stream file gets removed if we crash.
580  if (RemoveFileOnSignal)
581    llvm::sys::RemoveFileOnSignal(llvm::sys::Path(OSFile));
582
583  if (ResultPathName)
584    *ResultPathName = OutFile;
585  if (TempPathName)
586    *TempPathName = TempFile;
587
588  return OS.take();
589}
590
591// Initialization Utilities
592
593bool CompilerInstance::InitializeSourceManager(const FrontendInputFile &Input){
594  return InitializeSourceManager(Input, getDiagnostics(),
595                                 getFileManager(), getSourceManager(),
596                                 getFrontendOpts());
597}
598
599bool CompilerInstance::InitializeSourceManager(const FrontendInputFile &Input,
600                                               DiagnosticsEngine &Diags,
601                                               FileManager &FileMgr,
602                                               SourceManager &SourceMgr,
603                                               const FrontendOptions &Opts) {
604  SrcMgr::CharacteristicKind
605    Kind = Input.isSystem() ? SrcMgr::C_System : SrcMgr::C_User;
606
607  if (Input.isBuffer()) {
608    SourceMgr.createMainFileIDForMemBuffer(Input.getBuffer(), Kind);
609    assert(!SourceMgr.getMainFileID().isInvalid() &&
610           "Couldn't establish MainFileID!");
611    return true;
612  }
613
614  StringRef InputFile = Input.getFile();
615
616  // Figure out where to get and map in the main file.
617  if (InputFile != "-") {
618    const FileEntry *File = FileMgr.getFile(InputFile);
619    if (!File) {
620      Diags.Report(diag::err_fe_error_reading) << InputFile;
621      return false;
622    }
623    SourceMgr.createMainFileID(File, Kind);
624
625    // The natural SourceManager infrastructure can't currently handle named
626    // pipes, but we would at least like to accept them for the main
627    // file. Detect them here, read them with the more generic MemoryBuffer
628    // function, and simply override their contents as we do for STDIN.
629    if (File->isNamedPipe()) {
630      OwningPtr<llvm::MemoryBuffer> MB;
631      if (llvm::error_code ec = llvm::MemoryBuffer::getFile(InputFile, MB)) {
632        Diags.Report(diag::err_cannot_open_file) << InputFile << ec.message();
633        return false;
634      }
635      SourceMgr.overrideFileContents(File, MB.take());
636    }
637  } else {
638    OwningPtr<llvm::MemoryBuffer> SB;
639    if (llvm::MemoryBuffer::getSTDIN(SB)) {
640      // FIXME: Give ec.message() in this diag.
641      Diags.Report(diag::err_fe_error_reading_stdin);
642      return false;
643    }
644    const FileEntry *File = FileMgr.getVirtualFile(SB->getBufferIdentifier(),
645                                                   SB->getBufferSize(), 0);
646    SourceMgr.createMainFileID(File, Kind);
647    SourceMgr.overrideFileContents(File, SB.take());
648  }
649
650  assert(!SourceMgr.getMainFileID().isInvalid() &&
651         "Couldn't establish MainFileID!");
652  return true;
653}
654
655// High-Level Operations
656
657bool CompilerInstance::ExecuteAction(FrontendAction &Act) {
658  assert(hasDiagnostics() && "Diagnostics engine is not initialized!");
659  assert(!getFrontendOpts().ShowHelp && "Client must handle '-help'!");
660  assert(!getFrontendOpts().ShowVersion && "Client must handle '-version'!");
661
662  // FIXME: Take this as an argument, once all the APIs we used have moved to
663  // taking it as an input instead of hard-coding llvm::errs.
664  raw_ostream &OS = llvm::errs();
665
666  // Create the target instance.
667  setTarget(TargetInfo::CreateTargetInfo(getDiagnostics(), getTargetOpts()));
668  if (!hasTarget())
669    return false;
670
671  // Inform the target of the language options.
672  //
673  // FIXME: We shouldn't need to do this, the target should be immutable once
674  // created. This complexity should be lifted elsewhere.
675  getTarget().setForcedLangOptions(getLangOpts());
676
677  // rewriter project will change target built-in bool type from its default.
678  if (getFrontendOpts().ProgramAction == frontend::RewriteObjC)
679    getTarget().noSignedCharForObjCBool();
680
681  // Validate/process some options.
682  if (getHeaderSearchOpts().Verbose)
683    OS << "clang -cc1 version " CLANG_VERSION_STRING
684       << " based upon " << PACKAGE_STRING
685       << " default target " << llvm::sys::getDefaultTargetTriple() << "\n";
686
687  if (getFrontendOpts().ShowTimers)
688    createFrontendTimer();
689
690  if (getFrontendOpts().ShowStats)
691    llvm::EnableStatistics();
692
693  for (unsigned i = 0, e = getFrontendOpts().Inputs.size(); i != e; ++i) {
694    // Reset the ID tables if we are reusing the SourceManager.
695    if (hasSourceManager())
696      getSourceManager().clearIDTables();
697
698    if (Act.BeginSourceFile(*this, getFrontendOpts().Inputs[i])) {
699      Act.Execute();
700      Act.EndSourceFile();
701    }
702  }
703
704  // Notify the diagnostic client that all files were processed.
705  getDiagnostics().getClient()->finish();
706
707  if (getDiagnosticOpts().ShowCarets) {
708    // We can have multiple diagnostics sharing one diagnostic client.
709    // Get the total number of warnings/errors from the client.
710    unsigned NumWarnings = getDiagnostics().getClient()->getNumWarnings();
711    unsigned NumErrors = getDiagnostics().getClient()->getNumErrors();
712
713    if (NumWarnings)
714      OS << NumWarnings << " warning" << (NumWarnings == 1 ? "" : "s");
715    if (NumWarnings && NumErrors)
716      OS << " and ";
717    if (NumErrors)
718      OS << NumErrors << " error" << (NumErrors == 1 ? "" : "s");
719    if (NumWarnings || NumErrors)
720      OS << " generated.\n";
721  }
722
723  if (getFrontendOpts().ShowStats && hasFileManager()) {
724    getFileManager().PrintStats();
725    OS << "\n";
726  }
727
728  return !getDiagnostics().getClient()->getNumErrors();
729}
730
731/// \brief Determine the appropriate source input kind based on language
732/// options.
733static InputKind getSourceInputKindFromOptions(const LangOptions &LangOpts) {
734  if (LangOpts.OpenCL)
735    return IK_OpenCL;
736  if (LangOpts.CUDA)
737    return IK_CUDA;
738  if (LangOpts.ObjC1)
739    return LangOpts.CPlusPlus? IK_ObjCXX : IK_ObjC;
740  return LangOpts.CPlusPlus? IK_CXX : IK_C;
741}
742
743namespace {
744  struct CompileModuleMapData {
745    CompilerInstance &Instance;
746    GenerateModuleAction &CreateModuleAction;
747  };
748}
749
750/// \brief Helper function that executes the module-generating action under
751/// a crash recovery context.
752static void doCompileMapModule(void *UserData) {
753  CompileModuleMapData &Data
754    = *reinterpret_cast<CompileModuleMapData *>(UserData);
755  Data.Instance.ExecuteAction(Data.CreateModuleAction);
756}
757
758/// \brief Compile a module file for the given module, using the options
759/// provided by the importing compiler instance.
760static void compileModule(CompilerInstance &ImportingInstance,
761                          Module *Module,
762                          StringRef ModuleFileName) {
763  llvm::LockFileManager Locked(ModuleFileName);
764  switch (Locked) {
765  case llvm::LockFileManager::LFS_Error:
766    return;
767
768  case llvm::LockFileManager::LFS_Owned:
769    // We're responsible for building the module ourselves. Do so below.
770    break;
771
772  case llvm::LockFileManager::LFS_Shared:
773    // Someone else is responsible for building the module. Wait for them to
774    // finish.
775    Locked.waitForUnlock();
776    return;
777  }
778
779  ModuleMap &ModMap
780    = ImportingInstance.getPreprocessor().getHeaderSearchInfo().getModuleMap();
781
782  // Construct a compiler invocation for creating this module.
783  IntrusiveRefCntPtr<CompilerInvocation> Invocation
784    (new CompilerInvocation(ImportingInstance.getInvocation()));
785
786  PreprocessorOptions &PPOpts = Invocation->getPreprocessorOpts();
787
788  // For any options that aren't intended to affect how a module is built,
789  // reset them to their default values.
790  Invocation->getLangOpts()->resetNonModularOptions();
791  PPOpts.resetNonModularOptions();
792
793  // Note the name of the module we're building.
794  Invocation->getLangOpts()->CurrentModule = Module->getTopLevelModuleName();
795
796  // Note that this module is part of the module build path, so that we
797  // can detect cycles in the module graph.
798  PPOpts.ModuleBuildPath.push_back(Module->getTopLevelModuleName());
799
800  // If there is a module map file, build the module using the module map.
801  // Set up the inputs/outputs so that we build the module from its umbrella
802  // header.
803  FrontendOptions &FrontendOpts = Invocation->getFrontendOpts();
804  FrontendOpts.OutputFile = ModuleFileName.str();
805  FrontendOpts.DisableFree = false;
806  FrontendOpts.Inputs.clear();
807  InputKind IK = getSourceInputKindFromOptions(*Invocation->getLangOpts());
808
809  // Get or create the module map that we'll use to build this module.
810  SmallString<128> TempModuleMapFileName;
811  if (const FileEntry *ModuleMapFile
812                                  = ModMap.getContainingModuleMapFile(Module)) {
813    // Use the module map where this module resides.
814    FrontendOpts.Inputs.push_back(FrontendInputFile(ModuleMapFile->getName(),
815                                                    IK));
816  } else {
817    // Create a temporary module map file.
818    TempModuleMapFileName = Module->Name;
819    TempModuleMapFileName += "-%%%%%%%%.map";
820    int FD;
821    if (llvm::sys::fs::unique_file(TempModuleMapFileName.str(), FD,
822                                   TempModuleMapFileName,
823                                   /*makeAbsolute=*/true)
824          != llvm::errc::success) {
825      ImportingInstance.getDiagnostics().Report(diag::err_module_map_temp_file)
826        << TempModuleMapFileName;
827      return;
828    }
829    // Print the module map to this file.
830    llvm::raw_fd_ostream OS(FD, /*shouldClose=*/true);
831    Module->print(OS);
832    FrontendOpts.Inputs.push_back(
833      FrontendInputFile(TempModuleMapFileName.str().str(), IK));
834  }
835
836  // Don't free the remapped file buffers; they are owned by our caller.
837  PPOpts.RetainRemappedFileBuffers = true;
838
839  Invocation->getDiagnosticOpts().VerifyDiagnostics = 0;
840  assert(ImportingInstance.getInvocation().getModuleHash() ==
841         Invocation->getModuleHash() && "Module hash mismatch!");
842
843  // Construct a compiler instance that will be used to actually create the
844  // module.
845  CompilerInstance Instance;
846  Instance.setInvocation(&*Invocation);
847  Instance.createDiagnostics(/*argc=*/0, /*argv=*/0,
848                             &ImportingInstance.getDiagnosticClient(),
849                             /*ShouldOwnClient=*/true,
850                             /*ShouldCloneClient=*/true);
851
852  // Construct a module-generating action.
853  GenerateModuleAction CreateModuleAction;
854
855  // Execute the action to actually build the module in-place. Use a separate
856  // thread so that we get a stack large enough.
857  const unsigned ThreadStackSize = 8 << 20;
858  llvm::CrashRecoveryContext CRC;
859  CompileModuleMapData Data = { Instance, CreateModuleAction };
860  CRC.RunSafelyOnThread(&doCompileMapModule, &Data, ThreadStackSize);
861
862  // Delete the temporary module map file.
863  // FIXME: Even though we're executing under crash protection, it would still
864  // be nice to do this with RemoveFileOnSignal when we can. However, that
865  // doesn't make sense for all clients, so clean this up manually.
866  Instance.clearOutputFiles(/*EraseFiles=*/true);
867  if (!TempModuleMapFileName.empty())
868    llvm::sys::Path(TempModuleMapFileName).eraseFromDisk();
869}
870
871Module *CompilerInstance::loadModule(SourceLocation ImportLoc,
872                                     ModuleIdPath Path,
873                                     Module::NameVisibilityKind Visibility,
874                                     bool IsInclusionDirective) {
875  // If we've already handled this import, just return the cached result.
876  // This one-element cache is important to eliminate redundant diagnostics
877  // when both the preprocessor and parser see the same import declaration.
878  if (!ImportLoc.isInvalid() && LastModuleImportLoc == ImportLoc) {
879    // Make the named module visible.
880    if (LastModuleImportResult)
881      ModuleManager->makeModuleVisible(LastModuleImportResult, Visibility);
882    return LastModuleImportResult;
883  }
884
885  // Determine what file we're searching from.
886  StringRef ModuleName = Path[0].first->getName();
887  SourceLocation ModuleNameLoc = Path[0].second;
888
889  clang::Module *Module = 0;
890
891  // If we don't already have information on this module, load the module now.
892  llvm::DenseMap<const IdentifierInfo *, clang::Module *>::iterator Known
893    = KnownModules.find(Path[0].first);
894  if (Known != KnownModules.end()) {
895    // Retrieve the cached top-level module.
896    Module = Known->second;
897  } else if (ModuleName == getLangOpts().CurrentModule) {
898    // This is the module we're building.
899    Module = PP->getHeaderSearchInfo().getModuleMap().findModule(ModuleName);
900    Known = KnownModules.insert(std::make_pair(Path[0].first, Module)).first;
901  } else {
902    // Search for a module with the given name.
903    Module = PP->getHeaderSearchInfo().lookupModule(ModuleName);
904    std::string ModuleFileName;
905    if (Module)
906      ModuleFileName = PP->getHeaderSearchInfo().getModuleFileName(Module);
907    else
908      ModuleFileName = PP->getHeaderSearchInfo().getModuleFileName(ModuleName);
909
910    if (ModuleFileName.empty()) {
911      getDiagnostics().Report(ModuleNameLoc, diag::err_module_not_found)
912        << ModuleName
913        << SourceRange(ImportLoc, ModuleNameLoc);
914      LastModuleImportLoc = ImportLoc;
915      LastModuleImportResult = 0;
916      return 0;
917    }
918
919    const FileEntry *ModuleFile
920      = getFileManager().getFile(ModuleFileName, /*OpenFile=*/false,
921                                 /*CacheFailure=*/false);
922    bool BuildingModule = false;
923    if (!ModuleFile && Module) {
924      // The module is not cached, but we have a module map from which we can
925      // build the module.
926
927      // Check whether there is a cycle in the module graph.
928      SmallVectorImpl<std::string> &ModuleBuildPath
929        = getPreprocessorOpts().ModuleBuildPath;
930      SmallVectorImpl<std::string>::iterator Pos
931        = std::find(ModuleBuildPath.begin(), ModuleBuildPath.end(), ModuleName);
932      if (Pos != ModuleBuildPath.end()) {
933        SmallString<256> CyclePath;
934        for (; Pos != ModuleBuildPath.end(); ++Pos) {
935          CyclePath += *Pos;
936          CyclePath += " -> ";
937        }
938        CyclePath += ModuleName;
939
940        getDiagnostics().Report(ModuleNameLoc, diag::err_module_cycle)
941          << ModuleName << CyclePath;
942        return 0;
943      }
944
945      getDiagnostics().Report(ModuleNameLoc, diag::warn_module_build)
946        << ModuleName;
947      BuildingModule = true;
948      compileModule(*this, Module, ModuleFileName);
949      ModuleFile = FileMgr->getFile(ModuleFileName);
950    }
951
952    if (!ModuleFile) {
953      getDiagnostics().Report(ModuleNameLoc,
954                              BuildingModule? diag::err_module_not_built
955                                            : diag::err_module_not_found)
956        << ModuleName
957        << SourceRange(ImportLoc, ModuleNameLoc);
958      return 0;
959    }
960
961    // If we don't already have an ASTReader, create one now.
962    if (!ModuleManager) {
963      if (!hasASTContext())
964        createASTContext();
965
966      std::string Sysroot = getHeaderSearchOpts().Sysroot;
967      const PreprocessorOptions &PPOpts = getPreprocessorOpts();
968      ModuleManager = new ASTReader(getPreprocessor(), *Context,
969                                    Sysroot.empty() ? "" : Sysroot.c_str(),
970                                    PPOpts.DisablePCHValidation);
971      if (hasASTConsumer()) {
972        ModuleManager->setDeserializationListener(
973          getASTConsumer().GetASTDeserializationListener());
974        getASTContext().setASTMutationListener(
975          getASTConsumer().GetASTMutationListener());
976        getPreprocessor().setPPMutationListener(
977          getASTConsumer().GetPPMutationListener());
978      }
979      OwningPtr<ExternalASTSource> Source;
980      Source.reset(ModuleManager);
981      getASTContext().setExternalSource(Source);
982      if (hasSema())
983        ModuleManager->InitializeSema(getSema());
984      if (hasASTConsumer())
985        ModuleManager->StartTranslationUnit(&getASTConsumer());
986    }
987
988    // Try to load the module we found.
989    unsigned ARRFlags = ASTReader::ARR_None;
990    if (Module)
991      ARRFlags |= ASTReader::ARR_OutOfDate;
992    switch (ModuleManager->ReadAST(ModuleFile->getName(),
993                                   serialization::MK_Module, ImportLoc,
994                                   ARRFlags)) {
995    case ASTReader::Success:
996      break;
997
998    case ASTReader::OutOfDate: {
999      // The module file is out-of-date. Rebuild it.
1000      getFileManager().invalidateCache(ModuleFile);
1001      bool Existed;
1002      llvm::sys::fs::remove(ModuleFileName, Existed);
1003      compileModule(*this, Module, ModuleFileName);
1004
1005      // Try loading the module again.
1006      ModuleFile = FileMgr->getFile(ModuleFileName);
1007      if (!ModuleFile ||
1008          ModuleManager->ReadAST(ModuleFileName,
1009                                 serialization::MK_Module, ImportLoc,
1010                                 ASTReader::ARR_None) != ASTReader::Success) {
1011        KnownModules[Path[0].first] = 0;
1012        return 0;
1013      }
1014
1015      // Okay, we've rebuilt and now loaded the module.
1016      break;
1017    }
1018
1019    case ASTReader::VersionMismatch:
1020    case ASTReader::ConfigurationMismatch:
1021    case ASTReader::HadErrors:
1022      // FIXME: The ASTReader will already have complained, but can we showhorn
1023      // that diagnostic information into a more useful form?
1024      KnownModules[Path[0].first] = 0;
1025      return 0;
1026
1027    case ASTReader::Failure:
1028      // Already complained, but note now that we failed.
1029      KnownModules[Path[0].first] = 0;
1030      return 0;
1031    }
1032
1033    if (!Module) {
1034      // If we loaded the module directly, without finding a module map first,
1035      // we'll have loaded the module's information from the module itself.
1036      Module = PP->getHeaderSearchInfo().getModuleMap()
1037                 .findModule((Path[0].first->getName()));
1038    }
1039
1040    if (Module)
1041      Module->setASTFile(ModuleFile);
1042
1043    // Cache the result of this top-level module lookup for later.
1044    Known = KnownModules.insert(std::make_pair(Path[0].first, Module)).first;
1045  }
1046
1047  // If we never found the module, fail.
1048  if (!Module)
1049    return 0;
1050
1051  // Verify that the rest of the module path actually corresponds to
1052  // a submodule.
1053  if (Path.size() > 1) {
1054    for (unsigned I = 1, N = Path.size(); I != N; ++I) {
1055      StringRef Name = Path[I].first->getName();
1056      clang::Module *Sub = Module->findSubmodule(Name);
1057
1058      if (!Sub) {
1059        // Attempt to perform typo correction to find a module name that works.
1060        llvm::SmallVector<StringRef, 2> Best;
1061        unsigned BestEditDistance = (std::numeric_limits<unsigned>::max)();
1062
1063        for (clang::Module::submodule_iterator J = Module->submodule_begin(),
1064                                            JEnd = Module->submodule_end();
1065             J != JEnd; ++J) {
1066          unsigned ED = Name.edit_distance((*J)->Name,
1067                                           /*AllowReplacements=*/true,
1068                                           BestEditDistance);
1069          if (ED <= BestEditDistance) {
1070            if (ED < BestEditDistance) {
1071              Best.clear();
1072              BestEditDistance = ED;
1073            }
1074
1075            Best.push_back((*J)->Name);
1076          }
1077        }
1078
1079        // If there was a clear winner, user it.
1080        if (Best.size() == 1) {
1081          getDiagnostics().Report(Path[I].second,
1082                                  diag::err_no_submodule_suggest)
1083            << Path[I].first << Module->getFullModuleName() << Best[0]
1084            << SourceRange(Path[0].second, Path[I-1].second)
1085            << FixItHint::CreateReplacement(SourceRange(Path[I].second),
1086                                            Best[0]);
1087
1088          Sub = Module->findSubmodule(Best[0]);
1089        }
1090      }
1091
1092      if (!Sub) {
1093        // No submodule by this name. Complain, and don't look for further
1094        // submodules.
1095        getDiagnostics().Report(Path[I].second, diag::err_no_submodule)
1096          << Path[I].first << Module->getFullModuleName()
1097          << SourceRange(Path[0].second, Path[I-1].second);
1098        break;
1099      }
1100
1101      Module = Sub;
1102    }
1103  }
1104
1105  // Make the named module visible, if it's not already part of the module
1106  // we are parsing.
1107  if (ModuleName != getLangOpts().CurrentModule) {
1108    if (!Module->IsFromModuleFile) {
1109      // We have an umbrella header or directory that doesn't actually include
1110      // all of the headers within the directory it covers. Complain about
1111      // this missing submodule and recover by forgetting that we ever saw
1112      // this submodule.
1113      // FIXME: Should we detect this at module load time? It seems fairly
1114      // expensive (and rare).
1115      getDiagnostics().Report(ImportLoc, diag::warn_missing_submodule)
1116        << Module->getFullModuleName()
1117        << SourceRange(Path.front().second, Path.back().second);
1118
1119      return 0;
1120    }
1121
1122    // Check whether this module is available.
1123    StringRef Feature;
1124    if (!Module->isAvailable(getLangOpts(), getTarget(), Feature)) {
1125      getDiagnostics().Report(ImportLoc, diag::err_module_unavailable)
1126        << Module->getFullModuleName()
1127        << Feature
1128        << SourceRange(Path.front().second, Path.back().second);
1129      LastModuleImportLoc = ImportLoc;
1130      LastModuleImportResult = 0;
1131      return 0;
1132    }
1133
1134    ModuleManager->makeModuleVisible(Module, Visibility);
1135  }
1136
1137  // If this module import was due to an inclusion directive, create an
1138  // implicit import declaration to capture it in the AST.
1139  if (IsInclusionDirective && hasASTContext()) {
1140    TranslationUnitDecl *TU = getASTContext().getTranslationUnitDecl();
1141    ImportDecl *ImportD = ImportDecl::CreateImplicit(getASTContext(), TU,
1142                                                     ImportLoc, Module,
1143                                                     Path.back().second);
1144    TU->addDecl(ImportD);
1145    if (Consumer)
1146      Consumer->HandleImplicitImportDecl(ImportD);
1147  }
1148
1149  LastModuleImportLoc = ImportLoc;
1150  LastModuleImportResult = Module;
1151  return Module;
1152}
1153