dtest: Add new man pages. (dtestx dtestcm dtestsrq)
authorAmir Hanania <amir.hanania@intel.com>
Tue, 29 Nov 2016 23:15:49 +0000 (15:15 -0800)
committerArlin Davis <arlin.r.davis@intel.com>
Tue, 29 Nov 2016 23:15:49 +0000 (15:15 -0800)
Signed-off-by: Amir Hanania <amir.hanania@intel.com>
Signed-off-by: Arlin Davis <arlin.r.davis@intel.com>
Makefile.am
man/dapltest.1
man/dat.conf.5
man/dtest.1
man/dtestcm.1 [new file with mode: 0644]
man/dtestsrq.1 [new file with mode: 0644]
man/dtestx.1 [new file with mode: 0644]

index b10c409..483ba90 100755 (executable)
@@ -649,7 +649,7 @@ libdatinclude_HEADERS = dat/include/dat2/dat.h \
                        dat/include/dat2/udat_redirection.h \
                        dat/include/dat2/udat_vendor_specific.h $(XDAT)
                                        
-man_MANS = man/dtest.1 man/dapltest.1 man/dat.conf.5 
+man_MANS = man/dtest.1 man/dapltest.1 man/dat.conf.5 man/dtestsrq.1 man/dtestcm.1 man/dtestx.1 
        
 EXTRA_DIST = dat/common/dat_dictionary.h \
             dat/common/dat_dr.h \
index 62b44bb..90fd6d2 100644 (file)
@@ -1,5 +1,5 @@
 ." Text automatically generated by txt2man
-.TH dapltest 1 "July 16, 2013" "uDAPL 2.0" "USER COMMANDS"
+.TH dapltest 1 "November 15, 2016" "uDAPL 2.1" "USER COMMANDS"
 
 .SH NAME
 \fB
@@ -236,7 +236,7 @@ Usage - Performance test client
                         of data transfers will be made over each endpoint.
                         Default: 1000
 
-    [ -p pipeline ]     Specify the pipline length, valid arguments are in 
+    [ -p pipeline ]     Specify the pipeline length, valid arguments are in 
                         the range [0,MAX_SEND_DTOS]. If a value greater than 
                         MAX_SEND_DTOS is requested the value will be
                         adjusted down to MAX_SEND_DTOS.
@@ -278,7 +278,7 @@ Usage - Limit test client
     sets are created before beating upon the requested constructor.
     Use of -m limits the number of dat_*_create() calls that will
     be attempted, which can be helpful if the DAPL in use supports
-    essentailly unlimited numbers of some objects.
+    essentially unlimited numbers of some objects.
 
     The limit test arguments are:
 
@@ -393,3 +393,14 @@ BUGS
     Use of CNOs (-Q) is not yet supported.
 
     Further limit tests could be added.
+
+.SH SEE ALSO
+.BR dtest(1),
+.BR dtestx(1),
+.BR dtestcm(1),
+.BR dtestsrq(1)
+
+.SH AUTHORS
+.TP
+Arlin Davis
+.RI < arlin.r.davis@intel.com >
index e64ec81..e3f11a4 100644 (file)
@@ -1,4 +1,4 @@
-.TH "DAT.CONF" "5" "25 March 2008" "" ""
+.TH "DAT.CONF" "5" "November 15, 2016" "" ""
 .SH NAME
 dat.conf \- configuration file for static registration of user-level DAT rdma providers
 .SH "DESCRIPTION"
@@ -37,7 +37,7 @@ entry is termed Static Registration.
         - The IA Name.
         - The API version of the library:
           [k|u]major.minor where "major" and "minor" are both integers
-          in decimal format. User-level examples: "u1.2", and "u2.0".
+          in decimal format. User-level examples: "u2.0".
         - Whether the library is thread-safe: [threadsafe|nonthreadsafe]
         - Whether this is the default section: [default|nondefault]
         - The library image, version included, to be loaded.
@@ -47,32 +47,31 @@ entry is termed Static Registration.
 .PP
 .SH OpenFabrics RDMA providers: 
 \br 
