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