1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
4 This file is part of systemd.
6 Copyright 2010 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/>.
29 #include <sys/types.h>
32 #include "cgroup-util.h"
37 #include "path-util.h"
39 #include "unit-name.h"
42 int cg_enumerate_processes(const char *controller, const char *path, FILE **_f) {
43 _cleanup_free_ char *fs = NULL;
49 r = cg_get_path(controller, path, "cgroup.procs", &fs);
61 int cg_enumerate_tasks(const char *controller, const char *path, FILE **_f) {
62 _cleanup_free_ char *fs = NULL;
68 r = cg_get_path(controller, path, "tasks", &fs);
80 int cg_read_pid(FILE *f, pid_t *_pid) {
83 /* Note that the cgroup.procs might contain duplicates! See
84 * cgroups.txt for details. */
90 if (fscanf(f, "%lu", &ul) != 1) {
95 return errno ? -errno : -EIO;
105 int cg_enumerate_subgroups(const char *controller, const char *path, DIR **_d) {
106 _cleanup_free_ char *fs = NULL;
112 /* This is not recursive! */
114 r = cg_get_path(controller, path, NULL, &fs);
126 int cg_read_subgroup(DIR *d, char **fn) {
132 FOREACH_DIRENT(de, d, return -errno) {
135 if (de->d_type != DT_DIR)
138 if (streq(de->d_name, ".") ||
139 streq(de->d_name, ".."))
142 b = strdup(de->d_name);
153 int cg_rmdir(const char *controller, const char *path, bool honour_sticky) {
154 _cleanup_free_ char *p = NULL;
157 r = cg_get_path(controller, path, NULL, &p);
164 /* If the sticky bit is set don't remove the directory */
166 tasks = strappend(p, "/tasks");
170 r = file_is_priv_sticky(tasks);
178 if (r < 0 && errno != ENOENT)
184 int cg_kill(const char *controller, const char *path, int sig, bool sigcont, bool ignore_self, Set *s) {
185 _cleanup_set_free_ Set *allocated_set = NULL;
192 /* This goes through the tasks list and kills them all. This
193 * is repeated until no further processes are added to the
194 * tasks list, to properly handle forking processes */
197 s = allocated_set = set_new(trivial_hash_func, trivial_compare_func);
205 _cleanup_fclose_ FILE *f = NULL;
209 r = cg_enumerate_processes(controller, path, &f);
211 if (ret >= 0 && r != -ENOENT)
217 while ((r = cg_read_pid(f, &pid)) > 0) {
219 if (ignore_self && pid == my_pid)
222 if (set_get(s, LONG_TO_PTR(pid)) == LONG_TO_PTR(pid))
225 /* If we haven't killed this process yet, kill
227 if (kill(pid, sig) < 0) {
228 if (ret >= 0 && errno != ESRCH)
230 } else if (ret == 0) {
240 r = set_put(s, LONG_TO_PTR(pid));
256 /* To avoid racing against processes which fork
257 * quicker than we can kill them we repeat this until
258 * no new pids need to be killed. */
265 int cg_kill_recursive(const char *controller, const char *path, int sig, bool sigcont, bool ignore_self, bool rem, Set *s) {
266 _cleanup_set_free_ Set *allocated_set = NULL;
267 _cleanup_closedir_ DIR *d = NULL;
275 s = allocated_set = set_new(trivial_hash_func, trivial_compare_func);
280 ret = cg_kill(controller, path, sig, sigcont, ignore_self, s);
282 r = cg_enumerate_subgroups(controller, path, &d);
284 if (ret >= 0 && r != -ENOENT)
290 while ((r = cg_read_subgroup(d, &fn)) > 0) {
291 _cleanup_free_ char *p = NULL;
293 p = strjoin(path, "/", fn, NULL);
298 r = cg_kill_recursive(controller, p, sig, sigcont, ignore_self, rem, s);
299 if (ret >= 0 && r != 0)
303 if (ret >= 0 && r < 0)
307 r = cg_rmdir(controller, path, true);
308 if (r < 0 && ret >= 0 && r != -ENOENT && r != -EBUSY)
315 int cg_kill_recursive_and_wait(const char *controller, const char *path, bool rem) {
320 /* This safely kills all processes; first it sends a SIGTERM,
321 * then checks 8 times after 200ms whether the group is now
322 * empty, then kills everything that is left with SIGKILL and
323 * finally checks 5 times after 200ms each whether the group
324 * is finally empty. */
326 for (i = 0; i < 15; i++) {
336 r = cg_kill_recursive(controller, path, sig, true, true, rem, NULL);
340 usleep(200 * USEC_PER_MSEC);
346 int cg_migrate(const char *cfrom, const char *pfrom, const char *cto, const char *pto, bool ignore_self) {
348 _cleanup_set_free_ Set *s = NULL;
357 s = set_new(trivial_hash_func, trivial_compare_func);
364 _cleanup_fclose_ FILE *f = NULL;
368 r = cg_enumerate_tasks(cfrom, pfrom, &f);
370 if (ret >= 0 && r != -ENOENT)
376 while ((r = cg_read_pid(f, &pid)) > 0) {
378 /* This might do weird stuff if we aren't a
379 * single-threaded program. However, we
380 * luckily know we are not */
381 if (ignore_self && pid == my_pid)
384 if (set_get(s, LONG_TO_PTR(pid)) == LONG_TO_PTR(pid))
387 r = cg_attach(cto, pto, pid);
389 if (ret >= 0 && r != -ESRCH)
396 r = set_put(s, LONG_TO_PTR(pid));
416 int cg_migrate_recursive(const char *cfrom, const char *pfrom, const char *cto, const char *pto, bool ignore_self, bool rem) {
417 _cleanup_closedir_ DIR *d = NULL;
426 ret = cg_migrate(cfrom, pfrom, cto, pto, ignore_self);
428 r = cg_enumerate_subgroups(cfrom, pfrom, &d);
430 if (ret >= 0 && r != -ENOENT)
436 while ((r = cg_read_subgroup(d, &fn)) > 0) {
437 _cleanup_free_ char *p = NULL;
439 p = strjoin(pfrom, "/", fn, NULL);
448 r = cg_migrate_recursive(cfrom, p, cto, pto, ignore_self, rem);
449 if (r != 0 && ret >= 0)
453 if (r < 0 && ret >= 0)
457 r = cg_rmdir(cfrom, pfrom, true);
458 if (r < 0 && ret >= 0 && r != -ENOENT && r != -EBUSY)
465 static const char *normalize_controller(const char *controller) {
469 if (streq(controller, SYSTEMD_CGROUP_CONTROLLER))
471 else if (startswith(controller, "name="))
472 return controller + 5;
477 static int join_path(const char *controller, const char *path, const char *suffix, char **fs) {
482 t = strjoin("/sys/fs/cgroup/", controller, "/", path, "/", suffix, NULL);
484 t = strjoin("/sys/fs/cgroup/", controller, "/", path, NULL);
486 t = strjoin("/sys/fs/cgroup/", controller, "/", suffix, NULL);
488 t = strappend("/sys/fs/cgroup/", controller);
491 t = strjoin(path, "/", suffix, NULL);
501 path_kill_slashes(t);
507 int cg_get_path(const char *controller, const char *path, const char *suffix, char **fs) {
509 static __thread bool good = false;
513 if (controller && !cg_controller_is_valid(controller, true))
516 if (_unlikely_(!good)) {
519 r = path_is_mount_point("/sys/fs/cgroup", false);
521 return r < 0 ? r : -ENOENT;
523 /* Cache this to save a few stat()s */
527 p = controller ? normalize_controller(controller) : NULL;
529 return join_path(p, path, suffix, fs);
532 static int check_hierarchy(const char *p) {
537 /* Check if this controller actually really exists */
538 cc = alloca(sizeof("/sys/fs/cgroup/") + strlen(p));
539 strcpy(stpcpy(cc, "/sys/fs/cgroup/"), p);
540 if (access(cc, F_OK) < 0)
546 int cg_get_path_and_check(const char *controller, const char *path, const char *suffix, char **fs) {
552 if (!cg_controller_is_valid(controller, true))
555 /* Normalize the controller syntax */
556 p = normalize_controller(controller);
558 /* Check if this controller actually really exists */
559 r = check_hierarchy(p);
563 return join_path(p, path, suffix, fs);
566 static int trim_cb(const char *path, const struct stat *sb, int typeflag, struct FTW *ftwbuf) {
570 if (typeflag != FTW_DP)
573 if (ftwbuf->level < 1)
576 p = strappend(path, "/tasks");
582 is_sticky = file_is_priv_sticky(p) > 0;
592 int cg_trim(const char *controller, const char *path, bool delete_root) {
593 _cleanup_free_ char *fs = NULL;
598 r = cg_get_path(controller, path, NULL, &fs);
603 if (nftw(fs, trim_cb, 64, FTW_DEPTH|FTW_MOUNT|FTW_PHYS) != 0)
604 r = errno ? -errno : -EIO;
610 p = strappend(fs, "/tasks");
614 is_sticky = file_is_priv_sticky(p) > 0;
618 if (rmdir(fs) < 0 && errno != ENOENT && r == 0)
625 int cg_delete(const char *controller, const char *path) {
626 _cleanup_free_ char *parent = NULL;
631 r = path_get_parent(path, &parent);
635 r = cg_migrate_recursive(controller, path, controller, parent, false, true);
636 return r == -ENOENT ? 0 : r;
639 int cg_attach(const char *controller, const char *path, pid_t pid) {
640 _cleanup_free_ char *fs = NULL;
641 char c[DECIMAL_STR_MAX(pid_t) + 2];
647 r = cg_get_path_and_check(controller, path, "tasks", &fs);
654 snprintf(c, sizeof(c), "%lu\n", (unsigned long) pid);
656 return write_string_file(fs, c);
659 int cg_set_group_access(
660 const char *controller,
666 _cleanup_free_ char *fs = NULL;
671 if (mode != (mode_t) -1)
674 r = cg_get_path(controller, path, NULL, &fs);
678 return chmod_and_chown(fs, mode, uid, gid);
681 int cg_set_task_access(
682 const char *controller,
689 _cleanup_free_ char *fs = NULL, *procs = NULL;
694 if (mode == (mode_t) -1 && uid == (uid_t) -1 && gid == (gid_t) -1 && sticky < 0)
697 if (mode != (mode_t) -1)
700 r = cg_get_path(controller, path, "tasks", &fs);
704 if (sticky >= 0 && mode != (mode_t) -1)
705 /* Both mode and sticky param are passed */
706 mode |= (sticky ? S_ISVTX : 0);
707 else if ((sticky >= 0 && mode == (mode_t) -1) ||
708 (mode != (mode_t) -1 && sticky < 0)) {
711 /* Only one param is passed, hence read the current
712 * mode from the file itself */
718 if (mode == (mode_t) -1)
719 /* No mode set, we just shall set the sticky bit */
720 mode = (st.st_mode & ~S_ISVTX) | (sticky ? S_ISVTX : 0);
722 /* Only mode set, leave sticky bit untouched */
723 mode = (st.st_mode & ~0777) | mode;
726 r = chmod_and_chown(fs, mode, uid, gid);
730 /* Always keep values for "cgroup.procs" in sync with "tasks" */
731 r = cg_get_path(controller, path, "cgroup.procs", &procs);
735 return chmod_and_chown(procs, mode, uid, gid);
738 int cg_pid_get_path(const char *controller, pid_t pid, char **path) {
739 char fs[sizeof("/proc/") - 1 + DECIMAL_STR_MAX(pid_t) + sizeof("/cgroup")];
740 _cleanup_fclose_ FILE *f = NULL;
747 if (controller && !cg_controller_is_valid(controller, true))
751 controller = SYSTEMD_CGROUP_CONTROLLER;
756 sprintf(fs, "/proc/%lu/cgroup", (unsigned long) pid);
759 return errno == ENOENT ? -ESRCH : -errno;
761 cs = strlen(controller);
763 FOREACH_LINE(line, f, return -errno) {
768 l = strchr(line, ':');
773 if (!strneq(l, controller, cs))
779 p = strdup(l + cs + 1);
790 int cg_install_release_agent(const char *controller, const char *agent) {
791 _cleanup_free_ char *fs = NULL, *contents = NULL;
797 r = cg_get_path(controller, NULL, "release_agent", &fs);
801 r = read_one_line_file(fs, &contents);
805 sc = strstrip(contents);
807 r = write_string_file(fs, agent);
810 } else if (!streq(sc, agent))
815 r = cg_get_path(controller, NULL, "notify_on_release", &fs);
821 r = read_one_line_file(fs, &contents);
825 sc = strstrip(contents);
826 if (streq(sc, "0")) {
827 r = write_string_file(fs, "1");
840 int cg_is_empty(const char *controller, const char *path, bool ignore_self) {
841 _cleanup_fclose_ FILE *f = NULL;
842 pid_t pid = 0, self_pid;
848 r = cg_enumerate_tasks(controller, path, &f);
850 return r == -ENOENT ? 1 : r;
854 while ((r = cg_read_pid(f, &pid)) > 0) {
856 if (ignore_self && pid == self_pid)
869 int cg_is_empty_by_spec(const char *spec, bool ignore_self) {
870 _cleanup_free_ char *controller = NULL, *path = NULL;
875 r = cg_split_spec(spec, &controller, &path);
879 return cg_is_empty(controller, path, ignore_self);
882 int cg_is_empty_recursive(const char *controller, const char *path, bool ignore_self) {
883 _cleanup_closedir_ DIR *d = NULL;
889 r = cg_is_empty(controller, path, ignore_self);
893 r = cg_enumerate_subgroups(controller, path, &d);
895 return r == -ENOENT ? 1 : r;
897 while ((r = cg_read_subgroup(d, &fn)) > 0) {
898 _cleanup_free_ char *p = NULL;
900 p = strjoin(path, "/", fn, NULL);
905 r = cg_is_empty_recursive(controller, p, ignore_self);
916 int cg_split_spec(const char *spec, char **controller, char **path) {
918 char *t = NULL, *u = NULL;
923 if (!path_is_safe(spec))
940 e = strchr(spec, ':');
942 if (!cg_controller_is_valid(spec, true))
959 t = strndup(spec, e-spec);
962 if (!cg_controller_is_valid(t, true)) {
972 if (!path_is_safe(u)) {
991 int cg_join_spec(const char *controller, const char *path, char **spec) {
998 controller = "systemd";
1000 if (!cg_controller_is_valid(controller, true))
1003 controller = normalize_controller(controller);
1006 if (!path_is_absolute(path))
1009 s = strjoin(controller, ":", path, NULL);
1017 int cg_mangle_path(const char *path, char **result) {
1018 _cleanup_free_ char *c = NULL, *p = NULL;
1025 /* First check if it already is a filesystem path */
1026 if (path_startswith(path, "/sys/fs/cgroup")) {
1036 /* Otherwise treat it as cg spec */
1037 r = cg_split_spec(path, &c, &p);
1041 return cg_get_path(c ? c : SYSTEMD_CGROUP_CONTROLLER, p ? p : "/", NULL, result);
1044 int cg_get_system_path(char **path) {
1050 r = cg_pid_get_path(SYSTEMD_CGROUP_CONTROLLER, 1, &p);
1052 p = strdup("/system");
1057 if (endswith(p, "/system"))
1062 q = strappend(p, "/system");
1073 int cg_get_root_path(char **path) {
1079 r = cg_pid_get_path(SYSTEMD_CGROUP_CONTROLLER, 1, &root);
1083 e = endswith(root, "/system");
1093 int cg_get_user_path(char **path) {
1094 _cleanup_free_ char *root = NULL;
1099 /* Figure out the place to put user cgroups below. We use the
1100 * same as PID 1 has but with the "/system" suffix replaced by
1103 if (cg_get_root_path(&root) < 0 || streq(root, "/"))
1104 p = strdup("/user");
1106 p = strappend(root, "/user");
1115 int cg_get_machine_path(char **path) {
1116 _cleanup_free_ char *root = NULL;
1121 if (cg_get_root_path(&root) < 0 || streq(root, "/"))
1122 p = strdup("/machine");
1124 p = strappend(root, "/machine");
1133 char **cg_shorten_controllers(char **controllers) {
1139 for (f = controllers, t = controllers; *f; f++) {
1143 p = normalize_controller(*f);
1145 if (streq(p, "systemd")) {
1150 if (!cg_controller_is_valid(p, true)) {
1151 log_warning("Controller %s is not valid, removing from controllers list.", p);
1156 r = check_hierarchy(p);
1158 log_debug("Controller %s is not available, removing from controllers list.", p);
1167 return strv_uniq(controllers);
1170 int cg_pid_get_path_shifted(pid_t pid, char **root, char **cgroup) {
1171 _cleanup_free_ char *cg_root = NULL;
1172 char *cg_process, *p;
1175 r = cg_get_root_path(&cg_root);
1179 r = cg_pid_get_path(SYSTEMD_CGROUP_CONTROLLER, pid, &cg_process);
1183 p = path_startswith(cg_process, cg_root);
1202 cg_process[p-cg_process] = 0;
1210 int cg_path_decode_unit(const char *cgroup, char **unit){
1211 _cleanup_free_ char *unescaped = NULL;
1212 char *p, *e, *c, *s, *k;
1217 e = strchrnul(cgroup, '/');
1218 c = strndupa(cgroup, e - cgroup);
1221 /* Could this be a valid unit name? */
1222 if (!unit_name_is_valid(c, true))
1225 if (!unit_name_is_template(c))
1231 e += strspn(e, "/");
1233 p = strchrnul(e, '/');
1234 k = strndupa(e, p - e);
1237 if (!unit_name_is_valid(k, false))
1250 int cg_path_get_unit(const char *path, char **unit) {
1256 e = path_startswith(path, "/system/");
1260 return cg_path_decode_unit(e, unit);
1263 int cg_pid_get_unit(pid_t pid, char **unit) {
1264 _cleanup_free_ char *cgroup = NULL;
1269 r = cg_pid_get_path_shifted(pid, NULL, &cgroup);
1273 return cg_path_get_unit(cgroup, unit);
1276 static const char *skip_label(const char *e) {
1283 e += strspn(e, "/");
1287 int cg_path_get_user_unit(const char *path, char **unit) {
1293 /* We always have to parse the path from the beginning as unit
1294 * cgroups might have arbitrary child cgroups and we shouldn't get
1295 * confused by those */
1297 e = path_startswith(path, "/user/");
1301 /* Skip the user name */
1306 /* Skip the session ID */
1311 /* Skip the systemd cgroup */
1316 return cg_path_decode_unit(e, unit);
1319 int cg_pid_get_user_unit(pid_t pid, char **unit) {
1320 _cleanup_free_ char *cgroup = NULL;
1325 r = cg_pid_get_path_shifted(pid, NULL, &cgroup);
1329 return cg_path_get_user_unit(cgroup, unit);
1332 int cg_path_get_machine_name(const char *path, char **machine) {
1339 e = path_startswith(path, "/machine/");
1343 n = strchrnul(e, '/');
1347 s = strndupa(e, n - e);
1349 r = strdup(cg_unescape(s));
1357 int cg_pid_get_machine_name(pid_t pid, char **machine) {
1358 _cleanup_free_ char *cgroup = NULL;
1363 r = cg_pid_get_path_shifted(pid, NULL, &cgroup);
1367 return cg_path_get_machine_name(cgroup, machine);
1370 int cg_path_get_session(const char *path, char **session) {
1377 e = path_startswith(path, "/user/");
1381 /* Skip the user name */
1386 n = strchrnul(e, '/');
1389 if (memcmp(n - 8, ".session", 8) != 0)
1392 s = strndup(e, n - e - 8);
1400 int cg_pid_get_session(pid_t pid, char **session) {
1401 _cleanup_free_ char *cgroup = NULL;
1406 r = cg_pid_get_path_shifted(pid, NULL, &cgroup);
1410 return cg_path_get_session(cgroup, session);
1413 int cg_path_get_owner_uid(const char *path, uid_t *uid) {
1420 e = path_startswith(path, "/user/");
1424 n = strchrnul(e, '/');
1427 if (memcmp(n - 5, ".user", 5) != 0)
1430 s = strndupa(e, n - e - 5);
1434 return parse_uid(s, uid);
1437 int cg_pid_get_owner_uid(pid_t pid, uid_t *uid) {
1438 _cleanup_free_ char *cgroup = NULL;
1443 r = cg_pid_get_path_shifted(pid, NULL, &cgroup);
1447 return cg_path_get_owner_uid(cgroup, uid);
1450 int cg_controller_from_attr(const char *attr, char **controller) {
1457 if (!filename_is_safe(attr))
1460 dot = strchr(attr, '.');
1466 c = strndup(attr, dot - attr);
1470 if (!cg_controller_is_valid(c, false)) {
1479 char *cg_escape(const char *p) {
1480 bool need_prefix = false;
1482 /* This implements very minimal escaping for names to be used
1483 * as file names in the cgroup tree: any name which might
1484 * conflict with a kernel name or is prefixed with '_' is
1485 * prefixed with a '_'. That way, when reading cgroup names it
1486 * is sufficient to remove a single prefixing underscore if
1489 /* The return value of this function (unlike cg_unescape())
1492 if (p[0] == '_' || streq(p, "notify_on_release") || streq(p, "release_agent") || streq(p, "tasks"))
1497 dot = strrchr(p, '.');
1500 if (dot - p == 6 && memcmp(p, "cgroup", 6) == 0)
1505 n = strndupa(p, dot - p);
1507 if (check_hierarchy(n) >= 0)
1514 return strappend("_", p);
1519 char *cg_unescape(const char *p) {
1522 /* The return value of this function (unlike cg_escape())
1523 * doesn't need free()! */
1531 #define CONTROLLER_VALID \
1533 "abcdefghijklmnopqrstuvwxyz" \
1534 "ABCDEFGHIJKLMNOPQRSTUVWXYZ" \
1537 bool cg_controller_is_valid(const char *p, bool allow_named) {
1544 s = startswith(p, "name=");
1549 if (*p == 0 || *p == '_')
1552 for (t = p; *t; t++)
1553 if (!strchr(CONTROLLER_VALID, *t))
1556 if (t - p > FILENAME_MAX)