Files
cocos4/native/cocos/scripting/js-bindings/jswrapper/sm/ScriptEngine.cpp
T

737 lines
22 KiB
C++

#include "ScriptEngine.hpp"
#ifdef SCRIPT_ENGINE_SM
#include "Object.hpp"
#include "Class.hpp"
#include "Utils.hpp"
#include "../MappingUtils.hpp"
namespace se {
Class* __jsb_CCPrivateData_class = nullptr;
namespace {
const char* BYTE_CODE_FILE_EXT = ".jsc";
ScriptEngine* __instance = nullptr;
const JSClassOps sandbox_classOps = {
nullptr, nullptr, nullptr, nullptr,
nullptr, nullptr,
nullptr, nullptr,
nullptr, nullptr, nullptr,
JS_GlobalObjectTraceHook
};
JSClass globalClass = {
"global",
JSCLASS_GLOBAL_FLAGS,
&sandbox_classOps
};
void reportWarning(JSContext* cx, JSErrorReport* report)
{
MOZ_RELEASE_ASSERT(report);
MOZ_RELEASE_ASSERT(JSREPORT_IS_WARNING(report->flags));
LOGE("%s:%u:%s\n", report->filename ? report->filename : "<no filename>",
(unsigned int) report->lineno,
report->message().c_str());
}
void SetStandardCompartmentOptions(JS::CompartmentOptions& options)
{
bool enableSharedMemory = true;
options.behaviors().setVersion(JSVERSION_LATEST);
options.creationOptions().setSharedMemoryAndAtomicsEnabled(enableSharedMemory);
}
bool __forceGC(JSContext *cx, uint32_t argc, JS::Value* vp)
{
JS_GC(cx);
return true;
}
bool __log(JSContext *cx, uint32_t argc, JS::Value* vp)
{
JS::CallArgs args = JS::CallArgsFromVp(argc, vp);
if (argc > 0) {
JSString *string = JS::ToString(cx, args[0]);
if (string) {
JS::RootedString jsstr(cx, string);
char* buffer = JS_EncodeStringToUTF8(cx, jsstr);
LOGD("JS: %s\n", buffer);
JS_free(cx, (void*)buffer);
}
}
args.rval().setUndefined();
return true;
}
// Private data class
bool privateDataContructor(JSContext* cx, uint32_t argc, JS::Value* vp)
{
return true;
}
void privateDataFinalize(JSFreeOp* fop, JSObject* obj)
{
internal::PrivateData* p = (internal::PrivateData*)JS_GetPrivate(obj);
if (p == nullptr)
return;
JS_SetPrivate(obj, p->data);
if (p->finalizeCb != nullptr)
p->finalizeCb(fop, obj);
free(p);
}
// ------------------------------------------------------- ScriptEngine
void on_garbage_collect(JSContext* cx, JSGCStatus status, void* data)
{
/* We finalize any pending toggle refs before doing any garbage collection,
* so that we can collect the JS wrapper objects, and in order to minimize
* the chances of objects having a pending toggle up queued when they are
* garbage collected. */
if (status == JSGC_BEGIN)
{
ScriptEngine::getInstance()->_setInGC(true);
LOGD("on_garbage_collect: begin, Native -> JS map count: %d, all objects: %d\n", (int)NativePtrToObjectMap::size(), (int)__objectMap.size());
}
else if (status == JSGC_END)
{
LOGD("on_garbage_collect: end, Native -> JS map count: %d, all objects: %d\n", (int)NativePtrToObjectMap::size(), (int)__objectMap.size());
ScriptEngine::getInstance()->_setInGC(false);
}
}
// For promise
using JobQueue = JS::GCVector<JSObject*, 0, js::SystemAllocPolicy>;
// Per-context promise state.
struct PromiseState
{
explicit PromiseState(JSContext* cx);
JS::PersistentRooted<JobQueue> jobQueue;
bool drainingJobQueue;
bool quitting;
};
PromiseState::PromiseState(JSContext* cx)
: drainingJobQueue(false)
, quitting(false)
{}
PromiseState* getPromiseState(JSContext* cx)
{
PromiseState* sc = static_cast<PromiseState*>(JS_GetContextPrivate(cx));
assert(sc);
return sc;
}
JSObject* onGetIncumbentGlobalCallback(JSContext* cx)
{
return JS::CurrentGlobalOrNull(cx);
}
bool onEnqueuePromiseJobCallback(JSContext* cx, JS::HandleObject job, JS::HandleObject allocationSite,
JS::HandleObject incumbentGlobal, void* data)
{
PromiseState* sc = getPromiseState(cx);
assert(job);
return sc->jobQueue.append(job);
}
bool drainJobQueue()
{
JSContext* cx = ScriptEngine::getInstance()->_getContext();
PromiseState* sc = getPromiseState(cx);
if (sc->quitting || sc->drainingJobQueue)
return true;
sc->drainingJobQueue = true;
JS::RootedObject job(cx);
JS::HandleValueArray args(JS::HandleValueArray::empty());
JS::RootedValue rval(cx);
// Execute jobs in a loop until we've reached the end of the queue.
// Since executing a job can trigger enqueuing of additional jobs,
// it's crucial to re-check the queue length during each iteration.
for (size_t i = 0; i < sc->jobQueue.length(); i++)
{
job = sc->jobQueue[i];
JSAutoCompartment ac(cx, job);
JS::Call(cx, JS::UndefinedHandleValue, job, args, &rval);
ScriptEngine::getInstance()->clearException();
sc->jobQueue[i].set(nullptr);
}
sc->jobQueue.clear();
sc->drainingJobQueue = false;
return true;
}
std::string removeFileExt(const std::string& filePath)
{
size_t pos = filePath.rfind('.');
if (0 < pos)
{
return filePath.substr(0, pos);
}
return filePath;
}
bool getBytecodeBuildId(JS::BuildIdCharVector* buildId)
{
static const char* buildid = "cocos_xdr";
bool ok = buildId->append(buildid, strlen(buildid));
return ok;
}
} // namespace {
AutoHandleScope::AutoHandleScope()
{
}
AutoHandleScope::~AutoHandleScope()
{
drainJobQueue();
}
ScriptEngine *ScriptEngine::getInstance()
{
if (__instance == nullptr)
{
__instance = new ScriptEngine();
}
return __instance;
}
void ScriptEngine::destroyInstance()
{
delete __instance;
__instance = nullptr;
}
ScriptEngine::ScriptEngine()
: _cx(nullptr)
, _globalObj(nullptr)
, _oldCompartment(nullptr)
, _isInGC(false)
, _isValid(false)
, _isInCleanup(false)
, _nodeEventListener(nullptr)
{
bool ok = JS_Init();
assert(ok);
}
/* static */
void ScriptEngine::myWeakPointerCompartmentCallback(JSContext* cx, JSCompartment* comp, void* data)
{
myWeakPointerZoneGroupCallback(cx, data);
}
/* static */
void ScriptEngine::myWeakPointerZoneGroupCallback(JSContext* cx, void* data)
{
bool isInCleanup = getInstance()->_isInCleanup;
bool isIterUpdated = false;
Object* obj = nullptr;
auto iter = NativePtrToObjectMap::begin();
while (iter != NativePtrToObjectMap::end())
{
obj = iter->second;
isIterUpdated = false;
if (!obj->isRooted())
{
if (obj->updateAfterGC(data))
{
obj->release();
iter = NativePtrToObjectMap::erase(iter);
isIterUpdated = true;
}
}
else if (isInCleanup) // Rooted and in cleanup step
{
obj->unprotect();
obj->release();
iter = NativePtrToObjectMap::erase(iter);
isIterUpdated = true;
}
if (!isIterUpdated)
++iter;
}
}
bool ScriptEngine::init()
{
cleanup();
LOGD("Initializing SpiderMonkey \n");
for (const auto& hook : _beforeInitHookArray)
{
hook();
}
_beforeInitHookArray.clear();
_cx = JS_NewContext(JS::DefaultHeapMaxBytes);
if (nullptr == _cx)
return false;
NativePtrToObjectMap::init();
NonRefNativePtrCreatedByCtorMap::init();
Class::setContext(_cx);
Object::setContext(_cx);
JS_SetGCParameter(_cx, JSGC_MAX_BYTES, 0xffffffff);
JS_SetGCParameter(_cx, JSGC_MODE, JSGC_MODE_INCREMENTAL);
JS_SetNativeStackQuota(_cx, 5000000);
JS_SetGCCallback(_cx, on_garbage_collect, nullptr);
if (!JS::InitSelfHostedCode(_cx))
return false;
PromiseState* sc = new (std::nothrow) PromiseState(_cx);
if (!sc)
return false;
JS_SetContextPrivate(_cx, sc);
// Waiting is allowed on the shell's main thread, for now.
JS_SetFutexCanWait(_cx);
JS::SetWarningReporter(_cx, reportWarning);
#if defined(JS_GC_ZEAL) && defined(DEBUG)
// JS_SetGCZeal(_cx, 2, JS_DEFAULT_ZEAL_FREQ);
#endif
JS_SetDefaultLocale(_cx, "UTF-8");
JS_BeginRequest(_cx);
JS::CompartmentOptions options;
SetStandardCompartmentOptions(options);
#ifdef DEBUG
JS::ContextOptionsRef(_cx)
// .setExtraWarnings(true)
.setIon(false)
.setBaseline(false)
.setAsmJS(false);
#else
JS::ContextOptionsRef(_cx)
// .setExtraWarnings(true)
.setIon(true)
.setBaseline(true)
.setAsmJS(true)
.setNativeRegExp(true);
#endif
JSObject* globalObj = JS_NewGlobalObject(_cx, &globalClass, nullptr, JS::DontFireOnNewGlobalHook, options);
if (nullptr == globalObj)
return false;
_globalObj = Object::_createJSObject(nullptr, globalObj);
_globalObj->root();
JS::RootedObject rootedGlobalObj(_cx, _globalObj->_getJSObject());
_oldCompartment = JS_EnterCompartment(_cx, rootedGlobalObj);
JS_InitStandardClasses(_cx, rootedGlobalObj) ;
JS_DefineFunction(_cx, rootedGlobalObj, "log", __log, 0, JSPROP_PERMANENT);
JS_DefineFunction(_cx, rootedGlobalObj, "forceGC", __forceGC, 0, JSPROP_READONLY | JSPROP_PERMANENT);
// JS_AddWeakPointerZoneGroupCallback(_cx, ScriptEngine::myWeakPointerZoneGroupCallback, nullptr);
JS_AddWeakPointerCompartmentCallback(_cx, ScriptEngine::myWeakPointerCompartmentCallback, nullptr);
JS_FireOnNewGlobalObject(_cx, rootedGlobalObj);
JS::SetBuildIdOp(_cx, getBytecodeBuildId);
sc->jobQueue.init(_cx, JobQueue(js::SystemAllocPolicy()));
JS::SetEnqueuePromiseJobCallback(_cx, onEnqueuePromiseJobCallback);
JS::SetGetIncumbentGlobalCallback(_cx, onGetIncumbentGlobalCallback);
__jsb_CCPrivateData_class = Class::create("__CCPrivateData", _globalObj, nullptr, privateDataContructor);
__jsb_CCPrivateData_class->defineFinalizeFunction(privateDataFinalize);
__jsb_CCPrivateData_class->install();
_isValid = true;
for (const auto& hook : _afterInitHookArray)
{
hook();
}
_afterInitHookArray.clear();
return true;
}
ScriptEngine::~ScriptEngine()
{
cleanup();
JS_ShutDown();
}
void ScriptEngine::cleanup()
{
if (!_isValid)
return;
_isInCleanup = true;
for (const auto& hook : _beforeCleanupHookArray)
{
hook();
}
_beforeCleanupHookArray.clear();
auto sc = getPromiseState(_cx);
sc->quitting = true;
SAFE_RELEASE(_globalObj);
Class::cleanup();
Object::cleanup();
// JS_RemoveWeakPointerZoneGroupCallback(_cx, ScriptEngine::myWeakPointerZoneGroupCallback);
// JS_RemoveWeakPointerCompartmentCallback(_cx, ScriptEngine::myWeakPointerCompartmentCallback);
JS_LeaveCompartment(_cx, _oldCompartment);
JS::SetGetIncumbentGlobalCallback(_cx, nullptr);
JS::SetEnqueuePromiseJobCallback(_cx, nullptr);
sc->jobQueue.reset();
JS_EndRequest(_cx);
JS_DestroyContext(_cx);
delete sc;
_cx = nullptr;
_globalObj = nullptr;
_oldCompartment = nullptr;
_isValid = false;
_nodeEventListener = nullptr;
_registerCallbackArray.clear();
_filenameScriptMap.clear();
for (const auto& hook : _afterCleanupHookArray)
{
hook();
}
_afterCleanupHookArray.clear();
_isInCleanup = false;
NativePtrToObjectMap::destroy();
NonRefNativePtrCreatedByCtorMap::destroy();
}
void ScriptEngine::addBeforeCleanupHook(const std::function<void()>& hook)
{
_beforeCleanupHookArray.push_back(hook);
}
void ScriptEngine::addAfterCleanupHook(const std::function<void()>& hook)
{
_afterCleanupHookArray.push_back(hook);
}
void ScriptEngine::addBeforeInitHook(const std::function<void()>& hook)
{
_beforeInitHookArray.push_back(hook);
}
void ScriptEngine::addAfterInitHook(const std::function<void()>& hook)
{
_afterInitHookArray.push_back(hook);
}
bool ScriptEngine::isInGC()
{
return _isInGC;
}
void ScriptEngine::_setInGC(bool isInGC)
{
_isInGC = isInGC;
}
Object* ScriptEngine::getGlobalObject()
{
return _globalObj;
}
void ScriptEngine::addRegisterCallback(RegisterCallback cb)
{
assert(std::find(_registerCallbackArray.begin(), _registerCallbackArray.end(), cb) == _registerCallbackArray.end());
_registerCallbackArray.push_back(cb);
}
bool ScriptEngine::start()
{
if (!init())
return false;
bool ok = false;
_startTime = std::chrono::steady_clock::now();
for (auto cb : _registerCallbackArray)
{
ok = cb(_globalObj);
assert(ok);
if (!ok)
break;
}
// After ScriptEngine is started, _registerCallbackArray isn't needed. Therefore, clear it here.
_registerCallbackArray.clear();
return ok;
}
bool ScriptEngine::getScript(const std::string& path, JS::MutableHandleScript script)
{
// a) check jsc file first
std::string byteCodePath = removeFileExt(path) + BYTE_CODE_FILE_EXT;
if (_filenameScriptMap.find(byteCodePath) != _filenameScriptMap.end())
{
script.set(_filenameScriptMap[byteCodePath]->get());
return true;
}
// b) no jsc file, check js file
if (_filenameScriptMap.find(path) != _filenameScriptMap.end())
{
script.set(_filenameScriptMap[path]->get());
return true;
}
return false;
}
bool ScriptEngine::compileScript(const std::string& path, JS::MutableHandleScript script)
{
if (path.empty())
return false;
bool ok = getScript(path, script);
if (ok)
return true;
assert(_fileOperationDelegate.isValid());
bool compileSucceed = false;
// a) check jsc file first
std::string byteCodePath = removeFileExt(path) + BYTE_CODE_FILE_EXT;
// Check whether '.jsc' files exist to avoid outputting log which says 'couldn't find .jsc file'.
if (_fileOperationDelegate.onCheckFileExist(byteCodePath))
{
const uint8_t* data = nullptr;
size_t dataLen = 0;
_fileOperationDelegate.onGetDataFromFile(byteCodePath, &data, &dataLen);
if (data != nullptr && dataLen > 0)
{
JS::TranscodeBuffer buffer;
bool appended = buffer.append(data, dataLen);
JS::TranscodeResult result = JS::DecodeScript(_cx, buffer, script);
if (appended && result == JS::TranscodeResult::TranscodeResult_Ok)
{
compileSucceed = true;
_filenameScriptMap[byteCodePath] = new (std::nothrow) JS::PersistentRootedScript(_cx, script.get());
}
assert(compileSucceed);
}
}
// b) no jsc file, check js file
if (!compileSucceed)
{
/* Clear any pending exception from previous failed decoding. */
clearException();
ok = false;
std::string jsFileContent = _fileOperationDelegate.onGetStringFromFile(path);
if (!jsFileContent.empty())
{
JS::CompileOptions op(_cx);
op.setUTF8(true);
std::string fullPath = _fileOperationDelegate.onGetFullPath(path);
op.setFileAndLine(fullPath.c_str(), 1);
ok = JS::Compile(_cx, op, jsFileContent.c_str(), jsFileContent.size(), script);
if (ok)
{
compileSucceed = true;
_filenameScriptMap[fullPath] = new (std::nothrow) JS::PersistentRootedScript(_cx, script.get());
}
assert(compileSucceed);
}
}
clearException();
if (!compileSucceed)
{
LOGD("ScriptEngine::compileScript fail:%s\n", path.c_str());
}
return compileSucceed;
}
bool ScriptEngine::executeScriptBuffer(const char* script, ssize_t length/* = -1 */, Value* ret/* = nullptr */, const char* fileName/* = nullptr */)
{
assert(script != nullptr);
if (length < 0)
length = strlen(script);
if (fileName == nullptr)
fileName = "(no filename)";
JS::CompileOptions options(_cx);
options.setFile(fileName)
.setUTF8(true)
.setVersion(JSVERSION_LATEST);
JS::RootedValue rval(_cx);
bool ok = JS::Evaluate(_cx, options, script, length, &rval);
if (!ok)
{
clearException();
}
assert(ok);
if (ok && ret != nullptr && !rval.isNullOrUndefined())
{
internal::jsToSeValue(_cx, rval, ret);
}
return ok;
}
void ScriptEngine::setFileOperationDelegate(const FileOperationDelegate& delegate)
{
_fileOperationDelegate = delegate;
}
bool ScriptEngine::executeScriptFile(const std::string& path, Value* ret/* = nullptr */)
{
assert(_fileOperationDelegate.isValid());
JS::RootedScript script(_cx);
bool ok = compileScript(path, &script);
if (ok)
{
JS::RootedValue rval(_cx);
ok = JS_ExecuteScript(_cx, script, &rval);
if (!ok)
{
LOGE("Evaluating %s failed (evaluatedOK == JS_FALSE)\n", path.c_str());
clearException();
}
assert(ok);
if (ok && ret != nullptr && !rval.isNullOrUndefined())
{
internal::jsToSeValue(_cx, rval, ret);
}
}
return ok;
}
void ScriptEngine::_retainScriptObject(void* owner, void* target)
{
auto iterOwner = NativePtrToObjectMap::find(owner);
if (iterOwner == NativePtrToObjectMap::end())
{
return;
}
auto iterTarget = NativePtrToObjectMap::find(target);
if (iterTarget == NativePtrToObjectMap::end())
{
return;
}
clearException();
iterOwner->second->attachObject(iterTarget->second);
}
void ScriptEngine::_releaseScriptObject(void* owner, void* target)
{
auto iterOwner = NativePtrToObjectMap::find(owner);
if (iterOwner == NativePtrToObjectMap::end())
{
return;
}
auto iterTarget = NativePtrToObjectMap::find(target);
if (iterTarget == NativePtrToObjectMap::end())
{
return;
}
clearException();
iterOwner->second->detachObject(iterTarget->second);
}
bool ScriptEngine::_onReceiveNodeEvent(void* node, NodeEventType type)
{
assert(_nodeEventListener != nullptr);
return _nodeEventListener(node, type);
}
bool ScriptEngine::_setNodeEventListener(NodeEventListener listener)
{
_nodeEventListener = listener;
return true;
}
void ScriptEngine::clearException()
{
if (_cx == nullptr)
return;
if (JS_IsExceptionPending(_cx))
{
JS::RootedValue exceptionValue(_cx);
JS_GetPendingException(_cx, &exceptionValue);
JS_ClearPendingException(_cx);
assert(exceptionValue.isObject());
JS::RootedObject exceptionObj(_cx, exceptionValue.toObjectOrNull());
JSErrorReport* report = JS_ErrorFromException(_cx, exceptionObj);
const char* fileName = report->filename != nullptr ? report->filename : "(no filename)";
LOGE("JS ERROR: %s, file: %s, lineno: %u\n", report->message().c_str(), fileName, report->lineno);
JS::RootedValue stack(_cx);
if (JS_GetProperty(_cx, exceptionObj, "stack", &stack) && stack.isString())
{
JS::RootedString jsstackStr(_cx, stack.toString());
char *stackStr = JS_EncodeStringToUTF8(_cx, jsstackStr);
LOGE("Stack: %s\n", stackStr);
}
}
}
} // namespace se {
#endif // SCRIPT_ENGINE_SM