xref: /arkcompiler/ets_runtime/ecmascript/snapshot/mem/snapshot_processor.h

/*
 * Copyright (c) 2021-2024 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.
 */

#ifndef ECMASCRIPT_SNAPSHOT_MEM_SNAPSHOT_PROCESSOR_H
#define ECMASCRIPT_SNAPSHOT_MEM_SNAPSHOT_PROCESSOR_H

#include <iostream>
#include <fstream>
#include <sstream>

#include "ecmascript/snapshot/mem/encode_bit.h"
#include "ecmascript/jspandafile/method_literal.h"
#include "ecmascript/js_tagged_value.h"
#include "ecmascript/mem/object_xray.h"

#include "libpandabase/macros.h"

namespace panda::ecmascript {
class EcmaVM;
class JSPandaFile;
class AOTFileManager;

enum class SnapshotType {
    VM_ROOT,
    BUILTINS,
    AI
};

struct SnapshotRegionHeadInfo {
    uint32_t regionIndex_ {0};
    uint32_t aliveObjectSize_ {0};

    static constexpr size_t RegionHeadInfoSize()
    {
        return sizeof(SnapshotRegionHeadInfo);
    }
};

using ObjectEncode = std::pair<uint64_t, ecmascript::EncodeBit>;

class SnapshotProcessor final {
public:
    explicit SnapshotProcessor(EcmaVM *vm)
        : vm_(vm), sHeap_(SharedHeap::GetInstance()) {}
    ~SnapshotProcessor();

    void Initialize();
    void StopAllocate();
    void WriteObjectToFile(std::fstream &write);
    std::vector<uint32_t> StatisticsObjectSize();
    void ProcessObjectQueue(CQueue<TaggedObject *> *queue, std::unordered_map<uint64_t, ObjectEncode> *data);
    void SerializeObject(TaggedObject *objectHeader, CQueue<TaggedObject *> *queue,
                         std::unordered_map<uint64_t, ObjectEncode> *data);
    void Relocate(SnapshotType type, const JSPandaFile *jsPandaFile,
                  uint64_t rootObjSize);
    void RelocateSpaceObject(const JSPandaFile *jsPandaFile, Space* space, SnapshotType type, MethodLiteral* methods,
                             size_t methodNums, size_t rootObjSize);
    void SerializePandaFileMethod();
    uintptr_t GetNewObj(size_t objectSize, TaggedObject *objectHeader);
    EncodeBit EncodeTaggedObject(TaggedObject *objectHeader, CQueue<TaggedObject *> *queue,
                                 std::unordered_map<uint64_t, ObjectEncode> *data);
    EncodeBit GetObjectEncode(JSTaggedValue object, CQueue<TaggedObject *> *queue,
                              std::unordered_map<uint64_t, ObjectEncode> *data);
    void EncodeTaggedObjectRange(ObjectSlot start, ObjectSlot end, CQueue<TaggedObject *> *queue,
                                 std::unordered_map<uint64_t, ObjectEncode> *data);
    void DeserializeObjectExcludeString(uintptr_t oldSpaceBegin, size_t oldSpaceObjSize, size_t nonMovableObjSize,
                                        size_t machineCodeObjSize, size_t snapshotObjSize, size_t hugeSpaceObjSize);
    void DeserializeString(uintptr_t stringBegin, uintptr_t stringEnd);

    void AddRootObjectToAOTFileManager(SnapshotType type, const CString &fileName);

    void SetProgramSerializeStart()
    {
        programSerialize_ = true;
    }

    void SetBuiltinsSerializeStart()
    {
        builtinsSerialize_ = true;
    }

    void SetBuiltinsDeserializeStart()
    {
        builtinsDeserialize_ = true;
    }

    const CVector<uintptr_t> GetStringVector() const
    {
        return stringVector_;
    }

    LocalSpace* GetOldLocalSpace() const
    {
        return oldLocalSpace_;
    }

    size_t GetNativeTableSize() const;

private:
    size_t GetMarkGCBitSetSize() const
    {
        return GCBitset::SizeOfGCBitset(DEFAULT_REGION_SIZE -
            AlignUp(sizeof(Region), static_cast<size_t>(MemAlignment::MEM_ALIGN_REGION)));
    }

