src/core/manager.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #ifndef foomanagerhfoo
   4 #define foomanagerhfoo
   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 Lesser General Public License as published by
  13   the Free Software Foundation; either version 2.1 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   Lesser General Public License for more details.
  20
  21   You should have received a copy of the GNU Lesser General Public License
  22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  23 ***/
  24
  25 #include <stdbool.h>
  26 #include <inttypes.h>
  27 #include <stdio.h>
  28 #include <dbus/dbus.h>
  29
  30 #include "fdset.h"
  31
  32 /* Enforce upper limit how many names we allow */
  33 #define MANAGER_MAX_NAMES 131072 /* 128K */
  34
  35 typedef struct Manager Manager;
  36 typedef enum WatchType WatchType;
  37 typedef struct Watch Watch;
  38
  39 typedef enum ManagerExitCode {
  40         MANAGER_RUNNING,
  41         MANAGER_EXIT,
  42         MANAGER_RELOAD,
  43         MANAGER_REEXECUTE,
  44         MANAGER_REBOOT,
  45         MANAGER_POWEROFF,
  46         MANAGER_HALT,
  47         MANAGER_KEXEC,
  48         _MANAGER_EXIT_CODE_MAX,
  49         _MANAGER_EXIT_CODE_INVALID = -1
  50 } ManagerExitCode;
  51
  52 typedef enum ManagerRunningAs {
  53         MANAGER_SYSTEM,
  54         MANAGER_USER,
  55         _MANAGER_RUNNING_AS_MAX,
  56         _MANAGER_RUNNING_AS_INVALID = -1
  57 } ManagerRunningAs;
  58
  59 enum WatchType {
  60         WATCH_INVALID,
  61         WATCH_SIGNAL,
  62         WATCH_NOTIFY,
  63         WATCH_FD,
  64         WATCH_UNIT_TIMER,
  65         WATCH_JOB_TIMER,
  66         WATCH_MOUNT,
  67         WATCH_SWAP,
  68         WATCH_UDEV,
  69         WATCH_DBUS_WATCH,
  70         WATCH_DBUS_TIMEOUT
  71 };
  72
  73 struct Watch {
  74         int fd;
  75         WatchType type;
  76         union {
  77                 struct Unit *unit;
  78                 struct Job *job;
  79                 DBusWatch *bus_watch;
  80                 DBusTimeout *bus_timeout;
  81         } data;
  82         bool fd_is_dupped:1;
  83         bool socket_accept:1;
  84 };
  85
  86 #include "unit.h"
  87 #include "job.h"
  88 #include "hashmap.h"
  89 #include "list.h"
  90 #include "set.h"
  91 #include "dbus.h"
  92 #include "path-lookup.h"
  93
  94 struct Manager {
  95         /* Note that the set of units we know of is allowed to be
  96          * inconsistent. However the subset of it that is loaded may
  97          * not, and the list of jobs may neither. */
  98
  99         /* Active jobs and units */
 100         Hashmap *units;  /* name string => Unit object n:1 */
 101         Hashmap *jobs;   /* job id => Job object 1:1 */
 102
 103         /* To make it easy to iterate through the units of a specific
 104          * type we maintain a per type linked list */
 105         LIST_HEAD(Unit, units_by_type[_UNIT_TYPE_MAX]);
 106
 107         /* Units that need to be loaded */
 108         LIST_HEAD(Unit, load_queue); /* this is actually more a stack than a queue, but uh. */
 109
 110         /* Jobs that need to be run */
 111         LIST_HEAD(Job, run_queue);   /* more a stack than a queue, too */
 112
 113         /* Units and jobs that have not yet been announced via
 114          * D-Bus. When something about a job changes it is added here
 115          * if it is not in there yet. This allows easy coalescing of
 116          * D-Bus change signals. */
 117         LIST_HEAD(Unit, dbus_unit_queue);
 118         LIST_HEAD(Job, dbus_job_queue);
 119
 120         /* Units to remove */
 121         LIST_HEAD(Unit, cleanup_queue);
 122
 123         /* Units to check when doing GC */
 124         LIST_HEAD(Unit, gc_queue);
 125
 126         /* Jobs to be added */
 127         Hashmap *transaction_jobs;      /* Unit object => Job object list 1:1 */
 128         JobDependency *transaction_anchor;
 129
 130         Hashmap *watch_pids;  /* pid => Unit object n:1 */
 131
 132         char *notify_socket;
 133
 134         Watch notify_watch;
 135         Watch signal_watch;
 136
 137         int epoll_fd;
 138
 139         unsigned n_snapshots;
 140
 141         LookupPaths lookup_paths;
 142         Set *unit_path_cache;
 143
 144         char **environment;
 145         char **default_controllers;
 146
 147         usec_t runtime_watchdog;
 148         usec_t shutdown_watchdog;
 149
 150         dual_timestamp initrd_timestamp;
 151         dual_timestamp startup_timestamp;
 152         dual_timestamp finish_timestamp;
 153
 154         char *generator_unit_path;
 155
 156         /* Data specific to the device subsystem */
 157         struct udev* udev;
 158         struct udev_monitor* udev_monitor;
 159         Watch udev_watch;
 160         Hashmap *devices_by_sysfs;
 161
 162         /* Data specific to the mount subsystem */
 163         FILE *proc_self_mountinfo;
 164         Watch mount_watch;
 165
 166         /* Data specific to the swap filesystem */
 167         FILE *proc_swaps;
 168         Hashmap *swaps_by_proc_swaps;
 169         bool request_reload;
 170         Watch swap_watch;
 171
 172         /* Data specific to the D-Bus subsystem */
 173         DBusConnection *api_bus, *system_bus;
 174         DBusServer *private_bus;
 175         Set *bus_connections, *bus_connections_for_dispatch;
 176
 177         DBusMessage *queued_message; /* This is used during reloading:
 178                                       * before the reload we queue the
 179                                       * reply message here, and
 180                                       * afterwards we send it */
 181         DBusConnection *queued_message_connection; /* The connection to send the queued message on */
 182
 183         Hashmap *watch_bus;  /* D-Bus names => Unit object n:1 */
 184         int32_t name_data_slot;
 185         int32_t conn_data_slot;
 186         int32_t subscribed_data_slot;
 187
 188         uint32_t current_job_id;
 189         uint32_t default_unit_job_id;
 190
 191         /* Data specific to the Automount subsystem */
 192         int dev_autofs_fd;
 193
 194         /* Data specific to the cgroup subsystem */
 195         Hashmap *cgroup_bondings; /* path string => CGroupBonding object 1:n */
 196         char *cgroup_hierarchy;
 197
 198         usec_t gc_queue_timestamp;
 199         int gc_marker;
 200         unsigned n_in_gc_queue;
 201
 202         /* Make sure the user cannot accidentally unmount our cgroup
 203          * file system */
 204         int pin_cgroupfs_fd;
 205
 206         /* Audit fd */
 207 #ifdef HAVE_AUDIT
 208         int audit_fd;
 209 #endif
 210
 211         /* Flags */
 212         ManagerRunningAs running_as;
 213         ManagerExitCode exit_code:5;
 214
 215         bool dispatching_load_queue:1;
 216         bool dispatching_run_queue:1;
 217         bool dispatching_dbus_queue:1;
 218
 219         bool taint_usr:1;
 220
 221         bool show_status;
 222         bool confirm_spawn;
 223 #ifdef HAVE_SYSV_COMPAT
 224         bool sysv_console;
 225 #endif
 226         bool mount_auto;
 227         bool swap_auto;
 228
 229         ExecOutput default_std_output, default_std_error;
 230
 231         /* non-zero if we are reloading or reexecuting, */
 232         int n_reloading;
 233
 234         unsigned n_installed_jobs;
 235         unsigned n_failed_jobs;
 236 };
 237
 238 int manager_new(ManagerRunningAs running_as, Manager **m);
 239 void manager_free(Manager *m);
 240
 241 int manager_enumerate(Manager *m);
 242 int manager_coldplug(Manager *m);
 243 int manager_startup(Manager *m, FILE *serialization, FDSet *fds);
 244
 245 Job *manager_get_job(Manager *m, uint32_t id);
 246 Unit *manager_get_unit(Manager *m, const char *name);
 247
 248 int manager_get_unit_from_dbus_path(Manager *m, const char *s, Unit **_u);
 249 int manager_get_job_from_dbus_path(Manager *m, const char *s, Job **_j);
 250
 251 int manager_load_unit_prepare(Manager *m, const char *name, const char *path, DBusError *e, Unit **_ret);
 252 int manager_load_unit(Manager *m, const char *name, const char *path, DBusError *e, Unit **_ret);
 253
 254 int manager_add_job(Manager *m, JobType type, Unit *unit, JobMode mode, bool force, DBusError *e, Job **_ret);
 255 int manager_add_job_by_name(Manager *m, JobType type, const char *name, JobMode mode, bool force, DBusError *e, Job **_ret);
 256
 257 void manager_dump_units(Manager *s, FILE *f, const char *prefix);
 258 void manager_dump_jobs(Manager *s, FILE *f, const char *prefix);
 259
 260 void manager_transaction_unlink_job(Manager *m, Job *j, bool delete_dependencies);
 261
 262 void manager_clear_jobs(Manager *m);
 263
 264 unsigned manager_dispatch_load_queue(Manager *m);
 265 unsigned manager_dispatch_run_queue(Manager *m);
 266 unsigned manager_dispatch_dbus_queue(Manager *m);
 267
 268 int manager_set_default_controllers(Manager *m, char **controllers);
 269
 270 int manager_loop(Manager *m);
 271
 272 void manager_dispatch_bus_name_owner_changed(Manager *m, const char *name, const char* old_owner, const char *new_owner);
 273 void manager_dispatch_bus_query_pid_done(Manager *m, const char *name, pid_t pid);
 274
 275 int manager_open_serialization(Manager *m, FILE **_f);
 276
 277 int manager_serialize(Manager *m, FILE *f, FDSet *fds);
 278 int manager_deserialize(Manager *m, FILE *f, FDSet *fds);
 279
 280 int manager_reload(Manager *m);
 281
 282 bool manager_is_booting_or_shutting_down(Manager *m);
 283
 284 void manager_reset_failed(Manager *m);
 285
 286 void manager_send_unit_audit(Manager *m, Unit *u, int type, bool success);
 287 void manager_send_unit_plymouth(Manager *m, Unit *u);
 288
 289 bool manager_unit_pending_inactive(Manager *m, const char *name);
 290
 291 void manager_check_finished(Manager *m);
 292
 293 void manager_run_generators(Manager *m);
 294 void manager_undo_generators(Manager *m);
 295
 296 void manager_recheck_journal(Manager *m);
 297
 298 void manager_set_show_status(Manager *m, bool b);
 299 bool manager_get_show_status(Manager *m);
 300
 301 const char *manager_running_as_to_string(ManagerRunningAs i);
 302 ManagerRunningAs manager_running_as_from_string(const char *s);
 303
 304 #endif