1 //===-- SystemZAsmPrinter.cpp - SystemZ LLVM assembly printer -------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // Streams SystemZ assembly language and associated data, in the form of
11 // MCInsts and MCExprs respectively.
13 //===----------------------------------------------------------------------===//
15 #include "SystemZAsmPrinter.h"
16 #include "InstPrinter/SystemZInstPrinter.h"
17 #include "SystemZConstantPoolValue.h"
18 #include "SystemZMCInstLower.h"
19 #include "llvm/CodeGen/MachineModuleInfoImpls.h"
20 #include "llvm/CodeGen/TargetLoweringObjectFileImpl.h"
21 #include "llvm/IR/Mangler.h"
22 #include "llvm/MC/MCExpr.h"
23 #include "llvm/MC/MCInstBuilder.h"
24 #include "llvm/MC/MCStreamer.h"
25 #include "llvm/Support/TargetRegistry.h"
29 // Return an RI instruction like MI with opcode Opcode, but with the
30 // GR64 register operands turned into GR32s.
31 static MCInst lowerRILow(const MachineInstr *MI, unsigned Opcode) {
33 return MCInstBuilder(Opcode)
34 .addReg(SystemZMC::getRegAsGR32(MI->getOperand(0).getReg()))
35 .addImm(MI->getOperand(1).getImm());
37 return MCInstBuilder(Opcode)
38 .addReg(SystemZMC::getRegAsGR32(MI->getOperand(0).getReg()))
39 .addReg(SystemZMC::getRegAsGR32(MI->getOperand(1).getReg()))
40 .addImm(MI->getOperand(2).getImm());
43 // Return an RI instruction like MI with opcode Opcode, but with the
44 // GR64 register operands turned into GRH32s.
45 static MCInst lowerRIHigh(const MachineInstr *MI, unsigned Opcode) {
47 return MCInstBuilder(Opcode)
48 .addReg(SystemZMC::getRegAsGRH32(MI->getOperand(0).getReg()))
49 .addImm(MI->getOperand(1).getImm());
51 return MCInstBuilder(Opcode)
52 .addReg(SystemZMC::getRegAsGRH32(MI->getOperand(0).getReg()))
53 .addReg(SystemZMC::getRegAsGRH32(MI->getOperand(1).getReg()))
54 .addImm(MI->getOperand(2).getImm());
57 // Return an RI instruction like MI with opcode Opcode, but with the
58 // R2 register turned into a GR64.
59 static MCInst lowerRIEfLow(const MachineInstr *MI, unsigned Opcode) {
60 return MCInstBuilder(Opcode)
61 .addReg(MI->getOperand(0).getReg())
62 .addReg(MI->getOperand(1).getReg())
63 .addReg(SystemZMC::getRegAsGR64(MI->getOperand(2).getReg()))
64 .addImm(MI->getOperand(3).getImm())
65 .addImm(MI->getOperand(4).getImm())
66 .addImm(MI->getOperand(5).getImm());
69 static const MCSymbolRefExpr *getTLSGetOffset(MCContext &Context) {
70 StringRef Name = "__tls_get_offset";
71 return MCSymbolRefExpr::create(Context.getOrCreateSymbol(Name),
72 MCSymbolRefExpr::VK_PLT,
76 static const MCSymbolRefExpr *getGlobalOffsetTable(MCContext &Context) {
77 StringRef Name = "_GLOBAL_OFFSET_TABLE_";
78 return MCSymbolRefExpr::create(Context.getOrCreateSymbol(Name),
79 MCSymbolRefExpr::VK_None,
83 // MI loads the high part of a vector from memory. Return an instruction
84 // that uses replicating vector load Opcode to do the same thing.
85 static MCInst lowerSubvectorLoad(const MachineInstr *MI, unsigned Opcode) {
86 return MCInstBuilder(Opcode)
87 .addReg(SystemZMC::getRegAsVR128(MI->getOperand(0).getReg()))
88 .addReg(MI->getOperand(1).getReg())
89 .addImm(MI->getOperand(2).getImm())
90 .addReg(MI->getOperand(3).getReg());
93 // MI stores the high part of a vector to memory. Return an instruction
94 // that uses elemental vector store Opcode to do the same thing.
95 static MCInst lowerSubvectorStore(const MachineInstr *MI, unsigned Opcode) {
96 return MCInstBuilder(Opcode)
97 .addReg(SystemZMC::getRegAsVR128(MI->getOperand(0).getReg()))
98 .addReg(MI->getOperand(1).getReg())
99 .addImm(MI->getOperand(2).getImm())
100 .addReg(MI->getOperand(3).getReg())
104 void SystemZAsmPrinter::EmitInstruction(const MachineInstr *MI) {
105 SystemZMCInstLower Lower(MF->getContext(), *this);
107 switch (MI->getOpcode()) {
108 case SystemZ::Return:
109 LoweredMI = MCInstBuilder(SystemZ::BR).addReg(SystemZ::R14D);
112 case SystemZ::CondReturn:
113 LoweredMI = MCInstBuilder(SystemZ::BCR)
114 .addImm(MI->getOperand(0).getImm())
115 .addImm(MI->getOperand(1).getImm())
116 .addReg(SystemZ::R14D);
119 case SystemZ::CRBReturn:
120 LoweredMI = MCInstBuilder(SystemZ::CRB)
121 .addReg(MI->getOperand(0).getReg())
122 .addReg(MI->getOperand(1).getReg())
123 .addImm(MI->getOperand(2).getImm())
124 .addReg(SystemZ::R14D)
128 case SystemZ::CGRBReturn:
129 LoweredMI = MCInstBuilder(SystemZ::CGRB)
130 .addReg(MI->getOperand(0).getReg())
131 .addReg(MI->getOperand(1).getReg())
132 .addImm(MI->getOperand(2).getImm())
133 .addReg(SystemZ::R14D)
137 case SystemZ::CIBReturn:
138 LoweredMI = MCInstBuilder(SystemZ::CIB)
139 .addReg(MI->getOperand(0).getReg())
140 .addImm(MI->getOperand(1).getImm())
141 .addImm(MI->getOperand(2).getImm())
142 .addReg(SystemZ::R14D)
146 case SystemZ::CGIBReturn:
147 LoweredMI = MCInstBuilder(SystemZ::CGIB)
148 .addReg(MI->getOperand(0).getReg())
149 .addImm(MI->getOperand(1).getImm())
150 .addImm(MI->getOperand(2).getImm())
151 .addReg(SystemZ::R14D)
155 case SystemZ::CLRBReturn:
156 LoweredMI = MCInstBuilder(SystemZ::CLRB)
157 .addReg(MI->getOperand(0).getReg())
158 .addReg(MI->getOperand(1).getReg())
159 .addImm(MI->getOperand(2).getImm())
160 .addReg(SystemZ::R14D)
164 case SystemZ::CLGRBReturn:
165 LoweredMI = MCInstBuilder(SystemZ::CLGRB)
166 .addReg(MI->getOperand(0).getReg())
167 .addReg(MI->getOperand(1).getReg())
168 .addImm(MI->getOperand(2).getImm())
169 .addReg(SystemZ::R14D)
173 case SystemZ::CLIBReturn:
174 LoweredMI = MCInstBuilder(SystemZ::CLIB)
175 .addReg(MI->getOperand(0).getReg())
176 .addImm(MI->getOperand(1).getImm())
177 .addImm(MI->getOperand(2).getImm())
178 .addReg(SystemZ::R14D)
182 case SystemZ::CLGIBReturn:
183 LoweredMI = MCInstBuilder(SystemZ::CLGIB)
184 .addReg(MI->getOperand(0).getReg())
185 .addImm(MI->getOperand(1).getImm())
186 .addImm(MI->getOperand(2).getImm())
187 .addReg(SystemZ::R14D)
191 case SystemZ::CallBRASL:
192 LoweredMI = MCInstBuilder(SystemZ::BRASL)
193 .addReg(SystemZ::R14D)
194 .addExpr(Lower.getExpr(MI->getOperand(0), MCSymbolRefExpr::VK_PLT));
197 case SystemZ::CallBASR:
198 LoweredMI = MCInstBuilder(SystemZ::BASR)
199 .addReg(SystemZ::R14D)
200 .addReg(MI->getOperand(0).getReg());
203 case SystemZ::CallJG:
204 LoweredMI = MCInstBuilder(SystemZ::JG)
205 .addExpr(Lower.getExpr(MI->getOperand(0), MCSymbolRefExpr::VK_PLT));
208 case SystemZ::CallBRCL:
209 LoweredMI = MCInstBuilder(SystemZ::BRCL)
210 .addImm(MI->getOperand(0).getImm())
211 .addImm(MI->getOperand(1).getImm())
212 .addExpr(Lower.getExpr(MI->getOperand(2), MCSymbolRefExpr::VK_PLT));
215 case SystemZ::CallBR:
216 LoweredMI = MCInstBuilder(SystemZ::BR).addReg(SystemZ::R1D);
219 case SystemZ::CallBCR:
220 LoweredMI = MCInstBuilder(SystemZ::BCR)
221 .addImm(MI->getOperand(0).getImm())
222 .addImm(MI->getOperand(1).getImm())
223 .addReg(SystemZ::R1D);
226 case SystemZ::CRBCall:
227 LoweredMI = MCInstBuilder(SystemZ::CRB)
228 .addReg(MI->getOperand(0).getReg())
229 .addReg(MI->getOperand(1).getReg())
230 .addImm(MI->getOperand(2).getImm())
231 .addReg(SystemZ::R1D)
235 case SystemZ::CGRBCall:
236 LoweredMI = MCInstBuilder(SystemZ::CGRB)
237 .addReg(MI->getOperand(0).getReg())
238 .addReg(MI->getOperand(1).getReg())
239 .addImm(MI->getOperand(2).getImm())
240 .addReg(SystemZ::R1D)
244 case SystemZ::CIBCall:
245 LoweredMI = MCInstBuilder(SystemZ::CIB)
246 .addReg(MI->getOperand(0).getReg())
247 .addImm(MI->getOperand(1).getImm())
248 .addImm(MI->getOperand(2).getImm())
249 .addReg(SystemZ::R1D)
253 case SystemZ::CGIBCall:
254 LoweredMI = MCInstBuilder(SystemZ::CGIB)
255 .addReg(MI->getOperand(0).getReg())
256 .addImm(MI->getOperand(1).getImm())
257 .addImm(MI->getOperand(2).getImm())
258 .addReg(SystemZ::R1D)
262 case SystemZ::CLRBCall:
263 LoweredMI = MCInstBuilder(SystemZ::CLRB)
264 .addReg(MI->getOperand(0).getReg())
265 .addReg(MI->getOperand(1).getReg())
266 .addImm(MI->getOperand(2).getImm())
267 .addReg(SystemZ::R1D)
271 case SystemZ::CLGRBCall:
272 LoweredMI = MCInstBuilder(SystemZ::CLGRB)
273 .addReg(MI->getOperand(0).getReg())
274 .addReg(MI->getOperand(1).getReg())
275 .addImm(MI->getOperand(2).getImm())
276 .addReg(SystemZ::R1D)
280 case SystemZ::CLIBCall:
281 LoweredMI = MCInstBuilder(SystemZ::CLIB)
282 .addReg(MI->getOperand(0).getReg())
283 .addImm(MI->getOperand(1).getImm())
284 .addImm(MI->getOperand(2).getImm())
285 .addReg(SystemZ::R1D)
289 case SystemZ::CLGIBCall:
290 LoweredMI = MCInstBuilder(SystemZ::CLGIB)
291 .addReg(MI->getOperand(0).getReg())
292 .addImm(MI->getOperand(1).getImm())
293 .addImm(MI->getOperand(2).getImm())
294 .addReg(SystemZ::R1D)
298 case SystemZ::TLS_GDCALL:
299 LoweredMI = MCInstBuilder(SystemZ::BRASL)
300 .addReg(SystemZ::R14D)
301 .addExpr(getTLSGetOffset(MF->getContext()))
302 .addExpr(Lower.getExpr(MI->getOperand(0), MCSymbolRefExpr::VK_TLSGD));
305 case SystemZ::TLS_LDCALL:
306 LoweredMI = MCInstBuilder(SystemZ::BRASL)
307 .addReg(SystemZ::R14D)
308 .addExpr(getTLSGetOffset(MF->getContext()))
309 .addExpr(Lower.getExpr(MI->getOperand(0), MCSymbolRefExpr::VK_TLSLDM));
313 LoweredMI = MCInstBuilder(SystemZ::LARL)
314 .addReg(MI->getOperand(0).getReg())
315 .addExpr(getGlobalOffsetTable(MF->getContext()));
318 case SystemZ::IILF64:
319 LoweredMI = MCInstBuilder(SystemZ::IILF)
320 .addReg(SystemZMC::getRegAsGR32(MI->getOperand(0).getReg()))
321 .addImm(MI->getOperand(2).getImm());
324 case SystemZ::IIHF64:
325 LoweredMI = MCInstBuilder(SystemZ::IIHF)
326 .addReg(SystemZMC::getRegAsGRH32(MI->getOperand(0).getReg()))
327 .addImm(MI->getOperand(2).getImm());
330 case SystemZ::RISBHH:
331 case SystemZ::RISBHL:
332 LoweredMI = lowerRIEfLow(MI, SystemZ::RISBHG);
335 case SystemZ::RISBLH:
336 case SystemZ::RISBLL:
337 LoweredMI = lowerRIEfLow(MI, SystemZ::RISBLG);
340 case SystemZ::VLVGP32:
341 LoweredMI = MCInstBuilder(SystemZ::VLVGP)
342 .addReg(MI->getOperand(0).getReg())
343 .addReg(SystemZMC::getRegAsGR64(MI->getOperand(1).getReg()))
344 .addReg(SystemZMC::getRegAsGR64(MI->getOperand(2).getReg()));
349 LoweredMI = MCInstBuilder(SystemZ::VLR)
350 .addReg(SystemZMC::getRegAsVR128(MI->getOperand(0).getReg()))
351 .addReg(SystemZMC::getRegAsVR128(MI->getOperand(1).getReg()));
355 LoweredMI = lowerSubvectorLoad(MI, SystemZ::VLREPF);
359 LoweredMI = lowerSubvectorLoad(MI, SystemZ::VLREPG);
363 LoweredMI = lowerSubvectorStore(MI, SystemZ::VSTEF);
367 LoweredMI = lowerSubvectorStore(MI, SystemZ::VSTEG);
371 LoweredMI = MCInstBuilder(SystemZ::VLGVF)
372 .addReg(SystemZMC::getRegAsGR64(MI->getOperand(0).getReg()))
373 .addReg(SystemZMC::getRegAsVR128(MI->getOperand(1).getReg()))
374 .addReg(0).addImm(0);
378 LoweredMI = MCInstBuilder(SystemZ::VLVGF)
379 .addReg(SystemZMC::getRegAsVR128(MI->getOperand(0).getReg()))
380 .addReg(SystemZMC::getRegAsVR128(MI->getOperand(0).getReg()))
381 .addReg(MI->getOperand(1).getReg())
382 .addReg(0).addImm(0);
385 #define LOWER_LOW(NAME) \
386 case SystemZ::NAME##64: LoweredMI = lowerRILow(MI, SystemZ::NAME); break
402 #define LOWER_HIGH(NAME) \
403 case SystemZ::NAME##64: LoweredMI = lowerRIHigh(MI, SystemZ::NAME); break
419 case SystemZ::Serialize:
420 if (MF->getSubtarget<SystemZSubtarget>().hasFastSerialization())
421 LoweredMI = MCInstBuilder(SystemZ::BCRAsm)
422 .addImm(14).addReg(SystemZ::R0D);
424 LoweredMI = MCInstBuilder(SystemZ::BCRAsm)
425 .addImm(15).addReg(SystemZ::R0D);
428 // Emit nothing here but a comment if we can.
429 case SystemZ::MemBarrier:
430 OutStreamer->emitRawComment("MEMBARRIER");
433 // We want to emit "j .+2" for traps, jumping to the relative immediate field
434 // of the jump instruction, which is an illegal instruction. We cannot emit a
435 // "." symbol, so create and emit a temp label before the instruction and use
437 case SystemZ::Trap: {
438 MCSymbol *DotSym = OutContext.createTempSymbol();
439 OutStreamer->EmitLabel(DotSym);
441 const MCSymbolRefExpr *Expr = MCSymbolRefExpr::create(DotSym, OutContext);
442 const MCConstantExpr *ConstExpr = MCConstantExpr::create(2, OutContext);
443 LoweredMI = MCInstBuilder(SystemZ::J)
444 .addExpr(MCBinaryExpr::createAdd(Expr, ConstExpr, OutContext));
448 // Conditional traps will create a branch on condition instruction that jumps
449 // to the relative immediate field of the jump instruction. (eg. "jo .+2")
450 case SystemZ::CondTrap: {
451 MCSymbol *DotSym = OutContext.createTempSymbol();
452 OutStreamer->EmitLabel(DotSym);
454 const MCSymbolRefExpr *Expr = MCSymbolRefExpr::create(DotSym, OutContext);
455 const MCConstantExpr *ConstExpr = MCConstantExpr::create(2, OutContext);
456 LoweredMI = MCInstBuilder(SystemZ::BRC)
457 .addImm(MI->getOperand(0).getImm())
458 .addImm(MI->getOperand(1).getImm())
459 .addExpr(MCBinaryExpr::createAdd(Expr, ConstExpr, OutContext));
463 case TargetOpcode::STACKMAP:
467 case TargetOpcode::PATCHPOINT:
468 LowerPATCHPOINT(*MI, Lower);
472 Lower.lower(MI, LoweredMI);
475 EmitToStreamer(*OutStreamer, LoweredMI);
479 // Emit the largest nop instruction smaller than or equal to NumBytes
480 // bytes. Return the size of nop emitted.
481 static unsigned EmitNop(MCContext &OutContext, MCStreamer &OutStreamer,
482 unsigned NumBytes, const MCSubtargetInfo &STI) {
484 llvm_unreachable("Zero nops?");
487 else if (NumBytes < 4) {
488 OutStreamer.EmitInstruction(MCInstBuilder(SystemZ::BCRAsm)
489 .addImm(0).addReg(SystemZ::R0D), STI);
492 else if (NumBytes < 6) {
493 OutStreamer.EmitInstruction(MCInstBuilder(SystemZ::BCAsm)
494 .addImm(0).addReg(0).addImm(0).addReg(0),
499 MCSymbol *DotSym = OutContext.createTempSymbol();
500 const MCSymbolRefExpr *Dot = MCSymbolRefExpr::create(DotSym, OutContext);
501 OutStreamer.EmitInstruction(MCInstBuilder(SystemZ::BRCLAsm)
502 .addImm(0).addExpr(Dot), STI);
503 OutStreamer.EmitLabel(DotSym);
508 void SystemZAsmPrinter::LowerSTACKMAP(const MachineInstr &MI) {
509 const SystemZInstrInfo *TII =
510 static_cast<const SystemZInstrInfo *>(MF->getSubtarget().getInstrInfo());
512 unsigned NumNOPBytes = MI.getOperand(1).getImm();
514 SM.recordStackMap(MI);
515 assert(NumNOPBytes % 2 == 0 && "Invalid number of NOP bytes requested!");
517 // Scan ahead to trim the shadow.
518 unsigned ShadowBytes = 0;
519 const MachineBasicBlock &MBB = *MI.getParent();
520 MachineBasicBlock::const_iterator MII(MI);
522 while (ShadowBytes < NumNOPBytes) {
523 if (MII == MBB.end() ||
524 MII->getOpcode() == TargetOpcode::PATCHPOINT ||
525 MII->getOpcode() == TargetOpcode::STACKMAP)
527 ShadowBytes += TII->getInstSizeInBytes(*MII);
534 while (ShadowBytes < NumNOPBytes)
535 ShadowBytes += EmitNop(OutContext, *OutStreamer, NumNOPBytes - ShadowBytes,
539 // Lower a patchpoint of the form:
540 // [<def>], <id>, <numBytes>, <target>, <numArgs>
541 void SystemZAsmPrinter::LowerPATCHPOINT(const MachineInstr &MI,
542 SystemZMCInstLower &Lower) {
543 SM.recordPatchPoint(MI);
544 PatchPointOpers Opers(&MI);
546 unsigned EncodedBytes = 0;
547 const MachineOperand &CalleeMO = Opers.getCallTarget();
549 if (CalleeMO.isImm()) {
550 uint64_t CallTarget = CalleeMO.getImm();
552 unsigned ScratchIdx = -1;
553 unsigned ScratchReg = 0;
555 ScratchIdx = Opers.getNextScratchIdx(ScratchIdx + 1);
556 ScratchReg = MI.getOperand(ScratchIdx).getReg();
557 } while (ScratchReg == SystemZ::R0D);
559 // Materialize the call target address
560 EmitToStreamer(*OutStreamer, MCInstBuilder(SystemZ::LLILF)
562 .addImm(CallTarget & 0xFFFFFFFF));
564 if (CallTarget >> 32) {
565 EmitToStreamer(*OutStreamer, MCInstBuilder(SystemZ::IIHF)
567 .addImm(CallTarget >> 32));
571 EmitToStreamer(*OutStreamer, MCInstBuilder(SystemZ::BASR)
572 .addReg(SystemZ::R14D)
573 .addReg(ScratchReg));
576 } else if (CalleeMO.isGlobal()) {
577 const MCExpr *Expr = Lower.getExpr(CalleeMO, MCSymbolRefExpr::VK_PLT);
578 EmitToStreamer(*OutStreamer, MCInstBuilder(SystemZ::BRASL)
579 .addReg(SystemZ::R14D)
585 unsigned NumBytes = Opers.getNumPatchBytes();
586 assert(NumBytes >= EncodedBytes &&
587 "Patchpoint can't request size less than the length of a call.");
588 assert((NumBytes - EncodedBytes) % 2 == 0 &&
589 "Invalid number of NOP bytes requested!");
590 while (EncodedBytes < NumBytes)
591 EncodedBytes += EmitNop(OutContext, *OutStreamer, NumBytes - EncodedBytes,
595 // Convert a SystemZ-specific constant pool modifier into the associated
596 // MCSymbolRefExpr variant kind.
597 static MCSymbolRefExpr::VariantKind
598 getModifierVariantKind(SystemZCP::SystemZCPModifier Modifier) {
600 case SystemZCP::TLSGD: return MCSymbolRefExpr::VK_TLSGD;
601 case SystemZCP::TLSLDM: return MCSymbolRefExpr::VK_TLSLDM;
602 case SystemZCP::DTPOFF: return MCSymbolRefExpr::VK_DTPOFF;
603 case SystemZCP::NTPOFF: return MCSymbolRefExpr::VK_NTPOFF;
605 llvm_unreachable("Invalid SystemCPModifier!");
608 void SystemZAsmPrinter::
609 EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV) {
610 auto *ZCPV = static_cast<SystemZConstantPoolValue*>(MCPV);
613 MCSymbolRefExpr::create(getSymbol(ZCPV->getGlobalValue()),
614 getModifierVariantKind(ZCPV->getModifier()),
616 uint64_t Size = getDataLayout().getTypeAllocSize(ZCPV->getType());
618 OutStreamer->EmitValue(Expr, Size);
621 bool SystemZAsmPrinter::PrintAsmOperand(const MachineInstr *MI,
624 const char *ExtraCode,
626 if (ExtraCode && *ExtraCode == 'n') {
627 if (!MI->getOperand(OpNo).isImm())
629 OS << -int64_t(MI->getOperand(OpNo).getImm());
631 SystemZMCInstLower Lower(MF->getContext(), *this);
632 MCOperand MO(Lower.lowerOperand(MI->getOperand(OpNo)));
633 SystemZInstPrinter::printOperand(MO, MAI, OS);
638 bool SystemZAsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI,
641 const char *ExtraCode,
643 SystemZInstPrinter::printAddress(MI->getOperand(OpNo).getReg(),
644 MI->getOperand(OpNo + 1).getImm(),
645 MI->getOperand(OpNo + 2).getReg(), OS);
649 void SystemZAsmPrinter::EmitEndOfAsmFile(Module &M) {
653 // Force static initialization.
654 extern "C" void LLVMInitializeSystemZAsmPrinter() {
655 RegisterAsmPrinter<SystemZAsmPrinter> X(getTheSystemZTarget());