X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=src%2Fsystemd%2Fsd-login.h;h=776733ad1ddd0358240e787c794309f22a8e4788;hp=7d76f9a44ed3553b635da72960e9bd13a3a7074c;hb=9541666b8d97f107335dd7e3cb93b4d2cfbf19c9;hpb=eff406331adb23e27e4bd29a3b69322fc359ca3d;ds=inline diff --git a/src/systemd/sd-login.h b/src/systemd/sd-login.h index 7d76f9a44..776733ad1 100644 --- a/src/systemd/sd-login.h +++ b/src/systemd/sd-login.h @@ -9,20 +9,23 @@ Copyright 2011 Lennart Poettering systemd is free software; you can redistribute it and/or modify it - under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or + under the terms of the GNU Lesser General Public License as published by + the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. systemd is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. + Lesser General Public License for more details. - You should have received a copy of the GNU General Public License + You should have received a copy of the GNU Lesser General Public License along with systemd; If not, see . ***/ #include +#include + +#include "_sd-common.h" /* * A few points: @@ -30,16 +33,22 @@ * Instead of returning an empty string array or empty uid array, we * may return NULL. * - * Free the data we return with libc free(). + * Free the data the library returns with libc free(). String arrays + * are NULL terminated, and you need to free the array itself, in + * addition to the strings contained. * - * We return error codes as negative errno, kernel-style. 0 or - * positive on success. + * We return error codes as negative errno, kernel-style. On success, we + * return 0 or positive. * - * These functions access data in /proc, /sys/fs/cgroup and /run. All - * of these are virtual file systems, hence the accesses are + * These functions access data in /proc, /sys/fs/cgroup, and /run. All + * of these are virtual file systems; therefore, accesses are * relatively cheap. + * + * See sd-login(3) for more information. */ +_SD_BEGIN_DECLARATIONS; + /* Get session from PID. Note that 'shared' processes of a user are * not attached to a session, but only attached to a user. This will * return an error for system processes and 'shared' processes of a @@ -47,37 +56,80 @@ int sd_pid_get_session(pid_t pid, char **session); /* Get UID of the owner of the session of the PID (or in case the - * process is a 'shared' user process the UID of that user is + * process is a 'shared' user process, the UID of that user is * returned). This will not return the UID of the process, but rather - * the UID of the owner of the cgroup the process is in. This will + * the UID of the owner of the cgroup that the process is in. This will * return an error for system processes. */ int sd_pid_get_owner_uid(pid_t pid, uid_t *uid); -/* Get systemd unit (i.e. service) name from PID. This will return an - * error for non-service processes. */ -int sd_pid_get_unit(pid_t, char **unit); +/* Get systemd unit (i.e. service) name from PID, for system + * services. This will return an error for non-service processes. */ +int sd_pid_get_unit(pid_t pid, char **unit); + +/* Get systemd unit (i.e. service) name from PID, for user + * services. This will return an error for non-user-service + * processes. */ +int sd_pid_get_user_unit(pid_t pid, char **unit); + +/* Get machine name from PID, for processes assigned to a VM or + * container. This will return an error for non-machine processes. */ +int sd_pid_get_machine_name(pid_t pid, char **machine); + +/* Get slice name from PID. */ +int sd_pid_get_slice(pid_t pid, char **slice); + +/* Similar to sd_pid_get_session(), but retrieves data about peer of + * connected AF_UNIX socket */ +int sd_peer_get_session(int fd, char **session); -/* Get state from uid. Possible states: offline, lingering, online, active */ +/* Similar to sd_pid_get_owner_uid(), but retrieves data about peer of + * connected AF_UNIX socket */ +int sd_peer_get_owner_uid(int fd, uid_t *uid); + +/* Similar to sd_pid_get_unit(), but retrieves data about peer of + * connected AF_UNIX socket */ +int sd_peer_get_unit(int fd, char **unit); + +/* Similar to sd_pid_get_user_unit(), but retrieves data about peer of + * connected AF_UNIX socket */ +int sd_peer_get_user_unit(int fd, char **unit); + +/* Similar to sd_pid_get_machine_name(), but retrieves data about peer + * of connected AF_UNIX socket */ +int sd_peer_get_machine_name(int fd, char **machine); + +/* Similar to sd_pid_get_slice(), but retrieves data about peer of + * connected AF_UNIX socket */ +int sd_peer_get_slice(int fd, char **slice); + +/* Get state from UID. Possible states: offline, lingering, online, active, closing */ int sd_uid_get_state(uid_t uid, char**state); -/* Return 1 if uid has session on seat. If require_active is true will +/* Return 1 if UID has session on seat. If require_active is true, this will * look for active sessions only. */ int sd_uid_is_on_seat(uid_t uid, int require_active, const char *seat); -/* Return sessions of user. If require_active is true will look for - * active sessions only. Returns number of sessions as return - * value. If sessions is NULL will just return number of sessions. */ +/* Return sessions of user. If require_active is true, this will look for + * active sessions only. Returns the number of sessions. + * If sessions is NULL, this will just return the number of sessions. */ int sd_uid_get_sessions(uid_t uid, int require_active, char ***sessions); -/* Return seats of user is on. If require_active is true will look for - * active seats only. Returns number of seats. If seats is NULL will - * just return number of seats.*/ +/* Return seats of user is on. If require_active is true, this will look for + * active seats only. Returns the number of seats. + * If seats is NULL, this will just return the number of seats.*/ int sd_uid_get_seats(uid_t uid, int require_active, char ***seats); -/* Return 1 if the session is a active */ +/* Return 1 if the session is active. */ int sd_session_is_active(const char *session); -/* Determine user id of session */ +/* Return 1 if the session is remote. */ +int sd_session_is_remote(const char *session); + +/* Get state from session. Possible states: online, active, closing. + * This function is a more generic version of sd_session_is_active(). */ +int sd_session_get_state(const char *session, char **state); + +/* Determine user ID of session */ int sd_session_get_uid(const char *session, uid_t *uid); /* Determine seat of session */ @@ -86,34 +138,67 @@ int sd_session_get_seat(const char *session, char **seat); /* Determine the (PAM) service name this session was registered by. */ int sd_session_get_service(const char *session, char **service); +/* Determine the type of this session, i.e. one of "tty", "x11", "wayland", "mir" or "unspecified". */ +int sd_session_get_type(const char *session, char **type); + +/* Determine the class of this session, i.e. one of "user", "greeter" or "lock-screen". */ +int sd_session_get_class(const char *session, char **clazz); + +/* Determine the X11 display of this session. */ +int sd_session_get_display(const char *session, char **display); + +/* Determine the remote host of this session. */ +int sd_session_get_remote_host(const char *session, char **remote_host); + +/* Determine the remote user of this session (if provided by PAM). */ +int sd_session_get_remote_user(const char *session, char **remote_user); + +/* Determine the TTY of this session. */ +int sd_session_get_tty(const char *session, char **display); + +/* Determine the VT number of this session. */ +int sd_session_get_vt(const char *session, unsigned *vtnr); + /* Return active session and user of seat */ int sd_seat_get_active(const char *seat, char **session, uid_t *uid); -/* Return sessions and users on seat. Returns number of sessions as - * return value. If sessions is NULL returns only the number of - * sessions. */ +/* Return sessions and users on seat. Returns number of sessions. + * If sessions is NULL, this returns only the number of sessions. */ int sd_seat_get_sessions(const char *seat, char ***sessions, uid_t **uid, unsigned *n_uids); /* Return whether the seat is multi-session capable */ int sd_seat_can_multi_session(const char *seat); +/* Return whether the seat is TTY capable, i.e. suitable for showing console UIs */ +int sd_seat_can_tty(const char *seat); + +/* Return whether the seat is graphics capable, i.e. suitable for showing graphical UIs */ +int sd_seat_can_graphical(const char *seat); + +/* Return the class of machine */ +int sd_machine_get_class(const char *machine, char **clazz); + /* Get all seats, store in *seats. Returns the number of seats. If - * seats is NULL only returns number of seats. */ + * seats is NULL, this only returns the number of seats. */ int sd_get_seats(char ***seats); /* Get all sessions, store in *sessions. Returns the number of - * sessions. If sessions is NULL only returns number of sessions. */ + * sessions. If sessions is NULL, this only returns the number of sessions. */ int sd_get_sessions(char ***sessions); /* Get all logged in users, store in *users. Returns the number of - * users. If users is NULL only returns the number of users. */ + * users. If users is NULL, this only returns the number of users. */ int sd_get_uids(uid_t **users); +/* Get all running virtual machines/containers */ +int sd_get_machine_names(char ***machines); + /* Monitor object */ typedef struct sd_login_monitor sd_login_monitor; /* Create a new monitor. Category must be NULL, "seat", "session", - * "uid" to get monitor events for the specific category (or all). */ + * "uid", or "machine" to get monitor events for the specific category + * (or all). */ int sd_login_monitor_new(const char *category, sd_login_monitor** ret); /* Destroys the passed monitor. Returns NULL. */ @@ -125,4 +210,12 @@ int sd_login_monitor_flush(sd_login_monitor *m); /* Get FD from monitor */ int sd_login_monitor_get_fd(sd_login_monitor *m); +/* Get poll() mask to monitor */ +int sd_login_monitor_get_events(sd_login_monitor *m); + +/* Get timeout for poll(), as usec value relative to CLOCK_MONOTONIC's epoch */ +int sd_login_monitor_get_timeout(sd_login_monitor *m, uint64_t *timeout_usec); + +_SD_END_DECLARATIONS; + #endif