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