1 /*
2 * Copyright (c) 2021-2022 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 "native_async_work.h"
17
18 #ifdef ENABLE_HITRACE
19 #include "hitrace/trace.h"
20 #include "hitrace_meter.h"
21 #include "parameter.h"
22 #include <securec.h>
23 #endif
24 #ifdef ENABLE_CONTAINER_SCOPE
25 #include "core/common/container_scope.h"
26 #endif
27
28 #include "napi/native_api.h"
29 #include "native_engine.h"
30 #include "utils/log.h"
31
32 #ifdef ENABLE_CONTAINER_SCOPE
33 using OHOS::Ace::ContainerScope;
34 #endif
35
36 #ifdef ENABLE_HITRACE
37 bool g_napiTraceIdEnabled = false;
38 bool g_ParamUpdated = false;
39 constexpr size_t TRACE_BUFFER_SIZE = 120;
40 constexpr size_t TRACEID_PARAM_SIZE = 10;
41 #endif
42
NativeAsyncWork(NativeEngine * engine,NativeAsyncExecuteCallback execute,NativeAsyncCompleteCallback complete,const std::string & asyncResourceName,void * data)43 NativeAsyncWork::NativeAsyncWork(NativeEngine* engine,
44 NativeAsyncExecuteCallback execute,
45 NativeAsyncCompleteCallback complete,
46 const std::string &asyncResourceName,
47 void* data)
48 : work_({ 0 }), engine_(engine), execute_(execute), complete_(complete), data_(data)
49 {
50 work_.data = this;
51 (void)asyncResourceName;
52 #ifdef ENABLE_HITRACE
53 if (!g_ParamUpdated) {
54 char napiTraceIdEnabled[TRACEID_PARAM_SIZE] = {0};
55 int ret = GetParameter("persist.hiviewdfx.napitraceid.enabled", "false",
56 napiTraceIdEnabled, sizeof(napiTraceIdEnabled));
57 if (ret > 0 && strcmp(napiTraceIdEnabled, "true") == 0) {
58 g_napiTraceIdEnabled = true;
59 }
60 g_ParamUpdated = true;
61 }
62 bool createdTraceId = false;
63 traceId_ = std::make_unique<OHOS::HiviewDFX::HiTraceId>(OHOS::HiviewDFX::HiTraceChain::GetId());
64 if (g_napiTraceIdEnabled && (!traceId_ || !traceId_->IsValid())) {
65 traceId_ = std::make_unique<OHOS::HiviewDFX::HiTraceId>(
66 OHOS::HiviewDFX::HiTraceChain::Begin("New NativeAsyncWork", 0));
67 createdTraceId = true;
68 }
69 char traceStr[TRACE_BUFFER_SIZE] = {0};
70 if (sprintf_s(traceStr, sizeof(traceStr),
71 "name:%s, traceid:0x%x", asyncResourceName.c_str(), traceId_->GetChainId()) < 0) {
72 HILOG_ERROR("Get traceStr fail");
73 }
74 traceDescription_ = traceStr;
75 if (createdTraceId) {
76 OHOS::HiviewDFX::HiTraceChain::ClearId();
77 }
78 #endif
79 #ifdef ENABLE_CONTAINER_SCOPE
80 containerScopeId_ = ContainerScope::CurrentId();
81 #endif
82 }
83
84 NativeAsyncWork::~NativeAsyncWork() = default;
85
Queue()86 bool NativeAsyncWork::Queue()
87 {
88 uv_loop_t* loop = engine_->GetUVLoop();
89 if (loop == nullptr) {
90 HILOG_ERROR("Get loop failed");
91 return false;
92 }
93 #ifdef ENABLE_HITRACE
94 StartTrace(HITRACE_TAG_ACE, "Napi queue, " + this->GetTraceDescription());
95 #endif
96 int status = uv_queue_work(loop, &work_, AsyncWorkCallback, AsyncAfterWorkCallback);
97 #ifdef ENABLE_HITRACE
98 FinishTrace(HITRACE_TAG_ACE);
99 #endif
100 if (status != 0) {
101 HILOG_ERROR("uv_queue_work failed");
102 return false;
103 }
104 return true;
105 }
106
Cancel()107 bool NativeAsyncWork::Cancel()
108 {
109 int status = uv_cancel((uv_req_t*)&work_);
110 if (status != 0) {
111 HILOG_ERROR("uv_cancel failed");
112 return false;
113 }
114 return true;
115 }
116
AsyncWorkCallback(uv_work_t * req)117 void NativeAsyncWork::AsyncWorkCallback(uv_work_t* req)
118 {
119 if (req == nullptr) {
120 HILOG_ERROR("req is nullptr");
121 return;
122 }
123
124 auto that = reinterpret_cast<NativeAsyncWork*>(req->data);
125
126 #ifdef ENABLE_CONTAINER_SCOPE
127 ContainerScope containerScope(that->containerScopeId_);
128 #endif
129 #ifdef ENABLE_HITRACE
130 StartTrace(HITRACE_TAG_ACE, "Napi execute, " + that->GetTraceDescription());
131 if (that->traceId_ && that->traceId_->IsValid()) {
132 OHOS::HiviewDFX::HiTraceChain::SetId(*(that->traceId_.get()));
133 that->execute_(that->engine_, that->data_);
134 FinishTrace(HITRACE_TAG_ACE);
135 OHOS::HiviewDFX::HiTraceChain::ClearId();
136 return;
137 }
138 FinishTrace(HITRACE_TAG_ACE);
139 #endif
140 that->execute_(that->engine_, that->data_);
141 }
142
AsyncAfterWorkCallback(uv_work_t * req,int status)143 void NativeAsyncWork::AsyncAfterWorkCallback(uv_work_t* req, int status)
144 {
145 if (req == nullptr) {
146 HILOG_ERROR("req is nullptr");
147 return;
148 }
149
150 auto that = reinterpret_cast<NativeAsyncWork*>(req->data);
151
152 NativeScopeManager* scopeManager = that->engine_->GetScopeManager();
153 if (scopeManager == nullptr) {
154 HILOG_ERROR("Get scope manager failed");
155 return;
156 }
157
158 NativeScope* scope = scopeManager->Open();
159 if (scope == nullptr) {
160 HILOG_ERROR("Open scope failed");
161 return;
162 }
163
164 napi_status nstatus = napi_generic_failure;
165
166 switch (status) {
167 case 0:
168 nstatus = napi_ok;
169 break;
170 case (int)UV_EINVAL:
171 nstatus = napi_invalid_arg;
172 break;
173 case (int)UV_ECANCELED:
174 nstatus = napi_cancelled;
175 break;
176 default:
177 nstatus = napi_generic_failure;
178 }
179 #ifdef ENABLE_CONTAINER_SCOPE
180 ContainerScope containerScope(that->containerScopeId_);
181 #endif
182 #ifdef ENABLE_HITRACE
183 StartTrace(HITRACE_TAG_ACE, "Napi complete, " + that->GetTraceDescription());
184 if (that->traceId_ && that->traceId_->IsValid()) {
185 OHOS::HiviewDFX::HiTraceChain::SetId(*(that->traceId_.get()));
186 that->complete_(that->engine_, nstatus, that->data_);
187 FinishTrace(HITRACE_TAG_ACE);
188 OHOS::HiviewDFX::HiTraceChain::ClearId();
189 scopeManager->Close(scope);
190 return;
191 }
192 FinishTrace(HITRACE_TAG_ACE);
193 #endif
194 that->complete_(that->engine_, nstatus, that->data_);
195 scopeManager->Close(scope);
196 }
197
GetTraceDescription()198 std::string NativeAsyncWork::GetTraceDescription()
199 {
200 return traceDescription_;
201 }
202