v8-profiler.h

Go to the documentation of this file.

// Copyright 2010 the V8 project authors. All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
//       copyright notice, this list of conditions and the following
//       disclaimer in the documentation and/or other materials provided
//       with the distribution.
//     * Neither the name of Google Inc. nor the names of its
//       contributors may be used to endorse or promote products derived
//       from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#ifndef V8_V8_PROFILER_H_
#define V8_V8_PROFILER_H_

#include "v8.h"

#ifdef _WIN32
// Setup for Windows DLL export/import. See v8.h in this directory for
// information on how to build/use V8 as a DLL.
#if defined(BUILDING_V8_SHARED) && defined(USING_V8_SHARED)
#error both BUILDING_V8_SHARED and USING_V8_SHARED are set - please check the\
  build configuration to ensure that at most one of these is set
#endif

#ifdef BUILDING_V8_SHARED
#define V8EXPORT __declspec(dllexport)
#elif USING_V8_SHARED
#define V8EXPORT __declspec(dllimport)
#else
#define V8EXPORT
#endif

#else  // _WIN32

// Setup for Linux shared library export. See v8.h in this directory for
// information on how to build/use V8 as shared library.
#if defined(__GNUC__) && (__GNUC__ >= 4) && defined(V8_SHARED)
#define V8EXPORT __attribute__ ((visibility("default")))
#else  // defined(__GNUC__) && (__GNUC__ >= 4)
#define V8EXPORT
#endif  // defined(__GNUC__) && (__GNUC__ >= 4)

#endif  // _WIN32


namespace v8 {

typedef uint32_t SnapshotObjectId;

class V8EXPORT CpuProfileNode {
 public:
  Handle<String> GetFunctionName() const;

  Handle<String> GetScriptResourceName() const;

  int GetLineNumber() const;

  double GetTotalTime() const;

  double GetSelfTime() const;

  double GetTotalSamplesCount() const;

  double GetSelfSamplesCount() const;

  unsigned GetCallUid() const;

  int GetChildrenCount() const;

  const CpuProfileNode* GetChild(int index) const;

  static const int kNoLineNumberInfo = Message::kNoLineNumberInfo;
};


class V8EXPORT CpuProfile {
 public:
  unsigned GetUid() const;

  Handle<String> GetTitle() const;

  const CpuProfileNode* GetBottomUpRoot() const;

  const CpuProfileNode* GetTopDownRoot() const;

  void Delete();
};


class V8EXPORT CpuProfiler {
 public:
  static int GetProfilesCount();

  static const CpuProfile* GetProfile(
      int index,
      Handle<Value> security_token = Handle<Value>());

  static const CpuProfile* FindProfile(
      unsigned uid,
      Handle<Value> security_token = Handle<Value>());

  static void StartProfiling(Handle<String> title);

  static const CpuProfile* StopProfiling(
      Handle<String> title,
      Handle<Value> security_token = Handle<Value>());

  static void DeleteAllProfiles();
};


class HeapGraphNode;


class V8EXPORT HeapGraphEdge {
 public:
  enum Type {
    kContextVariable = 0,  // A variable from a function context.
    kElement = 1,          // An element of an array.
    kProperty = 2,         // A named object property.
    kInternal = 3,         // A link that can't be accessed from JS,
                           // thus, its name isn't a real property name
                           // (e.g. parts of a ConsString).
    kHidden = 4,           // A link that is needed for proper sizes
                           // calculation, but may be hidden from user.
    kShortcut = 5,         // A link that must not be followed during
                           // sizes calculation.
    kWeak = 6              // A weak reference (ignored by the GC).
  };

  Type GetType() const;

  Handle<Value> GetName() const;

  const HeapGraphNode* GetFromNode() const;

