/src/systemd/src/shared/install.h

Source
/* SPDX-License-Identifier: LGPL-2.1-or-later */
#pragma once

#include "forward.h"
#include "runtime-scope.h"
#include "unit-file.h"

typedef enum UnitFilePresetMode {
        UNIT_FILE_PRESET_FULL,
        UNIT_FILE_PRESET_ENABLE_ONLY,
        UNIT_FILE_PRESET_DISABLE_ONLY,
        _UNIT_FILE_PRESET_MODE_MAX,
        _UNIT_FILE_PRESET_MODE_INVALID = -EINVAL,
} UnitFilePresetMode;

typedef enum InstallChangeType {
        INSTALL_CHANGE_SYMLINK,
        INSTALL_CHANGE_UNLINK,
        INSTALL_CHANGE_IS_MASKED,
        INSTALL_CHANGE_IS_MASKED_GENERATOR,
        INSTALL_CHANGE_IS_DANGLING,
        INSTALL_CHANGE_DESTINATION_NOT_PRESENT,
        INSTALL_CHANGE_AUXILIARY_FAILED,
        _INSTALL_CHANGE_TYPE_MAX,
        _INSTALL_CHANGE_INVALID = -EINVAL,
        _INSTALL_CHANGE_ERRNO_MAX = -ERRNO_MAX, /* Ensure this type covers the whole negative errno range */
} InstallChangeType;

static inline bool INSTALL_CHANGE_TYPE_VALID(InstallChangeType t) {
        return t >= _INSTALL_CHANGE_ERRNO_MAX && t < _INSTALL_CHANGE_TYPE_MAX;
}

typedef enum UnitFileFlags {
        UNIT_FILE_RUNTIME                  = 1 << 0, /* Public API via DBUS, do not change */
        UNIT_FILE_FORCE                    = 1 << 1, /* Public API via DBUS, do not change */
        UNIT_FILE_PORTABLE                 = 1 << 2, /* Public API via DBUS, do not change */
        UNIT_FILE_DRY_RUN                  = 1 << 3,
        UNIT_FILE_IGNORE_AUXILIARY_FAILURE = 1 << 4,
        _UNIT_FILE_FLAGS_MASK_PUBLIC = UNIT_FILE_RUNTIME|UNIT_FILE_PORTABLE|UNIT_FILE_FORCE,
} UnitFileFlags;

typedef enum SearchFlags {
        SEARCH_LOAD                   = 1 << 0,
        SEARCH_FOLLOW_CONFIG_SYMLINKS = 1 << 1,
        SEARCH_DROPIN                 = 1 << 2,
        SEARCH_IGNORE_TEMPLATE        = 1 << 3, /* Don't look up the template if the instance does not exist. */
} SearchFlags;

/* type can be either one of the INSTALL_CHANGE_SYMLINK, INSTALL_CHANGE_UNLINK, … listed above, or a negative
 * errno value.
 *
 * If source is specified, it should be the contents of the path symlink. In case of an error, source should
 * be the existing symlink contents or NULL. */
typedef struct InstallChange {
        int type; /* INSTALL_CHANGE_SYMLINK, … if positive, errno if negative */
        char *path;
        char *source;
} InstallChange;

static inline bool install_changes_have_modification(const InstallChange *changes, size_t n_changes) {
        FOREACH_ARRAY(i, changes, n_changes)
                if (IN_SET(i->type, INSTALL_CHANGE_SYMLINK, INSTALL_CHANGE_UNLINK))
                        return true;
        return false;
}

typedef struct UnitFileList {
        char *path;
        UnitFileState state;
} UnitFileList;

typedef enum InstallMode {
        INSTALL_MODE_REGULAR,
        INSTALL_MODE_LINKED,
        INSTALL_MODE_ALIAS,
        INSTALL_MODE_MASKED,
        _INSTALL_MODE_MAX,
        _INSTALL_MODE_INVALID = -EINVAL,
} InstallMode;

typedef struct InstallInfo {
        char *name;
        char *path;
        char *root;

        char **aliases;
        char **wanted_by;
        char **required_by;
        char **upheld_by;
        char **also;

        char *default_instance;
        char *symlink_target;

        InstallMode install_mode;
        bool auxiliary;
} InstallInfo;

int unit_file_enable(
                RuntimeScope scope,
                UnitFileFlags flags,
                const char *root_dir,
                char * const *names_or_paths,
                InstallChange **changes,
                size_t *n_changes);
