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
  26 #include "list.h"
  27 #include "util.h"
  28 #include "logind.h"
  29 #include "logind-seat.h"
  30 #include "logind-user.h"
  31
  32 typedef enum SessionState {
  33         SESSION_ONLINE,   /* Logged in */
  34         SESSION_ACTIVE,   /* Logged in and in the fg */
  35         SESSION_CLOSING,  /* Logged out, but processes still remain */
  36         _SESSION_STATE_MAX,
  37         _SESSION_STATE_INVALID = -1
  38 } SessionState;
  39
  40 typedef enum SessionType {
  41         SESSION_UNSPECIFIED,
  42         SESSION_TTY,
  43         SESSION_X11,
  44         _SESSION_TYPE_MAX,
  45         _SESSION_TYPE_INVALID = -1
  46 } SessionType;
  47
  48 typedef enum SessionClass {
  49         SESSION_USER,
  50         SESSION_GREETER,
  51         SESSION_LOCK_SCREEN,
  52         _SESSION_CLASS_MAX,
  53         _SESSION_CLASS_INVALID = -1
  54 } SessionClass;
  55
  56 typedef enum KillWho {
  57         KILL_LEADER,
  58         KILL_ALL,
  59         _KILL_WHO_MAX,
  60         _KILL_WHO_INVALID = -1
  61 } KillWho;
  62
  63 struct Session {
  64         Manager *manager;
  65
  66         char *id;
  67         SessionType type;
  68         SessionClass class;
  69
  70         char *state_file;
  71
  72         User *user;
  73
  74         dual_timestamp timestamp;
  75
  76         char *tty;
  77         char *display;
  78
  79         bool remote;
  80         char *remote_user;
  81         char *remote_host;
  82
  83         char *service;
  84
  85         int vtnr;
  86         Seat *seat;
  87
  88         pid_t leader;
  89         uint32_t audit_id;
  90
  91         int fifo_fd;
  92         char *fifo_path;
  93
  94         char *cgroup_path;
  95         char **controllers, **reset_controllers;
  96
  97         bool idle_hint;
  98         dual_timestamp idle_hint_timestamp;
  99
 100         bool kill_processes;
 101         bool in_gc_queue:1;
 102         bool started:1;
 103
 104         LIST_FIELDS(Session, sessions_by_user);
 105         LIST_FIELDS(Session, sessions_by_seat);
 106
 107         LIST_FIELDS(Session, gc_queue);
 108 };
 109
 110 Session *session_new(Manager *m, User *u, const char *id);
 111 void session_free(Session *s);
 112 int session_check_gc(Session *s, bool drop_not_started);
 113 void session_add_to_gc_queue(Session *s);
 114 int session_activate(Session *s);
 115 bool session_is_active(Session *s);
 116 int session_get_idle_hint(Session *s, dual_timestamp *t);
 117 void session_set_idle_hint(Session *s, bool b);
 118 int session_create_fifo(Session *s);
 119 void session_remove_fifo(Session *s);
 120 int session_start(Session *s);
 121 int session_stop(Session *s);
 122 int session_save(Session *s);
 123 int session_load(Session *s);
 124 int session_kill(Session *s, KillWho who, int signo);
 125
 126 char *session_bus_path(Session *s);
 127
 128 SessionState session_get_state(Session *u);
 129
 130 extern const DBusObjectPathVTable bus_session_vtable;
 131
 132 int session_send_signal(Session *s, bool new_session);
 133 int session_send_changed(Session *s, const char *properties);
 134 int session_send_lock(Session *s, bool lock);
 135
 136 const char* session_state_to_string(SessionState t);
 137 SessionState session_state_from_string(const char *s);
 138
 139 const char* session_type_to_string(SessionType t);
 140 SessionType session_type_from_string(const char *s);
 141
 142 const char* session_class_to_string(SessionClass t);
 143 SessionClass session_class_from_string(const char *s);
 144
 145 const char *kill_who_to_string(KillWho k);
 146 KillWho kill_who_from_string(const char *s);