Function: push

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

Records the start time of the time span by msproftx when an event occurs.

After this API is called, the Profiling tool automatically records the start timestamp in stamp and sets the event type to Push or Pop.

Prototype

C Prototype
1
aclError aclprofPush(void *stamp)
Python Function
1
ret = acl.prof.push(stamp)

Parameters

Parameter	Description
stamp	Int, stamp pointer address, indicating the msproftx event stamp. Specifies the pointer address of the acl.prof.create_stamp API.

Return Value

Return Value	Description
ret	Int, error code. 0 indicates success. Other values indicate failure.

Restrictions

This API must be used in pair with Function: pop to indicate the start and end time of a time span.
Cross-thread calls are not supported. You can use the Function: range_start and Function: range_stop pair as an alternative.
This API must be called between Function: create_stamp and Function: destroy_stamp.

Parent topic: msproftx Extended APIs