xref: /openbmc/linux/fs/overlayfs/util.c (revision bccece1e)
1d2912cb1SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-only
2bbb1e54dSMiklos Szeredi /*
3bbb1e54dSMiklos Szeredi  * Copyright (C) 2011 Novell Inc.
4bbb1e54dSMiklos Szeredi  * Copyright (C) 2016 Red Hat, Inc.
5bbb1e54dSMiklos Szeredi  */
6bbb1e54dSMiklos Szeredi 
7bbb1e54dSMiklos Szeredi #include <linux/fs.h>
8bbb1e54dSMiklos Szeredi #include <linux/mount.h>
9bbb1e54dSMiklos Szeredi #include <linux/slab.h>
105b825c3aSIngo Molnar #include <linux/cred.h>
11bbb1e54dSMiklos Szeredi #include <linux/xattr.h>
1202bcd157SAmir Goldstein #include <linux/exportfs.h>
1302bcd157SAmir Goldstein #include <linux/uuid.h>
14caf70cb2SAmir Goldstein #include <linux/namei.h>
15caf70cb2SAmir Goldstein #include <linux/ratelimit.h>
16bbb1e54dSMiklos Szeredi #include "overlayfs.h"
17bbb1e54dSMiklos Szeredi 
18bbb1e54dSMiklos Szeredi int ovl_want_write(struct dentry *dentry)
19bbb1e54dSMiklos Szeredi {
20bbb1e54dSMiklos Szeredi 	struct ovl_fs *ofs = dentry->d_sb->s_fs_info;
21bbb1e54dSMiklos Szeredi 	return mnt_want_write(ofs->upper_mnt);
22bbb1e54dSMiklos Szeredi }
23bbb1e54dSMiklos Szeredi 
24bbb1e54dSMiklos Szeredi void ovl_drop_write(struct dentry *dentry)
25bbb1e54dSMiklos Szeredi {
26bbb1e54dSMiklos Szeredi 	struct ovl_fs *ofs = dentry->d_sb->s_fs_info;
27bbb1e54dSMiklos Szeredi 	mnt_drop_write(ofs->upper_mnt);
28bbb1e54dSMiklos Szeredi }
29bbb1e54dSMiklos Szeredi 
30bbb1e54dSMiklos Szeredi struct dentry *ovl_workdir(struct dentry *dentry)
31bbb1e54dSMiklos Szeredi {
32bbb1e54dSMiklos Szeredi 	struct ovl_fs *ofs = dentry->d_sb->s_fs_info;
33bbb1e54dSMiklos Szeredi 	return ofs->workdir;
34bbb1e54dSMiklos Szeredi }
35bbb1e54dSMiklos Szeredi 
36bbb1e54dSMiklos Szeredi const struct cred *ovl_override_creds(struct super_block *sb)
37bbb1e54dSMiklos Szeredi {
38bbb1e54dSMiklos Szeredi 	struct ovl_fs *ofs = sb->s_fs_info;
39bbb1e54dSMiklos Szeredi 
40bbb1e54dSMiklos Szeredi 	return override_creds(ofs->creator_cred);
41bbb1e54dSMiklos Szeredi }
42bbb1e54dSMiklos Szeredi 
43e487d889SAmir Goldstein /*
44e487d889SAmir Goldstein  * Check if underlying fs supports file handles and try to determine encoding
45e487d889SAmir Goldstein  * type, in order to deduce maximum inode number used by fs.
46e487d889SAmir Goldstein  *
47e487d889SAmir Goldstein  * Return 0 if file handles are not supported.
48e487d889SAmir Goldstein  * Return 1 (FILEID_INO32_GEN) if fs uses the default 32bit inode encoding.
49e487d889SAmir Goldstein  * Return -1 if fs uses a non default encoding with unknown inode size.
50e487d889SAmir Goldstein  */
51e487d889SAmir Goldstein int ovl_can_decode_fh(struct super_block *sb)
5202bcd157SAmir Goldstein {
539df085f3SAmir Goldstein 	if (!sb->s_export_op || !sb->s_export_op->fh_to_dentry)
54e487d889SAmir Goldstein 		return 0;
55e487d889SAmir Goldstein 
56e487d889SAmir Goldstein 	return sb->s_export_op->encode_fh ? -1 : FILEID_INO32_GEN;
5702bcd157SAmir Goldstein }
5802bcd157SAmir Goldstein 
5902bcd157SAmir Goldstein struct dentry *ovl_indexdir(struct super_block *sb)
6002bcd157SAmir Goldstein {
6102bcd157SAmir Goldstein 	struct ovl_fs *ofs = sb->s_fs_info;
6202bcd157SAmir Goldstein 
6302bcd157SAmir Goldstein 	return ofs->indexdir;
6402bcd157SAmir Goldstein }
6502bcd157SAmir Goldstein 
66f168f109SAmir Goldstein /* Index all files on copy up. For now only enabled for NFS export */
67f168f109SAmir Goldstein bool ovl_index_all(struct super_block *sb)
68f168f109SAmir Goldstein {
69f168f109SAmir Goldstein 	struct ovl_fs *ofs = sb->s_fs_info;
70f168f109SAmir Goldstein 
71f168f109SAmir Goldstein 	return ofs->config.nfs_export && ofs->config.index;
72f168f109SAmir Goldstein }
73f168f109SAmir Goldstein 
74f168f109SAmir Goldstein /* Verify lower origin on lookup. For now only enabled for NFS export */
75f168f109SAmir Goldstein bool ovl_verify_lower(struct super_block *sb)
76f168f109SAmir Goldstein {
77f168f109SAmir Goldstein 	struct ovl_fs *ofs = sb->s_fs_info;
78f168f109SAmir Goldstein 
79f168f109SAmir Goldstein 	return ofs->config.nfs_export && ofs->config.index;
80f168f109SAmir Goldstein }
81f168f109SAmir Goldstein 
82bbb1e54dSMiklos Szeredi struct ovl_entry *ovl_alloc_entry(unsigned int numlower)
83bbb1e54dSMiklos Szeredi {
84bbb1e54dSMiklos Szeredi 	size_t size = offsetof(struct ovl_entry, lowerstack[numlower]);
85bbb1e54dSMiklos Szeredi 	struct ovl_entry *oe = kzalloc(size, GFP_KERNEL);
86bbb1e54dSMiklos Szeredi 
87bbb1e54dSMiklos Szeredi 	if (oe)
88bbb1e54dSMiklos Szeredi 		oe->numlower = numlower;
89bbb1e54dSMiklos Szeredi 
90bbb1e54dSMiklos Szeredi 	return oe;
91bbb1e54dSMiklos Szeredi }
92bbb1e54dSMiklos Szeredi 
93bbb1e54dSMiklos Szeredi bool ovl_dentry_remote(struct dentry *dentry)
94bbb1e54dSMiklos Szeredi {
95bbb1e54dSMiklos Szeredi 	return dentry->d_flags &
967925dad8SMiklos Szeredi 		(DCACHE_OP_REVALIDATE | DCACHE_OP_WEAK_REVALIDATE);
97bbb1e54dSMiklos Szeredi }
98bbb1e54dSMiklos Szeredi 
99f4288844SMiklos Szeredi void ovl_dentry_update_reval(struct dentry *dentry, struct dentry *upperdentry,
100f4288844SMiklos Szeredi 			     unsigned int mask)
101f4288844SMiklos Szeredi {
102f4288844SMiklos Szeredi 	struct ovl_entry *oe = OVL_E(dentry);
103f4288844SMiklos Szeredi 	unsigned int i, flags = 0;
104f4288844SMiklos Szeredi 
105bccece1eSMiklos Szeredi 	if (upperdentry)
106bccece1eSMiklos Szeredi 		flags |= upperdentry->d_flags;
107f4288844SMiklos Szeredi 	for (i = 0; i < oe->numlower; i++)
108f4288844SMiklos Szeredi 		flags |= oe->lowerstack[i].dentry->d_flags;
109f4288844SMiklos Szeredi 
110f4288844SMiklos Szeredi 	spin_lock(&dentry->d_lock);
111f4288844SMiklos Szeredi 	dentry->d_flags &= ~mask;
112f4288844SMiklos Szeredi 	dentry->d_flags |= flags & mask;
113f4288844SMiklos Szeredi 	spin_unlock(&dentry->d_lock);
114f4288844SMiklos Szeredi }
115f4288844SMiklos Szeredi 
116bbb1e54dSMiklos Szeredi bool ovl_dentry_weird(struct dentry *dentry)
117bbb1e54dSMiklos Szeredi {
118bbb1e54dSMiklos Szeredi 	return dentry->d_flags & (DCACHE_NEED_AUTOMOUNT |
119bbb1e54dSMiklos Szeredi 				  DCACHE_MANAGE_TRANSIT |
120bbb1e54dSMiklos Szeredi 				  DCACHE_OP_HASH |
121bbb1e54dSMiklos Szeredi 				  DCACHE_OP_COMPARE);
122bbb1e54dSMiklos Szeredi }
123bbb1e54dSMiklos Szeredi 
124bbb1e54dSMiklos Szeredi enum ovl_path_type ovl_path_type(struct dentry *dentry)
125bbb1e54dSMiklos Szeredi {
126bbb1e54dSMiklos Szeredi 	struct ovl_entry *oe = dentry->d_fsdata;
127bbb1e54dSMiklos Szeredi 	enum ovl_path_type type = 0;
128bbb1e54dSMiklos Szeredi 
12909d8b586SMiklos Szeredi 	if (ovl_dentry_upper(dentry)) {
130bbb1e54dSMiklos Szeredi 		type = __OVL_PATH_UPPER;
131bbb1e54dSMiklos Szeredi 
132bbb1e54dSMiklos Szeredi 		/*
13359548503SAmir Goldstein 		 * Non-dir dentry can hold lower dentry of its copy up origin.
134bbb1e54dSMiklos Szeredi 		 */
13559548503SAmir Goldstein 		if (oe->numlower) {
13660124877SVivek Goyal 			if (ovl_test_flag(OVL_CONST_INO, d_inode(dentry)))
13759548503SAmir Goldstein 				type |= __OVL_PATH_ORIGIN;
1380b17c28aSVivek Goyal 			if (d_is_dir(dentry) ||
1390b17c28aSVivek Goyal 			    !ovl_has_upperdata(d_inode(dentry)))
140bbb1e54dSMiklos Szeredi 				type |= __OVL_PATH_MERGE;
14159548503SAmir Goldstein 		}
142bbb1e54dSMiklos Szeredi 	} else {
143bbb1e54dSMiklos Szeredi 		if (oe->numlower > 1)
144bbb1e54dSMiklos Szeredi 			type |= __OVL_PATH_MERGE;
145bbb1e54dSMiklos Szeredi 	}
146bbb1e54dSMiklos Szeredi 	return type;
147bbb1e54dSMiklos Szeredi }
148bbb1e54dSMiklos Szeredi 
149bbb1e54dSMiklos Szeredi void ovl_path_upper(struct dentry *dentry, struct path *path)
150bbb1e54dSMiklos Szeredi {
151bbb1e54dSMiklos Szeredi 	struct ovl_fs *ofs = dentry->d_sb->s_fs_info;
152bbb1e54dSMiklos Szeredi 
153bbb1e54dSMiklos Szeredi 	path->mnt = ofs->upper_mnt;
15409d8b586SMiklos Szeredi 	path->dentry = ovl_dentry_upper(dentry);
155bbb1e54dSMiklos Szeredi }
156bbb1e54dSMiklos Szeredi 
157bbb1e54dSMiklos Szeredi void ovl_path_lower(struct dentry *dentry, struct path *path)
158bbb1e54dSMiklos Szeredi {
159bbb1e54dSMiklos Szeredi 	struct ovl_entry *oe = dentry->d_fsdata;
160bbb1e54dSMiklos Szeredi 
161b9343632SChandan Rajendra 	if (oe->numlower) {
162b9343632SChandan Rajendra 		path->mnt = oe->lowerstack[0].layer->mnt;
163b9343632SChandan Rajendra 		path->dentry = oe->lowerstack[0].dentry;
164b9343632SChandan Rajendra 	} else {
165b9343632SChandan Rajendra 		*path = (struct path) { };
166b9343632SChandan Rajendra 	}
167bbb1e54dSMiklos Szeredi }
168bbb1e54dSMiklos Szeredi 
1694f93b426SVivek Goyal void ovl_path_lowerdata(struct dentry *dentry, struct path *path)
1704f93b426SVivek Goyal {
1714f93b426SVivek Goyal 	struct ovl_entry *oe = dentry->d_fsdata;
1724f93b426SVivek Goyal 
1734f93b426SVivek Goyal 	if (oe->numlower) {
1744f93b426SVivek Goyal 		path->mnt = oe->lowerstack[oe->numlower - 1].layer->mnt;
1754f93b426SVivek Goyal 		path->dentry = oe->lowerstack[oe->numlower - 1].dentry;
1764f93b426SVivek Goyal 	} else {
1774f93b426SVivek Goyal 		*path = (struct path) { };
1784f93b426SVivek Goyal 	}
1794f93b426SVivek Goyal }
1804f93b426SVivek Goyal 
181bbb1e54dSMiklos Szeredi enum ovl_path_type ovl_path_real(struct dentry *dentry, struct path *path)
182bbb1e54dSMiklos Szeredi {
183bbb1e54dSMiklos Szeredi 	enum ovl_path_type type = ovl_path_type(dentry);
184bbb1e54dSMiklos Szeredi 
185bbb1e54dSMiklos Szeredi 	if (!OVL_TYPE_UPPER(type))
186bbb1e54dSMiklos Szeredi 		ovl_path_lower(dentry, path);
187bbb1e54dSMiklos Szeredi 	else
188bbb1e54dSMiklos Szeredi 		ovl_path_upper(dentry, path);
189bbb1e54dSMiklos Szeredi 
190bbb1e54dSMiklos Szeredi 	return type;
191bbb1e54dSMiklos Szeredi }
192bbb1e54dSMiklos Szeredi 
193bbb1e54dSMiklos Szeredi struct dentry *ovl_dentry_upper(struct dentry *dentry)
194bbb1e54dSMiklos Szeredi {
19509d8b586SMiklos Szeredi 	return ovl_upperdentry_dereference(OVL_I(d_inode(dentry)));
196bbb1e54dSMiklos Szeredi }
197bbb1e54dSMiklos Szeredi 
198bbb1e54dSMiklos Szeredi struct dentry *ovl_dentry_lower(struct dentry *dentry)
199bbb1e54dSMiklos Szeredi {
200bbb1e54dSMiklos Szeredi 	struct ovl_entry *oe = dentry->d_fsdata;
201bbb1e54dSMiklos Szeredi 
20209d8b586SMiklos Szeredi 	return oe->numlower ? oe->lowerstack[0].dentry : NULL;
203bbb1e54dSMiklos Szeredi }
204bbb1e54dSMiklos Szeredi 
20513464165SMiklos Szeredi const struct ovl_layer *ovl_layer_lower(struct dentry *dentry)
206da309e8cSAmir Goldstein {
207da309e8cSAmir Goldstein 	struct ovl_entry *oe = dentry->d_fsdata;
208da309e8cSAmir Goldstein 
209da309e8cSAmir Goldstein 	return oe->numlower ? oe->lowerstack[0].layer : NULL;
210da309e8cSAmir Goldstein }
211da309e8cSAmir Goldstein 
212647d253fSVivek Goyal /*
213647d253fSVivek Goyal  * ovl_dentry_lower() could return either a data dentry or metacopy dentry
214647d253fSVivek Goyal  * dependig on what is stored in lowerstack[0]. At times we need to find
215647d253fSVivek Goyal  * lower dentry which has data (and not metacopy dentry). This helper
216647d253fSVivek Goyal  * returns the lower data dentry.
217647d253fSVivek Goyal  */
218647d253fSVivek Goyal struct dentry *ovl_dentry_lowerdata(struct dentry *dentry)
219647d253fSVivek Goyal {
220647d253fSVivek Goyal 	struct ovl_entry *oe = dentry->d_fsdata;
221647d253fSVivek Goyal 
222647d253fSVivek Goyal 	return oe->numlower ? oe->lowerstack[oe->numlower - 1].dentry : NULL;
223647d253fSVivek Goyal }
224647d253fSVivek Goyal 
225bbb1e54dSMiklos Szeredi struct dentry *ovl_dentry_real(struct dentry *dentry)
226bbb1e54dSMiklos Szeredi {
22709d8b586SMiklos Szeredi 	return ovl_dentry_upper(dentry) ?: ovl_dentry_lower(dentry);
228bbb1e54dSMiklos Szeredi }
229bbb1e54dSMiklos Szeredi 
2301d88f183SMiklos Szeredi struct dentry *ovl_i_dentry_upper(struct inode *inode)
2311d88f183SMiklos Szeredi {
2321d88f183SMiklos Szeredi 	return ovl_upperdentry_dereference(OVL_I(inode));
2331d88f183SMiklos Szeredi }
2341d88f183SMiklos Szeredi 
23509d8b586SMiklos Szeredi struct inode *ovl_inode_upper(struct inode *inode)
23625b7713aSMiklos Szeredi {
2371d88f183SMiklos Szeredi 	struct dentry *upperdentry = ovl_i_dentry_upper(inode);
23825b7713aSMiklos Szeredi 
23909d8b586SMiklos Szeredi 	return upperdentry ? d_inode(upperdentry) : NULL;
24025b7713aSMiklos Szeredi }
24125b7713aSMiklos Szeredi 
24209d8b586SMiklos Szeredi struct inode *ovl_inode_lower(struct inode *inode)
24309d8b586SMiklos Szeredi {
24409d8b586SMiklos Szeredi 	return OVL_I(inode)->lower;
24509d8b586SMiklos Szeredi }
24609d8b586SMiklos Szeredi 
24709d8b586SMiklos Szeredi struct inode *ovl_inode_real(struct inode *inode)
24809d8b586SMiklos Szeredi {
24909d8b586SMiklos Szeredi 	return ovl_inode_upper(inode) ?: ovl_inode_lower(inode);
25009d8b586SMiklos Szeredi }
25109d8b586SMiklos Szeredi 
2522664bd08SVivek Goyal /* Return inode which contains lower data. Do not return metacopy */
2532664bd08SVivek Goyal struct inode *ovl_inode_lowerdata(struct inode *inode)
2542664bd08SVivek Goyal {
2552664bd08SVivek Goyal 	if (WARN_ON(!S_ISREG(inode->i_mode)))
2562664bd08SVivek Goyal 		return NULL;
2572664bd08SVivek Goyal 
2582664bd08SVivek Goyal 	return OVL_I(inode)->lowerdata ?: ovl_inode_lower(inode);
2592664bd08SVivek Goyal }
26009d8b586SMiklos Szeredi 
2614823d49cSVivek Goyal /* Return real inode which contains data. Does not return metacopy inode */
2624823d49cSVivek Goyal struct inode *ovl_inode_realdata(struct inode *inode)
2634823d49cSVivek Goyal {
2644823d49cSVivek Goyal 	struct inode *upperinode;
2654823d49cSVivek Goyal 
2664823d49cSVivek Goyal 	upperinode = ovl_inode_upper(inode);
2674823d49cSVivek Goyal 	if (upperinode && ovl_has_upperdata(inode))
2684823d49cSVivek Goyal 		return upperinode;
2694823d49cSVivek Goyal 
2704823d49cSVivek Goyal 	return ovl_inode_lowerdata(inode);
2714823d49cSVivek Goyal }
2724823d49cSVivek Goyal 
2734edb83bbSMiklos Szeredi struct ovl_dir_cache *ovl_dir_cache(struct inode *inode)
274bbb1e54dSMiklos Szeredi {
2754edb83bbSMiklos Szeredi 	return OVL_I(inode)->cache;
276bbb1e54dSMiklos Szeredi }
277bbb1e54dSMiklos Szeredi 
2784edb83bbSMiklos Szeredi void ovl_set_dir_cache(struct inode *inode, struct ovl_dir_cache *cache)
279bbb1e54dSMiklos Szeredi {
2804edb83bbSMiklos Szeredi 	OVL_I(inode)->cache = cache;
281bbb1e54dSMiklos Szeredi }
282bbb1e54dSMiklos Szeredi 
283c62520a8SAmir Goldstein void ovl_dentry_set_flag(unsigned long flag, struct dentry *dentry)
284c62520a8SAmir Goldstein {
285c62520a8SAmir Goldstein 	set_bit(flag, &OVL_E(dentry)->flags);
286c62520a8SAmir Goldstein }
287c62520a8SAmir Goldstein 
288c62520a8SAmir Goldstein void ovl_dentry_clear_flag(unsigned long flag, struct dentry *dentry)
289c62520a8SAmir Goldstein {
290c62520a8SAmir Goldstein 	clear_bit(flag, &OVL_E(dentry)->flags);
291c62520a8SAmir Goldstein }
292c62520a8SAmir Goldstein 
293c62520a8SAmir Goldstein bool ovl_dentry_test_flag(unsigned long flag, struct dentry *dentry)
294c62520a8SAmir Goldstein {
295c62520a8SAmir Goldstein 	return test_bit(flag, &OVL_E(dentry)->flags);
296c62520a8SAmir Goldstein }
297c62520a8SAmir Goldstein 
298bbb1e54dSMiklos Szeredi bool ovl_dentry_is_opaque(struct dentry *dentry)
299bbb1e54dSMiklos Szeredi {
300c62520a8SAmir Goldstein 	return ovl_dentry_test_flag(OVL_E_OPAQUE, dentry);
301bbb1e54dSMiklos Szeredi }
302bbb1e54dSMiklos Szeredi 
303bbb1e54dSMiklos Szeredi bool ovl_dentry_is_whiteout(struct dentry *dentry)
304bbb1e54dSMiklos Szeredi {
305bbb1e54dSMiklos Szeredi 	return !dentry->d_inode && ovl_dentry_is_opaque(dentry);
306bbb1e54dSMiklos Szeredi }
307bbb1e54dSMiklos Szeredi 
3085cf5b477SMiklos Szeredi void ovl_dentry_set_opaque(struct dentry *dentry)
309bbb1e54dSMiklos Szeredi {
310c62520a8SAmir Goldstein 	ovl_dentry_set_flag(OVL_E_OPAQUE, dentry);
311bbb1e54dSMiklos Szeredi }
312bbb1e54dSMiklos Szeredi 
31355acc661SMiklos Szeredi /*
314aa3ff3c1SAmir Goldstein  * For hard links and decoded file handles, it's possible for ovl_dentry_upper()
315aa3ff3c1SAmir Goldstein  * to return positive, while there's no actual upper alias for the inode.
316aa3ff3c1SAmir Goldstein  * Copy up code needs to know about the existence of the upper alias, so it
317aa3ff3c1SAmir Goldstein  * can't use ovl_dentry_upper().
31855acc661SMiklos Szeredi  */
31955acc661SMiklos Szeredi bool ovl_dentry_has_upper_alias(struct dentry *dentry)
32055acc661SMiklos Szeredi {
321c62520a8SAmir Goldstein 	return ovl_dentry_test_flag(OVL_E_UPPER_ALIAS, dentry);
32255acc661SMiklos Szeredi }
32355acc661SMiklos Szeredi 
32455acc661SMiklos Szeredi void ovl_dentry_set_upper_alias(struct dentry *dentry)
32555acc661SMiklos Szeredi {
326c62520a8SAmir Goldstein 	ovl_dentry_set_flag(OVL_E_UPPER_ALIAS, dentry);
32755acc661SMiklos Szeredi }
32855acc661SMiklos Szeredi 
3290c288874SVivek Goyal static bool ovl_should_check_upperdata(struct inode *inode)
3300c288874SVivek Goyal {
3310c288874SVivek Goyal 	if (!S_ISREG(inode->i_mode))
3320c288874SVivek Goyal 		return false;
3330c288874SVivek Goyal 
3340c288874SVivek Goyal 	if (!ovl_inode_lower(inode))
3350c288874SVivek Goyal 		return false;
3360c288874SVivek Goyal 
3370c288874SVivek Goyal 	return true;
3380c288874SVivek Goyal }
3390c288874SVivek Goyal 
3400c288874SVivek Goyal bool ovl_has_upperdata(struct inode *inode)
3410c288874SVivek Goyal {
3420c288874SVivek Goyal 	if (!ovl_should_check_upperdata(inode))
3430c288874SVivek Goyal 		return true;
3440c288874SVivek Goyal 
3450c288874SVivek Goyal 	if (!ovl_test_flag(OVL_UPPERDATA, inode))
3460c288874SVivek Goyal 		return false;
3470c288874SVivek Goyal 	/*
3480c288874SVivek Goyal 	 * Pairs with smp_wmb() in ovl_set_upperdata(). Main user of
3490c288874SVivek Goyal 	 * ovl_has_upperdata() is ovl_copy_up_meta_inode_data(). Make sure
3500c288874SVivek Goyal 	 * if setting of OVL_UPPERDATA is visible, then effects of writes
3510c288874SVivek Goyal 	 * before that are visible too.
3520c288874SVivek Goyal 	 */
3530c288874SVivek Goyal 	smp_rmb();
3540c288874SVivek Goyal 	return true;
3550c288874SVivek Goyal }
3560c288874SVivek Goyal 
3570c288874SVivek Goyal void ovl_set_upperdata(struct inode *inode)
3580c288874SVivek Goyal {
3590c288874SVivek Goyal 	/*
3600c288874SVivek Goyal 	 * Pairs with smp_rmb() in ovl_has_upperdata(). Make sure
3610c288874SVivek Goyal 	 * if OVL_UPPERDATA flag is visible, then effects of write operations
3620c288874SVivek Goyal 	 * before it are visible as well.
3630c288874SVivek Goyal 	 */
3640c288874SVivek Goyal 	smp_wmb();
3650c288874SVivek Goyal 	ovl_set_flag(OVL_UPPERDATA, inode);
3660c288874SVivek Goyal }
3670c288874SVivek Goyal 
3680c288874SVivek Goyal /* Caller should hold ovl_inode->lock */
3690c288874SVivek Goyal bool ovl_dentry_needs_data_copy_up_locked(struct dentry *dentry, int flags)
3700c288874SVivek Goyal {
3710c288874SVivek Goyal 	if (!ovl_open_flags_need_copy_up(flags))
3720c288874SVivek Goyal 		return false;
3730c288874SVivek Goyal 
3740c288874SVivek Goyal 	return !ovl_test_flag(OVL_UPPERDATA, d_inode(dentry));
3750c288874SVivek Goyal }
3760c288874SVivek Goyal 
3770c288874SVivek Goyal bool ovl_dentry_needs_data_copy_up(struct dentry *dentry, int flags)
3780c288874SVivek Goyal {
3790c288874SVivek Goyal 	if (!ovl_open_flags_need_copy_up(flags))
3800c288874SVivek Goyal 		return false;
3810c288874SVivek Goyal 
3820c288874SVivek Goyal 	return !ovl_has_upperdata(d_inode(dentry));
3830c288874SVivek Goyal }
3840c288874SVivek Goyal 
385a6c60655SMiklos Szeredi bool ovl_redirect_dir(struct super_block *sb)
386a6c60655SMiklos Szeredi {
387a6c60655SMiklos Szeredi 	struct ovl_fs *ofs = sb->s_fs_info;
388a6c60655SMiklos Szeredi 
38921a22878SAmir Goldstein 	return ofs->config.redirect_dir && !ofs->noxattr;
390a6c60655SMiklos Szeredi }
391a6c60655SMiklos Szeredi 
392a6c60655SMiklos Szeredi const char *ovl_dentry_get_redirect(struct dentry *dentry)
393a6c60655SMiklos Szeredi {
394cf31c463SMiklos Szeredi 	return OVL_I(d_inode(dentry))->redirect;
395a6c60655SMiklos Szeredi }
396a6c60655SMiklos Szeredi 
397a6c60655SMiklos Szeredi void ovl_dentry_set_redirect(struct dentry *dentry, const char *redirect)
398a6c60655SMiklos Szeredi {
399cf31c463SMiklos Szeredi 	struct ovl_inode *oi = OVL_I(d_inode(dentry));
400a6c60655SMiklos Szeredi 
401cf31c463SMiklos Szeredi 	kfree(oi->redirect);
402cf31c463SMiklos Szeredi 	oi->redirect = redirect;
403a6c60655SMiklos Szeredi }
404a6c60655SMiklos Szeredi 
40509d8b586SMiklos Szeredi void ovl_inode_update(struct inode *inode, struct dentry *upperdentry)
406bbb1e54dSMiklos Szeredi {
40709d8b586SMiklos Szeredi 	struct inode *upperinode = d_inode(upperdentry);
408e6d2ebddSMiklos Szeredi 
40909d8b586SMiklos Szeredi 	WARN_ON(OVL_I(inode)->__upperdentry);
41009d8b586SMiklos Szeredi 
41125b7713aSMiklos Szeredi 	/*
41209d8b586SMiklos Szeredi 	 * Make sure upperdentry is consistent before making it visible
41325b7713aSMiklos Szeredi 	 */
41425b7713aSMiklos Szeredi 	smp_wmb();
41509d8b586SMiklos Szeredi 	OVL_I(inode)->__upperdentry = upperdentry;
41631747edaSAmir Goldstein 	if (inode_unhashed(inode)) {
41725b7713aSMiklos Szeredi 		inode->i_private = upperinode;
418bbb1e54dSMiklos Szeredi 		__insert_inode_hash(inode, (unsigned long) upperinode);
419bbb1e54dSMiklos Szeredi 	}
42025b7713aSMiklos Szeredi }
421bbb1e54dSMiklos Szeredi 
422d9854c87SMiklos Szeredi static void ovl_dentry_version_inc(struct dentry *dentry, bool impurity)
423bbb1e54dSMiklos Szeredi {
42404a01ac7SMiklos Szeredi 	struct inode *inode = d_inode(dentry);
425bbb1e54dSMiklos Szeredi 
42604a01ac7SMiklos Szeredi 	WARN_ON(!inode_is_locked(inode));
4274edb83bbSMiklos Szeredi 	/*
4284edb83bbSMiklos Szeredi 	 * Version is used by readdir code to keep cache consistent.  For merge
4294edb83bbSMiklos Szeredi 	 * dirs all changes need to be noted.  For non-merge dirs, cache only
4304edb83bbSMiklos Szeredi 	 * contains impure (ones which have been copied up and have origins)
4314edb83bbSMiklos Szeredi 	 * entries, so only need to note changes to impure entries.
4324edb83bbSMiklos Szeredi 	 */
4334edb83bbSMiklos Szeredi 	if (OVL_TYPE_MERGE(ovl_path_type(dentry)) || impurity)
43404a01ac7SMiklos Szeredi 		OVL_I(inode)->version++;
435bbb1e54dSMiklos Szeredi }
436bbb1e54dSMiklos Szeredi 
437d9854c87SMiklos Szeredi void ovl_dir_modified(struct dentry *dentry, bool impurity)
438d9854c87SMiklos Szeredi {
439d9854c87SMiklos Szeredi 	/* Copy mtime/ctime */
440d9854c87SMiklos Szeredi 	ovl_copyattr(d_inode(ovl_dentry_upper(dentry)), d_inode(dentry));
441d9854c87SMiklos Szeredi 
442d9854c87SMiklos Szeredi 	ovl_dentry_version_inc(dentry, impurity);
443d9854c87SMiklos Szeredi }
444d9854c87SMiklos Szeredi 
445bbb1e54dSMiklos Szeredi u64 ovl_dentry_version_get(struct dentry *dentry)
446bbb1e54dSMiklos Szeredi {
44704a01ac7SMiklos Szeredi 	struct inode *inode = d_inode(dentry);
448bbb1e54dSMiklos Szeredi 
44904a01ac7SMiklos Szeredi 	WARN_ON(!inode_is_locked(inode));
45004a01ac7SMiklos Szeredi 	return OVL_I(inode)->version;
451bbb1e54dSMiklos Szeredi }
452bbb1e54dSMiklos Szeredi 
453bbb1e54dSMiklos Szeredi bool ovl_is_whiteout(struct dentry *dentry)
454bbb1e54dSMiklos Szeredi {
455bbb1e54dSMiklos Szeredi 	struct inode *inode = dentry->d_inode;
456bbb1e54dSMiklos Szeredi 
457bbb1e54dSMiklos Szeredi 	return inode && IS_WHITEOUT(inode);
458bbb1e54dSMiklos Szeredi }
459bbb1e54dSMiklos Szeredi 
460bbb1e54dSMiklos Szeredi struct file *ovl_path_open(struct path *path, int flags)
461bbb1e54dSMiklos Szeredi {
462bbb1e54dSMiklos Szeredi 	return dentry_open(path, flags | O_NOATIME, current_cred());
463bbb1e54dSMiklos Szeredi }
46439d3d60aSAmir Goldstein 
4650c288874SVivek Goyal /* Caller should hold ovl_inode->lock */
4660c288874SVivek Goyal static bool ovl_already_copied_up_locked(struct dentry *dentry, int flags)
4670c288874SVivek Goyal {
4680c288874SVivek Goyal 	bool disconnected = dentry->d_flags & DCACHE_DISCONNECTED;
4690c288874SVivek Goyal 
4700c288874SVivek Goyal 	if (ovl_dentry_upper(dentry) &&
4710c288874SVivek Goyal 	    (ovl_dentry_has_upper_alias(dentry) || disconnected) &&
4720c288874SVivek Goyal 	    !ovl_dentry_needs_data_copy_up_locked(dentry, flags))
4730c288874SVivek Goyal 		return true;
4740c288874SVivek Goyal 
4750c288874SVivek Goyal 	return false;
4760c288874SVivek Goyal }
4770c288874SVivek Goyal 
4780c288874SVivek Goyal bool ovl_already_copied_up(struct dentry *dentry, int flags)
4792002df85SVivek Goyal {
4802002df85SVivek Goyal 	bool disconnected = dentry->d_flags & DCACHE_DISCONNECTED;
4812002df85SVivek Goyal 
4822002df85SVivek Goyal 	/*
4832002df85SVivek Goyal 	 * Check if copy-up has happened as well as for upper alias (in
4842002df85SVivek Goyal 	 * case of hard links) is there.
4852002df85SVivek Goyal 	 *
4862002df85SVivek Goyal 	 * Both checks are lockless:
4872002df85SVivek Goyal 	 *  - false negatives: will recheck under oi->lock
4882002df85SVivek Goyal 	 *  - false positives:
4892002df85SVivek Goyal 	 *    + ovl_dentry_upper() uses memory barriers to ensure the
4902002df85SVivek Goyal 	 *      upper dentry is up-to-date
4912002df85SVivek Goyal 	 *    + ovl_dentry_has_upper_alias() relies on locking of
4922002df85SVivek Goyal 	 *      upper parent i_rwsem to prevent reordering copy-up
4932002df85SVivek Goyal 	 *      with rename.
4942002df85SVivek Goyal 	 */
4952002df85SVivek Goyal 	if (ovl_dentry_upper(dentry) &&
4960c288874SVivek Goyal 	    (ovl_dentry_has_upper_alias(dentry) || disconnected) &&
4970c288874SVivek Goyal 	    !ovl_dentry_needs_data_copy_up(dentry, flags))
4982002df85SVivek Goyal 		return true;
4992002df85SVivek Goyal 
5002002df85SVivek Goyal 	return false;
5012002df85SVivek Goyal }
5022002df85SVivek Goyal 
5030c288874SVivek Goyal int ovl_copy_up_start(struct dentry *dentry, int flags)
50439d3d60aSAmir Goldstein {
5051e92e307SAmir Goldstein 	struct inode *inode = d_inode(dentry);
50639d3d60aSAmir Goldstein 	int err;
50739d3d60aSAmir Goldstein 
508531d3040SAmir Goldstein 	err = ovl_inode_lock_interruptible(inode);
5090c288874SVivek Goyal 	if (!err && ovl_already_copied_up_locked(dentry, flags)) {
51039d3d60aSAmir Goldstein 		err = 1; /* Already copied up */
5111e92e307SAmir Goldstein 		ovl_inode_unlock(inode);
51239d3d60aSAmir Goldstein 	}
51339d3d60aSAmir Goldstein 
51439d3d60aSAmir Goldstein 	return err;
51539d3d60aSAmir Goldstein }
51639d3d60aSAmir Goldstein 
51739d3d60aSAmir Goldstein void ovl_copy_up_end(struct dentry *dentry)
51839d3d60aSAmir Goldstein {
5191e92e307SAmir Goldstein 	ovl_inode_unlock(d_inode(dentry));
52039d3d60aSAmir Goldstein }
52182b749b2SAmir Goldstein 
522b79e05aaSAmir Goldstein bool ovl_check_origin_xattr(struct dentry *dentry)
523b79e05aaSAmir Goldstein {
524b79e05aaSAmir Goldstein 	int res;
525b79e05aaSAmir Goldstein 
526b79e05aaSAmir Goldstein 	res = vfs_getxattr(dentry, OVL_XATTR_ORIGIN, NULL, 0);
527b79e05aaSAmir Goldstein 
528b79e05aaSAmir Goldstein 	/* Zero size value means "copied up but origin unknown" */
529b79e05aaSAmir Goldstein 	if (res >= 0)
530b79e05aaSAmir Goldstein 		return true;
531b79e05aaSAmir Goldstein 
532b79e05aaSAmir Goldstein 	return false;
533b79e05aaSAmir Goldstein }
534b79e05aaSAmir Goldstein 
535f3a15685SAmir Goldstein bool ovl_check_dir_xattr(struct dentry *dentry, const char *name)
536f3a15685SAmir Goldstein {
537f3a15685SAmir Goldstein 	int res;
538f3a15685SAmir Goldstein 	char val;
539f3a15685SAmir Goldstein 
540f3a15685SAmir Goldstein 	if (!d_is_dir(dentry))
541f3a15685SAmir Goldstein 		return false;
542f3a15685SAmir Goldstein 
543f3a15685SAmir Goldstein 	res = vfs_getxattr(dentry, name, &val, 1);
544f3a15685SAmir Goldstein 	if (res == 1 && val == 'y')
545f3a15685SAmir Goldstein 		return true;
546f3a15685SAmir Goldstein 
547f3a15685SAmir Goldstein 	return false;
548f3a15685SAmir Goldstein }
549f3a15685SAmir Goldstein 
55082b749b2SAmir Goldstein int ovl_check_setxattr(struct dentry *dentry, struct dentry *upperdentry,
55182b749b2SAmir Goldstein 		       const char *name, const void *value, size_t size,
55282b749b2SAmir Goldstein 		       int xerr)
55382b749b2SAmir Goldstein {
55482b749b2SAmir Goldstein 	int err;
55582b749b2SAmir Goldstein 	struct ovl_fs *ofs = dentry->d_sb->s_fs_info;
55682b749b2SAmir Goldstein 
55782b749b2SAmir Goldstein 	if (ofs->noxattr)
55882b749b2SAmir Goldstein 		return xerr;
55982b749b2SAmir Goldstein 
56082b749b2SAmir Goldstein 	err = ovl_do_setxattr(upperdentry, name, value, size, 0);
56182b749b2SAmir Goldstein 
56282b749b2SAmir Goldstein 	if (err == -EOPNOTSUPP) {
5631bd0a3aeSlijiazi 		pr_warn("cannot set %s xattr on upper\n", name);
56482b749b2SAmir Goldstein 		ofs->noxattr = true;
56582b749b2SAmir Goldstein 		return xerr;
56682b749b2SAmir Goldstein 	}
56782b749b2SAmir Goldstein 
56882b749b2SAmir Goldstein 	return err;
56982b749b2SAmir Goldstein }
570f3a15685SAmir Goldstein 
571f3a15685SAmir Goldstein int ovl_set_impure(struct dentry *dentry, struct dentry *upperdentry)
572f3a15685SAmir Goldstein {
573f3a15685SAmir Goldstein 	int err;
574f3a15685SAmir Goldstein 
57513c72075SMiklos Szeredi 	if (ovl_test_flag(OVL_IMPURE, d_inode(dentry)))
576f3a15685SAmir Goldstein 		return 0;
577f3a15685SAmir Goldstein 
578f3a15685SAmir Goldstein 	/*
579f3a15685SAmir Goldstein 	 * Do not fail when upper doesn't support xattrs.
580f3a15685SAmir Goldstein 	 * Upper inodes won't have origin nor redirect xattr anyway.
581f3a15685SAmir Goldstein 	 */
582f3a15685SAmir Goldstein 	err = ovl_check_setxattr(dentry, upperdentry, OVL_XATTR_IMPURE,
583f3a15685SAmir Goldstein 				 "y", 1, 0);
584f3a15685SAmir Goldstein 	if (!err)
58513c72075SMiklos Szeredi 		ovl_set_flag(OVL_IMPURE, d_inode(dentry));
586f3a15685SAmir Goldstein 
587f3a15685SAmir Goldstein 	return err;
588f3a15685SAmir Goldstein }
58913c72075SMiklos Szeredi 
59013c72075SMiklos Szeredi void ovl_set_flag(unsigned long flag, struct inode *inode)
59113c72075SMiklos Szeredi {
59213c72075SMiklos Szeredi 	set_bit(flag, &OVL_I(inode)->flags);
59313c72075SMiklos Szeredi }
59413c72075SMiklos Szeredi 
5954edb83bbSMiklos Szeredi void ovl_clear_flag(unsigned long flag, struct inode *inode)
5964edb83bbSMiklos Szeredi {
5974edb83bbSMiklos Szeredi 	clear_bit(flag, &OVL_I(inode)->flags);
5984edb83bbSMiklos Szeredi }
5994edb83bbSMiklos Szeredi 
60013c72075SMiklos Szeredi bool ovl_test_flag(unsigned long flag, struct inode *inode)
60113c72075SMiklos Szeredi {
60213c72075SMiklos Szeredi 	return test_bit(flag, &OVL_I(inode)->flags);
60313c72075SMiklos Szeredi }
604ad0af710SAmir Goldstein 
605ad0af710SAmir Goldstein /**
606ad0af710SAmir Goldstein  * Caller must hold a reference to inode to prevent it from being freed while
607ad0af710SAmir Goldstein  * it is marked inuse.
608ad0af710SAmir Goldstein  */
609ad0af710SAmir Goldstein bool ovl_inuse_trylock(struct dentry *dentry)
610ad0af710SAmir Goldstein {
611ad0af710SAmir Goldstein 	struct inode *inode = d_inode(dentry);
612ad0af710SAmir Goldstein 	bool locked = false;
613ad0af710SAmir Goldstein 
614ad0af710SAmir Goldstein 	spin_lock(&inode->i_lock);
615ad0af710SAmir Goldstein 	if (!(inode->i_state & I_OVL_INUSE)) {
616ad0af710SAmir Goldstein 		inode->i_state |= I_OVL_INUSE;
617ad0af710SAmir Goldstein 		locked = true;
618ad0af710SAmir Goldstein 	}
619ad0af710SAmir Goldstein 	spin_unlock(&inode->i_lock);
620ad0af710SAmir Goldstein 
621ad0af710SAmir Goldstein 	return locked;
622ad0af710SAmir Goldstein }
623ad0af710SAmir Goldstein 
624ad0af710SAmir Goldstein void ovl_inuse_unlock(struct dentry *dentry)
625ad0af710SAmir Goldstein {
626ad0af710SAmir Goldstein 	if (dentry) {
627ad0af710SAmir Goldstein 		struct inode *inode = d_inode(dentry);
628ad0af710SAmir Goldstein 
629ad0af710SAmir Goldstein 		spin_lock(&inode->i_lock);
630ad0af710SAmir Goldstein 		WARN_ON(!(inode->i_state & I_OVL_INUSE));
631ad0af710SAmir Goldstein 		inode->i_state &= ~I_OVL_INUSE;
632ad0af710SAmir Goldstein 		spin_unlock(&inode->i_lock);
633ad0af710SAmir Goldstein 	}
634ad0af710SAmir Goldstein }
6355f8415d6SAmir Goldstein 
636146d62e5SAmir Goldstein bool ovl_is_inuse(struct dentry *dentry)
637146d62e5SAmir Goldstein {
638146d62e5SAmir Goldstein 	struct inode *inode = d_inode(dentry);
639146d62e5SAmir Goldstein 	bool inuse;
640146d62e5SAmir Goldstein 
641146d62e5SAmir Goldstein 	spin_lock(&inode->i_lock);
642146d62e5SAmir Goldstein 	inuse = (inode->i_state & I_OVL_INUSE);
643146d62e5SAmir Goldstein 	spin_unlock(&inode->i_lock);
644146d62e5SAmir Goldstein 
645146d62e5SAmir Goldstein 	return inuse;
646146d62e5SAmir Goldstein }
647146d62e5SAmir Goldstein 
64824b33ee1SAmir Goldstein /*
64924b33ee1SAmir Goldstein  * Does this overlay dentry need to be indexed on copy up?
65024b33ee1SAmir Goldstein  */
65124b33ee1SAmir Goldstein bool ovl_need_index(struct dentry *dentry)
65224b33ee1SAmir Goldstein {
65324b33ee1SAmir Goldstein 	struct dentry *lower = ovl_dentry_lower(dentry);
65424b33ee1SAmir Goldstein 
65524b33ee1SAmir Goldstein 	if (!lower || !ovl_indexdir(dentry->d_sb))
65624b33ee1SAmir Goldstein 		return false;
65724b33ee1SAmir Goldstein 
658fbd2d207SAmir Goldstein 	/* Index all files for NFS export and consistency verification */
659016b720fSAmir Goldstein 	if (ovl_index_all(dentry->d_sb))
660fbd2d207SAmir Goldstein 		return true;
661fbd2d207SAmir Goldstein 
66224b33ee1SAmir Goldstein 	/* Index only lower hardlinks on copy up */
66324b33ee1SAmir Goldstein 	if (!d_is_dir(lower) && d_inode(lower)->i_nlink > 1)
66424b33ee1SAmir Goldstein 		return true;
66524b33ee1SAmir Goldstein 
66624b33ee1SAmir Goldstein 	return false;
66724b33ee1SAmir Goldstein }
66824b33ee1SAmir Goldstein 
6699f4ec904SAmir Goldstein /* Caller must hold OVL_I(inode)->lock */
670caf70cb2SAmir Goldstein static void ovl_cleanup_index(struct dentry *dentry)
671caf70cb2SAmir Goldstein {
672e7dd0e71SAmir Goldstein 	struct dentry *indexdir = ovl_indexdir(dentry->d_sb);
673e7dd0e71SAmir Goldstein 	struct inode *dir = indexdir->d_inode;
674caf70cb2SAmir Goldstein 	struct dentry *lowerdentry = ovl_dentry_lower(dentry);
675caf70cb2SAmir Goldstein 	struct dentry *upperdentry = ovl_dentry_upper(dentry);
676caf70cb2SAmir Goldstein 	struct dentry *index = NULL;
677caf70cb2SAmir Goldstein 	struct inode *inode;
67863e13252SAmir Goldstein 	struct qstr name = { };
679caf70cb2SAmir Goldstein 	int err;
680caf70cb2SAmir Goldstein 
681caf70cb2SAmir Goldstein 	err = ovl_get_index_name(lowerdentry, &name);
682caf70cb2SAmir Goldstein 	if (err)
683caf70cb2SAmir Goldstein 		goto fail;
684caf70cb2SAmir Goldstein 
685caf70cb2SAmir Goldstein 	inode = d_inode(upperdentry);
68689a17556SAmir Goldstein 	if (!S_ISDIR(inode->i_mode) && inode->i_nlink != 1) {
6871bd0a3aeSlijiazi 		pr_warn_ratelimited("cleanup linked index (%pd2, ino=%lu, nlink=%u)\n",
688caf70cb2SAmir Goldstein 				    upperdentry, inode->i_ino, inode->i_nlink);
689caf70cb2SAmir Goldstein 		/*
690caf70cb2SAmir Goldstein 		 * We either have a bug with persistent union nlink or a lower
691caf70cb2SAmir Goldstein 		 * hardlink was added while overlay is mounted. Adding a lower
692caf70cb2SAmir Goldstein 		 * hardlink and then unlinking all overlay hardlinks would drop
693caf70cb2SAmir Goldstein 		 * overlay nlink to zero before all upper inodes are unlinked.
694caf70cb2SAmir Goldstein 		 * As a safety measure, when that situation is detected, set
695caf70cb2SAmir Goldstein 		 * the overlay nlink to the index inode nlink minus one for the
696caf70cb2SAmir Goldstein 		 * index entry itself.
697caf70cb2SAmir Goldstein 		 */
698caf70cb2SAmir Goldstein 		set_nlink(d_inode(dentry), inode->i_nlink - 1);
699caf70cb2SAmir Goldstein 		ovl_set_nlink_upper(dentry);
700caf70cb2SAmir Goldstein 		goto out;
701caf70cb2SAmir Goldstein 	}
702caf70cb2SAmir Goldstein 
703caf70cb2SAmir Goldstein 	inode_lock_nested(dir, I_MUTEX_PARENT);
704e7dd0e71SAmir Goldstein 	index = lookup_one_len(name.name, indexdir, name.len);
705caf70cb2SAmir Goldstein 	err = PTR_ERR(index);
706e7dd0e71SAmir Goldstein 	if (IS_ERR(index)) {
7079f4ec904SAmir Goldstein 		index = NULL;
708e7dd0e71SAmir Goldstein 	} else if (ovl_index_all(dentry->d_sb)) {
709e7dd0e71SAmir Goldstein 		/* Whiteout orphan index to block future open by handle */
710e7dd0e71SAmir Goldstein 		err = ovl_cleanup_and_whiteout(indexdir, dir, index);
711e7dd0e71SAmir Goldstein 	} else {
712e7dd0e71SAmir Goldstein 		/* Cleanup orphan index entries */
713e7dd0e71SAmir Goldstein 		err = ovl_cleanup(dir, index);
714e7dd0e71SAmir Goldstein 	}
7159f4ec904SAmir Goldstein 
716caf70cb2SAmir Goldstein 	inode_unlock(dir);
717caf70cb2SAmir Goldstein 	if (err)
718caf70cb2SAmir Goldstein 		goto fail;
719caf70cb2SAmir Goldstein 
720caf70cb2SAmir Goldstein out:
72163e13252SAmir Goldstein 	kfree(name.name);
722caf70cb2SAmir Goldstein 	dput(index);
723caf70cb2SAmir Goldstein 	return;
724caf70cb2SAmir Goldstein 
725caf70cb2SAmir Goldstein fail:
7261bd0a3aeSlijiazi 	pr_err("cleanup index of '%pd2' failed (%i)\n", dentry, err);
727caf70cb2SAmir Goldstein 	goto out;
728caf70cb2SAmir Goldstein }
729caf70cb2SAmir Goldstein 
7305f8415d6SAmir Goldstein /*
7315f8415d6SAmir Goldstein  * Operations that change overlay inode and upper inode nlink need to be
7325f8415d6SAmir Goldstein  * synchronized with copy up for persistent nlink accounting.
7335f8415d6SAmir Goldstein  */
7340e32992fSAmir Goldstein int ovl_nlink_start(struct dentry *dentry)
7355f8415d6SAmir Goldstein {
7361e92e307SAmir Goldstein 	struct inode *inode = d_inode(dentry);
7375f8415d6SAmir Goldstein 	const struct cred *old_cred;
7385f8415d6SAmir Goldstein 	int err;
7395f8415d6SAmir Goldstein 
7401e92e307SAmir Goldstein 	if (WARN_ON(!inode))
7410e32992fSAmir Goldstein 		return -ENOENT;
7425f8415d6SAmir Goldstein 
7435f8415d6SAmir Goldstein 	/*
7445f8415d6SAmir Goldstein 	 * With inodes index is enabled, we store the union overlay nlink
74524b33ee1SAmir Goldstein 	 * in an xattr on the index inode. When whiting out an indexed lower,
7465f8415d6SAmir Goldstein 	 * we need to decrement the overlay persistent nlink, but before the
7475f8415d6SAmir Goldstein 	 * first copy up, we have no upper index inode to store the xattr.
7485f8415d6SAmir Goldstein 	 *
74924b33ee1SAmir Goldstein 	 * As a workaround, before whiteout/rename over an indexed lower,
7505f8415d6SAmir Goldstein 	 * copy up to create the upper index. Creating the upper index will
7515f8415d6SAmir Goldstein 	 * initialize the overlay nlink, so it could be dropped if unlink
7525f8415d6SAmir Goldstein 	 * or rename succeeds.
7535f8415d6SAmir Goldstein 	 *
7545f8415d6SAmir Goldstein 	 * TODO: implement metadata only index copy up when called with
7555f8415d6SAmir Goldstein 	 *       ovl_copy_up_flags(dentry, O_PATH).
7565f8415d6SAmir Goldstein 	 */
75724b33ee1SAmir Goldstein 	if (ovl_need_index(dentry) && !ovl_dentry_has_upper_alias(dentry)) {
7585f8415d6SAmir Goldstein 		err = ovl_copy_up(dentry);
7595f8415d6SAmir Goldstein 		if (err)
7605f8415d6SAmir Goldstein 			return err;
7615f8415d6SAmir Goldstein 	}
7625f8415d6SAmir Goldstein 
763531d3040SAmir Goldstein 	err = ovl_inode_lock_interruptible(inode);
7645f8415d6SAmir Goldstein 	if (err)
7655f8415d6SAmir Goldstein 		return err;
7665f8415d6SAmir Goldstein 
7671e92e307SAmir Goldstein 	if (d_is_dir(dentry) || !ovl_test_flag(OVL_INDEX, inode))
7685f8415d6SAmir Goldstein 		goto out;
7695f8415d6SAmir Goldstein 
7705f8415d6SAmir Goldstein 	old_cred = ovl_override_creds(dentry->d_sb);
7715f8415d6SAmir Goldstein 	/*
7725f8415d6SAmir Goldstein 	 * The overlay inode nlink should be incremented/decremented IFF the
7735f8415d6SAmir Goldstein 	 * upper operation succeeds, along with nlink change of upper inode.
7745f8415d6SAmir Goldstein 	 * Therefore, before link/unlink/rename, we store the union nlink
7755f8415d6SAmir Goldstein 	 * value relative to the upper inode nlink in an upper inode xattr.
7765f8415d6SAmir Goldstein 	 */
7775f8415d6SAmir Goldstein 	err = ovl_set_nlink_upper(dentry);
7785f8415d6SAmir Goldstein 	revert_creds(old_cred);
7795f8415d6SAmir Goldstein 
7805f8415d6SAmir Goldstein out:
7815f8415d6SAmir Goldstein 	if (err)
7821e92e307SAmir Goldstein 		ovl_inode_unlock(inode);
7835f8415d6SAmir Goldstein 
7845f8415d6SAmir Goldstein 	return err;
7855f8415d6SAmir Goldstein }
7865f8415d6SAmir Goldstein 
7870e32992fSAmir Goldstein void ovl_nlink_end(struct dentry *dentry)
7885f8415d6SAmir Goldstein {
7891e92e307SAmir Goldstein 	struct inode *inode = d_inode(dentry);
7901e92e307SAmir Goldstein 
7911e92e307SAmir Goldstein 	if (ovl_test_flag(OVL_INDEX, inode) && inode->i_nlink == 0) {
792caf70cb2SAmir Goldstein 		const struct cred *old_cred;
793caf70cb2SAmir Goldstein 
794caf70cb2SAmir Goldstein 		old_cred = ovl_override_creds(dentry->d_sb);
795caf70cb2SAmir Goldstein 		ovl_cleanup_index(dentry);
796caf70cb2SAmir Goldstein 		revert_creds(old_cred);
797caf70cb2SAmir Goldstein 	}
798caf70cb2SAmir Goldstein 
7991e92e307SAmir Goldstein 	ovl_inode_unlock(inode);
8005f8415d6SAmir Goldstein }
8015820dc08SAmir Goldstein 
8025820dc08SAmir Goldstein int ovl_lock_rename_workdir(struct dentry *workdir, struct dentry *upperdir)
8035820dc08SAmir Goldstein {
8045820dc08SAmir Goldstein 	/* Workdir should not be the same as upperdir */
8055820dc08SAmir Goldstein 	if (workdir == upperdir)
8065820dc08SAmir Goldstein 		goto err;
8075820dc08SAmir Goldstein 
8085820dc08SAmir Goldstein 	/* Workdir should not be subdir of upperdir and vice versa */
8095820dc08SAmir Goldstein 	if (lock_rename(workdir, upperdir) != NULL)
8105820dc08SAmir Goldstein 		goto err_unlock;
8115820dc08SAmir Goldstein 
8125820dc08SAmir Goldstein 	return 0;
8135820dc08SAmir Goldstein 
8145820dc08SAmir Goldstein err_unlock:
8155820dc08SAmir Goldstein 	unlock_rename(workdir, upperdir);
8165820dc08SAmir Goldstein err:
8171bd0a3aeSlijiazi 	pr_err("failed to lock workdir+upperdir\n");
8185820dc08SAmir Goldstein 	return -EIO;
8195820dc08SAmir Goldstein }
8209d3dfea3SVivek Goyal 
8219d3dfea3SVivek Goyal /* err < 0, 0 if no metacopy xattr, 1 if metacopy xattr found */
8229d3dfea3SVivek Goyal int ovl_check_metacopy_xattr(struct dentry *dentry)
8239d3dfea3SVivek Goyal {
8249d3dfea3SVivek Goyal 	int res;
8259d3dfea3SVivek Goyal 
8269d3dfea3SVivek Goyal 	/* Only regular files can have metacopy xattr */
8279d3dfea3SVivek Goyal 	if (!S_ISREG(d_inode(dentry)->i_mode))
8289d3dfea3SVivek Goyal 		return 0;
8299d3dfea3SVivek Goyal 
8309d3dfea3SVivek Goyal 	res = vfs_getxattr(dentry, OVL_XATTR_METACOPY, NULL, 0);
8319d3dfea3SVivek Goyal 	if (res < 0) {
8329d3dfea3SVivek Goyal 		if (res == -ENODATA || res == -EOPNOTSUPP)
8339d3dfea3SVivek Goyal 			return 0;
8349d3dfea3SVivek Goyal 		goto out;
8359d3dfea3SVivek Goyal 	}
8369d3dfea3SVivek Goyal 
8379d3dfea3SVivek Goyal 	return 1;
8389d3dfea3SVivek Goyal out:
8391bd0a3aeSlijiazi 	pr_warn_ratelimited("failed to get metacopy (%i)\n", res);
8409d3dfea3SVivek Goyal 	return res;
8419d3dfea3SVivek Goyal }
84267d756c2SVivek Goyal 
84367d756c2SVivek Goyal bool ovl_is_metacopy_dentry(struct dentry *dentry)
84467d756c2SVivek Goyal {
84567d756c2SVivek Goyal 	struct ovl_entry *oe = dentry->d_fsdata;
84667d756c2SVivek Goyal 
84767d756c2SVivek Goyal 	if (!d_is_reg(dentry))
84867d756c2SVivek Goyal 		return false;
84967d756c2SVivek Goyal 
85067d756c2SVivek Goyal 	if (ovl_dentry_upper(dentry)) {
85167d756c2SVivek Goyal 		if (!ovl_has_upperdata(d_inode(dentry)))
85267d756c2SVivek Goyal 			return true;
85367d756c2SVivek Goyal 		return false;
85467d756c2SVivek Goyal 	}
85567d756c2SVivek Goyal 
85667d756c2SVivek Goyal 	return (oe->numlower > 1);
85767d756c2SVivek Goyal }
8580a2d0d3fSVivek Goyal 
859993a0b2aSVivek Goyal ssize_t ovl_getxattr(struct dentry *dentry, char *name, char **value,
860993a0b2aSVivek Goyal 		     size_t padding)
861993a0b2aSVivek Goyal {
862993a0b2aSVivek Goyal 	ssize_t res;
863993a0b2aSVivek Goyal 	char *buf = NULL;
864993a0b2aSVivek Goyal 
865993a0b2aSVivek Goyal 	res = vfs_getxattr(dentry, name, NULL, 0);
866993a0b2aSVivek Goyal 	if (res < 0) {
867993a0b2aSVivek Goyal 		if (res == -ENODATA || res == -EOPNOTSUPP)
868993a0b2aSVivek Goyal 			return -ENODATA;
869993a0b2aSVivek Goyal 		goto fail;
870993a0b2aSVivek Goyal 	}
871993a0b2aSVivek Goyal 
872993a0b2aSVivek Goyal 	if (res != 0) {
873993a0b2aSVivek Goyal 		buf = kzalloc(res + padding, GFP_KERNEL);
874993a0b2aSVivek Goyal 		if (!buf)
875993a0b2aSVivek Goyal 			return -ENOMEM;
876993a0b2aSVivek Goyal 
877993a0b2aSVivek Goyal 		res = vfs_getxattr(dentry, name, buf, res);
878993a0b2aSVivek Goyal 		if (res < 0)
879993a0b2aSVivek Goyal 			goto fail;
880993a0b2aSVivek Goyal 	}
881993a0b2aSVivek Goyal 	*value = buf;
882993a0b2aSVivek Goyal 
883993a0b2aSVivek Goyal 	return res;
884993a0b2aSVivek Goyal 
885993a0b2aSVivek Goyal fail:
8861bd0a3aeSlijiazi 	pr_warn_ratelimited("failed to get xattr %s: err=%zi)\n",
887993a0b2aSVivek Goyal 			    name, res);
888993a0b2aSVivek Goyal 	kfree(buf);
889993a0b2aSVivek Goyal 	return res;
890993a0b2aSVivek Goyal }
891993a0b2aSVivek Goyal 
8920a2d0d3fSVivek Goyal char *ovl_get_redirect_xattr(struct dentry *dentry, int padding)
8930a2d0d3fSVivek Goyal {
8940a2d0d3fSVivek Goyal 	int res;
8950a2d0d3fSVivek Goyal 	char *s, *next, *buf = NULL;
8960a2d0d3fSVivek Goyal 
897993a0b2aSVivek Goyal 	res = ovl_getxattr(dentry, OVL_XATTR_REDIRECT, &buf, padding + 1);
898993a0b2aSVivek Goyal 	if (res == -ENODATA)
8990a2d0d3fSVivek Goyal 		return NULL;
9000a2d0d3fSVivek Goyal 	if (res < 0)
901993a0b2aSVivek Goyal 		return ERR_PTR(res);
9020a2d0d3fSVivek Goyal 	if (res == 0)
9030a2d0d3fSVivek Goyal 		goto invalid;
9040a2d0d3fSVivek Goyal 
9050a2d0d3fSVivek Goyal 	if (buf[0] == '/') {
9060a2d0d3fSVivek Goyal 		for (s = buf; *s++ == '/'; s = next) {
9070a2d0d3fSVivek Goyal 			next = strchrnul(s, '/');
9080a2d0d3fSVivek Goyal 			if (s == next)
9090a2d0d3fSVivek Goyal 				goto invalid;
9100a2d0d3fSVivek Goyal 		}
9110a2d0d3fSVivek Goyal 	} else {
9120a2d0d3fSVivek Goyal 		if (strchr(buf, '/') != NULL)
9130a2d0d3fSVivek Goyal 			goto invalid;
9140a2d0d3fSVivek Goyal 	}
9150a2d0d3fSVivek Goyal 
9160a2d0d3fSVivek Goyal 	return buf;
9170a2d0d3fSVivek Goyal invalid:
9181bd0a3aeSlijiazi 	pr_warn_ratelimited("invalid redirect (%s)\n", buf);
9190a2d0d3fSVivek Goyal 	res = -EINVAL;
920993a0b2aSVivek Goyal 	kfree(buf);
921993a0b2aSVivek Goyal 	return ERR_PTR(res);
9220a2d0d3fSVivek Goyal }
923