Home | History | Annotate | Download | only in inspector 
      1 /*
      2  * Copyright (C) 2013 Google 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 are
      6  * met:
      7  *
      8  *     * Redistributions of source code must retain the above copyright
      9  * notice, this list of conditions and the following disclaimer.
     10  *     * Redistributions in binary form must reproduce the above
     11  * copyright notice, this list of conditions and the following disclaimer
     12  * in the documentation and/or other materials provided with the
     13  * distribution.
     14  *     * Neither the name of Google Inc. nor the names of its
     15  * contributors may be used to endorse or promote products derived from
     16  * this software without specific prior written permission.
     17  *
     18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     29  */
     30 
     31 #ifndef InspectorHeapProfilerAgent_h
     32 #define InspectorHeapProfilerAgent_h
     33 
     34 #include "InspectorFrontend.h"
     35 #include "core/inspector/InspectorBaseAgent.h"
     36 #include "wtf/Forward.h"
     37 #include "wtf/HashMap.h"
     38 #include "wtf/Noncopyable.h"
     39 #include "wtf/OwnPtr.h"
     40 #include "wtf/PassOwnPtr.h"
     41 #include "wtf/text/WTFString.h"
     42 
     43 namespace WebCore {
     44 
     45 class InjectedScriptManager;
     46 class HeapStatsUpdateTask;
     47 class ScriptHeapSnapshot;
     48 
     49 typedef String ErrorString;
     50 
     51 class InspectorHeapProfilerAgent : public InspectorBaseAgent<InspectorHeapProfilerAgent>, public InspectorBackendDispatcher::HeapProfilerCommandHandler {
     52     WTF_MAKE_NONCOPYABLE(InspectorHeapProfilerAgent); WTF_MAKE_FAST_ALLOCATED;
     53 public:
     54     static PassOwnPtr<InspectorHeapProfilerAgent> create(InstrumentingAgents*, InspectorCompositeState*, InjectedScriptManager*);
     55     virtual ~InspectorHeapProfilerAgent();
     56 
     57     virtual void collectGarbage(ErrorString*);
     58     virtual void clearProfiles(ErrorString*);
     59 
     60     virtual void enable(ErrorString*);
     61     virtual void disable(ErrorString*);
     62     virtual void getHeapSnapshot(ErrorString*, int uid);
     63     virtual void removeProfile(ErrorString*, int uid);
     64     virtual void startTrackingHeapObjects(ErrorString*);
     65     virtual void stopTrackingHeapObjects(ErrorString*, const bool* reportProgress);
     66 
     67     virtual void setFrontend(InspectorFrontend*);
     68     virtual void clearFrontend();
     69     virtual void restore();
     70 
     71     virtual void takeHeapSnapshot(ErrorString*, const bool* reportProgress);
     72 
     73     virtual void getObjectByHeapObjectId(ErrorString*, const String& heapSnapshotObjectId, const String* objectGroup, RefPtr<TypeBuilder::Runtime::RemoteObject>& result);
     74     virtual void getHeapObjectId(ErrorString*, const String& objectId, String* heapSnapshotObjectId);
     75 
     76 private:
     77     class HeapStatsStream;
     78     class HeapStatsUpdateTask;
     79 
     80     InspectorHeapProfilerAgent(InstrumentingAgents*, InspectorCompositeState*, InjectedScriptManager*);
     81 
     82     typedef HashMap<unsigned, RefPtr<ScriptHeapSnapshot> > IdToHeapSnapshotMap;
     83 
     84     void resetFrontendProfiles();
     85     void requestHeapStatsUpdate();
     86     void pushHeapStatsUpdate(const uint32_t* const data, const int size);
     87 
     88     PassRefPtr<TypeBuilder::HeapProfiler::ProfileHeader> createSnapshotHeader(const ScriptHeapSnapshot&);
     89     void stopTrackingHeapObjectsInternal();
     90 
     91     InjectedScriptManager* m_injectedScriptManager;
     92     InspectorFrontend::HeapProfiler* m_frontend;
     93     unsigned m_nextUserInitiatedHeapSnapshotNumber;
     94     IdToHeapSnapshotMap m_snapshots;
     95     OwnPtr<HeapStatsUpdateTask> m_heapStatsUpdateTask;
     96 };
     97 
     98 } // namespace WebCore
     99 
    100 
    101 #endif // !defined(InspectorHeapProfilerAgent_h)
    102