src/third_party/WebKit/Source/core/inspector/InspectorHeapProfilerAgent.h

   1 /*
   2  * Copyright (C) 2013 Google 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 are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef InspectorHeapProfilerAgent_h
  32 #define InspectorHeapProfilerAgent_h
  33
  34 #include "core/InspectorFrontend.h"
  35 #include "core/inspector/InspectorBaseAgent.h"
  36 #include "wtf/Forward.h"
  37 #include "wtf/HashMap.h"
  38 #include "wtf/Noncopyable.h"
  39 #include "wtf/OwnPtr.h"
  40 #include "wtf/PassOwnPtr.h"
  41 #include "wtf/text/WTFString.h"
  42
  43 namespace blink {
  44
  45 class InjectedScriptManager;
  46 class HeapStatsUpdateTask;
  47 class ScriptHeapSnapshot;
  48
  49 typedef String ErrorString;
  50
  51 class InspectorHeapProfilerAgent FINAL : public InspectorBaseAgent<InspectorHeapProfilerAgent>, public InspectorBackendDispatcher::HeapProfilerCommandHandler {
  52     WTF_MAKE_NONCOPYABLE(InspectorHeapProfilerAgent);
  53     WTF_MAKE_FAST_ALLOCATED_WILL_BE_REMOVED;
  54 public:
  55     static PassOwnPtrWillBeRawPtr<InspectorHeapProfilerAgent> create(InjectedScriptManager*);
  56     virtual ~InspectorHeapProfilerAgent();
  57     virtual void trace(Visitor*) OVERRIDE;
  58
  59     virtual void collectGarbage(ErrorString*) OVERRIDE;
  60
  61     virtual void enable(ErrorString*) OVERRIDE;
  62     virtual void disable(ErrorString*) OVERRIDE;
  63     virtual void startTrackingHeapObjects(ErrorString*, const bool* trackAllocations) OVERRIDE;
  64     virtual void stopTrackingHeapObjects(ErrorString*, const bool* reportProgress) OVERRIDE;
  65
  66     virtual void setFrontend(InspectorFrontend*) OVERRIDE;
  67     virtual void clearFrontend() OVERRIDE;
  68     virtual void restore() OVERRIDE;
  69
  70     virtual void takeHeapSnapshot(ErrorString*, const bool* reportProgress) OVERRIDE;
  71
  72     virtual void getObjectByHeapObjectId(ErrorString*, const String& heapSnapshotObjectId, const String* objectGroup, RefPtr<TypeBuilder::Runtime::RemoteObject>& result) OVERRIDE;
  73     virtual void getHeapObjectId(ErrorString*, const String& objectId, String* heapSnapshotObjectId) OVERRIDE;
  74
  75 private:
  76     class HeapStatsStream;
  77     class HeapStatsUpdateTask;
  78
  79     explicit InspectorHeapProfilerAgent(InjectedScriptManager*);
  80
  81     void requestHeapStatsUpdate();
  82     void pushHeapStatsUpdate(const uint32_t* const data, const int size);
  83
  84     void startTrackingHeapObjectsInternal(bool trackAllocations);
  85     void stopTrackingHeapObjectsInternal();
  86
  87     RawPtrWillBeMember<InjectedScriptManager> m_injectedScriptManager;
  88     InspectorFrontend::HeapProfiler* m_frontend;
  89     unsigned m_nextUserInitiatedHeapSnapshotNumber;
  90     OwnPtrWillBeMember<HeapStatsUpdateTask> m_heapStatsUpdateTask;
  91 };
  92
  93 } // namespace blink
  94
  95
  96 #endif // !defined(InspectorHeapProfilerAgent_h)