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#if ENABLE(JAVASCRIPT_DEBUGGER) && ENABLE(INSPECTOR)
35
36#include "InspectorBaseAgent.h"
37#include "InspectorFrontend.h"
38#include <wtf/Forward.h>
39#include <wtf/HashMap.h>
40#include <wtf/Noncopyable.h>
41#include <wtf/PassOwnPtr.h>
42#include <wtf/text/WTFString.h>
43
44namespace WebCore {
45
46class InjectedScriptManager;
47class ScriptHeapSnapshot;
48class ScriptProfile;
49
50typedef String ErrorString;
51
52class InspectorHeapProfilerAgent : public InspectorBaseAgent<InspectorHeapProfilerAgent>, public InspectorBackendDispatcher::HeapProfilerCommandHandler {
53    WTF_MAKE_NONCOPYABLE(InspectorHeapProfilerAgent); WTF_MAKE_FAST_ALLOCATED;
54public:
55    static PassOwnPtr<InspectorHeapProfilerAgent> create(InstrumentingAgents*, InspectorCompositeState*, InjectedScriptManager*);
56    virtual ~InspectorHeapProfilerAgent();
57
58    virtual void collectGarbage(ErrorString*);
59    virtual void clearProfiles(ErrorString*) { resetState(); }
60    void resetState();
61
62    virtual void hasHeapProfiler(ErrorString*, bool*);
63
64    virtual void getProfileHeaders(ErrorString*, RefPtr<TypeBuilder::Array<TypeBuilder::HeapProfiler::ProfileHeader> >&);
65    virtual void getHeapSnapshot(ErrorString*, int uid);
66    virtual void removeProfile(ErrorString*, int uid);
67
68    virtual void setFrontend(InspectorFrontend*);
69    virtual void clearFrontend();
70    virtual void restore();
71
72    virtual void takeHeapSnapshot(ErrorString*, const bool* reportProgress);
73
74    virtual void getObjectByHeapObjectId(ErrorString*, const String& heapSnapshotObjectId, const String* objectGroup, RefPtr<TypeBuilder::Runtime::RemoteObject>& result);
75    virtual void getHeapObjectId(ErrorString*, const String& objectId, String* heapSnapshotObjectId);
76
77private:
78    InspectorHeapProfilerAgent(InstrumentingAgents*, InspectorCompositeState*, InjectedScriptManager*);
79
80    typedef HashMap<unsigned, RefPtr<ScriptHeapSnapshot> > IdToHeapSnapshotMap;
81
82    void resetFrontendProfiles();
83
84    PassRefPtr<TypeBuilder::HeapProfiler::ProfileHeader> createSnapshotHeader(const ScriptHeapSnapshot&);
85
86    InjectedScriptManager* m_injectedScriptManager;
87    InspectorFrontend::HeapProfiler* m_frontend;
88    unsigned m_nextUserInitiatedHeapSnapshotNumber;
89    IdToHeapSnapshotMap m_snapshots;
90};
91
92} // namespace WebCore
93
94#endif // ENABLE(JAVASCRIPT_DEBUGGER) && ENABLE(INSPECTOR)
95
96#endif // !defined(InspectorHeapProfilerAgent_h)
97