src/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 "heap-snapshot-generator-inl.h"
  32 #include "isolate.h"
  33 #include "smart-pointers.h"
  34
  35 namespace v8 {
  36 namespace internal {
  37
  38 class HeapSnapshot;
  39
  40 class HeapProfiler {
  41  public:
  42   explicit HeapProfiler(Heap* heap);
  43   ~HeapProfiler();
  44
  45   size_t GetMemorySizeUsedByProfiler();
  46
  47   HeapSnapshot* TakeSnapshot(
  48       const char* name,
  49       v8::ActivityControl* control,
  50       v8::HeapProfiler::ObjectNameResolver* resolver);
  51   HeapSnapshot* TakeSnapshot(
  52       String* name,
  53       v8::ActivityControl* control,
  54       v8::HeapProfiler::ObjectNameResolver* resolver);
  55
  56   void StartHeapObjectsTracking(bool track_allocations);
  57   void StopHeapObjectsTracking();
  58   AllocationTracker* allocation_tracker() const {
  59     return allocation_tracker_.get();
  60   }
  61   HeapObjectsMap* heap_object_map() const { return ids_.get(); }
  62   StringsStorage* names() const { return names_.get(); }
  63
  64   SnapshotObjectId PushHeapObjectsStats(OutputStream* stream);
  65   int GetSnapshotsCount();
  66   HeapSnapshot* GetSnapshot(int index);
  67   SnapshotObjectId GetSnapshotObjectId(Handle<Object> obj);
  68   void DeleteAllSnapshots();
  69   void RemoveSnapshot(HeapSnapshot* snapshot);
  70
  71   void ObjectMoveEvent(Address from, Address to, int size);
  72
  73   void AllocationEvent(Address addr, int size);
  74
  75   void UpdateObjectSizeEvent(Address addr, int size);
  76
  77   void DefineWrapperClass(
  78       uint16_t class_id, v8::HeapProfiler::WrapperInfoCallback callback);
  79
  80   v8::RetainedObjectInfo* ExecuteWrapperClassCallback(uint16_t class_id,
  81                                                       Object** wrapper);
  82   void SetRetainedObjectInfo(UniqueId id, RetainedObjectInfo* info);
  83
  84   bool is_tracking_object_moves() const { return is_tracking_object_moves_; }
  85   bool is_tracking_allocations() const {
  86     return !allocation_tracker_.is_empty();
  87   }
  88
  89   Handle<HeapObject> FindHeapObjectById(SnapshotObjectId id);
  90   void ClearHeapObjectMap();
  91
  92  private:
  93   Heap* heap() const { return ids_->heap(); }
  94
  95   // Mapping from HeapObject addresses to objects' uids.
  96   SmartPointer<HeapObjectsMap> ids_;
  97   List<HeapSnapshot*> snapshots_;
  98   SmartPointer<StringsStorage> names_;
  99   unsigned next_snapshot_uid_;
 100   List<v8::HeapProfiler::WrapperInfoCallback> wrapper_callbacks_;
 101   SmartPointer<AllocationTracker> allocation_tracker_;
 102   bool is_tracking_object_moves_;
 103 };
 104
 105 } }  // namespace v8::internal
 106
 107 #endif  // V8_HEAP_PROFILER_H_