Merge tag 'locks-v4.15-1' of git://git.kernel.org/pub/scm/linux/kernel/git/jlayton...
[sfrench/cifs-2.6.git] / fs / overlayfs / inode.c
1 /*
2  *
3  * Copyright (C) 2011 Novell 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/slab.h>
12 #include <linux/cred.h>
13 #include <linux/xattr.h>
14 #include <linux/posix_acl.h>
15 #include <linux/ratelimit.h>
16 #include "overlayfs.h"
17
18 int ovl_setattr(struct dentry *dentry, struct iattr *attr)
19 {
20         int err;
21         struct dentry *upperdentry;
22         const struct cred *old_cred;
23
24         /*
25          * Check for permissions before trying to copy-up.  This is redundant
26          * since it will be rechecked later by ->setattr() on upper dentry.  But
27          * without this, copy-up can be triggered by just about anybody.
28          *
29          * We don't initialize inode->size, which just means that
30          * inode_newsize_ok() will always check against MAX_LFS_FILESIZE and not
31          * check for a swapfile (which this won't be anyway).
32          */
33         err = setattr_prepare(dentry, attr);
34         if (err)
35                 return err;
36
37         err = ovl_want_write(dentry);
38         if (err)
39                 goto out;
40
41         err = ovl_copy_up(dentry);
42         if (!err) {
43                 upperdentry = ovl_dentry_upper(dentry);
44
45                 if (attr->ia_valid & (ATTR_KILL_SUID|ATTR_KILL_SGID))
46                         attr->ia_valid &= ~ATTR_MODE;
47
48                 inode_lock(upperdentry->d_inode);
49                 old_cred = ovl_override_creds(dentry->d_sb);
50                 err = notify_change(upperdentry, attr, NULL);
51                 revert_creds(old_cred);
52                 if (!err)
53                         ovl_copyattr(upperdentry->d_inode, dentry->d_inode);
54                 inode_unlock(upperdentry->d_inode);
55         }
56         ovl_drop_write(dentry);
57 out:
58         return err;
59 }
60
61 int ovl_getattr(const struct path *path, struct kstat *stat,
62                 u32 request_mask, unsigned int flags)
63 {
64         struct dentry *dentry = path->dentry;
65         enum ovl_path_type type;
66         struct path realpath;
67         const struct cred *old_cred;
68         bool is_dir = S_ISDIR(dentry->d_inode->i_mode);
69         int err;
70
71         type = ovl_path_real(dentry, &realpath);
72         old_cred = ovl_override_creds(dentry->d_sb);
73         err = vfs_getattr(&realpath, stat, request_mask, flags);
74         if (err)
75                 goto out;
76
77         /*
78          * When all layers are on the same fs, all real inode number are
79          * unique, so we use the overlay st_dev, which is friendly to du -x.
80          *
81          * We also use st_ino of the copy up origin, if we know it.
82          * This guaranties constant st_dev/st_ino across copy up.
83          *
84          * If filesystem supports NFS export ops, this also guaranties
85          * persistent st_ino across mount cycle.
86          */
87         if (ovl_same_sb(dentry->d_sb)) {
88                 if (OVL_TYPE_ORIGIN(type)) {
89                         struct kstat lowerstat;
90                         u32 lowermask = STATX_INO | (!is_dir ? STATX_NLINK : 0);
91
92                         ovl_path_lower(dentry, &realpath);
93                         err = vfs_getattr(&realpath, &lowerstat,
94                                           lowermask, flags);
95                         if (err)
96                                 goto out;
97
98                         WARN_ON_ONCE(stat->dev != lowerstat.dev);
99                         /*
100                          * Lower hardlinks may be broken on copy up to different
101                          * upper files, so we cannot use the lower origin st_ino
102                          * for those different files, even for the same fs case.
103                          * With inodes index enabled, it is safe to use st_ino
104                          * of an indexed hardlinked origin. The index validates
105                          * that the upper hardlink is not broken.
106                          */
107                         if (is_dir || lowerstat.nlink == 1 ||
108                             ovl_test_flag(OVL_INDEX, d_inode(dentry)))
109                                 stat->ino = lowerstat.ino;
110                 }
111                 stat->dev = dentry->d_sb->s_dev;
112         } else if (is_dir) {
113                 /*
114                  * If not all layers are on the same fs the pair {real st_ino;
115                  * overlay st_dev} is not unique, so use the non persistent
116                  * overlay st_ino.
117                  *
118                  * Always use the overlay st_dev for directories, so 'find
119                  * -xdev' will scan the entire overlay mount and won't cross the
120                  * overlay mount boundaries.
121                  */
122                 stat->dev = dentry->d_sb->s_dev;
123                 stat->ino = dentry->d_inode->i_ino;
124         }
125
126         /*
127          * It's probably not worth it to count subdirs to get the
128          * correct link count.  nlink=1 seems to pacify 'find' and
129          * other utilities.
130          */
131         if (is_dir && OVL_TYPE_MERGE(type))
132                 stat->nlink = 1;
133
134         /*
135          * Return the overlay inode nlinks for indexed upper inodes.
136          * Overlay inode nlink counts the union of the upper hardlinks
137          * and non-covered lower hardlinks. It does not include the upper
138          * index hardlink.
139          */
140         if (!is_dir && ovl_test_flag(OVL_INDEX, d_inode(dentry)))
141                 stat->nlink = dentry->d_inode->i_nlink;
142
143 out:
144         revert_creds(old_cred);
145
146         return err;
147 }
148
149 int ovl_permission(struct inode *inode, int mask)
150 {
151         struct inode *upperinode = ovl_inode_upper(inode);
152         struct inode *realinode = upperinode ?: ovl_inode_lower(inode);
153         const struct cred *old_cred;
154         int err;
155
156         /* Careful in RCU walk mode */
157         if (!realinode) {
158                 WARN_ON(!(mask & MAY_NOT_BLOCK));
159                 return -ECHILD;
160         }
161
162         /*
163          * Check overlay inode with the creds of task and underlying inode
164          * with creds of mounter
165          */
166         err = generic_permission(inode, mask);
167         if (err)
168                 return err;
169
170         old_cred = ovl_override_creds(inode->i_sb);
171         if (!upperinode &&
172             !special_file(realinode->i_mode) && mask & MAY_WRITE) {
173                 mask &= ~(MAY_WRITE | MAY_APPEND);
174                 /* Make sure mounter can read file for copy up later */
175                 mask |= MAY_READ;
176         }
177         err = inode_permission(realinode, mask);
178         revert_creds(old_cred);
179
180         return err;
181 }
182
183 static const char *ovl_get_link(struct dentry *dentry,
184                                 struct inode *inode,
185                                 struct delayed_call *done)
186 {
187         const struct cred *old_cred;
188         const char *p;
189
190         if (!dentry)
191                 return ERR_PTR(-ECHILD);
192
193         old_cred = ovl_override_creds(dentry->d_sb);
194         p = vfs_get_link(ovl_dentry_real(dentry), done);
195         revert_creds(old_cred);
196         return p;
197 }
198
199 bool ovl_is_private_xattr(const char *name)
200 {
201         return strncmp(name, OVL_XATTR_PREFIX,
202                        sizeof(OVL_XATTR_PREFIX) - 1) == 0;
203 }
204
205 int ovl_xattr_set(struct dentry *dentry, struct inode *inode, const char *name,
206                   const void *value, size_t size, int flags)
207 {
208         int err;
209         struct dentry *upperdentry = ovl_i_dentry_upper(inode);
210         struct dentry *realdentry = upperdentry ?: ovl_dentry_lower(dentry);
211         const struct cred *old_cred;
212
213         err = ovl_want_write(dentry);
214         if (err)
215                 goto out;
216
217         if (!value && !upperdentry) {
218                 err = vfs_getxattr(realdentry, name, NULL, 0);
219                 if (err < 0)
220                         goto out_drop_write;
221         }
222
223         if (!upperdentry) {
224                 err = ovl_copy_up(dentry);
225                 if (err)
226                         goto out_drop_write;
227
228                 realdentry = ovl_dentry_upper(dentry);
229         }
230
231         old_cred = ovl_override_creds(dentry->d_sb);
232         if (value)
233                 err = vfs_setxattr(realdentry, name, value, size, flags);
234         else {
235                 WARN_ON(flags != XATTR_REPLACE);
236                 err = vfs_removexattr(realdentry, name);
237         }
238         revert_creds(old_cred);
239
240 out_drop_write:
241         ovl_drop_write(dentry);
242 out:
243         return err;
244 }
245
246 int ovl_xattr_get(struct dentry *dentry, struct inode *inode, const char *name,
247                   void *value, size_t size)
248 {
249         ssize_t res;
250         const struct cred *old_cred;
251         struct dentry *realdentry =
252                 ovl_i_dentry_upper(inode) ?: ovl_dentry_lower(dentry);
253
254         old_cred = ovl_override_creds(dentry->d_sb);
255         res = vfs_getxattr(realdentry, name, value, size);
256         revert_creds(old_cred);
257         return res;
258 }
259
260 static bool ovl_can_list(const char *s)
261 {
262         /* List all non-trusted xatts */
263         if (strncmp(s, XATTR_TRUSTED_PREFIX, XATTR_TRUSTED_PREFIX_LEN) != 0)
264                 return true;
265
266         /* Never list trusted.overlay, list other trusted for superuser only */
267         return !ovl_is_private_xattr(s) && capable(CAP_SYS_ADMIN);
268 }
269
270 ssize_t ovl_listxattr(struct dentry *dentry, char *list, size_t size)
271 {
272         struct dentry *realdentry = ovl_dentry_real(dentry);
273         ssize_t res;
274         size_t len;
275         char *s;
276         const struct cred *old_cred;
277
278         old_cred = ovl_override_creds(dentry->d_sb);
279         res = vfs_listxattr(realdentry, list, size);
280         revert_creds(old_cred);
281         if (res <= 0 || size == 0)
282                 return res;
283
284         /* filter out private xattrs */
285         for (s = list, len = res; len;) {
286                 size_t slen = strnlen(s, len) + 1;
287
288                 /* underlying fs providing us with an broken xattr list? */
289                 if (WARN_ON(slen > len))
290                         return -EIO;
291
292                 len -= slen;
293                 if (!ovl_can_list(s)) {
294                         res -= slen;
295                         memmove(s, s + slen, len);
296                 } else {
297                         s += slen;
298                 }
299         }
300
301         return res;
302 }
303
304 struct posix_acl *ovl_get_acl(struct inode *inode, int type)
305 {
306         struct inode *realinode = ovl_inode_real(inode);
307         const struct cred *old_cred;
308         struct posix_acl *acl;
309
310         if (!IS_ENABLED(CONFIG_FS_POSIX_ACL) || !IS_POSIXACL(realinode))
311                 return NULL;
312
313         old_cred = ovl_override_creds(inode->i_sb);
314         acl = get_acl(realinode, type);
315         revert_creds(old_cred);
316
317         return acl;
318 }
319
320 static bool ovl_open_need_copy_up(struct dentry *dentry, int flags)
321 {
322         if (ovl_dentry_upper(dentry) &&
323             ovl_dentry_has_upper_alias(dentry))
324                 return false;
325
326         if (special_file(d_inode(dentry)->i_mode))
327                 return false;
328
329         if (!(OPEN_FMODE(flags) & FMODE_WRITE) && !(flags & O_TRUNC))
330                 return false;
331
332         return true;
333 }
334
335 int ovl_open_maybe_copy_up(struct dentry *dentry, unsigned int file_flags)
336 {
337         int err = 0;
338
339         if (ovl_open_need_copy_up(dentry, file_flags)) {
340                 err = ovl_want_write(dentry);
341                 if (!err) {
342                         err = ovl_copy_up_flags(dentry, file_flags);
343                         ovl_drop_write(dentry);
344                 }
345         }
346
347         return err;
348 }
349
350 int ovl_update_time(struct inode *inode, struct timespec *ts, int flags)
351 {
352         struct dentry *alias;
353         struct path upperpath;
354
355         if (!(flags & S_ATIME))
356                 return 0;
357
358         alias = d_find_any_alias(inode);
359         if (!alias)
360                 return 0;
361
362         ovl_path_upper(alias, &upperpath);
363         if (upperpath.dentry) {
364                 touch_atime(&upperpath);
365                 inode->i_atime = d_inode(upperpath.dentry)->i_atime;
366         }
367
368         dput(alias);
369
370         return 0;
371 }
372
373 static const struct inode_operations ovl_file_inode_operations = {
374         .setattr        = ovl_setattr,
375         .permission     = ovl_permission,
376         .getattr        = ovl_getattr,
377         .listxattr      = ovl_listxattr,
378         .get_acl        = ovl_get_acl,
379         .update_time    = ovl_update_time,
380 };
381
382 static const struct inode_operations ovl_symlink_inode_operations = {
383         .setattr        = ovl_setattr,
384         .get_link       = ovl_get_link,
385         .getattr        = ovl_getattr,
386         .listxattr      = ovl_listxattr,
387         .update_time    = ovl_update_time,
388 };
389
390 /*
391  * It is possible to stack overlayfs instance on top of another
392  * overlayfs instance as lower layer. We need to annonate the
393  * stackable i_mutex locks according to stack level of the super
394  * block instance. An overlayfs instance can never be in stack
395  * depth 0 (there is always a real fs below it).  An overlayfs
396  * inode lock will use the lockdep annotaion ovl_i_mutex_key[depth].
397  *
398  * For example, here is a snip from /proc/lockdep_chains after
399  * dir_iterate of nested overlayfs:
400  *
401  * [...] &ovl_i_mutex_dir_key[depth]   (stack_depth=2)
402  * [...] &ovl_i_mutex_dir_key[depth]#2 (stack_depth=1)
403  * [...] &type->i_mutex_dir_key        (stack_depth=0)
404  */
405 #define OVL_MAX_NESTING FILESYSTEM_MAX_STACK_DEPTH
406
407 static inline void ovl_lockdep_annotate_inode_mutex_key(struct inode *inode)
408 {
409 #ifdef CONFIG_LOCKDEP
410         static struct lock_class_key ovl_i_mutex_key[OVL_MAX_NESTING];
411         static struct lock_class_key ovl_i_mutex_dir_key[OVL_MAX_NESTING];
412
413         int depth = inode->i_sb->s_stack_depth - 1;
414
415         if (WARN_ON_ONCE(depth < 0 || depth >= OVL_MAX_NESTING))
416                 depth = 0;
417
418         if (S_ISDIR(inode->i_mode))
419                 lockdep_set_class(&inode->i_rwsem, &ovl_i_mutex_dir_key[depth]);
420         else
421                 lockdep_set_class(&inode->i_rwsem, &ovl_i_mutex_key[depth]);
422 #endif
423 }
424
425 static void ovl_fill_inode(struct inode *inode, umode_t mode, dev_t rdev)
426 {
427         inode->i_ino = get_next_ino();
428         inode->i_mode = mode;
429         inode->i_flags |= S_NOCMTIME;
430 #ifdef CONFIG_FS_POSIX_ACL
431         inode->i_acl = inode->i_default_acl = ACL_DONT_CACHE;
432 #endif
433
434         ovl_lockdep_annotate_inode_mutex_key(inode);
435
436         switch (mode & S_IFMT) {
437         case S_IFREG:
438                 inode->i_op = &ovl_file_inode_operations;
439                 break;
440
441         case S_IFDIR:
442                 inode->i_op = &ovl_dir_inode_operations;
443                 inode->i_fop = &ovl_dir_operations;
444                 break;
445
446         case S_IFLNK:
447                 inode->i_op = &ovl_symlink_inode_operations;
448                 break;
449
450         default:
451                 inode->i_op = &ovl_file_inode_operations;
452                 init_special_inode(inode, mode, rdev);
453                 break;
454         }
455 }
456
457 /*
458  * With inodes index enabled, an overlay inode nlink counts the union of upper
459  * hardlinks and non-covered lower hardlinks. During the lifetime of a non-pure
460  * upper inode, the following nlink modifying operations can happen:
461  *
462  * 1. Lower hardlink copy up
463  * 2. Upper hardlink created, unlinked or renamed over
464  * 3. Lower hardlink whiteout or renamed over
465  *
466  * For the first, copy up case, the union nlink does not change, whether the
467  * operation succeeds or fails, but the upper inode nlink may change.
468  * Therefore, before copy up, we store the union nlink value relative to the
469  * lower inode nlink in the index inode xattr trusted.overlay.nlink.
470  *
471  * For the second, upper hardlink case, the union nlink should be incremented
472  * or decremented IFF the operation succeeds, aligned with nlink change of the
473  * upper inode. Therefore, before link/unlink/rename, we store the union nlink
474  * value relative to the upper inode nlink in the index inode.
475  *
476  * For the last, lower cover up case, we simplify things by preceding the
477  * whiteout or cover up with copy up. This makes sure that there is an index
478  * upper inode where the nlink xattr can be stored before the copied up upper
479  * entry is unlink.
480  */
481 #define OVL_NLINK_ADD_UPPER     (1 << 0)
482
483 /*
484  * On-disk format for indexed nlink:
485  *
486  * nlink relative to the upper inode - "U[+-]NUM"
487  * nlink relative to the lower inode - "L[+-]NUM"
488  */
489
490 static int ovl_set_nlink_common(struct dentry *dentry,
491                                 struct dentry *realdentry, const char *format)
492 {
493         struct inode *inode = d_inode(dentry);
494         struct inode *realinode = d_inode(realdentry);
495         char buf[13];
496         int len;
497
498         len = snprintf(buf, sizeof(buf), format,
499                        (int) (inode->i_nlink - realinode->i_nlink));
500
501         if (WARN_ON(len >= sizeof(buf)))
502                 return -EIO;
503
504         return ovl_do_setxattr(ovl_dentry_upper(dentry),
505                                OVL_XATTR_NLINK, buf, len, 0);
506 }
507
508 int ovl_set_nlink_upper(struct dentry *dentry)
509 {
510         return ovl_set_nlink_common(dentry, ovl_dentry_upper(dentry), "U%+i");
511 }
512
513 int ovl_set_nlink_lower(struct dentry *dentry)
514 {
515         return ovl_set_nlink_common(dentry, ovl_dentry_lower(dentry), "L%+i");
516 }
517
518 unsigned int ovl_get_nlink(struct dentry *lowerdentry,
519                            struct dentry *upperdentry,
520                            unsigned int fallback)
521 {
522         int nlink_diff;
523         int nlink;
524         char buf[13];
525         int err;
526
527         if (!lowerdentry || !upperdentry || d_inode(lowerdentry)->i_nlink == 1)
528                 return fallback;
529
530         err = vfs_getxattr(upperdentry, OVL_XATTR_NLINK, &buf, sizeof(buf) - 1);
531         if (err < 0)
532                 goto fail;
533
534         buf[err] = '\0';
535         if ((buf[0] != 'L' && buf[0] != 'U') ||
536             (buf[1] != '+' && buf[1] != '-'))
537                 goto fail;
538
539         err = kstrtoint(buf + 1, 10, &nlink_diff);
540         if (err < 0)
541                 goto fail;
542
543         nlink = d_inode(buf[0] == 'L' ? lowerdentry : upperdentry)->i_nlink;
544         nlink += nlink_diff;
545
546         if (nlink <= 0)
547                 goto fail;
548
549         return nlink;
550
551 fail:
552         pr_warn_ratelimited("overlayfs: failed to get index nlink (%pd2, err=%i)\n",
553                             upperdentry, err);
554         return fallback;
555 }
556
557 struct inode *ovl_new_inode(struct super_block *sb, umode_t mode, dev_t rdev)
558 {
559         struct inode *inode;
560
561         inode = new_inode(sb);
562         if (inode)
563                 ovl_fill_inode(inode, mode, rdev);
564
565         return inode;
566 }
567
568 static int ovl_inode_test(struct inode *inode, void *data)
569 {
570         return inode->i_private == data;
571 }
572
573 static int ovl_inode_set(struct inode *inode, void *data)
574 {
575         inode->i_private = data;
576         return 0;
577 }
578
579 static bool ovl_verify_inode(struct inode *inode, struct dentry *lowerdentry,
580                              struct dentry *upperdentry)
581 {
582         /*
583          * Allow non-NULL lower inode in ovl_inode even if lowerdentry is NULL.
584          * This happens when finding a copied up overlay inode for a renamed
585          * or hardlinked overlay dentry and lower dentry cannot be followed
586          * by origin because lower fs does not support file handles.
587          */
588         if (lowerdentry && ovl_inode_lower(inode) != d_inode(lowerdentry))
589                 return false;
590
591         /*
592          * Allow non-NULL __upperdentry in inode even if upperdentry is NULL.
593          * This happens when finding a lower alias for a copied up hard link.
594          */
595         if (upperdentry && ovl_inode_upper(inode) != d_inode(upperdentry))
596                 return false;
597
598         return true;
599 }
600
601 struct inode *ovl_get_inode(struct dentry *dentry, struct dentry *upperdentry,
602                             struct dentry *index)
603 {
604         struct dentry *lowerdentry = ovl_dentry_lower(dentry);
605         struct inode *realinode = upperdentry ? d_inode(upperdentry) : NULL;
606         struct inode *inode;
607         /* Already indexed or could be indexed on copy up? */
608         bool indexed = (index || (ovl_indexdir(dentry->d_sb) && !upperdentry));
609
610         if (WARN_ON(upperdentry && indexed && !lowerdentry))
611                 return ERR_PTR(-EIO);
612
613         if (!realinode)
614                 realinode = d_inode(lowerdentry);
615
616         /*
617          * Copy up origin (lower) may exist for non-indexed upper, but we must
618          * not use lower as hash key in that case.
619          * Hash inodes that are or could be indexed by origin inode and
620          * non-indexed upper inodes that could be hard linked by upper inode.
621          */
622         if (!S_ISDIR(realinode->i_mode) && (upperdentry || indexed)) {
623                 struct inode *key = d_inode(indexed ? lowerdentry :
624                                                       upperdentry);
625                 unsigned int nlink;
626
627                 inode = iget5_locked(dentry->d_sb, (unsigned long) key,
628                                      ovl_inode_test, ovl_inode_set, key);
629                 if (!inode)
630                         goto out_nomem;
631                 if (!(inode->i_state & I_NEW)) {
632                         /*
633                          * Verify that the underlying files stored in the inode
634                          * match those in the dentry.
635                          */
636                         if (!ovl_verify_inode(inode, lowerdentry, upperdentry)) {
637                                 iput(inode);
638                                 inode = ERR_PTR(-ESTALE);
639                                 goto out;
640                         }
641
642                         dput(upperdentry);
643                         goto out;
644                 }
645
646                 nlink = ovl_get_nlink(lowerdentry, upperdentry,
647                                       realinode->i_nlink);
648                 set_nlink(inode, nlink);
649         } else {
650                 inode = new_inode(dentry->d_sb);
651                 if (!inode)
652                         goto out_nomem;
653         }
654         ovl_fill_inode(inode, realinode->i_mode, realinode->i_rdev);
655         ovl_inode_init(inode, upperdentry, lowerdentry);
656
657         if (upperdentry && ovl_is_impuredir(upperdentry))
658                 ovl_set_flag(OVL_IMPURE, inode);
659
660         if (inode->i_state & I_NEW)
661                 unlock_new_inode(inode);
662 out:
663         return inode;
664
665 out_nomem:
666         inode = ERR_PTR(-ENOMEM);
667         goto out;
668 }