| 1 | //===- StridedMetadataRangeAnalysis.cpp - Integer range analysis --------*- C++ |
| 2 | //-*-===// |
| 3 | // |
| 4 | // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. |
| 5 | // See https://llvm.org/LICENSE.txt for license information. |
| 6 | // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception |
| 7 | // |
| 8 | //===----------------------------------------------------------------------===// |
| 9 | // |
| 10 | // This file defines the dataflow analysis class for integer range inference |
| 11 | // which is used in transformations over the `arith` dialect such as |
| 12 | // branch elimination or signed->unsigned rewriting |
| 13 | // |
| 14 | //===----------------------------------------------------------------------===// |
| 15 | |
| 16 | #include "mlir/Analysis/DataFlow/StridedMetadataRangeAnalysis.h" |
| 17 | #include "mlir/Analysis/DataFlow/IntegerRangeAnalysis.h" |
| 18 | #include "mlir/Dialect/Utils/IndexingUtils.h" |
| 19 | #include "mlir/IR/Operation.h" |
| 20 | #include "mlir/IR/Value.h" |
| 21 | #include "mlir/Support/DebugStringHelper.h" |
| 22 | #include "llvm/Support/Debug.h" |
| 23 | #include "llvm/Support/DebugLog.h" |
| 24 | |
| 25 | #define DEBUG_TYPE "strided-metadata-range-analysis" |
| 26 | |
| 27 | using namespace mlir; |
| 28 | using namespace mlir::dataflow; |
| 29 | |
| 30 | /// Get the entry state for a value. For any value that is not a ranked memref, |
| 31 | /// this function sets the metadata to a top state with no offsets, sizes, or |
| 32 | /// strides. For `memref` types, this function will use the metadata in the type |
| 33 | /// to try to deduce as much informaiton as possible. |
| 34 | static StridedMetadataRange getEntryStateImpl(Value v, int32_t indexBitwidth) { |
| 35 | // TODO: generalize this method with a type interface. |
| 36 | auto mTy = dyn_cast<BaseMemRefType>(Val: v.getType()); |
| 37 | |
| 38 | // If not a memref or it's un-ranked, don't infer any metadata. |
| 39 | if (!mTy || !mTy.hasRank()) |
| 40 | return StridedMetadataRange::getMaxRanges(indexBitwidth, offsetsRank: 0, sizeRank: 0, stridedRank: 0); |
| 41 | |
| 42 | // Get the top state. |
| 43 | auto metadata = |
| 44 | StridedMetadataRange::getMaxRanges(indexBitwidth, rank: mTy.getRank()); |
| 45 | |
| 46 | // Compute the offset and strides. |
| 47 | int64_t offset; |
| 48 | SmallVector<int64_t> strides; |
| 49 | if (failed(Result: cast<MemRefType>(Val&: mTy).getStridesAndOffset(strides, offset))) |
| 50 | return metadata; |
| 51 | |
| 52 | // Refine the metadata if we know it from the type. |
| 53 | if (!ShapedType::isDynamic(dValue: offset)) { |
| 54 | metadata.getOffsets()[0] = |
| 55 | ConstantIntRanges::constant(value: APInt(indexBitwidth, offset)); |
| 56 | } |
| 57 | for (auto &&[size, range] : |
| 58 | llvm::zip_equal(t: mTy.getShape(), u: metadata.getSizes())) { |
| 59 | if (ShapedType::isDynamic(dValue: size)) |
| 60 | continue; |
| 61 | range = ConstantIntRanges::constant(value: APInt(indexBitwidth, size)); |
| 62 | } |
| 63 | for (auto &&[stride, range] : |
| 64 | llvm::zip_equal(t&: strides, u: metadata.getStrides())) { |
| 65 | if (ShapedType::isDynamic(dValue: stride)) |
| 66 | continue; |
| 67 | range = ConstantIntRanges::constant(value: APInt(indexBitwidth, stride)); |
| 68 | } |
| 69 | |
| 70 | return metadata; |
| 71 | } |
| 72 | |
| 73 | StridedMetadataRangeAnalysis::StridedMetadataRangeAnalysis( |
| 74 | DataFlowSolver &solver, int32_t indexBitwidth) |
| 75 | : SparseForwardDataFlowAnalysis(solver), indexBitwidth(indexBitwidth) { |
| 76 | assert(indexBitwidth > 0 && "invalid bitwidth" ); |
| 77 | } |
| 78 | |
| 79 | void StridedMetadataRangeAnalysis::setToEntryState( |
| 80 | StridedMetadataRangeLattice *lattice) { |
| 81 | propagateIfChanged(state: lattice, changed: lattice->join(rhs: getEntryStateImpl( |
| 82 | v: lattice->getAnchor(), indexBitwidth))); |
| 83 | } |
| 84 | |
| 85 | LogicalResult StridedMetadataRangeAnalysis::visitOperation( |
| 86 | Operation *op, ArrayRef<const StridedMetadataRangeLattice *> operands, |
| 87 | ArrayRef<StridedMetadataRangeLattice *> results) { |
| 88 | auto inferrable = dyn_cast<InferStridedMetadataOpInterface>(Val: op); |
| 89 | |
| 90 | // Bail if we cannot reason about the op. |
| 91 | if (!inferrable) { |
| 92 | setAllToEntryStates(results); |
| 93 | return success(); |
| 94 | } |
| 95 | |
| 96 | LDBG() << "Inferring metadata for: " |
| 97 | << OpWithFlags(op, OpPrintingFlags().skipRegions()); |
| 98 | |
| 99 | // Helper function to retrieve int range values. |
| 100 | auto getIntRange = [&](Value value) -> IntegerValueRange { |
| 101 | auto lattice = getOrCreateFor<IntegerValueRangeLattice>( |
| 102 | dependent: getProgramPointAfter(op), anchor: value); |
| 103 | return lattice ? lattice->getValue() : IntegerValueRange(); |
| 104 | }; |
| 105 | |
| 106 | // Convert the arguments lattices to a vector. |
| 107 | SmallVector<StridedMetadataRange> argRanges = llvm::map_to_vector( |
| 108 | C&: operands, F: [](const StridedMetadataRangeLattice *lattice) { |
| 109 | return lattice->getValue(); |
| 110 | }); |
| 111 | |
| 112 | // Callback to set metadata on a result. |
| 113 | auto joinCallback = [&](Value v, const StridedMetadataRange &md) { |
| 114 | auto result = cast<OpResult>(Val&: v); |
| 115 | assert(llvm::is_contained(op->getResults(), result)); |
| 116 | LDBG() << "- Inferred metadata: " << md; |
| 117 | StridedMetadataRangeLattice *lattice = results[result.getResultNumber()]; |
| 118 | ChangeResult changed = lattice->join(rhs: md); |
| 119 | LDBG() << "- Joined metadata: " << lattice->getValue(); |
| 120 | propagateIfChanged(state: lattice, changed); |
| 121 | }; |
| 122 | |
| 123 | // Infer the metadata. |
| 124 | inferrable.inferStridedMetadataRanges(operands: argRanges, getIntRange, setMetadata: joinCallback, |
| 125 | indexBitwidth); |
| 126 | return success(); |
| 127 | } |
| 128 | |