src/core/manager.h

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