[cleanup] Re-sort all the #include lines in LLVM using
[oota-llvm.git] / lib / Target / R600 / InstPrinter / AMDGPUInstPrinter.cpp
1 //===-- AMDGPUInstPrinter.cpp - AMDGPU MC Inst -> ASM ---------------------===//
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 // \file
9 //===----------------------------------------------------------------------===//
10
11 #include "AMDGPUInstPrinter.h"
12 #include "MCTargetDesc/AMDGPUMCTargetDesc.h"
13 #include "SIDefines.h"
14 #include "llvm/MC/MCExpr.h"
15 #include "llvm/MC/MCInst.h"
16 #include "llvm/MC/MCInstrInfo.h"
17 #include "llvm/MC/MCRegisterInfo.h"
18 #include "llvm/Support/MathExtras.h"
19
20 using namespace llvm;
21
22 void AMDGPUInstPrinter::printInst(const MCInst *MI, raw_ostream &OS,
23                              StringRef Annot) {
24   OS.flush();
25   printInstruction(MI, OS);
26
27   printAnnotation(OS, Annot);
28 }
29
30 void AMDGPUInstPrinter::printU8ImmOperand(const MCInst *MI, unsigned OpNo,
31                                            raw_ostream &O) {
32   O << formatHex(MI->getOperand(OpNo).getImm() & 0xff);
33 }
34
35 void AMDGPUInstPrinter::printU16ImmOperand(const MCInst *MI, unsigned OpNo,
36                                            raw_ostream &O) {
37   O << formatHex(MI->getOperand(OpNo).getImm() & 0xffff);
38 }
39
40 void AMDGPUInstPrinter::printU32ImmOperand(const MCInst *MI, unsigned OpNo,
41                                            raw_ostream &O) {
42   O << formatHex(MI->getOperand(OpNo).getImm() & 0xffffffff);
43 }
44
45 void AMDGPUInstPrinter::printU8ImmDecOperand(const MCInst *MI, unsigned OpNo,
46                                              raw_ostream &O) {
47   O << formatDec(MI->getOperand(OpNo).getImm() & 0xff);
48 }
49
50 void AMDGPUInstPrinter::printU16ImmDecOperand(const MCInst *MI, unsigned OpNo,
51                                               raw_ostream &O) {
52   O << formatDec(MI->getOperand(OpNo).getImm() & 0xffff);
53 }
54
55 void AMDGPUInstPrinter::printOffen(const MCInst *MI, unsigned OpNo,
56                                    raw_ostream &O) {
57   if (MI->getOperand(OpNo).getImm())
58     O << " offen";
59 }
60
61 void AMDGPUInstPrinter::printIdxen(const MCInst *MI, unsigned OpNo,
62                                    raw_ostream &O) {
63   if (MI->getOperand(OpNo).getImm())
64     O << " idxen";
65 }
66
67 void AMDGPUInstPrinter::printAddr64(const MCInst *MI, unsigned OpNo,
68                                     raw_ostream &O) {
69   if (MI->getOperand(OpNo).getImm())
70     O << " addr64";
71 }
72
73 void AMDGPUInstPrinter::printMBUFOffset(const MCInst *MI, unsigned OpNo,
74                                         raw_ostream &O) {
75   if (MI->getOperand(OpNo).getImm()) {
76     O << " offset:";
77     printU16ImmDecOperand(MI, OpNo, O);
78   }
79 }
80
81 void AMDGPUInstPrinter::printDSOffset(const MCInst *MI, unsigned OpNo,
82                                       raw_ostream &O) {
83   uint16_t Imm = MI->getOperand(OpNo).getImm();
84   if (Imm != 0) {
85     O << " offset:";
86     printU16ImmDecOperand(MI, OpNo, O);
87   }
88 }
89
90 void AMDGPUInstPrinter::printDSOffset0(const MCInst *MI, unsigned OpNo,
91                                         raw_ostream &O) {
92   O << " offset0:";
93   printU8ImmDecOperand(MI, OpNo, O);
94 }
95
96 void AMDGPUInstPrinter::printDSOffset1(const MCInst *MI, unsigned OpNo,
97                                         raw_ostream &O) {
98   O << " offset1:";
99   printU8ImmDecOperand(MI, OpNo, O);
100 }
101
102 void AMDGPUInstPrinter::printGLC(const MCInst *MI, unsigned OpNo,
103                                  raw_ostream &O) {
104   if (MI->getOperand(OpNo).getImm())
105     O << " glc";
106 }
107
108 void AMDGPUInstPrinter::printSLC(const MCInst *MI, unsigned OpNo,
109                                  raw_ostream &O) {
110   if (MI->getOperand(OpNo).getImm())
111     O << " slc";
112 }
113
114 void AMDGPUInstPrinter::printTFE(const MCInst *MI, unsigned OpNo,
115                                  raw_ostream &O) {
116   if (MI->getOperand(OpNo).getImm())
117     O << " tfe";
118 }
119
120 void AMDGPUInstPrinter::printRegOperand(unsigned reg, raw_ostream &O) {
121   switch (reg) {
122   case AMDGPU::VCC:
123     O << "vcc";
124     return;
125   case AMDGPU::SCC:
126     O << "scc";
127     return;
128   case AMDGPU::EXEC:
129     O << "exec";
130     return;
131   case AMDGPU::M0:
132     O << "m0";
133     return;
134   case AMDGPU::FLAT_SCR:
135     O << "flat_scratch";
136     return;
137   case AMDGPU::VCC_LO:
138     O << "vcc_lo";
139     return;
140   case AMDGPU::VCC_HI:
141     O << "vcc_hi";
142     return;
143   case AMDGPU::EXEC_LO:
144     O << "exec_lo";
145     return;
146   case AMDGPU::EXEC_HI:
147     O << "exec_hi";
148     return;
149   case AMDGPU::FLAT_SCR_LO:
150     O << "flat_scratch_lo";
151     return;
152   case AMDGPU::FLAT_SCR_HI:
153     O << "flat_scratch_hi";
154     return;
155   default:
156     break;
157   }
158
159   char Type;
160   unsigned NumRegs;
161
162   if (MRI.getRegClass(AMDGPU::VGPR_32RegClassID).contains(reg)) {
163     Type = 'v';
164     NumRegs = 1;
165   } else  if (MRI.getRegClass(AMDGPU::SGPR_32RegClassID).contains(reg)) {
166     Type = 's';
167     NumRegs = 1;
168   } else if (MRI.getRegClass(AMDGPU::VReg_64RegClassID).contains(reg)) {
169     Type = 'v';
170     NumRegs = 2;
171   } else  if (MRI.getRegClass(AMDGPU::SReg_64RegClassID).contains(reg)) {
172     Type = 's';
173     NumRegs = 2;
174   } else if (MRI.getRegClass(AMDGPU::VReg_128RegClassID).contains(reg)) {
175     Type = 'v';
176     NumRegs = 4;
177   } else  if (MRI.getRegClass(AMDGPU::SReg_128RegClassID).contains(reg)) {
178     Type = 's';
179     NumRegs = 4;
180   } else if (MRI.getRegClass(AMDGPU::VReg_96RegClassID).contains(reg)) {
181     Type = 'v';
182     NumRegs = 3;
183   } else if (MRI.getRegClass(AMDGPU::VReg_256RegClassID).contains(reg)) {
184     Type = 'v';
185     NumRegs = 8;
186   } else if (MRI.getRegClass(AMDGPU::SReg_256RegClassID).contains(reg)) {
187     Type = 's';
188     NumRegs = 8;
189   } else if (MRI.getRegClass(AMDGPU::VReg_512RegClassID).contains(reg)) {
190     Type = 'v';
191     NumRegs = 16;
192   } else if (MRI.getRegClass(AMDGPU::SReg_512RegClassID).contains(reg)) {
193     Type = 's';
194     NumRegs = 16;
195   } else {
196     O << getRegisterName(reg);
197     return;
198   }
199
200   // The low 8 bits of the encoding value is the register index, for both VGPRs
201   // and SGPRs.
202   unsigned RegIdx = MRI.getEncodingValue(reg) & ((1 << 8) - 1);
203   if (NumRegs == 1) {
204     O << Type << RegIdx;
205     return;
206   }
207
208   O << Type << '[' << RegIdx << ':' << (RegIdx + NumRegs - 1) << ']';
209 }
210
211 void AMDGPUInstPrinter::printImmediate32(uint32_t Imm, raw_ostream &O) {
212   int32_t SImm = static_cast<int32_t>(Imm);
213   if (SImm >= -16 && SImm <= 64) {
214     O << SImm;
215     return;
216   }
217
218   if (Imm == FloatToBits(0.0f))
219     O << "0.0";
220   else if (Imm == FloatToBits(1.0f))
221     O << "1.0";
222   else if (Imm == FloatToBits(-1.0f))
223     O << "-1.0";
224   else if (Imm == FloatToBits(0.5f))
225     O << "0.5";
226   else if (Imm == FloatToBits(-0.5f))
227     O << "-0.5";
228   else if (Imm == FloatToBits(2.0f))
229     O << "2.0";
230   else if (Imm == FloatToBits(-2.0f))
231     O << "-2.0";
232   else if (Imm == FloatToBits(4.0f))
233     O << "4.0";
234   else if (Imm == FloatToBits(-4.0f))
235     O << "-4.0";
236   else
237     O << formatHex(static_cast<uint64_t>(Imm));
238 }
239
240 void AMDGPUInstPrinter::printImmediate64(uint64_t Imm, raw_ostream &O) {
241   int64_t SImm = static_cast<int64_t>(Imm);
242   if (SImm >= -16 && SImm <= 64) {
243     O << SImm;
244     return;
245   }
246
247   if (Imm == DoubleToBits(0.0))
248     O << "0.0";
249   else if (Imm == DoubleToBits(1.0))
250     O << "1.0";
251   else if (Imm == DoubleToBits(-1.0))
252     O << "-1.0";
253   else if (Imm == DoubleToBits(0.5))
254     O << "0.5";
255   else if (Imm == DoubleToBits(-0.5))
256     O << "-0.5";
257   else if (Imm == DoubleToBits(2.0))
258     O << "2.0";
259   else if (Imm == DoubleToBits(-2.0))
260     O << "-2.0";
261   else if (Imm == DoubleToBits(4.0))
262     O << "4.0";
263   else if (Imm == DoubleToBits(-4.0))
264     O << "-4.0";
265   else
266     llvm_unreachable("64-bit literal constants not supported");
267 }
268
269 void AMDGPUInstPrinter::printOperand(const MCInst *MI, unsigned OpNo,
270                                      raw_ostream &O) {
271
272   const MCOperand &Op = MI->getOperand(OpNo);
273   if (Op.isReg()) {
274     switch (Op.getReg()) {
275     // This is the default predicate state, so we don't need to print it.
276     case AMDGPU::PRED_SEL_OFF:
277       break;
278
279     default:
280       printRegOperand(Op.getReg(), O);
281       break;
282     }
283   } else if (Op.isImm()) {
284     const MCInstrDesc &Desc = MII.get(MI->getOpcode());
285     int RCID = Desc.OpInfo[OpNo].RegClass;
286     if (RCID != -1) {
287       const MCRegisterClass &ImmRC = MRI.getRegClass(RCID);
288       if (ImmRC.getSize() == 4)
289         printImmediate32(Op.getImm(), O);
290       else if (ImmRC.getSize() == 8)
291         printImmediate64(Op.getImm(), O);
292       else
293         llvm_unreachable("Invalid register class size");
294     } else {
295       // We hit this for the immediate instruction bits that don't yet have a
296       // custom printer.
297       // TODO: Eventually this should be unnecessary.
298       O << formatDec(Op.getImm());
299     }
300   } else if (Op.isFPImm()) {
301     // We special case 0.0 because otherwise it will be printed as an integer.
302     if (Op.getFPImm() == 0.0)
303       O << "0.0";
304     else {
305       const MCInstrDesc &Desc = MII.get(MI->getOpcode());
306       const MCRegisterClass &ImmRC = MRI.getRegClass(Desc.OpInfo[OpNo].RegClass);
307
308       if (ImmRC.getSize() == 4)
309         printImmediate32(FloatToBits(Op.getFPImm()), O);
310       else if (ImmRC.getSize() == 8)
311         printImmediate64(DoubleToBits(Op.getFPImm()), O);
312       else
313         llvm_unreachable("Invalid register class size");
314     }
315   } else if (Op.isExpr()) {
316     const MCExpr *Exp = Op.getExpr();
317     Exp->print(O);
318   } else {
319     llvm_unreachable("unknown operand type in printOperand");
320   }
321 }
322
323 void AMDGPUInstPrinter::printOperandAndMods(const MCInst *MI, unsigned OpNo,
324                                             raw_ostream &O) {
325   unsigned InputModifiers = MI->getOperand(OpNo).getImm();
326   if (InputModifiers & SISrcMods::NEG)
327     O << '-';
328   if (InputModifiers & SISrcMods::ABS)
329     O << '|';
330   printOperand(MI, OpNo + 1, O);
331   if (InputModifiers & SISrcMods::ABS)
332     O << '|';
333 }
334
335 void AMDGPUInstPrinter::printInterpSlot(const MCInst *MI, unsigned OpNum,
336                                         raw_ostream &O) {
337   unsigned Imm = MI->getOperand(OpNum).getImm();
338
339   if (Imm == 2) {
340     O << "P0";
341   } else if (Imm == 1) {
342     O << "P20";
343   } else if (Imm == 0) {
344     O << "P10";
345   } else {
346     llvm_unreachable("Invalid interpolation parameter slot");
347   }
348 }
349
350 void AMDGPUInstPrinter::printMemOperand(const MCInst *MI, unsigned OpNo,
351                                         raw_ostream &O) {
352   printOperand(MI, OpNo, O);
353   O  << ", ";
354   printOperand(MI, OpNo + 1, O);
355 }
356
357 void AMDGPUInstPrinter::printIfSet(const MCInst *MI, unsigned OpNo,
358                                    raw_ostream &O, StringRef Asm,
359                                    StringRef Default) {
360   const MCOperand &Op = MI->getOperand(OpNo);
361   assert(Op.isImm());
362   if (Op.getImm() == 1) {
363     O << Asm;
364   } else {
365     O << Default;
366   }
367 }
368
369 void AMDGPUInstPrinter::printAbs(const MCInst *MI, unsigned OpNo,
370                                  raw_ostream &O) {
371   printIfSet(MI, OpNo, O, "|");
372 }
373
374 void AMDGPUInstPrinter::printClamp(const MCInst *MI, unsigned OpNo,
375                                    raw_ostream &O) {
376   printIfSet(MI, OpNo, O, "_SAT");
377 }
378
379 void AMDGPUInstPrinter::printClampSI(const MCInst *MI, unsigned OpNo,
380                                      raw_ostream &O) {
381   if (MI->getOperand(OpNo).getImm())
382     O << " clamp";
383 }
384
385 void AMDGPUInstPrinter::printOModSI(const MCInst *MI, unsigned OpNo,
386                                      raw_ostream &O) {
387   int Imm = MI->getOperand(OpNo).getImm();
388   if (Imm == SIOutMods::MUL2)
389     O << " mul:2";
390   else if (Imm == SIOutMods::MUL4)
391     O << " mul:4";
392   else if (Imm == SIOutMods::DIV2)
393     O << " div:2";
394 }
395
396 void AMDGPUInstPrinter::printLiteral(const MCInst *MI, unsigned OpNo,
397                                      raw_ostream &O) {
398   int32_t Imm = MI->getOperand(OpNo).getImm();
399   O << Imm << '(' << BitsToFloat(Imm) << ')';
400 }
401
402 void AMDGPUInstPrinter::printLast(const MCInst *MI, unsigned OpNo,
403                                   raw_ostream &O) {
404   printIfSet(MI, OpNo, O.indent(25 - O.GetNumBytesInBuffer()), "*", " ");
405 }
406
407 void AMDGPUInstPrinter::printNeg(const MCInst *MI, unsigned OpNo,
408                                  raw_ostream &O) {
409   printIfSet(MI, OpNo, O, "-");
410 }
411
412 void AMDGPUInstPrinter::printOMOD(const MCInst *MI, unsigned OpNo,
413                                   raw_ostream &O) {
414   switch (MI->getOperand(OpNo).getImm()) {
415   default: break;
416   case 1:
417     O << " * 2.0";
418     break;
419   case 2:
420     O << " * 4.0";
421     break;
422   case 3:
423     O << " / 2.0";
424     break;
425   }
426 }
427
428 void AMDGPUInstPrinter::printRel(const MCInst *MI, unsigned OpNo,
429                                  raw_ostream &O) {
430   printIfSet(MI, OpNo, O, "+");
431 }
432
433 void AMDGPUInstPrinter::printUpdateExecMask(const MCInst *MI, unsigned OpNo,
434                                             raw_ostream &O) {
435   printIfSet(MI, OpNo, O, "ExecMask,");
436 }
437
438 void AMDGPUInstPrinter::printUpdatePred(const MCInst *MI, unsigned OpNo,
439                                         raw_ostream &O) {
440   printIfSet(MI, OpNo, O, "Pred,");
441 }
442
443 void AMDGPUInstPrinter::printWrite(const MCInst *MI, unsigned OpNo,
444                                        raw_ostream &O) {
445   const MCOperand &Op = MI->getOperand(OpNo);
446   if (Op.getImm() == 0) {
447     O << " (MASKED)";
448   }
449 }
450
451 void AMDGPUInstPrinter::printSel(const MCInst *MI, unsigned OpNo,
452                                   raw_ostream &O) {
453   const char * chans = "XYZW";
454   int sel = MI->getOperand(OpNo).getImm();
455
456   int chan = sel & 3;
457   sel >>= 2;
458
459   if (sel >= 512) {
460     sel -= 512;
461     int cb = sel >> 12;
462     sel &= 4095;
463     O << cb << '[' << sel << ']';
464   } else if (sel >= 448) {
465     sel -= 448;
466     O << sel;
467   } else if (sel >= 0){
468     O << sel;
469   }
470
471   if (sel >= 0)
472     O << '.' << chans[chan];
473 }
474
475 void AMDGPUInstPrinter::printBankSwizzle(const MCInst *MI, unsigned OpNo,
476                                          raw_ostream &O) {
477   int BankSwizzle = MI->getOperand(OpNo).getImm();
478   switch (BankSwizzle) {
479   case 1:
480     O << "BS:VEC_021/SCL_122";
481     break;
482   case 2:
483     O << "BS:VEC_120/SCL_212";
484     break;
485   case 3:
486     O << "BS:VEC_102/SCL_221";
487     break;
488   case 4:
489     O << "BS:VEC_201";
490     break;
491   case 5:
492     O << "BS:VEC_210";
493     break;
494   default:
495     break;
496   }
497   return;
498 }
499
500 void AMDGPUInstPrinter::printRSel(const MCInst *MI, unsigned OpNo,
501                                   raw_ostream &O) {
502   unsigned Sel = MI->getOperand(OpNo).getImm();
503   switch (Sel) {
504   case 0:
505     O << 'X';
506     break;
507   case 1:
508     O << 'Y';
509     break;
510   case 2:
511     O << 'Z';
512     break;
513   case 3:
514     O << 'W';
515     break;
516   case 4:
517     O << '0';
518     break;
519   case 5:
520     O << '1';
521     break;
522   case 7:
523     O << '_';
524     break;
525   default:
526     break;
527   }
528 }
529
530 void AMDGPUInstPrinter::printCT(const MCInst *MI, unsigned OpNo,
531                                   raw_ostream &O) {
532   unsigned CT = MI->getOperand(OpNo).getImm();
533   switch (CT) {
534   case 0:
535     O << 'U';
536     break;
537   case 1:
538     O << 'N';
539     break;
540   default:
541     break;
542   }
543 }
544
545 void AMDGPUInstPrinter::printKCache(const MCInst *MI, unsigned OpNo,
546                                     raw_ostream &O) {
547   int KCacheMode = MI->getOperand(OpNo).getImm();
548   if (KCacheMode > 0) {
549     int KCacheBank = MI->getOperand(OpNo - 2).getImm();
550     O << "CB" << KCacheBank << ':';
551     int KCacheAddr = MI->getOperand(OpNo + 2).getImm();
552     int LineSize = (KCacheMode == 1) ? 16 : 32;
553     O << KCacheAddr * 16 << '-' << KCacheAddr * 16 + LineSize;
554   }
555 }
556
557 void AMDGPUInstPrinter::printSendMsg(const MCInst *MI, unsigned OpNo,
558                                      raw_ostream &O) {
559   unsigned SImm16 = MI->getOperand(OpNo).getImm();
560   unsigned Msg = SImm16 & 0xF;
561   if (Msg == 2 || Msg == 3) {
562     unsigned Op = (SImm16 >> 4) & 0xF;
563     if (Msg == 3)
564       O << "Gs_done(";
565     else
566       O << "Gs(";
567     if (Op == 0) {
568       O << "nop";
569     } else {
570       unsigned Stream = (SImm16 >> 8) & 0x3;
571       if (Op == 1)
572         O << "cut";
573       else if (Op == 2)
574         O << "emit";
575       else if (Op == 3)
576         O << "emit-cut";
577       O << " stream " << Stream;
578     }
579     O << "), [m0] ";
580   } else if (Msg == 1)
581     O << "interrupt ";
582   else if (Msg == 15)
583     O << "system ";
584   else
585     O << "unknown(" << Msg << ") ";
586 }
587
588 void AMDGPUInstPrinter::printWaitFlag(const MCInst *MI, unsigned OpNo,
589                                       raw_ostream &O) {
590   // Note: Mask values are taken from SIInsertWaits.cpp and not from ISA docs
591   // SIInsertWaits.cpp bits usage does not match ISA docs description but it
592   // works so it might be a misprint in docs.
593   unsigned SImm16 = MI->getOperand(OpNo).getImm();
594   unsigned Vmcnt = SImm16 & 0xF;
595   unsigned Expcnt = (SImm16 >> 4) & 0xF;
596   unsigned Lgkmcnt = (SImm16 >> 8) & 0xF;
597
598   bool NeedSpace = false;
599
600   if (Vmcnt != 0xF) {
601     O << "vmcnt(" << Vmcnt << ')';
602     NeedSpace = true;
603   }
604
605   if (Expcnt != 0x7) {
606     if (NeedSpace)
607       O << ' ';
608     O << "expcnt(" << Expcnt << ')';
609     NeedSpace = true;
610   }
611
612   if (Lgkmcnt != 0x7) {
613     if (NeedSpace)
614       O << ' ';
615     O << "lgkmcnt(" << Lgkmcnt << ')';
616   }
617 }
618
619 #include "AMDGPUGenAsmWriter.inc"