src/login/logind-session.h

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