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 bool image_name_is_valid(const char *s) _pure_;
 554
 555 char* strshorten(char *s, size_t l);
 556
 557 int terminal_vhangup_fd(int fd);
 558 int terminal_vhangup(const char *name);
 559
 560 int vt_disallocate(const char *name);
 561
 562 int symlink_atomic(const char *from, const char *to);
 563 int mknod_atomic(const char *path, mode_t mode, dev_t dev);
 564 int mkfifo_atomic(const char *path, mode_t mode);
 565
 566 int fchmod_umask(int fd, mode_t mode);
 567
 568 bool display_is_local(const char *display) _pure_;
 569 int socket_from_display(const char *display, char **path);
 570
 571 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
 572 int get_group_creds(const char **groupname, gid_t *gid);
 573
 574 int in_gid(gid_t gid);
 575 int in_group(const char *name);
 576
 577 char* uid_to_name(uid_t uid);
 578 char* gid_to_name(gid_t gid);
 579
 580 int glob_exists(const char *path);
 581 int glob_extend(char ***strv, const char *path);
 582
 583 int dirent_ensure_type(DIR *d, struct dirent *de);
 584
 585 int get_files_in_directory(const char *path, char ***list);
 586
 587 char *strjoin(const char *x, ...) _sentinel_;
 588
 589 bool is_main_thread(void);
 590
 591 static inline bool _pure_ in_charset(const char *s, const char* charset) {
 592         assert(s);
 593         assert(charset);
 594         return s[strspn(s, charset)] == '\0';
 595 }
 596
 597 int block_get_whole_disk(dev_t d, dev_t *ret);
 598
 599 #define NULSTR_FOREACH(i, l)                                    \
 600         for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
 601
 602 #define NULSTR_FOREACH_PAIR(i, j, l)                             \
 603         for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
 604
 605 int ioprio_class_to_string_alloc(int i, char **s);
 606 int ioprio_class_from_string(const char *s);
 607
 608 const char *sigchld_code_to_string(int i) _const_;
 609 int sigchld_code_from_string(const char *s) _pure_;
 610
 611 int log_facility_unshifted_to_string_alloc(int i, char **s);
 612 int log_facility_unshifted_from_string(const char *s);
 613
 614 int log_level_to_string_alloc(int i, char **s);
 615 int log_level_from_string(const char *s);
 616
 617 int sched_policy_to_string_alloc(int i, char **s);
 618 int sched_policy_from_string(const char *s);
 619
 620 const char *rlimit_to_string(int i) _const_;
 621 int rlimit_from_string(const char *s) _pure_;
 622
 623 int ip_tos_to_string_alloc(int i, char **s);
 624 int ip_tos_from_string(const char *s);
 625
 626 const char *signal_to_string(int i) _const_;
 627 int signal_from_string(const char *s) _pure_;
 628
 629 int signal_from_string_try_harder(const char *s);
 630
 631 extern int saved_argc;
 632 extern char **saved_argv;
 633
 634 bool kexec_loaded(void);
 635
 636 int prot_from_flags(int flags) _const_;
 637
 638 char *format_bytes(char *buf, size_t l, off_t t);
 639
 640 int fd_wait_for_event(int fd, int event, usec_t timeout);
 641
 642 void* memdup(const void *p, size_t l) _alloc_(2);
 643
 644 int is_kernel_thread(pid_t pid);
 645
 646 int fd_inc_sndbuf(int fd, size_t n);
 647 int fd_inc_rcvbuf(int fd, size_t n);
 648
 649 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
 650
 651 int setrlimit_closest(int resource, const struct rlimit *rlim);
 652
 653 int getenv_for_pid(pid_t pid, const char *field, char **_value);
 654
 655 bool is_valid_documentation_url(const char *url) _pure_;
 656
 657 bool in_initrd(void);
 658
 659 void warn_melody(void);
 660
 661 int get_home_dir(char **ret);
 662 int get_shell(char **_ret);
 663
 664 static inline void freep(void *p) {
 665         free(*(void**) p);
 666 }
 667
 668 #define DEFINE_TRIVIAL_CLEANUP_FUNC(type, func)                 \
 669         static inline void func##p(type *p) {                   \
 670                 if (*p)                                         \
 671                         func(*p);                               \
 672         }                                                       \
 673         struct __useless_struct_to_allow_trailing_semicolon__
 674
 675 static inline void closep(int *fd) {
 676         safe_close(*fd);
 677 }
 678
 679 static inline void umaskp(mode_t *u) {
 680         umask(*u);
 681 }
 682
 683 static inline void close_pairp(int (*p)[2]) {
 684         safe_close_pair(*p);
 685 }
 686
 687 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, fclose);
 688 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, pclose);
 689 DEFINE_TRIVIAL_CLEANUP_FUNC(DIR*, closedir);
 690 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, endmntent);
 691
 692 #define _cleanup_free_ _cleanup_(freep)
 693 #define _cleanup_close_ _cleanup_(closep)
 694 #define _cleanup_umask_ _cleanup_(umaskp)
 695 #define _cleanup_globfree_ _cleanup_(globfree)
 696 #define _cleanup_fclose_ _cleanup_(fclosep)
 697 #define _cleanup_pclose_ _cleanup_(pclosep)
 698 #define _cleanup_closedir_ _cleanup_(closedirp)
 699 #define _cleanup_endmntent_ _cleanup_(endmntentp)
 700 #define _cleanup_close_pair_ _cleanup_(close_pairp)
 701
 702 _malloc_  _alloc_(1, 2) static inline void *malloc_multiply(size_t a, size_t b) {
 703         if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
 704                 return NULL;
 705
 706         return malloc(a * b);
 707 }
 708
 709 _alloc_(2, 3) static inline void *realloc_multiply(void *p, size_t a, size_t b) {
 710         if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
 711                 return NULL;
 712
 713         return realloc(p, a * b);
 714 }
 715
 716 _alloc_(2, 3) static inline void *memdup_multiply(const void *p, size_t a, size_t b) {
 717         if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
 718                 return NULL;
 719
 720         return memdup(p, a * b);
 721 }
 722
 723 bool filename_is_valid(const char *p) _pure_;
 724 bool path_is_safe(const char *p) _pure_;
 725 bool string_is_safe(const char *p) _pure_;
 726 bool string_has_cc(const char *p, const char *ok) _pure_;
 727
 728 /**
 729  * Check if a string contains any glob patterns.
 730  */
 731 _pure_ static inline bool string_is_glob(const char *p) {
 732         return !!strpbrk(p, GLOB_CHARS);
 733 }
 734
 735 void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
 736                  int (*compar) (const void *, const void *, void *),
 737                  void *arg);
 738
 739 bool is_locale_utf8(void);
 740
 741 typedef enum DrawSpecialChar {
 742         DRAW_TREE_VERTICAL,
 743         DRAW_TREE_BRANCH,
 744         DRAW_TREE_RIGHT,
 745         DRAW_TREE_SPACE,
 746         DRAW_TRIANGULAR_BULLET,
 747         DRAW_BLACK_CIRCLE,
 748         DRAW_ARROW,
 749         DRAW_DASH,
 750         _DRAW_SPECIAL_CHAR_MAX
 751 } DrawSpecialChar;
 752
 753 const char *draw_special_char(DrawSpecialChar ch);
 754
 755 char *strreplace(const char *text, const char *old_string, const char *new_string);
 756
 757 char *strip_tab_ansi(char **p, size_t *l);
 758
 759 int on_ac_power(void);
 760
 761 int search_and_fopen(const char *path, const char *mode, const char *root, const char **search, FILE **_f);
 762 int search_and_fopen_nulstr(const char *path, const char *mode, const char *root, const char *search, FILE **_f);
 763
 764 #define FOREACH_LINE(line, f, on_error)                         \
 765         for (;;)                                                \
 766                 if (!fgets(line, sizeof(line), f)) {            \
 767                         if (ferror(f)) {                        \
 768                                 on_error;                       \
 769                         }                                       \
 770                         break;                                  \
 771                 } else
 772
 773 #define FOREACH_DIRENT(de, d, on_error)                                 \
 774         for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d))   \
 775                 if (!de) {                                              \
 776                         if (errno > 0) {                                \
 777                                 on_error;                               \
 778                         }                                               \
 779                         break;                                          \
 780                 } else if (hidden_file((de)->d_name))                   \
 781                         continue;                                       \
 782                 else
 783
 784 #define FOREACH_DIRENT_ALL(de, d, on_error)                             \
 785         for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d))   \
 786                 if (!de) {                                              \
 787                         if (errno > 0) {                                \
 788                                 on_error;                               \
 789                         }                                               \
 790                         break;                                          \
 791                 } else
 792
 793 static inline void *mempset(void *s, int c, size_t n) {
 794         memset(s, c, n);
 795         return (uint8_t*)s + n;
 796 }
 797
 798 char *hexmem(const void *p, size_t l);
 799 void *unhexmem(const char *p, size_t l);
 800
 801 char *strextend(char **x, ...) _sentinel_;
 802 char *strrep(const char *s, unsigned n);
 803
 804 void* greedy_realloc(void **p, size_t *allocated, size_t need, size_t size);
 805 void* greedy_realloc0(void **p, size_t *allocated, size_t need, size_t size);
 806 #define GREEDY_REALLOC(array, allocated, need)                          \
 807         greedy_realloc((void**) &(array), &(allocated), (need), sizeof((array)[0]))
 808
 809 #define GREEDY_REALLOC0(array, allocated, need)                         \
 810         greedy_realloc0((void**) &(array), &(allocated), (need), sizeof((array)[0]))
 811
 812 static inline void _reset_errno_(int *saved_errno) {
 813         errno = *saved_errno;
 814 }
 815
 816 #define PROTECT_ERRNO _cleanup_(_reset_errno_) __attribute__((unused)) int _saved_errno_ = errno
 817
 818 static inline int negative_errno(void) {
 819         /* This helper should be used to shut up gcc if you know 'errno' is
 820          * negative. Instead of "return -errno;", use "return negative_errno();"
 821          * It will suppress bogus gcc warnings in case it assumes 'errno' might
 822          * be 0 and thus the caller's error-handling might not be triggered. */
 823         assert_return(errno > 0, -EINVAL);
 824         return -errno;
 825 }
 826
 827 struct _umask_struct_ {
 828         mode_t mask;
 829         bool quit;
 830 };
 831
 832 static inline void _reset_umask_(struct _umask_struct_ *s) {
 833         umask(s->mask);
 834 };
 835
 836 #define RUN_WITH_UMASK(mask)                                            \
 837         for (_cleanup_(_reset_umask_) struct _umask_struct_ _saved_umask_ = { umask(mask), false }; \
 838              !_saved_umask_.quit ;                                      \
 839              _saved_umask_.quit = true)
 840
 841 static inline unsigned u64log2(uint64_t n) {
 842 #if __SIZEOF_LONG_LONG__ == 8
 843         return (n > 1) ? (unsigned) __builtin_clzll(n) ^ 63U : 0;
 844 #else
 845 #error "Wut?"
 846 #endif
 847 }
 848
 849 static inline unsigned u32ctz(uint32_t n) {
 850 #if __SIZEOF_INT__ == 4
 851         return __builtin_ctz(n);
 852 #else
 853 #error "Wut?"
 854 #endif
 855 }
 856
 857 static inline int log2i(int x) {
 858         assert(x > 0);
 859
 860         return __SIZEOF_INT__ * 8 - __builtin_clz(x) - 1;
 861 }
 862
 863 static inline unsigned log2u(unsigned x) {
 864         assert(x > 0);
 865
 866         return sizeof(unsigned) * 8 - __builtin_clz(x) - 1;
 867 }
 868
 869 static inline unsigned log2u_round_up(unsigned x) {
 870         assert(x > 0);
 871
 872         if (x == 1)
 873                 return 0;
 874
 875         return log2u(x - 1) + 1;
 876 }
 877
 878 static inline bool logind_running(void) {
 879         return access("/run/systemd/seats/", F_OK) >= 0;
 880 }
 881
 882 #define DECIMAL_STR_WIDTH(x)                            \
 883         ({                                              \
 884                 typeof(x) _x_ = (x);                    \
 885                 unsigned ans = 1;                       \
 886                 while (_x_ /= 10)                       \
 887                         ans++;                          \
 888                 ans;                                    \
 889         })
 890
 891 int unlink_noerrno(const char *path);
 892
 893 #define alloca0(n)                                      \
 894         ({                                              \
 895                 char *_new_;                            \
 896                 size_t _len_ = n;                       \
 897                 _new_ = alloca(_len_);                  \
 898                 (void *) memset(_new_, 0, _len_);       \
 899         })
 900
 901 /* It's not clear what alignment glibc/gcc alloca() guarantee, hence provide a guaranteed safe version */
 902 #define alloca_align(size, align)                                       \
 903         ({                                                              \
 904                 void *_ptr_;                                            \
 905                 size_t _mask_ = (align) - 1;                            \
 906                 _ptr_ = alloca((size) + _mask_);                        \
 907                 (void*)(((uintptr_t)_ptr_ + _mask_) & ~_mask_);         \
 908         })
 909
 910 #define alloca0_align(size, align)                                      \
 911         ({                                                              \
 912                 void *_new_;                                            \
 913                 size_t _size_ = (size);                                 \
 914                 _new_ = alloca_align(_size_, (align));                  \
 915                 (void*)memset(_new_, 0, _size_);                        \
 916         })
 917
 918 #define strappenda(a, ...)                                       \
 919         ({                                                       \
 920                 int _len = strlen(a);                            \
 921                 unsigned _i;                                     \
 922                 char *_d_, *_p_;                                 \
 923                 const char *_appendees_[] = { __VA_ARGS__ };     \
 924                 for (_i = 0; _i < ELEMENTSOF(_appendees_); _i++) \
 925                         _len += strlen(_appendees_[_i]);         \
 926                 _d_ = alloca(_len + 1);                          \
 927                 _p_ = stpcpy(_d_, a);                            \
 928                 for (_i = 0; _i < ELEMENTSOF(_appendees_); _i++) \
 929                         _p_ = stpcpy(_p_, _appendees_[_i]);      \
 930                 _d_;                                             \
 931         })
 932
 933 #define procfs_file_alloca(pid, field)                                  \
 934         ({                                                              \
 935                 pid_t _pid_ = (pid);                                    \
 936                 const char *_r_;                                        \
 937                 if (_pid_ == 0) {                                       \
 938                         _r_ = ("/proc/self/" field);                    \
 939                 } else {                                                \
 940                         _r_ = alloca(strlen("/proc/") + DECIMAL_STR_MAX(pid_t) + 1 + sizeof(field)); \
 941                         sprintf((char*) _r_, "/proc/"PID_FMT"/" field, _pid_);                       \
 942                 }                                                       \
 943                 _r_;                                                    \
 944         })
 945
 946 struct _locale_struct_ {
 947         locale_t saved_locale;
 948         locale_t new_locale;
 949         bool quit;
 950 };
 951
 952 static inline void _reset_locale_(struct _locale_struct_ *s) {
 953         PROTECT_ERRNO;
 954         if (s->saved_locale != (locale_t) 0)
 955                 uselocale(s->saved_locale);
 956         if (s->new_locale != (locale_t) 0)
 957                 freelocale(s->new_locale);
 958 }
 959
 960 #define RUN_WITH_LOCALE(mask, loc) \
 961         for (_cleanup_(_reset_locale_) struct _locale_struct_ _saved_locale_ = { (locale_t) 0, (locale_t) 0, false }; \
 962              ({                                                         \
 963                      if (!_saved_locale_.quit) {                        \
 964                              PROTECT_ERRNO;                             \
 965                              _saved_locale_.new_locale = newlocale((mask), (loc), (locale_t) 0); \
 966                              if (_saved_locale_.new_locale != (locale_t) 0)     \
 967                                      _saved_locale_.saved_locale = uselocale(_saved_locale_.new_locale); \
 968                      }                                                  \
 969                      !_saved_locale_.quit; }) ;                         \
 970              _saved_locale_.quit = true)
 971
 972 bool id128_is_valid(const char *s) _pure_;
 973
 974 int split_pair(const char *s, const char *sep, char **l, char **r);
 975
 976 int shall_restore_state(void);
 977
 978 /**
 979  * Normal qsort requires base to be nonnull. Here were require
 980  * that only if nmemb > 0.
 981  */
 982 static inline void qsort_safe(void *base, size_t nmemb, size_t size,
 983                               int (*compar)(const void *, const void *)) {
 984         if (nmemb) {
 985                 assert(base);
 986                 qsort(base, nmemb, size, compar);
 987         }
 988 }
 989
 990 int proc_cmdline(char **ret);
 991 int parse_proc_cmdline(int (*parse_word)(const char *key, const char *value));
 992 int get_proc_cmdline_key(const char *parameter, char **value);
 993
 994 int container_get_leader(const char *machine, pid_t *pid);
 995
 996 int namespace_open(pid_t pid, int *pidns_fd, int *mntns_fd, int *netns_fd, int *root_fd);
 997 int namespace_enter(int pidns_fd, int mntns_fd, int netns_fd, int root_fd);
 998
 999 bool pid_is_alive(pid_t pid);
