blob: 63311c5362162838ce22fb0ef65a9cdc6f0439ec [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) {
136 type |= __OVL_PATH_ORIGIN;
137 if (d_is_dir(dentry))
138 type |= __OVL_PATH_MERGE;
139 }
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100140 } else {
141 if (oe->numlower > 1)
142 type |= __OVL_PATH_MERGE;
143 }
144 return type;
145}
146
147void ovl_path_upper(struct dentry *dentry, struct path *path)
148{
149 struct ovl_fs *ofs = dentry->d_sb->s_fs_info;
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100150
151 path->mnt = ofs->upper_mnt;
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200152 path->dentry = ovl_dentry_upper(dentry);
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100153}
154
155void ovl_path_lower(struct dentry *dentry, struct path *path)
156{
157 struct ovl_entry *oe = dentry->d_fsdata;
158
Chandan Rajendrab9343632017-07-24 01:57:54 -0500159 if (oe->numlower) {
160 path->mnt = oe->lowerstack[0].layer->mnt;
161 path->dentry = oe->lowerstack[0].dentry;
162 } else {
163 *path = (struct path) { };
164 }
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100165}
166
Vivek Goyal4f93b422018-05-11 11:49:30 -0400167void ovl_path_lowerdata(struct dentry *dentry, struct path *path)
168{
169 struct ovl_entry *oe = dentry->d_fsdata;
170
171 if (oe->numlower) {
172 path->mnt = oe->lowerstack[oe->numlower - 1].layer->mnt;
173 path->dentry = oe->lowerstack[oe->numlower - 1].dentry;
174 } else {
175 *path = (struct path) { };
176 }
177}
178
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100179enum ovl_path_type ovl_path_real(struct dentry *dentry, struct path *path)
180{
181 enum ovl_path_type type = ovl_path_type(dentry);
182
183 if (!OVL_TYPE_UPPER(type))
184 ovl_path_lower(dentry, path);
185 else
186 ovl_path_upper(dentry, path);
187
188 return type;
189}
190
191struct dentry *ovl_dentry_upper(struct dentry *dentry)
192{
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200193 return ovl_upperdentry_dereference(OVL_I(d_inode(dentry)));
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100194}
195
196struct dentry *ovl_dentry_lower(struct dentry *dentry)
197{
198 struct ovl_entry *oe = dentry->d_fsdata;
199
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200200 return oe->numlower ? oe->lowerstack[0].dentry : NULL;
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100201}
202
Amir Goldsteinda309e82017-11-08 19:39:51 +0200203struct ovl_layer *ovl_layer_lower(struct dentry *dentry)
204{
205 struct ovl_entry *oe = dentry->d_fsdata;
206
207 return oe->numlower ? oe->lowerstack[0].layer : NULL;
208}
209
Vivek Goyal647d2532018-05-11 11:49:30 -0400210/*
211 * ovl_dentry_lower() could return either a data dentry or metacopy dentry
212 * dependig on what is stored in lowerstack[0]. At times we need to find
213 * lower dentry which has data (and not metacopy dentry). This helper
214 * returns the lower data dentry.
215 */
216struct dentry *ovl_dentry_lowerdata(struct dentry *dentry)
217{
218 struct ovl_entry *oe = dentry->d_fsdata;
219
220 return oe->numlower ? oe->lowerstack[oe->numlower - 1].dentry : NULL;
221}
222
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100223struct dentry *ovl_dentry_real(struct dentry *dentry)
224{
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200225 return ovl_dentry_upper(dentry) ?: ovl_dentry_lower(dentry);
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100226}
227
Miklos Szeredi1d88f182017-07-20 11:08:21 +0200228struct dentry *ovl_i_dentry_upper(struct inode *inode)
229{
230 return ovl_upperdentry_dereference(OVL_I(inode));
231}
232
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200233struct inode *ovl_inode_upper(struct inode *inode)
Miklos Szeredi25b77132017-07-04 22:03:16 +0200234{
Miklos Szeredi1d88f182017-07-20 11:08:21 +0200235 struct dentry *upperdentry = ovl_i_dentry_upper(inode);
Miklos Szeredi25b77132017-07-04 22:03:16 +0200236
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200237 return upperdentry ? d_inode(upperdentry) : NULL;
Miklos Szeredi25b77132017-07-04 22:03:16 +0200238}
239
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200240struct inode *ovl_inode_lower(struct inode *inode)
241{
242 return OVL_I(inode)->lower;
243}
244
245struct inode *ovl_inode_real(struct inode *inode)
246{
247 return ovl_inode_upper(inode) ?: ovl_inode_lower(inode);
248}
249
Vivek Goyal2664bd02018-05-11 11:49:30 -0400250/* Return inode which contains lower data. Do not return metacopy */
251struct inode *ovl_inode_lowerdata(struct inode *inode)
252{
253 if (WARN_ON(!S_ISREG(inode->i_mode)))
254 return NULL;
255
256 return OVL_I(inode)->lowerdata ?: ovl_inode_lower(inode);
257}
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200258
Miklos Szeredi4edb83b2017-07-27 21:54:06 +0200259struct ovl_dir_cache *ovl_dir_cache(struct inode *inode)
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100260{
Miklos Szeredi4edb83b2017-07-27 21:54:06 +0200261 return OVL_I(inode)->cache;
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100262}
263
Miklos Szeredi4edb83b2017-07-27 21:54:06 +0200264void ovl_set_dir_cache(struct inode *inode, struct ovl_dir_cache *cache)
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100265{
Miklos Szeredi4edb83b2017-07-27 21:54:06 +0200266 OVL_I(inode)->cache = cache;
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100267}
268
Amir Goldsteinc62520a2018-01-14 19:25:31 +0200269void ovl_dentry_set_flag(unsigned long flag, struct dentry *dentry)
270{
271 set_bit(flag, &OVL_E(dentry)->flags);
272}
273
274void ovl_dentry_clear_flag(unsigned long flag, struct dentry *dentry)
275{
276 clear_bit(flag, &OVL_E(dentry)->flags);
277}
278
279bool ovl_dentry_test_flag(unsigned long flag, struct dentry *dentry)
280{
281 return test_bit(flag, &OVL_E(dentry)->flags);
282}
283
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100284bool ovl_dentry_is_opaque(struct dentry *dentry)
285{
Amir Goldsteinc62520a2018-01-14 19:25:31 +0200286 return ovl_dentry_test_flag(OVL_E_OPAQUE, dentry);
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100287}
288
289bool ovl_dentry_is_whiteout(struct dentry *dentry)
290{
291 return !dentry->d_inode && ovl_dentry_is_opaque(dentry);
292}
293
Miklos Szeredi5cf5b472016-12-16 11:02:57 +0100294void ovl_dentry_set_opaque(struct dentry *dentry)
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100295{
Amir Goldsteinc62520a2018-01-14 19:25:31 +0200296 ovl_dentry_set_flag(OVL_E_OPAQUE, dentry);
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100297}
298
Miklos Szeredi55acc662017-07-04 22:03:18 +0200299/*
Amir Goldsteinaa3ff3c2017-10-15 18:00:20 +0300300 * For hard links and decoded file handles, it's possible for ovl_dentry_upper()
301 * to return positive, while there's no actual upper alias for the inode.
302 * Copy up code needs to know about the existence of the upper alias, so it
303 * can't use ovl_dentry_upper().
Miklos Szeredi55acc662017-07-04 22:03:18 +0200304 */
305bool ovl_dentry_has_upper_alias(struct dentry *dentry)
306{
Amir Goldsteinc62520a2018-01-14 19:25:31 +0200307 return ovl_dentry_test_flag(OVL_E_UPPER_ALIAS, dentry);
Miklos Szeredi55acc662017-07-04 22:03:18 +0200308}
309
310void ovl_dentry_set_upper_alias(struct dentry *dentry)
311{
Amir Goldsteinc62520a2018-01-14 19:25:31 +0200312 ovl_dentry_set_flag(OVL_E_UPPER_ALIAS, dentry);
Miklos Szeredi55acc662017-07-04 22:03:18 +0200313}
314
Vivek Goyal0c288872018-05-11 11:49:28 -0400315static bool ovl_should_check_upperdata(struct inode *inode)
316{
317 if (!S_ISREG(inode->i_mode))
318 return false;
319
320 if (!ovl_inode_lower(inode))
321 return false;
322
323 return true;
324}
325
326bool ovl_has_upperdata(struct inode *inode)
327{
328 if (!ovl_should_check_upperdata(inode))
329 return true;
330
331 if (!ovl_test_flag(OVL_UPPERDATA, inode))
332 return false;
333 /*
334 * Pairs with smp_wmb() in ovl_set_upperdata(). Main user of
335 * ovl_has_upperdata() is ovl_copy_up_meta_inode_data(). Make sure
336 * if setting of OVL_UPPERDATA is visible, then effects of writes
337 * before that are visible too.
338 */
339 smp_rmb();
340 return true;
341}
342
343void ovl_set_upperdata(struct inode *inode)
344{
345 /*
346 * Pairs with smp_rmb() in ovl_has_upperdata(). Make sure
347 * if OVL_UPPERDATA flag is visible, then effects of write operations
348 * before it are visible as well.
349 */
350 smp_wmb();
351 ovl_set_flag(OVL_UPPERDATA, inode);
352}
353
354/* Caller should hold ovl_inode->lock */
355bool ovl_dentry_needs_data_copy_up_locked(struct dentry *dentry, int flags)
356{
357 if (!ovl_open_flags_need_copy_up(flags))
358 return false;
359
360 return !ovl_test_flag(OVL_UPPERDATA, d_inode(dentry));
361}
362
363bool ovl_dentry_needs_data_copy_up(struct dentry *dentry, int flags)
364{
365 if (!ovl_open_flags_need_copy_up(flags))
366 return false;
367
368 return !ovl_has_upperdata(d_inode(dentry));
369}
370
Miklos Szeredia6c60652016-12-16 11:02:56 +0100371bool ovl_redirect_dir(struct super_block *sb)
372{
373 struct ovl_fs *ofs = sb->s_fs_info;
374
Amir Goldstein21a22872017-05-17 00:12:41 +0300375 return ofs->config.redirect_dir && !ofs->noxattr;
Miklos Szeredia6c60652016-12-16 11:02:56 +0100376}
377
378const char *ovl_dentry_get_redirect(struct dentry *dentry)
379{
Miklos Szeredicf31c462017-07-04 22:03:16 +0200380 return OVL_I(d_inode(dentry))->redirect;
Miklos Szeredia6c60652016-12-16 11:02:56 +0100381}
382
383void ovl_dentry_set_redirect(struct dentry *dentry, const char *redirect)
384{
Miklos Szeredicf31c462017-07-04 22:03:16 +0200385 struct ovl_inode *oi = OVL_I(d_inode(dentry));
Miklos Szeredia6c60652016-12-16 11:02:56 +0100386
Miklos Szeredicf31c462017-07-04 22:03:16 +0200387 kfree(oi->redirect);
388 oi->redirect = redirect;
Miklos Szeredia6c60652016-12-16 11:02:56 +0100389}
390
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200391void ovl_inode_init(struct inode *inode, struct dentry *upperdentry,
Vivek Goyal2664bd02018-05-11 11:49:30 -0400392 struct dentry *lowerdentry, struct dentry *lowerdata)
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100393{
Amir Goldstein695b46e2018-03-15 23:39:01 +0200394 struct inode *realinode = d_inode(upperdentry ?: lowerdentry);
395
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200396 if (upperdentry)
397 OVL_I(inode)->__upperdentry = upperdentry;
398 if (lowerdentry)
Amir Goldstein31747ed2018-01-14 18:35:40 +0200399 OVL_I(inode)->lower = igrab(d_inode(lowerdentry));
Vivek Goyal2664bd02018-05-11 11:49:30 -0400400 if (lowerdata)
401 OVL_I(inode)->lowerdata = igrab(d_inode(lowerdata));
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100402
Amir Goldstein695b46e2018-03-15 23:39:01 +0200403 ovl_copyattr(realinode, inode);
Miklos Szeredi4f357292018-07-18 15:44:41 +0200404 ovl_copyflags(realinode, inode);
Amir Goldstein695b46e2018-03-15 23:39:01 +0200405 if (!inode->i_ino)
406 inode->i_ino = realinode->i_ino;
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100407}
408
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200409void ovl_inode_update(struct inode *inode, struct dentry *upperdentry)
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100410{
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200411 struct inode *upperinode = d_inode(upperdentry);
Miklos Szeredie6d2ebd2017-07-04 22:03:16 +0200412
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200413 WARN_ON(OVL_I(inode)->__upperdentry);
414
Miklos Szeredi25b77132017-07-04 22:03:16 +0200415 /*
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200416 * Make sure upperdentry is consistent before making it visible
Miklos Szeredi25b77132017-07-04 22:03:16 +0200417 */
418 smp_wmb();
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200419 OVL_I(inode)->__upperdentry = upperdentry;
Amir Goldstein31747ed2018-01-14 18:35:40 +0200420 if (inode_unhashed(inode)) {
Amir Goldstein695b46e2018-03-15 23:39:01 +0200421 if (!inode->i_ino)
422 inode->i_ino = upperinode->i_ino;
Miklos Szeredi25b77132017-07-04 22:03:16 +0200423 inode->i_private = upperinode;
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100424 __insert_inode_hash(inode, (unsigned long) upperinode);
Miklos Szeredi25b77132017-07-04 22:03:16 +0200425 }
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100426}
427
Miklos Szeredid9854c82018-07-18 15:44:40 +0200428static void ovl_dentry_version_inc(struct dentry *dentry, bool impurity)
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100429{
Miklos Szeredi04a01ac2017-07-04 22:03:16 +0200430 struct inode *inode = d_inode(dentry);
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100431
Miklos Szeredi04a01ac2017-07-04 22:03:16 +0200432 WARN_ON(!inode_is_locked(inode));
Miklos Szeredi4edb83b2017-07-27 21:54:06 +0200433 /*
434 * Version is used by readdir code to keep cache consistent. For merge
435 * dirs all changes need to be noted. For non-merge dirs, cache only
436 * contains impure (ones which have been copied up and have origins)
437 * entries, so only need to note changes to impure entries.
438 */
439 if (OVL_TYPE_MERGE(ovl_path_type(dentry)) || impurity)
440 OVL_I(inode)->version++;
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100441}
442
Miklos Szeredid9854c82018-07-18 15:44:40 +0200443void ovl_dir_modified(struct dentry *dentry, bool impurity)
444{
445 /* Copy mtime/ctime */
446 ovl_copyattr(d_inode(ovl_dentry_upper(dentry)), d_inode(dentry));
447
448 ovl_dentry_version_inc(dentry, impurity);
449}
450
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100451u64 ovl_dentry_version_get(struct dentry *dentry)
452{
Miklos Szeredi04a01ac2017-07-04 22:03:16 +0200453 struct inode *inode = d_inode(dentry);
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100454
Miklos Szeredi04a01ac2017-07-04 22:03:16 +0200455 WARN_ON(!inode_is_locked(inode));
456 return OVL_I(inode)->version;
Miklos Szeredibbb1e542016-12-16 11:02:56 +0100457}
458
459bool ovl_is_whiteout(struct dentry *dentry)
460{
461 struct inode *inode = dentry->d_inode;
462
463 return inode && IS_WHITEOUT(inode);
464}
465
466struct file *ovl_path_open(struct path *path, int flags)
467{
468 return dentry_open(path, flags | O_NOATIME, current_cred());
469}
Amir Goldstein39d3d602017-01-17 06:34:56 +0200470
Vivek Goyal0c288872018-05-11 11:49:28 -0400471/* Caller should hold ovl_inode->lock */
472static bool ovl_already_copied_up_locked(struct dentry *dentry, int flags)
473{
474 bool disconnected = dentry->d_flags & DCACHE_DISCONNECTED;
475
476 if (ovl_dentry_upper(dentry) &&
477 (ovl_dentry_has_upper_alias(dentry) || disconnected) &&
478 !ovl_dentry_needs_data_copy_up_locked(dentry, flags))
479 return true;
480
481 return false;
482}
483
484bool ovl_already_copied_up(struct dentry *dentry, int flags)
Vivek Goyal2002df82018-05-11 11:49:28 -0400485{
486 bool disconnected = dentry->d_flags & DCACHE_DISCONNECTED;
487
488 /*
489 * Check if copy-up has happened as well as for upper alias (in
490 * case of hard links) is there.
491 *
492 * Both checks are lockless:
493 * - false negatives: will recheck under oi->lock
494 * - false positives:
495 * + ovl_dentry_upper() uses memory barriers to ensure the
496 * upper dentry is up-to-date
497 * + ovl_dentry_has_upper_alias() relies on locking of
498 * upper parent i_rwsem to prevent reordering copy-up
499 * with rename.
500 */
501 if (ovl_dentry_upper(dentry) &&
Vivek Goyal0c288872018-05-11 11:49:28 -0400502 (ovl_dentry_has_upper_alias(dentry) || disconnected) &&
503 !ovl_dentry_needs_data_copy_up(dentry, flags))
Vivek Goyal2002df82018-05-11 11:49:28 -0400504 return true;
505
506 return false;
507}
508
Vivek Goyal0c288872018-05-11 11:49:28 -0400509int ovl_copy_up_start(struct dentry *dentry, int flags)
Amir Goldstein39d3d602017-01-17 06:34:56 +0200510{
Amir Goldsteina015daf2017-06-21 15:28:51 +0300511 struct ovl_inode *oi = OVL_I(d_inode(dentry));
Amir Goldstein39d3d602017-01-17 06:34:56 +0200512 int err;
513
Amir Goldsteina015daf2017-06-21 15:28:51 +0300514 err = mutex_lock_interruptible(&oi->lock);
Vivek Goyal0c288872018-05-11 11:49:28 -0400515 if (!err && ovl_already_copied_up_locked(dentry, flags)) {
Amir Goldsteina015daf2017-06-21 15:28:51 +0300516 err = 1; /* Already copied up */
517 mutex_unlock(&oi->lock);
Amir Goldstein39d3d602017-01-17 06:34:56 +0200518 }
Amir Goldstein39d3d602017-01-17 06:34:56 +0200519
520 return err;
521}
522
523void ovl_copy_up_end(struct dentry *dentry)
524{
Amir Goldsteina015daf2017-06-21 15:28:51 +0300525 mutex_unlock(&OVL_I(d_inode(dentry))->lock);
Amir Goldstein39d3d602017-01-17 06:34:56 +0200526}
Amir Goldstein82b749b2017-05-17 00:12:40 +0300527
Amir Goldsteinb79e05a2017-06-25 16:37:17 +0300528bool ovl_check_origin_xattr(struct dentry *dentry)
529{
530 int res;
531
532 res = vfs_getxattr(dentry, OVL_XATTR_ORIGIN, NULL, 0);
533
534 /* Zero size value means "copied up but origin unknown" */
535 if (res >= 0)
536 return true;
537
538 return false;
539}
540
Amir Goldsteinf3a15682017-05-24 15:29:33 +0300541bool ovl_check_dir_xattr(struct dentry *dentry, const char *name)
542{
543 int res;
544 char val;
545
546 if (!d_is_dir(dentry))
547 return false;
548
549 res = vfs_getxattr(dentry, name, &val, 1);
550 if (res == 1 && val == 'y')
551 return true;
552
553 return false;
554}
555
Amir Goldstein82b749b2017-05-17 00:12:40 +0300556int ovl_check_setxattr(struct dentry *dentry, struct dentry *upperdentry,
557 const char *name, const void *value, size_t size,
558 int xerr)
559{
560 int err;
561 struct ovl_fs *ofs = dentry->d_sb->s_fs_info;
562
563 if (ofs->noxattr)
564 return xerr;
565
566 err = ovl_do_setxattr(upperdentry, name, value, size, 0);
567
568 if (err == -EOPNOTSUPP) {
569 pr_warn("overlayfs: cannot set %s xattr on upper\n", name);
570 ofs->noxattr = true;
571 return xerr;
572 }
573
574 return err;
575}
Amir Goldsteinf3a15682017-05-24 15:29:33 +0300576
577int ovl_set_impure(struct dentry *dentry, struct dentry *upperdentry)
578{
579 int err;
Amir Goldsteinf3a15682017-05-24 15:29:33 +0300580
Miklos Szeredi13c72072017-07-04 22:03:16 +0200581 if (ovl_test_flag(OVL_IMPURE, d_inode(dentry)))
Amir Goldsteinf3a15682017-05-24 15:29:33 +0300582 return 0;
583
584 /*
585 * Do not fail when upper doesn't support xattrs.
586 * Upper inodes won't have origin nor redirect xattr anyway.
587 */
588 err = ovl_check_setxattr(dentry, upperdentry, OVL_XATTR_IMPURE,
589 "y", 1, 0);
590 if (!err)
Miklos Szeredi13c72072017-07-04 22:03:16 +0200591 ovl_set_flag(OVL_IMPURE, d_inode(dentry));
Amir Goldsteinf3a15682017-05-24 15:29:33 +0300592
593 return err;
594}
Miklos Szeredi13c72072017-07-04 22:03:16 +0200595
596void ovl_set_flag(unsigned long flag, struct inode *inode)
597{
598 set_bit(flag, &OVL_I(inode)->flags);
599}
600
Miklos Szeredi4edb83b2017-07-27 21:54:06 +0200601void ovl_clear_flag(unsigned long flag, struct inode *inode)
602{
603 clear_bit(flag, &OVL_I(inode)->flags);
604}
605
Miklos Szeredi13c72072017-07-04 22:03:16 +0200606bool ovl_test_flag(unsigned long flag, struct inode *inode)
607{
608 return test_bit(flag, &OVL_I(inode)->flags);
609}
Amir Goldsteinad0af712017-06-21 15:28:32 +0300610
611/**
612 * Caller must hold a reference to inode to prevent it from being freed while
613 * it is marked inuse.
614 */
615bool ovl_inuse_trylock(struct dentry *dentry)
616{
617 struct inode *inode = d_inode(dentry);
618 bool locked = false;
619
620 spin_lock(&inode->i_lock);
621 if (!(inode->i_state & I_OVL_INUSE)) {
622 inode->i_state |= I_OVL_INUSE;
623 locked = true;
624 }
625 spin_unlock(&inode->i_lock);
626
627 return locked;
628}
629
630void ovl_inuse_unlock(struct dentry *dentry)
631{
632 if (dentry) {
633 struct inode *inode = d_inode(dentry);
634
635 spin_lock(&inode->i_lock);
636 WARN_ON(!(inode->i_state & I_OVL_INUSE));
637 inode->i_state &= ~I_OVL_INUSE;
638 spin_unlock(&inode->i_lock);
639 }
640}
Amir Goldstein5f8415d2017-06-20 15:35:14 +0300641
Amir Goldstein24b33ee2017-09-26 07:55:26 +0300642/*
643 * Does this overlay dentry need to be indexed on copy up?
644 */
645bool ovl_need_index(struct dentry *dentry)
646{
647 struct dentry *lower = ovl_dentry_lower(dentry);
648
649 if (!lower || !ovl_indexdir(dentry->d_sb))
650 return false;
651
Amir Goldsteinfbd2d202017-11-22 00:08:21 +0200652 /* Index all files for NFS export and consistency verification */
Amir Goldstein016b7202018-01-11 14:01:08 +0200653 if (ovl_index_all(dentry->d_sb))
Amir Goldsteinfbd2d202017-11-22 00:08:21 +0200654 return true;
655
Amir Goldstein24b33ee2017-09-26 07:55:26 +0300656 /* Index only lower hardlinks on copy up */
657 if (!d_is_dir(lower) && d_inode(lower)->i_nlink > 1)
658 return true;
659
660 return false;
661}
662
Amir Goldstein9f4ec902017-09-24 17:36:26 +0300663/* Caller must hold OVL_I(inode)->lock */
Amir Goldsteincaf70cb2017-06-21 13:46:12 +0300664static void ovl_cleanup_index(struct dentry *dentry)
665{
Amir Goldsteine7dd0e72017-10-24 17:38:33 +0300666 struct dentry *indexdir = ovl_indexdir(dentry->d_sb);
667 struct inode *dir = indexdir->d_inode;
Amir Goldsteincaf70cb2017-06-21 13:46:12 +0300668 struct dentry *lowerdentry = ovl_dentry_lower(dentry);
669 struct dentry *upperdentry = ovl_dentry_upper(dentry);
670 struct dentry *index = NULL;
671 struct inode *inode;
672 struct qstr name;
673 int err;
674
675 err = ovl_get_index_name(lowerdentry, &name);
676 if (err)
677 goto fail;
678
679 inode = d_inode(upperdentry);
Amir Goldstein89a17552017-09-26 07:40:37 +0300680 if (!S_ISDIR(inode->i_mode) && inode->i_nlink != 1) {
Amir Goldsteincaf70cb2017-06-21 13:46:12 +0300681 pr_warn_ratelimited("overlayfs: cleanup linked index (%pd2, ino=%lu, nlink=%u)\n",
682 upperdentry, inode->i_ino, inode->i_nlink);
683 /*
684 * We either have a bug with persistent union nlink or a lower
685 * hardlink was added while overlay is mounted. Adding a lower
686 * hardlink and then unlinking all overlay hardlinks would drop
687 * overlay nlink to zero before all upper inodes are unlinked.
688 * As a safety measure, when that situation is detected, set
689 * the overlay nlink to the index inode nlink minus one for the
690 * index entry itself.
691 */
692 set_nlink(d_inode(dentry), inode->i_nlink - 1);
693 ovl_set_nlink_upper(dentry);
694 goto out;
695 }
696
697 inode_lock_nested(dir, I_MUTEX_PARENT);
Amir Goldsteine7dd0e72017-10-24 17:38:33 +0300698 index = lookup_one_len(name.name, indexdir, name.len);
Amir Goldsteincaf70cb2017-06-21 13:46:12 +0300699 err = PTR_ERR(index);
Amir Goldsteine7dd0e72017-10-24 17:38:33 +0300700 if (IS_ERR(index)) {
Amir Goldstein9f4ec902017-09-24 17:36:26 +0300701 index = NULL;
Amir Goldsteine7dd0e72017-10-24 17:38:33 +0300702 } else if (ovl_index_all(dentry->d_sb)) {
703 /* Whiteout orphan index to block future open by handle */
704 err = ovl_cleanup_and_whiteout(indexdir, dir, index);
705 } else {
706 /* Cleanup orphan index entries */
707 err = ovl_cleanup(dir, index);
708 }
Amir Goldstein9f4ec902017-09-24 17:36:26 +0300709
Amir Goldsteincaf70cb2017-06-21 13:46:12 +0300710 inode_unlock(dir);
711 if (err)
712 goto fail;
713
714out:
715 dput(index);
716 return;
717
718fail:
719 pr_err("overlayfs: cleanup index of '%pd2' failed (%i)\n", dentry, err);
720 goto out;
721}
722
Amir Goldstein5f8415d2017-06-20 15:35:14 +0300723/*
724 * Operations that change overlay inode and upper inode nlink need to be
725 * synchronized with copy up for persistent nlink accounting.
726 */
727int ovl_nlink_start(struct dentry *dentry, bool *locked)
728{
729 struct ovl_inode *oi = OVL_I(d_inode(dentry));
730 const struct cred *old_cred;
731 int err;
732
Amir Goldstein89a17552017-09-26 07:40:37 +0300733 if (!d_inode(dentry))
Amir Goldstein5f8415d2017-06-20 15:35:14 +0300734 return 0;
735
736 /*
737 * With inodes index is enabled, we store the union overlay nlink
Amir Goldstein24b33ee2017-09-26 07:55:26 +0300738 * in an xattr on the index inode. When whiting out an indexed lower,
Amir Goldstein5f8415d2017-06-20 15:35:14 +0300739 * we need to decrement the overlay persistent nlink, but before the
740 * first copy up, we have no upper index inode to store the xattr.
741 *
Amir Goldstein24b33ee2017-09-26 07:55:26 +0300742 * As a workaround, before whiteout/rename over an indexed lower,
Amir Goldstein5f8415d2017-06-20 15:35:14 +0300743 * copy up to create the upper index. Creating the upper index will
744 * initialize the overlay nlink, so it could be dropped if unlink
745 * or rename succeeds.
746 *
747 * TODO: implement metadata only index copy up when called with
748 * ovl_copy_up_flags(dentry, O_PATH).
749 */
Amir Goldstein24b33ee2017-09-26 07:55:26 +0300750 if (ovl_need_index(dentry) && !ovl_dentry_has_upper_alias(dentry)) {
Amir Goldstein5f8415d2017-06-20 15:35:14 +0300751 err = ovl_copy_up(dentry);
752 if (err)
753 return err;
754 }
755
756 err = mutex_lock_interruptible(&oi->lock);
757 if (err)
758 return err;
759
Amir Goldstein89a17552017-09-26 07:40:37 +0300760 if (d_is_dir(dentry) || !ovl_test_flag(OVL_INDEX, d_inode(dentry)))
Amir Goldstein5f8415d2017-06-20 15:35:14 +0300761 goto out;
762
763 old_cred = ovl_override_creds(dentry->d_sb);
764 /*
765 * The overlay inode nlink should be incremented/decremented IFF the
766 * upper operation succeeds, along with nlink change of upper inode.
767 * Therefore, before link/unlink/rename, we store the union nlink
768 * value relative to the upper inode nlink in an upper inode xattr.
769 */
770 err = ovl_set_nlink_upper(dentry);
771 revert_creds(old_cred);
772
773out:
774 if (err)
775 mutex_unlock(&oi->lock);
776 else
777 *locked = true;
778
779 return err;
780}
781
782void ovl_nlink_end(struct dentry *dentry, bool locked)
783{
Amir Goldsteincaf70cb2017-06-21 13:46:12 +0300784 if (locked) {
785 if (ovl_test_flag(OVL_INDEX, d_inode(dentry)) &&
786 d_inode(dentry)->i_nlink == 0) {
787 const struct cred *old_cred;
788
789 old_cred = ovl_override_creds(dentry->d_sb);
790 ovl_cleanup_index(dentry);
791 revert_creds(old_cred);
792 }
793
Amir Goldstein5f8415d2017-06-20 15:35:14 +0300794 mutex_unlock(&OVL_I(d_inode(dentry))->lock);
Amir Goldsteincaf70cb2017-06-21 13:46:12 +0300795 }
Amir Goldstein5f8415d2017-06-20 15:35:14 +0300796}
Amir Goldstein5820dc02017-09-25 16:39:55 +0300797
798int ovl_lock_rename_workdir(struct dentry *workdir, struct dentry *upperdir)
799{
800 /* Workdir should not be the same as upperdir */
801 if (workdir == upperdir)
802 goto err;
803
804 /* Workdir should not be subdir of upperdir and vice versa */
805 if (lock_rename(workdir, upperdir) != NULL)
806 goto err_unlock;
807
808 return 0;
809
810err_unlock:
811 unlock_rename(workdir, upperdir);
812err:
813 pr_err("overlayfs: failed to lock workdir+upperdir\n");
814 return -EIO;
815}
Vivek Goyal9d3dfea2018-05-11 11:49:28 -0400816
817/* err < 0, 0 if no metacopy xattr, 1 if metacopy xattr found */
818int ovl_check_metacopy_xattr(struct dentry *dentry)
819{
820 int res;
821
822 /* Only regular files can have metacopy xattr */
823 if (!S_ISREG(d_inode(dentry)->i_mode))
824 return 0;
825
826 res = vfs_getxattr(dentry, OVL_XATTR_METACOPY, NULL, 0);
827 if (res < 0) {
828 if (res == -ENODATA || res == -EOPNOTSUPP)
829 return 0;
830 goto out;
831 }
832
833 return 1;
834out:
835 pr_warn_ratelimited("overlayfs: failed to get metacopy (%i)\n", res);
836 return res;
837}
Vivek Goyal67d756c22018-05-11 11:49:30 -0400838
839bool ovl_is_metacopy_dentry(struct dentry *dentry)
840{
841 struct ovl_entry *oe = dentry->d_fsdata;
842
843 if (!d_is_reg(dentry))
844 return false;
845
846 if (ovl_dentry_upper(dentry)) {
847 if (!ovl_has_upperdata(d_inode(dentry)))
848 return true;
849 return false;
850 }
851
852 return (oe->numlower > 1);
853}