blob: bbf49843673be970c59cb4247a62d0b9daf6b0ca [file] [log] [blame]
//===- GenericUniformityInfo.h ---------------------------*- C++ -*--------===//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
#include "llvm/ADT/GenericCycleInfo.h"
#include "llvm/Support/raw_ostream.h"
namespace llvm {
class TargetTransformInfo;
template <typename ContextT> class GenericUniformityAnalysisImpl;
template <typename ImplT> struct GenericUniformityAnalysisImplDeleter {
// Ugly hack around the fact that recent (> 15.0) clang will run into an
// is_invocable() check in some GNU libc++'s unique_ptr implementation
// and reject this deleter if you just make it callable with an ImplT *,
// whether or not the type of ImplT is spelled out.
using pointer = ImplT *;
void operator()(ImplT *Impl);
template <typename ContextT> class GenericUniformityInfo {
using BlockT = typename ContextT::BlockT;
using FunctionT = typename ContextT::FunctionT;
using ValueRefT = typename ContextT::ValueRefT;
using ConstValueRefT = typename ContextT::ConstValueRefT;
using UseT = typename ContextT::UseT;
using InstructionT = typename ContextT::InstructionT;
using DominatorTreeT = typename ContextT::DominatorTreeT;
using ThisT = GenericUniformityInfo<ContextT>;
using CycleInfoT = GenericCycleInfo<ContextT>;
using CycleT = typename CycleInfoT::CycleT;
GenericUniformityInfo(FunctionT &F, const DominatorTreeT &DT,
const CycleInfoT &CI,
const TargetTransformInfo *TTI = nullptr);
GenericUniformityInfo() = default;
GenericUniformityInfo(GenericUniformityInfo &&) = default;
GenericUniformityInfo &operator=(GenericUniformityInfo &&) = default;
/// Whether any divergence was detected.
bool hasDivergence() const;
/// The GPU kernel this analysis result is for
const FunctionT &getFunction() const { return *F; }
/// Whether \p V is divergent at its definition.
bool isDivergent(ConstValueRefT V) const;
/// Whether \p V is uniform/non-divergent.
bool isUniform(ConstValueRefT V) const { return !isDivergent(V); }
// Similar queries for InstructionT. These accept a pointer argument so that
// in LLVM IR, they overload the equivalent queries for Value*. For example,
// if querying whether a BranchInst is divergent, it should not be treated as
// a Value in LLVM IR.
bool isUniform(const InstructionT *I) const { return !isDivergent(I); };
bool isDivergent(const InstructionT *I) const;
/// \brief Whether \p U is divergent. Uses of a uniform value can be
/// divergent.
bool isDivergentUse(const UseT &U) const;
bool hasDivergentTerminator(const BlockT &B);
void print(raw_ostream &Out) const;
using ImplT = GenericUniformityAnalysisImpl<ContextT>;
FunctionT *F;
std::unique_ptr<ImplT, GenericUniformityAnalysisImplDeleter<ImplT>> DA;
GenericUniformityInfo(const GenericUniformityInfo &) = delete;
GenericUniformityInfo &operator=(const GenericUniformityInfo &) = delete;
} // namespace llvm