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 static void session_remove_fifo(Session *s);
45 Session* session_new(Manager *m, const char *id) {
50 assert(session_id_valid(id));
56 s->state_file = strappend("/run/systemd/sessions/", id);
62 s->devices = hashmap_new(&devt_hash_ops);
69 s->id = basename(s->state_file);
71 if (hashmap_put(m->sessions, s->id, s) < 0) {
72 hashmap_free(s->devices);
85 void session_free(Session *s) {
91 LIST_REMOVE(gc_queue, s->manager->session_gc_queue, s);
93 s->timer_event_source = sd_event_source_unref(s->timer_event_source);
95 session_remove_fifo(s);
97 session_drop_controller(s);
99 while ((sd = hashmap_first(s->devices)))
100 session_device_free(sd);
102 hashmap_free(s->devices);
105 LIST_REMOVE(sessions_by_user, s->user->sessions, s);
107 if (s->user->display == s)
108 s->user->display = NULL;
112 if (s->seat->active == s)
113 s->seat->active = NULL;
114 if (s->seat->pending_switch == s)
115 s->seat->pending_switch = NULL;
117 seat_evict_position(s->seat, s);
118 LIST_REMOVE(sessions_by_seat, s->seat->sessions, s);
121 sd_bus_message_unref(s->create_message);
125 free(s->remote_host);
126 free(s->remote_user);
130 hashmap_remove(s->manager->sessions, s->id);
136 void session_set_user(Session *s, User *u) {
141 LIST_PREPEND(sessions_by_user, u->sessions, s);
144 int session_save(Session *s) {
145 _cleanup_free_ char *temp_path = NULL;
146 _cleanup_fclose_ FILE *f = NULL;
157 r = mkdir_safe_label("/run/systemd/sessions", 0755, 0, 0);
161 r = fopen_temporary(s->state_file, &f, &temp_path);
167 fchmod(fileno(f), 0644);
170 "# This is private data. Do not parse.\n"
178 session_is_active(s),
179 session_state_to_string(session_get_state(s)),
183 fprintf(f, "TYPE=%s\n", session_type_to_string(s->type));
186 fprintf(f, "CLASS=%s\n", session_class_to_string(s->class));
189 fprintf(f, "FIFO=%s\n", s->fifo_path);
192 fprintf(f, "SEAT=%s\n", s->seat->id);
195 fprintf(f, "TTY=%s\n", s->tty);
198 fprintf(f, "DISPLAY=%s\n", s->display);
200 if (s->remote_host) {
201 _cleanup_free_ char *escaped;
203 escaped = cescape(s->remote_host);
209 fprintf(f, "REMOTE_HOST=%s\n", escaped);
212 if (s->remote_user) {
213 _cleanup_free_ char *escaped;
215 escaped = cescape(s->remote_user);
221 fprintf(f, "REMOTE_USER=%s\n", escaped);
225 _cleanup_free_ char *escaped;
227 escaped = cescape(s->service);
233 fprintf(f, "SERVICE=%s\n", escaped);
237 _cleanup_free_ char *escaped;
240 escaped = cescape(s->desktop);
246 fprintf(f, "DESKTOP=%s\n", escaped);
249 if (s->seat && seat_has_vts(s->seat))
250 fprintf(f, "VTNR=%u\n", s->vtnr);
253 fprintf(f, "POSITION=%u\n", s->position);
256 fprintf(f, "LEADER="PID_FMT"\n", s->leader);
259 fprintf(f, "AUDIT=%"PRIu32"\n", s->audit_id);
261 if (dual_timestamp_is_set(&s->timestamp))
263 "REALTIME="USEC_FMT"\n"
264 "MONOTONIC="USEC_FMT"\n",
265 s->timestamp.realtime,
266 s->timestamp.monotonic);
269 fprintf(f, "CONTROLLER=%s\n", s->controller);
273 if (ferror(f) || rename(temp_path, s->state_file) < 0) {
275 unlink(s->state_file);
281 log_error_errno(r, "Failed to save session data %s: %m", s->state_file);
286 int session_load(Session *s) {
287 _cleanup_free_ char *remote = NULL,
304 r = parse_env_file(s->state_file, NEWLINE,
306 "FIFO", &s->fifo_path,
309 "DISPLAY", &s->display,
310 "REMOTE_HOST", &s->remote_host,
311 "REMOTE_USER", &s->remote_user,
312 "SERVICE", &s->service,
313 "DESKTOP", &s->desktop,
316 "POSITION", &position,
321 "REALTIME", &realtime,
322 "MONOTONIC", &monotonic,
323 "CONTROLLER", &controller,
327 return log_error_errno(r, "Failed to read %s: %m", s->state_file);
334 log_error("UID not specified for session %s", s->id);
338 r = parse_uid(uid, &u);
340 log_error("Failed to parse UID value %s for session %s.", uid, s->id);
344 user = hashmap_get(s->manager->users, UID_TO_PTR(u));
346 log_error("User of session %s not known.", s->id);
350 session_set_user(s, user);
354 k = parse_boolean(remote);
360 safe_atou(vtnr, &s->vtnr);
362 if (seat && !s->seat) {
365 o = hashmap_get(s->manager->seats, seat);
367 r = seat_attach_session(o, s);
369 log_error("Cannot attach session %s to seat %s", s->id, seat);
372 if (!s->seat || !seat_has_vts(s->seat))
375 if (position && s->seat) {
378 safe_atou(position, &npos);
379 seat_claim_position(s->seat, s, npos);
383 k = parse_pid(leader, &s->leader);
385 audit_session_from_pid(s->leader, &s->audit_id);
391 t = session_type_from_string(type);
399 c = session_class_from_string(class);
404 if (state && streq(state, "closing"))
410 /* If we open an unopened pipe for reading we will not
411 get an EOF. to trigger an EOF we hence open it for
412 writing, but close it right away which then will
413 trigger the EOF. This will happen immediately if no
414 other process has the FIFO open for writing, i. e.
415 when the session died before logind (re)started. */
417 fd = session_create_fifo(s);
422 unsigned long long l;
423 if (sscanf(realtime, "%llu", &l) > 0)
424 s->timestamp.realtime = l;
428 unsigned long long l;
429 if (sscanf(monotonic, "%llu", &l) > 0)
430 s->timestamp.monotonic = l;
434 if (bus_name_has_owner(s->manager->bus, controller, NULL) > 0)
435 session_set_controller(s, controller, false);
437 session_restore_vt(s);
443 int session_activate(Session *s) {
444 unsigned int num_pending;
452 if (s->seat->active == s)
455 /* on seats with VTs, we let VTs manage session-switching */
456 if (seat_has_vts(s->seat)) {
460 return chvt(s->vtnr);
463 /* On seats without VTs, we implement session-switching in logind. We
464 * try to pause all session-devices and wait until the session
465 * controller acknowledged them. Once all devices are asleep, we simply
466 * switch the active session and be done.
467 * We save the session we want to switch to in seat->pending_switch and
468 * seat_complete_switch() will perform the final switch. */
470 s->seat->pending_switch = s;
472 /* if no devices are running, immediately perform the session switch */
473 num_pending = session_device_try_pause_all(s);
475 seat_complete_switch(s->seat);
480 int session_start(Session *s) {
491 r = user_start(s->user);
495 log_struct(s->class == SESSION_BACKGROUND ? LOG_DEBUG : LOG_INFO,
496 LOG_MESSAGE_ID(SD_MESSAGE_SESSION_START),
497 "SESSION_ID=%s", s->id,
498 "USER_ID=%s", s->user->name,
499 "LEADER="PID_FMT, s->leader,
500 LOG_MESSAGE("New session %s of user %s.", s->id, s->user->name),
503 if (!dual_timestamp_is_set(&s->timestamp))
504 dual_timestamp_get(&s->timestamp);
507 seat_read_active_vt(s->seat);
511 user_elect_display(s->user);
520 session_send_signal(s, true);
521 user_send_changed(s->user, "Sessions", "Display", NULL);
523 if (s->seat->active == s)
524 seat_send_changed(s->seat, "Sessions", "ActiveSession", NULL);
526 seat_send_changed(s->seat, "Sessions", NULL);
532 int session_stop(Session *s, bool force) {
540 s->timer_event_source = sd_event_source_unref(s->timer_event_source);
543 seat_evict_position(s->seat, s);
545 /* We are going down, don't care about FIFOs anymore */
546 session_remove_fifo(s);
550 user_elect_display(s->user);
558 int session_finalize(Session *s) {
568 log_struct(s->class == SESSION_BACKGROUND ? LOG_DEBUG : LOG_INFO,
569 LOG_MESSAGE_ID(SD_MESSAGE_SESSION_STOP),
570 "SESSION_ID=%s", s->id,
571 "USER_ID=%s", s->user->name,
572 "LEADER="PID_FMT, s->leader,
573 LOG_MESSAGE("Removed session %s.", s->id),
576 s->timer_event_source = sd_event_source_unref(s->timer_event_source);
579 seat_evict_position(s->seat, s);
581 /* Kill session devices */
582 while ((sd = hashmap_first(s->devices)))
583 session_device_free(sd);
585 unlink(s->state_file);
586 session_add_to_gc_queue(s);
587 user_add_to_gc_queue(s->user);
590 session_send_signal(s, false);
595 if (s->seat->active == s)
596 seat_set_active(s->seat, NULL);
599 seat_send_changed(s->seat, "Sessions", NULL);
603 user_send_changed(s->user, "Sessions", "Display", NULL);
608 int session_release(Session *s) {
611 if (!s->started || s->stopping)
614 if (s->timer_event_source)
617 /* In systemd, session release is triggered by user jobs
618 dying. In elogind we don't have that so go ahead and stop
620 session_stop(s, false);
623 bool session_is_active(Session *s) {
629 return s->seat->active == s;
632 static int get_tty_atime(const char *tty, usec_t *atime) {
633 _cleanup_free_ char *p = NULL;
639 if (!path_is_absolute(tty)) {
640 p = strappend("/dev/", tty);
645 } else if (!path_startswith(tty, "/dev/"))
648 if (lstat(tty, &st) < 0)
651 *atime = timespec_load(&st.st_atim);
655 static int get_process_ctty_atime(pid_t pid, usec_t *atime) {
656 _cleanup_free_ char *p = NULL;
662 r = get_ctty(pid, NULL, &p);
666 return get_tty_atime(p, atime);
669 int session_get_idle_hint(Session *s, dual_timestamp *t) {
675 /* Explicit idle hint is set */
678 *t = s->idle_hint_timestamp;
683 /* Graphical sessions should really implement a real
688 /* For sessions with an explicitly configured tty, let's check
691 r = get_tty_atime(s->tty, &atime);
696 /* For sessions with a leader but no explicitly configured
697 * tty, let's check the controlling tty of the leader */
699 r = get_process_ctty_atime(s->leader, &atime);
706 *t = s->idle_hint_timestamp;
712 dual_timestamp_from_realtime(t, atime);
714 n = now(CLOCK_REALTIME);
716 if (s->manager->idle_action_usec <= 0)
719 return atime + s->manager->idle_action_usec <= n;
722 void session_set_idle_hint(Session *s, bool b) {
725 if (s->idle_hint == b)
729 dual_timestamp_get(&s->idle_hint_timestamp);
731 session_send_changed(s, "IdleHint", "IdleSinceHint", "IdleSinceHintMonotonic", NULL);
734 seat_send_changed(s->seat, "IdleHint", "IdleSinceHint", "IdleSinceHintMonotonic", NULL);
736 user_send_changed(s->user, "IdleHint", "IdleSinceHint", "IdleSinceHintMonotonic", NULL);
737 manager_send_changed(s->manager, "IdleHint", "IdleSinceHint", "IdleSinceHintMonotonic", NULL);
740 static int session_dispatch_fifo(sd_event_source *es, int fd, uint32_t revents, void *userdata) {
741 Session *s = userdata;
744 assert(s->fifo_fd == fd);
746 /* EOF on the FIFO means the session died abnormally. */
748 session_remove_fifo(s);
749 session_stop(s, false);
754 int session_create_fifo(Session *s) {
761 r = mkdir_safe_label("/run/systemd/sessions", 0755, 0, 0);
765 if (asprintf(&s->fifo_path, "/run/systemd/sessions/%s.ref", s->id) < 0)
768 if (mkfifo(s->fifo_path, 0600) < 0 && errno != EEXIST)
772 /* Open reading side */
773 if (s->fifo_fd < 0) {
774 s->fifo_fd = open(s->fifo_path, O_RDONLY|O_CLOEXEC|O_NDELAY);
780 if (!s->fifo_event_source) {
781 r = sd_event_add_io(s->manager->event, &s->fifo_event_source, s->fifo_fd, 0, session_dispatch_fifo, s);
785 r = sd_event_source_set_priority(s->fifo_event_source, SD_EVENT_PRIORITY_IDLE);
790 /* Open writing side */
791 r = open(s->fifo_path, O_WRONLY|O_CLOEXEC|O_NDELAY);
798 static void session_remove_fifo(Session *s) {
801 s->fifo_event_source = sd_event_source_unref(s->fifo_event_source);
802 s->fifo_fd = safe_close(s->fifo_fd);
805 unlink(s->fifo_path);
811 bool session_check_gc(Session *s, bool drop_not_started) {
814 if (drop_not_started && !s->started)
820 if (s->fifo_fd >= 0) {
821 if (pipe_eof(s->fifo_fd) <= 0)
828 void session_add_to_gc_queue(Session *s) {
834 LIST_PREPEND(gc_queue, s->manager->session_gc_queue, s);
835 s->in_gc_queue = true;
838 SessionState session_get_state(Session *s) {
841 /* always check closing first */
842 if (s->stopping || s->timer_event_source)
843 return SESSION_CLOSING;
846 return SESSION_OPENING;
848 if (session_is_active(s))
849 return SESSION_ACTIVE;
851 return SESSION_ONLINE;
854 int session_kill(Session *s, KillWho who, int signo) {
857 /* No way to kill the session without cgroups. */
861 static int session_open_vt(Session *s) {
862 char path[sizeof("/dev/tty") + DECIMAL_STR_MAX(s->vtnr)];
870 sprintf(path, "/dev/tty%u", s->vtnr);
871 s->vtfd = open(path, O_RDWR | O_CLOEXEC | O_NONBLOCK | O_NOCTTY);
873 return log_error_errno(errno, "cannot open VT %s of session %s: %m", path, s->id);
878 int session_prepare_vt(Session *s) {
880 struct vt_mode mode = { 0 };
885 vt = session_open_vt(s);
889 r = fchown(vt, s->user->uid, -1);
892 log_error_errno(errno, "Cannot change owner of /dev/tty%u: %m", s->vtnr);
896 r = ioctl(vt, KDSKBMODE, K_OFF);
899 log_error_errno(errno, "Cannot set K_OFF on /dev/tty%u: %m", s->vtnr);
903 r = ioctl(vt, KDSETMODE, KD_GRAPHICS);
906 log_error_errno(errno, "Cannot set KD_GRAPHICS on /dev/tty%u: %m", s->vtnr);
910 /* Oh, thanks to the VT layer, VT_AUTO does not work with KD_GRAPHICS.
911 * So we need a dummy handler here which just acknowledges *all* VT
912 * switch requests. */
913 mode.mode = VT_PROCESS;
914 mode.relsig = SIGRTMIN;
915 mode.acqsig = SIGRTMIN + 1;
916 r = ioctl(vt, VT_SETMODE, &mode);
919 log_error_errno(errno, "Cannot set VT_PROCESS on /dev/tty%u: %m", s->vtnr);
926 session_restore_vt(s);
930 void session_restore_vt(Session *s) {
931 _cleanup_free_ char *utf8 = NULL;
932 int vt, kb = K_XLATE;
933 struct vt_mode mode = { 0 };
935 vt = session_open_vt(s);
939 (void) ioctl(vt, KDSETMODE, KD_TEXT);
941 if (read_one_line_file("/sys/module/vt/parameters/default_utf8", &utf8) >= 0 && *utf8 == '1')
944 (void) ioctl(vt, KDSKBMODE, kb);
947 (void) ioctl(vt, VT_SETMODE, &mode);
951 s->vtfd = safe_close(s->vtfd);
954 void session_leave_vt(Session *s) {
959 /* This is called whenever we get a VT-switch signal from the kernel.
960 * We acknowledge all of them unconditionally. Note that session are
961 * free to overwrite those handlers and we only register them for
962 * sessions with controllers. Legacy sessions are not affected.
963 * However, if we switch from a non-legacy to a legacy session, we must
964 * make sure to pause all device before acknowledging the switch. We
965 * process the real switch only after we are notified via sysfs, so the
966 * legacy session might have already started using the devices. If we
967 * don't pause the devices before the switch, we might confuse the
968 * session we switch to. */
973 session_device_pause_all(s);
974 r = ioctl(s->vtfd, VT_RELDISP, 1);
976 log_debug_errno(errno, "Cannot release VT of session %s: %m", s->id);
979 bool session_is_controller(Session *s, const char *sender) {
982 return streq_ptr(s->controller, sender);
985 static void session_release_controller(Session *s, bool notify) {
986 _cleanup_free_ char *name = NULL;
992 name = s->controller;
994 /* By resetting the controller before releasing the devices, we won't
995 * send notification signals. This avoids sending useless notifications
996 * if the controller is released on disconnects. */
998 s->controller = NULL;
1000 while ((sd = hashmap_first(s->devices)))
1001 session_device_free(sd);
1003 s->controller = NULL;
1004 manager_drop_busname(s->manager, name);
1007 int session_set_controller(Session *s, const char *sender, bool force) {
1008 _cleanup_free_ char *name = NULL;
1014 if (session_is_controller(s, sender))
1016 if (s->controller && !force)
1019 name = strdup(sender);
1023 r = manager_watch_busname(s->manager, name);
1027 /* When setting a session controller, we forcibly mute the VT and set
1028 * it into graphics-mode. Applications can override that by changing
1029 * VT state after calling TakeControl(). However, this serves as a good
1030 * default and well-behaving controllers can now ignore VTs entirely.
1031 * Note that we reset the VT on ReleaseControl() and if the controller
1033 * If logind crashes/restarts, we restore the controller during restart
1034 * or reset the VT in case it crashed/exited, too. */
1035 r = session_prepare_vt(s);
1037 manager_drop_busname(s->manager, name);
1041 session_release_controller(s, true);
1042 s->controller = name;
1049 void session_drop_controller(Session *s) {
1055 session_release_controller(s, false);
1057 session_restore_vt(s);
1060 static const char* const session_state_table[_SESSION_STATE_MAX] = {
1061 [SESSION_OPENING] = "opening",
1062 [SESSION_ONLINE] = "online",
1063 [SESSION_ACTIVE] = "active",
1064 [SESSION_CLOSING] = "closing"
1067 DEFINE_STRING_TABLE_LOOKUP(session_state, SessionState);
1069 static const char* const session_type_table[_SESSION_TYPE_MAX] = {
1070 [SESSION_UNSPECIFIED] = "unspecified",
1071 [SESSION_TTY] = "tty",
1072 [SESSION_X11] = "x11",
1073 [SESSION_WAYLAND] = "wayland",
1074 [SESSION_MIR] = "mir",
1075 [SESSION_WEB] = "web",
1078 DEFINE_STRING_TABLE_LOOKUP(session_type, SessionType);
1080 static const char* const session_class_table[_SESSION_CLASS_MAX] = {
1081 [SESSION_USER] = "user",
1082 [SESSION_GREETER] = "greeter",
1083 [SESSION_LOCK_SCREEN] = "lock-screen",
1084 [SESSION_BACKGROUND] = "background"
1087 DEFINE_STRING_TABLE_LOOKUP(session_class, SessionClass);
1089 static const char* const kill_who_table[_KILL_WHO_MAX] = {
1090 [KILL_LEADER] = "leader",
1094 DEFINE_STRING_TABLE_LOOKUP(kill_who, KillWho);