]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - fs/overlayfs/overlayfs.h
btrfs: fix the error handling for submit_extent_page() for btrfs_do_readpage()
[mirror_ubuntu-jammy-kernel.git] / fs / overlayfs / overlayfs.h
CommitLineData
d2912cb1 1/* SPDX-License-Identifier: GPL-2.0-only */
e9be9d5e
MS
2/*
3 *
4 * Copyright (C) 2011 Novell Inc.
e9be9d5e
MS
5 */
6
7#include <linux/kernel.h>
3a1e819b 8#include <linux/uuid.h>
46e5d0a3 9#include <linux/fs.h>
ee023c30 10#include "ovl_entry.h"
e9be9d5e 11
1bd0a3ae 12#undef pr_fmt
13#define pr_fmt(fmt) "overlayfs: " fmt
14
e9be9d5e 15enum ovl_path_type {
38e813db
MS
16 __OVL_PATH_UPPER = (1 << 0),
17 __OVL_PATH_MERGE = (1 << 1),
59548503 18 __OVL_PATH_ORIGIN = (1 << 2),
e9be9d5e
MS
19};
20
1afaba1e
MS
21#define OVL_TYPE_UPPER(type) ((type) & __OVL_PATH_UPPER)
22#define OVL_TYPE_MERGE(type) ((type) & __OVL_PATH_MERGE)
59548503 23#define OVL_TYPE_ORIGIN(type) ((type) & __OVL_PATH_ORIGIN)
d837a49b 24
2d2f2d73
MS
25#define OVL_XATTR_NAMESPACE "overlay."
26#define OVL_XATTR_TRUSTED_PREFIX XATTR_TRUSTED_PREFIX OVL_XATTR_NAMESPACE
27#define OVL_XATTR_USER_PREFIX XATTR_USER_PREFIX OVL_XATTR_NAMESPACE
43d193f8
MS
28
29enum ovl_xattr {
30 OVL_XATTR_OPAQUE,
31 OVL_XATTR_REDIRECT,
32 OVL_XATTR_ORIGIN,
33 OVL_XATTR_IMPURE,
34 OVL_XATTR_NLINK,
35 OVL_XATTR_UPPER,
36 OVL_XATTR_METACOPY,
096a218a 37 OVL_XATTR_PROTATTR,
43d193f8 38};
3a1e819b 39
c62520a8 40enum ovl_inode_flag {
b79e05aa 41 /* Pure upper dir that may contain non pure upper entries */
13c72075 42 OVL_IMPURE,
b79e05aa
AG
43 /* Non-merge dir that may contain whiteout entries */
44 OVL_WHITEOUTS,
359f392c 45 OVL_INDEX,
0c288874 46 OVL_UPPERDATA,
a00c2d59
VG
47 /* Inode number will remain constant over copy up. */
48 OVL_CONST_INO,
13c72075
MS
49};
50
c62520a8
AG
51enum ovl_entry_flag {
52 OVL_E_UPPER_ALIAS,
53 OVL_E_OPAQUE,
2ca3c148 54 OVL_E_CONNECTED,
c62520a8
AG
55};
56
926e94d7
AG
57enum {
58 OVL_XINO_OFF,
59 OVL_XINO_AUTO,
60 OVL_XINO_ON,
61};
62
3a1e819b
AG
63/*
64 * The tuple (fh,uuid) is a universal unique identifier for a copy up origin,
65 * where:
66 * origin.fh - exported file handle of the lower file
67 * origin.uuid - uuid of the lower filesystem
68 */
69#define OVL_FH_VERSION 0
70#define OVL_FH_MAGIC 0xfb
71
72/* CPU byte order required for fid decoding: */
73#define OVL_FH_FLAG_BIG_ENDIAN (1 << 0)
74#define OVL_FH_FLAG_ANY_ENDIAN (1 << 1)
54fb347e
AG
75/* Is the real inode encoded in fid an upper inode? */
76#define OVL_FH_FLAG_PATH_UPPER (1 << 2)
3a1e819b 77
961af647
AG
78#define OVL_FH_FLAG_ALL (OVL_FH_FLAG_BIG_ENDIAN | OVL_FH_FLAG_ANY_ENDIAN | \
79 OVL_FH_FLAG_PATH_UPPER)
3a1e819b
AG
80
81#if defined(__LITTLE_ENDIAN)
82#define OVL_FH_FLAG_CPU_ENDIAN 0
83#elif defined(__BIG_ENDIAN)
84#define OVL_FH_FLAG_CPU_ENDIAN OVL_FH_FLAG_BIG_ENDIAN
85#else
86#error Endianness not defined
87#endif
88
cbe7fba8
AG
89/* The type used to be returned by overlay exportfs for misaligned fid */
90#define OVL_FILEID_V0 0xfb
91/* The type returned by overlay exportfs for 32bit aligned fid */
92#define OVL_FILEID_V1 0xf8
8ed5eec9 93
cbe7fba8
AG
94/* On-disk format for "origin" file handle */
95struct ovl_fb {
3a1e819b
AG
96 u8 version; /* 0 */
97 u8 magic; /* 0xfb */
98 u8 len; /* size of this header + size of fid */
99 u8 flags; /* OVL_FH_FLAG_* */
100 u8 type; /* fid_type of fid */
01633fd2 101 uuid_t uuid; /* uuid of filesystem */
0efbe7c4 102 u32 fid[]; /* file identifier should be 32bit aligned in-memory */
3a1e819b 103} __packed;
e9be9d5e 104
cbe7fba8
AG
105/* In-memory and on-wire format for overlay file handle */
106struct ovl_fh {
107 u8 padding[3]; /* make sure fb.fid is 32bit aligned */
108 union {
109 struct ovl_fb fb;
110 u8 buf[0];
111 };
112} __packed;
113
114#define OVL_FH_WIRE_OFFSET offsetof(struct ovl_fh, fb)
115#define OVL_FH_LEN(fh) (OVL_FH_WIRE_OFFSET + (fh)->fb.len)
116#define OVL_FH_FID_OFFSET (OVL_FH_WIRE_OFFSET + \
117 offsetof(struct ovl_fb, fid))
118
2d2f2d73 119extern const char *const ovl_xattr_table[][2];
43d193f8
MS
120static inline const char *ovl_xattr(struct ovl_fs *ofs, enum ovl_xattr ox)
121{
2d2f2d73 122 return ovl_xattr_table[ox][ofs->config.userxattr];
43d193f8
MS
123}
124
e9be9d5e
MS
125static inline int ovl_do_rmdir(struct inode *dir, struct dentry *dentry)
126{
6521f891 127 int err = vfs_rmdir(&init_user_ns, dir, dentry);
6cf00764 128
e9be9d5e
MS
129 pr_debug("rmdir(%pd2) = %i\n", dentry, err);
130 return err;
131}
132
133static inline int ovl_do_unlink(struct inode *dir, struct dentry *dentry)
134{
6521f891 135 int err = vfs_unlink(&init_user_ns, dir, dentry, NULL);
6cf00764 136
e9be9d5e
MS
137 pr_debug("unlink(%pd2) = %i\n", dentry, err);
138 return err;
139}
140
141static inline int ovl_do_link(struct dentry *old_dentry, struct inode *dir,
6cf00764 142 struct dentry *new_dentry)
e9be9d5e 143{
6521f891 144 int err = vfs_link(old_dentry, &init_user_ns, dir, new_dentry, NULL);
6cf00764
AG
145
146 pr_debug("link(%pd2, %pd2) = %i\n", old_dentry, new_dentry, err);
e9be9d5e
MS
147 return err;
148}
149
150static inline int ovl_do_create(struct inode *dir, struct dentry *dentry,
6cf00764 151 umode_t mode)
e9be9d5e 152{
6521f891 153 int err = vfs_create(&init_user_ns, dir, dentry, mode, true);
6cf00764
AG
154
155 pr_debug("create(%pd2, 0%o) = %i\n", dentry, mode, err);
e9be9d5e
MS
156 return err;
157}
158
159static inline int ovl_do_mkdir(struct inode *dir, struct dentry *dentry,
6cf00764 160 umode_t mode)
e9be9d5e 161{
6521f891 162 int err = vfs_mkdir(&init_user_ns, dir, dentry, mode);
6cf00764 163 pr_debug("mkdir(%pd2, 0%o) = %i\n", dentry, mode, err);
e9be9d5e
MS
164 return err;
165}
166
167static inline int ovl_do_mknod(struct inode *dir, struct dentry *dentry,
6cf00764 168 umode_t mode, dev_t dev)
e9be9d5e 169{
6521f891 170 int err = vfs_mknod(&init_user_ns, dir, dentry, mode, dev);
6cf00764
AG
171
172 pr_debug("mknod(%pd2, 0%o, 0%o) = %i\n", dentry, mode, dev, err);
e9be9d5e
MS
173 return err;
174}
175
176static inline int ovl_do_symlink(struct inode *dir, struct dentry *dentry,
6cf00764 177 const char *oldname)
e9be9d5e 178{
6521f891 179 int err = vfs_symlink(&init_user_ns, dir, dentry, oldname);
6cf00764
AG
180
181 pr_debug("symlink(\"%s\", %pd2) = %i\n", oldname, dentry, err);
e9be9d5e
MS
182 return err;
183}
184
610afc0b 185static inline ssize_t ovl_do_getxattr(struct ovl_fs *ofs, struct dentry *dentry,
43d193f8 186 enum ovl_xattr ox, void *value,
610afc0b 187 size_t size)
d5dc7486 188{
43d193f8 189 const char *name = ovl_xattr(ofs, ox);
5e717c6f
AG
190 int err = vfs_getxattr(&init_user_ns, dentry, name, value, size);
191 int len = (value && err > 0) ? err : 0;
192
193 pr_debug("getxattr(%pd2, \"%s\", \"%*pE\", %zu, 0) = %i\n",
194 dentry, name, min(len, 48), value, size, err);
195 return err;
d5dc7486
MS
196}
197
610afc0b 198static inline int ovl_do_setxattr(struct ovl_fs *ofs, struct dentry *dentry,
43d193f8 199 enum ovl_xattr ox, const void *value,
610afc0b 200 size_t size)
e9be9d5e 201{
43d193f8 202 const char *name = ovl_xattr(ofs, ox);
3fb38c98
SF
203 struct inode *inode = dentry->d_inode;
204 int err;
205
206 inode_lock(inode);
207 err = __vfs_setxattr_noperm(&init_user_ns, dentry, name, value, size, 0);
208 inode_unlock(inode);
209
26150ab5
MS
210 pr_debug("setxattr(%pd2, \"%s\", \"%*pE\", %zu, 0) = %i\n",
211 dentry, name, min((int)size, 48), value, size, err);
e9be9d5e
MS
212 return err;
213}
214
610afc0b 215static inline int ovl_do_removexattr(struct ovl_fs *ofs, struct dentry *dentry,
43d193f8 216 enum ovl_xattr ox)
e9be9d5e 217{
43d193f8 218 const char *name = ovl_xattr(ofs, ox);
3fb38c98
SF
219 struct inode *inode = dentry->d_inode;
220 int err;
221
222 inode_lock(inode);
223 err = __vfs_removexattr_noperm(&init_user_ns, dentry, name);
224 inode_unlock(inode);
225
e9be9d5e
MS
226 pr_debug("removexattr(%pd2, \"%s\") = %i\n", dentry, name, err);
227 return err;
228}
229
230static inline int ovl_do_rename(struct inode *olddir, struct dentry *olddentry,
231 struct inode *newdir, struct dentry *newdentry,
232 unsigned int flags)
233{
234 int err;
9fe61450 235 struct renamedata rd = {
6521f891 236 .old_mnt_userns = &init_user_ns,
9fe61450
CB
237 .old_dir = olddir,
238 .old_dentry = olddentry,
6521f891 239 .new_mnt_userns = &init_user_ns,
9fe61450
CB
240 .new_dir = newdir,
241 .new_dentry = newdentry,
242 .flags = flags,
243 };
e9be9d5e 244
6cf00764 245 pr_debug("rename(%pd2, %pd2, 0x%x)\n", olddentry, newdentry, flags);
9fe61450 246 err = vfs_rename(&rd);
e9be9d5e 247 if (err) {
2773bf00 248 pr_debug("...rename(%pd2, %pd2, ...) = %i\n",
e9be9d5e
MS
249 olddentry, newdentry, err);
250 }
251 return err;
252}
253
254static inline int ovl_do_whiteout(struct inode *dir, struct dentry *dentry)
255{
6521f891 256 int err = vfs_whiteout(&init_user_ns, dir, dentry);
e9be9d5e
MS
257 pr_debug("whiteout(%pd2) = %i\n", dentry, err);
258 return err;
259}
260
e7f52429
AG
261static inline struct dentry *ovl_do_tmpfile(struct dentry *dentry, umode_t mode)
262{
6521f891 263 struct dentry *ret = vfs_tmpfile(&init_user_ns, dentry, mode, 0);
7879cb43 264 int err = PTR_ERR_OR_ZERO(ret);
e7f52429
AG
265
266 pr_debug("tmpfile(%pd2, 0%o) = %i\n", dentry, mode, err);
267 return ret;
268}
269
0c288874
VG
270static inline bool ovl_open_flags_need_copy_up(int flags)
271{
272 if (!flags)
273 return false;
274
275 return ((OPEN_FMODE(flags) & FMODE_WRITE) || (flags & O_TRUNC));
276}
277
ca45275c
VY
278static inline bool ovl_allow_offline_changes(struct ovl_fs *ofs)
279{
280 /*
281 * To avoid regressions in existing setups with overlay lower offline
282 * changes, we allow lower changes only if none of the new features
283 * are used.
284 */
285 return (!ofs->config.index && !ofs->config.metacopy &&
286 !ofs->config.redirect_dir && ofs->config.xino != OVL_XINO_ON);
287}
288
289
bbb1e54d
MS
290/* util.c */
291int ovl_want_write(struct dentry *dentry);
292void ovl_drop_write(struct dentry *dentry);
293struct dentry *ovl_workdir(struct dentry *dentry);
294const struct cred *ovl_override_creds(struct super_block *sb);
e487d889 295int ovl_can_decode_fh(struct super_block *sb);
02bcd157 296struct dentry *ovl_indexdir(struct super_block *sb);
f168f109
AG
297bool ovl_index_all(struct super_block *sb);
298bool ovl_verify_lower(struct super_block *sb);
bbb1e54d
MS
299struct ovl_entry *ovl_alloc_entry(unsigned int numlower);
300bool ovl_dentry_remote(struct dentry *dentry);
f4288844
MS
301void ovl_dentry_update_reval(struct dentry *dentry, struct dentry *upperdentry,
302 unsigned int mask);
bbb1e54d 303bool ovl_dentry_weird(struct dentry *dentry);
e9be9d5e 304enum ovl_path_type ovl_path_type(struct dentry *dentry);
e9be9d5e
MS
305void ovl_path_upper(struct dentry *dentry, struct path *path);
306void ovl_path_lower(struct dentry *dentry, struct path *path);
4f93b426 307void ovl_path_lowerdata(struct dentry *dentry, struct path *path);
e9be9d5e
MS
308enum ovl_path_type ovl_path_real(struct dentry *dentry, struct path *path);
309struct dentry *ovl_dentry_upper(struct dentry *dentry);
310struct dentry *ovl_dentry_lower(struct dentry *dentry);
647d253f 311struct dentry *ovl_dentry_lowerdata(struct dentry *dentry);
13464165 312const struct ovl_layer *ovl_layer_lower(struct dentry *dentry);
e9be9d5e 313struct dentry *ovl_dentry_real(struct dentry *dentry);
1d88f183 314struct dentry *ovl_i_dentry_upper(struct inode *inode);
09d8b586
MS
315struct inode *ovl_inode_upper(struct inode *inode);
316struct inode *ovl_inode_lower(struct inode *inode);
2664bd08 317struct inode *ovl_inode_lowerdata(struct inode *inode);
09d8b586 318struct inode *ovl_inode_real(struct inode *inode);
4823d49c 319struct inode *ovl_inode_realdata(struct inode *inode);
4edb83bb
MS
320struct ovl_dir_cache *ovl_dir_cache(struct inode *inode);
321void ovl_set_dir_cache(struct inode *inode, struct ovl_dir_cache *cache);
c62520a8
AG
322void ovl_dentry_set_flag(unsigned long flag, struct dentry *dentry);
323void ovl_dentry_clear_flag(unsigned long flag, struct dentry *dentry);
324bool ovl_dentry_test_flag(unsigned long flag, struct dentry *dentry);
e9be9d5e 325bool ovl_dentry_is_opaque(struct dentry *dentry);
c412ce49 326bool ovl_dentry_is_whiteout(struct dentry *dentry);
5cf5b477 327void ovl_dentry_set_opaque(struct dentry *dentry);
55acc661
MS
328bool ovl_dentry_has_upper_alias(struct dentry *dentry);
329void ovl_dentry_set_upper_alias(struct dentry *dentry);
0c288874
VG
330bool ovl_dentry_needs_data_copy_up(struct dentry *dentry, int flags);
331bool ovl_dentry_needs_data_copy_up_locked(struct dentry *dentry, int flags);
332bool ovl_has_upperdata(struct inode *inode);
333void ovl_set_upperdata(struct inode *inode);
a6c60655 334bool ovl_redirect_dir(struct super_block *sb);
a6c60655
MS
335const char *ovl_dentry_get_redirect(struct dentry *dentry);
336void ovl_dentry_set_redirect(struct dentry *dentry, const char *redirect);
09d8b586 337void ovl_inode_update(struct inode *inode, struct dentry *upperdentry);
d9854c87 338void ovl_dir_modified(struct dentry *dentry, bool impurity);
bbb1e54d
MS
339u64 ovl_dentry_version_get(struct dentry *dentry);
340bool ovl_is_whiteout(struct dentry *dentry);
e9be9d5e 341struct file *ovl_path_open(struct path *path, int flags);
0c288874 342int ovl_copy_up_start(struct dentry *dentry, int flags);
39d3d60a 343void ovl_copy_up_end(struct dentry *dentry);
0c288874 344bool ovl_already_copied_up(struct dentry *dentry, int flags);
610afc0b
MS
345bool ovl_check_origin_xattr(struct ovl_fs *ofs, struct dentry *dentry);
346bool ovl_check_dir_xattr(struct super_block *sb, struct dentry *dentry,
43d193f8 347 enum ovl_xattr ox);
a0c236b1 348int ovl_check_setxattr(struct ovl_fs *ofs, struct dentry *upperdentry,
43d193f8 349 enum ovl_xattr ox, const void *value, size_t size,
f3a15685
AG
350 int xerr);
351int ovl_set_impure(struct dentry *dentry, struct dentry *upperdentry);
ad0af710
AG
352bool ovl_inuse_trylock(struct dentry *dentry);
353void ovl_inuse_unlock(struct dentry *dentry);
146d62e5 354bool ovl_is_inuse(struct dentry *dentry);
24b33ee1 355bool ovl_need_index(struct dentry *dentry);
0e32992f
AG
356int ovl_nlink_start(struct dentry *dentry);
357void ovl_nlink_end(struct dentry *dentry);
5820dc08 358int ovl_lock_rename_workdir(struct dentry *workdir, struct dentry *upperdir);
610afc0b 359int ovl_check_metacopy_xattr(struct ovl_fs *ofs, struct dentry *dentry);
67d756c2 360bool ovl_is_metacopy_dentry(struct dentry *dentry);
610afc0b
MS
361char *ovl_get_redirect_xattr(struct ovl_fs *ofs, struct dentry *dentry,
362 int padding);
335d3fc5 363int ovl_sync_status(struct ovl_fs *ofs);
f3a15685 364
65cd913e
AG
365static inline void ovl_set_flag(unsigned long flag, struct inode *inode)
366{
367 set_bit(flag, &OVL_I(inode)->flags);
368}
369
370static inline void ovl_clear_flag(unsigned long flag, struct inode *inode)
371{
372 clear_bit(flag, &OVL_I(inode)->flags);
373}
374
375static inline bool ovl_test_flag(unsigned long flag, struct inode *inode)
376{
377 return test_bit(flag, &OVL_I(inode)->flags);
378}
379
610afc0b
MS
380static inline bool ovl_is_impuredir(struct super_block *sb,
381 struct dentry *dentry)
f3a15685 382{
610afc0b 383 return ovl_check_dir_xattr(sb, dentry, OVL_XATTR_IMPURE);
f3a15685
AG
384}
385
926e94d7
AG
386/*
387 * With xino=auto, we do best effort to keep all inodes on same st_dev and
388 * d_ino consistent with st_ino.
389 * With xino=on, we do the same effort but we warn if we failed.
390 */
391static inline bool ovl_xino_warn(struct super_block *sb)
392{
393 return OVL_FS(sb)->config.xino == OVL_XINO_ON;
394}
395
0f831ec8
AG
396/* All layers on same fs? */
397static inline bool ovl_same_fs(struct super_block *sb)
e487d889 398{
0f831ec8
AG
399 return OVL_FS(sb)->xino_mode == 0;
400}
e487d889 401
0f831ec8
AG
402/* All overlay inodes have same st_dev? */
403static inline bool ovl_same_dev(struct super_block *sb)
404{
405 return OVL_FS(sb)->xino_mode >= 0;
406}
407
408static inline unsigned int ovl_xino_bits(struct super_block *sb)
409{
410 return ovl_same_dev(sb) ? OVL_FS(sb)->xino_mode : 0;
e487d889
AG
411}
412
531d3040
AG
413static inline void ovl_inode_lock(struct inode *inode)
414{
415 mutex_lock(&OVL_I(inode)->lock);
416}
417
418static inline int ovl_inode_lock_interruptible(struct inode *inode)
1e92e307
AG
419{
420 return mutex_lock_interruptible(&OVL_I(inode)->lock);
421}
422
423static inline void ovl_inode_unlock(struct inode *inode)
424{
425 mutex_unlock(&OVL_I(inode)->lock);
426}
427
e9be9d5e 428
bbb1e54d 429/* namei.c */
cbe7fba8
AG
430int ovl_check_fb_len(struct ovl_fb *fb, int fb_len);
431
432static inline int ovl_check_fh_len(struct ovl_fh *fh, int fh_len)
433{
522f6e6c
AG
434 if (fh_len < sizeof(struct ovl_fh))
435 return -EINVAL;
436
cbe7fba8
AG
437 return ovl_check_fb_len(&fh->fb, fh_len - OVL_FH_WIRE_OFFSET);
438}
439
1cdb0cb6
PT
440struct dentry *ovl_decode_real_fh(struct ovl_fs *ofs, struct ovl_fh *fh,
441 struct vfsmount *mnt, bool connected);
8a22efa1 442int ovl_check_origin_fh(struct ovl_fs *ofs, struct ovl_fh *fh, bool connected,
f941866f 443 struct dentry *upperdentry, struct ovl_path **stackp);
610afc0b 444int ovl_verify_set_fh(struct ovl_fs *ofs, struct dentry *dentry,
43d193f8 445 enum ovl_xattr ox, struct dentry *real, bool is_upper,
610afc0b 446 bool set);
3b0bfc6e 447struct dentry *ovl_index_upper(struct ovl_fs *ofs, struct dentry *index);
1eff1a1d 448int ovl_verify_index(struct ovl_fs *ofs, struct dentry *index);
1cdb0cb6
PT
449int ovl_get_index_name(struct ovl_fs *ofs, struct dentry *origin,
450 struct qstr *name);
91ffe7be 451struct dentry *ovl_get_index_fh(struct ovl_fs *ofs, struct ovl_fh *fh);
06170154
AG
452struct dentry *ovl_lookup_index(struct ovl_fs *ofs, struct dentry *upper,
453 struct dentry *origin, bool verify);
bbb1e54d 454int ovl_path_next(int idx, struct dentry *dentry, struct path *path);
1eff1a1d
AG
455struct dentry *ovl_lookup(struct inode *dir, struct dentry *dentry,
456 unsigned int flags);
bbb1e54d 457bool ovl_lower_positive(struct dentry *dentry);
e9be9d5e 458
610afc0b 459static inline int ovl_verify_origin(struct ovl_fs *ofs, struct dentry *upper,
05122443
AG
460 struct dentry *origin, bool set)
461{
610afc0b
MS
462 return ovl_verify_set_fh(ofs, upper, OVL_XATTR_ORIGIN, origin,
463 false, set);
05122443
AG
464}
465
610afc0b
MS
466static inline int ovl_verify_upper(struct ovl_fs *ofs, struct dentry *index,
467 struct dentry *upper, bool set)
ad1d615c 468{
610afc0b 469 return ovl_verify_set_fh(ofs, index, OVL_XATTR_UPPER, upper, true, set);
ad1d615c
AG
470}
471
e9be9d5e
MS
472/* readdir.c */
473extern const struct file_operations ovl_dir_operations;
61536bed 474struct file *ovl_dir_real_file(const struct file *file, bool want_upper);
e9be9d5e
MS
475int ovl_check_empty_dir(struct dentry *dentry, struct list_head *list);
476void ovl_cleanup_whiteouts(struct dentry *upper, struct list_head *list);
477void ovl_cache_free(struct list_head *list);
4edb83bb 478void ovl_dir_cache_free(struct inode *inode);
45aebeaf 479int ovl_check_d_type_supported(struct path *realpath);
3011645b
AG
480int ovl_workdir_cleanup(struct inode *dir, struct vfsmount *mnt,
481 struct dentry *dentry, int level);
1eff1a1d 482int ovl_indexdir_cleanup(struct ovl_fs *ofs);
e9be9d5e 483
65cd913e
AG
484/*
485 * Can we iterate real dir directly?
486 *
487 * Non-merge dir may contain whiteouts from a time it was a merge upper, before
488 * lower dir was removed under it and possibly before it was rotated from upper
489 * to lower layer.
490 */
491static inline bool ovl_dir_is_real(struct dentry *dir)
492{
493 return !ovl_test_flag(OVL_WHITEOUTS, d_inode(dir));
494}
495
e9be9d5e 496/* inode.c */
5f8415d6
AG
497int ovl_set_nlink_upper(struct dentry *dentry);
498int ovl_set_nlink_lower(struct dentry *dentry);
610afc0b 499unsigned int ovl_get_nlink(struct ovl_fs *ofs, struct dentry *lowerdentry,
caf70cb2
AG
500 struct dentry *upperdentry,
501 unsigned int fallback);
549c7297
CB
502int ovl_setattr(struct user_namespace *mnt_userns, struct dentry *dentry,
503 struct iattr *attr);
504int ovl_getattr(struct user_namespace *mnt_userns, const struct path *path,
505 struct kstat *stat, u32 request_mask, unsigned int flags);
506int ovl_permission(struct user_namespace *mnt_userns, struct inode *inode,
507 int mask);
1d88f183
MS
508int ovl_xattr_set(struct dentry *dentry, struct inode *inode, const char *name,
509 const void *value, size_t size, int flags);
510int ovl_xattr_get(struct dentry *dentry, struct inode *inode, const char *name,
0eb45fc3 511 void *value, size_t size);
e9be9d5e 512ssize_t ovl_listxattr(struct dentry *dentry, char *list, size_t size);
0cad6246 513struct posix_acl *ovl_get_acl(struct inode *inode, int type, bool rcu);
95582b00 514int ovl_update_time(struct inode *inode, struct timespec64 *ts, int flags);
610afc0b 515bool ovl_is_private_xattr(struct super_block *sb, const char *name);
e9be9d5e 516
ac6a52eb 517struct ovl_inode_params {
01b39dcc 518 struct inode *newinode;
ac6a52eb
VG
519 struct dentry *upperdentry;
520 struct ovl_path *lowerpath;
74c6e384 521 bool index;
ac6a52eb 522 unsigned int numlower;
9cec54c8 523 char *redirect;
2664bd08 524 struct dentry *lowerdata;
ac6a52eb 525};
62c832ed
AG
526void ovl_inode_init(struct inode *inode, struct ovl_inode_params *oip,
527 unsigned long ino, int fsid);
ca4c8a3a 528struct inode *ovl_new_inode(struct super_block *sb, umode_t mode, dev_t rdev);
4b91c30a
AG
529struct inode *ovl_lookup_inode(struct super_block *sb, struct dentry *real,
530 bool is_upper);
146d62e5
AG
531bool ovl_lookup_trap_inode(struct super_block *sb, struct dentry *dir);
532struct inode *ovl_get_trap_inode(struct super_block *sb, struct dentry *dir);
ac6a52eb
VG
533struct inode *ovl_get_inode(struct super_block *sb,
534 struct ovl_inode_params *oip);
e9be9d5e
MS
535static inline void ovl_copyattr(struct inode *from, struct inode *to)
536{
537 to->i_uid = from->i_uid;
538 to->i_gid = from->i_gid;
07a2daab 539 to->i_mode = from->i_mode;
d719e8f2
MS
540 to->i_atime = from->i_atime;
541 to->i_mtime = from->i_mtime;
542 to->i_ctime = from->i_ctime;
46e5d0a3 543 i_size_write(to, i_size_read(from));
e9be9d5e
MS
544}
545
72db8211
AG
546/* vfs inode flags copied from real to ovl inode */
547#define OVL_COPY_I_FLAGS_MASK (S_SYNC | S_NOATIME | S_APPEND | S_IMMUTABLE)
096a218a
AG
548/* vfs inode flags read from overlay.protattr xattr to ovl inode */
549#define OVL_PROT_I_FLAGS_MASK (S_APPEND | S_IMMUTABLE)
72db8211
AG
550
551/*
552 * fileattr flags copied from lower to upper inode on copy up.
096a218a
AG
553 * We cannot copy up immutable/append-only flags, because that would prevent
554 * linking temp inode to upper dir, so we store them in xattr instead.
72db8211
AG
555 */
556#define OVL_COPY_FS_FLAGS_MASK (FS_SYNC_FL | FS_NOATIME_FL)
557#define OVL_COPY_FSX_FLAGS_MASK (FS_XFLAG_SYNC | FS_XFLAG_NOATIME)
096a218a
AG
558#define OVL_PROT_FS_FLAGS_MASK (FS_APPEND_FL | FS_IMMUTABLE_FL)
559#define OVL_PROT_FSX_FLAGS_MASK (FS_XFLAG_APPEND | FS_XFLAG_IMMUTABLE)
560
561void ovl_check_protattr(struct inode *inode, struct dentry *upper);
562int ovl_set_protattr(struct inode *inode, struct dentry *upper,
563 struct fileattr *fa);
72db8211 564
4f357295
MS
565static inline void ovl_copyflags(struct inode *from, struct inode *to)
566{
72db8211 567 unsigned int mask = OVL_COPY_I_FLAGS_MASK;
4f357295
MS
568
569 inode_set_flags(to, from->i_flags & mask, mask);
570}
571
e9be9d5e
MS
572/* dir.c */
573extern const struct inode_operations ovl_dir_inode_operations;
c21c839b 574int ovl_cleanup_and_whiteout(struct ovl_fs *ofs, struct inode *dir,
e7dd0e71 575 struct dentry *dentry);
471ec5dc 576struct ovl_cattr {
32a3d848
AV
577 dev_t rdev;
578 umode_t mode;
579 const char *link;
471ec5dc 580 struct dentry *hardlink;
32a3d848 581};
471ec5dc
AG
582
583#define OVL_CATTR(m) (&(struct ovl_cattr) { .mode = (m) })
584
e1fd40d5 585int ovl_mkdir_real(struct inode *dir, struct dentry **newdentry, umode_t mode);
95a1c815
MS
586struct dentry *ovl_create_real(struct inode *dir, struct dentry *newdentry,
587 struct ovl_cattr *attr);
415543d5 588int ovl_cleanup(struct inode *dir, struct dentry *dentry);
cad218ab 589struct dentry *ovl_lookup_temp(struct dentry *workdir);
137ec526 590struct dentry *ovl_create_temp(struct dentry *workdir, struct ovl_cattr *attr);
e9be9d5e 591
d1d04ef8
MS
592/* file.c */
593extern const struct file_operations ovl_file_operations;
2406a307
JX
594int __init ovl_aio_request_cache_init(void);
595void ovl_aio_request_cache_destroy(void);
72db8211
AG
596int ovl_real_fileattr_get(struct path *realpath, struct fileattr *fa);
597int ovl_real_fileattr_set(struct path *realpath, struct fileattr *fa);
66dbfabf
MS
598int ovl_fileattr_get(struct dentry *dentry, struct fileattr *fa);
599int ovl_fileattr_set(struct user_namespace *mnt_userns,
600 struct dentry *dentry, struct fileattr *fa);
d1d04ef8 601
e9be9d5e
MS
602/* copy_up.c */
603int ovl_copy_up(struct dentry *dentry);
d1e6f6a9 604int ovl_copy_up_with_data(struct dentry *dentry);
3428030d 605int ovl_maybe_copy_up(struct dentry *dentry, int flags);
610afc0b
MS
606int ovl_copy_xattr(struct super_block *sb, struct dentry *old,
607 struct dentry *new);
e9be9d5e 608int ovl_set_attr(struct dentry *upper, struct kstat *stat);
1cdb0cb6
PT
609struct ovl_fh *ovl_encode_real_fh(struct ovl_fs *ofs, struct dentry *real,
610 bool is_upper);
a0c236b1
AG
611int ovl_set_origin(struct ovl_fs *ofs, struct dentry *lower,
612 struct dentry *upper);
8ed5eec9
AG
613
614/* export.c */
615extern const struct export_operations ovl_export_operations;