Reactor: Fix all memory leaks with rr::DebugInfo.

src/Reactor/LLVMReactor.cpp

@@ -643,18 +643,12 @@ namespace rr
 				ObjLayer::NotifyLoadedFtor(),
 				[](llvm::orc::VModuleKey, const llvm::object::ObjectFile &Obj, const llvm::RuntimeDyld::LoadedObjectInfo &L) {
 #ifdef ENABLE_RR_DEBUG_INFO
-					if (debugInfo != nullptr)
-					{
-						debugInfo->NotifyObjectEmitted(Obj, L);
-					}
+					DebugInfo::NotifyObjectEmitted(Obj, L);
 #endif // ENABLE_RR_DEBUG_INFO
 				},
 				[](llvm::orc::VModuleKey, const llvm::object::ObjectFile &Obj) {
 #ifdef ENABLE_RR_DEBUG_INFO
-					if (debugInfo != nullptr)
-					{
-						debugInfo->NotifyFreeingObject(Obj);
-					}
+					DebugInfo::NotifyFreeingObject(Obj);
 #endif // ENABLE_RR_DEBUG_INFO
 				}
 	  		),
@@ -963,6 +957,10 @@ namespace rr
 
 	Nucleus::~Nucleus()
 	{
+#ifdef ENABLE_RR_DEBUG_INFO
+		debugInfo.reset(nullptr);
+#endif // ENABLE_RR_DEBUG_INFO
+
 		::reactorJIT->endSession();
 
 		::codegenMutex.unlock();

src/Reactor/LLVMReactorDebugInfo.cpp

@@ -29,6 +29,7 @@
 
 #include <cctype>
 #include <fstream>
+#include <mutex>
 #include <regex>
 #include <sstream>
 #include <string>
@@ -45,6 +46,12 @@ namespace
 	{
 		return llvm::StringRef(path).rsplit('/');
 	}
+
+	// Note: createGDBRegistrationListener() returns a pointer to a singleton.
+	// Nothing is actually created.
+	auto jitEventListener = llvm::JITEventListener::createGDBRegistrationListener(); // guarded by jitEventListenerMutex
+	std::mutex jitEventListenerMutex;
+
 } // anonymous namespaces
 
 namespace rr
@@ -61,14 +68,13 @@ namespace rr
 		auto location = getCallerLocation();
 
 		auto fileAndDir = splitPath(location.function.file.c_str());
-		diBuilder = new llvm::DIBuilder(*module);
+		diBuilder.reset(new llvm::DIBuilder(*module));
 		diCU = diBuilder->createCompileUnit(
 			llvm::dwarf::DW_LANG_C,
 			diBuilder->createFile(fileAndDir.first, fileAndDir.second),
 			"Reactor",
 			0, "", 0);
 
-		jitEventListener = llvm::JITEventListener::createGDBRegistrationListener();
 		registerBasicTypes();
 
 		SmallVector<Metadata *, 8> EltTys;
@@ -94,11 +100,13 @@ namespace rr
 		builder->SetCurrentDebugLocation(diRootLocation);
 	}
 
+	DebugInfo::~DebugInfo() = default;
+
 	void DebugInfo::Finalize()
 	{
 		while (diScope.size() > 0)
 		{
-			emitPending(diScope.back(), builder, diBuilder);
+			emitPending(diScope.back(), builder);
 			diScope.pop_back();
 		}
 		diBuilder->finalize();
@@ -127,7 +135,7 @@ namespace rr
 
 	void DebugInfo::Flush()
 	{
-		emitPending(diScope.back(), builder, diBuilder);
+		emitPending(diScope.back(), builder);
 	}
 
 	void DebugInfo::syncScope(Backtrace const& backtrace)
@@ -141,7 +149,7 @@ namespace rr
 					int(diScope.size() - 1), scope.di,
 					scope.location.function.file.c_str(),
 					int(scope.location.line));
-				emitPending(scope, builder, diBuilder);
+				emitPending(scope, builder);
 				diScope.pop_back();
 			}
 		};
