1 /* SPDX-License-Identifier: LGPL-2.1+ */
3 This file is part of systemd.
5 Copyright 2011 Lennart Poettering
10 #include <sys/mount.h>
12 #include <stdio_ext.h>
14 #include "alloc-util.h"
15 #include "bus-common-errors.h"
16 #include "bus-error.h"
18 #include "cgroup-util.h"
19 #include "clean-ipc.h"
20 #include "conf-parser.h"
24 #include "format-util.h"
28 #include "logind-user.h"
30 #include "mount-util.h"
31 #include "parse-util.h"
32 #include "path-util.h"
34 #include "smack-util.h"
36 #include "stdio-util.h"
37 #include "string-table.h"
38 #include "unit-name.h"
39 #include "user-util.h"
42 int user_new(User **out, Manager *m, uid_t uid, gid_t gid, const char *name) {
43 _cleanup_(user_freep) User *u = NULL;
44 char lu[DECIMAL_STR_MAX(uid_t) + 1];
58 xsprintf(lu, UID_FMT, uid);
60 u->name = strdup(name);
64 if (asprintf(&u->state_file, "/run/systemd/users/"UID_FMT, uid) < 0)
67 if (asprintf(&u->runtime_path, "/run/user/"UID_FMT, uid) < 0)
70 r = slice_build_subslice(SPECIAL_USER_SLICE, lu, &u->slice);
74 r = unit_name_build("user", lu, ".service", &u->service);
78 r = hashmap_put(m->users, UID_TO_PTR(uid), u);
82 r = hashmap_put(m->user_units, u->slice, u);
86 r = hashmap_put(m->user_units, u->service, u);
95 User *user_free(User *u) {
100 LIST_REMOVE(gc_queue, u->manager->user_gc_queue, u);
103 session_free(u->sessions);
106 hashmap_remove_value(u->manager->user_units, u->service, u);
109 hashmap_remove_value(u->manager->user_units, u->slice, u);
111 hashmap_remove_value(u->manager->users, UID_TO_PTR(u->uid), u);
113 #if 0 /// elogind neither supports slice nor service jobs.
114 u->slice_job = mfree(u->slice_job);
115 u->service_job = mfree(u->service_job);
118 u->service = mfree(u->service);
119 u->slice = mfree(u->slice);
120 u->runtime_path = mfree(u->runtime_path);
121 u->state_file = mfree(u->state_file);
122 u->name = mfree(u->name);
127 static int user_save_internal(User *u) {
128 _cleanup_free_ char *temp_path = NULL;
129 _cleanup_fclose_ FILE *f = NULL;
133 assert(u->state_file);
135 r = mkdir_safe_label("/run/systemd/users", 0755, 0, 0, MKDIR_WARN_MODE);
139 r = fopen_temporary(u->state_file, &f, &temp_path);
143 (void) __fsetlocking(f, FSETLOCKING_BYCALLER);
144 (void) fchmod(fileno(f), 0644);
147 "# This is private data. Do not parse.\n"
151 user_state_to_string(user_get_state(u)));
153 /* LEGACY: no-one reads RUNTIME= anymore, drop it at some point */
155 fprintf(f, "RUNTIME=%s\n", u->runtime_path);
157 #if 0 /// elogind neither supports service nor slice jobs
159 fprintf(f, "SERVICE_JOB=%s\n", u->service_job);
162 fprintf(f, "SLICE_JOB=%s\n", u->slice_job);
166 fprintf(f, "DISPLAY=%s\n", u->display->id);
168 if (dual_timestamp_is_set(&u->timestamp))
170 "REALTIME="USEC_FMT"\n"
171 "MONOTONIC="USEC_FMT"\n",
172 u->timestamp.realtime,
173 u->timestamp.monotonic);
179 fputs("SESSIONS=", f);
181 LIST_FOREACH(sessions_by_user, i, u->sessions) {
190 fputs("\nSEATS=", f);
192 LIST_FOREACH(sessions_by_user, i, u->sessions) {
201 fputs(i->seat->id, f);
204 fputs("\nACTIVE_SESSIONS=", f);
206 LIST_FOREACH(sessions_by_user, i, u->sessions) {
207 if (!session_is_active(i))
218 fputs("\nONLINE_SESSIONS=", f);
220 LIST_FOREACH(sessions_by_user, i, u->sessions) {
221 if (session_get_state(i) == SESSION_CLOSING)
232 fputs("\nACTIVE_SEATS=", f);
234 LIST_FOREACH(sessions_by_user, i, u->sessions) {
235 if (!session_is_active(i) || !i->seat)
243 fputs(i->seat->id, f);
246 fputs("\nONLINE_SEATS=", f);
248 LIST_FOREACH(sessions_by_user, i, u->sessions) {
249 if (session_get_state(i) == SESSION_CLOSING || !i->seat)
257 fputs(i->seat->id, f);
262 r = fflush_and_check(f);
266 if (rename(temp_path, u->state_file) < 0) {
274 (void) unlink(u->state_file);
277 (void) unlink(temp_path);
279 return log_error_errno(r, "Failed to save user data %s: %m", u->state_file);
282 int user_save(User *u) {
288 return user_save_internal (u);
291 int user_load(User *u) {
292 _cleanup_free_ char *display = NULL, *realtime = NULL, *monotonic = NULL;
298 r = parse_env_file(u->state_file, NEWLINE,
299 #if 0 /// elogind neither supports service nor slice jobs
300 "SERVICE_JOB", &u->service_job,
301 "SLICE_JOB", &u->slice_job,
304 "REALTIME", &realtime,
305 "MONOTONIC", &monotonic,
311 return log_error_errno(r, "Failed to read %s: %m", u->state_file);
315 s = hashmap_get(u->manager->sessions, display);
317 if (s && s->display && display_is_local(s->display))
321 timestamp_deserialize(realtime, &u->timestamp.realtime);
323 timestamp_deserialize(monotonic, &u->timestamp.monotonic);
328 static int user_mkdir_runtime_path(User *u) {
333 r = mkdir_safe_label("/run/user", 0755, 0, 0, MKDIR_WARN_MODE);
335 return log_error_errno(r, "Failed to create /run/user: %m");
337 if (path_is_mount_point(u->runtime_path, NULL, 0) <= 0) {
338 _cleanup_free_ char *t = NULL;
340 r = asprintf(&t, "mode=0700,uid=" UID_FMT ",gid=" GID_FMT ",size=%zu%s",
341 u->uid, u->gid, u->manager->runtime_dir_size,
342 mac_smack_use() ? ",smackfsroot=*" : "");
346 (void) mkdir_label(u->runtime_path, 0700);
348 r = mount("tmpfs", u->runtime_path, "tmpfs", MS_NODEV|MS_NOSUID, t);
350 if (!IN_SET(errno, EPERM, EACCES)) {
351 r = log_error_errno(errno, "Failed to mount per-user tmpfs directory %s: %m", u->runtime_path);
355 log_debug_errno(errno, "Failed to mount per-user tmpfs directory %s, assuming containerized execution, ignoring: %m", u->runtime_path);
357 r = chmod_and_chown(u->runtime_path, 0700, u->uid, u->gid);
359 log_error_errno(r, "Failed to change runtime directory ownership and mode: %m");
364 r = label_fix(u->runtime_path, 0);
366 log_warning_errno(r, "Failed to fix label of '%s', ignoring: %m", u->runtime_path);
372 /* Try to clean up, but ignore errors */
373 (void) rmdir(u->runtime_path);
377 static int user_start_slice(User *u) {
378 #if 0 /// elogind can not ask systemd via dbus to start user services
379 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
380 const char *description;
386 u->slice_job = mfree(u->slice_job);
387 description = strjoina("User Slice of ", u->name);
389 r = manager_start_slice(
393 "systemd-logind.service",
394 "systemd-user-sessions.service",
395 u->manager->user_tasks_max,
400 else if (!sd_bus_error_has_name(&error, BUS_ERROR_UNIT_EXISTS))
401 /* we don't fail due to this, let's try to continue */
402 log_error_errno(r, "Failed to start user slice %s, ignoring: %s (%s)",
403 u->slice, bus_error_message(&error, r), error.name);
407 hashmap_put(u->manager->user_units, u->slice, u);
413 static int user_start_service(User *u) {
414 #if 0 /// elogind can not ask systemd via dbus to start user services
415 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
421 u->service_job = mfree(u->service_job);
423 r = manager_start_unit(
429 /* we don't fail due to this, let's try to continue */
430 log_error_errno(r, "Failed to start user service, ignoring: %s", bus_error_message(&error, r));
432 u->service_job = job;
436 hashmap_put(u->manager->user_units, u->service, u);
442 int user_start(User *u) {
447 if (u->started && !u->stopping)
451 * If u->stopping is set, the user is marked for removal and the slice
452 * and service stop-jobs are queued. We have to clear that flag before
453 * queing the start-jobs again. If they succeed, the user object can be
454 * re-used just fine (pid1 takes care of job-ordering and proper
455 * restart), but if they fail, we want to force another user_stop() so
456 * possibly pending units are stopped.
457 * Note that we don't clear u->started, as we have no clue what state
458 * the user is in on failure here. Hence, we pretend the user is
459 * running so it will be properly taken down by GC. However, we clearly
460 * return an error from user_start() in that case, so no further
461 * reference to the user is taken.
466 log_debug("Starting services for new user %s.", u->name);
468 /* Make XDG_RUNTIME_DIR */
469 r = user_mkdir_runtime_path(u);
475 r = user_start_slice(u);
479 /* Save the user data so far, because pam_systemd will read the
480 * XDG_RUNTIME_DIR out of it while starting up systemd --user.
481 * We need to do user_save_internal() because we have not
482 * "officially" started yet. */
483 user_save_internal(u);
485 /* Spawn user systemd */
486 r = user_start_service(u);
491 if (!dual_timestamp_is_set(&u->timestamp))
492 dual_timestamp_get(&u->timestamp);
493 user_send_signal(u, true);
497 /* Save new user data */
503 #if 0 /// UNNEEDED by elogind
504 static int user_stop_slice(User *u) {
505 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
511 r = manager_stop_unit(u->manager, u->slice, &error, &job);
513 log_error("Failed to stop user slice: %s", bus_error_message(&error, r));
523 static int user_stop_service(User *u) {
524 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
530 r = manager_stop_unit(u->manager, u->service, &error, &job);
532 log_error("Failed to stop user service: %s", bus_error_message(&error, r));
536 free_and_replace(u->service_job, job);
541 static int user_remove_runtime_path(User *u) {
546 r = rm_rf(u->runtime_path, 0);
548 log_error_errno(r, "Failed to remove runtime directory %s (before unmounting): %m", u->runtime_path);
550 /* Ignore cases where the directory isn't mounted, as that's
551 * quite possible, if we lacked the permissions to mount
553 r = umount2(u->runtime_path, MNT_DETACH);
554 if (r < 0 && !IN_SET(errno, EINVAL, ENOENT))
555 log_error_errno(errno, "Failed to unmount user runtime directory %s: %m", u->runtime_path);
557 r = rm_rf(u->runtime_path, REMOVE_ROOT);
559 log_error_errno(r, "Failed to remove runtime directory %s (after unmounting): %m", u->runtime_path);
564 int user_stop(User *u, bool force) {
569 /* Stop jobs have already been queued */
575 LIST_FOREACH(sessions_by_user, s, u->sessions) {
576 k = session_stop(s, force);
582 #if 0 /// elogind does not support service or slice jobs
583 k = user_stop_service(u);
588 k = user_stop_slice(u);
597 #if 1 /// elogind must queue this user again
598 user_add_to_gc_queue(u);
603 int user_finalize(User *u) {
610 log_debug("User %s logged out.", u->name);
612 LIST_FOREACH(sessions_by_user, s, u->sessions) {
613 k = session_finalize(s);
618 /* Kill XDG_RUNTIME_DIR */
619 k = user_remove_runtime_path(u);
623 /* Clean SysV + POSIX IPC objects, but only if this is not a system user. Background: in many setups cronjobs
624 * are run in full PAM and thus logind sessions, even if the code run doesn't belong to actual users but to
625 * system components. Since enable RemoveIPC= globally for all users, we need to be a bit careful with such
626 * cases, as we shouldn't accidentally remove a system service's IPC objects while it is running, just because
627 * a cronjob running as the same user just finished. Hence: exclude system users generally from IPC clean-up,
628 * and do it only for normal users. */
629 if (u->manager->remove_ipc && !uid_is_system(u->uid)) {
630 k = clean_ipc_by_uid(u->uid);
635 unlink(u->state_file);
636 user_add_to_gc_queue(u);
639 user_send_signal(u, false);
646 int user_get_idle_hint(User *u, dual_timestamp *t) {
648 bool idle_hint = true;
649 dual_timestamp ts = DUAL_TIMESTAMP_NULL;
653 LIST_FOREACH(sessions_by_user, s, u->sessions) {
657 ih = session_get_idle_hint(s, &k);
663 if (k.monotonic < ts.monotonic)
669 } else if (idle_hint) {
671 if (k.monotonic > ts.monotonic)
682 int user_check_linger_file(User *u) {
683 _cleanup_free_ char *cc = NULL;
686 cc = cescape(u->name);
690 p = strjoina("/var/lib/elogind/linger/", cc);
692 return access(p, F_OK) >= 0;
695 bool user_may_gc(User *u, bool drop_not_started) {
698 if (drop_not_started && !u->started)
704 if (user_check_linger_file(u) > 0)
707 #if 0 /// elogind neither supports service nor slice jobs
708 if (u->slice_job && manager_job_is_active(u->manager, u->slice_job))
711 if (u->service_job && manager_job_is_active(u->manager, u->service_job))
718 void user_add_to_gc_queue(User *u) {
724 LIST_PREPEND(gc_queue, u->manager->user_gc_queue, u);
725 u->in_gc_queue = true;
728 UserState user_get_state(User *u) {
736 #if 0 /// elogind neither supports service nor slice jobs.
737 if (!u->started || u->slice_job || u->service_job)
744 bool all_closing = true;
746 LIST_FOREACH(sessions_by_user, i, u->sessions) {
749 state = session_get_state(i);
750 if (state == SESSION_ACTIVE)
752 if (state != SESSION_CLOSING)
756 return all_closing ? USER_CLOSING : USER_ONLINE;
759 if (user_check_linger_file(u) > 0)
760 return USER_LINGERING;
765 int user_kill(User *u, int signo) {
766 #if 0 /// Without systemd unit support, elogind has to rely on its session system
769 return manager_kill_unit(u->manager, u->slice, KILL_ALL, signo, NULL);
776 LIST_FOREACH(sessions_by_user, s, u->sessions) {
777 int r = session_kill(s, KILL_ALL, signo);
778 if (res == 0 && r < 0)
786 static bool elect_display_filter(Session *s) {
787 /* Return true if the session is a candidate for the user’s ‘primary
788 * session’ or ‘display’. */
791 return (s->class == SESSION_USER && !s->stopping);
794 static int elect_display_compare(Session *s1, Session *s2) {
795 /* Indexed by SessionType. Lower numbers mean more preferred. */
796 const int type_ranks[_SESSION_TYPE_MAX] = {
797 [SESSION_UNSPECIFIED] = 0,
800 [SESSION_WAYLAND] = -3,
805 /* Calculate the partial order relationship between s1 and s2,
806 * returning < 0 if s1 is preferred as the user’s ‘primary session’,
807 * 0 if s1 and s2 are equally preferred or incomparable, or > 0 if s2
810 * s1 or s2 may be NULL. */
814 if ((s1 == NULL) != (s2 == NULL))
815 return (s1 == NULL) - (s2 == NULL);
817 if (s1->stopping != s2->stopping)
818 return s1->stopping - s2->stopping;
820 if ((s1->class != SESSION_USER) != (s2->class != SESSION_USER))
821 return (s1->class != SESSION_USER) - (s2->class != SESSION_USER);
823 if ((s1->type == _SESSION_TYPE_INVALID) != (s2->type == _SESSION_TYPE_INVALID))
824 return (s1->type == _SESSION_TYPE_INVALID) - (s2->type == _SESSION_TYPE_INVALID);
826 if (s1->type != s2->type)
827 return type_ranks[s1->type] - type_ranks[s2->type];
832 void user_elect_display(User *u) {
837 /* This elects a primary session for each user, which we call
838 * the "display". We try to keep the assignment stable, but we
839 * "upgrade" to better choices. */
840 log_debug("Electing new display for user %s", u->name);
842 LIST_FOREACH(sessions_by_user, s, u->sessions) {
843 if (!elect_display_filter(s)) {
844 log_debug("Ignoring session %s", s->id);
848 if (elect_display_compare(s, u->display) < 0) {
849 log_debug("Choosing session %s in preference to %s", s->id, u->display ? u->display->id : "-");
855 static const char* const user_state_table[_USER_STATE_MAX] = {
856 [USER_OFFLINE] = "offline",
857 [USER_OPENING] = "opening",
858 [USER_LINGERING] = "lingering",
859 [USER_ONLINE] = "online",
860 [USER_ACTIVE] = "active",
861 [USER_CLOSING] = "closing"
864 DEFINE_STRING_TABLE_LOOKUP(user_state, UserState);
866 int config_parse_tmpfs_size(
868 const char *filename,
871 unsigned section_line,
886 /* First, try to parse as percentage */
887 r = parse_percent(rvalue);
888 if (r > 0 && r < 100)
889 *sz = physical_memory_scale(r, 100U);
893 /* If the passed argument was not a percentage, or out of range, parse as byte size */
895 r = parse_size(rvalue, 1024, &k);
896 if (r < 0 || k <= 0 || (uint64_t) (size_t) k != k) {
897 log_syntax(unit, LOG_ERR, filename, line, r, "Failed to parse size value, ignoring: %s", rvalue);
901 *sz = PAGE_ALIGN((size_t) k);
907 int config_parse_user_tasks_max(
909 const char *filename,
912 unsigned section_line,
928 if (isempty(rvalue)) {
929 *m = system_tasks_max_scale(DEFAULT_USER_TASKS_MAX_PERCENTAGE, 100U);
933 if (streq(rvalue, "infinity")) {
934 *m = CGROUP_LIMIT_MAX;
938 /* Try to parse as percentage */
939 r = parse_percent(rvalue);
941 k = system_tasks_max_scale(r, 100U);
944 /* If the passed argument was not a percentage, or out of range, parse as byte size */
946 r = safe_atou64(rvalue, &k);
948 log_syntax(unit, LOG_ERR, filename, line, r, "Failed to parse tasks maximum, ignoring: %s", rvalue);
953 if (k <= 0 || k >= UINT64_MAX) {
954 log_syntax(unit, LOG_ERR, filename, line, 0, "Tasks maximum out of range, ignoring: %s", rvalue);