Function: create_event_ex_with_flag

Applicability

Product	Supported
Atlas 350 Accelerator Card	√
Atlas A3 training product/Atlas A3 inference product	√
Atlas A2 training product/Atlas A2 inference product	√
Atlas training product	√
Atlas inference product	√
Atlas 200I/500 A2 inference product	√

Description

Creates an event with a flag. Events with different flags are used for different functions. When an event is created, multiple flags can be carried (bitwise OR operation) to enable the corresponding flag function. Event resources are not restricted by hardware for the creation of events.

Prototype

C Prototype

aclError aclrtCreateEventExWithFlag(aclrtEvent *event, uint32_t flag)

Python Function

event, ret = acl.rt.create_event_ex_with_flag(flag)

Parameters

Parameter	Description
flag	Int, event pointer flag. The options are as follows: ACL_EVENT_TIME_LINE = 0x00000008 indicates that the number of created events is not limited, and the created events can be used to compute the elapsed time between events. ACL_EVENT_SYNC = 0x00000001 indicates that the number of created events is limited, and the created events can be used for synchronization between multiple streams. ACL_EVENT_CAPTURE_STREAM_PROGRESS = 0x00000002 indicates that the created event is used to trace the task execution progress of the stream.

Parameter

Description

flag

Int, event pointer flag. The options are as follows:

ACL_EVENT_TIME_LINE = 0x00000008 indicates that the number of created events is not limited, and the created events can be used to compute the elapsed time between events.
ACL_EVENT_SYNC = 0x00000001 indicates that the number of created events is limited, and the created events can be used for synchronization between multiple streams.
ACL_EVENT_CAPTURE_STREAM_PROGRESS = 0x00000002 indicates that the created event is used to trace the task execution progress of the stream.

Return Value

Return Value	Description
event	Int, pointer address of the created event object.
ret	Int, error code. 0 on success; else, failure.

Restrictions

Events created using this API cannot be used in the following APIs: acl.rt.reset_event, acl.rt.query_event, and acl.rt.query_event_wait_status.
When this API is called to create an event, flag is a bitmap. Operations can be performed on a single flag or multiple flags, for example, acl.rt.create_event_ex_with_flag( ACL_EVENT_TIME_LINE | ACL_EVENT_SYNC).
- If the value of flag contains ACL_EVENT_SYNC, the system allocates event resources only when acl.rt.record_event is called. Therefore, the number of events is limited. After the number of events reaches the upper limit, the system waits for resource release.
  Limit on the number of events:
  
  For the Atlas inference product, a single device supports a maximum of 1,023 events.
  
  For the Atlas 200I/500 A2 inference product, a single device supports a maximum of 65,536 events.
  
  For the Atlas training product, a single device supports a maximum of 65,535 events.
  
  For the Atlas A2 training product/Atlas A2 inference product, a single device supports a maximum of 65,536 events.
  
  For the Atlas A3 training product/Atlas A3 inference product, a single device supports a maximum of 65,536 events.
- If the value of flag does not contain ACL_EVENT_SYNC, the event created by this API cannot be used in the acl.rt.stream_wait_event API.

Parent topic: Event Management