blob: db8bdb29b3207ee74fad9a29029be59e64152061 [file] [log] [blame]
Miklos Szeredibbb1e542016-12-16 11:02:56 +01001/*
2 * Copyright (C) 2011 Novell Inc.
3 * Copyright (C) 2016 Red Hat, Inc.
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 as published by
7 * the Free Software Foundation.
8 */
9
10#include <linux/fs.h>
11#include <linux/mount.h>
12#include <linux/slab.h>
Ingo Molnar5b825c32017-02-02 17:54:15 +010013#include <linux/cred.h>
Miklos Szeredibbb1e542016-12-16 11:02:56 +010014#include <linux/xattr.h>
Amir Goldstein02bcd152017-06-21 15:28:36 +030015#include <linux/exportfs.h>
16#include <linux/uuid.h>
Amir Goldsteincaf70cb2017-06-21 13:46:12 +030017#include <linux/namei.h>
18#include <linux/ratelimit.h>
Miklos Szeredibbb1e542016-12-16 11:02:56 +010019#include "overlayfs.h"
Miklos Szeredibbb1e542016-12-16 11:02:56 +010020
21int ovl_want_write(struct dentry *dentry)
22{
23 struct ovl_fs *ofs = dentry->d_sb->s_fs_info;
24 return mnt_want_write(ofs->upper_mnt);
25}
26
27void ovl_drop_write(struct dentry *dentry)
28{
29 struct ovl_fs *ofs = dentry->d_sb->s_fs_info;
30 mnt_drop_write(ofs->upper_mnt);
31}
32
33struct dentry *ovl_workdir(struct dentry *dentry)
34{
35 struct ovl_fs *ofs = dentry->d_sb->s_fs_info;
36 return ofs->workdir;
37}
38
39const struct cred *ovl_override_creds(struct super_block *sb)
40{
41 struct ovl_fs *ofs = sb->s_fs_info;
42
43 return override_creds(ofs->creator_cred);
44}
45
Amir Goldstein7bcd74b2017-03-22 08:42:21 -040046struct super_block *ovl_same_sb(struct super_block *sb)
47{
48 struct ovl_fs *ofs = sb->s_fs_info;
49
Amir Goldstein51486262018-03-28 20:22:41 +030050 if (!ofs->numlowerfs)
51 return ofs->upper_mnt->mnt_sb;
52 else if (ofs->numlowerfs == 1 && !ofs->upper_mnt)
53 return ofs->lower_fs[0].sb;
54 else
55 return NULL;
Amir Goldstein7bcd74b2017-03-22 08:42:21 -040056}
57
Amir Goldsteine487d882017-11-07 13:55:04 +020058/*
59 * Check if underlying fs supports file handles and try to determine encoding
60 * type, in order to deduce maximum inode number used by fs.
61 *
62 * Return 0 if file handles are not supported.
63 * Return 1 (FILEID_INO32_GEN) if fs uses the default 32bit inode encoding.
64 * Return -1 if fs uses a non default encoding with unknown inode size.
65 */
66int ovl_can_decode_fh(struct super_block *sb)
Amir Goldstein02bcd152017-06-21 15:28:36 +030067{
Amir Goldsteine487d882017-11-07 13:55:04 +020068 if (!sb->s_export_op || !sb->s_export_op->fh_to_dentry ||
69 uuid_is_null(&sb->s_uuid))
70 return 0;
71
72 return sb->s_export_op->encode_fh ? -1 : FILEID_INO32_GEN;
Amir Goldstein02bcd152017-06-21 15:28:36 +030073}
74
75struct dentry *ovl_indexdir(struct super_block *sb)
76{
77 struct ovl_fs *ofs = sb->s_fs_info;
78
79 return ofs->indexdir;
80}
81
Amir Goldsteinf168f102018-01-19 11:26:53 +020082/* Index all files on copy up. For now only enabled for NFS export */
83bool ovl_index_all(struct super_block *sb)
84{
85 struct ovl_fs *ofs = sb->s_fs_info;
86
87 return ofs->config.nfs_export && ofs->config.index;
88}
89
90/* Verify lower origin on lookup. For now only enabled for NFS export */
91bool ovl_verify_lower(struct super_block *sb)
92{
93 struct ovl_fs *ofs = sb->s_fs_info;
94
95 return ofs->config.nfs_export && ofs->config.index;
96}
97
Miklos Szeredibbb1e542016-12-16 11:02:56 +010098struct ovl_entry *ovl_alloc_entry(unsigned int numlower)
99{
100 size_t size = offsetof(struct ovl_entry, lowerstack[numlower]);
101 struct ovl_entry *oe = kzalloc(size, GFP_KERNEL);
102
103 if (oe)
104 oe->numlower = numlower;
105
106 return oe;
107}
108
109bool ovl_dentry_remote(struct dentry *dentry)
110{
111 return dentry->d_flags &
112 (DCACHE_OP_REVALIDATE | DCACHE_OP_WEAK_REVALIDATE |
113 DCACHE_OP_REAL);
114}
115
116bool ovl_dentry_weird(struct dentry *dentry)
117{
118 return dentry->d_flags & (DCACHE_NEED_AUTOMOUNT |
119 DCACHE_MANAGE_TRANSIT |
120 DCACHE_OP_HASH |
121 DCACHE_OP_COMPARE);
122}
123
124enum ovl_path_type ovl_path_type(struct dentry *dentry)
125{
126 struct ovl_entry *oe = dentry->d_fsdata;
127 enum ovl_path_type type = 0;
128
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200129 if (ovl_dentry_upper(dentry)) {
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100130 type = __OVL_PATH_UPPER;
131
132 /*
Amir Goldstein59548502017-04-23 23:12:34 +0300133 * Non-dir dentry can hold lower dentry of its copy up origin.
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100134 */
Amir Goldstein59548502017-04-23 23:12:34 +0300135 if (oe->numlower) {
Vivek Goyal60124872018-05-11 11:49:32 -0400136 if (ovl_test_flag(OVL_CONST_INO, d_inode(dentry)))
137 type |= __OVL_PATH_ORIGIN;
Vivek Goyal0b17c282018-05-11 11:49:32 -0400138 if (d_is_dir(dentry) ||
139 !ovl_has_upperdata(d_inode(dentry)))
Amir Goldstein59548502017-04-23 23:12:34 +0300140 type |= __OVL_PATH_MERGE;
141 }
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100142 } else {
143 if (oe->numlower > 1)
144 type |= __OVL_PATH_MERGE;
145 }
146 return type;
147}
148
149void ovl_path_upper(struct dentry *dentry, struct path *path)
150{
151 struct ovl_fs *ofs = dentry->d_sb->s_fs_info;
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100152
153 path->mnt = ofs->upper_mnt;
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200154 path->dentry = ovl_dentry_upper(dentry);
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100155}
156
157void ovl_path_lower(struct dentry *dentry, struct path *path)
158{
159 struct ovl_entry *oe = dentry->d_fsdata;
160
Chandan Rajendrab9343632017-07-24 01:57:54 -0500161 if (oe->numlower) {
162 path->mnt = oe->lowerstack[0].layer->mnt;
163 path->dentry = oe->lowerstack[0].dentry;
164 } else {
165 *path = (struct path) { };
166 }
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100167}
168
Vivek Goyal4f93b422018-05-11 11:49:30 -0400169void ovl_path_lowerdata(struct dentry *dentry, struct path *path)
170{
171 struct ovl_entry *oe = dentry->d_fsdata;
172
173 if (oe->numlower) {
174 path->mnt = oe->lowerstack[oe->numlower - 1].layer->mnt;
175 path->dentry = oe->lowerstack[oe->numlower - 1].dentry;
176 } else {
177 *path = (struct path) { };
178 }
179}
180
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100181enum ovl_path_type ovl_path_real(struct dentry *dentry, struct path *path)
182{
183 enum ovl_path_type type = ovl_path_type(dentry);
184
185 if (!OVL_TYPE_UPPER(type))
186 ovl_path_lower(dentry, path);
187 else
188 ovl_path_upper(dentry, path);
189
190 return type;
191}
192
193struct dentry *ovl_dentry_upper(struct dentry *dentry)
194{
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200195 return ovl_upperdentry_dereference(OVL_I(d_inode(dentry)));
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100196}
197
198struct dentry *ovl_dentry_lower(struct dentry *dentry)
199{
200 struct ovl_entry *oe = dentry->d_fsdata;
201
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200202 return oe->numlower ? oe->lowerstack[0].dentry : NULL;
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100203}
204
Amir Goldsteinda309e82017-11-08 19:39:51 +0200205struct ovl_layer *ovl_layer_lower(struct dentry *dentry)
206{
207 struct ovl_entry *oe = dentry->d_fsdata;
208
209 return oe->numlower ? oe->lowerstack[0].layer : NULL;
210}
211
Vivek Goyal647d2532018-05-11 11:49:30 -0400212/*
213 * ovl_dentry_lower() could return either a data dentry or metacopy dentry
214 * dependig on what is stored in lowerstack[0]. At times we need to find
215 * lower dentry which has data (and not metacopy dentry). This helper
216 * returns the lower data dentry.
217 */
218struct dentry *ovl_dentry_lowerdata(struct dentry *dentry)
219{
220 struct ovl_entry *oe = dentry->d_fsdata;
221
222 return oe->numlower ? oe->lowerstack[oe->numlower - 1].dentry : NULL;
223}
224
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100225struct dentry *ovl_dentry_real(struct dentry *dentry)
226{
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200227 return ovl_dentry_upper(dentry) ?: ovl_dentry_lower(dentry);
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100228}
229
Miklos Szeredi1d88f182017-07-20 11:08:21 +0200230struct dentry *ovl_i_dentry_upper(struct inode *inode)
231{
232 return ovl_upperdentry_dereference(OVL_I(inode));
233}
234
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200235struct inode *ovl_inode_upper(struct inode *inode)
Miklos Szeredi25b77132017-07-04 22:03:16 +0200236{
Miklos Szeredi1d88f182017-07-20 11:08:21 +0200237 struct dentry *upperdentry = ovl_i_dentry_upper(inode);
Miklos Szeredi25b77132017-07-04 22:03:16 +0200238
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200239 return upperdentry ? d_inode(upperdentry) : NULL;
Miklos Szeredi25b77132017-07-04 22:03:16 +0200240}
241
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200242struct inode *ovl_inode_lower(struct inode *inode)
243{
244 return OVL_I(inode)->lower;
245}
246
247struct inode *ovl_inode_real(struct inode *inode)
248{
249 return ovl_inode_upper(inode) ?: ovl_inode_lower(inode);
250}
251
Vivek Goyal2664bd02018-05-11 11:49:30 -0400252/* Return inode which contains lower data. Do not return metacopy */
253struct inode *ovl_inode_lowerdata(struct inode *inode)
254{
255 if (WARN_ON(!S_ISREG(inode->i_mode)))
256 return NULL;
257
258 return OVL_I(inode)->lowerdata ?: ovl_inode_lower(inode);
259}
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200260
Vivek Goyal4823d492018-05-11 11:49:31 -0400261/* Return real inode which contains data. Does not return metacopy inode */
262struct inode *ovl_inode_realdata(struct inode *inode)
263{
264 struct inode *upperinode;
265
266 upperinode = ovl_inode_upper(inode);
267 if (upperinode && ovl_has_upperdata(inode))
268 return upperinode;
269
270 return ovl_inode_lowerdata(inode);
271}
272
Miklos Szeredi4edb83b2017-07-27 21:54:06 +0200273struct ovl_dir_cache *ovl_dir_cache(struct inode *inode)
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100274{
Miklos Szeredi4edb83b2017-07-27 21:54:06 +0200275 return OVL_I(inode)->cache;
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100276}
277
Miklos Szeredi4edb83b2017-07-27 21:54:06 +0200278void ovl_set_dir_cache(struct inode *inode, struct ovl_dir_cache *cache)
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100279{
Miklos Szeredi4edb83b2017-07-27 21:54:06 +0200280 OVL_I(inode)->cache = cache;
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100281}
282
Amir Goldsteinc62520a2018-01-14 19:25:31 +0200283void ovl_dentry_set_flag(unsigned long flag, struct dentry *dentry)
284{
285 set_bit(flag, &OVL_E(dentry)->flags);
286}
287
288void ovl_dentry_clear_flag(unsigned long flag, struct dentry *dentry)
289{
290 clear_bit(flag, &OVL_E(dentry)->flags);
291}
292
293bool ovl_dentry_test_flag(unsigned long flag, struct dentry *dentry)
294{
295 return test_bit(flag, &OVL_E(dentry)->flags);
296}
297
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100298bool ovl_dentry_is_opaque(struct dentry *dentry)
299{
Amir Goldsteinc62520a2018-01-14 19:25:31 +0200300 return ovl_dentry_test_flag(OVL_E_OPAQUE, dentry);
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100301}
302
303bool ovl_dentry_is_whiteout(struct dentry *dentry)
304{
305 return !dentry->d_inode && ovl_dentry_is_opaque(dentry);
306}
307
Miklos Szeredi5cf5b472016-12-16 11:02:57 +0100308void ovl_dentry_set_opaque(struct dentry *dentry)
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100309{
Amir Goldsteinc62520a2018-01-14 19:25:31 +0200310 ovl_dentry_set_flag(OVL_E_OPAQUE, dentry);
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100311}
312
Miklos Szeredi55acc662017-07-04 22:03:18 +0200313/*
Amir Goldsteinaa3ff3c2017-10-15 18:00:20 +0300314 * For hard links and decoded file handles, it's possible for ovl_dentry_upper()
315 * to return positive, while there's no actual upper alias for the inode.
316 * Copy up code needs to know about the existence of the upper alias, so it
317 * can't use ovl_dentry_upper().
Miklos Szeredi55acc662017-07-04 22:03:18 +0200318 */
319bool ovl_dentry_has_upper_alias(struct dentry *dentry)
320{
Amir Goldsteinc62520a2018-01-14 19:25:31 +0200321 return ovl_dentry_test_flag(OVL_E_UPPER_ALIAS, dentry);
Miklos Szeredi55acc662017-07-04 22:03:18 +0200322}
323
324void ovl_dentry_set_upper_alias(struct dentry *dentry)
325{
Amir Goldsteinc62520a2018-01-14 19:25:31 +0200326 ovl_dentry_set_flag(OVL_E_UPPER_ALIAS, dentry);
Miklos Szeredi55acc662017-07-04 22:03:18 +0200327}
328
Vivek Goyal0c288872018-05-11 11:49:28 -0400329static bool ovl_should_check_upperdata(struct inode *inode)
330{
331 if (!S_ISREG(inode->i_mode))
332 return false;
333
334 if (!ovl_inode_lower(inode))
335 return false;
336
337 return true;
338}
339
340bool ovl_has_upperdata(struct inode *inode)
341{
342 if (!ovl_should_check_upperdata(inode))
343 return true;
344
345 if (!ovl_test_flag(OVL_UPPERDATA, inode))
346 return false;
347 /*
348 * Pairs with smp_wmb() in ovl_set_upperdata(). Main user of
349 * ovl_has_upperdata() is ovl_copy_up_meta_inode_data(). Make sure
350 * if setting of OVL_UPPERDATA is visible, then effects of writes
351 * before that are visible too.
352 */
353 smp_rmb();
354 return true;
355}
356
357void ovl_set_upperdata(struct inode *inode)
358{
359 /*
360 * Pairs with smp_rmb() in ovl_has_upperdata(). Make sure
361 * if OVL_UPPERDATA flag is visible, then effects of write operations
362 * before it are visible as well.
363 */
364 smp_wmb();
365 ovl_set_flag(OVL_UPPERDATA, inode);
366}
367
368/* Caller should hold ovl_inode->lock */
369bool ovl_dentry_needs_data_copy_up_locked(struct dentry *dentry, int flags)
370{
371 if (!ovl_open_flags_need_copy_up(flags))
372 return false;
373
374 return !ovl_test_flag(OVL_UPPERDATA, d_inode(dentry));
375}
376
377bool ovl_dentry_needs_data_copy_up(struct dentry *dentry, int flags)
378{
379 if (!ovl_open_flags_need_copy_up(flags))
380 return false;
381
382 return !ovl_has_upperdata(d_inode(dentry));
383}
384
Miklos Szeredia6c60652016-12-16 11:02:56 +0100385bool ovl_redirect_dir(struct super_block *sb)
386{
387 struct ovl_fs *ofs = sb->s_fs_info;
388
Amir Goldstein21a22872017-05-17 00:12:41 +0300389 return ofs->config.redirect_dir && !ofs->noxattr;
Miklos Szeredia6c60652016-12-16 11:02:56 +0100390}
391
392const char *ovl_dentry_get_redirect(struct dentry *dentry)
393{
Miklos Szeredicf31c462017-07-04 22:03:16 +0200394 return OVL_I(d_inode(dentry))->redirect;
Miklos Szeredia6c60652016-12-16 11:02:56 +0100395}
396
397void ovl_dentry_set_redirect(struct dentry *dentry, const char *redirect)
398{
Miklos Szeredicf31c462017-07-04 22:03:16 +0200399 struct ovl_inode *oi = OVL_I(d_inode(dentry));
Miklos Szeredia6c60652016-12-16 11:02:56 +0100400
Miklos Szeredicf31c462017-07-04 22:03:16 +0200401 kfree(oi->redirect);
402 oi->redirect = redirect;
Miklos Szeredia6c60652016-12-16 11:02:56 +0100403}
404
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200405void ovl_inode_init(struct inode *inode, struct dentry *upperdentry,
Vivek Goyal2664bd02018-05-11 11:49:30 -0400406 struct dentry *lowerdentry, struct dentry *lowerdata)
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100407{
Amir Goldstein695b46e2018-03-15 23:39:01 +0200408 struct inode *realinode = d_inode(upperdentry ?: lowerdentry);
409
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200410 if (upperdentry)
411 OVL_I(inode)->__upperdentry = upperdentry;
412 if (lowerdentry)
Amir Goldstein31747ed2018-01-14 18:35:40 +0200413 OVL_I(inode)->lower = igrab(d_inode(lowerdentry));
Vivek Goyal2664bd02018-05-11 11:49:30 -0400414 if (lowerdata)
415 OVL_I(inode)->lowerdata = igrab(d_inode(lowerdata));
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100416
Amir Goldstein695b46e2018-03-15 23:39:01 +0200417 ovl_copyattr(realinode, inode);
Miklos Szeredi4f357292018-07-18 15:44:41 +0200418 ovl_copyflags(realinode, inode);
Amir Goldstein695b46e2018-03-15 23:39:01 +0200419 if (!inode->i_ino)
420 inode->i_ino = realinode->i_ino;
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100421}
422
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200423void ovl_inode_update(struct inode *inode, struct dentry *upperdentry)
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100424{
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200425 struct inode *upperinode = d_inode(upperdentry);
Miklos Szeredie6d2ebd2017-07-04 22:03:16 +0200426
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200427 WARN_ON(OVL_I(inode)->__upperdentry);
428
Miklos Szeredi25b77132017-07-04 22:03:16 +0200429 /*
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200430 * Make sure upperdentry is consistent before making it visible
Miklos Szeredi25b77132017-07-04 22:03:16 +0200431 */
432 smp_wmb();
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200433 OVL_I(inode)->__upperdentry = upperdentry;
Amir Goldstein31747ed2018-01-14 18:35:40 +0200434 if (inode_unhashed(inode)) {
Amir Goldstein695b46e2018-03-15 23:39:01 +0200435 if (!inode->i_ino)
436 inode->i_ino = upperinode->i_ino;
Miklos Szeredi25b77132017-07-04 22:03:16 +0200437 inode->i_private = upperinode;
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100438 __insert_inode_hash(inode, (unsigned long) upperinode);
Miklos Szeredi25b77132017-07-04 22:03:16 +0200439 }
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100440}
441
Miklos Szeredid9854c82018-07-18 15:44:40 +0200442static void ovl_dentry_version_inc(struct dentry *dentry, bool impurity)
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100443{
Miklos Szeredi04a01ac2017-07-04 22:03:16 +0200444 struct inode *inode = d_inode(dentry);
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100445
Miklos Szeredi04a01ac2017-07-04 22:03:16 +0200446 WARN_ON(!inode_is_locked(inode));
Miklos Szeredi4edb83b2017-07-27 21:54:06 +0200447 /*
448 * Version is used by readdir code to keep cache consistent. For merge
449 * dirs all changes need to be noted. For non-merge dirs, cache only
450 * contains impure (ones which have been copied up and have origins)
451 * entries, so only need to note changes to impure entries.
452 */
453 if (OVL_TYPE_MERGE(ovl_path_type(dentry)) || impurity)
454 OVL_I(inode)->version++;
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100455}
456
Miklos Szeredid9854c82018-07-18 15:44:40 +0200457void ovl_dir_modified(struct dentry *dentry, bool impurity)
458{
459 /* Copy mtime/ctime */
460 ovl_copyattr(d_inode(ovl_dentry_upper(dentry)), d_inode(dentry));
461
462 ovl_dentry_version_inc(dentry, impurity);
463}
464
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100465u64 ovl_dentry_version_get(struct dentry *dentry)
466{
Miklos Szeredi04a01ac2017-07-04 22:03:16 +0200467 struct inode *inode = d_inode(dentry);
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100468
Miklos Szeredi04a01ac2017-07-04 22:03:16 +0200469 WARN_ON(!inode_is_locked(inode));
470 return OVL_I(inode)->version;
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100471}
472
473bool ovl_is_whiteout(struct dentry *dentry)
474{
475 struct inode *inode = dentry->d_inode;
476
477 return inode && IS_WHITEOUT(inode);
478}
479
480struct file *ovl_path_open(struct path *path, int flags)
481{
482 return dentry_open(path, flags | O_NOATIME, current_cred());
483}
Amir Goldstein39d3d602017-01-17 06:34:56 +0200484
Vivek Goyal0c288872018-05-11 11:49:28 -0400485/* Caller should hold ovl_inode->lock */
486static bool ovl_already_copied_up_locked(struct dentry *dentry, int flags)
487{
488 bool disconnected = dentry->d_flags & DCACHE_DISCONNECTED;
489
490 if (ovl_dentry_upper(dentry) &&
491 (ovl_dentry_has_upper_alias(dentry) || disconnected) &&
492 !ovl_dentry_needs_data_copy_up_locked(dentry, flags))
493 return true;
494
495 return false;
496}
497
498bool ovl_already_copied_up(struct dentry *dentry, int flags)
Vivek Goyal2002df82018-05-11 11:49:28 -0400499{
500 bool disconnected = dentry->d_flags & DCACHE_DISCONNECTED;
501
502 /*
503 * Check if copy-up has happened as well as for upper alias (in
504 * case of hard links) is there.
505 *
506 * Both checks are lockless:
507 * - false negatives: will recheck under oi->lock
508 * - false positives:
509 * + ovl_dentry_upper() uses memory barriers to ensure the
510 * upper dentry is up-to-date
511 * + ovl_dentry_has_upper_alias() relies on locking of
512 * upper parent i_rwsem to prevent reordering copy-up
513 * with rename.
514 */
515 if (ovl_dentry_upper(dentry) &&
Vivek Goyal0c288872018-05-11 11:49:28 -0400516 (ovl_dentry_has_upper_alias(dentry) || disconnected) &&
517 !ovl_dentry_needs_data_copy_up(dentry, flags))
Vivek Goyal2002df82018-05-11 11:49:28 -0400518 return true;
519
520 return false;
521}
522
Vivek Goyal0c288872018-05-11 11:49:28 -0400523int ovl_copy_up_start(struct dentry *dentry, int flags)
Amir Goldstein39d3d602017-01-17 06:34:56 +0200524{
Amir Goldsteina015daf2017-06-21 15:28:51 +0300525 struct ovl_inode *oi = OVL_I(d_inode(dentry));
Amir Goldstein39d3d602017-01-17 06:34:56 +0200526 int err;
527
Amir Goldsteina015daf2017-06-21 15:28:51 +0300528 err = mutex_lock_interruptible(&oi->lock);
Vivek Goyal0c288872018-05-11 11:49:28 -0400529 if (!err && ovl_already_copied_up_locked(dentry, flags)) {
Amir Goldsteina015daf2017-06-21 15:28:51 +0300530 err = 1; /* Already copied up */
531 mutex_unlock(&oi->lock);
Amir Goldstein39d3d602017-01-17 06:34:56 +0200532 }
Amir Goldstein39d3d602017-01-17 06:34:56 +0200533
534 return err;
535}
536
537void ovl_copy_up_end(struct dentry *dentry)
538{
Amir Goldsteina015daf2017-06-21 15:28:51 +0300539 mutex_unlock(&OVL_I(d_inode(dentry))->lock);
Amir Goldstein39d3d602017-01-17 06:34:56 +0200540}
Amir Goldstein82b749b2017-05-17 00:12:40 +0300541
Amir Goldsteinb79e05a2017-06-25 16:37:17 +0300542bool ovl_check_origin_xattr(struct dentry *dentry)
543{
544 int res;
545
546 res = vfs_getxattr(dentry, OVL_XATTR_ORIGIN, NULL, 0);
547
548 /* Zero size value means "copied up but origin unknown" */
549 if (res >= 0)
550 return true;
551
552 return false;
553}
554
Amir Goldsteinf3a15682017-05-24 15:29:33 +0300555bool ovl_check_dir_xattr(struct dentry *dentry, const char *name)
556{
557 int res;
558 char val;
559
560 if (!d_is_dir(dentry))
561 return false;
562
563 res = vfs_getxattr(dentry, name, &val, 1);
564 if (res == 1 && val == 'y')
565 return true;
566
567 return false;
568}
569
Amir Goldstein82b749b2017-05-17 00:12:40 +0300570int ovl_check_setxattr(struct dentry *dentry, struct dentry *upperdentry,
571 const char *name, const void *value, size_t size,
572 int xerr)
573{
574 int err;
575 struct ovl_fs *ofs = dentry->d_sb->s_fs_info;
576
577 if (ofs->noxattr)
578 return xerr;
579
580 err = ovl_do_setxattr(upperdentry, name, value, size, 0);
581
582 if (err == -EOPNOTSUPP) {
583 pr_warn("overlayfs: cannot set %s xattr on upper\n", name);
584 ofs->noxattr = true;
585 return xerr;
586 }
587
588 return err;
589}
Amir Goldsteinf3a15682017-05-24 15:29:33 +0300590
591int ovl_set_impure(struct dentry *dentry, struct dentry *upperdentry)
592{
593 int err;
Amir Goldsteinf3a15682017-05-24 15:29:33 +0300594
Miklos Szeredi13c72072017-07-04 22:03:16 +0200595 if (ovl_test_flag(OVL_IMPURE, d_inode(dentry)))
Amir Goldsteinf3a15682017-05-24 15:29:33 +0300596 return 0;
597
598 /*
599 * Do not fail when upper doesn't support xattrs.
600 * Upper inodes won't have origin nor redirect xattr anyway.
601 */
602 err = ovl_check_setxattr(dentry, upperdentry, OVL_XATTR_IMPURE,
603 "y", 1, 0);
604 if (!err)
Miklos Szeredi13c72072017-07-04 22:03:16 +0200605 ovl_set_flag(OVL_IMPURE, d_inode(dentry));
Amir Goldsteinf3a15682017-05-24 15:29:33 +0300606
607 return err;
608}
Miklos Szeredi13c72072017-07-04 22:03:16 +0200609
610void ovl_set_flag(unsigned long flag, struct inode *inode)
611{
612 set_bit(flag, &OVL_I(inode)->flags);
613}
614
Miklos Szeredi4edb83b2017-07-27 21:54:06 +0200615void ovl_clear_flag(unsigned long flag, struct inode *inode)
616{
617 clear_bit(flag, &OVL_I(inode)->flags);
618}
619
Miklos Szeredi13c72072017-07-04 22:03:16 +0200620bool ovl_test_flag(unsigned long flag, struct inode *inode)
621{
622 return test_bit(flag, &OVL_I(inode)->flags);
623}
Amir Goldsteinad0af712017-06-21 15:28:32 +0300624
625/**
626 * Caller must hold a reference to inode to prevent it from being freed while
627 * it is marked inuse.
628 */
629bool ovl_inuse_trylock(struct dentry *dentry)
630{
631 struct inode *inode = d_inode(dentry);
632 bool locked = false;
633
634 spin_lock(&inode->i_lock);
635 if (!(inode->i_state & I_OVL_INUSE)) {
636 inode->i_state |= I_OVL_INUSE;
637 locked = true;
638 }
639 spin_unlock(&inode->i_lock);
640
641 return locked;
642}
643
644void ovl_inuse_unlock(struct dentry *dentry)
645{
646 if (dentry) {
647 struct inode *inode = d_inode(dentry);
648
649 spin_lock(&inode->i_lock);
650 WARN_ON(!(inode->i_state & I_OVL_INUSE));
651 inode->i_state &= ~I_OVL_INUSE;
652 spin_unlock(&inode->i_lock);
653 }
654}
Amir Goldstein5f8415d2017-06-20 15:35:14 +0300655
Amir Goldsteinf1c5aa52019-04-18 17:42:08 +0300656bool ovl_is_inuse(struct dentry *dentry)
657{
658 struct inode *inode = d_inode(dentry);
659 bool inuse;
660
661 spin_lock(&inode->i_lock);
662 inuse = (inode->i_state & I_OVL_INUSE);
663 spin_unlock(&inode->i_lock);
664
665 return inuse;
666}
667
Amir Goldstein24b33ee2017-09-26 07:55:26 +0300668/*
669 * Does this overlay dentry need to be indexed on copy up?
670 */
671bool ovl_need_index(struct dentry *dentry)
672{
673 struct dentry *lower = ovl_dentry_lower(dentry);
674
675 if (!lower || !ovl_indexdir(dentry->d_sb))
676 return false;
677
Amir Goldsteinfbd2d202017-11-22 00:08:21 +0200678 /* Index all files for NFS export and consistency verification */
Amir Goldstein016b7202018-01-11 14:01:08 +0200679 if (ovl_index_all(dentry->d_sb))
Amir Goldsteinfbd2d202017-11-22 00:08:21 +0200680 return true;
681
Amir Goldstein24b33ee2017-09-26 07:55:26 +0300682 /* Index only lower hardlinks on copy up */
683 if (!d_is_dir(lower) && d_inode(lower)->i_nlink > 1)
684 return true;
685
686 return false;
687}
688
Amir Goldstein9f4ec902017-09-24 17:36:26 +0300689/* Caller must hold OVL_I(inode)->lock */
Amir Goldsteincaf70cb2017-06-21 13:46:12 +0300690static void ovl_cleanup_index(struct dentry *dentry)
691{
Amir Goldsteine7dd0e72017-10-24 17:38:33 +0300692 struct dentry *indexdir = ovl_indexdir(dentry->d_sb);
693 struct inode *dir = indexdir->d_inode;
Amir Goldsteincaf70cb2017-06-21 13:46:12 +0300694 struct dentry *lowerdentry = ovl_dentry_lower(dentry);
695 struct dentry *upperdentry = ovl_dentry_upper(dentry);
696 struct dentry *index = NULL;
697 struct inode *inode;
Amir Goldstein63e13252018-09-18 16:34:31 +0300698 struct qstr name = { };
Amir Goldsteincaf70cb2017-06-21 13:46:12 +0300699 int err;
700
701 err = ovl_get_index_name(lowerdentry, &name);
702 if (err)
703 goto fail;
704
705 inode = d_inode(upperdentry);
Amir Goldstein89a17552017-09-26 07:40:37 +0300706 if (!S_ISDIR(inode->i_mode) && inode->i_nlink != 1) {
Amir Goldsteincaf70cb2017-06-21 13:46:12 +0300707 pr_warn_ratelimited("overlayfs: cleanup linked index (%pd2, ino=%lu, nlink=%u)\n",
708 upperdentry, inode->i_ino, inode->i_nlink);
709 /*
710 * We either have a bug with persistent union nlink or a lower
711 * hardlink was added while overlay is mounted. Adding a lower
712 * hardlink and then unlinking all overlay hardlinks would drop
713 * overlay nlink to zero before all upper inodes are unlinked.
714 * As a safety measure, when that situation is detected, set
715 * the overlay nlink to the index inode nlink minus one for the
716 * index entry itself.
717 */
718 set_nlink(d_inode(dentry), inode->i_nlink - 1);
719 ovl_set_nlink_upper(dentry);
720 goto out;
721 }
722
723 inode_lock_nested(dir, I_MUTEX_PARENT);
Amir Goldsteine7dd0e72017-10-24 17:38:33 +0300724 index = lookup_one_len(name.name, indexdir, name.len);
Amir Goldsteincaf70cb2017-06-21 13:46:12 +0300725 err = PTR_ERR(index);
Amir Goldsteine7dd0e72017-10-24 17:38:33 +0300726 if (IS_ERR(index)) {
Amir Goldstein9f4ec902017-09-24 17:36:26 +0300727 index = NULL;
Amir Goldsteine7dd0e72017-10-24 17:38:33 +0300728 } else if (ovl_index_all(dentry->d_sb)) {
729 /* Whiteout orphan index to block future open by handle */
730 err = ovl_cleanup_and_whiteout(indexdir, dir, index);
731 } else {
732 /* Cleanup orphan index entries */
733 err = ovl_cleanup(dir, index);
734 }
Amir Goldstein9f4ec902017-09-24 17:36:26 +0300735
Amir Goldsteincaf70cb2017-06-21 13:46:12 +0300736 inode_unlock(dir);
737 if (err)
738 goto fail;
739
740out:
Amir Goldstein63e13252018-09-18 16:34:31 +0300741 kfree(name.name);
Amir Goldsteincaf70cb2017-06-21 13:46:12 +0300742 dput(index);
743 return;
744
745fail:
746 pr_err("overlayfs: cleanup index of '%pd2' failed (%i)\n", dentry, err);
747 goto out;
748}
749
Amir Goldstein5f8415d2017-06-20 15:35:14 +0300750/*
751 * Operations that change overlay inode and upper inode nlink need to be
752 * synchronized with copy up for persistent nlink accounting.
753 */
754int ovl_nlink_start(struct dentry *dentry, bool *locked)
755{
756 struct ovl_inode *oi = OVL_I(d_inode(dentry));
757 const struct cred *old_cred;
758 int err;
759
Amir Goldstein89a17552017-09-26 07:40:37 +0300760 if (!d_inode(dentry))
Amir Goldstein5f8415d2017-06-20 15:35:14 +0300761 return 0;
762
763 /*
764 * With inodes index is enabled, we store the union overlay nlink
Amir Goldstein24b33ee2017-09-26 07:55:26 +0300765 * in an xattr on the index inode. When whiting out an indexed lower,
Amir Goldstein5f8415d2017-06-20 15:35:14 +0300766 * we need to decrement the overlay persistent nlink, but before the
767 * first copy up, we have no upper index inode to store the xattr.
768 *
Amir Goldstein24b33ee2017-09-26 07:55:26 +0300769 * As a workaround, before whiteout/rename over an indexed lower,
Amir Goldstein5f8415d2017-06-20 15:35:14 +0300770 * copy up to create the upper index. Creating the upper index will
771 * initialize the overlay nlink, so it could be dropped if unlink
772 * or rename succeeds.
773 *
774 * TODO: implement metadata only index copy up when called with
775 * ovl_copy_up_flags(dentry, O_PATH).
776 */
Amir Goldstein24b33ee2017-09-26 07:55:26 +0300777 if (ovl_need_index(dentry) && !ovl_dentry_has_upper_alias(dentry)) {
Amir Goldstein5f8415d2017-06-20 15:35:14 +0300778 err = ovl_copy_up(dentry);
779 if (err)
780 return err;
781 }
782
783 err = mutex_lock_interruptible(&oi->lock);
784 if (err)
785 return err;
786
Amir Goldstein89a17552017-09-26 07:40:37 +0300787 if (d_is_dir(dentry) || !ovl_test_flag(OVL_INDEX, d_inode(dentry)))
Amir Goldstein5f8415d2017-06-20 15:35:14 +0300788 goto out;
789
790 old_cred = ovl_override_creds(dentry->d_sb);
791 /*
792 * The overlay inode nlink should be incremented/decremented IFF the
793 * upper operation succeeds, along with nlink change of upper inode.
794 * Therefore, before link/unlink/rename, we store the union nlink
795 * value relative to the upper inode nlink in an upper inode xattr.
796 */
797 err = ovl_set_nlink_upper(dentry);
798 revert_creds(old_cred);
799
800out:
801 if (err)
802 mutex_unlock(&oi->lock);
803 else
804 *locked = true;
805
806 return err;
807}
808
809void ovl_nlink_end(struct dentry *dentry, bool locked)
810{
Amir Goldsteincaf70cb2017-06-21 13:46:12 +0300811 if (locked) {
812 if (ovl_test_flag(OVL_INDEX, d_inode(dentry)) &&
813 d_inode(dentry)->i_nlink == 0) {
814 const struct cred *old_cred;
815
816 old_cred = ovl_override_creds(dentry->d_sb);
817 ovl_cleanup_index(dentry);
818 revert_creds(old_cred);
819 }
820
Amir Goldstein5f8415d2017-06-20 15:35:14 +0300821 mutex_unlock(&OVL_I(d_inode(dentry))->lock);
Amir Goldsteincaf70cb2017-06-21 13:46:12 +0300822 }
Amir Goldstein5f8415d2017-06-20 15:35:14 +0300823}
Amir Goldstein5820dc02017-09-25 16:39:55 +0300824
825int ovl_lock_rename_workdir(struct dentry *workdir, struct dentry *upperdir)
826{
827 /* Workdir should not be the same as upperdir */
828 if (workdir == upperdir)
829 goto err;
830
831 /* Workdir should not be subdir of upperdir and vice versa */
832 if (lock_rename(workdir, upperdir) != NULL)
833 goto err_unlock;
834
835 return 0;
836
837err_unlock:
838 unlock_rename(workdir, upperdir);
839err:
840 pr_err("overlayfs: failed to lock workdir+upperdir\n");
841 return -EIO;
842}
Vivek Goyal9d3dfea2018-05-11 11:49:28 -0400843
844/* err < 0, 0 if no metacopy xattr, 1 if metacopy xattr found */
845int ovl_check_metacopy_xattr(struct dentry *dentry)
846{
847 int res;
848
849 /* Only regular files can have metacopy xattr */
850 if (!S_ISREG(d_inode(dentry)->i_mode))
851 return 0;
852
853 res = vfs_getxattr(dentry, OVL_XATTR_METACOPY, NULL, 0);
854 if (res < 0) {
855 if (res == -ENODATA || res == -EOPNOTSUPP)
856 return 0;
857 goto out;
858 }
859
860 return 1;
861out:
862 pr_warn_ratelimited("overlayfs: failed to get metacopy (%i)\n", res);
863 return res;
864}
Vivek Goyal67d756c22018-05-11 11:49:30 -0400865
866bool ovl_is_metacopy_dentry(struct dentry *dentry)
867{
868 struct ovl_entry *oe = dentry->d_fsdata;
869
870 if (!d_is_reg(dentry))
871 return false;
872
873 if (ovl_dentry_upper(dentry)) {
874 if (!ovl_has_upperdata(d_inode(dentry)))
875 return true;
876 return false;
877 }
878
879 return (oe->numlower > 1);
880}
Vivek Goyal0a2d0d32018-05-11 11:49:32 -0400881
Vivek Goyal205f1492019-01-30 14:01:57 -0500882ssize_t ovl_getxattr(struct dentry *dentry, char *name, char **value,
883 size_t padding)
884{
885 ssize_t res;
886 char *buf = NULL;
887
888 res = vfs_getxattr(dentry, name, NULL, 0);
889 if (res < 0) {
890 if (res == -ENODATA || res == -EOPNOTSUPP)
891 return -ENODATA;
892 goto fail;
893 }
894
895 if (res != 0) {
896 buf = kzalloc(res + padding, GFP_KERNEL);
897 if (!buf)
898 return -ENOMEM;
899
900 res = vfs_getxattr(dentry, name, buf, res);
901 if (res < 0)
902 goto fail;
903 }
904 *value = buf;
905
906 return res;
907
908fail:
909 pr_warn_ratelimited("overlayfs: failed to get xattr %s: err=%zi)\n",
910 name, res);
911 kfree(buf);
912 return res;
913}
914
Vivek Goyal0a2d0d32018-05-11 11:49:32 -0400915char *ovl_get_redirect_xattr(struct dentry *dentry, int padding)
916{
917 int res;
918 char *s, *next, *buf = NULL;
919
Vivek Goyal205f1492019-01-30 14:01:57 -0500920 res = ovl_getxattr(dentry, OVL_XATTR_REDIRECT, &buf, padding + 1);
921 if (res == -ENODATA)
922 return NULL;
Vivek Goyal0a2d0d32018-05-11 11:49:32 -0400923 if (res < 0)
Vivek Goyal205f1492019-01-30 14:01:57 -0500924 return ERR_PTR(res);
Vivek Goyal0a2d0d32018-05-11 11:49:32 -0400925 if (res == 0)
926 goto invalid;
927
928 if (buf[0] == '/') {
929 for (s = buf; *s++ == '/'; s = next) {
930 next = strchrnul(s, '/');
931 if (s == next)
932 goto invalid;
933 }
934 } else {
935 if (strchr(buf, '/') != NULL)
936 goto invalid;
937 }
938
939 return buf;
Vivek Goyal0a2d0d32018-05-11 11:49:32 -0400940invalid:
941 pr_warn_ratelimited("overlayfs: invalid redirect (%s)\n", buf);
942 res = -EINVAL;
Vivek Goyal205f1492019-01-30 14:01:57 -0500943 kfree(buf);
944 return ERR_PTR(res);
Vivek Goyal0a2d0d32018-05-11 11:49:32 -0400945}