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
  28 #include "sd-bus.h"
  29 #include "sd-event.h"
  30 #include "fdset.h"
  31 #include "cgroup-util.h"
  32
  33 /* Enforce upper limit how many names we allow */
  34 #define MANAGER_MAX_NAMES 131072 /* 128K */
  35
  36 typedef struct Manager Manager;
  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 #include "unit.h"
  53 #include "job.h"
  54 #include "hashmap.h"
  55 #include "list.h"
  56 #include "set.h"
  57 #include "path-lookup.h"
  58 #include "execute.h"
  59 #include "unit-name.h"
  60
  61 struct Manager {
  62         /* Note that the set of units we know of is allowed to be
  63          * inconsistent. However the subset of it that is loaded may
  64          * not, and the list of jobs may neither. */
  65
  66         /* Active jobs and units */
  67         Hashmap *units;  /* name string => Unit object n:1 */
  68         Hashmap *jobs;   /* job id => Job object 1:1 */
  69
  70         /* To make it easy to iterate through the units of a specific
  71          * type we maintain a per type linked list */
  72         LIST_HEAD(Unit, units_by_type[_UNIT_TYPE_MAX]);
  73
  74         /* Units that need to be loaded */
  75         LIST_HEAD(Unit, load_queue); /* this is actually more a stack than a queue, but uh. */
  76
  77         /* Jobs that need to be run */
  78         LIST_HEAD(Job, run_queue);   /* more a stack than a queue, too */
  79
  80         /* Units and jobs that have not yet been announced via
  81          * D-Bus. When something about a job changes it is added here
  82          * if it is not in there yet. This allows easy coalescing of
  83          * D-Bus change signals. */
  84         LIST_HEAD(Unit, dbus_unit_queue);
  85         LIST_HEAD(Job, dbus_job_queue);
  86
  87         /* Units to remove */
  88         LIST_HEAD(Unit, cleanup_queue);
  89
  90         /* Units to check when doing GC */
  91         LIST_HEAD(Unit, gc_queue);
  92
  93         /* Units that should be realized */
  94         LIST_HEAD(Unit, cgroup_queue);
  95
  96         sd_event *event;
  97
  98         Hashmap *watch_pids;  /* pid => Unit object n:1 */
  99
 100         sd_event_source *run_queue_event_source;
 101
 102         char *notify_socket;
 103         int notify_fd;
 104         sd_event_source *notify_event_source;
 105
 106         int signal_fd;
 107         sd_event_source *signal_event_source;
 108
 109         int time_change_fd;
 110         sd_event_source *time_change_event_source;
 111
 112         sd_event_source *jobs_in_progress_event_source;
 113
 114         unsigned n_snapshots;
 115
 116         LookupPaths lookup_paths;
 117         Set *unit_path_cache;
 118
 119         char **environment;
 120
 121         usec_t runtime_watchdog;
 122         usec_t shutdown_watchdog;
 123
 124         dual_timestamp firmware_timestamp;
 125         dual_timestamp loader_timestamp;
 126         dual_timestamp kernel_timestamp;
 127         dual_timestamp initrd_timestamp;
 128         dual_timestamp userspace_timestamp;
 129         dual_timestamp finish_timestamp;
 130         dual_timestamp security_start_timestamp;
 131         dual_timestamp security_finish_timestamp;
 132         dual_timestamp generators_start_timestamp;
 133         dual_timestamp generators_finish_timestamp;
 134         dual_timestamp units_load_start_timestamp;
 135         dual_timestamp units_load_finish_timestamp;
 136
 137         char *generator_unit_path;
 138         char *generator_unit_path_early;
 139         char *generator_unit_path_late;
 140
 141         /* Data specific to the device subsystem */
 142         struct udev* udev;
 143         struct udev_monitor* udev_monitor;
 144         sd_event_source *udev_event_source;
 145         Hashmap *devices_by_sysfs;
 146
 147         /* Data specific to the mount subsystem */
 148         FILE *proc_self_mountinfo;
 149         sd_event_source *mount_event_source;
 150
 151         /* Data specific to the swap filesystem */
 152         FILE *proc_swaps;
 153         sd_event_source *swap_event_source;
 154         Hashmap *swaps_by_proc_swaps;
 155
 156         /* Data specific to the D-Bus subsystem */
 157         sd_bus *api_bus, *system_bus;
 158         Set *private_buses;
 159         int private_listen_fd;
 160         sd_event_source *private_listen_event_source;
 161         Set *subscribed;
 162
 163         sd_bus_message *queued_message; /* This is used during reloading:
 164                                       * before the reload we queue the
 165                                       * reply message here, and
 166                                       * afterwards we send it */
 167         sd_bus *queued_message_bus; /* The connection to send the queued message on */
 168
 169         Hashmap *watch_bus;  /* D-Bus names => Unit object n:1 */
 170
 171         bool send_reloading_done;
 172
 173         uint32_t current_job_id;
 174         uint32_t default_unit_job_id;
 175
 176         /* Data specific to the Automount subsystem */
 177         int dev_autofs_fd;
 178
 179         /* Data specific to the cgroup subsystem */
 180         Hashmap *cgroup_unit;
 181         CGroupControllerMask cgroup_supported;
 182         char *cgroup_root;
 183
 184         int gc_marker;
 185         unsigned n_in_gc_queue;
 186
 187         /* Make sure the user cannot accidentally unmount our cgroup
 188          * file system */
 189         int pin_cgroupfs_fd;
 190
 191         /* Flags */
 192         SystemdRunningAs running_as;
 193         ManagerExitCode exit_code:5;
 194
 195         bool dispatching_load_queue:1;
 196         bool dispatching_dbus_queue:1;
 197
 198         bool taint_usr:1;
 199
 200         bool show_status;
 201         bool confirm_spawn;
 202         bool no_console_output;
 203
 204         ExecOutput default_std_output, default_std_error;
 205
 206         usec_t default_restart_usec, default_timeout_start_usec,
 207                 default_timeout_stop_usec;
 208
 209         usec_t default_start_limit_interval;
 210         unsigned default_start_limit_burst;
 211
 212         struct rlimit *rlimit[RLIMIT_NLIMITS];
 213
 214         /* non-zero if we are reloading or reexecuting, */
 215         int n_reloading;
 216
 217         unsigned n_installed_jobs;
 218         unsigned n_failed_jobs;
 219
 220         /* Jobs in progress watching */
 221         unsigned n_running_jobs;
 222         unsigned n_on_console;
 223         unsigned jobs_in_progress_iteration;
 224
 225         /* Type=idle pipes */
 226         int idle_pipe[4];
 227         sd_event_source *idle_pipe_event_source;
 228
 229         char *switch_root;
 230         char *switch_root_init;
 231
 232         /* This maps all possible path prefixes to the units needing
 233          * them. It's a hashmap with a path string as key and a Set as
 234          * value where Unit objects are contained. */
 235         Hashmap *units_requiring_mounts_for;
 236 };
 237
 238 int manager_new(SystemdRunningAs running_as, bool reexecuting, Manager **m);
 239 void manager_free(Manager *m);
 240
 241 int manager_enumerate(Manager *m);
 242 int manager_startup(Manager *m, FILE *serialization, FDSet *fds);
 243
 244 Job *manager_get_job(Manager *m, uint32_t id);
 245 Unit *manager_get_unit(Manager *m, const char *name);
 246
 247 int manager_get_unit_by_path(Manager *m, const char *path, const char *suffix, Unit **_found);
 248
 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, sd_bus_error *e, Unit **_ret);
 252 int manager_load_unit(Manager *m, const char *name, const char *path, sd_bus_error *e, Unit **_ret);
 253 int manager_load_unit_from_dbus_path(Manager *m, const char *s, sd_bus_error *e, Unit **_u);
 254
 255 int manager_add_job(Manager *m, JobType type, Unit *unit, JobMode mode, bool force, sd_bus_error *e, Job **_ret);
 256 int manager_add_job_by_name(Manager *m, JobType type, const char *name, JobMode mode, bool force, sd_bus_error *e, Job **_ret);
 257
 258 void manager_dump_units(Manager *s, FILE *f, const char *prefix);
 259 void manager_dump_jobs(Manager *s, FILE *f, const char *prefix);
 260
 261 void manager_clear_jobs(Manager *m);
 262
 263 unsigned manager_dispatch_load_queue(Manager *m);
 264
 265 int manager_environment_add(Manager *m, char **minus, char **plus);
 266 int manager_set_default_rlimits(Manager *m, struct rlimit **default_rlimit);
 267
 268 int manager_loop(Manager *m);
 269
 270 void manager_dispatch_bus_name_owner_changed(Manager *m, const char *name, const char* old_owner, const char *new_owner);
 271
 272 int manager_open_serialization(Manager *m, FILE **_f);
 273
 274 int manager_serialize(Manager *m, FILE *f, FDSet *fds, bool switching_root);
 275 int manager_deserialize(Manager *m, FILE *f, FDSet *fds);
 276
 277 int manager_reload(Manager *m);
 278
 279 bool manager_is_reloading_or_reexecuting(Manager *m) _pure_;
 280
 281 void manager_reset_failed(Manager *m);
 282
 283 void manager_send_unit_audit(Manager *m, Unit *u, int type, bool success);
 284 void manager_send_unit_plymouth(Manager *m, Unit *u);
 285
 286 bool manager_unit_inactive_or_pending(Manager *m, const char *name);
 287
 288 void manager_check_finished(Manager *m);
 289
 290 void manager_run_generators(Manager *m);
 291 void manager_undo_generators(Manager *m);
 292
 293 void manager_recheck_journal(Manager *m);
 294
 295 void manager_set_show_status(Manager *m, bool b);
 296 void manager_status_printf(Manager *m, bool ephemeral, const char *status, const char *format, ...) _printf_(4,5);
 297
 298 Set *manager_get_units_requiring_mounts_for(Manager *m, const char *path);