X-Git-Url: https://iankelling.org/git/?p=distro-setup;a=blobdiff_plain;f=btrfsmaint;h=c410b7b3503359309ab6938f5c233f7193cd6a3e;hp=d2263257d412b4da2d9e37e5c1678641e301e8f6;hb=HEAD;hpb=103a2e153f844343c359882079936b2521c82f15

diff --git a/btrfsmaint b/btrfsmaint
index d226325..85f2f34 100755
--- a/btrfsmaint
+++ b/btrfsmaint
@@ -1,88 +1,128 @@
 #!/bin/bash
+# I, Ian Kelling, follow the GNU license recommendations at
+# https://www.gnu.org/licenses/license-recommendations.en.html. They
+# recommend that small programs, < 300 lines, be licensed under the
+# Apache License 2.0. This file contains or is part of one or more small
+# programs. If a small program grows beyond 300 lines, I plan to switch
+# its license to GPL.
+
+# Copyright 2024 Ian Kelling
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 
 
 [[ $EUID == 0 ]] || exec sudo -E "${BASH_SOURCE[0]}" "$@"
 
-source /a/bin/errhandle/err
+set -e; . /usr/local/lib/bash-bear; set +e
 
 # inspired from
 # https://github.com/kdave/btrfsmaintenance
 
+if [[ $INVOCATION_ID ]]; then
+  err-cleanup() {
+    exim -odf -i root <<EOF
+From: root@$(hostname -f)
+To: root@$(hostname -f)
+Subject: btrfsmaint automatically exited on command error
+
+journalctl -u btrfsmaint -n 50:
+$(journalctl -u btrfsmaint -n 50)
+EOF
+  }
+fi
 
-# Man page says we could also use a range, i suppose it would be
-# logical to use a pattern like 5..10 10..20,
-# but I don't know if this would help us at all.
 dusage="5 10"
 musage="5"
 
 e() {
-  echo "cron: $*"
+  echo "btrfsmaint: $*"
   if ! $dryrun; then
     "$@"
   fi
 }
 
 check-idle() {
-  type -p xprintidle &>/dev/null || return 0
+  type -p xscreensaver-command &>/dev/null || return 0
+  export XAUTHORITY=/home/iank/.Xauthority
   export DISPLAY=:0
-  # a hours, a movie could run that long.
-  idle_limit=$((1000 * 60 * 60 * 2))
-  idle_time=$idle_limit
-  while read -r user; do
-    new_idle_time=$(sudo -u $user xprintidle 2>/dev/null) ||:
-    if [[ $new_idle_time && $new_idle_time -lt $idle_time ]]; then
-      idle_time=$new_idle_time
+  locked=false
+  if lock_info=$(xscreensaver-command -time); then
+    if [[ $lock_info != *non-blanked* ]]; then
+      locked=true
     fi
-  done < <(users | tr " " "\n" | sort -u)
-  if (( idle_time < idle_limit )); then
-    idle=false
   else
-    idle=true
+    locked=true
   fi
 }
 
 usage() {
   cat <<EOF
-Usage: ${0##*/} [ARGS]
-Do btrfs maintence or stop if xprintidle shows a user
+Usage: ${0##*/} [OPTIONS]
+Do btrfs maintence or stop if we have X and xprintidle shows a user
+
+Normally, no options are needed.
 
-force  Run regardless of user idle status on all disks and do scrub
-       regardless of when it was last run.
-check  Only check if an existing maintence should be cancelled due to
-         nonidle user. Also, runs in a loop every 20 seconds for 10
+--check  Only check if an existing maintence should be cancelled due to
+         nonidle user and run in a loop every 20 seconds for 10
          minutes.
 
+--dryrun Just print out what we would do.
+
+--force  Run regardless of user idle status on all disks and do scrub
+         regardless of when it was last run.
+--no-stats  Avoid checking error statistics. Use this to avoid a rare race
+            condition when running --check concurrently with normal run.
+
+
+-h|--help   Show help
+
 Note: Uses util-linux getopt option parsing: spaces between args and
 options, short options can be combined, options before args.
 EOF
   exit $1
 }
 
+##### begin command line parsing ########
+
+# ensure we can handle args with spaces or empty.
+ret=0; getopt -T || ret=$?
+[[ $ret == 4 ]] || { echo "Install util-linux for enhanced getopt" >&2; exit 1; }
 
-force=false
 check=false
 dryrun=false
-if [[ $1 ]]; then
+force=false
+stats=true
+
+temp=$(getopt -l help,check,dryrun,force,no-stats h "$@") || usage 1
+eval set -- "$temp"
+while true; do
   case $1 in
-    check)
-      check=true
-      ;;
-    force)
-      force=true
-      ;;
-    dryrun)
-      dryrun=true
-      ;;
-    *)
-      echo "$0: error: unexpected arg" >&2
-      usage 1
-      ;;
+    --check) check=true ;;
+    --dryrun) dryrun=true ;;
+    --force) force=true ;;
+    --no-stats) stats=false ;;
+    -h|--help) usage ;;
+    --) shift; break ;;
+    *) echo "$0: unexpected args: $*" >&2 ; usage 1 ;;
   esac
