ovl: use ovl_do_notify_change() wrapper
[linux-block.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
a15506ea
CB
125/*
126 * When changing ownership of an upper object map the intended ownership
127 * according to the upper layer's idmapping. When an upper mount idmaps files
128 * that are stored on-disk as owned by id 1001 to id 1000 this means stat on
129 * this object will report it as being owned by id 1000 when calling stat via
130 * the upper mount.
131 * In order to change ownership of an object so stat reports id 1000 when
132 * called on an idmapped upper mount the value written to disk - i.e., the
133 * value stored in ia_*id - must 1001. The mount mapping helper will thus take
134 * care to map 1000 to 1001.
135 * The mnt idmapping helpers are nops if the upper layer isn't idmapped.
136 */
137static inline int ovl_do_notify_change(struct ovl_fs *ofs,
138 struct dentry *upperdentry,
139 struct iattr *attr)
140{
141 struct user_namespace *upper_mnt_userns = ovl_upper_mnt_userns(ofs);
142 struct user_namespace *fs_userns = i_user_ns(d_inode(upperdentry));
143
144 if (attr->ia_valid & ATTR_UID)
145 attr->ia_uid = mapped_kuid_user(upper_mnt_userns,
146 fs_userns, attr->ia_uid);
147 if (attr->ia_valid & ATTR_GID)
148 attr->ia_gid = mapped_kgid_user(upper_mnt_userns,
149 fs_userns, attr->ia_gid);
150
151 return notify_change(upper_mnt_userns, upperdentry, attr, NULL);
152}
153
576bb263
CB
154static inline int ovl_do_rmdir(struct ovl_fs *ofs,
155 struct inode *dir, struct dentry *dentry)
e9be9d5e 156{
c67cf654 157 int err = vfs_rmdir(ovl_upper_mnt_userns(ofs), dir, dentry);
6cf00764 158
e9be9d5e
MS
159 pr_debug("rmdir(%pd2) = %i\n", dentry, err);
160 return err;
161}
162
576bb263
CB
163static inline int ovl_do_unlink(struct ovl_fs *ofs, struct inode *dir,
164 struct dentry *dentry)
e9be9d5e 165{
c67cf654 166 int err = vfs_unlink(ovl_upper_mnt_userns(ofs), dir, dentry, NULL);
6cf00764 167
e9be9d5e
MS
168 pr_debug("unlink(%pd2) = %i\n", dentry, err);
169 return err;
170}
171
576bb263
CB
172static inline int ovl_do_link(struct ovl_fs *ofs, struct dentry *old_dentry,
173 struct inode *dir, struct dentry *new_dentry)
e9be9d5e 174{
c67cf654 175 int err = vfs_link(old_dentry, ovl_upper_mnt_userns(ofs), dir, new_dentry, NULL);
6cf00764
AG
176
177 pr_debug("link(%pd2, %pd2) = %i\n", old_dentry, new_dentry, err);
e9be9d5e
MS
178 return err;
179}
180
576bb263
CB
181static inline int ovl_do_create(struct ovl_fs *ofs,
182 struct inode *dir, struct dentry *dentry,
6cf00764 183 umode_t mode)
e9be9d5e 184{
c67cf654 185 int err = vfs_create(ovl_upper_mnt_userns(ofs), dir, dentry, mode, true);
6cf00764
AG
186
187 pr_debug("create(%pd2, 0%o) = %i\n", dentry, mode, err);
e9be9d5e
MS
188 return err;
189}
190
576bb263
CB
191static inline int ovl_do_mkdir(struct ovl_fs *ofs,
192 struct inode *dir, struct dentry *dentry,
6cf00764 193 umode_t mode)
e9be9d5e 194{
c67cf654 195 int err = vfs_mkdir(ovl_upper_mnt_userns(ofs), dir, dentry, mode);
6cf00764 196 pr_debug("mkdir(%pd2, 0%o) = %i\n", dentry, mode, err);
e9be9d5e
MS
197 return err;
198}
199
576bb263
CB
200static inline int ovl_do_mknod(struct ovl_fs *ofs,
201 struct inode *dir, struct dentry *dentry,
6cf00764 202 umode_t mode, dev_t dev)
e9be9d5e 203{
c67cf654 204 int err = vfs_mknod(ovl_upper_mnt_userns(ofs), dir, dentry, mode, dev);
6cf00764
AG
205
206 pr_debug("mknod(%pd2, 0%o, 0%o) = %i\n", dentry, mode, dev, err);
e9be9d5e
MS
207 return err;
208}
209
576bb263
CB
210static inline int ovl_do_symlink(struct ovl_fs *ofs,
211 struct inode *dir, struct dentry *dentry,
6cf00764 212 const char *oldname)
e9be9d5e 213{
c67cf654 214 int err = vfs_symlink(ovl_upper_mnt_userns(ofs), dir, dentry, oldname);
6cf00764
AG
215
216 pr_debug("symlink(\"%s\", %pd2) = %i\n", oldname, dentry, err);
e9be9d5e
MS
217 return err;
218}
219
610afc0b 220static inline ssize_t ovl_do_getxattr(struct ovl_fs *ofs, struct dentry *dentry,
c914c0e2 221 const char *name, void *value,
610afc0b 222 size_t size)
d5dc7486 223{
5e717c6f
AG
224 int err = vfs_getxattr(&init_user_ns, dentry, name, value, size);
225 int len = (value && err > 0) ? err : 0;
226
227 pr_debug("getxattr(%pd2, \"%s\", \"%*pE\", %zu, 0) = %i\n",
228 dentry, name, min(len, 48), value, size, err);
229 return err;
d5dc7486
MS
230}
231
c914c0e2
AG
232static inline ssize_t ovl_getxattr(struct ovl_fs *ofs, struct dentry *dentry,
233 enum ovl_xattr ox, void *value,
234 size_t size)
235{
236 return ovl_do_getxattr(ofs, dentry, ovl_xattr(ofs, ox), value, size);
237}
238
610afc0b 239static inline int ovl_do_setxattr(struct ovl_fs *ofs, struct dentry *dentry,
c914c0e2
AG
240 const char *name, const void *value,
241 size_t size, int flags)
e9be9d5e 242{
c914c0e2
AG
243 int err = vfs_setxattr(&init_user_ns, dentry, name, value, size, flags);
244
245 pr_debug("setxattr(%pd2, \"%s\", \"%*pE\", %zu, %d) = %i\n",
246 dentry, name, min((int)size, 48), value, size, flags, err);
e9be9d5e
MS
247 return err;
248}
249
c914c0e2
AG
250static inline int ovl_setxattr(struct ovl_fs *ofs, struct dentry *dentry,
251 enum ovl_xattr ox, const void *value,
252 size_t size)
253{
254 return ovl_do_setxattr(ofs, dentry, ovl_xattr(ofs, ox), value, size, 0);
255}
256
610afc0b 257static inline int ovl_do_removexattr(struct ovl_fs *ofs, struct dentry *dentry,
c914c0e2 258 const char *name)
e9be9d5e 259{
c7c7a1a1 260 int err = vfs_removexattr(&init_user_ns, dentry, name);
e9be9d5e
MS
261 pr_debug("removexattr(%pd2, \"%s\") = %i\n", dentry, name, err);
262 return err;
263}
264
c914c0e2
AG
265static inline int ovl_removexattr(struct ovl_fs *ofs, struct dentry *dentry,
266 enum ovl_xattr ox)
267{
268 return ovl_do_removexattr(ofs, dentry, ovl_xattr(ofs, ox));
269}
270
576bb263
CB
271static inline int ovl_do_rename(struct ovl_fs *ofs, struct inode *olddir,
272 struct dentry *olddentry, struct inode *newdir,
273 struct dentry *newdentry, unsigned int flags)
e9be9d5e
MS
274{
275 int err;
9fe61450 276 struct renamedata rd = {
c67cf654 277 .old_mnt_userns = ovl_upper_mnt_userns(ofs),
9fe61450
CB
278 .old_dir = olddir,
279 .old_dentry = olddentry,
c67cf654 280 .new_mnt_userns = ovl_upper_mnt_userns(ofs),
9fe61450
CB
281 .new_dir = newdir,
282 .new_dentry = newdentry,
283 .flags = flags,
284 };
e9be9d5e 285
6cf00764 286 pr_debug("rename(%pd2, %pd2, 0x%x)\n", olddentry, newdentry, flags);
9fe61450 287 err = vfs_rename(&rd);
e9be9d5e 288 if (err) {
2773bf00 289 pr_debug("...rename(%pd2, %pd2, ...) = %i\n",
e9be9d5e
MS
290 olddentry, newdentry, err);
291 }
292 return err;
293}
294
576bb263
CB
295static inline int ovl_do_whiteout(struct ovl_fs *ofs,
296 struct inode *dir, struct dentry *dentry)
e9be9d5e 297{
c67cf654 298 int err = vfs_whiteout(ovl_upper_mnt_userns(ofs), dir, dentry);
e9be9d5e
MS
299 pr_debug("whiteout(%pd2) = %i\n", dentry, err);
300 return err;
301}
302
576bb263
CB
303static inline struct dentry *ovl_do_tmpfile(struct ovl_fs *ofs,
304 struct dentry *dentry, umode_t mode)
e7f52429 305{
c67cf654 306 struct dentry *ret = vfs_tmpfile(ovl_upper_mnt_userns(ofs), dentry, mode, 0);
7879cb43 307 int err = PTR_ERR_OR_ZERO(ret);
e7f52429
AG
308
309 pr_debug("tmpfile(%pd2, 0%o) = %i\n", dentry, mode, err);
310 return ret;
311}
312
0c288874
VG
313static inline bool ovl_open_flags_need_copy_up(int flags)
314{
315 if (!flags)
316 return false;
317
318 return ((OPEN_FMODE(flags) & FMODE_WRITE) || (flags & O_TRUNC));
319}
320
ca45275c
VY
321static inline bool ovl_allow_offline_changes(struct ovl_fs *ofs)
322{
323 /*
324 * To avoid regressions in existing setups with overlay lower offline
325 * changes, we allow lower changes only if none of the new features
326 * are used.
327 */
328 return (!ofs->config.index && !ofs->config.metacopy &&
329 !ofs->config.redirect_dir && ofs->config.xino != OVL_XINO_ON);
330}
331
332
bbb1e54d
MS
333/* util.c */
334int ovl_want_write(struct dentry *dentry);
335void ovl_drop_write(struct dentry *dentry);
336struct dentry *ovl_workdir(struct dentry *dentry);
337const struct cred *ovl_override_creds(struct super_block *sb);
e487d889 338int ovl_can_decode_fh(struct super_block *sb);
02bcd157 339struct dentry *ovl_indexdir(struct super_block *sb);
f168f109
AG
340bool ovl_index_all(struct super_block *sb);
341bool ovl_verify_lower(struct super_block *sb);
bbb1e54d
MS
342struct ovl_entry *ovl_alloc_entry(unsigned int numlower);
343bool ovl_dentry_remote(struct dentry *dentry);
f4288844
MS
344void ovl_dentry_update_reval(struct dentry *dentry, struct dentry *upperdentry,
345 unsigned int mask);
bbb1e54d 346bool ovl_dentry_weird(struct dentry *dentry);
e9be9d5e 347enum ovl_path_type ovl_path_type(struct dentry *dentry);
e9be9d5e
MS
348void ovl_path_upper(struct dentry *dentry, struct path *path);
349void ovl_path_lower(struct dentry *dentry, struct path *path);
4f93b426 350void ovl_path_lowerdata(struct dentry *dentry, struct path *path);
e9be9d5e 351enum ovl_path_type ovl_path_real(struct dentry *dentry, struct path *path);
1248ea4b 352enum ovl_path_type ovl_path_realdata(struct dentry *dentry, struct path *path);
e9be9d5e
MS
353struct dentry *ovl_dentry_upper(struct dentry *dentry);
354struct dentry *ovl_dentry_lower(struct dentry *dentry);
647d253f 355struct dentry *ovl_dentry_lowerdata(struct dentry *dentry);
13464165 356const struct ovl_layer *ovl_layer_lower(struct dentry *dentry);
e9be9d5e 357struct dentry *ovl_dentry_real(struct dentry *dentry);
1d88f183 358struct dentry *ovl_i_dentry_upper(struct inode *inode);
09d8b586
MS
359struct inode *ovl_inode_upper(struct inode *inode);
360struct inode *ovl_inode_lower(struct inode *inode);
2664bd08 361struct inode *ovl_inode_lowerdata(struct inode *inode);
09d8b586 362struct inode *ovl_inode_real(struct inode *inode);
4823d49c 363struct inode *ovl_inode_realdata(struct inode *inode);
4edb83bb
MS
364struct ovl_dir_cache *ovl_dir_cache(struct inode *inode);
365void ovl_set_dir_cache(struct inode *inode, struct ovl_dir_cache *cache);
c62520a8
AG
366void ovl_dentry_set_flag(unsigned long flag, struct dentry *dentry);
367void ovl_dentry_clear_flag(unsigned long flag, struct dentry *dentry);
368bool ovl_dentry_test_flag(unsigned long flag, struct dentry *dentry);
e9be9d5e 369bool ovl_dentry_is_opaque(struct dentry *dentry);
c412ce49 370bool ovl_dentry_is_whiteout(struct dentry *dentry);
5cf5b477 371void ovl_dentry_set_opaque(struct dentry *dentry);
55acc661
MS
372bool ovl_dentry_has_upper_alias(struct dentry *dentry);
373void ovl_dentry_set_upper_alias(struct dentry *dentry);
0c288874
VG
374bool ovl_dentry_needs_data_copy_up(struct dentry *dentry, int flags);
375bool ovl_dentry_needs_data_copy_up_locked(struct dentry *dentry, int flags);
376bool ovl_has_upperdata(struct inode *inode);
377void ovl_set_upperdata(struct inode *inode);
a6c60655 378bool ovl_redirect_dir(struct super_block *sb);
a6c60655
MS
379const char *ovl_dentry_get_redirect(struct dentry *dentry);
380void ovl_dentry_set_redirect(struct dentry *dentry, const char *redirect);
09d8b586 381void ovl_inode_update(struct inode *inode, struct dentry *upperdentry);
d9854c87 382void ovl_dir_modified(struct dentry *dentry, bool impurity);
bbb1e54d
MS
383u64 ovl_dentry_version_get(struct dentry *dentry);
384bool ovl_is_whiteout(struct dentry *dentry);
e9be9d5e 385struct file *ovl_path_open(struct path *path, int flags);
0c288874 386int ovl_copy_up_start(struct dentry *dentry, int flags);
39d3d60a 387void ovl_copy_up_end(struct dentry *dentry);
0c288874 388bool ovl_already_copied_up(struct dentry *dentry, int flags);
610afc0b
MS
389bool ovl_check_origin_xattr(struct ovl_fs *ofs, struct dentry *dentry);
390bool ovl_check_dir_xattr(struct super_block *sb, struct dentry *dentry,
43d193f8 391 enum ovl_xattr ox);
a0c236b1 392int ovl_check_setxattr(struct ovl_fs *ofs, struct dentry *upperdentry,
43d193f8 393 enum ovl_xattr ox, const void *value, size_t size,
f3a15685
AG
394 int xerr);
395int ovl_set_impure(struct dentry *dentry, struct dentry *upperdentry);
ad0af710
AG
396bool ovl_inuse_trylock(struct dentry *dentry);
397void ovl_inuse_unlock(struct dentry *dentry);
146d62e5 398bool ovl_is_inuse(struct dentry *dentry);
24b33ee1 399bool ovl_need_index(struct dentry *dentry);
0e32992f
AG
400int ovl_nlink_start(struct dentry *dentry);
401void ovl_nlink_end(struct dentry *dentry);
5820dc08 402int ovl_lock_rename_workdir(struct dentry *workdir, struct dentry *upperdir);
610afc0b 403int ovl_check_metacopy_xattr(struct ovl_fs *ofs, struct dentry *dentry);
67d756c2 404bool ovl_is_metacopy_dentry(struct dentry *dentry);
610afc0b
MS
405char *ovl_get_redirect_xattr(struct ovl_fs *ofs, struct dentry *dentry,
406 int padding);
335d3fc5 407int ovl_sync_status(struct ovl_fs *ofs);
f3a15685 408
65cd913e
AG
409static inline void ovl_set_flag(unsigned long flag, struct inode *inode)
410{
411 set_bit(flag, &OVL_I(inode)->flags);
412}
413
414static inline void ovl_clear_flag(unsigned long flag, struct inode *inode)
415{
416 clear_bit(flag, &OVL_I(inode)->flags);
417}
418
419static inline bool ovl_test_flag(unsigned long flag, struct inode *inode)
420{
421 return test_bit(flag, &OVL_I(inode)->flags);
422}
423
610afc0b
MS
424static inline bool ovl_is_impuredir(struct super_block *sb,
425 struct dentry *dentry)
f3a15685 426{
610afc0b 427 return ovl_check_dir_xattr(sb, dentry, OVL_XATTR_IMPURE);
f3a15685
AG
428}
429
926e94d7
AG
430/*
431 * With xino=auto, we do best effort to keep all inodes on same st_dev and
432 * d_ino consistent with st_ino.
433 * With xino=on, we do the same effort but we warn if we failed.
434 */
435static inline bool ovl_xino_warn(struct super_block *sb)
436{
437 return OVL_FS(sb)->config.xino == OVL_XINO_ON;
438}
439
0f831ec8
AG
440/* All layers on same fs? */
441static inline bool ovl_same_fs(struct super_block *sb)
e487d889 442{
0f831ec8
AG
443 return OVL_FS(sb)->xino_mode == 0;
444}
e487d889 445
0f831ec8
AG
446/* All overlay inodes have same st_dev? */
447static inline bool ovl_same_dev(struct super_block *sb)
448{
449 return OVL_FS(sb)->xino_mode >= 0;
450}
451
452static inline unsigned int ovl_xino_bits(struct super_block *sb)
453{
454 return ovl_same_dev(sb) ? OVL_FS(sb)->xino_mode : 0;
e487d889
AG
455}
456
531d3040
AG
457static inline void ovl_inode_lock(struct inode *inode)
458{
459 mutex_lock(&OVL_I(inode)->lock);
460}
461
462static inline int ovl_inode_lock_interruptible(struct inode *inode)
1e92e307
AG
463{
464 return mutex_lock_interruptible(&OVL_I(inode)->lock);
465}
466
467static inline void ovl_inode_unlock(struct inode *inode)
468{
469 mutex_unlock(&OVL_I(inode)->lock);
470}
471
e9be9d5e 472
bbb1e54d 473/* namei.c */
cbe7fba8
AG
474int ovl_check_fb_len(struct ovl_fb *fb, int fb_len);
475
476static inline int ovl_check_fh_len(struct ovl_fh *fh, int fh_len)
477{
522f6e6c
AG
478 if (fh_len < sizeof(struct ovl_fh))
479 return -EINVAL;
480
cbe7fba8
AG
481 return ovl_check_fb_len(&fh->fb, fh_len - OVL_FH_WIRE_OFFSET);
482}
483
1cdb0cb6
PT
484struct dentry *ovl_decode_real_fh(struct ovl_fs *ofs, struct ovl_fh *fh,
485 struct vfsmount *mnt, bool connected);
8a22efa1 486int ovl_check_origin_fh(struct ovl_fs *ofs, struct ovl_fh *fh, bool connected,
f941866f 487 struct dentry *upperdentry, struct ovl_path **stackp);
610afc0b 488int ovl_verify_set_fh(struct ovl_fs *ofs, struct dentry *dentry,
43d193f8 489 enum ovl_xattr ox, struct dentry *real, bool is_upper,
610afc0b 490 bool set);
3b0bfc6e 491struct dentry *ovl_index_upper(struct ovl_fs *ofs, struct dentry *index);
1eff1a1d 492int ovl_verify_index(struct ovl_fs *ofs, struct dentry *index);
1cdb0cb6
PT
493int ovl_get_index_name(struct ovl_fs *ofs, struct dentry *origin,
494 struct qstr *name);
91ffe7be 495struct dentry *ovl_get_index_fh(struct ovl_fs *ofs, struct ovl_fh *fh);
06170154
AG
496struct dentry *ovl_lookup_index(struct ovl_fs *ofs, struct dentry *upper,
497 struct dentry *origin, bool verify);
bbb1e54d 498int ovl_path_next(int idx, struct dentry *dentry, struct path *path);
1eff1a1d
AG
499struct dentry *ovl_lookup(struct inode *dir, struct dentry *dentry,
500 unsigned int flags);
bbb1e54d 501bool ovl_lower_positive(struct dentry *dentry);
e9be9d5e 502
610afc0b 503static inline int ovl_verify_origin(struct ovl_fs *ofs, struct dentry *upper,
05122443
AG
504 struct dentry *origin, bool set)
505{
610afc0b
MS
506 return ovl_verify_set_fh(ofs, upper, OVL_XATTR_ORIGIN, origin,
507 false, set);
05122443
AG
508}
509
610afc0b
MS
510static inline int ovl_verify_upper(struct ovl_fs *ofs, struct dentry *index,
511 struct dentry *upper, bool set)
ad1d615c 512{
610afc0b 513 return ovl_verify_set_fh(ofs, index, OVL_XATTR_UPPER, upper, true, set);
ad1d615c
AG
514}
515
e9be9d5e
MS
516/* readdir.c */
517extern const struct file_operations ovl_dir_operations;
61536bed 518struct file *ovl_dir_real_file(const struct file *file, bool want_upper);
e9be9d5e 519int ovl_check_empty_dir(struct dentry *dentry, struct list_head *list);
576bb263
CB
520void ovl_cleanup_whiteouts(struct ovl_fs *ofs, struct dentry *upper,
521 struct list_head *list);
e9be9d5e 522void ovl_cache_free(struct list_head *list);
4edb83bb 523void ovl_dir_cache_free(struct inode *inode);
45aebeaf 524int ovl_check_d_type_supported(struct path *realpath);
576bb263
CB
525int ovl_workdir_cleanup(struct ovl_fs *ofs, struct inode *dir,
526 struct vfsmount *mnt, struct dentry *dentry, int level);
1eff1a1d 527int ovl_indexdir_cleanup(struct ovl_fs *ofs);
e9be9d5e 528
65cd913e
AG
529/*
530 * Can we iterate real dir directly?
531 *
532 * Non-merge dir may contain whiteouts from a time it was a merge upper, before
533 * lower dir was removed under it and possibly before it was rotated from upper
534 * to lower layer.
535 */
536static inline bool ovl_dir_is_real(struct dentry *dir)
537{
538 return !ovl_test_flag(OVL_WHITEOUTS, d_inode(dir));
539}
540
e9be9d5e 541/* inode.c */
5f8415d6
AG
542int ovl_set_nlink_upper(struct dentry *dentry);
543int ovl_set_nlink_lower(struct dentry *dentry);
610afc0b 544unsigned int ovl_get_nlink(struct ovl_fs *ofs, struct dentry *lowerdentry,
caf70cb2
AG
545 struct dentry *upperdentry,
546 unsigned int fallback);
549c7297
CB
547int ovl_setattr(struct user_namespace *mnt_userns, struct dentry *dentry,
548 struct iattr *attr);
549int ovl_getattr(struct user_namespace *mnt_userns, const struct path *path,
550 struct kstat *stat, u32 request_mask, unsigned int flags);
551int ovl_permission(struct user_namespace *mnt_userns, struct inode *inode,
552 int mask);
1d88f183
MS
553int ovl_xattr_set(struct dentry *dentry, struct inode *inode, const char *name,
554 const void *value, size_t size, int flags);
555int ovl_xattr_get(struct dentry *dentry, struct inode *inode, const char *name,
0eb45fc3 556 void *value, size_t size);
e9be9d5e 557ssize_t ovl_listxattr(struct dentry *dentry, char *list, size_t size);
0cad6246 558struct posix_acl *ovl_get_acl(struct inode *inode, int type, bool rcu);
95582b00 559int ovl_update_time(struct inode *inode, struct timespec64 *ts, int flags);
610afc0b 560bool ovl_is_private_xattr(struct super_block *sb, const char *name);
e9be9d5e 561
ac6a52eb 562struct ovl_inode_params {
01b39dcc 563 struct inode *newinode;
ac6a52eb
VG
564 struct dentry *upperdentry;
565 struct ovl_path *lowerpath;
74c6e384 566 bool index;
ac6a52eb 567 unsigned int numlower;
9cec54c8 568 char *redirect;
2664bd08 569 struct dentry *lowerdata;
ac6a52eb 570};
62c832ed
AG
571void ovl_inode_init(struct inode *inode, struct ovl_inode_params *oip,
572 unsigned long ino, int fsid);
ca4c8a3a 573struct inode *ovl_new_inode(struct super_block *sb, umode_t mode, dev_t rdev);
4b91c30a
AG
574struct inode *ovl_lookup_inode(struct super_block *sb, struct dentry *real,
575 bool is_upper);
146d62e5
AG
576bool ovl_lookup_trap_inode(struct super_block *sb, struct dentry *dir);
577struct inode *ovl_get_trap_inode(struct super_block *sb, struct dentry *dir);
ac6a52eb
VG
578struct inode *ovl_get_inode(struct super_block *sb,
579 struct ovl_inode_params *oip);
e9be9d5e
MS
580static inline void ovl_copyattr(struct inode *from, struct inode *to)
581{
582 to->i_uid = from->i_uid;
583 to->i_gid = from->i_gid;
07a2daab 584 to->i_mode = from->i_mode;
d719e8f2
MS
585 to->i_atime = from->i_atime;
586 to->i_mtime = from->i_mtime;
587 to->i_ctime = from->i_ctime;
46e5d0a3 588 i_size_write(to, i_size_read(from));
e9be9d5e
MS
589}
590
72db8211
AG
591/* vfs inode flags copied from real to ovl inode */
592#define OVL_COPY_I_FLAGS_MASK (S_SYNC | S_NOATIME | S_APPEND | S_IMMUTABLE)
096a218a
AG
593/* vfs inode flags read from overlay.protattr xattr to ovl inode */
594#define OVL_PROT_I_FLAGS_MASK (S_APPEND | S_IMMUTABLE)
72db8211
AG
595
596/*
597 * fileattr flags copied from lower to upper inode on copy up.
096a218a
AG
598 * We cannot copy up immutable/append-only flags, because that would prevent
599 * linking temp inode to upper dir, so we store them in xattr instead.
72db8211
AG
600 */
601#define OVL_COPY_FS_FLAGS_MASK (FS_SYNC_FL | FS_NOATIME_FL)
602#define OVL_COPY_FSX_FLAGS_MASK (FS_XFLAG_SYNC | FS_XFLAG_NOATIME)
096a218a
AG
603#define OVL_PROT_FS_FLAGS_MASK (FS_APPEND_FL | FS_IMMUTABLE_FL)
604#define OVL_PROT_FSX_FLAGS_MASK (FS_XFLAG_APPEND | FS_XFLAG_IMMUTABLE)
605
606void ovl_check_protattr(struct inode *inode, struct dentry *upper);
607int ovl_set_protattr(struct inode *inode, struct dentry *upper,
608 struct fileattr *fa);
72db8211 609
4f357295
MS
610static inline void ovl_copyflags(struct inode *from, struct inode *to)
611{
72db8211 612 unsigned int mask = OVL_COPY_I_FLAGS_MASK;
4f357295
MS
613
614 inode_set_flags(to, from->i_flags & mask, mask);
615}
616
e9be9d5e
MS
617/* dir.c */
618extern const struct inode_operations ovl_dir_inode_operations;
c21c839b 619int ovl_cleanup_and_whiteout(struct ovl_fs *ofs, struct inode *dir,
e7dd0e71 620 struct dentry *dentry);
471ec5dc 621struct ovl_cattr {
32a3d848
AV
622 dev_t rdev;
623 umode_t mode;
624 const char *link;
471ec5dc 625 struct dentry *hardlink;
32a3d848 626};
471ec5dc
AG
627
628#define OVL_CATTR(m) (&(struct ovl_cattr) { .mode = (m) })
629
576bb263
CB
630int ovl_mkdir_real(struct ovl_fs *ofs, struct inode *dir,
631 struct dentry **newdentry, umode_t mode);
632struct dentry *ovl_create_real(struct ovl_fs *ofs,
633 struct inode *dir, struct dentry *newdentry,
634 struct ovl_cattr *attr);
635int ovl_cleanup(struct ovl_fs *ofs, struct inode *dir, struct dentry *dentry);
636struct dentry *ovl_lookup_temp(struct ovl_fs *ofs, struct dentry *workdir);
637struct dentry *ovl_create_temp(struct ovl_fs *ofs, struct dentry *workdir,
95a1c815 638 struct ovl_cattr *attr);
e9be9d5e 639
d1d04ef8
MS
640/* file.c */
641extern const struct file_operations ovl_file_operations;
2406a307
JX
642int __init ovl_aio_request_cache_init(void);
643void ovl_aio_request_cache_destroy(void);
72db8211
AG
644int ovl_real_fileattr_get(struct path *realpath, struct fileattr *fa);
645int ovl_real_fileattr_set(struct path *realpath, struct fileattr *fa);
66dbfabf
MS
646int ovl_fileattr_get(struct dentry *dentry, struct fileattr *fa);
647int ovl_fileattr_set(struct user_namespace *mnt_userns,
648 struct dentry *dentry, struct fileattr *fa);
d1d04ef8 649
e9be9d5e
MS
650/* copy_up.c */
651int ovl_copy_up(struct dentry *dentry);
d1e6f6a9 652int ovl_copy_up_with_data(struct dentry *dentry);
3428030d 653int ovl_maybe_copy_up(struct dentry *dentry, int flags);
610afc0b
MS
654int ovl_copy_xattr(struct super_block *sb, struct dentry *old,
655 struct dentry *new);
5272eaf3 656int ovl_set_attr(struct ovl_fs *ofs, struct dentry *upper, struct kstat *stat);
1cdb0cb6
PT
657struct ovl_fh *ovl_encode_real_fh(struct ovl_fs *ofs, struct dentry *real,
658 bool is_upper);
a0c236b1
AG
659int ovl_set_origin(struct ovl_fs *ofs, struct dentry *lower,
660 struct dentry *upper);
8ed5eec9
AG
661
662/* export.c */
663extern const struct export_operations ovl_export_operations;