fixes and qd for better source subvol error repo
[distro-setup] / btrbk-run
index 5d020d773d0229cdbfbbeb75a5ead04af1b9f1c8..f8618809e859ddbbbf378b86a56624c00a70c7b4 100644 (file)
--- a/btrbk-run
+++ b/btrbk-run
@@ -40,7 +40,9 @@ EOF
 
 
 
-pre="${0##*/}: "
+script_name="${BASH_SOURCE[0]}"
+script_name="${script_name##*/}"
+pre="${SSH_CLIENT:+$HOSTNAME} $script_name:"
 m() { if $verbose; then printf "$pre%s\n"  "$*"; fi;  "$@"; }
 e() { printf "$pre%s\n"  "$*"; }
 die() { printf "$pre%s\n" "$*" >&2; echo "exiting with status 1" >&2; exit 1; }
@@ -63,12 +65,20 @@ conf_only=false
 dry_run=false # mostly for testing
 rate_limit=no
 verbose=true; verbose_arg=-v
-progress_arg="--progress"
+force=false
+if [[ $INVOCATION_ID ]]; then
+  # INVOCATION_ID means running as a systemd service. we cant show progress in this case,
+  # but if we pass the arg, it will insert mbuffer into the command.
+  progress_arg=
+else
+  progress_arg="--progress"
+fi
 incremental_strict=false
 pull_reexec=false
 
 default_args_file=/etc/btrbk-run.conf
 if [[ -s $default_args_file ]]; then
+  # shellcheck disable=SC2046 # we want word splitting
   set -- $(< $default_args_file) "$@"
   # i havent used this feature yet, so warn about it
   echo "$0: warning: default btrbk-run options set in $default_args_file (sleeping 5 seconds):"
@@ -76,10 +86,13 @@ if [[ -s $default_args_file ]]; then
   sleep 5
 fi
 
+targets=()
 early=false
 cron=false
+fast=false
+kd_spread=false
 orig_args=("$@")
-temp=$(getopt -l cron,pull-reexec,help ceil:m:npqrs:t:vh "$@") || usage 1
+temp=$(getopt -l cron,fast,pull-reexec,help 23cefikl:m:npqrs:t:vh "$@") || usage 1
 eval set -- "$temp"
 while true; do
   case $1 in
@@ -90,24 +103,32 @@ while true; do
     --cron)
       cron=true
       pre=
-      shift
       ;;
+    # for the rare case we want to run multiple instances at the same time
+    -2) conf_suf=2 ;;
+    -3) conf_suf=3 ;;
     # only creates the config file, does not run btrbk
-    -c) conf_only=true; shift ;;
+    -c) conf_only=true ;;
     # quit early, just btrbk, no extra remounting etc.
-    -e) early=true; shift ;;
-    -i) incremental_strict=true; shift ;;
+    -e) early=true ;;
+    -f) force=true ;;
+    # skip various checks. when we run twice in a row for
+    # switch mail-host, no need to repeat the same checks again.
+    --fast) fast=true ;;
+    -i) incremental_strict=true ;;
+    # note this implies resume, cron and -p
+    -k) kd_spread=true ;;
     # bytes per second, suffix k m g
-    -l) rate_limit=$2; shift ;;
+    -l) rate_limit=$2; shift ;;
     # Comma separated mountpoints to backup. This has defaults set below.
-    -m) IFS=, mountpoints=($2); unset IFS; shift ;;
-    -n) dry_run=true; dry_run_arg=-n; shift ;;
-    # show progress
-    -p) progress_arg="--progress"; shift ;;
+    -m) IFS=, mountpoints=($2); unset IFS; shift ;;
+    -n) dry_run=true ;;
+    # preserve existing snapshots and backups
+    -p) preserve_arg=-p ;;
     # internal option for rerunning under newer SOURCE_HOST version.
-    --pull-reexec) pull_reexec=true; shift ;;
+    --pull-reexec) pull_reexec=true;;
     # quiet
-    -q) verbose=false; verbose_arg=; progress_arg=; shift ;;
+    -q) verbose=false; verbose_arg=; progress_arg= ;;
     # source host to receive a backup from
     -s)
       source=$2
