src/core/manager.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 #include <stdbool.h>
   5 #include <stdio.h>
   6
   7 #include "sd-bus.h"
   8 #include "sd-device.h"
   9 #include "sd-event.h"
  10
  11 #include "cgroup-util.h"
  12 #include "fdset.h"
  13 #include "hashmap.h"
  14 #include "ip-address-access.h"
  15 #include "list.h"
  16 #include "ratelimit.h"
  17
  18 struct libmnt_monitor;
  19 typedef struct Unit Unit;
  20
  21 /* Enforce upper limit how many names we allow */
  22 #define MANAGER_MAX_NAMES 131072 /* 128K */
  23
  24 typedef struct Manager Manager;
  25
  26 /* An externally visible state. We don't actually maintain this as state variable, but derive it from various fields
  27  * when requested */
  28 typedef enum ManagerState {
  29         MANAGER_INITIALIZING,
  30         MANAGER_STARTING,
  31         MANAGER_RUNNING,
  32         MANAGER_DEGRADED,
  33         MANAGER_MAINTENANCE,
  34         MANAGER_STOPPING,
  35         _MANAGER_STATE_MAX,
  36         _MANAGER_STATE_INVALID = -1
  37 } ManagerState;
  38
  39 typedef enum ManagerObjective {
  40         MANAGER_OK,
  41         MANAGER_EXIT,
  42         MANAGER_RELOAD,
  43         MANAGER_REEXECUTE,
  44         MANAGER_REBOOT,
  45         MANAGER_POWEROFF,
  46         MANAGER_HALT,
  47         MANAGER_KEXEC,
  48         MANAGER_SWITCH_ROOT,
  49         _MANAGER_OBJECTIVE_MAX,
  50         _MANAGER_OBJECTIVE_INVALID = -1
  51 } ManagerObjective;
  52
  53 typedef enum StatusType {
  54         STATUS_TYPE_EPHEMERAL,
  55         STATUS_TYPE_NORMAL,
  56         STATUS_TYPE_EMERGENCY,
  57 } StatusType;
  58
  59 /* Notes:
  60  * 1. TIMESTAMP_FIRMWARE, TIMESTAMP_LOADER, TIMESTAMP_KERNEL, TIMESTAMP_INITRD,
  61  *    TIMESTAMP_SECURITY_START, and TIMESTAMP_SECURITY_FINISH are set only when
  62  *    the manager is system and not running under container environment.
  63  *
  64  * 2. The monotonic timestamp of TIMESTAMP_KERNEL is always zero.
  65  *
  66  * 3. The realtime timestamp of TIMESTAMP_KERNEL will be unset if the system does not
  67  *    have RTC.
  68  *
  69  * 4. TIMESTAMP_FIRMWARE and TIMESTAMP_LOADER will be unset if the system does not
  70  *    have RTC, or systemd is built without EFI support.
  71  *
  72  * 5. The monotonic timestamps of TIMESTAMP_FIRMWARE and TIMESTAMP_LOADER are stored as
  73  *    negative of the actual value.
  74  *
  75  * 6. TIMESTAMP_USERSPACE is the timestamp of when the manager was started.
  76  *
  77  * 7. TIMESTAMP_INITRD_* are set only when the system is booted with an initrd.
  78  */
  79
  80 typedef enum ManagerTimestamp {
  81         MANAGER_TIMESTAMP_FIRMWARE,
  82         MANAGER_TIMESTAMP_LOADER,
  83         MANAGER_TIMESTAMP_KERNEL,
  84         MANAGER_TIMESTAMP_INITRD,
  85         MANAGER_TIMESTAMP_USERSPACE,
  86         MANAGER_TIMESTAMP_FINISH,
  87
  88         MANAGER_TIMESTAMP_SECURITY_START,
  89         MANAGER_TIMESTAMP_SECURITY_FINISH,
  90         MANAGER_TIMESTAMP_GENERATORS_START,
  91         MANAGER_TIMESTAMP_GENERATORS_FINISH,
  92         MANAGER_TIMESTAMP_UNITS_LOAD_START,
  93         MANAGER_TIMESTAMP_UNITS_LOAD_FINISH,
  94
  95         MANAGER_TIMESTAMP_INITRD_SECURITY_START,
  96         MANAGER_TIMESTAMP_INITRD_SECURITY_FINISH,
  97         MANAGER_TIMESTAMP_INITRD_GENERATORS_START,
  98         MANAGER_TIMESTAMP_INITRD_GENERATORS_FINISH,
  99         MANAGER_TIMESTAMP_INITRD_UNITS_LOAD_START,
 100         MANAGER_TIMESTAMP_INITRD_UNITS_LOAD_FINISH,
 101         _MANAGER_TIMESTAMP_MAX,
 102         _MANAGER_TIMESTAMP_INVALID = -1,
 103 } ManagerTimestamp;
 104
 105 #include "execute.h"
 106 #include "job.h"
 107 #include "path-lookup.h"
 108 #include "show-status.h"
 109 #include "unit-name.h"
 110
 111 typedef enum ManagerTestRunFlags {
 112         MANAGER_TEST_NORMAL             = 0,       /* run normally */
 113         MANAGER_TEST_RUN_MINIMAL        = 1 << 0,  /* create basic data structures */
 114         MANAGER_TEST_RUN_BASIC          = 1 << 1,  /* interact with the environment */
 115         MANAGER_TEST_RUN_ENV_GENERATORS = 1 << 2,  /* also run env generators  */
 116         MANAGER_TEST_RUN_GENERATORS     = 1 << 3,  /* also run unit generators */
 117         MANAGER_TEST_FULL = MANAGER_TEST_RUN_BASIC | MANAGER_TEST_RUN_ENV_GENERATORS | MANAGER_TEST_RUN_GENERATORS,
 118 } ManagerTestRunFlags;
 119
 120 assert_cc((MANAGER_TEST_FULL & UINT8_MAX) == MANAGER_TEST_FULL);
 121
 122 struct Manager {
 123         /* Note that the set of units we know of is allowed to be
 124          * inconsistent. However the subset of it that is loaded may
 125          * not, and the list of jobs may neither. */
 126
 127         /* Active jobs and units */
 128         Hashmap *units;  /* name string => Unit object n:1 */
 129         Hashmap *units_by_invocation_id;
 130         Hashmap *jobs;   /* job id => Job object 1:1 */
 131
 132         /* To make it easy to iterate through the units of a specific
 133          * type we maintain a per type linked list */
 134         LIST_HEAD(Unit, units_by_type[_UNIT_TYPE_MAX]);
 135
 136         /* Units that need to be loaded */
 137         LIST_HEAD(Unit, load_queue); /* this is actually more a stack than a queue, but uh. */
 138
 139         /* Jobs that need to be run */
 140         LIST_HEAD(Job, run_queue);   /* more a stack than a queue, too */
 141
 142         /* Units and jobs that have not yet been announced via
 143          * D-Bus. When something about a job changes it is added here
 144          * if it is not in there yet. This allows easy coalescing of
 145          * D-Bus change signals. */
 146         LIST_HEAD(Unit, dbus_unit_queue);
 147         LIST_HEAD(Job, dbus_job_queue);
 148
 149         /* Units to remove */
 150         LIST_HEAD(Unit, cleanup_queue);
 151
 152         /* Units and jobs to check when doing GC */
 153         LIST_HEAD(Unit, gc_unit_queue);
 154         LIST_HEAD(Job, gc_job_queue);
 155
 156         /* Units that should be realized */
 157         LIST_HEAD(Unit, cgroup_realize_queue);
 158
 159         /* Units whose cgroup ran empty */
 160         LIST_HEAD(Unit, cgroup_empty_queue);
 161
 162         /* Target units whose default target dependencies haven't been set yet */
 163         LIST_HEAD(Unit, target_deps_queue);
 164
 165         /* Units that might be subject to StopWhenUnneeded= clean-up */
 166         LIST_HEAD(Unit, stop_when_unneeded_queue);
 167
 168         sd_event *event;
 169
 170         /* This maps PIDs we care about to units that are interested in. We allow multiple units to he interested in
 171          * the same PID and multiple PIDs to be relevant to the same unit. Since in most cases only a single unit will
 172          * be interested in the same PID we use a somewhat special encoding here: the first unit interested in a PID is
 173          * stored directly in the hashmap, keyed by the PID unmodified. If there are other units interested too they'll
 174          * be stored in a NULL-terminated array, and keyed by the negative PID. This is safe as pid_t is signed and
 175          * negative PIDs are not used for regular processes but process groups, which we don't care about in this
 176          * context, but this allows us to use the negative range for our own purposes. */
 177         Hashmap *watch_pids;  /* pid => unit as well as -pid => array of units */
 178
 179         /* A set contains all units which cgroup should be refreshed after startup */
 180         Set *startup_units;
 181
 182         /* A set which contains all currently failed units */
 183         Set *failed_units;
 184
 185         sd_event_source *run_queue_event_source;
 186
 187         char *notify_socket;
 188         int notify_fd;
 189         sd_event_source *notify_event_source;
 190
 191         int cgroups_agent_fd;
 192         sd_event_source *cgroups_agent_event_source;
 193
 194         int signal_fd;
 195         sd_event_source *signal_event_source;
 196
 197         sd_event_source *sigchld_event_source;
 198
 199         int time_change_fd;
 200         sd_event_source *time_change_event_source;
 201
 202         sd_event_source *timezone_change_event_source;
 203
 204         sd_event_source *jobs_in_progress_event_source;
 205
 206         int user_lookup_fds[2];
 207         sd_event_source *user_lookup_event_source;
 208
 209         sd_event_source *sync_bus_names_event_source;
 210
 211         UnitFileScope unit_file_scope;
 212         LookupPaths lookup_paths;
 213         Set *unit_path_cache;
 214
 215         char **transient_environment;  /* The environment, as determined from config files, kernel cmdline and environment generators */
 216         char **client_environment;     /* Environment variables created by clients through the bus API */
 217
 218         usec_t runtime_watchdog;
 219         usec_t shutdown_watchdog;
 220
 221         dual_timestamp timestamps[_MANAGER_TIMESTAMP_MAX];
 222
 223         /* Data specific to the device subsystem */
 224         sd_device_monitor *device_monitor;
 225         Hashmap *devices_by_sysfs;
 226
 227         /* Data specific to the mount subsystem */
 228         struct libmnt_monitor *mount_monitor;
 229         sd_event_source *mount_event_source;
 230         sd_event_source *mount_timeout_source;
 231         usec_t mount_last_read_usec;
 232         usec_t mount_last_duration_usec;
 233         unsigned mount_pending_count;
 234
 235         /* Data specific to the swap filesystem */
 236         FILE *proc_swaps;
 237         sd_event_source *swap_event_source;
 238         Hashmap *swaps_by_devnode;
 239
 240         /* Data specific to the D-Bus subsystem */
 241         sd_bus *api_bus, *system_bus;
 242         Set *private_buses;
 243         int private_listen_fd;
 244         sd_event_source *private_listen_event_source;
 245
 246         /* Contains all the clients that are subscribed to signals via
 247         the API bus. Note that private bus connections are always
 248         considered subscribes, since they last for very short only,
 249         and it is much simpler that way. */
 250         sd_bus_track *subscribed;
 251         char **deserialized_subscribed;
 252
 253         /* This is used during reloading: before the reload we queue
 254          * the reply message here, and afterwards we send it */
 255         sd_bus_message *pending_reload_message;
 256
 257         Hashmap *watch_bus;  /* D-Bus names => Unit object n:1 */
 258
 259         bool send_reloading_done;
 260
 261         uint32_t current_job_id;
 262         uint32_t default_unit_job_id;
 263
 264         /* Data specific to the Automount subsystem */
 265         int dev_autofs_fd;
 266
 267         /* Data specific to the cgroup subsystem */
 268         Hashmap *cgroup_unit;
 269         CGroupMask cgroup_supported;
 270         char *cgroup_root;
 271
 272         /* Notifications from cgroups, when the unified hierarchy is used is done via inotify. */
 273         int cgroup_inotify_fd;
 274         sd_event_source *cgroup_inotify_event_source;
 275         Hashmap *cgroup_inotify_wd_unit;
 276
 277         /* A defer event for handling cgroup empty events and processing them after SIGCHLD in all cases. */
 278         sd_event_source *cgroup_empty_event_source;
 279
 280         /* Make sure the user cannot accidentally unmount our cgroup
 281          * file system */
 282         int pin_cgroupfs_fd;
 283
 284         unsigned gc_marker;
 285
 286         /* The stat() data the last time we saw /etc/localtime */
 287         usec_t etc_localtime_mtime;
 288         bool etc_localtime_accessible:1;
 289
 290         ManagerObjective objective:5;
 291
 292         /* Flags */
 293         bool dispatching_load_queue:1;
 294
 295         bool taint_usr:1;
 296
 297         /* Have we already sent out the READY=1 notification? */
 298         bool ready_sent:1;
 299
 300         /* Have we already printed the taint line if necessary? */
 301         bool taint_logged:1;
 302
 303         /* Have we ever changed the "kernel.pid_max" sysctl? */
 304         bool sysctl_pid_max_changed:1;
 305
 306         ManagerTestRunFlags test_run_flags:8;
 307
 308         /* If non-zero, exit with the following value when the systemd
 309          * process terminate. Useful for containers: systemd-nspawn could get
 310          * the return value. */
 311         uint8_t return_value;
 312
 313         ShowStatus show_status;
 314         char *confirm_spawn;
 315         bool no_console_output;
 316         bool service_watchdogs;
 317
 318         ExecOutput default_std_output, default_std_error;
 319
 320         usec_t default_restart_usec, default_timeout_start_usec, default_timeout_stop_usec;
 321
 322         usec_t default_start_limit_interval;
 323         unsigned default_start_limit_burst;
 324
 325         bool default_cpu_accounting;
 326         bool default_memory_accounting;
 327         bool default_io_accounting;
 328         bool default_blockio_accounting;
 329         bool default_tasks_accounting;
 330         bool default_ip_accounting;
 331
 332         uint64_t default_tasks_max;
 333         usec_t default_timer_accuracy_usec;
 334
 335         int original_log_level;
 336         LogTarget original_log_target;
 337         bool log_level_overridden:1;
 338         bool log_target_overridden:1;
 339
 340         struct rlimit *rlimit[_RLIMIT_MAX];
 341
 342         /* non-zero if we are reloading or reexecuting, */
 343         int n_reloading;
 344
 345         unsigned n_installed_jobs;
 346         unsigned n_failed_jobs;
 347
 348         /* Jobs in progress watching */
 349         unsigned n_running_jobs;
 350         unsigned n_on_console;
 351         unsigned jobs_in_progress_iteration;
 352
 353         /* Do we have any outstanding password prompts? */
 354         int have_ask_password;
 355         int ask_password_inotify_fd;
 356         sd_event_source *ask_password_event_source;
 357
 358         /* Type=idle pipes */
 359         int idle_pipe[4];
 360         sd_event_source *idle_pipe_event_source;
 361
 362         char *switch_root;
 363         char *switch_root_init;
 364
 365         /* This maps all possible path prefixes to the units needing
 366          * them. It's a hashmap with a path string as key and a Set as
 367          * value where Unit objects are contained. */
 368         Hashmap *units_requiring_mounts_for;
 369
 370         /* Used for processing polkit authorization responses */
 371         Hashmap *polkit_registry;
 372
 373         /* Dynamic users/groups, indexed by their name */
 374         Hashmap *dynamic_users;
 375
 376         /* Keep track of all UIDs and GIDs any of our services currently use. This is useful for the RemoveIPC= logic. */
 377         Hashmap *uid_refs;
 378         Hashmap *gid_refs;
 379
 380         /* ExecRuntime, indexed by their owner unit id */
 381         Hashmap *exec_runtime_by_id;
 382
 383         /* When the user hits C-A-D more than 7 times per 2s, do something immediately... */
 384         RateLimit ctrl_alt_del_ratelimit;
 385         EmergencyAction cad_burst_action;
 386
 387         const char *unit_log_field;
 388         const char *unit_log_format_string;
 389
 390         const char *invocation_log_field;
 391         const char *invocation_log_format_string;
 392
 393         int first_boot; /* tri-state */
 394
 395         /* Prefixes of e.g. RuntimeDirectory= */
 396         char *prefix[_EXEC_DIRECTORY_TYPE_MAX];
 397
 398         /* Used in the SIGCHLD and sd_notify() message invocation logic to avoid that we dispatch the same event
 399          * multiple times on the same unit. */
 400         unsigned sigchldgen;
 401         unsigned notifygen;
 402 };
 403
 404 #define MANAGER_IS_SYSTEM(m) ((m)->unit_file_scope == UNIT_FILE_SYSTEM)
 405 #define MANAGER_IS_USER(m) ((m)->unit_file_scope != UNIT_FILE_SYSTEM)
 406
 407 #define MANAGER_IS_RELOADING(m) ((m)->n_reloading > 0)
 408
 409 #define MANAGER_IS_FINISHED(m) (dual_timestamp_is_set((m)->timestamps + MANAGER_TIMESTAMP_FINISH))
 410
 411 /* The objective is set to OK as soon as we enter the main loop, and set otherwise as soon as we are done with it */
 412 #define MANAGER_IS_RUNNING(m) ((m)->objective == MANAGER_OK)
 413
 414 #define MANAGER_IS_TEST_RUN(m) ((m)->test_run_flags != 0)
 415
 416 int manager_new(UnitFileScope scope, ManagerTestRunFlags test_run_flags, Manager **m);
 417 Manager* manager_free(Manager *m);
 418 DEFINE_TRIVIAL_CLEANUP_FUNC(Manager*, manager_free);
 419
 420 int manager_startup(Manager *m, FILE *serialization, FDSet *fds);
 421
 422 Job *manager_get_job(Manager *m, uint32_t id);
 423 Unit *manager_get_unit(Manager *m, const char *name);
 424
 425 int manager_get_job_from_dbus_path(Manager *m, const char *s, Job **_j);
 426
 427 int manager_load_unit_prepare(Manager *m, const char *name, const char *path, sd_bus_error *e, Unit **_ret);
 428 int manager_load_unit(Manager *m, const char *name, const char *path, sd_bus_error *e, Unit **_ret);
 429 int manager_load_startable_unit_or_warn(Manager *m, const char *name, const char *path, Unit **ret);
 430 int manager_load_unit_from_dbus_path(Manager *m, const char *s, sd_bus_error *e, Unit **_u);
 431
 432 int manager_add_job(Manager *m, JobType type, Unit *unit, JobMode mode, sd_bus_error *e, Job **_ret);
 433 int manager_add_job_by_name(Manager *m, JobType type, const char *name, JobMode mode, sd_bus_error *e, Job **_ret);
 434 int manager_add_job_by_name_and_warn(Manager *m, JobType type, const char *name, JobMode mode, Job **ret);
 435 int manager_propagate_reload(Manager *m, Unit *unit, JobMode mode, sd_bus_error *e);
 436
 437 void manager_dump_units(Manager *s, FILE *f, const char *prefix);
 438 void manager_dump_jobs(Manager *s, FILE *f, const char *prefix);
 439 void manager_dump(Manager *s, FILE *f, const char *prefix);
 440 int manager_get_dump_string(Manager *m, char **ret);
 441
 442 void manager_clear_jobs(Manager *m);
 443
 444 unsigned manager_dispatch_load_queue(Manager *m);
 445
 446 int manager_default_environment(Manager *m);
 447 int manager_transient_environment_add(Manager *m, char **plus);
 448 int manager_client_environment_modify(Manager *m, char **minus, char **plus);
 449 int manager_get_effective_environment(Manager *m, char ***ret);
 450
 451 int manager_set_default_rlimits(Manager *m, struct rlimit **default_rlimit);
 452
 453 int manager_loop(Manager *m);
 454
 455 int manager_open_serialization(Manager *m, FILE **_f);
 456
 457 int manager_serialize(Manager *m, FILE *f, FDSet *fds, bool switching_root);
 458 int manager_deserialize(Manager *m, FILE *f, FDSet *fds);
 459
 460 int manager_reload(Manager *m);
 461
 462 void manager_reset_failed(Manager *m);
 463
 464 void manager_send_unit_audit(Manager *m, Unit *u, int type, bool success);
 465 void manager_send_unit_plymouth(Manager *m, Unit *u);
 466
 467 bool manager_unit_inactive_or_pending(Manager *m, const char *name);
 468
 469 void manager_check_finished(Manager *m);
 470
 471 void manager_recheck_dbus(Manager *m);
 472 void manager_recheck_journal(Manager *m);
 473
 474 void manager_set_show_status(Manager *m, ShowStatus mode);
 475 void manager_set_first_boot(Manager *m, bool b);
 476
 477 void manager_status_printf(Manager *m, StatusType type, const char *status, const char *format, ...) _printf_(4,5);
 478 void manager_flip_auto_status(Manager *m, bool enable);
 479
 480 Set *manager_get_units_requiring_mounts_for(Manager *m, const char *path);
 481
 482 ManagerState manager_state(Manager *m);
 483
 484 int manager_update_failed_units(Manager *m, Unit *u, bool failed);
 485
 486 void manager_unref_uid(Manager *m, uid_t uid, bool destroy_now);
 487 int manager_ref_uid(Manager *m, uid_t uid, bool clean_ipc);
 488
 489 void manager_unref_gid(Manager *m, gid_t gid, bool destroy_now);
 490 int manager_ref_gid(Manager *m, gid_t gid, bool destroy_now);
 491
 492 void manager_vacuum_uid_refs(Manager *m);
 493 void manager_vacuum_gid_refs(Manager *m);
 494
 495 void manager_serialize_uid_refs(Manager *m, FILE *f);
 496 void manager_deserialize_uid_refs_one(Manager *m, const char *value);
 497
 498 void manager_serialize_gid_refs(Manager *m, FILE *f);
 499 void manager_deserialize_gid_refs_one(Manager *m, const char *value);
 500
 501 char *manager_taint_string(Manager *m);
 502
 503 void manager_ref_console(Manager *m);
 504 void manager_unref_console(Manager *m);
 505
 506 void manager_override_log_level(Manager *m, int level);
 507 void manager_restore_original_log_level(Manager *m);
 508
 509 void manager_override_log_target(Manager *m, LogTarget target);
 510 void manager_restore_original_log_target(Manager *m);
 511
 512 const char *manager_state_to_string(ManagerState m) _const_;
 513 ManagerState manager_state_from_string(const char *s) _pure_;
 514
 515 const char *manager_get_confirm_spawn(Manager *m);
 516 bool manager_is_confirm_spawn_disabled(Manager *m);
 517 void manager_disable_confirm_spawn(void);
 518
 519 const char *manager_timestamp_to_string(ManagerTimestamp m) _const_;
 520 ManagerTimestamp manager_timestamp_from_string(const char *s) _pure_;
 521 ManagerTimestamp manager_timestamp_initrd_mangle(ManagerTimestamp s);