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);
127 u->service = mfree(u->service);
128 u->slice = mfree(u->slice);
129 u->runtime_path = mfree(u->runtime_path);
130 u->state_file = mfree(u->state_file);
131 u->name = mfree(u->name);
136 static int user_save_internal(User *u) {
137 _cleanup_free_ char *temp_path = NULL;
138 _cleanup_fclose_ FILE *f = NULL;
142 assert(u->state_file);
144 r = mkdir_safe_label("/run/systemd/users", 0755, 0, 0);
148 r = fopen_temporary(u->state_file, &f, &temp_path);
152 fchmod(fileno(f), 0644);
155 "# This is private data. Do not parse.\n"
159 user_state_to_string(user_get_state(u)));
161 /* LEGACY: no-one reads RUNTIME= anymore, drop it at some point */
163 fprintf(f, "RUNTIME=%s\n", u->runtime_path);
165 #if 0 /// elogind neither supports service nor slice jobs
167 fprintf(f, "SERVICE_JOB=%s\n", u->service_job);
170 fprintf(f, "SLICE_JOB=%s\n", u->slice_job);
174 fprintf(f, "DISPLAY=%s\n", u->display->id);
176 if (dual_timestamp_is_set(&u->timestamp))
178 "REALTIME="USEC_FMT"\n"
179 "MONOTONIC="USEC_FMT"\n",
180 u->timestamp.realtime,
181 u->timestamp.monotonic);
187 fputs("SESSIONS=", f);
189 LIST_FOREACH(sessions_by_user, i, u->sessions) {
198 fputs("\nSEATS=", f);
200 LIST_FOREACH(sessions_by_user, i, u->sessions) {
209 fputs(i->seat->id, f);
212 fputs("\nACTIVE_SESSIONS=", f);
214 LIST_FOREACH(sessions_by_user, i, u->sessions) {
215 if (!session_is_active(i))
226 fputs("\nONLINE_SESSIONS=", f);
228 LIST_FOREACH(sessions_by_user, i, u->sessions) {
229 if (session_get_state(i) == SESSION_CLOSING)
240 fputs("\nACTIVE_SEATS=", f);
242 LIST_FOREACH(sessions_by_user, i, u->sessions) {
243 if (!session_is_active(i) || !i->seat)
251 fputs(i->seat->id, f);
254 fputs("\nONLINE_SEATS=", f);
256 LIST_FOREACH(sessions_by_user, i, u->sessions) {
257 if (session_get_state(i) == SESSION_CLOSING || !i->seat)
265 fputs(i->seat->id, f);
270 r = fflush_and_check(f);
274 if (rename(temp_path, u->state_file) < 0) {
282 (void) unlink(u->state_file);
285 (void) unlink(temp_path);
287 return log_error_errno(r, "Failed to save user data %s: %m", u->state_file);
290 int user_save(User *u) {
296 return user_save_internal (u);
299 int user_load(User *u) {
300 _cleanup_free_ char *display = NULL, *realtime = NULL, *monotonic = NULL;
306 r = parse_env_file(u->state_file, NEWLINE,
307 #if 0 /// elogind neither supports service nor slice jobs
308 "SERVICE_JOB", &u->service_job,
309 "SLICE_JOB", &u->slice_job,
312 "REALTIME", &realtime,
313 "MONOTONIC", &monotonic,
319 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))
329 deserialize_timestamp_value(realtime, &u->timestamp.realtime);
330 deserialize_timestamp_value(monotonic, &u->timestamp.monotonic);
335 static int user_mkdir_runtime_path(User *u) {
340 r = mkdir_safe_label("/run/user", 0755, 0, 0);
342 return log_error_errno(r, "Failed to create /run/user: %m");
344 if (path_is_mount_point(u->runtime_path, 0) <= 0) {
345 _cleanup_free_ char *t = NULL;
347 (void) mkdir_label(u->runtime_path, 0700);
350 r = asprintf(&t, "mode=0700,smackfsroot=*,uid=" UID_FMT ",gid=" GID_FMT ",size=%zu", u->uid, u->gid, u->manager->runtime_dir_size);
352 r = asprintf(&t, "mode=0700,uid=" UID_FMT ",gid=" GID_FMT ",size=%zu", u->uid, u->gid, u->manager->runtime_dir_size);
358 r = mount("tmpfs", u->runtime_path, "tmpfs", MS_NODEV|MS_NOSUID, t);
360 if (errno != EPERM) {
361 r = log_error_errno(errno, "Failed to mount per-user tmpfs directory %s: %m", u->runtime_path);
365 /* Lacking permissions, maybe
366 * CAP_SYS_ADMIN-less container? In this case,
367 * just use a normal directory. */
369 r = chmod_and_chown(u->runtime_path, 0700, u->uid, u->gid);
371 log_error_errno(r, "Failed to change runtime directory ownership and mode: %m");
376 r = label_fix(u->runtime_path, false, false);
378 log_warning_errno(r, "Failed to fix label of '%s', ignoring: %m", u->runtime_path);
384 /* Try to clean up, but ignore errors */
385 (void) rmdir(u->runtime_path);
389 static int user_start_slice(User *u) {
390 #if 0 /// elogind can not ask systemd via dbus to start user services
391 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
392 const char *description;
398 u->slice_job = mfree(u->slice_job);
399 description = strjoina("User Slice of ", u->name);
401 r = manager_start_slice(
405 "systemd-logind.service",
406 "systemd-user-sessions.service",
407 u->manager->user_tasks_max,
412 else if (!sd_bus_error_has_name(&error, BUS_ERROR_UNIT_EXISTS))
413 /* we don't fail due to this, let's try to continue */
414 log_error_errno(r, "Failed to start user slice %s, ignoring: %s (%s)",
415 u->slice, bus_error_message(&error, r), error.name);
419 hashmap_put(u->manager->user_units, u->slice, u);
425 static int user_start_service(User *u) {
426 #if 0 /// elogind can not ask systemd via dbus to start user services
427 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
433 u->service_job = mfree(u->service_job);
435 r = manager_start_unit(
441 /* we don't fail due to this, let's try to continue */
442 log_error_errno(r, "Failed to start user service, ignoring: %s", bus_error_message(&error, r));
444 u->service_job = job;
449 hashmap_put(u->manager->user_units, u->service, u);
455 int user_start(User *u) {
460 if (u->started && !u->stopping)
464 * If u->stopping is set, the user is marked for removal and the slice
465 * and service stop-jobs are queued. We have to clear that flag before
466 * queing the start-jobs again. If they succeed, the user object can be
467 * re-used just fine (pid1 takes care of job-ordering and proper
468 * restart), but if they fail, we want to force another user_stop() so
469 * possibly pending units are stopped.
470 * Note that we don't clear u->started, as we have no clue what state
471 * the user is in on failure here. Hence, we pretend the user is
472 * running so it will be properly taken down by GC. However, we clearly
473 * return an error from user_start() in that case, so no further
474 * reference to the user is taken.
479 log_debug("New user %s logged in.", u->name);
481 /* Make XDG_RUNTIME_DIR */
482 r = user_mkdir_runtime_path(u);
488 r = user_start_slice(u);
492 /* Save the user data so far, because pam_systemd will read the
493 * XDG_RUNTIME_DIR out of it while starting up systemd --user.
494 * We need to do user_save_internal() because we have not
495 * "officially" started yet. */
496 user_save_internal(u);
498 /* Spawn user systemd */
499 r = user_start_service(u);
504 if (!dual_timestamp_is_set(&u->timestamp))
505 dual_timestamp_get(&u->timestamp);
506 user_send_signal(u, true);
510 /* Save new user data */
516 #if 0 /// UNNEEDED by elogind
517 static int user_stop_slice(User *u) {
518 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
524 r = manager_stop_unit(u->manager, u->slice, &error, &job);
526 log_error("Failed to stop user slice: %s", bus_error_message(&error, r));
536 static int user_stop_service(User *u) {
537 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
543 r = manager_stop_unit(u->manager, u->service, &error, &job);
545 log_error("Failed to stop user service: %s", bus_error_message(&error, r));
549 free(u->service_job);
550 u->service_job = job;
556 static int user_remove_runtime_path(User *u) {
561 r = rm_rf(u->runtime_path, 0);
563 log_error_errno(r, "Failed to remove runtime directory %s: %m", u->runtime_path);
565 /* Ignore cases where the directory isn't mounted, as that's
566 * quite possible, if we lacked the permissions to mount
568 r = umount2(u->runtime_path, MNT_DETACH);
569 if (r < 0 && errno != EINVAL && errno != ENOENT)
570 log_error_errno(errno, "Failed to unmount user runtime directory %s: %m", u->runtime_path);
572 r = rm_rf(u->runtime_path, REMOVE_ROOT);
574 log_error_errno(r, "Failed to remove runtime directory %s: %m", u->runtime_path);
579 int user_stop(User *u, bool force) {
584 /* Stop jobs have already been queued */
590 LIST_FOREACH(sessions_by_user, s, u->sessions) {
591 k = session_stop(s, force);
597 #if 0 /// elogind does not support service or slice jobs
598 k = user_stop_service(u);
603 k = user_stop_slice(u);
615 int user_finalize(User *u) {
622 log_debug("User %s logged out.", u->name);
624 LIST_FOREACH(sessions_by_user, s, u->sessions) {
625 k = session_finalize(s);
630 /* Kill XDG_RUNTIME_DIR */
631 k = user_remove_runtime_path(u);
635 /* Clean SysV + POSIX IPC objects */
636 if (u->manager->remove_ipc) {
637 k = clean_ipc(u->uid);
642 unlink(u->state_file);
643 user_add_to_gc_queue(u);
646 user_send_signal(u, false);
653 int user_get_idle_hint(User *u, dual_timestamp *t) {
655 bool idle_hint = true;
656 dual_timestamp ts = DUAL_TIMESTAMP_NULL;
660 LIST_FOREACH(sessions_by_user, s, u->sessions) {
664 ih = session_get_idle_hint(s, &k);
670 if (k.monotonic < ts.monotonic)
676 } else if (idle_hint) {
678 if (k.monotonic > ts.monotonic)
689 int user_check_linger_file(User *u) {
690 _cleanup_free_ char *cc = NULL;
693 cc = cescape(u->name);
697 p = strjoina("/var/lib/systemd/linger/", cc);
699 return access(p, F_OK) >= 0;
702 bool user_check_gc(User *u, bool drop_not_started) {
705 if (drop_not_started && !u->started)
711 if (user_check_linger_file(u) > 0)
714 #if 0 /// elogind neither supports service nor slice jobs
715 if (u->slice_job && manager_job_is_active(u->manager, u->slice_job))
718 if (u->service_job && manager_job_is_active(u->manager, u->service_job))
725 void user_add_to_gc_queue(User *u) {
731 LIST_PREPEND(gc_queue, u->manager->user_gc_queue, u);
732 u->in_gc_queue = true;
735 UserState user_get_state(User *u) {
743 #if 0 /// elogind neither supports service nor slice jobs.
744 if (!u->started || u->slice_job || u->service_job)
751 bool all_closing = true;
753 LIST_FOREACH(sessions_by_user, i, u->sessions) {
756 state = session_get_state(i);
757 if (state == SESSION_ACTIVE)
759 if (state != SESSION_CLOSING)
763 return all_closing ? USER_CLOSING : USER_ONLINE;
766 if (user_check_linger_file(u) > 0)
767 return USER_LINGERING;
772 int user_kill(User *u, int signo) {
773 #if 0 /// Without systemd unit support, elogind has to rely on its session system
776 return manager_kill_unit(u->manager, u->slice, KILL_ALL, signo, NULL);
783 LIST_FOREACH(sessions_by_user, s, u->sessions) {
784 int r = session_kill(s, KILL_ALL, signo);
785 if (res == 0 && r < 0)
793 static bool elect_display_filter(Session *s) {
794 /* Return true if the session is a candidate for the user’s ‘primary
795 * session’ or ‘display’. */
798 return (s->class == SESSION_USER && !s->stopping);
801 static int elect_display_compare(Session *s1, Session *s2) {
802 /* Indexed by SessionType. Lower numbers mean more preferred. */
803 const int type_ranks[_SESSION_TYPE_MAX] = {
804 [SESSION_UNSPECIFIED] = 0,
807 [SESSION_WAYLAND] = -3,
812 /* Calculate the partial order relationship between s1 and s2,
813 * returning < 0 if s1 is preferred as the user’s ‘primary session’,
814 * 0 if s1 and s2 are equally preferred or incomparable, or > 0 if s2
817 * s1 or s2 may be NULL. */
821 if ((s1 == NULL) != (s2 == NULL))
822 return (s1 == NULL) - (s2 == NULL);
824 if (s1->stopping != s2->stopping)
825 return s1->stopping - s2->stopping;
827 if ((s1->class != SESSION_USER) != (s2->class != SESSION_USER))
828 return (s1->class != SESSION_USER) - (s2->class != SESSION_USER);
830 if ((s1->type == _SESSION_TYPE_INVALID) != (s2->type == _SESSION_TYPE_INVALID))
831 return (s1->type == _SESSION_TYPE_INVALID) - (s2->type == _SESSION_TYPE_INVALID);
833 if (s1->type != s2->type)
834 return type_ranks[s1->type] - type_ranks[s2->type];
839 void user_elect_display(User *u) {
844 /* This elects a primary session for each user, which we call
845 * the "display". We try to keep the assignment stable, but we
846 * "upgrade" to better choices. */
847 log_debug("Electing new display for user %s", u->name);
849 LIST_FOREACH(sessions_by_user, s, u->sessions) {
850 if (!elect_display_filter(s)) {
851 log_debug("Ignoring session %s", s->id);
855 if (elect_display_compare(s, u->display) < 0) {
856 log_debug("Choosing session %s in preference to %s", s->id, u->display ? u->display->id : "-");
862 static const char* const user_state_table[_USER_STATE_MAX] = {
863 [USER_OFFLINE] = "offline",
864 [USER_OPENING] = "opening",
865 [USER_LINGERING] = "lingering",
866 [USER_ONLINE] = "online",
867 [USER_ACTIVE] = "active",
868 [USER_CLOSING] = "closing"
871 DEFINE_STRING_TABLE_LOOKUP(user_state, UserState);
873 int config_parse_tmpfs_size(
875 const char *filename,
878 unsigned section_line,
894 e = endswith(rvalue, "%");
900 ul = strtoul(rvalue, &f, 10);
901 if (errno > 0 || f != e) {
902 log_syntax(unit, LOG_ERR, filename, line, errno, "Failed to parse percentage value, ignoring: %s", rvalue);
906 if (ul <= 0 || ul >= 100) {
907 log_syntax(unit, LOG_ERR, filename, line, 0, "Percentage value out of range, ignoring: %s", rvalue);
911 *sz = PAGE_ALIGN((size_t) ((physical_memory() * (uint64_t) ul) / (uint64_t) 100));
915 r = parse_size(rvalue, 1024, &k);
916 if (r < 0 || (uint64_t) (size_t) k != k) {
917 log_syntax(unit, LOG_ERR, filename, line, r, "Failed to parse size value, ignoring: %s", rvalue);
921 *sz = PAGE_ALIGN((size_t) k);