src/basic/fs-util.h

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