src/login/logind-session.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #pragma once
   4
   5 /***
   6   This file is part of systemd.
   7
   8   Copyright 2011 Lennart Poettering
   9
  10   systemd is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU Lesser General Public License as published by
  12   the Free Software Foundation; either version 2.1 of the License, or
  13   (at your option) any later version.
  14
  15   systemd is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 ***/
  23
  24 typedef struct Session Session;
  25 typedef enum KillWho KillWho;
  26
  27 #include "list.h"
  28 #include "util.h"
  29 #include "logind.h"
  30 #include "logind-seat.h"
  31 #include "logind-session-device.h"
  32 #include "logind-user.h"
  33 #include "login-shared.h"
  34
  35 typedef enum SessionState {
  36         SESSION_OPENING,  /* Session scope is being created */
  37         SESSION_ONLINE,   /* Logged in */
  38         SESSION_ACTIVE,   /* Logged in and in the fg */
  39         SESSION_CLOSING,  /* Logged out, but scope is still there */
  40         _SESSION_STATE_MAX,
  41         _SESSION_STATE_INVALID = -1
  42 } SessionState;
  43
  44 typedef enum SessionClass {
  45         SESSION_USER,
  46         SESSION_GREETER,
  47         SESSION_LOCK_SCREEN,
  48         SESSION_BACKGROUND,
  49         _SESSION_CLASS_MAX,
  50         _SESSION_CLASS_INVALID = -1
  51 } SessionClass;
  52
  53 typedef enum SessionType {
  54         SESSION_UNSPECIFIED,
  55         SESSION_TTY,
  56         SESSION_X11,
  57         SESSION_WAYLAND,
  58         SESSION_MIR,
  59         _SESSION_TYPE_MAX,
  60         _SESSION_TYPE_INVALID = -1
  61 } SessionType;
  62
  63 #define SESSION_TYPE_IS_GRAPHICAL(type) IN_SET(type, SESSION_X11, SESSION_WAYLAND, SESSION_MIR)
  64
  65 enum KillWho {
  66         KILL_LEADER,
  67         KILL_ALL,
  68         _KILL_WHO_MAX,
  69         _KILL_WHO_INVALID = -1
  70 };
  71
  72 struct Session {
  73         Manager *manager;
  74
  75         const char *id;
  76         unsigned int pos;
  77         SessionType type;
  78         SessionClass class;
  79
  80         char *state_file;
  81
  82         User *user;
  83
  84         dual_timestamp timestamp;
  85
  86         char *tty;
  87         char *display;
  88
  89         bool remote;
  90         char *remote_user;
  91         char *remote_host;
  92         char *service;
  93         char *desktop;
  94
  95         char *scope;
  96         char *scope_job;
  97
  98         Seat *seat;
  99         unsigned int vtnr;
 100         int vtfd;
 101
 102         pid_t leader;
 103         uint32_t audit_id;
 104
 105         int fifo_fd;
 106         char *fifo_path;
 107
 108         sd_event_source *fifo_event_source;
 109
 110         bool idle_hint;
 111         dual_timestamp idle_hint_timestamp;
 112
 113         bool in_gc_queue:1;
 114         bool started:1;
 115         bool stopping:1;
 116
 117         sd_bus_message *create_message;
 118
 119         sd_event_source *timer_event_source;
 120
 121         char *controller;
 122         Hashmap *devices;
 123
 124         LIST_FIELDS(Session, sessions_by_user);
 125         LIST_FIELDS(Session, sessions_by_seat);
 126
 127         LIST_FIELDS(Session, gc_queue);
 128 };
 129
 130 Session *session_new(Manager *m, const char *id);
 131 void session_free(Session *s);
 132 void session_set_user(Session *s, User *u);
 133 bool session_check_gc(Session *s, bool drop_not_started);
 134 void session_add_to_gc_queue(Session *s);
 135 int session_activate(Session *s);
 136 bool session_is_active(Session *s);
 137 int session_get_idle_hint(Session *s, dual_timestamp *t);
 138 void session_set_idle_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 void 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
 177 bool session_is_controller(Session *s, const char *sender);
 178 int session_set_controller(Session *s, const char *sender, bool force);
 179 void session_drop_controller(Session *s);