Function Description
When the tool is used for operator debugging, the printf and PRINTF functions are supported to print scalar data.
For CPU debugging, printf and PRINTF printing are supported. printf uses the native C++ printing, which is not controlled by the dump-mode parameter.
In the simulator debugging scenario, printf and PRINTF printing are supported, which is controlled by the dump mode parameter.
The maximum available space allocated to each core for printing data is fixed at 1 MB. If the printing size exceeds 1 MB, the printed content will not be displayed. Therefore, the amount of data to be printed needs to be controlled.
Procedure (CLI-based)
Add the printf or PRINTF statement to target positions in the kernel code as required. For details about the API description, see Table 1. The following uses PRINTF as an example:
PRINTF("1 fmt string d %d\n", 6666); PRINTF("1 fmt string lf %lf\n", float(61.556));In the simulator debugging scenario, run the following command to enable the dump function:
ascendebug kernel --backend simulator --dump-mode normal ... {other simulator debugging parameters}--Set dump-mode to normal to enable the general printing Scalar mode. Set other parameters by referring to NPU Debugging Parameters.
Check the command output. The following is an example:
API Description
The description of the printf/PRINTF API is as follows:
Prototype: template <class...Args>
- void printf(gm const char* fmt, Args&&... args);
- void PRINTF(gm const char* fmt, Args&&... args);
Function usage: Prints scalar data.
Parameter (IN):
- fmt: format control string, which contains two types of objects: common characters and conversion descriptions.
- Common characters are printed as they are.
- Conversion descriptions are not directly output. Instead, they are used to control the conversion and printing of parameters in printf. Each conversion description starts with a percent (%) character and ends with the specific conversion description, indicating the type of the output data. The following conversion types are supported:
- %d / %i: outputs decimal numbers. The supported data types for printing are bool, int8_t, int16_t, int32_t, and int64_t.
- %f: outputs real numbers. The data types that can be printed are float/half/bfloat16_t.
- %x: outputs hexadecimal integers. The supported data types for printing are int8_t, int16_t, int32_t, int64_t, uint8_t, uint16_t, uint32_t, and uint64_t.
- %s: outputs strings.
- %u: outputs unsigned data. The data types that can be printed include bool, uint8_t, uint16_t, uint32_t, and uint64_t.
- %p: outputs pointer addresses.
- args: additional arguments (an output list with variable quantities and types). Depending on the fmt string, the function may require a series of additional arguments. Each argument contains a value to be inserted and replaces each % tag specified in the fmt parameter. The number of parameters must be the same as the number of % tags.
- fmt: format control string, which contains two types of objects: common characters and conversion descriptions.
Parameter (OUT): N/A
Return value: N/A
Restrictions:
- Escape characters cannot be printed.
- Currently, the following types can be printed:
- %d/%i: decimal number.
- %f: real number.
- %x: hexadecimal integer.
- %s: string.
- %u: unsigned data.
- %p: pointer address.
Calling example:
// Integer printing: printf("fmt string %d", 0x123); PRINTF("fmt string %d", 0x123); // Pointer printing: int *a; printf("TEST %p", a); PRINTF("TEST %p", a);