contrib/ofed/librdmacm/man/mckey.1

   1 .\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
   2 .TH "MCKEY" 1 "2007-05-15" "librdmacm" "librdmacm" librdmacm
   3 .SH NAME
   4 mckey \- RDMA CM multicast setup and simple data transfer test.
   5 .SH SYNOPSIS
   6 .sp
   7 .nf
   8 \fImckey\fR -m multicast_address [-s] [-b bind_address] [-c connections]
   9                 [-C message_count] [-S message_size] [-p port_space]
  10 \fImckey\fR -m multicast_address -s [-b bind_address] [-c connections]
  11                 [-C message_count] [-S message_size] [-p port_space]
  12 \fImckey\fR -M unmapped_multicast_address -b bind_address [-s] [-c connections]
  13                 [-C message_count] [-S message_size] [-p port_space]
  14 .fi
  15 .SH "DESCRIPTION"
  16 Establishes a set of RDMA multicast communication paths between nodes
  17 using the librdmacm, optionally transfers datagrams to receiving nodes,
  18 then tears down the communication.
  19 .SH "OPTIONS"
  20 .TP
  21 \-m multicast_address
  22 IP multicast address to join.
  23 .TP
  24 \-M unmapped_multicast_address
  25 RDMA transport specific multicast address to join.
  26 .TP
  27 \-s
  28 Send datagrams to the multicast group.
  29 .TP
  30 \-b bind_address
  31 The local network address to bind to.
  32 .TP
  33 \-c connections
  34 The number of QPs to join the multicast group.  (default 1)
  35 .TP
  36 \-C message_count
  37 The number of messages to transfer over each connection.  (default 10)
  38 .TP
  39 \-S message_size
  40 The size of each message transferred, in bytes.  This value must be smaller
  41 than the MTU of the underlying RDMA transport, or an error will occur.
  42 (default 100)
  43 .TP
  44 \-p port_space
  45 The port space of the datagram communication.  May be either the RDMA
  46 UDP (0x0111) or IPoIB (0x0002) port space.  (default RDMA_PS_UDP)
  47 .SH "NOTES"
  48 Basic usage is to start mckey -m multicast_address on a server system,
  49 then run mckey -m multicast_address -s on a client system.
  50 .P
  51 Unique Infiniband SA assigned multicast GIDs can be retrieved by
  52 invoking mckey with a zero MGID or IP address.  (Example, -M 0 or
  53 -m 0.0.0.0).  The assigned address will be displayed to allow
  54 mckey clients to join the created group.
  55 .P
  56 Because this test maps RDMA resources to userspace, users must ensure
  57 that they have available system resources and permissions.  See the
  58 libibverbs README file for additional details.
  59 .SH "SEE ALSO"
  60 rdma_cm(7), ucmatose(1), udaddy(1), rping(1)