src/systemd/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 Lesser General Public License as published by
  13   the Free Software Foundation; either version 2.1 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   Lesser General Public License for more details.
  20
  21   You should have received a copy of the GNU Lesser General Public License
  22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  23 ***/
  24
  25 #include <sys/types.h>
  26 #include <inttypes.h>
  27
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif
  31
  32 /*
  33  * A few points:
  34  *
  35  * Instead of returning an empty string array or empty uid array, we
  36  * may return NULL.
  37  *
  38  * Free the data the library returns with libc free(). String arrays
  39  * are NULL terminated and you need to free the array itself in
  40  * addition to the strings contained.
  41  *
  42  * We return error codes as negative errno, kernel-style. 0 or
  43  * positive on success.
  44  *
  45  * These functions access data in /proc, /sys/fs/cgroup and /run. All
  46  * of these are virtual file systems, hence the accesses are
  47  * relatively cheap.
  48  *
  49  * See sd-login(3) for more information.
  50  */
  51
  52 /* Get session from PID. Note that 'shared' processes of a user are
  53  * not attached to a session, but only attached to a user. This will
  54  * return an error for system processes and 'shared' processes of a
  55  * user. */
  56 int sd_pid_get_session(pid_t pid, char **session);
  57
  58 /* Get UID of the owner of the session of the PID (or in case the
  59  * process is a 'shared' user process the UID of that user is
  60  * returned). This will not return the UID of the process, but rather
  61  * the UID of the owner of the cgroup the process is in. This will
  62  * return an error for system processes. */
  63 int sd_pid_get_owner_uid(pid_t pid, uid_t *uid);
  64
  65 /* Get systemd unit (i.e. service) name from PID, for system
  66  * services. This will return an error for non-service processes. */
  67 int sd_pid_get_unit(pid_t, char **unit);
  68
  69 /* Get systemd unit (i.e. service) name from PID, for user
  70  * services. This will return an error for non-user-service
  71  * processes. */
  72 int sd_pid_get_user_unit(pid_t, char **unit);
  73
  74 /* Get state from uid. Possible states: offline, lingering, online, active, closing */
  75 int sd_uid_get_state(uid_t uid, char**state);
  76
  77 /* Return 1 if uid has session on seat. If require_active is true will
  78  * look for active sessions only. */
  79 int sd_uid_is_on_seat(uid_t uid, int require_active, const char *seat);
  80
  81 /* Return sessions of user. If require_active is true will look for
  82  * active sessions only. Returns number of sessions as return
  83  * value. If sessions is NULL will just return number of sessions. */
  84 int sd_uid_get_sessions(uid_t uid, int require_active, char ***sessions);
  85
  86 /* Return seats of user is on. If require_active is true will look for
  87  * active seats only.  Returns number of seats. If seats is NULL will
  88  * just return number of seats.*/
  89 int sd_uid_get_seats(uid_t uid, int require_active, char ***seats);
  90
  91 /* Return 1 if the session is a active. */
  92 int sd_session_is_active(const char *session);
  93
  94 /* Get state from session. Possible states: online, active, closing
  95  * (This function is a more generic version of
  96  * sd_session_is_active().) */
  97 int sd_session_get_state(const char *sessio, char **state);
  98
  99 /* Determine user id of session */
 100 int sd_session_get_uid(const char *session, uid_t *uid);
 101
 102 /* Determine seat of session */
 103 int sd_session_get_seat(const char *session, char **seat);
 104
 105 /* Determine the (PAM) service name this session was registered by. */
 106 int sd_session_get_service(const char *session, char **service);
 107
 108 /* Determine the type of this session, i.e. one of "tty", "x11" or "unspecified". */
 109 int sd_session_get_type(const char *session, char **type);
 110
 111 /* Determine the class of this session, i.e. one of "user", "greeter" or "lock-screen". */
 112 int sd_session_get_class(const char *session, char **clazz);
 113
 114 /* Determine the X11 display of this session. */
 115 int sd_session_get_display(const char *session, char **display);
 116
 117 /* Determine the TTY of this session. */
 118 int sd_session_get_tty(const char *session, char **display);
 119
 120 /* Return active session and user of seat */
 121 int sd_seat_get_active(const char *seat, char **session, uid_t *uid);
 122
 123 /* Return sessions and users on seat. Returns number of sessions as
 124  * return value. If sessions is NULL returns only the number of
 125  * sessions. */
 126 int sd_seat_get_sessions(const char *seat, char ***sessions, uid_t **uid, unsigned *n_uids);
 127
 128 /* Return whether the seat is multi-session capable */
 129 int sd_seat_can_multi_session(const char *seat);
 130
 131 /* Return whether the seat is TTY capable, i.e. suitable for showing console UIs */
 132 int sd_seat_can_tty(const char *seat);
 133
 134 /* Return whether the seat is graphics capable, i.e. suitable for showing graphical UIs */
 135 int sd_seat_can_graphical(const char *seat);
 136
 137 /* Get all seats, store in *seats. Returns the number of seats. If
 138  * seats is NULL only returns number of seats. */
 139 int sd_get_seats(char ***seats);
 140
 141 /* Get all sessions, store in *sessions. Returns the number of
 142  * sessions. If sessions is NULL only returns number of sessions. */
 143 int sd_get_sessions(char ***sessions);
 144
 145 /* Get all logged in users, store in *users. Returns the number of
 146  * users. If users is NULL only returns the number of users. */
 147 int sd_get_uids(uid_t **users);
 148
 149 /* Monitor object */
 150 typedef struct sd_login_monitor sd_login_monitor;
 151
 152 /* Create a new monitor. Category must be NULL, "seat", "session",
 153  * "uid" to get monitor events for the specific category (or all). */
 154 int sd_login_monitor_new(const char *category, sd_login_monitor** ret);
 155
 156 /* Destroys the passed monitor. Returns NULL. */
 157 sd_login_monitor* sd_login_monitor_unref(sd_login_monitor *m);
 158
 159 /* Flushes the monitor */
 160 int sd_login_monitor_flush(sd_login_monitor *m);
 161
 162 /* Get FD from monitor */
 163 int sd_login_monitor_get_fd(sd_login_monitor *m);
 164
 165 /* Get poll() mask to monitor */
 166 int sd_login_monitor_get_events(sd_login_monitor *m);
 167
 168 /* Get timeout for poll(), as usec value relative to CLOCK_MONOTONIC's epoch */
 169 int sd_login_monitor_get_timeout(sd_login_monitor *m, uint64_t *timeout_usec);
 170
 171 #ifdef __cplusplus
 172 }
 173 #endif
 174
 175 #endif