httm 0.49.9

A CLI tool for viewing snapshot file versions on ZFS and btrfs datasets
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

#!/usr/bin/env bash

#       ___           ___           ___           ___
#      /\__\         /\  \         /\  \         /\__\
#     /:/  /         \:\  \        \:\  \       /::|  |
#    /:/__/           \:\  \        \:\  \     /:|:|  |
#   /::\  \ ___       /::\  \       /::\  \   /:/|:|__|__
#  /:/\:\  /\__\     /:/\:\__\     /:/\:\__\ /:/ |::::\__\
#  \/__\:\/:/  /    /:/  \/__/    /:/  \/__/ \/__/~~/:/  /
#       \::/  /    /:/  /        /:/  /            /:/  /
#       /:/  /     \/__/         \/__/            /:/  /
#      /:/  /                                    /:/  /
#      \/__/                                     \/__/
#
# Copyright (c) 2023, Robert Swinford <robert.swinford<...at...>gmail.com>
#
# For the full copyright and license information, please view the LICENSE file
# that was distributed with this source code.

## Note: env is zsh/bash here but could maybe/should work in zsh/bash too? ##

set -euf -o pipefail
#set -x

function print_version {
	printf "\
zdbstat $(httm --version | cut -f2 -d' ')
" 1>&2
	exit 0
}

function print_usage {
	local zdbstat="\e[31mzdbstat\e[0m"

	printf "\
$zdbstat prints the underlying zdb metadata for a ZFS object.  $zdbstat takes no options and requires at least one path.

USAGE:
	zdbstat [path1 path2...]

" 1>&2
	exit 1
}

function print_err_exit {
	print_err "$*"
	exit 1
}

function print_err {
	printf "%s\n" "ERROR: $*" 1>&2
}

function prep_exec {
	[[ -n "$(
		command -v stat
		exit 0
	)" ]] || print_err_exit "'stat' is required to execute 'zdbstat'.  Please check that 'stat' is in your path."
	[[ -n "$(
		command -v zdb
		exit 0
	)" ]] || print_err_exit "'zdb' is required to execute 'zdbstat'.  Please check that 'zdb' is in your path."
	[[ -n "$(
		command -v zfs
		exit 0
	)" ]] || print_err_exit "'zfs' is required to execute 'zdbstat'.  Please check that 'zfs' is in your path."
}

function prep_sudo {
	local sudo_program=""

	local -a program_list=(
		sudo
		doas
		pkexec
	)

	for p in "${program_list[@]}"; do
		sudo_program="$(
			command -v "$p"
			exit 0
		)"
		[[ -z "$sudo_program" ]] || break
	done

	[[ -n "$sudo_program" ]] ||
		print_err_exit "'sudo'-like program is required to execute.  Please check that 'sudo' (or 'doas' or 'pkexec') is in your path."

	printf "%s" "$sudo_program"
}

function dump_zfs_obj_metadata() {

    local file_name=""
    local sudo_program=""
    local dataset=""
    local inode=""

    file_name="$1"
    sudo_program="$2"
    source="$( zfs list -H -o name "$file_name" 2>/dev/null; exit 0 )"
    [[ -n "$source" ]] || source="$( zfs list -H -o name "$file_name" 2>&1 | cut -f2 -d"'" ; exit 0 )"
    inode="$( stat -c %i "$file_name" 2>/dev/null; exit 0 )"

    if [[ -z "$source" ]]; then
	print_err_exit "Could not determine source dataset for path: "$file_name""
    fi

    if [[ -z "$inode" ]]; then
	print_err_exit "Could not determine inode for path: "$inode""
    fi

    "$sudo_program" zdb -dddddddddd "$source" "$inode"
}


function run_loop() {
    prep_exec
    [[ $# -ge 1 ]] || print_usage

    local sudo_program="$( prep_sudo )"

    for f in "${@}"; do

        local file_name=""
        file_name="$( readlink -e "$f" 2>/dev/null; exit 0 )"

        if [[ -z "$file_name" ]]; then
            print_err "WARN: Path likely does not exist: $f"
            continue
        fi

	if [[ "$( echo "$file_name" | grep -c ".zfs/snapshot" )" -eq 0 ]] && \
	[[ -z "$( zfs list "$file_name" 2>/dev/null; exit 0 )" ]]; then
		print_err "WARN: zdbstat requires a valid zfs path: "$file_name""
		continue
	fi

        dump_zfs_obj_metadata "$file_name" "$sudo_program"

    done

}

run_loop "${@}"