ecmascript/patch/quick_fix_manager.cpp

/*
 * Copyright (c) 2022-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.
 */
#include "ecmascript/patch/quick_fix_manager.h"

#include "ecmascript/global_env_constants-inl.h"
#include "ecmascript/jspandafile/js_pandafile_manager.h"
#include "ecmascript/js_tagged_value-inl.h"
#include "ecmascript/module/module_path_helper.h"

namespace panda::ecmascript {
QuickFixManager::~QuickFixManager()
{
    methodInfos_.clear();
}

void QuickFixManager::RegisterQuickFixQueryFunc(const std::function<bool(std::string baseFileName,
                        std::string &patchFileName,
                        uint8_t **patchBuffer,
                        size_t &patchSize)> callBack)
{
    callBack_ = callBack;
}

void QuickFixManager::LoadPatchIfNeeded(JSThread *thread, const JSPandaFile *baseFile)
{
    // callback and load patch.
    if (!HasQueryQuickFixInfoFunc()) {
        return;
    }

    std::string patchFileName;
    uint8_t *patchBuffer = nullptr;
    size_t patchSize = 0;
    CString baseFileName = baseFile->GetJSPandaFileDesc();
    if (checkedFiles_.find(baseFileName) != checkedFiles_.end()) {
        LOG_ECMA(DEBUG) << "Do not need check " << baseFileName << " has patch again";
        return;
    }
    checkedFiles_.insert(baseFileName);

    bool needLoadPatch = callBack_(baseFileName.c_str(), patchFileName, &patchBuffer, patchSize);
    if (!needLoadPatch) {
        LOG_ECMA(INFO) << "Do not need load patch of: " << baseFileName;
        return;
    }

    std::shared_ptr<JSPandaFile> patchFile = JSPandaFileManager::GetInstance()->LoadJSPandaFileSecure(
        thread, patchFileName.c_str(), "", patchBuffer, patchSize);
    if (patchFile == nullptr) {
        LOG_ECMA(ERROR) << "load patch jsPandafile failed of: " << baseFileName;
        return;
    }

    PatchInfo patchInfo;
    patchAndBaseFileNameMap_[patchFileName.c_str()] = baseFileName;
    if (baseClassInfo_.empty()) {
        baseClassInfo_ = PatchLoader::CollectClassInfo(baseFile);
    }
    auto ret = PatchLoader::LoadPatchInternal(thread, baseFile, patchFile.get(), patchInfo, baseClassInfo_);
    if (ret != PatchErrorCode::SUCCESS) {
        LOG_ECMA(ERROR) << "Load patch fail of: " << baseFileName;
        return;
    }
    thread->GetEcmaVM()->SetStageOfColdReload(StageOfColdReload::IS_COLD_RELOAD);
    methodInfos_.emplace(baseFileName, patchInfo);
}

PatchErrorCode QuickFixManager::LoadPatch(JSThread *thread, const std::string &patchFileName,
                                          const std::string &baseFileName)
{
    LOG_ECMA(INFO) << "Load patch, patch: " << patchFileName << ", base:" << baseFileName;
    if (methodInfos_.find(baseFileName.c_str()) != methodInfos_.end()) {
        LOG_ECMA(ERROR) << "Cannot repeat load patch!";
        return PatchErrorCode::PATCH_HAS_LOADED;
    }

    std::shared_ptr<JSPandaFile> baseFile = JSPandaFileManager::GetInstance()->LoadJSPandaFile(
        thread, baseFileName.c_str(), "", false, ExecuteTypes::STATIC);
    RETURN_VALUE_IF_ABRUPT_COMPLETION(thread, PatchErrorCode::FILE_NOT_FOUND);
    if (baseFile == nullptr) {
        LOG_ECMA(ERROR) << "find base jsPandafile failed";
        return PatchErrorCode::FILE_NOT_FOUND;
    }

    // The entry point is not work for merge abc.
    std::shared_ptr<JSPandaFile> patchFile = JSPandaFileManager::GetInstance()->LoadJSPandaFile(
        thread, patchFileName.c_str(), "", false, ExecuteTypes::STATIC);
    RETURN_VALUE_IF_ABRUPT_COMPLETION(thread, PatchErrorCode::FILE_NOT_FOUND);
    if (patchFile == nullptr) {
        LOG_ECMA(ERROR) << "load patch jsPandafile failed";
        return PatchErrorCode::FILE_NOT_FOUND;
    }

    PatchInfo patchInfo;
    patchAndBaseFileNameMap_[patchFile->GetJSPandaFileDesc()] = baseFileName.c_str();
    if (baseClassInfo_.empty()) {
        baseClassInfo_ = PatchLoader::CollectClassInfo(baseFile.get());
    }
    auto ret = PatchLoader::LoadPatchInternal(thread, baseFile.get(), patchFile.get(), patchInfo, baseClassInfo_);
    if (ret != PatchErrorCode::SUCCESS) {
        LOG_ECMA(ERROR) << "Load patch fail!";
        return ret;
    }

    methodInfos_.emplace(baseFileName.c_str(), patchInfo);
    LOG_ECMA(INFO) << "Load patch success!";
    return PatchErrorCode::SUCCESS;
}

PatchErrorCode QuickFixManager::LoadPatch(JSThread *thread,
                                          const std::string &patchFileName, uint8_t *patchBuffer, size_t patchSize,
                                          const std::string &baseFileName, uint8_t *baseBuffer, size_t baseSize)
{
    LOG_ECMA(INFO) << "Load patch, patch: " << patchFileName << ", base:" << baseFileName;
    if (methodInfos_.find(baseFileName.c_str()) != methodInfos_.end()) {
        LOG_ECMA(ERROR) << "Cannot repeat load patch!";
        return PatchErrorCode::PATCH_HAS_LOADED;
    }

    std::shared_ptr<JSPandaFile> baseFile = JSPandaFileManager::GetInstance()->LoadJSPandaFileSecure(
        thread, baseFileName.c_str(), "", baseBuffer, baseSize);
    if (baseFile == nullptr) {
        LOG_ECMA(ERROR) << "find base jsPandafile failed";
        return PatchErrorCode::FILE_NOT_FOUND;
    }

    std::shared_ptr<JSPandaFile> patchFile = JSPandaFileManager::GetInstance()->LoadJSPandaFileSecure(
        thread, patchFileName.c_str(), "", patchBuffer, patchSize);
    if (patchFile == nullptr) {
        LOG_ECMA(ERROR) << "load patch jsPandafile failed";
        return PatchErrorCode::FILE_NOT_FOUND;
    }

    PatchInfo patchInfo;
    patchAndBaseFileNameMap_[patchFile->GetJSPandaFileDesc()] = baseFileName.c_str();
    if (baseClassInfo_.empty()) {
        baseClassInfo_ = PatchLoader::CollectClassInfo(baseFile.get());
    }
    auto ret = PatchLoader::LoadPatchInternal(thread, baseFile.get(), patchFile.get(), patchInfo, baseClassInfo_);
    if (ret != PatchErrorCode::SUCCESS) {
        LOG_ECMA(ERROR) << "Load patch fail!";
        return ret;
    }

    methodInfos_.emplace(baseFileName.c_str(), patchInfo);
    LOG_ECMA(INFO) << "Load patch success!";
    return PatchErrorCode::SUCCESS;
}

PatchErrorCode QuickFixManager::UnloadPatch(JSThread *thread, const std::string &patchFileName)
{
    LOG_ECMA(INFO) << "Unload patch, patch: " << patchFileName;
    CString baseFileName;
    for (const auto &item : methodInfos_) {
        if (item.second.patchFileName == patchFileName.c_str()) {
            baseFileName = item.first;
        }
    }
    if (baseFileName.empty()) {
        LOG_ECMA(ERROR) << "patch has not been loaded!";
        return PatchErrorCode::PATCH_NOT_LOADED;
    }

    PatchInfo &patchInfo = methodInfos_.find(baseFileName)->second;
    patchAndBaseFileNameMap_.erase(patchFileName.c_str());
    auto ret = PatchLoader::UnloadPatchInternal(thread, patchFileName.c_str(), baseFileName.c_str(), patchInfo);
    if (ret != PatchErrorCode::SUCCESS) {
        LOG_ECMA(ERROR) << "Unload patch fail!";
        return ret;
    }

    methodInfos_.erase(baseFileName.c_str());
    LOG_ECMA(INFO) << "Unload patch success!";
    return PatchErrorCode::SUCCESS;
}

JSTaggedValue QuickFixManager::CheckAndGetPatch(JSThread *thread, const JSPandaFile *baseFile, EntityId baseMethodId)
{
    if (methodInfos_.empty()) {
        return JSTaggedValue::Hole();
    }

    auto iter = methodInfos_.find(baseFile->GetJSPandaFileDesc());
    if (iter == methodInfos_.end()) {
        return JSTaggedValue::Hole();
    }

    PatchInfo patchInfo = iter->second;
    MethodLiteral *patchMethodLiteral = PatchLoader::FindSameMethod(patchInfo, baseFile, baseMethodId, baseClassInfo_);
    if (patchMethodLiteral == nullptr) {
        return JSTaggedValue::Hole();
    }

    if (!HasQueryQuickFixInfoFunc()) {
        return JSTaggedValue::Hole();
    }

    // Generate patch constpool.
    CString patchFileName = patchInfo.patchFileName;
    std::shared_ptr<JSPandaFile> patchFile = JSPandaFileManager::GetInstance()->FindJSPandaFile(patchFileName);
    ASSERT(patchFile != nullptr);

    EcmaVM *vm = thread->GetEcmaVM();
    JSHandle<Method> method;
    method = vm->GetFactory()->NewSMethod(patchMethodLiteral);
    JSHandle<ConstantPool> newConstpool = vm->FindOrCreateConstPool(
        patchFile.get(), patchMethodLiteral->GetMethodId());
    method->SetConstantPool(thread, newConstpool);

    CString recordName = MethodLiteral::GetRecordName(baseFile, baseMethodId);
    JSHandle<JSTaggedValue> moduleRecord = vm->FindPatchModule(recordName);
    if (moduleRecord->IsHole()) {
        PatchLoader::ExecuteFuncOrPatchMain(thread, patchFile.get(), patchInfo);
        moduleRecord = vm->FindPatchModule(recordName);
        if (moduleRecord->IsHole()) {
            LOG_ECMA(FATAL) << "cold patch: moduleRecord is still hole after regeneration";
            UNREACHABLE();
        }
    }
    return method.GetTaggedValue();
}

bool QuickFixManager::IsQuickFixCausedException(JSThread *thread,
                                                const JSHandle<JSTaggedValue> &exceptionInfo,
                                                const std::string &patchFileName)
{
    JSPandaFileManager *pfManager = JSPandaFileManager::GetInstance();
    std::shared_ptr<JSPandaFile> patchFile = pfManager->FindJSPandaFile(ConvertToString(patchFileName));
    if (patchFile == nullptr || ConvertToString(patchFileName) != patchFile->GetJSPandaFileDesc()) {
        return false;
    }

    // get and parse stackinfo.
    JSHandle<JSTaggedValue> stackKey = thread->GlobalConstants()->GetHandledStackString();
    JSHandle<EcmaString> stack(JSObject::GetProperty(thread, exceptionInfo, stackKey).GetValue());
    CString stackInfo = ConvertToString(thread, *stack);
    CUnorderedSet<CString> methodNames = ParseStackInfo(stackInfo);

    // check whether the methodNames contains a patch method name.
    std::unordered_map<uint32_t, MethodLiteral *> patchMethodLiterals = patchFile->GetMethodLiteralMap();
    for (const auto &item : patchMethodLiterals) {
        MethodLiteral *patch = item.second;
        auto methodId = patch->GetMethodId();
        CString patchMethodName(MethodLiteral::GetMethodName(patchFile.get(), methodId));
        size_t index = patchMethodName.find_last_of('#');          // #...#functionName
        patchMethodName = patchMethodName.substr(index + 1);
        if (patchMethodName.find('^') != std::string::npos) {
            index = patchMethodName.find_last_of('^');
            patchMethodName = patchMethodName.substr(0, index);    // #...#functionName^1
        }

        if (std::strcmp(patchMethodName.data(), JSPandaFile::ENTRY_FUNCTION_NAME) != 0 &&
            methodNames.find(CString(patchMethodName)) != methodNames.end()) {
            return true;
        }
    }
    return false;
}

CUnorderedSet<CString> QuickFixManager::ParseStackInfo(const CString &stackInfo)
{
    const uint32_t methodNameOffsetToFirstIndex = 5; // offset of the starting position of methodname to firstIndex.
    size_t lineIndex = 0; // index of "\n".
    size_t firstIndex = 0; // index of "at".
    size_t nextIndex = 0; // index of "(".

    CUnorderedSet<CString> methodNames {}; // method names are from exception stack information.
    while (lineIndex != stackInfo.length() - 1) {
        firstIndex = stackInfo.find("  at ", lineIndex + 1);
        nextIndex = stackInfo.find("(", lineIndex + 1);
        CString methodName = stackInfo.substr(firstIndex + methodNameOffsetToFirstIndex,
            nextIndex - firstIndex - methodNameOffsetToFirstIndex - 1);
        methodNames.emplace(methodName);
        lineIndex = stackInfo.find("\n", lineIndex + 1);
    }
    return methodNames;
}

CString QuickFixManager::GetBaseFileName(const JSHandle<SourceTextModule> &module)
{
    CString fileName = module->GetEcmaModuleFilenameString();
    // Return the baseFileName of the patch module
    if (fileName.find(ModulePathHelper::EXT_NAME_HQF) != std::string::npos) {
        auto it = patchAndBaseFileNameMap_.find(fileName);
        if (it != patchAndBaseFileNameMap_.end()) {
            return it->second;
        } else {
            LOG_ECMA(ERROR) << "The baseFileName corresponding to " << fileName << " cannot be found.";
        }
    }
    return fileName;
}
}  // namespace panda::ecmascript