OpenHarmony-v5.0.2-Release/s

/*
 * Copyright (c) 2023 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 "aarch64_ssa.h"
#include "aarch64_cg.h"

namespace maplebe {
void AArch64CGSSAInfo::RenameInsn(Insn &insn)
{
    auto opndNum = static_cast<int32>(insn.GetOperandSize());
    const InsnDesc *md = insn.GetDesc();
    if (md->IsPhi()) {
        return;
    }
    for (int i = opndNum - 1; i >= 0; --i) {
        Operand &opnd = insn.GetOperand(static_cast<uint32>(i));
        auto *opndProp = (md->opndMD[static_cast<uint32>(i)]);
        A64SSAOperandRenameVisitor renameVisitor(*this, insn, *opndProp, i);
        opnd.Accept(renameVisitor);
    }
}

MemOperand *AArch64CGSSAInfo::CreateMemOperand(MemOperand &memOpnd, bool isOnSSA)
{
    return isOnSSA ? memOpnd.Clone(*memPool) : &static_cast<AArch64CGFunc *>(cgFunc)->GetOrCreateMemOpnd(memOpnd);
}

RegOperand *AArch64CGSSAInfo::GetRenamedOperand(RegOperand &vRegOpnd, bool isDef, Insn &curInsn, uint32 idx)
{
    if (vRegOpnd.IsVirtualRegister()) {
        DEBUG_ASSERT(!vRegOpnd.IsSSAForm(), "Unexpect ssa operand");
        if (isDef) {
            VRegVersion *newVersion = CreateNewVersion(vRegOpnd, curInsn, idx);
            CHECK_FATAL(newVersion != nullptr, "get ssa version failed");
            return newVersion->GetSSAvRegOpnd();
        } else {
            VRegVersion *curVersion = GetVersion(vRegOpnd);
            if (curVersion == nullptr) {
                curVersion = RenamedOperandSpecialCase(vRegOpnd, curInsn, idx);
            }
            curVersion->AddUseInsn(*this, curInsn, idx);
            return curVersion->GetSSAvRegOpnd();
        }
    }
    DEBUG_ASSERT(false, "Get Renamed operand failed");
    return nullptr;
}

VRegVersion *AArch64CGSSAInfo::RenamedOperandSpecialCase(RegOperand &vRegOpnd, Insn &curInsn, uint32 idx)
{
    LogInfo::MapleLogger() << "WARNING: " << vRegOpnd.GetRegisterNumber()
                           << " has no def info in function : " << cgFunc->GetName() << " !\n";
    /* occupy operand for no def vreg */
    if (!IncreaseSSAOperand(vRegOpnd.GetRegisterNumber(), nullptr)) {
        DEBUG_ASSERT(GetAllSSAOperands().find(vRegOpnd.GetRegisterNumber()) != GetAllSSAOperands().end(),
                     "should find");
        AddNoDefVReg(vRegOpnd.GetRegisterNumber());
    }
    VRegVersion *version = CreateNewVersion(vRegOpnd, curInsn, idx);
    version->SetDefInsn(nullptr, kDefByNo);
    return version;
}

RegOperand *AArch64CGSSAInfo::CreateSSAOperand(RegOperand &virtualOpnd)
{
    regno_t ssaRegNO = static_cast<regno_t>(GetAllSSAOperands().size()) + SSARegNObase;
    while (GetAllSSAOperands().count(ssaRegNO)) {
        ssaRegNO++;
        SSARegNObase++;
    }
    RegOperand *newVreg = memPool->New<RegOperand>(ssaRegNO, virtualOpnd.GetSize(), virtualOpnd.GetRegisterType());
    newVreg->SetValidBitsNum(virtualOpnd.GetValidBitsNum());
    newVreg->SetOpndSSAForm();
    return newVreg;
}

void AArch64CGSSAInfo::ReplaceInsn(Insn &oriInsn, Insn &newInsn)
{
    A64OpndSSAUpdateVsitor ssaUpdator(*this);
    auto UpdateInsnSSAInfo = [&ssaUpdator](Insn &curInsn, bool isDelete) {
        const InsnDesc *md = curInsn.GetDesc();
        for (uint32 i = 0; i < curInsn.GetOperandSize(); ++i) {
            Operand &opnd = curInsn.GetOperand(i);
            auto *opndProp = md->opndMD[i];
            if (isDelete) {
                ssaUpdator.MarkDecrease();
            } else {
                ssaUpdator.MarkIncrease();
            }
            ssaUpdator.SetInsnOpndInfo(curInsn, *opndProp, i);
            opnd.Accept(ssaUpdator);
        }
    };
    UpdateInsnSSAInfo(oriInsn, true);
    newInsn.SetId(oriInsn.GetId());
    UpdateInsnSSAInfo(newInsn, false);
    CHECK_FATAL(!ssaUpdator.HasDeleteDef(), "delete def point in replace insn, please check");
}

