Skip to content

[HLSL] Add static methods for resource initialization #155866

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 16 commits into from
Sep 10, 2025
Merged

[HLSL] Add static methods for resource initialization #155866

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
7a0d3ca
[HLSL] Reorder the arguments of handle initialization builtins
hekota Aug 28, 2025
dcbbda4
[HLSL] Add static methods for resource initialization and a construct…
hekota Aug 28, 2025
a0cfc72
Merge branch 'main' of https://github.com/llvm/llvm-project into res-…
hekota Sep 3, 2025
1e6f4de
Merge branch 'users/hekota/pr155861-res-create-0-reorder-builtin-args…
hekota Sep 3, 2025
dfc07bd
Remove handle constructor, update create methods body and expected AS…
hekota Sep 4, 2025
a41cf8a
Merge branch 'main' of https://github.com/llvm/llvm-project into res-…
hekota Sep 4, 2025
e7641e1
cleanup
hekota Sep 4, 2025
6028194
clang-format
hekota Sep 4, 2025
84883bc
Merge branch 'main' of https://github.com/llvm/llvm-project into res-…
hekota Sep 4, 2025
30b61c8
code review feedback - remove Access, rename method, add comments
hekota Sep 8, 2025
e516608
Merge branch 'main' of https://github.com/llvm/llvm-project into res-…
hekota Sep 8, 2025
0742a96
remove duplicated code, update test
hekota Sep 8, 2025
b8d1508
Update handling of local variables
hekota Sep 8, 2025
21e3992
Merge branch 'main' into res-create-1-add-methods
hekota Sep 9, 2025
25a0834
update template param names
hekota Sep 10, 2025
6982299
Merge branch 'res-create-1-add-methods' of https://github.com/hekota/…
hekota Sep 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
201 changes: 175 additions & 26 deletions clang/lib/Sema/HLSLBuiltinTypeDeclBuilder.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
#include "clang/AST/Expr.h"
#include "clang/AST/Type.h"
#include "clang/Basic/SourceLocation.h"
#include "clang/Basic/Specifiers.h"
#include "clang/Sema/Lookup.h"
#include "clang/Sema/Sema.h"
#include "clang/Sema/SemaHLSL.h"
Expand Down Expand Up @@ -102,6 +103,13 @@ struct BuiltinTypeMethodBuilder {
: NameII(NameII), Ty(Ty), Modifier(Modifier) {}
};

struct LocalVar {
StringRef Name;
QualType Ty;
VarDecl *Decl;
LocalVar(StringRef Name, QualType Ty) : Name(Name), Ty(Ty), Decl(nullptr) {}
};

BuiltinTypeDeclBuilder &DeclBuilder;
DeclarationName Name;
QualType ReturnTy;
Expand All @@ -110,6 +118,7 @@ struct BuiltinTypeMethodBuilder {
CXXMethodDecl *Method;
bool IsConst;
bool IsCtor;
StorageClass SC;
llvm::SmallVector<Param> Params;
llvm::SmallVector<Stmt *> StmtsList;

Expand All @@ -123,20 +132,21 @@ struct BuiltinTypeMethodBuilder {
enum class PlaceHolder { _0, _1, _2, _3, _4, Handle = 128, LastStmt };

Expr *convertPlaceholder(PlaceHolder PH);
Expr *convertPlaceholder(LocalVar &Var);
Expr *convertPlaceholder(Expr *E) { return E; }

public:
friend BuiltinTypeDeclBuilder;

BuiltinTypeMethodBuilder(BuiltinTypeDeclBuilder &DB, DeclarationName &Name,
QualType ReturnTy, bool IsConst = false,
bool IsCtor = false)
bool IsCtor = false, StorageClass SC = SC_None)
: DeclBuilder(DB), Name(Name), ReturnTy(ReturnTy), Method(nullptr),
IsConst(IsConst), IsCtor(IsCtor) {}
IsConst(IsConst), IsCtor(IsCtor), SC(SC) {}

BuiltinTypeMethodBuilder(BuiltinTypeDeclBuilder &DB, StringRef NameStr,
QualType ReturnTy, bool IsConst = false,
bool IsCtor = false);
bool IsCtor = false, StorageClass SC = SC_None);
BuiltinTypeMethodBuilder(const BuiltinTypeMethodBuilder &Other) = delete;

