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* gethostname_malloc(void);
 436 char* getlogname_malloc(void);
 437 char* getusername_malloc(void);
 438
 439 int getttyname_malloc(int fd, char **r);
 440 int getttyname_harder(int fd, char **r);
 441
 442 int get_ctty_devnr(pid_t pid, dev_t *d);
 443 int get_ctty(pid_t, dev_t *_devnr, char **r);
 444
 445 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
 446 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
 447
 448 int rm_rf_children(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
 449 int rm_rf_children_dangerous(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
 450 int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
 451 int rm_rf_dangerous(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
 452
 453 int pipe_eof(int fd);
 454
 455 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
 456
 457 int status_vprintf(const char *status, bool ellipse, bool ephemeral, const char *format, va_list ap) _printf_(4,0);
 458 int status_printf(const char *status, bool ellipse, bool ephemeral, const char *format, ...) _printf_(4,5);
 459
 460 int fd_columns(int fd);
 461 unsigned columns(void);
 462 int fd_lines(int fd);
 463 unsigned lines(void);
 464 void columns_lines_cache_reset(int _unused_ signum);
 465
 466 bool on_tty(void);
 467
 468 static inline const char *ansi_highlight(void) {
 469         return on_tty() ? ANSI_HIGHLIGHT_ON : "";
 470 }
 471
 472 static inline const char *ansi_highlight_red(void) {
 473         return on_tty() ? ANSI_HIGHLIGHT_RED_ON : "";
 474 }
 475
 476 static inline const char *ansi_highlight_green(void) {
 477         return on_tty() ? ANSI_HIGHLIGHT_GREEN_ON : "";
 478 }
 479
 480 static inline const char *ansi_highlight_yellow(void) {
 481         return on_tty() ? ANSI_HIGHLIGHT_YELLOW_ON : "";
 482 }
 483
 484 static inline const char *ansi_highlight_blue(void) {
 485         return on_tty() ? ANSI_HIGHLIGHT_BLUE_ON : "";
 486 }
 487
 488 static inline const char *ansi_highlight_off(void) {
 489         return on_tty() ? ANSI_HIGHLIGHT_OFF : "";
 490 }
 491
 492 int files_same(const char *filea, const char *fileb);
 493
 494 int running_in_chroot(void);
 495
 496 char *ellipsize(const char *s, size_t length, unsigned percent);
 497                                    /* bytes                 columns */
 498 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
 499
 500 int touch_file(const char *path, bool parents, usec_t stamp, uid_t uid, gid_t gid, mode_t mode);
 501 int touch(const char *path);
 502
 503 char *unquote(const char *s, const char *quotes);
 504 char *normalize_env_assignment(const char *s);
 505
 506 int wait_for_terminate(pid_t pid, siginfo_t *status);
 507 int wait_for_terminate_and_warn(const char *name, pid_t pid);
 508
 509 noreturn void freeze(void);
 510
 511 bool null_or_empty(struct stat *st) _pure_;
 512 int null_or_empty_path(const char *fn);
 513 int null_or_empty_fd(int fd);
 514
 515 DIR *xopendirat(int dirfd, const char *name, int flags);
 516
 517 char *fstab_node_to_udev_node(const char *p);
 518
 519 char *resolve_dev_console(char **active);
 520 bool tty_is_vc(const char *tty);
 521 bool tty_is_vc_resolve(const char *tty);
 522 bool tty_is_console(const char *tty) _pure_;
 523 int vtnr_from_tty(const char *tty);
 524 const char *default_term_for_tty(const char *tty);
 525
 526 void execute_directory(const char *directory, DIR *_d, usec_t timeout, char *argv[]);
 527
 528 int kill_and_sigcont(pid_t pid, int sig);
 529
 530 bool nulstr_contains(const char*nulstr, const char *needle);
 531
 532 bool plymouth_running(void);
 533
 534 bool hostname_is_valid(const char *s) _pure_;
 535 char* hostname_cleanup(char *s, bool lowercase);
 536
 537 bool machine_name_is_valid(const char *s) _pure_;
 538
 539 char* strshorten(char *s, size_t l);
 540
 541 int terminal_vhangup_fd(int fd);
 542 int terminal_vhangup(const char *name);
 543
 544 int vt_disallocate(const char *name);
 545
 546 int symlink_atomic(const char *from, const char *to);
 547 int mknod_atomic(const char *path, mode_t mode, dev_t dev);
 548 int mkfifo_atomic(const char *path, mode_t mode);
 549
 550 int fchmod_umask(int fd, mode_t mode);
 551
 552 bool display_is_local(const char *display) _pure_;
 553 int socket_from_display(const char *display, char **path);
 554
 555 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
 556 int get_group_creds(const char **groupname, gid_t *gid);
 557
 558 int in_gid(gid_t gid);
 559 int in_group(const char *name);
 560
 561 char* uid_to_name(uid_t uid);
 562 char* gid_to_name(gid_t gid);
 563
 564 int glob_exists(const char *path);
 565 int glob_extend(char ***strv, const char *path);
 566
 567 int dirent_ensure_type(DIR *d, struct dirent *de);
 568
 569 int get_files_in_directory(const char *path, char ***list);
 570
 571 char *strjoin(const char *x, ...) _sentinel_;
 572
 573 bool is_main_thread(void);
 574
 575 static inline bool _pure_ in_charset(const char *s, const char* charset) {
 576         assert(s);
 577         assert(charset);
 578         return s[strspn(s, charset)] == '\0';
 579 }
 580
 581 int block_get_whole_disk(dev_t d, dev_t *ret);
 582
 583 int file_is_priv_sticky(const char *p);
 584
 585 int strdup_or_null(const char *a, char **b);
 586
 587 #define NULSTR_FOREACH(i, l)                                    \
 588         for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
 589
 590 #define NULSTR_FOREACH_PAIR(i, j, l)                             \
 591         for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
 592
 593 int ioprio_class_to_string_alloc(int i, char **s);
 594 int ioprio_class_from_string(const char *s);
 595
 596 const char *sigchld_code_to_string(int i) _const_;
 597 int sigchld_code_from_string(const char *s) _pure_;
 598
 599 int log_facility_unshifted_to_string_alloc(int i, char **s);
 600 int log_facility_unshifted_from_string(const char *s);
 601
 602 int log_level_to_string_alloc(int i, char **s);
 603 int log_level_from_string(const char *s);
 604
 605 int sched_policy_to_string_alloc(int i, char **s);
 606 int sched_policy_from_string(const char *s);
 607
 608 const char *rlimit_to_string(int i) _const_;
 609 int rlimit_from_string(const char *s) _pure_;
 610
 611 int ip_tos_to_string_alloc(int i, char **s);
 612 int ip_tos_from_string(const char *s);
 613
 614 const char *signal_to_string(int i) _const_;
 615 int signal_from_string(const char *s) _pure_;
 616
 617 int signal_from_string_try_harder(const char *s);
 618
 619 extern int saved_argc;
 620 extern char **saved_argv;
 621
 622 bool kexec_loaded(void);
 623
 624 int prot_from_flags(int flags) _const_;
 625
 626 char *format_bytes(char *buf, size_t l, off_t t);
 627
 628 int fd_wait_for_event(int fd, int event, usec_t timeout);
 629
 630 void* memdup(const void *p, size_t l) _alloc_(2);
 631
 632 int is_kernel_thread(pid_t pid);
 633
 634 int fd_inc_sndbuf(int fd, size_t n);
 635 int fd_inc_rcvbuf(int fd, size_t n);
 636
 637 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
 638
 639 int setrlimit_closest(int resource, const struct rlimit *rlim);
 640
 641 int getenv_for_pid(pid_t pid, const char *field, char **_value);
 642
 643 bool is_valid_documentation_url(const char *url) _pure_;
 644
 645 bool in_initrd(void);
 646
 647 void warn_melody(void);
 648
 649 int get_home_dir(char **ret);
 650 int get_shell(char **_ret);
 651
 652 static inline void freep(void *p) {
 653         free(*(void**) p);
 654 }
 655
 656 #define DEFINE_TRIVIAL_CLEANUP_FUNC(type, func)                 \
 657         static inline void func##p(type *p) {                   \
 658                 if (*p)                                         \
 659                         func(*p);                               \
 660         }                                                       \
 661         struct __useless_struct_to_allow_trailing_semicolon__
 662
 663 static inline void closep(int *fd) {
 664         safe_close(*fd);
 665 }
 666
 667 static inline void umaskp(mode_t *u) {
 668         umask(*u);
 669 }
 670
 671 static inline void close_pairp(int (*p)[2]) {
 672         safe_close_pair(*p);
 673 }
 674
 675 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, fclose);
 676 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, pclose);
 677 DEFINE_TRIVIAL_CLEANUP_FUNC(DIR*, closedir);
 678 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, endmntent);
 679
 680 #define _cleanup_free_ _cleanup_(freep)
 681 #define _cleanup_close_ _cleanup_(closep)
 682 #define _cleanup_umask_ _cleanup_(umaskp)
 683 #define _cleanup_globfree_ _cleanup_(globfree)
 684 #define _cleanup_fclose_ _cleanup_(fclosep)
 685 #define _cleanup_pclose_ _cleanup_(pclosep)
 686 #define _cleanup_closedir_ _cleanup_(closedirp)
 687 #define _cleanup_endmntent_ _cleanup_(endmntentp)
 688 #define _cleanup_close_pair_ _cleanup_(close_pairp)
 689
 690 _malloc_  _alloc_(1, 2) static inline void *malloc_multiply(size_t a, size_t b) {
 691         if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
 692                 return NULL;
 693
 694         return malloc(a * b);
 695 }
 696
 697 _alloc_(2, 3) static inline void *realloc_multiply(void *p, size_t a, size_t b) {
 698         if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
 699                 return NULL;
 700
 701         return realloc(p, a * b);
 702 }
 703
 704 _alloc_(2, 3) static inline void *memdup_multiply(const void *p, size_t a, size_t b) {
 705         if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
 706                 return NULL;
 707
 708         return memdup(p, a * b);
 709 }
 710
 711 bool filename_is_safe(const char *p) _pure_;
 712 bool path_is_safe(const char *p) _pure_;
 713 bool string_is_safe(const char *p) _pure_;
 714 bool string_has_cc(const char *p, const char *ok) _pure_;
 715
 716 /**
 717  * Check if a string contains any glob patterns.
 718  */
 719 _pure_ static inline bool string_is_glob(const char *p) {
 720         return !!strpbrk(p, GLOB_CHARS);
 721 }
 722
 723 void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
 724                  int (*compar) (const void *, const void *, void *),
 725                  void *arg);
 726
 727 bool is_locale_utf8(void);
 728
 729 typedef enum DrawSpecialChar {
 730         DRAW_TREE_VERTICAL,
 731         DRAW_TREE_BRANCH,
 732         DRAW_TREE_RIGHT,
 733         DRAW_TREE_SPACE,
 734         DRAW_TRIANGULAR_BULLET,
 735         DRAW_BLACK_CIRCLE,
 736         DRAW_ARROW,
 737         DRAW_DASH,
 738         _DRAW_SPECIAL_CHAR_MAX
 739 } DrawSpecialChar;
 740
 741 const char *draw_special_char(DrawSpecialChar ch);
 742
 743 char *strreplace(const char *text, const char *old_string, const char *new_string);
 744
 745 char *strip_tab_ansi(char **p, size_t *l);
 746
 747 int on_ac_power(void);
 748
 749 int search_and_fopen(const char *path, const char *mode, const char *root, const char **search, FILE **_f);
 750 int search_and_fopen_nulstr(const char *path, const char *mode, const char *root, const char *search, FILE **_f);
 751
 752 #define FOREACH_LINE(line, f, on_error)                         \
 753         for (;;)                                                \
 754                 if (!fgets(line, sizeof(line), f)) {            \
 755                         if (ferror(f)) {                        \
 756                                 on_error;                       \
 757                         }                                       \
 758                         break;                                  \
 759                 } else
 760
 761 #define FOREACH_DIRENT(de, d, on_error)                                 \
 762         for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d))   \
 763                 if (!de) {                                              \
 764                         if (errno > 0) {                                \
 765                                 on_error;                               \
 766                         }                                               \
 767                         break;                                          \
 768                 } else if (ignore_file((de)->d_name))                   \
 769                         continue;                                       \
 770                 else
 771
 772 static inline void *mempset(void *s, int c, size_t n) {
 773         memset(s, c, n);
 774         return (uint8_t*)s + n;
 775 }
 776
 777 char *hexmem(const void *p, size_t l);
 778 void *unhexmem(const char *p, size_t l);
 779
 780 char *strextend(char **x, ...) _sentinel_;
 781 char *strrep(const char *s, unsigned n);
 782
 783 void* greedy_realloc(void **p, size_t *allocated, size_t need, size_t size);
 784 void* greedy_realloc0(void **p, size_t *allocated, size_t need, size_t size);
 785 #define GREEDY_REALLOC(array, allocated, need)                          \
 786         greedy_realloc((void**) &(array), &(allocated), (need), sizeof((array)[0]))
 787
 788 #define GREEDY_REALLOC0(array, allocated, need)                         \
 789         greedy_realloc0((void**) &(array), &(allocated), (need), sizeof((array)[0]))
 790
 791 static inline void _reset_errno_(int *saved_errno) {
 792         errno = *saved_errno;
 793 }
 794
 795 #define PROTECT_ERRNO _cleanup_(_reset_errno_) __attribute__((unused)) int _saved_errno_ = errno
 796
 797 struct _umask_struct_ {
 798         mode_t mask;
 799         bool quit;
 800 };
 801
 802 static inline void _reset_umask_(struct _umask_struct_ *s) {
 803         umask(s->mask);
 804 };
 805
 806 #define RUN_WITH_UMASK(mask)                                            \
 807         for (_cleanup_(_reset_umask_) struct _umask_struct_ _saved_umask_ = { umask(mask), false }; \
 808              !_saved_umask_.quit ;                                      \
 809              _saved_umask_.quit = true)
 810
 811 static inline unsigned u64log2(uint64_t n) {
 812 #if __SIZEOF_LONG_LONG__ == 8
 813         return (n > 1) ? (unsigned) __builtin_clzll(n) ^ 63U : 0;
 814 #else
 815 #error "Wut?"
 816 #endif
 817 }
 818
 819 static inline unsigned u32ctz(uint32_t n) {
 820 #if __SIZEOF_INT__ == 4
 821         return __builtin_ctz(n);
 822 #else
 823 #error "Wut?"
 824 #endif
 825 }
 826
 827 static inline int log2i(int x) {
 828         assert(x > 0);
 829
 830         return __SIZEOF_INT__ * 8 - __builtin_clz(x) - 1;
 831 }
 832
 833 static inline bool logind_running(void) {
 834         return access("/run/systemd/seats/", F_OK) >= 0;
 835 }
 836
 837 #define DECIMAL_STR_WIDTH(x)                            \
 838         ({                                              \
 839                 typeof(x) _x_ = (x);                    \
 840                 unsigned ans = 1;                       \
 841                 while (_x_ /= 10)                       \
 842                         ans++;                          \
 843                 ans;                                    \
 844         })
 845
 846 int unlink_noerrno(const char *path);
 847
 848 #define alloca0(n)                                      \
 849         ({                                              \
 850                 char *_new_;                            \
 851                 size_t _len_ = n;                       \
 852                 _new_ = alloca(_len_);                  \
 853                 (void *) memset(_new_, 0, _len_);       \
 854         })
 855
 856 #define strappenda(a, ...)                                       \
 857         ({                                                       \
 858                 int _len = strlen(a);                            \
 859                 unsigned _i;                                     \
 860                 char *_d_, *_p_;                                 \
 861                 const char *_appendees_[] = { __VA_ARGS__ };     \
 862                 for (_i = 0; _i < ELEMENTSOF(_appendees_); _i++) \
 863                         _len += strlen(_appendees_[_i]);         \
 864                 _d_ = alloca(_len + 1);                          \
 865                 _p_ = stpcpy(_d_, a);                            \
 866                 for (_i = 0; _i < ELEMENTSOF(_appendees_); _i++) \
 867                         _p_ = stpcpy(_p_, _appendees_[_i]);      \
 868                 _d_;                                             \
 869         })
 870
 871 #define procfs_file_alloca(pid, field)                                  \
 872         ({                                                              \
 873                 pid_t _pid_ = (pid);                                    \
 874                 const char *_r_;                                        \
 875                 if (_pid_ == 0) {                                       \
 876                         _r_ = ("/proc/self/" field);                    \
 877                 } else {                                                \
 878                         _r_ = alloca(strlen("/proc/") + DECIMAL_STR_MAX(pid_t) + 1 + sizeof(field)); \
 879                         sprintf((char*) _r_, "/proc/"PID_FMT"/" field, _pid_);                       \
 880                 }                                                       \
 881                 _r_;                                                    \
 882         })
 883
 884 struct _locale_struct_ {
 885         locale_t saved_locale;
 886         locale_t new_locale;
 887         bool quit;
 888 };
 889
 890 static inline void _reset_locale_(struct _locale_struct_ *s) {
 891         PROTECT_ERRNO;
 892         if (s->saved_locale != (locale_t) 0)
 893                 uselocale(s->saved_locale);
 894         if (s->new_locale != (locale_t) 0)
 895                 freelocale(s->new_locale);
 896 }
 897
 898 #define RUN_WITH_LOCALE(mask, loc) \
 899         for (_cleanup_(_reset_locale_) struct _locale_struct_ _saved_locale_ = { (locale_t) 0, (locale_t) 0, false }; \
 900              ({                                                         \
 901                      if (!_saved_locale_.quit) {                        \
 902                              PROTECT_ERRNO;                             \
 903                              _saved_locale_.new_locale = newlocale((mask), (loc), (locale_t) 0); \
 904                              if (_saved_locale_.new_locale != (locale_t) 0)     \
 905                                      _saved_locale_.saved_locale = uselocale(_saved_locale_.new_locale); \
 906                      }                                                  \
 907                      !_saved_locale_.quit; }) ;                         \
 908              _saved_locale_.quit = true)
 909
 910 bool id128_is_valid(const char *s) _pure_;
 911
 912 int split_pair(const char *s, const char *sep, char **l, char **r);
 913
 914 int shall_restore_state(void);
 915
 916 /**
 917  * Normal qsort requires base to be nonnull. Here were require
 918  * that only if nmemb > 0.
 919  */
 920 static inline void qsort_safe(void *base, size_t nmemb, size_t size,
 921                               int (*compar)(const void *, const void *)) {
 922         if (nmemb) {
 923                 assert(base);
 924                 qsort(base, nmemb, size, compar);
 925         }
 926 }
 927
 928 int proc_cmdline(char **ret);
 929 int parse_proc_cmdline(int (*parse_word)(const char *key, const char *value));
 930
 931 int container_get_leader(const char *machine, pid_t *pid);
 932
 933 int namespace_open(pid_t pid, int *pidns_fd, int *mntns_fd, int *netns_fd, int *root_fd);
 934 int namespace_enter(int pidns_fd, int mntns_fd, int netns_fd, int root_fd);
 935
 936 bool pid_is_alive(pid_t pid);
 937 bool pid_is_unwaited(pid_t pid);
 938
 939 int getpeercred(int fd, struct ucred *ucred);
 940 int getpeersec(int fd, char **ret);
 941
 942 int writev_safe(int fd, const struct iovec *w, int j);
 943
 944 int mkostemp_safe(char *pattern, int flags);
 945 int open_tmpfile(const char *path, int flags);
 946
 947 int fd_warn_permissions(const char *path, int fd);
 948
 949 unsigned long personality_from_string(const char *p);
 950 const char *personality_to_string(unsigned long);
 951
 952 uint64_t physical_memory(void);
 953
 954 char* mount_test_option(const char *haystack, const char *needle);
 955
 956 void hexdump(FILE *f, const void *p, size_t s);
 957
 958 union file_handle_union {
 959         struct file_handle handle;
 960         char padding[sizeof(struct file_handle) + MAX_HANDLE_SZ];
 961 };
 962
 963 int update_reboot_param_file(const char *param);
 964
 965 int umount_recursive(const char *target, int flags);
 966
 967 int bind_remount_recursive(const char *prefix, bool ro);
 968
 969 int fflush_and_check(FILE *f);
 970
 971 char *tempfn_xxxxxx(const char *p);
 972 char *tempfn_random(const char *p);
 973
 974 bool is_localhost(const char *hostname);
 975
 976 int take_password_lock(const char *root);
 977
 978 int is_symlink(const char *path);
 979
 980 int unquote_first_word(const char **p, char **ret);
 981 int unquote_many_words(const char **p, ...) _sentinel_;
 982
 983 int free_and_strdup(char **p, const char *s);