| 1 | //===- LoongArchInstPrinter.cpp - Convert LoongArch MCInst to asm syntax --===// |
| 2 | // |
| 3 | // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. |
| 4 | // See https://llvm.org/LICENSE.txt for license information. |
| 5 | // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception |
| 6 | // |
| 7 | //===----------------------------------------------------------------------===// |
| 8 | // |
| 9 | // This class prints an LoongArch MCInst to a .s file. |
| 10 | // |
| 11 | //===----------------------------------------------------------------------===// |
| 12 | |
| 13 | #include "LoongArchInstPrinter.h" |
| 14 | #include "LoongArchMCTargetDesc.h" |
| 15 | #include "llvm/MC/MCAsmInfo.h" |
| 16 | #include "llvm/MC/MCInst.h" |
| 17 | #include "llvm/MC/MCSubtargetInfo.h" |
| 18 | #include "llvm/MC/MCSymbol.h" |
| 19 | #include "llvm/Support/CommandLine.h" |
| 20 | using namespace llvm; |
| 21 | |
| 22 | #define DEBUG_TYPE "loongarch-asm-printer" |
| 23 | |
| 24 | // Include the auto-generated portion of the assembly writer. |
| 25 | #define PRINT_ALIAS_INSTR |
| 26 | #include "LoongArchGenAsmWriter.inc" |
| 27 | |
| 28 | static cl::opt<bool> |
| 29 | NoAliases("loongarch-no-aliases" , |
| 30 | cl::desc("Disable the emission of assembler pseudo instructions" ), |
| 31 | cl::init(Val: false), cl::Hidden); |
| 32 | |
| 33 | static cl::opt<bool> |
| 34 | NumericReg("loongarch-numeric-reg" , |
| 35 | cl::desc("Print numeric register names rather than the ABI " |
| 36 | "names (such as $r0 instead of $zero)" ), |
| 37 | cl::init(Val: false), cl::Hidden); |
| 38 | |
| 39 | static cl::opt<bool> |
| 40 | Annotate("loongarch-annotate" , |
| 41 | cl::desc("Print human-readable annotations for some instructions " |
| 42 | "(such as the barrier semantics of dbar hints)" ), |
| 43 | cl::init(Val: false), cl::Hidden); |
| 44 | |
| 45 | // The command-line flag above is used by llvm-mc and llc. It can be used by |
| 46 | // `llvm-objdump`, but we override the value here to handle options passed to |
| 47 | // `llvm-objdump` with `-M` (which matches GNU objdump). There did not seem to |
| 48 | // be an easier way to allow these options in all these tools, without doing it |
| 49 | // this way. |
| 50 | bool LoongArchInstPrinter::applyTargetSpecificCLOption(StringRef Opt) { |
| 51 | if (Opt == "no-aliases" ) { |
| 52 | PrintAliases = false; |
| 53 | return true; |
| 54 | } |
| 55 | |
| 56 | if (Opt == "numeric" ) { |
| 57 | NumericReg = true; |
| 58 | return true; |
| 59 | } |
| 60 | |
| 61 | if (Opt == "annotate" ) { |
| 62 | Annotate = true; |
| 63 | return true; |
| 64 | } |
| 65 | |
| 66 | return false; |
| 67 | } |
| 68 | |
| 69 | // Describe the barrier semantics of a DBAR hint in the same format as GNU |
| 70 | // objdump's `-M annotate`. For hints 0-0x1f the layout is `CRW|RW`, where the |
| 71 | // left side of `|` lists the preceding accesses (R: loads, W: stores) and the |
| 72 | // right side the succeeding accesses ordered by the barrier, and `C` (Cached) |
| 73 | // is printed when bit 4 is set. 0x700 is the same-address read-after-read |
| 74 | // barrier. Other hints are reserved and are not annotated. For more detailed |
| 75 | // description, see LoongArch Documents Volume 1. |
| 76 | static void printDbarAnnotation(uint64_t Hint, raw_ostream &OS) { |
| 77 | if (Hint == 0x700) { |
| 78 | OS << "SA-RAR\n" ; |
| 79 | return; |
| 80 | } |
| 81 | // 0xf and 0x1f are reserved. |
| 82 | if (Hint > 0x1f || (Hint & 0xf) == 0xf) |
| 83 | return; |
| 84 | char Buf[] = " | " ; |
| 85 | if (Hint & 0x10) |
| 86 | Buf[0] = 'C'; |
| 87 | if (!(Hint & 0x8)) |
| 88 | Buf[1] = 'R'; |
| 89 | if (!(Hint & 0x4)) |
| 90 | Buf[2] = 'W'; |
| 91 | if (!(Hint & 0x2)) |
| 92 | Buf[4] = 'R'; |
| 93 | if (!(Hint & 0x1)) |
| 94 | Buf[5] = 'W'; |
| 95 | |
| 96 | OS << StringRef(Buf).rtrim() << '\n'; |
| 97 | } |
| 98 | |
| 99 | void LoongArchInstPrinter::printInst(const MCInst *MI, uint64_t Address, |
| 100 | StringRef Annot, |
| 101 | const MCSubtargetInfo &STI, |
| 102 | raw_ostream &O) { |
| 103 | if (!PrintAliases || NoAliases || !printAliasInstr(MI, Address, STI, OS&: O)) |
| 104 | printInstruction(MI, Address, STI, O); |
| 105 | if (Annotate && CommentStream && MI->getOpcode() == LoongArch::DBAR) |
| 106 | printDbarAnnotation(Hint: MI->getOperand(i: 0).getImm(), OS&: *CommentStream); |
| 107 | printAnnotation(OS&: O, Annot); |
| 108 | } |
| 109 | |
| 110 | void LoongArchInstPrinter::printRegName(raw_ostream &O, MCRegister Reg) { |
| 111 | markup(OS&: O, M: Markup::Register) << '$' << getRegisterName(Reg); |
| 112 | } |
| 113 | |
| 114 | void LoongArchInstPrinter::printOperand(const MCInst *MI, unsigned OpNo, |
| 115 | const MCSubtargetInfo &STI, |
| 116 | raw_ostream &O) { |
| 117 | const MCOperand &MO = MI->getOperand(i: OpNo); |
| 118 | |
| 119 | if (MO.isReg()) { |
| 120 | printRegName(O, Reg: MO.getReg()); |
| 121 | return; |
| 122 | } |
| 123 | |
| 124 | if (MO.isImm()) { |
| 125 | markup(OS&: O, M: Markup::Immediate) << formatImm(Value: MO.getImm()); |
| 126 | return; |
| 127 | } |
| 128 | |
| 129 | assert(MO.isExpr() && "Unknown operand kind in printOperand" ); |
| 130 | MAI.printExpr(O, *MO.getExpr()); |
| 131 | } |
| 132 | |
| 133 | void LoongArchInstPrinter::printAtomicMemOp(const MCInst *MI, unsigned OpNo, |
| 134 | const MCSubtargetInfo &STI, |
| 135 | raw_ostream &O) { |
| 136 | const MCOperand &MO = MI->getOperand(i: OpNo); |
| 137 | assert(MO.isReg() && "printAtomicMemOp can only print register operands" ); |
| 138 | printRegName(O, Reg: MO.getReg()); |
| 139 | } |
| 140 | |
| 141 | void LoongArchInstPrinter::printCFRSetDest(const MCInst *MI, unsigned OpNo, |
| 142 | const MCSubtargetInfo &STI, |
| 143 | raw_ostream &O) { |
| 144 | printRegName(O, Reg: MI->getOperand(i: OpNo).getReg()); |
| 145 | O << ", " ; |
| 146 | printRegName(O, Reg: LoongArch::F0); |
| 147 | O << ", " ; |
| 148 | printRegName(O, Reg: LoongArch::F0); |
| 149 | } |
| 150 | |
| 151 | void LoongArchInstPrinter::printBranchOperand(const MCInst *MI, |
| 152 | uint64_t Address, unsigned OpNo, |
| 153 | const MCSubtargetInfo &STI, |
| 154 | raw_ostream &O) { |
| 155 | // Do not print the numeric target address when symbolizing. |
| 156 | if (SymbolizeOperands) |
| 157 | return; |
| 158 | |
| 159 | return printOperand(MI, OpNo, STI, O); |
| 160 | } |
| 161 | |
| 162 | const char *LoongArchInstPrinter::getRegisterName(MCRegister Reg) { |
| 163 | // Default print reg alias name |
| 164 | return getRegisterName(Reg, AltIdx: NumericReg ? LoongArch::NoRegAltName |
| 165 | : LoongArch::RegAliasName); |
| 166 | } |
| 167 | |