/* -*- Mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; tab-width: 40 -*- */ /* This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ #include "Worker.h" #include "mozilla/dom/DOMJSClass.h" #include "mozilla/dom/BindingUtils.h" #include "jsapi.h" #include "EventTarget.h" #include "RuntimeService.h" #include "WorkerPrivate.h" #include "WorkerInlines.h" #define FUNCTION_FLAGS \ JSPROP_ENUMERATE USING_WORKERS_NAMESPACE using namespace mozilla::dom; using mozilla::ErrorResult; namespace { class Worker { static const DOMJSClass sClass; static const DOMIfaceAndProtoJSClass sProtoClass; static const JSPropertySpec sProperties[]; static const JSFunctionSpec sFunctions[]; protected: enum { // The constructor function holds a WorkerPrivate* in its first reserved // slot. CONSTRUCTOR_SLOT_PARENT = 0 }; public: static const JSClass* Class() { return sClass.ToJSClass(); } static const JSClass* ProtoClass() { return sProtoClass.ToJSClass(); } static const DOMClass* DOMClassStruct() { return &sClass.mClass; } static JSObject* InitClass(JSContext* aCx, JSObject* aObj, JSObject* aParentProto, bool aMainRuntime) { JS::Rooted proto(aCx, js::InitClassWithReserved(aCx, aObj, aParentProto, ProtoClass(), Construct, 0, sProperties, sFunctions, NULL, NULL)); if (!proto) { return NULL; } js::SetReservedSlot(proto, DOM_PROTO_INSTANCE_CLASS_SLOT, JS::PrivateValue(const_cast(DOMClassStruct()))); if (!aMainRuntime) { WorkerPrivate* parent = GetWorkerPrivateFromContext(aCx); parent->AssertIsOnWorkerThread(); JSObject* constructor = JS_GetConstructor(aCx, proto); if (!constructor) return NULL; js::SetFunctionNativeReserved(constructor, CONSTRUCTOR_SLOT_PARENT, PRIVATE_TO_JSVAL(parent)); } return proto; } static WorkerPrivate* GetInstancePrivate(JSContext* aCx, JSObject* aObj, const char* aFunctionName); protected: static bool ConstructInternal(JSContext* aCx, unsigned aArgc, jsval* aVp, bool aIsChromeWorker, const JSClass* aClass) { if (!aArgc) { JS_ReportError(aCx, "Constructor requires at least one argument!"); return false; } JS::Rooted scriptURL(aCx, JS_ValueToString(aCx, JS_ARGV(aCx, aVp)[0])); if (!scriptURL) { return false; } jsval priv = js::GetFunctionNativeReserved(JSVAL_TO_OBJECT(JS_CALLEE(aCx, aVp)), CONSTRUCTOR_SLOT_PARENT); RuntimeService* runtimeService; WorkerPrivate* parent; if (JSVAL_IS_VOID(priv)) { runtimeService = RuntimeService::GetOrCreateService(); if (!runtimeService) { JS_ReportError(aCx, "Failed to create runtime service!"); return false; } parent = NULL; } else { runtimeService = RuntimeService::GetService(); parent = static_cast(JSVAL_TO_PRIVATE(priv)); parent->AssertIsOnWorkerThread(); } JS::Rooted obj(aCx, JS_NewObject(aCx, aClass, nullptr, nullptr)); if (!obj) { return false; } // Ensure that the DOM_OBJECT_SLOT always has a PrivateValue set, as this // will be accessed in the Trace() method if WorkerPrivate::Create() // triggers a GC. js::SetReservedSlot(obj, DOM_OBJECT_SLOT, JS::PrivateValue(nullptr)); nsRefPtr worker = WorkerPrivate::Create(aCx, obj, parent, scriptURL, aIsChromeWorker); if (!worker) { return false; } // Worker now owned by the JS object. NS_ADDREF(worker.get()); js::SetReservedSlot(obj, DOM_OBJECT_SLOT, PRIVATE_TO_JSVAL(worker)); if (!runtimeService->RegisterWorker(aCx, worker)) { return false; } // Worker now also owned by its thread. NS_ADDREF(worker.get()); JS_SET_RVAL(aCx, aVp, OBJECT_TO_JSVAL(obj)); return true; } private: // No instance of this class should ever be created so these are explicitly // left without an implementation to prevent linking in case someone tries to // make one. Worker(); ~Worker(); static bool IsWorker(JS::Handle v) { return v.isObject() && ClassIsWorker(JS_GetClass(&v.toObject())); } static bool GetEventListener(JSContext* aCx, const JS::CallArgs aArgs, const nsAString &aNameStr) { WorkerPrivate* worker = GetInstancePrivate(aCx, &aArgs.thisv().toObject(), NS_ConvertUTF16toUTF8(aNameStr).get()); MOZ_ASSERT(worker); ErrorResult rv; JS::Rooted listener(aCx, worker->GetEventListener(Substring(aNameStr, 2), rv)); if (rv.Failed()) { JS_ReportError(aCx, "Failed to get listener!"); return false; } aArgs.rval().setObjectOrNull(listener); return true; } static bool GetOnerrorImpl(JSContext* aCx, JS::CallArgs aArgs) { return GetEventListener(aCx, aArgs, NS_LITERAL_STRING("onerror")); } static bool GetOnerror(JSContext* aCx, unsigned aArgc, JS::Value* aVp) { JS::CallArgs args = JS::CallArgsFromVp(aArgc, aVp); return JS::CallNonGenericMethod(aCx, args); } static bool GetOnmessageImpl(JSContext* aCx, JS::CallArgs aArgs) { return GetEventListener(aCx, aArgs, NS_LITERAL_STRING("onmessage")); } static bool GetOnmessage(JSContext* aCx, unsigned aArgc, JS::Value* aVp) { JS::CallArgs args = JS::CallArgsFromVp(aArgc, aVp); return JS::CallNonGenericMethod(aCx, args); } static bool SetEventListener(JSContext* aCx, JS::CallArgs aArgs, const nsAString& aNameStr) { WorkerPrivate* worker = GetInstancePrivate(aCx, &aArgs.thisv().toObject(), NS_ConvertUTF16toUTF8(aNameStr).get()); MOZ_ASSERT(worker); JS::Rooted listener(aCx); if (!JS_ValueToObject(aCx, aArgs.get(0), listener.address())) { return false; } ErrorResult rv; worker->SetEventListener(Substring(aNameStr, 2), listener, rv); if (rv.Failed()) { JS_ReportError(aCx, "Failed to set listener!"); return false; } aArgs.rval().setUndefined(); return true; } static bool SetOnerrorImpl(JSContext* aCx, JS::CallArgs aArgs) { return SetEventListener(aCx, aArgs, NS_LITERAL_STRING("onerror")); } static bool SetOnerror(JSContext* aCx, unsigned aArgc, JS::Value* aVp) { JS::CallArgs args = JS::CallArgsFromVp(aArgc, aVp); return JS::CallNonGenericMethod(aCx, args); } static bool SetOnmessageImpl(JSContext* aCx, JS::CallArgs aArgs) { return SetEventListener(aCx, aArgs, NS_LITERAL_STRING("onmessage")); } static bool SetOnmessage(JSContext* aCx, unsigned aArgc, JS::Value* aVp) { JS::CallArgs args = JS::CallArgsFromVp(aArgc, aVp); return JS::CallNonGenericMethod(aCx, args); } static bool Construct(JSContext* aCx, unsigned aArgc, jsval* aVp) { return ConstructInternal(aCx, aArgc, aVp, false, Class()); } static void Finalize(JSFreeOp* aFop, JSObject* aObj) { JS_ASSERT(JS_GetClass(aObj) == Class()); WorkerPrivate* worker = UnwrapDOMObject(aObj); if (worker) { worker->_finalize(aFop); } } static void Trace(JSTracer* aTrc, JSObject* aObj) { JS_ASSERT(JS_GetClass(aObj) == Class()); WorkerPrivate* worker = UnwrapDOMObject(aObj); if (worker) { worker->_trace(aTrc); } } static bool Terminate(JSContext* aCx, unsigned aArgc, jsval* aVp) { JSObject* obj = JS_THIS_OBJECT(aCx, aVp); if (!obj) { return false; } const char* name = sFunctions[0].name; WorkerPrivate* worker = GetInstancePrivate(aCx, obj, name); if (!worker) { return !JS_IsExceptionPending(aCx); } if (!worker->Terminate(aCx)) { return false; } JS_RVAL(aCx, aVp).setUndefined(); return true; } static bool PostMessage(JSContext* aCx, unsigned aArgc, jsval* aVp) { JSObject* obj = JS_THIS_OBJECT(aCx, aVp); if (!obj) { return false; } const char* name = sFunctions[1].name; WorkerPrivate* worker = GetInstancePrivate(aCx, obj, name); if (!worker) { return !JS_IsExceptionPending(aCx); } JS::Rooted message(aCx); JS::Rooted transferable(aCx, JS::UndefinedValue()); if (!JS_ConvertArguments(aCx, aArgc, JS_ARGV(aCx, aVp), "v/v", message.address(), transferable.address())) { return false; } if (!worker->PostMessage(aCx, message, transferable)) { return false; } JS_RVAL(aCx, aVp).setUndefined(); return true; } }; const DOMJSClass Worker::sClass = { { "Worker", JSCLASS_IS_DOMJSCLASS | JSCLASS_HAS_RESERVED_SLOTS(3) | JSCLASS_IMPLEMENTS_BARRIERS, JS_PropertyStub, JS_DeletePropertyStub, JS_PropertyStub, JS_StrictPropertyStub, JS_EnumerateStub, JS_ResolveStub, JS_ConvertStub, Finalize, NULL, NULL, NULL, NULL, Trace }, { INTERFACE_CHAIN_1(prototypes::id::EventTarget_workers), false, &sWorkerNativePropertyHooks } }; const DOMIfaceAndProtoJSClass Worker::sProtoClass = { { // XXXbz we use "Worker" here to match sClass so that we can // js::InitClassWithReserved this JSClass and then call // JS_NewObject with our sClass and have it find the right // prototype. "Worker", JSCLASS_IS_DOMIFACEANDPROTOJSCLASS | JSCLASS_HAS_RESERVED_SLOTS(2), JS_PropertyStub, /* addProperty */ JS_DeletePropertyStub, /* delProperty */ JS_PropertyStub, /* getProperty */ JS_StrictPropertyStub, /* setProperty */ JS_EnumerateStub, JS_ResolveStub, JS_ConvertStub, nullptr, /* finalize */ nullptr, /* checkAccess */ nullptr, /* call */ nullptr, /* hasInstance */ nullptr, /* construct */ nullptr, /* trace */ JSCLASS_NO_INTERNAL_MEMBERS }, eInterfacePrototype, &sWorkerNativePropertyHooks, "[object Worker]", prototypes::id::_ID_Count, 0 }; const JSPropertySpec Worker::sProperties[] = { JS_PSGS("onerror", GetOnerror, SetOnerror, JSPROP_ENUMERATE), JS_PSGS("onmessage", GetOnmessage, SetOnmessage, JSPROP_ENUMERATE), JS_PS_END }; const JSFunctionSpec Worker::sFunctions[] = { JS_FN("terminate", Terminate, 0, FUNCTION_FLAGS), JS_FN("postMessage", PostMessage, 1, FUNCTION_FLAGS), JS_FS_END }; class ChromeWorker : public Worker { static const DOMJSClass sClass; static const DOMIfaceAndProtoJSClass sProtoClass; public: static const JSClass* Class() { return sClass.ToJSClass(); } static const JSClass* ProtoClass() { return sProtoClass.ToJSClass(); } static const DOMClass* DOMClassStruct() { return &sClass.mClass; } static JSObject* InitClass(JSContext* aCx, JSObject* aObj, JSObject* aParentProto, bool aMainRuntime) { JS::Rooted proto(aCx, js::InitClassWithReserved(aCx, aObj, aParentProto, ProtoClass(), Construct, 0, NULL, NULL, NULL, NULL)); if (!proto) { return NULL; } js::SetReservedSlot(proto, DOM_PROTO_INSTANCE_CLASS_SLOT, JS::PrivateValue(const_cast(DOMClassStruct()))); if (!aMainRuntime) { WorkerPrivate* parent = GetWorkerPrivateFromContext(aCx); parent->AssertIsOnWorkerThread(); JSObject* constructor = JS_GetConstructor(aCx, proto); if (!constructor) return NULL; js::SetFunctionNativeReserved(constructor, CONSTRUCTOR_SLOT_PARENT, PRIVATE_TO_JSVAL(parent)); } return proto; } private: // No instance of this class should ever be created so these are explicitly // left without an implementation to prevent linking in case someone tries to // make one. ChromeWorker(); ~ChromeWorker(); static WorkerPrivate* GetInstancePrivate(JSContext* aCx, JSObject* aObj, const char* aFunctionName) { if (aObj) { const JSClass* classPtr = JS_GetClass(aObj); if (classPtr == Class()) { return UnwrapDOMObject(aObj); } } return Worker::GetInstancePrivate(aCx, aObj, aFunctionName); } static bool Construct(JSContext* aCx, unsigned aArgc, jsval* aVp) { return ConstructInternal(aCx, aArgc, aVp, true, Class()); } static void Finalize(JSFreeOp* aFop, JSObject* aObj) { JS_ASSERT(JS_GetClass(aObj) == Class()); WorkerPrivate* worker = UnwrapDOMObject(aObj); if (worker) { worker->_finalize(aFop); } } static void Trace(JSTracer* aTrc, JSObject* aObj) { JS_ASSERT(JS_GetClass(aObj) == Class()); WorkerPrivate* worker = UnwrapDOMObject(aObj); if (worker) { worker->_trace(aTrc); } } }; const DOMJSClass ChromeWorker::sClass = { { "ChromeWorker", JSCLASS_IS_DOMJSCLASS | JSCLASS_HAS_RESERVED_SLOTS(3) | JSCLASS_IMPLEMENTS_BARRIERS, JS_PropertyStub, JS_DeletePropertyStub, JS_PropertyStub, JS_StrictPropertyStub, JS_EnumerateStub, JS_ResolveStub, JS_ConvertStub, Finalize, NULL, NULL, NULL, NULL, Trace, }, { INTERFACE_CHAIN_1(prototypes::id::EventTarget_workers), false, &sWorkerNativePropertyHooks } }; const DOMIfaceAndProtoJSClass ChromeWorker::sProtoClass = { { // XXXbz we use "ChromeWorker" here to match sClass so that we can // js::InitClassWithReserved this JSClass and then call // JS_NewObject with our sClass and have it find the right // prototype. "ChromeWorker", JSCLASS_IS_DOMIFACEANDPROTOJSCLASS | JSCLASS_HAS_RESERVED_SLOTS(2), JS_PropertyStub, /* addProperty */ JS_DeletePropertyStub, /* delProperty */ JS_PropertyStub, /* getProperty */ JS_StrictPropertyStub, /* setProperty */ JS_EnumerateStub, JS_ResolveStub, JS_ConvertStub, nullptr, /* finalize */ nullptr, /* checkAccess */ nullptr, /* call */ nullptr, /* hasInstance */ nullptr, /* construct */ nullptr, /* trace */ JSCLASS_NO_INTERNAL_MEMBERS }, eInterfacePrototype, &sWorkerNativePropertyHooks, "[object ChromeWorker]", prototypes::id::_ID_Count, 0 }; WorkerPrivate* Worker::GetInstancePrivate(JSContext* aCx, JSObject* aObj, const char* aFunctionName) { const JSClass* classPtr = JS_GetClass(aObj); if (ClassIsWorker(classPtr)) { return UnwrapDOMObject(aObj); } JS_ReportErrorNumber(aCx, js_GetErrorMessage, NULL, JSMSG_INCOMPATIBLE_PROTO, Class()->name, aFunctionName, classPtr->name); return NULL; } } // anonymous namespace BEGIN_WORKERS_NAMESPACE namespace worker { JSObject* InitClass(JSContext* aCx, JSObject* aGlobal, JSObject* aProto, bool aMainRuntime) { return Worker::InitClass(aCx, aGlobal, aProto, aMainRuntime); } } // namespace worker WorkerCrossThreadDispatcher* GetWorkerCrossThreadDispatcher(JSContext* aCx, jsval aWorker) { if (JSVAL_IS_PRIMITIVE(aWorker)) { return NULL; } WorkerPrivate* w = Worker::GetInstancePrivate(aCx, JSVAL_TO_OBJECT(aWorker), "GetWorkerCrossThreadDispatcher"); if (!w) { return NULL; } return w->GetCrossThreadDispatcher(); } namespace chromeworker { bool InitClass(JSContext* aCx, JSObject* aGlobal, JSObject* aProto, bool aMainRuntime) { return !!ChromeWorker::InitClass(aCx, aGlobal, aProto, aMainRuntime); } } // namespace chromeworker bool ClassIsWorker(const JSClass* aClass) { return Worker::Class() == aClass || ChromeWorker::Class() == aClass; } bool GetterOnlyJSNative(JSContext* aCx, unsigned aArgc, JS::Value* aVp) { JS_ReportErrorNumber(aCx, js_GetErrorMessage, nullptr, JSMSG_GETTER_ONLY); return false; } END_WORKERS_NAMESPACE