#!/usr/bin/env bash
#
# JbTecWiz Support Centre -- generated fix script
#
# Fault : XFS: "Structure needs cleaning" or a filesystem that will not mount
# Fix   : Check the hardware and take an image before repairing
# Source: https://jbtecwiz.com/support/lnx-sto-xfs-repair
#
# Run as     : Root shell
# Expect     : 1-4 hours
# Risk       : low
# Reversible : yes
#
# WHEN THIS IS THE RIGHT FIX
#   No backup, or the data matters. xfs_repair can discard what it cannot
#   reconcile.
#
# HOW TO UNDO IT
#   Nothing was changed on the filesystem.
#
# Walks the fix one step at a time and asks before each. Steps with no
# command are yours to do -- it prints those and waits. DRYRUN=1 prints
# without executing; UNATTENDED=1 does not ask.
#
# --------------------------------------------------------------------
# NO WARRANTY - USE AT YOUR OWN RISK
#
# This script is provided by JbTecWiz as-is and with no warranty of any
# kind, express or implied. You run it entirely at your own risk.
#
# JbTecWiz accepts no liability for any loss or damage arising from its
# use, including but not limited to data loss, downtime, or configuration
# changes that turn out to be wrong for your system.
#
# You are responsible for reading this script before running it, for
# satisfying yourself that it suits the machine in front of you, and for
# having a working backup first. Some steps cannot be undone.
# --------------------------------------------------------------------

set -uo pipefail
DRYRUN="${DRYRUN:-0}"
UNATTENDED="${UNATTENDED:-0}"
failed=0

if [ "$(id -u)" -ne 0 ]; then
  echo "  This fix is documented as needing root. Re-run with sudo." >&2
  exit 3
fi

rule() { printf "\n%s\n" "$(printf '-%.0s' $(seq 1 70))"; if [ $# -gt 0 ]; then echo "$1"; fi; }
prose() { echo "$1" | fold -s -w 74 | sed "s/^/  /"; }

# Returns 0 when the caller should run the command, 1 when it should not.
# A manual step always returns 1 -- there is nothing for the caller to run.
step() {  # step <n> <do> <why> <manual|cmd> [command lines...]
  local n="$1" dotext="$2" why="$3" mode="$4"; shift 4
  rule "  Step $n of 5"
  prose "$dotext"
  if [ -n "$why" ]; then echo; prose "$why"; fi
  if [ "$mode" = "manual" ]; then
    echo; echo "  -> Do this yourself, then press Enter to carry on."
    if [ "$UNATTENDED" = "0" ] && [ "$DRYRUN" = "0" ]; then read -r _; fi
    return 1
  fi
  echo; printf "    %s\n" "$@"; echo
  if [ "$DRYRUN" = "1" ]; then echo "  (dry run -- not executed)"; return 1; fi
  if [ "$UNATTENDED" = "0" ]; then
    read -r -p "  Run this step? [Y]es / [S]kip / [Q]uit " a
    case "$a" in
      [Qq]*) echo "  Stopped at your request."; exit 0 ;;
      [Ss]*) echo "  Skipped."; return 1 ;;
    esac
  fi
  return 0
}

rule
echo "  XFS: "Structure needs cleaning" or a filesystem that will not mount"
echo "  Check the hardware and take an image before repairing"
echo
echo "  Risk: low   Reversible   1-4 hours"
echo
prose 'No warranty. Use at your own risk - JbTecWiz accepts no liability. Read it before you run it, and have a backup.'
rule
echo
if [ "$UNATTENDED" = "0" ] && [ "$DRYRUN" = "0" ]; then
  read -r -p "  Ready? [y/N] " go
  case "$go" in [Yy]*) ;; *) echo "  Nothing was changed."; exit 0;; esac
fi

if step 1 'Read the kernel log for what actually happened. I/O errors underneath change the whole approach.' 'Repairing a filesystem on a disk that is still failing produces a filesystem that fails again in an hour, having lost whatever the repair discarded. The hardware question comes first.' cmd 'dmesg -T | grep -iE '\''xfs|i/o error|medium error|reset'\'' | tail -40'; then
  dmesg -T | grep -iE 'xfs|i/o error|medium error|reset' | tail -40
  if [ $? -ne 0 ]; then
    failed=$((failed+1))
    echo "  Step 1 failed. The rest of the fix may depend on it." >&2
  fi
fi

if step 2 'Check the drive'\''s own health.' '' cmd 'sudo smartctl -a /dev/sda | grep -iE '\''result|reallocated|pending|uncorrectable|error'\'''; then
  sudo smartctl -a /dev/sda | grep -iE 'result|reallocated|pending|uncorrectable|error'
  if [ $? -ne 0 ]; then
    failed=$((failed+1))
    echo "  Step 2 failed. The rest of the fix may depend on it." >&2
  fi
fi

if step 3 'Unmount it. Do not repair a mounted filesystem.' '' cmd 'sudo umount /data || sudo umount -l /data'; then
  sudo umount /data || sudo umount -l /data
  if [ $? -ne 0 ]; then
    failed=$((failed+1))
    echo "  Step 3 failed. The rest of the fix may depend on it." >&2
  fi
fi

if step 4 'Take a metadata dump, which is small and lets the repair be tested elsewhere.' '' cmd 'sudo xfs_metadump /dev/sdb1 /root/data-metadump.img'; then
  sudo xfs_metadump /dev/sdb1 /root/data-metadump.img
  if [ $? -ne 0 ]; then
    failed=$((failed+1))
    echo "  Step 4 failed. The rest of the fix may depend on it." >&2
  fi
fi

if step 5 'Where the data matters and there is somewhere to put it, take a full image with a tool that reads past errors.' '' cmd 'sudo ddrescue -f -n /dev/sdb1 /mnt/rescue/sdb1.img /mnt/rescue/sdb1.log'; then
  sudo ddrescue -f -n /dev/sdb1 /mnt/rescue/sdb1.img /mnt/rescue/sdb1.log
  if [ $? -ne 0 ]; then
    failed=$((failed+1))
    echo "  Step 5 failed. The rest of the fix may depend on it." >&2
  fi
fi

rule "  Confirm it worked"
prose 'You have an image or a metadump, and a clear answer on whether the disk is failing.'

rule
if [ "$failed" -gt 0 ]; then
  echo "  Finished with $failed failed step(s)."
  echo "  Read the full write-up at https://jbtecwiz.com/support/lnx-sto-xfs-repair"
else
  echo "  Finished."
fi
echo
prose 'To undo: Nothing was changed on the filesystem.'
rule