  const HeapGraphNode* GetToNode() const;
};


class V8EXPORT HeapGraphNode {
 public:
  enum Type {
    kHidden = 0,      // Hidden node, may be filtered when shown to user.
    kArray = 1,       // An array of elements.
    kString = 2,      // A string.
    kObject = 3,      // A JS object (except for arrays and strings).
    kCode = 4,        // Compiled code.
    kClosure = 5,     // Function closure.
    kRegExp = 6,      // RegExp.
    kHeapNumber = 7,  // Number stored in the heap.
    kNative = 8,      // Native object (not from V8 heap).
    kSynthetic = 9    // Synthetic object, usualy used for grouping
                      // snapshot items together.
  };

  Type GetType() const;

  Handle<String> GetName() const;

  SnapshotObjectId GetId() const;

  int GetSelfSize() const;

  int GetRetainedSize() const;

  int GetChildrenCount() const;

  const HeapGraphEdge* GetChild(int index) const;

  int GetRetainersCount() const;

  const HeapGraphEdge* GetRetainer(int index) const;

  const HeapGraphNode* GetDominatorNode() const;

  Handle<Value> GetHeapValue() const;
};


class V8EXPORT HeapSnapshot {
 public:
  enum Type {
    kFull = 0  // Heap snapshot with all instances and references.
  };
  enum SerializationFormat {
    kJSON = 0  // See format description near 'Serialize' method.
  };

  Type GetType() const;

  unsigned GetUid() const;

  Handle<String> GetTitle() const;

  const HeapGraphNode* GetRoot() const;

  const HeapGraphNode* GetNodeById(SnapshotObjectId id) const;

  int GetNodesCount() const;

  const HeapGraphNode* GetNode(int index) const;

  SnapshotObjectId GetMaxSnapshotJSObjectId() const;

  void Delete();

  void Serialize(OutputStream* stream, SerializationFormat format) const;
};


class RetainedObjectInfo;

class V8EXPORT HeapProfiler {
 public:
  typedef RetainedObjectInfo* (*WrapperInfoCallback)
      (uint16_t class_id, Handle<Value> wrapper);

  static int GetSnapshotsCount();

  static const HeapSnapshot* GetSnapshot(int index);

  static const HeapSnapshot* FindSnapshot(unsigned uid);

  static SnapshotObjectId GetSnapshotObjectId(Handle<Value> value);

  static const SnapshotObjectId kUnknownObjectId = 0;

  static const HeapSnapshot* TakeSnapshot(
      Handle<String> title,
      HeapSnapshot::Type type = HeapSnapshot::kFull,
      ActivityControl* control = NULL);

  static void StartHeapObjectsTracking();

  static SnapshotObjectId PushHeapObjectsStats(OutputStream* stream);

  static void StopHeapObjectsTracking();

  static void DeleteAllSnapshots();

  static void DefineWrapperClass(
      uint16_t class_id,
      WrapperInfoCallback callback);

  static const uint16_t kPersistentHandleNoClassId = 0;

  static int GetPersistentHandleCount();

  static size_t GetMemorySizeUsedByProfiler();
};


class V8EXPORT RetainedObjectInfo {  // NOLINT
 public:
  virtual void Dispose() = 0;

  virtual bool IsEquivalent(RetainedObjectInfo* other) = 0;

  virtual intptr_t GetHash() = 0;

  virtual const char* GetLabel() = 0;

  virtual const char* GetGroupLabel() { return GetLabel(); }

  virtual intptr_t GetElementCount() { return -1; }

  virtual intptr_t GetSizeInBytes() { return -1; }

 protected:
  RetainedObjectInfo() {}
  virtual ~RetainedObjectInfo() {}

 private:
  RetainedObjectInfo(const RetainedObjectInfo&);
  RetainedObjectInfo& operator=(const RetainedObjectInfo&);
};


struct HeapStatsUpdate {
  HeapStatsUpdate(uint32_t index, uint32_t count, uint32_t size)
    : index(index), count(count), size(size) { }
  uint32_t index;  // Index of the time interval that was changed.
  uint32_t count;  // New value of count field for the interval with this index.
  uint32_t size;  // New value of size field for the interval with this index.
};


}  // namespace v8


#undef V8EXPORT


#endif  // V8_V8_PROFILER_H_