Files
gps/tools/local/circt/include/mlir/Target/LLVM/NVVM/Utils.h
T
2026-07-12 11:01:51 +03:00

77 lines
2.7 KiB
C++

//===- Utils.h - MLIR NVVM target utils -------------------------*- 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
//
//===----------------------------------------------------------------------===//
//
// This files declares NVVM target related utility classes and functions.
//
//===----------------------------------------------------------------------===//
#ifndef MLIR_TARGET_LLVM_NVVM_UTILS_H
#define MLIR_TARGET_LLVM_NVVM_UTILS_H
#include "mlir/Dialect/GPU/IR/CompilationInterfaces.h"
#include "mlir/Dialect/LLVMIR/NVVMDialect.h"
#include "mlir/Target/LLVM/ModuleToObject.h"
namespace mlir {
namespace NVVM {
/// Searches & returns the path CUDA toolkit path, the search order is:
/// 1. The `CUDA_ROOT` environment variable.
/// 2. The `CUDA_HOME` environment variable.
/// 3. The `CUDA_PATH` environment variable.
/// 4. The CUDA toolkit path detected by CMake.
/// 5. Returns an empty string.
StringRef getCUDAToolkitPath();
/// Base class for all NVVM serializations from GPU modules into binary strings.
/// By default this class serializes into LLVM bitcode.
class SerializeGPUModuleBase : public LLVM::ModuleToObject {
public:
/// Initializes the `toolkitPath` with the path in `targetOptions` or if empty
/// with the path in `getCUDAToolkitPath`.
SerializeGPUModuleBase(Operation &module, NVVMTargetAttr target,
const gpu::TargetOptions &targetOptions = {});
/// Initializes the LLVM NVPTX target by safely calling `LLVMInitializeNVPTX*`
/// methods if available.
static void init();
/// Returns the target attribute.
NVVMTargetAttr getTarget() const;
/// Returns the CUDA toolkit path.
StringRef getToolkitPath() const;
/// Returns the bitcode libraries to be linked into the gpu module after
/// translation to LLVM IR.
ArrayRef<Attribute> getLibrariesToLink() const;
/// Appends `nvvm/libdevice.bc` into `librariesToLink`. Returns failure if the
/// library couldn't be found.
LogicalResult appendStandardLibs();
/// Loads the bitcode files in `librariesToLink`.
std::optional<SmallVector<std::unique_ptr<llvm::Module>>>
loadBitcodeFiles(llvm::Module &module) override;
protected:
/// NVVM target attribute.
NVVMTargetAttr target;
/// CUDA toolkit path.
std::string toolkitPath;
/// List of LLVM bitcode to link into after translation to LLVM IR.
/// The attributes can be StringAttr pointing to a file path, or
/// a Resource blob pointing to the LLVM bitcode in-memory.
SmallVector<Attribute> librariesToLink;
};
} // namespace NVVM
} // namespace mlir
#endif // MLIR_TARGET_LLVM_NVVM_UTILS_H