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-user.h"
  32 #include "login-shared.h"
  33
  34 typedef enum SessionState {
  35         SESSION_OPENING,  /* Session scope is being created */
  36         SESSION_ONLINE,   /* Logged in */
  37         SESSION_ACTIVE,   /* Logged in and in the fg */
  38         SESSION_CLOSING,  /* Logged out, but scope is still there */
  39         _SESSION_STATE_MAX,
  40         _SESSION_STATE_INVALID = -1
  41 } SessionState;
  42
  43 typedef enum SessionClass {
  44         SESSION_USER,
  45         SESSION_GREETER,
  46         SESSION_LOCK_SCREEN,
  47         SESSION_BACKGROUND,
  48         _SESSION_CLASS_MAX,
  49         _SESSION_CLASS_INVALID = -1
  50 } SessionClass;
  51
  52 typedef enum SessionType {
  53         SESSION_UNSPECIFIED,
  54         SESSION_TTY,
  55         SESSION_X11,
  56         _SESSION_TYPE_MAX,
  57         _SESSION_TYPE_INVALID = -1
  58 } SessionType;
  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         char *id;
  71         SessionType type;
  72         SessionClass class;
  73
  74         char *state_file;
  75
  76         User *user;
  77
  78         dual_timestamp timestamp;
  79
  80         char *tty;
  81         char *display;
  82
  83         bool remote;
  84         char *remote_user;
  85         char *remote_host;
  86         char *service;
  87
  88         char *scope;
  89         char *scope_job;
  90
  91         int vtnr;
  92         Seat *seat;
  93
  94         pid_t leader;
  95         uint32_t audit_id;
  96
  97         int fifo_fd;
  98         char *fifo_path;
  99
 100         bool idle_hint;
 101         dual_timestamp idle_hint_timestamp;
 102
 103         bool in_gc_queue:1;
 104         bool started:1;
 105         bool closing:1;
 106
 107         DBusMessage *create_message;
 108
 109         char *controller;
 110
 111         LIST_FIELDS(Session, sessions_by_user);
 112         LIST_FIELDS(Session, sessions_by_seat);
 113
 114         LIST_FIELDS(Session, gc_queue);
 115 };
 116
 117 Session *session_new(Manager *m, const char *id);
 118 void session_free(Session *s);
 119 void session_set_user(Session *s, User *u);
 120 int session_check_gc(Session *s, bool drop_not_started);
 121 void session_add_to_gc_queue(Session *s);
 122 int session_activate(Session *s);
 123 bool session_is_active(Session *s);
 124 int session_get_idle_hint(Session *s, dual_timestamp *t);
 125 void session_set_idle_hint(Session *s, bool b);
 126 int session_create_fifo(Session *s);
 127 void session_remove_fifo(Session *s);
 128 int session_start(Session *s);
 129 int session_stop(Session *s);
 130 int session_finalize(Session *s);
 131 int session_save(Session *s);
 132 int session_load(Session *s);
 133 int session_kill(Session *s, KillWho who, int signo);
 134
 135 char *session_bus_path(Session *s);
 136
 137 SessionState session_get_state(Session *u);
 138
 139 extern const DBusObjectPathVTable bus_session_vtable;
 140
 141 int session_send_signal(Session *s, bool new_session);
 142 int session_send_changed(Session *s, const char *properties);
 143 int session_send_lock(Session *s, bool lock);
 144 int session_send_lock_all(Manager *m, bool lock);
 145
 146 int session_send_create_reply(Session *s, DBusError *error);
 147
 148 const char* session_state_to_string(SessionState t) _const_;
 149 SessionState session_state_from_string(const char *s) _pure_;
 150
 151 const char* session_type_to_string(SessionType t) _const_;
 152 SessionType session_type_from_string(const char *s) _pure_;
 153
 154 const char* session_class_to_string(SessionClass t) _const_;
 155 SessionClass session_class_from_string(const char *s) _pure_;
 156
 157 const char *kill_who_to_string(KillWho k) _const_;
 158 KillWho kill_who_from_string(const char *s) _pure_;
 159
 160 bool session_is_controller(Session *s, const char *sender);
 161 int session_set_controller(Session *s, const char *sender, bool force);
 162 void session_drop_controller(Session *s);