//===- MachineSSAContext.h --------------------------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
/// \file
///
/// This file declares a specialization of the GenericSSAContext<X>
/// template class for Machine IR.
///
//===----------------------------------------------------------------------===//

#ifndef LLVM_CODEGEN_MACHINESSACONTEXT_H
#define LLVM_CODEGEN_MACHINESSACONTEXT_H

#include "llvm/CodeGen/MachineBasicBlock.h"
#include "llvm/Support/Printable.h"

namespace llvm {
class MachineRegisterInfo;
class MachineInstr;
class MachineFunction;
class Register;
template <typename _FunctionT> class GenericSSAContext;
template <typename, bool> class DominatorTreeBase;

inline unsigned succ_size(const MachineBasicBlock *BB) {
  return BB->succ_size();
}
inline unsigned pred_size(const MachineBasicBlock *BB) {
  return BB->pred_size();
}
inline auto instrs(const MachineBasicBlock &BB) { return BB.instrs(); }

template <> class GenericSSAContext<MachineFunction> {
  const MachineRegisterInfo *RegInfo = nullptr;
  MachineFunction *MF = nullptr;

public:
  using BlockT = MachineBasicBlock;
  using FunctionT = MachineFunction;
  using InstructionT = MachineInstr;
  using ValueRefT = Register;
  using ConstValueRefT = Register;
  using UseT = MachineOperand;
  using DominatorTreeT = DominatorTreeBase<BlockT, false>;

  static constexpr Register ValueRefNull = 0;

  void setFunction(MachineFunction &Fn);
  MachineFunction *getFunction() const { return MF; }

  static MachineBasicBlock *getEntryBlock(MachineFunction &F);
  static void appendBlockDefs(SmallVectorImpl<Register> &defs,
                              const MachineBasicBlock &block);
  static void appendBlockTerms(SmallVectorImpl<MachineInstr *> &terms,
                               MachineBasicBlock &block);
  static void appendBlockTerms(SmallVectorImpl<const MachineInstr *> &terms,
                               const MachineBasicBlock &block);
  MachineBasicBlock *getDefBlock(Register) const;
  static bool isConstantOrUndefValuePhi(const MachineInstr &Phi);

  Printable print(const MachineBasicBlock *Block) const;
  Printable print(const MachineInstr *Inst) const;
  Printable print(Register Value) const;
};

using MachineSSAContext = GenericSSAContext<MachineFunction>;
} // namespace llvm

#endif // LLVM_CODEGEN_MACHINESSACONTEXT_H
