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);
329 #if 0 /// elogind can not ask systemd via dbus to start user services
333 hashmap_put(u->manager->user_units, u->slice, u);
335 static int user_start_service(User *u) {
336 #if 0 /// elogind can not ask systemd via dbus to start user services
337 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
343 u->service_job = mfree(u->service_job);
345 r = manager_start_unit(
351 /* we don't fail due to this, let's try to continue */
352 log_error_errno(r, "Failed to start user service, ignoring: %s", bus_error_message(&error, r));
354 u->service_job = job;
358 hashmap_put(u->manager->user_units, u->service, u);
364 int user_start(User *u) {
369 if (u->started && !u->stopping)
373 * If u->stopping is set, the user is marked for removal and the slice
374 * and service stop-jobs are queued. We have to clear that flag before
375 * queing the start-jobs again. If they succeed, the user object can be
376 * re-used just fine (pid1 takes care of job-ordering and proper
377 * restart), but if they fail, we want to force another user_stop() so
378 * possibly pending units are stopped.
379 * Note that we don't clear u->started, as we have no clue what state
380 * the user is in on failure here. Hence, we pretend the user is
381 * running so it will be properly taken down by GC. However, we clearly
382 * return an error from user_start() in that case, so no further
383 * reference to the user is taken.
388 log_debug("Starting services for new user %s.", u->name);
390 /* Save the user data so far, because pam_systemd will read the
391 * XDG_RUNTIME_DIR out of it while starting up systemd --user.
392 * We need to do user_save_internal() because we have not
393 * "officially" started yet. */
394 user_save_internal(u);
396 /* Spawn user systemd */
397 r = user_start_service(u);
402 if (!dual_timestamp_is_set(&u->timestamp))
403 dual_timestamp_get(&u->timestamp);
404 user_send_signal(u, true);
408 /* Save new user data */
414 #if 0 /// UNNEEDED by elogind
415 static int user_stop_slice(User *u) {
416 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
422 r = manager_stop_unit(u->manager, u->slice, &error, &job);
424 log_error("Failed to stop user slice: %s", bus_error_message(&error, r));
434 static int user_stop_service(User *u) {
435 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
441 r = manager_stop_unit(u->manager, u->service, &error, &job);
443 log_error("Failed to stop user service: %s", bus_error_message(&error, r));
447 free_and_replace(u->service_job, job);
452 int user_stop(User *u, bool force) {
457 /* Stop jobs have already been queued */
463 LIST_FOREACH(sessions_by_user, s, u->sessions) {
464 k = session_stop(s, force);
470 #if 0 /// elogind does not support service or slice jobs
471 k = user_stop_service(u);
476 k = user_stop_slice(u);
485 #if 1 /// elogind must queue this user again
486 user_add_to_gc_queue(u);
491 int user_finalize(User *u) {
498 log_debug("User %s logged out.", u->name);
500 LIST_FOREACH(sessions_by_user, s, u->sessions) {
501 k = session_finalize(s);
506 /* Clean SysV + POSIX IPC objects, but only if this is not a system user. Background: in many setups cronjobs
507 * are run in full PAM and thus logind sessions, even if the code run doesn't belong to actual users but to
508 * system components. Since enable RemoveIPC= globally for all users, we need to be a bit careful with such
509 * cases, as we shouldn't accidentally remove a system service's IPC objects while it is running, just because
510 * a cronjob running as the same user just finished. Hence: exclude system users generally from IPC clean-up,
511 * and do it only for normal users. */
512 if (u->manager->remove_ipc && !uid_is_system(u->uid)) {
513 k = clean_ipc_by_uid(u->uid);
518 unlink(u->state_file);
519 user_add_to_gc_queue(u);
522 user_send_signal(u, false);
529 int user_get_idle_hint(User *u, dual_timestamp *t) {
531 bool idle_hint = true;
532 dual_timestamp ts = DUAL_TIMESTAMP_NULL;
536 LIST_FOREACH(sessions_by_user, s, u->sessions) {
540 ih = session_get_idle_hint(s, &k);
546 if (k.monotonic < ts.monotonic)
552 } else if (idle_hint) {
554 if (k.monotonic > ts.monotonic)
565 int user_check_linger_file(User *u) {
566 _cleanup_free_ char *cc = NULL;
569 cc = cescape(u->name);
573 p = strjoina("/var/lib/elogind/linger/", cc);
575 return access(p, F_OK) >= 0;
578 bool user_may_gc(User *u, bool drop_not_started) {
581 if (drop_not_started && !u->started)
587 if (user_check_linger_file(u) > 0)
590 #if 0 /// elogind neither supports service nor slice jobs
591 if (u->slice_job && manager_job_is_active(u->manager, u->slice_job))
594 if (u->service_job && manager_job_is_active(u->manager, u->service_job))
601 void user_add_to_gc_queue(User *u) {
607 LIST_PREPEND(gc_queue, u->manager->user_gc_queue, u);
608 u->in_gc_queue = true;
611 UserState user_get_state(User *u) {
619 #if 0 /// elogind neither supports service nor slice jobs.
620 if (!u->started || u->slice_job || u->service_job)
627 bool all_closing = true;
629 LIST_FOREACH(sessions_by_user, i, u->sessions) {
632 state = session_get_state(i);
633 if (state == SESSION_ACTIVE)
635 if (state != SESSION_CLOSING)
639 return all_closing ? USER_CLOSING : USER_ONLINE;
642 if (user_check_linger_file(u) > 0)
643 return USER_LINGERING;
648 int user_kill(User *u, int signo) {
649 #if 0 /// Without systemd unit support, elogind has to rely on its session system
652 return manager_kill_unit(u->manager, u->slice, KILL_ALL, signo, NULL);
659 LIST_FOREACH(sessions_by_user, s, u->sessions) {
660 int r = session_kill(s, KILL_ALL, signo);
661 if (res == 0 && r < 0)
669 static bool elect_display_filter(Session *s) {
670 /* Return true if the session is a candidate for the user’s ‘primary
671 * session’ or ‘display’. */
674 return (s->class == SESSION_USER && !s->stopping);
677 static int elect_display_compare(Session *s1, Session *s2) {
678 /* Indexed by SessionType. Lower numbers mean more preferred. */
679 const int type_ranks[_SESSION_TYPE_MAX] = {
680 [SESSION_UNSPECIFIED] = 0,
683 [SESSION_WAYLAND] = -3,
688 /* Calculate the partial order relationship between s1 and s2,
689 * returning < 0 if s1 is preferred as the user’s ‘primary session’,
690 * 0 if s1 and s2 are equally preferred or incomparable, or > 0 if s2
693 * s1 or s2 may be NULL. */
697 if ((s1 == NULL) != (s2 == NULL))
698 return (s1 == NULL) - (s2 == NULL);
700 if (s1->stopping != s2->stopping)
701 return s1->stopping - s2->stopping;
703 if ((s1->class != SESSION_USER) != (s2->class != SESSION_USER))
704 return (s1->class != SESSION_USER) - (s2->class != SESSION_USER);
706 if ((s1->type == _SESSION_TYPE_INVALID) != (s2->type == _SESSION_TYPE_INVALID))
707 return (s1->type == _SESSION_TYPE_INVALID) - (s2->type == _SESSION_TYPE_INVALID);
709 if (s1->type != s2->type)
710 return type_ranks[s1->type] - type_ranks[s2->type];
715 void user_elect_display(User *u) {
720 /* This elects a primary session for each user, which we call
721 * the "display". We try to keep the assignment stable, but we
722 * "upgrade" to better choices. */
723 log_debug("Electing new display for user %s", u->name);
725 LIST_FOREACH(sessions_by_user, s, u->sessions) {
726 if (!elect_display_filter(s)) {
727 log_debug("Ignoring session %s", s->id);
731 if (elect_display_compare(s, u->display) < 0) {
732 log_debug("Choosing session %s in preference to %s", s->id, u->display ? u->display->id : "-");
738 static const char* const user_state_table[_USER_STATE_MAX] = {
739 [USER_OFFLINE] = "offline",
740 [USER_OPENING] = "opening",
741 [USER_LINGERING] = "lingering",
742 [USER_ONLINE] = "online",
743 [USER_ACTIVE] = "active",
744 [USER_CLOSING] = "closing"
747 DEFINE_STRING_TABLE_LOOKUP(user_state, UserState);
749 int config_parse_tmpfs_size(
751 const char *filename,
754 unsigned section_line,
769 /* First, try to parse as percentage */
770 r = parse_percent(rvalue);
771 if (r > 0 && r < 100)
772 *sz = physical_memory_scale(r, 100U);
776 /* If the passed argument was not a percentage, or out of range, parse as byte size */
778 r = parse_size(rvalue, 1024, &k);
779 if (r < 0 || k <= 0 || (uint64_t) (size_t) k != k) {
780 log_syntax(unit, LOG_ERR, filename, line, r, "Failed to parse size value, ignoring: %s", rvalue);
784 *sz = PAGE_ALIGN((size_t) k);
790 int config_parse_compat_user_tasks_max(
792 const char *filename,
795 unsigned section_line,
807 log_syntax(unit, LOG_NOTICE, filename, line, 0,
808 "Support for option %s= has been removed.",
810 log_info("Hint: try creating /etc/elogind/system/user-.slice/50-limits.conf with:\n"