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