From f0b68892d4e85c078836eb0809c64dde82918aeb Mon Sep 17 00:00:00 2001 From: Trevor Norris Date: Mon, 25 Mar 2013 22:32:41 -0700 Subject: [PATCH] domain: fix domain callback from MakeCallback Since _tickCallback and _tickDomainCallback were both called from MakeCallback, it was possible for a callback to be called that required a domain directly to _tickCallback. The fix was to implement process.usingDomains(). This will set all applicable functions to their domain counterparts, and set a flag in cc to let MakeCallback know domain callbacks always need to be checked. Added test in own file. It's important that the test remains isolated. --- lib/domain.js | 5 +- src/node.cc | 86 ++++++++++++++++----------- src/node.js | 8 +-- test/simple/test-domain-from-timer.js | 39 ++++++++++++ 4 files changed, 97 insertions(+), 41 deletions(-) create mode 100644 test/simple/test-domain-from-timer.js diff --git a/lib/domain.js b/lib/domain.js index 5d38177dbe..80a64c64bf 100644 --- a/lib/domain.js +++ b/lib/domain.js @@ -32,9 +32,8 @@ var endMethods = ['end', 'abort', 'destroy', 'destroySoon']; // a few side effects. events.usingDomains = true; -// replace tickers with domain specific implementation -process.nextTick = process._nextDomainTick; -process._tickCallback = process._tickDomainCallback; +// let the process know we're using domains +process._usingDomains(); exports.Domain = Domain; diff --git a/src/node.cc b/src/node.cc index 7aba02bd35..f1a84a9d71 100644 --- a/src/node.cc +++ b/src/node.cc @@ -102,7 +102,6 @@ Persistent domain_symbol; // declared in node_internals.h Persistent process; -static Persistent process_tickDomainCallback; static Persistent process_tickFromSpinner; static Persistent process_tickCallback; @@ -134,6 +133,7 @@ static bool use_debug_agent = false; static bool debug_wait_connect = false; static int debug_port=5858; static int max_stack_size = 0; +static bool using_domains = false; // used by C++ modules as well bool no_deprecation = false; @@ -899,6 +899,30 @@ Handle FromConstructorTemplate(Persistent t, } +Handle UsingDomains(const Arguments& args) { + HandleScope scope; + if (using_domains) + return scope.Close(Undefined()); + using_domains = true; + Local tdc_v = process->Get(String::New("_tickDomainCallback")); + Local ndt_v = process->Get(String::New("_nextDomainTick")); + if (!tdc_v->IsFunction()) { + fprintf(stderr, "process._tickDomainCallback assigned to non-function\n"); + abort(); + } + if (!ndt_v->IsFunction()) { + fprintf(stderr, "process._nextDomainTick assigned to non-function\n"); + abort(); + } + Local tdc = tdc_v.As(); + Local ndt = ndt_v.As(); + process->Set(String::New("_tickCallback"), tdc); + process->Set(String::New("nextTick"), ndt); + process_tickCallback = Persistent::New(tdc); + return Undefined(); +} + + Handle MakeDomainCallback(const Handle object, const Handle callback, @@ -906,17 +930,6 @@ MakeDomainCallback(const Handle object, Handle argv[]) { // TODO Hook for long stack traces to be made here. - // lazy load _tickDomainCallback - if (process_tickDomainCallback.IsEmpty()) { - Local cb_v = process->Get(String::New("_tickDomainCallback")); - if (!cb_v->IsFunction()) { - fprintf(stderr, "process._tickDomainCallback assigned to non-function\n"); - abort(); - } - Local cb = cb_v.As(); - process_tickDomainCallback = Persistent::New(cb); - } - // lazy load domain specific symbols if (enter_symbol.IsEmpty()) { enter_symbol = NODE_PSYMBOL("enter"); @@ -931,19 +944,22 @@ MakeDomainCallback(const Handle object, TryCatch try_catch; - domain = domain_v->ToObject(); - assert(!domain.IsEmpty()); - if (domain->Get(disposed_symbol)->IsTrue()) { - // domain has been disposed of. - return Undefined(); - } - enter = Local::Cast(domain->Get(enter_symbol)); - assert(!enter.IsEmpty()); - enter->Call(domain, 0, NULL); + bool has_domain = domain_v->IsObject(); + if (has_domain) { + domain = domain_v->ToObject(); + assert(!domain.IsEmpty()); + if (domain->Get(disposed_symbol)->IsTrue()) { + // domain has been disposed of. + return Undefined(); + } + enter = Local::Cast(domain->Get(enter_symbol)); + assert(!enter.IsEmpty()); + enter->Call(domain, 0, NULL); - if (try_catch.HasCaught()) { - FatalException(try_catch); - return Undefined(); + if (try_catch.HasCaught()) { + FatalException(try_catch); + return Undefined(); + } } Local ret = callback->Call(object, argc, argv); @@ -953,13 +969,15 @@ MakeDomainCallback(const Handle object, return Undefined(); } - exit = Local::Cast(domain->Get(exit_symbol)); - assert(!exit.IsEmpty()); - exit->Call(domain, 0, NULL); + if (has_domain) { + exit = Local::Cast(domain->Get(exit_symbol)); + assert(!exit.IsEmpty()); + exit->Call(domain, 0, NULL); - if (try_catch.HasCaught()) { - FatalException(try_catch); - return Undefined(); + if (try_catch.HasCaught()) { + FatalException(try_catch); + return Undefined(); + } } if (tick_infobox.length == 0) { @@ -969,7 +987,7 @@ MakeDomainCallback(const Handle object, } // process nextTicks after call - process_tickDomainCallback->Call(process, 0, NULL); + process_tickCallback->Call(process, 0, NULL); if (try_catch.HasCaught()) { FatalException(try_catch); @@ -1033,10 +1051,8 @@ MakeCallback(const Handle object, HandleScope scope; Local callback = object->Get(symbol).As(); - Local domain = object->Get(domain_symbol); - // has domain, off with you - if (!domain->IsNull() && !domain->IsUndefined()) + if (using_domains) return scope.Close(MakeDomainCallback(object, callback, argc, argv)); return scope.Close(MakeCallback(object, callback, argc, argv)); } @@ -2488,6 +2504,8 @@ Handle SetupProcessObject(int argc, char *argv[]) { NODE_SET_METHOD(process, "binding", Binding); + NODE_SET_METHOD(process, "_usingDomains", UsingDomains); + // values use to cross communicate with processNextTick Local info_box = Object::New(); info_box->SetIndexedPropertiesToExternalArrayData(&tick_infobox, diff --git a/src/node.js b/src/node.js index 5e40fab272..e5833cb5cc 100644 --- a/src/node.js +++ b/src/node.js @@ -331,12 +331,12 @@ var index = 1; var depth = 2; - process._tickCallback = _tickCallback; - process._tickFromSpinner = _tickFromSpinner; - // needs to be accessible from cc land - process._tickDomainCallback = _tickDomainCallback; process.nextTick = nextTick; + // needs to be accessible from cc land process._nextDomainTick = _nextDomainTick; + process._tickCallback = _tickCallback; + process._tickDomainCallback = _tickDomainCallback; + process._tickFromSpinner = _tickFromSpinner; // the maximum number of times it'll process something like // nextTick(function f(){nextTick(f)}) diff --git a/test/simple/test-domain-from-timer.js b/test/simple/test-domain-from-timer.js new file mode 100644 index 0000000000..3e73a5c4b8 --- /dev/null +++ b/test/simple/test-domain-from-timer.js @@ -0,0 +1,39 @@ +// Copyright Joyent, Inc. and other Node contributors. +// +// Permission is hereby granted, free of charge, to any person obtaining a +// copy of this software and associated documentation files (the +// "Software"), to deal in the Software without restriction, including +// without limitation the rights to use, copy, modify, merge, publish, +// distribute, sublicense, and/or sell copies of the Software, and to permit +// persons to whom the Software is furnished to do so, subject to the +// following conditions: +// +// The above copyright notice and this permission notice shall be included +// in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN +// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, +// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR +// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE +// USE OR OTHER DEALINGS IN THE SOFTWARE. + + +// Simple tests of most basic domain functionality. + +var common = require('../common'); +var assert = require('assert'); + +// timeouts call the callback directly from cc, so need to make sure the +// domain will be used regardless +setTimeout(function() { + var domain = require('domain'); + var d = domain.create(); + d.run(function() { + process.nextTick(function() { + console.trace('in nexttick', process.domain === d) + assert.equal(process.domain, d); + }); + }); +});