From 46a3adeef38e8425108988940db1944fb114c19c Mon Sep 17 00:00:00 2001 From: Yu Watanabe Date: Wed, 25 Nov 2020 14:38:50 +0900 Subject: [PATCH 1/3] man: add missing specifiers supported in [INSTALL] section --- man/systemd.unit.xml | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml index 52db36be71..c848146f3a 100644 --- a/man/systemd.unit.xml +++ b/man/systemd.unit.xml @@ -1734,10 +1734,9 @@ - The following specifiers are interpreted in the Install - section: %n, %N, %p, %i, %j, %g, %G, %U, %u, %m, %H, %b, %v. For their - meaning see the next section. - + The following specifiers are interpreted in the Install section: + %a, %b, %B, %g, %G, %H, %i, %j, %l, %m, %n, %N, %o, %p, %u, %U, %v, %w, %W, %%. + For their meaning see the next section. From 55318801ba786199d2cbeb368054d1324926657a Mon Sep 17 00:00:00 2001 From: Yu Watanabe Date: Wed, 25 Nov 2020 14:39:10 +0900 Subject: [PATCH 2/3] man: sort specifiers alphabetically --- man/systemd.unit.xml | 32 ++++++++++++++++---------------- man/tmpfiles.d.xml | 20 ++++++++++---------- 2 files changed, 26 insertions(+), 26 deletions(-) diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml index c848146f3a..5364c4c975 100644 --- a/man/systemd.unit.xml +++ b/man/systemd.unit.xml @@ -1786,6 +1786,16 @@ Unescaped filename This is either the unescaped instance name (if applicable) with / prepended (if applicable), or the unescaped prefix name prepended with /. This implements unescaping according to the rules for escaping absolute file system paths discussed above. + + %g + User group + This is the name of the group running the service manager instance. In case of the system manager this resolves to root. + + + %G + User GID + This is the numeric GID of the user running the service manager instance. In case of the system manager this resolves to 0. + %h User home directory @@ -1800,11 +1810,6 @@ Note that this setting is not influenced by the Us Host name The hostname of the running system at the point in time the unit configuration is loaded. - - %l - Short host name - The hostname of the running system at the point in time the unit configuration is loaded, truncated at the first dot to remove any domain component. - %i Instance name @@ -1825,13 +1830,17 @@ Note that this setting is not influenced by the Us Unescaped final component of the prefix Same as %j, but with escaping undone. + + %l + Short host name + The hostname of the running system at the point in time the unit configuration is loaded, truncated at the first dot to remove any domain component. + %L Log directory root This is either /var/log (for the system manager) or the path $XDG_CONFIG_HOME resolves to with /log appended (for user managers). - %n Full unit name @@ -1842,6 +1851,7 @@ Note that this setting is not influenced by the Us Full unit name Same as %n, but with the type suffix removed. + %p Prefix name @@ -1868,16 +1878,6 @@ Note that this setting is not influenced by the Us This is either /run/ (for the system manager) or the path $XDG_RUNTIME_DIR resolves to (for user managers). - - %g - User group - This is the name of the group running the service manager instance. In case of the system manager this resolves to root. - - - %G - User GID - This is the numeric GID of the user running the service manager instance. In case of the system manager this resolves to 0. - %u User name diff --git a/man/tmpfiles.d.xml b/man/tmpfiles.d.xml index 5f69054847..49ce8375a4 100644 --- a/man/tmpfiles.d.xml +++ b/man/tmpfiles.d.xml @@ -639,6 +639,16 @@ w- /proc/sys/vm/swappiness - - - - 10 System or user cache directory In mode, this is the same as $XDG_CACHE_HOME, and /var/cache otherwise. + + %g + User group + This is the name of the group running the command. In case of the system instance this resolves to root. + + + %G + User GID + This is the numeric GID of the group running the command. In case of the system instance this resolves to 0. + %h User home directory @@ -664,16 +674,6 @@ w- /proc/sys/vm/swappiness - - - - 10 In mode, this is the same $XDG_RUNTIME_DIR, and /run/ otherwise. - - %g - User group - This is the name of the group running the command. In case of the system instance this resolves to root. - - - %G - User GID - This is the numeric GID of the group running the command. In case of the system instance this resolves to 0. - %u User name From e93387f38b7782afb41b6b6256e6a0f635662e75 Mon Sep 17 00:00:00 2001 From: Yu Watanabe Date: Wed, 25 Nov 2020 15:09:17 +0900 Subject: [PATCH 3/3] tree-wide: sort specifiers and move common comments to specifier.h --- src/core/unit-printf.c | 59 ++++++++++++++---------------------- src/resolve/resolved-conf.c | 12 ++++---- src/resolve/resolved-dnssd.c | 12 ++++---- src/shared/install-printf.c | 24 +++------------ src/shared/specifier.h | 38 ++++++++++++++++++----- src/tmpfiles/tmpfiles.c | 16 +++++----- 6 files changed, 80 insertions(+), 81 deletions(-) diff --git a/src/core/unit-printf.c b/src/core/unit-printf.c index ba3e6456b7..0c1e20d9ce 100644 --- a/src/core/unit-printf.c +++ b/src/core/unit-printf.c @@ -177,35 +177,23 @@ int unit_name_printf(const Unit *u, const char* format, char **ret) { * This will use the passed string as format string and replace the following specifiers (which should all be * safe for inclusion in unit names): * - * %n: the full id of the unit (foo@bar.waldo) - * %N: the id of the unit without the suffix (foo@bar) - * %p: the prefix (foo) + * %n: the full id of the unit (foo-aaa@bar.waldo) + * %N: the id of the unit without the suffix (foo-aaa@bar) + * %p: the prefix (foo-aaa) * %i: the instance (bar) - * - * %U: the UID of the running user - * %u: the username of the running user - * - * %m: the machine ID of the running system - * %b: the boot ID of the running system - * %H: the hostname of the running system - * %v: the kernel version - * %a: the native userspace architecture - * %o: the OS ID according to /etc/os-release - * %w: the OS version ID, according to /etc/os-release - * %B: the OS build ID, according to /etc/os-release - * %W: the OS variant ID, according to /etc/os-release + * %j: the last componet of the prefix (aaa) */ const Specifier table[] = { + { 'i', specifier_string, u->instance }, + { 'j', specifier_last_component, NULL }, { 'n', specifier_string, u->id }, { 'N', specifier_prefix_and_instance, NULL }, { 'p', specifier_prefix, NULL }, - { 'i', specifier_string, u->instance }, - { 'j', specifier_last_component, NULL }, - - COMMON_CREDS_SPECIFIERS, COMMON_SYSTEM_SPECIFIERS, + + COMMON_CREDS_SPECIFIERS, {} }; @@ -226,19 +214,15 @@ int unit_full_printf(const Unit *u, const char *format, char **ret) { * %r: where units in this slice are placed in the cgroup tree (deprecated) * %R: the root of this systemd's instance tree (deprecated) * - * %t: the runtime directory root (e.g. /run or $XDG_RUNTIME_DIR) - * %S: the state directory root (e.g. /var/lib or $XDG_CONFIG_HOME) * %C: the cache directory root (e.g. /var/cache or $XDG_CACHE_HOME) - * %L: the log directory root (e.g. /var/log or $XDG_CONFIG_HOME/log) * %E: the configuration directory root (e.g. /etc or $XDG_CONFIG_HOME) - * %T: the temporary directory (e.g. /tmp, or $TMPDIR, $TEMP, $TMP) - * %V: the temporary directory for large, persistent stuff (e.g. /var/tmp, or $TMPDIR, $TEMP, $TMP) + * %L: the log directory root (e.g. /var/log or $XDG_CONFIG_HOME/log) + * %S: the state directory root (e.g. /var/lib or $XDG_CONFIG_HOME) + * %t: the runtime directory root (e.g. /run or $XDG_RUNTIME_DIR) * * %h: the homedir of the running user * %s: the shell of the running user * - * %v: `uname -r` of the running system - * * NOTICE: When you add new entries here, please be careful: specifiers which depend on settings of the unit * file itself are broken by design, as they would resolve differently depending on whether they are used * before or after the relevant configuration setting. Hence: don't add them. @@ -249,32 +233,35 @@ int unit_full_printf(const Unit *u, const char *format, char **ret) { assert(ret); const Specifier table[] = { - { 'n', specifier_string, u->id }, - { 'N', specifier_prefix_and_instance, NULL }, - { 'p', specifier_prefix, NULL }, - { 'P', specifier_prefix_unescaped, NULL }, { 'i', specifier_string, u->instance }, { 'I', specifier_instance_unescaped, NULL }, { 'j', specifier_last_component, NULL }, { 'J', specifier_last_component_unescaped, NULL }, + { 'n', specifier_string, u->id }, + { 'N', specifier_prefix_and_instance, NULL }, + { 'p', specifier_prefix, NULL }, + { 'P', specifier_prefix_unescaped, NULL }, { 'f', specifier_filename, NULL }, + { 'c', specifier_cgroup, NULL }, { 'r', specifier_cgroup_slice, NULL }, { 'R', specifier_cgroup_root, NULL }, - { 't', specifier_special_directory, UINT_TO_PTR(EXEC_DIRECTORY_RUNTIME) }, - { 'S', specifier_special_directory, UINT_TO_PTR(EXEC_DIRECTORY_STATE) }, { 'C', specifier_special_directory, UINT_TO_PTR(EXEC_DIRECTORY_CACHE) }, - { 'L', specifier_special_directory, UINT_TO_PTR(EXEC_DIRECTORY_LOGS) }, { 'E', specifier_special_directory, UINT_TO_PTR(EXEC_DIRECTORY_CONFIGURATION) }, - COMMON_TMP_SPECIFIERS, + { 'L', specifier_special_directory, UINT_TO_PTR(EXEC_DIRECTORY_LOGS) }, + { 'S', specifier_special_directory, UINT_TO_PTR(EXEC_DIRECTORY_STATE) }, + { 't', specifier_special_directory, UINT_TO_PTR(EXEC_DIRECTORY_RUNTIME) }, - COMMON_CREDS_SPECIFIERS, { 'h', specifier_user_home, NULL }, { 's', specifier_user_shell, NULL }, COMMON_SYSTEM_SPECIFIERS, + + COMMON_CREDS_SPECIFIERS, + + COMMON_TMP_SPECIFIERS, {} }; diff --git a/src/resolve/resolved-conf.c b/src/resolve/resolved-conf.c index 92a7b168c2..f2a3316251 100644 --- a/src/resolve/resolved-conf.c +++ b/src/resolve/resolved-conf.c @@ -230,14 +230,14 @@ int config_parse_dnssd_service_name( void *userdata) { static const Specifier specifier_table[] = { - { 'm', specifier_machine_id, NULL }, - { 'b', specifier_boot_id, NULL }, - { 'H', specifier_host_name, NULL }, /* We will use specifier_dnssd_host_name(). */ - { 'v', specifier_kernel_release, NULL }, { 'a', specifier_architecture, NULL }, - { 'o', specifier_os_id, NULL }, - { 'w', specifier_os_version_id, NULL }, + { 'b', specifier_boot_id, NULL }, { 'B', specifier_os_build_id, NULL }, + { 'H', specifier_host_name, NULL }, /* We will use specifier_dnssd_host_name(). */ + { 'm', specifier_machine_id, NULL }, + { 'o', specifier_os_id, NULL }, + { 'v', specifier_kernel_release, NULL }, + { 'w', specifier_os_version_id, NULL }, { 'W', specifier_os_variant_id, NULL }, {} }; diff --git a/src/resolve/resolved-dnssd.c b/src/resolve/resolved-dnssd.c index 9ea9ec07db..8b40639728 100644 --- a/src/resolve/resolved-dnssd.c +++ b/src/resolve/resolved-dnssd.c @@ -157,14 +157,14 @@ static int specifier_dnssd_host_name(char specifier, const void *data, const voi int dnssd_render_instance_name(DnssdService *s, char **ret_name) { static const Specifier specifier_table[] = { - { 'm', specifier_machine_id, NULL }, - { 'b', specifier_boot_id, NULL }, - { 'H', specifier_dnssd_host_name, NULL }, - { 'v', specifier_kernel_release, NULL }, { 'a', specifier_architecture, NULL }, - { 'o', specifier_os_id, NULL }, - { 'w', specifier_os_version_id, NULL }, + { 'b', specifier_boot_id, NULL }, { 'B', specifier_os_build_id, NULL }, + { 'H', specifier_dnssd_host_name, NULL }, + { 'm', specifier_machine_id, NULL }, + { 'o', specifier_os_id, NULL }, + { 'v', specifier_kernel_release, NULL }, + { 'w', specifier_os_version_id, NULL }, { 'W', specifier_os_variant_id, NULL }, {} }; diff --git a/src/shared/install-printf.c b/src/shared/install-printf.c index 7f60359c78..6bc3f15def 100644 --- a/src/shared/install-printf.c +++ b/src/shared/install-printf.c @@ -104,32 +104,18 @@ static int specifier_last_component(char specifier, const void *data, const void } int install_full_printf(const UnitFileInstallInfo *i, const char *format, char **ret) { - /* This is similar to unit_full_printf() but does not support - * anything path-related. - * - * %n: the full id of the unit (foo@bar.waldo) - * %N: the id of the unit without the suffix (foo@bar) - * %p: the prefix (foo) - * %i: the instance (bar) - - * %U the UID of the running user - * %u the username of running user - * %m the machine ID of the running system - * %H the hostname of the running system - * %b the boot ID of the running system - * %v `uname -r` of the running system - */ + /* This is similar to unit_name_printf() */ const Specifier table[] = { + { 'i', specifier_instance, NULL }, + { 'j', specifier_last_component, NULL }, { 'n', specifier_name, NULL }, { 'N', specifier_prefix_and_instance, NULL }, { 'p', specifier_prefix, NULL }, - { 'i', specifier_instance, NULL }, - { 'j', specifier_last_component, NULL }, - - COMMON_CREDS_SPECIFIERS, COMMON_SYSTEM_SPECIFIERS, + + COMMON_CREDS_SPECIFIERS, {} }; diff --git a/src/shared/specifier.h b/src/shared/specifier.h index e01ee67db3..1323b41d98 100644 --- a/src/shared/specifier.h +++ b/src/shared/specifier.h @@ -37,24 +37,48 @@ int specifier_tmp_dir(char specifier, const void *data, const void *userdata, ch int specifier_var_tmp_dir(char specifier, const void *data, const void *userdata, char **ret); /* Typically, in places where one of the above specifier is to be resolved the other similar ones are to be - * resolved, too. Hence let's define common macros for the relevant array entries. */ + * resolved, too. Hence let's define common macros for the relevant array entries. + * + * COMMON_SYSTEM_SPECIFIERS: + * %a: the native userspace architecture + * %b: the boot ID of the running system + * %B: the OS build ID, according to /etc/os-release + * %H: the hostname of the running system + * %l: the short hostname of the running system + * %m: the machine ID of the running system + * %o: the OS ID according to /etc/os-release + * %v: the kernel version + * %w: the OS version ID, according to /etc/os-release + * %W: the OS variant ID, according to /etc/os-release + * + * COMMON_CREDS_SPECIFIERS: + * %g: the groupname of the running user + * %G: the GID of the running user + * %u: the username of the running user + * %U: the UID of the running user + * + * COMMON_TMP_SPECIFIERS: + * %T: the temporary directory (e.g. /tmp, or $TMPDIR, $TEMP, $TMP) + * %V: the temporary directory for large, persistent stuff (e.g. /var/tmp, or $TMPDIR, $TEMP, $TMP) + */ + #define COMMON_SYSTEM_SPECIFIERS \ - { 'm', specifier_machine_id, NULL }, \ + { 'a', specifier_architecture, NULL }, \ { 'b', specifier_boot_id, NULL }, \ + { 'B', specifier_os_build_id, NULL }, \ { 'H', specifier_host_name, NULL }, \ { 'l', specifier_short_host_name, NULL }, \ - { 'v', specifier_kernel_release, NULL }, \ - { 'a', specifier_architecture, NULL }, \ + { 'm', specifier_machine_id, NULL }, \ { 'o', specifier_os_id, NULL }, \ + { 'v', specifier_kernel_release, NULL }, \ { 'w', specifier_os_version_id, NULL }, \ - { 'B', specifier_os_build_id, NULL }, \ { 'W', specifier_os_variant_id, NULL } #define COMMON_CREDS_SPECIFIERS \ { 'g', specifier_group_name, NULL }, \ { 'G', specifier_group_id, NULL }, \ - { 'U', specifier_user_id, NULL }, \ - { 'u', specifier_user_name, NULL } + { 'u', specifier_user_name, NULL }, \ + { 'U', specifier_user_id, NULL } #define COMMON_TMP_SPECIFIERS \ { 'T', specifier_tmp_dir, NULL }, \ diff --git a/src/tmpfiles/tmpfiles.c b/src/tmpfiles/tmpfiles.c index 684762c842..9906c70eef 100644 --- a/src/tmpfiles/tmpfiles.c +++ b/src/tmpfiles/tmpfiles.c @@ -188,24 +188,26 @@ static int specifier_machine_id_safe(char specifier, const void *data, const voi static int specifier_directory(char specifier, const void *data, const void *userdata, char **ret); static const Specifier specifier_table[] = { - { 'm', specifier_machine_id_safe, NULL }, + { 'a', specifier_architecture, NULL }, { 'b', specifier_boot_id, NULL }, + { 'B', specifier_os_build_id, NULL }, { 'H', specifier_host_name, NULL }, { 'l', specifier_short_host_name, NULL }, - { 'v', specifier_kernel_release, NULL }, - { 'a', specifier_architecture, NULL }, + { 'm', specifier_machine_id_safe, NULL }, { 'o', specifier_os_id, NULL }, + { 'v', specifier_kernel_release, NULL }, { 'w', specifier_os_version_id, NULL }, - { 'B', specifier_os_build_id, NULL }, { 'W', specifier_os_variant_id, NULL }, - COMMON_CREDS_SPECIFIERS, { 'h', specifier_user_home, NULL }, - { 't', specifier_directory, UINT_TO_PTR(DIRECTORY_RUNTIME) }, - { 'S', specifier_directory, UINT_TO_PTR(DIRECTORY_STATE) }, { 'C', specifier_directory, UINT_TO_PTR(DIRECTORY_CACHE) }, { 'L', specifier_directory, UINT_TO_PTR(DIRECTORY_LOGS) }, + { 'S', specifier_directory, UINT_TO_PTR(DIRECTORY_STATE) }, + { 't', specifier_directory, UINT_TO_PTR(DIRECTORY_RUNTIME) }, + + COMMON_CREDS_SPECIFIERS, + COMMON_TMP_SPECIFIERS, {} };