Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Thursday, March 14, 2019
 
 

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

MCKEY(1)                           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 communication.

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  connection.
              (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(7) for descriptions of the following attributes:


       +---------------+-----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
       +---------------+-----------------------+
       |Availability   | network/open-fabrics  |
       +---------------+-----------------------+
       |Stability      | Pass-through 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 invok-
       ing 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://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/.



librdmacm                         2007-05-15                          MCKEY(1)