ca1bb8a61a83c8f085c0ebbe97abdbb6dcde5749
[WebKit-https.git] / Source / JavaScriptCore / inspector / agents / InspectorScriptProfilerAgent.h
1 /*
2  * Copyright (C) 2015-2016 Apple 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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "InspectorBackendDispatchers.h"
29 #include "InspectorFrontendDispatchers.h"
30 #include "inspector/InspectorAgentBase.h"
31 #include "inspector/ScriptDebugServer.h"
32 #include <wtf/Noncopyable.h>
33
34 namespace JSC {
35 class Profile;
36 }
37
38 namespace Inspector {
39
40 typedef String ErrorString;
41
42 class JS_EXPORT_PRIVATE InspectorScriptProfilerAgent final : public InspectorAgentBase, public ScriptProfilerBackendDispatcherHandler, public JSC::Debugger::ProfilingClient {
43     WTF_MAKE_NONCOPYABLE(InspectorScriptProfilerAgent);
44 public:
45     InspectorScriptProfilerAgent(AgentContext&);
46     virtual ~InspectorScriptProfilerAgent();
47
48     void didCreateFrontendAndBackend(FrontendRouter*, BackendDispatcher*) override;
49     void willDestroyFrontendAndBackend(DisconnectReason) override;
50
51     // ScriptProfilerBackendDispatcherHandler
52     void startTracking(ErrorString&, const bool* const includeSamples) override;
53     void stopTracking(ErrorString&) override;
54
55     void programmaticCaptureStarted();
56     void programmaticCaptureStopped();
57
58     // Debugger::ProfilingClient
59     bool isAlreadyProfiling() const override;
60     double willEvaluateScript() override;
61     void didEvaluateScript(double, JSC::ProfilingReason) override;
62
63 private:
64     struct Event {
65         Event(double start, double end) : startTime(start), endTime(end) { }
66         double startTime { 0 };
67         double endTime { 0 };
68     };
69
70     void addEvent(double startTime, double endTime, JSC::ProfilingReason);
71     void trackingComplete();
72     void stopSamplingWhenDisconnecting();
73
74     std::unique_ptr<ScriptProfilerFrontendDispatcher> m_frontendDispatcher;
75     RefPtr<ScriptProfilerBackendDispatcher> m_backendDispatcher;
76     InspectorEnvironment& m_environment;
77     bool m_tracking { false };
78 #if ENABLE(SAMPLING_PROFILER)
79     bool m_enabledSamplingProfiler { false };
80 #endif
81     bool m_activeEvaluateScript { false };
82 };
83
84 } // namespace Inspector