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
  29 #include <dbus/dbus.h>
  30
  31 typedef struct Manager Manager;
  32 typedef enum WatchType WatchType;
  33 typedef struct Watch Watch;
  34
  35 typedef enum ManagerRunningAs {
  36         MANAGER_INIT,      /* root and pid=1 */
  37         MANAGER_SYSTEM,    /* root and pid!=1 */
  38         MANAGER_SESSION,   /* non-root */
  39         _MANAGER_RUNNING_AS_MAX,
  40         _MANAGER_RUNNING_AS_INVALID = -1
  41 } ManagerRunningAs;
  42
  43 enum WatchType {
  44         WATCH_INVALID,
  45         WATCH_SIGNAL,
  46         WATCH_FD,
  47         WATCH_TIMER,
  48         WATCH_MOUNT,
  49         WATCH_UDEV,
  50         WATCH_DBUS_WATCH,
  51         WATCH_DBUS_TIMEOUT
  52 };
  53
  54 struct Watch {
  55         int fd;
  56         WatchType type;
  57         bool fd_is_dupped;
  58         union {
  59                 union Unit *unit;
  60                 DBusWatch *bus_watch;
  61                 DBusTimeout *bus_timeout;
  62         } data;
  63 };
  64
  65 #include "unit.h"
  66 #include "job.h"
  67 #include "hashmap.h"
  68 #include "list.h"
  69 #include "set.h"
  70 #include "dbus.h"
  71
  72 #define SPECIAL_DEFAULT_TARGET "default.target"
  73 #define SPECIAL_SYSLOG_SERVICE "syslog.service"
  74 #define SPECIAL_DBUS_SERVICE "messagebus.service"
  75 #define SPECIAL_LOGGER_SOCKET "systemd-logger.socket"
  76 #define SPECIAL_KBREQUEST_TARGET "kbrequest.target"
  77 #define SPECIAL_CTRL_ALT_DEL_TARGET "ctrl-alt-del.target"
  78 #define SPECIAL_LOCAL_FS_TARGET "local-fs.target"
  79 #define SPECIAL_NETWORK_TARGET "network.target"
  80 #define SPECIAL_NSS_LOOKUP_TARGET "nss-lookup.target"     /* LSB's $named */
  81 #define SPECIAL_RPCBIND_TARGET "rpcbind.target"           /* LSB's $portmap */
  82 #define SPECIAL_REMOTE_FS_TARGET "remote-fs.target"
  83 #define SPECIAL_SYSLOG_TARGET "syslog.target"             /* Should pull in syslog.socket or syslog.service */
  84 #define SPECIAL_RTC_SET_TARGET "rtc-set.target"           /* LSB's $time */
  85 #define SPECIAL_BASIC_TARGET "basic.target"
  86 #define SPECIAL_RESCUE_TARGET "rescue.target"
  87
  88 /* For SysV compatibility. Usually an alias for a saner target. On
  89  * SysV-free systems this doesn't exist. */
  90 #define SPECIAL_RUNLEVEL0_TARGET "runlevel0.target"
  91 #define SPECIAL_RUNLEVEL1_TARGET "runlevel1.target"
  92 #define SPECIAL_RUNLEVEL2_TARGET "runlevel2.target"
  93 #define SPECIAL_RUNLEVEL3_TARGET "runlevel3.target"
  94 #define SPECIAL_RUNLEVEL4_TARGET "runlevel4.target"
  95 #define SPECIAL_RUNLEVEL5_TARGET "runlevel5.target"
  96 #define SPECIAL_RUNLEVEL6_TARGET "runlevel6.target"
  97
  98 struct Manager {
  99         /* In which mode are we running */
 100         ManagerRunningAs running_as;
 101
 102         uint32_t current_job_id;
 103
 104         /* Note that the set of units we know of is allowed to be
 105          * incosistent. However the subset of it that is loaded may
 106          * not, and the list of jobs may neither. */
 107
 108         /* Active jobs and units */
 109         Hashmap *units;  /* name string => Unit object n:1 */
 110         Hashmap *jobs;   /* job id => Job object 1:1 */
 111
 112         /* To make it easy to iterate through the units of a specific
 113          * type we maintain a per type linked list */
 114         LIST_HEAD(Meta, units_per_type[_UNIT_TYPE_MAX]);
 115
 116         /* Units that need to be loaded */
 117         LIST_HEAD(Meta, load_queue); /* this is actually more a stack than a queue, but uh. */
 118
 119         /* Jobs that need to be run */
 120         LIST_HEAD(Job, run_queue);   /* more a stack than a queue, too */
 121
 122         /* Units and jobs that have not yet been announced via
 123          * D-Bus. When something about a job changes it is added here
 124          * if it is not in there yet. This allows easy coalescing of
 125          * D-Bus change signals. */
 126         LIST_HEAD(Meta, dbus_unit_queue);
 127         LIST_HEAD(Job, dbus_job_queue);
 128
 129         LIST_HEAD(Meta, cleanup_queue);
 130
 131         /* Jobs to be added */
 132         Hashmap *transaction_jobs;      /* Unit object => Job object list 1:1 */
 133         JobDependency *transaction_anchor;
 134
 135         bool dispatching_load_queue:1;
 136         bool dispatching_run_queue:1;
 137         bool dispatching_dbus_queue:1;
 138
 139         bool request_api_bus_dispatch:1;
 140         bool request_system_bus_dispatch:1;
 141
 142         Hashmap *watch_pids;  /* pid => Unit object n:1 */
 143
 144         int epoll_fd;
 145
 146         Watch signal_watch;
 147
 148         char **unit_path;
 149         char **sysvinit_path;
 150         char **sysvrcnd_path;
 151
 152         /* Data specific to the device subsystem */
 153         struct udev* udev;
 154         struct udev_monitor* udev_monitor;
 155         Watch udev_watch;
 156
 157         /* Data specific to the mount subsystem */
 158         FILE *proc_self_mountinfo;
 159         Watch mount_watch;
 160
 161         /* Data specific to the D-Bus subsystem */
 162         DBusConnection *api_bus, *system_bus;
 163         Set *subscribed;
 164
 165         /* Data specific to the cgroup subsystem */
 166         Hashmap *cgroup_bondings; /* path string => CGroupBonding object 1:n */
 167         char *cgroup_controller;
 168         char *cgroup_hierarchy;
 169 };
 170
 171 int manager_new(ManagerRunningAs running_as, Manager **m);
 172 void manager_free(Manager *m);
 173
 174 int manager_coldplug(Manager *m);
 175
 176 Job *manager_get_job(Manager *m, uint32_t id);
 177 Unit *manager_get_unit(Manager *m, const char *name);
 178
 179 int manager_get_unit_from_dbus_path(Manager *m, const char *s, Unit **_u);
 180 int manager_get_job_from_dbus_path(Manager *m, const char *s, Job **_j);
 181
 182 int manager_load_unit(Manager *m, const char *path_or_name, Unit **_ret);
 183 int manager_add_job(Manager *m, JobType type, Unit *unit, JobMode mode, bool force, Job **_ret);
 184
 185 void manager_dump_units(Manager *s, FILE *f, const char *prefix);
 186 void manager_dump_jobs(Manager *s, FILE *f, const char *prefix);
 187
 188 void manager_transaction_unlink_job(Manager *m, Job *j, bool delete_dependencies);
 189
 190 void manager_clear_jobs(Manager *m);
 191
 192 unsigned manager_dispatch_load_queue(Manager *m);
 193 unsigned manager_dispatch_run_queue(Manager *m);
 194 unsigned manager_dispatch_dbus_queue(Manager *m);
 195
 196 int manager_loop(Manager *m);
 197
 198 const char *manager_running_as_to_string(ManagerRunningAs i);
 199 ManagerRunningAs manager_running_as_from_string(const char *s);
 200
 201 #endif