2 This file is part of systemd.
4 Copyright 2011 Lennart Poettering
6 systemd is free software; you can redistribute it and/or modify it
7 under the terms of the GNU Lesser General Public License as published by
8 the Free Software Foundation; either version 2.1 of the License, or
9 (at your option) any later version.
11 systemd is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Lesser General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public License
17 along with systemd; If not, see <http://www.gnu.org/licenses/>.
22 #include <sys/mount.h>
25 #include "alloc-util.h"
26 #include "bus-common-errors.h"
27 #include "bus-error.h"
29 #include "cgroup-util.h"
30 #include "clean-ipc.h"
31 #include "conf-parser.h"
35 #include "format-util.h"
39 #include "logind-user.h"
41 #include "mount-util.h"
42 #include "parse-util.h"
43 #include "path-util.h"
45 #include "smack-util.h"
46 //#include "special.h"
47 #include "stdio-util.h"
48 #include "string-table.h"
49 #include "unit-name.h"
50 #include "user-util.h"
53 #if 1 /// elogind uses a static value here
54 # define SPECIAL_USER_SLICE "user.slice"
56 int user_new(User **out, Manager *m, uid_t uid, gid_t gid, const char *name) {
57 _cleanup_(user_freep) User *u = NULL;
58 char lu[DECIMAL_STR_MAX(uid_t) + 1];
72 xsprintf(lu, UID_FMT, uid);
74 u->name = strdup(name);
78 if (asprintf(&u->state_file, "/run/systemd/users/"UID_FMT, uid) < 0)
81 if (asprintf(&u->runtime_path, "/run/user/"UID_FMT, uid) < 0)
84 r = slice_build_subslice(SPECIAL_USER_SLICE, lu, &u->slice);
88 r = unit_name_build("user", lu, ".service", &u->service);
92 r = hashmap_put(m->users, UID_TO_PTR(uid), u);
96 r = hashmap_put(m->user_units, u->slice, u);
100 r = hashmap_put(m->user_units, u->service, u);
109 User *user_free(User *u) {
114 LIST_REMOVE(gc_queue, u->manager->user_gc_queue, u);
117 session_free(u->sessions);
120 hashmap_remove_value(u->manager->user_units, u->service, u);
123 hashmap_remove_value(u->manager->user_units, u->slice, u);
125 hashmap_remove_value(u->manager->users, UID_TO_PTR(u->uid), u);
127 #if 0 /// elogind neither supports slice nor service jobs.
128 u->slice_job = mfree(u->slice_job);
129 u->service_job = mfree(u->service_job);
132 u->service = mfree(u->service);
133 u->slice = mfree(u->slice);
134 u->runtime_path = mfree(u->runtime_path);
135 u->state_file = mfree(u->state_file);
136 u->name = mfree(u->name);
141 static int user_save_internal(User *u) {
142 _cleanup_free_ char *temp_path = NULL;
143 _cleanup_fclose_ FILE *f = NULL;
147 assert(u->state_file);
149 r = mkdir_safe_label("/run/systemd/users", 0755, 0, 0);
153 r = fopen_temporary(u->state_file, &f, &temp_path);
157 fchmod(fileno(f), 0644);
160 "# This is private data. Do not parse.\n"
164 user_state_to_string(user_get_state(u)));
166 /* LEGACY: no-one reads RUNTIME= anymore, drop it at some point */
168 fprintf(f, "RUNTIME=%s\n", u->runtime_path);
170 #if 0 /// elogind neither supports service nor slice jobs
172 fprintf(f, "SERVICE_JOB=%s\n", u->service_job);
175 fprintf(f, "SLICE_JOB=%s\n", u->slice_job);
179 fprintf(f, "DISPLAY=%s\n", u->display->id);
181 if (dual_timestamp_is_set(&u->timestamp))
183 "REALTIME="USEC_FMT"\n"
184 "MONOTONIC="USEC_FMT"\n",
185 u->timestamp.realtime,
186 u->timestamp.monotonic);
192 fputs("SESSIONS=", f);
194 LIST_FOREACH(sessions_by_user, i, u->sessions) {
203 fputs("\nSEATS=", f);
205 LIST_FOREACH(sessions_by_user, i, u->sessions) {
214 fputs(i->seat->id, f);
217 fputs("\nACTIVE_SESSIONS=", f);
219 LIST_FOREACH(sessions_by_user, i, u->sessions) {
220 if (!session_is_active(i))
231 fputs("\nONLINE_SESSIONS=", f);
233 LIST_FOREACH(sessions_by_user, i, u->sessions) {
234 if (session_get_state(i) == SESSION_CLOSING)
245 fputs("\nACTIVE_SEATS=", f);
247 LIST_FOREACH(sessions_by_user, i, u->sessions) {
248 if (!session_is_active(i) || !i->seat)
256 fputs(i->seat->id, f);
259 fputs("\nONLINE_SEATS=", f);
261 LIST_FOREACH(sessions_by_user, i, u->sessions) {
262 if (session_get_state(i) == SESSION_CLOSING || !i->seat)
270 fputs(i->seat->id, f);
275 r = fflush_and_check(f);
279 if (rename(temp_path, u->state_file) < 0) {
287 (void) unlink(u->state_file);
290 (void) unlink(temp_path);
292 return log_error_errno(r, "Failed to save user data %s: %m", u->state_file);
295 int user_save(User *u) {
301 return user_save_internal (u);
304 int user_load(User *u) {
305 _cleanup_free_ char *display = NULL, *realtime = NULL, *monotonic = NULL;
311 r = parse_env_file(u->state_file, NEWLINE,
312 #if 0 /// elogind neither supports service nor slice jobs
313 "SERVICE_JOB", &u->service_job,
314 "SLICE_JOB", &u->slice_job,
317 "REALTIME", &realtime,
318 "MONOTONIC", &monotonic,
324 return log_error_errno(r, "Failed to read %s: %m", u->state_file);
328 s = hashmap_get(u->manager->sessions, display);
330 if (s && s->display && display_is_local(s->display))
334 timestamp_deserialize(realtime, &u->timestamp.realtime);
336 timestamp_deserialize(monotonic, &u->timestamp.monotonic);
341 static int user_mkdir_runtime_path(User *u) {
346 r = mkdir_safe_label("/run/user", 0755, 0, 0);
348 return log_error_errno(r, "Failed to create /run/user: %m");
350 if (path_is_mount_point(u->runtime_path, NULL, 0) <= 0) {
351 _cleanup_free_ char *t = NULL;
353 (void) mkdir_label(u->runtime_path, 0700);
356 r = asprintf(&t, "mode=0700,smackfsroot=*,uid=" UID_FMT ",gid=" GID_FMT ",size=%zu", u->uid, u->gid, u->manager->runtime_dir_size);
358 r = asprintf(&t, "mode=0700,uid=" UID_FMT ",gid=" GID_FMT ",size=%zu", u->uid, u->gid, u->manager->runtime_dir_size);
364 r = mount("tmpfs", u->runtime_path, "tmpfs", MS_NODEV|MS_NOSUID, t);
366 if (errno != EPERM && errno != EACCES) {
367 r = log_error_errno(errno, "Failed to mount per-user tmpfs directory %s: %m", u->runtime_path);
371 log_debug_errno(errno, "Failed to mount per-user tmpfs directory %s, assuming containerized execution, ignoring: %m", u->runtime_path);
373 r = chmod_and_chown(u->runtime_path, 0700, u->uid, u->gid);
375 log_error_errno(r, "Failed to change runtime directory ownership and mode: %m");
380 r = label_fix(u->runtime_path, false, false);
382 log_warning_errno(r, "Failed to fix label of '%s', ignoring: %m", u->runtime_path);
388 /* Try to clean up, but ignore errors */
389 (void) rmdir(u->runtime_path);
393 static int user_start_slice(User *u) {
394 #if 0 /// elogind can not ask systemd via dbus to start user services
395 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
396 const char *description;
402 u->slice_job = mfree(u->slice_job);
403 description = strjoina("User Slice of ", u->name);
405 r = manager_start_slice(
409 "systemd-logind.service",
410 "systemd-user-sessions.service",
411 u->manager->user_tasks_max,
416 else if (!sd_bus_error_has_name(&error, BUS_ERROR_UNIT_EXISTS))
417 /* we don't fail due to this, let's try to continue */
418 log_error_errno(r, "Failed to start user slice %s, ignoring: %s (%s)",
419 u->slice, bus_error_message(&error, r), error.name);
423 hashmap_put(u->manager->user_units, u->slice, u);
429 static int user_start_service(User *u) {
430 #if 0 /// elogind can not ask systemd via dbus to start user services
431 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
437 u->service_job = mfree(u->service_job);
439 r = manager_start_unit(
445 /* we don't fail due to this, let's try to continue */
446 log_error_errno(r, "Failed to start user service, ignoring: %s", bus_error_message(&error, r));
448 u->service_job = job;
453 hashmap_put(u->manager->user_units, u->service, u);
459 int user_start(User *u) {
464 if (u->started && !u->stopping)
468 * If u->stopping is set, the user is marked for removal and the slice
469 * and service stop-jobs are queued. We have to clear that flag before
470 * queing the start-jobs again. If they succeed, the user object can be
471 * re-used just fine (pid1 takes care of job-ordering and proper
472 * restart), but if they fail, we want to force another user_stop() so
473 * possibly pending units are stopped.
474 * Note that we don't clear u->started, as we have no clue what state
475 * the user is in on failure here. Hence, we pretend the user is
476 * running so it will be properly taken down by GC. However, we clearly
477 * return an error from user_start() in that case, so no further
478 * reference to the user is taken.
483 log_debug("New user %s logged in.", u->name);
485 /* Make XDG_RUNTIME_DIR */
486 r = user_mkdir_runtime_path(u);
492 r = user_start_slice(u);
496 /* Save the user data so far, because pam_systemd will read the
497 * XDG_RUNTIME_DIR out of it while starting up systemd --user.
498 * We need to do user_save_internal() because we have not
499 * "officially" started yet. */
500 user_save_internal(u);
502 /* Spawn user systemd */
503 r = user_start_service(u);
508 if (!dual_timestamp_is_set(&u->timestamp))
509 dual_timestamp_get(&u->timestamp);
510 user_send_signal(u, true);
514 /* Save new user data */
520 #if 0 /// UNNEEDED by elogind
521 static int user_stop_slice(User *u) {
522 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
528 r = manager_stop_unit(u->manager, u->slice, &error, &job);
530 log_error("Failed to stop user slice: %s", bus_error_message(&error, r));
540 static int user_stop_service(User *u) {
541 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
547 r = manager_stop_unit(u->manager, u->service, &error, &job);
549 log_error("Failed to stop user service: %s", bus_error_message(&error, r));
553 free(u->service_job);
554 u->service_job = job;
560 static int user_remove_runtime_path(User *u) {
565 r = rm_rf(u->runtime_path, 0);
567 log_error_errno(r, "Failed to remove runtime directory %s: %m", u->runtime_path);
569 /* Ignore cases where the directory isn't mounted, as that's
570 * quite possible, if we lacked the permissions to mount
572 r = umount2(u->runtime_path, MNT_DETACH);
573 if (r < 0 && errno != EINVAL && errno != ENOENT)
574 log_error_errno(errno, "Failed to unmount user runtime directory %s: %m", u->runtime_path);
576 r = rm_rf(u->runtime_path, REMOVE_ROOT);
578 log_error_errno(r, "Failed to remove runtime directory %s: %m", u->runtime_path);
583 int user_stop(User *u, bool force) {
588 /* Stop jobs have already been queued */
594 LIST_FOREACH(sessions_by_user, s, u->sessions) {
595 k = session_stop(s, force);
601 #if 0 /// elogind does not support service or slice jobs
602 k = user_stop_service(u);
607 k = user_stop_slice(u);
616 #if 1 /// elogind must queue this user again
617 user_add_to_gc_queue(u);
622 int user_finalize(User *u) {
629 log_debug("User %s logged out.", u->name);
631 LIST_FOREACH(sessions_by_user, s, u->sessions) {
632 k = session_finalize(s);
637 /* Kill XDG_RUNTIME_DIR */
638 k = user_remove_runtime_path(u);
642 /* Clean SysV + POSIX IPC objects, but only if this is not a system user. Background: in many setups cronjobs
643 * are run in full PAM and thus logind sessions, even if the code run doesn't belong to actual users but to
644 * system components. Since enable RemoveIPC= globally for all users, we need to be a bit careful with such
645 * cases, as we shouldn't accidentally remove a system service's IPC objects while it is running, just because
646 * a cronjob running as the same user just finished. Hence: exclude system users generally from IPC clean-up,
647 * and do it only for normal users. */
648 if (u->manager->remove_ipc && u->uid > SYSTEM_UID_MAX) {
649 k = clean_ipc_by_uid(u->uid);
654 unlink(u->state_file);
655 user_add_to_gc_queue(u);
658 user_send_signal(u, false);
665 int user_get_idle_hint(User *u, dual_timestamp *t) {
667 bool idle_hint = true;
668 dual_timestamp ts = DUAL_TIMESTAMP_NULL;
672 LIST_FOREACH(sessions_by_user, s, u->sessions) {
676 ih = session_get_idle_hint(s, &k);
682 if (k.monotonic < ts.monotonic)
688 } else if (idle_hint) {
690 if (k.monotonic > ts.monotonic)
701 int user_check_linger_file(User *u) {
702 _cleanup_free_ char *cc = NULL;
705 cc = cescape(u->name);
709 p = strjoina("/var/lib/systemd/linger/", cc);
711 return access(p, F_OK) >= 0;
714 bool user_check_gc(User *u, bool drop_not_started) {
717 if (drop_not_started && !u->started)
723 if (user_check_linger_file(u) > 0)
726 #if 0 /// elogind neither supports service nor slice jobs
727 if (u->slice_job && manager_job_is_active(u->manager, u->slice_job))
730 if (u->service_job && manager_job_is_active(u->manager, u->service_job))
737 void user_add_to_gc_queue(User *u) {
743 LIST_PREPEND(gc_queue, u->manager->user_gc_queue, u);
744 u->in_gc_queue = true;
747 UserState user_get_state(User *u) {
755 #if 0 /// elogind neither supports service nor slice jobs.
756 if (!u->started || u->slice_job || u->service_job)
763 bool all_closing = true;
765 LIST_FOREACH(sessions_by_user, i, u->sessions) {
768 state = session_get_state(i);
769 if (state == SESSION_ACTIVE)
771 if (state != SESSION_CLOSING)
775 return all_closing ? USER_CLOSING : USER_ONLINE;
778 if (user_check_linger_file(u) > 0)
779 return USER_LINGERING;
784 int user_kill(User *u, int signo) {
785 #if 0 /// Without systemd unit support, elogind has to rely on its session system
788 return manager_kill_unit(u->manager, u->slice, KILL_ALL, signo, NULL);
795 LIST_FOREACH(sessions_by_user, s, u->sessions) {
796 int r = session_kill(s, KILL_ALL, signo);
797 if (res == 0 && r < 0)
805 static bool elect_display_filter(Session *s) {
806 /* Return true if the session is a candidate for the user’s ‘primary
807 * session’ or ‘display’. */
810 return (s->class == SESSION_USER && !s->stopping);
813 static int elect_display_compare(Session *s1, Session *s2) {
814 /* Indexed by SessionType. Lower numbers mean more preferred. */
815 const int type_ranks[_SESSION_TYPE_MAX] = {
816 [SESSION_UNSPECIFIED] = 0,
819 [SESSION_WAYLAND] = -3,
824 /* Calculate the partial order relationship between s1 and s2,
825 * returning < 0 if s1 is preferred as the user’s ‘primary session’,
826 * 0 if s1 and s2 are equally preferred or incomparable, or > 0 if s2
829 * s1 or s2 may be NULL. */
833 if ((s1 == NULL) != (s2 == NULL))
834 return (s1 == NULL) - (s2 == NULL);
836 if (s1->stopping != s2->stopping)
837 return s1->stopping - s2->stopping;
839 if ((s1->class != SESSION_USER) != (s2->class != SESSION_USER))
840 return (s1->class != SESSION_USER) - (s2->class != SESSION_USER);
842 if ((s1->type == _SESSION_TYPE_INVALID) != (s2->type == _SESSION_TYPE_INVALID))
843 return (s1->type == _SESSION_TYPE_INVALID) - (s2->type == _SESSION_TYPE_INVALID);
845 if (s1->type != s2->type)
846 return type_ranks[s1->type] - type_ranks[s2->type];
851 void user_elect_display(User *u) {
856 /* This elects a primary session for each user, which we call
857 * the "display". We try to keep the assignment stable, but we
858 * "upgrade" to better choices. */
859 log_debug("Electing new display for user %s", u->name);
861 LIST_FOREACH(sessions_by_user, s, u->sessions) {
862 if (!elect_display_filter(s)) {
863 log_debug("Ignoring session %s", s->id);
867 if (elect_display_compare(s, u->display) < 0) {
868 log_debug("Choosing session %s in preference to %s", s->id, u->display ? u->display->id : "-");
874 static const char* const user_state_table[_USER_STATE_MAX] = {
875 [USER_OFFLINE] = "offline",
876 [USER_OPENING] = "opening",
877 [USER_LINGERING] = "lingering",
878 [USER_ONLINE] = "online",
879 [USER_ACTIVE] = "active",
880 [USER_CLOSING] = "closing"
883 DEFINE_STRING_TABLE_LOOKUP(user_state, UserState);
885 int config_parse_tmpfs_size(
887 const char *filename,
890 unsigned section_line,
905 /* First, try to parse as percentage */
906 r = parse_percent(rvalue);
907 if (r > 0 && r < 100)
908 *sz = physical_memory_scale(r, 100U);
912 /* If the passed argument was not a percentage, or out of range, parse as byte size */
914 r = parse_size(rvalue, 1024, &k);
915 if (r < 0 || k <= 0 || (uint64_t) (size_t) k != k) {
916 log_syntax(unit, LOG_ERR, filename, line, r, "Failed to parse size value, ignoring: %s", rvalue);
920 *sz = PAGE_ALIGN((size_t) k);
926 int config_parse_user_tasks_max(
928 const char *filename,
931 unsigned section_line,
947 if (isempty(rvalue)) {
948 *m = system_tasks_max_scale(DEFAULT_USER_TASKS_MAX_PERCENTAGE, 100U);
952 if (streq(rvalue, "infinity")) {
953 *m = CGROUP_LIMIT_MAX;
957 /* Try to parse as percentage */
958 r = parse_percent(rvalue);
960 k = system_tasks_max_scale(r, 100U);
963 /* If the passed argument was not a percentage, or out of range, parse as byte size */
965 r = safe_atou64(rvalue, &k);
967 log_syntax(unit, LOG_ERR, filename, line, r, "Failed to parse tasks maximum, ignoring: %s", rvalue);
972 if (k <= 0 || k >= UINT64_MAX) {
973 log_syntax(unit, LOG_ERR, filename, line, 0, "Tasks maximum out of range, ignoring: %s", rvalue);