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, DBusMessage *message) {
 259         DBusMessage *reply = NULL;
 260         Manager *m = u->meta.manager;
 261         DBusError error;
 262         JobType job_type = _JOB_TYPE_INVALID;
 263
 264         dbus_error_init(&error);
 265
 266         if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Unit", "Start"))
 267                 job_type = JOB_START;
 268         else if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Unit", "Stop"))
 269                 job_type = JOB_STOP;
 270         else if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Unit", "Reload"))
 271                 job_type = JOB_RELOAD;
 272         else if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Unit", "Restart"))
 273                 job_type = JOB_RESTART;
 274         else if (UNIT_VTABLE(u)->bus_message_handler)
 275                 return UNIT_VTABLE(u)->bus_message_handler(u, message);
 276         else
 277                 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
 278
 279         if (job_type != _JOB_TYPE_INVALID) {
 280                 const char *smode;
 281                 JobMode mode;
 282                 Job *j;
 283                 int r;
 284                 char *path;
 285
 286                 if (job_type == JOB_START && u->meta.only_by_dependency)
 287                         return bus_send_error_reply(m, message, NULL, -EPERM);
 288
 289                 if (!dbus_message_get_args(
 290                                     message,
 291                                     &error,
 292                                     DBUS_TYPE_STRING, &smode,
 293                                     DBUS_TYPE_INVALID))
 294                         return bus_send_error_reply(m, message, &error, -EINVAL);
 295
 296                 if ((mode = job_mode_from_string(smode)) == _JOB_MODE_INVALID)
 297                         return bus_send_error_reply(m, message, NULL, -EINVAL);
 298
 299                 if ((r = manager_add_job(m, job_type, u, mode, true, &j)) < 0)
 300                         return bus_send_error_reply(m, message, NULL, r);
 301
 302                 if (!(reply = dbus_message_new_method_return(message)))
 303                         goto oom;
 304
 305                 if (!(path = job_dbus_path(j)))
 306                         goto oom;
 307
 308                 if (!dbus_message_append_args(
 309                                     reply,
 310                                     DBUS_TYPE_OBJECT_PATH, &path,
 311                                     DBUS_TYPE_INVALID))
 312                         goto oom;
 313         }
 314
 315         if (reply) {
 316                 if (!dbus_connection_send(m->api_bus, reply, NULL))
 317                         goto oom;
 318
 319                 dbus_message_unref(reply);
 320         }
 321
 322         return DBUS_HANDLER_RESULT_HANDLED;
 323
 324 oom:
 325         if (reply)
 326                 dbus_message_unref(reply);
 327
 328         dbus_error_free(&error);
 329
 330         return DBUS_HANDLER_RESULT_NEED_MEMORY;
 331 }
 332
 333 static DBusHandlerResult bus_unit_message_handler(DBusConnection  *connection, DBusMessage  *message, void *data) {
 334         Manager *m = data;
 335         Unit *u;
 336         int r;
 337
 338         assert(connection);
 339         assert(message);
 340         assert(m);
 341
 342         log_debug("Got D-Bus request: %s.%s() on %s",
 343                   dbus_message_get_interface(message),
 344                   dbus_message_get_member(message),
 345                   dbus_message_get_path(message));
 346
 347         if ((r = manager_get_unit_from_dbus_path(m, dbus_message_get_path(message), &u)) < 0) {
 348
 349                 if (r == -ENOMEM)
 350                         return DBUS_HANDLER_RESULT_NEED_MEMORY;
 351
 352                 if (r == -ENOENT)
 353                         return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
 354
 355                 return bus_send_error_reply(m, message, NULL, r);
 356         }
 357
 358         return bus_unit_message_dispatch(u, message);
 359 }
 360
 361 const DBusObjectPathVTable bus_unit_vtable = {
 362         .message_function = bus_unit_message_handler
 363 };
 364
 365 void bus_unit_send_change_signal(Unit *u) {
 366         char *p = NULL;
 367         DBusMessage *m = NULL;
 368
 369         assert(u);
 370         assert(u->meta.in_dbus_queue);
 371
 372         LIST_REMOVE(Meta, dbus_queue, u->meta.manager->dbus_unit_queue, &u->meta);
 373         u->meta.in_dbus_queue = false;
 374
 375         if (set_isempty(u->meta.manager->subscribed)) {
 376                 u->meta.sent_dbus_new_signal = true;
 377                 return;
 378         }
 379
 380         if (!(p = unit_dbus_path(u)))
 381                 goto oom;
 382
 383         if (u->meta.sent_dbus_new_signal) {
 384                 /* Send a change signal */
 385
 386                 if (!(m = dbus_message_new_signal(p, "org.freedesktop.systemd1.Unit", "Changed")))
 387                         goto oom;
 388         } else {
 389                 /* Send a new signal */
 390
 391                 if (!(m = dbus_message_new_signal("/org/freedesktop/systemd1", "org.freedesktop.systemd1.Manager", "UnitNew")))
 392                         goto oom;
 393
 394                 if (!dbus_message_append_args(m,
 395                                               DBUS_TYPE_STRING, &u->meta.id,
 396                                               DBUS_TYPE_OBJECT_PATH, &p,
 397                                               DBUS_TYPE_INVALID))
 398                         goto oom;
 399         }
 400
 401         if (!dbus_connection_send(u->meta.manager->api_bus, m, NULL))
 402                 goto oom;
 403
 404         free(p);
 405         dbus_message_unref(m);
 406
 407         u->meta.sent_dbus_new_signal = true;
 408
 409         return;
 410
 411 oom:
 412         free(p);
 413
 414         if (m)
 415                 dbus_message_unref(m);
 416
 417         log_error("Failed to allocate unit change/new signal.");
 418 }
 419
 420 void bus_unit_send_removed_signal(Unit *u) {
 421         char *p = NULL;
 422         DBusMessage *m = NULL;
 423
 424         assert(u);
 425
 426         if (set_isempty(u->meta.manager->subscribed))
 427                 return;
 428
 429         if (!u->meta.sent_dbus_new_signal)
 430                 bus_unit_send_change_signal(u);
 431
 432         if (!(p = unit_dbus_path(u)))
 433                 goto oom;
 434
 435         if (!(m = dbus_message_new_signal("/org/freedesktop/systemd1", "org.freedesktop.systemd1.Manager", "UnitRemoved")))
 436                 goto oom;
 437
 438         if (!dbus_message_append_args(m,
 439                                       DBUS_TYPE_STRING, &u->meta.id,
 440                                       DBUS_TYPE_OBJECT_PATH, &p,
 441                                       DBUS_TYPE_INVALID))
 442                 goto oom;
 443
 444         if (!dbus_connection_send(u->meta.manager->api_bus, m, NULL))
 445                 goto oom;
 446
 447         free(p);
 448         dbus_message_unref(m);
 449
 450         return;
 451
 452 oom:
 453         free(p);
 454
 455         if (m)
 456                 dbus_message_unref(m);
 457
 458         log_error("Failed to allocate unit remove signal.");
 459 }