Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

mckey(1) [centos man page]

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)

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)

librdmacm							    2007-05-15								  MCKEY(1)

Check Out this Related Man Page

RDMA_RESOLVE_ADDR(3)					   Librdmacm Programmer's Manual				      RDMA_RESOLVE_ADDR(3)

NAME

       rdma_resolve_addr - Resolve destination and optional source addresses.

SYNOPSIS

       #include <rdma/rdma_cma.h>

       int rdma_resolve_addr (struct rdma_cm_id *id, struct sockaddr *src_addr, struct sockaddr *dst_addr, int timeout_ms);

ARGUMENTS

       id	   RDMA identifier.

       src_addr    Source address information.	This parameter may be NULL.

       dst_addr    Destination address information.

       timeout_ms  Time to wait for resolution to complete.

DESCRIPTION

       Resolve	destination  and  optional source addresses from IP addresses to an RDMA address.  If successful, the specified rdma_cm_id will be
       bound to a local device.

RETURN VALUE

       Returns 0 on success, or -1 on error.  If an error occurs, errno will be set to indicate the failure reason.

NOTES

       This call is used to map a given destination IP address to a usable RDMA address.  The IP to RDMA address mapping is done using	the  local
       routing	tables,  or  via  ARP.	 If a source address is given, the rdma_cm_id is bound to that address, the same as if rdma_bind_addr were
       called.	If no source address is given, and the rdma_cm_id has not yet been bound to a device, then the	rdma_cm_id  will  be  bound  to  a
       source address based on the local routing tables.  After this call, the rdma_cm_id will be bound to an RDMA device.  This call is typically
       made from the active side of a connection before calling rdma_resolve_route and rdma_connect.

INFINIBAND SPECIFIC

       This call maps the destination and, if given, source IP addresses to GIDs.  In order to perform the mapping, IPoIB must be running on  both
       the local and remote nodes.

SEE ALSO

       rdma_create_id(3),      rdma_resolve_route(3),	  rdma_connect(3),     rdma_create_qp(3),     rdma_get_cm_event(3),	rdma_bind_addr(3),
       rdma_get_src_port(3), rdma_get_dst_port(3), rdma_get_local_addr(3), rdma_get_peer_addr(3)

librdmacm							    2007-10-31						      RDMA_RESOLVE_ADDR(3)
Man Page