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 <stdarg.h>
  29 #include <stdbool.h>
  30 #include <stdlib.h>
  31 #include <stdio.h>
  32 #include <signal.h>
  33 #include <sched.h>
  34 #include <limits.h>
  35 #include <sys/types.h>
  36 #include <sys/stat.h>
  37 #include <dirent.h>
  38 #include <stddef.h>
  39 #include <unistd.h>
  40 #include <locale.h>
  41 #include <mntent.h>
  42 #include <sys/inotify.h>
  43
  44 #if SIZEOF_PID_T == 4
  45 #  define PID_PRI PRIi32
  46 #elif SIZEOF_PID_T == 2
  47 #  define PID_PRI PRIi16
  48 #else
  49 #  error Unknown pid_t size
  50 #endif
  51 #define PID_FMT "%" PID_PRI
  52
  53 #if SIZEOF_UID_T == 4
  54 #  define UID_FMT "%" PRIu32
  55 #elif SIZEOF_UID_T == 2
  56 #  define UID_FMT "%" PRIu16
  57 #else
  58 #  error Unknown uid_t size
  59 #endif
  60
  61 #if SIZEOF_GID_T == 4
  62 #  define GID_FMT "%" PRIu32
  63 #elif SIZEOF_GID_T == 2
  64 #  define GID_FMT "%" PRIu16
  65 #else
  66 #  error Unknown gid_t size
  67 #endif
  68
  69 #if SIZEOF_TIME_T == 8
  70 #  define PRI_TIME PRIi64
  71 #elif SIZEOF_TIME_T == 4
  72 #  define PRI_TIME PRIu32
  73 #else
  74 #  error Unknown time_t size
  75 #endif
  76
  77 #if SIZEOF_RLIM_T == 8
  78 #  define RLIM_FMT "%" PRIu64
  79 #elif SIZEOF_RLIM_T == 4
  80 #  define RLIM_FMT "%" PRIu32
  81 #else
  82 #  error Unknown rlim_t size
  83 #endif
  84
  85 #include "macro.h"
  86 #include "missing.h"
  87 #include "time-util.h"
  88
  89 /* What is interpreted as whitespace? */
  90 #define WHITESPACE " \t\n\r"
  91 #define NEWLINE    "\n\r"
  92 #define QUOTES     "\"\'"
  93 #define COMMENTS   "#;"
  94 #define GLOB_CHARS "*?["
  95
  96 /* What characters are special in the shell? */
  97 /* must be escaped outside and inside double-quotes */
  98 #define SHELL_NEED_ESCAPE "\"\\`$"
  99 /* can be escaped or double-quoted */
 100 #define SHELL_NEED_QUOTES SHELL_NEED_ESCAPE GLOB_CHARS "'()<>|&;"
 101
 102 #define FORMAT_BYTES_MAX 8
 103
 104 #define ANSI_HIGHLIGHT_ON "\x1B[1;39m"
 105 #define ANSI_RED_ON "\x1B[31m"
 106 #define ANSI_HIGHLIGHT_RED_ON "\x1B[1;31m"
 107 #define ANSI_GREEN_ON "\x1B[32m"
 108 #define ANSI_HIGHLIGHT_GREEN_ON "\x1B[1;32m"
 109 #define ANSI_HIGHLIGHT_YELLOW_ON "\x1B[1;33m"
 110 #define ANSI_HIGHLIGHT_BLUE_ON "\x1B[1;34m"
 111 #define ANSI_HIGHLIGHT_OFF "\x1B[0m"
 112 #define ANSI_ERASE_TO_END_OF_LINE "\x1B[K"
 113
 114 size_t page_size(void) _pure_;
 115 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
 116
 117 #define streq(a,b) (strcmp((a),(b)) == 0)
 118 #define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
 119 #define strcaseeq(a,b) (strcasecmp((a),(b)) == 0)
 120 #define strncaseeq(a, b, n) (strncasecmp((a), (b), (n)) == 0)
 121
 122 bool streq_ptr(const char *a, const char *b) _pure_;
 123
 124 #define new(t, n) ((t*) malloc_multiply(sizeof(t), (n)))
 125
 126 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
 127
 128 #define newa(t, n) ((t*) alloca(sizeof(t)*(n)))
 129
 130 #define newa0(t, n) ((t*) alloca0(sizeof(t)*(n)))
 131
 132 #define newdup(t, p, n) ((t*) memdup_multiply(p, sizeof(t), (n)))
 133
 134 #define malloc0(n) (calloc((n), 1))
 135
 136 static inline const char* yes_no(bool b) {
 137         return b ? "yes" : "no";
 138 }
 139
 140 static inline const char* true_false(bool b) {
 141         return b ? "true" : "false";
 142 }
 143
 144 static inline const char* one_zero(bool b) {
 145         return b ? "1" : "0";
 146 }
 147
 148 static inline const char* strempty(const char *s) {
 149         return s ? s : "";
 150 }
 151
 152 static inline const char* strnull(const char *s) {
 153         return s ? s : "(null)";
 154 }
 155
 156 static inline const char *strna(const char *s) {
 157         return s ? s : "n/a";
 158 }
 159
 160 static inline bool isempty(const char *p) {
 161         return !p || !p[0];
 162 }
 163
 164 static inline char *startswith(const char *s, const char *prefix) {
 165         size_t l;
 166
 167         l = strlen(prefix);
 168         if (strncmp(s, prefix, l) == 0)
 169                 return (char*) s + l;
 170
 171         return NULL;
 172 }
 173
 174 static inline char *startswith_no_case(const char *s, const char *prefix) {
 175         size_t l;
 176
 177         l = strlen(prefix);
 178         if (strncasecmp(s, prefix, l) == 0)
 179                 return (char*) s + l;
 180
 181         return NULL;
 182 }
 183
 184 char *endswith(const char *s, const char *postfix) _pure_;
 185
 186 char *first_word(const char *s, const char *word) _pure_;
 187
 188 int close_nointr(int fd);
 189 int safe_close(int fd);
 190 void safe_close_pair(int p[]);
 191
 192 void close_many(const int fds[], unsigned n_fd);
 193
 194 int parse_size(const char *t, off_t base, off_t *size);
 195
 196 int parse_boolean(const char *v) _pure_;
 197 int parse_pid(const char *s, pid_t* ret_pid);
 198 int parse_uid(const char *s, uid_t* ret_uid);
 199 #define parse_gid(s, ret_uid) parse_uid(s, ret_uid)
 200
 201 int safe_atou(const char *s, unsigned *ret_u);
 202 int safe_atoi(const char *s, int *ret_i);
 203
 204 int safe_atollu(const char *s, unsigned long long *ret_u);
 205 int safe_atolli(const char *s, long long int *ret_i);
 206
 207 int safe_atod(const char *s, double *ret_d);
 208
 209 int safe_atou8(const char *s, uint8_t *ret);
 210
 211 #if LONG_MAX == INT_MAX
 212 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
 213         assert_cc(sizeof(unsigned long) == sizeof(unsigned));
 214         return safe_atou(s, (unsigned*) ret_u);
 215 }
 216 static inline int safe_atoli(const char *s, long int *ret_u) {
 217         assert_cc(sizeof(long int) == sizeof(int));
 218         return safe_atoi(s, (int*) ret_u);
 219 }
 220 #else
 221 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
 222         assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
 223         return safe_atollu(s, (unsigned long long*) ret_u);
 224 }
 225 static inline int safe_atoli(const char *s, long int *ret_u) {
 226         assert_cc(sizeof(long int) == sizeof(long long int));
 227         return safe_atolli(s, (long long int*) ret_u);
 228 }
 229 #endif
 230
 231 static inline int safe_atou32(const char *s, uint32_t *ret_u) {
 232         assert_cc(sizeof(uint32_t) == sizeof(unsigned));
 233         return safe_atou(s, (unsigned*) ret_u);
 234 }
 235
 236 static inline int safe_atoi32(const char *s, int32_t *ret_i) {
 237         assert_cc(sizeof(int32_t) == sizeof(int));
 238         return safe_atoi(s, (int*) ret_i);
 239 }
 240
 241 static inline int safe_atou64(const char *s, uint64_t *ret_u) {
 242         assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
 243         return safe_atollu(s, (unsigned long long*) ret_u);
 244 }
 245
 246 static inline int safe_atoi64(const char *s, int64_t *ret_i) {
 247         assert_cc(sizeof(int64_t) == sizeof(long long int));
 248         return safe_atolli(s, (long long int*) ret_i);
 249 }
 250
 251 int safe_atou16(const char *s, uint16_t *ret);
 252 int safe_atoi16(const char *s, int16_t *ret);
 253
 254 const char* split(const char **state, size_t *l, const char *separator, bool quoted);
 255
 256 #define FOREACH_WORD(word, length, s, state)                            \
 257         _FOREACH_WORD(word, length, s, WHITESPACE, false, state)
 258
 259 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state)       \
 260         _FOREACH_WORD(word, length, s, separator, false, state)
 261
 262 #define FOREACH_WORD_QUOTED(word, length, s, state)                     \
 263         _FOREACH_WORD(word, length, s, WHITESPACE, true, state)
 264
 265 #define _FOREACH_WORD(word, length, s, separator, quoted, state)        \
 266         for ((state) = (s), (word) = split(&(state), &(length), (separator), (quoted)); (word); (word) = split(&(state), &(length), (separator), (quoted)))
 267
 268 pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
 269
 270 char *strappend(const char *s, const char *suffix);
 271 char *strnappend(const char *s, const char *suffix, size_t length);
 272
 273 char *replace_env(const char *format, char **env);
 274 char **replace_env_argv(char **argv, char **env);
 275
 276 int readlinkat_malloc(int fd, const char *p, char **ret);
 277 int readlink_malloc(const char *p, char **r);
 278 int readlink_value(const char *p, char **ret);
 279 int readlink_and_make_absolute(const char *p, char **r);
 280 int readlink_and_canonicalize(const char *p, char **r);
 281
 282 int reset_all_signal_handlers(void);
 283 int reset_signal_mask(void);
 284
 285 char *strstrip(char *s);
 286 char *delete_chars(char *s, const char *bad);
 287 char *truncate_nl(char *s);
 288
 289 char *file_in_same_dir(const char *path, const char *filename);
 290
 291 int rmdir_parents(const char *path, const char *stop);
 292
 293 int get_process_state(pid_t pid);
 294 int get_process_comm(pid_t pid, char **name);
 295 int get_process_cmdline(pid_t pid, size_t max_length, bool comm_fallback, char **line);
 296 int get_process_exe(pid_t pid, char **name);
 297 int get_process_uid(pid_t pid, uid_t *uid);
 298 int get_process_gid(pid_t pid, gid_t *gid);
 299 int get_process_capeff(pid_t pid, char **capeff);
 300 int get_process_cwd(pid_t pid, char **cwd);
 301 int get_process_root(pid_t pid, char **root);
 302 int get_process_environ(pid_t pid, char **environ);
 303
 304 char hexchar(int x) _const_;
 305 int unhexchar(char c) _const_;
 306 char octchar(int x) _const_;
 307 int unoctchar(char c) _const_;
 308 char decchar(int x) _const_;
 309 int undecchar(char c) _const_;
 310
 311 char *cescape(const char *s);
 312 char *cunescape(const char *s);
 313 char *cunescape_length(const char *s, size_t length);
 314 char *cunescape_length_with_prefix(const char *s, size_t length, const char *prefix);
 315
 316 char *xescape(const char *s, const char *bad);
 317
 318 char *ascii_strlower(char *path);
 319
 320 bool dirent_is_file(const struct dirent *de) _pure_;
 321 bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix) _pure_;
 322
 323 bool hidden_file(const char *filename) _pure_;
 324
 325 bool chars_intersect(const char *a, const char *b) _pure_;
 326
 327 int make_stdio(int fd);
 328 int make_null_stdio(void);
 329 int make_console_stdio(void);
 330
 331 int dev_urandom(void *p, size_t n);
 332 void random_bytes(void *p, size_t n);
 333 void initialize_srand(void);
 334
 335 static inline uint64_t random_u64(void) {
 336         uint64_t u;
 337         random_bytes(&u, sizeof(u));
 338         return u;
 339 }
 340
 341 static inline uint32_t random_u32(void) {
 342         uint32_t u;
 343         random_bytes(&u, sizeof(u));
 344         return u;
 345 }
 346
 347 /* For basic lookup tables with strictly enumerated entries */
 348 #define _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,scope)          \
 349         scope const char *name##_to_string(type i) {                    \
 350                 if (i < 0 || i >= (type) ELEMENTSOF(name##_table))      \
 351                         return NULL;                                    \
 352                 return name##_table[i];                                 \
 353         }
 354
 355 ssize_t string_table_lookup(const char * const *table, size_t len, const char *key);
 356
 357 #define _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,scope)                                \
 358         scope inline type name##_from_string(const char *s) {                                   \
 359                 return (type)string_table_lookup(name##_table, ELEMENTSOF(name##_table), s);    \
 360         }
 361
 362 #define _DEFINE_STRING_TABLE_LOOKUP(name,type,scope)                    \
 363         _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,scope)          \
 364         _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,scope)        \
 365         struct __useless_struct_to_allow_trailing_semicolon__
 366
 367 #define DEFINE_STRING_TABLE_LOOKUP(name,type) _DEFINE_STRING_TABLE_LOOKUP(name,type,)
 368 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) _DEFINE_STRING_TABLE_LOOKUP(name,type,static)
 369 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_TO_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,static)
 370 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_FROM_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,static)
 371
 372 /* For string conversions where numbers are also acceptable */
 373 #define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max)         \
 374         int name##_to_string_alloc(type i, char **str) {                \
 375                 char *s;                                                \
 376                 int r;                                                  \
 377                 if (i < 0 || i > max)                                   \
 378                         return -ERANGE;                                 \
 379                 if (i < (type) ELEMENTSOF(name##_table)) {              \
 380                         s = strdup(name##_table[i]);                    \
 381                         if (!s)                                         \
 382                                 return log_oom();                       \
 383                 } else {                                                \
 384                         r = asprintf(&s, "%i", i);                      \
 385                         if (r < 0)                                      \
 386                                 return log_oom();                       \
 387                 }                                                       \
 388                 *str = s;                                               \
 389                 return 0;                                               \
 390         }                                                               \
 391         type name##_from_string(const char *s) {                        \
 392                 type i;                                                 \
 393                 unsigned u = 0;                                         \
 394                 assert(s);                                              \
 395                 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++)    \
 396                         if (name##_table[i] &&                          \
 397                             streq(name##_table[i], s))                  \
 398                                 return i;                               \
 399                 if (safe_atou(s, &u) >= 0 && u <= max)                  \
 400                         return (type) u;                                \
 401                 return (type) -1;                                       \
 402         }                                                               \
 403         struct __useless_struct_to_allow_trailing_semicolon__
 404
 405 int fd_nonblock(int fd, bool nonblock);
 406 int fd_cloexec(int fd, bool cloexec);
 407
 408 int close_all_fds(const int except[], unsigned n_except);
 409
 410 bool fstype_is_network(const char *fstype);
 411
 412 int chvt(int vt);
 413
 414 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
 415 int ask_char(char *ret, const char *replies, const char *text, ...) _printf_(3, 4);
 416 int ask_string(char **ret, const char *text, ...) _printf_(2, 3);
 417
 418 int reset_terminal_fd(int fd, bool switch_to_text);
 419 int reset_terminal(const char *name);
 420
 421 int open_terminal(const char *name, int mode);
 422 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
 423 int release_terminal(void);
 424
 425 int flush_fd(int fd);
 426
 427 int ignore_signals(int sig, ...);
 428 int default_signals(int sig, ...);
 429 int sigaction_many(const struct sigaction *sa, ...);
 430
 431 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
 432
 433 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
 434 int loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
 435
 436 bool is_device_path(const char *path);
 437
 438 int dir_is_empty(const char *path);
 439 char* dirname_malloc(const char *path);
 440
 441 void rename_process(const char name[8]);
 442
 443 void sigset_add_many(sigset_t *ss, ...);
 444 int sigprocmask_many(int how, ...);
 445
 446 bool hostname_is_set(void);
 447
 448 char* lookup_uid(uid_t uid);
 449 char* gethostname_malloc(void);
 450 char* getlogname_malloc(void);
 451 char* getusername_malloc(void);
 452
 453 int getttyname_malloc(int fd, char **r);
 454 int getttyname_harder(int fd, char **r);
 455
 456 int get_ctty_devnr(pid_t pid, dev_t *d);
 457 int get_ctty(pid_t, dev_t *_devnr, char **r);
 458
 459 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
 460 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
 461
 462 int is_fd_on_temporary_fs(int fd);
 463
 464 int rm_rf_children(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
 465 int rm_rf_children_dangerous(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
 466 int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
 467 int rm_rf_dangerous(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
 468
 469 int pipe_eof(int fd);
 470
 471 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
 472
 473 int status_vprintf(const char *status, bool ellipse, bool ephemeral, const char *format, va_list ap) _printf_(4,0);
 474 int status_printf(const char *status, bool ellipse, bool ephemeral, const char *format, ...) _printf_(4,5);
 475
 476 #define xsprintf(buf, fmt, ...) assert_se((size_t) snprintf(buf, ELEMENTSOF(buf), fmt, __VA_ARGS__) < ELEMENTSOF(buf))
 477
 478 int fd_columns(int fd);
 479 unsigned columns(void);
 480 int fd_lines(int fd);
 481 unsigned lines(void);
 482 void columns_lines_cache_reset(int _unused_ signum);
 483
 484 bool on_tty(void);
 485
 486 static inline const char *ansi_highlight(void) {
 487         return on_tty() ? ANSI_HIGHLIGHT_ON : "";
 488 }
 489
 490 static inline const char *ansi_highlight_red(void) {
 491         return on_tty() ? ANSI_HIGHLIGHT_RED_ON : "";
 492 }
 493
 494 static inline const char *ansi_highlight_green(void) {
 495         return on_tty() ? ANSI_HIGHLIGHT_GREEN_ON : "";
 496 }
 497
 498 static inline const char *ansi_highlight_yellow(void) {
 499         return on_tty() ? ANSI_HIGHLIGHT_YELLOW_ON : "";
 500 }
 501
 502 static inline const char *ansi_highlight_blue(void) {
 503         return on_tty() ? ANSI_HIGHLIGHT_BLUE_ON : "";
 504 }
 505
 506 static inline const char *ansi_highlight_off(void) {
 507         return on_tty() ? ANSI_HIGHLIGHT_OFF : "";
 508 }
 509
 510 int files_same(const char *filea, const char *fileb);
 511
 512 int running_in_chroot(void);
 513
 514 char *ellipsize(const char *s, size_t length, unsigned percent);
 515                                    /* bytes                 columns */
 516 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
 517
 518 int touch_file(const char *path, bool parents, usec_t stamp, uid_t uid, gid_t gid, mode_t mode);
 519 int touch(const char *path);
 520
 521 char *unquote(const char *s, const char *quotes);
 522 char *normalize_env_assignment(const char *s);
 523
 524 int wait_for_terminate(pid_t pid, siginfo_t *status);
 525 int wait_for_terminate_and_warn(const char *name, pid_t pid, bool check_exit_code);
 526
 527 noreturn void freeze(void);
 528
 529 bool null_or_empty(struct stat *st) _pure_;
 530 int null_or_empty_path(const char *fn);
 531 int null_or_empty_fd(int fd);
 532
 533 DIR *xopendirat(int dirfd, const char *name, int flags);
 534
 535 char *fstab_node_to_udev_node(const char *p);
 536
 537 char *resolve_dev_console(char **active);
 538 bool tty_is_vc(const char *tty);
 539 bool tty_is_vc_resolve(const char *tty);
 540 bool tty_is_console(const char *tty) _pure_;
 541 int vtnr_from_tty(const char *tty);
 542 const char *default_term_for_tty(const char *tty);
 543
 544 void execute_directories(const char* const* directories, usec_t timeout, char *argv[]);
 545
 546 int kill_and_sigcont(pid_t pid, int sig);
 547
 548 bool nulstr_contains(const char*nulstr, const char *needle);
 549
 550 bool plymouth_running(void);
 551
 552 bool hostname_is_valid(const char *s) _pure_;
 553 char* hostname_cleanup(char *s, bool lowercase);
 554
 555 bool machine_name_is_valid(const char *s) _pure_;
 556
 557 char* strshorten(char *s, size_t l);
 558
 559 int terminal_vhangup_fd(int fd);
 560 int terminal_vhangup(const char *name);
 561
 562 int vt_disallocate(const char *name);
 563
 564 int symlink_atomic(const char *from, const char *to);
 565 int mknod_atomic(const char *path, mode_t mode, dev_t dev);
 566 int mkfifo_atomic(const char *path, mode_t mode);
 567
 568 int fchmod_umask(int fd, mode_t mode);
 569
 570 bool display_is_local(const char *display) _pure_;
 571 int socket_from_display(const char *display, char **path);
 572
 573 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
 574 int get_group_creds(const char **groupname, gid_t *gid);
 575
 576 int in_gid(gid_t gid);
 577 int in_group(const char *name);
 578
 579 char* uid_to_name(uid_t uid);
 580 char* gid_to_name(gid_t gid);
 581
 582 int glob_exists(const char *path);
 583 int glob_extend(char ***strv, const char *path);
 584
 585 int dirent_ensure_type(DIR *d, struct dirent *de);
 586
 587 int get_files_in_directory(const char *path, char ***list);
 588
 589 char *strjoin(const char *x, ...) _sentinel_;
 590
 591 bool is_main_thread(void);
 592
 593 static inline bool _pure_ in_charset(const char *s, const char* charset) {
 594         assert(s);
 595         assert(charset);
 596         return s[strspn(s, charset)] == '\0';
 597 }
 598
 599 int block_get_whole_disk(dev_t d, dev_t *ret);
 600
 601 #define NULSTR_FOREACH(i, l)                                    \
 602         for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
 603
 604 #define NULSTR_FOREACH_PAIR(i, j, l)                             \
 605         for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
 606
 607 int ioprio_class_to_string_alloc(int i, char **s);
 608 int ioprio_class_from_string(const char *s);
 609
 610 const char *sigchld_code_to_string(int i) _const_;
 611 int sigchld_code_from_string(const char *s) _pure_;
 612
 613 int log_facility_unshifted_to_string_alloc(int i, char **s);
 614 int log_facility_unshifted_from_string(const char *s);
 615
 616 int log_level_to_string_alloc(int i, char **s);
 617 int log_level_from_string(const char *s);
 618
 619 int sched_policy_to_string_alloc(int i, char **s);
 620 int sched_policy_from_string(const char *s);
 621
 622 const char *rlimit_to_string(int i) _const_;
 623 int rlimit_from_string(const char *s) _pure_;
 624
 625 int ip_tos_to_string_alloc(int i, char **s);
 626 int ip_tos_from_string(const char *s);
 627
 628 const char *signal_to_string(int i) _const_;
 629 int signal_from_string(const char *s) _pure_;
 630
 631 int signal_from_string_try_harder(const char *s);
 632
 633 extern int saved_argc;
 634 extern char **saved_argv;
 635
 636 bool kexec_loaded(void);
 637
 638 int prot_from_flags(int flags) _const_;
 639
 640 char *format_bytes(char *buf, size_t l, off_t t);
 641
 642 int fd_wait_for_event(int fd, int event, usec_t timeout);
 643
 644 void* memdup(const void *p, size_t l) _alloc_(2);
 645
 646 int is_kernel_thread(pid_t pid);
 647
 648 int fd_inc_sndbuf(int fd, size_t n);
 649 int fd_inc_rcvbuf(int fd, size_t n);
 650
 651 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
 652
 653 int setrlimit_closest(int resource, const struct rlimit *rlim);
 654
 655 int getenv_for_pid(pid_t pid, const char *field, char **_value);
 656
 657 bool http_url_is_valid(const char *url) _pure_;
 658 bool documentation_url_is_valid(const char *url) _pure_;
 659
 660 bool http_etag_is_valid(const char *etag);
 661
 662 bool in_initrd(void);
 663
 664 void warn_melody(void);
 665
 666 int get_home_dir(char **ret);
 667 int get_shell(char **_ret);
 668
 669 static inline void freep(void *p) {
 670         free(*(void**) p);
 671 }
 672
 673 static inline void closep(int *fd) {
 674         safe_close(*fd);
 675 }
 676
 677 static inline void umaskp(mode_t *u) {
 678         umask(*u);
 679 }
 680
 681 static inline void close_pairp(int (*p)[2]) {
 682         safe_close_pair(*p);
 683 }
 684
 685 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, fclose);
 686 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, pclose);
 687 DEFINE_TRIVIAL_CLEANUP_FUNC(DIR*, closedir);
 688 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, endmntent);
 689
 690 #define _cleanup_free_ _cleanup_(freep)
 691 #define _cleanup_close_ _cleanup_(closep)
 692 #define _cleanup_umask_ _cleanup_(umaskp)
 693 #define _cleanup_globfree_ _cleanup_(globfree)
 694 #define _cleanup_fclose_ _cleanup_(fclosep)
 695 #define _cleanup_pclose_ _cleanup_(pclosep)
 696 #define _cleanup_closedir_ _cleanup_(closedirp)
 697 #define _cleanup_endmntent_ _cleanup_(endmntentp)
 698 #define _cleanup_close_pair_ _cleanup_(close_pairp)
 699
 700 _malloc_  _alloc_(1, 2) static inline void *malloc_multiply(size_t a, size_t b) {
 701         if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
 702                 return NULL;
 703
 704         return malloc(a * b);
 705 }
 706
 707 _alloc_(2, 3) static inline void *realloc_multiply(void *p, size_t a, size_t b) {
 708         if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
 709                 return NULL;
 710
 711         return realloc(p, a * b);
 712 }
 713
 714 _alloc_(2, 3) static inline void *memdup_multiply(const void *p, size_t a, size_t b) {
 715         if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
 716                 return NULL;
 717
 718         return memdup(p, a * b);
 719 }
 720
 721 bool filename_is_valid(const char *p) _pure_;
 722 bool path_is_safe(const char *p) _pure_;
 723 bool string_is_safe(const char *p) _pure_;
 724 bool string_has_cc(const char *p, const char *ok) _pure_;
 725
 726 /**
 727  * Check if a string contains any glob patterns.
 728  */
 729 _pure_ static inline bool string_is_glob(const char *p) {
 730         return !!strpbrk(p, GLOB_CHARS);
 731 }
 732
 733 void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
 734                  int (*compar) (const void *, const void *, void *),
 735                  void *arg);
 736
 737 #define _(String) gettext (String)
 738 void init_gettext(void);
 739 bool is_locale_utf8(void);
 740
 741 typedef enum DrawSpecialChar {
 742         DRAW_TREE_VERTICAL,
 743         DRAW_TREE_BRANCH,
 744         DRAW_TREE_RIGHT,
 745         DRAW_TREE_SPACE,
 746         DRAW_TRIANGULAR_BULLET,
 747         DRAW_BLACK_CIRCLE,
 748         DRAW_ARROW,
 749         DRAW_DASH,
 750         _DRAW_SPECIAL_CHAR_MAX
 751 } DrawSpecialChar;
 752
 753 const char *draw_special_char(DrawSpecialChar ch);
 754
 755 char *strreplace(const char *text, const char *old_string, const char *new_string);
 756
 757 char *strip_tab_ansi(char **p, size_t *l);
 758
 759 int on_ac_power(void);
 760
 761 int search_and_fopen(const char *path, const char *mode, const char *root, const char **search, FILE **_f);
 762 int search_and_fopen_nulstr(const char *path, const char *mode, const char *root, const char *search, FILE **_f);
 763
 764 #define FOREACH_LINE(line, f, on_error)                         \
 765         for (;;)                                                \
 766                 if (!fgets(line, sizeof(line), f)) {            \
 767                         if (ferror(f)) {                        \
 768                                 on_error;                       \
 769                         }                                       \
 770                         break;                                  \
 771                 } else
 772
 773 #define FOREACH_DIRENT(de, d, on_error)                                 \
 774         for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d))   \
 775                 if (!de) {                                              \
 776                         if (errno > 0) {                                \
 777                                 on_error;                               \
 778                         }                                               \
 779                         break;                                          \
 780                 } else if (hidden_file((de)->d_name))                   \
 781                         continue;                                       \
 782                 else
 783
 784 #define FOREACH_DIRENT_ALL(de, d, on_error)                             \
 785         for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d))   \
 786                 if (!de) {                                              \
 787                         if (errno > 0) {                                \
 788                                 on_error;                               \
 789                         }                                               \
 790                         break;                                          \
 791                 } else
 792
 793 static inline void *mempset(void *s, int c, size_t n) {
 794         memset(s, c, n);
 795         return (uint8_t*)s + n;
 796 }
 797
 798 char *hexmem(const void *p, size_t l);
 799 void *unhexmem(const char *p, size_t l);
 800
 801 char *strextend(char **x, ...) _sentinel_;
 802 char *strrep(const char *s, unsigned n);
 803
 804 void* greedy_realloc(void **p, size_t *allocated, size_t need, size_t size);
 805 void* greedy_realloc0(void **p, size_t *allocated, size_t need, size_t size);
 806 #define GREEDY_REALLOC(array, allocated, need)                          \
 807         greedy_realloc((void**) &(array), &(allocated), (need), sizeof((array)[0]))
 808
 809 #define GREEDY_REALLOC0(array, allocated, need)                         \
 810         greedy_realloc0((void**) &(array), &(allocated), (need), sizeof((array)[0]))
 811
 812 static inline void _reset_errno_(int *saved_errno) {
 813         errno = *saved_errno;
 814 }
 815
 816 #define PROTECT_ERRNO _cleanup_(_reset_errno_) __attribute__((unused)) int _saved_errno_ = errno
 817
 818 static inline int negative_errno(void) {
 819         /* This helper should be used to shut up gcc if you know 'errno' is
 820          * negative. Instead of "return -errno;", use "return negative_errno();"
 821          * It will suppress bogus gcc warnings in case it assumes 'errno' might
 822          * be 0 and thus the caller's error-handling might not be triggered. */
 823         assert_return(errno > 0, -EINVAL);
 824         return -errno;
 825 }
 826
 827 struct _umask_struct_ {
 828         mode_t mask;
 829         bool quit;
 830 };
 831
 832 static inline void _reset_umask_(struct _umask_struct_ *s) {
 833         umask(s->mask);
 834 };
 835
 836 #define RUN_WITH_UMASK(mask)                                            \
 837         for (_cleanup_(_reset_umask_) struct _umask_struct_ _saved_umask_ = { umask(mask), false }; \
 838              !_saved_umask_.quit ;                                      \
 839              _saved_umask_.quit = true)
 840
 841 static inline unsigned u64log2(uint64_t n) {
 842 #if __SIZEOF_LONG_LONG__ == 8
 843         return (n > 1) ? (unsigned) __builtin_clzll(n) ^ 63U : 0;
 844 #else
 845 #error "Wut?"
 846 #endif
 847 }
 848
 849 static inline unsigned u32ctz(uint32_t n) {
 850 #if __SIZEOF_INT__ == 4
 851         return __builtin_ctz(n);
 852 #else
 853 #error "Wut?"
 854 #endif
 855 }
 856
 857 static inline unsigned log2i(int x) {
 858         assert(x > 0);
 859
 860         return __SIZEOF_INT__ * 8 - __builtin_clz(x) - 1;
 861 }
 862
 863 static inline unsigned log2u(unsigned x) {
 864         assert(x > 0);
 865
 866         return sizeof(unsigned) * 8 - __builtin_clz(x) - 1;
 867 }
 868
 869 static inline unsigned log2u_round_up(unsigned x) {
 870         assert(x > 0);
 871
 872         if (x == 1)
 873                 return 0;
 874
 875         return log2u(x - 1) + 1;
 876 }
 877
 878 static inline bool logind_running(void) {
 879         return access("/run/systemd/seats/", F_OK) >= 0;
 880 }
 881
 882 #define DECIMAL_STR_WIDTH(x)                            \
 883         ({                                              \
 884                 typeof(x) _x_ = (x);                    \
 885                 unsigned ans = 1;                       \
 886                 while (_x_ /= 10)                       \
 887                         ans++;                          \
 888                 ans;                                    \
 889         })
 890
 891 int unlink_noerrno(const char *path);
 892
 893 #define alloca0(n)                                      \
 894         ({                                              \
 895                 char *_new_;                            \
 896                 size_t _len_ = n;                       \
 897                 _new_ = alloca(_len_);                  \
 898                 (void *) memset(_new_, 0, _len_);       \
 899         })
 900
 901 /* It's not clear what alignment glibc/gcc alloca() guarantee, hence provide a guaranteed safe version */
 902 #define alloca_align(size, align)                                       \
 903         ({                                                              \
 904                 void *_ptr_;                                            \
 905                 size_t _mask_ = (align) - 1;                            \
 906                 _ptr_ = alloca((size) + _mask_);                        \
 907                 (void*)(((uintptr_t)_ptr_ + _mask_) & ~_mask_);         \
 908         })
 909
 910 #define alloca0_align(size, align)                                      \
 911         ({                                                              \
 912                 void *_new_;                                            \
 913                 size_t _size_ = (size);                                 \
 914                 _new_ = alloca_align(_size_, (align));                  \
 915                 (void*)memset(_new_, 0, _size_);                        \
 916         })
 917
 918 #define strjoina(a, ...)                                                \
 919         ({                                                              \
 920                 const char *_appendees_[] = { a, __VA_ARGS__ };         \
 921                 char *_d_, *_p_;                                        \
 922                 int _len_ = 0;                                          \
 923                 unsigned _i_;                                           \
 924                 for (_i_ = 0; _i_ < ELEMENTSOF(_appendees_) && _appendees_[_i_]; _i_++) \
 925                         _len_ += strlen(_appendees_[_i_]);              \
 926                 _p_ = _d_ = alloca(_len_ + 1);                          \
 927                 for (_i_ = 0; _i_ < ELEMENTSOF(_appendees_) && _appendees_[_i_]; _i_++) \
 928                         _p_ = stpcpy(_p_, _appendees_[_i_]);            \
 929                 *_p_ = 0;                                               \
 930                 _d_;                                                    \
 931         })
 932
 933 #define procfs_file_alloca(pid, field)                                  \
 934         ({                                                              \
 935                 pid_t _pid_ = (pid);                                    \
 936                 const char *_r_;                                        \
 937                 if (_pid_ == 0) {                                       \
 938                         _r_ = ("/proc/self/" field);                    \
 939                 } else {                                                \
 940                         _r_ = alloca(strlen("/proc/") + DECIMAL_STR_MAX(pid_t) + 1 + sizeof(field)); \
 941                         sprintf((char*) _r_, "/proc/"PID_FMT"/" field, _pid_);                       \
 942                 }                                                       \
 943                 _r_;                                                    \
 944         })
 945
 946 bool id128_is_valid(const char *s) _pure_;
 947
 948 int split_pair(const char *s, const char *sep, char **l, char **r);
 949
 950 int shall_restore_state(void);
 951
 952 /**
 953  * Normal qsort requires base to be nonnull. Here were require
 954  * that only if nmemb > 0.
 955  */
 956 static inline void qsort_safe(void *base, size_t nmemb, size_t size,
 957                               int (*compar)(const void *, const void *)) {
 958         if (nmemb) {
 959                 assert(base);
 960                 qsort(base, nmemb, size, compar);
 961         }
 962 }
 963
 964 int proc_cmdline(char **ret);
 965 int parse_proc_cmdline(int (*parse_word)(const char *key, const char *value));
 966 int get_proc_cmdline_key(const char *parameter, char **value);
 967
 968 int container_get_leader(const char *machine, pid_t *pid);
 969
 970 int namespace_open(pid_t pid, int *pidns_fd, int *mntns_fd, int *netns_fd, int *root_fd);
 971 int namespace_enter(int pidns_fd, int mntns_fd, int netns_fd, int root_fd);
 972
 973 bool pid_is_alive(pid_t pid);
 974 bool pid_is_unwaited(pid_t pid);
 975
 976 int getpeercred(int fd, struct ucred *ucred);
 977 int getpeersec(int fd, char **ret);
 978
 979 int writev_safe(int fd, const struct iovec *w, int j);
 980
 981 int mkostemp_safe(char *pattern, int flags);
 982 int open_tmpfile(const char *path, int flags);
 983
 984 int fd_warn_permissions(const char *path, int fd);
 985
 986 unsigned long personality_from_string(const char *p);
 987 const char *personality_to_string(unsigned long);
 988
 989 uint64_t physical_memory(void);
 990
 991 void hexdump(FILE *f, const void *p, size_t s);
 992
 993 union file_handle_union {
 994         struct file_handle handle;
 995         char padding[sizeof(struct file_handle) + MAX_HANDLE_SZ];
 996 };
 997 #define FILE_HANDLE_INIT { .handle.handle_bytes = MAX_HANDLE_SZ }
 998
 999 int update_reboot_param_file(const char *param);
