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