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