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