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