src/sd-login.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #ifndef foosdloginhfoo
   4 #define foosdloginhfoo
   5
   6 /***
   7   This file is part of systemd.
   8
   9   Copyright 2011 Lennart Poettering
  10
  11   systemd is free software; you can redistribute it and/or modify it
  12   under the terms of the GNU General Public License as published by
  13   the Free Software Foundation; either version 2 of the License, or
  14   (at your option) any later version.
  15
  16   systemd is distributed in the hope that it will be useful, but
  17   WITHOUT ANY WARRANTY; without even the implied warranty of
  18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19   General Public License for more details.
  20
  21   You should have received a copy of the GNU General Public License
  22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  23 ***/
  24
  25 #include <sys/types.h>
  26
  27 /*
  28  * A few points:
  29  *
  30  * Instead of returning an empty string array or empty uid array, we
  31  * may return NULL.
  32  *
  33  * Free the data we return with libc free().
  34  *
  35  * We return error codes as negative errno, kernel-style. 0 or
  36  * positive on success.
  37  *
  38  * These functions access data in /proc, /sys/fs/cgroup and /run. All
  39  * of these are virtual file systems, hence the accesses are
  40  * relatively cheap.
  41  */
  42
  43 /* Get session from PID. Note that 'shared' processes of a user are
  44  * not attached to a session, but only attached to a user. This will
  45  * return an error for system processes and 'shared' processes of a
  46  * user. */
  47 int sd_pid_get_session(pid_t pid, char **session);
  48
  49 /* Get UID of the owner of the session of the PID (or in case the
  50  * process is a 'shared' user process the UID of that user is
  51  * returned). This will not return the UID of the process, but rather
  52  * the UID of the owner of the cgroup the process is in. This will
  53  * return an error for system processes. */
  54 int sd_pid_get_owner_uid(pid_t pid, uid_t *uid);
  55
  56 /* Get state from uid. Possible states: offline, lingering, online, active */
  57 int sd_uid_get_state(uid_t uid, char**state);
  58
  59 /* Return 1 if uid has session on seat. If require_active is true will
  60  * look for active sessions only. */
  61 int sd_uid_is_on_seat(uid_t uid, int require_active, const char *seat);
  62
  63 /* Return sessions of user. If require_active is true will look for
  64  * active sessions only. Returns number of sessions as return
  65  * value. If sessions is NULL will just return number of sessions. */
  66 int sd_uid_get_sessions(uid_t uid, int require_active, char ***sessions);
  67
  68 /* Return seats of user is on. If require_active is true will look for
  69  * active seats only.  Returns number of seats. If seats is NULL will
  70  * just return number of seats.*/
  71 int sd_uid_get_seats(uid_t uid, int require_active, char ***seats);
  72
  73 /* Return 1 if the session is a active */
  74 int sd_session_is_active(const char *session);
  75
  76 /* Determine user id of session */
  77 int sd_session_get_uid(const char *session, uid_t *uid);
  78
  79 /* Determine seat of session */
  80 int sd_session_get_seat(const char *session, char **seat);
  81
  82 /* Return active session and user of seat */
  83 int sd_seat_get_active(const char *seat, char **session, uid_t *uid);
  84
  85 /* Return sessions and users on seat. Returns number of sessions as
  86  * return value. If sessions is NULL returs only the number of
  87  * sessions. */
  88 int sd_seat_get_sessions(const char *seat, char ***sessions, uid_t **uid, unsigned *n_uids);
  89
  90 /* Return whether the seat is multi-session capable */
  91 int sd_seat_can_multi_session(const char *seat);
  92
  93 /* Get all seats, store in *seats. Returns the number of seats. If
  94  * seats is NULL only returns number of seats. */
  95 int sd_get_seats(char ***seats);
  96
  97 /* Get all sessions, store in *seessions. Returns the number of
  98  * sessions. If sessions is NULL only returns number of sessions. */
  99 int sd_get_sessions(char ***sessions);
 100
 101 /* Get all logged in users, store in *users. Returns the number of
 102  * users. If users is NULL only returns the number of users. */
 103 int sd_get_uids(uid_t **users);
 104
 105 /* Monitor object */
 106 typedef struct sd_login_monitor sd_login_monitor;
 107
 108 /* Create a new monitor. Category must be NULL, "seat", "session",
 109  * "uid" to get monitor events for the specific category (or all). */
 110 int sd_login_monitor_new(const char *category, sd_login_monitor** ret);
 111
 112 /* Destroys the passed monitor. Returns NULL. */
 113 sd_login_monitor* sd_login_monitor_unref(sd_login_monitor *m);
 114
 115 /* Flushes the monitor */
 116 int sd_login_monitor_flush(sd_login_monitor *m);
 117
 118 /* Get FD from monitor */
 119 int sd_login_monitor_get_fd(sd_login_monitor *m);
 120
 121 #endif