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