src/login/logind-session.h

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