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