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