-    Provider options for both 1.2 and 2.0, each using different CM services
+    Provider options for different CM services
 
         1. cma - OpenFabrics rdma_cm    - uses rdma_cm services for connections
                                         - requires IPoIB and SA/SM services for IB
                                         - netdev used for device name, without port designation (ia_params) 
                                         - Supports any transport rdma_cm supports including IB, iWARP, RoCEE
-                                        - libdaplcma.so (1.2), libdaplofa (2.0)
+                                        - libdaplofa (2.0)
 
         2. scm - uDAPL socket based CM  - exchanges CM information over sockets 
                                         - eliminates the need for rdma_cm, IPoIB, and SA for IB
                                         - verbs device used for device name with port designation (ia_param)
                                         - Supports IB, RoCEE. Doesn't support iWARP
-                                        - libdaplscm.so (1.2), libdaploscm (2.0)
+                                        - libdaploscm (2.0)
 
         3. ucm - uDAPL unreliable IB CM - exchanges CM information via IB UD QP's
                                         - eliminates the need for sockets or rdma_cm
                                         - verbs device used for device name with port designation (ia_param)
                                         - Supports IB only, no name service. 
-                                        - libdaplucm.so (1.2), libdaploucm (2.0)
+                                        - libdaploucm (2.0)
 .PP
 .SH Example entries for each OpenFabrics provider 
 \br 
 
-        1. cma - OpenFarbrics rdma_cm (v1.2 and v2.0 examples)
+        1. cma - OpenFarbrics rdma_cm examples
 
-        OpenIB-cma u1.2 nonthreadsafe default libdaplcma.so.1 dapl.1.2 "ib0 0" ""
         ofa-v2-ib0 u2.0 nonthreadsafe default libdaplofa.so.2 dapl.2.0 "ib0 0" ""
         ofa-v2-iwarp u2.0 nonthreadsafe default libdaplofa.so.2 dapl.2.0 "eth2 0" ""
         ofa-v2-cma-roe-eth2 u2.0 nonthreadsafe default libdaplofa.so.2 dapl.2.0 "eth2 0" ""
@@ -81,17 +80,15 @@ entry is termed Static Registration.
         NOTE: The OpenFabrics CMA providers use <ia_params> to specify the device with one of the following:
               network address, network hostname, or netdev name; along with port number.
 
-        2. scm - uDAPL socket based CM (v1.2 and v2.0 examples)
+        2. scm - uDAPL socket based CM v2.0 examples
 
-        OpenIB-mlx4_0-1 u1.2 nonthreadsafe default libdaplscm.so.1 dapl.1.2 "mlx4_0 1" ""
-        OpenIB-ipath0-1 u1.2 nonthreadsafe default libdaplscm.so.1 dapl.1.2 "ipath0 1" ""
         ofa-v2-mlx4_0-1 u2.0 nonthreadsafe default libdaploscm.so.2 dapl.2.0 "mlx4_0 1" ""
         ofa-v2-mlx4_0-2 u2.0 nonthreadsafe default libdaploscm.so.2 dapl.2.0 "mlx4_0 2" ""
-        ofa-v2-mlx4_1-1 u2.0 nonthreadsafe default libdaploscm.so.2 dapl.2.0 "mlx4_1 1" ""
+        ofa-v2-mlx5_1-1 u2.0 nonthreadsafe default libdaploscm.so.2 dapl.2.0 "mlx5_1 1" ""
         ofa-v2-ehca0-1 u2.0 nonthreadsafe default libdaploscm.so.2 dapl.2.0 "ehca0 1" ""
-        ofa-v2-scm-roe-mlx4_0-1 u2.0 nonthreadsafe default libdaploscm.so.2 dapl.2.0 "mlx4_0 1" ""
+        ofa-v2-scm-roe-mlx5_0-1 u2.0 nonthreadsafe default libdaploscm.so.2 dapl.2.0 "mlx5_0 1" ""
 
