src/3rdparty/v8/src/heap-profiler.h

   1 // Copyright 2009-2010 the V8 project authors. All rights reserved.
   2 // Redistribution and use in source and binary forms, with or without
   3 // modification, are permitted provided that the following conditions are
   4 // met:
   5 //
   6 //     * Redistributions of source code must retain the above copyright
   7 //       notice, this list of conditions and the following disclaimer.
   8 //     * Redistributions in binary form must reproduce the above
   9 //       copyright notice, this list of conditions and the following
  10 //       disclaimer in the documentation and/or other materials provided
  11 //       with the distribution.
  12 //     * Neither the name of Google Inc. nor the names of its
  13 //       contributors may be used to endorse or promote products derived
  14 //       from this software without specific prior written permission.
  15 //
  16 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27
  28 #ifndef V8_HEAP_PROFILER_H_
  29 #define V8_HEAP_PROFILER_H_
  30
  31 #include "isolate.h"
  32
  33 namespace v8 {
  34 namespace internal {
  35
  36 class HeapSnapshot;
  37 class HeapSnapshotsCollection;
  38
  39 #define HEAP_PROFILE(heap, call)                                             \
  40   do {                                                                       \
  41     v8::internal::HeapProfiler* profiler = heap->isolate()->heap_profiler(); \
  42     if (profiler != NULL && profiler->is_profiling()) {                      \
  43       profiler->call;                                                        \
  44     }                                                                        \
  45   } while (false)
  46
  47 class HeapProfiler {
  48  public:
  49   static void SetUp();
  50   static void TearDown();
  51
  52   static HeapSnapshot* TakeSnapshot(const char* name,
  53                                     int type,
  54                                     v8::ActivityControl* control);
  55   static HeapSnapshot* TakeSnapshot(String* name,
  56                                     int type,
  57                                     v8::ActivityControl* control);
  58
  59   static void StartHeapObjectsTracking();
  60   static void StopHeapObjectsTracking();
  61   static void PushHeapObjectsStats(OutputStream* stream);
  62   static int GetSnapshotsCount();
  63   static HeapSnapshot* GetSnapshot(int index);
  64   static HeapSnapshot* FindSnapshot(unsigned uid);
  65   static SnapshotObjectId GetSnapshotObjectId(Handle<Object> obj);
  66   static void DeleteAllSnapshots();
  67
  68   void ObjectMoveEvent(Address from, Address to);
  69
  70   void DefineWrapperClass(
  71       uint16_t class_id, v8::HeapProfiler::WrapperInfoCallback callback);
  72
  73   v8::RetainedObjectInfo* ExecuteWrapperClassCallback(uint16_t class_id,
  74                                                       Object** wrapper);
  75   INLINE(bool is_profiling()) {
  76     return snapshots_->is_tracking_objects();
  77   }
  78
  79  private:
  80   HeapProfiler();
  81   ~HeapProfiler();
  82   HeapSnapshot* TakeSnapshotImpl(const char* name,
  83                                  int type,
  84                                  v8::ActivityControl* control);
  85   HeapSnapshot* TakeSnapshotImpl(String* name,
  86                                  int type,
  87                                  v8::ActivityControl* control);
  88   void ResetSnapshots();
  89
  90   void StartHeapObjectsTrackingImpl();
  91   void StopHeapObjectsTrackingImpl();
  92   void PushHeapObjectsStatsImpl(OutputStream* stream);
  93
  94   HeapSnapshotsCollection* snapshots_;
  95   unsigned next_snapshot_uid_;
  96   List<v8::HeapProfiler::WrapperInfoCallback> wrapper_callbacks_;
  97 };
  98
  99 } }  // namespace v8::internal
 100
 101 #endif  // V8_HEAP_PROFILER_H_