forked from OSchip/llvm-project
445 lines
16 KiB
C++
445 lines
16 KiB
C++
//===- OMPContext.cpp ------ Collection of helpers for OpenMP contexts ----===//
|
|
//
|
|
// 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
/// \file
|
|
///
|
|
/// This file implements helper functions and classes to deal with OpenMP
|
|
/// contexts as used by `[begin/end] declare variant` and `metadirective`.
|
|
///
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "llvm/Frontend/OpenMP/OMPContext.h"
|
|
#include "llvm/ADT/SetOperations.h"
|
|
#include "llvm/ADT/StringSwitch.h"
|
|
#include "llvm/Support/Debug.h"
|
|
#include "llvm/Support/raw_ostream.h"
|
|
|
|
#define DEBUG_TYPE "openmp-ir-builder"
|
|
|
|
using namespace llvm;
|
|
using namespace omp;
|
|
|
|
OMPContext::OMPContext(bool IsDeviceCompilation, Triple TargetTriple) {
|
|
// Add the appropriate device kind trait based on the triple and the
|
|
// IsDeviceCompilation flag.
|
|
ActiveTraits.insert(IsDeviceCompilation ? TraitProperty::device_kind_nohost
|
|
: TraitProperty::device_kind_host);
|
|
switch (TargetTriple.getArch()) {
|
|
case Triple::arm:
|
|
case Triple::armeb:
|
|
case Triple::aarch64:
|
|
case Triple::aarch64_be:
|
|
case Triple::aarch64_32:
|
|
case Triple::mips:
|
|
case Triple::mipsel:
|
|
case Triple::mips64:
|
|
case Triple::mips64el:
|
|
case Triple::ppc:
|
|
case Triple::ppc64:
|
|
case Triple::ppc64le:
|
|
case Triple::x86:
|
|
case Triple::x86_64:
|
|
ActiveTraits.insert(TraitProperty::device_kind_cpu);
|
|
break;
|
|
case Triple::amdgcn:
|
|
case Triple::nvptx:
|
|
case Triple::nvptx64:
|
|
ActiveTraits.insert(TraitProperty::device_kind_gpu);
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
|
|
// Add the appropriate device architecture trait based on the triple.
|
|
#define OMP_TRAIT_PROPERTY(Enum, TraitSetEnum, TraitSelectorEnum, Str) \
|
|
if (TraitSelector::TraitSelectorEnum == TraitSelector::device_arch) \
|
|
if (TargetTriple.getArch() == TargetTriple.getArchTypeForLLVMName(Str)) \
|
|
ActiveTraits.insert(TraitProperty::Enum);
|
|
#include "llvm/Frontend/OpenMP/OMPKinds.def"
|
|
|
|
// TODO: What exactly do we want to see as device ISA trait?
|
|
// The discussion on the list did not seem to have come to an agreed
|
|
// upon solution.
|
|
|
|
// LLVM is the "OpenMP vendor" but we could also interpret vendor as the
|
|
// target vendor.
|
|
ActiveTraits.insert(TraitProperty::implementation_vendor_llvm);
|
|
|
|
// The user condition true is accepted but not false.
|
|
ActiveTraits.insert(TraitProperty::user_condition_true);
|
|
|
|
// This is for sure some device.
|
|
ActiveTraits.insert(TraitProperty::device_kind_any);
|
|
|
|
LLVM_DEBUG({
|
|
dbgs() << "[" << DEBUG_TYPE
|
|
<< "] New OpenMP context with the following properties:\n";
|
|
for (auto &Property : ActiveTraits)
|
|
dbgs() << "\t " << getOpenMPContextTraitPropertyFullName(Property)
|
|
<< "\n";
|
|
});
|
|
}
|
|
|
|
/// Return true if \p C0 is a subset of \p C1. Note that both arrays are
|
|
/// expected to be sorted.
|
|
template <typename T> static bool isSubset(ArrayRef<T> C0, ArrayRef<T> C1) {
|
|
#ifdef EXPENSIVE_CHECKS
|
|
assert(std::is_sorted(C0.begin(), C0.end()) &&
|
|
std::is_sorted(C1.begin(), C1.end()) && "Expected sorted arrays!");
|
|
#endif
|
|
if (C0.size() > C1.size())
|
|
return false;
|
|
auto It0 = C0.begin(), End0 = C0.end();
|
|
auto It1 = C1.begin(), End1 = C1.end();
|
|
while (It0 != End0) {
|
|
if (It1 == End1)
|
|
return false;
|
|
if (*It0 == *It1) {
|
|
++It0;
|
|
++It1;
|
|
continue;
|
|
}
|
|
++It0;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/// Return true if \p C0 is a strict subset of \p C1. Note that both arrays are
|
|
/// expected to be sorted.
|
|
template <typename T>
|
|
static bool isStrictSubset(ArrayRef<T> C0, ArrayRef<T> C1) {
|
|
if (C0.size() >= C1.size())
|
|
return false;
|
|
return isSubset<T>(C0, C1);
|
|
}
|
|
|
|
static bool isStrictSubset(const VariantMatchInfo &VMI0,
|
|
const VariantMatchInfo &VMI1) {
|
|
// If all required traits are a strict subset and the ordered vectors storing
|
|
// the construct traits, we say it is a strict subset. Note that the latter
|
|
// relation is not required to be strict.
|
|
return set_is_strict_subset(VMI0.RequiredTraits, VMI1.RequiredTraits) &&
|
|
isSubset<TraitProperty>(VMI0.ConstructTraits, VMI1.ConstructTraits);
|
|
}
|
|
|
|
static int isVariantApplicableInContextHelper(
|
|
const VariantMatchInfo &VMI, const OMPContext &Ctx,
|
|
SmallVectorImpl<unsigned> *ConstructMatches) {
|
|
|
|
for (TraitProperty Property : VMI.RequiredTraits) {
|
|
|
|
bool IsActiveTrait = Ctx.ActiveTraits.count(Property);
|
|
if (!IsActiveTrait) {
|
|
LLVM_DEBUG(dbgs() << "[" << DEBUG_TYPE << "] Property "
|
|
<< getOpenMPContextTraitPropertyName(Property)
|
|
<< " was not in the OpenMP context.\n");
|
|
return false;
|
|
}
|
|
}
|
|
|
|
// We could use isSubset here but we also want to record the match locations.
|
|
unsigned ConstructIdx = 0, NoConstructTraits = Ctx.ConstructTraits.size();
|
|
for (TraitProperty Property : VMI.ConstructTraits) {
|
|
assert(getOpenMPContextTraitSetForProperty(Property) ==
|
|
TraitSet::construct &&
|
|
"Variant context is ill-formed!");
|
|
|
|
// Verify the nesting.
|
|
bool FoundInOrder = false;
|
|
while (!FoundInOrder && ConstructIdx != NoConstructTraits)
|
|
FoundInOrder = (Ctx.ConstructTraits[ConstructIdx++] == Property);
|
|
if (ConstructMatches)
|
|
ConstructMatches->push_back(ConstructIdx - 1);
|
|
|
|
if (!FoundInOrder) {
|
|
LLVM_DEBUG(dbgs() << "[" << DEBUG_TYPE << "] Construct property "
|
|
<< getOpenMPContextTraitPropertyName(Property)
|
|
<< " was not nested properly.\n");
|
|
return false;
|
|
}
|
|
|
|
// TODO: Verify SIMD
|
|
}
|
|
|
|
assert(isSubset<TraitProperty>(VMI.ConstructTraits, Ctx.ConstructTraits) &&
|
|
"Broken invariant!");
|
|
return true;
|
|
}
|
|
|
|
bool llvm::omp::isVariantApplicableInContext(const VariantMatchInfo &VMI,
|
|
const OMPContext &Ctx) {
|
|
return isVariantApplicableInContextHelper(VMI, Ctx, nullptr);
|
|
}
|
|
|
|
static APInt getVariantMatchScore(const VariantMatchInfo &VMI,
|
|
const OMPContext &Ctx,
|
|
SmallVectorImpl<unsigned> &ConstructMatches) {
|
|
APInt Score(64, 1);
|
|
|
|
unsigned NoConstructTraits = VMI.ConstructTraits.size();
|
|
for (TraitProperty Property : VMI.RequiredTraits) {
|
|
// If there is a user score attached, use it.
|
|
if (VMI.ScoreMap.count(Property)) {
|
|
const APInt &UserScore = VMI.ScoreMap.lookup(Property);
|
|
assert(UserScore.uge(0) && "Expect non-negative user scores!");
|
|
Score += UserScore.getZExtValue();
|
|
continue;
|
|
}
|
|
|
|
switch (getOpenMPContextTraitSetForProperty(Property)) {
|
|
case TraitSet::construct:
|
|
// We handle the construct traits later via the VMI.ConstructTraits
|
|
// container.
|
|
continue;
|
|
case TraitSet::implementation:
|
|
// No effect on the score (implementation defined).
|
|
continue;
|
|
case TraitSet::user:
|
|
// No effect on the score.
|
|
continue;
|
|
case TraitSet::device:
|
|
// Handled separately below.
|
|
break;
|
|
case TraitSet::invalid:
|
|
llvm_unreachable("Unknown trait set is not to be used!");
|
|
}
|
|
|
|
// device={kind(any)} is "as if" no kind selector was specified.
|
|
if (Property == TraitProperty::device_kind_any)
|
|
continue;
|
|
|
|
switch (getOpenMPContextTraitSelectorForProperty(Property)) {
|
|
case TraitSelector::device_kind:
|
|
Score += (1ULL << (NoConstructTraits + 0));
|
|
continue;
|
|
case TraitSelector::device_arch:
|
|
Score += (1ULL << (NoConstructTraits + 1));
|
|
continue;
|
|
case TraitSelector::device_isa:
|
|
Score += (1ULL << (NoConstructTraits + 2));
|
|
continue;
|
|
default:
|
|
continue;
|
|
}
|
|
}
|
|
|
|
unsigned ConstructIdx = 0;
|
|
assert(NoConstructTraits == ConstructMatches.size() &&
|
|
"Mismatch in the construct traits!");
|
|
for (TraitProperty Property : VMI.ConstructTraits) {
|
|
assert(getOpenMPContextTraitSetForProperty(Property) ==
|
|
TraitSet::construct &&
|
|
"Ill-formed variant match info!");
|
|
(void)Property;
|
|
// ConstructMatches is the position p - 1 and we need 2^(p-1).
|
|
Score += (1ULL << ConstructMatches[ConstructIdx++]);
|
|
}
|
|
|
|
LLVM_DEBUG(dbgs() << "[" << DEBUG_TYPE << "] Variant has a score of " << Score
|
|
<< "\n");
|
|
return Score;
|
|
}
|
|
|
|
int llvm::omp::getBestVariantMatchForContext(
|
|
const SmallVectorImpl<VariantMatchInfo> &VMIs, const OMPContext &Ctx) {
|
|
|
|
APInt BestScore(64, 0);
|
|
int BestVMIIdx = -1;
|
|
const VariantMatchInfo *BestVMI = nullptr;
|
|
|
|
for (unsigned u = 0, e = VMIs.size(); u < e; ++u) {
|
|
const VariantMatchInfo &VMI = VMIs[u];
|
|
|
|
SmallVector<unsigned, 8> ConstructMatches;
|
|
// If the variant is not applicable its not the best.
|
|
if (!isVariantApplicableInContextHelper(VMI, Ctx, &ConstructMatches))
|
|
continue;
|
|
// Check if its clearly not the best.
|
|
APInt Score = getVariantMatchScore(VMI, Ctx, ConstructMatches);
|
|
if (Score.ult(BestScore))
|
|
continue;
|
|
// Equal score need subset checks.
|
|
if (Score.eq(BestScore)) {
|
|
// Strict subset are never best.
|
|
if (isStrictSubset(VMI, *BestVMI))
|
|
continue;
|
|
// Same score and the current best is no strict subset so we keep it.
|
|
if (!isStrictSubset(*BestVMI, VMI))
|
|
continue;
|
|
}
|
|
// New best found.
|
|
BestVMI = &VMI;
|
|
BestVMIIdx = u;
|
|
BestScore = Score;
|
|
}
|
|
|
|
return BestVMIIdx;
|
|
}
|
|
|
|
TraitSet llvm::omp::getOpenMPContextTraitSetKind(StringRef S) {
|
|
return StringSwitch<TraitSet>(S)
|
|
#define OMP_TRAIT_SET(Enum, Str) .Case(Str, TraitSet::Enum)
|
|
#include "llvm/Frontend/OpenMP/OMPKinds.def"
|
|
.Default(TraitSet::invalid);
|
|
}
|
|
|
|
TraitSet
|
|
llvm::omp::getOpenMPContextTraitSetForSelector(TraitSelector Selector) {
|
|
switch (Selector) {
|
|
#define OMP_TRAIT_SELECTOR(Enum, TraitSetEnum, Str, ReqProp) \
|
|
case TraitSelector::Enum: \
|
|
return TraitSet::TraitSetEnum;
|
|
#include "llvm/Frontend/OpenMP/OMPKinds.def"
|
|
}
|
|
llvm_unreachable("Unknown trait selector!");
|
|
}
|
|
TraitSet
|
|
llvm::omp::getOpenMPContextTraitSetForProperty(TraitProperty Property) {
|
|
switch (Property) {
|
|
#define OMP_TRAIT_PROPERTY(Enum, TraitSetEnum, TraitSelectorEnum, Str) \
|
|
case TraitProperty::Enum: \
|
|
return TraitSet::TraitSetEnum;
|
|
#include "llvm/Frontend/OpenMP/OMPKinds.def"
|
|
}
|
|
llvm_unreachable("Unknown trait set!");
|
|
}
|
|
StringRef llvm::omp::getOpenMPContextTraitSetName(TraitSet Kind) {
|
|
switch (Kind) {
|
|
#define OMP_TRAIT_SET(Enum, Str) \
|
|
case TraitSet::Enum: \
|
|
return Str;
|
|
#include "llvm/Frontend/OpenMP/OMPKinds.def"
|
|
}
|
|
llvm_unreachable("Unknown trait set!");
|
|
}
|
|
|
|
TraitSelector llvm::omp::getOpenMPContextTraitSelectorKind(StringRef S) {
|
|
return StringSwitch<TraitSelector>(S)
|
|
#define OMP_TRAIT_SELECTOR(Enum, TraitSetEnum, Str, ReqProp) \
|
|
.Case(Str, TraitSelector::Enum)
|
|
#include "llvm/Frontend/OpenMP/OMPKinds.def"
|
|
.Default(TraitSelector::invalid);
|
|
}
|
|
TraitSelector
|
|
llvm::omp::getOpenMPContextTraitSelectorForProperty(TraitProperty Property) {
|
|
switch (Property) {
|
|
#define OMP_TRAIT_PROPERTY(Enum, TraitSetEnum, TraitSelectorEnum, Str) \
|
|
case TraitProperty::Enum: \
|
|
return TraitSelector::TraitSelectorEnum;
|
|
#include "llvm/Frontend/OpenMP/OMPKinds.def"
|
|
}
|
|
llvm_unreachable("Unknown trait set!");
|
|
}
|
|
StringRef llvm::omp::getOpenMPContextTraitSelectorName(TraitSelector Kind) {
|
|
switch (Kind) {
|
|
#define OMP_TRAIT_SELECTOR(Enum, TraitSetEnum, Str, ReqProp) \
|
|
case TraitSelector::Enum: \
|
|
return Str;
|
|
#include "llvm/Frontend/OpenMP/OMPKinds.def"
|
|
}
|
|
llvm_unreachable("Unknown trait selector!");
|
|
}
|
|
|
|
TraitProperty llvm::omp::getOpenMPContextTraitPropertyKind(TraitSet Set,
|
|
StringRef S) {
|
|
#define OMP_TRAIT_PROPERTY(Enum, TraitSetEnum, TraitSelectorEnum, Str) \
|
|
if (Set == TraitSet::TraitSetEnum && Str == S) \
|
|
return TraitProperty::Enum;
|
|
#include "llvm/Frontend/OpenMP/OMPKinds.def"
|
|
return TraitProperty::invalid;
|
|
}
|
|
TraitProperty
|
|
llvm::omp::getOpenMPContextTraitPropertyForSelector(TraitSelector Selector) {
|
|
return StringSwitch<TraitProperty>(
|
|
getOpenMPContextTraitSelectorName(Selector))
|
|
#define OMP_TRAIT_PROPERTY(Enum, TraitSetEnum, TraitSelectorEnum, Str) \
|
|
.Case(Str, Selector == TraitSelector::TraitSelectorEnum \
|
|
? TraitProperty::Enum \
|
|
: TraitProperty::invalid)
|
|
#include "llvm/Frontend/OpenMP/OMPKinds.def"
|
|
.Default(TraitProperty::invalid);
|
|
}
|
|
StringRef llvm::omp::getOpenMPContextTraitPropertyName(TraitProperty Kind) {
|
|
switch (Kind) {
|
|
#define OMP_TRAIT_PROPERTY(Enum, TraitSetEnum, TraitSelectorEnum, Str) \
|
|
case TraitProperty::Enum: \
|
|
return Str;
|
|
#include "llvm/Frontend/OpenMP/OMPKinds.def"
|
|
}
|
|
llvm_unreachable("Unknown trait property!");
|
|
}
|
|
StringRef llvm::omp::getOpenMPContextTraitPropertyFullName(TraitProperty Kind) {
|
|
switch (Kind) {
|
|
#define OMP_TRAIT_PROPERTY(Enum, TraitSetEnum, TraitSelectorEnum, Str) \
|
|
case TraitProperty::Enum: \
|
|
return "(" #TraitSetEnum "," #TraitSelectorEnum "," Str ")";
|
|
#include "llvm/Frontend/OpenMP/OMPKinds.def"
|
|
}
|
|
llvm_unreachable("Unknown trait property!");
|
|
}
|
|
|
|
bool llvm::omp::isValidTraitSelectorForTraitSet(TraitSelector Selector,
|
|
TraitSet Set,
|
|
bool &AllowsTraitScore,
|
|
bool &RequiresProperty) {
|
|
AllowsTraitScore = Set != TraitSet::construct && Set != TraitSet::device;
|
|
switch (Selector) {
|
|
#define OMP_TRAIT_SELECTOR(Enum, TraitSetEnum, Str, ReqProp) \
|
|
case TraitSelector::Enum: \
|
|
RequiresProperty = ReqProp; \
|
|
return Set == TraitSet::TraitSetEnum;
|
|
#include "llvm/Frontend/OpenMP/OMPKinds.def"
|
|
}
|
|
llvm_unreachable("Unknown trait selector!");
|
|
}
|
|
|
|
bool llvm::omp::isValidTraitPropertyForTraitSetAndSelector(
|
|
TraitProperty Property, TraitSelector Selector, TraitSet Set) {
|
|
switch (Property) {
|
|
#define OMP_TRAIT_PROPERTY(Enum, TraitSetEnum, TraitSelectorEnum, Str) \
|
|
case TraitProperty::Enum: \
|
|
return Set == TraitSet::TraitSetEnum && \
|
|
Selector == TraitSelector::TraitSelectorEnum;
|
|
#include "llvm/Frontend/OpenMP/OMPKinds.def"
|
|
}
|
|
llvm_unreachable("Unknown trait property!");
|
|
}
|
|
|
|
std::string llvm::omp::listOpenMPContextTraitSets() {
|
|
std::string S;
|
|
#define OMP_TRAIT_SET(Enum, Str) \
|
|
if (!StringRef(Str).equals("invalid")) \
|
|
S.append("'").append(Str).append("'").append(" ");
|
|
#include "llvm/Frontend/OpenMP/OMPKinds.def"
|
|
S.pop_back();
|
|
return S;
|
|
}
|
|
|
|
std::string llvm::omp::listOpenMPContextTraitSelectors(TraitSet Set) {
|
|
std::string S;
|
|
#define OMP_TRAIT_SELECTOR(Enum, TraitSetEnum, Str, ReqProp) \
|
|
if (TraitSet::TraitSetEnum == Set && !StringRef(Str).equals("invalid")) \
|
|
S.append("'").append(Str).append("'").append(" ");
|
|
#include "llvm/Frontend/OpenMP/OMPKinds.def"
|
|
S.pop_back();
|
|
return S;
|
|
}
|
|
|
|
std::string
|
|
llvm::omp::listOpenMPContextTraitProperties(TraitSet Set,
|
|
TraitSelector Selector) {
|
|
std::string S;
|
|
#define OMP_TRAIT_PROPERTY(Enum, TraitSetEnum, TraitSelectorEnum, Str) \
|
|
if (TraitSet::TraitSetEnum == Set && \
|
|
TraitSelector::TraitSelectorEnum == Selector && \
|
|
!StringRef(Str).equals("invalid")) \
|
|
S.append("'").append(Str).append("'").append(" ");
|
|
#include "llvm/Frontend/OpenMP/OMPKinds.def"
|
|
S.pop_back();
|
|
return S;
|
|
}
|