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