Remove any dependence on singleton destruction order

apache · Dec 20, 2024 · 6fca7cb · 6fca7cb
1 parent b80e6ec
commit 6fca7cb
Show file tree

Hide file tree

Showing 5 changed files with 44 additions and 23 deletions.
diff --git a/src/main/cpp/fileappender.cpp b/src/main/cpp/fileappender.cpp
@@ -82,8 +82,8 @@ FileAppender::FileAppender(std::unique_ptr<FileAppenderPriv> priv)
 FileAppender::~FileAppender()
 {
 	finalize();
-	if (_priv->bufferedIO && 0 < _priv->bufferedSeconds)
-		ThreadUtility::instance()->removePeriodicTask(getName());
+	if (auto p = _priv->taskManager.lock())
+		p->value().removePeriodicTask(getName());
 }
 
 void FileAppender::setAppend(bool fileAppend1)
@@ -197,10 +197,12 @@ void FileAppender::activateOptionsInternal(Pool& p)
 			;
 		else if (0 < _priv->bufferedSeconds)
 		{
-			ThreadUtility::instance()->addPeriodicTask(getName()
+			auto taskManager = ThreadUtility::instancePtr();
+			taskManager->value().addPeriodicTask(getName()
 				, std::bind(&WriterAppenderPriv::flush, _priv)
 				, std::chrono::seconds(_priv->bufferedSeconds)
 				);
+			_priv->taskManager = taskManager;
 		}
 		else if (0 == _priv->bufferedSeconds)
 		{

diff --git a/src/main/cpp/filewatchdog.cpp b/src/main/cpp/filewatchdog.cpp
@@ -36,8 +36,7 @@ struct FileWatchdog::FileWatchdogPrivate{
 	FileWatchdogPrivate(const File& file1) :
 		file(file1), delay(DEFAULT_DELAY), lastModif(0),
 		warnedAlready(false),
-		taskName{ LOG4CXX_STR("WatchDog_") + file1.getName() },
-		taskManager{ ThreadUtility::instance() }
+		taskName{ LOG4CXX_STR("WatchDog_") + file1.getName() }
 	{ }
 
 
@@ -60,7 +59,7 @@ struct FileWatchdog::FileWatchdogPrivate{
 	std::mutex interrupt_mutex;
 #endif
 	LogString taskName;
-	ThreadUtility* taskManager;
+	ThreadUtility::ManagerWeakPtr taskManager;
 };
 
 FileWatchdog::FileWatchdog(const File& file1)
@@ -76,12 +75,16 @@ FileWatchdog::~FileWatchdog()
 
 bool FileWatchdog::is_active()
 {
-	return m_priv->taskManager->hasPeriodicTask(m_priv->taskName);
+	bool result = false;
+	if (auto p = m_priv->taskManager.lock())
+		result = p->value().hasPeriodicTask(m_priv->taskName);
+	return result;
 }
 
 void FileWatchdog::stop()
 {
-	m_priv->taskManager->removePeriodicTask(m_priv->taskName);
+	if (auto p = m_priv->taskManager.lock())
+		p->value().removePeriodicTask(m_priv->taskName);
 }
 
 /**
@@ -134,7 +137,8 @@ void FileWatchdog::checkAndConfigure()
 void FileWatchdog::start()
 {
 	checkAndConfigure();
-	if (!m_priv->taskManager->hasPeriodicTask(m_priv->taskName))
+	auto taskManager = ThreadUtility::instancePtr();
+	if (taskManager->value().hasPeriodicTask(m_priv->taskName))
 	{
 		if (LogLog::isDebugEnabled())
 		{
@@ -146,19 +150,21 @@ void FileWatchdog::start()
 			msg += LOG4CXX_STR(" ms interval");
 			LogLog::debug(msg);
 		}
-		m_priv->taskManager->addPeriodicTask(m_priv->taskName
+		taskManager->value().addPeriodicTask(m_priv->taskName
 			, std::bind(&FileWatchdog::checkAndConfigure, this)
 			, std::chrono::milliseconds(m_priv->delay)
 			);
+		m_priv->taskManager = taskManager;
 	}
 }
 
 void FileWatchdog::setDelay(long delay1){
 	m_priv->delay = delay1;
-	if (m_priv->taskManager->hasPeriodicTask(m_priv->taskName))
+	auto p = m_priv->taskManager.lock();
+	if (p && p->value().hasPeriodicTask(m_priv->taskName))
 	{
-		m_priv->taskManager->removePeriodicTask(m_priv->taskName);
-		m_priv->taskManager->addPeriodicTask(m_priv->taskName
+		p->value().removePeriodicTask(m_priv->taskName);
+		p->value().addPeriodicTask(m_priv->taskName
 			, std::bind(&FileWatchdog::checkAndConfigure, this)
 			, std::chrono::milliseconds(m_priv->delay)
 			);

diff --git a/src/main/cpp/threadutility.cpp b/src/main/cpp/threadutility.cpp
@@ -119,14 +119,18 @@ ThreadUtility::ThreadUtility()
 
 ThreadUtility::~ThreadUtility() {}
 
-ThreadUtility* ThreadUtility::instance()
+auto ThreadUtility::instancePtr() -> ManagerPtr
 {
-	using ThreadUtilityHolder = SingletonHolder<ThreadUtility>;
-	auto result = APRInitializer::getOrAddUnique<ThreadUtilityHolder>
+	auto result = APRInitializer::getOrAddUnique<Manager>
 		( []() -> ObjectPtr
-			{ return std::make_shared<ThreadUtilityHolder>(); }
+			{ return std::make_shared<Manager>(); }
 		);
-	return &result->value();
+	return result;
+}
+
+ThreadUtility* ThreadUtility::instance()
+{
+	return &instancePtr()->value();
 }
 
 void ThreadUtility::configure( ThreadConfigurationType type )

diff --git a/src/main/include/log4cxx/helpers/threadutility.h b/src/main/include/log4cxx/helpers/threadutility.h
@@ -65,13 +65,10 @@ enum class ThreadConfigurationType
 	BlockSignalsAndNameThread,
 };
 
-class ThreadUtility;
-LOG4CXX_PTR_DEF(ThreadUtility);
-
 class LOG4CXX_EXPORT ThreadUtility
 {
 	private:
-		friend class LOG4CXX_NS::helpers::SingletonHolder<ThreadUtility>;
+		friend class SingletonHolder<ThreadUtility>;
 		ThreadUtility();
 
 		LOG4CXX_NS::helpers::ThreadStartPre preStartFunction();
@@ -176,6 +173,11 @@ class LOG4CXX_EXPORT ThreadUtility
 		 * Remove any periodic task matching \c namePrefix
 		 */
 		void removePeriodicTasksMatching(const LogString& namePrefix);
+
+		using Manager = SingletonHolder<ThreadUtility>;
+		LOG4CXX_PTR_DEF(Manager);
+
+		static ManagerPtr instancePtr();
 };
 
 } /* namespace helpers */

diff --git a/src/main/include/log4cxx/private/fileappender_priv.h b/src/main/include/log4cxx/private/fileappender_priv.h
@@ -20,6 +20,7 @@
 
 #include <log4cxx/private/writerappender_priv.h>
 #include <log4cxx/fileappender.h>
+#include <log4cxx/helpers/threadutility.h>
 
 namespace LOG4CXX_NS
 {
@@ -63,9 +64,15 @@ struct FileAppender::FileAppenderPriv : public WriterAppender::WriterAppenderPri
 
 	/**
 	The number of seconds between each asynchronous output buffer flush.
-	Only active when <code>bufferedIO == true</code>.
+	Only used when <code>bufferedIO == true</code>.
 	*/
 	int bufferedSeconds{ 5 };
+
+	/**
+	Manages asynchronous output buffer flush.
+	Only used when <code>bufferedIO == true</code>.
+	*/
+	helpers::ThreadUtility::ManagerWeakPtr taskManager;
 };
 
 }