Whamcloud - gitweb
b=21452 kABI tracking
[fs/lustre-release.git] / lustre / doc / llverdev.8
1 .\" -*- nroff -*-
2 .\" Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
3 .\" This file may be copied under the terms of the GNU Public License, v2.
4 .\"
5 .TH llverdev 8 "2008 Mar 15" Lustre "configuration utilities"
6 .SH NAME
7 llverdev - verify a block device is functioning properly over its full size
8 .SH SYNOPSIS
9 .BI llverdev
10 .RB [ -c
11 .IR chunksize ]
12 .RB [ -f "] [" -h ]
13 .RB [ -o
14 .IR offset ]
15 .RB [ -l "] [" -p "] [" -r ]
16 .RB [ -t
17 .IR timestamp ]
18 .RB [ -v "] [" -w ]
19 .I device
20 .SH DESCRIPTION
21 Sometimes kernel drivers or hardware devices have bugs that prevent them from
22 accessing the full device size correctly, or possibly have bad sectors on disk
23 or other problems which prevent proper data storage.  There are often defects
24 associated with major system boundaries such as 2^32 bytes, 2^31 sectors,
25 2^31 blocks, 2^32 blocks, etc.
26 .PP
27 The
28 .B llverdev
29 tool will write and verify a unique test pattern across the entire device in
30 order to ensure that not only is data accessible after it was written, but
31 also that data written to one part of the disk is not overwriting data on
32 another part of the disk.
33 .PP
34 It is expected that llverdev tool will be run on large size devices (TB), 
35 so it is always better to run llverdev tool in verbose mode, so that one
36 can easily restart device testing from the point at which it had stopped. 
37 .PP
38 Running a full verification can be time consuming for very large devices,
39 so it is advisable to start with a partial verification to ensure the
40 device is minimally sane before investing the time in a full verification.
41 .SH OPTIONS
42 .TP
43 .BR -c | --chunksize
44 IO chunk size in bytes (default=1048576).
45 .TP
46 .BR -f | --force
47 force test to run without confirmation that the device will be overwritten
48 and all data therein will be permanently destroyed.
49 .TP
50 .BR -h | --help
51 display a brief help message.
52 .TP
53 .BI -o offset
54 offset in kilobytes of start of test (default=0).
55 .TP
56 .BR -l | --long
57 Run a full check, writing and then reading and verifying every block on the
58 disk.
59 .TP
60 .BR -p | --partial
61 Run a partial check, only doing periodic checks across the device (1GB steps).
62 .TP
63 .BR -r | --read
64 Run test in read (verify) mode only, after having run the test in
65 .B -w
66 mode previously.
67 .TP
68 .BI -t timestamp
69 Set test start time as printed at the start of a previously interrupted test
70 to ensure that the validation data is the same across the whole filesystem
71 (default=current time())
72 .TP
73 .BR -v | --verbose
74 Run test in verbose mode, listing each read and write operation.
75 .TP
76 .BR -w | --write
77 Run test in write (test-pattern) mode (default run both read and write)
78 .SH EXAMPLES
79 .TP
80 Run a partial device verification on \fB/dev/sda\fR:
81 .B llverdev -v -p /dev/sda
82 .br
83 llverdev: permanently overwrite all data on /dev/sda (yes/no)? y
84 .br
85 llverdev: /dev/sda is 4398046511104 bytes (4096.0 GB) in size
86 .br
87 Timestamp: 1009839028
88 .br
89 Current write offset:        4096 kB
90 .TP
91 Continue an interrupted verification at offset \fB4096\fRkB from the start of the device, using the same timestamp as the previous run:
92 .B llverdev -f -v -p --offset=4096 --timestamp=1009839028 /dev/sda
93 .br
94 llverdev: /dev/sda is 4398046511104 bytes (4096.0 GB) in size
95 .br
96 Timestamp: 1009839028
97 .br
98 write complete
99 .br
100 read complete
101 .SH SEE ALSO
102 .BR llverfs (8)