workers: initial implementation

LICENSE

@@ -1056,3 +1056,35 @@ The externally maintained libraries used by Node.js are:
  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  """
+
+- ProducerConsumerQueue, located at src/producer-consumer-queue.h. The folly::ProducerConsumerQueue class is a
+ one-producer one-consumer queue with very low synchronization overhead.
+ ProducerConsumerQueue's license follows:
+ """
+ Copyright 2015 Facebook, Inc.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ """
+
+ Significant changes made to the software:
+
+ - Removed Boost dependency
+ - Removed support for storing values directly
+ - Removed construction and destruction of the queue items feature
+ - Added initialization of all values to nullptr
+ - Made size a template parameter
+ - Crash instead of throw if malloc fails in constructor
+ - Changed namespace from folly to node
+ - Removed sizeGuess(), isFull(), isEmpty(), popFront() and frontPtr() methods
+ - Renamed write() to PushBack(), read() to PopFront()
+ - Added padding to fields

Makefile

@@ -231,6 +231,12 @@ test-v8-benchmarks:
 test-v8-all: test-v8 test-v8-intl test-v8-benchmarks
 	# runs all v8 tests
 
+test-workers: all
+	$(PYTHON) tools/test.py --mode=release workers -J
+
+test-workers-debug: all
+	$(PYTHON) tools/test.py --mode=debug workers -J
+
 apidoc_sources = $(wildcard doc/api/*.markdown)
 apidocs = $(addprefix out/,$(apidoc_sources:.markdown=.html)) \
  $(addprefix out/,$(apidoc_sources:.markdown=.json))

common.gypi

@@ -279,7 +279,7 @@
  'libraries': [ '-llog' ],
  }],
  ['OS=="mac"', {
- 'defines': ['_DARWIN_USE_64_BIT_INODE=1'],
+ 'defines': ['_DARWIN_USE_64_BIT_INODE=1', 'NODE_OS_MACOSX'],
  'xcode_settings': {
  'ALWAYS_SEARCH_USER_PATHS': 'NO',
  'GCC_CW_ASM_SYNTAX': 'NO', # No -fasm-blocks
@@ -290,7 +290,7 @@
  'GCC_ENABLE_PASCAL_STRINGS': 'NO', # No -mpascal-strings
  'GCC_THREADSAFE_STATICS': 'NO', # -fno-threadsafe-statics
  'PREBINDING': 'NO', # No -Wl,-prebind
- 'MACOSX_DEPLOYMENT_TARGET': '10.5', # -mmacosx-version-min=10.5
+ 'MACOSX_DEPLOYMENT_TARGET': '10.7', # -mmacosx-version-min=10.7
  'USE_HEADERMAP': 'NO',
  'OTHER_CFLAGS': [
  '-fno-strict-aliasing',
@@ -317,7 +317,8 @@
  ['clang==1', {
  'xcode_settings': {
  'GCC_VERSION': 'com.apple.compilers.llvm.clang.1_0',
- 'CLANG_CXX_LANGUAGE_STANDARD': 'gnu++0x', # -std=gnu++0x
+ 'CLANG_CXX_LANGUAGE_STANDARD': 'c++11', # -std=c++11
+ 'CLANG_CXX_LIBRARY': 'libc++', #-stdlib=libc++
  },
  }],
  ],

lib/worker.js

@@ -0,0 +1,216 @@
+'use strict';
+
+if (!process.features.experimental_workers) {
+ throw new Error('Experimental workers are not enabled');
+}
+
+const util = require('util');
+const assert = require('assert');
+const EventEmitter = require('events');
+const WorkerContextBinding = process.binding('worker_context');
+const JSONStringify = function(value) {
+ if (value === undefined) value = null;
+ return JSON.stringify(value);
+};
+const JSONParse = JSON.parse;
+const EMPTY_ARRAY = [];
+
+const workerContextSymbol = Symbol('workerContext');
+const installEventsSymbol = Symbol('installEvents');
+const checkAliveSymbol = Symbol('checkAlive');
+const initSymbol = WorkerContextBinding.initSymbol;
+
+const builtinErrorTypes = new Map([
+ Error, SyntaxError, RangeError, URIError, TypeError, EvalError, ReferenceError
+].map(function(Type) {
+ return [Type.name, Type];
+}));
+
+const Worker = WorkerContextBinding.JsConstructor;
+util.inherits(Worker, EventEmitter);
+
+Worker.prototype[initSymbol] = function(entryModulePath, options) {
+ if (typeof entryModulePath !== 'string')
+ throw new TypeError('entryModulePath must be a string');
+ EventEmitter.call(this);
+ options = Object(options);
+ const keepAlive =
+ options.keepAlive === undefined ? true : !!options.keepAlive;
+ const evalCode = !!options.eval;
+ const userData = JSONStringify(options.data);
+ this[workerContextSymbol] =
+ new WorkerContextBinding.WorkerContext(entryModulePath, {
+ keepAlive: keepAlive,
+ userData: userData,
+ eval: evalCode
+ });
+ this[installEventsSymbol]();
+};
+
+Worker.prototype[installEventsSymbol] = function() {
+ const workerObject = this;
+ const workerContext = this[workerContextSymbol];
+
+ const onerror = function(payload) {
+ var ErrorConstructor = builtinErrorTypes.get(payload.builtinType);
+ if (typeof ErrorConstructor !== 'function')
+ ErrorConstructor = Error;
+ const error = new ErrorConstructor(payload.message);
+ error.stack = payload.stack;
+ util._extend(error, payload.additionalProperties);
+ workerObject.emit('error', error);
+ };
+
+ workerContext._onexit = function(exitCode) {
+ workerObject[workerContextSymbol] = null;
+ workerObject.emit('exit', exitCode);
+ };
+
+ workerContext._onmessage = function(payload, messageType) {
+ payload = JSONParse(payload);
+ switch (messageType) {
+ case WorkerContextBinding.USER:
+ return workerObject.emit('message', payload);
+ case WorkerContextBinding.EXCEPTION:
+ return onerror(payload);
+ default:
+ assert.fail('unreachable');
+ }
+ };
+};
+
+Worker.prototype[checkAliveSymbol] = function() {
+ if (!this[workerContextSymbol])
+ throw new RangeError('this worker has been terminated');
+};
+
+Worker.prototype.postMessage = function(payload) {
+ this[checkAliveSymbol]();
+ this[workerContextSymbol].postMessage(JSONStringify(payload),
+ EMPTY_ARRAY,
+ WorkerContextBinding.USER);
+};
+
+Worker.prototype.terminate = function(callback) {
+ this[checkAliveSymbol]();
+ const context = this[workerContextSymbol];
+ this[workerContextSymbol] = null;
+ if (typeof callback === 'function') {
+ this.once('exit', function(exitCode) {
+ callback(null, exitCode);
+ });
+ }
+ context.terminate();
+};
+
+Worker.prototype.ref = function() {
+ this[checkAliveSymbol]();
+ this[workerContextSymbol].ref();
+};
+
+Worker.prototype.unref = function() {
+ this[checkAliveSymbol]();
+ this[workerContextSymbol].unref();
+};
+
+if (process.isWorkerThread) {
+ const postMessage = function(payload, transferList, type) {
+ if (!Array.isArray(transferList))
+ throw new TypeError('transferList must be an array');
+
+ WorkerContextBinding.workerWrapper._postMessage(JSONStringify(payload),
+ transferList,
+ type);
+ };
+ const workerFatalError = function(er) {
+ const defaultStack = null;
+ const defaultMessage = '[toString() conversion failed]';
+ const defaultBuiltinType = 'Error';
+
+ var message = defaultMessage;
+ var builtinType = defaultBuiltinType;
+ var stack = defaultStack;
+ var additionalProperties = {};
+
+ // As this is a fatal error handler we cannot throw any new errors here
+ // but should still try to extract as much info as possible from the
+ // cause.
+ if (er instanceof Error) {
+ // .name can be a getter that throws.
+ try {
+ builtinType = er.name;
+ } catch (ignore) {}
+
+ if (typeof builtinType !== 'string')
+ builtinType = defaultBuiltinType;
+
+ // .stack can be a getter that throws.
+ try {
+ stack = er.stack;
+ } catch (ignore) {}
+
+ if (typeof stack !== 'string')
+ stack = defaultStack;
+
+ try {
+ // Get inherited enumerable properties.
+ // .name, .stack and .message are all non-enumerable
+ for (var key in er)
+ additionalProperties[key] = er[key];
+ // The message delivery must always succeed, otherwise the real cause
+ // of this fatal error is masked.
+ JSONStringify(additionalProperties);
+ } catch (e) {
+ additionalProperties = {};
+ }
+ }
+
+ try {
+ // .message can be a getter that throws or the call to toString may fail.
+ if (er instanceof Error) {
+ message = er.message;
+ if (typeof message !== 'string')
+ message = '' + er;
+ } else {
+ message = '' + er;
+ }
+ } catch (e) {
+ message = defaultMessage;
+ }
+
+ postMessage({
+ message: message,
+ stack: stack,
+ additionalProperties: additionalProperties,
+ builtinType: builtinType
+ }, EMPTY_ARRAY, WorkerContextBinding.EXCEPTION);
+ };
+
+ util._extend(Worker, EventEmitter.prototype);
+ EventEmitter.call(Worker);
+
+ WorkerContextBinding.workerWrapper._onmessage =
+ function(payload, messageType) {
+ payload = JSONParse(payload);
+ switch (messageType) {
+ case WorkerContextBinding.USER:
+ return Worker.emit('message', payload);
+ default:
+ assert.fail('unreachable');
+ }
+ };
+
+ Worker.postMessage = function(payload) {
+ postMessage(payload, EMPTY_ARRAY, WorkerContextBinding.USER);
+ };
+
+ Object.defineProperty(Worker, '_workerFatalError', {
+ configurable: true,
+ writable: false,
+ enumerable: false,
+ value: workerFatalError
+ });
+}
+
+
+module.exports = Worker;

node.gyp

@@ -69,6 +69,7 @@
  'lib/v8.js',
  'lib/vm.js',
  'lib/zlib.js',
+ 'lib/worker.js',
  'lib/internal/child_process.js',
  'lib/internal/cluster.js',
  'lib/internal/freelist.js',
@@ -139,6 +140,8 @@
  'src/node_watchdog.cc',
  'src/node_zlib.cc',
  'src/node_i18n.cc',
+ 'src/notification-channel.cc',
+ 'src/persistent-handle-cleanup.cc',
  'src/pipe_wrap.cc',
  'src/signal_wrap.cc',
  'src/spawn_sync.cc',
@@ -151,6 +154,7 @@
  'src/process_wrap.cc',
  'src/udp_wrap.cc',
  'src/uv.cc',
+ 'src/worker.cc',
  # headers to make for a more pleasant IDE experience
  'src/async-wrap.h',
  'src/async-wrap-inl.h',
@@ -164,6 +168,7 @@
  'src/node.h',
  'src/node_buffer.h',
  'src/node_constants.h',
+ 'src/node-contextify.h',
  'src/node_file.h',
  'src/node_http_parser.h',
  'src/node_internals.h',
@@ -174,7 +179,10 @@
  'src/node_wrap.h',
  'src/node_revert.h',
  'src/node_i18n.h',
+ 'src/notification-channel.h',
+ 'src/persistent-handle-cleanup.h',
  'src/pipe_wrap.h',
+ 'src/producer-consumer-queue.h',
  'src/tty_wrap.h',
  'src/tcp_wrap.h',
  'src/udp_wrap.h',
@@ -189,6 +197,7 @@
  'src/util-inl.h',
  'src/util.cc',
  'src/string_search.cc',
+ 'src/worker.h',
  'deps/http_parser/http_parser.h',
  'deps/v8/include/v8.h',
  'deps/v8/include/v8-debug.h',
@@ -207,6 +216,11 @@
  'V8_DEPRECATION_WARNINGS=1',
  ],
 
+ 'xcode_settings': {
+ 'OTHER_LDFLAGS': [
+ '-stdlib=libc++',
+ ],
+ },
 
  'conditions': [
  [ 'node_tag!=""', {
@@ -679,7 +693,8 @@
  'dependencies': [
  'deps/gtest/gtest.gyp:gtest',
  'deps/v8/tools/gyp/v8.gyp:v8',
- 'deps/v8/tools/gyp/v8.gyp:v8_libplatform'
+ 'deps/v8/tools/gyp/v8.gyp:v8_libplatform',
+ 'deps/uv/uv.gyp:libuv',
  ],
  'include_dirs': [
  'src',