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 int bus_unit_append_load_error(DBusMessageIter *i, const char *property, void *data) {
335 const char *name, *message;
342 if (u->meta.load_error != 0) {
343 name = bus_errno_to_dbus(u->meta.load_error);
344 message = strempty(strerror(-u->meta.load_error));
348 if (!dbus_message_iter_open_container(i, DBUS_TYPE_STRUCT, NULL, &sub) ||
349 !dbus_message_iter_append_basic(&sub, DBUS_TYPE_STRING, &name) ||
350 !dbus_message_iter_append_basic(&sub, DBUS_TYPE_STRING, &message) ||
351 !dbus_message_iter_close_container(i, &sub))
357 static DBusHandlerResult bus_unit_message_dispatch(Unit *u, DBusConnection *connection, DBusMessage *message) {
358 DBusMessage *reply = NULL;
359 Manager *m = u->meta.manager;
361 JobType job_type = _JOB_TYPE_INVALID;
363 bool reload_if_possible = false;
365 dbus_error_init(&error);
367 if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Unit", "Start"))
368 job_type = JOB_START;
369 else if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Unit", "Stop"))
371 else if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Unit", "Reload"))
372 job_type = JOB_RELOAD;
373 else if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Unit", "Restart"))
374 job_type = JOB_RESTART;
375 else if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Unit", "TryRestart"))
376 job_type = JOB_TRY_RESTART;
377 else if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Unit", "ReloadOrRestart")) {
378 reload_if_possible = true;
379 job_type = JOB_RESTART;
380 } else if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Unit", "ReloadOrTryRestart")) {
381 reload_if_possible = true;
382 job_type = JOB_TRY_RESTART;
383 } else if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Unit", "Kill")) {
384 const char *swho, *smode;
390 if (!dbus_message_get_args(
393 DBUS_TYPE_STRING, &swho,
394 DBUS_TYPE_STRING, &smode,
395 DBUS_TYPE_INT32, &signo,
397 return bus_send_error_reply(connection, message, &error, -EINVAL);
402 who = kill_who_from_string(swho);
404 return bus_send_error_reply(connection, message, &error, -EINVAL);
408 mode = KILL_CONTROL_GROUP;
410 mode = kill_mode_from_string(smode);
412 return bus_send_error_reply(connection, message, &error, -EINVAL);
415 if (signo <= 0 || signo >= _NSIG)
416 return bus_send_error_reply(connection, message, &error, -EINVAL);
418 if ((r = unit_kill(u, who, mode, signo, &error)) < 0)
419 return bus_send_error_reply(connection, message, &error, r);
421 if (!(reply = dbus_message_new_method_return(message)))
424 } else if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Unit", "ResetFailed")) {
426 unit_reset_failed(u);
428 if (!(reply = dbus_message_new_method_return(message)))
431 } else if (UNIT_VTABLE(u)->bus_message_handler)
432 return UNIT_VTABLE(u)->bus_message_handler(u, connection, message);
434 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
436 if (job_type != _JOB_TYPE_INVALID) {
442 if ((job_type == JOB_START && u->meta.refuse_manual_start) ||
443 (job_type == JOB_STOP && u->meta.refuse_manual_stop) ||
444 ((job_type == JOB_RESTART || job_type == JOB_TRY_RESTART) &&
445 (u->meta.refuse_manual_start || u->meta.refuse_manual_stop))) {
446 dbus_set_error(&error, BUS_ERROR_ONLY_BY_DEPENDENCY, "Operation refused, may be requested by dependency only.");
447 return bus_send_error_reply(connection, message, &error, -EPERM);
450 if (!dbus_message_get_args(
453 DBUS_TYPE_STRING, &smode,
455 return bus_send_error_reply(connection, message, &error, -EINVAL);
457 if (reload_if_possible && unit_can_reload(u)) {
458 if (job_type == JOB_RESTART)
459 job_type = JOB_RELOAD_OR_START;
460 else if (job_type == JOB_TRY_RESTART)
461 job_type = JOB_RELOAD;
464 if ((mode = job_mode_from_string(smode)) == _JOB_MODE_INVALID) {
465 dbus_set_error(&error, BUS_ERROR_INVALID_JOB_MODE, "Job mode %s is invalid.", smode);
466 return bus_send_error_reply(connection, message, &error, -EINVAL);
469 if ((r = manager_add_job(m, job_type, u, mode, true, &error, &j)) < 0)
470 return bus_send_error_reply(connection, message, &error, r);
472 if (!(reply = dbus_message_new_method_return(message)))
475 if (!(path = job_dbus_path(j)))
478 if (!dbus_message_append_args(
480 DBUS_TYPE_OBJECT_PATH, &path,
486 if (!dbus_connection_send(connection, reply, NULL))
489 dbus_message_unref(reply);
494 return DBUS_HANDLER_RESULT_HANDLED;
500 dbus_message_unref(reply);
502 dbus_error_free(&error);
504 return DBUS_HANDLER_RESULT_NEED_MEMORY;
507 static DBusHandlerResult bus_unit_message_handler(DBusConnection *connection, DBusMessage *message, void *data) {
517 if (streq(dbus_message_get_path(message), "/org/freedesktop/systemd1/unit")) {
518 /* Be nice to gdbus and return introspection data for our mid-level paths */
520 if (dbus_message_is_method_call(message, "org.freedesktop.DBus.Introspectable", "Introspect")) {
521 char *introspection = NULL;
527 if (!(reply = dbus_message_new_method_return(message)))
530 /* We roll our own introspection code here, instead of
531 * relying on bus_default_message_handler() because we
532 * need to generate our introspection string
535 if (!(f = open_memstream(&introspection, &size)))
538 fputs(DBUS_INTROSPECT_1_0_XML_DOCTYPE_DECL_NODE
541 fputs(BUS_INTROSPECTABLE_INTERFACE, f);
542 fputs(BUS_PEER_INTERFACE, f);
544 HASHMAP_FOREACH_KEY(u, k, m->units, i) {
550 if (!(p = bus_path_escape(k))) {
556 fprintf(f, "<node name=\"%s\"/>", p);
560 fputs("</node>\n", f);
573 if (!dbus_message_append_args(reply, DBUS_TYPE_STRING, &introspection, DBUS_TYPE_INVALID)) {
580 if (!dbus_connection_send(connection, reply, NULL))
583 dbus_message_unref(reply);
585 return DBUS_HANDLER_RESULT_HANDLED;
588 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
591 if ((r = manager_get_unit_from_dbus_path(m, dbus_message_get_path(message), &u)) < 0) {
594 return DBUS_HANDLER_RESULT_NEED_MEMORY;
600 dbus_set_error_const(&e, DBUS_ERROR_UNKNOWN_OBJECT, "Unknown unit");
601 return bus_send_error_reply(connection, message, &e, r);
604 return bus_send_error_reply(connection, message, NULL, r);
607 return bus_unit_message_dispatch(u, connection, message);
611 dbus_message_unref(reply);
613 return DBUS_HANDLER_RESULT_NEED_MEMORY;
616 const DBusObjectPathVTable bus_unit_vtable = {
617 .message_function = bus_unit_message_handler
620 void bus_unit_send_change_signal(Unit *u) {
622 DBusMessage *m = NULL;
626 if (u->meta.in_dbus_queue) {
627 LIST_REMOVE(Meta, dbus_queue, u->meta.manager->dbus_unit_queue, &u->meta);
628 u->meta.in_dbus_queue = false;
634 if (!bus_has_subscriber(u->meta.manager)) {
635 u->meta.sent_dbus_new_signal = true;
639 if (!(p = unit_dbus_path(u)))
642 if (u->meta.sent_dbus_new_signal) {
643 /* Send a properties changed signal. First for the
644 * specific type, then for the generic unit. The
645 * clients may rely on this order to get atomic
646 * behaviour if needed. */
648 if (UNIT_VTABLE(u)->bus_invalidating_properties) {
650 if (!(m = bus_properties_changed_new(p,
651 UNIT_VTABLE(u)->bus_interface,
652 UNIT_VTABLE(u)->bus_invalidating_properties)))
655 if (bus_broadcast(u->meta.manager, m) < 0)
658 dbus_message_unref(m);
661 if (!(m = bus_properties_changed_new(p, "org.freedesktop.systemd1.Unit", INVALIDATING_PROPERTIES)))
665 /* Send a new signal */
667 if (!(m = dbus_message_new_signal("/org/freedesktop/systemd1", "org.freedesktop.systemd1.Manager", "UnitNew")))
670 if (!dbus_message_append_args(m,
671 DBUS_TYPE_STRING, &u->meta.id,
672 DBUS_TYPE_OBJECT_PATH, &p,
677 if (bus_broadcast(u->meta.manager, m) < 0)
681 dbus_message_unref(m);
683 u->meta.sent_dbus_new_signal = true;
691 dbus_message_unref(m);
693 log_error("Failed to allocate unit change/new signal.");
696 void bus_unit_send_removed_signal(Unit *u) {
698 DBusMessage *m = NULL;
702 if (!bus_has_subscriber(u->meta.manager))
705 if (!u->meta.sent_dbus_new_signal)
706 bus_unit_send_change_signal(u);
711 if (!(p = unit_dbus_path(u)))
714 if (!(m = dbus_message_new_signal("/org/freedesktop/systemd1", "org.freedesktop.systemd1.Manager", "UnitRemoved")))
717 if (!dbus_message_append_args(m,
718 DBUS_TYPE_STRING, &u->meta.id,
719 DBUS_TYPE_OBJECT_PATH, &p,
723 if (bus_broadcast(u->meta.manager, m) < 0)
727 dbus_message_unref(m);
735 dbus_message_unref(m);
737 log_error("Failed to allocate unit remove signal.");