]>
Commit | Line | Data |
---|---|---|
db9ecf05 | 1 | /* SPDX-License-Identifier: LGPL-2.1-or-later */ |
74b91131 LP |
2 | #ifndef foosdloginhfoo |
3 | #define foosdloginhfoo | |
4 | ||
5 | /*** | |
74b91131 | 6 | systemd is free software; you can redistribute it and/or modify it |
5430f7f2 LP |
7 | under the terms of the GNU Lesser General Public License as published by |
8 | the Free Software Foundation; either version 2.1 of the License, or | |
74b91131 LP |
9 | (at your option) any later version. |
10 | ||
11 | systemd is distributed in the hope that it will be useful, but | |
12 | WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
5430f7f2 | 14 | Lesser General Public License for more details. |
74b91131 | 15 | |
5430f7f2 | 16 | You should have received a copy of the GNU Lesser General Public License |
74b91131 LP |
17 | along with systemd; If not, see <http://www.gnu.org/licenses/>. |
18 | ***/ | |
19 | ||
667c24a6 | 20 | #include <inttypes.h> |
71d35b6b | 21 | #include <sys/types.h> |
74b91131 | 22 | |
0095c454 | 23 | #include "_sd-common.h" |
f9873976 | 24 | |
034a2a52 LP |
25 | /* |
26 | * A few points: | |
27 | * | |
28 | * Instead of returning an empty string array or empty uid array, we | |
29 | * may return NULL. | |
30 | * | |
ee1f44bd | 31 | * Free the data the library returns with libc free(). String arrays |
10b17992 | 32 | * are NULL terminated, and you need to free the array itself, in |
ee1f44bd | 33 | * addition to the strings contained. |
034a2a52 | 34 | * |
10b17992 JSJ |
35 | * We return error codes as negative errno, kernel-style. On success, we |
36 | * return 0 or positive. | |
034a2a52 | 37 | * |
10b17992 JSJ |
38 | * These functions access data in /proc, /sys/fs/cgroup, and /run. All |
39 | * of these are virtual file systems; therefore, accesses are | |
034a2a52 | 40 | * relatively cheap. |
cb07866b LP |
41 | * |
42 | * See sd-login(3) for more information. | |
034a2a52 LP |
43 | */ |
44 | ||
0095c454 LP |
45 | _SD_BEGIN_DECLARATIONS; |
46 | ||
034a2a52 LP |
47 | /* Get session from PID. Note that 'shared' processes of a user are |
48 | * not attached to a session, but only attached to a user. This will | |
49 | * return an error for system processes and 'shared' processes of a | |
50 | * user. */ | |
74b91131 LP |
51 | int sd_pid_get_session(pid_t pid, char **session); |
52 | ||
034a2a52 | 53 | /* Get UID of the owner of the session of the PID (or in case the |
10b17992 | 54 | * process is a 'shared' user process, the UID of that user is |
034a2a52 | 55 | * returned). This will not return the UID of the process, but rather |
10b17992 | 56 | * the UID of the owner of the cgroup that the process is in. This will |
034a2a52 LP |
57 | * return an error for system processes. */ |
58 | int sd_pid_get_owner_uid(pid_t pid, uid_t *uid); | |
59 | ||
329ac4bc | 60 | /* Get systemd non-slice unit (i.e. service) name from PID, for system |
97e13058 | 61 | * services. This will return an error for non-service processes. */ |
7027ff61 | 62 | int sd_pid_get_unit(pid_t pid, char **unit); |
9847946e | 63 | |
329ac4bc | 64 | /* Get systemd non-slice unit (i.e. service) name from PID, for user |
97e13058 LP |
65 | * services. This will return an error for non-user-service |
66 | * processes. */ | |
7027ff61 LP |
67 | int sd_pid_get_user_unit(pid_t pid, char **unit); |
68 | ||
329ac4bc LP |
69 | /* Get slice name from PID. */ |
70 | int sd_pid_get_slice(pid_t pid, char **slice); | |
71 | ||
72 | /* Get user slice name from PID. */ | |
73 | int sd_pid_get_user_slice(pid_t pid, char **slice); | |
74 | ||
10b17992 | 75 | /* Get machine name from PID, for processes assigned to a VM or |
1021b21b | 76 | * container. This will return an error for non-machine processes. */ |
bf34ab14 | 77 | int sd_pid_get_machine_name(pid_t pid, char **machine); |
97e13058 | 78 | |
f5aaf575 LP |
79 | /* Get the control group from a PID, relative to the root of the |
80 | * hierarchy. */ | |
81 | int sd_pid_get_cgroup(pid_t pid, char **cgroup); | |
82 | ||
a67c56bf LP |
83 | /* Similar to sd_pid_get_session(), but retrieves data about the peer |
84 | * of a connected AF_UNIX socket */ | |
bf34ab14 LP |
85 | int sd_peer_get_session(int fd, char **session); |
86 | ||
a67c56bf LP |
87 | /* Similar to sd_pid_get_owner_uid(), but retrieves data about the peer of |
88 | * a connected AF_UNIX socket */ | |
bf34ab14 LP |
89 | int sd_peer_get_owner_uid(int fd, uid_t *uid); |
90 | ||
a67c56bf LP |
91 | /* Similar to sd_pid_get_unit(), but retrieves data about the peer of |
92 | * a connected AF_UNIX socket */ | |
bf34ab14 LP |
93 | int sd_peer_get_unit(int fd, char **unit); |
94 | ||
a67c56bf LP |
95 | /* Similar to sd_pid_get_user_unit(), but retrieves data about the peer of |
96 | * a connected AF_UNIX socket */ | |
bf34ab14 LP |
97 | int sd_peer_get_user_unit(int fd, char **unit); |
98 | ||
a67c56bf LP |
99 | /* Similar to sd_pid_get_slice(), but retrieves data about the peer of |
100 | * a connected AF_UNIX socket */ | |
bf34ab14 | 101 | int sd_peer_get_slice(int fd, char **slice); |
1021b21b | 102 | |
a67c56bf LP |
103 | /* Similar to sd_pid_get_user_slice(), but retrieves data about the peer of |
104 | * a connected AF_UNIX socket */ | |
329ac4bc LP |
105 | int sd_peer_get_user_slice(int fd, char **slice); |
106 | ||
a67c56bf | 107 | /* Similar to sd_pid_get_machine_name(), but retrieves data about the |
ee7dca21 | 108 | * peer of a connected AF_UNIX socket */ |
329ac4bc LP |
109 | int sd_peer_get_machine_name(int fd, char **machine); |
110 | ||
f5aaf575 LP |
111 | /* Similar to sd_pid_get_cgroup(), but retrieves data about the peer |
112 | * of a connected AF_UNIX socket. */ | |
113 | int sd_peer_get_cgroup(pid_t pid, char **cgroup); | |
114 | ||
10b17992 | 115 | /* Get state from UID. Possible states: offline, lingering, online, active, closing */ |
a077b666 LP |
116 | int sd_uid_get_state(uid_t uid, char **state); |
117 | ||
118 | /* Return primary session of user, if there is any */ | |
119 | int sd_uid_get_display(uid_t uid, char **session); | |
74b91131 | 120 | |
10b17992 | 121 | /* Return 1 if UID has session on seat. If require_active is true, this will |
034a2a52 LP |
122 | * look for active sessions only. */ |
123 | int sd_uid_is_on_seat(uid_t uid, int require_active, const char *seat); | |
124 | ||
10b17992 JSJ |
125 | /* Return sessions of user. If require_active is true, this will look for |
126 | * active sessions only. Returns the number of sessions. | |
127 | * If sessions is NULL, this will just return the number of sessions. */ | |
034a2a52 | 128 | int sd_uid_get_sessions(uid_t uid, int require_active, char ***sessions); |
74b91131 | 129 | |
10b17992 JSJ |
130 | /* Return seats of user is on. If require_active is true, this will look for |
131 | * active seats only. Returns the number of seats. | |
f7340ab2 | 132 | * If seats is NULL, this will just return the number of seats. */ |
034a2a52 | 133 | int sd_uid_get_seats(uid_t uid, int require_active, char ***seats); |
74b91131 | 134 | |
5b04fe60 | 135 | /* Return 1 if the session is active. */ |
74b91131 LP |
136 | int sd_session_is_active(const char *session); |
137 | ||
5b04fe60 MM |
138 | /* Return 1 if the session is remote. */ |
139 | int sd_session_is_remote(const char *session); | |
140 | ||
10b17992 JSJ |
141 | /* Get state from session. Possible states: online, active, closing. |
142 | * This function is a more generic version of sd_session_is_active(). */ | |
5f34246c | 143 | int sd_session_get_state(const char *session, char **state); |
0604381b | 144 | |
10b17992 | 145 | /* Determine user ID of session */ |
74b91131 LP |
146 | int sd_session_get_uid(const char *session, uid_t *uid); |
147 | ||
148 | /* Determine seat of session */ | |
149 | int sd_session_get_seat(const char *session, char **seat); | |
150 | ||
eff40633 LP |
151 | /* Determine the (PAM) service name this session was registered by. */ |
152 | int sd_session_get_service(const char *session, char **service); | |
153 | ||
9541666b | 154 | /* Determine the type of this session, i.e. one of "tty", "x11", "wayland", "mir" or "unspecified". */ |
51f58f08 LP |
155 | int sd_session_get_type(const char *session, char **type); |
156 | ||
157 | /* Determine the class of this session, i.e. one of "user", "greeter" or "lock-screen". */ | |
e09a9a35 | 158 | int sd_session_get_class(const char *session, char **clazz); |
51f58f08 | 159 | |
09077149 | 160 | /* Determine the desktop brand of this session, i.e. something like "GNOME", "KDE" or "systemd-console". */ |
c72d5456 DH |
161 | int sd_session_get_desktop(const char *session, char **desktop); |
162 | ||
fc8af9ff LP |
163 | /* Determine the X11 display of this session. */ |
164 | int sd_session_get_display(const char *session, char **display); | |
165 | ||
5b04fe60 MM |
166 | /* Determine the remote host of this session. */ |
167 | int sd_session_get_remote_host(const char *session, char **remote_host); | |
168 | ||
169 | /* Determine the remote user of this session (if provided by PAM). */ | |
170 | int sd_session_get_remote_user(const char *session, char **remote_user); | |
171 | ||
c84f5e4a LP |
172 | /* Determine the TTY of this session. */ |
173 | int sd_session_get_tty(const char *session, char **display); | |
174 | ||
44ded3ab GC |
175 | /* Determine the VT number of this session. */ |
176 | int sd_session_get_vt(const char *session, unsigned *vtnr); | |
177 | ||
74b91131 LP |
178 | /* Return active session and user of seat */ |
179 | int sd_seat_get_active(const char *seat, char **session, uid_t *uid); | |
180 | ||
10b17992 JSJ |
181 | /* Return sessions and users on seat. Returns number of sessions. |
182 | * If sessions is NULL, this returns only the number of sessions. */ | |
aa3b40c3 ZJS |
183 | int sd_seat_get_sessions( |
184 | const char *seat, | |
185 | char ***ret_sessions, | |
186 | uid_t **ret_uids, | |
187 | unsigned *ret_n_uids); | |
034a2a52 | 188 | |
add30678 | 189 | /* Return whether the seat is multi-session capable */ |
8f8cc84b | 190 | int sd_seat_can_multi_session(const char *seat) _sd_deprecated_; |
add30678 | 191 | |
20747498 LP |
192 | /* Return whether the seat is TTY capable, i.e. suitable for showing console UIs */ |
193 | int sd_seat_can_tty(const char *seat); | |
194 | ||
195 | /* Return whether the seat is graphics capable, i.e. suitable for showing graphical UIs */ | |
196 | int sd_seat_can_graphical(const char *seat); | |
197 | ||
0325941f | 198 | /* Return the class of machine */ |
e43e3e3e | 199 | int sd_machine_get_class(const char *machine, char **clazz); |
0325941f | 200 | |
634af566 | 201 | /* Return the list if host-side network interface indices of a machine */ |
0ef14adc | 202 | int sd_machine_get_ifindices(const char *machine, int **ret_ifindices); |
cabb0bc6 | 203 | |
d60ef526 | 204 | /* Get all seats, store in *seats. Returns the number of seats. If |
10b17992 | 205 | * seats is NULL, this only returns the number of seats. */ |
034a2a52 LP |
206 | int sd_get_seats(char ***seats); |
207 | ||
e8fbe35d | 208 | /* Get all sessions, store in *sessions. Returns the number of |
10b17992 | 209 | * sessions. If sessions is NULL, this only returns the number of sessions. */ |
034a2a52 LP |
210 | int sd_get_sessions(char ***sessions); |
211 | ||
d60ef526 | 212 | /* Get all logged in users, store in *users. Returns the number of |
10b17992 | 213 | * users. If users is NULL, this only returns the number of users. */ |
034a2a52 LP |
214 | int sd_get_uids(uid_t **users); |
215 | ||
a20affe2 LP |
216 | /* Get all running virtual machines/containers */ |
217 | int sd_get_machine_names(char ***machines); | |
218 | ||
034a2a52 LP |
219 | /* Monitor object */ |
220 | typedef struct sd_login_monitor sd_login_monitor; | |
221 | ||
222 | /* Create a new monitor. Category must be NULL, "seat", "session", | |
10b17992 | 223 | * "uid", or "machine" to get monitor events for the specific category |
e10375f2 | 224 | * (or all). */ |
034a2a52 LP |
225 | int sd_login_monitor_new(const char *category, sd_login_monitor** ret); |
226 | ||
227 | /* Destroys the passed monitor. Returns NULL. */ | |
228 | sd_login_monitor* sd_login_monitor_unref(sd_login_monitor *m); | |
229 | ||
230 | /* Flushes the monitor */ | |
231 | int sd_login_monitor_flush(sd_login_monitor *m); | |
232 | ||
233 | /* Get FD from monitor */ | |
234 | int sd_login_monitor_get_fd(sd_login_monitor *m); | |
235 | ||
dace83cb LP |
236 | /* Get poll() mask to monitor */ |
237 | int sd_login_monitor_get_events(sd_login_monitor *m); | |
238 | ||
667c24a6 LP |
239 | /* Get timeout for poll(), as usec value relative to CLOCK_MONOTONIC's epoch */ |
240 | int sd_login_monitor_get_timeout(sd_login_monitor *m, uint64_t *timeout_usec); | |
241 | ||
4afd3348 LP |
242 | _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_login_monitor, sd_login_monitor_unref); |
243 | ||
0095c454 | 244 | _SD_END_DECLARATIONS; |
f9873976 | 245 | |
74b91131 | 246 | #endif |