dbench.1

   1 .\"                                      Hey, EMACS: -*- nroff -*-
   2 .\" First parameter, NAME, should be all caps
   3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
   4 .\" other parameters are allowed: see man(7), man(1)
   5 .TH DBENCH 1 "October 15, 2001"
   6 .\" Please adjust this date whenever revising the manpage.
   7 .\"
   8 .\" Some roff macros, for reference:
   9 .\" .nh        disable hyphenation
  10 .\" .hy        enable hyphenation
  11 .\" .ad l      left justify
  12 .\" .ad b      justify to both left and right margins
  13 .\" .nf        disable filling
  14 .\" .fi        enable filling
  15 .\" .br        insert line break
  16 .\" .sp <n>    insert n+1 empty lines
  17 .\" for manpage-specific macros, see man(7)
  18 .SH NAME
  19 dbench \- Measure disk throughput for simulated netbench run
  20 .SH SYNOPSIS
  21 .B dbench
  22 .RI [ options ] numclients
  23 .br
  24 .B tbench
  25 .RI [ options ] numclients server
  26 .B tbench_srv
  27 .RI [ options ]
  28 .SH DESCRIPTION
  29 This manual page documents briefly the
  30 .B dbench
  31 and
  32 .B tbench
  33 benchmarks.
  34 This manual page was written for the Debian GNU/Linux distribution
  35 because the original program does not have a manual page.  However,
  36 it has fairly easy to read source code.
  37 .PP
  38 .\" TeX users may be more comfortable with the \fB<whatever>\fP and
  39 .\" \fI<whatever>\fP escape sequences to invode bold face and italics,
  40 .\" respectively.
  41 Netbench is a terrible benchmark, but it's an "industry standard" and
  42 it's what is used in the press to rate windows fileservers like Samba
  43 and WindowsNT.
  44 .br
  45 Given the requirements of running netbench (60 and 150 Windows PCs all
  46 on switched fast ethernet and a really grunty server, and a to open up
  47 netbench to the masses.
  48 .br
  49 Both \fBdbench\fP and \fBtbench\fP read a load description file called
  50 client.txt that was derived from a capture of a real
  51 netbench run. client.txt is about 25MB and describes the
  52 500 thousand operations that a netbench client does in a typical
  53 netbench run. They parse client.txt and use it to produce
  54 the same load without having to buy a huge lab.
  55 .br
  56 dbench produces only the filesystem load. It does all the same IO
  57 calls that the smbd server in Samba would produce when confronted with
  58 a netbench run. It does no networking calls.
  59 .br
  60 tbench produces only the TCP and process load. It does the same socket
  61 calls that smbd would do under a netbench load. It does no filesystem
  62 calls. The idea behind tbench is to eliminate smbd from the netbench
  63 test, as though the smbd code could be made infinately fast.
  64 .SH OPTIONS
  65 The \fBdbench\fP program takes a number, which indicates the number of clients to run simultaneously.  It can also take the following options:
  66 .TP
  67 .B \-c client.txt
  68 Use this as the full path name of the client.txt file (the default is
  69 /usr/share/dbench/client.txt).
  70 .TP
  71 .B \-s
  72 Use synchronous file IO on all file operations.
  73 .TP
  74 .B \-t TIME
  75 set the runtime of the benchmark in seconds (default 600)
  76 .TP
  77 .B \-D DIR
  78 set the base directory to run the filesystem operations in
  79 .TP
  80 .B \-x
  81 enable xattr support, simulating the xattr operations Samba4 would
  82 need to perform to run the load
  83 .TP
  84 .B \-S
  85 Use synchronous IO for all directory operations (unlink, rmdir, mkdir
  86 and rename).
  87 .br
  88 The \fBtbench\fP program takes a number, which indicates the number of
  89 clients to run simultaneously, and a server name: \fBtbench_srv\fP
  90 should be invoked on that server before invoking \fBtbench\fP.
  91 \fBtbench\fP can also take the following options:
  92 .TP
  93 .B \-c loadfile
  94 Use this as the full path name of the client.txt file (the default is
  95 /usr/share/dbench/client.txt).
  96 .TP
  97 .B \-T option[,...]
  98 This sets the socket options for the connection to the server.  The
  99 options are a comma-separated list of one or more of the following:
 100 .BR "SO_KEEPALIVE" ,
 101 .BR "SO_REUSEADDR" ,
 102 .BR "SO_BROADCAST" ,
 103 .BR "SO_NODELAY" ,
 104 .BR "SO_LOWDELAY" ,
 105 .BR "SO_THROUGHPUT" ,
 106 .BR "SO_SNDBUF" =number,
 107 .BR "SO_RCVBUF" =number,
 108 .BR "SO_SNDLOWAT" =number,
 109 .BR "SO_RCVLOWAT" =number,
 110 .BR "SO_SNDTIMEO" =number, and
 111 .BR "SO_RCVTIMEO" =number.
 112 See
 113 .BR socket (7)
 114 for details about these options.
 115 .br
 116 The \fBtbench_srv\fP can only take one option:
 117 .B \-t option[,...]
 118 as documented above.
 119 .SH SEE ALSO
 120 .I /usr/share/doc/dbench/README
 121 contains the original README by Andrew Tridgell which accompanies the
 122 dbench source.
 123 .SH AUTHOR
 124 This manual page was written by Paul Russell <prussell@alderaan.franken.de>,
 125 for the Debian GNU/Linux system (but may be used by others).