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