timer.cc

Go to the documentation of this file.

/*
 * Copyright (c) 2013 Juniper Networks, Inc. All rights reserved.
 */

#include "base/timer.h"
#include "base/timer_impl.h"

class Timer::TimerTask : public Task {
public:
    TimerTask(TimerPtr timer, boost::system::error_code ec)
        : Task(timer->task_id_, timer->task_instance_), timer_(timer), ec_(ec) {
    }

    virtual ~TimerTask() {
    }

    // Invokes user callback.
    // Timer could have been cancelled or delete when task was enqueued
    virtual bool Run() {
        {
            tbb::mutex::scoped_lock lock(timer_->mutex_);

            // cancelled task .. ignore
            if (task_cancelled()) {
                // Cancelled timer's task releases the ownership of the timer

                lock.release();
                timer_ = NULL;
                return true;
            }

            // Conditions to invoke user callback met. Fire it
            timer_->SetState(Timer::Fired);
        }

        bool restart = false;

        // TODO: Is this error needed by user?
        if (ec_ && !timer_->error_handler_.empty()) {
            timer_->error_handler_(timer_->name_,
                                   std::string(ec_.category().name()),
                                   ec_.message());
        } else {
            restart = timer_->handler_();
        }

        OnTaskCancel();

        if (restart) {
            timer_->Start(timer_->time_, timer_->handler_,
                          timer_->error_handler_);
        } else if (timer_->delete_on_completion_) {
            TimerManager::DeleteTimer(timer_.get());
        }
        return true;
    }

    // Task Cancelled/Destroyed when it was Fired.
    void OnTaskCancel() {
        if (!timer_) {
            return;
        }
        tbb::mutex::scoped_lock lock(timer_->mutex_);

        if (timer_->timer_task_ != this) {
            assert(!timer_->timer_task_);
        }

        timer_->timer_task_ = NULL;
        timer_->SetState(Timer::Init);
    }

    virtual std::string Description() const {
        return timer_->Description();
    }

private:
    TimerPtr timer_;
    boost::system::error_code ec_;
    DISALLOW_COPY_AND_ASSIGN(TimerTask);
};

Timer::Timer(boost::asio::io_context &service, const std::string &name,
          int task_id, int task_instance, bool delete_on_completion)
        : impl_(new TimerImpl(service)),
          name_(name),
          handler_(NULL),
          error_handler_(NULL),
          state_(Init),
          timer_task_(NULL),
          time_(0),
          task_id_(task_id),
          task_instance_(task_instance),
          seq_no_(0),
          delete_on_completion_(delete_on_completion) {
    refcount_ = 0;
}

Timer::~Timer() {
    assert(state_ != Running && state_ != Fired);
}

//
// Start a timer
//
// If the timer is already running, return silently
//
bool Timer::Start(int time, Handler handler, ErrorHandler error_handler) {
    tbb::mutex::scoped_lock lock(mutex_);

    if (time < 0) {
        return true;
    }

    if (state_ == Running || state_ == Fired) {
        return true;
    }

    // Restart the timer
    time_ = time;
    handler_ = handler;
    seq_no_++;
    error_handler_ = error_handler;
    boost::system::error_code ec;
    impl_->expires_from_now(time, ec);
    if (ec) {
        return false;
    }

    SetState(Running);
    impl_->async_wait(
        boost::bind(&Timer::StartTimerTask, this, TimerPtr(this),
                    time, seq_no_, boost::asio::placeholders::error));
    return true;
}

bool Timer::Reschedule(int time)
{
    if (state_ != Fired)
        return false;

    if (time < 0)
        return false;

    time_ = time;
    return true;
}

// Cancel a running timer
bool Timer::Cancel() {
    tbb::mutex::scoped_lock lock(mutex_);

    // A fired timer cannot be cancelled
    if (state_ == Fired) {
        return false;
    }

    // Cancel Task. If Task cancel succeeds, there will be no callback.
    // Reset TaskRef if call succeeds.
    if (timer_task_) {
        TaskScheduler::CancelReturnCode rc =
            TaskScheduler::GetInstance()->Cancel(timer_task_);
        assert(rc != TaskScheduler::FAILED);
        timer_task_ = NULL;
    }

    SetState(Cancelled);
    return true;
}

// ASIO callback on timer expiry. Start a task to serve the timer
void Timer::StartTimerTask(TimerPtr reference, int time, uint32_t seq_no,
                           const boost::system::error_code &ec) {
    tbb::mutex::scoped_lock lock(mutex_);

    if (state_ == Cancelled) {
        return;
    }

    // If timer was cancelled, no callback is invoked
    if (ec && ec.value() == boost::asio::error::operation_aborted) {
        return;
    }

    // Timer could have fired for previous run. Validate the seq_no_
    if (seq_no_ != seq_no) {
        return;
    }
    // Start a task and add Task reference.
    assert(timer_task_ == NULL);
    timer_task_ = new TimerTask(reference, ec);
    TaskScheduler::GetInstance()->Enqueue(timer_task_);
}

//
// TimerManager class routines
//
TimerManager::TimerSet TimerManager::timer_ref_;
tbb::mutex TimerManager::mutex_;

Timer *TimerManager::CreateTimer(
            boost::asio::io_context &service, const std::string &name,
            int task_id, int task_instance, bool delete_on_completion) {
    Timer *timer = new Timer(service, name, task_id, task_instance,
                             delete_on_completion);
    AddTimer(timer);
    return timer;
}

void TimerManager::AddTimer(Timer *timer) {
    tbb::mutex::scoped_lock lock(mutex_);
    timer_ref_.insert(TimerPtr(timer));

    return;
}

//
// Delete a timer object from the data base, by removing the intrusive
// reference. If any other objects has a reference to this timer such as
// boost::asio, the timer object deletion is automatically deferred
//
bool TimerManager::DeleteTimer(Timer *timer) {
    if (!timer || timer->fired()) return false;

    if (!timer->Cancel() && timer->IsDeleteOnCompletion())
        return false;

    tbb::mutex::scoped_lock lock(mutex_);
    timer_ref_.erase(TimerPtr(timer));

    return true;
}

// Get timer's already elapsed time in milliseconds.
int64_t Timer::GetElapsedTime() const {
    tbb::mutex::scoped_lock lock(mutex_);
    int64_t elapsed;

#if __cplusplus >= 201103L
    elapsed = std::chrono::nanoseconds(impl_->expires_from_now()).count();
#else
    elapsed = boost::chrono::nanoseconds(impl_->expires_from_now()).count();
#endif

    elapsed = time_ - elapsed / 1000000; // Convert nanoseconds to milliseconds.
    if (elapsed < 0)
        elapsed = 0;
    return elapsed;
}