Add SPDX license identifiers to source files under the LGPL

[thirdparty/systemd.git] / src / shared / path-lookup.h

diff --git a/src/shared/path-lookup.h b/src/shared/path-lookup.h
index 64c8035c2bfebfdaae4ca38bcdacdafd86a885f8..8ea263e473b7fdc124e049ce151484ab72003ee1 100644 (file)
--- a/src/shared/path-lookup.h
+++ b/src/shared/path-lookup.h
@@ -1,3 +1,4 @@
+/* SPDX-License-Identifier: LGPL-2.1+ */
 #pragma once
 
 /***
@@ -22,38 +23,61 @@
 #include <stdbool.h>
 
 typedef struct LookupPaths LookupPaths;
-typedef enum ManagerRunningAs ManagerRunningAs;
 
 #include "install.h"
 #include "macro.h"
 
+typedef enum LookupPathsFlags {
+        LOOKUP_PATHS_EXCLUDE_GENERATED = 1,
+        LOOKUP_PATHS_TEMPORARY_GENERATED,
+} LookupPathsFlags;
+
 struct LookupPaths {
+        /* Where we look for unit files. This includes the individual special paths below, but also any vendor
+         * supplied, static unit file paths. */
         char **search_path;
 
-        /* Where we shall create or remove our installation symlinks, aka "configuration". */
+        /* Where we shall create or remove our installation symlinks, aka "configuration", and where the user/admin
+         * shall place his own unit files. */
         char *persistent_config;
         char *runtime_config;
 
-        /* Where to place generated unit files */
+        /* Where to place generated unit files (i.e. those a "generator" tool generated). Note the special semantics of
+         * this directory: the generators are flushed each time a "systemctl daemon-reload" is issued. The user should
+         * not alter these directories directly. */
         char *generator;
         char *generator_early;
         char *generator_late;
-};
 
-enum ManagerRunningAs {
-        MANAGER_SYSTEM,
-        MANAGER_USER,
-        _MANAGER_RUNNING_AS_MAX,
-        _MANAGER_RUNNING_AS_INVALID = -1
+        /* Where to place transient unit files (i.e. those created dynamically via the bus API). Note the special
+         * semantics of this directory: all units created transiently have their unit files removed as the transient
+         * unit is unloaded. The user should not alter this directory directly. */
+        char *transient;
+
+        /* Where the snippets created by "systemctl set-property" are placed. Note that for transient units, the
+         * snippets are placed in the transient directory though (see above). The user should not alter this directory
+         * directly. */
+        char *persistent_control;
+        char *runtime_control;
+
+        /* The root directory prepended to all items above, or NULL */
+        char *root_dir;
+
+        /* A temporary directory when running in test mode, to be nuked */
+        char *temporary_dir;
 };
 
-int user_config_home(char **config_home);
-int user_runtime_dir(char **runtime_dir);
+int lookup_paths_init(LookupPaths *p, UnitFileScope scope, LookupPathsFlags flags, const char *root_dir);
+bool path_is_user_data_dir(const char *path);
+bool path_is_user_config_dir(const char *path);
 
-char **generator_paths(ManagerRunningAs running_as);
+int lookup_paths_reduce(LookupPaths *p);
 
-int lookup_paths_init(LookupPaths *p, ManagerRunningAs running_as, bool personal, const char *root_dir);
-int lookup_paths_init_from_scope(LookupPaths *p, UnitFileScope scope, const char *root_dir);
+int lookup_paths_mkdir_generator(LookupPaths *p);
+void lookup_paths_trim_generator(LookupPaths *p);
+void lookup_paths_flush_generator(LookupPaths *p);
 
 void lookup_paths_free(LookupPaths *p);
 #define _cleanup_lookup_paths_free_ _cleanup_(lookup_paths_free)
+
+char **generator_binary_paths(UnitFileScope scope);