1RSTREAM(1)                         librdmacm                        RSTREAM(1)
2
3
4

NAME

6       rstream - streaming over RDMA ping-pong test.
7

SYNOPSIS

9       rstream [-s server_address] [-b bind_address] [-f address_format]
10                      [-B buffer_size] [-I iterations] [-C transfer_count]
11                      [-S transfer_size] [-p server_port] [-T test_option]
12

DESCRIPTION

14       Uses the streaming over RDMA protocol (rsocket) to connect and exchange
15       data between a client and server application.
16

OPTIONS

18       -s server_address
19              The network name or IP address of the  server  system  listening
20              for  connections.   The  used name or address must route over an
21              RDMA device.  This option must be specified by the client.
22
23       -b bind_address
24              The local network address to bind to.
25
26       -f address_format
27              Supported address formats are ip, ipv6, gid, or name.
28
29       -B buffer_size
30              Indicates the size of the send and receive network buffers.
31
32       -I iterations
33              The number of times that the specified number of  messages  will
34              be exchanged between the client and server.  (default 1000)
35
36       -C transfer_count
37              The number of messages to transfer from the client to the server
38              and back again on each iteration.  (default 1)
39
40       -S transfer_size
41              The size of each send transfer, in bytes.   (default  1000)   If
42              'all'  is specified, rstream will run a series of tests of vari‐
43              ous sizes.
44
45       -p server_port
46              The server's port number.
47
48       -T test_option
49              Specifies test parameters.  Available options are:
50
51       s | socket  - uses standard socket calls to transfer data
52
53       a | async - uses asynchronous operation (e.g. select / poll)
54
55       b | blocking - uses blocking calls
56
57       f | fork - fork server processing (forces -T s option)
58
59       n | nonblocking - uses non-blocking calls
60
61       r | resolve - use rdma cm to resolve address
62
63       v | verify - verifies data transfers
64

NOTES

66       Basic usage is to start rstream on a server system, then run rstream -s
67       server_name  on a client system.  By default, rstream will run a series
68       of latency and bandwidth performance  tests.   Specifying  a  different
69       iterations, transfer_count, or transfer_size will run a user customized
70       test using default values where none have been specified.
71
72       Because this test maps RDMA resources to userspace, users  must  ensure
73       that  they  have  available  system resources and permissions.  See the
74       libibverbs README file for additional details.
75

SEE ALSO

77       rdma_cm(7)
78
79
80
81librdmacm                         2011-11-16                        RSTREAM(1)
Impressum