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 union dirent_storage {
  48         struct dirent de;
  49         uint8_t storage[offsetof(struct dirent, d_name) +
  50                         ((NAME_MAX + 1 + sizeof(long)) & ~(sizeof(long) - 1))];
  51 };
  52
  53 /* What is interpreted as whitespace? */
  54 #define WHITESPACE " \t\n\r"
  55 #define NEWLINE "\n\r"
  56 #define QUOTES "\"\'"
  57 #define COMMENTS "#;"
  58
  59 #define FORMAT_BYTES_MAX 8
  60
  61 #define ANSI_HIGHLIGHT_ON "\x1B[1;39m"
  62 #define ANSI_RED_ON "\x1B[31m"
  63 #define ANSI_HIGHLIGHT_RED_ON "\x1B[1;31m"
  64 #define ANSI_GREEN_ON "\x1B[32m"
  65 #define ANSI_HIGHLIGHT_GREEN_ON "\x1B[1;32m"
  66 #define ANSI_HIGHLIGHT_YELLOW_ON "\x1B[1;33m"
  67 #define ANSI_HIGHLIGHT_BLUE_ON "\x1B[1;34m"
  68 #define ANSI_HIGHLIGHT_OFF "\x1B[0m"
  69 #define ANSI_ERASE_TO_END_OF_LINE "\x1B[K"
  70
  71 size_t page_size(void);
  72 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
  73
  74 #define streq(a,b) (strcmp((a),(b)) == 0)
  75 #define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
  76 #define strcaseeq(a,b) (strcasecmp((a),(b)) == 0)
  77 #define strncaseeq(a, b, n) (strncasecmp((a), (b), (n)) == 0)
  78
  79 bool streq_ptr(const char *a, const char *b) _pure_;
  80
  81 #define new(t, n) ((t*) malloc_multiply(sizeof(t), (n)))
  82
  83 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
  84
  85 #define newa(t, n) ((t*) alloca(sizeof(t)*(n)))
  86
  87 #define newdup(t, p, n) ((t*) memdup_multiply(p, sizeof(t), (n)))
  88
  89 #define malloc0(n) (calloc((n), 1))
  90
  91 static inline const char* yes_no(bool b) {
  92         return b ? "yes" : "no";
  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 unsigned long long random_ull(void);
 255 unsigned random_u(void);
 256
 257 /* For basic lookup tables with strictly enumerated entries */
 258 #define __DEFINE_STRING_TABLE_LOOKUP(name,type,scope)                   \
 259         scope const char *name##_to_string(type i) {                    \
 260                 if (i < 0 || i >= (type) ELEMENTSOF(name##_table))      \
 261                         return NULL;                                    \
 262                 return name##_table[i];                                 \
 263         }                                                               \
 264         scope type name##_from_string(const char *s) {                  \
 265                 type i;                                                 \
 266                 assert(s);                                              \
 267                 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++)    \
 268                         if (name##_table[i] &&                          \
 269                             streq(name##_table[i], s))                  \
 270                                 return i;                               \
 271                 return (type) -1;                                       \
 272         }                                                               \
 273         struct __useless_struct_to_allow_trailing_semicolon__
 274
 275 #define DEFINE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,)
 276 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,static)
 277
 278 /* For string conversions where numbers are also acceptable */
 279 #define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max)         \
 280         int name##_to_string_alloc(type i, char **str) {                \
 281                 char *s;                                                \
 282                 int r;                                                  \
 283                 if (i < 0 || i > max)                                   \
 284                         return -ERANGE;                                 \
 285                 if (i < (type) ELEMENTSOF(name##_table)) {              \
 286                         s = strdup(name##_table[i]);                    \
 287                         if (!s)                                         \
 288                                 return log_oom();                       \
 289                 } else {                                                \
 290                         r = asprintf(&s, "%u", i);                      \
 291                         if (r < 0)                                      \
 292                                 return log_oom();                       \
 293                 }                                                       \
 294                 *str = s;                                               \
 295                 return 0;                                               \
 296         }                                                               \
 297         type name##_from_string(const char *s) {                        \
 298                 type i;                                                 \
 299                 unsigned u = 0;                                         \
 300                 assert(s);                                              \
 301                 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++)    \
 302                         if (name##_table[i] &&                          \
 303                             streq(name##_table[i], s))                  \
 304                                 return i;                               \
 305                 if (safe_atou(s, &u) >= 0 && u <= max)                  \
 306                         return (type) u;                                \
 307                 return (type) -1;                                       \
 308         }                                                               \
 309         struct __useless_struct_to_allow_trailing_semicolon__
 310
 311 int fd_nonblock(int fd, bool nonblock);
 312 int fd_cloexec(int fd, bool cloexec);
 313
 314 int close_all_fds(const int except[], unsigned n_except);
 315
 316 bool fstype_is_network(const char *fstype);
 317
 318 int chvt(int vt);
 319
 320 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
 321 int ask(char *ret, const char *replies, const char *text, ...) _printf_(3, 4);
 322
 323 int reset_terminal_fd(int fd, bool switch_to_text);
 324 int reset_terminal(const char *name);
 325
 326 int open_terminal(const char *name, int mode);
 327 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
 328 int release_terminal(void);
 329
 330 int flush_fd(int fd);
 331
 332 int ignore_signals(int sig, ...);
 333 int default_signals(int sig, ...);
 334 int sigaction_many(const struct sigaction *sa, ...);
 335
 336 int close_pipe(int p[]);
 337 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
 338
 339 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
 340 ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
 341
 342 bool is_device_path(const char *path);
 343
 344 int dir_is_empty(const char *path);
 345 char* dirname_malloc(const char *path);
 346
 347 void rename_process(const char name[8]);
 348
 349 void sigset_add_many(sigset_t *ss, ...);
 350
 351 bool hostname_is_set(void);
 352
 353 char* gethostname_malloc(void);
 354 char* getlogname_malloc(void);
 355 char* getusername_malloc(void);
 356
 357 int getttyname_malloc(int fd, char **r);
 358 int getttyname_harder(int fd, char **r);
 359
 360 int get_ctty_devnr(pid_t pid, dev_t *d);
 361 int get_ctty(pid_t, dev_t *_devnr, char **r);
 362
 363 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
 364 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
 365
 366 int rm_rf_children(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
 367 int rm_rf_children_dangerous(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
 368 int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
 369 int rm_rf_dangerous(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
 370
 371 int pipe_eof(int fd);
 372
 373 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
 374
 375 int status_vprintf(const char *status, bool ellipse, bool ephemeral, const char *format, va_list ap) _printf_(4,0);
 376 int status_printf(const char *status, bool ellipse, bool ephemeral, const char *format, ...) _printf_(4,5);
 377 int status_welcome(void);
 378
 379 int fd_columns(int fd);
 380 unsigned columns(void);
 381 int fd_lines(int fd);
 382 unsigned lines(void);
 383 void columns_lines_cache_reset(int _unused_ signum);
 384
 385 bool on_tty(void);
 386
 387 static inline const char *ansi_highlight(void) {
 388         return on_tty() ? ANSI_HIGHLIGHT_ON : "";
 389 }
 390
 391 static inline const char *ansi_highlight_red(void) {
 392         return on_tty() ? ANSI_HIGHLIGHT_RED_ON : "";
 393 }
 394
 395 static inline const char *ansi_highlight_green(void) {
 396         return on_tty() ? ANSI_HIGHLIGHT_GREEN_ON : "";
 397 }
 398
 399 static inline const char *ansi_highlight_yellow(void) {
 400         return on_tty() ? ANSI_HIGHLIGHT_YELLOW_ON : "";
 401 }
 402
 403 static inline const char *ansi_highlight_blue(void) {
 404         return on_tty() ? ANSI_HIGHLIGHT_BLUE_ON : "";
 405 }
 406
 407 static inline const char *ansi_highlight_off(void) {
 408         return on_tty() ? ANSI_HIGHLIGHT_OFF : "";
 409 }
 410
 411 int running_in_chroot(void);
 412
 413 char *ellipsize(const char *s, size_t length, unsigned percent);
 414                                    /* bytes                 columns */
 415 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
 416
 417 int touch(const char *path);
 418
 419 char *unquote(const char *s, const char *quotes);
 420 char *normalize_env_assignment(const char *s);
 421
 422 int wait_for_terminate(pid_t pid, siginfo_t *status);
 423 int wait_for_terminate_and_warn(const char *name, pid_t pid);
 424
 425 _noreturn_ void freeze(void);
 426
 427 bool null_or_empty(struct stat *st) _pure_;
 428 int null_or_empty_path(const char *fn);
 429
 430 DIR *xopendirat(int dirfd, const char *name, int flags);
 431
 432 char *fstab_node_to_udev_node(const char *p);
 433
 434 char *resolve_dev_console(char **active);
 435 bool tty_is_vc(const char *tty);
 436 bool tty_is_vc_resolve(const char *tty);
 437 bool tty_is_console(const char *tty) _pure_;
 438 int vtnr_from_tty(const char *tty);
 439 const char *default_term_for_tty(const char *tty);
 440
 441 void execute_directory(const char *directory, DIR *_d, char *argv[]);
 442
 443 int kill_and_sigcont(pid_t pid, int sig);
 444
 445 bool nulstr_contains(const char*nulstr, const char *needle);
 446
 447 bool plymouth_running(void);
 448
 449 bool hostname_is_valid(const char *s) _pure_;
 450 char* hostname_cleanup(char *s, bool lowercase);
 451
 452 char* strshorten(char *s, size_t l);
 453
 454 int terminal_vhangup_fd(int fd);
 455 int terminal_vhangup(const char *name);
 456
 457 int vt_disallocate(const char *name);
 458
 459 int copy_file(const char *from, const char *to, int flags);
 460
 461 int symlink_atomic(const char *from, const char *to);
 462
 463 int fchmod_umask(int fd, mode_t mode);
 464
 465 bool display_is_local(const char *display) _pure_;
 466 int socket_from_display(const char *display, char **path);
 467
 468 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
 469 int get_group_creds(const char **groupname, gid_t *gid);
 470
 471 int in_gid(gid_t gid);
 472 int in_group(const char *name);
 473
 474 char* uid_to_name(uid_t uid);
 475 char* gid_to_name(gid_t gid);
 476
 477 int glob_exists(const char *path);
 478 int glob_extend(char ***strv, const char *path);
 479
 480 int dirent_ensure_type(DIR *d, struct dirent *de);
 481
 482 int in_search_path(const char *path, char **search);
 483 int get_files_in_directory(const char *path, char ***list);
 484
 485 char *strjoin(const char *x, ...) _sentinel_;
 486
 487 bool is_main_thread(void);
 488
 489 bool in_charset(const char *s, const char* charset) _pure_;
 490
 491 int block_get_whole_disk(dev_t d, dev_t *ret);
 492
 493 int file_is_priv_sticky(const char *p);
 494
 495 int strdup_or_null(const char *a, char **b);
 496
 497 #define NULSTR_FOREACH(i, l)                                    \
 498         for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
 499
 500 #define NULSTR_FOREACH_PAIR(i, j, l)                             \
 501         for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
 502
 503 int ioprio_class_to_string_alloc(int i, char **s);
 504 int ioprio_class_from_string(const char *s);
 505
 506 const char *sigchld_code_to_string(int i) _const_;
 507 int sigchld_code_from_string(const char *s) _pure_;
 508
 509 int log_facility_unshifted_to_string_alloc(int i, char **s);
 510 int log_facility_unshifted_from_string(const char *s);
 511
 512 int log_level_to_string_alloc(int i, char **s);
 513 int log_level_from_string(const char *s);
 514
 515 int sched_policy_to_string_alloc(int i, char **s);
 516 int sched_policy_from_string(const char *s);
 517
 518 const char *rlimit_to_string(int i) _const_;
 519 int rlimit_from_string(const char *s) _pure_;
 520
 521 int ip_tos_to_string_alloc(int i, char **s);
 522 int ip_tos_from_string(const char *s);
 523
 524 const char *signal_to_string(int i) _const_;
 525 int signal_from_string(const char *s) _pure_;
 526
 527 int signal_from_string_try_harder(const char *s);
 528
 529 extern int saved_argc;
 530 extern char **saved_argv;
 531
 532 bool kexec_loaded(void);
 533
 534 int prot_from_flags(int flags) _const_;
 535
 536 char *format_bytes(char *buf, size_t l, off_t t);
 537
 538 int fd_wait_for_event(int fd, int event, usec_t timeout);
 539
 540 void* memdup(const void *p, size_t l) _alloc_(2);
 541
 542 int is_kernel_thread(pid_t pid);
 543
 544 int fd_inc_sndbuf(int fd, size_t n);
 545 int fd_inc_rcvbuf(int fd, size_t n);
 546
 547 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
 548
 549 int setrlimit_closest(int resource, const struct rlimit *rlim);
 550
 551 int getenv_for_pid(pid_t pid, const char *field, char **_value);
 552
 553 bool is_valid_documentation_url(const char *url) _pure_;
 554
 555 bool in_initrd(void);
 556
 557 void warn_melody(void);
 558
 559 int get_home_dir(char **ret);
 560 int get_shell(char **_ret);
 561
 562 static inline void freep(void *p) {
 563         free(*(void**) p);
 564 }
 565
 566 #define DEFINE_TRIVIAL_CLEANUP_FUNC(type, func)                 \
 567         static inline void func##p(type *p) {                   \
 568                 if (*p)                                         \
 569                         func(*p);                               \
 570         }                                                       \
 571         struct __useless_struct_to_allow_trailing_semicolon__
 572
 573 static inline void closep(int *fd) {
 574         if (*fd >= 0)
 575                 close_nointr_nofail(*fd);
 576 }
 577
 578 static inline void umaskp(mode_t *u) {
 579         umask(*u);
 580 }
 581
 582 static inline void close_pipep(int (*p)[2]) {
 583         close_pipe(*p);
 584 }
 585
 586 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, fclose);
 587 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, pclose);
 588 DEFINE_TRIVIAL_CLEANUP_FUNC(DIR*, closedir);
 589 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, endmntent);
 590
 591 #define _cleanup_free_ _cleanup_(freep)
 592 #define _cleanup_close_ _cleanup_(closep)
 593 #define _cleanup_umask_ _cleanup_(umaskp)
 594 #define _cleanup_globfree_ _cleanup_(globfree)
 595 #define _cleanup_fclose_ _cleanup_(fclosep)
 596 #define _cleanup_pclose_ _cleanup_(pclosep)
 597 #define _cleanup_closedir_ _cleanup_(closedirp)
 598 #define _cleanup_endmntent_ _cleanup_(endmntentp)
 599 #define _cleanup_close_pipe_ _cleanup_(close_pipep)
 600
 601 _malloc_  _alloc_(1, 2) static inline void *malloc_multiply(size_t a, size_t b) {
 602         if (_unlikely_(b == 0 || a > ((size_t) -1) / b))
 603                 return NULL;
 604
 605         return malloc(a * b);
 606 }
 607
 608 _alloc_(2, 3) static inline void *memdup_multiply(const void *p, size_t a, size_t b) {
 609         if (_unlikely_(b == 0 || a > ((size_t) -1) / b))
 610                 return NULL;
 611
 612         return memdup(p, a * b);
 613 }
 614
 615 bool filename_is_safe(const char *p) _pure_;
 616 bool path_is_safe(const char *p) _pure_;
 617 bool string_is_safe(const char *p) _pure_;
 618 bool string_has_cc(const char *p) _pure_;
 619
 620 void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
 621                  int (*compar) (const void *, const void *, void *),
 622                  void *arg);
 623
 624 bool is_locale_utf8(void);
 625
 626 typedef enum DrawSpecialChar {
 627         DRAW_TREE_VERT,
 628         DRAW_TREE_BRANCH,
 629         DRAW_TREE_RIGHT,
 630         DRAW_TREE_SPACE,
 631         DRAW_TRIANGULAR_BULLET,
 632         DRAW_BLACK_CIRCLE,
 633         _DRAW_SPECIAL_CHAR_MAX
 634 } DrawSpecialChar;
 635 const char *draw_special_char(DrawSpecialChar ch);
 636
 637 char *strreplace(const char *text, const char *old_string, const char *new_string);
 638
 639 char *strip_tab_ansi(char **p, size_t *l);
 640
 641 int on_ac_power(void);
 642
 643 int search_and_fopen(const char *path, const char *mode, const char **search, FILE **_f);
 644 int search_and_fopen_nulstr(const char *path, const char *mode, const char *search, FILE **_f);
 645
 646 #define FOREACH_LINE(line, f, on_error)                         \
 647         for (;;)                                                \
 648                 if (!fgets(line, sizeof(line), f)) {            \
 649                         if (ferror(f)) {                        \
 650                                 on_error;                       \
 651                         }                                       \
 652                         break;                                  \
 653                 } else
 654
 655 #define FOREACH_DIRENT(de, d, on_error)                                 \
 656         for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d))   \
 657                 if (!de) {                                              \
 658                         if (errno > 0) {                                \
 659                                 on_error;                               \
 660                         }                                               \
 661                         break;                                          \
 662                 } else if (ignore_file((de)->d_name))                   \
 663                         continue;                                       \
 664                 else
 665
 666 static inline void *mempset(void *s, int c, size_t n) {
 667         memset(s, c, n);
 668         return (uint8_t*)s + n;
 669 }
 670
 671 char *hexmem(const void *p, size_t l);
 672 void *unhexmem(const char *p, size_t l);
 673
 674 char *strextend(char **x, ...) _sentinel_;
 675 char *strrep(const char *s, unsigned n);
 676
 677 void* greedy_realloc(void **p, size_t *allocated, size_t need);
 678 void* greedy_realloc0(void **p, size_t *allocated, size_t need);
 679 #define GREEDY_REALLOC(array, allocated, need) \
 680         greedy_realloc((void**) &(array), &(allocated), sizeof((array)[0]) * (need))
 681 #define GREEDY_REALLOC0(array, allocated, need) \
 682         greedy_realloc0((void**) &(array), &(allocated), sizeof((array)[0]) * (need))
 683
 684 static inline void _reset_errno_(int *saved_errno) {
 685         errno = *saved_errno;
 686 }
 687
 688 #define PROTECT_ERRNO _cleanup_(_reset_errno_) __attribute__((unused)) int _saved_errno_ = errno
 689
 690 struct _umask_struct_ {
 691         mode_t mask;
 692         bool quit;
 693 };
 694
 695 static inline void _reset_umask_(struct _umask_struct_ *s) {
 696         umask(s->mask);
 697 };
 698
 699 #define RUN_WITH_UMASK(mask)                                            \
 700         for (_cleanup_(_reset_umask_) struct _umask_struct_ _saved_umask_ = { umask(mask), false }; \
 701              !_saved_umask_.quit ;                                      \
 702              _saved_umask_.quit = true)
 703
 704 static inline unsigned u64log2(uint64_t n) {
 705         return (n > 1) ? __builtin_clzll(n) ^ 63U : 0;
 706 }
 707
 708 static inline bool logind_running(void) {
 709         return access("/run/systemd/seats/", F_OK) >= 0;
 710 }
 711
 712 #define DECIMAL_STR_WIDTH(x)                            \
 713         ({                                              \
 714                 typeof(x) _x_ = (x);                    \
 715                 unsigned ans = 1;                       \
 716                 while (_x_ /= 10)                       \
 717                         ans++;                          \
 718                 ans;                                    \
 719         })
 720
 721 int unlink_noerrno(const char *path);
 722
 723 #define alloca0(n)                                      \
 724         ({                                              \
 725                 char *_new_;                            \
 726                 size_t _len_ = n;                       \
 727                 _new_ = alloca(_len_);                  \
 728                 (void *) memset(_new_, 0, _len_);       \
 729         })
 730
 731 #define strappenda(a, b)                                \
 732         ({                                              \
 733                 const char *_a_ = (a), *_b_ = (b);      \
 734                 char *_c_;                              \
 735                 size_t _x_, _y_;                        \
 736                 _x_ = strlen(_a_);                      \
 737                 _y_ = strlen(_b_);                      \
 738                 _c_ = alloca(_x_ + _y_ + 1);            \
 739                 strcpy(stpcpy(_c_, _a_), _b_);          \
 740                 _c_;                                    \
 741         })
 742
 743 #define procfs_file_alloca(pid, field)                                  \
 744         ({                                                              \
 745                 pid_t _pid_ = (pid);                                    \
 746                 char *_r_;                                              \
 747                 _r_ = alloca(sizeof("/proc/") -1 + DECIMAL_STR_MAX(pid_t) + 1 + sizeof(field)); \
 748                 sprintf(_r_, "/proc/%lu/" field, (unsigned long) _pid_); \
 749                 _r_;                                                    \
 750         })
 751
 752 struct _locale_struct_ {
 753         locale_t saved_locale;
 754         locale_t new_locale;
 755         bool quit;
 756 };
 757
 758 static inline void _reset_locale_(struct _locale_struct_ *s) {
 759         PROTECT_ERRNO;
 760         if (s->saved_locale != (locale_t) 0)
 761                 uselocale(s->saved_locale);
 762         if (s->new_locale != (locale_t) 0)
 763                 freelocale(s->new_locale);
 764 }
 765
 766 #define RUN_WITH_LOCALE(mask, loc) \
 767         for (_cleanup_(_reset_locale_) struct _locale_struct_ _saved_locale_ = { (locale_t) 0, (locale_t) 0, false }; \
 768              ({                                                         \
 769                      if (!_saved_locale_.quit) {                        \
 770                              PROTECT_ERRNO;                             \
 771                              _saved_locale_.new_locale = newlocale((mask), (loc), (locale_t) 0); \
 772                              if (_saved_locale_.new_locale != (locale_t) 0)     \
 773                                      _saved_locale_.saved_locale = uselocale(_saved_locale_.new_locale); \
 774                      }                                                  \
 775                      !_saved_locale_.quit; }) ;                         \
 776              _saved_locale_.quit = true)
 777
 778 bool id128_is_valid(const char *s) _pure_;
 779 void parse_user_at_host(char *arg, char **user, char **host);
 780
 781 int split_pair(const char *s, const char *sep, char **l, char **r);
 782
 783 int shall_restore_state(void);
 784
 785 /**
 786  * Normal qsort requires base to be nonnull. Here were require
 787  * that only if nmemb > 0.
 788  */
 789 static inline void qsort_safe(void *base, size_t nmemb, size_t size,
 790                               int (*compar)(const void *, const void *)) {
 791         if (nmemb) {
 792                 assert(base);
 793                 qsort(base, nmemb, size, compar);
 794         }
 795 }
 796
 797 int proc_cmdline(char **ret);
 798
 799 int container_get_leader(const char *machine, pid_t *pid);
 800
 801 int namespace_open(pid_t pid, int *pidns_fd, int *mntns_fd, int *root_fd);
 802 int namespace_enter(int pidns_fd, int mntns_fd, int root_fd);