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 <stdio.h>
  26 #include <libmount.h>
  27
  28 #include "sd-bus.h"
  29 #include "sd-event.h"
  30 #include "cgroup-util.h"
  31 #include "fdset.h"
  32 #include "hashmap.h"
  33 #include "list.h"
  34 #include "ratelimit.h"
  35
  36 /* Enforce upper limit how many names we allow */
  37 #define MANAGER_MAX_NAMES 131072 /* 128K */
  38
  39 typedef struct Manager Manager;
  40
  41 typedef enum ManagerState {
  42         MANAGER_INITIALIZING,
  43         MANAGER_STARTING,
  44         MANAGER_RUNNING,
  45         MANAGER_DEGRADED,
  46         MANAGER_MAINTENANCE,
  47         MANAGER_STOPPING,
  48         _MANAGER_STATE_MAX,
  49         _MANAGER_STATE_INVALID = -1
  50 } ManagerState;
  51
  52 typedef enum ManagerExitCode {
  53         MANAGER_OK,
  54         MANAGER_EXIT,
  55         MANAGER_RELOAD,
  56         MANAGER_REEXECUTE,
  57         MANAGER_REBOOT,
  58         MANAGER_POWEROFF,
  59         MANAGER_HALT,
  60         MANAGER_KEXEC,
  61         MANAGER_SWITCH_ROOT,
  62         _MANAGER_EXIT_CODE_MAX,
  63         _MANAGER_EXIT_CODE_INVALID = -1
  64 } ManagerExitCode;
  65
  66 typedef enum StatusType {
  67         STATUS_TYPE_EPHEMERAL,
  68         STATUS_TYPE_NORMAL,
  69         STATUS_TYPE_EMERGENCY,
  70 } StatusType;
  71
  72 #include "execute.h"
  73 #include "job.h"
  74 #include "path-lookup.h"
  75 #include "show-status.h"
  76 #include "unit-name.h"
  77
  78 struct Manager {
  79         /* Note that the set of units we know of is allowed to be
  80          * inconsistent. However the subset of it that is loaded may
  81          * not, and the list of jobs may neither. */
  82
  83         /* Active jobs and units */
  84         Hashmap *units;  /* name string => Unit object n:1 */
  85         Hashmap *jobs;   /* job id => Job object 1:1 */
  86
  87         /* To make it easy to iterate through the units of a specific
  88          * type we maintain a per type linked list */
  89         LIST_HEAD(Unit, units_by_type[_UNIT_TYPE_MAX]);
  90
  91         /* Units that need to be loaded */
  92         LIST_HEAD(Unit, load_queue); /* this is actually more a stack than a queue, but uh. */
  93
  94         /* Jobs that need to be run */
  95         LIST_HEAD(Job, run_queue);   /* more a stack than a queue, too */
  96
  97         /* Units and jobs that have not yet been announced via
  98          * D-Bus. When something about a job changes it is added here
  99          * if it is not in there yet. This allows easy coalescing of
 100          * D-Bus change signals. */
 101         LIST_HEAD(Unit, dbus_unit_queue);
 102         LIST_HEAD(Job, dbus_job_queue);
 103
 104         /* Units to remove */
 105         LIST_HEAD(Unit, cleanup_queue);
 106
 107         /* Units to check when doing GC */
 108         LIST_HEAD(Unit, gc_queue);
 109
 110         /* Units that should be realized */
 111         LIST_HEAD(Unit, cgroup_queue);
 112
 113         sd_event *event;
 114
 115         /* We use two hash tables here, since the same PID might be
 116          * watched by two different units: once the unit that forked
 117          * it off, and possibly a different unit to which it was
 118          * joined as cgroup member. Since we know that it is either
 119          * one or two units for each PID we just use to hashmaps
 120          * here. */
 121         Hashmap *watch_pids1;  /* pid => Unit object n:1 */
 122         Hashmap *watch_pids2;  /* pid => Unit object n:1 */
 123
 124         /* A set contains all units which cgroup should be refreshed after startup */
 125         Set *startup_units;
 126
 127         /* A set which contains all currently failed units */
 128         Set *failed_units;
 129
 130         sd_event_source *run_queue_event_source;
 131
 132         char *notify_socket;
 133         int notify_fd;
 134         sd_event_source *notify_event_source;
 135
 136         int signal_fd;
 137         sd_event_source *signal_event_source;
 138
 139         int time_change_fd;
 140         sd_event_source *time_change_event_source;
 141
 142         sd_event_source *jobs_in_progress_event_source;
 143
 144         unsigned n_snapshots;
 145
 146         LookupPaths lookup_paths;
 147         Set *unit_path_cache;
 148
 149         char **environment;
 150
 151         usec_t runtime_watchdog;
 152         usec_t shutdown_watchdog;
 153
 154         dual_timestamp firmware_timestamp;
 155         dual_timestamp loader_timestamp;
 156         dual_timestamp kernel_timestamp;
 157         dual_timestamp initrd_timestamp;
 158         dual_timestamp userspace_timestamp;
 159         dual_timestamp finish_timestamp;
 160
 161         dual_timestamp security_start_timestamp;
 162         dual_timestamp security_finish_timestamp;
 163         dual_timestamp generators_start_timestamp;
 164         dual_timestamp generators_finish_timestamp;
 165         dual_timestamp units_load_start_timestamp;
 166         dual_timestamp units_load_finish_timestamp;
 167
 168         char *generator_unit_path;
 169         char *generator_unit_path_early;
 170         char *generator_unit_path_late;
 171
 172         struct udev* udev;
 173
 174         /* Data specific to the device subsystem */
 175         struct udev_monitor* udev_monitor;
 176         sd_event_source *udev_event_source;
 177         Hashmap *devices_by_sysfs;
 178
 179         /* Data specific to the mount subsystem */
 180         struct libmnt_monitor *mount_monitor;
 181         sd_event_source *mount_event_source;
 182
 183         /* Data specific to the swap filesystem */
 184         FILE *proc_swaps;
 185         sd_event_source *swap_event_source;
 186         Hashmap *swaps_by_devnode;
 187
 188         /* Data specific to the D-Bus subsystem */
 189         sd_bus *api_bus, *system_bus;
 190         Set *private_buses;
 191         int private_listen_fd;
 192         sd_event_source *private_listen_event_source;
 193
 194         /* Contains all the clients that are subscribed to signals via
 195         the API bus. Note that private bus connections are always
 196         considered subscribes, since they last for very short only,
 197         and it is much simpler that way. */
 198         sd_bus_track *subscribed;
 199         char **deserialized_subscribed;
 200
 201         /* This is used during reloading: before the reload we queue
 202          * the reply message here, and afterwards we send it */
 203         sd_bus_message *queued_message;
 204
 205         Hashmap *watch_bus;  /* D-Bus names => Unit object n:1 */
 206
 207         bool send_reloading_done;
 208
 209         uint32_t current_job_id;
 210         uint32_t default_unit_job_id;
 211
 212         /* Data specific to the Automount subsystem */
 213         int dev_autofs_fd;
 214
 215         /* Data specific to the cgroup subsystem */
 216         Hashmap *cgroup_unit;
 217         CGroupMask cgroup_supported;
 218         char *cgroup_root;
 219
 220         /* Notifications from cgroups, when the unified hierarchy is
 221          * used is done via inotify. */
 222         int cgroup_inotify_fd;
 223         sd_event_source *cgroup_inotify_event_source;
 224         Hashmap *cgroup_inotify_wd_unit;
 225
 226         /* Make sure the user cannot accidentally unmount our cgroup
 227          * file system */
 228         int pin_cgroupfs_fd;
 229
 230         int gc_marker;
 231         unsigned n_in_gc_queue;
 232
 233         /* Flags */
 234         ManagerRunningAs running_as;
 235         ManagerExitCode exit_code:5;
 236
 237         bool dispatching_load_queue:1;
 238         bool dispatching_dbus_queue:1;
 239
 240         bool taint_usr:1;
 241
 242         bool test_run:1;
 243
 244         /* If non-zero, exit with the following value when the systemd
 245          * process terminate. Useful for containers: systemd-nspawn could get
 246          * the return value. */
 247         uint8_t return_value;
 248
 249         ShowStatus show_status;
 250         bool confirm_spawn;
 251         bool no_console_output;
 252
 253         ExecOutput default_std_output, default_std_error;
 254
 255         usec_t default_restart_usec, default_timeout_start_usec, default_timeout_stop_usec;
 256
 257         usec_t default_start_limit_interval;
 258         unsigned default_start_limit_burst;
 259
 260         bool default_cpu_accounting;
 261         bool default_memory_accounting;
 262         bool default_blockio_accounting;
 263         bool default_tasks_accounting;
 264
 265         usec_t default_timer_accuracy_usec;
 266
 267         struct rlimit *rlimit[_RLIMIT_MAX];
 268
 269         /* non-zero if we are reloading or reexecuting, */
 270         int n_reloading;
 271
 272         unsigned n_installed_jobs;
 273         unsigned n_failed_jobs;
 274
 275         /* Jobs in progress watching */
 276         unsigned n_running_jobs;
 277         unsigned n_on_console;
 278         unsigned jobs_in_progress_iteration;
 279
 280         /* Do we have any outstanding password prompts? */
 281         int have_ask_password;
 282         int ask_password_inotify_fd;
 283         sd_event_source *ask_password_event_source;
 284
 285         /* Type=idle pipes */
 286         int idle_pipe[4];
 287         sd_event_source *idle_pipe_event_source;
 288
 289         char *switch_root;
 290         char *switch_root_init;
 291
 292         /* This maps all possible path prefixes to the units needing
 293          * them. It's a hashmap with a path string as key and a Set as
 294          * value where Unit objects are contained. */
 295         Hashmap *units_requiring_mounts_for;
 296
 297         /* Reference to the kdbus bus control fd */
 298         int kdbus_fd;
 299
 300         /* Used for processing polkit authorization responses */
 301         Hashmap *polkit_registry;
 302
 303         /* When the user hits C-A-D more than 7 times per 2s, reboot immediately... */
 304         RateLimit ctrl_alt_del_ratelimit;
 305
 306         const char *unit_log_field;
 307         const char *unit_log_format_string;
 308
 309         int first_boot;
 310
 311         /* Used for NetClass=auto units */
 312         Hashmap *cgroup_netclass_registry;
 313         uint32_t cgroup_netclass_registry_last;
 314 };
 315
 316 int manager_new(ManagerRunningAs running_as, bool test_run, Manager **m);
 317 Manager* manager_free(Manager *m);
 318
 319 int manager_enumerate(Manager *m);
 320 int manager_startup(Manager *m, FILE *serialization, FDSet *fds);
 321
 322 Job *manager_get_job(Manager *m, uint32_t id);
 323 Unit *manager_get_unit(Manager *m, const char *name);
 324
 325 int manager_get_unit_by_path(Manager *m, const char *path, const char *suffix, Unit **_found);
 326
 327 int manager_get_job_from_dbus_path(Manager *m, const char *s, Job **_j);
 328
 329 int manager_load_unit_prepare(Manager *m, const char *name, const char *path, sd_bus_error *e, Unit **_ret);
 330 int manager_load_unit(Manager *m, const char *name, const char *path, sd_bus_error *e, Unit **_ret);
 331 int manager_load_unit_from_dbus_path(Manager *m, const char *s, sd_bus_error *e, Unit **_u);
 332
 333 int manager_add_job(Manager *m, JobType type, Unit *unit, JobMode mode, bool force, sd_bus_error *e, Job **_ret);
 334 int manager_add_job_by_name(Manager *m, JobType type, const char *name, JobMode mode, bool force, sd_bus_error *e, Job **_ret);
 335
 336 void manager_dump_units(Manager *s, FILE *f, const char *prefix);
 337 void manager_dump_jobs(Manager *s, FILE *f, const char *prefix);
 338
 339 void manager_clear_jobs(Manager *m);
 340
 341 unsigned manager_dispatch_load_queue(Manager *m);
 342
 343 int manager_environment_add(Manager *m, char **minus, char **plus);
 344 int manager_set_default_rlimits(Manager *m, struct rlimit **default_rlimit);
 345
 346 int manager_loop(Manager *m);
 347
 348 int manager_open_serialization(Manager *m, FILE **_f);
 349
 350 int manager_serialize(Manager *m, FILE *f, FDSet *fds, bool switching_root);
 351 int manager_deserialize(Manager *m, FILE *f, FDSet *fds);
 352
 353 int manager_reload(Manager *m);
 354
 355 bool manager_is_reloading_or_reexecuting(Manager *m) _pure_;
 356
 357 void manager_reset_failed(Manager *m);
 358
 359 void manager_send_unit_audit(Manager *m, Unit *u, int type, bool success);
 360 void manager_send_unit_plymouth(Manager *m, Unit *u);
 361
 362 bool manager_unit_inactive_or_pending(Manager *m, const char *name);
 363
 364 void manager_check_finished(Manager *m);
 365
 366 void manager_recheck_journal(Manager *m);
 367
 368 void manager_set_show_status(Manager *m, ShowStatus mode);
 369 void manager_set_first_boot(Manager *m, bool b);
 370
 371 void manager_status_printf(Manager *m, StatusType type, const char *status, const char *format, ...) _printf_(4,5);
 372 void manager_flip_auto_status(Manager *m, bool enable);
 373
 374 Set *manager_get_units_requiring_mounts_for(Manager *m, const char *path);
 375
 376 const char *manager_get_runtime_prefix(Manager *m);
 377
 378 ManagerState manager_state(Manager *m);
 379
 380 int manager_update_failed_units(Manager *m, Unit *u, bool failed);
 381
 382 const char *manager_state_to_string(ManagerState m) _const_;
 383 ManagerState manager_state_from_string(const char *s) _pure_;