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_TYPE_MAX,
  59         _SESSION_TYPE_INVALID = -1
  60 } SessionType;
  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         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         char *scope;
  93         char *scope_job;
  94
  95         Seat *seat;
  96         unsigned int vtnr;
  97         int vtfd;
  98         sd_event_source *vt_source;
  99
 100         pid_t leader;
 101         uint32_t audit_id;
 102
 103         int fifo_fd;
 104         char *fifo_path;
 105
 106         sd_event_source *fifo_event_source;
 107
 108         bool idle_hint;
 109         dual_timestamp idle_hint_timestamp;
 110
 111         bool in_gc_queue:1;
 112         bool started:1;
 113
 114         sd_bus_message *create_message;
 115
 116         char *controller;
 117         Hashmap *devices;
 118
 119         LIST_FIELDS(Session, sessions_by_user);
 120         LIST_FIELDS(Session, sessions_by_seat);
 121
 122         LIST_FIELDS(Session, gc_queue);
 123 };
 124
 125 Session *session_new(Manager *m, const char *id);
 126 void session_free(Session *s);
 127 void session_set_user(Session *s, User *u);
 128 bool session_check_gc(Session *s, bool drop_not_started);
 129 void session_add_to_gc_queue(Session *s);
 130 int session_activate(Session *s);
 131 bool session_is_active(Session *s);
 132 int session_get_idle_hint(Session *s, dual_timestamp *t);
 133 void session_set_idle_hint(Session *s, bool b);
 134 int session_create_fifo(Session *s);
 135 void session_remove_fifo(Session *s);
 136 int session_start(Session *s);
 137 int session_stop(Session *s);
 138 int session_finalize(Session *s);
 139 int session_save(Session *s);
 140 int session_load(Session *s);
 141 int session_kill(Session *s, KillWho who, int signo);
 142
 143 SessionState session_get_state(Session *u);
 144
 145 extern const sd_bus_vtable session_vtable[];
 146 int session_node_enumerator(sd_bus *bus, const char *path,void *userdata, char ***nodes, sd_bus_error *error);
 147 int session_object_find(sd_bus *bus, const char *path, const char *interface, void *userdata, void **found, sd_bus_error *error);
 148 char *session_bus_path(Session *s);
 149
 150 int session_send_signal(Session *s, bool new_session);
 151 int session_send_changed(Session *s, const char *properties, ...) _sentinel_;
 152 int session_send_lock(Session *s, bool lock);
 153 int session_send_lock_all(Manager *m, bool lock);
 154
 155 int session_send_create_reply(Session *s, sd_bus_error *error);
 156
 157 const char* session_state_to_string(SessionState t) _const_;
 158 SessionState session_state_from_string(const char *s) _pure_;
 159
 160 const char* session_type_to_string(SessionType t) _const_;
 161 SessionType session_type_from_string(const char *s) _pure_;
 162
 163 const char* session_class_to_string(SessionClass t) _const_;
 164 SessionClass session_class_from_string(const char *s) _pure_;
 165
 166 const char *kill_who_to_string(KillWho k) _const_;
 167 KillWho kill_who_from_string(const char *s) _pure_;
 168
 169 void session_mute_vt(Session *s);
 170 void session_restore_vt(Session *s);
 171
 172 bool session_is_controller(Session *s, const char *sender);
 173 int session_set_controller(Session *s, const char *sender, bool force);
 174 void session_drop_controller(Session *s);