|
1 '\" t |
|
2 .\" Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved. |
|
3 .\" Modified for Solaris to add the Solaris stability classification, |
|
4 .\" and to add a note about source availability. |
|
5 .\" |
|
6 .TH IB_SEND_BW/IB_SEND_LAT 1 " Oct 15, 2011" |
|
7 .SH "NAME" |
|
8 ib_send_bw, ib_send_lat - Bandwith and latency test using send transactions. |
|
9 .PP |
|
10 .SH SYNOPSIS |
|
11 .HP |
|
12 .nf |
|
13 ib_send_bw [-p, --port=<port>] [-d, --ib-dev=<dev>] |
|
14 [-i, --ib-port=<port number.] [-c, --connection=<RC|UD>] |
|
15 [-m, --mtu=<mtu>] [-s, --size=<size>] [-a, --all] |
|
16 [-n, --iters=<iterations>] [-t, --tx-depth=<depth>] |
|
17 [-u, --qp-timeout=<timeout] [-S, --sl=<sl>] |
|
18 [-x, --gid-index=<index>] [-F, --CPU-freq] [-V, --version] |
|
19 [-r, --rx-depth=<depth>] [-I, --inline_size=<size>] |
|
20 [-b, --bidirectional] [-e, --events] [-N, --no peak-bw] |
|
21 [-g, --mcg=<num>] [-M, --MGID=<multicast_gid>] [server] |
|
22 .fi |
|
23 .HP |
|
24 |
|
25 .nf |
|
26 ib_send_lat [-p, --port=<port>] [-d, --ib-dev=<dev>] |
|
27 [-i, --ib-port=<port number.] [-c, --connection=<RC|UD>] |
|
28 [-m, --mtu=<mtu>] [-s, --size=<size>] [-a, --all] |
|
29 [-n, --iters=<iterations>] [-t, --tx-depth=<depth>] |
|
30 [-u, --qp-timeout=<timeout] [-S, --sl=<sl>] |
|
31 [-x, --gid-index=<index>] [-F, --CPU-freq] [-V, --version] |
|
32 [--I, --inline_size=<size>] [-e, --events] |
|
33 [-g, --mcg=<num>] [-M, --MGID=<multicast_gid>] |
|
34 [-C, --report-cycles] [-H, --report-histogram] |
|
35 [-U, --report-unsorted] [server] |
|
36 .fi |
|
37 |
|
38 |
|
39 .SH DESCRIPTION |
|
40 .PP |
|
41 .Nm |
|
42 The ib_send_bw and ib_send_lat tests are part of the "perftest" utilities that are used for InfiniBand related performance testing. The "perftest" utilities are micro bench mark utilities. |
|
43 |
|
44 .PP |
|
45 First a passive receiving instance is started. |
|
46 .RS 12 |
|
47 |
|
48 #ib_send_bw |
|
49 .RE |
|
50 .PP |
|
51 Then an active sending instance is started, giving it the address at which it will find a listening passive receiver. |
|
52 .PP |
|
53 .RS 12 |
|
54 #ib_send_bw server |
|
55 .RE |
|
56 .PP |
|
57 If options are used then the same options must be used for both client and server. |
|
58 .PP |
|
59 .SH OPTIONS |
|
60 .PP |
|
61 The following options are available for use on the command line: |
|
62 |
|
63 .TP 7 |
|
64 \fB\-p, --port <port> |
|
65 Listen on/connect to port <port> (default 18515) |
|
66 .TP |
|
67 \fB\-d, --ib-dev <dev> |
|
68 Use IB device <dev> (default first device found) |
|
69 .TP |
|
70 \fB\-i, --ib-port <port number> |
|
71 Use port <port number> of IB device (default 1) |
|
72 .TP |
|
73 \fB\-c, --connection <RC|UD> |
|
74 Connection type RC or UD (default RC) |
|
75 .TP |
|
76 \fB\-m, --mtu <mtu>s |
|
77 Mtu size : 256 - 4096 (default port mtu) |
|
78 .TP |
|
79 \fB\-s, --size <size> |
|
80 Size of message to exchange (default 2) |
|
81 .TP |
|
82 \fB\-a, --all |
|
83 Run sizes from 2 till 2^23 |
|
84 .TP |
|
85 \fB\-n, --iters <iterations> |
|
86 Number of exchanges (at least 5, default 1000) |
|
87 .TP |
|
88 \fB\-t, --tx-depth <depth> |
|
89 Size of tx queue (default 50) |
|
90 .TP |
|
91 \fB\-u, --qp-timeout <timeout> |
|
92 QP timeout, timeout value is 4 usec * 2 ^(timeout), default 14 |
|
93 .TP |
|
94 \fB\-S, --sl <sl> |
|
95 SL (default 0) |
|
96 .TP |
|
97 \fB\-x, --gid-index <index> |
|
98 Test uses GID with GID index (Default : IB - no gid) |
|
99 .TP |
|
100 \fB\-F, --CPU-freq |
|
101 Do not fail even if cpufreq_ondemand module is loaded |
|
102 .TP |
|
103 \fB\-V, --version |
|
104 Display version number |
|
105 .TP |
|
106 \fB\-I, --inline_size <size> |
|
107 Max size of message to be sent in inline (default 0) |
|
108 .TP |
|
109 \fB\-e, --events |
|
110 Sleep on CQ events (default poll) |
|
111 .TP |
|
112 \fB\-g, --mcg=<num_of_qps> |
|
113 Send messages to multicast group with <num_of_qps> qps attached to it. |
|
114 .TP |
|
115 \fB\-M, --MGID=<multicast_gid> |
|
116 In multicast, uses <multicast_gid> as the group MGID |
|
117 .TP |
|
118 \fB\-b, --bidirectional |
|
119 Measure bidirectional bandwidth (default unidirectional) |
|
120 .TP |
|
121 \fB\-N, --no peak-bw |
|
122 Cancel peak-bw calculation (default with peak) |
|
123 .TP |
|
124 \fB\-C, --report-cycles |
|
125 report times in cpu cycle units (default microseconds) |
|
126 .TP |
|
127 \fB\-H, --report-histogram |
|
128 Print out all results (default print summary only) |
|
129 .TP |
|
130 \fB\-U, --report-unsorted |
|
131 (implies -H) print out unsorted results (default sorted) |
|
132 .PP |
|
133 .SH SEE ALSO |
|
134 ib_write_bw(1), ib_write_lat(1), rdma_lat(1), ib_read_bw(1), rdma_bw(1), ib_read_lat(1), ib_send_lat(1), ib_clock_test(1), ib_write_bw_post_list(1) |