/*
 * 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.
 */

#ifndef MAPLEBE_INCLUDE_CG_DEPENDENCE_H
#define MAPLEBE_INCLUDE_CG_DEPENDENCE_H

#include "deps.h"
#include "cgbb.h"

namespace maplebe {
using namespace maple;

class DepAnalysis {
public:
    DepAnalysis(CGFunc &func, MemPool &memPool, MAD &mad, bool beforeRA)
        : cgFunc(func), memPool(memPool), alloc(&memPool), beforeRA(beforeRA), mad(mad), lastComments(alloc.Adapter())
    {
    }

    virtual ~DepAnalysis() = default;

    virtual void Run(BB &bb, MapleVector<DepNode *> &nodes) = 0;

    const MapleVector<Insn *> &GetLastComments() const
    {
        return lastComments;
    }
    virtual void CombineClinit(DepNode &firstNode, DepNode &secondNode, bool isAcrossSeparator) = 0;
    virtual void CombineDependence(DepNode &firstNode, DepNode &secondNode, bool isAcrossSeparator,
                                   bool isMemCombine = false) = 0;
    virtual void CombineMemoryAccessPair(DepNode &firstNode, DepNode &secondNode, bool useFirstOffset) = 0;

    virtual const std::string &GetDepTypeName(DepType depType) const = 0;
    virtual void DumpDepNode(DepNode &node) const = 0;
    virtual void DumpDepLink(DepLink &link, const DepNode *node) const = 0;

protected:
    CGFunc &cgFunc;
    MemPool &memPool;
    MapleAllocator alloc;
    bool beforeRA;
    MAD &mad;
    MapleVector<Insn *> lastComments;

    virtual void Init(BB &bb, MapleVector<DepNode *> &nodes) = 0;
    virtual void ClearAllDepData() = 0;
    virtual void AppendRegUseList(Insn &insn, regno_t regNO) = 0;
    virtual void AddDependence(DepNode &fromNode, DepNode &toNode, DepType depType) = 0;
    virtual void RemoveSelfDeps(Insn &insn) = 0;
    virtual void BuildDepsUseReg(Insn &insn, regno_t regNO) = 0;
    virtual void BuildDepsDefReg(Insn &insn, regno_t regNO) = 0;
    virtual void BuildDepsAmbiInsn(Insn &insn) = 0;
    virtual void BuildDepsMayThrowInsn(Insn &insn) = 0;
    virtual void BuildDepsUseMem(Insn &insn, MemOperand &memOpnd) = 0;
    virtual void BuildDepsMemBar(Insn &insn) = 0;
    virtual void BuildDepsSeparator(DepNode &newSepNode, MapleVector<DepNode *> &nodes) = 0;
    virtual void BuildDepsControlAll(DepNode &depNode, const MapleVector<DepNode *> &nodes) = 0;
    virtual void BuildDepsAccessStImmMem(Insn &insn, bool isDest) = 0;
    virtual void BuildCallerSavedDeps(Insn &insn) = 0;
    virtual void BuildDepsBetweenControlRegAndCall(Insn &insn, bool isDest) = 0;
    virtual void BuildStackPassArgsDeps(Insn &insn) = 0;
    virtual void BuildDepsDirtyStack(Insn &insn) = 0;
    virtual void BuildDepsUseStack(Insn &insn) = 0;
    virtual void BuildDepsDirtyHeap(Insn &insn) = 0;
    virtual DepNode *BuildSeparatorNode() = 0;
    virtual bool IfInAmbiRegs(regno_t regNO) const = 0;
    virtual bool IsFrameReg(const RegOperand &) const = 0;
};
}  // namespace maplebe

#endif /* MAPLEBE_INCLUDE_CG_DEPENDENCE_H */