1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
6 #include "alloc-util.h"
7 #include "bus-common-errors.h"
10 #include "cgroup-util.h"
11 #include "clean-ipc.h"
16 #include "format-util.h"
20 #include "limits-util.h"
21 #include "logind-dbus.h"
22 #include "logind-user-dbus.h"
23 #include "logind-user.h"
24 #include "mkdir-label.h"
25 #include "parse-util.h"
26 #include "path-util.h"
27 #include "percent-util.h"
29 #include "serialize.h"
31 #include "stdio-util.h"
32 #include "string-table.h"
34 #include "tmpfile-util.h"
35 #include "uid-alloc-range.h"
36 #include "unit-name.h"
37 #include "user-util.h"
39 int user_new(User
**ret
,
43 _cleanup_(user_freep
) User
*u
= NULL
;
44 char lu
[DECIMAL_STR_MAX(uid_t
) + 1];
54 if (!uid_is_valid(ur
->uid
))
63 .user_record
= user_record_ref(ur
),
64 .last_session_timestamp
= USEC_INFINITY
,
67 if (asprintf(&u
->state_file
, "/run/systemd/users/" UID_FMT
, ur
->uid
) < 0)
70 if (asprintf(&u
->runtime_path
, "/run/user/" UID_FMT
, ur
->uid
) < 0)
73 xsprintf(lu
, UID_FMT
, ur
->uid
);
74 r
= slice_build_subslice(SPECIAL_USER_SLICE
, lu
, &u
->slice
);
78 r
= unit_name_build("user", lu
, ".service", &u
->service
);
82 r
= unit_name_build("user-runtime-dir", lu
, ".service", &u
->runtime_dir_service
);
86 r
= hashmap_put(m
->users
, UID_TO_PTR(ur
->uid
), u
);
90 r
= hashmap_put(m
->user_units
, u
->slice
, u
);
94 r
= hashmap_put(m
->user_units
, u
->service
, u
);
98 r
= hashmap_put(m
->user_units
, u
->runtime_dir_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
);
119 if (u
->runtime_dir_service
)
120 hashmap_remove_value(u
->manager
->user_units
, u
->runtime_dir_service
, u
);
123 hashmap_remove_value(u
->manager
->user_units
, u
->slice
, u
);
125 hashmap_remove_value(u
->manager
->users
, UID_TO_PTR(u
->user_record
->uid
), u
);
127 sd_event_source_unref(u
->timer_event_source
);
129 u
->service_job
= mfree(u
->service_job
);
131 u
->service
= mfree(u
->service
);
132 u
->runtime_dir_service
= mfree(u
->runtime_dir_service
);
133 u
->slice
= mfree(u
->slice
);
134 u
->runtime_path
= mfree(u
->runtime_path
);
135 u
->state_file
= mfree(u
->state_file
);
137 user_record_unref(u
->user_record
);
142 static int user_save_internal(User
*u
) {
143 _cleanup_(unlink_and_freep
) char *temp_path
= NULL
;
144 _cleanup_fclose_
FILE *f
= NULL
;
148 assert(u
->state_file
);
150 r
= mkdir_safe_label("/run/systemd/users", 0755, 0, 0, MKDIR_WARN_MODE
);
154 r
= fopen_temporary(u
->state_file
, &f
, &temp_path
);
158 (void) fchmod(fileno(f
), 0644);
161 "# This is private data. Do not parse.\n"
163 "STATE=%s\n" /* friendly user-facing state */
164 "STOPPING=%s\n", /* low-level state */
165 u
->user_record
->user_name
,
166 user_state_to_string(user_get_state(u
)),
167 yes_no(u
->stopping
));
169 /* LEGACY: no-one reads RUNTIME= anymore, drop it at some point */
171 fprintf(f
, "RUNTIME=%s\n", u
->runtime_path
);
174 fprintf(f
, "SERVICE_JOB=%s\n", u
->service_job
);
177 fprintf(f
, "DISPLAY=%s\n", u
->display
->id
);
179 if (dual_timestamp_is_set(&u
->timestamp
))
181 "REALTIME="USEC_FMT
"\n"
182 "MONOTONIC="USEC_FMT
"\n",
183 u
->timestamp
.realtime
,
184 u
->timestamp
.monotonic
);
186 if (u
->last_session_timestamp
!= USEC_INFINITY
)
187 fprintf(f
, "LAST_SESSION_TIMESTAMP=" USEC_FMT
"\n",
188 u
->last_session_timestamp
);
193 fputs("SESSIONS=", f
);
195 LIST_FOREACH(sessions_by_user
, i
, u
->sessions
) {
204 fputs("\nSEATS=", f
);
206 LIST_FOREACH(sessions_by_user
, i
, u
->sessions
) {
215 fputs(i
->seat
->id
, f
);
218 fputs("\nACTIVE_SESSIONS=", f
);
220 LIST_FOREACH(sessions_by_user
, i
, u
->sessions
) {
221 if (!session_is_active(i
))
232 fputs("\nONLINE_SESSIONS=", f
);
234 LIST_FOREACH(sessions_by_user
, i
, u
->sessions
) {
235 if (session_get_state(i
) == SESSION_CLOSING
)
246 fputs("\nACTIVE_SEATS=", f
);
248 LIST_FOREACH(sessions_by_user
, i
, u
->sessions
) {
249 if (!session_is_active(i
) || !i
->seat
)
257 fputs(i
->seat
->id
, f
);
260 fputs("\nONLINE_SEATS=", f
);
262 LIST_FOREACH(sessions_by_user
, i
, u
->sessions
) {
263 if (session_get_state(i
) == SESSION_CLOSING
|| !i
->seat
)
271 fputs(i
->seat
->id
, f
);
276 r
= fflush_and_check(f
);
280 if (rename(temp_path
, u
->state_file
) < 0) {
285 temp_path
= mfree(temp_path
);
289 (void) unlink(u
->state_file
);
291 return log_error_errno(r
, "Failed to save user data %s: %m", u
->state_file
);
294 int user_save(User
*u
) {
300 return user_save_internal(u
);
303 int user_load(User
*u
) {
304 _cleanup_free_
char *realtime
= NULL
, *monotonic
= NULL
, *stopping
= NULL
, *last_session_timestamp
= NULL
;
309 r
= parse_env_file(NULL
, u
->state_file
,
310 "SERVICE_JOB", &u
->service_job
,
311 "STOPPING", &stopping
,
312 "REALTIME", &realtime
,
313 "MONOTONIC", &monotonic
,
314 "LAST_SESSION_TIMESTAMP", &last_session_timestamp
);
318 return log_error_errno(r
, "Failed to read %s: %m", u
->state_file
);
321 r
= parse_boolean(stopping
);
323 log_debug_errno(r
, "Failed to parse 'STOPPING' boolean: %s", stopping
);
329 (void) deserialize_usec(realtime
, &u
->timestamp
.realtime
);
331 (void) deserialize_usec(monotonic
, &u
->timestamp
.monotonic
);
332 if (last_session_timestamp
)
333 (void) deserialize_usec(last_session_timestamp
, &u
->last_session_timestamp
);
338 static void user_start_service(User
*u
) {
339 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
344 /* Start the service containing the "systemd --user" instance (user@.service). Note that we don't explicitly
345 * start the per-user slice or the systemd-runtime-dir@.service instance, as those are pulled in both by
346 * user@.service and the session scopes as dependencies. */
348 u
->service_job
= mfree(u
->service_job
);
350 r
= manager_start_unit(u
->manager
, u
->service
, &error
, &u
->service_job
);
352 log_full_errno(sd_bus_error_has_name(&error
, BUS_ERROR_UNIT_MASKED
) ? LOG_DEBUG
: LOG_WARNING
, r
,
353 "Failed to start user service '%s', ignoring: %s", u
->service
, bus_error_message(&error
, r
));
356 static int update_slice_callback(sd_bus_message
*m
, void *userdata
, sd_bus_error
*ret_error
) {
357 _cleanup_(user_record_unrefp
) UserRecord
*ur
= ASSERT_PTR(userdata
);
358 const sd_bus_error
*e
;
363 e
= sd_bus_message_get_error(m
);
365 r
= sd_bus_error_get_errno(e
);
367 "Failed to update slice of %s, ignoring: %s",
369 bus_error_message(e
, r
));
374 log_debug("Successfully set slice parameters of %s.", ur
->user_name
);
378 static int user_update_slice(User
*u
) {
379 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
;
384 if (u
->user_record
->tasks_max
== UINT64_MAX
&&
385 u
->user_record
->memory_high
== UINT64_MAX
&&
386 u
->user_record
->memory_max
== UINT64_MAX
&&
387 u
->user_record
->cpu_weight
== UINT64_MAX
&&
388 u
->user_record
->io_weight
== UINT64_MAX
)
391 r
= sd_bus_message_new_method_call(
394 "org.freedesktop.systemd1",
395 "/org/freedesktop/systemd1",
396 "org.freedesktop.systemd1.Manager",
397 "SetUnitProperties");
399 return bus_log_create_error(r
);
401 r
= sd_bus_message_append(m
, "sb", u
->slice
, true);
403 return bus_log_create_error(r
);
405 r
= sd_bus_message_open_container(m
, 'a', "(sv)");
407 return bus_log_create_error(r
);
413 { "TasksMax", u
->user_record
->tasks_max
},
414 { "MemoryMax", u
->user_record
->memory_max
},
415 { "MemoryHigh", u
->user_record
->memory_high
},
416 { "CPUWeight", u
->user_record
->cpu_weight
},
417 { "IOWeight", u
->user_record
->io_weight
},
420 for (size_t i
= 0; i
< ELEMENTSOF(settings
); i
++)
421 if (settings
[i
].value
!= UINT64_MAX
) {
422 r
= sd_bus_message_append(m
, "(sv)", settings
[i
].name
, "t", settings
[i
].value
);
424 return bus_log_create_error(r
);
427 r
= sd_bus_message_close_container(m
);
429 return bus_log_create_error(r
);
431 r
= sd_bus_call_async(u
->manager
->bus
, NULL
, m
, update_slice_callback
, u
->user_record
, 0);
433 return log_error_errno(r
, "Failed to change user slice properties: %m");
435 /* Ref the user record pointer, so that the slot keeps it pinned */
436 user_record_ref(u
->user_record
);
441 int user_start(User
*u
) {
444 if (u
->started
&& !u
->stopping
)
447 /* If u->stopping is set, the user is marked for removal and service stop-jobs are queued. We have to clear
448 * that flag before queueing the start-jobs again. If they succeed, the user object can be re-used just fine
449 * (pid1 takes care of job-ordering and proper restart), but if they fail, we want to force another user_stop()
450 * so possibly pending units are stopped. */
454 log_debug("Starting services for new user %s.", u
->user_record
->user_name
);
456 /* Save the user data so far, because pam_systemd will read the XDG_RUNTIME_DIR out of it while starting up
457 * systemd --user. We need to do user_save_internal() because we have not "officially" started yet. */
458 user_save_internal(u
);
460 /* Set slice parameters */
461 (void) user_update_slice(u
);
463 /* Start user@UID.service */
464 user_start_service(u
);
467 if (!dual_timestamp_is_set(&u
->timestamp
))
468 dual_timestamp_get(&u
->timestamp
);
469 user_send_signal(u
, true);
473 /* Save new user data */
479 static void user_stop_service(User
*u
, bool force
) {
480 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
486 /* The reverse of user_start_service(). Note that we only stop user@UID.service here, and let StopWhenUnneeded=
487 * deal with the slice and the user-runtime-dir@.service instance. */
489 u
->service_job
= mfree(u
->service_job
);
491 r
= manager_stop_unit(u
->manager
, u
->service
, force
? "replace" : "fail", &error
, &u
->service_job
);
493 log_warning_errno(r
, "Failed to stop user service '%s', ignoring: %s", u
->service
, bus_error_message(&error
, r
));
496 int user_stop(User
*u
, bool force
) {
501 /* This is called whenever we begin with tearing down a user record. It's called in two cases: explicit API
502 * request to do so via the bus (in which case 'force' is true) and automatically due to GC, if there's no
503 * session left pinning it (in which case 'force' is false). Note that this just initiates tearing down of the
504 * user, the User object will remain in memory until user_finalize() is called, see below. */
509 if (u
->stopping
) { /* Stop jobs have already been queued */
514 LIST_FOREACH(sessions_by_user
, s
, u
->sessions
) {
517 k
= session_stop(s
, force
);
522 user_stop_service(u
, force
);
531 int user_finalize(User
*u
) {
536 /* Called when the user is really ready to be freed, i.e. when all unit stop jobs and suchlike for it are
537 * done. This is called as a result of an earlier user_done() when all jobs are completed. */
540 log_debug("User %s logged out.", u
->user_record
->user_name
);
542 LIST_FOREACH(sessions_by_user
, s
, u
->sessions
) {
543 k
= session_finalize(s
);
548 /* Clean SysV + POSIX IPC objects, but only if this is not a system user. Background: in many setups cronjobs
549 * are run in full PAM and thus logind sessions, even if the code run doesn't belong to actual users but to
550 * system components. Since enable RemoveIPC= globally for all users, we need to be a bit careful with such
551 * cases, as we shouldn't accidentally remove a system service's IPC objects while it is running, just because
552 * a cronjob running as the same user just finished. Hence: exclude system users generally from IPC clean-up,
553 * and do it only for normal users. */
554 if (u
->manager
->remove_ipc
&& !uid_is_system(u
->user_record
->uid
)) {
555 k
= clean_ipc_by_uid(u
->user_record
->uid
);
560 (void) unlink(u
->state_file
);
561 user_add_to_gc_queue(u
);
564 user_send_signal(u
, false);
571 int user_get_idle_hint(User
*u
, dual_timestamp
*t
) {
572 bool idle_hint
= true;
573 dual_timestamp ts
= DUAL_TIMESTAMP_NULL
;
577 LIST_FOREACH(sessions_by_user
, s
, u
->sessions
) {
581 ih
= session_get_idle_hint(s
, &k
);
587 if (k
.monotonic
< ts
.monotonic
)
593 } else if (idle_hint
) {
595 if (k
.monotonic
> ts
.monotonic
)
606 int user_check_linger_file(User
*u
) {
607 _cleanup_free_
char *cc
= NULL
;
610 cc
= cescape(u
->user_record
->user_name
);
614 p
= strjoina("/var/lib/systemd/linger/", cc
);
615 if (access(p
, F_OK
) < 0) {
625 static bool user_unit_active(User
*u
) {
629 assert(u
->runtime_dir_service
);
632 FOREACH_STRING(i
, u
->service
, u
->runtime_dir_service
, u
->slice
) {
633 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
635 r
= manager_unit_is_active(u
->manager
, i
, &error
);
637 log_debug_errno(r
, "Failed to determine whether unit '%s' is active, ignoring: %s", i
, bus_error_message(&error
, r
));
645 static usec_t
user_get_stop_delay(User
*u
) {
648 if (u
->user_record
->stop_delay_usec
!= UINT64_MAX
)
649 return u
->user_record
->stop_delay_usec
;
651 if (user_record_removable(u
->user_record
) > 0)
652 return 0; /* For removable users lower the stop delay to zero */
654 return u
->manager
->user_stop_delay
;
657 bool user_may_gc(User
*u
, bool drop_not_started
) {
662 if (drop_not_started
&& !u
->started
)
668 if (u
->last_session_timestamp
!= USEC_INFINITY
) {
669 usec_t user_stop_delay
;
671 /* All sessions have been closed. Let's see if we shall leave the user record around for a bit */
673 user_stop_delay
= user_get_stop_delay(u
);
675 if (user_stop_delay
== USEC_INFINITY
)
676 return false; /* Leave it around forever! */
677 if (user_stop_delay
> 0 &&
678 now(CLOCK_MONOTONIC
) < usec_add(u
->last_session_timestamp
, user_stop_delay
))
679 return false; /* Leave it around for a bit longer. */
682 /* Is this a user that shall stay around forever ("linger")? Before we say "no" to GC'ing for lingering users, let's check
683 * if any of the three units that we maintain for this user is still around. If none of them is,
684 * there's no need to keep this user around even if lingering is enabled. */
685 if (user_check_linger_file(u
) > 0 && user_unit_active(u
))
688 /* Check if our job is still pending */
689 if (u
->service_job
) {
690 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
692 r
= manager_job_is_active(u
->manager
, u
->service_job
, &error
);
694 log_debug_errno(r
, "Failed to determine whether job '%s' is pending, ignoring: %s", u
->service_job
, bus_error_message(&error
, r
));
699 /* Note that we don't care if the three units we manage for each user object are up or not, as we are managing
700 * their state rather than tracking it. */
705 void user_add_to_gc_queue(User
*u
) {
711 LIST_PREPEND(gc_queue
, u
->manager
->user_gc_queue
, u
);
712 u
->in_gc_queue
= true;
715 UserState
user_get_state(User
*u
) {
721 if (!u
->started
|| u
->service_job
)
725 bool all_closing
= true;
727 LIST_FOREACH(sessions_by_user
, i
, u
->sessions
) {
730 state
= session_get_state(i
);
731 if (state
== SESSION_ACTIVE
)
733 if (state
!= SESSION_CLOSING
)
737 return all_closing
? USER_CLOSING
: USER_ONLINE
;
740 if (user_check_linger_file(u
) > 0 && user_unit_active(u
))
741 return USER_LINGERING
;
746 int user_kill(User
*u
, int signo
) {
749 return manager_kill_unit(u
->manager
, u
->slice
, KILL_ALL
, signo
, NULL
);
752 static bool elect_display_filter(Session
*s
) {
753 /* Return true if the session is a candidate for the user’s ‘primary session’ or ‘display’. */
756 return IN_SET(s
->class, SESSION_USER
, SESSION_GREETER
) && s
->started
&& !s
->stopping
;
759 static int elect_display_compare(Session
*s1
, Session
*s2
) {
760 /* Indexed by SessionType. Lower numbers mean more preferred. */
761 static const int type_ranks
[_SESSION_TYPE_MAX
] = {
762 [SESSION_UNSPECIFIED
] = 0,
765 [SESSION_WAYLAND
] = -3,
770 /* Calculate the partial order relationship between s1 and s2,
771 * returning < 0 if s1 is preferred as the user’s ‘primary session’,
772 * 0 if s1 and s2 are equally preferred or incomparable, or > 0 if s2
775 * s1 or s2 may be NULL. */
779 if ((s1
== NULL
) != (s2
== NULL
))
780 return (s1
== NULL
) - (s2
== NULL
);
782 if (s1
->stopping
!= s2
->stopping
)
783 return s1
->stopping
- s2
->stopping
;
785 if ((s1
->class != SESSION_USER
) != (s2
->class != SESSION_USER
))
786 return (s1
->class != SESSION_USER
) - (s2
->class != SESSION_USER
);
788 if ((s1
->type
== _SESSION_TYPE_INVALID
) != (s2
->type
== _SESSION_TYPE_INVALID
))
789 return (s1
->type
== _SESSION_TYPE_INVALID
) - (s2
->type
== _SESSION_TYPE_INVALID
);
791 if (s1
->type
!= s2
->type
)
792 return type_ranks
[s1
->type
] - type_ranks
[s2
->type
];
797 void user_elect_display(User
*u
) {
800 /* This elects a primary session for each user, which we call the "display". We try to keep the assignment
801 * stable, but we "upgrade" to better choices. */
802 log_debug("Electing new display for user %s", u
->user_record
->user_name
);
804 LIST_FOREACH(sessions_by_user
, s
, u
->sessions
) {
805 if (!elect_display_filter(s
)) {
806 log_debug("Ignoring session %s", s
->id
);
810 if (elect_display_compare(s
, u
->display
) < 0) {
811 log_debug("Choosing session %s in preference to %s", s
->id
, u
->display
? u
->display
->id
: "-");
817 static int user_stop_timeout_callback(sd_event_source
*es
, uint64_t usec
, void *userdata
) {
818 User
*u
= ASSERT_PTR(userdata
);
820 user_add_to_gc_queue(u
);
825 void user_update_last_session_timer(User
*u
) {
826 usec_t user_stop_delay
;
832 /* There are sessions, turn off the timer */
833 u
->last_session_timestamp
= USEC_INFINITY
;
834 u
->timer_event_source
= sd_event_source_unref(u
->timer_event_source
);
838 if (u
->last_session_timestamp
!= USEC_INFINITY
)
839 return; /* Timer already started */
841 u
->last_session_timestamp
= now(CLOCK_MONOTONIC
);
843 assert(!u
->timer_event_source
);
845 user_stop_delay
= user_get_stop_delay(u
);
846 if (!timestamp_is_set(user_stop_delay
))
849 if (sd_event_get_state(u
->manager
->event
) == SD_EVENT_FINISHED
) {
850 log_debug("Not allocating user stop timeout, since we are already exiting.");
854 r
= sd_event_add_time(u
->manager
->event
,
855 &u
->timer_event_source
,
857 usec_add(u
->last_session_timestamp
, user_stop_delay
), 0,
858 user_stop_timeout_callback
, u
);
860 log_warning_errno(r
, "Failed to enqueue user stop event source, ignoring: %m");
863 log_debug("Last session of user '%s' logged out, terminating user context in %s.",
864 u
->user_record
->user_name
,
865 FORMAT_TIMESPAN(user_stop_delay
, USEC_PER_MSEC
));
868 static const char* const user_state_table
[_USER_STATE_MAX
] = {
869 [USER_OFFLINE
] = "offline",
870 [USER_OPENING
] = "opening",
871 [USER_LINGERING
] = "lingering",
872 [USER_ONLINE
] = "online",
873 [USER_ACTIVE
] = "active",
874 [USER_CLOSING
] = "closing"
877 DEFINE_STRING_TABLE_LOOKUP(user_state
, UserState
);
879 int config_parse_tmpfs_size(
881 const char *filename
,
884 unsigned section_line
,
891 uint64_t *sz
= ASSERT_PTR(data
);
898 /* First, try to parse as percentage */
899 r
= parse_permyriad(rvalue
);
901 *sz
= physical_memory_scale(r
, 10000U);
905 /* If the passed argument was not a percentage, or out of range, parse as byte size */
907 r
= parse_size(rvalue
, 1024, &k
);
908 if (r
>= 0 && (k
<= 0 || (uint64_t) (size_t) k
!= k
))
911 log_syntax(unit
, LOG_WARNING
, filename
, line
, r
, "Failed to parse size value '%s', ignoring: %m", rvalue
);
915 *sz
= PAGE_ALIGN((size_t) k
);
921 int config_parse_compat_user_tasks_max(
923 const char *filename
,
926 unsigned section_line
,
937 log_syntax(unit
, LOG_NOTICE
, filename
, line
, 0,
938 "Support for option %s= has been removed.",
940 log_info("Hint: try creating /etc/systemd/system/user-.slice.d/50-limits.conf with:\n"