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