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