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