Usage

Preconditions

1. Mellanox Network Card Recognition: Confirm that your system recognizes the Mellanox network cards by executing the command lspci | grep Mellanox. This step ensures that the network cards are correctly detected and available for XLIO.
2. XLIO Library Installation: Install the XLIO library correctly on the system by following the instructions.
3. Tune the machine's performance using the Performance Tuning Guide.
4. Client-Server Setup: Set up two machines, one acting as a client and the other as a server, to test the XLIO library's performance. Ensure the machines are connected with Mellanox network cards to use the library's capabilities fully.
5. IP Configuration: Configure the IP addresses and subnets to establish end-to-end connectivity between the client and server. Verify that you have a functional ping between the machines to ensure successful communication.

By fulfilling these preconditions, you can proceed confidently, leveraging the XLIO library to enhance network performance and efficiency between your client and server machines with Mellanox network cards. Follow the performance tuning guide to optimize the throughput and minimize latency, resulting in a robust and high-performing network setup.

Usage example

Basic usage

# Without XLIO
iperf3 -c <server IP address> -p <server port number>

# Without XLIO
sudo LD_PRELOAD=<relative or absolute libxlio.so path> iperf3 -c <server IP address> -p <server port number>

# Configure the NUMA and set the affinity masks
sudo LD_PRELOAD=<relative or absolute libxlio.so path> numactl --cpunodebind=1 taskset -c 29,25 iperf3 -c <server IP address> -p <server port number>

The throughput with XLIO should be better out of the box.