clang 24.0.0git
LowerToLLVMOpenCLMetadata.cpp
Go to the documentation of this file.
1//===- LowerToLLVMOpenCLMetadata.cpp - OpenCL metadata lowering -----------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
10#include "LowerToLLVMMetadata.h"
11
12#include "mlir/Dialect/LLVMIR/LLVMAttrs.h"
13#include "mlir/Dialect/LLVMIR/LLVMModuleOps.h"
14#include "mlir/IR/Builders.h"
16#include "llvm/Support/ErrorHandling.h"
17
18namespace cir {
19namespace direct {
20
21namespace {
22using KernelArgStringMetadataGetter =
23 mlir::ArrayAttr (cir::OpenCLKernelArgMetadataAttr::*)() const;
24
25struct KernelArgStringMetadataMapping {
26 llvm::StringLiteral metadataName;
27 KernelArgStringMetadataGetter getMetadata;
28 bool optional;
29};
30
31static unsigned getOpenCLArgInfoAddressSpace(cir::LangAddressSpace as) {
32 switch (as) {
33 case cir::LangAddressSpace::Default:
34 case cir::LangAddressSpace::OffloadPrivate:
35 return 0;
36 case cir::LangAddressSpace::OffloadGlobal:
37 return 1;
38 case cir::LangAddressSpace::OffloadConstant:
39 return 2;
40 case cir::LangAddressSpace::OffloadLocal:
41 return 3;
42 case cir::LangAddressSpace::OffloadGeneric:
43 return 4;
44 case cir::LangAddressSpace::OffloadGlobalDevice:
45 return 5;
46 case cir::LangAddressSpace::OffloadGlobalHost:
47 return 6;
48 }
49 llvm_unreachable("unknown CIR language address space");
50}
51
52static mlir::LLVM::MDNodeAttr
53getAddrSpaceMetadataNode(cir::OpenCLKernelArgMetadataAttr clArgMetadata,
54 const LLVMMetadataNodeBuilder &metadataBuilder) {
55 llvm::SmallVector<unsigned> addrSpaces;
56 for (cir::LangAddressSpaceAttr addressSpace :
57 clArgMetadata.getAddrSpace().getAsRange<cir::LangAddressSpaceAttr>())
58 addrSpaces.push_back(getOpenCLArgInfoAddressSpace(addressSpace.getValue()));
59 return metadataBuilder.getI32Node(addrSpaces);
60}
61
62static void addOpenCLKernelArgFunctionMetadata(
63 mlir::MLIRContext *ctx, llvm::SmallVectorImpl<mlir::Attribute> &entries,
64 llvm::StringRef name, mlir::LLVM::MDNodeAttr node) {
65 entries.push_back(mlir::LLVM::FunctionMetadataAttr::get(
66 ctx, mlir::StringAttr::get(ctx, name), node));
67}
68
69} // namespace
70
72 cir::OpenCLKernelArgMetadataAttr clArgMetadata,
74 mlir::MLIRContext *ctx = clArgMetadata.getContext();
75 LLVMMetadataNodeBuilder metadataBuilder(ctx);
76
77 addOpenCLKernelArgFunctionMetadata(
78 ctx, entries, "kernel_arg_addr_space",
79 getAddrSpaceMetadataNode(clArgMetadata, metadataBuilder));
80
81 static constexpr KernelArgStringMetadataMapping stringMetadataMappings[] = {
82 {"kernel_arg_access_qual",
83 &cir::OpenCLKernelArgMetadataAttr::getAccessQual,
84 /*optional=*/false},
85 {"kernel_arg_type", &cir::OpenCLKernelArgMetadataAttr::getType,
86 /*optional=*/false},
87 {"kernel_arg_base_type", &cir::OpenCLKernelArgMetadataAttr::getBaseType,
88 /*optional=*/false},
89 {"kernel_arg_type_qual", &cir::OpenCLKernelArgMetadataAttr::getTypeQual,
90 /*optional=*/false},
91 {"kernel_arg_name", &cir::OpenCLKernelArgMetadataAttr::getName,
92 /*optional=*/true},
93 };
94
95 for (const KernelArgStringMetadataMapping &mapping : stringMetadataMappings) {
96 mlir::ArrayAttr metadata = (clArgMetadata.*mapping.getMetadata)();
97 if (mapping.optional && !metadata)
98 continue;
99 addOpenCLKernelArgFunctionMetadata(ctx, entries, mapping.metadataName,
100 metadataBuilder.getStringNode(metadata));
101 }
102}
103
104static void createOpenCLVersionNamedMetadata(mlir::ModuleOp module,
105 llvm::StringRef name,
106 mlir::LLVM::MDNodeAttr node) {
107 mlir::MLIRContext *ctx = module.getContext();
108 mlir::OpBuilder builder(ctx);
109 builder.setInsertionPointToEnd(module.getBody());
110 mlir::LLVM::NamedMetadataOp::create(builder, module.getLoc(), name,
111 mlir::ArrayAttr::get(ctx, node));
112}
113
114static void emitOpenCLVersionMetadata(mlir::ModuleOp module,
115 llvm::StringRef metadataName,
116 mlir::Attribute versionAttr) {
117 auto version = mlir::cast<cir::OpenCLVersionAttr>(versionAttr);
118 mlir::MLIRContext *ctx = module.getContext();
119 LLVMMetadataNodeBuilder metadataBuilder(ctx);
120
121 unsigned versionMetadata[] = {
122 static_cast<unsigned>(version.getMajorVersion()),
123 static_cast<unsigned>(version.getMinorVersion())};
124 createOpenCLVersionNamedMetadata(module, metadataName,
125 metadataBuilder.getI32Node(versionMetadata));
126}
127
128void lowerOpenCLModuleMetadataAttrs(mlir::ModuleOp module) {
129 struct OpenCLModuleMetadataMapping {
130 llvm::StringRef cirAttrName;
131 llvm::StringRef llvmMetadataName;
132 };
133
134 const OpenCLModuleMetadataMapping moduleMetadataMappings[] = {
135 {cir::CIRDialect::getOpenCLVersionAttrName(), "opencl.ocl.version"},
136 {cir::CIRDialect::getOpenCLCXXVersionAttrName(), "opencl.cxx.version"},
137 {cir::CIRDialect::getOpenCLSPIRVersionAttrName(), "opencl.spir.version"},
138 };
139
140 for (const OpenCLModuleMetadataMapping &mapping : moduleMetadataMappings) {
141 mlir::Attribute version = module->getAttr(mapping.cirAttrName);
142 if (!version)
143 continue;
144 emitOpenCLVersionMetadata(module, mapping.llvmMetadataName, version);
145 module->removeAttr(mapping.cirAttrName);
146 }
147}
148
149} // namespace direct
150} // namespace cir
mlir::LLVM::MDNodeAttr getI32Node(llvm::ArrayRef< unsigned > values) const
mlir::LLVM::MDNodeAttr getStringNode(mlir::ArrayAttr attrs) const
void lowerOpenCLKernelArgMetadata(cir::OpenCLKernelArgMetadataAttr clArgMetadata, llvm::SmallVectorImpl< mlir::Attribute > &entries)
static void createOpenCLVersionNamedMetadata(mlir::ModuleOp module, llvm::StringRef name, mlir::LLVM::MDNodeAttr node)
void lowerOpenCLModuleMetadataAttrs(mlir::ModuleOp module)
static void emitOpenCLVersionMetadata(mlir::ModuleOp module, llvm::StringRef metadataName, mlir::Attribute versionAttr)