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