Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Thursday, June 13, 2019
 
 

ib_read_bw (1)

Name

ib_read_bw - Bandwith and latency test using RDMA read transactions.

Synopsis

ib_read_bw [-p, --port=<port>] [-d, --ib-dev=<dev>]
[-i, --ib-port=<port number.] [-c, --connection=<RC|UD>]
[-m, --mtu=<mtu>] [-s, --size=<size>] [-a, --all]
[-n, --iters=<iterations>] [-t, --tx-depth=<depth>]
[-u, --qp-timeout=<timeout] [-S, --sl=<sl>]
[-x, --gid-index=<index>] [-F, --CPU-freq] [-V, --version]
[-b, --bidirectional] [-e, --events] [-N, --no peak-bw]
[-o, --outs=<num>] [server]



ib_read_lat [-p, --port=<port>] [-d, --ib-dev=<dev>]
[-i, --ib-port=<port number.] [-c, --connection=<RC|UD>]
[-m, --mtu=<mtu>] [-s, --size=<size>] [-a, --all]
[-n, --iters=<iterations>] [-t, --tx-depth=<depth>]
[-u, --qp-timeout=<timeout] [-S, --sl=<sl>]
[-x, --gid-index=<index>] [-F, --CPU-freq] [-V, --version]
[-e, --events] [-o, --outs=<num>] [-C, --report-cycles]
[-H, --report-histogram] [-U, --report-unsorted] [server]

Description

IB_READ_BW(1)(1)            General Commands Manual           IB_READ_BW(1)(1)



NAME
       ib_read_bw,  ib_read_lat  -  Bandwith  and latency test using RDMA read
       transactions.

SYNOPSIS

              ib_read_bw [-p, --port=<port>] [-d, --ib-dev=<dev>]
                    [-i, --ib-port=<port number.] [-c, --connection=<RC|UD>]
                    [-m, --mtu=<mtu>] [-s, --size=<size>] [-a, --all]
                    [-n, --iters=<iterations>] [-t, --tx-depth=<depth>]
                    [-u, --qp-timeout=<timeout] [-S, --sl=<sl>]
                    [-x, --gid-index=<index>] [-F, --CPU-freq] [-V, --version]
                    [-b, --bidirectional] [-e, --events] [-N, --no peak-bw]
                    [-o, --outs=<num>] [server]



              ib_read_lat [-p, --port=<port>] [-d, --ib-dev=<dev>]
                    [-i, --ib-port=<port number.] [-c, --connection=<RC|UD>]
                    [-m, --mtu=<mtu>] [-s, --size=<size>] [-a, --all]
                    [-n, --iters=<iterations>] [-t, --tx-depth=<depth>]
                    [-u, --qp-timeout=<timeout] [-S, --sl=<sl>]
                    [-x, --gid-index=<index>] [-F, --CPU-freq] [-V, --version]
                    [-e, --events] [-o, --outs=<num>] [-C, --report-cycles]
                    [-H, --report-histogram] [-U, --report-unsorted] [server]



DESCRIPTION
       The ib_read_bw and ib_read_lat tests are part of the "perftest"  utili-
       ties  that   are  used  for  InfiniBand  related  performance  testing.
       The "perftest" utilities are micro bench mark utilities.


       First a passive receiving instance is started.

                        #ib_read_bw

       Then an active sending instance is started, giving it  the  address  at
       which it will find a listening passive receiver.

                        #ib_read_bw server

       If options are used then the same options must be  used for both client
       and server.

OPTIONS
       The following options are available for use on the command line:


       -p, --port  <port>
              Listen on/connect to port <port> (default 18515)

       -d, --ib-dev <dev>
              Use IB device <dev> (default first device found)

       -i, --ib-port <port number>
              Use port <port number> of IB device (default 1)

       -c, --connection <RC|UD>
               Connection type RC or UD (default RC)

       -m, --mtu <mtu>s
              Mtu size : 256 - 4096 (default port mtu)

       -s, --size <size>
              Size of message to exchange (default 2)

       -a, --all
              Run sizes from 2 till 2^23

       -n, --iters <iterations>
              Number of exchanges (at least 5, default 1000)

       -t, --tx-depth  <depth>
              Size of tx queue (default 50)

       -u, --qp-timeout <timeout>
              QP timeout, timeout value is 4 usec * 2 ^(timeout), default 14

       -S, --sl <sl>
              SL (default 0)

       -x, --gid-index <index>
              Test uses GID with GID index (Default : IB - no gid)

       -F, --CPU-freq
              Do not fail even if cpufreq_ondemand module is loaded

       -V, --version
              Display version number

       -b, --bidirectional
              Measure bidirectional bandwidth (default unidirectional)

       -e, --events
              Sleep on CQ events (default poll)

       -N, --no peak-bw
              Cancel peak-bw calculation (default with peak)

       -o, --outs <num>
              Specify <num> as number of outstanding read/atom(default max  of
              device)

       -C, --report-cycles
              report times in cpu cycle units (default microseconds)

       -H, --report-histogram
              Print out all results (default print summary only)

       -U, --report-unsorted
              (implies -H) print out unsorted results (default sorted)

ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
       +---------------+-----------------------+
       |Availability   | network/open-fabrics  |
       +---------------+-----------------------+
       |Stability      | Pass-through volatile |
       +---------------+-----------------------+
SEE ALSO
       ib_write_bw(1),  ib_send_bw(1),  rdma_lat(1),  ib_write_bw_postlist(1),
       rdma_bw(1), ib_write_lat(1), ib_send_lat(1), ib_clock_test(8)



NOTES
       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source   was   downloaded   from    ['https://www.openfabrics.org/down-
       loads/ibutils/ibutils-1.5.7-0.2.gbd7e502.tar.gz', 'https://www.openfab-
       rics.org/downloads/libibverbs/libibverbs-1.1.8.tar.gz',
       'https://www.openfabrics.org/downloads/libmlx4/libmlx4-1.0.6.tar.gz',
       'https://www.openfabrics.org/downloads/libsdp/lib-
       sdp-1.1.108-0.15.gd7fdb72.tar.gz',   'https://www.openfabrics.org/down-
       loads/management/infiniband-diags-1.6.5.tar.gz',  'https://www.openfab-
       rics.org/downloads/management/libibmad-1.3.12.tar.gz',
       'https://www.openfabrics.org/downloads/management/libibu-
       mad-1.3.10.2.tar.gz',    'https://www.openfabrics.org/downloads/manage-
       ment/opensm-3.3.19.tar.gz',          'https://www.openfabrics.org/down-
       loads/perftest/perftest-1.3.0-0.42.gf350d3d.tar.gz', 'https://www.open-
       fabrics.org/downloads/qperf/qperf-0.4.9.tar.gz',  'https://www.openfab-
       rics.org/downloads/rdmacm/librdmacm-1.0.21.tar.gz',  'https://www.open-
       fabrics.org/downloads/rds-tools/rds-tools-2.0.4.tar.gz']

       Further information about this software can be found on the open source
       community website at http://www.openfabrics.org/.



 Oct 15, 2011                          1                      IB_READ_BW(1)(1)