[DAPL2] Sync with OFED DAPL 2.0.21 src release
[mirror/winof/.git] / ulp / dapl2 / README.windows
1 [10-17-07] Last update.\r
2 \r
3 ==========\r
4 BUILD:\r
5 ==========\r
6 \r
7 The default build includes both debug(checked) & non-debug (free) version of\r
8 dat2d.dll and dapl2d.dll uDAPL provider, free versions are dat2.dll & dapl2.dll.\r
9 Included in the build are test suites dtest (simple DAT example), dtestx\r
10 (DAT IB extensions test) and the main DAT/uDAPL tester dapl2test (see dt-svr &\r
11 dt-cli, see manual.htm for details).\r
12 Additionally, DAT v1.1 and/or DAT v2.0 build environments can be installed; see\r
13 manual.htm for details.\r
14 \r
15 Building a free/non-debug version:\r
16 ----------------------------------\r
17 Requires Windows Server 2003 DDK & Platform SDK.\r
18 From a DDK command window (free build) for a specific architecture\r
19 (x86, x64, ia64);\r
20 \r
21 cd gen1\trunk\ulp\dapl2\r
22 build -wg\r
23 Binaries are located in gen1\bin\{kernel|user}\os-arch-folder\...\r
24 \r
25 Building debug version:\r
26 -----------------------\r
27 Same as above except the DDK command window is for a Checked build\r
28 \r
29 \r
30 Installing:\r
31 -----------\r
32 \r
33 dat2.dll & dapl.dll --> %SystemRoot%\r
34 \r
35 ===================\r
36 CONFIGURATION:\r
37 ===================\r
38 \r
39 sample C:\dat\dat.conf \r
40 \r
41 #\r
42 # DAT 1.2 configuration file,\r
43 #\r
44 # Each entry should have the following fields:\r
45 #\r
46 # <ia_name> <api_version> <threadsafety> <default> <lib_path> \\r
47 #           <provider_version> <ia_params> <platform_params>\r
48 #\r
49 # For openib-cma provider you can specify <ia_params> as either:\r
50 #       network address, network hostname, or netdev name and 0 for port\r
51 #\r
52 #\r
53 ibnic0v2 u2.0 nonthreadsafe default C:\Windows\dapl2.dll ri.2.0 "IbalHca0 1" ""\r
54 \r
55 \r
56 =============================\r
57 Bugs/Known issues\r
58 =============================\r
59 \r
60 \r
61 \r
62 =============================\r
63 4.0 SAMPLE uDAPL APPLICATION:\r
64 =============================\r
65 \r
66 There are 2 sample programs provided with this package.\r
67 \r
68 (dapl2/test/dtest/)\r
69 (dapl2/test/dtestx/)\r
70 \r
71 NAME\r
72       dtest - simple uDAPL send/receive and RDMA test\r
73 \r
74 SYNOPSIS\r
75       dtest [-P provider] [-b buf size] [-B burst count][-v] [-c] [-p] [-d] [-s]\r
76 \r
77       dtest [-P provider] [-b buf size] [-B burst count][-v] [-c] [-p] [-d] [-h HOSTNAME]\r
78 \r
79 DESCRIPTION\r
80       dtest  is a simple test used to exercise and verify the uDAPL interfaces.\r
81       At least two instantiations of the test must be run. One acts as the\r
82       server and the other the client. The server side of the test listens for\r
83       connection requests, until timing out or killed. Upon receipt of a cd\r
84       connection request, the connection is established, the server and client\r
85       sides exchange information necessary to perform RDMA writes and reads.\r
86 \r
87 OPTIONS\r
88        -P=PROVIDER\r
89           use PROVIDER to specify uDAPL interface using C:\DAT\dat.conf\r
90           (default ibnic0v2)\r
91 \r
92        -b=BUFFER_SIZE\r
93           use buffer size BUFFER_SIZE for RDMA(default 64)\r
94 \r
95        -B=BURST_COUNT\r
96           use busrt count BURST_COUNT for interations (default 10)\r
97 \r
98        -v, verbose output(default off)\r
99 \r
100        -c, use consumer notification events (default off)\r
101 \r
102        -p, use polling (default wait for event)\r
103 \r
104        -d, delay in seconds before close (default off)\r
105 \r
106        -s, run as server (default - run as server)\r
107 \r
108        -h=HOSTNAME\r
109           use HOSTNAME to specify server hostname or IP address (default - none)\r
110 \r
111 EXAMPLES\r
112        dtest -v -s\r
113            Starts a server process with debug verbosity using provider ibnic0v2\r
114 \r
115        dtest -h server1-ib0\r
116 \r
117            Starts a client process, using ibnic0v2 provider to connect to\r
118            hostname server1-ib0.\r
119 \r
120 SEE ALSO\r
121        dapltest(1)\r
122 \r
123 AUTHORS\r
124        Arlin Davis\r
125               <ardavis@ichips.intel.com>\r
126 \r
127 BUGS\r
128 \r
129 /dapl/test/dapltest/\r
130 \r
131 NAME\r
132         dapltest - test for the Direct Access Programming Library (DAPL)\r
133 \r
134 DESCRIPTION\r
135        Dapltest  is  a  set  of tests developed to exercise, characterize, and\r
136        verify the DAPL interfaces during development and porting. At least two\r
137        instantiations of the test must be run. One acts as the server, fielding\r
138        requests and spawning server-side test threads as needed. Other client(s)\r
139        connect to the server and issue test requests. The server side of the\r
140        test, once  invoked, listens  continuously for client connection requests\r
141        until stopped or killed. Upon receipt of a connection request, the\r
142        connection is established, the server and client sides swap version\r
143        numbers to  verify that they are able to communicate, and the client\r
144        sends the test request to the server. If the version numbers match, and\r
145        the test request is well-formed, the server spawns  the  threads\r
146        needed to run the test before awaiting further connections.\r
147 \r
148 USAGE\r
149        See manual.htm and or dt-svr.bat & dt-cli.bat.\r
150 \r
151 EXAMPLES\r
152        dapltest -T S -d -D ibnic0v2\r
153 \r
154            Starts a server process with debug verbosity.\r
155 \r
156        dapltest -T T -d -s host1-ib0 -D ibnic0v2 -i 100 client SR 4096 2 \\r
157            server SR 4096 2\r
158 \r
159            Runs a transaction test, with both sides sending one buffer with\r
160            two 4KB segments, one hundred times.\r
161 \r
162        dapltest -T P -d -s host1-ib0 -D ibnic0v2 -i 100 SR 4096 2\r
163 \r
164            Runs a performance test, with the client sending one buffer with\r
165            two 4KB segments, one hundred times.\r
166 \r
167        dapltest -T Q -s host1-ib0 -D ibnic0v2\r
168 \r
169            Asks the server to clean up and exit.\r
170 \r
171        dapltest -T L -D ibnic0v2 -d -w 16 -m 1000\r
172 \r
173            Runs all of the limit tests, setting up 16 complete sets of DAPL\r
174            objects, and creating at most a thousand instances when trying to\r
175            exhaust resources.\r
176 \r
177        dapltest -T T -V -d -t 2 -w 4 -i 55555 -s linux3 -D ibnic0v2 \\r
178            client RW 4096 1 server RW  2048  4 client SR 1024 4 server SR 4096 \\r
179            2 client SR 1024 3 -f server SR 2048 1 -f\r
180 \r
181            Runs a more complicated transaction test, with two thread using four\r
182            EPs each, sending a more complicated buffer pattern for a larger\r
183            number of iterations, validating the data received.\r
184 \r
185        BUGS   (and To Do List)\r
186 \r
187            Use of CNOs (-Q) is not yet supported.\r
188 \r
189            Further limit tests could be added.\r
190 \r