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 <fcntl.h>
  26 #include <inttypes.h>
  27 #include <time.h>
  28 #include <sys/time.h>
  29 #include <stdarg.h>
  30 #include <stdbool.h>
  31 #include <stdlib.h>
  32 #include <stdio.h>
  33 #include <signal.h>
  34 #include <sched.h>
  35 #include <limits.h>
  36 #include <sys/types.h>
  37 #include <sys/stat.h>
  38 #include <dirent.h>
  39 #include <sys/resource.h>
  40 #include <stddef.h>
  41 #include <unistd.h>
  42 #include <locale.h>
  43 #include <mntent.h>
  44 #include <sys/socket.h>
  45 #include <sys/inotify.h>
  46
  47 #if SIZEOF_PID_T == 4
  48 #  define PID_FMT "%" PRIu32
  49 #elif SIZEOF_PID_T == 2
  50 #  define PID_FMT "%" PRIu16
  51 #else
  52 #  error Unknown pid_t size
  53 #endif
  54
  55 #if SIZEOF_UID_T == 4
  56 #  define UID_FMT "%" PRIu32
  57 #elif SIZEOF_UID_T == 2
  58 #  define UID_FMT "%" PRIu16
  59 #else
  60 #  error Unknown uid_t size
  61 #endif
  62
  63 #if SIZEOF_GID_T == 4
  64 #  define GID_FMT "%" PRIu32
  65 #elif SIZEOF_GID_T == 2
  66 #  define GID_FMT "%" PRIu16
  67 #else
  68 #  error Unknown gid_t size
  69 #endif
  70
  71 #if SIZEOF_TIME_T == 8
  72 #  define PRI_TIME PRIu64
  73 #elif SIZEOF_TIME_T == 4
  74 #  define PRI_TIME PRIu32
  75 #else
  76 #  error Unknown time_t size
  77 #endif
  78
  79 #if SIZEOF_RLIM_T == 8
  80 #  define RLIM_FMT "%" PRIu64
  81 #elif SIZEOF_RLIM_T == 4
  82 #  define RLIM_FMT "%" PRIu32
  83 #else
  84 #  error Unknown rlim_t size
  85 #endif
  86
  87 #include "macro.h"
  88 #include "missing.h"
  89 #include "time-util.h"
  90
  91 /* What is interpreted as whitespace? */
  92 #define WHITESPACE " \t\n\r"
  93 #define NEWLINE    "\n\r"
  94 #define QUOTES     "\"\'"
  95 #define COMMENTS   "#;"
  96 #define GLOB_CHARS "*?["
  97
  98 /* What characters are special in the shell? */
  99 /* must be escaped outside and inside double-quotes */
 100 #define SHELL_NEED_ESCAPE "\"\\`$"
 101 /* can be escaped or double-quoted */
 102 #define SHELL_NEED_QUOTES SHELL_NEED_ESCAPE GLOB_CHARS "'()<>|&;"
 103
 104 #define FORMAT_BYTES_MAX 8
 105
 106 #define ANSI_HIGHLIGHT_ON "\x1B[1;39m"
 107 #define ANSI_RED_ON "\x1B[31m"
 108 #define ANSI_HIGHLIGHT_RED_ON "\x1B[1;31m"
 109 #define ANSI_GREEN_ON "\x1B[32m"
 110 #define ANSI_HIGHLIGHT_GREEN_ON "\x1B[1;32m"
 111 #define ANSI_HIGHLIGHT_YELLOW_ON "\x1B[1;33m"
 112 #define ANSI_HIGHLIGHT_BLUE_ON "\x1B[1;34m"
 113 #define ANSI_HIGHLIGHT_OFF "\x1B[0m"
 114 #define ANSI_ERASE_TO_END_OF_LINE "\x1B[K"
 115
 116 size_t page_size(void) _pure_;
 117 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
 118
 119 #define streq(a,b) (strcmp((a),(b)) == 0)
 120 #define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
 121 #define strcaseeq(a,b) (strcasecmp((a),(b)) == 0)
 122 #define strncaseeq(a, b, n) (strncasecmp((a), (b), (n)) == 0)
 123
 124 bool streq_ptr(const char *a, const char *b) _pure_;
 125
 126 #define new(t, n) ((t*) malloc_multiply(sizeof(t), (n)))
 127
 128 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
 129
 130 #define newa(t, n) ((t*) alloca(sizeof(t)*(n)))
 131
 132 #define newa0(t, n) ((t*) alloca0(sizeof(t)*(n)))
 133
 134 #define newdup(t, p, n) ((t*) memdup_multiply(p, sizeof(t), (n)))
 135
 136 #define malloc0(n) (calloc((n), 1))
 137
 138 static inline const char* yes_no(bool b) {
 139         return b ? "yes" : "no";
 140 }
 141
 142 static inline const char* true_false(bool b) {
 143         return b ? "true" : "false";
 144 }
 145
 146 static inline const char* one_zero(bool b) {
 147         return b ? "1" : "0";
 148 }
 149
 150 static inline const char* strempty(const char *s) {
 151         return s ? s : "";
 152 }
 153
 154 static inline const char* strnull(const char *s) {
 155         return s ? s : "(null)";
 156 }
 157
 158 static inline const char *strna(const char *s) {
 159         return s ? s : "n/a";
 160 }
 161
 162 static inline bool isempty(const char *p) {
 163         return !p || !p[0];
 164 }
 165
 166 static inline char *startswith(const char *s, const char *prefix) {
 167         size_t l;
 168
 169         l = strlen(prefix);
 170         if (strncmp(s, prefix, l) == 0)
 171                 return (char*) s + l;
 172
 173         return NULL;
 174 }
 175
 176 static inline char *startswith_no_case(const char *s, const char *prefix) {
 177         size_t l;
 178
 179         l = strlen(prefix);
 180         if (strncasecmp(s, prefix, l) == 0)
 181                 return (char*) s + l;
 182
 183         return NULL;
 184 }
 185
 186 char *endswith(const char *s, const char *postfix) _pure_;
 187
 188 char *first_word(const char *s, const char *word) _pure_;
 189
 190 int close_nointr(int fd);
 191 int safe_close(int fd);
 192 void safe_close_pair(int p[]);
 193
 194 void close_many(const int fds[], unsigned n_fd);
 195
 196 int parse_size(const char *t, off_t base, off_t *size);
 197
 198 int parse_boolean(const char *v) _pure_;
 199 int parse_pid(const char *s, pid_t* ret_pid);
 200 int parse_uid(const char *s, uid_t* ret_uid);
 201 #define parse_gid(s, ret_uid) parse_uid(s, ret_uid)
 202
 203 int safe_atou(const char *s, unsigned *ret_u);
 204 int safe_atoi(const char *s, int *ret_i);
 205
 206 int safe_atollu(const char *s, unsigned long long *ret_u);
 207 int safe_atolli(const char *s, long long int *ret_i);
 208
 209 int safe_atod(const char *s, double *ret_d);
 210
 211 int safe_atou8(const char *s, uint8_t *ret);
 212
 213 #if LONG_MAX == INT_MAX
 214 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
 215         assert_cc(sizeof(unsigned long) == sizeof(unsigned));
 216         return safe_atou(s, (unsigned*) ret_u);
 217 }
 218 static inline int safe_atoli(const char *s, long int *ret_u) {
 219         assert_cc(sizeof(long int) == sizeof(int));
 220         return safe_atoi(s, (int*) ret_u);
 221 }
 222 #else
 223 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
 224         assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
 225         return safe_atollu(s, (unsigned long long*) ret_u);
 226 }
 227 static inline int safe_atoli(const char *s, long int *ret_u) {
 228         assert_cc(sizeof(long int) == sizeof(long long int));
 229         return safe_atolli(s, (long long int*) ret_u);
 230 }
 231 #endif
 232
 233 static inline int safe_atou32(const char *s, uint32_t *ret_u) {
 234         assert_cc(sizeof(uint32_t) == sizeof(unsigned));
 235         return safe_atou(s, (unsigned*) ret_u);
 236 }
 237
 238 static inline int safe_atoi32(const char *s, int32_t *ret_i) {
 239         assert_cc(sizeof(int32_t) == sizeof(int));
 240         return safe_atoi(s, (int*) ret_i);
 241 }
 242
 243 static inline int safe_atou64(const char *s, uint64_t *ret_u) {
 244         assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
 245         return safe_atollu(s, (unsigned long long*) ret_u);
 246 }
 247
 248 static inline int safe_atoi64(const char *s, int64_t *ret_i) {
 249         assert_cc(sizeof(int64_t) == sizeof(long long int));
 250         return safe_atolli(s, (long long int*) ret_i);
 251 }
 252
 253 int safe_atou16(const char *s, uint16_t *ret);
 254 int safe_atoi16(const char *s, int16_t *ret);
 255
 256 const char* split(const char **state, size_t *l, const char *separator, bool quoted);
 257
 258 #define FOREACH_WORD(word, length, s, state)                            \
 259         _FOREACH_WORD(word, length, s, WHITESPACE, false, state)
 260
 261 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state)       \
 262         _FOREACH_WORD(word, length, s, separator, false, state)
 263
 264 #define FOREACH_WORD_QUOTED(word, length, s, state)                     \
 265         _FOREACH_WORD(word, length, s, WHITESPACE, true, state)
 266
 267 #define _FOREACH_WORD(word, length, s, separator, quoted, state)        \
 268         for ((state) = (s), (word) = split(&(state), &(length), (separator), (quoted)); (word); (word) = split(&(state), &(length), (separator), (quoted)))
 269
 270 pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
 271
 272 char *strappend(const char *s, const char *suffix);
 273 char *strnappend(const char *s, const char *suffix, size_t length);
 274
 275 char *replace_env(const char *format, char **env);
 276 char **replace_env_argv(char **argv, char **env);
 277
 278 int readlinkat_malloc(int fd, const char *p, char **ret);
 279 int readlink_malloc(const char *p, char **r);
 280 int readlink_value(const char *p, char **ret);
 281 int readlink_and_make_absolute(const char *p, char **r);
 282 int readlink_and_canonicalize(const char *p, char **r);
 283
 284 int reset_all_signal_handlers(void);
 285 int reset_signal_mask(void);
 286
 287 char *strstrip(char *s);
 288 char *delete_chars(char *s, const char *bad);
 289 char *truncate_nl(char *s);
 290
 291 char *file_in_same_dir(const char *path, const char *filename);
 292
 293 int rmdir_parents(const char *path, const char *stop);
 294
 295 int get_process_state(pid_t pid);
 296 int get_process_comm(pid_t pid, char **name);
 297 int get_process_cmdline(pid_t pid, size_t max_length, bool comm_fallback, char **line);
 298 int get_process_exe(pid_t pid, char **name);
 299 int get_process_uid(pid_t pid, uid_t *uid);
 300 int get_process_gid(pid_t pid, gid_t *gid);
 301 int get_process_capeff(pid_t pid, char **capeff);
 302 int get_process_cwd(pid_t pid, char **cwd);
 303 int get_process_root(pid_t pid, char **root);
 304 int get_process_environ(pid_t pid, char **environ);
 305
 306 char hexchar(int x) _const_;
 307 int unhexchar(char c) _const_;
 308 char octchar(int x) _const_;
 309 int unoctchar(char c) _const_;
 310 char decchar(int x) _const_;
 311 int undecchar(char c) _const_;
 312
 313 char *cescape(const char *s);
 314 char *cunescape(const char *s);
 315 char *cunescape_length(const char *s, size_t length);
 316 char *cunescape_length_with_prefix(const char *s, size_t length, const char *prefix);
 317
 318 char *xescape(const char *s, const char *bad);
 319
 320 char *ascii_strlower(char *path);
 321
 322 bool dirent_is_file(const struct dirent *de) _pure_;
 323 bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix) _pure_;
 324
 325 bool hidden_file(const char *filename) _pure_;
 326
 327 bool chars_intersect(const char *a, const char *b) _pure_;
 328
 329 int make_stdio(int fd);
 330 int make_null_stdio(void);
 331 int make_console_stdio(void);
 332
 333 int dev_urandom(void *p, size_t n);
 334 void random_bytes(void *p, size_t n);
 335 void initialize_srand(void);
 336
 337 static inline uint64_t random_u64(void) {
 338         uint64_t u;
 339         random_bytes(&u, sizeof(u));
 340         return u;
 341 }
 342
 343 static inline uint32_t random_u32(void) {
 344         uint32_t u;
 345         random_bytes(&u, sizeof(u));
 346         return u;
 347 }
 348
 349 /* For basic lookup tables with strictly enumerated entries */
 350 #define __DEFINE_STRING_TABLE_LOOKUP(name,type,scope)                   \
 351         scope const char *name##_to_string(type i) {                    \
 352                 if (i < 0 || i >= (type) ELEMENTSOF(name##_table))      \
 353                         return NULL;                                    \
 354                 return name##_table[i];                                 \
 355         }                                                               \
 356         scope type name##_from_string(const char *s) {                  \
 357                 type i;                                                 \
 358                 if (!s)                                                 \
 359                         return (type) -1;                               \
 360                 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++)    \
 361                         if (name##_table[i] &&                          \
 362                             streq(name##_table[i], s))                  \
 363                                 return i;                               \
 364                 return (type) -1;                                       \
 365         }                                                               \
 366         struct __useless_struct_to_allow_trailing_semicolon__
 367
 368 #define DEFINE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,)
 369 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,static)
 370
 371 /* For string conversions where numbers are also acceptable */
 372 #define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max)         \
 373         int name##_to_string_alloc(type i, char **str) {                \
 374                 char *s;                                                \
 375                 int r;                                                  \
 376                 if (i < 0 || i > max)                                   \
 377                         return -ERANGE;                                 \
 378                 if (i < (type) ELEMENTSOF(name##_table)) {              \
 379                         s = strdup(name##_table[i]);                    \
 380                         if (!s)                                         \
 381                                 return log_oom();                       \
 382                 } else {                                                \
 383                         r = asprintf(&s, "%u", i);                      \
 384                         if (r < 0)                                      \
 385                                 return log_oom();                       \
 386                 }                                                       \
 387                 *str = s;                                               \
 388                 return 0;                                               \
 389         }                                                               \
 390         type name##_from_string(const char *s) {                        \
 391                 type i;                                                 \
 392                 unsigned u = 0;                                         \
 393                 assert(s);                                              \
 394                 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++)    \
 395                         if (name##_table[i] &&                          \
 396                             streq(name##_table[i], s))                  \
 397                                 return i;                               \
 398                 if (safe_atou(s, &u) >= 0 && u <= max)                  \
 399                         return (type) u;                                \
 400                 return (type) -1;                                       \
 401         }                                                               \
 402         struct __useless_struct_to_allow_trailing_semicolon__
 403
 404 int fd_nonblock(int fd, bool nonblock);
 405 int fd_cloexec(int fd, bool cloexec);
 406
 407 int close_all_fds(const int except[], unsigned n_except);
 408
 409 bool fstype_is_network(const char *fstype);
 410
 411 int chvt(int vt);
 412
 413 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
 414 int ask_char(char *ret, const char *replies, const char *text, ...) _printf_(3, 4);
 415 int ask_string(char **ret, const char *text, ...) _printf_(2, 3);
 416
 417 int reset_terminal_fd(int fd, bool switch_to_text);
 418 int reset_terminal(const char *name);
 419
 420 int open_terminal(const char *name, int mode);
 421 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
 422 int release_terminal(void);
 423
 424 int flush_fd(int fd);
 425
 426 int ignore_signals(int sig, ...);
 427 int default_signals(int sig, ...);
 428 int sigaction_many(const struct sigaction *sa, ...);
 429
 430 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
 431
 432 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
 433 int loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
 434
 435 bool is_device_path(const char *path);
 436
 437 int dir_is_empty(const char *path);
 438 char* dirname_malloc(const char *path);
 439
 440 void rename_process(const char name[8]);
 441
 442 void sigset_add_many(sigset_t *ss, ...);
 443 int sigprocmask_many(int how, ...);
 444
 445 bool hostname_is_set(void);
 446
 447 char* lookup_uid(uid_t uid);
 448 char* gethostname_malloc(void);
 449 char* getlogname_malloc(void);
 450 char* getusername_malloc(void);
 451
 452 int getttyname_malloc(int fd, char **r);
 453 int getttyname_harder(int fd, char **r);
 454
 455 int get_ctty_devnr(pid_t pid, dev_t *d);
 456 int get_ctty(pid_t, dev_t *_devnr, char **r);
 457
 458 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
 459 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
 460
 461 int is_fd_on_temporary_fs(int fd);
 462
 463 int rm_rf_children(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
 464 int rm_rf_children_dangerous(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
 465 int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
 466 int rm_rf_dangerous(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
 467
 468 int pipe_eof(int fd);
 469
 470 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
 471
 472 int status_vprintf(const char *status, bool ellipse, bool ephemeral, const char *format, va_list ap) _printf_(4,0);
 473 int status_printf(const char *status, bool ellipse, bool ephemeral, const char *format, ...) _printf_(4,5);
 474
 475 int fd_columns(int fd);
 476 unsigned columns(void);
 477 int fd_lines(int fd);
 478 unsigned lines(void);
 479 void columns_lines_cache_reset(int _unused_ signum);
 480
 481 bool on_tty(void);
 482
 483 static inline const char *ansi_highlight(void) {
 484         return on_tty() ? ANSI_HIGHLIGHT_ON : "";
 485 }
 486
 487 static inline const char *ansi_highlight_red(void) {
 488         return on_tty() ? ANSI_HIGHLIGHT_RED_ON : "";
 489 }
 490
 491 static inline const char *ansi_highlight_green(void) {
 492         return on_tty() ? ANSI_HIGHLIGHT_GREEN_ON : "";
 493 }
 494
 495 static inline const char *ansi_highlight_yellow(void) {
 496         return on_tty() ? ANSI_HIGHLIGHT_YELLOW_ON : "";
 497 }
 498
 499 static inline const char *ansi_highlight_blue(void) {
 500         return on_tty() ? ANSI_HIGHLIGHT_BLUE_ON : "";
 501 }
 502
 503 static inline const char *ansi_highlight_off(void) {
 504         return on_tty() ? ANSI_HIGHLIGHT_OFF : "";
 505 }
 506
 507 int files_same(const char *filea, const char *fileb);
 508
 509 int running_in_chroot(void);
 510
 511 char *ellipsize(const char *s, size_t length, unsigned percent);
 512                                    /* bytes                 columns */
 513 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
 514
 515 int touch_file(const char *path, bool parents, usec_t stamp, uid_t uid, gid_t gid, mode_t mode);
 516 int touch(const char *path);
 517
 518 char *unquote(const char *s, const char *quotes);
 519 char *normalize_env_assignment(const char *s);
 520
 521 int wait_for_terminate(pid_t pid, siginfo_t *status);
 522 int wait_for_terminate_and_warn(const char *name, pid_t pid, bool check_exit_code);
 523
 524 noreturn void freeze(void);
 525
 526 bool null_or_empty(struct stat *st) _pure_;
 527 int null_or_empty_path(const char *fn);
 528 int null_or_empty_fd(int fd);
 529
 530 DIR *xopendirat(int dirfd, const char *name, int flags);
 531
 532 char *fstab_node_to_udev_node(const char *p);
 533
 534 char *resolve_dev_console(char **active);
 535 bool tty_is_vc(const char *tty);
 536 bool tty_is_vc_resolve(const char *tty);
 537 bool tty_is_console(const char *tty) _pure_;
 538 int vtnr_from_tty(const char *tty);
 539 const char *default_term_for_tty(const char *tty);
 540
 541 void execute_directories(const char* const* directories, usec_t timeout, char *argv[]);
 542
 543 int kill_and_sigcont(pid_t pid, int sig);
 544
 545 bool nulstr_contains(const char*nulstr, const char *needle);
 546
 547 bool plymouth_running(void);
 548
 549 bool hostname_is_valid(const char *s) _pure_;
 550 char* hostname_cleanup(char *s, bool lowercase);
 551
 552 bool machine_name_is_valid(const char *s) _pure_;
 553
 554 char* strshorten(char *s, size_t l);
 555
 556 int terminal_vhangup_fd(int fd);
 557 int terminal_vhangup(const char *name);
 558
 559 int vt_disallocate(const char *name);
 560
 561 int symlink_atomic(const char *from, const char *to);
 562 int mknod_atomic(const char *path, mode_t mode, dev_t dev);
 563 int mkfifo_atomic(const char *path, mode_t mode);
 564
 565 int fchmod_umask(int fd, mode_t mode);
 566
 567 bool display_is_local(const char *display) _pure_;
 568 int socket_from_display(const char *display, char **path);
 569
 570 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
 571 int get_group_creds(const char **groupname, gid_t *gid);
 572
 573 int in_gid(gid_t gid);
 574 int in_group(const char *name);
 575
 576 char* uid_to_name(uid_t uid);
 577 char* gid_to_name(gid_t gid);
 578
 579 int glob_exists(const char *path);
 580 int glob_extend(char ***strv, const char *path);
 581
 582 int dirent_ensure_type(DIR *d, struct dirent *de);
 583
 584 int get_files_in_directory(const char *path, char ***list);
 585
 586 char *strjoin(const char *x, ...) _sentinel_;
 587
 588 bool is_main_thread(void);
 589
 590 static inline bool _pure_ in_charset(const char *s, const char* charset) {
 591         assert(s);
 592         assert(charset);
 593         return s[strspn(s, charset)] == '\0';
 594 }
 595
 596 int block_get_whole_disk(dev_t d, dev_t *ret);
 597
 598 #define NULSTR_FOREACH(i, l)                                    \
 599         for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
 600
 601 #define NULSTR_FOREACH_PAIR(i, j, l)                             \
 602         for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
 603
 604 int ioprio_class_to_string_alloc(int i, char **s);
 605 int ioprio_class_from_string(const char *s);
 606
 607 const char *sigchld_code_to_string(int i) _const_;
 608 int sigchld_code_from_string(const char *s) _pure_;
 609
 610 int log_facility_unshifted_to_string_alloc(int i, char **s);
 611 int log_facility_unshifted_from_string(const char *s);
 612
 613 int log_level_to_string_alloc(int i, char **s);
 614 int log_level_from_string(const char *s);
 615
 616 int sched_policy_to_string_alloc(int i, char **s);
 617 int sched_policy_from_string(const char *s);
 618
 619 const char *rlimit_to_string(int i) _const_;
 620 int rlimit_from_string(const char *s) _pure_;
 621
 622 int ip_tos_to_string_alloc(int i, char **s);
 623 int ip_tos_from_string(const char *s);
 624
 625 const char *signal_to_string(int i) _const_;
 626 int signal_from_string(const char *s) _pure_;
 627
 628 int signal_from_string_try_harder(const char *s);
 629
 630 extern int saved_argc;
 631 extern char **saved_argv;
 632
 633 bool kexec_loaded(void);
 634
 635 int prot_from_flags(int flags) _const_;
 636
 637 char *format_bytes(char *buf, size_t l, off_t t);
 638
 639 int fd_wait_for_event(int fd, int event, usec_t timeout);
 640
 641 void* memdup(const void *p, size_t l) _alloc_(2);
 642
 643 int is_kernel_thread(pid_t pid);
 644
 645 int fd_inc_sndbuf(int fd, size_t n);
 646 int fd_inc_rcvbuf(int fd, size_t n);
 647
 648 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
 649
 650 int setrlimit_closest(int resource, const struct rlimit *rlim);
 651
 652 int getenv_for_pid(pid_t pid, const char *field, char **_value);
 653
 654 bool is_valid_documentation_url(const char *url) _pure_;
 655
 656 bool in_initrd(void);
 657
 658 void warn_melody(void);
 659
 660 int get_home_dir(char **ret);
 661 int get_shell(char **_ret);
 662
 663 static inline void freep(void *p) {
 664         free(*(void**) p);
 665 }
 666
 667 static inline void closep(int *fd) {
 668         safe_close(*fd);
 669 }
 670
 671 static inline void umaskp(mode_t *u) {
 672         umask(*u);
 673 }
 674
 675 static inline void close_pairp(int (*p)[2]) {
 676         safe_close_pair(*p);
 677 }
 678
 679 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, fclose);
 680 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, pclose);
 681 DEFINE_TRIVIAL_CLEANUP_FUNC(DIR*, closedir);
 682 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, endmntent);
 683
 684 #define _cleanup_free_ _cleanup_(freep)
 685 #define _cleanup_close_ _cleanup_(closep)
 686 #define _cleanup_umask_ _cleanup_(umaskp)
 687 #define _cleanup_globfree_ _cleanup_(globfree)
 688 #define _cleanup_fclose_ _cleanup_(fclosep)
 689 #define _cleanup_pclose_ _cleanup_(pclosep)
 690 #define _cleanup_closedir_ _cleanup_(closedirp)
 691 #define _cleanup_endmntent_ _cleanup_(endmntentp)
 692 #define _cleanup_close_pair_ _cleanup_(close_pairp)
 693
 694 _malloc_  _alloc_(1, 2) static inline void *malloc_multiply(size_t a, size_t b) {
 695         if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
 696                 return NULL;
 697
 698         return malloc(a * b);
 699 }
 700
 701 _alloc_(2, 3) static inline void *realloc_multiply(void *p, size_t a, size_t b) {
 702         if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
 703                 return NULL;
 704
 705         return realloc(p, a * b);
 706 }
 707
 708 _alloc_(2, 3) static inline void *memdup_multiply(const void *p, size_t a, size_t b) {
 709         if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
 710                 return NULL;
 711
 712         return memdup(p, a * b);
 713 }
 714
 715 bool filename_is_valid(const char *p) _pure_;
 716 bool path_is_safe(const char *p) _pure_;
 717 bool string_is_safe(const char *p) _pure_;
 718 bool string_has_cc(const char *p, const char *ok) _pure_;
 719
 720 /**
 721  * Check if a string contains any glob patterns.
 722  */
 723 _pure_ static inline bool string_is_glob(const char *p) {
 724         return !!strpbrk(p, GLOB_CHARS);
 725 }
 726
 727 void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
 728                  int (*compar) (const void *, const void *, void *),
 729                  void *arg);
 730
 731 bool is_locale_utf8(void);
 732
 733 typedef enum DrawSpecialChar {
 734         DRAW_TREE_VERTICAL,
 735         DRAW_TREE_BRANCH,
 736         DRAW_TREE_RIGHT,
 737         DRAW_TREE_SPACE,
 738         DRAW_TRIANGULAR_BULLET,
 739         DRAW_BLACK_CIRCLE,
 740         DRAW_ARROW,
 741         DRAW_DASH,
 742         _DRAW_SPECIAL_CHAR_MAX
 743 } DrawSpecialChar;
 744
 745 const char *draw_special_char(DrawSpecialChar ch);
 746
 747 char *strreplace(const char *text, const char *old_string, const char *new_string);
 748
 749 char *strip_tab_ansi(char **p, size_t *l);
 750
 751 int on_ac_power(void);
 752
 753 int search_and_fopen(const char *path, const char *mode, const char *root, const char **search, FILE **_f);
 754 int search_and_fopen_nulstr(const char *path, const char *mode, const char *root, const char *search, FILE **_f);
 755
 756 #define FOREACH_LINE(line, f, on_error)                         \
 757         for (;;)                                                \
 758                 if (!fgets(line, sizeof(line), f)) {            \
 759                         if (ferror(f)) {                        \
 760                                 on_error;                       \
 761                         }                                       \
 762                         break;                                  \
 763                 } else
 764
 765 #define FOREACH_DIRENT(de, d, on_error)                                 \
 766         for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d))   \
 767                 if (!de) {                                              \
 768                         if (errno > 0) {                                \
 769                                 on_error;                               \
 770                         }                                               \
 771                         break;                                          \
 772                 } else if (hidden_file((de)->d_name))                   \
 773                         continue;                                       \
 774                 else
 775
 776 #define FOREACH_DIRENT_ALL(de, d, on_error)                             \
 777         for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d))   \
 778                 if (!de) {                                              \
 779                         if (errno > 0) {                                \
 780                                 on_error;                               \
 781                         }                                               \
 782                         break;                                          \
 783                 } else
 784
 785 static inline void *mempset(void *s, int c, size_t n) {
 786         memset(s, c, n);
 787         return (uint8_t*)s + n;
 788 }
 789
 790 char *hexmem(const void *p, size_t l);
 791 void *unhexmem(const char *p, size_t l);
 792
 793 char *strextend(char **x, ...) _sentinel_;
 794 char *strrep(const char *s, unsigned n);
 795
 796 void* greedy_realloc(void **p, size_t *allocated, size_t need, size_t size);
 797 void* greedy_realloc0(void **p, size_t *allocated, size_t need, size_t size);
 798 #define GREEDY_REALLOC(array, allocated, need)                          \
 799         greedy_realloc((void**) &(array), &(allocated), (need), sizeof((array)[0]))
 800
 801 #define GREEDY_REALLOC0(array, allocated, need)                         \
 802         greedy_realloc0((void**) &(array), &(allocated), (need), sizeof((array)[0]))
 803
 804 static inline void _reset_errno_(int *saved_errno) {
 805         errno = *saved_errno;
 806 }
 807
 808 #define PROTECT_ERRNO _cleanup_(_reset_errno_) __attribute__((unused)) int _saved_errno_ = errno
 809
 810 static inline int negative_errno(void) {
 811         /* This helper should be used to shut up gcc if you know 'errno' is
 812          * negative. Instead of "return -errno;", use "return negative_errno();"
 813          * It will suppress bogus gcc warnings in case it assumes 'errno' might
 814          * be 0 and thus the caller's error-handling might not be triggered. */
 815         assert_return(errno > 0, -EINVAL);
 816         return -errno;
 817 }
 818
 819 struct _umask_struct_ {
 820         mode_t mask;
 821         bool quit;
 822 };
 823
 824 static inline void _reset_umask_(struct _umask_struct_ *s) {
 825         umask(s->mask);
 826 };
 827
 828 #define RUN_WITH_UMASK(mask)                                            \
 829         for (_cleanup_(_reset_umask_) struct _umask_struct_ _saved_umask_ = { umask(mask), false }; \
 830              !_saved_umask_.quit ;                                      \
 831              _saved_umask_.quit = true)
 832
 833 static inline unsigned u64log2(uint64_t n) {
 834 #if __SIZEOF_LONG_LONG__ == 8
 835         return (n > 1) ? (unsigned) __builtin_clzll(n) ^ 63U : 0;
 836 #else
 837 #error "Wut?"
 838 #endif
 839 }
 840
 841 static inline unsigned u32ctz(uint32_t n) {
 842 #if __SIZEOF_INT__ == 4
 843         return __builtin_ctz(n);
 844 #else
 845 #error "Wut?"
 846 #endif
 847 }
 848
 849 static inline int log2i(int x) {
 850         assert(x > 0);
 851
 852         return __SIZEOF_INT__ * 8 - __builtin_clz(x) - 1;
 853 }
 854
 855 static inline unsigned log2u(unsigned x) {
 856         assert(x > 0);
 857
 858         return sizeof(unsigned) * 8 - __builtin_clz(x) - 1;
 859 }
 860
 861 static inline unsigned log2u_round_up(unsigned x) {
 862         assert(x > 0);
 863
 864         if (x == 1)
 865                 return 0;
 866
 867         return log2u(x - 1) + 1;
 868 }
 869
 870 static inline bool logind_running(void) {
 871         return access("/run/systemd/seats/", F_OK) >= 0;
 872 }
 873
 874 #define DECIMAL_STR_WIDTH(x)                            \
 875         ({                                              \
 876                 typeof(x) _x_ = (x);                    \
 877                 unsigned ans = 1;                       \
 878                 while (_x_ /= 10)                       \
 879                         ans++;                          \
 880                 ans;                                    \
 881         })
 882
 883 int unlink_noerrno(const char *path);
 884
 885 #define alloca0(n)                                      \
 886         ({                                              \
 887                 char *_new_;                            \
 888                 size_t _len_ = n;                       \
 889                 _new_ = alloca(_len_);                  \
 890                 (void *) memset(_new_, 0, _len_);       \
 891         })
 892
 893 /* It's not clear what alignment glibc/gcc alloca() guarantee, hence provide a guaranteed safe version */
 894 #define alloca_align(size, align)                                       \
 895         ({                                                              \
 896                 void *_ptr_;                                            \
 897                 size_t _mask_ = (align) - 1;                            \
 898                 _ptr_ = alloca((size) + _mask_);                        \
 899                 (void*)(((uintptr_t)_ptr_ + _mask_) & ~_mask_);         \
 900         })
 901
 902 #define alloca0_align(size, align)                                      \
 903         ({                                                              \
 904                 void *_new_;                                            \
 905                 size_t _size_ = (size);                                 \
 906                 _new_ = alloca_align(_size_, (align));                  \
 907                 (void*)memset(_new_, 0, _size_);                        \
 908         })
 909
 910 #define strappenda(a, ...)                                       \
 911         ({                                                       \
 912                 int _len = strlen(a);                            \
 913                 unsigned _i;                                     \
 914                 char *_d_, *_p_;                                 \
 915                 const char *_appendees_[] = { __VA_ARGS__ };     \
 916                 for (_i = 0; _i < ELEMENTSOF(_appendees_); _i++) \
 917                         _len += strlen(_appendees_[_i]);         \
 918                 _d_ = alloca(_len + 1);                          \
 919                 _p_ = stpcpy(_d_, a);                            \
 920                 for (_i = 0; _i < ELEMENTSOF(_appendees_); _i++) \
 921                         _p_ = stpcpy(_p_, _appendees_[_i]);      \
 922                 _d_;                                             \
 923         })
 924
 925 #define procfs_file_alloca(pid, field)                                  \
 926         ({                                                              \
 927                 pid_t _pid_ = (pid);                                    \
 928                 const char *_r_;                                        \
 929                 if (_pid_ == 0) {                                       \
 930                         _r_ = ("/proc/self/" field);                    \
 931                 } else {                                                \
 932                         _r_ = alloca(strlen("/proc/") + DECIMAL_STR_MAX(pid_t) + 1 + sizeof(field)); \
 933                         sprintf((char*) _r_, "/proc/"PID_FMT"/" field, _pid_);                       \
 934                 }                                                       \
 935                 _r_;                                                    \
 936         })
 937
 938 bool id128_is_valid(const char *s) _pure_;
 939
 940 int split_pair(const char *s, const char *sep, char **l, char **r);
 941
 942 int shall_restore_state(void);
 943
 944 /**
 945  * Normal qsort requires base to be nonnull. Here were require
 946  * that only if nmemb > 0.
 947  */
 948 static inline void qsort_safe(void *base, size_t nmemb, size_t size,
 949                               int (*compar)(const void *, const void *)) {
 950         if (nmemb) {
 951                 assert(base);
 952                 qsort(base, nmemb, size, compar);
 953         }
 954 }
 955
 956 int proc_cmdline(char **ret);
 957 int parse_proc_cmdline(int (*parse_word)(const char *key, const char *value));
 958 int get_proc_cmdline_key(const char *parameter, char **value);
 959
 960 int container_get_leader(const char *machine, pid_t *pid);
 961
 962 int namespace_open(pid_t pid, int *pidns_fd, int *mntns_fd, int *netns_fd, int *root_fd);
 963 int namespace_enter(int pidns_fd, int mntns_fd, int netns_fd, int root_fd);
 964
 965 bool pid_is_alive(pid_t pid);
 966 bool pid_is_unwaited(pid_t pid);
 967
 968 int getpeercred(int fd, struct ucred *ucred);
 969 int getpeersec(int fd, char **ret);
 970
 971 int writev_safe(int fd, const struct iovec *w, int j);
 972
 973 int mkostemp_safe(char *pattern, int flags);
 974 int open_tmpfile(const char *path, int flags);
 975
 976 int fd_warn_permissions(const char *path, int fd);
 977
 978 unsigned long personality_from_string(const char *p);
 979 const char *personality_to_string(unsigned long);
 980
 981 uint64_t physical_memory(void);
 982
 983 void hexdump(FILE *f, const void *p, size_t s);
 984
 985 union file_handle_union {
 986         struct file_handle handle;
 987         char padding[sizeof(struct file_handle) + MAX_HANDLE_SZ];
 988 };
 989 #define FILE_HANDLE_INIT { .handle.handle_bytes = MAX_HANDLE_SZ }
 990
 991 int update_reboot_param_file(const char *param);
 992
 993 int umount_recursive(const char *target, int flags);
 994
 995 int bind_remount_recursive(const char *prefix, bool ro);
 996
 997 int fflush_and_check(FILE *f);
 998
 999 int tempfn_xxxxxx(const char *p, char **ret);
