1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
4 This file is part of systemd.
6 Copyright 2013 Lennart Poettering
8 systemd is free software; you can redistribute it and/or modify it
9 under the terms of the GNU Lesser General Public License as published by
10 the Free Software Foundation; either version 2.1 of the License, or
11 (at your option) any later version.
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 Lesser General Public License for more details.
18 You should have received a copy of the GNU Lesser General Public License
19 along with systemd; If not, see <http://www.gnu.org/licenses/>.
28 #include "load-fragment.h"
30 #include "dbus-scope.h"
32 #include "unit-name.h"
33 #include "load-dropin.h"
35 static const UnitActiveState state_translation_table[_SCOPE_STATE_MAX] = {
36 [SCOPE_DEAD] = UNIT_INACTIVE,
37 [SCOPE_RUNNING] = UNIT_ACTIVE,
38 [SCOPE_STOP_SIGTERM] = UNIT_DEACTIVATING,
39 [SCOPE_STOP_SIGKILL] = UNIT_DEACTIVATING,
40 [SCOPE_FAILED] = UNIT_FAILED
43 static void scope_init(Unit *u) {
47 assert(u->load_state == UNIT_STUB);
49 s->timeout_stop_usec = DEFAULT_TIMEOUT_USEC;
51 watch_init(&s->timer_watch);
53 cgroup_context_init(&s->cgroup_context);
54 kill_context_init(&s->kill_context);
56 UNIT(s)->ignore_on_isolate = true;
57 UNIT(s)->ignore_on_snapshot = true;
60 static void scope_done(Unit *u) {
65 cgroup_context_done(&s->cgroup_context);
70 unit_unwatch_timer(u, &s->timer_watch);
73 static void scope_set_state(Scope *s, ScopeState state) {
80 if (state != SCOPE_STOP_SIGTERM &&
81 state != SCOPE_STOP_SIGKILL)
82 unit_unwatch_timer(UNIT(s), &s->timer_watch);
84 if (state != old_state)
85 log_debug("%s changed %s -> %s",
87 scope_state_to_string(old_state),
88 scope_state_to_string(state));
90 unit_notify(UNIT(s), state_translation_table[old_state], state_translation_table[state], true);
93 static int scope_add_default_dependencies(Scope *s) {
98 /* Make sure scopes are unloaded on shutdown */
99 r = unit_add_two_dependencies_by_name(
101 UNIT_BEFORE, UNIT_CONFLICTS,
102 SPECIAL_SHUTDOWN_TARGET, NULL, true);
109 static int scope_verify(Scope *s) {
112 if (UNIT(s)->load_state != UNIT_LOADED)
115 if (set_size(s->pids) <= 0) {
116 log_error_unit(UNIT(s)->id, "Scope %s has no PIDs. Refusing.", UNIT(s)->id);
123 static int scope_load(Unit *u) {
128 assert(u->load_state == UNIT_STUB);
130 if (!u->transient && UNIT(s)->manager->n_reloading <= 0)
133 u->load_state = UNIT_LOADED;
135 r = unit_load_dropin(u);
139 r = unit_add_default_slice(u);
143 if (u->default_dependencies) {
144 r = scope_add_default_dependencies(s);
149 return scope_verify(s);
152 static int scope_coldplug(Unit *u) {
157 assert(s->state == SCOPE_DEAD);
159 if (s->deserialized_state != s->state) {
161 if ((s->deserialized_state == SCOPE_STOP_SIGKILL || s->deserialized_state == SCOPE_STOP_SIGTERM)
162 && s->timeout_stop_usec > 0) {
163 r = unit_watch_timer(UNIT(s), CLOCK_MONOTONIC, true, s->timeout_stop_usec, &s->timer_watch);
169 scope_set_state(s, s->deserialized_state);
175 static void scope_dump(Unit *u, FILE *f, const char *prefix) {
182 "%sScope State: %s\n"
184 prefix, scope_state_to_string(s->state),
185 prefix, scope_result_to_string(s->result));
187 cgroup_context_dump(&s->cgroup_context, f, prefix);
188 kill_context_dump(&s->kill_context, f, prefix);
191 static void scope_enter_dead(Scope *s, ScopeResult f) {
194 if (f != SCOPE_SUCCESS)
197 scope_set_state(s, s->result != SCOPE_SUCCESS ? SCOPE_FAILED : SCOPE_DEAD);
200 static void scope_enter_signal(Scope *s, ScopeState state, ScopeResult f) {
205 if (f != SCOPE_SUCCESS)
208 r = unit_kill_context(
211 state != SCOPE_STOP_SIGTERM,
217 if (s->timeout_stop_usec > 0) {
218 r = unit_watch_timer(UNIT(s), CLOCK_MONOTONIC, true, s->timeout_stop_usec, &s->timer_watch);
223 scope_set_state(s, state);
225 scope_enter_dead(s, SCOPE_SUCCESS);
230 log_warning_unit(UNIT(s)->id,
231 "%s failed to kill processes: %s", UNIT(s)->id, strerror(-r));
233 scope_enter_dead(s, SCOPE_FAILURE_RESOURCES);
236 static int scope_start(Unit *u) {
242 if (s->state == SCOPE_STOP_SIGTERM ||
243 s->state == SCOPE_STOP_SIGKILL)
246 assert(s->state == SCOPE_DEAD);
248 if (!u->transient && UNIT(s)->manager->n_reloading <= 0)
251 r = unit_realize_cgroup(u);
253 log_error("Failed to realize cgroup: %s", strerror(-r));
257 r = cg_attach_many_with_mask(u->cgroup_mask, u->cgroup_path, s->pids);
264 s->result = SCOPE_SUCCESS;
266 scope_set_state(s, SCOPE_RUNNING);
270 static int scope_stop(Unit *u) {
274 assert(s->state == SCOPE_RUNNING);
276 if (s->state == SCOPE_STOP_SIGTERM ||
277 s->state == SCOPE_STOP_SIGKILL)
280 assert(s->state == SCOPE_RUNNING);
282 scope_enter_signal(s, SCOPE_STOP_SIGTERM, SCOPE_SUCCESS);
286 static int scope_kill(Unit *u, KillWho who, int signo, DBusError *error) {
287 return unit_kill_common(u, who, signo, -1, -1, error);
290 static int scope_serialize(Unit *u, FILE *f, FDSet *fds) {
297 unit_serialize_item(u, f, "state", scope_state_to_string(s->state));
301 static int scope_deserialize_item(Unit *u, const char *key, const char *value, FDSet *fds) {
309 if (streq(key, "state")) {
312 state = scope_state_from_string(value);
314 log_debug("Failed to parse state value %s", value);
316 s->deserialized_state = state;
319 log_debug("Unknown serialization key '%s'", key);
324 static bool scope_check_gc(Unit *u) {
330 /* Never clean up scopes that still have a process around,
331 * even if the scope is formally dead. */
333 if (UNIT(s)->cgroup_path) {
334 r = cg_is_empty_recursive(SYSTEMD_CGROUP_CONTROLLER, UNIT(s)->cgroup_path, true);
342 static void scope_timer_event(Unit *u, uint64_t elapsed, Watch*w) {
346 assert(elapsed == 1);
347 assert(w == &s->timer_watch);
351 case SCOPE_STOP_SIGTERM:
352 if (s->kill_context.send_sigkill) {
353 log_warning_unit(u->id, "%s stopping timed out. Killing.", u->id);
354 scope_enter_signal(s, SCOPE_STOP_SIGKILL, SCOPE_FAILURE_TIMEOUT);
356 log_warning_unit(u->id, "%s stopping timed out. Skipping SIGKILL.", u->id);
357 scope_enter_dead(s, SCOPE_FAILURE_TIMEOUT);
362 case SCOPE_STOP_SIGKILL:
363 log_warning_unit(u->id, "%s still around after SIGKILL. Ignoring.", u->id);
364 scope_enter_dead(s, SCOPE_FAILURE_TIMEOUT);
368 assert_not_reached("Timeout at wrong time.");
372 static void scope_notify_cgroup_empty_event(Unit *u) {
376 log_debug_unit(u->id, "%s: cgroup is empty", u->id);
381 case SCOPE_STOP_SIGTERM:
382 case SCOPE_STOP_SIGKILL:
383 scope_enter_dead(s, SCOPE_SUCCESS);
392 _pure_ static UnitActiveState scope_active_state(Unit *u) {
395 return state_translation_table[SCOPE(u)->state];
398 _pure_ static const char *scope_sub_state_to_string(Unit *u) {
401 return scope_state_to_string(SCOPE(u)->state);
404 static const char* const scope_state_table[_SCOPE_STATE_MAX] = {
405 [SCOPE_DEAD] = "dead",
406 [SCOPE_RUNNING] = "active",
407 [SCOPE_STOP_SIGTERM] = "stop-sigterm",
408 [SCOPE_STOP_SIGKILL] = "stop-sigkill",
409 [SCOPE_FAILED] = "failed",
412 DEFINE_STRING_TABLE_LOOKUP(scope_state, ScopeState);
414 static const char* const scope_result_table[_SCOPE_RESULT_MAX] = {
415 [SCOPE_SUCCESS] = "success",
416 [SCOPE_FAILURE_RESOURCES] = "resources",
417 [SCOPE_FAILURE_TIMEOUT] = "timeout",
420 DEFINE_STRING_TABLE_LOOKUP(scope_result, ScopeResult);
422 const UnitVTable scope_vtable = {
423 .object_size = sizeof(Scope),
429 .private_section = "Scope",
430 .cgroup_context_offset = offsetof(Scope, cgroup_context),
433 .no_instances = true,
439 .coldplug = scope_coldplug,
443 .start = scope_start,
448 .serialize = scope_serialize,
449 .deserialize_item = scope_deserialize_item,
451 .active_state = scope_active_state,
452 .sub_state_to_string = scope_sub_state_to_string,
454 .check_gc = scope_check_gc,
456 .timer_event = scope_timer_event,
458 .notify_cgroup_empty = scope_notify_cgroup_empty_event,
460 .bus_interface = "org.freedesktop.systemd1.Scope",
461 .bus_message_handler = bus_scope_message_handler,
462 .bus_set_property = bus_scope_set_property,
463 .bus_commit_properties = bus_scope_commit_properties,
465 .can_transient = true