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