mirror of
https://github.com/Spearfoot/disk-burnin-and-testing.git
synced 2025-12-05 23:53:31 +00:00
add docs from file header to help text
add -e option for "extended" help text move option parsing to the top to be able to always display help text add Tiny Core Linux 11.1 to tested OS; add IronWolf HDD to tested HDDs consolidate help text and README.md
This commit is contained in:
Michael Schnerring
57
README.md
57
README.md
@@ -8,9 +8,9 @@
|
||||
|
||||
Be warned that:
|
||||
|
||||
* This script runs the `badblocks` program in destructive mode, which erases any data on the disk. Therefore, please be careful! __Do not run this script on disks containing data you value!__
|
||||
* Run times for large disks can take several days to a week or more to complete, so it is a good idea to use `tmux` sessions to prevent mishaps.
|
||||
* Must be run as 'root', so either log on using the root account or use the `sudo` command, for example: `sudo ./disk_burnin.sh sda`
|
||||
* This script runs `badblocks` in destructive mode, which erases any data on the disk. Therefore, please be careful! __Do not run this script on disks containing valuable data!__
|
||||
* Run times for large disks can be several days. Use tmux or screen to test multiple disks in parallel.
|
||||
* Must be run as 'root'.
|
||||
|
||||
## Tests
|
||||
|
||||
@@ -48,29 +48,41 @@ The script extracts the drive model and serial number and creates a log filename
|
||||
* `-s` : Show progress
|
||||
* `-w` : Write-mode test, writes four patterns (0xaa, 0x55, 0x44, 0x00) on every disk block
|
||||
|
||||
The only required command-line argument is the device specifier, e.g.:
|
||||
## Usage
|
||||
|
||||
`./disk-burnin.sh sda`
|
||||
`./disk-burnin.sh [-h] [-f] [-o <directory>] <disk>`
|
||||
|
||||
...will run the burn-in test on device /dev/sda
|
||||
### Options
|
||||
|
||||
## Dry Run Mode
|
||||
* `-h`: show help text
|
||||
* `-e`: show extended help text
|
||||
* `-f`: run in destructive, non-dry mode. **ALL DATA ON THE DISK WILL BE LOST!**
|
||||
* `-o <directory>`: write log files to `<directory>` (default: working directory `$(pwd)`)
|
||||
* `<disk>`: disk to burn-in (`/dev/` may be omitted)
|
||||
|
||||
The script supports a 'dry run mode' which lets you check the sleep duration calculations and insure that the sequence of commands suits your needs without actually performing any operations on disks. In 'dry runs' the script does not perform any SMART tests or invoke the `sleep` or `badblocks` programs.
|
||||
### Examples
|
||||
|
||||
The script was formerly distributed with 'dry run mode' enabled by default, but this is no longer the case. You will have to edit the script and set the `Dry_Run` variable to a non-zero value to enable 'dry runs'.
|
||||
* `./disk-burnin.sh sda`: run in dry-run mode on disk `/dev/sda`
|
||||
* `./disk-burnin.sh -f /dev/sdb`: run in destructive, non-dry mode on disk `/dev/sdb`
|
||||
* `./disk-burnin.sh -fo ~/burn-in-logs sdc`: run in destructive, non-dry mode on disk `/dev/sdc` and write the log files to `~/burn-in-logs` directory
|
||||
|
||||
## Dry-Run Mode
|
||||
|
||||
The script runs in dry-run mode by default, so you can check the sleep durations and to insure that the sequence of commands suits your needs. In dry-run mode the script does not actually perform any SMART tests or invoke the `sleep` or `badblocks` programs.
|
||||
|
||||
In order to perform tests on drives, you will need to provide the `-f` option.
|
||||
|
||||
## `smartctl` Device Type
|
||||
|
||||
Some users with atypical hardware environments may need to modify the script and specify the `smartctl` command device type explictly with the `-d` option. User __bcmryan__ reports success using `-d sat` with a Western Digital MyBook 8TB external drive enclosure.
|
||||
|
||||
## FreeBSD/FreeNAS Notes
|
||||
## FreeBSD / FreeNAS Notes
|
||||
|
||||
Before using the script on FreeBSD systems (including FreeNAS) you should first execute the `sysctl` command below to alter the kernel's geometry debug flags. This allows `badblocks` to write to the entire disk:
|
||||
Before using the script on FreeBSD systems (including FreeNAS) you must first execute this ´sysctl´ command to alter the kernel's geometry debug flags. This allows `badblocks` to write to the entire disk:
|
||||
|
||||
`sysctl kern.geom.debugflags=0x10`
|
||||
|
||||
Also note that `badblocks` may issue the following warning under FreeBSD/FreeNAS, which can safely be ignored as it has no effect on testing:
|
||||
Also note that `badblocks` may issue the following warning under FreeBSD / FreeNAS, which can safely be ignored as it has no effect on testing:
|
||||
|
||||
`set_o_direct: Inappropiate ioctl for device`
|
||||
|
||||
@@ -83,17 +95,30 @@ Tested under:
|
||||
* FreeNAS 11.2-U8 (FreeBSD 11.2-STABLE)
|
||||
* Ubuntu Server 16.04.2 LTS
|
||||
* CentOS 7.0
|
||||
* Tiny Core Linux 11.1
|
||||
|
||||
## Drive Models Tested
|
||||
|
||||
The script should run successfully on any SATA disk with SMART capabilities, which includes just about all modern drives. It has been tested on these particular devices:
|
||||
|
||||
* HGST Deskstar NAS, UltraStar, UltraStar He10, and UltraStar He12 models
|
||||
* Western Digital Gold, Black, and Re models
|
||||
* Intel
|
||||
* DC S3700 SSD
|
||||
* Model 320 Series SSD
|
||||
* HGST
|
||||
* Deskstar NAS (HDN724040ALE640)
|
||||
* Ultrastar 7K4000 (HUS724020ALE640)
|
||||
* Ultrastar He10
|
||||
* Ultrastar He12
|
||||
* Western Digital
|
||||
* Black (WD6001FZWX)
|
||||
* Gold
|
||||
* Re (WD4000FYYZ)
|
||||
* Seagate
|
||||
* IronWolf NAS HDD 12TB (ST12000VN0008)
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Requires the smartmontools, available at [www.smartmontools.org](https://www.smartmontools.org)
|
||||
smartmontools, available at [www.smartmontools.org](https://www.smartmontools.org)
|
||||
|
||||
Uses: `grep`, `awk`, `sed`, `sleep`, `badblocks`
|
||||
|
||||
@@ -102,4 +127,4 @@ Tested with the static analysis tool at [www.shellcheck.net](https://www.shellch
|
||||
## Author
|
||||
|
||||
Written by Keith Nash, March 2017.
|
||||
Modified on 19 August 2020.
|
||||
Modified on 9 September 2020.
|
||||
|
||||
362
disk-burnin.sh
362
disk-burnin.sh
@@ -1,177 +1,193 @@
|
||||
#!/bin/sh
|
||||
########################################################################
|
||||
#
|
||||
# disk-burnin.sh
|
||||
#
|
||||
# A script to simplify the process of burning-in disks. Intended for use
|
||||
# only on disks which do not contain valuable data, such as new disks or
|
||||
# disks which are being tested or re-purposed.
|
||||
#
|
||||
# Be aware that:
|
||||
#
|
||||
# 1> This script runs the badblocks program in destructive mode, which
|
||||
# erases any data on the disk.
|
||||
#
|
||||
# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
# !!!!! WILL DESTROY THE DISK CONTENTS! BE CAREFUL! !!!!!
|
||||
# !!!!! DO NOT RUN THIS SCRIPT ON DISKS CONTAINING DATA YOU VALUE !!!!!
|
||||
# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
#
|
||||
# 2> Run times for large disks can take several days to complete, so it
|
||||
# is a good idea to use tmux sessions to prevent mishaps.
|
||||
#
|
||||
# 3> Must be run as 'root'.
|
||||
#
|
||||
# 4> Tests of large drives can take days to complete: use tmux!
|
||||
#
|
||||
# Performs these steps:
|
||||
#
|
||||
# 1> Run SMART short test
|
||||
# 2> Run badblocks
|
||||
# 3> Run SMART extended test
|
||||
#
|
||||
# The script sleeps after starting each SMART test, using a duration
|
||||
# based on the polling interval reported by the disk, after which the
|
||||
# script will poll the disk to verify the self-test has completed.
|
||||
#
|
||||
# Full SMART information is pulled after each SMART test. All output
|
||||
# except for the sleep command is echoed to both the screen and log file.
|
||||
#
|
||||
# You should monitor the burn-in progress and watch for errors, particularly
|
||||
# any errors reported by badblocks, or these SMART errors:
|
||||
#
|
||||
# 5 Reallocated_Sector_Ct
|
||||
# 196 Reallocated_Event_Count
|
||||
# 197 Current_Pending_Sector
|
||||
# 198 Offline_Uncorrectable
|
||||
#
|
||||
# These indicate possible problems with the drive. You therefore may
|
||||
# wish to abort the remaining tests and proceed with an RMA exchange
|
||||
# for new drives or discard old ones. Also please note that this list
|
||||
# is not exhaustive.
|
||||
#
|
||||
# The script extracts the drive model and serial number and forms
|
||||
# a log filename of the form 'burnin-[model]_[serial number].log'.
|
||||
#
|
||||
# badblocks is invoked with a block size of 4096, the -wsv options, and
|
||||
# the -o option to instruct it to write the list of bad blocks found (if
|
||||
# any) to a file named 'burnin-[model]_[serial number].bb'.
|
||||
#
|
||||
# The only required command-line argument is the device specifier, e.g.:
|
||||
#
|
||||
# ./disk-burnin.sh sda
|
||||
#
|
||||
# ...will run the burn-in test on device /dev/sda
|
||||
#
|
||||
# You can run the script in 'dry run mode' (see below) to check the sleep
|
||||
# duration calculations and to insure that the sequence of commands suits
|
||||
# your needs. In 'dry runs' the script does not actually perform any
|
||||
# SMART tests or invoke the sleep or badblocks programs. The script is
|
||||
# distributed with 'dry runs' enabled, so you will need to edit the
|
||||
# DRY_RUN variable below, setting it to 0, in order to actually perform
|
||||
# tests on drives.
|
||||
#
|
||||
# Before using the script on FreeBSD systems (including FreeNAS) you must
|
||||
# first execute this sysctl command to alter the kernel's geometry debug
|
||||
# flags. This allows badblocks to write to the entire disk:
|
||||
#
|
||||
# sysctl kern.geom.debugflags=0x10
|
||||
#
|
||||
# Tested under:
|
||||
# FreeNAS 9.10.2 (FreeBSD 10.3-STABLE)
|
||||
# Ubuntu Server 16.04.2 LTS
|
||||
#
|
||||
# Tested on:
|
||||
# Intel DC S3700 SSD
|
||||
# Intel Model 320 Series SSD
|
||||
# HGST Deskstar NAS (HDN724040ALE640)
|
||||
# Hitachi/HGST Ultrastar 7K4000 (HUS724020ALE640)
|
||||
# Western Digital Re (WD4000FYYZ)
|
||||
# Western Digital Black (WD6001FZWX)
|
||||
#
|
||||
# Requires the smartmontools, available at https://www.smartmontools.org
|
||||
#
|
||||
# Uses: grep, awk, sed, sleep, badblocks
|
||||
#
|
||||
# Written by Keith Nash, March 2017
|
||||
#
|
||||
# KN, 8 Apr 2017:
|
||||
# Added minimum test durations because some devices don't return accurate values.
|
||||
# Added code to clean up the log file, removing copyright notices, etc.
|
||||
# No longer echo 'smartctl -t' output to log file as it imparts no useful information.
|
||||
# Emit test results after tests instead of full 'smartctl -a' output.
|
||||
# Emit full 'smartctl -x' output at the end of all testing.
|
||||
# Minor changes to log output and formatting.
|
||||
#
|
||||
# KN, 12 May 2017:
|
||||
# Added code to poll the disk and check for completed self-tests.
|
||||
#
|
||||
# As noted above, some disks don't report accurate values for the short and extended
|
||||
# self-test intervals, sometimes by a significant amount. The original approach using
|
||||
# 'fudge' factors wasn't reliable and the script would finish even though the SMART
|
||||
# self-tests had not completed. The new polling code helps insure that this doesn't
|
||||
# happen.
|
||||
#
|
||||
# Fixed code to work around annoying differences between sed's behavior on Linux and
|
||||
# FreeBSD.
|
||||
#
|
||||
# KN, 8 Jun 2017
|
||||
# Modified parsing of short and extended test durations to accommodate the values
|
||||
# returned by larger drives; we needed to strip out the '(' and ')' characters
|
||||
# surrounding the integer value in order to fetch it reliably.
|
||||
#
|
||||
# KN, 19 Aug 2020
|
||||
# Changed DRY_RUN value so that dry runs are no longer the default setting.
|
||||
# Changed badblocks call to exit immediately on first error.
|
||||
# Set logging directoryto current working directory using pwd command.
|
||||
# Reduced default tests so that we run:
|
||||
# 1> Short SMART test
|
||||
# 2> badblocks
|
||||
# 3> Extended SMART test
|
||||
#
|
||||
################################################################################
|
||||
readonly USAGE=\
|
||||
"NAME
|
||||
$(basename "$0") -- disk burn-in program
|
||||
|
||||
SYNOPSIS
|
||||
$(basename "$0") [-h] [-f] [-o <directory>] <disk>
|
||||
|
||||
DESCRIPTION
|
||||
A script to simplify the process of burning-in disks. Only intended for use
|
||||
on disks which do not contain any data, such as new disks or disks which
|
||||
are being tested or re-purposed.
|
||||
|
||||
The script runs in dry-run mode by default, so you can check the sleep
|
||||
durations and to insure that the sequence of commands suits your needs. In
|
||||
dry-run mode the script does not actually perform any SMART tests or invoke
|
||||
the sleep or badblocks programs.
|
||||
|
||||
In order to perform tests on drives, you will need to provide the -f option.
|
||||
|
||||
OPTIONS
|
||||
-h show help text
|
||||
-e show extended help text
|
||||
-f run in destructive, non-dry mode
|
||||
ALL DATA ON THE DISK WILL BE LOST!
|
||||
-o <directory> write log files to <directory> (default: $(pwd))
|
||||
<disk> disk to burn-in (/dev/ may be omitted)
|
||||
|
||||
EXAMPLES
|
||||
$(basename "$0") sda
|
||||
run in dry-run mode on disk /dev/sda
|
||||
|
||||
$(basename "$0") -f /dev/sdb
|
||||
run in destructive, non-dry mode on disk /dev/sdb
|
||||
|
||||
$(basename "$0") -fo ~/burn-in-logs sdc
|
||||
run in destructive, non-dry mode on disk /dev/sdc and
|
||||
write the log files to ~/burn-in-logs directory
|
||||
|
||||
EXIT STATUS
|
||||
exit 0: script finishes successfully
|
||||
exit 2: dependencies are missing
|
||||
not running as 'root'
|
||||
illegal options are provided
|
||||
"
|
||||
readonly USAGE_2=\
|
||||
"NOTES
|
||||
Be warned that:
|
||||
|
||||
1> The script runs badblocks in destructive mode, which erases any data
|
||||
on the disk.
|
||||
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!!!! ALL DATA ON THE DISK WILL BE LOST! BE CAREFUL! !!!!
|
||||
!!!! DO NOT RUN THIS SCRIPT ON DISKS CONTAINING VALUABLE DATA !!!!
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
|
||||
2> Run times for large disks can be several days. Use tmux or screen
|
||||
to test multiple disks in parallel.
|
||||
|
||||
3> Must be run as 'root'.
|
||||
|
||||
4> The script has the following dependencies:
|
||||
|
||||
smartmontools, available at https://www.smartmontools.org
|
||||
Uses: grep, awk, sed, sleep, badblocks
|
||||
|
||||
Performs this test sequence:
|
||||
|
||||
1> Run SMART short test
|
||||
2> Run badblocks
|
||||
3> Run SMART extended test
|
||||
|
||||
The script sleeps after starting each SMART test, using a duration based on
|
||||
the polling interval reported by the disk, after which the script will poll
|
||||
the disk to verify the self-test has completed.
|
||||
|
||||
Full SMART information is pulled after each SMART test. All output except
|
||||
for the sleep command is written to both stdout and the log.
|
||||
|
||||
You should monitor the burn-in progress and watch for errors, particularly
|
||||
any errors reported by badblocks, or these SMART errors:
|
||||
|
||||
5 Reallocated_Sector_Ct
|
||||
196 Reallocated_Event_Count
|
||||
197 Current_Pending_Sector
|
||||
198 Offline_Uncorrectable
|
||||
|
||||
These indicate possible problems with the drive. You therefore may wish to
|
||||
abort the remaining tests and proceed with an RMA exchange for new drives or
|
||||
discard old ones. Please note that this list is not exhaustive.
|
||||
|
||||
The script extracts the drive model and serial number and forms a log file-
|
||||
name of the form 'burnin-[model]_[serial number].log'.
|
||||
|
||||
badblocks is invoked with a block size of 4096, the -wsv options, and the
|
||||
-o option to instruct it to write the list of bad blocks found (if any) to
|
||||
a file named 'burnin-[model]_[serial number].bb'.
|
||||
|
||||
Before using the script on FreeBSD systems (including FreeNAS) you must
|
||||
first execute this sysctl command to alter the kernel's geometry debug
|
||||
flags. This allows badblocks to write to the entire disk:
|
||||
|
||||
sysctl kern.geom.debugflags=0x10
|
||||
|
||||
Also note that badblocks may issue the following warning under FreeBSD /
|
||||
FreeNAS, which can safely be ignored as it has no effect on testing:
|
||||
|
||||
set_o_direct: Inappropiate ioctl for device
|
||||
|
||||
Tested operating systems:
|
||||
|
||||
FreeNAS 9.10.2 (FreeBSD 10.3-STABLE)
|
||||
FreeNAS 11.1-U7 (FreeBSD 11.1-STABLE)
|
||||
FreeNAS 11.2-U8 (FreeBSD 11.2-STABLE)
|
||||
Ubuntu Server 16.04.2 LTS
|
||||
CentOS 7.0
|
||||
Tiny Core Linux 11.1
|
||||
|
||||
Tested disks:
|
||||
|
||||
Intel
|
||||
DC S3700 SSD
|
||||
Model 320 Series SSD
|
||||
HGST
|
||||
Deskstar NAS (HDN724040ALE640)
|
||||
Ultrastar 7K4000 (HUS724020ALE640)
|
||||
Ultrastar He10
|
||||
Ultrastar He12
|
||||
Western Digital
|
||||
Black (WD6001FZWX)
|
||||
Gold
|
||||
Re (WD4000FYYZ)
|
||||
Seagate
|
||||
IronWolf NAS HDD 12TB (ST12000VN0008)
|
||||
|
||||
VERSIONS
|
||||
Written by Keith Nash, March 2017
|
||||
|
||||
KN, 8 Apr 2017:
|
||||
Added minimum test durations because some devices don't return accurate
|
||||
values.
|
||||
Added code to clean up the log file, removing copyright notices, etc.
|
||||
No longer echo 'smartctl -t' output to log file as it imparts no useful
|
||||
information.
|
||||
Emit test results after tests instead of full 'smartctl -a' output.
|
||||
Emit full 'smartctl -x' output at the end of all testing.
|
||||
Minor changes to log output and formatting.
|
||||
|
||||
KN, 12 May 2017:
|
||||
Added code to poll the disk and check for completed self-tests.
|
||||
|
||||
As noted above, some disks don't report accurate values for the short
|
||||
and extended self-test intervals, sometimes by a significant amount.
|
||||
The original approach using 'fudge' factors wasn't reliable and the
|
||||
script would finish even though the SMART self-tests had not completed.
|
||||
The new polling code helps insure that this doesn't happen.
|
||||
|
||||
Fixed code to work around annoying differences between sed's behavior
|
||||
on Linux and FreeBSD.
|
||||
|
||||
KN, 8 Jun 2017
|
||||
Modified parsing of short and extended test durations to accommodate the
|
||||
values returned by larger drives; we needed to strip out the '(' and ')'
|
||||
characters surrounding the integer value in order to fetch it reliably.
|
||||
|
||||
KN, 19 Aug 2020
|
||||
Changed DRY_RUN value so that dry runs are no longer the default
|
||||
setting.
|
||||
Changed badblocks call to exit immediately on first error.
|
||||
Set logging directory to current working directory using pwd command.
|
||||
Reduced default tests so that we run:
|
||||
1> Short SMART test
|
||||
2> badblocks
|
||||
3> Extended SMART test"
|
||||
|
||||
################################################################################
|
||||
# PRE-EXECUTION VALIDATION
|
||||
################################################################################
|
||||
|
||||
# Check required dependencies
|
||||
readonly DEPENDENCIES="awk badblocks grep sed sleep"
|
||||
for dependency in ${DEPENDENCIES}; do
|
||||
if ! command -v "${dependency}" > /dev/null 2>&1 ; then
|
||||
echo "Command '${dependency}' not found" >&2
|
||||
exit 2
|
||||
fi
|
||||
done
|
||||
|
||||
# Check if running as root
|
||||
if [ "$(id -u)" -ne 0 ]; then
|
||||
echo "Please run as root" >&2
|
||||
exit 2
|
||||
fi
|
||||
|
||||
readonly USAGE=\
|
||||
"$(basename "$0") -- program to burn-in disks
|
||||
|
||||
Usage:
|
||||
$(basename "$0") [-h] [-f] [-o <directory>] <disk>
|
||||
|
||||
By default the program runs in dry mode and no data will be lost.
|
||||
|
||||
Options:
|
||||
-h show help text
|
||||
-f run in destructive, non-dry mode
|
||||
ALL DATA ON THE DISK WILL BE LOST!
|
||||
-o <directory> write log files to <directory>
|
||||
default: $(pwd)
|
||||
<disk> disk to burn-in: /dev/<disk>
|
||||
e.g. specify 'sda' to burn-in '/dev/sda'"
|
||||
|
||||
while getopts ':hfo:' option; do
|
||||
# parse options
|
||||
while getopts ':hefo:' option; do
|
||||
case "${option}" in
|
||||
h) echo "${USAGE}"
|
||||
exit
|
||||
;;
|
||||
e) echo "${USAGE}"
|
||||
echo "${USAGE_2}"
|
||||
exit
|
||||
;;
|
||||
f) DRY_RUN=0
|
||||
;;
|
||||
o) LOG_DIR="${OPTARG}"
|
||||
@@ -194,6 +210,21 @@ if [ -z "$1" ]; then
|
||||
exit 2
|
||||
fi
|
||||
|
||||
# Check required dependencies
|
||||
readonly DEPENDENCIES="awk badblocks grep sed sleep"
|
||||
for dependency in ${DEPENDENCIES}; do
|
||||
if ! command -v "${dependency}" > /dev/null 2>&1 ; then
|
||||
echo "Command '${dependency}' not found" >&2
|
||||
exit 2
|
||||
fi
|
||||
done
|
||||
|
||||
# Check if running as root
|
||||
if [ "$(id -u)" -ne 0 ]; then
|
||||
echo "Please run as root" >&2
|
||||
exit 2
|
||||
fi
|
||||
|
||||
################################################################################
|
||||
# CONSTANTS
|
||||
################################################################################
|
||||
@@ -272,9 +303,6 @@ readonly DISK_MODEL
|
||||
# Get disk serial number
|
||||
readonly SERIAL_NUMBER="$(get_smart_info_value "Serial Number")"
|
||||
|
||||
# The script initially sleeps for a duration after a test is started.
|
||||
# Afterwards the completion status is repeatedly polled.
|
||||
|
||||
# SMART short test duration
|
||||
readonly SHORT_TEST_MINUTES="$(get_smart_test_duration "Short")"
|
||||
readonly SHORT_TEST_SECONDS="$(( SHORT_TEST_MINUTES * 60))"
|
||||
|
||||
Reference in New Issue
Block a user