Function: stream_abort

Applicability

Product	Supported (√/x)
Atlas A3 training products/Atlas A3 inference products	√
Atlas A2 training products/Atlas A2 inference products	√
Atlas training products	x
Atlas inference products	x
Atlas 200I/500 A2 inference products	x

Function Usage

Stops tasks that are being executed in a specified stream and discards tasks that have been delivered but not executed in the specified stream. New tasks delivered to the specified stream do not take effect during the execution of this API.

Prototype

C Prototype

aclError aclrtStreamAbort(aclrtStream stream)

Python Function
1
ret = acl.rt.stream_abort(stream)

Parameter Description

Parameter	Description
stream	Int, stream with tasks to be cleared. Passing NULL is not supported. Otherwise, an error will be reported.

Return Value Description

Return Value	Description
ret	Int, error code: 0 on success; else, failure.

Restrictions

If other streams depend on the stream specified by this API (for example, using acl.rt.record_event or acl.rt.stream_wait_event to synchronize two streams), the execution of other streams may be suspended. In this case, you need to explicitly call this API to clear tasks on other streams.

If you call this API to clear tasks on a specified stream and then call a synchronization API (such as acl.rt.synchronize_stream or acl.rt.synchronize_event), the synchronization API exits and returns ACL_ERROR_RT_STREAM_ABORT.

Parent topic: Streams Management