RDMA-STATISTIC(8)

💖 rdma-statistic — RDMA statistic counter configuration 💖

okay bestie, sit down, hydrate, and let me tell you about rdma-statistic, which lives in the Linux manual, section 8 (that's the admin-tools girlies). It's the rdma subcommand that handles all your statistic counter configuration. yes. counters. we're doing counters today. slay. ✨

---

🎀 NAME 🎀

rdma-statistic — RDMA statistic counter configuration. that's it, that's the whole name, she's concise and she knows it. 💅

---

🌸 SYNOPSIS 🌸

rdma [ OPTIONS ] statistic { COMMAND | help }

rdma statistic { OBJECT } show

rdma statistic [ OBJECT ] show link [ DEV/PORT_INDX ] [ FILTER_NAME
        FILTER_VALUE ]

rdma statistic OBJECT mode

rdma statistic OBJECT set COUNTER_SCOPE [ DEV/PORT_INDEX ] auto {
        CRITERIA | off } [ optional-counters | on/off ]

rdma statistic OBJECT bind COUNTER_SCOPE [ DEV/PORT_INDEX ] [ OBJECT-ID
        ] [ COUNTER-ID ]

rdma statistic OBJECT unbind COUNTER_SCOPE [ DEV/PORT_INDEX ] [ COUNTER-
        ID ] [ OBJECT-ID ]

rdma statistic mode [ supported ] link [ DEV/PORT_INDEX ]

rdma statistic set link [ DEV/PORT_INDEX ] optional-counters [ OPTIONAL-
        COUNTERS ]

rdma statistic unset link [ DEV/PORT_INDEX ] optional-counters

COUNTER_SCOPE := { link | dev }

OBJECT := { qp | mr }

CRITERIA := { type | pid }

FILTER_NAME := { cntn | lqpn | pid | qp-type }

look at her. gorgeous. every line exactly where it should be. no notes. 🦋

---

🌈 DESCRIPTION 🌈

✨ rdma statistic [object] show — display RDMA statistics ✨

she queries the RDMA device you point her at for RDMA statistics and driver-specific statistics. if you don't specify an object, you just get the default hw counters. simple. iconic. 🫶

• DEV — specifies counters on this RDMA device to show.
• PORT_INDEX — specifies counters on this RDMA port to show.
• FILTER_NAME — specifies a filter to show only the results matching it.

✨ rdma statistic <object> set — configure counter statistic auto-mode for a specific device/port ✨

in auto mode, every object that belongs to one category gets bound automatically to a single counter set. and listen — the "off" setting is global for all auto modes together. not per-mode. all of them. together. noted. 📝 also: not applicable for MR's. sorry to the MR girlies, this one's not for you.

✨ rdma statistic <object> bind — manually bind an object (e.g., a qp) with a counter ✨

when it's bound, the statistics of that object show up in that counter. that's the whole vibe. 🎀 and again — not applicable for MR's.

✨ rdma statistic <object> unbind — manually unbind an object (e.g., a qp) from the counter previously bound ✨

once unbound, the statistics of that object are no longer available in that counter. and here's the tea 🍵: if the object id isn't specified, then all objects on this counter will be unbound. all of them. bye. and yep — not applicable for MR's.

• COUNTER-ID — specifies the id of the counter to be bound. if you leave this argument out, a new counter will be allocated for you. so generous.

✨ rdma statistic mode ✨

displays the enabled optional counters for each link. 💚

✨ rdma statistic mode supported ✨

displays the supported optional counters for each link. different list, bestie, don't mix them up.

✨ rdma statistic set ✨

enables a set of optional counters for a specific device/port.

• OPTIONAL-COUNTERS — specifies the name of the optional counters to enable. any optional counters you don't name will be disabled. and heads up: optional counters are driver-specific. so what works on one driver might not exist on another. iykyk.

✨ rdma statistic unset ✨

disables all optional counters for a specific device/port. every single one. no survivors. 💀

---

🔥 EXAMPLES 🔥

okay this is the part where it all clicks. read every single one, they're all little treasures:

• rdma statistic show shows the state of the default counter of all RDMA devices on the system.
• rdma statistic show link mlx5_2/1 shows the state of the default counter of specified RDMA port.
• rdma statistic qp show shows the state of all qp counters of all RDMA devices on the system.
• rdma statistic qp show link mlx5_2/1 shows the state of all qp counters of specified RDMA port.
• rdma statistic qp show link mlx5_2 pid 30489 shows the state of all qp counters of specified RDMA port and belonging to pid 30489.
• rdma statistic qp show link mlx5_2 qp-type UD shows the state of all qp counters of specified RDMA port and with QP type UD.
• rdma statistic qp mode list current counter mode on all devices.
• rdma statistic qp mode link mlx5_2/1 list current counter mode of device mlx5_2 port 1.
• rdma statistic qp set link mlx5_2/1 auto type on on device mlx5_2 port 1, for each new user QP bind it with a counter automatically. per counter for QPs with same qp type.
• rdma statistic qp set link mlx5_2/1 auto type on optional-counters on on device mlx5_2 port 1, for each new user QP bind it with a counter automatically. per counter for QPs with same qp type. whilst also binding the currently enabled optional-counters.
• rdma statistic qp set link mlx5_2/1 auto pid on on device mlx5_2 port 1, for each new user QP bind it with a counter automatically. per counter for QPs with same pid.
• rdma statistic qp set link mlx5_2/1 auto pid,type on on device mlx5_2 port 1, for each new user QP bind it with a counter automatically. per counter for QPs with same pid and same type.
• rdma statistic qp set link mlx5_2/1 auto off turn-off auto mode on device mlx5_2 port 1. the allocated counters can be manually accessed.
• rdma statistic qp bind link mlx5_2/1 lqpn 178 on device mlx5_2 port 1, allocate a counter and bind the specified qp on it.
• rdma statistic qp unbind link mlx5_2/1 cntn 4 lqpn 178 on device mlx5_2 port 1, bind the specified qp on the specified counter.
• rdma statistic qp unbind link mlx5_2/1 cntn 4 on device mlx5_2 port 1, unbind all QPs on the specified counter. after that this counter will be released automatically by the kernel.
• rdma statistic show mr list all currently allocated MR's and their counters.
• rdma statistic show mr mrn 6 dump a specific MR statistics with mrn 6. dumps nothing if it does not exist.
• rdma statistic mode link mlx5_2/1 display the optional counters that were enabled on mlx5_2/1.
• rdma statistic mode supported link mlx5_2/1 display the optional counters that mlx5_2/1 supports.
• rdma statistic set link mlx5_2/1 optional-counters cc_rx_ce_pkts,cc_rx_cnp_pkts enable the cc_rx_ce_pkts,cc_rx_cnp_pkts counters on device mlx5_2 port 1.
• rdma statistic unset link mlx5_2/1 optional-counters disable all the optional counters on device mlx5_2 port 1.

---

💜 SEE ALSO 💜

go read her friends, they're all serving:

• rdma(8)
• rdma-dev(8)
• rdma-link(8)
• rdma-resource(8)

---

👑 AUTHORS 👑

the literal legends who made this happen, bow down:

• Mark Zhang <markz@mellanox.com>
• Erez Alfasi <ereza@mellanox.com>
• Neta Ostrovsky <netao@nvidia.com>

---

and that's the whole page, bestie 🫶 she's from iproute2, dated 27 June 2019, and honestly? she ate and left no crumbs. go forth and count your statistics. periodt. ✨💅🎀