1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
4 This file is part of systemd.
6 Copyright 2010 Lennart Poettering
8 systemd is free software; you can redistribute it and/or modify it
9 under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 systemd is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with systemd; If not, see <http://www.gnu.org/licenses/>.
26 #include "dbus-unit.h"
27 #include "bus-errors.h"
28 #include "dbus-common.h"
30 const char bus_unit_interface[] _introspect_("Unit") = BUS_UNIT_INTERFACE;
32 #define INVALIDATING_PROPERTIES \
36 "InactiveExitTimestamp\0" \
37 "ActiveEnterTimestamp\0" \
38 "ActiveExitTimestamp\0" \
39 "InactiveEnterTimestamp\0" \
43 int bus_unit_append_names(DBusMessageIter *i, const char *property, void *data) {
49 if (!dbus_message_iter_open_container(i, DBUS_TYPE_ARRAY, "s", &sub))
52 SET_FOREACH(t, u->meta.names, j)
53 if (!dbus_message_iter_append_basic(&sub, DBUS_TYPE_STRING, &t))
56 if (!dbus_message_iter_close_container(i, &sub))
62 int bus_unit_append_following(DBusMessageIter *i, const char *property, void *data) {
70 f = unit_following(u);
71 d = f ? f->meta.id : "";
73 if (!dbus_message_iter_append_basic(i, DBUS_TYPE_STRING, &d))
79 int bus_unit_append_dependencies(DBusMessageIter *i, const char *property, void *data) {
85 if (!dbus_message_iter_open_container(i, DBUS_TYPE_ARRAY, "s", &sub))
89 if (!dbus_message_iter_append_basic(&sub, DBUS_TYPE_STRING, &u->meta.id))
92 if (!dbus_message_iter_close_container(i, &sub))
98 int bus_unit_append_description(DBusMessageIter *i, const char *property, void *data) {
106 d = unit_description(u);
108 if (!dbus_message_iter_append_basic(i, DBUS_TYPE_STRING, &d))
114 DEFINE_BUS_PROPERTY_APPEND_ENUM(bus_unit_append_load_state, unit_load_state, UnitLoadState);
116 int bus_unit_append_active_state(DBusMessageIter *i, const char *property, void *data) {
124 state = unit_active_state_to_string(unit_active_state(u));
126 if (!dbus_message_iter_append_basic(i, DBUS_TYPE_STRING, &state))
132 int bus_unit_append_sub_state(DBusMessageIter *i, const char *property, void *data) {
140 state = unit_sub_state_to_string(u);
142 if (!dbus_message_iter_append_basic(i, DBUS_TYPE_STRING, &state))
148 int bus_unit_append_can_start(DBusMessageIter *i, const char *property, void *data) {
156 b = unit_can_start(u) &&
157 !u->meta.refuse_manual_start;
159 if (!dbus_message_iter_append_basic(i, DBUS_TYPE_BOOLEAN, &b))
165 int bus_unit_append_can_stop(DBusMessageIter *i, const char *property, void *data) {
173 /* On the lower levels we assume that every unit we can start
174 * we can also stop */
176 b = unit_can_start(u) &&
177 !u->meta.refuse_manual_stop;
179 if (!dbus_message_iter_append_basic(i, DBUS_TYPE_BOOLEAN, &b))
185 int bus_unit_append_can_reload(DBusMessageIter *i, const char *property, void *data) {
193 b = unit_can_reload(u);
195 if (!dbus_message_iter_append_basic(i, DBUS_TYPE_BOOLEAN, &b))
201 int bus_unit_append_can_isolate(DBusMessageIter *i, const char *property, void *data) {
209 b = unit_can_isolate(u) &&
210 !u->meta.refuse_manual_start;
212 if (!dbus_message_iter_append_basic(i, DBUS_TYPE_BOOLEAN, &b))
218 int bus_unit_append_job(DBusMessageIter *i, const char *property, void *data) {
227 if (!dbus_message_iter_open_container(i, DBUS_TYPE_STRUCT, NULL, &sub))
232 if (!(p = job_dbus_path(u->meta.job)))
235 if (!dbus_message_iter_append_basic(&sub, DBUS_TYPE_UINT32, &u->meta.job->id) ||
236 !dbus_message_iter_append_basic(&sub, DBUS_TYPE_OBJECT_PATH, &p)) {
243 /* No job, so let's fill in some placeholder
244 * data. Since we need to fill in a valid path we
245 * simple point to ourselves. */
247 if (!(p = unit_dbus_path(u)))
250 if (!dbus_message_iter_append_basic(&sub, DBUS_TYPE_UINT32, &id) ||
251 !dbus_message_iter_append_basic(&sub, DBUS_TYPE_OBJECT_PATH, &p)) {
259 if (!dbus_message_iter_close_container(i, &sub))
265 int bus_unit_append_default_cgroup(DBusMessageIter *i, const char *property, void *data) {
275 if ((cgb = unit_get_default_cgroup(u))) {
276 if (!(t = cgroup_bonding_to_string(cgb)))
281 success = dbus_message_iter_append_basic(i, DBUS_TYPE_STRING, &t);
286 return success ? 0 : -ENOMEM;
289 int bus_unit_append_cgroups(DBusMessageIter *i, const char *property, void *data) {
294 if (!dbus_message_iter_open_container(i, DBUS_TYPE_ARRAY, "s", &sub))
297 LIST_FOREACH(by_unit, cgb, u->meta.cgroup_bondings) {
301 if (!(t = cgroup_bonding_to_string(cgb)))
304 success = dbus_message_iter_append_basic(&sub, DBUS_TYPE_STRING, &t);
311 if (!dbus_message_iter_close_container(i, &sub))
317 int bus_unit_append_need_daemon_reload(DBusMessageIter *i, const char *property, void *data) {
325 b = unit_need_daemon_reload(u);
327 if (!dbus_message_iter_append_basic(i, DBUS_TYPE_BOOLEAN, &b))
333 static DBusHandlerResult bus_unit_message_dispatch(Unit *u, DBusConnection *connection, DBusMessage *message) {
334 DBusMessage *reply = NULL;
335 Manager *m = u->meta.manager;
337 JobType job_type = _JOB_TYPE_INVALID;
339 bool reload_if_possible = false;
341 dbus_error_init(&error);
343 if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Unit", "Start"))
344 job_type = JOB_START;
345 else if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Unit", "Stop"))
347 else if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Unit", "Reload"))
348 job_type = JOB_RELOAD;
349 else if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Unit", "Restart"))
350 job_type = JOB_RESTART;
351 else if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Unit", "TryRestart"))
352 job_type = JOB_TRY_RESTART;
353 else if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Unit", "ReloadOrRestart")) {
354 reload_if_possible = true;
355 job_type = JOB_RESTART;
356 } else if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Unit", "ReloadOrTryRestart")) {
357 reload_if_possible = true;
358 job_type = JOB_TRY_RESTART;
359 } else if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Unit", "Kill")) {
360 const char *swho, *smode;
366 if (!dbus_message_get_args(
369 DBUS_TYPE_STRING, &swho,
370 DBUS_TYPE_STRING, &smode,
371 DBUS_TYPE_INT32, &signo,
373 return bus_send_error_reply(connection, message, &error, -EINVAL);
378 who = kill_who_from_string(swho);
380 return bus_send_error_reply(connection, message, &error, -EINVAL);
384 mode = KILL_CONTROL_GROUP;
386 mode = kill_mode_from_string(smode);
388 return bus_send_error_reply(connection, message, &error, -EINVAL);
391 if (signo <= 0 || signo >= _NSIG)
392 return bus_send_error_reply(connection, message, &error, -EINVAL);
394 if ((r = unit_kill(u, who, mode, signo, &error)) < 0)
395 return bus_send_error_reply(connection, message, &error, r);
397 if (!(reply = dbus_message_new_method_return(message)))
400 } else if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Unit", "ResetFailed")) {
402 unit_reset_failed(u);
404 if (!(reply = dbus_message_new_method_return(message)))
407 } else if (UNIT_VTABLE(u)->bus_message_handler)
408 return UNIT_VTABLE(u)->bus_message_handler(u, connection, message);
410 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
412 if (job_type != _JOB_TYPE_INVALID) {
418 if ((job_type == JOB_START && u->meta.refuse_manual_start) ||
419 (job_type == JOB_STOP && u->meta.refuse_manual_stop) ||
420 ((job_type == JOB_RESTART || job_type == JOB_TRY_RESTART) &&
421 (u->meta.refuse_manual_start || u->meta.refuse_manual_stop))) {
422 dbus_set_error(&error, BUS_ERROR_ONLY_BY_DEPENDENCY, "Operation refused, may be requested by dependency only.");
423 return bus_send_error_reply(connection, message, &error, -EPERM);
426 if (!dbus_message_get_args(
429 DBUS_TYPE_STRING, &smode,
431 return bus_send_error_reply(connection, message, &error, -EINVAL);
433 if (reload_if_possible && unit_can_reload(u)) {
434 if (job_type == JOB_RESTART)
435 job_type = JOB_RELOAD_OR_START;
436 else if (job_type == JOB_TRY_RESTART)
437 job_type = JOB_RELOAD;
440 if ((mode = job_mode_from_string(smode)) == _JOB_MODE_INVALID) {
441 dbus_set_error(&error, BUS_ERROR_INVALID_JOB_MODE, "Job mode %s is invalid.", smode);
442 return bus_send_error_reply(connection, message, &error, -EINVAL);
445 if ((r = manager_add_job(m, job_type, u, mode, true, &error, &j)) < 0)
446 return bus_send_error_reply(connection, message, &error, r);
448 if (!(reply = dbus_message_new_method_return(message)))
451 if (!(path = job_dbus_path(j)))
454 if (!dbus_message_append_args(
456 DBUS_TYPE_OBJECT_PATH, &path,
462 if (!dbus_connection_send(connection, reply, NULL))
465 dbus_message_unref(reply);
470 return DBUS_HANDLER_RESULT_HANDLED;
476 dbus_message_unref(reply);
478 dbus_error_free(&error);
480 return DBUS_HANDLER_RESULT_NEED_MEMORY;
483 static DBusHandlerResult bus_unit_message_handler(DBusConnection *connection, DBusMessage *message, void *data) {
493 if (streq(dbus_message_get_path(message), "/org/freedesktop/systemd1/unit")) {
494 /* Be nice to gdbus and return introspection data for our mid-level paths */
496 if (dbus_message_is_method_call(message, "org.freedesktop.DBus.Introspectable", "Introspect")) {
497 char *introspection = NULL;
503 if (!(reply = dbus_message_new_method_return(message)))
506 /* We roll our own introspection code here, instead of
507 * relying on bus_default_message_handler() because we
508 * need to generate our introspection string
511 if (!(f = open_memstream(&introspection, &size)))
514 fputs(DBUS_INTROSPECT_1_0_XML_DOCTYPE_DECL_NODE
517 fputs(BUS_INTROSPECTABLE_INTERFACE, f);
518 fputs(BUS_PEER_INTERFACE, f);
520 HASHMAP_FOREACH_KEY(u, k, m->units, i) {
526 if (!(p = bus_path_escape(k))) {
532 fprintf(f, "<node name=\"%s\"/>", p);
536 fputs("</node>\n", f);
549 if (!dbus_message_append_args(reply, DBUS_TYPE_STRING, &introspection, DBUS_TYPE_INVALID)) {
556 if (!dbus_connection_send(connection, reply, NULL))
559 dbus_message_unref(reply);
561 return DBUS_HANDLER_RESULT_HANDLED;
564 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
567 if ((r = manager_get_unit_from_dbus_path(m, dbus_message_get_path(message), &u)) < 0) {
570 return DBUS_HANDLER_RESULT_NEED_MEMORY;
576 dbus_set_error_const(&e, DBUS_ERROR_UNKNOWN_OBJECT, "Unknown unit");
577 return bus_send_error_reply(connection, message, &e, r);
580 return bus_send_error_reply(connection, message, NULL, r);
583 return bus_unit_message_dispatch(u, connection, message);
587 dbus_message_unref(reply);
589 return DBUS_HANDLER_RESULT_NEED_MEMORY;
592 const DBusObjectPathVTable bus_unit_vtable = {
593 .message_function = bus_unit_message_handler
596 void bus_unit_send_change_signal(Unit *u) {
598 DBusMessage *m = NULL;
602 if (u->meta.in_dbus_queue) {
603 LIST_REMOVE(Meta, dbus_queue, u->meta.manager->dbus_unit_queue, &u->meta);
604 u->meta.in_dbus_queue = false;
610 if (!bus_has_subscriber(u->meta.manager)) {
611 u->meta.sent_dbus_new_signal = true;
615 if (!(p = unit_dbus_path(u)))
618 if (u->meta.sent_dbus_new_signal) {
619 /* Send a properties changed signal. First for the
620 * specific type, then for the generic unit. The
621 * clients may rely on this order to get atomic
622 * behaviour if needed. */
624 if (UNIT_VTABLE(u)->bus_invalidating_properties) {
626 if (!(m = bus_properties_changed_new(p,
627 UNIT_VTABLE(u)->bus_interface,
628 UNIT_VTABLE(u)->bus_invalidating_properties)))
631 if (bus_broadcast(u->meta.manager, m) < 0)
634 dbus_message_unref(m);
637 if (!(m = bus_properties_changed_new(p, "org.freedesktop.systemd1.Unit", INVALIDATING_PROPERTIES)))
641 /* Send a new signal */
643 if (!(m = dbus_message_new_signal("/org/freedesktop/systemd1", "org.freedesktop.systemd1.Manager", "UnitNew")))
646 if (!dbus_message_append_args(m,
647 DBUS_TYPE_STRING, &u->meta.id,
648 DBUS_TYPE_OBJECT_PATH, &p,
653 if (bus_broadcast(u->meta.manager, m) < 0)
657 dbus_message_unref(m);
659 u->meta.sent_dbus_new_signal = true;
667 dbus_message_unref(m);
669 log_error("Failed to allocate unit change/new signal.");
672 void bus_unit_send_removed_signal(Unit *u) {
674 DBusMessage *m = NULL;
678 if (!bus_has_subscriber(u->meta.manager))
681 if (!u->meta.sent_dbus_new_signal)
682 bus_unit_send_change_signal(u);
687 if (!(p = unit_dbus_path(u)))
690 if (!(m = dbus_message_new_signal("/org/freedesktop/systemd1", "org.freedesktop.systemd1.Manager", "UnitRemoved")))
693 if (!dbus_message_append_args(m,
694 DBUS_TYPE_STRING, &u->meta.id,
695 DBUS_TYPE_OBJECT_PATH, &p,
699 if (bus_broadcast(u->meta.manager, m) < 0)
703 dbus_message_unref(m);
711 dbus_message_unref(m);
713 log_error("Failed to allocate unit remove signal.");