-        3. ucm - uDAPL unreliable IB CM  (not supported in 1.2, v2.0 examples)
+        3. ucm - uDAPL unreliable IB CM examples
 
         ofa-v2-mlx4_0-1u u2.0 nonthreadsafe default libdaploucm.so.2 dapl.2.0 "mlx4_0 1" ""
         ofa-v2-mlx4_0-2u u2.0 nonthreadsafe default libdaploucm.so.2 dapl.2.0 "mlx4_0 2" ""
index 1e227e5..6c0aac9 100755 (executable)
@@ -1,4 +1,4 @@
-.TH dtest 1 "February 23, 2007" "uDAPL 1.2" "USER COMMANDS"
+.TH dtest 1 "November 15, 2016" "uDAPL 2.1" "USER COMMANDS"
 
 .SH NAME
 dtest \- simple uDAPL send/receive and RDMA test
@@ -24,8 +24,8 @@ sides exchange information necessary to perform RDMA writes and reads.
 .PP
 .TP
 \fB\-P\fR=\fIPROVIDER\fR
-use \fIPROVIDER\fR to specify uDAPL interface using /etc/dat.conf (default OpenIB-cma)
 .TP
+use \fIPROVIDER\fR to specify uDAPL interface using /etc/dat.conf (default ofa-v2-mlx4_0-1u)
 \fB\-b\fR=\fIBUFFER_SIZE\fR
 use buffer size \fIBUFFER_SIZE\fR for RDMA(default 64)
 .TP
@@ -64,15 +64,12 @@ dtest -P OpenIB-cma -h server1-ib0
 .fam T
 
 .SH SEE ALSO
+.BR dtestcm(1),
+.BR dtestx(1),
+.BR dtestsrq(1),
 .BR dapltest(1)
 
 .SH AUTHORS
 .TP
 Arlin Davis
