src/third_party/WebKit/Source/core/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 #include "InspectorFrontend.h"
  34 #include "core/inspector/InspectorBaseAgent.h"
  35 #include "wtf/Forward.h"
  36 #include "wtf/HashMap.h"
  37 #include "wtf/Noncopyable.h"
  38 #include "wtf/PassOwnPtr.h"
  39 #include "wtf/text/WTFString.h"
  40
  41 namespace WebCore {
  42
  43 class InjectedScriptManager;
  44 class InspectorConsoleAgent;
  45 class InspectorFrontend;
  46 class InstrumentingAgents;
  47 class ScriptCallStack;
  48 class ScriptProfile;
  49
  50 typedef String ErrorString;
  51
  52 class InspectorProfilerAgent : public InspectorBaseAgent<InspectorProfilerAgent>, public InspectorBackendDispatcher::ProfilerCommandHandler {
  53     WTF_MAKE_NONCOPYABLE(InspectorProfilerAgent); WTF_MAKE_FAST_ALLOCATED;
  54 public:
  55     static PassOwnPtr<InspectorProfilerAgent> create(InstrumentingAgents*, InspectorConsoleAgent*, InspectorCompositeState*, InjectedScriptManager*);
  56     virtual ~InspectorProfilerAgent();
  57
  58     void addProfile(PassRefPtr<ScriptProfile> prpProfile, PassRefPtr<ScriptCallStack>);
  59     void addProfileFinishedMessageToConsole(PassRefPtr<ScriptProfile>, unsigned lineNumber, const String& sourceURL);
  60     virtual void clearProfiles(ErrorString*);
  61
  62     virtual void enable(ErrorString*);
  63     virtual void disable(ErrorString*);
  64     virtual void setSamplingInterval(ErrorString*, int);
  65     virtual void start(ErrorString* = 0);
  66     virtual void stop(ErrorString*, RefPtr<TypeBuilder::Profiler::ProfileHeader>& header);
  67
  68     bool enabled();
  69     String getCurrentUserInitiatedProfileName(bool incrementProfileNumber = false);
  70     virtual void getCPUProfile(ErrorString*, int uid, RefPtr<TypeBuilder::Profiler::CPUProfile>&);
  71     virtual void removeProfile(ErrorString*, const String& type, int uid);
  72
  73     virtual void setFrontend(InspectorFrontend*);
  74     virtual void clearFrontend();
  75     virtual void restore();
  76
  77     void toggleRecordButton(bool isProfiling);
  78
  79     void willProcessTask();
  80     void didProcessTask();
  81     void willEnterNestedRunLoop();
  82     void didLeaveNestedRunLoop();
  83
  84 private:
  85     InspectorProfilerAgent(InstrumentingAgents*, InspectorConsoleAgent*, InspectorCompositeState*, InjectedScriptManager*);
  86
  87     void doEnable();
  88
  89     void addProfile(PassRefPtr<ScriptProfile> prpProfile, unsigned lineNumber, const String& sourceURL);
  90
  91     void resetFrontendProfiles();
  92     PassRefPtr<TypeBuilder::Profiler::ProfileHeader> stop(ErrorString* = 0);
  93
  94     PassRefPtr<TypeBuilder::Profiler::ProfileHeader> createProfileHeader(const ScriptProfile&);
  95
  96     InspectorConsoleAgent* m_consoleAgent;
  97     InjectedScriptManager* m_injectedScriptManager;
  98     InspectorFrontend::Profiler* m_frontend;
  99     bool m_recordingCPUProfile;
 100     int m_currentUserInitiatedProfileNumber;
 101     unsigned m_nextUserInitiatedProfileNumber;
 102     typedef HashMap<unsigned, RefPtr<ScriptProfile> > ProfilesMap;
 103     ProfilesMap m_profiles;
 104
 105     typedef HashMap<String, double> ProfileNameIdleTimeMap;
 106     ProfileNameIdleTimeMap* m_profileNameIdleTimeMap;
 107     double m_idleStartTime;
 108
 109     void idleStarted();
 110     void idleFinished();
 111 };
 112
 113 } // namespace WebCore
 114
 115
 116 #endif // !defined(InspectorProfilerAgent_h)