-
Notifications
You must be signed in to change notification settings - Fork 34
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.
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
alignas proposal #154
base: main
Are you sure you want to change the base?
alignas proposal #154
Conversation
@microsoft-github-policy-service agree company="NVIDIA"
…________________________________
From: microsoft-github-policy-service[bot] ***@***.***>
Sent: Thursday, January 11, 2024 10:40 AM
To: microsoft/hlsl-specs ***@***.***>
Cc: Michael Apodaca ***@***.***>; Mention ***@***.***>
Subject: Re: [microsoft/hlsl-specs] [0013] alignas proposal (PR #154)
@mapodaca-nv<https://github.com/mapodaca-nv> please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
@microsoft-github-policy-service agree [company="{your company}"]
Options:
* (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
* (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement
Contribution License Agreement
This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.
1. Definitions.
“Code” means the computer software code, whether in human-readable or machine-executable form,
that is delivered by You to Microsoft under this Agreement.
“Project” means any of the projects owned or managed by Microsoft and offered under a license
approved by the Open Source Initiative (www.opensource.org<http://www.opensource.org>).
“Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
Project, including but not limited to communication on electronic mailing lists, source code control
systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
discussing and improving that Project, but excluding communication that is conspicuously marked or
otherwise designated in writing by You as “Not a Submission.”
“Submission” means the Code and any other copyrightable material Submitted by You, including any
associated comments and documentation.
2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
Project. This Agreement covers any and all Submissions that You, now or in the future (except as
described in Section 4 below), Submit to any Project.
3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
Should You wish to Submit materials that are not Your original work, You may Submit them separately
to the Project if You (a) retain all copyright and license information that was in the materials as You
received them, (b) in the description accompanying Your Submission, include the phrase “Submission
containing materials of a third party:” followed by the names of the third party and any licenses or other
restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
guidelines concerning Submissions.
4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
Submission is made in the course of Your work for an employer or Your employer has intellectual
property rights in Your Submission by contract or applicable law, You must secure permission from Your
employer to make the Submission before signing this Agreement. In that case, the term “You” in this
Agreement will refer to You and the employer collectively. If You change employers in the future and
desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
and secure permission from the new employer before Submitting those Submissions.
5. Licenses.
* Copyright License. You grant Microsoft, and those who receive the Submission directly or
indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
parties.
* Patent License. You grant Microsoft, and those who receive the Submission directly or
indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
Your patent claims that are necessarily infringed by the Submission or the combination of the
Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
import or otherwise dispose of the Submission alone or with the Project.
* Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
granted by implication, exhaustion, estoppel or otherwise.
1. Representations and Warranties. You represent that You are legally entitled to grant the above
licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
have disclosed under Section 3). You represent that You have secured permission from Your employer to
make the Submission in cases where Your Submission is made in the course of Your work for Your
employer or Your employer has intellectual property rights in Your Submission by contract or applicable
law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
You later become aware that would make Your representations in this Agreement inaccurate in any
respect.
3. Information about Submissions. You agree that contributions to Projects and information about
contributions may be maintained indefinitely and disclosed publicly, including Your name and other
information that You submit with Your Submission.
4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
defenses of lack of personal jurisdiction and forum non-conveniens.
5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
supersedes any and all prior agreements, understandings or communications, written or oral, between
the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.
—
Reply to this email directly, view it on GitHub<#154 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/BEAR4UWWYAFSHOTKBCEJ4JLYOAW2RAVCNFSM6AAAAABBW6VL3GVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQOBXG42TAMBYHE>.
You are receiving this because you were mentioned.Message ID: ***@***.***>
|
@mapodaca-nv Do you know what SPIR-V you would want to generate for this? Will you require any changes to the spir-v spec? |
I removed the number from the title. Proposal numbers are assigned when they are approved for merging. |
Structures in SPIR-V are already explicitly laid out using Offset and ArrayStride decorations on the structure members, so no SPIR-V change should be needed to support this. The frontend compiler would have to handle alignas and use it in its calculation of the offsets and strides. |
proposals/0013-alignas.md
Outdated
|
||
# HLSL alignas Specifier | ||
|
||
* Proposal: [0013](0013-alignas.md) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use NNNN
instead of 0013
until just before this merges, and you pick the next available number.
Okay, this will potentially lose the alignment requirement for standalone variables. See https://godbolt.org/z/MnrrTv86M as an example. This is a common use case, which is explicitly used in the example uses here. Also, an offset and stride do not guarentee alignment. If the alignment of the start of the array is off, then the array stride will guarentee that every element has the wrong alignment. I think the spir-v side of these seem to be thought out more. I like the idea, and think it will be useful, but we are not able to implement it. Now that I think about it, @cassiebeckley do we have the same problem with the SpirvType proposal? |
The alignas specifier also applies to the structure itself, not just its members, which does affect the alignment of the structure within an array. There is also an expectation for structured buffers that the alignment in memory matches what was specified in HLSL. |
Hello! Seems like I'll be looking into this. Taking this code: struct alignas(64) MyStruct {
float field1;
alignas(16) float field2;
};
RWStructuredBuffer<MyStruct> input;
RWStructuredBuffer<MyStruct> output;
void main() {
MyStruct tmp = input[10];
output[10] = tmp;
} What I believe can be handled on the SPIR-V side (assuming the Vulkan API usage is correct):
The only bit that we cannot to my knowledge represent in SPIR-V is an aligned @mapodaca-nv : would those limitations be OK? Or shall we see if a new decoration shall be added to SPIR-V to also require local variables to have some kind of alignment? |
The primary intent of alignas is to declare how structures are laid out in memory, in order to utilize optimal load and store hardware. Therefore, it should be acceptable if the specification is relaxed to say that alignas is allowed on structure declarations for local variables, but has no affect on the layout in hardware registers. From @jeffbolznv:
|
Cool, thanks for the details. So on the SPIR-V side, as long as we ignore this attribute when it's not related to a memory buffer, and assume correct API usage for initial buffer alignment, I don't see any issues with this proposal. |
float3 bar; | ||
alignas(16) uint baz; // 16-byte aligned member | ||
}; | ||
static_assert(sizeof(Foo) == 32); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
RawBufferLoad is a SPIR-V only thing, and this proposal also targets that.
would be nice if static_assert
got implemented in the SPIR-V backend (currently only works in DXIL).
While we're here, could we get |
No description provided.