// Copyright 2004-present Facebook. All Rights Reserved. #pragma once #include #include #include #include #include #include #include "JSModulesUnbundle.h" namespace facebook { namespace react { #define UNPACKED_JS_SOURCE_PATH_SUFFIX "/bundle.js" #define UNPACKED_META_PATH_SUFFIX "/bundle.meta" #define UNPACKED_BYTECODE_SUFFIX "/bundle.bytecode" enum { UNPACKED_JS_SOURCE = (1 << 0), UNPACKED_BC_CACHE = (1 << 1), UNPACKED_BYTECODE = (1 << 2), }; class JSExecutor; class JSModulesUnbundle; class MessageQueueThread; class ModuleRegistry; struct MethodCallResult { folly::dynamic result; bool isUndefined; }; // This interface describes the delegate interface required by // Executor implementations to call from JS into native code. class ExecutorDelegate { public: virtual ~ExecutorDelegate() {} virtual void registerExecutor(std::unique_ptr executor, std::shared_ptr queue) = 0; virtual std::unique_ptr unregisterExecutor(JSExecutor& executor) = 0; virtual std::shared_ptr getModuleRegistry() = 0; virtual void callNativeModules( JSExecutor& executor, folly::dynamic&& calls, bool isEndOfBatch) = 0; virtual MethodCallResult callSerializableNativeHook( JSExecutor& executor, unsigned int moduleId, unsigned int methodId, folly::dynamic&& args) = 0; }; class JSExecutorFactory { public: virtual std::unique_ptr createJSExecutor( std::shared_ptr delegate, std::shared_ptr jsQueue) = 0; virtual ~JSExecutorFactory() {} }; // JSExecutor functions sometimes take large strings, on the order of // megabytes. Copying these can be expensive. Introducing a // move-only, non-CopyConstructible type will let the compiler ensure // that no copies occur. folly::MoveWrapper should be used when a // large string needs to be curried into a std::function<>, which must // by CopyConstructible. class JSBigString { public: JSBigString() = default; // Not copyable JSBigString(const JSBigString&) = delete; JSBigString& operator=(const JSBigString&) = delete; virtual ~JSBigString() {} virtual bool isAscii() const = 0; virtual const char* c_str() const = 0; virtual size_t size() const = 0; }; // Concrete JSBigString implementation which holds a std::string // instance. class JSBigStdString : public JSBigString { public: JSBigStdString(std::string str, bool isAscii=false) : m_isAscii(isAscii) , m_str(std::move(str)) {} bool isAscii() const override { return m_isAscii; } const char* c_str() const override { return m_str.c_str(); } size_t size() const override { return m_str.size(); } private: bool m_isAscii; std::string m_str; }; // Concrete JSBigString implementation which holds a heap-allocated // buffer, and provides an accessor for writing to it. This can be // used to construct a JSBigString in place, such as by reading from a // file. class JSBigBufferString : public facebook::react::JSBigString { public: JSBigBufferString(size_t size) : m_data(new char[size + 1]) , m_size(size) { // Guarantee nul-termination. The caller is responsible for // filling in the rest of m_data. m_data[m_size] = '\0'; } ~JSBigBufferString() { delete[] m_data; } bool isAscii() const override { return true; } const char* c_str() const override { return m_data; } size_t size() const override { return m_size; } char* data() { return m_data; } private: char* m_data; size_t m_size; }; // JSBigString interface implemented by a file-backed mmap region. class JSBigFileString : public JSBigString { public: JSBigFileString(int fd, size_t size, off_t offset = 0) : m_fd {fd} , m_data {nullptr} { // Offsets given to mmap must be page aligend. We abstract away that // restriction by sending a page aligned offset to mmap, and keeping track // of the offset within the page that we must alter the mmap pointer by to // get the final desired offset. auto ps = getpagesize(); auto d = lldiv(offset, ps); m_mapOff = d.quot; m_pageOff = d.rem; m_size = size + m_pageOff; } ~JSBigFileString() { if (m_data) { munmap((void *)m_data, m_size); } close(m_fd); } bool isAscii() const override { return true; } const char *c_str() const override { if (!m_data) { m_data = (const char *)mmap(0, m_size, PROT_READ, MAP_SHARED, m_fd, m_mapOff); CHECK(m_data != MAP_FAILED) << " fd: " << m_fd << " size: " << m_size << " offset: " << m_mapOff << " error: " << std::strerror(errno); } return m_data + m_pageOff; } size_t size() const override { return m_size - m_pageOff; } int fd() const { return m_fd; } private: int m_fd; // The file descriptor being mmaped size_t m_size; // The size of the mmaped region size_t m_pageOff; // The offset in the mmaped region to the data. off_t m_mapOff; // The offset in the file to the mmaped region. mutable const char *m_data; // Pointer to the mmaped region. }; class JSBigOptimizedBundleString : public JSBigString { public: enum class Encoding { Unknown, Ascii, Utf8, Utf16, }; JSBigOptimizedBundleString(int fd, size_t size, const uint8_t sha1[20], Encoding encoding) : m_fd(fd), m_size(size), m_encoding(encoding), m_str(nullptr) { memcpy(m_hash, sha1, 20); } ~JSBigOptimizedBundleString() { if (m_str) { CHECK(munmap((void *)m_str, m_size) != -1); } close(m_fd); } bool isAscii() const override { return m_encoding == Encoding::Ascii; } const char* c_str() const override { if (!m_str) { m_str = (const char *)mmap(0, m_size, PROT_READ, MAP_SHARED, m_fd, 0); CHECK(m_str != MAP_FAILED); } return m_str; } size_t size() const override { return m_size; } int fd() const { return m_fd; } const uint8_t* hash() const { return m_hash; } Encoding encoding() const { return m_encoding; } static std::unique_ptr fromOptimizedBundle(const std::string& bundlePath); private: int m_fd; size_t m_size; uint8_t m_hash[20]; Encoding m_encoding; mutable const char *m_str; }; class JSExecutor { public: /** * Execute an application script bundle in the JS context. */ virtual void loadApplicationScript(std::unique_ptr script, std::string sourceURL) = 0; /** * Execute an application script optimized bundle in the JS context. */ virtual void loadApplicationScript(std::string bundlePath, std::string source, int flags); /** * @experimental * * Read an app bundle from a file descriptor, determine how it should be * loaded, load and execute it in the JS context. */ virtual void loadApplicationScript(int fd, std::string source); /** * Add an application "unbundle" file */ virtual void setJSModulesUnbundle(std::unique_ptr bundle) = 0; /** * Executes BatchedBridge.callFunctionReturnFlushedQueue with the module ID, * method ID and optional additional arguments in JS. The executor is responsible * for using Bridge->callNativeModules to invoke any necessary native modules methods. */ virtual void callFunction(const std::string& moduleId, const std::string& methodId, const folly::dynamic& arguments) = 0; /** * Executes BatchedBridge.invokeCallbackAndReturnFlushedQueue with the cbID, * and optional additional arguments in JS and returns the next queue. The executor * is responsible for using Bridge->callNativeModules to invoke any necessary * native modules methods. */ virtual void invokeCallback(const double callbackId, const folly::dynamic& arguments) = 0; virtual void setGlobalVariable(std::string propName, std::unique_ptr jsonValue) = 0; virtual void* getJavaScriptContext() { return nullptr; } virtual bool supportsProfiling() { return false; } virtual void startProfiler(const std::string &titleString) {} virtual void stopProfiler(const std::string &titleString, const std::string &filename) {} virtual void handleMemoryPressureUiHidden() {} virtual void handleMemoryPressureModerate() {} virtual void handleMemoryPressureCritical() { handleMemoryPressureModerate(); } virtual void destroy() {} virtual ~JSExecutor() {} }; } }