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