/* * Copyright (c) 2022 Huawei Device Co., Ltd. * 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. */ #include "worker.h" #include "commonlibrary/ets_utils/js_sys_module/timer/timer.h" #include "helper/hitrace_helper.h" #include "process_helper.h" #include "task_group.h" #include "task_manager.h" #include "utils/log.h" namespace Commonlibrary::Concurrent::TaskPoolModule { using namespace OHOS::JsSysModule; using namespace Commonlibrary::Platform; Worker::RunningScope::~RunningScope() { if (scope_ != nullptr) { napi_close_handle_scope(worker_->workerEnv_, scope_); } // only when worker is not blocked can it be inserted { std::lock_guard lock(worker_->stateMutex_); if (UNLIKELY(worker_->state_ == WorkerState::BLOCKED)) { return; } } worker_->NotifyIdle(); } Worker* Worker::WorkerConstructor(napi_env env) { HITRACE_HELPER_METER_NAME("WorkerConstructor: [Add Thread]"); Worker* worker = new Worker(env); worker->StartExecuteInThread(); return worker; } void Worker::ReleaseWorkerHandles(const uv_async_t* req) { HITRACE_HELPER_METER_NAME("ReleaseWorkerHandles: [Release Thread]"); auto worker = static_cast(req->data); // when there is no active handle, worker loop will stop automatically. uv_close(reinterpret_cast(worker->performTaskSignal_), [](uv_handle_t* handle) { if (handle != nullptr) { delete reinterpret_cast(handle); handle = nullptr; } }); #if !defined(WINDOWS_PLATFORM) && !defined(MAC_PLATFORM) uv_close(reinterpret_cast(worker->debuggerOnPostTaskSignal_), [](uv_handle_t* handle) { if (handle != nullptr) { delete reinterpret_cast(handle); handle = nullptr; } }); #endif uv_close(reinterpret_cast(worker->clearWorkerSignal_), [](uv_handle_t* handle) { if (handle != nullptr) { delete reinterpret_cast(handle); handle = nullptr; } }); uv_loop_t* loop = worker->GetWorkerLoop(); if (loop != nullptr) { uv_stop(loop); } } void Worker::StartExecuteInThread() { if (!runner_) { runner_ = std::make_unique(TaskStartCallback(ExecuteInThread, this)); } if (runner_) { runner_->Execute(); // start a new thread } else { HILOG_ERROR("taskpool:: runner_ is nullptr"); } } #if !defined(WINDOWS_PLATFORM) && !defined(MAC_PLATFORM) void Worker::HandleDebuggerTask(const uv_async_t* req) { Worker* worker = reinterpret_cast(req->data); if (worker == nullptr) { HILOG_ERROR("taskpool:: worker is null"); return; } worker->debuggerTask_(); } void Worker::DebuggerOnPostTask(std::function&& task) { if (uv_is_active(reinterpret_cast(debuggerOnPostTaskSignal_))) { debuggerTask_ = std::move(task); uv_async_send(debuggerOnPostTaskSignal_); } } #endif void Worker::ExecuteInThread(const void* data) { HITRACE_HELPER_START_TRACE(__PRETTY_FUNCTION__); auto worker = reinterpret_cast(const_cast(data)); { napi_create_runtime(worker->hostEnv_, &worker->workerEnv_); if (worker->workerEnv_ == nullptr) { HILOG_ERROR("taskpool:: workerEnv is nullptr"); return; } auto workerEngine = reinterpret_cast(worker->workerEnv_); // mark worker env is taskpoolThread workerEngine->MarkTaskPoolThread(); workerEngine->InitTaskPoolThread(workerEngine, Worker::TaskResultCallback); } uv_loop_t* loop = worker->GetWorkerLoop(); if (loop == nullptr) { HILOG_ERROR("taskpool:: loop is nullptr"); return; } // save the worker tid worker->tid_ = GetThreadId(); // Init worker task execute signal worker->performTaskSignal_ = new uv_async_t; worker->performTaskSignal_->data = worker; uv_async_init(loop, worker->performTaskSignal_, reinterpret_cast(Worker::PerformTask)); worker->clearWorkerSignal_ = new uv_async_t; worker->clearWorkerSignal_->data = worker; uv_async_init(loop, worker->clearWorkerSignal_, reinterpret_cast(Worker::ReleaseWorkerHandles)); HITRACE_HELPER_FINISH_TRACE; #if !defined(WINDOWS_PLATFORM) && !defined(MAC_PLATFORM) // Init debugger task post signal worker->debuggerOnPostTaskSignal_ = new uv_async_t; worker->debuggerOnPostTaskSignal_->data = worker; uv_async_init(loop, worker->debuggerOnPostTaskSignal_, reinterpret_cast(Worker::HandleDebuggerTask)); #endif if (worker->PrepareForWorkerInstance()) { // Call after uv_async_init worker->NotifyWorkerCreated(); worker->RunLoop(); } else { HILOG_ERROR("taskpool:: Worker PrepareForWorkerInstance fail"); } TaskManager::GetInstance().RemoveWorker(worker); worker->ReleaseWorkerThreadContent(); delete worker; worker = nullptr; } bool Worker::PrepareForWorkerInstance() { HITRACE_HELPER_METER_NAME(__PRETTY_FUNCTION__); auto workerEngine = reinterpret_cast(workerEnv_); #if !defined(WINDOWS_PLATFORM) && !defined(MAC_PLATFORM) workerEngine->SetDebuggerPostTaskFunc( std::bind(&Worker::DebuggerOnPostTask, this, std::placeholders::_1)); #endif if (!workerEngine->CallInitWorkerFunc(workerEngine)) { HILOG_ERROR("taskpool:: Worker CallInitWorkerFunc fail"); return false; } // register timer interface Timer::RegisterTime(workerEnv_); // Check exception after worker construction if (NapiHelper::IsExceptionPending(workerEnv_)) { HILOG_ERROR("taskpool:: Worker construction occur exception"); return false; } return true; } void Worker::ReleaseWorkerThreadContent() { auto workerEngine = reinterpret_cast(workerEnv_); if (workerEngine == nullptr) { HILOG_ERROR("taskpool:: workerEngine is nullptr"); return; } if (state_ == WorkerState::BLOCKED) { HITRACE_HELPER_METER_NAME("Thread Timeout Exit"); } else { HITRACE_HELPER_METER_NAME("Thread Exit"); } Timer::ClearEnvironmentTimer(workerEnv_); // 2. delete NativeEngine created in worker thread if (!workerEngine->CallOffWorkerFunc(workerEngine)) { HILOG_ERROR("worker:: CallOffWorkerFunc error"); } delete workerEngine; workerEnv_ = nullptr; } void Worker::NotifyExecuteTask() { if (uv_is_active(reinterpret_cast(performTaskSignal_))) { uv_async_send(performTaskSignal_); } } void Worker::NotifyIdle() { TaskManager::GetInstance().NotifyWorkerIdle(this); } void Worker::NotifyWorkerCreated() { TaskManager::GetInstance().NotifyWorkerCreated(this); } void Worker::NotifyTaskFinished() { if (--runningCount_ != 0) { // the worker state is still RUNNING and the start time will be updated startTime_ = ConcurrentHelper::GetMilliseconds(); } else { std::lock_guard lock(stateMutex_); if (state_ != WorkerState::BLOCKED) { state_ = WorkerState::IDLE; } } idlePoint_ = ConcurrentHelper::GetMilliseconds(); } void Worker::PerformTask(const uv_async_t* req) { auto worker = static_cast(req->data); napi_env env = worker->workerEnv_; napi_status status = napi_ok; RunningScope runningScope(worker, status); NAPI_CALL_RETURN_VOID(env, status); auto executeIdAndPriority = TaskManager::GetInstance().DequeueExecuteId(); if (executeIdAndPriority.first == 0) { worker->NotifyTaskFinished(); return; } PriorityScope priorityScope(worker, executeIdAndPriority.second); TaskInfo* taskInfo = TaskManager::GetInstance().GetTaskInfo(executeIdAndPriority.first); if (taskInfo == nullptr) { // task may have been canceled worker->NotifyTaskFinished(); HILOG_DEBUG("taskpool::PerformTask taskInfo is null"); return; } { std::lock_guard lock(worker->currentTaskIdMutex_); worker->currentTaskId_.emplace_back(taskInfo->taskId); } // tag for trace parse: Task Perform std::string strTrace = "Task Perform: taskId : " + std::to_string(taskInfo->taskId) + ", executeId : " + std::to_string(taskInfo->executeId); HITRACE_HELPER_METER_NAME(strTrace); taskInfo->worker = worker; TaskManager::GetInstance().UpdateExecuteState(taskInfo->executeId, ExecuteState::RUNNING); napi_value func; status = napi_deserialize(env, taskInfo->serializationFunction, &func); if (status != napi_ok || func == nullptr) { HILOG_ERROR("taskpool:: PerformTask deserialize function fail"); napi_value err = ErrorHelper::NewError(env, ErrorHelper::ERR_WORKER_SERIALIZATION, "taskpool: failed to deserialize function."); taskInfo->success = false; NotifyTaskResult(env, taskInfo, err); return; } napi_value args; status = napi_deserialize(env, taskInfo->serializationArguments, &args); if (status != napi_ok || args == nullptr) { HILOG_ERROR("taskpool:: PerformTask deserialize arguments fail"); napi_value err = ErrorHelper::NewError(env, ErrorHelper::ERR_WORKER_SERIALIZATION, "taskpool: failed to deserialize arguments."); taskInfo->success = false; NotifyTaskResult(env, taskInfo, err); return; } auto funcVal = reinterpret_cast(func); auto workerEngine = reinterpret_cast(env); // Store taskinfo in function bool success = workerEngine->InitTaskPoolFunc(workerEngine, funcVal, taskInfo); napi_value exception; napi_get_and_clear_last_exception(env, &exception); if (exception != nullptr) { HILOG_ERROR("taskpool:: InitTaskPoolFunc occur exception"); taskInfo->success = false; napi_value errorEvent = ErrorHelper::TranslateErrorEvent(env, exception); NotifyTaskResult(env, taskInfo, errorEvent); return; } if (!success) { HILOG_ERROR("taskpool:: InitTaskPoolFunc fail"); napi_value err = ErrorHelper::NewError(env, ErrorHelper::TYPE_ERROR, "taskpool: function may not be concurrent."); taskInfo->success = false; NotifyTaskResult(env, taskInfo, err); return; } uint32_t argsNum = NapiHelper::GetArrayLength(env, args); napi_value argsArray[argsNum]; napi_value val; for (size_t i = 0; i < argsNum; i++) { napi_get_element(env, args, i, &val); argsArray[i] = val; } napi_value result; napi_value undefined = NapiHelper::GetUndefinedValue(env); napi_call_function(env, undefined, func, argsNum, argsArray, &result); { std::lock_guard lock(worker->stateMutex_); if (LIKELY(worker->state_ == WorkerState::RUNNING)) { uint64_t duration = ConcurrentHelper::GetMilliseconds() - worker->startTime_; TaskManager::GetInstance().UpdateExecutedInfo(duration); } } napi_get_and_clear_last_exception(env, &exception); if (exception != nullptr) { HILOG_ERROR("taskpool::PerformTask occur exception"); taskInfo->success = false; napi_value errorEvent = ErrorHelper::TranslateErrorEvent(env, exception); NotifyTaskResult(env, taskInfo, errorEvent); } } void Worker::NotifyTaskResult(napi_env env, TaskInfo* taskInfo, napi_value result) { HITRACE_HELPER_METER_NAME(__PRETTY_FUNCTION__); napi_value undefined = NapiHelper::GetUndefinedValue(env); napi_value resultData; napi_status status = napi_serialize(env, result, undefined, &resultData); if ((status != napi_ok || resultData == nullptr) && taskInfo->success) { taskInfo->success = false; napi_value err = ErrorHelper::NewError(env, ErrorHelper::ERR_WORKER_SERIALIZATION, "taskpool: failed to serialize result."); NotifyTaskResult(env, taskInfo, err); return; } taskInfo->result = resultData; TaskManager::GetInstance().RemoveExecuteState(taskInfo->executeId); if (taskInfo->groupExecuteId == 0) { TaskManager::GetInstance().PopRunningInfo(taskInfo->taskId, taskInfo->executeId); } TaskManager::GetInstance().PopTaskInfo(taskInfo->executeId); Worker* worker = reinterpret_cast(taskInfo->worker); { std::lock_guard lock(worker->currentTaskIdMutex_); worker->currentTaskId_.erase(std::find(worker->currentTaskId_.begin(), worker->currentTaskId_.end(), taskInfo->taskId)); } uv_async_send(taskInfo->onResultSignal); worker->NotifyTaskFinished(); } void Worker::TaskResultCallback(NativeEngine* engine, NativeValue* result, bool success, void* data) { HITRACE_HELPER_METER_NAME(__PRETTY_FUNCTION__); if (engine == nullptr) { HILOG_FATAL("taskpool::TaskResultCallback engine is null"); return; } if (data == nullptr) { HILOG_FATAL("taskpool:: taskInfo is nullptr"); return; } TaskInfo* taskInfo = static_cast(data); auto env = reinterpret_cast(engine); taskInfo->success = success; NotifyTaskResult(env, taskInfo, reinterpret_cast(result)); } // reset qos_user_initiated after perform task void Worker::ResetWorkerPriority() { if (priority_ != Priority::HIGH) { SetWorkerPriority(Priority::HIGH); priority_ = Priority::HIGH; } } } // namespace Commonlibrary::Concurrent::TaskPoolModule