fs-util.h 4.7 KB
Newer Older
1
/* SPDX-License-Identifier: LGPL-2.1+ */
2 3
#pragma once

4
#include <dirent.h>
5 6
#include <fcntl.h>
#include <limits.h>
7 8
#include <stdbool.h>
#include <stdint.h>
9
#include <sys/inotify.h>
10
#include <sys/stat.h>
11 12 13
#include <sys/types.h>
#include <unistd.h>

14
#include "errno-util.h"
15 16
#include "time-util.h"

17 18 19 20 21 22 23
#define MODE_INVALID ((mode_t) -1)

/* The following macros add 1 when converting things, since 0 is a valid mode, while the pointer
 * NULL is special */
#define PTR_TO_MODE(p) ((mode_t) ((uintptr_t) (p)-1))
#define MODE_TO_PTR(u) ((void *) ((uintptr_t) (u)+1))

24 25 26 27 28 29 30 31 32 33 34 35
int unlink_noerrno(const char *path);

int rmdir_parents(const char *path, const char *stop);

int rename_noreplace(int olddirfd, const char *oldpath, int newdirfd, const char *newpath);

int readlinkat_malloc(int fd, const char *p, char **ret);
int readlink_malloc(const char *p, char **r);
int readlink_value(const char *p, char **ret);
int readlink_and_make_absolute(const char *p, char **r);

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 42 43 44 45 46 47

int fd_warn_permissions(const char *path, int fd);

#define laccess(path, mode) faccessat(AT_FDCWD, (path), (mode), AT_SYMLINK_NOFOLLOW)

int touch_file(const char *path, bool parents, usec_t stamp, uid_t uid, gid_t gid, mode_t mode);
int touch(const char *path);

48
int symlink_idempotent(const char *from, const char *to, bool make_relative);
49 50 51 52

int symlink_atomic(const char *from, const char *to);
int mknod_atomic(const char *path, mode_t mode, dev_t dev);
int mkfifo_atomic(const char *path, mode_t mode);
53
int mkfifoat_atomic(int dir_fd, const char *path, mode_t mode);
54 55 56

int get_files_in_directory(const char *path, char ***list);

57 58 59
int tmp_dir(const char **ret);
int var_tmp_dir(const char **ret);

60 61
int unlink_or_warn(const char *filename);

62 63 64 65 66 67 68 69 70 71 72
#define INOTIFY_EVENT_MAX (sizeof(struct inotify_event) + NAME_MAX + 1)

#define FOREACH_INOTIFY_EVENT(e, buffer, sz) \
        for ((e) = &buffer.ev;                                \
             (uint8_t*) (e) < (uint8_t*) (buffer.raw) + (sz); \
             (e) = (struct inotify_event*) ((uint8_t*) (e) + sizeof(struct inotify_event) + (e)->len))

union inotify_event_buffer {
        struct inotify_event ev;
        uint8_t raw[INOTIFY_EVENT_MAX];
};
73 74

int inotify_add_watch_fd(int fd, int what, uint32_t mask);
75

76
enum {
77 78 79 80 81 82 83 84 85 86
        CHASE_PREFIX_ROOT = 1 << 0, /* The specified path will be prefixed by the specified root before beginning the iteration */
        CHASE_NONEXISTENT = 1 << 1, /* It's OK if the path doesn't actually exist. */
        CHASE_NO_AUTOFS   = 1 << 2, /* Return -EREMOTE if autofs mount point found */
        CHASE_SAFE        = 1 << 3, /* Return EPERM if we ever traverse from unprivileged to privileged files or directories */
        CHASE_OPEN        = 1 << 4, /* Return an O_PATH object to the final component */
        CHASE_TRAIL_SLASH = 1 << 5, /* Any trailing slash will be preserved */
        CHASE_STEP        = 1 << 6, /* Just execute a single step of the normalization */
        CHASE_NOFOLLOW    = 1 << 7, /* Do not follow the path's right-most compontent. With CHASE_OPEN, when
                                     * the path's right-most component refers to symlink, return O_PATH fd of
                                     * the symlink. */
87
        CHASE_WARN        = 1 << 8, /* Emit an appropriate warning when an error is encountered */
88 89
};

90 91 92
/* How many iterations to execute before returning -ELOOP */
#define CHASE_SYMLINKS_MAX 32

93 94
int chase_symlinks(const char *path_with_prefix, const char *root, unsigned flags, char **ret);

95 96
int chase_symlinks_and_open(const char *path, const char *root, unsigned chase_flags, int open_flags, char **ret_path);
int chase_symlinks_and_opendir(const char *path, const char *root, unsigned chase_flags, char **ret_path, DIR **ret_dir);
97
int chase_symlinks_and_stat(const char *path, const char *root, unsigned chase_flags, char **ret_path, struct stat *ret_stat);
98

99 100
/* Useful for usage with _cleanup_(), removes a directory and frees the pointer */
static inline void rmdir_and_free(char *p) {
101
        PROTECT_ERRNO;
102 103 104 105
        (void) rmdir(p);
        free(p);
}
DEFINE_TRIVIAL_CLEANUP_FUNC(char*, rmdir_and_free);
106 107

static inline void unlink_and_free(char *p) {
108
        (void) unlink_noerrno(p);
109 110 111
        free(p);
}
DEFINE_TRIVIAL_CLEANUP_FUNC(char*, unlink_and_free);
112 113

int access_fd(int fd, int mode);
114

115
void unlink_tempfilep(char (*p)[]);
116
int unlinkat_deallocate(int fd, const char *name, int flags);
117 118

int fsync_directory_of_file(int fd);
119
int fsync_full(int fd);
120
int fsync_path_at(int at_fd, const char *path);
121

122 123
int syncfs_path(int atfd, const char *path);

124
int open_parent(const char *path, int flags, mode_t mode);