DevTools: Support async call stacks for FileSystem API (part 1).

Source/core/inspector/AsyncCallStackTracker.cpp

 /*
  * Copyright (C) 2013 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
  * met:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
  *     * Redistributions in binary form must reproduce the above
@@ skipping 22 matching lines @@
 
 #include "bindings/core/v8/V8Binding.h"
 #include "bindings/core/v8/V8RecursionScope.h"
 #include "core/dom/ContextLifecycleObserver.h"
 #include "core/dom/ExecutionContext.h"
 #include "core/dom/ExecutionContextTask.h"
 #include "core/events/Event.h"
 #include "core/events/EventTarget.h"
 #include "core/xml/XMLHttpRequest.h"
 #include "core/xml/XMLHttpRequestUpload.h"
+#include "platform/AsyncFileSystemCallbacks.h"
 #include "wtf/text/StringBuilder.h"
 #include "wtf/text/StringHash.h"
 #include <v8.h>
 
 namespace {
 
 static const char setTimeoutName[] = "setTimeout";
 static const char setIntervalName[] = "setInterval";
 static const char requestAnimationFrameName[] = "requestAnimationFrame";
 static const char xhrSendName[] = "XMLHttpRequest.send";
 static const char enqueueMutationRecordName[] = "Mutation";
+static const char fileSystemName[] = "FileSystem";
 
 }
 
 namespace WebCore {
 
 class AsyncCallStackTracker::ExecutionContextData FINAL : public ContextLifecycleObserver {
     WTF_MAKE_FAST_ALLOCATED;
 public:
     ExecutionContextData(AsyncCallStackTracker* tracker, ExecutionContext* executionContext)
         : ContextLifecycleObserver(executionContext)
@@ skipping 12 matching lines @@
 
 public:
     AsyncCallStackTracker* m_tracker;
     HashSet<int> m_intervalTimerIds;
     HashMap<int, RefPtr<AsyncCallChain> > m_timerCallChains;
     HashMap<int, RefPtr<AsyncCallChain> > m_animationFrameCallChains;
     HashMap<Event*, RefPtr<AsyncCallChain> > m_eventCallChains;
     HashMap<EventTarget*, RefPtr<AsyncCallChain> > m_xhrCallChains;
     HashMap<MutationObserver*, RefPtr<AsyncCallChain> > m_mutationObserverCallChains;
     HashMap<ExecutionContextTask*, RefPtr<AsyncCallChain> > m_executionContextTaskCallChains;
+    HashMap<AsyncFileSystemCallbacks*, RefPtr<AsyncCallChain> > m_fileSystemCallChains;
     HashMap<String, RefPtr<AsyncCallChain> > m_v8AsyncTaskCallChains;
 };
 
 static XMLHttpRequest* toXmlHttpRequest(EventTarget* eventTarget)
 {
     const AtomicString& interfaceName = eventTarget->interfaceName();
     if (interfaceName == EventTargetNames::XMLHttpRequest)
         return static_cast<XMLHttpRequest*>(eventTarget);
     if (interfaceName == EventTargetNames::XMLHttpRequestUpload)
         return static_cast<XMLHttpRequestUpload*>(eventTarget)->xmlHttpRequest();
@@ skipping 224 matching lines @@
 void AsyncCallStackTracker::willPerformExecutionContextTask(ExecutionContext* context, ExecutionContextTask* task)
 {
     ASSERT(context);
     ASSERT(isEnabled());
     if (ExecutionContextData* data = m_executionContextDataMap.get(context))
         setCurrentAsyncCallChain(context, data->m_executionContextTaskCallChains.take(task));
     else
         setCurrentAsyncCallChain(context, nullptr);
 }
 
+void AsyncCallStackTracker::didEnqueueAsyncFileSystemCallback(ExecutionContext* context, AsyncFileSystemCallbacks* callback, const ScriptValue& callFrames)
+{
+    ASSERT(context);
+    ASSERT(isEnabled());
+    if (!validateCallFrames(callFrames))
+        return;
+    ExecutionContextData* data = createContextDataIfNeeded(context);
+    data->m_fileSystemCallChains.set(callback, createAsyncCallChain(fileSystemName, callFrames));
+}
+
+void AsyncCallStackTracker::didRemoveAsyncFileSystemCallback(ExecutionContext* context, AsyncFileSystemCallbacks* callback)
+{
+    ASSERT(context);
+    ASSERT(isEnabled());
+    if (ExecutionContextData* data = m_executionContextDataMap.get(context))
+        data->m_fileSystemCallChains.remove(callback);
+}
+
+void AsyncCallStackTracker::willHandleAsyncFileSystemCallback(ExecutionContext* context, AsyncFileSystemCallbacks* callback, bool hasMore)
+{
+    ASSERT(context);
+    ASSERT(isEnabled());
+    if (ExecutionContextData* data = m_executionContextDataMap.get(context)) {
+        if (hasMore)
+            setCurrentAsyncCallChain(context, data->m_fileSystemCallChains.get(callback));

[yurys, 2014/07/14 14:55:54]

style: consider extracting setCurrentAsyncCallChain out of the if block.

+        else
+            setCurrentAsyncCallChain(context, data->m_fileSystemCallChains.take(callback));
+    } else {
+        setCurrentAsyncCallChain(context, nullptr);
+    }
+}
+
 static String makeV8AsyncTaskUniqueId(const String& eventName, int id)
 {
     StringBuilder builder;
     builder.append(eventName);
     builder.appendNumber(id);
     return builder.toString();
 }
 
 void AsyncCallStackTracker::didEnqueueV8AsyncTask(ExecutionContext* context, const String& eventName, int id, const ScriptValue& callFrames)
 {
@@ skipping 13 matching lines @@
         setCurrentAsyncCallChain(context, data->m_v8AsyncTaskCallChains.take(makeV8AsyncTaskUniqueId(eventName, id)));
     else
         setCurrentAsyncCallChain(context, nullptr);
 }
 
 void AsyncCallStackTracker::didFireAsyncCall()
 {
     clearCurrentAsyncCallChain();
 }
 
+void AsyncCallStackTracker::willRescheduleAsyncCallChain()
+{
+    ASSERT(isEnabled());
+    if (!m_rescheduledAsyncCallChain)
+        m_rescheduleNextAsyncCallChain = true;
+}
+
+void AsyncCallStackTracker::didRescheduleAsyncCallChain()
+{
+    ASSERT(isEnabled());
+    m_rescheduleNextAsyncCallChain = false;
+    m_rescheduledAsyncCallChain.clear();
+}
+
 PassRefPtr<AsyncCallStackTracker::AsyncCallChain> AsyncCallStackTracker::createAsyncCallChain(const String& description, const ScriptValue& callFrames)
 {
+    // Check if we should propogate the async call stack chain.
+    if (m_rescheduledAsyncCallChain)
+        return m_rescheduledAsyncCallChain;
     if (callFrames.isEmpty()) {
         ASSERT(m_currentAsyncCallChain);
-        return m_currentAsyncCallChain; // Propogate async call stack chain.
+        return m_currentAsyncCallChain;
     }
     RefPtr<AsyncCallChain> chain = adoptRef(m_currentAsyncCallChain ? new AsyncCallStackTracker::AsyncCallChain(*m_currentAsyncCallChain) : new AsyncCallStackTracker::AsyncCallChain());
     ensureMaxAsyncCallChainDepth(chain.get(), m_maxAsyncCallStackDepth - 1);
     chain->m_callStacks.prepend(adoptRef(new AsyncCallStackTracker::AsyncCallStack(description, callFrames)));
     return chain.release();
 }
 
 void AsyncCallStackTracker::setCurrentAsyncCallChain(ExecutionContext* context, PassRefPtr<AsyncCallChain> chain)
 {
+    if (m_rescheduleNextAsyncCallChain) {
+        m_rescheduleNextAsyncCallChain = false;
+        m_rescheduledAsyncCallChain = chain.get();
+    }
     if (V8RecursionScope::recursionLevel(toIsolate(context))) {
         if (m_currentAsyncCallChain)
             ++m_nestedAsyncCallCount;
     } else {
         // Current AsyncCallChain corresponds to the bottommost JS call frame.
         m_currentAsyncCallChain = chain;
         m_nestedAsyncCallCount = m_currentAsyncCallChain ? 1 : 0;
     }
 }
 
 void AsyncCallStackTracker::clearCurrentAsyncCallChain()
 {
     if (!m_nestedAsyncCallCount)
         return;
     --m_nestedAsyncCallCount;
     if (!m_nestedAsyncCallCount)
         m_currentAsyncCallChain.clear();
 }
 
 void AsyncCallStackTracker::ensureMaxAsyncCallChainDepth(AsyncCallChain* chain, unsigned maxDepth)
 {
     while (chain->m_callStacks.size() > maxDepth)
         chain->m_callStacks.removeLast();
 }
 
 bool AsyncCallStackTracker::validateCallFrames(const ScriptValue& callFrames)
 {
-    return !callFrames.isEmpty() || m_currentAsyncCallChain;
+    return !callFrames.isEmpty() || m_currentAsyncCallChain || m_rescheduledAsyncCallChain;
 }
 
 AsyncCallStackTracker::ExecutionContextData* AsyncCallStackTracker::createContextDataIfNeeded(ExecutionContext* context)
 {
     ExecutionContextData* data = m_executionContextDataMap.get(context);
     if (!data) {
         data = new AsyncCallStackTracker::ExecutionContextData(this, context);
         m_executionContextDataMap.set(context, data);
     }
     return data;
 }
 
 void AsyncCallStackTracker::clear()
 {
     m_currentAsyncCallChain.clear();
     m_nestedAsyncCallCount = 0;
+    m_rescheduleNextAsyncCallChain = false;
+    m_rescheduledAsyncCallChain.clear();
     ExecutionContextDataMap copy;
     m_executionContextDataMap.swap(copy);
     for (ExecutionContextDataMap::const_iterator it = copy.begin(); it != copy.end(); ++it)
         delete it->value;
 }
 
 } // namespace WebCore