1 /* SPDX-License-Identifier: LGPL-2.1+ */
6 #include "alloc-util.h"
7 #include "dbus-scope.h"
8 #include "load-dropin.h"
12 #include "string-table.h"
13 #include "string-util.h"
15 #include "unit-name.h"
18 static const UnitActiveState state_translation_table
[_SCOPE_STATE_MAX
] = {
19 [SCOPE_DEAD
] = UNIT_INACTIVE
,
20 [SCOPE_RUNNING
] = UNIT_ACTIVE
,
21 [SCOPE_ABANDONED
] = UNIT_ACTIVE
,
22 [SCOPE_STOP_SIGTERM
] = UNIT_DEACTIVATING
,
23 [SCOPE_STOP_SIGKILL
] = UNIT_DEACTIVATING
,
24 [SCOPE_FAILED
] = UNIT_FAILED
27 static int scope_dispatch_timer(sd_event_source
*source
, usec_t usec
, void *userdata
);
29 static void scope_init(Unit
*u
) {
33 assert(u
->load_state
== UNIT_STUB
);
35 s
->timeout_stop_usec
= u
->manager
->default_timeout_stop_usec
;
36 u
->ignore_on_isolate
= true;
39 static void scope_done(Unit
*u
) {
44 s
->controller
= mfree(s
->controller
);
45 s
->controller_track
= sd_bus_track_unref(s
->controller_track
);
47 s
->timer_event_source
= sd_event_source_unref(s
->timer_event_source
);
50 static int scope_arm_timer(Scope
*s
, usec_t usec
) {
55 if (s
->timer_event_source
) {
56 r
= sd_event_source_set_time(s
->timer_event_source
, usec
);
60 return sd_event_source_set_enabled(s
->timer_event_source
, SD_EVENT_ONESHOT
);
63 if (usec
== USEC_INFINITY
)
66 r
= sd_event_add_time(
67 UNIT(s
)->manager
->event
,
68 &s
->timer_event_source
,
71 scope_dispatch_timer
, s
);
75 (void) sd_event_source_set_description(s
->timer_event_source
, "scope-timer");
80 static void scope_set_state(Scope
*s
, ScopeState state
) {
87 if (!IN_SET(state
, SCOPE_STOP_SIGTERM
, SCOPE_STOP_SIGKILL
))
88 s
->timer_event_source
= sd_event_source_unref(s
->timer_event_source
);
90 if (IN_SET(state
, SCOPE_DEAD
, SCOPE_FAILED
)) {
91 unit_unwatch_all_pids(UNIT(s
));
92 unit_dequeue_rewatch_pids(UNIT(s
));
95 if (state
!= old_state
)
96 log_debug("%s changed %s -> %s", UNIT(s
)->id
, scope_state_to_string(old_state
), scope_state_to_string(state
));
98 unit_notify(UNIT(s
), state_translation_table
[old_state
], state_translation_table
[state
], 0);
101 static int scope_add_default_dependencies(Scope
*s
) {
106 if (!UNIT(s
)->default_dependencies
)
109 /* Make sure scopes are unloaded on shutdown */
110 r
= unit_add_two_dependencies_by_name(
112 UNIT_BEFORE
, UNIT_CONFLICTS
,
113 SPECIAL_SHUTDOWN_TARGET
, true,
114 UNIT_DEPENDENCY_DEFAULT
);
121 static int scope_verify(Scope
*s
) {
124 if (UNIT(s
)->load_state
!= UNIT_LOADED
)
127 if (set_isempty(UNIT(s
)->pids
) &&
128 !MANAGER_IS_RELOADING(UNIT(s
)->manager
) &&
129 !unit_has_name(UNIT(s
), SPECIAL_INIT_SCOPE
)) {
130 log_unit_error(UNIT(s
), "Scope has no PIDs. Refusing.");
137 static int scope_load_init_scope(Unit
*u
) {
140 if (!unit_has_name(u
, SPECIAL_INIT_SCOPE
))
146 /* init.scope is a bit special, as it has to stick around forever. Because of its special semantics we
147 * synthesize it here, instead of relying on the unit file on disk. */
149 u
->default_dependencies
= false;
151 /* Prettify things, if we can. */
153 u
->description
= strdup("System and Service Manager");
154 if (!u
->documentation
)
155 (void) strv_extend(&u
->documentation
, "man:systemd(1)");
160 static int scope_load(Unit
*u
) {
165 assert(u
->load_state
== UNIT_STUB
);
167 if (!u
->transient
&& !MANAGER_IS_RELOADING(u
->manager
))
168 /* Refuse to load non-transient scope units, but allow them while reloading. */
171 r
= scope_load_init_scope(u
);
174 r
= unit_load_fragment_and_dropin_optional(u
);
178 if (u
->load_state
== UNIT_LOADED
) {
179 r
= unit_patch_contexts(u
);
183 r
= unit_set_default_slice(u
);
187 r
= scope_add_default_dependencies(s
);
192 return scope_verify(s
);
195 static int scope_coldplug(Unit
*u
) {
200 assert(s
->state
== SCOPE_DEAD
);
202 if (s
->deserialized_state
== s
->state
)
205 if (IN_SET(s
->deserialized_state
, SCOPE_STOP_SIGKILL
, SCOPE_STOP_SIGTERM
)) {
206 r
= scope_arm_timer(s
, usec_add(u
->state_change_timestamp
.monotonic
, s
->timeout_stop_usec
));
211 if (!IN_SET(s
->deserialized_state
, SCOPE_DEAD
, SCOPE_FAILED
))
212 (void) unit_enqueue_rewatch_pids(u
);
214 bus_scope_track_controller(s
);
216 scope_set_state(s
, s
->deserialized_state
);
220 static void scope_dump(Unit
*u
, FILE *f
, const char *prefix
) {
227 "%sScope State: %s\n"
229 prefix
, scope_state_to_string(s
->state
),
230 prefix
, scope_result_to_string(s
->result
));
232 cgroup_context_dump(&s
->cgroup_context
, f
, prefix
);
233 kill_context_dump(&s
->kill_context
, f
, prefix
);
236 static void scope_enter_dead(Scope
*s
, ScopeResult f
) {
239 if (s
->result
== SCOPE_SUCCESS
)
242 if (s
->result
!= SCOPE_SUCCESS
)
243 log_unit_warning(UNIT(s
), "Failed with result '%s'.", scope_result_to_string(s
->result
));
245 scope_set_state(s
, s
->result
!= SCOPE_SUCCESS
? SCOPE_FAILED
: SCOPE_DEAD
);
248 static void scope_enter_signal(Scope
*s
, ScopeState state
, ScopeResult f
) {
249 bool skip_signal
= false;
254 if (s
->result
== SCOPE_SUCCESS
)
257 /* Before sending any signal, make sure we track all members of this cgroup */
258 (void) unit_watch_all_pids(UNIT(s
));
260 /* Also, enqueue a job that we recheck all our PIDs a bit later, given that it's likely some processes have
262 (void) unit_enqueue_rewatch_pids(UNIT(s
));
264 /* If we have a controller set let's ask the controller nicely to terminate the scope, instead of us going
265 * directly into SIGTERM berserk mode */
266 if (state
== SCOPE_STOP_SIGTERM
)
267 skip_signal
= bus_scope_send_request_stop(s
) > 0;
272 r
= unit_kill_context(
275 state
!= SCOPE_STOP_SIGTERM
? KILL_KILL
:
276 s
->was_abandoned
? KILL_TERMINATE_AND_LOG
:
284 r
= scope_arm_timer(s
, usec_add(now(CLOCK_MONOTONIC
), s
->timeout_stop_usec
));
288 scope_set_state(s
, state
);
289 } else if (state
== SCOPE_STOP_SIGTERM
)
290 scope_enter_signal(s
, SCOPE_STOP_SIGKILL
, SCOPE_SUCCESS
);
292 scope_enter_dead(s
, SCOPE_SUCCESS
);
297 log_unit_warning_errno(UNIT(s
), r
, "Failed to kill processes: %m");
299 scope_enter_dead(s
, SCOPE_FAILURE_RESOURCES
);
302 static int scope_start(Unit
*u
) {
308 if (unit_has_name(u
, SPECIAL_INIT_SCOPE
))
311 if (s
->state
== SCOPE_FAILED
)
314 /* We can't fulfill this right now, please try again later */
315 if (IN_SET(s
->state
, SCOPE_STOP_SIGTERM
, SCOPE_STOP_SIGKILL
))
318 assert(s
->state
== SCOPE_DEAD
);
320 if (!u
->transient
&& !MANAGER_IS_RELOADING(u
->manager
))
323 (void) bus_scope_track_controller(s
);
325 r
= unit_acquire_invocation_id(u
);
329 (void) unit_realize_cgroup(u
);
330 (void) unit_reset_cpu_accounting(u
);
331 (void) unit_reset_ip_accounting(u
);
333 unit_export_state_files(UNIT(s
));
335 r
= unit_attach_pids_to_cgroup(u
, UNIT(s
)->pids
, NULL
);
337 log_unit_warning_errno(UNIT(s
), r
, "Failed to add PIDs to scope's control group: %m");
338 scope_enter_dead(s
, SCOPE_FAILURE_RESOURCES
);
342 s
->result
= SCOPE_SUCCESS
;
344 scope_set_state(s
, SCOPE_RUNNING
);
346 /* Start watching the PIDs currently in the scope */
347 (void) unit_enqueue_rewatch_pids(UNIT(s
));
351 static int scope_stop(Unit
*u
) {
356 if (IN_SET(s
->state
, SCOPE_STOP_SIGTERM
, SCOPE_STOP_SIGKILL
))
359 assert(IN_SET(s
->state
, SCOPE_RUNNING
, SCOPE_ABANDONED
));
361 scope_enter_signal(s
, SCOPE_STOP_SIGTERM
, SCOPE_SUCCESS
);
365 static void scope_reset_failed(Unit
*u
) {
370 if (s
->state
== SCOPE_FAILED
)
371 scope_set_state(s
, SCOPE_DEAD
);
373 s
->result
= SCOPE_SUCCESS
;
376 static int scope_kill(Unit
*u
, KillWho who
, int signo
, sd_bus_error
*error
) {
377 return unit_kill_common(u
, who
, signo
, -1, -1, error
);
380 static int scope_get_timeout(Unit
*u
, usec_t
*timeout
) {
385 if (!s
->timer_event_source
)
388 r
= sd_event_source_get_time(s
->timer_event_source
, &t
);
391 if (t
== USEC_INFINITY
)
398 static int scope_serialize(Unit
*u
, FILE *f
, FDSet
*fds
) {
405 unit_serialize_item(u
, f
, "state", scope_state_to_string(s
->state
));
406 unit_serialize_item(u
, f
, "was-abandoned", yes_no(s
->was_abandoned
));
409 unit_serialize_item(u
, f
, "controller", s
->controller
);
414 static int scope_deserialize_item(Unit
*u
, const char *key
, const char *value
, FDSet
*fds
) {
423 if (streq(key
, "state")) {
426 state
= scope_state_from_string(value
);
428 log_unit_debug(u
, "Failed to parse state value: %s", value
);
430 s
->deserialized_state
= state
;
432 } else if (streq(key
, "was-abandoned")) {
435 k
= parse_boolean(value
);
437 log_unit_debug(u
, "Failed to parse boolean value: %s", value
);
439 s
->was_abandoned
= k
;
440 } else if (streq(key
, "controller")) {
442 r
= free_and_strdup(&s
->controller
, value
);
447 log_unit_debug(u
, "Unknown serialization key: %s", key
);
452 static void scope_notify_cgroup_empty_event(Unit
*u
) {
456 log_unit_debug(u
, "cgroup is empty");
458 if (IN_SET(s
->state
, SCOPE_RUNNING
, SCOPE_ABANDONED
, SCOPE_STOP_SIGTERM
, SCOPE_STOP_SIGKILL
))
459 scope_enter_dead(s
, SCOPE_SUCCESS
);
462 static void scope_sigchld_event(Unit
*u
, pid_t pid
, int code
, int status
) {
465 /* If we get a SIGCHLD event for one of the processes we were interested in, then we look for others to
466 * watch, under the assumption that we'll sooner or later get a SIGCHLD for them, as the original
467 * process we watched was probably the parent of them, and they are hence now our children. */
469 (void) unit_enqueue_rewatch_pids(u
);
472 static int scope_dispatch_timer(sd_event_source
*source
, usec_t usec
, void *userdata
) {
473 Scope
*s
= SCOPE(userdata
);
476 assert(s
->timer_event_source
== source
);
480 case SCOPE_STOP_SIGTERM
:
481 if (s
->kill_context
.send_sigkill
) {
482 log_unit_warning(UNIT(s
), "Stopping timed out. Killing.");
483 scope_enter_signal(s
, SCOPE_STOP_SIGKILL
, SCOPE_FAILURE_TIMEOUT
);
485 log_unit_warning(UNIT(s
), "Stopping timed out. Skipping SIGKILL.");
486 scope_enter_dead(s
, SCOPE_FAILURE_TIMEOUT
);
491 case SCOPE_STOP_SIGKILL
:
492 log_unit_warning(UNIT(s
), "Still around after SIGKILL. Ignoring.");
493 scope_enter_dead(s
, SCOPE_FAILURE_TIMEOUT
);
497 assert_not_reached("Timeout at wrong time.");
503 int scope_abandon(Scope
*s
) {
506 if (unit_has_name(UNIT(s
), SPECIAL_INIT_SCOPE
))
509 if (!IN_SET(s
->state
, SCOPE_RUNNING
, SCOPE_ABANDONED
))
512 s
->was_abandoned
= true;
514 s
->controller
= mfree(s
->controller
);
515 s
->controller_track
= sd_bus_track_unref(s
->controller_track
);
517 scope_set_state(s
, SCOPE_ABANDONED
);
519 /* The client is no longer watching the remaining processes, so let's step in here, under the assumption that
520 * the remaining processes will be sooner or later reassigned to us as parent. */
521 (void) unit_enqueue_rewatch_pids(UNIT(s
));
526 _pure_
static UnitActiveState
scope_active_state(Unit
*u
) {
529 return state_translation_table
[SCOPE(u
)->state
];
532 _pure_
static const char *scope_sub_state_to_string(Unit
*u
) {
535 return scope_state_to_string(SCOPE(u
)->state
);
538 static void scope_enumerate_perpetual(Manager
*m
) {
544 /* Let's unconditionally add the "init.scope" special unit
545 * that encapsulates PID 1. Note that PID 1 already is in the
546 * cgroup for this, we hence just need to allocate the object
547 * for it and that's it. */
549 u
= manager_get_unit(m
, SPECIAL_INIT_SCOPE
);
551 r
= unit_new_for_name(m
, sizeof(Scope
), SPECIAL_INIT_SCOPE
, &u
);
553 log_error_errno(r
, "Failed to allocate the special " SPECIAL_INIT_SCOPE
" unit: %m");
560 SCOPE(u
)->deserialized_state
= SCOPE_RUNNING
;
562 unit_add_to_load_queue(u
);
563 unit_add_to_dbus_queue(u
);
566 static const char* const scope_result_table
[_SCOPE_RESULT_MAX
] = {
567 [SCOPE_SUCCESS
] = "success",
568 [SCOPE_FAILURE_RESOURCES
] = "resources",
569 [SCOPE_FAILURE_TIMEOUT
] = "timeout",
572 DEFINE_STRING_TABLE_LOOKUP(scope_result
, ScopeResult
);
574 const UnitVTable scope_vtable
= {
575 .object_size
= sizeof(Scope
),
576 .cgroup_context_offset
= offsetof(Scope
, cgroup_context
),
577 .kill_context_offset
= offsetof(Scope
, kill_context
),
583 .private_section
= "Scope",
585 .can_transient
= true,
586 .can_delegate
= true,
593 .coldplug
= scope_coldplug
,
597 .start
= scope_start
,
602 .get_timeout
= scope_get_timeout
,
604 .serialize
= scope_serialize
,
605 .deserialize_item
= scope_deserialize_item
,
607 .active_state
= scope_active_state
,
608 .sub_state_to_string
= scope_sub_state_to_string
,
610 .sigchld_event
= scope_sigchld_event
,
612 .reset_failed
= scope_reset_failed
,
614 .notify_cgroup_empty
= scope_notify_cgroup_empty_event
,
616 .bus_vtable
= bus_scope_vtable
,
617 .bus_set_property
= bus_scope_set_property
,
618 .bus_commit_properties
= bus_scope_commit_properties
,
620 .enumerate_perpetual
= scope_enumerate_perpetual
,