int unit_file_disable(
                RuntimeScope scope,
                UnitFileFlags flags,
                const char *root_dir,
                char * const *files,
                InstallChange **changes,
                size_t *n_changes);
int unit_file_reenable(
                RuntimeScope scope,
                UnitFileFlags flags,
                const char *root_dir,
                char * const *names_or_paths,
                InstallChange **changes,
                size_t *n_changes);
int unit_file_preset(
                RuntimeScope scope,
                UnitFileFlags file_flags,
                const char *root_dir,
                char * const *names,
                UnitFilePresetMode mode,
                InstallChange **changes,
                size_t *n_changes);
int unit_file_preset_all(
                RuntimeScope scope,
                UnitFileFlags file_flags,
                const char *root_dir,
                UnitFilePresetMode mode,
                InstallChange **changes,
                size_t *n_changes);
int unit_file_mask(
                RuntimeScope scope,
                UnitFileFlags flags,
                const char *root_dir,
                char * const *names,
                InstallChange **changes,
                size_t *n_changes);
int unit_file_unmask(
                RuntimeScope scope,
                UnitFileFlags flags,
                const char *root_dir,
                char * const *names,
                InstallChange **changes,
                size_t *n_changes);
int unit_file_link(
                RuntimeScope scope,
                UnitFileFlags flags,
                const char *root_dir,
                char * const *files,
                InstallChange **changes,
                size_t *n_changes);
int unit_file_revert(
                RuntimeScope scope,
                const char *root_dir,
                char * const *names,
                InstallChange **changes,
                size_t *n_changes);
int unit_file_set_default(
                RuntimeScope scope,
                UnitFileFlags flags,
                const char *root_dir,
                const char *name,
                InstallChange **changes,
                size_t *n_changes);
int unit_file_get_default(
                RuntimeScope scope,
                const char *root_dir,
                char **ret);
int unit_file_add_dependency(
                RuntimeScope scope,
                UnitFileFlags flags,
                const char *root_dir,
                char * const *names,
                const char *target,
                UnitDependency dep,
                InstallChange **changes,
                size_t *n_changes);

int unit_file_lookup_state(
                RuntimeScope scope,
                const LookupPaths *lp,
                const char *name,
                UnitFileState *ret);

int unit_file_get_state(RuntimeScope scope, const char *root_dir, const char *filename, UnitFileState *ret);

int unit_file_exists_full(
                RuntimeScope scope,
                const LookupPaths *lp,
                SearchFlags flags,
                const char *name,
                char **ret_path);

static inline int unit_file_exists(RuntimeScope scope, const LookupPaths *lp, const char *name) {
        return unit_file_exists_full(scope, lp, 0, name, NULL);
}

int unit_file_get_list(RuntimeScope scope, const char *root_dir, char * const *states, char * const *patterns, Hashmap **ret);

InstallChangeType install_changes_add(InstallChange **changes, size_t *n_changes, InstallChangeType type, const char *path, const char *source);
void install_changes_free(InstallChange *array, size_t n);

void install_change_dump_success(const InstallChange *change);
int install_change_dump_error(const InstallChange *change, char **ret_errmsg, const char **ret_bus_error);
int install_changes_dump(
                int error,
                const char *verb,
                const InstallChange *changes,
                size_t n_changes,
                bool quiet);

int unit_file_verify_alias(
                const InstallInfo *info,
                const char *dst,
                char **ret_dst,
                InstallChange **changes,
                size_t *n_changes);

typedef struct UnitFilePresetRule UnitFilePresetRule;

typedef struct {
        UnitFilePresetRule *rules;
        size_t n_rules;
        bool initialized;
} UnitFilePresets;

typedef enum PresetAction {
        PRESET_UNKNOWN,
        PRESET_ENABLE,
        PRESET_DISABLE,
        PRESET_IGNORE,
        _PRESET_ACTION_MAX,
        _PRESET_ACTION_INVALID = -EINVAL,
        _PRESET_ACTION_ERRNO_MAX = -ERRNO_MAX, /* Ensure this type covers the whole negative errno range */
} PresetAction;

DECLARE_STRING_TABLE_LOOKUP_TO_STRING(preset_action_past_tense, PresetAction);

void unit_file_presets_done(UnitFilePresets *p);
PresetAction unit_file_query_preset(RuntimeScope scope, const char *root_dir, const char *name, UnitFilePresets *cached);

DECLARE_STRING_TABLE_LOOKUP(unit_file_state, UnitFileState);
/* from_string conversion is unreliable because of the overlap between -EPERM and -1 for error. */