@@ -115,24 +136,41 @@ while true; do
       if [[ $source == *:* ]]; then
         bbksource="[$source]"
       fi
-      shift 2
+      shift
       ;;
     # target hosts to send to. empty is valid for just doing local
     # snapshot. we have default hosts we will populate.
-    -t) IFS=, targets=($2); unset IFS; shift ;;
+    -t) IFS=, targets=($2); unset IFS; shift ;;
     # verbose.
-    -v) verbose=true; verbose_arg=-v; shift ;;
+    -v) verbose=true; verbose_arg=-v ;;
     -h|--help) usage ;;
     --) shift; break ;;
     *) die "Internal error!" ;;
   esac
+  shift
 done
 
-cmd_arg=${1:-run}
+cmd_arg="$1"
+
+if $kd_spread; then
+  if [[ $cmd_arg && $cmd_arg != resume ]]; then
+    die "dont pass -k without resume or empty run arg"
+  fi
+  if [[ $HOSTNAME == "$MAIL_HOST" ]]; then
+    die "something went wrong, -k not meant to be run on MAIL_HOST"
+  fi
+  cmd_arg=resume
+  preserve_arg=-p
+  cron=true
+fi
+
+if [[ ! $cmd_arg ]]; then
+  cmd_arg=run
+fi
 
 
-std_preserve="18h 14d 8w 24m"
-q_preserve="18h 14d"
+std_preserve="36h 14d 8w 24m"
+q_preserve="18h 14d 8w"
 
 case $cmd_arg in
   run|resume) : ;;
@@ -163,9 +201,6 @@ if [[ -v targets && $source ]]; then
   die "error: -t and -s are mutually exclusive"
 fi
 
-if $verbose; then
-  printf "options: conf_only=%s\ndry_run=%s\nrate_limit=%s\nverbose=%s\ncmd_arg=%s" "$conf_only" "$dry_run" "$rate_limit" "$verbose" "$cmd_arg"
-fi
 ### end options parsing
 
 # remove path from earlier version of btrbk
@@ -184,77 +219,85 @@ fi
 # targets, plus any given on the command line.
 
 
-amy=false
 # set default targets
 if [[ ! -v targets && ! $source ]]; then
-  if [[ $HOSTNAME != "$MAIL_HOST" ]] && $cron ; then
+  if $cron && ! $kd_spread && [[ $HOSTNAME != "$MAIL_HOST" ]]; then
     echo "MAIL_HOST=$MAIL_HOST, nothing to do"
     mexit 0
-  else
-    amy=true
   fi
 
   at_work=false
+  at_home=false
 
-  targets=(frodo.b8.nz)
   case $HOSTNAME in
-    x2|kw)
+    kw|kd|frodo|x2|x3|sy) : ;;
+    *)
+      die "error: no default targets for this host, use -t"
+      ;;
+  esac
+
+  case $HOSTNAME in
+    kw)
       at_work=true
       ;;&
-    x2|x3|sy|bo)
-      if ping -q -c1 -w1 hal.office.fsf.org \
+    kd|frodo)
+      at_home=true
+      ;;&
+    x2|x3|sy)
+      if [[ $(dig +short @10.2.0.1 -x 10.2.0.2 2>&1 ||:) == kd.b8.nz. ]] \
+           && ip n show 10.2.0.1 | grep . &>/dev/null; then
+        at_home=true
+      elif ping -q -c1 -w1 hal.office.fsf.org &>/dev/null \
           && ip n show 192.168.0.26 | grep . &>/dev/null; then
         at_work=true
       fi
       ;;&
-    kw|x2|x3|sy|bo)
-      if $at_work; then
-        if ping -q -c1 -w1 iank.vpn.office.fsf.org &>/dev/null; then
-          home=iank.vpn.office.fsf.org
-        else
-          home=i.b8.nz
+    *)
+      if $at_home; then
+        if ! $kd_spread && [[ $HOSTNAME != x3 ]]; then
+          # main work machine
+          if ping -q -c1 -w1 x3.office.fsf.org &>/dev/null; then
+            targets+=(x3.office.fsf.org)
+          elif ping -q -c1 -w1 $h.b8.nz &>/dev/null; then
+            # in case we took it home
+            targets+=(x3.b8.nz)
+          else
+            targets+=(x3wg.b8.nz)
+          fi
         fi
