fd3907ccb5
Reland #118503. Added a fix for builds with `-DBUILD_SHARED_LIBS=ON` (see last commit). Otherwise the changes are identical. --- ### New API Previous discussions at the LLVM/Offload meeting have brought up the need for a new API for exposing the functionality of the plugins. This change introduces a very small subset of a new API, which is primarily for testing the offload tooling and demonstrating how a new API can fit into the existing code base without being too disruptive. Exact designs for these entry points and future additions can be worked out over time. The new API does however introduce the bare minimum functionality to implement device discovery for Unified Runtime and SYCL. This means that the `urinfo` and `sycl-ls` tools can be used on top of Offload. A (rough) implementation of a Unified Runtime adapter (aka plugin) for Offload is available [here](https://github.com/callumfare/unified-runtime/tree/offload_adapter). Our intention is to maintain this and use it to implement and test Offload API changes with SYCL. ### Demoing the new API ```sh # From the runtime build directory $ ninja LibomptUnitTests $ OFFLOAD_TRACE=1 ./offload/unittests/OffloadAPI/offload.unittests ``` ### Open questions and future work * Only some of the available device info is exposed, and not all the possible device queries needed for SYCL are implemented by the plugins. A sensible next step would be to refactor and extend the existing device info queries in the plugins. The existing info queries are all strings, but the new API introduces the ability to return any arbitrary type. * It may be sensible at some point for the plugins to implement the new API directly, and the higher level code on top of it could be made generic, but this is more of a long-term possibility.
95 lines
2.8 KiB
C++
95 lines
2.8 KiB
C++
//===- offload_impl.hpp- Implementation helpers for the Offload library ---===//
|
|
//
|
|
// 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
#pragma once
|
|
|
|
#include <OffloadAPI.h>
|
|
#include <iostream>
|
|
#include <memory>
|
|
#include <optional>
|
|
#include <set>
|
|
#include <string>
|
|
#include <unordered_set>
|
|
#include <vector>
|
|
|
|
#include "llvm/ADT/DenseSet.h"
|
|
#include "llvm/ADT/StringRef.h"
|
|
#include "llvm/ADT/StringSet.h"
|
|
|
|
struct OffloadConfig {
|
|
bool TracingEnabled = false;
|
|
};
|
|
|
|
OffloadConfig &offloadConfig();
|
|
|
|
// Use the StringSet container to efficiently deduplicate repeated error
|
|
// strings (e.g. if the same error is hit constantly in a long running program)
|
|
llvm::StringSet<> &errorStrs();
|
|
|
|
// Use an unordered_set to avoid duplicates of error structs themselves.
|
|
// We cannot store the structs directly as returned pointers to them must always
|
|
// be valid, and a rehash of the set may invalidate them. This requires
|
|
// custom hash and equal_to function objects.
|
|
using ErrPtrT = std::unique_ptr<ol_error_struct_t>;
|
|
struct ErrPtrEqual {
|
|
bool operator()(const ErrPtrT &lhs, const ErrPtrT &rhs) const {
|
|
if (!lhs && !rhs) {
|
|
return true;
|
|
}
|
|
if (!lhs || !rhs) {
|
|
return false;
|
|
}
|
|
|
|
bool StrsEqual = false;
|
|
if (lhs->Details == NULL && rhs->Details == NULL) {
|
|
StrsEqual = true;
|
|
} else if (lhs->Details != NULL && rhs->Details != NULL) {
|
|
StrsEqual = (std::strcmp(lhs->Details, rhs->Details) == 0);
|
|
}
|
|
return (lhs->Code == rhs->Code) && StrsEqual;
|
|
}
|
|
};
|
|
struct ErrPtrHash {
|
|
size_t operator()(const ErrPtrT &e) const {
|
|
if (!e) {
|
|
// We shouldn't store empty errors (i.e. success), but just in case
|
|
return 0lu;
|
|
} else {
|
|
return std::hash<int>{}(e->Code);
|
|
}
|
|
}
|
|
};
|
|
using ErrSetT = std::unordered_set<ErrPtrT, ErrPtrHash, ErrPtrEqual>;
|
|
ErrSetT &errors();
|
|
|
|
struct ol_impl_result_t {
|
|
ol_impl_result_t(std::nullptr_t) : Result(OL_SUCCESS) {}
|
|
ol_impl_result_t(ol_errc_t Code) {
|
|
if (Code == OL_ERRC_SUCCESS) {
|
|
Result = nullptr;
|
|
} else {
|
|
auto Err = std::unique_ptr<ol_error_struct_t>(
|
|
new ol_error_struct_t{Code, nullptr});
|
|
Result = errors().emplace(std::move(Err)).first->get();
|
|
}
|
|
}
|
|
|
|
ol_impl_result_t(ol_errc_t Code, llvm::StringRef Details) {
|
|
assert(Code != OL_ERRC_SUCCESS);
|
|
Result = nullptr;
|
|
auto DetailsStr = errorStrs().insert(Details).first->getKeyData();
|
|
auto Err = std::unique_ptr<ol_error_struct_t>(
|
|
new ol_error_struct_t{Code, DetailsStr});
|
|
Result = errors().emplace(std::move(Err)).first->get();
|
|
}
|
|
|
|
operator ol_result_t() { return Result; }
|
|
|
|
private:
|
|
ol_result_t Result;
|
|
};
|