es2panda/util/hotfix.cpp

/*
 * Copyright (c) 2022 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 "hotfix.h"
#include <binder/binder.h>
#include <binder/scope.h>
#include <binder/variable.h>
#include <compiler/core/pandagen.h>
#include <ir/expressions/literal.h>

#include <fstream>
#include <iostream>
#include <string>
#include <unistd.h>

namespace panda::es2panda::util {

constexpr std::string_view ANONYMOUS_OR_DUPLICATE_FUNCTION_SPECIFIER = "#";
const std::string EXTERNAL_ATTRIBUTE = "external";
const panda::panda_file::SourceLang SRC_LANG = panda::panda_file::SourceLang::ECMASCRIPT;

void Hotfix::ProcessFunction(const compiler::PandaGen *pg, panda::pandasm::Function *func,
    LiteralBuffers &literalBuffers)
{
    if (generateSymbolFile_) {
        DumpFunctionInfo(pg, func, literalBuffers);
        return;
    }

    if (generatePatch_ || hotReload_) {
        HandleFunction(pg, func, literalBuffers);
        return;
    }
}

void Hotfix::ProcessModule(const std::string &recordName,
    std::vector<panda::pandasm::LiteralArray::Literal> &moduleBuffer)
{
    if (generateSymbolFile_) {
        DumpModuleInfo(recordName, moduleBuffer);
        return;
    }

    if (generatePatch_ || hotReload_) {
        ValidateModuleInfo(recordName, moduleBuffer);
        return;
    }
}

void Hotfix::ProcessJsonContentRecord(const std::string &recordName, const std::string &jsonFileContent)
{
    if (generateSymbolFile_) {
        DumpJsonContentRecInfo(recordName, jsonFileContent);
        return;
    }

    if (generatePatch_ || hotReload_) {
        ValidateJsonContentRecInfo(recordName, jsonFileContent);
        return;
    }
}

void Hotfix::DumpModuleInfo(const std::string &recordName,
    std::vector<panda::pandasm::LiteralArray::Literal> &moduleBuffer)
{
    std::stringstream ss;
    ss << recordName << SymbolTable::SECOND_LEVEL_SEPERATOR;
    auto hash = std::hash<std::string>{}(ConvertLiteralToString(moduleBuffer));
    ss << hash << std::endl;
    symbolTable_->WriteSymbolTable(ss.str());
}

void Hotfix::ValidateModuleInfo(const std::string &recordName,
    std::vector<panda::pandasm::LiteralArray::Literal> &moduleBuffer)
{
    auto it = originModuleInfo_->find(recordName);
    if (it == originModuleInfo_->end()) {
        std::cerr << "[Patch] Found new import/export expression in " << recordName << ", not supported!" << std::endl;
        patchError_ = true;
        return;
    }

    auto hash = std::hash<std::string>{}(ConvertLiteralToString(moduleBuffer));
    if (std::to_string(hash) != it->second) {
        std::cerr << "[Patch] Found import/export expression changed in " << recordName << ", not supported!" <<
            std::endl;
        patchError_ = true;
        return;
    }
}

void Hotfix::DumpJsonContentRecInfo(const std::string &recordName, const std::string &jsonFileContent)
{
    std::stringstream ss;
    ss << recordName << SymbolTable::SECOND_LEVEL_SEPERATOR;
    auto hash = std::hash<std::string>{}(jsonFileContent);
    ss << hash << std::endl;
    symbolTable_->WriteSymbolTable(ss.str());
}

void Hotfix::ValidateJsonContentRecInfo(const std::string &recordName, const std::string &jsonFileContent)
{
    auto it = originModuleInfo_->find(recordName);
    if (it == originModuleInfo_->end()) {
        std::cerr << "[Patch] Found new import/require json file expression in " << recordName
                  << ", not supported!" << std::endl;
        patchError_ = true;
        return;
    }

    auto hash = std::hash<std::string>{}(jsonFileContent);
    if (std::to_string(hash) != it->second) {
        std::cerr << "[Patch] Found imported/required json file content changed in " << recordName
                  << ", not supported!" << std::endl;
        patchError_ = true;
        return;
    }
}

bool Hotfix::IsAnonymousOrDuplicateNameFunction(const std::string &funcName)
{
    return funcName.find(ANONYMOUS_OR_DUPLICATE_FUNCTION_SPECIFIER) != std::string::npos;
}

int64_t Hotfix::GetLiteralIdxFromStringId(const std::string &stringId)
{
    auto recordPrefix = recordName_ + "_";
    auto idxStr = stringId.substr(recordPrefix.size());
    return std::atoi(idxStr.c_str());
}

std::vector<std::pair<std::string, size_t>> Hotfix::GenerateFunctionAndClassHash(panda::pandasm::Function *func,
    LiteralBuffers &literalBuffers)
{
    std::stringstream ss;
    std::vector<std::pair<std::string, size_t>> hashList;

    ss << ".function any " << func->name << '(';

    for (uint32_t i = 0; i < func->GetParamsNum(); i++) {
        ss << "any a" << std::to_string(i);
        if (i != func->GetParamsNum() - 1) {
            ss << ", ";
        }
    }
    ss << ") {" << std::endl;

    for (const auto &ins : func->ins) {
        ss << (ins.set_label ? "" : "\t") << ins.ToString("", true, func->GetTotalRegs()) << " ";
        if (ins.opcode == panda::pandasm::Opcode::CREATEARRAYWITHBUFFER ||
            ins.opcode == panda::pandasm::Opcode::CREATEOBJECTWITHBUFFER) {
            int64_t bufferIdx = GetLiteralIdxFromStringId(ins.ids[0]);
            ss << ExpandLiteral(bufferIdx, literalBuffers) << " ";
        } else if (ins.opcode == panda::pandasm::Opcode::DEFINECLASSWITHBUFFER) {
            int64_t bufferIdx = GetLiteralIdxFromStringId(ins.ids[1]);
            std::string literalStr = ExpandLiteral(bufferIdx, literalBuffers);
            auto classHash = std::hash<std::string>{}(literalStr);
            hashList.push_back(std::pair<std::string, size_t>(ins.ids[0], classHash));
            CollectClassMemberFunctions(ins.ids[0], bufferIdx, literalBuffers);
        }
        ss << " ";
    }

    ss << "}" << std::endl;

    for (const auto &ct : func->catch_blocks) {
        ss << ".catchall " << ct.try_begin_label << ", " << ct.try_end_label << ", " << ct.catch_begin_label
            << std::endl;
    }

    auto funcHash = std::hash<std::string>{}(ss.str());
    hashList.push_back(std::pair<std::string, size_t>(func->name, funcHash));
    return hashList;
}

std::string Hotfix::ConvertLiteralToString(std::vector<panda::pandasm::LiteralArray::Literal> &literalBuffer)
{
    std::stringstream ss;
    int count = 0;
    for (auto &literal : literalBuffer) {
        ss << "{" << "index: " << count++ << " ";
        ss << "tag: " << static_cast<std::underlying_type<panda::es2panda::ir::LiteralTag>::type>(literal.tag_);
        ss << " ";
        std::string val;
        std::visit([&val](auto&& element) {
            val += "val: ";
            val += element;
            val += " ";
        }, literal.value_ );
        ss << val;
        ss << "},";

    }

    return ss.str();
}

std::string Hotfix::ExpandLiteral(int64_t bufferIdx, Hotfix::LiteralBuffers &literalBuffers)
{
    for (auto &litPair : literalBuffers) {
        if (litPair.first == bufferIdx) {
            return ConvertLiteralToString(litPair.second);
        }
    }

    return "";
}

std::vector<std::string> Hotfix::GetLiteralMethods(int64_t bufferIdx, Hotfix::LiteralBuffers &literalBuffers)
{
    std::vector<std::string> methods;
    for (auto &litPair : literalBuffers) {
        if (litPair.first != bufferIdx) {
            continue;
        }
        for (auto &literal : litPair.second) {
            switch (literal.tag_) {
                case panda::panda_file::LiteralTag::METHOD:
                case panda::panda_file::LiteralTag::GENERATORMETHOD:
                case panda::panda_file::LiteralTag::ASYNCGENERATORMETHOD: {
                    methods.push_back(std::get<std::string>(literal.value_));
                    break;
                }
                default:
                    break;
            }
        }
    }

    return methods;
}

void Hotfix::CollectClassMemberFunctions(const std::string &className, int64_t bufferIdx,
    Hotfix::LiteralBuffers &literalBuffers)
{
    std::vector<std::string> classMemberFunctions = GetLiteralMethods(bufferIdx, literalBuffers);
    classMemberFunctions.push_back(className);
    classMemberFunctions_.insert({className, classMemberFunctions});
}

bool Hotfix::IsScopeValidToPatchLexical(binder::VariableScope *scope) const
{
    if (!generatePatch_ && !hotReload_) {
        return false;
    }

    if (!scope->IsFunctionVariableScope()) {
        return false;
    }

    auto funcName = scope->AsFunctionVariableScope()->InternalName();
    if (std::string(funcName) != funcMain0_) {
        return false;
    }
    return true;
}

void Hotfix::AllocSlotfromPatchEnv(const std::string &variableName)
{
    if (!topScopeLexEnvs_.count(variableName)) {
        topScopeLexEnvs_[variableName] = topScopeIdx_++;
    }
}

uint32_t Hotfix::GetSlotIdFromSymbolTable(const std::string &variableName)
{
    auto functionIter = originFunctionInfo_->find(funcMain0_);
    if (functionIter != originFunctionInfo_->end()) {
        for (const auto &lexenv : functionIter->second.lexenv) {
            if (lexenv.second.first == variableName) {
                return lexenv.first;
            }
        }
    }
    return UINT32_MAX;
}

uint32_t Hotfix::GetPatchLexicalIdx(const std::string &variableName)
{
    ASSERT(topScopeLexEnvs_.count(variableName));
    return topScopeLexEnvs_[variableName];
}

bool IsFunctionOrClassDefineIns(panda::pandasm::Ins &ins)
{
    if (ins.opcode == panda::pandasm::Opcode::DEFINEMETHOD ||
        ins.opcode == panda::pandasm::Opcode::DEFINEFUNC ||
        ins.opcode == panda::pandasm::Opcode::DEFINECLASSWITHBUFFER) {
        return true;
    }
    return false;
}

bool IsStPatchVarIns(panda::pandasm::Ins &ins)
{
    return ins.opcode == panda::pandasm::Opcode::WIDE_STPATCHVAR;
}

void Hotfix::CollectFuncDefineIns(panda::pandasm::Function *func)
{
    for (size_t i = 0; i < func->ins.size(); ++i) {
        if (IsFunctionOrClassDefineIns(func->ins[i])) {
            funcDefineIns_.push_back(func->ins[i]);  // push define ins
            funcDefineIns_.push_back(func->ins[i + 1]);  // push store ins
        }
    }
}

void Hotfix::HandleModifiedClasses(panda::pandasm::Program *prog)
{
    for (auto &cls: classMemberFunctions_) {
        for (auto &func: cls.second) {
            if (!prog->function_table.at(func).metadata->IsForeign()) {
                modifiedClassNames_.insert(cls.first);
                break;
            }
        }
    }

    for (auto &cls: modifiedClassNames_) {
        auto &memberFunctions = classMemberFunctions_[cls];
        for (auto &func: memberFunctions) {
            if (prog->function_table.at(func).metadata->IsForeign()) {
                prog->function_table.at(func).metadata->RemoveAttribute(EXTERNAL_ATTRIBUTE);
            }
        }
    }
}

void Hotfix::AddHeadAndTailInsForPatchFuncMain0(std::vector<panda::pandasm::Ins> &ins)
{
    panda::pandasm::Ins returnUndefine;
    returnUndefine.opcode = pandasm::Opcode::RETURNUNDEFINED;

    if (ins.size() == 0) {
        ins.push_back(returnUndefine);
        return;
    }

    panda::pandasm::Ins newLexenv;
    newLexenv.opcode = pandasm::Opcode::NEWLEXENV;
    newLexenv.imms.reserve(1);
    auto newFuncNum = long(ins.size() / 2);  // each new function has 2 ins: define and store
    newLexenv.imms.emplace_back(newFuncNum);

    ins.insert(ins.begin(), newLexenv);
    ins.push_back(returnUndefine);
}

void Hotfix::AddTailInsForPatchFuncMain1(std::vector<panda::pandasm::Ins> &ins)
{
    panda::pandasm::Ins returnUndefined;
    returnUndefined.opcode = pandasm::Opcode::RETURNUNDEFINED;
    ins.push_back(returnUndefined);
}

void Hotfix::CreateFunctionPatchMain0AndMain1(panda::pandasm::Function &patchFuncMain0,
    panda::pandasm::Function &patchFuncMain1)
{
    const size_t defaultParamCount = 3;
    patchFuncMain0.params.reserve(defaultParamCount);
    patchFuncMain1.params.reserve(defaultParamCount);
    for (uint32_t i = 0; i < defaultParamCount; ++i) {
        patchFuncMain0.params.emplace_back(panda::pandasm::Type("any", 0), SRC_LANG);
        patchFuncMain1.params.emplace_back(panda::pandasm::Type("any", 0), SRC_LANG);
    }

    std::vector<panda::pandasm::Ins> patchMain0DefineIns;
    std::vector<panda::pandasm::Ins> patchMain1DefineIns;

    for (size_t i = 0; i < funcDefineIns_.size(); ++i) {
        if (IsFunctionOrClassDefineIns(funcDefineIns_[i])) {
            auto &name = funcDefineIns_[i].ids[0];
            if (newFuncNames_.count(name) && IsStPatchVarIns(funcDefineIns_[i + 1])) {
                patchMain0DefineIns.push_back(funcDefineIns_[i]);
                patchMain0DefineIns.push_back(funcDefineIns_[i + 1]);
                continue;
            }
            if (patchFuncNames_.count(name) || modifiedClassNames_.count(name)) {
                patchMain1DefineIns.push_back(funcDefineIns_[i]);
                continue;
            }
        }
    }

    AddHeadAndTailInsForPatchFuncMain0(patchMain0DefineIns);
    AddTailInsForPatchFuncMain1(patchMain1DefineIns);

    patchFuncMain0.ins = patchMain0DefineIns;
    patchFuncMain1.ins = patchMain1DefineIns;

    patchFuncMain0.return_type = panda::pandasm::Type("any", 0);
    patchFuncMain1.return_type = panda::pandasm::Type("any", 0);
}

void Hotfix::Finalize(panda::pandasm::Program **prog)
{
    if (!generatePatch_ && !hotReload_) {
        return;
    }

    HandleModifiedClasses(*prog);

    if (patchError_) {
        *prog = nullptr;
        std::cerr << "[Patch] Found unsupported change in file, will not generate patch!" << std::endl;
        return;
    }

    if (hotReload_) {
        return;
    }

    panda::pandasm::Function patchFuncMain0(patchMain0_, SRC_LANG);
    panda::pandasm::Function patchFuncMain1(patchMain1_, SRC_LANG);
    CreateFunctionPatchMain0AndMain1(patchFuncMain0, patchFuncMain1);

    (*prog)->function_table.emplace(patchFuncMain0.name, std::move(patchFuncMain0));
    (*prog)->function_table.emplace(patchFuncMain1.name, std::move(patchFuncMain1));
}

bool Hotfix::CompareLexenv(const std::string &funcName, const compiler::PandaGen *pg,
    SymbolTable::OriginFunctionInfo &bytecodeInfo)
{
    auto &lexicalVarNameAndTypes = pg->TopScope()->GetLexicalVarNameAndTypes();
    auto &lexenv = bytecodeInfo.lexenv;
    if (funcName != funcMain0_) {
        if (lexenv.size() != lexicalVarNameAndTypes.size()) {
            std::cerr << "[Patch] Found lexical variable added or removed in " << funcName << ", not supported!"
                << std::endl;
            patchError_ = true;
            return false;
        }
        for (auto &variable: lexicalVarNameAndTypes) {
            auto varSlot = variable.first;
            auto lexenvIter = lexenv.find(varSlot);
            if (lexenvIter == lexenv.end()) {
                std::cerr << "[Patch] Found new lexical variable added in function " << funcName << ", not supported!"
                    << std::endl;
                patchError_ = true;
                return false;
            }

            auto &lexInfo = lexenvIter->second;
            if (std::string(variable.second.first) != lexInfo.first || variable.second.second != lexInfo.second) {
                std::cerr << "[Patch] Found lexical variable changed in function " << funcName << ", not supported!"
                    << std::endl;
                patchError_ = true;
                return false;
            }
        }
    }
    return true;
}

bool Hotfix::CompareClassHash(std::vector<std::pair<std::string, size_t>> &hashList,
    SymbolTable::OriginFunctionInfo &bytecodeInfo)
{
    auto &classInfo = bytecodeInfo.classHash;
    for (size_t i = 0; i < hashList.size() - 1; ++i) {
        auto &className = hashList[i].first;
        auto classIter = classInfo.find(className);
        if (classIter != classInfo.end()) {
            if (classIter->second != std::to_string(hashList[i].second)) {
                if (hotReload_) {
                    std::cerr << "[Patch] Found class " << hashList[i].first << " changed, not supported! If " <<
                        hashList[i].first << " is not changed and you are changing UI Component, please only " <<
                        "change one Component at a time and make sure the Component is placed at the bottom " <<
                        "of the file." << std::endl;
                } else {
                    std::cerr << "[Patch] Found class " << hashList[i].first << " changed, not supported!" << std::endl;
                }
                patchError_ = true;
                return false;
            }
        }
    }
    return true;
}

void Hotfix::HandleFunction(const compiler::PandaGen *pg, panda::pandasm::Function *func,
    LiteralBuffers &literalBuffers)
{
    std::string funcName = func->name;
    auto originFunction = originFunctionInfo_->find(funcName);
    if (originFunction == originFunctionInfo_->end()) {
        // Support adding anonymous funtion in hotreload mode.
        if (hotReload_) {
            return;
        }
        if (IsAnonymousOrDuplicateNameFunction(funcName)) {
            std::cerr << "[Patch] Found new anonymous or duplicate name function " << funcName
                      << " not supported!" << std::endl;
            patchError_ = true;
            return;
        }
        newFuncNames_.insert(funcName);
        CollectFuncDefineIns(func);
        return;
    }

    auto &bytecodeInfo = originFunction->second;
    if (!CompareLexenv(funcName, pg, bytecodeInfo)) {
        return;
    }

    auto hashList = GenerateFunctionAndClassHash(func, literalBuffers);
    if (!CompareClassHash(hashList, bytecodeInfo)) {
        return;
    }

    if (hotReload_) {
        return;
    }

    auto funcHash = std::to_string(hashList.back().second);
    if (funcHash == bytecodeInfo.funcHash || funcName == funcMain0_) {
        func->metadata->SetAttribute(EXTERNAL_ATTRIBUTE);
    } else {
        patchFuncNames_.insert(funcName);
    }

    CollectFuncDefineIns(func);
}

void Hotfix::DumpFunctionInfo(const compiler::PandaGen *pg, panda::pandasm::Function *func,
    Hotfix::LiteralBuffers &literalBuffers)
{
    std::stringstream ss;

    ss << pg->InternalName();
    ss << SymbolTable::SECOND_LEVEL_SEPERATOR << pg->InternalName() << SymbolTable::SECOND_LEVEL_SEPERATOR;

    std::vector<std::pair<std::string, size_t>> hashList = GenerateFunctionAndClassHash(func, literalBuffers);
    ss << hashList.back().second << SymbolTable::SECOND_LEVEL_SEPERATOR;

    ss << SymbolTable::FIRST_LEVEL_SEPERATOR;
    for (size_t i = 0; i < hashList.size() - 1; ++i) {
        ss << hashList[i].first << SymbolTable::SECOND_LEVEL_SEPERATOR << hashList[i].second <<
            SymbolTable::SECOND_LEVEL_SEPERATOR;
    }
    ss << SymbolTable::SECOND_LEVEL_SEPERATOR << SymbolTable::FIRST_LEVEL_SEPERATOR;

    for (auto &variable: pg->TopScope()->GetLexicalVarNameAndTypes()) {
        ss << variable.second.first << SymbolTable::SECOND_LEVEL_SEPERATOR
           << variable.first << SymbolTable::SECOND_LEVEL_SEPERATOR
           << variable.second.second << SymbolTable::SECOND_LEVEL_SEPERATOR;
    }
    ss << SymbolTable::SECOND_LEVEL_SEPERATOR << std::endl;

    symbolTable_->WriteSymbolTable(ss.str());
}

bool Hotfix::IsPatchVar(uint32_t slot)
{
    return slot == UINT32_MAX;
}

} // namespace panda::es2panda::util