]> git.ipfire.org Git - thirdparty/systemd.git/blame - src/shared/util.h
TODO: extend login capability note
[thirdparty/systemd.git] / src / shared / util.h
CommitLineData
03467c88 1/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
60918275 2
c2f1db8f 3#pragma once
60918275 4
a7334b09
LP
5/***
6 This file is part of systemd.
7
8 Copyright 2010 Lennart Poettering
9
10 systemd is free software; you can redistribute it and/or modify it
5430f7f2
LP
11 under the terms of the GNU Lesser General Public License as published by
12 the Free Software Foundation; either version 2.1 of the License, or
a7334b09
LP
13 (at your option) any later version.
14
15 systemd is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5430f7f2 18 Lesser General Public License for more details.
a7334b09 19
5430f7f2 20 You should have received a copy of the GNU Lesser General Public License
a7334b09
LP
21 along with systemd; If not, see <http://www.gnu.org/licenses/>.
22***/
23
31885cd5 24#include <alloca.h>
60918275
LP
25#include <inttypes.h>
26#include <time.h>
27#include <sys/time.h>
ec2002f8 28#include <stdarg.h>
60918275 29#include <stdbool.h>
5cb5a6ff 30#include <stdlib.h>
80876c20 31#include <stdio.h>
9a34ec5f 32#include <signal.h>
82c121a4 33#include <sched.h>
8f75a603 34#include <limits.h>
25ea79fe 35#include <sys/types.h>
00dc5d76 36#include <sys/stat.h>
3b63d2d3 37#include <dirent.h>
68faf98c 38#include <sys/resource.h>
7d5e9c0f 39#include <stddef.h>
79d860fe 40#include <unistd.h>
d6dd604b 41#include <locale.h>
5862d652 42#include <mntent.h>
eff05270 43#include <sys/socket.h>
60918275 44
ccd06097
ZJS
45#if SIZEOF_PID_T == 4
46# define PID_FMT "%" PRIu32
47#elif SIZEOF_PID_T == 2
48# define PID_FMT "%" PRIu16
49#else
50# error Unknown pid_t size
51#endif
52
53#if SIZEOF_UID_T == 4
54# define UID_FMT "%" PRIu32
55#elif SIZEOF_UID_T == 2
56# define UID_FMT "%" PRIu16
57#else
58# error Unknown uid_t size
59#endif
60
a838e6a1 61#include "macro.h"
9a98c7a1 62#include "time-util.h"
871d7de4 63
44d8db9e 64/* What is interpreted as whitespace? */
4a72ff34 65#define WHITESPACE " \t\n\r"
e3e0314b
ZJS
66#define NEWLINE "\n\r"
67#define QUOTES "\"\'"
68#define COMMENTS "#;"
69#define GLOB_CHARS "*?["
44d8db9e 70
a7bc2c2a 71#define FORMAT_BYTES_MAX 8
8b6c7120 72
c1072ea0 73#define ANSI_HIGHLIGHT_ON "\x1B[1;39m"
03b717a3 74#define ANSI_RED_ON "\x1B[31m"
281605bf 75#define ANSI_HIGHLIGHT_RED_ON "\x1B[1;31m"
076a24ad 76#define ANSI_GREEN_ON "\x1B[32m"
2ee68f72 77#define ANSI_HIGHLIGHT_GREEN_ON "\x1B[1;32m"
5f23d5b1 78#define ANSI_HIGHLIGHT_YELLOW_ON "\x1B[1;33m"
c0fdf098 79#define ANSI_HIGHLIGHT_BLUE_ON "\x1B[1;34m"
61cbdc4b 80#define ANSI_HIGHLIGHT_OFF "\x1B[0m"
984a2be4 81#define ANSI_ERASE_TO_END_OF_LINE "\x1B[K"
61cbdc4b 82
37f85e66 83size_t page_size(void);
84#define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
85
60918275 86#define streq(a,b) (strcmp((a),(b)) == 0)
3846aeeb 87#define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
b43d1d01
TA
88#define strcaseeq(a,b) (strcasecmp((a),(b)) == 0)
89#define strncaseeq(a, b, n) (strncasecmp((a), (b), (n)) == 0)
60918275 90
44a6b1b6 91bool streq_ptr(const char *a, const char *b) _pure_;
e05797fb 92
4b8772bf 93#define new(t, n) ((t*) malloc_multiply(sizeof(t), (n)))
60918275
LP
94
95#define new0(t, n) ((t*) calloc((n), sizeof(t)))
96
0f0dbc46
LP
97#define newa(t, n) ((t*) alloca(sizeof(t)*(n)))
98
4b8772bf 99#define newdup(t, p, n) ((t*) memdup_multiply(p, sizeof(t), (n)))
888c7102 100
60918275
LP
101#define malloc0(n) (calloc((n), 1))
102
103static inline const char* yes_no(bool b) {
104 return b ? "yes" : "no";
105}
106
5232c42e
LS
107static inline const char* true_false(bool b) {
108 return b ? "true" : "false";
109}
110
60918275
LP
111static inline const char* strempty(const char *s) {
112 return s ? s : "";
113}
114
115static inline const char* strnull(const char *s) {
116 return s ? s : "(null)";
117}
118
04fd6fe4
LP
119static inline const char *strna(const char *s) {
120 return s ? s : "n/a";
121}
122
9beb3f4d
LP
123static inline bool isempty(const char *p) {
124 return !p || !p[0];
125}
126
df89481a
KS
127static inline const char *startswith(const char *s, const char *prefix) {
128 if (strncmp(s, prefix, strlen(prefix)) == 0)
129 return s + strlen(prefix);
130 return NULL;
131}
132
133static inline const char *startswith_no_case(const char *s, const char *prefix) {
134 if (strncasecmp(s, prefix, strlen(prefix)) == 0)
135 return s + strlen(prefix);
136 return NULL;
137}
138
44a6b1b6 139char *endswith(const char *s, const char *postfix) _pure_;
60918275 140
44a6b1b6 141bool first_word(const char *s, const char *word) _pure_;
79d6d816 142
42f4e3c4 143int close_nointr(int fd);
85f136b5 144void close_nointr_nofail(int fd);
5b6319dc 145void close_many(const int fds[], unsigned n_fd);
60918275 146
44a6b1b6 147int parse_boolean(const char *v) _pure_;
ab1f0633 148int parse_bytes(const char *t, off_t *bytes);
3ba686c1 149int parse_pid(const char *s, pid_t* ret_pid);
034a2a52
LP
150int parse_uid(const char *s, uid_t* ret_uid);
151#define parse_gid(s, ret_uid) parse_uid(s, ret_uid)
85261803
LP
152
153int safe_atou(const char *s, unsigned *ret_u);
154int safe_atoi(const char *s, int *ret_i);
155
8f75a603
LP
156int safe_atollu(const char *s, unsigned long long *ret_u);
157int safe_atolli(const char *s, long long int *ret_i);
158
f7900e25
TA
159int safe_atod(const char *s, double *ret_d);
160
8f75a603
LP
161#if __WORDSIZE == 32
162static inline int safe_atolu(const char *s, unsigned long *ret_u) {
163 assert_cc(sizeof(unsigned long) == sizeof(unsigned));
164 return safe_atou(s, (unsigned*) ret_u);
165}
166static inline int safe_atoli(const char *s, long int *ret_u) {
167 assert_cc(sizeof(long int) == sizeof(int));
168 return safe_atoi(s, (int*) ret_u);
169}
170#else
171static inline int safe_atolu(const char *s, unsigned long *ret_u) {
172 assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
173 return safe_atollu(s, (unsigned long long*) ret_u);
174}
175static inline int safe_atoli(const char *s, long int *ret_u) {
176 assert_cc(sizeof(long int) == sizeof(long long int));
177 return safe_atolli(s, (long long int*) ret_u);
178}
179#endif
180
a838e6a1
LP
181static inline int safe_atou32(const char *s, uint32_t *ret_u) {
182 assert_cc(sizeof(uint32_t) == sizeof(unsigned));
183 return safe_atou(s, (unsigned*) ret_u);
184}
185
8f75a603 186static inline int safe_atoi32(const char *s, int32_t *ret_i) {
a838e6a1 187 assert_cc(sizeof(int32_t) == sizeof(int));
8f75a603 188 return safe_atoi(s, (int*) ret_i);
a838e6a1
LP
189}
190
8f75a603
LP
191static inline int safe_atou64(const char *s, uint64_t *ret_u) {
192 assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
193 return safe_atollu(s, (unsigned long long*) ret_u);
194}
034c6ed7 195
8f75a603
LP
196static inline int safe_atoi64(const char *s, int64_t *ret_i) {
197 assert_cc(sizeof(int64_t) == sizeof(long long int));
198 return safe_atolli(s, (long long int*) ret_i);
199}
034c6ed7 200
65d2ebdc 201char *split(const char *c, size_t *l, const char *separator, char **state);
034c6ed7 202char *split_quoted(const char *c, size_t *l, char **state);
a41e8209 203
034c6ed7 204#define FOREACH_WORD(word, length, s, state) \
f62c0e4f 205 for ((state) = NULL, (word) = split((s), &(length), WHITESPACE, &(state)); (word); (word) = split((s), &(length), WHITESPACE, &(state)))
65d2ebdc
LP
206
207#define FOREACH_WORD_SEPARATOR(word, length, s, separator, state) \
f62c0e4f 208 for ((state) = NULL, (word) = split((s), &(length), (separator), &(state)); (word); (word) = split((s), &(length), (separator), &(state)))
a41e8209 209
034c6ed7 210#define FOREACH_WORD_QUOTED(word, length, s, state) \
f62c0e4f 211 for ((state) = NULL, (word) = split_quoted((s), &(length), &(state)); (word); (word) = split_quoted((s), &(length), &(state)))
034c6ed7 212
034c6ed7 213pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
7640a5de 214int get_starttime_of_pid(pid_t pid, unsigned long long *st);
034c6ed7 215
44d8db9e 216char *strappend(const char *s, const char *suffix);
fab56fc5
LP
217char *strnappend(const char *s, const char *suffix, size_t length);
218
219char *replace_env(const char *format, char **env);
220char **replace_env_argv(char **argv, char **env);
44d8db9e 221
87f0e418 222int readlink_malloc(const char *p, char **r);
2c7108c4 223int readlink_and_make_absolute(const char *p, char **r);
83096483 224int readlink_and_canonicalize(const char *p, char **r);
87f0e418 225
2a987ee8
LP
226int reset_all_signal_handlers(void);
227
4a72ff34 228char *strstrip(char *s);
ee9b5e01 229char *delete_chars(char *s, const char *bad);
7072ced8 230char *truncate_nl(char *s);
ee9b5e01 231
4a72ff34
LP
232char *file_in_same_dir(const char *path, const char *filename);
233
c32dd69b
LP
234int rmdir_parents(const char *path, const char *stop);
235
87d2c1ff
LP
236int get_process_comm(pid_t pid, char **name);
237int get_process_cmdline(pid_t pid, size_t max_length, bool comm_fallback, char **line);
238int get_process_exe(pid_t pid, char **name);
7e4ab3c5 239int get_process_uid(pid_t pid, uid_t *uid);
901c3d0d 240int get_process_gid(pid_t pid, gid_t *gid);
3a832116 241int get_process_capeff(pid_t pid, char **capeff);
7072ced8 242
bcb92f48
CR
243char hexchar(int x) _const_;
244int unhexchar(char c) _const_;
245char octchar(int x) _const_;
246int unoctchar(char c) _const_;
247char decchar(int x) _const_;
248int undecchar(char c) _const_;
4fe88d28
LP
249
250char *cescape(const char *s);
251char *cunescape(const char *s);
6febfd0d 252char *cunescape_length(const char *s, size_t length);
5b4c61cd 253char *cunescape_length_with_prefix(const char *s, size_t length, const char *prefix);
6febfd0d
LP
254
255char *xescape(const char *s, const char *bad);
256
4fe88d28
LP
257char *ascii_strlower(char *path);
258
44a6b1b6
ZJS
259bool dirent_is_file(const struct dirent *de) _pure_;
260bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix) _pure_;
87d2c1ff 261
44a6b1b6 262bool ignore_file(const char *filename) _pure_;
c85dc17b 263
44a6b1b6 264bool chars_intersect(const char *a, const char *b) _pure_;
db12775d 265
843d2643 266int make_stdio(int fd);
ade509ce 267int make_null_stdio(void);
cd3bd60a 268int make_console_stdio(void);
843d2643 269
9bf3b535
LP
270void random_bytes(void *p, size_t n);
271
272static inline uint64_t random_u64(void) {
273 uint64_t u;
274 random_bytes(&u, sizeof(u));
275 return u;
276}
277
278static inline uint32_t random_u32(void) {
279 uint32_t u;
280 random_bytes(&u, sizeof(u));
281 return u;
282}
d3782d60 283
f8b69d1d 284/* For basic lookup tables with strictly enumerated entries */
4e240ab0
MS
285#define __DEFINE_STRING_TABLE_LOOKUP(name,type,scope) \
286 scope const char *name##_to_string(type i) { \
1dccbe19
LP
287 if (i < 0 || i >= (type) ELEMENTSOF(name##_table)) \
288 return NULL; \
289 return name##_table[i]; \
290 } \
4e240ab0 291 scope type name##_from_string(const char *s) { \
1dccbe19
LP
292 type i; \
293 assert(s); \
294 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
4fd5948e
LP
295 if (name##_table[i] && \
296 streq(name##_table[i], s)) \
1dccbe19
LP
297 return i; \
298 return (type) -1; \
299 } \
300 struct __useless_struct_to_allow_trailing_semicolon__
301
4e240ab0
MS
302#define DEFINE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,)
303#define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,static)
1dccbe19 304
f8b69d1d
MS
305/* For string conversions where numbers are also acceptable */
306#define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max) \
307 int name##_to_string_alloc(type i, char **str) { \
308 char *s; \
309 int r; \
310 if (i < 0 || i > max) \
311 return -ERANGE; \
312 if (i < (type) ELEMENTSOF(name##_table)) { \
313 s = strdup(name##_table[i]); \
314 if (!s) \
315 return log_oom(); \
316 } else { \
317 r = asprintf(&s, "%u", i); \
318 if (r < 0) \
319 return log_oom(); \
320 } \
321 *str = s; \
322 return 0; \
323 } \
324 type name##_from_string(const char *s) { \
325 type i; \
326 unsigned u = 0; \
327 assert(s); \
328 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
329 if (name##_table[i] && \
330 streq(name##_table[i], s)) \
331 return i; \
8511dd18 332 if (safe_atou(s, &u) >= 0 && u <= max) \
f8b69d1d
MS
333 return (type) u; \
334 return (type) -1; \
335 } \
336 struct __useless_struct_to_allow_trailing_semicolon__
337
3a0ecb08
LP
338int fd_nonblock(int fd, bool nonblock);
339int fd_cloexec(int fd, bool cloexec);
340
a0d40ac5
LP
341int close_all_fds(const int except[], unsigned n_except);
342
42856c10
LP
343bool fstype_is_network(const char *fstype);
344
601f6a1e
LP
345int chvt(int vt);
346
8f2d43a0 347int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
44b601bc 348int ask(char *ret, const char *replies, const char *text, ...) _printf_(3, 4);
80876c20 349
512947d4 350int reset_terminal_fd(int fd, bool switch_to_text);
6ea832a2
LP
351int reset_terminal(const char *name);
352
80876c20 353int open_terminal(const char *name, int mode);
af6da548 354int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
80876c20
LP
355int release_terminal(void);
356
357int flush_fd(int fd);
358
9a34ec5f
LP
359int ignore_signals(int sig, ...);
360int default_signals(int sig, ...);
361int sigaction_many(const struct sigaction *sa, ...);
a337c6fc 362
8d567588 363int close_pipe(int p[]);
5a3ab509 364int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
8d567588 365
eb22ac37
LP
366ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
367ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
8d567588 368
8407a5d0
LP
369bool is_device_path(const char *path);
370
01f78473 371int dir_is_empty(const char *path);
844ec79b 372char* dirname_malloc(const char *path);
01f78473 373
5b6319dc 374void rename_process(const char name[8]);
2d368c14 375
7d793605
LP
376void sigset_add_many(sigset_t *ss, ...);
377
344de609 378bool hostname_is_set(void);
7c5f152a
LP
379
380char* gethostname_malloc(void);
ef2f1067 381char* getlogname_malloc(void);
7c5f152a 382char* getusername_malloc(void);
fc116c6a
LP
383
384int getttyname_malloc(int fd, char **r);
385int getttyname_harder(int fd, char **r);
386
4d6d6518
LP
387int get_ctty_devnr(pid_t pid, dev_t *d);
388int get_ctty(pid_t, dev_t *_devnr, char **r);
8c6db833
LP
389
390int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
f4b47811 391int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
8c6db833 392
597f43c7 393int rm_rf_children(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
f56d5db9 394int rm_rf_children_dangerous(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
ad293f5a 395int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
f56d5db9 396int rm_rf_dangerous(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
ef2f1067 397
1325aa42
LP
398int pipe_eof(int fd);
399
82c121a4
LP
400cpu_set_t* cpu_set_malloc(unsigned *ncpus);
401
44b601bc
LP
402int status_vprintf(const char *status, bool ellipse, bool ephemeral, const char *format, va_list ap) _printf_(4,0);
403int status_printf(const char *status, bool ellipse, bool ephemeral, const char *format, ...) _printf_(4,5);
669bec5d 404int status_welcome(void);
9e58ff9c 405
81beb750 406int fd_columns(int fd);
72f59706 407unsigned columns(void);
8f2d43a0
LP
408int fd_lines(int fd);
409unsigned lines(void);
ed757c0c
LP
410void columns_lines_cache_reset(int _unused_ signum);
411
412bool on_tty(void);
8f2d43a0 413
0b5a519c
DS
414static inline const char *ansi_highlight(void) {
415 return on_tty() ? ANSI_HIGHLIGHT_ON : "";
416}
417
418static inline const char *ansi_highlight_red(void) {
419 return on_tty() ? ANSI_HIGHLIGHT_RED_ON : "";
420}
421
422static inline const char *ansi_highlight_green(void) {
423 return on_tty() ? ANSI_HIGHLIGHT_GREEN_ON : "";
424}
425
dbc2c080
LP
426static inline const char *ansi_highlight_yellow(void) {
427 return on_tty() ? ANSI_HIGHLIGHT_YELLOW_ON : "";
428}
429
c0fdf098
ZJS
430static inline const char *ansi_highlight_blue(void) {
431 return on_tty() ? ANSI_HIGHLIGHT_BLUE_ON : "";
432}
433
0b5a519c
DS
434static inline const char *ansi_highlight_off(void) {
435 return on_tty() ? ANSI_HIGHLIGHT_OFF : "";
436}
437
b4f10a5e
LP
438int running_in_chroot(void);
439
72f59706 440char *ellipsize(const char *s, size_t length, unsigned percent);
f405e86d 441 /* bytes columns */
72f59706 442char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
8fe914ec 443
f6144808
LP
444int touch(const char *path);
445
97c4a07d 446char *unquote(const char *s, const char *quotes);
5f7c426e 447char *normalize_env_assignment(const char *s);
11ce3427 448
8e12a6ae 449int wait_for_terminate(pid_t pid, siginfo_t *status);
97c4a07d 450int wait_for_terminate_and_warn(const char *name, pid_t pid);
2e78aa99 451
919ce0b7 452noreturn void freeze(void);
3c14d26c 453
44a6b1b6 454bool null_or_empty(struct stat *st) _pure_;
83096483 455int null_or_empty_path(const char *fn);
00dc5d76 456
a247755d 457DIR *xopendirat(int dirfd, const char *name, int flags);
3b63d2d3 458
e23a0ce8
LP
459char *fstab_node_to_udev_node(const char *p);
460
21baf21a 461char *resolve_dev_console(char **active);
f212ac12 462bool tty_is_vc(const char *tty);
3043935f 463bool tty_is_vc_resolve(const char *tty);
44a6b1b6 464bool tty_is_console(const char *tty) _pure_;
98a28fef 465int vtnr_from_tty(const char *tty);
e3aa71c3
LP
466const char *default_term_for_tty(const char *tty);
467
83cc030f
LP
468void execute_directory(const char *directory, DIR *_d, char *argv[]);
469
430c18ed
LP
470int kill_and_sigcont(pid_t pid, int sig);
471
05feefe0
LP
472bool nulstr_contains(const char*nulstr, const char *needle);
473
6faa1114
LP
474bool plymouth_running(void);
475
44a6b1b6 476bool hostname_is_valid(const char *s) _pure_;
e724b063 477char* hostname_cleanup(char *s, bool lowercase);
9beb3f4d
LP
478
479char* strshorten(char *s, size_t l);
480
6ea832a2
LP
481int terminal_vhangup_fd(int fd);
482int terminal_vhangup(const char *name);
483
484int vt_disallocate(const char *name);
485
51045322 486int copy_file(const char *from, const char *to, int flags);
424a19f8
LP
487
488int symlink_atomic(const char *from, const char *to);
34ca941c
LP
489
490int fchmod_umask(int fd, mode_t mode);
491
44a6b1b6 492bool display_is_local(const char *display) _pure_;
4d6d6518
LP
493int socket_from_display(const char *display, char **path);
494
d05c5031 495int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
4b67834e 496int get_group_creds(const char **groupname, gid_t *gid);
1cccf435 497
4468addc 498int in_gid(gid_t gid);
43673799
LP
499int in_group(const char *name);
500
59164be4 501char* uid_to_name(uid_t uid);
4468addc 502char* gid_to_name(gid_t gid);
59164be4 503
8092a428 504int glob_exists(const char *path);
8d98da3f 505int glob_extend(char ***strv, const char *path);
8092a428 506
83096483
LP
507int dirent_ensure_type(DIR *d, struct dirent *de);
508
509int in_search_path(const char *path, char **search);
034a2a52 510int get_files_in_directory(const char *path, char ***list);
83096483 511
b7def684 512char *strjoin(const char *x, ...) _sentinel_;
911a4828 513
b636465b
LP
514bool is_main_thread(void);
515
44a6b1b6 516bool in_charset(const char *s, const char* charset) _pure_;
ab1f0633 517
94959f0f
LP
518int block_get_whole_disk(dev_t d, dev_t *ret);
519
8d53b453 520int file_is_priv_sticky(const char *p);
ad293f5a 521
fb9de93d
LP
522int strdup_or_null(const char *a, char **b);
523
e23a0ce8 524#define NULSTR_FOREACH(i, l) \
c4e2ceae
LP
525 for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
526
5c0532d1
LP
527#define NULSTR_FOREACH_PAIR(i, j, l) \
528 for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
529
f8b69d1d 530int ioprio_class_to_string_alloc(int i, char **s);
1dccbe19
LP
531int ioprio_class_from_string(const char *s);
532
44a6b1b6
ZJS
533const char *sigchld_code_to_string(int i) _const_;
534int sigchld_code_from_string(const char *s) _pure_;
1dccbe19 535
f8b69d1d 536int log_facility_unshifted_to_string_alloc(int i, char **s);
7d76f312 537int log_facility_unshifted_from_string(const char *s);
1dccbe19 538
f8b69d1d 539int log_level_to_string_alloc(int i, char **s);
1dccbe19
LP
540int log_level_from_string(const char *s);
541
f8b69d1d 542int sched_policy_to_string_alloc(int i, char **s);
1dccbe19
LP
543int sched_policy_from_string(const char *s);
544
44a6b1b6
ZJS
545const char *rlimit_to_string(int i) _const_;
546int rlimit_from_string(const char *s) _pure_;
1dccbe19 547
f8b69d1d 548int ip_tos_to_string_alloc(int i, char **s);
4fd5948e
LP
549int ip_tos_from_string(const char *s);
550
44a6b1b6
ZJS
551const char *signal_to_string(int i) _const_;
552int signal_from_string(const char *s) _pure_;
2e22afe9 553
8a0867d6
LP
554int signal_from_string_try_harder(const char *s);
555
9a0e6896
LP
556extern int saved_argc;
557extern char **saved_argv;
558
65457142
FC
559bool kexec_loaded(void);
560
44a6b1b6 561int prot_from_flags(int flags) _const_;
87d2c1ff 562
babfc091
LP
563char *format_bytes(char *buf, size_t l, off_t t);
564
8f2d43a0 565int fd_wait_for_event(int fd, int event, usec_t timeout);
df50185b 566
750ef272 567void* memdup(const void *p, size_t l) _alloc_(2);
55d7bfc1 568
1e5678d0
LP
569int is_kernel_thread(pid_t pid);
570
bb99a35a
LP
571int fd_inc_sndbuf(int fd, size_t n);
572int fd_inc_rcvbuf(int fd, size_t n);
6bb92a16 573
9bdc770c 574int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
6bb92a16 575
68faf98c
LP
576int setrlimit_closest(int resource, const struct rlimit *rlim);
577
ab94af92
LP
578int getenv_for_pid(pid_t pid, const char *field, char **_value);
579
44a6b1b6 580bool is_valid_documentation_url(const char *url) _pure_;
49dbfa7b 581
9be346c9 582bool in_initrd(void);
069cfc85
LP
583
584void warn_melody(void);
585
7c5f152a 586int get_home_dir(char **ret);
2cfbd749 587int get_shell(char **_ret);
2fbe635a 588
a740c14c
MS
589static inline void freep(void *p) {
590 free(*(void**) p);
591}
592
14bf2c9d
LP
593#define DEFINE_TRIVIAL_CLEANUP_FUNC(type, func) \
594 static inline void func##p(type *p) { \
595 if (*p) \
596 func(*p); \
597 } \
598 struct __useless_struct_to_allow_trailing_semicolon__
dfb33a97
LP
599
600static inline void closep(int *fd) {
601 if (*fd >= 0)
602 close_nointr_nofail(*fd);
603}
604
dfb33a97
LP
605static inline void umaskp(mode_t *u) {
606 umask(*u);
763c7aa2
ZJS
607}
608
04d39279
LP
609static inline void close_pipep(int (*p)[2]) {
610 close_pipe(*p);
611}
612
14bf2c9d
LP
613DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, fclose);
614DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, pclose);
615DEFINE_TRIVIAL_CLEANUP_FUNC(DIR*, closedir);
616DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, endmntent);
5862d652 617
dfb33a97 618#define _cleanup_free_ _cleanup_(freep)
dfb33a97 619#define _cleanup_close_ _cleanup_(closep)
dfb33a97
LP
620#define _cleanup_umask_ _cleanup_(umaskp)
621#define _cleanup_globfree_ _cleanup_(globfree)
1ca208fb
ZJS
622#define _cleanup_fclose_ _cleanup_(fclosep)
623#define _cleanup_pclose_ _cleanup_(pclosep)
624#define _cleanup_closedir_ _cleanup_(closedirp)
5862d652 625#define _cleanup_endmntent_ _cleanup_(endmntentp)
04d39279 626#define _cleanup_close_pipe_ _cleanup_(close_pipep)
c84a9488 627
750ef272 628_malloc_ _alloc_(1, 2) static inline void *malloc_multiply(size_t a, size_t b) {
aa408e77 629 if (_unlikely_(b == 0 || a > ((size_t) -1) / b))
4b8772bf
LP
630 return NULL;
631
632 return malloc(a * b);
633}
634
750ef272 635_alloc_(2, 3) static inline void *memdup_multiply(const void *p, size_t a, size_t b) {
aa408e77 636 if (_unlikely_(b == 0 || a > ((size_t) -1) / b))
4b8772bf
LP
637 return NULL;
638
639 return memdup(p, a * b);
640}
0b507b17 641
44a6b1b6
ZJS
642bool filename_is_safe(const char *p) _pure_;
643bool path_is_safe(const char *p) _pure_;
644bool string_is_safe(const char *p) _pure_;
645bool string_has_cc(const char *p) _pure_;
cfbc22ab 646
e3e0314b
ZJS
647/**
648 * Check if a string contains any glob patterns.
649 */
650_pure_ static inline bool string_is_glob(const char *p) {
651 return !!strpbrk(p, GLOB_CHARS);
652}
653
a9e12476
KS
654void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
655 int (*compar) (const void *, const void *, void *),
656 void *arg);
09017585
MS
657
658bool is_locale_utf8(void);
c339d977
MS
659
660typedef enum DrawSpecialChar {
45a5ff0d
MS
661 DRAW_TREE_VERT,
662 DRAW_TREE_BRANCH,
663 DRAW_TREE_RIGHT,
55c0b89c 664 DRAW_TREE_SPACE,
c339d977 665 DRAW_TRIANGULAR_BULLET,
3deadb91 666 DRAW_BLACK_CIRCLE,
c339d977
MS
667 _DRAW_SPECIAL_CHAR_MAX
668} DrawSpecialChar;
669const char *draw_special_char(DrawSpecialChar ch);
409bc9c3
LP
670
671char *strreplace(const char *text, const char *old_string, const char *new_string);
e8bc0ea2
LP
672
673char *strip_tab_ansi(char **p, size_t *l);
240dbaa4
LP
674
675int on_ac_power(void);
f74e605f 676
fabe5c0e
LP
677int search_and_fopen(const char *path, const char *mode, const char **search, FILE **_f);
678int search_and_fopen_nulstr(const char *path, const char *mode, const char *search, FILE **_f);
679
9db11a99
LP
680#define FOREACH_LINE(line, f, on_error) \
681 for (;;) \
f74e605f
LP
682 if (!fgets(line, sizeof(line), f)) { \
683 if (ferror(f)) { \
684 on_error; \
685 } \
686 break; \
687 } else
9db11a99
LP
688
689#define FOREACH_DIRENT(de, d, on_error) \
690 for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \
691 if (!de) { \
8333c77e 692 if (errno > 0) { \
9db11a99
LP
693 on_error; \
694 } \
695 break; \
696 } else if (ignore_file((de)->d_name)) \
697 continue; \
698 else
6282c859
MS
699
700static inline void *mempset(void *s, int c, size_t n) {
701 memset(s, c, n);
dfb33a97 702 return (uint8_t*)s + n;
6282c859 703}
66e35261
LP
704
705char *hexmem(const void *p, size_t l);
2181a7f5
LP
706void *unhexmem(const char *p, size_t l);
707
a432cb69 708char *strextend(char **x, ...) _sentinel_;
9a17484d 709char *strrep(const char *s, unsigned n);
392d5b37
LP
710
711void* greedy_realloc(void **p, size_t *allocated, size_t need);
4545a231 712void* greedy_realloc0(void **p, size_t *allocated, size_t need);
2244a6fb 713#define GREEDY_REALLOC(array, allocated, need) \
dfb33a97 714 greedy_realloc((void**) &(array), &(allocated), sizeof((array)[0]) * (need))
4545a231
DH
715#define GREEDY_REALLOC0(array, allocated, need) \
716 greedy_realloc0((void**) &(array), &(allocated), sizeof((array)[0]) * (need))
5c0aa72a 717
5c0d398d 718static inline void _reset_errno_(int *saved_errno) {
5c0aa72a
LP
719 errno = *saved_errno;
720}
721
2a371001 722#define PROTECT_ERRNO _cleanup_(_reset_errno_) __attribute__((unused)) int _saved_errno_ = errno
5c0d398d 723
d6dd604b 724struct _umask_struct_ {
5c0d398d
LP
725 mode_t mask;
726 bool quit;
727};
728
d6dd604b 729static inline void _reset_umask_(struct _umask_struct_ *s) {
5c0d398d
LP
730 umask(s->mask);
731};
732
733#define RUN_WITH_UMASK(mask) \
d6dd604b 734 for (_cleanup_(_reset_umask_) struct _umask_struct_ _saved_umask_ = { umask(mask), false }; \
5c0d398d
LP
735 !_saved_umask_.quit ; \
736 _saved_umask_.quit = true)
144e51ec
CR
737
738static inline unsigned u64log2(uint64_t n) {
693eb9a2 739 return (n > 1) ? (unsigned) __builtin_clzll(n) ^ 63U : 0;
144e51ec 740}
79d860fe
MP
741
742static inline bool logind_running(void) {
743 return access("/run/systemd/seats/", F_OK) >= 0;
744}
4b73a0c0 745
82da66fb
LP
746#define DECIMAL_STR_WIDTH(x) \
747 ({ \
748 typeof(x) _x_ = (x); \
749 unsigned ans = 1; \
750 while (_x_ /= 10) \
751 ans++; \
752 ans; \
753 })
75add28a 754
4b73a0c0 755int unlink_noerrno(const char *path);
ed5c5dbd 756
82da66fb
LP
757#define alloca0(n) \
758 ({ \
759 char *_new_; \
760 size_t _len_ = n; \
761 _new_ = alloca(_len_); \
762 (void *) memset(_new_, 0, _len_); \
ed5c5dbd 763 })
66060897
LP
764
765#define strappenda(a, b) \
766 ({ \
767 const char *_a_ = (a), *_b_ = (b); \
768 char *_c_; \
769 size_t _x_, _y_; \
770 _x_ = strlen(_a_); \
771 _y_ = strlen(_b_); \
772 _c_ = alloca(_x_ + _y_ + 1); \
773 strcpy(stpcpy(_c_, _a_), _b_); \
774 _c_; \
775 })
31885cd5
ZJS
776
777#define procfs_file_alloca(pid, field) \
778 ({ \
779 pid_t _pid_ = (pid); \
b68fa010
SP
780 const char *_r_; \
781 if (_pid_ == 0) { \
782 _r_ = ("/proc/self/" field); \
783 } else { \
784 _r_ = alloca(strlen("/proc/") + DECIMAL_STR_MAX(pid_t) + 1 + sizeof(field)); \
785 sprintf((char*) _r_, "/proc/"PID_FMT"/" field, _pid_); \
786 } \
31885cd5
ZJS
787 _r_; \
788 })
d6dd604b
LP
789
790struct _locale_struct_ {
791 locale_t saved_locale;
792 locale_t new_locale;
793 bool quit;
794};
795
796static inline void _reset_locale_(struct _locale_struct_ *s) {
797 PROTECT_ERRNO;
798 if (s->saved_locale != (locale_t) 0)
799 uselocale(s->saved_locale);
800 if (s->new_locale != (locale_t) 0)
801 freelocale(s->new_locale);
802}
803
804#define RUN_WITH_LOCALE(mask, loc) \
805 for (_cleanup_(_reset_locale_) struct _locale_struct_ _saved_locale_ = { (locale_t) 0, (locale_t) 0, false }; \
806 ({ \
807 if (!_saved_locale_.quit) { \
808 PROTECT_ERRNO; \
809 _saved_locale_.new_locale = newlocale((mask), (loc), (locale_t) 0); \
810 if (_saved_locale_.new_locale != (locale_t) 0) \
811 _saved_locale_.saved_locale = uselocale(_saved_locale_.new_locale); \
812 } \
813 !_saved_locale_.quit; }) ; \
814 _saved_locale_.quit = true)
aa96c6cb 815
44a6b1b6 816bool id128_is_valid(const char *s) _pure_;
7085053a 817void parse_user_at_host(char *arg, char **user, char **host);
d4ac85c6
LP
818
819int split_pair(const char *s, const char *sep, char **l, char **r);
7ff7394d 820
74df0fca 821int shall_restore_state(void);
295edddf 822
7ff7394d
ZJS
823/**
824 * Normal qsort requires base to be nonnull. Here were require
825 * that only if nmemb > 0.
826 */
827static inline void qsort_safe(void *base, size_t nmemb, size_t size,
828 int (*compar)(const void *, const void *)) {
829 if (nmemb) {
830 assert(base);
831 qsort(base, nmemb, size, compar);
832 }
833}
74df0fca
LP
834
835int proc_cmdline(char **ret);
bc9fd78c
LP
836
837int container_get_leader(const char *machine, pid_t *pid);
838
a4475f57
LP
839int namespace_open(pid_t pid, int *pidns_fd, int *mntns_fd, int *root_fd);
840int namespace_enter(int pidns_fd, int mntns_fd, int root_fd);
bf108e55
LP
841
842bool pid_valid(pid_t pid);
eff05270
LP
843
844int getpeercred(int fd, struct ucred *ucred);
845int getpeersec(int fd, char **ret);