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