doc/dbench.1

   1 .\"     Title: dbench
   2 .\"    Author:
   3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
   4 .\"      Date: 09/15/2009
   5 .\"    Manual:
   6 .\"    Source:
   7 .\"
   8 .TH "DBENCH" "1" "09/15/2009" "" ""
   9 .\" disable hyphenation
  10 .nh
  11 .\" disable justification (adjust text to left margin only)
  12 .ad l
  13 .SH "NAME"
  14 dbench - a benchmark tool
  15 .SH "SYNOPSIS"
  16 .HP 29
  17 \fBdbench [OPTIONS] <num\-procs>\fR
  18 .HP 7
  19 \fBdbench\fR [\-B\ \-\-backend=<dbench\ backend>] [\-c\ \-\-loadfile=<filename>] [\-D\ \-\-directory=<string>] [\-F\ \-\-fsync] [\-R\ \-\-target\-rate=<double>] [\-s\ \-\-sync] [\-S\ \-\-sync\-dir] [\-t\ \-\-timelimit=<integer>] [\-T\ \-\-tcp\-options=<string>] [\-\-run\-once] [\-\-fake\-io] [\-\-scsi=<scsi\-device>] [\-\-server=<hostname>] [\-\-export=<string>] [\-\-protocol=<string>] [\-\-clients\-per\-process=<integer>] [\-\-trunc\-io=<integer>] [\-\-stat\-check] [\-\-skip\-cleanup] [\-\-per\-client\-results] [\-\-iscsi\-portal=<ip\-address>] [\-\-iscsi\-target=<iqn\ name>] [\-\-iscsi\-lun=<LUN>] [\-?\ \-\-help] [\-\-usage]
  20 .SH "DESCRIPTION"
  21 .PP
  22 dbench is a utility to benchmark a system based on client workload profiles\.
  23 .SH "STANDARD OPTIONS"
  24 .SS "\-B \-\-backend=<dbench backend>"
  25 .PP
  26 The backend type specifies which kind of commandset and what kind of tests that dbench will perform\. The backend type specifies which kind of loadfile that can be used\.
  27 .PP
  28 There are currently five types of backends : "fileio", "sockio", "nfs", "scsi"and "iscsi"\. The default is "fileio" which uses a CIFS style loadfile\.
  29 .SS "\-c \-\-loadfile=<filename>"
  30 .PP
  31 This specifies the name of the loadfile to use\. The loadfile describes the sequence and timing of operations that dbench will issue\.
  32 .SS "\-D \-\-directory=<string>"
  33 .PP
  34 This controls which directory that dbench will use as the root for when running the loadfile\. This defaults to "\." which refers to the current directory for the "fileio" and "sockio" backends and the root of the export for the "nfs" backend\.
  35 .SS "\-R \-\-target\-rate=<double>"
  36 .PP
  37 By default dbench will try to replay the loadfile and keep the same rate as the original application the loadfile was captured from\. Using this option it is possible to run the load file faster/slower than in the original capture\.
  38 .PP
  39 The argument is specified in MByte/second\. dbench tries to match this target rate by dynamically increasing/decreasing the delays beteen the inidvidual opertaions in the loadfile\. These calculations only take the READ and WRITE operations of the loadfile into account so this may not work reliable for loadfiles with very few READ/WRITE operations\.
  40 .PP
  41 By setting this limit to something very large, such as 999999\.99 you can effectively tell dbench to "run this loadfile as fast as possible"\.
  42 .SS "\-t \-\-timelimit=<integer>"
  43 .PP
  44 How long to run the test for\.
  45 .SS "\-\-run\-once"
  46 .PP
  47 Only run the loadfile once and stop when the end of the loadfile is reached\.
  48 .PP
  49 The default for dbench is to wrap the loadfile when the end is reached and continue running the loadfile over and over until the timelimit is reached\.
  50 .SS "\-\-clients\-per\-process=<integer>"
  51 .PP
  52 By default dbench will fork one child process for each client emulated\. Using this option dbench will run multiple emulated clients inside each process\.
  53 .PP
  54 This is useful for testing how performance differs between the case of n processes with one thread of I/O each and one process with n threads of I/O\.
  55 .SS "\-\-skip\-cleanup"
  56 .PP
  57 Do not cleanup and delete all temporary files in the clients work directory when the test ends\.
  58 .SS "\-\-per\-client\-results"
  59 .PP
  60 When the test is finished print a latency report for each inidvidual client in addition to the aggregated report over all clients\.
  61 .SH "FILEIO OPTIONS"
  62 .SS "\-F \-\-fsync"
  63 .PP
  64 This option only apply to the "fileio" backend\.
  65 .PP
  66 This will make dbench perform a fsync() to the file after each write operation\.
  67 .SS "\-s \-\-sync\-open"
  68 .PP
  69 This option only apply to the "fileio" backend\.
  70 .PP
  71 This makes dbench override the loadfile and use O_SYNC for all file open operations\.
  72 .SS "\-S \-\-sync\-dir"
  73 .PP
  74 This option only apply to the "fileio" backend\.
  75 .PP
  76 Call fsync() on the directory after each "unlink", "rmdir" or "rename" operation\. This emulates how the linux kernel nfs daemon syncs directories after performing directory modifying operations\.
  77 .SS "\-\-fake\-io"
  78 .PP
  79 This option only apply to the "fileio" backend\.
  80 .PP
  81 Do not do any file read/write operations at all\.
  82 .SS "\-\-stat\-check"
  83 .PP
  84 This option only apply to the "fileio" backend\.
  85 .PP
  86 After each create/mkdir/rmdir/rename operation, immediately try to stat() the object affected and verify that the return code from stat() is correct\. I\.e\. Verify that immediately after we have created an object that stat() will succeed and that immediately after we have deleted an object that stat() will fail\.
  87 .SH "SOCKIO OPTIONS"
  88 .SS "\-T \-\-tcp\-options=<string>"
  89 .PP
  90 This option only apply to the "sockio" backend\.
  91 .SH "NFS OPTIONS"
  92 .SS "\-\-server=<hostname>"
  93 .PP
  94 This option only apply to the "nfs" backend\.
  95 .PP
  96 This option is mandatory when the "nfs" backend is used\.
  97 .PP
  98 This specifies the host\-name or ip\-address of the server to test\.
  99 .SS "\-\-export=<string>"
 100 .PP
 101 This option only apply to the "nfs" backend\.
 102 .PP
 103 This option is mandatory when the "nfs" backend is used\.
 104 .PP
 105 This specifies the nfs\-export on the server to do i/o to\.
 106 .SS "\-\-protocol=<string>"
 107 .PP
 108 This option only apply to the "nfs" backend\.
 109 .PP
 110 This specifies whether "tcp" or "udp" is to be used\. Default is "tcp"\.
 111 .SS "\-\-trunc\-io=<integer>"
 112 .PP
 113 This option only apply to the "nfs" backend\.
 114 .PP
 115 Some NFS server may have limitations on how large READ/WRITE I/Os they accept preventing some loadfiles from running\. Using this option will override the length specified in the loadfile and make dbench never issuing any READ/WRITE operations larger than this\.
 116 .SH "SCSI OPTIONS"
 117 .SS "\-\-scsi=<scsi\-device>"
 118 .PP
 119 This option only apply to the "scsi" backend\.
 120 .PP
 121 This option is mandatory when the "scsi" backend is used\.
 122 .PP
 123 This specifies the device node of the scsi\-device we want to run the loadfile on\. Example: \-\-scsi=/dev/sda
 124 .SH "ISCSI OPTIONS"
 125 .PP
 126 Dbench contains a primitive iSCSI initiator, allowing it to perform I/O to some iSCSI targets\.
 127 .SS "\-\-iscsi\-portal=<ip\-address>"
 128 .PP
 129 This option only apply to the "iscsi" backend\.
 130 .PP
 131 This option is mandatory when the "iscsi" backend is used\.
 132 .PP
 133 This specifies the host\-name or ip\-address of the target to test\.
 134 .SS "\-\-iscsi\-target=<iqn name>"
 135 .PP
 136 This option only apply to the "iscsi" backend\.
 137 .PP
 138 This option is mandatory when the "iscsi" backend is used\.
 139 .PP
 140 This specifies the iscsi iqn name of the target to test\.
 141 .SS "\-\-iscsi\-lun=<LUN>"
 142 .PP
 143 This option only apply to the "iscsi" backend\.
 144 .PP
 145 This option is mandatory when the "iscsi" backend is used\.
 146 .PP
 147 This specifies the LUN of the target to test\.
 148 .SH "COPYRIGHT/LICENSE"
 149 .sp
 150 .RS 4
 151 .nf
 152 Copyright (C) Andrew Tridgell 2008
 153 Copyright (C) Ronnie Sahlberg 2008
 154
 155 This program is free software; you can redistribute it and/or modify
 156 it under the terms of the GNU General Public License as published by
 157 the Free Software Foundation; either version 3 of the License, or (at
 158 your option) any later version\.
 159
 160 This program is distributed in the hope that it will be useful, but
 161 WITHOUT ANY WARRANTY; without even the implied warranty of
 162 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE\.  See the GNU
 163 General Public License for more details\.
 164
 165 You should have received a copy of the GNU General Public License
 166 along with this program; if not, see http://www\.gnu\.org/licenses/\.
 167 .fi
 168 .RE