LLVM 23.0.0git
LowerMatrixIntrinsics.cpp
Go to the documentation of this file.
1//===- LowerMatrixIntrinsics.cpp - Lower matrix intrinsics -----*- 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//
9// Lower matrix intrinsics to vector operations.
10//
11// TODO:
12// * Improve fusion:
13// * Support more cases, e.g. multiply-add, multiply-sub, operands/results
14// transposed.
15// * Improve cost-modeling, e.g. choose different number of rows/columns
16// columns for tiles, consider cost of copies on alias.
17//
18//===----------------------------------------------------------------------===//
19
22#include "llvm/ADT/STLExtras.h"
23#include "llvm/ADT/ScopeExit.h"
25#include "llvm/ADT/Statistic.h"
33#include "llvm/IR/CFG.h"
34#include "llvm/IR/DataLayout.h"
37#include "llvm/IR/Function.h"
38#include "llvm/IR/IRBuilder.h"
39#include "llvm/IR/InstrTypes.h"
48#include "llvm/Support/Debug.h"
52
53#include <cmath>
54
55using namespace llvm;
56using namespace PatternMatch;
57
58#define DEBUG_TYPE "lower-matrix-intrinsics"
59
60STATISTIC(FlattenedMatrices, "Number of matrix flattenings");
61STATISTIC(ReshapedMatrices, "Number of matrix reshapes");
62STATISTIC(SplitMatrices, "Number of matrix splits");
63
64static cl::opt<bool>
65 FuseMatrix("fuse-matrix", cl::init(true), cl::Hidden,
66 cl::desc("Enable/disable fusing matrix instructions."));
67// TODO: Allow and use non-square tiles.
69 "fuse-matrix-tile-size", cl::init(4), cl::Hidden,
71 "Tile size for matrix instruction fusion using square-shaped tiles."));
73 TileLoopsThreshold("fuse-matrix-loops-threshold", cl::init(200), cl::Hidden,
74 cl::desc("Generate loop nests for tiling when expected "
75 "number of operations exceeds threshold."));
77 "force-fuse-matrix", cl::init(false), cl::Hidden,
78 cl::desc("Force matrix instruction fusion even if not profitable."));
80 "matrix-allow-contract", cl::init(false), cl::Hidden,
81 cl::desc("Allow the use of FMAs if available and profitable. This may "
82 "result in different results, due to less rounding error."));
83
84static cl::opt<bool>
85 VerifyShapeInfo("verify-matrix-shapes", cl::Hidden,
86 cl::desc("Enable/disable matrix shape verification."),
87 cl::init(false));
88
90
92 "matrix-default-layout", cl::init(MatrixLayoutTy::ColumnMajor),
93 cl::desc("Sets the default matrix layout"),
95 "Use column-major layout"),
97 "Use row-major layout")));
98
99static cl::opt<bool> PrintAfterTransposeOpt("matrix-print-after-transpose-opt",
100 cl::init(false));
101
103 "matrix-split-matmul-remainder-over-threshold", cl::Hidden,
104 cl::desc("Illegal remainder vectors over this size in bits should be split "
105 "in the inner loop of matmul"),
106 cl::init(0));
107
108namespace llvm {
110} // end namespace llvm
111
112/// Helper function to either return Scope, if it is a subprogram or the
113/// attached subprogram for a local scope.
115 if (auto *Subprogram = dyn_cast<DISubprogram>(Scope))
116 return Subprogram;
117 return cast<DILocalScope>(Scope)->getSubprogram();
118}
119
120/// Return true if V is a splat of a value (which is used when multiplying a
121/// matrix with a scalar).
122static bool isSplat(Value *V) {
123 if (auto *SV = dyn_cast<ShuffleVectorInst>(V))
124 return SV->isZeroEltSplat();
125 return false;
126}
127
128/// Match any mul operation (fp or integer).
129template <typename LTy, typename RTy>
130static auto m_AnyMul(const LTy &L, const RTy &R) {
131 return m_CombineOr(m_Mul(L, R), m_FMul(L, R));
132}
133
134/// Match any add operation (fp or integer).
135template <typename LTy, typename RTy>
136static auto m_AnyAdd(const LTy &L, const RTy &R) {
137 return m_CombineOr(m_Add(L, R), m_FAdd(L, R));
138}
139
140// Given an element pointer \p BasePtr to the start of a (sub) matrix, compute
141// the start address of vector \p VecIdx with type (\p EltType x \p NumElements)
142// assuming \p Stride elements between start two consecutive vectors.
143// \p Stride must be >= \p NumElements.
144// For column-major matrixes, the function computes the address of a column
145// vectors and \p NumElements must be set to the number of elements in a column
146// (= number of rows of the matrix). For row-major matrixes, the function
147// computes the address of a row vector and \p NumElements must be set to the
148// number of elements in a column (= number of columns of the matrix).
149//
150// Consider a 4x4 matrix in column-mjaor layout like below
151//
152// 0 1 2 3
153// 0 v_0_0 v_0_1 v_0_2 v_0_3
154// 1 v_1_0 v_1_1 v_1_2 v_1_3
155// 2 v_2_0 v_2_1 v_2_2 v_2_3
156// 3 v_3_0 v_3_1 v_3_2 v_3_3
157
158// To compute the column addresses for a 2x3 sub-matrix at row 1 and column 1,
159// we need a pointer to the first element of the submatrix as base pointer.
160// Then we can use computeVectorAddr to compute the addresses for the columns
161// of the sub-matrix.
162//
163// Column 0: computeVectorAddr(Base, 0 (column), 4 (stride), 2 (num rows), ..)
164// -> just returns Base
165// Column 1: computeVectorAddr(Base, 1 (column), 4 (stride), 2 (num rows), ..)
166// -> returns Base + (1 * 4)
167// Column 2: computeVectorAddr(Base, 2 (column), 4 (stride), 2 (num rows), ..)
168// -> returns Base + (2 * 4)
169//
170// The graphic below illustrates the number of elements in a column (marked
171// with |) and the number of skipped elements (marked with }).
172//
173// v_0_0 v_0_1 {v_0_2 {v_0_3
174// Base Col 1 Col 2
175// | | |
176// v_1_0 |v_1_1 |v_1_2 |v_1_3
177// v_2_0 |v_2_1 |v_2_2 |v_2_3
178// v_3_0 {v_3_1 {v_3_2 v_3_3
179//
180static Value *computeVectorAddr(Value *BasePtr, Value *VecIdx, Value *Stride,
181 unsigned NumElements, Type *EltType,
182 IRBuilder<> &Builder) {
183
184 assert((!isa<ConstantInt>(Stride) ||
185 cast<ConstantInt>(Stride)->getZExtValue() >= NumElements) &&
186 "Stride must be >= the number of elements in the result vector.");
187
188 // Compute the start of the vector with index VecIdx as VecIdx * Stride.
189 Value *VecStart = Builder.CreateMul(VecIdx, Stride, "vec.start");
190
191 // Get pointer to the start of the selected vector. Skip GEP creation,
192 // if we select vector 0.
193 if (isa<ConstantInt>(VecStart) && cast<ConstantInt>(VecStart)->isZero())
194 VecStart = BasePtr;
195 else
196 VecStart = Builder.CreateGEP(EltType, BasePtr, VecStart, "vec.gep");
197
198 return VecStart;
199}
200
201namespace {
202struct ShapeInfo {
203 unsigned NumRows;
204 unsigned NumColumns;
205
206 bool IsColumnMajor;
207
208 ShapeInfo(unsigned NumRows = 0, unsigned NumColumns = 0)
209 : NumRows(NumRows), NumColumns(NumColumns),
210 IsColumnMajor(MatrixLayout == MatrixLayoutTy::ColumnMajor) {}
211
212 ShapeInfo(Value *NumRows, Value *NumColumns)
213 : ShapeInfo(cast<ConstantInt>(NumRows)->getZExtValue(),
214 cast<ConstantInt>(NumColumns)->getZExtValue()) {}
215
216 bool operator==(const ShapeInfo &other) {
217 return NumRows == other.NumRows && NumColumns == other.NumColumns;
218 }
219 bool operator!=(const ShapeInfo &other) { return !(*this == other); }
220
221 /// Returns true if shape-information is defined, meaning both dimensions
222 /// are != 0.
223 operator bool() const {
224 assert(NumRows == 0 || NumColumns != 0);
225 return NumRows != 0;
226 }
227
228 unsigned getStride() const {
229 if (IsColumnMajor)
230 return NumRows;
231 return NumColumns;
232 }
233
234 unsigned getNumVectors() const {
235 if (IsColumnMajor)
236 return NumColumns;
237 return NumRows;
238 }
239
240 /// Returns the transposed shape.
241 ShapeInfo t() const { return ShapeInfo(NumColumns, NumRows); }
242
243 friend raw_ostream &operator<<(raw_ostream &OS, ShapeInfo SI);
244
245 LLVM_DUMP_METHOD void dump() const { dbgs() << *this << '\n'; }
246};
247
248raw_ostream &operator<<(raw_ostream &OS, ShapeInfo SI) {
249 return OS << SI.NumRows << 'x' << SI.NumColumns;
250}
251
252} // namespace
253
254static bool isShapePreserving(Value *V) {
256 if (!I)
257 return true;
258
259 if (isa<SelectInst>(I))
260 return true;
261
262 if (I->isBinaryOp())
263 return true;
264
265 if (auto *Cast = dyn_cast<CastInst>(V)) {
266 switch (Cast->getOpcode()) {
267 case llvm::Instruction::Trunc:
268 case llvm::Instruction::ZExt:
269 case llvm::Instruction::SExt:
270 case llvm::Instruction::FPToUI:
271 case llvm::Instruction::FPToSI:
272 case llvm::Instruction::UIToFP:
273 case llvm::Instruction::SIToFP:
274 case llvm::Instruction::FPTrunc:
275 case llvm::Instruction::FPExt:
276 return true;
277 case llvm::Instruction::AddrSpaceCast:
278 case CastInst::PtrToAddr:
279 case CastInst::PtrToInt:
280 case CastInst::IntToPtr:
281 return false;
282 case CastInst::BitCast: {
283 if (auto *SrcVTy = dyn_cast<FixedVectorType>(Cast->getSrcTy()))
284 if (auto *DestVTy = dyn_cast<FixedVectorType>(Cast->getDestTy()))
285 return SrcVTy->getNumElements() == DestVTy->getNumElements();
286 return false;
287 }
288 case llvm::Instruction::CastOpsEnd:
289 llvm_unreachable("not an actual cast op");
290 }
291 llvm_unreachable("unhandled cast opcode");
292 }
293
294 if (auto *II = dyn_cast<IntrinsicInst>(V))
295 switch (II->getIntrinsicID()) {
296 case Intrinsic::abs:
297 case Intrinsic::fabs:
298 return true;
299 default:
300 return false;
301 }
302
303 switch (I->getOpcode()) {
304 case Instruction::PHI:
305 case Instruction::FNeg:
306 return true;
307 default:
308 return false;
309 }
310}
311
312/// Return an iterator over the operands of \p I that should share shape
313/// information with \p I.
316 "Can't retrieve shaped operands for an instruction that does not "
317 "preserve shape information");
318 auto Ops = I->operands();
319 return isa<SelectInst>(I) ? drop_begin(Ops) : Ops;
320}
321
322/// Return the ShapeInfo for the result of \p I, it it can be determined.
323static std::optional<ShapeInfo>
325 const DenseMap<Value *, ShapeInfo> &ShapeMap) {
326 Value *M;
327 Value *N;
328 Value *K;
330 m_Value(), m_Value(), m_Value(M), m_Value(N), m_Value(K))))
331 return ShapeInfo(M, K);
333 m_Value(N)))) {
334 // Flip dimensions.
335 return ShapeInfo(N, M);
336 }
338 m_Value(), m_Value(), m_Value(), m_Value(), m_Value(M),
339 m_Value(N))))
340 return ShapeInfo(N, M);
342 m_Value(), m_Value(), m_Value(), m_Value(M), m_Value(N))))
343 return ShapeInfo(M, N);
344 Value *MatrixA;
345 if (match(I, m_Store(m_Value(MatrixA), m_Value()))) {
346 auto OpShape = ShapeMap.find(MatrixA);
347 if (OpShape != ShapeMap.end())
348 return OpShape->second;
349 }
350
351 if (isShapePreserving(I)) {
352 auto ShapedOps = getShapedOperandsForInst(I);
353 // Find the first operand that has a known shape and use that.
354 for (auto &Op : ShapedOps) {
355 auto OpShape = ShapeMap.find(Op.get());
356 if (OpShape != ShapeMap.end())
357 return OpShape->second;
358 }
359 }
360 return std::nullopt;
361}
362
363namespace {
364
365/// LowerMatrixIntrinsics contains the methods used to lower matrix intrinsics.
366///
367/// Currently, the lowering for each matrix intrinsic is done as follows:
368/// 1. Propagate the shape information from intrinsics to connected
369/// instructions.
370/// 2. Lower instructions with shape information (assuming column-major layout).
371/// The lowering works similarly using row-major layout.
372/// 2.1. Get column vectors for each argument. If we already lowered the
373/// definition of an argument, use the produced column vectors directly.
374/// If not, split the operand vector containing an embedded matrix into
375/// a set of column vectors,
376/// 2.2. Lower the instruction in terms of column major operations, which
377/// yields a set of column vectors containing result matrix. Note that we
378/// lower all instructions that have shape information. Besides the
379/// intrinsics, this includes stores for example.
380/// 2.3. Update uses of the lowered instruction. If we have shape information
381/// for a user, there is nothing to do, as we will look up the result
382/// column matrix when lowering the user. For other uses, we embed the
383/// result matrix in a flat vector and update the use.
384/// 2.4. Cache the result column matrix for the instruction we lowered
385/// 3. After we lowered all instructions in a function, remove the now
386/// obsolete instructions.
387///
388class LowerMatrixIntrinsics {
389 Function &Func;
390 const DataLayout &DL;
391 const TargetTransformInfo &TTI;
393 AliasAnalysis *AA = nullptr;
394 DominatorTree *DT = nullptr;
395 LoopInfo *LI = nullptr;
396 OptimizationRemarkEmitter *ORE = nullptr;
397
398 /// Contains estimates of the number of operations (loads, stores, compute)
399 /// required to lower a matrix operation.
400 struct OpInfoTy {
401 /// Number of stores emitted to generate this matrix.
402 unsigned NumStores = 0;
403 /// Number of loads emitted to generate this matrix.
404 unsigned NumLoads = 0;
405 /// Number of compute operations emitted to generate this matrix.
406 unsigned NumComputeOps = 0;
407 /// Most of the time transposes can be fused with matrix multiplies or can
408 /// be folded away via algebraic simplifications. This is the number of
409 /// transposes that we failed to make "free" via such optimizations.
410 unsigned NumExposedTransposes = 0;
411
412 OpInfoTy &operator+=(const OpInfoTy &RHS) {
413 NumStores += RHS.NumStores;
414 NumLoads += RHS.NumLoads;
415 NumComputeOps += RHS.NumComputeOps;
416 NumExposedTransposes += RHS.NumExposedTransposes;
417 return *this;
418 }
419 };
420
421 /// Wrapper class representing a matrix as a set of vectors, either in row or
422 /// column major layout. All vectors must have the same vector type.
423 class MatrixTy {
424 SmallVector<Value *, 16> Vectors;
425
426 OpInfoTy OpInfo;
427
428 bool IsColumnMajor = true;
429
430 public:
431 MatrixTy() : IsColumnMajor(MatrixLayout == MatrixLayoutTy::ColumnMajor) {}
432 MatrixTy(ArrayRef<Value *> Vectors)
433 : Vectors(Vectors),
434 IsColumnMajor(MatrixLayout == MatrixLayoutTy::ColumnMajor) {}
435 MatrixTy(unsigned NumRows, unsigned NumColumns, Type *EltTy)
436 : IsColumnMajor(MatrixLayout == MatrixLayoutTy::ColumnMajor) {
437
438 unsigned D = isColumnMajor() ? NumColumns : NumRows;
439 for (unsigned J = 0; J < D; ++J)
441 EltTy, isColumnMajor() ? NumRows : NumColumns)));
442 }
443
444 Value *getVector(unsigned i) const { return Vectors[i]; }
445 Value *getColumn(unsigned i) const {
446 assert(isColumnMajor() && "only supported for column-major matrixes");
447 return Vectors[i];
448 }
449 Value *getRow(unsigned i) const {
450 assert(!isColumnMajor() && "only supported for row-major matrixes");
451 return Vectors[i];
452 }
453
454 void setVector(unsigned i, Value *V) { Vectors[i] = V; }
455
456 Type *getElementType() const { return getVectorTy()->getElementType(); }
457
458 unsigned getNumVectors() const {
459 if (isColumnMajor())
460 return getNumColumns();
461 return getNumRows();
462 }
463
464 unsigned getNumColumns() const {
465 if (isColumnMajor())
466 return Vectors.size();
467 else {
468 assert(Vectors.size() > 0 && "Cannot call getNumRows without columns");
469 return getVectorTy()->getNumElements();
470 }
471 }
472 unsigned getNumRows() const {
473 if (isColumnMajor()) {
474 assert(Vectors.size() > 0 && "Cannot call getNumRows without columns");
475 return getVectorTy()->getNumElements();
476 } else
477 return Vectors.size();
478 }
479
480 void addVector(Value *V) { Vectors.push_back(V); }
481 FixedVectorType *getColumnTy() {
482 assert(isColumnMajor() && "only supported for column-major matrixes");
483 return getVectorTy();
484 }
485
486 FixedVectorType *getVectorTy() const {
487 return cast<FixedVectorType>(Vectors[0]->getType());
488 }
489
490 iterator_range<SmallVector<Value *, 8>::iterator> columns() {
491 assert(isColumnMajor() &&
492 "columns() only supported for column-major matrixes");
493 return make_range(Vectors.begin(), Vectors.end());
494 }
495
496 iterator_range<SmallVector<Value *, 8>::iterator> vectors() {
497 return make_range(Vectors.begin(), Vectors.end());
498 }
499
500 /// Embed the vectors of the matrix into a flat vector by concatenating
501 /// them.
502 Value *embedInVector(IRBuilder<> &Builder) const {
503 return Vectors.size() == 1 ? Vectors[0]
504 : concatenateVectors(Builder, Vectors);
505 }
506
507 MatrixTy &addNumLoads(unsigned N) {
508 OpInfo.NumLoads += N;
509 return *this;
510 }
511
512 void setNumLoads(unsigned N) { OpInfo.NumLoads = N; }
513
514 MatrixTy &addNumStores(unsigned N) {
515 OpInfo.NumStores += N;
516 return *this;
517 }
518
519 MatrixTy &addNumExposedTransposes(unsigned N) {
520 OpInfo.NumExposedTransposes += N;
521 return *this;
522 }
523
524 MatrixTy &addNumComputeOps(unsigned N) {
525 OpInfo.NumComputeOps += N;
526 return *this;
527 }
528
529 unsigned getNumStores() const { return OpInfo.NumStores; }
530 unsigned getNumLoads() const { return OpInfo.NumLoads; }
531 unsigned getNumComputeOps() const { return OpInfo.NumComputeOps; }
532
533 const OpInfoTy &getOpInfo() const { return OpInfo; }
534
535 bool isColumnMajor() const { return IsColumnMajor; }
536
537 unsigned getStride() const {
538 if (isColumnMajor())
539 return getNumRows();
540 return getNumColumns();
541 }
542
543 ShapeInfo shape() const { return {getNumRows(), getNumColumns()}; }
544
545 /// Extract a vector of \p NumElts starting at index (\p I, \p J). If the
546 /// matrix is column-major, the result vector is extracted from a column
547 /// vector, otherwise from a row vector.
548 Value *extractVector(unsigned I, unsigned J, unsigned NumElts,
549 IRBuilder<> &Builder) const {
550 Value *Vec = isColumnMajor() ? getColumn(J) : getRow(I);
551 assert(cast<FixedVectorType>(Vec->getType())->getNumElements() >=
552 NumElts &&
553 "Extracted vector will contain poison values");
554 return Builder.CreateShuffleVector(
555 Vec, createSequentialMask(isColumnMajor() ? I : J, NumElts, 0),
556 "block");
557 }
558 };
559
560 /// Maps instructions to their shape information. The shape information
561 /// describes the shape to be used while lowering. This matches the shape of
562 /// the result value of the instruction, with the only exceptions being store
563 /// instructions and the matrix_column_major_store intrinsics. For those, the
564 /// shape information indicates that those instructions should be lowered
565 /// using shape information as well. Note that extra care is needed when
566 /// erasing or RAUW'ing a value that is present in ShapeMap. If the
567 /// replacement is also a matrix operation, use
568 /// updateShapeAndReplaceAllUsesWith to make sure the replacement is added to
569 /// ShapeMap. We don't use ValueMap, as there are also cases where we do not
570 /// want to add shape information for a replacement instruction. When directly
571 /// erasing a value with an entry in ShapeMap, use
572 /// eraseFromParentAndRemoveFromShapeMap to make sure ShapeMap is also updated
573 /// accordingly.
574 DenseMap<Value *, ShapeInfo> ShapeMap;
575
576 /// List of instructions to remove. While lowering, we are not replacing all
577 /// users of a lowered instruction, if shape information is available and
578 /// those need to be removed after we finished lowering.
579 SmallVector<Instruction *, 16> ToRemove;
580
581 /// Map from instructions to their produced column matrix.
582 MapVector<Value *, MatrixTy> Inst2ColumnMatrix;
583
584private:
585 static FastMathFlags getFastMathFlags(Instruction *Inst) {
586 FastMathFlags FMF;
587
588 if (isa<FPMathOperator>(*Inst))
589 FMF = Inst->getFastMathFlags();
590
592
593 return FMF;
594 }
595
596public:
597 LowerMatrixIntrinsics(Function &F, TargetTransformInfo &TTI,
599 : Func(F), DL(F.getDataLayout()), TTI(TTI), AM(AM) {}
600
601 unsigned getNumOps(Type *VT) {
602 assert(isa<FixedVectorType>(VT) && "Expected vector type");
603 return getNumOps(VT->getScalarType(),
604 cast<FixedVectorType>(VT)->getNumElements());
605 }
606
607 /// Is this the minimal version executed in the backend pipelines.
608 bool isMinimal() const {
609 return !DT;
610 }
611
612 /// Return the estimated number of vector ops required for an operation on
613 /// \p VT * N.
614 unsigned getNumOps(Type *ST, unsigned N) {
615 return std::ceil((ST->getPrimitiveSizeInBits() * N).getFixedValue() /
616 double(TTI.getRegisterBitWidth(
618 .getFixedValue()));
619 }
620
621 /// Estimate the number of native vector operations for a multiply of matrices
622 /// with dimensions \p R x \p M and \p M x \p C. Native ops are computed as
623 /// ceil(ElementCount * ElementBits / RegisterBits).
624 ///
625 /// Native vector ops per operation type (VF = native vector elements):
626 /// FMAs: C * ceil(R/VF) * M (one FMA per VF output elements)
627 /// A loads: ceil(R/VF) * M (A has M columns, ceil(R/VF) native loads each)
628 /// B loads: ceil(M/VF) * C (B has C columns, ceil(M/VF) native loads each)
629 /// Stores: C * ceil(R/VF) (one store per VF output elements)
630 unsigned getNumNativeVectorOps(Type *EltType, unsigned R, unsigned M,
631 unsigned C) {
632 unsigned NumFMAs = C * getNumOps(EltType, R) * M;
633 unsigned NumALoads = getNumOps(EltType, R) * M;
634 unsigned NumBLoads = getNumOps(EltType, M) * C;
635 unsigned NumStores = getNumOps(EltType, R) * C;
636 return NumFMAs + NumALoads + NumBLoads + NumStores;
637 }
638
639 /// Return the set of vectors that a matrix value is lowered to.
640 ///
641 /// If we lowered \p MatrixVal, just return the cache result matrix. Otherwise
642 /// split the flat vector \p MatrixVal containing a matrix with shape \p SI
643 /// into vectors.
644 MatrixTy getMatrix(Value *MatrixVal, const ShapeInfo &SI,
645 IRBuilder<> &Builder) {
646 FixedVectorType *VType = cast<FixedVectorType>(MatrixVal->getType());
647 assert(VType->getNumElements() == SI.NumRows * SI.NumColumns &&
648 "The vector size must match the number of matrix elements");
649
650 // Check if we lowered MatrixVal using shape information. In that case,
651 // return the existing matrix, if it matches the requested shape
652 // information. If there is a mis-match, embed the result in a flat
653 // vector and split it later.
654 auto Found = Inst2ColumnMatrix.find(MatrixVal);
655 if (Found != Inst2ColumnMatrix.end()) {
656 MatrixTy &M = Found->second;
657 // Return the found matrix, if its shape matches the requested shape
658 // information
659 if (SI.NumRows == M.getNumRows() && SI.NumColumns == M.getNumColumns())
660 return M;
661
662 MatrixVal = M.embedInVector(Builder);
663 }
664
665 // Otherwise split MatrixVal.
666 SmallVector<Value *, 16> SplitVecs;
667 for (unsigned MaskStart = 0; MaskStart < VType->getNumElements();
668 MaskStart += SI.getStride()) {
669 Value *V = Builder.CreateShuffleVector(
670 MatrixVal, createSequentialMask(MaskStart, SI.getStride(), 0),
671 "split");
672 SplitVecs.push_back(V);
673 }
674
675 if (Instruction *Inst = dyn_cast<Instruction>(MatrixVal)) {
676 if (Found != Inst2ColumnMatrix.end()) {
677 // FIXME: re: "at least": SplitVecs.size() doesn't count the shuffles
678 // that embedInVector created.
679 LLVM_DEBUG(dbgs() << "matrix reshape from " << Found->second.shape()
680 << " to " << SI << " using at least "
681 << SplitVecs.size() << " shuffles on behalf of:\n"
682 << *Inst << '\n');
683 ReshapedMatrices++;
684 } else if (!ShapeMap.contains(MatrixVal)) {
686 dbgs()
687 << "splitting a " << SI << " matrix with " << SplitVecs.size()
688 << " shuffles beacuse we do not have a shape-aware lowering for "
689 "its def:\n"
690 << *Inst << '\n');
691 (void)Inst;
692 SplitMatrices++;
693 } else {
694 // The ShapeMap has it, so it's a case where we're being lowered
695 // before the def, and we expect that InstCombine will clean things up
696 // afterward.
697 }
698 }
699
700 return {SplitVecs};
701 }
702
703 /// If \p V already has a known shape return false. Otherwise set the shape
704 /// for instructions that support it.
705 bool setShapeInfo(Value *V, ShapeInfo Shape) {
706 assert(Shape && "Shape not set");
707 if (isa<UndefValue>(V) || !supportsShapeInfo(V))
708 return false;
709
710 auto SIter = ShapeMap.find(V);
711 if (SIter != ShapeMap.end()) {
712 if (VerifyShapeInfo && (SIter->second.NumRows != Shape.NumRows ||
713 SIter->second.NumColumns != Shape.NumColumns)) {
714 errs() << "Conflicting shapes (" << SIter->second.NumRows << "x"
715 << SIter->second.NumColumns << " vs " << Shape.NumRows << "x"
716 << Shape.NumColumns << ") for " << *V << "\n";
718 "Matrix shape verification failed, compilation aborted!");
719 }
720
721 LLVM_DEBUG(dbgs() << " not overriding existing shape: "
722 << SIter->second.NumRows << " "
723 << SIter->second.NumColumns << " for " << *V << "\n");
724 return false;
725 }
726
727 ShapeMap.insert({V, Shape});
728 LLVM_DEBUG(dbgs() << " " << Shape.NumRows << " x " << Shape.NumColumns
729 << " for " << *V << "\n");
730 return true;
731 }
732
733 /// Returns true if shape information can be used for \p V. The supported
734 /// instructions must match the instructions that can be lowered by this pass.
735 bool supportsShapeInfo(Value *V) {
737 if (!Inst)
738 return false;
739
740 IntrinsicInst *II = dyn_cast<IntrinsicInst>(Inst);
741 if (II)
742 switch (II->getIntrinsicID()) {
743 case Intrinsic::matrix_multiply:
744 case Intrinsic::matrix_transpose:
745 case Intrinsic::matrix_column_major_load:
746 case Intrinsic::matrix_column_major_store:
747 return true;
748 default:
749 break;
750 }
751 return isShapePreserving(V) || isa<StoreInst>(V) || isa<LoadInst>(V);
752 }
753
754 /// Propagate the shape information of instructions to their users.
755 /// The work list contains instructions for which we can compute the shape,
756 /// either based on the information provided by matrix intrinsics or known
757 /// shapes of operands.
759 propagateShapeForward(SmallVectorImpl<Instruction *> &WorkList) {
761 // Pop an element for which we guaranteed to have at least one of the
762 // operand shapes. Add the shape for this and then add users to the work
763 // list.
764 LLVM_DEBUG(dbgs() << "Forward-propagate shapes:\n");
765 while (!WorkList.empty()) {
766 Instruction *Inst = WorkList.pop_back_val();
767
768 // New entry, set the value and insert operands
769 bool Propagate = false;
770 if (auto SI = computeShapeInfoForInst(Inst, ShapeMap))
771 Propagate = setShapeInfo(Inst, *SI);
772
773 if (Propagate) {
774 NewWorkList.push_back(Inst);
775 for (auto *User : Inst->users())
776 if (ShapeMap.count(User) == 0)
777 WorkList.push_back(cast<Instruction>(User));
778 }
779 }
780
781 return NewWorkList;
782 }
783
784 /// Propagate the shape to operands of instructions with shape information.
785 /// \p Worklist contains the instruction for which we already know the shape.
787 propagateShapeBackward(SmallVectorImpl<Instruction *> &WorkList) {
789
790 auto pushInstruction = [](Value *V,
791 SmallVectorImpl<Instruction *> &WorkList) {
793 if (I)
794 WorkList.push_back(I);
795 };
796 // Pop an element with known shape. Traverse the operands, if their shape
797 // derives from the result shape and is unknown, add it and add them to the
798 // worklist.
799 LLVM_DEBUG(dbgs() << "Backward-propagate shapes:\n");
800 while (!WorkList.empty()) {
801 Value *V = WorkList.pop_back_val();
802
803 size_t BeforeProcessingV = WorkList.size();
804 if (!isa<Instruction>(V))
805 continue;
806
807 Value *MatrixA;
808 Value *MatrixB;
809 Value *M;
810 Value *N;
811 Value *K;
813 m_Value(MatrixA), m_Value(MatrixB), m_Value(M),
814 m_Value(N), m_Value(K)))) {
815 if (setShapeInfo(MatrixA, {M, N}))
816 pushInstruction(MatrixA, WorkList);
817
818 if (setShapeInfo(MatrixB, {N, K}))
819 pushInstruction(MatrixB, WorkList);
820
822 m_Value(MatrixA), m_Value(M), m_Value(N)))) {
823 // Flip dimensions.
824 if (setShapeInfo(MatrixA, {M, N}))
825 pushInstruction(MatrixA, WorkList);
827 m_Value(MatrixA), m_Value(), m_Value(), m_Value(),
828 m_Value(M), m_Value(N)))) {
829 if (setShapeInfo(MatrixA, {M, N})) {
830 pushInstruction(MatrixA, WorkList);
831 }
832 } else if (isa<LoadInst>(V) ||
834 // Nothing to do, no matrix input.
835 } else if (isa<StoreInst>(V)) {
836 // Nothing to do. We forward-propagated to this so we would just
837 // backward propagate to an instruction with an already known shape.
838 } else if (isShapePreserving(V)) {
839 auto ShapedOps = getShapedOperandsForInst(cast<Instruction>(V));
840 // Propagate to all operands.
841 ShapeInfo Shape = ShapeMap[V];
842 for (Use &U : ShapedOps) {
843 if (setShapeInfo(U.get(), Shape))
844 pushInstruction(U.get(), WorkList);
845 }
846 }
847 // After we discovered new shape info for new instructions in the
848 // worklist, we use their users as seeds for the next round of forward
849 // propagation.
850 for (size_t I = BeforeProcessingV; I != WorkList.size(); I++)
851 for (User *U : WorkList[I]->users())
852 if (isa<Instruction>(U) && V != U)
853 NewWorkList.push_back(cast<Instruction>(U));
854 }
855 return NewWorkList;
856 }
857
858 /// (Op0 op Op1)^T -> Op0^T op Op1^T
859 /// Transpose \p Op0 and \p Op1 of shape \p Shape0 and \p Shape1, then use
860 /// them on both sides of \p Operation.
861 Instruction *distributeTransposes(
862 Value *Op0, ShapeInfo Shape0, Value *Op1, ShapeInfo Shape1,
863 MatrixBuilder &Builder,
864 function_ref<Instruction *(Value *, ShapeInfo, Value *, ShapeInfo)>
865 Operation) {
866 Value *T0 = Builder.CreateMatrixTranspose(
867 Op0, Shape0.NumRows, Shape0.NumColumns, Op0->getName() + "_t");
868 // We are being run after shape prop, add shape for newly created
869 // instructions so that we lower them later.
870 setShapeInfo(T0, Shape0.t());
871 Value *T1 = Builder.CreateMatrixTranspose(
872 Op1, Shape1.NumRows, Shape1.NumColumns, Op1->getName() + "_t");
873 setShapeInfo(T1, Shape1.t());
874 return Operation(T0, Shape0.t(), T1, Shape1.t());
875 }
876
877 /// Erase \p Inst from both ShapeMap (if an entry exists) and erase \p Inst
878 /// itself.
879 void eraseFromParentAndRemoveFromShapeMap(Instruction *Inst) {
880 ShapeMap.erase(Inst);
881 Inst->eraseFromParent();
882 }
883
884 /// Erase \p V from \p BB and move \II forward to avoid invalidating
885 /// iterators.
886 void eraseFromParentAndMove(Value *V, BasicBlock::reverse_iterator &II,
887 BasicBlock &BB) {
888 auto *Inst = cast<Instruction>(V);
889 // Still used, don't erase.
890 if (!Inst->use_empty())
891 return;
892 if (II != BB.rend() && Inst == &*II)
893 ++II;
894 eraseFromParentAndRemoveFromShapeMap(Inst);
895 }
896
897 /// Add a new entry to ShapeMap for \p New with \p Old's shape info, erase the
898 /// entry for \p Old and replace all uses of \p Old with \p New.
899 void updateShapeAndReplaceAllUsesWith(Instruction &Old, Value *New) {
900 // We need to remove Old from the ShapeMap otherwise RAUW will replace it
901 // with New. We should only add New it it supportsShapeInfo so we insert
902 // it conditionally instead.
903 auto S = ShapeMap.find(&Old);
904 if (S != ShapeMap.end()) {
905 ShapeMap.erase(S);
906 if (supportsShapeInfo(New))
907 ShapeMap.insert({New, S->second});
908 }
909 Old.replaceAllUsesWith(New);
910 }
911
912 /// Sink a top-level transpose inside matmuls and adds.
913 /// This creates and erases instructions as needed, and returns the newly
914 /// created instruction while updating the iterator to avoid invalidation. If
915 /// this returns nullptr, no new instruction was created.
916 Instruction *sinkTranspose(Instruction &I, BasicBlock::reverse_iterator &II,
917 bool &Changed) {
918 BasicBlock &BB = *I.getParent();
919 IRBuilder<> IB(&I);
920 MatrixBuilder Builder(IB);
921
922 Value *TA, *TAMA, *TAMB;
923 ConstantInt *R, *K, *C;
926 return nullptr;
927
928 // Transpose of a transpose is a nop when the shapes match.
929 Value *TATA;
931 m_Value(TATA), m_Specific(C), m_Specific(R)))) {
932 updateShapeAndReplaceAllUsesWith(I, TATA);
933 eraseFromParentAndMove(&I, II, BB);
934 eraseFromParentAndMove(TA, II, BB);
935 Changed = true;
936 return nullptr;
937 }
938
939 // k^T -> k
940 if (isSplat(TA)) {
941 updateShapeAndReplaceAllUsesWith(I, TA);
942 eraseFromParentAndMove(&I, II, BB);
943 Changed = true;
944 return nullptr;
945 }
946
947 // (A * B)^t -> B^t * A^t
948 // RxK KxC CxK KxR
950 m_Value(TAMA), m_Value(TAMB), m_ConstantInt(R),
952 auto NewInst = distributeTransposes(
953 TAMB, {K, C}, TAMA, {R, K}, Builder,
954 [&](Value *T0, ShapeInfo Shape0, Value *T1, ShapeInfo Shape1) {
955 return Builder.CreateMatrixMultiply(T0, T1, Shape0.NumRows,
956 Shape0.NumColumns,
957 Shape1.NumColumns, "mmul");
958 });
959 updateShapeAndReplaceAllUsesWith(I, NewInst);
960 eraseFromParentAndMove(&I, II, BB);
961 eraseFromParentAndMove(TA, II, BB);
962 Changed = true;
963 return NewInst;
964 }
965
966 // Same as above, but with a mul, which occurs when multiplied
967 // with a scalar.
968 // (A * k)^t -> A^t * k
969 // R x C RxC
970 if (match(TA, m_AnyMul(m_Value(TAMA), m_Value(TAMB))) &&
971 (isSplat(TAMA) || isSplat(TAMB))) {
972 IRBuilder<> LocalBuilder(&I);
973 // We know that the transposed operand is of shape RxC.
974 // An when multiplied with a scalar, the shape is preserved.
975 auto NewInst = distributeTransposes(
976 TAMA, {R, C}, TAMB, {R, C}, Builder,
977 [&](Value *T0, ShapeInfo Shape0, Value *T1, ShapeInfo Shape1) {
978 bool IsFP = I.getType()->isFPOrFPVectorTy();
979 auto *Mul = IsFP ? LocalBuilder.CreateFMul(T0, T1, "mmul")
980 : LocalBuilder.CreateMul(T0, T1, "mmul");
982 setShapeInfo(Result, Shape0);
983 return Result;
984 });
985 updateShapeAndReplaceAllUsesWith(I, NewInst);
986 eraseFromParentAndMove(&I, II, BB);
987 eraseFromParentAndMove(TA, II, BB);
988 Changed = true;
989 return NewInst;
990 }
991
992 // (A + B)^t -> A^t + B^t
993 // RxC RxC CxR CxR
994 if (match(TA, m_AnyAdd(m_Value(TAMA), m_Value(TAMB)))) {
995 IRBuilder<> LocalBuilder(&I);
996 auto NewInst = distributeTransposes(
997 TAMA, {R, C}, TAMB, {R, C}, Builder,
998 [&](Value *T0, ShapeInfo Shape0, Value *T1, ShapeInfo Shape1) {
999 bool IsFP = I.getType()->isFPOrFPVectorTy();
1000 auto *Add = IsFP ? LocalBuilder.CreateFAdd(T0, T1, "madd")
1001 : LocalBuilder.CreateAdd(T0, T1, "madd");
1002
1003 auto *Result = cast<Instruction>(Add);
1004 setShapeInfo(Result, Shape0);
1005 return Result;
1006 });
1007 updateShapeAndReplaceAllUsesWith(I, NewInst);
1008 eraseFromParentAndMove(&I, II, BB);
1009 eraseFromParentAndMove(TA, II, BB);
1010 Changed = true;
1011 return NewInst;
1012 }
1013
1014 return nullptr;
1015 }
1016
1017 bool liftTranspose(Instruction &I) {
1018 // Erase dead Instructions after lifting transposes from binops.
1019 auto CleanupBinOp = [this](Instruction &T, Value *A, Value *B) {
1020 if (T.use_empty())
1021 eraseFromParentAndRemoveFromShapeMap(&T);
1022 if (A->use_empty())
1023 eraseFromParentAndRemoveFromShapeMap(cast<Instruction>(A));
1024 if (A != B && B->use_empty())
1025 eraseFromParentAndRemoveFromShapeMap(cast<Instruction>(B));
1026 };
1027
1028 Value *A, *B, *AT, *BT;
1029 ConstantInt *R, *K, *C;
1030 // A^t * B ^t -> (B * A)^t
1033 m_ConstantInt(K), m_ConstantInt(C))) &&
1036 IRBuilder<> IB(&I);
1037 MatrixBuilder Builder(IB);
1038 Value *M = Builder.CreateMatrixMultiply(
1039 BT, AT, C->getZExtValue(), K->getZExtValue(), R->getZExtValue());
1040 setShapeInfo(M, {C, R});
1041 Instruction *NewInst = Builder.CreateMatrixTranspose(M, C->getZExtValue(),
1042 R->getZExtValue());
1043 updateShapeAndReplaceAllUsesWith(I, NewInst);
1044 CleanupBinOp(I, A, B);
1045 return true;
1046 }
1047 // A^t + B ^t -> (A + B)^t. Pick rows and columns from first transpose. If
1048 // the shape of the second transpose is different, there's a shape conflict
1049 // which gets resolved by picking the shape of the first operand.
1050 else if (match(&I, m_FAdd(m_Value(A), m_Value(B))) &&
1052 m_Value(AT), m_ConstantInt(R), m_ConstantInt(C))) &&
1055 IRBuilder<> Builder(&I);
1056 auto *Add = Builder.CreateFAdd(AT, BT, "mfadd");
1057 MatrixBuilder MBuilder(Builder);
1058 Instruction *NewInst = MBuilder.CreateMatrixTranspose(
1059 Add, R->getZExtValue(), C->getZExtValue(), "mfadd_t");
1060 updateShapeAndReplaceAllUsesWith(I, NewInst);
1061 assert(computeShapeInfoForInst(NewInst, ShapeMap) ==
1062 computeShapeInfoForInst(&I, ShapeMap) &&
1063 "Shape of new instruction doesn't match original shape.");
1064 CleanupBinOp(I, A, B);
1065 if (auto *AddI = dyn_cast<Instruction>(Add)) {
1066 setShapeInfo(AddI, {R, C});
1067 assert(
1068 computeShapeInfoForInst(AddI, ShapeMap).value_or(ShapeMap[AddI]) ==
1069 ShapeMap[AddI] &&
1070 "Shape of updated addition doesn't match cached shape.");
1071 }
1072 return true;
1073 }
1074 return false;
1075 }
1076
1077 /// Try moving transposes in order to fold them away or into multiplies.
1078 bool optimizeTransposes() {
1079 bool Changed = false;
1080 // First sink all transposes inside matmuls and adds, hoping that we end up
1081 // with NN, NT or TN variants.
1082 for (BasicBlock &BB : reverse(Func)) {
1083 for (auto II = BB.rbegin(); II != BB.rend();) {
1084 Instruction &I = *II;
1085 // We may remove II. By default continue on the next/prev instruction.
1086 ++II;
1087 if (Instruction *NewInst = sinkTranspose(I, II, Changed))
1088 II = std::next(BasicBlock::reverse_iterator(NewInst));
1089 }
1090 }
1091
1092 // If we have a TT matmul or a TT add, lift the transpose. We may be able
1093 // to fold into consuming multiply or add.
1094 for (BasicBlock &BB : Func) {
1095 for (Instruction &I : llvm::make_early_inc_range(BB)) {
1096 Changed |= liftTranspose(I);
1097 }
1098 }
1099 return Changed;
1100 }
1101
1102 bool Visit() {
1104
1105 // Initially only the shape of matrix intrinsics is known.
1106 // Initialize the work list with ops carrying shape information.
1107 for (BasicBlock &BB : Func)
1108 for (Instruction &Inst : BB) {
1109 IntrinsicInst *II = dyn_cast<IntrinsicInst>(&Inst);
1110 if (!II)
1111 continue;
1112
1113 switch (II->getIntrinsicID()) {
1114 case Intrinsic::matrix_multiply:
1115 case Intrinsic::matrix_transpose:
1116 case Intrinsic::matrix_column_major_load:
1117 case Intrinsic::matrix_column_major_store:
1118 WorkList.push_back(&Inst);
1119 break;
1120 default:
1121 break;
1122 }
1123 }
1124
1125 // Avoid unnecessary work if there are no matrix intrinsics in the function.
1126 if (WorkList.empty())
1127 return false;
1128
1129 if (AM) {
1130 ORE = &AM->getResult<OptimizationRemarkEmitterAnalysis>(Func);
1131 AA = &AM->getResult<AAManager>(Func);
1132 DT = &AM->getResult<DominatorTreeAnalysis>(Func);
1133 LI = &AM->getResult<LoopAnalysis>(Func);
1134 }
1135
1136 // Propagate shapes until nothing changes any longer.
1137 while (!WorkList.empty()) {
1138 WorkList = propagateShapeForward(WorkList);
1139 WorkList = propagateShapeBackward(WorkList);
1140 }
1141
1142 bool Changed = false;
1143 if (!isMinimal()) {
1144 Changed |= optimizeTransposes();
1146 dbgs() << "Dump after matrix transpose optimization:\n";
1147 Func.print(dbgs());
1148 }
1149 }
1150
1151 SmallVector<CallInst *, 16> MaybeFusableInsts;
1152 SmallVector<Instruction *, 16> MatrixInsts;
1154
1155 // First, collect all instructions with shape information and candidates for
1156 // fusion (currently only matrix multiplies).
1157 ReversePostOrderTraversal<Function *> RPOT(&Func);
1158 for (auto *BB : RPOT)
1159 for (Instruction &I : *BB) {
1161 LifetimeEnds.push_back(cast<IntrinsicInst>(&I));
1162 if (!ShapeMap.contains(&I))
1163 continue;
1165 MaybeFusableInsts.push_back(cast<CallInst>(&I));
1166 MatrixInsts.push_back(&I);
1167 }
1168
1169 // Second, try to lower any dot products
1170 SmallPtrSet<Instruction *, 16> FusedInsts;
1171 for (CallInst *CI : MaybeFusableInsts)
1172 lowerDotProduct(CI, FusedInsts, getFastMathFlags(CI));
1173
1174 // Third, try to fuse candidates.
1175 for (CallInst *CI : MaybeFusableInsts)
1176 if (!FusedInsts.contains(CI))
1177 LowerMatrixMultiplyFused(CI, FusedInsts, LifetimeEnds);
1178
1179 Changed |= !FusedInsts.empty();
1180
1181 // Fourth, pre-process all the PHINode's. The incoming values will be
1182 // assigned later in VisitPHI.
1183 for (Instruction *Inst : MatrixInsts) {
1184 if (FusedInsts.count(Inst))
1185 continue;
1186
1187 auto *PHI = dyn_cast<PHINode>(Inst);
1188 if (!PHI)
1189 continue;
1190
1191 const ShapeInfo &SI = ShapeMap.at(Inst);
1192 auto *EltTy = cast<FixedVectorType>(PHI->getType())->getElementType();
1193 MatrixTy PhiM(SI.NumRows, SI.NumColumns, EltTy);
1194
1195 IRBuilder<> Builder(Inst);
1196 for (unsigned VI = 0, VE = PhiM.getNumVectors(); VI != VE; ++VI)
1197 PhiM.setVector(VI, Builder.CreatePHI(PhiM.getVectorTy(),
1198 PHI->getNumIncomingValues(),
1199 PHI->getName()));
1200 assert(!Inst2ColumnMatrix.contains(PHI) && "map already contains phi?");
1201 Inst2ColumnMatrix[PHI] = PhiM;
1202 }
1203
1204 // Fifth, lower remaining instructions with shape information.
1205 for (Instruction *Inst : MatrixInsts) {
1206 if (FusedInsts.count(Inst))
1207 continue;
1208
1209 const ShapeInfo &SI = ShapeMap.at(Inst);
1210
1211 Value *Op1;
1212 Value *Op2;
1213 MatrixTy Result;
1214 IRBuilder<> Builder(Inst);
1215 if (auto *BinOp = dyn_cast<BinaryOperator>(Inst))
1216 Result = VisitBinaryOperator(BinOp, SI, Builder);
1217 else if (auto *Cast = dyn_cast<CastInst>(Inst))
1218 Result = VisitCastInstruction(Cast, SI, Builder);
1219 else if (auto *UnOp = dyn_cast<UnaryOperator>(Inst))
1220 Result = VisitUnaryOperator(UnOp, SI, Builder);
1221 else if (auto *Intr = dyn_cast<IntrinsicInst>(Inst))
1222 Result = VisitIntrinsicInst(Intr, SI, Builder);
1223 else if (auto *Select = dyn_cast<SelectInst>(Inst))
1224 Result = VisitSelectInst(Select, SI, Builder);
1225 else if (match(Inst, m_Load(m_Value(Op1))))
1226 Result = VisitLoad(cast<LoadInst>(Inst), SI, Op1, Builder);
1227 else if (match(Inst, m_Store(m_Value(Op1), m_Value(Op2))))
1228 Result = VisitStore(cast<StoreInst>(Inst), SI, Op1, Op2, Builder);
1229 else if (auto *PHI = dyn_cast<PHINode>(Inst))
1230 Result = VisitPHI(PHI, SI, Builder);
1231 else
1232 continue;
1233
1234 finalizeLowering(Inst, Result, Builder);
1235 Changed = true;
1236 }
1237
1238 if (ORE) {
1239 RemarkGenerator RemarkGen(Inst2ColumnMatrix, *ORE, Func);
1240 RemarkGen.emitRemarks();
1241 }
1242
1243 // Delete the instructions backwards, as it has a reduced likelihood of
1244 // having to update as many def-use and use-def chains.
1245 //
1246 // Because we add to ToRemove during fusion we can't guarantee that defs
1247 // are before uses. Change uses to poison temporarily as these should get
1248 // removed as well.
1249 //
1250 // For verification, we keep track of where we changed uses to poison in
1251 // PoisonedInsts and then check that we in fact remove them.
1252 SmallPtrSet<Instruction *, 16> PoisonedInsts;
1253 for (auto *Inst : reverse(ToRemove)) {
1254 for (Use &U : llvm::make_early_inc_range(Inst->uses())) {
1255 if (auto *Poisoned = dyn_cast<Instruction>(U.getUser()))
1256 PoisonedInsts.insert(Poisoned);
1257 U.set(PoisonValue::get(Inst->getType()));
1258 }
1259 Inst->eraseFromParent();
1260 PoisonedInsts.erase(Inst);
1261 }
1262 if (!PoisonedInsts.empty()) {
1263 // If we didn't remove all poisoned instructions, it's a hard error.
1264 dbgs() << "Poisoned but present instructions:\n";
1265 for (auto *I : PoisonedInsts)
1266 dbgs() << *I << "\n";
1267 llvm_unreachable("Poisoned but instruction not removed");
1268 }
1269
1270 return Changed;
1271 }
1272
1273 /// Replace intrinsic calls.
1274 MatrixTy VisitIntrinsicInst(IntrinsicInst *Inst, const ShapeInfo &SI,
1275 IRBuilder<> &Builder) {
1276 assert(Inst->getCalledFunction() &&
1277 Inst->getCalledFunction()->isIntrinsic());
1278
1279 switch (Inst->getCalledFunction()->getIntrinsicID()) {
1280 case Intrinsic::matrix_multiply:
1281 return LowerMultiply(Inst, Builder);
1282 case Intrinsic::matrix_transpose:
1283 return LowerTranspose(Inst, Builder);
1284 case Intrinsic::matrix_column_major_load:
1285 return LowerColumnMajorLoad(Inst, Builder);
1286 case Intrinsic::matrix_column_major_store:
1287 return LowerColumnMajorStore(Inst, Builder);
1288 case Intrinsic::abs:
1289 case Intrinsic::fabs: {
1290 MatrixTy Result;
1291 MatrixTy M = getMatrix(Inst->getOperand(0), SI, Builder);
1292 Builder.setFastMathFlags(getFastMathFlags(Inst));
1293
1294 for (auto *Vector : M.vectors()) {
1295 switch (Inst->getIntrinsicID()) {
1296 case Intrinsic::abs:
1297 Result.addVector(Builder.CreateBinaryIntrinsic(Intrinsic::abs, Vector,
1298 Inst->getOperand(1)));
1299 continue;
1300 case Intrinsic::fabs:
1301 Result.addVector(
1302 Builder.CreateUnaryIntrinsic(Inst->getIntrinsicID(), Vector));
1303 continue;
1304 default:
1305 llvm_unreachable("unexpected intrinsic");
1306 }
1307 }
1308
1309 return Result.addNumComputeOps(getNumOps(Result.getVectorTy()) *
1310 Result.getNumVectors());
1311 }
1312 default:
1313 break;
1314 }
1316 "only intrinsics supporting shape info should be seen here");
1317 }
1318
1319 /// Compute the alignment for a column/row \p Idx with \p Stride between them.
1320 /// The address at \p Idx == 0 has alignment \p A. If \p Stride is a
1321 /// ConstantInt, reduce the initial alignment based on the byte offset. For
1322 /// non-ConstantInt strides, return the common alignment of the initial
1323 /// alignment and the element size in bytes.
1324 Align getAlignForIndex(unsigned Idx, Value *Stride, Type *ElementTy,
1325 MaybeAlign A) const {
1326 Align InitialAlign = DL.getValueOrABITypeAlignment(A, ElementTy);
1327 if (Idx == 0)
1328 return InitialAlign;
1329
1330 TypeSize ElementSizeInBits = DL.getTypeSizeInBits(ElementTy);
1331 if (auto *ConstStride = dyn_cast<ConstantInt>(Stride)) {
1332 uint64_t StrideInBytes =
1333 ConstStride->getZExtValue() * ElementSizeInBits / 8;
1334 return commonAlignment(InitialAlign, Idx * StrideInBytes);
1335 }
1336 return commonAlignment(InitialAlign, ElementSizeInBits / 8);
1337 }
1338
1339 IntegerType *getIndexType(Value *Ptr) const {
1340 return cast<IntegerType>(DL.getIndexType(Ptr->getType()));
1341 }
1342
1343 Value *getIndex(Value *Ptr, uint64_t V) const {
1344 return ConstantInt::get(getIndexType(Ptr), V);
1345 }
1346
1347 Value *castToIndexType(Value *Ptr, Value *V, IRBuilder<> &Builder) const {
1348 assert(isa<IntegerType>(V->getType()) &&
1349 "Attempted to cast non-integral type to integer index");
1350 // In case the data layout's index type differs in width from the type of
1351 // the value we're given, truncate or zero extend to the appropriate width.
1352 // We zero extend here as indices are unsigned.
1353 return Builder.CreateZExtOrTrunc(V, getIndexType(Ptr),
1354 V->getName() + ".cast");
1355 }
1356
1357 /// Load a matrix with \p Shape starting at \p Ptr and using \p Stride between
1358 /// vectors.
1359 MatrixTy loadMatrix(Type *Ty, Value *Ptr, MaybeAlign MAlign, Value *Stride,
1360 bool IsVolatile, ShapeInfo Shape, IRBuilder<> &Builder) {
1361 auto *VType = cast<FixedVectorType>(Ty);
1362 Type *EltTy = VType->getElementType();
1363 Type *VecTy = FixedVectorType::get(EltTy, Shape.getStride());
1364 Value *EltPtr = Ptr;
1365 MatrixTy Result;
1366 Stride = castToIndexType(Ptr, Stride, Builder);
1367 for (unsigned I = 0, E = Shape.getNumVectors(); I < E; ++I) {
1369 EltPtr, Builder.getIntN(Stride->getType()->getScalarSizeInBits(), I),
1370 Stride, Shape.getStride(), EltTy, Builder);
1371 Value *Vector = Builder.CreateAlignedLoad(
1372 VecTy, GEP, getAlignForIndex(I, Stride, EltTy, MAlign),
1373 IsVolatile, "col.load");
1374
1375 Result.addVector(Vector);
1376 }
1377 return Result.addNumLoads(getNumOps(Result.getVectorTy()) *
1378 Result.getNumVectors());
1379 }
1380
1381 /// Loads a sub-matrix with shape \p ResultShape from a \p R x \p C matrix,
1382 /// starting at \p MatrixPtr[I][J].
1383 MatrixTy loadMatrix(Value *MatrixPtr, MaybeAlign Align, bool IsVolatile,
1384 ShapeInfo MatrixShape, Value *I, Value *J,
1385 ShapeInfo ResultShape, Type *EltTy,
1386 IRBuilder<> &Builder) {
1387 Value *Offset = Builder.CreateAdd(
1388 Builder.CreateMul(J, getIndex(MatrixPtr, MatrixShape.getStride())), I);
1389
1390 Value *TileStart = Builder.CreateGEP(EltTy, MatrixPtr, Offset);
1391 auto *TileTy = FixedVectorType::get(EltTy, ResultShape.NumRows *
1392 ResultShape.NumColumns);
1393
1394 return loadMatrix(TileTy, TileStart, Align,
1395 getIndex(MatrixPtr, MatrixShape.getStride()), IsVolatile,
1396 ResultShape, Builder);
1397 }
1398
1399 /// Lower a load instruction with shape information.
1400 MatrixTy LowerLoad(Instruction *Inst, Value *Ptr, MaybeAlign Align,
1401 Value *Stride, bool IsVolatile, ShapeInfo Shape,
1402 IRBuilder<> &Builder) {
1403 return loadMatrix(Inst->getType(), Ptr, Align, Stride, IsVolatile, Shape,
1404 Builder);
1405 }
1406
1407 /// Lowers llvm.matrix.column.major.load.
1408 ///
1409 /// The intrinsic loads a matrix from memory using a stride between columns.
1410 MatrixTy LowerColumnMajorLoad(CallInst *Inst, IRBuilder<> &Builder) {
1412 "Intrinsic only supports column-major layout!");
1413 Value *Ptr = Inst->getArgOperand(0);
1414 Value *Stride = Inst->getArgOperand(1);
1415 return LowerLoad(Inst, Ptr, Inst->getParamAlign(0), Stride,
1416 cast<ConstantInt>(Inst->getArgOperand(2))->isOne(),
1417 {Inst->getArgOperand(3), Inst->getArgOperand(4)}, Builder);
1418 }
1419
1420 /// Stores a sub-matrix \p StoreVal into the \p R x \p C matrix starting at \p
1421 /// MatrixPtr[I][J].
1422 void storeMatrix(const MatrixTy &StoreVal, Value *MatrixPtr,
1423 MaybeAlign MAlign, bool IsVolatile, ShapeInfo MatrixShape,
1424 Value *I, Value *J, Type *EltTy, IRBuilder<> &Builder) {
1425 Value *Offset = Builder.CreateAdd(
1426 Builder.CreateMul(J, getIndex(MatrixPtr, MatrixShape.getStride())), I);
1427
1428 Value *TileStart = Builder.CreateGEP(EltTy, MatrixPtr, Offset);
1429 auto *TileTy = FixedVectorType::get(EltTy, StoreVal.getNumRows() *
1430 StoreVal.getNumColumns());
1431
1432 storeMatrix(TileTy, StoreVal, TileStart, MAlign,
1433 getIndex(MatrixPtr, MatrixShape.getStride()), IsVolatile,
1434 Builder);
1435 }
1436
1437 /// Store matrix \p StoreVal starting at \p Ptr and using \p Stride between
1438 /// vectors.
1439 MatrixTy storeMatrix(Type *Ty, MatrixTy StoreVal, Value *Ptr,
1440 MaybeAlign MAlign, Value *Stride, bool IsVolatile,
1441 IRBuilder<> &Builder) {
1442 auto *VType = cast<FixedVectorType>(Ty);
1443 Value *EltPtr = Ptr;
1444 Stride = castToIndexType(Ptr, Stride, Builder);
1445 for (auto Vec : enumerate(StoreVal.vectors())) {
1447 EltPtr,
1448 Builder.getIntN(Stride->getType()->getScalarSizeInBits(),
1449 Vec.index()),
1450 Stride, StoreVal.getStride(), VType->getElementType(), Builder);
1451 Builder.CreateAlignedStore(Vec.value(), GEP,
1452 getAlignForIndex(Vec.index(), Stride,
1453 VType->getElementType(),
1454 MAlign),
1455 IsVolatile);
1456 }
1457 return MatrixTy().addNumStores(getNumOps(StoreVal.getVectorTy()) *
1458 StoreVal.getNumVectors());
1459 }
1460
1461 /// Lower a store instruction with shape information.
1462 MatrixTy LowerStore(Instruction *Inst, Value *Matrix, Value *Ptr,
1463 MaybeAlign A, Value *Stride, bool IsVolatile,
1464 ShapeInfo Shape, IRBuilder<> &Builder) {
1465 auto StoreVal = getMatrix(Matrix, Shape, Builder);
1466 return storeMatrix(Matrix->getType(), StoreVal, Ptr, A, Stride, IsVolatile,
1467 Builder);
1468 }
1469
1470 /// Lowers llvm.matrix.column.major.store.
1471 ///
1472 /// The intrinsic store a matrix back memory using a stride between columns.
1473 MatrixTy LowerColumnMajorStore(CallInst *Inst, IRBuilder<> &Builder) {
1475 "Intrinsic only supports column-major layout!");
1476 Value *Matrix = Inst->getArgOperand(0);
1477 Value *Ptr = Inst->getArgOperand(1);
1478 Value *Stride = Inst->getArgOperand(2);
1479 return LowerStore(Inst, Matrix, Ptr, Inst->getParamAlign(1), Stride,
1480 cast<ConstantInt>(Inst->getArgOperand(3))->isOne(),
1481 {Inst->getArgOperand(4), Inst->getArgOperand(5)},
1482 Builder);
1483 }
1484
1485 // Set elements I..I+NumElts-1 to Block
1486 Value *insertVector(Value *Col, unsigned I, Value *Block,
1487 IRBuilder<> &Builder) {
1488
1489 // First, bring Block to the same size as Col
1490 unsigned BlockNumElts =
1491 cast<FixedVectorType>(Block->getType())->getNumElements();
1492 unsigned NumElts = cast<FixedVectorType>(Col->getType())->getNumElements();
1493 assert(NumElts >= BlockNumElts && "Too few elements for current block");
1494
1495 Block = Builder.CreateShuffleVector(
1496 Block, createSequentialMask(0, BlockNumElts, NumElts - BlockNumElts));
1497
1498 // If Col is 7 long and I is 2 and BlockNumElts is 2 the mask is: 0, 1, 7,
1499 // 8, 4, 5, 6
1500 SmallVector<int, 16> Mask;
1501 unsigned i;
1502 for (i = 0; i < I; i++)
1503 Mask.push_back(i);
1504
1505 unsigned VecNumElts =
1506 cast<FixedVectorType>(Col->getType())->getNumElements();
1507 for (; i < I + BlockNumElts; i++)
1508 Mask.push_back(i - I + VecNumElts);
1509
1510 for (; i < VecNumElts; i++)
1511 Mask.push_back(i);
1512
1513 return Builder.CreateShuffleVector(Col, Block, Mask);
1514 }
1515
1516 Value *createMulAdd(Value *Sum, Value *A, Value *B, bool UseFPOp,
1517 IRBuilder<> &Builder, bool AllowContraction,
1518 unsigned &NumComputeOps) {
1519 NumComputeOps += getNumOps(A->getType());
1520 if (!Sum)
1521 return UseFPOp ? Builder.CreateFMul(A, B) : Builder.CreateMul(A, B);
1522
1523 if (UseFPOp) {
1524 if (AllowContraction) {
1525 // Use fmuladd for floating point operations and let the backend decide
1526 // if that's profitable.
1527 return Builder.CreateIntrinsic(Intrinsic::fmuladd, A->getType(),
1528 {A, B, Sum});
1529 }
1530 NumComputeOps += getNumOps(A->getType());
1531 Value *Mul = Builder.CreateFMul(A, B);
1532 return Builder.CreateFAdd(Sum, Mul);
1533 }
1534
1535 NumComputeOps += getNumOps(A->getType());
1536 Value *Mul = Builder.CreateMul(A, B);
1537 return Builder.CreateAdd(Sum, Mul);
1538 }
1539
1540 /// Cache \p Matrix as result of \p Inst and update the uses of \p Inst. For
1541 /// users with shape information, there's nothing to do: they will use the
1542 /// cached value when they are lowered. For other users, \p Matrix is
1543 /// flattened and the uses are updated to use it. Also marks \p Inst for
1544 /// deletion.
1545 void finalizeLowering(Instruction *Inst, MatrixTy Matrix,
1546 IRBuilder<> &Builder) {
1547 auto inserted = Inst2ColumnMatrix.insert(std::make_pair(Inst, Matrix));
1548 (void)inserted;
1549 assert((inserted.second || isa<PHINode>(Inst)) &&
1550 "multiple matrix lowering mapping");
1551
1552 ToRemove.push_back(Inst);
1553 Value *Flattened = nullptr;
1554 for (Use &U : llvm::make_early_inc_range(Inst->uses())) {
1555 if (ShapeMap.contains(U.getUser()))
1556 continue;
1557
1558 if (!Flattened) {
1559 Flattened = Matrix.embedInVector(Builder);
1560 LLVM_DEBUG(
1561 if (Instruction *User = dyn_cast<Instruction>(U.getUser())) dbgs()
1562 << "flattening a " << Matrix.shape() << " matrix:\n"
1563 << *Inst
1564 << "\nbecause we do not have a shape-aware lowering for its "
1565 "user:\n"
1566 << *User << '\n';);
1567 FlattenedMatrices++;
1568 }
1569 U.set(Flattened);
1570 }
1571 }
1572
1573 /// Special case for MatMul lowering. Prevents scalar loads of row-major
1574 /// vectors Lowers to vector reduction add instead of sequential add if
1575 /// reassocation is enabled.
1576 void lowerDotProduct(CallInst *MatMul,
1577 SmallPtrSet<Instruction *, 16> &FusedInsts,
1578 FastMathFlags FMF) {
1579 if (FusedInsts.contains(MatMul) ||
1581 return;
1582 ShapeInfo LShape(MatMul->getArgOperand(2), MatMul->getArgOperand(3));
1583 ShapeInfo RShape(MatMul->getArgOperand(3), MatMul->getArgOperand(4));
1584
1585 if (LShape.NumRows != 1 || RShape.NumColumns != 1) // not a dot product
1586 return;
1587
1588 Value *LHS = MatMul->getArgOperand(0);
1589 Value *RHS = MatMul->getArgOperand(1);
1590
1591 Type *ElementType = cast<FixedVectorType>(LHS->getType())->getElementType();
1592 bool IsIntVec = ElementType->isIntegerTy();
1593
1594 // Floating point reductions require reassocation.
1595 if (!IsIntVec && !FMF.allowReassoc())
1596 return;
1597
1598 auto CanBeFlattened = [](Value *Op) {
1599 if (match(Op, m_BinOp()))
1600 return true;
1601 return match(
1603 m_Load(m_Value()),
1606 m_Value(), m_SpecificInt(1))))));
1607 };
1608 // Returns the cost benefit of using \p Op with the dot product lowering. If
1609 // the returned cost is < 0, the argument is cheaper to use in the
1610 // dot-product lowering.
1611 auto GetCostForArg = [this, &CanBeFlattened](Value *Op, unsigned N) {
1612 if (!ShapeMap.contains(Op))
1613 return InstructionCost::getInvalid();
1614
1615 if (!isa<Instruction>(Op))
1616 return InstructionCost(0);
1617
1618 FixedVectorType *VecTy = cast<FixedVectorType>(Op->getType());
1619 Type *EltTy = VecTy->getElementType();
1620
1621 if (!CanBeFlattened(Op)) {
1622 InstructionCost EmbedCost(0);
1623 // Roughly estimate the cost for embedding the columns into a vector.
1624 for (unsigned I = 1; I < N; ++I)
1625 EmbedCost += TTI.getShuffleCost(
1628 return EmbedCost;
1629 }
1630
1631 if (match(Op, m_BinOp()) && ShapeMap.contains(Op)) {
1632 InstructionCost OriginalCost =
1633 TTI.getArithmeticInstrCost(cast<Instruction>(Op)->getOpcode(),
1634 EltTy) *
1635 N;
1636 InstructionCost NewCost = TTI.getArithmeticInstrCost(
1637 cast<Instruction>(Op)->getOpcode(), VecTy);
1638 return NewCost - OriginalCost;
1639 }
1640
1642 // The transpose can be skipped for the dot product lowering, roughly
1643 // estimate the savings as the cost of embedding the columns in a
1644 // vector.
1645 InstructionCost EmbedCost(0);
1646 for (unsigned I = 1; I < N; ++I)
1647 EmbedCost -= TTI.getShuffleCost(
1650 return EmbedCost;
1651 }
1652
1653 // Costs for loads.
1654 if (N == 1)
1655 return InstructionCost(0);
1656
1657 return TTI.getMemoryOpCost(Instruction::Load, VecTy, Align(1), 0) -
1658 N * TTI.getMemoryOpCost(Instruction::Load, EltTy, Align(1), 0);
1659 };
1660
1661 // Iterate over LHS and operations feeding LHS and check if it is profitable
1662 // to flatten the visited ops. For each op, we compute the difference
1663 // between the flattened and matrix versions.
1664 SmallPtrSet<Value *, 4> Seen;
1665 SmallVector<Value *> WorkList;
1666 SmallVector<Value *> ToFlatten;
1667 WorkList.push_back(LHS);
1668 InstructionCost LHSCost(0);
1669 while (!WorkList.empty()) {
1670 Value *Op = WorkList.pop_back_val();
1671 if (!Seen.insert(Op).second)
1672 continue;
1673
1674 InstructionCost OpCost = GetCostForArg(Op, LShape.NumColumns);
1675 if (OpCost + LHSCost >= LHSCost)
1676 continue;
1677
1678 LHSCost += OpCost;
1679 ToFlatten.push_back(Op);
1680 if (auto *I = dyn_cast<Instruction>(Op))
1681 WorkList.append(I->op_begin(), I->op_end());
1682 }
1683
1684 // We compare the costs of a vector.reduce.add to sequential add.
1685 int AddOpCode = IsIntVec ? Instruction::Add : Instruction::FAdd;
1686 int MulOpCode = IsIntVec ? Instruction::Mul : Instruction::FMul;
1687 InstructionCost ReductionCost =
1688 TTI.getArithmeticReductionCost(
1689 AddOpCode, cast<FixedVectorType>(LHS->getType()),
1690 IsIntVec ? std::nullopt : std::optional(FMF)) +
1691 TTI.getArithmeticInstrCost(MulOpCode, LHS->getType());
1692 InstructionCost SequentialAddCost =
1693 TTI.getArithmeticInstrCost(AddOpCode, ElementType) *
1694 (LShape.NumColumns - 1) +
1695 TTI.getArithmeticInstrCost(MulOpCode, ElementType) *
1696 (LShape.NumColumns);
1697 if ((LHSCost + ReductionCost - SequentialAddCost) > InstructionCost(0))
1698 return;
1699
1700 FusedInsts.insert(MatMul);
1701 IRBuilder<> Builder(MatMul);
1702 auto FlattenArg = [&Builder, &FusedInsts, &CanBeFlattened,
1703 this](Value *Op) {
1704 // Matmul must be the only user of loads because we don't use LowerLoad
1705 // for row vectors (LowerLoad results in scalar loads and shufflevectors
1706 // instead of single vector load).
1707 if (!CanBeFlattened(Op))
1708 return;
1709
1710 if (match(Op, m_BinOp())) {
1711 auto It = ShapeMap.find(Op);
1712 if (It != ShapeMap.end()) {
1713 It->second = It->second.t();
1714 return;
1715 }
1716 }
1717
1718 FusedInsts.insert(cast<Instruction>(Op));
1719 // If vector uses the builtin load, lower to a LoadInst
1720 Value *Arg;
1722 m_Value(Arg)))) {
1723 auto *NewLoad = Builder.CreateLoad(Op->getType(), Arg);
1724 Op->replaceAllUsesWith(NewLoad);
1725 eraseFromParentAndRemoveFromShapeMap(cast<Instruction>(Op));
1726 return;
1728 m_Value(Arg)))) {
1729 ToRemove.push_back(cast<Instruction>(Op));
1730 Op->replaceAllUsesWith(Arg);
1731 return;
1732 }
1733 };
1734
1735 for (auto *V : ToFlatten)
1736 FlattenArg(V);
1737
1738 LHS = MatMul->getArgOperand(0);
1739
1740 // Insert mul/fmul and llvm.vector.reduce.fadd
1741 Value *Mul =
1742 IsIntVec ? Builder.CreateMul(LHS, RHS) : Builder.CreateFMul(LHS, RHS);
1743
1744 Value *Result;
1745 if (IsIntVec)
1746 Result = Builder.CreateAddReduce(Mul);
1747 else {
1748 Result = Builder.CreateFAddReduce(
1749 ConstantFP::get(
1750 cast<FixedVectorType>(LHS->getType())->getElementType(), 0.0),
1751 Mul);
1752 cast<Instruction>(Result)->setFastMathFlags(FMF);
1753 }
1754
1755 // pack scalar back into a matrix and then replace matmul inst
1757 Result, uint64_t(0));
1758 MatMul->replaceAllUsesWith(Result);
1759 FusedInsts.insert(MatMul);
1760 ToRemove.push_back(MatMul);
1761 }
1762
1763 /// Given \p Remainder iterations of the the matmul inner loop,
1764 /// potentially lower \p Blocksize that is used for the underlying
1765 /// vector.
1766 unsigned capBlockSize(unsigned BlockSize, unsigned Remainder, Type *EltType) {
1767 if (BlockSize <= Remainder)
1768 return BlockSize;
1769
1770 // If the remainder is also a legal type just use it.
1771 auto *VecTy = FixedVectorType::get(EltType, Remainder);
1772 if (TTI.isTypeLegal(VecTy))
1773 return Remainder;
1774
1775 // Similarly, if the vector is small enough that we don't want
1776 // to split further.
1778 return Remainder;
1779
1780 // Gradually lower the vectorization factor to cover the
1781 // remainder.
1782 do {
1783 BlockSize /= 2;
1784 } while (BlockSize > Remainder);
1785 return BlockSize;
1786 }
1787
1788 /// Compute \p Result += \p A * \p B for input matrices with left-associating
1789 /// addition.
1790 ///
1791 /// We can fold a transpose into the operand that is used to extract scalars.
1792 /// This is the first operands with row-major and the second with
1793 /// column-major. If \p IsScalarMatrixTransposed we assume the appropriate
1794 /// operand is transposed.
1795 void emitMatrixMultiply(MatrixTy &Result, const MatrixTy &A,
1796 const MatrixTy &B, IRBuilder<> &Builder, bool IsTiled,
1797 bool IsScalarMatrixTransposed, FastMathFlags FMF) {
1798 const unsigned VF = std::max<unsigned>(
1799 TTI.getRegisterBitWidth(TargetTransformInfo::RGK_FixedWidthVector)
1800 .getFixedValue() /
1801 Result.getElementType()->getPrimitiveSizeInBits().getFixedValue(),
1802 1U);
1803 unsigned R = Result.getNumRows();
1804 unsigned C = Result.getNumColumns();
1805 unsigned M = A.getNumColumns();
1806
1807 bool IsFP = Result.getElementType()->isFloatingPointTy();
1808 assert(A.isColumnMajor() == B.isColumnMajor() &&
1809 Result.isColumnMajor() == A.isColumnMajor() &&
1810 "operands must agree on matrix layout");
1811 unsigned NumComputeOps = 0;
1812
1813 Builder.setFastMathFlags(FMF);
1814
1815 if (A.isColumnMajor()) {
1816 // Multiply columns from the first operand with scalars from the second
1817 // operand. Then move along the K axes and accumulate the columns. With
1818 // this the adds can be vectorized without reassociation.
1819 for (unsigned J = 0; J < C; ++J) {
1820 unsigned BlockSize = VF;
1821 // If Result is zero, we don't need to accumulate in the K==0 iteration.
1822 bool isSumZero = isa<ConstantAggregateZero>(Result.getColumn(J));
1823
1824 for (unsigned I = 0; I < R; I += BlockSize) {
1825 // Lower block size to make sure we stay within bounds.
1826 BlockSize = capBlockSize(BlockSize, R - I, Result.getElementType());
1827 Value *Sum = IsTiled ? Result.extractVector(I, J, BlockSize, Builder)
1828 : nullptr;
1829 for (unsigned K = 0; K < M; ++K) {
1830 Value *L = A.extractVector(I, K, BlockSize, Builder);
1831 Value *RH = Builder.CreateExtractElement(
1832 B.getColumn(IsScalarMatrixTransposed ? K : J),
1833 IsScalarMatrixTransposed ? J : K);
1834 Value *Splat = Builder.CreateVectorSplat(BlockSize, RH, "splat");
1835 Sum =
1836 createMulAdd(isSumZero && K == 0 ? nullptr : Sum, L, Splat,
1837 IsFP, Builder, FMF.allowContract(), NumComputeOps);
1838 }
1839 Result.setVector(J,
1840 insertVector(Result.getVector(J), I, Sum, Builder));
1841 }
1842 }
1843 } else {
1844 // Multiply rows from the second operand with scalars from the first
1845 // operand. Then move along the K axes and accumulate the rows. With this
1846 // the adds can be vectorized without reassociation.
1847 for (unsigned I = 0; I < R; ++I) {
1848 unsigned BlockSize = VF;
1849 bool isSumZero = isa<ConstantAggregateZero>(Result.getRow(I));
1850 for (unsigned J = 0; J < C; J += BlockSize) {
1851 // Lower the vectorization factor to cover the remainder.
1852 BlockSize = capBlockSize(BlockSize, C - J, Result.getElementType());
1853
1854 Value *Sum = nullptr;
1855 for (unsigned K = 0; K < M; ++K) {
1856 Value *R = B.extractVector(K, J, BlockSize, Builder);
1857 Value *LH = Builder.CreateExtractElement(
1858 A.getVector(IsScalarMatrixTransposed ? K : I),
1859 IsScalarMatrixTransposed ? I : K);
1860 Value *Splat = Builder.CreateVectorSplat(BlockSize, LH, "splat");
1861 Sum =
1862 createMulAdd(isSumZero && K == 0 ? nullptr : Sum, Splat, R,
1863 IsFP, Builder, FMF.allowContract(), NumComputeOps);
1864 }
1865 Result.setVector(I,
1866 insertVector(Result.getVector(I), J, Sum, Builder));
1867 }
1868 }
1869 }
1870 Result.addNumComputeOps(NumComputeOps);
1871 }
1872
1873 /// Ensure that the memory in \p Load does not alias \p Store by potentially
1874 /// copying it to a new location. This new or otherwise the original location
1875 /// is returned.
1876 Value *getNonAliasingPointer(LoadInst *Load, StoreInst *Store,
1877 CallInst *MatMul) {
1878 MemoryLocation StoreLoc = MemoryLocation::get(Store);
1879 MemoryLocation LoadLoc = MemoryLocation::get(Load);
1880
1881 // If we can statically determine noalias we're good.
1882 if (AA->isNoAlias(LoadLoc, StoreLoc))
1883 return Load->getPointerOperand();
1884
1885 // If the pointers are in different address spaces, we cannot compare them
1886 // at runtime. Conservatively copy the load operand to a new buffer.
1887 if (Load->getPointerAddressSpace() != Store->getPointerAddressSpace()) {
1888 IRBuilder<> Builder(MatMul);
1889 auto *VT = cast<FixedVectorType>(Load->getType());
1890 auto *ArrayTy =
1891 ArrayType::get(VT->getElementType(), VT->getNumElements());
1892 AllocaInst *Alloca =
1893 Builder.CreateAlloca(ArrayTy, Load->getPointerAddressSpace());
1894 Builder.CreateMemCpy(Alloca, Alloca->getAlign(),
1895 Load->getPointerOperand(), Load->getAlign(),
1896 LoadLoc.Size.getValue());
1897 return Alloca;
1898 }
1899
1900 // Create code to check if the memory locations of the Load and Store
1901 // overlap and if they do, copy Load's operand to a new buffer.
1902
1903 // First, create new blocks for 2n part of the check and the copy.
1904 BasicBlock *Check0 = MatMul->getParent();
1905 // FIXME: Use lazy DTU and update SplitBlock to accept a DTU instead of a
1906 // DT. Manually collect dominator tree updates, to avoid unnecessary work,
1907 // as we adjust Check0 and Check1's branches.
1909 for (BasicBlock *Succ : successors(Check0))
1910 DTUpdates.push_back({DT->Delete, Check0, Succ});
1911
1912 BasicBlock *Check1 =
1913 SplitBlock(MatMul->getParent(), MatMul, (DomTreeUpdater *)nullptr, LI,
1914 nullptr, "alias_cont");
1915 BasicBlock *Copy =
1916 SplitBlock(MatMul->getParent(), MatMul, (DomTreeUpdater *)nullptr, LI,
1917 nullptr, "copy");
1918 BasicBlock *Fusion =
1919 SplitBlock(MatMul->getParent(), MatMul, (DomTreeUpdater *)nullptr, LI,
1920 nullptr, "no_alias");
1921
1922 // Check if the loaded memory location begins before the end of the store
1923 // location. If the condition holds, they might overlap, otherwise they are
1924 // guaranteed to not overlap.
1925 IRBuilder<> Builder(MatMul);
1926 Check0->getTerminator()->eraseFromParent();
1927 Builder.SetInsertPoint(Check0);
1928 Type *AddrTy = DL.getAddressType(Store->getPointerOperand()->getType());
1929 Value *StoreBegin = Store->getPointerOperand();
1930 Value *StoreEnd = Builder.CreatePtrAdd(
1931 StoreBegin, ConstantInt::get(AddrTy, StoreLoc.Size.getValue()),
1932 "store.end",
1934 Value *LoadBegin = Load->getPointerOperand();
1935 CondBrInst *BR1 = Builder.CreateCondBr(
1936 Builder.CreateICmpULT(LoadBegin, StoreEnd), Check1, Fusion);
1938
1939 // Check if the store begins before the end of the load location. If the
1940 // condition holds, they alias, otherwise they are guaranteed to not
1941 // overlap.
1942 Check1->getTerminator()->eraseFromParent();
1943 Builder.SetInsertPoint(Check1, Check1->begin());
1944 Value *LoadEnd = Builder.CreatePtrAdd(
1945 LoadBegin, ConstantInt::get(AddrTy, LoadLoc.Size.getValue()),
1946 "load.end",
1948 CondBrInst *BR2 = Builder.CreateCondBr(
1949 Builder.CreateICmpULT(StoreBegin, LoadEnd), Copy, Fusion);
1951
1952 // Copy load operand to new alloca.
1953 Builder.SetInsertPoint(Copy, Copy->begin());
1954 auto *VT = cast<FixedVectorType>(Load->getType());
1955 // Use an array type for the alloca, to avoid potentially huge alignment
1956 // requirements for large vector types.
1957 auto *ArrayTy = ArrayType::get(VT->getElementType(), VT->getNumElements());
1958 AllocaInst *Alloca =
1959 Builder.CreateAlloca(ArrayTy, Load->getPointerAddressSpace());
1960
1961 Builder.CreateMemCpy(Alloca, Alloca->getAlign(), Load->getPointerOperand(),
1962 Load->getAlign(), LoadLoc.Size.getValue());
1963 Builder.SetInsertPoint(Fusion, Fusion->begin());
1964 PHINode *PHI = Builder.CreatePHI(Load->getPointerOperandType(), 3);
1965 PHI->addIncoming(Load->getPointerOperand(), Check0);
1966 PHI->addIncoming(Load->getPointerOperand(), Check1);
1967 PHI->addIncoming(Alloca, Copy);
1968
1969 // Adjust DT.
1970 DTUpdates.push_back({DT->Insert, Check0, Check1});
1971 DTUpdates.push_back({DT->Insert, Check0, Fusion});
1972 DTUpdates.push_back({DT->Insert, Check1, Copy});
1973 DTUpdates.push_back({DT->Insert, Check1, Fusion});
1974 DT->applyUpdates(DTUpdates);
1975 return PHI;
1976 }
1977
1978 bool isFusionProfitable(CallInst *MatMul) {
1979 if (ForceFusion)
1980 return true;
1981
1982 ShapeInfo LShape(MatMul->getArgOperand(2), MatMul->getArgOperand(3));
1983 ShapeInfo RShape(MatMul->getArgOperand(3), MatMul->getArgOperand(4));
1984
1985 const unsigned R = LShape.NumRows;
1986 const unsigned C = RShape.NumColumns;
1987 const unsigned M = LShape.NumColumns;
1988 auto *EltType = cast<FixedVectorType>(MatMul->getType())->getElementType();
1989
1990 const unsigned VF = std::max<unsigned>(
1991 TTI.getRegisterBitWidth(TargetTransformInfo::RGK_FixedWidthVector)
1992 .getFixedValue() /
1994 1U);
1995
1996 // Cost model for tiling
1997 //
1998 // For tiling to be beneficial, we need reuse either along the R or
1999 // the C axis. We vectorize along the R axis so that means at least
2000 // 3 elements.
2001 // TODO: Also consider cost of copying if operands alias.
2002 if (R <= VF && C == 1)
2003 return false;
2004 // Then we need enough elements to exceed the number of vector
2005 // registers we have. Note that this is an oversimplification since
2006 // fusing also takes some extra loads which may exceed the number of
2007 // reloads necessary.
2008 unsigned Op0Regs = (R + VF - 1) / VF * M;
2009 unsigned Op1Regs = (M + VF - 1) / VF * C;
2010 return Op0Regs + Op1Regs >
2011 TTI.getNumberOfRegisters(TTI.getRegisterClassForType(true));
2012 }
2013
2014 MatrixTy getZeroMatrix(Type *EltType, unsigned R, unsigned C) {
2015 MatrixTy Res;
2016 auto *ColumType = FixedVectorType::get(EltType, R);
2017 for (unsigned I = 0; I < C; ++I)
2018 Res.addVector(ConstantAggregateZero::get(ColumType));
2019 return Res;
2020 }
2021
2022 void createTiledLoops(CallInst *MatMul, Value *LPtr, ShapeInfo LShape,
2023 Value *RPtr, ShapeInfo RShape, StoreInst *Store) {
2024 auto *EltType = cast<FixedVectorType>(MatMul->getType())->getElementType();
2025
2026 // Create the main tiling loop nest.
2027 TileInfo TI(LShape.NumRows, RShape.NumColumns, LShape.NumColumns, TileSize);
2028 DomTreeUpdater DTU(DT, DomTreeUpdater::UpdateStrategy::Lazy);
2029 Instruction *InsertI = cast<Instruction>(MatMul);
2030 BasicBlock *Start = InsertI->getParent();
2031 BasicBlock *End =
2032 SplitBlock(InsertI->getParent(), InsertI, DT, LI, nullptr, "continue");
2033 IRBuilder<> Builder(MatMul);
2034 BasicBlock *InnerBody = TI.CreateTiledLoops(Start, End, Builder, DTU, *LI);
2035
2036 Type *TileVecTy =
2038 MatrixTy TileResult;
2039 // Insert in the inner loop header.
2040 Builder.SetInsertPoint(TI.KLoop.Header->getTerminator());
2041 // Create PHI nodes for the result columns to accumulate across iterations.
2042 SmallVector<PHINode *, 4> ColumnPhis;
2043 for (unsigned I = 0; I < TileSize; I++) {
2044 auto *Phi = Builder.CreatePHI(TileVecTy, 2, "result.vec." + Twine(I));
2045 Phi->addIncoming(ConstantAggregateZero::get(TileVecTy),
2046 TI.RowLoop.Header->getSingleSuccessor());
2047 TileResult.addVector(Phi);
2048 ColumnPhis.push_back(Phi);
2049 }
2050
2051 // Insert in the inner loop body, which computes
2052 // Res += Load(CurrentRow, K) * Load(K, CurrentColumn)
2053 Builder.SetInsertPoint(InnerBody->getTerminator());
2054 // Load tiles of the operands.
2055 MatrixTy A =
2056 loadMatrix(LPtr, {}, false, LShape, TI.RowLoop.Index, TI.KLoop.Index,
2057 {TileSize, TileSize}, EltType, Builder);
2058 MatrixTy B =
2059 loadMatrix(RPtr, {}, false, RShape, TI.KLoop.Index, TI.ColumnLoop.Index,
2060 {TileSize, TileSize}, EltType, Builder);
2061 emitMatrixMultiply(TileResult, A, B, Builder, true, false,
2062 getFastMathFlags(MatMul));
2063 // Store result after the inner loop is done.
2064 Builder.SetInsertPoint(TI.RowLoop.Latch->getTerminator());
2065 storeMatrix(TileResult, Store->getPointerOperand(), Store->getAlign(),
2066 Store->isVolatile(), {LShape.NumRows, RShape.NumColumns},
2067 TI.RowLoop.Index, TI.ColumnLoop.Index, EltType, Builder);
2068
2069 for (unsigned I = 0; I < TileResult.getNumVectors(); I++)
2070 ColumnPhis[I]->addIncoming(TileResult.getVector(I), TI.KLoop.Latch);
2071
2072 // Force unrolling of a few iterations of the inner loop, to make sure there
2073 // is enough work per iteration.
2074 // FIXME: The unroller should make this decision directly instead, but
2075 // currently the cost-model is not up to the task.
2076 unsigned InnerLoopUnrollCount = std::min(10u, LShape.NumColumns / TileSize);
2077 addStringMetadataToLoop(LI->getLoopFor(TI.KLoop.Header),
2078 "llvm.loop.unroll.count", InnerLoopUnrollCount);
2079 }
2080
2081 void emitSIMDTiling(CallInst *MatMul, LoadInst *LoadOp0, LoadInst *LoadOp1,
2082 StoreInst *Store,
2083 SmallPtrSetImpl<Instruction *> &FusedInsts) {
2085 "Tiling only supported for column-major matrixes at the moment!");
2086 if (!isFusionProfitable(MatMul))
2087 return;
2088
2089 ShapeInfo LShape(MatMul->getArgOperand(2), MatMul->getArgOperand(3));
2090 ShapeInfo RShape(MatMul->getArgOperand(3), MatMul->getArgOperand(4));
2091
2092 const unsigned R = LShape.NumRows;
2093 const unsigned C = RShape.NumColumns;
2094 const unsigned M = LShape.NumColumns;
2095 auto *EltType = cast<FixedVectorType>(MatMul->getType())->getElementType();
2096
2097 Value *APtr = getNonAliasingPointer(LoadOp0, Store, MatMul);
2098 Value *BPtr = getNonAliasingPointer(LoadOp1, Store, MatMul);
2099 Value *CPtr = Store->getPointerOperand();
2100
2101 // Use loop-based tiling when the number of expected operations exceeds
2102 // threshold.
2103 unsigned NumOps = getNumNativeVectorOps(EltType, R, M, C);
2104 bool UseLoops =
2105 (NumOps > TileLoopsThreshold) && R % TileSize == 0 && C % TileSize == 0;
2106 if (UseLoops)
2107 createTiledLoops(MatMul, APtr, LShape, BPtr, RShape, Store);
2108 else {
2109 IRBuilder<> Builder(Store);
2110 for (unsigned J = 0; J < C; J += TileSize)
2111 for (unsigned I = 0; I < R; I += TileSize) {
2112 const unsigned TileR = std::min(R - I, unsigned(TileSize));
2113 const unsigned TileC = std::min(C - J, unsigned(TileSize));
2114 MatrixTy Res = getZeroMatrix(EltType, TileR, TileC);
2115
2116 for (unsigned K = 0; K < M; K += TileSize) {
2117 const unsigned TileM = std::min(M - K, unsigned(TileSize));
2118 MatrixTy A =
2119 loadMatrix(APtr, LoadOp0->getAlign(), LoadOp0->isVolatile(),
2120 LShape, getIndex(APtr, I), getIndex(APtr, K),
2121 {TileR, TileM}, EltType, Builder);
2122 MatrixTy B =
2123 loadMatrix(BPtr, LoadOp1->getAlign(), LoadOp1->isVolatile(),
2124 RShape, getIndex(BPtr, K), getIndex(BPtr, J),
2125 {TileM, TileC}, EltType, Builder);
2126 emitMatrixMultiply(Res, A, B, Builder, true, false,
2127 getFastMathFlags(MatMul));
2128 }
2129 storeMatrix(Res, CPtr, Store->getAlign(), Store->isVolatile(), {R, M},
2130 getIndex(CPtr, I), getIndex(CPtr, J), EltType, Builder);
2131 }
2132 }
2133
2134 // Mark eliminated instructions as fused and remove them.
2135 FusedInsts.insert(Store);
2136 FusedInsts.insert(MatMul);
2137 eraseFromParentAndRemoveFromShapeMap(Store);
2138 eraseFromParentAndRemoveFromShapeMap(MatMul);
2139 if (LoadOp0->use_empty()) {
2140 FusedInsts.insert(LoadOp0);
2141 eraseFromParentAndRemoveFromShapeMap(LoadOp0);
2142 }
2143 if (LoadOp1 != LoadOp0 && LoadOp1->use_empty()) {
2144 FusedInsts.insert(LoadOp1);
2145 eraseFromParentAndRemoveFromShapeMap(LoadOp1);
2146 }
2147 }
2148
2149 /// Try to lower matrix multiply chains by fusing operations.
2150 ///
2151 /// Call finalizeLowering on lowered instructions. Instructions that are
2152 /// completely eliminated by fusion are added to \p FusedInsts.
2153 void
2154 LowerMatrixMultiplyFused(CallInst *MatMul,
2155 SmallPtrSetImpl<Instruction *> &FusedInsts,
2156 SmallVector<IntrinsicInst *, 16> &LifetimeEnds) {
2157 if (!FuseMatrix || !DT || TileSize == 0)
2158 return;
2159
2160 assert(AA && LI && "Analyses should be available");
2161
2162 Value *A = MatMul->getArgOperand(0);
2163 Value *B = MatMul->getArgOperand(1);
2164
2165 // We can fold the transpose into the operand that is used to fetch scalars.
2166 Value *T;
2170 IRBuilder<> Builder(MatMul);
2171 auto *EltType =
2172 cast<FixedVectorType>(MatMul->getType())->getElementType();
2173 ShapeInfo LShape(MatMul->getArgOperand(2), MatMul->getArgOperand(3));
2174 ShapeInfo RShape(MatMul->getArgOperand(3), MatMul->getArgOperand(4));
2175 const unsigned R = LShape.NumRows;
2176 const unsigned M = LShape.NumColumns;
2177 const unsigned C = RShape.NumColumns;
2178
2179 MatrixTy MA;
2180 MatrixTy MB;
2181
2182 Value *Transpose;
2184 MA = getMatrix(A, ShapeInfo(R, M), Builder);
2185 MB = getMatrix(T, ShapeInfo(C, M), Builder);
2186 Transpose = B;
2187 } else {
2188 MA = getMatrix(T, ShapeInfo(R, M), Builder);
2189 MB = getMatrix(B, ShapeInfo(C, M), Builder);
2190 Transpose = A;
2191 }
2192
2193 // Initialize the output
2194 MatrixTy Result(R, C, EltType);
2195
2196 emitMatrixMultiply(Result, MA, MB, Builder, false, true,
2197 getFastMathFlags(MatMul));
2198
2199 FusedInsts.insert(MatMul);
2200 if (Transpose->hasOneUse()) {
2201 FusedInsts.insert(cast<Instruction>(Transpose));
2202 ToRemove.push_back(cast<Instruction>(Transpose));
2203 // TODO: add a fake entry for the folded instruction so that this is
2204 // included in the expression in the remark.
2205 Inst2ColumnMatrix[Transpose] = MatrixTy(M, C, EltType);
2206 }
2207 finalizeLowering(MatMul, Result, Builder);
2208 return;
2209 }
2210
2212 return;
2213
2214 // Lower {ld, ld} -> matmul -> st chains. No need to call finalizeLowering
2215 // since the single store user will be lowered as part of this.
2216 auto *LoadOp0 = dyn_cast<LoadInst>(A);
2217 auto *LoadOp1 = dyn_cast<LoadInst>(B);
2218 auto *Store = dyn_cast<StoreInst>(*MatMul->user_begin());
2219 if (LoadOp0 && LoadOp1 && Store) {
2220 // The store address must dominate the MatMul instruction, otherwise
2221 // we create invalid IR.
2222 SetVector<Value *> WorkList;
2223 WorkList.insert(Store->getOperand(1));
2225 for (unsigned I = 0; I != WorkList.size(); ++I) {
2226 Value *Current = WorkList[I];
2227 auto *CurrI = dyn_cast<Instruction>(Current);
2228 if (!CurrI)
2229 continue;
2230 if (isa<PHINode>(CurrI))
2231 return;
2232 if (DT->dominates(CurrI, MatMul))
2233 continue;
2234 if (CurrI->mayHaveSideEffects() || CurrI->mayReadFromMemory())
2235 return;
2236 ToHoist.push_back(CurrI);
2237 WorkList.insert_range(CurrI->operands());
2238 }
2239
2240 sort(ToHoist, [this](Instruction *A, Instruction *B) {
2241 return DT->dominates(A, B);
2242 });
2243 for (Instruction *I : ToHoist)
2244 I->moveBefore(MatMul->getIterator());
2245
2246 // Deal with lifetime.end calls that might be between Load0/Load1 and the
2247 // store. To avoid introducing loads to dead objects (i.e. after the
2248 // lifetime has been termined by @llvm.lifetime.end), either sink them
2249 // after the store if in the same block, or remove the lifetime.end marker
2250 // otherwise. This might pessimize further optimizations, by extending the
2251 // lifetime of the object until the function returns, but should be
2252 // conservatively correct.
2253 MemoryLocation Load0Loc = MemoryLocation::get(LoadOp0);
2254 MemoryLocation Load1Loc = MemoryLocation::get(LoadOp1);
2255 BasicBlock *StoreParent = Store->getParent();
2256 bool FusableOpsInSameBlock = LoadOp0->getParent() == StoreParent &&
2257 LoadOp1->getParent() == StoreParent;
2258 for (unsigned Idx = 0; Idx != LifetimeEnds.size();) {
2259 IntrinsicInst *End = LifetimeEnds[Idx];
2260 llvm::scope_exit Inc([&Idx]() { Idx++; });
2261 // If the lifetime.end is guaranteed to be before the loads or after the
2262 // store, it won't interfere with fusion.
2263 if (DT->dominates(End, LoadOp0) && DT->dominates(End, LoadOp1))
2264 continue;
2265 if (DT->dominates(Store, End))
2266 continue;
2267 // If all fusable ops are in the same block and the lifetime.end is in a
2268 // different block, it won't interfere with fusion.
2269 if (FusableOpsInSameBlock && End->getParent() != StoreParent)
2270 continue;
2271
2272 // If the loads don't alias the lifetime.end, it won't interfere with
2273 // fusion.
2274 MemoryLocation EndLoc = MemoryLocation::getForArgument(End, 0, nullptr);
2275 if (!EndLoc.Ptr)
2276 continue;
2277 if (AA->isNoAlias(Load0Loc, EndLoc) && AA->isNoAlias(Load1Loc, EndLoc))
2278 continue;
2279
2280 // If both lifetime.end and the store are in the same block, extend the
2281 // lifetime until after the store, so the new lifetime covers the loads
2282 // we introduce later.
2283 if (End->getParent() == StoreParent) {
2284 End->moveAfter(Store);
2285 continue;
2286 }
2287
2288 // Otherwise remove the conflicting lifetime.end marker.
2289 ToRemove.push_back(End);
2290 std::swap(LifetimeEnds[Idx], LifetimeEnds.back());
2291 LifetimeEnds.pop_back();
2292 Inc.release();
2293 }
2294
2295 emitSIMDTiling(MatMul, LoadOp0, LoadOp1, Store, FusedInsts);
2296 return;
2297 }
2298 }
2299
2300 /// Lowers llvm.matrix.multiply.
2301 MatrixTy LowerMultiply(CallInst *MatMul, IRBuilder<> &Builder) {
2302 auto *EltType = cast<FixedVectorType>(MatMul->getType())->getElementType();
2303 ShapeInfo LShape(MatMul->getArgOperand(2), MatMul->getArgOperand(3));
2304 ShapeInfo RShape(MatMul->getArgOperand(3), MatMul->getArgOperand(4));
2305
2306 const MatrixTy &Lhs = getMatrix(MatMul->getArgOperand(0), LShape, Builder);
2307 const MatrixTy &Rhs = getMatrix(MatMul->getArgOperand(1), RShape, Builder);
2308 assert(Lhs.getElementType() == Rhs.getElementType() &&
2309 "Matrix multiply argument element types do not match.");
2310
2311 const unsigned R = LShape.NumRows;
2312 const unsigned C = RShape.NumColumns;
2313 assert(LShape.NumColumns == RShape.NumRows);
2314
2315 // Initialize the output
2316 MatrixTy Result(R, C, EltType);
2317 assert(Lhs.getElementType() == Result.getElementType() &&
2318 "Matrix multiply result element type does not match arguments.");
2319
2320 emitMatrixMultiply(Result, Lhs, Rhs, Builder, false, false,
2321 getFastMathFlags(MatMul));
2322 return Result;
2323 }
2324
2325 /// Lowers llvm.matrix.transpose.
2326 MatrixTy LowerTranspose(CallInst *Inst, IRBuilder<> &Builder) {
2327 MatrixTy Result;
2328 Value *InputVal = Inst->getArgOperand(0);
2329 FixedVectorType *VectorTy = cast<FixedVectorType>(InputVal->getType());
2330 ShapeInfo ArgShape(Inst->getArgOperand(1), Inst->getArgOperand(2));
2331 MatrixTy InputMatrix = getMatrix(InputVal, ArgShape, Builder);
2332
2333 const unsigned NewNumVecs =
2334 InputMatrix.isColumnMajor() ? ArgShape.NumRows : ArgShape.NumColumns;
2335 const unsigned NewNumElts =
2336 InputMatrix.isColumnMajor() ? ArgShape.NumColumns : ArgShape.NumRows;
2337
2338 for (unsigned I = 0; I < NewNumVecs; ++I) {
2339 // Build a single result vector. First initialize it.
2340 Value *ResultVector = PoisonValue::get(
2341 FixedVectorType::get(VectorTy->getElementType(), NewNumElts));
2342 // Go through the old elements and insert it into the resulting vector.
2343 for (auto J : enumerate(InputMatrix.vectors())) {
2344 Value *Elt = Builder.CreateExtractElement(J.value(), I);
2345 // Row and column indices are transposed.
2346 ResultVector =
2347 Builder.CreateInsertElement(ResultVector, Elt, J.index());
2348 }
2349 Result.addVector(ResultVector);
2350 }
2351
2352 // TODO: Improve estimate of operations needed for transposes. Currently we
2353 // just count the insertelement/extractelement instructions, but do not
2354 // account for later simplifications/combines.
2355 return Result.addNumComputeOps(2 * ArgShape.NumRows * ArgShape.NumColumns)
2356 .addNumExposedTransposes(1);
2357 }
2358
2359 /// Lower load instructions.
2360 MatrixTy VisitLoad(LoadInst *Inst, const ShapeInfo &SI, Value *Ptr,
2361 IRBuilder<> &Builder) {
2362 return LowerLoad(Inst, Ptr, Inst->getAlign(), getIndex(Ptr, SI.getStride()),
2363 Inst->isVolatile(), SI, Builder);
2364 }
2365
2366 MatrixTy VisitStore(StoreInst *Inst, const ShapeInfo &SI, Value *StoredVal,
2367 Value *Ptr, IRBuilder<> &Builder) {
2368 return LowerStore(Inst, StoredVal, Ptr, Inst->getAlign(),
2369 getIndex(Ptr, SI.getStride()), Inst->isVolatile(), SI,
2370 Builder);
2371 }
2372
2373 MatrixTy VisitPHI(PHINode *Inst, const ShapeInfo &SI, IRBuilder<> &Builder) {
2374 auto BlockIP = Inst->getParent()->getFirstInsertionPt();
2375 Builder.SetInsertPoint(BlockIP);
2376 MatrixTy PhiM = getMatrix(Inst, SI, Builder);
2377
2378 for (auto [IncomingV, IncomingB] :
2379 llvm::zip_equal(Inst->incoming_values(), Inst->blocks())) {
2380 // getMatrix() may insert some instructions to help with reshaping. The
2381 // safest place for those is at the top of the block after the rest of the
2382 // PHI's. Even better, if we can put it in the incoming block.
2383 Builder.SetInsertPoint(BlockIP);
2384 if (auto *IncomingInst = dyn_cast<Instruction>(IncomingV))
2385 if (auto MaybeIP = IncomingInst->getInsertionPointAfterDef())
2386 Builder.SetInsertPoint(*MaybeIP);
2387
2388 MatrixTy OpM = getMatrix(IncomingV, SI, Builder);
2389
2390 for (unsigned VI = 0, VE = PhiM.getNumVectors(); VI != VE; ++VI) {
2391 PHINode *NewPHI = cast<PHINode>(PhiM.getVector(VI));
2392 NewPHI->addIncoming(OpM.getVector(VI), IncomingB);
2393 }
2394 }
2395
2396 // finalizeLowering() may also insert instructions in some cases. The safe
2397 // place for those is at the end of the initial block of PHIs.
2398 Builder.SetInsertPoint(BlockIP);
2399 return PhiM;
2400 }
2401
2402 /// Lower binary operators.
2403 MatrixTy VisitBinaryOperator(BinaryOperator *Inst, const ShapeInfo &SI,
2404 IRBuilder<> &Builder) {
2405 Value *Lhs = Inst->getOperand(0);
2406 Value *Rhs = Inst->getOperand(1);
2407
2408 MatrixTy Result;
2409 MatrixTy A = getMatrix(Lhs, SI, Builder);
2410 MatrixTy B = getMatrix(Rhs, SI, Builder);
2411 assert(A.isColumnMajor() == B.isColumnMajor() &&
2412 Result.isColumnMajor() == A.isColumnMajor() &&
2413 "operands must agree on matrix layout");
2414
2415 Builder.setFastMathFlags(getFastMathFlags(Inst));
2416
2417 for (auto [AV, BV] : llvm::zip_equal(A.vectors(), B.vectors()))
2418 Result.addVector(Builder.CreateBinOp(Inst->getOpcode(), AV, BV));
2419
2420 return Result.addNumComputeOps(getNumOps(Result.getVectorTy()) *
2421 Result.getNumVectors());
2422 }
2423
2424 /// Lower unary operators.
2425 MatrixTy VisitUnaryOperator(UnaryOperator *Inst, const ShapeInfo &SI,
2426 IRBuilder<> &Builder) {
2427 Value *Op = Inst->getOperand(0);
2428
2429 MatrixTy Result;
2430 MatrixTy M = getMatrix(Op, SI, Builder);
2431
2432 Builder.setFastMathFlags(getFastMathFlags(Inst));
2433
2434 // Helper to perform unary op on vectors.
2435 auto BuildVectorOp = [&Builder, Inst](Value *Op) {
2436 switch (Inst->getOpcode()) {
2437 case Instruction::FNeg:
2438 return Builder.CreateFNeg(Op);
2439 default:
2440 llvm_unreachable("Unsupported unary operator for matrix");
2441 }
2442 };
2443
2444 for (auto *Vector : M.vectors())
2445 Result.addVector(BuildVectorOp(Vector));
2446
2447 return Result.addNumComputeOps(getNumOps(Result.getVectorTy()) *
2448 Result.getNumVectors());
2449 }
2450
2451 /// Lower cast instructions.
2452 MatrixTy VisitCastInstruction(CastInst *Inst, const ShapeInfo &Shape,
2453 IRBuilder<> &Builder) {
2454 Value *Op = Inst->getOperand(0);
2455
2456 MatrixTy Result;
2457 MatrixTy M = getMatrix(Op, Shape, Builder);
2458
2459 Builder.setFastMathFlags(getFastMathFlags(Inst));
2460
2461 auto *OrigVTy = cast<VectorType>(Inst->getType());
2462 auto *NewVTy = VectorType::get(OrigVTy->getElementType(),
2463 ElementCount::getFixed(M.getStride()));
2464
2465 for (auto *Vector : M.vectors())
2466 Result.addVector(Builder.CreateCast(Inst->getOpcode(), Vector, NewVTy));
2467
2468 return Result.addNumComputeOps(getNumOps(Result.getVectorTy()) *
2469 Result.getNumVectors());
2470 }
2471
2472 /// Lower selects.
2473 MatrixTy VisitSelectInst(SelectInst *Inst, const ShapeInfo &Shape,
2474 IRBuilder<> &Builder) {
2475 Value *Cond = Inst->getOperand(0);
2476 Value *OpA = Inst->getOperand(1);
2477 Value *OpB = Inst->getOperand(2);
2478
2479 MatrixTy Result;
2480 MatrixTy A = getMatrix(OpA, Shape, Builder);
2481 MatrixTy B = getMatrix(OpB, Shape, Builder);
2482
2483 SmallVector<Value*> CondV;
2484 Instruction *MDFrom = nullptr;
2485 if (isa<FixedVectorType>(Cond->getType())) {
2486 MatrixTy C = getMatrix(Cond, Shape, Builder);
2487 llvm::copy(C.vectors(), std::back_inserter(CondV));
2488 } else {
2489 CondV.resize(A.getNumVectors());
2490 llvm::fill(CondV, Cond);
2492 MDFrom = Inst;
2493 }
2494
2495 for (auto [CV, AV, BV] : llvm::zip_equal(CondV, A.vectors(), B.vectors())) {
2496 assert(!(isa<VectorType>(CV->getType()) && static_cast<bool>(MDFrom)) &&
2497 "If we have a vector conditional, we should be propagating "
2498 "profile information.");
2499 Result.addVector(Builder.CreateSelect(CV, AV, BV, "", MDFrom));
2500 }
2501
2502 return Result.addNumComputeOps(getNumOps(Result.getVectorTy()) *
2503 Result.getNumVectors());
2504 }
2505
2506 /// Helper to linearize a matrix expression tree into a string. Currently
2507 /// matrix expressions are linarized by starting at an expression leaf and
2508 /// linearizing bottom up.
2509 struct ExprLinearizer {
2510 unsigned LengthToBreak = 100;
2511 std::string Str;
2512 raw_string_ostream Stream;
2513 unsigned LineLength = 0;
2514 const DataLayout &DL;
2515
2516 /// Mapping from instructions to matrixes. It is used to identify
2517 /// matrix instructions.
2518 const MapVector<Value *, MatrixTy> &Inst2Matrix;
2519
2520 /// Mapping from values to the leaves of all expressions that the value is
2521 /// part of.
2522 const DenseMap<Value *, SmallPtrSet<Value *, 2>> &Shared;
2523
2524 /// Set of matrix expressions in the scope of a given DISubprogram.
2525 const SmallSetVector<Value *, 32> &ExprsInSubprogram;
2526
2527 /// Leaf node of the expression to linearize.
2528 Value *Leaf;
2529
2530 /// Used to keep track of sub-expressions that get reused while linearizing
2531 /// the expression. Re-used sub-expressions are marked as (reused).
2532 SmallPtrSet<Value *, 8> ReusedExprs;
2533
2534 ExprLinearizer(const DataLayout &DL,
2535 const MapVector<Value *, MatrixTy> &Inst2Matrix,
2536 const DenseMap<Value *, SmallPtrSet<Value *, 2>> &Shared,
2537 const SmallSetVector<Value *, 32> &ExprsInSubprogram,
2538 Value *Leaf)
2539 : Stream(Str), DL(DL), Inst2Matrix(Inst2Matrix), Shared(Shared),
2540 ExprsInSubprogram(ExprsInSubprogram), Leaf(Leaf) {}
2541
2542 void indent(unsigned N) {
2543 LineLength += N;
2544 for (unsigned i = 0; i < N; i++)
2545 Stream << " ";
2546 }
2547
2548 void lineBreak() {
2549 Stream << "\n";
2550 LineLength = 0;
2551 }
2552
2553 void maybeIndent(unsigned Indent) {
2554 if (LineLength >= LengthToBreak)
2555 lineBreak();
2556
2557 if (LineLength == 0)
2558 indent(Indent);
2559 }
2560
2561 void write(StringRef S) {
2562 LineLength += S.size();
2563 Stream << S;
2564 }
2565
2566 Value *getUnderlyingObjectThroughLoads(Value *V) {
2567 if (Value *Ptr = getPointerOperand(V))
2568 return getUnderlyingObjectThroughLoads(Ptr);
2569 else if (V->getType()->isPointerTy())
2570 return getUnderlyingObject(V);
2571 return V;
2572 }
2573
2574 /// Returns true if \p V is a matrix value in the given subprogram.
2575 bool isMatrix(Value *V) const { return ExprsInSubprogram.count(V); }
2576
2577 /// If \p V is a matrix value, print its shape as NumRows x NumColumns to
2578 /// \p SS.
2579 void prettyPrintMatrixType(Value *V, raw_string_ostream &SS) {
2580 auto M = Inst2Matrix.find(V);
2581 if (M == Inst2Matrix.end())
2582 SS << "unknown";
2583 else {
2584 SS << M->second.getNumRows();
2585 SS << "x";
2586 SS << M->second.getNumColumns();
2587 }
2588 }
2589
2590 /// Write the called function name. Handles calls to llvm.matrix.*
2591 /// specially: we write the name, followed by the dimensions of the input
2592 /// matrixes, followed by the scalar type name.
2593 void writeFnName(CallInst *CI) {
2594 if (!CI->getCalledFunction())
2595 write("<no called fn>");
2596 else {
2597 StringRef Name = CI->getCalledFunction()->getName();
2598 if (!Name.starts_with("llvm.matrix")) {
2599 write(Name);
2600 return;
2601 }
2602 auto *II = cast<IntrinsicInst>(CI);
2603 write(Intrinsic::getBaseName(II->getIntrinsicID())
2604 .drop_front(StringRef("llvm.matrix.").size()));
2605 write(".");
2606 std::string Tmp;
2607 raw_string_ostream SS(Tmp);
2608
2609 switch (II->getIntrinsicID()) {
2610 case Intrinsic::matrix_multiply:
2611 prettyPrintMatrixType(II->getOperand(0), SS);
2612 SS << ".";
2613 prettyPrintMatrixType(II->getOperand(1), SS);
2614 SS << "." << *II->getType()->getScalarType();
2615 break;
2616 case Intrinsic::matrix_transpose:
2617 prettyPrintMatrixType(II->getOperand(0), SS);
2618 SS << "." << *II->getType()->getScalarType();
2619 break;
2620 case Intrinsic::matrix_column_major_load:
2621 prettyPrintMatrixType(II, SS);
2622 SS << "." << *II->getType()->getScalarType();
2623 break;
2624 case Intrinsic::matrix_column_major_store:
2625 prettyPrintMatrixType(II->getOperand(0), SS);
2626 SS << "." << *II->getOperand(0)->getType()->getScalarType();
2627 break;
2628 default:
2629 llvm_unreachable("Unhandled case");
2630 }
2631 write(Tmp);
2632 }
2633 }
2634
2635 unsigned getNumShapeArgs(CallInst *CI) const {
2636 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(CI)) {
2637 switch (II->getIntrinsicID()) {
2638 case Intrinsic::matrix_multiply:
2639 return 3;
2640 case Intrinsic::matrix_transpose:
2641 return 2;
2642 case Intrinsic::matrix_column_major_load:
2643 case Intrinsic::matrix_column_major_store:
2644 return 3;
2645 default:
2646 return 0;
2647 }
2648 }
2649 return 0;
2650 }
2651
2652 /// Special printing for values: for pointers, we print if they refer to an
2653 /// (function) external address or a stack address, for other values we
2654 /// either print the constant or "scalar"/"matrix" for other values.
2655 void write(Value *V) {
2656 V = getUnderlyingObjectThroughLoads(V);
2657 if (V->getType()->isPointerTy()) {
2658 if (isa<AllocaInst>(V)) {
2659 Stream << "stack addr";
2660 LineLength += StringRef("stack addr").size();
2661 } else {
2662 Stream << "addr";
2663 LineLength += StringRef("addr").size();
2664 }
2665 if (!V->getName().empty()) {
2666 Stream << " %" << V->getName() << "";
2667 LineLength += V->getName().size() + 2;
2668 }
2669 return;
2670 }
2671
2672 std::string Tmp;
2673 raw_string_ostream TmpStream(Tmp);
2674
2675 if (auto *CI = dyn_cast<ConstantInt>(V))
2676 TmpStream << CI->getValue();
2677 else if (isa<Constant>(V))
2678 TmpStream << "constant";
2679 else {
2680 if (isMatrix(V))
2681 TmpStream << "matrix";
2682 else
2683 TmpStream << "scalar";
2684 }
2685 Tmp = std::string(StringRef(Tmp).trim());
2686 LineLength += Tmp.size();
2687 Stream << Tmp;
2688 }
2689
2690 /// Linearize expression \p Expr starting at an indentation of \p Indent.
2691 /// Expressions that are re-used multiple times are prefixed with (reused)
2692 /// at the re-used root instruction.
2693 void linearizeExpr(Value *Expr, unsigned Indent, bool ParentReused,
2694 bool ParentShared) {
2695 auto *I = cast<Instruction>(Expr);
2696 maybeIndent(Indent);
2697 SmallVector<Value *, 8> Ops;
2698
2699 // Is Expr shared with other expression leaves?
2700 bool ExprShared = false;
2701
2702 // Deal with shared subtrees. Mark them as shared, if required.
2703 if (!ParentShared) {
2704 auto SI = Shared.find(Expr);
2705 assert(SI != Shared.end() && SI->second.count(Leaf));
2706
2707 for (Value *S : SI->second) {
2708 if (S == Leaf)
2709 continue;
2710 DebugLoc DL = cast<Instruction>(S)->getDebugLoc();
2711 write("shared with remark at line " + std::to_string(DL.getLine()) +
2712 " column " + std::to_string(DL.getCol()) + " (");
2713 }
2714 ExprShared = SI->second.size() > 1;
2715 }
2716
2717 bool Reused = !ReusedExprs.insert(Expr).second;
2718 if (Reused && !ParentReused)
2719 write("(reused) ");
2720
2721 if (auto *CI = dyn_cast<CallInst>(I)) {
2722 writeFnName(CI);
2723
2724 Ops.append(CI->arg_begin(), CI->arg_end() - getNumShapeArgs(CI));
2725 } else if (isa<BitCastInst>(Expr)) {
2726 // Special case bitcasts, which are used to materialize matrixes from
2727 // non-matrix ops.
2728 write("matrix");
2729 return;
2730 } else {
2731 Ops.append(I->value_op_begin(), I->value_op_end());
2732 write(I->getOpcodeName());
2733 }
2734
2735 write("(");
2736
2737 unsigned NumOpsToBreak = 1;
2739 NumOpsToBreak = 2;
2740
2741 for (Value *Op : Ops) {
2742 if (Ops.size() > NumOpsToBreak)
2743 lineBreak();
2744
2745 maybeIndent(Indent + 1);
2746 if (isMatrix(Op))
2747 linearizeExpr(Op, Indent + 1, Reused, ExprShared);
2748 else
2749 write(Op);
2750 if (Op != Ops.back())
2751 write(", ");
2752 }
2753
2754 write(")");
2755 }
2756
2757 const std::string &getResult() {
2758 return Str;
2759 }
2760 };
2761
2762 /// Generate remarks for matrix operations in a function. To generate remarks
2763 /// for matrix expressions, the following approach is used:
2764 /// 1. Use the inlined-at debug information to group matrix operations to the
2765 /// DISubprograms they are contained in.
2766 /// 2. Collect leaves of matrix expressions (done in
2767 /// RemarkGenerator::getExpressionLeaves) for each subprogram - expression
2768 // mapping. Leaves are lowered matrix instructions without other matrix
2769 // users (like stores) in the current subprogram.
2770 /// 3. For each leaf, create a remark containing a linearizied version of the
2771 /// matrix expression. The expression is linearized by a recursive
2772 /// bottom-up traversal of the matrix operands, starting at a leaf. Note
2773 /// that multiple leaves can share sub-expressions. Shared subexpressions
2774 /// are explicitly marked as shared().
2775 struct RemarkGenerator {
2776 const MapVector<Value *, MatrixTy> &Inst2Matrix;
2777 OptimizationRemarkEmitter &ORE;
2778 Function &Func;
2779 const DataLayout &DL;
2780
2781 RemarkGenerator(const MapVector<Value *, MatrixTy> &Inst2Matrix,
2782 OptimizationRemarkEmitter &ORE, Function &Func)
2783 : Inst2Matrix(Inst2Matrix), ORE(ORE), Func(Func),
2784 DL(Func.getDataLayout()) {}
2785
2786 /// Return all leaves of the expressions in \p ExprsInSubprogram. Those are
2787 /// instructions in Inst2Matrix returning void or without any users in
2788 /// \p ExprsInSubprogram. Currently that should only include stores.
2789 SmallVector<Value *, 4>
2790 getExpressionLeaves(const SmallSetVector<Value *, 32> &ExprsInSubprogram) {
2791 SmallVector<Value *, 4> Leaves;
2792 for (auto *Expr : ExprsInSubprogram)
2793 if (Expr->getType()->isVoidTy() ||
2794 !any_of(Expr->users(), [&ExprsInSubprogram](User *U) {
2795 return ExprsInSubprogram.count(U);
2796 }))
2797 Leaves.push_back(Expr);
2798 return Leaves;
2799 }
2800
2801 /// Recursively traverse expression \p V starting at \p Leaf and add \p Leaf
2802 /// to all visited expressions in \p Shared. Limit the matrix operations to
2803 /// the ones in \p ExprsInSubprogram.
2804 void collectSharedInfo(Value *Leaf, Value *V,
2805 const SmallSetVector<Value *, 32> &ExprsInSubprogram,
2806 DenseMap<Value *, SmallPtrSet<Value *, 2>> &Shared) {
2807
2808 if (!ExprsInSubprogram.count(V))
2809 return;
2810
2811 Shared[V].insert(Leaf);
2812
2813 for (Value *Op : cast<Instruction>(V)->operand_values())
2814 collectSharedInfo(Leaf, Op, ExprsInSubprogram, Shared);
2815 }
2816
2817 /// Calculate the number of exclusive and shared op counts for expression
2818 /// starting at \p V. Expressions used multiple times are counted once.
2819 /// Limit the matrix operations to the ones in \p ExprsInSubprogram.
2820 std::pair<OpInfoTy, OpInfoTy>
2821 sumOpInfos(Value *Root, SmallPtrSetImpl<Value *> &ReusedExprs,
2822 const SmallSetVector<Value *, 32> &ExprsInSubprogram,
2823 DenseMap<Value *, SmallPtrSet<Value *, 2>> &Shared) const {
2824 if (!ExprsInSubprogram.count(Root))
2825 return {};
2826
2827 // Already counted this expression. Stop.
2828 if (!ReusedExprs.insert(Root).second)
2829 return {};
2830
2831 OpInfoTy SharedCount;
2832 OpInfoTy Count;
2833
2834 auto I = Shared.find(Root);
2835 auto CM = Inst2Matrix.find(Root);
2836 if (I->second.size() == 1)
2837 Count = CM->second.getOpInfo();
2838 else
2839 SharedCount = CM->second.getOpInfo();
2840
2841 for (Value *Op : cast<Instruction>(Root)->operand_values()) {
2842 auto C = sumOpInfos(Op, ReusedExprs, ExprsInSubprogram, Shared);
2843 Count += C.first;
2844 SharedCount += C.second;
2845 }
2846 return {Count, SharedCount};
2847 }
2848
2849 void emitRemarks() {
2850 if (!ORE.allowExtraAnalysis(DEBUG_TYPE))
2851 return;
2852
2853 // Map matrix operations to their containting subprograms, by traversing
2854 // the inlinedAt chain. If the function does not have a DISubprogram, we
2855 // only map them to the containing function.
2856 MapVector<DISubprogram *, SmallVector<Value *, 8>> Subprog2Exprs;
2857 for (const auto &KV : Inst2Matrix) {
2858 if (Func.getSubprogram()) {
2859 auto *I = cast<Instruction>(KV.first);
2860 DILocation *Context = I->getDebugLoc();
2861 while (Context) {
2862 Subprog2Exprs[getSubprogram(Context->getScope())].push_back(
2863 KV.first);
2864 Context = DebugLoc(Context).getInlinedAt();
2865 }
2866 } else {
2867 Subprog2Exprs[nullptr].push_back(KV.first);
2868 }
2869 }
2870 for (auto &KV : Subprog2Exprs) {
2871 SmallSetVector<Value *, 32> ExprsInSubprogram(KV.second.begin(),
2872 KV.second.end());
2873 auto Leaves = getExpressionLeaves(ExprsInSubprogram);
2874
2875 DenseMap<Value *, SmallPtrSet<Value *, 2>> Shared;
2876 for (Value *Leaf : Leaves)
2877 collectSharedInfo(Leaf, Leaf, ExprsInSubprogram, Shared);
2878
2879 // Generate remarks for each leaf.
2880 for (auto *L : Leaves) {
2881
2882 DebugLoc Loc = cast<Instruction>(L)->getDebugLoc();
2883 DILocation *Context = cast<Instruction>(L)->getDebugLoc();
2884 while (Context) {
2885 if (getSubprogram(Context->getScope()) == KV.first) {
2886 Loc = Context;
2887 break;
2888 }
2889 Context = DebugLoc(Context).getInlinedAt();
2890 }
2891
2892 SmallPtrSet<Value *, 8> ReusedExprs;
2893 OpInfoTy Counts, SharedCounts;
2894 std::tie(Counts, SharedCounts) =
2895 sumOpInfos(L, ReusedExprs, ExprsInSubprogram, Shared);
2896
2897 OptimizationRemark Rem(DEBUG_TYPE, "matrix-lowered", Loc,
2899
2900 Rem << "Lowered with ";
2901 Rem << ore::NV("NumStores", Counts.NumStores) << " stores, "
2902 << ore::NV("NumLoads", Counts.NumLoads) << " loads, "
2903 << ore::NV("NumComputeOps", Counts.NumComputeOps)
2904 << " compute ops, "
2905 << ore::NV("NumExposedTransposes", Counts.NumExposedTransposes)
2906 << " exposed transposes";
2907
2908 if (SharedCounts.NumStores > 0 || SharedCounts.NumLoads > 0 ||
2909 SharedCounts.NumComputeOps > 0) {
2910 Rem << ",\nadditionally "
2911 << ore::NV("NumStores", SharedCounts.NumStores) << " stores, "
2912 << ore::NV("NumLoads", SharedCounts.NumLoads) << " loads, "
2913 << ore::NV("NumFPOps", SharedCounts.NumComputeOps)
2914 << " compute ops"
2915 << " are shared with other expressions";
2916 }
2917
2918 Rem << ("\n" + linearize(L, Shared, ExprsInSubprogram, DL));
2919 ORE.emit(Rem);
2920 }
2921 }
2922 }
2923
2924 std::string
2925 linearize(Value *L,
2926 const DenseMap<Value *, SmallPtrSet<Value *, 2>> &Shared,
2927 const SmallSetVector<Value *, 32> &ExprsInSubprogram,
2928 const DataLayout &DL) {
2929 ExprLinearizer Lin(DL, Inst2Matrix, Shared, ExprsInSubprogram, L);
2930 Lin.linearizeExpr(L, 0, false, false);
2931 return Lin.getResult();
2932 }
2933 };
2934};
2935} // namespace
2936
2939 auto &TTI = AM.getResult<TargetIRAnalysis>(F);
2940
2941 LowerMatrixIntrinsics LMT(F, TTI, Minimal ? nullptr : &AM);
2942 if (LMT.Visit()) {
2944 if (!Minimal) {
2945 PA.preserve<LoopAnalysis>();
2947 }
2948 return PA;
2949 }
2950 return PreservedAnalyses::all();
2951}
2952
2954 raw_ostream &OS, function_ref<StringRef(StringRef)> MapClassName2PassName) {
2956 OS, MapClassName2PassName);
2957 OS << '<';
2958 if (Minimal)
2959 OS << "minimal";
2960 OS << '>';
2961}
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
AMDGPU Register Bank Select
Rewrite undef for PHI
static const Function * getParent(const Value *V)
BitTracker BT
static GCRegistry::Add< ErlangGC > A("erlang", "erlang-compatible garbage collector")
static GCRegistry::Add< StatepointGC > D("statepoint-example", "an example strategy for statepoint")
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
#define clEnumValN(ENUMVAL, FLAGNAME, DESC)
#define LLVM_DUMP_METHOD
Mark debug helper function definitions like dump() that should not be stripped from debug builds.
Definition Compiler.h:661
Hexagon Common GEP
static Type * getIndexType(Value *In)
hexagon Hexagon specific predictive commoning for HVX vectors
This file provides various utilities for inspecting and working with the control flow graph in LLVM I...
iv users
Definition IVUsers.cpp:48
const size_t AbstractManglingParser< Derived, Alloc >::NumOps
const AbstractManglingParser< Derived, Alloc >::OperatorInfo AbstractManglingParser< Derived, Alloc >::Ops[]
static bool isZero(Value *V, const DataLayout &DL, DominatorTree *DT, AssumptionCache *AC)
Definition Lint.cpp:539
Live Register Matrix
static DISubprogram * getSubprogram(DIScope *Scope)
Helper function to either return Scope, if it is a subprogram or the attached subprogram for a local ...
static cl::opt< bool > ForceFusion("force-fuse-matrix", cl::init(false), cl::Hidden, cl::desc("Force matrix instruction fusion even if not profitable."))
static auto m_AnyAdd(const LTy &L, const RTy &R)
Match any add operation (fp or integer).
static cl::opt< bool > VerifyShapeInfo("verify-matrix-shapes", cl::Hidden, cl::desc("Enable/disable matrix shape verification."), cl::init(false))
static bool isShapePreserving(Value *V)
static cl::opt< unsigned > TileLoopsThreshold("fuse-matrix-loops-threshold", cl::init(200), cl::Hidden, cl::desc("Generate loop nests for tiling when expected " "number of operations exceeds threshold."))
static auto m_AnyMul(const LTy &L, const RTy &R)
Match any mul operation (fp or integer).
static cl::opt< unsigned > SplitMatmulRemainderOverThreshold("matrix-split-matmul-remainder-over-threshold", cl::Hidden, cl::desc("Illegal remainder vectors over this size in bits should be split " "in the inner loop of matmul"), cl::init(0))
static bool isSplat(Value *V)
Return true if V is a splat of a value (which is used when multiplying a matrix with a scalar).
static cl::opt< bool > FuseMatrix("fuse-matrix", cl::init(true), cl::Hidden, cl::desc("Enable/disable fusing matrix instructions."))
static cl::opt< bool > AllowContractEnabled("matrix-allow-contract", cl::init(false), cl::Hidden, cl::desc("Allow the use of FMAs if available and profitable. This may " "result in different results, due to less rounding error."))
static std::optional< ShapeInfo > computeShapeInfoForInst(Instruction *I, const DenseMap< Value *, ShapeInfo > &ShapeMap)
Return the ShapeInfo for the result of I, it it can be determined.
static cl::opt< bool > PrintAfterTransposeOpt("matrix-print-after-transpose-opt", cl::init(false))
#define DEBUG_TYPE
static iterator_range< Use * > getShapedOperandsForInst(Instruction *I)
Return an iterator over the operands of I that should share shape information with I.
static Value * computeVectorAddr(Value *BasePtr, Value *VecIdx, Value *Stride, unsigned NumElements, Type *EltType, IRBuilder<> &Builder)
static cl::opt< unsigned > TileSize("fuse-matrix-tile-size", cl::init(4), cl::Hidden, cl::desc("Tile size for matrix instruction fusion using square-shaped tiles."))
static cl::opt< MatrixLayoutTy > MatrixLayout("matrix-default-layout", cl::init(MatrixLayoutTy::ColumnMajor), cl::desc("Sets the default matrix layout"), cl::values(clEnumValN(MatrixLayoutTy::ColumnMajor, "column-major", "Use column-major layout"), clEnumValN(MatrixLayoutTy::RowMajor, "row-major", "Use row-major layout")))
#define F(x, y, z)
Definition MD5.cpp:54
#define I(x, y, z)
Definition MD5.cpp:57
#define T
#define T1
uint64_t IntrinsicInst * II
PowerPC Reduce CR logical Operation
This file builds on the ADT/GraphTraits.h file to build a generic graph post order iterator.
This file contains the declarations for profiling metadata utility functions.
const SmallVectorImpl< MachineOperand > & Cond
static Value * extractVector(IRBuilderTy &IRB, Value *V, unsigned BeginIndex, unsigned EndIndex, const Twine &Name)
Definition SROA.cpp:2558
static Value * insertVector(IRBuilderTy &IRB, Value *Old, Value *V, unsigned BeginIndex, const Twine &Name)
Definition SROA.cpp:2580
This file contains some templates that are useful if you are working with the STL at all.
This file defines the make_scope_exit function, which executes user-defined cleanup logic at scope ex...
This file defines the SmallVector class.
This file defines the 'Statistic' class, which is designed to be an easy way to expose various metric...
#define STATISTIC(VARNAME, DESC)
Definition Statistic.h:171
#define LLVM_DEBUG(...)
Definition Debug.h:114
static SymbolRef::Type getType(const Symbol *Sym)
Definition TapiFile.cpp:39
static const int BlockSize
Definition TarWriter.cpp:33
This pass exposes codegen information to IR-level passes.
static std::optional< unsigned > getOpcode(ArrayRef< VPValue * > Values)
Returns the opcode of Values or ~0 if they do not all agree.
Definition VPlanSLP.cpp:247
static SDValue LowerStore(SDValue Op, const X86Subtarget &Subtarget, SelectionDAG &DAG)
static SDValue LowerLoad(SDValue Op, const X86Subtarget &Subtarget, SelectionDAG &DAG)
Value * RHS
Value * LHS
Align getAlign() const
Return the alignment of the memory that is being allocated by the instruction.
PassT::Result & getResult(IRUnitT &IR, ExtraArgTs... ExtraArgs)
Get the result of an analysis pass for a given IR unit.
iterator begin()
Instruction iterator methods.
Definition BasicBlock.h:461
const Function * getParent() const
Return the enclosing method, or null if none.
Definition BasicBlock.h:213
reverse_iterator rbegin()
Definition BasicBlock.h:477
InstListType::reverse_iterator reverse_iterator
Definition BasicBlock.h:172
reverse_iterator rend()
Definition BasicBlock.h:479
const Instruction * getTerminator() const LLVM_READONLY
Returns the terminator instruction; assumes that the block is well-formed.
Definition BasicBlock.h:237
BinaryOps getOpcode() const
Definition InstrTypes.h:374
Function * getCalledFunction() const
Returns the function called, or null if this is an indirect function invocation or the function signa...
User::op_iterator arg_begin()
Return the iterator pointing to the beginning of the argument list.
MaybeAlign getParamAlign(unsigned ArgNo) const
Extract the alignment for a call or parameter (0=unknown).
Value * getArgOperand(unsigned i) const
User::op_iterator arg_end()
Return the iterator pointing to the end of the argument list.
Instruction::CastOps getOpcode() const
Return the opcode of this CastInst.
Definition InstrTypes.h:610
static LLVM_ABI ConstantAggregateZero * get(Type *Ty)
LLVM_ABI DISubprogram * getSubprogram() const
Get the subprogram for this scope.
Base class for scope-like contexts.
Subprogram description. Uses SubclassData1.
iterator find(const_arg_type_t< KeyT > Val)
Definition DenseMap.h:178
iterator end()
Definition DenseMap.h:81
Analysis pass which computes a DominatorTree.
Definition Dominators.h:278
static constexpr ElementCount getFixed(ScalarTy MinVal)
Definition TypeSize.h:309
void setAllowContract(bool B=true)
Definition FMF.h:93
bool allowReassoc() const
Flag queries.
Definition FMF.h:67
bool allowContract() const
Definition FMF.h:72
unsigned getNumElements() const
static LLVM_ABI FixedVectorType * get(Type *ElementType, unsigned NumElts)
Definition Type.cpp:873
Intrinsic::ID getIntrinsicID() const LLVM_READONLY
getIntrinsicID - This method returns the ID number of the specified function, or Intrinsic::not_intri...
Definition Function.h:246
bool isIntrinsic() const
isIntrinsic - Returns true if the function's name starts with "llvm.".
Definition Function.h:251
static GEPNoWrapFlags inBounds()
static GEPNoWrapFlags noUnsignedWrap()
LLVM_ABI CallInst * CreateFAddReduce(Value *Acc, Value *Src)
Create a sequential vector fadd reduction intrinsic of the source vector.
Value * CreateICmpULT(Value *LHS, Value *RHS, const Twine &Name="")
Definition IRBuilder.h:2347
Value * CreateInsertElement(Type *VecTy, Value *NewElt, Value *Idx, const Twine &Name="")
Definition IRBuilder.h:2584
AllocaInst * CreateAlloca(Type *Ty, unsigned AddrSpace, Value *ArraySize=nullptr, const Twine &Name="")
Definition IRBuilder.h:1860
Value * CreateExtractElement(Value *Vec, Value *Idx, const Twine &Name="")
Definition IRBuilder.h:2572
LoadInst * CreateAlignedLoad(Type *Ty, Value *Ptr, MaybeAlign Align, const char *Name)
Definition IRBuilder.h:1894
Value * CreateZExtOrTrunc(Value *V, Type *DestTy, const Twine &Name="")
Create a ZExt or Trunc from the integer value V to DestTy.
Definition IRBuilder.h:2095
CallInst * CreateMemCpy(Value *Dst, MaybeAlign DstAlign, Value *Src, MaybeAlign SrcAlign, uint64_t Size, bool isVolatile=false, const AAMDNodes &AAInfo=AAMDNodes())
Create and insert a memcpy between the specified pointers.
Definition IRBuilder.h:710
CondBrInst * CreateCondBr(Value *Cond, BasicBlock *True, BasicBlock *False, MDNode *BranchWeights=nullptr, MDNode *Unpredictable=nullptr)
Create a conditional 'br Cond, TrueDest, FalseDest' instruction.
Definition IRBuilder.h:1223
Value * CreateFAdd(Value *L, Value *R, const Twine &Name="", MDNode *FPMD=nullptr)
Definition IRBuilder.h:1639
LLVM_ABI Value * CreateVectorSplat(unsigned NumElts, Value *V, const Twine &Name="")
Return a vector value that contains.
LLVM_ABI Value * CreateSelect(Value *C, Value *True, Value *False, const Twine &Name="", Instruction *MDFrom=nullptr)
LLVM_ABI CallInst * CreateAddReduce(Value *Src)
Create a vector int add reduction intrinsic of the source vector.
Value * CreatePtrAdd(Value *Ptr, Value *Offset, const Twine &Name="", GEPNoWrapFlags NW=GEPNoWrapFlags::none())
Definition IRBuilder.h:2048
Value * CreateCast(Instruction::CastOps Op, Value *V, Type *DestTy, const Twine &Name="", MDNode *FPMathTag=nullptr, FMFSource FMFSource={})
Definition IRBuilder.h:2233
void setFastMathFlags(FastMathFlags NewFMF)
Set the fast-math flags to be used with generated fp-math operators.
Definition IRBuilder.h:345
Value * CreateGEP(Type *Ty, Value *Ptr, ArrayRef< Value * > IdxList, const Twine &Name="", GEPNoWrapFlags NW=GEPNoWrapFlags::none())
Definition IRBuilder.h:1967
LLVM_ABI Value * CreateBinaryIntrinsic(Intrinsic::ID ID, Value *LHS, Value *RHS, FMFSource FMFSource={}, const Twine &Name="")
Create a call to intrinsic ID with 2 operands which is mangled on the first type.
LLVM_ABI CallInst * CreateIntrinsic(Intrinsic::ID ID, ArrayRef< Type * > Types, ArrayRef< Value * > Args, FMFSource FMFSource={}, const Twine &Name="")
Create a call to intrinsic ID with Args, mangled using Types.
PHINode * CreatePHI(Type *Ty, unsigned NumReservedValues, const Twine &Name="")
Definition IRBuilder.h:2496
ConstantInt * getIntN(unsigned N, uint64_t C)
Get a constant N-bit value, zero extended from a 64-bit value.
Definition IRBuilder.h:532
LLVM_ABI CallInst * CreateUnaryIntrinsic(Intrinsic::ID ID, Value *V, FMFSource FMFSource={}, const Twine &Name="")
Create a call to intrinsic ID with 1 operand which is mangled on its type.
LoadInst * CreateLoad(Type *Ty, Value *Ptr, const char *Name)
Provided to resolve 'CreateLoad(Ty, Ptr, "...")' correctly, instead of converting the string to 'bool...
Definition IRBuilder.h:1877
Value * CreateShuffleVector(Value *V1, Value *V2, Value *Mask, const Twine &Name="")
Definition IRBuilder.h:2606
Value * CreateAdd(Value *LHS, Value *RHS, const Twine &Name="", bool HasNUW=false, bool HasNSW=false)
Definition IRBuilder.h:1429
Value * CreateBinOp(Instruction::BinaryOps Opc, Value *LHS, Value *RHS, const Twine &Name="", MDNode *FPMathTag=nullptr)
Definition IRBuilder.h:1734
void SetInsertPoint(BasicBlock *TheBB)
This specifies that created instructions should be appended to the end of the specified block.
Definition IRBuilder.h:207
StoreInst * CreateAlignedStore(Value *Val, Value *Ptr, MaybeAlign Align, bool isVolatile=false)
Definition IRBuilder.h:1913
Value * CreateFMul(Value *L, Value *R, const Twine &Name="", MDNode *FPMD=nullptr)
Definition IRBuilder.h:1677
Value * CreateFNeg(Value *V, const Twine &Name="", MDNode *FPMathTag=nullptr)
Definition IRBuilder.h:1820
Value * CreateMul(Value *LHS, Value *RHS, const Twine &Name="", bool HasNUW=false, bool HasNSW=false)
Definition IRBuilder.h:1463
This provides a uniform API for creating instructions and inserting them into a basic block: either a...
Definition IRBuilder.h:2811
LLVM_ABI void moveAfter(Instruction *MovePos)
Unlink this instruction from its current basic block and insert it into the basic block that MovePos ...
LLVM_ABI void setFastMathFlags(FastMathFlags FMF)
Convenience function for setting multiple fast-math flags on this instruction, which must be an opera...
LLVM_ABI InstListType::iterator eraseFromParent()
This method unlinks 'this' from the containing basic block and deletes it.
LLVM_ABI FastMathFlags getFastMathFlags() const LLVM_READONLY
Convenience function for getting all the fast-math flags, which must be an operator which supports th...
Intrinsic::ID getIntrinsicID() const
Return the intrinsic ID of this intrinsic.
bool isVolatile() const
Return true if this is a load from a volatile memory location.
Align getAlign() const
Return the alignment of the access that is being performed.
TypeSize getValue() const
Analysis pass that exposes the LoopInfo for a function.
Definition LoopInfo.h:569
PreservedAnalyses run(Function &F, FunctionAnalysisManager &AM)
void printPipeline(raw_ostream &OS, function_ref< StringRef(StringRef)> MapClassName2PassName)
CallInst * CreateMatrixTranspose(Value *Matrix, unsigned Rows, unsigned Columns, const Twine &Name="")
Create a llvm.matrix.transpose call, transposing Matrix with Rows rows and Columns columns.
CallInst * CreateMatrixMultiply(Value *LHS, Value *RHS, unsigned LHSRows, unsigned LHSColumns, unsigned RHSColumns, const Twine &Name="")
Create a llvm.matrix.multiply call, multiplying matrixes LHS and RHS.
static LLVM_ABI MemoryLocation get(const LoadInst *LI)
Return a location with information about the memory reference by the given instruction.
LocationSize Size
The maximum size of the location, in address-units, or UnknownSize if the size is not known.
const Value * Ptr
The address of the start of the location.
static LLVM_ABI MemoryLocation getForArgument(const CallBase *Call, unsigned ArgIdx, const TargetLibraryInfo *TLI)
Return a location representing a particular argument of a call.
void addIncoming(Value *V, BasicBlock *BB)
Add an incoming value to the end of the PHI list.
iterator_range< const_block_iterator > blocks() const
op_range incoming_values()
static LLVM_ABI PoisonValue * get(Type *T)
Static factory methods - Return an 'poison' object of the specified type.
A set of analyses that are preserved following a run of a transformation pass.
Definition Analysis.h:112
static PreservedAnalyses all()
Construct a special preserved set that preserves all passes.
Definition Analysis.h:118
PreservedAnalyses & preserve()
Mark an analysis as preserved.
Definition Analysis.h:132
size_type size() const
Determine the number of elements in the SetVector.
Definition SetVector.h:103
void insert_range(Range &&R)
Definition SetVector.h:176
size_type count(const_arg_type key) const
Count the number of elements of a given key in the SetVector.
Definition SetVector.h:262
bool insert(const value_type &X)
Insert a new element into the SetVector.
Definition SetVector.h:151
bool erase(PtrType Ptr)
Remove pointer from the set.
size_type count(ConstPtrType Ptr) const
count - Return 1 if the specified pointer is in the set, 0 otherwise.
std::pair< iterator, bool > insert(PtrType Ptr)
Inserts Ptr if and only if there is no element in the container equal to Ptr.
bool contains(ConstPtrType Ptr) const
void append(ItTy in_start, ItTy in_end)
Add the specified range to the end of the SmallVector.
void resize(size_type N)
void push_back(const T &Elt)
Align getAlign() const
bool isVolatile() const
Return true if this is a store to a volatile memory location.
StringRef - Represent a constant reference to a string, i.e.
Definition StringRef.h:55
StringRef drop_front(size_t N=1) const
Return a StringRef equal to 'this' but with the first N elements dropped.
Definition StringRef.h:629
constexpr size_t size() const
size - Get the string size.
Definition StringRef.h:143
Analysis pass providing the TargetTransformInfo.
@ TCK_RecipThroughput
Reciprocal throughput.
@ SK_Splice
Concatenates elements from the first input vector with elements of the second input vector.
The instances of the Type class are immutable: once they are created, they are never changed.
Definition Type.h:46
Type * getScalarType() const
If this is a vector type, return the element type, otherwise return 'this'.
Definition Type.h:370
LLVM_ABI TypeSize getPrimitiveSizeInBits() const LLVM_READONLY
Return the basic size of this type if it is a primitive type.
Definition Type.cpp:201
LLVM_ABI unsigned getScalarSizeInBits() const LLVM_READONLY
If this is a vector type, return the getPrimitiveSizeInBits value for the element type.
Definition Type.cpp:236
bool isVoidTy() const
Return true if this is 'void'.
Definition Type.h:141
UnaryOps getOpcode() const
Definition InstrTypes.h:154
Value * getOperand(unsigned i) const
Definition User.h:207
LLVM Value Representation.
Definition Value.h:75
Type * getType() const
All values are typed, get the type of this value.
Definition Value.h:256
user_iterator user_begin()
Definition Value.h:403
bool hasOneUse() const
Return true if there is exactly one use of this value.
Definition Value.h:440
LLVM_ABI void replaceAllUsesWith(Value *V)
Change all uses of this to point to a new Value.
Definition Value.cpp:553
iterator_range< user_iterator > users()
Definition Value.h:427
bool use_empty() const
Definition Value.h:347
iterator_range< use_iterator > uses()
Definition Value.h:381
LLVM_ABI StringRef getName() const
Return a constant reference to the value's name.
Definition Value.cpp:322
Type * getElementType() const
constexpr ScalarTy getFixedValue() const
Definition TypeSize.h:200
An efficient, type-erasing, non-owning reference to a callable.
const ParentTy * getParent() const
Definition ilist_node.h:34
self_iterator getIterator()
Definition ilist_node.h:123
A range adaptor for a pair of iterators.
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition raw_ostream.h:53
Changed
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
constexpr char Align[]
Key for Kernel::Arg::Metadata::mAlign.
constexpr std::underlying_type_t< E > Mask()
Get a bitmask with 1s in all places up to the high-order bit of E's largest value.
@ C
The default llvm calling convention, compatible with C.
Definition CallingConv.h:34
@ BasicBlock
Various leaf nodes.
Definition ISDOpcodes.h:81
LLVM_ABI StringRef getBaseName(ID id)
Return the LLVM name for an intrinsic, without encoded types for overloading, such as "llvm....
OneUse_match< SubPat > m_OneUse(const SubPat &SP)
TwoOps_match< ValueOpTy, PointerOpTy, Instruction::Store > m_Store(const ValueOpTy &ValueOp, const PointerOpTy &PointerOp)
Matches StoreInst.
BinaryOp_match< LHS, RHS, Instruction::Add > m_Add(const LHS &L, const RHS &R)
class_match< BinaryOperator > m_BinOp()
Match an arbitrary binary operation and ignore it.
specific_intval< false > m_SpecificInt(const APInt &V)
Match a specific integer value or vector with all elements equal to the value.
BinaryOp_match< LHS, RHS, Instruction::FMul > m_FMul(const LHS &L, const RHS &R)
bool match(Val *V, const Pattern &P)
specificval_ty m_Specific(const Value *V)
Match if we have a specific specified value.
class_match< ConstantInt > m_ConstantInt()
Match an arbitrary ConstantInt and ignore it.
IntrinsicID_match m_Intrinsic()
Match intrinsic calls like this: m_Intrinsic<Intrinsic::fabs>(m_Value(X))
BinaryOp_match< LHS, RHS, Instruction::FAdd > m_FAdd(const LHS &L, const RHS &R)
BinaryOp_match< LHS, RHS, Instruction::Mul > m_Mul(const LHS &L, const RHS &R)
OneOps_match< OpTy, Instruction::Load > m_Load(const OpTy &Op)
Matches LoadInst.
class_match< Value > m_Value()
Match an arbitrary value and ignore it.
match_combine_or< LTy, RTy > m_CombineOr(const LTy &L, const RTy &R)
Combine two pattern matchers matching L || R.
ValuesClass values(OptsTy... Options)
Helper to build a ValuesClass by forwarding a variable number of arguments as an initializer list to ...
initializer< Ty > init(const Ty &Val)
ElementType
The element type of an SRV or UAV resource.
Definition DXILABI.h:68
DiagnosticInfoOptimizationBase::Argument NV
NodeAddr< PhiNode * > Phi
Definition RDFGraph.h:390
friend class Instruction
Iterator for Instructions in a `BasicBlock.
Definition BasicBlock.h:73
This is an optimization pass for GlobalISel generic memory operations.
auto drop_begin(T &&RangeOrContainer, size_t N=1)
Return a range covering RangeOrContainer with the first N elements excluded.
Definition STLExtras.h:316
void dump(const SparseBitVector< ElementSize > &LHS, raw_ostream &out)
@ Offset
Definition DWP.cpp:532
FunctionAddr VTableAddr Value
Definition InstrProf.h:137
void fill(R &&Range, T &&Value)
Provide wrappers to std::fill which take ranges instead of having to pass begin/end explicitly.
Definition STLExtras.h:1759
cl::opt< bool > ProfcheckDisableMetadataFixes
Definition LoopInfo.cpp:60
auto size(R &&Range, std::enable_if_t< std::is_base_of< std::random_access_iterator_tag, typename std::iterator_traits< decltype(Range.begin())>::iterator_category >::value, void > *=nullptr)
Get the size of a range.
Definition STLExtras.h:1669
detail::zippy< detail::zip_first, T, U, Args... > zip_equal(T &&t, U &&u, Args &&...args)
zip iterator that assumes that all iteratees have the same length.
Definition STLExtras.h:841
auto enumerate(FirstRange &&First, RestRanges &&...Rest)
Given two or more input ranges, returns a new range whose values are tuples (A, B,...
Definition STLExtras.h:2554
LLVM_ABI void setExplicitlyUnknownBranchWeightsIfProfiled(Instruction &I, StringRef PassName, const Function *F=nullptr)
Like setExplicitlyUnknownBranchWeights(...), but only sets unknown branch weights in the new instruct...
decltype(auto) dyn_cast(const From &Val)
dyn_cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:643
auto successors(const MachineBasicBlock *BB)
scope_exit(Callable) -> scope_exit< Callable >
bool operator!=(uint64_t V1, const APInt &V2)
Definition APInt.h:2131
iterator_range< T > make_range(T x, T y)
Convenience function for iterating over sub-ranges.
LLVM_ATTRIBUTE_ALWAYS_INLINE DynamicAPInt & operator+=(DynamicAPInt &A, int64_t B)
iterator_range< early_inc_iterator_impl< detail::IterOfRange< RangeT > > > make_early_inc_range(RangeT &&Range)
Make a range that does early increment to allow mutation of the underlying range without disrupting i...
Definition STLExtras.h:634
LLVM_ABI Value * concatenateVectors(IRBuilderBase &Builder, ArrayRef< Value * > Vecs)
Concatenate a list of vectors.
bool operator==(const AddressRangeValuePair &LHS, const AddressRangeValuePair &RHS)
const Value * getPointerOperand(const Value *V)
A helper function that returns the pointer operand of a load, store or GEP instruction.
LLVM_ABI void addStringMetadataToLoop(Loop *TheLoop, const char *MDString, unsigned V=0)
Set input string into loop metadata by keeping other values intact.
bool any_of(R &&range, UnaryPredicate P)
Provide wrappers to std::any_of which take ranges instead of having to pass begin/end explicitly.
Definition STLExtras.h:1746
auto reverse(ContainerTy &&C)
Definition STLExtras.h:408
void sort(IteratorTy Start, IteratorTy End)
Definition STLExtras.h:1636
LLVM_ABI raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
Definition Debug.cpp:207
LLVM_ABI void report_fatal_error(Error Err, bool gen_crash_diag=true)
Definition Error.cpp:163
FunctionAddr VTableAddr Count
Definition InstrProf.h:139
class LLVM_GSL_OWNER SmallVector
Forward declaration of SmallVector so that calculateSmallVectorDefaultInlinedElements can reference s...
bool isa(const From &Val)
isa<X> - Return true if the parameter to the template is an instance of one of the template type argu...
Definition Casting.h:547
LLVM_ABI raw_fd_ostream & errs()
This returns a reference to a raw_ostream for standard error.
TargetTransformInfo TTI
IRBuilder(LLVMContext &, FolderTy, InserterTy, MDNode *, ArrayRef< OperandBundleDef >) -> IRBuilder< FolderTy, InserterTy >
@ Mul
Product of integers.
@ Add
Sum of integers.
LLVM_ABI BasicBlock * SplitBlock(BasicBlock *Old, BasicBlock::iterator SplitPt, DominatorTree *DT, LoopInfo *LI=nullptr, MemorySSAUpdater *MSSAU=nullptr, const Twine &BBName="")
Split the specified block at the specified instruction.
DWARFExpression::Operation Op
raw_ostream & operator<<(raw_ostream &OS, const APFixedPoint &FX)
ArrayRef(const T &OneElt) -> ArrayRef< T >
OutputIt copy(R &&Range, OutputIt Out)
Definition STLExtras.h:1885
LLVM_ABI Error write(MCStreamer &Out, ArrayRef< std::string > Inputs, OnCuIndexOverflow OverflowOptValue, Dwarf64StrOffsetsPromotion StrOffsetsOptValue)
Definition DWP.cpp:677
decltype(auto) cast(const From &Val)
cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:559
Align commonAlignment(Align A, uint64_t Offset)
Returns the alignment that satisfies both alignments.
Definition Alignment.h:201
AnalysisManager< Function > FunctionAnalysisManager
Convenience typedef for the Function analysis manager.
LLVM_ABI const Value * getUnderlyingObject(const Value *V, unsigned MaxLookup=MaxLookupSearchDepth)
This method strips off any GEP address adjustments, pointer casts or llvm.threadlocal....
AAResults AliasAnalysis
Temporary typedef for legacy code that uses a generic AliasAnalysis pointer or reference.
LLVM_ABI llvm::SmallVector< int, 16 > createSequentialMask(unsigned Start, unsigned NumInts, unsigned NumUndefs)
Create a sequential shuffle mask.
void swap(llvm::BitVector &LHS, llvm::BitVector &RHS)
Implement std::swap in terms of BitVector swap.
Definition BitVector.h:872
#define N
A CRTP mix-in to automatically provide informational APIs needed for passes.
Definition PassManager.h:70