    bool VisitObjectBodyWithRep(TaggedObject *root, ObjectSlot slot, uintptr_t obj, int index, VisitObjectArea area);
    void SetObjectEncodeField(uintptr_t obj, size_t offset, uint64_t value);

    EncodeBit SerializeObjectHeader(TaggedObject *objectHeader, size_t objectType, CQueue<TaggedObject *> *queue,
                                    std::unordered_map<uint64_t, ObjectEncode> *data);
    uint64_t SerializeTaggedField(JSTaggedType *tagged, CQueue<TaggedObject *> *queue,
                                  std::unordered_map<uint64_t, ObjectEncode> *data);
    void DeserializeField(TaggedObject *objectHeader);
    void DeserializeTaggedField(uint64_t *value, TaggedObject *root);
    void DeserializeNativePointer(uint64_t *value);
    void DeserializeClassWord(TaggedObject *object);
    void DeserializePandaMethod(uintptr_t begin, uintptr_t end, MethodLiteral *methods,
                                size_t &methodNums, size_t &others);
    void DeserializeSpaceObject(uintptr_t beginAddr, Space* space, size_t spaceObjSize);
    void DeserializeHugeSpaceObject(uintptr_t beginAddr, HugeObjectSpace* space, size_t hugeSpaceObjSize);
    void HandleRootObject(SnapshotType type, uintptr_t rootObjectAddr, size_t objType, size_t &constSpecialIndex);

    EncodeBit NativePointerToEncodeBit(void *nativePointer);
    size_t SearchNativeMethodIndex(void *nativePointer);
    uintptr_t TaggedObjectEncodeBitToAddr(EncodeBit taggedBit);
    void WriteSpaceObjectToFile(Space* space, std::fstream &write);
    void WriteHugeObjectToFile(HugeObjectSpace* space, std::fstream &writer);
    uint32_t StatisticsSpaceObjectSize(Space* space);
    uint32_t StatisticsHugeObjectSize(HugeObjectSpace* space);
    uintptr_t AllocateObjectToLocalSpace(Space *space, size_t objectSize);
    SnapshotRegionHeadInfo GenerateRegionHeadInfo(Region *region);
    void ResetRegionUnusedRange(Region *region);

    EcmaVM *vm_ {nullptr};
    SharedHeap* sHeap_ {nullptr};
    LocalSpace *oldLocalSpace_ {nullptr};
    LocalSpace *nonMovableLocalSpace_ {nullptr};
    LocalSpace *machineCodeLocalSpace_ {nullptr};
    SnapshotSpace *snapshotLocalSpace_ {nullptr};
    HugeObjectSpace *hugeObjectLocalSpace_ {nullptr};
    bool programSerialize_ {false};
    bool builtinsSerialize_ {false};
    bool builtinsDeserialize_ {false};
    CVector<uintptr_t> pandaMethod_;
    CVector<uintptr_t> stringVector_;
    /**
     * In deserialize, RuntimeLock for string table may cause a SharedGC, making strings just created invalid,
     * so use handle to protect.
    */
    CVector<JSHandle<EcmaString>> deserializeStringVector_;
    std::unordered_map<size_t, Region *> regionIndexMap_;
    size_t regionIndex_ {0};
    bool isRootObjRelocate_ {false};
    JSTaggedValue root_ {JSTaggedValue::Hole()};

    NO_COPY_SEMANTIC(SnapshotProcessor);
    NO_MOVE_SEMANTIC(SnapshotProcessor);
};

class SnapshotHelper {
public:
    // when snapshot serialize, huge obj size is writed to region snapshotData_ high 32 bits
    static inline uint64_t EncodeHugeObjectSize(uint64_t objSize)
    {
        return objSize << Constants::UINT_32_BITS_COUNT;
    }

    // get huge object size which is saved in region snapshotData_ high 32 bits
    static inline size_t GetHugeObjectSize(uint64_t snapshotData)
    {
        return snapshotData >> Constants::UINT_32_BITS_COUNT;
    }

    // get huge object region index which is saved in region snapshotMark_ low 32 bits
    static inline size_t GetHugeObjectRegionIndex(uint64_t snapshotData)
    {
        return snapshotData & Constants::MAX_UINT_32;
    }
};
}  // namespace panda::ecmascript

#endif  // ECMASCRIPT_SNAPSHOT_MEM_SNAPSHOT_PROCESSOR_H