+        if [[ $HOSTNAME != kd ]]; then
+          targets+=(kd.b8.nz)
+        fi
+        wireless_home_hosts=(
+          x2
+          sy
+        )
+        for h in ${wireless_home_hosts[@]}; do
+          if [[ $HOSTNAME != "$h" ]]; then
+            if ping -q -c1 -w1 $h.b8.nz &>/dev/null; then
+              targets+=($h.b8.nz)
+            elif ping -q -c1 -w1 ${h}w.b8.nz &>/dev/null; then
+              targets+=(${h}w.b8.nz)
+            fi
+          fi
+        done
+      elif $at_work; then
+        targets+=(i.b8.nz)
+        for h in x2 x3 kw; do
+          if [[ $HOSTNAME == "$h" ]]; then
+            continue
+          fi
+          if ping -q -c1 -w1 $h.office.fsf.org &>/dev/null; then
+            targets+=($h.office.fsf.org)
+          fi
+        done
       else
-        home=b8.nz
-      fi
-      ;;&
-    kw)
-      targets+=($home x2.office.fsf.org)
-      ;;
-    x2|x3|sy|bo)
-      targets+=($home)
-      if $at_work; then
-        targets+=(x2.office.fsf.org x2.b8.nz)
-      else
-        targets+=(x2wg.b8.nz)
-      fi
-      ;;
-    kd)
-      targets+=(x2wg.b8.nz x3.b8.nz)
-      if ping -q -c1 -w1 sy.b8.nz &>/dev/null; then
-        targets+=(sy.b8.nz)
-      else
-        targets+=(syw.b8.nz)
+        targets+=(i.b8.nz)
       fi
       ;;
-    frodo)
-      # no targets
-      targets=()
-      ;;
-    *)
-      die "error: no default targets for this host, use -t"
-      ;;
   esac
 fi
 
-if [[ -v targets ]]; then
-  echo "targets: ${targets[*]}"
-fi
-
-if [[ $source ]]; then
-  echo "source: $source"
-fi
-
 if [[ ${mountpoints[0]} ]]; then
   for mp in ${mountpoints[@]}; do
     if [[ -e /nocow/btrfs-stale/$mp ]]; then
@@ -267,9 +310,6 @@ else
     prospective_mps=(/a)
   else
     case $HOSTNAME in
-      frodo)
-        prospective_mps=(/i)
-        ;;
       *)
         prospective_mps=()
         if [[ $source ]]; then
@@ -279,19 +319,22 @@ else
           if [[ $source_host == "$MAIL_HOST" ]]; then
             prospective_mps+=(/o)
           fi
+          if [[ $source_host == "$HOST2" ]]; then
+            prospective_mps+=(/a /ar /qr /qd /q)
+          fi
         else
           if [[ $HOSTNAME == "$MAIL_HOST" ]]; then
-            # HOST2 is really the mail host if it exists
-            if [[ $HOST2 && $HOST2 != "$HOSTNAME" ]]; then
-              echo "skipping /o because HOST2 is not us"
-            else
-              prospective_mps+=(/o)
-            fi
+            prospective_mps+=(/o)
+          fi
+          if [[ $HOSTNAME == "$HOST2" ]]; then
+            prospective_mps+=(/a /ar /qr /qd /q)
+          fi
+          if $kd_spread; then
+            prospective_mps=(/a /ar /o /qr /qd /q)
           fi
         fi
         # note: put q last just in case its specific retention options were to
         # affect other config sections. I havent tested if that is the case.
-        prospective_mps+=(/a /ar /qr /q)
         ;;
     esac
   fi
@@ -306,11 +349,16 @@ else
   done
 fi
 
