]> git.ipfire.org Git - thirdparty/systemd.git/blame - src/shared/util.h
update TODO
[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 407char *ellipsize(const char *s, size_t length, unsigned percent);
f405e86d 408 /* bytes columns */
72f59706 409char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
8fe914ec 410
f6144808
LP
411int touch(const char *path);
412
97c4a07d 413char *unquote(const char *s, const char *quotes);
5f7c426e 414char *normalize_env_assignment(const char *s);
11ce3427 415
8e12a6ae 416int wait_for_terminate(pid_t pid, siginfo_t *status);
97c4a07d 417int wait_for_terminate_and_warn(const char *name, pid_t pid);
2e78aa99 418
3c14d26c
LP
419_noreturn_ void freeze(void);
420
44a6b1b6 421bool null_or_empty(struct stat *st) _pure_;
83096483 422int null_or_empty_path(const char *fn);
00dc5d76 423
a247755d 424DIR *xopendirat(int dirfd, const char *name, int flags);
3b63d2d3 425
e23a0ce8
LP
426char *fstab_node_to_udev_node(const char *p);
427
21baf21a 428char *resolve_dev_console(char **active);
f212ac12 429bool tty_is_vc(const char *tty);
3043935f 430bool tty_is_vc_resolve(const char *tty);
44a6b1b6 431bool tty_is_console(const char *tty) _pure_;
98a28fef 432int vtnr_from_tty(const char *tty);
e3aa71c3
LP
433const char *default_term_for_tty(const char *tty);
434
83cc030f
LP
435void execute_directory(const char *directory, DIR *_d, char *argv[]);
436
430c18ed
LP
437int kill_and_sigcont(pid_t pid, int sig);
438
05feefe0
LP
439bool nulstr_contains(const char*nulstr, const char *needle);
440
6faa1114
LP
441bool plymouth_running(void);
442
44a6b1b6 443bool hostname_is_valid(const char *s) _pure_;
e724b063 444char* hostname_cleanup(char *s, bool lowercase);
9beb3f4d
LP
445
446char* strshorten(char *s, size_t l);
447
6ea832a2
LP
448int terminal_vhangup_fd(int fd);
449int terminal_vhangup(const char *name);
450
451int vt_disallocate(const char *name);
452
51045322 453int copy_file(const char *from, const char *to, int flags);
424a19f8
LP
454
455int symlink_atomic(const char *from, const char *to);
34ca941c
LP
456
457int fchmod_umask(int fd, mode_t mode);
458
44a6b1b6 459bool display_is_local(const char *display) _pure_;
4d6d6518
LP
460int socket_from_display(const char *display, char **path);
461
d05c5031 462int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
4b67834e 463int get_group_creds(const char **groupname, gid_t *gid);
1cccf435 464
4468addc 465int in_gid(gid_t gid);
43673799
LP
466int in_group(const char *name);
467
59164be4 468char* uid_to_name(uid_t uid);
4468addc 469char* gid_to_name(gid_t gid);
59164be4 470
8092a428 471int glob_exists(const char *path);
8d98da3f 472int glob_extend(char ***strv, const char *path);
8092a428 473
83096483
LP
474int dirent_ensure_type(DIR *d, struct dirent *de);
475
476int in_search_path(const char *path, char **search);
034a2a52 477int get_files_in_directory(const char *path, char ***list);
83096483 478
b7def684 479char *strjoin(const char *x, ...) _sentinel_;
911a4828 480
b636465b
LP
481bool is_main_thread(void);
482
44a6b1b6 483bool in_charset(const char *s, const char* charset) _pure_;
ab1f0633 484
94959f0f
LP
485int block_get_whole_disk(dev_t d, dev_t *ret);
486
8d53b453 487int file_is_priv_sticky(const char *p);
ad293f5a 488
fb9de93d
LP
489int strdup_or_null(const char *a, char **b);
490
e23a0ce8 491#define NULSTR_FOREACH(i, l) \
c4e2ceae
LP
492 for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
493
5c0532d1
LP
494#define NULSTR_FOREACH_PAIR(i, j, l) \
495 for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
496
f8b69d1d 497int ioprio_class_to_string_alloc(int i, char **s);
1dccbe19
LP
498int ioprio_class_from_string(const char *s);
499
44a6b1b6
ZJS
500const char *sigchld_code_to_string(int i) _const_;
501int sigchld_code_from_string(const char *s) _pure_;
1dccbe19 502
f8b69d1d 503int log_facility_unshifted_to_string_alloc(int i, char **s);
7d76f312 504int log_facility_unshifted_from_string(const char *s);
1dccbe19 505
f8b69d1d 506int log_level_to_string_alloc(int i, char **s);
1dccbe19
LP
507int log_level_from_string(const char *s);
508
f8b69d1d 509int sched_policy_to_string_alloc(int i, char **s);
1dccbe19
LP
510int sched_policy_from_string(const char *s);
511
44a6b1b6
ZJS
512const char *rlimit_to_string(int i) _const_;
513int rlimit_from_string(const char *s) _pure_;
1dccbe19 514
f8b69d1d 515int ip_tos_to_string_alloc(int i, char **s);
4fd5948e
LP
516int ip_tos_from_string(const char *s);
517
44a6b1b6
ZJS
518const char *signal_to_string(int i) _const_;
519int signal_from_string(const char *s) _pure_;
2e22afe9 520
8a0867d6
LP
521int signal_from_string_try_harder(const char *s);
522
9a0e6896
LP
523extern int saved_argc;
524extern char **saved_argv;
525
65457142
FC
526bool kexec_loaded(void);
527
44a6b1b6 528int prot_from_flags(int flags) _const_;
87d2c1ff 529
babfc091
LP
530char *format_bytes(char *buf, size_t l, off_t t);
531
8f2d43a0 532int fd_wait_for_event(int fd, int event, usec_t timeout);
df50185b 533
750ef272 534void* memdup(const void *p, size_t l) _alloc_(2);
55d7bfc1 535
1e5678d0
LP
536int is_kernel_thread(pid_t pid);
537
bb99a35a
LP
538int fd_inc_sndbuf(int fd, size_t n);
539int fd_inc_rcvbuf(int fd, size_t n);
6bb92a16 540
9bdc770c 541int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
6bb92a16 542
68faf98c
LP
543int setrlimit_closest(int resource, const struct rlimit *rlim);
544
ab94af92
LP
545int getenv_for_pid(pid_t pid, const char *field, char **_value);
546
44a6b1b6 547bool is_valid_documentation_url(const char *url) _pure_;
49dbfa7b 548
9be346c9 549bool in_initrd(void);
069cfc85
LP
550
551void warn_melody(void);
552
7c5f152a 553int get_home_dir(char **ret);
2fbe635a 554
a740c14c
MS
555static inline void freep(void *p) {
556 free(*(void**) p);
557}
558
1ca208fb
ZJS
559#define define_trivial_cleanup_func(type, func) \
560 static inline void func##p(type *p) { \
561 if (*p) \
562 func(*p); \
563 } \
dfb33a97
LP
564
565static inline void closep(int *fd) {
566 if (*fd >= 0)
567 close_nointr_nofail(*fd);
568}
569
dfb33a97
LP
570static inline void umaskp(mode_t *u) {
571 umask(*u);
763c7aa2
ZJS
572}
573
1ca208fb
ZJS
574define_trivial_cleanup_func(FILE*, fclose)
575define_trivial_cleanup_func(FILE*, pclose)
576define_trivial_cleanup_func(DIR*, closedir)
577define_trivial_cleanup_func(FILE*, endmntent)
5862d652 578
dfb33a97 579#define _cleanup_free_ _cleanup_(freep)
dfb33a97 580#define _cleanup_close_ _cleanup_(closep)
dfb33a97
LP
581#define _cleanup_umask_ _cleanup_(umaskp)
582#define _cleanup_globfree_ _cleanup_(globfree)
1ca208fb
ZJS
583#define _cleanup_fclose_ _cleanup_(fclosep)
584#define _cleanup_pclose_ _cleanup_(pclosep)
585#define _cleanup_closedir_ _cleanup_(closedirp)
5862d652 586#define _cleanup_endmntent_ _cleanup_(endmntentp)
c84a9488 587
750ef272 588_malloc_ _alloc_(1, 2) static inline void *malloc_multiply(size_t a, size_t b) {
aa408e77 589 if (_unlikely_(b == 0 || a > ((size_t) -1) / b))
4b8772bf
LP
590 return NULL;
591
592 return malloc(a * b);
593}
594
750ef272 595_alloc_(2, 3) static inline void *memdup_multiply(const void *p, size_t a, size_t b) {
aa408e77 596 if (_unlikely_(b == 0 || a > ((size_t) -1) / b))
4b8772bf
LP
597 return NULL;
598
599 return memdup(p, a * b);
600}
0b507b17 601
44a6b1b6
ZJS
602bool filename_is_safe(const char *p) _pure_;
603bool path_is_safe(const char *p) _pure_;
604bool string_is_safe(const char *p) _pure_;
605bool string_has_cc(const char *p) _pure_;
cfbc22ab 606
a9e12476
KS
607void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
608 int (*compar) (const void *, const void *, void *),
609 void *arg);
09017585
MS
610
611bool is_locale_utf8(void);
c339d977
MS
612
613typedef enum DrawSpecialChar {
45a5ff0d
MS
614 DRAW_TREE_VERT,
615 DRAW_TREE_BRANCH,
616 DRAW_TREE_RIGHT,
55c0b89c 617 DRAW_TREE_SPACE,
c339d977
MS
618 DRAW_TRIANGULAR_BULLET,
619 _DRAW_SPECIAL_CHAR_MAX
620} DrawSpecialChar;
621const char *draw_special_char(DrawSpecialChar ch);
409bc9c3
LP
622
623char *strreplace(const char *text, const char *old_string, const char *new_string);
e8bc0ea2
LP
624
625char *strip_tab_ansi(char **p, size_t *l);
240dbaa4
LP
626
627int on_ac_power(void);
f74e605f 628
fabe5c0e
LP
629int search_and_fopen(const char *path, const char *mode, const char **search, FILE **_f);
630int search_and_fopen_nulstr(const char *path, const char *mode, const char *search, FILE **_f);
d34cd374 631int create_tmp_dir(char template[], char** dir_name);
fabe5c0e 632
9db11a99
LP
633#define FOREACH_LINE(line, f, on_error) \
634 for (;;) \
f74e605f
LP
635 if (!fgets(line, sizeof(line), f)) { \
636 if (ferror(f)) { \
637 on_error; \
638 } \
639 break; \
640 } else
9db11a99
LP
641
642#define FOREACH_DIRENT(de, d, on_error) \
643 for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \
644 if (!de) { \
8333c77e 645 if (errno > 0) { \
9db11a99
LP
646 on_error; \
647 } \
648 break; \
649 } else if (ignore_file((de)->d_name)) \
650 continue; \
651 else
6282c859
MS
652
653static inline void *mempset(void *s, int c, size_t n) {
654 memset(s, c, n);
dfb33a97 655 return (uint8_t*)s + n;
6282c859 656}
66e35261
LP
657
658char *hexmem(const void *p, size_t l);
2181a7f5
LP
659void *unhexmem(const char *p, size_t l);
660
a432cb69 661char *strextend(char **x, ...) _sentinel_;
9a17484d 662char *strrep(const char *s, unsigned n);
392d5b37
LP
663
664void* greedy_realloc(void **p, size_t *allocated, size_t need);
2244a6fb 665#define GREEDY_REALLOC(array, allocated, need) \
dfb33a97 666 greedy_realloc((void**) &(array), &(allocated), sizeof((array)[0]) * (need))
5c0aa72a 667
5c0d398d 668static inline void _reset_errno_(int *saved_errno) {
5c0aa72a
LP
669 errno = *saved_errno;
670}
671
2a371001 672#define PROTECT_ERRNO _cleanup_(_reset_errno_) __attribute__((unused)) int _saved_errno_ = errno
5c0d398d 673
d6dd604b 674struct _umask_struct_ {
5c0d398d
LP
675 mode_t mask;
676 bool quit;
677};
678
d6dd604b 679static inline void _reset_umask_(struct _umask_struct_ *s) {
5c0d398d
LP
680 umask(s->mask);
681};
682
683#define RUN_WITH_UMASK(mask) \
d6dd604b 684 for (_cleanup_(_reset_umask_) struct _umask_struct_ _saved_umask_ = { umask(mask), false }; \
5c0d398d
LP
685 !_saved_umask_.quit ; \
686 _saved_umask_.quit = true)
144e51ec
CR
687
688static inline unsigned u64log2(uint64_t n) {
689 return (n > 1) ? __builtin_clzll(n) ^ 63U : 0;
690}
79d860fe
MP
691
692static inline bool logind_running(void) {
693 return access("/run/systemd/seats/", F_OK) >= 0;
694}
4b73a0c0 695
82da66fb
LP
696#define DECIMAL_STR_WIDTH(x) \
697 ({ \
698 typeof(x) _x_ = (x); \
699 unsigned ans = 1; \
700 while (_x_ /= 10) \
701 ans++; \
702 ans; \
703 })
75add28a 704
4b73a0c0 705int unlink_noerrno(const char *path);
ed5c5dbd 706
82da66fb
LP
707#define alloca0(n) \
708 ({ \
709 char *_new_; \
710 size_t _len_ = n; \
711 _new_ = alloca(_len_); \
712 (void *) memset(_new_, 0, _len_); \
ed5c5dbd 713 })
66060897
LP
714
715#define strappenda(a, b) \
716 ({ \
717 const char *_a_ = (a), *_b_ = (b); \
718 char *_c_; \
719 size_t _x_, _y_; \
720 _x_ = strlen(_a_); \
721 _y_ = strlen(_b_); \
722 _c_ = alloca(_x_ + _y_ + 1); \
723 strcpy(stpcpy(_c_, _a_), _b_); \
724 _c_; \
725 })
31885cd5
ZJS
726
727#define procfs_file_alloca(pid, field) \
728 ({ \
729 pid_t _pid_ = (pid); \
730 char *_r_; \
731 _r_ = alloca(sizeof("/proc/") -1 + DECIMAL_STR_MAX(pid_t) + 1 + sizeof(field)); \
732 sprintf(_r_, "/proc/%lu/" field, (unsigned long) _pid_); \
733 _r_; \
734 })
d6dd604b
LP
735
736struct _locale_struct_ {
737 locale_t saved_locale;
738 locale_t new_locale;
739 bool quit;
740};
741
742static inline void _reset_locale_(struct _locale_struct_ *s) {
743 PROTECT_ERRNO;
744 if (s->saved_locale != (locale_t) 0)
745 uselocale(s->saved_locale);
746 if (s->new_locale != (locale_t) 0)
747 freelocale(s->new_locale);
748}
749
750#define RUN_WITH_LOCALE(mask, loc) \
751 for (_cleanup_(_reset_locale_) struct _locale_struct_ _saved_locale_ = { (locale_t) 0, (locale_t) 0, false }; \
752 ({ \
753 if (!_saved_locale_.quit) { \
754 PROTECT_ERRNO; \
755 _saved_locale_.new_locale = newlocale((mask), (loc), (locale_t) 0); \
756 if (_saved_locale_.new_locale != (locale_t) 0) \
757 _saved_locale_.saved_locale = uselocale(_saved_locale_.new_locale); \
758 } \
759 !_saved_locale_.quit; }) ; \
760 _saved_locale_.quit = true)
aa96c6cb 761
44a6b1b6 762bool id128_is_valid(const char *s) _pure_;
7085053a 763void parse_user_at_host(char *arg, char **user, char **host);
d4ac85c6
LP
764
765int split_pair(const char *s, const char *sep, char **l, char **r);
7ff7394d
ZJS
766
767/**
768 * Normal qsort requires base to be nonnull. Here were require
769 * that only if nmemb > 0.
770 */
771static inline void qsort_safe(void *base, size_t nmemb, size_t size,
772 int (*compar)(const void *, const void *)) {
773 if (nmemb) {
774 assert(base);
775 qsort(base, nmemb, size, compar);
776 }
777}