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                 assert(s);                                              \
 299                 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++)    \
 300                         if (name##_table[i] &&                          \
 301                             streq(name##_table[i], s))                  \
 302                                 return i;                               \
 303                 return (type) -1;                                       \
 304         }                                                               \
 305         struct __useless_struct_to_allow_trailing_semicolon__
 306
 307 #define DEFINE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,)
 308 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,static)
 309
 310 /* For string conversions where numbers are also acceptable */
 311 #define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max)         \
 312         int name##_to_string_alloc(type i, char **str) {                \
 313                 char *s;                                                \
 314                 int r;                                                  \
 315                 if (i < 0 || i > max)                                   \
 316                         return -ERANGE;                                 \
 317                 if (i < (type) ELEMENTSOF(name##_table)) {              \
 318                         s = strdup(name##_table[i]);                    \
 319                         if (!s)                                         \
 320                                 return log_oom();                       \
 321                 } else {                                                \
 322                         r = asprintf(&s, "%u", i);                      \
 323                         if (r < 0)                                      \
 324                                 return log_oom();                       \
 325                 }                                                       \
 326                 *str = s;                                               \
 327                 return 0;                                               \
 328         }                                                               \
 329         type name##_from_string(const char *s) {                        \
 330                 type i;                                                 \
 331                 unsigned u = 0;                                         \
 332                 assert(s);                                              \
 333                 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++)    \
 334                         if (name##_table[i] &&                          \
 335                             streq(name##_table[i], s))                  \
 336                                 return i;                               \
 337                 if (safe_atou(s, &u) >= 0 && u <= max)                  \
 338                         return (type) u;                                \
 339                 return (type) -1;                                       \
 340         }                                                               \
 341         struct __useless_struct_to_allow_trailing_semicolon__
 342
 343 int fd_nonblock(int fd, bool nonblock);
 344 int fd_cloexec(int fd, bool cloexec);
 345
 346 int close_all_fds(const int except[], unsigned n_except);
 347
 348 bool fstype_is_network(const char *fstype);
 349
 350 int chvt(int vt);
 351
 352 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
 353 int ask(char *ret, const char *replies, const char *text, ...) _printf_(3, 4);
 354
 355 int reset_terminal_fd(int fd, bool switch_to_text);
 356 int reset_terminal(const char *name);
 357
 358 int open_terminal(const char *name, int mode);
 359 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
 360 int release_terminal(void);
 361
 362 int flush_fd(int fd);
 363
 364 int ignore_signals(int sig, ...);
 365 int default_signals(int sig, ...);
 366 int sigaction_many(const struct sigaction *sa, ...);
 367
 368 int close_pipe(int p[]);
 369 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
 370
 371 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
 372 ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
 373
 374 bool is_device_path(const char *path);
 375
 376 int dir_is_empty(const char *path);
 377 char* dirname_malloc(const char *path);
 378
 379 void rename_process(const char name[8]);
 380
 381 void sigset_add_many(sigset_t *ss, ...);
 382
 383 bool hostname_is_set(void);
 384
 385 char* gethostname_malloc(void);
 386 char* getlogname_malloc(void);
 387 char* getusername_malloc(void);
 388
 389 int getttyname_malloc(int fd, char **r);
 390 int getttyname_harder(int fd, char **r);
 391
 392 int get_ctty_devnr(pid_t pid, dev_t *d);
 393 int get_ctty(pid_t, dev_t *_devnr, char **r);
 394
 395 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
 396 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
 397
 398 int rm_rf_children(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
 399 int rm_rf_children_dangerous(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
 400 int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
 401 int rm_rf_dangerous(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
 402
 403 int pipe_eof(int fd);
 404
 405 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
 406
 407 int status_vprintf(const char *status, bool ellipse, bool ephemeral, const char *format, va_list ap) _printf_(4,0);
 408 int status_printf(const char *status, bool ellipse, bool ephemeral, const char *format, ...) _printf_(4,5);
 409 int status_welcome(void);
 410
 411 int fd_columns(int fd);
 412 unsigned columns(void);
 413 int fd_lines(int fd);
 414 unsigned lines(void);
 415 void columns_lines_cache_reset(int _unused_ signum);
 416
 417 bool on_tty(void);
 418
 419 static inline const char *ansi_highlight(void) {
 420         return on_tty() ? ANSI_HIGHLIGHT_ON : "";
 421 }
 422
 423 static inline const char *ansi_highlight_red(void) {
 424         return on_tty() ? ANSI_HIGHLIGHT_RED_ON : "";
 425 }
 426
 427 static inline const char *ansi_highlight_green(void) {
 428         return on_tty() ? ANSI_HIGHLIGHT_GREEN_ON : "";
 429 }
 430
 431 static inline const char *ansi_highlight_yellow(void) {
 432         return on_tty() ? ANSI_HIGHLIGHT_YELLOW_ON : "";
 433 }
 434
 435 static inline const char *ansi_highlight_blue(void) {
 436         return on_tty() ? ANSI_HIGHLIGHT_BLUE_ON : "";
 437 }
 438
 439 static inline const char *ansi_highlight_off(void) {
 440         return on_tty() ? ANSI_HIGHLIGHT_OFF : "";
 441 }
 442
 443 int running_in_chroot(void);
 444
 445 char *ellipsize(const char *s, size_t length, unsigned percent);
 446                                    /* bytes                 columns */
 447 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
 448
 449 int touch(const char *path);
 450
 451 char *unquote(const char *s, const char *quotes);
 452 char *normalize_env_assignment(const char *s);
 453
 454 int wait_for_terminate(pid_t pid, siginfo_t *status);
 455 int wait_for_terminate_and_warn(const char *name, pid_t pid);
 456
 457 noreturn void freeze(void);
 458
 459 bool null_or_empty(struct stat *st) _pure_;
 460 int null_or_empty_path(const char *fn);
 461
 462 DIR *xopendirat(int dirfd, const char *name, int flags);
 463
 464 char *fstab_node_to_udev_node(const char *p);
 465
 466 char *resolve_dev_console(char **active);
 467 bool tty_is_vc(const char *tty);
 468 bool tty_is_vc_resolve(const char *tty);
 469 bool tty_is_console(const char *tty) _pure_;
 470 int vtnr_from_tty(const char *tty);
 471 const char *default_term_for_tty(const char *tty);
 472
 473 void execute_directory(const char *directory, DIR *_d, char *argv[]);
 474
 475 int kill_and_sigcont(pid_t pid, int sig);
 476
 477 bool nulstr_contains(const char*nulstr, const char *needle);
 478
 479 bool plymouth_running(void);
 480
 481 bool hostname_is_valid(const char *s) _pure_;
 482 char* hostname_cleanup(char *s, bool lowercase);
 483
 484 char* strshorten(char *s, size_t l);
 485
 486 int terminal_vhangup_fd(int fd);
 487 int terminal_vhangup(const char *name);
 488
 489 int vt_disallocate(const char *name);
 490
 491 int copy_file(const char *from, const char *to, int flags);
 492
 493 int symlink_atomic(const char *from, const char *to);
 494
 495 int fchmod_umask(int fd, mode_t mode);
 496
 497 bool display_is_local(const char *display) _pure_;
 498 int socket_from_display(const char *display, char **path);
 499
 500 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
 501 int get_group_creds(const char **groupname, gid_t *gid);
 502
 503 int in_gid(gid_t gid);
 504 int in_group(const char *name);
 505
 506 char* uid_to_name(uid_t uid);
 507 char* gid_to_name(gid_t gid);
 508
 509 int glob_exists(const char *path);
 510 int glob_extend(char ***strv, const char *path);
 511
 512 int dirent_ensure_type(DIR *d, struct dirent *de);
 513
 514 int in_search_path(const char *path, char **search);
 515 int get_files_in_directory(const char *path, char ***list);
 516
 517 char *strjoin(const char *x, ...) _sentinel_;
 518
 519 bool is_main_thread(void);
 520
 521 bool in_charset(const char *s, const char* charset) _pure_;
 522
 523 int block_get_whole_disk(dev_t d, dev_t *ret);
 524
 525 int file_is_priv_sticky(const char *p);
 526
 527 int strdup_or_null(const char *a, char **b);
 528
 529 #define NULSTR_FOREACH(i, l)                                    \
 530         for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
 531
 532 #define NULSTR_FOREACH_PAIR(i, j, l)                             \
 533         for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
 534
 535 int ioprio_class_to_string_alloc(int i, char **s);
 536 int ioprio_class_from_string(const char *s);
 537
 538 const char *sigchld_code_to_string(int i) _const_;
 539 int sigchld_code_from_string(const char *s) _pure_;
 540
 541 int log_facility_unshifted_to_string_alloc(int i, char **s);
 542 int log_facility_unshifted_from_string(const char *s);
 543
 544 int log_level_to_string_alloc(int i, char **s);
 545 int log_level_from_string(const char *s);
 546
 547 int sched_policy_to_string_alloc(int i, char **s);
 548 int sched_policy_from_string(const char *s);
 549
 550 const char *rlimit_to_string(int i) _const_;
 551 int rlimit_from_string(const char *s) _pure_;
 552
 553 int ip_tos_to_string_alloc(int i, char **s);
 554 int ip_tos_from_string(const char *s);
 555
 556 const char *signal_to_string(int i) _const_;
 557 int signal_from_string(const char *s) _pure_;
 558
 559 int signal_from_string_try_harder(const char *s);
 560
 561 extern int saved_argc;
 562 extern char **saved_argv;
 563
 564 bool kexec_loaded(void);
 565
 566 int prot_from_flags(int flags) _const_;
 567
 568 char *format_bytes(char *buf, size_t l, off_t t);
 569
 570 int fd_wait_for_event(int fd, int event, usec_t timeout);
 571
 572 void* memdup(const void *p, size_t l) _alloc_(2);
 573
 574 int is_kernel_thread(pid_t pid);
 575
 576 int fd_inc_sndbuf(int fd, size_t n);
 577 int fd_inc_rcvbuf(int fd, size_t n);
 578
 579 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
 580
 581 int setrlimit_closest(int resource, const struct rlimit *rlim);
 582
 583 int getenv_for_pid(pid_t pid, const char *field, char **_value);
 584
 585 bool is_valid_documentation_url(const char *url) _pure_;
 586
 587 bool in_initrd(void);
 588
 589 void warn_melody(void);
 590
 591 int get_home_dir(char **ret);
 592 int get_shell(char **_ret);
 593
 594 static inline void freep(void *p) {
 595         free(*(void**) p);
 596 }
 597
 598 #define DEFINE_TRIVIAL_CLEANUP_FUNC(type, func)                 \
 599         static inline void func##p(type *p) {                   \
 600                 if (*p)                                         \
 601                         func(*p);                               \
 602         }                                                       \
 603         struct __useless_struct_to_allow_trailing_semicolon__
 604
 605 static inline void closep(int *fd) {
 606         if (*fd >= 0)
 607                 close_nointr_nofail(*fd);
 608 }
 609
 610 static inline void umaskp(mode_t *u) {
 611         umask(*u);
 612 }
 613
 614 static inline void close_pipep(int (*p)[2]) {
 615         close_pipe(*p);
 616 }
 617
 618 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, fclose);
 619 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, pclose);
 620 DEFINE_TRIVIAL_CLEANUP_FUNC(DIR*, closedir);
 621 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, endmntent);
 622
 623 #define _cleanup_free_ _cleanup_(freep)
 624 #define _cleanup_close_ _cleanup_(closep)
 625 #define _cleanup_umask_ _cleanup_(umaskp)
 626 #define _cleanup_globfree_ _cleanup_(globfree)
 627 #define _cleanup_fclose_ _cleanup_(fclosep)
 628 #define _cleanup_pclose_ _cleanup_(pclosep)
 629 #define _cleanup_closedir_ _cleanup_(closedirp)
 630 #define _cleanup_endmntent_ _cleanup_(endmntentp)
 631 #define _cleanup_close_pipe_ _cleanup_(close_pipep)
 632
 633 _malloc_  _alloc_(1, 2) static inline void *malloc_multiply(size_t a, size_t b) {
 634         if (_unlikely_(b == 0 || a > ((size_t) -1) / b))
 635                 return NULL;
 636
 637         return malloc(a * b);
 638 }
 639
 640 _alloc_(2, 3) static inline void *memdup_multiply(const void *p, size_t a, size_t b) {
 641         if (_unlikely_(b == 0 || a > ((size_t) -1) / b))
 642                 return NULL;
 643
 644         return memdup(p, a * b);
 645 }
 646
 647 bool filename_is_safe(const char *p) _pure_;
 648 bool path_is_safe(const char *p) _pure_;
 649 bool string_is_safe(const char *p) _pure_;
 650 bool string_has_cc(const char *p) _pure_;
 651
 652 /**
 653  * Check if a string contains any glob patterns.
 654  */
 655 _pure_ static inline bool string_is_glob(const char *p) {
 656         return !!strpbrk(p, GLOB_CHARS);
 657 }
 658
 659 void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
 660                  int (*compar) (const void *, const void *, void *),
 661                  void *arg);
 662
 663 bool is_locale_utf8(void);
 664
 665 typedef enum DrawSpecialChar {
 666         DRAW_TREE_VERT,
 667         DRAW_TREE_BRANCH,
 668         DRAW_TREE_RIGHT,
 669         DRAW_TREE_SPACE,
 670         DRAW_TRIANGULAR_BULLET,
 671         DRAW_BLACK_CIRCLE,
 672         _DRAW_SPECIAL_CHAR_MAX
 673 } DrawSpecialChar;
 674 const char *draw_special_char(DrawSpecialChar ch);
 675
 676 char *strreplace(const char *text, const char *old_string, const char *new_string);
 677
 678 char *strip_tab_ansi(char **p, size_t *l);
 679
 680 int on_ac_power(void);
 681
 682 int search_and_fopen(const char *path, const char *mode, const char **search, FILE **_f);
 683 int search_and_fopen_nulstr(const char *path, const char *mode, const char *search, FILE **_f);
 684
 685 #define FOREACH_LINE(line, f, on_error)                         \
 686         for (;;)                                                \
 687                 if (!fgets(line, sizeof(line), f)) {            \
 688                         if (ferror(f)) {                        \
 689                                 on_error;                       \
 690                         }                                       \
 691                         break;                                  \
 692                 } else
 693
 694 #define FOREACH_DIRENT(de, d, on_error)                                 \
 695         for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d))   \
 696                 if (!de) {                                              \
 697                         if (errno > 0) {                                \
 698                                 on_error;                               \
 699                         }                                               \
 700                         break;                                          \
 701                 } else if (ignore_file((de)->d_name))                   \
 702                         continue;                                       \
 703                 else
 704
 705 static inline void *mempset(void *s, int c, size_t n) {
 706         memset(s, c, n);
 707         return (uint8_t*)s + n;
 708 }
 709
 710 char *hexmem(const void *p, size_t l);
 711 void *unhexmem(const char *p, size_t l);
 712
 713 char *strextend(char **x, ...) _sentinel_;
 714 char *strrep(const char *s, unsigned n);
 715
 716 void* greedy_realloc(void **p, size_t *allocated, size_t need);
 717 void* greedy_realloc0(void **p, size_t *allocated, size_t need);
 718 #define GREEDY_REALLOC(array, allocated, need) \
 719         greedy_realloc((void**) &(array), &(allocated), sizeof((array)[0]) * (need))
 720 #define GREEDY_REALLOC0(array, allocated, need) \
 721         greedy_realloc0((void**) &(array), &(allocated), sizeof((array)[0]) * (need))
 722
 723 static inline void _reset_errno_(int *saved_errno) {
 724         errno = *saved_errno;
 725 }
 726
 727 #define PROTECT_ERRNO _cleanup_(_reset_errno_) __attribute__((unused)) int _saved_errno_ = errno
 728
 729 struct _umask_struct_ {
 730         mode_t mask;
 731         bool quit;
 732 };
 733
 734 static inline void _reset_umask_(struct _umask_struct_ *s) {
 735         umask(s->mask);
 736 };
 737
 738 #define RUN_WITH_UMASK(mask)                                            \
 739         for (_cleanup_(_reset_umask_) struct _umask_struct_ _saved_umask_ = { umask(mask), false }; \
 740              !_saved_umask_.quit ;                                      \
 741              _saved_umask_.quit = true)
 742
 743 static inline unsigned u64log2(uint64_t n) {
 744         return (n > 1) ? (unsigned) __builtin_clzll(n) ^ 63U : 0;
 745 }
 746
 747 static inline bool logind_running(void) {
 748         return access("/run/systemd/seats/", F_OK) >= 0;
 749 }
 750
 751 #define DECIMAL_STR_WIDTH(x)                            \
 752         ({                                              \
 753                 typeof(x) _x_ = (x);                    \
 754                 unsigned ans = 1;                       \
 755                 while (_x_ /= 10)                       \
 756                         ans++;                          \
 757                 ans;                                    \
 758         })
 759
 760 int unlink_noerrno(const char *path);
 761
 762 #define alloca0(n)                                      \
 763         ({                                              \
 764                 char *_new_;                            \
 765                 size_t _len_ = n;                       \
 766                 _new_ = alloca(_len_);                  \
 767                 (void *) memset(_new_, 0, _len_);       \
 768         })
 769
 770 #define strappenda(a, b)                                \
 771         ({                                              \
 772                 const char *_a_ = (a), *_b_ = (b);      \
 773                 char *_c_;                              \
 774                 size_t _x_, _y_;                        \
 775                 _x_ = strlen(_a_);                      \
 776                 _y_ = strlen(_b_);                      \
 777                 _c_ = alloca(_x_ + _y_ + 1);            \
 778                 strcpy(stpcpy(_c_, _a_), _b_);          \
 779                 _c_;                                    \
 780         })
 781
 782 #define procfs_file_alloca(pid, field)                                  \
 783         ({                                                              \
 784                 pid_t _pid_ = (pid);                                    \
 785                 const char *_r_;                                        \
 786                 if (_pid_ == 0) {                                       \
 787                         _r_ = ("/proc/self/" field);                    \
 788                 } else {                                                \
 789                         _r_ = alloca(strlen("/proc/") + DECIMAL_STR_MAX(pid_t) + 1 + sizeof(field)); \
 790                         sprintf((char*) _r_, "/proc/"PID_FMT"/" field, _pid_);                       \
 791                 }                                                       \
 792                 _r_;                                                    \
 793         })
 794
 795 struct _locale_struct_ {
 796         locale_t saved_locale;
 797         locale_t new_locale;
 798         bool quit;
 799 };
 800
 801 static inline void _reset_locale_(struct _locale_struct_ *s) {
 802         PROTECT_ERRNO;
 803         if (s->saved_locale != (locale_t) 0)
 804                 uselocale(s->saved_locale);
 805         if (s->new_locale != (locale_t) 0)
 806                 freelocale(s->new_locale);
 807 }
 808
 809 #define RUN_WITH_LOCALE(mask, loc) \
 810         for (_cleanup_(_reset_locale_) struct _locale_struct_ _saved_locale_ = { (locale_t) 0, (locale_t) 0, false }; \
 811              ({                                                         \
 812                      if (!_saved_locale_.quit) {                        \
 813                              PROTECT_ERRNO;                             \
 814                              _saved_locale_.new_locale = newlocale((mask), (loc), (locale_t) 0); \
 815                              if (_saved_locale_.new_locale != (locale_t) 0)     \
 816                                      _saved_locale_.saved_locale = uselocale(_saved_locale_.new_locale); \
 817                      }                                                  \
 818                      !_saved_locale_.quit; }) ;                         \
 819              _saved_locale_.quit = true)
 820
 821 bool id128_is_valid(const char *s) _pure_;
 822 void parse_user_at_host(char *arg, char **user, char **host);
 823
 824 int split_pair(const char *s, const char *sep, char **l, char **r);
 825
 826 int shall_restore_state(void);
 827
 828 /**
 829  * Normal qsort requires base to be nonnull. Here were require
 830  * that only if nmemb > 0.
 831  */
 832 static inline void qsort_safe(void *base, size_t nmemb, size_t size,
 833                               int (*compar)(const void *, const void *)) {
 834         if (nmemb) {
 835                 assert(base);
 836                 qsort(base, nmemb, size, compar);
 837         }
 838 }
 839
 840 int proc_cmdline(char **ret);
 841
 842 int container_get_leader(const char *machine, pid_t *pid);
 843
 844 int namespace_open(pid_t pid, int *pidns_fd, int *mntns_fd, int *root_fd);
 845 int namespace_enter(int pidns_fd, int mntns_fd, int root_fd);
 846
 847 bool pid_valid(pid_t pid);
 848
 849 int getpeercred(int fd, struct ucred *ucred);
 850 int getpeersec(int fd, char **ret);