src/dbus-unit.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #ifndef foodbusunithfoo
   4 #define foodbusunithfoo
   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 <dbus/dbus.h>
  26
  27 #include "manager.h"
  28
  29 #define BUS_UNIT_INTERFACE \
  30         " <interface name=\"org.freedesktop.systemd1.Unit\">\n"         \
  31         "  <method name=\"Start\">\n"                                   \
  32         "   <arg name=\"mode\" type=\"s\" direction=\"in\"/>\n"         \
  33         "   <arg name=\"job\" type=\"o\" direction=\"out\"/>\n"         \
  34         "  </method>\n"                                                 \
  35         "  <method name=\"Stop\">\n"                                    \
  36         "   <arg name=\"mode\" type=\"s\" direction=\"in\"/>\n"         \
  37         "   <arg name=\"job\" type=\"o\" direction=\"out\"/>\n"         \
  38         "  </method>\n"                                                 \
  39         "  <method name=\"Reload\">\n"                                  \
  40         "   <arg name=\"mode\" type=\"s\" direction=\"in\"/>\n"         \
  41         "   <arg name=\"job\" type=\"o\" direction=\"out\"/>\n"         \
  42         "  </method>\n"                                                 \
  43         "  <method name=\"Restart\">\n"                                 \
  44         "   <arg name=\"mode\" type=\"s\" direction=\"in\"/>\n"         \
  45         "   <arg name=\"job\" type=\"o\" direction=\"out\"/>\n"         \
  46         "  </method>\n"                                                 \
  47         "  <method name=\"TryRestart\">\n"                              \
  48         "   <arg name=\"mode\" type=\"s\" direction=\"in\"/>\n"         \
  49         "   <arg name=\"job\" type=\"o\" direction=\"out\"/>\n"         \
  50         "  </method>\n"                                                 \
  51         "  <method name=\"ReloadOrRestart\">\n"                         \
  52         "   <arg name=\"mode\" type=\"s\" direction=\"in\"/>\n"         \
  53         "   <arg name=\"job\" type=\"o\" direction=\"out\"/>\n"         \
  54         "  </method>\n"                                                 \
  55         "  <method name=\"ReloadOrTryRestart\">\n"                      \
  56         "   <arg name=\"mode\" type=\"s\" direction=\"in\"/>\n"         \
  57         "   <arg name=\"job\" type=\"o\" direction=\"out\"/>\n"         \
  58         "  </method>\n"                                                 \
  59         "  <method name=\"Kill\">\n"                                    \
  60         "   <arg name=\"who\" type=\"s\" direction=\"in\"/>\n"          \
  61         "   <arg name=\"mode\" type=\"s\" direction=\"in\"/>\n"         \
  62         "   <arg name=\"signal\" type=\"i\" direction=\"in\"/>\n"       \
  63         "  </method>\n"                                                 \
  64         "  <method name=\"ResetFailed\"/>\n"                            \
  65         "  <property name=\"Id\" type=\"s\" access=\"read\"/>\n"        \
  66         "  <property name=\"Names\" type=\"as\" access=\"read\"/>\n"    \
  67         "  <property name=\"Following\" type=\"s\" access=\"read\"/>\n" \
  68         "  <property name=\"Requires\" type=\"as\" access=\"read\"/>\n" \
  69         "  <property name=\"RequiresOverridable\" type=\"as\" access=\"read\"/>\n" \
  70         "  <property name=\"Requisite\" type=\"as\" access=\"read\"/>\n" \
  71         "  <property name=\"RequisiteOverridable\" type=\"as\" access=\"read\"/>\n" \
  72         "  <property name=\"Wants\" type=\"as\" access=\"read\"/>\n"    \
  73         "  <property name=\"BindTo\" type=\"as\" access=\"read\"/>\n"    \
  74         "  <property name=\"RequiredBy\" type=\"as\" access=\"read\"/>\n" \
  75         "  <property name=\"RequiredByOverridable\" type=\"as\" access=\"read\"/>\n" \
  76         "  <property name=\"WantedBy\" type=\"as\" access=\"read\"/>\n" \
  77         "  <property name=\"BoundBy\" type=\"as\" access=\"read\"/>\n" \
  78         "  <property name=\"Conflicts\" type=\"as\" access=\"read\"/>\n" \
  79         "  <property name=\"ConflictedBy\" type=\"as\" access=\"read\"/>\n" \
  80         "  <property name=\"Before\" type=\"as\" access=\"read\"/>\n"   \
  81         "  <property name=\"After\" type=\"as\" access=\"read\"/>\n"    \
  82         "  <property name=\"OnFailure\" type=\"as\" access=\"read\"/>\n"    \
  83         "  <property name=\"Triggers\" type=\"as\" access=\"read\"/>\n"    \
  84         "  <property name=\"TriggeredBy\" type=\"as\" access=\"read\"/>\n"    \
  85         "  <property name=\"PropagateReloadTo\" type=\"as\" access=\"read\"/>\n" \
  86         "  <property name=\"PropagateReloadFrom\" type=\"as\" access=\"read\"/>\n" \
  87         "  <property name=\"Description\" type=\"s\" access=\"read\"/>\n" \
  88         "  <property name=\"LoadState\" type=\"s\" access=\"read\"/>\n" \
  89         "  <property name=\"ActiveState\" type=\"s\" access=\"read\"/>\n" \
  90         "  <property name=\"SubState\" type=\"s\" access=\"read\"/>\n"  \
  91         "  <property name=\"FragmentPath\" type=\"s\" access=\"read\"/>\n" \
  92         "  <property name=\"UnitFileState\" type=\"s\" access=\"read\"/>\n" \
  93         "  <property name=\"InactiveExitTimestamp\" type=\"t\" access=\"read\"/>\n" \
  94         "  <property name=\"InactiveExitTimestampMonotonic\" type=\"t\" access=\"read\"/>\n" \
  95         "  <property name=\"ActiveEnterTimestamp\" type=\"t\" access=\"read\"/>\n" \
  96         "  <property name=\"ActiveEnterTimestampMonotonic\" type=\"t\" access=\"read\"/>\n" \
  97         "  <property name=\"ActiveExitTimestamp\" type=\"t\" access=\"read\"/>\n" \
  98         "  <property name=\"ActiveExitTimestampMonotonic\" type=\"t\" access=\"read\"/>\n" \
  99         "  <property name=\"InactiveEnterTimestamp\" type=\"t\" access=\"read\"/>\n" \
 100         "  <property name=\"InactiveEnterTimestampMonotonic\" type=\"t\" access=\"read\"/>\n" \
 101         "  <property name=\"CanStart\" type=\"b\" access=\"read\"/>\n"  \
 102         "  <property name=\"CanStop\" type=\"b\" access=\"read\"/>\n"   \
 103         "  <property name=\"CanReload\" type=\"b\" access=\"read\"/>\n" \
 104         "  <property name=\"CanIsolate\" type=\"b\" access=\"read\"/>\n" \
 105         "  <property name=\"Job\" type=\"(uo)\" access=\"read\"/>\n"    \
 106         "  <property name=\"StopWhenUnneeded\" type=\"b\" access=\"read\"/>\n" \
 107         "  <property name=\"RefuseManualStart\" type=\"b\" access=\"read\"/>\n" \
 108         "  <property name=\"RefuseManualStop\" type=\"b\" access=\"read\"/>\n" \
 109         "  <property name=\"AllowIsolate\" type=\"b\" access=\"read\"/>\n" \
 110         "  <property name=\"DefaultDependencies\" type=\"b\" access=\"read\"/>\n" \
 111         "  <property name=\"OnFailureIsolate\" type=\"b\" access=\"read\"/>\n" \
 112         "  <property name=\"IgnoreOnIsolate\" type=\"b\" access=\"read\"/>\n" \
 113         "  <property name=\"IgnoreOnSnapshot\" type=\"b\" access=\"read\"/>\n" \
 114         "  <property name=\"DefaultControlGroup\" type=\"s\" access=\"read\"/>\n" \
 115         "  <property name=\"ControlGroup\" type=\"as\" access=\"read\"/>\n" \
 116         "  <property name=\"ControlGroupAttributes\" type=\"a(sss)\" access=\"read\"/>\n" \
 117         "  <property name=\"NeedDaemonReload\" type=\"b\" access=\"read\"/>\n" \
 118         "  <property name=\"JobTimeoutUSec\" type=\"t\" access=\"read\"/>\n" \
 119         "  <property name=\"ConditionTimestamp\" type=\"t\" access=\"read\"/>\n" \
 120         "  <property name=\"ConditionTimestampMonotonic\" type=\"t\" access=\"read\"/>\n" \
 121         "  <property name=\"ConditionResult\" type=\"b\" access=\"read\"/>\n" \
 122         "  <property name=\"LoadError\" type=\"(ss)\" access=\"read\"/>\n" \
 123         " </interface>\n"
 124
 125 #define BUS_UNIT_INTERFACES_LIST                \
 126         BUS_GENERIC_INTERFACES_LIST             \
 127         "org.freedesktop.systemd1.Unit\0"
 128
 129 #define BUS_UNIT_PROPERTIES \
 130         { "org.freedesktop.systemd1.Unit", "Id",                   bus_property_append_string,     "s",    u->meta.id                        }, \
 131         { "org.freedesktop.systemd1.Unit", "Names",                bus_unit_append_names,          "as",   u                                 }, \
 132         { "org.freedesktop.systemd1.Unit", "Following",            bus_unit_append_following,      "s",    u                                 }, \
 133         { "org.freedesktop.systemd1.Unit", "Requires",             bus_unit_append_dependencies,   "as",   u->meta.dependencies[UNIT_REQUIRES] }, \
 134         { "org.freedesktop.systemd1.Unit", "RequiresOverridable",  bus_unit_append_dependencies,   "as",   u->meta.dependencies[UNIT_REQUIRES_OVERRIDABLE] }, \
 135         { "org.freedesktop.systemd1.Unit", "Requisite",            bus_unit_append_dependencies,   "as",   u->meta.dependencies[UNIT_REQUISITE] }, \
 136         { "org.freedesktop.systemd1.Unit", "RequisiteOverridable", bus_unit_append_dependencies,   "as",   u->meta.dependencies[UNIT_REQUISITE_OVERRIDABLE] }, \
 137         { "org.freedesktop.systemd1.Unit", "Wants",                bus_unit_append_dependencies,   "as",   u->meta.dependencies[UNIT_WANTS]  }, \
 138         { "org.freedesktop.systemd1.Unit", "BindTo",               bus_unit_append_dependencies,   "as",   u->meta.dependencies[UNIT_BIND_TO]  }, \
 139         { "org.freedesktop.systemd1.Unit", "RequiredBy",           bus_unit_append_dependencies,   "as",   u->meta.dependencies[UNIT_REQUIRED_BY] }, \
 140         { "org.freedesktop.systemd1.Unit", "RequiredByOverridable",bus_unit_append_dependencies,   "as",   u->meta.dependencies[UNIT_REQUIRED_BY_OVERRIDABLE] }, \
 141         { "org.freedesktop.systemd1.Unit", "WantedBy",             bus_unit_append_dependencies,   "as",   u->meta.dependencies[UNIT_WANTED_BY] }, \
 142         { "org.freedesktop.systemd1.Unit", "BoundBy",              bus_unit_append_dependencies,   "as",   u->meta.dependencies[UNIT_BOUND_BY]  }, \
 143         { "org.freedesktop.systemd1.Unit", "Conflicts",            bus_unit_append_dependencies,   "as",   u->meta.dependencies[UNIT_CONFLICTS] }, \
 144         { "org.freedesktop.systemd1.Unit", "ConflictedBy",         bus_unit_append_dependencies,   "as",   u->meta.dependencies[UNIT_CONFLICTED_BY] }, \
 145         { "org.freedesktop.systemd1.Unit", "Before",               bus_unit_append_dependencies,   "as",   u->meta.dependencies[UNIT_BEFORE] }, \
 146         { "org.freedesktop.systemd1.Unit", "After",                bus_unit_append_dependencies,   "as",   u->meta.dependencies[UNIT_AFTER]  }, \
 147         { "org.freedesktop.systemd1.Unit", "OnFailure",            bus_unit_append_dependencies,   "as",   u->meta.dependencies[UNIT_ON_FAILURE] }, \
 148         { "org.freedesktop.systemd1.Unit", "Triggers",             bus_unit_append_dependencies,   "as",   u->meta.dependencies[UNIT_TRIGGERS] }, \
 149         { "org.freedesktop.systemd1.Unit", "TriggeredBy",          bus_unit_append_dependencies,   "as",   u->meta.dependencies[UNIT_TRIGGERED_BY] }, \
 150         { "org.freedesktop.systemd1.Unit", "PropagateReloadTo",    bus_unit_append_dependencies,   "as",   u->meta.dependencies[UNIT_PROPAGATE_RELOAD_TO] }, \
 151         { "org.freedesktop.systemd1.Unit", "PropagateReloadFrom",  bus_unit_append_dependencies,   "as",   u->meta.dependencies[UNIT_PROPAGATE_RELOAD_FROM] }, \
 152         { "org.freedesktop.systemd1.Unit", "Description",          bus_unit_append_description,    "s",    u                                 }, \
 153         { "org.freedesktop.systemd1.Unit", "LoadState",            bus_unit_append_load_state,     "s",    &u->meta.load_state               }, \
 154         { "org.freedesktop.systemd1.Unit", "ActiveState",          bus_unit_append_active_state,   "s",    u                                 }, \
 155         { "org.freedesktop.systemd1.Unit", "SubState",             bus_unit_append_sub_state,      "s",    u                                 }, \
 156         { "org.freedesktop.systemd1.Unit", "FragmentPath",         bus_property_append_string,     "s",    u->meta.fragment_path             }, \
 157         { "org.freedesktop.systemd1.Unit", "UnitFileState",        bus_unit_append_file_state,     "s",    u                                 }, \
 158         { "org.freedesktop.systemd1.Unit", "InactiveExitTimestamp",bus_property_append_usec,       "t",    &u->meta.inactive_exit_timestamp.realtime }, \
 159         { "org.freedesktop.systemd1.Unit", "InactiveExitTimestampMonotonic",bus_property_append_usec, "t", &u->meta.inactive_exit_timestamp.monotonic }, \
 160         { "org.freedesktop.systemd1.Unit", "ActiveEnterTimestamp", bus_property_append_usec,       "t",    &u->meta.active_enter_timestamp.realtime }, \
 161         { "org.freedesktop.systemd1.Unit", "ActiveEnterTimestampMonotonic", bus_property_append_usec, "t", &u->meta.active_enter_timestamp.monotonic }, \
 162         { "org.freedesktop.systemd1.Unit", "ActiveExitTimestamp",  bus_property_append_usec,       "t",    &u->meta.active_exit_timestamp.realtime }, \
 163         { "org.freedesktop.systemd1.Unit", "ActiveExitTimestampMonotonic",  bus_property_append_usec, "t", &u->meta.active_exit_timestamp.monotonic }, \
 164         { "org.freedesktop.systemd1.Unit", "InactiveEnterTimestamp",bus_property_append_usec,      "t",    &u->meta.inactive_enter_timestamp.realtime }, \
 165         { "org.freedesktop.systemd1.Unit", "InactiveEnterTimestampMonotonic",bus_property_append_usec,"t", &u->meta.inactive_enter_timestamp.monotonic }, \
 166         { "org.freedesktop.systemd1.Unit", "CanStart",             bus_unit_append_can_start,      "b",    u                                 }, \
 167         { "org.freedesktop.systemd1.Unit", "CanStop",              bus_unit_append_can_stop,       "b",    u                                 }, \
 168         { "org.freedesktop.systemd1.Unit", "CanReload",            bus_unit_append_can_reload,     "b",    u                                 }, \
 169         { "org.freedesktop.systemd1.Unit", "CanIsolate",           bus_unit_append_can_isolate,    "b",    u                                 }, \
 170         { "org.freedesktop.systemd1.Unit", "Job",                  bus_unit_append_job,            "(uo)", u                                 }, \
 171         { "org.freedesktop.systemd1.Unit", "StopWhenUnneeded",     bus_property_append_bool,       "b",    &u->meta.stop_when_unneeded       }, \
 172         { "org.freedesktop.systemd1.Unit", "RefuseManualStart",    bus_property_append_bool,       "b",    &u->meta.refuse_manual_start      }, \
 173         { "org.freedesktop.systemd1.Unit", "RefuseManualStop",     bus_property_append_bool,       "b",    &u->meta.refuse_manual_stop       }, \
 174         { "org.freedesktop.systemd1.Unit", "AllowIsolate",         bus_property_append_bool,       "b",    &u->meta.allow_isolate            }, \
 175         { "org.freedesktop.systemd1.Unit", "DefaultDependencies",  bus_property_append_bool,       "b",    &u->meta.default_dependencies     }, \
 176         { "org.freedesktop.systemd1.Unit", "OnFailureIsolate",     bus_property_append_bool,       "b",    &u->meta.on_failure_isolate       }, \
 177         { "org.freedesktop.systemd1.Unit", "IgnoreOnIsolate",      bus_property_append_bool,       "b",    &u->meta.ignore_on_isolate        }, \
 178         { "org.freedesktop.systemd1.Unit", "IgnoreOnSnapshot",     bus_property_append_bool,       "b",    &u->meta.ignore_on_snapshot       }, \
 179         { "org.freedesktop.systemd1.Unit", "DefaultControlGroup",  bus_unit_append_default_cgroup, "s",    u                                 }, \
 180         { "org.freedesktop.systemd1.Unit", "ControlGroup",         bus_unit_append_cgroups,        "as",   u                                 }, \
 181         { "org.freedesktop.systemd1.Unit", "ControlGroupAttributes", bus_unit_append_cgroup_attrs, "a(sss)", u                               }, \
 182         { "org.freedesktop.systemd1.Unit", "NeedDaemonReload",     bus_unit_append_need_daemon_reload, "b", u                                }, \
 183         { "org.freedesktop.systemd1.Unit", "JobTimeoutUSec",       bus_property_append_usec,       "t",    &u->meta.job_timeout              }, \
 184         { "org.freedesktop.systemd1.Unit", "ConditionTimestamp",   bus_property_append_usec,       "t",    &u->meta.condition_timestamp.realtime }, \
 185         { "org.freedesktop.systemd1.Unit", "ConditionTimestampMonotonic", bus_property_append_usec,"t",    &u->meta.condition_timestamp.monotonic }, \
 186         { "org.freedesktop.systemd1.Unit", "ConditionResult",      bus_property_append_bool,       "b",    &u->meta.condition_result         }, \
 187         { "org.freedesktop.systemd1.Unit", "LoadError",            bus_unit_append_load_error,     "(ss)", u                                 }
 188
 189 int bus_unit_append_names(DBusMessageIter *i, const char *property, void *data);
 190 int bus_unit_append_following(DBusMessageIter *i, const char *property, void *data);
 191 int bus_unit_append_dependencies(DBusMessageIter *i, const char *property, void *data);
 192 int bus_unit_append_description(DBusMessageIter *i, const char *property, void *data);
 193 int bus_unit_append_load_state(DBusMessageIter *i, const char *property, void *data);
 194 int bus_unit_append_active_state(DBusMessageIter *i, const char *property, void *data);
 195 int bus_unit_append_sub_state(DBusMessageIter *i, const char *property, void *data);
 196 int bus_unit_append_file_state(DBusMessageIter *i, const char *property, void *data);
 197 int bus_unit_append_can_start(DBusMessageIter *i, const char *property, void *data);
 198 int bus_unit_append_can_stop(DBusMessageIter *i, const char *property, void *data);
 199 int bus_unit_append_can_reload(DBusMessageIter *i, const char *property, void *data);
 200 int bus_unit_append_can_isolate(DBusMessageIter *i, const char *property, void *data);
 201 int bus_unit_append_job(DBusMessageIter *i, const char *property, void *data);
 202 int bus_unit_append_default_cgroup(DBusMessageIter *i, const char *property, void *data);
 203 int bus_unit_append_cgroups(DBusMessageIter *i, const char *property, void *data);
 204 int bus_unit_append_cgroup_attrs(DBusMessageIter *i, const char *property, void *data);
 205 int bus_unit_append_need_daemon_reload(DBusMessageIter *i, const char *property, void *data);
 206 int bus_unit_append_load_error(DBusMessageIter *i, const char *property, void *data);
 207
 208 void bus_unit_send_change_signal(Unit *u);
 209 void bus_unit_send_removed_signal(Unit *u);
 210
 211 extern const DBusObjectPathVTable bus_unit_vtable;
 212
 213 extern const char bus_unit_interface[];
 214
 215 #endif