2a2b7fb9f3764286817b464f5182b6fe43099a7c
[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 "InspectorWebAgentBase.h"
36 #include "InspectorWebBackendDispatchers.h"
37 #include "InspectorWebFrontendDispatchers.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
44 namespace Inspector {
45 class InspectorArray;
46 class InspectorObject;
47 }
48
49 namespace WebCore {
50
51 class InspectorConsoleAgent;
52 class InstrumentingAgents;
53 class Page;
54 class PageInjectedScriptManager;
55 class ScriptHeapSnapshot;
56 class ScriptProfile;
57 class WorkerGlobalScope;
58
59 typedef String ErrorString;
60
61 class InspectorProfilerAgent : public InspectorAgentBase, public Inspector::InspectorProfilerBackendDispatcherHandler {
62     WTF_MAKE_NONCOPYABLE(InspectorProfilerAgent); WTF_MAKE_FAST_ALLOCATED;
63 public:
64     static std::unique_ptr<InspectorProfilerAgent> create(InstrumentingAgents*, InspectorConsoleAgent*, Page*, PageInjectedScriptManager*);
65     static std::unique_ptr<InspectorProfilerAgent> create(InstrumentingAgents*, InspectorConsoleAgent*, WorkerGlobalScope*, PageInjectedScriptManager*);
66
67     virtual ~InspectorProfilerAgent();
68
69     void addProfile(PassRefPtr<ScriptProfile> prpProfile, unsigned lineNumber, unsigned columnNumber, const String& sourceURL);
70     void addProfileFinishedMessageToConsole(PassRefPtr<ScriptProfile>, unsigned lineNumber, unsigned columnNumber, const String& sourceURL);
71     void addStartProfilingMessageToConsole(const String& title, unsigned lineNumber, unsigned columnNumber, const String& sourceURL);
72     virtual void collectGarbage(ErrorString*) override;
73     virtual void clearProfiles(ErrorString*) override { resetState(); }
74     void resetState();
75
76     virtual void recompileScript() = 0;
77     virtual void isSampling(ErrorString*, bool*) override;
78     virtual void hasHeapProfiler(ErrorString*, bool*) override;
79
80     virtual void enable(ErrorString*) override;
81     virtual void disable(ErrorString*) override;
82     virtual void start(ErrorString* = nullptr) override;
83     virtual void stop(ErrorString* = nullptr) override;
84
85     void disable();
86     void enable(bool skipRecompile);
87     bool enabled() const { return m_enabled; }
88     String getCurrentUserInitiatedProfileName(bool incrementProfileNumber = false);
89     virtual void getProfileHeaders(ErrorString*, RefPtr<Inspector::TypeBuilder::Array<Inspector::TypeBuilder::Profiler::ProfileHeader>>&) override;
90     virtual void getCPUProfile(ErrorString*, int uid, RefPtr<Inspector::TypeBuilder::Profiler::CPUProfile>&) override;
91     virtual void getHeapSnapshot(ErrorString*, int uid) override;
92     virtual void removeProfile(ErrorString*, const String& type, int uid) override;
93
94     virtual void didCreateFrontendAndBackend(Inspector::InspectorFrontendChannel*, Inspector::InspectorBackendDispatcher*) override;
95     virtual void willDestroyFrontendAndBackend() override;
96
97     virtual void takeHeapSnapshot(ErrorString*, const bool* reportProgress) override;
98     void toggleRecordButton(bool isProfiling);
99
100     virtual void getObjectByHeapObjectId(ErrorString*, const String& heapSnapshotObjectId, const String* objectGroup, RefPtr<Inspector::TypeBuilder::Runtime::RemoteObject>& result) override;
101     virtual void getHeapObjectId(ErrorString*, const String& objectId, String* heapSnapshotObjectId) override;
102
103 protected:
104     InspectorProfilerAgent(InstrumentingAgents*, InspectorConsoleAgent*, PageInjectedScriptManager*);
105     virtual void startProfiling(const String& title) = 0;
106     virtual PassRefPtr<ScriptProfile> stopProfiling(const String& title) = 0;
107
108 private:
109     typedef HashMap<unsigned int, RefPtr<ScriptProfile>> ProfilesMap;
110     typedef HashMap<unsigned int, RefPtr<ScriptHeapSnapshot>> HeapSnapshotsMap;
111
112     void resetFrontendProfiles();
113     void restoreEnablement();
114
115     PassRefPtr<Inspector::TypeBuilder::Profiler::ProfileHeader> createProfileHeader(const ScriptProfile&);
116     PassRefPtr<Inspector::TypeBuilder::Profiler::ProfileHeader> createSnapshotHeader(const ScriptHeapSnapshot&);
117
118     InspectorConsoleAgent* m_consoleAgent;
119     PageInjectedScriptManager* m_injectedScriptManager;
120     std::unique_ptr<Inspector::InspectorProfilerFrontendDispatcher> m_frontendDispatcher;
121     RefPtr<Inspector::InspectorProfilerBackendDispatcher> m_backendDispatcher;
122     bool m_enabled;
123     bool m_profileHeadersRequested;
124     bool m_recordingCPUProfile;
125     int m_currentUserInitiatedProfileNumber;
126     unsigned m_nextUserInitiatedProfileNumber;
127     unsigned m_nextUserInitiatedHeapSnapshotNumber;
128     ProfilesMap m_profiles;
129     HeapSnapshotsMap m_snapshots;
130
131     typedef HashMap<String, double> ProfileNameIdleTimeMap;
132     ProfileNameIdleTimeMap* m_profileNameIdleTimeMap;
133 };
134
135 } // namespace WebCore
136
137 #endif // ENABLE(JAVASCRIPT_DEBUGGER) && ENABLE(INSPECTOR)
138
139 #endif // !defined(InspectorProfilerAgent_h)