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 enum WatchType {
  53         WATCH_INVALID,
  54         WATCH_SIGNAL,
  55         WATCH_NOTIFY,
  56         WATCH_FD,
  57         WATCH_UNIT_TIMER,
  58         WATCH_JOB_TIMER,
  59         WATCH_MOUNT,
  60         WATCH_SWAP,
  61         WATCH_UDEV,
  62         WATCH_DBUS_WATCH,
  63         WATCH_DBUS_TIMEOUT,
  64         WATCH_TIME_CHANGE,
  65         WATCH_JOBS_IN_PROGRESS
  66 };
  67
  68 struct Watch {
  69         int fd;
  70         WatchType type;
  71         union {
  72                 struct Unit *unit;
  73                 struct Job *job;
  74                 DBusWatch *bus_watch;
  75                 DBusTimeout *bus_timeout;
  76         } data;
  77         bool fd_is_dupped:1;
  78         bool socket_accept:1;
  79 };
  80
  81 #include "unit.h"
  82 #include "job.h"
  83 #include "hashmap.h"
  84 #include "list.h"
  85 #include "set.h"
  86 #include "dbus.h"
  87 #include "path-lookup.h"
  88 #include "execute.h"
  89
  90 struct Manager {
  91         /* Note that the set of units we know of is allowed to be
  92          * inconsistent. However the subset of it that is loaded may
  93          * not, and the list of jobs may neither. */
  94
  95         /* Active jobs and units */
  96         Hashmap *units;  /* name string => Unit object n:1 */
  97         Hashmap *jobs;   /* job id => Job object 1:1 */
  98
  99         /* To make it easy to iterate through the units of a specific
 100          * type we maintain a per type linked list */
 101         LIST_HEAD(Unit, units_by_type[_UNIT_TYPE_MAX]);
 102
 103         /* To optimize iteration of units that have requires_mounts_for set */
 104         LIST_HEAD(Unit, has_requires_mounts_for);
 105
 106         /* Units that need to be loaded */
 107         LIST_HEAD(Unit, load_queue); /* this is actually more a stack than a queue, but uh. */
 108
 109         /* Jobs that need to be run */
 110         LIST_HEAD(Job, run_queue);   /* more a stack than a queue, too */
 111
 112         /* Units and jobs that have not yet been announced via
 113          * D-Bus. When something about a job changes it is added here
 114          * if it is not in there yet. This allows easy coalescing of
 115          * D-Bus change signals. */
 116         LIST_HEAD(Unit, dbus_unit_queue);
 117         LIST_HEAD(Job, dbus_job_queue);
 118
 119         /* Units to remove */
 120         LIST_HEAD(Unit, cleanup_queue);
 121
 122         /* Units to check when doing GC */
 123         LIST_HEAD(Unit, gc_queue);
 124
 125         Hashmap *watch_pids;  /* pid => Unit object n:1 */
 126
 127         char *notify_socket;
 128
 129         Watch notify_watch;
 130         Watch signal_watch;
 131         Watch time_change_watch;
 132         Watch jobs_in_progress_watch;
 133
 134         int epoll_fd;
 135
 136         unsigned n_snapshots;
 137
 138         LookupPaths lookup_paths;
 139         Set *unit_path_cache;
 140
 141         char **environment;
 142         char **default_controllers;
 143
 144         usec_t runtime_watchdog;
 145         usec_t shutdown_watchdog;
 146
 147         dual_timestamp firmware_timestamp;
 148         dual_timestamp loader_timestamp;
 149         dual_timestamp kernel_timestamp;
 150         dual_timestamp initrd_timestamp;
 151         dual_timestamp userspace_timestamp;
 152         dual_timestamp finish_timestamp;
 153         dual_timestamp generators_start_timestamp;
 154         dual_timestamp generators_finish_timestamp;
 155         dual_timestamp unitsload_start_timestamp;
 156         dual_timestamp unitsload_finish_timestamp;
 157
 158         char *generator_unit_path;
 159         char *generator_unit_path_early;
 160         char *generator_unit_path_late;
 161
 162         /* Data specific to the device subsystem */
 163         struct udev* udev;
 164         struct udev_monitor* udev_monitor;
 165         Watch udev_watch;
 166         Hashmap *devices_by_sysfs;
 167
 168         /* Data specific to the mount subsystem */
 169         FILE *proc_self_mountinfo;
 170         Watch mount_watch;
 171
 172         /* Data specific to the swap filesystem */
 173         FILE *proc_swaps;
 174         Hashmap *swaps_by_proc_swaps;
 175         bool request_reload;
 176         Watch swap_watch;
 177
 178         /* Data specific to the D-Bus subsystem */
 179         DBusConnection *api_bus, *system_bus;
 180         DBusServer *private_bus;
 181         Set *bus_connections, *bus_connections_for_dispatch;
 182
 183         DBusMessage *queued_message; /* This is used during reloading:
 184                                       * before the reload we queue the
 185                                       * reply message here, and
 186                                       * afterwards we send it */
 187         DBusConnection *queued_message_connection; /* The connection to send the queued message on */
 188
 189         Hashmap *watch_bus;  /* D-Bus names => Unit object n:1 */
 190         int32_t name_data_slot;
 191         int32_t conn_data_slot;
 192         int32_t subscribed_data_slot;
 193
 194         uint32_t current_job_id;
 195         uint32_t default_unit_job_id;
 196
 197         /* Data specific to the Automount subsystem */
 198         int dev_autofs_fd;
 199
 200         /* Data specific to the cgroup subsystem */
 201         Hashmap *cgroup_bondings; /* path string => CGroupBonding object 1:n */
 202         char *cgroup_root;
 203
 204         usec_t gc_queue_timestamp;
 205         int gc_marker;
 206         unsigned n_in_gc_queue;
 207
 208         /* Make sure the user cannot accidentally unmount our cgroup
 209          * file system */
 210         int pin_cgroupfs_fd;
 211
 212         /* Flags */
 213         SystemdRunningAs 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         /* Jobs in progress watching */
 236         unsigned n_running_jobs;
 237         unsigned n_on_console;
 238         unsigned jobs_in_progress_iteration;
 239
 240         /* Type=idle pipes */
 241         int idle_pipe[2];
 242
 243         char *switch_root;
 244         char *switch_root_init;
 245 };
 246
 247 int manager_new(SystemdRunningAs running_as, Manager **m);
 248 void manager_free(Manager *m);
 249
 250 int manager_enumerate(Manager *m);
 251 int manager_coldplug(Manager *m);
 252 int manager_startup(Manager *m, FILE *serialization, FDSet *fds);
 253
 254 Job *manager_get_job(Manager *m, uint32_t id);
 255 Unit *manager_get_unit(Manager *m, const char *name);
 256
 257 int manager_get_job_from_dbus_path(Manager *m, const char *s, Job **_j);
 258
 259 int manager_load_unit_prepare(Manager *m, const char *name, const char *path, DBusError *e, Unit **_ret);
 260 int manager_load_unit(Manager *m, const char *name, const char *path, DBusError *e, Unit **_ret);
 261 int manager_load_unit_from_dbus_path(Manager *m, const char *s, DBusError *e, Unit **_u);
 262
 263 int manager_add_job(Manager *m, JobType type, Unit *unit, JobMode mode, bool force, DBusError *e, Job **_ret);
 264 int manager_add_job_by_name(Manager *m, JobType type, const char *name, JobMode mode, bool force, DBusError *e, Job **_ret);
 265
 266 void manager_dump_units(Manager *s, FILE *f, const char *prefix);
 267 void manager_dump_jobs(Manager *s, FILE *f, const char *prefix);
 268
 269 void manager_clear_jobs(Manager *m);
 270
 271 unsigned manager_dispatch_load_queue(Manager *m);
 272 unsigned manager_dispatch_run_queue(Manager *m);
 273 unsigned manager_dispatch_dbus_queue(Manager *m);
 274
 275 int manager_set_default_controllers(Manager *m, char **controllers);
 276 int manager_set_default_rlimits(Manager *m, struct rlimit **default_rlimit);
 277
 278 int manager_loop(Manager *m);
 279
 280 void manager_dispatch_bus_name_owner_changed(Manager *m, const char *name, const char* old_owner, const char *new_owner);
 281 void manager_dispatch_bus_query_pid_done(Manager *m, const char *name, pid_t pid);
 282
 283 int manager_open_serialization(Manager *m, FILE **_f);
 284
 285 int manager_serialize(Manager *m, FILE *f, FDSet *fds, bool switching_root);
 286 int manager_deserialize(Manager *m, FILE *f, FDSet *fds);
 287 int manager_distribute_fds(Manager *m, FDSet *fds);
 288
 289 int manager_reload(Manager *m);
 290
 291 bool manager_is_reloading_or_reexecuting(Manager *m) _pure_;
 292
 293 void manager_reset_failed(Manager *m);
 294
 295 void manager_send_unit_audit(Manager *m, Unit *u, int type, bool success);
 296 void manager_send_unit_plymouth(Manager *m, Unit *u);
 297
 298 bool manager_unit_inactive_or_pending(Manager *m, const char *name);
 299
 300 void manager_check_finished(Manager *m);
 301
 302 void manager_run_generators(Manager *m);
 303 void manager_undo_generators(Manager *m);
 304
 305 void manager_recheck_journal(Manager *m);
 306
 307 void manager_set_show_status(Manager *m, bool b);
 308 void manager_status_printf(Manager *m, bool ephemeral, const char *status, const char *format, ...) _printf_attr_(4,5);
 309
 310 void watch_init(Watch *w);