// Copyright 2004-present Facebook. All Rights Reserved. #include "JSCExecutor.h" #include #include #include #include #include #include #include #include #include #include #include #include "FollySupport.h" #include "JSCHelpers.h" #include "Platform.h" #include "SystraceSection.h" #include "Value.h" #include "JSCSamplingProfiler.h" #if defined(WITH_JSC_EXTRA_TRACING) || DEBUG #include "JSCTracing.h" #endif #ifdef WITH_JSC_EXTRA_TRACING #include "JSCLegacyProfiler.h" #include "JSCLegacyTracing.h" #include #endif #ifdef WITH_JSC_MEMORY_PRESSURE #include #endif #ifdef WITH_FB_MEMORY_PROFILING #include "JSCMemory.h" #endif #if defined(WITH_FB_JSC_TUNING) && defined(__ANDROID__) #include #endif #ifdef JSC_HAS_PERF_STATS_API #include "JSCPerfStats.h" #endif namespace facebook { namespace react { namespace { template inline JSObjectCallAsFunctionCallback exceptionWrapMethod() { struct funcWrapper { static JSValueRef call( JSContextRef ctx, JSObjectRef function, JSObjectRef thisObject, size_t argumentCount, const JSValueRef arguments[], JSValueRef *exception) { try { auto globalObj = JSContextGetGlobalObject(ctx); auto executor = static_cast(JSObjectGetPrivate(globalObj)); return (executor->*method)(argumentCount, arguments); } catch (...) { *exception = translatePendingCppExceptionToJSError(ctx, function); return JSValueMakeUndefined(ctx); } } }; return &funcWrapper::call; } } static JSValueRef nativeInjectHMRUpdate( JSContextRef ctx, JSObjectRef function, JSObjectRef thisObject, size_t argumentCount, const JSValueRef arguments[], JSValueRef *exception); std::unique_ptr JSCExecutorFactory::createJSExecutor( std::shared_ptr delegate, std::shared_ptr jsQueue) { return std::unique_ptr( new JSCExecutor(delegate, jsQueue, m_cacheDir, m_jscConfig)); } JSCExecutor::JSCExecutor(std::shared_ptr delegate, std::shared_ptr messageQueueThread, const std::string& cacheDir, const folly::dynamic& jscConfig) throw(JSException) : m_delegate(delegate), m_deviceCacheDir(cacheDir), m_messageQueueThread(messageQueueThread), m_jscConfig(jscConfig) { initOnJSVMThread(); SystraceSection s("setBatchedBridgeConfig"); folly::dynamic nativeModuleConfig = folly::dynamic::array(); { SystraceSection s("collectNativeModuleNames"); for (auto& name : delegate->moduleNames()) { nativeModuleConfig.push_back(folly::dynamic::array(std::move(name))); } } folly::dynamic config = folly::dynamic::object ("remoteModuleConfig", std::move(nativeModuleConfig)); SystraceSection t("setGlobalVariable"); setGlobalVariable( "__fbBatchedBridgeConfig", folly::make_unique(detail::toStdString(folly::toJson(config)))); } JSCExecutor::JSCExecutor( std::shared_ptr delegate, std::shared_ptr messageQueueThread, int workerId, JSCExecutor *owner, std::string scriptURL, std::unordered_map globalObjAsJSON, const folly::dynamic& jscConfig) : m_delegate(delegate), m_workerId(workerId), m_owner(owner), m_deviceCacheDir(owner->m_deviceCacheDir), m_messageQueueThread(messageQueueThread), m_jscConfig(jscConfig) { // We post initOnJSVMThread here so that the owner doesn't have to wait for // initialization on its own thread m_messageQueueThread->runOnQueue([this, scriptURL, globalObjAsJSON=std::move(globalObjAsJSON)] () { initOnJSVMThread(); installNativeHook<&JSCExecutor::nativePostMessage>("postMessage"); for (auto& it : globalObjAsJSON) { setGlobalVariable(std::move(it.first), folly::make_unique(std::move(it.second))); } // Try to load the script from the network if script is a URL // NB: For security, this will only work in debug builds std::unique_ptr script; if (scriptURL.find("http://") == 0 || scriptURL.find("https://") == 0) { std::stringstream outfileBuilder; outfileBuilder << m_deviceCacheDir << "/workerScript" << m_workerId << ".js"; script = folly::make_unique( WebWorkerUtil::loadScriptFromNetworkSync(scriptURL, outfileBuilder.str())); } else { // TODO(9604438): Protect against script does not exist script = WebWorkerUtil::loadScriptFromAssets(scriptURL); } // TODO(9994180): Throw on error loadApplicationScript(std::move(script), std::move(scriptURL)); }); } JSCExecutor::~JSCExecutor() { CHECK(*m_isDestroyed) << "JSCExecutor::destroy() must be called before its destructor!"; } void JSCExecutor::destroy() { *m_isDestroyed = true; m_messageQueueThread->runOnQueueSync([this] () { terminateOnJSVMThread(); }); } void JSCExecutor::initOnJSVMThread() throw(JSException) { SystraceSection s("JSCExecutor.initOnJSVMThread"); #if defined(WITH_FB_JSC_TUNING) && defined(__ANDROID__) configureJSCForAndroid(m_jscConfig); #endif JSClassRef globalClass = nullptr; { SystraceSection s("JSClassCreate"); globalClass = JSClassCreate(&kJSClassDefinitionEmpty); } { SystraceSection s("JSGlobalContextCreateInGroup"); m_context = JSGlobalContextCreateInGroup(nullptr, globalClass); } JSClassRelease(globalClass); // Add a pointer to ourselves so we can retrieve it later in our hooks JSObjectSetPrivate(JSContextGetGlobalObject(m_context), this); installNativeHook<&JSCExecutor::nativeRequireModuleConfig>("nativeRequireModuleConfig"); installNativeHook<&JSCExecutor::nativeFlushQueueImmediate>("nativeFlushQueueImmediate"); installNativeHook<&JSCExecutor::nativeStartWorker>("nativeStartWorker"); installNativeHook<&JSCExecutor::nativePostMessageToWorker>("nativePostMessageToWorker"); installNativeHook<&JSCExecutor::nativeTerminateWorker>("nativeTerminateWorker"); installGlobalFunction(m_context, "nativeInjectHMRUpdate", nativeInjectHMRUpdate); installNativeHook<&JSCExecutor::nativeCallSyncHook>("nativeCallSyncHook"); installGlobalFunction(m_context, "nativeLoggingHook", JSNativeHooks::loggingHook); installGlobalFunction(m_context, "nativePerformanceNow", JSNativeHooks::nowHook); #if defined(WITH_JSC_EXTRA_TRACING) || DEBUG addNativeTracingHooks(m_context); #endif #ifdef WITH_JSC_EXTRA_TRACING addNativeProfilingHooks(m_context); addNativeTracingLegacyHooks(m_context); PerfLogging::installNativeHooks(m_context); initSamplingProfilerOnMainJSCThread(m_context); #endif #ifdef WITH_FB_MEMORY_PROFILING addNativeMemoryHooks(m_context); #endif #ifdef JSC_HAS_PERF_STATS_API addJSCPerfStatsHooks(m_context); #endif #if defined(WITH_FB_JSC_TUNING) && defined(__ANDROID__) configureJSContextForAndroid(m_context, m_jscConfig, m_deviceCacheDir); #endif } void JSCExecutor::terminateOnJSVMThread() { // terminateOwnedWebWorker mutates m_ownedWorkers so collect all the workers // to terminate first std::vector workerIds; for (auto& it : m_ownedWorkers) { workerIds.push_back(it.first); } for (int workerId : workerIds) { terminateOwnedWebWorker(workerId); } JSGlobalContextRelease(m_context); m_context = nullptr; } #ifdef WITH_FBJSCEXTENSIONS void JSCExecutor::loadApplicationScript( std::string bundlePath, std::string sourceURL, int flags) { SystraceSection s("JSCExecutor::loadApplicationScript", "sourceURL", sourceURL); if ((flags & UNPACKED_JS_SOURCE) == 0) { throw std::runtime_error("Optimized bundle with no unpacked js source"); } auto jsScriptBigString = JSBigMmapString::fromOptimizedBundle(bundlePath); if (jsScriptBigString->encoding() != JSBigMmapString::Encoding::Ascii) { LOG(WARNING) << "Bundle is not ASCII encoded - falling back to the slow path"; return loadApplicationScript(std::move(jsScriptBigString), sourceURL); } ReactMarker::logMarker("RUN_JS_BUNDLE_START"); if (flags & UNPACKED_BC_CACHE) { configureJSCBCCache(m_context, bundlePath); } String jsSourceURL(sourceURL.c_str()); JSSourceCodeRef sourceCode = JSCreateSourceCode( jsScriptBigString->fd(), jsScriptBigString->size(), jsSourceURL, jsScriptBigString->hash(), true); SCOPE_EXIT { JSReleaseSourceCode(sourceCode); }; evaluateSourceCode(m_context, sourceCode, jsSourceURL); bindBridge(); flush(); ReactMarker::logMarker("CREATE_REACT_CONTEXT_END"); ReactMarker::logMarker("RUN_JS_BUNDLE_END"); } #endif void JSCExecutor::loadApplicationScript(std::unique_ptr script, std::string sourceURL) throw(JSException) { SystraceSection s("JSCExecutor::loadApplicationScript", "sourceURL", sourceURL); #ifdef WITH_FBSYSTRACE fbsystrace_begin_section( TRACE_TAG_REACT_CXX_BRIDGE, "JSCExecutor::loadApplicationScript-createExpectingAscii"); #endif ReactMarker::logMarker("RUN_JS_BUNDLE_START"); ReactMarker::logMarker("loadApplicationScript_startStringConvert"); String jsScript = jsStringFromBigString(*script); ReactMarker::logMarker("loadApplicationScript_endStringConvert"); #ifdef WITH_FBSYSTRACE fbsystrace_end_section(TRACE_TAG_REACT_CXX_BRIDGE); #endif String jsSourceURL(sourceURL.c_str()); evaluateScript(m_context, jsScript, jsSourceURL); bindBridge(); flush(); ReactMarker::logMarker("CREATE_REACT_CONTEXT_END"); ReactMarker::logMarker("RUN_JS_BUNDLE_END"); } void JSCExecutor::setJSModulesUnbundle(std::unique_ptr unbundle) { if (!m_unbundle) { installNativeHook<&JSCExecutor::nativeRequire>("nativeRequire"); } m_unbundle = std::move(unbundle); } void JSCExecutor::bindBridge() throw(JSException) { SystraceSection s("JSCExecutor::bindBridge"); auto global = Object::getGlobalObject(m_context); auto batchedBridgeValue = global.getProperty("__fbBatchedBridge"); if (batchedBridgeValue.isUndefined()) { throwJSExecutionException("Could not get BatchedBridge, make sure your bundle is packaged correctly"); } auto batchedBridge = batchedBridgeValue.asObject(); m_callFunctionReturnFlushedQueueJS = batchedBridge.getProperty("callFunctionReturnFlushedQueue").asObject(); m_invokeCallbackAndReturnFlushedQueueJS = batchedBridge.getProperty("invokeCallbackAndReturnFlushedQueue").asObject(); m_flushedQueueJS = batchedBridge.getProperty("flushedQueue").asObject(); } void JSCExecutor::callNativeModules(Value&& value) { SystraceSection s("JSCExecutor::callNativeModules"); try { auto calls = value.toJSONString(); m_delegate->callNativeModules(*this, folly::parseJson(calls), true); } catch (...) { std::string message = "Error in callNativeModules()"; try { message += ":" + value.toString().str(); } catch (...) { // ignored } std::throw_with_nested(std::runtime_error(message)); } } void JSCExecutor::flush() { SystraceSection s("JSCExecutor::flush"); callNativeModules(m_flushedQueueJS->callAsFunction({})); } void JSCExecutor::callFunction(const std::string& moduleId, const std::string& methodId, const folly::dynamic& arguments) { SystraceSection s("JSCExecutor::callFunction"); // This weird pattern is because Value is not default constructible. // The lambda is inlined, so there's no overhead. auto result = [&] { try { return m_callFunctionReturnFlushedQueueJS->callAsFunction({ Value(m_context, String::createExpectingAscii(moduleId)), Value(m_context, String::createExpectingAscii(methodId)), Value::fromDynamic(m_context, std::move(arguments)) }); } catch (...) { std::throw_with_nested( std::runtime_error("Error calling function: " + moduleId + ":" + methodId)); } }(); callNativeModules(std::move(result)); } void JSCExecutor::invokeCallback(const double callbackId, const folly::dynamic& arguments) { SystraceSection s("JSCExecutor::invokeCallback"); auto result = [&] { try { return m_invokeCallbackAndReturnFlushedQueueJS->callAsFunction({ JSValueMakeNumber(m_context, callbackId), Value::fromDynamic(m_context, std::move(arguments)) }); } catch (...) { std::throw_with_nested( std::runtime_error(folly::to("Error invoking callback.", callbackId))); } }(); callNativeModules(std::move(result)); } void JSCExecutor::setGlobalVariable(std::string propName, std::unique_ptr jsonValue) { try { SystraceSection s("JSCExecutor.setGlobalVariable", "propName", propName); auto globalObject = JSContextGetGlobalObject(m_context); String jsPropertyName(propName.c_str()); String jsValueJSON = jsStringFromBigString(*jsonValue); auto valueToInject = JSValueMakeFromJSONString(m_context, jsValueJSON); JSObjectSetProperty(m_context, globalObject, jsPropertyName, valueToInject, 0, NULL); } catch (...) { std::throw_with_nested(std::runtime_error("Error setting global variable: " + propName)); } } void* JSCExecutor::getJavaScriptContext() { return m_context; } bool JSCExecutor::supportsProfiling() { #ifdef WITH_FBSYSTRACE return true; #else return false; #endif } void JSCExecutor::startProfiler(const std::string &titleString) { #ifdef WITH_JSC_EXTRA_TRACING JSStringRef title = JSStringCreateWithUTF8CString(titleString.c_str()); #if WITH_REACT_INTERNAL_SETTINGS JSStartProfiling(m_context, title, false); #else JSStartProfiling(m_context, title); #endif JSStringRelease(title); #endif } void JSCExecutor::stopProfiler(const std::string &titleString, const std::string& filename) { #ifdef WITH_JSC_EXTRA_TRACING JSStringRef title = JSStringCreateWithUTF8CString(titleString.c_str()); facebook::react::stopAndOutputProfilingFile(m_context, title, filename.c_str()); JSStringRelease(title); #endif } void JSCExecutor::handleMemoryPressureUiHidden() { #ifdef WITH_JSC_MEMORY_PRESSURE JSHandleMemoryPressure(this, m_context, JSMemoryPressure::UI_HIDDEN); #endif } void JSCExecutor::handleMemoryPressureModerate() { #ifdef WITH_JSC_MEMORY_PRESSURE JSHandleMemoryPressure(this, m_context, JSMemoryPressure::MODERATE); #endif } void JSCExecutor::handleMemoryPressureCritical() { #ifdef WITH_JSC_MEMORY_PRESSURE JSHandleMemoryPressure(this, m_context, JSMemoryPressure::CRITICAL); #endif } void JSCExecutor::flushQueueImmediate(Value&& queue) { auto queueStr = queue.toJSONString(); m_delegate->callNativeModules(*this, folly::parseJson(queueStr), false); } void JSCExecutor::loadModule(uint32_t moduleId) { auto module = m_unbundle->getModule(moduleId); auto sourceUrl = String::createExpectingAscii(module.name); auto source = String::createExpectingAscii(module.code); evaluateScript(m_context, source, sourceUrl); } int JSCExecutor::addWebWorker( std::string scriptURL, JSValueRef workerRef, JSValueRef globalObjRef) { static std::atomic_int nextWorkerId(1); int workerId = nextWorkerId++; Object globalObj = Value(m_context, globalObjRef).asObject(); auto workerJscConfig = m_jscConfig; workerJscConfig["isWebWorker"] = true; std::shared_ptr workerMQT = WebWorkerUtil::createWebWorkerThread(workerId, m_messageQueueThread.get()); std::unique_ptr worker; workerMQT->runOnQueueSync([this, &worker, &workerMQT, &scriptURL, &globalObj, workerId, &workerJscConfig] () { worker.reset(new JSCExecutor(m_delegate, workerMQT, workerId, this, std::move(scriptURL), globalObj.toJSONMap(), workerJscConfig)); }); Object workerObj = Value(m_context, workerRef).asObject(); workerObj.makeProtected(); JSCExecutor *workerPtr = worker.get(); std::shared_ptr sharedMessageQueueThread = worker->m_messageQueueThread; m_delegate->registerExecutor( std::move(worker), std::move(sharedMessageQueueThread)); m_ownedWorkers.emplace( std::piecewise_construct, std::forward_as_tuple(workerId), std::forward_as_tuple(workerPtr, std::move(workerObj))); return workerId; } void JSCExecutor::postMessageToOwnedWebWorker(int workerId, JSValueRef message) { auto worker = m_ownedWorkers.at(workerId).executor; std::string msgString = Value(m_context, message).toJSONString(); std::shared_ptr isWorkerDestroyed = worker->m_isDestroyed; worker->m_messageQueueThread->runOnQueue([isWorkerDestroyed, worker, msgString] () { if (*isWorkerDestroyed) { return; } worker->receiveMessageFromOwner(msgString); }); } void JSCExecutor::postMessageToOwner(JSValueRef msg) { std::string msgString = Value(m_context, msg).toJSONString(); std::shared_ptr ownerIsDestroyed = m_owner->m_isDestroyed; m_owner->m_messageQueueThread->runOnQueue([workerId=m_workerId, owner=m_owner, ownerIsDestroyed, msgString] () { if (*ownerIsDestroyed) { return; } owner->receiveMessageFromOwnedWebWorker(workerId, msgString); }); } void JSCExecutor::receiveMessageFromOwnedWebWorker(int workerId, const std::string& json) { Object* workerObj; try { workerObj = &m_ownedWorkers.at(workerId).jsObj; } catch (std::out_of_range& e) { // Worker was already terminated return; } Value onmessageValue = workerObj->getProperty("onmessage"); if (onmessageValue.isUndefined()) { return; } JSValueRef args[] = { createMessageObject(json) }; onmessageValue.asObject().callAsFunction(1, args); flush(); } void JSCExecutor::receiveMessageFromOwner(const std::string& msgString) { CHECK(m_owner) << "Received message in a Executor that doesn't have an owner!"; JSValueRef args[] = { createMessageObject(msgString) }; Value onmessageValue = Object::getGlobalObject(m_context).getProperty("onmessage"); onmessageValue.asObject().callAsFunction(1, args); } void JSCExecutor::terminateOwnedWebWorker(int workerId) { auto& workerRegistration = m_ownedWorkers.at(workerId); std::shared_ptr workerMQT = workerRegistration.executor->m_messageQueueThread; m_ownedWorkers.erase(workerId); workerMQT->runOnQueueSync([this, &workerMQT] { workerMQT->quitSynchronous(); std::unique_ptr worker = m_delegate->unregisterExecutor(*this); worker->destroy(); worker.reset(); }); } Object JSCExecutor::createMessageObject(const std::string& msgJson) { Value rebornJSMsg = Value::fromJSON(m_context, String(msgJson.c_str())); Object messageObject = Object::create(m_context); messageObject.setProperty("data", rebornJSMsg); return messageObject; } // Native JS hooks template void JSCExecutor::installNativeHook(const char* name) { installGlobalFunction(m_context, name, exceptionWrapMethod()); } JSValueRef JSCExecutor::nativePostMessage( size_t argumentCount, const JSValueRef arguments[]) { if (argumentCount != 1) { throw std::invalid_argument("Got wrong number of args"); } JSValueRef msg = arguments[0]; postMessageToOwner(msg); return JSValueMakeUndefined(m_context); } JSValueRef JSCExecutor::nativeRequire( size_t argumentCount, const JSValueRef arguments[]) { if (argumentCount != 1) { throw std::invalid_argument("Got wrong number of args"); } double moduleId = Value(m_context, arguments[0]).asNumber(); if (moduleId <= (double) std::numeric_limits::max() && moduleId >= 0.0) { try { loadModule(moduleId); } catch (const std::exception&) { throw std::invalid_argument(folly::to("Received invalid module ID: ", moduleId)); } } else { throw std::invalid_argument(folly::to("Received invalid module ID: ", moduleId)); } return JSValueMakeUndefined(m_context); } JSValueRef JSCExecutor::nativeRequireModuleConfig( size_t argumentCount, const JSValueRef arguments[]) { if (argumentCount != 1) { throw std::invalid_argument("Got wrong number of args"); } std::string moduleName = Value(m_context, arguments[0]).toString().str(); folly::dynamic config = m_delegate->getModuleConfig(moduleName); return Value::fromDynamic(m_context, config); } JSValueRef JSCExecutor::nativeFlushQueueImmediate( size_t argumentCount, const JSValueRef arguments[]) { if (argumentCount != 1) { throw std::invalid_argument("Got wrong number of args"); } flushQueueImmediate(Value(m_context, arguments[0])); return JSValueMakeUndefined(m_context); } JSValueRef JSCExecutor::nativeStartWorker( size_t argumentCount, const JSValueRef arguments[]) { if (argumentCount != 3) { throw std::invalid_argument("Got wrong number of args"); } std::string scriptFile = Value(m_context, arguments[0]).toString().str(); JSValueRef worker = arguments[1]; JSValueRef globalObj = arguments[2]; int workerId = addWebWorker(scriptFile, worker, globalObj); return JSValueMakeNumber(m_context, workerId); } JSValueRef JSCExecutor::nativePostMessageToWorker( size_t argumentCount, const JSValueRef arguments[]) { if (argumentCount != 2) { throw std::invalid_argument("Got wrong number of args"); } double workerDouble = Value(m_context, arguments[0]).asNumber(); if (workerDouble != workerDouble) { throw std::invalid_argument("Got invalid worker id"); } postMessageToOwnedWebWorker((int) workerDouble, arguments[1]); return JSValueMakeUndefined(m_context); } JSValueRef JSCExecutor::nativeTerminateWorker( size_t argumentCount, const JSValueRef arguments[]) { if (argumentCount != 1) { throw std::invalid_argument("Got wrong number of args"); } double workerDouble = Value(m_context, arguments[0]).asNumber(); if (workerDouble != workerDouble) { std::invalid_argument("Got invalid worker id"); } terminateOwnedWebWorker((int) workerDouble); return JSValueMakeUndefined(m_context); } JSValueRef JSCExecutor::nativeCallSyncHook( size_t argumentCount, const JSValueRef arguments[]) { if (argumentCount != 3) { throw std::invalid_argument("Got wrong number of args"); } unsigned int moduleId = Value(m_context, arguments[0]).asUnsignedInteger(); unsigned int methodId = Value(m_context, arguments[1]).asUnsignedInteger(); std::string argsJson = Value(m_context, arguments[2]).toJSONString(); MethodCallResult result = m_delegate->callSerializableNativeHook( *this, moduleId, methodId, argsJson); if (result.isUndefined) { return JSValueMakeUndefined(m_context); } return Value::fromDynamic(m_context, result.result); } static JSValueRef nativeInjectHMRUpdate( JSContextRef ctx, JSObjectRef function, JSObjectRef thisObject, size_t argumentCount, const JSValueRef arguments[], JSValueRef *exception) { String execJSString = Value(ctx, arguments[0]).toString(); String jsURL = Value(ctx, arguments[1]).toString(); evaluateScript(ctx, execJSString, jsURL); return JSValueMakeUndefined(ctx); } } }