mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2024-11-26 04:32:44 +01:00
6230d2a2a4
The `assume` attribute is a way to provide additional, arbitrary information to the optimizer. For now, assumptions are restricted to strings which will be accumulated for a function and emitted as comma separated string function attribute. The key of the LLVM-IR function attribute is `llvm.assume`. Similar to `llvm.assume` and `__builtin_assume`, the `assume` attribute provides a user defined assumption to the compiler. A follow up patch will introduce an LLVM-core API to query the assumptions attached to a function. We also expect to add more options, e.g., expression arguments, to the `assume` attribute later on. The `omp [begin] asssumes` pragma will leverage this attribute and expose the functionality in the absence of OpenMP. Reviewed By: aaron.ballman Differential Revision: https://reviews.llvm.org/D91979
51 lines
1.6 KiB
C++
51 lines
1.6 KiB
C++
//===--- Assumptions.h - Assumption handling and organization ---*- C++ -*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// String assumptions that are known to optimization passes should be placed in
|
|
// the KnownAssumptionStrings set. This can be done in various ways, i.a.,
|
|
// via a static KnownAssumptionString object.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_IR_ASSUMPTIONS_H
|
|
#define LLVM_IR_ASSUMPTIONS_H
|
|
|
|
#include "llvm/ADT/StringRef.h"
|
|
#include "llvm/ADT/StringSet.h"
|
|
|
|
namespace llvm {
|
|
|
|
class Function;
|
|
|
|
/// The key we use for assumption attributes.
|
|
constexpr StringRef AssumptionAttrKey = "llvm.assume";
|
|
|
|
/// A set of known assumption strings that are accepted without warning and
|
|
/// which can be recommended as typo correction.
|
|
extern StringSet<> KnownAssumptionStrings;
|
|
|
|
/// Helper that allows to insert a new assumption string in the known assumption
|
|
/// set by creating a (static) object.
|
|
struct KnownAssumptionString {
|
|
KnownAssumptionString(StringRef AssumptionStr)
|
|
: AssumptionStr(AssumptionStr) {
|
|
KnownAssumptionStrings.insert(AssumptionStr);
|
|
}
|
|
operator StringRef() const { return AssumptionStr; }
|
|
|
|
private:
|
|
StringRef AssumptionStr;
|
|
};
|
|
|
|
/// Return true if \p F has the assumption \p AssumptionStr attached.
|
|
bool hasAssumption(Function &F, const KnownAssumptionString &AssumptionStr);
|
|
|
|
} // namespace llvm
|
|
|
|
#endif
|