-fi
+  shift
+done
+readonly check dryrun force stats
+##### end command line parsing ########
 
 
 main() {
-  idle=true
   if ! $force; then
     check-idle
     if ! $check; then
@@ -90,7 +130,7 @@ main() {
       max_min=300
       # When the cron kicks in, we may not be idle (physically sleeping) yet, so
       # wait.
-      while ! $idle && (( min < max_min )); do
+      while ! $locked && (( min < max_min )); do
         min=$(( min + 1 ))
         sleep 60
         check-idle
@@ -109,26 +149,26 @@ main() {
     [[ $mnt ]] || continue
 
     #### begin look for diff in stats, eg: increasing error count ####
-
-    # Only run for $check, since it runs in parallel to non-check, avoid
-    # race condition.
-    if $check; then
+    if $stats; then
       tmp=$(mktemp)
-      # if mnt is /, avoid making a buggy looking path
+      # ${mnt%/} so that if mnt is / we avoid making a buggy looking path
       stats_path=${mnt%/}/btrfs-dev-stats
       if [[ ! -e $stats_path ]]; then
         btrfs dev stats -c $mnt >$stats_path ||: # populate initial reading
       elif ! btrfs dev stats -c $mnt >$tmp; then
         if ! diff -q $stats_path $tmp; then
-              exim -t <<EOF
-From: root@$HOSTNAME.b8.nz
-To: alerts@iankelling.org
-Subject: btrfsmaintstop: btrfs dev stats -c $mnt
-
-$(diff -u $stats_path $tmp ||:)
-EOF
           mv $stats_path $stats_path.1
           cat $tmp >$stats_path
+          diff=$(diff -u $stats_path $tmp 2>&1 ||:)
+          printf "diff of: btrfs dev stats -c %s\n%s\n" "$mnt" "$diff"
+          exim -odf -i root <<EOF
+From: root@$(hostname -f)
+To: root@$(hostname -f)
+Subject: btrfsmaint: device stats changed for $mnt
+
+diff of: btrfs dev stats -c $mnt
+$diff
+EOF
         fi
       fi
       rm -f $tmp
@@ -136,7 +176,7 @@ EOF
     #### end look for diff in stats, eg: increasing error count ####
 
     if $check; then
-      if ! $idle; then
+      if ! $locked; then
         if $dryrun; then
           echo "$0: not idle. if this wasnt a dry run, btrfs scrub cancel $mnt"
         else
@@ -194,9 +234,9 @@ EOF
     # btrfsmaintenance does -c 2 -n 4, but I want lowest pri.
     e btrfs scrub start -Bd -c 3 $mnt
 
-    # We normally only do one disk since this is meant to be run while I sleep
-    # and if we try to do all disks, we invariably end up doing a scrub still
-    # after I've woken up. So, just do one per day.
+    # We normally only do one disk since this is meant to be run in
+    # downtime and if we try to do all disks, we invariably end up doing
+    # a scrub after downtime. So, just do one disk per day.
     if ! $force; then
       return 0
     fi