src/basic/fs-util.c

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