src/basic/fs-util.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 /***
   5   This file is part of systemd.
   6
   7   Copyright 2010 Lennart Poettering
   8 ***/
   9
  10 //#include <dirent.h>
  11 #include <fcntl.h>
  12 #include <limits.h>
  13 #include <stdbool.h>
  14 #include <stdint.h>
  15 #include <sys/inotify.h>
  16 #include <sys/types.h>
  17 #include <unistd.h>
  18
  19 #include "time-util.h"
  20 #include "util.h"
  21
  22 int unlink_noerrno(const char *path);
  23
  24 #if 0 /// UNNEEDED by elogind
  25 int rmdir_parents(const char *path, const char *stop);
  26
  27 int rename_noreplace(int olddirfd, const char *oldpath, int newdirfd, const char *newpath);
  28 #endif // 0
  29
  30 int readlinkat_malloc(int fd, const char *p, char **ret);
  31 int readlink_malloc(const char *p, char **r);
  32 #if 0 /// UNNEEDED by elogind
  33 int readlink_value(const char *p, char **ret);
  34 #endif // 0
  35 int readlink_and_make_absolute(const char *p, char **r);
  36 #if 0 /// UNNEEDED by elogind
  37 #endif // 0
  38
  39 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
  40
  41 int fchmod_umask(int fd, mode_t mode);
  42
  43 int fd_warn_permissions(const char *path, int fd);
  44
  45 #ifdef __GLIBC__
  46 #define laccess(path, mode) faccessat(AT_FDCWD, (path), (mode), AT_SYMLINK_NOFOLLOW)
  47 #else
  48 #define laccess(path, mode) faccessat(AT_FDCWD, (path), (mode), 0)
  49 #endif // __GLIBC__
  50
  51 int touch_file(const char *path, bool parents, usec_t stamp, uid_t uid, gid_t gid, mode_t mode);
  52 int touch(const char *path);
  53
  54 #if 0 /// UNNEEDED by elogind
  55 int symlink_idempotent(const char *from, const char *to);
  56
  57 int symlink_atomic(const char *from, const char *to);
  58 int mknod_atomic(const char *path, mode_t mode, dev_t dev);
  59 int mkfifo_atomic(const char *path, mode_t mode);
  60 #endif // 0
  61
  62 int get_files_in_directory(const char *path, char ***list);
  63
  64 int tmp_dir(const char **ret);
  65 #if 0 /// UNNEEDED by elogind
  66 int var_tmp_dir(const char **ret);
  67 #endif // 0
  68
  69 int unlink_or_warn(const char *filename);
  70
  71 #if 0 /// UNNEEDED by elogind
  72 #define INOTIFY_EVENT_MAX (sizeof(struct inotify_event) + NAME_MAX + 1)
  73
  74 #define FOREACH_INOTIFY_EVENT(e, buffer, sz) \
  75         for ((e) = &buffer.ev;                                \
  76              (uint8_t*) (e) < (uint8_t*) (buffer.raw) + (sz); \
  77              (e) = (struct inotify_event*) ((uint8_t*) (e) + sizeof(struct inotify_event) + (e)->len))
  78
  79 union inotify_event_buffer {
  80         struct inotify_event ev;
  81         uint8_t raw[INOTIFY_EVENT_MAX];
  82 };
  83
  84 int inotify_add_watch_fd(int fd, int what, uint32_t mask);
  85
  86 #endif // 0
  87 enum {
  88         CHASE_PREFIX_ROOT = 1U << 0,   /* If set, the specified path will be prefixed by the specified root before beginning the iteration */
  89         CHASE_NONEXISTENT = 1U << 1,   /* If set, it's OK if the path doesn't actually exist. */
  90         CHASE_NO_AUTOFS   = 1U << 2,   /* If set, return -EREMOTE if autofs mount point found */
  91         CHASE_SAFE        = 1U << 3,   /* If set, return EPERM if we ever traverse from unprivileged to privileged files or directories */
  92         CHASE_OPEN        = 1U << 4,   /* If set, return an O_PATH object to the final component */
  93         CHASE_TRAIL_SLASH = 1U << 5,   /* If set, any trailing slash will be preserved */
  94         CHASE_STEP        = 1U << 6,   /* If set, just execute a single step of the normalization */
  95 };
  96
  97 /* How many iterations to execute before returning -ELOOP */
  98 #define CHASE_SYMLINKS_MAX 32
  99
 100 int chase_symlinks(const char *path_with_prefix, const char *root, unsigned flags, char **ret);
 101
 102 int chase_symlinks_and_open(const char *path, const char *root, unsigned chase_flags, int open_flags, char **ret_path);
 103 int chase_symlinks_and_opendir(const char *path, const char *root, unsigned chase_flags, char **ret_path, DIR **ret_dir);
 104
 105 /* Useful for usage with _cleanup_(), removes a directory and frees the pointer */
 106 static inline void rmdir_and_free(char *p) {
 107         PROTECT_ERRNO;
 108         (void) rmdir(p);
 109         free(p);
 110 }
 111 DEFINE_TRIVIAL_CLEANUP_FUNC(char*, rmdir_and_free);
 112
 113 #if 0 /// UNNEEDED by elogind
 114 static inline void unlink_and_free(char *p) {
 115         (void) unlink_noerrno(p);
 116         free(p);
 117 }
 118 DEFINE_TRIVIAL_CLEANUP_FUNC(char*, unlink_and_free);
 119 #endif // 0
 120
 121 int access_fd(int fd, int mode);
 122
 123 int unlinkat_deallocate(int fd, const char *name, int flags);
 124
 125 int fsync_directory_of_file(int fd);