/* do not break binding between input and output operands in asm */
void AArch64CGSSAInfo::CheckAsmDUbinding(Insn &insn, const VRegVersion *toBeReplaced, VRegVersion *newVersion)
{
    if (insn.GetMachineOpcode() == MOP_asm) {
        for (auto &opndIt : static_cast<ListOperand &>(insn.GetOperand(kAsmOutputListOpnd)).GetOperands()) {
            if (opndIt->IsSSAForm()) {
                VRegVersion *defVersion = FindSSAVersion(opndIt->GetRegisterNumber());
                if (defVersion && defVersion->GetOriginalRegNO() == toBeReplaced->GetOriginalRegNO()) {
                    insn.AddRegBinding(defVersion->GetOriginalRegNO(),
                                       newVersion->GetSSAvRegOpnd()->GetRegisterNumber());
                }
            }
        }
    }
}

void AArch64CGSSAInfo::ReplaceAllUse(VRegVersion *toBeReplaced, VRegVersion *newVersion)
{
    MapleUnorderedMap<uint32, DUInsnInfo *> &useList = toBeReplaced->GetAllUseInsns();
    for (auto it = useList.begin(); it != useList.end();) {
        Insn *useInsn = it->second->GetInsn();
        CheckAsmDUbinding(*useInsn, toBeReplaced, newVersion);
        for (auto &opndIt : it->second->GetOperands()) {
            Operand &opnd = useInsn->GetOperand(opndIt.first);
            A64ReplaceRegOpndVisitor replaceRegOpndVisitor(
                *cgFunc, *useInsn, opndIt.first, *toBeReplaced->GetSSAvRegOpnd(), *newVersion->GetSSAvRegOpnd());
            opnd.Accept(replaceRegOpndVisitor);
            newVersion->AddUseInsn(*this, *useInsn, opndIt.first);
            it->second->ClearDU(opndIt.first);
        }
        it = useList.erase(it);
    }
}

void AArch64CGSSAInfo::CreateNewInsnSSAInfo(Insn &newInsn)
{
    uint32 opndNum = newInsn.GetOperandSize();
    MarkInsnsInSSA(newInsn);
    for (uint32 i = 0; i < opndNum; i++) {
        Operand &opnd = newInsn.GetOperand(i);
        auto *opndProp = newInsn.GetDesc()->opndMD[i];
        if (opndProp->IsDef() && opndProp->IsUse()) {
            CHECK_FATAL(false, "do not support both def and use");
        }
        if (opndProp->IsDef()) {
            CHECK_FATAL(opnd.IsRegister(), "defOpnd must be reg");
            auto &defRegOpnd = static_cast<RegOperand &>(opnd);
            regno_t defRegNO = defRegOpnd.GetRegisterNumber();
            uint32 defVIdx = IncreaseVregCount(defRegNO);
            RegOperand *defSSAOpnd = CreateSSAOperand(defRegOpnd);
            newInsn.SetOperand(i, *defSSAOpnd);
            auto *defVersion = memPool->New<VRegVersion>(ssaAlloc, *defSSAOpnd, defVIdx, defRegNO);
            auto *defInfo = CreateDUInsnInfo(&newInsn, i);
            defVersion->SetDefInsn(defInfo, kDefByInsn);
            if (!IncreaseSSAOperand(defSSAOpnd->GetRegisterNumber(), defVersion)) {
                CHECK_FATAL(false, "insert ssa operand failed");
            }
        } else if (opndProp->IsUse()) {
            A64OpndSSAUpdateVsitor ssaUpdator(*this);
            ssaUpdator.MarkIncrease();
            ssaUpdator.SetInsnOpndInfo(newInsn, *opndProp, i);
            opnd.Accept(ssaUpdator);
        }
    }
}

void AArch64CGSSAInfo::DumpInsnInSSAForm(const Insn &insn) const
{
    MOperator mOp = insn.GetMachineOpcode();
    const InsnDesc *md = insn.GetDesc();
    DEBUG_ASSERT(md != nullptr, "md should not be nullptr");

    LogInfo::MapleLogger() << "< " << insn.GetId() << " > ";
    LogInfo::MapleLogger() << md->name << "(" << mOp << ")";

    for (uint32 i = 0; i < insn.GetOperandSize(); ++i) {
        Operand &opnd = insn.GetOperand(i);
        LogInfo::MapleLogger() << " (opnd" << i << ": ";
        A64SSAOperandDumpVisitor a64OpVisitor(GetAllSSAOperands());
        opnd.Accept(a64OpVisitor);
        if (!a64OpVisitor.HasDumped()) {
            opnd.Dump();
            LogInfo::MapleLogger() << ")";
        }
    }
    if (insn.IsVectorOp()) {
        auto &vInsn = static_cast<const VectorInsn &>(insn);
        if (vInsn.GetNumOfRegSpec() != 0) {
            LogInfo::MapleLogger() << " (vecSpec: " << vInsn.GetNumOfRegSpec() << ")";
        }
    }
    LogInfo::MapleLogger() << "\n";
}

