clang 19.0.0git
CGHLSLRuntime.h
Go to the documentation of this file.
1//===----- CGHLSLRuntime.h - Interface to HLSL Runtimes -----*- C++ -*-===//
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//
9// This provides an abstract class for HLSL code generation. Concrete
10// subclasses of this implement code generation for specific HLSL
11// runtime libraries.
12//
13//===----------------------------------------------------------------------===//
14
15#ifndef LLVM_CLANG_LIB_CODEGEN_CGHLSLRUNTIME_H
16#define LLVM_CLANG_LIB_CODEGEN_CGHLSLRUNTIME_H
17
18#include "llvm/IR/IRBuilder.h"
19#include "llvm/IR/Intrinsics.h"
20#include "llvm/IR/IntrinsicsDirectX.h"
21#include "llvm/IR/IntrinsicsSPIRV.h"
22
25
26#include "llvm/ADT/SmallVector.h"
27#include "llvm/ADT/StringRef.h"
28#include "llvm/Frontend/HLSL/HLSLResource.h"
29
30#include <optional>
31#include <vector>
32
33// A function generator macro for picking the right intrinsic
34// for the target backend
35#define GENERATE_HLSL_INTRINSIC_FUNCTION(FunctionName, IntrinsicPostfix) \
36 llvm::Intrinsic::ID get##FunctionName##Intrinsic() { \
37 llvm::Triple::ArchType Arch = getArch(); \
38 switch (Arch) { \
39 case llvm::Triple::dxil: \
40 return llvm::Intrinsic::dx_##IntrinsicPostfix; \
41 case llvm::Triple::spirv: \
42 return llvm::Intrinsic::spv_##IntrinsicPostfix; \
43 default: \
44 llvm_unreachable("Intrinsic " #IntrinsicPostfix \
45 " not supported by target architecture"); \
46 } \
47 }
48
49namespace llvm {
50class GlobalVariable;
51class Function;
52class StructType;
53} // namespace llvm
54
55namespace clang {
56class VarDecl;
57class ParmVarDecl;
58class HLSLBufferDecl;
59class HLSLResourceBindingAttr;
60class Type;
61class DeclContext;
62
63class FunctionDecl;
64
65namespace CodeGen {
66
67class CodeGenModule;
68
70public:
71 //===----------------------------------------------------------------------===//
72 // Start of reserved area for HLSL intrinsic getters.
73 //===----------------------------------------------------------------------===//
74
78 GENERATE_HLSL_INTRINSIC_FUNCTION(ThreadId, thread_id)
79
80 //===----------------------------------------------------------------------===//
81 // End of reserved area for HLSL intrinsic getters.
82 //===----------------------------------------------------------------------===//
83
85 // The ID like 2 in register(b2, space1).
86 std::optional<unsigned> Reg;
87 // The Space like 1 is register(b2, space1).
88 // Default value is 0.
89 unsigned Space;
90 BufferResBinding(HLSLResourceBindingAttr *Attr);
91 };
92 struct Buffer {
93 Buffer(const HLSLBufferDecl *D);
94 llvm::StringRef Name;
95 // IsCBuffer - Whether the buffer is a cbuffer (and not a tbuffer).
98 // Global variable and offset for each constant.
99 std::vector<std::pair<llvm::GlobalVariable *, unsigned>> Constants;
100 llvm::StructType *LayoutStruct = nullptr;
101 };
102
103protected:
105
106 llvm::Value *emitInputSemantic(llvm::IRBuilder<> &B, const ParmVarDecl &D,
107 llvm::Type *Ty);
108
109public:
111 virtual ~CGHLSLRuntime() {}
112
113 void annotateHLSLResource(const VarDecl *D, llvm::GlobalVariable *GV);
115
116 void addBuffer(const HLSLBufferDecl *D);
117 void finishCodeGen();
118
119 void setHLSLEntryAttributes(const FunctionDecl *FD, llvm::Function *Fn);
120
121 void emitEntryFunction(const FunctionDecl *FD, llvm::Function *Fn);
122 void setHLSLFunctionAttributes(llvm::Function *, const FunctionDecl *);
123
124private:
125 void addBufferResourceAnnotation(llvm::GlobalVariable *GV,
126 llvm::hlsl::ResourceClass RC,
127 llvm::hlsl::ResourceKind RK, bool IsROV,
128 llvm::hlsl::ElementType ET,
129 BufferResBinding &Binding);
130 void addConstant(VarDecl *D, Buffer &CB);
131 void addBufferDecls(const DeclContext *DC, Buffer &CB);
132 llvm::Triple::ArchType getArch();
134};
135
136} // namespace CodeGen
137} // namespace clang
138
139#endif
MatchType Type
Defines enum values for all the target-independent builtin functions.
#define GENERATE_HLSL_INTRINSIC_FUNCTION(FunctionName, IntrinsicPostfix)
Definition: CGHLSLRuntime.h:35
Defines helper utilities for supporting the HLSL runtime environment.
Attr - This represents one attribute.
Definition: Attr.h:42
void setHLSLEntryAttributes(const FunctionDecl *FD, llvm::Function *Fn)
void emitEntryFunction(const FunctionDecl *FD, llvm::Function *Fn)
llvm::Value * emitInputSemantic(llvm::IRBuilder<> &B, const ParmVarDecl &D, llvm::Type *Ty)
CGHLSLRuntime(CodeGenModule &CGM)
void annotateHLSLResource(const VarDecl *D, llvm::GlobalVariable *GV)
void addBuffer(const HLSLBufferDecl *D)
void setHLSLFunctionAttributes(llvm::Function *, const FunctionDecl *)
This class organizes the cross-function state that is used while generating LLVM code.
DeclContext - This is used only as base class of specific decl types that can act as declaration cont...
Definition: DeclBase.h:1436
Represents a function declaration or definition.
Definition: Decl.h:1971
HLSLBufferDecl - Represent a cbuffer or tbuffer declaration.
Definition: Decl.h:4940
Represents a parameter to a function.
Definition: Decl.h:1761
Represents a variable declaration or definition.
Definition: Decl.h:918
The JSON file list parser is used to communicate input to InstallAPI.
Diagnostic wrappers for TextAPI types for error reporting.
Definition: Dominators.h:30
int __ovld __cnfn all(char)
Returns 1 if the most significant bit in all components of x is set; otherwise returns 0.
int __ovld __cnfn any(char)
Returns 1 if the most significant bit in any component of x is set; otherwise returns 0.
std::vector< std::pair< llvm::GlobalVariable *, unsigned > > Constants
Definition: CGHLSLRuntime.h:99