cuda.bindings._v2.driver.stream_get_capture_info_v3#

cuda.bindings._v2.driver.stream_get_capture_info_v3(intptr_t h_stream) → tuple#

Query a stream’s capture state.

Query stream state related to stream capture. If called on CU_STREAM_LEGACY (the “null stream”) while a stream not created with CU_STREAM_NON_BLOCKING is capturing, returns CUDA_ERROR_STREAM_CAPTURE_IMPLICIT. Valid data (other than capture status) is returned only if both of the following are true:.

the call returns CUDA_SUCCESS.
the returned capture status is CU_STREAM_CAPTURE_STATUS_ACTIVE.

If edge_data_out is non-NULL then dependencies_out must be as well. If dependencies_out is non-NULL and edge_data_out is NULL, but there is non-zero edge data for one or more of the current stream dependencies, the call will return CUDA_ERROR_LOSSY_QUERY.

Parameters:

h_stream (intptr_t) – The stream to query.

Returns:

int: Location to return the capture status of the stream;
required.
uint64_t: Optional location to return an id for the capture
sequence, which is unique over the lifetime of the process.
intptr_t: Optional location to return the graph being captured
into. All operations other than destroy and node removal are permitted on the graph while the capture sequence is in progress. This API does not transfer ownership of the graph, which is transferred or destroyed at cuStreamEndCapture. Note that the graph handle may be invalidated before end of capture for certain errors. Nodes that are or become unreachable from the original stream at cuStreamEndCapture due to direct actions on the graph do not trigger CUDA_ERROR_STREAM_CAPTURE_UNJOINED.
intptr_t: Optional location to store a pointer to an array of
nodes. The next node to be captured in the stream will depend on this set of nodes, absent operations such as event wait which modify this set. The array pointer is valid until the next API call which operates on the stream or until the capture is terminated. The node handles may be copied out and are valid until they or the graph is destroyed. The driver- owned array may also be passed directly to APIs that operate on the graph (not the stream) without copying.
CUgraphEdgeData: Optional location to store a pointer to an array
of graph edge data. This array parallels dependencies_out; the next node to be added has an edge to dependencies_out[i] with annotation edge_data_out[i] for each i. The array pointer is valid until the next API call which operates on the stream or until the capture is terminated.

Return type:

A 5-tuple containing