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 typedef enum ManagerTimestamp {
  74         MANAGER_TIMESTAMP_FIRMWARE,
  75         MANAGER_TIMESTAMP_LOADER,
  76         MANAGER_TIMESTAMP_KERNEL,
  77         MANAGER_TIMESTAMP_INITRD,
  78         MANAGER_TIMESTAMP_USERSPACE,
  79         MANAGER_TIMESTAMP_FINISH,
  80
  81         MANAGER_TIMESTAMP_SECURITY_START,
  82         MANAGER_TIMESTAMP_SECURITY_FINISH,
  83         MANAGER_TIMESTAMP_GENERATORS_START,
  84         MANAGER_TIMESTAMP_GENERATORS_FINISH,
  85         MANAGER_TIMESTAMP_UNITS_LOAD_START,
  86         MANAGER_TIMESTAMP_UNITS_LOAD_FINISH,
  87         _MANAGER_TIMESTAMP_MAX,
  88         _MANAGER_TIMESTAMP_INVALID = -1,
  89 } ManagerTimestamp;
  90
  91 #include "execute.h"
  92 #include "job.h"
  93 #include "path-lookup.h"
  94 #include "show-status.h"
  95 #include "unit-name.h"
  96
  97 enum {
  98         /* 0 = run normally */
  99         MANAGER_TEST_RUN_MINIMAL        = 1 << 1,  /* create basic data structures */
 100         MANAGER_TEST_RUN_BASIC          = 1 << 2,  /* interact with the environment */
 101         MANAGER_TEST_RUN_ENV_GENERATORS = 1 << 3,  /* also run env generators  */
 102         MANAGER_TEST_RUN_GENERATORS     = 1 << 4,  /* also run unit generators */
 103         MANAGER_TEST_FULL = MANAGER_TEST_RUN_BASIC | MANAGER_TEST_RUN_ENV_GENERATORS | MANAGER_TEST_RUN_GENERATORS,
 104 };
 105 assert_cc((MANAGER_TEST_FULL & UINT8_MAX) == MANAGER_TEST_FULL);
 106
 107 struct Manager {
 108         /* Note that the set of units we know of is allowed to be
 109          * inconsistent. However the subset of it that is loaded may
 110          * not, and the list of jobs may neither. */
 111
 112         /* Active jobs and units */
 113         Hashmap *units;  /* name string => Unit object n:1 */
 114         Hashmap *units_by_invocation_id;
 115         Hashmap *jobs;   /* job id => Job object 1:1 */
 116
 117         /* To make it easy to iterate through the units of a specific
 118          * type we maintain a per type linked list */
 119         LIST_HEAD(Unit, units_by_type[_UNIT_TYPE_MAX]);
 120
 121         /* Units that need to be loaded */
 122         LIST_HEAD(Unit, load_queue); /* this is actually more a stack than a queue, but uh. */
 123
 124         /* Jobs that need to be run */
 125         LIST_HEAD(Job, run_queue);   /* more a stack than a queue, too */
 126
 127         /* Units and jobs that have not yet been announced via
 128          * D-Bus. When something about a job changes it is added here
 129          * if it is not in there yet. This allows easy coalescing of
 130          * D-Bus change signals. */
 131         LIST_HEAD(Unit, dbus_unit_queue);
 132         LIST_HEAD(Job, dbus_job_queue);
 133
 134         /* Units to remove */
 135         LIST_HEAD(Unit, cleanup_queue);
 136
 137         /* Units and jobs to check when doing GC */
 138         LIST_HEAD(Unit, gc_unit_queue);
 139         LIST_HEAD(Job, gc_job_queue);
 140
 141         /* Units that should be realized */
 142         LIST_HEAD(Unit, cgroup_realize_queue);
 143
 144         /* Units whose cgroup ran empty */
 145         LIST_HEAD(Unit, cgroup_empty_queue);
 146
 147         /* Target units whose default target dependencies haven't been set yet */
 148         LIST_HEAD(Unit, target_deps_queue);
 149
 150         sd_event *event;
 151
 152         /* This maps PIDs we care about to units that are interested in. We allow multiple units to he interested in
 153          * the same PID and multiple PIDs to be relevant to the same unit. Since in most cases only a single unit will
 154          * be interested in the same PID we use a somewhat special encoding here: the first unit interested in a PID is
 155          * stored directly in the hashmap, keyed by the PID unmodified. If there are other units interested too they'll
 156          * be stored in a NULL-terminated array, and keyed by the negative PID. This is safe as pid_t is signed and
 157          * negative PIDs are not used for regular processes but process groups, which we don't care about in this
 158          * context, but this allows us to use the negative range for our own purposes. */
 159         Hashmap *watch_pids;  /* pid => unit as well as -pid => array of units */
 160
 161         /* A set contains all units which cgroup should be refreshed after startup */
 162         Set *startup_units;
 163
 164         /* A set which contains all currently failed units */
 165         Set *failed_units;
 166
 167         sd_event_source *run_queue_event_source;
 168
 169         char *notify_socket;
 170         int notify_fd;
 171         sd_event_source *notify_event_source;
 172
 173         int cgroups_agent_fd;
 174         sd_event_source *cgroups_agent_event_source;
 175
 176         int signal_fd;
 177         sd_event_source *signal_event_source;
 178
 179         sd_event_source *sigchld_event_source;
 180
 181         int time_change_fd;
 182         sd_event_source *time_change_event_source;
 183
 184         sd_event_source *jobs_in_progress_event_source;
 185
 186         int user_lookup_fds[2];
 187         sd_event_source *user_lookup_event_source;
 188
 189         sd_event_source *sync_bus_names_event_source;
 190
 191         UnitFileScope unit_file_scope;
 192         LookupPaths lookup_paths;
 193         Set *unit_path_cache;
 194
 195         char **environment;
 196
 197         usec_t runtime_watchdog;
 198         usec_t shutdown_watchdog;
 199
 200         dual_timestamp timestamps[_MANAGER_TIMESTAMP_MAX];
 201
 202         struct udev* udev;
 203
 204         /* Data specific to the device subsystem */
 205         struct udev_monitor* udev_monitor;
 206         sd_event_source *udev_event_source;
 207         Hashmap *devices_by_sysfs;
 208
 209         /* Data specific to the mount subsystem */
 210         struct libmnt_monitor *mount_monitor;
 211         sd_event_source *mount_event_source;
 212
 213         /* Data specific to the swap filesystem */
 214         FILE *proc_swaps;
 215         sd_event_source *swap_event_source;
 216         Hashmap *swaps_by_devnode;
 217
 218         /* Data specific to the D-Bus subsystem */
 219         sd_bus *api_bus, *system_bus;
 220         Set *private_buses;
 221         int private_listen_fd;
 222         sd_event_source *private_listen_event_source;
 223
 224         /* Contains all the clients that are subscribed to signals via
 225         the API bus. Note that private bus connections are always
 226         considered subscribes, since they last for very short only,
 227         and it is much simpler that way. */
 228         sd_bus_track *subscribed;
 229         char **deserialized_subscribed;
 230
 231         /* This is used during reloading: before the reload we queue
 232          * the reply message here, and afterwards we send it */
 233         sd_bus_message *queued_message;
 234
 235         Hashmap *watch_bus;  /* D-Bus names => Unit object n:1 */
 236
 237         bool send_reloading_done;
 238
 239         uint32_t current_job_id;
 240         uint32_t default_unit_job_id;
 241
 242         /* Data specific to the Automount subsystem */
 243         int dev_autofs_fd;
 244
 245         /* Data specific to the cgroup subsystem */
 246         Hashmap *cgroup_unit;
 247         CGroupMask cgroup_supported;
 248         char *cgroup_root;
 249
 250         /* Notifications from cgroups, when the unified hierarchy is used is done via inotify. */
 251         int cgroup_inotify_fd;
 252         sd_event_source *cgroup_inotify_event_source;
 253         Hashmap *cgroup_inotify_wd_unit;
 254
 255         /* A defer event for handling cgroup empty events and processing them after SIGCHLD in all cases. */
 256         sd_event_source *cgroup_empty_event_source;
 257
 258         /* Make sure the user cannot accidentally unmount our cgroup
 259          * file system */
 260         int pin_cgroupfs_fd;
 261
 262         unsigned gc_marker;
 263
 264         /* Flags */
 265         ManagerExitCode exit_code:5;
 266
 267         bool dispatching_load_queue:1;
 268         bool dispatching_dbus_queue:1;
 269
 270         bool taint_usr:1;
 271
 272         /* Have we already sent out the READY=1 notification? */
 273         bool ready_sent:1;
 274
 275         /* Have we already printed the taint line if necessary? */
 276         bool taint_logged:1;
 277
 278         /* Have we ever changed the "kernel.pid_max" sysctl? */
 279         bool sysctl_pid_max_changed:1;
 280
 281         unsigned test_run_flags:8;
 282
 283         /* If non-zero, exit with the following value when the systemd
 284          * process terminate. Useful for containers: systemd-nspawn could get
 285          * the return value. */
 286         uint8_t return_value;
 287
 288         ShowStatus show_status;
 289         char *confirm_spawn;
 290         bool no_console_output;
 291         bool service_watchdogs;
 292
 293         ExecOutput default_std_output, default_std_error;
 294
 295         usec_t default_restart_usec, default_timeout_start_usec, default_timeout_stop_usec;
 296
 297         usec_t default_start_limit_interval;
 298         unsigned default_start_limit_burst;
 299
 300         bool default_cpu_accounting;
 301         bool default_memory_accounting;
 302         bool default_io_accounting;
 303         bool default_blockio_accounting;
 304         bool default_tasks_accounting;
 305         bool default_ip_accounting;
 306
 307         uint64_t default_tasks_max;
 308         usec_t default_timer_accuracy_usec;
 309
 310         struct rlimit *rlimit[_RLIMIT_MAX];
 311
 312         /* non-zero if we are reloading or reexecuting, */
 313         int n_reloading;
 314
 315         unsigned n_installed_jobs;
 316         unsigned n_failed_jobs;
 317
 318         /* Jobs in progress watching */
 319         unsigned n_running_jobs;
 320         unsigned n_on_console;
 321         unsigned jobs_in_progress_iteration;
 322
 323         /* Do we have any outstanding password prompts? */
 324         int have_ask_password;
 325         int ask_password_inotify_fd;
 326         sd_event_source *ask_password_event_source;
 327
 328         /* Type=idle pipes */
 329         int idle_pipe[4];
 330         sd_event_source *idle_pipe_event_source;
 331
 332         char *switch_root;
 333         char *switch_root_init;
 334
 335         /* This maps all possible path prefixes to the units needing
 336          * them. It's a hashmap with a path string as key and a Set as
 337          * value where Unit objects are contained. */
 338         Hashmap *units_requiring_mounts_for;
 339
 340         /* Used for processing polkit authorization responses */
 341         Hashmap *polkit_registry;
 342
 343         /* Dynamic users/groups, indexed by their name */
 344         Hashmap *dynamic_users;
 345
 346         /* Keep track of all UIDs and GIDs any of our services currently use. This is useful for the RemoveIPC= logic. */
 347         Hashmap *uid_refs;
 348         Hashmap *gid_refs;
 349
 350         /* ExecRuntime, indexed by their owner unit id */
 351         Hashmap *exec_runtime_by_id;
 352
 353         /* When the user hits C-A-D more than 7 times per 2s, do something immediately... */
 354         RateLimit ctrl_alt_del_ratelimit;
 355         EmergencyAction cad_burst_action;
 356
 357         const char *unit_log_field;
 358         const char *unit_log_format_string;
 359
 360         const char *invocation_log_field;
 361         const char *invocation_log_format_string;
 362
 363         int first_boot; /* tri-state */
 364
 365         /* Prefixes of e.g. RuntimeDirectory= */
 366         char *prefix[_EXEC_DIRECTORY_TYPE_MAX];
 367
 368         /* Used in the SIGCHLD and sd_notify() message invocation logic to avoid that we dispatch the same event
 369          * multiple times on the same unit. */
 370         unsigned sigchldgen;
 371         unsigned notifygen;
 372 };
 373
 374 #define MANAGER_IS_SYSTEM(m) ((m)->unit_file_scope == UNIT_FILE_SYSTEM)
 375 #define MANAGER_IS_USER(m) ((m)->unit_file_scope != UNIT_FILE_SYSTEM)
 376
 377 #define MANAGER_IS_RELOADING(m) ((m)->n_reloading > 0)
 378
 379 #define MANAGER_IS_FINISHED(m) (dual_timestamp_is_set((m)->timestamps + MANAGER_TIMESTAMP_FINISH))
 380
 381 /* The exit code is set to OK as soon as we enter the main loop, and set otherwise as soon as we are done with it */
 382 #define MANAGER_IS_RUNNING(m) ((m)->exit_code == MANAGER_OK)
 383
 384 int manager_new(UnitFileScope scope, unsigned test_run_flags, Manager **m);
 385 Manager* manager_free(Manager *m);
 386 DEFINE_TRIVIAL_CLEANUP_FUNC(Manager*, manager_free);
 387
 388 void manager_enumerate(Manager *m);
 389 int manager_startup(Manager *m, FILE *serialization, FDSet *fds);
 390
 391 Job *manager_get_job(Manager *m, uint32_t id);
 392 Unit *manager_get_unit(Manager *m, const char *name);
 393
 394 int manager_get_job_from_dbus_path(Manager *m, const char *s, Job **_j);
 395
 396 int manager_load_unit_prepare(Manager *m, const char *name, const char *path, sd_bus_error *e, Unit **_ret);
 397 int manager_load_unit(Manager *m, const char *name, const char *path, sd_bus_error *e, Unit **_ret);
 398 int manager_load_unit_from_dbus_path(Manager *m, const char *s, sd_bus_error *e, Unit **_u);
 399
 400 int manager_add_job(Manager *m, JobType type, Unit *unit, JobMode mode, sd_bus_error *e, Job **_ret);
 401 int manager_add_job_by_name(Manager *m, JobType type, const char *name, JobMode mode, sd_bus_error *e, Job **_ret);
 402 int manager_add_job_by_name_and_warn(Manager *m, JobType type, const char *name, JobMode mode, Job **ret);
 403 int manager_propagate_reload(Manager *m, Unit *unit, JobMode mode, sd_bus_error *e);
 404
 405 void manager_dump_units(Manager *s, FILE *f, const char *prefix);
 406 void manager_dump_jobs(Manager *s, FILE *f, const char *prefix);
 407 void manager_dump(Manager *s, FILE *f, const char *prefix);
 408 int manager_get_dump_string(Manager *m, char **ret);
 409
 410 void manager_clear_jobs(Manager *m);
 411
 412 unsigned manager_dispatch_load_queue(Manager *m);
 413
 414 int manager_environment_add(Manager *m, char **minus, char **plus);
 415 int manager_set_default_rlimits(Manager *m, struct rlimit **default_rlimit);
 416
 417 int manager_loop(Manager *m);
 418
 419 int manager_open_serialization(Manager *m, FILE **_f);
 420
 421 int manager_serialize(Manager *m, FILE *f, FDSet *fds, bool switching_root);
 422 int manager_deserialize(Manager *m, FILE *f, FDSet *fds);
 423
 424 int manager_reload(Manager *m);
 425
 426 void manager_reset_failed(Manager *m);
 427
 428 void manager_send_unit_audit(Manager *m, Unit *u, int type, bool success);
 429 void manager_send_unit_plymouth(Manager *m, Unit *u);
 430
 431 bool manager_unit_inactive_or_pending(Manager *m, const char *name);
 432
 433 void manager_check_finished(Manager *m);
 434
 435 void manager_recheck_dbus(Manager *m);
 436 void manager_recheck_journal(Manager *m);
 437
 438 void manager_set_show_status(Manager *m, ShowStatus mode);
 439 void manager_set_first_boot(Manager *m, bool b);
 440
 441 void manager_status_printf(Manager *m, StatusType type, const char *status, const char *format, ...) _printf_(4,5);
 442 void manager_flip_auto_status(Manager *m, bool enable);
 443
 444 Set *manager_get_units_requiring_mounts_for(Manager *m, const char *path);
 445
 446 ManagerState manager_state(Manager *m);
 447
 448 int manager_update_failed_units(Manager *m, Unit *u, bool failed);
 449
 450 void manager_unref_uid(Manager *m, uid_t uid, bool destroy_now);
 451 int manager_ref_uid(Manager *m, uid_t uid, bool clean_ipc);
 452
 453 void manager_unref_gid(Manager *m, gid_t gid, bool destroy_now);
 454 int manager_ref_gid(Manager *m, gid_t gid, bool destroy_now);
 455
 456 void manager_vacuum_uid_refs(Manager *m);
 457 void manager_vacuum_gid_refs(Manager *m);
 458
 459 void manager_serialize_uid_refs(Manager *m, FILE *f);
 460 void manager_deserialize_uid_refs_one(Manager *m, const char *value);
 461
 462 void manager_serialize_gid_refs(Manager *m, FILE *f);
 463 void manager_deserialize_gid_refs_one(Manager *m, const char *value);
 464
 465 char *manager_taint_string(Manager *m);
 466
 467 void manager_ref_console(Manager *m);
 468 void manager_unref_console(Manager *m);
 469
 470 const char *manager_state_to_string(ManagerState m) _const_;
 471 ManagerState manager_state_from_string(const char *s) _pure_;
 472
 473 const char *manager_get_confirm_spawn(Manager *m);
 474 bool manager_is_confirm_spawn_disabled(Manager *m);
 475 void manager_disable_confirm_spawn(void);
 476
 477 const char *manager_timestamp_to_string(ManagerTimestamp m) _const_;
 478 ManagerTimestamp manager_timestamp_from_string(const char *s) _pure_;