1 .\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
2 .TH "RIOSTREAM" 1 "2012-10-24" "librdmacm" "librdmacm" librdmacm
4 riostream \- zero-copy streaming over RDMA ping-pong test.
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]
13 Uses the streaming over RDMA protocol (rsocket) to connect and exchange
14 data between a client and server application.
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.
23 The local network address to bind to.
26 Indicates the size of the send and receive network buffers.
29 The number of times that the specified number of messages will be
30 exchanged between the client and server. (default 1000)
33 The number of messages to transfer from the client to the server and
34 back again on each iteration. (default 1)
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.
41 The server's port number.
44 Specifies test parameters. Available options are:
46 a | async - uses asynchronous operation (e.g. select / poll)
48 b | blocking - uses blocking calls
50 n | nonblocking - uses non-blocking calls
52 v | verify - verifies data transfers
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
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.