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