[SPIR-V][DOC] Update SPV_INTEL_function_pointers (#4883)

OpFunctionPointerINTEL was renamed to OpConstantFunctionPointerINTEL

Signed-off-by: Dmitry Sidorov <[email protected]>
Co-authored-by: Alexey Sachkov <[email protected]>

Author: MrSidims

sycl/doc/design/spirv-extensions/SPV_INTEL_function_pointers.asciidoc

@@ -18,6 +18,8 @@ https://github.com/intel/llvm/issues
 - Pawel Jurek, Intel
 - Thomas Raoux, Intel
 - Nikita Kornev, Intel
+- Dmitry Sidorov, Intel
+- Alex Bezzubikov, Intel
 
 == Notice
 
@@ -38,7 +40,7 @@ If you are interested in using this feature in your software product, please let
 [width="40%",cols="25,25"]
 |==================================
 | Last Modified Date | {docdate}
-| Revision           | H
+| Revision           | I
 |==================================
 
 == Dependencies
@@ -89,7 +91,7 @@ IndirectReferencesINTEL
 Instructions added under the *FunctionPointersINTEL* capability:
 
 ----
-OpFunctionPointerINTEL
+OpConstantFunctionPointerINTEL
 OpFunctionPointerCallINTEL
 ----
 
@@ -122,13 +124,13 @@ CodeSectionINTEL
 [cols="70%,30%"]
 [grid="rows"]
 |====
-|OpFunctionPointerINTEL     | 5600
-|OpFunctionPointerCallINTEL | 5601
-|ReferencedIndirectlyINTEL  | 5602
-|FunctionPointersINTEL      | 5603
-|IndirectReferencesINTEL    | 5604
-|CodeSectionINTEL           | 5605
-|ArgumentAttributeINTEL     | 6409
+|OpConstantFunctionPointerINTEL | 5600
+|OpFunctionPointerCallINTEL     | 5601
+|ReferencedIndirectlyINTEL      | 5602
+|FunctionPointersINTEL          | 5603
+|IndirectReferencesINTEL        | 5604
+|CodeSectionINTEL               | 5605
+|ArgumentAttributeINTEL         | 6409
 |====
 
 == Modifications to the SPIR-V Specification, Version 1.4
@@ -143,23 +145,24 @@ Modify Section 2.2.2, Types, add the following at the end of the section: ::
 [[FunctionPointer]]'Function Pointer': A pointer that results from the following
 instruction:
 
-- *OpFunctionPointerINTEL*
+- *OpConstantFunctionPointerINTEL*
 
 Additionally, any *OpSelect*, *OpPhi*, *OpFunctionCall*, *OpPtrAccessChain*,
 *OpLoad*, *OpAccessChain*, *OpInBoundAccessChain*, or *OpCopyObject* thas takes
 a function pointer as an operand also produces a function pointer. An
 *OpFunctionParameter* of pointer type is function pointer if any
 *OpFunctionCall* to the function statically passes a function pointer as the
-value of the parameter. *OpConstantNull* returns function pointer if 'Result
-type' is function pointer.
+value of the parameter. *OpCompositeExtract* and *OpConstantNull* return
+function pointer if 'Result type' is function pointer.
 
 Modify Section 2.9, Function Calling, add the following after the first sentence: ::
 
 Functions can be called indirectly using function pointers: to do so, use
 *OpFunctionPointerCallINTEL* with an operand that is the _<id>_ obtained using
-*OpFunctionPointerINTEL* of the *OpFunction* to call, and the _<id>s_ of the
-arguments to pass. All arguments are passed by value into the called function.
-This includes pointers, through which a callee object could be modified.
+*OpConstantFunctionPointerINTEL* of the *OpFunction* to call, and the _<id>s_ of
+the arguments to pass. All arguments are passed by value into the called
+function. This includes pointers, through which a callee object could be
+modified.
 
 === Storage Classes
 
@@ -226,16 +229,17 @@ Modify Section 3.32.6, Type-Declaration Instructions, change the third sentence
 pointer type. *OpFunction* and *OpTypePointer* are only valid uses of
 *OpTypeFunction*.
 
-Modify Section 3.32.9, Function Instructions, adding to the end of the list of instructions: ::
+Modify Section 3.32.7, Constant-Creation Instructions, adding to the end of the list of instructions: ::
 
 [cols="2*1,3*3",width="100%"]
 |=====
-4+|[[OpFunctionPointerINTEL]]*OpFunctionPointerINTEL* +
+4+|[[OpConstantFunctionPointerINTEL]]*OpConstantFunctionPointerINTEL* +
  +
-Obtains address of the specified function. +
+Obtains constant address of the specified function. +
  +
-Result value can be used immediately in *OpFunctionPointerCallINTEL* or stored
-somewhere for further usage in *OpFunctionPointerCallINTEL*. +
+Result value can be used immediately in *OpFunctionPointerCallINTEL*, inserted
+into a composite constant or stored somewhere for further usage in
+*OpFunctionPointerCallINTEL*. +
  +
 _Result Type_ must be an *OpTypePointer*. Its _Type_ operand must be the same
 *OpTypeFunction* which was used as _Function Type_ operand of the _Function_
@@ -245,6 +249,8 @@ operand. Its _Storage Class_ operand must be *CodeSectionINTEL*
 | 4 | 5600 | '<id>' 'Result Type' | '<id> Result ' | '<id>' 'Function'
 |=====
 
+Modify Section 3.32.9, Function Instructions, adding to the end of the list of instructions: ::
+
 [cols="2*1,4*3",width="100%"]
 |=====
 5+|[[OpFunctionPointerCallINTEL]]*OpFunctionPointerCallINTEL* +
@@ -271,14 +277,17 @@ argument types must match the formal parameter types.
 == Validation Rules
 
 It is legal to use <<FunctionPointer, Function Pointer>> as 'Result Type' of
-*OpFunctionArgument*, *OpUndef* and *OpConstantNULL*.
+*OpFunctionArgument*, *OpCompositeExtract*, *OpUndef* and *OpConstantNULL*.
 
 It is legal to use <<FunctionPointer, Function Pointer>> as 'Return Type' of
 *OpTypeFunction*.
 
 It is legal to use <<FunctionPointer, Function Pointer>> as 'Pointer'
 argument of *OpConvertPtrToU* and as 'Result Type' of *OpConvertUToPtr*.
 
+It is legal to use <<FunctionPointer, Function Pointer>> as 'Object'
+argument of *OpCompositeInsert*.
+
 It is illegal to use <<FunctionPointer, Function Pointer>> as 'Pointer'
 argument of *OpPtrCastToGeneric*.
 
@@ -327,6 +336,27 @@ be used for ones out of the box and we don't have much use-cases for it.
 *UNRESOLVED*
 --
 
+. Should we prohibit heterogenous composites with function pointers? Maybe we should
+distinct <<FunctionPointer, Function Pointer>> and Constant Function Pointer?
++
+--
+*RESOLVED*
+
+In general, we should not since this extension is aimed to support the whole C++ function
+pointers functionality in SPIR-V.
+--
+
+. Should we distinct const and non-const function pointers in rules for *OpCompositeInsert*?
+We can only use a result of *OpConstantFunctionPointerINTEL* (which is a quite specific case of
+<<FunctionPointer, Function Pointer>>, so we can't use the whole term in the rule)
+in *OpConstantComposite*, but how should we specify that in this spec?
++
+--
+*RESOLVED*
+
+Removed *OpFunctionPointerINTEL* instruction.
+--
+
 //. Issue.
 //+
 //--
@@ -356,4 +386,6 @@ be used for ones out of the box and we don't have much use-cases for it.
 pointers. Updated validation rules. Misc updates.
 |G|2019-07-19|Ben Ashbaugh|Assigned SPIR-V enums, added preview extension disclaimer text.
 |H|2021-11-15|Nikita Kornev|Added new *ArgumentAttributeINTEL* decoration.
+|I|2022-10-08|Dmitry Sidorov, Alex Bezzubikov, Alexey Sachkov|Replaced *OpFunctionPointerINTEL* with
+*OpConstantFunctionPointerINTEL*
 |========================================