minor fixes and improvements
[distro-setup] / mount-latest-subvol
1 #!/bin/bash
2
3 # On Ian's computers, mount received subvolumes after btrbk.
4 # Copyright (C) 2024 Ian Kelling
5
6 # This program is free software: you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation, either version 3 of the License, or
9 # (at your option) any later version.
10
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
15
16 # You should have received a copy of the GNU General Public License
17 # along with this program. If not, see <http://www.gnu.org/licenses/>.
18
19 # SPDX-License-Identifier: GPL-3.0-or-later
20
21 this_file="$(readlink -f -- "${BASH_SOURCE[0]}")"
22 readonly this_file
23 cd /
24 [[ $EUID == 0 ]] || exec sudo -E "$this_file" "$@"
25
26 set -e; . /usr/local/lib/bash-bear; set +e
27
28 usage() {
29 cat <<EOF
30 Usage: ${0##*/} [OPTIONS] [SUBVOLUMES]
31
32 -h|--help Print help and exit.
33 -f|--force Use kill -9 to try fixing unmount errors
34 -v|--verbose Be more verbose
35
36
37 Note: In git this is not not executable because it's meant to be installed
38 using ./install-my-scripts
39
40 Note: Uses util-linux getopt option parsing: spaces between args and
41 options, short options can be combined, options before args.
42 EOF
43 exit $1
44 }
45
46 pre="mount-latest-subvol:${SSH_CLIENT:+ $HOSTNAME:}"
47
48 tu() {
49 while read -r line; do
50 file="$1"
51 grep -xFq "$line" "$file" || tee -a "$file"<<<"$line"
52 done
53 }
54 d() {
55 if $verbose; then
56 printf "$pre %s\n" "$*"
57 fi
58 }
59 m() {
60 if $verbose; then
61 printf "$pre %s\n" "$*"
62 fi
63 "$@"
64 }
65 x() {
66 printf "$pre %s\n" "$*"
67 "$@"
68 }
69
70 mnt() {
71 dir=$1
72 if ! mountpoint -q $dir; then
73 mkdir -p $dir
74 m mount $dir
75 fi
76 }
77 fstab() {
78 while read -r start mpoint end; do
79 l="$start $mpoint $end"
80 # kill off any lines that duplicate the mount point.
81 sed --follow-symlinks -ri "\%$l%b;\%^\s*\S+\s+$mpoint\s%d" /etc/fstab
82 tu /etc/fstab <<<"$l"
83 done
84 }
85 pid-check() {
86 for p in ${pids}; do
87 for m in ${my_pids[@]}; do
88 if (( p == m )); then
89 echo "$0: error: pids to kill includes our pid or a parent. ps output:" >&2
90 ps -f -p $p
91 exit 1
92 fi
93 done
94 done
95 }
96 kill-dir() {
97 for sig; do
98 echo kill-dir $sig
99 found_pids=false
100 if pids=$(timeout 4 lsof -t $dir); then
101 found_pids=true
102 timeout 4 lsof -w $dir
103 pid-check
104 kill -$sig $pids
105 fi
106 # fuser will find open sockets that lsof won't, for example from gpg-agent.
107 # note: -v shows kernel processes, which then doesn't return true when we want
108 if pids=$(timeout 4 fuser -m $dir 2>/dev/null); then
109 pid-check
110 found_pids=true
111 fuser -$sig -mvk $dir
112 fi
113 sleep .5
114 if ! $found_pids; then
115 return 0
116 fi
117 done
118 return 1
119 }
120 umount-kill() {
121 dir=$1
122 if mountpoint -q $dir; then
123 if m umount -R $dir; then
124 unmounted+=($dir)
125 else
126 if ! kill-dir TERM TERM TERM INT INT HUP HUP TERM TERM TERM INT INT HUP HUP; then
127 if $force; then kill-dir KILL; fi
128 fi
129
130 if m umount -R $dir; then
131 unmounted+=($dir)
132 else
133 echo "$0: failed to umount $dir"
134 umount_ret=false
135 ret=1
136 fi
137 fi
138 fi
139 }
140
141 # duplicated in check-subvol
142 # Reassign $1 var from /dev/dm- to corresponding /dev/mapper/
143 mapper-dev() {
144 local mapdev
145 local -n devref=$1
146 if [[ $devref == /dev/dm-* ]]; then
147 for mapdev in /dev/mapper/*; do
148 if [[ $(readlink -f $mapdev) == "$devref" ]]; then
149 devref=$mapdev
150 break
151 fi
152 done
153 fi
154 }
155
156
157 ##### begin command line parsing ########
158
159 # you can remove this if you do not have options which can have args with spaces or empty.
160
161 verbose=true
162 force=false
163 temp=$(getopt -l help,force,verbose hfv "$@") || usage 1
164 eval set -- "$temp"
165 while true; do
166 case $1 in
167 -f|--force) force=true ;;
168 -v|--verbose) verbose=true ;;
169 -h|--help) usage ;;
170 --) shift; break ;;
171 *) echo "$0: unexpected args: $*" >&2 ; usage 1 ;;
172 esac
173 shift
174 done
175
176 if (( $# )); then
177 all_vols=( "$@" )
178 else
179 all_vols=(q a o i ar qd qr)
180 fi
181
182 ##### end command line parsing ########
183
184 ret=0
185
186 ##### begin setup fstab for subvols we care about ######
187
188 if [[ -e /mnt/root/root2-crypttab ]]; then
189 tu /etc/crypttab </mnt/root/root2-crypttab
190 while read -r mapper_dev _; do
191 if [[ ! -e /dev/mapper/$mapper_dev ]]; then
192 m cryptdisks_start $mapper_dev
193 fi
194 done < <(cat /mnt/root/root2-crypttab)
195 fi
196 if [[ -e /mnt/root/root2-fstab ]]; then
197 tu /etc/fstab </mnt/root/root2-fstab
198 mnt /mnt/root2
199 mnt /mnt/boot2
200 fi
201
202 root_dev=$(awk '$2 == "/" {print $1}' /etc/mtab)
203 mapper-dev root_dev
204 o_dev=$(awk '$2 == "/mnt/o" {print $1}' /etc/mtab)
205 mapper-dev o_dev
206
207
208 # root2_dev=$(awk '$2 == "/mnt/root2" {print $1}' /etc/mtab)
209 # mapper-dev root2_dev
210 # # dont bother with the above for crypt2_dev
211 # crypt2_dev=$root2_dev
212
213
214 if cryptsetup status $root_dev &>/dev/null; then
215 crypt_dev=$root_dev
216 else # if we are in a recovery boot, find the next best crypt device
217 mopts=,noauto
218 # todo: I think I had an idea to not setup /o in this case,
219 # but never finished implementing it
220 for dev in $(dmsetup ls --target crypt | awk '{print $1}'); do
221 dev=/dev/mapper/$dev
222 if awk '{print $1}' /etc/mtab | grep -Fx $dev &>/dev/null; then
223 crypt_dev=$dev
224 break
225 fi
226 done
227 fi
228
229
230
231 # dont tax the cpus of old laptops
232 if (( $(nproc) > 2)); then
233 mopts+=,compress=zstd
234 fi
235
236 fstab <<EOF
237 $crypt_dev /a btrfs noatime,subvol=a$mopts 0 0
238 EOF
239
240 shopt -s nullglob
241
242 # ssh and probably some other things care about parent directory
243 # ownership, and ssh doesn\'t allow any group writable parent
244 # directories, so we are forced to use a directory structure similar
245 # to home directories
246 fa=(/mnt/root/btrbk/q.*); f=${fa[0]}
247 if [[ -e $f ]]; then
248 fstab <<EOF
249 $crypt_dev /q btrfs noatime,subvol=q$mopts 0 0
250 $crypt_dev /qd btrfs noatime,subvol=qd$mopts 0 0
251 /q/p /p none bind$mopts 0 0
252 EOF
253 fi
254
255 fa=(/mnt/root/btrbk/qr.*); f=${fa[0]}
256 if [[ -e $f ]]; then
257 fstab <<EOF
258 $crypt_dev /qr btrfs noatime,subvol=qr$mopts 0 0
259 EOF
260 fi
261
262 # not syncing ar at the moment
263 # fa=(/mnt/root/btrbk/ar.*); f=${fa[0]}
264 # if [[ -e $f ]]; then
265 # fstab <<EOF
266 # $crypt_dev /ar btrfs noatime,subvol=ar,uid=1000$mopts 0 0
267 # EOF
268 # fi
269
270
271 fa=(/mnt/o/btrbk/o.*); f=${fa[0]}
272 if [[ -e $f ]]; then
273 if [[ $o_dev != "$root_dev" ]]; then
274 fstab <<EOF
275 $o_dev /o btrfs noatime,subvol=o$mopts 0 0
276 EOF
277 fi
278 fstab <<EOF
279 /o/m /m none bind$mopts 0 0
280 /o/debbugs /debbugs none bind$mopts 0 0
281 EOF
282 fi
283
284
285 ##### end setup fstab for subvols we care about ######
286
287 ### begin get pids that this program depends on so we dont kill them
288 my_pids=($$ $PPID)
289 loop_limit=30
290 count=0
291 while [[ ${my_pids[-1]} != 1 && ${my_pids[-1]} != "${my_pids[-2]}" && $count -lt $loop_limit ]]; do
292 count=$((count + 1))
293 p=$(ps -p ${my_pids[-1]} -o ppid=)
294 if [[ $p == 0 || ! $p ]]; then
295 break
296 fi
297 my_pids+=($p)
298 done
299 ### end get pids that this program depends on so we dont kill them
300
301 for vol in ${all_vols[@]}; do
302 d=/$vol
303 if ! awk '$3 == "btrfs" {print $2}' /etc/fstab | grep -xF $d &>/dev/null; then
304 continue
305 fi
306
307
308 ##### begin building up list of bind mounts ######
309 binds=() # list of bind mounts
310 roots=($d)
311 while true; do
312 new_roots=()
313 for r in ${roots[@]}; do
314 # eg. when r=/q/p, for lines like
315 # /q/p /p none bind 0 0
316 # output /p
317 new_roots+=("$(sed -rn "s#^$r/\S+\s+(\S+)\s+none\s+(\S+,|)bind[[:space:],].*#\1#p" /etc/fstab)")
318 done
319 (( ${#new_roots} )) || break
320 binds+=(${new_roots[@]})
321 # roots is used to recursively find binds of binds if they exist.
322 roots=( ${new_roots[@]} )
323 done
324 ##### end building up list of bind mounts ######
325
326
327
328 # if latest is already mounted, make sure binds are mounted and move on
329 m check-subvol-stale $d
330 # populated by check-subvol-stale if stale
331 if ! fresh_snap=$(cat /nocow/btrfs-stale/$vol 2>/dev/null); then
332 mnt $d
333 did=$(stat -c%d $d)
334 for b in ${binds[@]}; do
335 if mountpoint -q $b; then
336 bid=$(stat -c%d $b)
337 if [[ $did != "$bid" ]]; then
338 umount-kill $b
339 fi
340 fi
341 mnt $b
342 done
343 continue
344 fi
345
346
347 ##### begin checking for loopback mounts ####
348 found_loop=false
349 for l in $(losetup -ln|awk '{print $6}'); do
350 for dir in $d ${binds[@]}; do
351 if [[ $l == $dir* ]]; then
352 echo "$0: found loopback mount $l. giving up on unmounting $dir"
353 ret=1
354 found_loop=true
355 break
356 fi
357 done
358 if $found_loop; then
359 break
360 fi
361 done
362 if $found_loop; then
363 continue
364 fi
365 ##### end end checking loopback mounts ####
366
367
368 ## not using arbtt at the moment
369 # if [[ $vol == q ]]; then
370 # ## allow to fail, user might not be logged in
371 # x sudo -u $(id -nu 1000) XDG_RUNTIME_DIR=/run/user/1000 systemctl --user stop arbtt ||:
372 # fi
373 umount_ret=true
374 unmounted=()
375 for dir in $(echo $d ${binds[*]}\ |tac -s\ ); do
376 umount-kill $dir
377 done
378
379 # if we unmounted some but not all, restore them and move on
380 if ! $umount_ret; then
381 for dir in ${unmounted[@]}; do
382 mnt $dir
383 done
384 continue
385 fi
386
387 #### begin dealing with leaf vols ####
388
389 ### begin getting root_dir
390 ### this is duplicated in check-subvol-stale
391
392 dev=$(sed -rn "s,^\s*([^#]\S*)\s+$d\s.*,\1,p" /etc/fstab /etc/mtab|head -n1)
393 d dev=$dev
394 # note, we need $dev because $d might not be mounted, and we do this loop
395 # because the device in fstab for the rootfs can be different.
396 for devx in $(btrfs fil show $dev| sed -rn 's#.*path (\S+)$#\1#p'); do
397 if [[ $devx == dm-* ]]; then
398 devx=/dev/$devx
399 mapper-dev devx
400 fi
401 d devx=$devx
402 root_dir=$(sed -rn "s,^\s*$devx\s+(\S+).*\bsubvolid=[05]\b.*,\1,p" /etc/mtab /etc/fstab|head -n1)
403 if [[ $root_dir ]]; then
404 d root_dir=$root_dir
405 break
406 fi
407 done
408 if [[ ! $root_dir ]]; then
409 echo "$0: error could not find root subvol mount for $dev" >&2
410 exit 1
411 fi
412 ### end getting root_dir
413
414 cd $root_dir
415 if [[ -e $vol ]]; then
416 if [[ $vol == qd ]]; then
417 m btrfs sub del qd
418 else
419 leaf=$vol.leaf.$(date +%Y-%m-%dT%H:%M:%S%z)
420 m mv $vol $leaf
421 m btrfs property set -ts $leaf ro true
422
423 ### begin check if leaf is different, delete it if not ###
424 parentid=$(btrfs sub show $leaf | awk '$1 == "Parent" && $2 == "UUID:" {print $3}')
425 bsubs=(btrbk/$vol.*)
426 bsub= # base subvolume
427 # go in reverse order as its more likely to be at the end
428 for ((i=${#bsubs[@]}-1; i>=0; i--)); do
429 if [[ $parentid == $(btrfs sub show ${bsubs[i]} | awk '$1 == "UUID:" {print $2}') ]]; then
430 bsub=${bsubs[i]}
431 break
432 fi
433 done
434 if [[ $bsub ]]; then
435 # in testing, same subvol is 136 bytes. allow some overhead. 32 happens sometimes under systemd.
436 # $ errno 32
437 # EPIPE 32 Broken pipe
438 lines=$(btrfs send --no-data -p $bsub $leaf | btrfs receive --dump | head -n 100 | wc -l || [[ $? == 141 || ${PIPESTATUS[0]} == 32 ]])
439 if [[ $lines == 0 ]]; then
440 # example output of no differences:
441 # snapshot ./qrtest uuid=c41ff6b7-0527-f34d-95ac-190eecf54ff5 transid=2239 parent_uuid=64949e1b-4a3e-3945-9a8e-cd7b7c15d7d6 parent_transid=2239
442 echo suspected identical: $bsub $leaf
443 x btrfs sub del $leaf
444 fi
445 fi
446 ### end check if leaf is different, delete it if not ###
447
448 ## begin expire leaf vols ##
449 leaf_vols=($vol.leaf.*)
450 count=${#leaf_vols[@]}
451 leaf_limit_time=$(( EPOCHSECONDS - 60*60*24*60 )) # 60 days
452 leaf_new_limit_time=$(( EPOCHSECONDS - 60*60*24 * 5 )) # 5 days this
453 # goes backwards from oldest. leaf_new_limit_time is a safety
454 # measure to ensure we don't delete very recent leafs.
455 for leaf in ${leaf_vols[@]}; do
456 leaf_time=$(date -d ${leaf#"$vol".leaf.} +%s)
457 if (( leaf_limit_time > leaf_time || ( leaf_new_limit_time > leaf_time && count > 30 ) )); then
458 x btrfs sub del $leaf
459 fi
460 count=$((count-1))
461 done
462 fi
463 ## end expire leaf vols ##
464 fi
465 #### end dealing with leaf vols ####
466
467 # Note, we make a few assumptions in this script, like
468 # $d was not a different subvol id than $vol, and
469 # things otherwise didn't get mounted very strangely.
470 m btrfs sub snapshot $fresh_snap $vol
471 for dir in $d ${binds[@]}; do
472 m mnt $dir
473 done
474
475 ## arbtt disabled for now
476 # if [[ $vol == q ]]; then
477 # # maybe this will fail if X is not running
478 # x sudo -u $(id -nu 1000) XDG_RUNTIME_DIR=/run/user/1000 systemctl --user start arbtt ||:
479 # fi
480
481 stale_dir=/nocow/btrfs-stale
482 rm -f $stale_dir/$d
483 done
484
485
486
487 for dir in /mnt/r7/amy/{root/root,boot/boot}_ubuntubionic /mnt/{root2/root,boot2/boot}_ubuntubionic; do
488 vol=${dir##*/}
489 root_dir=${dir%/*}
490 if [[ ! -d $root_dir ]]; then
491 # this only exists on host kd currently
492 continue
493 fi
494 # if latest is already mounted, make sure binds are mounted and move on
495 m check-subvol-stale -p $dir
496 # populated by check-subvol-stale if stale
497 if ! fresh_snap=$(cat /nocow/btrfs-stale/$vol 2>/dev/null); then
498 continue
499 fi
500 if [[ -d $dir ]]; then
501 if ! kill-dir TERM TERM TERM INT INT HUP HUP TERM TERM TERM INT INT HUP HUP; then
502 if $force; then kill-dir KILL; fi
503 fi
504 m btrfs sub del $dir
505 fi
506 m btrfs sub snapshot $fresh_snap $dir
507 rm -f /nocow/btrfs-stale/$vol
508 done
509
510 if (( ret >= 1 )); then
511 echo "$0: exit status $ret. see error above"
512 fi
513 exit $ret
514
515