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