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 log_error_errno(r, "Failed to read %s: %m", u->state_file);
325 s = hashmap_get(u->manager->sessions, display);
327 if (s && s->display && display_is_local(s->display))
331 timestamp_deserialize(realtime, &u->timestamp.realtime);
333 timestamp_deserialize(monotonic, &u->timestamp.monotonic);
338 static int user_mkdir_runtime_path(User *u) {
343 r = mkdir_safe_label("/run/user", 0755, 0, 0);
345 return log_error_errno(r, "Failed to create /run/user: %m");
347 if (path_is_mount_point(u->runtime_path, 0) <= 0) {
348 _cleanup_free_ char *t = NULL;
350 (void) mkdir_label(u->runtime_path, 0700);
353 r = asprintf(&t, "mode=0700,smackfsroot=*,uid=" UID_FMT ",gid=" GID_FMT ",size=%zu", u->uid, u->gid, u->manager->runtime_dir_size);
355 r = asprintf(&t, "mode=0700,uid=" UID_FMT ",gid=" GID_FMT ",size=%zu", u->uid, u->gid, u->manager->runtime_dir_size);
361 r = mount("tmpfs", u->runtime_path, "tmpfs", MS_NODEV|MS_NOSUID, t);
363 if (errno != EPERM) {
364 r = log_error_errno(errno, "Failed to mount per-user tmpfs directory %s: %m", u->runtime_path);
368 /* Lacking permissions, maybe
369 * CAP_SYS_ADMIN-less container? In this case,
370 * just use a normal directory. */
372 r = chmod_and_chown(u->runtime_path, 0700, u->uid, u->gid);
374 log_error_errno(r, "Failed to change runtime directory ownership and mode: %m");
379 r = label_fix(u->runtime_path, false, false);
381 log_warning_errno(r, "Failed to fix label of '%s', ignoring: %m", u->runtime_path);
387 /* Try to clean up, but ignore errors */
388 (void) rmdir(u->runtime_path);
392 static int user_start_slice(User *u) {
393 #if 0 /// elogind can not ask systemd via dbus to start user services
394 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
395 const char *description;
401 u->slice_job = mfree(u->slice_job);
402 description = strjoina("User Slice of ", u->name);
404 r = manager_start_slice(
408 "systemd-logind.service",
409 "systemd-user-sessions.service",
410 u->manager->user_tasks_max,
415 else if (!sd_bus_error_has_name(&error, BUS_ERROR_UNIT_EXISTS))
416 /* we don't fail due to this, let's try to continue */
417 log_error_errno(r, "Failed to start user slice %s, ignoring: %s (%s)",
418 u->slice, bus_error_message(&error, r), error.name);
422 hashmap_put(u->manager->user_units, u->slice, u);
428 static int user_start_service(User *u) {
429 #if 0 /// elogind can not ask systemd via dbus to start user services
430 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
436 u->service_job = mfree(u->service_job);
438 r = manager_start_unit(
444 /* we don't fail due to this, let's try to continue */
445 log_error_errno(r, "Failed to start user service, ignoring: %s", bus_error_message(&error, r));
447 u->service_job = job;
452 hashmap_put(u->manager->user_units, u->service, u);
458 int user_start(User *u) {
463 if (u->started && !u->stopping)
467 * If u->stopping is set, the user is marked for removal and the slice
468 * and service stop-jobs are queued. We have to clear that flag before
469 * queing the start-jobs again. If they succeed, the user object can be
470 * re-used just fine (pid1 takes care of job-ordering and proper
471 * restart), but if they fail, we want to force another user_stop() so
472 * possibly pending units are stopped.
473 * Note that we don't clear u->started, as we have no clue what state
474 * the user is in on failure here. Hence, we pretend the user is
475 * running so it will be properly taken down by GC. However, we clearly
476 * return an error from user_start() in that case, so no further
477 * reference to the user is taken.
482 log_debug("New user %s logged in.", u->name);
484 /* Make XDG_RUNTIME_DIR */
485 r = user_mkdir_runtime_path(u);
491 r = user_start_slice(u);
495 /* Save the user data so far, because pam_systemd will read the
496 * XDG_RUNTIME_DIR out of it while starting up systemd --user.
497 * We need to do user_save_internal() because we have not
498 * "officially" started yet. */
499 user_save_internal(u);
501 /* Spawn user systemd */
502 r = user_start_service(u);
507 if (!dual_timestamp_is_set(&u->timestamp))
508 dual_timestamp_get(&u->timestamp);
509 user_send_signal(u, true);
513 /* Save new user data */
519 #if 0 /// UNNEEDED by elogind
520 static int user_stop_slice(User *u) {
521 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
527 r = manager_stop_unit(u->manager, u->slice, &error, &job);
529 log_error("Failed to stop user slice: %s", bus_error_message(&error, r));
539 static int user_stop_service(User *u) {
540 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
546 r = manager_stop_unit(u->manager, u->service, &error, &job);
548 log_error("Failed to stop user service: %s", bus_error_message(&error, r));
552 free(u->service_job);
553 u->service_job = job;
559 static int user_remove_runtime_path(User *u) {
564 r = rm_rf(u->runtime_path, 0);
566 log_error_errno(r, "Failed to remove runtime directory %s: %m", u->runtime_path);
568 /* Ignore cases where the directory isn't mounted, as that's
569 * quite possible, if we lacked the permissions to mount
571 r = umount2(u->runtime_path, MNT_DETACH);
572 if (r < 0 && errno != EINVAL && errno != ENOENT)
573 log_error_errno(errno, "Failed to unmount user runtime directory %s: %m", u->runtime_path);
575 r = rm_rf(u->runtime_path, REMOVE_ROOT);
577 log_error_errno(r, "Failed to remove runtime directory %s: %m", u->runtime_path);
582 int user_stop(User *u, bool force) {
587 /* Stop jobs have already been queued */
593 LIST_FOREACH(sessions_by_user, s, u->sessions) {
594 k = session_stop(s, force);
600 #if 0 /// elogind does not support service or slice jobs
601 k = user_stop_service(u);
606 k = user_stop_slice(u);
618 int user_finalize(User *u) {
625 log_debug("User %s logged out.", u->name);
627 LIST_FOREACH(sessions_by_user, s, u->sessions) {
628 k = session_finalize(s);
633 /* Kill XDG_RUNTIME_DIR */
634 k = user_remove_runtime_path(u);
638 /* Clean SysV + POSIX IPC objects */
639 if (u->manager->remove_ipc) {
640 k = clean_ipc(u->uid);
645 unlink(u->state_file);
646 user_add_to_gc_queue(u);
649 user_send_signal(u, false);
656 int user_get_idle_hint(User *u, dual_timestamp *t) {
658 bool idle_hint = true;
659 dual_timestamp ts = DUAL_TIMESTAMP_NULL;
663 LIST_FOREACH(sessions_by_user, s, u->sessions) {
667 ih = session_get_idle_hint(s, &k);
673 if (k.monotonic < ts.monotonic)
679 } else if (idle_hint) {
681 if (k.monotonic > ts.monotonic)
692 int user_check_linger_file(User *u) {
693 _cleanup_free_ char *cc = NULL;
696 cc = cescape(u->name);
700 p = strjoina("/var/lib/systemd/linger/", cc);
702 return access(p, F_OK) >= 0;
705 bool user_check_gc(User *u, bool drop_not_started) {
708 if (drop_not_started && !u->started)
714 if (user_check_linger_file(u) > 0)
717 #if 0 /// elogind neither supports service nor slice jobs
718 if (u->slice_job && manager_job_is_active(u->manager, u->slice_job))
721 if (u->service_job && manager_job_is_active(u->manager, u->service_job))
728 void user_add_to_gc_queue(User *u) {
734 LIST_PREPEND(gc_queue, u->manager->user_gc_queue, u);
735 u->in_gc_queue = true;
738 UserState user_get_state(User *u) {
746 #if 0 /// elogind neither supports service nor slice jobs.
747 if (!u->started || u->slice_job || u->service_job)
754 bool all_closing = true;
756 LIST_FOREACH(sessions_by_user, i, u->sessions) {
759 state = session_get_state(i);
760 if (state == SESSION_ACTIVE)
762 if (state != SESSION_CLOSING)
766 return all_closing ? USER_CLOSING : USER_ONLINE;
769 if (user_check_linger_file(u) > 0)
770 return USER_LINGERING;
775 int user_kill(User *u, int signo) {
776 #if 0 /// Without systemd unit support, elogind has to rely on its session system
779 return manager_kill_unit(u->manager, u->slice, KILL_ALL, signo, NULL);
786 LIST_FOREACH(sessions_by_user, s, u->sessions) {
787 int r = session_kill(s, KILL_ALL, signo);
788 if (res == 0 && r < 0)
796 static bool elect_display_filter(Session *s) {
797 /* Return true if the session is a candidate for the user’s ‘primary
798 * session’ or ‘display’. */
801 return (s->class == SESSION_USER && !s->stopping);
804 static int elect_display_compare(Session *s1, Session *s2) {
805 /* Indexed by SessionType. Lower numbers mean more preferred. */
806 const int type_ranks[_SESSION_TYPE_MAX] = {
807 [SESSION_UNSPECIFIED] = 0,
810 [SESSION_WAYLAND] = -3,
815 /* Calculate the partial order relationship between s1 and s2,
816 * returning < 0 if s1 is preferred as the user’s ‘primary session’,
817 * 0 if s1 and s2 are equally preferred or incomparable, or > 0 if s2
820 * s1 or s2 may be NULL. */
824 if ((s1 == NULL) != (s2 == NULL))
825 return (s1 == NULL) - (s2 == NULL);
827 if (s1->stopping != s2->stopping)
828 return s1->stopping - s2->stopping;
830 if ((s1->class != SESSION_USER) != (s2->class != SESSION_USER))
831 return (s1->class != SESSION_USER) - (s2->class != SESSION_USER);
833 if ((s1->type == _SESSION_TYPE_INVALID) != (s2->type == _SESSION_TYPE_INVALID))
834 return (s1->type == _SESSION_TYPE_INVALID) - (s2->type == _SESSION_TYPE_INVALID);
836 if (s1->type != s2->type)
837 return type_ranks[s1->type] - type_ranks[s2->type];
842 void user_elect_display(User *u) {
847 /* This elects a primary session for each user, which we call
848 * the "display". We try to keep the assignment stable, but we
849 * "upgrade" to better choices. */
850 log_debug("Electing new display for user %s", u->name);
852 LIST_FOREACH(sessions_by_user, s, u->sessions) {
853 if (!elect_display_filter(s)) {
854 log_debug("Ignoring session %s", s->id);
858 if (elect_display_compare(s, u->display) < 0) {
859 log_debug("Choosing session %s in preference to %s", s->id, u->display ? u->display->id : "-");
865 static const char* const user_state_table[_USER_STATE_MAX] = {
866 [USER_OFFLINE] = "offline",
867 [USER_OPENING] = "opening",
868 [USER_LINGERING] = "lingering",
869 [USER_ONLINE] = "online",
870 [USER_ACTIVE] = "active",
871 [USER_CLOSING] = "closing"
874 DEFINE_STRING_TABLE_LOOKUP(user_state, UserState);
876 int config_parse_tmpfs_size(
878 const char *filename,
881 unsigned section_line,
896 /* First, try to parse as percentage */
897 r = parse_percent(rvalue);
898 if (r > 0 && r < 100)
899 *sz = physical_memory_scale(r, 100U);
903 /* If the passed argument was not a percentage, or out of range, parse as byte size */
905 r = parse_size(rvalue, 1024, &k);
906 if (r < 0 || k <= 0 || (uint64_t) (size_t) k != k) {
907 log_syntax(unit, LOG_ERR, filename, line, r, "Failed to parse size value, ignoring: %s", rvalue);
911 *sz = PAGE_ALIGN((size_t) k);
917 int config_parse_user_tasks_max(
919 const char *filename,
922 unsigned section_line,
938 /* First, try to parse as percentage */
939 r = parse_percent(rvalue);
940 if (r > 0 && r < 100)
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);