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 "clean-ipc.h"
30 #include "conf-parser.h"
34 #include "formats-util.h"
38 #include "logind-user.h"
40 #include "mount-util.h"
41 #include "parse-util.h"
42 #include "path-util.h"
44 #include "smack-util.h"
45 //#include "special.h"
46 #include "stdio-util.h"
47 #include "string-table.h"
48 #include "unit-name.h"
49 #include "user-util.h"
52 int user_new(User **out, Manager *m, uid_t uid, gid_t gid, const char *name) {
53 _cleanup_(user_freep) User *u = NULL;
54 char lu[DECIMAL_STR_MAX(uid_t) + 1];
68 xsprintf(lu, UID_FMT, uid);
70 u->name = strdup(name);
74 if (asprintf(&u->state_file, "/run/systemd/users/"UID_FMT, uid) < 0)
77 if (asprintf(&u->runtime_path, "/run/user/"UID_FMT, uid) < 0)
80 r = slice_build_subslice("user.slice", lu, &u->slice);
84 r = unit_name_build("user", lu, ".service", &u->service);
88 r = hashmap_put(m->users, UID_TO_PTR(uid), u);
92 r = hashmap_put(m->user_units, u->slice, u);
96 r = hashmap_put(m->user_units, u->service, u);
105 User *user_free(User *u) {
110 LIST_REMOVE(gc_queue, u->manager->user_gc_queue, u);
113 session_free(u->sessions);
116 hashmap_remove_value(u->manager->user_units, u->service, u);
119 hashmap_remove_value(u->manager->user_units, u->slice, u);
121 hashmap_remove_value(u->manager->users, UID_TO_PTR(u->uid), u);
123 #if 0 /// elogind neither supports slice nor service jobs.
124 u->slice_job = mfree(u->slice_job);
125 u->service_job = mfree(u->service_job);
128 u->service = mfree(u->service);
129 u->slice = mfree(u->slice);
130 u->runtime_path = mfree(u->runtime_path);
131 u->state_file = mfree(u->state_file);
132 u->name = mfree(u->name);
137 static int user_save_internal(User *u) {
138 _cleanup_free_ char *temp_path = NULL;
139 _cleanup_fclose_ FILE *f = NULL;
143 assert(u->state_file);
145 r = mkdir_safe_label("/run/systemd/users", 0755, 0, 0);
149 r = fopen_temporary(u->state_file, &f, &temp_path);
153 fchmod(fileno(f), 0644);
156 "# This is private data. Do not parse.\n"
160 user_state_to_string(user_get_state(u)));
162 /* LEGACY: no-one reads RUNTIME= anymore, drop it at some point */
164 fprintf(f, "RUNTIME=%s\n", u->runtime_path);
166 #if 0 /// elogind neither supports service nor slice jobs
168 fprintf(f, "SERVICE_JOB=%s\n", u->service_job);
171 fprintf(f, "SLICE_JOB=%s\n", u->slice_job);
175 fprintf(f, "DISPLAY=%s\n", u->display->id);
177 if (dual_timestamp_is_set(&u->timestamp))
179 "REALTIME="USEC_FMT"\n"
180 "MONOTONIC="USEC_FMT"\n",
181 u->timestamp.realtime,
182 u->timestamp.monotonic);
188 fputs("SESSIONS=", f);
190 LIST_FOREACH(sessions_by_user, i, u->sessions) {
199 fputs("\nSEATS=", f);
201 LIST_FOREACH(sessions_by_user, i, u->sessions) {
210 fputs(i->seat->id, f);
213 fputs("\nACTIVE_SESSIONS=", f);
215 LIST_FOREACH(sessions_by_user, i, u->sessions) {
216 if (!session_is_active(i))
227 fputs("\nONLINE_SESSIONS=", f);
229 LIST_FOREACH(sessions_by_user, i, u->sessions) {
230 if (session_get_state(i) == SESSION_CLOSING)
241 fputs("\nACTIVE_SEATS=", f);
243 LIST_FOREACH(sessions_by_user, i, u->sessions) {
244 if (!session_is_active(i) || !i->seat)
252 fputs(i->seat->id, f);
255 fputs("\nONLINE_SEATS=", f);
257 LIST_FOREACH(sessions_by_user, i, u->sessions) {
258 if (session_get_state(i) == SESSION_CLOSING || !i->seat)
266 fputs(i->seat->id, f);
271 r = fflush_and_check(f);
275 if (rename(temp_path, u->state_file) < 0) {
283 (void) unlink(u->state_file);
286 (void) unlink(temp_path);
288 return log_error_errno(r, "Failed to save user data %s: %m", u->state_file);
291 int user_save(User *u) {
297 return user_save_internal (u);
300 int user_load(User *u) {
301 _cleanup_free_ char *display = NULL, *realtime = NULL, *monotonic = NULL;
307 r = parse_env_file(u->state_file, NEWLINE,
308 #if 0 /// elogind neither supports service nor slice jobs
309 "SERVICE_JOB", &u->service_job,
310 "SLICE_JOB", &u->slice_job,
313 "REALTIME", &realtime,
314 "MONOTONIC", &monotonic,
320 return log_error_errno(r, "Failed to read %s: %m", u->state_file);
324 s = hashmap_get(u->manager->sessions, display);
326 if (s && s->display && display_is_local(s->display))
330 timestamp_deserialize(realtime, &u->timestamp.realtime);
332 timestamp_deserialize(monotonic, &u->timestamp.monotonic);
337 static int user_mkdir_runtime_path(User *u) {
342 r = mkdir_safe_label("/run/user", 0755, 0, 0);
344 return log_error_errno(r, "Failed to create /run/user: %m");
346 if (path_is_mount_point(u->runtime_path, 0) <= 0) {
347 _cleanup_free_ char *t = NULL;
349 (void) mkdir_label(u->runtime_path, 0700);
352 r = asprintf(&t, "mode=0700,smackfsroot=*,uid=" UID_FMT ",gid=" GID_FMT ",size=%zu", u->uid, u->gid, u->manager->runtime_dir_size);
354 r = asprintf(&t, "mode=0700,uid=" UID_FMT ",gid=" GID_FMT ",size=%zu", u->uid, u->gid, u->manager->runtime_dir_size);
360 r = mount("tmpfs", u->runtime_path, "tmpfs", MS_NODEV|MS_NOSUID, t);
362 if (errno != EPERM) {
363 r = log_error_errno(errno, "Failed to mount per-user tmpfs directory %s: %m", u->runtime_path);
367 /* Lacking permissions, maybe
368 * CAP_SYS_ADMIN-less container? In this case,
369 * just use a normal directory. */
371 r = chmod_and_chown(u->runtime_path, 0700, u->uid, u->gid);
373 log_error_errno(r, "Failed to change runtime directory ownership and mode: %m");
378 r = label_fix(u->runtime_path, false, false);
380 log_warning_errno(r, "Failed to fix label of '%s', ignoring: %m", u->runtime_path);
386 /* Try to clean up, but ignore errors */
387 (void) rmdir(u->runtime_path);
391 static int user_start_slice(User *u) {
392 #if 0 /// elogind can not ask systemd via dbus to start user services
393 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
394 const char *description;
400 u->slice_job = mfree(u->slice_job);
401 description = strjoina("User Slice of ", u->name);
403 r = manager_start_slice(
407 "systemd-logind.service",
408 "systemd-user-sessions.service",
409 u->manager->user_tasks_max,
414 else if (!sd_bus_error_has_name(&error, BUS_ERROR_UNIT_EXISTS))
415 /* we don't fail due to this, let's try to continue */
416 log_error_errno(r, "Failed to start user slice %s, ignoring: %s (%s)",
417 u->slice, bus_error_message(&error, r), error.name);
421 hashmap_put(u->manager->user_units, u->slice, u);
427 static int user_start_service(User *u) {
428 #if 0 /// elogind can not ask systemd via dbus to start user services
429 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
435 u->service_job = mfree(u->service_job);
437 r = manager_start_unit(
443 /* we don't fail due to this, let's try to continue */
444 log_error_errno(r, "Failed to start user service, ignoring: %s", bus_error_message(&error, r));
446 u->service_job = job;
451 hashmap_put(u->manager->user_units, u->service, u);
457 int user_start(User *u) {
462 if (u->started && !u->stopping)
466 * If u->stopping is set, the user is marked for removal and the slice
467 * and service stop-jobs are queued. We have to clear that flag before
468 * queing the start-jobs again. If they succeed, the user object can be
469 * re-used just fine (pid1 takes care of job-ordering and proper
470 * restart), but if they fail, we want to force another user_stop() so
471 * possibly pending units are stopped.
472 * Note that we don't clear u->started, as we have no clue what state
473 * the user is in on failure here. Hence, we pretend the user is
474 * running so it will be properly taken down by GC. However, we clearly
475 * return an error from user_start() in that case, so no further
476 * reference to the user is taken.
481 log_debug("New user %s logged in.", u->name);
483 /* Make XDG_RUNTIME_DIR */
484 r = user_mkdir_runtime_path(u);
490 r = user_start_slice(u);
494 /* Save the user data so far, because pam_systemd will read the
495 * XDG_RUNTIME_DIR out of it while starting up systemd --user.
496 * We need to do user_save_internal() because we have not
497 * "officially" started yet. */
498 user_save_internal(u);
500 /* Spawn user systemd */
501 r = user_start_service(u);
506 if (!dual_timestamp_is_set(&u->timestamp))
507 dual_timestamp_get(&u->timestamp);
508 user_send_signal(u, true);
512 /* Save new user data */
518 #if 0 /// UNNEEDED by elogind
519 static int user_stop_slice(User *u) {
520 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
526 r = manager_stop_unit(u->manager, u->slice, &error, &job);
528 log_error("Failed to stop user slice: %s", bus_error_message(&error, r));
538 static int user_stop_service(User *u) {
539 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
545 r = manager_stop_unit(u->manager, u->service, &error, &job);
547 log_error("Failed to stop user service: %s", bus_error_message(&error, r));
551 free(u->service_job);
552 u->service_job = job;
558 static int user_remove_runtime_path(User *u) {
563 r = rm_rf(u->runtime_path, 0);
565 log_error_errno(r, "Failed to remove runtime directory %s: %m", u->runtime_path);
567 /* Ignore cases where the directory isn't mounted, as that's
568 * quite possible, if we lacked the permissions to mount
570 r = umount2(u->runtime_path, MNT_DETACH);
571 if (r < 0 && errno != EINVAL && errno != ENOENT)
572 log_error_errno(errno, "Failed to unmount user runtime directory %s: %m", u->runtime_path);
574 r = rm_rf(u->runtime_path, REMOVE_ROOT);
576 log_error_errno(r, "Failed to remove runtime directory %s: %m", u->runtime_path);
581 int user_stop(User *u, bool force) {
586 /* Stop jobs have already been queued */
592 LIST_FOREACH(sessions_by_user, s, u->sessions) {
593 k = session_stop(s, force);
599 #if 0 /// elogind does not support service or slice jobs
600 k = user_stop_service(u);
605 k = user_stop_slice(u);
617 int user_finalize(User *u) {
624 log_debug("User %s logged out.", u->name);
626 LIST_FOREACH(sessions_by_user, s, u->sessions) {
627 k = session_finalize(s);
632 /* Kill XDG_RUNTIME_DIR */
633 k = user_remove_runtime_path(u);
637 /* Clean SysV + POSIX IPC objects */
638 if (u->manager->remove_ipc) {
639 k = clean_ipc(u->uid);
644 unlink(u->state_file);
645 user_add_to_gc_queue(u);
648 user_send_signal(u, false);
655 int user_get_idle_hint(User *u, dual_timestamp *t) {
657 bool idle_hint = true;
658 dual_timestamp ts = DUAL_TIMESTAMP_NULL;
662 LIST_FOREACH(sessions_by_user, s, u->sessions) {
666 ih = session_get_idle_hint(s, &k);
672 if (k.monotonic < ts.monotonic)
678 } else if (idle_hint) {
680 if (k.monotonic > ts.monotonic)
691 int user_check_linger_file(User *u) {
692 _cleanup_free_ char *cc = NULL;
695 cc = cescape(u->name);
699 p = strjoina("/var/lib/systemd/linger/", cc);
701 return access(p, F_OK) >= 0;
704 bool user_check_gc(User *u, bool drop_not_started) {
707 if (drop_not_started && !u->started)
713 if (user_check_linger_file(u) > 0)
716 #if 0 /// elogind neither supports service nor slice jobs
717 if (u->slice_job && manager_job_is_active(u->manager, u->slice_job))
720 if (u->service_job && manager_job_is_active(u->manager, u->service_job))
727 void user_add_to_gc_queue(User *u) {
733 LIST_PREPEND(gc_queue, u->manager->user_gc_queue, u);
734 u->in_gc_queue = true;
737 UserState user_get_state(User *u) {
745 #if 0 /// elogind neither supports service nor slice jobs.
746 if (!u->started || u->slice_job || u->service_job)
753 bool all_closing = true;
755 LIST_FOREACH(sessions_by_user, i, u->sessions) {
758 state = session_get_state(i);
759 if (state == SESSION_ACTIVE)
761 if (state != SESSION_CLOSING)
765 return all_closing ? USER_CLOSING : USER_ONLINE;
768 if (user_check_linger_file(u) > 0)
769 return USER_LINGERING;
774 int user_kill(User *u, int signo) {
775 #if 0 /// Without systemd unit support, elogind has to rely on its session system
778 return manager_kill_unit(u->manager, u->slice, KILL_ALL, signo, NULL);
785 LIST_FOREACH(sessions_by_user, s, u->sessions) {
786 int r = session_kill(s, KILL_ALL, signo);
787 if (res == 0 && r < 0)
795 static bool elect_display_filter(Session *s) {
796 /* Return true if the session is a candidate for the user’s ‘primary
797 * session’ or ‘display’. */
800 return (s->class == SESSION_USER && !s->stopping);
803 static int elect_display_compare(Session *s1, Session *s2) {
804 /* Indexed by SessionType. Lower numbers mean more preferred. */
805 const int type_ranks[_SESSION_TYPE_MAX] = {
806 [SESSION_UNSPECIFIED] = 0,
809 [SESSION_WAYLAND] = -3,
814 /* Calculate the partial order relationship between s1 and s2,
815 * returning < 0 if s1 is preferred as the user’s ‘primary session’,
816 * 0 if s1 and s2 are equally preferred or incomparable, or > 0 if s2
819 * s1 or s2 may be NULL. */
823 if ((s1 == NULL) != (s2 == NULL))
824 return (s1 == NULL) - (s2 == NULL);
826 if (s1->stopping != s2->stopping)
827 return s1->stopping - s2->stopping;
829 if ((s1->class != SESSION_USER) != (s2->class != SESSION_USER))
830 return (s1->class != SESSION_USER) - (s2->class != SESSION_USER);
832 if ((s1->type == _SESSION_TYPE_INVALID) != (s2->type == _SESSION_TYPE_INVALID))
833 return (s1->type == _SESSION_TYPE_INVALID) - (s2->type == _SESSION_TYPE_INVALID);
835 if (s1->type != s2->type)
836 return type_ranks[s1->type] - type_ranks[s2->type];
841 void user_elect_display(User *u) {
846 /* This elects a primary session for each user, which we call
847 * the "display". We try to keep the assignment stable, but we
848 * "upgrade" to better choices. */
849 log_debug("Electing new display for user %s", u->name);
851 LIST_FOREACH(sessions_by_user, s, u->sessions) {
852 if (!elect_display_filter(s)) {
853 log_debug("Ignoring session %s", s->id);
857 if (elect_display_compare(s, u->display) < 0) {
858 log_debug("Choosing session %s in preference to %s", s->id, u->display ? u->display->id : "-");
864 static const char* const user_state_table[_USER_STATE_MAX] = {
865 [USER_OFFLINE] = "offline",
866 [USER_OPENING] = "opening",
867 [USER_LINGERING] = "lingering",
868 [USER_ONLINE] = "online",
869 [USER_ACTIVE] = "active",
870 [USER_CLOSING] = "closing"
873 DEFINE_STRING_TABLE_LOOKUP(user_state, UserState);
875 int config_parse_tmpfs_size(
877 const char *filename,
880 unsigned section_line,
895 /* First, try to parse as percentage */
896 r = parse_percent(rvalue);
897 if (r > 0 && r < 100)
898 *sz = physical_memory_scale(r, 100U);
902 /* If the passed argument was not a percentage, or out of range, parse as byte size */
904 r = parse_size(rvalue, 1024, &k);
905 if (r < 0 || k <= 0 || (uint64_t) (size_t) k != k) {
906 log_syntax(unit, LOG_ERR, filename, line, r, "Failed to parse size value, ignoring: %s", rvalue);
910 *sz = PAGE_ALIGN((size_t) k);
916 int config_parse_user_tasks_max(
918 const char *filename,
921 unsigned section_line,
937 /* First, try to parse as percentage */
938 r = parse_percent(rvalue);
940 k = system_tasks_max_scale(r, 100U);
943 /* If the passed argument was not a percentage, or out of range, parse as byte size */
945 r = safe_atou64(rvalue, &k);
947 log_syntax(unit, LOG_ERR, filename, line, r, "Failed to parse tasks maximum, ignoring: %s", rvalue);
952 if (k <= 0 || k >= UINT64_MAX) {
953 log_syntax(unit, LOG_ERR, filename, line, 0, "Tasks maximum out of range, ignoring: %s", rvalue);