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