]> git.ipfire.org Git - thirdparty/systemd.git/blame - src/basic/util.h
nspawn: don't try to extract quotes from option string, glibc doesn't do that either
[thirdparty/systemd.git] / src / basic / 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>
ec2002f8 28#include <stdarg.h>
60918275 29#include <stdbool.h>
5cb5a6ff 30#include <stdlib.h>
80876c20 31#include <stdio.h>
82c121a4 32#include <sched.h>
8f75a603 33#include <limits.h>
25ea79fe 34#include <sys/types.h>
2c35d880 35#include <sys/socket.h>
00dc5d76 36#include <sys/stat.h>
3b63d2d3 37#include <dirent.h>
7d5e9c0f 38#include <stddef.h>
79d860fe 39#include <unistd.h>
d6dd604b 40#include <locale.h>
5862d652 41#include <mntent.h>
0254e944 42#include <sys/inotify.h>
c6878637 43#include <sys/statfs.h>
60918275 44
a838e6a1 45#include "macro.h"
dced1557 46#include "missing.h"
9a98c7a1 47#include "time-util.h"
6482f626 48#include "formats-util.h"
871d7de4 49
44d8db9e 50/* What is interpreted as whitespace? */
4a72ff34 51#define WHITESPACE " \t\n\r"
e3e0314b
ZJS
52#define NEWLINE "\n\r"
53#define QUOTES "\"\'"
54#define COMMENTS "#;"
55#define GLOB_CHARS "*?["
44d8db9e 56
0ce5a806
MM
57/* What characters are special in the shell? */
58/* must be escaped outside and inside double-quotes */
59#define SHELL_NEED_ESCAPE "\"\\`$"
60/* can be escaped or double-quoted */
61#define SHELL_NEED_QUOTES SHELL_NEED_ESCAPE GLOB_CHARS "'()<>|&;"
62
a7bc2c2a 63#define FORMAT_BYTES_MAX 8
8b6c7120 64
2e857429 65size_t page_size(void) _pure_;
37f85e66 66#define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
67
60918275 68#define streq(a,b) (strcmp((a),(b)) == 0)
3846aeeb 69#define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
b43d1d01
TA
70#define strcaseeq(a,b) (strcasecmp((a),(b)) == 0)
71#define strncaseeq(a, b, n) (strncasecmp((a), (b), (n)) == 0)
60918275 72
44a6b1b6 73bool streq_ptr(const char *a, const char *b) _pure_;
c030a850 74int strcmp_ptr(const char *a, const char *b) _pure_;
e05797fb 75
4b8772bf 76#define new(t, n) ((t*) malloc_multiply(sizeof(t), (n)))
60918275
LP
77
78#define new0(t, n) ((t*) calloc((n), sizeof(t)))
79
0f0dbc46
LP
80#define newa(t, n) ((t*) alloca(sizeof(t)*(n)))
81
7629889c
LP
82#define newa0(t, n) ((t*) alloca0(sizeof(t)*(n)))
83
4b8772bf 84#define newdup(t, p, n) ((t*) memdup_multiply(p, sizeof(t), (n)))
888c7102 85
60918275
LP
86#define malloc0(n) (calloc((n), 1))
87
97b11eed
DH
88static inline void *mfree(void *memory) {
89 free(memory);
90 return NULL;
91}
92
60918275
LP
93static inline const char* yes_no(bool b) {
94 return b ? "yes" : "no";
95}
96
5232c42e
LS
97static inline const char* true_false(bool b) {
98 return b ? "true" : "false";
99}
100
769d324c
LP
101static inline const char* one_zero(bool b) {
102 return b ? "1" : "0";
103}
104
60918275
LP
105static inline const char* strempty(const char *s) {
106 return s ? s : "";
107}
108
109static inline const char* strnull(const char *s) {
110 return s ? s : "(null)";
111}
112
04fd6fe4
LP
113static inline const char *strna(const char *s) {
114 return s ? s : "n/a";
115}
116
9beb3f4d
LP
117static inline bool isempty(const char *p) {
118 return !p || !p[0];
119}
120
11adc1ae
LP
121static inline char *startswith(const char *s, const char *prefix) {
122 size_t l;
123
124 l = strlen(prefix);
125 if (strncmp(s, prefix, l) == 0)
126 return (char*) s + l;
127
df89481a
KS
128 return NULL;
129}
130
11adc1ae
LP
131static inline char *startswith_no_case(const char *s, const char *prefix) {
132 size_t l;
133
134 l = strlen(prefix);
135 if (strncasecmp(s, prefix, l) == 0)
136 return (char*) s + l;
137
df89481a
KS
138 return NULL;
139}
140
44a6b1b6 141char *endswith(const char *s, const char *postfix) _pure_;
d3226d77 142char *endswith_no_case(const char *s, const char *postfix) _pure_;
60918275 143
5cb36f41 144char *first_word(const char *s, const char *word) _pure_;
79d6d816 145
42f4e3c4 146int close_nointr(int fd);
03e334a1 147int safe_close(int fd);
3d94f76c 148void safe_close_pair(int p[]);
03e334a1 149
5b6319dc 150void close_many(const int fds[], unsigned n_fd);
60918275 151
5556b5fe
LP
152int parse_size(const char *t, off_t base, off_t *size);
153
44a6b1b6 154int parse_boolean(const char *v) _pure_;
3ba686c1 155int parse_pid(const char *s, pid_t* ret_pid);
034a2a52
LP
156int parse_uid(const char *s, uid_t* ret_uid);
157#define parse_gid(s, ret_uid) parse_uid(s, ret_uid)
85261803
LP
158
159int safe_atou(const char *s, unsigned *ret_u);
160int safe_atoi(const char *s, int *ret_i);
161
8f75a603
LP
162int safe_atollu(const char *s, unsigned long long *ret_u);
163int safe_atolli(const char *s, long long int *ret_i);
164
f7900e25
TA
165int safe_atod(const char *s, double *ret_d);
166
b914e211
LP
167int safe_atou8(const char *s, uint8_t *ret);
168
8507eb20 169#if LONG_MAX == INT_MAX
8f75a603
LP
170static inline int safe_atolu(const char *s, unsigned long *ret_u) {
171 assert_cc(sizeof(unsigned long) == sizeof(unsigned));
172 return safe_atou(s, (unsigned*) ret_u);
173}
174static inline int safe_atoli(const char *s, long int *ret_u) {
175 assert_cc(sizeof(long int) == sizeof(int));
176 return safe_atoi(s, (int*) ret_u);
177}
178#else
179static inline int safe_atolu(const char *s, unsigned long *ret_u) {
180 assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
181 return safe_atollu(s, (unsigned long long*) ret_u);
182}
183static inline int safe_atoli(const char *s, long int *ret_u) {
184 assert_cc(sizeof(long int) == sizeof(long long int));
185 return safe_atolli(s, (long long int*) ret_u);
186}
187#endif
188
a838e6a1
LP
189static inline int safe_atou32(const char *s, uint32_t *ret_u) {
190 assert_cc(sizeof(uint32_t) == sizeof(unsigned));
191 return safe_atou(s, (unsigned*) ret_u);
192}
193
8f75a603 194static inline int safe_atoi32(const char *s, int32_t *ret_i) {
a838e6a1 195 assert_cc(sizeof(int32_t) == sizeof(int));
8f75a603 196 return safe_atoi(s, (int*) ret_i);
a838e6a1
LP
197}
198
8f75a603
LP
199static inline int safe_atou64(const char *s, uint64_t *ret_u) {
200 assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
201 return safe_atollu(s, (unsigned long long*) ret_u);
202}
034c6ed7 203
8f75a603
LP
204static inline int safe_atoi64(const char *s, int64_t *ret_i) {
205 assert_cc(sizeof(int64_t) == sizeof(long long int));
206 return safe_atolli(s, (long long int*) ret_i);
207}
034c6ed7 208
781fa938
LP
209int safe_atou16(const char *s, uint16_t *ret);
210int safe_atoi16(const char *s, int16_t *ret);
211
a2a5291b 212const char* split(const char **state, size_t *l, const char *separator, bool quoted);
a41e8209 213
034c6ed7 214#define FOREACH_WORD(word, length, s, state) \
bf85c24d 215 _FOREACH_WORD(word, length, s, WHITESPACE, false, state)
65d2ebdc
LP
216
217#define FOREACH_WORD_SEPARATOR(word, length, s, separator, state) \
bf85c24d 218 _FOREACH_WORD(word, length, s, separator, false, state)
a41e8209 219
034c6ed7 220#define FOREACH_WORD_QUOTED(word, length, s, state) \
bf85c24d
SP
221 _FOREACH_WORD(word, length, s, WHITESPACE, true, state)
222
bf85c24d 223#define _FOREACH_WORD(word, length, s, separator, quoted, state) \
a2a5291b 224 for ((state) = (s), (word) = split(&(state), &(length), (separator), (quoted)); (word); (word) = split(&(state), &(length), (separator), (quoted)))
034c6ed7 225
44d8db9e 226char *strappend(const char *s, const char *suffix);
fab56fc5
LP
227char *strnappend(const char *s, const char *suffix, size_t length);
228
849958d1 229int readlinkat_malloc(int fd, const char *p, char **ret);
87f0e418 230int readlink_malloc(const char *p, char **r);
9a67bcf2 231int readlink_value(const char *p, char **ret);
2c7108c4 232int readlink_and_make_absolute(const char *p, char **r);
83096483 233int readlink_and_canonicalize(const char *p, char **r);
87f0e418 234
4a72ff34 235char *strstrip(char *s);
ee9b5e01 236char *delete_chars(char *s, const char *bad);
7072ced8 237char *truncate_nl(char *s);
ee9b5e01 238
4a72ff34
LP
239char *file_in_same_dir(const char *path, const char *filename);
240
c32dd69b
LP
241int rmdir_parents(const char *path, const char *stop);
242
bcb92f48
CR
243char hexchar(int x) _const_;
244int unhexchar(char c) _const_;
245char octchar(int x) _const_;
246int unoctchar(char c) _const_;
247char decchar(int x) _const_;
248int undecchar(char c) _const_;
919a7f5f
TG
249char base32hexchar(int x) _const_;
250int unbase32hexchar(char c) _const_;
13a5d76b
TG
251char base64char(int x) _const_;
252int unbase64char(char c) _const_;
4fe88d28
LP
253
254char *cescape(const char *s);
0b452006 255size_t cescape_char(char c, char *buf);
527b7a42
LP
256
257typedef enum UnescapeFlags {
258 UNESCAPE_RELAX = 1,
259} UnescapeFlags;
260
261int cunescape(const char *s, UnescapeFlags flags, char **ret);
262int cunescape_length(const char *s, size_t length, UnescapeFlags flags, char **ret);
263int cunescape_length_with_prefix(const char *s, size_t length, const char *prefix, UnescapeFlags flags, char **ret);
6febfd0d
LP
264
265char *xescape(const char *s, const char *bad);
266
4fe88d28
LP
267char *ascii_strlower(char *path);
268
44a6b1b6
ZJS
269bool dirent_is_file(const struct dirent *de) _pure_;
270bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix) _pure_;
87d2c1ff 271
a34bf9db 272bool hidden_file(const char *filename) _pure_;
c85dc17b 273
44a6b1b6 274bool chars_intersect(const char *a, const char *b) _pure_;
db12775d 275
f8b69d1d 276/* For basic lookup tables with strictly enumerated entries */
b9a5f858 277#define _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,scope) \
4e240ab0 278 scope const char *name##_to_string(type i) { \
1dccbe19
LP
279 if (i < 0 || i >= (type) ELEMENTSOF(name##_table)) \
280 return NULL; \
281 return name##_table[i]; \
b9a5f858
LP
282 }
283
9cad100e
BB
284ssize_t string_table_lookup(const char * const *table, size_t len, const char *key);
285
286#define _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,scope) \
287 scope inline type name##_from_string(const char *s) { \
288 return (type)string_table_lookup(name##_table, ELEMENTSOF(name##_table), s); \
b9a5f858
LP
289 }
290
291#define _DEFINE_STRING_TABLE_LOOKUP(name,type,scope) \
292 _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,scope) \
293 _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,scope) \
1dccbe19
LP
294 struct __useless_struct_to_allow_trailing_semicolon__
295
b9a5f858
LP
296#define DEFINE_STRING_TABLE_LOOKUP(name,type) _DEFINE_STRING_TABLE_LOOKUP(name,type,)
297#define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) _DEFINE_STRING_TABLE_LOOKUP(name,type,static)
298#define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_TO_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,static)
299#define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_FROM_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,static)
1dccbe19 300
f8b69d1d
MS
301/* For string conversions where numbers are also acceptable */
302#define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max) \
303 int name##_to_string_alloc(type i, char **str) { \
304 char *s; \
305 int r; \
306 if (i < 0 || i > max) \
307 return -ERANGE; \
308 if (i < (type) ELEMENTSOF(name##_table)) { \
309 s = strdup(name##_table[i]); \
310 if (!s) \
311 return log_oom(); \
312 } else { \
8facc349 313 r = asprintf(&s, "%i", i); \
f8b69d1d
MS
314 if (r < 0) \
315 return log_oom(); \
316 } \
317 *str = s; \
318 return 0; \
319 } \
320 type name##_from_string(const char *s) { \
321 type i; \
322 unsigned u = 0; \
323 assert(s); \
324 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
325 if (name##_table[i] && \
326 streq(name##_table[i], s)) \
327 return i; \
8511dd18 328 if (safe_atou(s, &u) >= 0 && u <= max) \
f8b69d1d
MS
329 return (type) u; \
330 return (type) -1; \
331 } \
332 struct __useless_struct_to_allow_trailing_semicolon__
333
3a0ecb08
LP
334int fd_nonblock(int fd, bool nonblock);
335int fd_cloexec(int fd, bool cloexec);
336
a0d40ac5
LP
337int close_all_fds(const int except[], unsigned n_except);
338
42856c10
LP
339bool fstype_is_network(const char *fstype);
340
80876c20
LP
341int flush_fd(int fd);
342
5a3ab509 343int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
8d567588 344
eb22ac37 345ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
a6dcc7e5 346int loop_read_exact(int fd, void *buf, size_t nbytes, bool do_poll);
553acb7b 347int loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
8d567588 348
8407a5d0
LP
349bool is_device_path(const char *path);
350
01f78473 351int dir_is_empty(const char *path);
844ec79b 352char* dirname_malloc(const char *path);
01f78473 353
f1566e63 354char* lookup_uid(uid_t uid);
ef2f1067 355char* getlogname_malloc(void);
7c5f152a 356char* getusername_malloc(void);
fc116c6a 357
8c6db833 358int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
f4b47811 359int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
8c6db833 360
c6878637
LP
361bool is_temporary_fs(const struct statfs *s) _pure_;
362int fd_is_temporary_fs(int fd);
ef2f1067 363
1325aa42
LP
364int pipe_eof(int fd);
365
82c121a4
LP
366cpu_set_t* cpu_set_malloc(unsigned *ncpus);
367
5ffa8c81
ZJS
368#define xsprintf(buf, fmt, ...) assert_se((size_t) snprintf(buf, ELEMENTSOF(buf), fmt, __VA_ARGS__) < ELEMENTSOF(buf))
369
9d9951a4
HH
370int files_same(const char *filea, const char *fileb);
371
b4f10a5e
LP
372int running_in_chroot(void);
373
72f59706 374char *ellipsize(const char *s, size_t length, unsigned percent);
f405e86d 375 /* bytes columns */
72f59706 376char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
8fe914ec 377
c38dfac9 378int touch_file(const char *path, bool parents, usec_t stamp, uid_t uid, gid_t gid, mode_t mode);
f6144808
LP
379int touch(const char *path);
380
919ce0b7 381noreturn void freeze(void);
3c14d26c 382
44a6b1b6 383bool null_or_empty(struct stat *st) _pure_;
83096483 384int null_or_empty_path(const char *fn);
ed88bcfb 385int null_or_empty_fd(int fd);
00dc5d76 386
a247755d 387DIR *xopendirat(int dirfd, const char *name, int flags);
3b63d2d3 388
e23a0ce8
LP
389char *fstab_node_to_udev_node(const char *p);
390
e801700e 391void execute_directories(const char* const* directories, usec_t timeout, char *argv[]);
83cc030f 392
05feefe0
LP
393bool nulstr_contains(const char*nulstr, const char *needle);
394
a88c8750
TG
395bool plymouth_running(void);
396
9beb3f4d
LP
397char* strshorten(char *s, size_t l);
398
875e1014 399int symlink_idempotent(const char *from, const char *to);
6ea832a2 400
424a19f8 401int symlink_atomic(const char *from, const char *to);
1554afae
LP
402int mknod_atomic(const char *path, mode_t mode, dev_t dev);
403int mkfifo_atomic(const char *path, mode_t mode);
34ca941c
LP
404
405int fchmod_umask(int fd, mode_t mode);
406
44a6b1b6 407bool display_is_local(const char *display) _pure_;
4d6d6518
LP
408int socket_from_display(const char *display, char **path);
409
d05c5031 410int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
4b67834e 411int get_group_creds(const char **groupname, gid_t *gid);
1cccf435 412
4468addc 413int in_gid(gid_t gid);
43673799
LP
414int in_group(const char *name);
415
59164be4 416char* uid_to_name(uid_t uid);
4468addc 417char* gid_to_name(gid_t gid);
59164be4 418
8092a428 419int glob_exists(const char *path);
8d98da3f 420int glob_extend(char ***strv, const char *path);
8092a428 421
83096483
LP
422int dirent_ensure_type(DIR *d, struct dirent *de);
423
034a2a52 424int get_files_in_directory(const char *path, char ***list);
83096483 425
b7def684 426char *strjoin(const char *x, ...) _sentinel_;
911a4828 427
b636465b
LP
428bool is_main_thread(void);
429
01f83c1c
JT
430static inline bool _pure_ in_charset(const char *s, const char* charset) {
431 assert(s);
432 assert(charset);
433 return s[strspn(s, charset)] == '\0';
434}
ab1f0633 435
94959f0f
LP
436int block_get_whole_disk(dev_t d, dev_t *ret);
437
e23a0ce8 438#define NULSTR_FOREACH(i, l) \
c4e2ceae
LP
439 for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
440
5c0532d1
LP
441#define NULSTR_FOREACH_PAIR(i, j, l) \
442 for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
443
f8b69d1d 444int ioprio_class_to_string_alloc(int i, char **s);
1dccbe19
LP
445int ioprio_class_from_string(const char *s);
446
44a6b1b6
ZJS
447const char *sigchld_code_to_string(int i) _const_;
448int sigchld_code_from_string(const char *s) _pure_;
1dccbe19 449
f8b69d1d 450int log_facility_unshifted_to_string_alloc(int i, char **s);
7d76f312 451int log_facility_unshifted_from_string(const char *s);
1dccbe19 452
f8b69d1d 453int log_level_to_string_alloc(int i, char **s);
1dccbe19
LP
454int log_level_from_string(const char *s);
455
f8b69d1d 456int sched_policy_to_string_alloc(int i, char **s);
1dccbe19
LP
457int sched_policy_from_string(const char *s);
458
44a6b1b6
ZJS
459const char *rlimit_to_string(int i) _const_;
460int rlimit_from_string(const char *s) _pure_;
1dccbe19 461
f8b69d1d 462int ip_tos_to_string_alloc(int i, char **s);
4fd5948e
LP
463int ip_tos_from_string(const char *s);
464
9a0e6896
LP
465extern int saved_argc;
466extern char **saved_argv;
467
65457142
FC
468bool kexec_loaded(void);
469
44a6b1b6 470int prot_from_flags(int flags) _const_;
87d2c1ff 471
babfc091
LP
472char *format_bytes(char *buf, size_t l, off_t t);
473
8f2d43a0 474int fd_wait_for_event(int fd, int event, usec_t timeout);
df50185b 475
750ef272 476void* memdup(const void *p, size_t l) _alloc_(2);
55d7bfc1 477
bb99a35a
LP
478int fd_inc_sndbuf(int fd, size_t n);
479int fd_inc_rcvbuf(int fd, size_t n);
6bb92a16 480
9bdc770c 481int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
6bb92a16 482
68faf98c
LP
483int setrlimit_closest(int resource, const struct rlimit *rlim);
484
a2e03378
LP
485bool http_url_is_valid(const char *url) _pure_;
486bool documentation_url_is_valid(const char *url) _pure_;
49dbfa7b 487
3d7415f4
LP
488bool http_etag_is_valid(const char *etag);
489
9be346c9 490bool in_initrd(void);
069cfc85 491
7c5f152a 492int get_home_dir(char **ret);
2cfbd749 493int get_shell(char **_ret);
2fbe635a 494
a740c14c
MS
495static inline void freep(void *p) {
496 free(*(void**) p);
497}
498
dfb33a97 499static inline void closep(int *fd) {
03e334a1 500 safe_close(*fd);
dfb33a97
LP
501}
502
dfb33a97
LP
503static inline void umaskp(mode_t *u) {
504 umask(*u);
763c7aa2
ZJS
505}
506
3d94f76c
LP
507static inline void close_pairp(int (*p)[2]) {
508 safe_close_pair(*p);
04d39279
LP
509}
510
14bf2c9d
LP
511DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, fclose);
512DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, pclose);
513DEFINE_TRIVIAL_CLEANUP_FUNC(DIR*, closedir);
514DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, endmntent);
5862d652 515
dfb33a97 516#define _cleanup_free_ _cleanup_(freep)
dfb33a97 517#define _cleanup_close_ _cleanup_(closep)
dfb33a97
LP
518#define _cleanup_umask_ _cleanup_(umaskp)
519#define _cleanup_globfree_ _cleanup_(globfree)
1ca208fb
ZJS
520#define _cleanup_fclose_ _cleanup_(fclosep)
521#define _cleanup_pclose_ _cleanup_(pclosep)
522#define _cleanup_closedir_ _cleanup_(closedirp)
5862d652 523#define _cleanup_endmntent_ _cleanup_(endmntentp)
3d94f76c 524#define _cleanup_close_pair_ _cleanup_(close_pairp)
c84a9488 525
750ef272 526_malloc_ _alloc_(1, 2) static inline void *malloc_multiply(size_t a, size_t b) {
368504f4 527 if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
4b8772bf
LP
528 return NULL;
529
530 return malloc(a * b);
531}
532
9489490a
DH
533_alloc_(2, 3) static inline void *realloc_multiply(void *p, size_t a, size_t b) {
534 if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
535 return NULL;
536
537 return realloc(p, a * b);
538}
539
750ef272 540_alloc_(2, 3) static inline void *memdup_multiply(const void *p, size_t a, size_t b) {
368504f4 541 if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
4b8772bf
LP
542 return NULL;
543
544 return memdup(p, a * b);
545}
0b507b17 546
ae6c3cc0 547bool filename_is_valid(const char *p) _pure_;
44a6b1b6
ZJS
548bool path_is_safe(const char *p) _pure_;
549bool string_is_safe(const char *p) _pure_;
6294aa76 550bool string_has_cc(const char *p, const char *ok) _pure_;
cfbc22ab 551
e3e0314b
ZJS
552/**
553 * Check if a string contains any glob patterns.
554 */
555_pure_ static inline bool string_is_glob(const char *p) {
556 return !!strpbrk(p, GLOB_CHARS);
557}
558
a9e12476
KS
559void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
560 int (*compar) (const void *, const void *, void *),
561 void *arg);
09017585 562
20f56fdd
DR
563#define _(String) gettext (String)
564void init_gettext(void);
09017585 565bool is_locale_utf8(void);
c339d977
MS
566
567typedef enum DrawSpecialChar {
6b01f1d3 568 DRAW_TREE_VERTICAL,
45a5ff0d
MS
569 DRAW_TREE_BRANCH,
570 DRAW_TREE_RIGHT,
55c0b89c 571 DRAW_TREE_SPACE,
c339d977 572 DRAW_TRIANGULAR_BULLET,
3deadb91 573 DRAW_BLACK_CIRCLE,
6b01f1d3 574 DRAW_ARROW,
13f8b8cb 575 DRAW_DASH,
c339d977
MS
576 _DRAW_SPECIAL_CHAR_MAX
577} DrawSpecialChar;
6b01f1d3 578
c339d977 579const char *draw_special_char(DrawSpecialChar ch);
409bc9c3
LP
580
581char *strreplace(const char *text, const char *old_string, const char *new_string);
e8bc0ea2
LP
582
583char *strip_tab_ansi(char **p, size_t *l);
240dbaa4
LP
584
585int on_ac_power(void);
f74e605f 586
4cf7ea55
MM
587int search_and_fopen(const char *path, const char *mode, const char *root, const char **search, FILE **_f);
588int search_and_fopen_nulstr(const char *path, const char *mode, const char *root, const char *search, FILE **_f);
fabe5c0e 589
9db11a99
LP
590#define FOREACH_LINE(line, f, on_error) \
591 for (;;) \
f74e605f
LP
592 if (!fgets(line, sizeof(line), f)) { \
593 if (ferror(f)) { \
594 on_error; \
595 } \
596 break; \
597 } else
9db11a99
LP
598
599#define FOREACH_DIRENT(de, d, on_error) \
600 for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \
601 if (!de) { \
8333c77e 602 if (errno > 0) { \
9db11a99
LP
603 on_error; \
604 } \
605 break; \
a34bf9db 606 } else if (hidden_file((de)->d_name)) \
9db11a99
LP
607 continue; \
608 else
cd61c3bf
LP
609
610#define FOREACH_DIRENT_ALL(de, d, on_error) \
611 for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \
612 if (!de) { \
613 if (errno > 0) { \
614 on_error; \
615 } \
616 break; \
617 } else
6282c859
MS
618
619static inline void *mempset(void *s, int c, size_t n) {
620 memset(s, c, n);
dfb33a97 621 return (uint8_t*)s + n;
6282c859 622}
66e35261
LP
623
624char *hexmem(const void *p, size_t l);
30494563 625int unhexmem(const char *p, size_t l, void **mem, size_t *len);
2181a7f5 626
919a7f5f
TG
627char *base32hexmem(const void *p, size_t l, bool padding);
628int unbase32hexmem(const char *p, size_t l, bool padding, void **mem, size_t *len);
629
13a5d76b
TG
630char *base64mem(const void *p, size_t l);
631int unbase64mem(const char *p, size_t l, void **mem, size_t *len);
632
a432cb69 633char *strextend(char **x, ...) _sentinel_;
9a17484d 634char *strrep(const char *s, unsigned n);
392d5b37 635
ca2d3784
ZJS
636void* greedy_realloc(void **p, size_t *allocated, size_t need, size_t size);
637void* greedy_realloc0(void **p, size_t *allocated, size_t need, size_t size);
638#define GREEDY_REALLOC(array, allocated, need) \
639 greedy_realloc((void**) &(array), &(allocated), (need), sizeof((array)[0]))
640
641#define GREEDY_REALLOC0(array, allocated, need) \
642 greedy_realloc0((void**) &(array), &(allocated), (need), sizeof((array)[0]))
a1937e67 643
5c0d398d 644static inline void _reset_errno_(int *saved_errno) {
5c0aa72a
LP
645 errno = *saved_errno;
646}
647
2a371001 648#define PROTECT_ERRNO _cleanup_(_reset_errno_) __attribute__((unused)) int _saved_errno_ = errno
5c0d398d 649
44dd2c6e
DH
650static inline int negative_errno(void) {
651 /* This helper should be used to shut up gcc if you know 'errno' is
652 * negative. Instead of "return -errno;", use "return negative_errno();"
653 * It will suppress bogus gcc warnings in case it assumes 'errno' might
654 * be 0 and thus the caller's error-handling might not be triggered. */
655 assert_return(errno > 0, -EINVAL);
656 return -errno;
657}
658
d6dd604b 659struct _umask_struct_ {
5c0d398d
LP
660 mode_t mask;
661 bool quit;
662};
663
d6dd604b 664static inline void _reset_umask_(struct _umask_struct_ *s) {
5c0d398d
LP
665 umask(s->mask);
666};
667
668#define RUN_WITH_UMASK(mask) \
d6dd604b 669 for (_cleanup_(_reset_umask_) struct _umask_struct_ _saved_umask_ = { umask(mask), false }; \
5c0d398d
LP
670 !_saved_umask_.quit ; \
671 _saved_umask_.quit = true)
144e51ec
CR
672
673static inline unsigned u64log2(uint64_t n) {
ec417ccc 674#if __SIZEOF_LONG_LONG__ == 8
693eb9a2 675 return (n > 1) ? (unsigned) __builtin_clzll(n) ^ 63U : 0;
ec417ccc
LP
676#else
677#error "Wut?"
678#endif
679}
680
681static inline unsigned u32ctz(uint32_t n) {
682#if __SIZEOF_INT__ == 4
683 return __builtin_ctz(n);
684#else
685#error "Wut?"
686#endif
144e51ec 687}
79d860fe 688
7d328b54 689static inline unsigned log2i(int x) {
8fe90522
ZJS
690 assert(x > 0);
691
692 return __SIZEOF_INT__ * 8 - __builtin_clz(x) - 1;
693}
694
b5de6d98
MS
695static inline unsigned log2u(unsigned x) {
696 assert(x > 0);
697
698 return sizeof(unsigned) * 8 - __builtin_clz(x) - 1;
699}
700
701static inline unsigned log2u_round_up(unsigned x) {
702 assert(x > 0);
703
704 if (x == 1)
705 return 0;
706
707 return log2u(x - 1) + 1;
708}
709
79d860fe
MP
710static inline bool logind_running(void) {
711 return access("/run/systemd/seats/", F_OK) >= 0;
712}
4b73a0c0 713
82da66fb
LP
714#define DECIMAL_STR_WIDTH(x) \
715 ({ \
716 typeof(x) _x_ = (x); \
717 unsigned ans = 1; \
718 while (_x_ /= 10) \
719 ans++; \
720 ans; \
721 })
75add28a 722
4b73a0c0 723int unlink_noerrno(const char *path);
ed5c5dbd 724
82da66fb
LP
725#define alloca0(n) \
726 ({ \
727 char *_new_; \
728 size_t _len_ = n; \
729 _new_ = alloca(_len_); \
730 (void *) memset(_new_, 0, _len_); \
ed5c5dbd 731 })
95d78c7e 732
257224b0 733/* It's not clear what alignment glibc/gcc alloca() guarantee, hence provide a guaranteed safe version */
95d78c7e
DH
734#define alloca_align(size, align) \
735 ({ \
736 void *_ptr_; \
737 size_t _mask_ = (align) - 1; \
738 _ptr_ = alloca((size) + _mask_); \
739 (void*)(((uintptr_t)_ptr_ + _mask_) & ~_mask_); \
740 })
741
742#define alloca0_align(size, align) \
743 ({ \
744 void *_new_; \
745 size_t _size_ = (size); \
746 _new_ = alloca_align(_size_, (align)); \
747 (void*)memset(_new_, 0, _size_); \
748 })
66060897 749
63c372cb
LP
750#define strjoina(a, ...) \
751 ({ \
752 const char *_appendees_[] = { a, __VA_ARGS__ }; \
753 char *_d_, *_p_; \
754 int _len_ = 0; \
755 unsigned _i_; \
756 for (_i_ = 0; _i_ < ELEMENTSOF(_appendees_) && _appendees_[_i_]; _i_++) \
757 _len_ += strlen(_appendees_[_i_]); \
758 _p_ = _d_ = alloca(_len_ + 1); \
759 for (_i_ = 0; _i_ < ELEMENTSOF(_appendees_) && _appendees_[_i_]; _i_++) \
760 _p_ = stpcpy(_p_, _appendees_[_i_]); \
761 *_p_ = 0; \
762 _d_; \
f39d4a08
HH
763 })
764
44a6b1b6 765bool id128_is_valid(const char *s) _pure_;
d4ac85c6
LP
766
767int split_pair(const char *s, const char *sep, char **l, char **r);
7ff7394d 768
74df0fca 769int shall_restore_state(void);
295edddf 770
7ff7394d
ZJS
771/**
772 * Normal qsort requires base to be nonnull. Here were require
773 * that only if nmemb > 0.
774 */
aeb24f30 775static inline void qsort_safe(void *base, size_t nmemb, size_t size, comparison_fn_t compar) {
1dbd13d8 776 if (nmemb <= 1)
aeb24f30
LP
777 return;
778
779 assert(base);
780 qsort(base, nmemb, size, compar);
7ff7394d 781}
74df0fca 782
6e6c21c8
LP
783/* Normal memmem() requires haystack to be nonnull, which is annoying for zero-length buffers */
784static inline void *memmem_safe(const void *haystack, size_t haystacklen, const void *needle, size_t needlelen) {
785
786 if (needlelen <= 0)
787 return (void*) haystack;
788
789 if (haystacklen < needlelen)
790 return NULL;
791
792 assert(haystack);
793 assert(needle);
794
795 return memmem(haystack, haystacklen, needle, needlelen);
796}
797
74df0fca 798int proc_cmdline(char **ret);
059cb385 799int parse_proc_cmdline(int (*parse_word)(const char *key, const char *value));
1a299299 800int get_proc_cmdline_key(const char *parameter, char **value);
bc9fd78c
LP
801
802int container_get_leader(const char *machine, pid_t *pid);
803
671c3419
RM
804int namespace_open(pid_t pid, int *pidns_fd, int *mntns_fd, int *netns_fd, int *userns_fd, int *root_fd);
805int namespace_enter(int pidns_fd, int mntns_fd, int netns_fd, int userns_fd, int root_fd);
bf108e55 806
eff05270
LP
807int getpeercred(int fd, struct ucred *ucred);
808int getpeersec(int fd, char **ret);
8e33886e 809
65b3903f
ZJS
810int writev_safe(int fd, const struct iovec *w, int j);
811
812int mkostemp_safe(char *pattern, int flags);
8e33886e 813int open_tmpfile(const char *path, int flags);
fdb9161c
LP
814
815int fd_warn_permissions(const char *path, int fd);
6afc95b7 816
050f7277
LP
817#ifndef PERSONALITY_INVALID
818/* personality(7) documents that 0xffffffffUL is used for querying the
819 * current personality, hence let's use that here as error
820 * indicator. */
821#define PERSONALITY_INVALID 0xffffffffLU
822#endif
823
ac45f971
LP
824unsigned long personality_from_string(const char *p);
825const char *personality_to_string(unsigned long);
1c231f56
LP
826
827uint64_t physical_memory(void);
6db615c1 828
29bfbcd6 829void hexdump(FILE *f, const void *p, size_t s);
370c860f
DR
830
831union file_handle_union {
c5220a94
MO
832 struct file_handle handle;
833 char padding[sizeof(struct file_handle) + MAX_HANDLE_SZ];
370c860f 834};
2695c5c4 835#define FILE_HANDLE_INIT { .handle.handle_bytes = MAX_HANDLE_SZ }
c5220a94
MO
836
837int update_reboot_param_file(const char *param);
6d313367
LP
838
839int umount_recursive(const char *target, int flags);
d6797c92
LP
840
841int bind_remount_recursive(const char *prefix, bool ro);
1b992147
LP
842
843int fflush_and_check(FILE *f);
2e78fa79 844
14bcf25c
LP
845int tempfn_xxxxxx(const char *p, const char *extra, char **ret);
846int tempfn_random(const char *p, const char *extra, char **ret);
847int tempfn_random_child(const char *p, const char *extra, char **ret);
fecc80c1 848
45035609 849int take_password_lock(const char *root);
5261ba90 850
7629889c 851int is_symlink(const char *path);
be57e297 852int is_dir(const char *path, bool follow);
ce5b3ad4 853int is_device_node(const char *path);
7629889c 854
68685607
RM
855typedef enum ExtractFlags {
856 EXTRACT_RELAX = 1,
857 EXTRACT_CUNESCAPE = 2,
858 EXTRACT_CUNESCAPE_RELAX = 4,
12ba2c44 859 EXTRACT_QUOTES = 8,
206644ae 860 EXTRACT_DONT_COALESCE_SEPARATORS = 16,
68685607
RM
861} ExtractFlags;
862
863int extract_first_word(const char **p, char **ret, const char *separators, ExtractFlags flags);
864int extract_first_word_and_warn(const char **p, char **ret, const char *separators, ExtractFlags flags, const char *unit, const char *filename, unsigned line, const char *rvalue);
865int extract_many_words(const char **p, const char *separators, ExtractFlags flags, ...) _sentinel_;
2928b0a8 866
8fb49443
ZJS
867static inline void free_and_replace(char **s, char *v) {
868 free(*s);
869 *s = v;
870}
871
2928b0a8 872int free_and_strdup(char **p, const char *s);
605f81a8 873
f7c1ad4f
LP
874#define INOTIFY_EVENT_MAX (sizeof(struct inotify_event) + NAME_MAX + 1)
875
876#define FOREACH_INOTIFY_EVENT(e, buffer, sz) \
0254e944
SL
877 for ((e) = &buffer.ev; \
878 (uint8_t*) (e) < (uint8_t*) (buffer.raw) + (sz); \
f7c1ad4f 879 (e) = (struct inotify_event*) ((uint8_t*) (e) + sizeof(struct inotify_event) + (e)->len))
72648326 880
0254e944
SL
881union inotify_event_buffer {
882 struct inotify_event ev;
883 uint8_t raw[INOTIFY_EVENT_MAX];
884};
885
72648326 886#define laccess(path, mode) faccessat(AT_FDCWD, (path), (mode), AT_SYMLINK_NOFOLLOW)
ee451d76
LP
887
888int ptsname_malloc(int fd, char **ret);
5f8cc96a
LP
889
890int openpt_in_namespace(pid_t pid, int flags);
4a4d89b6 891
10f9c755
LP
892ssize_t fgetxattrat_fake(int dirfd, const char *filename, const char *attribute, void *value, size_t size, int flags);
893
4a4d89b6
LP
894int fd_setcrtime(int fd, usec_t usec);
895int fd_getcrtime(int fd, usec_t *usec);
896int path_getcrtime(const char *p, usec_t *usec);
10f9c755 897int fd_getcrtime_at(int dirfd, const char *name, usec_t *usec, int flags);
a354329f
LP
898
899int same_fd(int a, int b);
11689d2a 900
1ed8f8c1
LP
901int chattr_fd(int fd, unsigned value, unsigned mask);
902int chattr_path(const char *p, unsigned value, unsigned mask);
de45d726 903
01b72568
LP
904int read_attr_fd(int fd, unsigned *ret);
905int read_attr_path(const char *p, unsigned *ret);
906
de45d726 907#define RLIMIT_MAKE_CONST(lim) ((struct rlimit) { lim, lim })
ff6a7460
LP
908
909ssize_t sparse_write(int fd, const void *p, size_t sz, size_t run_length);
3576d631
LP
910
911void sigkill_wait(pid_t *pid);
912#define _cleanup_sigkill_wait_ _cleanup_(sigkill_wait)
3d7415f4
LP
913
914int syslog_parse_priority(const char **p, int *priority, bool with_facility);
1c8da044
LP
915
916void cmsg_close_all(struct msghdr *mh);
f85ef957
AC
917
918int rename_noreplace(int olddirfd, const char *oldpath, int newdirfd, const char *newpath);
019c7fba 919
61ee6939 920char *shell_escape(const char *s, const char *bad);
019c7fba 921char *shell_maybe_quote(const char *s);
2ff7b0a5
LP
922
923int parse_mode(const char *s, mode_t *ret);
6458ec20
LP
924
925int mount_move_root(const char *path);
b4da6d6b
LP
926
927int reset_uid_gid(void);
7b9c9ab8
WC
928
929int getxattr_malloc(const char *path, const char *name, char **value, bool allow_symlink);
930int fgetxattr_malloc(int fd, const char *name, char **value);