heap/GCActivityCallback.h

   1 /*
   2  * Copyright (C) 2010 Apple 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  *
   8  * 1.  Redistributions of source code must retain the above copyright
   9  *     notice, this list of conditions and the following disclaimer.
  10  * 2.  Redistributions in binary form must reproduce the above copyright
  11  *     notice, this list of conditions and the following disclaimer in the
  12  *     documentation and/or other materials provided with the distribution.
  13  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
  14  *     its contributors may be used to endorse or promote products derived
  15  *     from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #ifndef GCActivityCallback_h
  30 #define GCActivityCallback_h
  31
  32 #include "HeapTimer.h"
  33 #include <wtf/OwnPtr.h>
  34 #include <wtf/PassRefPtr.h>
  35
  36 #if USE(CF)
  37 #include <CoreFoundation/CoreFoundation.h>
  38 #endif
  39
  40 namespace JSC {
  41
  42 class Heap;
  43
  44 class JS_EXPORT_PRIVATE GCActivityCallback : public HeapTimer, public ThreadSafeRefCounted<GCActivityCallback> {
  45     WTF_MAKE_FAST_ALLOCATED;
  46 public:
  47     static PassRefPtr<GCActivityCallback> createFullTimer(Heap*);
  48     static PassRefPtr<GCActivityCallback> createEdenTimer(Heap*);
  49
  50     GCActivityCallback(Heap*);
  51
  52     virtual void doWork() override;
  53
  54     virtual void doCollection() = 0;
  55
  56     virtual void didAllocate(size_t);
  57     virtual void willCollect();
  58     virtual void cancel();
  59     bool isEnabled() const { return m_enabled; }
  60     void setEnabled(bool enabled) { m_enabled = enabled; }
  61
  62     static bool s_shouldCreateGCTimer;
  63
  64 protected:
  65     virtual double lastGCLength() = 0;
  66     virtual double gcTimeSlice(size_t bytes) = 0;
  67     virtual double deathRate() = 0;
  68
  69 #if USE(CF)
  70     GCActivityCallback(VM* vm, CFRunLoopRef runLoop)
  71         : HeapTimer(vm, runLoop)
  72         , m_enabled(true)
  73         , m_delay(s_decade)
  74     {
  75     }
  76 #elif PLATFORM(EFL)
  77     static constexpr double s_hour = 3600;
  78     GCActivityCallback(VM* vm, bool flag)
  79         : HeapTimer(vm)
  80         , m_enabled(flag)
  81         , m_delay(s_hour)
  82     {
  83     }
  84 #else
  85     GCActivityCallback(VM* vm)
  86         : HeapTimer(vm)
  87         , m_enabled(true)
  88     {
  89     }
  90 #endif
  91
  92     bool m_enabled;
  93
  94 #if USE(CF)
  95 protected:
  96     GCActivityCallback(Heap*, CFRunLoopRef);
  97 #endif
  98 #if USE(CF) || PLATFORM(EFL)
  99 protected:
 100     void cancelTimer();
 101     void scheduleTimer(double);
 102
 103 private:
 104     double m_delay;
 105 #endif
 106 };
 107
 108 } // namespace JSC
 109
 110 #endif