This document provides instructions on the usage of the DOCA Comm Channel Admin Tool.
The Comm Channel Admin Tool is used to print a snapshot of DOCA Comch (comm channel) connections:
On the BlueField Arm side, it includes DOCA Comch servers and their current connection information
On the host side, it includes all active client connections and the server they are connected to
Only client-to-server control channels are reported; fast path producer/consumer channels are not.
The Comm Channel Admin Tool is for Linux only and requires an up-to-date BFB bundle or DOCA host packages of at least 2.7, which include in the Resource dump binary.
The Comm Channel Admin Tool can be executed on the host or Arm CPUs. By default, the tool scans all available PCIe slots to detect supported DOCA devices and reports any Comch information available.
The tool can be run on BlueField Arm or x86 host using the following command:
/opt/mellanox/doca/tools/doca_comm_channel_admin
Sample Output from BlueField Arm
On the BlueField Arm side, any active DOCA Comch servers are be reported:
The following information is available:
Server Name – the name assigned to the server
PID – the Linux process ID of the application which created the server
Connections – the number of connections active on the server out of the total allowed (e.g., 2/512 means 2 active connections of a maximum of 512)
PCIe – the PCIe address of the device which the server has been detected on
Interface Name – the interface name associated with the PCIe address
Connections may also be displayed on the BlueField Arm like on x86. This occurs if SF ports are detected here. The interface name associated with the PCIe address indicates the SF port.
Sample Output from x86
The x86 host cannot run DOCA Comch servers. Therefore, individual client connections are reported:
The following information is available:
Server Name – the name of the BlueField Arm server that a client has connected to
PID – the Linux process ID of the application running a DOCA Comch client
PCIe – the PCIe address of the BlueField networking platform which the destination server is running on
Interface Name – the interface name associated with the PCIe address