src/login/logind-session.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 /***
   5   Copyright 2011 Lennart Poettering
   6 ***/
   7
   8 typedef struct Session Session;
   9 typedef enum KillWho KillWho;
  10
  11 #include "list.h"
  12 #include "login-util.h"
  13 #include "logind-user.h"
  14
  15 typedef enum SessionState {
  16         SESSION_OPENING,  /* Session scope is being created */
  17         SESSION_ONLINE,   /* Logged in */
  18         SESSION_ACTIVE,   /* Logged in and in the fg */
  19         SESSION_CLOSING,  /* Logged out, but scope is still there */
  20         _SESSION_STATE_MAX,
  21         _SESSION_STATE_INVALID = -1
  22 } SessionState;
  23
  24 typedef enum SessionClass {
  25         SESSION_USER,
  26         SESSION_GREETER,
  27         SESSION_LOCK_SCREEN,
  28         SESSION_BACKGROUND,
  29         _SESSION_CLASS_MAX,
  30         _SESSION_CLASS_INVALID = -1
  31 } SessionClass;
  32
  33 typedef enum SessionType {
  34         SESSION_UNSPECIFIED,
  35         SESSION_TTY,
  36         SESSION_X11,
  37         SESSION_WAYLAND,
  38         SESSION_MIR,
  39         SESSION_WEB,
  40         _SESSION_TYPE_MAX,
  41         _SESSION_TYPE_INVALID = -1
  42 } SessionType;
  43
  44 #define SESSION_TYPE_IS_GRAPHICAL(type) IN_SET(type, SESSION_X11, SESSION_WAYLAND, SESSION_MIR)
  45
  46 enum KillWho {
  47         KILL_LEADER,
  48         KILL_ALL,
  49         _KILL_WHO_MAX,
  50         _KILL_WHO_INVALID = -1
  51 };
  52
  53 struct Session {
  54         Manager *manager;
  55
  56         const char *id;
  57         unsigned int position;
  58         SessionType type;
  59         SessionClass class;
  60
  61         char *state_file;
  62
  63         User *user;
  64
  65         dual_timestamp timestamp;
  66
  67         char *tty;
  68         char *display;
  69
  70         bool remote;
  71         char *remote_user;
  72         char *remote_host;
  73         char *service;
  74         char *desktop;
  75
  76         char *scope;
  77         char *scope_job;
  78
  79         Seat *seat;
  80         unsigned int vtnr;
  81         int vtfd;
  82
  83         pid_t leader;
  84         uint32_t audit_id;
  85
  86         int fifo_fd;
  87         char *fifo_path;
  88
  89         sd_event_source *fifo_event_source;
  90
  91         bool idle_hint;
  92         dual_timestamp idle_hint_timestamp;
  93
  94         bool locked_hint;
  95
  96         bool in_gc_queue:1;
  97         bool started:1;
  98         bool stopping:1;
  99
 100         bool was_active:1;
 101
 102         sd_bus_message *create_message;
 103
 104         sd_event_source *timer_event_source;
 105
 106         char *controller;
 107         Hashmap *devices;
 108         sd_bus_track *track;
 109
 110         LIST_FIELDS(Session, sessions_by_user);
 111         LIST_FIELDS(Session, sessions_by_seat);
 112
 113         LIST_FIELDS(Session, gc_queue);
 114 };
 115
 116 Session *session_new(Manager *m, const char *id);
 117 void session_free(Session *s);
 118 void session_set_user(Session *s, User *u);
 119 bool session_may_gc(Session *s, bool drop_not_started);
 120 void session_add_to_gc_queue(Session *s);
 121 int session_activate(Session *s);
 122 bool session_is_active(Session *s);
 123 int session_get_idle_hint(Session *s, dual_timestamp *t);
 124 void session_set_idle_hint(Session *s, bool b);
 125 int session_get_locked_hint(Session *s);
 126 void session_set_locked_hint(Session *s, bool b);
 127 int session_create_fifo(Session *s);
 128 int session_start(Session *s, sd_bus_message *properties);
 129 int session_stop(Session *s, bool force);
 130 int session_finalize(Session *s);
 131 int session_release(Session *s);
 132 int session_save(Session *s);
 133 int session_load(Session *s);
 134 int session_kill(Session *s, KillWho who, int signo);
 135
 136 SessionState session_get_state(Session *u);
 137
 138 extern const sd_bus_vtable session_vtable[];
 139 int session_node_enumerator(sd_bus *bus, const char *path,void *userdata, char ***nodes, sd_bus_error *error);
 140 int session_object_find(sd_bus *bus, const char *path, const char *interface, void *userdata, void **found, sd_bus_error *error);
 141 char *session_bus_path(Session *s);
 142
 143 int session_send_signal(Session *s, bool new_session);
 144 int session_send_changed(Session *s, const char *properties, ...) _sentinel_;
 145 int session_send_lock(Session *s, bool lock);
 146 int session_send_lock_all(Manager *m, bool lock);
 147
 148 int session_send_create_reply(Session *s, sd_bus_error *error);
 149
 150 const char* session_state_to_string(SessionState t) _const_;
 151 SessionState session_state_from_string(const char *s) _pure_;
 152
 153 const char* session_type_to_string(SessionType t) _const_;
 154 SessionType session_type_from_string(const char *s) _pure_;
 155
 156 const char* session_class_to_string(SessionClass t) _const_;
 157 SessionClass session_class_from_string(const char *s) _pure_;
 158
 159 const char *kill_who_to_string(KillWho k) _const_;
 160 KillWho kill_who_from_string(const char *s) _pure_;
 161
 162 int session_prepare_vt(Session *s);
 163 void session_restore_vt(Session *s);
 164 void session_leave_vt(Session *s);
 165
 166 bool session_is_controller(Session *s, const char *sender);
 167 int session_set_controller(Session *s, const char *sender, bool force, bool prepare);
 168 void session_drop_controller(Session *s);
 169
 170 int bus_session_method_activate(sd_bus_message *message, void *userdata, sd_bus_error *error);
 171 int bus_session_method_lock(sd_bus_message *message, void *userdata, sd_bus_error *error);
 172 int bus_session_method_terminate(sd_bus_message *message, void *userdata, sd_bus_error *error);
 173 int bus_session_method_kill(sd_bus_message *message, void *userdata, sd_bus_error *error);