1000 bool pid_is_unwaited(pid_t pid);
1001
1002 int getpeercred(int fd, struct ucred *ucred);
1003 int getpeersec(int fd, char **ret);
1004
1005 int writev_safe(int fd, const struct iovec *w, int j);
1006
1007 int mkostemp_safe(char *pattern, int flags);
1008 int open_tmpfile(const char *path, int flags);
1009
1010 int fd_warn_permissions(const char *path, int fd);
1011
1012 unsigned long personality_from_string(const char *p);
1013 const char *personality_to_string(unsigned long);
1014
1015 uint64_t physical_memory(void);
1016
1017 void hexdump(FILE *f, const void *p, size_t s);
1018
1019 union file_handle_union {
1020         struct file_handle handle;
1021         char padding[sizeof(struct file_handle) + MAX_HANDLE_SZ];
1022 };
1023
1024 int update_reboot_param_file(const char *param);
1025
1026 int umount_recursive(const char *target, int flags);
1027
1028 int bind_remount_recursive(const char *prefix, bool ro);
1029
1030 int fflush_and_check(FILE *f);
1031
1032 int tempfn_xxxxxx(const char *p, char **ret);
1033 int tempfn_random(const char *p, char **ret);
1034 int tempfn_random_child(const char *p, char **ret);
1035
1036 bool is_localhost(const char *hostname);
1037
1038 int take_password_lock(const char *root);
1039
1040 int is_symlink(const char *path);
1041 int is_dir(const char *path, bool follow);
1042
1043 int unquote_first_word(const char **p, char **ret, bool relax);
1044 int unquote_many_words(const char **p, ...) _sentinel_;
1045
1046 int free_and_strdup(char **p, const char *s);
1047
1048 int sethostname_idempotent(const char *s);
1049
1050 #define INOTIFY_EVENT_MAX (sizeof(struct inotify_event) + NAME_MAX + 1)
1051
1052 #define FOREACH_INOTIFY_EVENT(e, buffer, sz) \
1053         for ((e) = &buffer.ev;                                \
1054              (uint8_t*) (e) < (uint8_t*) (buffer.raw) + (sz); \
1055              (e) = (struct inotify_event*) ((uint8_t*) (e) + sizeof(struct inotify_event) + (e)->len))
1056
1057 union inotify_event_buffer {
1058         struct inotify_event ev;
1059         uint8_t raw[INOTIFY_EVENT_MAX];
1060 };
1061
1062 #define laccess(path, mode) faccessat(AT_FDCWD, (path), (mode), AT_SYMLINK_NOFOLLOW)
1063
1064 int ptsname_malloc(int fd, char **ret);
1065
1066 int openpt_in_namespace(pid_t pid, int flags);
1067
1068 ssize_t fgetxattrat_fake(int dirfd, const char *filename, const char *attribute, void *value, size_t size, int flags);
1069
1070 int fd_setcrtime(int fd, usec_t usec);
1071 int fd_getcrtime(int fd, usec_t *usec);
1072 int path_getcrtime(const char *p, usec_t *usec);
1073 int fd_getcrtime_at(int dirfd, const char *name, usec_t *usec, int flags);
1074
1075 int same_fd(int a, int b);
1076
1077 int chattr_fd(int fd, bool b, unsigned mask);
1078 int chattr_path(const char *p, bool b, unsigned mask);
1079
1080 int read_attr_fd(int fd, unsigned *ret);
1081 int read_attr_path(const char *p, unsigned *ret);
1082
1083 #define RLIMIT_MAKE_CONST(lim) ((struct rlimit) { lim, lim })