LLVM 19.0.0git
MachineIRBuilder.h
Go to the documentation of this file.
1//===-- llvm/CodeGen/GlobalISel/MachineIRBuilder.h - MIBuilder --*- C++ -*-===//
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/// \file
9/// This file declares the MachineIRBuilder class.
10/// This is a helper class to build MachineInstr.
11//===----------------------------------------------------------------------===//
12
13#ifndef LLVM_CODEGEN_GLOBALISEL_MACHINEIRBUILDER_H
14#define LLVM_CODEGEN_GLOBALISEL_MACHINEIRBUILDER_H
15
22#include "llvm/IR/DebugLoc.h"
23#include "llvm/IR/Module.h"
24
25namespace llvm {
26
27// Forward declarations.
28class APInt;
29class BlockAddress;
30class Constant;
31class ConstantFP;
32class ConstantInt;
33class DataLayout;
34class GISelCSEInfo;
35class GlobalValue;
36class TargetRegisterClass;
37class MachineFunction;
38class MachineInstr;
39class TargetInstrInfo;
40class GISelChangeObserver;
41
42/// Class which stores all the state required in a MachineIRBuilder.
43/// Since MachineIRBuilders will only store state in this object, it allows
44/// to transfer BuilderState between different kinds of MachineIRBuilders.
46 /// MachineFunction under construction.
47 MachineFunction *MF = nullptr;
48 /// Information used to access the description of the opcodes.
49 const TargetInstrInfo *TII = nullptr;
50 /// Information used to verify types are consistent and to create virtual registers.
52 /// Debug location to be set to any instruction we create.
54 /// PC sections metadata to be set to any instruction we create.
55 MDNode *PCSections = nullptr;
56 /// MMRA Metadata to be set on any instruction we create.
57 MDNode *MMRA = nullptr;
58
59 /// \name Fields describing the insertion point.
60 /// @{
63 /// @}
64
66
68};
69
70class DstOp {
71 union {
75 };
76
77public:
78 enum class DstType { Ty_LLT, Ty_Reg, Ty_RC };
79 DstOp(unsigned R) : Reg(R), Ty(DstType::Ty_Reg) {}
80 DstOp(Register R) : Reg(R), Ty(DstType::Ty_Reg) {}
82 DstOp(const LLT T) : LLTTy(T), Ty(DstType::Ty_LLT) {}
83 DstOp(const TargetRegisterClass *TRC) : RC(TRC), Ty(DstType::Ty_RC) {}
84
86 switch (Ty) {
87 case DstType::Ty_Reg:
88 MIB.addDef(Reg);
89 break;
90 case DstType::Ty_LLT:
91 MIB.addDef(MRI.createGenericVirtualRegister(LLTTy));
92 break;
93 case DstType::Ty_RC:
94 MIB.addDef(MRI.createVirtualRegister(RC));
95 break;
96 }
97 }
98
100 switch (Ty) {
101 case DstType::Ty_RC:
102 return LLT{};
103 case DstType::Ty_LLT:
104 return LLTTy;
105 case DstType::Ty_Reg:
106 return MRI.getType(Reg);
107 }
108 llvm_unreachable("Unrecognised DstOp::DstType enum");
109 }
110
111 Register getReg() const {
112 assert(Ty == DstType::Ty_Reg && "Not a register");
113 return Reg;
114 }
115
117 switch (Ty) {
118 case DstType::Ty_RC:
119 return RC;
120 default:
121 llvm_unreachable("Not a RC Operand");
122 }
123 }
124
125 DstType getDstOpKind() const { return Ty; }
126
127private:
128 DstType Ty;
129};
130
131class SrcOp {
132 union {
136 int64_t Imm;
137 };
138
139public:
141 SrcOp(Register R) : Reg(R), Ty(SrcType::Ty_Reg) {}
143 SrcOp(const MachineInstrBuilder &MIB) : SrcMIB(MIB), Ty(SrcType::Ty_MIB) {}
145 /// Use of registers held in unsigned integer variables (or more rarely signed
146 /// integers) is no longer permitted to avoid ambiguity with upcoming support
147 /// for immediates.
148 SrcOp(unsigned) = delete;
149 SrcOp(int) = delete;
150 SrcOp(uint64_t V) : Imm(V), Ty(SrcType::Ty_Imm) {}
151 SrcOp(int64_t V) : Imm(V), Ty(SrcType::Ty_Imm) {}
152
154 switch (Ty) {
156 MIB.addPredicate(Pred);
157 break;
158 case SrcType::Ty_Reg:
159 MIB.addUse(Reg);
160 break;
161 case SrcType::Ty_MIB:
162 MIB.addUse(SrcMIB->getOperand(0).getReg());
163 break;
164 case SrcType::Ty_Imm:
165 MIB.addImm(Imm);
166 break;
167 }
168 }
169
171 switch (Ty) {
173 case SrcType::Ty_Imm:
174 llvm_unreachable("Not a register operand");
175 case SrcType::Ty_Reg:
176 return MRI.getType(Reg);
177 case SrcType::Ty_MIB:
178 return MRI.getType(SrcMIB->getOperand(0).getReg());
179 }
180 llvm_unreachable("Unrecognised SrcOp::SrcType enum");
181 }
182
183 Register getReg() const {
184 switch (Ty) {
186 case SrcType::Ty_Imm:
187 llvm_unreachable("Not a register operand");
188 case SrcType::Ty_Reg:
189 return Reg;
190 case SrcType::Ty_MIB:
191 return SrcMIB->getOperand(0).getReg();
192 }
193 llvm_unreachable("Unrecognised SrcOp::SrcType enum");
194 }
195
197 switch (Ty) {
199 return Pred;
200 default:
201 llvm_unreachable("Not a register operand");
202 }
203 }
204
205 int64_t getImm() const {
206 switch (Ty) {
207 case SrcType::Ty_Imm:
208 return Imm;
209 default:
210 llvm_unreachable("Not an immediate");
211 }
212 }
213
214 SrcType getSrcOpKind() const { return Ty; }
215
216private:
217 SrcType Ty;
218};
219
220/// Helper class to build MachineInstr.
221/// It keeps internally the insertion point and debug location for all
222/// the new instructions we want to create.
223/// This information can be modified via the related setters.
225
227
228 unsigned getOpcodeForMerge(const DstOp &DstOp, ArrayRef<SrcOp> SrcOps) const;
229
230protected:
231 void validateTruncExt(const LLT Dst, const LLT Src, bool IsExtend);
232
233 void validateUnaryOp(const LLT Res, const LLT Op0);
234 void validateBinaryOp(const LLT Res, const LLT Op0, const LLT Op1);
235 void validateShiftOp(const LLT Res, const LLT Op0, const LLT Op1);
236
237 void validateSelectOp(const LLT ResTy, const LLT TstTy, const LLT Op0Ty,
238 const LLT Op1Ty);
239
240 void recordInsertion(MachineInstr *InsertedInstr) const {
241 if (State.Observer)
242 State.Observer->createdInstr(*InsertedInstr);
243 }
244
245public:
246 /// Some constructors for easy use.
247 MachineIRBuilder() = default;
249
251 setMF(*MBB.getParent());
252 setInsertPt(MBB, InsPt);
253 }
254
256 MachineIRBuilder(*MI.getParent(), MI.getIterator()) {
257 setInstr(MI);
258 setDebugLoc(MI.getDebugLoc());
259 }
260
263 setChangeObserver(Observer);
264 }
265
266 virtual ~MachineIRBuilder() = default;
267
268 MachineIRBuilder(const MachineIRBuilderState &BState) : State(BState) {}
269
271 assert(State.TII && "TargetInstrInfo is not set");
272 return *State.TII;
273 }
274
275 /// Getter for the function we currently build.
277 assert(State.MF && "MachineFunction is not set");
278 return *State.MF;
279 }
280
281 const MachineFunction &getMF() const {
282 assert(State.MF && "MachineFunction is not set");
283 return *State.MF;
284 }
285
286 const DataLayout &getDataLayout() const {
288 }
289
291 return getMF().getFunction().getContext();
292 }
293
294 /// Getter for DebugLoc
295 const DebugLoc &getDL() { return State.DL; }
296
297 /// Getter for MRI
298 MachineRegisterInfo *getMRI() { return State.MRI; }
299 const MachineRegisterInfo *getMRI() const { return State.MRI; }
300
301 /// Getter for the State
302 MachineIRBuilderState &getState() { return State; }
303
304 /// Setter for the State
305 void setState(const MachineIRBuilderState &NewState) { State = NewState; }
306
307 /// Getter for the basic block we currently build.
308 const MachineBasicBlock &getMBB() const {
309 assert(State.MBB && "MachineBasicBlock is not set");
310 return *State.MBB;
311 }
312
314 return const_cast<MachineBasicBlock &>(
315 const_cast<const MachineIRBuilder *>(this)->getMBB());
316 }
317
318 GISelCSEInfo *getCSEInfo() { return State.CSEInfo; }
319 const GISelCSEInfo *getCSEInfo() const { return State.CSEInfo; }
320
321 /// Current insertion point for new instructions.
323
324 /// Set the insertion point before the specified position.
325 /// \pre MBB must be in getMF().
326 /// \pre II must be a valid iterator in MBB.
328 assert(MBB.getParent() == &getMF() &&
329 "Basic block is in a different function");
330 State.MBB = &MBB;
331 State.II = II;
332 }
333
334 /// @}
335
337
338 /// \name Setters for the insertion point.
339 /// @{
340 /// Set the MachineFunction where to build instructions.
341 void setMF(MachineFunction &MF);
342
343 /// Set the insertion point to the end of \p MBB.
344 /// \pre \p MBB must be contained by getMF().
346 State.MBB = &MBB;
347 State.II = MBB.end();
348 assert(&getMF() == MBB.getParent() &&
349 "Basic block is in a different function");
350 }
351
352 /// Set the insertion point to before MI.
353 /// \pre MI must be in getMF().
355 assert(MI.getParent() && "Instruction is not part of a basic block");
356 setMBB(*MI.getParent());
357 State.II = MI.getIterator();
358 setPCSections(MI.getPCSections());
359 setMMRAMetadata(MI.getMMRAMetadata());
360 }
361 /// @}
362
363 /// Set the insertion point to before MI, and set the debug loc to MI's loc.
364 /// \pre MI must be in getMF().
366 setInstr(MI);
367 setDebugLoc(MI.getDebugLoc());
368 }
369
371 State.Observer = &Observer;
372 }
373
375
376 void stopObservingChanges() { State.Observer = nullptr; }
377
378 bool isObservingChanges() const { return State.Observer != nullptr; }
379 /// @}
380
381 /// Set the debug location to \p DL for all the next build instructions.
382 void setDebugLoc(const DebugLoc &DL) { this->State.DL = DL; }
383
384 /// Get the current instruction's debug location.
385 const DebugLoc &getDebugLoc() { return State.DL; }
386
387 /// Set the PC sections metadata to \p MD for all the next build instructions.
388 void setPCSections(MDNode *MD) { State.PCSections = MD; }
389
390 /// Get the current instruction's PC sections metadata.
391 MDNode *getPCSections() { return State.PCSections; }
392
393 /// Set the PC sections metadata to \p MD for all the next build instructions.
394 void setMMRAMetadata(MDNode *MMRA) { State.MMRA = MMRA; }
395
396 /// Get the current instruction's MMRA metadata.
397 MDNode *getMMRAMetadata() { return State.MMRA; }
398
399 /// Build and insert <empty> = \p Opcode <empty>.
400 /// The insertion point is the one set by the last call of either
401 /// setBasicBlock or setMI.
402 ///
403 /// \pre setBasicBlock or setMI must have been called.
404 ///
405 /// \return a MachineInstrBuilder for the newly created instruction.
407 return insertInstr(buildInstrNoInsert(Opcode));
408 }
409
410 /// Build but don't insert <empty> = \p Opcode <empty>.
411 ///
412 /// \pre setMF, setBasicBlock or setMI must have been called.
413 ///
414 /// \return a MachineInstrBuilder for the newly created instruction.
416
417 /// Insert an existing instruction at the insertion point.
419
420 /// Build and insert a DBG_VALUE instruction expressing the fact that the
421 /// associated \p Variable lives in \p Reg (suitably modified by \p Expr).
423 const MDNode *Expr);
424
425 /// Build and insert a DBG_VALUE instruction expressing the fact that the
426 /// associated \p Variable lives in memory at \p Reg (suitably modified by \p
427 /// Expr).
429 const MDNode *Variable,
430 const MDNode *Expr);
431
432 /// Build and insert a DBG_VALUE instruction expressing the fact that the
433 /// associated \p Variable lives in the stack slot specified by \p FI
434 /// (suitably modified by \p Expr).
435 MachineInstrBuilder buildFIDbgValue(int FI, const MDNode *Variable,
436 const MDNode *Expr);
437
438 /// Build and insert a DBG_VALUE instructions specifying that \p Variable is
439 /// given by \p C (suitably modified by \p Expr).
441 const MDNode *Variable,
442 const MDNode *Expr);
443
444 /// Build and insert a DBG_LABEL instructions specifying that \p Label is
445 /// given. Convert "llvm.dbg.label Label" to "DBG_LABEL Label".
447
448 /// Build and insert \p Res = G_DYN_STACKALLOC \p Size, \p Align
449 ///
450 /// G_DYN_STACKALLOC does a dynamic stack allocation and writes the address of
451 /// the allocated memory into \p Res.
452 /// \pre setBasicBlock or setMI must have been called.
453 /// \pre \p Res must be a generic virtual register with pointer type.
454 ///
455 /// \return a MachineInstrBuilder for the newly created instruction.
457 Align Alignment);
458
459 /// Build and insert \p Res = G_FRAME_INDEX \p Idx
460 ///
461 /// G_FRAME_INDEX materializes the address of an alloca value or other
462 /// stack-based object.
463 ///
464 /// \pre setBasicBlock or setMI must have been called.
465 /// \pre \p Res must be a generic virtual register with pointer type.
466 ///
467 /// \return a MachineInstrBuilder for the newly created instruction.
469
470 /// Build and insert \p Res = G_GLOBAL_VALUE \p GV
471 ///
472 /// G_GLOBAL_VALUE materializes the address of the specified global
473 /// into \p Res.
474 ///
475 /// \pre setBasicBlock or setMI must have been called.
476 /// \pre \p Res must be a generic virtual register with pointer type
477 /// in the same address space as \p GV.
478 ///
479 /// \return a MachineInstrBuilder for the newly created instruction.
481
482 /// Build and insert \p Res = G_CONSTANT_POOL \p Idx
483 ///
484 /// G_CONSTANT_POOL materializes the address of an object in the constant
485 /// pool.
486 ///
487 /// \pre setBasicBlock or setMI must have been called.
488 /// \pre \p Res must be a generic virtual register with pointer type.
489 ///
490 /// \return a MachineInstrBuilder for the newly created instruction.
491 MachineInstrBuilder buildConstantPool(const DstOp &Res, unsigned Idx);
492
493 /// Build and insert \p Res = G_PTR_ADD \p Op0, \p Op1
494 ///
495 /// G_PTR_ADD adds \p Op1 addressible units to the pointer specified by \p Op0,
496 /// storing the resulting pointer in \p Res. Addressible units are typically
497 /// bytes but this can vary between targets.
498 ///
499 /// \pre setBasicBlock or setMI must have been called.
500 /// \pre \p Res and \p Op0 must be generic virtual registers with pointer
501 /// type.
502 /// \pre \p Op1 must be a generic virtual register with scalar type.
503 ///
504 /// \return a MachineInstrBuilder for the newly created instruction.
505 MachineInstrBuilder buildPtrAdd(const DstOp &Res, const SrcOp &Op0,
506 const SrcOp &Op1,
507 std::optional<unsigned> Flags = std::nullopt);
508
509 /// Materialize and insert \p Res = G_PTR_ADD \p Op0, (G_CONSTANT \p Value)
510 ///
511 /// G_PTR_ADD adds \p Value bytes to the pointer specified by \p Op0,
512 /// storing the resulting pointer in \p Res. If \p Value is zero then no
513 /// G_PTR_ADD or G_CONSTANT will be created and \pre Op0 will be assigned to
514 /// \p Res.
515 ///
516 /// \pre setBasicBlock or setMI must have been called.
517 /// \pre \p Op0 must be a generic virtual register with pointer type.
518 /// \pre \p ValueTy must be a scalar type.
519 /// \pre \p Res must be 0. This is to detect confusion between
520 /// materializePtrAdd() and buildPtrAdd().
521 /// \post \p Res will either be a new generic virtual register of the same
522 /// type as \p Op0 or \p Op0 itself.
523 ///
524 /// \return a MachineInstrBuilder for the newly created instruction.
525 std::optional<MachineInstrBuilder> materializePtrAdd(Register &Res,
526 Register Op0,
527 const LLT ValueTy,
529
530 /// Build and insert \p Res = G_PTRMASK \p Op0, \p Op1
532 const SrcOp &Op1) {
533 return buildInstr(TargetOpcode::G_PTRMASK, {Res}, {Op0, Op1});
534 }
535
536 /// Build and insert \p Res = G_PTRMASK \p Op0, \p G_CONSTANT (1 << NumBits) - 1
537 ///
538 /// This clears the low bits of a pointer operand without destroying its
539 /// pointer properties. This has the effect of rounding the address *down* to
540 /// a specified alignment in bits.
541 ///
542 /// \pre setBasicBlock or setMI must have been called.
543 /// \pre \p Res and \p Op0 must be generic virtual registers with pointer
544 /// type.
545 /// \pre \p NumBits must be an integer representing the number of low bits to
546 /// be cleared in \p Op0.
547 ///
548 /// \return a MachineInstrBuilder for the newly created instruction.
549 MachineInstrBuilder buildMaskLowPtrBits(const DstOp &Res, const SrcOp &Op0,
550 uint32_t NumBits);
551
552 /// Build and insert
553 /// a, b, ..., x = G_UNMERGE_VALUES \p Op0
554 /// \p Res = G_BUILD_VECTOR a, b, ..., x, undef, ..., undef
555 ///
556 /// Pad \p Op0 with undef elements to match number of elements in \p Res.
557 ///
558 /// \pre setBasicBlock or setMI must have been called.
559 /// \pre \p Res and \p Op0 must be generic virtual registers with vector type,
560 /// same vector element type and Op0 must have fewer elements then Res.
561 ///
562 /// \return a MachineInstrBuilder for the newly created build vector instr.
564 const SrcOp &Op0);
565
566 /// Build and insert
567 /// a, b, ..., x, y, z = G_UNMERGE_VALUES \p Op0
568 /// \p Res = G_BUILD_VECTOR a, b, ..., x
569 ///
570 /// Delete trailing elements in \p Op0 to match number of elements in \p Res.
571 ///
572 /// \pre setBasicBlock or setMI must have been called.
573 /// \pre \p Res and \p Op0 must be generic virtual registers with vector type,
574 /// same vector element type and Op0 must have more elements then Res.
575 ///
576 /// \return a MachineInstrBuilder for the newly created build vector instr.
578 const SrcOp &Op0);
579
580 /// Build and insert \p Res, \p CarryOut = G_UADDO \p Op0, \p Op1
581 ///
582 /// G_UADDO sets \p Res to \p Op0 + \p Op1 (truncated to the bit width) and
583 /// sets \p CarryOut to 1 if the result overflowed in unsigned arithmetic.
584 ///
585 /// \pre setBasicBlock or setMI must have been called.
586 /// \pre \p Res, \p Op0 and \p Op1 must be generic virtual registers with the
587 /// same scalar type.
588 ////\pre \p CarryOut must be generic virtual register with scalar type
589 ///(typically s1)
590 ///
591 /// \return The newly created instruction.
592 MachineInstrBuilder buildUAddo(const DstOp &Res, const DstOp &CarryOut,
593 const SrcOp &Op0, const SrcOp &Op1) {
594 return buildInstr(TargetOpcode::G_UADDO, {Res, CarryOut}, {Op0, Op1});
595 }
596
597 /// Build and insert \p Res, \p CarryOut = G_USUBO \p Op0, \p Op1
598 MachineInstrBuilder buildUSubo(const DstOp &Res, const DstOp &CarryOut,
599 const SrcOp &Op0, const SrcOp &Op1) {
600 return buildInstr(TargetOpcode::G_USUBO, {Res, CarryOut}, {Op0, Op1});
601 }
602
603 /// Build and insert \p Res, \p CarryOut = G_SADDO \p Op0, \p Op1
604 MachineInstrBuilder buildSAddo(const DstOp &Res, const DstOp &CarryOut,
605 const SrcOp &Op0, const SrcOp &Op1) {
606 return buildInstr(TargetOpcode::G_SADDO, {Res, CarryOut}, {Op0, Op1});
607 }
608
609 /// Build and insert \p Res, \p CarryOut = G_SUBO \p Op0, \p Op1
610 MachineInstrBuilder buildSSubo(const DstOp &Res, const DstOp &CarryOut,
611 const SrcOp &Op0, const SrcOp &Op1) {
612 return buildInstr(TargetOpcode::G_SSUBO, {Res, CarryOut}, {Op0, Op1});
613 }
614
615 /// Build and insert \p Res, \p CarryOut = G_UADDE \p Op0,
616 /// \p Op1, \p CarryIn
617 ///
618 /// G_UADDE sets \p Res to \p Op0 + \p Op1 + \p CarryIn (truncated to the bit
619 /// width) and sets \p CarryOut to 1 if the result overflowed in unsigned
620 /// arithmetic.
621 ///
622 /// \pre setBasicBlock or setMI must have been called.
623 /// \pre \p Res, \p Op0 and \p Op1 must be generic virtual registers
624 /// with the same scalar type.
625 /// \pre \p CarryOut and \p CarryIn must be generic virtual
626 /// registers with the same scalar type (typically s1)
627 ///
628 /// \return The newly created instruction.
629 MachineInstrBuilder buildUAdde(const DstOp &Res, const DstOp &CarryOut,
630 const SrcOp &Op0, const SrcOp &Op1,
631 const SrcOp &CarryIn) {
632 return buildInstr(TargetOpcode::G_UADDE, {Res, CarryOut},
633 {Op0, Op1, CarryIn});
634 }
635
636 /// Build and insert \p Res, \p CarryOut = G_USUBE \p Op0, \p Op1, \p CarryInp
637 MachineInstrBuilder buildUSube(const DstOp &Res, const DstOp &CarryOut,
638 const SrcOp &Op0, const SrcOp &Op1,
639 const SrcOp &CarryIn) {
640 return buildInstr(TargetOpcode::G_USUBE, {Res, CarryOut},
641 {Op0, Op1, CarryIn});
642 }
643
644 /// Build and insert \p Res, \p CarryOut = G_SADDE \p Op0, \p Op1, \p CarryInp
645 MachineInstrBuilder buildSAdde(const DstOp &Res, const DstOp &CarryOut,
646 const SrcOp &Op0, const SrcOp &Op1,
647 const SrcOp &CarryIn) {
648 return buildInstr(TargetOpcode::G_SADDE, {Res, CarryOut},
649 {Op0, Op1, CarryIn});
650 }
651
652 /// Build and insert \p Res, \p CarryOut = G_SSUBE \p Op0, \p Op1, \p CarryInp
653 MachineInstrBuilder buildSSube(const DstOp &Res, const DstOp &CarryOut,
654 const SrcOp &Op0, const SrcOp &Op1,
655 const SrcOp &CarryIn) {
656 return buildInstr(TargetOpcode::G_SSUBE, {Res, CarryOut},
657 {Op0, Op1, CarryIn});
658 }
659
660 /// Build and insert \p Res = G_ANYEXT \p Op0
661 ///
662 /// G_ANYEXT produces a register of the specified width, with bits 0 to
663 /// sizeof(\p Ty) * 8 set to \p Op. The remaining bits are unspecified
664 /// (i.e. this is neither zero nor sign-extension). For a vector register,
665 /// each element is extended individually.
666 ///
667 /// \pre setBasicBlock or setMI must have been called.
668 /// \pre \p Res must be a generic virtual register with scalar or vector type.
669 /// \pre \p Op must be a generic virtual register with scalar or vector type.
670 /// \pre \p Op must be smaller than \p Res
671 ///
672 /// \return The newly created instruction.
673
674 MachineInstrBuilder buildAnyExt(const DstOp &Res, const SrcOp &Op);
675
676 /// Build and insert \p Res = G_SEXT \p Op
677 ///
678 /// G_SEXT produces a register of the specified width, with bits 0 to
679 /// sizeof(\p Ty) * 8 set to \p Op. The remaining bits are duplicated from the
680 /// high bit of \p Op (i.e. 2s-complement sign extended).
681 ///
682 /// \pre setBasicBlock or setMI must have been called.
683 /// \pre \p Res must be a generic virtual register with scalar or vector type.
684 /// \pre \p Op must be a generic virtual register with scalar or vector type.
685 /// \pre \p Op must be smaller than \p Res
686 ///
687 /// \return The newly created instruction.
688 MachineInstrBuilder buildSExt(const DstOp &Res, const SrcOp &Op);
689
690 /// Build and insert \p Res = G_SEXT_INREG \p Op, ImmOp
691 MachineInstrBuilder buildSExtInReg(const DstOp &Res, const SrcOp &Op, int64_t ImmOp) {
692 return buildInstr(TargetOpcode::G_SEXT_INREG, {Res}, {Op, SrcOp(ImmOp)});
693 }
694
695 /// Build and insert \p Res = G_FPEXT \p Op
697 std::optional<unsigned> Flags = std::nullopt) {
698 return buildInstr(TargetOpcode::G_FPEXT, {Res}, {Op}, Flags);
699 }
700
701 /// Build and insert a G_PTRTOINT instruction.
703 return buildInstr(TargetOpcode::G_PTRTOINT, {Dst}, {Src});
704 }
705
706 /// Build and insert a G_INTTOPTR instruction.
708 return buildInstr(TargetOpcode::G_INTTOPTR, {Dst}, {Src});
709 }
710
711 /// Build and insert \p Dst = G_BITCAST \p Src
712 MachineInstrBuilder buildBitcast(const DstOp &Dst, const SrcOp &Src) {
713 return buildInstr(TargetOpcode::G_BITCAST, {Dst}, {Src});
714 }
715
716 /// Build and insert \p Dst = G_ADDRSPACE_CAST \p Src
718 return buildInstr(TargetOpcode::G_ADDRSPACE_CAST, {Dst}, {Src});
719 }
720
721 /// \return The opcode of the extension the target wants to use for boolean
722 /// values.
723 unsigned getBoolExtOp(bool IsVec, bool IsFP) const;
724
725 // Build and insert \p Res = G_ANYEXT \p Op, \p Res = G_SEXT \p Op, or \p Res
726 // = G_ZEXT \p Op depending on how the target wants to extend boolean values.
727 MachineInstrBuilder buildBoolExt(const DstOp &Res, const SrcOp &Op,
728 bool IsFP);
729
730 // Build and insert \p Res = G_SEXT_INREG \p Op, 1 or \p Res = G_AND \p Op, 1,
731 // or COPY depending on how the target wants to extend boolean values, using
732 // the original register size.
734 bool IsVector,
735 bool IsFP);
736
737 /// Build and insert \p Res = G_ZEXT \p Op
738 ///
739 /// G_ZEXT produces a register of the specified width, with bits 0 to
740 /// sizeof(\p Ty) * 8 set to \p Op. The remaining bits are 0. For a vector
741 /// register, each element is extended individually.
742 ///
743 /// \pre setBasicBlock or setMI must have been called.
744 /// \pre \p Res must be a generic virtual register with scalar or vector type.
745 /// \pre \p Op must be a generic virtual register with scalar or vector type.
746 /// \pre \p Op must be smaller than \p Res
747 ///
748 /// \return The newly created instruction.
749 MachineInstrBuilder buildZExt(const DstOp &Res, const SrcOp &Op,
750 std::optional<unsigned> Flags = std::nullopt);
751
752 /// Build and insert \p Res = G_SEXT \p Op, \p Res = G_TRUNC \p Op, or
753 /// \p Res = COPY \p Op depending on the differing sizes of \p Res and \p Op.
754 /// ///
755 /// \pre setBasicBlock or setMI must have been called.
756 /// \pre \p Res must be a generic virtual register with scalar or vector type.
757 /// \pre \p Op must be a generic virtual register with scalar or vector type.
758 ///
759 /// \return The newly created instruction.
761
762 /// Build and insert \p Res = G_ZEXT \p Op, \p Res = G_TRUNC \p Op, or
763 /// \p Res = COPY \p Op depending on the differing sizes of \p Res and \p Op.
764 /// ///
765 /// \pre setBasicBlock or setMI must have been called.
766 /// \pre \p Res must be a generic virtual register with scalar or vector type.
767 /// \pre \p Op must be a generic virtual register with scalar or vector type.
768 ///
769 /// \return The newly created instruction.
771
772 // Build and insert \p Res = G_ANYEXT \p Op, \p Res = G_TRUNC \p Op, or
773 /// \p Res = COPY \p Op depending on the differing sizes of \p Res and \p Op.
774 /// ///
775 /// \pre setBasicBlock or setMI must have been called.
776 /// \pre \p Res must be a generic virtual register with scalar or vector type.
777 /// \pre \p Op must be a generic virtual register with scalar or vector type.
778 ///
779 /// \return The newly created instruction.
781
782 /// Build and insert \p Res = \p ExtOpc, \p Res = G_TRUNC \p
783 /// Op, or \p Res = COPY \p Op depending on the differing sizes of \p Res and
784 /// \p Op.
785 /// ///
786 /// \pre setBasicBlock or setMI must have been called.
787 /// \pre \p Res must be a generic virtual register with scalar or vector type.
788 /// \pre \p Op must be a generic virtual register with scalar or vector type.
789 ///
790 /// \return The newly created instruction.
791 MachineInstrBuilder buildExtOrTrunc(unsigned ExtOpc, const DstOp &Res,
792 const SrcOp &Op);
793
794 /// Build and inserts \p Res = \p G_AND \p Op, \p LowBitsSet(ImmOp)
795 /// Since there is no G_ZEXT_INREG like G_SEXT_INREG, the instruction is
796 /// emulated using G_AND.
798 int64_t ImmOp);
799
800 /// Build and insert an appropriate cast between two registers of equal size.
801 MachineInstrBuilder buildCast(const DstOp &Dst, const SrcOp &Src);
802
803 /// Build and insert G_BR \p Dest
804 ///
805 /// G_BR is an unconditional branch to \p Dest.
806 ///
807 /// \pre setBasicBlock or setMI must have been called.
808 ///
809 /// \return a MachineInstrBuilder for the newly created instruction.
811
812 /// Build and insert G_BRCOND \p Tst, \p Dest
813 ///
814 /// G_BRCOND is a conditional branch to \p Dest.
815 ///
816 /// \pre setBasicBlock or setMI must have been called.
817 /// \pre \p Tst must be a generic virtual register with scalar
818 /// type. At the beginning of legalization, this will be a single
819 /// bit (s1). Targets with interesting flags registers may change
820 /// this. For a wider type, whether the branch is taken must only
821 /// depend on bit 0 (for now).
822 ///
823 /// \return The newly created instruction.
825
826 /// Build and insert G_BRINDIRECT \p Tgt
827 ///
828 /// G_BRINDIRECT is an indirect branch to \p Tgt.
829 ///
830 /// \pre setBasicBlock or setMI must have been called.
831 /// \pre \p Tgt must be a generic virtual register with pointer type.
832 ///
833 /// \return a MachineInstrBuilder for the newly created instruction.
835
836 /// Build and insert G_BRJT \p TablePtr, \p JTI, \p IndexReg
837 ///
838 /// G_BRJT is a jump table branch using a table base pointer \p TablePtr,
839 /// jump table index \p JTI and index \p IndexReg
840 ///
841 /// \pre setBasicBlock or setMI must have been called.
842 /// \pre \p TablePtr must be a generic virtual register with pointer type.
843 /// \pre \p JTI must be a jump table index.
844 /// \pre \p IndexReg must be a generic virtual register with pointer type.
845 ///
846 /// \return a MachineInstrBuilder for the newly created instruction.
847 MachineInstrBuilder buildBrJT(Register TablePtr, unsigned JTI,
848 Register IndexReg);
849
850 /// Build and insert \p Res = G_CONSTANT \p Val
851 ///
852 /// G_CONSTANT is an integer constant with the specified size and value. \p
853 /// Val will be extended or truncated to the size of \p Reg.
854 ///
855 /// \pre setBasicBlock or setMI must have been called.
856 /// \pre \p Res must be a generic virtual register with scalar or pointer
857 /// type.
858 ///
859 /// \return The newly created instruction.
860 virtual MachineInstrBuilder buildConstant(const DstOp &Res,
861 const ConstantInt &Val);
862
863 /// Build and insert \p Res = G_CONSTANT \p Val
864 ///
865 /// G_CONSTANT is an integer constant with the specified size and value.
866 ///
867 /// \pre setBasicBlock or setMI must have been called.
868 /// \pre \p Res must be a generic virtual register with scalar type.
869 ///
870 /// \return The newly created instruction.
871 MachineInstrBuilder buildConstant(const DstOp &Res, int64_t Val);
872 MachineInstrBuilder buildConstant(const DstOp &Res, const APInt &Val);
873
874 /// Build and insert \p Res = G_FCONSTANT \p Val
875 ///
876 /// G_FCONSTANT is a floating-point constant with the specified size and
877 /// value.
878 ///
879 /// \pre setBasicBlock or setMI must have been called.
880 /// \pre \p Res must be a generic virtual register with scalar type.
881 ///
882 /// \return The newly created instruction.
883 virtual MachineInstrBuilder buildFConstant(const DstOp &Res,
884 const ConstantFP &Val);
885
886 MachineInstrBuilder buildFConstant(const DstOp &Res, double Val);
887 MachineInstrBuilder buildFConstant(const DstOp &Res, const APFloat &Val);
888
889 /// Build and insert \p Res = COPY Op
890 ///
891 /// Register-to-register COPY sets \p Res to \p Op.
892 ///
893 /// \pre setBasicBlock or setMI must have been called.
894 ///
895 /// \return a MachineInstrBuilder for the newly created instruction.
896 MachineInstrBuilder buildCopy(const DstOp &Res, const SrcOp &Op);
897
898
899 /// Build and insert G_ASSERT_SEXT, G_ASSERT_ZEXT, or G_ASSERT_ALIGN
900 ///
901 /// \return a MachineInstrBuilder for the newly created instruction.
903 const SrcOp &Op, unsigned Val) {
904 return buildInstr(Opc, Res, Op).addImm(Val);
905 }
906
907 /// Build and insert \p Res = G_ASSERT_ZEXT Op, Size
908 ///
909 /// \return a MachineInstrBuilder for the newly created instruction.
911 unsigned Size) {
912 return buildAssertInstr(TargetOpcode::G_ASSERT_ZEXT, Res, Op, Size);
913 }
914
915 /// Build and insert \p Res = G_ASSERT_SEXT Op, Size
916 ///
917 /// \return a MachineInstrBuilder for the newly created instruction.
919 unsigned Size) {
920 return buildAssertInstr(TargetOpcode::G_ASSERT_SEXT, Res, Op, Size);
921 }
922
923 /// Build and insert \p Res = G_ASSERT_ALIGN Op, AlignVal
924 ///
925 /// \return a MachineInstrBuilder for the newly created instruction.
927 Align AlignVal) {
928 return buildAssertInstr(TargetOpcode::G_ASSERT_ALIGN, Res, Op,
929 AlignVal.value());
930 }
931
932 /// Build and insert `Res = G_LOAD Addr, MMO`.
933 ///
934 /// Loads the value stored at \p Addr. Puts the result in \p Res.
935 ///
936 /// \pre setBasicBlock or setMI must have been called.
937 /// \pre \p Res must be a generic virtual register.
938 /// \pre \p Addr must be a generic virtual register with pointer type.
939 ///
940 /// \return a MachineInstrBuilder for the newly created instruction.
942 MachineMemOperand &MMO) {
943 return buildLoadInstr(TargetOpcode::G_LOAD, Res, Addr, MMO);
944 }
945
946 /// Build and insert a G_LOAD instruction, while constructing the
947 /// MachineMemOperand.
949 buildLoad(const DstOp &Res, const SrcOp &Addr, MachinePointerInfo PtrInfo,
950 Align Alignment,
952 const AAMDNodes &AAInfo = AAMDNodes());
953
954 /// Build and insert `Res = <opcode> Addr, MMO`.
955 ///
956 /// Loads the value stored at \p Addr. Puts the result in \p Res.
957 ///
958 /// \pre setBasicBlock or setMI must have been called.
959 /// \pre \p Res must be a generic virtual register.
960 /// \pre \p Addr must be a generic virtual register with pointer type.
961 ///
962 /// \return a MachineInstrBuilder for the newly created instruction.
963 MachineInstrBuilder buildLoadInstr(unsigned Opcode, const DstOp &Res,
964 const SrcOp &Addr, MachineMemOperand &MMO);
965
966 /// Helper to create a load from a constant offset given a base address. Load
967 /// the type of \p Dst from \p Offset from the given base address and memory
968 /// operand.
970 const SrcOp &BasePtr,
971 MachineMemOperand &BaseMMO,
972 int64_t Offset);
973
974 /// Build and insert `G_STORE Val, Addr, MMO`.
975 ///
976 /// Stores the value \p Val to \p Addr.
977 ///
978 /// \pre setBasicBlock or setMI must have been called.
979 /// \pre \p Val must be a generic virtual register.
980 /// \pre \p Addr must be a generic virtual register with pointer type.
981 ///
982 /// \return a MachineInstrBuilder for the newly created instruction.
983 MachineInstrBuilder buildStore(const SrcOp &Val, const SrcOp &Addr,
984 MachineMemOperand &MMO);
985
986 /// Build and insert a G_STORE instruction, while constructing the
987 /// MachineMemOperand.
989 buildStore(const SrcOp &Val, const SrcOp &Addr, MachinePointerInfo PtrInfo,
990 Align Alignment,
992 const AAMDNodes &AAInfo = AAMDNodes());
993
994 /// Build and insert `Res0, ... = G_EXTRACT Src, Idx0`.
995 ///
996 /// \pre setBasicBlock or setMI must have been called.
997 /// \pre \p Res and \p Src must be generic virtual registers.
998 ///
999 /// \return a MachineInstrBuilder for the newly created instruction.
1000 MachineInstrBuilder buildExtract(const DstOp &Res, const SrcOp &Src, uint64_t Index);
1001
1002 /// Build and insert \p Res = IMPLICIT_DEF.
1004
1005 /// Build and insert \p Res = G_MERGE_VALUES \p Op0, ...
1006 ///
1007 /// G_MERGE_VALUES combines the input elements contiguously into a larger
1008 /// register. It should only be used when the destination register is not a
1009 /// vector.
1010 ///
1011 /// \pre setBasicBlock or setMI must have been called.
1012 /// \pre The entire register \p Res (and no more) must be covered by the input
1013 /// registers.
1014 /// \pre The type of all \p Ops registers must be identical.
1015 ///
1016 /// \return a MachineInstrBuilder for the newly created instruction.
1018 ArrayRef<Register> Ops);
1019
1020 /// Build and insert \p Res = G_MERGE_VALUES \p Op0, ...
1021 /// or \p Res = G_BUILD_VECTOR \p Op0, ...
1022 /// or \p Res = G_CONCAT_VECTORS \p Op0, ...
1023 ///
1024 /// G_MERGE_VALUES combines the input elements contiguously into a larger
1025 /// register. It is used when the destination register is not a vector.
1026 /// G_BUILD_VECTOR combines scalar inputs into a vector register.
1027 /// G_CONCAT_VECTORS combines vector inputs into a vector register.
1028 ///
1029 /// \pre setBasicBlock or setMI must have been called.
1030 /// \pre The entire register \p Res (and no more) must be covered by the input
1031 /// registers.
1032 /// \pre The type of all \p Ops registers must be identical.
1033 ///
1034 /// \return a MachineInstrBuilder for the newly created instruction. The
1035 /// opcode of the new instruction will depend on the types of both
1036 /// the destination and the sources.
1038 ArrayRef<Register> Ops);
1040 std::initializer_list<SrcOp> Ops);
1041
1042 /// Build and insert \p Res0, ... = G_UNMERGE_VALUES \p Op
1043 ///
1044 /// G_UNMERGE_VALUES splits contiguous bits of the input into multiple
1045 ///
1046 /// \pre setBasicBlock or setMI must have been called.
1047 /// \pre The entire register \p Res (and no more) must be covered by the input
1048 /// registers.
1049 /// \pre The type of all \p Res registers must be identical.
1050 ///
1051 /// \return a MachineInstrBuilder for the newly created instruction.
1054
1055 /// Build and insert an unmerge of \p Res sized pieces to cover \p Op
1057
1058 /// Build and insert \p Res = G_BUILD_VECTOR \p Op0, ...
1059 ///
1060 /// G_BUILD_VECTOR creates a vector value from multiple scalar registers.
1061 /// \pre setBasicBlock or setMI must have been called.
1062 /// \pre The entire register \p Res (and no more) must be covered by the
1063 /// input scalar registers.
1064 /// \pre The type of all \p Ops registers must be identical.
1065 ///
1066 /// \return a MachineInstrBuilder for the newly created instruction.
1068 ArrayRef<Register> Ops);
1069
1070 /// Build and insert \p Res = G_BUILD_VECTOR \p Op0, ... where each OpN is
1071 /// built with G_CONSTANT.
1073 ArrayRef<APInt> Ops);
1074
1075 /// Build and insert \p Res = G_BUILD_VECTOR with \p Src replicated to fill
1076 /// the number of elements
1077 MachineInstrBuilder buildSplatBuildVector(const DstOp &Res, const SrcOp &Src);
1078
1079 /// Build and insert \p Res = G_BUILD_VECTOR_TRUNC \p Op0, ...
1080 ///
1081 /// G_BUILD_VECTOR_TRUNC creates a vector value from multiple scalar registers
1082 /// which have types larger than the destination vector element type, and
1083 /// truncates the values to fit.
1084 ///
1085 /// If the operands given are already the same size as the vector elt type,
1086 /// then this method will instead create a G_BUILD_VECTOR instruction.
1087 ///
1088 /// \pre setBasicBlock or setMI must have been called.
1089 /// \pre The type of all \p Ops registers must be identical.
1090 ///
1091 /// \return a MachineInstrBuilder for the newly created instruction.
1093 ArrayRef<Register> Ops);
1094
1095 /// Build and insert a vector splat of a scalar \p Src using a
1096 /// G_INSERT_VECTOR_ELT and G_SHUFFLE_VECTOR idiom.
1097 ///
1098 /// \pre setBasicBlock or setMI must have been called.
1099 /// \pre \p Src must have the same type as the element type of \p Dst
1100 ///
1101 /// \return a MachineInstrBuilder for the newly created instruction.
1102 MachineInstrBuilder buildShuffleSplat(const DstOp &Res, const SrcOp &Src);
1103
1104 /// Build and insert \p Res = G_SHUFFLE_VECTOR \p Src1, \p Src2, \p Mask
1105 ///
1106 /// \pre setBasicBlock or setMI must have been called.
1107 ///
1108 /// \return a MachineInstrBuilder for the newly created instruction.
1109 MachineInstrBuilder buildShuffleVector(const DstOp &Res, const SrcOp &Src1,
1110 const SrcOp &Src2, ArrayRef<int> Mask);
1111
1112 /// Build and insert \p Res = G_SPLAT_VECTOR \p Val
1113 ///
1114 /// \pre setBasicBlock or setMI must have been called.
1115 /// \pre \p Res must be a generic virtual register with vector type.
1116 /// \pre \p Val must be a generic virtual register with scalar type.
1117 ///
1118 /// \return a MachineInstrBuilder for the newly created instruction.
1119 MachineInstrBuilder buildSplatVector(const DstOp &Res, const SrcOp &Val);
1120
1121 /// Build and insert \p Res = G_CONCAT_VECTORS \p Op0, ...
1122 ///
1123 /// G_CONCAT_VECTORS creates a vector from the concatenation of 2 or more
1124 /// vectors.
1125 ///
1126 /// \pre setBasicBlock or setMI must have been called.
1127 /// \pre The entire register \p Res (and no more) must be covered by the input
1128 /// registers.
1129 /// \pre The type of all source operands must be identical.
1130 ///
1131 /// \return a MachineInstrBuilder for the newly created instruction.
1133 ArrayRef<Register> Ops);
1134
1135 /// Build and insert `Res = G_INSERT_SUBVECTOR Src0, Src1, Idx`.
1136 ///
1137 /// \pre setBasicBlock or setMI must have been called.
1138 /// \pre \p Res, \p Src0, and \p Src1 must be generic virtual registers with
1139 /// vector type.
1140 ///
1141 /// \return a MachineInstrBuilder for the newly created instruction.
1142 MachineInstrBuilder buildInsertSubvector(const DstOp &Res, const SrcOp &Src0,
1143 const SrcOp &Src1, unsigned Index);
1144
1145 /// Build and insert `Res = G_EXTRACT_SUBVECTOR Src, Idx0`.
1146 ///
1147 /// \pre setBasicBlock or setMI must have been called.
1148 /// \pre \p Res and \p Src must be generic virtual registers with vector type.
1149 ///
1150 /// \return a MachineInstrBuilder for the newly created instruction.
1152 unsigned Index);
1153
1154 MachineInstrBuilder buildInsert(const DstOp &Res, const SrcOp &Src,
1155 const SrcOp &Op, unsigned Index);
1156
1157 /// Build and insert \p Res = G_VSCALE \p MinElts
1158 ///
1159 /// G_VSCALE puts the value of the runtime vscale multiplied by \p MinElts
1160 /// into \p Res.
1161 ///
1162 /// \pre setBasicBlock or setMI must have been called.
1163 /// \pre \p Res must be a generic virtual register with scalar type.
1164 ///
1165 /// \return a MachineInstrBuilder for the newly created instruction.
1166 MachineInstrBuilder buildVScale(const DstOp &Res, unsigned MinElts);
1167
1168 /// Build and insert \p Res = G_VSCALE \p MinElts
1169 ///
1170 /// G_VSCALE puts the value of the runtime vscale multiplied by \p MinElts
1171 /// into \p Res.
1172 ///
1173 /// \pre setBasicBlock or setMI must have been called.
1174 /// \pre \p Res must be a generic virtual register with scalar type.
1175 ///
1176 /// \return a MachineInstrBuilder for the newly created instruction.
1177 MachineInstrBuilder buildVScale(const DstOp &Res, const ConstantInt &MinElts);
1178
1179 /// Build and insert \p Res = G_VSCALE \p MinElts
1180 ///
1181 /// G_VSCALE puts the value of the runtime vscale multiplied by \p MinElts
1182 /// into \p Res.
1183 ///
1184 /// \pre setBasicBlock or setMI must have been called.
1185 /// \pre \p Res must be a generic virtual register with scalar type.
1186 ///
1187 /// \return a MachineInstrBuilder for the newly created instruction.
1188 MachineInstrBuilder buildVScale(const DstOp &Res, const APInt &MinElts);
1189
1190 /// Build and insert a G_INTRINSIC instruction.
1191 ///
1192 /// There are four different opcodes based on combinations of whether the
1193 /// intrinsic has side effects and whether it is convergent. These properties
1194 /// can be specified as explicit parameters, or else they are retrieved from
1195 /// the MCID for the intrinsic.
1196 ///
1197 /// The parameter \p Res provides the Registers or MOs that will be defined by
1198 /// this instruction.
1199 ///
1200 /// \pre setBasicBlock or setMI must have been called.
1201 ///
1202 /// \return a MachineInstrBuilder for the newly created instruction.
1204 bool HasSideEffects, bool isConvergent);
1207 bool HasSideEffects, bool isConvergent);
1209
1210 /// Build and insert \p Res = G_FPTRUNC \p Op
1211 ///
1212 /// G_FPTRUNC converts a floating-point value into one with a smaller type.
1213 ///
1214 /// \pre setBasicBlock or setMI must have been called.
1215 /// \pre \p Res must be a generic virtual register with scalar or vector type.
1216 /// \pre \p Op must be a generic virtual register with scalar or vector type.
1217 /// \pre \p Res must be smaller than \p Op
1218 ///
1219 /// \return The newly created instruction.
1221 buildFPTrunc(const DstOp &Res, const SrcOp &Op,
1222 std::optional<unsigned> Flags = std::nullopt);
1223
1224 /// Build and insert \p Res = G_TRUNC \p Op
1225 ///
1226 /// G_TRUNC extracts the low bits of a type. For a vector type each element is
1227 /// truncated independently before being packed into the destination.
1228 ///
1229 /// \pre setBasicBlock or setMI must have been called.
1230 /// \pre \p Res must be a generic virtual register with scalar or vector type.
1231 /// \pre \p Op must be a generic virtual register with scalar or vector type.
1232 /// \pre \p Res must be smaller than \p Op
1233 ///
1234 /// \return The newly created instruction.
1235 MachineInstrBuilder buildTrunc(const DstOp &Res, const SrcOp &Op,
1236 std::optional<unsigned> Flags = std::nullopt);
1237
1238 /// Build and insert a \p Res = G_ICMP \p Pred, \p Op0, \p Op1
1239 ///
1240 /// \pre setBasicBlock or setMI must have been called.
1241
1242 /// \pre \p Res must be a generic virtual register with scalar or
1243 /// vector type. Typically this starts as s1 or <N x s1>.
1244 /// \pre \p Op0 and Op1 must be generic virtual registers with the
1245 /// same number of elements as \p Res. If \p Res is a scalar,
1246 /// \p Op0 must be either a scalar or pointer.
1247 /// \pre \p Pred must be an integer predicate.
1248 ///
1249 /// \return a MachineInstrBuilder for the newly created instruction.
1251 const SrcOp &Op0, const SrcOp &Op1);
1252
1253 /// Build and insert a \p Res = G_FCMP \p Pred\p Op0, \p Op1
1254 ///
1255 /// \pre setBasicBlock or setMI must have been called.
1256
1257 /// \pre \p Res must be a generic virtual register with scalar or
1258 /// vector type. Typically this starts as s1 or <N x s1>.
1259 /// \pre \p Op0 and Op1 must be generic virtual registers with the
1260 /// same number of elements as \p Res (or scalar, if \p Res is
1261 /// scalar).
1262 /// \pre \p Pred must be a floating-point predicate.
1263 ///
1264 /// \return a MachineInstrBuilder for the newly created instruction.
1266 const SrcOp &Op0, const SrcOp &Op1,
1267 std::optional<unsigned> Flags = std::nullopt);
1268
1269 /// Build and insert a \p Res = G_IS_FPCLASS \p Src, \p Mask
1271 unsigned Mask) {
1272 return buildInstr(TargetOpcode::G_IS_FPCLASS, {Res},
1273 {Src, SrcOp(static_cast<int64_t>(Mask))});
1274 }
1275
1276 /// Build and insert a \p Res = G_SELECT \p Tst, \p Op0, \p Op1
1277 ///
1278 /// \pre setBasicBlock or setMI must have been called.
1279 /// \pre \p Res, \p Op0 and \p Op1 must be generic virtual registers
1280 /// with the same type.
1281 /// \pre \p Tst must be a generic virtual register with scalar, pointer or
1282 /// vector type. If vector then it must have the same number of
1283 /// elements as the other parameters.
1284 ///
1285 /// \return a MachineInstrBuilder for the newly created instruction.
1286 MachineInstrBuilder buildSelect(const DstOp &Res, const SrcOp &Tst,
1287 const SrcOp &Op0, const SrcOp &Op1,
1288 std::optional<unsigned> Flags = std::nullopt);
1289
1290 /// Build and insert \p Res = G_INSERT_VECTOR_ELT \p Val,
1291 /// \p Elt, \p Idx
1292 ///
1293 /// \pre setBasicBlock or setMI must have been called.
1294 /// \pre \p Res and \p Val must be a generic virtual register
1295 // with the same vector type.
1296 /// \pre \p Elt and \p Idx must be a generic virtual register
1297 /// with scalar type.
1298 ///
1299 /// \return The newly created instruction.
1301 const SrcOp &Val,
1302 const SrcOp &Elt,
1303 const SrcOp &Idx);
1304
1305 /// Build and insert \p Res = G_EXTRACT_VECTOR_ELT \p Val, \p Idx
1306 ///
1307 /// \pre setBasicBlock or setMI must have been called.
1308 /// \pre \p Res must be a generic virtual register with scalar type.
1309 /// \pre \p Val must be a generic virtual register with vector type.
1310 ///
1311 /// \return The newly created instruction.
1313 const SrcOp &Val,
1314 const int Idx) {
1315 auto TLI = getMF().getSubtarget().getTargetLowering();
1316 unsigned VecIdxWidth = TLI->getVectorIdxTy(getDataLayout()).getSizeInBits();
1318 Res, Val, buildConstant(LLT::scalar(VecIdxWidth), Idx));
1319 }
1320
1321 /// Build and insert \p Res = G_EXTRACT_VECTOR_ELT \p Val, \p Idx
1322 ///
1323 /// \pre setBasicBlock or setMI must have been called.
1324 /// \pre \p Res must be a generic virtual register with scalar type.
1325 /// \pre \p Val must be a generic virtual register with vector type.
1326 /// \pre \p Idx must be a generic virtual register with scalar type.
1327 ///
1328 /// \return The newly created instruction.
1330 const SrcOp &Val,
1331 const SrcOp &Idx);
1332
1333 /// Build and insert `OldValRes<def>, SuccessRes<def> =
1334 /// G_ATOMIC_CMPXCHG_WITH_SUCCESS Addr, CmpVal, NewVal, MMO`.
1335 ///
1336 /// Atomically replace the value at \p Addr with \p NewVal if it is currently
1337 /// \p CmpVal otherwise leaves it unchanged. Puts the original value from \p
1338 /// Addr in \p Res, along with an s1 indicating whether it was replaced.
1339 ///
1340 /// \pre setBasicBlock or setMI must have been called.
1341 /// \pre \p OldValRes must be a generic virtual register of scalar type.
1342 /// \pre \p SuccessRes must be a generic virtual register of scalar type. It
1343 /// will be assigned 0 on failure and 1 on success.
1344 /// \pre \p Addr must be a generic virtual register with pointer type.
1345 /// \pre \p OldValRes, \p CmpVal, and \p NewVal must be generic virtual
1346 /// registers of the same type.
1347 ///
1348 /// \return a MachineInstrBuilder for the newly created instruction.
1350 buildAtomicCmpXchgWithSuccess(const DstOp &OldValRes, const DstOp &SuccessRes,
1351 const SrcOp &Addr, const SrcOp &CmpVal,
1352 const SrcOp &NewVal, MachineMemOperand &MMO);
1353
1354 /// Build and insert `OldValRes<def> = G_ATOMIC_CMPXCHG Addr, CmpVal, NewVal,
1355 /// MMO`.
1356 ///
1357 /// Atomically replace the value at \p Addr with \p NewVal if it is currently
1358 /// \p CmpVal otherwise leaves it unchanged. Puts the original value from \p
1359 /// Addr in \p Res.
1360 ///
1361 /// \pre setBasicBlock or setMI must have been called.
1362 /// \pre \p OldValRes must be a generic virtual register of scalar type.
1363 /// \pre \p Addr must be a generic virtual register with pointer type.
1364 /// \pre \p OldValRes, \p CmpVal, and \p NewVal must be generic virtual
1365 /// registers of the same type.
1366 ///
1367 /// \return a MachineInstrBuilder for the newly created instruction.
1369 const SrcOp &Addr, const SrcOp &CmpVal,
1370 const SrcOp &NewVal,
1371 MachineMemOperand &MMO);
1372
1373 /// Build and insert `OldValRes<def> = G_ATOMICRMW_<Opcode> Addr, Val, MMO`.
1374 ///
1375 /// Atomically read-modify-update the value at \p Addr with \p Val. Puts the
1376 /// original value from \p Addr in \p OldValRes. The modification is
1377 /// determined by the opcode.
1378 ///
1379 /// \pre setBasicBlock or setMI must have been called.
1380 /// \pre \p OldValRes must be a generic virtual register.
1381 /// \pre \p Addr must be a generic virtual register with pointer type.
1382 /// \pre \p OldValRes, and \p Val must be generic virtual registers of the
1383 /// same type.
1384 ///
1385 /// \return a MachineInstrBuilder for the newly created instruction.
1386 MachineInstrBuilder buildAtomicRMW(unsigned Opcode, const DstOp &OldValRes,
1387 const SrcOp &Addr, const SrcOp &Val,
1388 MachineMemOperand &MMO);
1389
1390 /// Build and insert `OldValRes<def> = G_ATOMICRMW_XCHG Addr, Val, MMO`.
1391 ///
1392 /// Atomically replace the value at \p Addr with \p Val. Puts the original
1393 /// value from \p Addr in \p OldValRes.
1394 ///
1395 /// \pre setBasicBlock or setMI must have been called.
1396 /// \pre \p OldValRes must be a generic virtual register.
1397 /// \pre \p Addr must be a generic virtual register with pointer type.
1398 /// \pre \p OldValRes, and \p Val must be generic virtual registers of the
1399 /// same type.
1400 ///
1401 /// \return a MachineInstrBuilder for the newly created instruction.
1403 Register Val, MachineMemOperand &MMO);
1404
1405 /// Build and insert `OldValRes<def> = G_ATOMICRMW_ADD Addr, Val, MMO`.
1406 ///
1407 /// Atomically replace the value at \p Addr with the addition of \p Val and
1408 /// the original value. Puts the original value from \p Addr in \p OldValRes.
1409 ///
1410 /// \pre setBasicBlock or setMI must have been called.
1411 /// \pre \p OldValRes must be a generic virtual register.
1412 /// \pre \p Addr must be a generic virtual register with pointer type.
1413 /// \pre \p OldValRes, and \p Val must be generic virtual registers of the
1414 /// same type.
1415 ///
1416 /// \return a MachineInstrBuilder for the newly created instruction.
1418 Register Val, MachineMemOperand &MMO);
1419
1420 /// Build and insert `OldValRes<def> = G_ATOMICRMW_SUB Addr, Val, MMO`.
1421 ///
1422 /// Atomically replace the value at \p Addr with the subtraction of \p Val and
1423 /// the original value. Puts the original value from \p Addr in \p OldValRes.
1424 ///
1425 /// \pre setBasicBlock or setMI must have been called.
1426 /// \pre \p OldValRes must be a generic virtual register.
1427 /// \pre \p Addr must be a generic virtual register with pointer type.
1428 /// \pre \p OldValRes, and \p Val must be generic virtual registers of the
1429 /// same type.
1430 ///
1431 /// \return a MachineInstrBuilder for the newly created instruction.
1433 Register Val, MachineMemOperand &MMO);
1434
1435 /// Build and insert `OldValRes<def> = G_ATOMICRMW_AND Addr, Val, MMO`.
1436 ///
1437 /// Atomically replace the value at \p Addr with the bitwise and of \p Val and
1438 /// the original value. Puts the original value from \p Addr in \p OldValRes.
1439 ///
1440 /// \pre setBasicBlock or setMI must have been called.
1441 /// \pre \p OldValRes must be a generic virtual register.
1442 /// \pre \p Addr must be a generic virtual register with pointer type.
1443 /// \pre \p OldValRes, and \p Val must be generic virtual registers of the
1444 /// same type.
1445 ///
1446 /// \return a MachineInstrBuilder for the newly created instruction.
1448 Register Val, MachineMemOperand &MMO);
1449
1450 /// Build and insert `OldValRes<def> = G_ATOMICRMW_NAND Addr, Val, MMO`.
1451 ///
1452 /// Atomically replace the value at \p Addr with the bitwise nand of \p Val
1453 /// and the original value. Puts the original value from \p Addr in \p
1454 /// OldValRes.
1455 ///
1456 /// \pre setBasicBlock or setMI must have been called.
1457 /// \pre \p OldValRes must be a generic virtual register.
1458 /// \pre \p Addr must be a generic virtual register with pointer type.
1459 /// \pre \p OldValRes, and \p Val must be generic virtual registers of the
1460 /// same type.
1461 ///
1462 /// \return a MachineInstrBuilder for the newly created instruction.
1464 Register Val, MachineMemOperand &MMO);
1465
1466 /// Build and insert `OldValRes<def> = G_ATOMICRMW_OR Addr, Val, MMO`.
1467 ///
1468 /// Atomically replace the value at \p Addr with the bitwise or of \p Val and
1469 /// the original value. Puts the original value from \p Addr in \p OldValRes.
1470 ///
1471 /// \pre setBasicBlock or setMI must have been called.
1472 /// \pre \p OldValRes must be a generic virtual register.
1473 /// \pre \p Addr must be a generic virtual register with pointer type.
1474 /// \pre \p OldValRes, and \p Val must be generic virtual registers of the
1475 /// same type.
1476 ///
1477 /// \return a MachineInstrBuilder for the newly created instruction.
1479 Register Val, MachineMemOperand &MMO);
1480
1481 /// Build and insert `OldValRes<def> = G_ATOMICRMW_XOR Addr, Val, MMO`.
1482 ///
1483 /// Atomically replace the value at \p Addr with the bitwise xor of \p Val and
1484 /// the original value. Puts the original value from \p Addr in \p OldValRes.
1485 ///
1486 /// \pre setBasicBlock or setMI must have been called.
1487 /// \pre \p OldValRes must be a generic virtual register.
1488 /// \pre \p Addr must be a generic virtual register with pointer type.
1489 /// \pre \p OldValRes, and \p Val must be generic virtual registers of the
1490 /// same type.
1491 ///
1492 /// \return a MachineInstrBuilder for the newly created instruction.
1494 Register Val, MachineMemOperand &MMO);
1495
1496 /// Build and insert `OldValRes<def> = G_ATOMICRMW_MAX Addr, Val, MMO`.
1497 ///
1498 /// Atomically replace the value at \p Addr with the signed maximum of \p
1499 /// Val and the original value. Puts the original value from \p Addr in \p
1500 /// OldValRes.
1501 ///
1502 /// \pre setBasicBlock or setMI must have been called.
1503 /// \pre \p OldValRes must be a generic virtual register.
1504 /// \pre \p Addr must be a generic virtual register with pointer type.
1505 /// \pre \p OldValRes, and \p Val must be generic virtual registers of the
1506 /// same type.
1507 ///
1508 /// \return a MachineInstrBuilder for the newly created instruction.
1510 Register Val, MachineMemOperand &MMO);
1511
1512 /// Build and insert `OldValRes<def> = G_ATOMICRMW_MIN Addr, Val, MMO`.
1513 ///
1514 /// Atomically replace the value at \p Addr with the signed minimum of \p
1515 /// Val and the original value. Puts the original value from \p Addr in \p
1516 /// OldValRes.
1517 ///
1518 /// \pre setBasicBlock or setMI must have been called.
1519 /// \pre \p OldValRes must be a generic virtual register.
1520 /// \pre \p Addr must be a generic virtual register with pointer type.
1521 /// \pre \p OldValRes, and \p Val must be generic virtual registers of the
1522 /// same type.
1523 ///
1524 /// \return a MachineInstrBuilder for the newly created instruction.
1526 Register Val, MachineMemOperand &MMO);
1527
1528 /// Build and insert `OldValRes<def> = G_ATOMICRMW_UMAX Addr, Val, MMO`.
1529 ///
1530 /// Atomically replace the value at \p Addr with the unsigned maximum of \p
1531 /// Val and the original value. Puts the original value from \p Addr in \p
1532 /// OldValRes.
1533 ///
1534 /// \pre setBasicBlock or setMI must have been called.
1535 /// \pre \p OldValRes must be a generic virtual register.
1536 /// \pre \p Addr must be a generic virtual register with pointer type.
1537 /// \pre \p OldValRes, and \p Val must be generic virtual registers of the
1538 /// same type.
1539 ///
1540 /// \return a MachineInstrBuilder for the newly created instruction.
1542 Register Val, MachineMemOperand &MMO);
1543
1544 /// Build and insert `OldValRes<def> = G_ATOMICRMW_UMIN Addr, Val, MMO`.
1545 ///
1546 /// Atomically replace the value at \p Addr with the unsigned minimum of \p
1547 /// Val and the original value. Puts the original value from \p Addr in \p
1548 /// OldValRes.
1549 ///
1550 /// \pre setBasicBlock or setMI must have been called.
1551 /// \pre \p OldValRes must be a generic virtual register.
1552 /// \pre \p Addr must be a generic virtual register with pointer type.
1553 /// \pre \p OldValRes, and \p Val must be generic virtual registers of the
1554 /// same type.
1555 ///
1556 /// \return a MachineInstrBuilder for the newly created instruction.
1558 Register Val, MachineMemOperand &MMO);
1559
1560 /// Build and insert `OldValRes<def> = G_ATOMICRMW_FADD Addr, Val, MMO`.
1562 const DstOp &OldValRes, const SrcOp &Addr, const SrcOp &Val,
1563 MachineMemOperand &MMO);
1564
1565 /// Build and insert `OldValRes<def> = G_ATOMICRMW_FSUB Addr, Val, MMO`.
1567 const DstOp &OldValRes, const SrcOp &Addr, const SrcOp &Val,
1568 MachineMemOperand &MMO);
1569
1570 /// Build and insert `OldValRes<def> = G_ATOMICRMW_FMAX Addr, Val, MMO`.
1571 ///
1572 /// Atomically replace the value at \p Addr with the floating point maximum of
1573 /// \p Val and the original value. Puts the original value from \p Addr in \p
1574 /// OldValRes.
1575 ///
1576 /// \pre setBasicBlock or setMI must have been called.
1577 /// \pre \p OldValRes must be a generic virtual register.
1578 /// \pre \p Addr must be a generic virtual register with pointer type.
1579 /// \pre \p OldValRes, and \p Val must be generic virtual registers of the
1580 /// same type.
1581 ///
1582 /// \return a MachineInstrBuilder for the newly created instruction.
1584 const DstOp &OldValRes, const SrcOp &Addr, const SrcOp &Val,
1585 MachineMemOperand &MMO);
1586
1587 /// Build and insert `OldValRes<def> = G_ATOMICRMW_FMIN Addr, Val, MMO`.
1588 ///
1589 /// Atomically replace the value at \p Addr with the floating point minimum of
1590 /// \p Val and the original value. Puts the original value from \p Addr in \p
1591 /// OldValRes.
1592 ///
1593 /// \pre setBasicBlock or setMI must have been called.
1594 /// \pre \p OldValRes must be a generic virtual register.
1595 /// \pre \p Addr must be a generic virtual register with pointer type.
1596 /// \pre \p OldValRes, and \p Val must be generic virtual registers of the
1597 /// same type.
1598 ///
1599 /// \return a MachineInstrBuilder for the newly created instruction.
1601 const DstOp &OldValRes, const SrcOp &Addr, const SrcOp &Val,
1602 MachineMemOperand &MMO);
1603
1604 /// Build and insert `G_FENCE Ordering, Scope`.
1605 MachineInstrBuilder buildFence(unsigned Ordering, unsigned Scope);
1606
1607 /// Build and insert G_PREFETCH \p Addr, \p RW, \p Locality, \p CacheType
1608 MachineInstrBuilder buildPrefetch(const SrcOp &Addr, unsigned RW,
1609 unsigned Locality, unsigned CacheType,
1610 MachineMemOperand &MMO);
1611
1612 /// Build and insert \p Dst = G_FREEZE \p Src
1613 MachineInstrBuilder buildFreeze(const DstOp &Dst, const SrcOp &Src) {
1614 return buildInstr(TargetOpcode::G_FREEZE, {Dst}, {Src});
1615 }
1616
1617 /// Build and insert \p Res = G_BLOCK_ADDR \p BA
1618 ///
1619 /// G_BLOCK_ADDR computes the address of a basic block.
1620 ///
1621 /// \pre setBasicBlock or setMI must have been called.
1622 /// \pre \p Res must be a generic virtual register of a pointer type.
1623 ///
1624 /// \return The newly created instruction.
1626
1627 /// Build and insert \p Res = G_ADD \p Op0, \p Op1
1628 ///
1629 /// G_ADD sets \p Res to the sum of integer parameters \p Op0 and \p Op1,
1630 /// truncated to their width.
1631 ///
1632 /// \pre setBasicBlock or setMI must have been called.
1633 /// \pre \p Res, \p Op0 and \p Op1 must be generic virtual registers
1634 /// with the same (scalar or vector) type).
1635 ///
1636 /// \return a MachineInstrBuilder for the newly created instruction.
1637
1638 MachineInstrBuilder buildAdd(const DstOp &Dst, const SrcOp &Src0,
1639 const SrcOp &Src1,
1640 std::optional<unsigned> Flags = std::nullopt) {
1641 return buildInstr(TargetOpcode::G_ADD, {Dst}, {Src0, Src1}, Flags);
1642 }
1643
1644 /// Build and insert \p Res = G_SUB \p Op0, \p Op1
1645 ///
1646 /// G_SUB sets \p Res to the difference of integer parameters \p Op0 and
1647 /// \p Op1, truncated to their width.
1648 ///
1649 /// \pre setBasicBlock or setMI must have been called.
1650 /// \pre \p Res, \p Op0 and \p Op1 must be generic virtual registers
1651 /// with the same (scalar or vector) type).
1652 ///
1653 /// \return a MachineInstrBuilder for the newly created instruction.
1654
1655 MachineInstrBuilder buildSub(const DstOp &Dst, const SrcOp &Src0,
1656 const SrcOp &Src1,
1657 std::optional<unsigned> Flags = std::nullopt) {
1658 return buildInstr(TargetOpcode::G_SUB, {Dst}, {Src0, Src1}, Flags);
1659 }
1660
1661 /// Build and insert \p Res = G_MUL \p Op0, \p Op1
1662 ///
1663 /// G_MUL sets \p Res to the product of integer parameters \p Op0 and \p Op1,
1664 /// truncated to their width.
1665 ///
1666 /// \pre setBasicBlock or setMI must have been called.
1667 /// \pre \p Res, \p Op0 and \p Op1 must be generic virtual registers
1668 /// with the same (scalar or vector) type).
1669 ///
1670 /// \return a MachineInstrBuilder for the newly created instruction.
1671 MachineInstrBuilder buildMul(const DstOp &Dst, const SrcOp &Src0,
1672 const SrcOp &Src1,
1673 std::optional<unsigned> Flags = std::nullopt) {
1674 return buildInstr(TargetOpcode::G_MUL, {Dst}, {Src0, Src1}, Flags);
1675 }
1676
1678 const SrcOp &Src1,
1679 std::optional<unsigned> Flags = std::nullopt) {
1680 return buildInstr(TargetOpcode::G_UMULH, {Dst}, {Src0, Src1}, Flags);
1681 }
1682
1684 const SrcOp &Src1,
1685 std::optional<unsigned> Flags = std::nullopt) {
1686 return buildInstr(TargetOpcode::G_SMULH, {Dst}, {Src0, Src1}, Flags);
1687 }
1688
1689 /// Build and insert \p Res = G_UREM \p Op0, \p Op1
1690 MachineInstrBuilder buildURem(const DstOp &Dst, const SrcOp &Src0,
1691 const SrcOp &Src1,
1692 std::optional<unsigned> Flags = std::nullopt) {
1693 return buildInstr(TargetOpcode::G_UREM, {Dst}, {Src0, Src1}, Flags);
1694 }
1695
1696 MachineInstrBuilder buildFMul(const DstOp &Dst, const SrcOp &Src0,
1697 const SrcOp &Src1,
1698 std::optional<unsigned> Flags = std::nullopt) {
1699 return buildInstr(TargetOpcode::G_FMUL, {Dst}, {Src0, Src1}, Flags);
1700 }
1701
1703 buildFMinNum(const DstOp &Dst, const SrcOp &Src0, const SrcOp &Src1,
1704 std::optional<unsigned> Flags = std::nullopt) {
1705 return buildInstr(TargetOpcode::G_FMINNUM, {Dst}, {Src0, Src1}, Flags);
1706 }
1707
1709 buildFMaxNum(const DstOp &Dst, const SrcOp &Src0, const SrcOp &Src1,
1710 std::optional<unsigned> Flags = std::nullopt) {
1711 return buildInstr(TargetOpcode::G_FMAXNUM, {Dst}, {Src0, Src1}, Flags);
1712 }
1713
1715 buildFMinNumIEEE(const DstOp &Dst, const SrcOp &Src0, const SrcOp &Src1,
1716 std::optional<unsigned> Flags = std::nullopt) {
1717 return buildInstr(TargetOpcode::G_FMINNUM_IEEE, {Dst}, {Src0, Src1}, Flags);
1718 }
1719
1721 buildFMaxNumIEEE(const DstOp &Dst, const SrcOp &Src0, const SrcOp &Src1,
1722 std::optional<unsigned> Flags = std::nullopt) {
1723 return buildInstr(TargetOpcode::G_FMAXNUM_IEEE, {Dst}, {Src0, Src1}, Flags);
1724 }
1725
1726 MachineInstrBuilder buildShl(const DstOp &Dst, const SrcOp &Src0,
1727 const SrcOp &Src1,
1728 std::optional<unsigned> Flags = std::nullopt) {
1729 return buildInstr(TargetOpcode::G_SHL, {Dst}, {Src0, Src1}, Flags);
1730 }
1731
1732 MachineInstrBuilder buildLShr(const DstOp &Dst, const SrcOp &Src0,
1733 const SrcOp &Src1,
1734 std::optional<unsigned> Flags = std::nullopt) {
1735 return buildInstr(TargetOpcode::G_LSHR, {Dst}, {Src0, Src1}, Flags);
1736 }
1737
1738 MachineInstrBuilder buildAShr(const DstOp &Dst, const SrcOp &Src0,
1739 const SrcOp &Src1,
1740 std::optional<unsigned> Flags = std::nullopt) {
1741 return buildInstr(TargetOpcode::G_ASHR, {Dst}, {Src0, Src1}, Flags);
1742 }
1743
1744 /// Build and insert \p Res = G_AND \p Op0, \p Op1
1745 ///
1746 /// G_AND sets \p Res to the bitwise and of integer parameters \p Op0 and \p
1747 /// Op1.
1748 ///
1749 /// \pre setBasicBlock or setMI must have been called.
1750 /// \pre \p Res, \p Op0 and \p Op1 must be generic virtual registers
1751 /// with the same (scalar or vector) type).
1752 ///
1753 /// \return a MachineInstrBuilder for the newly created instruction.
1754
1755 MachineInstrBuilder buildAnd(const DstOp &Dst, const SrcOp &Src0,
1756 const SrcOp &Src1) {
1757 return buildInstr(TargetOpcode::G_AND, {Dst}, {Src0, Src1});
1758 }
1759
1760 /// Build and insert \p Res = G_OR \p Op0, \p Op1
1761 ///
1762 /// G_OR sets \p Res to the bitwise or of integer parameters \p Op0 and \p
1763 /// Op1.
1764 ///
1765 /// \pre setBasicBlock or setMI must have been called.
1766 /// \pre \p Res, \p Op0 and \p Op1 must be generic virtual registers
1767 /// with the same (scalar or vector) type).
1768 ///
1769 /// \return a MachineInstrBuilder for the newly created instruction.
1770 MachineInstrBuilder buildOr(const DstOp &Dst, const SrcOp &Src0,
1771 const SrcOp &Src1,
1772 std::optional<unsigned> Flags = std::nullopt) {
1773 return buildInstr(TargetOpcode::G_OR, {Dst}, {Src0, Src1}, Flags);
1774 }
1775
1776 /// Build and insert \p Res = G_XOR \p Op0, \p Op1
1777 MachineInstrBuilder buildXor(const DstOp &Dst, const SrcOp &Src0,
1778 const SrcOp &Src1) {
1779 return buildInstr(TargetOpcode::G_XOR, {Dst}, {Src0, Src1});
1780 }
1781
1782 /// Build and insert a bitwise not,
1783 /// \p NegOne = G_CONSTANT -1
1784 /// \p Res = G_OR \p Op0, NegOne
1785 MachineInstrBuilder buildNot(const DstOp &Dst, const SrcOp &Src0) {
1786 auto NegOne = buildConstant(Dst.getLLTTy(*getMRI()), -1);
1787 return buildInstr(TargetOpcode::G_XOR, {Dst}, {Src0, NegOne});
1788 }
1789
1790 /// Build and insert integer negation
1791 /// \p Zero = G_CONSTANT 0
1792 /// \p Res = G_SUB Zero, \p Op0
1793 MachineInstrBuilder buildNeg(const DstOp &Dst, const SrcOp &Src0) {
1794 auto Zero = buildConstant(Dst.getLLTTy(*getMRI()), 0);
1795 return buildInstr(TargetOpcode::G_SUB, {Dst}, {Zero, Src0});
1796 }
1797
1798 /// Build and insert \p Res = G_CTPOP \p Op0, \p Src0
1799 MachineInstrBuilder buildCTPOP(const DstOp &Dst, const SrcOp &Src0) {
1800 return buildInstr(TargetOpcode::G_CTPOP, {Dst}, {Src0});
1801 }
1802
1803 /// Build and insert \p Res = G_CTLZ \p Op0, \p Src0
1804 MachineInstrBuilder buildCTLZ(const DstOp &Dst, const SrcOp &Src0) {
1805 return buildInstr(TargetOpcode::G_CTLZ, {Dst}, {Src0});
1806 }
1807
1808 /// Build and insert \p Res = G_CTLZ_ZERO_UNDEF \p Op0, \p Src0
1810 return buildInstr(TargetOpcode::G_CTLZ_ZERO_UNDEF, {Dst}, {Src0});
1811 }
1812
1813 /// Build and insert \p Res = G_CTTZ \p Op0, \p Src0
1814 MachineInstrBuilder buildCTTZ(const DstOp &Dst, const SrcOp &Src0) {
1815 return buildInstr(TargetOpcode::G_CTTZ, {Dst}, {Src0});
1816 }
1817
1818 /// Build and insert \p Res = G_CTTZ_ZERO_UNDEF \p Op0, \p Src0
1820 return buildInstr(TargetOpcode::G_CTTZ_ZERO_UNDEF, {Dst}, {Src0});
1821 }
1822
1823 /// Build and insert \p Dst = G_BSWAP \p Src0
1824 MachineInstrBuilder buildBSwap(const DstOp &Dst, const SrcOp &Src0) {
1825 return buildInstr(TargetOpcode::G_BSWAP, {Dst}, {Src0});
1826 }
1827
1828 /// Build and insert \p Res = G_FADD \p Op0, \p Op1
1829 MachineInstrBuilder buildFAdd(const DstOp &Dst, const SrcOp &Src0,
1830 const SrcOp &Src1,
1831 std::optional<unsigned> Flags = std::nullopt) {
1832 return buildInstr(TargetOpcode::G_FADD, {Dst}, {Src0, Src1}, Flags);
1833 }
1834
1835 /// Build and insert \p Res = G_STRICT_FADD \p Op0, \p Op1
1837 buildStrictFAdd(const DstOp &Dst, const SrcOp &Src0, const SrcOp &Src1,
1838 std::optional<unsigned> Flags = std::nullopt) {
1839 return buildInstr(TargetOpcode::G_STRICT_FADD, {Dst}, {Src0, Src1}, Flags);
1840 }
1841
1842 /// Build and insert \p Res = G_FSUB \p Op0, \p Op1
1843 MachineInstrBuilder buildFSub(const DstOp &Dst, const SrcOp &Src0,
1844 const SrcOp &Src1,
1845 std::optional<unsigned> Flags = std::nullopt) {
1846 return buildInstr(TargetOpcode::G_FSUB, {Dst}, {Src0, Src1}, Flags);
1847 }
1848
1849 /// Build and insert \p Res = G_FDIV \p Op0, \p Op1
1850 MachineInstrBuilder buildFDiv(const DstOp &Dst, const SrcOp &Src0,
1851 const SrcOp &Src1,
1852 std::optional<unsigned> Flags = std::nullopt) {
1853 return buildInstr(TargetOpcode::G_FDIV, {Dst}, {Src0, Src1}, Flags);
1854 }
1855
1856 /// Build and insert \p Res = G_FMA \p Op0, \p Op1, \p Op2
1857 MachineInstrBuilder buildFMA(const DstOp &Dst, const SrcOp &Src0,
1858 const SrcOp &Src1, const SrcOp &Src2,
1859 std::optional<unsigned> Flags = std::nullopt) {
1860 return buildInstr(TargetOpcode::G_FMA, {Dst}, {Src0, Src1, Src2}, Flags);
1861 }
1862
1863 /// Build and insert \p Res = G_FMAD \p Op0, \p Op1, \p Op2
1864 MachineInstrBuilder buildFMAD(const DstOp &Dst, const SrcOp &Src0,
1865 const SrcOp &Src1, const SrcOp &Src2,
1866 std::optional<unsigned> Flags = std::nullopt) {
1867 return buildInstr(TargetOpcode::G_FMAD, {Dst}, {Src0, Src1, Src2}, Flags);
1868 }
1869
1870 /// Build and insert \p Res = G_FNEG \p Op0
1871 MachineInstrBuilder buildFNeg(const DstOp &Dst, const SrcOp &Src0,
1872 std::optional<unsigned> Flags = std::nullopt) {
1873 return buildInstr(TargetOpcode::G_FNEG, {Dst}, {Src0}, Flags);
1874 }
1875
1876 /// Build and insert \p Res = G_FABS \p Op0
1877 MachineInstrBuilder buildFAbs(const DstOp &Dst, const SrcOp &Src0,
1878 std::optional<unsigned> Flags = std::nullopt) {
1879 return buildInstr(TargetOpcode::G_FABS, {Dst}, {Src0}, Flags);
1880 }
1881
1882 /// Build and insert \p Dst = G_FCANONICALIZE \p Src0
1884 buildFCanonicalize(const DstOp &Dst, const SrcOp &Src0,
1885 std::optional<unsigned> Flags = std::nullopt) {
1886 return buildInstr(TargetOpcode::G_FCANONICALIZE, {Dst}, {Src0}, Flags);
1887 }
1888
1889 /// Build and insert \p Dst = G_INTRINSIC_TRUNC \p Src0
1891 buildIntrinsicTrunc(const DstOp &Dst, const SrcOp &Src0,
1892 std::optional<unsigned> Flags = std::nullopt) {
1893 return buildInstr(TargetOpcode::G_INTRINSIC_TRUNC, {Dst}, {Src0}, Flags);
1894 }
1895
1896 /// Build and insert \p Res = GFFLOOR \p Op0, \p Op1
1898 buildFFloor(const DstOp &Dst, const SrcOp &Src0,
1899 std::optional<unsigned> Flags = std::nullopt) {
1900 return buildInstr(TargetOpcode::G_FFLOOR, {Dst}, {Src0}, Flags);
1901 }
1902
1903 /// Build and insert \p Dst = G_FLOG \p Src
1905 std::optional<unsigned> Flags = std::nullopt) {
1906 return buildInstr(TargetOpcode::G_FLOG, {Dst}, {Src}, Flags);
1907 }
1908
1909 /// Build and insert \p Dst = G_FLOG2 \p Src
1911 std::optional<unsigned> Flags = std::nullopt) {
1912 return buildInstr(TargetOpcode::G_FLOG2, {Dst}, {Src}, Flags);
1913 }
1914
1915 /// Build and insert \p Dst = G_FEXP2 \p Src
1917 std::optional<unsigned> Flags = std::nullopt) {
1918 return buildInstr(TargetOpcode::G_FEXP2, {Dst}, {Src}, Flags);
1919 }
1920
1921 /// Build and insert \p Dst = G_FPOW \p Src0, \p Src1
1922 MachineInstrBuilder buildFPow(const DstOp &Dst, const SrcOp &Src0,
1923 const SrcOp &Src1,
1924 std::optional<unsigned> Flags = std::nullopt) {
1925 return buildInstr(TargetOpcode::G_FPOW, {Dst}, {Src0, Src1}, Flags);
1926 }
1927
1928 /// Build and insert \p Dst = G_FLDEXP \p Src0, \p Src1
1930 buildFLdexp(const DstOp &Dst, const SrcOp &Src0, const SrcOp &Src1,
1931 std::optional<unsigned> Flags = std::nullopt) {
1932 return buildInstr(TargetOpcode::G_FLDEXP, {Dst}, {Src0, Src1}, Flags);
1933 }
1934
1935 /// Build and insert \p Fract, \p Exp = G_FFREXP \p Src
1937 buildFFrexp(const DstOp &Fract, const DstOp &Exp, const SrcOp &Src,
1938 std::optional<unsigned> Flags = std::nullopt) {
1939 return buildInstr(TargetOpcode::G_FFREXP, {Fract, Exp}, {Src}, Flags);
1940 }
1941
1942 /// Build and insert \p Res = G_FCOPYSIGN \p Op0, \p Op1
1944 const SrcOp &Src1) {
1945 return buildInstr(TargetOpcode::G_FCOPYSIGN, {Dst}, {Src0, Src1});
1946 }
1947
1948 /// Build and insert \p Res = G_UITOFP \p Src0
1949 MachineInstrBuilder buildUITOFP(const DstOp &Dst, const SrcOp &Src0) {
1950 return buildInstr(TargetOpcode::G_UITOFP, {Dst}, {Src0});
1951 }
1952
1953 /// Build and insert \p Res = G_SITOFP \p Src0
1954 MachineInstrBuilder buildSITOFP(const DstOp &Dst, const SrcOp &Src0) {
1955 return buildInstr(TargetOpcode::G_SITOFP, {Dst}, {Src0});
1956 }
1957
1958 /// Build and insert \p Res = G_FPTOUI \p Src0
1959 MachineInstrBuilder buildFPTOUI(const DstOp &Dst, const SrcOp &Src0) {
1960 return buildInstr(TargetOpcode::G_FPTOUI, {Dst}, {Src0});
1961 }
1962
1963 /// Build and insert \p Res = G_FPTOSI \p Src0
1964 MachineInstrBuilder buildFPTOSI(const DstOp &Dst, const SrcOp &Src0) {
1965 return buildInstr(TargetOpcode::G_FPTOSI, {Dst}, {Src0});
1966 }
1967
1968 /// Build and insert \p Dst = G_INTRINSIC_ROUNDEVEN \p Src0, \p Src1
1970 buildIntrinsicRoundeven(const DstOp &Dst, const SrcOp &Src0,
1971 std::optional<unsigned> Flags = std::nullopt) {
1972 return buildInstr(TargetOpcode::G_INTRINSIC_ROUNDEVEN, {Dst}, {Src0},
1973 Flags);
1974 }
1975
1976 /// Build and insert \p Res = G_SMIN \p Op0, \p Op1
1977 MachineInstrBuilder buildSMin(const DstOp &Dst, const SrcOp &Src0,
1978 const SrcOp &Src1) {
1979 return buildInstr(TargetOpcode::G_SMIN, {Dst}, {Src0, Src1});
1980 }
1981
1982 /// Build and insert \p Res = G_SMAX \p Op0, \p Op1
1983 MachineInstrBuilder buildSMax(const DstOp &Dst, const SrcOp &Src0,
1984 const SrcOp &Src1) {
1985 return buildInstr(TargetOpcode::G_SMAX, {Dst}, {Src0, Src1});
1986 }
1987
1988 /// Build and insert \p Res = G_UMIN \p Op0, \p Op1
1989 MachineInstrBuilder buildUMin(const DstOp &Dst, const SrcOp &Src0,
1990 const SrcOp &Src1) {
1991 return buildInstr(TargetOpcode::G_UMIN, {Dst}, {Src0, Src1});
1992 }
1993
1994 /// Build and insert \p Res = G_UMAX \p Op0, \p Op1
1995 MachineInstrBuilder buildUMax(const DstOp &Dst, const SrcOp &Src0,
1996 const SrcOp &Src1) {
1997 return buildInstr(TargetOpcode::G_UMAX, {Dst}, {Src0, Src1});
1998 }
1999
2000 /// Build and insert \p Dst = G_ABS \p Src
2001 MachineInstrBuilder buildAbs(const DstOp &Dst, const SrcOp &Src) {
2002 return buildInstr(TargetOpcode::G_ABS, {Dst}, {Src});
2003 }
2004
2005 /// Build and insert \p Res = G_JUMP_TABLE \p JTI
2006 ///
2007 /// G_JUMP_TABLE sets \p Res to the address of the jump table specified by
2008 /// the jump table index \p JTI.
2009 ///
2010 /// \return a MachineInstrBuilder for the newly created instruction.
2011 MachineInstrBuilder buildJumpTable(const LLT PtrTy, unsigned JTI);
2012
2013 /// Build and insert \p Res = G_VECREDUCE_SEQ_FADD \p ScalarIn, \p VecIn
2014 ///
2015 /// \p ScalarIn is the scalar accumulator input to start the sequential
2016 /// reduction operation of \p VecIn.
2018 const SrcOp &ScalarIn,
2019 const SrcOp &VecIn) {
2020 return buildInstr(TargetOpcode::G_VECREDUCE_SEQ_FADD, {Dst},
2021 {ScalarIn, {VecIn}});
2022 }
2023
2024 /// Build and insert \p Res = G_VECREDUCE_SEQ_FMUL \p ScalarIn, \p VecIn
2025 ///
2026 /// \p ScalarIn is the scalar accumulator input to start the sequential
2027 /// reduction operation of \p VecIn.
2029 const SrcOp &ScalarIn,
2030 const SrcOp &VecIn) {
2031 return buildInstr(TargetOpcode::G_VECREDUCE_SEQ_FMUL, {Dst},
2032 {ScalarIn, {VecIn}});
2033 }
2034
2035 /// Build and insert \p Res = G_VECREDUCE_FADD \p Src
2036 ///
2037 /// \p ScalarIn is the scalar accumulator input to the reduction operation of
2038 /// \p VecIn.
2040 const SrcOp &ScalarIn,
2041 const SrcOp &VecIn) {
2042 return buildInstr(TargetOpcode::G_VECREDUCE_FADD, {Dst}, {ScalarIn, VecIn});
2043 }
2044
2045 /// Build and insert \p Res = G_VECREDUCE_FMUL \p Src
2046 ///
2047 /// \p ScalarIn is the scalar accumulator input to the reduction operation of
2048 /// \p VecIn.
2050 const SrcOp &ScalarIn,
2051 const SrcOp &VecIn) {
2052 return buildInstr(TargetOpcode::G_VECREDUCE_FMUL, {Dst}, {ScalarIn, VecIn});
2053 }
2054
2055 /// Build and insert \p Res = G_VECREDUCE_FMAX \p Src
2057 return buildInstr(TargetOpcode::G_VECREDUCE_FMAX, {Dst}, {Src});
2058 }
2059
2060 /// Build and insert \p Res = G_VECREDUCE_FMIN \p Src
2062 return buildInstr(TargetOpcode::G_VECREDUCE_FMIN, {Dst}, {Src});
2063 }
2064
2065 /// Build and insert \p Res = G_VECREDUCE_FMAXIMUM \p Src
2067 const SrcOp &Src) {
2068 return buildInstr(TargetOpcode::G_VECREDUCE_FMAXIMUM, {Dst}, {Src});
2069 }
2070
2071 /// Build and insert \p Res = G_VECREDUCE_FMINIMUM \p Src
2073 const SrcOp &Src) {
2074 return buildInstr(TargetOpcode::G_VECREDUCE_FMINIMUM, {Dst}, {Src});
2075 }
2076
2077 /// Build and insert \p Res = G_VECREDUCE_ADD \p Src
2079 return buildInstr(TargetOpcode::G_VECREDUCE_ADD, {Dst}, {Src});
2080 }
2081
2082 /// Build and insert \p Res = G_VECREDUCE_MUL \p Src
2084 return buildInstr(TargetOpcode::G_VECREDUCE_MUL, {Dst}, {Src});
2085 }
2086
2087 /// Build and insert \p Res = G_VECREDUCE_AND \p Src
2089 return buildInstr(TargetOpcode::G_VECREDUCE_AND, {Dst}, {Src});
2090 }
2091
2092 /// Build and insert \p Res = G_VECREDUCE_OR \p Src
2094 return buildInstr(TargetOpcode::G_VECREDUCE_OR, {Dst}, {Src});
2095 }
2096
2097 /// Build and insert \p Res = G_VECREDUCE_XOR \p Src
2099 return buildInstr(TargetOpcode::G_VECREDUCE_XOR, {Dst}, {Src});
2100 }
2101
2102 /// Build and insert \p Res = G_VECREDUCE_SMAX \p Src
2104 return buildInstr(TargetOpcode::G_VECREDUCE_SMAX, {Dst}, {Src});
2105 }
2106
2107 /// Build and insert \p Res = G_VECREDUCE_SMIN \p Src
2109 return buildInstr(TargetOpcode::G_VECREDUCE_SMIN, {Dst}, {Src});
2110 }
2111
2112 /// Build and insert \p Res = G_VECREDUCE_UMAX \p Src
2114 return buildInstr(TargetOpcode::G_VECREDUCE_UMAX, {Dst}, {Src});
2115 }
2116
2117 /// Build and insert \p Res = G_VECREDUCE_UMIN \p Src
2119 return buildInstr(TargetOpcode::G_VECREDUCE_UMIN, {Dst}, {Src});
2120 }
2121
2122 /// Build and insert G_MEMCPY or G_MEMMOVE
2123 MachineInstrBuilder buildMemTransferInst(unsigned Opcode, const SrcOp &DstPtr,
2124 const SrcOp &SrcPtr,
2125 const SrcOp &Size,
2126 MachineMemOperand &DstMMO,
2127 MachineMemOperand &SrcMMO) {
2128 auto MIB = buildInstr(
2129 Opcode, {}, {DstPtr, SrcPtr, Size, SrcOp(INT64_C(0) /*isTailCall*/)});
2130 MIB.addMemOperand(&DstMMO);
2131 MIB.addMemOperand(&SrcMMO);
2132 return MIB;
2133 }
2134
2135 MachineInstrBuilder buildMemCpy(const SrcOp &DstPtr, const SrcOp &SrcPtr,
2136 const SrcOp &Size, MachineMemOperand &DstMMO,
2137 MachineMemOperand &SrcMMO) {
2138 return buildMemTransferInst(TargetOpcode::G_MEMCPY, DstPtr, SrcPtr, Size,
2139 DstMMO, SrcMMO);
2140 }
2141
2142 /// Build and insert G_TRAP or G_DEBUGTRAP
2144 return buildInstr(Debug ? TargetOpcode::G_DEBUGTRAP : TargetOpcode::G_TRAP);
2145 }
2146
2147 /// Build and insert \p Dst = G_SBFX \p Src, \p LSB, \p Width.
2149 const SrcOp &LSB, const SrcOp &Width) {
2150 return buildInstr(TargetOpcode::G_SBFX, {Dst}, {Src, LSB, Width});
2151 }
2152
2153 /// Build and insert \p Dst = G_UBFX \p Src, \p LSB, \p Width.
2155 const SrcOp &LSB, const SrcOp &Width) {
2156 return buildInstr(TargetOpcode::G_UBFX, {Dst}, {Src, LSB, Width});
2157 }
2158
2159 /// Build and insert \p Dst = G_ROTR \p Src, \p Amt
2161 const SrcOp &Amt) {
2162 return buildInstr(TargetOpcode::G_ROTR, {Dst}, {Src, Amt});
2163 }
2164
2165 /// Build and insert \p Dst = G_ROTL \p Src, \p Amt
2167 const SrcOp &Amt) {
2168 return buildInstr(TargetOpcode::G_ROTL, {Dst}, {Src, Amt});
2169 }
2170
2171 /// Build and insert \p Dst = G_BITREVERSE \p Src
2173 return buildInstr(TargetOpcode::G_BITREVERSE, {Dst}, {Src});
2174 }
2175
2176 virtual MachineInstrBuilder
2177 buildInstr(unsigned Opc, ArrayRef<DstOp> DstOps, ArrayRef<SrcOp> SrcOps,
2178 std::optional<unsigned> Flags = std::nullopt);
2179};
2180
2181} // End namespace llvm.
2182#endif // LLVM_CODEGEN_GLOBALISEL_MACHINEIRBUILDER_H
unsigned const MachineRegisterInfo * MRI
MachineBasicBlock & MBB
MachineBasicBlock MachineBasicBlock::iterator DebugLoc DL
static const Function * getParent(const Value *V)
Analysis containing CSE Info
Definition: CSEInfo.cpp:27
Returns the sub type a function will return at a given Idx Should correspond to the result type of an ExtractValue instruction executed with just that one unsigned Idx
uint64_t Addr
uint64_t Size
This contains common code to allow clients to notify changes to machine instr.
IRTranslator LLVM IR MI
unsigned Reg
Module.h This file contains the declarations for the Module class.
#define P(N)
bool Debug
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
This file describes how to lower LLVM code to machine code.
Class for arbitrary precision integers.
Definition: APInt.h:76
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition: ArrayRef.h:41
The address of a basic block.
Definition: Constants.h:889
Predicate
This enumeration lists the possible predicates for CmpInst subclasses.
Definition: InstrTypes.h:993
ConstantFP - Floating Point Values [float, double].
Definition: Constants.h:268
This is the shared class of boolean and integer constants.
Definition: Constants.h:80
This is an important base class in LLVM.
Definition: Constant.h:41
This class represents an Operation in the Expression.
A parsed version of the target data layout string in and methods for querying it.
Definition: DataLayout.h:110
A debug info location.
Definition: DebugLoc.h:33
DstOp(const LLT T)
DstOp(unsigned R)
DstOp(Register R)
void addDefToMIB(MachineRegisterInfo &MRI, MachineInstrBuilder &MIB) const
LLT getLLTTy(const MachineRegisterInfo &MRI) const
DstOp(const MachineOperand &Op)
DstType getDstOpKind() const
const TargetRegisterClass * RC
const TargetRegisterClass * getRegClass() const
DstOp(const TargetRegisterClass *TRC)
Register getReg() const
LLVMContext & getContext() const
getContext - Return a reference to the LLVMContext associated with this function.
Definition: Function.cpp:358
The CSE Analysis object.
Definition: CSEInfo.h:69
Abstract class that contains various methods for clients to notify about changes.
virtual void createdInstr(MachineInstr &MI)=0
An instruction has been created and inserted into the function.
Module * getParent()
Get the module that this global value is contained inside of...
Definition: GlobalValue.h:656
static constexpr LLT scalar(unsigned SizeInBits)
Get a low-level scalar or aggregate "bag of bits".
Definition: LowLevelType.h:42
This is an important class for using LLVM in a threaded context.
Definition: LLVMContext.h:67
Metadata node.
Definition: Metadata.h:1067
TypeSize getSizeInBits() const
Returns the size of the specified MVT in bits.
const TargetSubtargetInfo & getSubtarget() const
getSubtarget - Return the subtarget for which this machine code is being compiled.
Function & getFunction()
Return the LLVM function that this machine code represents.
Helper class to build MachineInstr.
MachineInstrBuilder buildLoadFromOffset(const DstOp &Dst, const SrcOp &BasePtr, MachineMemOperand &BaseMMO, int64_t Offset)
Helper to create a load from a constant offset given a base address.
MachineInstrBuilder buildAtomicRMWFMin(const DstOp &OldValRes, const SrcOp &Addr, const SrcOp &Val, MachineMemOperand &MMO)
Build and insert OldValRes<def> = G_ATOMICRMW_FMIN Addr, Val, MMO.
MachineInstrBuilder buildFSub(const DstOp &Dst, const SrcOp &Src0, const SrcOp &Src1, std::optional< unsigned > Flags=std::nullopt)
Build and insert Res = G_FSUB Op0, Op1.
MachineInstrBuilder buildFPTOSI(const DstOp &Dst, const SrcOp &Src0)
Build and insert Res = G_FPTOSI Src0.
GISelChangeObserver * getObserver()
MachineInstrBuilder buildFMul(const DstOp &Dst, const SrcOp &Src0, const SrcOp &Src1, std::optional< unsigned > Flags=std::nullopt)
MachineInstrBuilder buildBoolExtInReg(const DstOp &Res, const SrcOp &Op, bool IsVector, bool IsFP)
MachineInstrBuilder insertInstr(MachineInstrBuilder MIB)
Insert an existing instruction at the insertion point.
MachineInstrBuilder buildFLdexp(const DstOp &Dst, const SrcOp &Src0, const SrcOp &Src1, std::optional< unsigned > Flags=std::nullopt)
Build and insert Dst = G_FLDEXP Src0, Src1.
MachineInstrBuilder buildFreeze(const DstOp &Dst, const SrcOp &Src)
Build and insert Dst = G_FREEZE Src.
MachineInstrBuilder buildAtomicRMWXor(Register OldValRes, Register Addr, Register Val, MachineMemOperand &MMO)
Build and insert OldValRes<def> = G_ATOMICRMW_XOR Addr, Val, MMO.
MachineInstrBuilder buildGlobalValue(const DstOp &Res, const GlobalValue *GV)
Build and insert Res = G_GLOBAL_VALUE GV.
MachineInstrBuilder buildBr(MachineBasicBlock &Dest)
Build and insert G_BR Dest.
void setInsertPt(MachineBasicBlock &MBB, MachineBasicBlock::iterator II)
Set the insertion point before the specified position.
const MachineFunction & getMF() const
std::optional< MachineInstrBuilder > materializePtrAdd(Register &Res, Register Op0, const LLT ValueTy, uint64_t Value)
Materialize and insert Res = G_PTR_ADD Op0, (G_CONSTANT Value)
LLVMContext & getContext() const
MachineInstrBuilder buildAdd(const DstOp &Dst, const SrcOp &Src0, const SrcOp &Src1, std::optional< unsigned > Flags=std::nullopt)
Build and insert Res = G_ADD Op0, Op1.
MachineInstrBuilder buildUndef(const DstOp &Res)
Build and insert Res = IMPLICIT_DEF.
MachineInstrBuilder buildFPExt(const DstOp &Res, const SrcOp &Op, std::optional< unsigned > Flags=std::nullopt)
Build and insert Res = G_FPEXT Op.
MachineInstrBuilder buildNot(const DstOp &Dst, const SrcOp &Src0)
Build and insert a bitwise not, NegOne = G_CONSTANT -1 Res = G_OR Op0, NegOne.
MachineInstrBuilder buildVecReduceSeqFAdd(const DstOp &Dst, const SrcOp &ScalarIn, const SrcOp &VecIn)
Build and insert Res = G_VECREDUCE_SEQ_FADD ScalarIn, VecIn.
MachineInstrBuilder buildRotateRight(const DstOp &Dst, const SrcOp &Src, const SrcOp &Amt)
Build and insert Dst = G_ROTR Src, Amt.
MachineInstrBuilder buildCTTZ(const DstOp &Dst, const SrcOp &Src0)
Build and insert Res = G_CTTZ Op0, Src0.
virtual ~MachineIRBuilder()=default
MachineInstrBuilder buildVecReduceOr(const DstOp &Dst, const SrcOp &Src)
Build and insert Res = G_VECREDUCE_OR Src.
MachineInstrBuilder buildFLog2(const DstOp &Dst, const SrcOp &Src, std::optional< unsigned > Flags=std::nullopt)
Build and insert Dst = G_FLOG2 Src.
MachineInstrBuilder buildAShr(const DstOp &Dst, const SrcOp &Src0, const SrcOp &Src1, std::optional< unsigned > Flags=std::nullopt)
MachineInstrBuilder buildConstantPool(const DstOp &Res, unsigned Idx)
Build and insert Res = G_CONSTANT_POOL Idx.
MachineInstrBuilder buildJumpTable(const LLT PtrTy, unsigned JTI)
Build and insert Res = G_JUMP_TABLE JTI.
MachineInstrBuilder buildBoolExt(const DstOp &Res, const SrcOp &Op, bool IsFP)
MachineInstrBuilder buildUnmerge(ArrayRef< LLT > Res, const SrcOp &Op)
Build and insert Res0, ... = G_UNMERGE_VALUES Op.
MachineInstrBuilder buildFAbs(const DstOp &Dst, const SrcOp &Src0, std::optional< unsigned > Flags=std::nullopt)
Build and insert Res = G_FABS Op0.
MachineInstrBuilder buildFence(unsigned Ordering, unsigned Scope)
Build and insert G_FENCE Ordering, Scope.
MachineInstrBuilder buildFMinNumIEEE(const DstOp &Dst, const SrcOp &Src0, const SrcOp &Src1, std::optional< unsigned > Flags=std::nullopt)
MachineInstrBuilder buildSelect(const DstOp &Res, const SrcOp &Tst, const SrcOp &Op0, const SrcOp &Op1, std::optional< unsigned > Flags=std::nullopt)
Build and insert a Res = G_SELECT Tst, Op0, Op1.
MachineInstrBuilder buildFMA(const DstOp &Dst, const SrcOp &Src0, const SrcOp &Src1, const SrcOp &Src2, std::optional< unsigned > Flags=std::nullopt)
Build and insert Res = G_FMA Op0, Op1, Op2.
MachineInstrBuilder buildAtomicRMWAnd(Register OldValRes, Register Addr, Register Val, MachineMemOperand &MMO)
Build and insert OldValRes<def> = G_ATOMICRMW_AND Addr, Val, MMO.
MachineInstrBuilder buildZExtInReg(const DstOp &Res, const SrcOp &Op, int64_t ImmOp)
Build and inserts Res = G_AND Op, LowBitsSet(ImmOp) Since there is no G_ZEXT_INREG like G_SEXT_INREG,...
MachineInstrBuilder buildSMulH(const DstOp &Dst, const SrcOp &Src0, const SrcOp &Src1, std::optional< unsigned > Flags=std::nullopt)
GISelCSEInfo * getCSEInfo()
MachineInstrBuilder buildAtomicRMWMin(Register OldValRes, Register Addr, Register Val, MachineMemOperand &MMO)
Build and insert OldValRes<def> = G_ATOMICRMW_MIN Addr, Val, MMO.
MachineInstrBuilder buildVecReduceFMax(const DstOp &Dst, const SrcOp &Src)
Build and insert Res = G_VECREDUCE_FMAX Src.
MachineInstrBuilder buildExtract(const DstOp &Res, const SrcOp &Src, uint64_t Index)
Build and insert Res0, ... = G_EXTRACT Src, Idx0.
MachineInstrBuilder buildMul(const DstOp &Dst, const SrcOp &Src0, const SrcOp &Src1, std::optional< unsigned > Flags=std::nullopt)
Build and insert Res = G_MUL Op0, Op1.
MachineInstrBuilder buildInsertSubvector(const DstOp &Res, const SrcOp &Src0, const SrcOp &Src1, unsigned Index)
Build and insert Res = G_INSERT_SUBVECTOR Src0, Src1, Idx.
MachineInstrBuilder buildAnd(const DstOp &Dst, const SrcOp &Src0, const SrcOp &Src1)
Build and insert Res = G_AND Op0, Op1.
MachineInstrBuilder buildICmp(CmpInst::Predicate Pred, const DstOp &Res, const SrcOp &Op0, const SrcOp &Op1)
Build and insert a Res = G_ICMP Pred, Op0, Op1.
MachineInstrBuilder buildCast(const DstOp &Dst, const SrcOp &Src)
Build and insert an appropriate cast between two registers of equal size.
const TargetInstrInfo & getTII()
MachineInstrBuilder buildAtomicRMWFAdd(const DstOp &OldValRes, const SrcOp &Addr, const SrcOp &Val, MachineMemOperand &MMO)
Build and insert OldValRes<def> = G_ATOMICRMW_FADD Addr, Val, MMO.
MachineInstrBuilder buildSAdde(const DstOp &Res, const DstOp &CarryOut, const SrcOp &Op0, const SrcOp &Op1, const SrcOp &CarryIn)
Build and insert Res, CarryOut = G_SADDE Op0, Op1, CarryInp.
MachineInstrBuilder buildAtomicRMWNand(Register OldValRes, Register Addr, Register Val, MachineMemOperand &MMO)
Build and insert OldValRes<def> = G_ATOMICRMW_NAND Addr, Val, MMO.
MachineInstrBuilder buildURem(const DstOp &Dst, const SrcOp &Src0, const SrcOp &Src1, std::optional< unsigned > Flags=std::nullopt)
Build and insert Res = G_UREM Op0, Op1.
MachineInstrBuilder buildSAddo(const DstOp &Res, const DstOp &CarryOut, const SrcOp &Op0, const SrcOp &Op1)
Build and insert Res, CarryOut = G_SADDO Op0, Op1.
MachineInstrBuilder buildFPTOUI(const DstOp &Dst, const SrcOp &Src0)
Build and insert Res = G_FPTOUI Src0.
MachineInstrBuilder buildLShr(const DstOp &Dst, const SrcOp &Src0, const SrcOp &Src1, std::optional< unsigned > Flags=std::nullopt)
MachineInstrBuilder buildFPow(const DstOp &Dst, const SrcOp &Src0, const SrcOp &Src1, std::optional< unsigned > Flags=std::nullopt)
Build and insert Dst = G_FPOW Src0, Src1.
MachineInstrBuilder buildAnyExtOrTrunc(const DstOp &Res, const SrcOp &Op)
Res = COPY Op depending on the differing sizes of Res and Op.
MachineInstrBuilder buildSExt(const DstOp &Res, const SrcOp &Op)
Build and insert Res = G_SEXT Op.
MachineInstrBuilder buildIntrinsicTrunc(const DstOp &Dst, const SrcOp &Src0, std::optional< unsigned > Flags=std::nullopt)
Build and insert Dst = G_INTRINSIC_TRUNC Src0.
MachineBasicBlock::iterator getInsertPt()
Current insertion point for new instructions.
MachineInstrBuilder buildSExtOrTrunc(const DstOp &Res, const SrcOp &Op)
Build and insert Res = G_SEXT Op, Res = G_TRUNC Op, or Res = COPY Op depending on the differing sizes...
MachineInstrBuilder buildShuffleSplat(const DstOp &Res, const SrcOp &Src)
Build and insert a vector splat of a scalar Src using a G_INSERT_VECTOR_ELT and G_SHUFFLE_VECTOR idio...
MachineInstrBuilder buildZExt(const DstOp &Res, const SrcOp &Op, std::optional< unsigned > Flags=std::nullopt)
Build and insert Res = G_ZEXT Op.
MachineInstrBuilder buildConcatVectors(const DstOp &Res, ArrayRef< Register > Ops)
Build and insert Res = G_CONCAT_VECTORS Op0, ...
MachineInstrBuilder buildAtomicRMW(unsigned Opcode, const DstOp &OldValRes, const SrcOp &Addr, const SrcOp &Val, MachineMemOperand &MMO)
Build and insert OldValRes<def> = G_ATOMICRMW_<Opcode> Addr, Val, MMO.
MachineInstrBuilder buildVecReduceSeqFMul(const DstOp &Dst, const SrcOp &ScalarIn, const SrcOp &VecIn)
Build and insert Res = G_VECREDUCE_SEQ_FMUL ScalarIn, VecIn.
MachineInstrBuilder buildSub(const DstOp &Dst, const SrcOp &Src0, const SrcOp &Src1, std::optional< unsigned > Flags=std::nullopt)
Build and insert Res = G_SUB Op0, Op1.
MachineInstrBuilder buildIntrinsic(Intrinsic::ID ID, ArrayRef< Register > Res, bool HasSideEffects, bool isConvergent)
Build and insert a G_INTRINSIC instruction.
void setInstr(MachineInstr &MI)
Set the insertion point to before MI.
MDNode * getPCSections()
Get the current instruction's PC sections metadata.
MachineInstrBuilder buildBSwap(const DstOp &Dst, const SrcOp &Src0)
Build and insert Dst = G_BSWAP Src0.
MachineInstrBuilder buildVecReduceFMul(const DstOp &Dst, const SrcOp &ScalarIn, const SrcOp &VecIn)
Build and insert Res = G_VECREDUCE_FMUL Src.
MachineInstrBuilder buildCTLZ_ZERO_UNDEF(const DstOp &Dst, const SrcOp &Src0)
Build and insert Res = G_CTLZ_ZERO_UNDEF Op0, Src0.
MachineInstrBuilder buildVScale(const DstOp &Res, unsigned MinElts)
Build and insert Res = G_VSCALE MinElts.
MachineInstrBuilder buildAddrSpaceCast(const DstOp &Dst, const SrcOp &Src)
Build and insert Dst = G_ADDRSPACE_CAST Src.
MachineInstrBuilder buildSplatBuildVector(const DstOp &Res, const SrcOp &Src)
Build and insert Res = G_BUILD_VECTOR with Src replicated to fill the number of elements.
MachineInstrBuilder buildFExp2(const DstOp &Dst, const SrcOp &Src, std::optional< unsigned > Flags=std::nullopt)
Build and insert Dst = G_FEXP2 Src.
MachineInstrBuilder buildIntToPtr(const DstOp &Dst, const SrcOp &Src)
Build and insert a G_INTTOPTR instruction.
MachineInstrBuilder buildIndirectDbgValue(Register Reg, const MDNode *Variable, const MDNode *Expr)
Build and insert a DBG_VALUE instruction expressing the fact that the associated Variable lives in me...
unsigned getBoolExtOp(bool IsVec, bool IsFP) const
MachineInstrBuilder buildUSubo(const DstOp &Res, const DstOp &CarryOut, const SrcOp &Op0, const SrcOp &Op1)
Build and insert Res, CarryOut = G_USUBO Op0, Op1.
MachineInstrBuilder buildVecReduceFAdd(const DstOp &Dst, const SrcOp &ScalarIn, const SrcOp &VecIn)
Build and insert Res = G_VECREDUCE_FADD Src.
MachineInstrBuilder buildAtomicRMWUmax(Register OldValRes, Register Addr, Register Val, MachineMemOperand &MMO)
Build and insert OldValRes<def> = G_ATOMICRMW_UMAX Addr, Val, MMO.
MachineInstrBuilder buildBuildVector(const DstOp &Res, ArrayRef< Register > Ops)
Build and insert Res = G_BUILD_VECTOR Op0, ...
MachineIRBuilder(MachineBasicBlock &MBB, MachineBasicBlock::iterator InsPt)
MachineInstrBuilder buildVecReduceFMinimum(const DstOp &Dst, const SrcOp &Src)
Build and insert Res = G_VECREDUCE_FMINIMUM Src.
MachineInstrBuilder buildNeg(const DstOp &Dst, const SrcOp &Src0)
Build and insert integer negation Zero = G_CONSTANT 0 Res = G_SUB Zero, Op0.
MachineInstrBuilder buildVecReduceSMin(const DstOp &Dst, const SrcOp &Src)
Build and insert Res = G_VECREDUCE_SMIN Src.
MachineInstrBuilder buildCTLZ(const DstOp &Dst, const SrcOp &Src0)
Build and insert Res = G_CTLZ Op0, Src0.
MachineInstrBuilder buildSMax(const DstOp &Dst, const SrcOp &Src0, const SrcOp &Src1)
Build and insert Res = G_SMAX Op0, Op1.
MachineInstrBuilder buildConstDbgValue(const Constant &C, const MDNode *Variable, const MDNode *Expr)
Build and insert a DBG_VALUE instructions specifying that Variable is given by C (suitably modified b...
MachineInstrBuilder buildAssertZExt(const DstOp &Res, const SrcOp &Op, unsigned Size)
Build and insert Res = G_ASSERT_ZEXT Op, Size.
void recordInsertion(MachineInstr *InsertedInstr) const
MachineInstrBuilder buildUMulH(const DstOp &Dst, const SrcOp &Src0, const SrcOp &Src1, std::optional< unsigned > Flags=std::nullopt)
MachineInstrBuilder buildStrictFAdd(const DstOp &Dst, const SrcOp &Src0, const SrcOp &Src1, std::optional< unsigned > Flags=std::nullopt)
Build and insert Res = G_STRICT_FADD Op0, Op1.
MachineInstrBuilder buildBrCond(const SrcOp &Tst, MachineBasicBlock &Dest)
Build and insert G_BRCOND Tst, Dest.
MachineInstrBuilder buildVecReduceXor(const DstOp &Dst, const SrcOp &Src)
Build and insert Res = G_VECREDUCE_XOR Src.
MachineInstrBuilder buildVecReduceFMin(const DstOp &Dst, const SrcOp &Src)
Build and insert Res = G_VECREDUCE_FMIN Src.
MachineInstrBuilder buildFDiv(const DstOp &Dst, const SrcOp &Src0, const SrcOp &Src1, std::optional< unsigned > Flags=std::nullopt)
Build and insert Res = G_FDIV Op0, Op1.
MachineInstrBuilder buildMergeLikeInstr(const DstOp &Res, ArrayRef< Register > Ops)
Build and insert Res = G_MERGE_VALUES Op0, ... or Res = G_BUILD_VECTOR Op0, ... or Res = G_CONCAT_VEC...
const GISelCSEInfo * getCSEInfo() const
MachineInstrBuilder buildExtractVectorElement(const DstOp &Res, const SrcOp &Val, const SrcOp &Idx)
Build and insert Res = G_EXTRACT_VECTOR_ELT Val, Idx.
MachineInstrBuilder buildLoad(const DstOp &Res, const SrcOp &Addr, MachineMemOperand &MMO)
Build and insert Res = G_LOAD Addr, MMO.
MachineInstrBuilder buildPtrAdd(const DstOp &Res, const SrcOp &Op0, const SrcOp &Op1, std::optional< unsigned > Flags=std::nullopt)
Build and insert Res = G_PTR_ADD Op0, Op1.
MachineInstrBuilder buildZExtOrTrunc(const DstOp &Res, const SrcOp &Op)
Build and insert Res = G_ZEXT Op, Res = G_TRUNC Op, or Res = COPY Op depending on the differing sizes...
MachineInstrBuilder buildBuildVectorTrunc(const DstOp &Res, ArrayRef< Register > Ops)
Build and insert Res = G_BUILD_VECTOR_TRUNC Op0, ...
MachineBasicBlock & getMBB()
MachineIRBuilder(MachineInstr &MI)
MachineInstrBuilder buildExtractVectorElementConstant(const DstOp &Res, const SrcOp &Val, const int Idx)
Build and insert Res = G_EXTRACT_VECTOR_ELT Val, Idx.
MachineInstrBuilder buildCTTZ_ZERO_UNDEF(const DstOp &Dst, const SrcOp &Src0)
Build and insert Res = G_CTTZ_ZERO_UNDEF Op0, Src0.
virtual MachineInstrBuilder buildFConstant(const DstOp &Res, const ConstantFP &Val)
Build and insert Res = G_FCONSTANT Val.
MachineInstrBuilder buildBitReverse(const DstOp &Dst, const SrcOp &Src)
Build and insert Dst = G_BITREVERSE Src.
MachineInstrBuilder buildShl(const DstOp &Dst, const SrcOp &Src0, const SrcOp &Src1, std::optional< unsigned > Flags=std::nullopt)
MachineInstrBuilder buildUITOFP(const DstOp &Dst, const SrcOp &Src0)
Build and insert Res = G_UITOFP Src0.
MachineInstrBuilder buildStore(const SrcOp &Val, const SrcOp &Addr, MachineMemOperand &MMO)
Build and insert G_STORE Val, Addr, MMO.
MachineInstrBuilder buildInstr(unsigned Opcode)
Build and insert <empty> = Opcode <empty>.
MachineInstrBuilder buildSITOFP(const DstOp &Dst, const SrcOp &Src0)
Build and insert Res = G_SITOFP Src0.
MachineIRBuilder(MachineInstr &MI, GISelChangeObserver &Observer)
MachineInstrBuilder buildFMAD(const DstOp &Dst, const SrcOp &Src0, const SrcOp &Src1, const SrcOp &Src2, std::optional< unsigned > Flags=std::nullopt)
Build and insert Res = G_FMAD Op0, Op1, Op2.
MachineInstrBuilder buildPadVectorWithUndefElements(const DstOp &Res, const SrcOp &Op0)
Build and insert a, b, ..., x = G_UNMERGE_VALUES Op0 Res = G_BUILD_VECTOR a, b, .....
MachineInstrBuilder buildFLog(const DstOp &Dst, const SrcOp &Src, std::optional< unsigned > Flags=std::nullopt)
Build and insert Dst = G_FLOG Src.
void validateSelectOp(const LLT ResTy, const LLT TstTy, const LLT Op0Ty, const LLT Op1Ty)
MachineInstrBuilder buildFrameIndex(const DstOp &Res, int Idx)
Build and insert Res = G_FRAME_INDEX Idx.
MachineInstrBuilder buildVecReduceUMax(const DstOp &Dst, const SrcOp &Src)
Build and insert Res = G_VECREDUCE_UMAX Src.
MachineInstrBuilder buildDirectDbgValue(Register Reg, const MDNode *Variable, const MDNode *Expr)
Build and insert a DBG_VALUE instruction expressing the fact that the associated Variable lives in Re...
const DebugLoc & getDL()
Getter for DebugLoc.
MachineInstrBuilder buildUbfx(const DstOp &Dst, const SrcOp &Src, const SrcOp &LSB, const SrcOp &Width)
Build and insert Dst = G_UBFX Src, LSB, Width.
const MachineRegisterInfo * getMRI() const
MachineInstrBuilder buildCTPOP(const DstOp &Dst, const SrcOp &Src0)
Build and insert Res = G_CTPOP Op0, Src0.
MachineInstrBuilder buildAbs(const DstOp &Dst, const SrcOp &Src)
Build and insert Dst = G_ABS Src.
MachineInstrBuilder buildBuildVectorConstant(const DstOp &Res, ArrayRef< APInt > Ops)
Build and insert Res = G_BUILD_VECTOR Op0, ... where each OpN is built with G_CONSTANT.
MachineInstrBuilder buildAtomicRMWUmin(Register OldValRes, Register Addr, Register Val, MachineMemOperand &MMO)
Build and insert OldValRes<def> = G_ATOMICRMW_UMIN Addr, Val, MMO.
void validateBinaryOp(const LLT Res, const LLT Op0, const LLT Op1)
MachineInstrBuilder buildVecReduceAnd(const DstOp &Dst, const SrcOp &Src)
Build and insert Res = G_VECREDUCE_AND Src.
MachineInstrBuilder buildVecReduceFMaximum(const DstOp &Dst, const SrcOp &Src)
Build and insert Res = G_VECREDUCE_FMAXIMUM Src.
void validateShiftOp(const LLT Res, const LLT Op0, const LLT Op1)
MachineFunction & getMF()
Getter for the function we currently build.
MachineIRBuilder(MachineFunction &MF)
MachineIRBuilder(const MachineIRBuilderState &BState)
MachineInstrBuilder buildMemCpy(const SrcOp &DstPtr, const SrcOp &SrcPtr, const SrcOp &Size, MachineMemOperand &DstMMO, MachineMemOperand &SrcMMO)
MachineInstrBuilder buildAssertAlign(const DstOp &Res, const SrcOp &Op, Align AlignVal)
Build and insert Res = G_ASSERT_ALIGN Op, AlignVal.
MachineInstrBuilder buildSbfx(const DstOp &Dst, const SrcOp &Src, const SrcOp &LSB, const SrcOp &Width)
Build and insert Dst = G_SBFX Src, LSB, Width.
MachineInstrBuilder buildFMaxNum(const DstOp &Dst, const SrcOp &Src0, const SrcOp &Src1, std::optional< unsigned > Flags=std::nullopt)
MachineInstrBuilder buildSMin(const DstOp &Dst, const SrcOp &Src0, const SrcOp &Src1)
Build and insert Res = G_SMIN Op0, Op1.
MachineInstrBuilder buildFMinNum(const DstOp &Dst, const SrcOp &Src0, const SrcOp &Src1, std::optional< unsigned > Flags=std::nullopt)
MachineInstrBuilder buildDbgLabel(const MDNode *Label)
Build and insert a DBG_LABEL instructions specifying that Label is given.
MachineInstrBuilder buildBrJT(Register TablePtr, unsigned JTI, Register IndexReg)
Build and insert G_BRJT TablePtr, JTI, IndexReg.
MachineInstrBuilder buildInsert(const DstOp &Res, const SrcOp &Src, const SrcOp &Op, unsigned Index)
MachineInstrBuilder buildDynStackAlloc(const DstOp &Res, const SrcOp &Size, Align Alignment)
Build and insert Res = G_DYN_STACKALLOC Size, Align.
MachineInstrBuilder buildVecReduceUMin(const DstOp &Dst, const SrcOp &Src)
Build and insert Res = G_VECREDUCE_UMIN Src.
MachineInstrBuilder buildFIDbgValue(int FI, const MDNode *Variable, const MDNode *Expr)
Build and insert a DBG_VALUE instruction expressing the fact that the associated Variable lives in th...
void setInstrAndDebugLoc(MachineInstr &MI)
Set the insertion point to before MI, and set the debug loc to MI's loc.
void setMMRAMetadata(MDNode *MMRA)
Set the PC sections metadata to MD for all the next build instructions.
MachineInstrBuilder buildSSube(const DstOp &Res, const DstOp &CarryOut, const SrcOp &Op0, const SrcOp &Op1, const SrcOp &CarryIn)
Build and insert Res, CarryOut = G_SSUBE Op0, Op1, CarryInp.
MachineInstrBuilder buildIntrinsicRoundeven(const DstOp &Dst, const SrcOp &Src0, std::optional< unsigned > Flags=std::nullopt)
Build and insert Dst = G_INTRINSIC_ROUNDEVEN Src0, Src1.
void setPCSections(MDNode *MD)
Set the PC sections metadata to MD for all the next build instructions.
MachineInstrBuilder buildExtOrTrunc(unsigned ExtOpc, const DstOp &Res, const SrcOp &Op)
Build and insert Res = ExtOpc, Res = G_TRUNC Op, or Res = COPY Op depending on the differing sizes of...
MachineInstrBuilder buildVecReduceAdd(const DstOp &Dst, const SrcOp &Src)
Build and insert Res = G_VECREDUCE_ADD Src.
MachineInstrBuilder buildAtomicRMWSub(Register OldValRes, Register Addr, Register Val, MachineMemOperand &MMO)
Build and insert OldValRes<def> = G_ATOMICRMW_SUB Addr, Val, MMO.
MachineInstrBuilder buildIsFPClass(const DstOp &Res, const SrcOp &Src, unsigned Mask)
Build and insert a Res = G_IS_FPCLASS Src, Mask.
MachineInstrBuilder buildMergeValues(const DstOp &Res, ArrayRef< Register > Ops)
Build and insert Res = G_MERGE_VALUES Op0, ...
MachineInstrBuilder buildTrunc(const DstOp &Res, const SrcOp &Op, std::optional< unsigned > Flags=std::nullopt)
Build and insert Res = G_TRUNC Op.
MachineInstrBuilder buildUAdde(const DstOp &Res, const DstOp &CarryOut, const SrcOp &Op0, const SrcOp &Op1, const SrcOp &CarryIn)
Build and insert Res, CarryOut = G_UADDE Op0, Op1, CarryIn.
MachineInstrBuilder buildAtomicRMWFMax(const DstOp &OldValRes, const SrcOp &Addr, const SrcOp &Val, MachineMemOperand &MMO)
Build and insert OldValRes<def> = G_ATOMICRMW_FMAX Addr, Val, MMO.
void setDebugLoc(const DebugLoc &DL)
Set the debug location to DL for all the next build instructions.
MachineInstrBuilder buildFCopysign(const DstOp &Dst, const SrcOp &Src0, const SrcOp &Src1)
Build and insert Res = G_FCOPYSIGN Op0, Op1.
MachineInstrBuilder buildSSubo(const DstOp &Res, const DstOp &CarryOut, const SrcOp &Op0, const SrcOp &Op1)
Build and insert Res, CarryOut = G_SUBO Op0, Op1.
MachineInstrBuilder buildAtomicRMWOr(Register OldValRes, Register Addr, Register Val, MachineMemOperand &MMO)
Build and insert OldValRes<def> = G_ATOMICRMW_OR Addr, Val, MMO.
bool isObservingChanges() const
MachineInstrBuilder buildUSube(const DstOp &Res, const DstOp &CarryOut, const SrcOp &Op0, const SrcOp &Op1, const SrcOp &CarryIn)
Build and insert Res, CarryOut = G_USUBE Op0, Op1, CarryInp.
const MachineBasicBlock & getMBB() const
Getter for the basic block we currently build.
MachineInstrBuilder buildFNeg(const DstOp &Dst, const SrcOp &Src0, std::optional< unsigned > Flags=std::nullopt)
Build and insert Res = G_FNEG Op0.
MachineInstrBuilder buildInsertVectorElement(const DstOp &Res, const SrcOp &Val, const SrcOp &Elt, const SrcOp &Idx)
Build and insert Res = G_INSERT_VECTOR_ELT Val, Elt, Idx.
MachineInstrBuilder buildAnyExt(const DstOp &Res, const SrcOp &Op)
Build and insert Res = G_ANYEXT Op0.
MachineInstrBuilder buildAtomicCmpXchgWithSuccess(const DstOp &OldValRes, const DstOp &SuccessRes, const SrcOp &Addr, const SrcOp &CmpVal, const SrcOp &NewVal, MachineMemOperand &MMO)
Build and insert OldValRes<def>, SuccessRes<def> = G_ATOMIC_CMPXCHG_WITH_SUCCESS Addr,...
void setMBB(MachineBasicBlock &MBB)
Set the insertion point to the end of MBB.
MachineInstrBuilder buildBitcast(const DstOp &Dst, const SrcOp &Src)
Build and insert Dst = G_BITCAST Src.
const DebugLoc & getDebugLoc()
Get the current instruction's debug location.
MachineInstrBuilder buildUAddo(const DstOp &Res, const DstOp &CarryOut, const SrcOp &Op0, const SrcOp &Op1)
Build and insert Res, CarryOut = G_UADDO Op0, Op1.
void setCSEInfo(GISelCSEInfo *Info)
MachineInstrBuilder buildFMaxNumIEEE(const DstOp &Dst, const SrcOp &Src0, const SrcOp &Src1, std::optional< unsigned > Flags=std::nullopt)
MachineInstrBuilder buildTrap(bool Debug=false)
Build and insert G_TRAP or G_DEBUGTRAP.
MachineInstrBuilder buildFFloor(const DstOp &Dst, const SrcOp &Src0, std::optional< unsigned > Flags=std::nullopt)
Build and insert Res = GFFLOOR Op0, Op1.
MachineInstrBuilder buildFFrexp(const DstOp &Fract, const DstOp &Exp, const SrcOp &Src, std::optional< unsigned > Flags=std::nullopt)
Build and insert Fract, Exp = G_FFREXP Src.
MachineIRBuilder()=default
Some constructors for easy use.
MachineInstrBuilder buildDeleteTrailingVectorElements(const DstOp &Res, const SrcOp &Op0)
Build and insert a, b, ..., x, y, z = G_UNMERGE_VALUES Op0 Res = G_BUILD_VECTOR a,...
MachineRegisterInfo * getMRI()
Getter for MRI.
MachineInstrBuilder buildAtomicRMWAdd(Register OldValRes, Register Addr, Register Val, MachineMemOperand &MMO)
Build and insert OldValRes<def> = G_ATOMICRMW_ADD Addr, Val, MMO.
MachineInstrBuilder buildFPTrunc(const DstOp &Res, const SrcOp &Op, std::optional< unsigned > Flags=std::nullopt)
Build and insert Res = G_FPTRUNC Op.
MachineInstrBuilder buildOr(const DstOp &Dst, const SrcOp &Src0, const SrcOp &Src1, std::optional< unsigned > Flags=std::nullopt)
Build and insert Res = G_OR Op0, Op1.
MachineInstrBuilder buildAtomicCmpXchg(const DstOp &OldValRes, const SrcOp &Addr, const SrcOp &CmpVal, const SrcOp &NewVal, MachineMemOperand &MMO)
Build and insert OldValRes<def> = G_ATOMIC_CMPXCHG Addr, CmpVal, NewVal, MMO.
MachineIRBuilderState & getState()
Getter for the State.
MachineInstrBuilder buildShuffleVector(const DstOp &Res, const SrcOp &Src1, const SrcOp &Src2, ArrayRef< int > Mask)
Build and insert Res = G_SHUFFLE_VECTOR Src1, Src2, Mask.
MachineInstrBuilder buildAssertInstr(unsigned Opc, const DstOp &Res, const SrcOp &Op, unsigned Val)
Build and insert G_ASSERT_SEXT, G_ASSERT_ZEXT, or G_ASSERT_ALIGN.
void validateTruncExt(const LLT Dst, const LLT Src, bool IsExtend)
MachineInstrBuilder buildInstrNoInsert(unsigned Opcode)
Build but don't insert <empty> = Opcode <empty>.
MachineInstrBuilder buildPtrMask(const DstOp &Res, const SrcOp &Op0, const SrcOp &Op1)
Build and insert Res = G_PTRMASK Op0, Op1.
MachineInstrBuilder buildCopy(const DstOp &Res, const SrcOp &Op)
Build and insert Res = COPY Op.
MachineInstrBuilder buildVecReduceSMax(const DstOp &Dst, const SrcOp &Src)
Build and insert Res = G_VECREDUCE_SMAX Src.
MachineInstrBuilder buildMemTransferInst(unsigned Opcode, const SrcOp &DstPtr, const SrcOp &SrcPtr, const SrcOp &Size, MachineMemOperand &DstMMO, MachineMemOperand &SrcMMO)
Build and insert G_MEMCPY or G_MEMMOVE.
void validateUnaryOp(const LLT Res, const LLT Op0)
MachineInstrBuilder buildBlockAddress(Register Res, const BlockAddress *BA)
Build and insert Res = G_BLOCK_ADDR BA.
MDNode * getMMRAMetadata()
Get the current instruction's MMRA metadata.
MachineInstrBuilder buildAtomicRMWMax(Register OldValRes, Register Addr, Register Val, MachineMemOperand &MMO)
Build and insert OldValRes<def> = G_ATOMICRMW_MAX Addr, Val, MMO.
MachineInstrBuilder buildPrefetch(const SrcOp &Addr, unsigned RW, unsigned Locality, unsigned CacheType, MachineMemOperand &MMO)
Build and insert G_PREFETCH Addr, RW, Locality, CacheType.
MachineInstrBuilder buildExtractSubvector(const DstOp &Res, const SrcOp &Src, unsigned Index)
Build and insert Res = G_EXTRACT_SUBVECTOR Src, Idx0.
const DataLayout & getDataLayout() const
MachineInstrBuilder buildBrIndirect(Register Tgt)
Build and insert G_BRINDIRECT Tgt.
MachineInstrBuilder buildSplatVector(const DstOp &Res, const SrcOp &Val)
Build and insert Res = G_SPLAT_VECTOR Val.
MachineInstrBuilder buildLoadInstr(unsigned Opcode, const DstOp &Res, const SrcOp &Addr, MachineMemOperand &MMO)
Build and insert Res = <opcode> Addr, MMO.
void setMF(MachineFunction &MF)
MachineInstrBuilder buildAtomicRMWFSub(const DstOp &OldValRes, const SrcOp &Addr, const SrcOp &Val, MachineMemOperand &MMO)
Build and insert OldValRes<def> = G_ATOMICRMW_FSUB Addr, Val, MMO.
MachineInstrBuilder buildAssertSExt(const DstOp &Res, const SrcOp &Op, unsigned Size)
Build and insert Res = G_ASSERT_SEXT Op, Size.
MachineInstrBuilder buildXor(const DstOp &Dst, const SrcOp &Src0, const SrcOp &Src1)
Build and insert Res = G_XOR Op0, Op1.
MachineInstrBuilder buildAtomicRMWXchg(Register OldValRes, Register Addr, Register Val, MachineMemOperand &MMO)
Build and insert OldValRes<def> = G_ATOMICRMW_XCHG Addr, Val, MMO.
void setState(const MachineIRBuilderState &NewState)
Setter for the State.
void setChangeObserver(GISelChangeObserver &Observer)
MachineInstrBuilder buildMaskLowPtrBits(const DstOp &Res, const SrcOp &Op0, uint32_t NumBits)
Build and insert Res = G_PTRMASK Op0, G_CONSTANT (1 << NumBits) - 1.
virtual MachineInstrBuilder buildConstant(const DstOp &Res, const ConstantInt &Val)
Build and insert Res = G_CONSTANT Val.
MachineInstrBuilder buildVecReduceMul(const DstOp &Dst, const SrcOp &Src)
Build and insert Res = G_VECREDUCE_MUL Src.
MachineInstrBuilder buildUMin(const DstOp &Dst, const SrcOp &Src0, const SrcOp &Src1)
Build and insert Res = G_UMIN Op0, Op1.
MachineInstrBuilder buildUMax(const DstOp &Dst, const SrcOp &Src0, const SrcOp &Src1)
Build and insert Res = G_UMAX Op0, Op1.
MachineInstrBuilder buildFCmp(CmpInst::Predicate Pred, const DstOp &Res, const SrcOp &Op0, const SrcOp &Op1, std::optional< unsigned > Flags=std::nullopt)
Build and insert a Res = G_FCMP PredOp0, Op1.
MachineInstrBuilder buildFAdd(const DstOp &Dst, const SrcOp &Src0, const SrcOp &Src1, std::optional< unsigned > Flags=std::nullopt)
Build and insert Res = G_FADD Op0, Op1.
MachineInstrBuilder buildPtrToInt(const DstOp &Dst, const SrcOp &Src)
Build and insert a G_PTRTOINT instruction.
MachineInstrBuilder buildFCanonicalize(const DstOp &Dst, const SrcOp &Src0, std::optional< unsigned > Flags=std::nullopt)
Build and insert Dst = G_FCANONICALIZE Src0.
MachineInstrBuilder buildSExtInReg(const DstOp &Res, const SrcOp &Op, int64_t ImmOp)
Build and insert Res = G_SEXT_INREG Op, ImmOp.
MachineInstrBuilder buildRotateLeft(const DstOp &Dst, const SrcOp &Src, const SrcOp &Amt)
Build and insert Dst = G_ROTL Src, Amt.
const MachineInstrBuilder & addImm(int64_t Val) const
Add a new immediate operand.
const MachineInstrBuilder & addPredicate(CmpInst::Predicate Pred) const
const MachineInstrBuilder & addUse(Register RegNo, unsigned Flags=0, unsigned SubReg=0) const
Add a virtual register use operand.
const MachineInstrBuilder & addMemOperand(MachineMemOperand *MMO) const
const MachineInstrBuilder & addDef(Register RegNo, unsigned Flags=0, unsigned SubReg=0) const
Add a virtual register definition operand.
Representation of each machine instruction.
Definition: MachineInstr.h:69
const MachineOperand & getOperand(unsigned i) const
Definition: MachineInstr.h:568
A description of a memory reference used in the backend.
Flags
Flags values. These may be or'd together.
MachineOperand class - Representation of each machine instruction operand.
Register getReg() const
getReg - Returns the register number.
MachineRegisterInfo - Keep track of information for virtual and physical registers,...
const DataLayout & getDataLayout() const
Get the data layout for the module's target platform.
Definition: Module.h:293
Wrapper class representing virtual and physical registers.
Definition: Register.h:19
SrcOp(const MachineInstrBuilder &MIB)
SrcOp(int64_t V)
SrcOp(const CmpInst::Predicate P)
SrcOp(uint64_t V)
SrcOp(int)=delete
MachineInstrBuilder SrcMIB
CmpInst::Predicate getPredicate() const
SrcType getSrcOpKind() const
CmpInst::Predicate Pred
int64_t getImm() const
LLT getLLTTy(const MachineRegisterInfo &MRI) const
SrcOp(const MachineOperand &Op)
void addSrcToMIB(MachineInstrBuilder &MIB) const
SrcOp(unsigned)=delete
Use of registers held in unsigned integer variables (or more rarely signed integers) is no longer per...
Register getReg() const
SrcOp(Register R)
TargetInstrInfo - Interface to description of machine instruction set.
virtual MVT getVectorIdxTy(const DataLayout &DL) const
Returns the type to be used for the index operand of: ISD::INSERT_VECTOR_ELT, ISD::EXTRACT_VECTOR_ELT...
virtual const TargetLowering * getTargetLowering() const
LLVM Value Representation.
Definition: Value.h:74
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
@ C
The default llvm calling convention, compatible with C.
Definition: CallingConv.h:34
@ ConstantFP
Definition: ISDOpcodes.h:77
@ BlockAddress
Definition: ISDOpcodes.h:84
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
@ Offset
Definition: DWP.cpp:456
DWARFExpression::Operation Op
A collection of metadata nodes that might be associated with a memory access used by the alias-analys...
Definition: Metadata.h:760
This struct is a compact representation of a valid (non-zero power of two) alignment.
Definition: Alignment.h:39
uint64_t value() const
This is a hole in the type system and should not be abused.
Definition: Alignment.h:85
Class which stores all the state required in a MachineIRBuilder.
MachineFunction * MF
MachineFunction under construction.
MDNode * MMRA
MMRA Metadata to be set on any instruction we create.
DebugLoc DL
Debug location to be set to any instruction we create.
const TargetInstrInfo * TII
Information used to access the description of the opcodes.
MDNode * PCSections
PC sections metadata to be set to any instruction we create.
MachineBasicBlock::iterator II
MachineRegisterInfo * MRI
Information used to verify types are consistent and to create virtual registers.
GISelChangeObserver * Observer
This class contains a discriminated union of information about pointers in memory operands,...