1 //===-- llvm/CodeGen/GlobalISel/MachineIRBuilder.cpp - MIBuilder--*- C++ -*-==//
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 /// \file
10 /// This file implements the MachineIRBuidler class.
11 //===----------------------------------------------------------------------===//
12 #include "llvm/CodeGen/GlobalISel/MachineIRBuilder.h"
13 
14 #include "llvm/CodeGen/MachineFunction.h"
15 #include "llvm/CodeGen/MachineInstr.h"
16 #include "llvm/CodeGen/MachineInstrBuilder.h"
17 #include "llvm/CodeGen/MachineRegisterInfo.h"
18 #include "llvm/IR/DebugInfo.h"
19 #include "llvm/Target/TargetInstrInfo.h"
20 #include "llvm/Target/TargetOpcodes.h"
21 #include "llvm/Target/TargetSubtargetInfo.h"
22 
23 using namespace llvm;
24 
25 void MachineIRBuilder::setMF(MachineFunction &MF) {
26   this->MF = &MF;
27   this->MBB = nullptr;
28   this->MRI = &MF.getRegInfo();
29   this->TII = MF.getSubtarget().getInstrInfo();
30   this->DL = DebugLoc();
31   this->II = MachineBasicBlock::iterator();
32   this->InsertedInstr = nullptr;
33 }
34 
35 void MachineIRBuilder::setMBB(MachineBasicBlock &MBB) {
36   this->MBB = &MBB;
37   this->II = MBB.end();
38   assert(&getMF() == MBB.getParent() &&
39          "Basic block is in a different function");
40 }
41 
42 void MachineIRBuilder::setInstr(MachineInstr &MI) {
43   assert(MI.getParent() && "Instruction is not part of a basic block");
44   setMBB(*MI.getParent());
45   this->II = MI.getIterator();
46 }
47 
48 void MachineIRBuilder::setInsertPt(MachineBasicBlock &MBB,
49                                    MachineBasicBlock::iterator II) {
50   assert(MBB.getParent() == &getMF() &&
51          "Basic block is in a different function");
52   this->MBB = &MBB;
53   this->II = II;
54 }
55 
56 void MachineIRBuilder::recordInsertions(
57     std::function<void(MachineInstr *)> Inserted) {
58   InsertedInstr = std::move(Inserted);
59 }
60 
61 void MachineIRBuilder::stopRecordingInsertions() {
62   InsertedInstr = nullptr;
63 }
64 
65 //------------------------------------------------------------------------------
66 // Build instruction variants.
67 //------------------------------------------------------------------------------
68 
69 MachineInstrBuilder MachineIRBuilder::buildInstr(unsigned Opcode) {
70   return insertInstr(buildInstrNoInsert(Opcode));
71 }
72 
73 MachineInstrBuilder MachineIRBuilder::buildInstrNoInsert(unsigned Opcode) {
74   MachineInstrBuilder MIB = BuildMI(getMF(), DL, getTII().get(Opcode));
75   return MIB;
76 }
77 
78 
79 MachineInstrBuilder MachineIRBuilder::insertInstr(MachineInstrBuilder MIB) {
80   getMBB().insert(getInsertPt(), MIB);
81   if (InsertedInstr)
82     InsertedInstr(MIB);
83   return MIB;
84 }
85 
86 MachineInstrBuilder MachineIRBuilder::buildDirectDbgValue(
87     unsigned Reg, const MDNode *Variable, const MDNode *Expr) {
88   assert(isa<DILocalVariable>(Variable) && "not a variable");
89   assert(cast<DIExpression>(Expr)->isValid() && "not an expression");
90   assert(cast<DILocalVariable>(Variable)->isValidLocationForIntrinsic(DL) &&
91          "Expected inlined-at fields to agree");
92   return buildInstr(TargetOpcode::DBG_VALUE)
93       .addReg(Reg, RegState::Debug)
94       .addReg(0, RegState::Debug)
95       .addMetadata(Variable)
96       .addMetadata(Expr);
97 }
98 
99 MachineInstrBuilder MachineIRBuilder::buildIndirectDbgValue(
100     unsigned Reg, unsigned Offset, const MDNode *Variable, const MDNode *Expr) {
101   assert(isa<DILocalVariable>(Variable) && "not a variable");
102   assert(cast<DIExpression>(Expr)->isValid() && "not an expression");
103   assert(cast<DILocalVariable>(Variable)->isValidLocationForIntrinsic(DL) &&
104          "Expected inlined-at fields to agree");
105   return buildInstr(TargetOpcode::DBG_VALUE)
106       .addReg(Reg, RegState::Debug)
107       .addImm(Offset)
108       .addMetadata(Variable)
109       .addMetadata(Expr);
110 }
111 
112 MachineInstrBuilder MachineIRBuilder::buildFIDbgValue(int FI,
113                                                       const MDNode *Variable,
114                                                       const MDNode *Expr) {
115   assert(isa<DILocalVariable>(Variable) && "not a variable");
116   assert(cast<DIExpression>(Expr)->isValid() && "not an expression");
117   assert(cast<DILocalVariable>(Variable)->isValidLocationForIntrinsic(DL) &&
118          "Expected inlined-at fields to agree");
119   return buildInstr(TargetOpcode::DBG_VALUE)
120       .addFrameIndex(FI)
121       .addImm(0)
122       .addMetadata(Variable)
123       .addMetadata(Expr);
124 }
125 
126 MachineInstrBuilder MachineIRBuilder::buildConstDbgValue(const Constant &C,
127                                                          unsigned Offset,
128                                                          const MDNode *Variable,
129                                                          const MDNode *Expr) {
130   assert(isa<DILocalVariable>(Variable) && "not a variable");
131   assert(cast<DIExpression>(Expr)->isValid() && "not an expression");
132   assert(cast<DILocalVariable>(Variable)->isValidLocationForIntrinsic(DL) &&
133          "Expected inlined-at fields to agree");
134   auto MIB = buildInstr(TargetOpcode::DBG_VALUE);
135   if (auto *CI = dyn_cast<ConstantInt>(&C)) {
136     if (CI->getBitWidth() > 64)
137       MIB.addCImm(CI);
138     else
139       MIB.addImm(CI->getZExtValue());
140   } else
141     MIB.addFPImm(&cast<ConstantFP>(C));
142 
143   return MIB.addImm(Offset).addMetadata(Variable).addMetadata(Expr);
144 }
145 
146 MachineInstrBuilder MachineIRBuilder::buildFrameIndex(unsigned Res, int Idx) {
147   assert(MRI->getType(Res).isPointer() && "invalid operand type");
148   return buildInstr(TargetOpcode::G_FRAME_INDEX)
149       .addDef(Res)
150       .addFrameIndex(Idx);
151 }
152 
153 MachineInstrBuilder MachineIRBuilder::buildGlobalValue(unsigned Res,
154                                                        const GlobalValue *GV) {
155   assert(MRI->getType(Res).isPointer() && "invalid operand type");
156   assert(MRI->getType(Res).getAddressSpace() ==
157              GV->getType()->getAddressSpace() &&
158          "address space mismatch");
159 
160   return buildInstr(TargetOpcode::G_GLOBAL_VALUE)
161       .addDef(Res)
162       .addGlobalAddress(GV);
163 }
164 
165 MachineInstrBuilder MachineIRBuilder::buildAdd(unsigned Res, unsigned Op0,
166                                                unsigned Op1) {
167   assert((MRI->getType(Res).isScalar() || MRI->getType(Res).isVector()) &&
168          "invalid operand type");
169   assert(MRI->getType(Res) == MRI->getType(Op0) &&
170          MRI->getType(Res) == MRI->getType(Op1) && "type mismatch");
171 
172   return buildInstr(TargetOpcode::G_ADD)
173       .addDef(Res)
174       .addUse(Op0)
175       .addUse(Op1);
176 }
177 
178 MachineInstrBuilder MachineIRBuilder::buildGEP(unsigned Res, unsigned Op0,
179                                                unsigned Op1) {
180   assert(MRI->getType(Res).isPointer() &&
181          MRI->getType(Res) == MRI->getType(Op0) && "type mismatch");
182   assert(MRI->getType(Op1).isScalar()  && "invalid offset type");
183 
184   return buildInstr(TargetOpcode::G_GEP)
185       .addDef(Res)
186       .addUse(Op0)
187       .addUse(Op1);
188 }
189 
190 MachineInstrBuilder MachineIRBuilder::buildSub(unsigned Res, unsigned Op0,
191                                                unsigned Op1) {
192   assert((MRI->getType(Res).isScalar() || MRI->getType(Res).isVector()) &&
193          "invalid operand type");
194   assert(MRI->getType(Res) == MRI->getType(Op0) &&
195          MRI->getType(Res) == MRI->getType(Op1) && "type mismatch");
196 
197   return buildInstr(TargetOpcode::G_SUB)
198       .addDef(Res)
199       .addUse(Op0)
200       .addUse(Op1);
201 }
202 
203 MachineInstrBuilder MachineIRBuilder::buildMul(unsigned Res, unsigned Op0,
204                                                unsigned Op1) {
205   assert((MRI->getType(Res).isScalar() || MRI->getType(Res).isVector()) &&
206          "invalid operand type");
207   assert(MRI->getType(Res) == MRI->getType(Op0) &&
208          MRI->getType(Res) == MRI->getType(Op1) && "type mismatch");
209 
210   return buildInstr(TargetOpcode::G_MUL)
211       .addDef(Res)
212       .addUse(Op0)
213       .addUse(Op1);
214 }
215 
216 MachineInstrBuilder MachineIRBuilder::buildAnd(unsigned Res, unsigned Op0,
217                                                unsigned Op1) {
218   assert((MRI->getType(Res).isScalar() || MRI->getType(Res).isVector()) &&
219          "invalid operand type");
220   assert(MRI->getType(Res) == MRI->getType(Op0) &&
221          MRI->getType(Res) == MRI->getType(Op1) && "type mismatch");
222 
223   return buildInstr(TargetOpcode::G_AND)
224       .addDef(Res)
225       .addUse(Op0)
226       .addUse(Op1);
227 }
228 
229 MachineInstrBuilder MachineIRBuilder::buildBr(MachineBasicBlock &Dest) {
230   return buildInstr(TargetOpcode::G_BR).addMBB(&Dest);
231 }
232 
233 MachineInstrBuilder MachineIRBuilder::buildBrIndirect(unsigned Tgt) {
234   return buildInstr(TargetOpcode::G_BRINDIRECT).addUse(Tgt);
235 }
236 
237 MachineInstrBuilder MachineIRBuilder::buildCopy(unsigned Res, unsigned Op) {
238   return buildInstr(TargetOpcode::COPY).addDef(Res).addUse(Op);
239 }
240 
241 MachineInstrBuilder MachineIRBuilder::buildConstant(unsigned Res,
242                                                     const ConstantInt &Val) {
243   LLT Ty = MRI->getType(Res);
244 
245   assert((Ty.isScalar() || Ty.isPointer()) && "invalid operand type");
246 
247   const ConstantInt *NewVal = &Val;
248   if (Ty.getSizeInBits() != Val.getBitWidth())
249     NewVal = ConstantInt::get(MF->getFunction()->getContext(),
250                               Val.getValue().sextOrTrunc(Ty.getSizeInBits()));
251 
252   return buildInstr(TargetOpcode::G_CONSTANT).addDef(Res).addCImm(NewVal);
253 }
254 
255 MachineInstrBuilder MachineIRBuilder::buildConstant(unsigned Res,
256                                                     int64_t Val) {
257   auto IntN = IntegerType::get(MF->getFunction()->getContext(),
258                                MRI->getType(Res).getSizeInBits());
259   ConstantInt *CI = ConstantInt::get(IntN, Val, true);
260   return buildConstant(Res, *CI);
261 }
262 
263 MachineInstrBuilder MachineIRBuilder::buildFConstant(unsigned Res,
264                                                      const ConstantFP &Val) {
265   assert(MRI->getType(Res).isScalar() && "invalid operand type");
266 
267   return buildInstr(TargetOpcode::G_FCONSTANT).addDef(Res).addFPImm(&Val);
268 }
269 
270 MachineInstrBuilder MachineIRBuilder::buildBrCond(unsigned Tst,
271                                                   MachineBasicBlock &Dest) {
272   assert(MRI->getType(Tst).isScalar() && "invalid operand type");
273 
274   return buildInstr(TargetOpcode::G_BRCOND).addUse(Tst).addMBB(&Dest);
275 }
276 
277 MachineInstrBuilder MachineIRBuilder::buildLoad(unsigned Res, unsigned Addr,
278                                                 MachineMemOperand &MMO) {
279   assert(MRI->getType(Res).isValid() && "invalid operand type");
280   assert(MRI->getType(Addr).isPointer() && "invalid operand type");
281 
282   return buildInstr(TargetOpcode::G_LOAD)
283       .addDef(Res)
284       .addUse(Addr)
285       .addMemOperand(&MMO);
286 }
287 
288 MachineInstrBuilder MachineIRBuilder::buildStore(unsigned Val, unsigned Addr,
289                                                  MachineMemOperand &MMO) {
290   assert(MRI->getType(Val).isValid() && "invalid operand type");
291   assert(MRI->getType(Addr).isPointer() && "invalid operand type");
292 
293   return buildInstr(TargetOpcode::G_STORE)
294       .addUse(Val)
295       .addUse(Addr)
296       .addMemOperand(&MMO);
297 }
298 
299 MachineInstrBuilder MachineIRBuilder::buildUAdde(unsigned Res,
300                                                  unsigned CarryOut,
301                                                  unsigned Op0, unsigned Op1,
302                                                  unsigned CarryIn) {
303   assert(MRI->getType(Res).isScalar() && "invalid operand type");
304   assert(MRI->getType(Res) == MRI->getType(Op0) &&
305          MRI->getType(Res) == MRI->getType(Op1) && "type mismatch");
306   assert(MRI->getType(CarryOut).isScalar() && "invalid operand type");
307   assert(MRI->getType(CarryOut) == MRI->getType(CarryIn) && "type mismatch");
308 
309   return buildInstr(TargetOpcode::G_UADDE)
310       .addDef(Res)
311       .addDef(CarryOut)
312       .addUse(Op0)
313       .addUse(Op1)
314       .addUse(CarryIn);
315 }
316 
317 MachineInstrBuilder MachineIRBuilder::buildAnyExt(unsigned Res, unsigned Op) {
318   validateTruncExt(Res, Op, true);
319   return buildInstr(TargetOpcode::G_ANYEXT).addDef(Res).addUse(Op);
320 }
321 
322 MachineInstrBuilder MachineIRBuilder::buildSExt(unsigned Res, unsigned Op) {
323   validateTruncExt(Res, Op, true);
324   return buildInstr(TargetOpcode::G_SEXT).addDef(Res).addUse(Op);
325 }
326 
327 MachineInstrBuilder MachineIRBuilder::buildZExt(unsigned Res, unsigned Op) {
328   validateTruncExt(Res, Op, true);
329   return buildInstr(TargetOpcode::G_ZEXT).addDef(Res).addUse(Op);
330 }
331 
332 MachineInstrBuilder MachineIRBuilder::buildSExtOrTrunc(unsigned Res,
333                                                        unsigned Op) {
334   unsigned Opcode = TargetOpcode::COPY;
335   if (MRI->getType(Res).getSizeInBits() > MRI->getType(Op).getSizeInBits())
336     Opcode = TargetOpcode::G_SEXT;
337   else if (MRI->getType(Res).getSizeInBits() < MRI->getType(Op).getSizeInBits())
338     Opcode = TargetOpcode::G_TRUNC;
339 
340   return buildInstr(Opcode).addDef(Res).addUse(Op);
341 }
342 
343 MachineInstrBuilder MachineIRBuilder::buildZExtOrTrunc(unsigned Res,
344                                                        unsigned Op) {
345   unsigned Opcode = TargetOpcode::COPY;
346   if (MRI->getType(Res).getSizeInBits() > MRI->getType(Op).getSizeInBits())
347     Opcode = TargetOpcode::G_ZEXT;
348   else if (MRI->getType(Res).getSizeInBits() < MRI->getType(Op).getSizeInBits())
349     Opcode = TargetOpcode::G_TRUNC;
350 
351   return buildInstr(Opcode).addDef(Res).addUse(Op);
352 }
353 
354 MachineInstrBuilder MachineIRBuilder::buildExtract(ArrayRef<unsigned> Results,
355                                                    ArrayRef<uint64_t> Indices,
356                                                    unsigned Src) {
357 #ifndef NDEBUG
358   assert(Results.size() == Indices.size() && "inconsistent number of regs");
359   assert(!Results.empty() && "invalid trivial extract");
360   assert(std::is_sorted(Indices.begin(), Indices.end()) &&
361          "extract offsets must be in ascending order");
362 
363   assert(MRI->getType(Src).isValid() && "invalid operand type");
364   for (auto Res : Results)
365     assert(MRI->getType(Res).isValid() && "invalid operand type");
366 #endif
367 
368   auto MIB = BuildMI(getMF(), DL, getTII().get(TargetOpcode::G_EXTRACT));
369   for (auto Res : Results)
370     MIB.addDef(Res);
371 
372   MIB.addUse(Src);
373 
374   for (auto Idx : Indices)
375     MIB.addImm(Idx);
376 
377   getMBB().insert(getInsertPt(), MIB);
378   if (InsertedInstr)
379     InsertedInstr(MIB);
380 
381   return MIB;
382 }
383 
384 MachineInstrBuilder
385 MachineIRBuilder::buildSequence(unsigned Res,
386                                 ArrayRef<unsigned> Ops,
387                                 ArrayRef<uint64_t> Indices) {
388 #ifndef NDEBUG
389   assert(Ops.size() == Indices.size() && "incompatible args");
390   assert(!Ops.empty() && "invalid trivial sequence");
391   assert(std::is_sorted(Indices.begin(), Indices.end()) &&
392          "sequence offsets must be in ascending order");
393 
394   assert(MRI->getType(Res).isValid() && "invalid operand type");
395   for (auto Op : Ops)
396     assert(MRI->getType(Op).isValid() && "invalid operand type");
397 #endif
398 
399   MachineInstrBuilder MIB = buildInstr(TargetOpcode::G_SEQUENCE);
400   MIB.addDef(Res);
401   for (unsigned i = 0; i < Ops.size(); ++i) {
402     MIB.addUse(Ops[i]);
403     MIB.addImm(Indices[i]);
404   }
405   return MIB;
406 }
407 
408 MachineInstrBuilder MachineIRBuilder::buildIntrinsic(Intrinsic::ID ID,
409                                                      unsigned Res,
410                                                      bool HasSideEffects) {
411   auto MIB =
412       buildInstr(HasSideEffects ? TargetOpcode::G_INTRINSIC_W_SIDE_EFFECTS
413                                 : TargetOpcode::G_INTRINSIC);
414   if (Res)
415     MIB.addDef(Res);
416   MIB.addIntrinsicID(ID);
417   return MIB;
418 }
419 
420 MachineInstrBuilder MachineIRBuilder::buildTrunc(unsigned Res, unsigned Op) {
421   validateTruncExt(Res, Op, false);
422   return buildInstr(TargetOpcode::G_TRUNC).addDef(Res).addUse(Op);
423 }
424 
425 MachineInstrBuilder MachineIRBuilder::buildFPTrunc(unsigned Res, unsigned Op) {
426   validateTruncExt(Res, Op, false);
427   return buildInstr(TargetOpcode::G_FPTRUNC).addDef(Res).addUse(Op);
428 }
429 
430 MachineInstrBuilder MachineIRBuilder::buildICmp(CmpInst::Predicate Pred,
431                                                 unsigned Res, unsigned Op0,
432                                                 unsigned Op1) {
433 #ifndef NDEBUG
434   assert(MRI->getType(Op0) == MRI->getType(Op0) && "type mismatch");
435   assert(CmpInst::isIntPredicate(Pred) && "invalid predicate");
436   if (MRI->getType(Op0).isScalar() || MRI->getType(Op0).isPointer())
437     assert(MRI->getType(Res).isScalar() && "type mismatch");
438   else
439     assert(MRI->getType(Res).isVector() &&
440            MRI->getType(Res).getNumElements() ==
441                MRI->getType(Op0).getNumElements() &&
442            "type mismatch");
443 #endif
444 
445   return buildInstr(TargetOpcode::G_ICMP)
446       .addDef(Res)
447       .addPredicate(Pred)
448       .addUse(Op0)
449       .addUse(Op1);
450 }
451 
452 MachineInstrBuilder MachineIRBuilder::buildFCmp(CmpInst::Predicate Pred,
453                                                 unsigned Res, unsigned Op0,
454                                                 unsigned Op1) {
455 #ifndef NDEBUG
456   assert((MRI->getType(Op0).isScalar() || MRI->getType(Op0).isVector()) &&
457          "invalid operand type");
458   assert(MRI->getType(Op0) == MRI->getType(Op1) && "type mismatch");
459   assert(CmpInst::isFPPredicate(Pred) && "invalid predicate");
460   if (MRI->getType(Op0).isScalar())
461     assert(MRI->getType(Res).isScalar() && "type mismatch");
462   else
463     assert(MRI->getType(Res).isVector() &&
464            MRI->getType(Res).getNumElements() ==
465                MRI->getType(Op0).getNumElements() &&
466            "type mismatch");
467 #endif
468 
469   return buildInstr(TargetOpcode::G_FCMP)
470       .addDef(Res)
471       .addPredicate(Pred)
472       .addUse(Op0)
473       .addUse(Op1);
474 }
475 
476 MachineInstrBuilder MachineIRBuilder::buildSelect(unsigned Res, unsigned Tst,
477                                                   unsigned Op0, unsigned Op1) {
478 #ifndef NDEBUG
479   LLT ResTy = MRI->getType(Res);
480   assert((ResTy.isScalar() || ResTy.isVector() || ResTy.isPointer()) &&
481          "invalid operand type");
482   assert(ResTy == MRI->getType(Op0) && ResTy == MRI->getType(Op1) &&
483          "type mismatch");
484   if (ResTy.isScalar() || ResTy.isPointer())
485     assert(MRI->getType(Tst).isScalar() && "type mismatch");
486   else
487     assert(MRI->getType(Tst).isVector() &&
488            MRI->getType(Tst).getNumElements() ==
489                MRI->getType(Op0).getNumElements() &&
490            "type mismatch");
491 #endif
492 
493   return buildInstr(TargetOpcode::G_SELECT)
494       .addDef(Res)
495       .addUse(Tst)
496       .addUse(Op0)
497       .addUse(Op1);
498 }
499 
500 void MachineIRBuilder::validateTruncExt(unsigned Dst, unsigned Src,
501                                         bool IsExtend) {
502 #ifndef NDEBUG
503   LLT SrcTy = MRI->getType(Src);
504   LLT DstTy = MRI->getType(Dst);
505 
506   if (DstTy.isVector()) {
507     assert(SrcTy.isVector() && "mismatched cast between vecot and non-vector");
508     assert(SrcTy.getNumElements() == DstTy.getNumElements() &&
509            "different number of elements in a trunc/ext");
510   } else
511     assert(DstTy.isScalar() && SrcTy.isScalar() && "invalid extend/trunc");
512 
513   if (IsExtend)
514     assert(DstTy.getSizeInBits() > SrcTy.getSizeInBits() &&
515            "invalid narrowing extend");
516   else
517     assert(DstTy.getSizeInBits() < SrcTy.getSizeInBits() &&
518            "invalid widening trunc");
519 #endif
520 }
521