]> git.ipfire.org Git - thirdparty/systemd.git/blame - src/shared/util.h
sd-event: rework API to support CLOCK_REALTIME_ALARM and CLOCK_BOOTTIME_ALARM, too
[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);
03e334a1
LP
152int safe_close(int fd);
153
5b6319dc 154void close_many(const int fds[], unsigned n_fd);
60918275 155
5556b5fe
LP
156int parse_size(const char *t, off_t base, off_t *size);
157
44a6b1b6 158int parse_boolean(const char *v) _pure_;
3ba686c1 159int parse_pid(const char *s, pid_t* ret_pid);
034a2a52
LP
160int parse_uid(const char *s, uid_t* ret_uid);
161#define parse_gid(s, ret_uid) parse_uid(s, ret_uid)
85261803
LP
162
163int safe_atou(const char *s, unsigned *ret_u);
164int safe_atoi(const char *s, int *ret_i);
165
8f75a603
LP
166int safe_atollu(const char *s, unsigned long long *ret_u);
167int safe_atolli(const char *s, long long int *ret_i);
168
f7900e25
TA
169int safe_atod(const char *s, double *ret_d);
170
8f75a603
LP
171#if __WORDSIZE == 32
172static inline int safe_atolu(const char *s, unsigned long *ret_u) {
173 assert_cc(sizeof(unsigned long) == sizeof(unsigned));
174 return safe_atou(s, (unsigned*) ret_u);
175}
176static inline int safe_atoli(const char *s, long int *ret_u) {
177 assert_cc(sizeof(long int) == sizeof(int));
178 return safe_atoi(s, (int*) ret_u);
179}
180#else
181static inline int safe_atolu(const char *s, unsigned long *ret_u) {
182 assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
183 return safe_atollu(s, (unsigned long long*) ret_u);
184}
185static inline int safe_atoli(const char *s, long int *ret_u) {
186 assert_cc(sizeof(long int) == sizeof(long long int));
187 return safe_atolli(s, (long long int*) ret_u);
188}
189#endif
190
a838e6a1
LP
191static inline int safe_atou32(const char *s, uint32_t *ret_u) {
192 assert_cc(sizeof(uint32_t) == sizeof(unsigned));
193 return safe_atou(s, (unsigned*) ret_u);
194}
195
8f75a603 196static inline int safe_atoi32(const char *s, int32_t *ret_i) {
a838e6a1 197 assert_cc(sizeof(int32_t) == sizeof(int));
8f75a603 198 return safe_atoi(s, (int*) ret_i);
a838e6a1
LP
199}
200
8f75a603
LP
201static inline int safe_atou64(const char *s, uint64_t *ret_u) {
202 assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
203 return safe_atollu(s, (unsigned long long*) ret_u);
204}
034c6ed7 205
8f75a603
LP
206static inline int safe_atoi64(const char *s, int64_t *ret_i) {
207 assert_cc(sizeof(int64_t) == sizeof(long long int));
208 return safe_atolli(s, (long long int*) ret_i);
209}
034c6ed7 210
bf85c24d 211char *split(const char *c, size_t *l, const char *separator, bool quoted, char **state);
a41e8209 212
034c6ed7 213#define FOREACH_WORD(word, length, s, state) \
bf85c24d 214 _FOREACH_WORD(word, length, s, WHITESPACE, false, state)
65d2ebdc
LP
215
216#define FOREACH_WORD_SEPARATOR(word, length, s, separator, state) \
bf85c24d 217 _FOREACH_WORD(word, length, s, separator, false, state)
a41e8209 218
034c6ed7 219#define FOREACH_WORD_QUOTED(word, length, s, state) \
bf85c24d
SP
220 _FOREACH_WORD(word, length, s, WHITESPACE, true, state)
221
222#define FOREACH_WORD_SEPARATOR_QUOTED(word, length, s, separator, state) \
223 _FOREACH_WORD(word, length, s, separator, true, state)
224
225#define _FOREACH_WORD(word, length, s, separator, quoted, state) \
226 for ((state) = NULL, (word) = split((s), &(length), (separator), (quoted), &(state)); (word); (word) = split((s), &(length), (separator), (quoted), &(state)))
034c6ed7 227
034c6ed7 228pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
7640a5de 229int get_starttime_of_pid(pid_t pid, unsigned long long *st);
034c6ed7 230
44d8db9e 231char *strappend(const char *s, const char *suffix);
fab56fc5
LP
232char *strnappend(const char *s, const char *suffix, size_t length);
233
234char *replace_env(const char *format, char **env);
235char **replace_env_argv(char **argv, char **env);
44d8db9e 236
87f0e418 237int readlink_malloc(const char *p, char **r);
2c7108c4 238int readlink_and_make_absolute(const char *p, char **r);
83096483 239int readlink_and_canonicalize(const char *p, char **r);
87f0e418 240
2a987ee8
LP
241int reset_all_signal_handlers(void);
242
4a72ff34 243char *strstrip(char *s);
ee9b5e01 244char *delete_chars(char *s, const char *bad);
7072ced8 245char *truncate_nl(char *s);
ee9b5e01 246
4a72ff34
LP
247char *file_in_same_dir(const char *path, const char *filename);
248
c32dd69b
LP
249int rmdir_parents(const char *path, const char *stop);
250
93b5eaec 251int get_process_state(pid_t pid);
87d2c1ff
LP
252int get_process_comm(pid_t pid, char **name);
253int get_process_cmdline(pid_t pid, size_t max_length, bool comm_fallback, char **line);
254int get_process_exe(pid_t pid, char **name);
7e4ab3c5 255int get_process_uid(pid_t pid, uid_t *uid);
901c3d0d 256int get_process_gid(pid_t pid, gid_t *gid);
3a832116 257int get_process_capeff(pid_t pid, char **capeff);
7072ced8 258
bcb92f48
CR
259char hexchar(int x) _const_;
260int unhexchar(char c) _const_;
261char octchar(int x) _const_;
262int unoctchar(char c) _const_;
263char decchar(int x) _const_;
264int undecchar(char c) _const_;
4fe88d28
LP
265
266char *cescape(const char *s);
267char *cunescape(const char *s);
6febfd0d 268char *cunescape_length(const char *s, size_t length);
5b4c61cd 269char *cunescape_length_with_prefix(const char *s, size_t length, const char *prefix);
6febfd0d
LP
270
271char *xescape(const char *s, const char *bad);
272
4fe88d28
LP
273char *ascii_strlower(char *path);
274
44a6b1b6
ZJS
275bool dirent_is_file(const struct dirent *de) _pure_;
276bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix) _pure_;
87d2c1ff 277
44a6b1b6 278bool ignore_file(const char *filename) _pure_;
c85dc17b 279
44a6b1b6 280bool chars_intersect(const char *a, const char *b) _pure_;
db12775d 281
843d2643 282int make_stdio(int fd);
ade509ce 283int make_null_stdio(void);
cd3bd60a 284int make_console_stdio(void);
843d2643 285
b89446bb 286int dev_urandom(void *p, size_t n);
9bf3b535
LP
287void random_bytes(void *p, size_t n);
288
289static inline uint64_t random_u64(void) {
290 uint64_t u;
291 random_bytes(&u, sizeof(u));
292 return u;
293}
294
295static inline uint32_t random_u32(void) {
296 uint32_t u;
297 random_bytes(&u, sizeof(u));
298 return u;
299}
d3782d60 300
f8b69d1d 301/* For basic lookup tables with strictly enumerated entries */
4e240ab0
MS
302#define __DEFINE_STRING_TABLE_LOOKUP(name,type,scope) \
303 scope const char *name##_to_string(type i) { \
1dccbe19
LP
304 if (i < 0 || i >= (type) ELEMENTSOF(name##_table)) \
305 return NULL; \
306 return name##_table[i]; \
307 } \
4e240ab0 308 scope type name##_from_string(const char *s) { \
1dccbe19 309 type i; \
2c3d81d4
TG
310 if (!s) \
311 return (type) -1; \
1dccbe19 312 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
4fd5948e
LP
313 if (name##_table[i] && \
314 streq(name##_table[i], s)) \
1dccbe19
LP
315 return i; \
316 return (type) -1; \
317 } \
318 struct __useless_struct_to_allow_trailing_semicolon__
319
4e240ab0
MS
320#define DEFINE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,)
321#define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,static)
1dccbe19 322
f8b69d1d
MS
323/* For string conversions where numbers are also acceptable */
324#define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max) \
325 int name##_to_string_alloc(type i, char **str) { \
326 char *s; \
327 int r; \
328 if (i < 0 || i > max) \
329 return -ERANGE; \
330 if (i < (type) ELEMENTSOF(name##_table)) { \
331 s = strdup(name##_table[i]); \
332 if (!s) \
333 return log_oom(); \
334 } else { \
335 r = asprintf(&s, "%u", i); \
336 if (r < 0) \
337 return log_oom(); \
338 } \
339 *str = s; \
340 return 0; \
341 } \
342 type name##_from_string(const char *s) { \
343 type i; \
344 unsigned u = 0; \
345 assert(s); \
346 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
347 if (name##_table[i] && \
348 streq(name##_table[i], s)) \
349 return i; \
8511dd18 350 if (safe_atou(s, &u) >= 0 && u <= max) \
f8b69d1d
MS
351 return (type) u; \
352 return (type) -1; \
353 } \
354 struct __useless_struct_to_allow_trailing_semicolon__
355
3a0ecb08
LP
356int fd_nonblock(int fd, bool nonblock);
357int fd_cloexec(int fd, bool cloexec);
358
a0d40ac5
LP
359int close_all_fds(const int except[], unsigned n_except);
360
42856c10
LP
361bool fstype_is_network(const char *fstype);
362
601f6a1e
LP
363int chvt(int vt);
364
8f2d43a0 365int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
44b601bc 366int ask(char *ret, const char *replies, const char *text, ...) _printf_(3, 4);
80876c20 367
512947d4 368int reset_terminal_fd(int fd, bool switch_to_text);
6ea832a2
LP
369int reset_terminal(const char *name);
370
80876c20 371int open_terminal(const char *name, int mode);
af6da548 372int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
80876c20
LP
373int release_terminal(void);
374
375int flush_fd(int fd);
376
9a34ec5f
LP
377int ignore_signals(int sig, ...);
378int default_signals(int sig, ...);
379int sigaction_many(const struct sigaction *sa, ...);
a337c6fc 380
8d567588 381int close_pipe(int p[]);
5a3ab509 382int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
8d567588 383
eb22ac37
LP
384ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
385ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
8d567588 386
8407a5d0
LP
387bool is_device_path(const char *path);
388
01f78473 389int dir_is_empty(const char *path);
844ec79b 390char* dirname_malloc(const char *path);
01f78473 391
5b6319dc 392void rename_process(const char name[8]);
2d368c14 393
7d793605
LP
394void sigset_add_many(sigset_t *ss, ...);
395
344de609 396bool hostname_is_set(void);
7c5f152a
LP
397
398char* gethostname_malloc(void);
ef2f1067 399char* getlogname_malloc(void);
7c5f152a 400char* getusername_malloc(void);
fc116c6a
LP
401
402int getttyname_malloc(int fd, char **r);
403int getttyname_harder(int fd, char **r);
404
4d6d6518
LP
405int get_ctty_devnr(pid_t pid, dev_t *d);
406int get_ctty(pid_t, dev_t *_devnr, char **r);
8c6db833
LP
407
408int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
f4b47811 409int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
8c6db833 410
597f43c7 411int rm_rf_children(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
f56d5db9 412int rm_rf_children_dangerous(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
ad293f5a 413int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
f56d5db9 414int rm_rf_dangerous(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
ef2f1067 415
1325aa42
LP
416int pipe_eof(int fd);
417
82c121a4
LP
418cpu_set_t* cpu_set_malloc(unsigned *ncpus);
419
44b601bc
LP
420int status_vprintf(const char *status, bool ellipse, bool ephemeral, const char *format, va_list ap) _printf_(4,0);
421int status_printf(const char *status, bool ellipse, bool ephemeral, const char *format, ...) _printf_(4,5);
9e58ff9c 422
81beb750 423int fd_columns(int fd);
72f59706 424unsigned columns(void);
8f2d43a0
LP
425int fd_lines(int fd);
426unsigned lines(void);
ed757c0c
LP
427void columns_lines_cache_reset(int _unused_ signum);
428
429bool on_tty(void);
8f2d43a0 430
0b5a519c
DS
431static inline const char *ansi_highlight(void) {
432 return on_tty() ? ANSI_HIGHLIGHT_ON : "";
433}
434
435static inline const char *ansi_highlight_red(void) {
436 return on_tty() ? ANSI_HIGHLIGHT_RED_ON : "";
437}
438
439static inline const char *ansi_highlight_green(void) {
440 return on_tty() ? ANSI_HIGHLIGHT_GREEN_ON : "";
441}
442
dbc2c080
LP
443static inline const char *ansi_highlight_yellow(void) {
444 return on_tty() ? ANSI_HIGHLIGHT_YELLOW_ON : "";
445}
446
c0fdf098
ZJS
447static inline const char *ansi_highlight_blue(void) {
448 return on_tty() ? ANSI_HIGHLIGHT_BLUE_ON : "";
449}
450
0b5a519c
DS
451static inline const char *ansi_highlight_off(void) {
452 return on_tty() ? ANSI_HIGHLIGHT_OFF : "";
453}
454
9d9951a4
HH
455int files_same(const char *filea, const char *fileb);
456
b4f10a5e
LP
457int running_in_chroot(void);
458
72f59706 459char *ellipsize(const char *s, size_t length, unsigned percent);
f405e86d 460 /* bytes columns */
72f59706 461char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
8fe914ec 462
f6144808
LP
463int touch(const char *path);
464
97c4a07d 465char *unquote(const char *s, const char *quotes);
5f7c426e 466char *normalize_env_assignment(const char *s);
11ce3427 467
8e12a6ae 468int wait_for_terminate(pid_t pid, siginfo_t *status);
97c4a07d 469int wait_for_terminate_and_warn(const char *name, pid_t pid);
2e78aa99 470
919ce0b7 471noreturn void freeze(void);
3c14d26c 472
44a6b1b6 473bool null_or_empty(struct stat *st) _pure_;
83096483 474int null_or_empty_path(const char *fn);
00dc5d76 475
a247755d 476DIR *xopendirat(int dirfd, const char *name, int flags);
3b63d2d3 477
e23a0ce8
LP
478char *fstab_node_to_udev_node(const char *p);
479
21baf21a 480char *resolve_dev_console(char **active);
f212ac12 481bool tty_is_vc(const char *tty);
3043935f 482bool tty_is_vc_resolve(const char *tty);
44a6b1b6 483bool tty_is_console(const char *tty) _pure_;
98a28fef 484int vtnr_from_tty(const char *tty);
e3aa71c3
LP
485const char *default_term_for_tty(const char *tty);
486
aa62a893 487void execute_directory(const char *directory, DIR *_d, usec_t timeout, char *argv[]);
83cc030f 488
430c18ed
LP
489int kill_and_sigcont(pid_t pid, int sig);
490
05feefe0
LP
491bool nulstr_contains(const char*nulstr, const char *needle);
492
6faa1114
LP
493bool plymouth_running(void);
494
44a6b1b6 495bool hostname_is_valid(const char *s) _pure_;
e724b063 496char* hostname_cleanup(char *s, bool lowercase);
9beb3f4d
LP
497
498char* strshorten(char *s, size_t l);
499
6ea832a2
LP
500int terminal_vhangup_fd(int fd);
501int terminal_vhangup(const char *name);
502
503int vt_disallocate(const char *name);
504
51045322 505int copy_file(const char *from, const char *to, int flags);
424a19f8
LP
506
507int symlink_atomic(const char *from, const char *to);
34ca941c
LP
508
509int fchmod_umask(int fd, mode_t mode);
510
44a6b1b6 511bool display_is_local(const char *display) _pure_;
4d6d6518
LP
512int socket_from_display(const char *display, char **path);
513
d05c5031 514int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
4b67834e 515int get_group_creds(const char **groupname, gid_t *gid);
1cccf435 516
4468addc 517int in_gid(gid_t gid);
43673799
LP
518int in_group(const char *name);
519
59164be4 520char* uid_to_name(uid_t uid);
4468addc 521char* gid_to_name(gid_t gid);
59164be4 522
8092a428 523int glob_exists(const char *path);
8d98da3f 524int glob_extend(char ***strv, const char *path);
8092a428 525
83096483
LP
526int dirent_ensure_type(DIR *d, struct dirent *de);
527
528int in_search_path(const char *path, char **search);
034a2a52 529int get_files_in_directory(const char *path, char ***list);
83096483 530
b7def684 531char *strjoin(const char *x, ...) _sentinel_;
911a4828 532
b636465b
LP
533bool is_main_thread(void);
534
01f83c1c
JT
535static inline bool _pure_ in_charset(const char *s, const char* charset) {
536 assert(s);
537 assert(charset);
538 return s[strspn(s, charset)] == '\0';
539}
ab1f0633 540
94959f0f
LP
541int block_get_whole_disk(dev_t d, dev_t *ret);
542
8d53b453 543int file_is_priv_sticky(const char *p);
ad293f5a 544
fb9de93d
LP
545int strdup_or_null(const char *a, char **b);
546
e23a0ce8 547#define NULSTR_FOREACH(i, l) \
c4e2ceae
LP
548 for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
549
5c0532d1
LP
550#define NULSTR_FOREACH_PAIR(i, j, l) \
551 for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
552
f8b69d1d 553int ioprio_class_to_string_alloc(int i, char **s);
1dccbe19
LP
554int ioprio_class_from_string(const char *s);
555
44a6b1b6
ZJS
556const char *sigchld_code_to_string(int i) _const_;
557int sigchld_code_from_string(const char *s) _pure_;
1dccbe19 558
f8b69d1d 559int log_facility_unshifted_to_string_alloc(int i, char **s);
7d76f312 560int log_facility_unshifted_from_string(const char *s);
1dccbe19 561
f8b69d1d 562int log_level_to_string_alloc(int i, char **s);
1dccbe19
LP
563int log_level_from_string(const char *s);
564
f8b69d1d 565int sched_policy_to_string_alloc(int i, char **s);
1dccbe19
LP
566int sched_policy_from_string(const char *s);
567
44a6b1b6
ZJS
568const char *rlimit_to_string(int i) _const_;
569int rlimit_from_string(const char *s) _pure_;
1dccbe19 570
f8b69d1d 571int ip_tos_to_string_alloc(int i, char **s);
4fd5948e
LP
572int ip_tos_from_string(const char *s);
573
44a6b1b6
ZJS
574const char *signal_to_string(int i) _const_;
575int signal_from_string(const char *s) _pure_;
2e22afe9 576
8a0867d6
LP
577int signal_from_string_try_harder(const char *s);
578
9a0e6896
LP
579extern int saved_argc;
580extern char **saved_argv;
581
65457142
FC
582bool kexec_loaded(void);
583
44a6b1b6 584int prot_from_flags(int flags) _const_;
87d2c1ff 585
babfc091
LP
586char *format_bytes(char *buf, size_t l, off_t t);
587
8f2d43a0 588int fd_wait_for_event(int fd, int event, usec_t timeout);
df50185b 589
750ef272 590void* memdup(const void *p, size_t l) _alloc_(2);
55d7bfc1 591
1e5678d0
LP
592int is_kernel_thread(pid_t pid);
593
bb99a35a
LP
594int fd_inc_sndbuf(int fd, size_t n);
595int fd_inc_rcvbuf(int fd, size_t n);
6bb92a16 596
9bdc770c 597int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
6bb92a16 598
68faf98c
LP
599int setrlimit_closest(int resource, const struct rlimit *rlim);
600
ab94af92
LP
601int getenv_for_pid(pid_t pid, const char *field, char **_value);
602
44a6b1b6 603bool is_valid_documentation_url(const char *url) _pure_;
49dbfa7b 604
9be346c9 605bool in_initrd(void);
069cfc85
LP
606
607void warn_melody(void);
608
7c5f152a 609int get_home_dir(char **ret);
2cfbd749 610int get_shell(char **_ret);
2fbe635a 611
a740c14c
MS
612static inline void freep(void *p) {
613 free(*(void**) p);
614}
615
14bf2c9d
LP
616#define DEFINE_TRIVIAL_CLEANUP_FUNC(type, func) \
617 static inline void func##p(type *p) { \
618 if (*p) \
619 func(*p); \
620 } \
621 struct __useless_struct_to_allow_trailing_semicolon__
dfb33a97
LP
622
623static inline void closep(int *fd) {
03e334a1 624 safe_close(*fd);
dfb33a97
LP
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 784
8fe90522
ZJS
785static inline int log2i(int x) {
786 assert(x > 0);
787
788 return __SIZEOF_INT__ * 8 - __builtin_clz(x) - 1;
789}
790
79d860fe
MP
791static inline bool logind_running(void) {
792 return access("/run/systemd/seats/", F_OK) >= 0;
793}
4b73a0c0 794
82da66fb
LP
795#define DECIMAL_STR_WIDTH(x) \
796 ({ \
797 typeof(x) _x_ = (x); \
798 unsigned ans = 1; \
799 while (_x_ /= 10) \
800 ans++; \
801 ans; \
802 })
75add28a 803
4b73a0c0 804int unlink_noerrno(const char *path);
ed5c5dbd 805
82da66fb
LP
806#define alloca0(n) \
807 ({ \
808 char *_new_; \
809 size_t _len_ = n; \
810 _new_ = alloca(_len_); \
811 (void *) memset(_new_, 0, _len_); \
ed5c5dbd 812 })
66060897
LP
813
814#define strappenda(a, b) \
815 ({ \
816 const char *_a_ = (a), *_b_ = (b); \
817 char *_c_; \
818 size_t _x_, _y_; \
819 _x_ = strlen(_a_); \
820 _y_ = strlen(_b_); \
821 _c_ = alloca(_x_ + _y_ + 1); \
822 strcpy(stpcpy(_c_, _a_), _b_); \
823 _c_; \
824 })
31885cd5 825
f39d4a08
HH
826#define strappenda3(a, b, c) \
827 ({ \
828 const char *_a_ = (a), *_b_ = (b), *_c_ = (c); \
829 char *_d_; \
830 size_t _x_, _y_, _z_; \
831 _x_ = strlen(_a_); \
832 _y_ = strlen(_b_); \
833 _z_ = strlen(_c_); \
834 _d_ = alloca(_x_ + _y_ + _z_ + 1); \
835 strcpy(stpcpy(stpcpy(_d_, _a_), _b_), _c_); \
836 _d_; \
837 })
838
31885cd5
ZJS
839#define procfs_file_alloca(pid, field) \
840 ({ \
841 pid_t _pid_ = (pid); \
b68fa010
SP
842 const char *_r_; \
843 if (_pid_ == 0) { \
844 _r_ = ("/proc/self/" field); \
845 } else { \
846 _r_ = alloca(strlen("/proc/") + DECIMAL_STR_MAX(pid_t) + 1 + sizeof(field)); \
847 sprintf((char*) _r_, "/proc/"PID_FMT"/" field, _pid_); \
848 } \
31885cd5
ZJS
849 _r_; \
850 })
d6dd604b
LP
851
852struct _locale_struct_ {
853 locale_t saved_locale;
854 locale_t new_locale;
855 bool quit;
856};
857
858static inline void _reset_locale_(struct _locale_struct_ *s) {
859 PROTECT_ERRNO;
860 if (s->saved_locale != (locale_t) 0)
861 uselocale(s->saved_locale);
862 if (s->new_locale != (locale_t) 0)
863 freelocale(s->new_locale);
864}
865
866#define RUN_WITH_LOCALE(mask, loc) \
867 for (_cleanup_(_reset_locale_) struct _locale_struct_ _saved_locale_ = { (locale_t) 0, (locale_t) 0, false }; \
868 ({ \
869 if (!_saved_locale_.quit) { \
870 PROTECT_ERRNO; \
871 _saved_locale_.new_locale = newlocale((mask), (loc), (locale_t) 0); \
872 if (_saved_locale_.new_locale != (locale_t) 0) \
873 _saved_locale_.saved_locale = uselocale(_saved_locale_.new_locale); \
874 } \
875 !_saved_locale_.quit; }) ; \
876 _saved_locale_.quit = true)
aa96c6cb 877
44a6b1b6 878bool id128_is_valid(const char *s) _pure_;
d4ac85c6
LP
879
880int split_pair(const char *s, const char *sep, char **l, char **r);
7ff7394d 881
74df0fca 882int shall_restore_state(void);
295edddf 883
7ff7394d
ZJS
884/**
885 * Normal qsort requires base to be nonnull. Here were require
886 * that only if nmemb > 0.
887 */
888static inline void qsort_safe(void *base, size_t nmemb, size_t size,
889 int (*compar)(const void *, const void *)) {
890 if (nmemb) {
891 assert(base);
892 qsort(base, nmemb, size, compar);
893 }
894}
74df0fca
LP
895
896int proc_cmdline(char **ret);
059cb385 897int parse_proc_cmdline(int (*parse_word)(const char *key, const char *value));
bc9fd78c
LP
898
899int container_get_leader(const char *machine, pid_t *pid);
900
a4475f57
LP
901int namespace_open(pid_t pid, int *pidns_fd, int *mntns_fd, int *root_fd);
902int namespace_enter(int pidns_fd, int mntns_fd, int root_fd);
bf108e55 903
9f5650ae
LP
904bool pid_is_alive(pid_t pid);
905bool pid_is_unwaited(pid_t pid);
eff05270
LP
906
907int getpeercred(int fd, struct ucred *ucred);
908int getpeersec(int fd, char **ret);
8e33886e 909
65b3903f
ZJS
910int writev_safe(int fd, const struct iovec *w, int j);
911
912int mkostemp_safe(char *pattern, int flags);
8e33886e 913int open_tmpfile(const char *path, int flags);
fdb9161c
LP
914
915int fd_warn_permissions(const char *path, int fd);
6afc95b7 916
ac45f971
LP
917unsigned long personality_from_string(const char *p);
918const char *personality_to_string(unsigned long);
1c231f56
LP
919
920uint64_t physical_memory(void);
6db615c1
LP
921
922char* mount_test_option(const char *haystack, const char *needle);
29bfbcd6
LP
923
924void hexdump(FILE *f, const void *p, size_t s);