src/core/manager.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #ifndef foomanagerhfoo
   4 #define foomanagerhfoo
   5
   6 /***
   7   This file is part of systemd.
   8
   9   Copyright 2010 Lennart Poettering
  10
  11   systemd is free software; you can redistribute it and/or modify it
  12   under the terms of the GNU Lesser General Public License as published by
  13   the Free Software Foundation; either version 2.1 of the License, or
  14   (at your option) any later version.
  15
  16   systemd is distributed in the hope that it will be useful, but
  17   WITHOUT ANY WARRANTY; without even the implied warranty of
  18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19   Lesser General Public License for more details.
  20
  21   You should have received a copy of the GNU Lesser General Public License
  22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  23 ***/
  24
  25 #include <stdbool.h>
  26 #include <inttypes.h>
  27 #include <stdio.h>
  28 #include <dbus/dbus.h>
  29
  30 #include "fdset.h"
  31
  32 /* Enforce upper limit how many names we allow */
  33 #define MANAGER_MAX_NAMES 131072 /* 128K */
  34
  35 typedef struct Manager Manager;
  36 typedef enum WatchType WatchType;
  37 typedef struct Watch Watch;
  38
  39 typedef enum ManagerExitCode {
  40         MANAGER_RUNNING,
  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_EXIT_CODE_MAX,
  50         _MANAGER_EXIT_CODE_INVALID = -1
  51 } ManagerExitCode;
  52
  53 typedef enum ManagerRunningAs {
  54         MANAGER_SYSTEM,
  55         MANAGER_USER,
  56         _MANAGER_RUNNING_AS_MAX,
  57         _MANAGER_RUNNING_AS_INVALID = -1
  58 } ManagerRunningAs;
  59
  60 enum WatchType {
  61         WATCH_INVALID,
  62         WATCH_SIGNAL,
  63         WATCH_NOTIFY,
  64         WATCH_FD,
  65         WATCH_UNIT_TIMER,
  66         WATCH_JOB_TIMER,
  67         WATCH_MOUNT,
  68         WATCH_SWAP,
  69         WATCH_UDEV,
  70         WATCH_DBUS_WATCH,
  71         WATCH_DBUS_TIMEOUT
  72 };
  73
  74 struct Watch {
  75         int fd;
  76         WatchType type;
  77         union {
  78                 struct Unit *unit;
  79                 struct Job *job;
  80                 DBusWatch *bus_watch;
  81                 DBusTimeout *bus_timeout;
  82         } data;
  83         bool fd_is_dupped:1;
  84         bool socket_accept:1;
  85 };
  86
  87 #include "unit.h"
  88 #include "job.h"
  89 #include "hashmap.h"
  90 #include "list.h"
  91 #include "set.h"
  92 #include "dbus.h"
  93 #include "path-lookup.h"
  94
  95 struct Manager {
  96         /* Note that the set of units we know of is allowed to be
  97          * inconsistent. However the subset of it that is loaded may
  98          * not, and the list of jobs may neither. */
  99
 100         /* Active jobs and units */
 101         Hashmap *units;  /* name string => Unit object n:1 */
 102         Hashmap *jobs;   /* job id => Job object 1:1 */
 103
 104         /* To make it easy to iterate through the units of a specific
 105          * type we maintain a per type linked list */
 106         LIST_HEAD(Unit, units_by_type[_UNIT_TYPE_MAX]);
 107
 108         /* To optimize iteration of units that have requires_mounts_for set */
 109         LIST_HEAD(Unit, has_requires_mounts_for);
 110
 111         /* Units that need to be loaded */
 112         LIST_HEAD(Unit, load_queue); /* this is actually more a stack than a queue, but uh. */
 113
 114         /* Jobs that need to be run */
 115         LIST_HEAD(Job, run_queue);   /* more a stack than a queue, too */
 116
 117         /* Units and jobs that have not yet been announced via
 118          * D-Bus. When something about a job changes it is added here
 119          * if it is not in there yet. This allows easy coalescing of
 120          * D-Bus change signals. */
 121         LIST_HEAD(Unit, dbus_unit_queue);
 122         LIST_HEAD(Job, dbus_job_queue);
 123
 124         /* Units to remove */
 125         LIST_HEAD(Unit, cleanup_queue);
 126
 127         /* Units to check when doing GC */
 128         LIST_HEAD(Unit, gc_queue);
 129
 130         Hashmap *watch_pids;  /* pid => Unit object n:1 */
 131
 132         char *notify_socket;
 133
 134         Watch notify_watch;
 135         Watch signal_watch;
 136
 137         int epoll_fd;
 138
 139         unsigned n_snapshots;
 140
 141         LookupPaths lookup_paths;
 142         Set *unit_path_cache;
 143
 144         char **environment;
 145         char **default_controllers;
 146
 147         usec_t runtime_watchdog;
 148         usec_t shutdown_watchdog;
 149
 150         dual_timestamp initrd_timestamp;
 151         dual_timestamp startup_timestamp;
 152         dual_timestamp finish_timestamp;
 153
 154         char *generator_unit_path;
 155         char *generator_unit_path_early;
 156         char *generator_unit_path_late;
 157
 158         /* Data specific to the device subsystem */
 159         struct udev* udev;
 160         struct udev_monitor* udev_monitor;
 161         Watch udev_watch;
 162         Hashmap *devices_by_sysfs;
 163
 164         /* Data specific to the mount subsystem */
 165         FILE *proc_self_mountinfo;
 166         Watch mount_watch;
 167
 168         /* Data specific to the swap filesystem */
 169         FILE *proc_swaps;
 170         Hashmap *swaps_by_proc_swaps;
 171         bool request_reload;
 172         Watch swap_watch;
 173
 174         /* Data specific to the D-Bus subsystem */
 175         DBusConnection *api_bus, *system_bus;
 176         DBusServer *private_bus;
 177         Set *bus_connections, *bus_connections_for_dispatch;
 178
 179         DBusMessage *queued_message; /* This is used during reloading:
 180                                       * before the reload we queue the
 181                                       * reply message here, and
 182                                       * afterwards we send it */
 183         DBusConnection *queued_message_connection; /* The connection to send the queued message on */
 184
 185         Hashmap *watch_bus;  /* D-Bus names => Unit object n:1 */
 186         int32_t name_data_slot;
 187         int32_t conn_data_slot;
 188         int32_t subscribed_data_slot;
 189
 190         uint32_t current_job_id;
 191         uint32_t default_unit_job_id;
 192
 193         /* Data specific to the Automount subsystem */
 194         int dev_autofs_fd;
 195
 196         /* Data specific to the cgroup subsystem */
 197         Hashmap *cgroup_bondings; /* path string => CGroupBonding object 1:n */
 198         char *cgroup_hierarchy;
 199
 200         usec_t gc_queue_timestamp;
 201         int gc_marker;
 202         unsigned n_in_gc_queue;
 203
 204         /* Make sure the user cannot accidentally unmount our cgroup
 205          * file system */
 206         int pin_cgroupfs_fd;
 207
 208         /* Audit fd */
 209 #ifdef HAVE_AUDIT
 210         int audit_fd;
 211 #endif
 212
 213         /* Flags */
 214         ManagerRunningAs running_as;
 215         ManagerExitCode exit_code:5;
 216
 217         bool dispatching_load_queue:1;
 218         bool dispatching_run_queue:1;
 219         bool dispatching_dbus_queue:1;
 220
 221         bool taint_usr:1;
 222
 223         bool show_status;
 224         bool confirm_spawn;
 225
 226         ExecOutput default_std_output, default_std_error;
 227
 228         struct rlimit *rlimit[RLIMIT_NLIMITS];
 229
 230         /* non-zero if we are reloading or reexecuting, */
 231         int n_reloading;
 232
 233         unsigned n_installed_jobs;
 234         unsigned n_failed_jobs;
 235
 236         /* Type=idle pipes */
 237         int idle_pipe[2];
 238
 239         char *switch_root;
 240         char *switch_root_init;
 241 };
 242
 243 int manager_new(ManagerRunningAs running_as, Manager **m);
 244 void manager_free(Manager *m);
 245
 246 int manager_enumerate(Manager *m);
 247 int manager_coldplug(Manager *m);
 248 int manager_startup(Manager *m, FILE *serialization, FDSet *fds);
 249
 250 Job *manager_get_job(Manager *m, uint32_t id);
 251 Unit *manager_get_unit(Manager *m, const char *name);
 252
 253 int manager_get_job_from_dbus_path(Manager *m, const char *s, Job **_j);
 254
 255 int manager_load_unit_prepare(Manager *m, const char *name, const char *path, DBusError *e, Unit **_ret);
 256 int manager_load_unit(Manager *m, const char *name, const char *path, DBusError *e, Unit **_ret);
 257 int manager_load_unit_from_dbus_path(Manager *m, const char *s, DBusError *e, Unit **_u);
 258
 259 int manager_add_job(Manager *m, JobType type, Unit *unit, JobMode mode, bool force, DBusError *e, Job **_ret);
 260 int manager_add_job_by_name(Manager *m, JobType type, const char *name, JobMode mode, bool force, DBusError *e, Job **_ret);
 261
 262 void manager_dump_units(Manager *s, FILE *f, const char *prefix);
 263 void manager_dump_jobs(Manager *s, FILE *f, const char *prefix);
 264
 265 void manager_clear_jobs(Manager *m);
 266
 267 unsigned manager_dispatch_load_queue(Manager *m);
 268 unsigned manager_dispatch_run_queue(Manager *m);
 269 unsigned manager_dispatch_dbus_queue(Manager *m);
 270
 271 int manager_set_default_controllers(Manager *m, char **controllers);
 272 int manager_set_default_rlimits(Manager *m, struct rlimit **default_rlimit);
 273
 274 int manager_loop(Manager *m);
 275
 276 void manager_dispatch_bus_name_owner_changed(Manager *m, const char *name, const char* old_owner, const char *new_owner);
 277 void manager_dispatch_bus_query_pid_done(Manager *m, const char *name, pid_t pid);
 278
 279 int manager_open_serialization(Manager *m, FILE **_f);
 280
 281 int manager_serialize(Manager *m, FILE *f, FDSet *fds, bool serialize_jobs);
 282 int manager_deserialize(Manager *m, FILE *f, FDSet *fds);
 283
 284 int manager_reload(Manager *m);
 285
 286 bool manager_is_booting_or_shutting_down(Manager *m);
 287
 288 void manager_reset_failed(Manager *m);
 289
 290 void manager_send_unit_audit(Manager *m, Unit *u, int type, bool success);
 291 void manager_send_unit_plymouth(Manager *m, Unit *u);
 292
 293 bool manager_unit_pending_inactive(Manager *m, const char *name);
 294
 295 void manager_check_finished(Manager *m);
 296
 297 void manager_run_generators(Manager *m);
 298 void manager_undo_generators(Manager *m);
 299
 300 void manager_recheck_journal(Manager *m);
 301
 302 void manager_set_show_status(Manager *m, bool b);
 303 bool manager_get_show_status(Manager *m);
 304
 305 const char *manager_running_as_to_string(ManagerRunningAs i);
 306 ManagerRunningAs manager_running_as_from_string(const char *s);
 307
 308 #endif