inspector/agents/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 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(INSPECTOR)
  34
  35 #include "InspectorJSBackendDispatchers.h"
  36 #include "InspectorJSFrontendDispatchers.h"
  37 #include "inspector/InspectorAgentBase.h"
  38 #include <wtf/Forward.h>
  39 #include <wtf/HashMap.h>
  40 #include <wtf/Noncopyable.h>
  41 #include <wtf/text/WTFString.h>
  42
  43 namespace JSC {
  44 class ExecState;
  45 class Profile;
  46 }
  47
  48 namespace Inspector {
  49
  50 class ScriptDebugServer;
  51
  52 typedef String ErrorString;
  53
  54 class JS_EXPORT_PRIVATE InspectorProfilerAgent : public InspectorAgentBase, public InspectorProfilerBackendDispatcherHandler {
  55     WTF_MAKE_NONCOPYABLE(InspectorProfilerAgent);
  56     WTF_MAKE_FAST_ALLOCATED;
  57 public:
  58     virtual ~InspectorProfilerAgent();
  59
  60     virtual void didCreateFrontendAndBackend(InspectorFrontendChannel*, InspectorBackendDispatcher*) override final;
  61     virtual void willDestroyFrontendAndBackend(InspectorDisconnectReason) override final;
  62
  63     virtual void enable(ErrorString*) override final;
  64     virtual void disable(ErrorString*) override final;
  65
  66     virtual void start(ErrorString* = nullptr) override final;
  67     virtual void stop(ErrorString* = nullptr) override final;
  68
  69     virtual void clearProfiles(ErrorString*) override final { reset(); }
  70
  71     virtual void getProfileHeaders(ErrorString*, RefPtr<TypeBuilder::Array<TypeBuilder::Profiler::ProfileHeader>>&) override final;
  72     virtual void getCPUProfile(ErrorString*, int uid, RefPtr<TypeBuilder::Profiler::CPUProfile>&) override final;
  73     virtual void removeProfile(ErrorString*, const String& type, int uid) override final;
  74
  75     static PassRefPtr<TypeBuilder::Profiler::CPUProfile> buildProfileInspectorObject(const JSC::Profile*);
  76
  77     enum ShouldRecompile { SkipRecompile, Recompile };
  78
  79     virtual void enable(ShouldRecompile);
  80     virtual void disable(ShouldRecompile);
  81
  82     bool enabled() const { return m_enabled; }
  83
  84     void reset();
  85
  86     void setScriptDebugServer(ScriptDebugServer* scriptDebugServer) { m_scriptDebugServer = scriptDebugServer; }
  87
  88     String startProfiling(const String& title = String(), JSC::ExecState* = nullptr);
  89     PassRefPtr<JSC::Profile> stopProfiling(const String& title = String(), JSC::ExecState* = nullptr);
  90
  91 protected:
  92     InspectorProfilerAgent();
  93
  94     virtual JSC::ExecState* profilingGlobalExecState() const = 0;
  95
  96 private:
  97     void addProfile(PassRefPtr<JSC::Profile>);
  98
  99     void setRecordingProfile(bool isProfiling);
 100
 101     String getUserInitiatedProfileName();
 102
 103     PassRefPtr<TypeBuilder::Profiler::ProfileHeader> createProfileHeader(const JSC::Profile&);
 104
 105     std::unique_ptr<InspectorProfilerFrontendDispatcher> m_frontendDispatcher;
 106     RefPtr<InspectorProfilerBackendDispatcher> m_backendDispatcher;
 107     HashMap<unsigned, RefPtr<JSC::Profile>> m_profiles;
 108     ScriptDebugServer* m_scriptDebugServer;
 109     bool m_enabled;
 110     bool m_profileHeadersRequested;
 111     unsigned m_recordingProfileCount;
 112     unsigned m_nextUserInitiatedProfileNumber;
 113 };
 114
 115 } // namespace Inspector
 116
 117 #endif // ENABLE(INSPECTOR)
 118
 119 #endif // !defined(InspectorProfilerAgent_h)