1000 int tempfn_random(const char *p, char **ret);
1001 int tempfn_random_child(const char *p, char **ret);
1002
1003 bool is_localhost(const char *hostname);
1004
1005 int take_password_lock(const char *root);
1006
1007 int is_symlink(const char *path);
1008 int is_dir(const char *path, bool follow);
1009
1010 int unquote_first_word(const char **p, char **ret, bool relax);
1011 int unquote_many_words(const char **p, ...) _sentinel_;
1012
1013 int free_and_strdup(char **p, const char *s);
1014
1015 int sethostname_idempotent(const char *s);
1016
1017 #define INOTIFY_EVENT_MAX (sizeof(struct inotify_event) + NAME_MAX + 1)
1018
1019 #define FOREACH_INOTIFY_EVENT(e, buffer, sz) \
1020         for ((e) = &buffer.ev;                                \
1021              (uint8_t*) (e) < (uint8_t*) (buffer.raw) + (sz); \
1022              (e) = (struct inotify_event*) ((uint8_t*) (e) + sizeof(struct inotify_event) + (e)->len))
1023
1024 union inotify_event_buffer {
1025         struct inotify_event ev;
1026         uint8_t raw[INOTIFY_EVENT_MAX];
1027 };
1028
1029 #define laccess(path, mode) faccessat(AT_FDCWD, (path), (mode), AT_SYMLINK_NOFOLLOW)
1030
1031 int ptsname_malloc(int fd, char **ret);
1032
1033 int openpt_in_namespace(pid_t pid, int flags);
1034
1035 ssize_t fgetxattrat_fake(int dirfd, const char *filename, const char *attribute, void *value, size_t size, int flags);
1036
1037 int fd_setcrtime(int fd, usec_t usec);
1038 int fd_getcrtime(int fd, usec_t *usec);
1039 int path_getcrtime(const char *p, usec_t *usec);
1040 int fd_getcrtime_at(int dirfd, const char *name, usec_t *usec, int flags);
1041
1042 int same_fd(int a, int b);
1043
1044 int chattr_fd(int fd, bool b, unsigned mask);
1045 int chattr_path(const char *p, bool b, unsigned mask);
1046
1047 int read_attr_fd(int fd, unsigned *ret);
1048 int read_attr_path(const char *p, unsigned *ret);
1049
1050 typedef struct LockFile {
1051         char *path;
1052         int fd;
1053         int operation;
1054 } LockFile;
1055
1056 int make_lock_file(const char *p, int operation, LockFile *ret);
1057 int make_lock_file_for(const char *p, int operation, LockFile *ret);
1058 void release_lock_file(LockFile *f);
1059
1060 #define _cleanup_release_lock_file_ _cleanup_(release_lock_file)
1061
1062 #define LOCK_FILE_INIT { .fd = -1, .path = NULL }
1063
1064 #define RLIMIT_MAKE_CONST(lim) ((struct rlimit) { lim, lim })