contrib/ofed/librdmacm/man/udpong.1

   1 .\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
   2 .TH "UDPONG" 1 "2017-04-28" "librdmacm" "librdmacm" librdmacm
   3 .SH NAME
   4 udpong \- unreliable datagram streaming over RDMA ping-pong test.
   5 .SH SYNOPSIS
   6 .sp
   7 .nf
   8 \fIudpong\fR [-s server_address] [-b bind_address]
   9                         [-B buffer_size] [-C transfer_count]
  10                         [-S transfer_size] [-p server_port] [-T test_option]
  11 .fi
  12 .SH "DESCRIPTION"
  13 Uses unreliable datagram streaming over RDMA protocol (rsocket) to
  14 connect and exchange data between a client and server application.
  15 .SH "OPTIONS"
  16 .TP
  17 \-s server_address
  18 The network name or IP address of the server system listening for
  19 connections.  The used name or address must route over an RDMA device.
  20 This option must be specified by the client.
  21 .TP
  22 \-b bind_address
  23 The local network address to bind to.
  24 .TP
  25 \-B buffer_size
  26 Indicates the size of the send and receive network buffers.
  27 .TP
  28 \-C transfer_count
  29 The number of messages to transfer from the client to the server and
  30 back again on each iteration.  (default 1000)
  31 .TP
  32 \-S transfer_size
  33 The size of each send transfer, in bytes.  (default 1000)
  34 .TP
  35 \-p server_port
  36 The server's port number.
  37 .TP
  38 \-T test_option
  39 Specifies test parameters.  Available options are:
  40 .P
  41 s | socket  - uses standard socket calls to transfer data
  42 .P
  43 a | async - uses asynchronous operation (e.g. select / poll)
  44 .P
  45 b | blocking - uses blocking calls
  46 .P
  47 n | nonblocking - uses non-blocking calls
  48 .P
  49 e | echo - server echoes all messages
  50 .SH "NOTES"
  51 Basic usage is to start udpong on a server system, then run
  52 udpong -s server_name on a client system.  udpong
  53 will run a series of latency and bandwidth performance tests.
  54 Specifying a different transfer_count or transfer_size
  55 will run a user customized test using default values where none
  56 have been specified.
  57 .P
  58 Because this test maps RDMA resources to userspace, users must ensure
  59 that they have available system resources and permissions.  See the
  60 libibverbs README file for additional details.
  61 .SH "SEE ALSO"
  62 rdma_cm(7)