-
Notifications
You must be signed in to change notification settings - Fork 769
[SPIR-V][DOC] Add SPV_INTEL_token_type extension spec #3788
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
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
147 changes: 147 additions & 0 deletions
147
sycl/doc/extensions/SPIRV/SPV_INTEL_token_type.asciidoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,147 @@ | ||
SPV_INTEL_token_type | ||
==================== | ||
|
||
Name Strings | ||
------------ | ||
|
||
SPV_INTEL_token_type | ||
|
||
Contact | ||
------- | ||
|
||
To report problems with this extension, please open a new issue at: | ||
|
||
https://github.com/intel/llvm | ||
|
||
Contributors | ||
------------ | ||
|
||
- Dmitry Sidorov, Intel | ||
|
||
Notice | ||
------ | ||
|
||
Copyright (c) 2021 Intel Corporation. All rights reserved. | ||
|
||
Status | ||
------ | ||
|
||
Working Draft | ||
|
||
This is a preview extension specification, intended to provide early access to a | ||
feature for review and community feedback. When the feature matures, this | ||
specification may be released as a formal extension. | ||
|
||
Because the interfaces defined by this specification are not final and are | ||
subject to change they are not intended to be used by shipping software | ||
products. | ||
|
||
Version | ||
------- | ||
|
||
[width="40%",cols="25,25"] | ||
|======================================== | ||
| Last Modified Date | 2021-04-28 | ||
| Revision | A | ||
|======================================== | ||
|
||
Dependencies | ||
------------ | ||
|
||
This extension is written against the SPIR-V Specification, | ||
Version 1.5 Revision 7. | ||
|
||
This extension requires SPIR-V 1.0. | ||
|
||
Overview | ||
-------- | ||
|
||
This extension adds a type-declaration instruction *OpTypeTokenINTEL*, which is | ||
an analog of LLVM's type _token_. This type specifies IDs of entry points and | ||
exit points of certain IL constructs, for example it can be useful for exception | ||
handling representation in IL. | ||
|
||
Extension Name | ||
-------------- | ||
|
||
To use this extension within a SPIR-V module, the following *OpExtension* must | ||
be present in the module: | ||
|
||
---- | ||
OpExtension "SPV_INTEL_token_type" | ||
---- | ||
|
||
New Capabilities | ||
---------------- | ||
This extension introduces a new capability: | ||
|
||
---- | ||
TokenTypeINTEL | ||
---- | ||
|
||
New Instructions | ||
---------------- | ||
Instructions added under the *TokenTypeINTEL* capability: | ||
|
||
---- | ||
TypeTokenINTEL | ||
---- | ||
|
||
Token Number Assignments | ||
------------------------ | ||
[width="45%",cols="30,15"] | ||
|=============================== | ||
| TokenTypeINTEL | 6112 | ||
| OpTypeTokenINTEL | 6113 | ||
|=============================== | ||
|
||
Modifications to the SPIR-V Specification, Version 1.5 | ||
------------------------------------------------------ | ||
|
||
Capabilities | ||
~~~~~~~~~~~~ | ||
|
||
Modify Section 3.31, "Capability", adding these rows to the Capability table: | ||
|
||
-- | ||
[options="header"] | ||
|==== | ||
2+^| Capability ^| Depends On | ||
| 6112 | *TokenTypeINTEL* + | ||
Allow to use _OpTypeTokenINTEL_ type declaration instruction | | ||
|==== | ||
-- | ||
|
||
Instructions | ||
~~~~~~~~~~~~ | ||
|
||
In section 3.37.6 Type-Declaration Instructions, add a new instruction: | ||
|
||
[cols="3", width="100%"] | ||
|===== | ||
2+^|*OpTypeTokenINTEL* + | ||
Declare the token type. | ||
|
||
The token type is used when a value is associated with an instruction but all | ||
uses of the value must not attempt to introspect or obscure it. As such, it is | ||
not appropriate to have a _OpPhi_ or _OpSelect_ of _TypeTokenINTEL_. | ||
| Capability: | ||
*TokenTypeINTEL* | ||
|
||
| 2 | TBD | Result <id> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. no longer TBD |
||
|===== | ||
|
||
Issues | ||
------ | ||
|
||
Revision History | ||
---------------- | ||
|
||
[cols="5,15,15,70"] | ||
[grid="rows"] | ||
[options="header"] | ||
|======================================== | ||
|Rev|Date|Author|Changes | ||
|A|2021-04-28|Dmitry Sidorov|Initial revision | ||
|======================================== | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Revision 5