329909f0a6be4e9b47adceb59d6c6645137086ec
[WebKit-https.git] / Source / WebCore / inspector / InspectorProfilerAgent.h
1 /*
2  * Copyright (C) 2010 Apple Inc. All rights reserved.
3  * Copyright (C) 2010 Google Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer.
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution.
14  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
15  *     its contributors may be used to endorse or promote products derived
16  *     from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #ifndef InspectorProfilerAgent_h
31 #define InspectorProfilerAgent_h
32
33 #if ENABLE(JAVASCRIPT_DEBUGGER) && ENABLE(INSPECTOR)
34
35 #include "InspectorBaseAgent.h"
36 #include "InspectorFrontend.h"
37 #include "PlatformString.h"
38 #include <wtf/Forward.h>
39 #include <wtf/HashMap.h>
40 #include <wtf/Noncopyable.h>
41 #include <wtf/PassOwnPtr.h>
42
43 namespace WebCore {
44
45 class InjectedScriptManager;
46 class InspectorArray;
47 class InspectorConsoleAgent;
48 class InspectorFrontend;
49 class InspectorObject;
50 class InspectorState;
51 class InstrumentingAgents;
52 class Page;
53 class ScriptHeapSnapshot;
54 class ScriptProfile;
55 class WorkerContext;
56
57 typedef String ErrorString;
58
59 class InspectorProfilerAgent : public InspectorBaseAgent<InspectorProfilerAgent>, public InspectorBackendDispatcher::ProfilerCommandHandler {
60     WTF_MAKE_NONCOPYABLE(InspectorProfilerAgent); WTF_MAKE_FAST_ALLOCATED;
61 public:
62     static PassOwnPtr<InspectorProfilerAgent> create(InstrumentingAgents*, InspectorConsoleAgent*, Page*, InspectorState*, InjectedScriptManager*);
63 #if ENABLE(WORKERS)
64     static PassOwnPtr<InspectorProfilerAgent> create(InstrumentingAgents*, InspectorConsoleAgent*, WorkerContext*, InspectorState*, InjectedScriptManager*);
65 #endif
66     virtual ~InspectorProfilerAgent();
67
68     void addProfile(PassRefPtr<ScriptProfile> prpProfile, unsigned lineNumber, const String& sourceURL);
69     void addProfileFinishedMessageToConsole(PassRefPtr<ScriptProfile>, unsigned lineNumber, const String& sourceURL);
70     void addStartProfilingMessageToConsole(const String& title, unsigned lineNumber, const String& sourceURL);
71     virtual void collectGarbage(ErrorString*);
72     virtual void clearProfiles(ErrorString*) { resetState(); }
73     void resetState();
74
75     virtual void causesRecompilation(ErrorString*, bool*);
76     virtual void isSampling(ErrorString*, bool*);
77     virtual void hasHeapProfiler(ErrorString*, bool*);
78
79     virtual void enable(ErrorString*);
80     virtual void disable(ErrorString*);
81     virtual void start(ErrorString* = 0);
82     virtual void stop(ErrorString* = 0);
83
84     void disable();
85     void enable(bool skipRecompile);
86     bool enabled() { return m_enabled; }
87     String getCurrentUserInitiatedProfileName(bool incrementProfileNumber = false);
88     virtual void getProfileHeaders(ErrorString*, RefPtr<TypeBuilder::Array<TypeBuilder::Profiler::ProfileHeader> >&);
89     virtual void getProfile(ErrorString*, const String& type, int uid, RefPtr<TypeBuilder::Profiler::Profile>&);
90     virtual void removeProfile(ErrorString*, const String& type, int uid);
91
92     virtual void setFrontend(InspectorFrontend*);
93     virtual void clearFrontend();
94     virtual void restore();
95
96     virtual void takeHeapSnapshot(ErrorString*);
97     void toggleRecordButton(bool isProfiling);
98
99     virtual void getObjectByHeapObjectId(ErrorString*, const String& heapSnapshotObjectId, const String* objectGroup, RefPtr<TypeBuilder::Runtime::RemoteObject>& result);
100     virtual void getHeapObjectId(ErrorString*, const String& objectId, String* heapSnapshotObjectId);
101
102 protected:
103     InspectorProfilerAgent(InstrumentingAgents*, InspectorConsoleAgent*, InspectorState*, InjectedScriptManager*);
104     virtual void startProfiling(const String& title) = 0;
105     virtual PassRefPtr<ScriptProfile> stopProfiling(const String& title) = 0;
106
107 private:
108     typedef HashMap<unsigned int, RefPtr<ScriptProfile> > ProfilesMap;
109     typedef HashMap<unsigned int, RefPtr<ScriptHeapSnapshot> > HeapSnapshotsMap;
110
111     void resetFrontendProfiles();
112     void restoreEnablement();
113
114     PassRefPtr<TypeBuilder::Profiler::ProfileHeader> createProfileHeader(const ScriptProfile&);
115     PassRefPtr<TypeBuilder::Profiler::ProfileHeader> createSnapshotHeader(const ScriptHeapSnapshot&);
116
117     InspectorConsoleAgent* m_consoleAgent;
118     InjectedScriptManager* m_injectedScriptManager;
119     InspectorFrontend::Profiler* m_frontend;
120     bool m_enabled;
121     bool m_recordingUserInitiatedProfile;
122     bool m_headersRequested;
123     int m_currentUserInitiatedProfileNumber;
124     unsigned m_nextUserInitiatedProfileNumber;
125     unsigned m_nextUserInitiatedHeapSnapshotNumber;
126     ProfilesMap m_profiles;
127     HeapSnapshotsMap m_snapshots;
128 };
129
130 } // namespace WebCore
131
132 #endif // ENABLE(JAVASCRIPT_DEBUGGER) && ENABLE(INSPECTOR)
133
134 #endif // !defined(InspectorProfilerAgent_h)