2013-04-24 14:44:44 +00:00
|
|
|
# systemd-analyze(1) completion -*- shell-script -*-
|
2020-11-09 04:23:58 +00:00
|
|
|
# SPDX-License-Identifier: LGPL-2.1-or-later
|
2013-04-24 14:44:44 +00:00
|
|
|
#
|
|
|
|
# This file is part of systemd.
|
|
|
|
#
|
2018-06-12 17:00:24 +00:00
|
|
|
# Copyright © 2010 Ran Benita
|
2013-04-24 14:44:44 +00:00
|
|
|
#
|
|
|
|
# systemd is free software; you can redistribute it and/or modify it
|
|
|
|
# under the terms of the GNU Lesser General Public License as published by
|
|
|
|
# the Free Software Foundation; either version 2.1 of the License, or
|
|
|
|
# (at your option) any later version.
|
|
|
|
#
|
|
|
|
# systemd is distributed in the hope that it will be useful, but
|
|
|
|
# WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
|
# General Public License for more details.
|
|
|
|
#
|
|
|
|
# You should have received a copy of the GNU Lesser General Public License
|
|
|
|
# along with systemd; If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
|
|
|
__contains_word () {
|
2019-04-05 09:39:14 +00:00
|
|
|
local w word=$1; shift
|
|
|
|
for w in "$@"; do
|
|
|
|
[[ $w = "$word" ]] && return
|
|
|
|
done
|
2013-04-24 14:44:44 +00:00
|
|
|
}
|
|
|
|
|
2014-03-03 21:01:42 +00:00
|
|
|
__get_machines() {
|
2019-04-05 09:39:14 +00:00
|
|
|
local a b
|
2020-01-10 03:29:02 +00:00
|
|
|
machinectl list --full --no-legend --no-pager | { while read a b; do echo " $a"; done; };
|
2014-03-03 21:01:42 +00:00
|
|
|
}
|
|
|
|
|
2018-12-06 17:51:56 +00:00
|
|
|
__get_services() {
|
2020-04-17 09:40:03 +00:00
|
|
|
systemctl list-units --no-legend --no-pager --plain -t service --all $1 | \
|
2019-04-05 09:39:14 +00:00
|
|
|
{ while read -r a b c; do [[ $b == "loaded" ]]; echo " $a"; done }
|
2018-12-06 17:51:56 +00:00
|
|
|
}
|
|
|
|
|
2018-09-30 20:27:27 +00:00
|
|
|
__get_syscall_sets() {
|
2019-04-05 09:39:14 +00:00
|
|
|
local line
|
|
|
|
systemd-analyze syscall-filter --no-pager | while IFS= read -r line; do
|
|
|
|
if [[ $line == @* ]]; then
|
|
|
|
printf '%s\n' "$line"
|
|
|
|
fi
|
|
|
|
done
|
2018-09-30 20:27:27 +00:00
|
|
|
}
|
|
|
|
|
2013-04-24 14:44:44 +00:00
|
|
|
_systemd_analyze() {
|
2019-04-05 09:39:14 +00:00
|
|
|
local i verb comps mode
|
2021-04-03 03:33:59 +00:00
|
|
|
local cur=${COMP_WORDS[COMP_CWORD]} prev=${COMP_WORDS[COMP_CWORD-1]} words cword
|
2014-03-03 21:01:42 +00:00
|
|
|
|
2019-04-05 09:39:14 +00:00
|
|
|
local -A OPTS=(
|
|
|
|
[STANDALONE]='-h --help --version --system --user --global --order --require --no-pager
|
2021-11-16 11:19:42 +00:00
|
|
|
--man=no --generators=yes --quiet'
|
2019-04-05 09:39:14 +00:00
|
|
|
[ARG]='-H --host -M --machine --fuzz --from-pattern --to-pattern --root'
|
|
|
|
)
|
|
|
|
|
|
|
|
local -A VERBS=(
|
2021-08-23 15:44:58 +00:00
|
|
|
[STANDALONE]='time blame plot dump unit-paths exit-status calendar timestamp timespan'
|
2019-04-05 09:39:14 +00:00
|
|
|
[CRITICAL_CHAIN]='critical-chain'
|
|
|
|
[DOT]='dot'
|
|
|
|
[VERIFY]='verify'
|
|
|
|
[SECCOMP_FILTER]='syscall-filter'
|
|
|
|
[CAT_CONFIG]='cat-config'
|
|
|
|
[SECURITY]='security'
|
2021-08-23 15:44:58 +00:00
|
|
|
[CONDITION]='condition'
|
2019-04-05 09:39:14 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
local CONFIGS='systemd/bootchart.conf systemd/coredump.conf systemd/journald.conf
|
2018-05-10 19:11:56 +00:00
|
|
|
systemd/journal-remote.conf systemd/journal-upload.conf systemd/logind.conf
|
|
|
|
systemd/resolved.conf systemd/networkd.conf systemd/resolved.conf
|
|
|
|
systemd/sleep.conf systemd/system.conf systemd/timedated.conf
|
|
|
|
systemd/timesyncd.conf systemd/user.conf udev/udev.conf'
|
|
|
|
|
2019-04-05 09:39:14 +00:00
|
|
|
_init_completion || return
|
|
|
|
|
|
|
|
for ((i=0; i < COMP_CWORD; i++)); do
|
|
|
|
if __contains_word "${COMP_WORDS[i]}" ${VERBS[*]} &&
|
|
|
|
! __contains_word "${COMP_WORDS[i-1]}" ${OPTS[ARG]}; then
|
|
|
|
verb=${COMP_WORDS[i]}
|
|
|
|
break
|
2014-03-03 21:01:42 +00:00
|
|
|
fi
|
2019-04-05 09:39:14 +00:00
|
|
|
done
|
|
|
|
|
|
|
|
if __contains_word "$prev" ${OPTS[ARG]}; then
|
|
|
|
case $prev in
|
|
|
|
--host|-H)
|
|
|
|
comps=$(compgen -A hostname)
|
|
|
|
;;
|
|
|
|
--machine|-M)
|
|
|
|
comps=$( __get_machines )
|
|
|
|
;;
|
|
|
|
esac
|
|
|
|
COMPREPLY=( $(compgen -W '$comps' -- "$cur") )
|
|
|
|
return 0
|
|
|
|
fi
|
|
|
|
|
2021-06-22 13:56:19 +00:00
|
|
|
if [[ -z ${verb-} && $cur = -* ]]; then
|
2019-04-05 09:39:14 +00:00
|
|
|
COMPREPLY=( $(compgen -W '${OPTS[*]}' -- "$cur") )
|
|
|
|
return 0
|
|
|
|
fi
|
|
|
|
|
2021-06-22 13:56:19 +00:00
|
|
|
if [[ -z ${verb-} ]]; then
|
2019-04-05 09:39:14 +00:00
|
|
|
comps=${VERBS[*]}
|
2014-03-03 21:01:42 +00:00
|
|
|
|
2019-04-05 09:39:14 +00:00
|
|
|
elif __contains_word "$verb" ${VERBS[STANDALONE]}; then
|
|
|
|
if [[ $cur = -* ]]; then
|
|
|
|
comps='--help --version --system --user --global --no-pager'
|
2013-04-24 14:44:44 +00:00
|
|
|
fi
|
|
|
|
|
2019-04-05 09:39:14 +00:00
|
|
|
elif __contains_word "$verb" ${VERBS[CRITICAL_CHAIN]}; then
|
|
|
|
if [[ $cur = -* ]]; then
|
|
|
|
comps='--help --version --system --user --fuzz --no-pager'
|
2013-04-24 14:44:44 +00:00
|
|
|
fi
|
|
|
|
|
2019-04-05 09:39:14 +00:00
|
|
|
elif __contains_word "$verb" ${VERBS[DOT]}; then
|
|
|
|
if [[ $cur = -* ]]; then
|
|
|
|
comps='--help --version --system --user --global --from-pattern --to-pattern --order --require'
|
|
|
|
fi
|
|
|
|
|
|
|
|
elif __contains_word "$verb" ${VERBS[SECCOMP_FILTER]}; then
|
|
|
|
if [[ $cur = -* ]]; then
|
|
|
|
comps='--help --version --no-pager'
|
|
|
|
else
|
|
|
|
comps=$( __get_syscall_sets )
|
|
|
|
fi
|
|
|
|
|
|
|
|
elif __contains_word "$verb" ${VERBS[VERIFY]}; then
|
|
|
|
if [[ $cur = -* ]]; then
|
systemd-analyze: option to exit with an error when 'verify' fails
The commit introduces a callback invoked from log_syntax_internal.
Use it from systemd-analyze to gather a list of units that contain
syntax warnings. A new command line option is added to make use of this.
The new option --recursive-errors takes in three possible modes:
1. yes - which is the default. systemd-analyze exits with an error when syntax warnings arise during verification of the
specified units or any of their dependencies.
3. no - systemd-analyze exits with an error when syntax warnings arise during verification of only the selected unit.
Analyzing and loading any dependencies will be skipped.
4. one - systemd-analyze exits with an error when syntax warnings arise during verification
of only the selected units and their direct dependencies.
Below are two service unit files that I created for the purposes of testing:
1. First, we run the commands on a unit that does not have dependencies but has a non-existing key-value setting (i.e. foo = bar).
> cat <<EOF>testcase.service
[Unit]
foo = bar
[Service]
ExecStart = echo hello
EOF
OUTPUT:
maanya-goenka@debian:~/systemd (log-error)$ sudo build/systemd-analyze verify testcase.service
/home/maanya-goenka/systemd/testcase.service:2: Unknown key name 'foo' in section 'Unit', ignoring.
/usr/lib/systemd/system/plymouth-start.service:15: Unit configured to use KillMode=none. This is unsafe, as it disables systemd's process lifecycle management for the service. Please update your service to use a safer KillMode=, such as 'mixed' or 'control-group'. Support for KillMode=none is deprecated and will eventually be removed.
/usr/lib/systemd/system/dbus.socket:5: ListenStream= references a path below legacy directory /var/run/, updating /var/run/dbus/system_bus_socket → /run/dbus/system_bus_socket; please update the unit file accordingly.
/usr/lib/systemd/system/gdm.service:30: Standard output type syslog is obsolete, automatically updating to journal. Please update your unit file, and consider removing the setting altogether.
maanya-goenka@debian:~/systemd (log-error)$ echo $?
1
maanya-goenka@debian:~/systemd (log-error)$ sudo build/systemd-analyze verify --recursive-errors=yes testcase.service
/home/maanya-goenka/systemd/testcase.service:2: Unknown key name 'foo' in section 'Unit', ignoring.
/usr/lib/systemd/system/plymouth-start.service:15: Unit configured to use KillMode=none. This is unsafe, as it disables systemd's process lifecycle management for the service. Please update your service to use a safer KillMode=, such as 'mixed' or 'control-group'. Support for KillMode=none is deprecated and will eventually be removed.
/usr/lib/systemd/system/dbus.socket:5: ListenStream= references a path below legacy directory /var/run/, updating /var/run/dbus/system_bus_socket → /run/dbus/system_bus_socket; please update the unit file accordingly.
/usr/lib/systemd/system/gdm.service:30: Standard output type syslog is obsolete, automatically updating to journal. Please update your unit file, and consider removing the setting altogether.
maanya-goenka@debian:~/systemd (log-error)$ echo $?
1
maanya-goenka@debian:~/systemd (log-error)$ sudo build/systemd-analyze verify --recursive-errors=no testcase.service
/home/maanya-goenka/systemd/testcase.service:2: Unknown key name 'foo' in section 'Unit', ignoring.
maanya-goenka@debian:~/systemd (log-error)$ echo $?
1
maanya-goenka@debian:~/systemd (log-error)$ sudo build/systemd-analyze verify --recursive-errors=one testcase.service
/home/maanya-goenka/systemd/testcase.service:2: Unknown key name 'foo' in section 'Unit', ignoring.
/usr/lib/systemd/system/plymouth-start.service:15: Unit configured to use KillMode=none. This is unsafe, as it disables systemd's process lifecycle management for the service. Please update your service to use a safer KillMode=, such as 'mixed' or 'control-group'. Support for KillMode=none is deprecated and will eventually be removed.
/usr/lib/systemd/system/dbus.socket:5: ListenStream= references a path below legacy directory /var/run/, updating /var/run/dbus/system_bus_socket → /run/dbus/system_bus_socket; please update the unit file accordingly.
/usr/lib/systemd/system/gdm.service:30: Standard output type syslog is obsolete, automatically updating to journal. Please update your unit file, and consider removing the setting altogether.
maanya-goenka@debian:~/systemd (log-error)$ echo $?
1
2. Next, we run the commands on a unit that is syntactically valid but has a non-existing dependency (i.e. foo2.service)
> cat <<EOF>foobar.service
[Unit]
Requires = foo2.service
[Service]
ExecStart = echo hello
EOF
OUTPUT:
maanya-goenka@debian:~/systemd (log-error)$ sudo build/systemd-analyze verify foobar.service
/usr/lib/systemd/system/plymouth-start.service:15: Unit configured to use KillMode=none. This is unsafe, as it disables systemd's process lifecycle management for the service. Please update your service to use a safer KillMode=, such as 'mixed' or 'control-group'. Support for KillMode=none is deprecated and will eventually be removed.
/usr/lib/systemd/system/dbus.socket:5: ListenStream= references a path below legacy directory /var/run/, updating /var/run/dbus/system_bus_socket → /run/dbus/system_bus_socket; please update the unit file accordingly.
/usr/lib/systemd/system/gdm.service:30: Standard output type syslog is obsolete, automatically updating to journal. Please update your unit file, and consider removing the setting altogether.
foobar.service: Failed to create foobar.service/start: Unit foo2.service not found.
maanya-goenka@debian:~/systemd (log-error)$ echo $?
1
maanya-goenka@debian:~/systemd (log-error)$ sudo build/systemd-analyze verify --recursive-errors=yes foobar.service
/usr/lib/systemd/system/plymouth-start.service:15: Unit configured to use KillMode=none. This is unsafe, as it disables systemd's process lifecycle management for the service. Please update your service to use a safer KillMode=, such as 'mixed' or 'control-group'. Support for KillMode=none is deprecated and will eventually be removed.
/usr/lib/systemd/system/dbus.socket:5: ListenStream= references a path below legacy directory /var/run/, updating /var/run/dbus/system_bus_socket → /run/dbus/system_bus_socket; please update the unit file accordingly.
/usr/lib/systemd/system/gdm.service:30: Standard output type syslog is obsolete, automatically updating to journal. Please update your unit file, and consider removing the setting altogether.
foobar.service: Failed to create foobar.service/start: Unit foo2.service not found.
maanya-goenka@debian:~/systemd (log-error)$ echo $?
1
maanya-goenka@debian:~/systemd (log-error)$ sudo build/systemd-analyze verify --recursive-errors=no foobar.service
maanya-goenka@debian:~/systemd (log-error)$ echo $?
0
maanya-goenka@debian:~/systemd (log-error)$ sudo build/systemd-analyze verify --recursive-errors=one foobar.service
/usr/lib/systemd/system/plymouth-start.service:15: Unit configured to use KillMode=none. This is unsafe, as it disables systemd's process lifecycle management for the service. Please update your service to use a safer KillMode=, such as 'mixed' or 'control-group'. Support for KillMode=none is deprecated and will eventually be removed.
/usr/lib/systemd/system/dbus.socket:5: ListenStream= references a path below legacy directory /var/run/, updating /var/run/dbus/system_bus_socket → /run/dbus/system_bus_socket; please update the unit file accordingly.
/usr/lib/systemd/system/gdm.service:30: Standard output type syslog is obsolete, automatically updating to journal. Please update your unit file, and consider removing the setting altogether.
foobar.service: Failed to create foobar.service/start: Unit foo2.service not found.
maanya-goenka@debian:~/systemd (log-error)$ echo $?
1
2021-07-26 20:02:17 +00:00
|
|
|
comps='--help --version --system --user --global --man=no --generators=yes --root --image --recursive-errors=no --recursive-errors=yes --recursive-errors=one'
|
2019-04-05 09:39:14 +00:00
|
|
|
else
|
|
|
|
comps=$( compgen -A file -- "$cur" )
|
|
|
|
compopt -o filenames
|
|
|
|
fi
|
|
|
|
|
|
|
|
elif __contains_word "$verb" ${VERBS[CAT_CONFIG]}; then
|
|
|
|
if [[ $cur = -* ]]; then
|
|
|
|
comps='--help --version --root --no-pager'
|
|
|
|
elif [[ -z $cur ]]; then
|
|
|
|
comps="$CONFIGS"
|
|
|
|
compopt -o filenames
|
|
|
|
else
|
|
|
|
comps="$CONFIGS $( compgen -A file -- "$cur" )"
|
|
|
|
compopt -o filenames
|
|
|
|
fi
|
|
|
|
|
|
|
|
elif __contains_word "$verb" ${VERBS[SECURITY]}; then
|
|
|
|
if [[ $cur = -* ]]; then
|
2021-11-26 18:07:37 +00:00
|
|
|
comps='--help --version --no-pager --system --user -H --host -M --machine --offline --threshold --security-policy --json=off --json=pretty --json=short --root --image'
|
|
|
|
elif ! __contains_word "--offline" ${COMP_WORDS[*]}; then
|
2019-04-05 09:39:14 +00:00
|
|
|
if __contains_word "--user" ${COMP_WORDS[*]}; then
|
|
|
|
mode=--user
|
|
|
|
else
|
|
|
|
mode=--system
|
|
|
|
fi
|
|
|
|
comps=$( __get_services $mode )
|
2021-11-26 18:07:37 +00:00
|
|
|
else
|
|
|
|
comps="$CONFIGS $( compgen -A file -- "$cur" )"
|
|
|
|
compopt -o filenames
|
2019-04-05 09:39:14 +00:00
|
|
|
fi
|
2021-08-23 15:44:58 +00:00
|
|
|
|
|
|
|
elif __contains_word "$verb" ${VERBS[CONDITION]}; then
|
|
|
|
if [[ $cur = -* ]]; then
|
|
|
|
comps='--help --version --system --user --global --no-pager --root --image'
|
|
|
|
elif [[ $prev = "-u" ]] || [[ $prev = "--unit" ]]; then
|
|
|
|
if __contains_word "--user" ${COMP_WORDS[*]}; then
|
|
|
|
mode=--user
|
|
|
|
else
|
|
|
|
mode=--system
|
|
|
|
fi
|
|
|
|
comps=$( __get_services $mode )
|
|
|
|
fi
|
2019-04-05 09:39:14 +00:00
|
|
|
fi
|
|
|
|
|
|
|
|
COMPREPLY=( $(compgen -W '$comps' -- "$cur") )
|
|
|
|
return 0
|
2013-04-24 14:44:44 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
complete -F _systemd_analyze systemd-analyze
|