Compare commits

...

29 Commits

Author SHA1 Message Date
9ce4de84d7 fix(script): Document pkg character replacement (#3) 2024-07-18 19:47:12 +02:00
83e11af519 Merge remote-tracking branch 'origin/1-get-base-version-going' into 1-get-base-version-going 2024-07-18 19:33:20 +02:00
136b1aa99a fix(script): Add .gitignore, keep out JetBrains files (#3) 2024-07-18 19:32:55 +02:00
01180844e7 fix(script): Treat '@' and '+' in pkg names, ZFS doesn't like them (#3)
Replace at characters ('@') indiscriminately with one dot each ('.'),
replace plus characters ('+') with one underscore each ('_').
2024-07-18 19:31:54 +02:00
d606ae9688 refactor(docs): Layout (#1) 2023-12-26 06:15:01 +01:00
2246823d06 refactor(docs): Typo (#1) 2023-12-26 06:14:04 +01:00
3516f56580 refactor(docs): Explain counter suffix (#1) 2023-12-26 06:09:43 +01:00
525600dde4 refactor(docs): Adjust explanation of how we avoid naming collisions (#1) 2023-12-26 05:59:49 +01:00
650a91f2cc refactor(docs): Fix incorrect explanation how we identify snapshottable datasets (#1) 2023-12-26 05:59:12 +01:00
917a71ced4 feat(script): Avoid snap name collisions, always append counter to make them unique (#1) 2023-12-26 05:58:34 +01:00
ff963aa844 refactor(script): Abort early and with clear msg when no datasets snapshottable (#1) 2023-12-26 05:58:07 +01:00
c23567e2b1 refactor(script): Space out error messages correctly (#1) 2023-12-26 05:57:22 +01:00
562ffbdc0f refactor(script): Put ZFS property in a variable (#1) 2023-12-26 05:56:56 +01:00
204a2a49b1 refactor(docs): Add warning about simple snapshot names (#1) 2023-12-26 00:44:35 +01:00
d027966ed3 refactor(docs): Phrasing (#1) 2023-12-26 00:43:42 +01:00
f16f2b8612 refactor(docs): Trim ZFS example snapshot list (#1) 2023-12-26 00:27:27 +01:00
93380891ec Merge remote-tracking branch 'refs/remotes/origin/1-get-base-version-going' into 1-get-base-version-going 2023-12-26 00:20:01 +01:00
8de0e25ab8 refactor(docs): Spell ZFS all uppercase (#1) 2023-12-26 00:09:42 +01:00
4069c33145 feat(docs): Don't do duplicate snapshot names (#1) 2023-12-26 00:08:49 +01:00
2fbbf4da19 refactor(docs): Add pkg list trimming (#1) 2023-12-25 22:30:37 +01:00
47885efbab refactor(docs): Explain ZFS snapshot name max length (#1) 2023-12-25 22:30:16 +01:00
e3f6316c47 feat(docs): Explain pkg name trimming in snapshots (#1) 2023-12-25 22:12:15 +01:00
7681bbde84 refactor(docs): We're doing 10 imp snapshots by default (#1) 2023-12-25 22:11:41 +01:00
961649d252 refactor(docs): Explain new important pkgs regex (#1) 2023-12-25 21:52:20 +01:00
360c726326 refactor(conf): Keep more important snapshots (#1)
On an example daily driver test machine 10
important snapshots allow for about one full
month of rollbacks. Sounds and feels reasonable.
2023-12-25 21:50:12 +01:00
7d573627f5 refactor(conf): Add more important package names to default config (#1)
Users running ZFS may come in contact with the
archzfs repository. They may also want to try
linux-zen kernels. Add those to default config so
those users are covered.
2023-12-25 21:48:52 +01:00
818082a0b3 refactor(script): Trim package name if it doesn't fit full-length (#1) 2023-12-25 21:45:54 +01:00
04caca48a5 refactor(script): Add pkgs to snapshot name only when allowed by user (#1) 2023-12-25 21:45:05 +01:00
7efb2e5821 fix(script): Check severity against actaual severity value (#1)
Instead of checking against hard-coded string 'imp'
2023-12-25 20:47:39 +01:00
4 changed files with 271 additions and 85 deletions

1
.gitignore vendored Normal file
View File

@@ -0,0 +1 @@
.idea

129
README.md
View File

@@ -38,42 +38,139 @@ Hook files from both directories are collectively parsed and executed in lexicog
For ZFS snapshots intended to save your bacon the `00-*` naming convention is particularly critical. In `/usr/share/libalpm/hooks` you can see for example that when a kernel upgrade happens `60-mkinitcpio-remove.hook` is executed (deleting your existing `vmlinuz-*` kernel image for example at `/boot/vmlinuz-linux`). After that if you're using the `zfs-dkms` package which itself requires `dkms` which in turn installs `71-dkms-remove.hook` this hook removes your ZFS kernel module files. Both the `60-*` and optionally the `71-*` hook (for `zfs-dkms` users) run early due to their naming. If we don't create a snapshot before these hooks run we end up creating a snapshot without kernel image and without ZFS kernel module files. Our `00-*` hook files are executed early enough ensuring that a snapshot can safely return you to a working system.
By default we identify the active system dataset by doing `findmnt / --noheadings --output source` which for example returns:
## Snapshot selection
We snapshot datasets that have the `space.quico:auto-snapshot` property set to `true`. By default we further limit datasets to only those that are currently mounted in your active operating system. We identify these by asking `findmnt` for a list of mounted file systems of `fstype=="zfs"` which for example returns:
```
# findmnt --json --list --output 'fstype,source,target' | \
jq --raw-output '.[][] | select(.fstype=="zfs") | .source'
zpool/root/archlinux
```
If exactly one source returns that is the exact name of a ZFS dataset in an imported zpool we create a snapshot on it. If no source returns we silently exit. If more than one source returns we raise an error and halt the `pacman` transaction.
If no dataset (or no _local_ dataset) has the property set correctly no snapshots are done. The script will print an info-level message about that on `pacman` transactions.
We retain two different snapshot chains, one for `pacman` transactions that only affect what we are calling _trivial_ packages and a separate chain for _important_ packages. By default only the exact regular expression package name match `^(linux|systemd|zfs-(dkms|utils))$` is considered important so in plain English any one of:
## Snapshot chains
We retain two different snapshot chains, one for `pacman` transactions that only affect what we are calling _trivial_ packages and a separate chain for _important_ packages. By default only the exact regular expression package name match `^(linux(-zen)?(-headers)?|systemd|zfs-(linux(-zen)?|dkms|utils))$` is considered important so in plain English any one of:
- `linux`
- `linux-headers`
- `linux-zen`
- `linux-zen-headers`
- `systemd`
- `zfs-linux`
- `zfs-linux-zen`
- `zfs-dkms`
- `zfs-utils`
Whenever an important package is affected by a transaction a snapshot goes into the corresponding chain. In all other cases - when an important package is not affected - snapshots go into the trivial chain.
The _trivial_ snapshot chain by default keeps 25 snapshots, the _important_ chain keeps 10. The thought process here is that you will likely not futz around with a kernel every day whereas you may very well install arbitrary packages multiple times a day. Snapshots should keep you safe for a couple of days hence the defaults of 10 and 25 snapshots, respectively.
The _trivial_ snapshot chain by default keeps 25 snapshots, the _important_ chain keeps 10. The thought process here is that you will likely not futz around with a kernel every day whereas you may very well install arbitrary packages multiple times a day. Snapshots should keep you safe for a low number of weeks up to maybe a full month on an average daily driver system hence the defaults of 10 and 25 snapshots, respectively.
## Dataset naming and uniqueness
Snapshots may look like so:
```
$ zfs list -o name -t all
NAME ┌─── Important because systemd
zpool snap_date_format='%F-%H%M' | is on our list of
zpool/root ▼ | important packages
zpool/root/archlinux ┌─────────────┐ ▼▼▼
zpool/root/archlinux@pacman_2023-03-07-0113_op:upgr_sev:imp_pkgs:systemd:bind:enchant:grep
zpool/root/archlinux@pacman_2023-03-07-0113_op:upgr_sev:trv_pkgs:jdk17-temurin
zpool/root/archlinux@pacman_2023-03-07-0115_op:upgr_sev:trv_pkgs:proton-ge-custom-bin
▲▲▲▲ ▲▲▲ └────────────────────────────┘
| | Max. 30 characters per our
Pacman operation that triggered this snapshot ───┘ | pacman-zfs-snapshot.conf
| setting 'pkgs_list_max_length'
Severity based on affected packages, here trivial ───────┘
NAME snap_date_format='%F-%H%M' ┌─── Important because systemd
zpool | | is on our list of
zpool/root ▼ ┌ Counter | important packages
zpool/root/archlinux ┌─────────────┐ ▼▼▼
zpool/root/archlinux@pacman_2023-03-07-0113_1_op:upgr_sev:imp_pkgs:systemd:bind:enchant:grep
zpool/root/archlinux@pacman_2023-03-07-0113_1_op:upgr_sev:trv_pkgs:jdk17-temurin
zpool/root/archlinux@pacman_2023-03-07-0114_1_op:inst_sev:trv_pkgs:docker-credential-secretser...
zpool/root/archlinux@pacman_2023-03-07-0115_1_op:upgr_sev:trv_pkgs:proton-ge-custom-bin
▲▲▲▲ ▲▲▲ └────────────────────────────┘
| | Max. 30 characters per our
Pacman operation that triggered this snapshot ───┘ | pacman-zfs-snapshot.conf
| setting 'pkgs_list_max_length'
Severity based on affected packages, here trivial ───────┘
```
Notice how in this case the _counter_ is `1` for all four snapshots. The counter is used as the distinguishing factor for snapshots that are otherwise identical. This avoids naming collisions by incrementing it as needed. In day-to-day operations you will typically see it at `1` as there rarely is a need to avoid collisions unless you purposely limit the timestamp length and/or package list length to the point that successive snapshots may appear identical. See [Avoiding naming collisions](#avoiding-naming-collisions) for more details.
Notice also how snapshot line 3 ends in `docker-credential-secretser...`. This snapshot was triggered on installation of the Arch User Repository package [docker-credential-secretservice-bin](https://aur.archlinux.org/packages/docker-credential-secretservice-bin) whose package name is 35 characters long. In this example our `pkgs_list_max_length` setting limits maximum name of the packages string to `30` characters. If we can't naturally fit package names into this limit by removing packages from the list we instead cut off part of the package name and add an ellipsis (three dots `...`). The default setting is `pkgs_list_max_length='30'`. In case the user wants three characters or fewer thus making an ellipsis impractical we simply trim the package name to that many characters:
```
pkgs_list_max_length='7': dock...
pkgs_list_max_length='6': doc...
pkgs_list_max_length='5': do...
pkgs_list_max_length='4': d...
pkgs_list_max_length='3': doc
pkgs_list_max_length='2': do
pkgs_list_max_length='1': d
```
With a package list allowance of 0 characters the entire `pkgs` field is removed. Above example will then look like so:
```
$ zfs list -o name -t all
NAME
zpool
zpool/root
zpool/root/archlinux
zpool/root/archlinux@pacman_2023-03-07-0113_1_op:upgr_sev:imp
zpool/root/archlinux@pacman_2023-03-07-0113_1_op:upgr_sev:trv
zpool/root/archlinux@pacman_2023-03-07-0114_1_op:inst_sev:trv
zpool/root/archlinux@pacman_2023-03-07-0115_1_op:upgr_sev:trv
```
Whatever you set as your `pkgs_list_max_length` is still just a best effort as it is subject to ZFS' internal maximum for dataset name length. This limit is currently 255 characters. For a snapshot the dataset name in front of the `@` character plus everything else starting with the `@` character til the end count against the limit. If you'd like e.g. 200 characters allocated to the package list chances are that you'll see fewer characters than that depending on how long your dataset names are on their own.
## Special characters in package names
Arch Linux has no qualms with at (`@`) characters and plus (`+`) characters in package names but ZFS very much does take issue with those. Just a heads-up, when constructing a ZFS snapshot name we replace all `@` characters in package names with one dot each (`.`) and we replace all `+` characters with one underscore each (`_`).
A snapshot name that would appear like so:
```
$ zfs list -o name -t all
NAME
zpool
zpool/root
zpool/root/archlinux
zpool/root/archlinux@pacman_2023-03-07-0113_1_op:upgr_sev:trv_pkgs:jdk17-temurin:libc++
~~~~~~
```
We'll create like so instead:
```
$ zfs list -o name -t all
NAME
zpool
zpool/root
zpool/root/archlinux
zpool/root/archlinux@pacman_2023-03-07-0113_1_op:upgr_sev:trv_pkgs:jdk17-temurin:libc__
~~~~~~
```
Have a look at `pacman-zfs-snapshot.conf` as well, its comments should be clear enough to get you going.
# Avoiding naming collisions
By default snapshot names contain a timestamp formatted like so: `2023-03-07-0114`. This makes snapshot names reasonably unique. You can change both the timestamp format and timezone in `pacman-zfs-snapshot.conf` where the format defaults to:
```
snap_date_format='%F-%H%M'
```
And the timezone defaults to:
```
snap_timezone='Etc/UTC'
```
With these settings it is possible to cause ZFS snapshot name collisions (meaning reuse of the exact same snapshot name) when all of the following conditions are true for any two `pacman` operations:
- They occur within the same minute
- They cover the same type of operation (_Install_, _Remove_ or _Upgrade_)
- They cover the same list of packages
The script safeguards against naming collisions by adding a monotonically incrementing counter after the timestamp string.
For example by running `pacman -S tmux` three times within the same minute (once for an _Install_ operation and two more times for two identical _Upgrade_ operations) your system may generate the following example snapshots:
```
zpool/root/archlinux@pacman_2023-03-07-0116_1_op:inst_sev:trv_pkgs:tmux
zpool/root/archlinux@pacman_2023-03-07-0116_1_op:upgr_sev:trv_pkgs:tmux
zpool/root/archlinux@pacman_2023-03-07-0116_2_op:upgr_sev:trv_pkgs:tmux
~~~
```
Notice that lines 2 and 3 would collide since their dataset names are virtually identical other than the counter suffix which was incremented by 1 to avoid a collision.
This facilitates a hands-off approach to using this script on a daily driver system without risking missing snapshots or employing other more involved approaches to avoid naming collisions.
# Rollback
After a rollback for example via the excellent [ZFSBootMenu](https://docs.zfsbootmenu.org/) `pacman` and all AUR helpers you may be using will consider the `pacman` database to be locked. No `pacman` transactions can start, you will for example see:

View File

@@ -9,7 +9,7 @@ do_dry_run='false'
# before a pacman transaction on an important package have a separate
# retention from snapshots for trivial packages. Lends itself to keeping
# high-risk updates separate from everything else.
important_names='linux|systemd|zfs-(dkms|utils)'
important_names='linux(-zen)?(-headers)?|systemd|zfs-(linux(-zen)?|dkms|utils)'
# Number snapshots to keep
snaps_trivial_keep='25'

View File

@@ -31,7 +31,8 @@ snap_op_remove_suffix="${snap_op_remove_suffix:-rmvl}"
snap_op_upgrade_suffix="${snap_op_upgrade_suffix:-upgr}"
# Internal
declare pkg_separator max_zfs_snapshot_name_length color_reset color_lyellow color_red
declare zfs_prop pkg_separator max_zfs_snapshot_name_length color_reset color_lyellow color_red
zfs_prop='space.quico:auto-snapshot'
pkg_separator=':'
max_zfs_snapshot_name_length='255'
color_reset='\e[0m'
@@ -63,7 +64,7 @@ function pprint () {
printf -- "${color_lyellow}"'[WARN]'"${color_reset}"' %s\n' "${msg}"
;;
err)
printf -- "${color_red}"'[ERR]'"${color_reset}"' %s\n' "${msg}"
printf -- "${color_red}"'[ERR] '"${color_reset}"' %s\n' "${msg}"
;;
info)
printf -- '[INFO] %s\n' "${msg}"
@@ -95,12 +96,12 @@ function set_severity () {
function get_globally_snappable_datasets () {
local datasets_list
# For all datasets show their 'space.quico:auto-snapshot' property; only
# print dataset name in column 1 and property value in column 2. In awk
# limit this list to datasets where tab-delimited column 2 has exact
# string '^true$' then further limit output by eliminating snapshots
# from list, i.e. dataset names that contain an '@' character.
datasets_list="$(zfs get -H -o 'name,value' 'space.quico:auto-snapshot' | \
# For all datasets show their "${zfs_prop}" property; only print dataset
# name in column 1 and property value in column 2. In awk limit this
# list to datasets where tab-delimited column 2 has exact string
# '^true$' then further limit output by eliminating snapshots from list,
# i.e. dataset names that contain an '@' character.
datasets_list="$(zfs get -H -o 'name,value' "${zfs_prop}" | \
awk -F'\t' '{if($2 ~ /^true$/ && $1 !~ /@/) print $1}')"
while IFS= read -u10 -r dataset; do
globally_snappable_datasets+=("${dataset}")
@@ -127,7 +128,7 @@ function trim_globally_snappable_datasets () {
}
function write_pkg_list_oneline () {
if [[ "${severity}" == 'imp' ]]; then
if [[ "${severity}" == "${snaps_important_suffix}" ]]; then
for pkg in "${important_pkgs_in_transaction[@]}"; do
if [[ "${unabridged_pkg_list_oneline}" ]]; then
unabridged_pkg_list_oneline="${unabridged_pkg_list_oneline}${pkg_separator}${pkg}"
@@ -147,73 +148,147 @@ function write_pkg_list_oneline () {
fi
}
function find_max_dataset_name_length () {
local longest_op_suffix op_suffix_string
longest_op_suffix='0'
for op_suffix in "${snap_op_installation_suffix}" "${snap_op_remove_suffix}" "${snap_op_upgrade_suffix}"; do
if [[ "${#op_suffix}" -gt "${longest_op_suffix}" ]]; then
longest_op_suffix="${#op_suffix}"
fi
done
op_suffix_string="$(head -c "${longest_op_suffix}" '/dev/zero' | tr '\0' '_')"
local longest_sev_suffix sev_suffix_string
longest_sev_suffix='0'
for sev_suffix in "${snaps_trivial_suffix}" "${snaps_important_suffix}"; do
if [[ "${#sev_suffix}" -gt "${longest_sev_suffix}" ]]; then
longest_sev_suffix="${#sev_suffix}"
fi
done
sev_suffix_string="$(head -c "${longest_sev_suffix}" '/dev/zero' | tr '\0' '_')"
local dataset_name_no_pkgs
max_dataset_name_length='0'
for dataset in "${snappable_datasets[@]}"; do
dataset_name_no_pkgs="${dataset}"'@'"${snap_name_prefix}${snap_field_separator}${date_string}${snap_field_separator}"'op:'"${op_suffix_string}${snap_field_separator}"'sev:'"${sev_suffix_string}${snap_field_separator}"'pkgs:'
if [[ "${#dataset_name_no_pkgs}" -gt "${max_dataset_name_length}" ]]; then
max_dataset_name_length="${#dataset_name_no_pkgs}"
fi
done
if [[ "${max_dataset_name_length}" -gt "${max_zfs_snapshot_name_length}" ]]; then
pprint 'warn' 'Snapshot name would exceed ZFS '"${max_zfs_snapshot_name_length}"' chars limit. Skipping snapshots ...' '0'
fi
function trim_single_remaining_package_name () {
local pkg_name
pkg_name="${shorter_pkg_list}"
case 1 in
# Trim to 1 to 3 characters, no trailing ellipsis (...)
$(( 1<=pkgs_list_max_length && pkgs_list_max_length<=3 )))
pkg_name="${pkg_name::${pkgs_list_max_length}}"
;;
# Show as many pkg name characters as we can while also
# fitting an ellipsis into the name (...) to indicate
# that we've cut the pkg name off at the end.
$(( pkgs_list_max_length>=4 )))
pkg_name="${pkg_name::$(( pkgs_list_max_length - 3 ))}"'...'
;;
esac
shorter_pkg_list="${pkg_name}"
}
function trim_pkg_list_oneline () {
local available_pkg_list_length
available_pkg_list_length="$((${max_zfs_snapshot_name_length} - ${max_dataset_name_length}))"
available_pkg_list_length="${1}"
if [[ "${available_pkg_list_length}" -lt "${pkgs_list_max_length}" ]]; then
# If we have fewer characters available than the user wants limit
# package list length
# If we have fewer characters available before hitting the
# ZFS internal maximum snapshot name length than the user
# wants limit package list length.
pkgs_list_max_length="${available_pkg_list_length}"
fi
local shorter_pkg_list
shorter_pkg_list="${unabridged_pkg_list_oneline}"
while [[ "${#shorter_pkg_list}" -gt "${pkgs_list_max_length}" ]]; do
shorter_pkg_list="${shorter_pkg_list%${pkg_separator}*}"
if ! grep -Piq "${pkg_separator}" <<<"${shorter_pkg_list}"; then
# Only one package remains in package list, no need to continue
break
fi
done
if [[ "${#shorter_pkg_list}" -gt "${pkgs_list_max_length}" ]]; then
# If this is still too long we empty the package list
if [[ "${pkgs_list_max_length}" -le '0' ]]; then
# User wants zero characters of pkg names in snapshot name,
# no need to even find an appropriate pkg name string. Just
# set to empty string and we're done here.
shorter_pkg_list=''
else
shorter_pkg_list="${unabridged_pkg_list_oneline}"
while [[ "${#shorter_pkg_list}" -gt "${pkgs_list_max_length}" ]]; do
shorter_pkg_list="${shorter_pkg_list%${pkg_separator}*}"
if ! grep -Piq "${pkg_separator}" <<<"${shorter_pkg_list}"; then
# Only one package remains in package list, no need to continue
break
fi
done
# If pkg name is still too long trim it. If there's enough
# space for an ellipsis (...) we add that to indicate we've
# trimmed the name, otherwise we just take however many
# characters of the pkg name we can get.
if [[ "${#shorter_pkg_list}" -gt "${pkgs_list_max_length}" ]]; then
trim_single_remaining_package_name
fi
fi
trimmed_pkg_list_oneline="${shorter_pkg_list}"
}
function do_snaps () {
local snap_name snap_return_code
local -a planned_snaps
for snappable_dataset_id in "${!snappable_datasets[@]}"; do
snap_name="${snappable_datasets[${snappable_dataset_id}]}"'@'"${snap_name_prefix}${snap_field_separator}${date_string}${snap_field_separator}"'op:'"${conf_op_suffix}${snap_field_separator}"'sev:'"${severity}${snap_field_separator}"'pkgs:'"${trimmed_pkg_list_oneline}"
planned_snaps["${snappable_dataset_id}"]="${snap_name}"
function test_snap_names_for_validity () {
local snap_counter max_dataset_name_length trimmed_pkg_list_oneline dataset_name_no_pkgs dataset_name_with_pkgs
snap_counter="${1}"
max_dataset_name_length='0'
for dataset in "${snappable_datasets[@]}"; do
# Begin building snapshot name
dataset_name_no_pkgs="${dataset}"'@'"${snap_name_prefix}${snap_field_separator}${date_string}"
# Append counter
dataset_name_no_pkgs="${dataset_name_no_pkgs}${snap_field_separator}${snap_counter}"
# Append operation, severity and packages fields
dataset_name_no_pkgs="${dataset_name_no_pkgs}${snap_field_separator}"'op:'"${conf_op_suffix}${snap_field_separator}"'sev:'"${severity}"
# Update the longest snapshot name seen so far. We add an automatic
# +6 to string length (or more exactly ${#snap_field_separator}+5)
# to account for the fact that by default the dataset will end in
# the separator string "${snap_field_separator}" plus 'pkgs:' for a
# total of 6 additional characters. If these additional characters
# cause us to reach or go over the ZFS dataset name length limit
# there's no point in attempting to add package names to snapshots.
# We calculate as if these additional characters existed and we add
# dataset names to our planned_snaps array as if they don't.
if [[ "$(( ${#dataset_name_no_pkgs}+${#snap_field_separator}+5 ))" -gt "${max_dataset_name_length}" ]]; then
max_dataset_name_length="$(( ${#dataset_name_no_pkgs}+${#snap_field_separator}+5 ))"
fi
planned_snaps+=("${dataset_name_no_pkgs}")
done
# Abort if this is longer than what ZFS allows
if [[ "${max_dataset_name_length}" -gt "${max_zfs_snapshot_name_length}" ]]; then
pprint 'err' 'Snapshot name would exceed ZFS '"${max_zfs_snapshot_name_length}"' chars limit. Aborting ...' '1'
fi
if [[ "${max_dataset_name_length}" -eq "${max_zfs_snapshot_name_length}" ]]; then
for planned_snap in "${planned_snaps[@]}"; do
if grep -Piq -- '^'"${planned_snap}"'$' <<<"${existing_snaps}"; then
# This snapshot name already exists. Unset array and break.
# Try again with next higher counter suffix.
unset planned_snaps[@]
break
fi
done
# If planned_snaps array still has members we take the snapshot
# names already generated. If not we return without array in which
# case this function will run again with the snapshot counter
# incremented by one. Maximum length seen across all snapshot names
# is exactly the ZFS snapshot character limit. We won't be able to
# add packages to snapshot names but they will all fit perfectly.
# This is good enough.
return
else
# We have enough room to add package names.
local available_pkg_list_length
available_pkg_list_length="${pkgs_list_max_length}"
if [[ "${max_dataset_name_length}" -gt $(( max_zfs_snapshot_name_length - pkgs_list_max_length )) ]]; then
available_pkg_list_length="$(( max_zfs_snapshot_name_length - max_dataset_name_length ))"
fi
trim_pkg_list_oneline "${available_pkg_list_length}"
for planned_snap_id in "${!planned_snaps[@]}"; do
planned_snaps["${planned_snap_id}"]="${planned_snaps[${planned_snap_id}]}${snap_field_separator}"'pkgs:'"${trimmed_pkg_list_oneline}"
if grep -Piq -- '^'"${planned_snaps[${planned_snap_id}]}"'$' <<<"${existing_snaps}"; then
# This snapshot name already exists. Unset array and break.
# Try again with next higher counter suffix.
unset planned_snaps[@]
break
fi
done
fi
}
function generate_snap_names () {
local snap_counter existing_snaps
snap_counter='0'
existing_snaps="$(zfs list -t all -oname -H)"
until [[ "${#planned_snaps[@]}" -gt '0' ]]; do
snap_counter="$(( snap_counter+1 ))"
test_snap_names_for_validity "${snap_counter}"
done
}
function do_snaps () {
local snap_return_code
if [[ "${do_dry_run}" == 'true' ]]; then
pprint 'info' 'Dry-run, pretending to atomically do zfs snapshot:'
pprint 'info' 'Dry-run, pretending to atomically do ZFS snapshot:'
for planned_snap in "${planned_snaps[@]}"; do
pprint 'info' ' '"${planned_snap}"
done
@@ -222,12 +297,12 @@ function do_snaps () {
snap_return_code="${?}"
if [[ "${snap_return_code}" -eq '0' ]]; then
successfully_snapped_datasets=("${snappable_datasets[@]}")
pprint 'info' 'zfs snapshot atomically done:'
pprint 'info' 'ZFS snapshot atomically done:'
for planned_snap in "${planned_snaps[@]}"; do
pprint 'info' ' '"${planned_snap}"
done
else
pprint 'warn' 'zfs snapshot failed:'
pprint 'warn' 'ZFS snapshot failed:'
for planned_snap in "${planned_snaps[@]}"; do
pprint 'warn' ' '"${planned_snap}"
done
@@ -248,7 +323,7 @@ function do_retention () {
local snap_list snaps_done_by_us snaps_in_cur_sev snaps_limit oldest_snap snap_return_code
local -a destroyed_snaps failed_to_destroy_snaps
if [[ "${do_dry_run}" == 'true' ]]; then
pprint 'info' 'Dry-run, skipping potential zfs destroy operations ...'
pprint 'info' 'Dry-run, skipping potential ZFS destroy operations ...'
else
for successfully_snapped_dataset in "${successfully_snapped_datasets[@]}"; do
snaps_in_cur_sev="$(get_snaps_in_cur_sev "${successfully_snapped_dataset}")"
@@ -287,6 +362,11 @@ function do_retention () {
function main () {
local pkgs_in_transaction
pkgs_in_transaction=("${@}")
# Replace characters that are valid as Arch Linux package names but invalid as ZFS dataset names with something ZFS
# doesn't mind. Replace at characters ('@') indiscriminately with one dot each ('.'), replace plus characters ('+')
# with one underscore each ('_').
pkgs_in_transaction=("${pkgs_in_transaction[@]//+/_}")
pkgs_in_transaction=("${pkgs_in_transaction[@]//@/.}")
local -a important_pkgs_in_transaction trivial_pkgs_in_transaction
split_pkgs_by_importance "${pkgs_in_transaction[@]}"
@@ -302,19 +382,27 @@ function main () {
local local_snappable_datasets
get_local_snappable_datasets
trim_globally_snappable_datasets
if [[ "${#snappable_datasets[@]}" -eq '0' ]]; then
pprint 'info' 'ZFS snapshot skipped, no local (= currently mounted) dataset has'
pprint 'info' 'property '"'"''"${zfs_prop}"''"'"' set to '"'"'true'"'"'. At the same'
pprint 'info' 'time option '"'"'snap_only_local_datasets'"'"' equals '"'"'true'"'"' so'
pprint 'info' 'we must only snapshot local datasets. Nothing to do here while'
pprint 'info' 'none of them have '"'"''"${zfs_prop}"''"'"' set to '"'"'true'"'"'.' '0'
fi
else
snappable_datasets=("${globally_snappable_datasets}")
if [[ "${#snappable_datasets[@]}" -eq '0' ]]; then
pprint 'info' 'ZFS snapshot skipped, no dataset has property '"'"''"${zfs_prop}"''"'"' set to '"'"'true'"'"'.' '0'
fi
fi
local unabridged_pkg_list_oneline
write_pkg_list_oneline
local date_string max_dataset_name_length
local date_string
local -a planned_snaps
date_string="$($([[ "${snap_timezone}" ]] && printf -- 'export TZ='"${snap_timezone}"); date +"${snap_date_format}")"
find_max_dataset_name_length
local trimmed_pkg_list_oneline
trim_pkg_list_oneline
generate_snap_names
local -a successfully_snapped_datasets
do_snaps