]> git.ipfire.org Git - thirdparty/systemd.git/blame - src/basic/fs-util.h
Merge pull request #8575 from keszybz/non-absolute-paths
[thirdparty/systemd.git] / src / basic / fs-util.h
CommitLineData
53e1b683 1/* SPDX-License-Identifier: LGPL-2.1+ */
f4f15635
LP
2#pragma once
3
4/***
5 This file is part of systemd.
6
7 Copyright 2010 Lennart Poettering
f4f15635
LP
8***/
9
21c692e9 10#include <dirent.h>
f4f15635 11#include <fcntl.h>
71d35b6b 12#include <limits.h>
11c3a366
TA
13#include <stdbool.h>
14#include <stdint.h>
77601719
LP
15#include <sys/inotify.h>
16#include <sys/types.h>
f4f15635
LP
17#include <unistd.h>
18
19#include "time-util.h"
dfd14786 20#include "util.h"
f4f15635
LP
21
22int unlink_noerrno(const char *path);
23
24int rmdir_parents(const char *path, const char *stop);
25
26int rename_noreplace(int olddirfd, const char *oldpath, int newdirfd, const char *newpath);
27
28int readlinkat_malloc(int fd, const char *p, char **ret);
29int readlink_malloc(const char *p, char **r);
30int readlink_value(const char *p, char **ret);
31int readlink_and_make_absolute(const char *p, char **r);
f4f15635
LP
32
33int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
f4f15635
LP
34
35int fchmod_umask(int fd, mode_t mode);
36
37int fd_warn_permissions(const char *path, int fd);
38
39#define laccess(path, mode) faccessat(AT_FDCWD, (path), (mode), AT_SYMLINK_NOFOLLOW)
40
41int touch_file(const char *path, bool parents, usec_t stamp, uid_t uid, gid_t gid, mode_t mode);
42int touch(const char *path);
43
44int symlink_idempotent(const char *from, const char *to);
45
46int symlink_atomic(const char *from, const char *to);
47int mknod_atomic(const char *path, mode_t mode, dev_t dev);
48int mkfifo_atomic(const char *path, mode_t mode);
49
50int get_files_in_directory(const char *path, char ***list);
77601719 51
992e8f22
LP
52int tmp_dir(const char **ret);
53int var_tmp_dir(const char **ret);
34a8f081 54
af229d7a
ZJS
55int unlink_or_warn(const char *filename);
56
77601719
LP
57#define INOTIFY_EVENT_MAX (sizeof(struct inotify_event) + NAME_MAX + 1)
58
59#define FOREACH_INOTIFY_EVENT(e, buffer, sz) \
60 for ((e) = &buffer.ev; \
61 (uint8_t*) (e) < (uint8_t*) (buffer.raw) + (sz); \
62 (e) = (struct inotify_event*) ((uint8_t*) (e) + sizeof(struct inotify_event) + (e)->len))
63
64union inotify_event_buffer {
65 struct inotify_event ev;
66 uint8_t raw[INOTIFY_EVENT_MAX];
67};
430fbf8e
LP
68
69int inotify_add_watch_fd(int fd, int what, uint32_t mask);
d944dc95 70
c4f4fce7 71enum {
f14f1806
LP
72 CHASE_PREFIX_ROOT = 1U << 0, /* If set, the specified path will be prefixed by the specified root before beginning the iteration */
73 CHASE_NONEXISTENT = 1U << 1, /* If set, it's OK if the path doesn't actually exist. */
74 CHASE_NO_AUTOFS = 1U << 2, /* If set, return -EREMOTE if autofs mount point found */
75 CHASE_SAFE = 1U << 3, /* If set, return EPERM if we ever traverse from unprivileged to privileged files or directories */
1ed34d75 76 CHASE_OPEN = 1U << 4, /* If set, return an O_PATH object to the final component */
62570f6f 77 CHASE_TRAIL_SLASH = 1U << 5, /* If set, any trailing slash will be preserved */
c4f4fce7
LP
78};
79
80int chase_symlinks(const char *path_with_prefix, const char *root, unsigned flags, char **ret);
676bcb0f 81
21c692e9
LP
82int chase_symlinks_and_open(const char *path, const char *root, unsigned chase_flags, int open_flags, char **ret_path);
83int chase_symlinks_and_opendir(const char *path, const char *root, unsigned chase_flags, char **ret_path, DIR **ret_dir);
84
676bcb0f
LP
85/* Useful for usage with _cleanup_(), removes a directory and frees the pointer */
86static inline void rmdir_and_free(char *p) {
dfd14786 87 PROTECT_ERRNO;
676bcb0f
LP
88 (void) rmdir(p);
89 free(p);
90}
91DEFINE_TRIVIAL_CLEANUP_FUNC(char*, rmdir_and_free);
f5b84de2
LP
92
93static inline void unlink_and_free(char *p) {
dfd14786 94 (void) unlink_noerrno(p);
f5b84de2
LP
95 free(p);
96}
97DEFINE_TRIVIAL_CLEANUP_FUNC(char*, unlink_and_free);
57a4359e
LP
98
99int access_fd(int fd, int mode);
43767d9d
LP
100
101int unlinkat_deallocate(int fd, const char *name, int flags);
11b29a96
LP
102
103int fsync_directory_of_file(int fd);