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