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