src/core/dbus-service.c

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2
   3 #include <fcntl.h>
   4
   5 #include "alloc-util.h"
   6 #include "async.h"
   7 #include "bus-internal.h"
   8 #include "bus-util.h"
   9 #include "dbus-cgroup.h"
  10 #include "dbus-execute.h"
  11 #include "dbus-kill.h"
  12 #include "dbus-manager.h"
  13 #include "dbus-service.h"
  14 #include "dbus-util.h"
  15 #include "exit-status.h"
  16 #include "fd-util.h"
  17 #include "fileio.h"
  18 #include "parse-util.h"
  19 #include "path-util.h"
  20 #include "service.h"
  21 #include "signal-util.h"
  22 #include "string-util.h"
  23 #include "strv.h"
  24 #include "unit.h"
  25
  26 static BUS_DEFINE_PROPERTY_GET_ENUM(property_get_type, service_type, ServiceType);
  27 static BUS_DEFINE_PROPERTY_GET_ENUM(property_get_result, service_result, ServiceResult);
  28 static BUS_DEFINE_PROPERTY_GET_ENUM(property_get_restart, service_restart, ServiceRestart);
  29 static BUS_DEFINE_PROPERTY_GET_ENUM(property_get_notify_access, notify_access, NotifyAccess);
  30 static BUS_DEFINE_PROPERTY_GET_ENUM(property_get_emergency_action, emergency_action, EmergencyAction);
  31 static BUS_DEFINE_PROPERTY_GET(property_get_timeout_abort_usec, "t", Service, service_timeout_abort_usec);
  32
  33 static int property_get_exit_status_set(
  34                 sd_bus *bus,
  35                 const char *path,
  36                 const char *interface,
  37                 const char *property,
  38                 sd_bus_message *reply,
  39                 void *userdata,
  40                 sd_bus_error *error) {
  41
  42         ExitStatusSet *status_set = userdata;
  43         Iterator i;
  44         void *id;
  45         int r;
  46
  47         assert(bus);
  48         assert(reply);
  49         assert(status_set);
  50
  51         r = sd_bus_message_open_container(reply, 'r', "aiai");
  52         if (r < 0)
  53                 return r;
  54
  55         r = sd_bus_message_open_container(reply, 'a', "i");
  56         if (r < 0)
  57                 return r;
  58
  59         SET_FOREACH(id, status_set->status, i) {
  60                 int32_t val = PTR_TO_INT(id);
  61
  62                 if (val < 0 || val > 255)
  63                         continue;
  64
  65                 r = sd_bus_message_append_basic(reply, 'i', &val);
  66                 if (r < 0)
  67                         return r;
  68         }
  69
  70         r = sd_bus_message_close_container(reply);
  71         if (r < 0)
  72                 return r;
  73
  74         r = sd_bus_message_open_container(reply, 'a', "i");
  75         if (r < 0)
  76                 return r;
  77
  78         SET_FOREACH(id, status_set->signal, i) {
  79                 int32_t val = PTR_TO_INT(id);
  80                 const char *str;
  81
  82                 str = signal_to_string((int) val);
  83                 if (!str)
  84                         continue;
  85
  86                 r = sd_bus_message_append_basic(reply, 'i', &val);
  87                 if (r < 0)
  88                         return r;
  89         }
  90
  91         r = sd_bus_message_close_container(reply);
  92         if (r < 0)
  93                 return r;
  94
  95         return sd_bus_message_close_container(reply);
  96 }
  97
  98 const sd_bus_vtable bus_service_vtable[] = {
  99         SD_BUS_VTABLE_START(0),
 100         SD_BUS_PROPERTY("Type", "s", property_get_type, offsetof(Service, type), SD_BUS_VTABLE_PROPERTY_CONST),
 101         SD_BUS_PROPERTY("Restart", "s", property_get_restart, offsetof(Service, restart), SD_BUS_VTABLE_PROPERTY_CONST),
 102         SD_BUS_PROPERTY("PIDFile", "s", NULL, offsetof(Service, pid_file), SD_BUS_VTABLE_PROPERTY_CONST),
 103         SD_BUS_PROPERTY("NotifyAccess", "s", property_get_notify_access, offsetof(Service, notify_access), SD_BUS_VTABLE_PROPERTY_CONST),
 104         SD_BUS_PROPERTY("RestartUSec", "t", bus_property_get_usec, offsetof(Service, restart_usec), SD_BUS_VTABLE_PROPERTY_CONST),
 105         SD_BUS_PROPERTY("TimeoutStartUSec", "t", bus_property_get_usec, offsetof(Service, timeout_start_usec), SD_BUS_VTABLE_PROPERTY_CONST),
 106         SD_BUS_PROPERTY("TimeoutStopUSec", "t", bus_property_get_usec, offsetof(Service, timeout_stop_usec), SD_BUS_VTABLE_PROPERTY_CONST),
 107         SD_BUS_PROPERTY("TimeoutAbortUSec", "t", property_get_timeout_abort_usec, 0, 0),
 108         SD_BUS_PROPERTY("RuntimeMaxUSec", "t", bus_property_get_usec, offsetof(Service, runtime_max_usec), SD_BUS_VTABLE_PROPERTY_CONST),
 109         SD_BUS_PROPERTY("WatchdogUSec", "t", bus_property_get_usec, offsetof(Service, watchdog_usec), SD_BUS_VTABLE_PROPERTY_CONST),
 110         BUS_PROPERTY_DUAL_TIMESTAMP("WatchdogTimestamp", offsetof(Service, watchdog_timestamp), 0),
 111         SD_BUS_PROPERTY("PermissionsStartOnly", "b", bus_property_get_bool, offsetof(Service, permissions_start_only), SD_BUS_VTABLE_PROPERTY_CONST|SD_BUS_VTABLE_HIDDEN), /* 😷 deprecated */
 112         SD_BUS_PROPERTY("RootDirectoryStartOnly", "b", bus_property_get_bool, offsetof(Service, root_directory_start_only), SD_BUS_VTABLE_PROPERTY_CONST),
 113         SD_BUS_PROPERTY("RemainAfterExit", "b", bus_property_get_bool, offsetof(Service, remain_after_exit), SD_BUS_VTABLE_PROPERTY_CONST),
 114         SD_BUS_PROPERTY("GuessMainPID", "b", bus_property_get_bool, offsetof(Service, guess_main_pid), SD_BUS_VTABLE_PROPERTY_CONST),
 115         SD_BUS_PROPERTY("RestartPreventExitStatus", "(aiai)", property_get_exit_status_set, offsetof(Service, restart_prevent_status), SD_BUS_VTABLE_PROPERTY_CONST),
 116         SD_BUS_PROPERTY("RestartForceExitStatus", "(aiai)", property_get_exit_status_set, offsetof(Service, restart_force_status), SD_BUS_VTABLE_PROPERTY_CONST),
 117         SD_BUS_PROPERTY("SuccessExitStatus", "(aiai)", property_get_exit_status_set, offsetof(Service, success_status), SD_BUS_VTABLE_PROPERTY_CONST),
 118         SD_BUS_PROPERTY("MainPID", "u", bus_property_get_pid, offsetof(Service, main_pid), SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE),
 119         SD_BUS_PROPERTY("ControlPID", "u", bus_property_get_pid, offsetof(Service, control_pid), SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE),
 120         SD_BUS_PROPERTY("BusName", "s", NULL, offsetof(Service, bus_name), SD_BUS_VTABLE_PROPERTY_CONST),
 121         SD_BUS_PROPERTY("FileDescriptorStoreMax", "u", bus_property_get_unsigned, offsetof(Service, n_fd_store_max), SD_BUS_VTABLE_PROPERTY_CONST),
 122         SD_BUS_PROPERTY("NFileDescriptorStore", "u", bus_property_get_unsigned, offsetof(Service, n_fd_store), 0),
 123         SD_BUS_PROPERTY("StatusText", "s", NULL, offsetof(Service, status_text), SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE),
 124         SD_BUS_PROPERTY("StatusErrno", "i", bus_property_get_int, offsetof(Service, status_errno), SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE),
 125         SD_BUS_PROPERTY("Result", "s", property_get_result, offsetof(Service, result), SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE),
 126         SD_BUS_PROPERTY("ReloadResult", "s", property_get_result, offsetof(Service, reload_result), SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE),
 127         SD_BUS_PROPERTY("USBFunctionDescriptors", "s", NULL, offsetof(Service, usb_function_descriptors), SD_BUS_VTABLE_PROPERTY_CONST),
 128         SD_BUS_PROPERTY("USBFunctionStrings", "s", NULL, offsetof(Service, usb_function_strings), SD_BUS_VTABLE_PROPERTY_CONST),
 129         SD_BUS_PROPERTY("UID", "u", bus_property_get_uid, offsetof(Unit, ref_uid), SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE),
 130         SD_BUS_PROPERTY("GID", "u", bus_property_get_gid, offsetof(Unit, ref_gid), SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE),
 131         SD_BUS_PROPERTY("NRestarts", "u", bus_property_get_unsigned, offsetof(Service, n_restarts), SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE),
 132         SD_BUS_PROPERTY("OOMPolicy", "s", bus_property_get_oom_policy, offsetof(Service, oom_policy), SD_BUS_VTABLE_PROPERTY_CONST),
 133
 134         BUS_EXEC_STATUS_VTABLE("ExecMain", offsetof(Service, main_exec_status), SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE),
 135         BUS_EXEC_COMMAND_LIST_VTABLE("ExecStartPre", offsetof(Service, exec_command[SERVICE_EXEC_START_PRE]), SD_BUS_VTABLE_PROPERTY_EMITS_INVALIDATION),
 136         BUS_EXEC_COMMAND_LIST_VTABLE("ExecStart", offsetof(Service, exec_command[SERVICE_EXEC_START]), SD_BUS_VTABLE_PROPERTY_EMITS_INVALIDATION),
 137         BUS_EXEC_COMMAND_LIST_VTABLE("ExecStartPost", offsetof(Service, exec_command[SERVICE_EXEC_START_POST]), SD_BUS_VTABLE_PROPERTY_EMITS_INVALIDATION),
 138         BUS_EXEC_COMMAND_LIST_VTABLE("ExecReload", offsetof(Service, exec_command[SERVICE_EXEC_RELOAD]), SD_BUS_VTABLE_PROPERTY_EMITS_INVALIDATION),
 139         BUS_EXEC_COMMAND_LIST_VTABLE("ExecStop", offsetof(Service, exec_command[SERVICE_EXEC_STOP]), SD_BUS_VTABLE_PROPERTY_EMITS_INVALIDATION),
 140         BUS_EXEC_COMMAND_LIST_VTABLE("ExecStopPost", offsetof(Service, exec_command[SERVICE_EXEC_STOP_POST]), SD_BUS_VTABLE_PROPERTY_EMITS_INVALIDATION),
 141
 142         /* The following four are obsolete, and thus marked hidden here. They moved into the Unit interface */
 143         SD_BUS_PROPERTY("StartLimitInterval", "t", bus_property_get_usec, offsetof(Unit, start_limit.interval), SD_BUS_VTABLE_PROPERTY_CONST|SD_BUS_VTABLE_HIDDEN),
 144         SD_BUS_PROPERTY("StartLimitBurst", "u", bus_property_get_unsigned, offsetof(Unit, start_limit.burst), SD_BUS_VTABLE_PROPERTY_CONST|SD_BUS_VTABLE_HIDDEN),
 145         SD_BUS_PROPERTY("StartLimitAction", "s", property_get_emergency_action, offsetof(Unit, start_limit_action), SD_BUS_VTABLE_PROPERTY_CONST|SD_BUS_VTABLE_HIDDEN),
 146         SD_BUS_PROPERTY("FailureAction", "s", property_get_emergency_action, offsetof(Unit, failure_action), SD_BUS_VTABLE_PROPERTY_CONST|SD_BUS_VTABLE_HIDDEN),
 147         SD_BUS_PROPERTY("RebootArgument", "s", NULL, offsetof(Unit, reboot_arg), SD_BUS_VTABLE_PROPERTY_CONST|SD_BUS_VTABLE_HIDDEN),
 148         SD_BUS_VTABLE_END
 149 };
 150
 151 static int bus_set_transient_exit_status(
 152                 Unit *u,
 153                 const char *name,
 154                 ExitStatusSet *status_set,
 155                 sd_bus_message *message,
 156                 UnitWriteFlags flags,
 157                 sd_bus_error *error) {
 158
 159         const int32_t *status, *signal;
 160         size_t sz_status, sz_signal, i;
 161         int r;
 162
 163         r = sd_bus_message_enter_container(message, 'r', "aiai");
 164         if (r < 0)
 165                 return r;
 166
 167         r = sd_bus_message_read_array(message, 'i', (const void **) &status, &sz_status);
 168         if (r < 0)
 169                 return r;
 170
 171         r = sd_bus_message_read_array(message, 'i', (const void **) &signal, &sz_signal);
 172         if (r < 0)
 173                 return r;
 174
 175         r = sd_bus_message_exit_container(message);
 176         if (r < 0)
 177                 return r;
 178
 179         sz_status /= sizeof(int32_t);
 180         sz_signal /= sizeof(int32_t);
 181
 182         if (sz_status == 0 && sz_signal == 0 && !UNIT_WRITE_FLAGS_NOOP(flags)) {
 183                 exit_status_set_free(status_set);
 184                 unit_write_settingf(u, flags, name, "%s=", name);
 185                 return 1;
 186         }
 187
 188         for (i = 0; i < sz_status; i++) {
 189                 if (status[i] < 0 || status[i] > 255)
 190                         return sd_bus_error_setf(error, SD_BUS_ERROR_INVALID_ARGS, "Invalid status code in %s: %"PRIi32, name, status[i]);
 191
 192                 if (!UNIT_WRITE_FLAGS_NOOP(flags)) {
 193                         r = set_ensure_allocated(&status_set->status, NULL);
 194                         if (r < 0)
 195                                 return r;
 196
 197                         r = set_put(status_set->status, INT_TO_PTR((int) status[i]));
 198                         if (r < 0)
 199                                 return r;
 200
 201                         unit_write_settingf(u, flags, name, "%s=%"PRIi32, name, status[i]);
 202                 }
 203         }
 204
 205         for (i = 0; i < sz_signal; i++) {
 206                 const char *str;
 207
 208                 str = signal_to_string((int) signal[i]);
 209                 if (!str)
 210                         return sd_bus_error_setf(error, SD_BUS_ERROR_INVALID_ARGS, "Invalid signal in %s: %"PRIi32, name, signal[i]);
 211
 212                 if (!UNIT_WRITE_FLAGS_NOOP(flags)) {
 213                         r = set_ensure_allocated(&status_set->signal, NULL);
 214                         if (r < 0)
 215                                 return r;
 216
 217                         r = set_put(status_set->signal, INT_TO_PTR((int) signal[i]));
 218                         if (r < 0)
 219                                 return r;
 220
 221                         unit_write_settingf(u, flags, name, "%s=%s", name, str);
 222                 }
 223         }
 224
 225         return 1;
 226 }
 227
 228 static int bus_set_transient_std_fd(
 229                 Unit *u,
 230                 const char *name,
 231                 int *p,
 232                 bool *b,
 233                 sd_bus_message *message,
 234                 UnitWriteFlags flags,
 235                 sd_bus_error *error) {
 236
 237         int fd, r;
 238
 239         assert(p);
 240         assert(b);
 241
 242         r = sd_bus_message_read(message, "h", &fd);
 243         if (r < 0)
 244                 return r;
 245
 246         if (!UNIT_WRITE_FLAGS_NOOP(flags)) {
 247                 int copy;
 248
 249                 copy = fcntl(fd, F_DUPFD_CLOEXEC, 3);
 250                 if (copy < 0)
 251                         return -errno;
 252
 253                 asynchronous_close(*p);
 254                 *p = copy;
 255                 *b = true;
 256         }
 257
 258         return 1;
 259 }
 260 static BUS_DEFINE_SET_TRANSIENT_PARSE(notify_access, NotifyAccess, notify_access_from_string);
 261 static BUS_DEFINE_SET_TRANSIENT_PARSE(service_type, ServiceType, service_type_from_string);
 262 static BUS_DEFINE_SET_TRANSIENT_PARSE(service_restart, ServiceRestart, service_restart_from_string);
 263 static BUS_DEFINE_SET_TRANSIENT_PARSE(oom_policy, OOMPolicy, oom_policy_from_string);
 264 static BUS_DEFINE_SET_TRANSIENT_STRING_WITH_CHECK(bus_name, service_name_is_valid);
 265
 266 static int bus_service_set_transient_property(
 267                 Service *s,
 268                 const char *name,
 269                 sd_bus_message *message,
 270                 UnitWriteFlags flags,
 271                 sd_bus_error *error) {
 272
 273         Unit *u = UNIT(s);
 274         ServiceExecCommand ci;
 275         int r;
 276
 277         assert(s);
 278         assert(name);
 279         assert(message);
 280
 281         flags |= UNIT_PRIVATE;
 282
 283         if (streq(name, "PermissionsStartOnly"))
 284                 return bus_set_transient_bool(u, name, &s->permissions_start_only, message, flags, error);
 285
 286         if (streq(name, "RootDirectoryStartOnly"))
 287                 return bus_set_transient_bool(u, name, &s->root_directory_start_only, message, flags, error);
 288
 289         if (streq(name, "RemainAfterExit"))
 290                 return bus_set_transient_bool(u, name, &s->remain_after_exit, message, flags, error);
 291
 292         if (streq(name, "GuessMainPID"))
 293                 return bus_set_transient_bool(u, name, &s->guess_main_pid, message, flags, error);
 294
 295         if (streq(name, "Type"))
 296                 return bus_set_transient_service_type(u, name, &s->type, message, flags, error);
 297
 298         if (streq(name, "OOMPolicy"))
 299                 return bus_set_transient_oom_policy(u, name, &s->oom_policy, message, flags, error);
 300
 301         if (streq(name, "RestartUSec"))
 302                 return bus_set_transient_usec(u, name, &s->restart_usec, message, flags, error);
 303
 304         if (streq(name, "TimeoutStartUSec")) {
 305                 r = bus_set_transient_usec(u, name, &s->timeout_start_usec, message, flags, error);
 306                 if (r >= 0 && !UNIT_WRITE_FLAGS_NOOP(flags))
 307                         s->start_timeout_defined = true;
 308
 309                 return r;
 310         }
 311
 312         if (streq(name, "TimeoutStopUSec"))
 313                 return bus_set_transient_usec(u, name, &s->timeout_stop_usec, message, flags, error);
 314
 315         if (streq(name, "RuntimeMaxUSec"))
 316                 return bus_set_transient_usec(u, name, &s->runtime_max_usec, message, flags, error);
 317
 318         if (streq(name, "WatchdogUSec"))
 319                 return bus_set_transient_usec(u, name, &s->watchdog_usec, message, flags, error);
 320
 321         if (streq(name, "FileDescriptorStoreMax"))
 322                 return bus_set_transient_unsigned(u, name, &s->n_fd_store_max, message, flags, error);
 323
 324         if (streq(name, "NotifyAccess"))
 325                 return bus_set_transient_notify_access(u, name, &s->notify_access, message, flags, error);
 326
 327         if (streq(name, "PIDFile")) {
 328                 _cleanup_free_ char *n = NULL;
 329                 const char *v, *e;
 330
 331                 r = sd_bus_message_read(message, "s", &v);
 332                 if (r < 0)
 333                         return r;
 334
 335                 if (!isempty(v)) {
 336                         n = path_make_absolute(v, u->manager->prefix[EXEC_DIRECTORY_RUNTIME]);
 337                         if (!n)
 338                                 return -ENOMEM;
 339
 340                         path_simplify(n, true);
 341
 342                         if (!path_is_normalized(n))
 343                                 return sd_bus_error_setf(error, SD_BUS_ERROR_INVALID_ARGS, "PIDFile= path '%s' is not valid", n);
 344
 345                         e = path_startswith(n, "/var/run/");
 346                         if (e) {
 347                                 char *z;
 348
 349                                 z = strjoin("/run/", e);
 350                                 if (!z)
 351                                         return log_oom();
 352
 353                                 if (!UNIT_WRITE_FLAGS_NOOP(flags))
 354                                         log_unit_notice(u, "Transient unit's PIDFile= property references path below legacy directory /var/run, updating %s → %s; please update client accordingly.", n, z);
 355
 356                                 free_and_replace(n, z);
 357                         }
 358                 }
 359
 360                 if (!UNIT_WRITE_FLAGS_NOOP(flags)) {
 361                         free_and_replace(s->pid_file, n);
 362                         unit_write_settingf(u, flags, name, "%s=%s", name, strempty(s->pid_file));
 363                 }
 364
 365                 return 1;
 366         }
 367
 368         if (streq(name, "USBFunctionDescriptors"))
 369                 return bus_set_transient_path(u, name, &s->usb_function_descriptors, message, flags, error);
 370
 371         if (streq(name, "USBFunctionStrings"))
 372                 return bus_set_transient_path(u, name, &s->usb_function_strings, message, flags, error);
 373
 374         if (streq(name, "BusName"))
 375                 return bus_set_transient_bus_name(u, name, &s->bus_name, message, flags, error);
 376
 377         if (streq(name, "Restart"))
 378                 return bus_set_transient_service_restart(u, name, &s->restart, message, flags, error);
 379
 380         if (streq(name, "RestartPreventExitStatus"))
 381                 return bus_set_transient_exit_status(u, name, &s->restart_prevent_status, message, flags, error);
 382
 383         if (streq(name, "RestartForceExitStatus"))
 384                 return bus_set_transient_exit_status(u, name, &s->restart_force_status, message, flags, error);
 385
 386         if (streq(name, "SuccessExitStatus"))
 387                 return bus_set_transient_exit_status(u, name, &s->success_status, message, flags, error);
 388
 389         ci = service_exec_command_from_string(name);
 390         if (ci >= 0)
 391                 return bus_set_transient_exec_command(u, name, &s->exec_command[ci], message, flags, error);
 392
 393         if (streq(name, "StandardInputFileDescriptor"))
 394                 return bus_set_transient_std_fd(u, name, &s->stdin_fd, &s->exec_context.stdio_as_fds, message, flags, error);
 395
 396         if (streq(name, "StandardOutputFileDescriptor"))
 397                 return bus_set_transient_std_fd(u, name, &s->stdout_fd, &s->exec_context.stdio_as_fds, message, flags, error);
 398
 399         if (streq(name, "StandardErrorFileDescriptor"))
 400                 return bus_set_transient_std_fd(u, name, &s->stderr_fd, &s->exec_context.stdio_as_fds, message, flags, error);
 401
 402         return 0;
 403 }
 404
 405 int bus_service_set_property(
 406                 Unit *u,
 407                 const char *name,
 408                 sd_bus_message *message,
 409                 UnitWriteFlags flags,
 410                 sd_bus_error *error) {
 411
 412         Service *s = SERVICE(u);
 413         int r;
 414
 415         assert(s);
 416         assert(name);
 417         assert(message);
 418
 419         r = bus_cgroup_set_property(u, &s->cgroup_context, name, message, flags, error);
 420         if (r != 0)
 421                 return r;
 422
 423         if (u->transient && u->load_state == UNIT_STUB) {
 424                 /* This is a transient unit, let's load a little more */
 425
 426                 r = bus_service_set_transient_property(s, name, message, flags, error);
 427                 if (r != 0)
 428                         return r;
 429
 430                 r = bus_exec_context_set_transient_property(u, &s->exec_context, name, message, flags, error);
 431                 if (r != 0)
 432                         return r;
 433
 434                 r = bus_kill_context_set_transient_property(u, &s->kill_context, name, message, flags, error);
 435                 if (r != 0)
 436                         return r;
 437         }
 438
 439         return 0;
 440 }
 441
 442 int bus_service_commit_properties(Unit *u) {
 443         assert(u);
 444
 445         unit_invalidate_cgroup_members_masks(u);
 446         unit_realize_cgroup(u);
 447
 448         return 0;
 449 }