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