1 /*
2 * Copyright (c) 2023 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16 #include "task_group.h"
17
18 #include "helper/error_helper.h"
19 #include "helper/napi_helper.h"
20 #include "helper/object_helper.h"
21 #include "napi/native_api.h"
22 #include "tools/log.h"
23
24 namespace Commonlibrary::Concurrent::TaskPoolModule {
25 using namespace Commonlibrary::Concurrent::Common::Helper;
26
TaskGroupConstructor(napi_env env,napi_callback_info cbinfo)27 napi_value TaskGroup::TaskGroupConstructor(napi_env env, napi_callback_info cbinfo)
28 {
29 size_t argc = 1;
30 napi_value args[1];
31 napi_value thisVar;
32 napi_get_cb_info(env, cbinfo, &argc, args, &thisVar, nullptr);
33 if (argc > 1) {
34 ErrorHelper::ThrowError(env, ErrorHelper::TYPE_ERROR,
35 "the number of params must be zero or one.");
36 return nullptr;
37 }
38 napi_value name;
39 if (argc == 1) {
40 // check 1st param is taskGroupName
41 if (!NapiHelper::IsString(env, args[0])) {
42 ErrorHelper::ThrowError(env, ErrorHelper::TYPE_ERROR,
43 "the first param must be string.");
44 return nullptr;
45 }
46 name = args[0];
47 } else {
48 name = NapiHelper::CreateEmptyString(env);
49 }
50 TaskGroup* group = new TaskGroup();
51 uint64_t groupId = reinterpret_cast<uint64_t>(group);
52 group->groupId_ = groupId;
53 TaskGroupManager::GetInstance().StoreTaskGroup(groupId, group);
54 napi_value napiGroupId = NapiHelper::CreateUint64(env, groupId);
55 napi_property_descriptor properties[] = {
56 DECLARE_NAPI_PROPERTY(GROUP_ID_STR, napiGroupId),
57 DECLARE_NAPI_FUNCTION_WITH_DATA("addTask", AddTask, thisVar),
58 };
59 napi_set_named_property(env, thisVar, NAME, name);
60 napi_define_properties(env, thisVar, sizeof(properties) / sizeof(properties[0]), properties);
61 napi_status status = napi_wrap(env, thisVar, group, TaskGroupDestructor, nullptr, nullptr);
62 if (status != napi_ok) {
63 HILOG_ERROR("taskpool::TaskGroupConstructor napi_wrap return value is %{public}d", status);
64 TaskGroupManager::GetInstance().RemoveTaskGroup(group->groupId_);
65 delete group;
66 group = nullptr;
67 return nullptr;
68 }
69 napi_create_reference(env, thisVar, 0, &group->groupRef_);
70 return thisVar;
71 }
72
TaskGroupDestructor(napi_env env,void * data,void * hint)73 void TaskGroup::TaskGroupDestructor(napi_env env, void* data, [[maybe_unused]] void* hint)
74 {
75 HILOG_DEBUG("taskpool::TaskGroupDestructor");
76 TaskGroup* group = static_cast<TaskGroup*>(data);
77 TaskGroupManager::GetInstance().ReleaseTaskGroupData(env, group);
78 napi_delete_reference(env, group->groupRef_);
79 delete group;
80 }
81
AddTask(napi_env env,napi_callback_info cbinfo)82 napi_value TaskGroup::AddTask(napi_env env, napi_callback_info cbinfo)
83 {
84 size_t argc = NapiHelper::GetCallbackInfoArgc(env, cbinfo);
85 std::string errMessage = "";
86 if (argc < 1) {
87 errMessage = "taskGroup:: the number of params must be at least one";
88 HILOG_ERROR("%{public}s", errMessage.c_str());
89 ErrorHelper::ThrowError(env, ErrorHelper::TYPE_ERROR,
90 "the number of params must be at least one.");
91 return nullptr;
92 }
93 napi_value* args = new napi_value[argc];
94 ObjectScope<napi_value> scope(args, true);
95 napi_value thisVar;
96 napi_get_cb_info(env, cbinfo, &argc, args, &thisVar, nullptr);
97 napi_value napiGroupId = NapiHelper::GetNameProperty(env, thisVar, GROUP_ID_STR);
98 uint64_t groupId = NapiHelper::GetUint64Value(env, napiGroupId);
99 TaskGroup* group = TaskGroupManager::GetInstance().GetTaskGroup(groupId);
100 if (group->groupState_ != ExecuteState::NOT_FOUND) {
101 errMessage = "taskpool:: executed taskGroup cannot addTask";
102 HILOG_ERROR("%{public}s", errMessage.c_str());
103 ErrorHelper::ThrowError(env, ErrorHelper::TYPE_ERROR, errMessage.c_str());
104 return nullptr;
105 }
106 napi_valuetype type = napi_undefined;
107 napi_typeof(env, args[0], &type);
108 if (type == napi_object) {
109 Task* task = nullptr;
110 napi_unwrap(env, args[0], reinterpret_cast<void**>(&task));
111 if (task == nullptr) {
112 ErrorHelper::ThrowError(env, ErrorHelper::TYPE_ERROR,
113 "the type of the params must be task.");
114 return nullptr;
115 }
116 if (!task->CanForTaskGroup(env)) {
117 return nullptr;
118 }
119 task->taskType_ = TaskType::GROUP_COMMON_TASK;
120 task->groupId_ = groupId;
121 napi_reference_ref(env, task->taskRef_, nullptr);
122 TaskGroupManager::GetInstance().AddTask(groupId, task->taskRef_, task->taskId_);
123 return nullptr;
124 } else if (type == napi_function) {
125 napi_value napiTask = NapiHelper::CreateObject(env);
126 Task* task = Task::GenerateFunctionTask(env, args[0], args + 1, argc - 1, TaskType::GROUP_FUNCTION_TASK);
127 if (task == nullptr) {
128 return nullptr;
129 }
130 task->groupId_ = groupId;
131 napi_status status = napi_wrap(env, napiTask, task, Task::TaskDestructor, nullptr, nullptr);
132 if (status != napi_ok) {
133 HILOG_ERROR("taskpool::AddTask napi_wrap return value is %{public}d", status);
134 delete task;
135 task = nullptr;
136 return nullptr;
137 }
138 TaskManager::GetInstance().StoreTask(task->taskId_, task);
139 napi_create_reference(env, napiTask, 1, &task->taskRef_);
140 TaskGroupManager::GetInstance().AddTask(groupId, task->taskRef_, task->taskId_);
141 return nullptr;
142 }
143 ErrorHelper::ThrowError(env, ErrorHelper::TYPE_ERROR,
144 "the type of the first param must be object or function.");
145 return nullptr;
146 }
147
GetTaskIndex(uint32_t taskId)148 uint32_t TaskGroup::GetTaskIndex(uint32_t taskId)
149 {
150 uint32_t index = 0;
151 for (uint32_t id : taskIds_) {
152 if (taskId == id) {
153 break;
154 }
155 index++;
156 }
157 return index;
158 }
159
NotifyGroupTask(napi_env env)160 void TaskGroup::NotifyGroupTask(napi_env env)
161 {
162 HILOG_DEBUG("taskpool:: NotifyGroupTask");
163 std::lock_guard<RECURSIVE_MUTEX> lock(taskGroupMutex_);
164 if (pendingGroupInfos_.empty()) {
165 return;
166 }
167 groupState_ = ExecuteState::WAITING;
168 currentGroupInfo_ = pendingGroupInfos_.front();
169 pendingGroupInfos_.pop_front();
170 for (auto iter = taskRefs_.begin(); iter != taskRefs_.end(); iter++) {
171 napi_value napiTask = NapiHelper::GetReferenceValue(env, *iter);
172 Task* task = nullptr;
173 napi_unwrap(env, napiTask, reinterpret_cast<void**>(&task));
174 if (task == nullptr) {
175 HILOG_ERROR("taskpool::ExecuteGroup task is nullptr");
176 return;
177 }
178 napi_reference_ref(env, task->taskRef_, nullptr);
179 Priority priority = currentGroupInfo_->priority;
180 if (task->IsGroupCommonTask()) {
181 task->GetTaskInfo(env, napiTask, priority);
182 } else {
183 reinterpret_cast<NativeEngine*>(env)->IncreaseSubEnvCounter();
184 }
185 task->IncreaseRefCount();
186 TaskManager::GetInstance().IncreaseRefCount(task->taskId_);
187 task->taskState_ = ExecuteState::WAITING;
188 TaskManager::GetInstance().EnqueueTaskId(task->taskId_, priority);
189 }
190 }
191
CancelPendingGroup(napi_env env)192 void TaskGroup::CancelPendingGroup(napi_env env)
193 {
194 HILOG_DEBUG("taskpool:: CancelPendingGroup");
195 if (pendingGroupInfos_.empty()) {
196 return;
197 }
198 napi_value error = ErrorHelper::NewError(env, 0, "taskpool:: taskGroup has been canceled");
199 auto pendingIter = pendingGroupInfos_.begin();
200 auto engine = reinterpret_cast<NativeEngine*>(env);
201 for (; pendingIter != pendingGroupInfos_.end(); ++pendingIter) {
202 for (size_t i = 0; i < taskIds_.size(); i++) {
203 engine->DecreaseSubEnvCounter();
204 }
205 GroupInfo* info = *pendingIter;
206 napi_reject_deferred(env, info->deferred, error);
207 napi_reference_unref(env, groupRef_, nullptr);
208 delete info;
209 }
210 pendingIter = pendingGroupInfos_.begin();
211 pendingGroupInfos_.erase(pendingIter, pendingGroupInfos_.end());
212 }
213
CancelGroupTask(napi_env env,uint64_t taskId)214 void TaskGroup::CancelGroupTask(napi_env env, uint64_t taskId)
215 {
216 TaskGroupManager::GetInstance().CancelGroupTask(env, taskId, this);
217 if (currentGroupInfo_ != nullptr && currentGroupInfo_->finishedTaskNum == taskNum_) {
218 napi_value error = ErrorHelper::NewError(env, 0, "taskpool:: taskGroup has been canceled");
219 RejectResult(env, error);
220 }
221 }
222
RejectResult(napi_env env,napi_value res)223 void TaskGroup::RejectResult(napi_env env, napi_value res)
224 {
225 napi_reject_deferred(env, currentGroupInfo_->deferred, res);
226 napi_delete_reference(env, currentGroupInfo_->resArr);
227 napi_reference_unref(env, groupRef_, nullptr);
228 delete currentGroupInfo_;
229 currentGroupInfo_ = nullptr;
230 }
231 } // namespace Commonlibrary::Concurrent::TaskPoolModule