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 "logind-session.h"
41 static void session_remove_fifo(Session *s);
43 Session* session_new(Manager *m, const char *id) {
48 assert(session_id_valid(id));
54 s->state_file = strappend("/run/systemd/sessions/", id);
60 s->devices = hashmap_new(&devt_hash_ops);
67 s->id = basename(s->state_file);
69 if (hashmap_put(m->sessions, s->id, s) < 0) {
70 hashmap_free(s->devices);
83 void session_free(Session *s) {
89 LIST_REMOVE(gc_queue, s->manager->session_gc_queue, s);
91 s->timer_event_source = sd_event_source_unref(s->timer_event_source);
93 session_remove_fifo(s);
95 session_drop_controller(s);
97 while ((sd = hashmap_first(s->devices)))
98 session_device_free(sd);
100 hashmap_free(s->devices);
103 LIST_REMOVE(sessions_by_user, s->user->sessions, s);
105 if (s->user->display == s)
106 s->user->display = NULL;
110 if (s->seat->active == s)
111 s->seat->active = NULL;
112 if (s->seat->pending_switch == s)
113 s->seat->pending_switch = NULL;
115 seat_evict_position(s->seat, s);
116 LIST_REMOVE(sessions_by_seat, s->seat->sessions, s);
119 sd_bus_message_unref(s->create_message);
123 free(s->remote_host);
124 free(s->remote_user);
128 hashmap_remove(s->manager->sessions, s->id);
134 void session_set_user(Session *s, User *u) {
139 LIST_PREPEND(sessions_by_user, u->sessions, s);
142 int session_save(Session *s) {
143 _cleanup_free_ char *temp_path = NULL;
144 _cleanup_fclose_ FILE *f = NULL;
155 r = mkdir_safe_label("/run/systemd/sessions", 0755, 0, 0);
159 r = fopen_temporary(s->state_file, &f, &temp_path);
165 fchmod(fileno(f), 0644);
168 "# This is private data. Do not parse.\n"
176 session_is_active(s),
177 session_state_to_string(session_get_state(s)),
181 fprintf(f, "TYPE=%s\n", session_type_to_string(s->type));
184 fprintf(f, "CLASS=%s\n", session_class_to_string(s->class));
187 fprintf(f, "FIFO=%s\n", s->fifo_path);
190 fprintf(f, "SEAT=%s\n", s->seat->id);
193 fprintf(f, "TTY=%s\n", s->tty);
196 fprintf(f, "DISPLAY=%s\n", s->display);
198 if (s->remote_host) {
199 _cleanup_free_ char *escaped;
201 escaped = cescape(s->remote_host);
207 fprintf(f, "REMOTE_HOST=%s\n", escaped);
210 if (s->remote_user) {
211 _cleanup_free_ char *escaped;
213 escaped = cescape(s->remote_user);
219 fprintf(f, "REMOTE_USER=%s\n", escaped);
223 _cleanup_free_ char *escaped;
225 escaped = cescape(s->service);
231 fprintf(f, "SERVICE=%s\n", escaped);
235 _cleanup_free_ char *escaped;
238 escaped = cescape(s->desktop);
244 fprintf(f, "DESKTOP=%s\n", escaped);
247 if (s->seat && seat_has_vts(s->seat))
248 fprintf(f, "VTNR=%u\n", s->vtnr);
251 fprintf(f, "POS=%u\n", s->pos);
254 fprintf(f, "LEADER="PID_FMT"\n", s->leader);
257 fprintf(f, "AUDIT=%"PRIu32"\n", s->audit_id);
259 if (dual_timestamp_is_set(&s->timestamp))
261 "REALTIME="USEC_FMT"\n"
262 "MONOTONIC="USEC_FMT"\n",
263 s->timestamp.realtime,
264 s->timestamp.monotonic);
267 fprintf(f, "CONTROLLER=%s\n", s->controller);
271 if (ferror(f) || rename(temp_path, s->state_file) < 0) {
273 unlink(s->state_file);
279 log_error_errno(r, "Failed to save session data %s: %m", s->state_file);
284 int session_load(Session *s) {
285 _cleanup_free_ char *remote = NULL,
302 r = parse_env_file(s->state_file, NEWLINE,
304 "FIFO", &s->fifo_path,
307 "DISPLAY", &s->display,
308 "REMOTE_HOST", &s->remote_host,
309 "REMOTE_USER", &s->remote_user,
310 "SERVICE", &s->service,
311 "DESKTOP", &s->desktop,
319 "REALTIME", &realtime,
320 "MONOTONIC", &monotonic,
321 "CONTROLLER", &controller,
325 return log_error_errno(r, "Failed to read %s: %m", s->state_file);
332 log_error("UID not specified for session %s", s->id);
336 r = parse_uid(uid, &u);
338 log_error("Failed to parse UID value %s for session %s.", uid, s->id);
342 user = hashmap_get(s->manager->users, UID_TO_PTR(u));
344 log_error("User of session %s not known.", s->id);
348 session_set_user(s, user);
352 k = parse_boolean(remote);
358 safe_atou(vtnr, &s->vtnr);
360 if (seat && !s->seat) {
363 o = hashmap_get(s->manager->seats, seat);
365 r = seat_attach_session(o, s);
367 log_error("Cannot attach session %s to seat %s", s->id, seat);
370 if (!s->seat || !seat_has_vts(s->seat))
373 if (pos && s->seat) {
376 safe_atou(pos, &npos);
377 seat_claim_position(s->seat, s, npos);
381 k = parse_pid(leader, &s->leader);
383 audit_session_from_pid(s->leader, &s->audit_id);
389 t = session_type_from_string(type);
397 c = session_class_from_string(class);
402 if (state && streq(state, "closing"))
408 /* If we open an unopened pipe for reading we will not
409 get an EOF. to trigger an EOF we hence open it for
410 writing, but close it right away which then will
411 trigger the EOF. This will happen immediately if no
412 other process has the FIFO open for writing, i. e.
413 when the session died before logind (re)started. */
415 fd = session_create_fifo(s);
420 unsigned long long l;
421 if (sscanf(realtime, "%llu", &l) > 0)
422 s->timestamp.realtime = l;
426 unsigned long long l;
427 if (sscanf(monotonic, "%llu", &l) > 0)
428 s->timestamp.monotonic = l;
432 if (bus_name_has_owner(s->manager->bus, controller, NULL) > 0)
433 session_set_controller(s, controller, false);
435 session_restore_vt(s);
441 int session_activate(Session *s) {
442 unsigned int num_pending;
450 if (s->seat->active == s)
453 /* on seats with VTs, we let VTs manage session-switching */
454 if (seat_has_vts(s->seat)) {
458 return chvt(s->vtnr);
461 /* On seats without VTs, we implement session-switching in logind. We
462 * try to pause all session-devices and wait until the session
463 * controller acknowledged them. Once all devices are asleep, we simply
464 * switch the active session and be done.
465 * We save the session we want to switch to in seat->pending_switch and
466 * seat_complete_switch() will perform the final switch. */
468 s->seat->pending_switch = s;
470 /* if no devices are running, immediately perform the session switch */
471 num_pending = session_device_try_pause_all(s);
473 seat_complete_switch(s->seat);
478 int session_start(Session *s) {
489 r = user_start(s->user);
493 log_struct(s->class == SESSION_BACKGROUND ? LOG_DEBUG : LOG_INFO,
494 LOG_MESSAGE_ID(SD_MESSAGE_SESSION_START),
495 "SESSION_ID=%s", s->id,
496 "USER_ID=%s", s->user->name,
497 "LEADER="PID_FMT, s->leader,
498 LOG_MESSAGE("New session %s of user %s.", s->id, s->user->name),
501 if (!dual_timestamp_is_set(&s->timestamp))
502 dual_timestamp_get(&s->timestamp);
505 seat_read_active_vt(s->seat);
509 user_elect_display(s->user);
518 session_send_signal(s, true);
519 user_send_changed(s->user, "Sessions", "Display", NULL);
521 if (s->seat->active == s)
522 seat_send_changed(s->seat, "Sessions", "ActiveSession", NULL);
524 seat_send_changed(s->seat, "Sessions", NULL);
530 int session_stop(Session *s, bool force) {
538 s->timer_event_source = sd_event_source_unref(s->timer_event_source);
540 /* We are going down, don't care about FIFOs anymore */
541 session_remove_fifo(s);
545 user_elect_display(s->user);
553 int session_finalize(Session *s) {
563 log_struct(s->class == SESSION_BACKGROUND ? LOG_DEBUG : LOG_INFO,
564 LOG_MESSAGE_ID(SD_MESSAGE_SESSION_STOP),
565 "SESSION_ID=%s", s->id,
566 "USER_ID=%s", s->user->name,
567 "LEADER="PID_FMT, s->leader,
568 LOG_MESSAGE("Removed session %s.", s->id),
571 s->timer_event_source = sd_event_source_unref(s->timer_event_source);
573 /* Kill session devices */
574 while ((sd = hashmap_first(s->devices)))
575 session_device_free(sd);
577 unlink(s->state_file);
578 session_add_to_gc_queue(s);
579 user_add_to_gc_queue(s->user);
582 session_send_signal(s, false);
587 if (s->seat->active == s)
588 seat_set_active(s->seat, NULL);
591 seat_send_changed(s->seat, "Sessions", NULL);
595 user_send_changed(s->user, "Sessions", "Display", NULL);
600 int session_release(Session *s) {
603 if (!s->started || s->stopping)
606 if (s->timer_event_source)
609 /* In systemd, session release is triggered by user jobs
610 dying. In elogind we don't have that so go ahead and stop
612 session_stop(s, false);
615 bool session_is_active(Session *s) {
621 return s->seat->active == s;
624 static int get_tty_atime(const char *tty, usec_t *atime) {
625 _cleanup_free_ char *p = NULL;
631 if (!path_is_absolute(tty)) {
632 p = strappend("/dev/", tty);
637 } else if (!path_startswith(tty, "/dev/"))
640 if (lstat(tty, &st) < 0)
643 *atime = timespec_load(&st.st_atim);
647 static int get_process_ctty_atime(pid_t pid, usec_t *atime) {
648 _cleanup_free_ char *p = NULL;
654 r = get_ctty(pid, NULL, &p);
658 return get_tty_atime(p, atime);
661 int session_get_idle_hint(Session *s, dual_timestamp *t) {
667 /* Explicit idle hint is set */
670 *t = s->idle_hint_timestamp;
675 /* Graphical sessions should really implement a real
680 /* For sessions with an explicitly configured tty, let's check
683 r = get_tty_atime(s->tty, &atime);
688 /* For sessions with a leader but no explicitly configured
689 * tty, let's check the controlling tty of the leader */
691 r = get_process_ctty_atime(s->leader, &atime);
698 *t = s->idle_hint_timestamp;
704 dual_timestamp_from_realtime(t, atime);
706 n = now(CLOCK_REALTIME);
708 if (s->manager->idle_action_usec <= 0)
711 return atime + s->manager->idle_action_usec <= n;
714 void session_set_idle_hint(Session *s, bool b) {
717 if (s->idle_hint == b)
721 dual_timestamp_get(&s->idle_hint_timestamp);
723 session_send_changed(s, "IdleHint", "IdleSinceHint", "IdleSinceHintMonotonic", NULL);
726 seat_send_changed(s->seat, "IdleHint", "IdleSinceHint", "IdleSinceHintMonotonic", NULL);
728 user_send_changed(s->user, "IdleHint", "IdleSinceHint", "IdleSinceHintMonotonic", NULL);
729 manager_send_changed(s->manager, "IdleHint", "IdleSinceHint", "IdleSinceHintMonotonic", NULL);
732 static int session_dispatch_fifo(sd_event_source *es, int fd, uint32_t revents, void *userdata) {
733 Session *s = userdata;
736 assert(s->fifo_fd == fd);
738 /* EOF on the FIFO means the session died abnormally. */
740 session_remove_fifo(s);
741 session_stop(s, false);
746 int session_create_fifo(Session *s) {
753 r = mkdir_safe_label("/run/systemd/sessions", 0755, 0, 0);
757 if (asprintf(&s->fifo_path, "/run/systemd/sessions/%s.ref", s->id) < 0)
760 if (mkfifo(s->fifo_path, 0600) < 0 && errno != EEXIST)
764 /* Open reading side */
765 if (s->fifo_fd < 0) {
766 s->fifo_fd = open(s->fifo_path, O_RDONLY|O_CLOEXEC|O_NDELAY);
772 if (!s->fifo_event_source) {
773 r = sd_event_add_io(s->manager->event, &s->fifo_event_source, s->fifo_fd, 0, session_dispatch_fifo, s);
777 r = sd_event_source_set_priority(s->fifo_event_source, SD_EVENT_PRIORITY_IDLE);
782 /* Open writing side */
783 r = open(s->fifo_path, O_WRONLY|O_CLOEXEC|O_NDELAY);
790 static void session_remove_fifo(Session *s) {
793 s->fifo_event_source = sd_event_source_unref(s->fifo_event_source);
794 s->fifo_fd = safe_close(s->fifo_fd);
797 unlink(s->fifo_path);
803 bool session_check_gc(Session *s, bool drop_not_started) {
806 if (drop_not_started && !s->started)
812 if (s->fifo_fd >= 0) {
813 if (pipe_eof(s->fifo_fd) <= 0)
820 void session_add_to_gc_queue(Session *s) {
826 LIST_PREPEND(gc_queue, s->manager->session_gc_queue, s);
827 s->in_gc_queue = true;
830 SessionState session_get_state(Session *s) {
833 /* always check closing first */
834 if (s->stopping || s->timer_event_source)
835 return SESSION_CLOSING;
838 return SESSION_OPENING;
840 if (session_is_active(s))
841 return SESSION_ACTIVE;
843 return SESSION_ONLINE;
846 int session_kill(Session *s, KillWho who, int signo) {
849 /* No way to kill the session without cgroups. */
853 static int session_open_vt(Session *s) {
854 char path[sizeof("/dev/tty") + DECIMAL_STR_MAX(s->vtnr)];
862 sprintf(path, "/dev/tty%u", s->vtnr);
863 s->vtfd = open(path, O_RDWR | O_CLOEXEC | O_NONBLOCK | O_NOCTTY);
865 return log_error_errno(errno, "cannot open VT %s of session %s: %m", path, s->id);
870 int session_prepare_vt(Session *s) {
872 struct vt_mode mode = { 0 };
877 vt = session_open_vt(s);
881 r = fchown(vt, s->user->uid, -1);
884 log_error_errno(errno, "Cannot change owner of /dev/tty%u: %m", s->vtnr);
888 r = ioctl(vt, KDSKBMODE, K_OFF);
891 log_error_errno(errno, "Cannot set K_OFF on /dev/tty%u: %m", s->vtnr);
895 r = ioctl(vt, KDSETMODE, KD_GRAPHICS);
898 log_error_errno(errno, "Cannot set KD_GRAPHICS on /dev/tty%u: %m", s->vtnr);
902 /* Oh, thanks to the VT layer, VT_AUTO does not work with KD_GRAPHICS.
903 * So we need a dummy handler here which just acknowledges *all* VT
904 * switch requests. */
905 mode.mode = VT_PROCESS;
906 mode.relsig = SIGRTMIN;
907 mode.acqsig = SIGRTMIN + 1;
908 r = ioctl(vt, VT_SETMODE, &mode);
911 log_error_errno(errno, "Cannot set VT_PROCESS on /dev/tty%u: %m", s->vtnr);
918 session_restore_vt(s);
922 void session_restore_vt(Session *s) {
923 _cleanup_free_ char *utf8 = NULL;
924 int vt, kb = K_XLATE;
925 struct vt_mode mode = { 0 };
927 vt = session_open_vt(s);
931 (void) ioctl(vt, KDSETMODE, KD_TEXT);
933 if (read_one_line_file("/sys/module/vt/parameters/default_utf8", &utf8) >= 0 && *utf8 == '1')
936 (void) ioctl(vt, KDSKBMODE, kb);
939 (void) ioctl(vt, VT_SETMODE, &mode);
943 s->vtfd = safe_close(s->vtfd);
946 void session_leave_vt(Session *s) {
951 /* This is called whenever we get a VT-switch signal from the kernel.
952 * We acknowledge all of them unconditionally. Note that session are
953 * free to overwrite those handlers and we only register them for
954 * sessions with controllers. Legacy sessions are not affected.
955 * However, if we switch from a non-legacy to a legacy session, we must
956 * make sure to pause all device before acknowledging the switch. We
957 * process the real switch only after we are notified via sysfs, so the
958 * legacy session might have already started using the devices. If we
959 * don't pause the devices before the switch, we might confuse the
960 * session we switch to. */
965 session_device_pause_all(s);
966 r = ioctl(s->vtfd, VT_RELDISP, 1);
968 log_debug_errno(errno, "Cannot release VT of session %s: %m", s->id);
971 bool session_is_controller(Session *s, const char *sender) {
974 return streq_ptr(s->controller, sender);
977 static void session_release_controller(Session *s, bool notify) {
978 _cleanup_free_ char *name = NULL;
984 name = s->controller;
986 /* By resetting the controller before releasing the devices, we won't
987 * send notification signals. This avoids sending useless notifications
988 * if the controller is released on disconnects. */
990 s->controller = NULL;
992 while ((sd = hashmap_first(s->devices)))
993 session_device_free(sd);
995 s->controller = NULL;
996 manager_drop_busname(s->manager, name);
999 int session_set_controller(Session *s, const char *sender, bool force) {
1000 _cleanup_free_ char *name = NULL;
1006 if (session_is_controller(s, sender))
1008 if (s->controller && !force)
1011 name = strdup(sender);
1015 r = manager_watch_busname(s->manager, name);
1019 /* When setting a session controller, we forcibly mute the VT and set
1020 * it into graphics-mode. Applications can override that by changing
1021 * VT state after calling TakeControl(). However, this serves as a good
1022 * default and well-behaving controllers can now ignore VTs entirely.
1023 * Note that we reset the VT on ReleaseControl() and if the controller
1025 * If logind crashes/restarts, we restore the controller during restart
1026 * or reset the VT in case it crashed/exited, too. */
1027 r = session_prepare_vt(s);
1029 manager_drop_busname(s->manager, name);
1033 session_release_controller(s, true);
1034 s->controller = name;
1041 void session_drop_controller(Session *s) {
1047 session_release_controller(s, false);
1049 session_restore_vt(s);
1052 static const char* const session_state_table[_SESSION_STATE_MAX] = {
1053 [SESSION_OPENING] = "opening",
1054 [SESSION_ONLINE] = "online",
1055 [SESSION_ACTIVE] = "active",
1056 [SESSION_CLOSING] = "closing"
1059 DEFINE_STRING_TABLE_LOOKUP(session_state, SessionState);
1061 static const char* const session_type_table[_SESSION_TYPE_MAX] = {
1062 [SESSION_UNSPECIFIED] = "unspecified",
1063 [SESSION_TTY] = "tty",
1064 [SESSION_X11] = "x11",
1065 [SESSION_WAYLAND] = "wayland",
1066 [SESSION_MIR] = "mir",
1067 [SESSION_WEB] = "web",
1070 DEFINE_STRING_TABLE_LOOKUP(session_type, SessionType);
1072 static const char* const session_class_table[_SESSION_CLASS_MAX] = {
1073 [SESSION_USER] = "user",
1074 [SESSION_GREETER] = "greeter",
1075 [SESSION_LOCK_SCREEN] = "lock-screen",
1076 [SESSION_BACKGROUND] = "background"
1079 DEFINE_STRING_TABLE_LOOKUP(session_class, SessionClass);
1081 static const char* const kill_who_table[_KILL_WHO_MAX] = {
1082 [KILL_LEADER] = "leader",
1086 DEFINE_STRING_TABLE_LOOKUP(kill_who, KillWho);