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