set-ethernet-max-ring-buffer

Intro

Maximizing NIC Ring Buffer is a common task when the host encounters drop packets or loss of data situations on the network. However, the maximum ring buffer values can be different on different NICs.

This small utility will detect the maximum RX/TX ring buffer values and set them to those values on the specified NIC. This could save some time for engineers to investigate and set up commands for tuning ring buffer manually.

In order to make the ring buffer change permanently, please use some facilities that can ensure the command run after OS started.

I developed this utility in both C and Python versions.

Python Version

Dependencies

Following Python packages are needed:

argparse
os
re
subprocess
sys

Usage

This utility needs ethtool utility to read and set ring buffer values. So it needs superuser permission to run.

$ ./set-ethernet-max-ring-buffer.py -h
usage: set-ethernet-max-ring-buffer.py [-h] --device DEVICE

Set max TX/RX ring buffer for ethernet device

options:
  -h, --help       show this help message and exit
  --device DEVICE  Ethernet device name

Example

$ sudo ./set-ethernet-max-ring-buffer.py --device eno1
Setting RX Ring Buffer from 256 to 4096
Setting TX Ring Buffer from 256 to 4096
$ sudo ethtool -g eno1
Ring parameters for eno1:
Pre-set maximums:
RX:		4096
RX Mini:	n/a
RX Jumbo:	n/a
TX:		4096
Current hardware settings:
RX:		4096
RX Mini:	n/a
RX Jumbo:	n/a
TX:		4096

C Version

Dependencies

This C version does not need any extra command dependencies. It utilized related ETHTOOL_* ioctl commands to complete the ring buffer configuration.

Compilation

$ gcc -g -Wall -Wextra -Wpedantic -o set-ethernet-max-ring-buffer set-ethernet-max-ring-buffer.c

Usage

$ ./set-ethernet-max-ring-buffer
usage: ./set-ethernet-max-ring-buffer -d <ethernet device name>

Example

$ sudo ./set-ethernet-max-ring-buffer -d eno1
Setting RX Ring Buffer from 256 to 4096
Setting TX Ring Buffer from 256 to 4096
$ sudo ethtool -g eno1
Ring parameters for eno1:
Pre-set maximums:
RX:             4096
RX Mini:        n/a
RX Jumbo:       n/a
TX:             4096
Current hardware settings:
RX:             4096
RX Mini:        n/a
RX Jumbo:       n/a
TX:             4096

Reference

Monitoring and tuning the RX ring buffer

Queueing in the Linux Network Stack

meow-watermelon / set-ethernet-max-ring-buffer Goto Github PK