Whamcloud - gitweb
LU-1617 build: skip generated files in .gitignore
[fs/lustre-release.git] / lnet / klnds / mxlnd / README
index cc87e7a..7467b42 100644 (file)
@@ -29,9 +29,12 @@ I. Installation
 ================
 
 MXLND is supported on Linux 2.6. It may be possible to run it on 2.4,
-but it has not been tested. MXLND requires Myricom's MX version 1.2.1
+but it has not been tested. MXLND requires Myricom's MX version 1.2.8
 or higher. See MX's README for the supported list of processors.
 
+MXLND requires the optional MX kernel library interface. MX must be compiled
+with --enable-kernel-lib.
+
 1. Configuring and compiling
 
 MXLND should be already integrated into the Lustre build process. To 
@@ -60,64 +63,46 @@ On some (older?) systems, you may need to modify /etc/modprobe.conf.
 
 The available options are:
 
-    n_waitd     # of completion daemons
-    max_peers   maximum number of peers that may connect
-    cksum       set non-zero to enable small message (< 4KB) checksums
-    ntx         # of total tx message descriptors
-    credits     # concurrent sends to a single peer
-    board       index value of the Myrinet board (NIC)
-    ep_id       MX endpoint ID
-    polling     Use 0 to block (wait). A value > 0 will poll that many times before blocking
-    hosts       IP-to-hostname resolution file
-
-Of these, only hosts is required. It must be the absolute path to the
-MXLND hosts file. For example:
-
-    options kmxlnd hosts=/etc/hosts.mxlnd
-
-The file format for the hosts file is as follows:
+    n_waitd    # of completion daemons
+    cksum      set non-zero to enable small message (< 4KB) checksums
+    ntx                # of total tx message descriptors
+    peercredits        # concurrent sends to one peer
+    board      index value of the Myrinet board
+    ep_id      MX endpoint ID
+    ipif_name  IPoMX interface name
+    polling    Use 0 to block (wait). A value > 0 will poll that many times before blocking
 
-IP  HOST  BOARD   EP_ID
+    credits    Unused - was # concurrent sends to all peers
+    max_peers  Unused - was maximum number of peers that may connect
+    hosts      Unused - was IP-to-hostname resolution file
 
-The values must be space and/or tab separated where:
-
-    IP is a valid IPv4 address
-    HOST is the name returned by `hostname` on that machine
-    BOARD is the index of the Myricom NIC (0 for the first card, etc.)
-    EP_ID is the MX endpoint ID
-
-You may want to vary the remaining options to obtain the optimal performance
-for your platform.
+You may want to vary the options to obtain the optimal performance for your
+platform.
 
     n_waitd sets the number of threads that process completed MX requests
 (sends and receives). In our testing, the default of 1 performed best.
 
-    max_peers tells MXLND the upper limit of machines that it will need to 
-communicate with. This affects how many receives it will pre-post and each
-receive will use one page of memory. Ideally, on clients, this value will
-be equal to the total number of Lustre servers (MDS and OSS). On servers,
-it needs to equal the total number of machines in the storage system.
-
     cksum turns on small message checksums. It can be used to aid in trouble-
 shooting. MX also provides an optional checksumming feature which can check 
 all messages (large and small). See the MX README for details.
 
-    ntx is the number of total sends in flight from this machine. In actuality,
-MXLND reserves half of them for connect messages so make this value twice as large
-as you want for the total number of sends in flight.
+    ntx is the number of total sends in flight from this machine.
 
-    credits is the number of in-flight messages for a specific peer. This is part
+    peercredits is the number of in-flight messages for a specific peer. This is part
 of the flow-control system in Lustre. Increasing this value may improve performance
 but it requires more memory since each message requires at least one page.
 
     board is the index of the Myricom NIC. Hosts can have multiple Myricom NICs
-and this identifies which one MXLND should use. This value must match the board
-value in your MXLND hosts file for this host.
+and this identifies which one MXLND should use.
 
     ep_id is the MX endpoint ID. Each process that uses MX is required to have at
 least one MX endpoint to access the MX library and NIC. The ID is a simple index
-starting at 0. This value must match the endpoint ID value in your MXLND hosts 
-file for this host.
+starting at 0. When used on a server, the server will attempt to use this end-
+point. When used on a client, it specifies the endpoint to connect to on the 
+management server.
+
+    ipif_name is the name of the Ethernet interface over MX. Generally, it is
+myriN, where N matches the MX board index.
 
     polling determines whether this host will poll or block for MX request com-
 pletions. A value of 0 blocks and any positive value will poll that many times
@@ -149,9 +134,9 @@ send email to help@myri.com.
 
 2. Multi-homing
 
-At this time, the MXLND cannot drive more than one interface at a time.  Thus,
-a single Lustre router cannot route between two MX-10G, between two MX-2G, or
-between MX-10G and MX-2G fabrics.
+At this time, the MXLND does not support more than one interface at a time.
+Thus, a single Lustre router cannot route between two MX-10G, between two
+MX-2G, or between MX-10G and MX-2G fabrics.
 
 3. MX endpoint collision