15c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)/* 25c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Copyright (C) 2011 Google Inc. All rights reserved. 35c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 45c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Redistribution and use in source and binary forms, with or without 55c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * modification, are permitted provided that the following conditions are 65c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * met: 75c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 85c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * * Redistributions of source code must retain the above copyright 95c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * notice, this list of conditions and the following disclaimer. 105c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * * Redistributions in binary form must reproduce the above 115c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * copyright notice, this list of conditions and the following disclaimer 125c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * in the documentation and/or other materials provided with the 135c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * distribution. 145c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * * Neither the name of Google Inc. nor the names of its 155c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * contributors may be used to endorse or promote products derived from 165c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * this software without specific prior written permission. 175c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 185c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 195c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 205c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 215c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 225c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 235c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 245c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 255c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 265c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 275c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 285c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 295c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 305c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 315c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#ifndef V8RecursionScope_h 325c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#define V8RecursionScope_h 335c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 34197021e6b966cfb06891637935ef33fff06433d1Ben Murdoch#include "bindings/core/v8/V8PerIsolateData.h" 351e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles)#include "core/dom/ExecutionContext.h" 36197021e6b966cfb06891637935ef33fff06433d1Ben Murdoch#include "platform/ScriptForbiddenScope.h" 3753e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles)#include "wtf/Noncopyable.h" 38f6b7aed3f7ce69aca0d7a032d144cbd088b04393Torne (Richard Coles)#include <v8.h> 395c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 40c1847b1379d12d0e05df27436bf19a9b1bf12deaTorne (Richard Coles)namespace blink { 415c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 425c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// C++ calls into script contexts which are "owned" by WebKit (created in a 435c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// process where WebKit.cpp initializes v8) must declare their type: 445c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// 455c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// 1. Calls into page/author script from a frame 465c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// 2. Calls into page/author script from a worker 475c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// 3. Calls into internal script (typically setup/teardown work) 485c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// 495c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// Debug-time checking of this is enforced via this class. 505c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// 515c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// Calls of type (1) should generally go through ScriptController, as inspector 5293ac45cfc74041c8ae536ce58a9534d46db2024eTorne (Richard Coles)// instrumentation is needed. ScriptController allocates V8RecursionScope for you. 5393ac45cfc74041c8ae536ce58a9534d46db2024eTorne (Richard Coles)// Calls of type (2) should always stack-allocate a V8RecursionScope in the same 5493ac45cfc74041c8ae536ce58a9534d46db2024eTorne (Richard Coles)// block as the call into script. Calls of type (3) should stack allocate a 5593ac45cfc74041c8ae536ce58a9534d46db2024eTorne (Richard Coles)// V8RecursionScope::MicrotaskSuppression -- this skips work that is spec'd to 5693ac45cfc74041c8ae536ce58a9534d46db2024eTorne (Richard Coles)// happen at the end of the outer-most script stack frame of calls into page script: 575c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// 585c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// http://www.whatwg.org/specs/web-apps/current-work/#perform-a-microtask-checkpoint 595c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)class V8RecursionScope { 605c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) WTF_MAKE_NONCOPYABLE(V8RecursionScope); 615c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)public: 627242dc3dbeb210b5e876a3c42d1ec1a667fc621aPrimiano Tucci explicit V8RecursionScope(v8::Isolate* isolate) 63a9984bf9ddc3cf73fdae3f29134a2bab379e7029Ben Murdoch : m_isolate(isolate) 645c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 65a9984bf9ddc3cf73fdae3f29134a2bab379e7029Ben Murdoch V8PerIsolateData::from(m_isolate)->incrementRecursionLevel(); 66197021e6b966cfb06891637935ef33fff06433d1Ben Murdoch RELEASE_ASSERT(!ScriptForbiddenScope::isScriptForbidden()); 67d6cdb82654e8f3343a693ca752d5c4cee0324e17Torne (Richard Coles) // If you want V8 to autorun microtasks, this class needs to have a 68d6cdb82654e8f3343a693ca752d5c4cee0324e17Torne (Richard Coles) // v8::Isolate::SuppressMicrotaskExecutionScope member. 69d6cdb82654e8f3343a693ca752d5c4cee0324e17Torne (Richard Coles) ASSERT(!isolate->WillAutorunMicrotasks()); 705c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 715c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 725c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ~V8RecursionScope() 735c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 74a9984bf9ddc3cf73fdae3f29134a2bab379e7029Ben Murdoch if (!V8PerIsolateData::from(m_isolate)->decrementRecursionLevel()) 755c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) didLeaveScriptContext(); 765c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 775c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 78a9984bf9ddc3cf73fdae3f29134a2bab379e7029Ben Murdoch static int recursionLevel(v8::Isolate* isolate) 795c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 80a9984bf9ddc3cf73fdae3f29134a2bab379e7029Ben Murdoch return V8PerIsolateData::from(isolate)->recursionLevel(); 815c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 825c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 83197021e6b966cfb06891637935ef33fff06433d1Ben Murdoch#if ENABLE(ASSERT) 84a9984bf9ddc3cf73fdae3f29134a2bab379e7029Ben Murdoch static bool properlyUsed(v8::Isolate* isolate) 855c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 86a9984bf9ddc3cf73fdae3f29134a2bab379e7029Ben Murdoch return recursionLevel(isolate) > 0 || V8PerIsolateData::from(isolate)->internalScriptRecursionLevel() > 0; 875c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 885c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#endif 895c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 905c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) class MicrotaskSuppression { 915c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) public: 92a9984bf9ddc3cf73fdae3f29134a2bab379e7029Ben Murdoch MicrotaskSuppression(v8::Isolate* isolate) 93197021e6b966cfb06891637935ef33fff06433d1Ben Murdoch#if ENABLE(ASSERT) 94a9984bf9ddc3cf73fdae3f29134a2bab379e7029Ben Murdoch : m_isolate(isolate) 95a9984bf9ddc3cf73fdae3f29134a2bab379e7029Ben Murdoch#endif 965c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 97f91f5fa1608c2cdd9af1842fb5dadbe78275be2aBo Liu ASSERT(!ScriptForbiddenScope::isScriptForbidden()); 98197021e6b966cfb06891637935ef33fff06433d1Ben Murdoch#if ENABLE(ASSERT) 99a9984bf9ddc3cf73fdae3f29134a2bab379e7029Ben Murdoch V8PerIsolateData::from(m_isolate)->incrementInternalScriptRecursionLevel(); 1005c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#endif 1015c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 1025c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1035c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ~MicrotaskSuppression() 1045c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 105197021e6b966cfb06891637935ef33fff06433d1Ben Murdoch#if ENABLE(ASSERT) 106a9984bf9ddc3cf73fdae3f29134a2bab379e7029Ben Murdoch V8PerIsolateData::from(m_isolate)->decrementInternalScriptRecursionLevel(); 1075c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#endif 1085c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 109a9984bf9ddc3cf73fdae3f29134a2bab379e7029Ben Murdoch 110a9984bf9ddc3cf73fdae3f29134a2bab379e7029Ben Murdoch private: 111197021e6b966cfb06891637935ef33fff06433d1Ben Murdoch#if ENABLE(ASSERT) 112a9984bf9ddc3cf73fdae3f29134a2bab379e7029Ben Murdoch v8::Isolate* m_isolate; 113a9984bf9ddc3cf73fdae3f29134a2bab379e7029Ben Murdoch#endif 1145c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) }; 1155c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1165c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)private: 1175c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) void didLeaveScriptContext(); 1185c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 119a9984bf9ddc3cf73fdae3f29134a2bab379e7029Ben Murdoch v8::Isolate* m_isolate; 1205c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)}; 1215c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 122c1847b1379d12d0e05df27436bf19a9b1bf12deaTorne (Richard Coles)} // namespace blink 1235c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1245c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#endif // V8RecursionScope_h 125