src/third_party/WebKit/Source/platform/Timer.h

   1 /*
   2  * Copyright (C) 2006 Apple Computer, Inc.  All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef Timer_h
  27 #define Timer_h
  28
  29 #include "platform/PlatformExport.h"
  30 #include "platform/TraceLocation.h"
  31 #include "wtf/Noncopyable.h"
  32 #include "wtf/Threading.h"
  33 #include "wtf/Vector.h"
  34
  35 namespace WebCore {
  36
  37 // Time intervals are all in seconds.
  38
  39 class TimerHeapElement;
  40
  41 class PLATFORM_EXPORT TimerBase {
  42     WTF_MAKE_NONCOPYABLE(TimerBase); WTF_MAKE_FAST_ALLOCATED;
  43 public:
  44     TimerBase();
  45     virtual ~TimerBase();
  46
  47     void start(double nextFireInterval, double repeatInterval, const TraceLocation&);
  48
  49     void startRepeating(double repeatInterval, const TraceLocation& caller)
  50     {
  51         start(repeatInterval, repeatInterval, caller);
  52     }
  53     void startOneShot(double interval, const TraceLocation& caller)
  54     {
  55         start(interval, 0, caller);
  56     }
  57
  58     void stop();
  59     bool isActive() const;
  60     const TraceLocation& location() const { return m_location; }
  61
  62     double nextFireInterval() const;
  63     double nextUnalignedFireInterval() const;
  64     double repeatInterval() const { return m_repeatInterval; }
  65
  66     void augmentRepeatInterval(double delta) {
  67         setNextFireTime(m_nextFireTime + delta);
  68         m_repeatInterval += delta;
  69     }
  70
  71     void didChangeAlignmentInterval();
  72
  73     static void fireTimersInNestedEventLoop();
  74
  75 private:
  76     virtual void fired() = 0;
  77
  78     virtual double alignedFireTime(double fireTime) const { return fireTime; }
  79
  80     void checkConsistency() const;
  81     void checkHeapIndex() const;
  82
  83     void setNextFireTime(double);
  84
  85     bool inHeap() const { return m_heapIndex != -1; }
  86
  87     bool hasValidHeapPosition() const;
  88     void updateHeapIfNeeded(double oldTime);
  89
  90     void heapDecreaseKey();
  91     void heapDelete();
  92     void heapDeleteMin();
  93     void heapIncreaseKey();
  94     void heapInsert();
  95     void heapPop();
  96     void heapPopMin();
  97
  98     Vector<TimerBase*>& timerHeap() const { ASSERT(m_cachedThreadGlobalTimerHeap); return *m_cachedThreadGlobalTimerHeap; }
  99
 100     double m_nextFireTime; // 0 if inactive
 101     double m_unalignedNextFireTime; // m_nextFireTime not considering alignment interval
 102     double m_repeatInterval; // 0 if not repeating
 103     int m_heapIndex; // -1 if not in heap
 104     unsigned m_heapInsertionOrder; // Used to keep order among equal-fire-time timers
 105     Vector<TimerBase*>* m_cachedThreadGlobalTimerHeap;
 106     TraceLocation m_location;
 107
 108 #ifndef NDEBUG
 109     ThreadIdentifier m_thread;
 110 #endif
 111
 112     friend class ThreadTimers;
 113     friend class TimerHeapLessThanFunction;
 114     friend class TimerHeapReference;
 115 };
 116
 117 template <typename TimerFiredClass>
 118 class Timer FINAL : public TimerBase {
 119 public:
 120     typedef void (TimerFiredClass::*TimerFiredFunction)(Timer*);
 121
 122     Timer(TimerFiredClass* o, TimerFiredFunction f)
 123         : m_object(o), m_function(f) { }
 124
 125 private:
 126     virtual void fired() OVERRIDE { (m_object->*m_function)(this); }
 127
 128     // FIXME: oilpan: TimerBase should be moved to the heap and m_object should be traced.
 129     // This raw pointer is safe as long as Timer<X> is held by the X itself (That's the case
 130     // in the current code base).
 131     TimerFiredClass* m_object;
 132     TimerFiredFunction m_function;
 133 };
 134
 135 inline bool TimerBase::isActive() const
 136 {
 137     ASSERT(m_thread == currentThread());
 138     return m_nextFireTime;
 139 }
 140
 141 template <typename TimerFiredClass>
 142 class DeferrableOneShotTimer FINAL : private TimerBase {
 143 public:
 144     typedef void (TimerFiredClass::*TimerFiredFunction)(DeferrableOneShotTimer*);
 145
 146     DeferrableOneShotTimer(TimerFiredClass* o, TimerFiredFunction f, double delay)
 147         : m_object(o)
 148         , m_function(f)
 149         , m_delay(delay)
 150         , m_shouldRestartWhenTimerFires(false)
 151     {
 152     }
 153
 154     void restart(const TraceLocation& caller)
 155     {
 156         // Setting this boolean is much more efficient than calling startOneShot
 157         // again, which might result in rescheduling the system timer which
 158         // can be quite expensive.
 159
 160         if (isActive()) {
 161             m_shouldRestartWhenTimerFires = true;
 162             return;
 163         }
 164         startOneShot(m_delay, caller);
 165     }
 166
 167     using TimerBase::stop;
 168     using TimerBase::isActive;
 169
 170 private:
 171     virtual void fired() OVERRIDE
 172     {
 173         if (m_shouldRestartWhenTimerFires) {
 174             m_shouldRestartWhenTimerFires = false;
 175             // FIXME: This should not be FROM_HERE.
 176             startOneShot(m_delay, FROM_HERE);
 177             return;
 178         }
 179
 180         (m_object->*m_function)(this);
 181     }
 182
 183     // FIXME: oilpan: TimerBase should be moved to the heap and m_object should be traced.
 184     // This raw pointer is safe as long as Timer<X> is held by the X itself (That's the case
 185     // in the current code base).
 186     TimerFiredClass* m_object;
 187     TimerFiredFunction m_function;
 188
 189     double m_delay;
 190     bool m_shouldRestartWhenTimerFires;
 191 };
 192
 193 }
 194
 195 #endif