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