mstxDomainRangeStartA

Supported Products

Product Supported
Ascend 910_95 AI Processors
Atlas A3 training products/Atlas A3 inference products
Atlas A2 training products/Atlas A2 inference products
Atlas 200I/500 A2 inference products
Atlas inference products
Atlas training products

Function

Marks the start of a timestamp event within the specified domain.

If the passed domain has been destroyed, a warning is logged and the API no longer executes the instrumentation process.

Prototype

mstxRangeId mstxDomainRangeStartA(mstxDomainHandle_t domain, const char *message, aclrtStream stream)

Parameter Description

Table 1 Parameter description

Parameter Input/Output Description
domain Input Specified domain handle.
message Input Pointer to the message string carried by the instrumentation.
Length requirement for the incoming message string: MSPTI scenario: cannot exceed 255 bytes. Non-MSPTI scenarios (e.g., msprof command line, Ascend PyTorch Profiler): cannot exceed 156 bytes.
stream Input Stream used to execute the instrumentation task. When set to nullptr, only marks instantaneous events on the Host side. When set to a valid stream, marks instantaneous events on both the Host side and the corresponding Device side.

Returns

range_id: Identifies the range. Returns 0 if instrumentation fails or the domain has been destroyed.