1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
4 typedef struct Session Session
;
5 typedef enum KillWho KillWho
;
8 #include "login-util.h"
9 #include "logind-user.h"
11 #include "string-util.h"
13 typedef enum SessionState
{
14 SESSION_OPENING
, /* Session scope is being created */
15 SESSION_ONLINE
, /* Logged in */
16 SESSION_ACTIVE
, /* Logged in and in the fg */
17 SESSION_CLOSING
, /* Logged out, but scope is still there */
19 _SESSION_STATE_INVALID
= -EINVAL
,
22 typedef enum SessionClass
{
23 SESSION_USER
, /* A regular user session */
24 SESSION_USER_EARLY
, /* A user session, that is not ordered after systemd-user-sessions.service (i.e. for root) */
25 SESSION_GREETER
, /* A login greeter pseudo-session */
26 SESSION_LOCK_SCREEN
, /* A lock screen */
27 SESSION_BACKGROUND
, /* Things like cron jobs, which are non-interactive */
28 SESSION_BACKGROUND_LIGHT
, /* Like SESSION_BACKGROUND, but without the service manager */
29 SESSION_MANAGER
, /* The service manager */
30 SESSION_MANAGER_EARLY
, /* The service manager for root (which is allowed to run before systemd-user-sessions.service) */
32 _SESSION_CLASS_INVALID
= -EINVAL
,
35 /* Whether we shall allow sessions of this class to run before 'systemd-user-sessions.service'. It's
36 * generally set for root sessions, but no one else. */
37 #define SESSION_CLASS_IS_EARLY(class) IN_SET((class), SESSION_USER_EARLY, SESSION_MANAGER_EARLY)
39 /* Which session classes want their own scope units? (all of them, except the manager, which comes in its own service unit already */
40 #define SESSION_CLASS_WANTS_SCOPE(class) IN_SET((class), SESSION_USER, SESSION_USER_EARLY, SESSION_GREETER, SESSION_LOCK_SCREEN, SESSION_BACKGROUND, SESSION_BACKGROUND_LIGHT)
42 /* Which session classes want their own per-user service manager? */
43 #define SESSION_CLASS_WANTS_SERVICE_MANAGER(class) IN_SET((class), SESSION_USER, SESSION_USER_EARLY, SESSION_GREETER, SESSION_LOCK_SCREEN, SESSION_BACKGROUND)
45 /* Which session classes can pin our user tracking? */
46 #define SESSION_CLASS_PIN_USER(class) (!IN_SET((class), SESSION_MANAGER, SESSION_MANAGER_EARLY))
48 /* Which session classes decide whether system is idle? (should only cover sessions that have input, and are not idle screens themselves)*/
49 #define SESSION_CLASS_CAN_IDLE(class) (IN_SET((class), SESSION_USER, SESSION_USER_EARLY, SESSION_GREETER))
51 /* Which session classes have a lock screen concept? */
52 #define SESSION_CLASS_CAN_LOCK(class) (IN_SET((class), SESSION_USER, SESSION_USER_EARLY))
54 /* Which sessions are candidates to become "display" sessions */
55 #define SESSION_CLASS_CAN_DISPLAY(class) (IN_SET((class), SESSION_USER, SESSION_USER_EARLY, SESSION_GREETER))
57 /* Which sessions classes should be subject to stop-in-idle */
58 #define SESSION_CLASS_CAN_STOP_ON_IDLE(class) (IN_SET((class), SESSION_USER, SESSION_USER_EARLY))
60 /* Which session classes can take control of devices */
61 #define SESSION_CLASS_CAN_TAKE_DEVICE(class) (IN_SET((class), SESSION_USER, SESSION_USER_EARLY, SESSION_GREETER, SESSION_LOCK_SCREEN))
63 /* Which session classes allow changing session types */
64 #define SESSION_CLASS_CAN_CHANGE_TYPE(class) (IN_SET((class), SESSION_USER, SESSION_USER_EARLY, SESSION_GREETER, SESSION_LOCK_SCREEN))
66 typedef enum SessionType
{
74 _SESSION_TYPE_INVALID
= -EINVAL
,
77 #define SESSION_TYPE_IS_GRAPHICAL(type) IN_SET(type, SESSION_X11, SESSION_WAYLAND, SESSION_MIR)
83 _KILL_WHO_INVALID
= -EINVAL
,
86 typedef enum TTYValidity
{
89 TTY_UTMP_INCONSISTENT
, /* may happen on ssh sessions with multiplexed TTYs */
91 _TTY_VALIDITY_INVALID
= -EINVAL
,
100 SessionType original_type
;
107 dual_timestamp timestamp
;
111 TTYValidity tty_validity
;
127 bool leader_fd_saved
; /* pidfd of leader uploaded to fdstore */
128 pid_t deserialized_pid
; /* PID deserialized from state file (for verification when pidfd is used) */
134 sd_event_source
*fifo_event_source
;
135 sd_event_source
*leader_pidfd_event_source
;
138 dual_timestamp idle_hint_timestamp
;
148 sd_bus_message
*create_message
;
150 /* Set up when a client requested to release the session via the bus */
151 sd_event_source
*timer_event_source
;
157 sd_event_source
*stop_on_idle_event_source
;
159 LIST_FIELDS(Session
, sessions_by_user
);
160 LIST_FIELDS(Session
, sessions_by_seat
);
162 LIST_FIELDS(Session
, gc_queue
);
165 int session_new(Session
**ret
, Manager
*m
, const char *id
);
166 Session
* session_free(Session
*s
);
168 DEFINE_TRIVIAL_CLEANUP_FUNC(Session
*, session_free
);
170 void session_set_user(Session
*s
, User
*u
);
171 int session_set_leader_consume(Session
*s
, PidRef _leader
);
172 bool session_may_gc(Session
*s
, bool drop_not_started
);
173 void session_add_to_gc_queue(Session
*s
);
174 int session_activate(Session
*s
);
175 bool session_is_active(Session
*s
);
176 int session_get_idle_hint(Session
*s
, dual_timestamp
*t
);
177 int session_set_idle_hint(Session
*s
, bool b
);
178 int session_get_locked_hint(Session
*s
);
179 int session_set_locked_hint(Session
*s
, bool b
);
180 void session_set_type(Session
*s
, SessionType t
);
181 int session_set_display(Session
*s
, const char *display
);
182 int session_set_tty(Session
*s
, const char *tty
);
183 int session_create_fifo(Session
*s
);
184 int session_start(Session
*s
, sd_bus_message
*properties
, sd_bus_error
*error
);
185 int session_stop(Session
*s
, bool force
);
186 int session_finalize(Session
*s
);
187 int session_release(Session
*s
);
188 int session_save(Session
*s
);
189 int session_load(Session
*s
);
190 int session_kill(Session
*s
, KillWho who
, int signo
);
192 SessionState
session_get_state(Session
*u
);
194 const char* session_state_to_string(SessionState t
) _const_
;
195 SessionState
session_state_from_string(const char *s
) _pure_
;
197 const char* session_type_to_string(SessionType t
) _const_
;
198 SessionType
session_type_from_string(const char *s
) _pure_
;
200 const char* session_class_to_string(SessionClass t
) _const_
;
201 SessionClass
session_class_from_string(const char *s
) _pure_
;
203 const char *kill_who_to_string(KillWho k
) _const_
;
204 KillWho
kill_who_from_string(const char *s
) _pure_
;
206 const char* tty_validity_to_string(TTYValidity t
) _const_
;
207 TTYValidity
tty_validity_from_string(const char *s
) _pure_
;
209 void session_leave_vt(Session
*s
);
211 bool session_is_controller(Session
*s
, const char *sender
);
212 int session_set_controller(Session
*s
, const char *sender
, bool force
, bool prepare
);
213 void session_drop_controller(Session
*s
);
215 static inline bool SESSION_IS_SELF(const char *name
) {
216 return isempty(name
) || streq(name
, "self");
219 static inline bool SESSION_IS_AUTO(const char *name
) {
220 return streq_ptr(name
, "auto");