X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=unit.h;h=8f9d9e98601925f308277f0501f8f178ee1141c4;hp=e4034fd7d8505a92eb6ec80ae8b59af3b2a76d20;hb=173e382182d7f1ad2b132b6e923ef731d6affdf7;hpb=c1e1601e8c6cace85b19a0eebe50076e5d119688 diff --git a/unit.h b/unit.h index e4034fd7d..8f9d9e986 100644 --- a/unit.h +++ b/unit.h @@ -43,23 +43,34 @@ typedef enum UnitDependency UnitDependency; #define DEFAULT_TIMEOUT_USEC (20*USEC_PER_SEC) #define DEFAULT_RESTART_USEC (100*USEC_PER_MSEC) +typedef enum KillMode { + KILL_CONTROL_GROUP = 0, + KILL_PROCESS_GROUP, + KILL_PROCESS, + KILL_NONE, + _KILL_MODE_MAX, + _KILL_MODE_INVALID = -1 +} KillMode; + enum UnitType { UNIT_SERVICE = 0, - UNIT_TIMER, UNIT_SOCKET, UNIT_TARGET, UNIT_DEVICE, UNIT_MOUNT, UNIT_AUTOMOUNT, UNIT_SNAPSHOT, + UNIT_TIMER, + UNIT_SWAP, _UNIT_TYPE_MAX, - _UNIT_TYPE_INVALID = -1, + _UNIT_TYPE_INVALID = -1 }; enum UnitLoadState { UNIT_STUB, UNIT_LOADED, UNIT_FAILED, + UNIT_MERGED, _UNIT_LOAD_STATE_MAX, _UNIT_LOAD_STATE_INVALID = -1 }; @@ -89,68 +100,93 @@ static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t) { enum UnitDependency { /* Positive dependencies */ UNIT_REQUIRES, - UNIT_SOFT_REQUIRES, - UNIT_WANTS, + UNIT_REQUIRES_OVERRIDABLE, UNIT_REQUISITE, - UNIT_SOFT_REQUISITE, + UNIT_REQUISITE_OVERRIDABLE, + UNIT_WANTS, /* Inverse of the above */ - UNIT_REQUIRED_BY, /* inverse of 'requires' and 'requisite' is 'required_by' */ - UNIT_SOFT_REQUIRED_BY, /* inverse of 'soft_requires' and 'soft_requisite' is 'soft_required_by' */ - UNIT_WANTED_BY, /* inverse of 'wants' */ + UNIT_REQUIRED_BY, /* inverse of 'requires' and 'requisite' is 'required_by' */ + UNIT_REQUIRED_BY_OVERRIDABLE, /* inverse of 'soft_requires' and 'soft_requisite' is 'soft_required_by' */ + UNIT_WANTED_BY, /* inverse of 'wants' */ /* Negative dependencies */ - UNIT_CONFLICTS, /* inverse of 'conflicts' is 'conflicts' */ + UNIT_CONFLICTS, /* inverse of 'conflicts' is 'conflicts' */ /* Order */ - UNIT_BEFORE, /* inverse of before is after and vice versa */ + UNIT_BEFORE, /* inverse of 'before' is 'after' and vice versa */ UNIT_AFTER, + /* Reference information for GC logic */ + UNIT_REFERENCES, /* Inverse of 'references' is 'referenced_by' */ + UNIT_REFERENCED_BY, + _UNIT_DEPENDENCY_MAX, _UNIT_DEPENDENCY_INVALID = -1 }; #include "manager.h" #include "job.h" +#include "cgroup.h" struct Meta { Manager *manager; + UnitType type; UnitLoadState load_state; + Unit *merged_into; char *id; /* One name is special because we use it for identification. Points to an entry in the names set */ + char *instance; Set *names; Set *dependencies[_UNIT_DEPENDENCY_MAX]; char *description; - char *load_path; /* if loaded from a config file this is the primary path to it */ + char *fragment_path; /* if loaded from a config file this is the primary path to it */ /* If there is something to do with this unit, then this is * the job for it */ Job *job; - bool in_load_queue:1; - bool in_dbus_queue:1; - bool sent_dbus_new_signal:1; - - /* If we go down, pull down everything that depends on us, too */ - bool recursive_stop; - - /* Garbage collect us we nobody wants or requires us anymore */ - bool stop_when_unneeded; - + usec_t inactive_exit_timestamp; usec_t active_enter_timestamp; usec_t active_exit_timestamp; + usec_t inactive_enter_timestamp; - /* Load queue */ - LIST_FIELDS(Meta, load_queue); + /* Counterparts in the cgroup filesystem */ + CGroupBonding *cgroup_bondings; /* Per type list */ LIST_FIELDS(Meta, units_per_type); + /* Load queue */ + LIST_FIELDS(Meta, load_queue); + /* D-Bus queue */ LIST_FIELDS(Meta, dbus_queue); + + /* Cleanup queue */ + LIST_FIELDS(Meta, cleanup_queue); + + /* GC queue */ + LIST_FIELDS(Meta, gc_queue); + + /* Used during GC sweeps */ + unsigned gc_marker; + + /* If we go down, pull down everything that depends on us, too */ + bool recursive_stop; + + /* Garbage collect us we nobody wants or requires us anymore */ + bool stop_when_unneeded; + + bool in_load_queue:1; + bool in_dbus_queue:1; + bool in_cleanup_queue:1; + bool in_gc_queue:1; + + bool sent_dbus_new_signal:1; }; #include "service.h" @@ -161,6 +197,7 @@ struct Meta { #include "mount.h" #include "automount.h" #include "snapshot.h" +#include "swap.h" union Unit { Meta meta; @@ -172,13 +209,29 @@ union Unit { Mount mount; Automount automount; Snapshot snapshot; + Swap swap; }; struct UnitVTable { const char *suffix; - int (*init)(Unit *u); + /* This should reset all type-specific variables. This should + * not allocate memory, and is called with zero-initialized + * data. It should hence only initialize variables that need + * to be set != 0. */ + void (*init)(Unit *u); + + /* This should free all type-specific variables. It should be + * idempotent. */ void (*done)(Unit *u); + + /* Actually load data from disk. This may fail, and should set + * load_state to UNIT_LOADED, UNIT_MERGED or leave it at + * UNIT_STUB if no configuration could be found. */ + int (*load)(Unit *u); + + /* If a a lot of units got created via enumerate(), this is + * where to actually set the state and call unit_notify(). */ int (*coldplug)(Unit *u); void (*dump)(Unit *u, FILE *f, const char *prefix); @@ -189,14 +242,49 @@ struct UnitVTable { bool (*can_reload)(Unit *u); + /* Write all data that cannot be restored from other sources + * away using unit_serialize_item() */ + int (*serialize)(Unit *u, FILE *f, FDSet *fds); + + /* Restore one item from the serialization */ + int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds); + /* Boils down the more complex internal state of this unit to * a simpler one that the engine can understand */ UnitActiveState (*active_state)(Unit *u); + /* Returns the substate specific to this unit type as + * string. This is purely information so that we can give the + * user a more finegrained explanation in which actual state a + * unit is in. */ + const char* (*sub_state_to_string)(Unit *u); + + /* Return true when there is reason to keep this entry around + * even nothing references it and it isn't active in any + * way */ + bool (*check_gc)(Unit *u); + + /* Return true when this unit is suitable for snapshotting */ + bool (*check_snapshot)(Unit *u); + void (*fd_event)(Unit *u, int fd, uint32_t events, Watch *w); void (*sigchld_event)(Unit *u, pid_t pid, int code, int status); void (*timer_event)(Unit *u, uint64_t n_elapsed, Watch *w); + /* Called whenever any of the cgroups this unit watches for + * ran empty */ + void (*cgroup_notify_empty)(Unit *u); + + /* Called whenever a name thus Unit registered for comes or + * goes away. */ + void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner); + + /* Called whenever a bus PID lookup finishes */ + void (*bus_query_pid_done)(Unit *u, const char *name, pid_t pid); + + /* Called for each message received on the bus */ + DBusHandlerResult (*bus_message_handler)(Unit *u, DBusMessage *message); + /* This is called for each unit type and should be used to * enumerate existing devices and load them. However, * everything that is loaded here should still stay in @@ -206,6 +294,26 @@ struct UnitVTable { /* Type specific cleanups. */ void (*shutdown)(Manager *m); + + /* Can units of this type have multiple names? */ + bool no_alias:1; + + /* If true units of this types can never have "Requires" + * dependencies, because state changes can only be observed, + * not triggered */ + bool no_requires:1; + + /* Instances make no sense for this type */ + bool no_instances:1; + + /* Exclude this type from snapshots */ + bool no_snapshots:1; + + /* Exclude from automatic gc */ + bool no_gc:1; + + /* Exclude from isolation requests */ + bool no_isolate:1; }; extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX]; @@ -232,34 +340,52 @@ DEFINE_CAST(DEVICE, Device); DEFINE_CAST(MOUNT, Mount); DEFINE_CAST(AUTOMOUNT, Automount); DEFINE_CAST(SNAPSHOT, Snapshot); - -UnitType unit_name_to_type(const char *n); -bool unit_name_is_valid(const char *n); -char *unit_name_change_suffix(const char *n, const char *suffix); +DEFINE_CAST(SWAP, Swap); Unit *unit_new(Manager *m); void unit_free(Unit *u); int unit_add_name(Unit *u, const char *name); -int unit_add_dependency(Unit *u, UnitDependency d, Unit *other); -int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name); + +int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference); +int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference); +int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference); + +int unit_add_exec_dependencies(Unit *u, ExecContext *c); + +int unit_add_cgroup(Unit *u, CGroupBonding *b); +int unit_add_cgroup_from_text(Unit *u, const char *name); +int unit_add_default_cgroup(Unit *u); +CGroupBonding* unit_get_default_cgroup(Unit *u); int unit_choose_id(Unit *u, const char *name); int unit_set_description(Unit *u, const char *description); +bool unit_check_gc(Unit *u); + void unit_add_to_load_queue(Unit *u); void unit_add_to_dbus_queue(Unit *u); +void unit_add_to_cleanup_queue(Unit *u); +void unit_add_to_gc_queue(Unit *u); int unit_merge(Unit *u, Unit *other); +int unit_merge_by_name(Unit *u, const char *other); + +Unit *unit_follow_merge(Unit *u); int unit_load_fragment_and_dropin(Unit *u); +int unit_load_fragment_and_dropin_optional(Unit *u); +int unit_load_nop(Unit *u); int unit_load(Unit *unit); -const char* unit_id(Unit *u); const char *unit_description(Unit *u); +bool unit_has_name(Unit *u, const char *name); + UnitActiveState unit_active_state(Unit *u); +const char* unit_sub_state_to_string(Unit *u); + void unit_dump(Unit *u, FILE *f, const char *prefix); bool unit_can_reload(Unit *u); @@ -280,12 +406,29 @@ void unit_unwatch_pid(Unit *u, pid_t pid); int unit_watch_timer(Unit *u, usec_t delay, Watch *w); void unit_unwatch_timer(Unit *u, Watch *w); +int unit_watch_bus_name(Unit *u, const char *name); +void unit_unwatch_bus_name(Unit *u, const char *name); + bool unit_job_is_applicable(Unit *u, JobType j); -const char *unit_path(void); int set_unit_path(const char *p); -char *unit_name_escape_path(const char *prefix, const char *path, const char *suffix); +char *unit_dbus_path(Unit *u); + +int unit_load_related_unit(Unit *u, const char *type, Unit **_found); +int unit_get_related_unit(Unit *u, const char *type, Unit **_found); + +char *unit_name_printf(Unit *u, const char* text); +char *unit_full_printf(Unit *u, const char *text); +char **unit_full_printf_strv(Unit *u, char **l); + +bool unit_can_serialize(Unit *u); +int unit_serialize(Unit *u, FILE *f, FDSet *fds); +void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_attr(4,5); +void unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value); +int unit_deserialize(Unit *u, FILE *f, FDSet *fds); + +int unit_add_node_link(Unit *u, const char *what, bool wants); const char *unit_type_to_string(UnitType i); UnitType unit_type_from_string(const char *s); @@ -299,6 +442,7 @@ UnitActiveState unit_active_state_from_string(const char *s); const char *unit_dependency_to_string(UnitDependency i); UnitDependency unit_dependency_from_string(const char *s); -char *unit_dbus_path(Unit *u); +const char *kill_mode_to_string(KillMode k); +KillMode kill_mode_from_string(const char *s); #endif