Improve systemd-analyze man page and bash completion (#39778)

This updates example output in systemd-analyze's man page after the
tool's output was changed in a previous commit.

Additionally bash completion is added for `systemd-analyze filesystems`
and improved for `systemd-analyze calendar`.

man/systemd-analyze.xml

@@ -464,7 +464,7 @@ $ eog targets.svg</programlisting>
       <title><command>systemd-analyze exit-status <optional><replaceable>STATUS</replaceable>...</optional></command></title>
 
       <para>This command prints a list of exit statuses along with their "class", i.e. the source of the
-      definition (one of <literal>glibc</literal>, <literal>systemd</literal>, <literal>LSB</literal>, or
+      definition (one of <literal>libc</literal>, <literal>systemd</literal>, <literal>LSB</literal>, or
       <literal>BSD</literal>), see the Process Exit Codes section in
       <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
       If no additional arguments are specified, all known statuses are shown. Otherwise, only the
@@ -475,8 +475,8 @@ $ eog targets.svg</programlisting>
 
         <programlisting>$ systemd-analyze exit-status 0 1 {63..65}
 NAME    STATUS CLASS
-SUCCESS 0      glibc
+SUCCESS 0      libc
-FAILURE 1      glibc
+FAILURE 1      libc
 -       63     -
 USAGE   64     BSD
 DATAERR 65     BSD

shell-completion/bash/systemd-analyze

@@ -56,6 +56,15 @@ __get_architectures() {
     systemd-analyze --no-legend --no-pager architectures 2>/dev/null | { while read -r a b; do echo " $a"; done; }
 }
 
+__get_filesystem_sets() {
+    local line
+    systemd-analyze filesystems --no-pager 2>/dev/null | while IFS= read -r line; do
+        if [[ $line == @* ]]; then
+            printf '%s\n' "$line"
+        fi
+    done
+}
+
 _systemd_analyze() {
     local i verb comps mode
     local cur=${COMP_WORDS[COMP_CWORD]} prev=${COMP_WORDS[COMP_CWORD-1]} words cword
@@ -68,7 +77,7 @@ _systemd_analyze() {
     )
 
     local -A VERBS=(
-        [STANDALONE]='time blame unit-files unit-paths exit-status compare-versions calendar timestamp timespan pcrs nvpcrs srk has-tpm2 smbios11 chid image-policy'
+        [STANDALONE]='time blame unit-files unit-paths exit-status compare-versions timestamp timespan pcrs nvpcrs srk has-tpm2 smbios11 chid image-policy'
         [CRITICAL_CHAIN]='critical-chain'
         [DOT]='dot'
         [DUMP]='dump'
@@ -86,6 +95,8 @@ _systemd_analyze() {
         [TRANSIENT_SETTINGS]='transient-settings'
         [UNIT_SHELL]='unit-shell'
         [UNIT_GDB]='unit-gdb'
+        [FILESYSTEMS]='filesystems'
+        [CALENDAR]='calendar'
     )
 
     local CONFIGS='locale.conf systemd/bootchart.conf systemd/coredump.conf systemd/journald.conf
@@ -265,6 +276,18 @@ _systemd_analyze() {
         else
             comps=$( __get_services $mode )
         fi
+
+    elif __contains_word "$verb" ${VERBS[FILESYSTEMS]}; then
+        if [[ $cur = -* ]]; then
+            comps='--help --version --no-pager'
+        else
+            comps=$( __get_filesystem_sets )
+        fi
+
+    elif __contains_word "$verb" ${VERBS[CALENDAR]}; then
+        if [[ $cur = -* ]]; then
+            comps='--help --version --iterations --base-time'
+        fi
     fi
 
     COMPREPLY=( $(compgen -W '$comps' -- "$cur") )

src/basic/user-util.h

@@ -9,8 +9,10 @@
 #include <shadow.h>
 
 #include "basic-forward.h"
+#include "errno-util.h"
 
-/* Users managed by systemd-homed. See https://systemd.io/UIDS-GIDS for details how this range fits into the rest of the world */
+/* Users managed by systemd-homed. See https://systemd.io/UIDS-GIDS for details
+ * how this range fits into the rest of the world. */
 #define HOME_UID_MIN ((uid_t) 60001)
 #define HOME_UID_MAX ((uid_t) 60513)
 
@@ -18,6 +20,19 @@
 #define MAP_UID_MIN ((uid_t) 60514)
 #define MAP_UID_MAX ((uid_t) 60577)
 
+/* A helper to print an error message when user or group resolution fails.
+ * Note that we can't use ({ … }) to define a temporary variable, so errnum is
+ * evaluated multiple times. */
+#define STRERROR_USER(errnum) ((errnum) == -ESRCH ? "Unknown user" : (errnum) == -ENOEXEC ? "Not a system user" : STRERROR(errnum))
+#define STRERROR_GROUP(errnum) ((errnum) == -ESRCH ? "Unknown group" : (errnum) == -ENOEXEC ? "Not a system group" : STRERROR(errnum))
+
+static inline bool ERRNO_IS_NEG_BAD_ACCOUNT(intmax_t r) {
+        return IN_SET(r,
+                      -ESRCH,
+                      -ENOEXEC);
+}
+_DEFINE_ABS_WRAPPER(BAD_ACCOUNT);
+
 bool uid_is_valid(uid_t uid) _const_;
 
 static inline bool gid_is_valid(gid_t gid) {

src/core/exec-invoke.c

@@ -2087,8 +2087,11 @@ static int build_environment(
                 assert(!c->user);
 
                 r = get_fixed_user("root", /* prefer_nss = */ false, &username, NULL, NULL, &home, &shell);
-                if (r < 0)
+                if (r < 0) {
-                        return log_debug_errno(r, "Failed to determine user credentials for root: %m");
+                        log_debug_errno(r, "Failed to determine credentials for user root: %s",
+                                        STRERROR_USER(r));
+                        return ERRNO_IS_NEG_BAD_ACCOUNT(r) ? -EINVAL : r;  /* Suppress confusing errno */
+                }
         }
 
         bool set_user_login_env = exec_context_get_set_login_environment(c);
@@ -5265,7 +5268,9 @@ int exec_invoke(
                                            &username, &uid, &gid, &pwent_home, &shell);
                         if (r < 0) {
                                 *exit_status = EXIT_USER;
-                                return log_error_errno(r, "Failed to determine user credentials: %m");
+                                log_error_errno(r, "Failed to determine credentials for user '%s': %s",
+                                                u, STRERROR_USER(r));
+                                return ERRNO_IS_NEG_BAD_ACCOUNT(r) ? -EINVAL : r;  /* Suppress confusing errno */
                         }
                 }
 
@@ -5273,7 +5278,9 @@ int exec_invoke(
                         r = get_fixed_group(context->group, &groupname, &gid);
                         if (r < 0) {
                                 *exit_status = EXIT_GROUP;
-                                return log_error_errno(r, "Failed to determine group credentials: %m");
+                                log_error_errno(r, "Failed to determine credentials for group '%s': %s",
+                                                u, STRERROR_GROUP(r));
+                                return ERRNO_IS_NEG_BAD_ACCOUNT(r) ? -EINVAL : r;  /* Suppress confusing errno */
                         }
                 }
         }

src/core/scope.c

@@ -348,7 +348,9 @@ static int scope_enter_start_chown(Scope *s) {
 
                         r = get_user_creds(&user, &uid, &gid, NULL, NULL, 0);
                         if (r < 0) {
-                                log_unit_error_errno(UNIT(s), r, "Failed to resolve user \"%s\": %m", user);
+                                log_unit_error_errno(UNIT(s), r,
+                                                     "Failed to resolve user '%s': %s",
+                                                     user, STRERROR_USER(r));
                                 _exit(EXIT_USER);
                         }
                 }
@@ -358,7 +360,9 @@ static int scope_enter_start_chown(Scope *s) {
 
                         r = get_group_creds(&group, &gid, 0);
                         if (r < 0) {
-                                log_unit_error_errno(UNIT(s), r, "Failed to resolve group \"%s\": %m", group);
+                                log_unit_error_errno(UNIT(s), r,
+                                                     "Failed to resolve group '%s': %s",
+                                                     group, STRERROR_GROUP(r));
                                 _exit(EXIT_GROUP);
                         }
                 }

src/core/socket.c

@@ -2056,7 +2056,9 @@ static int socket_chown(Socket *s, PidRef *ret_pid) {
 
                         r = get_user_creds(&user, &uid, &gid, NULL, NULL, 0);
                         if (r < 0) {
-                                log_unit_error_errno(UNIT(s), r, "Failed to resolve user %s: %m", user);
+                                log_unit_error_errno(UNIT(s), r,
+                                                     "Failed to resolve user '%s': %s",
+                                                     user, STRERROR_USER(r));
                                 _exit(EXIT_USER);
                         }
                 }
@@ -2066,7 +2068,9 @@ static int socket_chown(Socket *s, PidRef *ret_pid) {
 
                         r = get_group_creds(&group, &gid, 0);
                         if (r < 0) {
-                                log_unit_error_errno(UNIT(s), r, "Failed to resolve group %s: %m", group);
+                                log_unit_error_errno(UNIT(s), r,
+                                                     "Failed to resolve group '%s': %s",
+                                                     group, STRERROR_GROUP(r));
                                 _exit(EXIT_GROUP);
                         }
                 }

src/creds/creds.c

@@ -1062,7 +1062,8 @@ static int parse_argv(int argc, char *argv[]) {
                                                 /* ret_shell= */ NULL,
                                                 /* flags= */ 0);
                                 if (r < 0)
-                                        return log_error_errno(r, "Failed to resolve user '%s': %m", optarg);
+                                        return log_error_errno(r, "Failed to resolve user '%s': %s",
+                                                               optarg, STRERROR_USER(r));
                         }
                         break;
 

src/login/user-runtime-dir.c

@@ -348,10 +348,8 @@ static int run(int argc, char *argv[]) {
         if (streq(verb, "start")) {
                 _cleanup_(user_record_unrefp) UserRecord *ur = NULL;
                 r = userdb_by_name(user, /* match= */ NULL, USERDB_PARSE_NUMERIC|USERDB_SUPPRESS_SHADOW, &ur);
-                if (r == -ESRCH)
-                        return log_error_errno(r, "User '%s' does not exist: %m", user);
                 if (r < 0)
-                        return log_error_errno(r, "Failed to resolve user '%s': %m", user);
+                        return log_error_errno(r, "Failed to resolve user '%s': %s", user, STRERROR_USER(r));
 
                 /* We do two things here: mount the per-user XDG_RUNTIME_DIR, and set up tmpfs quota on /tmp/
                  * and /dev/shm/. */

src/network/netdev/tuntap.c

@@ -239,10 +239,9 @@ static int tuntap_verify(NetDev *netdev, const char *filename) {
                 r = userdb_by_name(t->user_name, &USERDB_MATCH_ROOT_AND_SYSTEM,
                                    USERDB_SUPPRESS_SHADOW | USERDB_PARSE_NUMERIC,
                                    &ur);
-                if (r == -ENOEXEC)
+                if (r < 0)
-                        log_netdev_warning_errno(netdev, r, "User %s is not a system user, ignoring.", t->user_name);
+                        log_netdev_warning_errno(netdev, r, "Cannot resolve user name '%s', ignoring: %s",
-                else if (r < 0)
+                                                 t->user_name, STRERROR_USER(r));
-                        log_netdev_warning_errno(netdev, r, "Cannot resolve user name %s, ignoring: %m", t->user_name);
                 else
                         t->uid = ur->uid;
         }
@@ -253,10 +252,9 @@ static int tuntap_verify(NetDev *netdev, const char *filename) {
                 r = groupdb_by_name(t->group_name, &USERDB_MATCH_ROOT_AND_SYSTEM,
                                     USERDB_SUPPRESS_SHADOW | USERDB_PARSE_NUMERIC,
                                     &gr);
-                if (r == -ENOEXEC)
+                if (r < 0)
-                        log_netdev_warning_errno(netdev, r, "Group %s is not a system group, ignoring.", t->group_name);
+                        log_netdev_warning_errno(netdev, r, "Cannot resolve group name '%s', ignoring: %s",
-                else if (r < 0)
+                                                 t->group_name, STRERROR_GROUP(r));
-                        log_netdev_warning_errno(netdev, r, "Cannot resolve group name %s, ignoring: %m", t->group_name);
                 else
                         t->gid = gr->gid;
         }

src/run/run.c

@@ -2748,7 +2748,8 @@ static int start_transient_scope(sd_bus *bus) {
 
                 r = get_group_creds(&arg_exec_group, &gid, 0);
                 if (r < 0)
-                        return log_error_errno(r, "Failed to resolve group %s: %m", arg_exec_group);
+                        return log_error_errno(r, "Failed to resolve group '%s': %s",
+                                               arg_exec_group, STRERROR_GROUP(r));
 
                 if (setresgid(gid, gid, gid) < 0)
                         return log_error_errno(errno, "Failed to change GID to " GID_FMT ": %m", gid);
@@ -2762,7 +2763,8 @@ static int start_transient_scope(sd_bus *bus) {
                 r = get_user_creds(&arg_exec_user, &uid, &gid, &home, &shell,
                                    USER_CREDS_CLEAN|USER_CREDS_SUPPRESS_PLACEHOLDER|USER_CREDS_PREFER_NSS);
                 if (r < 0)
-                        return log_error_errno(r, "Failed to resolve user %s: %m", arg_exec_user);
+                        return log_error_errno(r, "Failed to resolve user '%s': %s",
+                                               arg_exec_user, STRERROR_USER(r));
 
                 if (home) {
                         r = strv_extendf(&user_env, "HOME=%s", home);

src/shared/machine-bind-user.c

@@ -244,8 +244,10 @@ int machine_bind_user_prepare(
                 _cleanup_(group_record_unrefp) GroupRecord *g = NULL, *cg = NULL;
 
                 r = userdb_by_name(*n, /* match= */ NULL, USERDB_DONT_SYNTHESIZE_INTRINSIC|USERDB_DONT_SYNTHESIZE_FOREIGN, &u);
+                if (r == -ENOEXEC)
+                        return log_error_errno(r, "User '%s' did not pass filter.", *n);
                 if (r < 0)
-                        return log_error_errno(r, "Failed to resolve user '%s': %m", *n);
+                        return log_error_errno(r, "Failed to resolve user '%s': %s", *n, STRERROR_USER(r));
 
                 /* For now, let's refuse mapping the root/nobody users explicitly. The records we generate
                  * are strictly additive, nss-systemd is typically placed last in /etc/nsswitch.conf. Thus
@@ -266,8 +268,11 @@ int machine_bind_user_prepare(
                         return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "Cannot bind user with no UID, refusing.");
 
                 r = groupdb_by_gid(user_record_gid(u), /* match= */ NULL, USERDB_DONT_SYNTHESIZE_INTRINSIC|USERDB_DONT_SYNTHESIZE_FOREIGN, &g);
+                if (r == -ENOEXEC)
+                        return log_error_errno(r, "Group of user '%s' did not pass filter.", u->user_name);
                 if (r < 0)
-                        return log_error_errno(r, "Failed to resolve group of user '%s': %m", u->user_name);
+                        return log_error_errno(r, "Failed to resolve group of user '%s': %s",
+                                               u->user_name, STRERROR_GROUP(r));
 
                 /* We want to synthesize exactly one user + group from the host into the machine. This only
                  * makes sense if the user on the host has its own private group. We can't reasonably check

src/shared/userdb.c

@@ -932,7 +932,7 @@ int userdb_by_name(const char *name, const UserDBMatch *match, UserDBFlags flags
         r = userdb_start_query(iterator, "io.systemd.UserDatabase.GetUserRecord", /* more= */ false, query, flags);
         if (r >= 0) {
                 r = userdb_process(iterator, &ur, /* ret_group_record= */ NULL, /* ret_user_name= */ NULL, /* ret_group_name= */ NULL);
-                if (r == -ENOEXEC) /* found a user matching UID or name, but not filter. In this case the
+                if (r == -ENOEXEC) /* Found a user matching UID or name, but not filter. In this case the
                                     * fallback paths below are pointless */
                         return r;
         }

src/tmpfiles/tmpfiles.c

@@ -3992,7 +3992,8 @@ static int parse_line(
                         missing_user_or_group = true;
                 } else if (r < 0) {
                         *invalid_config = true;
-                        return log_syntax(NULL, LOG_ERR, fname, line, r, "Failed to resolve user '%s': %m", u);
+                        return log_syntax(NULL, LOG_ERR, fname, line, r,
+                                          "Failed to resolve user '%s': %s", u, STRERROR_USER(r));
                 } else
                         i.uid_set = true;
         }
@@ -4013,7 +4014,8 @@ static int parse_line(
                         missing_user_or_group = true;
                 } else if (r < 0) {
                         *invalid_config = true;
-                        return log_syntax(NULL, LOG_ERR, fname, line, r, "Failed to resolve group '%s': %m", g);
+                        return log_syntax(NULL, LOG_ERR, fname, line, r,
+                                          "Failed to resolve group '%s': %s", g, STRERROR_GROUP(r));
                 } else
                         i.gid_set = true;
         }

src/udev/udev-rules.c

@@ -512,12 +512,10 @@ static int rule_resolve_user(UdevRuleLine *rule_line, const char *name, uid_t *r
         r = userdb_by_name(name, &USERDB_MATCH_ROOT_AND_SYSTEM,
                            USERDB_SUPPRESS_SHADOW | USERDB_PARSE_NUMERIC | USERDB_SYNTHESIZE_NUMERIC,
                            &ur);
-        if (r == -ESRCH)
-                return log_line_error_errno(rule_line, r, "Unknown user '%s', ignoring.", name);
-        if (r == -ENOEXEC)
-                return log_line_error_errno(rule_line, r, "User '%s' is not a system user, ignoring.", name);
         if (r < 0)
-                return log_line_error_errno(rule_line, r, "Failed to resolve user '%s', ignoring: %m", name);
+                return log_line_error_errno(rule_line, r,
+                                            "Failed to resolve user '%s', ignoring: %s",
+                                            name, STRERROR_USER(r));
 
         _cleanup_free_ char *n = strdup(name);
         if (!n)
@@ -549,12 +547,10 @@ static int rule_resolve_group(UdevRuleLine *rule_line, const char *name, gid_t *
         r = groupdb_by_name(name, &USERDB_MATCH_ROOT_AND_SYSTEM,
                             USERDB_SUPPRESS_SHADOW | USERDB_PARSE_NUMERIC | USERDB_SYNTHESIZE_NUMERIC,
                             &gr);
-        if (r == -ESRCH)
-                return log_line_error_errno(rule_line, r, "Unknown group '%s', ignoring.", name);
-        if (r == -ENOEXEC)
-                return log_line_error_errno(rule_line, r, "Group '%s' is not a system group, ignoring.", name);
         if (r < 0)
-                return log_line_error_errno(rule_line, r, "Failed to resolve group '%s', ignoring: %m", name);
+                return log_line_error_errno(rule_line, r,
+                                            "Failed to resolve group '%s', ignoring: %s",
+                                            name, STRERROR_GROUP(r));
 
         _cleanup_free_ char *n = strdup(name);
         if (!n)
@@ -2681,12 +2677,10 @@ static int udev_rule_apply_token_to_event(
                 r = userdb_by_name(owner, &USERDB_MATCH_ROOT_AND_SYSTEM,
                                    USERDB_SUPPRESS_SHADOW | USERDB_PARSE_NUMERIC | USERDB_SYNTHESIZE_NUMERIC,
                                    &ur);
-                if (r == -ESRCH)
+                if (r < 0)
-                        log_event_error_errno(event, token, r, "Unknown user \"%s\", ignoring.", owner);
+                        log_event_error_errno(event, token, r,
-                else if (r == -ENOEXEC)
+                                              "Failed to resolve user \"%s\", ignoring: %s",
-                        log_event_error(event, token, "User \"%s\" is not a system user, ignoring.", owner);
+                                              owner, STRERROR_USER(r));
-                else if (r < 0)
-                        log_event_error_errno(event, token, r, "Failed to resolve user \"%s\", ignoring: %m", owner);
                 else {
                         event->uid = ur->uid;
                         log_event_debug(event, token, "Set owner: %s("UID_FMT")", owner, event->uid);
@@ -2709,12 +2703,10 @@ static int udev_rule_apply_token_to_event(
                 r = groupdb_by_name(group, &USERDB_MATCH_ROOT_AND_SYSTEM,
                                     USERDB_SUPPRESS_SHADOW | USERDB_PARSE_NUMERIC | USERDB_SYNTHESIZE_NUMERIC,
                                     &gr);
-                if (r == -ESRCH)
+                if (r < 0)
-                        log_event_error_errno(event, token, r, "Unknown group \"%s\", ignoring.", group);
+                        log_event_error_errno(event, token, r,
-                else if (r == -ENOEXEC)
+                                              "Failed to resolve group \"%s\", ignoring: %s",
-                        log_event_error(event, token, "Group \"%s\" is not a system group, ignoring.", group);
+                                              group, STRERROR_GROUP(r));
-                else if (r < 0)
-                        log_event_error_errno(event, token, r, "Failed to resolve group \"%s\", ignoring: %m", group);
                 else {
                         event->gid = gr->gid;
                         log_event_debug(event, token, "Set group: %s("GID_FMT")", group, event->gid);

test/units/TEST-17-UDEV.verify.sh

@@ -309,15 +309,15 @@ assert_0 "${rules}"
 test_syntax_error 'OWNER=":nosuchuser:"' "Failed to resolve user ':nosuchuser:', ignoring: Invalid argument"
 # nonexistent user
 if ! getent passwd nosuchuser >/dev/null; then
-    test_syntax_error 'OWNER="nosuchuser"' "Unknown user 'nosuchuser', ignoring."
+    test_syntax_error 'OWNER="nosuchuser"' "Failed to resolve user 'nosuchuser', ignoring: Unknown user"
 fi
 if ! getent passwd 12345 >/dev/null; then
-    test_syntax_error 'OWNER="12345"' "Unknown user '12345', ignoring."
+    test_syntax_error 'OWNER="12345"' "Failed to resolve user '12345', ignoring: Unknown user"
 fi
 # regular user
 if getent passwd testuser >/dev/null; then
-    test_syntax_error 'OWNER="testuser"' "User 'testuser' is not a system user, ignoring."
+    test_syntax_error 'OWNER="testuser"' "Failed to resolve user 'testuser', ignoring: Not a system user"
-    test_syntax_error "OWNER=\"$(id -u testuser)\"" "User '$(id -u testuser)' is not a system user, ignoring."
+    test_syntax_error "OWNER=\"$(id -u testuser)\"" "Failed to resolve user '$(id -u testuser)', ignoring: Not a system user"
 fi
 test_syntax_error 'GROUP{a}="b"' 'Invalid attribute for GROUP.'
 test_syntax_error 'GROUP-="b"' 'Invalid operator for GROUP.'
@@ -341,15 +341,15 @@ assert_0 "${rules}"
 test_syntax_error 'GROUP=":nosuchgroup:"' "Failed to resolve group ':nosuchgroup:', ignoring: Invalid argument"
 # nonexistent group
 if ! getent group nosuchgroup >/dev/null; then
-    test_syntax_error 'GROUP="nosuchgroup"' "Unknown group 'nosuchgroup', ignoring."
+    test_syntax_error 'GROUP="nosuchgroup"' "Failed to resolve group 'nosuchgroup', ignoring: Unknown group"
 fi
 if ! getent group 12345 >/dev/null; then
-    test_syntax_error 'GROUP="12345"' "Unknown group '12345', ignoring."
+    test_syntax_error 'GROUP="12345"' "Failed to resolve group '12345', ignoring: Unknown group"
 fi
 # regular group
 if getent group testuser >/dev/null; then
-    test_syntax_error 'GROUP="testuser"' "Group 'testuser' is not a system group, ignoring."
+    test_syntax_error 'GROUP="testuser"' "Failed to resolve group 'testuser', ignoring: Not a system group"
-    test_syntax_error "GROUP=\"$(id -g testuser)\"" "Group '$(id -g testuser)' is not a system group, ignoring."
+    test_syntax_error "GROUP=\"$(id -g testuser)\"" "Failed to resolve group '$(id -g testuser)', ignoring: Not a system group"
 fi
 test_syntax_error 'MODE{a}="b"' 'Invalid attribute for MODE.'
 test_syntax_error 'MODE-="b"' 'Invalid operator for MODE.'