blob: bd2d193d0a2a11d516dd78d5d6910603526fe7d7 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * fs/libfs.c
3 * Library for filesystems writers.
4 */
5
Fabian Frederickac13a822014-06-04 16:06:27 -07006#include <linux/blkdev.h>
Paul Gortmaker630d9c42011-11-16 23:57:37 -05007#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07008#include <linux/pagemap.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +09009#include <linux/slab.h>
Ingo Molnar5b825c32017-02-02 17:54:15 +010010#include <linux/cred.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070011#include <linux/mount.h>
12#include <linux/vfs.h>
npiggin@suse.de7bb46a62010-05-27 01:05:33 +100013#include <linux/quotaops.h>
Ingo Molnar7cf34c72006-03-23 03:00:36 -080014#include <linux/mutex.h>
Al Viro87dc8002013-09-16 10:30:04 -040015#include <linux/namei.h>
Christoph Hellwig25961102007-10-21 16:42:05 -070016#include <linux/exportfs.h>
Al Virod5aacad2009-06-07 14:56:44 -040017#include <linux/writeback.h>
Al Viroff01bb42011-09-16 02:31:11 -040018#include <linux/buffer_head.h> /* sync_mapping_buffers */
Ingo Molnar7cf34c72006-03-23 03:00:36 -080019
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -080020#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070021
Al Viroa4464db2011-07-07 15:03:58 -040022#include "internal.h"
23
David Howellsa528d352017-01-31 16:46:22 +000024int simple_getattr(const struct path *path, struct kstat *stat,
25 u32 request_mask, unsigned int query_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -070026{
David Howellsa528d352017-01-31 16:46:22 +000027 struct inode *inode = d_inode(path->dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -070028 generic_fillattr(inode, stat);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +030029 stat->blocks = inode->i_mapping->nrpages << (PAGE_SHIFT - 9);
Linus Torvalds1da177e2005-04-16 15:20:36 -070030 return 0;
31}
Al Viro12f38872013-09-15 21:20:49 -040032EXPORT_SYMBOL(simple_getattr);
Linus Torvalds1da177e2005-04-16 15:20:36 -070033
David Howells726c3342006-06-23 02:02:58 -070034int simple_statfs(struct dentry *dentry, struct kstatfs *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -070035{
David Howells726c3342006-06-23 02:02:58 -070036 buf->f_type = dentry->d_sb->s_magic;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +030037 buf->f_bsize = PAGE_SIZE;
Linus Torvalds1da177e2005-04-16 15:20:36 -070038 buf->f_namelen = NAME_MAX;
39 return 0;
40}
Al Viro12f38872013-09-15 21:20:49 -040041EXPORT_SYMBOL(simple_statfs);
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
43/*
44 * Retaining negative dentries for an in-memory filesystem just wastes
45 * memory and lookup time: arrange for them to be deleted immediately.
46 */
Al Virob26d4cd2013-10-25 18:47:37 -040047int always_delete_dentry(const struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -070048{
49 return 1;
50}
Al Virob26d4cd2013-10-25 18:47:37 -040051EXPORT_SYMBOL(always_delete_dentry);
52
53const struct dentry_operations simple_dentry_operations = {
54 .d_delete = always_delete_dentry,
55};
56EXPORT_SYMBOL(simple_dentry_operations);
Linus Torvalds1da177e2005-04-16 15:20:36 -070057
58/*
59 * Lookup the data. This is trivial - if the dentry didn't already
60 * exist, we know it is negative. Set d_op to delete negative dentries.
61 */
Al Viro00cd8dd2012-06-10 17:13:09 -040062struct dentry *simple_lookup(struct inode *dir, struct dentry *dentry, unsigned int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -070063{
Linus Torvalds1da177e2005-04-16 15:20:36 -070064 if (dentry->d_name.len > NAME_MAX)
65 return ERR_PTR(-ENAMETOOLONG);
Al Viro74931da2013-07-14 17:43:25 +040066 if (!dentry->d_sb->s_d_op)
67 d_set_d_op(dentry, &simple_dentry_operations);
Linus Torvalds1da177e2005-04-16 15:20:36 -070068 d_add(dentry, NULL);
69 return NULL;
70}
Al Viro12f38872013-09-15 21:20:49 -040071EXPORT_SYMBOL(simple_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -070072
Linus Torvalds1da177e2005-04-16 15:20:36 -070073int dcache_dir_open(struct inode *inode, struct file *file)
74{
Al Viroba65dc52016-06-10 11:32:47 -040075 file->private_data = d_alloc_cursor(file->f_path.dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
77 return file->private_data ? 0 : -ENOMEM;
78}
Al Viro12f38872013-09-15 21:20:49 -040079EXPORT_SYMBOL(dcache_dir_open);
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
81int dcache_dir_close(struct inode *inode, struct file *file)
82{
83 dput(file->private_data);
84 return 0;
85}
Al Viro12f38872013-09-15 21:20:49 -040086EXPORT_SYMBOL(dcache_dir_close);
Linus Torvalds1da177e2005-04-16 15:20:36 -070087
Al Viro4f42c1b2016-06-06 19:37:13 -040088/* parent is locked at least shared */
Al Viro664ec2d2019-09-15 12:12:39 -040089/*
90 * Returns an element of siblings' list.
91 * We are looking for <count>th positive after <p>; if
92 * found, dentry is grabbed and passed to caller via *<res>.
93 * If no such element exists, the anchor of list is returned
94 * and *<res> is set to NULL.
95 */
96static struct list_head *scan_positives(struct dentry *cursor,
97 struct list_head *p,
98 loff_t count,
99 struct dentry **res)
Al Viro4f42c1b2016-06-06 19:37:13 -0400100{
Al Viro664ec2d2019-09-15 12:12:39 -0400101 struct dentry *dentry = cursor->d_parent, *found = NULL;
Al Viro4f42c1b2016-06-06 19:37:13 -0400102
Al Viro664ec2d2019-09-15 12:12:39 -0400103 spin_lock(&dentry->d_lock);
104 while ((p = p->next) != &dentry->d_subdirs) {
Al Viro4f42c1b2016-06-06 19:37:13 -0400105 struct dentry *d = list_entry(p, struct dentry, d_child);
Al Viro664ec2d2019-09-15 12:12:39 -0400106 // we must at least skip cursors, to avoid livelocks
107 if (d->d_flags & DCACHE_DENTRY_CURSOR)
108 continue;
109 if (simple_positive(d) && !--count) {
110 spin_lock_nested(&d->d_lock, DENTRY_D_LOCK_NESTED);
111 if (simple_positive(d))
112 found = dget_dlock(d);
113 spin_unlock(&d->d_lock);
114 if (likely(found))
115 break;
116 count = 1;
117 }
118 if (need_resched()) {
119 list_move(&cursor->d_child, p);
120 p = &cursor->d_child;
121 spin_unlock(&dentry->d_lock);
122 cond_resched();
123 spin_lock(&dentry->d_lock);
Al Viro4f42c1b2016-06-06 19:37:13 -0400124 }
125 }
Al Viro664ec2d2019-09-15 12:12:39 -0400126 spin_unlock(&dentry->d_lock);
127 dput(*res);
128 *res = found;
129 return p;
Al Viro4f42c1b2016-06-06 19:37:13 -0400130}
131
Andrew Morton965c8e52012-12-17 15:59:39 -0800132loff_t dcache_dir_lseek(struct file *file, loff_t offset, int whence)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133{
Nick Piggin2fd6b7f2011-01-07 17:49:34 +1100134 struct dentry *dentry = file->f_path.dentry;
Andrew Morton965c8e52012-12-17 15:59:39 -0800135 switch (whence) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 case 1:
137 offset += file->f_pos;
138 case 0:
139 if (offset >= 0)
140 break;
141 default:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 return -EINVAL;
143 }
144 if (offset != file->f_pos) {
Al Viro664ec2d2019-09-15 12:12:39 -0400145 struct dentry *cursor = file->private_data;
146 struct dentry *to = NULL;
147 struct list_head *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
Al Viro664ec2d2019-09-15 12:12:39 -0400149 file->f_pos = offset;
150 inode_lock_shared(dentry->d_inode);
151
152 if (file->f_pos > 2) {
153 p = scan_positives(cursor, &dentry->d_subdirs,
154 file->f_pos - 2, &to);
155 spin_lock(&dentry->d_lock);
156 list_move(&cursor->d_child, p);
157 spin_unlock(&dentry->d_lock);
158 } else {
159 spin_lock(&dentry->d_lock);
160 list_del_init(&cursor->d_child);
161 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 }
Al Viro664ec2d2019-09-15 12:12:39 -0400163
164 dput(to);
165
166 inode_unlock_shared(dentry->d_inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168 return offset;
169}
Al Viro12f38872013-09-15 21:20:49 -0400170EXPORT_SYMBOL(dcache_dir_lseek);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171
172/* Relationship between i_mode and the DT_xxx types */
173static inline unsigned char dt_type(struct inode *inode)
174{
175 return (inode->i_mode >> 12) & 15;
176}
177
178/*
179 * Directory is locked and all positive dentries in it are safe, since
180 * for ramfs-type trees they can't go away without unlink() or rmdir(),
181 * both impossible due to the lock on directory.
182 */
183
Al Viro5f99f4e2013-05-15 20:23:06 -0400184int dcache_readdir(struct file *file, struct dir_context *ctx)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185{
Al Viro5f99f4e2013-05-15 20:23:06 -0400186 struct dentry *dentry = file->f_path.dentry;
187 struct dentry *cursor = file->private_data;
Al Viro664ec2d2019-09-15 12:12:39 -0400188 struct list_head *anchor = &dentry->d_subdirs;
189 struct dentry *next = NULL;
190 struct list_head *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191
Al Viro5f99f4e2013-05-15 20:23:06 -0400192 if (!dir_emit_dots(file, ctx))
193 return 0;
Al Viro4f42c1b2016-06-06 19:37:13 -0400194
Al Viro5f99f4e2013-05-15 20:23:06 -0400195 if (ctx->pos == 2)
Al Viro664ec2d2019-09-15 12:12:39 -0400196 p = anchor;
197 else
198 p = &cursor->d_child;
199
200 while ((p = scan_positives(cursor, p, 1, &next)) != anchor) {
Al Viro5f99f4e2013-05-15 20:23:06 -0400201 if (!dir_emit(ctx, next->d_name.name, next->d_name.len,
David Howellsdea655c2015-03-17 22:26:15 +0000202 d_inode(next)->i_ino, dt_type(d_inode(next))))
Al Viro4f42c1b2016-06-06 19:37:13 -0400203 break;
Al Viro5f99f4e2013-05-15 20:23:06 -0400204 ctx->pos++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 }
Al Viro664ec2d2019-09-15 12:12:39 -0400206 spin_lock(&dentry->d_lock);
207 list_move_tail(&cursor->d_child, p);
208 spin_unlock(&dentry->d_lock);
209 dput(next);
210
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 return 0;
212}
Al Viro12f38872013-09-15 21:20:49 -0400213EXPORT_SYMBOL(dcache_readdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214
215ssize_t generic_read_dir(struct file *filp, char __user *buf, size_t siz, loff_t *ppos)
216{
217 return -EISDIR;
218}
Al Viro12f38872013-09-15 21:20:49 -0400219EXPORT_SYMBOL(generic_read_dir);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -0800221const struct file_operations simple_dir_operations = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 .open = dcache_dir_open,
223 .release = dcache_dir_close,
224 .llseek = dcache_dir_lseek,
225 .read = generic_read_dir,
Al Viro4e829012016-04-20 19:52:15 -0400226 .iterate_shared = dcache_readdir,
Christoph Hellwig1b061d92010-05-26 17:53:41 +0200227 .fsync = noop_fsync,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228};
Al Viro12f38872013-09-15 21:20:49 -0400229EXPORT_SYMBOL(simple_dir_operations);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230
Arjan van de Ven92e1d5b2007-02-12 00:55:39 -0800231const struct inode_operations simple_dir_inode_operations = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232 .lookup = simple_lookup,
233};
Al Viro12f38872013-09-15 21:20:49 -0400234EXPORT_SYMBOL(simple_dir_inode_operations);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235
Hugh Dickins759b9772007-03-05 00:30:28 -0800236static const struct super_operations simple_super_operations = {
237 .statfs = simple_statfs,
238};
239
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240/*
241 * Common helper for pseudo-filesystems (sockfs, pipefs, bdev - stuff that
242 * will never be mountable)
243 */
Andreas Gruenbacherbba0bd32016-09-29 17:48:35 +0200244struct dentry *mount_pseudo_xattr(struct file_system_type *fs_type, char *name,
245 const struct super_operations *ops, const struct xattr_handler **xattr,
Al Viroc74a1cb2011-01-12 16:59:34 -0500246 const struct dentry_operations *dops, unsigned long magic)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247{
David Howells9249e172012-06-25 12:55:37 +0100248 struct super_block *s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 struct dentry *dentry;
250 struct inode *root;
Linus Torvalds26fe5752012-05-10 13:14:12 -0700251 struct qstr d_name = QSTR_INIT(name, strlen(name));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252
Linus Torvalds1751e8a2017-11-27 13:05:09 -0800253 s = sget_userns(fs_type, NULL, set_anon_super, SB_KERNMOUNT|SB_NOUSER,
Eric W. Biederman75422722017-01-04 17:37:27 +1300254 &init_user_ns, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 if (IS_ERR(s))
Al Viro51139ad2010-07-25 23:47:46 +0400256 return ERR_CAST(s);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257
Jeff Layton89a4eb42009-08-18 14:11:08 -0700258 s->s_maxbytes = MAX_LFS_FILESIZE;
Alex Nixon3971e1a2008-07-29 22:33:03 -0700259 s->s_blocksize = PAGE_SIZE;
260 s->s_blocksize_bits = PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 s->s_magic = magic;
Hugh Dickins759b9772007-03-05 00:30:28 -0800262 s->s_op = ops ? ops : &simple_super_operations;
Andreas Gruenbacherbba0bd32016-09-29 17:48:35 +0200263 s->s_xattr = xattr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 s->s_time_gran = 1;
265 root = new_inode(s);
266 if (!root)
267 goto Enomem;
Jeff Layton1a1c9bb2007-05-08 00:32:31 -0700268 /*
269 * since this is the first inode, make it number 1. New inodes created
270 * after this must take care not to collide with it (by passing
271 * max_reserved of 1 to iunique).
272 */
273 root->i_ino = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 root->i_mode = S_IFDIR | S_IRUSR | S_IWUSR;
Deepa Dinamani078cd822016-09-14 07:48:04 -0700275 root->i_atime = root->i_mtime = root->i_ctime = current_time(root);
Al Viroa4464db2011-07-07 15:03:58 -0400276 dentry = __d_alloc(s, &d_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277 if (!dentry) {
278 iput(root);
279 goto Enomem;
280 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281 d_instantiate(dentry, root);
282 s->s_root = dentry;
Al Viroc74a1cb2011-01-12 16:59:34 -0500283 s->s_d_op = dops;
Linus Torvalds1751e8a2017-11-27 13:05:09 -0800284 s->s_flags |= SB_ACTIVE;
Al Viro51139ad2010-07-25 23:47:46 +0400285 return dget(s->s_root);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286
287Enomem:
Al Viro6f5bbff2009-05-06 01:34:22 -0400288 deactivate_locked_super(s);
Al Viro51139ad2010-07-25 23:47:46 +0400289 return ERR_PTR(-ENOMEM);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290}
Andreas Gruenbacherbba0bd32016-09-29 17:48:35 +0200291EXPORT_SYMBOL(mount_pseudo_xattr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292
Stephen Boyd20955e82012-04-05 14:25:09 -0700293int simple_open(struct inode *inode, struct file *file)
294{
295 if (inode->i_private)
296 file->private_data = inode->i_private;
297 return 0;
298}
Al Viro12f38872013-09-15 21:20:49 -0400299EXPORT_SYMBOL(simple_open);
Stephen Boyd20955e82012-04-05 14:25:09 -0700300
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301int simple_link(struct dentry *old_dentry, struct inode *dir, struct dentry *dentry)
302{
David Howellsdea655c2015-03-17 22:26:15 +0000303 struct inode *inode = d_inode(old_dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304
Deepa Dinamani078cd822016-09-14 07:48:04 -0700305 inode->i_ctime = dir->i_ctime = dir->i_mtime = current_time(inode);
Dave Hansend8c76e62006-09-30 23:29:04 -0700306 inc_nlink(inode);
Al Viro7de9c6ee2010-10-23 11:11:40 -0400307 ihold(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308 dget(dentry);
309 d_instantiate(dentry, inode);
310 return 0;
311}
Al Viro12f38872013-09-15 21:20:49 -0400312EXPORT_SYMBOL(simple_link);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314int simple_empty(struct dentry *dentry)
315{
316 struct dentry *child;
317 int ret = 0;
318
Nick Piggin2fd6b7f2011-01-07 17:49:34 +1100319 spin_lock(&dentry->d_lock);
Al Viro946e51f2014-10-26 19:19:16 -0400320 list_for_each_entry(child, &dentry->d_subdirs, d_child) {
Nick Pigginda502952011-01-07 17:49:33 +1100321 spin_lock_nested(&child->d_lock, DENTRY_D_LOCK_NESTED);
322 if (simple_positive(child)) {
323 spin_unlock(&child->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 goto out;
Nick Pigginda502952011-01-07 17:49:33 +1100325 }
326 spin_unlock(&child->d_lock);
327 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 ret = 1;
329out:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +1100330 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331 return ret;
332}
Al Viro12f38872013-09-15 21:20:49 -0400333EXPORT_SYMBOL(simple_empty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334
335int simple_unlink(struct inode *dir, struct dentry *dentry)
336{
David Howellsdea655c2015-03-17 22:26:15 +0000337 struct inode *inode = d_inode(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338
Deepa Dinamani078cd822016-09-14 07:48:04 -0700339 inode->i_ctime = dir->i_ctime = dir->i_mtime = current_time(inode);
Dave Hansen9a53c3a2006-09-30 23:29:03 -0700340 drop_nlink(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341 dput(dentry);
342 return 0;
343}
Al Viro12f38872013-09-15 21:20:49 -0400344EXPORT_SYMBOL(simple_unlink);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345
346int simple_rmdir(struct inode *dir, struct dentry *dentry)
347{
348 if (!simple_empty(dentry))
349 return -ENOTEMPTY;
350
David Howellsdea655c2015-03-17 22:26:15 +0000351 drop_nlink(d_inode(dentry));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 simple_unlink(dir, dentry);
Dave Hansen9a53c3a2006-09-30 23:29:03 -0700353 drop_nlink(dir);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 return 0;
355}
Al Viro12f38872013-09-15 21:20:49 -0400356EXPORT_SYMBOL(simple_rmdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357
358int simple_rename(struct inode *old_dir, struct dentry *old_dentry,
Miklos Szeredie0e0be82016-09-27 11:03:57 +0200359 struct inode *new_dir, struct dentry *new_dentry,
360 unsigned int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361{
David Howellsdea655c2015-03-17 22:26:15 +0000362 struct inode *inode = d_inode(old_dentry);
David Howellse36cb0b2015-01-29 12:02:35 +0000363 int they_are_dirs = d_is_dir(old_dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364
Miklos Szeredie0e0be82016-09-27 11:03:57 +0200365 if (flags & ~RENAME_NOREPLACE)
366 return -EINVAL;
367
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368 if (!simple_empty(new_dentry))
369 return -ENOTEMPTY;
370
David Howellsdea655c2015-03-17 22:26:15 +0000371 if (d_really_is_positive(new_dentry)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 simple_unlink(new_dir, new_dentry);
Al Viro841590c2011-07-21 15:49:09 -0400373 if (they_are_dirs) {
David Howellsdea655c2015-03-17 22:26:15 +0000374 drop_nlink(d_inode(new_dentry));
Dave Hansen9a53c3a2006-09-30 23:29:03 -0700375 drop_nlink(old_dir);
Al Viro841590c2011-07-21 15:49:09 -0400376 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 } else if (they_are_dirs) {
Dave Hansen9a53c3a2006-09-30 23:29:03 -0700378 drop_nlink(old_dir);
Dave Hansend8c76e62006-09-30 23:29:04 -0700379 inc_nlink(new_dir);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380 }
381
382 old_dir->i_ctime = old_dir->i_mtime = new_dir->i_ctime =
Deepa Dinamani078cd822016-09-14 07:48:04 -0700383 new_dir->i_mtime = inode->i_ctime = current_time(old_dir);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384
385 return 0;
386}
Al Viro12f38872013-09-15 21:20:49 -0400387EXPORT_SYMBOL(simple_rename);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388
npiggin@suse.de7bb46a62010-05-27 01:05:33 +1000389/**
Christoph Hellwigeef23802010-06-04 11:30:01 +0200390 * simple_setattr - setattr for simple filesystem
npiggin@suse.de7bb46a62010-05-27 01:05:33 +1000391 * @dentry: dentry
392 * @iattr: iattr structure
393 *
394 * Returns 0 on success, -error on failure.
395 *
Christoph Hellwigeef23802010-06-04 11:30:01 +0200396 * simple_setattr is a simple ->setattr implementation without a proper
397 * implementation of size changes.
398 *
399 * It can either be used for in-memory filesystems or special files
400 * on simple regular filesystems. Anything that needs to change on-disk
401 * or wire state on size changes needs its own setattr method.
npiggin@suse.de7bb46a62010-05-27 01:05:33 +1000402 */
403int simple_setattr(struct dentry *dentry, struct iattr *iattr)
404{
David Howellsdea655c2015-03-17 22:26:15 +0000405 struct inode *inode = d_inode(dentry);
npiggin@suse.de7bb46a62010-05-27 01:05:33 +1000406 int error;
407
Jan Kara31051c82016-05-26 16:55:18 +0200408 error = setattr_prepare(dentry, iattr);
npiggin@suse.de7bb46a62010-05-27 01:05:33 +1000409 if (error)
410 return error;
411
Christoph Hellwig2c27c652010-06-04 11:30:04 +0200412 if (iattr->ia_valid & ATTR_SIZE)
413 truncate_setsize(inode, iattr->ia_size);
Christoph Hellwig6a1a90a2010-06-04 11:30:00 +0200414 setattr_copy(inode, iattr);
Christoph Hellwigeef23802010-06-04 11:30:01 +0200415 mark_inode_dirty(inode);
416 return 0;
npiggin@suse.de7bb46a62010-05-27 01:05:33 +1000417}
418EXPORT_SYMBOL(simple_setattr);
419
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420int simple_readpage(struct file *file, struct page *page)
421{
Pekka J Enbergc0d92cb2006-09-29 01:59:09 -0700422 clear_highpage(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 flush_dcache_page(page);
424 SetPageUptodate(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 unlock_page(page);
426 return 0;
427}
Al Viro12f38872013-09-15 21:20:49 -0400428EXPORT_SYMBOL(simple_readpage);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429
Nick Pigginafddba42007-10-16 01:25:01 -0700430int simple_write_begin(struct file *file, struct address_space *mapping,
431 loff_t pos, unsigned len, unsigned flags,
432 struct page **pagep, void **fsdata)
433{
434 struct page *page;
435 pgoff_t index;
Nick Pigginafddba42007-10-16 01:25:01 -0700436
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300437 index = pos >> PAGE_SHIFT;
Nick Pigginafddba42007-10-16 01:25:01 -0700438
Nick Piggin54566b22009-01-04 12:00:53 -0800439 page = grab_cache_page_write_begin(mapping, index, flags);
Nick Pigginafddba42007-10-16 01:25:01 -0700440 if (!page)
441 return -ENOMEM;
442
443 *pagep = page;
444
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300445 if (!PageUptodate(page) && (len != PAGE_SIZE)) {
446 unsigned from = pos & (PAGE_SIZE - 1);
Boaz Harrosh193cf4b2010-01-12 16:18:08 +0200447
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300448 zero_user_segments(page, 0, from, from + len, PAGE_SIZE);
Boaz Harrosh193cf4b2010-01-12 16:18:08 +0200449 }
450 return 0;
Nick Pigginafddba42007-10-16 01:25:01 -0700451}
Al Viro12f38872013-09-15 21:20:49 -0400452EXPORT_SYMBOL(simple_write_begin);
Nick Pigginafddba42007-10-16 01:25:01 -0700453
Boaz Harroshad2a722f2010-01-12 15:13:47 +0200454/**
455 * simple_write_end - .write_end helper for non-block-device FSes
456 * @available: See .write_end of address_space_operations
457 * @file: "
458 * @mapping: "
459 * @pos: "
460 * @len: "
461 * @copied: "
462 * @page: "
463 * @fsdata: "
464 *
465 * simple_write_end does the minimum needed for updating a page after writing is
466 * done. It has the same API signature as the .write_end of
467 * address_space_operations vector. So it can just be set onto .write_end for
468 * FSes that don't need any other processing. i_mutex is assumed to be held.
469 * Block based filesystems should use generic_write_end().
470 * NOTE: Even though i_size might get updated by this function, mark_inode_dirty
471 * is not called, so a filesystem that actually does store data in .write_inode
472 * should extend on what's done here with a call to mark_inode_dirty() in the
473 * case that i_size has changed.
Al Viro04fff642016-08-29 22:39:56 -0400474 *
475 * Use *ONLY* with simple_readpage()
Boaz Harroshad2a722f2010-01-12 15:13:47 +0200476 */
477int simple_write_end(struct file *file, struct address_space *mapping,
478 loff_t pos, unsigned len, unsigned copied,
479 struct page *page, void *fsdata)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480{
481 struct inode *inode = page->mapping->host;
Boaz Harroshad2a722f2010-01-12 15:13:47 +0200482 loff_t last_pos = pos + copied;
483
484 /* zero the stale part of the page if we did a short copy */
Al Viro04fff642016-08-29 22:39:56 -0400485 if (!PageUptodate(page)) {
486 if (copied < len) {
487 unsigned from = pos & (PAGE_SIZE - 1);
Boaz Harroshad2a722f2010-01-12 15:13:47 +0200488
Al Viro04fff642016-08-29 22:39:56 -0400489 zero_user(page, from + copied, len - copied);
490 }
Nick Piggin955eff52007-02-20 13:58:08 -0800491 SetPageUptodate(page);
Al Viro04fff642016-08-29 22:39:56 -0400492 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493 /*
494 * No need to use i_size_read() here, the i_size
Jes Sorensen1b1dcc12006-01-09 15:59:24 -0800495 * cannot change under us because we hold the i_mutex.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496 */
Boaz Harroshad2a722f2010-01-12 15:13:47 +0200497 if (last_pos > inode->i_size)
498 i_size_write(inode, last_pos);
499
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 set_page_dirty(page);
Nick Pigginafddba42007-10-16 01:25:01 -0700501 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300502 put_page(page);
Nick Pigginafddba42007-10-16 01:25:01 -0700503
504 return copied;
505}
Al Viro12f38872013-09-15 21:20:49 -0400506EXPORT_SYMBOL(simple_write_end);
Nick Pigginafddba42007-10-16 01:25:01 -0700507
Jeff Layton1a1c9bb2007-05-08 00:32:31 -0700508/*
509 * the inodes created here are not hashed. If you use iunique to generate
510 * unique inode values later for this filesystem, then you must take care
511 * to pass it an appropriate max_reserved value to avoid collisions.
512 */
Roberto Sassu7d683a02010-06-03 11:58:28 +0200513int simple_fill_super(struct super_block *s, unsigned long magic,
Eric Biggerscda37122017-03-25 21:15:37 -0700514 const struct tree_descr *files)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 struct inode *inode;
517 struct dentry *root;
518 struct dentry *dentry;
519 int i;
520
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300521 s->s_blocksize = PAGE_SIZE;
522 s->s_blocksize_bits = PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523 s->s_magic = magic;
Hugh Dickins759b9772007-03-05 00:30:28 -0800524 s->s_op = &simple_super_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 s->s_time_gran = 1;
526
527 inode = new_inode(s);
528 if (!inode)
529 return -ENOMEM;
Jeff Layton1a1c9bb2007-05-08 00:32:31 -0700530 /*
531 * because the root inode is 1, the files array must not contain an
532 * entry at index 1
533 */
534 inode->i_ino = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535 inode->i_mode = S_IFDIR | 0755;
Deepa Dinamani078cd822016-09-14 07:48:04 -0700536 inode->i_atime = inode->i_mtime = inode->i_ctime = current_time(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 inode->i_op = &simple_dir_inode_operations;
538 inode->i_fop = &simple_dir_operations;
Miklos Szeredibfe86842011-10-28 14:13:29 +0200539 set_nlink(inode, 2);
Al Viro48fde702012-01-08 22:15:13 -0500540 root = d_make_root(inode);
541 if (!root)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543 for (i = 0; !files->name || files->name[0]; i++, files++) {
544 if (!files->name)
545 continue;
Jeff Layton1a1c9bb2007-05-08 00:32:31 -0700546
547 /* warn if it tries to conflict with the root inode */
548 if (unlikely(i == 1))
549 printk(KERN_WARNING "%s: %s passed in a files array"
550 "with an index of 1!\n", __func__,
551 s->s_type->name);
552
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 dentry = d_alloc_name(root, files->name);
554 if (!dentry)
555 goto out;
556 inode = new_inode(s);
Konstantin Khlebnikov32096ea2011-11-01 16:12:33 +0300557 if (!inode) {
558 dput(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559 goto out;
Konstantin Khlebnikov32096ea2011-11-01 16:12:33 +0300560 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 inode->i_mode = S_IFREG | files->mode;
Deepa Dinamani078cd822016-09-14 07:48:04 -0700562 inode->i_atime = inode->i_mtime = inode->i_ctime = current_time(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563 inode->i_fop = files->ops;
564 inode->i_ino = i;
565 d_add(dentry, inode);
566 }
567 s->s_root = root;
568 return 0;
569out:
570 d_genocide(root);
Al Viro640946f2012-04-02 19:22:25 -0400571 shrink_dcache_parent(root);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572 dput(root);
573 return -ENOMEM;
574}
Al Viro12f38872013-09-15 21:20:49 -0400575EXPORT_SYMBOL(simple_fill_super);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576
577static DEFINE_SPINLOCK(pin_fs_lock);
578
Trond Myklebust1f5ce9e2006-06-09 09:34:16 -0400579int simple_pin_fs(struct file_system_type *type, struct vfsmount **mount, int *count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580{
581 struct vfsmount *mnt = NULL;
582 spin_lock(&pin_fs_lock);
583 if (unlikely(!*mount)) {
584 spin_unlock(&pin_fs_lock);
Linus Torvalds1751e8a2017-11-27 13:05:09 -0800585 mnt = vfs_kern_mount(type, SB_KERNMOUNT, type->name, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 if (IS_ERR(mnt))
587 return PTR_ERR(mnt);
588 spin_lock(&pin_fs_lock);
589 if (!*mount)
590 *mount = mnt;
591 }
592 mntget(*mount);
593 ++*count;
594 spin_unlock(&pin_fs_lock);
595 mntput(mnt);
596 return 0;
597}
Al Viro12f38872013-09-15 21:20:49 -0400598EXPORT_SYMBOL(simple_pin_fs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599
600void simple_release_fs(struct vfsmount **mount, int *count)
601{
602 struct vfsmount *mnt;
603 spin_lock(&pin_fs_lock);
604 mnt = *mount;
605 if (!--*count)
606 *mount = NULL;
607 spin_unlock(&pin_fs_lock);
608 mntput(mnt);
609}
Al Viro12f38872013-09-15 21:20:49 -0400610EXPORT_SYMBOL(simple_release_fs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611
Akinobu Mita6d1029b2008-07-04 09:59:51 -0700612/**
613 * simple_read_from_buffer - copy data from the buffer to user space
614 * @to: the user space buffer to read to
615 * @count: the maximum number of bytes to read
616 * @ppos: the current position in the buffer
617 * @from: the buffer to read from
618 * @available: the size of the buffer
619 *
620 * The simple_read_from_buffer() function reads up to @count bytes from the
621 * buffer @from at offset @ppos into the user space address starting at @to.
622 *
623 * On success, the number of bytes read is returned and the offset @ppos is
624 * advanced by this number, or negative value is returned on error.
625 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626ssize_t simple_read_from_buffer(void __user *to, size_t count, loff_t *ppos,
627 const void *from, size_t available)
628{
629 loff_t pos = *ppos;
Steven Rostedt14be2742009-09-18 13:05:42 -0700630 size_t ret;
631
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 if (pos < 0)
633 return -EINVAL;
Steven Rostedt14be2742009-09-18 13:05:42 -0700634 if (pos >= available || !count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635 return 0;
636 if (count > available - pos)
637 count = available - pos;
Steven Rostedt14be2742009-09-18 13:05:42 -0700638 ret = copy_to_user(to, from + pos, count);
639 if (ret == count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 return -EFAULT;
Steven Rostedt14be2742009-09-18 13:05:42 -0700641 count -= ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642 *ppos = pos + count;
643 return count;
644}
Al Viro12f38872013-09-15 21:20:49 -0400645EXPORT_SYMBOL(simple_read_from_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646
Akinobu Mita6d1029b2008-07-04 09:59:51 -0700647/**
Jiri Slaby6a727b42010-05-01 23:51:22 +0200648 * simple_write_to_buffer - copy data from user space to the buffer
649 * @to: the buffer to write to
650 * @available: the size of the buffer
651 * @ppos: the current position in the buffer
652 * @from: the user space buffer to read from
653 * @count: the maximum number of bytes to read
654 *
655 * The simple_write_to_buffer() function reads up to @count bytes from the user
656 * space address starting at @from into the buffer @to at offset @ppos.
657 *
658 * On success, the number of bytes written is returned and the offset @ppos is
659 * advanced by this number, or negative value is returned on error.
660 **/
661ssize_t simple_write_to_buffer(void *to, size_t available, loff_t *ppos,
662 const void __user *from, size_t count)
663{
664 loff_t pos = *ppos;
665 size_t res;
666
667 if (pos < 0)
668 return -EINVAL;
669 if (pos >= available || !count)
670 return 0;
671 if (count > available - pos)
672 count = available - pos;
673 res = copy_from_user(to + pos, from, count);
674 if (res == count)
675 return -EFAULT;
676 count -= res;
677 *ppos = pos + count;
678 return count;
679}
Al Viro12f38872013-09-15 21:20:49 -0400680EXPORT_SYMBOL(simple_write_to_buffer);
Jiri Slaby6a727b42010-05-01 23:51:22 +0200681
682/**
Akinobu Mita6d1029b2008-07-04 09:59:51 -0700683 * memory_read_from_buffer - copy data from the buffer
684 * @to: the kernel space buffer to read to
685 * @count: the maximum number of bytes to read
686 * @ppos: the current position in the buffer
687 * @from: the buffer to read from
688 * @available: the size of the buffer
689 *
690 * The memory_read_from_buffer() function reads up to @count bytes from the
691 * buffer @from at offset @ppos into the kernel space address starting at @to.
692 *
693 * On success, the number of bytes read is returned and the offset @ppos is
694 * advanced by this number, or negative value is returned on error.
695 **/
Akinobu Mita93b07112008-06-05 22:46:21 -0700696ssize_t memory_read_from_buffer(void *to, size_t count, loff_t *ppos,
697 const void *from, size_t available)
698{
699 loff_t pos = *ppos;
700
701 if (pos < 0)
702 return -EINVAL;
703 if (pos >= available)
704 return 0;
705 if (count > available - pos)
706 count = available - pos;
707 memcpy(to, from + pos, count);
708 *ppos = pos + count;
709
710 return count;
711}
Al Viro12f38872013-09-15 21:20:49 -0400712EXPORT_SYMBOL(memory_read_from_buffer);
Akinobu Mita93b07112008-06-05 22:46:21 -0700713
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714/*
715 * Transaction based IO.
716 * The file expects a single write which triggers the transaction, and then
717 * possibly a read which collects the result - which is stored in a
718 * file-local buffer.
719 */
Ingo Molnar76791ab2009-03-25 16:48:35 +0100720
721void simple_transaction_set(struct file *file, size_t n)
722{
723 struct simple_transaction_argresp *ar = file->private_data;
724
725 BUG_ON(n > SIMPLE_TRANSACTION_LIMIT);
726
727 /*
728 * The barrier ensures that ar->size will really remain zero until
729 * ar->data is ready for reading.
730 */
731 smp_mb();
732 ar->size = n;
733}
Al Viro12f38872013-09-15 21:20:49 -0400734EXPORT_SYMBOL(simple_transaction_set);
Ingo Molnar76791ab2009-03-25 16:48:35 +0100735
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736char *simple_transaction_get(struct file *file, const char __user *buf, size_t size)
737{
738 struct simple_transaction_argresp *ar;
739 static DEFINE_SPINLOCK(simple_transaction_lock);
740
741 if (size > SIMPLE_TRANSACTION_LIMIT - 1)
742 return ERR_PTR(-EFBIG);
743
744 ar = (struct simple_transaction_argresp *)get_zeroed_page(GFP_KERNEL);
745 if (!ar)
746 return ERR_PTR(-ENOMEM);
747
748 spin_lock(&simple_transaction_lock);
749
750 /* only one write allowed per open */
751 if (file->private_data) {
752 spin_unlock(&simple_transaction_lock);
753 free_page((unsigned long)ar);
754 return ERR_PTR(-EBUSY);
755 }
756
757 file->private_data = ar;
758
759 spin_unlock(&simple_transaction_lock);
760
761 if (copy_from_user(ar->data, buf, size))
762 return ERR_PTR(-EFAULT);
763
764 return ar->data;
765}
Al Viro12f38872013-09-15 21:20:49 -0400766EXPORT_SYMBOL(simple_transaction_get);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767
768ssize_t simple_transaction_read(struct file *file, char __user *buf, size_t size, loff_t *pos)
769{
770 struct simple_transaction_argresp *ar = file->private_data;
771
772 if (!ar)
773 return 0;
774 return simple_read_from_buffer(buf, size, pos, ar->data, ar->size);
775}
Al Viro12f38872013-09-15 21:20:49 -0400776EXPORT_SYMBOL(simple_transaction_read);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777
778int simple_transaction_release(struct inode *inode, struct file *file)
779{
780 free_page((unsigned long)file->private_data);
781 return 0;
782}
Al Viro12f38872013-09-15 21:20:49 -0400783EXPORT_SYMBOL(simple_transaction_release);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200785/* Simple attribute files */
786
787struct simple_attr {
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800788 int (*get)(void *, u64 *);
789 int (*set)(void *, u64);
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200790 char get_buf[24]; /* enough to store a u64 and "\n\0" */
791 char set_buf[24];
792 void *data;
793 const char *fmt; /* format for read operation */
Ingo Molnar7cf34c72006-03-23 03:00:36 -0800794 struct mutex mutex; /* protects access to these buffers */
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200795};
796
797/* simple_attr_open is called by an actual attribute open file operation
798 * to set the attribute specific access operations. */
799int simple_attr_open(struct inode *inode, struct file *file,
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800800 int (*get)(void *, u64 *), int (*set)(void *, u64),
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200801 const char *fmt)
802{
803 struct simple_attr *attr;
804
805 attr = kmalloc(sizeof(*attr), GFP_KERNEL);
806 if (!attr)
807 return -ENOMEM;
808
809 attr->get = get;
810 attr->set = set;
Theodore Ts'o8e18e292006-09-27 01:50:46 -0700811 attr->data = inode->i_private;
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200812 attr->fmt = fmt;
Ingo Molnar7cf34c72006-03-23 03:00:36 -0800813 mutex_init(&attr->mutex);
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200814
815 file->private_data = attr;
816
817 return nonseekable_open(inode, file);
818}
Al Viro12f38872013-09-15 21:20:49 -0400819EXPORT_SYMBOL_GPL(simple_attr_open);
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200820
Christoph Hellwig74bedc42008-02-08 04:20:28 -0800821int simple_attr_release(struct inode *inode, struct file *file)
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200822{
823 kfree(file->private_data);
824 return 0;
825}
Al Viro12f38872013-09-15 21:20:49 -0400826EXPORT_SYMBOL_GPL(simple_attr_release); /* GPL-only? This? Really? */
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200827
828/* read from the buffer that is filled with the get function */
829ssize_t simple_attr_read(struct file *file, char __user *buf,
830 size_t len, loff_t *ppos)
831{
832 struct simple_attr *attr;
833 size_t size;
834 ssize_t ret;
835
836 attr = file->private_data;
837
838 if (!attr->get)
839 return -EACCES;
840
Christoph Hellwig92613032008-02-08 04:20:27 -0800841 ret = mutex_lock_interruptible(&attr->mutex);
842 if (ret)
843 return ret;
844
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800845 if (*ppos) { /* continued read */
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200846 size = strlen(attr->get_buf);
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800847 } else { /* first read */
848 u64 val;
849 ret = attr->get(attr->data, &val);
850 if (ret)
851 goto out;
852
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200853 size = scnprintf(attr->get_buf, sizeof(attr->get_buf),
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800854 attr->fmt, (unsigned long long)val);
855 }
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200856
857 ret = simple_read_from_buffer(buf, len, ppos, attr->get_buf, size);
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800858out:
Ingo Molnar7cf34c72006-03-23 03:00:36 -0800859 mutex_unlock(&attr->mutex);
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200860 return ret;
861}
Al Viro12f38872013-09-15 21:20:49 -0400862EXPORT_SYMBOL_GPL(simple_attr_read);
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200863
864/* interpret the buffer as a number to call the set function with */
865ssize_t simple_attr_write(struct file *file, const char __user *buf,
866 size_t len, loff_t *ppos)
867{
868 struct simple_attr *attr;
869 u64 val;
870 size_t size;
871 ssize_t ret;
872
873 attr = file->private_data;
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200874 if (!attr->set)
875 return -EACCES;
876
Christoph Hellwig92613032008-02-08 04:20:27 -0800877 ret = mutex_lock_interruptible(&attr->mutex);
878 if (ret)
879 return ret;
880
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200881 ret = -EFAULT;
882 size = min(sizeof(attr->set_buf) - 1, len);
883 if (copy_from_user(attr->set_buf, buf, size))
884 goto out;
885
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200886 attr->set_buf[size] = '\0';
Akinobu Mitaf7b88632011-07-19 08:49:25 -0700887 val = simple_strtoll(attr->set_buf, NULL, 0);
Wu Fengguang05cc0ce2009-09-18 13:06:03 -0700888 ret = attr->set(attr->data, val);
889 if (ret == 0)
890 ret = len; /* on success, claim we got the whole input */
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200891out:
Ingo Molnar7cf34c72006-03-23 03:00:36 -0800892 mutex_unlock(&attr->mutex);
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200893 return ret;
894}
Al Viro12f38872013-09-15 21:20:49 -0400895EXPORT_SYMBOL_GPL(simple_attr_write);
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200896
Christoph Hellwig25961102007-10-21 16:42:05 -0700897/**
898 * generic_fh_to_dentry - generic helper for the fh_to_dentry export operation
899 * @sb: filesystem to do the file handle conversion on
900 * @fid: file handle to convert
901 * @fh_len: length of the file handle in bytes
902 * @fh_type: type of file handle
903 * @get_inode: filesystem callback to retrieve inode
904 *
905 * This function decodes @fid as long as it has one of the well-known
906 * Linux filehandle types and calls @get_inode on it to retrieve the
907 * inode for the object specified in the file handle.
908 */
909struct dentry *generic_fh_to_dentry(struct super_block *sb, struct fid *fid,
910 int fh_len, int fh_type, struct inode *(*get_inode)
911 (struct super_block *sb, u64 ino, u32 gen))
912{
913 struct inode *inode = NULL;
914
915 if (fh_len < 2)
916 return NULL;
917
918 switch (fh_type) {
919 case FILEID_INO32_GEN:
920 case FILEID_INO32_GEN_PARENT:
921 inode = get_inode(sb, fid->i32.ino, fid->i32.gen);
922 break;
923 }
924
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +0200925 return d_obtain_alias(inode);
Christoph Hellwig25961102007-10-21 16:42:05 -0700926}
927EXPORT_SYMBOL_GPL(generic_fh_to_dentry);
928
929/**
Yanchuan Nianca186832012-09-05 16:31:29 +0800930 * generic_fh_to_parent - generic helper for the fh_to_parent export operation
Christoph Hellwig25961102007-10-21 16:42:05 -0700931 * @sb: filesystem to do the file handle conversion on
932 * @fid: file handle to convert
933 * @fh_len: length of the file handle in bytes
934 * @fh_type: type of file handle
935 * @get_inode: filesystem callback to retrieve inode
936 *
937 * This function decodes @fid as long as it has one of the well-known
938 * Linux filehandle types and calls @get_inode on it to retrieve the
939 * inode for the _parent_ object specified in the file handle if it
940 * is specified in the file handle, or NULL otherwise.
941 */
942struct dentry *generic_fh_to_parent(struct super_block *sb, struct fid *fid,
943 int fh_len, int fh_type, struct inode *(*get_inode)
944 (struct super_block *sb, u64 ino, u32 gen))
945{
946 struct inode *inode = NULL;
947
948 if (fh_len <= 2)
949 return NULL;
950
951 switch (fh_type) {
952 case FILEID_INO32_GEN_PARENT:
953 inode = get_inode(sb, fid->i32.parent_ino,
954 (fh_len > 3 ? fid->i32.parent_gen : 0));
955 break;
956 }
957
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +0200958 return d_obtain_alias(inode);
Christoph Hellwig25961102007-10-21 16:42:05 -0700959}
960EXPORT_SYMBOL_GPL(generic_fh_to_parent);
961
Christoph Hellwig1b061d92010-05-26 17:53:41 +0200962/**
Fabian Frederickac13a822014-06-04 16:06:27 -0700963 * __generic_file_fsync - generic fsync implementation for simple filesystems
964 *
Christoph Hellwig1b061d92010-05-26 17:53:41 +0200965 * @file: file to synchronize
Fabian Frederickac13a822014-06-04 16:06:27 -0700966 * @start: start offset in bytes
967 * @end: end offset in bytes (inclusive)
Christoph Hellwig1b061d92010-05-26 17:53:41 +0200968 * @datasync: only synchronize essential metadata if true
969 *
970 * This is a generic implementation of the fsync method for simple
971 * filesystems which track all non-inode metadata in the buffers list
972 * hanging off the address_space structure.
973 */
Fabian Frederickac13a822014-06-04 16:06:27 -0700974int __generic_file_fsync(struct file *file, loff_t start, loff_t end,
975 int datasync)
Al Virod5aacad2009-06-07 14:56:44 -0400976{
Christoph Hellwig7ea80852010-05-26 17:53:25 +0200977 struct inode *inode = file->f_mapping->host;
Al Virod5aacad2009-06-07 14:56:44 -0400978 int err;
979 int ret;
980
Jeff Layton383aa542017-07-06 07:02:29 -0400981 err = file_write_and_wait_range(file, start, end);
Josef Bacik02c24a82011-07-16 20:44:56 -0400982 if (err)
983 return err;
984
Al Viro59551022016-01-22 15:40:57 -0500985 inode_lock(inode);
Al Virod5aacad2009-06-07 14:56:44 -0400986 ret = sync_mapping_buffers(inode->i_mapping);
Theodore Ts'o0ae45f62015-02-02 00:37:00 -0500987 if (!(inode->i_state & I_DIRTY_ALL))
Josef Bacik02c24a82011-07-16 20:44:56 -0400988 goto out;
Al Virod5aacad2009-06-07 14:56:44 -0400989 if (datasync && !(inode->i_state & I_DIRTY_DATASYNC))
Josef Bacik02c24a82011-07-16 20:44:56 -0400990 goto out;
Al Virod5aacad2009-06-07 14:56:44 -0400991
Christoph Hellwigc37650162010-10-06 10:48:20 +0200992 err = sync_inode_metadata(inode, 1);
Al Virod5aacad2009-06-07 14:56:44 -0400993 if (ret == 0)
994 ret = err;
Fabian Frederickac13a822014-06-04 16:06:27 -0700995
Josef Bacik02c24a82011-07-16 20:44:56 -0400996out:
Al Viro59551022016-01-22 15:40:57 -0500997 inode_unlock(inode);
Jeff Layton383aa542017-07-06 07:02:29 -0400998 /* check and advance again to catch errors after syncing out buffers */
999 err = file_check_and_advance_wb_err(file);
1000 if (ret == 0)
1001 ret = err;
1002 return ret;
Al Virod5aacad2009-06-07 14:56:44 -04001003}
Fabian Frederickac13a822014-06-04 16:06:27 -07001004EXPORT_SYMBOL(__generic_file_fsync);
1005
1006/**
1007 * generic_file_fsync - generic fsync implementation for simple filesystems
1008 * with flush
1009 * @file: file to synchronize
1010 * @start: start offset in bytes
1011 * @end: end offset in bytes (inclusive)
1012 * @datasync: only synchronize essential metadata if true
1013 *
1014 */
1015
1016int generic_file_fsync(struct file *file, loff_t start, loff_t end,
1017 int datasync)
1018{
1019 struct inode *inode = file->f_mapping->host;
1020 int err;
1021
1022 err = __generic_file_fsync(file, start, end, datasync);
1023 if (err)
1024 return err;
1025 return blkdev_issue_flush(inode->i_sb->s_bdev, GFP_KERNEL, NULL);
1026}
Christoph Hellwig1b061d92010-05-26 17:53:41 +02001027EXPORT_SYMBOL(generic_file_fsync);
1028
Patrick J. LoPresti30ca22c2010-07-22 15:03:41 -07001029/**
1030 * generic_check_addressable - Check addressability of file system
1031 * @blocksize_bits: log of file system block size
1032 * @num_blocks: number of blocks in file system
1033 *
1034 * Determine whether a file system with @num_blocks blocks (and a
1035 * block size of 2**@blocksize_bits) is addressable by the sector_t
1036 * and page cache of the system. Return 0 if so and -EFBIG otherwise.
1037 */
1038int generic_check_addressable(unsigned blocksize_bits, u64 num_blocks)
1039{
1040 u64 last_fs_block = num_blocks - 1;
Joel Beckera33f13e2010-08-16 12:10:17 -07001041 u64 last_fs_page =
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001042 last_fs_block >> (PAGE_SHIFT - blocksize_bits);
Patrick J. LoPresti30ca22c2010-07-22 15:03:41 -07001043
1044 if (unlikely(num_blocks == 0))
1045 return 0;
1046
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001047 if ((blocksize_bits < 9) || (blocksize_bits > PAGE_SHIFT))
Patrick J. LoPresti30ca22c2010-07-22 15:03:41 -07001048 return -EINVAL;
1049
Joel Beckera33f13e2010-08-16 12:10:17 -07001050 if ((last_fs_block > (sector_t)(~0ULL) >> (blocksize_bits - 9)) ||
1051 (last_fs_page > (pgoff_t)(~0ULL))) {
Patrick J. LoPresti30ca22c2010-07-22 15:03:41 -07001052 return -EFBIG;
1053 }
1054 return 0;
1055}
1056EXPORT_SYMBOL(generic_check_addressable);
1057
Christoph Hellwig1b061d92010-05-26 17:53:41 +02001058/*
1059 * No-op implementation of ->fsync for in-memory filesystems.
1060 */
Josef Bacik02c24a82011-07-16 20:44:56 -04001061int noop_fsync(struct file *file, loff_t start, loff_t end, int datasync)
Christoph Hellwig1b061d92010-05-26 17:53:41 +02001062{
1063 return 0;
1064}
Christoph Hellwig1b061d92010-05-26 17:53:41 +02001065EXPORT_SYMBOL(noop_fsync);
Al Viro87dc8002013-09-16 10:30:04 -04001066
Dan Williamsf44c7762018-03-07 15:26:44 -08001067int noop_set_page_dirty(struct page *page)
1068{
1069 /*
1070 * Unlike __set_page_dirty_no_writeback that handles dirty page
1071 * tracking in the page object, dax does all dirty tracking in
1072 * the inode address_space in response to mkwrite faults. In the
1073 * dax case we only need to worry about potentially dirty CPU
1074 * caches, not dirty page cache pages to write back.
1075 *
1076 * This callback is defined to prevent fallback to
1077 * __set_page_dirty_buffers() in set_page_dirty().
1078 */
1079 return 0;
1080}
1081EXPORT_SYMBOL_GPL(noop_set_page_dirty);
1082
1083void noop_invalidatepage(struct page *page, unsigned int offset,
1084 unsigned int length)
1085{
1086 /*
1087 * There is no page cache to invalidate in the dax case, however
1088 * we need this callback defined to prevent falling back to
1089 * block_invalidatepage() in do_invalidatepage().
1090 */
1091}
1092EXPORT_SYMBOL_GPL(noop_invalidatepage);
1093
1094ssize_t noop_direct_IO(struct kiocb *iocb, struct iov_iter *iter)
1095{
1096 /*
1097 * iomap based filesystems support direct I/O without need for
1098 * this callback. However, it still needs to be set in
1099 * inode->a_ops so that open/fcntl know that direct I/O is
1100 * generally supported.
1101 */
1102 return -EINVAL;
1103}
1104EXPORT_SYMBOL_GPL(noop_direct_IO);
1105
Al Virofceef392015-12-29 15:58:39 -05001106/* Because kfree isn't assignment-compatible with void(void*) ;-/ */
1107void kfree_link(void *p)
Al Viro87dc8002013-09-16 10:30:04 -04001108{
Al Virofceef392015-12-29 15:58:39 -05001109 kfree(p);
Al Viro87dc8002013-09-16 10:30:04 -04001110}
Al Virofceef392015-12-29 15:58:39 -05001111EXPORT_SYMBOL(kfree_link);
Al Viro69878432013-10-02 22:35:11 -04001112
1113/*
1114 * nop .set_page_dirty method so that people can use .page_mkwrite on
1115 * anon inodes.
1116 */
1117static int anon_set_page_dirty(struct page *page)
1118{
1119 return 0;
1120};
1121
1122/*
1123 * A single inode exists for all anon_inode files. Contrary to pipes,
1124 * anon_inode inodes have no associated per-instance data, so we need
1125 * only allocate one of them.
1126 */
1127struct inode *alloc_anon_inode(struct super_block *s)
1128{
1129 static const struct address_space_operations anon_aops = {
1130 .set_page_dirty = anon_set_page_dirty,
1131 };
1132 struct inode *inode = new_inode_pseudo(s);
1133
1134 if (!inode)
1135 return ERR_PTR(-ENOMEM);
1136
1137 inode->i_ino = get_next_ino();
1138 inode->i_mapping->a_ops = &anon_aops;
1139
1140 /*
1141 * Mark the inode dirty from the very beginning,
1142 * that way it will never be moved to the dirty
1143 * list because mark_inode_dirty() will think
1144 * that it already _is_ on the dirty list.
1145 */
1146 inode->i_state = I_DIRTY;
1147 inode->i_mode = S_IRUSR | S_IWUSR;
1148 inode->i_uid = current_fsuid();
1149 inode->i_gid = current_fsgid();
1150 inode->i_flags |= S_PRIVATE;
Deepa Dinamani078cd822016-09-14 07:48:04 -07001151 inode->i_atime = inode->i_mtime = inode->i_ctime = current_time(inode);
Al Viro69878432013-10-02 22:35:11 -04001152 return inode;
1153}
1154EXPORT_SYMBOL(alloc_anon_inode);
Jeff Layton1c994a02014-08-27 06:49:41 -04001155
1156/**
1157 * simple_nosetlease - generic helper for prohibiting leases
1158 * @filp: file pointer
1159 * @arg: type of lease to obtain
1160 * @flp: new lease supplied for insertion
Jeff Laytone6f5c782014-08-22 10:40:25 -04001161 * @priv: private data for lm_setup operation
Jeff Layton1c994a02014-08-27 06:49:41 -04001162 *
1163 * Generic helper for filesystems that do not wish to allow leases to be set.
1164 * All arguments are ignored and it just returns -EINVAL.
1165 */
1166int
Jeff Laytone6f5c782014-08-22 10:40:25 -04001167simple_nosetlease(struct file *filp, long arg, struct file_lock **flp,
1168 void **priv)
Jeff Layton1c994a02014-08-27 06:49:41 -04001169{
1170 return -EINVAL;
1171}
1172EXPORT_SYMBOL(simple_nosetlease);
Al Viro61ba64f2015-05-02 09:54:06 -04001173
Al Viro6b255392015-11-17 10:20:54 -05001174const char *simple_get_link(struct dentry *dentry, struct inode *inode,
Al Virofceef392015-12-29 15:58:39 -05001175 struct delayed_call *done)
Al Viro61ba64f2015-05-02 09:54:06 -04001176{
Al Viro6b255392015-11-17 10:20:54 -05001177 return inode->i_link;
Al Viro61ba64f2015-05-02 09:54:06 -04001178}
Al Viro6b255392015-11-17 10:20:54 -05001179EXPORT_SYMBOL(simple_get_link);
Al Viro61ba64f2015-05-02 09:54:06 -04001180
1181const struct inode_operations simple_symlink_inode_operations = {
Al Viro6b255392015-11-17 10:20:54 -05001182 .get_link = simple_get_link,
Al Viro61ba64f2015-05-02 09:54:06 -04001183};
1184EXPORT_SYMBOL(simple_symlink_inode_operations);
Eric W. Biedermanfbabfd02015-05-09 15:54:49 -05001185
1186/*
1187 * Operations for a permanently empty directory.
1188 */
1189static struct dentry *empty_dir_lookup(struct inode *dir, struct dentry *dentry, unsigned int flags)
1190{
1191 return ERR_PTR(-ENOENT);
1192}
1193
David Howellsa528d352017-01-31 16:46:22 +00001194static int empty_dir_getattr(const struct path *path, struct kstat *stat,
1195 u32 request_mask, unsigned int query_flags)
Eric W. Biedermanfbabfd02015-05-09 15:54:49 -05001196{
David Howellsa528d352017-01-31 16:46:22 +00001197 struct inode *inode = d_inode(path->dentry);
Eric W. Biedermanfbabfd02015-05-09 15:54:49 -05001198 generic_fillattr(inode, stat);
1199 return 0;
1200}
1201
1202static int empty_dir_setattr(struct dentry *dentry, struct iattr *attr)
1203{
1204 return -EPERM;
1205}
1206
Eric W. Biedermanfbabfd02015-05-09 15:54:49 -05001207static ssize_t empty_dir_listxattr(struct dentry *dentry, char *list, size_t size)
1208{
1209 return -EOPNOTSUPP;
1210}
1211
1212static const struct inode_operations empty_dir_inode_operations = {
1213 .lookup = empty_dir_lookup,
1214 .permission = generic_permission,
1215 .setattr = empty_dir_setattr,
1216 .getattr = empty_dir_getattr,
Eric W. Biedermanfbabfd02015-05-09 15:54:49 -05001217 .listxattr = empty_dir_listxattr,
1218};
1219
1220static loff_t empty_dir_llseek(struct file *file, loff_t offset, int whence)
1221{
1222 /* An empty directory has two entries . and .. at offsets 0 and 1 */
1223 return generic_file_llseek_size(file, offset, whence, 2, 2);
1224}
1225
1226static int empty_dir_readdir(struct file *file, struct dir_context *ctx)
1227{
1228 dir_emit_dots(file, ctx);
1229 return 0;
1230}
1231
1232static const struct file_operations empty_dir_operations = {
1233 .llseek = empty_dir_llseek,
1234 .read = generic_read_dir,
Al Viroc51da202016-04-30 22:37:34 -04001235 .iterate_shared = empty_dir_readdir,
Eric W. Biedermanfbabfd02015-05-09 15:54:49 -05001236 .fsync = noop_fsync,
1237};
1238
1239
1240void make_empty_dir_inode(struct inode *inode)
1241{
1242 set_nlink(inode, 2);
1243 inode->i_mode = S_IFDIR | S_IRUGO | S_IXUGO;
1244 inode->i_uid = GLOBAL_ROOT_UID;
1245 inode->i_gid = GLOBAL_ROOT_GID;
1246 inode->i_rdev = 0;
Eric W. Biederman4b75de862015-08-12 15:00:12 -05001247 inode->i_size = 0;
Eric W. Biedermanfbabfd02015-05-09 15:54:49 -05001248 inode->i_blkbits = PAGE_SHIFT;
1249 inode->i_blocks = 0;
1250
1251 inode->i_op = &empty_dir_inode_operations;
Andreas Gruenbacherf5c24432016-09-29 17:48:41 +02001252 inode->i_opflags &= ~IOP_XATTR;
Eric W. Biedermanfbabfd02015-05-09 15:54:49 -05001253 inode->i_fop = &empty_dir_operations;
1254}
1255
1256bool is_empty_dir_inode(struct inode *inode)
1257{
1258 return (inode->i_fop == &empty_dir_operations) &&
1259 (inode->i_op == &empty_dir_inode_operations);
1260}