void A64SSAOperandRenameVisitor::Visit(RegOperand *v)
{
    if (v->IsVirtualRegister()) {
        if (opndDes->IsRegDef() && opndDes->IsRegUse()) { /* both def use */
            insn->SetOperand(idx, *ssaInfo->GetRenamedOperand(*v, false, *insn, idx));
            (void)ssaInfo->GetRenamedOperand(*v, true, *insn, idx);
        } else {
            insn->SetOperand(idx, *ssaInfo->GetRenamedOperand(*v, opndDes->IsRegDef(), *insn, idx));
        }
    }
}

void A64SSAOperandRenameVisitor::Visit(MemOperand *a64MemOpnd)
{
    RegOperand *base = a64MemOpnd->GetBaseRegister();
    RegOperand *index = a64MemOpnd->GetIndexRegister();
    bool needCopy = (base != nullptr && base->IsVirtualRegister()) || (index != nullptr && index->IsVirtualRegister());
    if (needCopy) {
        MemOperand *cpyMem = ssaInfo->CreateMemOperand(*a64MemOpnd, true);
        if (base != nullptr && base->IsVirtualRegister()) {
            bool isDef = !a64MemOpnd->IsIntactIndexed();
            cpyMem->SetBaseRegister(*ssaInfo->GetRenamedOperand(*base, isDef, *insn, idx));
        }
        if (index != nullptr && index->IsVirtualRegister()) {
            cpyMem->SetIndexRegister(*ssaInfo->GetRenamedOperand(*index, false, *insn, idx));
        }
        insn->SetMemOpnd(ssaInfo->CreateMemOperand(*cpyMem, false));
    }
}

void A64SSAOperandRenameVisitor::Visit(ListOperand *v)
{
    bool isAsm = insn->GetMachineOpcode() == MOP_asm;
    /* record the orignal list order */
    std::list<RegOperand *> tempList;
    auto &opndList = v->GetOperands();
    while (!opndList.empty()) {
        auto *op = opndList.front();
        opndList.pop_front();

        if (op->IsSSAForm() || !op->IsVirtualRegister()) {
            tempList.push_back(op);
            continue;
        }

        bool isDef = isAsm && (idx == kAsmClobberListOpnd || idx == kAsmOutputListOpnd);
        RegOperand *renameOpnd = ssaInfo->GetRenamedOperand(*op, isDef, *insn, idx);
        tempList.push_back(renameOpnd);
    }
    DEBUG_ASSERT(v->GetOperands().empty(), "need to clean list");
    v->GetOperands().assign(tempList.begin(), tempList.end());
}

void A64OpndSSAUpdateVsitor::Visit(RegOperand *regOpnd)
{
    if (regOpnd->IsSSAForm()) {
        if (opndDes->IsRegDef() && opndDes->IsRegUse()) {
            UpdateRegUse(regOpnd->GetRegisterNumber());
            UpdateRegDef(regOpnd->GetRegisterNumber());
        } else {
            if (opndDes->IsRegDef()) {
                UpdateRegDef(regOpnd->GetRegisterNumber());
            } else if (opndDes->IsRegUse()) {
                UpdateRegUse(regOpnd->GetRegisterNumber());
            } else if (IsPhi()) {
                UpdateRegUse(regOpnd->GetRegisterNumber());
            } else {
                DEBUG_ASSERT(false, "invalid opnd");
            }
        }
    }
}

void A64OpndSSAUpdateVsitor::Visit(maplebe::MemOperand *a64MemOpnd)
{
    RegOperand *base = a64MemOpnd->GetBaseRegister();
    RegOperand *index = a64MemOpnd->GetIndexRegister();
    if (base != nullptr && base->IsSSAForm()) {
        if (a64MemOpnd->IsIntactIndexed()) {
            UpdateRegUse(base->GetRegisterNumber());
        } else {
            UpdateRegDef(base->GetRegisterNumber());
        }
    }
    if (index != nullptr && index->IsSSAForm()) {
        UpdateRegUse(index->GetRegisterNumber());
    }
}

void A64OpndSSAUpdateVsitor::Visit(PhiOperand *phiOpnd)
{
    SetPhi(true);
    for (auto phiListIt = phiOpnd->GetOperands().begin(); phiListIt != phiOpnd->GetOperands().end(); ++phiListIt) {
        Visit(phiListIt->second);
    }
    SetPhi(false);
}

