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