* Copyright (c) 2021 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 "ecmascript/tests/test_helper.h"
#include "ecmascript/ecma_vm.h"
#include "ecmascript/global_env.h"
#include "ecmascript/js_handle.h"
#include "ecmascript/js_hclass.h"
#include "ecmascript/js_thread.h"
#include "ecmascript/jspandafile/program_object.h"
#include "ecmascript/object_factory.h"
#include "ecmascript/snapshot/mem/snapshot.h"
#include "ecmascript/snapshot/mem/snapshot_processor.h"
#include "ecmascript/snapshot/tests/snapshot_mock.h"
using namespace panda::ecmascript;
namespace panda::test {
class SnapshotTest : public testing::Test {
public:
static void SetUpTestCase()
{
GTEST_LOG_(INFO) << "SetUpTestCase";
}
static void TearDownTestCase()
{
GTEST_LOG_(INFO) << "TearDownCase";
}
void SetUp() override
{
JSRuntimeOptions options;
ecmaVm = JSNApi::CreateEcmaVM(options);
ASSERT_TRUE(ecmaVm != nullptr) << "Cannot create EcmaVM";
thread = ecmaVm->GetJSThread();
thread->ManagedCodeBegin();
scope = new EcmaHandleScope(thread);
}
void TearDown() override
{
thread->ManagedCodeEnd();
delete scope;
scope = nullptr;
ecmaVm->SetEnableForceGC(false);
thread->ClearException();
JSNApi::DestroyJSVM(ecmaVm);
}
void CompatibilityHelper(base::FileHeaderBase::VersionType serializeVersion,
base::FileHeaderBase::VersionType deserializeVersion, bool expected)
{
static constexpr uint32_t ARRAY_SIZE = 300;
static constexpr uint32_t KILO_BITS = 1024;
auto factory = ecmaVm->GetFactory();
auto env = ecmaVm->GetGlobalEnv();
JSHandle<TaggedArray> array1 = factory->NewTaggedArray(ARRAY_SIZE * KILO_BITS / sizeof(uint8_t));
JSHandle<JSFunction> funcFunc(env->GetFunctionFunction());
array1->Set(thread, 0, funcFunc.GetTaggedValue());
CString fileName = "snapshot";
SnapshotMock snapshotSerialize(ecmaVm);
snapshotSerialize.SetLastVersion(serializeVersion);
snapshotSerialize.Serialize(*array1, nullptr, fileName);
std::thread t1([&]() {
JSRuntimeOptions options;
EcmaVM *ecmaVm2 = JSNApi::CreateEcmaVM(options);
{
ThreadManagedScope scope(ecmaVm2->GetJSThread());
SnapshotMock snapshotDeserialize(ecmaVm2);
snapshotDeserialize.SetLastVersion(deserializeVersion);
EXPECT_EQ(snapshotDeserialize.Deserialize(SnapshotType::VM_ROOT, fileName), expected);
}
JSNApi::DestroyJSVM(ecmaVm2);
});
{
ecmascript::ThreadSuspensionScope suspensionScope(thread);
t1.join();
}
std::remove(fileName.c_str());
}
EcmaVM *ecmaVm {nullptr};
ecmascript::EcmaHandleScope *scope {nullptr};
JSThread *thread {nullptr};
};
HWTEST_F_L0(SnapshotTest, SerializeConstPool)
{
auto factory = ecmaVm->GetFactory();
auto env = ecmaVm->GetGlobalEnv();
JSHandle<ConstantPool> constpool = factory->NewConstantPool(10);
JSHandle<JSFunction> funcFunc(env->GetFunctionFunction());
JSHandle<JSFunction> dateFunc(env->GetDateFunction());
JSHandle<JSFunction> numberFunc(env->GetNumberFunction());
JSHandle<EcmaString> str1 = factory->NewFromASCII("str11");
JSHandle<EcmaString> str2 = factory->NewFromASCII("str22");
JSHandle<EcmaString> str3 = factory->NewFromASCII("str333333333333");
JSHandle<EcmaString> str4 = factory->ConcatFromString(str1, str3);
JSHandle<EcmaString> str5 = factory->NewFromASCII("str44");
constpool->SetObjectToCache(thread, 0, funcFunc.GetTaggedValue());
constpool->SetObjectToCache(thread, 1, dateFunc.GetTaggedValue());
constpool->SetObjectToCache(thread, 2, str1.GetTaggedValue());
constpool->SetObjectToCache(thread, 3, numberFunc.GetTaggedValue());
constpool->SetObjectToCache(thread, 4, str2.GetTaggedValue());
constpool->SetObjectToCache(thread, 5, str1.GetTaggedValue());
constpool->SetObjectToCache(thread, 6, str3.GetTaggedValue());
constpool->SetObjectToCache(thread, 7, str4.GetTaggedValue());
constpool->SetObjectToCache(thread, 8, str4.GetTaggedValue());
constpool->SetObjectToCache(thread, 9, str5.GetTaggedValue());
CString fileName = "snapshot";
Snapshot snapshotSerialize(ecmaVm);
snapshotSerialize.Serialize(*constpool, nullptr, fileName);
Snapshot snapshotDeserialize(ecmaVm);
snapshotDeserialize.Deserialize(SnapshotType::VM_ROOT, fileName);
ConstantPool *constpool1;
if (g_isEnableCMCGC || G_USE_CMS_GC) {
constpool1 = ConstantPool::Cast(snapshotDeserialize.GetDeserializeResultForUT().GetTaggedObject());
} else {
auto beginRegion = const_cast<Heap *>(ecmaVm->GetHeap())->GetOldSpace()->GetCurrentRegion();
constpool1 = reinterpret_cast<ConstantPool *>(beginRegion->GetBegin());
}
EXPECT_EQ((*constpool)->GetSize(),
constpool1->GetSize());
EXPECT_TRUE(constpool1->GetObjectFromCache(thread, 0).IsJSFunction());
EXPECT_TRUE(constpool1->GetObjectFromCache(thread, 1).IsJSFunction());
EXPECT_TRUE(constpool1->GetObjectFromCache(thread, 3).IsJSFunction());
EcmaString *str11 = reinterpret_cast<EcmaString *>(constpool1->Get(thread, 2).GetTaggedObject());
EcmaString *str22 = reinterpret_cast<EcmaString *>(constpool1->Get(thread, 4).GetTaggedObject());
EcmaString *str33 = reinterpret_cast<EcmaString *>(constpool1->Get(thread, 5).GetTaggedObject());
EcmaString *str44 = reinterpret_cast<EcmaString *>(constpool1->Get(thread, 6).GetTaggedObject());
EcmaString *str55 = reinterpret_cast<EcmaString *>(constpool1->Get(thread, 7).GetTaggedObject());
EcmaString *str66 = reinterpret_cast<EcmaString *>(constpool1->Get(thread, 8).GetTaggedObject());
EcmaString *str77 = reinterpret_cast<EcmaString *>(constpool1->Get(thread, 9).GetTaggedObject());
EXPECT_EQ(std::strcmp(EcmaStringAccessor(str11).ToCString(thread).c_str(), "str11"), 0);
EXPECT_EQ(std::strcmp(EcmaStringAccessor(str22).ToCString(thread).c_str(), "str22"), 0);
EXPECT_EQ(std::strcmp(EcmaStringAccessor(str33).ToCString(thread).c_str(), "str11"), 0);
EXPECT_EQ(std::strcmp(EcmaStringAccessor(str44).ToCString(thread).c_str(), "str333333333333"), 0);
EXPECT_EQ(std::strcmp(EcmaStringAccessor(str55).ToCString(thread).c_str(), "str11str333333333333"), 0);
EXPECT_EQ(std::strcmp(EcmaStringAccessor(str66).ToCString(thread).c_str(), "str11str333333333333"), 0);
EXPECT_EQ(std::strcmp(EcmaStringAccessor(str77).ToCString(thread).c_str(), "str44"), 0);
std::remove(fileName.c_str());
}
HWTEST_F_L0(SnapshotTest, SerializeDifferentSpace)
{
auto factory = ecmaVm->GetFactory();
JSHandle<ConstantPool> constpool = factory->NewConstantPool(400);
for (int i = 0; i < 100; i++) {
JSHandle<TaggedArray> array = factory->NewTaggedArray(10, JSTaggedValue::Hole(), MemSpaceType::SEMI_SPACE);
constpool->SetObjectToCache(thread, i, array.GetTaggedValue());
}
for (int i = 0; i < 100; i++) {
JSHandle<TaggedArray> array = factory->NewTaggedArray(10, JSTaggedValue::Hole(), MemSpaceType::OLD_SPACE);
constpool->SetObjectToCache(thread, i + 100, array.GetTaggedValue());
}
for (int i = 0; i < 100; i++) {
JSHandle<ConstantPool> constpool1 = factory->NewConstantPool(10);
constpool->SetObjectToCache(thread, i + 300, constpool1.GetTaggedValue());
}
CString fileName = "snapshot";
Snapshot snapshotSerialize(ecmaVm);
snapshotSerialize.Serialize(*constpool, nullptr, fileName);
Snapshot snapshotDeserialize(ecmaVm);
snapshotDeserialize.Deserialize(SnapshotType::VM_ROOT, fileName);
ConstantPool *constpool1;
if (g_isEnableCMCGC || G_USE_CMS_GC) {
constpool1 = ConstantPool::Cast(snapshotDeserialize.GetDeserializeResultForUT().GetTaggedObject());
} else {
auto beginRegion = const_cast<Heap *>(ecmaVm->GetHeap())->GetOldSpace()->GetCurrentRegion();
constpool1 = reinterpret_cast<ConstantPool *>(beginRegion->GetBegin());
}
EXPECT_EQ((*constpool)->GetSize(),
constpool1->GetSize());
EXPECT_TRUE(constpool1->GetObjectFromCache(thread, 0).IsTaggedArray());
EXPECT_TRUE(constpool1->GetObjectFromCache(thread, 100).IsTaggedArray());
EXPECT_TRUE(constpool1->GetObjectFromCache(thread, 300).IsTaggedArray());
if (G_USE_CMS_GC) {
auto obj1 = constpool1->GetObjectFromCache(thread, 0).GetTaggedObject();
EXPECT_TRUE(Region::ObjectAddressToRange(obj1)->InSlotSpace());
auto obj2 = constpool1->GetObjectFromCache(thread, 100).GetTaggedObject();
EXPECT_TRUE(Region::ObjectAddressToRange(obj2)->InSlotSpace());
} else if (!g_isEnableCMCGC) {
auto obj1 = constpool1->GetObjectFromCache(thread, 0).GetTaggedObject();
EXPECT_TRUE(Region::ObjectAddressToRange(obj1)->InOldSpace());
auto obj2 = constpool1->GetObjectFromCache(thread, 100).GetTaggedObject();
EXPECT_TRUE(Region::ObjectAddressToRange(obj2)->InOldSpace());
}
std::remove(fileName.c_str());
}
HWTEST_F_L0(SnapshotTest, SerializeMultiFile)
{
auto factory = ecmaVm->GetFactory();
JSHandle<ConstantPool> constpool1 = factory->NewConstantPool(400);
JSHandle<ConstantPool> constpool2 = factory->NewConstantPool(400);
for (int i = 0; i < 100; i++) {
JSHandle<TaggedArray> array = factory->NewTaggedArray(10, JSTaggedValue::Hole(), MemSpaceType::SEMI_SPACE);
constpool1->SetObjectToCache(thread, i, array.GetTaggedValue());
constpool2->SetObjectToCache(thread, i, array.GetTaggedValue());
}
for (int i = 0; i < 100; i++) {
JSHandle<TaggedArray> array = factory->NewTaggedArray(10, JSTaggedValue::Hole(), MemSpaceType::OLD_SPACE);
constpool1->SetObjectToCache(thread, i + 100, array.GetTaggedValue());
constpool2->SetObjectToCache(thread, i + 100, array.GetTaggedValue());
}
for (int i = 0; i < 100; i++) {
JSHandle<ConstantPool> constpool3 = factory->NewConstantPool(10);
constpool1->SetObjectToCache(thread, i + 300, constpool3.GetTaggedValue());
constpool2->SetObjectToCache(thread, i + 300, constpool3.GetTaggedValue());
}
CString fileName1 = "snapshot1";
CString fileName2 = "snapshot2";
Snapshot snapshotSerialize(ecmaVm);
snapshotSerialize.Serialize(*constpool1, nullptr, fileName1);
snapshotSerialize.Serialize(*constpool2, nullptr, fileName2);
Snapshot snapshotDeserialize(ecmaVm);
snapshotDeserialize.Deserialize(SnapshotType::VM_ROOT, fileName1);
snapshotDeserialize.Deserialize(SnapshotType::VM_ROOT, fileName2);
ConstantPool *constpool;
if (g_isEnableCMCGC || G_USE_CMS_GC) {
constpool = ConstantPool::Cast(snapshotDeserialize.GetDeserializeResultForUT().GetTaggedObject());
} else{
auto beginRegion = const_cast<Heap *>(ecmaVm->GetHeap())->GetOldSpace()->GetCurrentRegion();
constpool = reinterpret_cast<ConstantPool *>(beginRegion->GetBegin());
}
EXPECT_TRUE(constpool->GetObjectFromCache(thread, 0).IsTaggedArray());
EXPECT_TRUE(constpool->GetObjectFromCache(thread, 100).IsTaggedArray());
if (G_USE_CMS_GC) {
auto obj1 = constpool->GetObjectFromCache(thread, 0).GetTaggedObject();
EXPECT_TRUE(Region::ObjectAddressToRange(obj1)->InSlotSpace());
auto obj2 = constpool->GetObjectFromCache(thread, 100).GetTaggedObject();
EXPECT_TRUE(Region::ObjectAddressToRange(obj2)->InSlotSpace());
} else if (!g_isEnableCMCGC) {
auto obj1 = constpool->GetObjectFromCache(thread, 0).GetTaggedObject();
EXPECT_TRUE(Region::ObjectAddressToRange(obj1)->InOldSpace());
auto obj2 = constpool->GetObjectFromCache(thread, 100).GetTaggedObject();
EXPECT_TRUE(Region::ObjectAddressToRange(obj2)->InOldSpace());
}
std::remove(fileName1.c_str());
std::remove(fileName2.c_str());
}
HWTEST_F_L0(SnapshotTest, SerializeBuiltins)
{
CString fileName = "builtins.snapshot";
std::remove(fileName.c_str());
std::thread t1([]() {
JSRuntimeOptions options1;
options1.SetArkProperties(ArkProperties::ENABLE_SNAPSHOT_SERIALIZE);
EcmaVM *ecmaVm1 = JSNApi::CreateEcmaVM(options1);
JSNApi::DestroyJSVM(ecmaVm1);
});
{
ecmascript::ThreadSuspensionScope suspensionScope(thread);
t1.join();
}
std::thread t2([&]() {
JSRuntimeOptions options2;
options2.SetArkProperties(ArkProperties::ENABLE_SNAPSHOT_DESERIALIZE);
EcmaVM *ecmaVm2 = JSNApi::CreateEcmaVM(options2);
EXPECT_TRUE(ecmaVm2->GetGlobalEnv()->GetClass()->GetObjectType() == JSType::GLOBAL_ENV);
class TestRootVisitor final : public RootVisitor {
public:
TestRootVisitor() = default;
~TestRootVisitor() = default;
void VisitRoot([[maybe_unused]] Root type, [[maybe_unused]] ObjectSlot slot) override {}
void VisitRangeRoot([[maybe_unused]] Root type, ObjectSlot start, ObjectSlot end) override
{
size_t sharedBeginHclassIndex = static_cast<size_t>(ConstantIndex::SHARED_HCLASS_BEGIN);
size_t sharedHclassEndIndex = static_cast<size_t>(ConstantIndex::SHARED_HCLASS_END);
size_t hclassBeginIndex = static_cast<size_t>(ConstantIndex::NON_SHARED_HCLASS_BEGIN);
size_t hclassEndIndex = static_cast<size_t>(ConstantIndex::NON_SHARED_HCLASS_END);
size_t index = 0U;
while (start < end) {
JSTaggedValue object(start.GetTaggedType());
if ((index >= sharedBeginHclassIndex && index <= sharedHclassEndIndex) ||
(index >= hclassBeginIndex && index <= hclassEndIndex)) {
EXPECT_TRUE(object.IsJSHClass());
}
start++;
index++;
}
}
void VisitBaseAndDerivedRoot([[maybe_unused]] Root type, [[maybe_unused]] ObjectSlot base,
[[maybe_unused]] ObjectSlot derived, [[maybe_unused]] uintptr_t baseOldObject) override {}
};
TestRootVisitor testRootVisitor;
auto globalConst = const_cast<GlobalEnvConstants *>(ecmaVm2->GetJSThread()->GlobalConstants());
globalConst->Iterate(testRootVisitor);
JSNApi::DestroyJSVM(ecmaVm2);
});
{
ecmascript::ThreadSuspensionScope suspensionScope(thread);
t2.join();
}
std::remove(fileName.c_str());
}
HWTEST_F_L0(SnapshotTest, SerializeHugeObject)
{
auto factory = ecmaVm->GetFactory();
auto env = ecmaVm->GetGlobalEnv();
JSHandle<TaggedArray> array1 = factory->NewTaggedArray(300 * 1024 / 8);
JSHandle<TaggedArray> array2 = factory->NewTaggedArray(300 * 1024 / 8);
JSHandle<TaggedArray> array3 = factory->NewTaggedArray(100);
JSHandle<JSFunction> funcFunc(env->GetFunctionFunction());
JSHandle<JSFunction> dateFunc(env->GetDateFunction());
JSHandle<JSFunction> numberFunc(env->GetNumberFunction());
array1->Set(thread, 0, array2.GetTaggedValue());
array1->Set(thread, 1, funcFunc.GetTaggedValue());
array1->Set(thread, 2, dateFunc.GetTaggedValue());
array1->Set(thread, 3, numberFunc.GetTaggedValue());
array2->Set(thread, 0, array3.GetTaggedValue());
array2->Set(thread, 1, funcFunc.GetTaggedValue());
array2->Set(thread, 2, dateFunc.GetTaggedValue());
array2->Set(thread, 3, numberFunc.GetTaggedValue());
CString fileName = "snapshot";
Snapshot snapshotSerialize(ecmaVm);
snapshotSerialize.Serialize(*array1, nullptr, fileName);
Snapshot snapshotDeserialize(ecmaVm);
snapshotDeserialize.Deserialize(SnapshotType::VM_ROOT, fileName);
TaggedArray *array4;
if (g_isEnableCMCGC || G_USE_CMS_GC) {
array4 = TaggedArray::Cast(snapshotDeserialize.GetDeserializeResultForUT().GetTaggedObject());
} else {
auto lastRegion = const_cast<Heap *>(ecmaVm->GetHeap())->GetHugeObjectSpace()->GetCurrentRegion();
array4 = reinterpret_cast<TaggedArray *>(lastRegion->GetBegin());
}
EXPECT_TRUE(array4->Get(thread, 0).IsTaggedArray());
EXPECT_TRUE(array4->Get(thread, 1).IsJSFunction());
EXPECT_TRUE(array4->Get(thread, 2).IsJSFunction());
EXPECT_TRUE(array4->Get(thread, 3).IsJSFunction());
std::remove(fileName.c_str());
}
HWTEST_F_L0(SnapshotTest, SerializeObject)
{
auto factory = ecmaVm->GetFactory();
JSHandle<JSTaggedValue> prototype(thread, JSTaggedValue::Undefined());
JSHandle<JSHClass> hclass = factory->NewEcmaHClass(JSObject::SIZE, JSType::JS_OBJECT, prototype);
JSHandle<JSObject> obj = factory->NewJSObject(hclass);
CString fileName = "snapshot";
Snapshot snapshotSerialize(ecmaVm);
snapshotSerialize.Serialize(*obj, nullptr, fileName);
Snapshot snapshotDeserialize(ecmaVm);
snapshotDeserialize.Deserialize(SnapshotType::VM_ROOT, fileName);
}
HWTEST_F_L0(SnapshotTest, BackwardCompatibility)
{
base::FileHeaderBase::VersionType oldVersion = {0, 0, 0, 1};
base::FileHeaderBase::VersionType newVersion = {4, 0, 0, 1};
CompatibilityHelper(oldVersion, newVersion, false);
}
HWTEST_F_L0(SnapshotTest, ForwardCompatibility)
{
base::FileHeaderBase::VersionType oldVersion = {0, 0, 0, 1};
base::FileHeaderBase::VersionType newVersion = {4, 0, 0, 1};
CompatibilityHelper(newVersion, oldVersion, false);
}
HWTEST_F_L0(SnapshotTest, StrictCompatibility)
{
base::FileHeaderBase::VersionType newVersion = {4, 0, 0, 1};
CompatibilityHelper(newVersion, newVersion, true);
}
HWTEST_F_L0(SnapshotTest, VersionTest)
{
base::FileHeaderBase::VersionType version = {4, 3, 2, 1};
uint32_t versionNumber = 0x04030201U;
EXPECT_EQ(version, base::FileHeaderBase::ToVersion(versionNumber));
EXPECT_EQ(versionNumber, base::FileHeaderBase::ToVersionNumber(version));
}
}