src/basic/fs-util.c

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 /***
   3   This file is part of systemd.
   4
   5   Copyright 2010 Lennart Poettering
   6 ***/
   7
   8 #include <errno.h>
   9 #include <stddef.h>
  10 #include <stdio.h>
  11 #include <stdlib.h>
  12 #include <string.h>
  13 #include <sys/stat.h>
  14 #include <linux/magic.h>
  15 #include <time.h>
  16 #include <unistd.h>
  17
  18 #include "alloc-util.h"
  19 #include "dirent-util.h"
  20 #include "fd-util.h"
  21 #include "fileio.h"
  22 #include "fs-util.h"
  23 //#include "log.h"
  24 //#include "macro.h"
  25 //#include "missing.h"
  26 #include "mkdir.h"
  27 #include "parse-util.h"
  28 #include "path-util.h"
  29 //#include "process-util.h"
  30 #include "stat-util.h"
  31 #include "stdio-util.h"
  32 #include "string-util.h"
  33 #include "strv.h"
  34 //#include "time-util.h"
  35 #include "user-util.h"
  36 #include "util.h"
  37
  38 /// Additional includes needed by elogind
  39 #include "process-util.h"
  40
  41 int unlink_noerrno(const char *path) {
  42         PROTECT_ERRNO;
  43         int r;
  44
  45         r = unlink(path);
  46         if (r < 0)
  47                 return -errno;
  48
  49         return 0;
  50 }
  51
  52 #if 0 /// UNNEEDED by elogind
  53 int rmdir_parents(const char *path, const char *stop) {
  54         size_t l;
  55         int r = 0;
  56
  57         assert(path);
  58         assert(stop);
  59
  60         l = strlen(path);
  61
  62         /* Skip trailing slashes */
  63         while (l > 0 && path[l-1] == '/')
  64                 l--;
  65
  66         while (l > 0) {
  67                 char *t;
  68
  69                 /* Skip last component */
  70                 while (l > 0 && path[l-1] != '/')
  71                         l--;
  72
  73                 /* Skip trailing slashes */
  74                 while (l > 0 && path[l-1] == '/')
  75                         l--;
  76
  77                 if (l <= 0)
  78                         break;
  79
  80                 t = strndup(path, l);
  81                 if (!t)
  82                         return -ENOMEM;
  83
  84                 if (path_startswith(stop, t)) {
  85                         free(t);
  86                         return 0;
  87                 }
  88
  89                 r = rmdir(t);
  90                 free(t);
  91
  92                 if (r < 0)
  93                         if (errno != ENOENT)
  94                                 return -errno;
  95         }
  96
  97         return 0;
  98 }
  99
 100 int rename_noreplace(int olddirfd, const char *oldpath, int newdirfd, const char *newpath) {
 101         struct stat buf;
 102         int ret;
 103
 104         ret = renameat2(olddirfd, oldpath, newdirfd, newpath, RENAME_NOREPLACE);
 105         if (ret >= 0)
 106                 return 0;
 107
 108         /* renameat2() exists since Linux 3.15, btrfs added support for it later.
 109          * If it is not implemented, fallback to another method. */
 110         if (!IN_SET(errno, EINVAL, ENOSYS))
 111                 return -errno;
 112
 113         /* The link()/unlink() fallback does not work on directories. But
 114          * renameat() without RENAME_NOREPLACE gives the same semantics on
 115          * directories, except when newpath is an *empty* directory. This is
 116          * good enough. */
 117         ret = fstatat(olddirfd, oldpath, &buf, AT_SYMLINK_NOFOLLOW);
 118         if (ret >= 0 && S_ISDIR(buf.st_mode)) {
 119                 ret = renameat(olddirfd, oldpath, newdirfd, newpath);
 120                 return ret >= 0 ? 0 : -errno;
 121         }
 122
 123         /* If it is not a directory, use the link()/unlink() fallback. */
 124         ret = linkat(olddirfd, oldpath, newdirfd, newpath, 0);
 125         if (ret < 0)
 126                 return -errno;
 127
 128         ret = unlinkat(olddirfd, oldpath, 0);
 129         if (ret < 0) {
 130                 /* backup errno before the following unlinkat() alters it */
 131                 ret = errno;
 132                 (void) unlinkat(newdirfd, newpath, 0);
 133                 errno = ret;
 134                 return -errno;
 135         }
 136
 137         return 0;
 138 }
 139 #endif // 0
 140
 141 int readlinkat_malloc(int fd, const char *p, char **ret) {
 142         size_t l = 100;
 143         int r;
 144
 145         assert(p);
 146         assert(ret);
 147
 148         for (;;) {
 149                 char *c;
 150                 ssize_t n;
 151
 152                 c = new(char, l);
 153                 if (!c)
 154                         return -ENOMEM;
 155
 156                 n = readlinkat(fd, p, c, l-1);
 157                 if (n < 0) {
 158                         r = -errno;
 159                         free(c);
 160                         return r;
 161                 }
 162
 163                 if ((size_t) n < l-1) {
 164                         c[n] = 0;
 165                         *ret = c;
 166                         return 0;
 167                 }
 168
 169                 free(c);
 170                 l *= 2;
 171         }
 172 }
 173
 174 int readlink_malloc(const char *p, char **ret) {
 175         return readlinkat_malloc(AT_FDCWD, p, ret);
 176 }
 177
 178 #if 0 /// UNNEEDED by elogind
 179 int readlink_value(const char *p, char **ret) {
 180         _cleanup_free_ char *link = NULL;
 181         char *value;
 182         int r;
 183
 184         r = readlink_malloc(p, &link);
 185         if (r < 0)
 186                 return r;
 187
 188         value = basename(link);
 189         if (!value)
 190                 return -ENOENT;
 191
 192         value = strdup(value);
 193         if (!value)
 194                 return -ENOMEM;
 195
 196         *ret = value;
 197
 198         return 0;
 199 }
 200 #endif // 0
 201
 202 int readlink_and_make_absolute(const char *p, char **r) {
 203         _cleanup_free_ char *target = NULL;
 204         char *k;
 205         int j;
 206
 207         assert(p);
 208         assert(r);
 209
 210         j = readlink_malloc(p, &target);
 211         if (j < 0)
 212                 return j;
 213
 214         k = file_in_same_dir(p, target);
 215         if (!k)
 216                 return -ENOMEM;
 217
 218         *r = k;
 219         return 0;
 220 }
 221
 222 #if 0 /// UNNEEDED by elogind
 223 #endif // 0
 224 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid) {
 225         assert(path);
 226
 227         /* Under the assumption that we are running privileged we
 228          * first change the access mode and only then hand out
 229          * ownership to avoid a window where access is too open. */
 230
 231         if (mode != MODE_INVALID)
 232                 if (chmod(path, mode) < 0)
 233                         return -errno;
 234
 235         if (uid != UID_INVALID || gid != GID_INVALID)
 236                 if (chown(path, uid, gid) < 0)
 237                         return -errno;
 238
 239         return 0;
 240 }
 241
 242 int fchmod_umask(int fd, mode_t m) {
 243         mode_t u;
 244         int r;
 245
 246         u = umask(0777);
 247         r = fchmod(fd, m & (~u)) < 0 ? -errno : 0;
 248         umask(u);
 249
 250         return r;
 251 }
 252
 253 int fchmod_opath(int fd, mode_t m) {
 254         char procfs_path[STRLEN("/proc/self/fd/") + DECIMAL_STR_MAX(int)];
 255
 256         /* This function operates also on fd that might have been opened with
 257          * O_PATH. Indeed fchmodat() doesn't have the AT_EMPTY_PATH flag like
 258          * fchownat() does. */
 259
 260         xsprintf(procfs_path, "/proc/self/fd/%i", fd);
 261
 262         if (chmod(procfs_path, m) < 0)
 263                 return -errno;
 264
 265         return 0;
 266 }
 267
 268 int fd_warn_permissions(const char *path, int fd) {
 269         struct stat st;
 270
 271         if (fstat(fd, &st) < 0)
 272                 return -errno;
 273
 274         if (st.st_mode & 0111)
 275                 log_warning("Configuration file %s is marked executable. Please remove executable permission bits. Proceeding anyway.", path);
 276
 277         if (st.st_mode & 0002)
 278                 log_warning("Configuration file %s is marked world-writable. Please remove world writability permission bits. Proceeding anyway.", path);
 279
 280         if (getpid_cached() == 1 && (st.st_mode & 0044) != 0044)
 281                 log_warning("Configuration file %s is marked world-inaccessible. This has no effect as configuration data is accessible via APIs without restrictions. Proceeding anyway.", path);
 282
 283         return 0;
 284 }
 285
 286 int touch_file(const char *path, bool parents, usec_t stamp, uid_t uid, gid_t gid, mode_t mode) {
 287         char fdpath[STRLEN("/proc/self/fd/") + DECIMAL_STR_MAX(int)];
 288         _cleanup_close_ int fd = -1;
 289         int r, ret = 0;
 290
 291         assert(path);
 292
 293         /* Note that touch_file() does not follow symlinks: if invoked on an existing symlink, then it is the symlink
 294          * itself which is updated, not its target
 295          *
 296          * Returns the first error we encounter, but tries to apply as much as possible. */
 297
 298         if (parents)
 299                 (void) mkdir_parents(path, 0755);
 300
 301         /* Initially, we try to open the node with O_PATH, so that we get a reference to the node. This is useful in
 302          * case the path refers to an existing device or socket node, as we can open it successfully in all cases, and
 303          * won't trigger any driver magic or so. */
 304         fd = open(path, O_PATH|O_CLOEXEC|O_NOFOLLOW);
 305         if (fd < 0) {
 306                 if (errno != ENOENT)
 307                         return -errno;
 308
 309                 /* if the node doesn't exist yet, we create it, but with O_EXCL, so that we only create a regular file
 310                  * here, and nothing else */
 311                 fd = open(path, O_WRONLY|O_CREAT|O_EXCL|O_CLOEXEC, IN_SET(mode, 0, MODE_INVALID) ? 0644 : mode);
 312                 if (fd < 0)
 313                         return -errno;
 314         }
 315
 316         /* Let's make a path from the fd, and operate on that. With this logic, we can adjust the access mode,
 317          * ownership and time of the file node in all cases, even if the fd refers to an O_PATH object — which is
 318          * something fchown(), fchmod(), futimensat() don't allow. */
 319         xsprintf(fdpath, "/proc/self/fd/%i", fd);
 320
 321         if (mode != MODE_INVALID)
 322                 if (chmod(fdpath, mode) < 0)
 323                         ret = -errno;
 324
 325         if (uid_is_valid(uid) || gid_is_valid(gid))
 326                 if (chown(fdpath, uid, gid) < 0 && ret >= 0)
 327                         ret = -errno;
 328
 329         if (stamp != USEC_INFINITY) {
 330                 struct timespec ts[2];
 331
 332                 timespec_store(&ts[0], stamp);
 333                 ts[1] = ts[0];
 334                 r = utimensat(AT_FDCWD, fdpath, ts, 0);
 335         } else
 336                 r = utimensat(AT_FDCWD, fdpath, NULL, 0);
 337         if (r < 0 && ret >= 0)
 338                 return -errno;
 339
 340         return ret;
 341 }
 342
 343 int touch(const char *path) {
 344         return touch_file(path, false, USEC_INFINITY, UID_INVALID, GID_INVALID, MODE_INVALID);
 345 }
 346
 347 #if 0 /// UNNEEDED by elogind
 348 int symlink_idempotent(const char *from, const char *to) {
 349         int r;
 350
 351         assert(from);
 352         assert(to);
 353
 354         if (symlink(from, to) < 0) {
 355                 _cleanup_free_ char *p = NULL;
 356
 357                 if (errno != EEXIST)
 358                         return -errno;
 359
 360                 r = readlink_malloc(to, &p);
 361                 if (r == -EINVAL) /* Not a symlink? In that case return the original error we encountered: -EEXIST */
 362                         return -EEXIST;
 363                 if (r < 0) /* Any other error? In that case propagate it as is */
 364                         return r;
 365
 366                 if (!streq(p, from)) /* Not the symlink we want it to be? In that case, propagate the original -EEXIST */
 367                         return -EEXIST;
 368         }
 369
 370         return 0;
 371 }
 372
 373 int symlink_atomic(const char *from, const char *to) {
 374         _cleanup_free_ char *t = NULL;
 375         int r;
 376
 377         assert(from);
 378         assert(to);
 379
 380         r = tempfn_random(to, NULL, &t);
 381         if (r < 0)
 382                 return r;
 383
 384         if (symlink(from, t) < 0)
 385                 return -errno;
 386
 387         if (rename(t, to) < 0) {
 388                 unlink_noerrno(t);
 389                 return -errno;
 390         }
 391
 392         return 0;
 393 }
 394
 395 int mknod_atomic(const char *path, mode_t mode, dev_t dev) {
 396         _cleanup_free_ char *t = NULL;
 397         int r;
 398
 399         assert(path);
 400
 401         r = tempfn_random(path, NULL, &t);
 402         if (r < 0)
 403                 return r;
 404
 405         if (mknod(t, mode, dev) < 0)
 406                 return -errno;
 407
 408         if (rename(t, path) < 0) {
 409                 unlink_noerrno(t);
 410                 return -errno;
 411         }
 412
 413         return 0;
 414 }
 415
 416 int mkfifo_atomic(const char *path, mode_t mode) {
 417         _cleanup_free_ char *t = NULL;
 418         int r;
 419
 420         assert(path);
 421
 422         r = tempfn_random(path, NULL, &t);
 423         if (r < 0)
 424                 return r;
 425
 426         if (mkfifo(t, mode) < 0)
 427                 return -errno;
 428
 429         if (rename(t, path) < 0) {
 430                 unlink_noerrno(t);
 431                 return -errno;
 432         }
 433
 434         return 0;
 435 }
 436 #endif // 0
 437
 438 int get_files_in_directory(const char *path, char ***list) {
 439         _cleanup_closedir_ DIR *d = NULL;
 440         struct dirent *de;
 441         size_t bufsize = 0, n = 0;
 442         _cleanup_strv_free_ char **l = NULL;
 443
 444         assert(path);
 445
 446         /* Returns all files in a directory in *list, and the number
 447          * of files as return value. If list is NULL returns only the
 448          * number. */
 449
 450         d = opendir(path);
 451         if (!d)
 452                 return -errno;
 453
 454         FOREACH_DIRENT_ALL(de, d, return -errno) {
 455                 dirent_ensure_type(d, de);
 456
 457                 if (!dirent_is_file(de))
 458                         continue;
 459
 460                 if (list) {
 461                         /* one extra slot is needed for the terminating NULL */
 462                         if (!GREEDY_REALLOC(l, bufsize, n + 2))
 463                                 return -ENOMEM;
 464
 465                         l[n] = strdup(de->d_name);
 466                         if (!l[n])
 467                                 return -ENOMEM;
 468
 469                         l[++n] = NULL;
 470                 } else
 471                         n++;
 472         }
 473
 474         if (list)
 475                 *list = TAKE_PTR(l);
 476
 477         return n;
 478 }
 479
 480 static int getenv_tmp_dir(const char **ret_path) {
 481         const char *n;
 482         int r, ret = 0;
 483
 484         assert(ret_path);
 485
 486         /* We use the same order of environment variables python uses in tempfile.gettempdir():
 487          * https://docs.python.org/3/library/tempfile.html#tempfile.gettempdir */
 488         FOREACH_STRING(n, "TMPDIR", "TEMP", "TMP") {
 489                 const char *e;
 490
 491                 e = secure_getenv(n);
 492                 if (!e)
 493                         continue;
 494                 if (!path_is_absolute(e)) {
 495                         r = -ENOTDIR;
 496                         goto next;
 497                 }
 498                 if (!path_is_normalized(e)) {
 499                         r = -EPERM;
 500                         goto next;
 501                 }
 502
 503                 r = is_dir(e, true);
 504                 if (r < 0)
 505                         goto next;
 506                 if (r == 0) {
 507                         r = -ENOTDIR;
 508                         goto next;
 509                 }
 510
 511                 *ret_path = e;
 512                 return 1;
 513
 514         next:
 515                 /* Remember first error, to make this more debuggable */
 516                 if (ret >= 0)
 517                         ret = r;
 518         }
 519
 520         if (ret < 0)
 521                 return ret;
 522
 523         *ret_path = NULL;
 524         return ret;
 525 }
 526
 527 static int tmp_dir_internal(const char *def, const char **ret) {
 528         const char *e;
 529         int r, k;
 530
 531         assert(def);
 532         assert(ret);
 533
 534         r = getenv_tmp_dir(&e);
 535         if (r > 0) {
 536                 *ret = e;
 537                 return 0;
 538         }
 539
 540         k = is_dir(def, true);
 541         if (k == 0)
 542                 k = -ENOTDIR;
 543         if (k < 0)
 544                 return r < 0 ? r : k;
 545
 546         *ret = def;
 547         return 0;
 548 }
 549
 550 #if 0 /// UNNEEDED by elogind
 551 int var_tmp_dir(const char **ret) {
 552
 553         /* Returns the location for "larger" temporary files, that is backed by physical storage if available, and thus
 554          * even might survive a boot: /var/tmp. If $TMPDIR (or related environment variables) are set, its value is
 555          * returned preferably however. Note that both this function and tmp_dir() below are affected by $TMPDIR,
 556          * making it a variable that overrides all temporary file storage locations. */
 557
 558         return tmp_dir_internal("/var/tmp", ret);
 559 }
 560 #endif // 0
 561
 562 int tmp_dir(const char **ret) {
 563
 564         /* Similar to var_tmp_dir() above, but returns the location for "smaller" temporary files, which is usually
 565          * backed by an in-memory file system: /tmp. */
 566
 567         return tmp_dir_internal("/tmp", ret);
 568 }
 569
 570 int unlink_or_warn(const char *filename) {
 571         if (unlink(filename) < 0 && errno != ENOENT)
 572                 /* If the file doesn't exist and the fs simply was read-only (in which
 573                  * case unlink() returns EROFS even if the file doesn't exist), don't
 574                  * complain */
 575                 if (errno != EROFS || access(filename, F_OK) >= 0)
 576                         return log_error_errno(errno, "Failed to remove \"%s\": %m", filename);
 577
 578         return 0;
 579 }
 580
 581 #if 0 /// UNNEEDED by elogind
 582 int inotify_add_watch_fd(int fd, int what, uint32_t mask) {
 583         char path[STRLEN("/proc/self/fd/") + DECIMAL_STR_MAX(int) + 1];
 584         int r;
 585
 586         /* This is like inotify_add_watch(), except that the file to watch is not referenced by a path, but by an fd */
 587         xsprintf(path, "/proc/self/fd/%i", what);
 588
 589         r = inotify_add_watch(fd, path, mask);
 590         if (r < 0)
 591                 return -errno;
 592
 593         return r;
 594 }
 595 #endif // 0
 596
 597 static bool safe_transition(const struct stat *a, const struct stat *b) {
 598         /* Returns true if the transition from a to b is safe, i.e. that we never transition from unprivileged to
 599          * privileged files or directories. Why bother? So that unprivileged code can't symlink to privileged files
 600          * making us believe we read something safe even though it isn't safe in the specific context we open it in. */
 601
 602         if (a->st_uid == 0) /* Transitioning from privileged to unprivileged is always fine */
 603                 return true;
 604
 605         return a->st_uid == b->st_uid; /* Otherwise we need to stay within the same UID */
 606 }
 607
 608 int chase_symlinks(const char *path, const char *original_root, unsigned flags, char **ret) {
 609         _cleanup_free_ char *buffer = NULL, *done = NULL, *root = NULL;
 610         _cleanup_close_ int fd = -1;
 611         unsigned max_follow = CHASE_SYMLINKS_MAX; /* how many symlinks to follow before giving up and returning ELOOP */
 612         struct stat previous_stat;
 613         bool exists = true;
 614         char *todo;
 615         int r;
 616
 617         assert(path);
 618
 619         /* Either the file may be missing, or we return an fd to the final object, but both make no sense */
 620         if ((flags & (CHASE_NONEXISTENT|CHASE_OPEN)) == (CHASE_NONEXISTENT|CHASE_OPEN))
 621                 return -EINVAL;
 622
 623         if ((flags & (CHASE_STEP|CHASE_OPEN)) == (CHASE_STEP|CHASE_OPEN))
 624                 return -EINVAL;
 625
 626         if (isempty(path))
 627                 return -EINVAL;
 628
 629         /* This is a lot like canonicalize_file_name(), but takes an additional "root" parameter, that allows following
 630          * symlinks relative to a root directory, instead of the root of the host.
 631          *
 632          * Note that "root" primarily matters if we encounter an absolute symlink. It is also used when following
 633          * relative symlinks to ensure they cannot be used to "escape" the root directory. The path parameter passed is
 634          * assumed to be already prefixed by it, except if the CHASE_PREFIX_ROOT flag is set, in which case it is first
 635          * prefixed accordingly.
 636          *
 637          * Algorithmically this operates on two path buffers: "done" are the components of the path we already
 638          * processed and resolved symlinks, "." and ".." of. "todo" are the components of the path we still need to
 639          * process. On each iteration, we move one component from "todo" to "done", processing it's special meaning
 640          * each time. The "todo" path always starts with at least one slash, the "done" path always ends in no
 641          * slash. We always keep an O_PATH fd to the component we are currently processing, thus keeping lookup races
 642          * at a minimum.
 643          *
 644          * Suggested usage: whenever you want to canonicalize a path, use this function. Pass the absolute path you got
 645          * as-is: fully qualified and relative to your host's root. Optionally, specify the root parameter to tell this
 646          * function what to do when encountering a symlink with an absolute path as directory: prefix it by the
 647          * specified path.
 648          *
 649          * There are three ways to invoke this function:
 650          *
 651          * 1. Without CHASE_STEP or CHASE_OPEN: in this case the path is resolved and the normalized path is returned
 652          *    in `ret`. The return value is < 0 on error. If CHASE_NONEXISTENT is also set 0 is returned if the file
 653          *    doesn't exist, > 0 otherwise. If CHASE_NONEXISTENT is not set >= 0 is returned if the destination was
 654          *    found, -ENOENT if it doesn't.
 655          *
 656          * 2. With CHASE_OPEN: in this case the destination is opened after chasing it as O_PATH and this file
 657          *    descriptor is returned as return value. This is useful to open files relative to some root
 658          *    directory. Note that the returned O_PATH file descriptors must be converted into a regular one (using
 659          *    fd_reopen() or such) before it can be used for reading/writing. CHASE_OPEN may not be combined with
 660          *    CHASE_NONEXISTENT.
 661          *
 662          * 3. With CHASE_STEP: in this case only a single step of the normalization is executed, i.e. only the first
 663          *    symlink or ".." component of the path is resolved, and the resulting path is returned. This is useful if
 664          *    a caller wants to trace the a path through the file system verbosely. Returns < 0 on error, > 0 if the
 665          *    path is fully normalized, and == 0 for each normalization step. This may be combined with
 666          *    CHASE_NONEXISTENT, in which case 1 is returned when a component is not found.
 667          *
 668          * */
 669
 670         /* A root directory of "/" or "" is identical to none */
 671         if (empty_or_root(original_root))
 672                 original_root = NULL;
 673
 674         if (!original_root && !ret && (flags & (CHASE_NONEXISTENT|CHASE_NO_AUTOFS|CHASE_SAFE|CHASE_OPEN|CHASE_STEP)) == CHASE_OPEN) {
 675                 /* Shortcut the CHASE_OPEN case if the caller isn't interested in the actual path and has no root set
 676                  * and doesn't care about any of the other special features we provide either. */
 677                 r = open(path, O_PATH|O_CLOEXEC);
 678                 if (r < 0)
 679                         return -errno;
 680
 681                 return r;
 682         }
 683
 684         if (original_root) {
 685                 r = path_make_absolute_cwd(original_root, &root);
 686                 if (r < 0)
 687                         return r;
 688
 689                 if (flags & CHASE_PREFIX_ROOT) {
 690
 691                         /* We don't support relative paths in combination with a root directory */
 692                         if (!path_is_absolute(path))
 693                                 return -EINVAL;
 694
 695                         path = prefix_roota(root, path);
 696                 }
 697         }
 698
 699         r = path_make_absolute_cwd(path, &buffer);
 700         if (r < 0)
 701                 return r;
 702
 703         fd = open("/", O_CLOEXEC|O_NOFOLLOW|O_PATH);
 704         if (fd < 0)
 705                 return -errno;
 706
 707         if (flags & CHASE_SAFE) {
 708                 if (fstat(fd, &previous_stat) < 0)
 709                         return -errno;
 710         }
 711
 712         todo = buffer;
 713         for (;;) {
 714                 _cleanup_free_ char *first = NULL;
 715                 _cleanup_close_ int child = -1;
 716                 struct stat st;
 717                 size_t n, m;
 718
 719                 /* Determine length of first component in the path */
 720                 n = strspn(todo, "/");                  /* The slashes */
 721                 m = n + strcspn(todo + n, "/");         /* The entire length of the component */
 722
 723                 /* Extract the first component. */
 724                 first = strndup(todo, m);
 725                 if (!first)
 726                         return -ENOMEM;
 727
 728                 todo += m;
 729
 730                 /* Empty? Then we reached the end. */
 731                 if (isempty(first))
 732                         break;
 733
 734                 /* Just a single slash? Then we reached the end. */
 735                 if (path_equal(first, "/")) {
 736                         /* Preserve the trailing slash */
 737
 738                         if (flags & CHASE_TRAIL_SLASH)
 739                                 if (!strextend(&done, "/", NULL))
 740                                         return -ENOMEM;
 741
 742                         break;
 743                 }
 744
 745                 /* Just a dot? Then let's eat this up. */
 746                 if (path_equal(first, "/."))
 747                         continue;
 748
 749                 /* Two dots? Then chop off the last bit of what we already found out. */
 750                 if (path_equal(first, "/..")) {
 751                         _cleanup_free_ char *parent = NULL;
 752                         _cleanup_close_ int fd_parent = -1;
 753
 754                         /* If we already are at the top, then going up will not change anything. This is in-line with
 755                          * how the kernel handles this. */
 756                         if (empty_or_root(done))
 757                                 continue;
 758
 759                         parent = dirname_malloc(done);
 760                         if (!parent)
 761                                 return -ENOMEM;
 762
 763                         /* Don't allow this to leave the root dir.  */
 764                         if (root &&
 765                             path_startswith(done, root) &&
 766                             !path_startswith(parent, root))
 767                                 continue;
 768
 769                         free_and_replace(done, parent);
 770
 771                         if (flags & CHASE_STEP)
 772                                 goto chased_one;
 773
 774                         fd_parent = openat(fd, "..", O_CLOEXEC|O_NOFOLLOW|O_PATH);
 775                         if (fd_parent < 0)
 776                                 return -errno;
 777
 778                         if (flags & CHASE_SAFE) {
 779                                 if (fstat(fd_parent, &st) < 0)
 780                                         return -errno;
 781
 782                                 if (!safe_transition(&previous_stat, &st))
 783                                         return -EPERM;
 784
 785                                 previous_stat = st;
 786                         }
 787
 788                         safe_close(fd);
 789                         fd = TAKE_FD(fd_parent);
 790
 791                         continue;
 792                 }
 793
 794                 /* Otherwise let's see what this is. */
 795                 child = openat(fd, first + n, O_CLOEXEC|O_NOFOLLOW|O_PATH);
 796                 if (child < 0) {
 797
 798                         if (errno == ENOENT &&
 799                             (flags & CHASE_NONEXISTENT) &&
 800                             (isempty(todo) || path_is_normalized(todo))) {
 801
 802                                 /* If CHASE_NONEXISTENT is set, and the path does not exist, then that's OK, return
 803                                  * what we got so far. But don't allow this if the remaining path contains "../ or "./"
 804                                  * or something else weird. */
 805
 806                                 /* If done is "/", as first also contains slash at the head, then remove this redundant slash. */
 807                                 if (streq_ptr(done, "/"))
 808                                         *done = '\0';
 809
 810                                 if (!strextend(&done, first, todo, NULL))
 811                                         return -ENOMEM;
 812
 813                                 exists = false;
 814                                 break;
 815                         }
 816
 817                         return -errno;
 818                 }
 819
 820                 if (fstat(child, &st) < 0)
 821                         return -errno;
 822                 if ((flags & CHASE_SAFE) &&
 823                     !safe_transition(&previous_stat, &st))
 824                         return -EPERM;
 825
 826                 previous_stat = st;
 827
 828                 if ((flags & CHASE_NO_AUTOFS) &&
 829                     fd_is_fs_type(child, AUTOFS_SUPER_MAGIC) > 0)
 830                         return -EREMOTE;
 831
 832                 if (S_ISLNK(st.st_mode)) {
 833                         char *joined;
 834
 835                         _cleanup_free_ char *destination = NULL;
 836
 837                         /* This is a symlink, in this case read the destination. But let's make sure we don't follow
 838                          * symlinks without bounds. */
 839                         if (--max_follow <= 0)
 840                                 return -ELOOP;
 841
 842                         r = readlinkat_malloc(fd, first + n, &destination);
 843                         if (r < 0)
 844                                 return r;
 845                         if (isempty(destination))
 846                                 return -EINVAL;
 847
 848                         if (path_is_absolute(destination)) {
 849
 850                                 /* An absolute destination. Start the loop from the beginning, but use the root
 851                                  * directory as base. */
 852
 853                                 safe_close(fd);
 854                                 fd = open(root ?: "/", O_CLOEXEC|O_NOFOLLOW|O_PATH);
 855                                 if (fd < 0)
 856                                         return -errno;
 857
 858                                 if (flags & CHASE_SAFE) {
 859                                         if (fstat(fd, &st) < 0)
 860                                                 return -errno;
 861
 862                                         if (!safe_transition(&previous_stat, &st))
 863                                                 return -EPERM;
 864
 865                                         previous_stat = st;
 866                                 }
 867
 868                                 free(done);
 869
 870                                 /* Note that we do not revalidate the root, we take it as is. */
 871                                 if (isempty(root))
 872                                         done = NULL;
 873                                 else {
 874                                         done = strdup(root);
 875                                         if (!done)
 876                                                 return -ENOMEM;
 877                                 }
 878
 879                                 /* Prefix what's left to do with what we just read, and start the loop again, but
 880                                  * remain in the current directory. */
 881                                 joined = strjoin(destination, todo);
 882                         } else
 883                                 joined = strjoin("/", destination, todo);
 884                         if (!joined)
 885                                 return -ENOMEM;
 886
 887                         free(buffer);
 888                         todo = buffer = joined;
 889
 890                         if (flags & CHASE_STEP)
 891                                 goto chased_one;
 892
 893                         continue;
 894                 }
 895
 896                 /* If this is not a symlink, then let's just add the name we read to what we already verified. */
 897                 if (!done)
 898                         done = TAKE_PTR(first);
 899                 else {
 900                         /* If done is "/", as first also contains slash at the head, then remove this redundant slash. */
 901                         if (streq(done, "/"))
 902                                 *done = '\0';
 903
 904                         if (!strextend(&done, first, NULL))
 905                                 return -ENOMEM;
 906                 }
 907
 908                 /* And iterate again, but go one directory further down. */
 909                 safe_close(fd);
 910                 fd = TAKE_FD(child);
 911         }
 912
 913         if (!done) {
 914                 /* Special case, turn the empty string into "/", to indicate the root directory. */
 915                 done = strdup("/");
 916                 if (!done)
 917                         return -ENOMEM;
 918         }
 919
 920         if (ret)
 921                 *ret = TAKE_PTR(done);
 922
 923         if (flags & CHASE_OPEN) {
 924                 /* Return the O_PATH fd we currently are looking to the caller. It can translate it to a proper fd by
 925                  * opening /proc/self/fd/xyz. */
 926
 927                 assert(fd >= 0);
 928                 return TAKE_FD(fd);
 929         }
 930
 931         if (flags & CHASE_STEP)
 932                 return 1;
 933
 934         return exists;
 935
 936 chased_one:
 937         if (ret) {
 938                 char *c;
 939
 940                 c = strjoin(strempty(done), todo);
 941                 if (!c)
 942                         return -ENOMEM;
 943
 944                 *ret = c;
 945         }
 946
 947         return 0;
 948 }
 949
 950 int chase_symlinks_and_open(
 951                 const char *path,
 952                 const char *root,
 953                 unsigned chase_flags,
 954                 int open_flags,
 955                 char **ret_path) {
 956
 957         _cleanup_close_ int path_fd = -1;
 958         _cleanup_free_ char *p = NULL;
 959         int r;
 960
 961         if (chase_flags & CHASE_NONEXISTENT)
 962                 return -EINVAL;
 963
 964         if (empty_or_root(root) && !ret_path && (chase_flags & (CHASE_NO_AUTOFS|CHASE_SAFE)) == 0) {
 965                 /* Shortcut this call if none of the special features of this call are requested */
 966                 r = open(path, open_flags);
 967                 if (r < 0)
 968                         return -errno;
 969
 970                 return r;
 971         }
 972
 973         path_fd = chase_symlinks(path, root, chase_flags|CHASE_OPEN, ret_path ? &p : NULL);
 974         if (path_fd < 0)
 975                 return path_fd;
 976
 977         r = fd_reopen(path_fd, open_flags);
 978         if (r < 0)
 979                 return r;
 980
 981         if (ret_path)
 982                 *ret_path = TAKE_PTR(p);
 983
 984         return r;
 985 }
 986
 987 int chase_symlinks_and_opendir(
 988                 const char *path,
 989                 const char *root,
 990                 unsigned chase_flags,
 991                 char **ret_path,
 992                 DIR **ret_dir) {
 993
 994         char procfs_path[STRLEN("/proc/self/fd/") + DECIMAL_STR_MAX(int)];
 995         _cleanup_close_ int path_fd = -1;
 996         _cleanup_free_ char *p = NULL;
 997         DIR *d;
 998
 999         if (!ret_dir)
1000                 return -EINVAL;
1001         if (chase_flags & CHASE_NONEXISTENT)
1002                 return -EINVAL;
1003
1004         if (empty_or_root(root) && !ret_path && (chase_flags & (CHASE_NO_AUTOFS|CHASE_SAFE)) == 0) {
1005                 /* Shortcut this call if none of the special features of this call are requested */
1006                 d = opendir(path);
1007                 if (!d)
1008                         return -errno;
1009
1010                 *ret_dir = d;
1011                 return 0;
1012         }
1013
1014         path_fd = chase_symlinks(path, root, chase_flags|CHASE_OPEN, ret_path ? &p : NULL);
1015         if (path_fd < 0)
1016                 return path_fd;
1017
1018         xsprintf(procfs_path, "/proc/self/fd/%i", path_fd);
1019         d = opendir(procfs_path);
1020         if (!d)
1021                 return -errno;
1022
1023         if (ret_path)
1024                 *ret_path = TAKE_PTR(p);
1025
1026         *ret_dir = d;
1027         return 0;
1028 }
1029
1030 int chase_symlinks_and_stat(
1031                 const char *path,
1032                 const char *root,
1033                 unsigned chase_flags,
1034                 char **ret_path,
1035                 struct stat *ret_stat) {
1036
1037         _cleanup_close_ int path_fd = -1;
1038         _cleanup_free_ char *p = NULL;
1039
1040         assert(path);
1041         assert(ret_stat);
1042
1043         if (chase_flags & CHASE_NONEXISTENT)
1044                 return -EINVAL;
1045
1046         if (empty_or_root(root) && !ret_path && (chase_flags & (CHASE_NO_AUTOFS|CHASE_SAFE)) == 0) {
1047                 /* Shortcut this call if none of the special features of this call are requested */
1048                 if (stat(path, ret_stat) < 0)
1049                         return -errno;
1050
1051                 return 1;
1052         }
1053
1054         path_fd = chase_symlinks(path, root, chase_flags|CHASE_OPEN, ret_path ? &p : NULL);
1055         if (path_fd < 0)
1056                 return path_fd;
1057
1058         if (fstat(path_fd, ret_stat) < 0)
1059                 return -errno;
1060
1061         if (ret_path)
1062                 *ret_path = TAKE_PTR(p);
1063
1064         if (chase_flags & CHASE_OPEN)
1065                 return TAKE_FD(path_fd);
1066
1067         return 1;
1068 }
1069
1070 int access_fd(int fd, int mode) {
1071         char p[STRLEN("/proc/self/fd/") + DECIMAL_STR_MAX(fd) + 1];
1072         int r;
1073
1074         /* Like access() but operates on an already open fd */
1075
1076         xsprintf(p, "/proc/self/fd/%i", fd);
1077         r = access(p, mode);
1078         if (r < 0)
1079                 return -errno;
1080
1081         return r;
1082 }
1083
1084 void unlink_tempfilep(char (*p)[]) {
1085         /* If the file is created with mkstemp(), it will (almost always)
1086          * change the suffix. Treat this as a sign that the file was
1087          * successfully created. We ignore both the rare case where the
1088          * original suffix is used and unlink failures. */
1089         if (!endswith(*p, ".XXXXXX"))
1090                 (void) unlink_noerrno(*p);
1091 }
1092
1093 int unlinkat_deallocate(int fd, const char *name, int flags) {
1094         _cleanup_close_ int truncate_fd = -1;
1095         struct stat st;
1096         off_t l, bs;
1097
1098         /* Operates like unlinkat() but also deallocates the file contents if it is a regular file and there's no other
1099          * link to it. This is useful to ensure that other processes that might have the file open for reading won't be
1100          * able to keep the data pinned on disk forever. This call is particular useful whenever we execute clean-up
1101          * jobs ("vacuuming"), where we want to make sure the data is really gone and the disk space released and
1102          * returned to the free pool.
1103          *
1104          * Deallocation is preferably done by FALLOC_FL_PUNCH_HOLE|FALLOC_FL_KEEP_SIZE (👊) if supported, which means
1105          * the file won't change size. That's a good thing since we shouldn't needlessly trigger SIGBUS in other
1106          * programs that have mmap()ed the file. (The assumption here is that changing file contents to all zeroes
1107          * underneath those programs is the better choice than simply triggering SIGBUS in them which truncation does.)
1108          * However if hole punching is not implemented in the kernel or file system we'll fall back to normal file
1109          * truncation (🔪), as our goal of deallocating the data space trumps our goal of being nice to readers (💐).
1110          *
1111          * Note that we attempt deallocation, but failure to succeed with that is not considered fatal, as long as the
1112          * primary job – to delete the file – is accomplished. */
1113
1114         if ((flags & AT_REMOVEDIR) == 0) {
1115                 truncate_fd = openat(fd, name, O_WRONLY|O_CLOEXEC|O_NOCTTY|O_NOFOLLOW|O_NONBLOCK);
1116                 if (truncate_fd < 0) {
1117
1118                         /* If this failed because the file doesn't exist propagate the error right-away. Also,
1119                          * AT_REMOVEDIR wasn't set, and we tried to open the file for writing, which means EISDIR is
1120                          * returned when this is a directory but we are not supposed to delete those, hence propagate
1121                          * the error right-away too. */
1122                         if (IN_SET(errno, ENOENT, EISDIR))
1123                                 return -errno;
1124
1125                         if (errno != ELOOP) /* don't complain if this is a symlink */
1126                                 log_debug_errno(errno, "Failed to open file '%s' for deallocation, ignoring: %m", name);
1127                 }
1128         }
1129
1130         if (unlinkat(fd, name, flags) < 0)
1131                 return -errno;
1132
1133         if (truncate_fd < 0) /* Don't have a file handle, can't do more ☹️ */
1134                 return 0;
1135
1136         if (fstat(truncate_fd, &st) < 0) {
1137                 log_debug_errno(errno, "Failed to stat file '%s' for deallocation, ignoring.", name);
1138                 return 0;
1139         }
1140
1141         if (!S_ISREG(st.st_mode) || st.st_blocks == 0 || st.st_nlink > 0)
1142                 return 0;
1143
1144         /* If this is a regular file, it actually took up space on disk and there are no other links it's time to
1145          * punch-hole/truncate this to release the disk space. */
1146
1147         bs = MAX(st.st_blksize, 512);
1148         l = DIV_ROUND_UP(st.st_size, bs) * bs; /* Round up to next block size */
1149
1150         if (fallocate(truncate_fd, FALLOC_FL_PUNCH_HOLE|FALLOC_FL_KEEP_SIZE, 0, l) >= 0)
1151                 return 0; /* Successfully punched a hole! 😊 */
1152
1153         /* Fall back to truncation */
1154         if (ftruncate(truncate_fd, 0) < 0) {
1155                 log_debug_errno(errno, "Failed to truncate file to 0, ignoring: %m");
1156                 return 0;
1157         }
1158
1159         return 0;
1160 }
1161
1162 int fsync_directory_of_file(int fd) {
1163         _cleanup_free_ char *path = NULL, *dn = NULL;
1164         _cleanup_close_ int dfd = -1;
1165         int r;
1166
1167         r = fd_verify_regular(fd);
1168         if (r < 0)
1169                 return r;
1170
1171         r = fd_get_path(fd, &path);
1172         if (r < 0) {
1173                 log_debug("Failed to query /proc/self/fd/%d%s: %m",
1174                           fd,
1175                           r == -EOPNOTSUPP ? ", ignoring" : "");
1176
1177                 if (r == -EOPNOTSUPP)
1178                         /* If /proc is not available, we're most likely running in some
1179                          * chroot environment, and syncing the directory is not very
1180                          * important in that case. Let's just silently do nothing. */
1181                         return 0;
1182
1183                 return r;
1184         }
1185
1186         if (!path_is_absolute(path))
1187                 return -EINVAL;
1188
1189         dn = dirname_malloc(path);
1190         if (!dn)
1191                 return -ENOMEM;
1192
1193         dfd = open(dn, O_RDONLY|O_CLOEXEC|O_DIRECTORY);
1194         if (dfd < 0)
1195                 return -errno;
1196
1197         if (fsync(dfd) < 0)
1198                 return -errno;
1199
1200         return 0;
1201 }