From 9315a4acce26b3913eac6ea84e13a67e15281df1 Mon Sep 17 00:00:00 2001
From: Tobias Markmann <tm@ayena.de>
Date: Thu, 23 Jul 2015 13:14:50 +0200
Subject: Make access to deadline_timer thread-safe

According to boost doucmentation shared deadline_timers are not
thread-safe. Adding a mutext to protect access to
boost::asio::deadline_timer instance in Swift::BoostTimer.

This fixes a data-race reported by TSAN when running
Swiften/QA/ClientTest/ClientTest.

Test-Information:

Verified that the data-race report is gone with this fix.

Change-Id: I62c8c3a07d6ea16fe6e2d24c879340040406699b

diff --git a/Swiften/Network/BoostTimer.cpp b/Swiften/Network/BoostTimer.cpp
index dd6bd0d..30f5180 100644
--- a/Swiften/Network/BoostTimer.cpp
+++ b/Swiften/Network/BoostTimer.cpp
@@ -1,30 +1,44 @@
 /*
- * Copyright (c) 2010 Isode Limited.
+ * Copyright (c) 2010-2015 Isode Limited.
  * All rights reserved.
  * See the COPYING file for more information.
  */
 
 #include <Swiften/Network/BoostTimer.h>
 
-#include <boost/date_time/posix_time/posix_time.hpp>
 #include <boost/asio.hpp>
 #include <boost/bind.hpp>
+#include <boost/date_time/posix_time/posix_time.hpp>
 
 #include <Swiften/EventLoop/EventLoop.h>
 
 namespace Swift {
 
 BoostTimer::BoostTimer(int milliseconds, boost::shared_ptr<boost::asio::io_service> service, EventLoop* eventLoop) :
-		timeout(milliseconds), ioService(service), timer(*service), eventLoop(eventLoop) {
+		timeout(milliseconds), ioService(service), eventLoop(eventLoop) {
+		timer.reset(new boost::asio::deadline_timer(*service));
+}
+
+BoostTimer::~BoostTimer() {
+	{
+		boost::mutex::scoped_lock lockTimer(timerMutex);
+		timer.reset();
+	}
 }
 
 void BoostTimer::start() {
-	timer.expires_from_now(boost::posix_time::milliseconds(timeout));
-	timer.async_wait(boost::bind(&BoostTimer::handleTimerTick, shared_from_this(), boost::asio::placeholders::error));
+	{
+		boost::mutex::scoped_lock lockTimer(timerMutex);
+		timer->expires_from_now(boost::posix_time::milliseconds(timeout));
+		timer->async_wait(boost::bind(&BoostTimer::handleTimerTick, shared_from_this(), boost::asio::placeholders::error));
+	}
 }
 
 void BoostTimer::stop() {
-	timer.cancel();
+	{
+		boost::mutex::scoped_lock lockTimer(timerMutex);
+		timer->cancel();
+	}
 	eventLoop->removeEventsFromOwner(shared_from_this());
 }
 
diff --git a/Swiften/Network/BoostTimer.h b/Swiften/Network/BoostTimer.h
index 1562887..a246b75 100644
--- a/Swiften/Network/BoostTimer.h
+++ b/Swiften/Network/BoostTimer.h
@@ -6,9 +6,11 @@
 
 #pragma once
 
-#include <boost/asio/io_service.hpp>
 #include <boost/asio/deadline_timer.hpp>
+#include <boost/asio/io_service.hpp>
 #include <boost/enable_shared_from_this.hpp>
+#include <boost/scoped_ptr.hpp>
+#include <boost/thread/mutex.hpp>
 
 #include <Swiften/Base/API.h>
 #include <Swiften/EventLoop/EventOwner.h>
@@ -21,6 +23,8 @@ namespace Swift {
 		public:
 			typedef boost::shared_ptr<BoostTimer> ref;
 
+			virtual ~BoostTimer();
+
 			static ref create(int milliseconds, boost::shared_ptr<boost::asio::io_service> service, EventLoop* eventLoop) {
 				return ref(new BoostTimer(milliseconds, service, eventLoop));
 			}
@@ -36,7 +40,8 @@ namespace Swift {
 		private:
 			int timeout;
 			boost::shared_ptr<boost::asio::io_service> ioService;
-			boost::asio::deadline_timer timer;
+			boost::scoped_ptr<boost::asio::deadline_timer> timer;
+			boost::mutex timerMutex;
 			EventLoop* eventLoop;
 	};
 }
-- 
cgit v0.10.2-6-g49f6