Function: range_start

Applicability

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

Function Usage

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)

Parameter Description

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

Return Value Description

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.

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.

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.

Reference

For the API call example, see Profile Data Collection.

Parent topic: msproftx Extension APIs