1 /**
2 * Copyright (c) 2025 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 <cstring>
17 #include "plugins/ets/runtime/interop_js/ets_proxy/shared_reference_storage.h"
18 #include "plugins/ets/runtime/interop_js/ets_proxy/shared_reference_storage_verifier.h"
19 #include "plugins/ets/runtime/interop_js/interop_context.h"
20
21 namespace ark::ets::interop::js::ets_proxy {
22
23 #define LOG_REF_VERIFIER LOG(ERROR, ETS_INTEROP_JS) << "REF_VERIFIER: "
24
IsJsObjectAlive(const SharedReference * ref)25 ALWAYS_INLINE static bool IsJsObjectAlive([[maybe_unused]] const SharedReference *ref)
26 {
27 bool result = false;
28 #ifdef PANDA_JS_ETS_HYBRID_MODE
29 napi_is_alive_object(ref->GetCtx()->GetJSEnv(), ref->GetJsRef(), &result);
30 #endif // PANDA_JS_ETS_HYBRID_MODE
31 return result;
32 }
33
JsObjectContainObject(const SharedReference * ref)34 ALWAYS_INLINE static bool JsObjectContainObject([[maybe_unused]] const SharedReference *ref)
35 {
36 bool result = false;
37 #ifdef PANDA_JS_ETS_HYBRID_MODE
38 napi_is_contain_object(ref->GetCtx()->GetJSEnv(), ref->GetJsRef(), &result);
39 #endif // PANDA_JS_ETS_HYBRID_MODE
40 return result;
41 }
42
IsJsXrefObjectType(const SharedReference * ref,napi_value jsObject)43 ALWAYS_INLINE static bool IsJsXrefObjectType([[maybe_unused]] const SharedReference *ref,
44 [[maybe_unused]] napi_value jsObject)
45 {
46 bool result = false;
47 #ifdef PANDA_JS_ETS_HYBRID_MODE
48 napi_is_xref_type(ref->GetCtx()->GetJSEnv(), jsObject, &result);
49 #endif // PANDA_JS_ETS_HYBRID_MODE
50 return result;
51 }
52
TraverseAllItems(const SharedReferenceStorage * const storage,XgcStatus status)53 size_t SharedReferenceStorageVerifier::TraverseAllItems(const SharedReferenceStorage *const storage, XgcStatus status)
54 {
55 size_t capacity = storage->Capacity();
56 size_t failCount = 0;
57 for (size_t index = 1U; index < capacity; ++index) {
58 failCount += VerifyOneItem(storage, index, status);
59 }
60 LOG_IF(failCount > 0, ERROR, ETS_INTEROP_JS) << "REF_VERIFIER: Shared reference verify total fails: " << failCount;
61 return failCount;
62 }
63
VerifyOneItem(const SharedReferenceStorage * const storage,size_t index,XgcStatus status)64 size_t SharedReferenceStorageVerifier::VerifyOneItem(const SharedReferenceStorage *const storage, size_t index,
65 XgcStatus status)
66 {
67 size_t failCount = 0;
68 const SharedReference *item = storage->GetItemByIndex(index);
69 if (item->IsEmpty()) {
70 LOG_REF_VERIFIER << "Shared references is empty object at " << index << ", capacity is" << storage->Capacity();
71 return failCount;
72 }
73 failCount = CheckObjectAlive(item, index);
74 failCount += CheckObjectReindex(storage, item, index);
75 failCount += CheckObjectAddressValid(item, index);
76 failCount += CheckJsObjectType(item, index);
77 if (status == XgcStatus::XGC_FINISHED) {
78 failCount += IsAllItemsMarked(item, index);
79 }
80 return static_cast<size_t>(failCount != 0U);
81 }
82
CheckObjectAlive(const SharedReference * item,size_t index)83 size_t SharedReferenceStorageVerifier::CheckObjectAlive(const SharedReference *item, size_t index)
84 {
85 size_t failCount = CheckJsObjectAlive(item, index);
86 failCount += CheckJEtsObjectAlive(item, index);
87 return failCount;
88 }
89
CheckJEtsObjectAlive(const SharedReference * item,size_t index)90 size_t SharedReferenceStorageVerifier::CheckJEtsObjectAlive(const SharedReference *item, size_t index)
91 {
92 size_t failCount = 0;
93 ObjectHeader *obj = item->GetEtsObject()->GetCoreType();
94 if (item->GetCtx()->GetPandaEtsVM()->GetHeapManager()->IsLiveObject(obj)) {
95 LOG_REF_VERIFIER << "Shared reference corruption found! ETS object address does not alive at " << std::hex
96 << item << "," << index;
97 failCount++;
98 }
99 return failCount;
100 }
101
CheckJsObjectAlive(const SharedReference * item,size_t index)102 size_t SharedReferenceStorageVerifier::CheckJsObjectAlive(const SharedReference *item, size_t index)
103 {
104 size_t failCount = 0;
105 if (!IsJsObjectAlive(item)) {
106 LOG_REF_VERIFIER << "Shared Reference corruption found! JS object address does not alive at " << std::hex
107 << item << "," << index;
108 failCount++;
109 }
110 return failCount;
111 }
112
CheckObjectReindex(const SharedReferenceStorage * const storage,const SharedReference * item,size_t index)113 size_t SharedReferenceStorageVerifier::CheckObjectReindex(const SharedReferenceStorage *const storage,
114 const SharedReference *item, size_t index)
115 {
116 size_t failCount = 0;
117 if (!item->HasETSFlag() && item->HasJSFlag()) {
118 failCount += CheckJsObjectReindex(storage, item, index);
119 }
120 failCount += CheckEtsObjectReindex(item, index);
121 return failCount;
122 }
123
CheckJsObjectReindex(const SharedReferenceStorage * const storage,const SharedReference * item,size_t index)124 size_t SharedReferenceStorageVerifier::CheckJsObjectReindex(const SharedReferenceStorage *const storage,
125 const SharedReference *item, size_t index)
126 {
127 size_t failCount = 0;
128 napi_value result = nullptr;
129 #ifdef PANDA_JS_ETS_HYBRID_MODE
130 napi_get_reference_value(const_cast<InteropCtx *>(item->GetCtx())->GetJSEnv(), item->GetJsRef(), &result);
131 #endif
132 if (item != storage->GetReference(const_cast<InteropCtx *>(item->GetCtx())->GetJSEnv(), result)) {
133 LOG_REF_VERIFIER << "Shared Reference corruption found! JS object address cannot reindex at " << std::hex
134 << item << "," << index;
135 failCount++;
136 }
137 return failCount;
138 }
139
CheckEtsObjectReindex(const SharedReference * item,size_t index)140 size_t SharedReferenceStorageVerifier::CheckEtsObjectReindex(const SharedReference *item, size_t index)
141 {
142 size_t failCount = 0;
143 int32_t idx = item->GetEtsObject()->GetInteropIndex();
144 if (const_cast<InteropCtx *>(item->GetCtx())->GetSharedRefStorage()->GetItemByIndex(idx) != item) {
145 LOG_REF_VERIFIER << "Shared Reference corruption found! Ets object address cannot reindex at " << std::hex
146 << item << "," << index;
147 failCount++;
148 }
149 return failCount;
150 }
151
CheckObjectAddressValid(const SharedReference * item,size_t index)152 size_t SharedReferenceStorageVerifier::CheckObjectAddressValid(const SharedReference *item, size_t index)
153 {
154 size_t failCount = CheckJsObjectAddress(item, index);
155 failCount += CheckEtsObjectAddress(item, index);
156 return failCount;
157 }
158
CheckJsObjectAddress(const SharedReference * item,size_t index)159 size_t SharedReferenceStorageVerifier::CheckJsObjectAddress(const SharedReference *item, size_t index)
160 {
161 size_t failCount = 0;
162 if (!JsObjectContainObject(item)) {
163 LOG_REF_VERIFIER << "Shared Reference corruption found! Js object address is invalid at " << std::hex << item
164 << "," << index;
165 failCount++;
166 }
167 return failCount;
168 }
169
CheckEtsObjectAddress(const SharedReference * item,size_t index)170 size_t SharedReferenceStorageVerifier::CheckEtsObjectAddress(const SharedReference *item, size_t index)
171 {
172 size_t failCount = 0;
173 ObjectHeader *obj = item->GetEtsObject()->GetCoreType();
174 if (!const_cast<InteropCtx *>(item->GetCtx())->GetPandaEtsVM()->GetHeapManager()->ContainObject(obj)) {
175 LOG_REF_VERIFIER << "Shared Reference corruption found! Ets object address is invalid at " << std::hex << item
176 << "," << index;
177 failCount++;
178 }
179 return failCount;
180 }
181
CheckJsObjectType(const SharedReference * item,size_t index)182 size_t SharedReferenceStorageVerifier::CheckJsObjectType(const SharedReference *item, size_t index)
183 {
184 size_t failCount = 0;
185 if (!CheckJsObjectTypeIsJsXref(item)) {
186 LOG_REF_VERIFIER << "Shared Reference corruption found! Js Type is not JSType::JS_XREF_OBJECT at " << std::hex
187 << item << "," << index;
188 failCount++;
189 }
190 if (CheckJsObjectTypeIsJsXref(item)) {
191 LOG_REF_VERIFIER << "Shared Reference corruption found! Js Type is not JSType::JS_XREF_OBJECT at " << std::hex
192 << item << "," << index;
193 failCount++;
194 }
195 return failCount;
196 }
197
CheckJsObjectTypeIsJsXref(const SharedReference * item)198 bool SharedReferenceStorageVerifier::CheckJsObjectTypeIsJsXref(const SharedReference *item)
199 {
200 napi_value jsObject = nullptr;
201 napi_get_reference_value(const_cast<InteropCtx *>(item->GetCtx())->GetJSEnv(), item->GetJsRef(), &jsObject);
202 return IsJsXrefObjectType(item, jsObject);
203 }
204
IsAllItemsMarked(const SharedReference * item,size_t index)205 size_t SharedReferenceStorageVerifier::IsAllItemsMarked(const SharedReference *item, size_t index)
206 {
207 size_t failCount = 0;
208 if (!item->IsMarked()) {
209 failCount++;
210 LOG_REF_VERIFIER << "Shared Reference corruption found! Xgc finished but not marked at " << std::hex << item
211 << "," << index;
212 }
213 return failCount;
214 }
215 } // namespace ark::ets::interop::js::ets_proxy