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