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 <stdbool.h>
  25 #include <inttypes.h>
  26 #include <stdio.h>
  27
  28 #include "sd-bus.h"
  29 #include "sd-event.h"
  30 #include "fdset.h"
  31 #include "cgroup-util.h"
  32
  33 /* Enforce upper limit how many names we allow */
  34 #define MANAGER_MAX_NAMES 131072 /* 128K */
  35
  36 typedef struct Manager Manager;
  37
  38 typedef enum ManagerState {
  39         MANAGER_STARTING,
  40         MANAGER_RUNNING,
  41         MANAGER_DEGRADED,
  42         MANAGER_MAINTENANCE,
  43         MANAGER_STOPPING,
  44         _MANAGER_STATE_MAX,
  45         _MANAGER_STATE_INVALID = -1
  46 } ManagerState;
  47
  48 typedef enum ManagerExitCode {
  49         MANAGER_OK,
  50         MANAGER_EXIT,
  51         MANAGER_RELOAD,
  52         MANAGER_REEXECUTE,
  53         MANAGER_REBOOT,
  54         MANAGER_POWEROFF,
  55         MANAGER_HALT,
  56         MANAGER_KEXEC,
  57         MANAGER_SWITCH_ROOT,
  58         _MANAGER_EXIT_CODE_MAX,
  59         _MANAGER_EXIT_CODE_INVALID = -1
  60 } ManagerExitCode;
  61
  62 #include "unit.h"
  63 #include "job.h"
  64 #include "hashmap.h"
  65 #include "list.h"
  66 #include "set.h"
  67 #include "path-lookup.h"
  68 #include "execute.h"
  69 #include "unit-name.h"
  70 #include "exit-status.h"
  71 #include "show-status.h"
  72
  73 struct Manager {
  74         /* Note that the set of units we know of is allowed to be
  75          * inconsistent. However the subset of it that is loaded may
  76          * not, and the list of jobs may neither. */
  77
  78         /* Active jobs and units */
  79         Hashmap *units;  /* name string => Unit object n:1 */
  80         Hashmap *jobs;   /* job id => Job object 1:1 */
  81
  82         /* To make it easy to iterate through the units of a specific
  83          * type we maintain a per type linked list */
  84         LIST_HEAD(Unit, units_by_type[_UNIT_TYPE_MAX]);
  85
  86         /* Units that need to be loaded */
  87         LIST_HEAD(Unit, load_queue); /* this is actually more a stack than a queue, but uh. */
  88
  89         /* Jobs that need to be run */
  90         LIST_HEAD(Job, run_queue);   /* more a stack than a queue, too */
  91
  92         /* Units and jobs that have not yet been announced via
  93          * D-Bus. When something about a job changes it is added here
  94          * if it is not in there yet. This allows easy coalescing of
  95          * D-Bus change signals. */
  96         LIST_HEAD(Unit, dbus_unit_queue);
  97         LIST_HEAD(Job, dbus_job_queue);
  98
  99         /* Units to remove */
 100         LIST_HEAD(Unit, cleanup_queue);
 101
 102         /* Units to check when doing GC */
 103         LIST_HEAD(Unit, gc_queue);
 104
 105         /* Units that should be realized */
 106         LIST_HEAD(Unit, cgroup_queue);
 107
 108         sd_event *event;
 109
 110         /* We use two hash tables here, since the same PID might be
 111          * watched by two different units: once the unit that forked
 112          * it off, and possibly a different unit to which it was
 113          * joined as cgroup member. Since we know that it is either
 114          * one or two units for each PID we just use to hashmaps
 115          * here. */
 116         Hashmap *watch_pids1;  /* pid => Unit object n:1 */
 117         Hashmap *watch_pids2;  /* pid => Unit object n:1 */
 118
 119         /* A set contains all units which cgroup should be refreshed after startup */
 120         Set *startup_units;
 121
 122         /* A set which contains all currently failed units */
 123         Set *failed_units;
 124
 125         sd_event_source *run_queue_event_source;
 126
 127         char *notify_socket;
 128         int notify_fd;
 129         sd_event_source *notify_event_source;
 130
 131         int signal_fd;
 132         sd_event_source *signal_event_source;
 133
 134         int time_change_fd;
 135         sd_event_source *time_change_event_source;
 136
 137         sd_event_source *jobs_in_progress_event_source;
 138
 139         unsigned n_snapshots;
 140
 141         LookupPaths lookup_paths;
 142         Set *unit_path_cache;
 143
 144         char **environment;
 145
 146         usec_t runtime_watchdog;
 147         usec_t shutdown_watchdog;
 148
 149         dual_timestamp firmware_timestamp;
 150         dual_timestamp loader_timestamp;
 151         dual_timestamp kernel_timestamp;
 152         dual_timestamp initrd_timestamp;
 153         dual_timestamp userspace_timestamp;
 154         dual_timestamp finish_timestamp;
 155         dual_timestamp security_start_timestamp;
 156         dual_timestamp security_finish_timestamp;
 157         dual_timestamp generators_start_timestamp;
 158         dual_timestamp generators_finish_timestamp;
 159         dual_timestamp units_load_start_timestamp;
 160         dual_timestamp units_load_finish_timestamp;
 161
 162         char *generator_unit_path;
 163         char *generator_unit_path_early;
 164         char *generator_unit_path_late;
 165
 166         struct udev* udev;
 167
 168         /* Data specific to the device subsystem */
 169         struct udev_monitor* udev_monitor;
 170         sd_event_source *udev_event_source;
 171         Hashmap *devices_by_sysfs;
 172
 173         /* Data specific to the mount subsystem */
 174         FILE *proc_self_mountinfo;
 175         sd_event_source *mount_event_source;
 176
 177         /* Data specific to the swap filesystem */
 178         FILE *proc_swaps;
 179         sd_event_source *swap_event_source;
 180         Hashmap *swaps_by_devnode;
 181
 182         /* Data specific to the D-Bus subsystem */
 183         sd_bus *api_bus, *system_bus;
 184         Set *private_buses;
 185         int private_listen_fd;
 186         sd_event_source *private_listen_event_source;
 187
 188         /* Contains all the clients that are subscribed to signals via
 189         the API bus. Note that private bus connections are always
 190         considered subscribes, since they last for very short only,
 191         and it is much simpler that way. */
 192         sd_bus_track *subscribed;
 193         char **deserialized_subscribed;
 194
 195         sd_bus_message *queued_message; /* This is used during reloading:
 196                                       * before the reload we queue the
 197                                       * reply message here, and
 198                                       * afterwards we send it */
 199         sd_bus *queued_message_bus; /* The connection to send the queued message on */
 200
 201         Hashmap *watch_bus;  /* D-Bus names => Unit object n:1 */
 202
 203         bool send_reloading_done;
 204
 205         uint32_t current_job_id;
 206         uint32_t default_unit_job_id;
 207
 208         /* Data specific to the Automount subsystem */
 209         int dev_autofs_fd;
 210
 211         /* Data specific to the cgroup subsystem */
 212         Hashmap *cgroup_unit;
 213         CGroupControllerMask cgroup_supported;
 214         char *cgroup_root;
 215
 216         int gc_marker;
 217         unsigned n_in_gc_queue;
 218
 219         /* Make sure the user cannot accidentally unmount our cgroup
 220          * file system */
 221         int pin_cgroupfs_fd;
 222
 223         /* Flags */
 224         SystemdRunningAs running_as;
 225         ManagerExitCode exit_code:5;
 226
 227         bool dispatching_load_queue:1;
 228         bool dispatching_dbus_queue:1;
 229
 230         bool taint_usr:1;
 231
 232         ShowStatus show_status;
 233         bool confirm_spawn;
 234         bool no_console_output;
 235
 236         ExecOutput default_std_output, default_std_error;
 237
 238         usec_t default_restart_usec, default_timeout_start_usec, default_timeout_stop_usec;
 239
 240         usec_t default_start_limit_interval;
 241         unsigned default_start_limit_burst;
 242
 243         bool default_cpu_accounting;
 244         bool default_memory_accounting;
 245         bool default_blockio_accounting;
 246
 247         usec_t default_timer_accuracy_usec;
 248
 249         struct rlimit *rlimit[_RLIMIT_MAX];
 250
 251         /* non-zero if we are reloading or reexecuting, */
 252         int n_reloading;
 253
 254         unsigned n_installed_jobs;
 255         unsigned n_failed_jobs;
 256
 257         /* Jobs in progress watching */
 258         unsigned n_running_jobs;
 259         unsigned n_on_console;
 260         unsigned jobs_in_progress_iteration;
 261
 262         /* Type=idle pipes */
 263         int idle_pipe[4];
 264         sd_event_source *idle_pipe_event_source;
 265
 266         char *switch_root;
 267         char *switch_root_init;
 268
 269         /* This maps all possible path prefixes to the units needing
 270          * them. It's a hashmap with a path string as key and a Set as
 271          * value where Unit objects are contained. */
 272         Hashmap *units_requiring_mounts_for;
 273
 274         /* Reference to the kdbus bus control fd */
 275         int kdbus_fd;
 276 };
 277
 278 int manager_new(SystemdRunningAs running_as, Manager **m);
 279 void manager_free(Manager *m);
 280
 281 int manager_enumerate(Manager *m);
 282 int manager_startup(Manager *m, FILE *serialization, FDSet *fds);
 283
 284 Job *manager_get_job(Manager *m, uint32_t id);
 285 Unit *manager_get_unit(Manager *m, const char *name);
 286
 287 int manager_get_unit_by_path(Manager *m, const char *path, const char *suffix, Unit **_found);
 288
 289 int manager_get_job_from_dbus_path(Manager *m, const char *s, Job **_j);
 290
 291 int manager_load_unit_prepare(Manager *m, const char *name, const char *path, sd_bus_error *e, Unit **_ret);
 292 int manager_load_unit(Manager *m, const char *name, const char *path, sd_bus_error *e, Unit **_ret);
 293 int manager_load_unit_from_dbus_path(Manager *m, const char *s, sd_bus_error *e, Unit **_u);
 294
 295 int manager_add_job(Manager *m, JobType type, Unit *unit, JobMode mode, bool force, sd_bus_error *e, Job **_ret);
 296 int manager_add_job_by_name(Manager *m, JobType type, const char *name, JobMode mode, bool force, sd_bus_error *e, Job **_ret);
 297
 298 void manager_dump_units(Manager *s, FILE *f, const char *prefix);
 299 void manager_dump_jobs(Manager *s, FILE *f, const char *prefix);
 300
 301 void manager_clear_jobs(Manager *m);
 302
 303 unsigned manager_dispatch_load_queue(Manager *m);
 304
 305 int manager_environment_add(Manager *m, char **minus, char **plus);
 306 int manager_set_default_rlimits(Manager *m, struct rlimit **default_rlimit);
 307
 308 int manager_loop(Manager *m);
 309
 310 void manager_dispatch_bus_name_owner_changed(Manager *m, const char *name, const char* old_owner, const char *new_owner);
 311
 312 int manager_open_serialization(Manager *m, FILE **_f);
 313
 314 int manager_serialize(Manager *m, FILE *f, FDSet *fds, bool switching_root);
 315 int manager_deserialize(Manager *m, FILE *f, FDSet *fds);
 316
 317 int manager_reload(Manager *m);
 318
 319 bool manager_is_reloading_or_reexecuting(Manager *m) _pure_;
 320
 321 void manager_reset_failed(Manager *m);
 322
 323 void manager_send_unit_audit(Manager *m, Unit *u, int type, bool success);
 324 void manager_send_unit_plymouth(Manager *m, Unit *u);
 325
 326 bool manager_unit_inactive_or_pending(Manager *m, const char *name);
 327
 328 void manager_check_finished(Manager *m);
 329
 330 void manager_run_generators(Manager *m);
 331 void manager_undo_generators(Manager *m);
 332
 333 void manager_recheck_journal(Manager *m);
 334
 335 void manager_set_show_status(Manager *m, ShowStatus mode);
 336 void manager_status_printf(Manager *m, bool ephemeral, const char *status, const char *format, ...) _printf_(4,5);
 337 void manager_flip_auto_status(Manager *m, bool enable);
 338
 339 Set *manager_get_units_requiring_mounts_for(Manager *m, const char *path);
 340
 341 const char *manager_get_runtime_prefix(Manager *m);
 342
 343 ManagerState manager_state(Manager *m);
 344
 345 const char *manager_state_to_string(ManagerState m) _const_;
 346 ManagerState manager_state_from_string(const char *s) _pure_;