src/core/manager.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 /***
   5   This file is part of systemd.
   6
   7   Copyright 2010 Lennart Poettering
   8
   9   systemd is free software; you can redistribute it and/or modify it
  10   under the terms of the GNU Lesser General Public License as published by
  11   the Free Software Foundation; either version 2.1 of the License, or
  12   (at your option) any later version.
  13
  14   systemd is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   Lesser General Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public License
  20   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  21 ***/
  22
  23 #include <libmount.h>
  24 #include <stdbool.h>
  25 #include <stdio.h>
  26
  27 #include "sd-bus.h"
  28 #include "sd-event.h"
  29
  30 #include "cgroup-util.h"
  31 #include "fdset.h"
  32 #include "hashmap.h"
  33 #include "ip-address-access.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 enum {
  80         /* 0 = run normally */
  81         MANAGER_TEST_RUN_MINIMAL = 1,        /* run test w/o generators */
  82         MANAGER_TEST_RUN_ENV_GENERATORS = 2, /* also run env generators  */
  83         MANAGER_TEST_RUN_GENERATORS = 4,     /* also run unit generators */
  84         MANAGER_TEST_FULL = MANAGER_TEST_RUN_ENV_GENERATORS | MANAGER_TEST_RUN_GENERATORS,
  85 };
  86 assert_cc((MANAGER_TEST_FULL & UINT8_MAX) == MANAGER_TEST_FULL);
  87
  88 struct Manager {
  89         /* Note that the set of units we know of is allowed to be
  90          * inconsistent. However the subset of it that is loaded may
  91          * not, and the list of jobs may neither. */
  92
  93         /* Active jobs and units */
  94         Hashmap *units;  /* name string => Unit object n:1 */
  95         Hashmap *units_by_invocation_id;
  96         Hashmap *jobs;   /* job id => Job object 1:1 */
  97
  98         /* To make it easy to iterate through the units of a specific
  99          * type we maintain a per type linked list */
 100         LIST_HEAD(Unit, units_by_type[_UNIT_TYPE_MAX]);
 101
 102         /* Units that need to be loaded */
 103         LIST_HEAD(Unit, load_queue); /* this is actually more a stack than a queue, but uh. */
 104
 105         /* Jobs that need to be run */
 106         LIST_HEAD(Job, run_queue);   /* more a stack than a queue, too */
 107
 108         /* Units and jobs that have not yet been announced via
 109          * D-Bus. When something about a job changes it is added here
 110          * if it is not in there yet. This allows easy coalescing of
 111          * D-Bus change signals. */
 112         LIST_HEAD(Unit, dbus_unit_queue);
 113         LIST_HEAD(Job, dbus_job_queue);
 114
 115         /* Units to remove */
 116         LIST_HEAD(Unit, cleanup_queue);
 117
 118         /* Units and jobs to check when doing GC */
 119         LIST_HEAD(Unit, gc_unit_queue);
 120         LIST_HEAD(Job, gc_job_queue);
 121
 122         /* Units that should be realized */
 123         LIST_HEAD(Unit, cgroup_realize_queue);
 124
 125         /* Units whose cgroup ran empty */
 126         LIST_HEAD(Unit, cgroup_empty_queue);
 127
 128         sd_event *event;
 129
 130         /* We use two hash tables here, since the same PID might be
 131          * watched by two different units: once the unit that forked
 132          * it off, and possibly a different unit to which it was
 133          * joined as cgroup member. Since we know that it is either
 134          * one or two units for each PID we just use to hashmaps
 135          * here. */
 136         Hashmap *watch_pids1;  /* pid => Unit object n:1 */
 137         Hashmap *watch_pids2;  /* pid => Unit object n:1 */
 138
 139         /* A set contains all units which cgroup should be refreshed after startup */
 140         Set *startup_units;
 141
 142         /* A set which contains all currently failed units */
 143         Set *failed_units;
 144
 145         sd_event_source *run_queue_event_source;
 146
 147         char *notify_socket;
 148         int notify_fd;
 149         sd_event_source *notify_event_source;
 150
 151         int cgroups_agent_fd;
 152         sd_event_source *cgroups_agent_event_source;
 153
 154         int signal_fd;
 155         sd_event_source *signal_event_source;
 156
 157         int time_change_fd;
 158         sd_event_source *time_change_event_source;
 159
 160         sd_event_source *jobs_in_progress_event_source;
 161
 162         int user_lookup_fds[2];
 163         sd_event_source *user_lookup_event_source;
 164
 165         UnitFileScope unit_file_scope;
 166         LookupPaths lookup_paths;
 167         Set *unit_path_cache;
 168
 169         char **environment;
 170
 171         usec_t runtime_watchdog;
 172         usec_t shutdown_watchdog;
 173
 174         dual_timestamp firmware_timestamp;
 175         dual_timestamp loader_timestamp;
 176         dual_timestamp kernel_timestamp;
 177         dual_timestamp initrd_timestamp;
 178         dual_timestamp userspace_timestamp;
 179         dual_timestamp finish_timestamp;
 180
 181         dual_timestamp security_start_timestamp;
 182         dual_timestamp security_finish_timestamp;
 183         dual_timestamp generators_start_timestamp;
 184         dual_timestamp generators_finish_timestamp;
 185         dual_timestamp units_load_start_timestamp;
 186         dual_timestamp units_load_finish_timestamp;
 187
 188         struct udev* udev;
 189
 190         /* Data specific to the device subsystem */
 191         struct udev_monitor* udev_monitor;
 192         sd_event_source *udev_event_source;
 193         Hashmap *devices_by_sysfs;
 194
 195         /* Data specific to the mount subsystem */
 196         struct libmnt_monitor *mount_monitor;
 197         sd_event_source *mount_event_source;
 198
 199         /* Data specific to the swap filesystem */
 200         FILE *proc_swaps;
 201         sd_event_source *swap_event_source;
 202         Hashmap *swaps_by_devnode;
 203
 204         /* Data specific to the D-Bus subsystem */
 205         sd_bus *api_bus, *system_bus;
 206         Set *private_buses;
 207         int private_listen_fd;
 208         sd_event_source *private_listen_event_source;
 209
 210         /* Contains all the clients that are subscribed to signals via
 211         the API bus. Note that private bus connections are always
 212         considered subscribes, since they last for very short only,
 213         and it is much simpler that way. */
 214         sd_bus_track *subscribed;
 215         char **deserialized_subscribed;
 216
 217         /* This is used during reloading: before the reload we queue
 218          * the reply message here, and afterwards we send it */
 219         sd_bus_message *queued_message;
 220
 221         Hashmap *watch_bus;  /* D-Bus names => Unit object n:1 */
 222
 223         bool send_reloading_done;
 224
 225         uint32_t current_job_id;
 226         uint32_t default_unit_job_id;
 227
 228         /* Data specific to the Automount subsystem */
 229         int dev_autofs_fd;
 230
 231         /* Data specific to the cgroup subsystem */
 232         Hashmap *cgroup_unit;
 233         CGroupMask cgroup_supported;
 234         char *cgroup_root;
 235
 236         /* Notifications from cgroups, when the unified hierarchy is used is done via inotify. */
 237         int cgroup_inotify_fd;
 238         sd_event_source *cgroup_inotify_event_source;
 239         Hashmap *cgroup_inotify_wd_unit;
 240
 241         /* A defer event for handling cgroup empty events and processing them after SIGCHLD in all cases. */
 242         sd_event_source *cgroup_empty_event_source;
 243
 244         /* Make sure the user cannot accidentally unmount our cgroup
 245          * file system */
 246         int pin_cgroupfs_fd;
 247
 248         unsigned gc_marker;
 249
 250         /* Flags */
 251         ManagerExitCode exit_code:5;
 252
 253         bool dispatching_load_queue:1;
 254         bool dispatching_dbus_queue:1;
 255
 256         bool taint_usr:1;
 257
 258         bool ready_sent:1;
 259
 260         unsigned test_run_flags:8;
 261
 262         /* If non-zero, exit with the following value when the systemd
 263          * process terminate. Useful for containers: systemd-nspawn could get
 264          * the return value. */
 265         uint8_t return_value;
 266
 267         ShowStatus show_status;
 268         char *confirm_spawn;
 269         bool no_console_output;
 270
 271         ExecOutput default_std_output, default_std_error;
 272
 273         usec_t default_restart_usec, default_timeout_start_usec, default_timeout_stop_usec;
 274
 275         usec_t default_start_limit_interval;
 276         unsigned default_start_limit_burst;
 277
 278         bool default_cpu_accounting;
 279         bool default_memory_accounting;
 280         bool default_io_accounting;
 281         bool default_blockio_accounting;
 282         bool default_tasks_accounting;
 283         bool default_ip_accounting;
 284
 285         uint64_t default_tasks_max;
 286         usec_t default_timer_accuracy_usec;
 287
 288         struct rlimit *rlimit[_RLIMIT_MAX];
 289
 290         /* non-zero if we are reloading or reexecuting, */
 291         int n_reloading;
 292
 293         unsigned n_installed_jobs;
 294         unsigned n_failed_jobs;
 295
 296         /* Jobs in progress watching */
 297         unsigned n_running_jobs;
 298         unsigned n_on_console;
 299         unsigned jobs_in_progress_iteration;
 300
 301         /* Do we have any outstanding password prompts? */
 302         int have_ask_password;
 303         int ask_password_inotify_fd;
 304         sd_event_source *ask_password_event_source;
 305
 306         /* Type=idle pipes */
 307         int idle_pipe[4];
 308         sd_event_source *idle_pipe_event_source;
 309
 310         char *switch_root;
 311         char *switch_root_init;
 312
 313         /* This maps all possible path prefixes to the units needing
 314          * them. It's a hashmap with a path string as key and a Set as
 315          * value where Unit objects are contained. */
 316         Hashmap *units_requiring_mounts_for;
 317
 318         /* Used for processing polkit authorization responses */
 319         Hashmap *polkit_registry;
 320
 321         /* Dynamic users/groups, indexed by their name */
 322         Hashmap *dynamic_users;
 323
 324         /* Keep track of all UIDs and GIDs any of our services currently use. This is useful for the RemoveIPC= logic. */
 325         Hashmap *uid_refs;
 326         Hashmap *gid_refs;
 327
 328         /* When the user hits C-A-D more than 7 times per 2s, do something immediately... */
 329         RateLimit ctrl_alt_del_ratelimit;
 330         EmergencyAction cad_burst_action;
 331
 332         const char *unit_log_field;
 333         const char *unit_log_format_string;
 334
 335         const char *invocation_log_field;
 336         const char *invocation_log_format_string;
 337
 338         int first_boot; /* tri-state */
 339
 340         /* prefixes of e.g. RuntimeDirectory= */
 341         char *prefix[_EXEC_DIRECTORY_TYPE_MAX];
 342 };
 343
 344 #define MANAGER_IS_SYSTEM(m) ((m)->unit_file_scope == UNIT_FILE_SYSTEM)
 345 #define MANAGER_IS_USER(m) ((m)->unit_file_scope != UNIT_FILE_SYSTEM)
 346
 347 #define MANAGER_IS_RELOADING(m) ((m)->n_reloading > 0)
 348
 349 int manager_new(UnitFileScope scope, unsigned test_run_flags, Manager **m);
 350 Manager* manager_free(Manager *m);
 351
 352 void manager_enumerate(Manager *m);
 353 int manager_startup(Manager *m, FILE *serialization, FDSet *fds);
 354
 355 Job *manager_get_job(Manager *m, uint32_t id);
 356 Unit *manager_get_unit(Manager *m, const char *name);
 357
 358 int manager_get_job_from_dbus_path(Manager *m, const char *s, Job **_j);
 359
 360 int manager_load_unit_prepare(Manager *m, const char *name, const char *path, sd_bus_error *e, Unit **_ret);
 361 int manager_load_unit(Manager *m, const char *name, const char *path, sd_bus_error *e, Unit **_ret);
 362 int manager_load_unit_from_dbus_path(Manager *m, const char *s, sd_bus_error *e, Unit **_u);
 363
 364 int manager_add_job(Manager *m, JobType type, Unit *unit, JobMode mode, sd_bus_error *e, Job **_ret);
 365 int manager_add_job_by_name(Manager *m, JobType type, const char *name, JobMode mode, sd_bus_error *e, Job **_ret);
 366 int manager_add_job_by_name_and_warn(Manager *m, JobType type, const char *name, JobMode mode, Job **ret);
 367 int manager_propagate_reload(Manager *m, Unit *unit, JobMode mode, sd_bus_error *e);
 368
 369 void manager_dump_units(Manager *s, FILE *f, const char *prefix);
 370 void manager_dump_jobs(Manager *s, FILE *f, const char *prefix);
 371
 372 void manager_clear_jobs(Manager *m);
 373
 374 unsigned manager_dispatch_load_queue(Manager *m);
 375
 376 int manager_environment_add(Manager *m, char **minus, char **plus);
 377 int manager_set_default_rlimits(Manager *m, struct rlimit **default_rlimit);
 378
 379 int manager_loop(Manager *m);
 380
 381 int manager_open_serialization(Manager *m, FILE **_f);
 382
 383 int manager_serialize(Manager *m, FILE *f, FDSet *fds, bool switching_root);
 384 int manager_deserialize(Manager *m, FILE *f, FDSet *fds);
 385
 386 int manager_reload(Manager *m);
 387
 388 void manager_reset_failed(Manager *m);
 389
 390 void manager_send_unit_audit(Manager *m, Unit *u, int type, bool success);
 391 void manager_send_unit_plymouth(Manager *m, Unit *u);
 392
 393 bool manager_unit_inactive_or_pending(Manager *m, const char *name);
 394
 395 void manager_check_finished(Manager *m);
 396
 397 void manager_recheck_journal(Manager *m);
 398
 399 void manager_set_show_status(Manager *m, ShowStatus mode);
 400 void manager_set_first_boot(Manager *m, bool b);
 401
 402 void manager_status_printf(Manager *m, StatusType type, const char *status, const char *format, ...) _printf_(4,5);
 403 void manager_flip_auto_status(Manager *m, bool enable);
 404
 405 Set *manager_get_units_requiring_mounts_for(Manager *m, const char *path);
 406
 407 void manager_set_exec_params(Manager *m, ExecParameters *p);
 408
 409 ManagerState manager_state(Manager *m);
 410
 411 int manager_update_failed_units(Manager *m, Unit *u, bool failed);
 412
 413 void manager_unref_uid(Manager *m, uid_t uid, bool destroy_now);
 414 int manager_ref_uid(Manager *m, uid_t uid, bool clean_ipc);
 415
 416 void manager_unref_gid(Manager *m, gid_t gid, bool destroy_now);
 417 int manager_ref_gid(Manager *m, gid_t gid, bool destroy_now);
 418
 419 void manager_vacuum_uid_refs(Manager *m);
 420 void manager_vacuum_gid_refs(Manager *m);
 421
 422 void manager_serialize_uid_refs(Manager *m, FILE *f);
 423 void manager_deserialize_uid_refs_one(Manager *m, const char *value);
 424
 425 void manager_serialize_gid_refs(Manager *m, FILE *f);
 426 void manager_deserialize_gid_refs_one(Manager *m, const char *value);
 427
 428 const char *manager_state_to_string(ManagerState m) _const_;
 429 ManagerState manager_state_from_string(const char *s) _pure_;
 430
 431 const char *manager_get_confirm_spawn(Manager *m);
 432 bool manager_is_confirm_spawn_disabled(Manager *m);
 433 void manager_disable_confirm_spawn(void);