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