void A64OpndSSAUpdateVsitor::Visit(ListOperand *v)
{
    /* do not handle asm here, so there is no list def */
    if (insn->GetMachineOpcode() == MOP_asm) {
        DEBUG_ASSERT(false, "do not support asm yet");
        return;
    }
    for (auto *op : v->GetOperands()) {
        if (op->IsSSAForm()) {
            UpdateRegUse(op->GetRegisterNumber());
        }
    }
}

void A64OpndSSAUpdateVsitor::UpdateRegUse(uint32 ssaIdx)
{
    VRegVersion *curVersion = ssaInfo->FindSSAVersion(ssaIdx);
    DEBUG_ASSERT(curVersion != nullptr, "curVersion should not be nullptr");
    if (isDecrease) {
        curVersion->RemoveUseInsn(*insn, idx);
    } else {
        curVersion->AddUseInsn(*ssaInfo, *insn, idx);
    }
}

void A64OpndSSAUpdateVsitor::UpdateRegDef(uint32 ssaIdx)
{
    VRegVersion *curVersion = ssaInfo->FindSSAVersion(ssaIdx);
    if (isDecrease) {
        deletedDef.emplace(ssaIdx);
        DEBUG_ASSERT(curVersion != nullptr, "nullptr check");
        curVersion->MarkDeleted();
    } else {
        if (deletedDef.count(ssaIdx)) {
            deletedDef.erase(ssaIdx);
            curVersion->MarkRecovery();
        } else {
            CHECK_FATAL(false, "do no support new define in ssaUpdating");
        }
        DEBUG_ASSERT(!insn->IsPhi(), "do no support yet");
        curVersion->SetDefInsn(ssaInfo->CreateDUInsnInfo(insn, idx), kDefByInsn);
    }
}

void A64SSAOperandDumpVisitor::Visit(RegOperand *a64RegOpnd)
{
    DEBUG_ASSERT(!a64RegOpnd->IsConditionCode(), "both condi and reg");
    if (a64RegOpnd->IsSSAForm()) {
        std::array<const std::string, kRegTyLast> prims = {"U", "R", "V", "C", "X", "Vra"};
        std::array<const std::string, kRegTyLast> classes = {"[U]", "[I]", "[F]", "[CC]", "[X87]", "[Vra]"};
        CHECK_FATAL(a64RegOpnd->IsVirtualRegister() && a64RegOpnd->IsSSAForm(), "only dump ssa opnd here");
        RegType regType = a64RegOpnd->GetRegisterType();
        DEBUG_ASSERT(regType < kRegTyLast, "unexpected regType");
        auto ssaVit = allSSAOperands.find(a64RegOpnd->GetRegisterNumber());
        CHECK_FATAL(ssaVit != allSSAOperands.end(), "find ssa version failed");
        LogInfo::MapleLogger() << "ssa_reg:" << prims[regType] << ssaVit->second->GetOriginalRegNO() << "_"
                               << ssaVit->second->GetVersionIdx() << " class: " << classes[regType] << " validBitNum: ["
                               << static_cast<uint32>(a64RegOpnd->GetValidBitsNum()) << "]";
        LogInfo::MapleLogger() << ")";
        SetHasDumped();
    }
}

void A64SSAOperandDumpVisitor::Visit(ListOperand *v)
{
    for (auto regOpnd : v->GetOperands()) {
        if (regOpnd->IsSSAForm()) {
            Visit(regOpnd);
            continue;
        }
    }
}

void A64SSAOperandDumpVisitor::Visit(MemOperand *a64MemOpnd)
{
    if (a64MemOpnd->GetBaseRegister() != nullptr && a64MemOpnd->GetBaseRegister()->IsSSAForm()) {
        LogInfo::MapleLogger() << "Mem: ";
        Visit(a64MemOpnd->GetBaseRegister());
        if (a64MemOpnd->GetAddrMode() == MemOperand::kAddrModeBOi) {
            LogInfo::MapleLogger() << "offset:";
            a64MemOpnd->GetOffsetOperand()->Dump();
        }
    }
    if (a64MemOpnd->GetIndexRegister() != nullptr && a64MemOpnd->GetIndexRegister()->IsSSAForm()) {
        DEBUG_ASSERT(a64MemOpnd->GetAddrMode() == MemOperand::kAddrModeBOrX, "mem mode false");
        LogInfo::MapleLogger() << "offset:";
        Visit(a64MemOpnd->GetIndexRegister());
    }
}

void A64SSAOperandDumpVisitor::Visit(PhiOperand *phi)
{
    for (auto phiListIt = phi->GetOperands().begin(); phiListIt != phi->GetOperands().end();) {
        Visit(phiListIt->second);
        LogInfo::MapleLogger() << " fBB<" << phiListIt->first << ">";
        LogInfo::MapleLogger() << (++phiListIt == phi->GetOperands().end() ? ")" : ", ");
    }
}
}  // namespace maplebe