contrib/ofed/librdmacm/man/riostream.1

   1 .\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
   2 .TH "RIOSTREAM" 1 "2012-10-24" "librdmacm" "librdmacm" librdmacm
   3 .SH NAME
   4 riostream \- zero-copy streaming over RDMA ping-pong test.
   5 .SH SYNOPSIS
   6 .sp
   7 .nf
   8 \fIriostream\fR [-s server_address] [-b bind_address] [-B buffer_size]
   9                         [-I iterations] [-C transfer_count]
  10                         [-S transfer_size] [-p server_port] [-T test_option]
  11 .fi
  12 .SH "DESCRIPTION"
  13 Uses the streaming over RDMA protocol (rsocket) to connect and exchange
  14 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 \-I iterations
  29 The number of times that the specified number of messages will be
  30 exchanged between the client and server.  (default 1000)
  31 .TP
  32 \-C transfer_count
  33 The number of messages to transfer from the client to the server and
  34 back again on each iteration.  (default 1)
  35 .TP
  36 \-S transfer_size
  37 The size of each send transfer, in bytes.  (default 1000)  If 'all'
  38 is specified, rstream will run a series of tests of various sizes.
  39 .TP
  40 \-p server_port
  41 The server's port number.
  42 .TP
  43 \-T test_option
  44 Specifies test parameters.  Available options are:
  45 .P
  46 a | async - uses asynchronous operation (e.g. select / poll)
  47 .P
  48 b | blocking - uses blocking calls
  49 .P
  50 n | nonblocking - uses non-blocking calls
  51 .P
  52 v | verify - verifies data transfers
  53 .SH "NOTES"
  54 Basic usage is to start riostream on a server system, then run
  55 riostream -s server_name on a client system.  By default, riostream
  56 will run a series of latency and bandwidth performance tests.
  57 Specifying a different iterations, transfer_count, or transfer_size
  58 will run a user customized test using default values where none
  59 have been specified.
  60 .P
  61 Because this test maps RDMA resources to userspace, users must ensure
  62 that they have available system resources and permissions.  See the
  63 libibverbs README file for additional details.
  64 .SH "SEE ALSO"
  65 rdma_cm(7) rstream(1)