LUDOC-349 utils: remove loadgen documentation

The loadgen tool was removed by http://review.whamcloud.com/12395
"LU-2675 utils: remove loadgen" and should not be in the manual.

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Change-Id: Ia05ec8180fbf4c3b74f511962835a46c419b4338
Reviewed-on: http://review.whamcloud.com/21731
Tested-by: Jenkins

diff --git a/SystemConfigurationUtilities.xml b/SystemConfigurationUtilities.xml
index c4d65c2..40a179d 100644 (file)
--- a/SystemConfigurationUtilities.xml
+++ b/SystemConfigurationUtilities.xml
@@ -2615,115 +2615,6 @@ Application Profiling Utilities</title>
 Testing / Debugging Utilities</title>
       <para>Lustre offers the following test and debugging utilities.</para>
       <section remap="h5">
-        <title><indexterm><primary>loadgen</primary></indexterm>
-loadgen</title>
-        <para>The Load Generator (loadgen) is a test program designed to simulate large numbers of Lustre clients connecting and writing to an OST. The loadgen utility is located at lustre/utils/loadgen (in a build directory) or at /usr/sbin/loadgen (from an RPM).</para>
-        <para>Loadgen offers the ability to run this test:</para>
-        <orderedlist>
-          <listitem>
-            <para>Start an arbitrary number of (echo) clients.</para>
-          </listitem>
-          <listitem>
-            <para>Start and connect to an echo server, instead of a real OST.</para>
-          </listitem>
-          <listitem>
-            <para>Create/bulk_write/delete objects on any number of echo clients simultaneously.</para>
-          </listitem>
-        </orderedlist>
-        <para>Currently, the maximum number of clients is limited by MAX_OBD_DEVICES and the amount of memory available.</para>
-      </section>
-      <section remap="h5">
-        <title>Usage</title>
-        <para>The loadgen utility can be run locally on the OST server machine or remotely from any LNET host. The device command can take an optional NID as a parameter; if unspecified, the first local NID found is used.</para>
-        <para>The obdecho module must be loaded by hand before running loadgen.</para>
-        <screen># cd lustre/utils/ 
-# insmod ../obdecho/obdecho.ko 
-# ./loadgen 
-loadgen&gt; h 
-This is a test program used to simulate large numbers of clients. The echo \
-obds are used, so the obdecho module must be loaded. 
- 
-Typical usage would be: 
-loadgen&gt; dev lustre-OST0000       set the target device 
-loadgen&gt; start 20                 start 20 echo clients 
-loadgen&gt; wr 10 5                  have 10 clients do simultaneous brw_write \
-tests 5 times each 
- 
-Available commands are: 
-   device 
-   dl 
-   echosrv 
-   start 
-   verbose 
-   wait 
-   write 
-   help 
-   exit 
-   quit 
- 
-For more help type: help command-name 
-loadgen&gt; 
-loadgen&gt; device lustre-OST0000 192.168.0.21@tcp 
-Added uuid OSS_UUID: 192.168.0.21@tcp 
-Target OST name is &apos;lustre-OST0000&apos; 
-loadgen&gt; 
-loadgen&gt; st 4 
-start 0 to 4 
-./loadgen: running thread #1 
-./loadgen: running thread #2 
-./loadgen: running thread #3 
-./loadgen: running thread #4 
-loadgen&gt; wr 4 5 
-Estimate 76 clients before we run out of grant space (155872K / 2097152) 
-1: i0 
-2: i0 
-4: i0 
-3: i0 
-1: done (0) 
-2: done (0) 
-4: done (0) 
-3: done (0) 
-wrote 25MB in 1.419s (17.623 MB/s) 
-loadgen&gt; 
-</screen>
-        <para>The loadgen utility prints periodic status messages; message output can be controlled with the verbose command.</para>
-        <para>To insure that a file can be written to (a requirement of write cache), OSTs reserve (&quot;grants&quot;), chunks of space for each newly-created file. A grant may cause an OST to report that it is out of space, even though there is plenty of space on the disk, because the space is &quot;reserved&quot; by other files. The loadgen utility estimates the number of simultaneous open files as the disk size divided by the grant size and reports that number when the write tests are first started.</para>
-        <para>Echo Server</para>
-        <para>The loadgen utility can start an echo server. On another node, loadgen can specify the echo server as the device, thus creating a network-only test environment.</para>
-        <screen>loadgen&gt; echosrv 
-loadgen&gt; dl 
-   0 UP obdecho echosrv echosrv 3 
-   1 UP ost OSS OSS 3 
-</screen>
-        <para>On another node:</para>
-        <screen>loadgen&gt; device echosrv cfs21@tcp 
-Added uuid OSS_UUID: 192.168.0.21@tcp 
-Target OST name is &apos;echosrv&apos; 
-loadgen&gt; st 1 
-start 0 to 1 
-./loadgen: running thread #1 
-loadgen&gt; wr 1 
-start a test_brw write test on X clients for Y iterations 
-usage: write &lt;num_clients&gt; &lt;num_iter&gt; [&lt;delay&gt;] 
-loadgen&gt; wr 1 1 
-loadgen&gt; 
-1: i0 
-1: done (0) 
-wrote 1MB in 0.029s (34.023 MB/s)
-</screen>
-        <para>Scripting</para>
-        <para>The threads all perform their actions in non-blocking mode; use the wait command to block for the idle state. For example:</para>
-        <screen>#!/bin/bash 
-./loadgen &lt;&lt; EOF 
-device lustre-OST0000 
-st 1 
-wr 1 10 
-wait 
-quit 
-EOF 
-</screen>
-      </section>
-      <section remap="h5">
         <title><indexterm><primary>lr_reader</primary></indexterm>
 lr_reader</title>
         <para>The lr_reader utility translates the content of the <literal>last_rcvd</literal> and <literal>reply_data</literal> files into human-readable form.</para>