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 int get_starttime_of_pid(pid_t pid, unsigned long long *st);
 267
 268 char *strappend(const char *s, const char *suffix);
 269 char *strnappend(const char *s, const char *suffix, size_t length);
 270
 271 char *replace_env(const char *format, char **env);
 272 char **replace_env_argv(char **argv, char **env);
 273
 274 int readlinkat_malloc(int fd, const char *p, char **ret);
 275 int readlink_malloc(const char *p, char **r);
 276 int readlink_value(const char *p, char **ret);
 277 int readlink_and_make_absolute(const char *p, char **r);
 278 int readlink_and_canonicalize(const char *p, char **r);
 279
 280 int reset_all_signal_handlers(void);
 281 int reset_signal_mask(void);
 282
 283 char *strstrip(char *s);
 284 char *delete_chars(char *s, const char *bad);
 285 char *truncate_nl(char *s);
 286
 287 char *file_in_same_dir(const char *path, const char *filename);
 288
 289 int rmdir_parents(const char *path, const char *stop);
 290
 291 int get_process_state(pid_t pid);
 292 int get_process_comm(pid_t pid, char **name);
 293 int get_process_cmdline(pid_t pid, size_t max_length, bool comm_fallback, char **line);
 294 int get_process_exe(pid_t pid, char **name);
 295 int get_process_uid(pid_t pid, uid_t *uid);
 296 int get_process_gid(pid_t pid, gid_t *gid);
 297 int get_process_capeff(pid_t pid, char **capeff);
 298 int get_process_cwd(pid_t pid, char **cwd);
 299 int get_process_root(pid_t pid, char **root);
 300 int get_process_environ(pid_t pid, char **environ);
 301
 302 char hexchar(int x) _const_;
 303 int unhexchar(char c) _const_;
 304 char octchar(int x) _const_;
 305 int unoctchar(char c) _const_;
 306 char decchar(int x) _const_;
 307 int undecchar(char c) _const_;
 308
 309 char *cescape(const char *s);
 310 char *cunescape(const char *s);
 311 char *cunescape_length(const char *s, size_t length);
 312 char *cunescape_length_with_prefix(const char *s, size_t length, const char *prefix);
 313
 314 char *xescape(const char *s, const char *bad);
 315
 316 char *ascii_strlower(char *path);
 317
 318 bool dirent_is_file(const struct dirent *de) _pure_;
 319 bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix) _pure_;
 320
 321 bool ignore_file(const char *filename) _pure_;
 322
 323 bool chars_intersect(const char *a, const char *b) _pure_;
 324
 325 int make_stdio(int fd);
 326 int make_null_stdio(void);
 327 int make_console_stdio(void);
 328
 329 int dev_urandom(void *p, size_t n);
 330 void random_bytes(void *p, size_t n);
 331 void initialize_srand(void);
 332
 333 static inline uint64_t random_u64(void) {
 334         uint64_t u;
 335         random_bytes(&u, sizeof(u));
 336         return u;
 337 }
 338
 339 static inline uint32_t random_u32(void) {
 340         uint32_t u;
 341         random_bytes(&u, sizeof(u));
 342         return u;
 343 }
 344
 345 /* For basic lookup tables with strictly enumerated entries */
 346 #define __DEFINE_STRING_TABLE_LOOKUP(name,type,scope)                   \
 347         scope const char *name##_to_string(type i) {                    \
 348                 if (i < 0 || i >= (type) ELEMENTSOF(name##_table))      \
 349                         return NULL;                                    \
 350                 return name##_table[i];                                 \
 351         }                                                               \
 352         scope type name##_from_string(const char *s) {                  \
 353                 type i;                                                 \
 354                 if (!s)                                                 \
 355                         return (type) -1;                               \
 356                 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++)    \
 357                         if (name##_table[i] &&                          \
 358                             streq(name##_table[i], s))                  \
 359                                 return i;                               \
 360                 return (type) -1;                                       \
 361         }                                                               \
 362         struct __useless_struct_to_allow_trailing_semicolon__
 363
 364 #define DEFINE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,)
 365 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,static)
 366
 367 /* For string conversions where numbers are also acceptable */
 368 #define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max)         \
 369         int name##_to_string_alloc(type i, char **str) {                \
 370                 char *s;                                                \
 371                 int r;                                                  \
 372                 if (i < 0 || i > max)                                   \
 373                         return -ERANGE;                                 \
 374                 if (i < (type) ELEMENTSOF(name##_table)) {              \
 375                         s = strdup(name##_table[i]);                    \
 376                         if (!s)                                         \
 377                                 return log_oom();                       \
 378                 } else {                                                \
 379                         r = asprintf(&s, "%u", i);                      \
 380                         if (r < 0)                                      \
 381                                 return log_oom();                       \
 382                 }                                                       \
 383                 *str = s;                                               \
 384                 return 0;                                               \
 385         }                                                               \
 386         type name##_from_string(const char *s) {                        \
 387                 type i;                                                 \
 388                 unsigned u = 0;                                         \
 389                 assert(s);                                              \
 390                 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++)    \
 391                         if (name##_table[i] &&                          \
 392                             streq(name##_table[i], s))                  \
 393                                 return i;                               \
 394                 if (safe_atou(s, &u) >= 0 && u <= max)                  \
 395                         return (type) u;                                \
 396                 return (type) -1;                                       \
 397         }                                                               \
 398         struct __useless_struct_to_allow_trailing_semicolon__
 399
 400 int fd_nonblock(int fd, bool nonblock);
 401 int fd_cloexec(int fd, bool cloexec);
 402
 403 int close_all_fds(const int except[], unsigned n_except);
 404
 405 bool fstype_is_network(const char *fstype);
 406
 407 int chvt(int vt);
 408
 409 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
 410 int ask_char(char *ret, const char *replies, const char *text, ...) _printf_(3, 4);
 411 int ask_string(char **ret, const char *text, ...) _printf_(2, 3);
 412
 413 int reset_terminal_fd(int fd, bool switch_to_text);
 414 int reset_terminal(const char *name);
 415
 416 int open_terminal(const char *name, int mode);
 417 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
 418 int release_terminal(void);
 419
 420 int flush_fd(int fd);
 421
 422 int ignore_signals(int sig, ...);
 423 int default_signals(int sig, ...);
 424 int sigaction_many(const struct sigaction *sa, ...);
 425
 426 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
 427
 428 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
 429 ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
 430
 431 bool is_device_path(const char *path);
 432
 433 int dir_is_empty(const char *path);
 434 char* dirname_malloc(const char *path);
 435
 436 void rename_process(const char name[8]);
 437
 438 void sigset_add_many(sigset_t *ss, ...);
 439 int sigprocmask_many(int how, ...);
 440
 441 bool hostname_is_set(void);
 442
 443 char* lookup_uid(uid_t uid);
 444 char* gethostname_malloc(void);
 445 char* getlogname_malloc(void);
 446 char* getusername_malloc(void);
 447
 448 int getttyname_malloc(int fd, char **r);
 449 int getttyname_harder(int fd, char **r);
 450
 451 int get_ctty_devnr(pid_t pid, dev_t *d);
 452 int get_ctty(pid_t, dev_t *_devnr, char **r);
 453
 454 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
 455 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
 456
 457 int rm_rf_children(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
 458 int rm_rf_children_dangerous(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
 459 int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
 460 int rm_rf_dangerous(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
 461
 462 int pipe_eof(int fd);
 463
 464 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
 465
 466 int status_vprintf(const char *status, bool ellipse, bool ephemeral, const char *format, va_list ap) _printf_(4,0);
 467 int status_printf(const char *status, bool ellipse, bool ephemeral, const char *format, ...) _printf_(4,5);
 468
 469 int fd_columns(int fd);
 470 unsigned columns(void);
 471 int fd_lines(int fd);
 472 unsigned lines(void);
 473 void columns_lines_cache_reset(int _unused_ signum);
 474
 475 bool on_tty(void);
 476
 477 static inline const char *ansi_highlight(void) {
 478         return on_tty() ? ANSI_HIGHLIGHT_ON : "";
 479 }
 480
 481 static inline const char *ansi_highlight_red(void) {
 482         return on_tty() ? ANSI_HIGHLIGHT_RED_ON : "";
 483 }
 484
 485 static inline const char *ansi_highlight_green(void) {
 486         return on_tty() ? ANSI_HIGHLIGHT_GREEN_ON : "";
 487 }
 488
 489 static inline const char *ansi_highlight_yellow(void) {
 490         return on_tty() ? ANSI_HIGHLIGHT_YELLOW_ON : "";
 491 }
 492
 493 static inline const char *ansi_highlight_blue(void) {
 494         return on_tty() ? ANSI_HIGHLIGHT_BLUE_ON : "";
 495 }
 496
 497 static inline const char *ansi_highlight_off(void) {
 498         return on_tty() ? ANSI_HIGHLIGHT_OFF : "";
 499 }
 500
 501 int files_same(const char *filea, const char *fileb);
 502
 503 int running_in_chroot(void);
 504
 505 char *ellipsize(const char *s, size_t length, unsigned percent);
 506                                    /* bytes                 columns */
 507 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
 508
 509 int touch_file(const char *path, bool parents, usec_t stamp, uid_t uid, gid_t gid, mode_t mode);
 510 int touch(const char *path);
 511
 512 char *unquote(const char *s, const char *quotes);
 513 char *normalize_env_assignment(const char *s);
 514
 515 int wait_for_terminate(pid_t pid, siginfo_t *status);
 516 int wait_for_terminate_and_warn(const char *name, pid_t pid);
 517
 518 noreturn void freeze(void);
 519
 520 bool null_or_empty(struct stat *st) _pure_;
 521 int null_or_empty_path(const char *fn);
 522 int null_or_empty_fd(int fd);
 523
 524 DIR *xopendirat(int dirfd, const char *name, int flags);
 525
 526 char *fstab_node_to_udev_node(const char *p);
 527
 528 char *resolve_dev_console(char **active);
 529 bool tty_is_vc(const char *tty);
 530 bool tty_is_vc_resolve(const char *tty);
 531 bool tty_is_console(const char *tty) _pure_;
 532 int vtnr_from_tty(const char *tty);
 533 const char *default_term_for_tty(const char *tty);
 534
 535 void execute_directory(const char *directory, DIR *_d, usec_t timeout, char *argv[]);
 536
 537 int kill_and_sigcont(pid_t pid, int sig);
 538
 539 bool nulstr_contains(const char*nulstr, const char *needle);
 540
 541 bool plymouth_running(void);
 542
 543 bool hostname_is_valid(const char *s) _pure_;
 544 char* hostname_cleanup(char *s, bool lowercase);
 545
 546 bool machine_name_is_valid(const char *s) _pure_;
 547
 548 char* strshorten(char *s, size_t l);
 549
 550 int terminal_vhangup_fd(int fd);
 551 int terminal_vhangup(const char *name);
 552
 553 int vt_disallocate(const char *name);
 554
 555 int symlink_atomic(const char *from, const char *to);
 556 int mknod_atomic(const char *path, mode_t mode, dev_t dev);
 557 int mkfifo_atomic(const char *path, mode_t mode);
 558
 559 int fchmod_umask(int fd, mode_t mode);
 560
 561 bool display_is_local(const char *display) _pure_;
 562 int socket_from_display(const char *display, char **path);
 563
 564 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
 565 int get_group_creds(const char **groupname, gid_t *gid);
 566
 567 int in_gid(gid_t gid);
 568 int in_group(const char *name);
 569
 570 char* uid_to_name(uid_t uid);
 571 char* gid_to_name(gid_t gid);
 572
 573 int glob_exists(const char *path);
 574 int glob_extend(char ***strv, const char *path);
 575
 576 int dirent_ensure_type(DIR *d, struct dirent *de);
 577
 578 int get_files_in_directory(const char *path, char ***list);
 579
 580 char *strjoin(const char *x, ...) _sentinel_;
 581
 582 bool is_main_thread(void);
 583
 584 static inline bool _pure_ in_charset(const char *s, const char* charset) {
 585         assert(s);
 586         assert(charset);
 587         return s[strspn(s, charset)] == '\0';
 588 }
 589
 590 int block_get_whole_disk(dev_t d, dev_t *ret);
 591
 592 #define NULSTR_FOREACH(i, l)                                    \
 593         for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
 594
 595 #define NULSTR_FOREACH_PAIR(i, j, l)                             \
 596         for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
 597
 598 int ioprio_class_to_string_alloc(int i, char **s);
 599 int ioprio_class_from_string(const char *s);
 600
 601 const char *sigchld_code_to_string(int i) _const_;
 602 int sigchld_code_from_string(const char *s) _pure_;
 603
 604 int log_facility_unshifted_to_string_alloc(int i, char **s);
 605 int log_facility_unshifted_from_string(const char *s);
 606
 607 int log_level_to_string_alloc(int i, char **s);
 608 int log_level_from_string(const char *s);
 609
 610 int sched_policy_to_string_alloc(int i, char **s);
 611 int sched_policy_from_string(const char *s);
 612
 613 const char *rlimit_to_string(int i) _const_;
 614 int rlimit_from_string(const char *s) _pure_;
 615
 616 int ip_tos_to_string_alloc(int i, char **s);
 617 int ip_tos_from_string(const char *s);
 618
 619 const char *signal_to_string(int i) _const_;
 620 int signal_from_string(const char *s) _pure_;
 621
 622 int signal_from_string_try_harder(const char *s);
 623
 624 extern int saved_argc;
 625 extern char **saved_argv;
 626
 627 bool kexec_loaded(void);
 628
 629 int prot_from_flags(int flags) _const_;
 630
 631 char *format_bytes(char *buf, size_t l, off_t t);
 632
 633 int fd_wait_for_event(int fd, int event, usec_t timeout);
 634
 635 void* memdup(const void *p, size_t l) _alloc_(2);
 636
 637 int is_kernel_thread(pid_t pid);
 638
 639 int fd_inc_sndbuf(int fd, size_t n);
 640 int fd_inc_rcvbuf(int fd, size_t n);
 641
 642 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
 643
 644 int setrlimit_closest(int resource, const struct rlimit *rlim);
 645
 646 int getenv_for_pid(pid_t pid, const char *field, char **_value);
 647
 648 bool is_valid_documentation_url(const char *url) _pure_;
 649
 650 bool in_initrd(void);
 651
 652 void warn_melody(void);
 653
 654 int get_home_dir(char **ret);
 655 int get_shell(char **_ret);
 656
 657 static inline void freep(void *p) {
 658         free(*(void**) p);
 659 }
 660
 661 #define DEFINE_TRIVIAL_CLEANUP_FUNC(type, func)                 \
 662         static inline void func##p(type *p) {                   \
 663                 if (*p)                                         \
 664                         func(*p);                               \
 665         }                                                       \
 666         struct __useless_struct_to_allow_trailing_semicolon__
 667
 668 static inline void closep(int *fd) {
 669         safe_close(*fd);
 670 }
 671
 672 static inline void umaskp(mode_t *u) {
 673         umask(*u);
 674 }
 675
 676 static inline void close_pairp(int (*p)[2]) {
 677         safe_close_pair(*p);
 678 }
 679
 680 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, fclose);
 681 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, pclose);
 682 DEFINE_TRIVIAL_CLEANUP_FUNC(DIR*, closedir);
 683 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, endmntent);
 684
 685 #define _cleanup_free_ _cleanup_(freep)
 686 #define _cleanup_close_ _cleanup_(closep)
 687 #define _cleanup_umask_ _cleanup_(umaskp)
 688 #define _cleanup_globfree_ _cleanup_(globfree)
 689 #define _cleanup_fclose_ _cleanup_(fclosep)
 690 #define _cleanup_pclose_ _cleanup_(pclosep)
 691 #define _cleanup_closedir_ _cleanup_(closedirp)
 692 #define _cleanup_endmntent_ _cleanup_(endmntentp)
 693 #define _cleanup_close_pair_ _cleanup_(close_pairp)
 694
 695 _malloc_  _alloc_(1, 2) static inline void *malloc_multiply(size_t a, size_t b) {
 696         if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
 697                 return NULL;
 698
 699         return malloc(a * b);
 700 }
 701
 702 _alloc_(2, 3) static inline void *realloc_multiply(void *p, size_t a, size_t b) {
 703         if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
 704                 return NULL;
 705
 706         return realloc(p, a * b);
 707 }
 708
 709 _alloc_(2, 3) static inline void *memdup_multiply(const void *p, size_t a, size_t b) {
 710         if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
 711                 return NULL;
 712
 713         return memdup(p, a * b);
 714 }
 715
 716 bool filename_is_safe(const char *p) _pure_;
 717 bool path_is_safe(const char *p) _pure_;
 718 bool string_is_safe(const char *p) _pure_;
 719 bool string_has_cc(const char *p, const char *ok) _pure_;
 720
 721 /**
 722  * Check if a string contains any glob patterns.
 723  */
 724 _pure_ static inline bool string_is_glob(const char *p) {
 725         return !!strpbrk(p, GLOB_CHARS);
 726 }
 727
 728 void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
 729                  int (*compar) (const void *, const void *, void *),
 730                  void *arg);
 731
 732 bool is_locale_utf8(void);
 733
 734 typedef enum DrawSpecialChar {
 735         DRAW_TREE_VERTICAL,
 736         DRAW_TREE_BRANCH,
 737         DRAW_TREE_RIGHT,
 738         DRAW_TREE_SPACE,
 739         DRAW_TRIANGULAR_BULLET,
 740         DRAW_BLACK_CIRCLE,
 741         DRAW_ARROW,
 742         DRAW_DASH,
 743         _DRAW_SPECIAL_CHAR_MAX
 744 } DrawSpecialChar;
 745
 746 const char *draw_special_char(DrawSpecialChar ch);
 747
 748 char *strreplace(const char *text, const char *old_string, const char *new_string);
 749
 750 char *strip_tab_ansi(char **p, size_t *l);
 751
 752 int on_ac_power(void);
 753
 754 int search_and_fopen(const char *path, const char *mode, const char *root, const char **search, FILE **_f);
 755 int search_and_fopen_nulstr(const char *path, const char *mode, const char *root, const char *search, FILE **_f);
 756
 757 #define FOREACH_LINE(line, f, on_error)                         \
 758         for (;;)                                                \
 759                 if (!fgets(line, sizeof(line), f)) {            \
 760                         if (ferror(f)) {                        \
 761                                 on_error;                       \
 762                         }                                       \
 763                         break;                                  \
 764                 } else
 765
 766 #define FOREACH_DIRENT(de, d, on_error)                                 \
 767         for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d))   \
 768                 if (!de) {                                              \
 769                         if (errno > 0) {                                \
 770                                 on_error;                               \
 771                         }                                               \
 772                         break;                                          \
 773                 } else if (ignore_file((de)->d_name))                   \
 774                         continue;                                       \
 775                 else
 776
 777 static inline void *mempset(void *s, int c, size_t n) {
 778         memset(s, c, n);
 779         return (uint8_t*)s + n;
 780 }
 781
 782 char *hexmem(const void *p, size_t l);
 783 void *unhexmem(const char *p, size_t l);
 784
 785 char *strextend(char **x, ...) _sentinel_;
 786 char *strrep(const char *s, unsigned n);
 787
 788 void* greedy_realloc(void **p, size_t *allocated, size_t need, size_t size);
 789 void* greedy_realloc0(void **p, size_t *allocated, size_t need, size_t size);
 790 #define GREEDY_REALLOC(array, allocated, need)                          \
 791         greedy_realloc((void**) &(array), &(allocated), (need), sizeof((array)[0]))
 792
 793 #define GREEDY_REALLOC0(array, allocated, need)                         \
 794         greedy_realloc0((void**) &(array), &(allocated), (need), sizeof((array)[0]))
 795
 796 static inline void _reset_errno_(int *saved_errno) {
 797         errno = *saved_errno;
 798 }
 799
 800 #define PROTECT_ERRNO _cleanup_(_reset_errno_) __attribute__((unused)) int _saved_errno_ = errno
 801
 802 static inline int negative_errno(void) {
 803         /* This helper should be used to shut up gcc if you know 'errno' is
 804          * negative. Instead of "return -errno;", use "return negative_errno();"
 805          * It will suppress bogus gcc warnings in case it assumes 'errno' might
 806          * be 0 and thus the caller's error-handling might not be triggered. */
 807         assert_return(errno > 0, -EINVAL);
 808         return -errno;
 809 }
 810
 811 struct _umask_struct_ {
 812         mode_t mask;
 813         bool quit;
 814 };
 815
 816 static inline void _reset_umask_(struct _umask_struct_ *s) {
 817         umask(s->mask);
 818 };
 819
 820 #define RUN_WITH_UMASK(mask)                                            \
 821         for (_cleanup_(_reset_umask_) struct _umask_struct_ _saved_umask_ = { umask(mask), false }; \
 822              !_saved_umask_.quit ;                                      \
 823              _saved_umask_.quit = true)
 824
 825 static inline unsigned u64log2(uint64_t n) {
 826 #if __SIZEOF_LONG_LONG__ == 8
 827         return (n > 1) ? (unsigned) __builtin_clzll(n) ^ 63U : 0;
 828 #else
 829 #error "Wut?"
 830 #endif
 831 }
 832
 833 static inline unsigned u32ctz(uint32_t n) {
 834 #if __SIZEOF_INT__ == 4
 835         return __builtin_ctz(n);
 836 #else
 837 #error "Wut?"
 838 #endif
 839 }
 840
 841 static inline int log2i(int x) {
 842         assert(x > 0);
 843
 844         return __SIZEOF_INT__ * 8 - __builtin_clz(x) - 1;
 845 }
 846
 847 static inline unsigned log2u(unsigned x) {
 848         assert(x > 0);
 849
 850         return sizeof(unsigned) * 8 - __builtin_clz(x) - 1;
 851 }
 852
 853 static inline unsigned log2u_round_up(unsigned x) {
 854         assert(x > 0);
 855
 856         if (x == 1)
 857                 return 0;
 858
 859         return log2u(x - 1) + 1;
 860 }
 861
 862 static inline bool logind_running(void) {
 863         return access("/run/systemd/seats/", F_OK) >= 0;
 864 }
 865
 866 #define DECIMAL_STR_WIDTH(x)                            \
 867         ({                                              \
 868                 typeof(x) _x_ = (x);                    \
 869                 unsigned ans = 1;                       \
 870                 while (_x_ /= 10)                       \
 871                         ans++;                          \
 872                 ans;                                    \
 873         })
 874
 875 int unlink_noerrno(const char *path);
 876
 877 #define alloca0(n)                                      \
 878         ({                                              \
 879                 char *_new_;                            \
 880                 size_t _len_ = n;                       \
 881                 _new_ = alloca(_len_);                  \
 882                 (void *) memset(_new_, 0, _len_);       \
 883         })
 884
 885 #define alloca_align(size, align)                                       \
 886         ({                                                              \
 887                 void *_ptr_;                                            \
 888                 size_t _mask_ = (align) - 1;                            \
 889                 _ptr_ = alloca((size) + _mask_);                        \
 890                 (void*)(((uintptr_t)_ptr_ + _mask_) & ~_mask_);         \
 891         })
 892
 893 #define alloca0_align(size, align)                                      \
 894         ({                                                              \
 895                 void *_new_;                                            \
 896                 size_t _size_ = (size);                                 \
 897                 _new_ = alloca_align(_size_, (align));                  \
 898                 (void*)memset(_new_, 0, _size_);                        \
 899         })
 900
 901 #define strappenda(a, ...)                                       \
 902         ({                                                       \
 903                 int _len = strlen(a);                            \
 904                 unsigned _i;                                     \
 905                 char *_d_, *_p_;                                 \
 906                 const char *_appendees_[] = { __VA_ARGS__ };     \
 907                 for (_i = 0; _i < ELEMENTSOF(_appendees_); _i++) \
 908                         _len += strlen(_appendees_[_i]);         \
 909                 _d_ = alloca(_len + 1);                          \
 910                 _p_ = stpcpy(_d_, a);                            \
 911                 for (_i = 0; _i < ELEMENTSOF(_appendees_); _i++) \
 912                         _p_ = stpcpy(_p_, _appendees_[_i]);      \
 913                 _d_;                                             \
 914         })
 915
 916 #define procfs_file_alloca(pid, field)                                  \
 917         ({                                                              \
 918                 pid_t _pid_ = (pid);                                    \
 919                 const char *_r_;                                        \
 920                 if (_pid_ == 0) {                                       \
 921                         _r_ = ("/proc/self/" field);                    \
 922                 } else {                                                \
 923                         _r_ = alloca(strlen("/proc/") + DECIMAL_STR_MAX(pid_t) + 1 + sizeof(field)); \
 924                         sprintf((char*) _r_, "/proc/"PID_FMT"/" field, _pid_);                       \
 925                 }                                                       \
 926                 _r_;                                                    \
 927         })
 928
 929 struct _locale_struct_ {
 930         locale_t saved_locale;
 931         locale_t new_locale;
 932         bool quit;
 933 };
 934
 935 static inline void _reset_locale_(struct _locale_struct_ *s) {
 936         PROTECT_ERRNO;
 937         if (s->saved_locale != (locale_t) 0)
 938                 uselocale(s->saved_locale);
 939         if (s->new_locale != (locale_t) 0)
 940                 freelocale(s->new_locale);
 941 }
 942
 943 #define RUN_WITH_LOCALE(mask, loc) \
 944         for (_cleanup_(_reset_locale_) struct _locale_struct_ _saved_locale_ = { (locale_t) 0, (locale_t) 0, false }; \
 945              ({                                                         \
 946                      if (!_saved_locale_.quit) {                        \
 947                              PROTECT_ERRNO;                             \
 948                              _saved_locale_.new_locale = newlocale((mask), (loc), (locale_t) 0); \
 949                              if (_saved_locale_.new_locale != (locale_t) 0)     \
 950                                      _saved_locale_.saved_locale = uselocale(_saved_locale_.new_locale); \
 951                      }                                                  \
 952                      !_saved_locale_.quit; }) ;                         \
 953              _saved_locale_.quit = true)
 954
 955 bool id128_is_valid(const char *s) _pure_;
 956
 957 int split_pair(const char *s, const char *sep, char **l, char **r);
 958
 959 int shall_restore_state(void);
 960
 961 /**
 962  * Normal qsort requires base to be nonnull. Here were require
 963  * that only if nmemb > 0.
 964  */
 965 static inline void qsort_safe(void *base, size_t nmemb, size_t size,
 966                               int (*compar)(const void *, const void *)) {
 967         if (nmemb) {
 968                 assert(base);
 969                 qsort(base, nmemb, size, compar);
 970         }
 971 }
 972
 973 int proc_cmdline(char **ret);
 974 int parse_proc_cmdline(int (*parse_word)(const char *key, const char *value));
 975 int get_proc_cmdline_key(const char *parameter, char **value);
 976
 977 int container_get_leader(const char *machine, pid_t *pid);
 978
 979 int namespace_open(pid_t pid, int *pidns_fd, int *mntns_fd, int *netns_fd, int *root_fd);
 980 int namespace_enter(int pidns_fd, int mntns_fd, int netns_fd, int root_fd);
 981
 982 bool pid_is_alive(pid_t pid);
 983 bool pid_is_unwaited(pid_t pid);
 984
 985 int getpeercred(int fd, struct ucred *ucred);
 986 int getpeersec(int fd, char **ret);
 987
 988 int writev_safe(int fd, const struct iovec *w, int j);
 989
 990 int mkostemp_safe(char *pattern, int flags);
 991 int open_tmpfile(const char *path, int flags);
 992
 993 int fd_warn_permissions(const char *path, int fd);
 994
 995 unsigned long personality_from_string(const char *p);
 996 const char *personality_to_string(unsigned long);
 997
 998 uint64_t physical_memory(void);
 999
1000 char* mount_test_option(const char *haystack, const char *needle);
1001
1002 void hexdump(FILE *f, const void *p, size_t s);
1003
1004 union file_handle_union {
1005         struct file_handle handle;
1006         char padding[sizeof(struct file_handle) + MAX_HANDLE_SZ];
1007 };
1008
1009 int update_reboot_param_file(const char *param);
1010
1011 int umount_recursive(const char *target, int flags);
1012
1013 int bind_remount_recursive(const char *prefix, bool ro);
1014
1015 int fflush_and_check(FILE *f);
1016
1017 char *tempfn_xxxxxx(const char *p);
1018 char *tempfn_random(const char *p);
1019
1020 bool is_localhost(const char *hostname);
1021
1022 int take_password_lock(const char *root);
1023
1024 int is_symlink(const char *path);
1025 int is_dir(const char *path, bool follow);
1026
1027 int unquote_first_word(const char **p, char **ret, bool relax);
1028 int unquote_many_words(const char **p, ...) _sentinel_;
1029
1030 int free_and_strdup(char **p, const char *s);
1031
1032 int sethostname_idempotent(const char *s);