//===------- ColossusMCInstrInfo.h - Colossus sub-class of MCInst ---------===//
//    Copyright (c) 2023 Graphcore Ltd. All Rights Reserved.
//     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.
// --- LLVM Exceptions to the Apache 2.0 License ----
//
// As an exception, if, as a result of your compiling your source code, portions
// of this Software are embedded into an Object form of such source code, you
// may redistribute such embedded portions in such Object form without complying
// with the conditions of Sections 4(a), 4(b) and 4(d) of the License.
//
// In addition, if you combine or link compiled forms of this Software with
// software that is licensed under the GPLv2 ("Combined Software") and if a
// court of competent jurisdiction determines that the patent provision (Section
// 3), the indemnity provision (Section 9) or other Section of the License
// conflicts with the conditions of the GPLv2, you may retroactively and
// prospectively choose to deem waived or otherwise exclude such Section(s) of
// the License, but only in their entirety and only with respect to the Combined
// Software.
//
//===----------------------------------------------------------------------===//
//
// Utility functions for Colossus specific MCInst queries
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_LIB_TARGET_COLOSSUS_MCTARGETDESC_COLOSSUSMCINSTRINFO_H
#define LLVM_LIB_TARGET_COLOSSUS_MCTARGETDESC_COLOSSUSMCINSTRINFO_H

#include "ColossusTargetMachine.h"
#include "llvm/MC/MCInst.h"
#include "ColossusDefinesGenerated.h"

#define MAX_NUM_INSTRUCTIONS_IN_BUNDLE (2)

namespace llvm {

namespace ColossusMCInstrInfo {

// These values must match the values emitted by Generation/LLVMGeneration.cpp
// and encoded into the TSFlags in ColossusInstrInfoGenerated.td.
enum OperandModifier {
  OperandNoPostInc = 0,
  OperandPostInc = 1,
  OperandPostIncOffset = 2,
  OperandPostIncDelta = 3,
  OperandPostMod = 4
};


bool isCoIssue(MCInst &Instr, uint32_t Insn = 0);

bool canCoIssue(const MCInstrInfo &MII, unsigned opcode);
inline bool canCoIssue(const MCInstrInfo &MII, const MCInst &Instr) {
  return canCoIssue(MII, Instr.getOpcode());
}

bool isControl(const MCInstrInfo &MII, unsigned opcode);
inline bool isControl(const MCInstrInfo &MII, const MCInst &Instr) {
  return isControl(MII, Instr.getOpcode());
}

bool isSystem(const MCInstrInfo &MII, unsigned opcode);
inline bool isSystem(const MCInstrInfo &MII, const MCInst &Instr) {
  return isSystem(MII, Instr.getOpcode());
}

bool isRepeat(const MCInst &Instr);
bool isFnop(const MCSubtargetInfo &STI, const MCInst &Inst);
bool isBarrier(const MCInst &Inst);

void SetCoIssue(MCInst &Instr, int Set);

unsigned getLane(const MCInstrInfo &MII, unsigned opcode);
inline unsigned getLane(const MCInstrInfo &MII, const MCInst &Instr) {
  return getLane(MII, Instr.getOpcode());
}

OperandModifier getOperandModifier(const MCInstrInfo &MII, const MCInst &Instr,
                                   unsigned OpNo);
}
}

#endif