CompilerInstance.cpp revision 8616f9af65b9a3662f2c9dfed38eeabc509f8446 
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                          ASTReader::ARR_None)) {
346  case ASTReader::Success:
347    // Set the predefines buffer as suggested by the PCH reader. Typically, the
348    // predefines buffer will be empty.
349    PP.setPredefines(Reader->getSuggestedPredefines());
350    return Reader.take();
351
352  case ASTReader::Failure:
353    // Unrecoverable failure: don't even try to process the input file.
354    break;
355
356  case ASTReader::OutOfDate:
357  case ASTReader::VersionMismatch:
358  case ASTReader::ConfigurationMismatch:
359  case ASTReader::HadErrors:
360    // No suitable PCH file could be found. Return an error.
361    break;
362  }
363
364  return 0;
365}
366
367// Code Completion
368
369static bool EnableCodeCompletion(Preprocessor &PP,
370                                 const std::string &Filename,
371                                 unsigned Line,
372                                 unsigned Column) {
373  // Tell the source manager to chop off the given file at a specific
374  // line and column.
375  const FileEntry *Entry = PP.getFileManager().getFile(Filename);
376  if (!Entry) {
377    PP.getDiagnostics().Report(diag::err_fe_invalid_code_complete_file)
378      << Filename;
379    return true;
380  }
381
382  // Truncate the named file at the given line/column.
383  PP.SetCodeCompletionPoint(Entry, Line, Column);
384  return false;
385}
386
387void CompilerInstance::createCodeCompletionConsumer() {
388  const ParsedSourceLocation &Loc = getFrontendOpts().CodeCompletionAt;
389  if (!CompletionConsumer) {
390    setCodeCompletionConsumer(
391      createCodeCompletionConsumer(getPreprocessor(),
392                                   Loc.FileName, Loc.Line, Loc.Column,
393                                   getFrontendOpts().CodeCompleteOpts,
394                                   llvm::outs()));
395    if (!CompletionConsumer)
396      return;
397  } else if (EnableCodeCompletion(getPreprocessor(), Loc.FileName,
398                                  Loc.Line, Loc.Column)) {
399    setCodeCompletionConsumer(0);
400    return;
401  }
402
403  if (CompletionConsumer->isOutputBinary() &&
404      llvm::sys::Program::ChangeStdoutToBinary()) {
405    getPreprocessor().getDiagnostics().Report(diag::err_fe_stdout_binary);
406    setCodeCompletionConsumer(0);
407  }
408}
409
410void CompilerInstance::createFrontendTimer() {
411  FrontendTimer.reset(new llvm::Timer("Clang front-end timer"));
412}
413
414CodeCompleteConsumer *
415CompilerInstance::createCodeCompletionConsumer(Preprocessor &PP,
416                                               const std::string &Filename,
417                                               unsigned Line,
418                                               unsigned Column,
419                                               const CodeCompleteOptions &Opts,
420                                               raw_ostream &OS) {
421  if (EnableCodeCompletion(PP, Filename, Line, Column))
422    return 0;
423
424  // Set up the creation routine for code-completion.
425  return new PrintingCodeCompleteConsumer(Opts, OS);
426}
427
428void CompilerInstance::createSema(TranslationUnitKind TUKind,
429                                  CodeCompleteConsumer *CompletionConsumer) {
430  TheSema.reset(new Sema(getPreprocessor(), getASTContext(), getASTConsumer(),
431                         TUKind, CompletionConsumer));
432}
433
434// Output Files
435
436void CompilerInstance::addOutputFile(const OutputFile &OutFile) {
437  assert(OutFile.OS && "Attempt to add empty stream to output list!");
438  OutputFiles.push_back(OutFile);
439}
440
441void CompilerInstance::clearOutputFiles(bool EraseFiles) {
442  for (std::list<OutputFile>::iterator
443         it = OutputFiles.begin(), ie = OutputFiles.end(); it != ie; ++it) {
444    delete it->OS;
445    if (!it->TempFilename.empty()) {
446      if (EraseFiles) {
447        bool existed;
448        llvm::sys::fs::remove(it->TempFilename, existed);
449      } else {
450        SmallString<128> NewOutFile(it->Filename);
451
452        // If '-working-directory' was passed, the output filename should be
453        // relative to that.
454        FileMgr->FixupRelativePath(NewOutFile);
455        if (llvm::error_code ec = llvm::sys::fs::rename(it->TempFilename,
456                                                        NewOutFile.str())) {
457          getDiagnostics().Report(diag::err_unable_to_rename_temp)
458            << it->TempFilename << it->Filename << ec.message();
459
460          bool existed;
461          llvm::sys::fs::remove(it->TempFilename, existed);
462        }
463      }
464    } else if (!it->Filename.empty() && EraseFiles)
465      llvm::sys::Path(it->Filename).eraseFromDisk();
466
467  }
468  OutputFiles.clear();
469}
470
471llvm::raw_fd_ostream *
472CompilerInstance::createDefaultOutputFile(bool Binary,
473                                          StringRef InFile,
474                                          StringRef Extension) {
475  return createOutputFile(getFrontendOpts().OutputFile, Binary,
476                          /*RemoveFileOnSignal=*/true, InFile, Extension,
477                          /*UseTemporary=*/true);
478}
479
480llvm::raw_fd_ostream *
481CompilerInstance::createOutputFile(StringRef OutputPath,
482                                   bool Binary, bool RemoveFileOnSignal,
483                                   StringRef InFile,
484                                   StringRef Extension,
485                                   bool UseTemporary,
486                                   bool CreateMissingDirectories) {
487  std::string Error, OutputPathName, TempPathName;
488  llvm::raw_fd_ostream *OS = createOutputFile(OutputPath, Error, Binary,
489                                              RemoveFileOnSignal,
490                                              InFile, Extension,
491                                              UseTemporary,
492                                              CreateMissingDirectories,
493                                              &OutputPathName,
494                                              &TempPathName);
495  if (!OS) {
496    getDiagnostics().Report(diag::err_fe_unable_to_open_output)
497      << OutputPath << Error;
498    return 0;
499  }
500
501  // Add the output file -- but don't try to remove "-", since this means we are
502  // using stdin.
503  addOutputFile(OutputFile((OutputPathName != "-") ? OutputPathName : "",
504                TempPathName, OS));
505
506  return OS;
507}
508
509llvm::raw_fd_ostream *
510CompilerInstance::createOutputFile(StringRef OutputPath,
511                                   std::string &Error,
512                                   bool Binary,
513                                   bool RemoveFileOnSignal,
514                                   StringRef InFile,
515                                   StringRef Extension,
516                                   bool UseTemporary,
517                                   bool CreateMissingDirectories,
518                                   std::string *ResultPathName,
519                                   std::string *TempPathName) {
520  assert((!CreateMissingDirectories || UseTemporary) &&
521         "CreateMissingDirectories is only allowed when using temporary files");
522
523  std::string OutFile, TempFile;
524  if (!OutputPath.empty()) {
525    OutFile = OutputPath;
526  } else if (InFile == "-") {
527    OutFile = "-";
528  } else if (!Extension.empty()) {
529    llvm::sys::Path Path(InFile);
530    Path.eraseSuffix();
531    Path.appendSuffix(Extension);
532    OutFile = Path.str();
533  } else {
534    OutFile = "-";
535  }
536
537  OwningPtr<llvm::raw_fd_ostream> OS;
538  std::string OSFile;
539
540  if (UseTemporary && OutFile != "-") {
541    // Only create the temporary if the parent directory exists (or create
542    // missing directories is true) and we can actually write to OutPath,
543    // otherwise we want to fail early.
544    SmallString<256> AbsPath(OutputPath);
545    llvm::sys::fs::make_absolute(AbsPath);
546    llvm::sys::Path OutPath(AbsPath);
547    bool ParentExists = false;
548    if (llvm::sys::fs::exists(llvm::sys::path::parent_path(AbsPath.str()),
549                              ParentExists))
550      ParentExists = false;
551    bool Exists;
552    if ((CreateMissingDirectories || ParentExists) &&
553        ((llvm::sys::fs::exists(AbsPath.str(), Exists) || !Exists) ||
554         (OutPath.isRegularFile() && OutPath.canWrite()))) {
555      // Create a temporary file.
556      SmallString<128> TempPath;
557      TempPath = OutFile;
558      TempPath += "-%%%%%%%%";
559      int fd;
560      if (llvm::sys::fs::unique_file(TempPath.str(), fd, TempPath,
561                                     /*makeAbsolute=*/false, 0664)
562          == llvm::errc::success) {
563        OS.reset(new llvm::raw_fd_ostream(fd, /*shouldClose=*/true));
564        OSFile = TempFile = TempPath.str();
565      }
566    }
567  }
568
569  if (!OS) {
570    OSFile = OutFile;
571    OS.reset(
572      new llvm::raw_fd_ostream(OSFile.c_str(), Error,
573                               (Binary ? llvm::raw_fd_ostream::F_Binary : 0)));
574    if (!Error.empty())
575      return 0;
576  }
577
578  // Make sure the out stream file gets removed if we crash.
579  if (RemoveFileOnSignal)
580    llvm::sys::RemoveFileOnSignal(llvm::sys::Path(OSFile));
581
582  if (ResultPathName)
583    *ResultPathName = OutFile;
584  if (TempPathName)
585    *TempPathName = TempFile;
586
587  return OS.take();
588}
589
590// Initialization Utilities
591
592bool CompilerInstance::InitializeSourceManager(const FrontendInputFile &Input){
593  return InitializeSourceManager(Input, getDiagnostics(),
594                                 getFileManager(), getSourceManager(),
595                                 getFrontendOpts());
596}
597
598bool CompilerInstance::InitializeSourceManager(const FrontendInputFile &Input,
599                                               DiagnosticsEngine &Diags,
600                                               FileManager &FileMgr,
601                                               SourceManager &SourceMgr,
602                                               const FrontendOptions &Opts) {
603  StringRef InputFile = Input.getFile();
604  SrcMgr::CharacteristicKind
605    Kind = Input.isSystem() ? SrcMgr::C_System : SrcMgr::C_User;
606
607  // Figure out where to get and map in the main file.
608  if (InputFile != "-") {
609    const FileEntry *File = FileMgr.getFile(InputFile);
610    if (!File) {
611      Diags.Report(diag::err_fe_error_reading) << InputFile;
612      return false;
613    }
614    SourceMgr.createMainFileID(File, Kind);
615
616    // The natural SourceManager infrastructure can't currently handle named
617    // pipes, but we would at least like to accept them for the main
618    // file. Detect them here, read them with the more generic MemoryBuffer
619    // function, and simply override their contents as we do for STDIN.
620    if (File->isNamedPipe()) {
621      OwningPtr<llvm::MemoryBuffer> MB;
622      if (llvm::error_code ec = llvm::MemoryBuffer::getFile(InputFile, MB)) {
623        Diags.Report(diag::err_cannot_open_file) << InputFile << ec.message();
624        return false;
625      }
626      SourceMgr.overrideFileContents(File, MB.take());
627    }
628  } else {
629    OwningPtr<llvm::MemoryBuffer> SB;
630    if (llvm::MemoryBuffer::getSTDIN(SB)) {
631      // FIXME: Give ec.message() in this diag.
632      Diags.Report(diag::err_fe_error_reading_stdin);
633      return false;
634    }
635    const FileEntry *File = FileMgr.getVirtualFile(SB->getBufferIdentifier(),
636                                                   SB->getBufferSize(), 0);
637    SourceMgr.createMainFileID(File, Kind);
638    SourceMgr.overrideFileContents(File, SB.take());
639  }
640
641  assert(!SourceMgr.getMainFileID().isInvalid() &&
642         "Couldn't establish MainFileID!");
643  return true;
644}
645
646// High-Level Operations
647
648bool CompilerInstance::ExecuteAction(FrontendAction &Act) {
649  assert(hasDiagnostics() && "Diagnostics engine is not initialized!");
650  assert(!getFrontendOpts().ShowHelp && "Client must handle '-help'!");
651  assert(!getFrontendOpts().ShowVersion && "Client must handle '-version'!");
652
653  // FIXME: Take this as an argument, once all the APIs we used have moved to
654  // taking it as an input instead of hard-coding llvm::errs.
655  raw_ostream &OS = llvm::errs();
656
657  // Create the target instance.
658  setTarget(TargetInfo::CreateTargetInfo(getDiagnostics(), getTargetOpts()));
659  if (!hasTarget())
660    return false;
661
662  // Inform the target of the language options.
663  //
664  // FIXME: We shouldn't need to do this, the target should be immutable once
665  // created. This complexity should be lifted elsewhere.
666  getTarget().setForcedLangOptions(getLangOpts());
667
668  // rewriter project will change target built-in bool type from its default.
669  if (getFrontendOpts().ProgramAction == frontend::RewriteObjC)
670    getTarget().noSignedCharForObjCBool();
671
672  // Validate/process some options.
673  if (getHeaderSearchOpts().Verbose)
674    OS << "clang -cc1 version " CLANG_VERSION_STRING
675       << " based upon " << PACKAGE_STRING
676       << " default target " << llvm::sys::getDefaultTargetTriple() << "\n";
677
678  if (getFrontendOpts().ShowTimers)
679    createFrontendTimer();
680
681  if (getFrontendOpts().ShowStats)
682    llvm::EnableStatistics();
683
684  for (unsigned i = 0, e = getFrontendOpts().Inputs.size(); i != e; ++i) {
685    // Reset the ID tables if we are reusing the SourceManager.
686    if (hasSourceManager())
687      getSourceManager().clearIDTables();
688
689    if (Act.BeginSourceFile(*this, getFrontendOpts().Inputs[i])) {
690      Act.Execute();
691      Act.EndSourceFile();
692    }
693  }
694
695  // Notify the diagnostic client that all files were processed.
696  getDiagnostics().getClient()->finish();
697
698  if (getDiagnosticOpts().ShowCarets) {
699    // We can have multiple diagnostics sharing one diagnostic client.
700    // Get the total number of warnings/errors from the client.
701    unsigned NumWarnings = getDiagnostics().getClient()->getNumWarnings();
702    unsigned NumErrors = getDiagnostics().getClient()->getNumErrors();
703
704    if (NumWarnings)
705      OS << NumWarnings << " warning" << (NumWarnings == 1 ? "" : "s");
706    if (NumWarnings && NumErrors)
707      OS << " and ";
708    if (NumErrors)
709      OS << NumErrors << " error" << (NumErrors == 1 ? "" : "s");
710    if (NumWarnings || NumErrors)
711      OS << " generated.\n";
712  }
713
714  if (getFrontendOpts().ShowStats && hasFileManager()) {
715    getFileManager().PrintStats();
716    OS << "\n";
717  }
718
719  return !getDiagnostics().getClient()->getNumErrors();
720}
721
722/// \brief Determine the appropriate source input kind based on language
723/// options.
724static InputKind getSourceInputKindFromOptions(const LangOptions &LangOpts) {
725  if (LangOpts.OpenCL)
726    return IK_OpenCL;
727  if (LangOpts.CUDA)
728    return IK_CUDA;
729  if (LangOpts.ObjC1)
730    return LangOpts.CPlusPlus? IK_ObjCXX : IK_ObjC;
731  return LangOpts.CPlusPlus? IK_CXX : IK_C;
732}
733
734namespace {
735  struct CompileModuleMapData {
736    CompilerInstance &Instance;
737    GenerateModuleAction &CreateModuleAction;
738  };
739}
740
741/// \brief Helper function that executes the module-generating action under
742/// a crash recovery context.
743static void doCompileMapModule(void *UserData) {
744  CompileModuleMapData &Data
745    = *reinterpret_cast<CompileModuleMapData *>(UserData);
746  Data.Instance.ExecuteAction(Data.CreateModuleAction);
747}
748
749/// \brief Compile a module file for the given module, using the options
750/// provided by the importing compiler instance.
751static void compileModule(CompilerInstance &ImportingInstance,
752                          Module *Module,
753                          StringRef ModuleFileName) {
754  llvm::LockFileManager Locked(ModuleFileName);
755  switch (Locked) {
756  case llvm::LockFileManager::LFS_Error:
757    return;
758
759  case llvm::LockFileManager::LFS_Owned:
760    // We're responsible for building the module ourselves. Do so below.
761    break;
762
763  case llvm::LockFileManager::LFS_Shared:
764    // Someone else is responsible for building the module. Wait for them to
765    // finish.
766    Locked.waitForUnlock();
767    return;
768  }
769
770  ModuleMap &ModMap
771    = ImportingInstance.getPreprocessor().getHeaderSearchInfo().getModuleMap();
772
773  // Construct a compiler invocation for creating this module.
774  IntrusiveRefCntPtr<CompilerInvocation> Invocation
775    (new CompilerInvocation(ImportingInstance.getInvocation()));
776
777  PreprocessorOptions &PPOpts = Invocation->getPreprocessorOpts();
778
779  // For any options that aren't intended to affect how a module is built,
780  // reset them to their default values.
781  Invocation->getLangOpts()->resetNonModularOptions();
782  PPOpts.resetNonModularOptions();
783
784  // Note the name of the module we're building.
785  Invocation->getLangOpts()->CurrentModule = Module->getTopLevelModuleName();
786
787  // Note that this module is part of the module build path, so that we
788  // can detect cycles in the module graph.
789  PPOpts.ModuleBuildPath.push_back(Module->getTopLevelModuleName());
790
791  // If there is a module map file, build the module using the module map.
792  // Set up the inputs/outputs so that we build the module from its umbrella
793  // header.
794  FrontendOptions &FrontendOpts = Invocation->getFrontendOpts();
795  FrontendOpts.OutputFile = ModuleFileName.str();
796  FrontendOpts.DisableFree = false;
797  FrontendOpts.Inputs.clear();
798  InputKind IK = getSourceInputKindFromOptions(*Invocation->getLangOpts());
799
800  // Get or create the module map that we'll use to build this module.
801  SmallString<128> TempModuleMapFileName;
802  if (const FileEntry *ModuleMapFile
803                                  = ModMap.getContainingModuleMapFile(Module)) {
804    // Use the module map where this module resides.
805    FrontendOpts.Inputs.push_back(FrontendInputFile(ModuleMapFile->getName(),
806                                                    IK));
807  } else {
808    // Create a temporary module map file.
809    TempModuleMapFileName = Module->Name;
810    TempModuleMapFileName += "-%%%%%%%%.map";
811    int FD;
812    if (llvm::sys::fs::unique_file(TempModuleMapFileName.str(), FD,
813                                   TempModuleMapFileName,
814                                   /*makeAbsolute=*/true)
815          != llvm::errc::success) {
816      ImportingInstance.getDiagnostics().Report(diag::err_module_map_temp_file)
817        << TempModuleMapFileName;
818      return;
819    }
820    // Print the module map to this file.
821    llvm::raw_fd_ostream OS(FD, /*shouldClose=*/true);
822    Module->print(OS);
823    FrontendOpts.Inputs.push_back(
824      FrontendInputFile(TempModuleMapFileName.str().str(), IK));
825  }
826
827  // Don't free the remapped file buffers; they are owned by our caller.
828  PPOpts.RetainRemappedFileBuffers = true;
829
830  Invocation->getDiagnosticOpts().VerifyDiagnostics = 0;
831  assert(ImportingInstance.getInvocation().getModuleHash() ==
832         Invocation->getModuleHash() && "Module hash mismatch!");
833
834  // Construct a compiler instance that will be used to actually create the
835  // module.
836  CompilerInstance Instance;
837  Instance.setInvocation(&*Invocation);
838  Instance.createDiagnostics(/*argc=*/0, /*argv=*/0,
839                             &ImportingInstance.getDiagnosticClient(),
840                             /*ShouldOwnClient=*/true,
841                             /*ShouldCloneClient=*/true);
842
843  // Construct a module-generating action.
844  GenerateModuleAction CreateModuleAction;
845
846  // Execute the action to actually build the module in-place. Use a separate
847  // thread so that we get a stack large enough.
848  const unsigned ThreadStackSize = 8 << 20;
849  llvm::CrashRecoveryContext CRC;
850  CompileModuleMapData Data = { Instance, CreateModuleAction };
851  CRC.RunSafelyOnThread(&doCompileMapModule, &Data, ThreadStackSize);
852
853  // Delete the temporary module map file.
854  // FIXME: Even though we're executing under crash protection, it would still
855  // be nice to do this with RemoveFileOnSignal when we can. However, that
856  // doesn't make sense for all clients, so clean this up manually.
857  Instance.clearOutputFiles(/*EraseFiles=*/true);
858  if (!TempModuleMapFileName.empty())
859    llvm::sys::Path(TempModuleMapFileName).eraseFromDisk();
860}
861
862Module *CompilerInstance::loadModule(SourceLocation ImportLoc,
863                                     ModuleIdPath Path,
864                                     Module::NameVisibilityKind Visibility,
865                                     bool IsInclusionDirective) {
866  // If we've already handled this import, just return the cached result.
867  // This one-element cache is important to eliminate redundant diagnostics
868  // when both the preprocessor and parser see the same import declaration.
869  if (!ImportLoc.isInvalid() && LastModuleImportLoc == ImportLoc) {
870    // Make the named module visible.
871    if (LastModuleImportResult)
872      ModuleManager->makeModuleVisible(LastModuleImportResult, Visibility);
873    return LastModuleImportResult;
874  }
875
876  // Determine what file we're searching from.
877  StringRef ModuleName = Path[0].first->getName();
878  SourceLocation ModuleNameLoc = Path[0].second;
879
880  clang::Module *Module = 0;
881
882  // If we don't already have information on this module, load the module now.
883  llvm::DenseMap<const IdentifierInfo *, clang::Module *>::iterator Known
884    = KnownModules.find(Path[0].first);
885  if (Known != KnownModules.end()) {
886    // Retrieve the cached top-level module.
887    Module = Known->second;
888  } else if (ModuleName == getLangOpts().CurrentModule) {
889    // This is the module we're building.
890    Module = PP->getHeaderSearchInfo().getModuleMap().findModule(ModuleName);
891    Known = KnownModules.insert(std::make_pair(Path[0].first, Module)).first;
892  } else {
893    // Search for a module with the given name.
894    Module = PP->getHeaderSearchInfo().lookupModule(ModuleName);
895    std::string ModuleFileName;
896    if (Module)
897      ModuleFileName = PP->getHeaderSearchInfo().getModuleFileName(Module);
898    else
899      ModuleFileName = PP->getHeaderSearchInfo().getModuleFileName(ModuleName);
900
901    if (ModuleFileName.empty()) {
902      getDiagnostics().Report(ModuleNameLoc, diag::err_module_not_found)
903        << ModuleName
904        << SourceRange(ImportLoc, ModuleNameLoc);
905      LastModuleImportLoc = ImportLoc;
906      LastModuleImportResult = 0;
907      return 0;
908    }
909
910    const FileEntry *ModuleFile
911      = getFileManager().getFile(ModuleFileName, /*OpenFile=*/false,
912                                 /*CacheFailure=*/false);
913    bool BuildingModule = false;
914    if (!ModuleFile && Module) {
915      // The module is not cached, but we have a module map from which we can
916      // build the module.
917
918      // Check whether there is a cycle in the module graph.
919      SmallVectorImpl<std::string> &ModuleBuildPath
920        = getPreprocessorOpts().ModuleBuildPath;
921      SmallVectorImpl<std::string>::iterator Pos
922        = std::find(ModuleBuildPath.begin(), ModuleBuildPath.end(), ModuleName);
923      if (Pos != ModuleBuildPath.end()) {
924        SmallString<256> CyclePath;
925        for (; Pos != ModuleBuildPath.end(); ++Pos) {
926          CyclePath += *Pos;
927          CyclePath += " -> ";
928        }
929        CyclePath += ModuleName;
930
931        getDiagnostics().Report(ModuleNameLoc, diag::err_module_cycle)
932          << ModuleName << CyclePath;
933        return 0;
934      }
935
936      getDiagnostics().Report(ModuleNameLoc, diag::warn_module_build)
937        << ModuleName;
938      BuildingModule = true;
939      compileModule(*this, Module, ModuleFileName);
940      ModuleFile = FileMgr->getFile(ModuleFileName);
941    }
942
943    if (!ModuleFile) {
944      getDiagnostics().Report(ModuleNameLoc,
945                              BuildingModule? diag::err_module_not_built
946                                            : diag::err_module_not_found)
947        << ModuleName
948        << SourceRange(ImportLoc, ModuleNameLoc);
949      return 0;
950    }
951
952    // If we don't already have an ASTReader, create one now.
953    if (!ModuleManager) {
954      if (!hasASTContext())
955        createASTContext();
956
957      std::string Sysroot = getHeaderSearchOpts().Sysroot;
958      const PreprocessorOptions &PPOpts = getPreprocessorOpts();
959      ModuleManager = new ASTReader(getPreprocessor(), *Context,
960                                    Sysroot.empty() ? "" : Sysroot.c_str(),
961                                    PPOpts.DisablePCHValidation);
962      if (hasASTConsumer()) {
963        ModuleManager->setDeserializationListener(
964          getASTConsumer().GetASTDeserializationListener());
965        getASTContext().setASTMutationListener(
966          getASTConsumer().GetASTMutationListener());
967        getPreprocessor().setPPMutationListener(
968          getASTConsumer().GetPPMutationListener());
969      }
970      OwningPtr<ExternalASTSource> Source;
971      Source.reset(ModuleManager);
972      getASTContext().setExternalSource(Source);
973      if (hasSema())
974        ModuleManager->InitializeSema(getSema());
975      if (hasASTConsumer())
976        ModuleManager->StartTranslationUnit(&getASTConsumer());
977    }
978
979    // Try to load the module we found.
980    unsigned ARRFlags = ASTReader::ARR_None;
981    if (Module)
982      ARRFlags |= ASTReader::ARR_OutOfDate;
983    switch (ModuleManager->ReadAST(ModuleFile->getName(),
984                                   serialization::MK_Module,
985                                   ARRFlags)) {
986    case ASTReader::Success:
987      break;
988
989    case ASTReader::OutOfDate: {
990      // The module file is out-of-date. Rebuild it.
991      getFileManager().invalidateCache(ModuleFile);
992      bool Existed;
993      llvm::sys::fs::remove(ModuleFileName, Existed);
994      compileModule(*this, Module, ModuleFileName);
995
996      // Try loading the module again.
997      ModuleFile = FileMgr->getFile(ModuleFileName);
998      if (!ModuleFile ||
999          ModuleManager->ReadAST(ModuleFileName,
1000                                 serialization::MK_Module,
1001                                 ASTReader::ARR_None) != ASTReader::Success) {
1002        KnownModules[Path[0].first] = 0;
1003        return 0;
1004      }
1005
1006      // Okay, we've rebuilt and now loaded the module.
1007      break;
1008    }
1009
1010    case ASTReader::VersionMismatch:
1011    case ASTReader::ConfigurationMismatch:
1012    case ASTReader::HadErrors:
1013      // FIXME: The ASTReader will already have complained, but can we showhorn
1014      // that diagnostic information into a more useful form?
1015      KnownModules[Path[0].first] = 0;
1016      return 0;
1017
1018    case ASTReader::Failure:
1019      // Already complained, but note now that we failed.
1020      KnownModules[Path[0].first] = 0;
1021      return 0;
1022    }
1023
1024    if (!Module) {
1025      // If we loaded the module directly, without finding a module map first,
1026      // we'll have loaded the module's information from the module itself.
1027      Module = PP->getHeaderSearchInfo().getModuleMap()
1028                 .findModule((Path[0].first->getName()));
1029    }
1030
1031    if (Module)
1032      Module->setASTFile(ModuleFile);
1033
1034    // Cache the result of this top-level module lookup for later.
1035    Known = KnownModules.insert(std::make_pair(Path[0].first, Module)).first;
1036  }
1037
1038  // If we never found the module, fail.
1039  if (!Module)
1040    return 0;
1041
1042  // Verify that the rest of the module path actually corresponds to
1043  // a submodule.
1044  if (Path.size() > 1) {
1045    for (unsigned I = 1, N = Path.size(); I != N; ++I) {
1046      StringRef Name = Path[I].first->getName();
1047      clang::Module *Sub = Module->findSubmodule(Name);
1048
1049      if (!Sub) {
1050        // Attempt to perform typo correction to find a module name that works.
1051        llvm::SmallVector<StringRef, 2> Best;
1052        unsigned BestEditDistance = (std::numeric_limits<unsigned>::max)();
1053
1054        for (clang::Module::submodule_iterator J = Module->submodule_begin(),
1055                                            JEnd = Module->submodule_end();
1056             J != JEnd; ++J) {
1057          unsigned ED = Name.edit_distance((*J)->Name,
1058                                           /*AllowReplacements=*/true,
1059                                           BestEditDistance);
1060          if (ED <= BestEditDistance) {
1061            if (ED < BestEditDistance) {
1062              Best.clear();
1063              BestEditDistance = ED;
1064            }
1065
1066            Best.push_back((*J)->Name);
1067          }
1068        }
1069
1070        // If there was a clear winner, user it.
1071        if (Best.size() == 1) {
1072          getDiagnostics().Report(Path[I].second,
1073                                  diag::err_no_submodule_suggest)
1074            << Path[I].first << Module->getFullModuleName() << Best[0]
1075            << SourceRange(Path[0].second, Path[I-1].second)
1076            << FixItHint::CreateReplacement(SourceRange(Path[I].second),
1077                                            Best[0]);
1078
1079          Sub = Module->findSubmodule(Best[0]);
1080        }
1081      }
1082
1083      if (!Sub) {
1084        // No submodule by this name. Complain, and don't look for further
1085        // submodules.
1086        getDiagnostics().Report(Path[I].second, diag::err_no_submodule)
1087          << Path[I].first << Module->getFullModuleName()
1088          << SourceRange(Path[0].second, Path[I-1].second);
1089        break;
1090      }
1091
1092      Module = Sub;
1093    }
1094  }
1095
1096  // Make the named module visible, if it's not already part of the module
1097  // we are parsing.
1098  if (ModuleName != getLangOpts().CurrentModule) {
1099    if (!Module->IsFromModuleFile) {
1100      // We have an umbrella header or directory that doesn't actually include
1101      // all of the headers within the directory it covers. Complain about
1102      // this missing submodule and recover by forgetting that we ever saw
1103      // this submodule.
1104      // FIXME: Should we detect this at module load time? It seems fairly
1105      // expensive (and rare).
1106      getDiagnostics().Report(ImportLoc, diag::warn_missing_submodule)
1107        << Module->getFullModuleName()
1108        << SourceRange(Path.front().second, Path.back().second);
1109
1110      return 0;
1111    }
1112
1113    // Check whether this module is available.
1114    StringRef Feature;
1115    if (!Module->isAvailable(getLangOpts(), getTarget(), Feature)) {
1116      getDiagnostics().Report(ImportLoc, diag::err_module_unavailable)
1117        << Module->getFullModuleName()
1118        << Feature
1119        << SourceRange(Path.front().second, Path.back().second);
1120      LastModuleImportLoc = ImportLoc;
1121      LastModuleImportResult = 0;
1122      return 0;
1123    }
1124
1125    ModuleManager->makeModuleVisible(Module, Visibility);
1126  }
1127
1128  // If this module import was due to an inclusion directive, create an
1129  // implicit import declaration to capture it in the AST.
1130  if (IsInclusionDirective && hasASTContext()) {
1131    TranslationUnitDecl *TU = getASTContext().getTranslationUnitDecl();
1132    ImportDecl *ImportD = ImportDecl::CreateImplicit(getASTContext(), TU,
1133                                                     ImportLoc, Module,
1134                                                     Path.back().second);
1135    TU->addDecl(ImportD);
1136    if (Consumer)
1137      Consumer->HandleImplicitImportDecl(ImportD);
1138  }
1139
1140  LastModuleImportLoc = ImportLoc;
1141  LastModuleImportResult = Module;
1142  return Module;
1143}
1144