src/core/dbus-service.c

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