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"
40 #include "formats-util.h"
41 #include "terminal-util.h"
43 #define RELEASE_USEC (20*USEC_PER_SEC)
45 static void session_remove_fifo(Session *s);
47 Session* session_new(Manager *m, const char *id) {
52 assert(session_id_valid(id));
58 s->state_file = strappend("/run/systemd/sessions/", id);
64 s->devices = hashmap_new(&devt_hash_ops);
71 s->id = basename(s->state_file);
73 if (hashmap_put(m->sessions, s->id, s) < 0) {
74 hashmap_free(s->devices);
87 void session_free(Session *s) {
93 LIST_REMOVE(gc_queue, s->manager->session_gc_queue, s);
95 s->timer_event_source = sd_event_source_unref(s->timer_event_source);
97 session_remove_fifo(s);
99 session_drop_controller(s);
101 while ((sd = hashmap_first(s->devices)))
102 session_device_free(sd);
104 hashmap_free(s->devices);
107 LIST_REMOVE(sessions_by_user, s->user->sessions, s);
109 if (s->user->display == s)
110 s->user->display = NULL;
114 if (s->seat->active == s)
115 s->seat->active = NULL;
116 if (s->seat->pending_switch == s)
117 s->seat->pending_switch = NULL;
119 seat_evict_position(s->seat, s);
120 LIST_REMOVE(sessions_by_seat, s->seat->sessions, s);
123 sd_bus_message_unref(s->create_message);
127 free(s->remote_host);
128 free(s->remote_user);
132 hashmap_remove(s->manager->sessions, s->id);
138 void session_set_user(Session *s, User *u) {
143 LIST_PREPEND(sessions_by_user, u->sessions, s);
146 int session_save(Session *s) {
147 _cleanup_free_ char *temp_path = NULL;
148 _cleanup_fclose_ FILE *f = NULL;
159 r = mkdir_safe_label("/run/systemd/sessions", 0755, 0, 0);
163 r = fopen_temporary(s->state_file, &f, &temp_path);
169 fchmod(fileno(f), 0644);
172 "# This is private data. Do not parse.\n"
180 session_is_active(s),
181 session_state_to_string(session_get_state(s)),
185 fprintf(f, "TYPE=%s\n", session_type_to_string(s->type));
188 fprintf(f, "CLASS=%s\n", session_class_to_string(s->class));
191 fprintf(f, "FIFO=%s\n", s->fifo_path);
194 fprintf(f, "SEAT=%s\n", s->seat->id);
197 fprintf(f, "TTY=%s\n", s->tty);
200 fprintf(f, "DISPLAY=%s\n", s->display);
202 if (s->remote_host) {
203 _cleanup_free_ char *escaped;
205 escaped = cescape(s->remote_host);
211 fprintf(f, "REMOTE_HOST=%s\n", escaped);
214 if (s->remote_user) {
215 _cleanup_free_ char *escaped;
217 escaped = cescape(s->remote_user);
223 fprintf(f, "REMOTE_USER=%s\n", escaped);
227 _cleanup_free_ char *escaped;
229 escaped = cescape(s->service);
235 fprintf(f, "SERVICE=%s\n", escaped);
239 _cleanup_free_ char *escaped;
242 escaped = cescape(s->desktop);
248 fprintf(f, "DESKTOP=%s\n", escaped);
251 if (s->seat && seat_has_vts(s->seat))
252 fprintf(f, "VTNR=%u\n", s->vtnr);
255 fprintf(f, "POSITION=%u\n", s->position);
258 fprintf(f, "LEADER="PID_FMT"\n", s->leader);
261 fprintf(f, "AUDIT=%"PRIu32"\n", s->audit_id);
263 if (dual_timestamp_is_set(&s->timestamp))
265 "REALTIME="USEC_FMT"\n"
266 "MONOTONIC="USEC_FMT"\n",
267 s->timestamp.realtime,
268 s->timestamp.monotonic);
271 fprintf(f, "CONTROLLER=%s\n", s->controller);
275 if (ferror(f) || rename(temp_path, s->state_file) < 0) {
277 unlink(s->state_file);
283 log_error_errno(r, "Failed to save session data %s: %m", s->state_file);
288 int session_load(Session *s) {
289 _cleanup_free_ char *remote = NULL,
306 r = parse_env_file(s->state_file, NEWLINE,
308 "FIFO", &s->fifo_path,
311 "DISPLAY", &s->display,
312 "REMOTE_HOST", &s->remote_host,
313 "REMOTE_USER", &s->remote_user,
314 "SERVICE", &s->service,
315 "DESKTOP", &s->desktop,
318 "POSITION", &position,
323 "REALTIME", &realtime,
324 "MONOTONIC", &monotonic,
325 "CONTROLLER", &controller,
329 return log_error_errno(r, "Failed to read %s: %m", s->state_file);
336 log_error("UID not specified for session %s", s->id);
340 r = parse_uid(uid, &u);
342 log_error("Failed to parse UID value %s for session %s.", uid, s->id);
346 user = hashmap_get(s->manager->users, UID_TO_PTR(u));
348 log_error("User of session %s not known.", s->id);
352 session_set_user(s, user);
356 k = parse_boolean(remote);
362 safe_atou(vtnr, &s->vtnr);
364 if (seat && !s->seat) {
367 o = hashmap_get(s->manager->seats, seat);
369 r = seat_attach_session(o, s);
371 log_error("Cannot attach session %s to seat %s", s->id, seat);
374 if (!s->seat || !seat_has_vts(s->seat))
377 if (position && s->seat) {
380 safe_atou(position, &npos);
381 seat_claim_position(s->seat, s, npos);
385 k = parse_pid(leader, &s->leader);
387 audit_session_from_pid(s->leader, &s->audit_id);
393 t = session_type_from_string(type);
401 c = session_class_from_string(class);
406 if (state && streq(state, "closing"))
412 /* If we open an unopened pipe for reading we will not
413 get an EOF. to trigger an EOF we hence open it for
414 writing, but close it right away which then will
415 trigger the EOF. This will happen immediately if no
416 other process has the FIFO open for writing, i. e.
417 when the session died before logind (re)started. */
419 fd = session_create_fifo(s);
424 unsigned long long l;
425 if (sscanf(realtime, "%llu", &l) > 0)
426 s->timestamp.realtime = l;
430 unsigned long long l;
431 if (sscanf(monotonic, "%llu", &l) > 0)
432 s->timestamp.monotonic = l;
436 if (bus_name_has_owner(s->manager->bus, controller, NULL) > 0)
437 session_set_controller(s, controller, false);
439 session_restore_vt(s);
445 int session_activate(Session *s) {
446 unsigned int num_pending;
454 if (s->seat->active == s)
457 /* on seats with VTs, we let VTs manage session-switching */
458 if (seat_has_vts(s->seat)) {
462 return chvt(s->vtnr);
465 /* On seats without VTs, we implement session-switching in logind. We
466 * try to pause all session-devices and wait until the session
467 * controller acknowledged them. Once all devices are asleep, we simply
468 * switch the active session and be done.
469 * We save the session we want to switch to in seat->pending_switch and
470 * seat_complete_switch() will perform the final switch. */
472 s->seat->pending_switch = s;
474 /* if no devices are running, immediately perform the session switch */
475 num_pending = session_device_try_pause_all(s);
477 seat_complete_switch(s->seat);
482 int session_start(Session *s) {
493 r = user_start(s->user);
497 log_struct(s->class == SESSION_BACKGROUND ? LOG_DEBUG : LOG_INFO,
498 LOG_MESSAGE_ID(SD_MESSAGE_SESSION_START),
499 "SESSION_ID=%s", s->id,
500 "USER_ID=%s", s->user->name,
501 "LEADER="PID_FMT, s->leader,
502 LOG_MESSAGE("New session %s of user %s.", s->id, s->user->name),
505 if (!dual_timestamp_is_set(&s->timestamp))
506 dual_timestamp_get(&s->timestamp);
509 seat_read_active_vt(s->seat);
513 user_elect_display(s->user);
522 session_send_signal(s, true);
523 user_send_changed(s->user, "Sessions", "Display", NULL);
525 if (s->seat->active == s)
526 seat_send_changed(s->seat, "Sessions", "ActiveSession", NULL);
528 seat_send_changed(s->seat, "Sessions", NULL);
534 int session_stop(Session *s, bool force) {
542 s->timer_event_source = sd_event_source_unref(s->timer_event_source);
545 seat_evict_position(s->seat, s);
547 /* We are going down, don't care about FIFOs anymore */
548 session_remove_fifo(s);
552 user_elect_display(s->user);
560 int session_finalize(Session *s) {
570 log_struct(s->class == SESSION_BACKGROUND ? LOG_DEBUG : LOG_INFO,
571 LOG_MESSAGE_ID(SD_MESSAGE_SESSION_STOP),
572 "SESSION_ID=%s", s->id,
573 "USER_ID=%s", s->user->name,
574 "LEADER="PID_FMT, s->leader,
575 LOG_MESSAGE("Removed session %s.", s->id),
578 s->timer_event_source = sd_event_source_unref(s->timer_event_source);
581 seat_evict_position(s->seat, s);
583 /* Kill session devices */
584 while ((sd = hashmap_first(s->devices)))
585 session_device_free(sd);
587 unlink(s->state_file);
588 session_add_to_gc_queue(s);
589 user_add_to_gc_queue(s->user);
592 session_send_signal(s, false);
597 if (s->seat->active == s)
598 seat_set_active(s->seat, NULL);
601 seat_send_changed(s->seat, "Sessions", NULL);
605 user_send_changed(s->user, "Sessions", "Display", NULL);
610 static int release_timeout_callback(sd_event_source *es, uint64_t usec, void *userdata) {
611 Session *s = userdata;
616 session_stop(s, false);
620 int session_release(Session *s) {
623 if (!s->started || s->stopping)
626 if (s->timer_event_source)
629 return sd_event_add_time(s->manager->event,
630 &s->timer_event_source,
632 now(CLOCK_MONOTONIC) + RELEASE_USEC, 0,
633 release_timeout_callback, s);
636 bool session_is_active(Session *s) {
642 return s->seat->active == s;
645 static int get_tty_atime(const char *tty, usec_t *atime) {
646 _cleanup_free_ char *p = NULL;
652 if (!path_is_absolute(tty)) {
653 p = strappend("/dev/", tty);
658 } else if (!path_startswith(tty, "/dev/"))
661 if (lstat(tty, &st) < 0)
664 *atime = timespec_load(&st.st_atim);
668 static int get_process_ctty_atime(pid_t pid, usec_t *atime) {
669 _cleanup_free_ char *p = NULL;
675 r = get_ctty(pid, NULL, &p);
679 return get_tty_atime(p, atime);
682 int session_get_idle_hint(Session *s, dual_timestamp *t) {
688 /* Explicit idle hint is set */
691 *t = s->idle_hint_timestamp;
696 /* Graphical sessions should really implement a real
701 /* For sessions with an explicitly configured tty, let's check
704 r = get_tty_atime(s->tty, &atime);
709 /* For sessions with a leader but no explicitly configured
710 * tty, let's check the controlling tty of the leader */
712 r = get_process_ctty_atime(s->leader, &atime);
719 *t = s->idle_hint_timestamp;
725 dual_timestamp_from_realtime(t, atime);
727 n = now(CLOCK_REALTIME);
729 if (s->manager->idle_action_usec <= 0)
732 return atime + s->manager->idle_action_usec <= n;
735 void session_set_idle_hint(Session *s, bool b) {
738 if (s->idle_hint == b)
742 dual_timestamp_get(&s->idle_hint_timestamp);
744 session_send_changed(s, "IdleHint", "IdleSinceHint", "IdleSinceHintMonotonic", NULL);
747 seat_send_changed(s->seat, "IdleHint", "IdleSinceHint", "IdleSinceHintMonotonic", NULL);
749 user_send_changed(s->user, "IdleHint", "IdleSinceHint", "IdleSinceHintMonotonic", NULL);
750 manager_send_changed(s->manager, "IdleHint", "IdleSinceHint", "IdleSinceHintMonotonic", NULL);
753 static int session_dispatch_fifo(sd_event_source *es, int fd, uint32_t revents, void *userdata) {
754 Session *s = userdata;
757 assert(s->fifo_fd == fd);
759 /* EOF on the FIFO means the session died abnormally. */
761 session_remove_fifo(s);
762 session_stop(s, false);
767 int session_create_fifo(Session *s) {
774 r = mkdir_safe_label("/run/systemd/sessions", 0755, 0, 0);
778 if (asprintf(&s->fifo_path, "/run/systemd/sessions/%s.ref", s->id) < 0)
781 if (mkfifo(s->fifo_path, 0600) < 0 && errno != EEXIST)
785 /* Open reading side */
786 if (s->fifo_fd < 0) {
787 s->fifo_fd = open(s->fifo_path, O_RDONLY|O_CLOEXEC|O_NDELAY);
793 if (!s->fifo_event_source) {
794 r = sd_event_add_io(s->manager->event, &s->fifo_event_source, s->fifo_fd, 0, session_dispatch_fifo, s);
798 r = sd_event_source_set_priority(s->fifo_event_source, SD_EVENT_PRIORITY_IDLE);
803 /* Open writing side */
804 r = open(s->fifo_path, O_WRONLY|O_CLOEXEC|O_NDELAY);
811 static void session_remove_fifo(Session *s) {
814 s->fifo_event_source = sd_event_source_unref(s->fifo_event_source);
815 s->fifo_fd = safe_close(s->fifo_fd);
818 unlink(s->fifo_path);
824 bool session_check_gc(Session *s, bool drop_not_started) {
827 if (drop_not_started && !s->started)
833 if (s->fifo_fd >= 0) {
834 if (pipe_eof(s->fifo_fd) <= 0)
841 void session_add_to_gc_queue(Session *s) {
847 LIST_PREPEND(gc_queue, s->manager->session_gc_queue, s);
848 s->in_gc_queue = true;
851 SessionState session_get_state(Session *s) {
854 /* always check closing first */
855 if (s->stopping || s->timer_event_source)
856 return SESSION_CLOSING;
859 return SESSION_OPENING;
861 if (session_is_active(s))
862 return SESSION_ACTIVE;
864 return SESSION_ONLINE;
867 int session_kill(Session *s, KillWho who, int signo) {
870 /* No way to kill the session without cgroups. */
874 static int session_open_vt(Session *s) {
875 char path[sizeof("/dev/tty") + DECIMAL_STR_MAX(s->vtnr)];
883 sprintf(path, "/dev/tty%u", s->vtnr);
884 s->vtfd = open(path, O_RDWR | O_CLOEXEC | O_NONBLOCK | O_NOCTTY);
886 return log_error_errno(errno, "cannot open VT %s of session %s: %m", path, s->id);
891 int session_prepare_vt(Session *s) {
893 struct vt_mode mode = { 0 };
898 vt = session_open_vt(s);
902 r = fchown(vt, s->user->uid, -1);
905 log_error_errno(errno, "Cannot change owner of /dev/tty%u: %m", s->vtnr);
909 r = ioctl(vt, KDSKBMODE, K_OFF);
912 log_error_errno(errno, "Cannot set K_OFF on /dev/tty%u: %m", s->vtnr);
916 r = ioctl(vt, KDSETMODE, KD_GRAPHICS);
919 log_error_errno(errno, "Cannot set KD_GRAPHICS on /dev/tty%u: %m", s->vtnr);
923 /* Oh, thanks to the VT layer, VT_AUTO does not work with KD_GRAPHICS.
924 * So we need a dummy handler here which just acknowledges *all* VT
925 * switch requests. */
926 mode.mode = VT_PROCESS;
927 mode.relsig = SIGRTMIN;
928 mode.acqsig = SIGRTMIN + 1;
929 r = ioctl(vt, VT_SETMODE, &mode);
932 log_error_errno(errno, "Cannot set VT_PROCESS on /dev/tty%u: %m", s->vtnr);
939 session_restore_vt(s);
943 void session_restore_vt(Session *s) {
944 _cleanup_free_ char *utf8 = NULL;
945 int vt, kb = K_XLATE;
946 struct vt_mode mode = { 0 };
948 vt = session_open_vt(s);
952 (void) ioctl(vt, KDSETMODE, KD_TEXT);
954 if (read_one_line_file("/sys/module/vt/parameters/default_utf8", &utf8) >= 0 && *utf8 == '1')
957 (void) ioctl(vt, KDSKBMODE, kb);
960 (void) ioctl(vt, VT_SETMODE, &mode);
964 s->vtfd = safe_close(s->vtfd);
967 void session_leave_vt(Session *s) {
972 /* This is called whenever we get a VT-switch signal from the kernel.
973 * We acknowledge all of them unconditionally. Note that session are
974 * free to overwrite those handlers and we only register them for
975 * sessions with controllers. Legacy sessions are not affected.
976 * However, if we switch from a non-legacy to a legacy session, we must
977 * make sure to pause all device before acknowledging the switch. We
978 * process the real switch only after we are notified via sysfs, so the
979 * legacy session might have already started using the devices. If we
980 * don't pause the devices before the switch, we might confuse the
981 * session we switch to. */
986 session_device_pause_all(s);
987 r = ioctl(s->vtfd, VT_RELDISP, 1);
989 log_debug_errno(errno, "Cannot release VT of session %s: %m", s->id);
992 bool session_is_controller(Session *s, const char *sender) {
995 return streq_ptr(s->controller, sender);
998 static void session_release_controller(Session *s, bool notify) {
999 _cleanup_free_ char *name = NULL;
1005 name = s->controller;
1007 /* By resetting the controller before releasing the devices, we won't
1008 * send notification signals. This avoids sending useless notifications
1009 * if the controller is released on disconnects. */
1011 s->controller = NULL;
1013 while ((sd = hashmap_first(s->devices)))
1014 session_device_free(sd);
1016 s->controller = NULL;
1017 manager_drop_busname(s->manager, name);
1020 int session_set_controller(Session *s, const char *sender, bool force) {
1021 _cleanup_free_ char *name = NULL;
1027 if (session_is_controller(s, sender))
1029 if (s->controller && !force)
1032 name = strdup(sender);
1036 r = manager_watch_busname(s->manager, name);
1040 /* When setting a session controller, we forcibly mute the VT and set
1041 * it into graphics-mode. Applications can override that by changing
1042 * VT state after calling TakeControl(). However, this serves as a good
1043 * default and well-behaving controllers can now ignore VTs entirely.
1044 * Note that we reset the VT on ReleaseControl() and if the controller
1046 * If logind crashes/restarts, we restore the controller during restart
1047 * or reset the VT in case it crashed/exited, too. */
1048 r = session_prepare_vt(s);
1050 manager_drop_busname(s->manager, name);
1054 session_release_controller(s, true);
1055 s->controller = name;
1062 void session_drop_controller(Session *s) {
1068 session_release_controller(s, false);
1070 session_restore_vt(s);
1073 static const char* const session_state_table[_SESSION_STATE_MAX] = {
1074 [SESSION_OPENING] = "opening",
1075 [SESSION_ONLINE] = "online",
1076 [SESSION_ACTIVE] = "active",
1077 [SESSION_CLOSING] = "closing"
1080 DEFINE_STRING_TABLE_LOOKUP(session_state, SessionState);
1082 static const char* const session_type_table[_SESSION_TYPE_MAX] = {
1083 [SESSION_UNSPECIFIED] = "unspecified",
1084 [SESSION_TTY] = "tty",
1085 [SESSION_X11] = "x11",
1086 [SESSION_WAYLAND] = "wayland",
1087 [SESSION_MIR] = "mir",
1088 [SESSION_WEB] = "web",
1091 DEFINE_STRING_TABLE_LOOKUP(session_type, SessionType);
1093 static const char* const session_class_table[_SESSION_CLASS_MAX] = {
1094 [SESSION_USER] = "user",
1095 [SESSION_GREETER] = "greeter",
1096 [SESSION_LOCK_SCREEN] = "lock-screen",
1097 [SESSION_BACKGROUND] = "background"
1100 DEFINE_STRING_TABLE_LOOKUP(session_class, SessionClass);
1102 static const char* const kill_who_table[_KILL_WHO_MAX] = {
1103 [KILL_LEADER] = "leader",
1107 DEFINE_STRING_TABLE_LOOKUP(kill_who, KillWho);