src/third_party/WebKit/Source/bindings/v8/V8RecursionScope.h

   1 /*
   2  * Copyright (C) 2011 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 V8RecursionScope_h
  32 #define V8RecursionScope_h
  33
  34 #include "bindings/v8/V8PerIsolateData.h"
  35 #include "wtf/Noncopyable.h"
  36
  37 namespace WebCore {
  38
  39 class ExecutionContext;
  40
  41 // C++ calls into script contexts which are "owned" by WebKit (created in a
  42 // process where WebKit.cpp initializes v8) must declare their type:
  43 //
  44 //   1. Calls into page/author script from a frame
  45 //   2. Calls into page/author script from a worker
  46 //   3. Calls into internal script (typically setup/teardown work)
  47 //
  48 // Debug-time checking of this is enforced via this class.
  49 //
  50 // Calls of type (1) should generally go through ScriptController, as inspector
  51 // instrumentation is needed. ScriptController allocates V8RecursionScope for you.
  52 // Calls of type (2) should always stack-allocate a V8RecursionScope in the same
  53 // block as the call into script. Calls of type (3) should stack allocate a
  54 // V8RecursionScope::MicrotaskSuppression -- this skips work that is spec'd to
  55 // happen at the end of the outer-most script stack frame of calls into page script:
  56 //
  57 // http://www.whatwg.org/specs/web-apps/current-work/#perform-a-microtask-checkpoint
  58 class V8RecursionScope {
  59     WTF_MAKE_NONCOPYABLE(V8RecursionScope);
  60 public:
  61     explicit V8RecursionScope(ExecutionContext* context)
  62         : m_context(context)
  63     {
  64         V8PerIsolateData::current()->incrementRecursionLevel();
  65     }
  66
  67     ~V8RecursionScope()
  68     {
  69         if (!V8PerIsolateData::current()->decrementRecursionLevel())
  70             didLeaveScriptContext();
  71     }
  72
  73     static int recursionLevel()
  74     {
  75         return V8PerIsolateData::current()->recursionLevel();
  76     }
  77
  78 #ifndef NDEBUG
  79     static bool properlyUsed()
  80     {
  81         return recursionLevel() > 0 || V8PerIsolateData::current()->internalScriptRecursionLevel() > 0;
  82     }
  83 #endif
  84
  85     class MicrotaskSuppression {
  86     public:
  87         MicrotaskSuppression()
  88         {
  89 #ifndef NDEBUG
  90             V8PerIsolateData::current()->incrementInternalScriptRecursionLevel();
  91 #endif
  92         }
  93
  94         ~MicrotaskSuppression()
  95         {
  96 #ifndef NDEBUG
  97             V8PerIsolateData::current()->decrementInternalScriptRecursionLevel();
  98 #endif
  99         }
 100     };
 101
 102 private:
 103     void didLeaveScriptContext();
 104     bool isStopped();
 105
 106     ExecutionContext* m_context;
 107 };
 108
 109 } // namespace WebCore
 110
 111 #endif // V8RecursionScope_h