src/manager.h

   1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
   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_EXIT_CODE_MAX,
  45         _MANAGER_EXIT_CODE_INVALID = -1
  46 } ManagerExitCode;
  47
  48 typedef enum ManagerRunningAs {
  49         MANAGER_INIT,      /* root and pid=1 */
  50         MANAGER_SYSTEM,    /* root and pid!=1 */
  51         MANAGER_SESSION,   /* non-root, for a session */
  52         _MANAGER_RUNNING_AS_MAX,
  53         _MANAGER_RUNNING_AS_INVALID = -1
  54 } ManagerRunningAs;
  55
  56 enum WatchType {
  57         WATCH_INVALID,
  58         WATCH_SIGNAL,
  59         WATCH_NOTIFY,
  60         WATCH_FD,
  61         WATCH_TIMER,
  62         WATCH_MOUNT,
  63         WATCH_UDEV,
  64         WATCH_DBUS_WATCH,
  65         WATCH_DBUS_TIMEOUT
  66 };
  67
  68 struct Watch {
  69         int fd;
  70         WatchType type;
  71         union {
  72                 union Unit *unit;
  73                 DBusWatch *bus_watch;
  74                 DBusTimeout *bus_timeout;
  75         } data;
  76         bool fd_is_dupped:1;
  77         bool socket_accept:1;
  78 };
  79
  80 #include "unit.h"
  81 #include "job.h"
  82 #include "hashmap.h"
  83 #include "list.h"
  84 #include "set.h"
  85 #include "dbus.h"
  86 #include "path-lookup.h"
  87
  88 struct Manager {
  89         uint32_t current_job_id;
  90
  91         /* Note that the set of units we know of is allowed to be
  92          * incosistent. However the subset of it that is loaded may
  93          * not, and the list of jobs may neither. */
  94
  95         /* Active jobs and units */
  96         Hashmap *units;  /* name string => Unit object n:1 */
  97         Hashmap *jobs;   /* job id => Job object 1:1 */
  98
  99         /* To make it easy to iterate through the units of a specific
 100          * type we maintain a per type linked list */
 101         LIST_HEAD(Meta, units_per_type[_UNIT_TYPE_MAX]);
 102
 103         /* Units that need to be loaded */
 104         LIST_HEAD(Meta, load_queue); /* this is actually more a stack than a queue, but uh. */
 105
 106         /* Jobs that need to be run */
 107         LIST_HEAD(Job, run_queue);   /* more a stack than a queue, too */
 108
 109         /* Units and jobs that have not yet been announced via
 110          * D-Bus. When something about a job changes it is added here
 111          * if it is not in there yet. This allows easy coalescing of
 112          * D-Bus change signals. */
 113         LIST_HEAD(Meta, dbus_unit_queue);
 114         LIST_HEAD(Job, dbus_job_queue);
 115
 116         /* Units to remove */
 117         LIST_HEAD(Meta, cleanup_queue);
 118
 119         /* Units to check when doing GC */
 120         LIST_HEAD(Meta, gc_queue);
 121
 122         /* Jobs to be added */
 123         Hashmap *transaction_jobs;      /* Unit object => Job object list 1:1 */
 124         JobDependency *transaction_anchor;
 125
 126         Hashmap *watch_pids;  /* pid => Unit object n:1 */
 127
 128         Watch notify_watch;
 129         Watch signal_watch;
 130
 131         int epoll_fd;
 132
 133         unsigned n_snapshots;
 134
 135         LookupPaths lookup_paths;
 136
 137         char **environment;
 138
 139         timestamp startup_timestamp;
 140
 141         /* Data specific to the device subsystem */
 142         struct udev* udev;
 143         struct udev_monitor* udev_monitor;
 144         Watch udev_watch;
 145
 146         /* Data specific to the mount subsystem */
 147         FILE *proc_self_mountinfo;
 148         Watch mount_watch;
 149
 150         /* Data specific to the swap filesystem */
 151         FILE *proc_swaps;
 152
 153         /* Data specific to the D-Bus subsystem */
 154         DBusConnection *api_bus, *system_bus;
 155         Set *subscribed;
 156         DBusMessage *queued_message; /* This is used during reloading:
 157                                       * before the reload we queue the
 158                                       * reply message here, and
 159                                       * afterwards we send it */
 160
 161         Hashmap *watch_bus;  /* D-Bus names => Unit object n:1 */
 162         int32_t name_data_slot;
 163
 164         /* Data specific to the Automount subsystem */
 165         int dev_autofs_fd;
 166
 167         /* Data specific to the cgroup subsystem */
 168         Hashmap *cgroup_bondings; /* path string => CGroupBonding object 1:n */
 169         char *cgroup_controller;
 170         char *cgroup_mount_point;
 171         char *cgroup_hierarchy;
 172
 173         usec_t gc_queue_timestamp;
 174         int gc_marker;
 175         unsigned n_in_gc_queue;
 176
 177         /* Make sure the user cannot accidentaly unmount our cgroup
 178          * file system */
 179         int pin_cgroupfs_fd;
 180
 181         /* Flags */
 182         ManagerRunningAs running_as;
 183         ManagerExitCode exit_code:4;
 184
 185         bool dispatching_load_queue:1;
 186         bool dispatching_run_queue:1;
 187         bool dispatching_dbus_queue:1;
 188
 189         bool request_api_bus_dispatch:1;
 190         bool request_system_bus_dispatch:1;
 191
 192         bool utmp_reboot_written:1;
 193
 194         bool confirm_spawn:1;
 195 };
 196
 197 int manager_new(ManagerRunningAs running_as, bool confirm_spawn, Manager **m);
 198 void manager_free(Manager *m);
 199
 200 int manager_enumerate(Manager *m);
 201 int manager_coldplug(Manager *m);
 202 int manager_startup(Manager *m, FILE *serialization, FDSet *fds);
 203
 204 Job *manager_get_job(Manager *m, uint32_t id);
 205 Unit *manager_get_unit(Manager *m, const char *name);
 206
 207 int manager_get_unit_from_dbus_path(Manager *m, const char *s, Unit **_u);
 208 int manager_get_job_from_dbus_path(Manager *m, const char *s, Job **_j);
 209
 210 int manager_load_unit_prepare(Manager *m, const char *name, const char *path, Unit **_ret);
 211 int manager_load_unit(Manager *m, const char *name, const char *path, Unit **_ret);
 212
 213 int manager_add_job(Manager *m, JobType type, Unit *unit, JobMode mode, bool force, Job **_ret);
 214 int manager_add_job_by_name(Manager *m, JobType type, const char *name, JobMode mode, bool force, Job **_ret);
 215
 216 void manager_dump_units(Manager *s, FILE *f, const char *prefix);
 217 void manager_dump_jobs(Manager *s, FILE *f, const char *prefix);
 218
 219 void manager_transaction_unlink_job(Manager *m, Job *j, bool delete_dependencies);
 220
 221 void manager_clear_jobs(Manager *m);
 222
 223 unsigned manager_dispatch_load_queue(Manager *m);
 224 unsigned manager_dispatch_run_queue(Manager *m);
 225 unsigned manager_dispatch_dbus_queue(Manager *m);
 226
 227 int manager_loop(Manager *m);
 228
 229 void manager_write_utmp_reboot(Manager *m);
 230 void manager_write_utmp_runlevel(Manager *m, Unit *t);
 231
 232 void manager_dispatch_bus_name_owner_changed(Manager *m, const char *name, const char* old_owner, const char *new_owner);
 233 void manager_dispatch_bus_query_pid_done(Manager *m, const char *name, pid_t pid);
 234
 235 int manager_open_serialization(FILE **_f);
 236
 237 int manager_serialize(Manager *m, FILE *f, FDSet *fds);
 238 int manager_deserialize(Manager *m, FILE *f, FDSet *fds);
 239
 240 int manager_reload(Manager *m);
 241
 242 const char *manager_running_as_to_string(ManagerRunningAs i);
 243 ManagerRunningAs manager_running_as_from_string(const char *s);
 244
 245 #endif