← Back to branch summary

~ubuntu-branches/ubuntu/trusty/netpipe/trusty-proposed

« back to all changes in this revision

Viewing changes to dox/README

  • Committer: Bazaar Package Importer
  • Author(s): Camm Maguire
  • Date: 2010-01-06 19:07:32 UTC
  • mfrom: (4.1.1 sid)
  • Revision ID: james.westby@ubuntu.com-20100106190732-fg9urgk31weolrcs
Tags: 3.7.1-1
http://bugs.debian.org/450010
* New upstream release
* Bug fix: "debian/watch fails to report upstream's version", thanks
  to Raphael Geissert (Closes: #450010).

Show diffs side-by-side

added added

removed removed

Lines of Context:
dox/README
6
6
NetPIPE was originally developed by Quinn Snell, Armin Mikler,
7
7
John Gustafson, and Guy Helmer.
8
8
 
9
 
It is currently being developed and maintained by Dave Turner with
10
 
help from several graduate students (Xuehua Chen, Adam Oline, 
11
 
Brian Smith, Bogdan Vasiliu).
 
9
It is currently being developed and maintained by Troy Benjegerdes, with
 
10
help from several graduate students (Veerendra Allada, Kyle Schochenmaier)
 
11
 
 
12
Release 3.7 adds support for OpenFabrics infiniband verbs module (NPibv),
 
13
and should work with the OFED-1.1 or OFED-1.2 release. It has been tested
 
14
on IBM eHCA hardware as well as Mellanox pci-express infiniband adapters.
 
15
The openfabrics verbs support is currently lacking any support for the
 
16
connection manager, and all connections are set up via TCP sockets. This
 
17
means that RDMA ethernet devices will not work. Patches to
 
18
netpipe@lists.scl.ameslab.gov are encouraged.
12
19
 
13
20
Release 3.6.2 mainly fixes some bugs. A number of portability issues 
14
21
with 64-bit architectures were taken care of, especially in the Infiniband
85
92
  make shmem      (1-sided library for Cray and SGI systems)
86
93
 
87
94
  make tcp
 
95
  make tcp6       (for IPv6 enabled systems)
 
96
  make ipx        (for IPX enabled systems)
 
97
  make sctp       (for SCTP enabled systems)
 
98
  make sctp6      (for SCTP6 enabled systems)
88
99
  make gm         (for Myrinet cards, you will need to set some paths)
89
100
  make shmem      (1-sided library for Cray and SGI systems)
90
101
  make gpshmem    (SHMEM interface for other machines)
91
102
  make armci      (still under development)
92
103
  make lapi       (for the IBM SP)
93
104
  make ib         (for Mellanox Infiniband adapters, uses VAPI layer)
 
105
  make ibv        (for OpenFabrics Infiniband devices)
94
106
  make memcpy     (uses memcpy to copy data between buffers in 1 process)
95
107
  make MP_memcpy  (uses an optimized copy in MP_memcpy.c to copy data between 
96
108
                   buffers.  This requires icc or gcc 3.x.)
145
157
        -2: Bi-directional communications.  Transmit in both directions
146
158
            simultaneously.
147
159
 
148
 
   TCP
 
160
        -P: Set the port number used by TCP to something other than
 
161
            default.
 
162
 
 
163
   TCP 
149
164
   ---
150
165
 
151
166
      Compile NetPIPE using 'make tcp'
157
172
 
158
173
      local_host>  nplaunch NPtcp -h remote_host [options]
159
174
 
 
175
   TCP6
 
176
   ----
 
177
 
 
178
      Compile NetPIPE using 'make tcp6'
 
179
 
 
180
      remote_host> NPtcp6 [options]
 
181
      local_host>  NPtcp6 -h remote_host [options]
 
182
 
 
183
                       OR
 
184
 
 
185
      local_host>  nplaunch NPtcp6 -h remote_host [options]
 
186
 
 
187
 
 
188
   IPX
 
189
   ---
 
190
 
 
191
      Compile NetPIPE using 'make ipx
 
192
 
 
193
      remote_host> NPipx [options]
 
194
      local_host>  NPipx -h remote_host [options]
 
195
 
 
196
                       OR
 
197
 
 
198
      local_host>  nplaunch NPipx -h remote_host [options]
 
199
 
 
200
 
 
201
   SCTP
 
202
   ----
 
203
 
 
204
      Compile NetPIPE using 'make sctp
 
205
 
 
206
      remote_host> NPsctp [options]
 
207
      local_host>  NPsctp -h remote_host [options]
 
208
 
 
209
                       OR
 
210
 
 
211
      local_host>  nplaunch NPsctp -h remote_host [options]
 
212
 
 
213
 
 
214
 
 
215
   SCTP6
 
216
   ----
 
217
 
 
218
      Compile NetPIPE using 'make sctp6
 
219
 
 
220
      remote_host> NPsctp6 [options]
 
221
      local_host>  NPsctp6 -h remote_host [options]
 
222
 
 
223
                       OR
 
224
 
 
225
      local_host>  nplaunch NPsctp6 -h remote_host [options]
 
226
 
 
227
 
 
228
 
160
229
   MPICH
161
230
   -----
162
231
 
308
377
 
309
378
      This test will only work on machines connected via TCP/IP as well
310
379
        as Infiniband.
311
 
      Install Mellanox Infiniband adapters and software
 
380
      Install Infiniband adapters and mellanox vapi software
 
381
        (OR OFED-1.1 or OFED-1.2)
312
382
      Make sure the adapters are up and running (e.g. Check that the 
313
383
        Mellanox-supplied bandwidth/latency program, perf_main, works, if 
314
 
        you have it).
315
 
      Compile NetPIPE using 'make ib' (The environment variable MTHOME needs
316
 
        to be set to the directory containing the include and lib directories
317
 
        for the Mellanox software).
 
384
        you have it. For OFED, make sure ibv_rc_pingpong works)
 
385
      Compile NetPIPE using 'make ib' for vapi and 'make ibv for OFED
 
386
        (The environment variable MTHOME needs to be set to the directory
 
387
        containing the include and lib directories for the Mellanox software).
 
388
        OFED should build if the libraries are in the standard OFED install
 
389
        locations, if not, edit the makefile.
318
390
 
319
391
      remote_host> NPib [-options]
320
392
      local_host>  NPib -h remote_host [-options]
325
397
 
326
398
      (remote_host should be the ip address or hostname of the other host)
327
399
        
328
 
      Other options:
 
400
      Other options: (this documentation is out of date for ibv)
329
401
        Use -m to select mtu size for Infiniband adapter.
330
402
          Valid values are 256, 512, 1024, 2048, 4096.  Default is 1024.
331
403
        Use -t to select the communications type.
416
488
--------------
417
489
 
418
490
 - we need to replace the getrusage stuff from version 2.4 with a dummy
419
 
   workload
 
491
   workload ... We have a working version using DGEMM internally, email
 
492
   netpipe@lists.scl.ameslab.gov for more info.
 
493
 - the ibv module needs to have better documentation, and support for the CM
420
494