1000
1001 int umount_recursive(const char *target, int flags);
1002
1003 int bind_remount_recursive(const char *prefix, bool ro);
1004
1005 int fflush_and_check(FILE *f);
1006
1007 int tempfn_xxxxxx(const char *p, char **ret);
1008 int tempfn_random(const char *p, char **ret);
1009 int tempfn_random_child(const char *p, char **ret);
1010
1011 bool is_localhost(const char *hostname);
1012
1013 int take_password_lock(const char *root);
1014
1015 int is_symlink(const char *path);
1016 int is_dir(const char *path, bool follow);
1017
1018 int unquote_first_word(const char **p, char **ret, bool relax);
1019 int unquote_many_words(const char **p, ...) _sentinel_;
1020
1021 int free_and_strdup(char **p, const char *s);
1022
1023 int sethostname_idempotent(const char *s);
1024
1025 #define INOTIFY_EVENT_MAX (sizeof(struct inotify_event) + NAME_MAX + 1)
1026
1027 #define FOREACH_INOTIFY_EVENT(e, buffer, sz) \
1028         for ((e) = &buffer.ev;                                \
1029              (uint8_t*) (e) < (uint8_t*) (buffer.raw) + (sz); \
1030              (e) = (struct inotify_event*) ((uint8_t*) (e) + sizeof(struct inotify_event) + (e)->len))
1031
1032 union inotify_event_buffer {
1033         struct inotify_event ev;
1034         uint8_t raw[INOTIFY_EVENT_MAX];
1035 };
1036
1037 #define laccess(path, mode) faccessat(AT_FDCWD, (path), (mode), AT_SYMLINK_NOFOLLOW)
1038
1039 int ptsname_malloc(int fd, char **ret);
1040
1041 int openpt_in_namespace(pid_t pid, int flags);
1042
1043 ssize_t fgetxattrat_fake(int dirfd, const char *filename, const char *attribute, void *value, size_t size, int flags);
1044
1045 int fd_setcrtime(int fd, usec_t usec);
1046 int fd_getcrtime(int fd, usec_t *usec);
1047 int path_getcrtime(const char *p, usec_t *usec);
1048 int fd_getcrtime_at(int dirfd, const char *name, usec_t *usec, int flags);
1049
1050 int same_fd(int a, int b);
1051
1052 int chattr_fd(int fd, bool b, unsigned mask);
1053 int chattr_path(const char *p, bool b, unsigned mask);
1054
1055 int read_attr_fd(int fd, unsigned *ret);
1056 int read_attr_path(const char *p, unsigned *ret);
1057
1058 typedef struct LockFile {
1059         char *path;
1060         int fd;
1061         int operation;
1062 } LockFile;
1063
1064 int make_lock_file(const char *p, int operation, LockFile *ret);
1065 int make_lock_file_for(const char *p, int operation, LockFile *ret);
1066 void release_lock_file(LockFile *f);
1067
1068 #define _cleanup_release_lock_file_ _cleanup_(release_lock_file)
1069
1070 #define LOCK_FILE_INIT { .fd = -1, .path = NULL }
1071
1072 #define RLIMIT_MAKE_CONST(lim) ((struct rlimit) { lim, lim })
1073
1074 ssize_t sparse_write(int fd, const void *p, size_t sz, size_t run_length);
1075
1076 void sigkill_wait(pid_t *pid);
1077 #define _cleanup_sigkill_wait_ _cleanup_(sigkill_wait)
1078
1079 int syslog_parse_priority(const char **p, int *priority, bool with_facility);
1080
1081 void cmsg_close_all(struct msghdr *mh);