lib/Target/Hexagon/InstPrinter/HexagonInstPrinter.cpp

   1 //===- HexagonInstPrinter.cpp - Convert Hexagon MCInst to assembly syntax -===//
   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 prints an Hexagon MCInst to a .s file.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "HexagonAsmPrinter.h"
  15 #include "Hexagon.h"
  16 #include "HexagonInstPrinter.h"
  17 #include "MCTargetDesc/HexagonMCInst.h"
  18 #include "llvm/ADT/StringExtras.h"
  19 #include "llvm/MC/MCAsmInfo.h"
  20 #include "llvm/MC/MCExpr.h"
  21 #include "llvm/MC/MCInst.h"
  22 #include "llvm/Support/raw_ostream.h"
  23
  24 using namespace llvm;
  25
  26 #define DEBUG_TYPE "asm-printer"
  27
  28 #define GET_INSTRUCTION_NAME
  29 #include "HexagonGenAsmWriter.inc"
  30
  31 const char HexagonInstPrinter::PacketPadding = '\t';
  32 // Return the minimum value that a constant extendable operand can have
  33 // without being extended.
  34 static int getMinValue(uint64_t TSFlags) {
  35   unsigned isSigned =
  36       (TSFlags >> HexagonII::ExtentSignedPos) & HexagonII::ExtentSignedMask;
  37   unsigned bits =
  38       (TSFlags >> HexagonII::ExtentBitsPos) & HexagonII::ExtentBitsMask;
  39
  40   if (isSigned)
  41     return -1U << (bits - 1);
  42
  43   return 0;
  44 }
  45
  46 // Return the maximum value that a constant extendable operand can have
  47 // without being extended.
  48 static int getMaxValue(uint64_t TSFlags) {
  49   unsigned isSigned =
  50       (TSFlags >> HexagonII::ExtentSignedPos) & HexagonII::ExtentSignedMask;
  51   unsigned bits =
  52       (TSFlags >> HexagonII::ExtentBitsPos) & HexagonII::ExtentBitsMask;
  53
  54   if (isSigned)
  55     return ~(-1U << (bits - 1));
  56
  57   return ~(-1U << bits);
  58 }
  59
  60 // Return true if the instruction must be extended.
  61 static bool isExtended(uint64_t TSFlags) {
  62   return (TSFlags >> HexagonII::ExtendedPos) & HexagonII::ExtendedMask;
  63 }
  64
  65 // Currently just used in an assert statement
  66 static bool isExtendable(uint64_t TSFlags) LLVM_ATTRIBUTE_UNUSED;
  67 // Return true if the instruction may be extended based on the operand value.
  68 static bool isExtendable(uint64_t TSFlags) {
  69   return (TSFlags >> HexagonII::ExtendablePos) & HexagonII::ExtendableMask;
  70 }
  71
  72 StringRef HexagonInstPrinter::getOpcodeName(unsigned Opcode) const {
  73   return MII.getName(Opcode);
  74 }
  75
  76 StringRef HexagonInstPrinter::getRegName(unsigned RegNo) const {
  77   return getRegisterName(RegNo);
  78 }
  79
  80 void HexagonInstPrinter::printInst(const MCInst *MI, raw_ostream &O,
  81                                    StringRef Annot) {
  82   printInst((const HexagonMCInst*)(MI), O, Annot);
  83 }
  84
  85 void HexagonInstPrinter::printInst(const HexagonMCInst *MI, raw_ostream &O,
  86                                    StringRef Annot) {
  87   const char startPacket = '{',
  88              endPacket = '}';
  89   // TODO: add outer HW loop when it's supported too.
  90   if (MI->getOpcode() == Hexagon::ENDLOOP0) {
  91     // Ending a harware loop is different from ending an regular packet.
  92     assert(MI->isPacketEnd() && "Loop-end must also end the packet");
  93
  94     if (MI->isPacketBegin()) {
  95       // There must be a packet to end a loop.
  96       // FIXME: when shuffling is always run, this shouldn't be needed.
  97       HexagonMCInst Nop (Hexagon::NOP);
  98       StringRef NoAnnot;
  99
 100       Nop.setPacketBegin (MI->isPacketBegin());
 101       printInst (&Nop, O, NoAnnot);
 102     }
 103
 104     // Close the packet.
 105     if (MI->isPacketEnd())
 106       O << PacketPadding << endPacket;
 107
 108     printInstruction(MI, O);
 109   }
 110   else {
 111     // Prefix the insn opening the packet.
 112     if (MI->isPacketBegin())
 113       O << PacketPadding << startPacket << '\n';
 114
 115     printInstruction(MI, O);
 116
 117     // Suffix the insn closing the packet.
 118     if (MI->isPacketEnd())
 119       // Suffix the packet in a new line always, since the GNU assembler has
 120       // issues with a closing brace on the same line as CONST{32,64}.
 121       O << '\n' << PacketPadding << endPacket;
 122   }
 123
 124   printAnnotation(O, Annot);
 125 }
 126
 127 void HexagonInstPrinter::printOperand(const MCInst *MI, unsigned OpNo,
 128                                       raw_ostream &O) const {
 129   const MCOperand& MO = MI->getOperand(OpNo);
 130
 131   if (MO.isReg()) {
 132     O << getRegisterName(MO.getReg());
 133   } else if(MO.isExpr()) {
 134     O << *MO.getExpr();
 135   } else if(MO.isImm()) {
 136     printImmOperand(MI, OpNo, O);
 137   } else {
 138     llvm_unreachable("Unknown operand");
 139   }
 140 }
 141
 142 void HexagonInstPrinter::printImmOperand(const MCInst *MI, unsigned OpNo,
 143                                          raw_ostream &O) const {
 144   const MCOperand& MO = MI->getOperand(OpNo);
 145
 146   if(MO.isExpr()) {
 147     O << *MO.getExpr();
 148   } else if(MO.isImm()) {
 149     O << MI->getOperand(OpNo).getImm();
 150   } else {
 151     llvm_unreachable("Unknown operand");
 152   }
 153 }
 154
 155 void HexagonInstPrinter::printExtOperand(const MCInst *MI, unsigned OpNo,
 156                                          raw_ostream &O) const {
 157   const MCOperand &MO = MI->getOperand(OpNo);
 158   const MCInstrDesc &MII = getMII().get(MI->getOpcode());
 159
 160   assert((isExtendable(MII.TSFlags) || isExtended(MII.TSFlags)) &&
 161          "Expecting an extendable operand");
 162
 163   if (MO.isExpr() || isExtended(MII.TSFlags)) {
 164     O << "#";
 165   } else if (MO.isImm()) {
 166     int ImmValue = MO.getImm();
 167     if (ImmValue < getMinValue(MII.TSFlags) ||
 168         ImmValue > getMaxValue(MII.TSFlags))
 169       O << "#";
 170   }
 171   printOperand(MI, OpNo, O);
 172 }
 173
 174 void HexagonInstPrinter::printUnsignedImmOperand(const MCInst *MI,
 175                                     unsigned OpNo, raw_ostream &O) const {
 176   O << MI->getOperand(OpNo).getImm();
 177 }
 178
 179 void HexagonInstPrinter::printNegImmOperand(const MCInst *MI, unsigned OpNo,
 180                                             raw_ostream &O) const {
 181   O << -MI->getOperand(OpNo).getImm();
 182 }
 183
 184 void HexagonInstPrinter::printNOneImmOperand(const MCInst *MI, unsigned OpNo,
 185                                              raw_ostream &O) const {
 186   O << -1;
 187 }
 188
 189 void HexagonInstPrinter::printMEMriOperand(const MCInst *MI, unsigned OpNo,
 190                                            raw_ostream &O) const {
 191   const MCOperand& MO0 = MI->getOperand(OpNo);
 192   const MCOperand& MO1 = MI->getOperand(OpNo + 1);
 193
 194   O << getRegisterName(MO0.getReg());
 195   O << " + #" << MO1.getImm();
 196 }
 197
 198 void HexagonInstPrinter::printFrameIndexOperand(const MCInst *MI, unsigned OpNo,
 199                                                 raw_ostream &O) const {
 200   const MCOperand& MO0 = MI->getOperand(OpNo);
 201   const MCOperand& MO1 = MI->getOperand(OpNo + 1);
 202
 203   O << getRegisterName(MO0.getReg()) << ", #" << MO1.getImm();
 204 }
 205
 206 void HexagonInstPrinter::printGlobalOperand(const MCInst *MI, unsigned OpNo,
 207                                             raw_ostream &O) const {
 208   assert(MI->getOperand(OpNo).isExpr() && "Expecting expression");
 209
 210   printOperand(MI, OpNo, O);
 211 }
 212
 213 void HexagonInstPrinter::printJumpTable(const MCInst *MI, unsigned OpNo,
 214                                         raw_ostream &O) const {
 215   assert(MI->getOperand(OpNo).isExpr() && "Expecting expression");
 216
 217   printOperand(MI, OpNo, O);
 218 }
 219
 220 void HexagonInstPrinter::printConstantPool(const MCInst *MI, unsigned OpNo,
 221                                            raw_ostream &O) const {
 222   assert(MI->getOperand(OpNo).isExpr() && "Expecting expression");
 223
 224   printOperand(MI, OpNo, O);
 225 }
 226
 227 void HexagonInstPrinter::printBranchOperand(const MCInst *MI, unsigned OpNo,
 228                                             raw_ostream &O) const {
 229   // Branches can take an immediate operand.  This is used by the branch
 230   // selection pass to print $+8, an eight byte displacement from the PC.
 231   llvm_unreachable("Unknown branch operand.");
 232 }
 233
 234 void HexagonInstPrinter::printCallOperand(const MCInst *MI, unsigned OpNo,
 235                                           raw_ostream &O) const {
 236 }
 237
 238 void HexagonInstPrinter::printAbsAddrOperand(const MCInst *MI, unsigned OpNo,
 239                                              raw_ostream &O) const {
 240 }
 241
 242 void HexagonInstPrinter::printPredicateOperand(const MCInst *MI, unsigned OpNo,
 243                                                raw_ostream &O) const {
 244 }
 245
 246 void HexagonInstPrinter::printSymbol(const MCInst *MI, unsigned OpNo,
 247                                      raw_ostream &O, bool hi) const {
 248   assert(MI->getOperand(OpNo).isImm() && "Unknown symbol operand");
 249
 250   O << '#' << (hi ? "HI" : "LO") << "(#";
 251   printOperand(MI, OpNo, O);
 252   O << ')';
 253 }