contrib/ofed/librdmacm/man/ucmatose.1

   1 .\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
   2 .TH "UCMATOSE" 1 "2007-05-15" "librdmacm" "librdmacm" librdmacm
   3 .SH NAME
   4 ucmatose \- RDMA CM connection and simple ping-pong test.
   5 .SH SYNOPSIS
   6 .sp
   7 .nf
   8 \fIucmatose\fR [-s server_address] [-b bind_address]
   9                 [-f address_format] [-P port_space]
  10                 [-c connections] [-C message_count] [-S message_size]
  11 \fIucmatose\fR -s server_address [-b bind_address]
  12                 [-f address_format] [-P port_space]
  13                 [-c connections] [-C message_count] [-S message_size] [-t tos]
  14 .fi
  15 .SH "DESCRIPTION"
  16 Establishes a set of reliable RDMA connections between two nodes using the
  17 librdmacm, optionally transfers data between the nodes, then disconnects.
  18 .SH "OPTIONS"
  19 .TP
  20 \-s server_address
  21 The network name or IP address of the server system listening for
  22 connections.  The used name or address must route over an RDMA device.
  23 This option must be specified by the client.
  24 .TP
  25 \-b bind_address
  26 The local network address to bind to.
  27 To bind to any address with IPv6 use -b ::0 .
  28 .TP
  29 \-f address_format
  30 Specifies the format of the server and bind address.  Be default, the
  31 format is determined by getaddrinfo() as either being a hostname, an IPv4
  32 address, or an IPv6 address.  This option may be used to indicate that
  33 a specific address format has been provided.  Supported address_format
  34 values are: name, ip, ipv6, and gid.
  35 .TP
  36 \-P port_space
  37 Specifies the port space for the connection.  Be default, the port space
  38 is the RDMA TCP port space. (Note that the RDMA port space may be separate
  39 from that used for IP.)  Supported port_space values are: tcp and ib.
  40 .TP
  41 \-c connections
  42 The number of connections to establish between the client and server.
  43 (default 1)
  44 .TP
  45 \-C message_count
  46 The number of messages to transfer over each connection.  (default 10)
  47 .TP
  48 \-S message_size
  49 The size of each message transferred, in bytes.  (default 100)
  50 .TP
  51 \-t tos
  52 Indicates the type of service used for the communication.  Type of service
  53 is implementation dependent based on subnet configuration.
  54 .TP
  55 \-m
  56 Tests event channel migration.  Migrates all communication identifiers to
  57 a different event channel for disconnect events.
  58 .SH "NOTES"
  59 Basic usage is to start ucmatose on a server system, then run
  60 ucmatose -s server_name on a client system.
  61 .P
  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 .SH "SEE ALSO"
  66 rdma_cm(7), udaddy(1), mckey(1), rping(1)