DECLARE_STRING_TABLE_LOOKUP(install_change_type, InstallChangeType);

DECLARE_STRING_TABLE_LOOKUP(unit_file_preset_mode, UnitFilePresetMode);

Coverage Report

Created: 2026-10-28 06:53

Line	Count	Source
1		/* SPDX-License-Identifier: LGPL-2.1-or-later */
2		#pragma once
3
4		#include "forward.h"
5		#include "runtime-scope.h"
6		#include "unit-file.h"
7
8		typedef enum UnitFilePresetMode {
9		UNIT_FILE_PRESET_FULL,
10		UNIT_FILE_PRESET_ENABLE_ONLY,
11		UNIT_FILE_PRESET_DISABLE_ONLY,
12		_UNIT_FILE_PRESET_MODE_MAX,
13		_UNIT_FILE_PRESET_MODE_INVALID = -EINVAL,
14		} UnitFilePresetMode;
15
16		typedef enum InstallChangeType {
17		INSTALL_CHANGE_SYMLINK,
18		INSTALL_CHANGE_UNLINK,
19		INSTALL_CHANGE_IS_MASKED,
20		INSTALL_CHANGE_IS_MASKED_GENERATOR,
21		INSTALL_CHANGE_IS_DANGLING,
22		INSTALL_CHANGE_DESTINATION_NOT_PRESENT,
23		INSTALL_CHANGE_AUXILIARY_FAILED,
24		_INSTALL_CHANGE_TYPE_MAX,
25		_INSTALL_CHANGE_INVALID = -EINVAL,
26		_INSTALL_CHANGE_ERRNO_MAX = -ERRNO_MAX, /* Ensure this type covers the whole negative errno range */
27		} InstallChangeType;
28
29	0	static inline bool INSTALL_CHANGE_TYPE_VALID(InstallChangeType t) {
30	0	return t >= _INSTALL_CHANGE_ERRNO_MAX && t < _INSTALL_CHANGE_TYPE_MAX;
31	0	} Unexecuted instantiation: fuzz-manager-serialize.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: fuzz-unit-file.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: systemctl-util.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: systemctl.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: bus-unit-util.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: install-printf.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: install.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: load-fragment-gperf.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: automount.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: bpf-bind-iface.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: bpf-firewall.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: bpf-foreign.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: bpf-restrict-fs.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: bpf-restrict-fsaccess.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: bpf-restrict-ifaces.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: bpf-socket-bind.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: cgroup.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: dbus-automount.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: dbus-cgroup.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: dbus-device.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: dbus-execute.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: dbus-job.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: dbus-kill.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: dbus-manager.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: dbus-mount.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: dbus-path.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: dbus-scope.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: dbus-service.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: dbus-slice.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: dbus-socket.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: dbus-swap.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: dbus-timer.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: dbus-unit.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: dbus-util.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: dbus.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: device.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: dynamic-user.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: emergency-action.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: exec-credential.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: execute.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: execute-serialize.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: job.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: load-dropin.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: load-fragment.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: luo.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: manager-dump.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: manager-serialize.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: manager.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: mount.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: path.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: scope.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: service.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: slice.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: socket.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: swap.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: target.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: timer.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: transaction.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: unit-printf.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: unit-serialize.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: unit.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: varlink.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: varlink-automount.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: varlink-cgroup.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: varlink-common.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: varlink-dynamic-user.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: varlink-execute.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: varlink-job.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: varlink-kill.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: varlink-manager.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: varlink-metrics.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: varlink-mount.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: varlink-path.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: varlink-scope.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: varlink-service.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: varlink-socket.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: varlink-swap.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: varlink-timer.c:INSTALL_CHANGE_TYPE_VALID Unexecuted instantiation: varlink-unit.c:INSTALL_CHANGE_TYPE_VALID
32
33		typedef enum UnitFileFlags {
34		UNIT_FILE_RUNTIME = 1 << 0, /* Public API via DBUS, do not change */
35		UNIT_FILE_FORCE = 1 << 1, /* Public API via DBUS, do not change */
36		UNIT_FILE_PORTABLE = 1 << 2, /* Public API via DBUS, do not change */
37		UNIT_FILE_DRY_RUN = 1 << 3,
38		UNIT_FILE_IGNORE_AUXILIARY_FAILURE = 1 << 4,
39		_UNIT_FILE_FLAGS_MASK_PUBLIC = UNIT_FILE_RUNTIME\|UNIT_FILE_PORTABLE\|UNIT_FILE_FORCE,