contrib/ofed/librdmacm/man/cmtime.1

   1 .\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
   2 .TH "CMTIME" 1 "2017-04-28" "librdmacm" "librdmacm" librdmacm
   3 .SH NAME
   4 cmtime \- RDMA CM connection steps timing test.
   5 .SH SYNOPSIS
   6 .sp
   7 .nf
   8 \fIcmtime\fR [-s server_address] [-b bind_address]
   9                         [-c connections] [-p port_number]
  10                         [-r retries] [-t timeout_ms]
  11 .fi
  12 .SH "DESCRIPTION"
  13 Determines min and max times for various "steps" in RDMA CM
  14 connection setup and teardown between a client and server
  15 application.
  16
  17 "Steps" that are timed are: create id, bind address, resolve address,
  18 resolve route, create qp, connect, disconnect, and destroy.
  19 .SH "OPTIONS"
  20 .TP
  21 \-s server_address
  22 The network name or IP address of the server system listening for
  23 connections.  The used name or address must route over an RDMA device.
  24 This option must be specified by the client.
  25 .TP
  26 \-b bind_address
  27 The local network address to bind to.
  28 .TP
  29 \-c connections
  30 The number of connections to establish between the client and
  31 server.  (default 100)
  32 .TP
  33 \-p port_number
  34 The server's port number.
  35 .TP
  36 \-r retries
  37 Number of retries when resolving address or route.  (default 2)
  38 .TP
  39 \-t timeout_ms
  40 Timeout in millseconds (ms) when resolving address or
  41 route.  (default 2000 - 2 seconds)
  42 .SH "NOTES"
  43 Basic usage is to start cmtime on a server system, then run
  44 cmtime -s server_name on a client system.
  45 .P
  46 Because this test maps RDMA resources to userspace, users must ensure
  47 that they have available system resources and permissions.  See the
  48 libibverbs README file for additional details.
  49 .SH "SEE ALSO"
  50 rdma_cm(7)