1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
4 This file is part of systemd.
6 Copyright 2011 Lennart Poettering
8 systemd is free software; you can redistribute it and/or modify it
9 under the terms of the GNU Lesser General Public License as published by
10 the Free Software Foundation; either version 2.1 of the License, or
11 (at your option) any later version.
13 systemd is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 Lesser General Public License for more details.
18 You should have received a copy of the GNU Lesser General Public License
19 along with systemd; If not, see <http://www.gnu.org/licenses/>.
28 #include <sys/ioctl.h>
31 #include "sd-messages.h"
34 #include "path-util.h"
38 #include "bus-error.h"
39 #include "cgroup-util.h"
41 #include "logind-session.h"
42 #include "formats-util.h"
44 static void session_remove_fifo(Session *s);
46 Session* session_new(Manager *m, const char *id) {
51 assert(session_id_valid(id));
57 s->state_file = strappend("/run/systemd/sessions/", id);
63 s->devices = hashmap_new(&devt_hash_ops);
70 s->id = basename(s->state_file);
72 if (hashmap_put(m->sessions, s->id, s) < 0) {
73 hashmap_free(s->devices);
86 void session_free(Session *s) {
92 LIST_REMOVE(gc_queue, s->manager->session_gc_queue, s);
94 s->timer_event_source = sd_event_source_unref(s->timer_event_source);
96 session_remove_fifo(s);
98 session_drop_controller(s);
100 while ((sd = hashmap_first(s->devices)))
101 session_device_free(sd);
103 hashmap_free(s->devices);
106 LIST_REMOVE(sessions_by_user, s->user->sessions, s);
108 if (s->user->display == s)
109 s->user->display = NULL;
113 if (s->seat->active == s)
114 s->seat->active = NULL;
115 if (s->seat->pending_switch == s)
116 s->seat->pending_switch = NULL;
118 seat_evict_position(s->seat, s);
119 LIST_REMOVE(sessions_by_seat, s->seat->sessions, s);
122 sd_bus_message_unref(s->create_message);
126 free(s->remote_host);
127 free(s->remote_user);
131 hashmap_remove(s->manager->sessions, s->id);
137 void session_set_user(Session *s, User *u) {
142 LIST_PREPEND(sessions_by_user, u->sessions, s);
145 int session_save(Session *s) {
146 _cleanup_free_ char *temp_path = NULL;
147 _cleanup_fclose_ FILE *f = NULL;
158 r = mkdir_safe_label("/run/systemd/sessions", 0755, 0, 0);
162 r = fopen_temporary(s->state_file, &f, &temp_path);
168 fchmod(fileno(f), 0644);
171 "# This is private data. Do not parse.\n"
179 session_is_active(s),
180 session_state_to_string(session_get_state(s)),
184 fprintf(f, "TYPE=%s\n", session_type_to_string(s->type));
187 fprintf(f, "CLASS=%s\n", session_class_to_string(s->class));
190 fprintf(f, "FIFO=%s\n", s->fifo_path);
193 fprintf(f, "SEAT=%s\n", s->seat->id);
196 fprintf(f, "TTY=%s\n", s->tty);
199 fprintf(f, "DISPLAY=%s\n", s->display);
201 if (s->remote_host) {
202 _cleanup_free_ char *escaped;
204 escaped = cescape(s->remote_host);
210 fprintf(f, "REMOTE_HOST=%s\n", escaped);
213 if (s->remote_user) {
214 _cleanup_free_ char *escaped;
216 escaped = cescape(s->remote_user);
222 fprintf(f, "REMOTE_USER=%s\n", escaped);
226 _cleanup_free_ char *escaped;
228 escaped = cescape(s->service);
234 fprintf(f, "SERVICE=%s\n", escaped);
238 _cleanup_free_ char *escaped;
241 escaped = cescape(s->desktop);
247 fprintf(f, "DESKTOP=%s\n", escaped);
250 if (s->seat && seat_has_vts(s->seat))
251 fprintf(f, "VTNR=%u\n", s->vtnr);
254 fprintf(f, "POS=%u\n", s->pos);
257 fprintf(f, "LEADER="PID_FMT"\n", s->leader);
260 fprintf(f, "AUDIT=%"PRIu32"\n", s->audit_id);
262 if (dual_timestamp_is_set(&s->timestamp))
264 "REALTIME="USEC_FMT"\n"
265 "MONOTONIC="USEC_FMT"\n",
266 s->timestamp.realtime,
267 s->timestamp.monotonic);
270 fprintf(f, "CONTROLLER=%s\n", s->controller);
274 if (ferror(f) || rename(temp_path, s->state_file) < 0) {
276 unlink(s->state_file);
282 log_error_errno(r, "Failed to save session data %s: %m", s->state_file);
287 int session_load(Session *s) {
288 _cleanup_free_ char *remote = NULL,
305 r = parse_env_file(s->state_file, NEWLINE,
307 "FIFO", &s->fifo_path,
310 "DISPLAY", &s->display,
311 "REMOTE_HOST", &s->remote_host,
312 "REMOTE_USER", &s->remote_user,
313 "SERVICE", &s->service,
314 "DESKTOP", &s->desktop,
322 "REALTIME", &realtime,
323 "MONOTONIC", &monotonic,
324 "CONTROLLER", &controller,
328 return log_error_errno(r, "Failed to read %s: %m", s->state_file);
335 log_error("UID not specified for session %s", s->id);
339 r = parse_uid(uid, &u);
341 log_error("Failed to parse UID value %s for session %s.", uid, s->id);
345 user = hashmap_get(s->manager->users, UID_TO_PTR(u));
347 log_error("User of session %s not known.", s->id);
351 session_set_user(s, user);
355 k = parse_boolean(remote);
361 safe_atou(vtnr, &s->vtnr);
363 if (seat && !s->seat) {
366 o = hashmap_get(s->manager->seats, seat);
368 r = seat_attach_session(o, s);
370 log_error("Cannot attach session %s to seat %s", s->id, seat);
373 if (!s->seat || !seat_has_vts(s->seat))
376 if (pos && s->seat) {
379 safe_atou(pos, &npos);
380 seat_claim_position(s->seat, s, npos);
384 k = parse_pid(leader, &s->leader);
386 audit_session_from_pid(s->leader, &s->audit_id);
392 t = session_type_from_string(type);
400 c = session_class_from_string(class);
405 if (state && streq(state, "closing"))
411 /* If we open an unopened pipe for reading we will not
412 get an EOF. to trigger an EOF we hence open it for
413 writing, but close it right away which then will
414 trigger the EOF. This will happen immediately if no
415 other process has the FIFO open for writing, i. e.
416 when the session died before logind (re)started. */
418 fd = session_create_fifo(s);
423 unsigned long long l;
424 if (sscanf(realtime, "%llu", &l) > 0)
425 s->timestamp.realtime = l;
429 unsigned long long l;
430 if (sscanf(monotonic, "%llu", &l) > 0)
431 s->timestamp.monotonic = l;
435 if (bus_name_has_owner(s->manager->bus, controller, NULL) > 0)
436 session_set_controller(s, controller, false);
438 session_restore_vt(s);
444 int session_activate(Session *s) {
445 unsigned int num_pending;
453 if (s->seat->active == s)
456 /* on seats with VTs, we let VTs manage session-switching */
457 if (seat_has_vts(s->seat)) {
461 return chvt(s->vtnr);
464 /* On seats without VTs, we implement session-switching in logind. We
465 * try to pause all session-devices and wait until the session
466 * controller acknowledged them. Once all devices are asleep, we simply
467 * switch the active session and be done.
468 * We save the session we want to switch to in seat->pending_switch and
469 * seat_complete_switch() will perform the final switch. */
471 s->seat->pending_switch = s;
473 /* if no devices are running, immediately perform the session switch */
474 num_pending = session_device_try_pause_all(s);
476 seat_complete_switch(s->seat);
481 static int session_start_cgroup(Session *s) {
486 assert(s->leader > 0);
488 /* First, create our own group */
489 r = cg_create(SYSTEMD_CGROUP_CONTROLLER, s->id);
491 return log_error_errno(r, "Failed to create cgroup %s: %m", s->id);
493 r = cg_attach(SYSTEMD_CGROUP_CONTROLLER, s->id, s->leader);
495 log_warning_errno(r, "Failed to attach PID %d to cgroup %s: %m", s->leader, s->id);
500 int session_start(Session *s) {
511 r = user_start(s->user);
515 r = session_start_cgroup(s);
519 log_struct(s->class == SESSION_BACKGROUND ? LOG_DEBUG : LOG_INFO,
520 LOG_MESSAGE_ID(SD_MESSAGE_SESSION_START),
521 "SESSION_ID=%s", s->id,
522 "USER_ID=%s", s->user->name,
523 "LEADER="PID_FMT, s->leader,
524 LOG_MESSAGE("New session %s of user %s.", s->id, s->user->name),
527 if (!dual_timestamp_is_set(&s->timestamp))
528 dual_timestamp_get(&s->timestamp);
531 seat_read_active_vt(s->seat);
535 user_elect_display(s->user);
544 session_send_signal(s, true);
545 user_send_changed(s->user, "Sessions", "Display", NULL);
547 if (s->seat->active == s)
548 seat_send_changed(s->seat, "Sessions", "ActiveSession", NULL);
550 seat_send_changed(s->seat, "Sessions", NULL);
556 static int session_stop_cgroup(Session *s, bool force) {
557 _cleanup_bus_error_free_ sd_bus_error error = SD_BUS_ERROR_NULL;
562 if (force || manager_shall_kill(s->manager, s->user->name)) {
563 r = session_kill(s, KILL_ALL, SIGTERM);
571 int session_stop(Session *s, bool force) {
579 s->timer_event_source = sd_event_source_unref(s->timer_event_source);
581 /* We are going down, don't care about FIFOs anymore */
582 session_remove_fifo(s);
585 r = session_stop_cgroup(s, force);
589 user_elect_display(s->user);
597 int session_finalize(Session *s) {
607 log_struct(s->class == SESSION_BACKGROUND ? LOG_DEBUG : LOG_INFO,
608 LOG_MESSAGE_ID(SD_MESSAGE_SESSION_STOP),
609 "SESSION_ID=%s", s->id,
610 "USER_ID=%s", s->user->name,
611 "LEADER="PID_FMT, s->leader,
612 LOG_MESSAGE("Removed session %s.", s->id),
615 s->timer_event_source = sd_event_source_unref(s->timer_event_source);
617 /* Kill session devices */
618 while ((sd = hashmap_first(s->devices)))
619 session_device_free(sd);
621 unlink(s->state_file);
622 session_add_to_gc_queue(s);
623 user_add_to_gc_queue(s->user);
626 session_send_signal(s, false);
631 if (s->seat->active == s)
632 seat_set_active(s->seat, NULL);
635 seat_send_changed(s->seat, "Sessions", NULL);
639 user_send_changed(s->user, "Sessions", "Display", NULL);
644 int session_release(Session *s) {
647 if (!s->started || s->stopping)
650 if (s->timer_event_source)
653 /* In systemd, session release is triggered by user jobs
654 dying. In elogind we don't have that so go ahead and stop
656 return session_stop(s, false);
659 bool session_is_active(Session *s) {
665 return s->seat->active == s;
668 static int get_tty_atime(const char *tty, usec_t *atime) {
669 _cleanup_free_ char *p = NULL;
675 if (!path_is_absolute(tty)) {
676 p = strappend("/dev/", tty);
681 } else if (!path_startswith(tty, "/dev/"))
684 if (lstat(tty, &st) < 0)
687 *atime = timespec_load(&st.st_atim);
691 static int get_process_ctty_atime(pid_t pid, usec_t *atime) {
692 _cleanup_free_ char *p = NULL;
698 r = get_ctty(pid, NULL, &p);
702 return get_tty_atime(p, atime);
705 int session_get_idle_hint(Session *s, dual_timestamp *t) {
711 /* Explicit idle hint is set */
714 *t = s->idle_hint_timestamp;
719 /* Graphical sessions should really implement a real
724 /* For sessions with an explicitly configured tty, let's check
727 r = get_tty_atime(s->tty, &atime);
732 /* For sessions with a leader but no explicitly configured
733 * tty, let's check the controlling tty of the leader */
735 r = get_process_ctty_atime(s->leader, &atime);
742 *t = s->idle_hint_timestamp;
748 dual_timestamp_from_realtime(t, atime);
750 n = now(CLOCK_REALTIME);
752 if (s->manager->idle_action_usec <= 0)
755 return atime + s->manager->idle_action_usec <= n;
758 void session_set_idle_hint(Session *s, bool b) {
761 if (s->idle_hint == b)
765 dual_timestamp_get(&s->idle_hint_timestamp);
767 session_send_changed(s, "IdleHint", "IdleSinceHint", "IdleSinceHintMonotonic", NULL);
770 seat_send_changed(s->seat, "IdleHint", "IdleSinceHint", "IdleSinceHintMonotonic", NULL);
772 user_send_changed(s->user, "IdleHint", "IdleSinceHint", "IdleSinceHintMonotonic", NULL);
773 manager_send_changed(s->manager, "IdleHint", "IdleSinceHint", "IdleSinceHintMonotonic", NULL);
776 static int session_dispatch_fifo(sd_event_source *es, int fd, uint32_t revents, void *userdata) {
777 Session *s = userdata;
780 assert(s->fifo_fd == fd);
782 /* EOF on the FIFO means the session died abnormally. */
784 session_remove_fifo(s);
785 session_stop(s, false);
790 int session_create_fifo(Session *s) {
797 r = mkdir_safe_label("/run/systemd/sessions", 0755, 0, 0);
801 if (asprintf(&s->fifo_path, "/run/systemd/sessions/%s.ref", s->id) < 0)
804 if (mkfifo(s->fifo_path, 0600) < 0 && errno != EEXIST)
808 /* Open reading side */
809 if (s->fifo_fd < 0) {
810 s->fifo_fd = open(s->fifo_path, O_RDONLY|O_CLOEXEC|O_NDELAY);
816 if (!s->fifo_event_source) {
817 r = sd_event_add_io(s->manager->event, &s->fifo_event_source, s->fifo_fd, 0, session_dispatch_fifo, s);
821 r = sd_event_source_set_priority(s->fifo_event_source, SD_EVENT_PRIORITY_IDLE);
826 /* Open writing side */
827 r = open(s->fifo_path, O_WRONLY|O_CLOEXEC|O_NDELAY);
834 static void session_remove_fifo(Session *s) {
837 s->fifo_event_source = sd_event_source_unref(s->fifo_event_source);
838 s->fifo_fd = safe_close(s->fifo_fd);
841 unlink(s->fifo_path);
847 bool session_check_gc(Session *s, bool drop_not_started) {
850 if (drop_not_started && !s->started)
856 if (s->fifo_fd >= 0) {
857 if (pipe_eof(s->fifo_fd) <= 0)
861 if (cg_is_empty_recursive (SYSTEMD_CGROUP_CONTROLLER, s->id, false) > 0)
867 void session_add_to_gc_queue(Session *s) {
873 LIST_PREPEND(gc_queue, s->manager->session_gc_queue, s);
874 s->in_gc_queue = true;
877 SessionState session_get_state(Session *s) {
880 /* always check closing first */
881 if (s->stopping || s->timer_event_source)
882 return SESSION_CLOSING;
885 return SESSION_OPENING;
887 if (session_is_active(s))
888 return SESSION_ACTIVE;
890 return SESSION_ONLINE;
893 int session_kill(Session *s, KillWho who, int signo) {
896 if (who == KILL_LEADER) {
900 /* FIXME: verify that leader is in cgroup? */
902 if (kill(s->leader, signo) < 0) {
903 return log_error_errno(errno, "Failed to kill process leader %d for session %s: %m", s->leader, s->id);
907 bool sigcont = false;
908 bool ignore_self = true;
910 return cg_kill_recursive (SYSTEMD_CGROUP_CONTROLLER, s->id, signo,
911 sigcont, ignore_self, rem, NULL);
915 static int session_open_vt(Session *s) {
916 char path[sizeof("/dev/tty") + DECIMAL_STR_MAX(s->vtnr)];
924 sprintf(path, "/dev/tty%u", s->vtnr);
925 s->vtfd = open(path, O_RDWR | O_CLOEXEC | O_NONBLOCK | O_NOCTTY);
927 return log_error_errno(errno, "cannot open VT %s of session %s: %m", path, s->id);
932 int session_prepare_vt(Session *s) {
934 struct vt_mode mode = { 0 };
939 vt = session_open_vt(s);
943 r = fchown(vt, s->user->uid, -1);
946 log_error_errno(errno, "Cannot change owner of /dev/tty%u: %m", s->vtnr);
950 r = ioctl(vt, KDSKBMODE, K_OFF);
953 log_error_errno(errno, "Cannot set K_OFF on /dev/tty%u: %m", s->vtnr);
957 r = ioctl(vt, KDSETMODE, KD_GRAPHICS);
960 log_error_errno(errno, "Cannot set KD_GRAPHICS on /dev/tty%u: %m", s->vtnr);
964 /* Oh, thanks to the VT layer, VT_AUTO does not work with KD_GRAPHICS.
965 * So we need a dummy handler here which just acknowledges *all* VT
966 * switch requests. */
967 mode.mode = VT_PROCESS;
968 mode.relsig = SIGRTMIN;
969 mode.acqsig = SIGRTMIN + 1;
970 r = ioctl(vt, VT_SETMODE, &mode);
973 log_error_errno(errno, "Cannot set VT_PROCESS on /dev/tty%u: %m", s->vtnr);
980 session_restore_vt(s);
984 void session_restore_vt(Session *s) {
985 _cleanup_free_ char *utf8 = NULL;
986 int vt, kb = K_XLATE;
987 struct vt_mode mode = { 0 };
989 vt = session_open_vt(s);
993 (void) ioctl(vt, KDSETMODE, KD_TEXT);
995 if (read_one_line_file("/sys/module/vt/parameters/default_utf8", &utf8) >= 0 && *utf8 == '1')
998 (void) ioctl(vt, KDSKBMODE, kb);
1000 mode.mode = VT_AUTO;
1001 (void) ioctl(vt, VT_SETMODE, &mode);
1005 s->vtfd = safe_close(s->vtfd);
1008 void session_leave_vt(Session *s) {
1013 /* This is called whenever we get a VT-switch signal from the kernel.
1014 * We acknowledge all of them unconditionally. Note that session are
1015 * free to overwrite those handlers and we only register them for
1016 * sessions with controllers. Legacy sessions are not affected.
1017 * However, if we switch from a non-legacy to a legacy session, we must
1018 * make sure to pause all device before acknowledging the switch. We
1019 * process the real switch only after we are notified via sysfs, so the
1020 * legacy session might have already started using the devices. If we
1021 * don't pause the devices before the switch, we might confuse the
1022 * session we switch to. */
1027 session_device_pause_all(s);
1028 r = ioctl(s->vtfd, VT_RELDISP, 1);
1030 log_debug_errno(errno, "Cannot release VT of session %s: %m", s->id);
1033 bool session_is_controller(Session *s, const char *sender) {
1036 return streq_ptr(s->controller, sender);
1039 static void session_release_controller(Session *s, bool notify) {
1040 _cleanup_free_ char *name = NULL;
1046 name = s->controller;
1048 /* By resetting the controller before releasing the devices, we won't
1049 * send notification signals. This avoids sending useless notifications
1050 * if the controller is released on disconnects. */
1052 s->controller = NULL;
1054 while ((sd = hashmap_first(s->devices)))
1055 session_device_free(sd);
1057 s->controller = NULL;
1058 manager_drop_busname(s->manager, name);
1061 int session_set_controller(Session *s, const char *sender, bool force) {
1062 _cleanup_free_ char *name = NULL;
1068 if (session_is_controller(s, sender))
1070 if (s->controller && !force)
1073 name = strdup(sender);
1077 r = manager_watch_busname(s->manager, name);
1081 /* When setting a session controller, we forcibly mute the VT and set
1082 * it into graphics-mode. Applications can override that by changing
1083 * VT state after calling TakeControl(). However, this serves as a good
1084 * default and well-behaving controllers can now ignore VTs entirely.
1085 * Note that we reset the VT on ReleaseControl() and if the controller
1087 * If logind crashes/restarts, we restore the controller during restart
1088 * or reset the VT in case it crashed/exited, too. */
1089 r = session_prepare_vt(s);
1091 manager_drop_busname(s->manager, name);
1095 session_release_controller(s, true);
1096 s->controller = name;
1103 void session_drop_controller(Session *s) {
1109 session_release_controller(s, false);
1111 session_restore_vt(s);
1114 static const char* const session_state_table[_SESSION_STATE_MAX] = {
1115 [SESSION_OPENING] = "opening",
1116 [SESSION_ONLINE] = "online",
1117 [SESSION_ACTIVE] = "active",
1118 [SESSION_CLOSING] = "closing"
1121 DEFINE_STRING_TABLE_LOOKUP(session_state, SessionState);
1123 static const char* const session_type_table[_SESSION_TYPE_MAX] = {
1124 [SESSION_UNSPECIFIED] = "unspecified",
1125 [SESSION_TTY] = "tty",
1126 [SESSION_X11] = "x11",
1127 [SESSION_WAYLAND] = "wayland",
1128 [SESSION_MIR] = "mir",
1129 [SESSION_WEB] = "web",
1132 DEFINE_STRING_TABLE_LOOKUP(session_type, SessionType);
1134 static const char* const session_class_table[_SESSION_CLASS_MAX] = {
1135 [SESSION_USER] = "user",
1136 [SESSION_GREETER] = "greeter",
1137 [SESSION_LOCK_SCREEN] = "lock-screen",
1138 [SESSION_BACKGROUND] = "background"
1141 DEFINE_STRING_TABLE_LOOKUP(session_class, SessionClass);
1143 static const char* const kill_who_table[_KILL_WHO_MAX] = {
1144 [KILL_LEADER] = "leader",
1148 DEFINE_STRING_TABLE_LOOKUP(kill_who, KillWho);