src/libsystemd-terminal/sysview.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 /***
   4   This file is part of systemd.
   5
   6   Copyright (C) 2014 David Herrmann <dh.herrmann@gmail.com>
   7
   8   systemd is free software; you can redistribute it and/or modify it
   9   under the terms of the GNU Lesser General Public License as published by
  10   the Free Software Foundation; either version 2.1 of the License, or
  11   (at your option) any later version.
  12
  13   systemd is distributed in the hope that it will be useful, but
  14   WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16   Lesser General Public License for more details.
  17
  18   You should have received a copy of the GNU Lesser General Public License
  19   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  20 ***/
  21
  22 /*
  23  * System View
  24  * The sysview interface scans and monitors the system for seats, sessions and
  25  * devices. It basically mirrors the state of logind on the application side.
  26  * It's meant as base for session services that require managed device access.
  27  * The logind controller API is employed to allow unprivileged access to all
  28  * devices of a user.
  29  * Furthermore, the sysview interface can be used for system services that run
  30  * in situations where logind is not available, but session-like services are
  31  * needed. For instance, the initrd does not run logind but might require
  32  * graphics access. It cannot run session services, though. The sysview
  33  * interface pretends that a session is available and provides the same
  34  * interface as to normal session services.
  35  */
  36
  37 #pragma once
  38
  39 #include <inttypes.h>
  40 #include <libudev.h>
  41 #include <stdbool.h>
  42 #include <stdlib.h>
  43 #include <systemd/sd-bus.h>
  44 #include <systemd/sd-event.h>
  45 #include "util.h"
  46
  47 typedef struct sysview_event            sysview_event;
  48 typedef struct sysview_device           sysview_device;
  49 typedef struct sysview_session          sysview_session;
  50 typedef struct sysview_seat             sysview_seat;
  51 typedef struct sysview_context          sysview_context;
  52
  53 /*
  54  * Events
  55  */
  56
  57 enum {
  58         SYSVIEW_EVENT_SEAT_ADD,
  59         SYSVIEW_EVENT_SEAT_REMOVE,
  60
  61         SYSVIEW_EVENT_SESSION_FILTER,
  62         SYSVIEW_EVENT_SESSION_ADD,
  63         SYSVIEW_EVENT_SESSION_REMOVE,
  64         SYSVIEW_EVENT_SESSION_ATTACH,
  65         SYSVIEW_EVENT_SESSION_DETACH,
  66         SYSVIEW_EVENT_SESSION_CONTROL,
  67 };
  68
  69 struct sysview_event {
  70         unsigned int type;
  71
  72         union {
  73                 struct {
  74                         sysview_seat *seat;
  75                 } seat_add, seat_remove;
  76
  77                 struct {
  78                         const char *id;
  79                         const char *seatid;
  80                         const char *username;
  81                         unsigned int uid;
  82                 } session_filter;
  83
  84                 struct {
  85                         sysview_session *session;
  86                 } session_add, session_remove;
  87
  88                 struct {
  89                         sysview_session *session;
  90                         sysview_device *device;
  91                 } session_attach, session_detach;
  92
  93                 struct {
  94                         sysview_session *session;
  95                         int error;
  96                 } session_control;
  97         };
  98 };
  99
 100 typedef int (*sysview_event_fn) (sysview_context *c, void *userdata, sysview_event *e);
 101
 102 /*
 103  * Devices
 104  */
 105
 106 enum {
 107         SYSVIEW_DEVICE_EVDEV,
 108         SYSVIEW_DEVICE_DRM,
 109         SYSVIEW_DEVICE_CNT
 110 };
 111
 112 unsigned int sysview_device_get_type(sysview_device *device);
 113 struct udev_device *sysview_device_get_ud(sysview_device *device);
 114
 115 /*
 116  * Sessions
 117  */
 118
 119 const char *sysview_session_get_name(sysview_session *session);
 120
 121 int sysview_session_take_control(sysview_session *session);
 122 void sysview_session_release_control(sysview_session *session);
 123
 124 /*
 125  * Seats
 126  */
 127
 128 const char *sysview_seat_get_name(sysview_seat *seat);
 129
 130 /*
 131  * Contexts
 132  */
 133
 134 enum {
 135         SYSVIEW_CONTEXT_SCAN_LOGIND             = (1 << 0),
 136         SYSVIEW_CONTEXT_SCAN_EVDEV              = (1 << 1),
 137         SYSVIEW_CONTEXT_SCAN_DRM                = (1 << 2),
 138 };
 139
 140 int sysview_context_new(sysview_context **out,
 141                         unsigned int flags,
 142                         sd_event *event,
 143                         sd_bus *sysbus,
 144                         struct udev *ud);
 145 sysview_context *sysview_context_free(sysview_context *c);
 146
 147 DEFINE_TRIVIAL_CLEANUP_FUNC(sysview_context*, sysview_context_free);
 148
 149 bool sysview_context_is_running(sysview_context *c);
 150 int sysview_context_start(sysview_context *c, sysview_event_fn event_fn, void *userdata);
 151 void sysview_context_stop(sysview_context *c);