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 typedef struct Manager Manager;
  33 typedef enum WatchType WatchType;
  34 typedef struct Watch Watch;
  35
  36 typedef enum ManagerExitCode {
  37         MANAGER_RUNNING,
  38         MANAGER_EXIT,
  39         MANAGER_RELOAD,
  40         MANAGER_REEXECUTE,
  41         _MANAGER_EXIT_CODE_MAX,
  42         _MANAGER_EXIT_CODE_INVALID = -1
  43 } ManagerExitCode;
  44
  45 typedef enum ManagerRunningAs {
  46         MANAGER_INIT,      /* root and pid=1 */
  47         MANAGER_SYSTEM,    /* root and pid!=1 */
  48         MANAGER_SESSION,   /* non-root, for a session */
  49         _MANAGER_RUNNING_AS_MAX,
  50         _MANAGER_RUNNING_AS_INVALID = -1
  51 } ManagerRunningAs;
  52
  53 enum WatchType {
  54         WATCH_INVALID,
  55         WATCH_SIGNAL,
  56         WATCH_FD,
  57         WATCH_TIMER,
  58         WATCH_MOUNT,
  59         WATCH_UDEV,
  60         WATCH_DBUS_WATCH,
  61         WATCH_DBUS_TIMEOUT
  62 };
  63
  64 struct Watch {
  65         int fd;
  66         WatchType type;
  67         union {
  68                 union Unit *unit;
  69                 DBusWatch *bus_watch;
  70                 DBusTimeout *bus_timeout;
  71                 bool socket_accept;
  72         } data;
  73         bool fd_is_dupped;
  74 };
  75
  76 #include "unit.h"
  77 #include "job.h"
  78 #include "hashmap.h"
  79 #include "list.h"
  80 #include "set.h"
  81 #include "dbus.h"
  82
  83 #define SPECIAL_DEFAULT_TARGET "default.target"
  84
  85 #define SPECIAL_LOGGER_SOCKET "systemd-logger.socket"
  86
  87 #define SPECIAL_KBREQUEST_TARGET "kbrequest.target"
  88 #define SPECIAL_SIGPWR_TARGET "sigpwr.target"
  89 #define SPECIAL_CTRL_ALT_DEL_TARGET "ctrl-alt-del.target"
  90
  91 #define SPECIAL_LOCAL_FS_TARGET "local-fs.target"
  92 #define SPECIAL_REMOTE_FS_TARGET "remote-fs.target"
  93 #define SPECIAL_NETWORK_TARGET "network.target"
  94 #define SPECIAL_NSS_LOOKUP_TARGET "nss-lookup.target"     /* LSB's $named */
  95 #define SPECIAL_RPCBIND_TARGET "rpcbind.target"           /* LSB's $portmap */
  96 #define SPECIAL_SYSLOG_TARGET "syslog.target"             /* Should pull in syslog.socket or syslog.service */
  97 #define SPECIAL_RTC_SET_TARGET "rtc-set.target"           /* LSB's $time */
  98
  99 #define SPECIAL_BASIC_TARGET "basic.target"
 100 #define SPECIAL_RESCUE_TARGET "rescue.target"
 101
 102 #ifndef SPECIAL_DBUS_SERVICE
 103 #define SPECIAL_DBUS_SERVICE "dbus.service"
 104 #endif
 105
 106 #ifndef SPECIAL_SYSLOG_SERVICE
 107 #define SPECIAL_SYSLOG_SERVICE "syslog.service"
 108 #endif
 109
 110 /* For SysV compatibility. Usually an alias for a saner target. On
 111  * SysV-free systems this doesn't exist. */
 112 #define SPECIAL_RUNLEVEL0_TARGET "runlevel0.target"
 113 #define SPECIAL_RUNLEVEL1_TARGET "runlevel1.target"
 114 #define SPECIAL_RUNLEVEL2_TARGET "runlevel2.target"
 115 #define SPECIAL_RUNLEVEL3_TARGET "runlevel3.target"
 116 #define SPECIAL_RUNLEVEL4_TARGET "runlevel4.target"
 117 #define SPECIAL_RUNLEVEL5_TARGET "runlevel5.target"
 118 #define SPECIAL_RUNLEVEL6_TARGET "runlevel6.target"
 119
 120 struct Manager {
 121         uint32_t current_job_id;
 122
 123         /* Note that the set of units we know of is allowed to be
 124          * incosistent. However the subset of it that is loaded may
 125          * not, and the list of jobs may neither. */
 126
 127         /* Active jobs and units */
 128         Hashmap *units;  /* name string => Unit object n:1 */
 129         Hashmap *jobs;   /* job id => Job object 1:1 */
 130
 131         /* To make it easy to iterate through the units of a specific
 132          * type we maintain a per type linked list */
 133         LIST_HEAD(Meta, units_per_type[_UNIT_TYPE_MAX]);
 134
 135         /* Units that need to be loaded */
 136         LIST_HEAD(Meta, load_queue); /* this is actually more a stack than a queue, but uh. */
 137
 138         /* Jobs that need to be run */
 139         LIST_HEAD(Job, run_queue);   /* more a stack than a queue, too */
 140
 141         /* Units and jobs that have not yet been announced via
 142          * D-Bus. When something about a job changes it is added here
 143          * if it is not in there yet. This allows easy coalescing of
 144          * D-Bus change signals. */
 145         LIST_HEAD(Meta, dbus_unit_queue);
 146         LIST_HEAD(Job, dbus_job_queue);
 147
 148         /* Units to remove */
 149         LIST_HEAD(Meta, cleanup_queue);
 150
 151         /* Units to check when doing GC */
 152         LIST_HEAD(Meta, gc_queue);
 153
 154         /* Jobs to be added */
 155         Hashmap *transaction_jobs;      /* Unit object => Job object list 1:1 */
 156         JobDependency *transaction_anchor;
 157
 158         Hashmap *watch_pids;  /* pid => Unit object n:1 */
 159
 160         Watch signal_watch;
 161
 162         int epoll_fd;
 163
 164         unsigned n_snapshots;
 165
 166         char **unit_path;
 167         char **sysvinit_path;
 168         char **sysvrcnd_path;
 169
 170         usec_t boot_timestamp;
 171
 172         /* Data specific to the device subsystem */
 173         struct udev* udev;
 174         struct udev_monitor* udev_monitor;
 175         Watch udev_watch;
 176
 177         /* Data specific to the mount subsystem */
 178         FILE *proc_self_mountinfo;
 179         Watch mount_watch;
 180
 181         /* Data specific to the D-Bus subsystem */
 182         DBusConnection *api_bus, *system_bus;
 183         Set *subscribed;
 184         DBusMessage *queued_message; /* This is used during reloading:
 185                                       * before the reload we queue the
 186                                       * reply message here, and
 187                                       * afterwards we send it */
 188
 189         Hashmap *watch_bus;  /* D-Bus names => Unit object n:1 */
 190         int32_t name_data_slot;
 191
 192         /* Data specific to the Automount subsystem */
 193         int dev_autofs_fd;
 194
 195         /* Data specific to the cgroup subsystem */
 196         Hashmap *cgroup_bondings; /* path string => CGroupBonding object 1:n */
 197         char *cgroup_controller;
 198         char *cgroup_hierarchy;
 199
 200         usec_t gc_queue_timestamp;
 201
 202         int gc_marker;
 203         unsigned n_in_gc_queue;
 204
 205         /* Flags */
 206         ManagerRunningAs running_as;
 207         ManagerExitCode exit_code:4;
 208
 209         bool dispatching_load_queue:1;
 210         bool dispatching_run_queue:1;
 211         bool dispatching_dbus_queue:1;
 212
 213         bool request_api_bus_dispatch:1;
 214         bool request_system_bus_dispatch:1;
 215
 216         bool utmp_reboot_written:1;
 217
 218         bool confirm_spawn:1;
 219 };
 220
 221 int manager_new(ManagerRunningAs running_as, bool confirm_spawn, Manager **m);
 222 void manager_free(Manager *m);
 223
 224 int manager_enumerate(Manager *m);
 225 int manager_coldplug(Manager *m);
 226 int manager_startup(Manager *m, FILE *serialization, FDSet *fds);
 227
 228 Job *manager_get_job(Manager *m, uint32_t id);
 229 Unit *manager_get_unit(Manager *m, const char *name);
 230
 231 int manager_get_unit_from_dbus_path(Manager *m, const char *s, Unit **_u);
 232 int manager_get_job_from_dbus_path(Manager *m, const char *s, Job **_j);
 233
 234 int manager_load_unit(Manager *m, const char *name, const char *path, Unit **_ret);
 235
 236 int manager_add_job(Manager *m, JobType type, Unit *unit, JobMode mode, bool force, Job **_ret);
 237 int manager_add_job_by_name(Manager *m, JobType type, const char *name, JobMode mode, bool force, Job **_ret);
 238
 239 void manager_dump_units(Manager *s, FILE *f, const char *prefix);
 240 void manager_dump_jobs(Manager *s, FILE *f, const char *prefix);
 241
 242 void manager_transaction_unlink_job(Manager *m, Job *j, bool delete_dependencies);
 243
 244 void manager_clear_jobs(Manager *m);
 245
 246 unsigned manager_dispatch_load_queue(Manager *m);
 247 unsigned manager_dispatch_run_queue(Manager *m);
 248 unsigned manager_dispatch_dbus_queue(Manager *m);
 249
 250 int manager_loop(Manager *m);
 251
 252 void manager_write_utmp_reboot(Manager *m);
 253 void manager_write_utmp_runlevel(Manager *m, Unit *t);
 254
 255 void manager_dispatch_bus_name_owner_changed(Manager *m, const char *name, const char* old_owner, const char *new_owner);
 256 void manager_dispatch_bus_query_pid_done(Manager *m, const char *name, pid_t pid);
 257
 258 int manager_open_serialization(FILE **_f);
 259
 260 int manager_serialize(Manager *m, FILE *f, FDSet *fds);
 261 int manager_deserialize(Manager *m, FILE *f, FDSet *fds);
 262
 263 int manager_reload(Manager *m);
 264
 265 const char *manager_running_as_to_string(ManagerRunningAs i);
 266 ManagerRunningAs manager_running_as_from_string(const char *s);
 267
 268 #endif