runtime/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 Computer, 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/PassOwnPtr.h>
  35
  36 #if USE(CF)
  37 #include <CoreFoundation/CoreFoundation.h>
  38 #endif
  39
  40 namespace JSC {
  41
  42 class Heap;
  43
  44 class GCActivityCallback : public HeapTimer {
  45     WTF_MAKE_FAST_ALLOCATED;
  46 public:
  47     virtual void didAllocate(size_t) { }
  48     virtual void willCollect() { }
  49     virtual void cancel() { }
  50     bool isEnabled() const { return m_enabled; }
  51     void setEnabled(bool enabled) { m_enabled = enabled; }
  52
  53 #if PLATFORM(IOS)
  54     static bool s_shouldCreateGCTimer;
  55 #endif // PLATFORM(IOS)
  56
  57 protected:
  58 #if USE(CF)
  59     GCActivityCallback(VM* vm, CFRunLoopRef runLoop)
  60         : HeapTimer(vm, runLoop)
  61         , m_enabled(true)
  62     {
  63     }
  64 #elif PLATFORM(EFL)
  65     GCActivityCallback(VM* vm, bool flag)
  66         : HeapTimer(vm)
  67         , m_enabled(flag)
  68     {
  69     }
  70 #else
  71     GCActivityCallback(VM* vm)
  72         : HeapTimer(vm)
  73         , m_enabled(true)
  74     {
  75     }
  76 #endif
  77
  78     bool m_enabled;
  79 };
  80
  81 class DefaultGCActivityCallback : public GCActivityCallback {
  82 public:
  83     static PassOwnPtr<DefaultGCActivityCallback> create(Heap*);
  84
  85     DefaultGCActivityCallback(Heap*);
  86 #if PLATFORM(IOS)
  87     JS_EXPORT_PRIVATE virtual void didAllocate(size_t);
  88     JS_EXPORT_PRIVATE virtual void willCollect();
  89     JS_EXPORT_PRIVATE virtual void cancel();
  90
  91     JS_EXPORT_PRIVATE virtual void doWork();
  92 #else
  93     virtual void didAllocate(size_t);
  94     virtual void willCollect();
  95     virtual void cancel();
  96
  97     virtual void doWork();
  98 #endif
  99
 100 #if USE(CF)
 101 protected:
 102 #if PLATFORM(IOS)
 103     JS_EXPORT_PRIVATE DefaultGCActivityCallback(Heap*, CFRunLoopRef);
 104 #else
 105     DefaultGCActivityCallback(Heap*, CFRunLoopRef);
 106 #endif // PLATFORM(IOS)
 107 #endif
 108 #if USE(CF) || PLATFORM(QT) || PLATFORM(EFL)
 109 protected:
 110     void cancelTimer();
 111     void scheduleTimer(double);
 112
 113 private:
 114     double m_delay;
 115 #endif
 116 };
 117
 118 inline PassOwnPtr<DefaultGCActivityCallback> DefaultGCActivityCallback::create(Heap* heap)
 119 {
 120 #if PLATFORM(IOS)
 121     // Big hack.
 122     if (GCActivityCallback::s_shouldCreateGCTimer)
 123         return adoptPtr(new DefaultGCActivityCallback(heap));
 124     return nullptr;
 125 #else
 126     return adoptPtr(new DefaultGCActivityCallback(heap));
 127 #endif // PLATFORM(IOS)
 128 }
 129
 130 }
 131
 132 #endif