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