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