LLVM 20.0.0git
AssumeBundleBuilder.h
Go to the documentation of this file.
1//===- AssumeBundleBuilder.h - utils to build assume bundles ----*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file contain tools to preserve informations. They should be used before
10// performing a transformation that may move and delete instructions as those
11// transformation may destroy or worsen information that can be derived from the
12// IR.
13//
14//===----------------------------------------------------------------------===//
15
16#ifndef LLVM_TRANSFORMS_UTILS_ASSUMEBUNDLEBUILDER_H
17#define LLVM_TRANSFORMS_UTILS_ASSUMEBUNDLEBUILDER_H
18
20#include "llvm/IR/PassManager.h"
22
23namespace llvm {
24class AssumeInst;
25class Function;
26class Instruction;
27class AssumptionCache;
28class DominatorTree;
29
30extern cl::opt<bool> EnableKnowledgeRetention;
31
32/// Build a call to llvm.assume to preserve informations that can be derived
33/// from the given instruction.
34/// If no information derived from \p I, this call returns null.
35/// The returned instruction is not inserted anywhere.
36AssumeInst *buildAssumeFromInst(Instruction *I);
37
38/// Calls BuildAssumeFromInst and if the resulting llvm.assume is valid insert
39/// if before I. This is usually what need to be done to salvage the knowledge
40/// contained in the instruction I.
41/// The AssumptionCache must be provided if it is available or the cache may
42/// become silently be invalid.
43/// The DominatorTree can optionally be provided to enable cross-block
44/// reasoning.
45/// This returns if a change was made.
46bool salvageKnowledge(Instruction *I, AssumptionCache *AC = nullptr,
47 DominatorTree *DT = nullptr);
48
49/// Build and return a new assume created from the provided knowledge
50/// if the knowledge in the assume is fully redundant this will return nullptr
51AssumeInst *buildAssumeFromKnowledge(ArrayRef<RetainedKnowledge> Knowledge,
52 Instruction *CtxI,
53 AssumptionCache *AC = nullptr,
54 DominatorTree *DT = nullptr);
55
56/// This pass attempts to minimize the number of assume without loosing any
57/// information.
58struct AssumeSimplifyPass : public PassInfoMixin<AssumeSimplifyPass> {
60};
61
62/// This pass will try to build an llvm.assume for every instruction in the
63/// function. Its main purpose is testing.
64struct AssumeBuilderPass : public PassInfoMixin<AssumeBuilderPass> {
66};
67
68/// canonicalize the RetainedKnowledge RK. it is assumed that RK is part of
69/// Assume. This will return an empty RetainedKnowledge if the knowledge is
70/// useless.
74 DominatorTree *DT);
75
76} // namespace llvm
77
78#endif
#define F(x, y, z)
Definition: MD5.cpp:55
#define I(x, y, z)
Definition: MD5.cpp:58
This header defines various interfaces for pass management in LLVM.
A container for analyses that lazily runs them and caches their results.
Definition: PassManager.h:253
This represents the llvm.assume intrinsic.
A cache of @llvm.assume calls within a function.
Concrete subclass of DominatorTreeBase that is used to compute a normal dominator tree.
Definition: Dominators.h:162
A set of analyses that are preserved following a run of a transformation pass.
Definition: Analysis.h:111
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
cl::opt< bool > EnableKnowledgeRetention
RetainedKnowledge simplifyRetainedKnowledge(AssumeInst *Assume, RetainedKnowledge RK, AssumptionCache *AC, DominatorTree *DT)
canonicalize the RetainedKnowledge RK.
AssumeInst * buildAssumeFromKnowledge(ArrayRef< RetainedKnowledge > Knowledge, Instruction *CtxI, AssumptionCache *AC=nullptr, DominatorTree *DT=nullptr)
Build and return a new assume created from the provided knowledge if the knowledge in the assume is f...
bool salvageKnowledge(Instruction *I, AssumptionCache *AC=nullptr, DominatorTree *DT=nullptr)
Calls BuildAssumeFromInst and if the resulting llvm.assume is valid insert if before I.
AssumeInst * buildAssumeFromInst(Instruction *I)
Build a call to llvm.assume to preserve informations that can be derived from the given instruction.
This pass will try to build an llvm.assume for every instruction in the function.
PreservedAnalyses run(Function &F, FunctionAnalysisManager &AM)
This pass attempts to minimize the number of assume without loosing any information.
PreservedAnalyses run(Function &F, FunctionAnalysisManager &AM)
A CRTP mix-in to automatically provide informational APIs needed for passes.
Definition: PassManager.h:69
Represent one information held inside an operand bundle of an llvm.assume.