]> git.ipfire.org Git - thirdparty/systemd.git/blame - src/shared/util.h
bus: update bloom filter description a bit
[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
bf85c24d 201char *split(const char *c, size_t *l, const char *separator, bool quoted, char **state);
a41e8209 202
034c6ed7 203#define FOREACH_WORD(word, length, s, state) \
bf85c24d 204 _FOREACH_WORD(word, length, s, WHITESPACE, false, state)
65d2ebdc
LP
205
206#define FOREACH_WORD_SEPARATOR(word, length, s, separator, state) \
bf85c24d 207 _FOREACH_WORD(word, length, s, separator, false, state)
a41e8209 208
034c6ed7 209#define FOREACH_WORD_QUOTED(word, length, s, state) \
bf85c24d
SP
210 _FOREACH_WORD(word, length, s, WHITESPACE, true, state)
211
212#define FOREACH_WORD_SEPARATOR_QUOTED(word, length, s, separator, state) \
213 _FOREACH_WORD(word, length, s, separator, true, state)
214
215#define _FOREACH_WORD(word, length, s, separator, quoted, state) \
216 for ((state) = NULL, (word) = split((s), &(length), (separator), (quoted), &(state)); (word); (word) = split((s), &(length), (separator), (quoted), &(state)))
034c6ed7 217
034c6ed7 218pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
7640a5de 219int get_starttime_of_pid(pid_t pid, unsigned long long *st);
034c6ed7 220
44d8db9e 221char *strappend(const char *s, const char *suffix);
fab56fc5
LP
222char *strnappend(const char *s, const char *suffix, size_t length);
223
224char *replace_env(const char *format, char **env);
225char **replace_env_argv(char **argv, char **env);
44d8db9e 226
87f0e418 227int readlink_malloc(const char *p, char **r);
2c7108c4 228int readlink_and_make_absolute(const char *p, char **r);
83096483 229int readlink_and_canonicalize(const char *p, char **r);
87f0e418 230
2a987ee8
LP
231int reset_all_signal_handlers(void);
232
4a72ff34 233char *strstrip(char *s);
ee9b5e01 234char *delete_chars(char *s, const char *bad);
7072ced8 235char *truncate_nl(char *s);
ee9b5e01 236
4a72ff34
LP
237char *file_in_same_dir(const char *path, const char *filename);
238
c32dd69b
LP
239int rmdir_parents(const char *path, const char *stop);
240
87d2c1ff
LP
241int get_process_comm(pid_t pid, char **name);
242int get_process_cmdline(pid_t pid, size_t max_length, bool comm_fallback, char **line);
243int get_process_exe(pid_t pid, char **name);
7e4ab3c5 244int get_process_uid(pid_t pid, uid_t *uid);
901c3d0d 245int get_process_gid(pid_t pid, gid_t *gid);
3a832116 246int get_process_capeff(pid_t pid, char **capeff);
7072ced8 247
bcb92f48
CR
248char hexchar(int x) _const_;
249int unhexchar(char c) _const_;
250char octchar(int x) _const_;
251int unoctchar(char c) _const_;
252char decchar(int x) _const_;
253int undecchar(char c) _const_;
4fe88d28
LP
254
255char *cescape(const char *s);
256char *cunescape(const char *s);
6febfd0d 257char *cunescape_length(const char *s, size_t length);
5b4c61cd 258char *cunescape_length_with_prefix(const char *s, size_t length, const char *prefix);
6febfd0d
LP
259
260char *xescape(const char *s, const char *bad);
261
4fe88d28
LP
262char *ascii_strlower(char *path);
263
44a6b1b6
ZJS
264bool dirent_is_file(const struct dirent *de) _pure_;
265bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix) _pure_;
87d2c1ff 266
44a6b1b6 267bool ignore_file(const char *filename) _pure_;
c85dc17b 268
44a6b1b6 269bool chars_intersect(const char *a, const char *b) _pure_;
db12775d 270
843d2643 271int make_stdio(int fd);
ade509ce 272int make_null_stdio(void);
cd3bd60a 273int make_console_stdio(void);
843d2643 274
9bf3b535
LP
275void random_bytes(void *p, size_t n);
276
277static inline uint64_t random_u64(void) {
278 uint64_t u;
279 random_bytes(&u, sizeof(u));
280 return u;
281}
282
283static inline uint32_t random_u32(void) {
284 uint32_t u;
285 random_bytes(&u, sizeof(u));
286 return u;
287}
d3782d60 288
f8b69d1d 289/* For basic lookup tables with strictly enumerated entries */
4e240ab0
MS
290#define __DEFINE_STRING_TABLE_LOOKUP(name,type,scope) \
291 scope const char *name##_to_string(type i) { \
1dccbe19
LP
292 if (i < 0 || i >= (type) ELEMENTSOF(name##_table)) \
293 return NULL; \
294 return name##_table[i]; \
295 } \
4e240ab0 296 scope type name##_from_string(const char *s) { \
1dccbe19 297 type i; \
2c3d81d4
TG
298 if (!s) \
299 return (type) -1; \
1dccbe19 300 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
4fd5948e
LP
301 if (name##_table[i] && \
302 streq(name##_table[i], s)) \
1dccbe19
LP
303 return i; \
304 return (type) -1; \
305 } \
306 struct __useless_struct_to_allow_trailing_semicolon__
307
4e240ab0
MS
308#define DEFINE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,)
309#define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,static)
1dccbe19 310
f8b69d1d
MS
311/* For string conversions where numbers are also acceptable */
312#define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max) \
313 int name##_to_string_alloc(type i, char **str) { \
314 char *s; \
315 int r; \
316 if (i < 0 || i > max) \
317 return -ERANGE; \
318 if (i < (type) ELEMENTSOF(name##_table)) { \
319 s = strdup(name##_table[i]); \
320 if (!s) \
321 return log_oom(); \
322 } else { \
323 r = asprintf(&s, "%u", i); \
324 if (r < 0) \
325 return log_oom(); \
326 } \
327 *str = s; \
328 return 0; \
329 } \
330 type name##_from_string(const char *s) { \
331 type i; \
332 unsigned u = 0; \
333 assert(s); \
334 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
335 if (name##_table[i] && \
336 streq(name##_table[i], s)) \
337 return i; \
8511dd18 338 if (safe_atou(s, &u) >= 0 && u <= max) \
f8b69d1d
MS
339 return (type) u; \
340 return (type) -1; \
341 } \
342 struct __useless_struct_to_allow_trailing_semicolon__
343
3a0ecb08
LP
344int fd_nonblock(int fd, bool nonblock);
345int fd_cloexec(int fd, bool cloexec);
346
a0d40ac5
LP
347int close_all_fds(const int except[], unsigned n_except);
348
42856c10
LP
349bool fstype_is_network(const char *fstype);
350
601f6a1e
LP
351int chvt(int vt);
352
8f2d43a0 353int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
44b601bc 354int ask(char *ret, const char *replies, const char *text, ...) _printf_(3, 4);
80876c20 355
512947d4 356int reset_terminal_fd(int fd, bool switch_to_text);
6ea832a2
LP
357int reset_terminal(const char *name);
358
80876c20 359int open_terminal(const char *name, int mode);
af6da548 360int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
80876c20
LP
361int release_terminal(void);
362
363int flush_fd(int fd);
364
9a34ec5f
LP
365int ignore_signals(int sig, ...);
366int default_signals(int sig, ...);
367int sigaction_many(const struct sigaction *sa, ...);
a337c6fc 368
8d567588 369int close_pipe(int p[]);
5a3ab509 370int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
8d567588 371
eb22ac37
LP
372ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
373ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
8d567588 374
8407a5d0
LP
375bool is_device_path(const char *path);
376
01f78473 377int dir_is_empty(const char *path);
844ec79b 378char* dirname_malloc(const char *path);
01f78473 379
5b6319dc 380void rename_process(const char name[8]);
2d368c14 381
7d793605
LP
382void sigset_add_many(sigset_t *ss, ...);
383
344de609 384bool hostname_is_set(void);
7c5f152a
LP
385
386char* gethostname_malloc(void);
ef2f1067 387char* getlogname_malloc(void);
7c5f152a 388char* getusername_malloc(void);
fc116c6a
LP
389
390int getttyname_malloc(int fd, char **r);
391int getttyname_harder(int fd, char **r);
392
4d6d6518
LP
393int get_ctty_devnr(pid_t pid, dev_t *d);
394int get_ctty(pid_t, dev_t *_devnr, char **r);
8c6db833
LP
395
396int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
f4b47811 397int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
8c6db833 398
597f43c7 399int rm_rf_children(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
f56d5db9 400int rm_rf_children_dangerous(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
ad293f5a 401int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
f56d5db9 402int rm_rf_dangerous(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
ef2f1067 403
1325aa42
LP
404int pipe_eof(int fd);
405
82c121a4
LP
406cpu_set_t* cpu_set_malloc(unsigned *ncpus);
407
44b601bc
LP
408int status_vprintf(const char *status, bool ellipse, bool ephemeral, const char *format, va_list ap) _printf_(4,0);
409int status_printf(const char *status, bool ellipse, bool ephemeral, const char *format, ...) _printf_(4,5);
669bec5d 410int status_welcome(void);
9e58ff9c 411
81beb750 412int fd_columns(int fd);
72f59706 413unsigned columns(void);
8f2d43a0
LP
414int fd_lines(int fd);
415unsigned lines(void);
ed757c0c
LP
416void columns_lines_cache_reset(int _unused_ signum);
417
418bool on_tty(void);
8f2d43a0 419
0b5a519c
DS
420static inline const char *ansi_highlight(void) {
421 return on_tty() ? ANSI_HIGHLIGHT_ON : "";
422}
423
424static inline const char *ansi_highlight_red(void) {
425 return on_tty() ? ANSI_HIGHLIGHT_RED_ON : "";
426}
427
428static inline const char *ansi_highlight_green(void) {
429 return on_tty() ? ANSI_HIGHLIGHT_GREEN_ON : "";
430}
431
dbc2c080
LP
432static inline const char *ansi_highlight_yellow(void) {
433 return on_tty() ? ANSI_HIGHLIGHT_YELLOW_ON : "";
434}
435
c0fdf098
ZJS
436static inline const char *ansi_highlight_blue(void) {
437 return on_tty() ? ANSI_HIGHLIGHT_BLUE_ON : "";
438}
439
0b5a519c
DS
440static inline const char *ansi_highlight_off(void) {
441 return on_tty() ? ANSI_HIGHLIGHT_OFF : "";
442}
443
b4f10a5e
LP
444int running_in_chroot(void);
445
72f59706 446char *ellipsize(const char *s, size_t length, unsigned percent);
f405e86d 447 /* bytes columns */
72f59706 448char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
8fe914ec 449
f6144808
LP
450int touch(const char *path);
451
97c4a07d 452char *unquote(const char *s, const char *quotes);
5f7c426e 453char *normalize_env_assignment(const char *s);
11ce3427 454
8e12a6ae 455int wait_for_terminate(pid_t pid, siginfo_t *status);
97c4a07d 456int wait_for_terminate_and_warn(const char *name, pid_t pid);
2e78aa99 457
919ce0b7 458noreturn void freeze(void);
3c14d26c 459
44a6b1b6 460bool null_or_empty(struct stat *st) _pure_;
83096483 461int null_or_empty_path(const char *fn);
00dc5d76 462
a247755d 463DIR *xopendirat(int dirfd, const char *name, int flags);
3b63d2d3 464
e23a0ce8
LP
465char *fstab_node_to_udev_node(const char *p);
466
21baf21a 467char *resolve_dev_console(char **active);
f212ac12 468bool tty_is_vc(const char *tty);
3043935f 469bool tty_is_vc_resolve(const char *tty);
44a6b1b6 470bool tty_is_console(const char *tty) _pure_;
98a28fef 471int vtnr_from_tty(const char *tty);
e3aa71c3
LP
472const char *default_term_for_tty(const char *tty);
473
83cc030f
LP
474void execute_directory(const char *directory, DIR *_d, char *argv[]);
475
430c18ed
LP
476int kill_and_sigcont(pid_t pid, int sig);
477
05feefe0
LP
478bool nulstr_contains(const char*nulstr, const char *needle);
479
6faa1114
LP
480bool plymouth_running(void);
481
44a6b1b6 482bool hostname_is_valid(const char *s) _pure_;
e724b063 483char* hostname_cleanup(char *s, bool lowercase);
9beb3f4d
LP
484
485char* strshorten(char *s, size_t l);
486
6ea832a2
LP
487int terminal_vhangup_fd(int fd);
488int terminal_vhangup(const char *name);
489
490int vt_disallocate(const char *name);
491
51045322 492int copy_file(const char *from, const char *to, int flags);
424a19f8
LP
493
494int symlink_atomic(const char *from, const char *to);
34ca941c
LP
495
496int fchmod_umask(int fd, mode_t mode);
497
44a6b1b6 498bool display_is_local(const char *display) _pure_;
4d6d6518
LP
499int socket_from_display(const char *display, char **path);
500
d05c5031 501int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
4b67834e 502int get_group_creds(const char **groupname, gid_t *gid);
1cccf435 503
4468addc 504int in_gid(gid_t gid);
43673799
LP
505int in_group(const char *name);
506
59164be4 507char* uid_to_name(uid_t uid);
4468addc 508char* gid_to_name(gid_t gid);
59164be4 509
8092a428 510int glob_exists(const char *path);
8d98da3f 511int glob_extend(char ***strv, const char *path);
8092a428 512
83096483
LP
513int dirent_ensure_type(DIR *d, struct dirent *de);
514
515int in_search_path(const char *path, char **search);
034a2a52 516int get_files_in_directory(const char *path, char ***list);
83096483 517
b7def684 518char *strjoin(const char *x, ...) _sentinel_;
911a4828 519
b636465b
LP
520bool is_main_thread(void);
521
44a6b1b6 522bool in_charset(const char *s, const char* charset) _pure_;
ab1f0633 523
94959f0f
LP
524int block_get_whole_disk(dev_t d, dev_t *ret);
525
8d53b453 526int file_is_priv_sticky(const char *p);
ad293f5a 527
fb9de93d
LP
528int strdup_or_null(const char *a, char **b);
529
e23a0ce8 530#define NULSTR_FOREACH(i, l) \
c4e2ceae
LP
531 for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
532
5c0532d1
LP
533#define NULSTR_FOREACH_PAIR(i, j, l) \
534 for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
535
f8b69d1d 536int ioprio_class_to_string_alloc(int i, char **s);
1dccbe19
LP
537int ioprio_class_from_string(const char *s);
538
44a6b1b6
ZJS
539const char *sigchld_code_to_string(int i) _const_;
540int sigchld_code_from_string(const char *s) _pure_;
1dccbe19 541
f8b69d1d 542int log_facility_unshifted_to_string_alloc(int i, char **s);
7d76f312 543int log_facility_unshifted_from_string(const char *s);
1dccbe19 544
f8b69d1d 545int log_level_to_string_alloc(int i, char **s);
1dccbe19
LP
546int log_level_from_string(const char *s);
547
f8b69d1d 548int sched_policy_to_string_alloc(int i, char **s);
1dccbe19
LP
549int sched_policy_from_string(const char *s);
550
44a6b1b6
ZJS
551const char *rlimit_to_string(int i) _const_;
552int rlimit_from_string(const char *s) _pure_;
1dccbe19 553
f8b69d1d 554int ip_tos_to_string_alloc(int i, char **s);
4fd5948e
LP
555int ip_tos_from_string(const char *s);
556
44a6b1b6
ZJS
557const char *signal_to_string(int i) _const_;
558int signal_from_string(const char *s) _pure_;
2e22afe9 559
8a0867d6
LP
560int signal_from_string_try_harder(const char *s);
561
9a0e6896
LP
562extern int saved_argc;
563extern char **saved_argv;
564
65457142
FC
565bool kexec_loaded(void);
566
44a6b1b6 567int prot_from_flags(int flags) _const_;
87d2c1ff 568
babfc091
LP
569char *format_bytes(char *buf, size_t l, off_t t);
570
8f2d43a0 571int fd_wait_for_event(int fd, int event, usec_t timeout);
df50185b 572
750ef272 573void* memdup(const void *p, size_t l) _alloc_(2);
55d7bfc1 574
1e5678d0
LP
575int is_kernel_thread(pid_t pid);
576
bb99a35a
LP
577int fd_inc_sndbuf(int fd, size_t n);
578int fd_inc_rcvbuf(int fd, size_t n);
6bb92a16 579
9bdc770c 580int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
6bb92a16 581
68faf98c
LP
582int setrlimit_closest(int resource, const struct rlimit *rlim);
583
ab94af92
LP
584int getenv_for_pid(pid_t pid, const char *field, char **_value);
585
44a6b1b6 586bool is_valid_documentation_url(const char *url) _pure_;
49dbfa7b 587
9be346c9 588bool in_initrd(void);
069cfc85
LP
589
590void warn_melody(void);
591
7c5f152a 592int get_home_dir(char **ret);
2cfbd749 593int get_shell(char **_ret);
2fbe635a 594
a740c14c
MS
595static inline void freep(void *p) {
596 free(*(void**) p);
597}
598
14bf2c9d
LP
599#define DEFINE_TRIVIAL_CLEANUP_FUNC(type, func) \
600 static inline void func##p(type *p) { \
601 if (*p) \
602 func(*p); \
603 } \
604 struct __useless_struct_to_allow_trailing_semicolon__
dfb33a97
LP
605
606static inline void closep(int *fd) {
607 if (*fd >= 0)
608 close_nointr_nofail(*fd);
609}
610
dfb33a97
LP
611static inline void umaskp(mode_t *u) {
612 umask(*u);
763c7aa2
ZJS
613}
614
04d39279
LP
615static inline void close_pipep(int (*p)[2]) {
616 close_pipe(*p);
617}
618
14bf2c9d
LP
619DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, fclose);
620DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, pclose);
621DEFINE_TRIVIAL_CLEANUP_FUNC(DIR*, closedir);
622DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, endmntent);
5862d652 623
dfb33a97 624#define _cleanup_free_ _cleanup_(freep)
dfb33a97 625#define _cleanup_close_ _cleanup_(closep)
dfb33a97
LP
626#define _cleanup_umask_ _cleanup_(umaskp)
627#define _cleanup_globfree_ _cleanup_(globfree)
1ca208fb
ZJS
628#define _cleanup_fclose_ _cleanup_(fclosep)
629#define _cleanup_pclose_ _cleanup_(pclosep)
630#define _cleanup_closedir_ _cleanup_(closedirp)
5862d652 631#define _cleanup_endmntent_ _cleanup_(endmntentp)
04d39279 632#define _cleanup_close_pipe_ _cleanup_(close_pipep)
c84a9488 633
750ef272 634_malloc_ _alloc_(1, 2) static inline void *malloc_multiply(size_t a, size_t b) {
aa408e77 635 if (_unlikely_(b == 0 || a > ((size_t) -1) / b))
4b8772bf
LP
636 return NULL;
637
638 return malloc(a * b);
639}
640
750ef272 641_alloc_(2, 3) static inline void *memdup_multiply(const void *p, size_t a, size_t b) {
aa408e77 642 if (_unlikely_(b == 0 || a > ((size_t) -1) / b))
4b8772bf
LP
643 return NULL;
644
645 return memdup(p, a * b);
646}
0b507b17 647
44a6b1b6
ZJS
648bool filename_is_safe(const char *p) _pure_;
649bool path_is_safe(const char *p) _pure_;
650bool string_is_safe(const char *p) _pure_;
651bool string_has_cc(const char *p) _pure_;
cfbc22ab 652
e3e0314b
ZJS
653/**
654 * Check if a string contains any glob patterns.
655 */
656_pure_ static inline bool string_is_glob(const char *p) {
657 return !!strpbrk(p, GLOB_CHARS);
658}
659
a9e12476
KS
660void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
661 int (*compar) (const void *, const void *, void *),
662 void *arg);
09017585
MS
663
664bool is_locale_utf8(void);
c339d977
MS
665
666typedef enum DrawSpecialChar {
45a5ff0d
MS
667 DRAW_TREE_VERT,
668 DRAW_TREE_BRANCH,
669 DRAW_TREE_RIGHT,
55c0b89c 670 DRAW_TREE_SPACE,
c339d977 671 DRAW_TRIANGULAR_BULLET,
3deadb91 672 DRAW_BLACK_CIRCLE,
c339d977
MS
673 _DRAW_SPECIAL_CHAR_MAX
674} DrawSpecialChar;
675const char *draw_special_char(DrawSpecialChar ch);
409bc9c3
LP
676
677char *strreplace(const char *text, const char *old_string, const char *new_string);
e8bc0ea2
LP
678
679char *strip_tab_ansi(char **p, size_t *l);
240dbaa4
LP
680
681int on_ac_power(void);
f74e605f 682
fabe5c0e
LP
683int search_and_fopen(const char *path, const char *mode, const char **search, FILE **_f);
684int search_and_fopen_nulstr(const char *path, const char *mode, const char *search, FILE **_f);
685
9db11a99
LP
686#define FOREACH_LINE(line, f, on_error) \
687 for (;;) \
f74e605f
LP
688 if (!fgets(line, sizeof(line), f)) { \
689 if (ferror(f)) { \
690 on_error; \
691 } \
692 break; \
693 } else
9db11a99
LP
694
695#define FOREACH_DIRENT(de, d, on_error) \
696 for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \
697 if (!de) { \
8333c77e 698 if (errno > 0) { \
9db11a99
LP
699 on_error; \
700 } \
701 break; \
702 } else if (ignore_file((de)->d_name)) \
703 continue; \
704 else
6282c859
MS
705
706static inline void *mempset(void *s, int c, size_t n) {
707 memset(s, c, n);
dfb33a97 708 return (uint8_t*)s + n;
6282c859 709}
66e35261
LP
710
711char *hexmem(const void *p, size_t l);
2181a7f5
LP
712void *unhexmem(const char *p, size_t l);
713
a432cb69 714char *strextend(char **x, ...) _sentinel_;
9a17484d 715char *strrep(const char *s, unsigned n);
392d5b37
LP
716
717void* greedy_realloc(void **p, size_t *allocated, size_t need);
4545a231 718void* greedy_realloc0(void **p, size_t *allocated, size_t need);
2244a6fb 719#define GREEDY_REALLOC(array, allocated, need) \
dfb33a97 720 greedy_realloc((void**) &(array), &(allocated), sizeof((array)[0]) * (need))
4545a231
DH
721#define GREEDY_REALLOC0(array, allocated, need) \
722 greedy_realloc0((void**) &(array), &(allocated), sizeof((array)[0]) * (need))
5c0aa72a 723
5c0d398d 724static inline void _reset_errno_(int *saved_errno) {
5c0aa72a
LP
725 errno = *saved_errno;
726}
727
2a371001 728#define PROTECT_ERRNO _cleanup_(_reset_errno_) __attribute__((unused)) int _saved_errno_ = errno
5c0d398d 729
d6dd604b 730struct _umask_struct_ {
5c0d398d
LP
731 mode_t mask;
732 bool quit;
733};
734
d6dd604b 735static inline void _reset_umask_(struct _umask_struct_ *s) {
5c0d398d
LP
736 umask(s->mask);
737};
738
739#define RUN_WITH_UMASK(mask) \
d6dd604b 740 for (_cleanup_(_reset_umask_) struct _umask_struct_ _saved_umask_ = { umask(mask), false }; \
5c0d398d
LP
741 !_saved_umask_.quit ; \
742 _saved_umask_.quit = true)
144e51ec
CR
743
744static inline unsigned u64log2(uint64_t n) {
693eb9a2 745 return (n > 1) ? (unsigned) __builtin_clzll(n) ^ 63U : 0;
144e51ec 746}
79d860fe
MP
747
748static inline bool logind_running(void) {
749 return access("/run/systemd/seats/", F_OK) >= 0;
750}
4b73a0c0 751
82da66fb
LP
752#define DECIMAL_STR_WIDTH(x) \
753 ({ \
754 typeof(x) _x_ = (x); \
755 unsigned ans = 1; \
756 while (_x_ /= 10) \
757 ans++; \
758 ans; \
759 })
75add28a 760
4b73a0c0 761int unlink_noerrno(const char *path);
ed5c5dbd 762
82da66fb
LP
763#define alloca0(n) \
764 ({ \
765 char *_new_; \
766 size_t _len_ = n; \
767 _new_ = alloca(_len_); \
768 (void *) memset(_new_, 0, _len_); \
ed5c5dbd 769 })
66060897
LP
770
771#define strappenda(a, b) \
772 ({ \
773 const char *_a_ = (a), *_b_ = (b); \
774 char *_c_; \
775 size_t _x_, _y_; \
776 _x_ = strlen(_a_); \
777 _y_ = strlen(_b_); \
778 _c_ = alloca(_x_ + _y_ + 1); \
779 strcpy(stpcpy(_c_, _a_), _b_); \
780 _c_; \
781 })
31885cd5
ZJS
782
783#define procfs_file_alloca(pid, field) \
784 ({ \
785 pid_t _pid_ = (pid); \
b68fa010
SP
786 const char *_r_; \
787 if (_pid_ == 0) { \
788 _r_ = ("/proc/self/" field); \
789 } else { \
790 _r_ = alloca(strlen("/proc/") + DECIMAL_STR_MAX(pid_t) + 1 + sizeof(field)); \
791 sprintf((char*) _r_, "/proc/"PID_FMT"/" field, _pid_); \
792 } \
31885cd5
ZJS
793 _r_; \
794 })
d6dd604b
LP
795
796struct _locale_struct_ {
797 locale_t saved_locale;
798 locale_t new_locale;
799 bool quit;
800};
801
802static inline void _reset_locale_(struct _locale_struct_ *s) {
803 PROTECT_ERRNO;
804 if (s->saved_locale != (locale_t) 0)
805 uselocale(s->saved_locale);
806 if (s->new_locale != (locale_t) 0)
807 freelocale(s->new_locale);
808}
809
810#define RUN_WITH_LOCALE(mask, loc) \
811 for (_cleanup_(_reset_locale_) struct _locale_struct_ _saved_locale_ = { (locale_t) 0, (locale_t) 0, false }; \
812 ({ \
813 if (!_saved_locale_.quit) { \
814 PROTECT_ERRNO; \
815 _saved_locale_.new_locale = newlocale((mask), (loc), (locale_t) 0); \
816 if (_saved_locale_.new_locale != (locale_t) 0) \
817 _saved_locale_.saved_locale = uselocale(_saved_locale_.new_locale); \
818 } \
819 !_saved_locale_.quit; }) ; \
820 _saved_locale_.quit = true)
aa96c6cb 821
44a6b1b6 822bool id128_is_valid(const char *s) _pure_;
7085053a 823void parse_user_at_host(char *arg, char **user, char **host);
d4ac85c6
LP
824
825int split_pair(const char *s, const char *sep, char **l, char **r);
7ff7394d 826
74df0fca 827int shall_restore_state(void);
295edddf 828
7ff7394d
ZJS
829/**
830 * Normal qsort requires base to be nonnull. Here were require
831 * that only if nmemb > 0.
832 */
833static inline void qsort_safe(void *base, size_t nmemb, size_t size,
834 int (*compar)(const void *, const void *)) {
835 if (nmemb) {
836 assert(base);
837 qsort(base, nmemb, size, compar);
838 }
839}
74df0fca
LP
840
841int proc_cmdline(char **ret);
bc9fd78c
LP
842
843int container_get_leader(const char *machine, pid_t *pid);
844
a4475f57
LP
845int namespace_open(pid_t pid, int *pidns_fd, int *mntns_fd, int *root_fd);
846int namespace_enter(int pidns_fd, int mntns_fd, int root_fd);
bf108e55
LP
847
848bool pid_valid(pid_t pid);
eff05270
LP
849
850int getpeercred(int fd, struct ucred *ucred);
851int getpeersec(int fd, char **ret);