mstxDomainCreateA

Product Support

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

Creates a custom mstx domain.

Domain: Used to partition trace data, allowing users to manage trace data in a customized manner. Trace data without a specified domain belongs to the default domain (domain name: default). By default, all trace data belongs to the default domain.

Prototype

mstxDomainHandle_t mstxDomainCreateA(const char* id)

Parameter Description

Table 1 Parameter description

Parameter Input/Output Description
id Input Name of the domain to be created.
Data Type: const char *.
The default domain name is globalDomain.
The maximum length is 1,023 bytes. Only digits, uppercase and lowercase letters, and underscores (_) are supported.
MSPTI scenario: cannot exceed 255 bytes.
Non-MSPTI scenarios (such as the msprof command line and Ascend PyTorch Profiler): cannot exceed 1,024 bytes.

Returns

Returns a valid domain handle, indicating that the API is executed successfully; returns nullptr, indicating that the API execution fails.

Example

mstxDomainHandle_t domain = mstxDomainCreateA("sample")