mckey (1)

Name

mckey - RDMA CM multicast setup and simple data transfer test.

Synopsis

mckey -m multicast_address [-s] [-b bind_address] [-c connections]
[-C message_count] [-S message_size] [-p port_space]
mckey -m multicast_address -s [-b bind_address] [-c connections]
[-C message_count] [-S message_size] [-p port_space]
mckey -M unmapped_multicast_address -b bind_address [-s] [-c connections]
[-C message_count] [-S message_size] [-p port_space]

Description

librdmacm                                                MCKEY(1)



NAME
     mckey  -  RDMA  CM  multicast setup and simple data transfer
     test.

SYNOPSIS
     mckey -m multicast_address [-s] [-b bind_address] [-c connections]
               [-C message_count] [-S message_size] [-p port_space]
     mckey -m multicast_address -s [-b bind_address] [-c connections]
               [-C message_count] [-S message_size] [-p port_space]
     mckey -M unmapped_multicast_address -b bind_address [-s] [-c connections]
               [-C message_count] [-S message_size] [-p port_space]

DESCRIPTION
     Establishes a set  of  RDMA  multicast  communication  paths
     between  nodes  using  the  librdmacm,  optionally transfers
     datagrams to receiving nodes, then tears down the communica-
     tion.

OPTIONS
     -m multicast_address
          IP multicast address to join.

     -M unmapped_multicast_address
          RDMA transport specific multicast address to join.

     -s   Send datagrams to the multicast group.

     -b bind_address
          The local network address to bind to.

     -c connections
          The   number  of  QPs  to  join  the  multicast  group.
          (default 1)

     -C message_count
          The number of messages to transfer  over  each  connec-
          tion.  (default 10)

     -S message_size
          The  size  of each message transferred, in bytes.  This
          value must be smaller than the MTU  of  the  underlying
          RDMA transport, or an error will occur.  (default 100)

     -p port_space
          The  port  space of the datagram communication.  May be
          either the RDMA UDP (0x0111)  or  IPoIB  (0x0002)  port
          space.  (default RDMA_PS_UDP)


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



librdmacm            Last change: 2007-05-15                    1






librdmacm                                                MCKEY(1)



     +---------------+----------------------+
     |ATTRIBUTE TYPE |   ATTRIBUTE VALUE    |
     +---------------+----------------------+
     |Availability   | network/open-fabrics |
     +---------------+----------------------+
     |Stability      | Volatile             |
     +---------------+----------------------+
NOTES
     Basic usage is to start  mckey  -m  multicast_address  on  a
     server  system,  then run mckey -m multicast_address -s on a
     client system.

     Unique Infiniband SA assigned multicast GIDs can be retrived
     by invoking mckey with a zero MGID or IP address.  (Example,
     -M 0 or -m 0.0.0.0).  The assigned address will be displayed
     to allow mckey clients to join the created group.

     Because  this  test  maps RDMA resources to userspace, users
     must ensure that they have available  system  resources  and
     permissions.   See the libibverbs README file for additional
     details.

SEE ALSO
     rdma_cm(7), ucmatose(1), udaddy(1), rping(1)


     This  software  was   built   from   source   available   at
     https://java.net/projects/solaris-userland.    The  original
     community source was downloaded from   ['http://www.openfab-
     rics.org/downloads/ibutils/ibutils-1.5.7.tar.gz',
     'http://www.openfabrics.org/downloads/libibverbs/libib-
     verbs-1.1.4-1.22.g7257cd3.tar.gz',      'http://www.openfab-
     rics.org/down-
     loads/libmlx4/libmlx4-1.0.1-1.18.gb810a27.tar.gz',
     'http://www.openfabrics.org/downloads/libsdp/lib-
     sdp-1.1.108-0.15.gd7fdb72.tar.gz',      'http://www.openfab-
     rics.org/downloads/management/infiniband-
     diags-1.5.8.tar.gz',       'http://www.openfabrics.org/down-
     loads/management/libibmad-1.3.7.tar.gz',   'http://www.open-
     fabrics.org/downloads/management/libibumad-1.3.7.tar.gz',
     'http://www.openfabrics.org/downloads/manage-
     ment/opensm-3.3.9.tar.gz', 'http://www.openfabrics.org/down-
     loads/perftest/perftest-1.3.0-0.42.gf350d3d.tar.gz',
     'http://www.openfabrics.org/down-
     loads/qperf/qperf-0.4.6-0.1.gb81434e.tar.gz',
     'http://www.openfabrics.org/downloads/rdmacm/librd-
     macm-1.0.14.1.tar.gz',     'http://www.openfabrics.org/down-
     loads/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.openfab-
     rics.org/.



librdmacm            Last change: 2007-05-15                    2