Dnnl_api_stream

Collaboration diagram for Dnnl_api_stream:

Classes
struct	dnnl_stream

Typedefs
typedef struct dnnl_stream *	dnnl_stream_t
	An execution stream handle. More...
typedef const struct dnnl_stream *	const_dnnl_stream_t
	A constant execution stream handle. More...
typedef struct dnnl_stream_attr *	dnnl_stream_attr_t
	An execution stream attributes handle. More...
typedef const struct dnnl_stream_attr *	const_dnnl_stream_attr_t
	A constant execution stream attributes handle. More...

Enumerations
enum	dnnl_stream_flags_t { dnnl_stream_default_order = 0x1U, dnnl_stream_in_order = 0x2U, dnnl_stream_out_of_order = 0x4U, dnnl_stream_default_flags = dnnl_stream_default_order }
	Stream flags. More...

Functions
dnnl_status_t DNNL_API	dnnl_stream_attr_create (dnnl_stream_attr_t *attr, dnnl_engine_kind_t kind)
dnnl_status_t DNNL_API	dnnl_stream_attr_destroy (dnnl_stream_attr_t attr)
dnnl_status_t DNNL_API	dnnl_stream_create (dnnl_stream_t *stream, dnnl_engine_t engine, unsigned flags)
dnnl_status_t DNNL_API	dnnl_stream_create_v2 (dnnl_stream_t *stream, dnnl_engine_t engine, unsigned flags, const_dnnl_stream_attr_t attr)
dnnl_status_t DNNL_API	dnnl_stream_wait (dnnl_stream_t stream)
dnnl_status_t DNNL_API	dnnl_stream_destroy (dnnl_stream_t stream)

Detailed Description

Typedef Documentation

typedef const struct dnnl_stream_attr* const_dnnl_stream_attr_t

A constant execution stream attributes handle.

typedef const struct dnnl_stream* const_dnnl_stream_t

A constant execution stream handle.

typedef struct dnnl_stream_attr* dnnl_stream_attr_t

An execution stream attributes handle.

typedef struct dnnl_stream* dnnl_stream_t

An execution stream handle.

Enumeration Type Documentation

enum dnnl_stream_flags_t

Stream flags.

Enumerator
dnnl_stream_default_order	Default order execution. Either in-order or out-of-order depending on the runtime.
dnnl_stream_in_order	In-order execution.
dnnl_stream_out_of_order	Out-of-order execution.
dnnl_stream_default_flags	Default stream configuration.

Function Documentation

dnnl_status_t DNNL_API dnnl_stream_attr_create	(	dnnl_stream_attr_t *	attr,
		dnnl_engine_kind_t	kind
	)

Creates execution stream attributes for a stream that runs on an engine of a particular kind.

Parameters

attr	Output execution stream attributes.
kind	Target engine kind.

Returns

dnnl_success on success and a status describing the error otherwise.

dnnl_status_t DNNL_API dnnl_stream_attr_destroy

(

dnnl_stream_attr_t

attr

)

Destroys execution stream attributes.

Parameters

attr	Execution stream attributes to destroy.

Returns

dnnl_success on success and a status describing the error otherwise.

dnnl_status_t DNNL_API dnnl_stream_create	(	dnnl_stream_t *	stream,
		dnnl_engine_t	engine,
		unsigned	flags
	)

Creates an execution stream.

Parameters

stream	Output execution stream.
engine	Engine to create the execution stream on.
flags	Stream behavior flags (

See also

dnnl_stream_flags_t).

Returns

dnnl_success on success and a status describing the error otherwise.

dnnl_status_t DNNL_API dnnl_stream_create_v2	(	dnnl_stream_t *	stream,
		dnnl_engine_t	engine,
		unsigned	flags,
		const_dnnl_stream_attr_t	attr
	)

Creates an execution stream.

Parameters

stream	Output execution stream.
engine	Engine to create the execution stream on.
flags	Stream behavior flags (

See also

dnnl_stream_flags_t).

Parameters

attr	Stream attributes.

Returns

dnnl_success on success and a status describing the error otherwise.

dnnl_status_t DNNL_API dnnl_stream_destroy

(

dnnl_stream_t

stream

)

Destroys an execution stream.

Parameters

stream

Execution stream to destroy.

Returns

dnnl_success on success and a status describing the error otherwise.

dnnl_status_t DNNL_API dnnl_stream_wait

(

dnnl_stream_t

stream

)

Waits for all primitives in the execution stream to finish computations.

Parameters

stream

Execution stream.

Returns

dnnl_success on success and a status describing the error otherwise.