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