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