~BuiltinTypeMethodBuilder() { finalize(); }
Expand All @@ -147,18 +157,22 @@ struct BuiltinTypeMethodBuilder {
BuiltinTypeMethodBuilder &addParam(StringRef Name, QualType Ty,
HLSLParamModifierAttr::Spelling Modifier =
HLSLParamModifierAttr::Keyword_in);
BuiltinTypeMethodBuilder &declareLocalVar(LocalVar &Var);
template <typename... Ts>
BuiltinTypeMethodBuilder &callBuiltin(StringRef BuiltinName,
QualType ReturnType, Ts... ArgSpecs);
template <typename TLHS, typename TRHS>
BuiltinTypeMethodBuilder &assign(TLHS LHS, TRHS RHS);
template <typename T> BuiltinTypeMethodBuilder &dereference(T Ptr);
BuiltinTypeDeclBuilder &finalize();
Expr *getResourceHandleExpr();

template <typename T>
BuiltinTypeMethodBuilder &getResourceHandle(T ResourceRecord);
BuiltinTypeMethodBuilder &accessHandleFieldOnResource(T ResourceRecord);
template <typename ResourceT, typename ValueT>
BuiltinTypeMethodBuilder &setHandleFieldOnResource(ResourceT ResourceRecord,
ValueT HandleValue);
template <typename T> BuiltinTypeMethodBuilder &returnValue(T ReturnValue);
BuiltinTypeMethodBuilder &returnThis();
BuiltinTypeDeclBuilder &finalize();
Expr *getResourceHandleExpr();

private:
void createDecl();
Expand Down Expand Up @@ -339,12 +353,22 @@ Expr *BuiltinTypeMethodBuilder::convertPlaceholder(PlaceHolder PH) {
ParamDecl->getType().getNonReferenceType(), VK_PRValue);
}

Expr *BuiltinTypeMethodBuilder::convertPlaceholder(LocalVar &Var) {
VarDecl *VD = Var.Decl;
assert(VD && "local variable is not declared");
return DeclRefExpr::Create(
VD->getASTContext(), NestedNameSpecifierLoc(), SourceLocation(), VD,
false, DeclarationNameInfo(VD->getDeclName(), SourceLocation()),
VD->getType(), VK_LValue);
}

