//===--- ASTUnit.cpp - ASTUnit utility ------------------------------------===// // // The LLVM Compiler Infrastructure // // This file is distributed under the University of Illinois Open Source // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// // // ASTUnit Implementation. // //===----------------------------------------------------------------------===// #include "clang/Frontend/ASTUnit.h" #include "clang/Frontend/PCHReader.h" #include "clang/AST/ASTContext.h" #include "clang/AST/ASTConsumer.h" #include "clang/AST/DeclVisitor.h" #include "clang/AST/StmtVisitor.h" #include "clang/Driver/Compilation.h" #include "clang/Driver/Driver.h" #include "clang/Driver/Job.h" #include "clang/Driver/Tool.h" #include "clang/Frontend/CompilerInstance.h" #include "clang/Frontend/FrontendActions.h" #include "clang/Frontend/FrontendDiagnostic.h" #include "clang/Frontend/FrontendOptions.h" #include "clang/Lex/HeaderSearch.h" #include "clang/Lex/Preprocessor.h" #include "clang/Basic/TargetOptions.h" #include "clang/Basic/TargetInfo.h" #include "clang/Basic/Diagnostic.h" #include "llvm/Support/MemoryBuffer.h" #include "llvm/System/Host.h" #include "llvm/System/Path.h" #include #include using namespace clang; PrecompiledPreamble::~PrecompiledPreamble() { PreambleFile.eraseFromDisk(); } ASTUnit::ASTUnit(bool _MainFileIsAST) : CaptureDiagnostics(false), MainFileIsAST(_MainFileIsAST), ConcurrencyCheckValue(CheckUnlocked) { } ASTUnit::~ASTUnit() { ConcurrencyCheckValue = CheckLocked; CleanTemporaryFiles(); } void ASTUnit::CleanTemporaryFiles() { for (unsigned I = 0, N = TemporaryFiles.size(); I != N; ++I) TemporaryFiles[I].eraseFromDisk(); TemporaryFiles.clear(); } namespace { /// \brief Gathers information from PCHReader that will be used to initialize /// a Preprocessor. class PCHInfoCollector : public PCHReaderListener { LangOptions &LangOpt; HeaderSearch &HSI; std::string &TargetTriple; std::string &Predefines; unsigned &Counter; unsigned NumHeaderInfos; public: PCHInfoCollector(LangOptions &LangOpt, HeaderSearch &HSI, std::string &TargetTriple, std::string &Predefines, unsigned &Counter) : LangOpt(LangOpt), HSI(HSI), TargetTriple(TargetTriple), Predefines(Predefines), Counter(Counter), NumHeaderInfos(0) {} virtual bool ReadLanguageOptions(const LangOptions &LangOpts) { LangOpt = LangOpts; return false; } virtual bool ReadTargetTriple(llvm::StringRef Triple) { TargetTriple = Triple; return false; } virtual bool ReadPredefinesBuffer(const PCHPredefinesBlocks &Buffers, llvm::StringRef OriginalFileName, std::string &SuggestedPredefines) { Predefines = Buffers[0].Data; for (unsigned I = 1, N = Buffers.size(); I != N; ++I) { Predefines += Buffers[I].Data; } return false; } virtual void ReadHeaderFileInfo(const HeaderFileInfo &HFI, unsigned ID) { HSI.setHeaderFileInfoForUID(HFI, NumHeaderInfos++); } virtual void ReadCounter(unsigned Value) { Counter = Value; } }; class StoredDiagnosticClient : public DiagnosticClient { llvm::SmallVectorImpl &StoredDiags; public: explicit StoredDiagnosticClient( llvm::SmallVectorImpl &StoredDiags) : StoredDiags(StoredDiags) { } virtual void HandleDiagnostic(Diagnostic::Level Level, const DiagnosticInfo &Info); }; /// \brief RAII object that optionally captures diagnostics, if /// there is no diagnostic client to capture them already. class CaptureDroppedDiagnostics { Diagnostic &Diags; StoredDiagnosticClient Client; DiagnosticClient *PreviousClient; public: CaptureDroppedDiagnostics(bool RequestCapture, Diagnostic &Diags, llvm::SmallVectorImpl &StoredDiags) : Diags(Diags), Client(StoredDiags), PreviousClient(Diags.getClient()) { if (RequestCapture || Diags.getClient() == 0) Diags.setClient(&Client); } ~CaptureDroppedDiagnostics() { Diags.setClient(PreviousClient); } }; } // anonymous namespace void StoredDiagnosticClient::HandleDiagnostic(Diagnostic::Level Level, const DiagnosticInfo &Info) { StoredDiags.push_back(StoredDiagnostic(Level, Info)); } const std::string &ASTUnit::getOriginalSourceFileName() { return OriginalSourceFile; } const std::string &ASTUnit::getPCHFileName() { assert(isMainFileAST() && "Not an ASTUnit from a PCH file!"); return static_cast(Ctx->getExternalSource())->getFileName(); } ASTUnit *ASTUnit::LoadFromPCHFile(const std::string &Filename, llvm::IntrusiveRefCntPtr Diags, bool OnlyLocalDecls, RemappedFile *RemappedFiles, unsigned NumRemappedFiles, bool CaptureDiagnostics) { llvm::OwningPtr AST(new ASTUnit(true)); if (!Diags.getPtr()) { // No diagnostics engine was provided, so create our own diagnostics object // with the default options. DiagnosticOptions DiagOpts; Diags = CompilerInstance::createDiagnostics(DiagOpts, 0, 0); } AST->CaptureDiagnostics = CaptureDiagnostics; AST->OnlyLocalDecls = OnlyLocalDecls; AST->Diagnostics = Diags; AST->FileMgr.reset(new FileManager); AST->SourceMgr.reset(new SourceManager(AST->getDiagnostics())); AST->HeaderInfo.reset(new HeaderSearch(AST->getFileManager())); // If requested, capture diagnostics in the ASTUnit. CaptureDroppedDiagnostics Capture(CaptureDiagnostics, AST->getDiagnostics(), AST->StoredDiagnostics); for (unsigned I = 0; I != NumRemappedFiles; ++I) { // Create the file entry for the file that we're mapping from. const FileEntry *FromFile = AST->getFileManager().getVirtualFile(RemappedFiles[I].first, RemappedFiles[I].second->getBufferSize(), 0); if (!FromFile) { AST->getDiagnostics().Report(diag::err_fe_remap_missing_from_file) << RemappedFiles[I].first; delete RemappedFiles[I].second; continue; } // Override the contents of the "from" file with the contents of // the "to" file. AST->getSourceManager().overrideFileContents(FromFile, RemappedFiles[I].second); } // Gather Info for preprocessor construction later on. LangOptions LangInfo; HeaderSearch &HeaderInfo = *AST->HeaderInfo.get(); std::string TargetTriple; std::string Predefines; unsigned Counter; llvm::OwningPtr Reader; llvm::OwningPtr Source; Reader.reset(new PCHReader(AST->getSourceManager(), AST->getFileManager(), AST->getDiagnostics())); Reader->setListener(new PCHInfoCollector(LangInfo, HeaderInfo, TargetTriple, Predefines, Counter)); switch (Reader->ReadPCH(Filename)) { case PCHReader::Success: break; case PCHReader::Failure: case PCHReader::IgnorePCH: AST->getDiagnostics().Report(diag::err_fe_unable_to_load_pch); return NULL; } AST->OriginalSourceFile = Reader->getOriginalSourceFile(); // PCH loaded successfully. Now create the preprocessor. // Get information about the target being compiled for. // // FIXME: This is broken, we should store the TargetOptions in the PCH. TargetOptions TargetOpts; TargetOpts.ABI = ""; TargetOpts.CXXABI = "itanium"; TargetOpts.CPU = ""; TargetOpts.Features.clear(); TargetOpts.Triple = TargetTriple; AST->Target.reset(TargetInfo::CreateTargetInfo(AST->getDiagnostics(), TargetOpts)); AST->PP.reset(new Preprocessor(AST->getDiagnostics(), LangInfo, *AST->Target.get(), AST->getSourceManager(), HeaderInfo)); Preprocessor &PP = *AST->PP.get(); PP.setPredefines(Reader->getSuggestedPredefines()); PP.setCounterValue(Counter); Reader->setPreprocessor(PP); // Create and initialize the ASTContext. AST->Ctx.reset(new ASTContext(LangInfo, AST->getSourceManager(), *AST->Target.get(), PP.getIdentifierTable(), PP.getSelectorTable(), PP.getBuiltinInfo(), /* FreeMemory = */ false, /* size_reserve = */0)); ASTContext &Context = *AST->Ctx.get(); Reader->InitializeContext(Context); // Attach the PCH reader to the AST context as an external AST // source, so that declarations will be deserialized from the // PCH file as needed. Source.reset(Reader.take()); Context.setExternalSource(Source); return AST.take(); } namespace { class TopLevelDeclTrackerConsumer : public ASTConsumer { ASTUnit &Unit; public: TopLevelDeclTrackerConsumer(ASTUnit &_Unit) : Unit(_Unit) {} void HandleTopLevelDecl(DeclGroupRef D) { for (DeclGroupRef::iterator it = D.begin(), ie = D.end(); it != ie; ++it) { Decl *D = *it; // FIXME: Currently ObjC method declarations are incorrectly being // reported as top-level declarations, even though their DeclContext // is the containing ObjC @interface/@implementation. This is a // fundamental problem in the parser right now. if (isa(D)) continue; Unit.getTopLevelDecls().push_back(D); } } }; class TopLevelDeclTrackerAction : public ASTFrontendAction { public: ASTUnit &Unit; virtual ASTConsumer *CreateASTConsumer(CompilerInstance &CI, llvm::StringRef InFile) { return new TopLevelDeclTrackerConsumer(Unit); } public: TopLevelDeclTrackerAction(ASTUnit &_Unit) : Unit(_Unit) {} virtual bool hasCodeCompletionSupport() const { return false; } }; } /// Parse the source file into a translation unit using the given compiler /// invocation, replacing the current translation unit. /// /// \returns True if a failure occurred that causes the ASTUnit not to /// contain any translation-unit information, false otherwise. bool ASTUnit::Parse() { if (!Invocation.get()) return true; // Create the compiler instance to use for building the AST. CompilerInstance Clang; Clang.setInvocation(Invocation.take()); OriginalSourceFile = Clang.getFrontendOpts().Inputs[0].second; // Set up diagnostics. Clang.setDiagnostics(&getDiagnostics()); Clang.setDiagnosticClient(getDiagnostics().getClient()); // Create the target instance. Clang.setTarget(TargetInfo::CreateTargetInfo(Clang.getDiagnostics(), Clang.getTargetOpts())); if (!Clang.hasTarget()) { Clang.takeDiagnosticClient(); return true; } // Inform the target of the language options. // // FIXME: We shouldn't need to do this, the target should be immutable once // created. This complexity should be lifted elsewhere. Clang.getTarget().setForcedLangOptions(Clang.getLangOpts()); assert(Clang.getFrontendOpts().Inputs.size() == 1 && "Invocation must have exactly one source file!"); assert(Clang.getFrontendOpts().Inputs[0].first != IK_AST && "FIXME: AST inputs not yet supported here!"); assert(Clang.getFrontendOpts().Inputs[0].first != IK_LLVM_IR && "IR inputs not support here!"); // Configure the various subsystems. // FIXME: Should we retain the previous file manager? FileMgr.reset(new FileManager); SourceMgr.reset(new SourceManager(getDiagnostics())); Ctx.reset(); PP.reset(); // Clear out old caches and data. TopLevelDecls.clear(); StoredDiagnostics.clear(); CleanTemporaryFiles(); PreprocessedEntitiesByFile.clear(); // Capture any diagnostics that would otherwise be dropped. CaptureDroppedDiagnostics Capture(CaptureDiagnostics, Clang.getDiagnostics(), StoredDiagnostics); // Create a file manager object to provide access to and cache the filesystem. Clang.setFileManager(&getFileManager()); // Create the source manager. Clang.setSourceManager(&getSourceManager()); llvm::OwningPtr Act; Act.reset(new TopLevelDeclTrackerAction(*this)); if (!Act->BeginSourceFile(Clang, Clang.getFrontendOpts().Inputs[0].second, Clang.getFrontendOpts().Inputs[0].first)) goto error; Act->Execute(); // Steal the created target, context, and preprocessor, and take back the // source and file managers. Ctx.reset(Clang.takeASTContext()); PP.reset(Clang.takePreprocessor()); Clang.takeSourceManager(); Clang.takeFileManager(); Target.reset(Clang.takeTarget()); Act->EndSourceFile(); Clang.takeDiagnosticClient(); Invocation.reset(Clang.takeInvocation()); return false; error: Clang.takeSourceManager(); Clang.takeFileManager(); Clang.takeDiagnosticClient(); Invocation.reset(Clang.takeInvocation()); return true; } /// \brief Simple function to retrieve a path for a preamble precompiled header. static std::string GetPreamblePCHPath() { // FIXME: This is lame; sys::Path should provide this function (in particular, // it should know how to find the temporary files dir). // FIXME: This is really lame. I copied this code from the Driver! std::string Error; const char *TmpDir = ::getenv("TMPDIR"); if (!TmpDir) TmpDir = ::getenv("TEMP"); if (!TmpDir) TmpDir = ::getenv("TMP"); if (!TmpDir) TmpDir = "/tmp"; llvm::sys::Path P(TmpDir); P.appendComponent("preamble"); if (P.createTemporaryFileOnDisk()) return std::string(); P.appendSuffix("pch"); return P.str(); } void ASTUnit::BuildPrecompiledPreamble() { CompilerInvocation PreambleInvocation(*Invocation); FrontendOptions &FrontendOpts = PreambleInvocation.getFrontendOpts(); PreprocessorOptions &PreprocessorOpts = PreambleInvocation.getPreprocessorOpts(); // Try to determine if the main file has been remapped, either from the // command line (to another file) or directly through the compiler invocation // (to a memory buffer). llvm::MemoryBuffer *Buffer = 0; llvm::sys::PathWithStatus MainFilePath(FrontendOpts.Inputs[0].second); if (const llvm::sys::FileStatus *MainFileStatus = MainFilePath.getFileStatus()) { // Check whether there is a file-file remapping of the main file for (PreprocessorOptions::remapped_file_iterator M = PreprocessorOpts.remapped_file_begin(), E = PreprocessorOpts.remapped_file_end(); M != E; ++M) { llvm::sys::PathWithStatus MPath(M->first); if (const llvm::sys::FileStatus *MStatus = MPath.getFileStatus()) { if (MainFileStatus->uniqueID == MStatus->uniqueID) { // We found a remapping. Try to load the resulting, remapped source. if (Buffer) delete Buffer; Buffer = llvm::MemoryBuffer::getFile(M->second); if (!Buffer) return; // Remove the file-file remapping. M = PreprocessorOpts.eraseRemappedFile(M); E = PreprocessorOpts.remapped_file_end(); } } } // Check whether there is a file-buffer remapping. It supercedes the // file-file remapping. for (PreprocessorOptions::remapped_file_buffer_iterator M = PreprocessorOpts.remapped_file_buffer_begin(), E = PreprocessorOpts.remapped_file_buffer_end(); M != E; ++M) { llvm::sys::PathWithStatus MPath(M->first); if (const llvm::sys::FileStatus *MStatus = MPath.getFileStatus()) { if (MainFileStatus->uniqueID == MStatus->uniqueID) { // We found a remapping. if (Buffer) delete Buffer; Buffer = const_cast(M->second); // Remove the file-buffer remapping. M = PreprocessorOpts.eraseRemappedFile(M); E = PreprocessorOpts.remapped_file_buffer_end(); } } } } // If the main source file was not remapped, load it now. if (!Buffer) { Buffer = llvm::MemoryBuffer::getFile(FrontendOpts.Inputs[0].second); if (!Buffer) return; } // Try to compute the preamble. unsigned PreambleLength = Lexer::ComputePreamble(Buffer); if (PreambleLength == 0) return; // Create a new buffer that stores the preamble. The buffer also contains // extra space for the original contents of the file (which will be present // when we actually parse the file) along with more room in case the file // grows. unsigned PreambleBufferSize = Buffer->getBufferSize(); if (PreambleBufferSize < 4096) PreambleBufferSize = 8192; else PreambleBufferSize *= 2; llvm::MemoryBuffer *PreambleBuffer = llvm::MemoryBuffer::getNewUninitMemBuffer(PreambleBufferSize, FrontendOpts.Inputs[0].second); memcpy(const_cast(PreambleBuffer->getBufferStart()), Buffer->getBufferStart(), PreambleLength); memset(const_cast(PreambleBuffer->getBufferStart()) + PreambleLength, ' ', PreambleBufferSize - PreambleLength - 1); const_cast(PreambleBuffer->getBufferEnd())[-1] = 0; delete Buffer; // Remap the main source file to the preamble buffer. PreprocessorOpts.addRemappedFile(MainFilePath.str(), PreambleBuffer); // Tell the compiler invocation to generate a temporary precompiled header. FrontendOpts.ProgramAction = frontend::GeneratePCH; // FIXME: Set ChainedPCH, once it is ready. // FIXME: Generate the precompiled header into memory? FrontendOpts.OutputFile = GetPreamblePCHPath(); // Create the compiler instance to use for building the precompiled preamble. CompilerInstance Clang; Clang.setInvocation(&PreambleInvocation); OriginalSourceFile = Clang.getFrontendOpts().Inputs[0].second; // Set up diagnostics. Clang.setDiagnostics(&getDiagnostics()); Clang.setDiagnosticClient(getDiagnostics().getClient()); // Create the target instance. Clang.setTarget(TargetInfo::CreateTargetInfo(Clang.getDiagnostics(), Clang.getTargetOpts())); if (!Clang.hasTarget()) { Clang.takeDiagnosticClient(); return; } // Inform the target of the language options. // // FIXME: We shouldn't need to do this, the target should be immutable once // created. This complexity should be lifted elsewhere. Clang.getTarget().setForcedLangOptions(Clang.getLangOpts()); assert(Clang.getFrontendOpts().Inputs.size() == 1 && "Invocation must have exactly one source file!"); assert(Clang.getFrontendOpts().Inputs[0].first != IK_AST && "FIXME: AST inputs not yet supported here!"); assert(Clang.getFrontendOpts().Inputs[0].first != IK_LLVM_IR && "IR inputs not support here!"); // Clear out old caches and data. StoredDiagnostics.clear(); // Capture any diagnostics that would otherwise be dropped. CaptureDroppedDiagnostics Capture(CaptureDiagnostics, Clang.getDiagnostics(), StoredDiagnostics); // Create a file manager object to provide access to and cache the filesystem. Clang.setFileManager(new FileManager); // Create the source manager. Clang.setSourceManager(new SourceManager(getDiagnostics())); // FIXME: Eventually, we'll have to track top-level declarations here, too. llvm::OwningPtr Act; Act.reset(new GeneratePCHAction); if (!Act->BeginSourceFile(Clang, Clang.getFrontendOpts().Inputs[0].second, Clang.getFrontendOpts().Inputs[0].first)) { Clang.takeDiagnosticClient(); Clang.takeInvocation(); return; } Act->Execute(); Act->EndSourceFile(); Clang.takeDiagnosticClient(); Clang.takeInvocation(); // FIXME: Keep track of the actual preamble header we created! fprintf(stderr, "Preamble PCH: %s\n", FrontendOpts.OutputFile.c_str()); } ASTUnit *ASTUnit::LoadFromCompilerInvocation(CompilerInvocation *CI, llvm::IntrusiveRefCntPtr Diags, bool OnlyLocalDecls, bool CaptureDiagnostics, bool PrecompilePreamble) { if (!Diags.getPtr()) { // No diagnostics engine was provided, so create our own diagnostics object // with the default options. DiagnosticOptions DiagOpts; Diags = CompilerInstance::createDiagnostics(DiagOpts, 0, 0); } // Create the AST unit. llvm::OwningPtr AST; AST.reset(new ASTUnit(false)); AST->Diagnostics = Diags; AST->CaptureDiagnostics = CaptureDiagnostics; AST->OnlyLocalDecls = OnlyLocalDecls; AST->Invocation.reset(CI); if (PrecompilePreamble) AST->BuildPrecompiledPreamble(); if (!AST->Parse()) return AST.take(); return 0; } ASTUnit *ASTUnit::LoadFromCommandLine(const char **ArgBegin, const char **ArgEnd, llvm::IntrusiveRefCntPtr Diags, llvm::StringRef ResourceFilesPath, bool OnlyLocalDecls, RemappedFile *RemappedFiles, unsigned NumRemappedFiles, bool CaptureDiagnostics, bool PrecompilePreamble) { if (!Diags.getPtr()) { // No diagnostics engine was provided, so create our own diagnostics object // with the default options. DiagnosticOptions DiagOpts; Diags = CompilerInstance::createDiagnostics(DiagOpts, 0, 0); } llvm::SmallVector Args; Args.push_back(""); // FIXME: Remove dummy argument. Args.insert(Args.end(), ArgBegin, ArgEnd); // FIXME: Find a cleaner way to force the driver into restricted modes. We // also want to force it to use clang. Args.push_back("-fsyntax-only"); // FIXME: We shouldn't have to pass in the path info. driver::Driver TheDriver("clang", llvm::sys::getHostTriple(), "a.out", false, false, *Diags); // Don't check that inputs exist, they have been remapped. TheDriver.setCheckInputsExist(false); llvm::OwningPtr C( TheDriver.BuildCompilation(Args.size(), Args.data())); // We expect to get back exactly one command job, if we didn't something // failed. const driver::JobList &Jobs = C->getJobs(); if (Jobs.size() != 1 || !isa(Jobs.begin())) { llvm::SmallString<256> Msg; llvm::raw_svector_ostream OS(Msg); C->PrintJob(OS, C->getJobs(), "; ", true); Diags->Report(diag::err_fe_expected_compiler_job) << OS.str(); return 0; } const driver::Command *Cmd = cast(*Jobs.begin()); if (llvm::StringRef(Cmd->getCreator().getName()) != "clang") { Diags->Report(diag::err_fe_expected_clang_command); return 0; } const driver::ArgStringList &CCArgs = Cmd->getArguments(); llvm::OwningPtr CI(new CompilerInvocation); CompilerInvocation::CreateFromArgs(*CI, const_cast(CCArgs.data()), const_cast(CCArgs.data()) + CCArgs.size(), *Diags); // Override any files that need remapping for (unsigned I = 0; I != NumRemappedFiles; ++I) CI->getPreprocessorOpts().addRemappedFile(RemappedFiles[I].first, RemappedFiles[I].second); // Override the resources path. CI->getHeaderSearchOpts().ResourceDir = ResourceFilesPath; CI->getFrontendOpts().DisableFree = true; return LoadFromCompilerInvocation(CI.take(), Diags, OnlyLocalDecls, CaptureDiagnostics, PrecompilePreamble); } bool ASTUnit::Reparse(RemappedFile *RemappedFiles, unsigned NumRemappedFiles) { if (!Invocation.get()) return true; // Clear out the diagnostics state. getDiagnostics().Reset(); // Remap files. Invocation->getPreprocessorOpts().clearRemappedFiles(); for (unsigned I = 0; I != NumRemappedFiles; ++I) Invocation->getPreprocessorOpts().addRemappedFile(RemappedFiles[I].first, RemappedFiles[I].second); return Parse(); }