chiark / gitweb /
journal: downgrade comments about sd_journal_print_with_location()
[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
44 #include "macro.h"
45 #include "time-util.h"
46
47 union dirent_storage {
48         struct dirent de;
49         uint8_t storage[offsetof(struct dirent, d_name) +
50                         ((NAME_MAX + 1 + sizeof(long)) & ~(sizeof(long) - 1))];
51 };
52
53 /* What is interpreted as whitespace? */
54 #define WHITESPACE " \t\n\r"
55 #define NEWLINE "\n\r"
56 #define QUOTES "\"\'"
57 #define COMMENTS "#;"
58
59 #define FORMAT_BYTES_MAX 8
60
61 #define ANSI_HIGHLIGHT_ON "\x1B[1;39m"
62 #define ANSI_RED_ON "\x1B[31m"
63 #define ANSI_HIGHLIGHT_RED_ON "\x1B[1;31m"
64 #define ANSI_GREEN_ON "\x1B[32m"
65 #define ANSI_HIGHLIGHT_GREEN_ON "\x1B[1;32m"
66 #define ANSI_HIGHLIGHT_YELLOW_ON "\x1B[1;33m"
67 #define ANSI_HIGHLIGHT_OFF "\x1B[0m"
68 #define ANSI_ERASE_TO_END_OF_LINE "\x1B[K"
69
70 size_t page_size(void);
71 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
72
73 #define streq(a,b) (strcmp((a),(b)) == 0)
74 #define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
75 #define strcaseeq(a,b) (strcasecmp((a),(b)) == 0)
76 #define strncaseeq(a, b, n) (strncasecmp((a), (b), (n)) == 0)
77
78 bool streq_ptr(const char *a, const char *b) _pure_;
79
80 #define new(t, n) ((t*) malloc_multiply(sizeof(t), (n)))
81
82 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
83
84 #define newa(t, n) ((t*) alloca(sizeof(t)*(n)))
85
86 #define newdup(t, p, n) ((t*) memdup_multiply(p, sizeof(t), (n)))
87
88 #define malloc0(n) (calloc((n), 1))
89
90 static inline const char* yes_no(bool b) {
91         return b ? "yes" : "no";
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 unsigned long long random_ull(void);
254 unsigned random_u(void);
255
256 /* For basic lookup tables with strictly enumerated entries */
257 #define __DEFINE_STRING_TABLE_LOOKUP(name,type,scope)                   \
258         scope const char *name##_to_string(type i) {                    \
259                 if (i < 0 || i >= (type) ELEMENTSOF(name##_table))      \
260                         return NULL;                                    \
261                 return name##_table[i];                                 \
262         }                                                               \
263         scope type name##_from_string(const char *s) {                  \
264                 type i;                                                 \
265                 assert(s);                                              \
266                 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++)    \
267                         if (name##_table[i] &&                          \
268                             streq(name##_table[i], s))                  \
269                                 return i;                               \
270                 return (type) -1;                                       \
271         }                                                               \
272         struct __useless_struct_to_allow_trailing_semicolon__
273
274 #define DEFINE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,)
275 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,static)
276
277 /* For string conversions where numbers are also acceptable */
278 #define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max)         \
279         int name##_to_string_alloc(type i, char **str) {                \
280                 char *s;                                                \
281                 int r;                                                  \
282                 if (i < 0 || i > max)                                   \
283                         return -ERANGE;                                 \
284                 if (i < (type) ELEMENTSOF(name##_table)) {              \
285                         s = strdup(name##_table[i]);                    \
286                         if (!s)                                         \
287                                 return log_oom();                       \
288                 } else {                                                \
289                         r = asprintf(&s, "%u", i);                      \
290                         if (r < 0)                                      \
291                                 return log_oom();                       \
292                 }                                                       \
293                 *str = s;                                               \
294                 return 0;                                               \
295         }                                                               \
296         type name##_from_string(const char *s) {                        \
297                 type i;                                                 \
298                 unsigned u = 0;                                         \
299                 assert(s);                                              \
300                 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++)    \
301                         if (name##_table[i] &&                          \
302                             streq(name##_table[i], s))                  \
303                                 return i;                               \
304                 if (safe_atou(s, &u) >= 0 && u <= max)                  \
305                         return (type) u;                                \
306                 return (type) -1;                                       \
307         }                                                               \
308         struct __useless_struct_to_allow_trailing_semicolon__
309
310 int fd_nonblock(int fd, bool nonblock);
311 int fd_cloexec(int fd, bool cloexec);
312
313 int close_all_fds(const int except[], unsigned n_except);
314
315 bool fstype_is_network(const char *fstype);
316
317 int chvt(int vt);
318
319 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
320 int ask(char *ret, const char *replies, const char *text, ...) _printf_(3, 4);
321
322 int reset_terminal_fd(int fd, bool switch_to_text);
323 int reset_terminal(const char *name);
324
325 int open_terminal(const char *name, int mode);
326 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
327 int release_terminal(void);
328
329 int flush_fd(int fd);
330
331 int ignore_signals(int sig, ...);
332 int default_signals(int sig, ...);
333 int sigaction_many(const struct sigaction *sa, ...);
334
335 int close_pipe(int p[]);
336 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
337
338 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
339 ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
340
341 bool is_device_path(const char *path);
342
343 int dir_is_empty(const char *path);
344 char* dirname_malloc(const char *path);
345
346 void rename_process(const char name[8]);
347
348 void sigset_add_many(sigset_t *ss, ...);
349
350 bool hostname_is_set(void);
351
352 char* gethostname_malloc(void);
353 char* getlogname_malloc(void);
354 char* getusername_malloc(void);
355
356 int getttyname_malloc(int fd, char **r);
357 int getttyname_harder(int fd, char **r);
358
359 int get_ctty_devnr(pid_t pid, dev_t *d);
360 int get_ctty(pid_t, dev_t *_devnr, char **r);
361
362 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
363 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
364
365 int rm_rf_children(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
366 int rm_rf_children_dangerous(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
367 int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
368 int rm_rf_dangerous(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
369
370 int pipe_eof(int fd);
371
372 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
373
374 int status_vprintf(const char *status, bool ellipse, bool ephemeral, const char *format, va_list ap) _printf_(4,0);
375 int status_printf(const char *status, bool ellipse, bool ephemeral, const char *format, ...) _printf_(4,5);
376 int status_welcome(void);
377
378 int fd_columns(int fd);
379 unsigned columns(void);
380 int fd_lines(int fd);
381 unsigned lines(void);
382 void columns_lines_cache_reset(int _unused_ signum);
383
384 bool on_tty(void);
385
386 static inline const char *ansi_highlight(void) {
387         return on_tty() ? ANSI_HIGHLIGHT_ON : "";
388 }
389
390 static inline const char *ansi_highlight_red(void) {
391         return on_tty() ? ANSI_HIGHLIGHT_RED_ON : "";
392 }
393
394 static inline const char *ansi_highlight_green(void) {
395         return on_tty() ? ANSI_HIGHLIGHT_GREEN_ON : "";
396 }
397
398 static inline const char *ansi_highlight_yellow(void) {
399         return on_tty() ? ANSI_HIGHLIGHT_YELLOW_ON : "";
400 }
401
402 static inline const char *ansi_highlight_off(void) {
403         return on_tty() ? ANSI_HIGHLIGHT_OFF : "";
404 }
405
406 int running_in_chroot(void);
407
408 char *ellipsize(const char *s, size_t length, unsigned percent);
409                                    /* bytes                 columns */
410 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
411
412 int touch(const char *path);
413
414 char *unquote(const char *s, const char *quotes);
415 char *normalize_env_assignment(const char *s);
416
417 int wait_for_terminate(pid_t pid, siginfo_t *status);
418 int wait_for_terminate_and_warn(const char *name, pid_t pid);
419
420 _noreturn_ void freeze(void);
421
422 bool null_or_empty(struct stat *st) _pure_;
423 int null_or_empty_path(const char *fn);
424
425 DIR *xopendirat(int dirfd, const char *name, int flags);
426
427 char *fstab_node_to_udev_node(const char *p);
428
429 char *resolve_dev_console(char **active);
430 bool tty_is_vc(const char *tty);
431 bool tty_is_vc_resolve(const char *tty);
432 bool tty_is_console(const char *tty) _pure_;
433 int vtnr_from_tty(const char *tty);
434 const char *default_term_for_tty(const char *tty);
435
436 void execute_directory(const char *directory, DIR *_d, char *argv[]);
437
438 int kill_and_sigcont(pid_t pid, int sig);
439
440 bool nulstr_contains(const char*nulstr, const char *needle);
441
442 bool plymouth_running(void);
443
444 bool hostname_is_valid(const char *s) _pure_;
445 char* hostname_cleanup(char *s, bool lowercase);
446
447 char* strshorten(char *s, size_t l);
448
449 int terminal_vhangup_fd(int fd);
450 int terminal_vhangup(const char *name);
451
452 int vt_disallocate(const char *name);
453
454 int copy_file(const char *from, const char *to, int flags);
455
456 int symlink_atomic(const char *from, const char *to);
457
458 int fchmod_umask(int fd, mode_t mode);
459
460 bool display_is_local(const char *display) _pure_;
461 int socket_from_display(const char *display, char **path);
462
463 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
464 int get_group_creds(const char **groupname, gid_t *gid);
465
466 int in_gid(gid_t gid);
467 int in_group(const char *name);
468
469 char* uid_to_name(uid_t uid);
470 char* gid_to_name(gid_t gid);
471
472 int glob_exists(const char *path);
473 int glob_extend(char ***strv, const char *path);
474
475 int dirent_ensure_type(DIR *d, struct dirent *de);
476
477 int in_search_path(const char *path, char **search);
478 int get_files_in_directory(const char *path, char ***list);
479
480 char *strjoin(const char *x, ...) _sentinel_;
481
482 bool is_main_thread(void);
483
484 bool in_charset(const char *s, const char* charset) _pure_;
485
486 int block_get_whole_disk(dev_t d, dev_t *ret);
487
488 int file_is_priv_sticky(const char *p);
489
490 int strdup_or_null(const char *a, char **b);
491
492 #define NULSTR_FOREACH(i, l)                                    \
493         for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
494
495 #define NULSTR_FOREACH_PAIR(i, j, l)                             \
496         for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
497
498 int ioprio_class_to_string_alloc(int i, char **s);
499 int ioprio_class_from_string(const char *s);
500
501 const char *sigchld_code_to_string(int i) _const_;
502 int sigchld_code_from_string(const char *s) _pure_;
503
504 int log_facility_unshifted_to_string_alloc(int i, char **s);
505 int log_facility_unshifted_from_string(const char *s);
506
507 int log_level_to_string_alloc(int i, char **s);
508 int log_level_from_string(const char *s);
509
510 int sched_policy_to_string_alloc(int i, char **s);
511 int sched_policy_from_string(const char *s);
512
513 const char *rlimit_to_string(int i) _const_;
514 int rlimit_from_string(const char *s) _pure_;
515
516 int ip_tos_to_string_alloc(int i, char **s);
517 int ip_tos_from_string(const char *s);
518
519 const char *signal_to_string(int i) _const_;
520 int signal_from_string(const char *s) _pure_;
521
522 int signal_from_string_try_harder(const char *s);
523
524 extern int saved_argc;
525 extern char **saved_argv;
526
527 bool kexec_loaded(void);
528
529 int prot_from_flags(int flags) _const_;
530
531 char *format_bytes(char *buf, size_t l, off_t t);
532
533 int fd_wait_for_event(int fd, int event, usec_t timeout);
534
535 void* memdup(const void *p, size_t l) _alloc_(2);
536
537 int is_kernel_thread(pid_t pid);
538
539 int fd_inc_sndbuf(int fd, size_t n);
540 int fd_inc_rcvbuf(int fd, size_t n);
541
542 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
543
544 int setrlimit_closest(int resource, const struct rlimit *rlim);
545
546 int getenv_for_pid(pid_t pid, const char *field, char **_value);
547
548 bool is_valid_documentation_url(const char *url) _pure_;
549
550 bool in_initrd(void);
551
552 void warn_melody(void);
553
554 int get_home_dir(char **ret);
555
556 static inline void freep(void *p) {
557         free(*(void**) p);
558 }
559
560 #define DEFINE_TRIVIAL_CLEANUP_FUNC(type, func)                 \
561         static inline void func##p(type *p) {                   \
562                 if (*p)                                         \
563                         func(*p);                               \
564         }                                                       \
565         struct __useless_struct_to_allow_trailing_semicolon__
566
567 static inline void closep(int *fd) {
568         if (*fd >= 0)
569                 close_nointr_nofail(*fd);
570 }
571
572 static inline void umaskp(mode_t *u) {
573         umask(*u);
574 }
575
576 static inline void close_pipep(int (*p)[2]) {
577         close_pipe(*p);
578 }
579
580 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, fclose);
581 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, pclose);
582 DEFINE_TRIVIAL_CLEANUP_FUNC(DIR*, closedir);
583 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, endmntent);
584
585 #define _cleanup_free_ _cleanup_(freep)
586 #define _cleanup_close_ _cleanup_(closep)
587 #define _cleanup_umask_ _cleanup_(umaskp)
588 #define _cleanup_globfree_ _cleanup_(globfree)
589 #define _cleanup_fclose_ _cleanup_(fclosep)
590 #define _cleanup_pclose_ _cleanup_(pclosep)
591 #define _cleanup_closedir_ _cleanup_(closedirp)
592 #define _cleanup_endmntent_ _cleanup_(endmntentp)
593 #define _cleanup_close_pipe_ _cleanup_(close_pipep)
594
595 _malloc_  _alloc_(1, 2) static inline void *malloc_multiply(size_t a, size_t b) {
596         if (_unlikely_(b == 0 || a > ((size_t) -1) / b))
597                 return NULL;
598
599         return malloc(a * b);
600 }
601
602 _alloc_(2, 3) static inline void *memdup_multiply(const void *p, size_t a, size_t b) {
603         if (_unlikely_(b == 0 || a > ((size_t) -1) / b))
604                 return NULL;
605
606         return memdup(p, a * b);
607 }
608
609 bool filename_is_safe(const char *p) _pure_;
610 bool path_is_safe(const char *p) _pure_;
611 bool string_is_safe(const char *p) _pure_;
612 bool string_has_cc(const char *p) _pure_;
613
614 void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
615                  int (*compar) (const void *, const void *, void *),
616                  void *arg);
617
618 bool is_locale_utf8(void);
619
620 typedef enum DrawSpecialChar {
621         DRAW_TREE_VERT,
622         DRAW_TREE_BRANCH,
623         DRAW_TREE_RIGHT,
624         DRAW_TREE_SPACE,
625         DRAW_TRIANGULAR_BULLET,
626         DRAW_BLACK_CIRCLE,
627         _DRAW_SPECIAL_CHAR_MAX
628 } DrawSpecialChar;
629 const char *draw_special_char(DrawSpecialChar ch);
630
631 char *strreplace(const char *text, const char *old_string, const char *new_string);
632
633 char *strip_tab_ansi(char **p, size_t *l);
634
635 int on_ac_power(void);
636
637 int search_and_fopen(const char *path, const char *mode, const char **search, FILE **_f);
638 int search_and_fopen_nulstr(const char *path, const char *mode, const char *search, FILE **_f);
639
640 #define FOREACH_LINE(line, f, on_error)                         \
641         for (;;)                                                \
642                 if (!fgets(line, sizeof(line), f)) {            \
643                         if (ferror(f)) {                        \
644                                 on_error;                       \
645                         }                                       \
646                         break;                                  \
647                 } else
648
649 #define FOREACH_DIRENT(de, d, on_error)                                 \
650         for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d))   \
651                 if (!de) {                                              \
652                         if (errno > 0) {                                \
653                                 on_error;                               \
654                         }                                               \
655                         break;                                          \
656                 } else if (ignore_file((de)->d_name))                   \
657                         continue;                                       \
658                 else
659
660 static inline void *mempset(void *s, int c, size_t n) {
661         memset(s, c, n);
662         return (uint8_t*)s + n;
663 }
664
665 char *hexmem(const void *p, size_t l);
666 void *unhexmem(const char *p, size_t l);
667
668 char *strextend(char **x, ...) _sentinel_;
669 char *strrep(const char *s, unsigned n);
670
671 void* greedy_realloc(void **p, size_t *allocated, size_t need);
672 void* greedy_realloc0(void **p, size_t *allocated, size_t need);
673 #define GREEDY_REALLOC(array, allocated, need) \
674         greedy_realloc((void**) &(array), &(allocated), sizeof((array)[0]) * (need))
675 #define GREEDY_REALLOC0(array, allocated, need) \
676         greedy_realloc0((void**) &(array), &(allocated), sizeof((array)[0]) * (need))
677
678 static inline void _reset_errno_(int *saved_errno) {
679         errno = *saved_errno;
680 }
681
682 #define PROTECT_ERRNO _cleanup_(_reset_errno_) __attribute__((unused)) int _saved_errno_ = errno
683
684 struct _umask_struct_ {
685         mode_t mask;
686         bool quit;
687 };
688
689 static inline void _reset_umask_(struct _umask_struct_ *s) {
690         umask(s->mask);
691 };
692
693 #define RUN_WITH_UMASK(mask)                                            \
694         for (_cleanup_(_reset_umask_) struct _umask_struct_ _saved_umask_ = { umask(mask), false }; \
695              !_saved_umask_.quit ;                                      \
696              _saved_umask_.quit = true)
697
698 static inline unsigned u64log2(uint64_t n) {
699         return (n > 1) ? __builtin_clzll(n) ^ 63U : 0;
700 }
701
702 static inline bool logind_running(void) {
703         return access("/run/systemd/seats/", F_OK) >= 0;
704 }
705
706 #define DECIMAL_STR_WIDTH(x)                            \
707         ({                                              \
708                 typeof(x) _x_ = (x);                    \
709                 unsigned ans = 1;                       \
710                 while (_x_ /= 10)                       \
711                         ans++;                          \
712                 ans;                                    \
713         })
714
715 int unlink_noerrno(const char *path);
716
717 #define alloca0(n)                                      \
718         ({                                              \
719                 char *_new_;                            \
720                 size_t _len_ = n;                       \
721                 _new_ = alloca(_len_);                  \
722                 (void *) memset(_new_, 0, _len_);       \
723         })
724
725 #define strappenda(a, b)                                \
726         ({                                              \
727                 const char *_a_ = (a), *_b_ = (b);      \
728                 char *_c_;                              \
729                 size_t _x_, _y_;                        \
730                 _x_ = strlen(_a_);                      \
731                 _y_ = strlen(_b_);                      \
732                 _c_ = alloca(_x_ + _y_ + 1);            \
733                 strcpy(stpcpy(_c_, _a_), _b_);          \
734                 _c_;                                    \
735         })
736
737 #define procfs_file_alloca(pid, field)                                  \
738         ({                                                              \
739                 pid_t _pid_ = (pid);                                    \
740                 char *_r_;                                              \
741                 _r_ = alloca(sizeof("/proc/") -1 + DECIMAL_STR_MAX(pid_t) + 1 + sizeof(field)); \
742                 sprintf(_r_, "/proc/%lu/" field, (unsigned long) _pid_); \
743                 _r_;                                                    \
744         })
745
746 struct _locale_struct_ {
747         locale_t saved_locale;
748         locale_t new_locale;
749         bool quit;
750 };
751
752 static inline void _reset_locale_(struct _locale_struct_ *s) {
753         PROTECT_ERRNO;
754         if (s->saved_locale != (locale_t) 0)
755                 uselocale(s->saved_locale);
756         if (s->new_locale != (locale_t) 0)
757                 freelocale(s->new_locale);
758 }
759
760 #define RUN_WITH_LOCALE(mask, loc) \
761         for (_cleanup_(_reset_locale_) struct _locale_struct_ _saved_locale_ = { (locale_t) 0, (locale_t) 0, false }; \
762              ({                                                         \
763                      if (!_saved_locale_.quit) {                        \
764                              PROTECT_ERRNO;                             \
765                              _saved_locale_.new_locale = newlocale((mask), (loc), (locale_t) 0); \
766                              if (_saved_locale_.new_locale != (locale_t) 0)     \
767                                      _saved_locale_.saved_locale = uselocale(_saved_locale_.new_locale); \
768                      }                                                  \
769                      !_saved_locale_.quit; }) ;                         \
770              _saved_locale_.quit = true)
771
772 bool id128_is_valid(const char *s) _pure_;
773 void parse_user_at_host(char *arg, char **user, char **host);
774
775 int split_pair(const char *s, const char *sep, char **l, char **r);
776
777 int shall_restore_state(void);
778
779 /**
780  * Normal qsort requires base to be nonnull. Here were require
781  * that only if nmemb > 0.
782  */
783 static inline void qsort_safe(void *base, size_t nmemb, size_t size,
784                               int (*compar)(const void *, const void *)) {
785         if (nmemb) {
786                 assert(base);
787                 qsort(base, nmemb, size, compar);
788         }
789 }
790
791 int proc_cmdline(char **ret);