BuiltinTypeMethodBuilder::BuiltinTypeMethodBuilder(BuiltinTypeDeclBuilder &DB,
StringRef NameStr,
QualType ReturnTy,
bool IsConst, bool IsCtor)
bool IsConst, bool IsCtor,
StorageClass SC)
: DeclBuilder(DB), ReturnTy(ReturnTy), Method(nullptr), IsConst(IsConst),
IsCtor(IsCtor) {
IsCtor(IsCtor), SC(SC) {

assert((!NameStr.empty() || IsCtor) && "method needs a name");
assert(((IsCtor && !IsConst) || !IsCtor) && "constructor cannot be const");
Expand Down Expand Up @@ -394,10 +418,9 @@ void BuiltinTypeMethodBuilder::createDecl() {
ExplicitSpecifier(), false, true, false,
ConstexprSpecKind::Unspecified);
else
Method =
CXXMethodDecl::Create(AST, DeclBuilder.Record, SourceLocation(),
NameInfo, FuncTy, TSInfo, SC_None, false, false,
ConstexprSpecKind::Unspecified, SourceLocation());
Method = CXXMethodDecl::Create(
AST, DeclBuilder.Record, SourceLocation(), NameInfo, FuncTy, TSInfo, SC,
false, false, ConstexprSpecKind::Unspecified, SourceLocation());

// create params & set them to the function prototype
SmallVector<ParmVarDecl *> ParmDecls;
Expand Down Expand Up @@ -435,19 +458,20 @@ Expr *BuiltinTypeMethodBuilder::getResourceHandleExpr() {
OK_Ordinary);
}

template <typename T>
BuiltinTypeMethodBuilder &
BuiltinTypeMethodBuilder::getResourceHandle(T ResourceRecord) {
BuiltinTypeMethodBuilder::declareLocalVar(LocalVar &Var) {
ensureCompleteDecl();

Expr *ResourceExpr = convertPlaceholder(ResourceRecord);
assert(Var.Decl == nullptr && "local variable is already declared");

ASTContext &AST = DeclBuilder.SemaRef.getASTContext();
FieldDecl *HandleField = DeclBuilder.getResourceHandleField();
MemberExpr *HandleExpr = MemberExpr::CreateImplicit(
AST, ResourceExpr, /*IsArrow=*/false, HandleField, HandleField->getType(),
VK_LValue, OK_Ordinary);
StmtsList.push_back(HandleExpr);
Var.Decl = VarDecl::Create(
AST, Method, SourceLocation(), SourceLocation(),
&AST.Idents.get(Var.Name, tok::TokenKind::identifier), Var.Ty,
AST.getTrivialTypeSourceInfo(Var.Ty, SourceLocation()), SC_None);
DeclStmt *DS = new (AST) clang::DeclStmt(DeclGroupRef(Var.Decl),
SourceLocation(), SourceLocation());
StmtsList.push_back(DS);
return *this;
}

Expand All @@ -464,11 +488,11 @@ template <typename... Ts>
BuiltinTypeMethodBuilder &
BuiltinTypeMethodBuilder::callBuiltin(StringRef BuiltinName,
QualType ReturnType, Ts... ArgSpecs) {
ensureCompleteDecl();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was this moved up intentionally?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, this move was intentional. We need a complete method declaration (=all parameters created) before convertPlaceHolder can refer to them.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: no need to move this?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This move was intentional. We need a complete method declaration (=all parameters created) before convertPlaceHolder can refer to them.


std::array<Expr *, sizeof...(ArgSpecs)> Args{
convertPlaceholder(std::forward<Ts>(ArgSpecs))...};

ensureCompleteDecl();

ASTContext &AST = DeclBuilder.SemaRef.getASTContext();
FunctionDecl *FD = lookupBuiltinFunction(DeclBuilder.SemaRef, BuiltinName);
DeclRefExpr *DRE = DeclRefExpr::Create(
Expand Down Expand Up @@ -512,6 +536,55 @@ BuiltinTypeMethodBuilder &BuiltinTypeMethodBuilder::dereference(T Ptr) {
return *this;
}

template <typename T>
BuiltinTypeMethodBuilder &
BuiltinTypeMethodBuilder::accessHandleFieldOnResource(T ResourceRecord) {
ensureCompleteDecl();

Expr *ResourceExpr = convertPlaceholder(ResourceRecord);

ASTContext &AST = DeclBuilder.SemaRef.getASTContext();
FieldDecl *HandleField = DeclBuilder.getResourceHandleField();
MemberExpr *HandleExpr = MemberExpr::CreateImplicit(
AST, ResourceExpr, false, HandleField, HandleField->getType(), VK_LValue,
OK_Ordinary);
StmtsList.push_back(HandleExpr);
return *this;
}

template <typename ResourceT, typename ValueT>
BuiltinTypeMethodBuilder &
BuiltinTypeMethodBuilder::setHandleFieldOnResource(ResourceT ResourceRecord,
ValueT HandleValue) {
ensureCompleteDecl();

Expr *ResourceExpr = convertPlaceholder(ResourceRecord);
Expr *HandleValueExpr = convertPlaceholder(HandleValue);

ASTContext &AST = DeclBuilder.SemaRef.getASTContext();
FieldDecl *HandleField = DeclBuilder.getResourceHandleField();
MemberExpr *HandleMemberExpr = MemberExpr::CreateImplicit(
AST, ResourceExpr, false, HandleField, HandleField->getType(), VK_LValue,
OK_Ordinary);
Stmt *AssignStmt = BinaryOperator::Create(
DeclBuilder.SemaRef.getASTContext(), HandleMemberExpr, HandleValueExpr,
BO_Assign, HandleMemberExpr->getType(), ExprValueKind::VK_PRValue,
ExprObjectKind::OK_Ordinary, SourceLocation(), FPOptionsOverride());
StmtsList.push_back(AssignStmt);
return *this;
}

template <typename T>
BuiltinTypeMethodBuilder &BuiltinTypeMethodBuilder::returnValue(T ReturnValue) {
ensureCompleteDecl();

Expr *ReturnValueExpr = convertPlaceholder(ReturnValue);
ASTContext &AST = DeclBuilder.SemaRef.getASTContext();
StmtsList.push_back(
ReturnStmt::Create(AST, SourceLocation(), ReturnValueExpr, nullptr));
return *this;
}

BuiltinTypeDeclBuilder &BuiltinTypeMethodBuilder::finalize() {
assert(!DeclBuilder.Record->isCompleteDefinition() &&
"record is already complete");
Expand Down Expand Up @@ -539,7 +612,7 @@ BuiltinTypeDeclBuilder &BuiltinTypeMethodBuilder::finalize() {
Method->setBody(CompoundStmt::Create(AST, StmtsList, FPOptionsOverride(),
SourceLocation(), SourceLocation()));
Method->setLexicalDeclContext(DeclBuilder.Record);
Method->setAccess(AccessSpecifier::AS_public);
Method->setAccess(AS_public);
Method->addAttr(AlwaysInlineAttr::CreateImplicit(
AST, SourceRange(), AlwaysInlineAttr::CXX11_clang_always_inline));
DeclBuilder.Record->addDecl(Method);
Expand Down Expand Up @@ -705,6 +778,82 @@ BuiltinTypeDeclBuilder::addHandleConstructorFromImplicitBinding() {
.finalize();
}

// Adds static method that initializes resource from binding:
//
// static Resource<T> __createFromBinding(unsigned registerNo,
// unsigned spaceNo, int range,
// unsigned index, const char *name) {
// Resource<T> tmp;
// tmp.__handle = __builtin_hlsl_resource_handlefrombinding(
// tmp.__handle, registerNo, spaceNo,
// range, index, name);
// return tmp;
// }
BuiltinTypeDeclBuilder &BuiltinTypeDeclBuilder::addCreateFromBinding() {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: addCreateFromBinding and addCreateFromImplicitBinding are super similar. Do we have a general preference of having explicit functions vs an input argument for this? Just the call to BuiltinTypeMethodBuilder constructor and the first addparam are different.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We do want these methods to be separate with different names since Sema and CodeGen will search for them by name. There are also going to be methods for initializing resources from dynamic binding, or resources with separate binding for counter - the complete list of create methods will be more varied.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think Alex was trying to say that the implementations of the builder functions are really similar. That is, would it be worth it to abstract out a helper along the lines of

BuiltinTypeDeclBuilder &addStaticResoureConstructor(StringRef Name, StringRef Builtin, ArrayRef<std::pair<StringRef, QualType>> Params);

I think it might clean this up a bit, but I'm also okay with waiting for some of the other initialization functions to come in before settling on the best abstraction here. Up to you.

if (Record->isCompleteDefinition())
return *this;

using PH = BuiltinTypeMethodBuilder::PlaceHolder;
ASTContext &AST = SemaRef.getASTContext();
QualType HandleType = getResourceHandleField()->getType();
QualType RecordType = AST.getTypeDeclType(cast<TypeDecl>(Record));
BuiltinTypeMethodBuilder::LocalVar TmpVar("tmp", RecordType);

return BuiltinTypeMethodBuilder(*this, "__createFromBinding", RecordType,
false, false, SC_Static)
.addParam("registerNo", AST.UnsignedIntTy)
.addParam("spaceNo", AST.UnsignedIntTy)
.addParam("range", AST.IntTy)
.addParam("index", AST.UnsignedIntTy)
.addParam("name", AST.getPointerType(AST.CharTy.withConst()))
.declareLocalVar(TmpVar)
.accessHandleFieldOnResource(TmpVar)
.callBuiltin("__builtin_hlsl_resource_handlefrombinding", HandleType,
PH::LastStmt, PH::_0, PH::_1, PH::_2, PH::_3, PH::_4)
.setHandleFieldOnResource(TmpVar, PH::LastStmt)
.returnValue(TmpVar)
.finalize();
}

// Adds static method that initializes resource from binding:
//
// static Resource<T> __createFromImplicitBinding(unsigned orderId,
// unsigned spaceNo, int range,
// unsigned index,
// const char *name) {
// Resource<T> tmp;
// tmp.__handle = __builtin_hlsl_resource_handlefromimplicitbinding(
// tmp.__handle, spaceNo,
// range, index, orderId, name);
// return tmp;
// }
BuiltinTypeDeclBuilder &BuiltinTypeDeclBuilder::addCreateFromImplicitBinding() {
if (Record->isCompleteDefinition())
return *this;

using PH = BuiltinTypeMethodBuilder::PlaceHolder;
ASTContext &AST = SemaRef.getASTContext();
QualType HandleType = getResourceHandleField()->getType();
QualType RecordType = AST.getTypeDeclType(cast<TypeDecl>(Record));
BuiltinTypeMethodBuilder::LocalVar TmpVar("tmp", RecordType);

return BuiltinTypeMethodBuilder(*this, "__createFromImplicitBinding",
RecordType, false, false, SC_Static)
.addParam("orderId", AST.UnsignedIntTy)
.addParam("spaceNo", AST.UnsignedIntTy)
.addParam("range", AST.IntTy)
.addParam("index", AST.UnsignedIntTy)
.addParam("name", AST.getPointerType(AST.CharTy.withConst()))
.declareLocalVar(TmpVar)
.accessHandleFieldOnResource(TmpVar)
.callBuiltin("__builtin_hlsl_resource_handlefromimplicitbinding",
HandleType, PH::LastStmt, PH::_0, PH::_1, PH::_2, PH::_3,
PH::_4)
.setHandleFieldOnResource(TmpVar, PH::LastStmt)
.returnValue(TmpVar)
.finalize();
}

BuiltinTypeDeclBuilder &BuiltinTypeDeclBuilder::addCopyConstructor() {
if (Record->isCompleteDefinition())
return *this;
Expand All @@ -719,7 +868,7 @@ BuiltinTypeDeclBuilder &BuiltinTypeDeclBuilder::addCopyConstructor() {
return BuiltinTypeMethodBuilder(*this, /*Name=*/"", AST.VoidTy,
/*IsConst=*/false, /*IsCtor=*/true)
.addParam("other", ConstRecordRefType)
.getResourceHandle(PH::_0)
.accessHandleFieldOnResource(PH::_0)
.assign(PH::Handle, PH::LastStmt)
.finalize();
}
Expand All @@ -738,7 +887,7 @@ BuiltinTypeDeclBuilder &BuiltinTypeDeclBuilder::addCopyAssignmentOperator() {
DeclarationName Name = AST.DeclarationNames.getCXXOperatorName(OO_Equal);
return BuiltinTypeMethodBuilder(*this, Name, RecordRefType)
.addParam("other", ConstRecordRefType)
.getResourceHandle(PH::_0)
.accessHandleFieldOnResource(PH::_0)
.assign(PH::Handle, PH::LastStmt)
.returnThis()
.finalize();
Expand Down
4 changes: 4 additions & 0 deletions clang/lib/Sema/HLSLBuiltinTypeDeclBuilder.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,10 @@ class BuiltinTypeDeclBuilder {
BuiltinTypeDeclBuilder &addCopyConstructor();
BuiltinTypeDeclBuilder &addCopyAssignmentOperator();

// Static create methods
BuiltinTypeDeclBuilder &addCreateFromBinding();
BuiltinTypeDeclBuilder &addCreateFromImplicitBinding();

// Builtin types methods
BuiltinTypeDeclBuilder &addLoadMethods();
BuiltinTypeDeclBuilder &addIncrementCounterMethod();
Expand Down
2 changes: 2 additions & 0 deletions clang/lib/Sema/HLSLExternalSemaSource.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,8 @@ static BuiltinTypeDeclBuilder setupBufferType(CXXRecordDecl *Decl, Sema &S,
.addDefaultHandleConstructor()
.addCopyConstructor()
.addCopyAssignmentOperator()
.addCreateFromBinding()
.addCreateFromImplicitBinding()
.addHandleConstructorFromBinding()
.addHandleConstructorFromImplicitBinding();
}
Expand Down
Loading