ctdb/doc/ping_pong.1.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE refentry
   3         PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   4         "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
   5 <refentry id="ping_pong.1">
   6
   7   <refmeta>
   8     <refentrytitle>ping_pong</refentrytitle>
   9     <manvolnum>1</manvolnum>
  10     <refmiscinfo class="source">ctdb</refmiscinfo>
  11     <refmiscinfo class="manual">CTDB - clustered TDB database</refmiscinfo>
  12   </refmeta>
  13
  14   <refnamediv>
  15     <refname>ping_pong</refname>
  16     <refpurpose>measures the ping-pong byte range lock latency</refpurpose>
  17   </refnamediv>
  18
  19   <refsynopsisdiv>
  20     <cmdsynopsis>
  21       <command>ping_pong</command>
  22       <group choice="req">
  23         <arg choice="plain">-r</arg>
  24         <arg choice="plain">-w</arg>
  25         <arg choice="plain">-rw</arg>
  26       </group>
  27       <arg>-m</arg>
  28       <arg>-c</arg>
  29       <arg choice="req"><replaceable>FILENAME</replaceable></arg>
  30       <arg choice="req"><replaceable>NUM-LOCKS</replaceable></arg>
  31     </cmdsynopsis>
  32   </refsynopsisdiv>
  33
  34   <refsect1>
  35     <title>DESCRIPTION</title>
  36     <para>
  37       ping_pong measures the byte range lock latency. It is especially
  38       useful on a cluster of nodes sharing a common lock manager as it
  39       will give some indication of the lock manager's performance
  40       under stress.
  41     </para>
  42
  43     <para>
  44       FILENAME is a file on shared storage to use for byte range
  45       locking tests.
  46     </para>
  47
  48     <para>
  49       NUM-LOCKS is the number of byte range locks, so needs to be
  50       (strictly) greater than the number of nodes in the cluster.
  51     </para>
  52   </refsect1>
  53
  54   <refsect1>
  55     <title>OPTIONS</title>
  56
  57     <variablelist>
  58       <varlistentry>
  59         <term>-r</term>
  60         <listitem>
  61           <para>
  62             test read performance
  63           </para>
  64         </listitem>
  65       </varlistentry>
  66
  67       <varlistentry>
  68         <term>-w</term>
  69         <listitem>
  70           <para>
  71             test write performance
  72           </para>
  73         </listitem>
  74       </varlistentry>
  75
  76       <varlistentry>
  77         <term>-m</term>
  78         <listitem>
  79           <para>
  80             use mmap
  81           </para>
  82         </listitem>
  83       </varlistentry>
  84
  85       <varlistentry>
  86         <term>-c</term>
  87         <listitem>
  88           <para>
  89             validate the locks
  90           </para>
  91         </listitem>
  92       </varlistentry>
  93
  94     </variablelist>
  95   </refsect1>
  96
  97   <refsect1>
  98     <title>EXAMPLES</title>
  99     <para>
 100       Testing lock coherence
 101     </para>
 102     <screen format="linespecific">
 103       ping_pong test.dat N
 104     </screen>
 105
 106     <para>
 107       Testing lock coherence with lock validation
 108     </para>
 109     <screen format="linespecific">
 110       ping_pong -c test.dat N
 111     </screen>
 112
 113     <para>
 114       Testing IO coherence
 115     </para>
 116     <screen format="linespecific">
 117       ping_pong -rw test.dat N
 118     </screen>
 119   </refsect1>
 120
 121   <refsect1>
 122     <title>SEE ALSO</title>
 123     <para>
 124       <citerefentry><refentrytitle>ctdb</refentrytitle>
 125       <manvolnum>7</manvolnum></citerefentry>,
 126
 127       <ulink url="https://wiki.samba.org/index.php/Ping_pong"/>
 128
 129     </para>
 130   </refsect1>
 131
 132   <refentryinfo>
 133     <author>
 134       <contrib>
 135         This documentation was written by Mathieu Parent
 136       </contrib>
 137     </author>
 138
 139     <copyright>
 140       <year>2002</year>
 141       <holder>Andrew Tridgell</holder>
 142     </copyright>
 143     <legalnotice>
 144       <para>
 145         This program is free software; you can redistribute it and/or
 146         modify it under the terms of the GNU General Public License as
 147         published by the Free Software Foundation; either version 3 of
 148         the License, or (at your option) any later version.
 149       </para>
 150       <para>
 151         This program is distributed in the hope that it will be
 152         useful, but WITHOUT ANY WARRANTY; without even the implied
 153         warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 154         PURPOSE.  See the GNU General Public License for more details.
 155       </para>
 156       <para>
 157         You should have received a copy of the GNU General Public
 158         License along with this program; if not, see
 159         <ulink url="http://www.gnu.org/licenses"/>.
 160       </para>
 161     </legalnotice>
 162   </refentryinfo>
 163
 164 </refentry>