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