|
| 1 | +<% |
| 2 | + OneApi=tags['$OneApi'] |
| 3 | + x=tags['$x'] |
| 4 | + X=x.upper() |
| 5 | +%> |
| 6 | + |
| 7 | +.. _experimental-graph: |
| 8 | + |
| 9 | +================================================================================ |
| 10 | +Graph |
| 11 | +================================================================================ |
| 12 | + |
| 13 | +.. warning:: |
| 14 | + |
| 15 | + Experimental features: |
| 16 | + |
| 17 | + * May be replaced, updated, or removed at any time. |
| 18 | + * Do not require maintaining API/ABI stability of their own additions over |
| 19 | + time. |
| 20 | + |
| 21 | + |
| 22 | +Motivation |
| 23 | +-------------------------------------------------------------------------------- |
| 24 | +This extension introduces functionality for recording enqueued operations into a |
| 25 | +graph for later execution. Queues can enter graph capture mode, where operations |
| 26 | +enqueued to them are recorded into a graph instead of being executed immediately. |
| 27 | +This graph can then be instantiated as an executable graph and appended to a queue |
| 28 | +multiple times for repeated execution. |
| 29 | + |
| 30 | +API |
| 31 | +-------------------------------------------------------------------------------- |
| 32 | + |
| 33 | +Enums |
| 34 | +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 35 | +* ${x}_device_info_t |
| 36 | + * ${X}_DEVICE_INFO_GRAPH_RECORD_AND_REPLAY_SUPPORT_EXP |
| 37 | + |
| 38 | +Functions |
| 39 | +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 40 | +* Graph |
| 41 | + * ${x}GraphCreateExp |
| 42 | + * ${x}GraphInstantiateGraphExp |
| 43 | + * ${x}GraphDestroyExp |
| 44 | + * ${x}GraphExecutableGraphDestroyExp |
| 45 | + * ${x}GraphIsEmptyExp |
| 46 | + * ${x}GraphDumpContentsExp |
| 47 | +* Queue |
| 48 | + * ${x}QueueBeginGraphCaptureExp |
| 49 | + * ${x}QueueBeginCaptureIntoGraphExp |
| 50 | + * ${x}QueueEndGraphCaptureExp |
| 51 | + * ${x}QueueAppendGraphExp |
| 52 | + * ${x}QueueIsGraphCaptureEnabledExp |
| 53 | + |
| 54 | +Changelog |
| 55 | +-------------------------------------------------------------------------------- |
| 56 | + |
| 57 | ++-----------+---------------------------------------------+ |
| 58 | +| Revision | Changes | |
| 59 | ++===========+=============================================+ |
| 60 | +| 1.0 | Initial Draft | |
| 61 | ++-----------+---------------------------------------------+ |
| 62 | +| 1.1 | Extend ${x}_device_info_t enumerator with | |
| 63 | +| | graph record and replay entry. | |
| 64 | ++-----------+---------------------------------------------+ |
| 65 | + |
| 66 | +Support |
| 67 | +-------------------------------------------------------------------------------- |
| 68 | + |
| 69 | +Adapters which support this experimental feature *must* return true for the new |
| 70 | +``${X}_DEVICE_INFO_GRAPH_RECORD_AND_REPLAY_SUPPORT_EXP`` device info query. |
| 71 | + |
| 72 | +Contributors |
| 73 | +-------------------------------------------------------------------------------- |
| 74 | + |
| 75 | + |
| 76 | + |
0 commit comments