-echo "mountpoints: ${mountpoints[*]}"
+if (( ! ${#mountpoints[@]} )); then
+  die didnt get mountpoint arg and had no defaults
+fi
 
 ##### end command line parsing ########
 
-if [[ $source ]]; then
+#### begin pre-checks #####
+
+# todo: this has a timing problem, since btrbk.timer could activate the service after this check.
+if ! $fast && [[ $source ]]; then
   if [[ $(ssh $source ps --no-headers -o comm 1) == systemd ]]; then
     status=$(ssh $source systemctl is-active btrbk.service) || : # normally returns 3
     case $status in
@@ -322,6 +370,38 @@ if [[ $source ]]; then
   fi
 fi
 
+if ! command -v btrbk &>/dev/null; then
+  die "error: no btrbk binary found"
+fi
+
+
+#### end pre-checks #####
+
+mkdir -p /var/log/btrbk
+# The journal doesnt go back to my oldest backups, and I've found myself
+# wanting older logs. Not going to bother expiring old logs, since it is
+# fine if they go back years.
+log_path=/var/log/btrbk/$(date +%F_%T%:::z).log
+echo copying output to $log_path
+exec &> >(ts "%F %T" | tee -a $log_path)
+
+
+if $verbose; then
+  printf "$pre options: conf_only=%s\ndry_run=%s\nrate_limit=%s\nverbose=%s\ncmd_arg=%s" "$conf_only" "$dry_run" "$rate_limit" "$verbose" "$cmd_arg"
+fi
+
+if [[ -v targets ]]; then
+  echo "targets: ${targets[*]}"
+fi
+
+if [[ $source ]]; then
+  echo "source: $source"
+fi
+
+echo "mountpoints: ${mountpoints[*]}"
+
+
+
 # pull_reexec stops us from getting into an infinite loop if there is some
 # kind of weird problem
 pulla=false
@@ -345,48 +425,56 @@ if ! $pull_reexec && [[ $source ]] && $pulla ; then
 fi
 
 
-if ! command -v btrbk &>/dev/null; then
-  die "error: no btrbk binary found"
-fi
-# if our mountpoints are from stale snapshots,
-# it doesn't make sense to do a backup.
-check-subvol-stale ${mountpoints[@]} || die "found stale mountpoints in ${mountpoints[*]}"
+if ! $fast; then
+  # if our mountpoints are from stale snapshots,
+  # it doesn't make sense to do a backup.
+  m check-subvol-stale ${mountpoints[@]} || die "found stale mountpoints in ${mountpoints[*]}"
 
-# for an initial run, btrbk requires the dir to exist.
-mkdir -p /mnt/{root,o}/btrbk
+  # for an initial run, btrbk requires the dir to exist.
+  mkdir -p /mnt/{root,o}/btrbk
+fi
 local_zone=$(date +%z)
 
 if [[ $source ]]; then
-  if ! zone=$(ssh root@$source date +%z); then
-    if $conf_only; then
-      echo "$0: warning: failed to ssh to root@$source"
-    else
-      die failed to ssh to root@$source
+  if $fast; then
+    zone=$local_zone
+  else
+    if ! zone=$(ssh root@$source date +%z); then
+      if $conf_only; then
+        echo "$0: warning: failed to ssh to root@$source"
+      else
+        die failed to ssh to root@$source
+      fi
+    fi
+    if [[ $zone != "$local_zone" ]]; then
+      die "error: dont confuse yourself with multiple time zones. $h has different timezone than localhost"
     fi
   fi
-  if [[ $zone != "$local_zone" ]]; then
-    die "error: dont confuse yourself with multiple time zones. $h has different timezone than localhost"
-  fi
-
 else
 
   sshable=()
   sshfail=()
-  min_idle_ms=$((1000 * 60 * 15))
   for h in ${targets[@]}; do
-    if remote_info=( $(timeout -s 9 6 ssh root@$h "mkdir -p /mnt/root/btrbk /mnt/o/btrbk && date +%z && df --output=size,pcent / | tail -n1") ); then
-      zone=${remote_info[0]}
-      root_size=${remote_info[1]}
-      percent_used=${remote_info[2]%%%}
-
-      if (( ${#remote_info[@]} != 3 )); then
-        die "error: didnt get 3 fields in test ssh to target $h. investigate"
-      fi
-    elif $conf_only; then
+    if $fast || $conf_only; then
       # Use some typical values in this case
       root_size=$(( 1024 * 1024 * 2000 )) #2tb
       percent_used=10
       zone=$(date +%z)
+    elif remote_str=$(timeout -s 9 6 ssh root@$h "mkdir -p /mnt/root/btrbk /mnt/o/btrbk && date +%z && df --output=size,pcent / | tail -n1"); then
+      mapfile -t tmp_array <<<"$remote_str"
+      zone="${tmp_array[0]}"
+      IFS=" " read -r root_size percent_used <<<"${tmp_array[1]}"
+      percent_used=${percent_used%%%}
+
+      if (( ${#tmp_array[@]} != 2 )); then
+        die "error: didnt get 2 lines in test ssh to target $h. investigate"
+      fi
+      case $percent_used in
+        [0-9]|[1-9][0-9]) : ;;
+        *)
+          die "error: didnt get percent disk use in test ssh to target $h. investigate"
+          ;;
+      esac
     else
       sshfail+=($h)
       continue
@@ -402,15 +490,26 @@ else
       die "error: filesystem on target $h is $percent_used % full"
     fi
 
-    # This is a separate ssh because xprintidle can fail and thats ok.
-    if $cron && idle_ms=$(timeout -s 9 6 ssh $h DISPLAY=:0 xprintidle); then
-      if (( idle_ms < min_idle_ms )); then
-
+    # on sy, xprintidle is resetting every 12 seconds even when not
+    # idle, i dunno why, instead we are checking if the screen is locked,
+    # which is good enough.
+    #
+    # This is a separate ssh because the command can fail and thatis ok.
+    if $cron && ! $force; then
+      locked=false
+      if lock_info=$(timeout -s 9 6 ssh $h DISPLAY=:0 xscreensaver-command -time); then
+        if [[ $lock_info != *non-blanked* ]]; then
+          locked=true
+        fi
+      else
+        locked=true
+      fi
+      if ! $locked; then
         # Ignore this host. i sometimes use a non-main machine for
         # testing or web browsing, knowing that everything will be wiped
         # by the next backup, but I dont want it to happen as Im using
         # it from cronjob.
-        e "warning: $h: active X session in the last 15 minutes, skipping for now"
+        e "warning: $h: seems to be actively in use, skipping for now"
         continue
       fi
     fi
@@ -431,7 +530,7 @@ else
 fi
 
 
-cat >/etc/btrbk.conf <<EOF
+cat >/etc/btrbk$conf_suf.conf <<EOF
 ssh_identity /q/root/h
 #ssh_identity /root/.ssh/home
 
@@ -444,10 +543,10 @@ ssh_identity /q/root/h
 transaction_syslog local7
 
 # trying this out
-stream_compress zstd
+#stream_compress zstd
 
 # so we only run one at a time
-lockfile                   /var/lock/btrbk.lock
+lockfile                   /var/lock/btrbk$conf_suf.lock
 
 # default format of short does not accomidate hourly preservation setting
 timestamp_format long-iso
@@ -458,11 +557,14 @@ snapshot_create onchange
 # if one disk had less space.
 # for now, keeping them equal.
 snapshot_preserve $std_preserve
-snapshot_preserve_min 2h
+snapshot_preserve_min 6h
 snapshot_dir btrbk
 # so, total backups = ~58
 target_preserve $std_preserve
-target_preserve_min 2h
+target_preserve_min 6h
+
+# i tried this when investigating: clone no source subvolume found error
+#incremental_prefs sro:1 srn:1 sao san:1 aro:1 arn:1
 
 # if something fails and it's not obvious, try doing
 # btrbk -l debug -v dryrun
@@ -471,11 +573,36 @@ rate_limit $rate_limit
 EOF
 
 if $incremental_strict; then
-  cat >>/etc/btrbk.conf <<EOF
+  cat >>/etc/btrbk$conf_suf.conf <<EOF
 incremental strict
 EOF
 fi
 
+qconf() {
+  case $sub in
+    q)
+      # q has sensitive data i dont want to backup for so long
+      cat >>/etc/btrbk$conf_suf.conf <<EOF
+snapshot_preserve $q_preserve
+snapshot_preserve_min 2h
+snapshot_dir btrbk
+target_preserve $q_preserve
+target_preserve_min 2h
+EOF
+      ;;
+  esac
+
+}
+
+# make /q be last
+mp_count=${#mountpoints[@]}
+for (( i=0; i < mp_count - 1 ; i++ )); do
+  if [[ ${mountpoints[i]} == /q ]]; then
+    unset "mountpoints[i]"
+    mountpoints+=(/q)
+  fi
+done
+
 for m in ${mountpoints[@]}; do
   case $m in
     /o)
@@ -488,51 +615,33 @@ for m in ${mountpoints[@]}; do
 
   sub=${m#/}
   if [[ $source ]]; then
-    cat >>/etc/btrbk.conf <<EOF
+    cat >>/etc/btrbk$conf_suf.conf <<EOF
 volume ssh://$bbksource$vol
 subvolume $sub
+EOF
+    qconf
+    cat >>/etc/btrbk$conf_suf.conf <<EOF
 target send-receive $vol/btrbk
 EOF
   fi
   if (( ${#targets[@]} )); then
-    cat >>/etc/btrbk.conf <<EOF
+    cat >>/etc/btrbk$conf_suf.conf <<EOF
 volume $vol
 subvolume $sub
 EOF
-    case $sub in
-      q)
-        # q has sensitive data i dont want to backup for so long
-        cat >>/etc/btrbk.conf <<EOF
-snapshot_preserve $std_preserve
-snapshot_preserve_min 2h
-snapshot_dir btrbk
-target_preserve $std_preserve
-target_preserve_min 2h
-EOF
-        ;;
-    esac
+    qconf
     for tg in ${targets[@]}; do
       # handle ipv6
       if [[ $tg == *:* ]]; then
         tg="[$tg]"
       fi
-      cat >>/etc/btrbk.conf <<EOF
+      cat >>/etc/btrbk$conf_suf.conf <<EOF
 target send-receive ssh://$tg$vol/btrbk
 EOF
     done
   fi
 done
 
-# if $amy; then
-#   # to manually backup amy,
-#   # bbk -e -s amy -m root_ubuntubionic
-#   cat >>/etc/btrbk.conf <<'EOF'
-# volume ssh://amy/mnt/root
-# subvolume root_ubuntubionic
-# target send-receive /mnt/root/btrbk
-# EOF
-# fi
-
 # todo: umount first to ensure we don't have any errors
 # todo: do some kill fuser stuff to make umount more reliable
 
@@ -544,12 +653,16 @@ fi
 
 
 if $dry_run; then
-  m btrbk -v -n $cmd_arg
+  m btrbk -c /etc/btrbk$conf_suf.conf -v -n $cmd_arg
   mexit 0
 fi
 # -q and just using the syslog option seemed nice,
 # but it doesn't show when a send has a parent and when it doesn't.
-m btrbk $preserve_arg $verbose_arg $progress_arg $cmd_arg
+m btrbk -c /etc/btrbk$conf_suf.conf $preserve_arg $verbose_arg $progress_arg $cmd_arg
+
+if $early; then
+  exit 0
+fi
 
 # todo: tp not valid anymore.
 # if we have it, sync to systems which don't
@@ -569,17 +682,30 @@ if mountpoint $rsync_mountpoint >/dev/null; then
   done
 fi
 
+subvols=()
+for mp in "${mountpoints[@]}"; do
+  subvols+=("${mp##*/}")
+done
 if [[ $source ]]; then
-  m mount-latest-subvol
+  m mount-latest-subvol "${subvols[@]}"
 else
-  m /a/exe/mount-latest-remote ${targets[@]}
+  for tg in ${targets[@]}; do
+    m /a/exe/mount-latest-remote "$tg" "${subvols[@]}" || ret=$?
+  done
 fi
 
 if [[ $ret == 0 ]]; then
   for tg in ${targets[@]}; do
-    :
-    #ssh root@$tg /a/exe/mail-backup-clean
+    h=$(ssh $tg hostname)
+    if [[ $h == kd && $HOSTNAME == x3 && $HOSTNAME == "$MAIL_HOST" ]]; then
+      ssh root$tg systemctl --no-block start btrbk-spread
+    fi
+    rsync -a -f"- */" -f"+ *" /var/log/btrbk/ root@$tg:/var/log/btrbk/$tg
+    ssh root@$tg /usr/local/bin/mail-backup-clean
   done
+  if [[ $source ]]; then
+    rsync -a -f"- */" -f"+ *" $source:/var/log/btrbk/ /var/log/btrbk/$source
+  fi
 fi
 
 mexit $ret