Skip to content

Commit

Permalink
librdmacm/cmtime: Update man page to reflect latest updates
Browse files Browse the repository at this point in the history
Signed-off-by: Sean Hefty <[email protected]>
  • Loading branch information
Sean Hefty committed Apr 9, 2024
1 parent 2dfdf32 commit 212da56
Showing 1 changed file with 28 additions and 3 deletions.
31 changes: 28 additions & 3 deletions librdmacm/man/cmtime.1
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,35 @@ cmtime \- RDMA CM connection steps timing test.
.nf
\fIcmtime\fR [-s server_address] [-b bind_address]
[-c connections] [-p port_number]
[-q base_qpn]
[-r retries] [-t timeout_ms]
.fi
.SH "DESCRIPTION"
Determines min and max times for various "steps" in RDMA CM
Determines min, max, and average times for various "steps" in RDMA CM
connection setup and teardown between a client and server
application.

"Steps" that are timed are: create id, bind address, resolve address,
resolve route, create qp, connect, disconnect, and destroy.
"Steps" that are timed are: create ID, bind address, resolve address,
resolve route, create QP, modify QP to INIT, modify QP to RTR,
modify QP to RTS, CM connect, client establish, disconnect, destroy QP,
and destroy ID.

Many operations are asynchronous, allowing progress on multiple connections
simultanesously. The 'sum' output adds the time that all connections took
for a given step. The average 'us/conn' is the sum divided by the number
of connections. This is useful to identify steps which take a significant
amount of time. The min and max values are the smallest and largest times
that any single connection took to complete a given step.

The 'total' and 'avg/iter' times measure the time to complete a given step
for all connections. These two values take into account asynchronous
operations. For steps which are serial, the total and sum values will be
roughly the same. For asynchronous steps, the total may be significantly
lower than the sum, as multiple connections will be in progress simultanesously.
The avg/iter is the total time divided by the number of connections.

In many cases, times may not be available or only available on the client.
Is such situations, the output will show 0.
.SH "OPTIONS"
.TP
\-s server_address
Expand All @@ -33,6 +53,11 @@ server. (default 100)
\-p port_number
The server's port number.
.TP
\-q base_qpn
The first QP number to use when creating connections without allocating
hardware QPs. The test will use the values between base_qpn and base_qpn
plus connections when connecting. (default 1000)
.TP
\-r retries
Number of retries when resolving address or route. (default 2)
.TP
Expand Down

0 comments on commit 212da56

Please sign in to comment.