LLVM 24.0.0git
AttributorAttributes.cpp
Go to the documentation of this file.
1//===- AttributorAttributes.cpp - Attributes for Attributor deduction -----===//
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// See the Attributor.h file comment and the class descriptions in that file for
10// more information.
11//
12//===----------------------------------------------------------------------===//
13
15
16#include "llvm/ADT/APInt.h"
17#include "llvm/ADT/ArrayRef.h"
18#include "llvm/ADT/DenseMap.h"
20#include "llvm/ADT/MapVector.h"
22#include "llvm/ADT/STLExtras.h"
24#include "llvm/ADT/SetVector.h"
27#include "llvm/ADT/Statistic.h"
40#include "llvm/IR/Argument.h"
41#include "llvm/IR/Assumptions.h"
42#include "llvm/IR/Attributes.h"
43#include "llvm/IR/BasicBlock.h"
44#include "llvm/IR/Constant.h"
45#include "llvm/IR/Constants.h"
46#include "llvm/IR/DataLayout.h"
48#include "llvm/IR/GlobalValue.h"
49#include "llvm/IR/IRBuilder.h"
50#include "llvm/IR/InlineAsm.h"
51#include "llvm/IR/InstrTypes.h"
52#include "llvm/IR/Instruction.h"
55#include "llvm/IR/IntrinsicsAMDGPU.h"
56#include "llvm/IR/IntrinsicsNVPTX.h"
57#include "llvm/IR/LLVMContext.h"
58#include "llvm/IR/MDBuilder.h"
59#include "llvm/IR/NoFolder.h"
60#include "llvm/IR/Value.h"
61#include "llvm/IR/ValueHandle.h"
76#include <cassert>
77#include <numeric>
78#include <optional>
79#include <string>
80
81using namespace llvm;
82
83#define DEBUG_TYPE "attributor"
84
86 "attributor-manifest-internal", cl::Hidden,
87 cl::desc("Manifest Attributor internal string attributes."),
88 cl::init(false));
89
90static cl::opt<int> MaxHeapToStackSize("max-heap-to-stack-size", cl::init(128),
92
93template <>
95
97
99 "attributor-max-potential-values", cl::Hidden,
100 cl::desc("Maximum number of potential values to be "
101 "tracked for each position."),
103 cl::init(7));
104
106 "attributor-max-potential-values-iterations", cl::Hidden,
107 cl::desc(
108 "Maximum number of iterations we keep dismantling potential values."),
109 cl::init(64));
110
111STATISTIC(NumAAs, "Number of abstract attributes created");
112STATISTIC(NumIndirectCallsPromoted, "Number of indirect calls promoted");
113
114// Some helper macros to deal with statistics tracking.
115//
116// Usage:
117// For simple IR attribute tracking overload trackStatistics in the abstract
118// attribute and choose the right STATS_DECLTRACK_********* macro,
119// e.g.,:
120// void trackStatistics() const override {
121// STATS_DECLTRACK_ARG_ATTR(returned)
122// }
123// If there is a single "increment" side one can use the macro
124// STATS_DECLTRACK with a custom message. If there are multiple increment
125// sides, STATS_DECL and STATS_TRACK can also be used separately.
126//
127#define BUILD_STAT_MSG_IR_ATTR(TYPE, NAME) \
128 ("Number of " #TYPE " marked '" #NAME "'")
129#define BUILD_STAT_NAME(NAME, TYPE) NumIR##TYPE##_##NAME
130#define STATS_DECL_(NAME, MSG) STATISTIC(NAME, MSG);
131#define STATS_DECL(NAME, TYPE, MSG) \
132 STATS_DECL_(BUILD_STAT_NAME(NAME, TYPE), MSG);
133#define STATS_TRACK(NAME, TYPE) ++(BUILD_STAT_NAME(NAME, TYPE));
134#define STATS_DECLTRACK(NAME, TYPE, MSG) \
135 {STATS_DECL(NAME, TYPE, MSG) STATS_TRACK(NAME, TYPE)}
136#define STATS_DECLTRACK_ARG_ATTR(NAME) \
137 STATS_DECLTRACK(NAME, Arguments, BUILD_STAT_MSG_IR_ATTR(arguments, NAME))
138#define STATS_DECLTRACK_CSARG_ATTR(NAME) \
139 STATS_DECLTRACK(NAME, CSArguments, \
140 BUILD_STAT_MSG_IR_ATTR(call site arguments, NAME))
141#define STATS_DECLTRACK_FN_ATTR(NAME) \
142 STATS_DECLTRACK(NAME, Function, BUILD_STAT_MSG_IR_ATTR(functions, NAME))
143#define STATS_DECLTRACK_CS_ATTR(NAME) \
144 STATS_DECLTRACK(NAME, CS, BUILD_STAT_MSG_IR_ATTR(call site, NAME))
145#define STATS_DECLTRACK_FNRET_ATTR(NAME) \
146 STATS_DECLTRACK(NAME, FunctionReturn, \
147 BUILD_STAT_MSG_IR_ATTR(function returns, NAME))
148#define STATS_DECLTRACK_CSRET_ATTR(NAME) \
149 STATS_DECLTRACK(NAME, CSReturn, \
150 BUILD_STAT_MSG_IR_ATTR(call site returns, NAME))
151#define STATS_DECLTRACK_FLOATING_ATTR(NAME) \
152 STATS_DECLTRACK(NAME, Floating, \
153 ("Number of floating values known to be '" #NAME "'"))
154
155// Specialization of the operator<< for abstract attributes subclasses. This
156// disambiguates situations where multiple operators are applicable.
157namespace llvm {
158#define PIPE_OPERATOR(CLASS) \
159 raw_ostream &operator<<(raw_ostream &OS, const CLASS &AA) { \
160 return OS << static_cast<const AbstractAttribute &>(AA); \
161 }
162
202
203#undef PIPE_OPERATOR
204
205template <>
207 const DerefState &R) {
208 ChangeStatus CS0 =
209 clampStateAndIndicateChange(S.DerefBytesState, R.DerefBytesState);
210 ChangeStatus CS1 = clampStateAndIndicateChange(S.GlobalState, R.GlobalState);
211 return CS0 | CS1;
212}
213
214} // namespace llvm
215
216static bool mayBeInCycle(const CycleInfo *CI, const Instruction *I,
217 bool HeaderOnly, CycleRef *CPtr = nullptr) {
218 if (!CI)
219 return true;
220 auto *BB = I->getParent();
221 CycleRef C = CI->getCycle(BB);
222 if (!C)
223 return false;
224 if (CPtr)
225 *CPtr = C;
226 return !HeaderOnly || BB == CI->getHeader(C);
227}
228
229/// Checks if a type could have padding bytes.
230static bool isDenselyPacked(Type *Ty, const DataLayout &DL) {
231 // There is no size information, so be conservative.
232 if (!Ty->isSized())
233 return false;
234
235 // If the alloc size is not equal to the storage size, then there are padding
236 // bytes. For x86_fp80 on x86-64, size: 80 alloc size: 128.
237 if (DL.getTypeSizeInBits(Ty) != DL.getTypeAllocSizeInBits(Ty))
238 return false;
239
240 // FIXME: This isn't the right way to check for padding in vectors with
241 // non-byte-size elements.
242 if (VectorType *SeqTy = dyn_cast<VectorType>(Ty))
243 return isDenselyPacked(SeqTy->getElementType(), DL);
244
245 // For array types, check for padding within members.
246 if (ArrayType *SeqTy = dyn_cast<ArrayType>(Ty))
247 return isDenselyPacked(SeqTy->getElementType(), DL);
248
249 if (!isa<StructType>(Ty))
250 return true;
251
252 // Check for padding within and between elements of a struct.
253 StructType *StructTy = cast<StructType>(Ty);
254 const StructLayout *Layout = DL.getStructLayout(StructTy);
255 uint64_t StartPos = 0;
256 for (unsigned I = 0, E = StructTy->getNumElements(); I < E; ++I) {
257 Type *ElTy = StructTy->getElementType(I);
258 if (!isDenselyPacked(ElTy, DL))
259 return false;
260 if (StartPos != Layout->getElementOffsetInBits(I))
261 return false;
262 StartPos += DL.getTypeAllocSizeInBits(ElTy);
263 }
264
265 return true;
266}
267
268/// Get pointer operand of memory accessing instruction. If \p I is
269/// not a memory accessing instruction, return nullptr. If \p AllowVolatile,
270/// is set to false and the instruction is volatile, return nullptr.
272 bool AllowVolatile) {
273 if (!AllowVolatile && I->isVolatile())
274 return nullptr;
275
276 if (auto *LI = dyn_cast<LoadInst>(I)) {
277 return LI->getPointerOperand();
278 }
279
280 if (auto *SI = dyn_cast<StoreInst>(I)) {
281 return SI->getPointerOperand();
282 }
283
284 if (auto *CXI = dyn_cast<AtomicCmpXchgInst>(I)) {
285 return CXI->getPointerOperand();
286 }
287
288 if (auto *RMWI = dyn_cast<AtomicRMWInst>(I)) {
289 return RMWI->getPointerOperand();
290 }
291
292 return nullptr;
293}
294
295/// Helper function to create a pointer based on \p Ptr, and advanced by \p
296/// Offset bytes.
297static Value *constructPointer(Value *Ptr, int64_t Offset,
298 IRBuilder<NoFolder> &IRB) {
299 LLVM_DEBUG(dbgs() << "Construct pointer: " << *Ptr << " + " << Offset
300 << "-bytes\n");
301
302 if (Offset)
303 Ptr = IRB.CreatePtrAdd(Ptr, IRB.getInt64(Offset),
304 Ptr->getName() + ".b" + Twine(Offset));
305 return Ptr;
306}
307
308static const Value *
310 const Value *Val, const DataLayout &DL, APInt &Offset,
311 bool GetMinOffset, bool AllowNonInbounds,
312 bool UseAssumed = false) {
313
314 auto AttributorAnalysis = [&](Value &V, APInt &ROffset) -> bool {
315 const IRPosition &Pos = IRPosition::value(V);
316 // Only track dependence if we are going to use the assumed info.
317 const AAValueConstantRange *ValueConstantRangeAA =
318 A.getAAFor<AAValueConstantRange>(QueryingAA, Pos,
319 UseAssumed ? DepClassTy::OPTIONAL
321 if (!ValueConstantRangeAA)
322 return false;
323 ConstantRange Range = UseAssumed ? ValueConstantRangeAA->getAssumed()
324 : ValueConstantRangeAA->getKnown();
325 if (Range.isFullSet())
326 return false;
327
328 // We can only use the lower part of the range because the upper part can
329 // be higher than what the value can really be.
330 if (GetMinOffset)
331 ROffset = Range.getSignedMin();
332 else
333 ROffset = Range.getSignedMax();
334 return true;
335 };
336
337 return Val->stripAndAccumulateConstantOffsets(DL, Offset, AllowNonInbounds,
338 /* AllowInvariant */ true,
339 AttributorAnalysis);
340}
341
342static const Value *
344 const Value *Ptr, int64_t &BytesOffset,
345 const DataLayout &DL, bool AllowNonInbounds = false) {
346 APInt OffsetAPInt(DL.getIndexTypeSizeInBits(Ptr->getType()), 0);
347 const Value *Base =
348 stripAndAccumulateOffsets(A, QueryingAA, Ptr, DL, OffsetAPInt,
349 /* GetMinOffset */ true, AllowNonInbounds);
350
351 BytesOffset = OffsetAPInt.getSExtValue();
352 return Base;
353}
354
355/// Clamp the information known for all returned values of a function
356/// (identified by \p QueryingAA) into \p S.
357template <typename AAType, typename StateType = typename AAType::StateType,
358 Attribute::AttrKind IRAttributeKind = AAType::IRAttributeKind,
359 bool RecurseForSelectAndPHI = true>
361 Attributor &A, const AAType &QueryingAA, StateType &S,
362 const IRPosition::CallBaseContext *CBContext = nullptr) {
363 LLVM_DEBUG(dbgs() << "[Attributor] Clamp return value states for "
364 << QueryingAA << " into " << S << "\n");
365
366 assert((QueryingAA.getIRPosition().getPositionKind() ==
368 QueryingAA.getIRPosition().getPositionKind() ==
370 "Can only clamp returned value states for a function returned or call "
371 "site returned position!");
372
373 // Use an optional state as there might not be any return values and we want
374 // to join (IntegerState::operator&) the state of all there are.
375 std::optional<StateType> T;
376
377 // Callback for each possibly returned value.
378 auto CheckReturnValue = [&](Value &RV) -> bool {
379 const IRPosition &RVPos = IRPosition::value(RV, CBContext);
380 // If possible, use the hasAssumedIRAttr interface.
381 if (Attribute::isEnumAttrKind(IRAttributeKind)) {
382 bool IsKnown;
384 A, &QueryingAA, RVPos, DepClassTy::REQUIRED, IsKnown);
385 }
386
387 const AAType *AA =
388 A.getAAFor<AAType>(QueryingAA, RVPos, DepClassTy::REQUIRED);
389 if (!AA)
390 return false;
391 LLVM_DEBUG(dbgs() << "[Attributor] RV: " << RV
392 << " AA: " << AA->getAsStr(&A) << " @ " << RVPos << "\n");
393 const StateType &AAS = AA->getState();
394 if (!T)
395 T = StateType::getBestState(AAS);
396 *T &= AAS;
397 LLVM_DEBUG(dbgs() << "[Attributor] AA State: " << AAS << " RV State: " << T
398 << "\n");
399 return T->isValidState();
400 };
401
402 if (!A.checkForAllReturnedValues(CheckReturnValue, QueryingAA,
404 RecurseForSelectAndPHI))
405 S.indicatePessimisticFixpoint();
406 else if (T)
407 S ^= *T;
408}
409
410namespace {
411/// Helper class for generic deduction: return value -> returned position.
412template <typename AAType, typename BaseType,
413 typename StateType = typename BaseType::StateType,
414 bool PropagateCallBaseContext = false,
415 Attribute::AttrKind IRAttributeKind = AAType::IRAttributeKind,
416 bool RecurseForSelectAndPHI = true>
417struct AAReturnedFromReturnedValues : public BaseType {
418 AAReturnedFromReturnedValues(const IRPosition &IRP, Attributor &A)
419 : BaseType(IRP, A) {}
420
421 /// See AbstractAttribute::updateImpl(...).
422 ChangeStatus updateImpl(Attributor &A) override {
423 StateType S(StateType::getBestState(this->getState()));
424 clampReturnedValueStates<AAType, StateType, IRAttributeKind,
425 RecurseForSelectAndPHI>(
426 A, *this, S,
427 PropagateCallBaseContext ? this->getCallBaseContext() : nullptr);
428 // TODO: If we know we visited all returned values, thus no are assumed
429 // dead, we can take the known information from the state T.
430 return clampStateAndIndicateChange<StateType>(this->getState(), S);
431 }
432};
433
434/// Clamp the information known at all call sites for a given argument
435/// (identified by \p QueryingAA) into \p S.
436template <typename AAType, typename StateType = typename AAType::StateType,
437 Attribute::AttrKind IRAttributeKind = AAType::IRAttributeKind>
438static void clampCallSiteArgumentStates(Attributor &A, const AAType &QueryingAA,
439 StateType &S) {
440 LLVM_DEBUG(dbgs() << "[Attributor] Clamp call site argument states for "
441 << QueryingAA << " into " << S << "\n");
442
443 assert(QueryingAA.getIRPosition().getPositionKind() ==
445 "Can only clamp call site argument states for an argument position!");
446
447 // Use an optional state as there might not be any return values and we want
448 // to join (IntegerState::operator&) the state of all there are.
449 std::optional<StateType> T;
450
451 // The argument number which is also the call site argument number.
452 unsigned ArgNo = QueryingAA.getIRPosition().getCallSiteArgNo();
453
454 auto CallSiteCheck = [&](AbstractCallSite ACS) {
455 const IRPosition &ACSArgPos = IRPosition::callsite_argument(ACS, ArgNo);
456 // Check if a coresponding argument was found or if it is on not associated
457 // (which can happen for callback calls).
458 if (ACSArgPos.getPositionKind() == IRPosition::IRP_INVALID)
459 return false;
460
461 // If possible, use the hasAssumedIRAttr interface.
462 if (Attribute::isEnumAttrKind(IRAttributeKind)) {
463 bool IsKnown;
465 A, &QueryingAA, ACSArgPos, DepClassTy::REQUIRED, IsKnown);
466 }
467
468 const AAType *AA =
469 A.getAAFor<AAType>(QueryingAA, ACSArgPos, DepClassTy::REQUIRED);
470 if (!AA)
471 return false;
472 LLVM_DEBUG(dbgs() << "[Attributor] ACS: " << *ACS.getInstruction()
473 << " AA: " << AA->getAsStr(&A) << " @" << ACSArgPos
474 << "\n");
475 const StateType &AAS = AA->getState();
476 if (!T)
477 T = StateType::getBestState(AAS);
478 *T &= AAS;
479 LLVM_DEBUG(dbgs() << "[Attributor] AA State: " << AAS << " CSA State: " << T
480 << "\n");
481 return T->isValidState();
482 };
483
484 bool UsedAssumedInformation = false;
485 if (!A.checkForAllCallSites(CallSiteCheck, QueryingAA, true,
486 UsedAssumedInformation))
487 S.indicatePessimisticFixpoint();
488 else if (T)
489 S ^= *T;
490}
491
492/// This function is the bridge between argument position and the call base
493/// context.
494template <typename AAType, typename BaseType,
495 typename StateType = typename AAType::StateType,
496 Attribute::AttrKind IRAttributeKind = AAType::IRAttributeKind>
497bool getArgumentStateFromCallBaseContext(Attributor &A,
498 BaseType &QueryingAttribute,
499 IRPosition &Pos, StateType &State) {
501 "Expected an 'argument' position !");
502 const CallBase *CBContext = Pos.getCallBaseContext();
503 if (!CBContext)
504 return false;
505
506 int ArgNo = Pos.getCallSiteArgNo();
507 assert(ArgNo >= 0 && "Invalid Arg No!");
508 const IRPosition CBArgPos = IRPosition::callsite_argument(*CBContext, ArgNo);
509
510 // If possible, use the hasAssumedIRAttr interface.
511 if (Attribute::isEnumAttrKind(IRAttributeKind)) {
512 bool IsKnown;
514 A, &QueryingAttribute, CBArgPos, DepClassTy::REQUIRED, IsKnown);
515 }
516
517 const auto *AA =
518 A.getAAFor<AAType>(QueryingAttribute, CBArgPos, DepClassTy::REQUIRED);
519 if (!AA)
520 return false;
521 const StateType &CBArgumentState =
522 static_cast<const StateType &>(AA->getState());
523
524 LLVM_DEBUG(dbgs() << "[Attributor] Briding Call site context to argument"
525 << "Position:" << Pos << "CB Arg state:" << CBArgumentState
526 << "\n");
527
528 // NOTE: If we want to do call site grouping it should happen here.
529 State ^= CBArgumentState;
530 return true;
531}
532
533/// Helper class for generic deduction: call site argument -> argument position.
534template <typename AAType, typename BaseType,
535 typename StateType = typename AAType::StateType,
536 bool BridgeCallBaseContext = false,
537 Attribute::AttrKind IRAttributeKind = AAType::IRAttributeKind>
538struct AAArgumentFromCallSiteArguments : public BaseType {
539 AAArgumentFromCallSiteArguments(const IRPosition &IRP, Attributor &A)
540 : BaseType(IRP, A) {}
541
542 /// See AbstractAttribute::updateImpl(...).
543 ChangeStatus updateImpl(Attributor &A) override {
544 StateType S = StateType::getBestState(this->getState());
545
546 if (BridgeCallBaseContext) {
547 bool Success =
548 getArgumentStateFromCallBaseContext<AAType, BaseType, StateType,
549 IRAttributeKind>(
550 A, *this, this->getIRPosition(), S);
551 if (Success)
552 return clampStateAndIndicateChange<StateType>(this->getState(), S);
553 }
554 clampCallSiteArgumentStates<AAType, StateType, IRAttributeKind>(A, *this,
555 S);
556
557 // TODO: If we know we visited all incoming values, thus no are assumed
558 // dead, we can take the known information from the state T.
559 return clampStateAndIndicateChange<StateType>(this->getState(), S);
560 }
561};
562
563/// Helper class for generic replication: function returned -> cs returned.
564template <typename AAType, typename BaseType,
565 typename StateType = typename BaseType::StateType,
566 bool IntroduceCallBaseContext = false,
567 Attribute::AttrKind IRAttributeKind = AAType::IRAttributeKind>
568struct AACalleeToCallSite : public BaseType {
569 AACalleeToCallSite(const IRPosition &IRP, Attributor &A) : BaseType(IRP, A) {}
570
571 /// See AbstractAttribute::updateImpl(...).
572 ChangeStatus updateImpl(Attributor &A) override {
573 auto IRPKind = this->getIRPosition().getPositionKind();
575 IRPKind == IRPosition::IRP_CALL_SITE) &&
576 "Can only wrap function returned positions for call site "
577 "returned positions!");
578 auto &S = this->getState();
579
580 CallBase &CB = cast<CallBase>(this->getAnchorValue());
581 if (IntroduceCallBaseContext)
582 LLVM_DEBUG(dbgs() << "[Attributor] Introducing call base context:" << CB
583 << "\n");
584
585 ChangeStatus Changed = ChangeStatus::UNCHANGED;
586 auto CalleePred = [&](ArrayRef<const Function *> Callees) {
587 for (const Function *Callee : Callees) {
588 IRPosition FnPos =
590 ? IRPosition::returned(*Callee,
591 IntroduceCallBaseContext ? &CB : nullptr)
592 : IRPosition::function(
593 *Callee, IntroduceCallBaseContext ? &CB : nullptr);
594 // If possible, use the hasAssumedIRAttr interface.
595 if (Attribute::isEnumAttrKind(IRAttributeKind)) {
596 bool IsKnown;
598 A, this, FnPos, DepClassTy::REQUIRED, IsKnown))
599 return false;
600 continue;
601 }
602
603 const AAType *AA =
604 A.getAAFor<AAType>(*this, FnPos, DepClassTy::REQUIRED);
605 if (!AA)
606 return false;
607 Changed |= clampStateAndIndicateChange(S, AA->getState());
608 if (S.isAtFixpoint())
609 return S.isValidState();
610 }
611 return true;
612 };
613 if (!A.checkForAllCallees(CalleePred, *this, CB))
614 return S.indicatePessimisticFixpoint();
615 return Changed;
616 }
617};
618
619/// Helper function to accumulate uses.
620template <class AAType, typename StateType = typename AAType::StateType>
621static void followUsesInContext(AAType &AA, Attributor &A,
623 const Instruction *CtxI,
625 StateType &State) {
626 auto EIt = Explorer.begin(CtxI), EEnd = Explorer.end(CtxI);
627 for (unsigned u = 0; u < Uses.size(); ++u) {
628 const Use *U = Uses[u];
629 if (const Instruction *UserI = dyn_cast<Instruction>(U->getUser())) {
630 bool Found = Explorer.findInContextOf(UserI, EIt, EEnd);
631 if (Found && AA.followUseInMBEC(A, U, UserI, State))
632 Uses.insert_range(llvm::make_pointer_range(UserI->uses()));
633 }
634 }
635}
636
637/// Use the must-be-executed-context around \p I to add information into \p S.
638/// The AAType class is required to have `followUseInMBEC` method with the
639/// following signature and behaviour:
640///
641/// bool followUseInMBEC(Attributor &A, const Use *U, const Instruction *I)
642/// U - Underlying use.
643/// I - The user of the \p U.
644/// Returns true if the value should be tracked transitively.
645///
646template <class AAType, typename StateType = typename AAType::StateType>
647static void followUsesInMBEC(AAType &AA, Attributor &A, StateType &S,
648 Instruction &CtxI) {
649 const Value &Val = AA.getIRPosition().getAssociatedValue();
650 if (isa<ConstantData>(Val))
651 return;
652
654 A.getInfoCache().getMustBeExecutedContextExplorer();
655 if (!Explorer)
656 return;
657
658 // Container for (transitive) uses of the associated value.
660 for (const Use &U : Val.uses())
661 Uses.insert(&U);
662
663 followUsesInContext<AAType>(AA, A, *Explorer, &CtxI, Uses, S);
664
665 if (S.isAtFixpoint())
666 return;
667
669 auto Pred = [&](const Instruction *I) {
670 if (const CondBrInst *Br = dyn_cast<CondBrInst>(I))
671 BrInsts.push_back(Br);
672 return true;
673 };
674
675 // Here, accumulate conditional branch instructions in the context. We
676 // explore the child paths and collect the known states. The disjunction of
677 // those states can be merged to its own state. Let ParentState_i be a state
678 // to indicate the known information for an i-th branch instruction in the
679 // context. ChildStates are created for its successors respectively.
680 //
681 // ParentS_1 = ChildS_{1, 1} /\ ChildS_{1, 2} /\ ... /\ ChildS_{1, n_1}
682 // ParentS_2 = ChildS_{2, 1} /\ ChildS_{2, 2} /\ ... /\ ChildS_{2, n_2}
683 // ...
684 // ParentS_m = ChildS_{m, 1} /\ ChildS_{m, 2} /\ ... /\ ChildS_{m, n_m}
685 //
686 // Known State |= ParentS_1 \/ ParentS_2 \/... \/ ParentS_m
687 //
688 // FIXME: Currently, recursive branches are not handled. For example, we
689 // can't deduce that ptr must be dereferenced in below function.
690 //
691 // void f(int a, int c, int *ptr) {
692 // if(a)
693 // if (b) {
694 // *ptr = 0;
695 // } else {
696 // *ptr = 1;
697 // }
698 // else {
699 // if (b) {
700 // *ptr = 0;
701 // } else {
702 // *ptr = 1;
703 // }
704 // }
705 // }
706
707 Explorer->checkForAllContext(&CtxI, Pred);
708 for (const CondBrInst *Br : BrInsts) {
709 StateType ParentState;
710
711 // The known state of the parent state is a conjunction of children's
712 // known states so it is initialized with a best state.
713 ParentState.indicateOptimisticFixpoint();
714
715 for (const BasicBlock *BB : Br->successors()) {
716 StateType ChildState;
717
718 size_t BeforeSize = Uses.size();
719 followUsesInContext(AA, A, *Explorer, &BB->front(), Uses, ChildState);
720
721 // Erase uses which only appear in the child.
722 for (auto It = Uses.begin() + BeforeSize; It != Uses.end();)
723 It = Uses.erase(It);
724
725 ParentState &= ChildState;
726 }
727
728 // Use only known state.
729 S += ParentState;
730 }
731}
732} // namespace
733
734/// ------------------------ PointerInfo ---------------------------------------
735
736namespace llvm {
737namespace AA {
738namespace PointerInfo {
739
740struct State;
741
742} // namespace PointerInfo
743} // namespace AA
744
745/// Helper for AA::PointerInfo::Access DenseMap/Set usage.
746template <>
749 static unsigned getHashValue(const Access &A);
750 static bool isEqual(const Access &LHS, const Access &RHS);
751};
752
753/// Helper that allows RangeTy as a key in a DenseMap.
754template <> struct DenseMapInfo<AA::RangeTy> {
760
761 static bool isEqual(const AA::RangeTy &A, const AA::RangeTy B) {
762 return A == B;
763 }
764};
765
766} // namespace llvm
767
768/// A type to track pointer/struct usage and accesses for AAPointerInfo.
770 /// Return the best possible representable state.
771 static State getBestState(const State &SIS) { return State(); }
772
773 /// Return the worst possible representable state.
774 static State getWorstState(const State &SIS) {
775 State R;
776 R.indicatePessimisticFixpoint();
777 return R;
778 }
779
780 State() = default;
781 State(State &&SIS) = default;
782
783 const State &getAssumed() const { return *this; }
784
785 /// See AbstractState::isValidState().
786 bool isValidState() const override { return BS.isValidState(); }
787
788 /// See AbstractState::isAtFixpoint().
789 bool isAtFixpoint() const override { return BS.isAtFixpoint(); }
790
791 /// See AbstractState::indicateOptimisticFixpoint().
793 BS.indicateOptimisticFixpoint();
795 }
796
797 /// See AbstractState::indicatePessimisticFixpoint().
799 BS.indicatePessimisticFixpoint();
801 }
802
803 State &operator=(const State &R) {
804 if (this == &R)
805 return *this;
806 BS = R.BS;
807 AccessList = R.AccessList;
808 OffsetBins = R.OffsetBins;
809 RemoteIMap = R.RemoteIMap;
810 ReturnedOffsets = R.ReturnedOffsets;
811 return *this;
812 }
813
815 if (this == &R)
816 return *this;
817 std::swap(BS, R.BS);
818 std::swap(AccessList, R.AccessList);
819 std::swap(OffsetBins, R.OffsetBins);
820 std::swap(RemoteIMap, R.RemoteIMap);
821 std::swap(ReturnedOffsets, R.ReturnedOffsets);
822 return *this;
823 }
824
825 /// Add a new Access to the state at offset \p Offset and with size \p Size.
826 /// The access is associated with \p I, writes \p Content (if anything), and
827 /// is of kind \p Kind. If an Access already exists for the same \p I and same
828 /// \p RemoteI, the two are combined, potentially losing information about
829 /// offset and size. The resulting access must now be moved from its original
830 /// OffsetBin to the bin for its new offset.
831 ///
832 /// \Returns CHANGED, if the state changed, UNCHANGED otherwise.
834 Instruction &I, std::optional<Value *> Content,
836 Instruction *RemoteI = nullptr);
837
840 int64_t numOffsetBins() const { return OffsetBins.size(); }
841
842 const AAPointerInfo::Access &getAccess(unsigned Index) const {
843 return AccessList[Index];
844 }
845
846protected:
847 // Every memory instruction results in an Access object. We maintain a list of
848 // all Access objects that we own, along with the following maps:
849 //
850 // - OffsetBins: RangeTy -> { Access }
851 // - RemoteIMap: RemoteI x LocalI -> Access
852 //
853 // A RemoteI is any instruction that accesses memory. RemoteI is different
854 // from LocalI if and only if LocalI is a call; then RemoteI is some
855 // instruction in the callgraph starting from LocalI. Multiple paths in the
856 // callgraph from LocalI to RemoteI may produce multiple accesses, but these
857 // are all combined into a single Access object. This may result in loss of
858 // information in RangeTy in the Access object.
862
863 /// Flag to determine if the underlying pointer is reaching a return statement
864 /// in the associated function or not. Returns in other functions cause
865 /// invalidation.
867
868 /// See AAPointerInfo::forallInterferingAccesses.
869 template <typename F>
871 if (!isValidState() || !ReturnedOffsets.isUnassigned())
872 return false;
873
874 for (const auto &It : OffsetBins) {
875 AA::RangeTy ItRange = It.getFirst();
876 if (!Range.mayOverlap(ItRange))
877 continue;
878 bool IsExact = Range == ItRange && !Range.offsetOrSizeAreUnknown();
879 for (auto Index : It.getSecond()) {
880 auto &Access = AccessList[Index];
881 if (!CB(Access, IsExact))
882 return false;
883 }
884 }
885 return true;
886 }
887
888 /// See AAPointerInfo::forallInterferingAccesses.
889 template <typename F>
891 AA::RangeTy &Range) const {
892 if (!isValidState() || !ReturnedOffsets.isUnassigned())
893 return false;
894
895 auto LocalList = RemoteIMap.find(&I);
896 if (LocalList == RemoteIMap.end()) {
897 return true;
898 }
899
900 for (unsigned Index : LocalList->getSecond()) {
901 for (auto &R : AccessList[Index]) {
902 Range &= R;
903 if (Range.offsetAndSizeAreUnknown())
904 break;
905 }
906 }
908 }
909
910private:
911 /// State to track fixpoint and validity.
912 BooleanState BS;
913};
914
917 std::optional<Value *> Content, AAPointerInfo::AccessKind Kind, Type *Ty,
918 Instruction *RemoteI) {
919 RemoteI = RemoteI ? RemoteI : &I;
920
921 // Check if we have an access for this instruction, if not, simply add it.
922 auto &LocalList = RemoteIMap[RemoteI];
923 bool AccExists = false;
924 unsigned AccIndex = AccessList.size();
925 for (auto Index : LocalList) {
926 auto &A = AccessList[Index];
927 if (A.getLocalInst() == &I) {
928 AccExists = true;
929 AccIndex = Index;
930 break;
931 }
932 }
933
934 auto AddToBins = [&](const AAPointerInfo::RangeList &ToAdd) {
935 LLVM_DEBUG(if (ToAdd.size()) dbgs()
936 << "[AAPointerInfo] Inserting access in new offset bins\n";);
937
938 for (auto Key : ToAdd) {
939 LLVM_DEBUG(dbgs() << " key " << Key << "\n");
940 OffsetBins[Key].insert(AccIndex);
941 }
942 };
943
944 if (!AccExists) {
945 AccessList.emplace_back(&I, RemoteI, Ranges, Content, Kind, Ty);
946 assert((AccessList.size() == AccIndex + 1) &&
947 "New Access should have been at AccIndex");
948 LocalList.push_back(AccIndex);
949 AddToBins(AccessList[AccIndex].getRanges());
951 }
952
953 // Combine the new Access with the existing Access, and then update the
954 // mapping in the offset bins.
955 AAPointerInfo::Access Acc(&I, RemoteI, Ranges, Content, Kind, Ty);
956 auto &Current = AccessList[AccIndex];
957 auto Before = Current;
958 Current &= Acc;
959 if (Current == Before)
961
962 auto &ExistingRanges = Before.getRanges();
963 auto &NewRanges = Current.getRanges();
964
965 // Ranges that are in the old access but not the new access need to be removed
966 // from the offset bins.
968 AAPointerInfo::RangeList::set_difference(ExistingRanges, NewRanges, ToRemove);
969 LLVM_DEBUG(if (ToRemove.size()) dbgs()
970 << "[AAPointerInfo] Removing access from old offset bins\n";);
971
972 for (auto Key : ToRemove) {
973 LLVM_DEBUG(dbgs() << " key " << Key << "\n");
974 assert(OffsetBins.count(Key) && "Existing Access must be in some bin.");
975 auto &Bin = OffsetBins[Key];
976 assert(Bin.count(AccIndex) &&
977 "Expected bin to actually contain the Access.");
978 Bin.erase(AccIndex);
979 }
980
981 // Ranges that are in the new access but not the old access need to be added
982 // to the offset bins.
984 AAPointerInfo::RangeList::set_difference(NewRanges, ExistingRanges, ToAdd);
985 AddToBins(ToAdd);
987}
988
989namespace {
990
991#ifndef NDEBUG
993 const AAPointerInfo::OffsetInfo &OI) {
994 OS << llvm::interleaved_array(OI);
995 return OS;
996}
997#endif // NDEBUG
998
999struct AAPointerInfoImpl
1000 : public StateWrapper<AA::PointerInfo::State, AAPointerInfo> {
1002 AAPointerInfoImpl(const IRPosition &IRP, Attributor &A) : BaseTy(IRP) {}
1003
1004 /// See AbstractAttribute::getAsStr().
1005 const std::string getAsStr(Attributor *A) const override {
1006 return std::string("PointerInfo ") +
1007 (isValidState() ? (std::string("#") +
1008 std::to_string(OffsetBins.size()) + " bins")
1009 : "<invalid>") +
1010 (reachesReturn()
1011 ? (" (returned:" +
1012 join(map_range(ReturnedOffsets,
1013 [](int64_t O) { return std::to_string(O); }),
1014 ", ") +
1015 ")")
1016 : "");
1017 }
1018
1019 /// See AbstractAttribute::manifest(...).
1020 ChangeStatus manifest(Attributor &A) override {
1021 return AAPointerInfo::manifest(A);
1022 }
1023
1024 const_bin_iterator begin() const override { return State::begin(); }
1025 const_bin_iterator end() const override { return State::end(); }
1026 int64_t numOffsetBins() const override { return State::numOffsetBins(); }
1027 bool reachesReturn() const override {
1028 return !ReturnedOffsets.isUnassigned();
1029 }
1030 void addReturnedOffsetsTo(OffsetInfo &OI) const override {
1031 if (ReturnedOffsets.isUnknown()) {
1032 OI.setUnknown();
1033 return;
1034 }
1035
1036 OffsetInfo MergedOI;
1037 for (auto Offset : ReturnedOffsets) {
1038 OffsetInfo TmpOI = OI;
1039 TmpOI.addToAll(Offset);
1040 MergedOI.merge(TmpOI);
1041 }
1042 OI = std::move(MergedOI);
1043 }
1044
1045 ChangeStatus setReachesReturn(const OffsetInfo &ReachedReturnedOffsets) {
1046 if (ReturnedOffsets.isUnknown())
1047 return ChangeStatus::UNCHANGED;
1048 if (ReachedReturnedOffsets.isUnknown()) {
1049 ReturnedOffsets.setUnknown();
1050 return ChangeStatus::CHANGED;
1051 }
1052 if (ReturnedOffsets.merge(ReachedReturnedOffsets))
1053 return ChangeStatus::CHANGED;
1054 return ChangeStatus::UNCHANGED;
1055 }
1056
1057 bool forallInterferingAccesses(
1058 AA::RangeTy Range,
1059 function_ref<bool(const AAPointerInfo::Access &, bool)> CB)
1060 const override {
1061 return State::forallInterferingAccesses(Range, CB);
1062 }
1063
1064 bool forallInterferingAccesses(
1065 Attributor &A, const AbstractAttribute &QueryingAA, Instruction &I,
1066 bool FindInterferingWrites, bool FindInterferingReads,
1067 function_ref<bool(const Access &, bool)> UserCB, bool &HasBeenWrittenTo,
1068 AA::RangeTy &Range,
1069 function_ref<bool(const Access &)> SkipCB) const override {
1070 HasBeenWrittenTo = false;
1071
1072 SmallPtrSet<const Access *, 8> DominatingWrites;
1073 SmallVector<std::pair<const Access *, bool>, 8> InterferingAccesses;
1074
1075 Function &Scope = *I.getFunction();
1076 bool IsKnownNoSync;
1077 bool IsAssumedNoSync = AA::hasAssumedIRAttr<Attribute::NoSync>(
1078 A, &QueryingAA, IRPosition::function(Scope), DepClassTy::OPTIONAL,
1079 IsKnownNoSync);
1080 const auto *ExecDomainAA = A.lookupAAFor<AAExecutionDomain>(
1081 IRPosition::function(Scope), &QueryingAA, DepClassTy::NONE);
1082 bool AllInSameNoSyncFn = IsAssumedNoSync;
1083 bool InstIsExecutedByInitialThreadOnly =
1084 ExecDomainAA && ExecDomainAA->isExecutedByInitialThreadOnly(I);
1085
1086 // If the function is not ending in aligned barriers, we need the stores to
1087 // be in aligned barriers. The load being in one is not sufficient since the
1088 // store might be executed by a thread that disappears after, causing the
1089 // aligned barrier guarding the load to unblock and the load to read a value
1090 // that has no CFG path to the load.
1091 bool InstIsExecutedInAlignedRegion =
1092 FindInterferingReads && ExecDomainAA &&
1093 ExecDomainAA->isExecutedInAlignedRegion(A, I);
1094
1095 if (InstIsExecutedInAlignedRegion || InstIsExecutedByInitialThreadOnly)
1096 A.recordDependence(*ExecDomainAA, QueryingAA, DepClassTy::OPTIONAL);
1097
1098 InformationCache &InfoCache = A.getInfoCache();
1099 bool IsThreadLocalObj =
1100 AA::isAssumedThreadLocalObject(A, getAssociatedValue(), *this);
1101
1102 // Helper to determine if we need to consider threading, which we cannot
1103 // right now. However, if the function is (assumed) nosync or the thread
1104 // executing all instructions is the main thread only we can ignore
1105 // threading. Also, thread-local objects do not require threading reasoning.
1106 // Finally, we can ignore threading if either access is executed in an
1107 // aligned region.
1108 auto CanIgnoreThreadingForInst = [&](const Instruction &I) -> bool {
1109 if (IsThreadLocalObj || AllInSameNoSyncFn)
1110 return true;
1111 const auto *FnExecDomainAA =
1112 I.getFunction() == &Scope
1113 ? ExecDomainAA
1114 : A.lookupAAFor<AAExecutionDomain>(
1115 IRPosition::function(*I.getFunction()), &QueryingAA,
1116 DepClassTy::NONE);
1117 if (!FnExecDomainAA)
1118 return false;
1119 if (InstIsExecutedInAlignedRegion ||
1120 (FindInterferingWrites &&
1121 FnExecDomainAA->isExecutedInAlignedRegion(A, I))) {
1122 A.recordDependence(*FnExecDomainAA, QueryingAA, DepClassTy::OPTIONAL);
1123 return true;
1124 }
1125 if (InstIsExecutedByInitialThreadOnly &&
1126 FnExecDomainAA->isExecutedByInitialThreadOnly(I)) {
1127 A.recordDependence(*FnExecDomainAA, QueryingAA, DepClassTy::OPTIONAL);
1128 return true;
1129 }
1130 return false;
1131 };
1132
1133 // Helper to determine if the access is executed by the same thread as the
1134 // given instruction, for now it is sufficient to avoid any potential
1135 // threading effects as we cannot deal with them anyway.
1136 auto CanIgnoreThreading = [&](const Access &Acc) -> bool {
1137 return CanIgnoreThreadingForInst(*Acc.getRemoteInst()) ||
1138 (Acc.getRemoteInst() != Acc.getLocalInst() &&
1139 CanIgnoreThreadingForInst(*Acc.getLocalInst()));
1140 };
1141
1142 // TODO: Use inter-procedural reachability and dominance.
1143 bool IsKnownNoRecurse;
1145 A, this, IRPosition::function(Scope), DepClassTy::OPTIONAL,
1146 IsKnownNoRecurse);
1147
1148 // TODO: Use reaching kernels from AAKernelInfo (or move it to
1149 // AAExecutionDomain) such that we allow scopes other than kernels as long
1150 // as the reaching kernels are disjoint.
1151 bool InstInKernel = A.getInfoCache().isKernel(Scope);
1152 bool ObjHasKernelLifetime = false;
1153 const bool UseDominanceReasoning =
1154 FindInterferingWrites && IsKnownNoRecurse;
1155 const DominatorTree *DT =
1156 InfoCache.getAnalysisResultForFunction<DominatorTreeAnalysis>(Scope);
1157
1158 // Helper to check if a value has "kernel lifetime", that is it will not
1159 // outlive a GPU kernel. This is true for shared, constant, and local
1160 // globals on AMD and NVIDIA GPUs.
1161 auto HasKernelLifetime = [&](Value *V, Module &M) {
1162 if (!AA::isGPU(M))
1163 return false;
1164 unsigned VAS = V->getType()->getPointerAddressSpace();
1165 return AA::isGPUSharedAddressSpace(M, VAS) ||
1168 };
1169
1170 // The IsLiveInCalleeCB will be used by the AA::isPotentiallyReachable query
1171 // to determine if we should look at reachability from the callee. For
1172 // certain pointers we know the lifetime and we do not have to step into the
1173 // callee to determine reachability as the pointer would be dead in the
1174 // callee. See the conditional initialization below.
1175 std::function<bool(const Function &)> IsLiveInCalleeCB;
1176
1177 if (auto *AI = dyn_cast<AllocaInst>(&getAssociatedValue())) {
1178 // If the alloca containing function is not recursive the alloca
1179 // must be dead in the callee.
1180 const Function *AIFn = AI->getFunction();
1181 ObjHasKernelLifetime = A.getInfoCache().isKernel(*AIFn);
1182 bool IsKnownNoRecurse;
1184 A, this, IRPosition::function(*AIFn), DepClassTy::OPTIONAL,
1185 IsKnownNoRecurse)) {
1186 IsLiveInCalleeCB = [AIFn](const Function &Fn) { return AIFn != &Fn; };
1187 }
1188 } else if (auto *GV = dyn_cast<GlobalValue>(&getAssociatedValue())) {
1189 // If the global has kernel lifetime we can stop if we reach a kernel
1190 // as it is "dead" in the (unknown) callees.
1191 ObjHasKernelLifetime = HasKernelLifetime(GV, *GV->getParent());
1192 if (ObjHasKernelLifetime)
1193 IsLiveInCalleeCB = [&A](const Function &Fn) {
1194 return !A.getInfoCache().isKernel(Fn);
1195 };
1196 }
1197
1198 // Set of accesses/instructions that will overwrite the result and are
1199 // therefore blockers in the reachability traversal.
1200 AA::InstExclusionSetTy ExclusionSet;
1201
1202 auto AccessCB = [&](const Access &Acc, bool Exact) {
1203 Function *AccScope = Acc.getRemoteInst()->getFunction();
1204 bool AccInSameScope = AccScope == &Scope;
1205
1206 // If the object has kernel lifetime we can ignore accesses only reachable
1207 // by other kernels. For now we only skip accesses *in* other kernels.
1208 if (InstInKernel && ObjHasKernelLifetime && !AccInSameScope &&
1209 A.getInfoCache().isKernel(*AccScope))
1210 return true;
1211
1212 if (Exact && Acc.isMustAccess() && Acc.getRemoteInst() != &I) {
1213 if (Acc.isWrite() || (isa<LoadInst>(I) && Acc.isWriteOrAssumption()))
1214 ExclusionSet.insert(Acc.getRemoteInst());
1215 }
1216
1217 if ((!FindInterferingWrites || !Acc.isWriteOrAssumption()) &&
1218 (!FindInterferingReads || !Acc.isRead()))
1219 return true;
1220
1221 bool Dominates = FindInterferingWrites && DT && Exact &&
1222 Acc.isMustAccess() && AccInSameScope &&
1223 DT->dominates(Acc.getRemoteInst(), &I);
1224 if (Dominates)
1225 DominatingWrites.insert(&Acc);
1226
1227 // Track if all interesting accesses are in the same `nosync` function as
1228 // the given instruction.
1229 AllInSameNoSyncFn &= Acc.getRemoteInst()->getFunction() == &Scope;
1230
1231 InterferingAccesses.push_back({&Acc, Exact});
1232 return true;
1233 };
1234 if (!State::forallInterferingAccesses(I, AccessCB, Range))
1235 return false;
1236
1237 HasBeenWrittenTo = !DominatingWrites.empty();
1238
1239 // Dominating writes form a chain, find the least/lowest member.
1240 Instruction *LeastDominatingWriteInst = nullptr;
1241 for (const Access *Acc : DominatingWrites) {
1242 if (!LeastDominatingWriteInst) {
1243 LeastDominatingWriteInst = Acc->getRemoteInst();
1244 } else if (DT->dominates(LeastDominatingWriteInst,
1245 Acc->getRemoteInst())) {
1246 LeastDominatingWriteInst = Acc->getRemoteInst();
1247 }
1248 }
1249
1250 // Helper to determine if we can skip a specific write access.
1251 auto CanSkipAccess = [&](const Access &Acc, bool Exact) {
1252 if (SkipCB && SkipCB(Acc))
1253 return true;
1254 if (!CanIgnoreThreading(Acc))
1255 return false;
1256
1257 // Check read (RAW) dependences and write (WAR) dependences as necessary.
1258 // If we successfully excluded all effects we are interested in, the
1259 // access can be skipped.
1260 bool ReadChecked = !FindInterferingReads;
1261 bool WriteChecked = !FindInterferingWrites;
1262
1263 // If the instruction cannot reach the access, the former does not
1264 // interfere with what the access reads.
1265 if (!ReadChecked) {
1266 if (!AA::isPotentiallyReachable(A, I, *Acc.getRemoteInst(), QueryingAA,
1267 &ExclusionSet, IsLiveInCalleeCB))
1268 ReadChecked = true;
1269 }
1270 // If the instruction cannot be reach from the access, the latter does not
1271 // interfere with what the instruction reads.
1272 if (!WriteChecked) {
1273 if (!AA::isPotentiallyReachable(A, *Acc.getRemoteInst(), I, QueryingAA,
1274 &ExclusionSet, IsLiveInCalleeCB))
1275 WriteChecked = true;
1276 }
1277
1278 // If we still might be affected by the write of the access but there are
1279 // dominating writes in the function of the instruction
1280 // (HasBeenWrittenTo), we can try to reason that the access is overwritten
1281 // by them. This would have happend above if they are all in the same
1282 // function, so we only check the inter-procedural case. Effectively, we
1283 // want to show that there is no call after the dominting write that might
1284 // reach the access, and when it returns reach the instruction with the
1285 // updated value. To this end, we iterate all call sites, check if they
1286 // might reach the instruction without going through another access
1287 // (ExclusionSet) and at the same time might reach the access. However,
1288 // that is all part of AAInterFnReachability.
1289 if (!WriteChecked && HasBeenWrittenTo &&
1290 Acc.getRemoteInst()->getFunction() != &Scope) {
1291
1292 const auto *FnReachabilityAA = A.getAAFor<AAInterFnReachability>(
1293 QueryingAA, IRPosition::function(Scope), DepClassTy::OPTIONAL);
1294 if (FnReachabilityAA) {
1295 // Without going backwards in the call tree, can we reach the access
1296 // from the least dominating write. Do not allow to pass the
1297 // instruction itself either.
1298 bool Inserted = ExclusionSet.insert(&I).second;
1299
1300 if (!FnReachabilityAA->instructionCanReach(
1301 A, *LeastDominatingWriteInst,
1302 *Acc.getRemoteInst()->getFunction(), &ExclusionSet))
1303 WriteChecked = true;
1304
1305 if (Inserted)
1306 ExclusionSet.erase(&I);
1307 }
1308 }
1309
1310 if (ReadChecked && WriteChecked)
1311 return true;
1312
1313 if (!DT || !UseDominanceReasoning)
1314 return false;
1315 if (!DominatingWrites.count(&Acc))
1316 return false;
1317 return LeastDominatingWriteInst != Acc.getRemoteInst();
1318 };
1319
1320 // Run the user callback on all accesses we cannot skip and return if
1321 // that succeeded for all or not.
1322 for (auto &It : InterferingAccesses) {
1323 if ((!AllInSameNoSyncFn && !IsThreadLocalObj && !ExecDomainAA) ||
1324 !CanSkipAccess(*It.first, It.second)) {
1325 if (!UserCB(*It.first, It.second))
1326 return false;
1327 }
1328 }
1329 return true;
1330 }
1331
1332 ChangeStatus translateAndAddStateFromCallee(Attributor &A,
1333 const AAPointerInfo &OtherAA,
1334 CallBase &CB) {
1335 using namespace AA::PointerInfo;
1336 if (!OtherAA.getState().isValidState() || !isValidState())
1337 return indicatePessimisticFixpoint();
1338
1339 ChangeStatus Changed = ChangeStatus::UNCHANGED;
1340 const auto &OtherAAImpl = static_cast<const AAPointerInfoImpl &>(OtherAA);
1341 bool IsByval = OtherAAImpl.getAssociatedArgument()->hasByValAttr();
1342 Changed |= setReachesReturn(OtherAAImpl.ReturnedOffsets);
1343
1344 // Combine the accesses bin by bin.
1345 const auto &State = OtherAAImpl.getState();
1346 for (const auto &It : State) {
1347 for (auto Index : It.getSecond()) {
1348 const auto &RAcc = State.getAccess(Index);
1349 if (IsByval && !RAcc.isRead())
1350 continue;
1351 bool UsedAssumedInformation = false;
1352 AccessKind AK = RAcc.getKind();
1353 auto Content = A.translateArgumentToCallSiteContent(
1354 RAcc.getContent(), CB, *this, UsedAssumedInformation);
1355 AK = AccessKind(AK & (IsByval ? AccessKind::AK_R : AccessKind::AK_RW));
1356 AK = AccessKind(AK | (RAcc.isMayAccess() ? AK_MAY : AK_MUST));
1357
1358 Changed |= addAccess(A, RAcc.getRanges(), CB, Content, AK,
1359 RAcc.getType(), RAcc.getRemoteInst());
1360 }
1361 }
1362 return Changed;
1363 }
1364
1365 ChangeStatus translateAndAddState(Attributor &A, const AAPointerInfo &OtherAA,
1366 const OffsetInfo &Offsets, CallBase &CB,
1367 bool IsMustAcc) {
1368 using namespace AA::PointerInfo;
1369 if (!OtherAA.getState().isValidState() || !isValidState())
1370 return indicatePessimisticFixpoint();
1371
1372 const auto &OtherAAImpl = static_cast<const AAPointerInfoImpl &>(OtherAA);
1373
1374 // Combine the accesses bin by bin.
1375 ChangeStatus Changed = ChangeStatus::UNCHANGED;
1376 const auto &State = OtherAAImpl.getState();
1377 for (const auto &It : State) {
1378 for (auto Index : It.getSecond()) {
1379 const auto &RAcc = State.getAccess(Index);
1380 if (!IsMustAcc && RAcc.isAssumption())
1381 continue;
1382 for (auto Offset : Offsets) {
1383 auto NewRanges = Offset == AA::RangeTy::Unknown
1385 : RAcc.getRanges();
1386 if (!NewRanges.isUnknown()) {
1387 NewRanges.addToAllOffsets(Offset);
1388 }
1389 AccessKind AK = RAcc.getKind();
1390 if (!IsMustAcc)
1391 AK = AccessKind((AK & ~AK_MUST) | AK_MAY);
1392 Changed |= addAccess(A, NewRanges, CB, RAcc.getContent(), AK,
1393 RAcc.getType(), RAcc.getRemoteInst());
1394 }
1395 }
1396 }
1397 return Changed;
1398 }
1399
1400 /// Statistic tracking for all AAPointerInfo implementations.
1401 /// See AbstractAttribute::trackStatistics().
1402 void trackPointerInfoStatistics(const IRPosition &IRP) const {}
1403
1404 /// Dump the state into \p O.
1405 void dumpState(raw_ostream &O) {
1406 for (auto &It : OffsetBins) {
1407 O << "[" << It.first.Offset << "-" << It.first.Offset + It.first.Size
1408 << "] : " << It.getSecond().size() << "\n";
1409 for (auto AccIndex : It.getSecond()) {
1410 auto &Acc = AccessList[AccIndex];
1411 O << " - " << Acc.getKind() << " - " << *Acc.getLocalInst() << "\n";
1412 if (Acc.getLocalInst() != Acc.getRemoteInst())
1413 O << " --> " << *Acc.getRemoteInst()
1414 << "\n";
1415 if (!Acc.isWrittenValueYetUndetermined()) {
1416 if (isa_and_nonnull<Function>(Acc.getWrittenValue()))
1417 O << " - c: func " << Acc.getWrittenValue()->getName()
1418 << "\n";
1419 else if (Acc.getWrittenValue())
1420 O << " - c: " << *Acc.getWrittenValue() << "\n";
1421 else
1422 O << " - c: <unknown>\n";
1423 }
1424 }
1425 }
1426 }
1427};
1428
1429struct AAPointerInfoFloating : public AAPointerInfoImpl {
1431 AAPointerInfoFloating(const IRPosition &IRP, Attributor &A)
1432 : AAPointerInfoImpl(IRP, A) {}
1433
1434 /// Deal with an access and signal if it was handled successfully.
1435 bool handleAccess(Attributor &A, Instruction &I,
1436 std::optional<Value *> Content, AccessKind Kind,
1437 OffsetInfo::VecTy &Offsets, ChangeStatus &Changed,
1438 Type &Ty) {
1439 using namespace AA::PointerInfo;
1441 const DataLayout &DL = A.getDataLayout();
1442 TypeSize AccessSize = DL.getTypeStoreSize(&Ty);
1443 if (!AccessSize.isScalable())
1444 Size = AccessSize.getFixedValue();
1445
1446 // Make a strictly ascending list of offsets as required by addAccess()
1447 SmallVector<int64_t> OffsetsSorted(Offsets.begin(), Offsets.end());
1448 llvm::sort(OffsetsSorted);
1449
1451 if (!VT || VT->getElementCount().isScalable() ||
1452 !Content.value_or(nullptr) || !isa<Constant>(*Content) ||
1453 (*Content)->getType() != VT ||
1454 DL.getTypeStoreSize(VT->getElementType()).isScalable()) {
1455 Changed =
1456 Changed | addAccess(A, {OffsetsSorted, Size}, I, Content, Kind, &Ty);
1457 } else {
1458 // Handle vector stores with constant content element-wise.
1459 // TODO: We could look for the elements or create instructions
1460 // representing them.
1461 // TODO: We need to push the Content into the range abstraction
1462 // (AA::RangeTy) to allow different content values for different
1463 // ranges. ranges. Hence, support vectors storing different values.
1464 Type *ElementType = VT->getElementType();
1465 int64_t ElementSize = DL.getTypeStoreSize(ElementType).getFixedValue();
1466 auto *ConstContent = cast<Constant>(*Content);
1467 Type *Int32Ty = Type::getInt32Ty(ElementType->getContext());
1468 SmallVector<int64_t> ElementOffsets(Offsets.begin(), Offsets.end());
1469
1470 for (int i = 0, e = VT->getElementCount().getFixedValue(); i != e; ++i) {
1471 Value *ElementContent = ConstantExpr::getExtractElement(
1472 ConstContent, ConstantInt::get(Int32Ty, i));
1473
1474 // Add the element access.
1475 Changed = Changed | addAccess(A, {ElementOffsets, ElementSize}, I,
1476 ElementContent, Kind, ElementType);
1477
1478 // Advance the offsets for the next element.
1479 for (auto &ElementOffset : ElementOffsets)
1480 ElementOffset += ElementSize;
1481 }
1482 }
1483 return true;
1484 };
1485
1486 /// See AbstractAttribute::updateImpl(...).
1487 ChangeStatus updateImpl(Attributor &A) override;
1488
1489 /// If the indices to \p GEP can be traced to constants, incorporate all
1490 /// of these into \p UsrOI.
1491 ///
1492 /// \return true iff \p UsrOI is updated.
1493 bool collectConstantsForGEP(Attributor &A, const DataLayout &DL,
1494 OffsetInfo &UsrOI, const OffsetInfo &PtrOI,
1495 const GEPOperator *GEP);
1496
1497 /// See AbstractAttribute::trackStatistics()
1498 void trackStatistics() const override {
1499 AAPointerInfoImpl::trackPointerInfoStatistics(getIRPosition());
1500 }
1501};
1502
1503bool AAPointerInfoFloating::collectConstantsForGEP(Attributor &A,
1504 const DataLayout &DL,
1505 OffsetInfo &UsrOI,
1506 const OffsetInfo &PtrOI,
1507 const GEPOperator *GEP) {
1508 unsigned BitWidth = DL.getIndexTypeSizeInBits(GEP->getType());
1509 SmallMapVector<Value *, APInt, 4> VariableOffsets;
1510 APInt ConstantOffset(BitWidth, 0);
1511
1512 assert(!UsrOI.isUnknown() && !PtrOI.isUnknown() &&
1513 "Don't look for constant values if the offset has already been "
1514 "determined to be unknown.");
1515
1516 if (!GEP->collectOffset(DL, BitWidth, VariableOffsets, ConstantOffset)) {
1517 UsrOI.setUnknown();
1518 return true;
1519 }
1520
1521 LLVM_DEBUG(dbgs() << "[AAPointerInfo] GEP offset is "
1522 << (VariableOffsets.empty() ? "" : "not") << " constant "
1523 << *GEP << "\n");
1524
1525 auto Union = PtrOI;
1526 Union.addToAll(ConstantOffset.getSExtValue());
1527
1528 // Each VI in VariableOffsets has a set of potential constant values. Every
1529 // combination of elements, picked one each from these sets, is separately
1530 // added to the original set of offsets, thus resulting in more offsets.
1531 for (const auto &VI : VariableOffsets) {
1532 auto *PotentialConstantsAA = A.getAAFor<AAPotentialConstantValues>(
1533 *this, IRPosition::value(*VI.first), DepClassTy::OPTIONAL);
1534 if (!PotentialConstantsAA || !PotentialConstantsAA->isValidState()) {
1535 UsrOI.setUnknown();
1536 return true;
1537 }
1538
1539 // UndefValue is treated as a zero, which leaves Union as is.
1540 if (PotentialConstantsAA->undefIsContained())
1541 continue;
1542
1543 // We need at least one constant in every set to compute an actual offset.
1544 // Otherwise, we end up pessimizing AAPointerInfo by respecting offsets that
1545 // don't actually exist. In other words, the absence of constant values
1546 // implies that the operation can be assumed dead for now.
1547 auto &AssumedSet = PotentialConstantsAA->getAssumedSet();
1548 if (AssumedSet.empty())
1549 return false;
1550
1551 OffsetInfo Product;
1552 for (const auto &ConstOffset : AssumedSet) {
1553 auto CopyPerOffset = Union;
1554 CopyPerOffset.addToAll(ConstOffset.getSExtValue() *
1555 VI.second.getZExtValue());
1556 Product.merge(CopyPerOffset);
1557 }
1558 Union = Product;
1559 }
1560
1561 UsrOI = std::move(Union);
1562 return true;
1563}
1564
1565ChangeStatus AAPointerInfoFloating::updateImpl(Attributor &A) {
1566 using namespace AA::PointerInfo;
1568 const DataLayout &DL = A.getDataLayout();
1569 Value &AssociatedValue = getAssociatedValue();
1570
1571 DenseMap<Value *, OffsetInfo> OffsetInfoMap;
1572 OffsetInfoMap[&AssociatedValue].insert(0);
1573
1574 auto HandlePassthroughUser = [&](Value *Usr, Value *CurPtr, bool &Follow) {
1575 // One does not simply walk into a map and assign a reference to a possibly
1576 // new location. That can cause an invalidation before the assignment
1577 // happens, like so:
1578 //
1579 // OffsetInfoMap[Usr] = OffsetInfoMap[CurPtr]; /* bad idea! */
1580 //
1581 // The RHS is a reference that may be invalidated by an insertion caused by
1582 // the LHS. So we ensure that the side-effect of the LHS happens first.
1583
1584 assert(OffsetInfoMap.contains(CurPtr) &&
1585 "CurPtr does not exist in the map!");
1586
1587 auto &UsrOI = OffsetInfoMap[Usr];
1588 auto &PtrOI = OffsetInfoMap[CurPtr];
1589 assert(!PtrOI.isUnassigned() &&
1590 "Cannot pass through if the input Ptr was not visited!");
1591 UsrOI.merge(PtrOI);
1592 Follow = true;
1593 return true;
1594 };
1595
1596 auto UsePred = [&](const Use &U, bool &Follow) -> bool {
1597 Value *CurPtr = U.get();
1598 User *Usr = U.getUser();
1599 LLVM_DEBUG(dbgs() << "[AAPointerInfo] Analyze " << *CurPtr << " in " << *Usr
1600 << "\n");
1601 assert(OffsetInfoMap.count(CurPtr) &&
1602 "The current pointer offset should have been seeded!");
1603 assert(!OffsetInfoMap[CurPtr].isUnassigned() &&
1604 "Current pointer should be assigned");
1605
1606 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Usr)) {
1607 if (CE->isCast())
1608 return HandlePassthroughUser(Usr, CurPtr, Follow);
1609 if (!isa<GEPOperator>(CE)) {
1610 LLVM_DEBUG(dbgs() << "[AAPointerInfo] Unhandled constant user " << *CE
1611 << "\n");
1612 return false;
1613 }
1614 }
1615 if (auto *GEP = dyn_cast<GEPOperator>(Usr)) {
1616 // Note the order here, the Usr access might change the map, CurPtr is
1617 // already in it though.
1618 auto &UsrOI = OffsetInfoMap[Usr];
1619 auto &PtrOI = OffsetInfoMap[CurPtr];
1620
1621 if (UsrOI.isUnknown())
1622 return true;
1623
1624 if (PtrOI.isUnknown()) {
1625 Follow = true;
1626 UsrOI.setUnknown();
1627 return true;
1628 }
1629
1630 Follow = collectConstantsForGEP(A, DL, UsrOI, PtrOI, GEP);
1631 return true;
1632 }
1633 if (isa<PtrToIntInst>(Usr))
1634 return false;
1635 if (isa<CastInst>(Usr) || isa<SelectInst>(Usr))
1636 return HandlePassthroughUser(Usr, CurPtr, Follow);
1637 // Returns are allowed if they are in the associated functions. Users can
1638 // then check the call site return. Returns from other functions can't be
1639 // tracked and are cause for invalidation.
1640 if (auto *RI = dyn_cast<ReturnInst>(Usr)) {
1641 if (RI->getFunction() == getAssociatedFunction()) {
1642 auto &PtrOI = OffsetInfoMap[CurPtr];
1643 Changed |= setReachesReturn(PtrOI);
1644 return true;
1645 }
1646 return false;
1647 }
1648
1649 // For PHIs we need to take care of the recurrence explicitly as the value
1650 // might change while we iterate through a loop. For now, we give up if
1651 // the PHI is not invariant.
1652 if (auto *PHI = dyn_cast<PHINode>(Usr)) {
1653 // Note the order here, the Usr access might change the map, CurPtr is
1654 // already in it though.
1655 auto [PhiIt, IsFirstPHIUser] = OffsetInfoMap.try_emplace(PHI);
1656 auto &UsrOI = PhiIt->second;
1657 auto &PtrOI = OffsetInfoMap[CurPtr];
1658
1659 // Check if the PHI operand has already an unknown offset as we can't
1660 // improve on that anymore.
1661 if (PtrOI.isUnknown()) {
1662 LLVM_DEBUG(dbgs() << "[AAPointerInfo] PHI operand offset unknown "
1663 << *CurPtr << " in " << *PHI << "\n");
1664 Follow = !UsrOI.isUnknown();
1665 UsrOI.setUnknown();
1666 return true;
1667 }
1668
1669 // Check if the PHI is invariant (so far).
1670 if (UsrOI == PtrOI) {
1671 assert(!PtrOI.isUnassigned() &&
1672 "Cannot assign if the current Ptr was not visited!");
1673 LLVM_DEBUG(dbgs() << "[AAPointerInfo] PHI is invariant (so far)");
1674 return true;
1675 }
1676
1677 // Check if the PHI operand can be traced back to AssociatedValue.
1678 APInt Offset(
1679 DL.getIndexSizeInBits(CurPtr->getType()->getPointerAddressSpace()),
1680 0);
1681 Value *CurPtrBase = CurPtr->stripAndAccumulateConstantOffsets(
1682 DL, Offset, /* AllowNonInbounds */ true);
1683 auto It = OffsetInfoMap.find(CurPtrBase);
1684 if (It == OffsetInfoMap.end()) {
1685 LLVM_DEBUG(dbgs() << "[AAPointerInfo] PHI operand is too complex "
1686 << *CurPtr << " in " << *PHI
1687 << " (base: " << *CurPtrBase << ")\n");
1688 UsrOI.setUnknown();
1689 Follow = true;
1690 return true;
1691 }
1692
1693 // Check if the PHI operand is not dependent on the PHI itself. Every
1694 // recurrence is a cyclic net of PHIs in the data flow, and has an
1695 // equivalent Cycle in the control flow. One of those PHIs must be in the
1696 // header of that control flow Cycle. This is independent of the choice of
1697 // Cycles reported by CycleInfo. It is sufficient to check the PHIs in
1698 // every Cycle header; if such a node is marked unknown, this will
1699 // eventually propagate through the whole net of PHIs in the recurrence.
1700 const auto *CI =
1701 A.getInfoCache().getAnalysisResultForFunction<CycleAnalysis>(
1702 *PHI->getFunction());
1703 if (mayBeInCycle(CI, cast<Instruction>(Usr), /* HeaderOnly */ true)) {
1704 auto BaseOI = It->getSecond();
1705 BaseOI.addToAll(Offset.getZExtValue());
1706 if (IsFirstPHIUser || BaseOI == UsrOI) {
1707 LLVM_DEBUG(dbgs() << "[AAPointerInfo] PHI is invariant " << *CurPtr
1708 << " in " << *Usr << "\n");
1709 return HandlePassthroughUser(Usr, CurPtr, Follow);
1710 }
1711
1712 LLVM_DEBUG(
1713 dbgs() << "[AAPointerInfo] PHI operand pointer offset mismatch "
1714 << *CurPtr << " in " << *PHI << "\n");
1715 UsrOI.setUnknown();
1716 Follow = true;
1717 return true;
1718 }
1719
1720 UsrOI.merge(PtrOI);
1721 Follow = true;
1722 return true;
1723 }
1724
1725 if (auto *LoadI = dyn_cast<LoadInst>(Usr)) {
1726 // If the access is to a pointer that may or may not be the associated
1727 // value, e.g. due to a PHI, we cannot assume it will be read.
1728 AccessKind AK = AccessKind::AK_R;
1729 if (getUnderlyingObject(CurPtr) == &AssociatedValue)
1730 AK = AccessKind(AK | AccessKind::AK_MUST);
1731 else
1732 AK = AccessKind(AK | AccessKind::AK_MAY);
1733 if (!handleAccess(A, *LoadI, /* Content */ nullptr, AK,
1734 OffsetInfoMap[CurPtr].Offsets, Changed,
1735 *LoadI->getType()))
1736 return false;
1737
1738 auto IsAssumption = [](Instruction &I) {
1739 if (auto *II = dyn_cast<IntrinsicInst>(&I))
1740 return II->isAssumeLikeIntrinsic();
1741 return false;
1742 };
1743
1744 auto IsImpactedInRange = [&](Instruction *FromI, Instruction *ToI) {
1745 // Check if the assumption and the load are executed together without
1746 // memory modification.
1747 do {
1748 if (FromI->mayWriteToMemory() && !IsAssumption(*FromI))
1749 return true;
1750 FromI = FromI->getNextNode();
1751 } while (FromI && FromI != ToI);
1752 return false;
1753 };
1754
1755 BasicBlock *BB = LoadI->getParent();
1756 auto IsValidAssume = [&](IntrinsicInst &IntrI) {
1757 if (IntrI.getIntrinsicID() != Intrinsic::assume)
1758 return false;
1759 BasicBlock *IntrBB = IntrI.getParent();
1760 if (IntrI.getParent() == BB) {
1761 if (IsImpactedInRange(LoadI->getNextNode(), &IntrI))
1762 return false;
1763 } else {
1764 auto PredIt = pred_begin(IntrBB);
1765 if (PredIt == pred_end(IntrBB))
1766 return false;
1767 if ((*PredIt) != BB)
1768 return false;
1769 if (++PredIt != pred_end(IntrBB))
1770 return false;
1771 for (auto *SuccBB : successors(BB)) {
1772 if (SuccBB == IntrBB)
1773 continue;
1774 if (isa<UnreachableInst>(SuccBB->getTerminator()))
1775 continue;
1776 return false;
1777 }
1778 if (IsImpactedInRange(LoadI->getNextNode(), BB->getTerminator()))
1779 return false;
1780 if (IsImpactedInRange(&IntrBB->front(), &IntrI))
1781 return false;
1782 }
1783 return true;
1784 };
1785
1786 std::pair<Value *, IntrinsicInst *> Assumption;
1787 for (const Use &LoadU : LoadI->uses()) {
1788 if (auto *CmpI = dyn_cast<CmpInst>(LoadU.getUser())) {
1789 if (!CmpI->isEquality() || !CmpI->isTrueWhenEqual())
1790 continue;
1791 for (const Use &CmpU : CmpI->uses()) {
1792 if (auto *IntrI = dyn_cast<IntrinsicInst>(CmpU.getUser())) {
1793 if (!IsValidAssume(*IntrI))
1794 continue;
1795 int Idx = CmpI->getOperandUse(0) == LoadU;
1796 Assumption = {CmpI->getOperand(Idx), IntrI};
1797 break;
1798 }
1799 }
1800 }
1801 if (Assumption.first)
1802 break;
1803 }
1804
1805 // Check if we found an assumption associated with this load.
1806 if (!Assumption.first || !Assumption.second)
1807 return true;
1808
1809 LLVM_DEBUG(dbgs() << "[AAPointerInfo] Assumption found "
1810 << *Assumption.second << ": " << *LoadI
1811 << " == " << *Assumption.first << "\n");
1812 bool UsedAssumedInformation = false;
1813 std::optional<Value *> Content = nullptr;
1814 if (Assumption.first)
1815 Content =
1816 A.getAssumedSimplified(*Assumption.first, *this,
1817 UsedAssumedInformation, AA::Interprocedural);
1818 return handleAccess(
1819 A, *Assumption.second, Content, AccessKind::AK_ASSUMPTION,
1820 OffsetInfoMap[CurPtr].Offsets, Changed, *LoadI->getType());
1821 }
1822
1823 auto HandleStoreLike = [&](Instruction &I, Value *ValueOp, Type &ValueTy,
1824 ArrayRef<Value *> OtherOps, AccessKind AK) {
1825 for (auto *OtherOp : OtherOps) {
1826 if (OtherOp == CurPtr) {
1827 LLVM_DEBUG(
1828 dbgs()
1829 << "[AAPointerInfo] Escaping use in store like instruction " << I
1830 << "\n");
1831 return false;
1832 }
1833 }
1834
1835 // If the access is to a pointer that may or may not be the associated
1836 // value, e.g. due to a PHI, we cannot assume it will be written.
1837 if (getUnderlyingObject(CurPtr) == &AssociatedValue)
1838 AK = AccessKind(AK | AccessKind::AK_MUST);
1839 else
1840 AK = AccessKind(AK | AccessKind::AK_MAY);
1841 bool UsedAssumedInformation = false;
1842 std::optional<Value *> Content = nullptr;
1843 if (ValueOp)
1844 Content = A.getAssumedSimplified(
1845 *ValueOp, *this, UsedAssumedInformation, AA::Interprocedural);
1846 return handleAccess(A, I, Content, AK, OffsetInfoMap[CurPtr].Offsets,
1847 Changed, ValueTy);
1848 };
1849
1850 if (auto *StoreI = dyn_cast<StoreInst>(Usr))
1851 return HandleStoreLike(*StoreI, StoreI->getValueOperand(),
1852 *StoreI->getValueOperand()->getType(),
1853 {StoreI->getValueOperand()}, AccessKind::AK_W);
1854 if (auto *RMWI = dyn_cast<AtomicRMWInst>(Usr))
1855 return HandleStoreLike(*RMWI, nullptr, *RMWI->getValOperand()->getType(),
1856 {RMWI->getValOperand()}, AccessKind::AK_RW);
1857 if (auto *CXI = dyn_cast<AtomicCmpXchgInst>(Usr))
1858 return HandleStoreLike(
1859 *CXI, nullptr, *CXI->getNewValOperand()->getType(),
1860 {CXI->getCompareOperand(), CXI->getNewValOperand()},
1861 AccessKind::AK_RW);
1862
1863 if (auto *CB = dyn_cast<CallBase>(Usr)) {
1864 if (CB->isLifetimeStartOrEnd())
1865 return true;
1866 const auto *TLI =
1867 A.getInfoCache().getTargetLibraryInfoForFunction(*CB->getFunction());
1868 if (getFreedOperand(CB, TLI) == U)
1869 return true;
1870 if (CB->isArgOperand(&U)) {
1871 unsigned ArgNo = CB->getArgOperandNo(&U);
1872 const auto *CSArgPI = A.getAAFor<AAPointerInfo>(
1873 *this, IRPosition::callsite_argument(*CB, ArgNo),
1875 if (!CSArgPI)
1876 return false;
1877 bool IsArgMustAcc = (getUnderlyingObject(CurPtr) == &AssociatedValue);
1878 Changed = translateAndAddState(A, *CSArgPI, OffsetInfoMap[CurPtr], *CB,
1879 IsArgMustAcc) |
1880 Changed;
1881 if (!CSArgPI->reachesReturn())
1882 return isValidState();
1883
1885 if (!Callee || Callee->arg_size() <= ArgNo)
1886 return false;
1887 bool UsedAssumedInformation = false;
1888 auto ReturnedValue = A.getAssumedSimplified(
1889 IRPosition::returned(*Callee), *this, UsedAssumedInformation,
1891 auto *ReturnedArg =
1892 dyn_cast_or_null<Argument>(ReturnedValue.value_or(nullptr));
1893 auto *Arg = Callee->getArg(ArgNo);
1894 if (ReturnedArg && Arg != ReturnedArg)
1895 return true;
1896 bool IsRetMustAcc = IsArgMustAcc && (ReturnedArg == Arg);
1897 const auto *CSRetPI = A.getAAFor<AAPointerInfo>(
1899 if (!CSRetPI)
1900 return false;
1901 OffsetInfo OI = OffsetInfoMap[CurPtr];
1902 CSArgPI->addReturnedOffsetsTo(OI);
1903 Changed =
1904 translateAndAddState(A, *CSRetPI, OI, *CB, IsRetMustAcc) | Changed;
1905 return isValidState();
1906 }
1907 LLVM_DEBUG(dbgs() << "[AAPointerInfo] Call user not handled " << *CB
1908 << "\n");
1909 return false;
1910 }
1911
1912 LLVM_DEBUG(dbgs() << "[AAPointerInfo] User not handled " << *Usr << "\n");
1913 return false;
1914 };
1915 auto EquivalentUseCB = [&](const Use &OldU, const Use &NewU) {
1916 assert(OffsetInfoMap.count(OldU) && "Old use should be known already!");
1917 assert(!OffsetInfoMap[OldU].isUnassigned() && "Old use should be assinged");
1918 if (OffsetInfoMap.count(NewU)) {
1919 LLVM_DEBUG({
1920 if (!(OffsetInfoMap[NewU] == OffsetInfoMap[OldU])) {
1921 dbgs() << "[AAPointerInfo] Equivalent use callback failed: "
1922 << OffsetInfoMap[NewU] << " vs " << OffsetInfoMap[OldU]
1923 << "\n";
1924 }
1925 });
1926 return OffsetInfoMap[NewU] == OffsetInfoMap[OldU];
1927 }
1928 bool Unused;
1929 return HandlePassthroughUser(NewU.get(), OldU.get(), Unused);
1930 };
1931 if (!A.checkForAllUses(UsePred, *this, AssociatedValue,
1932 /* CheckBBLivenessOnly */ true, DepClassTy::OPTIONAL,
1933 /* IgnoreDroppableUses */ true, EquivalentUseCB)) {
1934 LLVM_DEBUG(dbgs() << "[AAPointerInfo] Check for all uses failed, abort!\n");
1935 return indicatePessimisticFixpoint();
1936 }
1937
1938 LLVM_DEBUG({
1939 dbgs() << "Accesses by bin after update:\n";
1940 dumpState(dbgs());
1941 });
1942
1943 return Changed;
1944}
1945
1946struct AAPointerInfoReturned final : AAPointerInfoImpl {
1947 AAPointerInfoReturned(const IRPosition &IRP, Attributor &A)
1948 : AAPointerInfoImpl(IRP, A) {}
1949
1950 /// See AbstractAttribute::updateImpl(...).
1951 ChangeStatus updateImpl(Attributor &A) override {
1952 return indicatePessimisticFixpoint();
1953 }
1954
1955 /// See AbstractAttribute::trackStatistics()
1956 void trackStatistics() const override {
1957 AAPointerInfoImpl::trackPointerInfoStatistics(getIRPosition());
1958 }
1959};
1960
1961struct AAPointerInfoArgument final : AAPointerInfoFloating {
1962 AAPointerInfoArgument(const IRPosition &IRP, Attributor &A)
1963 : AAPointerInfoFloating(IRP, A) {}
1964
1965 /// See AbstractAttribute::trackStatistics()
1966 void trackStatistics() const override {
1967 AAPointerInfoImpl::trackPointerInfoStatistics(getIRPosition());
1968 }
1969};
1970
1971struct AAPointerInfoCallSiteArgument final : AAPointerInfoFloating {
1972 AAPointerInfoCallSiteArgument(const IRPosition &IRP, Attributor &A)
1973 : AAPointerInfoFloating(IRP, A) {}
1974
1975 /// See AbstractAttribute::updateImpl(...).
1976 ChangeStatus updateImpl(Attributor &A) override {
1977 using namespace AA::PointerInfo;
1978 // We handle memory intrinsics explicitly, at least the first (=
1979 // destination) and second (=source) arguments as we know how they are
1980 // accessed.
1981 if (auto *MI = dyn_cast_or_null<MemIntrinsic>(getCtxI())) {
1982 int64_t LengthVal = AA::RangeTy::Unknown;
1983 if (auto Length = MI->getLengthInBytes())
1984 LengthVal = Length->getSExtValue();
1985 unsigned ArgNo = getIRPosition().getCallSiteArgNo();
1986 ChangeStatus Changed = ChangeStatus::UNCHANGED;
1987 if (ArgNo > 1) {
1988 LLVM_DEBUG(dbgs() << "[AAPointerInfo] Unhandled memory intrinsic "
1989 << *MI << "\n");
1990 return indicatePessimisticFixpoint();
1991 } else {
1992 auto Kind =
1993 ArgNo == 0 ? AccessKind::AK_MUST_WRITE : AccessKind::AK_MUST_READ;
1994 Changed =
1995 Changed | addAccess(A, {0, LengthVal}, *MI, nullptr, Kind, nullptr);
1996 }
1997 LLVM_DEBUG({
1998 dbgs() << "Accesses by bin after update:\n";
1999 dumpState(dbgs());
2000 });
2001
2002 return Changed;
2003 }
2004
2005 // TODO: Once we have call site specific value information we can provide
2006 // call site specific liveness information and then it makes
2007 // sense to specialize attributes for call sites arguments instead of
2008 // redirecting requests to the callee argument.
2009 Argument *Arg = getAssociatedArgument();
2010 if (Arg) {
2011 const IRPosition &ArgPos = IRPosition::argument(*Arg);
2012 auto *ArgAA =
2013 A.getAAFor<AAPointerInfo>(*this, ArgPos, DepClassTy::REQUIRED);
2014 if (ArgAA && ArgAA->getState().isValidState())
2015 return translateAndAddStateFromCallee(A, *ArgAA,
2016 *cast<CallBase>(getCtxI()));
2017 if (!Arg->getParent()->isDeclaration())
2018 return indicatePessimisticFixpoint();
2019 }
2020
2021 bool IsKnownNoCapture;
2023 A, this, getIRPosition(), DepClassTy::OPTIONAL, IsKnownNoCapture))
2024 return indicatePessimisticFixpoint();
2025
2026 bool IsKnown = false;
2027 if (AA::isAssumedReadNone(A, getIRPosition(), *this, IsKnown))
2028 return ChangeStatus::UNCHANGED;
2029 bool ReadOnly = AA::isAssumedReadOnly(A, getIRPosition(), *this, IsKnown);
2030 auto Kind =
2031 ReadOnly ? AccessKind::AK_MAY_READ : AccessKind::AK_MAY_READ_WRITE;
2032 return addAccess(A, AA::RangeTy::getUnknown(), *getCtxI(), nullptr, Kind,
2033 nullptr);
2034 }
2035
2036 /// See AbstractAttribute::trackStatistics()
2037 void trackStatistics() const override {
2038 AAPointerInfoImpl::trackPointerInfoStatistics(getIRPosition());
2039 }
2040};
2041
2042struct AAPointerInfoCallSiteReturned final : AAPointerInfoFloating {
2043 AAPointerInfoCallSiteReturned(const IRPosition &IRP, Attributor &A)
2044 : AAPointerInfoFloating(IRP, A) {}
2045
2046 /// See AbstractAttribute::trackStatistics()
2047 void trackStatistics() const override {
2048 AAPointerInfoImpl::trackPointerInfoStatistics(getIRPosition());
2049 }
2050};
2051} // namespace
2052
2053/// -----------------------NoUnwind Function Attribute--------------------------
2054
2055namespace {
2056struct AANoUnwindImpl : AANoUnwind {
2057 AANoUnwindImpl(const IRPosition &IRP, Attributor &A) : AANoUnwind(IRP, A) {}
2058
2059 /// See AbstractAttribute::initialize(...).
2060 void initialize(Attributor &A) override {
2061 bool IsKnown;
2063 A, nullptr, getIRPosition(), DepClassTy::NONE, IsKnown));
2064 (void)IsKnown;
2065 }
2066
2067 const std::string getAsStr(Attributor *A) const override {
2068 return getAssumed() ? "nounwind" : "may-unwind";
2069 }
2070
2071 /// See AbstractAttribute::updateImpl(...).
2072 ChangeStatus updateImpl(Attributor &A) override {
2073 auto Opcodes = {
2074 (unsigned)Instruction::Invoke, (unsigned)Instruction::CallBr,
2075 (unsigned)Instruction::Call, (unsigned)Instruction::CleanupRet,
2076 (unsigned)Instruction::CatchSwitch, (unsigned)Instruction::Resume};
2077
2078 auto CheckForNoUnwind = [&](Instruction &I) {
2079 if (!I.mayThrow(/* IncludePhaseOneUnwind */ true))
2080 return true;
2081
2082 if (const auto *CB = dyn_cast<CallBase>(&I)) {
2083 bool IsKnownNoUnwind;
2085 A, this, IRPosition::callsite_function(*CB), DepClassTy::REQUIRED,
2086 IsKnownNoUnwind);
2087 }
2088 return false;
2089 };
2090
2091 bool UsedAssumedInformation = false;
2092 if (!A.checkForAllInstructions(CheckForNoUnwind, *this, Opcodes,
2093 UsedAssumedInformation))
2094 return indicatePessimisticFixpoint();
2095
2096 return ChangeStatus::UNCHANGED;
2097 }
2098};
2099
2100struct AANoUnwindFunction final : public AANoUnwindImpl {
2101 AANoUnwindFunction(const IRPosition &IRP, Attributor &A)
2102 : AANoUnwindImpl(IRP, A) {}
2103
2104 /// See AbstractAttribute::trackStatistics()
2105 void trackStatistics() const override { STATS_DECLTRACK_FN_ATTR(nounwind) }
2106};
2107
2108/// NoUnwind attribute deduction for a call sites.
2109struct AANoUnwindCallSite final
2110 : AACalleeToCallSite<AANoUnwind, AANoUnwindImpl> {
2111 AANoUnwindCallSite(const IRPosition &IRP, Attributor &A)
2112 : AACalleeToCallSite<AANoUnwind, AANoUnwindImpl>(IRP, A) {}
2113
2114 /// See AbstractAttribute::trackStatistics()
2115 void trackStatistics() const override { STATS_DECLTRACK_CS_ATTR(nounwind); }
2116};
2117} // namespace
2118
2119/// ------------------------ NoSync Function Attribute -------------------------
2120
2121bool AANoSync::isAlignedBarrier(const CallBase &CB, bool ExecutedAligned) {
2122 switch (CB.getIntrinsicID()) {
2123 case Intrinsic::nvvm_barrier_cta_sync_aligned_all:
2124 case Intrinsic::nvvm_barrier_cta_sync_aligned_count:
2125 case Intrinsic::nvvm_barrier_cta_red_and_aligned_all:
2126 case Intrinsic::nvvm_barrier_cta_red_and_aligned_count:
2127 case Intrinsic::nvvm_barrier_cta_red_or_aligned_all:
2128 case Intrinsic::nvvm_barrier_cta_red_or_aligned_count:
2129 case Intrinsic::nvvm_barrier_cta_red_popc_aligned_all:
2130 case Intrinsic::nvvm_barrier_cta_red_popc_aligned_count:
2131 return true;
2132 case Intrinsic::amdgcn_s_barrier:
2133 if (ExecutedAligned)
2134 return true;
2135 break;
2136 default:
2137 break;
2138 }
2139 return hasAssumption(CB, KnownAssumptionString("ompx_aligned_barrier"));
2140}
2141
2143 if (!I->isAtomic())
2144 return false;
2145
2146 if (auto *FI = dyn_cast<FenceInst>(I))
2147 // All legal orderings for fence are stronger than monotonic.
2148 return FI->getSyncScopeID() != SyncScope::SingleThread;
2149 if (auto *AI = dyn_cast<AtomicCmpXchgInst>(I)) {
2150 // Unordered is not a legal ordering for cmpxchg.
2151 return (AI->getSuccessOrdering() != AtomicOrdering::Monotonic ||
2152 AI->getFailureOrdering() != AtomicOrdering::Monotonic);
2153 }
2154
2155 AtomicOrdering Ordering;
2156 switch (I->getOpcode()) {
2157 case Instruction::AtomicRMW:
2158 Ordering = cast<AtomicRMWInst>(I)->getOrdering();
2159 break;
2160 case Instruction::Store:
2161 Ordering = cast<StoreInst>(I)->getOrdering();
2162 break;
2163 case Instruction::Load:
2164 Ordering = cast<LoadInst>(I)->getOrdering();
2165 break;
2166 default:
2168 "New atomic operations need to be known in the attributor.");
2169 }
2170
2171 return (Ordering != AtomicOrdering::Unordered &&
2172 Ordering != AtomicOrdering::Monotonic);
2173}
2174
2175namespace {
2176struct AANoSyncImpl : AANoSync {
2177 AANoSyncImpl(const IRPosition &IRP, Attributor &A) : AANoSync(IRP, A) {}
2178
2179 /// See AbstractAttribute::initialize(...).
2180 void initialize(Attributor &A) override {
2181 bool IsKnown;
2182 assert(!AA::hasAssumedIRAttr<Attribute::NoSync>(A, nullptr, getIRPosition(),
2183 DepClassTy::NONE, IsKnown));
2184 (void)IsKnown;
2185 }
2186
2187 const std::string getAsStr(Attributor *A) const override {
2188 return getAssumed() ? "nosync" : "may-sync";
2189 }
2190
2191 /// See AbstractAttribute::updateImpl(...).
2192 ChangeStatus updateImpl(Attributor &A) override;
2193};
2194
2195ChangeStatus AANoSyncImpl::updateImpl(Attributor &A) {
2196
2197 auto CheckRWInstForNoSync = [&](Instruction &I) {
2198 return AA::isNoSyncInst(A, I, *this);
2199 };
2200
2201 auto CheckForNoSync = [&](Instruction &I) {
2202 // At this point we handled all read/write effects and they are all
2203 // nosync, so they can be skipped.
2204 if (I.mayReadOrWriteMemory())
2205 return true;
2206
2207 bool IsKnown;
2208 CallBase &CB = cast<CallBase>(I);
2211 IsKnown))
2212 return true;
2213
2214 // non-convergent and readnone imply nosync.
2215 return !CB.isConvergent();
2216 };
2217
2218 bool UsedAssumedInformation = false;
2219 if (!A.checkForAllReadWriteInstructions(CheckRWInstForNoSync, *this,
2220 UsedAssumedInformation) ||
2221 !A.checkForAllCallLikeInstructions(CheckForNoSync, *this,
2222 UsedAssumedInformation))
2223 return indicatePessimisticFixpoint();
2224
2226}
2227
2228struct AANoSyncFunction final : public AANoSyncImpl {
2229 AANoSyncFunction(const IRPosition &IRP, Attributor &A)
2230 : AANoSyncImpl(IRP, A) {}
2231
2232 /// See AbstractAttribute::trackStatistics()
2233 void trackStatistics() const override { STATS_DECLTRACK_FN_ATTR(nosync) }
2234};
2235
2236/// NoSync attribute deduction for a call sites.
2237struct AANoSyncCallSite final : AACalleeToCallSite<AANoSync, AANoSyncImpl> {
2238 AANoSyncCallSite(const IRPosition &IRP, Attributor &A)
2239 : AACalleeToCallSite<AANoSync, AANoSyncImpl>(IRP, A) {}
2240
2241 /// See AbstractAttribute::trackStatistics()
2242 void trackStatistics() const override { STATS_DECLTRACK_CS_ATTR(nosync); }
2243};
2244} // namespace
2245
2246/// ------------------------ No-Free Attributes ----------------------------
2247
2248namespace {
2249struct AANoFreeImpl : public AANoFree {
2250 AANoFreeImpl(const IRPosition &IRP, Attributor &A) : AANoFree(IRP, A) {}
2251
2252 /// See AbstractAttribute::initialize(...).
2253 void initialize(Attributor &A) override {
2254 bool IsKnown;
2255 assert(!AA::hasAssumedIRAttr<Attribute::NoFree>(A, nullptr, getIRPosition(),
2256 DepClassTy::NONE, IsKnown));
2257 (void)IsKnown;
2258 }
2259
2260 /// See AbstractAttribute::updateImpl(...).
2261 ChangeStatus updateImpl(Attributor &A) override {
2262 auto CheckForNoFree = [&](Instruction &I) {
2263 if (auto *CB = dyn_cast<CallBase>(&I)) {
2264 bool IsKnown;
2266 A, this, IRPosition::callsite_function(*CB), DepClassTy::REQUIRED,
2267 IsKnown);
2268 }
2269 // Make sure that synchronization cannot establish happens-before with a
2270 // free on another thread.
2271 return AA::isNoSyncInst(A, I, *this);
2272 };
2273
2274 bool UsedAssumedInformation = false;
2275 if (!A.checkForAllReadWriteInstructions(CheckForNoFree, *this,
2276 UsedAssumedInformation) ||
2277 !A.checkForAllCallLikeInstructions(CheckForNoFree, *this,
2278 UsedAssumedInformation))
2279 return indicatePessimisticFixpoint();
2280
2281 return ChangeStatus::UNCHANGED;
2282 }
2283
2284 /// See AbstractAttribute::getAsStr().
2285 const std::string getAsStr(Attributor *A) const override {
2286 return getAssumed() ? "nofree" : "may-free";
2287 }
2288};
2289
2290struct AANoFreeFunction final : public AANoFreeImpl {
2291 AANoFreeFunction(const IRPosition &IRP, Attributor &A)
2292 : AANoFreeImpl(IRP, A) {}
2293
2294 /// See AbstractAttribute::trackStatistics()
2295 void trackStatistics() const override { STATS_DECLTRACK_FN_ATTR(nofree) }
2296};
2297
2298/// NoFree attribute deduction for a call sites.
2299struct AANoFreeCallSite final : AACalleeToCallSite<AANoFree, AANoFreeImpl> {
2300 AANoFreeCallSite(const IRPosition &IRP, Attributor &A)
2301 : AACalleeToCallSite<AANoFree, AANoFreeImpl>(IRP, A) {}
2302
2303 /// See AbstractAttribute::trackStatistics()
2304 void trackStatistics() const override { STATS_DECLTRACK_CS_ATTR(nofree); }
2305};
2306
2307/// NoFree attribute for floating values.
2308struct AANoFreeFloating : AANoFreeImpl {
2309 AANoFreeFloating(const IRPosition &IRP, Attributor &A)
2310 : AANoFreeImpl(IRP, A) {}
2311
2312 /// See AbstractAttribute::trackStatistics()
2313 void trackStatistics() const override{STATS_DECLTRACK_FLOATING_ATTR(nofree)}
2314
2315 /// See Abstract Attribute::updateImpl(...).
2316 ChangeStatus updateImpl(Attributor &A) override {
2317 const IRPosition &IRP = getIRPosition();
2318
2319 bool IsKnown;
2322 DepClassTy::OPTIONAL, IsKnown))
2323 return ChangeStatus::UNCHANGED;
2324
2325 Value &AssociatedValue = getIRPosition().getAssociatedValue();
2326 auto Pred = [&](const Use &U, bool &Follow) -> bool {
2327 Instruction *UserI = cast<Instruction>(U.getUser());
2328 if (auto *CB = dyn_cast<CallBase>(UserI)) {
2329 if (CB->isBundleOperand(&U))
2330 return false;
2331 if (!CB->isArgOperand(&U))
2332 return true;
2333 unsigned ArgNo = CB->getArgOperandNo(&U);
2334
2335 // Even if the argument is nofree, we still need to check for nocapture,
2336 // as the call may capture the argument without freeing it, and the
2337 // captured argument is freed later.
2338 bool IsKnown;
2340 A, this, IRPosition::callsite_argument(*CB, ArgNo),
2341 DepClassTy::REQUIRED, IsKnown))
2342 return false;
2343
2344 const AANoCapture *NoCaptureAA = nullptr;
2346 A, this, IRPosition::callsite_argument(*CB, ArgNo),
2347 DepClassTy::REQUIRED, IsKnown,
2348 /*IgnoreSubsumingPositions=*/false, &NoCaptureAA)) {
2349 if (NoCaptureAA && NoCaptureAA->isAssumedNoCaptureMaybeReturned()) {
2350 Follow = true;
2351 return true;
2352 }
2353 return false;
2354 }
2355
2356 return true;
2357 }
2358
2359 UseCaptureInfo CI = DetermineUseCaptureKind(U, /*Base=*/nullptr);
2360 if (!capturesAnyProvenance(CI))
2361 return true;
2363 Follow = true;
2364 return true;
2365 }
2366
2367 if (isa<ReturnInst>(UserI) && getIRPosition().isArgumentPosition())
2368 return true;
2369
2370 // Capturing user.
2371 return false;
2372 };
2373 if (!A.checkForAllUses(Pred, *this, AssociatedValue))
2374 return indicatePessimisticFixpoint();
2375
2376 return ChangeStatus::UNCHANGED;
2377 }
2378};
2379
2380/// NoFree attribute for a call site argument.
2381struct AANoFreeArgument final : AANoFreeFloating {
2382 AANoFreeArgument(const IRPosition &IRP, Attributor &A)
2383 : AANoFreeFloating(IRP, A) {}
2384
2385 /// See AbstractAttribute::trackStatistics()
2386 void trackStatistics() const override { STATS_DECLTRACK_ARG_ATTR(nofree) }
2387};
2388
2389/// NoFree attribute for call site arguments.
2390struct AANoFreeCallSiteArgument final : AANoFreeFloating {
2391 AANoFreeCallSiteArgument(const IRPosition &IRP, Attributor &A)
2392 : AANoFreeFloating(IRP, A) {}
2393
2394 /// See AbstractAttribute::updateImpl(...).
2395 ChangeStatus updateImpl(Attributor &A) override {
2396 // TODO: Once we have call site specific value information we can provide
2397 // call site specific liveness information and then it makes
2398 // sense to specialize attributes for call sites arguments instead of
2399 // redirecting requests to the callee argument.
2400 Argument *Arg = getAssociatedArgument();
2401 if (!Arg)
2402 return indicatePessimisticFixpoint();
2403 const IRPosition &ArgPos = IRPosition::argument(*Arg);
2404 bool IsKnown;
2406 DepClassTy::REQUIRED, IsKnown))
2407 return ChangeStatus::UNCHANGED;
2408 return indicatePessimisticFixpoint();
2409 }
2410
2411 /// See AbstractAttribute::trackStatistics()
2412 void trackStatistics() const override { STATS_DECLTRACK_CSARG_ATTR(nofree) };
2413};
2414
2415/// NoFree attribute for function return value.
2416struct AANoFreeReturned final : AANoFreeFloating {
2417 AANoFreeReturned(const IRPosition &IRP, Attributor &A)
2418 : AANoFreeFloating(IRP, A) {
2419 llvm_unreachable("NoFree is not applicable to function returns!");
2420 }
2421
2422 /// See AbstractAttribute::initialize(...).
2423 void initialize(Attributor &A) override {
2424 llvm_unreachable("NoFree is not applicable to function returns!");
2425 }
2426
2427 /// See AbstractAttribute::updateImpl(...).
2428 ChangeStatus updateImpl(Attributor &A) override {
2429 llvm_unreachable("NoFree is not applicable to function returns!");
2430 }
2431
2432 /// See AbstractAttribute::trackStatistics()
2433 void trackStatistics() const override {}
2434};
2435
2436/// NoFree attribute deduction for a call site return value.
2437struct AANoFreeCallSiteReturned final : AANoFreeFloating {
2438 AANoFreeCallSiteReturned(const IRPosition &IRP, Attributor &A)
2439 : AANoFreeFloating(IRP, A) {}
2440
2441 ChangeStatus manifest(Attributor &A) override {
2442 return ChangeStatus::UNCHANGED;
2443 }
2444 /// See AbstractAttribute::trackStatistics()
2445 void trackStatistics() const override { STATS_DECLTRACK_CSRET_ATTR(nofree) }
2446};
2447} // namespace
2448
2449/// ------------------------ NonNull Argument Attribute ------------------------
2450
2452 Attribute::AttrKind ImpliedAttributeKind,
2453 bool IgnoreSubsumingPositions) {
2455 AttrKinds.push_back(Attribute::NonNull);
2458 AttrKinds.push_back(Attribute::Dereferenceable);
2459 if (A.hasAttr(IRP, AttrKinds, IgnoreSubsumingPositions, Attribute::NonNull))
2460 return true;
2461
2462 DominatorTree *DT = nullptr;
2463 AssumptionCache *AC = nullptr;
2464 InformationCache &InfoCache = A.getInfoCache();
2465 if (const Function *Fn = IRP.getAnchorScope()) {
2466 if (!Fn->isDeclaration()) {
2469 }
2470 }
2471
2473 if (IRP.getPositionKind() != IRP_RETURNED) {
2474 Worklist.push_back({IRP.getAssociatedValue(), IRP.getCtxI()});
2475 } else {
2476 bool UsedAssumedInformation = false;
2477 if (!A.checkForAllInstructions(
2478 [&](Instruction &I) {
2479 Worklist.push_back({*cast<ReturnInst>(I).getReturnValue(), &I});
2480 return true;
2481 },
2482 IRP.getAssociatedFunction(), nullptr, {Instruction::Ret},
2483 UsedAssumedInformation, false, /*CheckPotentiallyDead=*/true))
2484 return false;
2485 }
2486
2487 if (llvm::any_of(Worklist, [&](AA::ValueAndContext VAC) {
2488 return !isKnownNonZero(
2489 VAC.getValue(),
2490 SimplifyQuery(A.getDataLayout(), DT, AC, VAC.getCtxI()));
2491 }))
2492 return false;
2493
2494 A.manifestAttrs(IRP, {Attribute::get(IRP.getAnchorValue().getContext(),
2495 Attribute::NonNull)});
2496 return true;
2497}
2498
2499namespace {
2500static int64_t getKnownNonNullAndDerefBytesForUse(
2501 Attributor &A, const AbstractAttribute &QueryingAA, Value &AssociatedValue,
2502 const Use *U, const Instruction *I, bool &IsNonNull, bool &TrackUse) {
2503 TrackUse = false;
2504
2505 const Value *UseV = U->get();
2506 if (!UseV->getType()->isPointerTy())
2507 return 0;
2508
2509 // We need to follow common pointer manipulation uses to the accesses they
2510 // feed into. We can try to be smart to avoid looking through things we do not
2511 // like for now, e.g., non-inbounds GEPs.
2512 if (isa<CastInst>(I)) {
2513 TrackUse = true;
2514 return 0;
2515 }
2516
2518 TrackUse = true;
2519 return 0;
2520 }
2521
2522 Type *PtrTy = UseV->getType();
2523 const Function *F = I->getFunction();
2526 const DataLayout &DL = A.getInfoCache().getDL();
2527 if (const auto *CB = dyn_cast<CallBase>(I)) {
2528 if (CB->isBundleOperand(U)) {
2529 if (RetainedKnowledge RK = getKnowledgeFromUse(
2530 U, {Attribute::NonNull, Attribute::Dereferenceable})) {
2531 IsNonNull |=
2532 (RK.AttrKind == Attribute::NonNull || !NullPointerIsDefined);
2533 return RK.ArgValue;
2534 }
2535 return 0;
2536 }
2537
2538 if (CB->isCallee(U)) {
2539 IsNonNull |= !NullPointerIsDefined;
2540 return 0;
2541 }
2542
2543 unsigned ArgNo = CB->getArgOperandNo(U);
2544 IRPosition IRP = IRPosition::callsite_argument(*CB, ArgNo);
2545 // As long as we only use known information there is no need to track
2546 // dependences here.
2547 bool IsKnownNonNull;
2549 DepClassTy::NONE, IsKnownNonNull);
2550 IsNonNull |= IsKnownNonNull;
2551 auto *DerefAA =
2552 A.getAAFor<AADereferenceable>(QueryingAA, IRP, DepClassTy::NONE);
2553 return DerefAA ? DerefAA->getKnownDereferenceableBytes() : 0;
2554 }
2555
2556 std::optional<MemoryLocation> Loc = MemoryLocation::getOrNone(I);
2557 if (!Loc || Loc->Ptr != UseV || !Loc->Size.isPrecise() ||
2558 Loc->Size.isScalable() || I->isVolatile())
2559 return 0;
2560
2561 int64_t Offset;
2562 const Value *Base =
2563 getMinimalBaseOfPointer(A, QueryingAA, Loc->Ptr, Offset, DL);
2564 if (Base && Base == &AssociatedValue) {
2565 int64_t DerefBytes = Loc->Size.getValue() + Offset;
2566 IsNonNull |= !NullPointerIsDefined;
2567 return std::max(int64_t(0), DerefBytes);
2568 }
2569
2570 /// Corner case when an offset is 0.
2572 /*AllowNonInbounds*/ true);
2573 if (Base && Base == &AssociatedValue && Offset == 0) {
2574 int64_t DerefBytes = Loc->Size.getValue();
2575 IsNonNull |= !NullPointerIsDefined;
2576 return std::max(int64_t(0), DerefBytes);
2577 }
2578
2579 return 0;
2580}
2581
2582struct AANonNullImpl : AANonNull {
2583 AANonNullImpl(const IRPosition &IRP, Attributor &A) : AANonNull(IRP, A) {}
2584
2585 /// See AbstractAttribute::initialize(...).
2586 void initialize(Attributor &A) override {
2587 Value &V = *getAssociatedValue().stripPointerCasts();
2588 if (isa<ConstantPointerNull>(V)) {
2589 indicatePessimisticFixpoint();
2590 return;
2591 }
2592
2593 if (Instruction *CtxI = getCtxI())
2594 followUsesInMBEC(*this, A, getState(), *CtxI);
2595 }
2596
2597 /// See followUsesInMBEC
2598 bool followUseInMBEC(Attributor &A, const Use *U, const Instruction *I,
2599 AANonNull::StateType &State) {
2600 bool IsNonNull = false;
2601 bool TrackUse = false;
2602 getKnownNonNullAndDerefBytesForUse(A, *this, getAssociatedValue(), U, I,
2603 IsNonNull, TrackUse);
2604 State.setKnown(IsNonNull);
2605 return TrackUse;
2606 }
2607
2608 /// See AbstractAttribute::getAsStr().
2609 const std::string getAsStr(Attributor *A) const override {
2610 return getAssumed() ? "nonnull" : "may-null";
2611 }
2612};
2613
2614/// NonNull attribute for a floating value.
2615struct AANonNullFloating : public AANonNullImpl {
2616 AANonNullFloating(const IRPosition &IRP, Attributor &A)
2617 : AANonNullImpl(IRP, A) {}
2618
2619 /// See AbstractAttribute::updateImpl(...).
2620 ChangeStatus updateImpl(Attributor &A) override {
2621 auto CheckIRP = [&](const IRPosition &IRP) {
2622 bool IsKnownNonNull;
2624 A, *this, IRP, DepClassTy::OPTIONAL, IsKnownNonNull);
2625 };
2626
2627 bool Stripped;
2628 bool UsedAssumedInformation = false;
2629 Value *AssociatedValue = &getAssociatedValue();
2631 if (!A.getAssumedSimplifiedValues(getIRPosition(), *this, Values,
2632 AA::AnyScope, UsedAssumedInformation))
2633 Stripped = false;
2634 else
2635 Stripped =
2636 Values.size() != 1 || Values.front().getValue() != AssociatedValue;
2637
2638 if (!Stripped) {
2639 bool IsKnown;
2640 if (auto *PHI = dyn_cast<PHINode>(AssociatedValue))
2641 if (llvm::all_of(PHI->incoming_values(), [&](Value *Op) {
2642 return AA::hasAssumedIRAttr<Attribute::NonNull>(
2643 A, this, IRPosition::value(*Op), DepClassTy::OPTIONAL,
2644 IsKnown);
2645 }))
2646 return ChangeStatus::UNCHANGED;
2647 if (auto *Select = dyn_cast<SelectInst>(AssociatedValue))
2649 A, this, IRPosition::value(*Select->getFalseValue()),
2650 DepClassTy::OPTIONAL, IsKnown) &&
2652 A, this, IRPosition::value(*Select->getTrueValue()),
2653 DepClassTy::OPTIONAL, IsKnown))
2654 return ChangeStatus::UNCHANGED;
2655
2656 // If we haven't stripped anything we might still be able to use a
2657 // different AA, but only if the IRP changes. Effectively when we
2658 // interpret this not as a call site value but as a floating/argument
2659 // value.
2660 const IRPosition AVIRP = IRPosition::value(*AssociatedValue);
2661 if (AVIRP == getIRPosition() || !CheckIRP(AVIRP))
2662 return indicatePessimisticFixpoint();
2663 return ChangeStatus::UNCHANGED;
2664 }
2665
2666 for (const auto &VAC : Values)
2667 if (!CheckIRP(IRPosition::value(*VAC.getValue())))
2668 return indicatePessimisticFixpoint();
2669
2670 return ChangeStatus::UNCHANGED;
2671 }
2672
2673 /// See AbstractAttribute::trackStatistics()
2674 void trackStatistics() const override { STATS_DECLTRACK_FNRET_ATTR(nonnull) }
2675};
2676
2677/// NonNull attribute for function return value.
2678struct AANonNullReturned final
2679 : AAReturnedFromReturnedValues<AANonNull, AANonNull, AANonNull::StateType,
2680 false, AANonNull::IRAttributeKind, false> {
2681 AANonNullReturned(const IRPosition &IRP, Attributor &A)
2682 : AAReturnedFromReturnedValues<AANonNull, AANonNull, AANonNull::StateType,
2683 false, Attribute::NonNull, false>(IRP, A) {
2684 }
2685
2686 /// See AbstractAttribute::getAsStr().
2687 const std::string getAsStr(Attributor *A) const override {
2688 return getAssumed() ? "nonnull" : "may-null";
2689 }
2690
2691 /// See AbstractAttribute::trackStatistics()
2692 void trackStatistics() const override { STATS_DECLTRACK_FNRET_ATTR(nonnull) }
2693};
2694
2695/// NonNull attribute for function argument.
2696struct AANonNullArgument final
2697 : AAArgumentFromCallSiteArguments<AANonNull, AANonNullImpl> {
2698 AANonNullArgument(const IRPosition &IRP, Attributor &A)
2699 : AAArgumentFromCallSiteArguments<AANonNull, AANonNullImpl>(IRP, A) {}
2700
2701 /// See AbstractAttribute::trackStatistics()
2702 void trackStatistics() const override { STATS_DECLTRACK_ARG_ATTR(nonnull) }
2703};
2704
2705struct AANonNullCallSiteArgument final : AANonNullFloating {
2706 AANonNullCallSiteArgument(const IRPosition &IRP, Attributor &A)
2707 : AANonNullFloating(IRP, A) {}
2708
2709 /// See AbstractAttribute::trackStatistics()
2710 void trackStatistics() const override { STATS_DECLTRACK_CSARG_ATTR(nonnull) }
2711};
2712
2713/// NonNull attribute for a call site return position.
2714struct AANonNullCallSiteReturned final
2715 : AACalleeToCallSite<AANonNull, AANonNullImpl> {
2716 AANonNullCallSiteReturned(const IRPosition &IRP, Attributor &A)
2717 : AACalleeToCallSite<AANonNull, AANonNullImpl>(IRP, A) {}
2718
2719 /// See AbstractAttribute::trackStatistics()
2720 void trackStatistics() const override { STATS_DECLTRACK_CSRET_ATTR(nonnull) }
2721};
2722} // namespace
2723
2724/// ------------------------ Must-Progress Attributes --------------------------
2725namespace {
2726struct AAMustProgressImpl : public AAMustProgress {
2727 AAMustProgressImpl(const IRPosition &IRP, Attributor &A)
2728 : AAMustProgress(IRP, A) {}
2729
2730 /// See AbstractAttribute::initialize(...).
2731 void initialize(Attributor &A) override {
2732 bool IsKnown;
2734 A, nullptr, getIRPosition(), DepClassTy::NONE, IsKnown));
2735 (void)IsKnown;
2736 }
2737
2738 /// See AbstractAttribute::getAsStr()
2739 const std::string getAsStr(Attributor *A) const override {
2740 return getAssumed() ? "mustprogress" : "may-not-progress";
2741 }
2742};
2743
2744struct AAMustProgressFunction final : AAMustProgressImpl {
2745 AAMustProgressFunction(const IRPosition &IRP, Attributor &A)
2746 : AAMustProgressImpl(IRP, A) {}
2747
2748 /// See AbstractAttribute::updateImpl(...).
2749 ChangeStatus updateImpl(Attributor &A) override {
2750 bool IsKnown;
2752 A, this, getIRPosition(), DepClassTy::OPTIONAL, IsKnown)) {
2753 if (IsKnown)
2754 return indicateOptimisticFixpoint();
2755 return ChangeStatus::UNCHANGED;
2756 }
2757
2758 auto CheckForMustProgress = [&](AbstractCallSite ACS) {
2759 IRPosition IPos = IRPosition::callsite_function(*ACS.getInstruction());
2760 bool IsKnownMustProgress;
2762 A, this, IPos, DepClassTy::REQUIRED, IsKnownMustProgress,
2763 /* IgnoreSubsumingPositions */ true);
2764 };
2765
2766 bool AllCallSitesKnown = true;
2767 if (!A.checkForAllCallSites(CheckForMustProgress, *this,
2768 /* RequireAllCallSites */ true,
2769 AllCallSitesKnown))
2770 return indicatePessimisticFixpoint();
2771
2772 return ChangeStatus::UNCHANGED;
2773 }
2774
2775 /// See AbstractAttribute::trackStatistics()
2776 void trackStatistics() const override {
2777 STATS_DECLTRACK_FN_ATTR(mustprogress)
2778 }
2779};
2780
2781/// MustProgress attribute deduction for a call sites.
2782struct AAMustProgressCallSite final : AAMustProgressImpl {
2783 AAMustProgressCallSite(const IRPosition &IRP, Attributor &A)
2784 : AAMustProgressImpl(IRP, A) {}
2785
2786 /// See AbstractAttribute::updateImpl(...).
2787 ChangeStatus updateImpl(Attributor &A) override {
2788 // TODO: Once we have call site specific value information we can provide
2789 // call site specific liveness information and then it makes
2790 // sense to specialize attributes for call sites arguments instead of
2791 // redirecting requests to the callee argument.
2792 const IRPosition &FnPos = IRPosition::function(*getAnchorScope());
2793 bool IsKnownMustProgress;
2795 A, this, FnPos, DepClassTy::REQUIRED, IsKnownMustProgress))
2796 return indicatePessimisticFixpoint();
2797 return ChangeStatus::UNCHANGED;
2798 }
2799
2800 /// See AbstractAttribute::trackStatistics()
2801 void trackStatistics() const override {
2802 STATS_DECLTRACK_CS_ATTR(mustprogress);
2803 }
2804};
2805} // namespace
2806
2807/// ------------------------ No-Recurse Attributes ----------------------------
2808
2809namespace {
2810struct AANoRecurseImpl : public AANoRecurse {
2811 AANoRecurseImpl(const IRPosition &IRP, Attributor &A) : AANoRecurse(IRP, A) {}
2812
2813 /// See AbstractAttribute::initialize(...).
2814 void initialize(Attributor &A) override {
2815 bool IsKnown;
2817 A, nullptr, getIRPosition(), DepClassTy::NONE, IsKnown));
2818 (void)IsKnown;
2819 }
2820
2821 /// See AbstractAttribute::getAsStr()
2822 const std::string getAsStr(Attributor *A) const override {
2823 return getAssumed() ? "norecurse" : "may-recurse";
2824 }
2825};
2826
2827struct AANoRecurseFunction final : AANoRecurseImpl {
2828 AANoRecurseFunction(const IRPosition &IRP, Attributor &A)
2829 : AANoRecurseImpl(IRP, A) {}
2830
2831 /// See AbstractAttribute::updateImpl(...).
2832 ChangeStatus updateImpl(Attributor &A) override {
2833
2834 // If all live call sites are known to be no-recurse, we are as well.
2835 auto CallSitePred = [&](AbstractCallSite ACS) {
2836 bool IsKnownNoRecurse;
2838 A, this,
2839 IRPosition::function(*ACS.getInstruction()->getFunction()),
2840 DepClassTy::NONE, IsKnownNoRecurse))
2841 return false;
2842 return IsKnownNoRecurse;
2843 };
2844 bool UsedAssumedInformation = false;
2845 if (A.checkForAllCallSites(CallSitePred, *this, true,
2846 UsedAssumedInformation)) {
2847 // If we know all call sites and all are known no-recurse, we are done.
2848 // If all known call sites, which might not be all that exist, are known
2849 // to be no-recurse, we are not done but we can continue to assume
2850 // no-recurse. If one of the call sites we have not visited will become
2851 // live, another update is triggered.
2852 if (!UsedAssumedInformation)
2853 indicateOptimisticFixpoint();
2854 return ChangeStatus::UNCHANGED;
2855 }
2856
2857 const AAInterFnReachability *EdgeReachability =
2858 A.getAAFor<AAInterFnReachability>(*this, getIRPosition(),
2859 DepClassTy::REQUIRED);
2860 if (EdgeReachability && EdgeReachability->canReach(A, *getAnchorScope()))
2861 return indicatePessimisticFixpoint();
2862 return ChangeStatus::UNCHANGED;
2863 }
2864
2865 void trackStatistics() const override { STATS_DECLTRACK_FN_ATTR(norecurse) }
2866};
2867
2868/// NoRecurse attribute deduction for a call sites.
2869struct AANoRecurseCallSite final
2870 : AACalleeToCallSite<AANoRecurse, AANoRecurseImpl> {
2871 AANoRecurseCallSite(const IRPosition &IRP, Attributor &A)
2872 : AACalleeToCallSite<AANoRecurse, AANoRecurseImpl>(IRP, A) {}
2873
2874 /// See AbstractAttribute::trackStatistics()
2875 void trackStatistics() const override { STATS_DECLTRACK_CS_ATTR(norecurse); }
2876};
2877} // namespace
2878
2879/// ------------------------ No-Convergent Attribute --------------------------
2880
2881namespace {
2882struct AANonConvergentImpl : public AANonConvergent {
2883 AANonConvergentImpl(const IRPosition &IRP, Attributor &A)
2884 : AANonConvergent(IRP, A) {}
2885
2886 /// See AbstractAttribute::getAsStr()
2887 const std::string getAsStr(Attributor *A) const override {
2888 return getAssumed() ? "non-convergent" : "may-be-convergent";
2889 }
2890};
2891
2892struct AANonConvergentFunction final : AANonConvergentImpl {
2893 AANonConvergentFunction(const IRPosition &IRP, Attributor &A)
2894 : AANonConvergentImpl(IRP, A) {}
2895
2896 /// See AbstractAttribute::updateImpl(...).
2897 ChangeStatus updateImpl(Attributor &A) override {
2898 // If all function calls are known to not be convergent, we are not
2899 // convergent.
2900 auto CalleeIsNotConvergent = [&](Instruction &Inst) {
2901 CallBase &CB = cast<CallBase>(Inst);
2903 if (!Callee || Callee->isIntrinsic()) {
2904 return false;
2905 }
2906 if (Callee->isDeclaration()) {
2907 return !Callee->hasFnAttribute(Attribute::Convergent);
2908 }
2909 const auto *ConvergentAA = A.getAAFor<AANonConvergent>(
2910 *this, IRPosition::function(*Callee), DepClassTy::REQUIRED);
2911 return ConvergentAA && ConvergentAA->isAssumedNotConvergent();
2912 };
2913
2914 bool UsedAssumedInformation = false;
2915 if (!A.checkForAllCallLikeInstructions(CalleeIsNotConvergent, *this,
2916 UsedAssumedInformation)) {
2917 return indicatePessimisticFixpoint();
2918 }
2919 return ChangeStatus::UNCHANGED;
2920 }
2921
2922 ChangeStatus manifest(Attributor &A) override {
2923 if (isKnownNotConvergent() &&
2924 A.hasAttr(getIRPosition(), Attribute::Convergent)) {
2925 A.removeAttrs(getIRPosition(), {Attribute::Convergent});
2926 return ChangeStatus::CHANGED;
2927 }
2928 return ChangeStatus::UNCHANGED;
2929 }
2930
2931 void trackStatistics() const override { STATS_DECLTRACK_FN_ATTR(convergent) }
2932};
2933} // namespace
2934
2935/// -------------------- Undefined-Behavior Attributes ------------------------
2936
2937namespace {
2938struct AAUndefinedBehaviorImpl : public AAUndefinedBehavior {
2939 AAUndefinedBehaviorImpl(const IRPosition &IRP, Attributor &A)
2940 : AAUndefinedBehavior(IRP, A) {}
2941
2942 struct UBInfo {
2943 enum Kind {
2944 NullPtrAccess,
2945 UndefPtrAccess,
2946 UndefBranchCondition,
2947 UndefReturnValue,
2948 NullReturnViolatesNonNull,
2949 UndefCallArgument,
2950 NullArgViolatesNonNull,
2951 };
2952
2953 Kind K;
2954 std::optional<unsigned> ArgNo;
2955
2956 UBInfo(Kind K) : K(K), ArgNo(std::nullopt) {}
2957
2958 UBInfo(Kind K, std::optional<unsigned> ArgNo) : K(K), ArgNo(ArgNo) {}
2959 };
2960
2961 /// See AbstractAttribute::updateImpl(...).
2962 // through a pointer (i.e. also branches etc.)
2963 ChangeStatus updateImpl(Attributor &A) override {
2964 const size_t UBPrevSize = KnownUBInsts.size();
2965 const size_t NoUBPrevSize = AssumedNoUBInsts.size();
2966
2967 auto InspectMemAccessInstForUB = [&](Instruction &I) {
2968 // Volatile accesses on null are not necessarily UB.
2969 if (I.isVolatile())
2970 return true;
2971
2972 // Skip instructions that are already saved.
2973 if (AssumedNoUBInsts.count(&I) || KnownUBInsts.count(&I))
2974 return true;
2975
2976 // If we reach here, we know we have an instruction
2977 // that accesses memory through a pointer operand,
2978 // for which getPointerOperand() should give it to us.
2979 Value *PtrOp =
2980 const_cast<Value *>(getPointerOperand(&I, /* AllowVolatile */ true));
2981 assert(PtrOp &&
2982 "Expected pointer operand of memory accessing instruction");
2983
2984 // Either we stopped and the appropriate action was taken,
2985 // or we got back a simplified value to continue.
2986 std::optional<Value *> SimplifiedPtrOp =
2987 stopOnUndefOrAssumed(A, PtrOp, &I, UBInfo::UndefPtrAccess);
2988 if (!SimplifiedPtrOp || !*SimplifiedPtrOp)
2989 return true;
2990 const Value *PtrOpVal = *SimplifiedPtrOp;
2991
2992 // A memory access through a pointer is considered UB
2993 // only if the pointer has constant null value.
2994 // TODO: Expand it to not only check constant values.
2995 if (!isa<ConstantPointerNull>(PtrOpVal)) {
2996 AssumedNoUBInsts.insert(&I);
2997 return true;
2998 }
2999 const Type *PtrTy = PtrOpVal->getType();
3000
3001 // Because we only consider instructions inside functions,
3002 // assume that a parent function exists.
3003 const Function *F = I.getFunction();
3004
3005 // A memory access using constant null pointer is only considered UB
3006 // if null pointer is _not_ defined for the target platform.
3008 AssumedNoUBInsts.insert(&I);
3009 else
3010 KnownUBInsts.try_emplace(&I, UBInfo::NullPtrAccess);
3011 return true;
3012 };
3013
3014 auto InspectBrInstForUB = [&](Instruction &I) {
3015 // A conditional branch instruction is considered UB if it has `undef`
3016 // condition.
3017
3018 // Skip instructions that are already saved.
3019 if (AssumedNoUBInsts.count(&I) || KnownUBInsts.count(&I))
3020 return true;
3021
3022 // We know we have a branch instruction.
3023 auto *BrInst = cast<CondBrInst>(&I);
3024
3025 // Either we stopped and the appropriate action was taken,
3026 // or we got back a simplified value to continue.
3027 std::optional<Value *> SimplifiedCond = stopOnUndefOrAssumed(
3028 A, BrInst->getCondition(), BrInst, UBInfo::UndefBranchCondition);
3029 if (!SimplifiedCond || !*SimplifiedCond)
3030 return true;
3031 AssumedNoUBInsts.insert(&I);
3032 return true;
3033 };
3034
3035 auto InspectCallSiteForUB = [&](Instruction &I) {
3036 // Check whether a callsite always cause UB or not
3037
3038 // Skip instructions that are already saved.
3039 if (AssumedNoUBInsts.count(&I) || KnownUBInsts.count(&I))
3040 return true;
3041
3042 // Check nonnull and noundef argument attribute violation for each
3043 // callsite.
3044 CallBase &CB = cast<CallBase>(I);
3046 if (!Callee)
3047 return true;
3048 for (unsigned idx = 0; idx < CB.arg_size(); idx++) {
3049 // If current argument is known to be simplified to null pointer and the
3050 // corresponding argument position is known to have nonnull attribute,
3051 // the argument is poison. Furthermore, if the argument is poison and
3052 // the position is known to have noundef attriubte, this callsite is
3053 // considered UB.
3054 if (idx >= Callee->arg_size())
3055 break;
3056 Value *ArgVal = CB.getArgOperand(idx);
3057 if (!ArgVal)
3058 continue;
3059 // Here, we handle three cases.
3060 // (1) Not having a value means it is dead. (we can replace the value
3061 // with undef)
3062 // (2) Simplified to undef. The argument violate noundef attriubte.
3063 // (3) Simplified to null pointer where known to be nonnull.
3064 // The argument is a poison value and violate noundef attribute.
3065 IRPosition CalleeArgumentIRP = IRPosition::callsite_argument(CB, idx);
3066 bool IsKnownNoUndef;
3068 A, this, CalleeArgumentIRP, DepClassTy::NONE, IsKnownNoUndef);
3069 if (!IsKnownNoUndef)
3070 continue;
3071 bool UsedAssumedInformation = false;
3072 std::optional<Value *> SimplifiedVal =
3073 A.getAssumedSimplified(IRPosition::value(*ArgVal), *this,
3074 UsedAssumedInformation, AA::Interprocedural);
3075 if (UsedAssumedInformation)
3076 continue;
3077 if (SimplifiedVal && !*SimplifiedVal)
3078 return true;
3079 if (!SimplifiedVal || isa<UndefValue>(**SimplifiedVal)) {
3080 KnownUBInsts.try_emplace(&I, UBInfo(UBInfo::UndefCallArgument, idx));
3081 continue;
3082 }
3083 if (!ArgVal->getType()->isPointerTy() ||
3084 !isa<ConstantPointerNull>(**SimplifiedVal))
3085 continue;
3086 bool IsKnownNonNull;
3088 A, this, CalleeArgumentIRP, DepClassTy::NONE, IsKnownNonNull);
3089 if (IsKnownNonNull)
3090 KnownUBInsts.try_emplace(&I,
3091 UBInfo(UBInfo::NullArgViolatesNonNull, idx));
3092 }
3093 return true;
3094 };
3095
3096 auto InspectReturnInstForUB = [&](Instruction &I) {
3097 auto &RI = cast<ReturnInst>(I);
3098 // Either we stopped and the appropriate action was taken,
3099 // or we got back a simplified return value to continue.
3100 std::optional<Value *> SimplifiedRetValue = stopOnUndefOrAssumed(
3101 A, RI.getReturnValue(), &I, UBInfo::UndefReturnValue);
3102 if (!SimplifiedRetValue || !*SimplifiedRetValue)
3103 return true;
3104
3105 // Check if a return instruction always cause UB or not
3106 // Note: It is guaranteed that the returned position of the anchor
3107 // scope has noundef attribute when this is called.
3108 // We also ensure the return position is not "assumed dead"
3109 // because the returned value was then potentially simplified to
3110 // `undef` in AAReturnedValues without removing the `noundef`
3111 // attribute yet.
3112
3113 // When the returned position has noundef attriubte, UB occurs in the
3114 // following cases.
3115 // (1) Returned value is known to be undef.
3116 // (2) The value is known to be a null pointer and the returned
3117 // position has nonnull attribute (because the returned value is
3118 // poison).
3119 if (isa<ConstantPointerNull>(*SimplifiedRetValue)) {
3120 bool IsKnownNonNull;
3122 A, this, IRPosition::returned(*getAnchorScope()), DepClassTy::NONE,
3123 IsKnownNonNull);
3124 if (IsKnownNonNull)
3125 KnownUBInsts.try_emplace(&I, UBInfo::NullReturnViolatesNonNull);
3126 }
3127
3128 return true;
3129 };
3130
3131 bool UsedAssumedInformation = false;
3132 A.checkForAllInstructions(InspectMemAccessInstForUB, *this,
3133 {Instruction::Load, Instruction::Store,
3134 Instruction::AtomicCmpXchg,
3135 Instruction::AtomicRMW},
3136 UsedAssumedInformation,
3137 /* CheckBBLivenessOnly */ true);
3138 A.checkForAllInstructions(InspectBrInstForUB, *this, {Instruction::CondBr},
3139 UsedAssumedInformation,
3140 /* CheckBBLivenessOnly */ true);
3141 A.checkForAllCallLikeInstructions(InspectCallSiteForUB, *this,
3142 UsedAssumedInformation);
3143
3144 // If the returned position of the anchor scope has noundef attriubte, check
3145 // all returned instructions.
3146 if (!getAnchorScope()->getReturnType()->isVoidTy()) {
3147 const IRPosition &ReturnIRP = IRPosition::returned(*getAnchorScope());
3148 if (!A.isAssumedDead(ReturnIRP, this, nullptr, UsedAssumedInformation)) {
3149 bool IsKnownNoUndef;
3151 A, this, ReturnIRP, DepClassTy::NONE, IsKnownNoUndef);
3152 if (IsKnownNoUndef)
3153 A.checkForAllInstructions(InspectReturnInstForUB, *this,
3154 {Instruction::Ret}, UsedAssumedInformation,
3155 /* CheckBBLivenessOnly */ true);
3156 }
3157 }
3158
3159 if (NoUBPrevSize != AssumedNoUBInsts.size() ||
3160 UBPrevSize != KnownUBInsts.size())
3161 return ChangeStatus::CHANGED;
3162 return ChangeStatus::UNCHANGED;
3163 }
3164
3165 bool isKnownToCauseUB(Instruction *I) const override {
3166 return KnownUBInsts.count(I);
3167 }
3168
3169 bool isAssumedToCauseUB(Instruction *I) const override {
3170 // In simple words, if an instruction is not in the assumed to _not_
3171 // cause UB, then it is assumed UB (that includes those
3172 // in the KnownUBInsts set). The rest is boilerplate
3173 // is to ensure that it is one of the instructions we test
3174 // for UB.
3175
3176 switch (I->getOpcode()) {
3177 case Instruction::Load:
3178 case Instruction::Store:
3179 case Instruction::AtomicCmpXchg:
3180 case Instruction::AtomicRMW:
3181 case Instruction::CondBr:
3182 return !AssumedNoUBInsts.count(I);
3183 default:
3184 return false;
3185 }
3186 return false;
3187 }
3188
3189 /// Emit an optimization remark explaining why \p I is known to cause UB,
3190 /// per \p Info, right before it is replaced with 'unreachable'.
3191 static void emitUBRemark(Attributor &A, Instruction *I, const UBInfo &Info) {
3192 auto Remark = [&](OptimizationRemark OR) {
3193 switch (Info.K) {
3194 case UBInfo::NullPtrAccess:
3195 case UBInfo::UndefPtrAccess: {
3196 return OR << "Memory access through a pointer known to be "
3197 << ore::NV("Pointer",
3198 getPointerOperand(I, /*AllowVolatile*/ true))
3199 << " is undefined behavior; replacing with 'unreachable'.";
3200 }
3201 case UBInfo::UndefBranchCondition:
3202 return OR << "Branch condition known to be "
3203 << ore::NV("Condition", cast<CondBrInst>(I)->getCondition())
3204 << " is undefined behavior; replacing with 'unreachable'.";
3205 case UBInfo::UndefReturnValue:
3206 case UBInfo::NullReturnViolatesNonNull:
3207 return OR << "Value returned known to be "
3208 << ore::NV("ReturnValue",
3209 cast<ReturnInst>(I)->getReturnValue())
3210 << " is undefined behavior; replacing with 'unreachable'.";
3211 case UBInfo::UndefCallArgument:
3212 case UBInfo::NullArgViolatesNonNull: {
3213 bool IsUndef = Info.K == UBInfo::UndefCallArgument;
3214 CallBase &CB = *cast<CallBase>(I);
3215 OR << "Argument " << ore::NV("ArgNo", *Info.ArgNo)
3216 << " passed to parameter of ";
3217 if (auto *Callee = dyn_cast_if_present<Function>(CB.getCalledOperand()))
3218 OR << ore::NV("Callee", Callee);
3219 else
3220 OR << "the callee";
3221 return OR << " known to be "
3222 << ore::NV("Argument", IsUndef ? "undef" : "null")
3223 << " is undefined behavior; replacing with 'unreachable'.";
3224 }
3225 }
3226 llvm_unreachable("Unknown UBInfo::Kind");
3227 };
3228 A.emitRemark<OptimizationRemark>(I, "UndefinedBehavior", Remark);
3229 }
3230
3231 ChangeStatus manifest(Attributor &A) override {
3232 if (KnownUBInsts.empty())
3233 return ChangeStatus::UNCHANGED;
3234 for (const auto &[I, Info] : KnownUBInsts) {
3235 emitUBRemark(A, I, Info);
3236 A.changeToUnreachableAfterManifest(I);
3237 }
3238 return ChangeStatus::CHANGED;
3239 }
3240
3241 /// See AbstractAttribute::getAsStr()
3242 const std::string getAsStr(Attributor *A) const override {
3243 return getAssumed() ? "undefined-behavior" : "no-ub";
3244 }
3245
3246 /// Note: The correctness of this analysis depends on the fact that the
3247 /// following 2 sets will stop changing after some point.
3248 /// "Change" here means that their size changes.
3249 /// The size of each set is monotonically increasing
3250 /// (we only add items to them) and it is upper bounded by the number of
3251 /// instructions in the processed function (we can never save more
3252 /// elements in either set than this number). Hence, at some point,
3253 /// they will stop increasing.
3254 /// Consequently, at some point, both sets will have stopped
3255 /// changing, effectively making the analysis reach a fixpoint.
3256
3257 /// Note: These 2 sets are disjoint and an instruction can be considered
3258 /// one of 3 things:
3259 /// 1) Known to cause UB (AAUndefinedBehavior could prove it) and put it in
3260 /// the KnownUBInsts set.
3261 /// 2) Assumed to cause UB (in every updateImpl, AAUndefinedBehavior
3262 /// has a reason to assume it).
3263 /// 3) Assumed to not cause UB. very other instruction - AAUndefinedBehavior
3264 /// could not find a reason to assume or prove that it can cause UB,
3265 /// hence it assumes it doesn't. We have a set for these instructions
3266 /// so that we don't reprocess them in every update.
3267 /// Note however that instructions in this set may cause UB.
3268
3269protected:
3270 /// A map from all live instructions _known_ to cause UB to the reason why,
3271 /// used to build actionable optimization remarks in manifest().
3272 MapVector<Instruction *, UBInfo> KnownUBInsts;
3273
3274private:
3275 /// A set of all the (live) instructions that are assumed to _not_ cause UB.
3276 SmallPtrSet<Instruction *, 8> AssumedNoUBInsts;
3277
3278 // Should be called on updates in which if we're processing an instruction
3279 // \p I that depends on a value \p V, one of the following has to happen:
3280 // - If the value is assumed, then stop.
3281 // - If the value is known but undef, then consider it UB for \p K.
3282 // - Otherwise, do specific processing with the simplified value.
3283 // We return std::nullopt in the first 2 cases to signify that an appropriate
3284 // action was taken and the caller should stop.
3285 // Otherwise, we return the simplified value that the caller should
3286 // use for specific processing.
3287 std::optional<Value *> stopOnUndefOrAssumed(Attributor &A, Value *V,
3288 Instruction *I, UBInfo::Kind K) {
3289 bool UsedAssumedInformation = false;
3290 std::optional<Value *> SimplifiedV =
3291 A.getAssumedSimplified(IRPosition::value(*V), *this,
3292 UsedAssumedInformation, AA::Interprocedural);
3293 if (!UsedAssumedInformation) {
3294 // Don't depend on assumed values.
3295 if (!SimplifiedV) {
3296 // If it is known (which we tested above) but it doesn't have a value,
3297 // then we can assume `undef` and hence the instruction is UB.
3298 KnownUBInsts.try_emplace(I, K);
3299 return std::nullopt;
3300 }
3301 if (!*SimplifiedV)
3302 return nullptr;
3303 V = *SimplifiedV;
3304 }
3305 if (isa<UndefValue>(V)) {
3306 KnownUBInsts.try_emplace(I, K);
3307 return std::nullopt;
3308 }
3309 return V;
3310 }
3311};
3312
3313struct AAUndefinedBehaviorFunction final : AAUndefinedBehaviorImpl {
3314 AAUndefinedBehaviorFunction(const IRPosition &IRP, Attributor &A)
3315 : AAUndefinedBehaviorImpl(IRP, A) {}
3316
3317 /// See AbstractAttribute::trackStatistics()
3318 void trackStatistics() const override {
3319 STATS_DECL(UndefinedBehaviorInstruction, Instruction,
3320 "Number of instructions known to have UB");
3321 BUILD_STAT_NAME(UndefinedBehaviorInstruction, Instruction) +=
3322 KnownUBInsts.size();
3323 }
3324};
3325} // namespace
3326
3327/// ------------------------ Will-Return Attributes ----------------------------
3328
3329namespace {
3330// Helper function that checks whether a function has any cycle which we don't
3331// know if it is bounded or not.
3332// Loops with maximum trip count are considered bounded, any other cycle not.
3333static bool mayContainUnboundedCycle(Function &F, Attributor &A) {
3334 ScalarEvolution *SE =
3335 A.getInfoCache().getAnalysisResultForFunction<ScalarEvolutionAnalysis>(F);
3336 LoopInfo *LI = A.getInfoCache().getAnalysisResultForFunction<LoopAnalysis>(F);
3337 // If either SCEV or LoopInfo is not available for the function then we assume
3338 // any cycle to be unbounded cycle.
3339 // We use scc_iterator which uses Tarjan algorithm to find all the maximal
3340 // SCCs.To detect if there's a cycle, we only need to find the maximal ones.
3341 if (!SE || !LI) {
3342 for (scc_iterator<Function *> SCCI = scc_begin(&F); !SCCI.isAtEnd(); ++SCCI)
3343 if (SCCI.hasCycle())
3344 return true;
3345 return false;
3346 }
3347
3348 // If there's irreducible control, the function may contain non-loop cycles.
3350 return true;
3351
3352 // Any loop that does not have a max trip count is considered unbounded cycle.
3353 for (auto *L : LI->getLoopsInPreorder()) {
3354 if (!SE->getSmallConstantMaxTripCount(L))
3355 return true;
3356 }
3357 return false;
3358}
3359
3360struct AAWillReturnImpl : public AAWillReturn {
3361 AAWillReturnImpl(const IRPosition &IRP, Attributor &A)
3362 : AAWillReturn(IRP, A) {}
3363
3364 /// See AbstractAttribute::initialize(...).
3365 void initialize(Attributor &A) override {
3366 bool IsKnown;
3368 A, nullptr, getIRPosition(), DepClassTy::NONE, IsKnown));
3369 (void)IsKnown;
3370 }
3371
3372 /// Check for `mustprogress` and `readonly` as they imply `willreturn`.
3373 bool isImpliedByMustprogressAndReadonly(Attributor &A, bool KnownOnly) {
3374 if (!A.hasAttr(getIRPosition(), {Attribute::MustProgress}))
3375 return false;
3376
3377 bool IsKnown;
3378 if (AA::isAssumedReadOnly(A, getIRPosition(), *this, IsKnown))
3379 return IsKnown || !KnownOnly;
3380 return false;
3381 }
3382
3383 /// See AbstractAttribute::updateImpl(...).
3384 ChangeStatus updateImpl(Attributor &A) override {
3385 if (isImpliedByMustprogressAndReadonly(A, /* KnownOnly */ false))
3386 return ChangeStatus::UNCHANGED;
3387
3388 auto CheckForWillReturn = [&](Instruction &I) {
3390 bool IsKnown;
3392 A, this, IPos, DepClassTy::REQUIRED, IsKnown)) {
3393 if (IsKnown)
3394 return true;
3395 } else {
3396 return false;
3397 }
3398 bool IsKnownNoRecurse;
3400 A, this, IPos, DepClassTy::REQUIRED, IsKnownNoRecurse);
3401 };
3402
3403 bool UsedAssumedInformation = false;
3404 if (!A.checkForAllCallLikeInstructions(CheckForWillReturn, *this,
3405 UsedAssumedInformation))
3406 return indicatePessimisticFixpoint();
3407
3408 auto CheckForVolatile = [&](Instruction &I) {
3409 // Volatile operations are not willreturn.
3410 return !I.isVolatile();
3411 };
3412 if (!A.checkForAllInstructions(CheckForVolatile, *this,
3413 {Instruction::Load, Instruction::Store,
3414 Instruction::AtomicCmpXchg,
3415 Instruction::AtomicRMW},
3416 UsedAssumedInformation))
3417 return indicatePessimisticFixpoint();
3418
3419 return ChangeStatus::UNCHANGED;
3420 }
3421
3422 /// See AbstractAttribute::getAsStr()
3423 const std::string getAsStr(Attributor *A) const override {
3424 return getAssumed() ? "willreturn" : "may-noreturn";
3425 }
3426};
3427
3428struct AAWillReturnFunction final : AAWillReturnImpl {
3429 AAWillReturnFunction(const IRPosition &IRP, Attributor &A)
3430 : AAWillReturnImpl(IRP, A) {}
3431
3432 /// See AbstractAttribute::initialize(...).
3433 void initialize(Attributor &A) override {
3434 AAWillReturnImpl::initialize(A);
3435
3436 Function *F = getAnchorScope();
3437 assert(F && "Did expect an anchor function");
3438 if (F->isDeclaration() || mayContainUnboundedCycle(*F, A))
3439 indicatePessimisticFixpoint();
3440 }
3441
3442 /// See AbstractAttribute::trackStatistics()
3443 void trackStatistics() const override { STATS_DECLTRACK_FN_ATTR(willreturn) }
3444};
3445
3446/// WillReturn attribute deduction for a call sites.
3447struct AAWillReturnCallSite final
3448 : AACalleeToCallSite<AAWillReturn, AAWillReturnImpl> {
3449 AAWillReturnCallSite(const IRPosition &IRP, Attributor &A)
3450 : AACalleeToCallSite<AAWillReturn, AAWillReturnImpl>(IRP, A) {}
3451
3452 /// See AbstractAttribute::updateImpl(...).
3453 ChangeStatus updateImpl(Attributor &A) override {
3454 if (isImpliedByMustprogressAndReadonly(A, /* KnownOnly */ false))
3455 return ChangeStatus::UNCHANGED;
3456
3457 return AACalleeToCallSite::updateImpl(A);
3458 }
3459
3460 /// See AbstractAttribute::trackStatistics()
3461 void trackStatistics() const override { STATS_DECLTRACK_CS_ATTR(willreturn); }
3462};
3463} // namespace
3464
3465/// -------------------AAIntraFnReachability Attribute--------------------------
3466
3467/// All information associated with a reachability query. This boilerplate code
3468/// is used by both AAIntraFnReachability and AAInterFnReachability, with
3469/// different \p ToTy values.
3470template <typename ToTy> struct ReachabilityQueryInfo {
3471 enum class Reachable {
3474 };
3475
3476 /// Start here,
3477 const Instruction *From = nullptr;
3478 /// reach this place,
3479 const ToTy *To = nullptr;
3480 /// without going through any of these instructions,
3482 /// and remember if it worked:
3484
3485 /// Precomputed hash for this RQI.
3486 unsigned Hash = 0;
3487
3488 unsigned computeHashValue() const {
3489 assert(Hash == 0 && "Computed hash twice!");
3492 return const_cast<ReachabilityQueryInfo<ToTy> *>(this)->Hash =
3493 detail::combineHashValue(PairDMI ::getHashValue({From, To}),
3494 InstSetDMI::getHashValue(ExclusionSet));
3495 }
3496
3498 : From(From), To(To) {}
3499
3500 /// Constructor replacement to ensure unique and stable sets are used for the
3501 /// cache.
3503 const AA::InstExclusionSetTy *ES, bool MakeUnique)
3504 : From(&From), To(&To), ExclusionSet(ES) {
3505
3506 if (!ES || ES->empty()) {
3507 ExclusionSet = nullptr;
3508 } else if (MakeUnique) {
3509 ExclusionSet = A.getInfoCache().getOrCreateUniqueBlockExecutionSet(ES);
3510 }
3511 }
3512
3515};
3516
3517namespace llvm {
3518template <typename ToTy> struct DenseMapInfo<ReachabilityQueryInfo<ToTy> *> {
3521
3522 static unsigned getHashValue(const ReachabilityQueryInfo<ToTy> *RQI) {
3523 return RQI->Hash ? RQI->Hash : RQI->computeHashValue();
3524 }
3525 static bool isEqual(const ReachabilityQueryInfo<ToTy> *LHS,
3526 const ReachabilityQueryInfo<ToTy> *RHS) {
3527 if (!PairDMI::isEqual({LHS->From, LHS->To}, {RHS->From, RHS->To}))
3528 return false;
3529 return InstSetDMI::isEqual(LHS->ExclusionSet, RHS->ExclusionSet);
3530 }
3531};
3532
3533} // namespace llvm
3534
3535namespace {
3536
3537template <typename BaseTy, typename ToTy>
3538struct CachedReachabilityAA : public BaseTy {
3539 using RQITy = ReachabilityQueryInfo<ToTy>;
3540
3541 CachedReachabilityAA(const IRPosition &IRP, Attributor &A) : BaseTy(IRP, A) {}
3542
3543 /// See AbstractAttribute::isQueryAA.
3544 bool isQueryAA() const override { return true; }
3545
3546 /// See AbstractAttribute::updateImpl(...).
3547 ChangeStatus updateImpl(Attributor &A) override {
3548 ChangeStatus Changed = ChangeStatus::UNCHANGED;
3549 for (unsigned u = 0, e = QueryVector.size(); u < e; ++u) {
3550 RQITy *RQI = QueryVector[u];
3551 if (RQI->Result == RQITy::Reachable::No &&
3552 isReachableImpl(A, *RQI, /*IsTemporaryRQI=*/false))
3553 Changed = ChangeStatus::CHANGED;
3554 }
3555 return Changed;
3556 }
3557
3558 virtual bool isReachableImpl(Attributor &A, RQITy &RQI,
3559 bool IsTemporaryRQI) = 0;
3560
3561 bool rememberResult(Attributor &A, typename RQITy::Reachable Result,
3562 RQITy &RQI, bool UsedExclusionSet, bool IsTemporaryRQI) {
3563 RQI.Result = Result;
3564
3565 // Remove the temporary RQI from the cache.
3566 if (IsTemporaryRQI)
3567 QueryCache.erase(&RQI);
3568
3569 // Insert a plain RQI (w/o exclusion set) if that makes sense. Two options:
3570 // 1) If it is reachable, it doesn't matter if we have an exclusion set for
3571 // this query. 2) We did not use the exclusion set, potentially because
3572 // there is none.
3573 if (Result == RQITy::Reachable::Yes || !UsedExclusionSet) {
3574 RQITy PlainRQI(RQI.From, RQI.To);
3575 if (!QueryCache.count(&PlainRQI)) {
3576 RQITy *RQIPtr = new (A.Allocator) RQITy(RQI.From, RQI.To);
3577 RQIPtr->Result = Result;
3578 QueryVector.push_back(RQIPtr);
3579 QueryCache.insert(RQIPtr);
3580 }
3581 }
3582
3583 // Check if we need to insert a new permanent RQI with the exclusion set.
3584 if (IsTemporaryRQI && Result != RQITy::Reachable::Yes && UsedExclusionSet) {
3585 assert((!RQI.ExclusionSet || !RQI.ExclusionSet->empty()) &&
3586 "Did not expect empty set!");
3587 RQITy *RQIPtr = new (A.Allocator)
3588 RQITy(A, *RQI.From, *RQI.To, RQI.ExclusionSet, true);
3589 assert(RQIPtr->Result == RQITy::Reachable::No && "Already reachable?");
3590 RQIPtr->Result = Result;
3591 assert(!QueryCache.count(RQIPtr));
3592 QueryVector.push_back(RQIPtr);
3593 QueryCache.insert(RQIPtr);
3594 }
3595
3596 if (Result == RQITy::Reachable::No && IsTemporaryRQI)
3597 A.registerForUpdate(*this);
3598 return Result == RQITy::Reachable::Yes;
3599 }
3600
3601 const std::string getAsStr(Attributor *A) const override {
3602 // TODO: Return the number of reachable queries.
3603 return "#queries(" + std::to_string(QueryVector.size()) + ")";
3604 }
3605
3606 bool checkQueryCache(Attributor &A, RQITy &StackRQI,
3607 typename RQITy::Reachable &Result) {
3608 if (!this->getState().isValidState()) {
3609 Result = RQITy::Reachable::Yes;
3610 return true;
3611 }
3612
3613 // If we have an exclusion set we might be able to find our answer by
3614 // ignoring it first.
3615 if (StackRQI.ExclusionSet) {
3616 RQITy PlainRQI(StackRQI.From, StackRQI.To);
3617 auto It = QueryCache.find(&PlainRQI);
3618 if (It != QueryCache.end() && (*It)->Result == RQITy::Reachable::No) {
3619 Result = RQITy::Reachable::No;
3620 return true;
3621 }
3622 }
3623
3624 auto It = QueryCache.find(&StackRQI);
3625 if (It != QueryCache.end()) {
3626 Result = (*It)->Result;
3627 return true;
3628 }
3629
3630 // Insert a temporary for recursive queries. We will replace it with a
3631 // permanent entry later.
3632 QueryCache.insert(&StackRQI);
3633 return false;
3634 }
3635
3636private:
3637 SmallVector<RQITy *> QueryVector;
3638 DenseSet<RQITy *> QueryCache;
3639};
3640
3641struct AAIntraFnReachabilityFunction final
3642 : public CachedReachabilityAA<AAIntraFnReachability, Instruction> {
3643 using Base = CachedReachabilityAA<AAIntraFnReachability, Instruction>;
3644 AAIntraFnReachabilityFunction(const IRPosition &IRP, Attributor &A)
3645 : Base(IRP, A) {
3646 DT = A.getInfoCache().getAnalysisResultForFunction<DominatorTreeAnalysis>(
3647 *IRP.getAssociatedFunction());
3648 }
3649
3650 bool isAssumedReachable(
3651 Attributor &A, const Instruction &From, const Instruction &To,
3652 const AA::InstExclusionSetTy *ExclusionSet) const override {
3653 auto *NonConstThis = const_cast<AAIntraFnReachabilityFunction *>(this);
3654 if (&From == &To)
3655 return true;
3656
3657 RQITy StackRQI(A, From, To, ExclusionSet, false);
3658 RQITy::Reachable Result;
3659 if (!NonConstThis->checkQueryCache(A, StackRQI, Result))
3660 return NonConstThis->isReachableImpl(A, StackRQI,
3661 /*IsTemporaryRQI=*/true);
3662 return Result == RQITy::Reachable::Yes;
3663 }
3664
3665 ChangeStatus updateImpl(Attributor &A) override {
3666 // We only depend on liveness. DeadEdges is all we care about, check if any
3667 // of them changed.
3668 auto *LivenessAA =
3669 A.getAAFor<AAIsDead>(*this, getIRPosition(), DepClassTy::OPTIONAL);
3670 if (LivenessAA &&
3671 llvm::all_of(DeadEdges,
3672 [&](const auto &DeadEdge) {
3673 return LivenessAA->isEdgeDead(DeadEdge.first,
3674 DeadEdge.second);
3675 }) &&
3676 llvm::all_of(DeadBlocks, [&](const BasicBlock *BB) {
3677 return LivenessAA->isAssumedDead(BB);
3678 })) {
3679 return ChangeStatus::UNCHANGED;
3680 }
3681 DeadEdges.clear();
3682 DeadBlocks.clear();
3683 return Base::updateImpl(A);
3684 }
3685
3686 bool isReachableImpl(Attributor &A, RQITy &RQI,
3687 bool IsTemporaryRQI) override {
3688 const Instruction *Origin = RQI.From;
3689 bool UsedExclusionSet = false;
3690
3691 auto WillReachInBlock = [&](const Instruction &From, const Instruction &To,
3692 const AA::InstExclusionSetTy *ExclusionSet) {
3693 const Instruction *IP = &From;
3694 while (IP && IP != &To) {
3695 if (ExclusionSet && IP != Origin && ExclusionSet->count(IP)) {
3696 UsedExclusionSet = true;
3697 break;
3698 }
3699 IP = IP->getNextNode();
3700 }
3701 return IP == &To;
3702 };
3703
3704 const BasicBlock *FromBB = RQI.From->getParent();
3705 const BasicBlock *ToBB = RQI.To->getParent();
3706 assert(FromBB->getParent() == ToBB->getParent() &&
3707 "Not an intra-procedural query!");
3708
3709 // Check intra-block reachability, however, other reaching paths are still
3710 // possible.
3711 if (FromBB == ToBB &&
3712 WillReachInBlock(*RQI.From, *RQI.To, RQI.ExclusionSet))
3713 return rememberResult(A, RQITy::Reachable::Yes, RQI, UsedExclusionSet,
3714 IsTemporaryRQI);
3715
3716 // Check if reaching the ToBB block is sufficient or if even that would not
3717 // ensure reaching the target. In the latter case we are done.
3718 if (!WillReachInBlock(ToBB->front(), *RQI.To, RQI.ExclusionSet))
3719 return rememberResult(A, RQITy::Reachable::No, RQI, UsedExclusionSet,
3720 IsTemporaryRQI);
3721
3722 const Function *Fn = FromBB->getParent();
3723 SmallPtrSet<const BasicBlock *, 16> ExclusionBlocks;
3724 if (RQI.ExclusionSet)
3725 for (auto *I : *RQI.ExclusionSet)
3726 if (I->getFunction() == Fn)
3727 ExclusionBlocks.insert(I->getParent());
3728
3729 // Check if we make it out of the FromBB block at all.
3730 if (ExclusionBlocks.count(FromBB) &&
3731 !WillReachInBlock(*RQI.From, *FromBB->getTerminator(),
3732 RQI.ExclusionSet))
3733 return rememberResult(A, RQITy::Reachable::No, RQI, true, IsTemporaryRQI);
3734
3735 auto *LivenessAA =
3736 A.getAAFor<AAIsDead>(*this, getIRPosition(), DepClassTy::OPTIONAL);
3737 if (LivenessAA && LivenessAA->isAssumedDead(ToBB)) {
3738 DeadBlocks.insert(ToBB);
3739 return rememberResult(A, RQITy::Reachable::No, RQI, UsedExclusionSet,
3740 IsTemporaryRQI);
3741 }
3742
3743 SmallPtrSet<const BasicBlock *, 16> Visited;
3745 Worklist.push_back(FromBB);
3746
3747 DenseSet<std::pair<const BasicBlock *, const BasicBlock *>> LocalDeadEdges;
3748 while (!Worklist.empty()) {
3749 const BasicBlock *BB = Worklist.pop_back_val();
3750 if (!Visited.insert(BB).second)
3751 continue;
3752 for (const BasicBlock *SuccBB : successors(BB)) {
3753 if (LivenessAA && LivenessAA->isEdgeDead(BB, SuccBB)) {
3754 LocalDeadEdges.insert({BB, SuccBB});
3755 continue;
3756 }
3757 // We checked before if we just need to reach the ToBB block.
3758 if (SuccBB == ToBB)
3759 return rememberResult(A, RQITy::Reachable::Yes, RQI, UsedExclusionSet,
3760 IsTemporaryRQI);
3761 if (DT && ExclusionBlocks.empty() && DT->dominates(BB, ToBB))
3762 return rememberResult(A, RQITy::Reachable::Yes, RQI, UsedExclusionSet,
3763 IsTemporaryRQI);
3764
3765 if (ExclusionBlocks.count(SuccBB)) {
3766 UsedExclusionSet = true;
3767 continue;
3768 }
3769 Worklist.push_back(SuccBB);
3770 }
3771 }
3772
3773 DeadEdges.insert_range(LocalDeadEdges);
3774 return rememberResult(A, RQITy::Reachable::No, RQI, UsedExclusionSet,
3775 IsTemporaryRQI);
3776 }
3777
3778 /// See AbstractAttribute::trackStatistics()
3779 void trackStatistics() const override {}
3780
3781private:
3782 // Set of assumed dead blocks we used in the last query. If any changes we
3783 // update the state.
3784 DenseSet<const BasicBlock *> DeadBlocks;
3785
3786 // Set of assumed dead edges we used in the last query. If any changes we
3787 // update the state.
3788 DenseSet<std::pair<const BasicBlock *, const BasicBlock *>> DeadEdges;
3789
3790 /// The dominator tree of the function to short-circuit reasoning.
3791 const DominatorTree *DT = nullptr;
3792};
3793} // namespace
3794
3795/// ------------------------ NoAlias Argument Attribute ------------------------
3796
3798 Attribute::AttrKind ImpliedAttributeKind,
3799 bool IgnoreSubsumingPositions) {
3800 assert(ImpliedAttributeKind == Attribute::NoAlias &&
3801 "Unexpected attribute kind");
3802 Value *Val = &IRP.getAssociatedValue();
3804 if (isa<AllocaInst>(Val))
3805 return true;
3806 } else {
3807 IgnoreSubsumingPositions = true;
3808 }
3809
3810 if (isa<UndefValue>(Val))
3811 return true;
3812
3813 if (isa<ConstantPointerNull>(Val) &&
3816 return true;
3817
3818 if (A.hasAttr(IRP, {Attribute::ByVal, Attribute::NoAlias},
3819 IgnoreSubsumingPositions, Attribute::NoAlias))
3820 return true;
3821
3822 return false;
3823}
3824
3825namespace {
3826struct AANoAliasImpl : AANoAlias {
3827 AANoAliasImpl(const IRPosition &IRP, Attributor &A) : AANoAlias(IRP, A) {
3828 assert(getAssociatedType()->isPointerTy() &&
3829 "Noalias is a pointer attribute");
3830 }
3831
3832 const std::string getAsStr(Attributor *A) const override {
3833 return getAssumed() ? "noalias" : "may-alias";
3834 }
3835};
3836
3837/// NoAlias attribute for a floating value.
3838struct AANoAliasFloating final : AANoAliasImpl {
3839 AANoAliasFloating(const IRPosition &IRP, Attributor &A)
3840 : AANoAliasImpl(IRP, A) {}
3841
3842 /// See AbstractAttribute::updateImpl(...).
3843 ChangeStatus updateImpl(Attributor &A) override {
3844 // TODO: Implement this.
3845 return indicatePessimisticFixpoint();
3846 }
3847
3848 /// See AbstractAttribute::trackStatistics()
3849 void trackStatistics() const override {
3851 }
3852};
3853
3854/// NoAlias attribute for an argument.
3855struct AANoAliasArgument final
3856 : AAArgumentFromCallSiteArguments<AANoAlias, AANoAliasImpl> {
3857 using Base = AAArgumentFromCallSiteArguments<AANoAlias, AANoAliasImpl>;
3858 AANoAliasArgument(const IRPosition &IRP, Attributor &A) : Base(IRP, A) {}
3859
3860 /// See AbstractAttribute::update(...).
3861 ChangeStatus updateImpl(Attributor &A) override {
3862 // We have to make sure no-alias on the argument does not break
3863 // synchronization when this is a callback argument, see also [1] below.
3864 // If synchronization cannot be affected, we delegate to the base updateImpl
3865 // function, otherwise we give up for now.
3866
3867 // If the function is no-sync, no-alias cannot break synchronization.
3868 bool IsKnownNoSycn;
3870 A, this, IRPosition::function_scope(getIRPosition()),
3871 DepClassTy::OPTIONAL, IsKnownNoSycn))
3872 return Base::updateImpl(A);
3873
3874 // If the argument is read-only, no-alias cannot break synchronization.
3875 bool IsKnown;
3876 if (AA::isAssumedReadOnly(A, getIRPosition(), *this, IsKnown))
3877 return Base::updateImpl(A);
3878
3879 // If the argument is never passed through callbacks, no-alias cannot break
3880 // synchronization.
3881 bool UsedAssumedInformation = false;
3882 if (A.checkForAllCallSites(
3883 [](AbstractCallSite ACS) { return !ACS.isCallbackCall(); }, *this,
3884 true, UsedAssumedInformation))
3885 return Base::updateImpl(A);
3886
3887 // TODO: add no-alias but make sure it doesn't break synchronization by
3888 // introducing fake uses. See:
3889 // [1] Compiler Optimizations for OpenMP, J. Doerfert and H. Finkel,
3890 // International Workshop on OpenMP 2018,
3891 // http://compilers.cs.uni-saarland.de/people/doerfert/par_opt18.pdf
3892
3893 return indicatePessimisticFixpoint();
3894 }
3895
3896 /// See AbstractAttribute::trackStatistics()
3897 void trackStatistics() const override { STATS_DECLTRACK_ARG_ATTR(noalias) }
3898};
3899
3900struct AANoAliasCallSiteArgument final : AANoAliasImpl {
3901 AANoAliasCallSiteArgument(const IRPosition &IRP, Attributor &A)
3902 : AANoAliasImpl(IRP, A) {}
3903
3904 /// Determine if the underlying value may alias with the call site argument
3905 /// \p OtherArgNo of \p ICS (= the underlying call site).
3906 bool mayAliasWithArgument(Attributor &A, AAResults *&AAR,
3907 const AAMemoryBehavior &MemBehaviorAA,
3908 const CallBase &CB, unsigned OtherArgNo) {
3909 // We do not need to worry about aliasing with the underlying IRP.
3910 if (this->getCalleeArgNo() == (int)OtherArgNo)
3911 return false;
3912
3913 // If it is not a pointer or pointer vector we do not alias.
3914 const Value *ArgOp = CB.getArgOperand(OtherArgNo);
3915 if (!ArgOp->getType()->isPtrOrPtrVectorTy())
3916 return false;
3917
3918 auto *CBArgMemBehaviorAA = A.getAAFor<AAMemoryBehavior>(
3919 *this, IRPosition::callsite_argument(CB, OtherArgNo), DepClassTy::NONE);
3920
3921 // If the argument is readnone, there is no read-write aliasing.
3922 if (CBArgMemBehaviorAA && CBArgMemBehaviorAA->isAssumedReadNone()) {
3923 A.recordDependence(*CBArgMemBehaviorAA, *this, DepClassTy::OPTIONAL);
3924 return false;
3925 }
3926
3927 // If the argument is readonly and the underlying value is readonly, there
3928 // is no read-write aliasing.
3929 bool IsReadOnly = MemBehaviorAA.isAssumedReadOnly();
3930 if (CBArgMemBehaviorAA && CBArgMemBehaviorAA->isAssumedReadOnly() &&
3931 IsReadOnly) {
3932 A.recordDependence(MemBehaviorAA, *this, DepClassTy::OPTIONAL);
3933 A.recordDependence(*CBArgMemBehaviorAA, *this, DepClassTy::OPTIONAL);
3934 return false;
3935 }
3936
3937 // We have to utilize actual alias analysis queries so we need the object.
3938 if (!AAR)
3939 AAR = A.getInfoCache().getAnalysisResultForFunction<AAManager>(
3940 *getAnchorScope());
3941
3942 // Try to rule it out at the call site.
3943 bool IsAliasing = !AAR || !AAR->isNoAlias(&getAssociatedValue(), ArgOp);
3944 LLVM_DEBUG(dbgs() << "[NoAliasCSArg] Check alias between "
3945 "callsite arguments: "
3946 << getAssociatedValue() << " " << *ArgOp << " => "
3947 << (IsAliasing ? "" : "no-") << "alias \n");
3948
3949 return IsAliasing;
3950 }
3951
3952 bool isKnownNoAliasDueToNoAliasPreservation(
3953 Attributor &A, AAResults *&AAR, const AAMemoryBehavior &MemBehaviorAA) {
3954 // We can deduce "noalias" if the following conditions hold.
3955 // (i) Associated value is assumed to be noalias in the definition.
3956 // (ii) Associated value is assumed to be no-capture in all the uses
3957 // possibly executed before this callsite.
3958 // (iii) There is no other pointer argument which could alias with the
3959 // value.
3960
3961 const IRPosition &VIRP = IRPosition::value(getAssociatedValue());
3962 const Function *ScopeFn = VIRP.getAnchorScope();
3963 // Check whether the value is captured in the scope using AANoCapture.
3964 // Look at CFG and check only uses possibly executed before this
3965 // callsite.
3966 auto UsePred = [&](const Use &U, bool &Follow) -> bool {
3967 Instruction *UserI = cast<Instruction>(U.getUser());
3968
3969 // If UserI is the curr instruction and there is a single potential use of
3970 // the value in UserI we allow the use.
3971 // TODO: We should inspect the operands and allow those that cannot alias
3972 // with the value.
3973 if (UserI == getCtxI() && UserI->getNumOperands() == 1)
3974 return true;
3975
3976 if (ScopeFn) {
3977 if (auto *CB = dyn_cast<CallBase>(UserI)) {
3978 if (CB->isArgOperand(&U)) {
3979
3980 unsigned ArgNo = CB->getArgOperandNo(&U);
3981
3982 bool IsKnownNoCapture;
3984 A, this, IRPosition::callsite_argument(*CB, ArgNo),
3985 DepClassTy::OPTIONAL, IsKnownNoCapture))
3986 return true;
3987 }
3988 }
3989
3991 A, *UserI, *getCtxI(), *this, /* ExclusionSet */ nullptr,
3992 [ScopeFn](const Function &Fn) { return &Fn != ScopeFn; }))
3993 return true;
3994 }
3995
3996 // TODO: We should track the capturing uses in AANoCapture but the problem
3997 // is CGSCC runs. For those we would need to "allow" AANoCapture for
3998 // a value in the module slice.
3999 // TODO(captures): Make this more precise.
4000 UseCaptureInfo CI = DetermineUseCaptureKind(U, /*Base=*/nullptr);
4001 if (capturesNothing(CI))
4002 return true;
4003 if (CI.isPassthrough()) {
4004 Follow = true;
4005 return true;
4006 }
4007 LLVM_DEBUG(dbgs() << "[AANoAliasCSArg] Unknown user: " << *UserI << "\n");
4008 return false;
4009 };
4010
4011 bool IsKnownNoCapture;
4012 const AANoCapture *NoCaptureAA = nullptr;
4013 bool IsAssumedNoCapture = AA::hasAssumedIRAttr<Attribute::Captures>(
4014 A, this, VIRP, DepClassTy::NONE, IsKnownNoCapture, false, &NoCaptureAA);
4015 if (!IsAssumedNoCapture &&
4016 (!NoCaptureAA || !NoCaptureAA->isAssumedNoCaptureMaybeReturned())) {
4017 if (!A.checkForAllUses(UsePred, *this, getAssociatedValue())) {
4018 LLVM_DEBUG(
4019 dbgs() << "[AANoAliasCSArg] " << getAssociatedValue()
4020 << " cannot be noalias as it is potentially captured\n");
4021 return false;
4022 }
4023 }
4024 if (NoCaptureAA)
4025 A.recordDependence(*NoCaptureAA, *this, DepClassTy::OPTIONAL);
4026
4027 // Check there is no other pointer argument which could alias with the
4028 // value passed at this call site.
4029 // TODO: AbstractCallSite
4030 const auto &CB = cast<CallBase>(getAnchorValue());
4031 for (unsigned OtherArgNo = 0; OtherArgNo < CB.arg_size(); OtherArgNo++)
4032 if (mayAliasWithArgument(A, AAR, MemBehaviorAA, CB, OtherArgNo))
4033 return false;
4034
4035 return true;
4036 }
4037
4038 /// See AbstractAttribute::updateImpl(...).
4039 ChangeStatus updateImpl(Attributor &A) override {
4040 // If the argument is readnone we are done as there are no accesses via the
4041 // argument.
4042 auto *MemBehaviorAA =
4043 A.getAAFor<AAMemoryBehavior>(*this, getIRPosition(), DepClassTy::NONE);
4044 if (MemBehaviorAA && MemBehaviorAA->isAssumedReadNone()) {
4045 A.recordDependence(*MemBehaviorAA, *this, DepClassTy::OPTIONAL);
4046 return ChangeStatus::UNCHANGED;
4047 }
4048
4049 bool IsKnownNoAlias;
4050 const IRPosition &VIRP = IRPosition::value(getAssociatedValue());
4052 A, this, VIRP, DepClassTy::REQUIRED, IsKnownNoAlias)) {
4053 LLVM_DEBUG(dbgs() << "[AANoAlias] " << getAssociatedValue()
4054 << " is not no-alias at the definition\n");
4055 return indicatePessimisticFixpoint();
4056 }
4057
4058 AAResults *AAR = nullptr;
4059 if (MemBehaviorAA &&
4060 isKnownNoAliasDueToNoAliasPreservation(A, AAR, *MemBehaviorAA)) {
4061 LLVM_DEBUG(
4062 dbgs() << "[AANoAlias] No-Alias deduced via no-alias preservation\n");
4063 return ChangeStatus::UNCHANGED;
4064 }
4065
4066 return indicatePessimisticFixpoint();
4067 }
4068
4069 /// See AbstractAttribute::trackStatistics()
4070 void trackStatistics() const override { STATS_DECLTRACK_CSARG_ATTR(noalias) }
4071};
4072
4073/// NoAlias attribute for function return value.
4074struct AANoAliasReturned final : AANoAliasImpl {
4075 AANoAliasReturned(const IRPosition &IRP, Attributor &A)
4076 : AANoAliasImpl(IRP, A) {}
4077
4078 /// See AbstractAttribute::updateImpl(...).
4079 ChangeStatus updateImpl(Attributor &A) override {
4080
4081 auto CheckReturnValue = [&](Value &RV) -> bool {
4082 if (Constant *C = dyn_cast<Constant>(&RV))
4083 if (C->isNullValue() || isa<UndefValue>(C))
4084 return true;
4085
4086 /// For now, we can only deduce noalias if we have call sites.
4087 /// FIXME: add more support.
4088 if (!isa<CallBase>(&RV))
4089 return false;
4090
4091 const IRPosition &RVPos = IRPosition::value(RV);
4092 bool IsKnownNoAlias;
4094 A, this, RVPos, DepClassTy::REQUIRED, IsKnownNoAlias))
4095 return false;
4096
4097 bool IsKnownNoCapture;
4098 const AANoCapture *NoCaptureAA = nullptr;
4099 bool IsAssumedNoCapture = AA::hasAssumedIRAttr<Attribute::Captures>(
4100 A, this, RVPos, DepClassTy::REQUIRED, IsKnownNoCapture, false,
4101 &NoCaptureAA);
4102 return IsAssumedNoCapture ||
4103 (NoCaptureAA && NoCaptureAA->isAssumedNoCaptureMaybeReturned());
4104 };
4105
4106 if (!A.checkForAllReturnedValues(CheckReturnValue, *this))
4107 return indicatePessimisticFixpoint();
4108
4109 return ChangeStatus::UNCHANGED;
4110 }
4111
4112 /// See AbstractAttribute::trackStatistics()
4113 void trackStatistics() const override { STATS_DECLTRACK_FNRET_ATTR(noalias) }
4114};
4115
4116/// NoAlias attribute deduction for a call site return value.
4117struct AANoAliasCallSiteReturned final
4118 : AACalleeToCallSite<AANoAlias, AANoAliasImpl> {
4119 AANoAliasCallSiteReturned(const IRPosition &IRP, Attributor &A)
4120 : AACalleeToCallSite<AANoAlias, AANoAliasImpl>(IRP, A) {}
4121
4122 /// See AbstractAttribute::trackStatistics()
4123 void trackStatistics() const override { STATS_DECLTRACK_CSRET_ATTR(noalias); }
4124};
4125} // namespace
4126
4127/// -------------------AAIsDead Function Attribute-----------------------
4128
4129namespace {
4130struct AAIsDeadValueImpl : public AAIsDead {
4131 AAIsDeadValueImpl(const IRPosition &IRP, Attributor &A) : AAIsDead(IRP, A) {}
4132
4133 /// See AAIsDead::isAssumedDead().
4134 bool isAssumedDead() const override { return isAssumed(IS_DEAD); }
4135
4136 /// See AAIsDead::isKnownDead().
4137 bool isKnownDead() const override { return isKnown(IS_DEAD); }
4138
4139 /// See AAIsDead::isAssumedDead(BasicBlock *).
4140 bool isAssumedDead(const BasicBlock *BB) const override { return false; }
4141
4142 /// See AAIsDead::isKnownDead(BasicBlock *).
4143 bool isKnownDead(const BasicBlock *BB) const override { return false; }
4144
4145 /// See AAIsDead::isAssumedDead(Instruction *I).
4146 bool isAssumedDead(const Instruction *I) const override {
4147 return I == getCtxI() && isAssumedDead();
4148 }
4149
4150 /// See AAIsDead::isKnownDead(Instruction *I).
4151 bool isKnownDead(const Instruction *I) const override {
4152 return isAssumedDead(I) && isKnownDead();
4153 }
4154
4155 /// See AbstractAttribute::getAsStr().
4156 const std::string getAsStr(Attributor *A) const override {
4157 return isAssumedDead() ? "assumed-dead" : "assumed-live";
4158 }
4159
4160 /// Check if all uses are assumed dead.
4161 bool areAllUsesAssumedDead(Attributor &A, Value &V) {
4162 // Callers might not check the type, void has no uses.
4163 if (V.getType()->isVoidTy() || V.use_empty())
4164 return true;
4165
4166 // If we replace a value with a constant there are no uses left afterwards.
4167 if (!isa<Constant>(V)) {
4168 if (auto *I = dyn_cast<Instruction>(&V))
4169 if (!A.isRunOn(*I->getFunction()))
4170 return false;
4171 bool UsedAssumedInformation = false;
4172 std::optional<Constant *> C =
4173 A.getAssumedConstant(V, *this, UsedAssumedInformation);
4174 if (!C || *C)
4175 return true;
4176 }
4177
4178 auto UsePred = [&](const Use &U, bool &Follow) { return false; };
4179 // Explicitly set the dependence class to required because we want a long
4180 // chain of N dependent instructions to be considered live as soon as one is
4181 // without going through N update cycles. This is not required for
4182 // correctness.
4183 return A.checkForAllUses(UsePred, *this, V, /* CheckBBLivenessOnly */ false,
4184 DepClassTy::REQUIRED,
4185 /* IgnoreDroppableUses */ false);
4186 }
4187
4188 /// Determine if \p I is assumed to be side-effect free.
4189 bool isAssumedSideEffectFree(Attributor &A, Instruction *I) {
4191 return true;
4192
4193 if (!I->isTerminator() && !I->mayHaveSideEffects())
4194 return true;
4195
4196 auto *CB = dyn_cast<CallBase>(I);
4197 if (!CB || isa<IntrinsicInst>(CB))
4198 return false;
4199
4200 const IRPosition &CallIRP = IRPosition::callsite_function(*CB);
4201
4202 bool IsKnownNoUnwind;
4204 A, this, CallIRP, DepClassTy::OPTIONAL, IsKnownNoUnwind))
4205 return false;
4206
4207 bool IsKnown;
4208 return AA::isAssumedReadOnly(A, CallIRP, *this, IsKnown);
4209 }
4210};
4211
4212struct AAIsDeadFloating : public AAIsDeadValueImpl {
4213 AAIsDeadFloating(const IRPosition &IRP, Attributor &A)
4214 : AAIsDeadValueImpl(IRP, A) {}
4215
4216 /// See AbstractAttribute::initialize(...).
4217 void initialize(Attributor &A) override {
4218 AAIsDeadValueImpl::initialize(A);
4219
4220 if (isa<UndefValue>(getAssociatedValue())) {
4221 indicatePessimisticFixpoint();
4222 return;
4223 }
4224
4225 Instruction *I = dyn_cast<Instruction>(&getAssociatedValue());
4226 if (!isAssumedSideEffectFree(A, I)) {
4228 indicatePessimisticFixpoint();
4229 else
4230 removeAssumedBits(HAS_NO_EFFECT);
4231 }
4232 }
4233
4234 bool isDeadFence(Attributor &A, FenceInst &FI) {
4235 const auto *ExecDomainAA = A.lookupAAFor<AAExecutionDomain>(
4236 IRPosition::function(*FI.getFunction()), *this, DepClassTy::NONE);
4237 if (!ExecDomainAA || !ExecDomainAA->isNoOpFence(FI))
4238 return false;
4239 A.recordDependence(*ExecDomainAA, *this, DepClassTy::OPTIONAL);
4240 return true;
4241 }
4242
4243 bool isDeadStore(Attributor &A, StoreInst &SI,
4244 SmallSetVector<Instruction *, 8> *AssumeOnlyInst = nullptr) {
4245 // Lang ref now states volatile store is not UB/dead, let's skip them.
4246 if (SI.isVolatile())
4247 return false;
4248
4249 // If we are collecting assumes to be deleted we are in the manifest stage.
4250 // It's problematic to collect the potential copies again now so we use the
4251 // cached ones.
4252 bool UsedAssumedInformation = false;
4253 if (!AssumeOnlyInst) {
4254 PotentialCopies.clear();
4255 if (!AA::getPotentialCopiesOfStoredValue(A, SI, PotentialCopies, *this,
4256 UsedAssumedInformation)) {
4257 LLVM_DEBUG(
4258 dbgs()
4259 << "[AAIsDead] Could not determine potential copies of store!\n");
4260 return false;
4261 }
4262 }
4263 LLVM_DEBUG(dbgs() << "[AAIsDead] Store has " << PotentialCopies.size()
4264 << " potential copies.\n");
4265
4266 InformationCache &InfoCache = A.getInfoCache();
4267 return llvm::all_of(PotentialCopies, [&](Value *V) {
4268 if (A.isAssumedDead(IRPosition::value(*V), this, nullptr,
4269 UsedAssumedInformation))
4270 return true;
4271 if (auto *LI = dyn_cast<LoadInst>(V)) {
4272 if (llvm::all_of(LI->uses(), [&](const Use &U) {
4273 auto &UserI = cast<Instruction>(*U.getUser());
4274 if (InfoCache.isOnlyUsedByAssume(UserI)) {
4275 if (AssumeOnlyInst)
4276 AssumeOnlyInst->insert(&UserI);
4277 return true;
4278 }
4279 return A.isAssumedDead(U, this, nullptr, UsedAssumedInformation);
4280 })) {
4281 return true;
4282 }
4283 }
4284 LLVM_DEBUG(dbgs() << "[AAIsDead] Potential copy " << *V
4285 << " is assumed live!\n");
4286 return false;
4287 });
4288 }
4289
4290 /// See AbstractAttribute::getAsStr().
4291 const std::string getAsStr(Attributor *A) const override {
4292 Instruction *I = dyn_cast<Instruction>(&getAssociatedValue());
4294 if (isValidState())
4295 return "assumed-dead-store";
4297 if (isValidState())
4298 return "assumed-dead-fence";
4299 return AAIsDeadValueImpl::getAsStr(A);
4300 }
4301
4302 /// See AbstractAttribute::updateImpl(...).
4303 ChangeStatus updateImpl(Attributor &A) override {
4304 Instruction *I = dyn_cast<Instruction>(&getAssociatedValue());
4305 if (auto *SI = dyn_cast_or_null<StoreInst>(I)) {
4306 if (!isDeadStore(A, *SI))
4307 return indicatePessimisticFixpoint();
4308 } else if (auto *FI = dyn_cast_or_null<FenceInst>(I)) {
4309 if (!isDeadFence(A, *FI))
4310 return indicatePessimisticFixpoint();
4311 } else {
4312 if (!isAssumedSideEffectFree(A, I))
4313 return indicatePessimisticFixpoint();
4314 if (!areAllUsesAssumedDead(A, getAssociatedValue()))
4315 return indicatePessimisticFixpoint();
4316 }
4318 }
4319
4320 bool isRemovableStore() const override {
4321 return isAssumed(IS_REMOVABLE) && isa<StoreInst>(&getAssociatedValue());
4322 }
4323
4324 /// See AbstractAttribute::manifest(...).
4325 ChangeStatus manifest(Attributor &A) override {
4326 Value &V = getAssociatedValue();
4327 if (auto *I = dyn_cast<Instruction>(&V)) {
4328 // If we get here we basically know the users are all dead. We check if
4329 // isAssumedSideEffectFree returns true here again because it might not be
4330 // the case and only the users are dead but the instruction (=call) is
4331 // still needed.
4332 if (auto *SI = dyn_cast<StoreInst>(I)) {
4333 SmallSetVector<Instruction *, 8> AssumeOnlyInst;
4334 bool IsDead = isDeadStore(A, *SI, &AssumeOnlyInst);
4335 (void)IsDead;
4336 assert(IsDead && "Store was assumed to be dead!");
4337 A.deleteAfterManifest(*I);
4338 for (size_t i = 0; i < AssumeOnlyInst.size(); ++i) {
4339 Instruction *AOI = AssumeOnlyInst[i];
4340 for (auto *Usr : AOI->users())
4341 AssumeOnlyInst.insert(cast<Instruction>(Usr));
4342 A.deleteAfterManifest(*AOI);
4343 }
4344 return ChangeStatus::CHANGED;
4345 }
4346 if (auto *FI = dyn_cast<FenceInst>(I)) {
4347 assert(isDeadFence(A, *FI));
4348 A.deleteAfterManifest(*FI);
4349 return ChangeStatus::CHANGED;
4350 }
4351 if (isAssumedSideEffectFree(A, I) && !I->isTerminator()) {
4352 A.deleteAfterManifest(*I);
4353 return ChangeStatus::CHANGED;
4354 }
4355 }
4357 }
4358
4359 /// See AbstractAttribute::trackStatistics()
4360 void trackStatistics() const override {
4362 }
4363
4364private:
4365 // The potential copies of a dead store, used for deletion during manifest.
4366 SmallSetVector<Value *, 4> PotentialCopies;
4367};
4368
4369struct AAIsDeadArgument : public AAIsDeadFloating {
4370 AAIsDeadArgument(const IRPosition &IRP, Attributor &A)
4371 : AAIsDeadFloating(IRP, A) {}
4372
4373 /// See AbstractAttribute::manifest(...).
4374 ChangeStatus manifest(Attributor &A) override {
4375 Argument &Arg = *getAssociatedArgument();
4376 if (A.isValidFunctionSignatureRewrite(Arg, /* ReplacementTypes */ {}))
4377 if (A.registerFunctionSignatureRewrite(
4378 Arg, /* ReplacementTypes */ {},
4381 return ChangeStatus::CHANGED;
4382 }
4383 return ChangeStatus::UNCHANGED;
4384 }
4385
4386 /// See AbstractAttribute::trackStatistics()
4387 void trackStatistics() const override { STATS_DECLTRACK_ARG_ATTR(IsDead) }
4388};
4389
4390struct AAIsDeadCallSiteArgument : public AAIsDeadValueImpl {
4391 AAIsDeadCallSiteArgument(const IRPosition &IRP, Attributor &A)
4392 : AAIsDeadValueImpl(IRP, A) {}
4393
4394 /// See AbstractAttribute::initialize(...).
4395 void initialize(Attributor &A) override {
4396 AAIsDeadValueImpl::initialize(A);
4397 if (isa<UndefValue>(getAssociatedValue()))
4398 indicatePessimisticFixpoint();
4399 }
4400
4401 /// See AbstractAttribute::updateImpl(...).
4402 ChangeStatus updateImpl(Attributor &A) override {
4403 // TODO: Once we have call site specific value information we can provide
4404 // call site specific liveness information and then it makes
4405 // sense to specialize attributes for call sites arguments instead of
4406 // redirecting requests to the callee argument.
4407 Argument *Arg = getAssociatedArgument();
4408 if (!Arg)
4409 return indicatePessimisticFixpoint();
4410 const IRPosition &ArgPos = IRPosition::argument(*Arg);
4411 auto *ArgAA = A.getAAFor<AAIsDead>(*this, ArgPos, DepClassTy::REQUIRED);
4412 if (!ArgAA)
4413 return indicatePessimisticFixpoint();
4414 return clampStateAndIndicateChange(getState(), ArgAA->getState());
4415 }
4416
4417 /// See AbstractAttribute::manifest(...).
4418 ChangeStatus manifest(Attributor &A) override {
4419 CallBase &CB = cast<CallBase>(getAnchorValue());
4420 Use &U = CB.getArgOperandUse(getCallSiteArgNo());
4421 assert(!isa<UndefValue>(U.get()) &&
4422 "Expected undef values to be filtered out!");
4423 UndefValue &UV = *UndefValue::get(U->getType());
4424 if (A.changeUseAfterManifest(U, UV))
4425 return ChangeStatus::CHANGED;
4426 return ChangeStatus::UNCHANGED;
4427 }
4428
4429 /// See AbstractAttribute::trackStatistics()
4430 void trackStatistics() const override { STATS_DECLTRACK_CSARG_ATTR(IsDead) }
4431};
4432
4433struct AAIsDeadCallSiteReturned : public AAIsDeadFloating {
4434 AAIsDeadCallSiteReturned(const IRPosition &IRP, Attributor &A)
4435 : AAIsDeadFloating(IRP, A) {}
4436
4437 /// See AAIsDead::isAssumedDead().
4438 bool isAssumedDead() const override {
4439 return AAIsDeadFloating::isAssumedDead() && IsAssumedSideEffectFree;
4440 }
4441
4442 /// See AbstractAttribute::initialize(...).
4443 void initialize(Attributor &A) override {
4444 AAIsDeadFloating::initialize(A);
4445 if (isa<UndefValue>(getAssociatedValue())) {
4446 indicatePessimisticFixpoint();
4447 return;
4448 }
4449
4450 // We track this separately as a secondary state.
4451 IsAssumedSideEffectFree = isAssumedSideEffectFree(A, getCtxI());
4452 }
4453
4454 /// See AbstractAttribute::updateImpl(...).
4455 ChangeStatus updateImpl(Attributor &A) override {
4456 ChangeStatus Changed = ChangeStatus::UNCHANGED;
4457 if (IsAssumedSideEffectFree && !isAssumedSideEffectFree(A, getCtxI())) {
4458 IsAssumedSideEffectFree = false;
4459 Changed = ChangeStatus::CHANGED;
4460 }
4461 if (!areAllUsesAssumedDead(A, getAssociatedValue()))
4462 return indicatePessimisticFixpoint();
4463 return Changed;
4464 }
4465
4466 /// See AbstractAttribute::trackStatistics()
4467 void trackStatistics() const override {
4468 if (IsAssumedSideEffectFree)
4470 else
4471 STATS_DECLTRACK_CSRET_ATTR(UnusedResult)
4472 }
4473
4474 /// See AbstractAttribute::getAsStr().
4475 const std::string getAsStr(Attributor *A) const override {
4476 return isAssumedDead()
4477 ? "assumed-dead"
4478 : (getAssumed() ? "assumed-dead-users" : "assumed-live");
4479 }
4480
4481private:
4482 bool IsAssumedSideEffectFree = true;
4483};
4484
4485struct AAIsDeadReturned : public AAIsDeadValueImpl {
4486 AAIsDeadReturned(const IRPosition &IRP, Attributor &A)
4487 : AAIsDeadValueImpl(IRP, A) {}
4488
4489 /// See AbstractAttribute::updateImpl(...).
4490 ChangeStatus updateImpl(Attributor &A) override {
4491
4492 bool UsedAssumedInformation = false;
4493 A.checkForAllInstructions([](Instruction &) { return true; }, *this,
4494 {Instruction::Ret}, UsedAssumedInformation);
4495
4496 auto PredForCallSite = [&](AbstractCallSite ACS) {
4497 if (ACS.isCallbackCall() || !ACS.getInstruction())
4498 return false;
4499 return areAllUsesAssumedDead(A, *ACS.getInstruction());
4500 };
4501
4502 if (!A.checkForAllCallSites(PredForCallSite, *this, true,
4503 UsedAssumedInformation))
4504 return indicatePessimisticFixpoint();
4505
4506 return ChangeStatus::UNCHANGED;
4507 }
4508
4509 /// See AbstractAttribute::manifest(...).
4510 ChangeStatus manifest(Attributor &A) override {
4511 // TODO: Rewrite the signature to return void?
4512 bool AnyChange = false;
4513 UndefValue &UV = *UndefValue::get(getAssociatedFunction()->getReturnType());
4514 auto RetInstPred = [&](Instruction &I) {
4515 ReturnInst &RI = cast<ReturnInst>(I);
4517 AnyChange |= A.changeUseAfterManifest(RI.getOperandUse(0), UV);
4518 return true;
4519 };
4520 bool UsedAssumedInformation = false;
4521 A.checkForAllInstructions(RetInstPred, *this, {Instruction::Ret},
4522 UsedAssumedInformation);
4523 return AnyChange ? ChangeStatus::CHANGED : ChangeStatus::UNCHANGED;
4524 }
4525
4526 /// See AbstractAttribute::trackStatistics()
4527 void trackStatistics() const override { STATS_DECLTRACK_FNRET_ATTR(IsDead) }
4528};
4529
4530struct AAIsDeadFunction : public AAIsDead {
4531 AAIsDeadFunction(const IRPosition &IRP, Attributor &A) : AAIsDead(IRP, A) {}
4532
4533 /// See AbstractAttribute::initialize(...).
4534 void initialize(Attributor &A) override {
4535 Function *F = getAnchorScope();
4536 assert(F && "Did expect an anchor function");
4537 if (!isAssumedDeadInternalFunction(A)) {
4538 ToBeExploredFrom.insert(&F->getEntryBlock().front());
4539 assumeLive(A, F->getEntryBlock());
4540 }
4541 }
4542
4543 bool isAssumedDeadInternalFunction(Attributor &A) {
4544 if (!getAnchorScope()->hasLocalLinkage())
4545 return false;
4546 bool UsedAssumedInformation = false;
4547 return A.checkForAllCallSites([](AbstractCallSite) { return false; }, *this,
4548 true, UsedAssumedInformation);
4549 }
4550
4551 /// See AbstractAttribute::getAsStr().
4552 const std::string getAsStr(Attributor *A) const override {
4553 return "Live[#BB " + std::to_string(AssumedLiveBlocks.size()) + "/" +
4554 std::to_string(getAnchorScope()->size()) + "][#TBEP " +
4555 std::to_string(ToBeExploredFrom.size()) + "][#KDE " +
4556 std::to_string(KnownDeadEnds.size()) + "]";
4557 }
4558
4559 /// See AbstractAttribute::manifest(...).
4560 ChangeStatus manifest(Attributor &A) override {
4561 assert(getState().isValidState() &&
4562 "Attempted to manifest an invalid state!");
4563
4564 ChangeStatus HasChanged = ChangeStatus::UNCHANGED;
4565 Function &F = *getAnchorScope();
4566
4567 if (AssumedLiveBlocks.empty()) {
4568 A.deleteAfterManifest(F);
4569 return ChangeStatus::CHANGED;
4570 }
4571
4572 // Flag to determine if we can change an invoke to a call assuming the
4573 // callee is nounwind. This is not possible if the personality of the
4574 // function allows to catch asynchronous exceptions.
4575 bool Invoke2CallAllowed = !mayCatchAsynchronousExceptions(F);
4576
4577 KnownDeadEnds.set_union(ToBeExploredFrom);
4578 for (const Instruction *DeadEndI : KnownDeadEnds) {
4579 auto *CB = dyn_cast<CallBase>(DeadEndI);
4580 if (!CB)
4581 continue;
4582 bool IsKnownNoReturn;
4584 A, this, IRPosition::callsite_function(*CB), DepClassTy::OPTIONAL,
4585 IsKnownNoReturn);
4586 if (MayReturn && (!Invoke2CallAllowed || !isa<InvokeInst>(CB)))
4587 continue;
4588
4589 if (auto *II = dyn_cast<InvokeInst>(DeadEndI))
4590 A.registerInvokeWithDeadSuccessor(const_cast<InvokeInst &>(*II));
4591 else
4592 A.changeToUnreachableAfterManifest(
4593 const_cast<Instruction *>(DeadEndI->getNextNode()));
4594 HasChanged = ChangeStatus::CHANGED;
4595 }
4596
4597 STATS_DECL(AAIsDead, BasicBlock, "Number of dead basic blocks deleted.");
4598 for (BasicBlock &BB : F)
4599 if (!AssumedLiveBlocks.count(&BB)) {
4600 A.deleteAfterManifest(BB);
4601 ++BUILD_STAT_NAME(AAIsDead, BasicBlock);
4602 HasChanged = ChangeStatus::CHANGED;
4603 }
4604
4605 return HasChanged;
4606 }
4607
4608 /// See AbstractAttribute::updateImpl(...).
4609 ChangeStatus updateImpl(Attributor &A) override;
4610
4611 bool isEdgeDead(const BasicBlock *From, const BasicBlock *To) const override {
4612 assert(From->getParent() == getAnchorScope() &&
4613 To->getParent() == getAnchorScope() &&
4614 "Used AAIsDead of the wrong function");
4615 return isValidState() && !AssumedLiveEdges.count(std::make_pair(From, To));
4616 }
4617
4618 /// See AbstractAttribute::trackStatistics()
4619 void trackStatistics() const override {}
4620
4621 /// Returns true if the function is assumed dead.
4622 bool isAssumedDead() const override { return false; }
4623
4624 /// See AAIsDead::isKnownDead().
4625 bool isKnownDead() const override { return false; }
4626
4627 /// See AAIsDead::isAssumedDead(BasicBlock *).
4628 bool isAssumedDead(const BasicBlock *BB) const override {
4629 assert(BB->getParent() == getAnchorScope() &&
4630 "BB must be in the same anchor scope function.");
4631
4632 if (!getAssumed())
4633 return false;
4634 return !AssumedLiveBlocks.count(BB);
4635 }
4636
4637 /// See AAIsDead::isKnownDead(BasicBlock *).
4638 bool isKnownDead(const BasicBlock *BB) const override {
4639 return getKnown() && isAssumedDead(BB);
4640 }
4641
4642 /// See AAIsDead::isAssumed(Instruction *I).
4643 bool isAssumedDead(const Instruction *I) const override {
4644 assert(I->getParent()->getParent() == getAnchorScope() &&
4645 "Instruction must be in the same anchor scope function.");
4646
4647 if (!getAssumed())
4648 return false;
4649
4650 // If it is not in AssumedLiveBlocks then it for sure dead.
4651 // Otherwise, it can still be after noreturn call in a live block.
4652 if (!AssumedLiveBlocks.count(I->getParent()))
4653 return true;
4654
4655 // If it is not after a liveness barrier it is live.
4656 const Instruction *PrevI = I->getPrevNode();
4657 while (PrevI) {
4658 if (KnownDeadEnds.count(PrevI) || ToBeExploredFrom.count(PrevI))
4659 return true;
4660 PrevI = PrevI->getPrevNode();
4661 }
4662 return false;
4663 }
4664
4665 /// See AAIsDead::isKnownDead(Instruction *I).
4666 bool isKnownDead(const Instruction *I) const override {
4667 return getKnown() && isAssumedDead(I);
4668 }
4669
4670 /// Assume \p BB is (partially) live now and indicate to the Attributor \p A
4671 /// that internal function called from \p BB should now be looked at.
4672 bool assumeLive(Attributor &A, const BasicBlock &BB) {
4673 if (!AssumedLiveBlocks.insert(&BB).second)
4674 return false;
4675
4676 if (!A.isDuringDeduction())
4677 return true;
4678
4679 // We assume that all of BB is (probably) live now and if there are calls to
4680 // internal functions we will assume that those are now live as well. This
4681 // is a performance optimization for blocks with calls to a lot of internal
4682 // functions. It can however cause dead functions to be treated as live.
4683 for (const Instruction &I : BB)
4684 if (const auto *CB = dyn_cast<CallBase>(&I))
4686 if (F->hasLocalLinkage()) {
4687 LLVM_DEBUG({
4688 dbgs() << "[AAIsDead] Seeding live internal callee ";
4689 F->printAsOperand(dbgs(), /*PrintType=*/false);
4690 dbgs() << " from ";
4691 BB.getParent()->printAsOperand(dbgs(), /*PrintType=*/false);
4692 dbgs() << "\n";
4693 });
4694 A.markLiveInternalFunction(*F);
4695 }
4696 return true;
4697 }
4698
4699 /// Collection of instructions that need to be explored again, e.g., we
4700 /// did assume they do not transfer control to (one of their) successors.
4701 SmallSetVector<const Instruction *, 8> ToBeExploredFrom;
4702
4703 /// Collection of instructions that are known to not transfer control.
4704 SmallSetVector<const Instruction *, 8> KnownDeadEnds;
4705
4706 /// Collection of all assumed live edges
4707 DenseSet<std::pair<const BasicBlock *, const BasicBlock *>> AssumedLiveEdges;
4708
4709 /// Collection of all assumed live BasicBlocks.
4710 DenseSet<const BasicBlock *> AssumedLiveBlocks;
4711};
4712
4713static bool
4714identifyAliveSuccessors(Attributor &A, const CallBase &CB,
4715 AbstractAttribute &AA,
4716 SmallVectorImpl<const Instruction *> &AliveSuccessors) {
4717 const IRPosition &IPos = IRPosition::callsite_function(CB);
4718
4719 bool IsKnownNoReturn;
4721 A, &AA, IPos, DepClassTy::OPTIONAL, IsKnownNoReturn))
4722 return !IsKnownNoReturn;
4723 if (CB.isTerminator())
4724 AliveSuccessors.push_back(&CB.getSuccessor(0)->front());
4725 else
4726 AliveSuccessors.push_back(CB.getNextNode());
4727 return false;
4728}
4729
4730static bool
4731identifyAliveSuccessors(Attributor &A, const InvokeInst &II,
4732 AbstractAttribute &AA,
4733 SmallVectorImpl<const Instruction *> &AliveSuccessors) {
4734 bool UsedAssumedInformation =
4735 identifyAliveSuccessors(A, cast<CallBase>(II), AA, AliveSuccessors);
4736
4737 // First, determine if we can change an invoke to a call assuming the
4738 // callee is nounwind. This is not possible if the personality of the
4739 // function allows to catch asynchronous exceptions.
4740 if (AAIsDeadFunction::mayCatchAsynchronousExceptions(*II.getFunction())) {
4741 AliveSuccessors.push_back(&II.getUnwindDest()->front());
4742 } else {
4743 const IRPosition &IPos = IRPosition::callsite_function(II);
4744
4745 bool IsKnownNoUnwind;
4747 A, &AA, IPos, DepClassTy::OPTIONAL, IsKnownNoUnwind)) {
4748 UsedAssumedInformation |= !IsKnownNoUnwind;
4749 } else {
4750 AliveSuccessors.push_back(&II.getUnwindDest()->front());
4751 }
4752 }
4753 return UsedAssumedInformation;
4754}
4755
4756static bool
4757identifyAliveSuccessors(Attributor &, const UncondBrInst &BI,
4758 AbstractAttribute &,
4759 SmallVectorImpl<const Instruction *> &AliveSuccessors) {
4760 AliveSuccessors.push_back(&BI.getSuccessor()->front());
4761 return false;
4762}
4763
4764static bool
4765identifyAliveSuccessors(Attributor &A, const CondBrInst &BI,
4766 AbstractAttribute &AA,
4767 SmallVectorImpl<const Instruction *> &AliveSuccessors) {
4768 bool UsedAssumedInformation = false;
4769 std::optional<Constant *> C =
4770 A.getAssumedConstant(*BI.getCondition(), AA, UsedAssumedInformation);
4771 if (!C || isa_and_nonnull<UndefValue>(*C)) {
4772 // No value yet, assume both edges are dead.
4773 } else if (isa_and_nonnull<ConstantInt>(*C)) {
4774 const BasicBlock *SuccBB =
4775 BI.getSuccessor(1 - cast<ConstantInt>(*C)->getValue().getZExtValue());
4776 AliveSuccessors.push_back(&SuccBB->front());
4777 } else {
4778 AliveSuccessors.push_back(&BI.getSuccessor(0)->front());
4779 AliveSuccessors.push_back(&BI.getSuccessor(1)->front());
4780 UsedAssumedInformation = false;
4781 }
4782 return UsedAssumedInformation;
4783}
4784
4785static bool
4786identifyAliveSuccessors(Attributor &A, const SwitchInst &SI,
4787 AbstractAttribute &AA,
4788 SmallVectorImpl<const Instruction *> &AliveSuccessors) {
4789 bool UsedAssumedInformation = false;
4791 if (!A.getAssumedSimplifiedValues(IRPosition::value(*SI.getCondition()), &AA,
4793 UsedAssumedInformation)) {
4794 // Something went wrong, assume all successors are live.
4795 for (const BasicBlock *SuccBB : successors(SI.getParent()))
4796 AliveSuccessors.push_back(&SuccBB->front());
4797 return false;
4798 }
4799
4800 if (Values.empty() ||
4801 (Values.size() == 1 &&
4802 isa_and_nonnull<UndefValue>(Values.front().getValue()))) {
4803 // No valid value yet, assume all edges are dead.
4804 return UsedAssumedInformation;
4805 }
4806
4807 Type &Ty = *SI.getCondition()->getType();
4808 SmallPtrSet<ConstantInt *, 8> Constants;
4809 auto CheckForConstantInt = [&](Value *V) {
4810 if (auto *CI = dyn_cast_if_present<ConstantInt>(AA::getWithType(*V, Ty))) {
4811 Constants.insert(CI);
4812 return true;
4813 }
4814 return false;
4815 };
4816
4817 if (!all_of(Values, [&](AA::ValueAndContext &VAC) {
4818 return CheckForConstantInt(VAC.getValue());
4819 })) {
4820 for (const BasicBlock *SuccBB : successors(SI.getParent()))
4821 AliveSuccessors.push_back(&SuccBB->front());
4822 return UsedAssumedInformation;
4823 }
4824
4825 unsigned MatchedCases = 0;
4826 for (const auto &CaseIt : SI.cases()) {
4827 if (Constants.count(CaseIt.getCaseValue())) {
4828 ++MatchedCases;
4829 AliveSuccessors.push_back(&CaseIt.getCaseSuccessor()->front());
4830 }
4831 }
4832
4833 // If all potential values have been matched, we will not visit the default
4834 // case.
4835 if (MatchedCases < Constants.size())
4836 AliveSuccessors.push_back(&SI.getDefaultDest()->front());
4837 return UsedAssumedInformation;
4838}
4839
4840ChangeStatus AAIsDeadFunction::updateImpl(Attributor &A) {
4842
4843 if (AssumedLiveBlocks.empty()) {
4844 if (isAssumedDeadInternalFunction(A))
4846
4847 Function *F = getAnchorScope();
4848 ToBeExploredFrom.insert(&F->getEntryBlock().front());
4849 assumeLive(A, F->getEntryBlock());
4850 Change = ChangeStatus::CHANGED;
4851 }
4852
4853 LLVM_DEBUG(dbgs() << "[AAIsDead] Live [" << AssumedLiveBlocks.size() << "/"
4854 << getAnchorScope()->size() << "] BBs and "
4855 << ToBeExploredFrom.size() << " exploration points and "
4856 << KnownDeadEnds.size() << " known dead ends\n");
4857
4858 // Copy and clear the list of instructions we need to explore from. It is
4859 // refilled with instructions the next update has to look at.
4860 SmallVector<const Instruction *, 8> Worklist(ToBeExploredFrom.begin(),
4861 ToBeExploredFrom.end());
4862 decltype(ToBeExploredFrom) NewToBeExploredFrom;
4863
4865 while (!Worklist.empty()) {
4866 const Instruction *I = Worklist.pop_back_val();
4867 LLVM_DEBUG(dbgs() << "[AAIsDead] Exploration inst: " << *I << "\n");
4868
4869 // Fast forward for uninteresting instructions. We could look for UB here
4870 // though.
4871 while (!I->isTerminator() && !isa<CallBase>(I))
4872 I = I->getNextNode();
4873
4874 AliveSuccessors.clear();
4875
4876 bool UsedAssumedInformation = false;
4877 switch (I->getOpcode()) {
4878 // TODO: look for (assumed) UB to backwards propagate "deadness".
4879 default:
4880 assert(I->isTerminator() &&
4881 "Expected non-terminators to be handled already!");
4882 for (const BasicBlock *SuccBB : successors(I->getParent()))
4883 AliveSuccessors.push_back(&SuccBB->front());
4884 break;
4885 case Instruction::Call:
4886 UsedAssumedInformation = identifyAliveSuccessors(A, cast<CallInst>(*I),
4887 *this, AliveSuccessors);
4888 break;
4889 case Instruction::Invoke:
4890 UsedAssumedInformation = identifyAliveSuccessors(A, cast<InvokeInst>(*I),
4891 *this, AliveSuccessors);
4892 break;
4893 case Instruction::UncondBr:
4894 UsedAssumedInformation = identifyAliveSuccessors(
4895 A, cast<UncondBrInst>(*I), *this, AliveSuccessors);
4896 break;
4897 case Instruction::CondBr:
4898 UsedAssumedInformation = identifyAliveSuccessors(A, cast<CondBrInst>(*I),
4899 *this, AliveSuccessors);
4900 break;
4901 case Instruction::Switch:
4902 UsedAssumedInformation = identifyAliveSuccessors(A, cast<SwitchInst>(*I),
4903 *this, AliveSuccessors);
4904 break;
4905 }
4906
4907 if (UsedAssumedInformation) {
4908 NewToBeExploredFrom.insert(I);
4909 } else if (AliveSuccessors.empty() ||
4910 (I->isTerminator() &&
4911 AliveSuccessors.size() < I->getNumSuccessors())) {
4912 if (KnownDeadEnds.insert(I))
4913 Change = ChangeStatus::CHANGED;
4914 }
4915
4916 LLVM_DEBUG(dbgs() << "[AAIsDead] #AliveSuccessors: "
4917 << AliveSuccessors.size() << " UsedAssumedInformation: "
4918 << UsedAssumedInformation << "\n");
4919
4920 for (const Instruction *AliveSuccessor : AliveSuccessors) {
4921 if (!I->isTerminator()) {
4922 assert(AliveSuccessors.size() == 1 &&
4923 "Non-terminator expected to have a single successor!");
4924 Worklist.push_back(AliveSuccessor);
4925 } else {
4926 // record the assumed live edge
4927 auto Edge = std::make_pair(I->getParent(), AliveSuccessor->getParent());
4928 if (AssumedLiveEdges.insert(Edge).second)
4929 Change = ChangeStatus::CHANGED;
4930 if (assumeLive(A, *AliveSuccessor->getParent()))
4931 Worklist.push_back(AliveSuccessor);
4932 }
4933 }
4934 }
4935
4936 // Check if the content of ToBeExploredFrom changed, ignore the order.
4937 if (NewToBeExploredFrom.size() != ToBeExploredFrom.size() ||
4938 llvm::any_of(NewToBeExploredFrom, [&](const Instruction *I) {
4939 return !ToBeExploredFrom.count(I);
4940 })) {
4941 Change = ChangeStatus::CHANGED;
4942 ToBeExploredFrom = std::move(NewToBeExploredFrom);
4943 }
4944
4945 // If we know everything is live there is no need to query for liveness.
4946 // Instead, indicating a pessimistic fixpoint will cause the state to be
4947 // "invalid" and all queries to be answered conservatively without lookups.
4948 // To be in this state we have to (1) finished the exploration and (3) not
4949 // discovered any non-trivial dead end and (2) not ruled unreachable code
4950 // dead.
4951 if (ToBeExploredFrom.empty() &&
4952 getAnchorScope()->size() == AssumedLiveBlocks.size() &&
4953 llvm::all_of(KnownDeadEnds, [](const Instruction *DeadEndI) {
4954 return DeadEndI->isTerminator() && DeadEndI->getNumSuccessors() == 0;
4955 }))
4956 return indicatePessimisticFixpoint();
4957 return Change;
4958}
4959
4960/// Liveness information for a call sites.
4961struct AAIsDeadCallSite final : AAIsDeadFunction {
4962 AAIsDeadCallSite(const IRPosition &IRP, Attributor &A)
4963 : AAIsDeadFunction(IRP, A) {}
4964
4965 /// See AbstractAttribute::initialize(...).
4966 void initialize(Attributor &A) override {
4967 // TODO: Once we have call site specific value information we can provide
4968 // call site specific liveness information and then it makes
4969 // sense to specialize attributes for call sites instead of
4970 // redirecting requests to the callee.
4971 llvm_unreachable("Abstract attributes for liveness are not "
4972 "supported for call sites yet!");
4973 }
4974
4975 /// See AbstractAttribute::updateImpl(...).
4976 ChangeStatus updateImpl(Attributor &A) override {
4977 return indicatePessimisticFixpoint();
4978 }
4979
4980 /// See AbstractAttribute::trackStatistics()
4981 void trackStatistics() const override {}
4982};
4983} // namespace
4984
4985/// -------------------- Dereferenceable Argument Attribute --------------------
4986
4987namespace {
4988struct AADereferenceableImpl : AADereferenceable {
4989 AADereferenceableImpl(const IRPosition &IRP, Attributor &A)
4990 : AADereferenceable(IRP, A) {}
4991 using StateType = DerefState;
4992
4993 /// See AbstractAttribute::initialize(...).
4994 void initialize(Attributor &A) override {
4995 Value &V = *getAssociatedValue().stripPointerCasts();
4997 A.getAttrs(getIRPosition(),
4998 {Attribute::Dereferenceable, Attribute::DereferenceableOrNull},
4999 Attrs, /* IgnoreSubsumingPositions */ false);
5000 for (const Attribute &Attr : Attrs)
5001 takeKnownDerefBytesMaximum(Attr.getValueAsInt());
5002
5003 // Ensure we initialize the non-null AA (if necessary).
5004 bool IsKnownNonNull;
5006 A, this, getIRPosition(), DepClassTy::OPTIONAL, IsKnownNonNull);
5007
5008 bool CanBeNull;
5009 takeKnownDerefBytesMaximum(V.getPointerDereferenceableBytes(
5010 A.getDataLayout(), CanBeNull, /*CanBeFreed=*/nullptr));
5011
5012 if (Instruction *CtxI = getCtxI())
5013 followUsesInMBEC(*this, A, getState(), *CtxI);
5014 }
5015
5016 /// See AbstractAttribute::getState()
5017 /// {
5018 StateType &getState() override { return *this; }
5019 const StateType &getState() const override { return *this; }
5020 /// }
5021
5022 /// Helper function for collecting accessed bytes in must-be-executed-context
5023 void addAccessedBytesForUse(Attributor &A, const Use *U, const Instruction *I,
5024 DerefState &State) {
5025 const Value *UseV = U->get();
5026 if (!UseV->getType()->isPointerTy())
5027 return;
5028
5029 std::optional<MemoryLocation> Loc = MemoryLocation::getOrNone(I);
5030 if (!Loc || Loc->Ptr != UseV || !Loc->Size.isPrecise() || I->isVolatile())
5031 return;
5032
5033 int64_t Offset;
5035 Loc->Ptr, Offset, A.getDataLayout(), /*AllowNonInbounds*/ true);
5036 if (Base && Base == &getAssociatedValue())
5037 State.addAccessedBytes(Offset, Loc->Size.getValue());
5038 }
5039
5040 /// See followUsesInMBEC
5041 bool followUseInMBEC(Attributor &A, const Use *U, const Instruction *I,
5042 AADereferenceable::StateType &State) {
5043 bool IsNonNull = false;
5044 bool TrackUse = false;
5045 int64_t DerefBytes = getKnownNonNullAndDerefBytesForUse(
5046 A, *this, getAssociatedValue(), U, I, IsNonNull, TrackUse);
5047 LLVM_DEBUG(dbgs() << "[AADereferenceable] Deref bytes: " << DerefBytes
5048 << " for instruction " << *I << "\n");
5049
5050 addAccessedBytesForUse(A, U, I, State);
5051 State.takeKnownDerefBytesMaximum(DerefBytes);
5052 return TrackUse;
5053 }
5054
5055 /// See AbstractAttribute::manifest(...).
5056 ChangeStatus manifest(Attributor &A) override {
5057 ChangeStatus Change = AADereferenceable::manifest(A);
5058 bool IsKnownNonNull;
5059 bool IsAssumedNonNull = AA::hasAssumedIRAttr<Attribute::NonNull>(
5060 A, this, getIRPosition(), DepClassTy::NONE, IsKnownNonNull);
5061 if (IsAssumedNonNull &&
5062 A.hasAttr(getIRPosition(), Attribute::DereferenceableOrNull)) {
5063 A.removeAttrs(getIRPosition(), {Attribute::DereferenceableOrNull});
5064 return ChangeStatus::CHANGED;
5065 }
5066 return Change;
5067 }
5068
5069 void getDeducedAttributes(Attributor &A, LLVMContext &Ctx,
5070 SmallVectorImpl<Attribute> &Attrs) const override {
5071 // TODO: Add *_globally support
5072 bool IsKnownNonNull;
5073 bool IsAssumedNonNull = AA::hasAssumedIRAttr<Attribute::NonNull>(
5074 A, this, getIRPosition(), DepClassTy::NONE, IsKnownNonNull);
5075 if (IsAssumedNonNull)
5076 Attrs.emplace_back(Attribute::getWithDereferenceableBytes(
5077 Ctx, getAssumedDereferenceableBytes()));
5078 else
5079 Attrs.emplace_back(Attribute::getWithDereferenceableOrNullBytes(
5080 Ctx, getAssumedDereferenceableBytes()));
5081 }
5082
5083 /// See AbstractAttribute::getAsStr().
5084 const std::string getAsStr(Attributor *A) const override {
5085 if (!getAssumedDereferenceableBytes())
5086 return "unknown-dereferenceable";
5087 bool IsKnownNonNull;
5088 bool IsAssumedNonNull = false;
5089 if (A)
5091 *A, this, getIRPosition(), DepClassTy::NONE, IsKnownNonNull);
5092 return std::string("dereferenceable") +
5093 (IsAssumedNonNull ? "" : "_or_null") +
5094 (isAssumedGlobal() ? "_globally" : "") + "<" +
5095 std::to_string(getKnownDereferenceableBytes()) + "-" +
5096 std::to_string(getAssumedDereferenceableBytes()) + ">" +
5097 (!A ? " [non-null is unknown]" : "");
5098 }
5099};
5100
5101/// Dereferenceable attribute for a floating value.
5102struct AADereferenceableFloating : AADereferenceableImpl {
5103 AADereferenceableFloating(const IRPosition &IRP, Attributor &A)
5104 : AADereferenceableImpl(IRP, A) {}
5105
5106 /// See AbstractAttribute::updateImpl(...).
5107 ChangeStatus updateImpl(Attributor &A) override {
5108 bool Stripped;
5109 bool UsedAssumedInformation = false;
5111 if (!A.getAssumedSimplifiedValues(getIRPosition(), *this, Values,
5112 AA::AnyScope, UsedAssumedInformation)) {
5113 Values.push_back({getAssociatedValue(), getCtxI()});
5114 Stripped = false;
5115 } else {
5116 Stripped = Values.size() != 1 ||
5117 Values.front().getValue() != &getAssociatedValue();
5118 }
5119
5120 const DataLayout &DL = A.getDataLayout();
5121 DerefState T;
5122
5123 auto VisitValueCB = [&](const Value &V) -> bool {
5124 unsigned IdxWidth =
5125 DL.getIndexSizeInBits(V.getType()->getPointerAddressSpace());
5126 APInt Offset(IdxWidth, 0);
5128 A, *this, &V, DL, Offset, /* GetMinOffset */ false,
5129 /* AllowNonInbounds */ true);
5130
5131 const auto *AA = A.getAAFor<AADereferenceable>(
5132 *this, IRPosition::value(*Base), DepClassTy::REQUIRED);
5133 int64_t DerefBytes = 0;
5134 if (!AA || (!Stripped && this == AA)) {
5135 // Use IR information if we did not strip anything.
5136 // TODO: track globally.
5137 bool CanBeNull;
5138 DerefBytes = Base->getPointerDereferenceableBytes(
5139 DL, CanBeNull, /*CanBeFreed=*/nullptr);
5140 T.GlobalState.indicatePessimisticFixpoint();
5141 } else {
5142 const DerefState &DS = AA->getState();
5143 DerefBytes = DS.DerefBytesState.getAssumed();
5144 T.GlobalState &= DS.GlobalState;
5145 }
5146
5147 // For now we do not try to "increase" dereferenceability due to negative
5148 // indices as we first have to come up with code to deal with loops and
5149 // for overflows of the dereferenceable bytes.
5150 int64_t OffsetSExt = Offset.getSExtValue();
5151 if (OffsetSExt < 0)
5152 OffsetSExt = 0;
5153
5154 T.takeAssumedDerefBytesMinimum(
5155 std::max(int64_t(0), DerefBytes - OffsetSExt));
5156
5157 if (this == AA) {
5158 if (!Stripped) {
5159 // If nothing was stripped IR information is all we got.
5160 T.takeKnownDerefBytesMaximum(
5161 std::max(int64_t(0), DerefBytes - OffsetSExt));
5162 T.indicatePessimisticFixpoint();
5163 } else if (OffsetSExt > 0) {
5164 // If something was stripped but there is circular reasoning we look
5165 // for the offset. If it is positive we basically decrease the
5166 // dereferenceable bytes in a circular loop now, which will simply
5167 // drive them down to the known value in a very slow way which we
5168 // can accelerate.
5169 T.indicatePessimisticFixpoint();
5170 }
5171 }
5172
5173 return T.isValidState();
5174 };
5175
5176 for (const auto &VAC : Values)
5177 if (!VisitValueCB(*VAC.getValue()))
5178 return indicatePessimisticFixpoint();
5179
5180 return clampStateAndIndicateChange(getState(), T);
5181 }
5182
5183 /// See AbstractAttribute::trackStatistics()
5184 void trackStatistics() const override {
5185 STATS_DECLTRACK_FLOATING_ATTR(dereferenceable)
5186 }
5187};
5188
5189/// Dereferenceable attribute for a return value.
5190struct AADereferenceableReturned final
5191 : AAReturnedFromReturnedValues<AADereferenceable, AADereferenceableImpl> {
5192 using Base =
5193 AAReturnedFromReturnedValues<AADereferenceable, AADereferenceableImpl>;
5194 AADereferenceableReturned(const IRPosition &IRP, Attributor &A)
5195 : Base(IRP, A) {}
5196
5197 /// See AbstractAttribute::trackStatistics()
5198 void trackStatistics() const override {
5199 STATS_DECLTRACK_FNRET_ATTR(dereferenceable)
5200 }
5201};
5202
5203/// Dereferenceable attribute for an argument
5204struct AADereferenceableArgument final
5205 : AAArgumentFromCallSiteArguments<AADereferenceable,
5206 AADereferenceableImpl> {
5207 using Base =
5208 AAArgumentFromCallSiteArguments<AADereferenceable, AADereferenceableImpl>;
5209 AADereferenceableArgument(const IRPosition &IRP, Attributor &A)
5210 : Base(IRP, A) {}
5211
5212 /// See AbstractAttribute::trackStatistics()
5213 void trackStatistics() const override {
5214 STATS_DECLTRACK_ARG_ATTR(dereferenceable)
5215 }
5216};
5217
5218/// Dereferenceable attribute for a call site argument.
5219struct AADereferenceableCallSiteArgument final : AADereferenceableFloating {
5220 AADereferenceableCallSiteArgument(const IRPosition &IRP, Attributor &A)
5221 : AADereferenceableFloating(IRP, A) {}
5222
5223 /// See AbstractAttribute::trackStatistics()
5224 void trackStatistics() const override {
5225 STATS_DECLTRACK_CSARG_ATTR(dereferenceable)
5226 }
5227};
5228
5229/// Dereferenceable attribute deduction for a call site return value.
5230struct AADereferenceableCallSiteReturned final
5231 : AACalleeToCallSite<AADereferenceable, AADereferenceableImpl> {
5232 using Base = AACalleeToCallSite<AADereferenceable, AADereferenceableImpl>;
5233 AADereferenceableCallSiteReturned(const IRPosition &IRP, Attributor &A)
5234 : Base(IRP, A) {}
5235
5236 /// See AbstractAttribute::trackStatistics()
5237 void trackStatistics() const override {
5238 STATS_DECLTRACK_CS_ATTR(dereferenceable);
5239 }
5240};
5241} // namespace
5242
5243// ------------------------ Align Argument Attribute ------------------------
5244
5245namespace {
5246
5247static unsigned getKnownAlignForUse(Attributor &A, AAAlign &QueryingAA,
5248 Value &AssociatedValue, const Use *U,
5249 const Instruction *I, bool &TrackUse) {
5250 // We need to follow common pointer manipulation uses to the accesses they
5251 // feed into.
5252 if (isa<CastInst>(I)) {
5253 // Follow all but ptr2int casts.
5254 TrackUse = !isa<PtrToIntInst>(I);
5255 return 0;
5256 }
5257 if (auto *GEP = dyn_cast<GetElementPtrInst>(I)) {
5258 if (GEP->hasAllConstantIndices())
5259 TrackUse = true;
5260 return 0;
5261 }
5262 if (const IntrinsicInst *II = dyn_cast<IntrinsicInst>(I))
5263 switch (II->getIntrinsicID()) {
5264 case Intrinsic::ptrmask: {
5265 // Is it appropriate to pull attribute in initialization?
5266 const auto *ConstVals = A.getAAFor<AAPotentialConstantValues>(
5267 QueryingAA, IRPosition::value(*II->getOperand(1)), DepClassTy::NONE);
5268 const auto *AlignAA = A.getAAFor<AAAlign>(
5269 QueryingAA, IRPosition::value(*II), DepClassTy::NONE);
5270 if (ConstVals && ConstVals->isValidState() && ConstVals->isAtFixpoint()) {
5271 unsigned ShiftValue = std::min(ConstVals->getAssumedMinTrailingZeros(),
5273 Align ConstAlign(UINT64_C(1) << ShiftValue);
5274 if (ConstAlign >= AlignAA->getKnownAlign())
5275 return Align(1).value();
5276 }
5277 if (AlignAA)
5278 return AlignAA->getKnownAlign().value();
5279 break;
5280 }
5281 case Intrinsic::amdgcn_make_buffer_rsrc: {
5282 const auto *AlignAA = A.getAAFor<AAAlign>(
5283 QueryingAA, IRPosition::value(*II), DepClassTy::NONE);
5284 if (AlignAA)
5285 return AlignAA->getKnownAlign().value();
5286 break;
5287 }
5288 default:
5289 break;
5290 }
5291
5292 MaybeAlign MA;
5293 if (const auto *CB = dyn_cast<CallBase>(I)) {
5294 if (CB->isBundleOperand(U) || CB->isCallee(U))
5295 return 0;
5296
5297 unsigned ArgNo = CB->getArgOperandNo(U);
5298 IRPosition IRP = IRPosition::callsite_argument(*CB, ArgNo);
5299 // As long as we only use known information there is no need to track
5300 // dependences here.
5301 auto *AlignAA = A.getAAFor<AAAlign>(QueryingAA, IRP, DepClassTy::NONE);
5302 if (AlignAA)
5303 MA = MaybeAlign(AlignAA->getKnownAlign());
5304 }
5305
5306 const DataLayout &DL = A.getDataLayout();
5307 const Value *UseV = U->get();
5308 if (auto *SI = dyn_cast<StoreInst>(I)) {
5309 if (SI->getPointerOperand() == UseV)
5310 MA = SI->getAlign();
5311 } else if (auto *LI = dyn_cast<LoadInst>(I)) {
5312 if (LI->getPointerOperand() == UseV)
5313 MA = LI->getAlign();
5314 } else if (auto *AI = dyn_cast<AtomicRMWInst>(I)) {
5315 if (AI->getPointerOperand() == UseV)
5316 MA = AI->getAlign();
5317 } else if (auto *AI = dyn_cast<AtomicCmpXchgInst>(I)) {
5318 if (AI->getPointerOperand() == UseV)
5319 MA = AI->getAlign();
5320 }
5321
5322 if (!MA || *MA <= QueryingAA.getKnownAlign())
5323 return 0;
5324
5325 unsigned Alignment = MA->value();
5326 int64_t Offset;
5327
5328 if (const Value *Base = GetPointerBaseWithConstantOffset(UseV, Offset, DL)) {
5329 if (Base == &AssociatedValue) {
5330 // BasePointerAddr + Offset = Alignment * Q for some integer Q.
5331 // So we can say that the maximum power of two which is a divisor of
5332 // gcd(Offset, Alignment) is an alignment.
5333
5334 uint32_t gcd = std::gcd(uint32_t(abs((int32_t)Offset)), Alignment);
5336 }
5337 }
5338
5339 return Alignment;
5340}
5341
5342struct AAAlignImpl : AAAlign {
5343 AAAlignImpl(const IRPosition &IRP, Attributor &A) : AAAlign(IRP, A) {}
5344
5345 /// See AbstractAttribute::initialize(...).
5346 void initialize(Attributor &A) override {
5348 A.getAttrs(getIRPosition(), {Attribute::Alignment}, Attrs);
5349 for (const Attribute &Attr : Attrs)
5350 takeKnownMaximum(Attr.getValueAsInt());
5351
5352 Value &V = *getAssociatedValue().stripPointerCasts();
5353 takeKnownMaximum(V.getPointerAlignment(A.getDataLayout()).value());
5354
5355 if (Instruction *CtxI = getCtxI())
5356 followUsesInMBEC(*this, A, getState(), *CtxI);
5357 }
5358
5359 /// See AbstractAttribute::manifest(...).
5360 ChangeStatus manifest(Attributor &A) override {
5361 ChangeStatus InstrChanged = ChangeStatus::UNCHANGED;
5362
5363 // Check for users that allow alignment annotations.
5364 Value &AssociatedValue = getAssociatedValue();
5365 if (isa<ConstantData>(AssociatedValue))
5366 return ChangeStatus::UNCHANGED;
5367
5368 for (const Use &U : AssociatedValue.uses()) {
5369 if (auto *SI = dyn_cast<StoreInst>(U.getUser())) {
5370 if (SI->getPointerOperand() == &AssociatedValue)
5371 if (SI->getAlign() < getAssumedAlign()) {
5372 STATS_DECLTRACK(AAAlign, Store,
5373 "Number of times alignment added to a store");
5374 SI->setAlignment(getAssumedAlign());
5375 InstrChanged = ChangeStatus::CHANGED;
5376 }
5377 } else if (auto *LI = dyn_cast<LoadInst>(U.getUser())) {
5378 if (LI->getPointerOperand() == &AssociatedValue)
5379 if (LI->getAlign() < getAssumedAlign()) {
5380 LI->setAlignment(getAssumedAlign());
5381 STATS_DECLTRACK(AAAlign, Load,
5382 "Number of times alignment added to a load");
5383 InstrChanged = ChangeStatus::CHANGED;
5384 }
5385 } else if (auto *RMW = dyn_cast<AtomicRMWInst>(U.getUser())) {
5386 if (RMW->getPointerOperand() == &AssociatedValue) {
5387 if (RMW->getAlign() < getAssumedAlign()) {
5388 STATS_DECLTRACK(AAAlign, AtomicRMW,
5389 "Number of times alignment added to atomicrmw");
5390
5391 RMW->setAlignment(getAssumedAlign());
5392 InstrChanged = ChangeStatus::CHANGED;
5393 }
5394 }
5395 } else if (auto *CAS = dyn_cast<AtomicCmpXchgInst>(U.getUser())) {
5396 if (CAS->getPointerOperand() == &AssociatedValue) {
5397 if (CAS->getAlign() < getAssumedAlign()) {
5398 STATS_DECLTRACK(AAAlign, AtomicCmpXchg,
5399 "Number of times alignment added to cmpxchg");
5400 CAS->setAlignment(getAssumedAlign());
5401 InstrChanged = ChangeStatus::CHANGED;
5402 }
5403 }
5404 }
5405 }
5406
5407 ChangeStatus Changed = AAAlign::manifest(A);
5408
5409 Align InheritAlign =
5410 getAssociatedValue().getPointerAlignment(A.getDataLayout());
5411 if (InheritAlign >= getAssumedAlign())
5412 return InstrChanged;
5413 return Changed | InstrChanged;
5414 }
5415
5416 // TODO: Provide a helper to determine the implied ABI alignment and check in
5417 // the existing manifest method and a new one for AAAlignImpl that value
5418 // to avoid making the alignment explicit if it did not improve.
5419
5420 /// See AbstractAttribute::getDeducedAttributes
5421 void getDeducedAttributes(Attributor &A, LLVMContext &Ctx,
5422 SmallVectorImpl<Attribute> &Attrs) const override {
5423 if (getAssumedAlign() > 1)
5424 Attrs.emplace_back(
5425 Attribute::getWithAlignment(Ctx, Align(getAssumedAlign())));
5426 }
5427
5428 /// See followUsesInMBEC
5429 bool followUseInMBEC(Attributor &A, const Use *U, const Instruction *I,
5430 AAAlign::StateType &State) {
5431 bool TrackUse = false;
5432
5433 unsigned int KnownAlign =
5434 getKnownAlignForUse(A, *this, getAssociatedValue(), U, I, TrackUse);
5435 State.takeKnownMaximum(KnownAlign);
5436
5437 return TrackUse;
5438 }
5439
5440 /// See AbstractAttribute::getAsStr().
5441 const std::string getAsStr(Attributor *A) const override {
5442 return "align<" + std::to_string(getKnownAlign().value()) + "-" +
5443 std::to_string(getAssumedAlign().value()) + ">";
5444 }
5445};
5446
5447/// Align attribute for a floating value.
5448struct AAAlignFloating : AAAlignImpl {
5449 AAAlignFloating(const IRPosition &IRP, Attributor &A) : AAAlignImpl(IRP, A) {}
5450
5451 /// See AbstractAttribute::updateImpl(...).
5452 ChangeStatus updateImpl(Attributor &A) override {
5453 const DataLayout &DL = A.getDataLayout();
5454
5455 bool Stripped;
5456 bool UsedAssumedInformation = false;
5458 if (!A.getAssumedSimplifiedValues(getIRPosition(), *this, Values,
5459 AA::AnyScope, UsedAssumedInformation)) {
5460 Values.push_back({getAssociatedValue(), getCtxI()});
5461 Stripped = false;
5462 } else {
5463 Stripped = Values.size() != 1 ||
5464 Values.front().getValue() != &getAssociatedValue();
5465 }
5466
5467 StateType T;
5468 auto VisitValueCB = [&](Value &V) -> bool {
5470 return true;
5471 const auto *AA = A.getAAFor<AAAlign>(*this, IRPosition::value(V),
5472 DepClassTy::REQUIRED);
5473 if (!AA || (!Stripped && this == AA)) {
5474 int64_t Offset;
5475 unsigned Alignment = 1;
5476 if (const Value *Base =
5478 // TODO: Use AAAlign for the base too.
5479 Align PA = Base->getPointerAlignment(DL);
5480 // BasePointerAddr + Offset = Alignment * Q for some integer Q.
5481 // So we can say that the maximum power of two which is a divisor of
5482 // gcd(Offset, Alignment) is an alignment.
5483
5484 uint32_t gcd =
5485 std::gcd(uint32_t(abs((int32_t)Offset)), uint32_t(PA.value()));
5487 } else {
5488 Alignment = V.getPointerAlignment(DL).value();
5489 }
5490 // Use only IR information if we did not strip anything.
5491 T.takeKnownMaximum(Alignment);
5492 T.indicatePessimisticFixpoint();
5493 } else {
5494 // Use abstract attribute information.
5495 const AAAlign::StateType &DS = AA->getState();
5496 T ^= DS;
5497 }
5498 return T.isValidState();
5499 };
5500
5501 for (const auto &VAC : Values) {
5502 if (!VisitValueCB(*VAC.getValue()))
5503 return indicatePessimisticFixpoint();
5504 }
5505
5506 // TODO: If we know we visited all incoming values, thus no are assumed
5507 // dead, we can take the known information from the state T.
5508 return clampStateAndIndicateChange(getState(), T);
5509 }
5510
5511 /// See AbstractAttribute::trackStatistics()
5512 void trackStatistics() const override { STATS_DECLTRACK_FLOATING_ATTR(align) }
5513};
5514
5515/// Align attribute for function return value.
5516struct AAAlignReturned final
5517 : AAReturnedFromReturnedValues<AAAlign, AAAlignImpl> {
5518 using Base = AAReturnedFromReturnedValues<AAAlign, AAAlignImpl>;
5519 AAAlignReturned(const IRPosition &IRP, Attributor &A) : Base(IRP, A) {}
5520
5521 /// See AbstractAttribute::trackStatistics()
5522 void trackStatistics() const override { STATS_DECLTRACK_FNRET_ATTR(aligned) }
5523};
5524
5525/// Align attribute for function argument.
5526struct AAAlignArgument final
5527 : AAArgumentFromCallSiteArguments<AAAlign, AAAlignImpl> {
5528 using Base = AAArgumentFromCallSiteArguments<AAAlign, AAAlignImpl>;
5529 AAAlignArgument(const IRPosition &IRP, Attributor &A) : Base(IRP, A) {}
5530
5531 /// See AbstractAttribute::manifest(...).
5532 ChangeStatus manifest(Attributor &A) override {
5533 // If the associated argument is involved in a must-tail call we give up
5534 // because we would need to keep the argument alignments of caller and
5535 // callee in-sync. Just does not seem worth the trouble right now.
5536 if (A.getInfoCache().isInvolvedInMustTailCall(*getAssociatedArgument()))
5537 return ChangeStatus::UNCHANGED;
5538 return Base::manifest(A);
5539 }
5540
5541 /// See AbstractAttribute::trackStatistics()
5542 void trackStatistics() const override { STATS_DECLTRACK_ARG_ATTR(aligned) }
5543};
5544
5545struct AAAlignCallSiteArgument final : AAAlignFloating {
5546 AAAlignCallSiteArgument(const IRPosition &IRP, Attributor &A)
5547 : AAAlignFloating(IRP, A) {}
5548
5549 /// See AbstractAttribute::manifest(...).
5550 ChangeStatus manifest(Attributor &A) override {
5551 // If the associated argument is involved in a must-tail call we give up
5552 // because we would need to keep the argument alignments of caller and
5553 // callee in-sync. Just does not seem worth the trouble right now.
5554 if (Argument *Arg = getAssociatedArgument())
5555 if (A.getInfoCache().isInvolvedInMustTailCall(*Arg))
5556 return ChangeStatus::UNCHANGED;
5557 ChangeStatus Changed = AAAlignImpl::manifest(A);
5558 Align InheritAlign =
5559 getAssociatedValue().getPointerAlignment(A.getDataLayout());
5560 if (InheritAlign >= getAssumedAlign())
5561 Changed = ChangeStatus::UNCHANGED;
5562 return Changed;
5563 }
5564
5565 /// See AbstractAttribute::updateImpl(Attributor &A).
5566 ChangeStatus updateImpl(Attributor &A) override {
5567 ChangeStatus Changed = AAAlignFloating::updateImpl(A);
5568 if (Argument *Arg = getAssociatedArgument()) {
5569 // We only take known information from the argument
5570 // so we do not need to track a dependence.
5571 const auto *ArgAlignAA = A.getAAFor<AAAlign>(
5572 *this, IRPosition::argument(*Arg), DepClassTy::NONE);
5573 if (ArgAlignAA)
5574 takeKnownMaximum(ArgAlignAA->getKnownAlign().value());
5575 }
5576 return Changed;
5577 }
5578
5579 /// See AbstractAttribute::trackStatistics()
5580 void trackStatistics() const override { STATS_DECLTRACK_CSARG_ATTR(aligned) }
5581};
5582
5583/// Align attribute deduction for a call site return value.
5584struct AAAlignCallSiteReturned final
5585 : AACalleeToCallSite<AAAlign, AAAlignImpl> {
5586 using Base = AACalleeToCallSite<AAAlign, AAAlignImpl>;
5587 AAAlignCallSiteReturned(const IRPosition &IRP, Attributor &A)
5588 : Base(IRP, A) {}
5589
5590 ChangeStatus updateImpl(Attributor &A) override {
5591 Instruction *I = getIRPosition().getCtxI();
5592 if (const IntrinsicInst *II = dyn_cast<IntrinsicInst>(I)) {
5593 switch (II->getIntrinsicID()) {
5594 case Intrinsic::ptrmask: {
5596 bool Valid = false;
5597
5598 const auto *ConstVals = A.getAAFor<AAPotentialConstantValues>(
5599 *this, IRPosition::value(*II->getOperand(1)), DepClassTy::REQUIRED);
5600 if (ConstVals && ConstVals->isValidState()) {
5601 unsigned ShiftValue =
5602 std::min(ConstVals->getAssumedMinTrailingZeros(),
5603 Value::MaxAlignmentExponent);
5604 Alignment = Align(UINT64_C(1) << ShiftValue);
5605 Valid = true;
5606 }
5607
5608 const auto *AlignAA =
5609 A.getAAFor<AAAlign>(*this, IRPosition::value(*(II->getOperand(0))),
5610 DepClassTy::REQUIRED);
5611 if (AlignAA) {
5612 Alignment = std::max(AlignAA->getAssumedAlign(), Alignment);
5613 Valid = true;
5614 }
5615
5616 if (Valid)
5618 this->getState(),
5619 std::min(this->getAssumedAlign(), Alignment).value());
5620 break;
5621 }
5622 // FIXME: Should introduce target specific sub-attributes and letting
5623 // getAAfor<AAAlign> lead to create sub-attribute to handle target
5624 // specific intrinsics.
5625 case Intrinsic::amdgcn_make_buffer_rsrc: {
5626 const auto *AlignAA =
5627 A.getAAFor<AAAlign>(*this, IRPosition::value(*(II->getOperand(0))),
5628 DepClassTy::REQUIRED);
5629 if (AlignAA)
5631 this->getState(), AlignAA->getAssumedAlign().value());
5632 break;
5633 }
5634 default:
5635 break;
5636 }
5637 }
5638 return Base::updateImpl(A);
5639 };
5640 /// See AbstractAttribute::trackStatistics()
5641 void trackStatistics() const override { STATS_DECLTRACK_CS_ATTR(align); }
5642};
5643} // namespace
5644
5645/// ------------------ Function No-Return Attribute ----------------------------
5646namespace {
5647struct AANoReturnImpl : public AANoReturn {
5648 AANoReturnImpl(const IRPosition &IRP, Attributor &A) : AANoReturn(IRP, A) {}
5649
5650 /// See AbstractAttribute::initialize(...).
5651 void initialize(Attributor &A) override {
5652 bool IsKnown;
5654 A, nullptr, getIRPosition(), DepClassTy::NONE, IsKnown));
5655 (void)IsKnown;
5656 }
5657
5658 /// See AbstractAttribute::getAsStr().
5659 const std::string getAsStr(Attributor *A) const override {
5660 return getAssumed() ? "noreturn" : "may-return";
5661 }
5662
5663 /// See AbstractAttribute::updateImpl(Attributor &A).
5664 ChangeStatus updateImpl(Attributor &A) override {
5665 auto CheckForNoReturn = [](Instruction &) { return false; };
5666 bool UsedAssumedInformation = false;
5667 if (!A.checkForAllInstructions(CheckForNoReturn, *this,
5668 {(unsigned)Instruction::Ret},
5669 UsedAssumedInformation))
5670 return indicatePessimisticFixpoint();
5671 return ChangeStatus::UNCHANGED;
5672 }
5673};
5674
5675struct AANoReturnFunction final : AANoReturnImpl {
5676 AANoReturnFunction(const IRPosition &IRP, Attributor &A)
5677 : AANoReturnImpl(IRP, A) {}
5678
5679 /// See AbstractAttribute::trackStatistics()
5680 void trackStatistics() const override { STATS_DECLTRACK_FN_ATTR(noreturn) }
5681};
5682
5683/// NoReturn attribute deduction for a call sites.
5684struct AANoReturnCallSite final
5685 : AACalleeToCallSite<AANoReturn, AANoReturnImpl> {
5686 AANoReturnCallSite(const IRPosition &IRP, Attributor &A)
5687 : AACalleeToCallSite<AANoReturn, AANoReturnImpl>(IRP, A) {}
5688
5689 /// See AbstractAttribute::trackStatistics()
5690 void trackStatistics() const override { STATS_DECLTRACK_CS_ATTR(noreturn); }
5691};
5692} // namespace
5693
5694/// ----------------------- Instance Info ---------------------------------
5695
5696namespace {
5697/// A class to hold the state of for no-capture attributes.
5698struct AAInstanceInfoImpl : public AAInstanceInfo {
5699 AAInstanceInfoImpl(const IRPosition &IRP, Attributor &A)
5700 : AAInstanceInfo(IRP, A) {}
5701
5702 /// See AbstractAttribute::initialize(...).
5703 void initialize(Attributor &A) override {
5704 Value &V = getAssociatedValue();
5705 if (auto *C = dyn_cast<Constant>(&V)) {
5706 if (C->isThreadDependent())
5707 indicatePessimisticFixpoint();
5708 else
5709 indicateOptimisticFixpoint();
5710 return;
5711 }
5712 if (auto *CB = dyn_cast<CallBase>(&V))
5713 if (CB->arg_size() == 0 && !CB->mayHaveSideEffects() &&
5714 !CB->mayReadFromMemory()) {
5715 indicateOptimisticFixpoint();
5716 return;
5717 }
5718 if (auto *I = dyn_cast<Instruction>(&V)) {
5719 const auto *CI =
5720 A.getInfoCache().getAnalysisResultForFunction<CycleAnalysis>(
5721 *I->getFunction());
5722 if (mayBeInCycle(CI, I, /* HeaderOnly */ false)) {
5723 indicatePessimisticFixpoint();
5724 return;
5725 }
5726 }
5727 }
5728
5729 /// See AbstractAttribute::updateImpl(...).
5730 ChangeStatus updateImpl(Attributor &A) override {
5731 ChangeStatus Changed = ChangeStatus::UNCHANGED;
5732
5733 Value &V = getAssociatedValue();
5734 const Function *Scope = nullptr;
5735 if (auto *I = dyn_cast<Instruction>(&V))
5736 Scope = I->getFunction();
5737 if (auto *A = dyn_cast<Argument>(&V)) {
5738 Scope = A->getParent();
5739 if (!Scope->hasLocalLinkage())
5740 return Changed;
5741 }
5742 if (!Scope)
5743 return indicateOptimisticFixpoint();
5744
5745 bool IsKnownNoRecurse;
5747 A, this, IRPosition::function(*Scope), DepClassTy::OPTIONAL,
5748 IsKnownNoRecurse))
5749 return Changed;
5750
5751 auto UsePred = [&](const Use &U, bool &Follow) {
5752 const Instruction *UserI = dyn_cast<Instruction>(U.getUser());
5753 if (!UserI || isa<GetElementPtrInst>(UserI) || isa<CastInst>(UserI) ||
5754 isa<PHINode>(UserI) || isa<SelectInst>(UserI)) {
5755 Follow = true;
5756 return true;
5757 }
5758 if (isa<LoadInst>(UserI) || isa<CmpInst>(UserI) ||
5759 (isa<StoreInst>(UserI) &&
5760 cast<StoreInst>(UserI)->getValueOperand() != U.get()))
5761 return true;
5762 if (auto *CB = dyn_cast<CallBase>(UserI)) {
5763 // This check is not guaranteeing uniqueness but for now that we cannot
5764 // end up with two versions of \p U thinking it was one.
5766 if (!Callee || !Callee->hasLocalLinkage())
5767 return true;
5768 if (!CB->isArgOperand(&U))
5769 return false;
5770 const auto *ArgInstanceInfoAA = A.getAAFor<AAInstanceInfo>(
5772 DepClassTy::OPTIONAL);
5773 if (!ArgInstanceInfoAA ||
5774 !ArgInstanceInfoAA->isAssumedUniqueForAnalysis())
5775 return false;
5776 // If this call base might reach the scope again we might forward the
5777 // argument back here. This is very conservative.
5779 A, *CB, *Scope, *this, /* ExclusionSet */ nullptr,
5780 [Scope](const Function &Fn) { return &Fn != Scope; }))
5781 return false;
5782 return true;
5783 }
5784 return false;
5785 };
5786
5787 auto EquivalentUseCB = [&](const Use &OldU, const Use &NewU) {
5788 if (auto *SI = dyn_cast<StoreInst>(OldU.getUser())) {
5789 auto *Ptr = SI->getPointerOperand()->stripPointerCasts();
5790 if ((isa<AllocaInst>(Ptr) || isNoAliasCall(Ptr)) &&
5791 AA::isDynamicallyUnique(A, *this, *Ptr))
5792 return true;
5793 }
5794 return false;
5795 };
5796
5797 if (!A.checkForAllUses(UsePred, *this, V, /* CheckBBLivenessOnly */ true,
5798 DepClassTy::OPTIONAL,
5799 /* IgnoreDroppableUses */ true, EquivalentUseCB))
5800 return indicatePessimisticFixpoint();
5801
5802 return Changed;
5803 }
5804
5805 /// See AbstractState::getAsStr().
5806 const std::string getAsStr(Attributor *A) const override {
5807 return isAssumedUniqueForAnalysis() ? "<unique [fAa]>" : "<unknown>";
5808 }
5809
5810 /// See AbstractAttribute::trackStatistics()
5811 void trackStatistics() const override {}
5812};
5813
5814/// InstanceInfo attribute for floating values.
5815struct AAInstanceInfoFloating : AAInstanceInfoImpl {
5816 AAInstanceInfoFloating(const IRPosition &IRP, Attributor &A)
5817 : AAInstanceInfoImpl(IRP, A) {}
5818};
5819
5820/// NoCapture attribute for function arguments.
5821struct AAInstanceInfoArgument final : AAInstanceInfoFloating {
5822 AAInstanceInfoArgument(const IRPosition &IRP, Attributor &A)
5823 : AAInstanceInfoFloating(IRP, A) {}
5824};
5825
5826/// InstanceInfo attribute for call site arguments.
5827struct AAInstanceInfoCallSiteArgument final : AAInstanceInfoImpl {
5828 AAInstanceInfoCallSiteArgument(const IRPosition &IRP, Attributor &A)
5829 : AAInstanceInfoImpl(IRP, A) {}
5830
5831 /// See AbstractAttribute::updateImpl(...).
5832 ChangeStatus updateImpl(Attributor &A) override {
5833 // TODO: Once we have call site specific value information we can provide
5834 // call site specific liveness information and then it makes
5835 // sense to specialize attributes for call sites arguments instead of
5836 // redirecting requests to the callee argument.
5837 Argument *Arg = getAssociatedArgument();
5838 if (!Arg)
5839 return indicatePessimisticFixpoint();
5840 const IRPosition &ArgPos = IRPosition::argument(*Arg);
5841 auto *ArgAA =
5842 A.getAAFor<AAInstanceInfo>(*this, ArgPos, DepClassTy::REQUIRED);
5843 if (!ArgAA)
5844 return indicatePessimisticFixpoint();
5845 return clampStateAndIndicateChange(getState(), ArgAA->getState());
5846 }
5847};
5848
5849/// InstanceInfo attribute for function return value.
5850struct AAInstanceInfoReturned final : AAInstanceInfoImpl {
5851 AAInstanceInfoReturned(const IRPosition &IRP, Attributor &A)
5852 : AAInstanceInfoImpl(IRP, A) {
5853 llvm_unreachable("InstanceInfo is not applicable to function returns!");
5854 }
5855
5856 /// See AbstractAttribute::initialize(...).
5857 void initialize(Attributor &A) override {
5858 llvm_unreachable("InstanceInfo is not applicable to function returns!");
5859 }
5860
5861 /// See AbstractAttribute::updateImpl(...).
5862 ChangeStatus updateImpl(Attributor &A) override {
5863 llvm_unreachable("InstanceInfo is not applicable to function returns!");
5864 }
5865};
5866
5867/// InstanceInfo attribute deduction for a call site return value.
5868struct AAInstanceInfoCallSiteReturned final : AAInstanceInfoFloating {
5869 AAInstanceInfoCallSiteReturned(const IRPosition &IRP, Attributor &A)
5870 : AAInstanceInfoFloating(IRP, A) {}
5871};
5872} // namespace
5873
5874/// ----------------------- Variable Capturing ---------------------------------
5876 Attribute::AttrKind ImpliedAttributeKind,
5877 bool IgnoreSubsumingPositions) {
5878 assert(ImpliedAttributeKind == Attribute::Captures &&
5879 "Unexpected attribute kind");
5880 Value &V = IRP.getAssociatedValue();
5881 if (!isa<Constant>(V) && !IRP.isArgumentPosition())
5882 return V.use_empty();
5883
5884 // You cannot "capture" null in the default address space.
5885 //
5886 // FIXME: This should use NullPointerIsDefined to account for the function
5887 // attribute.
5889 V.getType()->getPointerAddressSpace() == 0)) {
5890 return true;
5891 }
5892
5894 A.getAttrs(IRP, {Attribute::Captures}, Attrs,
5895 /* IgnoreSubsumingPositions */ true);
5896 for (const Attribute &Attr : Attrs)
5897 if (capturesNothing(Attr.getCaptureInfo()))
5898 return true;
5899
5901 if (Argument *Arg = IRP.getAssociatedArgument()) {
5903 A.getAttrs(IRPosition::argument(*Arg),
5904 {Attribute::Captures, Attribute::ByVal}, Attrs,
5905 /* IgnoreSubsumingPositions */ true);
5906 bool ArgNoCapture = any_of(Attrs, [](Attribute Attr) {
5907 return Attr.getKindAsEnum() == Attribute::ByVal ||
5909 });
5910 if (ArgNoCapture) {
5911 A.manifestAttrs(IRP, Attribute::getWithCaptureInfo(
5912 V.getContext(), CaptureInfo::none()));
5913 return true;
5914 }
5915 }
5916
5917 if (const Function *F = IRP.getAssociatedFunction()) {
5918 // Check what state the associated function can actually capture.
5921 if (State.isKnown(NO_CAPTURE)) {
5922 A.manifestAttrs(IRP, Attribute::getWithCaptureInfo(V.getContext(),
5924 return true;
5925 }
5926 }
5927
5928 return false;
5929}
5930
5931/// Set the NOT_CAPTURED_IN_MEM and NOT_CAPTURED_IN_RET bits in \p Known
5932/// depending on the ability of the function associated with \p IRP to capture
5933/// state in memory and through "returning/throwing", respectively.
5935 const Function &F,
5936 BitIntegerState &State) {
5937 // TODO: Once we have memory behavior attributes we should use them here.
5938
5939 // If we know we cannot communicate or write to memory, we do not care about
5940 // ptr2int anymore.
5941 bool ReadOnly = F.onlyReadsMemory();
5942 bool NoThrow = F.doesNotThrow();
5943 bool IsVoidReturn = F.getReturnType()->isVoidTy();
5944 if (ReadOnly && NoThrow && IsVoidReturn) {
5945 State.addKnownBits(NO_CAPTURE);
5946 return;
5947 }
5948
5949 // A function cannot capture state in memory if it only reads memory, it can
5950 // however return/throw state and the state might be influenced by the
5951 // pointer value, e.g., loading from a returned pointer might reveal a bit.
5952 if (ReadOnly)
5953 State.addKnownBits(NOT_CAPTURED_IN_MEM);
5954
5955 // A function cannot communicate state back if it does not through
5956 // exceptions and doesn not return values.
5957 if (NoThrow && IsVoidReturn)
5958 State.addKnownBits(NOT_CAPTURED_IN_RET);
5959
5960 // Check existing "returned" attributes.
5961 int ArgNo = IRP.getCalleeArgNo();
5962 if (!NoThrow || ArgNo < 0 ||
5963 !F.getAttributes().hasAttrSomewhere(Attribute::Returned))
5964 return;
5965
5966 for (unsigned U = 0, E = F.arg_size(); U < E; ++U)
5967 if (F.hasParamAttribute(U, Attribute::Returned)) {
5968 if (U == unsigned(ArgNo))
5969 State.removeAssumedBits(NOT_CAPTURED_IN_RET);
5970 else if (ReadOnly)
5971 State.addKnownBits(NO_CAPTURE);
5972 else
5973 State.addKnownBits(NOT_CAPTURED_IN_RET);
5974 break;
5975 }
5976}
5977
5978namespace {
5979/// A class to hold the state of for no-capture attributes.
5980struct AANoCaptureImpl : public AANoCapture {
5981 AANoCaptureImpl(const IRPosition &IRP, Attributor &A) : AANoCapture(IRP, A) {}
5982
5983 /// See AbstractAttribute::initialize(...).
5984 void initialize(Attributor &A) override {
5985 bool IsKnown;
5987 A, nullptr, getIRPosition(), DepClassTy::NONE, IsKnown));
5988 (void)IsKnown;
5989 }
5990
5991 /// See AbstractAttribute::updateImpl(...).
5992 ChangeStatus updateImpl(Attributor &A) override;
5993
5994 /// see AbstractAttribute::isAssumedNoCaptureMaybeReturned(...).
5995 void getDeducedAttributes(Attributor &A, LLVMContext &Ctx,
5996 SmallVectorImpl<Attribute> &Attrs) const override {
5997 if (!isAssumedNoCaptureMaybeReturned())
5998 return;
5999
6000 if (isArgumentPosition()) {
6001 if (isAssumedNoCapture())
6002 Attrs.emplace_back(Attribute::get(Ctx, Attribute::Captures));
6003 else if (ManifestInternal)
6004 Attrs.emplace_back(Attribute::get(Ctx, "no-capture-maybe-returned"));
6005 }
6006 }
6007
6008 /// See AbstractState::getAsStr().
6009 const std::string getAsStr(Attributor *A) const override {
6010 if (isKnownNoCapture())
6011 return "known not-captured";
6012 if (isAssumedNoCapture())
6013 return "assumed not-captured";
6014 if (isKnownNoCaptureMaybeReturned())
6015 return "known not-captured-maybe-returned";
6016 if (isAssumedNoCaptureMaybeReturned())
6017 return "assumed not-captured-maybe-returned";
6018 return "assumed-captured";
6019 }
6020
6021 /// Check the use \p U and update \p State accordingly. Return true if we
6022 /// should continue to update the state.
6023 bool checkUse(Attributor &A, AANoCapture::StateType &State, const Use &U,
6024 bool &Follow) {
6025 Instruction *UInst = cast<Instruction>(U.getUser());
6026 LLVM_DEBUG(dbgs() << "[AANoCapture] Check use: " << *U.get() << " in "
6027 << *UInst << "\n");
6028
6029 // Deal with ptr2int by following uses.
6030 if (isa<PtrToIntInst>(UInst)) {
6031 LLVM_DEBUG(dbgs() << " - ptr2int assume the worst!\n");
6032 return isCapturedIn(State, /* Memory */ true, /* Integer */ true,
6033 /* Return */ true);
6034 }
6035
6036 // For stores we already checked if we can follow them, if they make it
6037 // here we give up.
6038 if (isa<StoreInst>(UInst))
6039 return isCapturedIn(State, /* Memory */ true, /* Integer */ true,
6040 /* Return */ true);
6041
6042 // Explicitly catch return instructions.
6043 if (isa<ReturnInst>(UInst)) {
6044 if (UInst->getFunction() == getAnchorScope())
6045 return isCapturedIn(State, /* Memory */ false, /* Integer */ false,
6046 /* Return */ true);
6047 return isCapturedIn(State, /* Memory */ true, /* Integer */ true,
6048 /* Return */ true);
6049 }
6050
6051 // For now we only use special logic for call sites. However, the tracker
6052 // itself knows about a lot of other non-capturing cases already.
6053 auto *CB = dyn_cast<CallBase>(UInst);
6054 if (!CB || !CB->isArgOperand(&U))
6055 return isCapturedIn(State, /* Memory */ true, /* Integer */ true,
6056 /* Return */ true);
6057
6058 unsigned ArgNo = CB->getArgOperandNo(&U);
6059 const IRPosition &CSArgPos = IRPosition::callsite_argument(*CB, ArgNo);
6060 // If we have a abstract no-capture attribute for the argument we can use
6061 // it to justify a non-capture attribute here. This allows recursion!
6062 bool IsKnownNoCapture;
6063 const AANoCapture *ArgNoCaptureAA = nullptr;
6064 bool IsAssumedNoCapture = AA::hasAssumedIRAttr<Attribute::Captures>(
6065 A, this, CSArgPos, DepClassTy::REQUIRED, IsKnownNoCapture, false,
6066 &ArgNoCaptureAA);
6067 if (IsAssumedNoCapture)
6068 return isCapturedIn(State, /* Memory */ false, /* Integer */ false,
6069 /* Return */ false);
6070 if (ArgNoCaptureAA && ArgNoCaptureAA->isAssumedNoCaptureMaybeReturned()) {
6071 Follow = true;
6072 return isCapturedIn(State, /* Memory */ false, /* Integer */ false,
6073 /* Return */ false);
6074 }
6075
6076 // Lastly, we could not find a reason no-capture can be assumed so we don't.
6077 return isCapturedIn(State, /* Memory */ true, /* Integer */ true,
6078 /* Return */ true);
6079 }
6080
6081 /// Update \p State according to \p CapturedInMem, \p CapturedInInt, and
6082 /// \p CapturedInRet, then return true if we should continue updating the
6083 /// state.
6084 static bool isCapturedIn(AANoCapture::StateType &State, bool CapturedInMem,
6085 bool CapturedInInt, bool CapturedInRet) {
6086 LLVM_DEBUG(dbgs() << " - captures [Mem " << CapturedInMem << "|Int "
6087 << CapturedInInt << "|Ret " << CapturedInRet << "]\n");
6088 if (CapturedInMem)
6089 State.removeAssumedBits(AANoCapture::NOT_CAPTURED_IN_MEM);
6090 if (CapturedInInt)
6091 State.removeAssumedBits(AANoCapture::NOT_CAPTURED_IN_INT);
6092 if (CapturedInRet)
6093 State.removeAssumedBits(AANoCapture::NOT_CAPTURED_IN_RET);
6094 return State.isAssumed(AANoCapture::NO_CAPTURE_MAYBE_RETURNED);
6095 }
6096};
6097
6098ChangeStatus AANoCaptureImpl::updateImpl(Attributor &A) {
6099 const IRPosition &IRP = getIRPosition();
6100 Value *V = isArgumentPosition() ? IRP.getAssociatedArgument()
6101 : &IRP.getAssociatedValue();
6102 if (!V)
6103 return indicatePessimisticFixpoint();
6104
6105 const Function *F =
6106 isArgumentPosition() ? IRP.getAssociatedFunction() : IRP.getAnchorScope();
6107
6108 // TODO: Is the checkForAllUses below useful for constants?
6109 if (!F)
6110 return indicatePessimisticFixpoint();
6111
6113 const IRPosition &FnPos = IRPosition::function(*F);
6114
6115 // Readonly means we cannot capture through memory.
6116 bool IsKnown;
6117 if (AA::isAssumedReadOnly(A, FnPos, *this, IsKnown)) {
6118 T.addKnownBits(NOT_CAPTURED_IN_MEM);
6119 if (IsKnown)
6120 addKnownBits(NOT_CAPTURED_IN_MEM);
6121 }
6122
6123 // Make sure all returned values are different than the underlying value.
6124 // TODO: we could do this in a more sophisticated way inside
6125 // AAReturnedValues, e.g., track all values that escape through returns
6126 // directly somehow.
6127 auto CheckReturnedArgs = [&](bool &UsedAssumedInformation) {
6129 if (!A.getAssumedSimplifiedValues(IRPosition::returned(*F), this, Values,
6131 UsedAssumedInformation))
6132 return false;
6133 bool SeenConstant = false;
6134 for (const AA::ValueAndContext &VAC : Values) {
6135 if (isa<Constant>(VAC.getValue())) {
6136 if (SeenConstant)
6137 return false;
6138 SeenConstant = true;
6139 } else if (!isa<Argument>(VAC.getValue()) ||
6140 VAC.getValue() == getAssociatedArgument())
6141 return false;
6142 }
6143 return true;
6144 };
6145
6146 bool IsKnownNoUnwind;
6148 A, this, FnPos, DepClassTy::OPTIONAL, IsKnownNoUnwind)) {
6149 bool IsVoidTy = F->getReturnType()->isVoidTy();
6150 bool UsedAssumedInformation = false;
6151 if (IsVoidTy || CheckReturnedArgs(UsedAssumedInformation)) {
6152 T.addKnownBits(NOT_CAPTURED_IN_RET);
6153 if (T.isKnown(NOT_CAPTURED_IN_MEM))
6155 if (IsKnownNoUnwind && (IsVoidTy || !UsedAssumedInformation)) {
6156 addKnownBits(NOT_CAPTURED_IN_RET);
6157 if (isKnown(NOT_CAPTURED_IN_MEM))
6158 return indicateOptimisticFixpoint();
6159 }
6160 }
6161 }
6162
6163 auto UseCheck = [&](const Use &U, bool &Follow) -> bool {
6164 // TODO(captures): Make this more precise.
6165 UseCaptureInfo CI = DetermineUseCaptureKind(U, /*Base=*/nullptr);
6166 if (capturesNothing(CI))
6167 return true;
6168 if (CI.isPassthrough()) {
6169 Follow = true;
6170 return true;
6171 }
6172 return checkUse(A, T, U, Follow);
6173 };
6174
6175 if (!A.checkForAllUses(UseCheck, *this, *V))
6176 return indicatePessimisticFixpoint();
6177
6178 AANoCapture::StateType &S = getState();
6179 auto Assumed = S.getAssumed();
6180 S.intersectAssumedBits(T.getAssumed());
6181 if (!isAssumedNoCaptureMaybeReturned())
6182 return indicatePessimisticFixpoint();
6183 return Assumed == S.getAssumed() ? ChangeStatus::UNCHANGED
6185}
6186
6187/// NoCapture attribute for function arguments.
6188struct AANoCaptureArgument final : AANoCaptureImpl {
6189 AANoCaptureArgument(const IRPosition &IRP, Attributor &A)
6190 : AANoCaptureImpl(IRP, A) {}
6191
6192 /// See AbstractAttribute::trackStatistics()
6193 void trackStatistics() const override { STATS_DECLTRACK_ARG_ATTR(nocapture) }
6194};
6195
6196/// NoCapture attribute for call site arguments.
6197struct AANoCaptureCallSiteArgument final : AANoCaptureImpl {
6198 AANoCaptureCallSiteArgument(const IRPosition &IRP, Attributor &A)
6199 : AANoCaptureImpl(IRP, A) {}
6200
6201 /// See AbstractAttribute::updateImpl(...).
6202 ChangeStatus updateImpl(Attributor &A) override {
6203 // TODO: Once we have call site specific value information we can provide
6204 // call site specific liveness information and then it makes
6205 // sense to specialize attributes for call sites arguments instead of
6206 // redirecting requests to the callee argument.
6207 Argument *Arg = getAssociatedArgument();
6208 if (!Arg)
6209 return indicatePessimisticFixpoint();
6210 const IRPosition &ArgPos = IRPosition::argument(*Arg);
6211 bool IsKnownNoCapture;
6212 const AANoCapture *ArgAA = nullptr;
6214 A, this, ArgPos, DepClassTy::REQUIRED, IsKnownNoCapture, false,
6215 &ArgAA))
6216 return ChangeStatus::UNCHANGED;
6217 if (!ArgAA || !ArgAA->isAssumedNoCaptureMaybeReturned())
6218 return indicatePessimisticFixpoint();
6219 return clampStateAndIndicateChange(getState(), ArgAA->getState());
6220 }
6221
6222 /// See AbstractAttribute::trackStatistics()
6223 void trackStatistics() const override {
6225 };
6226};
6227
6228/// NoCapture attribute for floating values.
6229struct AANoCaptureFloating final : AANoCaptureImpl {
6230 AANoCaptureFloating(const IRPosition &IRP, Attributor &A)
6231 : AANoCaptureImpl(IRP, A) {}
6232
6233 /// See AbstractAttribute::trackStatistics()
6234 void trackStatistics() const override {
6236 }
6237};
6238
6239/// NoCapture attribute for function return value.
6240struct AANoCaptureReturned final : AANoCaptureImpl {
6241 AANoCaptureReturned(const IRPosition &IRP, Attributor &A)
6242 : AANoCaptureImpl(IRP, A) {
6243 llvm_unreachable("NoCapture is not applicable to function returns!");
6244 }
6245
6246 /// See AbstractAttribute::initialize(...).
6247 void initialize(Attributor &A) override {
6248 llvm_unreachable("NoCapture is not applicable to function returns!");
6249 }
6250
6251 /// See AbstractAttribute::updateImpl(...).
6252 ChangeStatus updateImpl(Attributor &A) override {
6253 llvm_unreachable("NoCapture is not applicable to function returns!");
6254 }
6255
6256 /// See AbstractAttribute::trackStatistics()
6257 void trackStatistics() const override {}
6258};
6259
6260/// NoCapture attribute deduction for a call site return value.
6261struct AANoCaptureCallSiteReturned final : AANoCaptureImpl {
6262 AANoCaptureCallSiteReturned(const IRPosition &IRP, Attributor &A)
6263 : AANoCaptureImpl(IRP, A) {}
6264
6265 /// See AbstractAttribute::initialize(...).
6266 void initialize(Attributor &A) override {
6267 const Function *F = getAnchorScope();
6268 // Check what state the associated function can actually capture.
6269 determineFunctionCaptureCapabilities(getIRPosition(), *F, *this);
6270 }
6271
6272 /// See AbstractAttribute::trackStatistics()
6273 void trackStatistics() const override {
6275 }
6276};
6277} // namespace
6278
6279/// ------------------ Value Simplify Attribute ----------------------------
6280
6281bool ValueSimplifyStateType::unionAssumed(std::optional<Value *> Other) {
6282 // FIXME: Add a typecast support.
6285 if (SimplifiedAssociatedValue == std::optional<Value *>(nullptr))
6286 return false;
6287
6288 LLVM_DEBUG({
6290 dbgs() << "[ValueSimplify] is assumed to be "
6291 << **SimplifiedAssociatedValue << "\n";
6292 else
6293 dbgs() << "[ValueSimplify] is assumed to be <none>\n";
6294 });
6295 return true;
6296}
6297
6298namespace {
6299struct AAValueSimplifyImpl : AAValueSimplify {
6300 AAValueSimplifyImpl(const IRPosition &IRP, Attributor &A)
6301 : AAValueSimplify(IRP, A) {}
6302
6303 /// See AbstractAttribute::initialize(...).
6304 void initialize(Attributor &A) override {
6305 if (getAssociatedValue().getType()->isVoidTy())
6306 indicatePessimisticFixpoint();
6307 if (A.hasSimplificationCallback(getIRPosition()))
6308 indicatePessimisticFixpoint();
6309 }
6310
6311 /// See AbstractAttribute::getAsStr().
6312 const std::string getAsStr(Attributor *A) const override {
6313 LLVM_DEBUG({
6314 dbgs() << "SAV: " << (bool)SimplifiedAssociatedValue << " ";
6315 if (SimplifiedAssociatedValue && *SimplifiedAssociatedValue)
6316 dbgs() << "SAV: " << **SimplifiedAssociatedValue << " ";
6317 });
6318 return isValidState() ? (isAtFixpoint() ? "simplified" : "maybe-simple")
6319 : "not-simple";
6320 }
6321
6322 /// See AbstractAttribute::trackStatistics()
6323 void trackStatistics() const override {}
6324
6325 /// See AAValueSimplify::getAssumedSimplifiedValue()
6326 std::optional<Value *>
6327 getAssumedSimplifiedValue(Attributor &A) const override {
6328 return SimplifiedAssociatedValue;
6329 }
6330
6331 /// Ensure the return value is \p V with type \p Ty, if not possible return
6332 /// nullptr. If \p Check is true we will only verify such an operation would
6333 /// suceed and return a non-nullptr value if that is the case. No IR is
6334 /// generated or modified.
6335 static Value *ensureType(Attributor &A, Value &V, Type &Ty, Instruction *CtxI,
6336 bool Check) {
6337 if (auto *TypedV = AA::getWithType(V, Ty))
6338 return TypedV;
6339 if (CtxI && V.getType()->canLosslesslyBitCastTo(&Ty))
6340 return Check ? &V
6341 : BitCastInst::CreatePointerBitCastOrAddrSpaceCast(
6342 &V, &Ty, "", CtxI->getIterator());
6343 return nullptr;
6344 }
6345
6346 /// Reproduce \p I with type \p Ty or return nullptr if that is not posisble.
6347 /// If \p Check is true we will only verify such an operation would suceed and
6348 /// return a non-nullptr value if that is the case. No IR is generated or
6349 /// modified.
6350 static Value *reproduceInst(Attributor &A,
6351 const AbstractAttribute &QueryingAA,
6352 Instruction &I, Type &Ty, Instruction *CtxI,
6353 bool Check, ValueToValueMapTy &VMap) {
6354 assert(CtxI && "Cannot reproduce an instruction without context!");
6355 if (Check && (I.mayReadFromMemory() ||
6356 !isSafeToSpeculativelyExecute(&I, CtxI, /* DT */ nullptr,
6357 /* TLI */ nullptr)))
6358 return nullptr;
6359 for (Value *Op : I.operands()) {
6360 Value *NewOp = reproduceValue(A, QueryingAA, *Op, Ty, CtxI, Check, VMap);
6361 if (!NewOp) {
6362 assert(Check && "Manifest of new value unexpectedly failed!");
6363 return nullptr;
6364 }
6365 if (!Check)
6366 VMap[Op] = NewOp;
6367 }
6368 if (Check)
6369 return &I;
6370
6371 Instruction *CloneI = I.clone();
6372 // TODO: Try to salvage debug information here.
6373 CloneI->setDebugLoc(DebugLoc());
6374 VMap[&I] = CloneI;
6375 CloneI->insertBefore(CtxI->getIterator());
6376 RemapInstruction(CloneI, VMap);
6377 return CloneI;
6378 }
6379
6380 /// Reproduce \p V with type \p Ty or return nullptr if that is not posisble.
6381 /// If \p Check is true we will only verify such an operation would suceed and
6382 /// return a non-nullptr value if that is the case. No IR is generated or
6383 /// modified.
6384 static Value *reproduceValue(Attributor &A,
6385 const AbstractAttribute &QueryingAA, Value &V,
6386 Type &Ty, Instruction *CtxI, bool Check,
6387 ValueToValueMapTy &VMap) {
6388 if (const auto &NewV = VMap.lookup(&V))
6389 return NewV;
6390 bool UsedAssumedInformation = false;
6391 std::optional<Value *> SimpleV = A.getAssumedSimplified(
6392 V, QueryingAA, UsedAssumedInformation, AA::Interprocedural);
6393 if (!SimpleV.has_value())
6394 return PoisonValue::get(&Ty);
6395 Value *EffectiveV = &V;
6396 if (*SimpleV)
6397 EffectiveV = *SimpleV;
6398 if (auto *C = dyn_cast<Constant>(EffectiveV))
6399 return C;
6400 if (CtxI && AA::isValidAtPosition(AA::ValueAndContext(*EffectiveV, *CtxI),
6401 A.getInfoCache()))
6402 return ensureType(A, *EffectiveV, Ty, CtxI, Check);
6403 if (auto *I = dyn_cast<Instruction>(EffectiveV))
6404 if (Value *NewV = reproduceInst(A, QueryingAA, *I, Ty, CtxI, Check, VMap))
6405 return ensureType(A, *NewV, Ty, CtxI, Check);
6406 return nullptr;
6407 }
6408
6409 /// Return a value we can use as replacement for the associated one, or
6410 /// nullptr if we don't have one that makes sense.
6411 Value *manifestReplacementValue(Attributor &A, Instruction *CtxI) const {
6412 Value *NewV = SimplifiedAssociatedValue
6413 ? *SimplifiedAssociatedValue
6414 : UndefValue::get(getAssociatedType());
6415 if (NewV && NewV != &getAssociatedValue()) {
6416 ValueToValueMapTy VMap;
6417 // First verify we can reprduce the value with the required type at the
6418 // context location before we actually start modifying the IR.
6419 if (reproduceValue(A, *this, *NewV, *getAssociatedType(), CtxI,
6420 /* CheckOnly */ true, VMap))
6421 return reproduceValue(A, *this, *NewV, *getAssociatedType(), CtxI,
6422 /* CheckOnly */ false, VMap);
6423 }
6424 return nullptr;
6425 }
6426
6427 /// Helper function for querying AAValueSimplify and updating candidate.
6428 /// \param IRP The value position we are trying to unify with SimplifiedValue
6429 bool checkAndUpdate(Attributor &A, const AbstractAttribute &QueryingAA,
6430 const IRPosition &IRP, bool Simplify = true) {
6431 bool UsedAssumedInformation = false;
6432 std::optional<Value *> QueryingValueSimplified = &IRP.getAssociatedValue();
6433 if (Simplify)
6434 QueryingValueSimplified = A.getAssumedSimplified(
6435 IRP, QueryingAA, UsedAssumedInformation, AA::Interprocedural);
6436 return unionAssumed(QueryingValueSimplified);
6437 }
6438
6439 /// Returns a candidate is found or not
6440 template <typename AAType> bool askSimplifiedValueFor(Attributor &A) {
6441 if (!getAssociatedValue().getType()->isIntegerTy())
6442 return false;
6443
6444 // This will also pass the call base context.
6445 const auto *AA =
6446 A.getAAFor<AAType>(*this, getIRPosition(), DepClassTy::NONE);
6447 if (!AA)
6448 return false;
6449
6450 std::optional<Constant *> COpt = AA->getAssumedConstant(A);
6451
6452 if (!COpt) {
6453 SimplifiedAssociatedValue = std::nullopt;
6454 A.recordDependence(*AA, *this, DepClassTy::OPTIONAL);
6455 return true;
6456 }
6457 if (auto *C = *COpt) {
6458 SimplifiedAssociatedValue = C;
6459 A.recordDependence(*AA, *this, DepClassTy::OPTIONAL);
6460 return true;
6461 }
6462 return false;
6463 }
6464
6465 bool askSimplifiedValueForOtherAAs(Attributor &A) {
6466 if (askSimplifiedValueFor<AAValueConstantRange>(A))
6467 return true;
6468 if (askSimplifiedValueFor<AAPotentialConstantValues>(A))
6469 return true;
6470 return false;
6471 }
6472
6473 /// See AbstractAttribute::manifest(...).
6474 ChangeStatus manifest(Attributor &A) override {
6475 ChangeStatus Changed = ChangeStatus::UNCHANGED;
6476 for (auto &U : getAssociatedValue().uses()) {
6477 // Check if we need to adjust the insertion point to make sure the IR is
6478 // valid.
6479 Instruction *IP = dyn_cast<Instruction>(U.getUser());
6480 if (auto *PHI = dyn_cast_or_null<PHINode>(IP))
6481 IP = PHI->getIncomingBlock(U)->getTerminator();
6482 if (auto *NewV = manifestReplacementValue(A, IP)) {
6483 LLVM_DEBUG(dbgs() << "[ValueSimplify] " << getAssociatedValue()
6484 << " -> " << *NewV << " :: " << *this << "\n");
6485 if (A.changeUseAfterManifest(U, *NewV))
6486 Changed = ChangeStatus::CHANGED;
6487 }
6488 }
6489
6490 return Changed | AAValueSimplify::manifest(A);
6491 }
6492
6493 /// See AbstractState::indicatePessimisticFixpoint(...).
6494 ChangeStatus indicatePessimisticFixpoint() override {
6495 SimplifiedAssociatedValue = &getAssociatedValue();
6496 return AAValueSimplify::indicatePessimisticFixpoint();
6497 }
6498};
6499
6500struct AAValueSimplifyArgument final : AAValueSimplifyImpl {
6501 AAValueSimplifyArgument(const IRPosition &IRP, Attributor &A)
6502 : AAValueSimplifyImpl(IRP, A) {}
6503
6504 void initialize(Attributor &A) override {
6505 AAValueSimplifyImpl::initialize(A);
6506 if (A.hasAttr(getIRPosition(),
6507 {Attribute::InAlloca, Attribute::Preallocated,
6508 Attribute::StructRet, Attribute::Nest, Attribute::ByVal},
6509 /* IgnoreSubsumingPositions */ true))
6510 indicatePessimisticFixpoint();
6511 }
6512
6513 /// See AbstractAttribute::updateImpl(...).
6514 ChangeStatus updateImpl(Attributor &A) override {
6515 // Byval is only replacable if it is readonly otherwise we would write into
6516 // the replaced value and not the copy that byval creates implicitly.
6517 Argument *Arg = getAssociatedArgument();
6518 if (Arg->hasByValAttr()) {
6519 // TODO: We probably need to verify synchronization is not an issue, e.g.,
6520 // there is no race by not copying a constant byval.
6521 bool IsKnown;
6522 if (!AA::isAssumedReadOnly(A, getIRPosition(), *this, IsKnown))
6523 return indicatePessimisticFixpoint();
6524 }
6525
6526 auto Before = SimplifiedAssociatedValue;
6527
6528 auto PredForCallSite = [&](AbstractCallSite ACS) {
6529 const IRPosition &ACSArgPos =
6530 IRPosition::callsite_argument(ACS, getCallSiteArgNo());
6531 // Check if a coresponding argument was found or if it is on not
6532 // associated (which can happen for callback calls).
6533 if (ACSArgPos.getPositionKind() == IRPosition::IRP_INVALID)
6534 return false;
6535
6536 // Simplify the argument operand explicitly and check if the result is
6537 // valid in the current scope. This avoids refering to simplified values
6538 // in other functions, e.g., we don't want to say a an argument in a
6539 // static function is actually an argument in a different function.
6540 bool UsedAssumedInformation = false;
6541 std::optional<Constant *> SimpleArgOp =
6542 A.getAssumedConstant(ACSArgPos, *this, UsedAssumedInformation);
6543 if (!SimpleArgOp)
6544 return true;
6545 if (!*SimpleArgOp)
6546 return false;
6547 if (!AA::isDynamicallyUnique(A, *this, **SimpleArgOp))
6548 return false;
6549 return unionAssumed(*SimpleArgOp);
6550 };
6551
6552 // Generate a answer specific to a call site context.
6553 bool Success;
6554 bool UsedAssumedInformation = false;
6555 if (hasCallBaseContext() &&
6556 getCallBaseContext()->getCalledOperand() == Arg->getParent())
6557 Success = PredForCallSite(
6558 AbstractCallSite(&getCallBaseContext()->getCalledOperandUse()));
6559 else
6560 Success = A.checkForAllCallSites(PredForCallSite, *this, true,
6561 UsedAssumedInformation);
6562
6563 if (!Success)
6564 if (!askSimplifiedValueForOtherAAs(A))
6565 return indicatePessimisticFixpoint();
6566
6567 // If a candidate was found in this update, return CHANGED.
6568 return Before == SimplifiedAssociatedValue ? ChangeStatus::UNCHANGED
6569 : ChangeStatus ::CHANGED;
6570 }
6571
6572 /// See AbstractAttribute::trackStatistics()
6573 void trackStatistics() const override {
6574 STATS_DECLTRACK_ARG_ATTR(value_simplify)
6575 }
6576};
6577
6578struct AAValueSimplifyReturned : AAValueSimplifyImpl {
6579 AAValueSimplifyReturned(const IRPosition &IRP, Attributor &A)
6580 : AAValueSimplifyImpl(IRP, A) {}
6581
6582 /// See AAValueSimplify::getAssumedSimplifiedValue()
6583 std::optional<Value *>
6584 getAssumedSimplifiedValue(Attributor &A) const override {
6585 if (!isValidState())
6586 return nullptr;
6587 return SimplifiedAssociatedValue;
6588 }
6589
6590 /// See AbstractAttribute::updateImpl(...).
6591 ChangeStatus updateImpl(Attributor &A) override {
6592 auto Before = SimplifiedAssociatedValue;
6593
6594 auto ReturnInstCB = [&](Instruction &I) {
6595 auto &RI = cast<ReturnInst>(I);
6596 return checkAndUpdate(
6597 A, *this,
6598 IRPosition::value(*RI.getReturnValue(), getCallBaseContext()));
6599 };
6600
6601 bool UsedAssumedInformation = false;
6602 if (!A.checkForAllInstructions(ReturnInstCB, *this, {Instruction::Ret},
6603 UsedAssumedInformation))
6604 if (!askSimplifiedValueForOtherAAs(A))
6605 return indicatePessimisticFixpoint();
6606
6607 // If a candidate was found in this update, return CHANGED.
6608 return Before == SimplifiedAssociatedValue ? ChangeStatus::UNCHANGED
6609 : ChangeStatus ::CHANGED;
6610 }
6611
6612 ChangeStatus manifest(Attributor &A) override {
6613 // We queried AAValueSimplify for the returned values so they will be
6614 // replaced if a simplified form was found. Nothing to do here.
6615 return ChangeStatus::UNCHANGED;
6616 }
6617
6618 /// See AbstractAttribute::trackStatistics()
6619 void trackStatistics() const override {
6620 STATS_DECLTRACK_FNRET_ATTR(value_simplify)
6621 }
6622};
6623
6624struct AAValueSimplifyFloating : AAValueSimplifyImpl {
6625 AAValueSimplifyFloating(const IRPosition &IRP, Attributor &A)
6626 : AAValueSimplifyImpl(IRP, A) {}
6627
6628 /// See AbstractAttribute::initialize(...).
6629 void initialize(Attributor &A) override {
6630 AAValueSimplifyImpl::initialize(A);
6631 Value &V = getAnchorValue();
6632
6633 // TODO: add other stuffs
6634 if (isa<Constant>(V))
6635 indicatePessimisticFixpoint();
6636 }
6637
6638 /// See AbstractAttribute::updateImpl(...).
6639 ChangeStatus updateImpl(Attributor &A) override {
6640 auto Before = SimplifiedAssociatedValue;
6641 if (!askSimplifiedValueForOtherAAs(A))
6642 return indicatePessimisticFixpoint();
6643
6644 // If a candidate was found in this update, return CHANGED.
6645 return Before == SimplifiedAssociatedValue ? ChangeStatus::UNCHANGED
6646 : ChangeStatus ::CHANGED;
6647 }
6648
6649 /// See AbstractAttribute::trackStatistics()
6650 void trackStatistics() const override {
6651 STATS_DECLTRACK_FLOATING_ATTR(value_simplify)
6652 }
6653};
6654
6655struct AAValueSimplifyFunction : AAValueSimplifyImpl {
6656 AAValueSimplifyFunction(const IRPosition &IRP, Attributor &A)
6657 : AAValueSimplifyImpl(IRP, A) {}
6658
6659 /// See AbstractAttribute::initialize(...).
6660 void initialize(Attributor &A) override {
6661 SimplifiedAssociatedValue = nullptr;
6662 indicateOptimisticFixpoint();
6663 }
6664 /// See AbstractAttribute::initialize(...).
6665 ChangeStatus updateImpl(Attributor &A) override {
6667 "AAValueSimplify(Function|CallSite)::updateImpl will not be called");
6668 }
6669 /// See AbstractAttribute::trackStatistics()
6670 void trackStatistics() const override {
6671 STATS_DECLTRACK_FN_ATTR(value_simplify)
6672 }
6673};
6674
6675struct AAValueSimplifyCallSite : AAValueSimplifyFunction {
6676 AAValueSimplifyCallSite(const IRPosition &IRP, Attributor &A)
6677 : AAValueSimplifyFunction(IRP, A) {}
6678 /// See AbstractAttribute::trackStatistics()
6679 void trackStatistics() const override {
6680 STATS_DECLTRACK_CS_ATTR(value_simplify)
6681 }
6682};
6683
6684struct AAValueSimplifyCallSiteReturned : AAValueSimplifyImpl {
6685 AAValueSimplifyCallSiteReturned(const IRPosition &IRP, Attributor &A)
6686 : AAValueSimplifyImpl(IRP, A) {}
6687
6688 void initialize(Attributor &A) override {
6689 AAValueSimplifyImpl::initialize(A);
6690 Function *Fn = getAssociatedFunction();
6691 assert(Fn && "Did expect an associted function");
6692 for (Argument &Arg : Fn->args()) {
6693 if (Arg.hasReturnedAttr()) {
6694 auto IRP = IRPosition::callsite_argument(*cast<CallBase>(getCtxI()),
6695 Arg.getArgNo());
6697 checkAndUpdate(A, *this, IRP))
6698 indicateOptimisticFixpoint();
6699 else
6700 indicatePessimisticFixpoint();
6701 return;
6702 }
6703 }
6704 }
6705
6706 /// See AbstractAttribute::updateImpl(...).
6707 ChangeStatus updateImpl(Attributor &A) override {
6708 return indicatePessimisticFixpoint();
6709 }
6710
6711 void trackStatistics() const override {
6712 STATS_DECLTRACK_CSRET_ATTR(value_simplify)
6713 }
6714};
6715
6716struct AAValueSimplifyCallSiteArgument : AAValueSimplifyFloating {
6717 AAValueSimplifyCallSiteArgument(const IRPosition &IRP, Attributor &A)
6718 : AAValueSimplifyFloating(IRP, A) {}
6719
6720 /// See AbstractAttribute::manifest(...).
6721 ChangeStatus manifest(Attributor &A) override {
6722 ChangeStatus Changed = ChangeStatus::UNCHANGED;
6723 // TODO: We should avoid simplification duplication to begin with.
6724 auto *FloatAA = A.lookupAAFor<AAValueSimplify>(
6725 IRPosition::value(getAssociatedValue()), this, DepClassTy::NONE);
6726 if (FloatAA && FloatAA->getState().isValidState())
6727 return Changed;
6728
6729 if (auto *NewV = manifestReplacementValue(A, getCtxI())) {
6730 Use &U = cast<CallBase>(&getAnchorValue())
6731 ->getArgOperandUse(getCallSiteArgNo());
6732 if (A.changeUseAfterManifest(U, *NewV))
6733 Changed = ChangeStatus::CHANGED;
6734 }
6735
6736 return Changed | AAValueSimplify::manifest(A);
6737 }
6738
6739 void trackStatistics() const override {
6740 STATS_DECLTRACK_CSARG_ATTR(value_simplify)
6741 }
6742};
6743} // namespace
6744
6745/// ----------------------- Heap-To-Stack Conversion ---------------------------
6746namespace {
6747struct AAHeapToStackFunction final : public AAHeapToStack {
6748
6749 static bool isGlobalizedLocal(const CallBase &CB) {
6750 Attribute A = CB.getFnAttr("alloc-family");
6751 return A.isValid() && A.getValueAsString() == "__kmpc_alloc_shared";
6752 }
6753
6754 struct AllocationInfo {
6755 /// The call that allocates the memory.
6756 CallBase *const CB;
6757
6758 /// Whether this allocation is an OpenMP globalized local variable.
6759 bool IsGlobalizedLocal = false;
6760
6761 /// The status wrt. a rewrite.
6762 enum {
6763 STACK_DUE_TO_USE,
6764 STACK_DUE_TO_FREE,
6765 INVALID,
6766 } Status = STACK_DUE_TO_USE;
6767
6768 /// Flag to indicate if we encountered a use that might free this allocation
6769 /// but which is not in the deallocation infos.
6770 bool HasPotentiallyFreeingUnknownUses = false;
6771
6772 /// Flag to indicate that we should place the new alloca in the function
6773 /// entry block rather than where the call site (CB) is.
6774 bool MoveAllocaIntoEntry = true;
6775
6776 /// The set of free calls that use this allocation.
6777 SmallSetVector<CallBase *, 1> PotentialFreeCalls{};
6778 };
6779
6780 struct DeallocationInfo {
6781 /// The call that deallocates the memory.
6782 CallBase *const CB;
6783 /// The value freed by the call.
6784 Value *FreedOp;
6785
6786 /// Flag to indicate if we don't know all objects this deallocation might
6787 /// free.
6788 bool MightFreeUnknownObjects = false;
6789
6790 /// The set of allocation calls that are potentially freed.
6791 SmallSetVector<CallBase *, 1> PotentialAllocationCalls{};
6792 };
6793
6794 AAHeapToStackFunction(const IRPosition &IRP, Attributor &A)
6795 : AAHeapToStack(IRP, A) {}
6796
6797 ~AAHeapToStackFunction() override {
6798 // Ensure we call the destructor so we release any memory allocated in the
6799 // sets.
6800 for (auto &It : AllocationInfos)
6801 It.second->~AllocationInfo();
6802 for (auto &It : DeallocationInfos)
6803 It.second->~DeallocationInfo();
6804 }
6805
6806 void initialize(Attributor &A) override {
6807 AAHeapToStack::initialize(A);
6808
6809 const Function *F = getAnchorScope();
6810 const auto *TLI = A.getInfoCache().getTargetLibraryInfoForFunction(*F);
6811
6812 auto AllocationIdentifierCB = [&](Instruction &I) {
6813 CallBase *CB = dyn_cast<CallBase>(&I);
6814 if (!CB)
6815 return true;
6816 if (Value *FreedOp = getFreedOperand(CB, TLI)) {
6817 DeallocationInfos[CB] = new (A.Allocator) DeallocationInfo{CB, FreedOp};
6818 return true;
6819 }
6820 // To do heap to stack, we need to know that the allocation itself is
6821 // removable once uses are rewritten, and that we can initialize the
6822 // alloca to the same pattern as the original allocation result.
6823 if (isRemovableAlloc(CB, TLI)) {
6824 auto *I8Ty = Type::getInt8Ty(CB->getParent()->getContext());
6825 if (nullptr != getInitialValueOfAllocation(CB, TLI, I8Ty)) {
6826 AllocationInfo *AI = new (A.Allocator) AllocationInfo{CB};
6827 AllocationInfos[CB] = AI;
6828 AI->IsGlobalizedLocal = isGlobalizedLocal(*CB);
6829 }
6830 }
6831 return true;
6832 };
6833
6834 bool UsedAssumedInformation = false;
6835 bool Success = A.checkForAllCallLikeInstructions(
6836 AllocationIdentifierCB, *this, UsedAssumedInformation,
6837 /* CheckBBLivenessOnly */ false,
6838 /* CheckPotentiallyDead */ true);
6839 (void)Success;
6840 assert(Success && "Did not expect the call base visit callback to fail!");
6841
6843 [](const IRPosition &, const AbstractAttribute *,
6844 bool &) -> std::optional<Value *> { return nullptr; };
6845 for (const auto &It : AllocationInfos)
6846 A.registerSimplificationCallback(IRPosition::callsite_returned(*It.first),
6847 SCB);
6848 for (const auto &It : DeallocationInfos)
6849 A.registerSimplificationCallback(IRPosition::callsite_returned(*It.first),
6850 SCB);
6851 }
6852
6853 const std::string getAsStr(Attributor *A) const override {
6854 unsigned NumH2SMallocs = 0, NumInvalidMallocs = 0;
6855 for (const auto &It : AllocationInfos) {
6856 if (It.second->Status == AllocationInfo::INVALID)
6857 ++NumInvalidMallocs;
6858 else
6859 ++NumH2SMallocs;
6860 }
6861 return "[H2S] Mallocs Good/Bad: " + std::to_string(NumH2SMallocs) + "/" +
6862 std::to_string(NumInvalidMallocs);
6863 }
6864
6865 /// See AbstractAttribute::trackStatistics().
6866 void trackStatistics() const override {
6867 STATS_DECL(
6868 MallocCalls, Function,
6869 "Number of malloc/calloc/aligned_alloc calls converted to allocas");
6870 for (const auto &It : AllocationInfos)
6871 if (It.second->Status != AllocationInfo::INVALID)
6872 ++BUILD_STAT_NAME(MallocCalls, Function);
6873 }
6874
6875 bool isAssumedHeapToStack(const CallBase &CB) const override {
6876 if (isValidState())
6877 if (AllocationInfo *AI =
6878 AllocationInfos.lookup(const_cast<CallBase *>(&CB)))
6879 return AI->Status != AllocationInfo::INVALID;
6880 return false;
6881 }
6882
6883 bool isAssumedHeapToStackRemovedFree(CallBase &CB) const override {
6884 if (!isValidState())
6885 return false;
6886
6887 for (const auto &It : AllocationInfos) {
6888 AllocationInfo &AI = *It.second;
6889 if (AI.Status == AllocationInfo::INVALID)
6890 continue;
6891
6892 if (AI.PotentialFreeCalls.count(&CB))
6893 return true;
6894 }
6895
6896 return false;
6897 }
6898
6899 ChangeStatus manifest(Attributor &A) override {
6900 assert(getState().isValidState() &&
6901 "Attempted to manifest an invalid state!");
6902
6903 ChangeStatus HasChanged = ChangeStatus::UNCHANGED;
6904 Function *F = getAnchorScope();
6905 const auto *TLI = A.getInfoCache().getTargetLibraryInfoForFunction(*F);
6906
6907 for (auto &It : AllocationInfos) {
6908 AllocationInfo &AI = *It.second;
6909 if (AI.Status == AllocationInfo::INVALID)
6910 continue;
6911
6912 for (CallBase *FreeCall : AI.PotentialFreeCalls) {
6913 LLVM_DEBUG(dbgs() << "H2S: Removing free call: " << *FreeCall << "\n");
6914 A.deleteAfterManifest(*FreeCall);
6915 HasChanged = ChangeStatus::CHANGED;
6916 }
6917
6918 LLVM_DEBUG(dbgs() << "H2S: Removing malloc-like call: " << *AI.CB
6919 << "\n");
6920
6921 auto Remark = [&](OptimizationRemark OR) {
6922 if (AI.IsGlobalizedLocal)
6923 return OR << "Moving globalized variable to the stack.";
6924 return OR << "Moving memory allocation from the heap to the stack.";
6925 };
6926 if (AI.IsGlobalizedLocal)
6927 A.emitRemark<OptimizationRemark>(AI.CB, "OMP110", Remark);
6928 else
6929 A.emitRemark<OptimizationRemark>(AI.CB, "HeapToStack", Remark);
6930
6931 const DataLayout &DL = A.getInfoCache().getDL();
6932 Value *Size;
6933 std::optional<APInt> SizeAPI = getSize(A, *this, AI);
6934 if (SizeAPI) {
6935 Size = ConstantInt::get(AI.CB->getContext(), *SizeAPI);
6936 } else {
6937 LLVMContext &Ctx = AI.CB->getContext();
6938 ObjectSizeOpts Opts;
6939 ObjectSizeOffsetEvaluator Eval(DL, TLI, Ctx, Opts);
6940 SizeOffsetValue SizeOffsetPair = Eval.compute(AI.CB);
6941 assert(SizeOffsetPair != ObjectSizeOffsetEvaluator::unknown() &&
6942 cast<ConstantInt>(SizeOffsetPair.Offset)->isZero());
6943 Size = SizeOffsetPair.Size;
6944 }
6945
6946 BasicBlock::iterator IP = AI.MoveAllocaIntoEntry
6947 ? F->getEntryBlock().begin()
6948 : AI.CB->getIterator();
6949
6950 Align Alignment(1);
6951 if (MaybeAlign RetAlign = AI.CB->getRetAlign())
6952 Alignment = std::max(Alignment, *RetAlign);
6953 if (Value *Align = getAllocAlignment(AI.CB, TLI)) {
6954 std::optional<APInt> AlignmentAPI = getAPInt(A, *this, *Align);
6955 assert(AlignmentAPI && AlignmentAPI->getZExtValue() > 0 &&
6956 "Expected an alignment during manifest!");
6957 Alignment =
6958 std::max(Alignment, assumeAligned(AlignmentAPI->getZExtValue()));
6959 }
6960
6961 // TODO: Hoist the alloca towards the function entry.
6962 unsigned AS = DL.getAllocaAddrSpace();
6963 Instruction *Alloca =
6964 new AllocaInst(Type::getInt8Ty(F->getContext()), AS, Size, Alignment,
6965 AI.CB->getName() + ".h2s", IP);
6966
6967 if (Alloca->getType() != AI.CB->getType())
6968 Alloca = BitCastInst::CreatePointerBitCastOrAddrSpaceCast(
6969 Alloca, AI.CB->getType(), "malloc_cast", AI.CB->getIterator());
6970
6971 auto *I8Ty = Type::getInt8Ty(F->getContext());
6972 auto *InitVal = getInitialValueOfAllocation(AI.CB, TLI, I8Ty);
6973 assert(InitVal &&
6974 "Must be able to materialize initial memory state of allocation");
6975
6976 A.changeAfterManifest(IRPosition::inst(*AI.CB), *Alloca);
6977
6978 if (auto *II = dyn_cast<InvokeInst>(AI.CB)) {
6979 auto *NBB = II->getNormalDest();
6980 UncondBrInst::Create(NBB, AI.CB->getParent());
6981 A.deleteAfterManifest(*AI.CB);
6982 } else {
6983 A.deleteAfterManifest(*AI.CB);
6984 }
6985
6986 // Initialize the alloca with the same value as used by the allocation
6987 // function. We can skip undef as the initial value of an alloc is
6988 // undef, and the memset would simply end up being DSEd.
6989 if (!isa<UndefValue>(InitVal)) {
6990 IRBuilder<> Builder(Alloca->getNextNode());
6991 // TODO: Use alignment above if align!=1
6992 Builder.CreateMemSet(Alloca, InitVal, Size, std::nullopt);
6993 }
6994 HasChanged = ChangeStatus::CHANGED;
6995 }
6996
6997 return HasChanged;
6998 }
6999
7000 std::optional<APInt> getAPInt(Attributor &A, const AbstractAttribute &AA,
7001 Value &V) {
7002 bool UsedAssumedInformation = false;
7003 std::optional<Constant *> SimpleV =
7004 A.getAssumedConstant(V, AA, UsedAssumedInformation);
7005 if (!SimpleV)
7006 return APInt(64, 0);
7007 if (auto *CI = dyn_cast_or_null<ConstantInt>(*SimpleV))
7008 return CI->getValue();
7009 return std::nullopt;
7010 }
7011
7012 std::optional<APInt> getSize(Attributor &A, const AbstractAttribute &AA,
7013 AllocationInfo &AI) {
7014 auto Mapper = [&](const Value *V) -> const Value * {
7015 bool UsedAssumedInformation = false;
7016 if (std::optional<Constant *> SimpleV =
7017 A.getAssumedConstant(*V, AA, UsedAssumedInformation))
7018 if (*SimpleV)
7019 return *SimpleV;
7020 return V;
7021 };
7022
7023 const Function *F = getAnchorScope();
7024 const auto *TLI = A.getInfoCache().getTargetLibraryInfoForFunction(*F);
7025 return getAllocSize(AI.CB, TLI, Mapper);
7026 }
7027
7028 /// Collection of all malloc-like calls in a function with associated
7029 /// information.
7030 MapVector<CallBase *, AllocationInfo *> AllocationInfos;
7031
7032 /// Collection of all free-like calls in a function with associated
7033 /// information.
7034 MapVector<CallBase *, DeallocationInfo *> DeallocationInfos;
7035
7036 ChangeStatus updateImpl(Attributor &A) override;
7037};
7038
7039ChangeStatus AAHeapToStackFunction::updateImpl(Attributor &A) {
7041 const Function *F = getAnchorScope();
7042 const auto *TLI = A.getInfoCache().getTargetLibraryInfoForFunction(*F);
7043
7044 const auto *LivenessAA =
7045 A.getAAFor<AAIsDead>(*this, IRPosition::function(*F), DepClassTy::NONE);
7046
7047 MustBeExecutedContextExplorer *Explorer =
7048 A.getInfoCache().getMustBeExecutedContextExplorer();
7049
7050 bool StackIsAccessibleByOtherThreads =
7051 A.getInfoCache().stackIsAccessibleByOtherThreads();
7052
7053 LoopInfo *LI =
7054 A.getInfoCache().getAnalysisResultForFunction<LoopAnalysis>(*F);
7055 std::optional<bool> MayContainIrreducibleControl;
7056 auto IsInLoop = [&](BasicBlock &BB) {
7057 if (&F->getEntryBlock() == &BB)
7058 return false;
7059 if (!MayContainIrreducibleControl.has_value())
7060 MayContainIrreducibleControl = mayContainIrreducibleControl(*F, LI);
7061 if (*MayContainIrreducibleControl)
7062 return true;
7063 if (!LI)
7064 return true;
7065 return LI->getLoopFor(&BB) != nullptr;
7066 };
7067
7068 // Flag to ensure we update our deallocation information at most once per
7069 // updateImpl call and only if we use the free check reasoning.
7070 bool HasUpdatedFrees = false;
7071
7072 auto UpdateFrees = [&]() {
7073 HasUpdatedFrees = true;
7074
7075 for (auto &It : DeallocationInfos) {
7076 DeallocationInfo &DI = *It.second;
7077 // For now we cannot use deallocations that have unknown inputs, skip
7078 // them.
7079 if (DI.MightFreeUnknownObjects)
7080 continue;
7081
7082 // No need to analyze dead calls, ignore them instead.
7083 bool UsedAssumedInformation = false;
7084 if (A.isAssumedDead(*DI.CB, this, LivenessAA, UsedAssumedInformation,
7085 /* CheckBBLivenessOnly */ true))
7086 continue;
7087
7088 // Use the non-optimistic version to get the freed object.
7089 Value *Obj = getUnderlyingObject(DI.FreedOp);
7090 if (!Obj) {
7091 LLVM_DEBUG(dbgs() << "[H2S] Unknown underlying object for free!\n");
7092 DI.MightFreeUnknownObjects = true;
7093 continue;
7094 }
7095
7096 // Free of null and undef can be ignored as no-ops (or UB in the latter
7097 // case).
7099 continue;
7100
7101 CallBase *ObjCB = dyn_cast<CallBase>(Obj);
7102 if (!ObjCB) {
7103 LLVM_DEBUG(dbgs() << "[H2S] Free of a non-call object: " << *Obj
7104 << "\n");
7105 DI.MightFreeUnknownObjects = true;
7106 continue;
7107 }
7108
7109 AllocationInfo *AI = AllocationInfos.lookup(ObjCB);
7110 if (!AI) {
7111 LLVM_DEBUG(dbgs() << "[H2S] Free of a non-allocation object: " << *Obj
7112 << "\n");
7113 DI.MightFreeUnknownObjects = true;
7114 continue;
7115 }
7116
7117 DI.PotentialAllocationCalls.insert(ObjCB);
7118 }
7119 };
7120
7121 auto FreeCheck = [&](AllocationInfo &AI) {
7122 // If the stack is not accessible by other threads, the "must-free" logic
7123 // doesn't apply as the pointer could be shared and needs to be places in
7124 // "shareable" memory.
7125 if (!StackIsAccessibleByOtherThreads) {
7126 bool IsKnownNoSycn;
7128 A, this, getIRPosition(), DepClassTy::OPTIONAL, IsKnownNoSycn)) {
7129 LLVM_DEBUG(
7130 dbgs() << "[H2S] found an escaping use, stack is not accessible by "
7131 "other threads and function is not nosync:\n");
7132 return false;
7133 }
7134 }
7135 if (!HasUpdatedFrees)
7136 UpdateFrees();
7137
7138 // TODO: Allow multi exit functions that have different free calls.
7139 if (AI.PotentialFreeCalls.size() != 1) {
7140 LLVM_DEBUG(dbgs() << "[H2S] did not find one free call but "
7141 << AI.PotentialFreeCalls.size() << "\n");
7142 return false;
7143 }
7144 CallBase *UniqueFree = *AI.PotentialFreeCalls.begin();
7145 DeallocationInfo *DI = DeallocationInfos.lookup(UniqueFree);
7146 if (!DI) {
7147 LLVM_DEBUG(
7148 dbgs() << "[H2S] unique free call was not known as deallocation call "
7149 << *UniqueFree << "\n");
7150 return false;
7151 }
7152 if (DI->MightFreeUnknownObjects) {
7153 LLVM_DEBUG(
7154 dbgs() << "[H2S] unique free call might free unknown allocations\n");
7155 return false;
7156 }
7157 if (DI->PotentialAllocationCalls.empty())
7158 return true;
7159 if (DI->PotentialAllocationCalls.size() > 1) {
7160 LLVM_DEBUG(dbgs() << "[H2S] unique free call might free "
7161 << DI->PotentialAllocationCalls.size()
7162 << " different allocations\n");
7163 return false;
7164 }
7165 if (*DI->PotentialAllocationCalls.begin() != AI.CB) {
7166 LLVM_DEBUG(
7167 dbgs()
7168 << "[H2S] unique free call not known to free this allocation but "
7169 << **DI->PotentialAllocationCalls.begin() << "\n");
7170 return false;
7171 }
7172
7173 // __kmpc_alloc_shared and __kmpc_free_shared are by construction matched.
7174 if (!AI.IsGlobalizedLocal) {
7175 Instruction *CtxI = isa<InvokeInst>(AI.CB) ? AI.CB : AI.CB->getNextNode();
7176 if (!Explorer || !Explorer->findInContextOf(UniqueFree, CtxI)) {
7177 LLVM_DEBUG(dbgs() << "[H2S] unique free call might not be executed "
7178 "with the allocation "
7179 << *UniqueFree << "\n");
7180 return false;
7181 }
7182 }
7183 return true;
7184 };
7185
7186 auto UsesCheck = [&](AllocationInfo &AI) {
7187 bool ValidUsesOnly = true;
7188
7189 auto Pred = [&](const Use &U, bool &Follow) -> bool {
7190 Instruction *UserI = cast<Instruction>(U.getUser());
7191 if (isa<LoadInst>(UserI))
7192 return true;
7193 if (auto *SI = dyn_cast<StoreInst>(UserI)) {
7194 if (SI->getValueOperand() == U.get()) {
7196 << "[H2S] escaping store to memory: " << *UserI << "\n");
7197 ValidUsesOnly = false;
7198 } else {
7199 // A store into the malloc'ed memory is fine.
7200 }
7201 return true;
7202 }
7203 if (auto *CB = dyn_cast<CallBase>(UserI)) {
7204 if (!CB->isArgOperand(&U) || CB->isLifetimeStartOrEnd())
7205 return true;
7206 if (DeallocationInfos.count(CB)) {
7207 AI.PotentialFreeCalls.insert(CB);
7208 return true;
7209 }
7210
7211 unsigned ArgNo = CB->getArgOperandNo(&U);
7212 auto CBIRP = IRPosition::callsite_argument(*CB, ArgNo);
7213
7214 bool IsKnownNoCapture;
7215 bool IsAssumedNoCapture = AA::hasAssumedIRAttr<Attribute::Captures>(
7216 A, this, CBIRP, DepClassTy::OPTIONAL, IsKnownNoCapture);
7217
7218 // If a call site argument use is nofree, we are fine.
7219 bool IsKnownNoFree;
7220 bool IsAssumedNoFree = AA::hasAssumedIRAttr<Attribute::NoFree>(
7221 A, this, CBIRP, DepClassTy::OPTIONAL, IsKnownNoFree);
7222
7223 if (!IsAssumedNoCapture ||
7224 (!AI.IsGlobalizedLocal && !IsAssumedNoFree)) {
7225 AI.HasPotentiallyFreeingUnknownUses |= !IsAssumedNoFree;
7226
7227 // Emit a missed remark if this is missed OpenMP globalization.
7228 auto Remark = [&](OptimizationRemarkMissed ORM) {
7229 return ORM
7230 << "Could not move globalized variable to the stack. "
7231 "Variable is potentially captured in call. Mark "
7232 "parameter as `__attribute__((noescape))` to override.";
7233 };
7234
7235 if (ValidUsesOnly && AI.IsGlobalizedLocal)
7236 A.emitRemark<OptimizationRemarkMissed>(CB, "OMP113", Remark);
7237
7238 LLVM_DEBUG(dbgs() << "[H2S] Bad user: " << *UserI << "\n");
7239 ValidUsesOnly = false;
7240 }
7241 return true;
7242 }
7243
7244 if (isa<GetElementPtrInst>(UserI) || isa<BitCastInst>(UserI) ||
7245 isa<PHINode>(UserI) || isa<SelectInst>(UserI)) {
7246 Follow = true;
7247 return true;
7248 }
7249 // Unknown user for which we can not track uses further (in a way that
7250 // makes sense).
7251 LLVM_DEBUG(dbgs() << "[H2S] Unknown user: " << *UserI << "\n");
7252 ValidUsesOnly = false;
7253 return true;
7254 };
7255 if (!A.checkForAllUses(Pred, *this, *AI.CB, /* CheckBBLivenessOnly */ false,
7256 DepClassTy::OPTIONAL, /* IgnoreDroppableUses */ true,
7257 [&](const Use &OldU, const Use &NewU) {
7258 auto *SI = dyn_cast<StoreInst>(OldU.getUser());
7259 return !SI || StackIsAccessibleByOtherThreads ||
7260 AA::isAssumedThreadLocalObject(
7261 A, *SI->getPointerOperand(), *this);
7262 }))
7263 return false;
7264 return ValidUsesOnly;
7265 };
7266
7267 // The actual update starts here. We look at all allocations and depending on
7268 // their status perform the appropriate check(s).
7269 for (auto &It : AllocationInfos) {
7270 AllocationInfo &AI = *It.second;
7271 if (AI.Status == AllocationInfo::INVALID)
7272 continue;
7273
7274 if (Value *Align = getAllocAlignment(AI.CB, TLI)) {
7275 std::optional<APInt> APAlign = getAPInt(A, *this, *Align);
7276 if (!APAlign) {
7277 // Can't generate an alloca which respects the required alignment
7278 // on the allocation.
7279 LLVM_DEBUG(dbgs() << "[H2S] Unknown allocation alignment: " << *AI.CB
7280 << "\n");
7281 AI.Status = AllocationInfo::INVALID;
7283 continue;
7284 }
7285 if (APAlign->ugt(llvm::Value::MaximumAlignment) ||
7286 !APAlign->isPowerOf2()) {
7287 LLVM_DEBUG(dbgs() << "[H2S] Invalid allocation alignment: " << APAlign
7288 << "\n");
7289 AI.Status = AllocationInfo::INVALID;
7291 continue;
7292 }
7293 }
7294
7295 std::optional<APInt> Size = getSize(A, *this, AI);
7296 if (!AI.IsGlobalizedLocal && MaxHeapToStackSize != -1) {
7297 if (!Size || Size->ugt(MaxHeapToStackSize)) {
7298 LLVM_DEBUG({
7299 if (!Size)
7300 dbgs() << "[H2S] Unknown allocation size: " << *AI.CB << "\n";
7301 else
7302 dbgs() << "[H2S] Allocation size too large: " << *AI.CB << " vs. "
7303 << MaxHeapToStackSize << "\n";
7304 });
7305
7306 AI.Status = AllocationInfo::INVALID;
7308 continue;
7309 }
7310 }
7311
7312 switch (AI.Status) {
7313 case AllocationInfo::STACK_DUE_TO_USE:
7314 if (UsesCheck(AI))
7315 break;
7316 AI.Status = AllocationInfo::STACK_DUE_TO_FREE;
7317 [[fallthrough]];
7318 case AllocationInfo::STACK_DUE_TO_FREE:
7319 if (FreeCheck(AI))
7320 break;
7321 AI.Status = AllocationInfo::INVALID;
7323 break;
7324 case AllocationInfo::INVALID:
7325 llvm_unreachable("Invalid allocations should never reach this point!");
7326 };
7327
7328 // Check if we still think we can move it into the entry block. If the
7329 // alloca comes from a converted __kmpc_alloc_shared then we can usually
7330 // ignore the potential complications associated with loops.
7331 bool IsGlobalizedLocal = AI.IsGlobalizedLocal;
7332 if (AI.MoveAllocaIntoEntry &&
7333 (!Size.has_value() ||
7334 (!IsGlobalizedLocal && IsInLoop(*AI.CB->getParent()))))
7335 AI.MoveAllocaIntoEntry = false;
7336 }
7337
7338 return Changed;
7339}
7340} // namespace
7341
7342/// ----------------------- Privatizable Pointers ------------------------------
7343namespace {
7344struct AAPrivatizablePtrImpl : public AAPrivatizablePtr {
7345 AAPrivatizablePtrImpl(const IRPosition &IRP, Attributor &A)
7346 : AAPrivatizablePtr(IRP, A), PrivatizableType(std::nullopt) {}
7347
7348 ChangeStatus indicatePessimisticFixpoint() override {
7349 AAPrivatizablePtr::indicatePessimisticFixpoint();
7350 PrivatizableType = nullptr;
7351 return ChangeStatus::CHANGED;
7352 }
7353
7354 /// Identify the type we can chose for a private copy of the underlying
7355 /// argument. std::nullopt means it is not clear yet, nullptr means there is
7356 /// none.
7357 virtual std::optional<Type *> identifyPrivatizableType(Attributor &A) = 0;
7358
7359 /// Return a privatizable type that encloses both T0 and T1.
7360 /// TODO: This is merely a stub for now as we should manage a mapping as well.
7361 std::optional<Type *> combineTypes(std::optional<Type *> T0,
7362 std::optional<Type *> T1) {
7363 if (!T0)
7364 return T1;
7365 if (!T1)
7366 return T0;
7367 if (T0 == T1)
7368 return T0;
7369 return nullptr;
7370 }
7371
7372 std::optional<Type *> getPrivatizableType() const override {
7373 return PrivatizableType;
7374 }
7375
7376 const std::string getAsStr(Attributor *A) const override {
7377 return isAssumedPrivatizablePtr() ? "[priv]" : "[no-priv]";
7378 }
7379
7380protected:
7381 std::optional<Type *> PrivatizableType;
7382};
7383
7384// TODO: Do this for call site arguments (probably also other values) as well.
7385
7386struct AAPrivatizablePtrArgument final : public AAPrivatizablePtrImpl {
7387 AAPrivatizablePtrArgument(const IRPosition &IRP, Attributor &A)
7388 : AAPrivatizablePtrImpl(IRP, A) {}
7389
7390 /// See AAPrivatizablePtrImpl::identifyPrivatizableType(...)
7391 std::optional<Type *> identifyPrivatizableType(Attributor &A) override {
7392 // If this is a byval argument and we know all the call sites (so we can
7393 // rewrite them), there is no need to check them explicitly.
7394 bool UsedAssumedInformation = false;
7396 A.getAttrs(getIRPosition(), {Attribute::ByVal}, Attrs,
7397 /* IgnoreSubsumingPositions */ true);
7398 if (!Attrs.empty() &&
7399 A.checkForAllCallSites([](AbstractCallSite ACS) { return true; }, *this,
7400 true, UsedAssumedInformation))
7401 return Attrs[0].getValueAsType();
7402
7403 std::optional<Type *> Ty;
7404 unsigned ArgNo = getIRPosition().getCallSiteArgNo();
7405
7406 // Make sure the associated call site argument has the same type at all call
7407 // sites and it is an allocation we know is safe to privatize, for now that
7408 // means we only allow alloca instructions.
7409 // TODO: We can additionally analyze the accesses in the callee to create
7410 // the type from that information instead. That is a little more
7411 // involved and will be done in a follow up patch.
7412 auto CallSiteCheck = [&](AbstractCallSite ACS) {
7413 IRPosition ACSArgPos = IRPosition::callsite_argument(ACS, ArgNo);
7414 // Check if a coresponding argument was found or if it is one not
7415 // associated (which can happen for callback calls).
7416 if (ACSArgPos.getPositionKind() == IRPosition::IRP_INVALID)
7417 return false;
7418
7419 // Check that all call sites agree on a type.
7420 auto *PrivCSArgAA =
7421 A.getAAFor<AAPrivatizablePtr>(*this, ACSArgPos, DepClassTy::REQUIRED);
7422 if (!PrivCSArgAA)
7423 return false;
7424 std::optional<Type *> CSTy = PrivCSArgAA->getPrivatizableType();
7425
7426 LLVM_DEBUG({
7427 dbgs() << "[AAPrivatizablePtr] ACSPos: " << ACSArgPos << ", CSTy: ";
7428 if (CSTy && *CSTy)
7429 (*CSTy)->print(dbgs());
7430 else if (CSTy)
7431 dbgs() << "<nullptr>";
7432 else
7433 dbgs() << "<none>";
7434 });
7435
7436 Ty = combineTypes(Ty, CSTy);
7437
7438 LLVM_DEBUG({
7439 dbgs() << " : New Type: ";
7440 if (Ty && *Ty)
7441 (*Ty)->print(dbgs());
7442 else if (Ty)
7443 dbgs() << "<nullptr>";
7444 else
7445 dbgs() << "<none>";
7446 dbgs() << "\n";
7447 });
7448
7449 return !Ty || *Ty;
7450 };
7451
7452 if (!A.checkForAllCallSites(CallSiteCheck, *this, true,
7453 UsedAssumedInformation))
7454 return nullptr;
7455 return Ty;
7456 }
7457
7458 /// See AbstractAttribute::updateImpl(...).
7459 ChangeStatus updateImpl(Attributor &A) override {
7460 PrivatizableType = identifyPrivatizableType(A);
7461 if (!PrivatizableType)
7462 return ChangeStatus::UNCHANGED;
7463 if (!*PrivatizableType)
7464 return indicatePessimisticFixpoint();
7465
7466 // The dependence is optional so we don't give up once we give up on the
7467 // alignment.
7468 A.getAAFor<AAAlign>(*this, IRPosition::value(getAssociatedValue()),
7469 DepClassTy::OPTIONAL);
7470
7471 // Avoid arguments with padding for now.
7472 if (!A.hasAttr(getIRPosition(), Attribute::ByVal) &&
7473 !isDenselyPacked(*PrivatizableType, A.getInfoCache().getDL())) {
7474 LLVM_DEBUG(dbgs() << "[AAPrivatizablePtr] Padding detected\n");
7475 return indicatePessimisticFixpoint();
7476 }
7477
7478 // Collect the types that will replace the privatizable type in the function
7479 // signature.
7480 SmallVector<Type *, 16> ReplacementTypes;
7481 identifyReplacementTypes(*PrivatizableType, ReplacementTypes);
7482
7483 // Verify callee and caller agree on how the promoted argument would be
7484 // passed.
7485 Function &Fn = *getIRPosition().getAnchorScope();
7486 const auto *TTI =
7487 A.getInfoCache().getAnalysisResultForFunction<TargetIRAnalysis>(Fn);
7488 if (!TTI) {
7489 LLVM_DEBUG(dbgs() << "[AAPrivatizablePtr] Missing TTI for function "
7490 << Fn.getName() << "\n");
7491 return indicatePessimisticFixpoint();
7492 }
7493
7494 auto CallSiteCheck = [&](AbstractCallSite ACS) {
7495 CallBase *CB = ACS.getInstruction();
7496 return TTI->areTypesABICompatible(
7497 CB->getCaller(),
7499 ReplacementTypes);
7500 };
7501 bool UsedAssumedInformation = false;
7502 if (!A.checkForAllCallSites(CallSiteCheck, *this, true,
7503 UsedAssumedInformation)) {
7504 LLVM_DEBUG(
7505 dbgs() << "[AAPrivatizablePtr] ABI incompatibility detected for "
7506 << Fn.getName() << "\n");
7507 return indicatePessimisticFixpoint();
7508 }
7509
7510 // Register a rewrite of the argument.
7511 Argument *Arg = getAssociatedArgument();
7512 if (!A.isValidFunctionSignatureRewrite(*Arg, ReplacementTypes)) {
7513 LLVM_DEBUG(dbgs() << "[AAPrivatizablePtr] Rewrite not valid\n");
7514 return indicatePessimisticFixpoint();
7515 }
7516
7517 unsigned ArgNo = Arg->getArgNo();
7518
7519 // Helper to check if for the given call site the associated argument is
7520 // passed to a callback where the privatization would be different.
7521 auto IsCompatiblePrivArgOfCallback = [&](CallBase &CB) {
7522 SmallVector<const Use *, 4> CallbackUses;
7523 AbstractCallSite::getCallbackUses(CB, CallbackUses);
7524 for (const Use *U : CallbackUses) {
7525 AbstractCallSite CBACS(U);
7526 assert(CBACS && CBACS.isCallbackCall());
7527 for (Argument &CBArg : CBACS.getCalledFunction()->args()) {
7528 int CBArgNo = CBACS.getCallArgOperandNo(CBArg);
7529
7530 LLVM_DEBUG({
7531 dbgs()
7532 << "[AAPrivatizablePtr] Argument " << *Arg
7533 << "check if can be privatized in the context of its parent ("
7534 << Arg->getParent()->getName()
7535 << ")\n[AAPrivatizablePtr] because it is an argument in a "
7536 "callback ("
7537 << CBArgNo << "@" << CBACS.getCalledFunction()->getName()
7538 << ")\n[AAPrivatizablePtr] " << CBArg << " : "
7539 << CBACS.getCallArgOperand(CBArg) << " vs "
7540 << CB.getArgOperand(ArgNo) << "\n"
7541 << "[AAPrivatizablePtr] " << CBArg << " : "
7542 << CBACS.getCallArgOperandNo(CBArg) << " vs " << ArgNo << "\n";
7543 });
7544
7545 if (CBArgNo != int(ArgNo))
7546 continue;
7547 const auto *CBArgPrivAA = A.getAAFor<AAPrivatizablePtr>(
7548 *this, IRPosition::argument(CBArg), DepClassTy::REQUIRED);
7549 if (CBArgPrivAA && CBArgPrivAA->isValidState()) {
7550 auto CBArgPrivTy = CBArgPrivAA->getPrivatizableType();
7551 if (!CBArgPrivTy)
7552 continue;
7553 if (*CBArgPrivTy == PrivatizableType)
7554 continue;
7555 }
7556
7557 LLVM_DEBUG({
7558 dbgs() << "[AAPrivatizablePtr] Argument " << *Arg
7559 << " cannot be privatized in the context of its parent ("
7560 << Arg->getParent()->getName()
7561 << ")\n[AAPrivatizablePtr] because it is an argument in a "
7562 "callback ("
7563 << CBArgNo << "@" << CBACS.getCalledFunction()->getName()
7564 << ").\n[AAPrivatizablePtr] for which the argument "
7565 "privatization is not compatible.\n";
7566 });
7567 return false;
7568 }
7569 }
7570 return true;
7571 };
7572
7573 // Helper to check if for the given call site the associated argument is
7574 // passed to a direct call where the privatization would be different.
7575 auto IsCompatiblePrivArgOfDirectCS = [&](AbstractCallSite ACS) {
7576 CallBase *DC = cast<CallBase>(ACS.getInstruction());
7577 int DCArgNo = ACS.getCallArgOperandNo(ArgNo);
7578 assert(DCArgNo >= 0 && unsigned(DCArgNo) < DC->arg_size() &&
7579 "Expected a direct call operand for callback call operand");
7580
7581 Function *DCCallee =
7583 LLVM_DEBUG({
7584 dbgs() << "[AAPrivatizablePtr] Argument " << *Arg
7585 << " check if be privatized in the context of its parent ("
7586 << Arg->getParent()->getName()
7587 << ")\n[AAPrivatizablePtr] because it is an argument in a "
7588 "direct call of ("
7589 << DCArgNo << "@" << DCCallee->getName() << ").\n";
7590 });
7591
7592 if (unsigned(DCArgNo) < DCCallee->arg_size()) {
7593 const auto *DCArgPrivAA = A.getAAFor<AAPrivatizablePtr>(
7594 *this, IRPosition::argument(*DCCallee->getArg(DCArgNo)),
7595 DepClassTy::REQUIRED);
7596 if (DCArgPrivAA && DCArgPrivAA->isValidState()) {
7597 auto DCArgPrivTy = DCArgPrivAA->getPrivatizableType();
7598 if (!DCArgPrivTy)
7599 return true;
7600 if (*DCArgPrivTy == PrivatizableType)
7601 return true;
7602 }
7603 }
7604
7605 LLVM_DEBUG({
7606 dbgs() << "[AAPrivatizablePtr] Argument " << *Arg
7607 << " cannot be privatized in the context of its parent ("
7608 << Arg->getParent()->getName()
7609 << ")\n[AAPrivatizablePtr] because it is an argument in a "
7610 "direct call of ("
7612 << ").\n[AAPrivatizablePtr] for which the argument "
7613 "privatization is not compatible.\n";
7614 });
7615 return false;
7616 };
7617
7618 // Helper to check if the associated argument is used at the given abstract
7619 // call site in a way that is incompatible with the privatization assumed
7620 // here.
7621 auto IsCompatiblePrivArgOfOtherCallSite = [&](AbstractCallSite ACS) {
7622 if (ACS.isDirectCall())
7623 return IsCompatiblePrivArgOfCallback(*ACS.getInstruction());
7624 if (ACS.isCallbackCall())
7625 return IsCompatiblePrivArgOfDirectCS(ACS);
7626 return false;
7627 };
7628
7629 if (!A.checkForAllCallSites(IsCompatiblePrivArgOfOtherCallSite, *this, true,
7630 UsedAssumedInformation))
7631 return indicatePessimisticFixpoint();
7632
7633 return ChangeStatus::UNCHANGED;
7634 }
7635
7636 /// Given a type to private \p PrivType, collect the constituates (which are
7637 /// used) in \p ReplacementTypes.
7638 static void
7639 identifyReplacementTypes(Type *PrivType,
7640 SmallVectorImpl<Type *> &ReplacementTypes) {
7641 // TODO: For now we expand the privatization type to the fullest which can
7642 // lead to dead arguments that need to be removed later.
7643 assert(PrivType && "Expected privatizable type!");
7644
7645 // Traverse the type, extract constituate types on the outermost level.
7646 if (auto *PrivStructType = dyn_cast<StructType>(PrivType)) {
7647 for (unsigned u = 0, e = PrivStructType->getNumElements(); u < e; u++)
7648 ReplacementTypes.push_back(PrivStructType->getElementType(u));
7649 } else if (auto *PrivArrayType = dyn_cast<ArrayType>(PrivType)) {
7650 ReplacementTypes.append(PrivArrayType->getNumElements(),
7651 PrivArrayType->getElementType());
7652 } else {
7653 ReplacementTypes.push_back(PrivType);
7654 }
7655 }
7656
7657 /// Initialize \p Base according to the type \p PrivType at position \p IP.
7658 /// The values needed are taken from the arguments of \p F starting at
7659 /// position \p ArgNo.
7660 static void createInitialization(Type *PrivType, Value &Base, Function &F,
7661 unsigned ArgNo, BasicBlock::iterator IP) {
7662 assert(PrivType && "Expected privatizable type!");
7663
7664 IRBuilder<NoFolder> IRB(IP->getParent(), IP);
7665 const DataLayout &DL = F.getDataLayout();
7666
7667 // Traverse the type, build GEPs and stores.
7668 if (auto *PrivStructType = dyn_cast<StructType>(PrivType)) {
7669 const StructLayout *PrivStructLayout = DL.getStructLayout(PrivStructType);
7670 for (unsigned u = 0, e = PrivStructType->getNumElements(); u < e; u++) {
7671 Value *Ptr =
7672 constructPointer(&Base, PrivStructLayout->getElementOffset(u), IRB);
7673 new StoreInst(F.getArg(ArgNo + u), Ptr, IP);
7674 }
7675 } else if (auto *PrivArrayType = dyn_cast<ArrayType>(PrivType)) {
7676 Type *PointeeTy = PrivArrayType->getElementType();
7677 uint64_t PointeeTySize = DL.getTypeStoreSize(PointeeTy);
7678 for (unsigned u = 0, e = PrivArrayType->getNumElements(); u < e; u++) {
7679 Value *Ptr = constructPointer(&Base, u * PointeeTySize, IRB);
7680 new StoreInst(F.getArg(ArgNo + u), Ptr, IP);
7681 }
7682 } else {
7683 new StoreInst(F.getArg(ArgNo), &Base, IP);
7684 }
7685 }
7686
7687 /// Extract values from \p Base according to the type \p PrivType at the
7688 /// call position \p ACS. The values are appended to \p ReplacementValues.
7689 void createReplacementValues(Align Alignment, Type *PrivType,
7690 AbstractCallSite ACS, Value *Base,
7691 SmallVectorImpl<Value *> &ReplacementValues) {
7692 assert(Base && "Expected base value!");
7693 assert(PrivType && "Expected privatizable type!");
7694 Instruction *IP = ACS.getInstruction();
7695
7696 IRBuilder<NoFolder> IRB(IP);
7697 const DataLayout &DL = IP->getDataLayout();
7698
7699 // Traverse the type, build GEPs and loads.
7700 if (auto *PrivStructType = dyn_cast<StructType>(PrivType)) {
7701 const StructLayout *PrivStructLayout = DL.getStructLayout(PrivStructType);
7702 for (unsigned u = 0, e = PrivStructType->getNumElements(); u < e; u++) {
7703 Type *PointeeTy = PrivStructType->getElementType(u);
7704 Value *Ptr =
7705 constructPointer(Base, PrivStructLayout->getElementOffset(u), IRB);
7706 LoadInst *L = new LoadInst(PointeeTy, Ptr, "", IP->getIterator());
7707 L->setAlignment(Alignment);
7708 ReplacementValues.push_back(L);
7709 }
7710 } else if (auto *PrivArrayType = dyn_cast<ArrayType>(PrivType)) {
7711 Type *PointeeTy = PrivArrayType->getElementType();
7712 uint64_t PointeeTySize = DL.getTypeStoreSize(PointeeTy);
7713 for (unsigned u = 0, e = PrivArrayType->getNumElements(); u < e; u++) {
7714 Value *Ptr = constructPointer(Base, u * PointeeTySize, IRB);
7715 LoadInst *L = new LoadInst(PointeeTy, Ptr, "", IP->getIterator());
7716 L->setAlignment(Alignment);
7717 ReplacementValues.push_back(L);
7718 }
7719 } else {
7720 LoadInst *L = new LoadInst(PrivType, Base, "", IP->getIterator());
7721 L->setAlignment(Alignment);
7722 ReplacementValues.push_back(L);
7723 }
7724 }
7725
7726 /// See AbstractAttribute::manifest(...)
7727 ChangeStatus manifest(Attributor &A) override {
7728 if (!PrivatizableType)
7729 return ChangeStatus::UNCHANGED;
7730 assert(*PrivatizableType && "Expected privatizable type!");
7731
7732 // Collect all tail calls in the function as we cannot allow new allocas to
7733 // escape into tail recursion.
7734 // TODO: Be smarter about new allocas escaping into tail calls.
7736 bool UsedAssumedInformation = false;
7737 if (!A.checkForAllInstructions(
7738 [&](Instruction &I) {
7739 CallInst &CI = cast<CallInst>(I);
7740 if (CI.isTailCall())
7741 TailCalls.push_back(&CI);
7742 return true;
7743 },
7744 *this, {Instruction::Call}, UsedAssumedInformation))
7745 return ChangeStatus::UNCHANGED;
7746
7747 Argument *Arg = getAssociatedArgument();
7748 // Query AAAlign attribute for alignment of associated argument to
7749 // determine the best alignment of loads.
7750 const auto *AlignAA =
7751 A.getAAFor<AAAlign>(*this, IRPosition::value(*Arg), DepClassTy::NONE);
7752
7753 // Callback to repair the associated function. A new alloca is placed at the
7754 // beginning and initialized with the values passed through arguments. The
7755 // new alloca replaces the use of the old pointer argument.
7757 [=](const Attributor::ArgumentReplacementInfo &ARI,
7758 Function &ReplacementFn, Function::arg_iterator ArgIt) {
7759 BasicBlock &EntryBB = ReplacementFn.getEntryBlock();
7761 const DataLayout &DL = IP->getDataLayout();
7762 unsigned AS = DL.getAllocaAddrSpace();
7763 Instruction *AI = new AllocaInst(*PrivatizableType, AS,
7764 Arg->getName() + ".priv", IP);
7765 createInitialization(*PrivatizableType, *AI, ReplacementFn,
7766 ArgIt->getArgNo(), IP);
7767
7768 if (AI->getType() != Arg->getType())
7769 AI = BitCastInst::CreatePointerBitCastOrAddrSpaceCast(
7770 AI, Arg->getType(), "", IP);
7771 Arg->replaceAllUsesWith(AI);
7772
7773 for (CallInst *CI : TailCalls)
7774 CI->setTailCall(false);
7775 };
7776
7777 // Callback to repair a call site of the associated function. The elements
7778 // of the privatizable type are loaded prior to the call and passed to the
7779 // new function version.
7781 [=](const Attributor::ArgumentReplacementInfo &ARI,
7782 AbstractCallSite ACS, SmallVectorImpl<Value *> &NewArgOperands) {
7783 // When no alignment is specified for the load instruction,
7784 // natural alignment is assumed.
7785 createReplacementValues(
7786 AlignAA ? AlignAA->getAssumedAlign() : Align(0),
7787 *PrivatizableType, ACS,
7788 ACS.getCallArgOperand(ARI.getReplacedArg().getArgNo()),
7789 NewArgOperands);
7790 };
7791
7792 // Collect the types that will replace the privatizable type in the function
7793 // signature.
7794 SmallVector<Type *, 16> ReplacementTypes;
7795 identifyReplacementTypes(*PrivatizableType, ReplacementTypes);
7796
7797 // Register a rewrite of the argument.
7798 if (A.registerFunctionSignatureRewrite(*Arg, ReplacementTypes,
7799 std::move(FnRepairCB),
7800 std::move(ACSRepairCB)))
7801 return ChangeStatus::CHANGED;
7802 return ChangeStatus::UNCHANGED;
7803 }
7804
7805 /// See AbstractAttribute::trackStatistics()
7806 void trackStatistics() const override {
7807 STATS_DECLTRACK_ARG_ATTR(privatizable_ptr);
7808 }
7809};
7810
7811struct AAPrivatizablePtrFloating : public AAPrivatizablePtrImpl {
7812 AAPrivatizablePtrFloating(const IRPosition &IRP, Attributor &A)
7813 : AAPrivatizablePtrImpl(IRP, A) {}
7814
7815 /// See AbstractAttribute::initialize(...).
7816 void initialize(Attributor &A) override {
7817 // TODO: We can privatize more than arguments.
7818 indicatePessimisticFixpoint();
7819 }
7820
7821 ChangeStatus updateImpl(Attributor &A) override {
7822 llvm_unreachable("AAPrivatizablePtr(Floating|Returned|CallSiteReturned)::"
7823 "updateImpl will not be called");
7824 }
7825
7826 /// See AAPrivatizablePtrImpl::identifyPrivatizableType(...)
7827 std::optional<Type *> identifyPrivatizableType(Attributor &A) override {
7828 Value *Obj = getUnderlyingObject(&getAssociatedValue());
7829 if (!Obj) {
7830 LLVM_DEBUG(dbgs() << "[AAPrivatizablePtr] No underlying object found!\n");
7831 return nullptr;
7832 }
7833
7834 if (auto *AI = dyn_cast<AllocaInst>(Obj))
7835 if (auto *CI = dyn_cast<ConstantInt>(AI->getArraySize()))
7836 if (CI->isOne())
7837 return AI->getAllocatedType();
7838 if (auto *Arg = dyn_cast<Argument>(Obj)) {
7839 auto *PrivArgAA = A.getAAFor<AAPrivatizablePtr>(
7840 *this, IRPosition::argument(*Arg), DepClassTy::REQUIRED);
7841 if (PrivArgAA && PrivArgAA->isAssumedPrivatizablePtr())
7842 return PrivArgAA->getPrivatizableType();
7843 }
7844
7845 LLVM_DEBUG(dbgs() << "[AAPrivatizablePtr] Underlying object neither valid "
7846 "alloca nor privatizable argument: "
7847 << *Obj << "!\n");
7848 return nullptr;
7849 }
7850
7851 /// See AbstractAttribute::trackStatistics()
7852 void trackStatistics() const override {
7853 STATS_DECLTRACK_FLOATING_ATTR(privatizable_ptr);
7854 }
7855};
7856
7857struct AAPrivatizablePtrCallSiteArgument final
7858 : public AAPrivatizablePtrFloating {
7859 AAPrivatizablePtrCallSiteArgument(const IRPosition &IRP, Attributor &A)
7860 : AAPrivatizablePtrFloating(IRP, A) {}
7861
7862 /// See AbstractAttribute::initialize(...).
7863 void initialize(Attributor &A) override {
7864 if (A.hasAttr(getIRPosition(), Attribute::ByVal))
7865 indicateOptimisticFixpoint();
7866 }
7867
7868 /// See AbstractAttribute::updateImpl(...).
7869 ChangeStatus updateImpl(Attributor &A) override {
7870 PrivatizableType = identifyPrivatizableType(A);
7871 if (!PrivatizableType)
7872 return ChangeStatus::UNCHANGED;
7873 if (!*PrivatizableType)
7874 return indicatePessimisticFixpoint();
7875
7876 const IRPosition &IRP = getIRPosition();
7877 bool IsKnownNoCapture;
7878 bool IsAssumedNoCapture = AA::hasAssumedIRAttr<Attribute::Captures>(
7879 A, this, IRP, DepClassTy::REQUIRED, IsKnownNoCapture);
7880 if (!IsAssumedNoCapture) {
7881 LLVM_DEBUG(dbgs() << "[AAPrivatizablePtr] pointer might be captured!\n");
7882 return indicatePessimisticFixpoint();
7883 }
7884
7885 bool IsKnownNoAlias;
7887 A, this, IRP, DepClassTy::REQUIRED, IsKnownNoAlias)) {
7888 LLVM_DEBUG(dbgs() << "[AAPrivatizablePtr] pointer might alias!\n");
7889 return indicatePessimisticFixpoint();
7890 }
7891
7892 bool IsKnown;
7893 if (!AA::isAssumedReadOnly(A, IRP, *this, IsKnown)) {
7894 LLVM_DEBUG(dbgs() << "[AAPrivatizablePtr] pointer is written!\n");
7895 return indicatePessimisticFixpoint();
7896 }
7897
7898 return ChangeStatus::UNCHANGED;
7899 }
7900
7901 /// See AbstractAttribute::trackStatistics()
7902 void trackStatistics() const override {
7903 STATS_DECLTRACK_CSARG_ATTR(privatizable_ptr);
7904 }
7905};
7906
7907struct AAPrivatizablePtrCallSiteReturned final
7908 : public AAPrivatizablePtrFloating {
7909 AAPrivatizablePtrCallSiteReturned(const IRPosition &IRP, Attributor &A)
7910 : AAPrivatizablePtrFloating(IRP, A) {}
7911
7912 /// See AbstractAttribute::initialize(...).
7913 void initialize(Attributor &A) override {
7914 // TODO: We can privatize more than arguments.
7915 indicatePessimisticFixpoint();
7916 }
7917
7918 /// See AbstractAttribute::trackStatistics()
7919 void trackStatistics() const override {
7920 STATS_DECLTRACK_CSRET_ATTR(privatizable_ptr);
7921 }
7922};
7923
7924struct AAPrivatizablePtrReturned final : public AAPrivatizablePtrFloating {
7925 AAPrivatizablePtrReturned(const IRPosition &IRP, Attributor &A)
7926 : AAPrivatizablePtrFloating(IRP, A) {}
7927
7928 /// See AbstractAttribute::initialize(...).
7929 void initialize(Attributor &A) override {
7930 // TODO: We can privatize more than arguments.
7931 indicatePessimisticFixpoint();
7932 }
7933
7934 /// See AbstractAttribute::trackStatistics()
7935 void trackStatistics() const override {
7936 STATS_DECLTRACK_FNRET_ATTR(privatizable_ptr);
7937 }
7938};
7939} // namespace
7940
7941/// -------------------- Memory Behavior Attributes ----------------------------
7942/// Includes read-none, read-only, and write-only.
7943/// ----------------------------------------------------------------------------
7944namespace {
7945struct AAMemoryBehaviorImpl : public AAMemoryBehavior {
7946 AAMemoryBehaviorImpl(const IRPosition &IRP, Attributor &A)
7947 : AAMemoryBehavior(IRP, A) {}
7948
7949 /// See AbstractAttribute::initialize(...).
7950 void initialize(Attributor &A) override {
7951 intersectAssumedBits(BEST_STATE);
7952 getKnownStateFromValue(A, getIRPosition(), getState());
7953 AAMemoryBehavior::initialize(A);
7954 }
7955
7956 /// Return the memory behavior information encoded in the IR for \p IRP.
7957 static void getKnownStateFromValue(Attributor &A, const IRPosition &IRP,
7958 BitIntegerState &State,
7959 bool IgnoreSubsumingPositions = false) {
7961 A.getAttrs(IRP, AttrKinds, Attrs, IgnoreSubsumingPositions);
7962 for (const Attribute &Attr : Attrs) {
7963 switch (Attr.getKindAsEnum()) {
7964 case Attribute::ReadNone:
7965 State.addKnownBits(NO_ACCESSES);
7966 break;
7967 case Attribute::ReadOnly:
7968 State.addKnownBits(NO_WRITES);
7969 break;
7970 case Attribute::WriteOnly:
7971 State.addKnownBits(NO_READS);
7972 break;
7973 default:
7974 llvm_unreachable("Unexpected attribute!");
7975 }
7976 }
7977
7978 if (auto *I = dyn_cast<Instruction>(&IRP.getAnchorValue())) {
7979 if (!I->mayReadFromMemory())
7980 State.addKnownBits(NO_READS);
7981 if (!I->mayWriteToMemory())
7982 State.addKnownBits(NO_WRITES);
7983 }
7984 }
7985
7986 /// See AbstractAttribute::getDeducedAttributes(...).
7987 void getDeducedAttributes(Attributor &A, LLVMContext &Ctx,
7988 SmallVectorImpl<Attribute> &Attrs) const override {
7989 assert(Attrs.size() == 0);
7990 if (isAssumedReadNone())
7991 Attrs.push_back(Attribute::get(Ctx, Attribute::ReadNone));
7992 else if (isAssumedReadOnly())
7993 Attrs.push_back(Attribute::get(Ctx, Attribute::ReadOnly));
7994 else if (isAssumedWriteOnly())
7995 Attrs.push_back(Attribute::get(Ctx, Attribute::WriteOnly));
7996 assert(Attrs.size() <= 1);
7997 }
7998
7999 /// See AbstractAttribute::manifest(...).
8000 ChangeStatus manifest(Attributor &A) override {
8001 const IRPosition &IRP = getIRPosition();
8002
8003 if (A.hasAttr(IRP, Attribute::ReadNone,
8004 /* IgnoreSubsumingPositions */ true))
8005 return ChangeStatus::UNCHANGED;
8006
8007 // Check if we would improve the existing attributes first.
8008 SmallVector<Attribute, 4> DeducedAttrs;
8009 getDeducedAttributes(A, IRP.getAnchorValue().getContext(), DeducedAttrs);
8010 if (llvm::all_of(DeducedAttrs, [&](const Attribute &Attr) {
8011 return A.hasAttr(IRP, Attr.getKindAsEnum(),
8012 /* IgnoreSubsumingPositions */ true);
8013 }))
8014 return ChangeStatus::UNCHANGED;
8015
8016 // Clear existing attributes.
8017 A.removeAttrs(IRP, AttrKinds);
8018 // Clear conflicting writable attribute.
8019 if (isAssumedReadOnly())
8020 A.removeAttrs(IRP, Attribute::Writable);
8021
8022 // Use the generic manifest method.
8023 return IRAttribute::manifest(A);
8024 }
8025
8026 /// See AbstractState::getAsStr().
8027 const std::string getAsStr(Attributor *A) const override {
8028 if (isAssumedReadNone())
8029 return "readnone";
8030 if (isAssumedReadOnly())
8031 return "readonly";
8032 if (isAssumedWriteOnly())
8033 return "writeonly";
8034 return "may-read/write";
8035 }
8036
8037 /// The set of IR attributes AAMemoryBehavior deals with.
8038 static const Attribute::AttrKind AttrKinds[3];
8039};
8040
8041const Attribute::AttrKind AAMemoryBehaviorImpl::AttrKinds[] = {
8042 Attribute::ReadNone, Attribute::ReadOnly, Attribute::WriteOnly};
8043
8044/// Memory behavior attribute for a floating value.
8045struct AAMemoryBehaviorFloating : AAMemoryBehaviorImpl {
8046 AAMemoryBehaviorFloating(const IRPosition &IRP, Attributor &A)
8047 : AAMemoryBehaviorImpl(IRP, A) {}
8048
8049 /// See AbstractAttribute::updateImpl(...).
8050 ChangeStatus updateImpl(Attributor &A) override;
8051
8052 /// See AbstractAttribute::trackStatistics()
8053 void trackStatistics() const override {
8054 if (isAssumedReadNone())
8056 else if (isAssumedReadOnly())
8058 else if (isAssumedWriteOnly())
8060 }
8061
8062private:
8063 /// Return true if users of \p UserI might access the underlying
8064 /// variable/location described by \p U and should therefore be analyzed.
8065 bool followUsersOfUseIn(Attributor &A, const Use &U,
8066 const Instruction *UserI);
8067
8068 /// Update the state according to the effect of use \p U in \p UserI.
8069 void analyzeUseIn(Attributor &A, const Use &U, const Instruction *UserI);
8070};
8071
8072/// Memory behavior attribute for function argument.
8073struct AAMemoryBehaviorArgument : AAMemoryBehaviorFloating {
8074 AAMemoryBehaviorArgument(const IRPosition &IRP, Attributor &A)
8075 : AAMemoryBehaviorFloating(IRP, A) {}
8076
8077 /// See AbstractAttribute::initialize(...).
8078 void initialize(Attributor &A) override {
8079 intersectAssumedBits(BEST_STATE);
8080 const IRPosition &IRP = getIRPosition();
8081 // TODO: Make IgnoreSubsumingPositions a property of an IRAttribute so we
8082 // can query it when we use has/getAttr. That would allow us to reuse the
8083 // initialize of the base class here.
8084 bool HasByVal = A.hasAttr(IRP, {Attribute::ByVal},
8085 /* IgnoreSubsumingPositions */ true);
8086 getKnownStateFromValue(A, IRP, getState(),
8087 /* IgnoreSubsumingPositions */ HasByVal);
8088 }
8089
8090 ChangeStatus manifest(Attributor &A) override {
8091 // TODO: Pointer arguments are not supported on vectors of pointers yet.
8092 if (!getAssociatedValue().getType()->isPointerTy())
8093 return ChangeStatus::UNCHANGED;
8094
8095 // TODO: From readattrs.ll: "inalloca parameters are always
8096 // considered written"
8097 if (A.hasAttr(getIRPosition(),
8098 {Attribute::InAlloca, Attribute::Preallocated})) {
8099 removeKnownBits(NO_WRITES);
8100 removeAssumedBits(NO_WRITES);
8101 }
8102 A.removeAttrs(getIRPosition(), AttrKinds);
8103 return AAMemoryBehaviorFloating::manifest(A);
8104 }
8105
8106 /// See AbstractAttribute::trackStatistics()
8107 void trackStatistics() const override {
8108 if (isAssumedReadNone())
8109 STATS_DECLTRACK_ARG_ATTR(readnone)
8110 else if (isAssumedReadOnly())
8111 STATS_DECLTRACK_ARG_ATTR(readonly)
8112 else if (isAssumedWriteOnly())
8113 STATS_DECLTRACK_ARG_ATTR(writeonly)
8114 }
8115};
8116
8117struct AAMemoryBehaviorCallSiteArgument final : AAMemoryBehaviorArgument {
8118 AAMemoryBehaviorCallSiteArgument(const IRPosition &IRP, Attributor &A)
8119 : AAMemoryBehaviorArgument(IRP, A) {}
8120
8121 /// See AbstractAttribute::initialize(...).
8122 void initialize(Attributor &A) override {
8123 // If we don't have an associated attribute this is either a variadic call
8124 // or an indirect call, either way, nothing to do here.
8125 Argument *Arg = getAssociatedArgument();
8126 if (!Arg) {
8127 indicatePessimisticFixpoint();
8128 return;
8129 }
8130 if (Arg->hasByValAttr()) {
8131 addKnownBits(NO_WRITES);
8132 removeKnownBits(NO_READS);
8133 removeAssumedBits(NO_READS);
8134 }
8135 AAMemoryBehaviorArgument::initialize(A);
8136 if (getAssociatedFunction()->isDeclaration())
8137 indicatePessimisticFixpoint();
8138 }
8139
8140 /// See AbstractAttribute::updateImpl(...).
8141 ChangeStatus updateImpl(Attributor &A) override {
8142 // TODO: Once we have call site specific value information we can provide
8143 // call site specific liveness liveness information and then it makes
8144 // sense to specialize attributes for call sites arguments instead of
8145 // redirecting requests to the callee argument.
8146 Argument *Arg = getAssociatedArgument();
8147 const IRPosition &ArgPos = IRPosition::argument(*Arg);
8148 auto *ArgAA =
8149 A.getAAFor<AAMemoryBehavior>(*this, ArgPos, DepClassTy::REQUIRED);
8150 if (!ArgAA)
8151 return indicatePessimisticFixpoint();
8152 return clampStateAndIndicateChange(getState(), ArgAA->getState());
8153 }
8154
8155 /// See AbstractAttribute::trackStatistics()
8156 void trackStatistics() const override {
8157 if (isAssumedReadNone())
8159 else if (isAssumedReadOnly())
8161 else if (isAssumedWriteOnly())
8163 }
8164};
8165
8166/// Memory behavior attribute for a call site return position.
8167struct AAMemoryBehaviorCallSiteReturned final : AAMemoryBehaviorFloating {
8168 AAMemoryBehaviorCallSiteReturned(const IRPosition &IRP, Attributor &A)
8169 : AAMemoryBehaviorFloating(IRP, A) {}
8170
8171 /// See AbstractAttribute::initialize(...).
8172 void initialize(Attributor &A) override {
8173 AAMemoryBehaviorImpl::initialize(A);
8174 }
8175 /// See AbstractAttribute::manifest(...).
8176 ChangeStatus manifest(Attributor &A) override {
8177 // We do not annotate returned values.
8178 return ChangeStatus::UNCHANGED;
8179 }
8180
8181 /// See AbstractAttribute::trackStatistics()
8182 void trackStatistics() const override {}
8183};
8184
8185/// An AA to represent the memory behavior function attributes.
8186struct AAMemoryBehaviorFunction final : public AAMemoryBehaviorImpl {
8187 AAMemoryBehaviorFunction(const IRPosition &IRP, Attributor &A)
8188 : AAMemoryBehaviorImpl(IRP, A) {}
8189
8190 /// See AbstractAttribute::updateImpl(Attributor &A).
8191 ChangeStatus updateImpl(Attributor &A) override;
8192
8193 /// See AbstractAttribute::manifest(...).
8194 ChangeStatus manifest(Attributor &A) override {
8195 // TODO: It would be better to merge this with AAMemoryLocation, so that
8196 // we could determine read/write per location. This would also have the
8197 // benefit of only one place trying to manifest the memory attribute.
8198 Function &F = cast<Function>(getAnchorValue());
8200 if (isAssumedReadNone())
8201 ME = MemoryEffects::none();
8202 else if (isAssumedReadOnly())
8204 else if (isAssumedWriteOnly())
8206
8207 A.removeAttrs(getIRPosition(), AttrKinds);
8208 // Clear conflicting writable attribute.
8209 if (ME.onlyReadsMemory())
8210 for (Argument &Arg : F.args())
8211 A.removeAttrs(IRPosition::argument(Arg), Attribute::Writable);
8212 return A.manifestAttrs(getIRPosition(),
8213 Attribute::getWithMemoryEffects(F.getContext(), ME));
8214 }
8215
8216 /// See AbstractAttribute::trackStatistics()
8217 void trackStatistics() const override {
8218 if (isAssumedReadNone())
8219 STATS_DECLTRACK_FN_ATTR(readnone)
8220 else if (isAssumedReadOnly())
8221 STATS_DECLTRACK_FN_ATTR(readonly)
8222 else if (isAssumedWriteOnly())
8223 STATS_DECLTRACK_FN_ATTR(writeonly)
8224 }
8225};
8226
8227/// AAMemoryBehavior attribute for call sites.
8228struct AAMemoryBehaviorCallSite final
8229 : AACalleeToCallSite<AAMemoryBehavior, AAMemoryBehaviorImpl> {
8230 AAMemoryBehaviorCallSite(const IRPosition &IRP, Attributor &A)
8231 : AACalleeToCallSite<AAMemoryBehavior, AAMemoryBehaviorImpl>(IRP, A) {}
8232
8233 /// See AbstractAttribute::manifest(...).
8234 ChangeStatus manifest(Attributor &A) override {
8235 // TODO: Deduplicate this with AAMemoryBehaviorFunction.
8236 CallBase &CB = cast<CallBase>(getAnchorValue());
8238 if (isAssumedReadNone())
8239 ME = MemoryEffects::none();
8240 else if (isAssumedReadOnly())
8242 else if (isAssumedWriteOnly())
8244
8245 A.removeAttrs(getIRPosition(), AttrKinds);
8246 // Clear conflicting writable attribute.
8247 if (ME.onlyReadsMemory())
8248 for (Use &U : CB.args())
8249 A.removeAttrs(IRPosition::callsite_argument(CB, U.getOperandNo()),
8250 Attribute::Writable);
8251 return A.manifestAttrs(
8252 getIRPosition(), Attribute::getWithMemoryEffects(CB.getContext(), ME));
8253 }
8254
8255 /// See AbstractAttribute::trackStatistics()
8256 void trackStatistics() const override {
8257 if (isAssumedReadNone())
8258 STATS_DECLTRACK_CS_ATTR(readnone)
8259 else if (isAssumedReadOnly())
8260 STATS_DECLTRACK_CS_ATTR(readonly)
8261 else if (isAssumedWriteOnly())
8262 STATS_DECLTRACK_CS_ATTR(writeonly)
8263 }
8264};
8265
8266ChangeStatus AAMemoryBehaviorFunction::updateImpl(Attributor &A) {
8267
8268 // The current assumed state used to determine a change.
8269 auto AssumedState = getAssumed();
8270
8271 auto CheckRWInst = [&](Instruction &I) {
8272 // If the instruction has an own memory behavior state, use it to restrict
8273 // the local state. No further analysis is required as the other memory
8274 // state is as optimistic as it gets.
8275 if (const auto *CB = dyn_cast<CallBase>(&I)) {
8276 const auto *MemBehaviorAA = A.getAAFor<AAMemoryBehavior>(
8278 if (MemBehaviorAA) {
8279 intersectAssumedBits(MemBehaviorAA->getAssumed());
8280 return !isAtFixpoint();
8281 }
8282 }
8283
8284 // Remove access kind modifiers if necessary.
8285 if (I.mayReadFromMemory())
8286 removeAssumedBits(NO_READS);
8287 if (I.mayWriteToMemory())
8288 removeAssumedBits(NO_WRITES);
8289 return !isAtFixpoint();
8290 };
8291
8292 bool UsedAssumedInformation = false;
8293 if (!A.checkForAllReadWriteInstructions(CheckRWInst, *this,
8294 UsedAssumedInformation))
8295 return indicatePessimisticFixpoint();
8296
8297 return (AssumedState != getAssumed()) ? ChangeStatus::CHANGED
8299}
8300
8301ChangeStatus AAMemoryBehaviorFloating::updateImpl(Attributor &A) {
8302
8303 const IRPosition &IRP = getIRPosition();
8304 const IRPosition &FnPos = IRPosition::function_scope(IRP);
8305 AAMemoryBehavior::StateType &S = getState();
8306
8307 // First, check the function scope. We take the known information and we avoid
8308 // work if the assumed information implies the current assumed information for
8309 // this attribute. This is a valid for all but byval arguments.
8310 Argument *Arg = IRP.getAssociatedArgument();
8311 AAMemoryBehavior::base_t FnMemAssumedState =
8313 if (!Arg || !Arg->hasByValAttr()) {
8314 const auto *FnMemAA =
8315 A.getAAFor<AAMemoryBehavior>(*this, FnPos, DepClassTy::OPTIONAL);
8316 if (FnMemAA) {
8317 FnMemAssumedState = FnMemAA->getAssumed();
8318 S.addKnownBits(FnMemAA->getKnown());
8319 if ((S.getAssumed() & FnMemAA->getAssumed()) == S.getAssumed())
8321 }
8322 }
8323
8324 // The current assumed state used to determine a change.
8325 auto AssumedState = S.getAssumed();
8326
8327 // Make sure the value is not captured (except through "return"), if
8328 // it is, any information derived would be irrelevant anyway as we cannot
8329 // check the potential aliases introduced by the capture. However, no need
8330 // to fall back to anythign less optimistic than the function state.
8331 bool IsKnownNoCapture;
8332 const AANoCapture *ArgNoCaptureAA = nullptr;
8333 bool IsAssumedNoCapture = AA::hasAssumedIRAttr<Attribute::Captures>(
8334 A, this, IRP, DepClassTy::OPTIONAL, IsKnownNoCapture, false,
8335 &ArgNoCaptureAA);
8336
8337 if (!IsAssumedNoCapture &&
8338 (!ArgNoCaptureAA || !ArgNoCaptureAA->isAssumedNoCaptureMaybeReturned())) {
8339 S.intersectAssumedBits(FnMemAssumedState);
8340 return (AssumedState != getAssumed()) ? ChangeStatus::CHANGED
8342 }
8343
8344 // Visit and expand uses until all are analyzed or a fixpoint is reached.
8345 auto UsePred = [&](const Use &U, bool &Follow) -> bool {
8346 Instruction *UserI = cast<Instruction>(U.getUser());
8347 LLVM_DEBUG(dbgs() << "[AAMemoryBehavior] Use: " << *U << " in " << *UserI
8348 << " \n");
8349
8350 // Droppable users, e.g., llvm::assume does not actually perform any action.
8351 if (UserI->isDroppable())
8352 return true;
8353
8354 // Check if the users of UserI should also be visited.
8355 Follow = followUsersOfUseIn(A, U, UserI);
8356
8357 // If UserI might touch memory we analyze the use in detail.
8358 if (UserI->mayReadOrWriteMemory())
8359 analyzeUseIn(A, U, UserI);
8360
8361 return !isAtFixpoint();
8362 };
8363
8364 if (!A.checkForAllUses(UsePred, *this, getAssociatedValue()))
8365 return indicatePessimisticFixpoint();
8366
8367 return (AssumedState != getAssumed()) ? ChangeStatus::CHANGED
8369}
8370
8371bool AAMemoryBehaviorFloating::followUsersOfUseIn(Attributor &A, const Use &U,
8372 const Instruction *UserI) {
8373 // The loaded value is unrelated to the pointer argument, no need to
8374 // follow the users of the load.
8375 if (isa<LoadInst>(UserI) || isa<ReturnInst>(UserI))
8376 return false;
8377
8378 // By default we follow all uses assuming UserI might leak information on U,
8379 // we have special handling for call sites operands though.
8380 const auto *CB = dyn_cast<CallBase>(UserI);
8381 if (!CB || !CB->isArgOperand(&U))
8382 return true;
8383
8384 // If the use is a call argument known not to be captured, the users of
8385 // the call do not need to be visited because they have to be unrelated to
8386 // the input. Note that this check is not trivial even though we disallow
8387 // general capturing of the underlying argument. The reason is that the
8388 // call might the argument "through return", which we allow and for which we
8389 // need to check call users.
8390 if (U.get()->getType()->isPointerTy()) {
8391 unsigned ArgNo = CB->getArgOperandNo(&U);
8392 bool IsKnownNoCapture;
8394 A, this, IRPosition::callsite_argument(*CB, ArgNo),
8395 DepClassTy::OPTIONAL, IsKnownNoCapture);
8396 }
8397
8398 return true;
8399}
8400
8401void AAMemoryBehaviorFloating::analyzeUseIn(Attributor &A, const Use &U,
8402 const Instruction *UserI) {
8403 assert(UserI->mayReadOrWriteMemory());
8404
8405 switch (UserI->getOpcode()) {
8406 default:
8407 // TODO: Handle all atomics and other side-effect operations we know of.
8408 break;
8409 case Instruction::Load:
8410 // Loads cause the NO_READS property to disappear.
8411 removeAssumedBits(NO_READS);
8412 return;
8413
8414 case Instruction::Store:
8415 // Stores cause the NO_WRITES property to disappear if the use is the
8416 // pointer operand. Note that while capturing was taken care of somewhere
8417 // else we need to deal with stores of the value that is not looked through.
8418 if (cast<StoreInst>(UserI)->getPointerOperand() == U.get())
8419 removeAssumedBits(NO_WRITES);
8420 else
8421 indicatePessimisticFixpoint();
8422 return;
8423
8424 case Instruction::Call:
8425 case Instruction::CallBr:
8426 case Instruction::Invoke: {
8427 // For call sites we look at the argument memory behavior attribute (this
8428 // could be recursive!) in order to restrict our own state.
8429 const auto *CB = cast<CallBase>(UserI);
8430
8431 // Give up on operand bundles.
8432 if (CB->isBundleOperand(&U)) {
8433 indicatePessimisticFixpoint();
8434 return;
8435 }
8436
8437 // Calling a function does read the function pointer, maybe write it if the
8438 // function is self-modifying.
8439 if (CB->isCallee(&U)) {
8440 removeAssumedBits(NO_READS);
8441 break;
8442 }
8443
8444 // Adjust the possible access behavior based on the information on the
8445 // argument.
8446 IRPosition Pos;
8447 if (U.get()->getType()->isPointerTy())
8449 else
8451 const auto *MemBehaviorAA =
8452 A.getAAFor<AAMemoryBehavior>(*this, Pos, DepClassTy::OPTIONAL);
8453 if (!MemBehaviorAA)
8454 break;
8455 // "assumed" has at most the same bits as the MemBehaviorAA assumed
8456 // and at least "known".
8457 intersectAssumedBits(MemBehaviorAA->getAssumed());
8458 return;
8459 }
8460 };
8461
8462 // Generally, look at the "may-properties" and adjust the assumed state if we
8463 // did not trigger special handling before.
8464 if (UserI->mayReadFromMemory())
8465 removeAssumedBits(NO_READS);
8466 if (UserI->mayWriteToMemory())
8467 removeAssumedBits(NO_WRITES);
8468}
8469} // namespace
8470
8471/// -------------------- Memory Locations Attributes ---------------------------
8472/// Includes read-none, argmemonly, inaccessiblememonly,
8473/// inaccessiblememorargmemonly
8474/// ----------------------------------------------------------------------------
8475
8478 if (0 == (MLK & AAMemoryLocation::NO_LOCATIONS))
8479 return "all memory";
8481 return "no memory";
8482 std::string S = "memory:";
8483 if (0 == (MLK & AAMemoryLocation::NO_LOCAL_MEM))
8484 S += "stack,";
8485 if (0 == (MLK & AAMemoryLocation::NO_CONST_MEM))
8486 S += "constant,";
8488 S += "internal global,";
8490 S += "external global,";
8491 if (0 == (MLK & AAMemoryLocation::NO_ARGUMENT_MEM))
8492 S += "argument,";
8494 S += "inaccessible,";
8495 if (0 == (MLK & AAMemoryLocation::NO_MALLOCED_MEM))
8496 S += "malloced,";
8497 if (0 == (MLK & AAMemoryLocation::NO_UNKOWN_MEM))
8498 S += "unknown,";
8499 S.pop_back();
8500 return S;
8501}
8502
8503namespace {
8504struct AAMemoryLocationImpl : public AAMemoryLocation {
8505
8506 AAMemoryLocationImpl(const IRPosition &IRP, Attributor &A)
8507 : AAMemoryLocation(IRP, A), Allocator(A.Allocator) {
8508 AccessKind2Accesses.fill(nullptr);
8509 }
8510
8511 ~AAMemoryLocationImpl() override {
8512 // The AccessSets are allocated via a BumpPtrAllocator, we call
8513 // the destructor manually.
8514 for (AccessSet *AS : AccessKind2Accesses)
8515 if (AS)
8516 AS->~AccessSet();
8517 }
8518
8519 /// See AbstractAttribute::initialize(...).
8520 void initialize(Attributor &A) override {
8521 intersectAssumedBits(BEST_STATE);
8522 getKnownStateFromValue(A, getIRPosition(), getState());
8523 AAMemoryLocation::initialize(A);
8524 }
8525
8526 /// Return the memory behavior information encoded in the IR for \p IRP.
8527 static void getKnownStateFromValue(Attributor &A, const IRPosition &IRP,
8528 BitIntegerState &State,
8529 bool IgnoreSubsumingPositions = false) {
8530 // For internal functions we ignore `argmemonly` and
8531 // `inaccessiblememorargmemonly` as we might break it via interprocedural
8532 // constant propagation. It is unclear if this is the best way but it is
8533 // unlikely this will cause real performance problems. If we are deriving
8534 // attributes for the anchor function we even remove the attribute in
8535 // addition to ignoring it.
8536 // TODO: A better way to handle this would be to add ~NO_GLOBAL_MEM /
8537 // MemoryEffects::Other as a possible location.
8538 bool UseArgMemOnly = true;
8539 Function *AnchorFn = IRP.getAnchorScope();
8540 if (AnchorFn && A.isRunOn(*AnchorFn))
8541 UseArgMemOnly = !AnchorFn->hasLocalLinkage();
8542
8544 A.getAttrs(IRP, {Attribute::Memory}, Attrs, IgnoreSubsumingPositions);
8545 for (const Attribute &Attr : Attrs) {
8546 // TODO: We can map MemoryEffects to Attributor locations more precisely.
8547 MemoryEffects ME = Attr.getMemoryEffects();
8548 if (ME.doesNotAccessMemory()) {
8549 State.addKnownBits(NO_LOCAL_MEM | NO_CONST_MEM);
8550 continue;
8551 }
8552 if (ME.onlyAccessesInaccessibleMem()) {
8553 State.addKnownBits(inverseLocation(NO_INACCESSIBLE_MEM, true, true));
8554 continue;
8555 }
8556 if (ME.onlyAccessesArgPointees()) {
8557 if (UseArgMemOnly)
8558 State.addKnownBits(inverseLocation(NO_ARGUMENT_MEM, true, true));
8559 else {
8560 // Remove location information, only keep read/write info.
8561 ME = MemoryEffects(ME.getModRef());
8562 A.manifestAttrs(IRP,
8563 Attribute::getWithMemoryEffects(
8564 IRP.getAnchorValue().getContext(), ME),
8565 /*ForceReplace*/ true);
8566 }
8567 continue;
8568 }
8570 if (UseArgMemOnly)
8571 State.addKnownBits(inverseLocation(
8572 NO_INACCESSIBLE_MEM | NO_ARGUMENT_MEM, true, true));
8573 else {
8574 // Remove location information, only keep read/write info.
8575 ME = MemoryEffects(ME.getModRef());
8576 A.manifestAttrs(IRP,
8577 Attribute::getWithMemoryEffects(
8578 IRP.getAnchorValue().getContext(), ME),
8579 /*ForceReplace*/ true);
8580 }
8581 continue;
8582 }
8583 }
8584 }
8585
8586 /// See AbstractAttribute::getDeducedAttributes(...).
8587 void getDeducedAttributes(Attributor &A, LLVMContext &Ctx,
8588 SmallVectorImpl<Attribute> &Attrs) const override {
8589 // TODO: We can map Attributor locations to MemoryEffects more precisely.
8590 assert(Attrs.size() == 0);
8591 if (getIRPosition().getPositionKind() == IRPosition::IRP_FUNCTION) {
8592 if (isAssumedReadNone())
8593 Attrs.push_back(
8594 Attribute::getWithMemoryEffects(Ctx, MemoryEffects::none()));
8595 else if (isAssumedInaccessibleMemOnly())
8596 Attrs.push_back(Attribute::getWithMemoryEffects(
8598 else if (isAssumedArgMemOnly())
8599 Attrs.push_back(
8600 Attribute::getWithMemoryEffects(Ctx, MemoryEffects::argMemOnly()));
8601 else if (isAssumedInaccessibleOrArgMemOnly())
8602 Attrs.push_back(Attribute::getWithMemoryEffects(
8604 }
8605 assert(Attrs.size() <= 1);
8606 }
8607
8608 /// See AbstractAttribute::manifest(...).
8609 ChangeStatus manifest(Attributor &A) override {
8610 // TODO: If AAMemoryLocation and AAMemoryBehavior are merged, we could
8611 // provide per-location modref information here.
8612 const IRPosition &IRP = getIRPosition();
8613
8614 SmallVector<Attribute, 1> DeducedAttrs;
8615 getDeducedAttributes(A, IRP.getAnchorValue().getContext(), DeducedAttrs);
8616 if (DeducedAttrs.size() != 1)
8617 return ChangeStatus::UNCHANGED;
8618 MemoryEffects ME = DeducedAttrs[0].getMemoryEffects();
8619
8620 return A.manifestAttrs(IRP, Attribute::getWithMemoryEffects(
8621 IRP.getAnchorValue().getContext(), ME));
8622 }
8623
8624 /// See AAMemoryLocation::checkForAllAccessesToMemoryKind(...).
8625 bool checkForAllAccessesToMemoryKind(
8626 function_ref<bool(const Instruction *, const Value *, AccessKind,
8627 MemoryLocationsKind)>
8628 Pred,
8629 MemoryLocationsKind RequestedMLK) const override {
8630 if (!isValidState())
8631 return false;
8632
8633 MemoryLocationsKind AssumedMLK = getAssumedNotAccessedLocation();
8634 if (AssumedMLK == NO_LOCATIONS)
8635 return true;
8636
8637 unsigned Idx = 0;
8638 for (MemoryLocationsKind CurMLK = 1; CurMLK < NO_LOCATIONS;
8639 CurMLK *= 2, ++Idx) {
8640 if (CurMLK & RequestedMLK)
8641 continue;
8642
8643 if (const AccessSet *Accesses = AccessKind2Accesses[Idx])
8644 for (const AccessInfo &AI : *Accesses)
8645 if (!Pred(AI.I, AI.Ptr, AI.Kind, CurMLK))
8646 return false;
8647 }
8648
8649 return true;
8650 }
8651
8652 ChangeStatus indicatePessimisticFixpoint() override {
8653 // If we give up and indicate a pessimistic fixpoint this instruction will
8654 // become an access for all potential access kinds:
8655 // TODO: Add pointers for argmemonly and globals to improve the results of
8656 // checkForAllAccessesToMemoryKind.
8657 bool Changed = false;
8658 MemoryLocationsKind KnownMLK = getKnown();
8659 Instruction *I = dyn_cast<Instruction>(&getAssociatedValue());
8660 for (MemoryLocationsKind CurMLK = 1; CurMLK < NO_LOCATIONS; CurMLK *= 2)
8661 if (!(CurMLK & KnownMLK))
8662 updateStateAndAccessesMap(getState(), CurMLK, I, nullptr, Changed,
8663 getAccessKindFromInst(I));
8664 return AAMemoryLocation::indicatePessimisticFixpoint();
8665 }
8666
8667protected:
8668 /// Helper struct to tie together an instruction that has a read or write
8669 /// effect with the pointer it accesses (if any).
8670 struct AccessInfo {
8671
8672 /// The instruction that caused the access.
8673 const Instruction *I;
8674
8675 /// The base pointer that is accessed, or null if unknown.
8676 const Value *Ptr;
8677
8678 /// The kind of access (read/write/read+write).
8680
8681 bool operator==(const AccessInfo &RHS) const {
8682 return I == RHS.I && Ptr == RHS.Ptr && Kind == RHS.Kind;
8683 }
8684 bool operator()(const AccessInfo &LHS, const AccessInfo &RHS) const {
8685 if (LHS.I != RHS.I)
8686 return LHS.I < RHS.I;
8687 if (LHS.Ptr != RHS.Ptr)
8688 return LHS.Ptr < RHS.Ptr;
8689 if (LHS.Kind != RHS.Kind)
8690 return LHS.Kind < RHS.Kind;
8691 return false;
8692 }
8693 };
8694
8695 /// Mapping from *single* memory location kinds, e.g., LOCAL_MEM with the
8696 /// value of NO_LOCAL_MEM, to the accesses encountered for this memory kind.
8697 using AccessSet = SmallSet<AccessInfo, 2, AccessInfo>;
8698 std::array<AccessSet *, llvm::ConstantLog2<VALID_STATE>()>
8699 AccessKind2Accesses;
8700
8701 /// Categorize the pointer arguments of CB that might access memory in
8702 /// AccessedLoc and update the state and access map accordingly.
8703 void
8704 categorizeArgumentPointerLocations(Attributor &A, CallBase &CB,
8705 AAMemoryLocation::StateType &AccessedLocs,
8706 bool &Changed);
8707
8708 /// Return the kind(s) of location that may be accessed by \p V.
8710 categorizeAccessedLocations(Attributor &A, Instruction &I, bool &Changed);
8711
8712 /// Return the access kind as determined by \p I.
8713 AccessKind getAccessKindFromInst(const Instruction *I) {
8714 AccessKind AK = READ_WRITE;
8715 if (I) {
8716 AK = I->mayReadFromMemory() ? READ : NONE;
8717 AK = AccessKind(AK | (I->mayWriteToMemory() ? WRITE : NONE));
8718 }
8719 return AK;
8720 }
8721
8722 /// Update the state \p State and the AccessKind2Accesses given that \p I is
8723 /// an access of kind \p AK to a \p MLK memory location with the access
8724 /// pointer \p Ptr.
8725 void updateStateAndAccessesMap(AAMemoryLocation::StateType &State,
8726 MemoryLocationsKind MLK, const Instruction *I,
8727 const Value *Ptr, bool &Changed,
8728 AccessKind AK = READ_WRITE) {
8729
8730 assert(isPowerOf2_32(MLK) && "Expected a single location set!");
8731 auto *&Accesses = AccessKind2Accesses[llvm::Log2_32(MLK)];
8732 if (!Accesses)
8733 Accesses = new (Allocator) AccessSet();
8734 Changed |= Accesses->insert(AccessInfo{I, Ptr, AK}).second;
8735 if (MLK == NO_UNKOWN_MEM)
8736 MLK = NO_LOCATIONS;
8737 State.removeAssumedBits(MLK);
8738 }
8739
8740 /// Determine the underlying locations kinds for \p Ptr, e.g., globals or
8741 /// arguments, and update the state and access map accordingly.
8742 void categorizePtrValue(Attributor &A, const Instruction &I, const Value &Ptr,
8743 AAMemoryLocation::StateType &State, bool &Changed,
8744 unsigned AccessAS = 0);
8745
8746 /// Used to allocate access sets.
8748};
8749
8750void AAMemoryLocationImpl::categorizePtrValue(
8751 Attributor &A, const Instruction &I, const Value &Ptr,
8752 AAMemoryLocation::StateType &State, bool &Changed, unsigned AccessAS) {
8753 LLVM_DEBUG(dbgs() << "[AAMemoryLocation] Categorize pointer locations for "
8754 << Ptr << " ["
8755 << getMemoryLocationsAsStr(State.getAssumed()) << "]\n");
8756
8757 auto Pred = [&](Value &Obj) {
8758 unsigned ObjectAS = Obj.getType()->getPointerAddressSpace();
8759 // TODO: recognize the TBAA used for constant accesses.
8760 MemoryLocationsKind MLK = NO_LOCATIONS;
8761
8762 // Filter accesses to constant (GPU) memory if we have an AS at the access
8763 // site or the object is known to actually have the associated AS.
8764 if (AA::isGPU(A.getModule())) {
8765 if (AA::isGPUConstantAddressSpace(A.getModule(), AccessAS) ||
8766 (AA::isGPUConstantAddressSpace(A.getModule(), ObjectAS) &&
8767 isIdentifiedObject(&Obj)))
8768 return true;
8769 }
8770
8771 if (isa<UndefValue>(&Obj))
8772 return true;
8773 if (isa<Argument>(&Obj)) {
8774 // TODO: For now we do not treat byval arguments as local copies performed
8775 // on the call edge, though, we should. To make that happen we need to
8776 // teach various passes, e.g., DSE, about the copy effect of a byval. That
8777 // would also allow us to mark functions only accessing byval arguments as
8778 // readnone again, arguably their accesses have no effect outside of the
8779 // function, like accesses to allocas.
8780 MLK = NO_ARGUMENT_MEM;
8781 } else if (auto *GV = dyn_cast<GlobalValue>(&Obj)) {
8782 // Reading constant memory is not treated as a read "effect" by the
8783 // function attr pass so we won't neither. Constants defined by TBAA are
8784 // similar. (We know we do not write it because it is constant.)
8785 if (auto *GVar = dyn_cast<GlobalVariable>(GV))
8786 if (GVar->isConstant())
8787 return true;
8788
8789 if (GV->hasLocalLinkage())
8790 MLK = NO_GLOBAL_INTERNAL_MEM;
8791 else
8792 MLK = NO_GLOBAL_EXTERNAL_MEM;
8793 } else if (isa<ConstantPointerNull>(&Obj) &&
8794 (!NullPointerIsDefined(getAssociatedFunction(), AccessAS) ||
8795 !NullPointerIsDefined(getAssociatedFunction(), ObjectAS))) {
8796 return true;
8797 } else if (isa<AllocaInst>(&Obj)) {
8798 MLK = NO_LOCAL_MEM;
8799 } else if (const auto *CB = dyn_cast<CallBase>(&Obj)) {
8800 bool IsKnownNoAlias;
8803 IsKnownNoAlias))
8804 MLK = NO_MALLOCED_MEM;
8805 else
8806 MLK = NO_UNKOWN_MEM;
8807 } else {
8808 MLK = NO_UNKOWN_MEM;
8809 }
8810
8811 assert(MLK != NO_LOCATIONS && "No location specified!");
8812 LLVM_DEBUG(dbgs() << "[AAMemoryLocation] Ptr value can be categorized: "
8813 << Obj << " -> " << getMemoryLocationsAsStr(MLK) << "\n");
8814 updateStateAndAccessesMap(State, MLK, &I, &Obj, Changed,
8815 getAccessKindFromInst(&I));
8816
8817 return true;
8818 };
8819
8820 const auto *AA = A.getAAFor<AAUnderlyingObjects>(
8822 if (!AA || !AA->forallUnderlyingObjects(Pred, AA::Intraprocedural)) {
8823 LLVM_DEBUG(
8824 dbgs() << "[AAMemoryLocation] Pointer locations not categorized\n");
8825 updateStateAndAccessesMap(State, NO_UNKOWN_MEM, &I, nullptr, Changed,
8826 getAccessKindFromInst(&I));
8827 return;
8828 }
8829
8830 LLVM_DEBUG(
8831 dbgs() << "[AAMemoryLocation] Accessed locations with pointer locations: "
8832 << getMemoryLocationsAsStr(State.getAssumed()) << "\n");
8833}
8834
8835void AAMemoryLocationImpl::categorizeArgumentPointerLocations(
8836 Attributor &A, CallBase &CB, AAMemoryLocation::StateType &AccessedLocs,
8837 bool &Changed) {
8838 for (unsigned ArgNo = 0, E = CB.arg_size(); ArgNo < E; ++ArgNo) {
8839
8840 // Skip non-pointer arguments.
8841 const Value *ArgOp = CB.getArgOperand(ArgNo);
8842 if (!ArgOp->getType()->isPtrOrPtrVectorTy())
8843 continue;
8844
8845 // Skip readnone arguments.
8846 const IRPosition &ArgOpIRP = IRPosition::callsite_argument(CB, ArgNo);
8847 const auto *ArgOpMemLocationAA =
8848 A.getAAFor<AAMemoryBehavior>(*this, ArgOpIRP, DepClassTy::OPTIONAL);
8849
8850 if (ArgOpMemLocationAA && ArgOpMemLocationAA->isAssumedReadNone())
8851 continue;
8852
8853 // Categorize potentially accessed pointer arguments as if there was an
8854 // access instruction with them as pointer.
8855 categorizePtrValue(A, CB, *ArgOp, AccessedLocs, Changed);
8856 }
8857}
8858
8860AAMemoryLocationImpl::categorizeAccessedLocations(Attributor &A, Instruction &I,
8861 bool &Changed) {
8862 LLVM_DEBUG(dbgs() << "[AAMemoryLocation] Categorize accessed locations for "
8863 << I << "\n");
8864
8865 AAMemoryLocation::StateType AccessedLocs;
8866 AccessedLocs.intersectAssumedBits(NO_LOCATIONS);
8867
8868 if (auto *CB = dyn_cast<CallBase>(&I)) {
8869
8870 // First check if we assume any memory is access is visible.
8871 const auto *CBMemLocationAA = A.getAAFor<AAMemoryLocation>(
8873 LLVM_DEBUG(dbgs() << "[AAMemoryLocation] Categorize call site: " << I
8874 << " [" << CBMemLocationAA << "]\n");
8875 if (!CBMemLocationAA) {
8876 updateStateAndAccessesMap(AccessedLocs, NO_UNKOWN_MEM, &I, nullptr,
8877 Changed, getAccessKindFromInst(&I));
8878 return NO_UNKOWN_MEM;
8879 }
8880
8881 if (CBMemLocationAA->isAssumedReadNone())
8882 return NO_LOCATIONS;
8883
8884 if (CBMemLocationAA->isAssumedInaccessibleMemOnly()) {
8885 updateStateAndAccessesMap(AccessedLocs, NO_INACCESSIBLE_MEM, &I, nullptr,
8886 Changed, getAccessKindFromInst(&I));
8887 return AccessedLocs.getAssumed();
8888 }
8889
8890 uint32_t CBAssumedNotAccessedLocs =
8891 CBMemLocationAA->getAssumedNotAccessedLocation();
8892
8893 // Set the argmemonly and global bit as we handle them separately below.
8894 uint32_t CBAssumedNotAccessedLocsNoArgMem =
8895 CBAssumedNotAccessedLocs | NO_ARGUMENT_MEM | NO_GLOBAL_MEM;
8896
8897 for (MemoryLocationsKind CurMLK = 1; CurMLK < NO_LOCATIONS; CurMLK *= 2) {
8898 if (CBAssumedNotAccessedLocsNoArgMem & CurMLK)
8899 continue;
8900 updateStateAndAccessesMap(AccessedLocs, CurMLK, &I, nullptr, Changed,
8901 getAccessKindFromInst(&I));
8902 }
8903
8904 // Now handle global memory if it might be accessed. This is slightly tricky
8905 // as NO_GLOBAL_MEM has multiple bits set.
8906 bool HasGlobalAccesses = ((~CBAssumedNotAccessedLocs) & NO_GLOBAL_MEM);
8907 if (HasGlobalAccesses) {
8908 auto AccessPred = [&](const Instruction *, const Value *Ptr,
8909 AccessKind Kind, MemoryLocationsKind MLK) {
8910 updateStateAndAccessesMap(AccessedLocs, MLK, &I, Ptr, Changed,
8911 getAccessKindFromInst(&I));
8912 return true;
8913 };
8914 if (!CBMemLocationAA->checkForAllAccessesToMemoryKind(
8915 AccessPred, inverseLocation(NO_GLOBAL_MEM, false, false)))
8916 return AccessedLocs.getWorstState();
8917 }
8918
8919 LLVM_DEBUG(
8920 dbgs() << "[AAMemoryLocation] Accessed state before argument handling: "
8921 << getMemoryLocationsAsStr(AccessedLocs.getAssumed()) << "\n");
8922
8923 // Now handle argument memory if it might be accessed.
8924 bool HasArgAccesses = ((~CBAssumedNotAccessedLocs) & NO_ARGUMENT_MEM);
8925 if (HasArgAccesses)
8926 categorizeArgumentPointerLocations(A, *CB, AccessedLocs, Changed);
8927
8928 LLVM_DEBUG(
8929 dbgs() << "[AAMemoryLocation] Accessed state after argument handling: "
8930 << getMemoryLocationsAsStr(AccessedLocs.getAssumed()) << "\n");
8931
8932 return AccessedLocs.getAssumed();
8933 }
8934
8935 if (const Value *Ptr = getPointerOperand(&I, /* AllowVolatile */ true)) {
8936 LLVM_DEBUG(
8937 dbgs() << "[AAMemoryLocation] Categorize memory access with pointer: "
8938 << I << " [" << *Ptr << "]\n");
8939 categorizePtrValue(A, I, *Ptr, AccessedLocs, Changed,
8940 Ptr->getType()->getPointerAddressSpace());
8941 return AccessedLocs.getAssumed();
8942 }
8943
8944 LLVM_DEBUG(dbgs() << "[AAMemoryLocation] Failed to categorize instruction: "
8945 << I << "\n");
8946 updateStateAndAccessesMap(AccessedLocs, NO_UNKOWN_MEM, &I, nullptr, Changed,
8947 getAccessKindFromInst(&I));
8948 return AccessedLocs.getAssumed();
8949}
8950
8951/// An AA to represent the memory behavior function attributes.
8952struct AAMemoryLocationFunction final : public AAMemoryLocationImpl {
8953 AAMemoryLocationFunction(const IRPosition &IRP, Attributor &A)
8954 : AAMemoryLocationImpl(IRP, A) {}
8955
8956 /// See AbstractAttribute::updateImpl(Attributor &A).
8957 ChangeStatus updateImpl(Attributor &A) override {
8958
8959 const auto *MemBehaviorAA =
8960 A.getAAFor<AAMemoryBehavior>(*this, getIRPosition(), DepClassTy::NONE);
8961 if (MemBehaviorAA && MemBehaviorAA->isAssumedReadNone()) {
8962 if (MemBehaviorAA->isKnownReadNone())
8963 return indicateOptimisticFixpoint();
8965 "AAMemoryLocation was not read-none but AAMemoryBehavior was!");
8966 A.recordDependence(*MemBehaviorAA, *this, DepClassTy::OPTIONAL);
8967 return ChangeStatus::UNCHANGED;
8968 }
8969
8970 // The current assumed state used to determine a change.
8971 auto AssumedState = getAssumed();
8972 bool Changed = false;
8973
8974 auto CheckRWInst = [&](Instruction &I) {
8975 MemoryLocationsKind MLK = categorizeAccessedLocations(A, I, Changed);
8976 LLVM_DEBUG(dbgs() << "[AAMemoryLocation] Accessed locations for " << I
8977 << ": " << getMemoryLocationsAsStr(MLK) << "\n");
8978 removeAssumedBits(inverseLocation(MLK, false, false));
8979 // Stop once only the valid bit set in the *not assumed location*, thus
8980 // once we don't actually exclude any memory locations in the state.
8981 return getAssumedNotAccessedLocation() != VALID_STATE;
8982 };
8983
8984 bool UsedAssumedInformation = false;
8985 if (!A.checkForAllReadWriteInstructions(CheckRWInst, *this,
8986 UsedAssumedInformation))
8987 return indicatePessimisticFixpoint();
8988
8989 Changed |= AssumedState != getAssumed();
8990 return Changed ? ChangeStatus::CHANGED : ChangeStatus::UNCHANGED;
8991 }
8992
8993 /// See AbstractAttribute::trackStatistics()
8994 void trackStatistics() const override {
8995 if (isAssumedReadNone())
8996 STATS_DECLTRACK_FN_ATTR(readnone)
8997 else if (isAssumedArgMemOnly())
8998 STATS_DECLTRACK_FN_ATTR(argmemonly)
8999 else if (isAssumedInaccessibleMemOnly())
9000 STATS_DECLTRACK_FN_ATTR(inaccessiblememonly)
9001 else if (isAssumedInaccessibleOrArgMemOnly())
9002 STATS_DECLTRACK_FN_ATTR(inaccessiblememorargmemonly)
9003 }
9004};
9005
9006/// AAMemoryLocation attribute for call sites.
9007struct AAMemoryLocationCallSite final : AAMemoryLocationImpl {
9008 AAMemoryLocationCallSite(const IRPosition &IRP, Attributor &A)
9009 : AAMemoryLocationImpl(IRP, A) {}
9010
9011 /// See AbstractAttribute::updateImpl(...).
9012 ChangeStatus updateImpl(Attributor &A) override {
9013 // TODO: Once we have call site specific value information we can provide
9014 // call site specific liveness liveness information and then it makes
9015 // sense to specialize attributes for call sites arguments instead of
9016 // redirecting requests to the callee argument.
9017 Function *F = getAssociatedFunction();
9018 const IRPosition &FnPos = IRPosition::function(*F);
9019 auto *FnAA =
9020 A.getAAFor<AAMemoryLocation>(*this, FnPos, DepClassTy::REQUIRED);
9021 if (!FnAA)
9022 return indicatePessimisticFixpoint();
9023 bool Changed = false;
9024 auto AccessPred = [&](const Instruction *I, const Value *Ptr,
9025 AccessKind Kind, MemoryLocationsKind MLK) {
9026 updateStateAndAccessesMap(getState(), MLK, I, Ptr, Changed,
9027 getAccessKindFromInst(I));
9028 return true;
9029 };
9030 if (!FnAA->checkForAllAccessesToMemoryKind(AccessPred, ALL_LOCATIONS))
9031 return indicatePessimisticFixpoint();
9032 return Changed ? ChangeStatus::CHANGED : ChangeStatus::UNCHANGED;
9033 }
9034
9035 /// See AbstractAttribute::trackStatistics()
9036 void trackStatistics() const override {
9037 if (isAssumedReadNone())
9038 STATS_DECLTRACK_CS_ATTR(readnone)
9039 }
9040};
9041} // namespace
9042
9043/// ------------------ denormal-fp-math Attribute -------------------------
9044
9045namespace {
9046struct AADenormalFPMathImpl : public AADenormalFPMath {
9047 AADenormalFPMathImpl(const IRPosition &IRP, Attributor &A)
9048 : AADenormalFPMath(IRP, A) {}
9049
9050 const std::string getAsStr(Attributor *A) const override {
9051 std::string Str("AADenormalFPMath[");
9052 raw_string_ostream OS(Str);
9053
9054 DenormalState Known = getKnown();
9055 if (Known.Mode.isValid())
9056 OS << "denormal-fp-math=" << Known.Mode;
9057 else
9058 OS << "invalid";
9059
9060 if (Known.ModeF32.isValid())
9061 OS << " denormal-fp-math-f32=" << Known.ModeF32;
9062 OS << ']';
9063 return Str;
9064 }
9065};
9066
9067struct AADenormalFPMathFunction final : AADenormalFPMathImpl {
9068 AADenormalFPMathFunction(const IRPosition &IRP, Attributor &A)
9069 : AADenormalFPMathImpl(IRP, A) {}
9070
9071 void initialize(Attributor &A) override {
9072 const Function *F = getAnchorScope();
9073 DenormalFPEnv DenormEnv = F->getDenormalFPEnv();
9074
9075 Known = DenormalState{DenormEnv.DefaultMode, DenormEnv.F32Mode};
9076 if (isModeFixed())
9077 indicateFixpoint();
9078 }
9079
9080 ChangeStatus updateImpl(Attributor &A) override {
9081 ChangeStatus Change = ChangeStatus::UNCHANGED;
9082
9083 auto CheckCallSite = [=, &Change, &A](AbstractCallSite CS) {
9084 Function *Caller = CS.getInstruction()->getFunction();
9085 LLVM_DEBUG(dbgs() << "[AADenormalFPMath] Call " << Caller->getName()
9086 << "->" << getAssociatedFunction()->getName() << '\n');
9087
9088 const auto *CallerInfo = A.getAAFor<AADenormalFPMath>(
9089 *this, IRPosition::function(*Caller), DepClassTy::REQUIRED);
9090 if (!CallerInfo)
9091 return false;
9092
9093 Change = Change | clampStateAndIndicateChange(this->getState(),
9094 CallerInfo->getState());
9095 return true;
9096 };
9097
9098 bool AllCallSitesKnown = true;
9099 if (!A.checkForAllCallSites(CheckCallSite, *this, true, AllCallSitesKnown))
9100 return indicatePessimisticFixpoint();
9101
9102 if (Change == ChangeStatus::CHANGED && isModeFixed())
9103 indicateFixpoint();
9104 return Change;
9105 }
9106
9107 ChangeStatus manifest(Attributor &A) override {
9108 LLVMContext &Ctx = getAssociatedFunction()->getContext();
9109
9110 SmallVector<Attribute, 2> AttrToAdd;
9112
9113 // TODO: Change to use DenormalFPEnv everywhere.
9114 DenormalFPEnv KnownEnv(Known.Mode, Known.ModeF32);
9115
9116 if (KnownEnv == DenormalFPEnv::getDefault()) {
9117 AttrToRemove.push_back(Attribute::DenormalFPEnv);
9118 } else {
9119 AttrToAdd.push_back(Attribute::get(
9120 Ctx, Attribute::DenormalFPEnv,
9121 DenormalFPEnv(Known.Mode, Known.ModeF32).toIntValue()));
9122 }
9123
9124 auto &IRP = getIRPosition();
9125
9126 // TODO: There should be a combined add and remove API.
9127 return A.removeAttrs(IRP, AttrToRemove) |
9128 A.manifestAttrs(IRP, AttrToAdd, /*ForceReplace=*/true);
9129 }
9130
9131 void trackStatistics() const override {
9132 STATS_DECLTRACK_FN_ATTR(denormal_fpenv)
9133 }
9134};
9135} // namespace
9136
9137/// ------------------ Value Constant Range Attribute -------------------------
9138
9139namespace {
9140struct AAValueConstantRangeImpl : AAValueConstantRange {
9141 using StateType = IntegerRangeState;
9142 AAValueConstantRangeImpl(const IRPosition &IRP, Attributor &A)
9143 : AAValueConstantRange(IRP, A) {}
9144
9145 /// See AbstractAttribute::initialize(..).
9146 void initialize(Attributor &A) override {
9147 if (A.hasSimplificationCallback(getIRPosition())) {
9148 indicatePessimisticFixpoint();
9149 return;
9150 }
9151
9152 // Intersect a range given by SCEV.
9153 intersectKnown(getConstantRangeFromSCEV(A, getCtxI()));
9154
9155 // Intersect a range given by LVI.
9156 intersectKnown(getConstantRangeFromLVI(A, getCtxI()));
9157 }
9158
9159 /// See AbstractAttribute::getAsStr().
9160 const std::string getAsStr(Attributor *A) const override {
9161 std::string Str;
9162 llvm::raw_string_ostream OS(Str);
9163 OS << "range(" << getBitWidth() << ")<";
9164 getKnown().print(OS);
9165 OS << " / ";
9166 getAssumed().print(OS);
9167 OS << ">";
9168 return Str;
9169 }
9170
9171 /// Helper function to get a SCEV expr for the associated value at program
9172 /// point \p I.
9173 const SCEV *getSCEV(Attributor &A, const Instruction *I = nullptr) const {
9174 if (!getAnchorScope())
9175 return nullptr;
9176
9177 ScalarEvolution *SE =
9178 A.getInfoCache().getAnalysisResultForFunction<ScalarEvolutionAnalysis>(
9179 *getAnchorScope());
9180
9181 LoopInfo *LI = A.getInfoCache().getAnalysisResultForFunction<LoopAnalysis>(
9182 *getAnchorScope());
9183
9184 if (!SE || !LI)
9185 return nullptr;
9186
9187 const SCEV *S = SE->getSCEV(&getAssociatedValue());
9188 if (!I)
9189 return S;
9190
9191 return SE->getSCEVAtScope(S, LI->getLoopFor(I->getParent()));
9192 }
9193
9194 /// Helper function to get a range from SCEV for the associated value at
9195 /// program point \p I.
9196 ConstantRange getConstantRangeFromSCEV(Attributor &A,
9197 const Instruction *I = nullptr) const {
9198 if (!getAnchorScope())
9199 return getWorstState(getBitWidth());
9200
9201 ScalarEvolution *SE =
9202 A.getInfoCache().getAnalysisResultForFunction<ScalarEvolutionAnalysis>(
9203 *getAnchorScope());
9204
9205 const SCEV *S = getSCEV(A, I);
9206 if (!SE || !S)
9207 return getWorstState(getBitWidth());
9208
9209 return SE->getUnsignedRange(S);
9210 }
9211
9212 /// Helper function to get a range from LVI for the associated value at
9213 /// program point \p I.
9214 ConstantRange
9215 getConstantRangeFromLVI(Attributor &A,
9216 const Instruction *CtxI = nullptr) const {
9217 if (!getAnchorScope())
9218 return getWorstState(getBitWidth());
9219
9220 LazyValueInfo *LVI =
9221 A.getInfoCache().getAnalysisResultForFunction<LazyValueAnalysis>(
9222 *getAnchorScope());
9223
9224 if (!LVI || !CtxI)
9225 return getWorstState(getBitWidth());
9226 return LVI->getConstantRange(&getAssociatedValue(),
9227 const_cast<Instruction *>(CtxI),
9228 /*UndefAllowed*/ false);
9229 }
9230
9231 /// Return true if \p CtxI is valid for querying outside analyses.
9232 /// This basically makes sure we do not ask intra-procedural analysis
9233 /// about a context in the wrong function or a context that violates
9234 /// dominance assumptions they might have. The \p AllowAACtxI flag indicates
9235 /// if the original context of this AA is OK or should be considered invalid.
9236 bool isValidCtxInstructionForOutsideAnalysis(Attributor &A,
9237 const Instruction *CtxI,
9238 bool AllowAACtxI) const {
9239 if (!CtxI || (!AllowAACtxI && CtxI == getCtxI()))
9240 return false;
9241
9242 // Our context might be in a different function, neither intra-procedural
9243 // analysis (ScalarEvolution nor LazyValueInfo) can handle that.
9244 if (!AA::isValidInScope(getAssociatedValue(), CtxI->getFunction()))
9245 return false;
9246
9247 // If the context is not dominated by the value there are paths to the
9248 // context that do not define the value. This cannot be handled by
9249 // LazyValueInfo so we need to bail.
9250 if (auto *I = dyn_cast<Instruction>(&getAssociatedValue())) {
9251 InformationCache &InfoCache = A.getInfoCache();
9252 const DominatorTree *DT =
9253 InfoCache.getAnalysisResultForFunction<DominatorTreeAnalysis>(
9254 *I->getFunction());
9255 return DT && DT->dominates(I, CtxI);
9256 }
9257
9258 return true;
9259 }
9260
9261 /// See AAValueConstantRange::getAssumedConstantRange(..).
9262 ConstantRange
9263 getAssumedConstantRange(Attributor &A,
9264 const Instruction *CtxI = nullptr) const override {
9265 // TODO: Make SCEV use Attributor assumption.
9266 // We may be able to bound a variable range via assumptions in
9267 // Attributor. ex.) If x is assumed to be in [1, 3] and y is known to
9268 // evolve to x^2 + x, then we can say that y is in [2, 12].
9269 if (!isValidCtxInstructionForOutsideAnalysis(A, CtxI,
9270 /* AllowAACtxI */ false))
9271 return getAssumed();
9272
9273 ConstantRange LVIR = getConstantRangeFromLVI(A, CtxI);
9274 ConstantRange SCEVR = getConstantRangeFromSCEV(A, CtxI);
9275 return getAssumed().intersectWith(SCEVR).intersectWith(LVIR);
9276 }
9277
9278 /// Helper function to create MDNode for range metadata.
9279 static MDNode *
9280 getMDNodeForConstantRange(Type *Ty, LLVMContext &Ctx,
9281 const ConstantRange &AssumedConstantRange) {
9282 Metadata *LowAndHigh[] = {ConstantAsMetadata::get(ConstantInt::get(
9283 Ty, AssumedConstantRange.getLower())),
9284 ConstantAsMetadata::get(ConstantInt::get(
9285 Ty, AssumedConstantRange.getUpper()))};
9286 return MDNode::get(Ctx, LowAndHigh);
9287 }
9288
9289 /// Return true if \p Assumed is included in ranges from instruction \p I.
9290 static bool isBetterRange(const ConstantRange &Assumed,
9291 const Instruction &I) {
9292 if (Assumed.isFullSet())
9293 return false;
9294
9295 std::optional<ConstantRange> Known;
9296
9297 if (const auto *CB = dyn_cast<CallBase>(&I)) {
9298 Known = CB->getRange();
9299 } else if (MDNode *KnownRanges = I.getMetadata(LLVMContext::MD_range)) {
9300 // If multiple ranges are annotated in IR, we give up to annotate assumed
9301 // range for now.
9302
9303 // TODO: If there exists a known range which containts assumed range, we
9304 // can say assumed range is better.
9305 if (KnownRanges->getNumOperands() > 2)
9306 return false;
9307
9308 ConstantInt *Lower =
9309 mdconst::extract<ConstantInt>(KnownRanges->getOperand(0));
9310 ConstantInt *Upper =
9311 mdconst::extract<ConstantInt>(KnownRanges->getOperand(1));
9312
9313 Known.emplace(Lower->getValue(), Upper->getValue());
9314 }
9315 return !Known || (*Known != Assumed && Known->contains(Assumed));
9316 }
9317
9318 /// Helper function to set range metadata.
9319 static bool
9320 setRangeMetadataIfisBetterRange(Instruction *I,
9321 const ConstantRange &AssumedConstantRange) {
9322 if (isBetterRange(AssumedConstantRange, *I)) {
9323 I->setMetadata(LLVMContext::MD_range,
9324 getMDNodeForConstantRange(I->getType(), I->getContext(),
9325 AssumedConstantRange));
9326 return true;
9327 }
9328 return false;
9329 }
9330 /// Helper function to set range return attribute.
9331 static bool
9332 setRangeRetAttrIfisBetterRange(Attributor &A, const IRPosition &IRP,
9333 Instruction *I,
9334 const ConstantRange &AssumedConstantRange) {
9335 if (isBetterRange(AssumedConstantRange, *I)) {
9336 A.manifestAttrs(IRP,
9337 Attribute::get(I->getContext(), Attribute::Range,
9338 AssumedConstantRange),
9339 /*ForceReplace*/ true);
9340 return true;
9341 }
9342 return false;
9343 }
9344
9345 /// See AbstractAttribute::manifest()
9346 ChangeStatus manifest(Attributor &A) override {
9347 ChangeStatus Changed = ChangeStatus::UNCHANGED;
9348 ConstantRange AssumedConstantRange = getAssumedConstantRange(A);
9349 assert(!AssumedConstantRange.isFullSet() && "Invalid state");
9350
9351 auto &V = getAssociatedValue();
9352 if (!AssumedConstantRange.isEmptySet() &&
9353 !AssumedConstantRange.isSingleElement()) {
9354 if (Instruction *I = dyn_cast<Instruction>(&V)) {
9355 assert(I == getCtxI() && "Should not annotate an instruction which is "
9356 "not the context instruction");
9357 if (isa<LoadInst>(I))
9358 if (setRangeMetadataIfisBetterRange(I, AssumedConstantRange))
9359 Changed = ChangeStatus::CHANGED;
9360 if (isa<CallInst>(I))
9361 if (setRangeRetAttrIfisBetterRange(A, getIRPosition(), I,
9362 AssumedConstantRange))
9363 Changed = ChangeStatus::CHANGED;
9364 }
9365 }
9366
9367 return Changed;
9368 }
9369};
9370
9371struct AAValueConstantRangeArgument final
9372 : AAArgumentFromCallSiteArguments<
9373 AAValueConstantRange, AAValueConstantRangeImpl, IntegerRangeState,
9374 true /* BridgeCallBaseContext */> {
9375 using Base = AAArgumentFromCallSiteArguments<
9376 AAValueConstantRange, AAValueConstantRangeImpl, IntegerRangeState,
9377 true /* BridgeCallBaseContext */>;
9378 AAValueConstantRangeArgument(const IRPosition &IRP, Attributor &A)
9379 : Base(IRP, A) {}
9380
9381 /// See AbstractAttribute::trackStatistics()
9382 void trackStatistics() const override {
9383 STATS_DECLTRACK_ARG_ATTR(value_range)
9384 }
9385};
9386
9387struct AAValueConstantRangeReturned
9388 : AAReturnedFromReturnedValues<AAValueConstantRange,
9389 AAValueConstantRangeImpl,
9390 AAValueConstantRangeImpl::StateType,
9391 /* PropagateCallBaseContext */ true> {
9392 using Base =
9393 AAReturnedFromReturnedValues<AAValueConstantRange,
9394 AAValueConstantRangeImpl,
9395 AAValueConstantRangeImpl::StateType,
9396 /* PropagateCallBaseContext */ true>;
9397 AAValueConstantRangeReturned(const IRPosition &IRP, Attributor &A)
9398 : Base(IRP, A) {}
9399
9400 /// See AbstractAttribute::initialize(...).
9401 void initialize(Attributor &A) override {
9402 if (!A.isFunctionIPOAmendable(*getAssociatedFunction()))
9403 indicatePessimisticFixpoint();
9404 }
9405
9406 /// See AbstractAttribute::trackStatistics()
9407 void trackStatistics() const override {
9408 STATS_DECLTRACK_FNRET_ATTR(value_range)
9409 }
9410};
9411
9412struct AAValueConstantRangeFloating : AAValueConstantRangeImpl {
9413 AAValueConstantRangeFloating(const IRPosition &IRP, Attributor &A)
9414 : AAValueConstantRangeImpl(IRP, A) {}
9415
9416 /// See AbstractAttribute::initialize(...).
9417 void initialize(Attributor &A) override {
9418 AAValueConstantRangeImpl::initialize(A);
9419 if (isAtFixpoint())
9420 return;
9421
9422 Value &V = getAssociatedValue();
9423
9424 if (auto *C = dyn_cast<ConstantInt>(&V)) {
9425 unionAssumed(ConstantRange(C->getValue()));
9426 indicateOptimisticFixpoint();
9427 return;
9428 }
9429
9430 if (isa<UndefValue>(&V)) {
9431 // Collapse the undef state to 0.
9432 unionAssumed(ConstantRange(APInt(getBitWidth(), 0)));
9433 indicateOptimisticFixpoint();
9434 return;
9435 }
9436
9437 if (isa<CallBase>(&V))
9438 return;
9439
9440 if (isa<BinaryOperator>(&V) || isa<CmpInst>(&V) || isa<CastInst>(&V))
9441 return;
9442
9443 // If it is a load instruction with range metadata, use it.
9444 if (LoadInst *LI = dyn_cast<LoadInst>(&V))
9445 if (auto *RangeMD = LI->getMetadata(LLVMContext::MD_range)) {
9446 intersectKnown(getConstantRangeFromMetadata(*RangeMD));
9447 return;
9448 }
9449
9450 // We can work with PHI and select instruction as we traverse their operands
9451 // during update.
9452 if (isa<SelectInst>(V) || isa<PHINode>(V))
9453 return;
9454
9455 // Otherwise we give up.
9456 indicatePessimisticFixpoint();
9457
9458 LLVM_DEBUG(dbgs() << "[AAValueConstantRange] We give up: "
9459 << getAssociatedValue() << "\n");
9460 }
9461
9462 bool calculateBinaryOperator(
9463 Attributor &A, BinaryOperator *BinOp, IntegerRangeState &T,
9464 const Instruction *CtxI,
9465 SmallVectorImpl<const AAValueConstantRange *> &QuerriedAAs) {
9466 Value *LHS = BinOp->getOperand(0);
9467 Value *RHS = BinOp->getOperand(1);
9468
9469 // Simplify the operands first.
9470 bool UsedAssumedInformation = false;
9471 const auto &SimplifiedLHS = A.getAssumedSimplified(
9472 IRPosition::value(*LHS, getCallBaseContext()), *this,
9473 UsedAssumedInformation, AA::Interprocedural);
9474 if (!SimplifiedLHS.has_value())
9475 return true;
9476 if (!*SimplifiedLHS)
9477 return false;
9478 LHS = *SimplifiedLHS;
9479
9480 const auto &SimplifiedRHS = A.getAssumedSimplified(
9481 IRPosition::value(*RHS, getCallBaseContext()), *this,
9482 UsedAssumedInformation, AA::Interprocedural);
9483 if (!SimplifiedRHS.has_value())
9484 return true;
9485 if (!*SimplifiedRHS)
9486 return false;
9487 RHS = *SimplifiedRHS;
9488
9489 // TODO: Allow non integers as well.
9490 if (!LHS->getType()->isIntegerTy() || !RHS->getType()->isIntegerTy())
9491 return false;
9492
9493 auto *LHSAA = A.getAAFor<AAValueConstantRange>(
9494 *this, IRPosition::value(*LHS, getCallBaseContext()),
9495 DepClassTy::REQUIRED);
9496 if (!LHSAA)
9497 return false;
9498 QuerriedAAs.push_back(LHSAA);
9499 auto LHSAARange = LHSAA->getAssumedConstantRange(A, CtxI);
9500
9501 auto *RHSAA = A.getAAFor<AAValueConstantRange>(
9502 *this, IRPosition::value(*RHS, getCallBaseContext()),
9503 DepClassTy::REQUIRED);
9504 if (!RHSAA)
9505 return false;
9506 QuerriedAAs.push_back(RHSAA);
9507 auto RHSAARange = RHSAA->getAssumedConstantRange(A, CtxI);
9508
9509 auto AssumedRange = LHSAARange.binaryOp(BinOp->getOpcode(), RHSAARange);
9510
9511 T.unionAssumed(AssumedRange);
9512
9513 // TODO: Track a known state too.
9514
9515 return T.isValidState();
9516 }
9517
9518 bool calculateCastInst(
9519 Attributor &A, CastInst *CastI, IntegerRangeState &T,
9520 const Instruction *CtxI,
9521 SmallVectorImpl<const AAValueConstantRange *> &QuerriedAAs) {
9522 assert(CastI->getNumOperands() == 1 && "Expected cast to be unary!");
9523 // TODO: Allow non integers as well.
9524 Value *OpV = CastI->getOperand(0);
9525
9526 // Simplify the operand first.
9527 bool UsedAssumedInformation = false;
9528 const auto &SimplifiedOpV = A.getAssumedSimplified(
9529 IRPosition::value(*OpV, getCallBaseContext()), *this,
9530 UsedAssumedInformation, AA::Interprocedural);
9531 if (!SimplifiedOpV.has_value())
9532 return true;
9533 if (!*SimplifiedOpV)
9534 return false;
9535 OpV = *SimplifiedOpV;
9536
9537 if (!OpV->getType()->isIntegerTy())
9538 return false;
9539
9540 auto *OpAA = A.getAAFor<AAValueConstantRange>(
9541 *this, IRPosition::value(*OpV, getCallBaseContext()),
9542 DepClassTy::REQUIRED);
9543 if (!OpAA)
9544 return false;
9545 QuerriedAAs.push_back(OpAA);
9546 T.unionAssumed(OpAA->getAssumed().castOp(CastI->getOpcode(),
9547 getState().getBitWidth()));
9548 return T.isValidState();
9549 }
9550
9551 bool
9552 calculateCmpInst(Attributor &A, CmpInst *CmpI, IntegerRangeState &T,
9553 const Instruction *CtxI,
9554 SmallVectorImpl<const AAValueConstantRange *> &QuerriedAAs) {
9555 Value *LHS = CmpI->getOperand(0);
9556 Value *RHS = CmpI->getOperand(1);
9557
9558 // Simplify the operands first.
9559 bool UsedAssumedInformation = false;
9560 const auto &SimplifiedLHS = A.getAssumedSimplified(
9561 IRPosition::value(*LHS, getCallBaseContext()), *this,
9562 UsedAssumedInformation, AA::Interprocedural);
9563 if (!SimplifiedLHS.has_value())
9564 return true;
9565 if (!*SimplifiedLHS)
9566 return false;
9567 LHS = *SimplifiedLHS;
9568
9569 const auto &SimplifiedRHS = A.getAssumedSimplified(
9570 IRPosition::value(*RHS, getCallBaseContext()), *this,
9571 UsedAssumedInformation, AA::Interprocedural);
9572 if (!SimplifiedRHS.has_value())
9573 return true;
9574 if (!*SimplifiedRHS)
9575 return false;
9576 RHS = *SimplifiedRHS;
9577
9578 // TODO: Allow non integers as well.
9579 if (!LHS->getType()->isIntegerTy() || !RHS->getType()->isIntegerTy())
9580 return false;
9581
9582 auto *LHSAA = A.getAAFor<AAValueConstantRange>(
9583 *this, IRPosition::value(*LHS, getCallBaseContext()),
9584 DepClassTy::REQUIRED);
9585 if (!LHSAA)
9586 return false;
9587 QuerriedAAs.push_back(LHSAA);
9588 auto *RHSAA = A.getAAFor<AAValueConstantRange>(
9589 *this, IRPosition::value(*RHS, getCallBaseContext()),
9590 DepClassTy::REQUIRED);
9591 if (!RHSAA)
9592 return false;
9593 QuerriedAAs.push_back(RHSAA);
9594 auto LHSAARange = LHSAA->getAssumedConstantRange(A, CtxI);
9595 auto RHSAARange = RHSAA->getAssumedConstantRange(A, CtxI);
9596
9597 // If one of them is empty set, we can't decide.
9598 if (LHSAARange.isEmptySet() || RHSAARange.isEmptySet())
9599 return true;
9600
9601 bool MustTrue = false, MustFalse = false;
9602
9603 auto AllowedRegion =
9605
9606 if (AllowedRegion.intersectWith(LHSAARange).isEmptySet())
9607 MustFalse = true;
9608
9609 if (LHSAARange.icmp(CmpI->getPredicate(), RHSAARange))
9610 MustTrue = true;
9611
9612 assert((!MustTrue || !MustFalse) &&
9613 "Either MustTrue or MustFalse should be false!");
9614
9615 if (MustTrue)
9616 T.unionAssumed(ConstantRange(APInt(/* numBits */ 1, /* val */ 1)));
9617 else if (MustFalse)
9618 T.unionAssumed(ConstantRange(APInt(/* numBits */ 1, /* val */ 0)));
9619 else
9620 T.unionAssumed(ConstantRange(/* BitWidth */ 1, /* isFullSet */ true));
9621
9622 LLVM_DEBUG(dbgs() << "[AAValueConstantRange] " << *CmpI << " after "
9623 << (MustTrue ? "true" : (MustFalse ? "false" : "unknown"))
9624 << ": " << T << "\n\t" << *LHSAA << "\t<op>\n\t"
9625 << *RHSAA);
9626
9627 // TODO: Track a known state too.
9628 return T.isValidState();
9629 }
9630
9631 /// See AbstractAttribute::updateImpl(...).
9632 ChangeStatus updateImpl(Attributor &A) override {
9633
9634 IntegerRangeState T(getBitWidth());
9635 auto VisitValueCB = [&](Value &V, const Instruction *CtxI) -> bool {
9637 if (!I || isa<CallBase>(I)) {
9638
9639 // Simplify the operand first.
9640 bool UsedAssumedInformation = false;
9641 const auto &SimplifiedOpV = A.getAssumedSimplified(
9642 IRPosition::value(V, getCallBaseContext()), *this,
9643 UsedAssumedInformation, AA::Interprocedural);
9644 if (!SimplifiedOpV.has_value())
9645 return true;
9646 if (!*SimplifiedOpV)
9647 return false;
9648 Value *VPtr = *SimplifiedOpV;
9649
9650 // If the value is not instruction, we query AA to Attributor.
9651 const auto *AA = A.getAAFor<AAValueConstantRange>(
9652 *this, IRPosition::value(*VPtr, getCallBaseContext()),
9653 DepClassTy::REQUIRED);
9654
9655 // Clamp operator is not used to utilize a program point CtxI.
9656 if (AA)
9657 T.unionAssumed(AA->getAssumedConstantRange(A, CtxI));
9658 else
9659 return false;
9660
9661 return T.isValidState();
9662 }
9663
9665 if (auto *BinOp = dyn_cast<BinaryOperator>(I)) {
9666 if (!calculateBinaryOperator(A, BinOp, T, CtxI, QuerriedAAs))
9667 return false;
9668 } else if (auto *CmpI = dyn_cast<CmpInst>(I)) {
9669 if (!calculateCmpInst(A, CmpI, T, CtxI, QuerriedAAs))
9670 return false;
9671 } else if (auto *CastI = dyn_cast<CastInst>(I)) {
9672 if (!calculateCastInst(A, CastI, T, CtxI, QuerriedAAs))
9673 return false;
9674 } else {
9675 // Give up with other instructions.
9676 // TODO: Add other instructions
9677
9678 T.indicatePessimisticFixpoint();
9679 return false;
9680 }
9681
9682 // Catch circular reasoning in a pessimistic way for now.
9683 // TODO: Check how the range evolves and if we stripped anything, see also
9684 // AADereferenceable or AAAlign for similar situations.
9685 for (const AAValueConstantRange *QueriedAA : QuerriedAAs) {
9686 if (QueriedAA != this)
9687 continue;
9688 // If we are in a stady state we do not need to worry.
9689 if (T.getAssumed() == getState().getAssumed())
9690 continue;
9691 T.indicatePessimisticFixpoint();
9692 }
9693
9694 return T.isValidState();
9695 };
9696
9697 if (!VisitValueCB(getAssociatedValue(), getCtxI()))
9698 return indicatePessimisticFixpoint();
9699
9700 // Ensure that long def-use chains can't cause circular reasoning either by
9701 // introducing a cutoff below.
9702 if (clampStateAndIndicateChange(getState(), T) == ChangeStatus::UNCHANGED)
9703 return ChangeStatus::UNCHANGED;
9704 if (++NumChanges > MaxNumChanges) {
9705 LLVM_DEBUG(dbgs() << "[AAValueConstantRange] performed " << NumChanges
9706 << " but only " << MaxNumChanges
9707 << " are allowed to avoid cyclic reasoning.");
9708 return indicatePessimisticFixpoint();
9709 }
9710 return ChangeStatus::CHANGED;
9711 }
9712
9713 /// See AbstractAttribute::trackStatistics()
9714 void trackStatistics() const override {
9716 }
9717
9718 /// Tracker to bail after too many widening steps of the constant range.
9719 int NumChanges = 0;
9720
9721 /// Upper bound for the number of allowed changes (=widening steps) for the
9722 /// constant range before we give up.
9723 static constexpr int MaxNumChanges = 5;
9724};
9725
9726struct AAValueConstantRangeFunction : AAValueConstantRangeImpl {
9727 AAValueConstantRangeFunction(const IRPosition &IRP, Attributor &A)
9728 : AAValueConstantRangeImpl(IRP, A) {}
9729
9730 /// See AbstractAttribute::initialize(...).
9731 ChangeStatus updateImpl(Attributor &A) override {
9732 llvm_unreachable("AAValueConstantRange(Function|CallSite)::updateImpl will "
9733 "not be called");
9734 }
9735
9736 /// See AbstractAttribute::trackStatistics()
9737 void trackStatistics() const override { STATS_DECLTRACK_FN_ATTR(value_range) }
9738};
9739
9740struct AAValueConstantRangeCallSite : AAValueConstantRangeFunction {
9741 AAValueConstantRangeCallSite(const IRPosition &IRP, Attributor &A)
9742 : AAValueConstantRangeFunction(IRP, A) {}
9743
9744 /// See AbstractAttribute::trackStatistics()
9745 void trackStatistics() const override { STATS_DECLTRACK_CS_ATTR(value_range) }
9746};
9747
9748struct AAValueConstantRangeCallSiteReturned
9749 : AACalleeToCallSite<AAValueConstantRange, AAValueConstantRangeImpl,
9750 AAValueConstantRangeImpl::StateType,
9751 /* IntroduceCallBaseContext */ true> {
9752 AAValueConstantRangeCallSiteReturned(const IRPosition &IRP, Attributor &A)
9753 : AACalleeToCallSite<AAValueConstantRange, AAValueConstantRangeImpl,
9754 AAValueConstantRangeImpl::StateType,
9755 /* IntroduceCallBaseContext */ true>(IRP, A) {}
9756
9757 /// See AbstractAttribute::initialize(...).
9758 void initialize(Attributor &A) override {
9759 // If it is a call instruction with range attribute, use the range.
9760 if (CallInst *CI = dyn_cast<CallInst>(&getAssociatedValue())) {
9761 if (std::optional<ConstantRange> Range = CI->getRange())
9762 intersectKnown(*Range);
9763 }
9764
9765 AAValueConstantRangeImpl::initialize(A);
9766 }
9767
9768 /// See AbstractAttribute::trackStatistics()
9769 void trackStatistics() const override {
9770 STATS_DECLTRACK_CSRET_ATTR(value_range)
9771 }
9772};
9773struct AAValueConstantRangeCallSiteArgument : AAValueConstantRangeFloating {
9774 AAValueConstantRangeCallSiteArgument(const IRPosition &IRP, Attributor &A)
9775 : AAValueConstantRangeFloating(IRP, A) {}
9776
9777 /// See AbstractAttribute::manifest()
9778 ChangeStatus manifest(Attributor &A) override {
9779 return ChangeStatus::UNCHANGED;
9780 }
9781
9782 /// See AbstractAttribute::trackStatistics()
9783 void trackStatistics() const override {
9784 STATS_DECLTRACK_CSARG_ATTR(value_range)
9785 }
9786};
9787} // namespace
9788
9789/// ------------------ Potential Values Attribute -------------------------
9790
9791namespace {
9792struct AAPotentialConstantValuesImpl : AAPotentialConstantValues {
9793 using StateType = PotentialConstantIntValuesState;
9794
9795 AAPotentialConstantValuesImpl(const IRPosition &IRP, Attributor &A)
9796 : AAPotentialConstantValues(IRP, A) {}
9797
9798 /// See AbstractAttribute::initialize(..).
9799 void initialize(Attributor &A) override {
9800 if (A.hasSimplificationCallback(getIRPosition()))
9801 indicatePessimisticFixpoint();
9802 else
9803 AAPotentialConstantValues::initialize(A);
9804 }
9805
9806 bool fillSetWithConstantValues(Attributor &A, const IRPosition &IRP, SetTy &S,
9807 bool &ContainsUndef, bool ForSelf) {
9809 bool UsedAssumedInformation = false;
9810 if (!A.getAssumedSimplifiedValues(IRP, *this, Values, AA::Interprocedural,
9811 UsedAssumedInformation)) {
9812 // Avoid recursion when the caller is computing constant values for this
9813 // IRP itself.
9814 if (ForSelf)
9815 return false;
9816 if (!IRP.getAssociatedType()->isIntegerTy())
9817 return false;
9818 auto *PotentialValuesAA = A.getAAFor<AAPotentialConstantValues>(
9819 *this, IRP, DepClassTy::REQUIRED);
9820 if (!PotentialValuesAA || !PotentialValuesAA->getState().isValidState())
9821 return false;
9822 ContainsUndef = PotentialValuesAA->getState().undefIsContained();
9823 S = PotentialValuesAA->getState().getAssumedSet();
9824 return true;
9825 }
9826
9827 // Copy all the constant values, except UndefValue. ContainsUndef is true
9828 // iff Values contains only UndefValue instances. If there are other known
9829 // constants, then UndefValue is dropped.
9830 ContainsUndef = false;
9831 for (auto &It : Values) {
9832 if (isa<UndefValue>(It.getValue())) {
9833 ContainsUndef = true;
9834 continue;
9835 }
9836 auto *CI = dyn_cast<ConstantInt>(It.getValue());
9837 if (!CI)
9838 return false;
9839 S.insert(CI->getValue());
9840 }
9841 ContainsUndef &= S.empty();
9842
9843 return true;
9844 }
9845
9846 /// See AbstractAttribute::getAsStr().
9847 const std::string getAsStr(Attributor *A) const override {
9848 std::string Str;
9849 llvm::raw_string_ostream OS(Str);
9850 OS << getState();
9851 return Str;
9852 }
9853
9854 /// See AbstractAttribute::updateImpl(...).
9855 ChangeStatus updateImpl(Attributor &A) override {
9856 return indicatePessimisticFixpoint();
9857 }
9858};
9859
9860struct AAPotentialConstantValuesArgument final
9861 : AAArgumentFromCallSiteArguments<AAPotentialConstantValues,
9862 AAPotentialConstantValuesImpl,
9863 PotentialConstantIntValuesState> {
9864 using Base = AAArgumentFromCallSiteArguments<AAPotentialConstantValues,
9865 AAPotentialConstantValuesImpl,
9867 AAPotentialConstantValuesArgument(const IRPosition &IRP, Attributor &A)
9868 : Base(IRP, A) {}
9869
9870 /// See AbstractAttribute::trackStatistics()
9871 void trackStatistics() const override {
9872 STATS_DECLTRACK_ARG_ATTR(potential_values)
9873 }
9874};
9875
9876struct AAPotentialConstantValuesReturned
9877 : AAReturnedFromReturnedValues<AAPotentialConstantValues,
9878 AAPotentialConstantValuesImpl> {
9879 using Base = AAReturnedFromReturnedValues<AAPotentialConstantValues,
9880 AAPotentialConstantValuesImpl>;
9881 AAPotentialConstantValuesReturned(const IRPosition &IRP, Attributor &A)
9882 : Base(IRP, A) {}
9883
9884 void initialize(Attributor &A) override {
9885 if (!A.isFunctionIPOAmendable(*getAssociatedFunction()))
9886 indicatePessimisticFixpoint();
9887 Base::initialize(A);
9888 }
9889
9890 /// See AbstractAttribute::trackStatistics()
9891 void trackStatistics() const override {
9892 STATS_DECLTRACK_FNRET_ATTR(potential_values)
9893 }
9894};
9895
9896struct AAPotentialConstantValuesFloating : AAPotentialConstantValuesImpl {
9897 AAPotentialConstantValuesFloating(const IRPosition &IRP, Attributor &A)
9898 : AAPotentialConstantValuesImpl(IRP, A) {}
9899
9900 /// See AbstractAttribute::initialize(..).
9901 void initialize(Attributor &A) override {
9902 AAPotentialConstantValuesImpl::initialize(A);
9903 if (isAtFixpoint())
9904 return;
9905
9906 Value &V = getAssociatedValue();
9907
9908 if (auto *C = dyn_cast<ConstantInt>(&V)) {
9909 unionAssumed(C->getValue());
9910 indicateOptimisticFixpoint();
9911 return;
9912 }
9913
9914 if (isa<UndefValue>(&V)) {
9915 unionAssumedWithUndef();
9916 indicateOptimisticFixpoint();
9917 return;
9918 }
9919
9920 if (isa<BinaryOperator>(&V) || isa<ICmpInst>(&V) || isa<CastInst>(&V))
9921 return;
9922
9923 if (isa<SelectInst>(V) || isa<PHINode>(V) || isa<LoadInst>(V))
9924 return;
9925
9926 indicatePessimisticFixpoint();
9927
9928 LLVM_DEBUG(dbgs() << "[AAPotentialConstantValues] We give up: "
9929 << getAssociatedValue() << "\n");
9930 }
9931
9932 static bool calculateICmpInst(const ICmpInst *ICI, const APInt &LHS,
9933 const APInt &RHS) {
9934 return ICmpInst::compare(LHS, RHS, ICI->getPredicate());
9935 }
9936
9937 static APInt calculateCastInst(const CastInst *CI, const APInt &Src,
9938 uint32_t ResultBitWidth) {
9939 Instruction::CastOps CastOp = CI->getOpcode();
9940 switch (CastOp) {
9941 default:
9942 llvm_unreachable("unsupported or not integer cast");
9943 case Instruction::Trunc:
9944 return Src.trunc(ResultBitWidth);
9945 case Instruction::SExt:
9946 return Src.sext(ResultBitWidth);
9947 case Instruction::ZExt:
9948 return Src.zext(ResultBitWidth);
9949 case Instruction::BitCast:
9950 return Src;
9951 }
9952 }
9953
9954 static APInt calculateBinaryOperator(const BinaryOperator *BinOp,
9955 const APInt &LHS, const APInt &RHS,
9956 bool &SkipOperation, bool &Unsupported) {
9957 Instruction::BinaryOps BinOpcode = BinOp->getOpcode();
9958 // Unsupported is set to true when the binary operator is not supported.
9959 // SkipOperation is set to true when UB occur with the given operand pair
9960 // (LHS, RHS).
9961 // TODO: we should look at nsw and nuw keywords to handle operations
9962 // that create poison or undef value.
9963 switch (BinOpcode) {
9964 default:
9965 Unsupported = true;
9966 return LHS;
9967 case Instruction::Add:
9968 return LHS + RHS;
9969 case Instruction::Sub:
9970 return LHS - RHS;
9971 case Instruction::Mul:
9972 return LHS * RHS;
9973 case Instruction::UDiv:
9974 if (RHS.isZero()) {
9975 SkipOperation = true;
9976 return LHS;
9977 }
9978 return LHS.udiv(RHS);
9979 case Instruction::SDiv:
9980 if (RHS.isZero()) {
9981 SkipOperation = true;
9982 return LHS;
9983 }
9984 return LHS.sdiv(RHS);
9985 case Instruction::URem:
9986 if (RHS.isZero()) {
9987 SkipOperation = true;
9988 return LHS;
9989 }
9990 return LHS.urem(RHS);
9991 case Instruction::SRem:
9992 if (RHS.isZero()) {
9993 SkipOperation = true;
9994 return LHS;
9995 }
9996 return LHS.srem(RHS);
9997 case Instruction::Shl:
9998 return LHS.shl(RHS);
9999 case Instruction::LShr:
10000 return LHS.lshr(RHS);
10001 case Instruction::AShr:
10002 return LHS.ashr(RHS);
10003 case Instruction::And:
10004 return LHS & RHS;
10005 case Instruction::Or:
10006 return LHS | RHS;
10007 case Instruction::Xor:
10008 return LHS ^ RHS;
10009 }
10010 }
10011
10012 bool calculateBinaryOperatorAndTakeUnion(const BinaryOperator *BinOp,
10013 const APInt &LHS, const APInt &RHS) {
10014 bool SkipOperation = false;
10015 bool Unsupported = false;
10016 APInt Result =
10017 calculateBinaryOperator(BinOp, LHS, RHS, SkipOperation, Unsupported);
10018 if (Unsupported)
10019 return false;
10020 // If SkipOperation is true, we can ignore this operand pair (L, R).
10021 if (!SkipOperation)
10022 unionAssumed(Result);
10023 return isValidState();
10024 }
10025
10026 ChangeStatus updateWithICmpInst(Attributor &A, ICmpInst *ICI) {
10027 auto AssumedBefore = getAssumed();
10028 Value *LHS = ICI->getOperand(0);
10029 Value *RHS = ICI->getOperand(1);
10030
10031 bool LHSContainsUndef = false, RHSContainsUndef = false;
10032 SetTy LHSAAPVS, RHSAAPVS;
10033 if (!fillSetWithConstantValues(A, IRPosition::value(*LHS), LHSAAPVS,
10034 LHSContainsUndef, /* ForSelf */ false) ||
10035 !fillSetWithConstantValues(A, IRPosition::value(*RHS), RHSAAPVS,
10036 RHSContainsUndef, /* ForSelf */ false))
10037 return indicatePessimisticFixpoint();
10038
10039 // TODO: make use of undef flag to limit potential values aggressively.
10040 bool MaybeTrue = false, MaybeFalse = false;
10041 const APInt Zero(RHS->getType()->getIntegerBitWidth(), 0);
10042 if (LHSContainsUndef && RHSContainsUndef) {
10043 // The result of any comparison between undefs can be soundly replaced
10044 // with undef.
10045 unionAssumedWithUndef();
10046 } else if (LHSContainsUndef) {
10047 for (const APInt &R : RHSAAPVS) {
10048 bool CmpResult = calculateICmpInst(ICI, Zero, R);
10049 MaybeTrue |= CmpResult;
10050 MaybeFalse |= !CmpResult;
10051 if (MaybeTrue & MaybeFalse)
10052 return indicatePessimisticFixpoint();
10053 }
10054 } else if (RHSContainsUndef) {
10055 for (const APInt &L : LHSAAPVS) {
10056 bool CmpResult = calculateICmpInst(ICI, L, Zero);
10057 MaybeTrue |= CmpResult;
10058 MaybeFalse |= !CmpResult;
10059 if (MaybeTrue & MaybeFalse)
10060 return indicatePessimisticFixpoint();
10061 }
10062 } else {
10063 for (const APInt &L : LHSAAPVS) {
10064 for (const APInt &R : RHSAAPVS) {
10065 bool CmpResult = calculateICmpInst(ICI, L, R);
10066 MaybeTrue |= CmpResult;
10067 MaybeFalse |= !CmpResult;
10068 if (MaybeTrue & MaybeFalse)
10069 return indicatePessimisticFixpoint();
10070 }
10071 }
10072 }
10073 if (MaybeTrue)
10074 unionAssumed(APInt(/* numBits */ 1, /* val */ 1));
10075 if (MaybeFalse)
10076 unionAssumed(APInt(/* numBits */ 1, /* val */ 0));
10077 return AssumedBefore == getAssumed() ? ChangeStatus::UNCHANGED
10078 : ChangeStatus::CHANGED;
10079 }
10080
10081 ChangeStatus updateWithSelectInst(Attributor &A, SelectInst *SI) {
10082 auto AssumedBefore = getAssumed();
10083 Value *LHS = SI->getTrueValue();
10084 Value *RHS = SI->getFalseValue();
10085
10086 bool UsedAssumedInformation = false;
10087 std::optional<Constant *> C = A.getAssumedConstant(
10088 *SI->getCondition(), *this, UsedAssumedInformation);
10089
10090 // Check if we only need one operand.
10091 bool OnlyLeft = false, OnlyRight = false;
10092 if (C && *C && (*C)->isOneValue())
10093 OnlyLeft = true;
10094 else if (C && *C && (*C)->isNullValue())
10095 OnlyRight = true;
10096
10097 bool LHSContainsUndef = false, RHSContainsUndef = false;
10098 SetTy LHSAAPVS, RHSAAPVS;
10099 if (!OnlyRight &&
10100 !fillSetWithConstantValues(A, IRPosition::value(*LHS), LHSAAPVS,
10101 LHSContainsUndef, /* ForSelf */ false))
10102 return indicatePessimisticFixpoint();
10103
10104 if (!OnlyLeft &&
10105 !fillSetWithConstantValues(A, IRPosition::value(*RHS), RHSAAPVS,
10106 RHSContainsUndef, /* ForSelf */ false))
10107 return indicatePessimisticFixpoint();
10108
10109 if (OnlyLeft || OnlyRight) {
10110 // select (true/false), lhs, rhs
10111 auto *OpAA = OnlyLeft ? &LHSAAPVS : &RHSAAPVS;
10112 auto Undef = OnlyLeft ? LHSContainsUndef : RHSContainsUndef;
10113
10114 if (Undef)
10115 unionAssumedWithUndef();
10116 else {
10117 for (const auto &It : *OpAA)
10118 unionAssumed(It);
10119 }
10120
10121 } else if (LHSContainsUndef && RHSContainsUndef) {
10122 // select i1 *, undef , undef => undef
10123 unionAssumedWithUndef();
10124 } else {
10125 for (const auto &It : LHSAAPVS)
10126 unionAssumed(It);
10127 for (const auto &It : RHSAAPVS)
10128 unionAssumed(It);
10129 }
10130 return AssumedBefore == getAssumed() ? ChangeStatus::UNCHANGED
10131 : ChangeStatus::CHANGED;
10132 }
10133
10134 ChangeStatus updateWithCastInst(Attributor &A, CastInst *CI) {
10135 auto AssumedBefore = getAssumed();
10136 if (!CI->isIntegerCast())
10137 return indicatePessimisticFixpoint();
10138 assert(CI->getNumOperands() == 1 && "Expected cast to be unary!");
10139 uint32_t ResultBitWidth = CI->getDestTy()->getIntegerBitWidth();
10140 Value *Src = CI->getOperand(0);
10141
10142 bool SrcContainsUndef = false;
10143 SetTy SrcPVS;
10144 if (!fillSetWithConstantValues(A, IRPosition::value(*Src), SrcPVS,
10145 SrcContainsUndef, /* ForSelf */ false))
10146 return indicatePessimisticFixpoint();
10147
10148 if (SrcContainsUndef)
10149 unionAssumedWithUndef();
10150 else {
10151 for (const APInt &S : SrcPVS) {
10152 APInt T = calculateCastInst(CI, S, ResultBitWidth);
10153 unionAssumed(T);
10154 }
10155 }
10156 return AssumedBefore == getAssumed() ? ChangeStatus::UNCHANGED
10157 : ChangeStatus::CHANGED;
10158 }
10159
10160 ChangeStatus updateWithBinaryOperator(Attributor &A, BinaryOperator *BinOp) {
10161 auto AssumedBefore = getAssumed();
10162 Value *LHS = BinOp->getOperand(0);
10163 Value *RHS = BinOp->getOperand(1);
10164
10165 bool LHSContainsUndef = false, RHSContainsUndef = false;
10166 SetTy LHSAAPVS, RHSAAPVS;
10167 if (!fillSetWithConstantValues(A, IRPosition::value(*LHS), LHSAAPVS,
10168 LHSContainsUndef, /* ForSelf */ false) ||
10169 !fillSetWithConstantValues(A, IRPosition::value(*RHS), RHSAAPVS,
10170 RHSContainsUndef, /* ForSelf */ false))
10171 return indicatePessimisticFixpoint();
10172
10173 const APInt Zero = APInt(LHS->getType()->getIntegerBitWidth(), 0);
10174
10175 // TODO: make use of undef flag to limit potential values aggressively.
10176 if (LHSContainsUndef && RHSContainsUndef) {
10177 if (!calculateBinaryOperatorAndTakeUnion(BinOp, Zero, Zero))
10178 return indicatePessimisticFixpoint();
10179 } else if (LHSContainsUndef) {
10180 for (const APInt &R : RHSAAPVS) {
10181 if (!calculateBinaryOperatorAndTakeUnion(BinOp, Zero, R))
10182 return indicatePessimisticFixpoint();
10183 }
10184 } else if (RHSContainsUndef) {
10185 for (const APInt &L : LHSAAPVS) {
10186 if (!calculateBinaryOperatorAndTakeUnion(BinOp, L, Zero))
10187 return indicatePessimisticFixpoint();
10188 }
10189 } else {
10190 for (const APInt &L : LHSAAPVS) {
10191 for (const APInt &R : RHSAAPVS) {
10192 if (!calculateBinaryOperatorAndTakeUnion(BinOp, L, R))
10193 return indicatePessimisticFixpoint();
10194 }
10195 }
10196 }
10197 return AssumedBefore == getAssumed() ? ChangeStatus::UNCHANGED
10198 : ChangeStatus::CHANGED;
10199 }
10200
10201 ChangeStatus updateWithInstruction(Attributor &A, Instruction *Inst) {
10202 auto AssumedBefore = getAssumed();
10203 SetTy Incoming;
10204 bool ContainsUndef;
10205 if (!fillSetWithConstantValues(A, IRPosition::value(*Inst), Incoming,
10206 ContainsUndef, /* ForSelf */ true))
10207 return indicatePessimisticFixpoint();
10208 if (ContainsUndef) {
10209 unionAssumedWithUndef();
10210 } else {
10211 for (const auto &It : Incoming)
10212 unionAssumed(It);
10213 }
10214 return AssumedBefore == getAssumed() ? ChangeStatus::UNCHANGED
10215 : ChangeStatus::CHANGED;
10216 }
10217
10218 /// See AbstractAttribute::updateImpl(...).
10219 ChangeStatus updateImpl(Attributor &A) override {
10220 Value &V = getAssociatedValue();
10222
10223 if (auto *ICI = dyn_cast<ICmpInst>(I))
10224 return updateWithICmpInst(A, ICI);
10225
10226 if (auto *SI = dyn_cast<SelectInst>(I))
10227 return updateWithSelectInst(A, SI);
10228
10229 if (auto *CI = dyn_cast<CastInst>(I))
10230 return updateWithCastInst(A, CI);
10231
10232 if (auto *BinOp = dyn_cast<BinaryOperator>(I))
10233 return updateWithBinaryOperator(A, BinOp);
10234
10235 if (isa<PHINode>(I) || isa<LoadInst>(I))
10236 return updateWithInstruction(A, I);
10237
10238 return indicatePessimisticFixpoint();
10239 }
10240
10241 /// See AbstractAttribute::trackStatistics()
10242 void trackStatistics() const override {
10243 STATS_DECLTRACK_FLOATING_ATTR(potential_values)
10244 }
10245};
10246
10247struct AAPotentialConstantValuesFunction : AAPotentialConstantValuesImpl {
10248 AAPotentialConstantValuesFunction(const IRPosition &IRP, Attributor &A)
10249 : AAPotentialConstantValuesImpl(IRP, A) {}
10250
10251 /// See AbstractAttribute::initialize(...).
10252 ChangeStatus updateImpl(Attributor &A) override {
10254 "AAPotentialConstantValues(Function|CallSite)::updateImpl will "
10255 "not be called");
10256 }
10257
10258 /// See AbstractAttribute::trackStatistics()
10259 void trackStatistics() const override {
10260 STATS_DECLTRACK_FN_ATTR(potential_values)
10261 }
10262};
10263
10264struct AAPotentialConstantValuesCallSite : AAPotentialConstantValuesFunction {
10265 AAPotentialConstantValuesCallSite(const IRPosition &IRP, Attributor &A)
10266 : AAPotentialConstantValuesFunction(IRP, A) {}
10267
10268 /// See AbstractAttribute::trackStatistics()
10269 void trackStatistics() const override {
10270 STATS_DECLTRACK_CS_ATTR(potential_values)
10271 }
10272};
10273
10274struct AAPotentialConstantValuesCallSiteReturned
10275 : AACalleeToCallSite<AAPotentialConstantValues,
10276 AAPotentialConstantValuesImpl> {
10277 AAPotentialConstantValuesCallSiteReturned(const IRPosition &IRP,
10278 Attributor &A)
10279 : AACalleeToCallSite<AAPotentialConstantValues,
10280 AAPotentialConstantValuesImpl>(IRP, A) {}
10281
10282 /// See AbstractAttribute::trackStatistics()
10283 void trackStatistics() const override {
10284 STATS_DECLTRACK_CSRET_ATTR(potential_values)
10285 }
10286};
10287
10288struct AAPotentialConstantValuesCallSiteArgument
10289 : AAPotentialConstantValuesFloating {
10290 AAPotentialConstantValuesCallSiteArgument(const IRPosition &IRP,
10291 Attributor &A)
10292 : AAPotentialConstantValuesFloating(IRP, A) {}
10293
10294 /// See AbstractAttribute::initialize(..).
10295 void initialize(Attributor &A) override {
10296 AAPotentialConstantValuesImpl::initialize(A);
10297 if (isAtFixpoint())
10298 return;
10299
10300 Value &V = getAssociatedValue();
10301
10302 if (auto *C = dyn_cast<ConstantInt>(&V)) {
10303 unionAssumed(C->getValue());
10304 indicateOptimisticFixpoint();
10305 return;
10306 }
10307
10308 if (isa<UndefValue>(&V)) {
10309 unionAssumedWithUndef();
10310 indicateOptimisticFixpoint();
10311 return;
10312 }
10313 }
10314
10315 /// See AbstractAttribute::updateImpl(...).
10316 ChangeStatus updateImpl(Attributor &A) override {
10317 Value &V = getAssociatedValue();
10318 auto AssumedBefore = getAssumed();
10319 auto *AA = A.getAAFor<AAPotentialConstantValues>(
10320 *this, IRPosition::value(V), DepClassTy::REQUIRED);
10321 if (!AA)
10322 return indicatePessimisticFixpoint();
10323 const auto &S = AA->getAssumed();
10324 unionAssumed(S);
10325 return AssumedBefore == getAssumed() ? ChangeStatus::UNCHANGED
10326 : ChangeStatus::CHANGED;
10327 }
10328
10329 /// See AbstractAttribute::trackStatistics()
10330 void trackStatistics() const override {
10331 STATS_DECLTRACK_CSARG_ATTR(potential_values)
10332 }
10333};
10334} // namespace
10335
10336/// ------------------------ NoUndef Attribute ---------------------------------
10338 Attribute::AttrKind ImpliedAttributeKind,
10339 bool IgnoreSubsumingPositions) {
10340 assert(ImpliedAttributeKind == Attribute::NoUndef &&
10341 "Unexpected attribute kind");
10342 if (A.hasAttr(IRP, {Attribute::NoUndef}, IgnoreSubsumingPositions,
10343 Attribute::NoUndef))
10344 return true;
10345
10346 Value &Val = IRP.getAssociatedValue();
10349 LLVMContext &Ctx = Val.getContext();
10350 A.manifestAttrs(IRP, Attribute::get(Ctx, Attribute::NoUndef));
10351 return true;
10352 }
10353
10354 return false;
10355}
10356
10357namespace {
10358struct AANoUndefImpl : AANoUndef {
10359 AANoUndefImpl(const IRPosition &IRP, Attributor &A) : AANoUndef(IRP, A) {}
10360
10361 /// See AbstractAttribute::initialize(...).
10362 void initialize(Attributor &A) override {
10363 Value &V = getAssociatedValue();
10364 if (isa<UndefValue>(V))
10365 indicatePessimisticFixpoint();
10366 assert(!isImpliedByIR(A, getIRPosition(), Attribute::NoUndef));
10367 }
10368
10369 /// See followUsesInMBEC
10370 bool followUseInMBEC(Attributor &A, const Use *U, const Instruction *I,
10371 AANoUndef::StateType &State) {
10372 const Value *UseV = U->get();
10373 const DominatorTree *DT = nullptr;
10374 AssumptionCache *AC = nullptr;
10375 InformationCache &InfoCache = A.getInfoCache();
10376 if (Function *F = getAnchorScope()) {
10377 DT = InfoCache.getAnalysisResultForFunction<DominatorTreeAnalysis>(*F);
10378 AC = InfoCache.getAnalysisResultForFunction<AssumptionAnalysis>(*F);
10379 }
10380 State.setKnown(isGuaranteedNotToBeUndefOrPoison(UseV, AC, I, DT));
10381 bool TrackUse = false;
10382 // Track use for instructions which must produce undef or poison bits when
10383 // at least one operand contains such bits.
10385 TrackUse = true;
10386 return TrackUse;
10387 }
10388
10389 /// See AbstractAttribute::getAsStr().
10390 const std::string getAsStr(Attributor *A) const override {
10391 return getAssumed() ? "noundef" : "may-undef-or-poison";
10392 }
10393
10394 ChangeStatus manifest(Attributor &A) override {
10395 // We don't manifest noundef attribute for dead positions because the
10396 // associated values with dead positions would be replaced with undef
10397 // values.
10398 bool UsedAssumedInformation = false;
10399 if (A.isAssumedDead(getIRPosition(), nullptr, nullptr,
10400 UsedAssumedInformation))
10401 return ChangeStatus::UNCHANGED;
10402 // A position whose simplified value does not have any value is
10403 // considered to be dead. We don't manifest noundef in such positions for
10404 // the same reason above.
10405 if (!A.getAssumedSimplified(getIRPosition(), *this, UsedAssumedInformation,
10407 .has_value())
10408 return ChangeStatus::UNCHANGED;
10409 return AANoUndef::manifest(A);
10410 }
10411};
10412
10413struct AANoUndefFloating : public AANoUndefImpl {
10414 AANoUndefFloating(const IRPosition &IRP, Attributor &A)
10415 : AANoUndefImpl(IRP, A) {}
10416
10417 /// See AbstractAttribute::initialize(...).
10418 void initialize(Attributor &A) override {
10419 AANoUndefImpl::initialize(A);
10420 if (!getState().isAtFixpoint() && getAnchorScope() &&
10421 !getAnchorScope()->isDeclaration())
10422 if (Instruction *CtxI = getCtxI())
10423 followUsesInMBEC(*this, A, getState(), *CtxI);
10424 }
10425
10426 /// See AbstractAttribute::updateImpl(...).
10427 ChangeStatus updateImpl(Attributor &A) override {
10428 auto VisitValueCB = [&](const IRPosition &IRP) -> bool {
10429 bool IsKnownNoUndef;
10431 A, this, IRP, DepClassTy::REQUIRED, IsKnownNoUndef);
10432 };
10433
10434 bool Stripped;
10435 bool UsedAssumedInformation = false;
10436 Value *AssociatedValue = &getAssociatedValue();
10438 if (!A.getAssumedSimplifiedValues(getIRPosition(), *this, Values,
10439 AA::AnyScope, UsedAssumedInformation))
10440 Stripped = false;
10441 else
10442 Stripped =
10443 Values.size() != 1 || Values.front().getValue() != AssociatedValue;
10444
10445 if (!Stripped) {
10446 // If we haven't stripped anything we might still be able to use a
10447 // different AA, but only if the IRP changes. Effectively when we
10448 // interpret this not as a call site value but as a floating/argument
10449 // value.
10450 const IRPosition AVIRP = IRPosition::value(*AssociatedValue);
10451 if (AVIRP == getIRPosition() || !VisitValueCB(AVIRP))
10452 return indicatePessimisticFixpoint();
10453 return ChangeStatus::UNCHANGED;
10454 }
10455
10456 for (const auto &VAC : Values)
10457 if (!VisitValueCB(IRPosition::value(*VAC.getValue())))
10458 return indicatePessimisticFixpoint();
10459
10460 return ChangeStatus::UNCHANGED;
10461 }
10462
10463 /// See AbstractAttribute::trackStatistics()
10464 void trackStatistics() const override { STATS_DECLTRACK_FNRET_ATTR(noundef) }
10465};
10466
10467struct AANoUndefReturned final
10468 : AAReturnedFromReturnedValues<AANoUndef, AANoUndefImpl> {
10469 AANoUndefReturned(const IRPosition &IRP, Attributor &A)
10470 : AAReturnedFromReturnedValues<AANoUndef, AANoUndefImpl>(IRP, A) {}
10471
10472 /// See AbstractAttribute::trackStatistics()
10473 void trackStatistics() const override { STATS_DECLTRACK_FNRET_ATTR(noundef) }
10474};
10475
10476struct AANoUndefArgument final
10477 : AAArgumentFromCallSiteArguments<AANoUndef, AANoUndefImpl> {
10478 AANoUndefArgument(const IRPosition &IRP, Attributor &A)
10479 : AAArgumentFromCallSiteArguments<AANoUndef, AANoUndefImpl>(IRP, A) {}
10480
10481 /// See AbstractAttribute::trackStatistics()
10482 void trackStatistics() const override { STATS_DECLTRACK_ARG_ATTR(noundef) }
10483};
10484
10485struct AANoUndefCallSiteArgument final : AANoUndefFloating {
10486 AANoUndefCallSiteArgument(const IRPosition &IRP, Attributor &A)
10487 : AANoUndefFloating(IRP, A) {}
10488
10489 /// See AbstractAttribute::trackStatistics()
10490 void trackStatistics() const override { STATS_DECLTRACK_CSARG_ATTR(noundef) }
10491};
10492
10493struct AANoUndefCallSiteReturned final
10494 : AACalleeToCallSite<AANoUndef, AANoUndefImpl> {
10495 AANoUndefCallSiteReturned(const IRPosition &IRP, Attributor &A)
10496 : AACalleeToCallSite<AANoUndef, AANoUndefImpl>(IRP, A) {}
10497
10498 /// See AbstractAttribute::trackStatistics()
10499 void trackStatistics() const override { STATS_DECLTRACK_CSRET_ATTR(noundef) }
10500};
10501
10502/// ------------------------ NoFPClass Attribute -------------------------------
10503
10504struct AANoFPClassImpl : AANoFPClass {
10505 AANoFPClassImpl(const IRPosition &IRP, Attributor &A) : AANoFPClass(IRP, A) {}
10506
10507 void initialize(Attributor &A) override {
10508 const IRPosition &IRP = getIRPosition();
10509
10510 Value &V = IRP.getAssociatedValue();
10511 if (isa<UndefValue>(V)) {
10512 indicateOptimisticFixpoint();
10513 return;
10514 }
10515
10517 A.getAttrs(getIRPosition(), {Attribute::NoFPClass}, Attrs, false);
10518 for (const auto &Attr : Attrs) {
10519 addKnownBits(Attr.getNoFPClass());
10520 }
10521
10522 Instruction *CtxI = getCtxI();
10523
10524 if (getPositionKind() != IRPosition::IRP_RETURNED) {
10525 const DataLayout &DL = A.getDataLayout();
10526 InformationCache &InfoCache = A.getInfoCache();
10527
10528 const DominatorTree *DT = nullptr;
10529 AssumptionCache *AC = nullptr;
10530 const TargetLibraryInfo *TLI = nullptr;
10531 Function *F = getAnchorScope();
10532 if (F) {
10533 TLI = InfoCache.getTargetLibraryInfoForFunction(*F);
10534 if (!F->isDeclaration()) {
10535 DT =
10536 InfoCache.getAnalysisResultForFunction<DominatorTreeAnalysis>(*F);
10537 AC = InfoCache.getAnalysisResultForFunction<AssumptionAnalysis>(*F);
10538 }
10539 }
10540
10541 SimplifyQuery Q(DL, TLI, DT, AC, CtxI);
10542
10543 KnownFPClass KnownFPClass = computeKnownFPClass(&V, fcAllFlags, Q);
10544 addKnownBits(~KnownFPClass.getKnownFPClasses());
10545 }
10546
10547 if (CtxI)
10548 followUsesInMBEC(*this, A, getState(), *CtxI);
10549 }
10550
10551 /// See followUsesInMBEC
10552 bool followUseInMBEC(Attributor &A, const Use *U, const Instruction *I,
10553 AANoFPClass::StateType &State) {
10554 // TODO: Determine what instructions can be looked through.
10555 auto *CB = dyn_cast<CallBase>(I);
10556 if (!CB)
10557 return false;
10558
10559 if (!CB->isArgOperand(U))
10560 return false;
10561
10562 unsigned ArgNo = CB->getArgOperandNo(U);
10563 IRPosition IRP = IRPosition::callsite_argument(*CB, ArgNo);
10564 if (auto *NoFPAA = A.getAAFor<AANoFPClass>(*this, IRP, DepClassTy::NONE))
10565 State.addKnownBits(NoFPAA->getState().getKnown());
10566 return false;
10567 }
10568
10569 const std::string getAsStr(Attributor *A) const override {
10570 std::string Result = "nofpclass";
10571 raw_string_ostream OS(Result);
10572 OS << getKnownNoFPClass() << '/' << getAssumedNoFPClass();
10573 return Result;
10574 }
10575
10576 void getDeducedAttributes(Attributor &A, LLVMContext &Ctx,
10577 SmallVectorImpl<Attribute> &Attrs) const override {
10578 Attrs.emplace_back(Attribute::getWithNoFPClass(Ctx, getAssumedNoFPClass()));
10579 }
10580};
10581
10582struct AANoFPClassFloating : public AANoFPClassImpl {
10583 AANoFPClassFloating(const IRPosition &IRP, Attributor &A)
10584 : AANoFPClassImpl(IRP, A) {}
10585
10586 /// See AbstractAttribute::updateImpl(...).
10587 ChangeStatus updateImpl(Attributor &A) override {
10589 bool UsedAssumedInformation = false;
10590 if (!A.getAssumedSimplifiedValues(getIRPosition(), *this, Values,
10591 AA::AnyScope, UsedAssumedInformation)) {
10592 Values.push_back({getAssociatedValue(), getCtxI()});
10593 }
10594
10595 StateType T;
10596 auto VisitValueCB = [&](Value &V, const Instruction *CtxI) -> bool {
10597 const auto *AA = A.getAAFor<AANoFPClass>(*this, IRPosition::value(V),
10598 DepClassTy::REQUIRED);
10599 if (!AA || this == AA) {
10600 T.indicatePessimisticFixpoint();
10601 } else {
10602 const AANoFPClass::StateType &S =
10603 static_cast<const AANoFPClass::StateType &>(AA->getState());
10604 T ^= S;
10605 }
10606 return T.isValidState();
10607 };
10608
10609 for (const auto &VAC : Values)
10610 if (!VisitValueCB(*VAC.getValue(), VAC.getCtxI()))
10611 return indicatePessimisticFixpoint();
10612
10613 return clampStateAndIndicateChange(getState(), T);
10614 }
10615
10616 /// See AbstractAttribute::trackStatistics()
10617 void trackStatistics() const override {
10619 }
10620};
10621
10622struct AANoFPClassReturned final
10623 : AAReturnedFromReturnedValues<AANoFPClass, AANoFPClassImpl,
10624 AANoFPClassImpl::StateType, false,
10625 Attribute::None, false> {
10626 AANoFPClassReturned(const IRPosition &IRP, Attributor &A)
10627 : AAReturnedFromReturnedValues<AANoFPClass, AANoFPClassImpl,
10628 AANoFPClassImpl::StateType, false,
10629 Attribute::None, false>(IRP, A) {}
10630
10631 /// See AbstractAttribute::trackStatistics()
10632 void trackStatistics() const override {
10634 }
10635};
10636
10637struct AANoFPClassArgument final
10638 : AAArgumentFromCallSiteArguments<AANoFPClass, AANoFPClassImpl> {
10639 AANoFPClassArgument(const IRPosition &IRP, Attributor &A)
10640 : AAArgumentFromCallSiteArguments<AANoFPClass, AANoFPClassImpl>(IRP, A) {}
10641
10642 /// See AbstractAttribute::trackStatistics()
10643 void trackStatistics() const override { STATS_DECLTRACK_ARG_ATTR(nofpclass) }
10644};
10645
10646struct AANoFPClassCallSiteArgument final : AANoFPClassFloating {
10647 AANoFPClassCallSiteArgument(const IRPosition &IRP, Attributor &A)
10648 : AANoFPClassFloating(IRP, A) {}
10649
10650 /// See AbstractAttribute::trackStatistics()
10651 void trackStatistics() const override {
10653 }
10654};
10655
10656struct AANoFPClassCallSiteReturned final
10657 : AACalleeToCallSite<AANoFPClass, AANoFPClassImpl> {
10658 AANoFPClassCallSiteReturned(const IRPosition &IRP, Attributor &A)
10659 : AACalleeToCallSite<AANoFPClass, AANoFPClassImpl>(IRP, A) {}
10660
10661 /// See AbstractAttribute::trackStatistics()
10662 void trackStatistics() const override {
10664 }
10665};
10666
10667struct AACallEdgesImpl : public AACallEdges {
10668 AACallEdgesImpl(const IRPosition &IRP, Attributor &A) : AACallEdges(IRP, A) {}
10669
10670 const SetVector<Function *> &getOptimisticEdges() const override {
10671 return CalledFunctions;
10672 }
10673
10674 bool hasUnknownCallee() const override { return HasUnknownCallee; }
10675
10676 bool hasNonAsmUnknownCallee() const override {
10677 return HasUnknownCalleeNonAsm;
10678 }
10679
10680 const std::string getAsStr(Attributor *A) const override {
10681 return "CallEdges[" + std::to_string(HasUnknownCallee) + "," +
10682 std::to_string(CalledFunctions.size()) + "]";
10683 }
10684
10685 void trackStatistics() const override {}
10686
10687protected:
10688 void addCalledFunction(Function *Fn, ChangeStatus &Change) {
10689 if (CalledFunctions.insert(Fn)) {
10690 Change = ChangeStatus::CHANGED;
10691 LLVM_DEBUG(dbgs() << "[AACallEdges] New call edge: " << Fn->getName()
10692 << "\n");
10693 }
10694 }
10695
10696 void setHasUnknownCallee(bool NonAsm, ChangeStatus &Change) {
10697 if (!HasUnknownCallee)
10698 Change = ChangeStatus::CHANGED;
10699 if (NonAsm && !HasUnknownCalleeNonAsm)
10700 Change = ChangeStatus::CHANGED;
10701 HasUnknownCalleeNonAsm |= NonAsm;
10702 HasUnknownCallee = true;
10703 }
10704
10705private:
10706 /// Optimistic set of functions that might be called by this position.
10707 SetVector<Function *> CalledFunctions;
10708
10709 /// Is there any call with a unknown callee.
10710 bool HasUnknownCallee = false;
10711
10712 /// Is there any call with a unknown callee, excluding any inline asm.
10713 bool HasUnknownCalleeNonAsm = false;
10714};
10715
10716struct AACallEdgesCallSite : public AACallEdgesImpl {
10717 AACallEdgesCallSite(const IRPosition &IRP, Attributor &A)
10718 : AACallEdgesImpl(IRP, A) {}
10719 /// See AbstractAttribute::updateImpl(...).
10720 ChangeStatus updateImpl(Attributor &A) override {
10721 ChangeStatus Change = ChangeStatus::UNCHANGED;
10722
10723 auto VisitValue = [&](Value &V, const Instruction *CtxI) -> bool {
10724 if (Function *Fn = dyn_cast<Function>(&V)) {
10725 addCalledFunction(Fn, Change);
10726 } else {
10727 LLVM_DEBUG(dbgs() << "[AACallEdges] Unrecognized value: " << V << "\n");
10728 setHasUnknownCallee(true, Change);
10729 }
10730
10731 // Explore all values.
10732 return true;
10733 };
10734
10736 // Process any value that we might call.
10737 auto ProcessCalledOperand = [&](Value *V, Instruction *CtxI) {
10738 if (isa<Constant>(V)) {
10739 VisitValue(*V, CtxI);
10740 return;
10741 }
10742
10743 bool UsedAssumedInformation = false;
10744 Values.clear();
10745 if (!A.getAssumedSimplifiedValues(IRPosition::value(*V), *this, Values,
10746 AA::AnyScope, UsedAssumedInformation)) {
10747 Values.push_back({*V, CtxI});
10748 }
10749 for (auto &VAC : Values)
10750 VisitValue(*VAC.getValue(), VAC.getCtxI());
10751 };
10752
10753 CallBase *CB = cast<CallBase>(getCtxI());
10754
10755 if (auto *IA = dyn_cast<InlineAsm>(CB->getCalledOperand())) {
10756 if (IA->hasSideEffects() &&
10757 !hasAssumption(*CB->getCaller(), "ompx_no_call_asm") &&
10758 !hasAssumption(*CB, "ompx_no_call_asm")) {
10759 setHasUnknownCallee(false, Change);
10760 }
10761 return Change;
10762 }
10763
10764 if (CB->isIndirectCall())
10765 if (auto *IndirectCallAA = A.getAAFor<AAIndirectCallInfo>(
10766 *this, getIRPosition(), DepClassTy::OPTIONAL))
10767 if (IndirectCallAA->foreachCallee(
10768 [&](Function *Fn) { return VisitValue(*Fn, CB); }))
10769 return Change;
10770
10771 // The most simple case.
10772 ProcessCalledOperand(CB->getCalledOperand(), CB);
10773
10774 // Process callback functions.
10775 SmallVector<const Use *, 4u> CallbackUses;
10776 AbstractCallSite::getCallbackUses(*CB, CallbackUses);
10777 for (const Use *U : CallbackUses)
10778 ProcessCalledOperand(U->get(), CB);
10779
10780 return Change;
10781 }
10782};
10783
10784struct AACallEdgesFunction : public AACallEdgesImpl {
10785 AACallEdgesFunction(const IRPosition &IRP, Attributor &A)
10786 : AACallEdgesImpl(IRP, A) {}
10787
10788 /// See AbstractAttribute::updateImpl(...).
10789 ChangeStatus updateImpl(Attributor &A) override {
10790 ChangeStatus Change = ChangeStatus::UNCHANGED;
10791
10792 auto ProcessCallInst = [&](Instruction &Inst) {
10793 CallBase &CB = cast<CallBase>(Inst);
10794
10795 auto *CBEdges = A.getAAFor<AACallEdges>(
10796 *this, IRPosition::callsite_function(CB), DepClassTy::REQUIRED);
10797 if (!CBEdges)
10798 return false;
10799 if (CBEdges->hasNonAsmUnknownCallee())
10800 setHasUnknownCallee(true, Change);
10801 if (CBEdges->hasUnknownCallee())
10802 setHasUnknownCallee(false, Change);
10803
10804 for (Function *F : CBEdges->getOptimisticEdges())
10805 addCalledFunction(F, Change);
10806
10807 return true;
10808 };
10809
10810 // Visit all callable instructions.
10811 bool UsedAssumedInformation = false;
10812 if (!A.checkForAllCallLikeInstructions(ProcessCallInst, *this,
10813 UsedAssumedInformation,
10814 /* CheckBBLivenessOnly */ true)) {
10815 // If we haven't looked at all call like instructions, assume that there
10816 // are unknown callees.
10817 setHasUnknownCallee(true, Change);
10818 }
10819
10820 return Change;
10821 }
10822};
10823
10824/// -------------------AAInterFnReachability Attribute--------------------------
10825
10826struct AAInterFnReachabilityFunction
10827 : public CachedReachabilityAA<AAInterFnReachability, Function> {
10828 using Base = CachedReachabilityAA<AAInterFnReachability, Function>;
10829 AAInterFnReachabilityFunction(const IRPosition &IRP, Attributor &A)
10830 : Base(IRP, A) {}
10831
10832 bool instructionCanReach(
10833 Attributor &A, const Instruction &From, const Function &To,
10834 const AA::InstExclusionSetTy *ExclusionSet) const override {
10835 assert(From.getFunction() == getAnchorScope() && "Queried the wrong AA!");
10836 auto *NonConstThis = const_cast<AAInterFnReachabilityFunction *>(this);
10837
10838 RQITy StackRQI(A, From, To, ExclusionSet, false);
10839 RQITy::Reachable Result;
10840 if (!NonConstThis->checkQueryCache(A, StackRQI, Result))
10841 return NonConstThis->isReachableImpl(A, StackRQI,
10842 /*IsTemporaryRQI=*/true);
10843 return Result == RQITy::Reachable::Yes;
10844 }
10845
10846 bool isReachableImpl(Attributor &A, RQITy &RQI,
10847 bool IsTemporaryRQI) override {
10848 const Instruction *EntryI =
10849 &RQI.From->getFunction()->getEntryBlock().front();
10850 if (EntryI != RQI.From &&
10851 !instructionCanReach(A, *EntryI, *RQI.To, nullptr))
10852 return rememberResult(A, RQITy::Reachable::No, RQI, false,
10853 IsTemporaryRQI);
10854
10855 auto CheckReachableCallBase = [&](CallBase *CB) {
10856 auto *CBEdges = A.getAAFor<AACallEdges>(
10857 *this, IRPosition::callsite_function(*CB), DepClassTy::OPTIONAL);
10858 if (!CBEdges || !CBEdges->getState().isValidState())
10859 return false;
10860 // TODO Check To backwards in this case.
10861 if (CBEdges->hasUnknownCallee())
10862 return false;
10863
10864 for (Function *Fn : CBEdges->getOptimisticEdges()) {
10865 if (Fn == RQI.To)
10866 return false;
10867
10868 if (Fn->isDeclaration()) {
10869 if (Fn->hasFnAttribute(Attribute::NoCallback))
10870 continue;
10871 // TODO Check To backwards in this case.
10872 return false;
10873 }
10874
10875 if (Fn == getAnchorScope()) {
10876 if (EntryI == RQI.From)
10877 continue;
10878 return false;
10879 }
10880
10881 const AAInterFnReachability *InterFnReachability =
10882 A.getAAFor<AAInterFnReachability>(*this, IRPosition::function(*Fn),
10883 DepClassTy::OPTIONAL);
10884
10885 const Instruction &FnFirstInst = Fn->getEntryBlock().front();
10886 if (!InterFnReachability ||
10887 InterFnReachability->instructionCanReach(A, FnFirstInst, *RQI.To,
10888 RQI.ExclusionSet))
10889 return false;
10890 }
10891 return true;
10892 };
10893
10894 const auto *IntraFnReachability = A.getAAFor<AAIntraFnReachability>(
10895 *this, IRPosition::function(*RQI.From->getFunction()),
10896 DepClassTy::OPTIONAL);
10897
10898 // Determine call like instructions that we can reach from the inst.
10899 auto CheckCallBase = [&](Instruction &CBInst) {
10900 // There are usually less nodes in the call graph, check inter function
10901 // reachability first.
10902 if (CheckReachableCallBase(cast<CallBase>(&CBInst)))
10903 return true;
10904 return IntraFnReachability && !IntraFnReachability->isAssumedReachable(
10905 A, *RQI.From, CBInst, RQI.ExclusionSet);
10906 };
10907
10908 bool UsedExclusionSet = /* conservative */ true;
10909 bool UsedAssumedInformation = false;
10910 if (!A.checkForAllCallLikeInstructions(CheckCallBase, *this,
10911 UsedAssumedInformation,
10912 /* CheckBBLivenessOnly */ true))
10913 return rememberResult(A, RQITy::Reachable::Yes, RQI, UsedExclusionSet,
10914 IsTemporaryRQI);
10915
10916 return rememberResult(A, RQITy::Reachable::No, RQI, UsedExclusionSet,
10917 IsTemporaryRQI);
10918 }
10919
10920 void trackStatistics() const override {}
10921};
10922} // namespace
10923
10924template <typename AAType>
10925static std::optional<Constant *>
10927 const IRPosition &IRP, Type &Ty) {
10928 if (!Ty.isIntegerTy())
10929 return nullptr;
10930
10931 // This will also pass the call base context.
10932 const auto *AA = A.getAAFor<AAType>(QueryingAA, IRP, DepClassTy::NONE);
10933 if (!AA)
10934 return nullptr;
10935
10936 std::optional<Constant *> COpt = AA->getAssumedConstant(A);
10937
10938 if (!COpt.has_value()) {
10939 A.recordDependence(*AA, QueryingAA, DepClassTy::OPTIONAL);
10940 return std::nullopt;
10941 }
10942 if (auto *C = *COpt) {
10943 A.recordDependence(*AA, QueryingAA, DepClassTy::OPTIONAL);
10944 return C;
10945 }
10946 return nullptr;
10947}
10948
10950 Attributor &A, const AbstractAttribute &AA, const IRPosition &IRP,
10952 Type &Ty = *IRP.getAssociatedType();
10953 std::optional<Value *> V;
10954 for (auto &It : Values) {
10955 V = AA::combineOptionalValuesInAAValueLatice(V, It.getValue(), &Ty);
10956 if (V.has_value() && !*V)
10957 break;
10958 }
10959 if (!V.has_value())
10960 return UndefValue::get(&Ty);
10961 return *V;
10962}
10963
10964namespace {
10965struct AAPotentialValuesImpl : AAPotentialValues {
10966 using StateType = PotentialLLVMValuesState;
10967
10968 AAPotentialValuesImpl(const IRPosition &IRP, Attributor &A)
10969 : AAPotentialValues(IRP, A) {}
10970
10971 /// See AbstractAttribute::initialize(..).
10972 void initialize(Attributor &A) override {
10973 if (A.hasSimplificationCallback(getIRPosition())) {
10974 indicatePessimisticFixpoint();
10975 return;
10976 }
10977 Value *Stripped = getAssociatedValue().stripPointerCasts();
10978 if (isa<Constant>(Stripped) && !isa<ConstantExpr>(Stripped)) {
10979 addValue(A, getState(), *Stripped, getCtxI(), AA::AnyScope,
10980 getAnchorScope());
10981 indicateOptimisticFixpoint();
10982 return;
10983 }
10984 AAPotentialValues::initialize(A);
10985 }
10986
10987 /// See AbstractAttribute::getAsStr().
10988 const std::string getAsStr(Attributor *A) const override {
10989 std::string Str;
10990 llvm::raw_string_ostream OS(Str);
10991 OS << getState();
10992 return Str;
10993 }
10994
10995 template <typename AAType>
10996 static std::optional<Value *> askOtherAA(Attributor &A,
10997 const AbstractAttribute &AA,
10998 const IRPosition &IRP, Type &Ty) {
11000 return &IRP.getAssociatedValue();
11001 std::optional<Constant *> C = askForAssumedConstant<AAType>(A, AA, IRP, Ty);
11002 if (!C)
11003 return std::nullopt;
11004 if (*C)
11005 if (auto *CC = AA::getWithType(**C, Ty))
11006 return CC;
11007 return nullptr;
11008 }
11009
11010 virtual void addValue(Attributor &A, StateType &State, Value &V,
11011 const Instruction *CtxI, AA::ValueScope S,
11012 Function *AnchorScope) const {
11013
11014 IRPosition ValIRP = IRPosition::value(V);
11015 if (auto *CB = dyn_cast_or_null<CallBase>(CtxI)) {
11016 for (const auto &U : CB->args()) {
11017 if (U.get() != &V)
11018 continue;
11019 ValIRP = IRPosition::callsite_argument(*CB, CB->getArgOperandNo(&U));
11020 break;
11021 }
11022 }
11023
11024 Value *VPtr = &V;
11025 if (ValIRP.getAssociatedType()->isIntegerTy()) {
11026 Type &Ty = *getAssociatedType();
11027 std::optional<Value *> SimpleV =
11028 askOtherAA<AAValueConstantRange>(A, *this, ValIRP, Ty);
11029 if (SimpleV.has_value() && !*SimpleV) {
11030 auto *PotentialConstantsAA = A.getAAFor<AAPotentialConstantValues>(
11031 *this, ValIRP, DepClassTy::OPTIONAL);
11032 if (PotentialConstantsAA && PotentialConstantsAA->isValidState()) {
11033 for (const auto &It : PotentialConstantsAA->getAssumedSet())
11034 State.unionAssumed({{*ConstantInt::get(&Ty, It), nullptr}, S});
11035 if (PotentialConstantsAA->undefIsContained())
11036 State.unionAssumed({{*UndefValue::get(&Ty), nullptr}, S});
11037 return;
11038 }
11039 }
11040 if (!SimpleV.has_value())
11041 return;
11042
11043 if (*SimpleV)
11044 VPtr = *SimpleV;
11045 }
11046
11047 if (isa<ConstantInt>(VPtr))
11048 CtxI = nullptr;
11049 if (!AA::isValidInScope(*VPtr, AnchorScope))
11051
11052 State.unionAssumed({{*VPtr, CtxI}, S});
11053 }
11054
11055 /// Helper struct to tie a value+context pair together with the scope for
11056 /// which this is the simplified version.
11057 struct ItemInfo {
11058 AA::ValueAndContext I;
11060
11061 bool operator==(const ItemInfo &II) const {
11062 return II.I == I && II.S == S;
11063 };
11064 bool operator<(const ItemInfo &II) const {
11065 return std::tie(I, S) < std::tie(II.I, II.S);
11066 };
11067 };
11068
11069 bool recurseForValue(Attributor &A, const IRPosition &IRP, AA::ValueScope S) {
11070 SmallMapVector<AA::ValueAndContext, int, 8> ValueScopeMap;
11071 for (auto CS : {AA::Intraprocedural, AA::Interprocedural}) {
11072 if (!(CS & S))
11073 continue;
11074
11075 bool UsedAssumedInformation = false;
11077 if (!A.getAssumedSimplifiedValues(IRP, this, Values, CS,
11078 UsedAssumedInformation))
11079 return false;
11080
11081 for (auto &It : Values)
11082 ValueScopeMap[It] += CS;
11083 }
11084 for (auto &It : ValueScopeMap)
11085 addValue(A, getState(), *It.first.getValue(), It.first.getCtxI(),
11086 AA::ValueScope(It.second), getAnchorScope());
11087
11088 return true;
11089 }
11090
11091 void giveUpOnIntraprocedural(Attributor &A) {
11092 auto NewS = StateType::getBestState(getState());
11093 for (const auto &It : getAssumedSet()) {
11094 if (It.second == AA::Intraprocedural)
11095 continue;
11096 addValue(A, NewS, *It.first.getValue(), It.first.getCtxI(),
11097 AA::Interprocedural, getAnchorScope());
11098 }
11099 assert(!undefIsContained() && "Undef should be an explicit value!");
11100 addValue(A, NewS, getAssociatedValue(), getCtxI(), AA::Intraprocedural,
11101 getAnchorScope());
11102 getState() = NewS;
11103 }
11104
11105 /// See AbstractState::indicatePessimisticFixpoint(...).
11106 ChangeStatus indicatePessimisticFixpoint() override {
11107 getState() = StateType::getBestState(getState());
11108 getState().unionAssumed({{getAssociatedValue(), getCtxI()}, AA::AnyScope});
11109 AAPotentialValues::indicateOptimisticFixpoint();
11110 return ChangeStatus::CHANGED;
11111 }
11112
11113 /// See AbstractAttribute::updateImpl(...).
11114 ChangeStatus updateImpl(Attributor &A) override {
11115 return indicatePessimisticFixpoint();
11116 }
11117
11118 /// See AbstractAttribute::manifest(...).
11119 ChangeStatus manifest(Attributor &A) override {
11122 Values.clear();
11123 if (!getAssumedSimplifiedValues(A, Values, S))
11124 continue;
11125 Value &OldV = getAssociatedValue();
11126 if (isa<UndefValue>(OldV))
11127 continue;
11128 Value *NewV = getSingleValue(A, *this, getIRPosition(), Values);
11129 if (!NewV || NewV == &OldV)
11130 continue;
11131 if (getCtxI() &&
11132 !AA::isValidAtPosition({*NewV, *getCtxI()}, A.getInfoCache()))
11133 continue;
11134 if (A.changeAfterManifest(getIRPosition(), *NewV))
11135 return ChangeStatus::CHANGED;
11136 }
11137 return ChangeStatus::UNCHANGED;
11138 }
11139
11140 bool getAssumedSimplifiedValues(
11141 Attributor &A, SmallVectorImpl<AA::ValueAndContext> &Values,
11142 AA::ValueScope S, bool RecurseForSelectAndPHI = false) const override {
11143 if (!isValidState())
11144 return false;
11145 bool UsedAssumedInformation = false;
11146 for (const auto &It : getAssumedSet())
11147 if (It.second & S) {
11148 if (RecurseForSelectAndPHI && (isa<PHINode>(It.first.getValue()) ||
11149 isa<SelectInst>(It.first.getValue()))) {
11150 if (A.getAssumedSimplifiedValues(
11151 IRPosition::inst(*cast<Instruction>(It.first.getValue())),
11152 this, Values, S, UsedAssumedInformation))
11153 continue;
11154 }
11155 Values.push_back(It.first);
11156 }
11157 assert(!undefIsContained() && "Undef should be an explicit value!");
11158 return true;
11159 }
11160};
11161
11162struct AAPotentialValuesFloating : AAPotentialValuesImpl {
11163 AAPotentialValuesFloating(const IRPosition &IRP, Attributor &A)
11164 : AAPotentialValuesImpl(IRP, A) {}
11165
11166 /// See AbstractAttribute::updateImpl(...).
11167 ChangeStatus updateImpl(Attributor &A) override {
11168 auto AssumedBefore = getAssumed();
11169
11170 genericValueTraversal(A, &getAssociatedValue());
11171
11172 return (AssumedBefore == getAssumed()) ? ChangeStatus::UNCHANGED
11173 : ChangeStatus::CHANGED;
11174 }
11175
11176 /// Helper struct to remember which AAIsDead instances we actually used.
11177 struct LivenessInfo {
11178 const AAIsDead *LivenessAA = nullptr;
11179 bool AnyDead = false;
11180 };
11181
11182 /// Check if \p Cmp is a comparison we can simplify.
11183 ///
11184 /// We handle multiple cases, one in which at least one operand is an
11185 /// (assumed) nullptr. If so, try to simplify it using AANonNull on the other
11186 /// operand. Return true if successful, in that case Worklist will be updated.
11187 bool handleCmp(Attributor &A, Value &Cmp, Value *LHS, Value *RHS,
11188 CmpInst::Predicate Pred, ItemInfo II,
11189 SmallVectorImpl<ItemInfo> &Worklist) {
11190
11191 // Simplify the operands first.
11192 bool UsedAssumedInformation = false;
11193 SmallVector<AA::ValueAndContext> LHSValues, RHSValues;
11194 auto GetSimplifiedValues = [&](Value &V,
11196 if (!A.getAssumedSimplifiedValues(
11197 IRPosition::value(V, getCallBaseContext()), this, Values,
11198 AA::Intraprocedural, UsedAssumedInformation)) {
11199 Values.clear();
11200 Values.push_back(AA::ValueAndContext{V, II.I.getCtxI()});
11201 }
11202 return Values.empty();
11203 };
11204 if (GetSimplifiedValues(*LHS, LHSValues))
11205 return true;
11206 if (GetSimplifiedValues(*RHS, RHSValues))
11207 return true;
11208
11209 LLVMContext &Ctx = LHS->getContext();
11210
11211 InformationCache &InfoCache = A.getInfoCache();
11212 Instruction *CmpI = dyn_cast<Instruction>(&Cmp);
11213 Function *F = CmpI ? CmpI->getFunction() : nullptr;
11214 const auto *DT =
11215 F ? InfoCache.getAnalysisResultForFunction<DominatorTreeAnalysis>(*F)
11216 : nullptr;
11217 const auto *TLI =
11218 F ? A.getInfoCache().getTargetLibraryInfoForFunction(*F) : nullptr;
11219 auto *AC =
11220 F ? InfoCache.getAnalysisResultForFunction<AssumptionAnalysis>(*F)
11221 : nullptr;
11222
11223 const DataLayout &DL = A.getDataLayout();
11224 SimplifyQuery Q(DL, TLI, DT, AC, CmpI);
11225
11226 auto CheckPair = [&](Value &LHSV, Value &RHSV) {
11227 if (isa<UndefValue>(LHSV) || isa<UndefValue>(RHSV)) {
11228 addValue(A, getState(), *UndefValue::get(Cmp.getType()),
11229 /* CtxI */ nullptr, II.S, getAnchorScope());
11230 return true;
11231 }
11232
11233 // Handle the trivial case first in which we don't even need to think
11234 // about null or non-null.
11235 if (&LHSV == &RHSV &&
11237 Constant *NewV = ConstantInt::get(Type::getInt1Ty(Ctx),
11239 addValue(A, getState(), *NewV, /* CtxI */ nullptr, II.S,
11240 getAnchorScope());
11241 return true;
11242 }
11243
11244 auto *TypedLHS = AA::getWithType(LHSV, *LHS->getType());
11245 auto *TypedRHS = AA::getWithType(RHSV, *RHS->getType());
11246 if (TypedLHS && TypedRHS) {
11247 Value *NewV = simplifyCmpInst(Pred, TypedLHS, TypedRHS, Q);
11248 if (NewV && NewV != &Cmp) {
11249 addValue(A, getState(), *NewV, /* CtxI */ nullptr, II.S,
11250 getAnchorScope());
11251 return true;
11252 }
11253 }
11254
11255 // From now on we only handle equalities (==, !=).
11256 if (!CmpInst::isEquality(Pred))
11257 return false;
11258
11259 bool LHSIsNull = isa<ConstantPointerNull>(LHSV);
11260 bool RHSIsNull = isa<ConstantPointerNull>(RHSV);
11261 if (!LHSIsNull && !RHSIsNull)
11262 return false;
11263
11264 // Left is the nullptr ==/!= non-nullptr case. We'll use AANonNull on the
11265 // non-nullptr operand and if we assume it's non-null we can conclude the
11266 // result of the comparison.
11267 assert((LHSIsNull || RHSIsNull) &&
11268 "Expected nullptr versus non-nullptr comparison at this point");
11269
11270 // The index is the operand that we assume is not null.
11271 unsigned PtrIdx = LHSIsNull;
11272 bool IsKnownNonNull;
11273 bool IsAssumedNonNull = AA::hasAssumedIRAttr<Attribute::NonNull>(
11274 A, this, IRPosition::value(*(PtrIdx ? &RHSV : &LHSV)),
11275 DepClassTy::REQUIRED, IsKnownNonNull);
11276 if (!IsAssumedNonNull)
11277 return false;
11278
11279 // The new value depends on the predicate, true for != and false for ==.
11280 Constant *NewV =
11281 ConstantInt::get(Type::getInt1Ty(Ctx), Pred == CmpInst::ICMP_NE);
11282 addValue(A, getState(), *NewV, /* CtxI */ nullptr, II.S,
11283 getAnchorScope());
11284 return true;
11285 };
11286
11287 for (auto &LHSValue : LHSValues)
11288 for (auto &RHSValue : RHSValues)
11289 if (!CheckPair(*LHSValue.getValue(), *RHSValue.getValue()))
11290 return false;
11291 return true;
11292 }
11293
11294 bool handleSelectInst(Attributor &A, SelectInst &SI, ItemInfo II,
11295 SmallVectorImpl<ItemInfo> &Worklist) {
11296 const Instruction *CtxI = II.I.getCtxI();
11297 bool UsedAssumedInformation = false;
11298
11299 std::optional<Constant *> C =
11300 A.getAssumedConstant(*SI.getCondition(), *this, UsedAssumedInformation);
11301 bool NoValueYet = !C.has_value();
11302 if (NoValueYet || isa_and_nonnull<UndefValue>(*C))
11303 return true;
11304 if (auto *CI = dyn_cast_or_null<ConstantInt>(*C)) {
11305 if (CI->isZero())
11306 Worklist.push_back({{*SI.getFalseValue(), CtxI}, II.S});
11307 else
11308 Worklist.push_back({{*SI.getTrueValue(), CtxI}, II.S});
11309 } else if (&SI == &getAssociatedValue()) {
11310 // We could not simplify the condition, assume both values.
11311 Worklist.push_back({{*SI.getTrueValue(), CtxI}, II.S});
11312 Worklist.push_back({{*SI.getFalseValue(), CtxI}, II.S});
11313 } else {
11314 std::optional<Value *> SimpleV = A.getAssumedSimplified(
11315 IRPosition::inst(SI), *this, UsedAssumedInformation, II.S);
11316 if (!SimpleV.has_value())
11317 return true;
11318 if (*SimpleV) {
11319 addValue(A, getState(), **SimpleV, CtxI, II.S, getAnchorScope());
11320 return true;
11321 }
11322 return false;
11323 }
11324 return true;
11325 }
11326
11327 bool handleLoadInst(Attributor &A, LoadInst &LI, ItemInfo II,
11328 SmallVectorImpl<ItemInfo> &Worklist) {
11329 SmallSetVector<Value *, 4> PotentialCopies;
11330 SmallSetVector<Instruction *, 4> PotentialValueOrigins;
11331 bool UsedAssumedInformation = false;
11332 if (!AA::getPotentiallyLoadedValues(A, LI, PotentialCopies,
11333 PotentialValueOrigins, *this,
11334 UsedAssumedInformation,
11335 /* OnlyExact */ true)) {
11336 LLVM_DEBUG(dbgs() << "[AAPotentialValues] Failed to get potentially "
11337 "loaded values for load instruction "
11338 << LI << "\n");
11339 return false;
11340 }
11341
11342 // Do not simplify loads that are only used in llvm.assume if we cannot also
11343 // remove all stores that may feed into the load. The reason is that the
11344 // assume is probably worth something as long as the stores are around.
11345 InformationCache &InfoCache = A.getInfoCache();
11346 if (InfoCache.isOnlyUsedByAssume(LI)) {
11347 if (!llvm::all_of(PotentialValueOrigins, [&](Instruction *I) {
11348 if (!I || isa<AssumeInst>(I))
11349 return true;
11350 if (auto *SI = dyn_cast<StoreInst>(I))
11351 return A.isAssumedDead(SI->getOperandUse(0), this,
11352 /* LivenessAA */ nullptr,
11353 UsedAssumedInformation,
11354 /* CheckBBLivenessOnly */ false);
11355 return A.isAssumedDead(*I, this, /* LivenessAA */ nullptr,
11356 UsedAssumedInformation,
11357 /* CheckBBLivenessOnly */ false);
11358 })) {
11359 LLVM_DEBUG(dbgs() << "[AAPotentialValues] Load is onl used by assumes "
11360 "and we cannot delete all the stores: "
11361 << LI << "\n");
11362 return false;
11363 }
11364 }
11365
11366 // Values have to be dynamically unique or we loose the fact that a
11367 // single llvm::Value might represent two runtime values (e.g.,
11368 // stack locations in different recursive calls).
11369 const Instruction *CtxI = II.I.getCtxI();
11370 bool ScopeIsLocal = (II.S & AA::Intraprocedural);
11371 bool AllLocal = ScopeIsLocal;
11372 bool DynamicallyUnique = llvm::all_of(PotentialCopies, [&](Value *PC) {
11373 AllLocal &= AA::isValidInScope(*PC, getAnchorScope());
11374 return AA::isDynamicallyUnique(A, *this, *PC);
11375 });
11376 if (!DynamicallyUnique) {
11377 LLVM_DEBUG(dbgs() << "[AAPotentialValues] Not all potentially loaded "
11378 "values are dynamically unique: "
11379 << LI << "\n");
11380 return false;
11381 }
11382
11383 for (auto *PotentialCopy : PotentialCopies) {
11384 if (AllLocal) {
11385 Worklist.push_back({{*PotentialCopy, CtxI}, II.S});
11386 } else {
11387 Worklist.push_back({{*PotentialCopy, CtxI}, AA::Interprocedural});
11388 }
11389 }
11390 if (!AllLocal && ScopeIsLocal)
11391 addValue(A, getState(), LI, CtxI, AA::Intraprocedural, getAnchorScope());
11392 return true;
11393 }
11394
11395 bool handlePHINode(
11396 Attributor &A, PHINode &PHI, ItemInfo II,
11397 SmallVectorImpl<ItemInfo> &Worklist,
11398 SmallMapVector<const Function *, LivenessInfo, 4> &LivenessAAs) {
11399 auto GetLivenessInfo = [&](const Function &F) -> LivenessInfo & {
11400 LivenessInfo &LI = LivenessAAs[&F];
11401 if (!LI.LivenessAA)
11402 LI.LivenessAA = A.getAAFor<AAIsDead>(*this, IRPosition::function(F),
11403 DepClassTy::NONE);
11404 return LI;
11405 };
11406
11407 if (&PHI == &getAssociatedValue()) {
11408 LivenessInfo &LI = GetLivenessInfo(*PHI.getFunction());
11409 const auto *CI =
11410 A.getInfoCache().getAnalysisResultForFunction<CycleAnalysis>(
11411 *PHI.getFunction());
11412
11413 CycleRef C;
11414 bool CyclePHI = mayBeInCycle(CI, &PHI, /* HeaderOnly */ true, &C);
11415 for (unsigned u = 0, e = PHI.getNumIncomingValues(); u < e; u++) {
11416 BasicBlock *IncomingBB = PHI.getIncomingBlock(u);
11417 if (LI.LivenessAA &&
11418 LI.LivenessAA->isEdgeDead(IncomingBB, PHI.getParent())) {
11419 LI.AnyDead = true;
11420 continue;
11421 }
11422 Value *V = PHI.getIncomingValue(u);
11423 if (V == &PHI)
11424 continue;
11425
11426 // If the incoming value is not the PHI but an instruction in the same
11427 // cycle we might have multiple versions of it flying around.
11428 if (CyclePHI && isa<Instruction>(V) &&
11429 (!C || CI->contains(C, cast<Instruction>(V)->getParent())))
11430 return false;
11431
11432 Worklist.push_back({{*V, IncomingBB->getTerminator()}, II.S});
11433 }
11434 return true;
11435 }
11436
11437 bool UsedAssumedInformation = false;
11438 std::optional<Value *> SimpleV = A.getAssumedSimplified(
11439 IRPosition::inst(PHI), *this, UsedAssumedInformation, II.S);
11440 if (!SimpleV.has_value())
11441 return true;
11442 if (!(*SimpleV))
11443 return false;
11444 addValue(A, getState(), **SimpleV, &PHI, II.S, getAnchorScope());
11445 return true;
11446 }
11447
11448 /// Use the generic, non-optimistic InstSimplfy functionality if we managed to
11449 /// simplify any operand of the instruction \p I. Return true if successful,
11450 /// in that case Worklist will be updated.
11451 bool handleGenericInst(Attributor &A, Instruction &I, ItemInfo II,
11452 SmallVectorImpl<ItemInfo> &Worklist) {
11453 bool SomeSimplified = false;
11454 bool UsedAssumedInformation = false;
11455
11456 SmallVector<Value *, 8> NewOps(I.getNumOperands());
11457 int Idx = 0;
11458 for (Value *Op : I.operands()) {
11459 const auto &SimplifiedOp = A.getAssumedSimplified(
11460 IRPosition::value(*Op, getCallBaseContext()), *this,
11461 UsedAssumedInformation, AA::Intraprocedural);
11462 // If we are not sure about any operand we are not sure about the entire
11463 // instruction, we'll wait.
11464 if (!SimplifiedOp.has_value())
11465 return true;
11466
11467 if (*SimplifiedOp)
11468 NewOps[Idx] = *SimplifiedOp;
11469 else
11470 NewOps[Idx] = Op;
11471
11472 SomeSimplified |= (NewOps[Idx] != Op);
11473 ++Idx;
11474 }
11475
11476 // We won't bother with the InstSimplify interface if we didn't simplify any
11477 // operand ourselves.
11478 if (!SomeSimplified)
11479 return false;
11480
11481 InformationCache &InfoCache = A.getInfoCache();
11482 Function *F = I.getFunction();
11483 const auto *DT =
11484 InfoCache.getAnalysisResultForFunction<DominatorTreeAnalysis>(*F);
11485 const auto *TLI = A.getInfoCache().getTargetLibraryInfoForFunction(*F);
11486 auto *AC = InfoCache.getAnalysisResultForFunction<AssumptionAnalysis>(*F);
11487
11488 const DataLayout &DL = I.getDataLayout();
11489 SimplifyQuery Q(DL, TLI, DT, AC, &I);
11490 Value *NewV = simplifyInstructionWithOperands(&I, NewOps, Q);
11491 if (!NewV || NewV == &I)
11492 return false;
11493
11494 LLVM_DEBUG(dbgs() << "Generic inst " << I << " assumed simplified to "
11495 << *NewV << "\n");
11496 Worklist.push_back({{*NewV, II.I.getCtxI()}, II.S});
11497 return true;
11498 }
11499
11501 Attributor &A, Instruction &I, ItemInfo II,
11502 SmallVectorImpl<ItemInfo> &Worklist,
11503 SmallMapVector<const Function *, LivenessInfo, 4> &LivenessAAs) {
11504 if (auto *CI = dyn_cast<CmpInst>(&I))
11505 return handleCmp(A, *CI, CI->getOperand(0), CI->getOperand(1),
11506 CI->getPredicate(), II, Worklist);
11507
11508 switch (I.getOpcode()) {
11509 case Instruction::Select:
11510 return handleSelectInst(A, cast<SelectInst>(I), II, Worklist);
11511 case Instruction::PHI:
11512 return handlePHINode(A, cast<PHINode>(I), II, Worklist, LivenessAAs);
11513 case Instruction::Load:
11514 return handleLoadInst(A, cast<LoadInst>(I), II, Worklist);
11515 default:
11516 return handleGenericInst(A, I, II, Worklist);
11517 };
11518 return false;
11519 }
11520
11521 void genericValueTraversal(Attributor &A, Value *InitialV) {
11522 SmallMapVector<const Function *, LivenessInfo, 4> LivenessAAs;
11523
11524 SmallSet<ItemInfo, 16> Visited;
11526 Worklist.push_back({{*InitialV, getCtxI()}, AA::AnyScope});
11527
11528 int Iteration = 0;
11529 do {
11530 ItemInfo II = Worklist.pop_back_val();
11531 Value *V = II.I.getValue();
11532 assert(V);
11533 const Instruction *CtxI = II.I.getCtxI();
11534 AA::ValueScope S = II.S;
11535
11536 // Check if we should process the current value. To prevent endless
11537 // recursion keep a record of the values we followed!
11538 if (!Visited.insert(II).second)
11539 continue;
11540
11541 // Make sure we limit the compile time for complex expressions.
11542 if (Iteration++ >= MaxPotentialValuesIterations) {
11543 LLVM_DEBUG(dbgs() << "Generic value traversal reached iteration limit: "
11544 << Iteration << "!\n");
11545 addValue(A, getState(), *V, CtxI, S, getAnchorScope());
11546 continue;
11547 }
11548
11549 // Explicitly look through calls with a "returned" attribute if we do
11550 // not have a pointer as stripPointerCasts only works on them.
11551 Value *NewV = nullptr;
11552 if (V->getType()->isPointerTy()) {
11553 NewV = AA::getWithType(*V->stripPointerCasts(), *V->getType());
11554 } else {
11555 if (auto *CB = dyn_cast<CallBase>(V))
11556 if (auto *Callee =
11558 for (Argument &Arg : Callee->args())
11559 if (Arg.hasReturnedAttr()) {
11560 NewV = CB->getArgOperand(Arg.getArgNo());
11561 break;
11562 }
11563 }
11564 }
11565 if (NewV && NewV != V) {
11566 Worklist.push_back({{*NewV, CtxI}, S});
11567 continue;
11568 }
11569
11570 if (auto *I = dyn_cast<Instruction>(V)) {
11571 if (simplifyInstruction(A, *I, II, Worklist, LivenessAAs))
11572 continue;
11573 }
11574
11575 if (V != InitialV || isa<Argument>(V))
11576 if (recurseForValue(A, IRPosition::value(*V), II.S))
11577 continue;
11578
11579 // If we haven't stripped anything we give up.
11580 if (V == InitialV && CtxI == getCtxI()) {
11581 indicatePessimisticFixpoint();
11582 return;
11583 }
11584
11585 addValue(A, getState(), *V, CtxI, S, getAnchorScope());
11586 } while (!Worklist.empty());
11587
11588 // If we actually used liveness information so we have to record a
11589 // dependence.
11590 for (auto &It : LivenessAAs)
11591 if (It.second.AnyDead)
11592 A.recordDependence(*It.second.LivenessAA, *this, DepClassTy::OPTIONAL);
11593 }
11594
11595 /// See AbstractAttribute::trackStatistics()
11596 void trackStatistics() const override {
11597 STATS_DECLTRACK_FLOATING_ATTR(potential_values)
11598 }
11599};
11600
11601struct AAPotentialValuesArgument final : AAPotentialValuesImpl {
11602 using Base = AAPotentialValuesImpl;
11603 AAPotentialValuesArgument(const IRPosition &IRP, Attributor &A)
11604 : Base(IRP, A) {}
11605
11606 /// See AbstractAttribute::initialize(..).
11607 void initialize(Attributor &A) override {
11608 auto &Arg = cast<Argument>(getAssociatedValue());
11610 indicatePessimisticFixpoint();
11611 }
11612
11613 /// See AbstractAttribute::updateImpl(...).
11614 ChangeStatus updateImpl(Attributor &A) override {
11615 auto AssumedBefore = getAssumed();
11616
11617 unsigned ArgNo = getCalleeArgNo();
11618
11619 bool UsedAssumedInformation = false;
11621 auto CallSitePred = [&](AbstractCallSite ACS) {
11622 const auto CSArgIRP = IRPosition::callsite_argument(ACS, ArgNo);
11623 if (CSArgIRP.getPositionKind() == IRP_INVALID)
11624 return false;
11625
11626 if (!A.getAssumedSimplifiedValues(CSArgIRP, this, Values,
11628 UsedAssumedInformation))
11629 return false;
11630
11631 return isValidState();
11632 };
11633
11634 if (!A.checkForAllCallSites(CallSitePred, *this,
11635 /* RequireAllCallSites */ true,
11636 UsedAssumedInformation))
11637 return indicatePessimisticFixpoint();
11638
11639 Function *Fn = getAssociatedFunction();
11640 bool AnyNonLocal = false;
11641 for (auto &It : Values) {
11642 if (isa<Constant>(It.getValue())) {
11643 addValue(A, getState(), *It.getValue(), It.getCtxI(), AA::AnyScope,
11644 getAnchorScope());
11645 continue;
11646 }
11647 if (!AA::isDynamicallyUnique(A, *this, *It.getValue()))
11648 return indicatePessimisticFixpoint();
11649
11650 if (auto *Arg = dyn_cast<Argument>(It.getValue()))
11651 if (Arg->getParent() == Fn) {
11652 addValue(A, getState(), *It.getValue(), It.getCtxI(), AA::AnyScope,
11653 getAnchorScope());
11654 continue;
11655 }
11656 addValue(A, getState(), *It.getValue(), It.getCtxI(), AA::Interprocedural,
11657 getAnchorScope());
11658 AnyNonLocal = true;
11659 }
11660 assert(!undefIsContained() && "Undef should be an explicit value!");
11661 if (AnyNonLocal)
11662 giveUpOnIntraprocedural(A);
11663
11664 return (AssumedBefore == getAssumed()) ? ChangeStatus::UNCHANGED
11665 : ChangeStatus::CHANGED;
11666 }
11667
11668 /// See AbstractAttribute::trackStatistics()
11669 void trackStatistics() const override {
11670 STATS_DECLTRACK_ARG_ATTR(potential_values)
11671 }
11672};
11673
11674struct AAPotentialValuesReturned : public AAPotentialValuesFloating {
11675 using Base = AAPotentialValuesFloating;
11676 AAPotentialValuesReturned(const IRPosition &IRP, Attributor &A)
11677 : Base(IRP, A) {}
11678
11679 /// See AbstractAttribute::initialize(..).
11680 void initialize(Attributor &A) override {
11681 Function *F = getAssociatedFunction();
11682 if (!F || F->isDeclaration() || F->getReturnType()->isVoidTy()) {
11683 indicatePessimisticFixpoint();
11684 return;
11685 }
11686
11687 for (Argument &Arg : F->args())
11688 if (Arg.hasReturnedAttr()) {
11689 addValue(A, getState(), Arg, nullptr, AA::AnyScope, F);
11690 ReturnedArg = &Arg;
11691 break;
11692 }
11693 if (!A.isFunctionIPOAmendable(*F) ||
11694 A.hasSimplificationCallback(getIRPosition())) {
11695 if (!ReturnedArg)
11696 indicatePessimisticFixpoint();
11697 else
11698 indicateOptimisticFixpoint();
11699 }
11700 }
11701
11702 /// See AbstractAttribute::updateImpl(...).
11703 ChangeStatus updateImpl(Attributor &A) override {
11704 auto AssumedBefore = getAssumed();
11705 bool UsedAssumedInformation = false;
11706
11708 Function *AnchorScope = getAnchorScope();
11709 auto HandleReturnedValue = [&](Value &V, Instruction *CtxI,
11710 bool AddValues) {
11712 Values.clear();
11713 if (!A.getAssumedSimplifiedValues(IRPosition::value(V), this, Values, S,
11714 UsedAssumedInformation,
11715 /* RecurseForSelectAndPHI */ true))
11716 return false;
11717 if (!AddValues)
11718 continue;
11719
11720 bool AllInterAreIntra = false;
11721 if (S == AA::Interprocedural)
11722 AllInterAreIntra =
11723 llvm::all_of(Values, [&](const AA::ValueAndContext &VAC) {
11724 return AA::isValidInScope(*VAC.getValue(), AnchorScope);
11725 });
11726
11727 for (const AA::ValueAndContext &VAC : Values) {
11728 addValue(A, getState(), *VAC.getValue(),
11729 VAC.getCtxI() ? VAC.getCtxI() : CtxI,
11730 AllInterAreIntra ? AA::AnyScope : S, AnchorScope);
11731 }
11732 if (AllInterAreIntra)
11733 break;
11734 }
11735 return true;
11736 };
11737
11738 if (ReturnedArg) {
11739 HandleReturnedValue(*ReturnedArg, nullptr, true);
11740 } else {
11741 auto RetInstPred = [&](Instruction &RetI) {
11742 bool AddValues = true;
11743 if (isa<PHINode>(RetI.getOperand(0)) ||
11744 isa<SelectInst>(RetI.getOperand(0))) {
11745 addValue(A, getState(), *RetI.getOperand(0), &RetI, AA::AnyScope,
11746 AnchorScope);
11747 AddValues = false;
11748 }
11749 return HandleReturnedValue(*RetI.getOperand(0), &RetI, AddValues);
11750 };
11751
11752 if (!A.checkForAllInstructions(RetInstPred, *this, {Instruction::Ret},
11753 UsedAssumedInformation,
11754 /* CheckBBLivenessOnly */ true))
11755 return indicatePessimisticFixpoint();
11756 }
11757
11758 return (AssumedBefore == getAssumed()) ? ChangeStatus::UNCHANGED
11759 : ChangeStatus::CHANGED;
11760 }
11761
11762 ChangeStatus manifest(Attributor &A) override {
11763 if (ReturnedArg)
11764 return ChangeStatus::UNCHANGED;
11766 if (!getAssumedSimplifiedValues(A, Values, AA::ValueScope::Intraprocedural,
11767 /* RecurseForSelectAndPHI */ true))
11768 return ChangeStatus::UNCHANGED;
11769 Value *NewVal = getSingleValue(A, *this, getIRPosition(), Values);
11770 if (!NewVal)
11771 return ChangeStatus::UNCHANGED;
11772
11773 ChangeStatus Changed = ChangeStatus::UNCHANGED;
11774 if (auto *Arg = dyn_cast<Argument>(NewVal)) {
11775 STATS_DECLTRACK(UniqueReturnValue, FunctionReturn,
11776 "Number of function with unique return");
11777 Changed |= A.manifestAttrs(
11779 {Attribute::get(Arg->getContext(), Attribute::Returned)});
11780 STATS_DECLTRACK_ARG_ATTR(returned);
11781 }
11782
11783 auto RetInstPred = [&](Instruction &RetI) {
11784 Value *RetOp = RetI.getOperand(0);
11785 if (isa<UndefValue>(RetOp) || RetOp == NewVal)
11786 return true;
11787 if (AA::isValidAtPosition({*NewVal, RetI}, A.getInfoCache()))
11788 if (A.changeUseAfterManifest(RetI.getOperandUse(0), *NewVal))
11789 Changed = ChangeStatus::CHANGED;
11790 return true;
11791 };
11792 bool UsedAssumedInformation = false;
11793 (void)A.checkForAllInstructions(RetInstPred, *this, {Instruction::Ret},
11794 UsedAssumedInformation,
11795 /* CheckBBLivenessOnly */ true);
11796 return Changed;
11797 }
11798
11799 ChangeStatus indicatePessimisticFixpoint() override {
11800 return AAPotentialValues::indicatePessimisticFixpoint();
11801 }
11802
11803 /// See AbstractAttribute::trackStatistics()
11804 void trackStatistics() const override{
11805 STATS_DECLTRACK_FNRET_ATTR(potential_values)}
11806
11807 /// The argumented with an existing `returned` attribute.
11808 Argument *ReturnedArg = nullptr;
11809};
11810
11811struct AAPotentialValuesFunction : AAPotentialValuesImpl {
11812 AAPotentialValuesFunction(const IRPosition &IRP, Attributor &A)
11813 : AAPotentialValuesImpl(IRP, A) {}
11814
11815 /// See AbstractAttribute::updateImpl(...).
11816 ChangeStatus updateImpl(Attributor &A) override {
11817 llvm_unreachable("AAPotentialValues(Function|CallSite)::updateImpl will "
11818 "not be called");
11819 }
11820
11821 /// See AbstractAttribute::trackStatistics()
11822 void trackStatistics() const override {
11823 STATS_DECLTRACK_FN_ATTR(potential_values)
11824 }
11825};
11826
11827struct AAPotentialValuesCallSite : AAPotentialValuesFunction {
11828 AAPotentialValuesCallSite(const IRPosition &IRP, Attributor &A)
11829 : AAPotentialValuesFunction(IRP, A) {}
11830
11831 /// See AbstractAttribute::trackStatistics()
11832 void trackStatistics() const override {
11833 STATS_DECLTRACK_CS_ATTR(potential_values)
11834 }
11835};
11836
11837struct AAPotentialValuesCallSiteReturned : AAPotentialValuesImpl {
11838 AAPotentialValuesCallSiteReturned(const IRPosition &IRP, Attributor &A)
11839 : AAPotentialValuesImpl(IRP, A) {}
11840
11841 /// See AbstractAttribute::updateImpl(...).
11842 ChangeStatus updateImpl(Attributor &A) override {
11843 auto AssumedBefore = getAssumed();
11844
11845 Function *Callee = getAssociatedFunction();
11846 if (!Callee)
11847 return indicatePessimisticFixpoint();
11848
11849 bool UsedAssumedInformation = false;
11850 auto *CB = cast<CallBase>(getCtxI());
11851 if (CB->isMustTailCall() &&
11852 !A.isAssumedDead(IRPosition::inst(*CB), this, nullptr,
11853 UsedAssumedInformation))
11854 return indicatePessimisticFixpoint();
11855
11856 Function *Caller = CB->getCaller();
11857
11858 auto AddScope = [&](AA::ValueScope S) {
11860 if (!A.getAssumedSimplifiedValues(IRPosition::returned(*Callee), this,
11861 Values, S, UsedAssumedInformation))
11862 return false;
11863
11864 for (auto &It : Values) {
11865 Value *V = It.getValue();
11866 std::optional<Value *> CallerV = A.translateArgumentToCallSiteContent(
11867 V, *CB, *this, UsedAssumedInformation);
11868 if (!CallerV.has_value()) {
11869 // Nothing to do as long as no value was determined.
11870 continue;
11871 }
11872 V = *CallerV ? *CallerV : V;
11873 if (*CallerV && AA::isDynamicallyUnique(A, *this, *V)) {
11874 if (recurseForValue(A, IRPosition::value(*V), S))
11875 continue;
11876 }
11877 if (S == AA::Intraprocedural && !AA::isValidInScope(*V, Caller)) {
11878 giveUpOnIntraprocedural(A);
11879 return true;
11880 }
11881 addValue(A, getState(), *V, CB, S, getAnchorScope());
11882 }
11883 return true;
11884 };
11885 if (!AddScope(AA::Intraprocedural))
11886 return indicatePessimisticFixpoint();
11887 if (!AddScope(AA::Interprocedural))
11888 return indicatePessimisticFixpoint();
11889 return (AssumedBefore == getAssumed()) ? ChangeStatus::UNCHANGED
11890 : ChangeStatus::CHANGED;
11891 }
11892
11893 ChangeStatus indicatePessimisticFixpoint() override {
11894 return AAPotentialValues::indicatePessimisticFixpoint();
11895 }
11896
11897 /// See AbstractAttribute::trackStatistics()
11898 void trackStatistics() const override {
11899 STATS_DECLTRACK_CSRET_ATTR(potential_values)
11900 }
11901};
11902
11903struct AAPotentialValuesCallSiteArgument : AAPotentialValuesFloating {
11904 AAPotentialValuesCallSiteArgument(const IRPosition &IRP, Attributor &A)
11905 : AAPotentialValuesFloating(IRP, A) {}
11906
11907 /// See AbstractAttribute::trackStatistics()
11908 void trackStatistics() const override {
11909 STATS_DECLTRACK_CSARG_ATTR(potential_values)
11910 }
11911};
11912} // namespace
11913
11914/// ---------------------- Assumption Propagation ------------------------------
11915namespace {
11916struct AAAssumptionInfoImpl : public AAAssumptionInfo {
11917 AAAssumptionInfoImpl(const IRPosition &IRP, Attributor &A,
11918 const DenseSet<StringRef> &Known)
11919 : AAAssumptionInfo(IRP, A, Known) {}
11920
11921 /// See AbstractAttribute::manifest(...).
11922 ChangeStatus manifest(Attributor &A) override {
11923 // Don't manifest a universal set if it somehow made it here.
11924 if (getKnown().isUniversal())
11925 return ChangeStatus::UNCHANGED;
11926
11927 const IRPosition &IRP = getIRPosition();
11928 SmallVector<StringRef, 0> Set(getAssumed().getSet().begin(),
11929 getAssumed().getSet().end());
11930 llvm::sort(Set);
11931 return A.manifestAttrs(IRP,
11932 Attribute::get(IRP.getAnchorValue().getContext(),
11934 llvm::join(Set, ",")),
11935 /*ForceReplace=*/true);
11936 }
11937
11938 bool hasAssumption(const StringRef Assumption) const override {
11939 return isValidState() && setContains(Assumption);
11940 }
11941
11942 /// See AbstractAttribute::getAsStr()
11943 const std::string getAsStr(Attributor *A) const override {
11944 const SetContents &Known = getKnown();
11945 const SetContents &Assumed = getAssumed();
11946
11947 SmallVector<StringRef, 0> Set(Known.getSet().begin(), Known.getSet().end());
11948 llvm::sort(Set);
11949 const std::string KnownStr = llvm::join(Set, ",");
11950
11951 std::string AssumedStr = "Universal";
11952 if (!Assumed.isUniversal()) {
11953 Set.assign(Assumed.getSet().begin(), Assumed.getSet().end());
11954 AssumedStr = llvm::join(Set, ",");
11955 }
11956 return "Known [" + KnownStr + "]," + " Assumed [" + AssumedStr + "]";
11957 }
11958};
11959
11960/// Propagates assumption information from parent functions to all of their
11961/// successors. An assumption can be propagated if the containing function
11962/// dominates the called function.
11963///
11964/// We start with a "known" set of assumptions already valid for the associated
11965/// function and an "assumed" set that initially contains all possible
11966/// assumptions. The assumed set is inter-procedurally updated by narrowing its
11967/// contents as concrete values are known. The concrete values are seeded by the
11968/// first nodes that are either entries into the call graph, or contains no
11969/// assumptions. Each node is updated as the intersection of the assumed state
11970/// with all of its predecessors.
11971struct AAAssumptionInfoFunction final : AAAssumptionInfoImpl {
11972 AAAssumptionInfoFunction(const IRPosition &IRP, Attributor &A)
11973 : AAAssumptionInfoImpl(IRP, A,
11974 getAssumptions(*IRP.getAssociatedFunction())) {}
11975
11976 /// See AbstractAttribute::updateImpl(...).
11977 ChangeStatus updateImpl(Attributor &A) override {
11978 bool Changed = false;
11979
11980 auto CallSitePred = [&](AbstractCallSite ACS) {
11981 const auto *AssumptionAA = A.getAAFor<AAAssumptionInfo>(
11982 *this, IRPosition::callsite_function(*ACS.getInstruction()),
11983 DepClassTy::REQUIRED);
11984 if (!AssumptionAA)
11985 return false;
11986 // Get the set of assumptions shared by all of this function's callers.
11987 Changed |= getIntersection(AssumptionAA->getAssumed());
11988 return !getAssumed().empty() || !getKnown().empty();
11989 };
11990
11991 bool UsedAssumedInformation = false;
11992 // Get the intersection of all assumptions held by this node's predecessors.
11993 // If we don't know all the call sites then this is either an entry into the
11994 // call graph or an empty node. This node is known to only contain its own
11995 // assumptions and can be propagated to its successors.
11996 if (!A.checkForAllCallSites(CallSitePred, *this, true,
11997 UsedAssumedInformation))
11998 return indicatePessimisticFixpoint();
11999
12000 return Changed ? ChangeStatus::CHANGED : ChangeStatus::UNCHANGED;
12001 }
12002
12003 void trackStatistics() const override {}
12004};
12005
12006/// Assumption Info defined for call sites.
12007struct AAAssumptionInfoCallSite final : AAAssumptionInfoImpl {
12008
12009 AAAssumptionInfoCallSite(const IRPosition &IRP, Attributor &A)
12010 : AAAssumptionInfoImpl(IRP, A, getInitialAssumptions(IRP)) {}
12011
12012 /// See AbstractAttribute::initialize(...).
12013 void initialize(Attributor &A) override {
12014 const IRPosition &FnPos = IRPosition::function(*getAnchorScope());
12015 A.getAAFor<AAAssumptionInfo>(*this, FnPos, DepClassTy::REQUIRED);
12016 }
12017
12018 /// See AbstractAttribute::updateImpl(...).
12019 ChangeStatus updateImpl(Attributor &A) override {
12020 const IRPosition &FnPos = IRPosition::function(*getAnchorScope());
12021 auto *AssumptionAA =
12022 A.getAAFor<AAAssumptionInfo>(*this, FnPos, DepClassTy::REQUIRED);
12023 if (!AssumptionAA)
12024 return indicatePessimisticFixpoint();
12025 bool Changed = getIntersection(AssumptionAA->getAssumed());
12026 return Changed ? ChangeStatus::CHANGED : ChangeStatus::UNCHANGED;
12027 }
12028
12029 /// See AbstractAttribute::trackStatistics()
12030 void trackStatistics() const override {}
12031
12032private:
12033 /// Helper to initialized the known set as all the assumptions this call and
12034 /// the callee contain.
12035 DenseSet<StringRef> getInitialAssumptions(const IRPosition &IRP) {
12036 const CallBase &CB = cast<CallBase>(IRP.getAssociatedValue());
12037 auto Assumptions = getAssumptions(CB);
12038 if (const Function *F = CB.getCaller())
12039 set_union(Assumptions, getAssumptions(*F));
12040 if (Function *F = IRP.getAssociatedFunction())
12041 set_union(Assumptions, getAssumptions(*F));
12042 return Assumptions;
12043 }
12044};
12045} // namespace
12046
12048 return static_cast<AACallGraphNode *>(const_cast<AACallEdges *>(
12049 A.getOrCreateAAFor<AACallEdges>(IRPosition::function(**I))));
12050}
12051
12053
12054/// ------------------------ UnderlyingObjects ---------------------------------
12055
12056namespace {
12057struct AAUnderlyingObjectsImpl
12058 : StateWrapper<BooleanState, AAUnderlyingObjects> {
12060 AAUnderlyingObjectsImpl(const IRPosition &IRP, Attributor &A) : BaseTy(IRP) {}
12061
12062 /// See AbstractAttribute::getAsStr().
12063 const std::string getAsStr(Attributor *A) const override {
12064 if (!isValidState())
12065 return "<invalid>";
12066 std::string Str;
12068 OS << "underlying objects: inter " << InterAssumedUnderlyingObjects.size()
12069 << " objects, intra " << IntraAssumedUnderlyingObjects.size()
12070 << " objects.\n";
12071 if (!InterAssumedUnderlyingObjects.empty()) {
12072 OS << "inter objects:\n";
12073 for (auto *Obj : InterAssumedUnderlyingObjects)
12074 OS << *Obj << '\n';
12075 }
12076 if (!IntraAssumedUnderlyingObjects.empty()) {
12077 OS << "intra objects:\n";
12078 for (auto *Obj : IntraAssumedUnderlyingObjects)
12079 OS << *Obj << '\n';
12080 }
12081 return Str;
12082 }
12083
12084 /// See AbstractAttribute::trackStatistics()
12085 void trackStatistics() const override {}
12086
12087 /// See AbstractAttribute::updateImpl(...).
12088 ChangeStatus updateImpl(Attributor &A) override {
12089 auto &Ptr = getAssociatedValue();
12090
12091 bool UsedAssumedInformation = false;
12092 auto DoUpdate = [&](SmallSetVector<Value *, 8> &UnderlyingObjects,
12094 SmallPtrSet<Value *, 8> SeenObjects;
12096
12097 if (!A.getAssumedSimplifiedValues(IRPosition::value(Ptr), *this, Values,
12098 Scope, UsedAssumedInformation))
12099 return UnderlyingObjects.insert(&Ptr);
12100
12101 bool Changed = false;
12102
12103 for (unsigned I = 0; I < Values.size(); ++I) {
12104 auto &VAC = Values[I];
12105 auto *Obj = VAC.getValue();
12106 Value *UO = getUnderlyingObject(Obj);
12107 if (!SeenObjects.insert(UO ? UO : Obj).second)
12108 continue;
12109 if (UO && UO != Obj) {
12110 if (isa<AllocaInst>(UO) || isa<GlobalValue>(UO)) {
12111 Changed |= UnderlyingObjects.insert(UO);
12112 continue;
12113 }
12114
12115 const auto *OtherAA = A.getAAFor<AAUnderlyingObjects>(
12116 *this, IRPosition::value(*UO), DepClassTy::OPTIONAL);
12117 auto Pred = [&](Value &V) {
12118 if (&V == UO)
12119 Changed |= UnderlyingObjects.insert(UO);
12120 else
12121 Values.emplace_back(V, nullptr);
12122 return true;
12123 };
12124
12125 if (!OtherAA || !OtherAA->forallUnderlyingObjects(Pred, Scope))
12127 "The forall call should not return false at this position");
12128 UsedAssumedInformation |= !OtherAA->getState().isAtFixpoint();
12129 continue;
12130 }
12131
12132 if (isa<SelectInst>(Obj)) {
12133 Changed |= handleIndirect(A, *Obj, UnderlyingObjects, Scope,
12134 UsedAssumedInformation);
12135 continue;
12136 }
12137 if (auto *PHI = dyn_cast<PHINode>(Obj)) {
12138 // Explicitly look through PHIs as we do not care about dynamically
12139 // uniqueness.
12140 for (unsigned u = 0, e = PHI->getNumIncomingValues(); u < e; u++) {
12141 Changed |=
12142 handleIndirect(A, *PHI->getIncomingValue(u), UnderlyingObjects,
12143 Scope, UsedAssumedInformation);
12144 }
12145 continue;
12146 }
12147
12148 Changed |= UnderlyingObjects.insert(Obj);
12149 }
12150
12151 return Changed;
12152 };
12153
12154 bool Changed = false;
12155 Changed |= DoUpdate(IntraAssumedUnderlyingObjects, AA::Intraprocedural);
12156 Changed |= DoUpdate(InterAssumedUnderlyingObjects, AA::Interprocedural);
12157 if (!UsedAssumedInformation)
12158 indicateOptimisticFixpoint();
12159 return Changed ? ChangeStatus::CHANGED : ChangeStatus::UNCHANGED;
12160 }
12161
12162 bool forallUnderlyingObjects(
12163 function_ref<bool(Value &)> Pred,
12164 AA::ValueScope Scope = AA::Interprocedural) const override {
12165 if (!isValidState())
12166 return Pred(getAssociatedValue());
12167
12168 auto &AssumedUnderlyingObjects = Scope == AA::Intraprocedural
12169 ? IntraAssumedUnderlyingObjects
12170 : InterAssumedUnderlyingObjects;
12171 for (Value *Obj : AssumedUnderlyingObjects)
12172 if (!Pred(*Obj))
12173 return false;
12174
12175 return true;
12176 }
12177
12178private:
12179 /// Handle the case where the value is not the actual underlying value, such
12180 /// as a phi node or a select instruction.
12181 bool handleIndirect(Attributor &A, Value &V,
12182 SmallSetVector<Value *, 8> &UnderlyingObjects,
12183 AA::ValueScope Scope, bool &UsedAssumedInformation) {
12184 bool Changed = false;
12185 const auto *AA = A.getAAFor<AAUnderlyingObjects>(
12186 *this, IRPosition::value(V), DepClassTy::OPTIONAL);
12187 auto Pred = [&](Value &V) {
12188 Changed |= UnderlyingObjects.insert(&V);
12189 return true;
12190 };
12191 if (!AA || !AA->forallUnderlyingObjects(Pred, Scope))
12193 "The forall call should not return false at this position");
12194 UsedAssumedInformation |= !AA->getState().isAtFixpoint();
12195 return Changed;
12196 }
12197
12198 /// All the underlying objects collected so far via intra procedural scope.
12199 SmallSetVector<Value *, 8> IntraAssumedUnderlyingObjects;
12200 /// All the underlying objects collected so far via inter procedural scope.
12201 SmallSetVector<Value *, 8> InterAssumedUnderlyingObjects;
12202};
12203
12204struct AAUnderlyingObjectsFloating final : AAUnderlyingObjectsImpl {
12205 AAUnderlyingObjectsFloating(const IRPosition &IRP, Attributor &A)
12206 : AAUnderlyingObjectsImpl(IRP, A) {}
12207};
12208
12209struct AAUnderlyingObjectsArgument final : AAUnderlyingObjectsImpl {
12210 AAUnderlyingObjectsArgument(const IRPosition &IRP, Attributor &A)
12211 : AAUnderlyingObjectsImpl(IRP, A) {}
12212};
12213
12214struct AAUnderlyingObjectsCallSite final : AAUnderlyingObjectsImpl {
12215 AAUnderlyingObjectsCallSite(const IRPosition &IRP, Attributor &A)
12216 : AAUnderlyingObjectsImpl(IRP, A) {}
12217};
12218
12219struct AAUnderlyingObjectsCallSiteArgument final : AAUnderlyingObjectsImpl {
12220 AAUnderlyingObjectsCallSiteArgument(const IRPosition &IRP, Attributor &A)
12221 : AAUnderlyingObjectsImpl(IRP, A) {}
12222};
12223
12224struct AAUnderlyingObjectsReturned final : AAUnderlyingObjectsImpl {
12225 AAUnderlyingObjectsReturned(const IRPosition &IRP, Attributor &A)
12226 : AAUnderlyingObjectsImpl(IRP, A) {}
12227};
12228
12229struct AAUnderlyingObjectsCallSiteReturned final : AAUnderlyingObjectsImpl {
12230 AAUnderlyingObjectsCallSiteReturned(const IRPosition &IRP, Attributor &A)
12231 : AAUnderlyingObjectsImpl(IRP, A) {}
12232};
12233
12234struct AAUnderlyingObjectsFunction final : AAUnderlyingObjectsImpl {
12235 AAUnderlyingObjectsFunction(const IRPosition &IRP, Attributor &A)
12236 : AAUnderlyingObjectsImpl(IRP, A) {}
12237};
12238} // namespace
12239
12240/// ------------------------ Global Value Info -------------------------------
12241namespace {
12242struct AAGlobalValueInfoFloating : public AAGlobalValueInfo {
12243 AAGlobalValueInfoFloating(const IRPosition &IRP, Attributor &A)
12244 : AAGlobalValueInfo(IRP, A) {}
12245
12246 /// See AbstractAttribute::initialize(...).
12247 void initialize(Attributor &A) override {}
12248
12249 bool checkUse(Attributor &A, const Use &U, bool &Follow,
12250 SmallVectorImpl<const Value *> &Worklist) {
12251 Instruction *UInst = dyn_cast<Instruction>(U.getUser());
12252 if (!UInst) {
12253 Follow = true;
12254 return true;
12255 }
12256
12257 LLVM_DEBUG(dbgs() << "[AAGlobalValueInfo] Check use: " << *U.get() << " in "
12258 << *UInst << "\n");
12259
12260 if (auto *Cmp = dyn_cast<ICmpInst>(U.getUser())) {
12261 int Idx = &Cmp->getOperandUse(0) == &U;
12262 if (isa<Constant>(Cmp->getOperand(Idx)))
12263 return true;
12264 return U == &getAnchorValue();
12265 }
12266
12267 // Explicitly catch return instructions.
12268 if (isa<ReturnInst>(UInst)) {
12269 auto CallSitePred = [&](AbstractCallSite ACS) {
12270 Worklist.push_back(ACS.getInstruction());
12271 return true;
12272 };
12273 bool UsedAssumedInformation = false;
12274 // TODO: We should traverse the uses or add a "non-call-site" CB.
12275 if (!A.checkForAllCallSites(CallSitePred, *UInst->getFunction(),
12276 /*RequireAllCallSites=*/true, this,
12277 UsedAssumedInformation))
12278 return false;
12279 return true;
12280 }
12281
12282 // For now we only use special logic for call sites. However, the tracker
12283 // itself knows about a lot of other non-capturing cases already.
12284 auto *CB = dyn_cast<CallBase>(UInst);
12285 if (!CB)
12286 return false;
12287 // Direct calls are OK uses.
12288 if (CB->isCallee(&U))
12289 return true;
12290 // Non-argument uses are scary.
12291 if (!CB->isArgOperand(&U))
12292 return false;
12293 // TODO: Iterate callees.
12294 auto *Fn = dyn_cast<Function>(CB->getCalledOperand());
12295 if (!Fn || !A.isFunctionIPOAmendable(*Fn))
12296 return false;
12297
12298 unsigned ArgNo = CB->getArgOperandNo(&U);
12299 Worklist.push_back(Fn->getArg(ArgNo));
12300 return true;
12301 }
12302
12303 ChangeStatus updateImpl(Attributor &A) override {
12304 unsigned NumUsesBefore = Uses.size();
12305
12306 SmallPtrSet<const Value *, 8> Visited;
12308 Worklist.push_back(&getAnchorValue());
12309
12310 auto UsePred = [&](const Use &U, bool &Follow) -> bool {
12311 Uses.insert(&U);
12312 // TODO(captures): Make this more precise.
12313 UseCaptureInfo CI = DetermineUseCaptureKind(U, /*Base=*/nullptr);
12314 if (CI.isPassthrough()) {
12315 Follow = true;
12316 return true;
12317 }
12318 return checkUse(A, U, Follow, Worklist);
12319 };
12320 auto EquivalentUseCB = [&](const Use &OldU, const Use &NewU) {
12321 Uses.insert(&OldU);
12322 return true;
12323 };
12324
12325 while (!Worklist.empty()) {
12326 const Value *V = Worklist.pop_back_val();
12327 if (!Visited.insert(V).second)
12328 continue;
12329 if (!A.checkForAllUses(UsePred, *this, *V,
12330 /* CheckBBLivenessOnly */ true,
12331 DepClassTy::OPTIONAL,
12332 /* IgnoreDroppableUses */ true, EquivalentUseCB)) {
12333 return indicatePessimisticFixpoint();
12334 }
12335 }
12336
12337 return Uses.size() == NumUsesBefore ? ChangeStatus::UNCHANGED
12338 : ChangeStatus::CHANGED;
12339 }
12340
12341 bool isPotentialUse(const Use &U) const override {
12342 return !isValidState() || Uses.contains(&U);
12343 }
12344
12345 /// See AbstractAttribute::manifest(...).
12346 ChangeStatus manifest(Attributor &A) override {
12347 return ChangeStatus::UNCHANGED;
12348 }
12349
12350 /// See AbstractAttribute::getAsStr().
12351 const std::string getAsStr(Attributor *A) const override {
12352 return "[" + std::to_string(Uses.size()) + " uses]";
12353 }
12354
12355 void trackStatistics() const override {
12356 STATS_DECLTRACK_FLOATING_ATTR(GlobalValuesTracked);
12357 }
12358
12359private:
12360 /// Set of (transitive) uses of this GlobalValue.
12361 SmallPtrSet<const Use *, 8> Uses;
12362};
12363} // namespace
12364
12365/// ------------------------ Indirect Call Info -------------------------------
12366namespace {
12367struct AAIndirectCallInfoCallSite : public AAIndirectCallInfo {
12368 AAIndirectCallInfoCallSite(const IRPosition &IRP, Attributor &A)
12369 : AAIndirectCallInfo(IRP, A) {}
12370
12371 /// See AbstractAttribute::initialize(...).
12372 void initialize(Attributor &A) override {
12373 auto *MD = getCtxI()->getMetadata(LLVMContext::MD_callees);
12374 if (!MD && !A.isClosedWorldModule())
12375 return;
12376
12377 if (MD) {
12378 for (const auto &Op : MD->operands())
12380 PotentialCallees.insert(Callee);
12381 } else if (A.isClosedWorldModule()) {
12382 ArrayRef<Function *> IndirectlyCallableFunctions =
12383 A.getInfoCache().getIndirectlyCallableFunctions(A);
12384 PotentialCallees.insert_range(IndirectlyCallableFunctions);
12385 }
12386
12387 if (PotentialCallees.empty())
12388 indicateOptimisticFixpoint();
12389 }
12390
12391 ChangeStatus updateImpl(Attributor &A) override {
12392 CallBase *CB = cast<CallBase>(getCtxI());
12393 const Use &CalleeUse = CB->getCalledOperandUse();
12394 Value *FP = CB->getCalledOperand();
12395
12396 SmallSetVector<Function *, 4> AssumedCalleesNow;
12397 bool AllCalleesKnownNow = AllCalleesKnown;
12398
12399 auto CheckPotentialCalleeUse = [&](Function &PotentialCallee,
12400 bool &UsedAssumedInformation) {
12401 const auto *GIAA = A.getAAFor<AAGlobalValueInfo>(
12402 *this, IRPosition::value(PotentialCallee), DepClassTy::OPTIONAL);
12403 if (!GIAA || GIAA->isPotentialUse(CalleeUse))
12404 return true;
12405 UsedAssumedInformation = !GIAA->isAtFixpoint();
12406 return false;
12407 };
12408
12409 auto AddPotentialCallees = [&]() {
12410 for (auto *PotentialCallee : PotentialCallees) {
12411 bool UsedAssumedInformation = false;
12412 if (CheckPotentialCalleeUse(*PotentialCallee, UsedAssumedInformation))
12413 AssumedCalleesNow.insert(PotentialCallee);
12414 }
12415 };
12416
12417 // Use simplification to find potential callees, if !callees was present,
12418 // fallback to that set if necessary.
12419 bool UsedAssumedInformation = false;
12421 if (!A.getAssumedSimplifiedValues(IRPosition::value(*FP), this, Values,
12422 AA::ValueScope::AnyScope,
12423 UsedAssumedInformation)) {
12424 if (PotentialCallees.empty())
12425 return indicatePessimisticFixpoint();
12426 AddPotentialCallees();
12427 }
12428
12429 // Try to find a reason for \p Fn not to be a potential callee. If none was
12430 // found, add it to the assumed callees set.
12431 auto CheckPotentialCallee = [&](Function &Fn) {
12432 if (!PotentialCallees.empty() && !PotentialCallees.count(&Fn))
12433 return false;
12434
12435 auto &CachedResult = FilterResults[&Fn];
12436 if (CachedResult.has_value())
12437 return CachedResult.value();
12438
12439 bool UsedAssumedInformation = false;
12440 if (!CheckPotentialCalleeUse(Fn, UsedAssumedInformation)) {
12441 if (!UsedAssumedInformation)
12442 CachedResult = false;
12443 return false;
12444 }
12445
12446 int NumFnArgs = Fn.arg_size();
12447 int NumCBArgs = CB->arg_size();
12448
12449 // Check if any excess argument (which we fill up with poison) is known to
12450 // be UB on undef.
12451 for (int I = NumCBArgs; I < NumFnArgs; ++I) {
12452 bool IsKnown = false;
12454 A, this, IRPosition::argument(*Fn.getArg(I)),
12455 DepClassTy::OPTIONAL, IsKnown)) {
12456 if (IsKnown)
12457 CachedResult = false;
12458 return false;
12459 }
12460 }
12461
12462 CachedResult = true;
12463 return true;
12464 };
12465
12466 // Check simplification result, prune known UB callees, also restrict it to
12467 // the !callees set, if present.
12468 for (auto &VAC : Values) {
12469 if (isa<UndefValue>(VAC.getValue()))
12470 continue;
12472 VAC.getValue()->getType()->getPointerAddressSpace() == 0)
12473 continue;
12474 // TODO: Check for known UB, e.g., poison + noundef.
12475 if (auto *VACFn = dyn_cast<Function>(VAC.getValue())) {
12476 if (CheckPotentialCallee(*VACFn))
12477 AssumedCalleesNow.insert(VACFn);
12478 continue;
12479 }
12480 if (!PotentialCallees.empty()) {
12481 AddPotentialCallees();
12482 break;
12483 }
12484 AllCalleesKnownNow = false;
12485 }
12486
12487 if (AssumedCalleesNow == AssumedCallees &&
12488 AllCalleesKnown == AllCalleesKnownNow)
12489 return ChangeStatus::UNCHANGED;
12490
12491 std::swap(AssumedCallees, AssumedCalleesNow);
12492 AllCalleesKnown = AllCalleesKnownNow;
12493 return ChangeStatus::CHANGED;
12494 }
12495
12496 /// See AbstractAttribute::manifest(...).
12497 ChangeStatus manifest(Attributor &A) override {
12498 // If we can't specialize at all, give up now.
12499 if (!AllCalleesKnown && AssumedCallees.empty())
12500 return ChangeStatus::UNCHANGED;
12501
12502 CallBase *CB = cast<CallBase>(getCtxI());
12503 bool UsedAssumedInformation = false;
12504 if (A.isAssumedDead(*CB, this, /*LivenessAA=*/nullptr,
12505 UsedAssumedInformation))
12506 return ChangeStatus::UNCHANGED;
12507
12508 ChangeStatus Changed = ChangeStatus::UNCHANGED;
12509 unsigned ProgramAS = CB->getDataLayout().getProgramAddressSpace();
12510 Value *FP = CB->getCalledOperand();
12511 if (FP->getType()->getPointerAddressSpace() != ProgramAS)
12512 FP = new AddrSpaceCastInst(
12513 FP, PointerType::get(FP->getContext(), ProgramAS),
12514 FP->getName() + ".as" + Twine(ProgramAS), CB->getIterator());
12515
12516 bool CBIsVoid = CB->getType()->isVoidTy();
12518 FunctionType *CSFT = CB->getFunctionType();
12519 SmallVector<Value *> CSArgs(CB->args());
12520
12521 // If we know all callees and there are none, the call site is (effectively)
12522 // dead (or UB).
12523 if (AssumedCallees.empty()) {
12524 assert(AllCalleesKnown &&
12525 "Expected all callees to be known if there are none.");
12526 A.changeToUnreachableAfterManifest(CB);
12527 return ChangeStatus::CHANGED;
12528 }
12529
12530 // Special handling for the single callee case.
12531 if (AllCalleesKnown && AssumedCallees.size() == 1) {
12532 auto *NewCallee = AssumedCallees.front();
12533 if (isLegalToPromote(*CB, NewCallee)) {
12534 promoteCall(*CB, NewCallee, nullptr);
12535 NumIndirectCallsPromoted++;
12536 return ChangeStatus::CHANGED;
12537 }
12538 Instruction *NewCall =
12539 CallInst::Create(FunctionCallee(CSFT, NewCallee), CSArgs,
12540 CB->getName(), CB->getIterator());
12541 if (!CBIsVoid)
12542 A.changeAfterManifest(IRPosition::callsite_returned(*CB), *NewCall);
12543 A.deleteAfterManifest(*CB);
12544 return ChangeStatus::CHANGED;
12545 }
12546
12547 // For each potential value we create a conditional
12548 //
12549 // ```
12550 // if (ptr == value) value(args);
12551 // else ...
12552 // ```
12553 //
12554 bool SpecializedForAnyCallees = false;
12555 bool SpecializedForAllCallees = AllCalleesKnown;
12556 ICmpInst *LastCmp = nullptr;
12557 SmallVector<Function *, 8> SkippedAssumedCallees;
12559 for (Function *NewCallee : AssumedCallees) {
12560 if (!A.shouldSpecializeCallSiteForCallee(*this, *CB, *NewCallee,
12561 AssumedCallees.size())) {
12562 SkippedAssumedCallees.push_back(NewCallee);
12563 SpecializedForAllCallees = false;
12564 continue;
12565 }
12566 SpecializedForAnyCallees = true;
12567
12568 LastCmp = new ICmpInst(IP, llvm::CmpInst::ICMP_EQ, FP, NewCallee);
12569 Instruction *ThenTI =
12570 SplitBlockAndInsertIfThen(LastCmp, IP, /* Unreachable */ false);
12571 BasicBlock *CBBB = CB->getParent();
12572 A.registerManifestAddedBasicBlock(*ThenTI->getParent());
12573 A.registerManifestAddedBasicBlock(*IP->getParent());
12574 auto *SplitTI = cast<CondBrInst>(LastCmp->getNextNode());
12575 BasicBlock *ElseBB;
12576 if (&*IP == CB) {
12577 ElseBB = BasicBlock::Create(ThenTI->getContext(), "",
12578 ThenTI->getFunction(), CBBB);
12579 A.registerManifestAddedBasicBlock(*ElseBB);
12580 IP = UncondBrInst::Create(CBBB, ElseBB)->getIterator();
12581 SplitTI->replaceUsesOfWith(CBBB, ElseBB);
12582 } else {
12583 ElseBB = IP->getParent();
12584 ThenTI->replaceUsesOfWith(ElseBB, CBBB);
12585 }
12586 CastInst *RetBC = nullptr;
12587 CallInst *NewCall = nullptr;
12588 if (isLegalToPromote(*CB, NewCallee)) {
12589 auto *CBClone = cast<CallBase>(CB->clone());
12590 CBClone->insertBefore(ThenTI->getIterator());
12591 NewCall = &cast<CallInst>(promoteCall(*CBClone, NewCallee, &RetBC));
12592 NumIndirectCallsPromoted++;
12593 } else {
12594 NewCall = CallInst::Create(FunctionCallee(CSFT, NewCallee), CSArgs,
12595 CB->getName(), ThenTI->getIterator());
12596 }
12597 NewCalls.push_back({NewCall, RetBC});
12598 }
12599
12600 auto AttachCalleeMetadata = [&](CallBase &IndirectCB) {
12601 if (!AllCalleesKnown)
12602 return ChangeStatus::UNCHANGED;
12603 MDBuilder MDB(IndirectCB.getContext());
12604 MDNode *Callees = MDB.createCallees(SkippedAssumedCallees);
12605 IndirectCB.setMetadata(LLVMContext::MD_callees, Callees);
12606 return ChangeStatus::CHANGED;
12607 };
12608
12609 if (!SpecializedForAnyCallees)
12610 return AttachCalleeMetadata(*CB);
12611
12612 // Check if we need the fallback indirect call still.
12613 if (SpecializedForAllCallees) {
12615 LastCmp->eraseFromParent();
12616 new UnreachableInst(IP->getContext(), IP);
12617 IP->eraseFromParent();
12618 } else {
12619 auto *CBClone = cast<CallInst>(CB->clone());
12620 CBClone->setName(CB->getName());
12621 CBClone->insertBefore(*IP->getParent(), IP);
12622 NewCalls.push_back({CBClone, nullptr});
12623 AttachCalleeMetadata(*CBClone);
12624 }
12625
12626 // Check if we need a PHI to merge the results.
12627 if (!CBIsVoid) {
12628 auto *PHI = PHINode::Create(CB->getType(), NewCalls.size(),
12629 CB->getName() + ".phi",
12630 CB->getParent()->getFirstInsertionPt());
12631 for (auto &It : NewCalls) {
12632 CallBase *NewCall = It.first;
12633 Instruction *CallRet = It.second ? It.second : It.first;
12634 if (CallRet->getType() == CB->getType())
12635 PHI->addIncoming(CallRet, CallRet->getParent());
12636 else if (NewCall->getType()->isVoidTy())
12637 PHI->addIncoming(PoisonValue::get(CB->getType()),
12638 NewCall->getParent());
12639 else
12640 llvm_unreachable("Call return should match or be void!");
12641 }
12642 A.changeAfterManifest(IRPosition::callsite_returned(*CB), *PHI);
12643 }
12644
12645 A.deleteAfterManifest(*CB);
12646 Changed = ChangeStatus::CHANGED;
12647
12648 return Changed;
12649 }
12650
12651 /// See AbstractAttribute::getAsStr().
12652 const std::string getAsStr(Attributor *A) const override {
12653 return std::string(AllCalleesKnown ? "eliminate" : "specialize") +
12654 " indirect call site with " + std::to_string(AssumedCallees.size()) +
12655 " functions";
12656 }
12657
12658 void trackStatistics() const override {
12659 if (AllCalleesKnown) {
12661 Eliminated, CallSites,
12662 "Number of indirect call sites eliminated via specialization")
12663 } else {
12664 STATS_DECLTRACK(Specialized, CallSites,
12665 "Number of indirect call sites specialized")
12666 }
12667 }
12668
12669 bool foreachCallee(function_ref<bool(Function *)> CB) const override {
12670 return isValidState() && AllCalleesKnown && all_of(AssumedCallees, CB);
12671 }
12672
12673private:
12674 /// Map to remember filter results.
12675 DenseMap<Function *, std::optional<bool>> FilterResults;
12676
12677 /// If the !callee metadata was present, this set will contain all potential
12678 /// callees (superset).
12679 SmallSetVector<Function *, 4> PotentialCallees;
12680
12681 /// This set contains all currently assumed calllees, which might grow over
12682 /// time.
12683 SmallSetVector<Function *, 4> AssumedCallees;
12684
12685 /// Flag to indicate if all possible callees are in the AssumedCallees set or
12686 /// if there could be others.
12687 bool AllCalleesKnown = true;
12688};
12689} // namespace
12690
12691/// --------------------- Invariant Load Pointer -------------------------------
12692namespace {
12693
12694struct AAInvariantLoadPointerImpl
12695 : public StateWrapper<BitIntegerState<uint8_t, 15>,
12696 AAInvariantLoadPointer> {
12697
12698 enum {
12699 // pointer does not alias within the bounds of the function
12700 IS_NOALIAS = 1 << 0,
12701 // pointer is not involved in any effectful instructions within the bounds
12702 // of the function
12703 IS_NOEFFECT = 1 << 1,
12704 // loads are invariant within the bounds of the function
12705 IS_LOCALLY_INVARIANT = 1 << 2,
12706 // memory lifetime is constrained within the bounds of the function
12707 IS_LOCALLY_CONSTRAINED = 1 << 3,
12708
12709 IS_BEST_STATE = IS_NOALIAS | IS_NOEFFECT | IS_LOCALLY_INVARIANT |
12710 IS_LOCALLY_CONSTRAINED,
12711 };
12712 static_assert(getBestState() == IS_BEST_STATE, "Unexpected best state");
12713
12714 using Base =
12715 StateWrapper<BitIntegerState<uint8_t, 15>, AAInvariantLoadPointer>;
12716
12717 // the BitIntegerState is optimistic about IS_NOALIAS and IS_NOEFFECT, but
12718 // pessimistic about IS_KNOWN_INVARIANT
12719 AAInvariantLoadPointerImpl(const IRPosition &IRP, Attributor &A)
12720 : Base(IRP) {}
12721
12722 bool isKnownInvariant() const final {
12723 return isKnownLocallyInvariant() && isKnown(IS_LOCALLY_CONSTRAINED);
12724 }
12725
12726 bool isKnownLocallyInvariant() const final {
12727 if (isKnown(IS_LOCALLY_INVARIANT))
12728 return true;
12729 return isKnown(IS_NOALIAS | IS_NOEFFECT);
12730 }
12731
12732 bool isAssumedInvariant() const final {
12733 return isAssumedLocallyInvariant() && isAssumed(IS_LOCALLY_CONSTRAINED);
12734 }
12735
12736 bool isAssumedLocallyInvariant() const final {
12737 if (isAssumed(IS_LOCALLY_INVARIANT))
12738 return true;
12739 return isAssumed(IS_NOALIAS | IS_NOEFFECT);
12740 }
12741
12742 ChangeStatus updateImpl(Attributor &A) override {
12743 ChangeStatus Changed = ChangeStatus::UNCHANGED;
12744
12745 Changed |= updateNoAlias(A);
12746 if (requiresNoAlias() && !isAssumed(IS_NOALIAS))
12747 return indicatePessimisticFixpoint();
12748
12749 Changed |= updateNoEffect(A);
12750
12751 Changed |= updateLocalInvariance(A);
12752
12753 return Changed;
12754 }
12755
12756 ChangeStatus manifest(Attributor &A) override {
12757 if (!isKnownInvariant())
12758 return ChangeStatus::UNCHANGED;
12759
12760 ChangeStatus Changed = ChangeStatus::UNCHANGED;
12761 const Value *Ptr = &getAssociatedValue();
12762 const auto TagInvariantLoads = [&](const Use &U, bool &) {
12763 if (U.get() != Ptr)
12764 return true;
12765 auto *I = dyn_cast<Instruction>(U.getUser());
12766 if (!I)
12767 return true;
12768
12769 // Ensure that we are only changing uses from the corresponding callgraph
12770 // SSC in the case that the AA isn't run on the entire module
12771 if (!A.isRunOn(I->getFunction()))
12772 return true;
12773
12774 if (I->hasMetadata(LLVMContext::MD_invariant_load))
12775 return true;
12776
12777 if (auto *LI = dyn_cast<LoadInst>(I)) {
12778 LI->setMetadata(LLVMContext::MD_invariant_load,
12779 MDNode::get(LI->getContext(), {}));
12780 Changed = ChangeStatus::CHANGED;
12781 }
12782 return true;
12783 };
12784
12785 (void)A.checkForAllUses(TagInvariantLoads, *this, *Ptr);
12786 return Changed;
12787 }
12788
12789 /// See AbstractAttribute::getAsStr().
12790 const std::string getAsStr(Attributor *) const override {
12791 if (isKnownInvariant())
12792 return "load-invariant pointer";
12793 return "non-invariant pointer";
12794 }
12795
12796 /// See AbstractAttribute::trackStatistics().
12797 void trackStatistics() const override {}
12798
12799private:
12800 /// Indicate that noalias is required for the pointer to be invariant.
12801 bool requiresNoAlias() const {
12802 switch (getPositionKind()) {
12803 default:
12804 // Conservatively default to require noalias.
12805 return true;
12806 case IRP_FLOAT:
12807 case IRP_RETURNED:
12808 case IRP_CALL_SITE:
12809 return false;
12810 case IRP_CALL_SITE_RETURNED: {
12811 const auto &CB = cast<CallBase>(getAnchorValue());
12813 &CB, /*MustPreserveOffset=*/false);
12814 }
12815 case IRP_ARGUMENT: {
12816 const Function *F = getAssociatedFunction();
12817 assert(F && "no associated function for argument");
12818 return !isCallableCC(F->getCallingConv());
12819 }
12820 }
12821 }
12822
12823 bool isExternal() const {
12824 const Function *F = getAssociatedFunction();
12825 if (!F)
12826 return true;
12827 return isCallableCC(F->getCallingConv()) &&
12828 getPositionKind() != IRP_CALL_SITE_RETURNED;
12829 }
12830
12831 ChangeStatus updateNoAlias(Attributor &A) {
12832 if (isKnown(IS_NOALIAS) || !isAssumed(IS_NOALIAS))
12833 return ChangeStatus::UNCHANGED;
12834
12835 // Try to use AANoAlias.
12836 if (const auto *ANoAlias = A.getOrCreateAAFor<AANoAlias>(
12837 getIRPosition(), this, DepClassTy::REQUIRED)) {
12838 if (ANoAlias->isKnownNoAlias()) {
12839 addKnownBits(IS_NOALIAS);
12840 return ChangeStatus::CHANGED;
12841 }
12842
12843 if (!ANoAlias->isAssumedNoAlias()) {
12844 removeAssumedBits(IS_NOALIAS);
12845 return ChangeStatus::CHANGED;
12846 }
12847
12848 return ChangeStatus::UNCHANGED;
12849 }
12850
12851 // Try to infer noalias from argument attribute, since it is applicable for
12852 // the duration of the function.
12853 if (const Argument *Arg = getAssociatedArgument()) {
12854 if (Arg->hasNoAliasAttr()) {
12855 addKnownBits(IS_NOALIAS);
12856 return ChangeStatus::UNCHANGED;
12857 }
12858
12859 // Noalias information is not provided, and cannot be inferred,
12860 // so we conservatively assume the pointer aliases.
12861 removeAssumedBits(IS_NOALIAS);
12862 return ChangeStatus::CHANGED;
12863 }
12864
12865 return ChangeStatus::UNCHANGED;
12866 }
12867
12868 ChangeStatus updateNoEffect(Attributor &A) {
12869 if (isKnown(IS_NOEFFECT) || !isAssumed(IS_NOEFFECT))
12870 return ChangeStatus::UNCHANGED;
12871
12872 if (!getAssociatedFunction())
12873 return indicatePessimisticFixpoint();
12874
12875 if (isa<AllocaInst>(&getAssociatedValue()))
12876 return indicatePessimisticFixpoint();
12877
12878 const auto HasNoEffectLoads = [&](const Use &U, bool &) {
12879 const auto *LI = dyn_cast<LoadInst>(U.getUser());
12880 return !LI || !LI->mayHaveSideEffects();
12881 };
12882 if (!A.checkForAllUses(HasNoEffectLoads, *this, getAssociatedValue()))
12883 return indicatePessimisticFixpoint();
12884
12885 if (const auto *AMemoryBehavior = A.getOrCreateAAFor<AAMemoryBehavior>(
12886 getIRPosition(), this, DepClassTy::REQUIRED)) {
12887 // For non-instructions, try to use AAMemoryBehavior to infer the readonly
12888 // attribute
12889 if (!AMemoryBehavior->isAssumedReadOnly())
12890 return indicatePessimisticFixpoint();
12891
12892 if (AMemoryBehavior->isKnownReadOnly()) {
12893 addKnownBits(IS_NOEFFECT);
12894 return ChangeStatus::UNCHANGED;
12895 }
12896
12897 return ChangeStatus::UNCHANGED;
12898 }
12899
12900 if (const Argument *Arg = getAssociatedArgument()) {
12901 if (Arg->onlyReadsMemory()) {
12902 addKnownBits(IS_NOEFFECT);
12903 return ChangeStatus::UNCHANGED;
12904 }
12905
12906 // Readonly information is not provided, and cannot be inferred from
12907 // AAMemoryBehavior.
12908 return indicatePessimisticFixpoint();
12909 }
12910
12911 return ChangeStatus::UNCHANGED;
12912 }
12913
12914 ChangeStatus updateLocalInvariance(Attributor &A) {
12915 if (isKnown(IS_LOCALLY_INVARIANT) || !isAssumed(IS_LOCALLY_INVARIANT))
12916 return ChangeStatus::UNCHANGED;
12917
12918 // try to infer invariance from underlying objects
12919 const auto *AUO = A.getOrCreateAAFor<AAUnderlyingObjects>(
12920 getIRPosition(), this, DepClassTy::REQUIRED);
12921 if (!AUO)
12922 return ChangeStatus::UNCHANGED;
12923
12924 bool UsedAssumedInformation = false;
12925 const auto IsLocallyInvariantLoadIfPointer = [&](const Value &V) {
12926 if (!V.getType()->isPointerTy())
12927 return true;
12928 const auto *IsInvariantLoadPointer =
12929 A.getOrCreateAAFor<AAInvariantLoadPointer>(IRPosition::value(V), this,
12930 DepClassTy::REQUIRED);
12931 // Conservatively fail if invariance cannot be inferred.
12932 if (!IsInvariantLoadPointer)
12933 return false;
12934
12935 if (IsInvariantLoadPointer->isKnownLocallyInvariant())
12936 return true;
12937 if (!IsInvariantLoadPointer->isAssumedLocallyInvariant())
12938 return false;
12939
12940 UsedAssumedInformation = true;
12941 return true;
12942 };
12943 if (!AUO->forallUnderlyingObjects(IsLocallyInvariantLoadIfPointer))
12944 return indicatePessimisticFixpoint();
12945
12946 if (const auto *CB = dyn_cast<CallBase>(&getAnchorValue())) {
12948 CB, /*MustPreserveOffset=*/false)) {
12949 for (const Value *Arg : CB->args()) {
12950 if (!IsLocallyInvariantLoadIfPointer(*Arg))
12951 return indicatePessimisticFixpoint();
12952 }
12953 }
12954 }
12955
12956 if (!UsedAssumedInformation) {
12957 // Pointer is known and not just assumed to be locally invariant.
12958 addKnownBits(IS_LOCALLY_INVARIANT);
12959 return ChangeStatus::CHANGED;
12960 }
12961
12962 return ChangeStatus::UNCHANGED;
12963 }
12964};
12965
12966struct AAInvariantLoadPointerFloating final : AAInvariantLoadPointerImpl {
12967 AAInvariantLoadPointerFloating(const IRPosition &IRP, Attributor &A)
12968 : AAInvariantLoadPointerImpl(IRP, A) {}
12969};
12970
12971struct AAInvariantLoadPointerReturned final : AAInvariantLoadPointerImpl {
12972 AAInvariantLoadPointerReturned(const IRPosition &IRP, Attributor &A)
12973 : AAInvariantLoadPointerImpl(IRP, A) {}
12974
12975 void initialize(Attributor &) override {
12976 removeAssumedBits(IS_LOCALLY_CONSTRAINED);
12977 }
12978};
12979
12980struct AAInvariantLoadPointerCallSiteReturned final
12981 : AAInvariantLoadPointerImpl {
12982 AAInvariantLoadPointerCallSiteReturned(const IRPosition &IRP, Attributor &A)
12983 : AAInvariantLoadPointerImpl(IRP, A) {}
12984
12985 void initialize(Attributor &A) override {
12986 const Function *F = getAssociatedFunction();
12987 assert(F && "no associated function for return from call");
12988
12989 if (!F->isDeclaration() && !F->isIntrinsic())
12990 return AAInvariantLoadPointerImpl::initialize(A);
12991
12992 const auto &CB = cast<CallBase>(getAnchorValue());
12994 &CB, /*MustPreserveOffset=*/false))
12995 return AAInvariantLoadPointerImpl::initialize(A);
12996
12997 if (F->onlyReadsMemory() && F->hasNoSync())
12998 return AAInvariantLoadPointerImpl::initialize(A);
12999
13000 // At this point, the function is opaque, so we conservatively assume
13001 // non-invariance.
13002 indicatePessimisticFixpoint();
13003 }
13004};
13005
13006struct AAInvariantLoadPointerArgument final : AAInvariantLoadPointerImpl {
13007 AAInvariantLoadPointerArgument(const IRPosition &IRP, Attributor &A)
13008 : AAInvariantLoadPointerImpl(IRP, A) {}
13009
13010 void initialize(Attributor &) override {
13011 const Function *F = getAssociatedFunction();
13012 assert(F && "no associated function for argument");
13013
13014 if (!isCallableCC(F->getCallingConv())) {
13015 addKnownBits(IS_LOCALLY_CONSTRAINED);
13016 return;
13017 }
13018
13019 if (!F->hasLocalLinkage())
13020 removeAssumedBits(IS_LOCALLY_CONSTRAINED);
13021 }
13022};
13023
13024struct AAInvariantLoadPointerCallSiteArgument final
13025 : AAInvariantLoadPointerImpl {
13026 AAInvariantLoadPointerCallSiteArgument(const IRPosition &IRP, Attributor &A)
13027 : AAInvariantLoadPointerImpl(IRP, A) {}
13028};
13029} // namespace
13030
13031/// ------------------------ Address Space ------------------------------------
13032namespace {
13033
13034template <typename InstType>
13035static bool makeChange(Attributor &A, InstType *MemInst, const Use &U,
13036 Value *OriginalValue, PointerType *NewPtrTy,
13037 bool UseOriginalValue) {
13038 if (U.getOperandNo() != InstType::getPointerOperandIndex())
13039 return false;
13040
13041 if (MemInst->isVolatile()) {
13042 auto *TTI = A.getInfoCache().getAnalysisResultForFunction<TargetIRAnalysis>(
13043 *MemInst->getFunction());
13044 unsigned NewAS = NewPtrTy->getPointerAddressSpace();
13045 if (!TTI || !TTI->hasVolatileVariant(MemInst, NewAS))
13046 return false;
13047 }
13048
13049 if (UseOriginalValue) {
13050 A.changeUseAfterManifest(const_cast<Use &>(U), *OriginalValue);
13051 return true;
13052 }
13053
13054 Instruction *CastInst = new AddrSpaceCastInst(OriginalValue, NewPtrTy);
13055 CastInst->insertBefore(MemInst->getIterator());
13056 A.changeUseAfterManifest(const_cast<Use &>(U), *CastInst);
13057 return true;
13058}
13059
13060struct AAAddressSpaceImpl : public AAAddressSpace {
13061 AAAddressSpaceImpl(const IRPosition &IRP, Attributor &A)
13062 : AAAddressSpace(IRP, A) {}
13063
13064 uint32_t getAddressSpace() const override {
13065 assert(isValidState() && "the AA is invalid");
13066 return AssumedAddressSpace;
13067 }
13068
13069 /// See AbstractAttribute::initialize(...).
13070 void initialize(Attributor &A) override {
13071 assert(getAssociatedType()->isPtrOrPtrVectorTy() &&
13072 "Associated value is not a pointer");
13073
13074 if (!A.getInfoCache().getFlatAddressSpace().has_value()) {
13075 indicatePessimisticFixpoint();
13076 return;
13077 }
13078
13079 unsigned FlatAS = A.getInfoCache().getFlatAddressSpace().value();
13080 unsigned AS = getAssociatedType()->getPointerAddressSpace();
13081 if (AS != FlatAS) {
13082 [[maybe_unused]] bool R = takeAddressSpace(AS);
13083 assert(R && "The take should happen");
13084 indicateOptimisticFixpoint();
13085 }
13086 }
13087
13088 ChangeStatus updateImpl(Attributor &A) override {
13089 uint32_t OldAddressSpace = AssumedAddressSpace;
13090 unsigned FlatAS = A.getInfoCache().getFlatAddressSpace().value();
13091
13092 auto CheckAddressSpace = [&](Value &Obj) {
13093 // Ignore undef.
13094 if (isa<UndefValue>(&Obj))
13095 return true;
13096
13097 // If the object already has a non-flat address space, we simply take it.
13098 unsigned ObjAS = Obj.getType()->getPointerAddressSpace();
13099 if (ObjAS != FlatAS)
13100 return takeAddressSpace(ObjAS);
13101
13102 // At this point, we know Obj is in the flat address space. For a final
13103 // attempt, we want to use getAssumedAddrSpace, but first we must get the
13104 // associated function, if possible.
13105 Function *F = nullptr;
13106 if (auto *Arg = dyn_cast<Argument>(&Obj))
13107 F = Arg->getParent();
13108 else if (auto *I = dyn_cast<Instruction>(&Obj))
13109 F = I->getFunction();
13110
13111 // Use getAssumedAddrSpace if the associated function exists.
13112 if (F) {
13113 auto *TTI =
13114 A.getInfoCache().getAnalysisResultForFunction<TargetIRAnalysis>(*F);
13115 unsigned AssumedAS = TTI->getAssumedAddrSpace(&Obj);
13116 if (AssumedAS != ~0U)
13117 return takeAddressSpace(AssumedAS);
13118 }
13119
13120 // Now we can't do anything else but to take the flat AS.
13121 return takeAddressSpace(FlatAS);
13122 };
13123
13124 auto *AUO = A.getOrCreateAAFor<AAUnderlyingObjects>(getIRPosition(), this,
13125 DepClassTy::REQUIRED);
13126 if (!AUO->forallUnderlyingObjects(CheckAddressSpace))
13127 return indicatePessimisticFixpoint();
13128
13129 return OldAddressSpace == AssumedAddressSpace ? ChangeStatus::UNCHANGED
13130 : ChangeStatus::CHANGED;
13131 }
13132
13133 /// See AbstractAttribute::manifest(...).
13134 ChangeStatus manifest(Attributor &A) override {
13135 unsigned NewAS = getAddressSpace();
13136
13137 if (NewAS == InvalidAddressSpace ||
13138 NewAS == getAssociatedType()->getPointerAddressSpace())
13139 return ChangeStatus::UNCHANGED;
13140
13141 unsigned FlatAS = A.getInfoCache().getFlatAddressSpace().value();
13142
13143 Value *AssociatedValue = &getAssociatedValue();
13144 Value *OriginalValue = peelAddrspacecast(AssociatedValue, FlatAS);
13145
13146 PointerType *NewPtrTy =
13147 PointerType::get(getAssociatedType()->getContext(), NewAS);
13148 bool UseOriginalValue =
13149 OriginalValue->getType()->getPointerAddressSpace() == NewAS;
13150
13151 bool Changed = false;
13152
13153 auto Pred = [&](const Use &U, bool &) {
13154 if (U.get() != AssociatedValue)
13155 return true;
13156 auto *Inst = dyn_cast<Instruction>(U.getUser());
13157 if (!Inst)
13158 return true;
13159 // This is a WA to make sure we only change uses from the corresponding
13160 // CGSCC if the AA is run on CGSCC instead of the entire module.
13161 if (!A.isRunOn(Inst->getFunction()))
13162 return true;
13163 if (auto *LI = dyn_cast<LoadInst>(Inst)) {
13164 Changed |=
13165 makeChange(A, LI, U, OriginalValue, NewPtrTy, UseOriginalValue);
13166 } else if (auto *SI = dyn_cast<StoreInst>(Inst)) {
13167 Changed |=
13168 makeChange(A, SI, U, OriginalValue, NewPtrTy, UseOriginalValue);
13169 } else if (auto *RMW = dyn_cast<AtomicRMWInst>(Inst)) {
13170 Changed |=
13171 makeChange(A, RMW, U, OriginalValue, NewPtrTy, UseOriginalValue);
13172 } else if (auto *CmpX = dyn_cast<AtomicCmpXchgInst>(Inst)) {
13173 Changed |=
13174 makeChange(A, CmpX, U, OriginalValue, NewPtrTy, UseOriginalValue);
13175 }
13176 return true;
13177 };
13178
13179 // It doesn't matter if we can't check all uses as we can simply
13180 // conservatively ignore those that can not be visited.
13181 (void)A.checkForAllUses(Pred, *this, getAssociatedValue(),
13182 /* CheckBBLivenessOnly */ true);
13183
13184 return Changed ? ChangeStatus::CHANGED : ChangeStatus::UNCHANGED;
13185 }
13186
13187 /// See AbstractAttribute::getAsStr().
13188 const std::string getAsStr(Attributor *A) const override {
13189 if (!isValidState())
13190 return "addrspace(<invalid>)";
13191 return "addrspace(" +
13192 (AssumedAddressSpace == InvalidAddressSpace
13193 ? "none"
13194 : std::to_string(AssumedAddressSpace)) +
13195 ")";
13196 }
13197
13198private:
13199 uint32_t AssumedAddressSpace = InvalidAddressSpace;
13200
13201 bool takeAddressSpace(uint32_t AS) {
13202 if (AssumedAddressSpace == InvalidAddressSpace) {
13203 AssumedAddressSpace = AS;
13204 return true;
13205 }
13206 return AssumedAddressSpace == AS;
13207 }
13208
13209 static Value *peelAddrspacecast(Value *V, unsigned FlatAS) {
13210 if (auto *I = dyn_cast<AddrSpaceCastInst>(V)) {
13211 assert(I->getSrcAddressSpace() != FlatAS &&
13212 "there should not be flat AS -> non-flat AS");
13213 return I->getPointerOperand();
13214 }
13215 if (auto *C = dyn_cast<ConstantExpr>(V))
13216 if (C->getOpcode() == Instruction::AddrSpaceCast) {
13217 assert(C->getOperand(0)->getType()->getPointerAddressSpace() !=
13218 FlatAS &&
13219 "there should not be flat AS -> non-flat AS X");
13220 return C->getOperand(0);
13221 }
13222 return V;
13223 }
13224};
13225
13226struct AAAddressSpaceFloating final : AAAddressSpaceImpl {
13227 AAAddressSpaceFloating(const IRPosition &IRP, Attributor &A)
13228 : AAAddressSpaceImpl(IRP, A) {}
13229
13230 void trackStatistics() const override {
13232 }
13233};
13234
13235struct AAAddressSpaceReturned final : AAAddressSpaceImpl {
13236 AAAddressSpaceReturned(const IRPosition &IRP, Attributor &A)
13237 : AAAddressSpaceImpl(IRP, A) {}
13238
13239 /// See AbstractAttribute::initialize(...).
13240 void initialize(Attributor &A) override {
13241 // TODO: we don't rewrite function argument for now because it will need to
13242 // rewrite the function signature and all call sites.
13243 (void)indicatePessimisticFixpoint();
13244 }
13245
13246 void trackStatistics() const override {
13247 STATS_DECLTRACK_FNRET_ATTR(addrspace);
13248 }
13249};
13250
13251struct AAAddressSpaceCallSiteReturned final : AAAddressSpaceImpl {
13252 AAAddressSpaceCallSiteReturned(const IRPosition &IRP, Attributor &A)
13253 : AAAddressSpaceImpl(IRP, A) {}
13254
13255 void trackStatistics() const override {
13256 STATS_DECLTRACK_CSRET_ATTR(addrspace);
13257 }
13258};
13259
13260struct AAAddressSpaceArgument final : AAAddressSpaceImpl {
13261 AAAddressSpaceArgument(const IRPosition &IRP, Attributor &A)
13262 : AAAddressSpaceImpl(IRP, A) {}
13263
13264 void trackStatistics() const override { STATS_DECLTRACK_ARG_ATTR(addrspace); }
13265};
13266
13267struct AAAddressSpaceCallSiteArgument final : AAAddressSpaceImpl {
13268 AAAddressSpaceCallSiteArgument(const IRPosition &IRP, Attributor &A)
13269 : AAAddressSpaceImpl(IRP, A) {}
13270
13271 /// See AbstractAttribute::initialize(...).
13272 void initialize(Attributor &A) override {
13273 // TODO: we don't rewrite call site argument for now because it will need to
13274 // rewrite the function signature of the callee.
13275 (void)indicatePessimisticFixpoint();
13276 }
13277
13278 void trackStatistics() const override {
13279 STATS_DECLTRACK_CSARG_ATTR(addrspace);
13280 }
13281};
13282} // namespace
13283
13284/// ------------------------ No Alias Address Space ---------------------------
13285// This attribute assumes flat address space can alias all other address space
13286
13287// TODO: this is similar to AAAddressSpace, most of the code should be merged.
13288// But merging it created failing cased on gateway test that cannot be
13289// reproduced locally. So should open a separated PR to handle the merge of
13290// AANoAliasAddrSpace and AAAddressSpace attribute
13291
13292namespace {
13293struct AANoAliasAddrSpaceImpl : public AANoAliasAddrSpace {
13294 AANoAliasAddrSpaceImpl(const IRPosition &IRP, Attributor &A)
13295 : AANoAliasAddrSpace(IRP, A) {}
13296
13297 void initialize(Attributor &A) override {
13298 assert(getAssociatedType()->isPtrOrPtrVectorTy() &&
13299 "Associated value is not a pointer");
13300
13301 resetASRanges(A);
13302
13303 std::optional<unsigned> FlatAS = A.getInfoCache().getFlatAddressSpace();
13304 if (!FlatAS.has_value()) {
13305 indicatePessimisticFixpoint();
13306 return;
13307 }
13308
13309 removeAS(*FlatAS);
13310
13311 unsigned AS = getAssociatedType()->getPointerAddressSpace();
13312 if (AS != *FlatAS) {
13313 removeAS(AS);
13314 indicateOptimisticFixpoint();
13315 }
13316 }
13317
13318 ChangeStatus updateImpl(Attributor &A) override {
13319 unsigned FlatAS = A.getInfoCache().getFlatAddressSpace().value();
13320 uint32_t OldAssumed = getAssumed();
13321
13322 auto CheckAddressSpace = [&](Value &Obj) {
13323 if (isa<PoisonValue>(&Obj))
13324 return true;
13325
13326 unsigned AS = Obj.getType()->getPointerAddressSpace();
13327 if (AS == FlatAS)
13328 return false;
13329
13330 removeAS(Obj.getType()->getPointerAddressSpace());
13331 return true;
13332 };
13333
13334 const AAUnderlyingObjects *AUO = A.getOrCreateAAFor<AAUnderlyingObjects>(
13335 getIRPosition(), this, DepClassTy::REQUIRED);
13336 if (!AUO->forallUnderlyingObjects(CheckAddressSpace))
13337 return indicatePessimisticFixpoint();
13338
13339 return OldAssumed == getAssumed() ? ChangeStatus::UNCHANGED
13340 : ChangeStatus::CHANGED;
13341 }
13342
13343 /// See AbstractAttribute::manifest(...).
13344 ChangeStatus manifest(Attributor &A) override {
13345 unsigned FlatAS = A.getInfoCache().getFlatAddressSpace().value();
13346
13347 unsigned AS = getAssociatedType()->getPointerAddressSpace();
13348 if (AS != FlatAS || Map.empty())
13349 return ChangeStatus::UNCHANGED;
13350
13351 LLVMContext &Ctx = getAssociatedValue().getContext();
13352 MDNode *NoAliasASNode = nullptr;
13353 MDBuilder MDB(Ctx);
13354 // Has to use iterator to get the range info.
13355 for (RangeMap::const_iterator I = Map.begin(); I != Map.end(); I++) {
13356 if (!I.value())
13357 continue;
13358 unsigned Upper = I.stop();
13359 unsigned Lower = I.start();
13360 if (!NoAliasASNode) {
13361 NoAliasASNode = MDB.createRange(APInt(32, Lower), APInt(32, Upper + 1));
13362 continue;
13363 }
13364 MDNode *ASRange = MDB.createRange(APInt(32, Lower), APInt(32, Upper + 1));
13365 NoAliasASNode = MDNode::getMostGenericRange(NoAliasASNode, ASRange);
13366 }
13367
13368 Value *AssociatedValue = &getAssociatedValue();
13369 bool Changed = false;
13370
13371 auto AddNoAliasAttr = [&](const Use &U, bool &) {
13372 if (U.get() != AssociatedValue)
13373 return true;
13374 Instruction *Inst = dyn_cast<Instruction>(U.getUser());
13375 if (!Inst || Inst->hasMetadata(LLVMContext::MD_noalias_addrspace))
13376 return true;
13377 if (!isa<LoadInst>(Inst) && !isa<StoreInst>(Inst) &&
13379 return true;
13380 if (!A.isRunOn(Inst->getFunction()))
13381 return true;
13382 Inst->setMetadata(LLVMContext::MD_noalias_addrspace, NoAliasASNode);
13383 Changed = true;
13384 return true;
13385 };
13386 (void)A.checkForAllUses(AddNoAliasAttr, *this, *AssociatedValue,
13387 /*CheckBBLivenessOnly=*/true);
13388 return Changed ? ChangeStatus::CHANGED : ChangeStatus::UNCHANGED;
13389 }
13390
13391 /// See AbstractAttribute::getAsStr().
13392 const std::string getAsStr(Attributor *A) const override {
13393 if (!isValidState())
13394 return "<invalid>";
13395 std::string Str;
13396 raw_string_ostream OS(Str);
13397 OS << "CanNotBeAddrSpace(";
13398 for (RangeMap::const_iterator I = Map.begin(); I != Map.end(); I++) {
13399 unsigned Upper = I.stop();
13400 unsigned Lower = I.start();
13401 OS << ' ' << '[' << Upper << ',' << Lower + 1 << ')';
13402 }
13403 OS << " )";
13404 return OS.str();
13405 }
13406
13407private:
13408 void removeAS(unsigned AS) {
13409 RangeMap::iterator I = Map.find(AS);
13410
13411 if (I != Map.end()) {
13412 unsigned Upper = I.stop();
13413 unsigned Lower = I.start();
13414 I.erase();
13415 if (Upper == Lower)
13416 return;
13417 if (AS != ~((unsigned)0) && AS + 1 <= Upper)
13418 Map.insert(AS + 1, Upper, /*what ever this variable name is=*/true);
13419 if (AS != 0 && Lower <= AS - 1)
13420 Map.insert(Lower, AS - 1, true);
13421 }
13422 }
13423
13424 void resetASRanges(Attributor &A) {
13425 Map.clear();
13426 Map.insert(0, A.getInfoCache().getMaxAddrSpace(), true);
13427 }
13428};
13429
13430struct AANoAliasAddrSpaceFloating final : AANoAliasAddrSpaceImpl {
13431 AANoAliasAddrSpaceFloating(const IRPosition &IRP, Attributor &A)
13432 : AANoAliasAddrSpaceImpl(IRP, A) {}
13433
13434 void trackStatistics() const override {
13435 STATS_DECLTRACK_FLOATING_ATTR(noaliasaddrspace);
13436 }
13437};
13438
13439struct AANoAliasAddrSpaceReturned final : AANoAliasAddrSpaceImpl {
13440 AANoAliasAddrSpaceReturned(const IRPosition &IRP, Attributor &A)
13441 : AANoAliasAddrSpaceImpl(IRP, A) {}
13442
13443 void trackStatistics() const override {
13444 STATS_DECLTRACK_FNRET_ATTR(noaliasaddrspace);
13445 }
13446};
13447
13448struct AANoAliasAddrSpaceCallSiteReturned final : AANoAliasAddrSpaceImpl {
13449 AANoAliasAddrSpaceCallSiteReturned(const IRPosition &IRP, Attributor &A)
13450 : AANoAliasAddrSpaceImpl(IRP, A) {}
13451
13452 void trackStatistics() const override {
13453 STATS_DECLTRACK_CSRET_ATTR(noaliasaddrspace);
13454 }
13455};
13456
13457struct AANoAliasAddrSpaceArgument final : AANoAliasAddrSpaceImpl {
13458 AANoAliasAddrSpaceArgument(const IRPosition &IRP, Attributor &A)
13459 : AANoAliasAddrSpaceImpl(IRP, A) {}
13460
13461 void trackStatistics() const override {
13462 STATS_DECLTRACK_ARG_ATTR(noaliasaddrspace);
13463 }
13464};
13465
13466struct AANoAliasAddrSpaceCallSiteArgument final : AANoAliasAddrSpaceImpl {
13467 AANoAliasAddrSpaceCallSiteArgument(const IRPosition &IRP, Attributor &A)
13468 : AANoAliasAddrSpaceImpl(IRP, A) {}
13469
13470 void trackStatistics() const override {
13471 STATS_DECLTRACK_CSARG_ATTR(noaliasaddrspace);
13472 }
13473};
13474} // namespace
13475/// ----------- Allocation Info ----------
13476namespace {
13477struct AAAllocationInfoImpl : public AAAllocationInfo {
13478 AAAllocationInfoImpl(const IRPosition &IRP, Attributor &A)
13479 : AAAllocationInfo(IRP, A) {}
13480
13481 std::optional<TypeSize> getAllocatedSize() const override {
13482 assert(isValidState() && "the AA is invalid");
13483 return AssumedAllocatedSize;
13484 }
13485
13486 std::optional<TypeSize> findInitialAllocationSize(Instruction *I,
13487 const DataLayout &DL) {
13488
13489 // TODO: implement case for malloc like instructions
13490 switch (I->getOpcode()) {
13491 case Instruction::Alloca: {
13492 AllocaInst *AI = cast<AllocaInst>(I);
13493 return AI->getAllocationSize(DL);
13494 }
13495 default:
13496 return std::nullopt;
13497 }
13498 }
13499
13500 ChangeStatus updateImpl(Attributor &A) override {
13501
13502 const IRPosition &IRP = getIRPosition();
13503 Instruction *I = IRP.getCtxI();
13504
13505 // TODO: update check for malloc like calls
13506 if (!isa<AllocaInst>(I))
13507 return indicatePessimisticFixpoint();
13508
13509 bool IsKnownNoCapture;
13511 A, this, IRP, DepClassTy::OPTIONAL, IsKnownNoCapture))
13512 return indicatePessimisticFixpoint();
13513
13514 const AAPointerInfo *PI =
13515 A.getOrCreateAAFor<AAPointerInfo>(IRP, *this, DepClassTy::REQUIRED);
13516
13517 if (!PI)
13518 return indicatePessimisticFixpoint();
13519
13520 if (!PI->getState().isValidState() || PI->reachesReturn())
13521 return indicatePessimisticFixpoint();
13522
13523 const DataLayout &DL = A.getDataLayout();
13524 const auto AllocationSize = findInitialAllocationSize(I, DL);
13525
13526 // If allocation size is nullopt, we give up.
13527 if (!AllocationSize)
13528 return indicatePessimisticFixpoint();
13529
13530 // For zero sized allocations, we give up.
13531 // Since we can't reduce further
13532 if (*AllocationSize == 0)
13533 return indicatePessimisticFixpoint();
13534
13535 int64_t BinSize = PI->numOffsetBins();
13536
13537 // TODO: implement for multiple bins
13538 if (BinSize > 1)
13539 return indicatePessimisticFixpoint();
13540
13541 if (BinSize == 0) {
13542 auto NewAllocationSize = std::make_optional<TypeSize>(0, false);
13543 if (!changeAllocationSize(NewAllocationSize))
13544 return ChangeStatus::UNCHANGED;
13545 return ChangeStatus::CHANGED;
13546 }
13547
13548 // TODO: refactor this to be part of multiple bin case
13549 const auto &It = PI->begin();
13550
13551 // TODO: handle if Offset is not zero
13552 if (It->first.Offset != 0)
13553 return indicatePessimisticFixpoint();
13554
13555 uint64_t SizeOfBin = It->first.Offset + It->first.Size;
13556
13557 if (SizeOfBin >= *AllocationSize)
13558 return indicatePessimisticFixpoint();
13559
13560 auto NewAllocationSize = std::make_optional<TypeSize>(SizeOfBin * 8, false);
13561
13562 if (!changeAllocationSize(NewAllocationSize))
13563 return ChangeStatus::UNCHANGED;
13564
13565 return ChangeStatus::CHANGED;
13566 }
13567
13568 /// See AbstractAttribute::manifest(...).
13569 ChangeStatus manifest(Attributor &A) override {
13570
13571 assert(isValidState() &&
13572 "Manifest should only be called if the state is valid.");
13573
13574 Instruction *I = getIRPosition().getCtxI();
13575
13576 auto FixedAllocatedSizeInBits = getAllocatedSize()->getFixedValue();
13577
13578 unsigned long NumBytesToAllocate = (FixedAllocatedSizeInBits + 7) / 8;
13579
13580 switch (I->getOpcode()) {
13581 // TODO: add case for malloc like calls
13582 case Instruction::Alloca: {
13583
13584 AllocaInst *AI = cast<AllocaInst>(I);
13585
13586 Type *CharType = Type::getInt8Ty(I->getContext());
13587
13588 auto *NumBytesToValue =
13589 ConstantInt::get(I->getContext(), APInt(32, NumBytesToAllocate));
13590
13591 BasicBlock::iterator insertPt = AI->getIterator();
13592 insertPt = std::next(insertPt);
13593 AllocaInst *NewAllocaInst =
13594 new AllocaInst(CharType, AI->getAddressSpace(), NumBytesToValue,
13595 AI->getAlign(), AI->getName(), insertPt);
13596
13597 if (A.changeAfterManifest(IRPosition::inst(*AI), *NewAllocaInst))
13598 return ChangeStatus::CHANGED;
13599
13600 break;
13601 }
13602 default:
13603 break;
13604 }
13605
13606 return ChangeStatus::UNCHANGED;
13607 }
13608
13609 /// See AbstractAttribute::getAsStr().
13610 const std::string getAsStr(Attributor *A) const override {
13611 if (!isValidState())
13612 return "allocationinfo(<invalid>)";
13613 return "allocationinfo(" +
13614 (AssumedAllocatedSize == HasNoAllocationSize
13615 ? "none"
13616 : std::to_string(AssumedAllocatedSize->getFixedValue())) +
13617 ")";
13618 }
13619
13620private:
13621 std::optional<TypeSize> AssumedAllocatedSize = HasNoAllocationSize;
13622
13623 // Maintain the computed allocation size of the object.
13624 // Returns (bool) weather the size of the allocation was modified or not.
13625 bool changeAllocationSize(std::optional<TypeSize> Size) {
13626 if (AssumedAllocatedSize == HasNoAllocationSize ||
13627 AssumedAllocatedSize != Size) {
13628 AssumedAllocatedSize = Size;
13629 return true;
13630 }
13631 return false;
13632 }
13633};
13634
13635struct AAAllocationInfoFloating : AAAllocationInfoImpl {
13636 AAAllocationInfoFloating(const IRPosition &IRP, Attributor &A)
13637 : AAAllocationInfoImpl(IRP, A) {}
13638
13639 void trackStatistics() const override {
13640 STATS_DECLTRACK_FLOATING_ATTR(allocationinfo);
13641 }
13642};
13643
13644struct AAAllocationInfoReturned : AAAllocationInfoImpl {
13645 AAAllocationInfoReturned(const IRPosition &IRP, Attributor &A)
13646 : AAAllocationInfoImpl(IRP, A) {}
13647
13648 /// See AbstractAttribute::initialize(...).
13649 void initialize(Attributor &A) override {
13650 // TODO: we don't rewrite function argument for now because it will need to
13651 // rewrite the function signature and all call sites
13652 (void)indicatePessimisticFixpoint();
13653 }
13654
13655 void trackStatistics() const override {
13656 STATS_DECLTRACK_FNRET_ATTR(allocationinfo);
13657 }
13658};
13659
13660struct AAAllocationInfoCallSiteReturned : AAAllocationInfoImpl {
13661 AAAllocationInfoCallSiteReturned(const IRPosition &IRP, Attributor &A)
13662 : AAAllocationInfoImpl(IRP, A) {}
13663
13664 void trackStatistics() const override {
13665 STATS_DECLTRACK_CSRET_ATTR(allocationinfo);
13666 }
13667};
13668
13669struct AAAllocationInfoArgument : AAAllocationInfoImpl {
13670 AAAllocationInfoArgument(const IRPosition &IRP, Attributor &A)
13671 : AAAllocationInfoImpl(IRP, A) {}
13672
13673 void trackStatistics() const override {
13674 STATS_DECLTRACK_ARG_ATTR(allocationinfo);
13675 }
13676};
13677
13678struct AAAllocationInfoCallSiteArgument : AAAllocationInfoImpl {
13679 AAAllocationInfoCallSiteArgument(const IRPosition &IRP, Attributor &A)
13680 : AAAllocationInfoImpl(IRP, A) {}
13681
13682 /// See AbstractAttribute::initialize(...).
13683 void initialize(Attributor &A) override {
13684
13685 (void)indicatePessimisticFixpoint();
13686 }
13687
13688 void trackStatistics() const override {
13689 STATS_DECLTRACK_CSARG_ATTR(allocationinfo);
13690 }
13691};
13692} // namespace
13693
13694const char AANoUnwind::ID = 0;
13695const char AANoSync::ID = 0;
13696const char AANoFree::ID = 0;
13697const char AANonNull::ID = 0;
13698const char AAMustProgress::ID = 0;
13699const char AANoRecurse::ID = 0;
13700const char AANonConvergent::ID = 0;
13701const char AAWillReturn::ID = 0;
13702const char AAUndefinedBehavior::ID = 0;
13703const char AANoAlias::ID = 0;
13704const char AAIntraFnReachability::ID = 0;
13705const char AANoReturn::ID = 0;
13706const char AAIsDead::ID = 0;
13707const char AADereferenceable::ID = 0;
13708const char AAAlign::ID = 0;
13709const char AAInstanceInfo::ID = 0;
13710const char AANoCapture::ID = 0;
13711const char AAValueSimplify::ID = 0;
13712const char AAHeapToStack::ID = 0;
13713const char AAPrivatizablePtr::ID = 0;
13714const char AAMemoryBehavior::ID = 0;
13715const char AAMemoryLocation::ID = 0;
13716const char AAValueConstantRange::ID = 0;
13717const char AAPotentialConstantValues::ID = 0;
13718const char AAPotentialValues::ID = 0;
13719const char AANoUndef::ID = 0;
13720const char AANoFPClass::ID = 0;
13721const char AACallEdges::ID = 0;
13722const char AAInterFnReachability::ID = 0;
13723const char AAPointerInfo::ID = 0;
13724const char AAAssumptionInfo::ID = 0;
13725const char AAUnderlyingObjects::ID = 0;
13726const char AAInvariantLoadPointer::ID = 0;
13727const char AAAddressSpace::ID = 0;
13728const char AANoAliasAddrSpace::ID = 0;
13729const char AAAllocationInfo::ID = 0;
13730const char AAIndirectCallInfo::ID = 0;
13731const char AAGlobalValueInfo::ID = 0;
13732const char AADenormalFPMath::ID = 0;
13733
13734// Macro magic to create the static generator function for attributes that
13735// follow the naming scheme.
13736
13737#define SWITCH_PK_INV(CLASS, PK, POS_NAME) \
13738 case IRPosition::PK: \
13739 llvm_unreachable("Cannot create " #CLASS " for a " POS_NAME " position!");
13740
13741#define SWITCH_PK_CREATE(CLASS, IRP, PK, SUFFIX) \
13742 case IRPosition::PK: \
13743 AA = new (A.Allocator) CLASS##SUFFIX(IRP, A); \
13744 ++NumAAs; \
13745 break;
13746
13747#define CREATE_FUNCTION_ABSTRACT_ATTRIBUTE_FOR_POSITION(CLASS) \
13748 CLASS &CLASS::createForPosition(const IRPosition &IRP, Attributor &A) { \
13749 CLASS *AA = nullptr; \
13750 switch (IRP.getPositionKind()) { \
13751 SWITCH_PK_INV(CLASS, IRP_INVALID, "invalid") \
13752 SWITCH_PK_INV(CLASS, IRP_FLOAT, "floating") \
13753 SWITCH_PK_INV(CLASS, IRP_ARGUMENT, "argument") \
13754 SWITCH_PK_INV(CLASS, IRP_RETURNED, "returned") \
13755 SWITCH_PK_INV(CLASS, IRP_CALL_SITE_RETURNED, "call site returned") \
13756 SWITCH_PK_INV(CLASS, IRP_CALL_SITE_ARGUMENT, "call site argument") \
13757 SWITCH_PK_CREATE(CLASS, IRP, IRP_FUNCTION, Function) \
13758 SWITCH_PK_CREATE(CLASS, IRP, IRP_CALL_SITE, CallSite) \
13759 } \
13760 return *AA; \
13761 }
13762
13763#define CREATE_VALUE_ABSTRACT_ATTRIBUTE_FOR_POSITION(CLASS) \
13764 CLASS &CLASS::createForPosition(const IRPosition &IRP, Attributor &A) { \
13765 CLASS *AA = nullptr; \
13766 switch (IRP.getPositionKind()) { \
13767 SWITCH_PK_INV(CLASS, IRP_INVALID, "invalid") \
13768 SWITCH_PK_INV(CLASS, IRP_FUNCTION, "function") \
13769 SWITCH_PK_INV(CLASS, IRP_CALL_SITE, "call site") \
13770 SWITCH_PK_CREATE(CLASS, IRP, IRP_FLOAT, Floating) \
13771 SWITCH_PK_CREATE(CLASS, IRP, IRP_ARGUMENT, Argument) \
13772 SWITCH_PK_CREATE(CLASS, IRP, IRP_RETURNED, Returned) \
13773 SWITCH_PK_CREATE(CLASS, IRP, IRP_CALL_SITE_RETURNED, CallSiteReturned) \
13774 SWITCH_PK_CREATE(CLASS, IRP, IRP_CALL_SITE_ARGUMENT, CallSiteArgument) \
13775 } \
13776 return *AA; \
13777 }
13778
13779#define CREATE_ABSTRACT_ATTRIBUTE_FOR_ONE_POSITION(POS, SUFFIX, CLASS) \
13780 CLASS &CLASS::createForPosition(const IRPosition &IRP, Attributor &A) { \
13781 CLASS *AA = nullptr; \
13782 switch (IRP.getPositionKind()) { \
13783 SWITCH_PK_CREATE(CLASS, IRP, POS, SUFFIX) \
13784 default: \
13785 llvm_unreachable("Cannot create " #CLASS " for position otherthan " #POS \
13786 " position!"); \
13787 } \
13788 return *AA; \
13789 }
13790
13791#define CREATE_ALL_ABSTRACT_ATTRIBUTE_FOR_POSITION(CLASS) \
13792 CLASS &CLASS::createForPosition(const IRPosition &IRP, Attributor &A) { \
13793 CLASS *AA = nullptr; \
13794 switch (IRP.getPositionKind()) { \
13795 SWITCH_PK_INV(CLASS, IRP_INVALID, "invalid") \
13796 SWITCH_PK_CREATE(CLASS, IRP, IRP_FUNCTION, Function) \
13797 SWITCH_PK_CREATE(CLASS, IRP, IRP_CALL_SITE, CallSite) \
13798 SWITCH_PK_CREATE(CLASS, IRP, IRP_FLOAT, Floating) \
13799 SWITCH_PK_CREATE(CLASS, IRP, IRP_ARGUMENT, Argument) \
13800 SWITCH_PK_CREATE(CLASS, IRP, IRP_RETURNED, Returned) \
13801 SWITCH_PK_CREATE(CLASS, IRP, IRP_CALL_SITE_RETURNED, CallSiteReturned) \
13802 SWITCH_PK_CREATE(CLASS, IRP, IRP_CALL_SITE_ARGUMENT, CallSiteArgument) \
13803 } \
13804 return *AA; \
13805 }
13806
13807#define CREATE_FUNCTION_ONLY_ABSTRACT_ATTRIBUTE_FOR_POSITION(CLASS) \
13808 CLASS &CLASS::createForPosition(const IRPosition &IRP, Attributor &A) { \
13809 CLASS *AA = nullptr; \
13810 switch (IRP.getPositionKind()) { \
13811 SWITCH_PK_INV(CLASS, IRP_INVALID, "invalid") \
13812 SWITCH_PK_INV(CLASS, IRP_ARGUMENT, "argument") \
13813 SWITCH_PK_INV(CLASS, IRP_FLOAT, "floating") \
13814 SWITCH_PK_INV(CLASS, IRP_RETURNED, "returned") \
13815 SWITCH_PK_INV(CLASS, IRP_CALL_SITE_RETURNED, "call site returned") \
13816 SWITCH_PK_INV(CLASS, IRP_CALL_SITE_ARGUMENT, "call site argument") \
13817 SWITCH_PK_INV(CLASS, IRP_CALL_SITE, "call site") \
13818 SWITCH_PK_CREATE(CLASS, IRP, IRP_FUNCTION, Function) \
13819 } \
13820 return *AA; \
13821 }
13822
13823#define CREATE_NON_RET_ABSTRACT_ATTRIBUTE_FOR_POSITION(CLASS) \
13824 CLASS &CLASS::createForPosition(const IRPosition &IRP, Attributor &A) { \
13825 CLASS *AA = nullptr; \
13826 switch (IRP.getPositionKind()) { \
13827 SWITCH_PK_INV(CLASS, IRP_INVALID, "invalid") \
13828 SWITCH_PK_INV(CLASS, IRP_RETURNED, "returned") \
13829 SWITCH_PK_CREATE(CLASS, IRP, IRP_FUNCTION, Function) \
13830 SWITCH_PK_CREATE(CLASS, IRP, IRP_CALL_SITE, CallSite) \
13831 SWITCH_PK_CREATE(CLASS, IRP, IRP_FLOAT, Floating) \
13832 SWITCH_PK_CREATE(CLASS, IRP, IRP_ARGUMENT, Argument) \
13833 SWITCH_PK_CREATE(CLASS, IRP, IRP_CALL_SITE_RETURNED, CallSiteReturned) \
13834 SWITCH_PK_CREATE(CLASS, IRP, IRP_CALL_SITE_ARGUMENT, CallSiteArgument) \
13835 } \
13836 return *AA; \
13837 }
13838
13848
13866
13871
13876
13883
13885
13886#undef CREATE_FUNCTION_ONLY_ABSTRACT_ATTRIBUTE_FOR_POSITION
13887#undef CREATE_FUNCTION_ABSTRACT_ATTRIBUTE_FOR_POSITION
13888#undef CREATE_NON_RET_ABSTRACT_ATTRIBUTE_FOR_POSITION
13889#undef CREATE_VALUE_ABSTRACT_ATTRIBUTE_FOR_POSITION
13890#undef CREATE_ALL_ABSTRACT_ATTRIBUTE_FOR_POSITION
13891#undef CREATE_ABSTRACT_ATTRIBUTE_FOR_ONE_POSITION
13892#undef SWITCH_PK_CREATE
13893#undef SWITCH_PK_INV
#define Success
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
aarch64 promote const
unsigned uint64_t
AMDGPU Register Bank Select
Rewrite undef for PHI
This file implements a class to represent arbitrary precision integral constant values and operations...
ReachingDefInfo InstSet & ToRemove
MachineBasicBlock MachineBasicBlock::iterator DebugLoc DL
Function Alias Analysis false
This file contains the simple types necessary to represent the attributes associated with functions a...
#define STATS_DECLTRACK(NAME, TYPE, MSG)
static std::optional< Constant * > askForAssumedConstant(Attributor &A, const AbstractAttribute &QueryingAA, const IRPosition &IRP, Type &Ty)
static cl::opt< unsigned, true > MaxPotentialValues("attributor-max-potential-values", cl::Hidden, cl::desc("Maximum number of potential values to be " "tracked for each position."), cl::location(llvm::PotentialConstantIntValuesState::MaxPotentialValues), cl::init(7))
static void clampReturnedValueStates(Attributor &A, const AAType &QueryingAA, StateType &S, const IRPosition::CallBaseContext *CBContext=nullptr)
Clamp the information known for all returned values of a function (identified by QueryingAA) into S.
#define STATS_DECLTRACK_FN_ATTR(NAME)
#define CREATE_FUNCTION_ABSTRACT_ATTRIBUTE_FOR_POSITION(CLASS)
static cl::opt< int > MaxPotentialValuesIterations("attributor-max-potential-values-iterations", cl::Hidden, cl::desc("Maximum number of iterations we keep dismantling potential values."), cl::init(64))
#define STATS_DECLTRACK_CS_ATTR(NAME)
#define PIPE_OPERATOR(CLASS)
#define STATS_DECLTRACK_ARG_ATTR(NAME)
static const Value * stripAndAccumulateOffsets(Attributor &A, const AbstractAttribute &QueryingAA, const Value *Val, const DataLayout &DL, APInt &Offset, bool GetMinOffset, bool AllowNonInbounds, bool UseAssumed=false)
#define STATS_DECLTRACK_CSRET_ATTR(NAME)
static cl::opt< bool > ManifestInternal("attributor-manifest-internal", cl::Hidden, cl::desc("Manifest Attributor internal string attributes."), cl::init(false))
static Value * constructPointer(Value *Ptr, int64_t Offset, IRBuilder< NoFolder > &IRB)
Helper function to create a pointer based on Ptr, and advanced by Offset bytes.
#define CREATE_NON_RET_ABSTRACT_ATTRIBUTE_FOR_POSITION(CLASS)
#define BUILD_STAT_NAME(NAME, TYPE)
static bool isDenselyPacked(Type *Ty, const DataLayout &DL)
Checks if a type could have padding bytes.
#define CREATE_VALUE_ABSTRACT_ATTRIBUTE_FOR_POSITION(CLASS)
static const Value * getMinimalBaseOfPointer(Attributor &A, const AbstractAttribute &QueryingAA, const Value *Ptr, int64_t &BytesOffset, const DataLayout &DL, bool AllowNonInbounds=false)
static bool mayBeInCycle(const CycleInfo *CI, const Instruction *I, bool HeaderOnly, CycleRef *CPtr=nullptr)
#define STATS_DECLTRACK_FNRET_ATTR(NAME)
#define STATS_DECLTRACK_CSARG_ATTR(NAME)
#define CREATE_ABSTRACT_ATTRIBUTE_FOR_ONE_POSITION(POS, SUFFIX, CLASS)
#define CREATE_ALL_ABSTRACT_ATTRIBUTE_FOR_POSITION(CLASS)
static cl::opt< int > MaxHeapToStackSize("max-heap-to-stack-size", cl::init(128), cl::Hidden)
#define CREATE_FUNCTION_ONLY_ABSTRACT_ATTRIBUTE_FOR_POSITION(CLASS)
#define STATS_DECLTRACK_FLOATING_ATTR(NAME)
#define STATS_DECL(NAME, TYPE, MSG)
basic Basic Alias true
static GCRegistry::Add< ShadowStackGC > C("shadow-stack", "Very portable GC for uncooperative code generators")
static GCRegistry::Add< ErlangGC > A("erlang", "erlang-compatible garbage collector")
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
static bool isReachableImpl(SmallVectorImpl< BasicBlock * > &Worklist, const StopSetT &StopSet, const SmallPtrSetImpl< BasicBlock * > *ExclusionSet, const DominatorTree *DT, const LoopInfo *LI, const CycleInfo *CI)
Definition CFG.cpp:145
This file contains the declarations for the subclasses of Constant, which represent the different fla...
This file declares an analysis pass that computes CycleInfo for LLVM IR, specialized from GenericCycl...
static uint64_t align(uint64_t Size)
DXIL Forward Handle Accesses
DXIL Resource Access
dxil translate DXIL Translate Metadata
This file defines DenseMapInfo traits for DenseMap.
This file defines the DenseMap class.
#define Check(C,...)
static Value * getCondition(Instruction *I)
Hexagon Common GEP
IRTranslator LLVM IR MI
#define F(x, y, z)
Definition MD5.cpp:54
#define I(x, y, z)
Definition MD5.cpp:57
Machine Check Debug Module
This file implements a map that provides insertion order iteration.
#define T
#define T1
static unsigned getAddressSpace(const Value *V, unsigned MaxLookup)
ConstantRange Range(APInt(BitWidth, Low), APInt(BitWidth, High))
uint64_t IntrinsicInst * II
if(PassOpts->AAPipeline)
static StringRef getName(Value *V)
Basic Register Allocator
dot regions Print regions of function to dot true view regions View regions of function(with no function bodies)"
Remove Loads Into Fake Uses
This builds on the llvm/ADT/GraphTraits.h file to find the strongly connected components (SCCs) of a ...
bool IsDead
Func getContext().diagnose(DiagnosticInfoUnsupported(Func
std::pair< BasicBlock *, BasicBlock * > Edge
This file contains some templates that are useful if you are working with the STL at all.
BaseType
A given derived pointer can have multiple base pointers through phi/selects.
This file defines generic set operations that may be used on set's of different types,...
This file implements a set that has insertion order iteration characteristics.
This file defines the SmallPtrSet class.
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
This file contains some functions that are useful when dealing with strings.
#define LLVM_DEBUG(...)
Definition Debug.h:119
static SymbolRef::Type getType(const Symbol *Sym)
Definition TapiFile.cpp:39
static void initialize(TargetLibraryInfoImpl &TLI, const Triple &T, const llvm::StringTable &StandardNames, VectorLibrary VecLib)
Initialize the set of available library functions based on the specified target triple.
This pass exposes codegen information to IR-level passes.
static unsigned getBitWidth(Type *Ty, const DataLayout &DL)
Returns the bitwidth of the given scalar or pointer type.
Value * RHS
Value * LHS
static unsigned getSize(unsigned Kind)
LLVM_ABI AACallGraphNode * operator*() const
bool isNoAlias(const MemoryLocation &LocA, const MemoryLocation &LocB)
A trivial helper function to check to see if the specified pointers are no-alias.
Class for arbitrary precision integers.
Definition APInt.h:78
int64_t getSExtValue() const
Get sign extended value.
Definition APInt.h:1582
CallBase * getInstruction() const
Return the underlying instruction.
bool isCallbackCall() const
Return true if this ACS represents a callback call.
bool isDirectCall() const
Return true if this ACS represents a direct call.
static LLVM_ABI void getCallbackUses(const CallBase &CB, SmallVectorImpl< const Use * > &CallbackUses)
Add operand uses of CB that represent callback uses into CallbackUses.
int getCallArgOperandNo(Argument &Arg) const
Return the operand index of the underlying instruction associated with Arg.
Align getAlign() const
Return the alignment of the memory that is being allocated by the instruction.
unsigned getAddressSpace() const
Return the address space for the allocation.
LLVM_ABI std::optional< TypeSize > getAllocationSize(const DataLayout &DL) const
Get allocation size in bytes.
This class represents an incoming formal argument to a Function.
Definition Argument.h:32
LLVM_ABI bool hasNoAliasAttr() const
Return true if this argument has the noalias attribute.
Definition Function.cpp:270
LLVM_ABI bool onlyReadsMemory() const
Return true if this argument has the readonly or readnone attribute.
Definition Function.cpp:306
LLVM_ABI bool hasPointeeInMemoryValueAttr() const
Return true if this argument has the byval, sret, inalloca, preallocated, or byref attribute.
Definition Function.cpp:173
LLVM_ABI bool hasReturnedAttr() const
Return true if this argument has the returned attribute.
Definition Function.cpp:294
LLVM_ABI bool hasByValAttr() const
Return true if this argument has the byval attribute.
Definition Function.cpp:130
const Function * getParent() const
Definition Argument.h:44
unsigned getArgNo() const
Return the index of this formal argument in its containing function.
Definition Argument.h:50
A function analysis which provides an AssumptionCache.
A cache of @llvm.assume calls within a function.
Functions, function parameters, and return types can have attributes to indicate how they should be t...
Definition Attributes.h:106
static LLVM_ABI Attribute get(LLVMContext &Context, AttrKind Kind, uint64_t Val=0)
Return a uniquified Attribute object.
LLVM_ABI FPClassTest getNoFPClass() const
Return the FPClassTest for nofpclass.
LLVM_ABI Attribute::AttrKind getKindAsEnum() const
Return the attribute's kind as an enum (Attribute::AttrKind).
LLVM_ABI MemoryEffects getMemoryEffects() const
Returns memory effects.
AttrKind
This enumeration lists the attributes that can be associated with parameters, function results,...
Definition Attributes.h:125
static LLVM_ABI Attribute getWithCaptureInfo(LLVMContext &Context, CaptureInfo CI)
static bool isEnumAttrKind(AttrKind Kind)
Definition Attributes.h:139
bool isValid() const
Return true if the attribute is any kind of attribute.
Definition Attributes.h:266
LLVM_ABI CaptureInfo getCaptureInfo() const
Returns information from captures attribute.
LLVM Basic Block Representation.
Definition BasicBlock.h:62
LLVM_ABI const_iterator getFirstInsertionPt() const
Returns an iterator to the first instruction in this block that is suitable for inserting a non-PHI i...
const Function * getParent() const
Return the enclosing method, or null if none.
Definition BasicBlock.h:213
static BasicBlock * Create(LLVMContext &Context, const Twine &Name="", Function *Parent=nullptr, BasicBlock *InsertBefore=nullptr)
Creates a new BasicBlock.
Definition BasicBlock.h:206
const Instruction & front() const
Definition BasicBlock.h:469
InstListType::iterator iterator
Instruction iterators...
Definition BasicBlock.h:170
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:409
Base class for all callable instructions (InvokeInst and CallInst) Holds everything related to callin...
Function * getCalledFunction() const
Returns the function called, or null if this is an indirect function invocation or the function signa...
LLVM_ABI bool isMustTailCall() const
Tests if this call site must be tail call optimized.
LLVM_ABI bool isIndirectCall() const
Return true if the callsite is an indirect call.
bool isCallee(Value::const_user_iterator UI) const
Determine whether the passed iterator points to the callee operand's Use.
Value * getCalledOperand() const
const Use & getCalledOperandUse() const
Attribute getFnAttr(StringRef Kind) const
Get the attribute of a given kind for the function.
const Use & getArgOperandUse(unsigned i) const
Wrappers for getting the Use of a call argument.
LLVM_ABI std::optional< ConstantRange > getRange() const
If this return value has a range attribute, return the value range of the argument.
Value * getArgOperand(unsigned i) const
bool isBundleOperand(unsigned Idx) const
Return true if the operand at index Idx is a bundle operand.
bool isConvergent() const
Determine if the invoke is convergent.
FunctionType * getFunctionType() const
LLVM_ABI Intrinsic::ID getIntrinsicID() const
Returns the intrinsic ID of the intrinsic called or Intrinsic::not_intrinsic if the called function i...
iterator_range< User::op_iterator > args()
Iteration adapter for range-for loops.
unsigned getArgOperandNo(const Use *U) const
Given a use for a arg operand, get the arg operand number that corresponds to it.
unsigned arg_size() const
bool isArgOperand(const Use *U) const
LLVM_ABI Function * getCaller()
Helper to get the caller (the parent function).
static CallInst * Create(FunctionType *Ty, Value *F, const Twine &NameStr="", InsertPosition InsertBefore=nullptr)
static CaptureInfo none()
Create CaptureInfo that does not capture any components of the pointer.
Definition ModRef.h:427
Instruction::CastOps getOpcode() const
Return the opcode of this CastInst.
Definition InstrTypes.h:674
LLVM_ABI bool isIntegerCast() const
There are several places where we need to know if a cast instruction only deals with integer source a...
Type * getDestTy() const
Return the destination type, as a convenience.
Definition InstrTypes.h:681
bool isEquality() const
Determine if this is an equals/not equals predicate.
Definition InstrTypes.h:978
bool isFalseWhenEqual() const
This is just a convenience.
Predicate
This enumeration lists the possible predicates for CmpInst subclasses.
Definition InstrTypes.h:740
@ ICMP_NE
not equal
Definition InstrTypes.h:762
bool isTrueWhenEqual() const
This is just a convenience.
Predicate getPredicate() const
Return the predicate for this instruction.
Definition InstrTypes.h:828
Conditional Branch instruction.
Value * getCondition() const
BasicBlock * getSuccessor(unsigned i) const
static ConstantAsMetadata * get(Constant *C)
Definition Metadata.h:548
static LLVM_ABI Constant * getExtractElement(Constant *Vec, Constant *Idx, Type *OnlyIfReducedTy=nullptr)
static LLVM_ABI ConstantInt * getTrue(LLVMContext &Context)
This class represents a range of values.
const APInt & getLower() const
Return the lower value for this range.
LLVM_ABI bool isFullSet() const
Return true if this set contains all of the elements possible for this data-type.
LLVM_ABI bool isEmptySet() const
Return true if this set contains no members.
bool isSingleElement() const
Return true if this set contains exactly one member.
static LLVM_ABI ConstantRange makeAllowedICmpRegion(CmpInst::Predicate Pred, const ConstantRange &Other)
Produce the smallest range such that all values that may satisfy the given predicate with any value c...
const APInt & getUpper() const
Return the upper value for this range.
LLVM_ABI bool contains(const APInt &Val) const
Return true if the specified value is in the set.
Opaque handle to a cycle within a GenericCycleInfo that wraps the cycle's preorder index.
A parsed version of the target data layout string in and methods for querying it.
Definition DataLayout.h:64
unsigned getProgramAddressSpace() const
Definition DataLayout.h:269
iterator find(const_arg_type_t< KeyT > Val)
Definition DenseMap.h:258
std::pair< iterator, bool > try_emplace(KeyT &&Key, Ts &&...Args)
Definition DenseMap.h:348
size_type count(const_arg_type_t< KeyT > Val) const
Return 1 if the specified key is in the map, 0 otherwise.
Definition DenseMap.h:254
iterator end()
Definition DenseMap.h:176
bool contains(const_arg_type_t< KeyT > Val) const
Return true if the specified key is in the map, false otherwise.
Definition DenseMap.h:249
std::pair< iterator, bool > insert(const std::pair< KeyT, ValueT > &KV)
Definition DenseMap.h:319
Analysis pass which computes a DominatorTree.
Definition Dominators.h:241
Concrete subclass of DominatorTreeBase that is used to compute a normal dominator tree.
Definition Dominators.h:122
LLVM_ABI bool dominates(const BasicBlock *BB, const Use &U) const
Return true if the (end of the) basic block BB dominates the use U.
const BasicBlock & getEntryBlock() const
Definition Function.h:794
Argument * arg_iterator
Definition Function.h:73
iterator_range< arg_iterator > args()
Definition Function.h:877
const Function & getFunction() const
Definition Function.h:167
size_t arg_size() const
Definition Function.h:886
Argument * getArg(unsigned i) const
Definition Function.h:871
bool hasFnAttribute(Attribute::AttrKind Kind) const
Return true if the function has the attribute.
Definition Function.cpp:730
BlockT * getHeader(CycleRef C) const
CycleRef getCycle(const BlockT *Block) const
Find the innermost cycle containing Block.
LLVM_ABI bool isDeclaration() const
Return true if the primary definition of this global value is outside of the current translation unit...
Definition Globals.cpp:408
bool hasLocalLinkage() const
static LLVM_ABI bool compare(const APInt &LHS, const APInt &RHS, ICmpInst::Predicate Pred)
Return result of LHS Pred RHS comparison.
Value * CreatePtrAdd(Value *Ptr, Value *Offset, const Twine &Name="", GEPNoWrapFlags NW=GEPNoWrapFlags::none())
Definition IRBuilder.h:2100
ConstantInt * getInt64(uint64_t C)
Get a constant 64-bit value.
Definition IRBuilder.h:482
This provides a uniform API for creating instructions and inserting them into a basic block: either a...
Definition IRBuilder.h:2908
LLVM_ABI Instruction * clone() const
Create a copy of 'this' instruction that is identical in all ways except the following:
LLVM_ABI bool isLifetimeStartOrEnd() const LLVM_READONLY
Return true if the instruction is a llvm.lifetime.start or llvm.lifetime.end marker.
bool mayReadOrWriteMemory() const
Return true if this instruction may read or write memory.
LLVM_ABI bool mayWriteToMemory() const LLVM_READONLY
Return true if this instruction may modify memory.
bool hasMetadata() const
Return true if this instruction has any metadata attached to it.
LLVM_ABI void insertBefore(InstListType::iterator InsertPos)
Insert an unlinked instruction into a basic block immediately before the specified position.
LLVM_ABI InstListType::iterator eraseFromParent()
This method unlinks 'this' from the containing basic block and deletes it.
LLVM_ABI const Function * getFunction() const
Return the function this instruction belongs to.
LLVM_ABI BasicBlock * getSuccessor(unsigned Idx) const LLVM_READONLY
Return the specified successor. This instruction must be a terminator.
LLVM_ABI bool mayHaveSideEffects() const LLVM_READONLY
Return true if the instruction may have side effects.
bool isTerminator() const
LLVM_ABI bool mayReadFromMemory() const LLVM_READONLY
Return true if this instruction may read memory.
iterator_range< user_iterator > users()
LLVM_ABI void setMetadata(unsigned KindID, MDNode *Node)
Set the metadata of the specified kind to the specified node.
unsigned getOpcode() const
Returns a member of one of the enums like Instruction::Add.
void setDebugLoc(DebugLoc Loc)
Set the debug location information for this instruction.
LLVM_ABI const DataLayout & getDataLayout() const
Get the data layout of the module this instruction belongs to.
This is an important class for using LLVM in a threaded context.
Definition LLVMContext.h:68
LLVM_ABI ConstantRange getConstantRange(Value *V, Instruction *CxtI, bool UndefAllowed)
Return the ConstantRange constraint that is known to hold for the specified value at the specified in...
LoopT * getLoopFor(const BlockT *BB) const
Return the inner most loop that BB lives in.
static MDTuple * get(LLVMContext &Context, ArrayRef< Metadata * > MDs)
Definition Metadata.h:1578
static LLVM_ABI MDNode * getMostGenericRange(MDNode *A, MDNode *B)
bool empty() const
Definition MapVector.h:79
static MemoryEffectsBase readOnly()
Definition ModRef.h:133
bool doesNotAccessMemory() const
Whether this function accesses no memory.
Definition ModRef.h:246
static MemoryEffectsBase argMemOnly(ModRefInfo MR=ModRefInfo::ModRef)
Definition ModRef.h:143
static MemoryEffectsBase inaccessibleMemOnly(ModRefInfo MR=ModRefInfo::ModRef)
Definition ModRef.h:149
bool onlyAccessesInaccessibleMem() const
Whether this function only (at most) accesses inaccessible memory.
Definition ModRef.h:265
ModRefInfo getModRef(Location Loc) const
Get ModRefInfo for the given Location.
Definition ModRef.h:219
bool onlyAccessesArgPointees() const
Whether this function only (at most) accesses argument memory.
Definition ModRef.h:255
bool onlyReadsMemory() const
Whether this function only (at most) reads memory.
Definition ModRef.h:249
static MemoryEffectsBase writeOnly()
Definition ModRef.h:138
static MemoryEffectsBase inaccessibleOrArgMemOnly(ModRefInfo MR=ModRefInfo::ModRef)
Definition ModRef.h:166
static MemoryEffectsBase none()
Definition ModRef.h:128
bool onlyAccessesInaccessibleOrArgMem() const
Whether this function only (at most) accesses argument and inaccessible memory.
Definition ModRef.h:305
static MemoryEffectsBase unknown()
Definition ModRef.h:123
static LLVM_ABI std::optional< MemoryLocation > getOrNone(const Instruction *Inst)
static SizeOffsetValue unknown()
static PHINode * Create(Type *Ty, unsigned NumReservedValues, const Twine &NameStr="", InsertPosition InsertBefore=nullptr)
Constructors - NumReservedValues is a hint for the number of incoming edges that this phi node will h...
static LLVM_ABI PoisonValue * get(Type *T)
Static factory methods - Return an 'poison' object of the specified type.
Value * getReturnValue() const
Convenience accessor. Returns null if there is no return value.
LLVM_ABI SCEVUse getSCEVAtScope(const SCEV *S, const Loop *L)
Return a SCEV expression for the specified value at the specified scope in the program.
LLVM_ABI const SCEV * getSCEV(Value *V)
Return a SCEV expression for the full generality of the specified expression.
LLVM_ABI unsigned getSmallConstantMaxTripCount(const Loop *L, SmallVectorImpl< const SCEVPredicate * > *Predicates=nullptr)
Returns the upper bound of the loop trip count as a normal unsigned value.
ConstantRange getUnsignedRange(const SCEV *S)
Determine the unsigned range for a particular SCEV.
A vector that has set insertion semantics.
Definition SetVector.h:57
size_type size() const
Determine the number of elements in the SetVector.
Definition SetVector.h:103
bool insert(const value_type &X)
Insert a new element into the SetVector.
Definition SetVector.h:157
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.
std::pair< const_iterator, bool > insert(const T &V)
insert - Insert an element into the set if it isn't already there.
Definition SmallSet.h:184
This class consists of common code factored out of the SmallVector class to reduce code duplication b...
void append(ItTy in_start, ItTy in_end)
Add the specified range to the end of the SmallVector.
void push_back(const T &Elt)
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
Used to lazily calculate structure layout information for a target machine, based on the DataLayout s...
Definition DataLayout.h:743
TypeSize getElementOffset(unsigned Idx) const
Definition DataLayout.h:774
TypeSize getElementOffsetInBits(unsigned Idx) const
Definition DataLayout.h:779
Class to represent struct types.
unsigned getNumElements() const
Random access to the elements.
Type * getElementType(unsigned N) const
LLVM_ABI bool areTypesABICompatible(const Function *Caller, const Function *Callee, ArrayRef< Type * > Types) const
LLVM_ABI unsigned getAssumedAddrSpace(const Value *V) const
LLVM_ABI bool hasVolatileVariant(Instruction *I, unsigned AddrSpace) const
Return true if the given instruction (assumed to be a memory access instruction) has a volatile varia...
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition Twine.h:82
The instances of the Type class are immutable: once they are created, they are never changed.
Definition Type.h:46
LLVM_ABI unsigned getIntegerBitWidth() const
bool isPointerTy() const
True if this is an instance of PointerType.
Definition Type.h:277
LLVM_ABI unsigned getPointerAddressSpace() const
Get the address space of this pointer or pointer vector type.
bool isPtrOrPtrVectorTy() const
Return true if this is a pointer type or a vector of pointer types.
Definition Type.h:280
bool isIntegerTy() const
True if this is an instance of IntegerType.
Definition Type.h:252
bool isVoidTy() const
Return true if this is 'void'.
Definition Type.h:141
static UncondBrInst * Create(BasicBlock *Target, InsertPosition InsertBefore=nullptr)
BasicBlock * getSuccessor(unsigned i=0) const
static LLVM_ABI UndefValue * get(Type *T)
Static factory methods - Return an 'undef' object of the specified type.
A Use represents the edge between a Value definition and its users.
Definition Use.h:35
User * getUser() const
Returns the User that contains this Use.
Definition Use.h:61
Value * get() const
Definition Use.h:55
const Use & getOperandUse(unsigned i) const
Definition User.h:220
LLVM_ABI bool isDroppable() const
A droppable user is a user for which uses can be dropped without affecting correctness and should be ...
Definition User.cpp:119
LLVM_ABI bool replaceUsesOfWith(Value *From, Value *To)
Replace uses of one Value with another.
Definition User.cpp:25
Value * getOperand(unsigned i) const
Definition User.h:207
unsigned getNumOperands() const
Definition User.h:229
ValueT lookup(const KeyT &Val) const
lookup - Return the entry for the specified key, or a default constructed value if no such entry exis...
Definition ValueMap.h:167
LLVM Value Representation.
Definition Value.h:75
Type * getType() const
All values are typed, get the type of this value.
Definition Value.h:257
static constexpr uint64_t MaximumAlignment
Definition Value.h:801
LLVM_ABI void replaceAllUsesWith(Value *V)
Change all uses of this to point to a new Value.
Definition Value.cpp:553
LLVMContext & getContext() const
All values hold a context through their type.
Definition Value.h:260
LLVM_ABI const Value * stripAndAccumulateConstantOffsets(const DataLayout &DL, APInt &Offset, bool AllowNonInbounds, bool AllowInvariantGroup=false, function_ref< bool(Value &Value, APInt &Offset)> ExternalAnalysis=nullptr, bool LookThroughIntToPtr=false) const
Accumulate the constant offset this value has compared to a base pointer.
bool use_empty() const
Definition Value.h:348
static constexpr unsigned MaxAlignmentExponent
The maximum alignment for instructions.
Definition Value.h:800
iterator_range< use_iterator > uses()
Definition Value.h:382
LLVM_ABI StringRef getName() const
Return a constant reference to the value's name.
Definition Value.cpp:319
std::pair< iterator, bool > insert(const ValueT &V)
Definition DenseSet.h:209
constexpr ScalarTy getFixedValue() const
Definition TypeSize.h:200
constexpr bool isScalable() const
Returns whether the quantity is scaled by a runtime quantity (vscale).
Definition TypeSize.h:168
const ParentTy * getParent() const
Definition ilist_node.h:34
self_iterator getIterator()
Definition ilist_node.h:123
NodeTy * getNextNode()
Get the next node, or nullptr for the list tail.
Definition ilist_node.h:348
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition raw_ostream.h:53
A raw_ostream that writes to an std::string.
Changed
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
Abstract Attribute helper functions.
Definition Attributor.h:165
LLVM_ABI bool isAssumedReadNone(Attributor &A, const IRPosition &IRP, const AbstractAttribute &QueryingAA, bool &IsKnown)
Return true if IRP is readnone.
LLVM_ABI bool isAssumedReadOnly(Attributor &A, const IRPosition &IRP, const AbstractAttribute &QueryingAA, bool &IsKnown)
Return true if IRP is readonly.
raw_ostream & operator<<(raw_ostream &OS, const RangeTy &R)
Definition Attributor.h:335
LLVM_ABI std::optional< Value * > combineOptionalValuesInAAValueLatice(const std::optional< Value * > &A, const std::optional< Value * > &B, Type *Ty)
Return the combination of A and B such that the result is a possible value of both.
LLVM_ABI bool isValidAtPosition(const ValueAndContext &VAC, InformationCache &InfoCache)
Return true if the value of VAC is a valid at the position of VAC, that is a constant,...
LLVM_ABI bool isAssumedThreadLocalObject(Attributor &A, Value &Obj, const AbstractAttribute &QueryingAA)
Return true if Obj is assumed to be a thread local object.
LLVM_ABI bool isGPUConstantAddressSpace(const Module &M, unsigned AS)
Check if the given address space AS corresponds to a GPU constant address space for the target triple...
LLVM_ABI bool isDynamicallyUnique(Attributor &A, const AbstractAttribute &QueryingAA, const Value &V, bool ForAnalysisOnly=true)
Return true if V is dynamically unique, that is, there are no two "instances" of V at runtime with di...
LLVM_ABI bool getPotentialCopiesOfStoredValue(Attributor &A, StoreInst &SI, SmallSetVector< Value *, 4 > &PotentialCopies, const AbstractAttribute &QueryingAA, bool &UsedAssumedInformation, bool OnlyExact=false)
Collect all potential values of the one stored by SI into PotentialCopies.
LLVM_ABI bool isGPUSharedAddressSpace(const Module &M, unsigned AS)
Check if the given address space AS corresponds to a GPU shared address space for the target triple i...
LLVM_ABI bool isGPULocalAddressSpace(const Module &M, unsigned AS)
Check if the given address space AS corresponds to a GPU local/private address space for the target t...
SmallPtrSet< Instruction *, 4 > InstExclusionSetTy
Definition Attributor.h:166
LLVM_ABI bool isGPU(const Module &M)
Return true iff M target a GPU (and we can use GPU AS reasoning).
ValueScope
Flags to distinguish intra-procedural queries from potentially inter-procedural queries.
Definition Attributor.h:194
@ Intraprocedural
Definition Attributor.h:195
@ Interprocedural
Definition Attributor.h:196
LLVM_ABI bool isValidInScope(const Value &V, const Function *Scope)
Return true if V is a valid value in Scope, that is a constant or an instruction/argument of Scope.
LLVM_ABI bool isPotentiallyReachable(Attributor &A, const Instruction &FromI, const Instruction &ToI, const AbstractAttribute &QueryingAA, const AA::InstExclusionSetTy *ExclusionSet=nullptr, std::function< bool(const Function &F)> GoBackwardsCB=nullptr)
Return true if ToI is potentially reachable from FromI without running into any instruction in Exclus...
LLVM_ABI bool isNoSyncInst(Attributor &A, const Instruction &I, const AbstractAttribute &QueryingAA)
Return true if I is a nosync instruction.
bool hasAssumedIRAttr(Attributor &A, const AbstractAttribute *QueryingAA, const IRPosition &IRP, DepClassTy DepClass, bool &IsKnown, bool IgnoreSubsumingPositions=false, const AAType **AAPtr=nullptr)
Helper to avoid creating an AA for IR Attributes that might already be set.
LLVM_ABI bool getPotentiallyLoadedValues(Attributor &A, LoadInst &LI, SmallSetVector< Value *, 4 > &PotentialValues, SmallSetVector< Instruction *, 4 > &PotentialValueOrigins, const AbstractAttribute &QueryingAA, bool &UsedAssumedInformation, bool OnlyExact=false)
Collect all potential values LI could read into PotentialValues.
LLVM_ABI Value * getWithType(Value &V, Type &Ty)
Try to convert V to type Ty without introducing new instructions.
constexpr char Align[]
Key for Kernel::Arg::Metadata::mAlign.
constexpr char Attrs[]
Key for Kernel::Metadata::mAttrs.
@ BasicBlock
Various leaf nodes.
Definition ISDOpcodes.h:81
@ Unsupported
This operation is completely unsupported on the target.
Offsets
Offsets in bytes from the start of the input buffer.
@ SingleThread
Synchronized with respect to signal handlers executing in the same thread.
Definition LLVMContext.h:55
@ CE
Windows NT (Windows on ARM)
Definition MCAsmInfo.h:51
@ Valid
The data is already valid.
initializer< Ty > init(const Ty &Val)
LocationClass< Ty > location(Ty &L)
unsigned combineHashValue(unsigned a, unsigned b)
Simplistic combination of 32-bit hash values into 32-bit hash values.
ElementType
The element type of an SRV or UAV resource.
Definition DXILABI.h:68
std::enable_if_t< detail::IsValidPointer< X, Y >::value, X * > dyn_extract_or_null(Y &&MD)
Extract a Value from Metadata, if any, allowing null.
Definition Metadata.h:720
std::enable_if_t< detail::IsValidPointer< X, Y >::value, X * > extract(Y &&MD)
Extract a Value from Metadata.
Definition Metadata.h:679
@ User
could "use" a pointer
DiagnosticInfoOptimizationBase::Argument NV
NodeAddr< UseNode * > Use
Definition RDFGraph.h:385
iterator end() const
Definition BasicBlock.h:89
friend class Instruction
Iterator for Instructions in a `BasicBlock.
Definition BasicBlock.h:73
LLVM_ABI iterator begin() const
This is an optimization pass for GlobalISel generic memory operations.
@ Offset
Definition DWP.cpp:577
@ Length
Definition DWP.cpp:577
bool operator<(int64_t V1, const APSInt &V2)
Definition APSInt.h:360
LLVM_ATTRIBUTE_ALWAYS_INLINE DynamicAPInt gcd(const DynamicAPInt &A, const DynamicAPInt &B)
LLVM_ABI KnownFPClass computeKnownFPClass(const Value *V, const APInt &DemandedElts, FPClassTest InterestedClasses, const SimplifyQuery &SQ, unsigned Depth=0)
Determine which floating-point classes are valid for V, and return them in KnownFPClass bit sets.
bool all_of(R &&range, UnaryPredicate P)
Provide wrappers to std::all_of which take ranges instead of having to pass begin/end explicitly.
Definition STLExtras.h:1755
LLVM_ABI bool isLegalToPromote(const CallBase &CB, Function *Callee, const char **FailureReason=nullptr)
Return true if the given indirect call site can be made to call Callee.
LLVM_ABI Constant * getInitialValueOfAllocation(const Value *V, const TargetLibraryInfo *TLI, Type *Ty)
If this is a call to an allocation function that initializes memory to a fixed value,...
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:1685
RelativeUniformCounterPtr Values
Definition InstrProf.h:91
@ Known
Known to have no common set bits.
@ Undef
Value of the register doesn't matter.
auto pred_end(const MachineBasicBlock *BB)
unsigned getPointerAddressSpace(const Type *T)
Definition SPIRVUtils.h:395
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)
LLVM_ABI bool isRemovableAlloc(const CallBase *V, const TargetLibraryInfo *TLI)
Return true if this is a call to an allocation function that does not have side effects that we are r...
APFloat abs(APFloat X)
Returns the absolute value of the argument.
Definition APFloat.h:1721
@ Load
The value being inserted comes from a load (InsertElement only).
@ Store
The extracted value is stored (ExtractElement only).
LLVM_ABI raw_fd_ostream & outs()
This returns a reference to a raw_fd_ostream for standard output.
LLVM_ABI Value * getAllocAlignment(const CallBase *V, const TargetLibraryInfo *TLI)
Gets the alignment argument for an aligned_alloc-like function, using either built-in knowledge based...
auto dyn_cast_if_present(const Y &Val)
dyn_cast_if_present<X> - Functionally identical to dyn_cast, except that a null (or none in the case ...
Definition Casting.h:732
LLVM_ABI Value * simplifyInstructionWithOperands(Instruction *I, ArrayRef< Value * > NewOps, const SimplifyQuery &Q)
Like simplifyInstruction but the operands of I are replaced with NewOps.
Value * GetPointerBaseWithConstantOffset(Value *Ptr, int64_t &Offset, const DataLayout &DL, bool AllowNonInbounds=true)
Analyze the specified pointer to see if it can be expressed as a base pointer plus a constant offset.
scc_iterator< T > scc_begin(const T &G)
Construct the begin iterator for a deduced graph type T.
LLVM_ABI bool isNoAliasCall(const Value *V)
Return true if this pointer is returned by a noalias function.
MemoryEffectsBase< IRMemLocation > MemoryEffects
Summary of how a function affects memory in the program.
Definition ModRef.h:356
raw_ostream & WriteGraph(raw_ostream &O, const GraphType &G, bool ShortNames=false, const Twine &Title="")
LLVM_ABI bool isSafeToSpeculativelyExecute(const Instruction *I, const Instruction *CtxI=nullptr, AssumptionCache *AC=nullptr, const DominatorTree *DT=nullptr, const TargetLibraryInfo *TLI=nullptr, bool UseVariableInfo=true, bool IgnoreUBImplyingAttrs=true)
Return true if the instruction does not have any effects besides calculating the result and does not ...
bool isa_and_nonnull(const Y &Val)
Definition Casting.h:676
bool operator==(const AddressRangeValuePair &LHS, const AddressRangeValuePair &RHS)
LLVM_ABI ConstantRange getConstantRangeFromMetadata(const MDNode &RangeMD)
Parse out a conservative ConstantRange from !range metadata.
auto map_range(ContainerTy &&C, FuncTy F)
Return a range that applies F to the elements of C.
Definition STLExtras.h:366
const Value * getPointerOperand(const Value *V)
A helper function that returns the pointer operand of a load, store or GEP instruction.
RelativeUniformCounterPtr ValuesPtrExpr VTableAddr Value
Definition InstrProf.h:143
LLVM_ABI Value * simplifyInstruction(Instruction *I, const SimplifyQuery &Q)
See if we can compute a simplified version of this instruction.
auto dyn_cast_or_null(const Y &Val)
Definition Casting.h:753
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:1762
unsigned Log2_32(uint32_t Value)
Return the floor log base 2 of the specified value, -1 if the value is zero.
Definition MathExtras.h:326
constexpr bool isPowerOf2_32(uint32_t Value)
Return true if the argument is a power of two > 0.
Definition MathExtras.h:280
PotentialValuesState< std::pair< AA::ValueAndContext, AA::ValueScope > > PotentialLLVMValuesState
void sort(IteratorTy Start, IteratorTy End)
Definition STLExtras.h:1652
LLVM_ABI bool NullPointerIsDefined(const Function *F, unsigned AS=0)
Check whether null pointer dereferencing is considered undefined behavior for a given function or an ...
LLVM_ABI raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
Definition Debug.cpp:209
bool isPointerTy(const Type *T)
Definition SPIRVUtils.h:383
LLVM_ABI bool wouldInstructionBeTriviallyDead(const Instruction *I, const TargetLibraryInfo *TLI=nullptr)
Return true if the result produced by the instruction would have no side effects if it was not used.
Definition Local.cpp:409
bool set_union(S1Ty &S1, const S2Ty &S2)
set_union(A, B) - Compute A := A u B, return whether A changed.
class LLVM_GSL_OWNER SmallVector
Forward declaration of SmallVector so that calculateSmallVectorDefaultInlinedElements can reference s...
LLVM_ABI CallBase & promoteCall(CallBase &CB, Function *Callee, CastInst **RetBitCast=nullptr)
Promote the given indirect call site to unconditionally call Callee.
LLVM_ABI const Value * getUnderlyingObject(const Value *V, unsigned MaxLookup=MaxLookupSearchDepth, bool MustPreserveProvenance=false)
This method strips off any GEP address adjustments, pointer casts or llvm.threadlocal....
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 bool hasAssumption(const Function &F, const KnownAssumptionString &AssumptionStr)
Return true if F has the assumption AssumptionStr attached.
LLVM_ABI RetainedKnowledge getKnowledgeFromUse(const Use *U, ArrayRef< Attribute::AttrKind > AttrKinds)
Return a valid Knowledge associated to the Use U if its Attribute kind is in AttrKinds.
@ Success
The lock was released successfully.
LLVM_ATTRIBUTE_VISIBILITY_DEFAULT AnalysisKey InnerAnalysisManagerProxy< AnalysisManagerT, IRUnitT, ExtraArgTs... >::Key
LLVM_ABI bool isKnownNonZero(const Value *V, const SimplifyQuery &Q, unsigned Depth=0)
Return true if the given value is known to be non-zero when defined.
AtomicOrdering
Atomic ordering for LLVM's memory model.
@ Other
Any other memory.
Definition ModRef.h:68
PotentialValuesState< APInt > PotentialConstantIntValuesState
TargetTransformInfo TTI
std::string join(IteratorT Begin, IteratorT End, StringRef Separator)
Joins the strings in the range [Begin, End), adding Separator between the elements.
IRBuilder(LLVMContext &, FolderTy, InserterTy, MDNode *, ArrayRef< OperandBundleDef >) -> IRBuilder< FolderTy, InserterTy >
InterleavedRange< Range > interleaved_array(const Range &R, StringRef Separator=", ")
Output range R as an array of interleaved elements.
ChangeStatus clampStateAndIndicateChange< DerefState >(DerefState &S, const DerefState &R)
void RemapInstruction(Instruction *I, ValueToValueMapTy &VM, RemapFlags Flags=RF_None, ValueMapTypeRemapper *TypeMapper=nullptr, ValueMaterializer *Materializer=nullptr, const MetadataPredicate *IdentityMD=nullptr)
Convert the instruction operands from referencing the current values into those specified by VM.
LLVM_ABI bool isIntrinsicReturningPointerAliasingArgumentWithoutCapturing(const CallBase *Call, bool MustPreserveOffset, bool MustPreserveProvenance=false)
{launder,strip}.invariant.group returns pointer that aliases its argument, and it only captures point...
DWARFExpression::Operation Op
LLVM_ABI bool isGuaranteedNotToBeUndefOrPoison(const Value *V, AssumptionCache *AC=nullptr, const Instruction *CtxI=nullptr, const DominatorTree *DT=nullptr, unsigned Depth=0)
Return true if this function can prove that V does not have undef bits and is never poison.
ArrayRef(const T &OneElt) -> ArrayRef< T >
LLVM_ABI Value * getFreedOperand(const CallBase *CB, const TargetLibraryInfo *TLI)
If this if a call to a free function, return the freed operand.
ChangeStatus clampStateAndIndicateChange(StateType &S, const StateType &R)
Helper function to clamp a state S of type StateType with the information in R and indicate/return if...
constexpr unsigned BitWidth
ValueMap< const Value *, WeakTrackingVH > ValueToValueMapTy
auto pred_begin(const MachineBasicBlock *BB)
decltype(auto) cast(const From &Val)
cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:559
iterator_range< pointer_iterator< WrappedIteratorT > > make_pointer_range(RangeT &&Range)
Definition iterator.h:368
ChangeStatus
{
Definition Attributor.h:485
LLVM_ABI std::optional< APInt > getAllocSize(const CallBase *CB, const TargetLibraryInfo *TLI, function_ref< const Value *(const Value *)> Mapper=[](const Value *V) { return V;})
Return the size of the requested allocation.
LLVM_ABI DenseSet< StringRef > getAssumptions(const Function &F)
Return the set of all assumptions for the function F.
Align assumeAligned(uint64_t Value)
Treats the value 0 as a 1, so Align is always at least 1.
Definition Alignment.h:100
LLVM_ABI Instruction * SplitBlockAndInsertIfThen(Value *Cond, BasicBlock::iterator SplitBefore, bool Unreachable, MDNode *BranchWeights=nullptr, DomTreeUpdater *DTU=nullptr, LoopInfo *LI=nullptr, BasicBlock *ThenBlock=nullptr)
Split the containing block at the specified instruction - everything before SplitBefore stays in the ...
@ OPTIONAL
The target may be valid if the source is not.
Definition Attributor.h:497
@ NONE
Do not track a dependence between source and target.
Definition Attributor.h:498
@ REQUIRED
The target cannot be valid if the source is not.
Definition Attributor.h:496
LLVM_ABI UseCaptureInfo DetermineUseCaptureKind(const Use &U, const Value *Base)
Determine what kind of capture behaviour U may exhibit.
LLVM_ABI Value * simplifyCmpInst(CmpPredicate Predicate, Value *LHS, Value *RHS, const SimplifyQuery &Q)
Given operands for a CmpInst, fold the result or return null.
LLVM_ABI bool mayContainIrreducibleControl(const Function &F, const LoopInfo *LI)
BumpPtrAllocatorImpl<> BumpPtrAllocator
The standard BumpPtrAllocator which just uses the default template parameters.
Definition Allocator.h:390
T bit_floor(T Value)
Returns the largest integral power of two no greater than Value if Value is nonzero.
Definition bit.h:347
bool capturesNothing(CaptureComponents CC)
Definition ModRef.h:375
LLVM_ABI bool isIdentifiedObject(const Value *V)
Return true if this pointer refers to a distinct and identifiable object.
bool capturesAnyProvenance(CaptureComponents CC)
Definition ModRef.h:400
constexpr StringRef AssumptionAttrKey
The key we use for assumption attributes.
Definition Assumptions.h:29
constexpr bool isCallableCC(CallingConv::ID CC)
void swap(llvm::BitVector &LHS, llvm::BitVector &RHS)
Implement std::swap in terms of BitVector swap.
Definition BitVector.h:880
A type to track pointer/struct usage and accesses for AAPointerInfo.
bool forallInterferingAccesses(AA::RangeTy Range, F CB) const
See AAPointerInfo::forallInterferingAccesses.
AAPointerInfo::const_bin_iterator end() const
ChangeStatus addAccess(Attributor &A, const AAPointerInfo::RangeList &Ranges, Instruction &I, std::optional< Value * > Content, AAPointerInfo::AccessKind Kind, Type *Ty, Instruction *RemoteI=nullptr)
Add a new Access to the state at offset Offset and with size Size.
DenseMap< const Instruction *, SmallVector< unsigned > > RemoteIMap
AAPointerInfo::const_bin_iterator begin() const
AAPointerInfo::OffsetInfo ReturnedOffsets
Flag to determine if the underlying pointer is reaching a return statement in the associated function...
State(State &&SIS)=default
const AAPointerInfo::Access & getAccess(unsigned Index) const
SmallVector< AAPointerInfo::Access > AccessList
bool isAtFixpoint() const override
See AbstractState::isAtFixpoint().
bool forallInterferingAccesses(Instruction &I, F CB, AA::RangeTy &Range) const
See AAPointerInfo::forallInterferingAccesses.
static State getWorstState(const State &SIS)
Return the worst possible representable state.
AAPointerInfo::OffsetBinsTy OffsetBins
ChangeStatus indicateOptimisticFixpoint() override
See AbstractState::indicateOptimisticFixpoint().
ChangeStatus indicatePessimisticFixpoint() override
See AbstractState::indicatePessimisticFixpoint().
static State getBestState(const State &SIS)
Return the best possible representable state.
bool isValidState() const override
See AbstractState::isValidState().
----------------—AAIntraFnReachability Attribute-----------------------—
ReachabilityQueryInfo(const ReachabilityQueryInfo &RQI)
unsigned Hash
Precomputed hash for this RQI.
const Instruction * From
Start here,.
Reachable Result
and remember if it worked:
ReachabilityQueryInfo(const Instruction *From, const ToTy *To)
ReachabilityQueryInfo(Attributor &A, const Instruction &From, const ToTy &To, const AA::InstExclusionSetTy *ES, bool MakeUnique)
Constructor replacement to ensure unique and stable sets are used for the cache.
const ToTy * To
reach this place,
const AA::InstExclusionSetTy * ExclusionSet
without going through any of these instructions,
An abstract interface for address space information.
static LLVM_ABI const char ID
Unique ID (due to the unique address)
An abstract interface for all align attributes.
static LLVM_ABI const char ID
Unique ID (due to the unique address)
Align getKnownAlign() const
Return known alignment.
static LLVM_ABI const char ID
An abstract attribute for getting assumption information.
static LLVM_ABI const char ID
Unique ID (due to the unique address)
An abstract state for querying live call edges.
static LLVM_ABI const char ID
Unique ID (due to the unique address)
An abstract Attribute for specializing "dynamic" components of denormal_fpenv to a known denormal mod...
static LLVM_ABI const char ID
Unique ID (due to the unique address)
An abstract interface for all dereferenceable attribute.
static LLVM_ABI const char ID
Unique ID (due to the unique address)
An abstract interface for llvm::GlobalValue information interference.
static LLVM_ABI const char ID
Unique ID (due to the unique address)
static LLVM_ABI const char ID
Unique ID (due to the unique address)
An abstract interface for indirect call information interference.
static LLVM_ABI const char ID
Unique ID (due to the unique address)
An abstract interface to track if a value leaves it's defining function instance.
static LLVM_ABI const char ID
Unique ID (due to the unique address)
An abstract Attribute for computing reachability between functions.
static LLVM_ABI const char ID
Unique ID (due to the unique address)
bool canReach(Attributor &A, const Function &Fn) const
If the function represented by this possition can reach Fn.
virtual bool instructionCanReach(Attributor &A, const Instruction &Inst, const Function &Fn, const AA::InstExclusionSetTy *ExclusionSet=nullptr) const =0
Can Inst reach Fn.
An abstract interface to determine reachability of point A to B.
static LLVM_ABI const char ID
Unique ID (due to the unique address)
An abstract interface for identifying pointers from which loads can be marked invariant.
static LLVM_ABI const char ID
Unique ID (due to the unique address).
An abstract interface for liveness abstract attribute.
static LLVM_ABI const char ID
Unique ID (due to the unique address)
An abstract interface for memory access kind related attributes (readnone/readonly/writeonly).
bool isAssumedReadOnly() const
Return true if we assume that the underlying value is not accessed (=written) in its respective scope...
bool isKnownReadNone() const
Return true if we know that the underlying value is not read or accessed in its respective scope.
static LLVM_ABI const char ID
Unique ID (due to the unique address)
bool isAssumedReadNone() const
Return true if we assume that the underlying value is not read or accessed in its respective scope.
An abstract interface for all memory location attributes (readnone/argmemonly/inaccessiblememonly/ina...
static LLVM_ABI std::string getMemoryLocationsAsStr(MemoryLocationsKind MLK)
Return the locations encoded by MLK as a readable string.
static LLVM_ABI const char ID
Unique ID (due to the unique address)
StateType::base_t MemoryLocationsKind
An abstract interface for all nonnull attributes.
static LLVM_ABI const char ID
Unique ID (due to the unique address)
An abstract interface for potential address space information.
static LLVM_ABI const char ID
Unique ID (due to the unique address)
An abstract interface for all noalias attributes.
static LLVM_ABI bool isImpliedByIR(Attributor &A, const IRPosition &IRP, Attribute::AttrKind ImpliedAttributeKind, bool IgnoreSubsumingPositions=false)
See IRAttribute::isImpliedByIR.
static LLVM_ABI const char ID
Unique ID (due to the unique address)
An abstract interface for all nocapture attributes.
@ NO_CAPTURE_MAYBE_RETURNED
If we do not capture the value in memory or through integers we can only communicate it back as a der...
@ NO_CAPTURE
If we do not capture the value in memory, through integers, or as a derived pointer we know it is not...
static LLVM_ABI const char ID
Unique ID (due to the unique address)
bool isAssumedNoCaptureMaybeReturned() const
Return true if we assume that the underlying value is not captured in its respective scope but we all...
static LLVM_ABI bool isImpliedByIR(Attributor &A, const IRPosition &IRP, Attribute::AttrKind ImpliedAttributeKind, bool IgnoreSubsumingPositions=false)
See IRAttribute::isImpliedByIR.
static LLVM_ABI void determineFunctionCaptureCapabilities(const IRPosition &IRP, const Function &F, BitIntegerState &State)
Update State according to the capture capabilities of F for position IRP.
static LLVM_ABI const char ID
Unique ID (due to the unique address)
An AbstractAttribute for nofree.
static LLVM_ABI const char ID
Unique ID (due to the unique address)
An abstract attribute for norecurse.
static LLVM_ABI const char ID
Unique ID (due to the unique address)
An AbstractAttribute for noreturn.
static LLVM_ABI const char ID
Unique ID (due to the unique address)
static LLVM_ABI const char ID
Unique ID (due to the unique address)
static LLVM_ABI bool isAlignedBarrier(const CallBase &CB, bool ExecutedAligned)
Helper function to determine if CB is an aligned (GPU) barrier.
static LLVM_ABI bool isNonRelaxedAtomic(const Instruction *I)
Helper function used to determine whether an instruction is non-relaxed atomic.
An abstract interface for all noundef attributes.
static LLVM_ABI const char ID
Unique ID (due to the unique address)
static LLVM_ABI bool isImpliedByIR(Attributor &A, const IRPosition &IRP, Attribute::AttrKind ImpliedAttributeKind, bool IgnoreSubsumingPositions=false)
See IRAttribute::isImpliedByIR.
static LLVM_ABI const char ID
Unique ID (due to the unique address)
An abstract Attribute for determining the necessity of the convergent attribute.
static LLVM_ABI const char ID
Unique ID (due to the unique address)
An abstract interface for all nonnull attributes.
static LLVM_ABI const char ID
Unique ID (due to the unique address)
static LLVM_ABI bool isImpliedByIR(Attributor &A, const IRPosition &IRP, Attribute::AttrKind ImpliedAttributeKind, bool IgnoreSubsumingPositions=false)
See AbstractAttribute::isImpliedByIR(...).
An access description.
A helper containing a list of offsets computed for a Use.
A container for a list of ranges.
static void set_difference(const RangeList &L, const RangeList &R, RangeList &D)
Copy ranges from L that are not in R, into D.
An abstract interface for struct information.
virtual bool reachesReturn() const =0
OffsetBinsTy::const_iterator const_bin_iterator
virtual const_bin_iterator begin() const =0
DenseMap< AA::RangeTy, SmallSet< unsigned, 4 > > OffsetBinsTy
static LLVM_ABI const char ID
Unique ID (due to the unique address)
virtual int64_t numOffsetBins() const =0
An abstract interface for potential values analysis.
static LLVM_ABI const char ID
Unique ID (due to the unique address)
friend struct Attributor
static LLVM_ABI const char ID
Unique ID (due to the unique address)
static LLVM_ABI Value * getSingleValue(Attributor &A, const AbstractAttribute &AA, const IRPosition &IRP, SmallVectorImpl< AA::ValueAndContext > &Values)
Extract the single value in Values if any.
An abstract interface for privatizability.
static LLVM_ABI const char ID
Unique ID (due to the unique address)
An abstract attribute for undefined behavior.
static LLVM_ABI const char ID
Unique ID (due to the unique address)
An abstract attribute for getting all assumption underlying objects.
virtual bool forallUnderlyingObjects(function_ref< bool(Value &)> Pred, AA::ValueScope Scope=AA::Interprocedural) const =0
Check Pred on all underlying objects in Scope collected so far.
static LLVM_ABI const char ID
Unique ID (due to the unique address)
An abstract interface for range value analysis.
static LLVM_ABI const char ID
Unique ID (due to the unique address)
An abstract interface for value simplify abstract attribute.
static LLVM_ABI const char ID
Unique ID (due to the unique address)
An abstract attribute for willreturn.
static LLVM_ABI const char ID
Unique ID (due to the unique address)
Helper to represent an access offset and size, with logic to deal with uncertainty and check for over...
Definition Attributor.h:253
static constexpr int64_t Unknown
Definition Attributor.h:332
static RangeTy getUnknown()
Definition Attributor.h:259
Value * getValue() const
Definition Attributor.h:206
const Instruction * getCtxI() const
Definition Attributor.h:207
Base struct for all "concrete attribute" deductions.
void print(raw_ostream &OS) const
Helper functions, for debug purposes only.
virtual StateType & getState()=0
Return the internal abstract state for inspection.
AbstractState StateType
An interface to query the internal state of an abstract attribute.
virtual bool isAtFixpoint() const =0
Return if this abstract state is fixed, thus does not need to be updated if information changes as it...
virtual bool isValidState() const =0
Return if this abstract state is in a valid state.
constexpr uint64_t value() const
This is a hole in the type system and should not be abused.
Definition Alignment.h:77
std::function< void( const ArgumentReplacementInfo &, Function &, Function::arg_iterator)> CalleeRepairCBTy
Callee repair callback type.
const Argument & getReplacedArg() const
std::function< void(const ArgumentReplacementInfo &, AbstractCallSite, SmallVectorImpl< Value * > &)> ACSRepairCBTy
Abstract call site (ACS) repair callback type.
The fixpoint analysis framework that orchestrates the attribute deduction.
std::function< std::optional< Value * >( const IRPosition &, const AbstractAttribute *, bool &)> SimplifictionCallbackTy
Register CB as a simplification callback.
Specialization of the integer state for a bit-wise encoding.
BitIntegerState & addKnownBits(base_t Bits)
Add the bits in BitsEncoding to the "known bits".
Simple wrapper for a single bit (boolean) state.
static constexpr DenormalFPEnv getDefault()
static unsigned getHashValue(const Access &A)
static bool isEqual(const Access &LHS, const Access &RHS)
static bool isEqual(const AA::RangeTy &A, const AA::RangeTy B)
static unsigned getHashValue(const AA::RangeTy &Range)
DenseMapInfo< std::pair< const Instruction *, const ToTy * > > PairDMI
static bool isEqual(const ReachabilityQueryInfo< ToTy > *LHS, const ReachabilityQueryInfo< ToTy > *RHS)
DenseMapInfo< const AA::InstExclusionSetTy * > InstSetDMI
static unsigned getHashValue(const ReachabilityQueryInfo< ToTy > *RQI)
An information struct used to provide DenseMap with the various necessary components for a given valu...
State for dereferenceable attribute.
IncIntegerState DerefBytesState
State representing for dereferenceable bytes.
ChangeStatus manifest(Attributor &A) override
See AbstractAttribute::manifest(...).
Helper to describe and deal with positions in the LLVM-IR.
Definition Attributor.h:582
Function * getAssociatedFunction() const
Return the associated function, if any.
Definition Attributor.h:713
static const IRPosition callsite_returned(const CallBase &CB)
Create a position describing the returned value of CB.
Definition Attributor.h:650
static const IRPosition returned(const Function &F, const CallBaseContext *CBContext=nullptr)
Create a position describing the returned value of F.
Definition Attributor.h:632
LLVM_ABI Argument * getAssociatedArgument() const
Return the associated argument, if any.
static const IRPosition value(const Value &V, const CallBaseContext *CBContext=nullptr)
Create a position describing the value of V.
Definition Attributor.h:606
CallBase CallBaseContext
Definition Attributor.h:585
int getCalleeArgNo() const
Return the callee argument number of the associated value if it is an argument or call site argument,...
Definition Attributor.h:800
static const IRPosition inst(const Instruction &I, const CallBaseContext *CBContext=nullptr)
Create a position describing the instruction I.
Definition Attributor.h:618
static const IRPosition callsite_argument(const CallBase &CB, unsigned ArgNo)
Create a position describing the argument of CB at position ArgNo.
Definition Attributor.h:655
@ IRP_ARGUMENT
An attribute for a function argument.
Definition Attributor.h:596
@ IRP_RETURNED
An attribute for the function return value.
Definition Attributor.h:592
@ IRP_CALL_SITE
An attribute for a call site (function scope).
Definition Attributor.h:595
@ IRP_CALL_SITE_RETURNED
An attribute for a call site return value.
Definition Attributor.h:593
@ IRP_FUNCTION
An attribute for a function (scope).
Definition Attributor.h:594
@ IRP_CALL_SITE_ARGUMENT
An attribute for a call site argument.
Definition Attributor.h:597
@ IRP_INVALID
An invalid position.
Definition Attributor.h:589
Instruction * getCtxI() const
Return the context instruction, if any.
Definition Attributor.h:766
static const IRPosition argument(const Argument &Arg, const CallBaseContext *CBContext=nullptr)
Create a position describing the argument Arg.
Definition Attributor.h:639
Type * getAssociatedType() const
Return the type this abstract attribute is associated with.
Definition Attributor.h:789
static const IRPosition function(const Function &F, const CallBaseContext *CBContext=nullptr)
Create a position describing the function scope of F.
Definition Attributor.h:625
const CallBaseContext * getCallBaseContext() const
Get the call base context from the position.
Definition Attributor.h:928
Value & getAssociatedValue() const
Return the value this abstract attribute is associated with.
Definition Attributor.h:780
Value & getAnchorValue() const
Return the value this abstract attribute is anchored with.
Definition Attributor.h:699
int getCallSiteArgNo() const
Return the call site argument number of the associated value if it is an argument or call site argume...
Definition Attributor.h:809
static const IRPosition function_scope(const IRPosition &IRP, const CallBaseContext *CBContext=nullptr)
Create a position with function scope matching the "context" of IRP.
Definition Attributor.h:678
Kind getPositionKind() const
Return the associated position kind.
Definition Attributor.h:878
bool isArgumentPosition() const
Return true if the position is an argument or call site argument.
Definition Attributor.h:910
static const IRPosition callsite_function(const CallBase &CB)
Create a position describing the function scope of CB.
Definition Attributor.h:645
Function * getAnchorScope() const
Return the Function surrounding the anchor value.
Definition Attributor.h:754
Data structure to hold cached (LLVM-IR) information.
TargetLibraryInfo * getTargetLibraryInfoForFunction(const Function &F)
Return TargetLibraryInfo for function F.
bool isOnlyUsedByAssume(const Instruction &I) const
AP::Result * getAnalysisResultForFunction(const Function &F, bool CachedOnly=false)
Return the analysis result from a pass AP for function F.
ConstantRange getKnown() const
Return the known state encoding.
ConstantRange getAssumed() const
Return the assumed state encoding.
base_t getAssumed() const
Return the assumed state encoding.
Helper that allows to insert a new assumption string in the known assumption set by creating a (stati...
Definition Assumptions.h:37
FPClassTest getKnownFPClasses() const
Floating-point classes the value could be one of.
A "must be executed context" for a given program point PP is the set of instructions,...
iterator & end()
Return an universal end iterator.
bool findInContextOf(const Instruction *I, const Instruction *PP)
Helper to look for I in the context of PP.
iterator & begin(const Instruction *PP)
Return an iterator to explore the context around PP.
bool checkForAllContext(const Instruction *PP, function_ref< bool(const Instruction *)> Pred)
}
Helper to tie a abstract state implementation to an abstract attribute.
StateType & getState() override
See AbstractAttribute::getState(...).
CaptureComponents ResultCC
Components captured by the return value of the user of this Use.
LLVM_ABI bool unionAssumed(std::optional< Value * > Other)
Merge Other into the currently assumed simplified value.
std::optional< Value * > SimplifiedAssociatedValue
An assumed simplified value.
Type * Ty
The type of the original value.