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 AsyncCallStackTracker_h
     32 #define AsyncCallStackTracker_h
     33 
     34 #include "bindings/v8/ScriptValue.h"
     35 #include "wtf/Deque.h"
     36 #include "wtf/HashMap.h"
     37 #include "wtf/HashSet.h"
     38 #include "wtf/Noncopyable.h"
     39 #include "wtf/PassRefPtr.h"
     40 #include "wtf/RefPtr.h"
     41 
     42 namespace WebCore {
     43 
     44 class Event;
     45 class EventListener;
     46 class EventTarget;
     47 class ExecutionContext;
     48 class MutationObserver;
     49 class XMLHttpRequest;
     50 
     51 class AsyncCallStackTracker {
     52     WTF_MAKE_NONCOPYABLE(AsyncCallStackTracker);
     53 public:
     54     class AsyncCallStack : public RefCounted<AsyncCallStack> {
     55     public:
     56         AsyncCallStack(const String&, const ScriptValue&);
     57         ~AsyncCallStack();
     58         String description() const { return m_description; }
     59         ScriptValue callFrames() const { return m_callFrames; }
     60     private:
     61         String m_description;
     62         ScriptValue m_callFrames;
     63     };
     64 
     65     typedef Deque<RefPtr<AsyncCallStack>, 4> AsyncCallStackVector;
     66 
     67     class AsyncCallChain : public RefCounted<AsyncCallChain> {
     68     public:
     69         AsyncCallChain() { }
     70         AsyncCallChain(const AsyncCallChain& t) : m_callStacks(t.m_callStacks) { }
     71         AsyncCallStackVector callStacks() const { return m_callStacks; }
     72     private:
     73         friend class AsyncCallStackTracker;
     74         AsyncCallStackVector m_callStacks;
     75     };
     76 
     77     AsyncCallStackTracker();
     78 
     79     bool isEnabled() const { return m_maxAsyncCallStackDepth; }
     80     void setAsyncCallStackDepth(int);
     81     const AsyncCallChain* currentAsyncCallChain() const;
     82 
     83     void didInstallTimer(ExecutionContext*, int timerId, bool singleShot, const ScriptValue& callFrames);
     84     void didRemoveTimer(ExecutionContext*, int timerId);
     85     void willFireTimer(ExecutionContext*, int timerId);
     86 
     87     void didRequestAnimationFrame(ExecutionContext*, int callbackId, const ScriptValue& callFrames);
     88     void didCancelAnimationFrame(ExecutionContext*, int callbackId);
     89     void willFireAnimationFrame(ExecutionContext*, int callbackId);
     90 
     91     void didEnqueueEvent(EventTarget*, Event*, const ScriptValue& callFrames);
     92     void didRemoveEvent(EventTarget*, Event*);
     93     void willHandleEvent(EventTarget*, Event*, EventListener*, bool useCapture);
     94     void willLoadXHR(XMLHttpRequest*, const ScriptValue& callFrames);
     95 
     96     void didEnqueueMutationRecord(ExecutionContext*, MutationObserver*, const ScriptValue& callFrames);
     97     bool hasEnqueuedMutationRecord(ExecutionContext*, MutationObserver*);
     98     void didClearAllMutationRecords(ExecutionContext*, MutationObserver*);
     99     void willDeliverMutationRecords(ExecutionContext*, MutationObserver*);
    100 
    101     void didFireAsyncCall();
    102     void clear();
    103 
    104 private:
    105     void willHandleXHREvent(XMLHttpRequest*, EventTarget*, Event*);
    106 
    107     PassRefPtr<AsyncCallChain> createAsyncCallChain(const String& description, const ScriptValue& callFrames);
    108     void setCurrentAsyncCallChain(PassRefPtr<AsyncCallChain>);
    109     void clearCurrentAsyncCallChain();
    110     static void ensureMaxAsyncCallChainDepth(AsyncCallChain*, unsigned);
    111     static bool validateCallFrames(const ScriptValue& callFrames);
    112 
    113     class ExecutionContextData;
    114     ExecutionContextData* createContextDataIfNeeded(ExecutionContext*);
    115 
    116     unsigned m_maxAsyncCallStackDepth;
    117     RefPtr<AsyncCallChain> m_currentAsyncCallChain;
    118     unsigned m_nestedAsyncCallCount;
    119     typedef HashMap<ExecutionContext*, ExecutionContextData*> ExecutionContextDataMap;
    120     ExecutionContextDataMap m_executionContextDataMap;
    121 };
    122 
    123 } // namespace WebCore
    124 
    125 #endif // !defined(AsyncCallStackTracker_h)
    126