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