LLVM  14.0.0git
Assumptions.h
Go to the documentation of this file.
1 //===--- Assumptions.h - Assumption handling and organization ---*- 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 // String assumptions that are known to optimization passes should be placed in
10 // the KnownAssumptionStrings set. This can be done in various ways, i.a.,
11 // via a static KnownAssumptionString object.
12 //
13 //===----------------------------------------------------------------------===//
14 
15 #ifndef LLVM_IR_ASSUMPTIONS_H
16 #define LLVM_IR_ASSUMPTIONS_H
17 
18 #include "llvm/ADT/DenseSet.h"
19 #include "llvm/ADT/StringRef.h"
20 #include "llvm/ADT/StringSet.h"
21 
22 namespace llvm {
23 
24 class Function;
25 class CallBase;
26 
27 /// The key we use for assumption attributes.
28 constexpr StringRef AssumptionAttrKey = "llvm.assume";
29 
30 /// A set of known assumption strings that are accepted without warning and
31 /// which can be recommended as typo correction.
33 
34 /// Helper that allows to insert a new assumption string in the known assumption
35 /// set by creating a (static) object.
38  : AssumptionStr(AssumptionStr) {
39  KnownAssumptionStrings.insert(AssumptionStr);
40  }
41  operator StringRef() const { return AssumptionStr; }
42 
43 private:
44  StringRef AssumptionStr;
45 };
46 
47 /// Return true if \p F has the assumption \p AssumptionStr attached.
48 bool hasAssumption(const Function &F,
49  const KnownAssumptionString &AssumptionStr);
50 
51 /// Return true if \p CB or the callee has the assumption \p AssumptionStr
52 /// attached.
53 bool hasAssumption(const CallBase &CB,
54  const KnownAssumptionString &AssumptionStr);
55 
56 /// Return the set of all assumptions for the function \p F.
57 DenseSet<StringRef> getAssumptions(const Function &F);
58 
59 /// Return the set of all assumptions for the call \p CB.
60 DenseSet<StringRef> getAssumptions(const CallBase &CB);
61 
62 /// Appends the set of assumptions \p Assumptions to \F.
63 bool addAssumptions(Function &F, const DenseSet<StringRef> &Assumptions);
64 
65 /// Appends the set of assumptions \p Assumptions to \CB.
66 bool addAssumptions(CallBase &CB, const DenseSet<StringRef> &Assumptions);
67 
68 } // namespace llvm
69 
70 #endif
llvm
This is an optimization pass for GlobalISel generic memory operations.
Definition: AllocatorList.h:23
StringRef.h
llvm::getAssumptions
DenseSet< StringRef > getAssumptions(const Function &F)
Return the set of all assumptions for the function F.
Definition: Assumptions.cpp:86
llvm::StringSet::insert
std::pair< typename Base::iterator, bool > insert(StringRef key)
Definition: StringSet.h:33
F
#define F(x, y, z)
Definition: MD5.cpp:56
llvm::KnownAssumptionString::KnownAssumptionString
KnownAssumptionString(StringRef AssumptionStr)
Definition: Assumptions.h:37
llvm::KnownAssumptionStrings
StringSet KnownAssumptionStrings
A set of known assumption strings that are accepted without warning and which can be recommended as t...
llvm::hasAssumption
bool hasAssumption(const Function &F, const KnownAssumptionString &AssumptionStr)
Return true if F has the assumption AssumptionStr attached.
Definition: Assumptions.cpp:70
DenseSet.h
llvm::KnownAssumptionString
Helper that allows to insert a new assumption string in the known assumption set by creating a (stati...
Definition: Assumptions.h:36
llvm::AssumptionAttrKey
constexpr StringRef AssumptionAttrKey
The key we use for assumption attributes.
Definition: Assumptions.h:28
llvm::StringSet
StringSet - A wrapper for StringMap that provides set-like functionality.
Definition: StringSet.h:22
llvm::StringRef
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:57
StringSet.h
llvm::addAssumptions
bool addAssumptions(Function &F, const DenseSet< StringRef > &Assumptions)
Appends the set of assumptions Assumptions to \F.
Definition: Assumptions.cpp:96
llvm::codeview::PublicSymFlags::Function
@ Function