User Manual

Rev 1.50
Mellanox Technologies
43
Appendix C: Debug Utilities
C.1 itrace Utility
C.1.1 Overview
The itrace utility extracts and prints trace messages generated by the embedded iRISC processors
of Mellanox Technologies’ InfiniBand or Ethernet adapter devices. These trace messages inform
developers of software drivers about internal status, events, critical errors, etc., for each iRISC.
Trace messages generated by iRISCs are stored in the trace buffer. The trace buffer is located in
host memory for MemFree adapter cards (i.e., without on-board memory), and in adapter memory
for adapter cards with on-board memory.
The utility is a command line application controlled by command line parameters. It prints trace
messages in text format to the console.
For more details, see the QUERY_DEBUG_MESSAGE command interface description in the
device’s Programmer’s Reference Manual available via https://docs.mellanox.com (requires a cus-
tomer login account).
C.1.2 Operation
In order to print the firmware traces, it is required that
y Debug firmware is burnt and loaded to the device
y The driver is up. Specifically, this means that
 For adapters with on-board memory: The SYS_ENABLE command has been executed
 For adapters without on-board memory (MemFree): The RUN_FW command has been
executed
y The desired trace mask is set (see the -m flag below)
The MST driver must be started prior to running itrace tool. To start itrace:
1. Start the MST driver (mst start
1
or mst restart
1
).
2. Enter the following command:
where:
IRISC_NAME – is the iRISC for which traces are to be printed. This can be specified once any-
where in the command line as a special option without the leading hyphen. Run ‘itrace -h’ to get
a list of iRISC names for each adapter device.
[options] can specify any of the following:
-h, --help – Displays help about itrace usage.
-m, --mask=TRACE_MASK– Sets the Trace Mask.
1. This step in not required in Windows.
itrace [options...] IRISC_NAME