-.RI < ardavis@ichips.intel.com >
-
-.SH BUGS 
-
-
-
-
+.RI < arlin.r.davis@intel.com >
diff --git a/man/dtestcm.1 b/man/dtestcm.1
new file mode 100644 (file)
index 0000000..c1092c8
--- /dev/null
@@ -0,0 +1,81 @@
+.TH dtestcm 1 "November 15, 2016" "uDAPL 2.1" "USER COMMANDS"
+
+.SH NAME
+dtestcm \- simple uDAPL test that measure setup time and connection establish time
+
+.SH SYNOPSIS
+.B dtestcm
+[\-mwvu] [\-P provider] [\-b burst size] [\-p port id] [\-c connections num] [\-d delay] \fB[ -s | -h HOSTNAME ]\fR
+
+.SH DESCRIPTION
+.PP
+dtestcm is a simple test that measure setup time and how long it takes to establish one connection on AVG.
+At least two instantiations of the test must be run. One acts as the server and the other the client.
+The server side of the test, once invoked listens for connection requests, until timing out or killed.
+Upon receipt of a connection request, the connection is established.
+Upon the established of all the connections we calc AVG time.  
+
+.SH OPTIONS
+
+.PP
+.TP
+\fB\-P\fR=\fIPROVIDER\fR
+use \fIPROVIDER\fR to specify uDAPL interface using /etc/dat.conf (default ofa-v2-ib0)
+.TP
+\fB\-h\fR=\fIHOSTNAME\fR
+use \fIHOSTNAME\fR to specify server hostname or IP address (default - none)
+.TP
+\fB\-b\fR=\fIBURST_SIZE\fR
+send \fIBURST_SIZE\fR connection requests at one time (default 100)
+.TP
+\fB\-d\fR=\fIDELAY_TIME\fR
+delay in \fIDELAY_TIME\fR seconds before close (default 0)
+.TP
+\fB\-p\fR=\fIPORT_NUM\fR
+use \fIPORT_NUM\fR to established connections (default 45248)
+.TP
+\fB\-c\fR=\fICONN_NUM\fR
+establish \fICONN_NUM\fR connections (default 1000)
+.TP
+\fB\-v\fR, verbose output (default off)
+.TP
+\fB\-m\fR, multi listens. listen on burst size PSP (default off)
+.TP
+\fB\-u\fR, run ud test (default no)
+.TP
+\fB\-w\fR, wait for CR (default poll)
+.TP
+\fB\-s\fR, run as server (default - run as server)
+
+.SH EXAMPLES
+
+dtestcm -P  ofa-v2-ib0 -v -s
+.PP
+.nf
+.fam C
+     Starts a server process with debug verbosity using provider ofa-v2-ib0.
+
+.fam T
+.fi
+dtestcm -P ofa-v2-ib0 -h server1-ib0 
+.PP
+.nf
+.fam C
+     Starts a client process, using ofa-v2-ib0 provider to connect to hostname server1-ib0.
+
+.fam T
+
+.SH SEE ALSO
+.BR dtest(1),
+.BR dtestsrq(1),
+.BR dtestx(1),
+.BR dapltest(1)
+
+.SH AUTHORS
+.TP
+Arlin Davis
+.RI < arlin.r.davis@intel.com >
+.TP
+.TP
+Amir Hanania
+.RI < amir.hanania@intel.com >
diff --git a/man/dtestsrq.1 b/man/dtestsrq.1
new file mode 100644 (file)
index 0000000..378d11a
--- /dev/null
@@ -0,0 +1,90 @@
+.TH dtestsrq 1 "November 15, 2016" "uDAPL 2.1" "USER COMMANDS"
+
+.SH NAME
+dtestsrq \- simple uDAPL send/receive and RDMA test with shared receive queue. \fB(SRQ)\fr
+
+.SH SYNOPSIS
+.B dtestsrq
+[\-vu] [\-P provider] [\-b buf size] [\-B burst size] [\-t burst num] [\-c connections] [\-p port] [\-S 0|1] \fB[ \-s | \-h HOSTNAME ]\fR
+
+.SH DESCRIPTION
+.PP
+dtestsrq is a simple test used to exercise and verify the uDAPL interfaces. 
+At least two instantiations of the test must be run. One acts as the server 
+and the other the client. The server side of the test, once invoked listens 
+for connection requests, until timing out or killed. Upon receipt of a cd 
+connection request, the connection is established, the server and client 
+sides exchange information necessary to perform RDMA writes and reads.
+This test support SRQ so all the connections will share the same Rx Q.
+
+.SH OPTIONS
+
+.PP
+.TP
+\fB\-P\fR=\fIPROVIDER\fR
+use \fIPROVIDER\fR to specify uDAPL interface using /etc/dat.conf (default ofa-v2-ib0)
+.TP
+\fB\-h\fR=\fIHOSTNAME\fR
+use \fIHOSTNAME\fR to specify server hostname or IP address (default - none)
+.TP
+\fB\-b\fR=\fIBUFFER_SIZE\fR
+use buffer size \fIBUFFER_SIZE\fR for RDMA (default 64)
+.TP
+\fB\-B\fR=\fIBURST_SIZE\fR
+use burst size \fIBURST_SIZE\fR (default 1)
+.TP
+\fB\-t\fR=\fIBURST_COUNT\fR
+use burst count \fIBURST_COUNT\fR (default 3)
+.TP
+\fB\-p\fR=\fIPORT_NUM\fR
+use port \fIPORT_NUM\fR (default 45248)
+.TP
+\fB\-c\fR=\fICONN_NUM\fR
+establish \fICONN_NUM\fR connections (default = 1, max = 100)
+.TP
+\fB\-s\fR, run as server (default - run as server)
+.TP
+\fB\-S\fR, use SRQ (default use SQR)
+.TP
+\fB\-v\fR, verbose output(default off)
+.TP
+\fB\-u\fR, run ud test (default no)
+.TP
+\fB\-l\fR=\fILID\fR
+use \fILID\fR for server lid in ucm provider (default - none)
+.TP
+\fB\-q\fR=\fIQPN\fR
+use \fIQPN\fR for server qpn in ucm provider (default - none)
+
+
+.SH EXAMPLES
+
+dtestsrq -P ofa-v2-ib0 -s -c 10
+.PP
+.nf
+.fam C
+     Starts a server process with 10 connections using provider ofa-v2-ib0.
+
+.fam T
+.fi
+dtestsrq -P ofa-v2-ib0 -c 10 -h server1-ib0 
+.PP
+.nf
+.fam C
+     Starts a client process with 10 connections, using ofa-v2-ib0 provider to connect to hostname server1-ib0.
+
+.fam T
+
+.SH SEE ALSO
+.BR dtest(1),
+.BR dtestx(1),
+.BR dtestcm(1),
+.BR dapltest(1) 
+
+.SH AUTHORS
+.TP
+Arlin Davis
+.RI < arlin.r.davis@intel.com >
+.TP
+Amir Hanania
+.RI < amir.hanania@intel.com >
diff --git a/man/dtestx.1 b/man/dtestx.1
new file mode 100644 (file)
index 0000000..b82ab26
--- /dev/null
@@ -0,0 +1,89 @@
+.TH dtestx 1 "November 15, 2016" "uDAPL 2.1" "USER COMMANDS"
+
+.SH NAME
+dtestx \- simple uDAPL extensions test
+
+.SH SYNOPSIS
+.B dtestx
+[\-vmpqc] [\-u|\-U ep num] [\-P provider] [\-b buf size] \fB[ \-s | \-h HOSTNAME ]\fR 
+
+.SH DESCRIPTION
+.PP
+dtestx is a simple test used to test extensions to the DAT API.
+At least two instantiations of the test must be run. One acts as the server 
+and the other the client. The server side of the test, once invoked listens 
+for connection requests, until timing out or killed. Upon receipt of a cd 
+connection request, the connection is established, the server and client 
+sides exchange information necessary to perform extensions test.
+.TP 8
+Extensions tests are:
+1. Post rdma write with immediate data
+.br
+2. Atomic compare and swap
+.br
+3. Atomic fetch and add
+.br    
+Note: In case -q is set only query test will run.
+
+.SH OPTIONS
+
+.PP
+.TP
+\fB\-P\fR=\fIPROVIDER\fR
+use \fIPROVIDER\fR to specify uDAPL interface using /etc/dat.conf (default ofa-v2-mlx4_0-1u)
+.TP
+\fB\-h\fR=\fIHOSTNAME\fR
+use \fIHOSTNAME\fR to specify server hostname or IP address (default - none)
+.TP
+\fB\-b\fR=\fIBUFFER_SIZE\fR
+use buffer size \fIBUFFER_SIZE\fR for RDMA(default 64)
+.TP
+\fB\-U\fR=\fIEP_COUNT\fR
+use \fIEP_COUNT\fR to specify unreliable datagram test with \fIEP_COUNT\fR UD endpoints (default - none)
+.TP
+\fB\-v\fR, verbose output(default off)
+.TP
+\fB\-q\fR, query only test (default off)
+.TP
+\fB\-u\fR, unreliable datagram test (default no)
+.TP
+\fB\-s\fR, run as server (default - run as server)
+.TP
+\fB\-c\fR, run as client (for non UD tests, -h is always client)
+.TP
+\fB\-p\fR, print counters. Provide IA, EP, or EVD and call will print appropriate counters (default off)
+.TP
+\fB\-m\fR, multi ep. in ud test only. receive multi messages on single EP. (default off - receive one message across multiple EPs)
+
+.SH EXAMPLES
+
+dtestx -P ofa-v2-ib0 -v -s
+.PP
+.nf
+.fam C
+     Starts a server process with debug verbosity using provider ofa-v2-ib0.
+
+.fam T
+.fi
+dtestx -P ofa-v2-ib0 -h server1-ib0 
+.PP
+.nf
+.fam C
+     Starts a client process, using ofa-v2-ib0 provider to connect to hostname server1-ib0.
+
+.fam T
+
+.SH SEE ALSO
+.BR dtest(1),
+.BR dtestsrq(1),
+.BR dtestcm(1),
+.BR dapltest(1)
+
+.SH AUTHORS
+.TP
+Arlin Davis
+.RI < arlin.r.davis@intel.com >
+.TP
+Amir Hanania
+.RI < amir.hanania@intel.com >
+