contrib/ofed/librdmacm/man/ucmatose.1

   1 .TH "UCMATOSE" 1 "2007-05-15" "librdmacm" "librdmacm" librdmacm
   2 .SH NAME
   3 ucmatose \- RDMA CM connection and simple ping-pong test.
   4 .SH SYNOPSIS
   5 .sp
   6 .nf
   7 \fIucmatose\fR [-s server_address] [-b bind_address] [-c connections]
   8                 [-C message_count] [-S message_size]
   9 \fIucmatose\fR -s server_address [-b bind_address] [-c connections]
  10                 [-C message_count] [-S message_size] [-t tos]
  11 .fi
  12 .SH "DESCRIPTION"
  13 Establishes a set of reliable RDMA connections between two nodes using the
  14 librdmacm, optionally transfers data between the nodes, then disconnects.
  15 .SH "OPTIONS"
  16 .TP
  17 \-s server_address
  18 The network name or IP address of the server system listening for
  19 connections.  The used name or address must route over an RDMA device.
  20 This option must be specified by the client.
  21 .TP
  22 \-b bind_address
  23 The local network address to bind to.
  24 .TP
  25 \-c connections
  26 The number of connections to establish between the client and server.
  27 (default 1)
  28 .TP
  29 \-C message_count
  30 The number of messages to transfer over each connection.  (default 10)
  31 .TP
  32 \-S message_size
  33 The size of each message transferred, in bytes.  (default 100)
  34 .TP
  35 \-t tos
  36 Indicates the type of service used for the communication.  Type of service
  37 is implementation dependent based on subnet configuration.
  38 .TP
  39 \-m
  40 Tests event channel migration.  Migrates all communication identifiers to
  41 a different event channel for disconnect events.
  42 .SH "NOTES"
  43 Basic usage is to start ucmatose on a server system, then run
  44 ucmatose -s server_name on a client system.
  45 .P
  46 Because this test maps RDMA resources to userspace, users must ensure
  47 that they have available system resources and permissions.  See the
  48 libibverbs README file for additional details.
  49 .SH "SEE ALSO"
  50 rdma_cm(7), udaddy(1), mckey(1), rping(1)