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);
124 hashmap_remove(s->manager->session_units, s->scope);
128 /// elogind does not support systemd scope_jobs
133 sd_bus_message_unref(s->create_message);
137 free(s->remote_host);
138 free(s->remote_user);
142 hashmap_remove(s->manager->sessions, s->id);
148 void session_set_user(Session *s, User *u) {
153 LIST_PREPEND(sessions_by_user, u->sessions, s);
156 int session_save(Session *s) {
157 _cleanup_free_ char *temp_path = NULL;
158 _cleanup_fclose_ FILE *f = NULL;
169 r = mkdir_safe_label("/run/systemd/sessions", 0755, 0, 0);
173 r = fopen_temporary(s->state_file, &f, &temp_path);
179 fchmod(fileno(f), 0644);
182 "# This is private data. Do not parse.\n"
190 session_is_active(s),
191 session_state_to_string(session_get_state(s)),
195 fprintf(f, "TYPE=%s\n", session_type_to_string(s->type));
198 fprintf(f, "CLASS=%s\n", session_class_to_string(s->class));
201 fprintf(f, "SCOPE=%s\n", s->scope);
202 /// elogind does not support systemd scope_jobs
205 fprintf(f, "SCOPE_JOB=%s\n", s->scope_job);
209 fprintf(f, "FIFO=%s\n", s->fifo_path);
212 fprintf(f, "SEAT=%s\n", s->seat->id);
215 fprintf(f, "TTY=%s\n", s->tty);
218 fprintf(f, "DISPLAY=%s\n", s->display);
220 if (s->remote_host) {
221 _cleanup_free_ char *escaped;
223 escaped = cescape(s->remote_host);
229 fprintf(f, "REMOTE_HOST=%s\n", escaped);
232 if (s->remote_user) {
233 _cleanup_free_ char *escaped;
235 escaped = cescape(s->remote_user);
241 fprintf(f, "REMOTE_USER=%s\n", escaped);
245 _cleanup_free_ char *escaped;
247 escaped = cescape(s->service);
253 fprintf(f, "SERVICE=%s\n", escaped);
257 _cleanup_free_ char *escaped;
260 escaped = cescape(s->desktop);
266 fprintf(f, "DESKTOP=%s\n", escaped);
269 if (s->seat && seat_has_vts(s->seat))
270 fprintf(f, "VTNR=%u\n", s->vtnr);
273 fprintf(f, "POSITION=%u\n", s->position);
276 fprintf(f, "LEADER="PID_FMT"\n", s->leader);
279 fprintf(f, "AUDIT=%"PRIu32"\n", s->audit_id);
281 if (dual_timestamp_is_set(&s->timestamp))
283 "REALTIME="USEC_FMT"\n"
284 "MONOTONIC="USEC_FMT"\n",
285 s->timestamp.realtime,
286 s->timestamp.monotonic);
289 fprintf(f, "CONTROLLER=%s\n", s->controller);
291 r = fflush_and_check(f);
295 if (rename(temp_path, s->state_file) < 0) {
303 (void) unlink(s->state_file);
306 (void) unlink(temp_path);
308 return log_error_errno(r, "Failed to save session data %s: %m", s->state_file);
312 int session_load(Session *s) {
313 _cleanup_free_ char *remote = NULL,
330 r = parse_env_file(s->state_file, NEWLINE,
333 /// elogind does not support systemd scope_jobs
335 "SCOPE_JOB", &s->scope_job,
337 "FIFO", &s->fifo_path,
340 "DISPLAY", &s->display,
341 "REMOTE_HOST", &s->remote_host,
342 "REMOTE_USER", &s->remote_user,
343 "SERVICE", &s->service,
344 "DESKTOP", &s->desktop,
347 "POSITION", &position,
352 "REALTIME", &realtime,
353 "MONOTONIC", &monotonic,
354 "CONTROLLER", &controller,
358 return log_error_errno(r, "Failed to read %s: %m", s->state_file);
365 log_error("UID not specified for session %s", s->id);
369 r = parse_uid(uid, &u);
371 log_error("Failed to parse UID value %s for session %s.", uid, s->id);
375 user = hashmap_get(s->manager->users, UID_TO_PTR(u));
377 log_error("User of session %s not known.", s->id);
381 session_set_user(s, user);
385 k = parse_boolean(remote);
391 safe_atou(vtnr, &s->vtnr);
393 if (seat && !s->seat) {
396 o = hashmap_get(s->manager->seats, seat);
398 r = seat_attach_session(o, s);
400 log_error("Cannot attach session %s to seat %s", s->id, seat);
403 if (!s->seat || !seat_has_vts(s->seat))
406 if (position && s->seat) {
409 safe_atou(position, &npos);
410 seat_claim_position(s->seat, s, npos);
414 k = parse_pid(leader, &s->leader);
416 audit_session_from_pid(s->leader, &s->audit_id);
422 t = session_type_from_string(type);
430 c = session_class_from_string(class);
435 if (state && streq(state, "closing"))
441 /* If we open an unopened pipe for reading we will not
442 get an EOF. to trigger an EOF we hence open it for
443 writing, but close it right away which then will
444 trigger the EOF. This will happen immediately if no
445 other process has the FIFO open for writing, i. e.
446 when the session died before logind (re)started. */
448 fd = session_create_fifo(s);
453 unsigned long long l;
454 if (sscanf(realtime, "%llu", &l) > 0)
455 s->timestamp.realtime = l;
459 unsigned long long l;
460 if (sscanf(monotonic, "%llu", &l) > 0)
461 s->timestamp.monotonic = l;
465 if (bus_name_has_owner(s->manager->bus, controller, NULL) > 0)
466 session_set_controller(s, controller, false);
468 session_restore_vt(s);
474 int session_activate(Session *s) {
475 unsigned int num_pending;
483 if (s->seat->active == s)
486 /* on seats with VTs, we let VTs manage session-switching */
487 if (seat_has_vts(s->seat)) {
491 return chvt(s->vtnr);
494 /* On seats without VTs, we implement session-switching in logind. We
495 * try to pause all session-devices and wait until the session
496 * controller acknowledged them. Once all devices are asleep, we simply
497 * switch the active session and be done.
498 * We save the session we want to switch to in seat->pending_switch and
499 * seat_complete_switch() will perform the final switch. */
501 s->seat->pending_switch = s;
503 /* if no devices are running, immediately perform the session switch */
504 num_pending = session_device_try_pause_all(s);
506 seat_complete_switch(s->seat);
511 static int session_start_scope(Session *s) {
516 assert(s->user->slice);
519 _cleanup_bus_error_free_ sd_bus_error error = SD_BUS_ERROR_NULL;
520 _cleanup_free_ char *description = NULL;
521 char *scope = NULL; //, *job = NULL;
523 description = strjoin("Session ", s->id, " of user ", s->user->name, NULL);
527 scope = strjoin("session-", s->id, ".scope", NULL);
531 /// elogind : Do not try to use dbus to call systemd
533 r = manager_start_scope(s->manager, scope, s->leader, s->user->slice, description, "logind.service", "systemd-user-sessions.service", &error, &job);
536 log_error("Failed to start session scope %s: %s %s",
537 scope, bus_error_message(&error, r), error.name);
542 /// elogind does not support scope jobs
551 hashmap_put(s->manager->session_units, s->scope, s);
556 int session_start(Session *s) {
567 r = user_start(s->user);
572 r = session_start_scope(s);
576 log_struct(s->class == SESSION_BACKGROUND ? LOG_DEBUG : LOG_INFO,
577 LOG_MESSAGE_ID(SD_MESSAGE_SESSION_START),
578 "SESSION_ID=%s", s->id,
579 "USER_ID=%s", s->user->name,
580 "LEADER="PID_FMT, s->leader,
581 LOG_MESSAGE("New session %s of user %s.", s->id, s->user->name),
584 if (!dual_timestamp_is_set(&s->timestamp))
585 dual_timestamp_get(&s->timestamp);
588 seat_read_active_vt(s->seat);
592 user_elect_display(s->user);
601 session_send_signal(s, true);
602 user_send_changed(s->user, "Sessions", "Display", NULL);
604 if (s->seat->active == s)
605 seat_send_changed(s->seat, "Sessions", "ActiveSession", NULL);
607 seat_send_changed(s->seat, "Sessions", NULL);
613 /// UNNEEDED by elogind
615 static int session_stop_scope(Session *s, bool force) {
616 _cleanup_bus_error_free_ sd_bus_error error = SD_BUS_ERROR_NULL;
625 if (force || manager_shall_kill(s->manager, s->user->name)) {
626 r = manager_stop_unit(s->manager, s->scope, &error, &job);
628 log_error("Failed to stop session scope: %s", bus_error_message(&error, r));
635 r = manager_abandon_scope(s->manager, s->scope, &error);
637 log_error("Failed to abandon session scope: %s", bus_error_message(&error, r));
646 int session_stop(Session *s, bool force) {
654 s->timer_event_source = sd_event_source_unref(s->timer_event_source);
657 seat_evict_position(s->seat, s);
659 /* We are going down, don't care about FIFOs anymore */
660 session_remove_fifo(s);
663 /// @todo : Currently elogind does not start scopes. It remains to be seen
664 /// whether this is really not needed, but then, elogind is not a
665 /// systemd cgroups manager.
667 r = session_stop_scope(s, force);
672 user_elect_display(s->user);
680 int session_finalize(Session *s) {
689 log_struct(s->class == SESSION_BACKGROUND ? LOG_DEBUG : LOG_INFO,
690 LOG_MESSAGE_ID(SD_MESSAGE_SESSION_STOP),
691 "SESSION_ID=%s", s->id,
692 "USER_ID=%s", s->user->name,
693 "LEADER="PID_FMT, s->leader,
694 LOG_MESSAGE("Removed session %s.", s->id),
697 s->timer_event_source = sd_event_source_unref(s->timer_event_source);
700 seat_evict_position(s->seat, s);
702 /* Kill session devices */
703 while ((sd = hashmap_first(s->devices)))
704 session_device_free(sd);
706 (void) unlink(s->state_file);
707 session_add_to_gc_queue(s);
708 user_add_to_gc_queue(s->user);
711 session_send_signal(s, false);
716 if (s->seat->active == s)
717 seat_set_active(s->seat, NULL);
720 seat_send_changed(s->seat, "Sessions", NULL);
724 user_send_changed(s->user, "Sessions", "Display", NULL);
729 static int release_timeout_callback(sd_event_source *es, uint64_t usec, void *userdata) {
730 Session *s = userdata;
735 session_stop(s, false);
739 int session_release(Session *s) {
742 if (!s->started || s->stopping)
745 if (s->timer_event_source)
748 return sd_event_add_time(s->manager->event,
749 &s->timer_event_source,
751 now(CLOCK_MONOTONIC) + RELEASE_USEC, 0,
752 release_timeout_callback, s);
755 bool session_is_active(Session *s) {
761 return s->seat->active == s;
764 static int get_tty_atime(const char *tty, usec_t *atime) {
765 _cleanup_free_ char *p = NULL;
771 if (!path_is_absolute(tty)) {
772 p = strappend("/dev/", tty);
777 } else if (!path_startswith(tty, "/dev/"))
780 if (lstat(tty, &st) < 0)
783 *atime = timespec_load(&st.st_atim);
787 static int get_process_ctty_atime(pid_t pid, usec_t *atime) {
788 _cleanup_free_ char *p = NULL;
794 r = get_ctty(pid, NULL, &p);
798 return get_tty_atime(p, atime);
801 int session_get_idle_hint(Session *s, dual_timestamp *t) {
807 /* Explicit idle hint is set */
810 *t = s->idle_hint_timestamp;
815 /* Graphical sessions should really implement a real
820 /* For sessions with an explicitly configured tty, let's check
823 r = get_tty_atime(s->tty, &atime);
828 /* For sessions with a leader but no explicitly configured
829 * tty, let's check the controlling tty of the leader */
831 r = get_process_ctty_atime(s->leader, &atime);
838 *t = s->idle_hint_timestamp;
844 dual_timestamp_from_realtime(t, atime);
846 n = now(CLOCK_REALTIME);
848 if (s->manager->idle_action_usec <= 0)
851 return atime + s->manager->idle_action_usec <= n;
854 void session_set_idle_hint(Session *s, bool b) {
857 if (s->idle_hint == b)
861 dual_timestamp_get(&s->idle_hint_timestamp);
863 session_send_changed(s, "IdleHint", "IdleSinceHint", "IdleSinceHintMonotonic", NULL);
866 seat_send_changed(s->seat, "IdleHint", "IdleSinceHint", "IdleSinceHintMonotonic", NULL);
868 user_send_changed(s->user, "IdleHint", "IdleSinceHint", "IdleSinceHintMonotonic", NULL);
869 manager_send_changed(s->manager, "IdleHint", "IdleSinceHint", "IdleSinceHintMonotonic", NULL);
872 static int session_dispatch_fifo(sd_event_source *es, int fd, uint32_t revents, void *userdata) {
873 Session *s = userdata;
876 assert(s->fifo_fd == fd);
878 /* EOF on the FIFO means the session died abnormally. */
880 session_remove_fifo(s);
881 session_stop(s, false);
886 int session_create_fifo(Session *s) {
893 r = mkdir_safe_label("/run/systemd/sessions", 0755, 0, 0);
897 if (asprintf(&s->fifo_path, "/run/systemd/sessions/%s.ref", s->id) < 0)
900 if (mkfifo(s->fifo_path, 0600) < 0 && errno != EEXIST)
904 /* Open reading side */
905 if (s->fifo_fd < 0) {
906 s->fifo_fd = open(s->fifo_path, O_RDONLY|O_CLOEXEC|O_NDELAY);
912 if (!s->fifo_event_source) {
913 r = sd_event_add_io(s->manager->event, &s->fifo_event_source, s->fifo_fd, 0, session_dispatch_fifo, s);
917 r = sd_event_source_set_priority(s->fifo_event_source, SD_EVENT_PRIORITY_IDLE);
922 /* Open writing side */
923 r = open(s->fifo_path, O_WRONLY|O_CLOEXEC|O_NDELAY);
930 static void session_remove_fifo(Session *s) {
933 s->fifo_event_source = sd_event_source_unref(s->fifo_event_source);
934 s->fifo_fd = safe_close(s->fifo_fd);
937 unlink(s->fifo_path);
943 bool session_check_gc(Session *s, bool drop_not_started) {
946 if (drop_not_started && !s->started)
952 if (s->fifo_fd >= 0) {
953 if (pipe_eof(s->fifo_fd) <= 0)
957 /// elogind supports neither scopes nor jobs
959 if (s->scope_job && manager_job_is_active(s->manager, s->scope_job))
962 if (s->scope && manager_unit_is_active(s->manager, s->scope))
969 void session_add_to_gc_queue(Session *s) {
975 LIST_PREPEND(gc_queue, s->manager->session_gc_queue, s);
976 s->in_gc_queue = true;
979 SessionState session_get_state(Session *s) {
982 /* always check closing first */
983 if (s->stopping || s->timer_event_source)
984 return SESSION_CLOSING;
986 /// elogind does not support systemd scope_jobs
988 if (s->scope_job || s->fifo_fd < 0)
992 return SESSION_OPENING;
994 if (session_is_active(s))
995 return SESSION_ACTIVE;
997 return SESSION_ONLINE;
1000 int session_kill(Session *s, KillWho who, int signo) {
1003 /// FIXME: Without direct cgroup support, elogind can not kill sessions
1008 return manager_kill_unit(s->manager, s->scope, who, signo, NULL);
1014 static int session_open_vt(Session *s) {
1015 char path[sizeof("/dev/tty") + DECIMAL_STR_MAX(s->vtnr)];
1023 sprintf(path, "/dev/tty%u", s->vtnr);
1024 s->vtfd = open_terminal(path, O_RDWR | O_CLOEXEC | O_NONBLOCK | O_NOCTTY);
1026 return log_error_errno(errno, "cannot open VT %s of session %s: %m", path, s->id);
1031 int session_prepare_vt(Session *s) {
1033 struct vt_mode mode = { 0 };
1038 vt = session_open_vt(s);
1042 r = fchown(vt, s->user->uid, -1);
1045 log_error_errno(errno, "Cannot change owner of /dev/tty%u: %m", s->vtnr);
1049 r = ioctl(vt, KDSKBMODE, K_OFF);
1052 log_error_errno(errno, "Cannot set K_OFF on /dev/tty%u: %m", s->vtnr);
1056 r = ioctl(vt, KDSETMODE, KD_GRAPHICS);
1059 log_error_errno(errno, "Cannot set KD_GRAPHICS on /dev/tty%u: %m", s->vtnr);
1063 /* Oh, thanks to the VT layer, VT_AUTO does not work with KD_GRAPHICS.
1064 * So we need a dummy handler here which just acknowledges *all* VT
1065 * switch requests. */
1066 mode.mode = VT_PROCESS;
1067 mode.relsig = SIGRTMIN;
1068 mode.acqsig = SIGRTMIN + 1;
1069 r = ioctl(vt, VT_SETMODE, &mode);
1072 log_error_errno(errno, "Cannot set VT_PROCESS on /dev/tty%u: %m", s->vtnr);
1079 session_restore_vt(s);
1083 void session_restore_vt(Session *s) {
1084 _cleanup_free_ char *utf8 = NULL;
1085 int vt, kb = K_XLATE;
1086 struct vt_mode mode = { 0 };
1088 /* We need to get a fresh handle to the virtual terminal,
1089 * since the old file-descriptor is potentially in a hung-up
1090 * state after the controlling process exited; we do a
1091 * little dance to avoid having the terminal be available
1092 * for reuse before we've cleaned it up.
1094 int old_fd = s->vtfd;
1097 vt = session_open_vt(s);
1103 (void) ioctl(vt, KDSETMODE, KD_TEXT);
1105 if (read_one_line_file("/sys/module/vt/parameters/default_utf8", &utf8) >= 0 && *utf8 == '1')
1108 (void) ioctl(vt, KDSKBMODE, kb);
1110 mode.mode = VT_AUTO;
1111 (void) ioctl(vt, VT_SETMODE, &mode);
1115 s->vtfd = safe_close(s->vtfd);
1118 void session_leave_vt(Session *s) {
1123 /* This is called whenever we get a VT-switch signal from the kernel.
1124 * We acknowledge all of them unconditionally. Note that session are
1125 * free to overwrite those handlers and we only register them for
1126 * sessions with controllers. Legacy sessions are not affected.
1127 * However, if we switch from a non-legacy to a legacy session, we must
1128 * make sure to pause all device before acknowledging the switch. We
1129 * process the real switch only after we are notified via sysfs, so the
1130 * legacy session might have already started using the devices. If we
1131 * don't pause the devices before the switch, we might confuse the
1132 * session we switch to. */
1137 session_device_pause_all(s);
1138 r = ioctl(s->vtfd, VT_RELDISP, 1);
1140 log_debug_errno(errno, "Cannot release VT of session %s: %m", s->id);
1143 bool session_is_controller(Session *s, const char *sender) {
1146 return streq_ptr(s->controller, sender);
1149 static void session_release_controller(Session *s, bool notify) {
1150 _cleanup_free_ char *name = NULL;
1156 name = s->controller;
1158 /* By resetting the controller before releasing the devices, we won't
1159 * send notification signals. This avoids sending useless notifications
1160 * if the controller is released on disconnects. */
1162 s->controller = NULL;
1164 while ((sd = hashmap_first(s->devices)))
1165 session_device_free(sd);
1167 s->controller = NULL;
1168 s->track = sd_bus_track_unref(s->track);
1171 static int on_bus_track(sd_bus_track *track, void *userdata) {
1172 Session *s = userdata;
1177 session_drop_controller(s);
1182 int session_set_controller(Session *s, const char *sender, bool force) {
1183 _cleanup_free_ char *name = NULL;
1189 if (session_is_controller(s, sender))
1191 if (s->controller && !force)
1194 name = strdup(sender);
1198 s->track = sd_bus_track_unref(s->track);
1199 r = sd_bus_track_new(s->manager->bus, &s->track, on_bus_track, s);
1203 r = sd_bus_track_add_name(s->track, name);
1207 /* When setting a session controller, we forcibly mute the VT and set
1208 * it into graphics-mode. Applications can override that by changing
1209 * VT state after calling TakeControl(). However, this serves as a good
1210 * default and well-behaving controllers can now ignore VTs entirely.
1211 * Note that we reset the VT on ReleaseControl() and if the controller
1213 * If logind crashes/restarts, we restore the controller during restart
1214 * or reset the VT in case it crashed/exited, too. */
1215 r = session_prepare_vt(s);
1217 s->track = sd_bus_track_unref(s->track);
1221 session_release_controller(s, true);
1222 s->controller = name;
1229 void session_drop_controller(Session *s) {
1235 s->track = sd_bus_track_unref(s->track);
1236 session_release_controller(s, false);
1238 session_restore_vt(s);
1241 static const char* const session_state_table[_SESSION_STATE_MAX] = {
1242 [SESSION_OPENING] = "opening",
1243 [SESSION_ONLINE] = "online",
1244 [SESSION_ACTIVE] = "active",
1245 [SESSION_CLOSING] = "closing"
1248 DEFINE_STRING_TABLE_LOOKUP(session_state, SessionState);
1250 static const char* const session_type_table[_SESSION_TYPE_MAX] = {
1251 [SESSION_UNSPECIFIED] = "unspecified",
1252 [SESSION_TTY] = "tty",
1253 [SESSION_X11] = "x11",
1254 [SESSION_WAYLAND] = "wayland",
1255 [SESSION_MIR] = "mir",
1256 [SESSION_WEB] = "web",
1259 DEFINE_STRING_TABLE_LOOKUP(session_type, SessionType);
1261 static const char* const session_class_table[_SESSION_CLASS_MAX] = {
1262 [SESSION_USER] = "user",
1263 [SESSION_GREETER] = "greeter",
1264 [SESSION_LOCK_SCREEN] = "lock-screen",
1265 [SESSION_BACKGROUND] = "background"
1268 DEFINE_STRING_TABLE_LOOKUP(session_class, SessionClass);
1270 static const char* const kill_who_table[_KILL_WHO_MAX] = {
1271 [KILL_LEADER] = "leader",
1275 DEFINE_STRING_TABLE_LOOKUP(kill_who, KillWho);