unit.h

   1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
   2
   3 #ifndef foounithfoo
   4 #define foounithfoo
   5
   6 /***
   7   This file is part of systemd.
   8
   9   Copyright 2010 Lennart Poettering
  10
  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.
  15
  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.
  20
  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/>.
  23 ***/
  24
  25 #include <stdbool.h>
  26 #include <stdlib.h>
  27
  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;
  35
  36 #include "set.h"
  37 #include "util.h"
  38 #include "list.h"
  39 #include "socket-util.h"
  40 #include "execute.h"
  41
  42 #define UNIT_NAME_MAX 128
  43 #define DEFAULT_TIMEOUT_USEC (20*USEC_PER_SEC)
  44 #define DEFAULT_RESTART_USEC (100*USEC_PER_MSEC)
  45
  46 typedef enum KillMode {
  47         KILL_CONTROL_GROUP = 0,
  48         KILL_PROCESS_GROUP,
  49         KILL_PROCESS,
  50         KILL_NONE,
  51         _KILL_MODE_MAX,
  52         _KILL_MODE_INVALID = -1
  53 } KillMode;
  54
  55 enum UnitType {
  56         UNIT_SERVICE = 0,
  57         UNIT_SOCKET,
  58         UNIT_TARGET,
  59         UNIT_DEVICE,
  60         UNIT_MOUNT,
  61         UNIT_AUTOMOUNT,
  62         UNIT_SNAPSHOT,
  63         UNIT_TIMER,
  64         _UNIT_TYPE_MAX,
  65         _UNIT_TYPE_INVALID = -1
  66 };
  67
  68 enum UnitLoadState {
  69         UNIT_STUB,
  70         UNIT_LOADED,
  71         UNIT_FAILED,
  72         UNIT_MERGED,
  73         _UNIT_LOAD_STATE_MAX,
  74         _UNIT_LOAD_STATE_INVALID = -1
  75 };
  76
  77 enum UnitActiveState {
  78         UNIT_ACTIVE,
  79         UNIT_ACTIVE_RELOADING,
  80         UNIT_INACTIVE,
  81         UNIT_ACTIVATING,
  82         UNIT_DEACTIVATING,
  83         _UNIT_ACTIVE_STATE_MAX,
  84         _UNIT_ACTIVE_STATE_INVALID = -1
  85 };
  86
  87 static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t) {
  88         return t == UNIT_ACTIVE || t == UNIT_ACTIVE_RELOADING;
  89 }
  90
  91 static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t) {
  92         return t == UNIT_ACTIVE || t == UNIT_ACTIVATING || t == UNIT_ACTIVE_RELOADING;
  93 }
  94
  95 static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t) {
  96         return t == UNIT_INACTIVE || t == UNIT_DEACTIVATING;
  97 }
  98
  99 enum UnitDependency {
 100         /* Positive dependencies */
 101         UNIT_REQUIRES,
 102         UNIT_REQUIRES_OVERRIDABLE,
 103         UNIT_REQUISITE,
 104         UNIT_REQUISITE_OVERRIDABLE,
 105         UNIT_WANTS,
 106
 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' */
 111
 112         /* Negative dependencies */
 113         UNIT_CONFLICTS,               /* inverse of 'conflicts' is 'conflicts' */
 114
 115         /* Order */
 116         UNIT_BEFORE,                  /* inverse of before is after and vice versa */
 117         UNIT_AFTER,
 118
 119         _UNIT_DEPENDENCY_MAX,
 120         _UNIT_DEPENDENCY_INVALID = -1
 121 };
 122
 123 #include "manager.h"
 124 #include "job.h"
 125 #include "cgroup.h"
 126
 127 struct Meta {
 128         Manager *manager;
 129
 130         UnitType type;
 131         UnitLoadState load_state;
 132         Unit *merged_into;
 133
 134         char *id; /* One name is special because we use it for identification. Points to an entry in the names set */
 135         char *instance;
 136
 137         Set *names;
 138         Set *dependencies[_UNIT_DEPENDENCY_MAX];
 139
 140         char *description;
 141         char *fragment_path; /* if loaded from a config file this is the primary path to it */
 142
 143         /* If there is something to do with this unit, then this is
 144          * the job for it */
 145         Job *job;
 146
 147         bool in_load_queue:1;
 148         bool in_dbus_queue:1;
 149         bool in_cleanup_queue:1;
 150         bool sent_dbus_new_signal:1;
 151
 152         /* If we go down, pull down everything that depends on us, too */
 153         bool recursive_stop;
 154
 155         /* Garbage collect us we nobody wants or requires us anymore */
 156         bool stop_when_unneeded;
 157
 158         usec_t active_enter_timestamp;
 159         usec_t active_exit_timestamp;
 160
 161         /* Counterparts in the cgroup filesystem */
 162         CGroupBonding *cgroup_bondings;
 163
 164         /* Load queue */
 165         LIST_FIELDS(Meta, load_queue);
 166
 167         /* Per type list */
 168         LIST_FIELDS(Meta, units_per_type);
 169
 170         /* D-Bus queue */
 171         LIST_FIELDS(Meta, dbus_queue);
 172
 173         /* Cleanup queue */
 174         LIST_FIELDS(Meta, cleanup_queue);
 175 };
 176
 177 #include "service.h"
 178 #include "timer.h"
 179 #include "socket.h"
 180 #include "target.h"
 181 #include "device.h"
 182 #include "mount.h"
 183 #include "automount.h"
 184 #include "snapshot.h"
 185
 186 union Unit {
 187         Meta meta;
 188         Service service;
 189         Timer timer;
 190         Socket socket;
 191         Target target;
 192         Device device;
 193         Mount mount;
 194         Automount automount;
 195         Snapshot snapshot;
 196 };
 197
 198 struct UnitVTable {
 199         const char *suffix;
 200
 201         /* Can units of this type have multiple names? */
 202         bool no_alias:1;
 203
 204         /* If true units of this types can never have "Requires"
 205          * dependencies, because state changes can only be observed,
 206          * not triggered */
 207         bool no_requires:1;
 208
 209         /* Instances make no sense for this type */
 210         bool no_instances:1;
 211
 212         /* Exclude this type from snapshots */
 213         bool no_snapshots:1;
 214
 215         /* This should reset all type-specific variables. This should
 216          * not allocate memory, and is called with zero-initialized
 217          * data. It should hence only initialize variables that need
 218          * to be set != 0. */
 219         void (*init)(Unit *u);
 220
 221         /* This should free all type-specific variables. It should be
 222          * idempotent. */
 223         void (*done)(Unit *u);
 224
 225         /* Actually load data from disk. This may fail, and should set
 226          * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
 227          * UNIT_STUB if no configuration could be found. */
 228         int (*load)(Unit *u);
 229
 230         /* If a a lot of units got created via enumerate(), this is
 231          * where to actually set the state and call unit_notify(). */
 232         int (*coldplug)(Unit *u);
 233
 234         void (*dump)(Unit *u, FILE *f, const char *prefix);
 235
 236         int (*start)(Unit *u);
 237         int (*stop)(Unit *u);
 238         int (*reload)(Unit *u);
 239
 240         bool (*can_reload)(Unit *u);
 241
 242         /* Write all data that cannot be restored from other sources
 243          * away using unit_serialize_item() */
 244         int (*serialize)(Unit *u, FILE *f, FDSet *fds);
 245
 246         /* Restore one item from the serialization */
 247         int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds);
 248
 249         /* Boils down the more complex internal state of this unit to
 250          * a simpler one that the engine can understand */
 251         UnitActiveState (*active_state)(Unit *u);
 252
 253         /* Returns the substate specific to this unit type as
 254          * string. This is purely information so that we can give the
 255          * user a more finegrained explanation in which actual state a
 256          * unit is in. */
 257         const char* (*sub_state_to_string)(Unit *u);
 258
 259         void (*fd_event)(Unit *u, int fd, uint32_t events, Watch *w);
 260         void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
 261         void (*timer_event)(Unit *u, uint64_t n_elapsed, Watch *w);
 262
 263         /* Called whenever any of the cgroups this unit watches for
 264          * ran empty */
 265         void (*cgroup_notify_empty)(Unit *u);
 266
 267         /* Called whenever a name thus Unit registered for comes or
 268          * goes away. */
 269         void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner);
 270
 271         /* Called whenever a bus PID lookup finishes */
 272         void (*bus_query_pid_done)(Unit *u, const char *name, pid_t pid);
 273
 274         /* Called for each message received on the bus */
 275         DBusHandlerResult (*bus_message_handler)(Unit *u, DBusMessage *message);
 276
 277         /* This is called for each unit type and should be used to
 278          * enumerate existing devices and load them. However,
 279          * everything that is loaded here should still stay in
 280          * inactive state. It is the job of the coldplug() call above
 281          * to put the units into the initial state.  */
 282         int (*enumerate)(Manager *m);
 283
 284         /* Type specific cleanups. */
 285         void (*shutdown)(Manager *m);
 286 };
 287
 288 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
 289
 290 #define UNIT_VTABLE(u) unit_vtable[(u)->meta.type]
 291
 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)             \
 296                         return NULL;                                    \
 297                                                                         \
 298                 return (MixedCase*) u;                                  \
 299         }
 300
 301 /* For casting the various unit types into a unit */
 302 #define UNIT(u) ((Unit*) (u))
 303
 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);
 312
 313 Unit *unit_new(Manager *m);
 314 void unit_free(Unit *u);
 315
 316 int unit_add_name(Unit *u, const char *name);
 317
 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);
 321
 322 int unit_add_exec_dependencies(Unit *u, ExecContext *c);
 323
 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);
 328
 329 int unit_choose_id(Unit *u, const char *name);
 330 int unit_set_description(Unit *u, const char *description);
 331
 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);
 335
 336 int unit_merge(Unit *u, Unit *other);
 337 int unit_merge_by_name(Unit *u, const char *other);
 338
 339 Unit *unit_follow_merge(Unit *u);
 340
 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);
 345
 346 const char *unit_description(Unit *u);
 347
 348 bool unit_has_name(Unit *u, const char *name);
 349
 350 UnitActiveState unit_active_state(Unit *u);
 351
 352 const char* unit_sub_state_to_string(Unit *u);
 353
 354 void unit_dump(Unit *u, FILE *f, const char *prefix);
 355
 356 bool unit_can_reload(Unit *u);
 357 bool unit_can_start(Unit *u);
 358
 359 int unit_start(Unit *u);
 360 int unit_stop(Unit *u);
 361 int unit_reload(Unit *u);
 362
 363 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns);
 364
 365 int unit_watch_fd(Unit *u, int fd, uint32_t events, Watch *w);
 366 void unit_unwatch_fd(Unit *u, Watch *w);
 367
 368 int unit_watch_pid(Unit *u, pid_t pid);
 369 void unit_unwatch_pid(Unit *u, pid_t pid);
 370
 371 int unit_watch_timer(Unit *u, usec_t delay, Watch *w);
 372 void unit_unwatch_timer(Unit *u, Watch *w);
 373
 374 int unit_watch_bus_name(Unit *u, const char *name);
 375 void unit_unwatch_bus_name(Unit *u, const char *name);
 376
 377 bool unit_job_is_applicable(Unit *u, JobType j);
 378
 379 int set_unit_path(const char *p);
 380
 381 char *unit_dbus_path(Unit *u);
 382
 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);
 385
 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);
 389
 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);
 395
 396 const char *unit_type_to_string(UnitType i);
 397 UnitType unit_type_from_string(const char *s);
 398
 399 const char *unit_load_state_to_string(UnitLoadState i);
 400 UnitLoadState unit_load_state_from_string(const char *s);
 401
 402 const char *unit_active_state_to_string(UnitActiveState i);
 403 UnitActiveState unit_active_state_from_string(const char *s);
 404
 405 const char *unit_dependency_to_string(UnitDependency i);
 406 UnitDependency unit_dependency_from_string(const char *s);
 407
 408 const char *kill_mode_to_string(KillMode k);
 409 KillMode kill_mode_from_string(const char *s);
 410
 411 #endif