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
34namespace v8 {
35namespace internal {
36
37class HeapSnapshot;
38class HeapSnapshotsCollection;
39
40#define HEAP_PROFILE(heap, call)                                             \
41  do {                                                                       \
42    v8::internal::HeapProfiler* profiler = heap->isolate()->heap_profiler(); \
43    if (profiler != NULL && profiler->is_profiling()) {                      \
44      profiler->call;                                                        \
45    }                                                                        \
46  } while (false)
47
48class HeapProfiler {
49 public:
50  explicit HeapProfiler(Heap* heap);
51  ~HeapProfiler();
52
53  size_t GetMemorySizeUsedByProfiler();
54
55  HeapSnapshot* TakeSnapshot(
56      const char* name,
57      v8::ActivityControl* control,
58      v8::HeapProfiler::ObjectNameResolver* resolver);
59  HeapSnapshot* TakeSnapshot(
60      String* name,
61      v8::ActivityControl* control,
62      v8::HeapProfiler::ObjectNameResolver* resolver);
63
64  void StartHeapObjectsTracking();
65  void StopHeapObjectsTracking();
66  SnapshotObjectId PushHeapObjectsStats(OutputStream* stream);
67  int GetSnapshotsCount();
68  HeapSnapshot* GetSnapshot(int index);
69  SnapshotObjectId GetSnapshotObjectId(Handle<Object> obj);
70  void DeleteAllSnapshots();
71
72  void ObjectMoveEvent(Address from, Address to);
73
74  void DefineWrapperClass(
75      uint16_t class_id, v8::HeapProfiler::WrapperInfoCallback callback);
76
77  v8::RetainedObjectInfo* ExecuteWrapperClassCallback(uint16_t class_id,
78                                                      Object** wrapper);
79  INLINE(bool is_profiling()) {
80    return snapshots_->is_tracking_objects();
81  }
82
83  void SetRetainedObjectInfo(UniqueId id, RetainedObjectInfo* info);
84
85 private:
86  Heap* heap() const { return snapshots_->heap(); }
87
88  HeapSnapshotsCollection* snapshots_;
89  unsigned next_snapshot_uid_;
90  List<v8::HeapProfiler::WrapperInfoCallback> wrapper_callbacks_;
91};
92
93} }  // namespace v8::internal
94
95#endif  // V8_HEAP_PROFILER_H_
96