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