src/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 General Public License as published by
  13   the Free Software Foundation; either version 2 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   General Public License for more details.
  20
  21   You should have received a copy of the GNU 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 2048
  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_EXIT_CODE_MAX,
  49         _MANAGER_EXIT_CODE_INVALID = -1
  50 } ManagerExitCode;
  51
  52 typedef enum ManagerRunningAs {
  53         MANAGER_SYSTEM,
  54         MANAGER_SESSION,
  55         _MANAGER_RUNNING_AS_MAX,
  56         _MANAGER_RUNNING_AS_INVALID = -1
  57 } ManagerRunningAs;
  58
  59 enum WatchType {
  60         WATCH_INVALID,
  61         WATCH_SIGNAL,
  62         WATCH_NOTIFY,
  63         WATCH_FD,
  64         WATCH_UNIT_TIMER,
  65         WATCH_JOB_TIMER,
  66         WATCH_MOUNT,
  67         WATCH_UDEV,
  68         WATCH_DBUS_WATCH,
  69         WATCH_DBUS_TIMEOUT
  70 };
  71
  72 struct Watch {
  73         int fd;
  74         WatchType type;
  75         union {
  76                 union Unit *unit;
  77                 struct Job *job;
  78                 DBusWatch *bus_watch;
  79                 DBusTimeout *bus_timeout;
  80         } data;
  81         bool fd_is_dupped:1;
  82         bool socket_accept:1;
  83 };
  84
  85 #include "unit.h"
  86 #include "job.h"
  87 #include "hashmap.h"
  88 #include "list.h"
  89 #include "set.h"
  90 #include "dbus.h"
  91 #include "path-lookup.h"
  92
  93 struct Manager {
  94         /* Note that the set of units we know of is allowed to be
  95          * incosistent. However the subset of it that is loaded may
  96          * not, and the list of jobs may neither. */
  97
  98         /* Active jobs and units */
  99         Hashmap *units;  /* name string => Unit object n:1 */
 100         Hashmap *jobs;   /* job id => Job object 1:1 */
 101
 102         /* To make it easy to iterate through the units of a specific
 103          * type we maintain a per type linked list */
 104         LIST_HEAD(Meta, units_per_type[_UNIT_TYPE_MAX]);
 105
 106         /* Units that need to be loaded */
 107         LIST_HEAD(Meta, load_queue); /* this is actually more a stack than a queue, but uh. */
 108
 109         /* Jobs that need to be run */
 110         LIST_HEAD(Job, run_queue);   /* more a stack than a queue, too */
 111
 112         /* Units and jobs that have not yet been announced via
 113          * D-Bus. When something about a job changes it is added here
 114          * if it is not in there yet. This allows easy coalescing of
 115          * D-Bus change signals. */
 116         LIST_HEAD(Meta, dbus_unit_queue);
 117         LIST_HEAD(Job, dbus_job_queue);
 118
 119         /* Units to remove */
 120         LIST_HEAD(Meta, cleanup_queue);
 121
 122         /* Units to check when doing GC */
 123         LIST_HEAD(Meta, gc_queue);
 124
 125         /* Jobs to be added */
 126         Hashmap *transaction_jobs;      /* Unit object => Job object list 1:1 */
 127         JobDependency *transaction_anchor;
 128
 129         Hashmap *watch_pids;  /* pid => Unit object n:1 */
 130
 131         char *notify_socket;
 132
 133         Watch notify_watch;
 134         Watch signal_watch;
 135
 136         int epoll_fd;
 137
 138         unsigned n_snapshots;
 139
 140         LookupPaths lookup_paths;
 141         Set *unit_path_cache;
 142
 143         char **environment;
 144
 145         dual_timestamp startup_timestamp;
 146         dual_timestamp finish_timestamp;
 147
 148         char *console;
 149
 150         /* Data specific to the device subsystem */
 151         struct udev* udev;
 152         struct udev_monitor* udev_monitor;
 153         Watch udev_watch;
 154         Hashmap *devices_by_sysfs;
 155
 156         /* Data specific to the mount subsystem */
 157         FILE *proc_self_mountinfo;
 158         Watch mount_watch;
 159
 160         /* Data specific to the swap filesystem */
 161         FILE *proc_swaps;
 162         Hashmap *swaps_by_proc_swaps;
 163         bool request_reload;
 164
 165         /* Data specific to the D-Bus subsystem */
 166         DBusConnection *api_bus, *system_bus;
 167         DBusServer *private_bus;
 168         Set *bus_connections, *bus_connections_for_dispatch;
 169
 170         DBusMessage *queued_message; /* This is used during reloading:
 171                                       * before the reload we queue the
 172                                       * reply message here, and
 173                                       * afterwards we send it */
 174         DBusConnection *queued_message_connection; /* The connection to send the queued message on */
 175
 176         Hashmap *watch_bus;  /* D-Bus names => Unit object n:1 */
 177         int32_t name_data_slot;
 178         int32_t subscribed_data_slot;
 179
 180         uint32_t current_job_id;
 181
 182         /* Data specific to the Automount subsystem */
 183         int dev_autofs_fd;
 184
 185         /* Data specific to the cgroup subsystem */
 186         Hashmap *cgroup_bondings; /* path string => CGroupBonding object 1:n */
 187         char *cgroup_hierarchy;
 188
 189         usec_t gc_queue_timestamp;
 190         int gc_marker;
 191         unsigned n_in_gc_queue;
 192
 193         /* Make sure the user cannot accidentaly unmount our cgroup
 194          * file system */
 195         int pin_cgroupfs_fd;
 196
 197         /* Audit fd */
 198 #ifdef HAVE_AUDIT
 199         int audit_fd;
 200 #endif
 201
 202         /* Flags */
 203         ManagerRunningAs running_as;
 204         ManagerExitCode exit_code:5;
 205
 206         bool dispatching_load_queue:1;
 207         bool dispatching_run_queue:1;
 208         bool dispatching_dbus_queue:1;
 209
 210         bool show_status;
 211         bool confirm_spawn;
 212 #ifdef HAVE_SYSV_COMPAT
 213         bool sysv_console;
 214 #endif
 215         bool mount_auto;
 216         bool swap_auto;
 217
 218         int n_deserializing;
 219
 220         unsigned n_installed_jobs;
 221         unsigned n_failed_jobs;
 222 };
 223
 224 int manager_new(ManagerRunningAs running_as, Manager **m);
 225 void manager_free(Manager *m);
 226
 227 int manager_enumerate(Manager *m);
 228 int manager_coldplug(Manager *m);
 229 int manager_startup(Manager *m, FILE *serialization, FDSet *fds);
 230
 231 Job *manager_get_job(Manager *m, uint32_t id);
 232 Unit *manager_get_unit(Manager *m, const char *name);
 233
 234 int manager_get_unit_from_dbus_path(Manager *m, const char *s, Unit **_u);
 235 int manager_get_job_from_dbus_path(Manager *m, const char *s, Job **_j);
 236
 237 int manager_load_unit_prepare(Manager *m, const char *name, const char *path, DBusError *e, Unit **_ret);
 238 int manager_load_unit(Manager *m, const char *name, const char *path, DBusError *e, Unit **_ret);
 239
 240 int manager_add_job(Manager *m, JobType type, Unit *unit, JobMode mode, bool force, DBusError *e, Job **_ret);
 241 int manager_add_job_by_name(Manager *m, JobType type, const char *name, JobMode mode, bool force, DBusError *e, Job **_ret);
 242
 243 void manager_dump_units(Manager *s, FILE *f, const char *prefix);
 244 void manager_dump_jobs(Manager *s, FILE *f, const char *prefix);
 245
 246 void manager_transaction_unlink_job(Manager *m, Job *j, bool delete_dependencies);
 247
 248 void manager_clear_jobs(Manager *m);
 249
 250 unsigned manager_dispatch_load_queue(Manager *m);
 251 unsigned manager_dispatch_run_queue(Manager *m);
 252 unsigned manager_dispatch_dbus_queue(Manager *m);
 253
 254 int manager_set_console(Manager *m, const char *console);
 255
 256 int manager_loop(Manager *m);
 257
 258 void manager_dispatch_bus_name_owner_changed(Manager *m, const char *name, const char* old_owner, const char *new_owner);
 259 void manager_dispatch_bus_query_pid_done(Manager *m, const char *name, pid_t pid);
 260
 261 int manager_open_serialization(Manager *m, FILE **_f);
 262
 263 int manager_serialize(Manager *m, FILE *f, FDSet *fds);
 264 int manager_deserialize(Manager *m, FILE *f, FDSet *fds);
 265
 266 int manager_reload(Manager *m);
 267
 268 bool manager_is_booting_or_shutting_down(Manager *m);
 269
 270 void manager_reset_failed(Manager *m);
 271
 272 void manager_send_unit_audit(Manager *m, Unit *u, int type, bool success);
 273 void manager_send_unit_plymouth(Manager *m, Unit *u);
 274
 275 bool manager_unit_pending_inactive(Manager *m, const char *name);
 276
 277 void manager_check_finished(Manager *m);
 278
 279 const char *manager_running_as_to_string(ManagerRunningAs i);
 280 ManagerRunningAs manager_running_as_from_string(const char *s);
 281
 282 #endif