]>
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 |
85fce6f4 | 17 | along with systemd; If not, see <https://www.gnu.org/licenses/>. |
74b91131 LP |
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 | ||
da20baae LB |
83 | /* Equivalent to the corresponding sd_pid_get* functions, but take a |
84 | * PIDFD instead of a PID, to ensure there can be no possible PID | |
85 | * recycle issues before/after the calls. */ | |
86 | int sd_pidfd_get_session(pid_t pid, char **session); | |
87 | int sd_pidfd_get_owner_uid(pid_t pid, uid_t *uid); | |
88 | int sd_pidfd_get_unit(pid_t pid, char **unit); | |
89 | int sd_pidfd_get_user_unit(pid_t pid, char **unit); | |
90 | int sd_pidfd_get_slice(pid_t pid, char **slice); | |
91 | int sd_pidfd_get_user_slice(pid_t pid, char **slice); | |
92 | int sd_pidfd_get_machine_name(pid_t pid, char **machine); | |
93 | int sd_pidfd_get_cgroup(pid_t pid, char **cgroup); | |
94 | ||
a67c56bf LP |
95 | /* Similar to sd_pid_get_session(), but retrieves data about the peer |
96 | * of a connected AF_UNIX socket */ | |
bf34ab14 LP |
97 | int sd_peer_get_session(int fd, char **session); |
98 | ||
a67c56bf LP |
99 | /* Similar to sd_pid_get_owner_uid(), but retrieves data about the peer of |
100 | * a connected AF_UNIX socket */ | |
bf34ab14 LP |
101 | int sd_peer_get_owner_uid(int fd, uid_t *uid); |
102 | ||
a67c56bf LP |
103 | /* Similar to sd_pid_get_unit(), but retrieves data about the peer of |
104 | * a connected AF_UNIX socket */ | |
bf34ab14 LP |
105 | int sd_peer_get_unit(int fd, char **unit); |
106 | ||
a67c56bf LP |
107 | /* Similar to sd_pid_get_user_unit(), but retrieves data about the peer of |
108 | * a connected AF_UNIX socket */ | |
bf34ab14 LP |
109 | int sd_peer_get_user_unit(int fd, char **unit); |
110 | ||
a67c56bf LP |
111 | /* Similar to sd_pid_get_slice(), but retrieves data about the peer of |
112 | * a connected AF_UNIX socket */ | |
bf34ab14 | 113 | int sd_peer_get_slice(int fd, char **slice); |
1021b21b | 114 | |
a67c56bf LP |
115 | /* Similar to sd_pid_get_user_slice(), but retrieves data about the peer of |
116 | * a connected AF_UNIX socket */ | |
329ac4bc LP |
117 | int sd_peer_get_user_slice(int fd, char **slice); |
118 | ||
a67c56bf | 119 | /* Similar to sd_pid_get_machine_name(), but retrieves data about the |
ee7dca21 | 120 | * peer of a connected AF_UNIX socket */ |
329ac4bc LP |
121 | int sd_peer_get_machine_name(int fd, char **machine); |
122 | ||
f5aaf575 LP |
123 | /* Similar to sd_pid_get_cgroup(), but retrieves data about the peer |
124 | * of a connected AF_UNIX socket. */ | |
a8310e39 | 125 | int sd_peer_get_cgroup(int fd, char **cgroup); |
f5aaf575 | 126 | |
10b17992 | 127 | /* Get state from UID. Possible states: offline, lingering, online, active, closing */ |
a077b666 LP |
128 | int sd_uid_get_state(uid_t uid, char **state); |
129 | ||
130 | /* Return primary session of user, if there is any */ | |
131 | int sd_uid_get_display(uid_t uid, char **session); | |
74b91131 | 132 | |
d622fefc TK |
133 | /* Determine the login time of user */ |
134 | int sd_uid_get_login_time(uid_t uid, uint64_t *usec); | |
135 | ||
10b17992 | 136 | /* Return 1 if UID has session on seat. If require_active is true, this will |
034a2a52 LP |
137 | * look for active sessions only. */ |
138 | int sd_uid_is_on_seat(uid_t uid, int require_active, const char *seat); | |
139 | ||
10b17992 JSJ |
140 | /* Return sessions of user. If require_active is true, this will look for |
141 | * active sessions only. Returns the number of sessions. | |
142 | * If sessions is NULL, this will just return the number of sessions. */ | |
034a2a52 | 143 | int sd_uid_get_sessions(uid_t uid, int require_active, char ***sessions); |
74b91131 | 144 | |
10b17992 JSJ |
145 | /* Return seats of user is on. If require_active is true, this will look for |
146 | * active seats only. Returns the number of seats. | |
f7340ab2 | 147 | * If seats is NULL, this will just return the number of seats. */ |
034a2a52 | 148 | int sd_uid_get_seats(uid_t uid, int require_active, char ***seats); |
74b91131 | 149 | |
5b04fe60 | 150 | /* Return 1 if the session is active. */ |
74b91131 LP |
151 | int sd_session_is_active(const char *session); |
152 | ||
5b04fe60 MM |
153 | /* Return 1 if the session is remote. */ |
154 | int sd_session_is_remote(const char *session); | |
155 | ||
10b17992 JSJ |
156 | /* Get state from session. Possible states: online, active, closing. |
157 | * This function is a more generic version of sd_session_is_active(). */ | |
5f34246c | 158 | int sd_session_get_state(const char *session, char **state); |
0604381b | 159 | |
10b17992 | 160 | /* Determine user ID of session */ |
74b91131 LP |
161 | int sd_session_get_uid(const char *session, uid_t *uid); |
162 | ||
d71f5b12 MY |
163 | /* Determine username of session */ |
164 | int sd_session_get_username(const char *session, char **username); | |
165 | ||
74b91131 LP |
166 | /* Determine seat of session */ |
167 | int sd_session_get_seat(const char *session, char **seat); | |
168 | ||
c4ef14dc MY |
169 | /* Determine the start time of session */ |
170 | int sd_session_get_start_time(const char *session, uint64_t *usec); | |
171 | ||
eff40633 LP |
172 | /* Determine the (PAM) service name this session was registered by. */ |
173 | int sd_session_get_service(const char *session, char **service); | |
174 | ||
9541666b | 175 | /* Determine the type of this session, i.e. one of "tty", "x11", "wayland", "mir" or "unspecified". */ |
51f58f08 LP |
176 | int sd_session_get_type(const char *session, char **type); |
177 | ||
178 | /* Determine the class of this session, i.e. one of "user", "greeter" or "lock-screen". */ | |
e09a9a35 | 179 | int sd_session_get_class(const char *session, char **clazz); |
51f58f08 | 180 | |
09077149 | 181 | /* Determine the desktop brand of this session, i.e. something like "GNOME", "KDE" or "systemd-console". */ |
c72d5456 DH |
182 | int sd_session_get_desktop(const char *session, char **desktop); |
183 | ||
fc8af9ff LP |
184 | /* Determine the X11 display of this session. */ |
185 | int sd_session_get_display(const char *session, char **display); | |
186 | ||
5b04fe60 MM |
187 | /* Determine the remote host of this session. */ |
188 | int sd_session_get_remote_host(const char *session, char **remote_host); | |
189 | ||
190 | /* Determine the remote user of this session (if provided by PAM). */ | |
191 | int sd_session_get_remote_user(const char *session, char **remote_user); | |
192 | ||
c84f5e4a LP |
193 | /* Determine the TTY of this session. */ |
194 | int sd_session_get_tty(const char *session, char **display); | |
195 | ||
44ded3ab GC |
196 | /* Determine the VT number of this session. */ |
197 | int sd_session_get_vt(const char *session, unsigned *vtnr); | |
198 | ||
74b91131 LP |
199 | /* Return active session and user of seat */ |
200 | int sd_seat_get_active(const char *seat, char **session, uid_t *uid); | |
201 | ||
10b17992 JSJ |
202 | /* Return sessions and users on seat. Returns number of sessions. |
203 | * If sessions is NULL, this returns only the number of sessions. */ | |
aa3b40c3 ZJS |
204 | int sd_seat_get_sessions( |
205 | const char *seat, | |
206 | char ***ret_sessions, | |
207 | uid_t **ret_uids, | |
208 | unsigned *ret_n_uids); | |
034a2a52 | 209 | |
add30678 | 210 | /* Return whether the seat is multi-session capable */ |
8f8cc84b | 211 | int sd_seat_can_multi_session(const char *seat) _sd_deprecated_; |
add30678 | 212 | |
20747498 LP |
213 | /* Return whether the seat is TTY capable, i.e. suitable for showing console UIs */ |
214 | int sd_seat_can_tty(const char *seat); | |
215 | ||
216 | /* Return whether the seat is graphics capable, i.e. suitable for showing graphical UIs */ | |
217 | int sd_seat_can_graphical(const char *seat); | |
218 | ||
0325941f | 219 | /* Return the class of machine */ |
e43e3e3e | 220 | int sd_machine_get_class(const char *machine, char **clazz); |
0325941f | 221 | |
634af566 | 222 | /* Return the list if host-side network interface indices of a machine */ |
0ef14adc | 223 | int sd_machine_get_ifindices(const char *machine, int **ret_ifindices); |
cabb0bc6 | 224 | |
d60ef526 | 225 | /* Get all seats, store in *seats. Returns the number of seats. If |
10b17992 | 226 | * seats is NULL, this only returns the number of seats. */ |
034a2a52 LP |
227 | int sd_get_seats(char ***seats); |
228 | ||
e8fbe35d | 229 | /* Get all sessions, store in *sessions. Returns the number of |
10b17992 | 230 | * sessions. If sessions is NULL, this only returns the number of sessions. */ |
034a2a52 LP |
231 | int sd_get_sessions(char ***sessions); |
232 | ||
d60ef526 | 233 | /* Get all logged in users, store in *users. Returns the number of |
10b17992 | 234 | * users. If users is NULL, this only returns the number of users. */ |
034a2a52 LP |
235 | int sd_get_uids(uid_t **users); |
236 | ||
a20affe2 LP |
237 | /* Get all running virtual machines/containers */ |
238 | int sd_get_machine_names(char ***machines); | |
239 | ||
034a2a52 LP |
240 | /* Monitor object */ |
241 | typedef struct sd_login_monitor sd_login_monitor; | |
242 | ||
243 | /* Create a new monitor. Category must be NULL, "seat", "session", | |
10b17992 | 244 | * "uid", or "machine" to get monitor events for the specific category |
e10375f2 | 245 | * (or all). */ |
034a2a52 LP |
246 | int sd_login_monitor_new(const char *category, sd_login_monitor** ret); |
247 | ||
248 | /* Destroys the passed monitor. Returns NULL. */ | |
249 | sd_login_monitor* sd_login_monitor_unref(sd_login_monitor *m); | |
250 | ||
251 | /* Flushes the monitor */ | |
252 | int sd_login_monitor_flush(sd_login_monitor *m); | |
253 | ||
254 | /* Get FD from monitor */ | |
255 | int sd_login_monitor_get_fd(sd_login_monitor *m); | |
256 | ||
dace83cb LP |
257 | /* Get poll() mask to monitor */ |
258 | int sd_login_monitor_get_events(sd_login_monitor *m); | |
259 | ||
667c24a6 LP |
260 | /* Get timeout for poll(), as usec value relative to CLOCK_MONOTONIC's epoch */ |
261 | int sd_login_monitor_get_timeout(sd_login_monitor *m, uint64_t *timeout_usec); | |
262 | ||
4afd3348 LP |
263 | _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_login_monitor, sd_login_monitor_unref); |
264 | ||
0095c454 | 265 | _SD_END_DECLARATIONS; |
f9873976 | 266 | |
74b91131 | 267 | #endif |