src/basic/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 <fcntl.h>
  26 #include <inttypes.h>
  27 #include <time.h>
  28 #include <stdarg.h>
  29 #include <stdbool.h>
  30 #include <stdlib.h>
  31 #include <stdio.h>
  32 #include <sched.h>
  33 #include <limits.h>
  34 #include <sys/types.h>
  35 #include <sys/socket.h>
  36 #include <sys/stat.h>
  37 #include <dirent.h>
  38 #include <stddef.h>
  39 #include <unistd.h>
  40 #include <locale.h>
  41 #include <mntent.h>
  42 #include <sys/inotify.h>
  43 #include <sys/statfs.h>
  44 #include <sys/sysmacros.h>
  45
  46 #include "macro.h"
  47 #include "missing.h"
  48 #include "time-util.h"
  49 #include "formats-util.h"
  50
  51 /* What is interpreted as whitespace? */
  52 #define WHITESPACE " \t\n\r"
  53 #define NEWLINE    "\n\r"
  54 #define QUOTES     "\"\'"
  55 #define COMMENTS   "#;"
  56 #define GLOB_CHARS "*?["
  57
  58 /* What characters are special in the shell? */
  59 /* must be escaped outside and inside double-quotes */
  60 #define SHELL_NEED_ESCAPE "\"\\`$"
  61 /* can be escaped or double-quoted */
  62 #define SHELL_NEED_QUOTES SHELL_NEED_ESCAPE GLOB_CHARS "'()<>|&;"
  63
  64 #define FORMAT_BYTES_MAX 8
  65
  66 size_t page_size(void) _pure_;
  67 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
  68
  69 #define streq(a,b) (strcmp((a),(b)) == 0)
  70 #define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
  71 #define strcaseeq(a,b) (strcasecmp((a),(b)) == 0)
  72 #define strncaseeq(a, b, n) (strncasecmp((a), (b), (n)) == 0)
  73
  74 bool streq_ptr(const char *a, const char *b) _pure_;
  75 int strcmp_ptr(const char *a, const char *b) _pure_;
  76
  77 #define new(t, n) ((t*) malloc_multiply(sizeof(t), (n)))
  78
  79 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
  80
  81 #define newa(t, n) ((t*) alloca(sizeof(t)*(n)))
  82
  83 #define newa0(t, n) ((t*) alloca0(sizeof(t)*(n)))
  84
  85 #define newdup(t, p, n) ((t*) memdup_multiply(p, sizeof(t), (n)))
  86
  87 #define malloc0(n) (calloc(1, (n)))
  88
  89 static inline void *mfree(void *memory) {
  90         free(memory);
  91         return NULL;
  92 }
  93
  94 static inline const char* yes_no(bool b) {
  95         return b ? "yes" : "no";
  96 }
  97
  98 static inline const char* true_false(bool b) {
  99         return b ? "true" : "false";
 100 }
 101
 102 static inline const char* one_zero(bool b) {
 103         return b ? "1" : "0";
 104 }
 105
 106 static inline const char* strempty(const char *s) {
 107         return s ? s : "";
 108 }
 109
 110 static inline const char* strnull(const char *s) {
 111         return s ? s : "(null)";
 112 }
 113
 114 static inline const char *strna(const char *s) {
 115         return s ? s : "n/a";
 116 }
 117
 118 static inline bool isempty(const char *p) {
 119         return !p || !p[0];
 120 }
 121
 122 static inline char *startswith(const char *s, const char *prefix) {
 123         size_t l;
 124
 125         l = strlen(prefix);
 126         if (strncmp(s, prefix, l) == 0)
 127                 return (char*) s + l;
 128
 129         return NULL;
 130 }
 131
 132 static inline char *startswith_no_case(const char *s, const char *prefix) {
 133         size_t l;
 134
 135         l = strlen(prefix);
 136         if (strncasecmp(s, prefix, l) == 0)
 137                 return (char*) s + l;
 138
 139         return NULL;
 140 }
 141
 142 char *endswith(const char *s, const char *postfix) _pure_;
 143 char *endswith_no_case(const char *s, const char *postfix) _pure_;
 144
 145 char *first_word(const char *s, const char *word) _pure_;
 146
 147 int close_nointr(int fd);
 148 int safe_close(int fd);
 149 void safe_close_pair(int p[]);
 150
 151 void close_many(const int fds[], unsigned n_fd);
 152
 153 int parse_size(const char *t, off_t base, off_t *size);
 154
 155 int parse_boolean(const char *v) _pure_;
 156 int parse_pid(const char *s, pid_t* ret_pid);
 157 int parse_uid(const char *s, uid_t* ret_uid);
 158 #define parse_gid(s, ret_gid) parse_uid(s, ret_gid)
 159
 160 bool uid_is_valid(uid_t uid);
 161 #define gid_is_valid(gid) uid_is_valid(gid)
 162
 163 int safe_atou(const char *s, unsigned *ret_u);
 164 int safe_atoi(const char *s, int *ret_i);
 165
 166 int safe_atollu(const char *s, unsigned long long *ret_u);
 167 int safe_atolli(const char *s, long long int *ret_i);
 168
 169 int safe_atod(const char *s, double *ret_d);
 170
 171 int safe_atou8(const char *s, uint8_t *ret);
 172
 173 #if LONG_MAX == INT_MAX
 174 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
 175         assert_cc(sizeof(unsigned long) == sizeof(unsigned));
 176         return safe_atou(s, (unsigned*) ret_u);
 177 }
 178 static inline int safe_atoli(const char *s, long int *ret_u) {
 179         assert_cc(sizeof(long int) == sizeof(int));
 180         return safe_atoi(s, (int*) ret_u);
 181 }
 182 #else
 183 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
 184         assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
 185         return safe_atollu(s, (unsigned long long*) ret_u);
 186 }
 187 static inline int safe_atoli(const char *s, long int *ret_u) {
 188         assert_cc(sizeof(long int) == sizeof(long long int));
 189         return safe_atolli(s, (long long int*) ret_u);
 190 }
 191 #endif
 192
 193 static inline int safe_atou32(const char *s, uint32_t *ret_u) {
 194         assert_cc(sizeof(uint32_t) == sizeof(unsigned));
 195         return safe_atou(s, (unsigned*) ret_u);
 196 }
 197
 198 static inline int safe_atoi32(const char *s, int32_t *ret_i) {
 199         assert_cc(sizeof(int32_t) == sizeof(int));
 200         return safe_atoi(s, (int*) ret_i);
 201 }
 202
 203 static inline int safe_atou64(const char *s, uint64_t *ret_u) {
 204         assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
 205         return safe_atollu(s, (unsigned long long*) ret_u);
 206 }
 207
 208 static inline int safe_atoi64(const char *s, int64_t *ret_i) {
 209         assert_cc(sizeof(int64_t) == sizeof(long long int));
 210         return safe_atolli(s, (long long int*) ret_i);
 211 }
 212
 213 int safe_atou16(const char *s, uint16_t *ret);
 214 int safe_atoi16(const char *s, int16_t *ret);
 215
 216 const char* split(const char **state, size_t *l, const char *separator, bool quoted);
 217
 218 #define FOREACH_WORD(word, length, s, state)                            \
 219         _FOREACH_WORD(word, length, s, WHITESPACE, false, state)
 220
 221 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state)       \
 222         _FOREACH_WORD(word, length, s, separator, false, state)
 223
 224 #define FOREACH_WORD_QUOTED(word, length, s, state)                     \
 225         _FOREACH_WORD(word, length, s, WHITESPACE, true, state)
 226
 227 #define _FOREACH_WORD(word, length, s, separator, quoted, state)        \
 228         for ((state) = (s), (word) = split(&(state), &(length), (separator), (quoted)); (word); (word) = split(&(state), &(length), (separator), (quoted)))
 229
 230 char *strappend(const char *s, const char *suffix);
 231 char *strnappend(const char *s, const char *suffix, size_t length);
 232
 233 int readlinkat_malloc(int fd, const char *p, char **ret);
 234 int readlink_malloc(const char *p, char **r);
 235 // UNNEEDED int readlink_value(const char *p, char **ret);
 236 int readlink_and_make_absolute(const char *p, char **r);
 237 // UNNEEDED int readlink_and_canonicalize(const char *p, char **r);
 238
 239 char *strstrip(char *s);
 240 // UNNEEDED char *delete_chars(char *s, const char *bad);
 241 char *truncate_nl(char *s);
 242
 243 char *file_in_same_dir(const char *path, const char *filename);
 244
 245 // UNNEEDED int rmdir_parents(const char *path, const char *stop);
 246
 247 char hexchar(int x) _const_;
 248 int unhexchar(char c) _const_;
 249 char octchar(int x) _const_;
 250 int unoctchar(char c) _const_;
 251 char decchar(int x) _const_;
 252 int undecchar(char c) _const_;
 253 char base32hexchar(int x) _const_;
 254 int unbase32hexchar(char c) _const_;
 255 char base64char(int x) _const_;
 256 int unbase64char(char c) _const_;
 257
 258 char *cescape(const char *s);
 259 size_t cescape_char(char c, char *buf);
 260
 261 typedef enum UnescapeFlags {
 262         UNESCAPE_RELAX = 1,
 263 } UnescapeFlags;
 264
 265 int cunescape(const char *s, UnescapeFlags flags, char **ret);
 266 int cunescape_length(const char *s, size_t length, UnescapeFlags flags, char **ret);
 267 int cunescape_length_with_prefix(const char *s, size_t length, const char *prefix, UnescapeFlags flags, char **ret);
 268
 269 char *xescape(const char *s, const char *bad);
 270
 271 // UNNEEDED char *ascii_strlower(char *path);
 272
 273 bool dirent_is_file(const struct dirent *de) _pure_;
 274 bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix) _pure_;
 275
 276 bool hidden_file(const char *filename) _pure_;
 277
 278 bool chars_intersect(const char *a, const char *b) _pure_;
 279
 280 /* For basic lookup tables with strictly enumerated entries */
 281 #define _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,scope)          \
 282         scope const char *name##_to_string(type i) {                    \
 283                 if (i < 0 || i >= (type) ELEMENTSOF(name##_table))      \
 284                         return NULL;                                    \
 285                 return name##_table[i];                                 \
 286         }
 287
 288 ssize_t string_table_lookup(const char * const *table, size_t len, const char *key);
 289
 290 #define _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,scope)        \
 291         scope type name##_from_string(const char *s) {                  \
 292                 return (type) string_table_lookup(name##_table, ELEMENTSOF(name##_table), s); \
 293         }
 294
 295 #define _DEFINE_STRING_TABLE_LOOKUP(name,type,scope)                    \
 296         _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,scope)          \
 297         _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,scope)        \
 298         struct __useless_struct_to_allow_trailing_semicolon__
 299
 300 #define DEFINE_STRING_TABLE_LOOKUP(name,type) _DEFINE_STRING_TABLE_LOOKUP(name,type,)
 301 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) _DEFINE_STRING_TABLE_LOOKUP(name,type,static)
 302 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_TO_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,static)
 303 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_FROM_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(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                 if (i < 0 || i > max)                                   \
 310                         return -ERANGE;                                 \
 311                 if (i < (type) ELEMENTSOF(name##_table)) {              \
 312                         s = strdup(name##_table[i]);                    \
 313                         if (!s)                                         \
 314                                 return -ENOMEM;                         \
 315                 } else {                                                \
 316                         if (asprintf(&s, "%i", i) < 0)                  \
 317                                 return -ENOMEM;                         \
 318                 }                                                       \
 319                 *str = s;                                               \
 320                 return 0;                                               \
 321         }                                                               \
 322         type name##_from_string(const char *s) {                        \
 323                 type i;                                                 \
 324                 unsigned u = 0;                                         \
 325                 if (!s)                                                 \
 326                         return (type) -1;                               \
 327                 for (i = 0; i < (type) ELEMENTSOF(name##_table); i++)   \
 328                         if (streq_ptr(name##_table[i], s))              \
 329                                 return i;                               \
 330                 if (safe_atou(s, &u) >= 0 && u <= max)                  \
 331                         return (type) u;                                \
 332                 return (type) -1;                                       \
 333         }                                                               \
 334         struct __useless_struct_to_allow_trailing_semicolon__
 335
 336 int fd_nonblock(int fd, bool nonblock);
 337 int fd_cloexec(int fd, bool cloexec);
 338
 339 int close_all_fds(const int except[], unsigned n_except);
 340
 341 // UNNEEDED bool fstype_is_network(const char *fstype);
 342
 343 int flush_fd(int fd);
 344
 345 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
 346
 347 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
 348 int loop_read_exact(int fd, void *buf, size_t nbytes, bool do_poll);
 349 int loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
 350
 351 bool is_device_path(const char *path);
 352
 353 // UNNEEDED int dir_is_empty(const char *path);
 354 // UNNEEDED char* dirname_malloc(const char *path);
 355
 356 char* lookup_uid(uid_t uid);
 357 // UNNEEDED char* getlogname_malloc(void);
 358 // UNNEEDED char* getusername_malloc(void);
 359
 360 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
 361 // UNNEEDED int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
 362
 363 bool is_temporary_fs(const struct statfs *s) _pure_;
 364 int fd_is_temporary_fs(int fd);
 365
 366 int pipe_eof(int fd);
 367
 368 DEFINE_TRIVIAL_CLEANUP_FUNC(cpu_set_t*, CPU_FREE);
 369 #define _cleanup_cpu_free_ _cleanup_(CPU_FREEp)
 370
 371 // UNNEEDED cpu_set_t* cpu_set_malloc(unsigned *ncpus);
 372
 373 #define xsprintf(buf, fmt, ...) assert_se((size_t) snprintf(buf, ELEMENTSOF(buf), fmt, __VA_ARGS__) < ELEMENTSOF(buf))
 374
 375 int files_same(const char *filea, const char *fileb);
 376
 377 int running_in_chroot(void);
 378
 379 char *ellipsize(const char *s, size_t length, unsigned percent);
 380                                    /* bytes                 columns */
 381 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
 382
 383 int touch_file(const char *path, bool parents, usec_t stamp, uid_t uid, gid_t gid, mode_t mode);
 384 int touch(const char *path);
 385
 386 noreturn void freeze(void);
 387
 388 bool null_or_empty(struct stat *st) _pure_;
 389 int null_or_empty_path(const char *fn);
 390 // UNNEEDED int null_or_empty_fd(int fd);
 391
 392 DIR *xopendirat(int dirfd, const char *name, int flags);
 393
 394 // UNNEEDED char *fstab_node_to_udev_node(const char *p);
 395
 396 void execute_directories(const char* const* directories, usec_t timeout, char *argv[]);
 397
 398 bool nulstr_contains(const char*nulstr, const char *needle);
 399
 400 // UNNEEDED bool plymouth_running(void);
 401
 402 char* strshorten(char *s, size_t l);
 403
 404 // UNNEEDED int symlink_idempotent(const char *from, const char *to);
 405
 406 // UNNEEDED int symlink_atomic(const char *from, const char *to);
 407 // UNNEEDED int mknod_atomic(const char *path, mode_t mode, dev_t dev);
 408 // UNNEEDED int mkfifo_atomic(const char *path, mode_t mode);
 409
 410 int fchmod_umask(int fd, mode_t mode);
 411
 412 bool display_is_local(const char *display) _pure_;
 413 int socket_from_display(const char *display, char **path);
 414
 415 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
 416 int get_group_creds(const char **groupname, gid_t *gid);
 417
 418 int in_gid(gid_t gid);
 419 // UNNEEDED int in_group(const char *name);
 420
 421 char* uid_to_name(uid_t uid);
 422 char* gid_to_name(gid_t gid);
 423
 424 // UNNEEDED int glob_exists(const char *path);
 425 // UNNEEDED int glob_extend(char ***strv, const char *path);
 426
 427 int dirent_ensure_type(DIR *d, struct dirent *de);
 428
 429 int get_files_in_directory(const char *path, char ***list);
 430
 431 char *strjoin(const char *x, ...) _sentinel_;
 432
 433 bool is_main_thread(void);
 434
 435 static inline bool _pure_ in_charset(const char *s, const char* charset) {
 436         assert(s);
 437         assert(charset);
 438         return s[strspn(s, charset)] == '\0';
 439 }
 440
 441 // UNNEEDED int block_get_whole_disk(dev_t d, dev_t *ret);
 442
 443 #define NULSTR_FOREACH(i, l)                                    \
 444         for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
 445
 446 #define NULSTR_FOREACH_PAIR(i, j, l)                             \
 447         for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
 448
 449 int ioprio_class_to_string_alloc(int i, char **s);
 450 int ioprio_class_from_string(const char *s);
 451
 452 const char *sigchld_code_to_string(int i) _const_;
 453 int sigchld_code_from_string(const char *s) _pure_;
 454
 455 int log_facility_unshifted_to_string_alloc(int i, char **s);
 456 int log_facility_unshifted_from_string(const char *s);
 457
 458 int log_level_to_string_alloc(int i, char **s);
 459 int log_level_from_string(const char *s);
 460
 461 int sched_policy_to_string_alloc(int i, char **s);
 462 int sched_policy_from_string(const char *s);
 463
 464 const char *rlimit_to_string(int i) _const_;
 465 int rlimit_from_string(const char *s) _pure_;
 466
 467 int ip_tos_to_string_alloc(int i, char **s);
 468 int ip_tos_from_string(const char *s);
 469
 470 extern int saved_argc;
 471 extern char **saved_argv;
 472
 473 bool kexec_loaded(void);
 474
 475 // UNNEEDED int prot_from_flags(int flags) _const_;
 476
 477 // UNNEEDED char *format_bytes(char *buf, size_t l, off_t t);
 478
 479 int fd_wait_for_event(int fd, int event, usec_t timeout);
 480
 481 void* memdup(const void *p, size_t l) _alloc_(2);
 482
 483 int fd_inc_sndbuf(int fd, size_t n);
 484 int fd_inc_rcvbuf(int fd, size_t n);
 485
 486 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
 487
 488 // UNNEEDED int setrlimit_closest(int resource, const struct rlimit *rlim);
 489
 490 bool http_url_is_valid(const char *url) _pure_;
 491 bool documentation_url_is_valid(const char *url) _pure_;
 492
 493 // UNNEEDED bool http_etag_is_valid(const char *etag);
 494
 495 bool in_initrd(void);
 496
 497 int get_home_dir(char **ret);
 498 // UNNEEDED int get_shell(char **_ret);
 499
 500 static inline void freep(void *p) {
 501         free(*(void**) p);
 502 }
 503
 504 static inline void closep(int *fd) {
 505         safe_close(*fd);
 506 }
 507
 508 static inline void umaskp(mode_t *u) {
 509         umask(*u);
 510 }
 511
 512 static inline void close_pairp(int (*p)[2]) {
 513         safe_close_pair(*p);
 514 }
 515
 516 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, fclose);
 517 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, pclose);
 518 DEFINE_TRIVIAL_CLEANUP_FUNC(DIR*, closedir);
 519 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, endmntent);
 520
 521 #define _cleanup_free_ _cleanup_(freep)
 522 #define _cleanup_close_ _cleanup_(closep)
 523 #define _cleanup_umask_ _cleanup_(umaskp)
 524 #define _cleanup_globfree_ _cleanup_(globfree)
 525 #define _cleanup_fclose_ _cleanup_(fclosep)
 526 #define _cleanup_pclose_ _cleanup_(pclosep)
 527 #define _cleanup_closedir_ _cleanup_(closedirp)
 528 #define _cleanup_endmntent_ _cleanup_(endmntentp)
 529 #define _cleanup_close_pair_ _cleanup_(close_pairp)
 530
 531 _malloc_  _alloc_(1, 2) static inline void *malloc_multiply(size_t a, size_t b) {
 532         if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
 533                 return NULL;
 534
 535         return malloc(a * b);
 536 }
 537
 538 _alloc_(2, 3) static inline void *realloc_multiply(void *p, size_t a, size_t b) {
 539         if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
 540                 return NULL;
 541
 542         return realloc(p, a * b);
 543 }
 544
 545 _alloc_(2, 3) static inline void *memdup_multiply(const void *p, size_t a, size_t b) {
 546         if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
 547                 return NULL;
 548
 549         return memdup(p, a * b);
 550 }
 551
 552 bool filename_is_valid(const char *p) _pure_;
 553 bool path_is_safe(const char *p) _pure_;
 554 bool string_is_safe(const char *p) _pure_;
 555 bool string_has_cc(const char *p, const char *ok) _pure_;
 556
 557 /**
 558  * Check if a string contains any glob patterns.
 559  */
 560 _pure_ static inline bool string_is_glob(const char *p) {
 561         return !!strpbrk(p, GLOB_CHARS);
 562 }
 563
 564 // UNNEEDED void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
 565 // UNNEEDED                 int (*compar) (const void *, const void *, void *),
 566 // UNNEEDED                 void *arg);
 567
 568 #define _(String) gettext (String)
 569 #define N_(String) String
 570 // UNNEEDED void init_gettext(void);
 571 bool is_locale_utf8(void);
 572
 573 typedef enum DrawSpecialChar {
 574         DRAW_TREE_VERTICAL,
 575         DRAW_TREE_BRANCH,
 576         DRAW_TREE_RIGHT,
 577         DRAW_TREE_SPACE,
 578         DRAW_TRIANGULAR_BULLET,
 579         DRAW_BLACK_CIRCLE,
 580         DRAW_ARROW,
 581         DRAW_DASH,
 582         _DRAW_SPECIAL_CHAR_MAX
 583 } DrawSpecialChar;
 584
 585 const char *draw_special_char(DrawSpecialChar ch);
 586
 587 // UNNEEDED char *strreplace(const char *text, const char *old_string, const char *new_string);
 588
 589 // UNNEEDED char *strip_tab_ansi(char **p, size_t *l);
 590
 591 // UNNEEDED int on_ac_power(void);
 592
 593 int search_and_fopen(const char *path, const char *mode, const char *root, const char **search, FILE **_f);
 594 // UNNEEDED int search_and_fopen_nulstr(const char *path, const char *mode, const char *root, const char *search, FILE **_f);
 595
 596 #define FOREACH_LINE(line, f, on_error)                         \
 597         for (;;)                                                \
 598                 if (!fgets(line, sizeof(line), f)) {            \
 599                         if (ferror(f)) {                        \
 600                                 on_error;                       \
 601                         }                                       \
 602                         break;                                  \
 603                 } else
 604
 605 #define FOREACH_DIRENT(de, d, on_error)                                 \
 606         for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d))   \
 607                 if (!de) {                                              \
 608                         if (errno > 0) {                                \
 609                                 on_error;                               \
 610                         }                                               \
 611                         break;                                          \
 612                 } else if (hidden_file((de)->d_name))                   \
 613                         continue;                                       \
 614                 else
 615
 616 #define FOREACH_DIRENT_ALL(de, d, on_error)                             \
 617         for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d))   \
 618                 if (!de) {                                              \
 619                         if (errno > 0) {                                \
 620                                 on_error;                               \
 621                         }                                               \
 622                         break;                                          \
 623                 } else
 624
 625 static inline void *mempset(void *s, int c, size_t n) {
 626         memset(s, c, n);
 627         return (uint8_t*)s + n;
 628 }
 629
 630 char *hexmem(const void *p, size_t l);
 631 int unhexmem(const char *p, size_t l, void **mem, size_t *len);
 632
 633 char *base32hexmem(const void *p, size_t l, bool padding);
 634 int unbase32hexmem(const char *p, size_t l, bool padding, void **mem, size_t *len);
 635
 636 char *base64mem(const void *p, size_t l);
 637 int unbase64mem(const char *p, size_t l, void **mem, size_t *len);
 638
 639 char *strextend(char **x, ...) _sentinel_;
 640 char *strrep(const char *s, unsigned n);
 641
 642 void* greedy_realloc(void **p, size_t *allocated, size_t need, size_t size);
 643 void* greedy_realloc0(void **p, size_t *allocated, size_t need, size_t size);
 644 #define GREEDY_REALLOC(array, allocated, need)                          \
 645         greedy_realloc((void**) &(array), &(allocated), (need), sizeof((array)[0]))
 646
 647 #define GREEDY_REALLOC0(array, allocated, need)                         \
 648         greedy_realloc0((void**) &(array), &(allocated), (need), sizeof((array)[0]))
 649
 650 static inline void _reset_errno_(int *saved_errno) {
 651         errno = *saved_errno;
 652 }
 653
 654 #define PROTECT_ERRNO _cleanup_(_reset_errno_) __attribute__((unused)) int _saved_errno_ = errno
 655
 656 static inline int negative_errno(void) {
 657         /* This helper should be used to shut up gcc if you know 'errno' is
 658          * negative. Instead of "return -errno;", use "return negative_errno();"
 659          * It will suppress bogus gcc warnings in case it assumes 'errno' might
 660          * be 0 and thus the caller's error-handling might not be triggered. */
 661         assert_return(errno > 0, -EINVAL);
 662         return -errno;
 663 }
 664
 665 struct _umask_struct_ {
 666         mode_t mask;
 667         bool quit;
 668 };
 669
 670 static inline void _reset_umask_(struct _umask_struct_ *s) {
 671         umask(s->mask);
 672 };
 673
 674 #define RUN_WITH_UMASK(mask)                                            \
 675         for (_cleanup_(_reset_umask_) struct _umask_struct_ _saved_umask_ = { umask(mask), false }; \
 676              !_saved_umask_.quit ;                                      \
 677              _saved_umask_.quit = true)
 678
 679 static inline unsigned u64log2(uint64_t n) {
 680 #if __SIZEOF_LONG_LONG__ == 8
 681         return (n > 1) ? (unsigned) __builtin_clzll(n) ^ 63U : 0;
 682 #else
 683 #error "Wut?"
 684 #endif
 685 }
 686
 687 static inline unsigned u32ctz(uint32_t n) {
 688 #if __SIZEOF_INT__ == 4
 689         return __builtin_ctz(n);
 690 #else
 691 #error "Wut?"
 692 #endif
 693 }
 694
 695 static inline unsigned log2i(int x) {
 696         assert(x > 0);
 697
 698         return __SIZEOF_INT__ * 8 - __builtin_clz(x) - 1;
 699 }
 700
 701 static inline unsigned log2u(unsigned x) {
 702         assert(x > 0);
 703
 704         return sizeof(unsigned) * 8 - __builtin_clz(x) - 1;
 705 }
 706
 707 static inline unsigned log2u_round_up(unsigned x) {
 708         assert(x > 0);
 709
 710         if (x == 1)
 711                 return 0;
 712
 713         return log2u(x - 1) + 1;
 714 }
 715
 716 static inline bool logind_running(void) {
 717         return access("/run/systemd/seats/", F_OK) >= 0;
 718 }
 719
 720 #define DECIMAL_STR_WIDTH(x)                            \
 721         ({                                              \
 722                 typeof(x) _x_ = (x);                    \
 723                 unsigned ans = 1;                       \
 724                 while (_x_ /= 10)                       \
 725                         ans++;                          \
 726                 ans;                                    \
 727         })
 728
 729 int unlink_noerrno(const char *path);
 730
 731 #define alloca0(n)                                      \
 732         ({                                              \
 733                 char *_new_;                            \
 734                 size_t _len_ = n;                       \
 735                 _new_ = alloca(_len_);                  \
 736                 (void *) memset(_new_, 0, _len_);       \
 737         })
 738
 739 /* It's not clear what alignment glibc/gcc alloca() guarantee, hence provide a guaranteed safe version */
 740 #define alloca_align(size, align)                                       \
 741         ({                                                              \
 742                 void *_ptr_;                                            \
 743                 size_t _mask_ = (align) - 1;                            \
 744                 _ptr_ = alloca((size) + _mask_);                        \
 745                 (void*)(((uintptr_t)_ptr_ + _mask_) & ~_mask_);         \
 746         })
 747
 748 #define alloca0_align(size, align)                                      \
 749         ({                                                              \
 750                 void *_new_;                                            \
 751                 size_t _size_ = (size);                                 \
 752                 _new_ = alloca_align(_size_, (align));                  \
 753                 (void*)memset(_new_, 0, _size_);                        \
 754         })
 755
 756 #define strjoina(a, ...)                                                \
 757         ({                                                              \
 758                 const char *_appendees_[] = { a, __VA_ARGS__ };         \
 759                 char *_d_, *_p_;                                        \
 760                 int _len_ = 0;                                          \
 761                 unsigned _i_;                                           \
 762                 for (_i_ = 0; _i_ < ELEMENTSOF(_appendees_) && _appendees_[_i_]; _i_++) \
 763                         _len_ += strlen(_appendees_[_i_]);              \
 764                 _p_ = _d_ = alloca(_len_ + 1);                          \
 765                 for (_i_ = 0; _i_ < ELEMENTSOF(_appendees_) && _appendees_[_i_]; _i_++) \
 766                         _p_ = stpcpy(_p_, _appendees_[_i_]);            \
 767                 *_p_ = 0;                                               \
 768                 _d_;                                                    \
 769         })
 770
 771 bool id128_is_valid(const char *s) _pure_;
 772
 773 // UNNEEDED int split_pair(const char *s, const char *sep, char **l, char **r);
 774
 775 // UNNEEDED int shall_restore_state(void);
 776
 777 /**
 778  * Normal qsort requires base to be nonnull. Here were require
 779  * that only if nmemb > 0.
 780  */
 781 static inline void qsort_safe(void *base, size_t nmemb, size_t size, comparison_fn_t compar) {
 782         if (nmemb <= 1)
 783                 return;
 784
 785         assert(base);
 786         qsort(base, nmemb, size, compar);
 787 }
 788
 789 /* Normal memmem() requires haystack to be nonnull, which is annoying for zero-length buffers */
 790 static inline void *memmem_safe(const void *haystack, size_t haystacklen, const void *needle, size_t needlelen) {
 791
 792         if (needlelen <= 0)
 793                 return (void*) haystack;
 794
 795         if (haystacklen < needlelen)
 796                 return NULL;
 797
 798         assert(haystack);
 799         assert(needle);
 800
 801         return memmem(haystack, haystacklen, needle, needlelen);
 802 }
 803
 804 int proc_cmdline(char **ret);
 805 int parse_proc_cmdline(int (*parse_word)(const char *key, const char *value));
 806 int get_proc_cmdline_key(const char *parameter, char **value);
 807
 808 int container_get_leader(const char *machine, pid_t *pid);
 809
 810 int namespace_open(pid_t pid, int *pidns_fd, int *mntns_fd, int *netns_fd, int *userns_fd, int *root_fd);
 811 int namespace_enter(int pidns_fd, int mntns_fd, int netns_fd, int userns_fd, int root_fd);
 812
 813 int getpeercred(int fd, struct ucred *ucred);
 814 int getpeersec(int fd, char **ret);
 815
 816 int writev_safe(int fd, const struct iovec *w, int j);
 817
 818 int mkostemp_safe(char *pattern, int flags);
 819 // UNNEEDED int open_tmpfile(const char *path, int flags);
 820
 821 int fd_warn_permissions(const char *path, int fd);
 822
 823 #ifndef PERSONALITY_INVALID
 824 /* personality(7) documents that 0xffffffffUL is used for querying the
 825  * current personality, hence let's use that here as error
 826  * indicator. */
 827 #define PERSONALITY_INVALID 0xffffffffLU
 828 #endif
 829
 830 // UNNEEDED unsigned long personality_from_string(const char *p);
 831 // UNNEEDED const char *personality_to_string(unsigned long);
 832
 833 uint64_t physical_memory(void);
 834
 835 // UNNEEDED void hexdump(FILE *f, const void *p, size_t s);
 836
 837 union file_handle_union {
 838         struct file_handle handle;
 839         char padding[sizeof(struct file_handle) + MAX_HANDLE_SZ];
 840 };
 841 #define FILE_HANDLE_INIT { .handle.handle_bytes = MAX_HANDLE_SZ }
 842
 843 // UNNEEDED int update_reboot_param_file(const char *param);
 844
 845 // UNNEEDED int umount_recursive(const char *target, int flags);
 846
 847 // UNNEEDED int bind_remount_recursive(const char *prefix, bool ro);
 848
 849 int fflush_and_check(FILE *f);
 850
 851 int tempfn_xxxxxx(const char *p, const char *extra, char **ret);
 852 int tempfn_random(const char *p, const char *extra, char **ret);
 853 // UNNEEDED int tempfn_random_child(const char *p, const char *extra, char **ret);
 854
 855 // UNNEEDED int take_password_lock(const char *root);
 856
 857 // UNNEEDED int is_symlink(const char *path);
 858 int is_dir(const char *path, bool follow);
 859 // UNNEEDED int is_device_node(const char *path);
 860
 861 typedef enum ExtractFlags {
 862         EXTRACT_RELAX           = 1,
 863         EXTRACT_CUNESCAPE       = 2,
 864         EXTRACT_CUNESCAPE_RELAX = 4,
 865         EXTRACT_QUOTES          = 8,
 866         EXTRACT_DONT_COALESCE_SEPARATORS = 16,
 867 } ExtractFlags;
 868
 869 int extract_first_word(const char **p, char **ret, const char *separators, ExtractFlags flags);
 870 // UNNEEDED int extract_first_word_and_warn(const char **p, char **ret, const char *separators, ExtractFlags flags, const char *unit, const char *filename, unsigned line, const char *rvalue);
 871 // UNNEEDED int extract_many_words(const char **p, const char *separators, ExtractFlags flags, ...) _sentinel_;
 872
 873 static inline void free_and_replace(char **s, char *v) {
 874         free(*s);
 875         *s = v;
 876 }
 877
 878 int free_and_strdup(char **p, const char *s);
 879
 880 #define INOTIFY_EVENT_MAX (sizeof(struct inotify_event) + NAME_MAX + 1)
 881
 882 #define FOREACH_INOTIFY_EVENT(e, buffer, sz) \
 883         for ((e) = &buffer.ev;                                \
 884              (uint8_t*) (e) < (uint8_t*) (buffer.raw) + (sz); \
 885              (e) = (struct inotify_event*) ((uint8_t*) (e) + sizeof(struct inotify_event) + (e)->len))
 886
 887 union inotify_event_buffer {
 888         struct inotify_event ev;
 889         uint8_t raw[INOTIFY_EVENT_MAX];
 890 };
 891
 892 #ifdef __GLIBC__
 893  #define laccess(path, mode) faccessat(AT_FDCWD, (path), (mode), AT_SYMLINK_NOFOLLOW)
 894 #else
 895  #define laccess(path, mode) faccessat(AT_FDCWD, (path), (mode), 0)
 896 #endif
 897
 898 // UNNEEDED int ptsname_malloc(int fd, char **ret);
 899
 900 // UNNEEDED int openpt_in_namespace(pid_t pid, int flags);
 901
 902 ssize_t fgetxattrat_fake(int dirfd, const char *filename, const char *attribute, void *value, size_t size, int flags);
 903
 904 // UNNEEDED int fd_setcrtime(int fd, usec_t usec);
 905 int fd_getcrtime(int fd, usec_t *usec);
 906 // UNNEEDED int path_getcrtime(const char *p, usec_t *usec);
 907 // UNNEEDED int fd_getcrtime_at(int dirfd, const char *name, usec_t *usec, int flags);
 908
 909 // UNNEEDED int same_fd(int a, int b);
 910
 911 int chattr_fd(int fd, unsigned value, unsigned mask);
 912 // UNNEEDED int chattr_path(const char *p, unsigned value, unsigned mask);
 913
 914 int read_attr_fd(int fd, unsigned *ret);
 915 // UNNEEDED int read_attr_path(const char *p, unsigned *ret);
 916
 917 #define RLIMIT_MAKE_CONST(lim) ((struct rlimit) { lim, lim })
 918
 919 // UNNEEDED ssize_t sparse_write(int fd, const void *p, size_t sz, size_t run_length);
 920
 921 void sigkill_wait(pid_t *pid);
 922 #define _cleanup_sigkill_wait_ _cleanup_(sigkill_wait)
 923
 924 // UNNEEDED int syslog_parse_priority(const char **p, int *priority, bool with_facility);
 925
 926 // UNNEEDED void cmsg_close_all(struct msghdr *mh);
 927
 928 // UNNEEDED int rename_noreplace(int olddirfd, const char *oldpath, int newdirfd, const char *newpath);
 929
 930 // UNNEEDED char *shell_escape(const char *s, const char *bad);
 931 // UNNEEDED char *shell_maybe_quote(const char *s);
 932
 933 int parse_mode(const char *s, mode_t *ret);
 934
 935 // UNNEEDED int mount_move_root(const char *path);
 936
 937 int reset_uid_gid(void);
 938
 939 int getxattr_malloc(const char *path, const char *name, char **value, bool allow_symlink);
 940 int fgetxattr_malloc(int fd, const char *name, char **value);