src/core/manager.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #pragma once
   4
   5 /***
   6   This file is part of systemd.
   7
   8   Copyright 2010 Lennart Poettering
   9
  10   systemd is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU Lesser General Public License as published by
  12   the Free Software Foundation; either version 2.1 of the License, or
  13   (at your option) any later version.
  14
  15   systemd is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 ***/
  23
  24 #include <stdbool.h>
  25 #include <inttypes.h>
  26 #include <stdio.h>
  27 #include <dbus/dbus.h>
  28
  29 #include "fdset.h"
  30
  31 /* Enforce upper limit how many names we allow */
  32 #define MANAGER_MAX_NAMES 131072 /* 128K */
  33
  34 typedef struct Manager Manager;
  35 typedef enum WatchType WatchType;
  36 typedef struct Watch Watch;
  37
  38 typedef enum ManagerExitCode {
  39         MANAGER_RUNNING,
  40         MANAGER_EXIT,
  41         MANAGER_RELOAD,
  42         MANAGER_REEXECUTE,
  43         MANAGER_REBOOT,
  44         MANAGER_POWEROFF,
  45         MANAGER_HALT,
  46         MANAGER_KEXEC,
  47         MANAGER_SWITCH_ROOT,
  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         /* To optimize iteration of units that have requires_mounts_for set */
 108         LIST_HEAD(Unit, has_requires_mounts_for);
 109
 110         /* Units that need to be loaded */
 111         LIST_HEAD(Unit, load_queue); /* this is actually more a stack than a queue, but uh. */
 112
 113         /* Jobs that need to be run */
 114         LIST_HEAD(Job, run_queue);   /* more a stack than a queue, too */
 115
 116         /* Units and jobs that have not yet been announced via
 117          * D-Bus. When something about a job changes it is added here
 118          * if it is not in there yet. This allows easy coalescing of
 119          * D-Bus change signals. */
 120         LIST_HEAD(Unit, dbus_unit_queue);
 121         LIST_HEAD(Job, dbus_job_queue);
 122
 123         /* Units to remove */
 124         LIST_HEAD(Unit, cleanup_queue);
 125
 126         /* Units to check when doing GC */
 127         LIST_HEAD(Unit, gc_queue);
 128
 129         Hashmap *watch_pids;  /* pid => Unit object n:1 */
 130
 131         char *notify_socket;
 132
 133         Watch notify_watch;
 134         Watch signal_watch;
 135
 136         int epoll_fd;
 137
 138         unsigned n_snapshots;
 139
 140         LookupPaths lookup_paths;
 141         Set *unit_path_cache;
 142
 143         char **environment;
 144         char **default_controllers;
 145
 146         usec_t runtime_watchdog;
 147         usec_t shutdown_watchdog;
 148
 149         dual_timestamp initrd_timestamp;
 150         dual_timestamp startup_timestamp;
 151         dual_timestamp finish_timestamp;
 152
 153         char *generator_unit_path;
 154         char *generator_unit_path_early;
 155         char *generator_unit_path_late;
 156
 157         /* Data specific to the device subsystem */
 158         struct udev* udev;
 159         struct udev_monitor* udev_monitor;
 160         Watch udev_watch;
 161         Hashmap *devices_by_sysfs;
 162
 163         /* Data specific to the mount subsystem */
 164         FILE *proc_self_mountinfo;
 165         Watch mount_watch;
 166
 167         /* Data specific to the swap filesystem */
 168         FILE *proc_swaps;
 169         Hashmap *swaps_by_proc_swaps;
 170         bool request_reload;
 171         Watch swap_watch;
 172
 173         /* Data specific to the D-Bus subsystem */
 174         DBusConnection *api_bus, *system_bus;
 175         DBusServer *private_bus;
 176         Set *bus_connections, *bus_connections_for_dispatch;
 177
 178         DBusMessage *queued_message; /* This is used during reloading:
 179                                       * before the reload we queue the
 180                                       * reply message here, and
 181                                       * afterwards we send it */
 182         DBusConnection *queued_message_connection; /* The connection to send the queued message on */
 183
 184         Hashmap *watch_bus;  /* D-Bus names => Unit object n:1 */
 185         int32_t name_data_slot;
 186         int32_t conn_data_slot;
 187         int32_t subscribed_data_slot;
 188
 189         uint32_t current_job_id;
 190         uint32_t default_unit_job_id;
 191
 192         /* Data specific to the Automount subsystem */
 193         int dev_autofs_fd;
 194
 195         /* Data specific to the cgroup subsystem */
 196         Hashmap *cgroup_bondings; /* path string => CGroupBonding object 1:n */
 197         char *cgroup_hierarchy;
 198
 199         usec_t gc_queue_timestamp;
 200         int gc_marker;
 201         unsigned n_in_gc_queue;
 202
 203         /* Make sure the user cannot accidentally unmount our cgroup
 204          * file system */
 205         int pin_cgroupfs_fd;
 206
 207         /* Audit fd */
 208 #ifdef HAVE_AUDIT
 209         int audit_fd;
 210 #endif
 211
 212         /* Flags */
 213         ManagerRunningAs running_as;
 214         ManagerExitCode exit_code:5;
 215
 216         bool dispatching_load_queue:1;
 217         bool dispatching_run_queue:1;
 218         bool dispatching_dbus_queue:1;
 219
 220         bool taint_usr:1;
 221
 222         bool show_status;
 223         bool confirm_spawn;
 224
 225         ExecOutput default_std_output, default_std_error;
 226
 227         struct rlimit *rlimit[RLIMIT_NLIMITS];
 228
 229         /* non-zero if we are reloading or reexecuting, */
 230         int n_reloading;
 231
 232         unsigned n_installed_jobs;
 233         unsigned n_failed_jobs;
 234
 235         /* Type=idle pipes */
 236         int idle_pipe[2];
 237
 238         char *switch_root;
 239         char *switch_root_init;
 240 };
 241
 242 int manager_new(ManagerRunningAs running_as, Manager **m);
 243 void manager_free(Manager *m);
 244
 245 int manager_enumerate(Manager *m);
 246 int manager_coldplug(Manager *m);
 247 int manager_startup(Manager *m, FILE *serialization, FDSet *fds);
 248
 249 Job *manager_get_job(Manager *m, uint32_t id);
 250 Unit *manager_get_unit(Manager *m, const char *name);
 251
 252 int manager_get_job_from_dbus_path(Manager *m, const char *s, Job **_j);
 253
 254 int manager_load_unit_prepare(Manager *m, const char *name, const char *path, DBusError *e, Unit **_ret);
 255 int manager_load_unit(Manager *m, const char *name, const char *path, DBusError *e, Unit **_ret);
 256 int manager_load_unit_from_dbus_path(Manager *m, const char *s, DBusError *e, Unit **_u);
 257
 258 int manager_add_job(Manager *m, JobType type, Unit *unit, JobMode mode, bool force, DBusError *e, Job **_ret);
 259 int manager_add_job_by_name(Manager *m, JobType type, const char *name, JobMode mode, bool force, DBusError *e, Job **_ret);
 260
 261 void manager_dump_units(Manager *s, FILE *f, const char *prefix);
 262 void manager_dump_jobs(Manager *s, FILE *f, const char *prefix);
 263
 264 void manager_clear_jobs(Manager *m);
 265
 266 unsigned manager_dispatch_load_queue(Manager *m);
 267 unsigned manager_dispatch_run_queue(Manager *m);
 268 unsigned manager_dispatch_dbus_queue(Manager *m);
 269
 270 int manager_set_default_controllers(Manager *m, char **controllers);
 271 int manager_set_default_rlimits(Manager *m, struct rlimit **default_rlimit);
 272
 273 int manager_loop(Manager *m);
 274
 275 void manager_dispatch_bus_name_owner_changed(Manager *m, const char *name, const char* old_owner, const char *new_owner);
 276 void manager_dispatch_bus_query_pid_done(Manager *m, const char *name, pid_t pid);
 277
 278 int manager_open_serialization(Manager *m, FILE **_f);
 279
 280 int manager_serialize(Manager *m, FILE *f, FDSet *fds, bool serialize_jobs);
 281 int manager_deserialize(Manager *m, FILE *f, FDSet *fds);
 282
 283 int manager_reload(Manager *m);
 284
 285 bool manager_is_booting_or_shutting_down(Manager *m);
 286
 287 void manager_reset_failed(Manager *m);
 288
 289 void manager_send_unit_audit(Manager *m, Unit *u, int type, bool success);
 290 void manager_send_unit_plymouth(Manager *m, Unit *u);
 291
 292 bool manager_unit_pending_inactive(Manager *m, const char *name);
 293
 294 void manager_check_finished(Manager *m);
 295
 296 void manager_run_generators(Manager *m);
 297 void manager_undo_generators(Manager *m);
 298
 299 void manager_recheck_journal(Manager *m);
 300
 301 void manager_set_show_status(Manager *m, bool b);
 302 bool manager_get_show_status(Manager *m);
 303
 304 const char *manager_running_as_to_string(ManagerRunningAs i);
 305 ManagerRunningAs manager_running_as_from_string(const char *s);