contrib/ofed/librdmacm/man/rstream.1

   1 .\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
   2 .TH "RSTREAM" 1 "2011-11-16" "librdmacm" "librdmacm" librdmacm
   3 .SH NAME
   4 rstream \- streaming over RDMA ping-pong test.
   5 .SH SYNOPSIS
   6 .sp
   7 .nf
   8 \fIrstream\fR [-s server_address] [-b bind_address] [-f address_format]
   9                         [-B buffer_size] [-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 \-f address_format
  26 Supported address formats are ip, ipv6, gid, or name.
  27 .TP
  28 \-B buffer_size
  29 Indicates the size of the send and receive network buffers.
  30 .TP
  31 \-I iterations
  32 The number of times that the specified number of messages will be
  33 exchanged between the client and server.  (default 1000)
  34 .TP
  35 \-C transfer_count
  36 The number of messages to transfer from the client to the server and
  37 back again on each iteration.  (default 1000)
  38 .TP
  39 \-S transfer_size
  40 The size of each send transfer, in bytes.  (default 1000)  If 'all'
  41 is specified, rstream will run a series of tests of various sizes.
  42 .TP
  43 \-p server_port
  44 The server's port number.
  45 .TP
  46 \-T test_option
  47 Specifies test parameters.  Available options are:
  48 .P
  49 s | socket  - uses standard socket calls to transfer data
  50 .P
  51 a | async - uses asynchronous operation (e.g. select / poll)
  52 .P
  53 b | blocking - uses blocking calls
  54 .P
  55 f | fork - fork server processing (forces -T s option)
  56 .P
  57 n | nonblocking - uses non-blocking calls
  58 .P
  59 r | resolve - use rdma cm to resolve address
  60 .P
  61 v | verify - verifies data transfers
  62 .SH "NOTES"
  63 Basic usage is to start rstream on a server system, then run
  64 rstream -s server_name on a client system.  By default, rstream
  65 will run a series of latency and bandwidth performance tests.
  66 Specifying a different iterations, transfer_count, or transfer_size
  67 will run a user customized test using default values where none
  68 have been specified.
  69 .P
  70 Because this test maps RDMA resources to userspace, users must ensure
  71 that they have available system resources and permissions.  See the
  72 libibverbs README file for additional details.
  73 .SH "SEE ALSO"
  74 rdma_cm(7)