BIND 10 trac957, updated. 33e3357a5e6887b461b5a6cc5593f911e84df98a [trac957] revert the fix

[BIND 10 source code commits]

The branch, trac957 has been updated
       via  33e3357a5e6887b461b5a6cc5593f911e84df98a (commit)
      from  879663a28bd59692b3745f9e1851412a73872460 (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit 33e3357a5e6887b461b5a6cc5593f911e84df98a
Author: Yoshitaka Aharen <aharen at jprs.co.jp>
Date:   Fri Jun 10 10:21:38 2011 +0900

    [trac957] revert the fix
    
    Revert "[trac957] Added new ChangeLog entry"
    
    This reverts commit 879663a28bd59692b3745f9e1851412a73872460.
    
    Revert "[trac957] Fixed the bug that destructIntervalTimer segfaults."
    
    This reverts commit 8abc6698d085aeb474d705403f7b15c2e3505fc2.

-----------------------------------------------------------------------

Summary of changes:
 ChangeLog                          |    6 -----
 src/lib/asiolink/interval_timer.cc |   41 +++++++++++++++---------------------
 src/lib/asiolink/interval_timer.h  |   10 +++++---
 3 files changed, 23 insertions(+), 34 deletions(-)

-----------------------------------------------------------------------
diff --git a/ChangeLog b/ChangeLog
index 905d887..e44caa2 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,9 +1,3 @@
-TBD.	[bug]           y-aharen
-	Fixed a bug an instance of IntervalTimerImpl may be destructed 
-	while deadline_timer is holding the handler. This fix addresses
-	occasional failure of IntervalTimerTest.destructIntervalTimer.
-	(Trac #957, git TBD)
-
 243.	[func]*		feng
 	Add optional hmac algorithm SHA224/384/812.
 	(Trac#782,git 77d792c9d7c1a3f95d3e6a8b721ac79002cd7db1).
diff --git a/src/lib/asiolink/interval_timer.cc b/src/lib/asiolink/interval_timer.cc
index 2830a3b..0ed06eb 100644
--- a/src/lib/asiolink/interval_timer.cc
+++ b/src/lib/asiolink/interval_timer.cc
@@ -19,8 +19,6 @@
 #include <netinet/in.h>
 
 #include <boost/bind.hpp>
-#include <boost/enable_shared_from_this.hpp>
-#include <boost/shared_ptr.hpp>
 
 #include <exceptions/exceptions.h>
 
@@ -31,11 +29,7 @@
 namespace isc {
 namespace asiolink {
 
-/// This class uses shared_from_this in its methods. It must live inside
-/// a shared_ptr.
-class IntervalTimerImpl :
-    public boost::enable_shared_from_this<IntervalTimerImpl>
-{
+class IntervalTimerImpl {
 private:
     // prohibit copy
     IntervalTimerImpl(const IntervalTimerImpl& source);
@@ -87,43 +81,42 @@ IntervalTimerImpl::setup(const IntervalTimer::Callback& cbfunc,
     // At this point the timer is not running yet and will not expire.
     // After calling IOService::run(), the timer will expire.
     update();
+    return;
 }
 
 void
 IntervalTimerImpl::update() {
+    if (interval_ == 0) {
+        // timer has been canceled.  Do nothing.
+        return;
+    }
     try {
         // Update expire time to (current time + interval_).
         timer_.expires_from_now(boost::posix_time::millisec(interval_));
-        // Reset timer.
-        timer_.async_wait(boost::bind(&IntervalTimerImpl::callback,
-                                      shared_from_this(),
-                                      asio::placeholders::error));
     } catch (const asio::system_error& e) {
         isc_throw(isc::Unexpected, "Failed to update timer");
-    } catch (const boost::bad_weak_ptr& e) {
-        isc_throw(isc::Unexpected, "Failed to update timer");
     }
+    // Reset timer.
+    timer_.async_wait(boost::bind(&IntervalTimerImpl::callback, this, _1));
 }
 
 void
-IntervalTimerImpl::callback(const asio::error_code& ec) {
-    if (interval_ == 0 || ec) {
-        // timer has been canceled. Do nothing.
-    } else {
+IntervalTimerImpl::callback(const asio::error_code& cancelled) {
+    // Do not call cbfunc_ in case the timer was cancelled.
+    // The timer will be canelled in the destructor of asio::deadline_timer.
+    if (!cancelled) {
+        cbfunc_();
         // Set next expire time.
         update();
-        // Invoke the call back function.
-        cbfunc_();
     }
 }
 
-IntervalTimer::IntervalTimer(IOService& io_service) :
-    impl_(new IntervalTimerImpl(io_service))
-{}
+IntervalTimer::IntervalTimer(IOService& io_service) {
+    impl_ = new IntervalTimerImpl(io_service);
+}
 
 IntervalTimer::~IntervalTimer() {
-    // Cancel the timer to make sure cbfunc_() will not be called any more.
-    cancel();
+    delete impl_;
 }
 
 void
diff --git a/src/lib/asiolink/interval_timer.h b/src/lib/asiolink/interval_timer.h
index 57ec1c3..8de16cb 100644
--- a/src/lib/asiolink/interval_timer.h
+++ b/src/lib/asiolink/interval_timer.h
@@ -16,7 +16,6 @@
 #define __ASIOLINK_INTERVAL_TIMER_H 1
 
 #include <boost/function.hpp>
-#include <boost/shared_ptr.hpp>
 
 #include <asiolink/io_service.h>
 
@@ -43,6 +42,9 @@ class IntervalTimerImpl;
 /// The call back function will not be called if the instance of this class is
 /// destroyed before the timer is expired.
 ///
+/// Note: Destruction of an instance of this class while call back is pending
+/// causes throwing an exception from \c IOService.
+///
 /// Sample code:
 /// \code
 ///  void function_to_call_back() {
@@ -98,12 +100,12 @@ public:
     /// \param interval Interval in milliseconds (greater than 0)
     ///
     /// Note: IntervalTimer will not pass \c asio::error_code to
-    /// call back function. In case the timer is canceled, the function
+    /// call back function. In case the timer is cancelled, the function
     /// will not be called.
     ///
     /// \throw isc::InvalidParameter cbfunc is empty
     /// \throw isc::BadValue interval is less than or equal to 0
-    /// \throw isc::Unexpected internal runtime error
+    /// \throw isc::Unexpected ASIO library error
     void setup(const Callback& cbfunc, const long interval);
 
     /// Cancel the timer.
@@ -125,7 +127,7 @@ public:
     long getInterval() const;
 
 private:
-    boost::shared_ptr<IntervalTimerImpl> impl_;
+    IntervalTimerImpl* impl_;
 };
 
 } // namespace asiolink