contrib/ofed/librdmacm/man/udaddy.1

   1 .\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
   2 .TH "UDADDY" 1 "2007-05-15" "librdmacm" "librdmacm" librdmacm
   3 .SH NAME
   4 udaddy \- RDMA CM datagram setup and simple ping-pong test.
   5 .SH SYNOPSIS
   6 .sp
   7 .nf
   8 \fIudaddy\fR [-s server_address] [-b bind_address] [-c connections]
   9                 [-C message_count] [-S message_size] [-p port_space]
  10 \fIudaddy\fR -s server_address [-b bind_address] [-c connections]
  11                 [-C message_count] [-S message_size] [-t tos] [-p port_space]
  12 .fi
  13 .SH "DESCRIPTION"
  14 Establishes a set of unreliable RDMA datagram communication paths between two
  15 nodes using the librdmacm, optionally transfers datagrams between the nodes,
  16 then tears down the communication.
  17 .SH "OPTIONS"
  18 .TP
  19 \-s server_address
  20 The network name or IP address of the server system listening for
  21 communication.  The used name or address must route over an RDMA device.
  22 This option must be specified by the client.
  23 .TP
  24 \-b bind_address
  25 The local network address to bind to.
  26 To bind to any address with IPv6 use -b ::0 .
  27 .TP
  28 \-c connections
  29 The number of communication paths to establish between the client and server.
  30 The test uses unreliable datagram communication, so no actual connections are
  31 formed.  (default 1)
  32 .TP
  33 \-C message_count
  34 The number of messages to transfer over each connection.  (default 10)
  35 .TP
  36 \-S message_size
  37 The size of each message transferred, in bytes.  This value must be smaller
  38 than the MTU of the underlying RDMA transport, or an error will occur.
  39 (default 100)
  40 .TP
  41 \-t tos
  42 Indicates the type of service used for the communication.  Type of service
  43 is implementation dependent based on subnet configuration.
  44 .TP
  45 \-p port_space
  46 The port space of the datagram communication.  May be either the RDMA
  47 UDP (0x0111) or IPoIB (0x0002) port space.  (default RDMA_PS_UDP)
  48 .SH "NOTES"
  49 Basic usage is to start udaddy on a server system, then run
  50 udaddy -s server_name on a client system.
  51 .P
  52 Because this test maps RDMA resources to userspace, users must ensure
  53 that they have available system resources and permissions.  See the
  54 libibverbs README file for additional details.
  55 .SH "SEE ALSO"
  56 rdma_cm(7), ucmatose(1), mckey(1), rping(1)