1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
7 This file is part of systemd.
9 Copyright 2010 Lennart Poettering
11 systemd is free software; you can redistribute it and/or modify it
12 under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 2 of the License, or
14 (at your option) any later version.
16 systemd is distributed in the hope that it will be useful, but
17 WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 General Public License for more details.
21 You should have received a copy of the GNU General Public License
22 along with systemd; If not, see <http://www.gnu.org/licenses/>.
28 typedef union Unit Unit;
29 typedef struct Meta Meta;
30 typedef struct UnitVTable UnitVTable;
31 typedef enum UnitType UnitType;
32 typedef enum UnitLoadState UnitLoadState;
33 typedef enum UnitActiveState UnitActiveState;
34 typedef enum UnitDependency UnitDependency;
39 #include "socket-util.h"
42 #define UNIT_NAME_MAX 128
43 #define DEFAULT_TIMEOUT_USEC (20*USEC_PER_SEC)
44 #define DEFAULT_RESTART_USEC (100*USEC_PER_MSEC)
46 typedef enum KillMode {
47 KILL_CONTROL_GROUP = 0,
52 _KILL_MODE_INVALID = -1
65 _UNIT_TYPE_INVALID = -1
74 _UNIT_LOAD_STATE_INVALID = -1
77 enum UnitActiveState {
79 UNIT_ACTIVE_RELOADING,
83 _UNIT_ACTIVE_STATE_MAX,
84 _UNIT_ACTIVE_STATE_INVALID = -1
87 static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t) {
88 return t == UNIT_ACTIVE || t == UNIT_ACTIVE_RELOADING;
91 static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t) {
92 return t == UNIT_ACTIVE || t == UNIT_ACTIVATING || t == UNIT_ACTIVE_RELOADING;
95 static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t) {
96 return t == UNIT_INACTIVE || t == UNIT_DEACTIVATING;
100 /* Positive dependencies */
102 UNIT_REQUIRES_OVERRIDABLE,
104 UNIT_REQUISITE_OVERRIDABLE,
107 /* Inverse of the above */
108 UNIT_REQUIRED_BY, /* inverse of 'requires' and 'requisite' is 'required_by' */
109 UNIT_REQUIRED_BY_OVERRIDABLE, /* inverse of 'soft_requires' and 'soft_requisite' is 'soft_required_by' */
110 UNIT_WANTED_BY, /* inverse of 'wants' */
112 /* Negative dependencies */
113 UNIT_CONFLICTS, /* inverse of 'conflicts' is 'conflicts' */
116 UNIT_BEFORE, /* inverse of before is after and vice versa */
119 _UNIT_DEPENDENCY_MAX,
120 _UNIT_DEPENDENCY_INVALID = -1
131 UnitLoadState load_state;
134 char *id; /* One name is special because we use it for identification. Points to an entry in the names set */
138 Set *dependencies[_UNIT_DEPENDENCY_MAX];
141 char *fragment_path; /* if loaded from a config file this is the primary path to it */
143 /* If there is something to do with this unit, then this is
147 usec_t active_enter_timestamp;
148 usec_t active_exit_timestamp;
150 /* Counterparts in the cgroup filesystem */
151 CGroupBonding *cgroup_bondings;
154 LIST_FIELDS(Meta, load_queue);
157 LIST_FIELDS(Meta, units_per_type);
160 LIST_FIELDS(Meta, dbus_queue);
163 LIST_FIELDS(Meta, cleanup_queue);
165 /* If we go down, pull down everything that depends on us, too */
168 /* Garbage collect us we nobody wants or requires us anymore */
169 bool stop_when_unneeded;
171 bool in_load_queue:1;
172 bool in_dbus_queue:1;
173 bool in_cleanup_queue:1;
174 bool sent_dbus_new_signal:1;
183 #include "automount.h"
184 #include "snapshot.h"
201 /* This should reset all type-specific variables. This should
202 * not allocate memory, and is called with zero-initialized
203 * data. It should hence only initialize variables that need
205 void (*init)(Unit *u);
207 /* This should free all type-specific variables. It should be
209 void (*done)(Unit *u);
211 /* Actually load data from disk. This may fail, and should set
212 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
213 * UNIT_STUB if no configuration could be found. */
214 int (*load)(Unit *u);
216 /* If a a lot of units got created via enumerate(), this is
217 * where to actually set the state and call unit_notify(). */
218 int (*coldplug)(Unit *u);
220 void (*dump)(Unit *u, FILE *f, const char *prefix);
222 int (*start)(Unit *u);
223 int (*stop)(Unit *u);
224 int (*reload)(Unit *u);
226 bool (*can_reload)(Unit *u);
228 /* Write all data that cannot be restored from other sources
229 * away using unit_serialize_item() */
230 int (*serialize)(Unit *u, FILE *f, FDSet *fds);
232 /* Restore one item from the serialization */
233 int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds);
235 /* Boils down the more complex internal state of this unit to
236 * a simpler one that the engine can understand */
237 UnitActiveState (*active_state)(Unit *u);
239 /* Returns the substate specific to this unit type as
240 * string. This is purely information so that we can give the
241 * user a more finegrained explanation in which actual state a
243 const char* (*sub_state_to_string)(Unit *u);
245 void (*fd_event)(Unit *u, int fd, uint32_t events, Watch *w);
246 void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
247 void (*timer_event)(Unit *u, uint64_t n_elapsed, Watch *w);
249 /* Called whenever any of the cgroups this unit watches for
251 void (*cgroup_notify_empty)(Unit *u);
253 /* Called whenever a name thus Unit registered for comes or
255 void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner);
257 /* Called whenever a bus PID lookup finishes */
258 void (*bus_query_pid_done)(Unit *u, const char *name, pid_t pid);
260 /* Called for each message received on the bus */
261 DBusHandlerResult (*bus_message_handler)(Unit *u, DBusMessage *message);
263 /* This is called for each unit type and should be used to
264 * enumerate existing devices and load them. However,
265 * everything that is loaded here should still stay in
266 * inactive state. It is the job of the coldplug() call above
267 * to put the units into the initial state. */
268 int (*enumerate)(Manager *m);
270 /* Type specific cleanups. */
271 void (*shutdown)(Manager *m);
273 /* Can units of this type have multiple names? */
276 /* If true units of this types can never have "Requires"
277 * dependencies, because state changes can only be observed,
281 /* Instances make no sense for this type */
284 /* Exclude this type from snapshots */
288 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
290 #define UNIT_VTABLE(u) unit_vtable[(u)->meta.type]
292 /* For casting a unit into the various unit types */
293 #define DEFINE_CAST(UPPERCASE, MixedCase) \
294 static inline MixedCase* UPPERCASE(Unit *u) { \
295 if (!u || u->meta.type != UNIT_##UPPERCASE) \
298 return (MixedCase*) u; \
301 /* For casting the various unit types into a unit */
302 #define UNIT(u) ((Unit*) (u))
304 DEFINE_CAST(SOCKET, Socket);
305 DEFINE_CAST(TIMER, Timer);
306 DEFINE_CAST(SERVICE, Service);
307 DEFINE_CAST(TARGET, Target);
308 DEFINE_CAST(DEVICE, Device);
309 DEFINE_CAST(MOUNT, Mount);
310 DEFINE_CAST(AUTOMOUNT, Automount);
311 DEFINE_CAST(SNAPSHOT, Snapshot);
313 Unit *unit_new(Manager *m);
314 void unit_free(Unit *u);
316 int unit_add_name(Unit *u, const char *name);
318 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other);
319 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename);
320 int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *filename);
322 int unit_add_exec_dependencies(Unit *u, ExecContext *c);
324 int unit_add_cgroup(Unit *u, CGroupBonding *b);
325 int unit_add_cgroup_from_text(Unit *u, const char *name);
326 int unit_add_default_cgroup(Unit *u);
327 CGroupBonding* unit_get_default_cgroup(Unit *u);
329 int unit_choose_id(Unit *u, const char *name);
330 int unit_set_description(Unit *u, const char *description);
332 void unit_add_to_load_queue(Unit *u);
333 void unit_add_to_dbus_queue(Unit *u);
334 void unit_add_to_cleanup_queue(Unit *u);
336 int unit_merge(Unit *u, Unit *other);
337 int unit_merge_by_name(Unit *u, const char *other);
339 Unit *unit_follow_merge(Unit *u);
341 int unit_load_fragment_and_dropin(Unit *u);
342 int unit_load_fragment_and_dropin_optional(Unit *u);
343 int unit_load_nop(Unit *u);
344 int unit_load(Unit *unit);
346 const char *unit_description(Unit *u);
348 bool unit_has_name(Unit *u, const char *name);
350 UnitActiveState unit_active_state(Unit *u);
352 const char* unit_sub_state_to_string(Unit *u);
354 void unit_dump(Unit *u, FILE *f, const char *prefix);
356 bool unit_can_reload(Unit *u);
357 bool unit_can_start(Unit *u);
359 int unit_start(Unit *u);
360 int unit_stop(Unit *u);
361 int unit_reload(Unit *u);
363 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns);
365 int unit_watch_fd(Unit *u, int fd, uint32_t events, Watch *w);
366 void unit_unwatch_fd(Unit *u, Watch *w);
368 int unit_watch_pid(Unit *u, pid_t pid);
369 void unit_unwatch_pid(Unit *u, pid_t pid);
371 int unit_watch_timer(Unit *u, usec_t delay, Watch *w);
372 void unit_unwatch_timer(Unit *u, Watch *w);
374 int unit_watch_bus_name(Unit *u, const char *name);
375 void unit_unwatch_bus_name(Unit *u, const char *name);
377 bool unit_job_is_applicable(Unit *u, JobType j);
379 int set_unit_path(const char *p);
381 char *unit_dbus_path(Unit *u);
383 int unit_load_related_unit(Unit *u, const char *type, Unit **_found);
384 int unit_get_related_unit(Unit *u, const char *type, Unit **_found);
386 char *unit_name_printf(Unit *u, const char* text);
387 char *unit_full_printf(Unit *u, const char *text);
388 char **unit_full_printf_strv(Unit *u, char **l);
390 bool unit_can_serialize(Unit *u);
391 int unit_serialize(Unit *u, FILE *f, FDSet *fds);
392 void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_attr(4,5);
393 void unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value);
394 int unit_deserialize(Unit *u, FILE *f, FDSet *fds);
396 const char *unit_type_to_string(UnitType i);
397 UnitType unit_type_from_string(const char *s);
399 const char *unit_load_state_to_string(UnitLoadState i);
400 UnitLoadState unit_load_state_from_string(const char *s);
402 const char *unit_active_state_to_string(UnitActiveState i);
403 UnitActiveState unit_active_state_from_string(const char *s);
405 const char *unit_dependency_to_string(UnitDependency i);
406 UnitDependency unit_dependency_from_string(const char *s);
408 const char *kill_mode_to_string(KillMode k);
409 KillMode kill_mode_from_string(const char *s);