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