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