2020-11-09 05:23:58 +01:00
|
|
|
/* SPDX-License-Identifier: LGPL-2.1-or-later */
|
2014-07-02 12:23:36 +02:00
|
|
|
#ifndef foosdpathhfoo
|
|
|
|
#define foosdpathhfoo
|
|
|
|
|
|
|
|
/***
|
|
|
|
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
|
|
|
|
Lesser 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/>.
|
|
|
|
***/
|
|
|
|
|
|
|
|
#include <inttypes.h>
|
|
|
|
|
2015-10-24 23:42:56 +02:00
|
|
|
#include "_sd-common.h"
|
|
|
|
|
|
|
|
_SD_BEGIN_DECLARATIONS;
|
|
|
|
|
2014-07-02 12:23:36 +02:00
|
|
|
enum {
|
|
|
|
/* Temporary files */
|
2018-10-06 19:16:17 +02:00
|
|
|
SD_PATH_TEMPORARY,
|
2014-07-02 12:23:36 +02:00
|
|
|
SD_PATH_TEMPORARY_LARGE,
|
|
|
|
|
|
|
|
/* Vendor supplied data */
|
|
|
|
SD_PATH_SYSTEM_BINARIES,
|
|
|
|
SD_PATH_SYSTEM_INCLUDE,
|
|
|
|
SD_PATH_SYSTEM_LIBRARY_PRIVATE,
|
|
|
|
SD_PATH_SYSTEM_LIBRARY_ARCH,
|
|
|
|
SD_PATH_SYSTEM_SHARED,
|
|
|
|
SD_PATH_SYSTEM_CONFIGURATION_FACTORY,
|
|
|
|
SD_PATH_SYSTEM_STATE_FACTORY,
|
|
|
|
|
|
|
|
/* System configuration, runtime, state, ... */
|
|
|
|
SD_PATH_SYSTEM_CONFIGURATION,
|
|
|
|
SD_PATH_SYSTEM_RUNTIME,
|
|
|
|
SD_PATH_SYSTEM_RUNTIME_LOGS,
|
|
|
|
SD_PATH_SYSTEM_STATE_PRIVATE,
|
|
|
|
SD_PATH_SYSTEM_STATE_LOGS,
|
|
|
|
SD_PATH_SYSTEM_STATE_CACHE,
|
|
|
|
SD_PATH_SYSTEM_STATE_SPOOL,
|
|
|
|
|
|
|
|
/* Vendor supplied data */
|
|
|
|
SD_PATH_USER_BINARIES,
|
|
|
|
SD_PATH_USER_LIBRARY_PRIVATE,
|
|
|
|
SD_PATH_USER_LIBRARY_ARCH,
|
|
|
|
SD_PATH_USER_SHARED,
|
|
|
|
|
|
|
|
/* User configuration, state, runtime ... */
|
|
|
|
SD_PATH_USER_CONFIGURATION, /* takes both actual configuration (like /etc) and state (like /var/lib) */
|
|
|
|
SD_PATH_USER_RUNTIME,
|
|
|
|
SD_PATH_USER_STATE_CACHE,
|
|
|
|
|
|
|
|
/* User resources */
|
|
|
|
SD_PATH_USER, /* $HOME itself */
|
|
|
|
SD_PATH_USER_DOCUMENTS,
|
|
|
|
SD_PATH_USER_MUSIC,
|
|
|
|
SD_PATH_USER_PICTURES,
|
|
|
|
SD_PATH_USER_VIDEOS,
|
|
|
|
SD_PATH_USER_DOWNLOAD,
|
|
|
|
SD_PATH_USER_PUBLIC,
|
|
|
|
SD_PATH_USER_TEMPLATES,
|
|
|
|
SD_PATH_USER_DESKTOP,
|
|
|
|
|
|
|
|
/* Search paths */
|
|
|
|
SD_PATH_SEARCH_BINARIES,
|
2018-03-26 09:51:12 +02:00
|
|
|
SD_PATH_SEARCH_BINARIES_DEFAULT,
|
2014-07-02 12:23:36 +02:00
|
|
|
SD_PATH_SEARCH_LIBRARY_PRIVATE,
|
|
|
|
SD_PATH_SEARCH_LIBRARY_ARCH,
|
|
|
|
SD_PATH_SEARCH_SHARED,
|
|
|
|
SD_PATH_SEARCH_CONFIGURATION_FACTORY,
|
|
|
|
SD_PATH_SEARCH_STATE_FACTORY,
|
|
|
|
SD_PATH_SEARCH_CONFIGURATION,
|
|
|
|
|
sd-path: drop "-dir" and "-path" suffixes from path enums
Clean up the naming of the sd-path enums. Previously, the more recently
added fields where named in the form SD_PATH_xyz_DIR and
SD_PATH_xyz_PATH, while the older fields where called just SD_PATH_xyz
and SD_PATH_SEARCH_xyz. Let's clean this up, to come to a more unified
way how we name this stuff.
I opted to stick to the old naming, i.e. dropthe suffixes. It's a bit of
a bike-shedding question of course, but I think there's a good reason to
avoid the additional DIR and PATH suffixes: the enum prefix contains
"PATH" anyway (i.e. "SD_PATH_"), so including PATH twice in each name is
redundant. Moreover, the key difference between the enums with the "dir"
and the "path" in the name is that the latter are *seach* paths, and I
think this is better emphasized by sticking to the "SEARCH" in the name.
Moreover dropping the suffixes makes the identifiers a lot shorter, in
particular in the "systemd-path" list output. And that's always good.
This means the naming pkgconfig file and in sd-path slightly deviate
(though the mapping is very simple), but I think that's OK, given that
this is developer facing and not user facing.
2020-05-28 09:28:28 +02:00
|
|
|
/* Various systemd paths, generally mirroring systemd.pc — Except we drop the "dir" suffix (and
|
|
|
|
* replaces "path" by "search"), since this API is about dirs/paths anyway, and contains "path"
|
|
|
|
* already in the prefix */
|
|
|
|
SD_PATH_SYSTEMD_UTIL,
|
|
|
|
SD_PATH_SYSTEMD_SYSTEM_UNIT,
|
|
|
|
SD_PATH_SYSTEMD_SYSTEM_PRESET,
|
|
|
|
SD_PATH_SYSTEMD_SYSTEM_CONF,
|
|
|
|
SD_PATH_SYSTEMD_USER_UNIT,
|
|
|
|
SD_PATH_SYSTEMD_USER_PRESET,
|
|
|
|
SD_PATH_SYSTEMD_USER_CONF,
|
|
|
|
|
|
|
|
SD_PATH_SYSTEMD_SEARCH_SYSTEM_UNIT,
|
|
|
|
SD_PATH_SYSTEMD_SEARCH_USER_UNIT,
|
|
|
|
|
|
|
|
SD_PATH_SYSTEMD_SYSTEM_GENERATOR,
|
|
|
|
SD_PATH_SYSTEMD_USER_GENERATOR,
|
|
|
|
SD_PATH_SYSTEMD_SEARCH_SYSTEM_GENERATOR,
|
|
|
|
SD_PATH_SYSTEMD_SEARCH_USER_GENERATOR,
|
|
|
|
|
|
|
|
SD_PATH_SYSTEMD_SLEEP,
|
|
|
|
SD_PATH_SYSTEMD_SHUTDOWN,
|
|
|
|
|
|
|
|
SD_PATH_TMPFILES,
|
|
|
|
SD_PATH_SYSUSERS,
|
|
|
|
SD_PATH_SYSCTL,
|
|
|
|
SD_PATH_BINFMT,
|
|
|
|
SD_PATH_MODULES_LOAD,
|
|
|
|
SD_PATH_CATALOG,
|
path: show various systemd directories and search paths too
So far we had various ad hoc APIs to query search paths:
systemd-analyze unit-paths, lookup_paths_log(), the pkgconfig file,
debug logs emitted by systemd-analyze cat-config.
But answering a simple question "what is the search path for tmpfiles,
sysusers, .network files, ..." is surprisingly hard.
I think we should have an api that makes it easy to query this. Pkgconfig is
not bad, but it is primarily a development tool, so it's not available in many
context. Also it can't provide support for paths which are influenced by
environment variables, and I'd like to be able to answer the question "what is
the search path for ..., assuming that VAR_FOO=... is set?".
Extending sd-path to support more of our internal paths seems to be most
flexible solution. We already have systemd-path which provides a nice
way to query, and we can add stuff like optional descriptions later on.
We we essentially get a nice programmatic and commmandline apis for the price
of one.
2020-03-24 16:04:50 +01:00
|
|
|
|
2020-03-24 17:12:45 +01:00
|
|
|
/* systemd-networkd search paths */
|
sd-path: drop "-dir" and "-path" suffixes from path enums
Clean up the naming of the sd-path enums. Previously, the more recently
added fields where named in the form SD_PATH_xyz_DIR and
SD_PATH_xyz_PATH, while the older fields where called just SD_PATH_xyz
and SD_PATH_SEARCH_xyz. Let's clean this up, to come to a more unified
way how we name this stuff.
I opted to stick to the old naming, i.e. dropthe suffixes. It's a bit of
a bike-shedding question of course, but I think there's a good reason to
avoid the additional DIR and PATH suffixes: the enum prefix contains
"PATH" anyway (i.e. "SD_PATH_"), so including PATH twice in each name is
redundant. Moreover, the key difference between the enums with the "dir"
and the "path" in the name is that the latter are *seach* paths, and I
think this is better emphasized by sticking to the "SEARCH" in the name.
Moreover dropping the suffixes makes the identifiers a lot shorter, in
particular in the "systemd-path" list output. And that's always good.
This means the naming pkgconfig file and in sd-path slightly deviate
(though the mapping is very simple), but I think that's OK, given that
this is developer facing and not user facing.
2020-05-28 09:28:28 +02:00
|
|
|
SD_PATH_SYSTEMD_SEARCH_NETWORK,
|
2020-03-24 17:12:45 +01:00
|
|
|
|
2014-07-02 12:23:36 +02:00
|
|
|
_SD_PATH_MAX,
|
|
|
|
};
|
|
|
|
|
2020-03-23 19:50:59 +01:00
|
|
|
int sd_path_lookup(uint64_t type, const char *suffix, char **path);
|
|
|
|
int sd_path_lookup_strv(uint64_t type, const char *suffix, char ***paths);
|
2014-07-02 12:23:36 +02:00
|
|
|
|
2015-10-24 23:42:56 +02:00
|
|
|
_SD_END_DECLARATIONS;
|
|
|
|
|
2014-07-02 12:23:36 +02:00
|
|
|
#endif
|