[Hexagon] Creating HexagonMCInstrInfo namespace as landing zone for static functions...
[oota-llvm.git] / lib / Target / Hexagon / MCTargetDesc / HexagonMCInst.h
1 //===- HexagonMCInst.h - Hexagon sub-class of MCInst ----------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This class extends MCInst to allow some VLIW annotations.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #ifndef LLVM_LIB_TARGET_HEXAGON_MCTARGETDESC_HEXAGONMCINST_H
15 #define LLVM_LIB_TARGET_HEXAGON_MCTARGETDESC_HEXAGONMCINST_H
16
17 #include "HexagonTargetMachine.h"
18 #include "llvm/MC/MCInst.h"
19 #include <memory>
20
21 extern "C" void LLVMInitializeHexagonTargetMC();
22 namespace llvm {
23 class MCOperand;
24
25 class HexagonMCInst : public MCInst {
26   // Used to access TSFlags
27   std::unique_ptr <MCInstrInfo const> MCII;
28
29 public:
30   explicit HexagonMCInst();
31   HexagonMCInst(const MCInstrDesc &mcid);
32
33   static void AppendImplicitOperands(MCInst &MCI);
34   static std::bitset<16> GetImplicitBits(MCInst const &MCI);
35   static void SetImplicitBits(MCInst &MCI, std::bitset<16> Bits);
36   static void SanityCheckImplicitOperands(MCInst const &MCI) {
37     assert(MCI.getNumOperands() >= 2 && "At least the two implicit operands");
38     assert(MCI.getOperand(MCI.getNumOperands() - 1).isInst() &&
39            "Implicit bits and flags");
40     assert(MCI.getOperand(MCI.getNumOperands() - 2).isImm() &&
41            "Parent pointer");
42   }
43
44   void setPacketBegin(bool Y);
45   bool isPacketBegin() const;
46   static const size_t packetBeginIndex = 0;
47   void setPacketEnd(bool Y);
48   bool isPacketEnd() const;
49   static const size_t packetEndIndex = 1;
50   void resetPacket();
51
52   // Return the Hexagon ISA class for the insn.
53   unsigned getType() const;
54
55   // Return whether the insn is an actual insn.
56   bool isCanon() const;
57
58   // Return whether the insn is a prefix.
59   bool isPrefix() const;
60
61   // Return whether the insn is solo, i.e., cannot be in a packet.
62   bool isSolo() const;
63
64   // Return whether the instruction needs to be constant extended.
65   bool isConstExtended() const;
66
67   // Return constant extended operand number.
68   unsigned short getCExtOpNum(void) const;
69
70   // Return whether the insn is a new-value consumer.
71   bool isNewValue() const;
72
73   // Return whether the instruction is a legal new-value producer.
74   bool hasNewValue() const;
75
76   // Return the operand that consumes or produces a new value.
77   const MCOperand &getNewValue() const;
78
79   // Return number of bits in the constant extended operand.
80   unsigned getBitCount(void) const;
81
82 private:
83   // Return whether the instruction must be always extended.
84   bool isExtended() const;
85
86   // Return true if the insn may be extended based on the operand value.
87   bool isExtendable() const;
88
89   // Return true if the operand can be constant extended.
90   bool isOperandExtended(const unsigned short OperandNum) const;
91
92   // Return the min value that a constant extendable operand can have
93   // without being extended.
94   int getMinValue() const;
95 };
96 }
97
98 #endif