src/shared/util.h

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