src/dbus-unit.c

   1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
   2
   3 /***
   4   This file is part of systemd.
   5
   6   Copyright 2010 Lennart Poettering
   7
   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.
  12
  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.
  17
  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/>.
  20 ***/
  21
  22 #include <errno.h>
  23
  24 #include "dbus.h"
  25 #include "log.h"
  26 #include "dbus-unit.h"
  27
  28 const char bus_unit_interface[] = BUS_UNIT_INTERFACE;
  29
  30 int bus_unit_append_names(Manager *m, DBusMessageIter *i, const char *property, void *data) {
  31         char *t;
  32         Iterator j;
  33         DBusMessageIter sub;
  34         Unit *u = data;
  35
  36         if (!dbus_message_iter_open_container(i, DBUS_TYPE_ARRAY, "s", &sub))
  37                 return -ENOMEM;
  38
  39         SET_FOREACH(t, u->meta.names, j)
  40                 if (!dbus_message_iter_append_basic(&sub, DBUS_TYPE_STRING, &t))
  41                         return -ENOMEM;
  42
  43         if (!dbus_message_iter_close_container(i, &sub))
  44                 return -ENOMEM;
  45
  46         return 0;
  47 }
  48
  49 int bus_unit_append_dependencies(Manager *m, DBusMessageIter *i, const char *property, void *data) {
  50         Unit *u;
  51         Iterator j;
  52         DBusMessageIter sub;
  53         Set *s = data;
  54
  55         if (!dbus_message_iter_open_container(i, DBUS_TYPE_ARRAY, "s", &sub))
  56                 return -ENOMEM;
  57
  58         SET_FOREACH(u, s, j)
  59                 if (!dbus_message_iter_append_basic(&sub, DBUS_TYPE_STRING, &u->meta.id))
  60                         return -ENOMEM;
  61
  62         if (!dbus_message_iter_close_container(i, &sub))
  63                 return -ENOMEM;
  64
  65         return 0;
  66 }
  67
  68 int bus_unit_append_description(Manager *m, DBusMessageIter *i, const char *property, void *data) {
  69         Unit *u = data;
  70         const char *d;
  71
  72         assert(m);
  73         assert(i);
  74         assert(property);
  75         assert(u);
  76
  77         d = unit_description(u);
  78
  79         if (!dbus_message_iter_append_basic(i, DBUS_TYPE_STRING, &d))
  80                 return -ENOMEM;
  81
  82         return 0;
  83 }
  84
  85 DEFINE_BUS_PROPERTY_APPEND_ENUM(bus_unit_append_load_state, unit_load_state, UnitLoadState);
  86
  87 int bus_unit_append_active_state(Manager *m, DBusMessageIter *i, const char *property, void *data) {
  88         Unit *u = data;
  89         const char *state;
  90
  91         assert(m);
  92         assert(i);
  93         assert(property);
  94         assert(u);
  95
  96         state = unit_active_state_to_string(unit_active_state(u));
  97
  98         if (!dbus_message_iter_append_basic(i, DBUS_TYPE_STRING, &state))
  99                 return -ENOMEM;
 100
 101         return 0;
 102 }
 103
 104 int bus_unit_append_sub_state(Manager *m, DBusMessageIter *i, const char *property, void *data) {
 105         Unit *u = data;
 106         const char *state;
 107
 108         assert(m);
 109         assert(i);
 110         assert(property);
 111         assert(u);
 112
 113         state = unit_sub_state_to_string(u);
 114
 115         if (!dbus_message_iter_append_basic(i, DBUS_TYPE_STRING, &state))
 116                 return -ENOMEM;
 117
 118         return 0;
 119 }
 120
 121 int bus_unit_append_can_start(Manager *m, DBusMessageIter *i, const char *property, void *data) {
 122         Unit *u = data;
 123         dbus_bool_t b;
 124
 125         assert(m);
 126         assert(i);
 127         assert(property);
 128         assert(u);
 129
 130         b = unit_can_start(u);
 131
 132         if (!dbus_message_iter_append_basic(i, DBUS_TYPE_BOOLEAN, &b))
 133                 return -ENOMEM;
 134
 135         return 0;
 136 }
 137
 138 int bus_unit_append_can_reload(Manager *m, DBusMessageIter *i, const char *property, void *data) {
 139         Unit *u = data;
 140         dbus_bool_t b;
 141
 142         assert(m);
 143         assert(i);
 144         assert(property);
 145         assert(u);
 146
 147         b = unit_can_reload(u);
 148
 149         if (!dbus_message_iter_append_basic(i, DBUS_TYPE_BOOLEAN, &b))
 150                 return -ENOMEM;
 151
 152         return 0;
 153 }
 154
 155 int bus_unit_append_job(Manager *m, DBusMessageIter *i, const char *property, void *data) {
 156         Unit *u = data;
 157         DBusMessageIter sub;
 158         char *p;
 159
 160         assert(m);
 161         assert(i);
 162         assert(property);
 163         assert(u);
 164
 165         if (!dbus_message_iter_open_container(i, DBUS_TYPE_STRUCT, NULL, &sub))
 166                 return -ENOMEM;
 167
 168         if (u->meta.job) {
 169
 170                 if (!(p = job_dbus_path(u->meta.job)))
 171                         return -ENOMEM;
 172
 173                 if (!dbus_message_iter_append_basic(&sub, DBUS_TYPE_UINT32, &u->meta.job->id) ||
 174                     !dbus_message_iter_append_basic(&sub, DBUS_TYPE_OBJECT_PATH, &p)) {
 175                         free(p);
 176                         return -ENOMEM;
 177                 }
 178         } else {
 179                 uint32_t id = 0;
 180
 181                 /* No job, so let's fill in some placeholder
 182                  * data. Since we need to fill in a valid path we
 183                  * simple point to ourselves. */
 184
 185                 if (!(p = unit_dbus_path(u)))
 186                         return -ENOMEM;
 187
 188                 if (!dbus_message_iter_append_basic(&sub, DBUS_TYPE_UINT32, &id) ||
 189                     !dbus_message_iter_append_basic(&sub, DBUS_TYPE_OBJECT_PATH, &p)) {
 190                         free(p);
 191                         return -ENOMEM;
 192                 }
 193         }
 194
 195         free(p);
 196
 197         if (!dbus_message_iter_close_container(i, &sub))
 198                 return -ENOMEM;
 199
 200         return 0;
 201 }
 202
 203 int bus_unit_append_default_cgroup(Manager *m, DBusMessageIter *i, const char *property, void *data) {
 204         Unit *u = data;
 205         char *t;
 206         CGroupBonding *cgb;
 207         bool success;
 208
 209         assert(m);
 210         assert(i);
 211         assert(property);
 212         assert(u);
 213
 214         if ((cgb = unit_get_default_cgroup(u))) {
 215                 if (!(t = cgroup_bonding_to_string(cgb)))
 216                         return -ENOMEM;
 217         } else
 218                 t = (char*) "";
 219
 220         success = dbus_message_iter_append_basic(i, DBUS_TYPE_STRING, &t);
 221
 222         if (cgb)
 223                 free(t);
 224
 225         return success ? 0 : -ENOMEM;
 226 }
 227
 228 int bus_unit_append_cgroups(Manager *m, DBusMessageIter *i, const char *property, void *data) {
 229         Unit *u = data;
 230         CGroupBonding *cgb;
 231         DBusMessageIter sub;
 232
 233         if (!dbus_message_iter_open_container(i, DBUS_TYPE_ARRAY, "s", &sub))
 234                 return -ENOMEM;
 235
 236         LIST_FOREACH(by_unit, cgb, u->meta.cgroup_bondings) {
 237                 char *t;
 238                 bool success;
 239
 240                 if (!(t = cgroup_bonding_to_string(cgb)))
 241                         return -ENOMEM;
 242
 243                 success = dbus_message_iter_append_basic(&sub, DBUS_TYPE_STRING, &t);
 244                 free(t);
 245
 246                 if (!success)
 247                         return -ENOMEM;
 248         }
 249
 250         if (!dbus_message_iter_close_container(i, &sub))
 251                 return -ENOMEM;
 252
 253         return 0;
 254 }
 255
 256 DEFINE_BUS_PROPERTY_APPEND_ENUM(bus_unit_append_kill_mode, kill_mode, KillMode);
 257
 258 static DBusHandlerResult bus_unit_message_dispatch(Unit *u, DBusConnection *connection, DBusMessage *message) {
 259         DBusMessage *reply = NULL;
 260         Manager *m = u->meta.manager;
 261         DBusError error;
 262         JobType job_type = _JOB_TYPE_INVALID;
 263         char *path = NULL;
 264
 265         dbus_error_init(&error);
 266
 267         if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Unit", "Start"))
 268                 job_type = JOB_START;
 269         else if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Unit", "Stop"))
 270                 job_type = JOB_STOP;
 271         else if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Unit", "Reload"))
 272                 job_type = JOB_RELOAD;
 273         else if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Unit", "Restart"))
 274                 job_type = JOB_RESTART;
 275         else if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Unit", "TryRestart"))
 276                 job_type = JOB_TRY_RESTART;
 277         else if (UNIT_VTABLE(u)->bus_message_handler)
 278                 return UNIT_VTABLE(u)->bus_message_handler(u, connection, message);
 279         else
 280                 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
 281
 282         if (job_type != _JOB_TYPE_INVALID) {
 283                 const char *smode;
 284                 JobMode mode;
 285                 Job *j;
 286                 int r;
 287
 288                 if (job_type == JOB_START && u->meta.only_by_dependency)
 289                         return bus_send_error_reply(m, connection, message, NULL, -EPERM);
 290
 291                 if (!dbus_message_get_args(
 292                                     message,
 293                                     &error,
 294                                     DBUS_TYPE_STRING, &smode,
 295                                     DBUS_TYPE_INVALID))
 296                         return bus_send_error_reply(m, connection, message, &error, -EINVAL);
 297
 298                 if ((mode = job_mode_from_string(smode)) == _JOB_MODE_INVALID)
 299                         return bus_send_error_reply(m, connection, message, NULL, -EINVAL);
 300
 301                 if ((r = manager_add_job(m, job_type, u, mode, true, &j)) < 0)
 302                         return bus_send_error_reply(m, connection, message, NULL, r);
 303
 304                 if (!(reply = dbus_message_new_method_return(message)))
 305                         goto oom;
 306
 307                 if (!(path = job_dbus_path(j)))
 308                         goto oom;
 309
 310                 if (!dbus_message_append_args(
 311                                     reply,
 312                                     DBUS_TYPE_OBJECT_PATH, &path,
 313                                     DBUS_TYPE_INVALID))
 314                         goto oom;
 315         }
 316
 317         free(path);
 318
 319         if (reply) {
 320                 if (!dbus_connection_send(connection, reply, NULL))
 321                         goto oom;
 322
 323                 dbus_message_unref(reply);
 324         }
 325
 326         return DBUS_HANDLER_RESULT_HANDLED;
 327
 328 oom:
 329         free(path);
 330
 331         if (reply)
 332                 dbus_message_unref(reply);
 333
 334         dbus_error_free(&error);
 335
 336         return DBUS_HANDLER_RESULT_NEED_MEMORY;
 337 }
 338
 339 static DBusHandlerResult bus_unit_message_handler(DBusConnection *connection, DBusMessage  *message, void *data) {
 340         Manager *m = data;
 341         Unit *u;
 342         int r;
 343
 344         assert(connection);
 345         assert(message);
 346         assert(m);
 347
 348         log_debug("Got D-Bus request: %s.%s() on %s",
 349                   dbus_message_get_interface(message),
 350                   dbus_message_get_member(message),
 351                   dbus_message_get_path(message));
 352
 353         if ((r = manager_get_unit_from_dbus_path(m, dbus_message_get_path(message), &u)) < 0) {
 354
 355                 if (r == -ENOMEM)
 356                         return DBUS_HANDLER_RESULT_NEED_MEMORY;
 357
 358                 if (r == -ENOENT)
 359                         return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
 360
 361                 return bus_send_error_reply(m, connection, message, NULL, r);
 362         }
 363
 364         return bus_unit_message_dispatch(u, connection, message);
 365 }
 366
 367 const DBusObjectPathVTable bus_unit_vtable = {
 368         .message_function = bus_unit_message_handler
 369 };
 370
 371 void bus_unit_send_change_signal(Unit *u) {
 372         char *p = NULL;
 373         DBusMessage *m = NULL;
 374
 375         assert(u);
 376         assert(u->meta.in_dbus_queue);
 377
 378         LIST_REMOVE(Meta, dbus_queue, u->meta.manager->dbus_unit_queue, &u->meta);
 379         u->meta.in_dbus_queue = false;
 380
 381         if (!bus_has_subscriber(u->meta.manager)) {
 382                 u->meta.sent_dbus_new_signal = true;
 383                 return;
 384         }
 385
 386         if (!(p = unit_dbus_path(u)))
 387                 goto oom;
 388
 389         if (u->meta.sent_dbus_new_signal) {
 390                 /* Send a change signal */
 391
 392                 if (!(m = dbus_message_new_signal(p, "org.freedesktop.systemd1.Unit", "Changed")))
 393                         goto oom;
 394         } else {
 395                 /* Send a new signal */
 396
 397                 if (!(m = dbus_message_new_signal("/org/freedesktop/systemd1", "org.freedesktop.systemd1.Manager", "UnitNew")))
 398                         goto oom;
 399
 400                 if (!dbus_message_append_args(m,
 401                                               DBUS_TYPE_STRING, &u->meta.id,
 402                                               DBUS_TYPE_OBJECT_PATH, &p,
 403                                               DBUS_TYPE_INVALID))
 404                         goto oom;
 405         }
 406
 407         if (bus_broadcast(u->meta.manager, m) < 0)
 408                 goto oom;
 409
 410         free(p);
 411         dbus_message_unref(m);
 412
 413         u->meta.sent_dbus_new_signal = true;
 414
 415         return;
 416
 417 oom:
 418         free(p);
 419
 420         if (m)
 421                 dbus_message_unref(m);
 422
 423         log_error("Failed to allocate unit change/new signal.");
 424 }
 425
 426 void bus_unit_send_removed_signal(Unit *u) {
 427         char *p = NULL;
 428         DBusMessage *m = NULL;
 429
 430         assert(u);
 431
 432         if (!bus_has_subscriber(u->meta.manager))
 433                 return;
 434
 435         if (!u->meta.sent_dbus_new_signal)
 436                 bus_unit_send_change_signal(u);
 437
 438         if (!(p = unit_dbus_path(u)))
 439                 goto oom;
 440
 441         if (!(m = dbus_message_new_signal("/org/freedesktop/systemd1", "org.freedesktop.systemd1.Manager", "UnitRemoved")))
 442                 goto oom;
 443
 444         if (!dbus_message_append_args(m,
 445                                       DBUS_TYPE_STRING, &u->meta.id,
 446                                       DBUS_TYPE_OBJECT_PATH, &p,
 447                                       DBUS_TYPE_INVALID))
 448                 goto oom;
 449
 450         if (bus_broadcast(u->meta.manager, m) < 0)
 451                 goto oom;
 452
 453         free(p);
 454         dbus_message_unref(m);
 455
 456         return;
 457
 458 oom:
 459         free(p);
 460
 461         if (m)
 462                 dbus_message_unref(m);
 463
 464         log_error("Failed to allocate unit remove signal.");
 465 }