1#!/bin/bash
2
3#  Copyright (C) 2018 Oracle.  All Rights Reserved.
4#
5#  Author: Darrick J. Wong <darrick.wong@oracle.com>
6#
7#  This program is free software; you can redistribute it and/or
8#  modify it under the terms of the GNU General Public License
9#  as published by the Free Software Foundation; either version 2
10#  of the License, or (at your option) any later version.
11#
12#  This program is distributed in the hope that it would be useful,
13#  but WITHOUT ANY WARRANTY; without even the implied warranty of
14#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15#  GNU General Public License for more details.
16#
17#  You should have received a copy of the GNU General Public License
18#  along with this program; if not, write the Free Software Foundation,
19#  Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA.
20
21PATH=/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin
22
23if (( $EUID != 0 )); then
24    echo "e2scrub_all must be run as root"
25    exit 1
26fi
27
28periodic_e2scrub=0
29scrub_all=0
30snap_size_mb=256
31reap=0
32conffile="@root_sysconfdir@/e2scrub.conf"
33
34test -f "${conffile}" && . "${conffile}"
35
36scrub_args=""
37
38print_help() {
39	echo "Usage: $0 [OPTIONS]"
40	echo " -n: Show what commands e2scrub_all would execute."
41	echo " -r: Remove e2scrub snapshots."
42	echo " -A: Scrub all ext[234] filesystems even if not mounted."
43	echo " -V: Print version information and exit."
44}
45
46print_version() {
47	echo "e2scrub_all @E2FSPROGS_VERSION@ (@E2FSPROGS_DATE@)"
48}
49
50exitcode() {
51	ret="$1"
52
53	# If we're being run as a service, the return code must fit the LSB
54	# init script action error guidelines, which is to say that we
55	# compress all errors to 1 ("generic or unspecified error", LSB 5.0
56	# section 22.2) and hope the admin will scan the log for what
57	# actually happened.
58
59	# We have to sleep 2 seconds here because journald uses the pid to
60	# connect our log messages to the systemd service.  This is critical
61	# for capturing all the log messages if the scrub fails, because the
62	# fail service uses the service name to gather log messages for the
63	# error report.
64	if [ -n "${SERVICE_MODE}" ]; then
65		test "${ret}" -ne 0 && ret=1
66		sleep 2
67	fi
68
69	exit "${ret}"
70}
71
72while getopts "nrAV" opt; do
73	case "${opt}" in
74	"n") DBG="echo Would execute: " ;;
75	"r") scrub_args="${scrub_args} -r"; reap=1;;
76	"A") scrub_all=1;;
77	"V") print_version; exitcode 0;;
78	*) print_help; exitcode 2;;
79	esac
80done
81shift "$((OPTIND - 1))"
82
83if [ -n "${SERVICE_MODE}" -a "${reap}" -ne 1 -a "${periodic_e2scrub}" -ne 1 ]
84then
85    exitcode 0
86fi
87
88# close file descriptor 3 (from cron) since it causes lvm to kvetch
89exec 3<&-
90
91# If some prerequisite packages are not installed, exit with a code
92# indicating success to avoid spamming the sysadmin with fail messages
93# when e2scrub_all is run out of cron or a systemd timer.
94
95if ! type lsblk >& /dev/null ; then
96    test -n "${SERVICE_MODE}" && exitcode 0
97    echo "e2scrub_all: can't find lsblk --- is util-linux installed?"
98    exitcode 1
99fi
100
101if ! type lvcreate >& /dev/null ; then
102    test -n "${SERVICE_MODE}" && exitcode 0
103    echo "e2scrub_all: can't find lvcreate --- is lvm2 installed?"
104    exitcode 1
105fi
106
107# Find scrub targets, make sure we only do this once.
108ls_scan_targets() {
109    local devices=$(lvs -o lv_path --noheadings -S "lv_active=active,lv_role=public,lv_role!=snapshot,vg_free>=${snap_size_mb}")
110
111    if [ -z "$devices" ]; then
112	return 0;
113    fi
114    lsblk -o NAME,MOUNTPOINT,FSTYPE,TYPE -P -n -p $devices | \
115	grep FSTYPE=\"ext\[234\]\" | grep TYPE=\"lvm\" | \
116	while read vars ; do
117		eval "${vars}"
118
119		if [ "${scrub_all}" -eq 1 ] || [ -n "${MOUNTPOINT}" ]; then
120		    echo ${MOUNTPOINT:-${NAME}}
121		fi
122	done
123}
124
125# Find leftover scrub snapshots
126ls_reap_targets() {
127    lvs -o lv_path -S lv_role=snapshot -S lv_name=~\(e2scrub$\) \
128	--noheadings | sed -e 's/.e2scrub$//'
129}
130
131# Figure out what we're targeting
132ls_targets() {
133	if [ "${reap}" -eq 1 ]; then
134		ls_reap_targets
135	else
136		ls_scan_targets
137	fi
138}
139
140# systemd doesn't know to do path escaping on the instance variable we pass
141# to the e2scrub service, which breaks things if there is a dash in the path
142# name.  Therefore, do the path escaping ourselves if needed.
143#
144# systemd path escaping also drops the initial slash so we add that back in so
145# that log messages from the service units preserve the full path and users can
146# look up log messages using full paths.  However, for "/" the escaping rules
147# do /not/ drop the initial slash, so we have to special-case that here.
148escape_path_for_systemd() {
149	local path="$1"
150
151	if [ "${path}" != "/" ]; then
152		echo "-$(systemd-escape --path "${path}")"
153	else
154		echo "-"
155	fi
156}
157
158# Scrub any mounted fs on lvm by creating a snapshot and fscking that.
159stdin="$(realpath /dev/stdin)"
160ls_targets | while read tgt; do
161	# If we're not reaping and systemd is present, try invoking the
162	# systemd service.
163	if [ "${reap}" -ne 1 ] && type systemctl > /dev/null 2>&1; then
164		tgt_esc="$(escape_path_for_systemd "${tgt}")"
165		${DBG} systemctl start "e2scrub@${tgt_esc}" 2> /dev/null < "${stdin}"
166		res=$?
167		if [ "${res}" -eq 0 ] || [ "${res}" -eq 1 ]; then
168			continue;
169		fi
170	fi
171
172	# Otherwise use direct invocation
173	${DBG} "@root_sbindir@/e2scrub" ${scrub_args} "${tgt}" < "${stdin}"
174done
175
176exitcode 0
177