@@ -172,7 +180,7 @@ namespace rr
 				auto di = diBuilder->createLexicalBlock(scope.di, file, newLocation.line, 0);
 				LOG("  STACK(%d): Jumped backwards %d -> %d. di: %p -> %p", int(i),
 					oldLocation.line, newLocation.line, scope.di, di);
-				emitPending(scope, builder, diBuilder);
+				emitPending(scope, builder);
 				scope = {newLocation, di};
 				shrink(i+1);
 				break;
@@ -263,7 +271,7 @@ namespace rr
 			auto &scope = diScope[i];
 			if (scope.pending.location != location)
 			{
-				emitPending(scope, builder, diBuilder);
+				emitPending(scope, builder);
 			}
 
 			auto value = V(variable);
@@ -297,7 +305,7 @@ namespace rr
 		}
 	}
 
-	void DebugInfo::emitPending(Scope &scope, IRBuilder *builder, llvm::DIBuilder *diBuilder)
+	void DebugInfo::emitPending(Scope &scope, IRBuilder *builder)
 	{
 		auto const &pending = scope.pending;
 		if (pending.value == nullptr)
@@ -373,11 +381,13 @@ namespace rr
 
 	void DebugInfo::NotifyObjectEmitted(const llvm::object::ObjectFile &Obj, const llvm::LoadedObjectInfo &L)
 	{
+		std::unique_lock<std::mutex> lock(jitEventListenerMutex);
 		jitEventListener->NotifyObjectEmitted(Obj, static_cast<const llvm::RuntimeDyld::LoadedObjectInfo&>(L));
 	}
 
 	void DebugInfo::NotifyFreeingObject(const llvm::object::ObjectFile &Obj)
 	{
+		std::unique_lock<std::mutex> lock(jitEventListenerMutex);
 		jitEventListener->NotifyFreeingObject(Obj);
 	}
 

src/Reactor/LLVMReactorDebugInfo.hpp

@@ -71,6 +71,8 @@ namespace rr
 				llvm::Module *module,
 				llvm::Function *function);
 
+		~DebugInfo();
+
 		// Finalize debug info generation. Must be called before the LLVM module
 		// is built.
 		void Finalize();
@@ -88,11 +90,11 @@ namespace rr
 
 		// NotifyObjectEmitted informs any attached debuggers of the JIT'd
 		// object.
-		void NotifyObjectEmitted(const llvm::object::ObjectFile &Obj, const llvm::LoadedObjectInfo &L);
+		static void NotifyObjectEmitted(const llvm::object::ObjectFile &Obj, const llvm::LoadedObjectInfo &L);
 
 		// NotifyFreeingObject informs any attached debuggers that the JIT'd
 		// object is now invalid.
-		void NotifyFreeingObject(const llvm::object::ObjectFile &Obj);
+		static void NotifyFreeingObject(const llvm::object::ObjectFile &Obj);
 
 	private:
 		struct Token
@@ -168,7 +170,7 @@ namespace rr
 
 		void registerBasicTypes();
 
-		void emitPending(Scope &scope, IRBuilder *builder, llvm::DIBuilder *diBuilder);
+		void emitPending(Scope &scope, IRBuilder *builder);
 
 		// Returns the source location of the non-Reactor calling function.
 		Location getCallerLocation() const;
@@ -192,7 +194,7 @@ namespace rr
 		llvm::Module *module;
 		llvm::Function *function;
 
-		llvm::DIBuilder *diBuilder;
+		std::unique_ptr<llvm::DIBuilder> diBuilder;
 		llvm::DICompileUnit *diCU;
 		llvm::DISubprogram *diSubprogram;
 		llvm::DILocation *diRootLocation;
@@ -200,7 +202,6 @@ namespace rr
 		std::unordered_map<std::string, llvm::DIFile*> diFiles;
 		std::unordered_map<llvm::Type*, llvm::DIType*> diTypes;
 		std::unordered_map<std::string, std::unique_ptr<LineTokens>> fileTokens;
-		llvm::JITEventListener *jitEventListener;
 		std::vector<void const*> pushed;
 	};