1MCKEY(1)                           librdmacm                          MCKEY(1)
2
3
4

NAME

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

SYNOPSIS

9       mckey -m multicast_address [-s] [-b bind_address] [-c connections]
10                 [-C message_count] [-S message_size] [-p port_space]
11       mckey -m multicast_address -s [-b bind_address] [-c connections]
12                 [-C message_count] [-S message_size] [-p port_space]
13       mckey -M unmapped_multicast_address -b bind_address [-s] [-c connections]
14                 [-C message_count] [-S message_size] [-p port_space]
15

DESCRIPTION

17       Establishes  a  set of RDMA multicast communication paths between nodes
18       using the librdmacm, optionally transfers datagrams to receiving nodes,
19       then tears down the communication.
20

OPTIONS

22       -m multicast_address
23              IP multicast address to join.
24
25       -M unmapped_multicast_address
26              RDMA transport specific multicast address to join.
27
28       -s     Send datagrams to the multicast group.
29
30       -b bind_address
31              The local network address to bind to.
32
33       -c connections
34              The number of QPs to join the multicast group.  (default 1)
35
36       -C message_count
37              The  number  of  messages  to  transfer  over  each  connection.
38              (default 10)
39
40       -S message_size
41              The size of each message transferred, in bytes.  This value must
42              be  smaller than the MTU of the underlying RDMA transport, or an
43              error will occur.  (default 100)
44
45       -o     Join the multicast group as a send-only  full-member.  Otherwise
46              the group is joined as a full-member.
47
48       -p port_space
49              The port space of the datagram communication.  May be either the
50              RDMA UDP  (0x0111)  or  IPoIB  (0x0002)  port  space.   (default
51              RDMA_PS_UDP)
52

NOTES

54       Basic  usage is to start mckey -m multicast_address on a server system,
55       then run mckey -m multicast_address -s on a client system.
56
57       Unique Infiniband SA assigned multicast GIDs can be retrieved by invok‐
58       ing  mckey  with  a  zero  MGID  or  IP  address.  (Example, -M 0 or -m
59       0.0.0.0).  The assigned  address  will  be  displayed  to  allow  mckey
60       clients to join the created group.
61
62       Because  this  test maps RDMA resources to userspace, users must ensure
63       that they have available system resources  and  permissions.   See  the
64       libibverbs README file for additional details.
65

SEE ALSO

67       rdma_cm(7), ucmatose(1), udaddy(1), rping(1)
68
69
70
71librdmacm                         2007-05-15                          MCKEY(1)
Impressum