From d3b74d9ca4f239a7a90ad193378c494306c57352 Mon Sep 17 00:00:00 2001 From: Ted Kremenek Date: Thu, 17 Nov 2011 23:01:24 +0000 Subject: [PATCH] Make 'LangOptions' in CompilerInvocation a heap-allocated, reference counted object. I discovered that llvm::RefCountedBase has a bug where the reference count is copied in the copy constructor, which means that there were cases when the CompilerInvocation objects created by ASTUnit were actually leaked. When I fixed that bug locally, it showed that a whole bunch of code assumed that the LangOptions object that was part of CompilerInvocation was still alive. By making it heap-allocated and reference counted, we can keep it around after the CompilerInvocation object goes away. As part of this change, change CompilerInvocation:getLangOptions() to return a pointer, acting as another clue that this object may outlive the CompilerInvocation object. This commit doesn't fix the CompilerInvocation leak itself. That will come when I commit the fix to llvm::RefCountedBase to mainline LLVM. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@144930 91177308-0d34-0410-b5e6-96231b3b80d8 --- include/clang/Basic/LangOptions.h | 3 ++- include/clang/Frontend/ASTUnit.h | 2 ++ include/clang/Frontend/CompilerInstance.h | 4 ++-- include/clang/Frontend/CompilerInvocation.h | 12 +++++----- lib/ARCMigrate/ARCMT.cpp | 23 ++++++++++--------- lib/Frontend/ASTUnit.cpp | 5 +++-- lib/Frontend/CompilerInstance.cpp | 6 ++--- lib/Frontend/CompilerInvocation.cpp | 25 ++++++++++++++++----- tools/arcmt-test/arcmt-test.cpp | 6 ++--- tools/libclang/Indexing.cpp | 2 +- 10 files changed, 55 insertions(+), 33 deletions(-) diff --git a/include/clang/Basic/LangOptions.h b/include/clang/Basic/LangOptions.h index 35c0ade7ec..7275f6655e 100644 --- a/include/clang/Basic/LangOptions.h +++ b/include/clang/Basic/LangOptions.h @@ -16,12 +16,13 @@ #include #include "clang/Basic/Visibility.h" +#include "llvm/ADT/IntrusiveRefCntPtr.h" namespace clang { /// LangOptions - This class keeps track of the various options that can be /// enabled, which controls the dialect of C that is accepted. -class LangOptions { +class LangOptions : public llvm::RefCountedBase { public: typedef clang::Visibility Visibility; diff --git a/include/clang/Frontend/ASTUnit.h b/include/clang/Frontend/ASTUnit.h index 26828a4427..ae192fa7c3 100644 --- a/include/clang/Frontend/ASTUnit.h +++ b/include/clang/Frontend/ASTUnit.h @@ -20,6 +20,7 @@ #include "clang/Sema/CodeCompleteConsumer.h" #include "clang/Lex/ModuleLoader.h" #include "clang/Lex/PreprocessingRecord.h" +#include "clang/Basic/LangOptions.h" #include "clang/Basic/SourceManager.h" #include "clang/Basic/FileManager.h" #include "clang/Basic/FileSystemOptions.h" @@ -69,6 +70,7 @@ class GlobalCodeCompletionAllocator /// class ASTUnit : public ModuleLoader { private: + llvm::IntrusiveRefCntPtr LangOpts; llvm::IntrusiveRefCntPtr Diagnostics; llvm::IntrusiveRefCntPtr FileMgr; llvm::IntrusiveRefCntPtr SourceMgr; diff --git a/include/clang/Frontend/CompilerInstance.h b/include/clang/Frontend/CompilerInstance.h index 881774022d..639c2f68d3 100644 --- a/include/clang/Frontend/CompilerInstance.h +++ b/include/clang/Frontend/CompilerInstance.h @@ -218,10 +218,10 @@ public: } LangOptions &getLangOpts() { - return Invocation->getLangOpts(); + return *Invocation->getLangOpts(); } const LangOptions &getLangOpts() const { - return Invocation->getLangOpts(); + return *Invocation->getLangOpts(); } PreprocessorOptions &getPreprocessorOpts() { diff --git a/include/clang/Frontend/CompilerInvocation.h b/include/clang/Frontend/CompilerInvocation.h index 47c70311dd..10cb4bc935 100644 --- a/include/clang/Frontend/CompilerInvocation.h +++ b/include/clang/Frontend/CompilerInvocation.h @@ -61,7 +61,7 @@ class CompilerInvocation : public llvm::RefCountedBase { HeaderSearchOptions HeaderSearchOpts; /// Options controlling the language variant. - LangOptions LangOpts; + llvm::IntrusiveRefCntPtr LangOpts; /// Options controlling the preprocessor (aside from #include handling). PreprocessorOptions PreprocessorOpts; @@ -73,7 +73,7 @@ class CompilerInvocation : public llvm::RefCountedBase { TargetOptions TargetOpts; public: - CompilerInvocation() {} + CompilerInvocation(); /// @name Utility Methods /// @{ @@ -111,7 +111,7 @@ public: /// \param LangStd - The input language standard. void setLangDefaults(InputKind IK, LangStandard::Kind LangStd = LangStandard::lang_unspecified) { - setLangDefaults(LangOpts, IK, LangStd); + setLangDefaults(*LangOpts, IK, LangStd); } /// setLangDefaults - Set language defaults for the given input language and @@ -166,8 +166,10 @@ public: return FrontendOpts; } - LangOptions &getLangOpts() { return LangOpts; } - const LangOptions &getLangOpts() const { return LangOpts; } + LangOptions *getLangOpts() { return LangOpts.getPtr(); } + const LangOptions *getLangOpts() const { return LangOpts.getPtr(); } + + void setLangOpts(LangOptions *LangOpts); PreprocessorOptions &getPreprocessorOpts() { return PreprocessorOpts; } const PreprocessorOptions &getPreprocessorOpts() const { diff --git a/lib/ARCMigrate/ARCMT.cpp b/lib/ARCMigrate/ARCMT.cpp index f35f2577ed..06bc6b8c04 100644 --- a/lib/ARCMigrate/ARCMT.cpp +++ b/lib/ARCMigrate/ARCMT.cpp @@ -190,13 +190,14 @@ createInvocationForMigration(CompilerInvocation &origCI) { CInvok->getPreprocessorOpts().ImplicitPTHInclude = std::string(); std::string define = getARCMTMacroName(); define += '='; + CInvok->setLangOpts(new LangOptions(*CInvok->getLangOpts())); CInvok->getPreprocessorOpts().addMacroDef(define); - CInvok->getLangOpts().ObjCAutoRefCount = true; - CInvok->getLangOpts().setGC(LangOptions::NonGC); + CInvok->getLangOpts()->ObjCAutoRefCount = true; + CInvok->getLangOpts()->setGC(LangOptions::NonGC); CInvok->getDiagnosticOpts().ErrorLimit = 0; CInvok->getDiagnosticOpts().Warnings.push_back( "error=arc-unsafe-retained-assign"); - CInvok->getLangOpts().ObjCRuntimeHasWeak = HasARCRuntime(origCI); + CInvok->getLangOpts()->ObjCRuntimeHasWeak = HasARCRuntime(origCI); return CInvok.take(); } @@ -224,10 +225,10 @@ bool arcmt::checkForManualIssues(CompilerInvocation &origCI, DiagnosticConsumer *DiagClient, bool emitPremigrationARCErrors, StringRef plistOut) { - if (!origCI.getLangOpts().ObjC1) + if (!origCI.getLangOpts()->ObjC1) return false; - LangOptions::GCMode OrigGCMode = origCI.getLangOpts().getGC(); + LangOptions::GCMode OrigGCMode = origCI.getLangOpts()->getGC(); std::vector transforms = arcmt::getAllTransformations(OrigGCMode); assert(!transforms.empty()); @@ -301,7 +302,7 @@ bool arcmt::checkForManualIssues(CompilerInvocation &origCI, // If we are migrating code that gets the '-fobjc-arc' flag, make sure // to remove it so that we don't get errors from normal compilation. - origCI.getLangOpts().ObjCAutoRefCount = false; + origCI.getLangOpts()->ObjCAutoRefCount = false; return capturedDiags.hasErrors() || testAct.hasReportedErrors(); } @@ -316,10 +317,10 @@ static bool applyTransforms(CompilerInvocation &origCI, StringRef outputDir, bool emitPremigrationARCErrors, StringRef plistOut) { - if (!origCI.getLangOpts().ObjC1) + if (!origCI.getLangOpts()->ObjC1) return false; - LangOptions::GCMode OrigGCMode = origCI.getLangOpts().getGC(); + LangOptions::GCMode OrigGCMode = origCI.getLangOpts()->getGC(); // Make sure checking is successful first. CompilerInvocation CInvokForCheck(origCI); @@ -346,12 +347,12 @@ static bool applyTransforms(CompilerInvocation &origCI, new DiagnosticsEngine(DiagID, DiagClient, /*ShouldOwnClient=*/false)); if (outputDir.empty()) { - origCI.getLangOpts().ObjCAutoRefCount = true; + origCI.getLangOpts()->ObjCAutoRefCount = true; return migration.getRemapper().overwriteOriginal(*Diags); } else { // If we are migrating code that gets the '-fobjc-arc' flag, make sure // to remove it so that we don't get errors from normal compilation. - origCI.getLangOpts().ObjCAutoRefCount = false; + origCI.getLangOpts()->ObjCAutoRefCount = false; return migration.getRemapper().flushToDisk(outputDir, *Diags); } } @@ -542,7 +543,7 @@ bool MigrationProcess::applyTransform(TransformFn trans, Rewriter rewriter(Ctx.getSourceManager(), Ctx.getLangOptions()); TransformActions TA(*Diags, capturedDiags, Ctx, Unit->getPreprocessor()); - MigrationPass pass(Ctx, OrigCI.getLangOpts().getGC(), + MigrationPass pass(Ctx, OrigCI.getLangOpts()->getGC(), Unit->getSema(), TA, ARCMTMacroLocs); trans(pass); diff --git a/lib/Frontend/ASTUnit.cpp b/lib/Frontend/ASTUnit.cpp index e2544027b5..c59f2d16d2 100644 --- a/lib/Frontend/ASTUnit.cpp +++ b/lib/Frontend/ASTUnit.cpp @@ -1041,6 +1041,7 @@ bool ASTUnit::Parse(llvm::MemoryBuffer *OverrideMainBuffer) { // Configure the various subsystems. // FIXME: Should we retain the previous file manager? + LangOpts = &Clang->getLangOpts(); FileSystemOpts = Clang->getFileSystemOpts(); FileMgr = new FileManager(FileSystemOpts); SourceMgr = new SourceManager(getDiagnostics(), *FileMgr); @@ -1247,7 +1248,7 @@ ASTUnit::ComputePreamble(CompilerInvocation &Invocation, } return std::make_pair(Buffer, Lexer::ComputePreamble(Buffer, - Invocation.getLangOpts(), + *Invocation.getLangOpts(), MaxLines)); } @@ -2230,7 +2231,7 @@ void ASTUnit::CodeComplete(StringRef File, unsigned Line, unsigned Column, FrontendOpts.CodeCompletionAt.Column = Column; // Set the language options appropriately. - LangOpts = CCInvocation->getLangOpts(); + LangOpts = *CCInvocation->getLangOpts(); llvm::OwningPtr Clang(new CompilerInstance()); diff --git a/lib/Frontend/CompilerInstance.cpp b/lib/Frontend/CompilerInstance.cpp index ea2c3bd6c6..838a0675f2 100644 --- a/lib/Frontend/CompilerInstance.cpp +++ b/lib/Frontend/CompilerInstance.cpp @@ -987,11 +987,11 @@ static void compileModule(CompilerInstance &ImportingInstance, // For any options that aren't intended to affect how a module is built, // reset them to their default values. - Invocation->getLangOpts().resetNonModularOptions(); + Invocation->getLangOpts()->resetNonModularOptions(); Invocation->getPreprocessorOpts().resetNonModularOptions(); // Note the name of the module we're building. - Invocation->getLangOpts().CurrentModule = ModuleName; + Invocation->getLangOpts()->CurrentModule = ModuleName; // Note that this module is part of the module build path, so that we // can detect cycles in the module graph. @@ -1004,7 +1004,7 @@ static void compileModule(CompilerInstance &ImportingInstance, FrontendOpts.DisableFree = false; FrontendOpts.Inputs.clear(); FrontendOpts.Inputs.push_back( - std::make_pair(getSourceInputKindFromOptions(Invocation->getLangOpts()), + std::make_pair(getSourceInputKindFromOptions(*Invocation->getLangOpts()), UmbrellaHeader)); Invocation->getDiagnosticOpts().VerifyDiagnostics = 0; diff --git a/lib/Frontend/CompilerInvocation.cpp b/lib/Frontend/CompilerInvocation.cpp index 1fd967ffcc..13be408141 100644 --- a/lib/Frontend/CompilerInvocation.cpp +++ b/lib/Frontend/CompilerInvocation.cpp @@ -30,6 +30,21 @@ #include "llvm/Support/Path.h" using namespace clang; +//===----------------------------------------------------------------------===// +// Initialization. +//===----------------------------------------------------------------------===// + +CompilerInvocation::CompilerInvocation() + : LangOpts(new LangOptions()) {} + +void CompilerInvocation::setLangOpts(LangOptions *LOpts) { + LangOpts = LOpts; +} + +//===----------------------------------------------------------------------===// +// Utility functions. +//===----------------------------------------------------------------------===// + static const char *getAnalysisStoreName(AnalysisStores Kind) { switch (Kind) { default: @@ -892,7 +907,7 @@ void CompilerInvocation::toArgs(std::vector &Res) { FileSystemOptsToArgs(getFileSystemOpts(), Res); FrontendOptsToArgs(getFrontendOpts(), Res); HeaderSearchOptsToArgs(getHeaderSearchOpts(), Res); - LangOptsToArgs(getLangOpts(), Res); + LangOptsToArgs(*getLangOpts(), Res); PreprocessorOptsToArgs(getPreprocessorOpts(), Res); PreprocessorOutputOptsToArgs(getPreprocessorOutputOpts(), Res); TargetOptsToArgs(getTargetOpts(), Res); @@ -1982,9 +1997,9 @@ void CompilerInvocation::CreateFromArgs(CompilerInvocation &Res, ParseCodeGenArgs(Res.getCodeGenOpts(), *Args, DashX, Diags); ParseHeaderSearchArgs(Res.getHeaderSearchOpts(), *Args); if (DashX != IK_AST && DashX != IK_LLVM_IR) { - ParseLangArgs(Res.getLangOpts(), *Args, DashX, Diags); + ParseLangArgs(*Res.getLangOpts(), *Args, DashX, Diags); if (Res.getFrontendOpts().ProgramAction == frontend::RewriteObjC) - Res.getLangOpts().ObjCExceptions = 1; + Res.getLangOpts()->ObjCExceptions = 1; } // FIXME: ParsePreprocessorArgs uses the FileManager to read the contents of // PCH file and find the original header name. Remove the need to do that in @@ -2057,9 +2072,9 @@ std::string CompilerInvocation::getModuleHash() const { // Extend the signature with the language options #define LANGOPT(Name, Bits, Default, Description) \ - Signature.add(LangOpts.Name, Bits); + Signature.add(LangOpts->Name, Bits); #define ENUM_LANGOPT(Name, Type, Bits, Default, Description) \ - Signature.add(static_cast(LangOpts.get##Name()), Bits); + Signature.add(static_cast(LangOpts->get##Name()), Bits); #define BENIGN_LANGOPT(Name, Bits, Default, Description) #define BENIGN_ENUM_LANGOPT(Name, Type, Bits, Default, Description) #include "clang/Basic/LangOptions.def" diff --git a/tools/arcmt-test/arcmt-test.cpp b/tools/arcmt-test/arcmt-test.cpp index e47e815d35..3f91fcf124 100644 --- a/tools/arcmt-test/arcmt-test.cpp +++ b/tools/arcmt-test/arcmt-test.cpp @@ -125,7 +125,7 @@ static bool checkForMigration(StringRef resourcesPath, return true; } - if (!CI.getLangOpts().ObjC1) + if (!CI.getLangOpts()->ObjC1) return false; arcmt::checkForManualIssues(CI, @@ -167,13 +167,13 @@ static bool performTransformations(StringRef resourcesPath, return true; } - if (!origCI.getLangOpts().ObjC1) + if (!origCI.getLangOpts()->ObjC1) return false; MigrationProcess migration(origCI, DiagClient); std::vector - transforms = arcmt::getAllTransformations(origCI.getLangOpts().getGC()); + transforms = arcmt::getAllTransformations(origCI.getLangOpts()->getGC()); assert(!transforms.empty()); llvm::OwningPtr transformPrinter; diff --git a/tools/libclang/Indexing.cpp b/tools/libclang/Indexing.cpp index 1eb3da21b4..4540f9731d 100644 --- a/tools/libclang/Indexing.cpp +++ b/tools/libclang/Indexing.cpp @@ -333,7 +333,7 @@ static void clang_indexSourceFile_Impl(void *UserData) { // (often very broken) source code, where spell-checking can have a // significant negative impact on performance (particularly when // precompiled headers are involved), we disable it. - CInvok->getLangOpts().SpellChecking = false; + CInvok->getLangOpts()->SpellChecking = false; if (!requestedToGetTU) CInvok->getPreprocessorOpts().DetailedRecord = false; -- 2.40.0