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 "cgroup-util.h"
30 #include "clean-ipc.h"
31 #include "conf-parser.h"
35 #include "formats-util.h"
39 #include "logind-user.h"
41 #include "mount-util.h"
42 #include "parse-util.h"
43 #include "path-util.h"
45 #include "smack-util.h"
47 #include "stdio-util.h"
48 #include "string-table.h"
49 #include "unit-name.h"
50 #include "user-util.h"
53 int user_new(User
**out
, Manager
*m
, uid_t uid
, gid_t gid
, const char *name
) {
54 _cleanup_(user_freep
) User
*u
= NULL
;
55 char lu
[DECIMAL_STR_MAX(uid_t
) + 1];
69 xsprintf(lu
, UID_FMT
, uid
);
71 u
->name
= strdup(name
);
75 if (asprintf(&u
->state_file
, "/run/systemd/users/"UID_FMT
, uid
) < 0)
78 if (asprintf(&u
->runtime_path
, "/run/user/"UID_FMT
, uid
) < 0)
81 r
= slice_build_subslice(SPECIAL_USER_SLICE
, lu
, &u
->slice
);
85 r
= unit_name_build("user", lu
, ".service", &u
->service
);
89 r
= hashmap_put(m
->users
, UID_TO_PTR(uid
), u
);
93 r
= hashmap_put(m
->user_units
, u
->slice
, u
);
97 r
= hashmap_put(m
->user_units
, u
->service
, u
);
106 User
*user_free(User
*u
) {
111 LIST_REMOVE(gc_queue
, u
->manager
->user_gc_queue
, u
);
114 session_free(u
->sessions
);
117 hashmap_remove_value(u
->manager
->user_units
, u
->service
, u
);
120 hashmap_remove_value(u
->manager
->user_units
, u
->slice
, u
);
122 hashmap_remove_value(u
->manager
->users
, UID_TO_PTR(u
->uid
), u
);
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
);
166 fprintf(f
, "SERVICE_JOB=%s\n", u
->service_job
);
169 fprintf(f
, "SLICE_JOB=%s\n", u
->slice_job
);
172 fprintf(f
, "DISPLAY=%s\n", u
->display
->id
);
174 if (dual_timestamp_is_set(&u
->timestamp
))
176 "REALTIME="USEC_FMT
"\n"
177 "MONOTONIC="USEC_FMT
"\n",
178 u
->timestamp
.realtime
,
179 u
->timestamp
.monotonic
);
185 fputs("SESSIONS=", f
);
187 LIST_FOREACH(sessions_by_user
, i
, u
->sessions
) {
196 fputs("\nSEATS=", f
);
198 LIST_FOREACH(sessions_by_user
, i
, u
->sessions
) {
207 fputs(i
->seat
->id
, f
);
210 fputs("\nACTIVE_SESSIONS=", f
);
212 LIST_FOREACH(sessions_by_user
, i
, u
->sessions
) {
213 if (!session_is_active(i
))
224 fputs("\nONLINE_SESSIONS=", f
);
226 LIST_FOREACH(sessions_by_user
, i
, u
->sessions
) {
227 if (session_get_state(i
) == SESSION_CLOSING
)
238 fputs("\nACTIVE_SEATS=", f
);
240 LIST_FOREACH(sessions_by_user
, i
, u
->sessions
) {
241 if (!session_is_active(i
) || !i
->seat
)
249 fputs(i
->seat
->id
, f
);
252 fputs("\nONLINE_SEATS=", f
);
254 LIST_FOREACH(sessions_by_user
, i
, u
->sessions
) {
255 if (session_get_state(i
) == SESSION_CLOSING
|| !i
->seat
)
263 fputs(i
->seat
->id
, f
);
268 r
= fflush_and_check(f
);
272 if (rename(temp_path
, u
->state_file
) < 0) {
280 (void) unlink(u
->state_file
);
283 (void) unlink(temp_path
);
285 return log_error_errno(r
, "Failed to save user data %s: %m", u
->state_file
);
288 int user_save(User
*u
) {
294 return user_save_internal (u
);
297 int user_load(User
*u
) {
298 _cleanup_free_
char *display
= NULL
, *realtime
= NULL
, *monotonic
= NULL
;
304 r
= parse_env_file(u
->state_file
, NEWLINE
,
305 "SERVICE_JOB", &u
->service_job
,
306 "SLICE_JOB", &u
->slice_job
,
308 "REALTIME", &realtime
,
309 "MONOTONIC", &monotonic
,
315 return log_error_errno(r
, "Failed to read %s: %m", u
->state_file
);
319 s
= hashmap_get(u
->manager
->sessions
, display
);
321 if (s
&& s
->display
&& display_is_local(s
->display
))
325 timestamp_deserialize(realtime
, &u
->timestamp
.realtime
);
327 timestamp_deserialize(monotonic
, &u
->timestamp
.monotonic
);
332 static int user_mkdir_runtime_path(User
*u
) {
337 r
= mkdir_safe_label("/run/user", 0755, 0, 0);
339 return log_error_errno(r
, "Failed to create /run/user: %m");
341 if (path_is_mount_point(u
->runtime_path
, 0) <= 0) {
342 _cleanup_free_
char *t
= NULL
;
344 (void) mkdir_label(u
->runtime_path
, 0700);
347 r
= asprintf(&t
, "mode=0700,smackfsroot=*,uid=" UID_FMT
",gid=" GID_FMT
",size=%zu", u
->uid
, u
->gid
, u
->manager
->runtime_dir_size
);
349 r
= asprintf(&t
, "mode=0700,uid=" UID_FMT
",gid=" GID_FMT
",size=%zu", u
->uid
, u
->gid
, u
->manager
->runtime_dir_size
);
355 r
= mount("tmpfs", u
->runtime_path
, "tmpfs", MS_NODEV
|MS_NOSUID
, t
);
357 if (errno
!= EPERM
) {
358 r
= log_error_errno(errno
, "Failed to mount per-user tmpfs directory %s: %m", u
->runtime_path
);
362 /* Lacking permissions, maybe
363 * CAP_SYS_ADMIN-less container? In this case,
364 * just use a normal directory. */
366 r
= chmod_and_chown(u
->runtime_path
, 0700, u
->uid
, u
->gid
);
368 log_error_errno(r
, "Failed to change runtime directory ownership and mode: %m");
373 r
= label_fix(u
->runtime_path
, false, false);
375 log_warning_errno(r
, "Failed to fix label of '%s', ignoring: %m", u
->runtime_path
);
381 /* Try to clean up, but ignore errors */
382 (void) rmdir(u
->runtime_path
);
386 static int user_start_slice(User
*u
) {
387 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
388 const char *description
;
394 u
->slice_job
= mfree(u
->slice_job
);
395 description
= strjoina("User Slice of ", u
->name
);
397 r
= manager_start_slice(
401 "systemd-logind.service",
402 "systemd-user-sessions.service",
403 u
->manager
->user_tasks_max
,
408 else if (!sd_bus_error_has_name(&error
, BUS_ERROR_UNIT_EXISTS
))
409 /* we don't fail due to this, let's try to continue */
410 log_error_errno(r
, "Failed to start user slice %s, ignoring: %s (%s)",
411 u
->slice
, bus_error_message(&error
, r
), error
.name
);
416 static int user_start_service(User
*u
) {
417 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
423 u
->service_job
= mfree(u
->service_job
);
425 r
= manager_start_unit(
431 /* we don't fail due to this, let's try to continue */
432 log_error_errno(r
, "Failed to start user service, ignoring: %s", bus_error_message(&error
, r
));
434 u
->service_job
= job
;
440 int user_start(User
*u
) {
445 if (u
->started
&& !u
->stopping
)
449 * If u->stopping is set, the user is marked for removal and the slice
450 * and service stop-jobs are queued. We have to clear that flag before
451 * queing the start-jobs again. If they succeed, the user object can be
452 * re-used just fine (pid1 takes care of job-ordering and proper
453 * restart), but if they fail, we want to force another user_stop() so
454 * possibly pending units are stopped.
455 * Note that we don't clear u->started, as we have no clue what state
456 * the user is in on failure here. Hence, we pretend the user is
457 * running so it will be properly taken down by GC. However, we clearly
458 * return an error from user_start() in that case, so no further
459 * reference to the user is taken.
464 log_debug("New user %s logged in.", u
->name
);
466 /* Make XDG_RUNTIME_DIR */
467 r
= user_mkdir_runtime_path(u
);
473 r
= user_start_slice(u
);
477 /* Save the user data so far, because pam_systemd will read the
478 * XDG_RUNTIME_DIR out of it while starting up systemd --user.
479 * We need to do user_save_internal() because we have not
480 * "officially" started yet. */
481 user_save_internal(u
);
483 /* Spawn user systemd */
484 r
= user_start_service(u
);
489 if (!dual_timestamp_is_set(&u
->timestamp
))
490 dual_timestamp_get(&u
->timestamp
);
491 user_send_signal(u
, true);
495 /* Save new user data */
501 static int user_stop_slice(User
*u
) {
502 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
508 r
= manager_stop_unit(u
->manager
, u
->slice
, &error
, &job
);
510 log_error("Failed to stop user slice: %s", bus_error_message(&error
, r
));
520 static int user_stop_service(User
*u
) {
521 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
527 r
= manager_stop_unit(u
->manager
, u
->service
, &error
, &job
);
529 log_error("Failed to stop user service: %s", bus_error_message(&error
, r
));
533 free(u
->service_job
);
534 u
->service_job
= job
;
539 static int user_remove_runtime_path(User
*u
) {
544 r
= rm_rf(u
->runtime_path
, 0);
546 log_error_errno(r
, "Failed to remove runtime directory %s: %m", u
->runtime_path
);
548 /* Ignore cases where the directory isn't mounted, as that's
549 * quite possible, if we lacked the permissions to mount
551 r
= umount2(u
->runtime_path
, MNT_DETACH
);
552 if (r
< 0 && errno
!= EINVAL
&& errno
!= ENOENT
)
553 log_error_errno(errno
, "Failed to unmount user runtime directory %s: %m", u
->runtime_path
);
555 r
= rm_rf(u
->runtime_path
, REMOVE_ROOT
);
557 log_error_errno(r
, "Failed to remove runtime directory %s: %m", u
->runtime_path
);
562 int user_stop(User
*u
, bool force
) {
567 /* Stop jobs have already been queued */
573 LIST_FOREACH(sessions_by_user
, s
, u
->sessions
) {
574 k
= session_stop(s
, force
);
580 k
= user_stop_service(u
);
585 k
= user_stop_slice(u
);
596 int user_finalize(User
*u
) {
603 log_debug("User %s logged out.", u
->name
);
605 LIST_FOREACH(sessions_by_user
, s
, u
->sessions
) {
606 k
= session_finalize(s
);
611 /* Kill XDG_RUNTIME_DIR */
612 k
= user_remove_runtime_path(u
);
616 /* Clean SysV + POSIX IPC objects, but only if this is not a system user. Background: in many setups cronjobs
617 * are run in full PAM and thus logind sessions, even if the code run doesn't belong to actual users but to
618 * system components. Since enable RemoveIPC= globally for all users, we need to be a bit careful with such
619 * cases, as we shouldn't accidentally remove a system service's IPC objects while it is running, just because
620 * a cronjob running as the same user just finished. Hence: exclude system users generally from IPC clean-up,
621 * and do it only for normal users. */
622 if (u
->manager
->remove_ipc
&& u
->uid
> SYSTEM_UID_MAX
) {
623 k
= clean_ipc_by_uid(u
->uid
);
628 unlink(u
->state_file
);
629 user_add_to_gc_queue(u
);
632 user_send_signal(u
, false);
639 int user_get_idle_hint(User
*u
, dual_timestamp
*t
) {
641 bool idle_hint
= true;
642 dual_timestamp ts
= DUAL_TIMESTAMP_NULL
;
646 LIST_FOREACH(sessions_by_user
, s
, u
->sessions
) {
650 ih
= session_get_idle_hint(s
, &k
);
656 if (k
.monotonic
< ts
.monotonic
)
662 } else if (idle_hint
) {
664 if (k
.monotonic
> ts
.monotonic
)
675 int user_check_linger_file(User
*u
) {
676 _cleanup_free_
char *cc
= NULL
;
679 cc
= cescape(u
->name
);
683 p
= strjoina("/var/lib/systemd/linger/", cc
);
685 return access(p
, F_OK
) >= 0;
688 bool user_check_gc(User
*u
, bool drop_not_started
) {
691 if (drop_not_started
&& !u
->started
)
697 if (user_check_linger_file(u
) > 0)
700 if (u
->slice_job
&& manager_job_is_active(u
->manager
, u
->slice_job
))
703 if (u
->service_job
&& manager_job_is_active(u
->manager
, u
->service_job
))
709 void user_add_to_gc_queue(User
*u
) {
715 LIST_PREPEND(gc_queue
, u
->manager
->user_gc_queue
, u
);
716 u
->in_gc_queue
= true;
719 UserState
user_get_state(User
*u
) {
727 if (!u
->started
|| u
->slice_job
|| u
->service_job
)
731 bool all_closing
= true;
733 LIST_FOREACH(sessions_by_user
, i
, u
->sessions
) {
736 state
= session_get_state(i
);
737 if (state
== SESSION_ACTIVE
)
739 if (state
!= SESSION_CLOSING
)
743 return all_closing
? USER_CLOSING
: USER_ONLINE
;
746 if (user_check_linger_file(u
) > 0)
747 return USER_LINGERING
;
752 int user_kill(User
*u
, int signo
) {
755 return manager_kill_unit(u
->manager
, u
->slice
, KILL_ALL
, signo
, NULL
);
758 static bool elect_display_filter(Session
*s
) {
759 /* Return true if the session is a candidate for the user’s ‘primary
760 * session’ or ‘display’. */
763 return (s
->class == SESSION_USER
&& !s
->stopping
);
766 static int elect_display_compare(Session
*s1
, Session
*s2
) {
767 /* Indexed by SessionType. Lower numbers mean more preferred. */
768 const int type_ranks
[_SESSION_TYPE_MAX
] = {
769 [SESSION_UNSPECIFIED
] = 0,
772 [SESSION_WAYLAND
] = -3,
777 /* Calculate the partial order relationship between s1 and s2,
778 * returning < 0 if s1 is preferred as the user’s ‘primary session’,
779 * 0 if s1 and s2 are equally preferred or incomparable, or > 0 if s2
782 * s1 or s2 may be NULL. */
786 if ((s1
== NULL
) != (s2
== NULL
))
787 return (s1
== NULL
) - (s2
== NULL
);
789 if (s1
->stopping
!= s2
->stopping
)
790 return s1
->stopping
- s2
->stopping
;
792 if ((s1
->class != SESSION_USER
) != (s2
->class != SESSION_USER
))
793 return (s1
->class != SESSION_USER
) - (s2
->class != SESSION_USER
);
795 if ((s1
->type
== _SESSION_TYPE_INVALID
) != (s2
->type
== _SESSION_TYPE_INVALID
))
796 return (s1
->type
== _SESSION_TYPE_INVALID
) - (s2
->type
== _SESSION_TYPE_INVALID
);
798 if (s1
->type
!= s2
->type
)
799 return type_ranks
[s1
->type
] - type_ranks
[s2
->type
];
804 void user_elect_display(User
*u
) {
809 /* This elects a primary session for each user, which we call
810 * the "display". We try to keep the assignment stable, but we
811 * "upgrade" to better choices. */
812 log_debug("Electing new display for user %s", u
->name
);
814 LIST_FOREACH(sessions_by_user
, s
, u
->sessions
) {
815 if (!elect_display_filter(s
)) {
816 log_debug("Ignoring session %s", s
->id
);
820 if (elect_display_compare(s
, u
->display
) < 0) {
821 log_debug("Choosing session %s in preference to %s", s
->id
, u
->display
? u
->display
->id
: "-");
827 static const char* const user_state_table
[_USER_STATE_MAX
] = {
828 [USER_OFFLINE
] = "offline",
829 [USER_OPENING
] = "opening",
830 [USER_LINGERING
] = "lingering",
831 [USER_ONLINE
] = "online",
832 [USER_ACTIVE
] = "active",
833 [USER_CLOSING
] = "closing"
836 DEFINE_STRING_TABLE_LOOKUP(user_state
, UserState
);
838 int config_parse_tmpfs_size(
840 const char *filename
,
843 unsigned section_line
,
858 /* First, try to parse as percentage */
859 r
= parse_percent(rvalue
);
860 if (r
> 0 && r
< 100)
861 *sz
= physical_memory_scale(r
, 100U);
865 /* If the passed argument was not a percentage, or out of range, parse as byte size */
867 r
= parse_size(rvalue
, 1024, &k
);
868 if (r
< 0 || k
<= 0 || (uint64_t) (size_t) k
!= k
) {
869 log_syntax(unit
, LOG_ERR
, filename
, line
, r
, "Failed to parse size value, ignoring: %s", rvalue
);
873 *sz
= PAGE_ALIGN((size_t) k
);
879 int config_parse_user_tasks_max(
881 const char *filename
,
884 unsigned section_line
,
900 if (isempty(rvalue
)) {
901 *m
= system_tasks_max_scale(DEFAULT_USER_TASKS_MAX_PERCENTAGE
, 100U);
905 if (streq(rvalue
, "infinity")) {
906 *m
= CGROUP_LIMIT_MAX
;
910 /* Try to parse as percentage */
911 r
= parse_percent(rvalue
);
913 k
= system_tasks_max_scale(r
, 100U);
916 /* If the passed argument was not a percentage, or out of range, parse as byte size */
918 r
= safe_atou64(rvalue
, &k
);
920 log_syntax(unit
, LOG_ERR
, filename
, line
, r
, "Failed to parse tasks maximum, ignoring: %s", rvalue
);
925 if (k
<= 0 || k
>= UINT64_MAX
) {
926 log_syntax(unit
, LOG_ERR
, filename
, line
, 0, "Tasks maximum out of range, ignoring: %s", rvalue
);