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