src/core/scope.c

   1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
   2
   3 #include <errno.h>
   4 #include <unistd.h>
   5
   6 #include "alloc-util.h"
   7 #include "cgroup-setup.h"
   8 #include "dbus-scope.h"
   9 #include "dbus-unit.h"
  10 #include "exit-status.h"
  11 #include "load-dropin.h"
  12 #include "log.h"
  13 #include "process-util.h"
  14 #include "random-util.h"
  15 #include "scope.h"
  16 #include "serialize.h"
  17 #include "special.h"
  18 #include "string-table.h"
  19 #include "string-util.h"
  20 #include "strv.h"
  21 #include "unit-name.h"
  22 #include "unit.h"
  23 #include "user-util.h"
  24
  25 static const UnitActiveState state_translation_table[_SCOPE_STATE_MAX] = {
  26         [SCOPE_DEAD] = UNIT_INACTIVE,
  27         [SCOPE_START_CHOWN] = UNIT_ACTIVATING,
  28         [SCOPE_RUNNING] = UNIT_ACTIVE,
  29         [SCOPE_ABANDONED] = UNIT_ACTIVE,
  30         [SCOPE_STOP_SIGTERM] = UNIT_DEACTIVATING,
  31         [SCOPE_STOP_SIGKILL] = UNIT_DEACTIVATING,
  32         [SCOPE_FAILED] = UNIT_FAILED
  33 };
  34
  35 static int scope_dispatch_timer(sd_event_source *source, usec_t usec, void *userdata);
  36
  37 static void scope_init(Unit *u) {
  38         Scope *s = SCOPE(u);
  39
  40         assert(u);
  41         assert(u->load_state == UNIT_STUB);
  42
  43         s->runtime_max_usec = USEC_INFINITY;
  44         s->timeout_stop_usec = u->manager->default_timeout_stop_usec;
  45         u->ignore_on_isolate = true;
  46         s->user = s->group = NULL;
  47         s->oom_policy = _OOM_POLICY_INVALID;
  48 }
  49
  50 static void scope_done(Unit *u) {
  51         Scope *s = SCOPE(u);
  52
  53         assert(u);
  54
  55         s->controller = mfree(s->controller);
  56         s->controller_track = sd_bus_track_unref(s->controller_track);
  57
  58         s->timer_event_source = sd_event_source_disable_unref(s->timer_event_source);
  59
  60         s->user = mfree(s->user);
  61         s->group = mfree(s->group);
  62 }
  63
  64 static usec_t scope_running_timeout(Scope *s) {
  65         usec_t delta = 0;
  66
  67         assert(s);
  68
  69         if (s->runtime_rand_extra_usec != 0) {
  70                 delta = random_u64_range(s->runtime_rand_extra_usec);
  71                 log_unit_debug(UNIT(s), "Adding delta of %s sec to timeout", FORMAT_TIMESPAN(delta, USEC_PER_SEC));
  72         }
  73
  74         return usec_add(usec_add(UNIT(s)->active_enter_timestamp.monotonic,
  75                                  s->runtime_max_usec),
  76                         delta);
  77 }
  78
  79 static int scope_arm_timer(Scope *s, usec_t usec) {
  80         int r;
  81
  82         assert(s);
  83
  84         if (s->timer_event_source) {
  85                 r = sd_event_source_set_time(s->timer_event_source, usec);
  86                 if (r < 0)
  87                         return r;
  88
  89                 return sd_event_source_set_enabled(s->timer_event_source, SD_EVENT_ONESHOT);
  90         }
  91
  92         if (usec == USEC_INFINITY)
  93                 return 0;
  94
  95         r = sd_event_add_time(
  96                         UNIT(s)->manager->event,
  97                         &s->timer_event_source,
  98                         CLOCK_MONOTONIC,
  99                         usec, 0,
 100                         scope_dispatch_timer, s);
 101         if (r < 0)
 102                 return r;
 103
 104         (void) sd_event_source_set_description(s->timer_event_source, "scope-timer");
 105
 106         return 0;
 107 }
 108
 109 static void scope_set_state(Scope *s, ScopeState state) {
 110         ScopeState old_state;
 111         assert(s);
 112
 113         if (s->state != state)
 114                 bus_unit_send_pending_change_signal(UNIT(s), false);
 115
 116         old_state = s->state;
 117         s->state = state;
 118
 119         if (!IN_SET(state, SCOPE_STOP_SIGTERM, SCOPE_STOP_SIGKILL, SCOPE_START_CHOWN, SCOPE_RUNNING))
 120                 s->timer_event_source = sd_event_source_disable_unref(s->timer_event_source);
 121
 122         if (IN_SET(state, SCOPE_DEAD, SCOPE_FAILED)) {
 123                 unit_unwatch_all_pids(UNIT(s));
 124                 unit_dequeue_rewatch_pids(UNIT(s));
 125         }
 126
 127         if (state != old_state)
 128                 log_debug("%s changed %s -> %s", UNIT(s)->id, scope_state_to_string(old_state), scope_state_to_string(state));
 129
 130         unit_notify(UNIT(s), state_translation_table[old_state], state_translation_table[state], /* reload_success = */ true);
 131 }
 132
 133 static int scope_add_default_dependencies(Scope *s) {
 134         int r;
 135
 136         assert(s);
 137
 138         if (!UNIT(s)->default_dependencies)
 139                 return 0;
 140
 141         /* Make sure scopes are unloaded on shutdown */
 142         r = unit_add_two_dependencies_by_name(
 143                         UNIT(s),
 144                         UNIT_BEFORE, UNIT_CONFLICTS,
 145                         SPECIAL_SHUTDOWN_TARGET, true,
 146                         UNIT_DEPENDENCY_DEFAULT);
 147         if (r < 0)
 148                 return r;
 149
 150         return 0;
 151 }
 152
 153 static int scope_verify(Scope *s) {
 154         assert(s);
 155         assert(UNIT(s)->load_state == UNIT_LOADED);
 156
 157         if (set_isempty(UNIT(s)->pids) &&
 158             !MANAGER_IS_RELOADING(UNIT(s)->manager) &&
 159             !unit_has_name(UNIT(s), SPECIAL_INIT_SCOPE))
 160                 return log_unit_error_errno(UNIT(s), SYNTHETIC_ERRNO(ENOENT), "Scope has no PIDs. Refusing.");
 161
 162         return 0;
 163 }
 164
 165 static int scope_load_init_scope(Unit *u) {
 166         assert(u);
 167
 168         if (!unit_has_name(u, SPECIAL_INIT_SCOPE))
 169                 return 0;
 170
 171         u->transient = true;
 172         u->perpetual = true;
 173
 174         /* init.scope is a bit special, as it has to stick around forever. Because of its special semantics we
 175          * synthesize it here, instead of relying on the unit file on disk. */
 176
 177         u->default_dependencies = false;
 178
 179         /* Prettify things, if we can. */
 180         if (!u->description)
 181                 u->description = strdup("System and Service Manager");
 182         if (!u->documentation)
 183                 (void) strv_extend(&u->documentation, "man:systemd(1)");
 184
 185         return 1;
 186 }
 187
 188 static int scope_add_extras(Scope *s) {
 189         int r;
 190
 191         r = unit_patch_contexts(UNIT(s));
 192         if (r < 0)
 193                 return r;
 194
 195         r = unit_set_default_slice(UNIT(s));
 196         if (r < 0)
 197                 return r;
 198
 199         if (s->oom_policy < 0)
 200                 s->oom_policy = s->cgroup_context.delegate ? OOM_CONTINUE : UNIT(s)->manager->default_oom_policy;
 201
 202         s->cgroup_context.memory_oom_group = s->oom_policy == OOM_KILL;
 203
 204         return scope_add_default_dependencies(s);
 205 }
 206
 207 static int scope_load(Unit *u) {
 208         Scope *s = SCOPE(u);
 209         int r;
 210
 211         assert(s);
 212         assert(u->load_state == UNIT_STUB);
 213
 214         if (!u->transient && !MANAGER_IS_RELOADING(u->manager))
 215                 /* Refuse to load non-transient scope units, but allow them while reloading. */
 216                 return -ENOENT;
 217
 218         r = scope_load_init_scope(u);
 219         if (r < 0)
 220                 return r;
 221
 222         r = unit_load_fragment_and_dropin(u, false);
 223         if (r < 0)
 224                 return r;
 225
 226         if (u->load_state != UNIT_LOADED)
 227                 return 0;
 228
 229         r = scope_add_extras(s);
 230         if (r < 0)
 231                 return r;
 232
 233         return scope_verify(s);
 234 }
 235
 236 static usec_t scope_coldplug_timeout(Scope *s) {
 237         assert(s);
 238
 239         switch (s->deserialized_state) {
 240
 241         case SCOPE_RUNNING:
 242                 return scope_running_timeout(s);
 243
 244         case SCOPE_STOP_SIGKILL:
 245         case SCOPE_STOP_SIGTERM:
 246                 return usec_add(UNIT(s)->state_change_timestamp.monotonic, s->timeout_stop_usec);
 247
 248         default:
 249                 return USEC_INFINITY;
 250         }
 251 }
 252
 253 static int scope_coldplug(Unit *u) {
 254         Scope *s = SCOPE(u);
 255         int r;
 256
 257         assert(s);
 258         assert(s->state == SCOPE_DEAD);
 259
 260         if (s->deserialized_state == s->state)
 261                 return 0;
 262
 263         r = scope_arm_timer(s, scope_coldplug_timeout(s));
 264         if (r < 0)
 265                 return r;
 266
 267         if (!IN_SET(s->deserialized_state, SCOPE_DEAD, SCOPE_FAILED)) {
 268                 if (u->pids) {
 269                         void *pidp;
 270
 271                         SET_FOREACH(pidp, u->pids) {
 272                                 r = unit_watch_pid(u, PTR_TO_PID(pidp), false);
 273                                 if (r < 0 && r != -EEXIST)
 274                                         return r;
 275                         }
 276                 } else
 277                         (void) unit_enqueue_rewatch_pids(u);
 278         }
 279
 280         bus_scope_track_controller(s);
 281
 282         scope_set_state(s, s->deserialized_state);
 283         return 0;
 284 }
 285
 286 static void scope_dump(Unit *u, FILE *f, const char *prefix) {
 287         Scope *s = SCOPE(u);
 288
 289         assert(s);
 290         assert(f);
 291
 292         fprintf(f,
 293                 "%sScope State: %s\n"
 294                 "%sResult: %s\n"
 295                 "%sRuntimeMaxSec: %s\n"
 296                 "%sRuntimeRandomizedExtraSec: %s\n"
 297                 "%sOOMPolicy: %s\n",
 298                 prefix, scope_state_to_string(s->state),
 299                 prefix, scope_result_to_string(s->result),
 300                 prefix, FORMAT_TIMESPAN(s->runtime_max_usec, USEC_PER_SEC),
 301                 prefix, FORMAT_TIMESPAN(s->runtime_rand_extra_usec, USEC_PER_SEC),
 302                 prefix, oom_policy_to_string(s->oom_policy));
 303
 304         cgroup_context_dump(UNIT(s), f, prefix);
 305         kill_context_dump(&s->kill_context, f, prefix);
 306 }
 307
 308 static void scope_enter_dead(Scope *s, ScopeResult f) {
 309         assert(s);
 310
 311         if (s->result == SCOPE_SUCCESS)
 312                 s->result = f;
 313
 314         unit_log_result(UNIT(s), s->result == SCOPE_SUCCESS, scope_result_to_string(s->result));
 315         scope_set_state(s, s->result != SCOPE_SUCCESS ? SCOPE_FAILED : SCOPE_DEAD);
 316 }
 317
 318 static void scope_enter_signal(Scope *s, ScopeState state, ScopeResult f) {
 319         bool skip_signal = false;
 320         int r;
 321
 322         assert(s);
 323
 324         if (s->result == SCOPE_SUCCESS)
 325                 s->result = f;
 326
 327         /* Before sending any signal, make sure we track all members of this cgroup */
 328         (void) unit_watch_all_pids(UNIT(s));
 329
 330         /* Also, enqueue a job that we recheck all our PIDs a bit later, given that it's likely some processes have
 331          * died now */
 332         (void) unit_enqueue_rewatch_pids(UNIT(s));
 333
 334         /* If we have a controller set let's ask the controller nicely to terminate the scope, instead of us going
 335          * directly into SIGTERM berserk mode */
 336         if (state == SCOPE_STOP_SIGTERM)
 337                 skip_signal = bus_scope_send_request_stop(s) > 0;
 338
 339         if (skip_signal)
 340                 r = 1; /* wait */
 341         else {
 342                 r = unit_kill_context(
 343                                 UNIT(s),
 344                                 &s->kill_context,
 345                                 state != SCOPE_STOP_SIGTERM ? KILL_KILL :
 346                                 s->was_abandoned            ? KILL_TERMINATE_AND_LOG :
 347                                                               KILL_TERMINATE,
 348                                 -1, -1, false);
 349                 if (r < 0)
 350                         goto fail;
 351         }
 352
 353         if (r > 0) {
 354                 r = scope_arm_timer(s, usec_add(now(CLOCK_MONOTONIC), s->timeout_stop_usec));
 355                 if (r < 0)
 356                         goto fail;
 357
 358                 scope_set_state(s, state);
 359         } else if (state == SCOPE_STOP_SIGTERM)
 360                 scope_enter_signal(s, SCOPE_STOP_SIGKILL, SCOPE_SUCCESS);
 361         else
 362                 scope_enter_dead(s, SCOPE_SUCCESS);
 363
 364         return;
 365
 366 fail:
 367         log_unit_warning_errno(UNIT(s), r, "Failed to kill processes: %m");
 368
 369         scope_enter_dead(s, SCOPE_FAILURE_RESOURCES);
 370 }
 371
 372 static int scope_enter_start_chown(Scope *s) {
 373         Unit *u = UNIT(s);
 374         pid_t pid;
 375         int r;
 376
 377         assert(s);
 378         assert(s->user);
 379
 380         r = scope_arm_timer(s, usec_add(now(CLOCK_MONOTONIC), u->manager->default_timeout_start_usec));
 381         if (r < 0)
 382                 return r;
 383
 384         r = unit_fork_helper_process(u, "(sd-chown-cgroup)", &pid);
 385         if (r < 0)
 386                 goto fail;
 387
 388         if (r == 0) {
 389                 uid_t uid = UID_INVALID;
 390                 gid_t gid = GID_INVALID;
 391
 392                 if (!isempty(s->user)) {
 393                         const char *user = s->user;
 394
 395                         r = get_user_creds(&user, &uid, &gid, NULL, NULL, 0);
 396                         if (r < 0) {
 397                                 log_unit_error_errno(UNIT(s), r, "Failed to resolve user \"%s\": %m", user);
 398                                 _exit(EXIT_USER);
 399                         }
 400                 }
 401
 402                 if (!isempty(s->group)) {
 403                         const char *group = s->group;
 404
 405                         r = get_group_creds(&group, &gid, 0);
 406                         if (r < 0) {
 407                                 log_unit_error_errno(UNIT(s), r, "Failed to resolve group \"%s\": %m", group);
 408                                 _exit(EXIT_GROUP);
 409                         }
 410                 }
 411
 412                 r = cg_set_access(SYSTEMD_CGROUP_CONTROLLER, u->cgroup_path, uid, gid);
 413                 if (r < 0) {
 414                         log_unit_error_errno(UNIT(s), r, "Failed to adjust control group access: %m");
 415                         _exit(EXIT_CGROUP);
 416                 }
 417
 418                 _exit(EXIT_SUCCESS);
 419         }
 420
 421         r = unit_watch_pid(UNIT(s), pid, true);
 422         if (r < 0)
 423                 goto fail;
 424
 425         scope_set_state(s, SCOPE_START_CHOWN);
 426
 427         return 1;
 428 fail:
 429         s->timer_event_source = sd_event_source_disable_unref(s->timer_event_source);
 430         return r;
 431 }
 432
 433 static int scope_enter_running(Scope *s) {
 434         Unit *u = UNIT(s);
 435         int r;
 436
 437         assert(s);
 438
 439         (void) bus_scope_track_controller(s);
 440
 441         r = unit_acquire_invocation_id(u);
 442         if (r < 0)
 443                 return r;
 444
 445         unit_export_state_files(u);
 446
 447         r = unit_attach_pids_to_cgroup(u, u->pids, NULL);
 448         if (r < 0) {
 449                 log_unit_warning_errno(u, r, "Failed to add PIDs to scope's control group: %m");
 450                 scope_enter_dead(s, SCOPE_FAILURE_RESOURCES);
 451                 return r;
 452         }
 453         if (r == 0) {
 454                 log_unit_warning(u, "No PIDs left to attach to the scope's control group, refusing.");
 455                 scope_enter_dead(s, SCOPE_FAILURE_RESOURCES);
 456                 return -ECHILD;
 457         }
 458         log_unit_debug(u, "%i %s added to scope's control group.", r, r == 1 ? "process" : "processes");
 459
 460         s->result = SCOPE_SUCCESS;
 461
 462         scope_set_state(s, SCOPE_RUNNING);
 463
 464         /* Set the maximum runtime timeout. */
 465         scope_arm_timer(s, scope_running_timeout(s));
 466
 467         /* On unified we use proper notifications hence we can unwatch the PIDs
 468          * we just attached to the scope. This can also be done on legacy as
 469          * we're going to update the list of the processes we watch with the
 470          * PIDs currently in the scope anyway. */
 471         unit_unwatch_all_pids(u);
 472
 473         /* Start watching the PIDs currently in the scope (legacy hierarchy only) */
 474         (void) unit_enqueue_rewatch_pids(u);
 475         return 1;
 476 }
 477
 478 static int scope_start(Unit *u) {
 479         Scope *s = SCOPE(u);
 480
 481         assert(s);
 482
 483         if (unit_has_name(u, SPECIAL_INIT_SCOPE))
 484                 return -EPERM;
 485
 486         if (s->state == SCOPE_FAILED)
 487                 return -EPERM;
 488
 489         /* We can't fulfill this right now, please try again later */
 490         if (IN_SET(s->state, SCOPE_STOP_SIGTERM, SCOPE_STOP_SIGKILL))
 491                 return -EAGAIN;
 492
 493         assert(s->state == SCOPE_DEAD);
 494
 495         if (!u->transient && !MANAGER_IS_RELOADING(u->manager))
 496                 return -ENOENT;
 497
 498         (void) unit_realize_cgroup(u);
 499         (void) unit_reset_accounting(u);
 500
 501         /* We check only for User= option to keep behavior consistent with logic for service units,
 502          * i.e. having 'Delegate=true Group=foo' w/o specifying User= has no effect. */
 503         if (s->user && unit_cgroup_delegate(u))
 504                 return scope_enter_start_chown(s);
 505
 506         return scope_enter_running(s);
 507 }
 508
 509 static int scope_stop(Unit *u) {
 510         Scope *s = SCOPE(u);
 511
 512         assert(s);
 513
 514         if (IN_SET(s->state, SCOPE_STOP_SIGTERM, SCOPE_STOP_SIGKILL))
 515                 return 0;
 516
 517         assert(IN_SET(s->state, SCOPE_RUNNING, SCOPE_ABANDONED));
 518
 519         scope_enter_signal(s, SCOPE_STOP_SIGTERM, SCOPE_SUCCESS);
 520         return 1;
 521 }
 522
 523 static void scope_reset_failed(Unit *u) {
 524         Scope *s = SCOPE(u);
 525
 526         assert(s);
 527
 528         if (s->state == SCOPE_FAILED)
 529                 scope_set_state(s, SCOPE_DEAD);
 530
 531         s->result = SCOPE_SUCCESS;
 532 }
 533
 534 static int scope_kill(Unit *u, KillWho who, int signo, int code, int value, sd_bus_error *error) {
 535         return unit_kill_common(u, who, signo, code, value, -1, -1, error);
 536 }
 537
 538 static int scope_get_timeout(Unit *u, usec_t *timeout) {
 539         Scope *s = SCOPE(u);
 540         usec_t t;
 541         int r;
 542
 543         if (!s->timer_event_source)
 544                 return 0;
 545
 546         r = sd_event_source_get_time(s->timer_event_source, &t);
 547         if (r < 0)
 548                 return r;
 549         if (t == USEC_INFINITY)
 550                 return 0;
 551
 552         *timeout = t;
 553         return 1;
 554 }
 555
 556 static int scope_serialize(Unit *u, FILE *f, FDSet *fds) {
 557         Scope *s = SCOPE(u);
 558         void *pidp;
 559
 560         assert(s);
 561         assert(f);
 562         assert(fds);
 563
 564         (void) serialize_item(f, "state", scope_state_to_string(s->state));
 565         (void) serialize_bool(f, "was-abandoned", s->was_abandoned);
 566
 567         if (s->controller)
 568                 (void) serialize_item(f, "controller", s->controller);
 569
 570         SET_FOREACH(pidp, u->pids)
 571                 serialize_item_format(f, "pids", PID_FMT, PTR_TO_PID(pidp));
 572
 573         return 0;
 574 }
 575
 576 static int scope_deserialize_item(Unit *u, const char *key, const char *value, FDSet *fds) {
 577         Scope *s = SCOPE(u);
 578         int r;
 579
 580         assert(u);
 581         assert(key);
 582         assert(value);
 583         assert(fds);
 584
 585         if (streq(key, "state")) {
 586                 ScopeState state;
 587
 588                 state = scope_state_from_string(value);
 589                 if (state < 0)
 590                         log_unit_debug(u, "Failed to parse state value: %s", value);
 591                 else
 592                         s->deserialized_state = state;
 593
 594         } else if (streq(key, "was-abandoned")) {
 595                 int k;
 596
 597                 k = parse_boolean(value);
 598                 if (k < 0)
 599                         log_unit_debug(u, "Failed to parse boolean value: %s", value);
 600                 else
 601                         s->was_abandoned = k;
 602         } else if (streq(key, "controller")) {
 603
 604                 r = free_and_strdup(&s->controller, value);
 605                 if (r < 0)
 606                         return log_oom();
 607
 608         } else if (streq(key, "pids")) {
 609                 pid_t pid;
 610
 611                 if (parse_pid(value, &pid) < 0)
 612                         log_unit_debug(u, "Failed to parse pids value: %s", value);
 613                 else {
 614                         r = set_ensure_put(&u->pids, NULL, PID_TO_PTR(pid));
 615                         if (r < 0)
 616                                 return r;
 617                 }
 618         } else
 619                 log_unit_debug(u, "Unknown serialization key: %s", key);
 620
 621         return 0;
 622 }
 623
 624 static void scope_notify_cgroup_empty_event(Unit *u) {
 625         Scope *s = SCOPE(u);
 626         assert(u);
 627
 628         log_unit_debug(u, "cgroup is empty");
 629
 630         if (IN_SET(s->state, SCOPE_RUNNING, SCOPE_ABANDONED, SCOPE_STOP_SIGTERM, SCOPE_STOP_SIGKILL))
 631                 scope_enter_dead(s, SCOPE_SUCCESS);
 632 }
 633
 634 static void scope_notify_cgroup_oom_event(Unit *u, bool managed_oom) {
 635         Scope *s = SCOPE(u);
 636
 637         if (managed_oom)
 638                 log_unit_debug(u, "Process(es) of control group were killed by systemd-oomd.");
 639         else
 640                 log_unit_debug(u, "Process of control group was killed by the OOM killer.");
 641
 642         if (s->oom_policy == OOM_CONTINUE)
 643                 return;
 644
 645         switch (s->state) {
 646
 647         case SCOPE_START_CHOWN:
 648         case SCOPE_RUNNING:
 649                 scope_enter_signal(s, SCOPE_STOP_SIGTERM, SCOPE_FAILURE_OOM_KILL);
 650                 break;
 651
 652         case SCOPE_STOP_SIGTERM:
 653                 scope_enter_signal(s, SCOPE_STOP_SIGKILL, SCOPE_FAILURE_OOM_KILL);
 654                 break;
 655
 656         case SCOPE_STOP_SIGKILL:
 657                 if (s->result == SCOPE_SUCCESS)
 658                         s->result = SCOPE_FAILURE_OOM_KILL;
 659                 break;
 660         /* SCOPE_DEAD, SCOPE_ABANDONED, and SCOPE_FAILED end up in default */
 661         default:
 662                 ;
 663         }
 664 }
 665
 666 static void scope_sigchld_event(Unit *u, pid_t pid, int code, int status) {
 667         Scope *s = SCOPE(u);
 668
 669         assert(s);
 670
 671         if (s->state == SCOPE_START_CHOWN) {
 672                 if (!is_clean_exit(code, status, EXIT_CLEAN_COMMAND, NULL))
 673                         scope_enter_dead(s, SCOPE_FAILURE_RESOURCES);
 674                 else
 675                         scope_enter_running(s);
 676                 return;
 677         }
 678
 679         /* If we get a SIGCHLD event for one of the processes we were interested in, then we look for others to
 680          * watch, under the assumption that we'll sooner or later get a SIGCHLD for them, as the original
 681          * process we watched was probably the parent of them, and they are hence now our children. */
 682
 683         (void) unit_enqueue_rewatch_pids(u);
 684 }
 685
 686 static int scope_dispatch_timer(sd_event_source *source, usec_t usec, void *userdata) {
 687         Scope *s = SCOPE(userdata);
 688
 689         assert(s);
 690         assert(s->timer_event_source == source);
 691
 692         switch (s->state) {
 693
 694         case SCOPE_RUNNING:
 695                 log_unit_warning(UNIT(s), "Scope reached runtime time limit. Stopping.");
 696                 scope_enter_signal(s, SCOPE_STOP_SIGTERM, SCOPE_FAILURE_TIMEOUT);
 697                 break;
 698
 699         case SCOPE_STOP_SIGTERM:
 700                 if (s->kill_context.send_sigkill) {
 701                         log_unit_warning(UNIT(s), "Stopping timed out. Killing.");
 702                         scope_enter_signal(s, SCOPE_STOP_SIGKILL, SCOPE_FAILURE_TIMEOUT);
 703                 } else {
 704                         log_unit_warning(UNIT(s), "Stopping timed out. Skipping SIGKILL.");
 705                         scope_enter_dead(s, SCOPE_FAILURE_TIMEOUT);
 706                 }
 707
 708                 break;
 709
 710         case SCOPE_STOP_SIGKILL:
 711                 log_unit_warning(UNIT(s), "Still around after SIGKILL. Ignoring.");
 712                 scope_enter_dead(s, SCOPE_FAILURE_TIMEOUT);
 713                 break;
 714
 715         case SCOPE_START_CHOWN:
 716                 log_unit_warning(UNIT(s), "User lookup timed out. Entering failed state.");
 717                 scope_enter_dead(s, SCOPE_FAILURE_TIMEOUT);
 718                 break;
 719
 720         default:
 721                 assert_not_reached();
 722         }
 723
 724         return 0;
 725 }
 726
 727 int scope_abandon(Scope *s) {
 728         assert(s);
 729
 730         if (unit_has_name(UNIT(s), SPECIAL_INIT_SCOPE))
 731                 return -EPERM;
 732
 733         if (!IN_SET(s->state, SCOPE_RUNNING, SCOPE_ABANDONED))
 734                 return -ESTALE;
 735
 736         s->was_abandoned = true;
 737
 738         s->controller = mfree(s->controller);
 739         s->controller_track = sd_bus_track_unref(s->controller_track);
 740
 741         scope_set_state(s, SCOPE_ABANDONED);
 742
 743         /* The client is no longer watching the remaining processes, so let's step in here, under the assumption that
 744          * the remaining processes will be sooner or later reassigned to us as parent. */
 745         (void) unit_enqueue_rewatch_pids(UNIT(s));
 746
 747         return 0;
 748 }
 749
 750 _pure_ static UnitActiveState scope_active_state(Unit *u) {
 751         assert(u);
 752
 753         return state_translation_table[SCOPE(u)->state];
 754 }
 755
 756 _pure_ static const char *scope_sub_state_to_string(Unit *u) {
 757         assert(u);
 758
 759         return scope_state_to_string(SCOPE(u)->state);
 760 }
 761
 762 static void scope_enumerate_perpetual(Manager *m) {
 763         Unit *u;
 764         int r;
 765
 766         assert(m);
 767
 768         /* Let's unconditionally add the "init.scope" special unit
 769          * that encapsulates PID 1. Note that PID 1 already is in the
 770          * cgroup for this, we hence just need to allocate the object
 771          * for it and that's it. */
 772
 773         u = manager_get_unit(m, SPECIAL_INIT_SCOPE);
 774         if (!u) {
 775                 r = unit_new_for_name(m, sizeof(Scope), SPECIAL_INIT_SCOPE, &u);
 776                 if (r < 0)  {
 777                         log_error_errno(r, "Failed to allocate the special " SPECIAL_INIT_SCOPE " unit: %m");
 778                         return;
 779                 }
 780         }
 781
 782         u->transient = true;
 783         u->perpetual = true;
 784         SCOPE(u)->deserialized_state = SCOPE_RUNNING;
 785
 786         unit_add_to_load_queue(u);
 787         unit_add_to_dbus_queue(u);
 788         /* Enqueue an explicit cgroup realization here. Unlike other cgroups this one already exists and is
 789          * populated (by us, after all!) already, even when we are not in a reload cycle. Hence we cannot
 790          * apply the settings at creation time anymore, but let's at least apply them asynchronously. */
 791         unit_add_to_cgroup_realize_queue(u);
 792 }
 793
 794 static const char* const scope_result_table[_SCOPE_RESULT_MAX] = {
 795         [SCOPE_SUCCESS]           = "success",
 796         [SCOPE_FAILURE_RESOURCES] = "resources",
 797         [SCOPE_FAILURE_TIMEOUT]   = "timeout",
 798         [SCOPE_FAILURE_OOM_KILL]  = "oom-kill",
 799 };
 800
 801 DEFINE_STRING_TABLE_LOOKUP(scope_result, ScopeResult);
 802
 803 const UnitVTable scope_vtable = {
 804         .object_size = sizeof(Scope),
 805         .cgroup_context_offset = offsetof(Scope, cgroup_context),
 806         .kill_context_offset = offsetof(Scope, kill_context),
 807
 808         .sections =
 809                 "Unit\0"
 810                 "Scope\0"
 811                 "Install\0",
 812         .private_section = "Scope",
 813
 814         .can_transient = true,
 815         .can_delegate = true,
 816         .can_fail = true,
 817         .once_only = true,
 818         .can_set_managed_oom = true,
 819
 820         .init = scope_init,
 821         .load = scope_load,
 822         .done = scope_done,
 823
 824         .coldplug = scope_coldplug,
 825
 826         .dump = scope_dump,
 827
 828         .start = scope_start,
 829         .stop = scope_stop,
 830
 831         .kill = scope_kill,
 832
 833         .freeze = unit_freeze_vtable_common,
 834         .thaw = unit_thaw_vtable_common,
 835
 836         .get_timeout = scope_get_timeout,
 837
 838         .serialize = scope_serialize,
 839         .deserialize_item = scope_deserialize_item,
 840
 841         .active_state = scope_active_state,
 842         .sub_state_to_string = scope_sub_state_to_string,
 843
 844         .sigchld_event = scope_sigchld_event,
 845
 846         .reset_failed = scope_reset_failed,
 847
 848         .notify_cgroup_empty = scope_notify_cgroup_empty_event,
 849         .notify_cgroup_oom = scope_notify_cgroup_oom_event,
 850
 851         .bus_set_property = bus_scope_set_property,
 852         .bus_commit_properties = bus_scope_commit_properties,
 853
 854         .enumerate_perpetual = scope_enumerate_perpetual,
 855 };