Function: range_start

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 Start or Stop. The tool also generates a unique process ID, and saves the stamp in a map maintained by process.

Prototype

C Prototype

aclError aclprofRangeStart(void *stamp, uint32_t *rangeId)

Python Function

range_id, ret = acl.prof.range_start(stamp)

Parameters

Parameter	Description
stamp	Int, stamp pointer address, indicating the msproftx event stamp. This specifies the pointer to the Function: create_stamp API.

Return Value

Return Value	Description
range_id	Int, unique ID of a msproftx event stamp. Used to distinguish between threads.
ret	Int, error code. 0 indicates success. Other values indicate failure.

Description

range_id

Int, unique ID of a msproftx event stamp. Used to distinguish between threads.

ret

Int, error code.

0 indicates success.
Other values indicate failure.

Restrictions

This API must be used in pair with Function: range_stop to indicate the start and end time of a time span.
Cross-thread calls are supported.
This API must be called between Function: create_stamp and Function: destroy_stamp.

Parent topic: msproftx Extended APIs