Skip to content

Commit 234c095

Browse files
Clarify documentation for SPIRV_GraphARMOp
Signed-off-by: Davide Grohmann <[email protected]> Change-Id: I7e73e1277bb988813f19f5684ec024c2d2dcb1df
1 parent 533589e commit 234c095

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

mlir/include/mlir/Dialect/SPIRV/IR/SPIRVGraphOps.td

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,15 @@ def SPIRV_GraphARMOp : SPIRV_GraphARMOp<"Graph", [
4545
This op declares or defines a SPIR-V graph using one region, which
4646
contains one or more blocks.
4747

48-
Different from the SPIR-V binary format, this op is not allowed to
49-
implicitly capture global values, and all external references must use
50-
function arguments or symbol references. This op itself defines a symbol
51-
that is unique in the enclosing module op.
48+
This op is not allowed to implicitly capture global values, and all external
49+
references must use function arguments or symbol references. This op itself
50+
defines a symbol that is unique in the enclosing module op.
51+
52+
Note that this op does not have a 1:1 mapping to the SPIR-V ops representing
53+
a graph. Indeed during serialization a single GraphARMOp is serialized into
54+
several different SPIR-V ops: OpGraphARM, OpGraphInputARM and OpGraphEndARM.
55+
There are as many occurences of OpGraphInputARM ops as many inputs in the
56+
graph. Deserialization maps that set of operations into a single GraphARMOp.
5257

5358
This op itself takes no operands and generates no results. Its region
5459
can take zero or more arguments and return one or more values.

0 commit comments

Comments
 (0)