1 //===- AssumeBundleQueries.cpp - tool to query assume bundles ---*- 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 #include "llvm/Analysis/AssumeBundleQueries.h" 10 #include "llvm/Analysis/AssumptionCache.h" 11 #include "llvm/Analysis/ValueTracking.h" 12 #include "llvm/IR/Function.h" 13 #include "llvm/IR/InstIterator.h" 14 #include "llvm/IR/IntrinsicInst.h" 15 #include "llvm/IR/PatternMatch.h" 16 17 using namespace llvm; 18 using namespace llvm::PatternMatch; 19 20 static bool bundleHasArgument(const CallBase::BundleOpInfo &BOI, unsigned Idx) { 21 return BOI.End - BOI.Begin > Idx; 22 } 23 24 static Value *getValueFromBundleOpInfo(CallInst &Assume, 25 const CallBase::BundleOpInfo &BOI, 26 unsigned Idx) { 27 assert(bundleHasArgument(BOI, Idx) && "index out of range"); 28 return (Assume.op_begin() + BOI.Begin + Idx)->get(); 29 } 30 31 bool llvm::hasAttributeInAssume(CallInst &AssumeCI, Value *IsOn, 32 StringRef AttrName, uint64_t *ArgVal) { 33 assert(isa<IntrinsicInst>(AssumeCI) && 34 "this function is intended to be used on llvm.assume"); 35 IntrinsicInst &Assume = cast<IntrinsicInst>(AssumeCI); 36 assert(Assume.getIntrinsicID() == Intrinsic::assume && 37 "this function is intended to be used on llvm.assume"); 38 assert(Attribute::isExistingAttribute(AttrName) && 39 "this attribute doesn't exist"); 40 assert((ArgVal == nullptr || Attribute::doesAttrKindHaveArgument( 41 Attribute::getAttrKindFromName(AttrName))) && 42 "requested value for an attribute that has no argument"); 43 if (Assume.bundle_op_infos().empty()) 44 return false; 45 46 for (auto &BOI : Assume.bundle_op_infos()) { 47 if (BOI.Tag->getKey() != AttrName) 48 continue; 49 if (IsOn && (BOI.End - BOI.Begin <= ABA_WasOn || 50 IsOn != getValueFromBundleOpInfo(Assume, BOI, ABA_WasOn))) 51 continue; 52 if (ArgVal) { 53 assert(BOI.End - BOI.Begin > ABA_Argument); 54 *ArgVal = 55 cast<ConstantInt>(getValueFromBundleOpInfo(Assume, BOI, ABA_Argument)) 56 ->getZExtValue(); 57 } 58 return true; 59 } 60 return false; 61 } 62 63 void llvm::fillMapFromAssume(CallInst &AssumeCI, RetainedKnowledgeMap &Result) { 64 IntrinsicInst &Assume = cast<IntrinsicInst>(AssumeCI); 65 assert(Assume.getIntrinsicID() == Intrinsic::assume && 66 "this function is intended to be used on llvm.assume"); 67 for (auto &Bundles : Assume.bundle_op_infos()) { 68 std::pair<Value *, Attribute::AttrKind> Key{ 69 nullptr, Attribute::getAttrKindFromName(Bundles.Tag->getKey())}; 70 if (bundleHasArgument(Bundles, ABA_WasOn)) 71 Key.first = getValueFromBundleOpInfo(Assume, Bundles, ABA_WasOn); 72 73 if (Key.first == nullptr && Key.second == Attribute::None) 74 continue; 75 if (!bundleHasArgument(Bundles, ABA_Argument)) { 76 Result[Key][&Assume] = {0, 0}; 77 continue; 78 } 79 unsigned Val = cast<ConstantInt>( 80 getValueFromBundleOpInfo(Assume, Bundles, ABA_Argument)) 81 ->getZExtValue(); 82 auto Lookup = Result.find(Key); 83 if (Lookup == Result.end() || !Lookup->second.count(&Assume)) { 84 Result[Key][&Assume] = {Val, Val}; 85 continue; 86 } 87 Lookup->second[&Assume].Min = std::min(Val, Lookup->second[&Assume].Min); 88 Lookup->second[&Assume].Max = std::max(Val, Lookup->second[&Assume].Max); 89 } 90 } 91 92 RetainedKnowledge 93 llvm::getKnowledgeFromBundle(CallInst &Assume, 94 const CallBase::BundleOpInfo &BOI) { 95 RetainedKnowledge Result; 96 Result.AttrKind = Attribute::getAttrKindFromName(BOI.Tag->getKey()); 97 if (bundleHasArgument(BOI, ABA_WasOn)) 98 Result.WasOn = getValueFromBundleOpInfo(Assume, BOI, ABA_WasOn); 99 if (BOI.End - BOI.Begin > ABA_Argument) 100 Result.ArgValue = 101 cast<ConstantInt>(getValueFromBundleOpInfo(Assume, BOI, ABA_Argument)) 102 ->getZExtValue(); 103 return Result; 104 } 105 106 RetainedKnowledge llvm::getKnowledgeFromOperandInAssume(CallInst &AssumeCI, 107 unsigned Idx) { 108 IntrinsicInst &Assume = cast<IntrinsicInst>(AssumeCI); 109 assert(Assume.getIntrinsicID() == Intrinsic::assume && 110 "this function is intended to be used on llvm.assume"); 111 CallBase::BundleOpInfo BOI = Assume.getBundleOpInfoForOperand(Idx); 112 return getKnowledgeFromBundle(AssumeCI, BOI); 113 } 114 115 bool llvm::isAssumeWithEmptyBundle(CallInst &CI) { 116 IntrinsicInst &Assume = cast<IntrinsicInst>(CI); 117 assert(Assume.getIntrinsicID() == Intrinsic::assume && 118 "this function is intended to be used on llvm.assume"); 119 return none_of(Assume.bundle_op_infos(), 120 [](const CallBase::BundleOpInfo &BOI) { 121 return BOI.Tag->getKey() != IgnoreBundleTag; 122 }); 123 } 124 125 static CallInst::BundleOpInfo *getBundleFromUse(const Use *U) { 126 auto *Intr = dyn_cast<IntrinsicInst>(U->getUser()); 127 if (!match(U->getUser(), 128 m_Intrinsic<Intrinsic::assume>(m_Unless(m_Specific(U->get()))))) 129 return nullptr; 130 return &Intr->getBundleOpInfoForOperand(U->getOperandNo()); 131 } 132 133 RetainedKnowledge 134 llvm::getKnowledgeFromUse(const Use *U, 135 ArrayRef<Attribute::AttrKind> AttrKinds) { 136 CallInst::BundleOpInfo* Bundle = getBundleFromUse(U); 137 if (!Bundle) 138 return RetainedKnowledge::none(); 139 RetainedKnowledge RK = 140 getKnowledgeFromBundle(*cast<CallInst>(U->getUser()), *Bundle); 141 for (auto Attr : AttrKinds) 142 if (Attr == RK.AttrKind) 143 return RK; 144 return RetainedKnowledge::none(); 145 } 146 147 RetainedKnowledge 148 llvm::getKnowledgeForValue(const Value *V, 149 ArrayRef<Attribute::AttrKind> AttrKinds, 150 AssumptionCache *AC, 151 function_ref<bool(RetainedKnowledge, Instruction *, 152 const CallBase::BundleOpInfo *)> 153 Filter) { 154 if (AC) { 155 for (AssumptionCache::ResultElem &Elem : AC->assumptionsFor(V)) { 156 IntrinsicInst *II = cast_or_null<IntrinsicInst>(Elem.Assume); 157 if (!II || Elem.Index == AssumptionCache::ExprResultIdx) 158 continue; 159 if (RetainedKnowledge RK = getKnowledgeFromBundle( 160 *II, II->bundle_op_info_begin()[Elem.Index])) 161 if (is_contained(AttrKinds, RK.AttrKind) && 162 Filter(RK, II, &II->bundle_op_info_begin()[Elem.Index])) 163 return RK; 164 } 165 return RetainedKnowledge::none(); 166 } 167 for (auto &U : V->uses()) { 168 CallInst::BundleOpInfo* Bundle = getBundleFromUse(&U); 169 if (!Bundle) 170 continue; 171 if (RetainedKnowledge RK = 172 getKnowledgeFromBundle(*cast<CallInst>(U.getUser()), *Bundle)) 173 if (is_contained(AttrKinds, RK.AttrKind) && 174 Filter(RK, cast<Instruction>(U.getUser()), Bundle)) 175 return RK; 176 } 177 return RetainedKnowledge::none(); 178 } 179 180 RetainedKnowledge llvm::getKnowledgeValidInContext( 181 const Value *V, ArrayRef<Attribute::AttrKind> AttrKinds, 182 const Instruction *CtxI, const DominatorTree *DT, AssumptionCache *AC) { 183 return getKnowledgeForValue(V, AttrKinds, AC, 184 [&](auto, Instruction *I, auto) { 185 return isValidAssumeForContext(I, CtxI, DT); 186 }); 187 } 188