bash scripts: use /usr/bin/env for bash shebangs
Not all systems / distros have a `/bin/bash`, and these scripts are
more difficult to run at development time.
For example, my system is NixOS which doesn't have a /bin/bash. This
is not a problem for NixOS building ZFS as a package: the build
environment automatically replaces these shebangs with corrected
paths.
The problem is much more annoying at development time: either the
scripts don't run, or I correct them for my local machine and deal with
a perpetually dirty work tree.
Before committing this patch I confirmed there are existing scripts
which use `/usr/bin/env` to locate bash, so I am thinking this is a
safe transformation.
There are a handful of other shebangs in this repository which don't
work on my system. This patch is useful on its own specifically for
`commitcheck.sh`, otherwise I can't validate my commits before
submission.
Here are the remaining shebangs which NixOS systems won't have:
1274 #!/bin/ksh -p
91 #!/bin/ksh
89 #! /bin/ksh -p
2 #!/bin/sed -f
1 #!/usr/bin/perl -w
1 #!/usr/bin/ksh
1 #!/bin/nawk -f
plus this which will create an invalid shebang in
`tests/zfs-tests/tests/functional/mv_files/mv_files_common.kshlib`:
echo "#!/bin/ksh" > $TEST_BASE_DIR/exitsZero.ksh
I chose to leave those alone for now, and gauge the interest in this
much smaller patch first.
The fixes for these are easy enough by simply using `/usr/bin/env ksh`:
91 #!/bin/ksh
1 #!/usr/bin/ksh
The fix for the other set is much trickier. Quoting the GNU coreutils
manual:
Most operating systems (e.g. GNU/Linux, BSDs) treat all text after
the first space as a single argument. When using env in a script it
is thus not possible to specify multiple arguments.
and not all `env`'s support arguments.
Mine (GNU Coreutils 8.31) does, though this feature is new since
April 2018, GNU Coreutils 8.30:
https://git.savannah.gnu.org/cgit/coreutils.git/commit/?id=668306ed86c8c79b0af0db8b9c882654ebb66db2
and worse, requires the -S argument:
-S, --split-string=S process and split S into separate arguments;
used to pass multiple arguments on shebang
lines
Example:
$ seq 1 2 | $(nix-build '<nixpkgs>' -A coreutils)/bin/env "sort -nr"
/nix/[...]-coreutils-8.31/bin/env: ‘sort -nr’: No such file or directory
/nix/[...]-coreutils-8.31/bin/env: use -[v]S to pass options in shebang lines
$ seq 1 2 | $(nix-build '<nixpkgs>' -A coreutils)/bin/env "-S sort -nr"
2
1
GNU Coreutils says FreeBSD's `env` does, though I wonder if FreeBSD's
would be unhappy with the `-S`:
https://www.gnu.org/software/coreutils/manual/html_node/env-invocation.html#env-invocation
BusyBox v1.30.1 does not, and does not have a `-S`-like option:
$ seq 1 2 | $(nix-build '<nixpkgs>' -A busybox)/bin/env "sort -nr"
env: can't execute 'sort -nr': No such file or directory
Toybox 0.8.1 also does not, and also does not have a `-S` option:
$ seq 1 2 | $(nix-build '<nixpkgs>' -A toybox)/bin/env "sort -nr"
env: exec sort -nr: No such file or directory
---
At any rate, if this patch merges and the remaining ~1,500 are updated,
the much larger patch should probably include a checkstyle-like test
asserting all new shebangs use `/usr/bin/env`. I also don't mind
dealing with NixOS weirdness if the project would prefer that.
Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: Ryan Moeller <ryan@iXsystems.com>
Signed-off-by: Graham Christensen <graham@grahamc.com>
Closes #9893
2020-02-10 21:13:46 +00:00
|
|
|
#!/usr/bin/env bash
|
2016-03-30 23:59:15 +00:00
|
|
|
|
|
|
|
get_devtype() {
|
|
|
|
local typ
|
|
|
|
typ=$(udevadm info --query=property --name="$1" | grep "^ID_FS_TYPE=" | sed 's|^ID_FS_TYPE=||')
|
|
|
|
if [ "$typ" = "" ] ; then
|
|
|
|
typ=$(blkid -c /dev/null "$1" -o value -s TYPE)
|
|
|
|
fi
|
|
|
|
echo "$typ"
|
|
|
|
}
|
|
|
|
|
|
|
|
get_pool_devices() {
|
|
|
|
# also present in 99zfssystemd
|
|
|
|
local poolconfigtemp
|
|
|
|
local poolconfigoutput
|
|
|
|
local pooldev
|
|
|
|
local prefix
|
2016-04-24 11:35:44 +00:00
|
|
|
local resolved
|
2016-03-30 23:59:15 +00:00
|
|
|
poolconfigtemp=`mktemp`
|
2016-04-24 11:35:44 +00:00
|
|
|
@sbindir@/zpool list -v -H -P "$1" > "$poolconfigtemp" 2>&1
|
2016-03-30 23:59:15 +00:00
|
|
|
if [ "$?" != "0" ] ; then
|
|
|
|
poolconfigoutput=$(cat "$poolconfigtemp")
|
|
|
|
dinfo "zfsexpandknowledge: pool $1 cannot be listed: $poolconfigoutput"
|
|
|
|
else
|
2017-01-31 22:25:49 +00:00
|
|
|
cat "$poolconfigtemp" | awk -F '\t' '/\t\/dev/ { print $2 }' | \
|
2016-03-30 23:59:15 +00:00
|
|
|
while read pooldev ; do
|
2016-04-24 11:35:44 +00:00
|
|
|
if [ -n "$pooldev" -a -e "$pooldev" ] ; then
|
|
|
|
if [ -h "$pooldev" ] ; then
|
|
|
|
resolved=`readlink -f "$pooldev"`
|
|
|
|
else
|
|
|
|
resolved="$pooldev"
|
|
|
|
fi
|
|
|
|
dinfo "zfsexpandknowledge: pool $1 has device $pooldev (which resolves to $resolved)"
|
|
|
|
echo "$resolved"
|
2016-03-30 23:59:15 +00:00
|
|
|
fi
|
2017-01-31 22:25:49 +00:00
|
|
|
done
|
2016-03-30 23:59:15 +00:00
|
|
|
fi
|
|
|
|
rm -f "$poolconfigtemp"
|
|
|
|
}
|
|
|
|
|
|
|
|
find_zfs_block_devices() {
|
|
|
|
local dev
|
|
|
|
local blockdev
|
|
|
|
local mp
|
|
|
|
local fstype
|
|
|
|
local pool
|
|
|
|
local key
|
|
|
|
local n
|
|
|
|
local poolconfigoutput
|
|
|
|
numfields=`head -1 /proc/self/mountinfo | awk '{print NF}'`
|
|
|
|
if [ "$numfields" == "10" ] ; then
|
|
|
|
fields="n n n n mp n n fstype dev n"
|
|
|
|
else
|
|
|
|
fields="n n n n mp n n n fstype dev n"
|
|
|
|
fi
|
|
|
|
while read $fields ; do
|
|
|
|
if [ "$fstype" != "zfs" ]; then continue ; fi
|
|
|
|
if [ "$mp" == "$1" ]; then
|
|
|
|
pool=$(echo "$dev" | cut -d / -f 1)
|
|
|
|
get_pool_devices "$pool"
|
|
|
|
fi
|
|
|
|
done < /proc/self/mountinfo
|
|
|
|
}
|
|
|
|
|
|
|
|
array_contains () {
|
|
|
|
local e
|
|
|
|
for e in "${@:2}"; do [[ "$e" == "$1" ]] && return 0; done
|
|
|
|
return 1
|
|
|
|
}
|
|
|
|
|
|
|
|
check() {
|
|
|
|
local mp
|
|
|
|
local dev
|
|
|
|
local blockdevs
|
|
|
|
local fstype
|
|
|
|
local majmin
|
|
|
|
local _slavedev
|
|
|
|
local _slavedevname
|
|
|
|
local _slavedevtype
|
|
|
|
local _slavemajmin
|
|
|
|
local _dev
|
|
|
|
|
|
|
|
if [[ $hostonly ]]; then
|
|
|
|
|
|
|
|
for mp in \
|
|
|
|
"/" \
|
|
|
|
"/etc" \
|
|
|
|
"/bin" \
|
|
|
|
"/sbin" \
|
|
|
|
"/lib" \
|
|
|
|
"/lib64" \
|
|
|
|
"/usr" \
|
|
|
|
"/usr/bin" \
|
|
|
|
"/usr/sbin" \
|
|
|
|
"/usr/lib" \
|
|
|
|
"/usr/lib64" \
|
|
|
|
"/boot";
|
|
|
|
do
|
|
|
|
mp=$(readlink -f "$mp")
|
|
|
|
mountpoint "$mp" >/dev/null 2>&1 || continue
|
|
|
|
blockdevs=$(find_zfs_block_devices "$mp")
|
|
|
|
if [ -z "$blockdevs" ] ; then continue ; fi
|
|
|
|
dinfo "zfsexpandknowledge: block devices backing ZFS dataset $mp: $blockdevs"
|
|
|
|
for dev in $blockdevs
|
|
|
|
do
|
|
|
|
array_contains "$dev" "${host_devs[@]}" || host_devs+=("$dev")
|
|
|
|
fstype=$(get_devtype "$dev")
|
|
|
|
host_fs_types["$dev"]="$fstype"
|
|
|
|
majmin=$(get_maj_min "$dev")
|
|
|
|
if [[ -d /sys/dev/block/$majmin/slaves ]] ; then
|
|
|
|
for _slavedev in /sys/dev/block/$majmin/slaves/*; do
|
|
|
|
[[ -f $_slavedev/dev ]] || continue
|
|
|
|
_slavedev=/dev/$(basename "$_slavedev")
|
|
|
|
_slavedevname=$(udevadm info --query=property --name="$_slavedev" | grep "^DEVNAME=" | sed 's|^DEVNAME=||')
|
|
|
|
_slavedevtype=$(get_devtype "$_slavedevname")
|
|
|
|
_slavemajmin=$(get_maj_min "$_slavedevname")
|
|
|
|
dinfo "zfsexpandknowledge: slave block device backing ZFS dataset $mp: $_slavedevname"
|
|
|
|
array_contains "$_slavedevname" "${host_devs[@]}" || host_devs+=("$_slavedevname")
|
|
|
|
host_fs_types["$_slavedevname"]="$_slavedevtype"
|
|
|
|
done
|
|
|
|
fi
|
|
|
|
done
|
|
|
|
done
|
|
|
|
for a in "${host_devs[@]}"
|
|
|
|
do
|
|
|
|
dinfo "zfsexpandknowledge: host device $a"
|
|
|
|
done
|
|
|
|
for a in "${!host_fs_types[@]}"
|
|
|
|
do
|
|
|
|
dinfo "zfsexpandknowledge: device $a of type ${host_fs_types[$a]}"
|
|
|
|
done
|
|
|
|
|
|
|
|
fi
|
|
|
|
|
|
|
|
return 1
|
|
|
|
}
|