src/basic/fs-util.h

   1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
   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/stat.h>
  10 #include <sys/types.h>
  11 #include <unistd.h>
  12
  13 #include "alloc-util.h"
  14 #include "errno-util.h"
  15 #include "lock-util.h"
  16 #include "time-util.h"
  17 #include "user-util.h"
  18
  19 #define MODE_INVALID ((mode_t) -1)
  20
  21 /* The following macros add 1 when converting things, since 0 is a valid mode, while the pointer
  22  * NULL is special */
  23 #define PTR_TO_MODE(p) ((mode_t) ((uintptr_t) (p)-1))
  24 #define MODE_TO_PTR(u) ((void *) ((uintptr_t) (u)+1))
  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_at(int dir_fd, const char *path, mode_t mode, uid_t uid, gid_t gid);
  36 static inline int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid) {
  37         return chmod_and_chown_at(AT_FDCWD, path, mode, uid, gid);
  38 }
  39 int fchmod_and_chown_with_fallback(int fd, const char *path, mode_t mode, uid_t uid, gid_t gid);
  40 static inline int fchmod_and_chown(int fd, mode_t mode, uid_t uid, gid_t gid) {
  41         return fchmod_and_chown_with_fallback(fd, NULL, mode, uid, gid); /* no fallback */
  42 }
  43
  44 int fchmod_umask(int fd, mode_t mode);
  45 int fchmod_opath(int fd, mode_t m);
  46
  47 int futimens_opath(int fd, const struct timespec ts[2]);
  48
  49 int fd_warn_permissions(const char *path, int fd);
  50 int stat_warn_permissions(const char *path, const struct stat *st);
  51
  52 #define laccess(path, mode)                                             \
  53         RET_NERRNO(faccessat(AT_FDCWD, (path), (mode), AT_SYMLINK_NOFOLLOW))
  54
  55 int touch_file(const char *path, bool parents, usec_t stamp, uid_t uid, gid_t gid, mode_t mode);
  56
  57 static inline int touch(const char *path) {
  58         return touch_file(path, false, USEC_INFINITY, UID_INVALID, GID_INVALID, MODE_INVALID);
  59 }
  60
  61 int symlink_idempotent(const char *from, const char *to, bool make_relative);
  62
  63 int symlinkat_atomic_full(const char *from, int atfd, const char *to, bool make_relative);
  64 static inline int symlink_atomic(const char *from, const char *to) {
  65         return symlinkat_atomic_full(from, AT_FDCWD, to, false);
  66 }
  67
  68 int mknodat_atomic(int atfd, const char *path, mode_t mode, dev_t dev);
  69 static inline int mknod_atomic(const char *path, mode_t mode, dev_t dev) {
  70         return mknodat_atomic(AT_FDCWD, path, mode, dev);
  71 }
  72
  73 int mkfifoat_atomic(int dir_fd, const char *path, mode_t mode);
  74 static inline int mkfifo_atomic(const char *path, mode_t mode) {
  75         return mkfifoat_atomic(AT_FDCWD, path, mode);
  76 }
  77
  78 int get_files_in_directory(const char *path, char ***list);
  79
  80 int tmp_dir(const char **ret);
  81 int var_tmp_dir(const char **ret);
  82
  83 int unlink_or_warn(const char *filename);
  84
  85 /* Useful for usage with _cleanup_(), removes a directory and frees the pointer */
  86 static inline char *rmdir_and_free(char *p) {
  87         PROTECT_ERRNO;
  88
  89         if (!p)
  90                 return NULL;
  91
  92         (void) rmdir(p);
  93         return mfree(p);
  94 }
  95 DEFINE_TRIVIAL_CLEANUP_FUNC(char*, rmdir_and_free);
  96
  97 static inline char* unlink_and_free(char *p) {
  98         if (!p)
  99                 return NULL;
 100
 101         (void) unlink(p);
 102         return mfree(p);
 103 }
 104 DEFINE_TRIVIAL_CLEANUP_FUNC(char*, unlink_and_free);
 105
 106 int access_fd(int fd, int mode);
 107
 108 void unlink_tempfilep(char (*p)[]);
 109
 110 typedef enum UnlinkDeallocateFlags {
 111         UNLINK_REMOVEDIR = 1 << 0,
 112         UNLINK_ERASE     = 1 << 1,
 113 } UnlinkDeallocateFlags;
 114
 115 int unlinkat_deallocate(int fd, const char *name, UnlinkDeallocateFlags flags);
 116
 117 int open_parent_at(int dir_fd, const char *path, int flags, mode_t mode);
 118 static inline int open_parent(const char *path, int flags, mode_t mode) {
 119         return open_parent_at(AT_FDCWD, path, flags, mode);
 120 }
 121
 122 int conservative_renameat(int olddirfd, const char *oldpath, int newdirfd, const char *newpath);
 123 static inline int conservative_rename(const char *oldpath, const char *newpath) {
 124         return conservative_renameat(AT_FDCWD, oldpath, AT_FDCWD, newpath);
 125 }
 126
 127 int posix_fallocate_loop(int fd, uint64_t offset, uint64_t size);
 128
 129 int parse_cifs_service(const char *s, char **ret_host, char **ret_service, char **ret_path);
 130
 131 int open_mkdir_at(int dirfd, const char *path, int flags, mode_t mode);
 132
 133 int openat_report_new(int dirfd, const char *pathname, int flags, mode_t mode, bool *ret_newly_created);
 134
 135 typedef enum XOpenFlags {
 136         XO_LABEL     = 1 << 0,
 137         XO_SUBVOLUME = 1 << 1,
 138 } XOpenFlags;
 139
 140 int xopenat(int dir_fd, const char *path, int open_flags, XOpenFlags xopen_flags, mode_t mode);
 141
 142 int xopenat_lock(int dir_fd, const char *path, int open_flags, XOpenFlags xopen_flags, mode_t mode, LockType locktype, int operation);