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

76 lines
2.8 KiB
C++

//===-- Utils.h - MLIR XeVM target utils ------------------------*- C++ -*-===//
//
// This file is licensed 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 XeVM target related utility classes and functions.
//
//===----------------------------------------------------------------------===//
#ifndef MLIR_TARGET_LLVM_XEVM_UTILS_H
#define MLIR_TARGET_LLVM_XEVM_UTILS_H
#include "mlir/Dialect/GPU/IR/CompilationInterfaces.h"
#include "mlir/Dialect/GPU/IR/GPUDialect.h"
#include "mlir/Dialect/LLVMIR/XeVMDialect.h"
#include "mlir/IR/Attributes.h"
#include "mlir/Target/LLVM/ModuleToObject.h"
namespace mlir {
namespace xevm {
/// Base class for all XeVM serializations from GPU modules into binary strings.
/// By default this class serializes into LLVM bitcode.
class SerializeGPUModuleBase : public LLVM::ModuleToObject {
public:
SerializeGPUModuleBase(Operation &module, XeVMTargetAttr target,
const gpu::TargetOptions &targetOptions = {});
/// Returns the target attribute.
XeVMTargetAttr getTarget() const;
/// Loads the bitcode files in `librariesToLink`.
std::optional<SmallVector<std::unique_ptr<llvm::Module>>>
loadBitcodeFiles(llvm::Module &module) override;
/// Returns the gpu module being serialized.
gpu::GPUModuleOp getGPUModuleOp();
/// Compiles to native code using `ocloc` (API or tool).
FailureOr<SmallVector<char, 0>> compileToBinary(StringRef asmStr,
StringRef inputFormat);
protected:
/// XeVM Target attribute.
XeVMTargetAttr xeTarget;
/// 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;
/// Returns the path to the tool used for serialization.
std::optional<std::string> findTool(StringRef tool);
/// Compiles to native code using the `ocloc` command-line tool, communicating
/// through temporary files.
FailureOr<SmallVector<char, 0>>
compileToBinaryViaOclocTool(StringRef asmStr, StringRef inputFormat);
/// Compiles to native code using the `ocloc` shared library API, in-process,
/// without temporary files. Only available when the library is linked in.
#if MLIR_XEVM_OCLOC_LIB_AVAILABLE
FailureOr<SmallVector<char, 0>>
compileToBinaryViaLibocloc(StringRef asmStr, StringRef inputFormat);
#endif // MLIR_XEVM_OCLOC_LIB_AVAILABLE
/// GPU compilation target options.
gpu::TargetOptions targetOptions;
};
} // namespace xevm
} // namespace mlir
#endif // MLIR_TARGET_LLVM_XEVM_UTILS_H