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