blob: b05b74ae3f167da9f996de6cef86c35c75e661fb [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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070010#include <linux/mount.h>
11#include <linux/vfs.h>
npiggin@suse.de7bb46a62010-05-27 01:05:33 +100012#include <linux/quotaops.h>
Ingo Molnar7cf34c72006-03-23 03:00:36 -080013#include <linux/mutex.h>
Al Viro87dc8002013-09-16 10:30:04 -040014#include <linux/namei.h>
Christoph Hellwig25961102007-10-21 16:42:05 -070015#include <linux/exportfs.h>
Al Virod5aacad2009-06-07 14:56:44 -040016#include <linux/writeback.h>
Al Viroff01bb482011-09-16 02:31:11 -040017#include <linux/buffer_head.h> /* sync_mapping_buffers */
Ingo Molnar7cf34c72006-03-23 03:00:36 -080018
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <asm/uaccess.h>
20
Al Viroa4464db2011-07-07 15:03:58 -040021#include "internal.h"
22
Linus Torvalds1da177e2005-04-16 15:20:36 -070023int simple_getattr(struct vfsmount *mnt, struct dentry *dentry,
24 struct kstat *stat)
25{
David Howellsdea655c2015-03-17 22:26:15 +000026 struct inode *inode = d_inode(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -070027 generic_fillattr(inode, stat);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +030028 stat->blocks = inode->i_mapping->nrpages << (PAGE_SHIFT - 9);
Linus Torvalds1da177e2005-04-16 15:20:36 -070029 return 0;
30}
Al Viro12f38872013-09-15 21:20:49 -040031EXPORT_SYMBOL(simple_getattr);
Linus Torvalds1da177e2005-04-16 15:20:36 -070032
David Howells726c3342006-06-23 02:02:58 -070033int simple_statfs(struct dentry *dentry, struct kstatfs *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -070034{
David Howells726c3342006-06-23 02:02:58 -070035 buf->f_type = dentry->d_sb->s_magic;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +030036 buf->f_bsize = PAGE_SIZE;
Linus Torvalds1da177e2005-04-16 15:20:36 -070037 buf->f_namelen = NAME_MAX;
38 return 0;
39}
Al Viro12f38872013-09-15 21:20:49 -040040EXPORT_SYMBOL(simple_statfs);
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
42/*
43 * Retaining negative dentries for an in-memory filesystem just wastes
44 * memory and lookup time: arrange for them to be deleted immediately.
45 */
Al Virob26d4cd2013-10-25 18:47:37 -040046int always_delete_dentry(const struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -070047{
48 return 1;
49}
Al Virob26d4cd2013-10-25 18:47:37 -040050EXPORT_SYMBOL(always_delete_dentry);
51
52const struct dentry_operations simple_dentry_operations = {
53 .d_delete = always_delete_dentry,
54};
55EXPORT_SYMBOL(simple_dentry_operations);
Linus Torvalds1da177e2005-04-16 15:20:36 -070056
57/*
58 * Lookup the data. This is trivial - if the dentry didn't already
59 * exist, we know it is negative. Set d_op to delete negative dentries.
60 */
Al Viro00cd8dd2012-06-10 17:13:09 -040061struct dentry *simple_lookup(struct inode *dir, struct dentry *dentry, unsigned int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -070062{
Linus Torvalds1da177e2005-04-16 15:20:36 -070063 if (dentry->d_name.len > NAME_MAX)
64 return ERR_PTR(-ENAMETOOLONG);
Al Viro74931da2013-07-14 17:43:25 +040065 if (!dentry->d_sb->s_d_op)
66 d_set_d_op(dentry, &simple_dentry_operations);
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 d_add(dentry, NULL);
68 return NULL;
69}
Al Viro12f38872013-09-15 21:20:49 -040070EXPORT_SYMBOL(simple_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -070071
Linus Torvalds1da177e2005-04-16 15:20:36 -070072int dcache_dir_open(struct inode *inode, struct file *file)
73{
Al Viroba65dc52016-06-10 11:32:47 -040074 file->private_data = d_alloc_cursor(file->f_path.dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -070075
76 return file->private_data ? 0 : -ENOMEM;
77}
Al Viro12f38872013-09-15 21:20:49 -040078EXPORT_SYMBOL(dcache_dir_open);
Linus Torvalds1da177e2005-04-16 15:20:36 -070079
80int dcache_dir_close(struct inode *inode, struct file *file)
81{
82 dput(file->private_data);
83 return 0;
84}
Al Viro12f38872013-09-15 21:20:49 -040085EXPORT_SYMBOL(dcache_dir_close);
Linus Torvalds1da177e2005-04-16 15:20:36 -070086
Al Viro4f42c1b2016-06-06 19:37:13 -040087/* parent is locked at least shared */
88static struct dentry *next_positive(struct dentry *parent,
89 struct list_head *from,
90 int count)
91{
92 struct dentry *res = NULL;
93 struct list_head *p;
94
95 spin_lock(&parent->d_lock);
96 for (p = from->next; p != &parent->d_subdirs; p = p->next) {
97 struct dentry *d = list_entry(p, struct dentry, d_child);
98 if (simple_positive(d) && !--count) {
99 res = d;
100 break;
101 }
102 }
103 spin_unlock(&parent->d_lock);
104 return res;
105}
106
107static void move_cursor(struct dentry *cursor, struct list_head *after)
108{
109 struct dentry *parent = cursor->d_parent;
110
111 spin_lock(&parent->d_lock);
112 __list_del(cursor->d_child.prev, cursor->d_child.next);
113 if (after)
114 list_add(&cursor->d_child, after);
115 else
116 list_add_tail(&cursor->d_child, &parent->d_subdirs);
117 spin_unlock(&parent->d_lock);
118}
119
Andrew Morton965c8e52012-12-17 15:59:39 -0800120loff_t dcache_dir_lseek(struct file *file, loff_t offset, int whence)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121{
Nick Piggin2fd6b7f2011-01-07 17:49:34 +1100122 struct dentry *dentry = file->f_path.dentry;
Andrew Morton965c8e52012-12-17 15:59:39 -0800123 switch (whence) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 case 1:
125 offset += file->f_pos;
126 case 0:
127 if (offset >= 0)
128 break;
129 default:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130 return -EINVAL;
131 }
132 if (offset != file->f_pos) {
133 file->f_pos = offset;
134 if (file->f_pos >= 2) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 struct dentry *cursor = file->private_data;
Al Viro4f42c1b2016-06-06 19:37:13 -0400136 struct dentry *to;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137 loff_t n = file->f_pos - 2;
138
Al Viro274f5b02016-06-06 18:55:57 -0400139 inode_lock_shared(dentry->d_inode);
Al Viro4f42c1b2016-06-06 19:37:13 -0400140 to = next_positive(dentry, &dentry->d_subdirs, n);
141 move_cursor(cursor, to ? &to->d_child : NULL);
Al Viro274f5b02016-06-06 18:55:57 -0400142 inode_unlock_shared(dentry->d_inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 }
144 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 return offset;
146}
Al Viro12f38872013-09-15 21:20:49 -0400147EXPORT_SYMBOL(dcache_dir_lseek);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
149/* Relationship between i_mode and the DT_xxx types */
150static inline unsigned char dt_type(struct inode *inode)
151{
152 return (inode->i_mode >> 12) & 15;
153}
154
155/*
156 * Directory is locked and all positive dentries in it are safe, since
157 * for ramfs-type trees they can't go away without unlink() or rmdir(),
158 * both impossible due to the lock on directory.
159 */
160
Al Viro5f99f4e2013-05-15 20:23:06 -0400161int dcache_readdir(struct file *file, struct dir_context *ctx)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162{
Al Viro5f99f4e2013-05-15 20:23:06 -0400163 struct dentry *dentry = file->f_path.dentry;
164 struct dentry *cursor = file->private_data;
Al Viro4f42c1b2016-06-06 19:37:13 -0400165 struct list_head *p = &cursor->d_child;
166 struct dentry *next;
167 bool moved = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168
Al Viro5f99f4e2013-05-15 20:23:06 -0400169 if (!dir_emit_dots(file, ctx))
170 return 0;
Al Viro4f42c1b2016-06-06 19:37:13 -0400171
Al Viro5f99f4e2013-05-15 20:23:06 -0400172 if (ctx->pos == 2)
Al Viro4f42c1b2016-06-06 19:37:13 -0400173 p = &dentry->d_subdirs;
174 while ((next = next_positive(dentry, p, 1)) != NULL) {
Al Viro5f99f4e2013-05-15 20:23:06 -0400175 if (!dir_emit(ctx, next->d_name.name, next->d_name.len,
David Howellsdea655c2015-03-17 22:26:15 +0000176 d_inode(next)->i_ino, dt_type(d_inode(next))))
Al Viro4f42c1b2016-06-06 19:37:13 -0400177 break;
178 moved = true;
179 p = &next->d_child;
Al Viro5f99f4e2013-05-15 20:23:06 -0400180 ctx->pos++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181 }
Al Viro4f42c1b2016-06-06 19:37:13 -0400182 if (moved)
183 move_cursor(cursor, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184 return 0;
185}
Al Viro12f38872013-09-15 21:20:49 -0400186EXPORT_SYMBOL(dcache_readdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187
188ssize_t generic_read_dir(struct file *filp, char __user *buf, size_t siz, loff_t *ppos)
189{
190 return -EISDIR;
191}
Al Viro12f38872013-09-15 21:20:49 -0400192EXPORT_SYMBOL(generic_read_dir);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -0800194const struct file_operations simple_dir_operations = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 .open = dcache_dir_open,
196 .release = dcache_dir_close,
197 .llseek = dcache_dir_lseek,
198 .read = generic_read_dir,
Al Viro4e829012016-04-20 19:52:15 -0400199 .iterate_shared = dcache_readdir,
Christoph Hellwig1b061d92010-05-26 17:53:41 +0200200 .fsync = noop_fsync,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201};
Al Viro12f38872013-09-15 21:20:49 -0400202EXPORT_SYMBOL(simple_dir_operations);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203
Arjan van de Ven92e1d5b2007-02-12 00:55:39 -0800204const struct inode_operations simple_dir_inode_operations = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 .lookup = simple_lookup,
206};
Al Viro12f38872013-09-15 21:20:49 -0400207EXPORT_SYMBOL(simple_dir_inode_operations);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208
Hugh Dickins759b9772007-03-05 00:30:28 -0800209static const struct super_operations simple_super_operations = {
210 .statfs = simple_statfs,
211};
212
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213/*
214 * Common helper for pseudo-filesystems (sockfs, pipefs, bdev - stuff that
215 * will never be mountable)
216 */
Al Viro51139ad2010-07-25 23:47:46 +0400217struct dentry *mount_pseudo(struct file_system_type *fs_type, char *name,
Al Viroc74a1cb2011-01-12 16:59:34 -0500218 const struct super_operations *ops,
219 const struct dentry_operations *dops, unsigned long magic)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220{
David Howells9249e172012-06-25 12:55:37 +0100221 struct super_block *s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 struct dentry *dentry;
223 struct inode *root;
Linus Torvalds26fe5752012-05-10 13:14:12 -0700224 struct qstr d_name = QSTR_INIT(name, strlen(name));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225
David Howells9249e172012-06-25 12:55:37 +0100226 s = sget(fs_type, NULL, set_anon_super, MS_NOUSER, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227 if (IS_ERR(s))
Al Viro51139ad2010-07-25 23:47:46 +0400228 return ERR_CAST(s);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229
Jeff Layton89a4eb42009-08-18 14:11:08 -0700230 s->s_maxbytes = MAX_LFS_FILESIZE;
Alex Nixon3971e1a2008-07-29 22:33:03 -0700231 s->s_blocksize = PAGE_SIZE;
232 s->s_blocksize_bits = PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 s->s_magic = magic;
Hugh Dickins759b9772007-03-05 00:30:28 -0800234 s->s_op = ops ? ops : &simple_super_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 s->s_time_gran = 1;
236 root = new_inode(s);
237 if (!root)
238 goto Enomem;
Jeff Layton1a1c9bb2007-05-08 00:32:31 -0700239 /*
240 * since this is the first inode, make it number 1. New inodes created
241 * after this must take care not to collide with it (by passing
242 * max_reserved of 1 to iunique).
243 */
244 root->i_ino = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 root->i_mode = S_IFDIR | S_IRUSR | S_IWUSR;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 root->i_atime = root->i_mtime = root->i_ctime = CURRENT_TIME;
Al Viroa4464db2011-07-07 15:03:58 -0400247 dentry = __d_alloc(s, &d_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248 if (!dentry) {
249 iput(root);
250 goto Enomem;
251 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 d_instantiate(dentry, root);
253 s->s_root = dentry;
Al Viroc74a1cb2011-01-12 16:59:34 -0500254 s->s_d_op = dops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 s->s_flags |= MS_ACTIVE;
Al Viro51139ad2010-07-25 23:47:46 +0400256 return dget(s->s_root);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257
258Enomem:
Al Viro6f5bbff2009-05-06 01:34:22 -0400259 deactivate_locked_super(s);
Al Viro51139ad2010-07-25 23:47:46 +0400260 return ERR_PTR(-ENOMEM);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261}
Al Viro12f38872013-09-15 21:20:49 -0400262EXPORT_SYMBOL(mount_pseudo);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263
Stephen Boyd20955e82012-04-05 14:25:09 -0700264int simple_open(struct inode *inode, struct file *file)
265{
266 if (inode->i_private)
267 file->private_data = inode->i_private;
268 return 0;
269}
Al Viro12f38872013-09-15 21:20:49 -0400270EXPORT_SYMBOL(simple_open);
Stephen Boyd20955e82012-04-05 14:25:09 -0700271
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272int simple_link(struct dentry *old_dentry, struct inode *dir, struct dentry *dentry)
273{
David Howellsdea655c2015-03-17 22:26:15 +0000274 struct inode *inode = d_inode(old_dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275
276 inode->i_ctime = dir->i_ctime = dir->i_mtime = CURRENT_TIME;
Dave Hansend8c76e62006-09-30 23:29:04 -0700277 inc_nlink(inode);
Al Viro7de9c6ee2010-10-23 11:11:40 -0400278 ihold(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279 dget(dentry);
280 d_instantiate(dentry, inode);
281 return 0;
282}
Al Viro12f38872013-09-15 21:20:49 -0400283EXPORT_SYMBOL(simple_link);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285int simple_empty(struct dentry *dentry)
286{
287 struct dentry *child;
288 int ret = 0;
289
Nick Piggin2fd6b7f2011-01-07 17:49:34 +1100290 spin_lock(&dentry->d_lock);
Al Viro946e51f2014-10-26 19:19:16 -0400291 list_for_each_entry(child, &dentry->d_subdirs, d_child) {
Nick Pigginda502952011-01-07 17:49:33 +1100292 spin_lock_nested(&child->d_lock, DENTRY_D_LOCK_NESTED);
293 if (simple_positive(child)) {
294 spin_unlock(&child->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 goto out;
Nick Pigginda502952011-01-07 17:49:33 +1100296 }
297 spin_unlock(&child->d_lock);
298 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299 ret = 1;
300out:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +1100301 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302 return ret;
303}
Al Viro12f38872013-09-15 21:20:49 -0400304EXPORT_SYMBOL(simple_empty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305
306int simple_unlink(struct inode *dir, struct dentry *dentry)
307{
David Howellsdea655c2015-03-17 22:26:15 +0000308 struct inode *inode = d_inode(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309
310 inode->i_ctime = dir->i_ctime = dir->i_mtime = CURRENT_TIME;
Dave Hansen9a53c3a2006-09-30 23:29:03 -0700311 drop_nlink(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312 dput(dentry);
313 return 0;
314}
Al Viro12f38872013-09-15 21:20:49 -0400315EXPORT_SYMBOL(simple_unlink);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316
317int simple_rmdir(struct inode *dir, struct dentry *dentry)
318{
319 if (!simple_empty(dentry))
320 return -ENOTEMPTY;
321
David Howellsdea655c2015-03-17 22:26:15 +0000322 drop_nlink(d_inode(dentry));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 simple_unlink(dir, dentry);
Dave Hansen9a53c3a2006-09-30 23:29:03 -0700324 drop_nlink(dir);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325 return 0;
326}
Al Viro12f38872013-09-15 21:20:49 -0400327EXPORT_SYMBOL(simple_rmdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328
329int simple_rename(struct inode *old_dir, struct dentry *old_dentry,
330 struct inode *new_dir, struct dentry *new_dentry)
331{
David Howellsdea655c2015-03-17 22:26:15 +0000332 struct inode *inode = d_inode(old_dentry);
David Howellse36cb0b2015-01-29 12:02:35 +0000333 int they_are_dirs = d_is_dir(old_dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334
335 if (!simple_empty(new_dentry))
336 return -ENOTEMPTY;
337
David Howellsdea655c2015-03-17 22:26:15 +0000338 if (d_really_is_positive(new_dentry)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339 simple_unlink(new_dir, new_dentry);
Al Viro841590c2011-07-21 15:49:09 -0400340 if (they_are_dirs) {
David Howellsdea655c2015-03-17 22:26:15 +0000341 drop_nlink(d_inode(new_dentry));
Dave Hansen9a53c3a2006-09-30 23:29:03 -0700342 drop_nlink(old_dir);
Al Viro841590c2011-07-21 15:49:09 -0400343 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344 } else if (they_are_dirs) {
Dave Hansen9a53c3a2006-09-30 23:29:03 -0700345 drop_nlink(old_dir);
Dave Hansend8c76e62006-09-30 23:29:04 -0700346 inc_nlink(new_dir);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347 }
348
349 old_dir->i_ctime = old_dir->i_mtime = new_dir->i_ctime =
350 new_dir->i_mtime = inode->i_ctime = CURRENT_TIME;
351
352 return 0;
353}
Al Viro12f38872013-09-15 21:20:49 -0400354EXPORT_SYMBOL(simple_rename);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355
npiggin@suse.de7bb46a62010-05-27 01:05:33 +1000356/**
Christoph Hellwigeef23802010-06-04 11:30:01 +0200357 * simple_setattr - setattr for simple filesystem
npiggin@suse.de7bb46a62010-05-27 01:05:33 +1000358 * @dentry: dentry
359 * @iattr: iattr structure
360 *
361 * Returns 0 on success, -error on failure.
362 *
Christoph Hellwigeef23802010-06-04 11:30:01 +0200363 * simple_setattr is a simple ->setattr implementation without a proper
364 * implementation of size changes.
365 *
366 * It can either be used for in-memory filesystems or special files
367 * on simple regular filesystems. Anything that needs to change on-disk
368 * or wire state on size changes needs its own setattr method.
npiggin@suse.de7bb46a62010-05-27 01:05:33 +1000369 */
370int simple_setattr(struct dentry *dentry, struct iattr *iattr)
371{
David Howellsdea655c2015-03-17 22:26:15 +0000372 struct inode *inode = d_inode(dentry);
npiggin@suse.de7bb46a62010-05-27 01:05:33 +1000373 int error;
374
375 error = inode_change_ok(inode, iattr);
376 if (error)
377 return error;
378
Christoph Hellwig2c27c652010-06-04 11:30:04 +0200379 if (iattr->ia_valid & ATTR_SIZE)
380 truncate_setsize(inode, iattr->ia_size);
Christoph Hellwig6a1a90a2010-06-04 11:30:00 +0200381 setattr_copy(inode, iattr);
Christoph Hellwigeef23802010-06-04 11:30:01 +0200382 mark_inode_dirty(inode);
383 return 0;
npiggin@suse.de7bb46a62010-05-27 01:05:33 +1000384}
385EXPORT_SYMBOL(simple_setattr);
386
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387int simple_readpage(struct file *file, struct page *page)
388{
Pekka J Enbergc0d92cb2006-09-29 01:59:09 -0700389 clear_highpage(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 flush_dcache_page(page);
391 SetPageUptodate(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 unlock_page(page);
393 return 0;
394}
Al Viro12f38872013-09-15 21:20:49 -0400395EXPORT_SYMBOL(simple_readpage);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396
Nick Pigginafddba42007-10-16 01:25:01 -0700397int simple_write_begin(struct file *file, struct address_space *mapping,
398 loff_t pos, unsigned len, unsigned flags,
399 struct page **pagep, void **fsdata)
400{
401 struct page *page;
402 pgoff_t index;
Nick Pigginafddba42007-10-16 01:25:01 -0700403
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300404 index = pos >> PAGE_SHIFT;
Nick Pigginafddba42007-10-16 01:25:01 -0700405
Nick Piggin54566b22009-01-04 12:00:53 -0800406 page = grab_cache_page_write_begin(mapping, index, flags);
Nick Pigginafddba42007-10-16 01:25:01 -0700407 if (!page)
408 return -ENOMEM;
409
410 *pagep = page;
411
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300412 if (!PageUptodate(page) && (len != PAGE_SIZE)) {
413 unsigned from = pos & (PAGE_SIZE - 1);
Boaz Harrosh193cf4b2010-01-12 16:18:08 +0200414
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300415 zero_user_segments(page, 0, from, from + len, PAGE_SIZE);
Boaz Harrosh193cf4b2010-01-12 16:18:08 +0200416 }
417 return 0;
Nick Pigginafddba42007-10-16 01:25:01 -0700418}
Al Viro12f38872013-09-15 21:20:49 -0400419EXPORT_SYMBOL(simple_write_begin);
Nick Pigginafddba42007-10-16 01:25:01 -0700420
Boaz Harroshad2a722f2010-01-12 15:13:47 +0200421/**
422 * simple_write_end - .write_end helper for non-block-device FSes
423 * @available: See .write_end of address_space_operations
424 * @file: "
425 * @mapping: "
426 * @pos: "
427 * @len: "
428 * @copied: "
429 * @page: "
430 * @fsdata: "
431 *
432 * simple_write_end does the minimum needed for updating a page after writing is
433 * done. It has the same API signature as the .write_end of
434 * address_space_operations vector. So it can just be set onto .write_end for
435 * FSes that don't need any other processing. i_mutex is assumed to be held.
436 * Block based filesystems should use generic_write_end().
437 * NOTE: Even though i_size might get updated by this function, mark_inode_dirty
438 * is not called, so a filesystem that actually does store data in .write_inode
439 * should extend on what's done here with a call to mark_inode_dirty() in the
440 * case that i_size has changed.
441 */
442int simple_write_end(struct file *file, struct address_space *mapping,
443 loff_t pos, unsigned len, unsigned copied,
444 struct page *page, void *fsdata)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445{
446 struct inode *inode = page->mapping->host;
Boaz Harroshad2a722f2010-01-12 15:13:47 +0200447 loff_t last_pos = pos + copied;
448
449 /* zero the stale part of the page if we did a short copy */
450 if (copied < len) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300451 unsigned from = pos & (PAGE_SIZE - 1);
Boaz Harroshad2a722f2010-01-12 15:13:47 +0200452
453 zero_user(page, from + copied, len - copied);
454 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455
Nick Piggin955eff52007-02-20 13:58:08 -0800456 if (!PageUptodate(page))
457 SetPageUptodate(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 /*
459 * No need to use i_size_read() here, the i_size
Jes Sorensen1b1dcc12006-01-09 15:59:24 -0800460 * cannot change under us because we hold the i_mutex.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 */
Boaz Harroshad2a722f2010-01-12 15:13:47 +0200462 if (last_pos > inode->i_size)
463 i_size_write(inode, last_pos);
464
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 set_page_dirty(page);
Nick Pigginafddba42007-10-16 01:25:01 -0700466 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300467 put_page(page);
Nick Pigginafddba42007-10-16 01:25:01 -0700468
469 return copied;
470}
Al Viro12f38872013-09-15 21:20:49 -0400471EXPORT_SYMBOL(simple_write_end);
Nick Pigginafddba42007-10-16 01:25:01 -0700472
Jeff Layton1a1c9bb2007-05-08 00:32:31 -0700473/*
474 * the inodes created here are not hashed. If you use iunique to generate
475 * unique inode values later for this filesystem, then you must take care
476 * to pass it an appropriate max_reserved value to avoid collisions.
477 */
Roberto Sassu7d683a02010-06-03 11:58:28 +0200478int simple_fill_super(struct super_block *s, unsigned long magic,
479 struct tree_descr *files)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481 struct inode *inode;
482 struct dentry *root;
483 struct dentry *dentry;
484 int i;
485
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300486 s->s_blocksize = PAGE_SIZE;
487 s->s_blocksize_bits = PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488 s->s_magic = magic;
Hugh Dickins759b9772007-03-05 00:30:28 -0800489 s->s_op = &simple_super_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490 s->s_time_gran = 1;
491
492 inode = new_inode(s);
493 if (!inode)
494 return -ENOMEM;
Jeff Layton1a1c9bb2007-05-08 00:32:31 -0700495 /*
496 * because the root inode is 1, the files array must not contain an
497 * entry at index 1
498 */
499 inode->i_ino = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 inode->i_mode = S_IFDIR | 0755;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
502 inode->i_op = &simple_dir_inode_operations;
503 inode->i_fop = &simple_dir_operations;
Miklos Szeredibfe86842011-10-28 14:13:29 +0200504 set_nlink(inode, 2);
Al Viro48fde702012-01-08 22:15:13 -0500505 root = d_make_root(inode);
506 if (!root)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508 for (i = 0; !files->name || files->name[0]; i++, files++) {
509 if (!files->name)
510 continue;
Jeff Layton1a1c9bb2007-05-08 00:32:31 -0700511
512 /* warn if it tries to conflict with the root inode */
513 if (unlikely(i == 1))
514 printk(KERN_WARNING "%s: %s passed in a files array"
515 "with an index of 1!\n", __func__,
516 s->s_type->name);
517
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 dentry = d_alloc_name(root, files->name);
519 if (!dentry)
520 goto out;
521 inode = new_inode(s);
Konstantin Khlebnikov32096ea2011-11-01 16:12:33 +0300522 if (!inode) {
523 dput(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 goto out;
Konstantin Khlebnikov32096ea2011-11-01 16:12:33 +0300525 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526 inode->i_mode = S_IFREG | files->mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
528 inode->i_fop = files->ops;
529 inode->i_ino = i;
530 d_add(dentry, inode);
531 }
532 s->s_root = root;
533 return 0;
534out:
535 d_genocide(root);
Al Viro640946f2012-04-02 19:22:25 -0400536 shrink_dcache_parent(root);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 dput(root);
538 return -ENOMEM;
539}
Al Viro12f38872013-09-15 21:20:49 -0400540EXPORT_SYMBOL(simple_fill_super);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541
542static DEFINE_SPINLOCK(pin_fs_lock);
543
Trond Myklebust1f5ce9e2006-06-09 09:34:16 -0400544int simple_pin_fs(struct file_system_type *type, struct vfsmount **mount, int *count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545{
546 struct vfsmount *mnt = NULL;
547 spin_lock(&pin_fs_lock);
548 if (unlikely(!*mount)) {
549 spin_unlock(&pin_fs_lock);
Al Viro24529922012-03-17 02:13:52 -0400550 mnt = vfs_kern_mount(type, MS_KERNMOUNT, type->name, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 if (IS_ERR(mnt))
552 return PTR_ERR(mnt);
553 spin_lock(&pin_fs_lock);
554 if (!*mount)
555 *mount = mnt;
556 }
557 mntget(*mount);
558 ++*count;
559 spin_unlock(&pin_fs_lock);
560 mntput(mnt);
561 return 0;
562}
Al Viro12f38872013-09-15 21:20:49 -0400563EXPORT_SYMBOL(simple_pin_fs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564
565void simple_release_fs(struct vfsmount **mount, int *count)
566{
567 struct vfsmount *mnt;
568 spin_lock(&pin_fs_lock);
569 mnt = *mount;
570 if (!--*count)
571 *mount = NULL;
572 spin_unlock(&pin_fs_lock);
573 mntput(mnt);
574}
Al Viro12f38872013-09-15 21:20:49 -0400575EXPORT_SYMBOL(simple_release_fs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576
Akinobu Mita6d1029b2008-07-04 09:59:51 -0700577/**
578 * simple_read_from_buffer - copy data from the buffer to user space
579 * @to: the user space buffer to read to
580 * @count: the maximum number of bytes to read
581 * @ppos: the current position in the buffer
582 * @from: the buffer to read from
583 * @available: the size of the buffer
584 *
585 * The simple_read_from_buffer() function reads up to @count bytes from the
586 * buffer @from at offset @ppos into the user space address starting at @to.
587 *
588 * On success, the number of bytes read is returned and the offset @ppos is
589 * advanced by this number, or negative value is returned on error.
590 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591ssize_t simple_read_from_buffer(void __user *to, size_t count, loff_t *ppos,
592 const void *from, size_t available)
593{
594 loff_t pos = *ppos;
Steven Rostedt14be2742009-09-18 13:05:42 -0700595 size_t ret;
596
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 if (pos < 0)
598 return -EINVAL;
Steven Rostedt14be2742009-09-18 13:05:42 -0700599 if (pos >= available || !count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600 return 0;
601 if (count > available - pos)
602 count = available - pos;
Steven Rostedt14be2742009-09-18 13:05:42 -0700603 ret = copy_to_user(to, from + pos, count);
604 if (ret == count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 return -EFAULT;
Steven Rostedt14be2742009-09-18 13:05:42 -0700606 count -= ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607 *ppos = pos + count;
608 return count;
609}
Al Viro12f38872013-09-15 21:20:49 -0400610EXPORT_SYMBOL(simple_read_from_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611
Akinobu Mita6d1029b2008-07-04 09:59:51 -0700612/**
Jiri Slaby6a727b42010-05-01 23:51:22 +0200613 * simple_write_to_buffer - copy data from user space to the buffer
614 * @to: the buffer to write to
615 * @available: the size of the buffer
616 * @ppos: the current position in the buffer
617 * @from: the user space buffer to read from
618 * @count: the maximum number of bytes to read
619 *
620 * The simple_write_to_buffer() function reads up to @count bytes from the user
621 * space address starting at @from into the buffer @to at offset @ppos.
622 *
623 * On success, the number of bytes written is returned and the offset @ppos is
624 * advanced by this number, or negative value is returned on error.
625 **/
626ssize_t simple_write_to_buffer(void *to, size_t available, loff_t *ppos,
627 const void __user *from, size_t count)
628{
629 loff_t pos = *ppos;
630 size_t res;
631
632 if (pos < 0)
633 return -EINVAL;
634 if (pos >= available || !count)
635 return 0;
636 if (count > available - pos)
637 count = available - pos;
638 res = copy_from_user(to + pos, from, count);
639 if (res == count)
640 return -EFAULT;
641 count -= res;
642 *ppos = pos + count;
643 return count;
644}
Al Viro12f38872013-09-15 21:20:49 -0400645EXPORT_SYMBOL(simple_write_to_buffer);
Jiri Slaby6a727b42010-05-01 23:51:22 +0200646
647/**
Akinobu Mita6d1029b2008-07-04 09:59:51 -0700648 * memory_read_from_buffer - copy data from the buffer
649 * @to: the kernel space buffer to read to
650 * @count: the maximum number of bytes to read
651 * @ppos: the current position in the buffer
652 * @from: the buffer to read from
653 * @available: the size of the buffer
654 *
655 * The memory_read_from_buffer() function reads up to @count bytes from the
656 * buffer @from at offset @ppos into the kernel space address starting at @to.
657 *
658 * On success, the number of bytes read is returned and the offset @ppos is
659 * advanced by this number, or negative value is returned on error.
660 **/
Akinobu Mita93b07112008-06-05 22:46:21 -0700661ssize_t memory_read_from_buffer(void *to, size_t count, loff_t *ppos,
662 const void *from, size_t available)
663{
664 loff_t pos = *ppos;
665
666 if (pos < 0)
667 return -EINVAL;
668 if (pos >= available)
669 return 0;
670 if (count > available - pos)
671 count = available - pos;
672 memcpy(to, from + pos, count);
673 *ppos = pos + count;
674
675 return count;
676}
Al Viro12f38872013-09-15 21:20:49 -0400677EXPORT_SYMBOL(memory_read_from_buffer);
Akinobu Mita93b07112008-06-05 22:46:21 -0700678
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679/*
680 * Transaction based IO.
681 * The file expects a single write which triggers the transaction, and then
682 * possibly a read which collects the result - which is stored in a
683 * file-local buffer.
684 */
Ingo Molnar76791ab2009-03-25 16:48:35 +0100685
686void simple_transaction_set(struct file *file, size_t n)
687{
688 struct simple_transaction_argresp *ar = file->private_data;
689
690 BUG_ON(n > SIMPLE_TRANSACTION_LIMIT);
691
692 /*
693 * The barrier ensures that ar->size will really remain zero until
694 * ar->data is ready for reading.
695 */
696 smp_mb();
697 ar->size = n;
698}
Al Viro12f38872013-09-15 21:20:49 -0400699EXPORT_SYMBOL(simple_transaction_set);
Ingo Molnar76791ab2009-03-25 16:48:35 +0100700
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701char *simple_transaction_get(struct file *file, const char __user *buf, size_t size)
702{
703 struct simple_transaction_argresp *ar;
704 static DEFINE_SPINLOCK(simple_transaction_lock);
705
706 if (size > SIMPLE_TRANSACTION_LIMIT - 1)
707 return ERR_PTR(-EFBIG);
708
709 ar = (struct simple_transaction_argresp *)get_zeroed_page(GFP_KERNEL);
710 if (!ar)
711 return ERR_PTR(-ENOMEM);
712
713 spin_lock(&simple_transaction_lock);
714
715 /* only one write allowed per open */
716 if (file->private_data) {
717 spin_unlock(&simple_transaction_lock);
718 free_page((unsigned long)ar);
719 return ERR_PTR(-EBUSY);
720 }
721
722 file->private_data = ar;
723
724 spin_unlock(&simple_transaction_lock);
725
726 if (copy_from_user(ar->data, buf, size))
727 return ERR_PTR(-EFAULT);
728
729 return ar->data;
730}
Al Viro12f38872013-09-15 21:20:49 -0400731EXPORT_SYMBOL(simple_transaction_get);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732
733ssize_t simple_transaction_read(struct file *file, char __user *buf, size_t size, loff_t *pos)
734{
735 struct simple_transaction_argresp *ar = file->private_data;
736
737 if (!ar)
738 return 0;
739 return simple_read_from_buffer(buf, size, pos, ar->data, ar->size);
740}
Al Viro12f38872013-09-15 21:20:49 -0400741EXPORT_SYMBOL(simple_transaction_read);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742
743int simple_transaction_release(struct inode *inode, struct file *file)
744{
745 free_page((unsigned long)file->private_data);
746 return 0;
747}
Al Viro12f38872013-09-15 21:20:49 -0400748EXPORT_SYMBOL(simple_transaction_release);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200750/* Simple attribute files */
751
752struct simple_attr {
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800753 int (*get)(void *, u64 *);
754 int (*set)(void *, u64);
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200755 char get_buf[24]; /* enough to store a u64 and "\n\0" */
756 char set_buf[24];
757 void *data;
758 const char *fmt; /* format for read operation */
Ingo Molnar7cf34c72006-03-23 03:00:36 -0800759 struct mutex mutex; /* protects access to these buffers */
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200760};
761
762/* simple_attr_open is called by an actual attribute open file operation
763 * to set the attribute specific access operations. */
764int simple_attr_open(struct inode *inode, struct file *file,
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800765 int (*get)(void *, u64 *), int (*set)(void *, u64),
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200766 const char *fmt)
767{
768 struct simple_attr *attr;
769
770 attr = kmalloc(sizeof(*attr), GFP_KERNEL);
771 if (!attr)
772 return -ENOMEM;
773
774 attr->get = get;
775 attr->set = set;
Theodore Ts'o8e18e292006-09-27 01:50:46 -0700776 attr->data = inode->i_private;
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200777 attr->fmt = fmt;
Ingo Molnar7cf34c72006-03-23 03:00:36 -0800778 mutex_init(&attr->mutex);
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200779
780 file->private_data = attr;
781
782 return nonseekable_open(inode, file);
783}
Al Viro12f38872013-09-15 21:20:49 -0400784EXPORT_SYMBOL_GPL(simple_attr_open);
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200785
Christoph Hellwig74bedc42008-02-08 04:20:28 -0800786int simple_attr_release(struct inode *inode, struct file *file)
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200787{
788 kfree(file->private_data);
789 return 0;
790}
Al Viro12f38872013-09-15 21:20:49 -0400791EXPORT_SYMBOL_GPL(simple_attr_release); /* GPL-only? This? Really? */
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200792
793/* read from the buffer that is filled with the get function */
794ssize_t simple_attr_read(struct file *file, char __user *buf,
795 size_t len, loff_t *ppos)
796{
797 struct simple_attr *attr;
798 size_t size;
799 ssize_t ret;
800
801 attr = file->private_data;
802
803 if (!attr->get)
804 return -EACCES;
805
Christoph Hellwig92613032008-02-08 04:20:27 -0800806 ret = mutex_lock_interruptible(&attr->mutex);
807 if (ret)
808 return ret;
809
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800810 if (*ppos) { /* continued read */
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200811 size = strlen(attr->get_buf);
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800812 } else { /* first read */
813 u64 val;
814 ret = attr->get(attr->data, &val);
815 if (ret)
816 goto out;
817
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200818 size = scnprintf(attr->get_buf, sizeof(attr->get_buf),
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800819 attr->fmt, (unsigned long long)val);
820 }
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200821
822 ret = simple_read_from_buffer(buf, len, ppos, attr->get_buf, size);
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800823out:
Ingo Molnar7cf34c72006-03-23 03:00:36 -0800824 mutex_unlock(&attr->mutex);
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200825 return ret;
826}
Al Viro12f38872013-09-15 21:20:49 -0400827EXPORT_SYMBOL_GPL(simple_attr_read);
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200828
829/* interpret the buffer as a number to call the set function with */
830ssize_t simple_attr_write(struct file *file, const char __user *buf,
831 size_t len, loff_t *ppos)
832{
833 struct simple_attr *attr;
834 u64 val;
835 size_t size;
836 ssize_t ret;
837
838 attr = file->private_data;
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200839 if (!attr->set)
840 return -EACCES;
841
Christoph Hellwig92613032008-02-08 04:20:27 -0800842 ret = mutex_lock_interruptible(&attr->mutex);
843 if (ret)
844 return ret;
845
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200846 ret = -EFAULT;
847 size = min(sizeof(attr->set_buf) - 1, len);
848 if (copy_from_user(attr->set_buf, buf, size))
849 goto out;
850
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200851 attr->set_buf[size] = '\0';
Akinobu Mitaf7b88632011-07-19 08:49:25 -0700852 val = simple_strtoll(attr->set_buf, NULL, 0);
Wu Fengguang05cc0ce2009-09-18 13:06:03 -0700853 ret = attr->set(attr->data, val);
854 if (ret == 0)
855 ret = len; /* on success, claim we got the whole input */
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200856out:
Ingo Molnar7cf34c72006-03-23 03:00:36 -0800857 mutex_unlock(&attr->mutex);
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200858 return ret;
859}
Al Viro12f38872013-09-15 21:20:49 -0400860EXPORT_SYMBOL_GPL(simple_attr_write);
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200861
Christoph Hellwig25961102007-10-21 16:42:05 -0700862/**
863 * generic_fh_to_dentry - generic helper for the fh_to_dentry export operation
864 * @sb: filesystem to do the file handle conversion on
865 * @fid: file handle to convert
866 * @fh_len: length of the file handle in bytes
867 * @fh_type: type of file handle
868 * @get_inode: filesystem callback to retrieve inode
869 *
870 * This function decodes @fid as long as it has one of the well-known
871 * Linux filehandle types and calls @get_inode on it to retrieve the
872 * inode for the object specified in the file handle.
873 */
874struct dentry *generic_fh_to_dentry(struct super_block *sb, struct fid *fid,
875 int fh_len, int fh_type, struct inode *(*get_inode)
876 (struct super_block *sb, u64 ino, u32 gen))
877{
878 struct inode *inode = NULL;
879
880 if (fh_len < 2)
881 return NULL;
882
883 switch (fh_type) {
884 case FILEID_INO32_GEN:
885 case FILEID_INO32_GEN_PARENT:
886 inode = get_inode(sb, fid->i32.ino, fid->i32.gen);
887 break;
888 }
889
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +0200890 return d_obtain_alias(inode);
Christoph Hellwig25961102007-10-21 16:42:05 -0700891}
892EXPORT_SYMBOL_GPL(generic_fh_to_dentry);
893
894/**
Yanchuan Nianca186832012-09-05 16:31:29 +0800895 * generic_fh_to_parent - generic helper for the fh_to_parent export operation
Christoph Hellwig25961102007-10-21 16:42:05 -0700896 * @sb: filesystem to do the file handle conversion on
897 * @fid: file handle to convert
898 * @fh_len: length of the file handle in bytes
899 * @fh_type: type of file handle
900 * @get_inode: filesystem callback to retrieve inode
901 *
902 * This function decodes @fid as long as it has one of the well-known
903 * Linux filehandle types and calls @get_inode on it to retrieve the
904 * inode for the _parent_ object specified in the file handle if it
905 * is specified in the file handle, or NULL otherwise.
906 */
907struct dentry *generic_fh_to_parent(struct super_block *sb, struct fid *fid,
908 int fh_len, int fh_type, struct inode *(*get_inode)
909 (struct super_block *sb, u64 ino, u32 gen))
910{
911 struct inode *inode = NULL;
912
913 if (fh_len <= 2)
914 return NULL;
915
916 switch (fh_type) {
917 case FILEID_INO32_GEN_PARENT:
918 inode = get_inode(sb, fid->i32.parent_ino,
919 (fh_len > 3 ? fid->i32.parent_gen : 0));
920 break;
921 }
922
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +0200923 return d_obtain_alias(inode);
Christoph Hellwig25961102007-10-21 16:42:05 -0700924}
925EXPORT_SYMBOL_GPL(generic_fh_to_parent);
926
Christoph Hellwig1b061d92010-05-26 17:53:41 +0200927/**
Fabian Frederickac13a822014-06-04 16:06:27 -0700928 * __generic_file_fsync - generic fsync implementation for simple filesystems
929 *
Christoph Hellwig1b061d92010-05-26 17:53:41 +0200930 * @file: file to synchronize
Fabian Frederickac13a822014-06-04 16:06:27 -0700931 * @start: start offset in bytes
932 * @end: end offset in bytes (inclusive)
Christoph Hellwig1b061d92010-05-26 17:53:41 +0200933 * @datasync: only synchronize essential metadata if true
934 *
935 * This is a generic implementation of the fsync method for simple
936 * filesystems which track all non-inode metadata in the buffers list
937 * hanging off the address_space structure.
938 */
Fabian Frederickac13a822014-06-04 16:06:27 -0700939int __generic_file_fsync(struct file *file, loff_t start, loff_t end,
940 int datasync)
Al Virod5aacad2009-06-07 14:56:44 -0400941{
Christoph Hellwig7ea80852010-05-26 17:53:25 +0200942 struct inode *inode = file->f_mapping->host;
Al Virod5aacad2009-06-07 14:56:44 -0400943 int err;
944 int ret;
945
Josef Bacik02c24a82011-07-16 20:44:56 -0400946 err = filemap_write_and_wait_range(inode->i_mapping, start, end);
947 if (err)
948 return err;
949
Al Viro59551022016-01-22 15:40:57 -0500950 inode_lock(inode);
Al Virod5aacad2009-06-07 14:56:44 -0400951 ret = sync_mapping_buffers(inode->i_mapping);
Theodore Ts'o0ae45f62015-02-02 00:37:00 -0500952 if (!(inode->i_state & I_DIRTY_ALL))
Josef Bacik02c24a82011-07-16 20:44:56 -0400953 goto out;
Al Virod5aacad2009-06-07 14:56:44 -0400954 if (datasync && !(inode->i_state & I_DIRTY_DATASYNC))
Josef Bacik02c24a82011-07-16 20:44:56 -0400955 goto out;
Al Virod5aacad2009-06-07 14:56:44 -0400956
Christoph Hellwigc37650162010-10-06 10:48:20 +0200957 err = sync_inode_metadata(inode, 1);
Al Virod5aacad2009-06-07 14:56:44 -0400958 if (ret == 0)
959 ret = err;
Fabian Frederickac13a822014-06-04 16:06:27 -0700960
Josef Bacik02c24a82011-07-16 20:44:56 -0400961out:
Al Viro59551022016-01-22 15:40:57 -0500962 inode_unlock(inode);
Al Virod5aacad2009-06-07 14:56:44 -0400963 return ret;
964}
Fabian Frederickac13a822014-06-04 16:06:27 -0700965EXPORT_SYMBOL(__generic_file_fsync);
966
967/**
968 * generic_file_fsync - generic fsync implementation for simple filesystems
969 * with flush
970 * @file: file to synchronize
971 * @start: start offset in bytes
972 * @end: end offset in bytes (inclusive)
973 * @datasync: only synchronize essential metadata if true
974 *
975 */
976
977int generic_file_fsync(struct file *file, loff_t start, loff_t end,
978 int datasync)
979{
980 struct inode *inode = file->f_mapping->host;
981 int err;
982
983 err = __generic_file_fsync(file, start, end, datasync);
984 if (err)
985 return err;
986 return blkdev_issue_flush(inode->i_sb->s_bdev, GFP_KERNEL, NULL);
987}
Christoph Hellwig1b061d92010-05-26 17:53:41 +0200988EXPORT_SYMBOL(generic_file_fsync);
989
Patrick J. LoPresti30ca22c2010-07-22 15:03:41 -0700990/**
991 * generic_check_addressable - Check addressability of file system
992 * @blocksize_bits: log of file system block size
993 * @num_blocks: number of blocks in file system
994 *
995 * Determine whether a file system with @num_blocks blocks (and a
996 * block size of 2**@blocksize_bits) is addressable by the sector_t
997 * and page cache of the system. Return 0 if so and -EFBIG otherwise.
998 */
999int generic_check_addressable(unsigned blocksize_bits, u64 num_blocks)
1000{
1001 u64 last_fs_block = num_blocks - 1;
Joel Beckera33f13e2010-08-16 12:10:17 -07001002 u64 last_fs_page =
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001003 last_fs_block >> (PAGE_SHIFT - blocksize_bits);
Patrick J. LoPresti30ca22c2010-07-22 15:03:41 -07001004
1005 if (unlikely(num_blocks == 0))
1006 return 0;
1007
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001008 if ((blocksize_bits < 9) || (blocksize_bits > PAGE_SHIFT))
Patrick J. LoPresti30ca22c2010-07-22 15:03:41 -07001009 return -EINVAL;
1010
Joel Beckera33f13e2010-08-16 12:10:17 -07001011 if ((last_fs_block > (sector_t)(~0ULL) >> (blocksize_bits - 9)) ||
1012 (last_fs_page > (pgoff_t)(~0ULL))) {
Patrick J. LoPresti30ca22c2010-07-22 15:03:41 -07001013 return -EFBIG;
1014 }
1015 return 0;
1016}
1017EXPORT_SYMBOL(generic_check_addressable);
1018
Christoph Hellwig1b061d92010-05-26 17:53:41 +02001019/*
1020 * No-op implementation of ->fsync for in-memory filesystems.
1021 */
Josef Bacik02c24a82011-07-16 20:44:56 -04001022int noop_fsync(struct file *file, loff_t start, loff_t end, int datasync)
Christoph Hellwig1b061d92010-05-26 17:53:41 +02001023{
1024 return 0;
1025}
Christoph Hellwig1b061d92010-05-26 17:53:41 +02001026EXPORT_SYMBOL(noop_fsync);
Al Viro87dc8002013-09-16 10:30:04 -04001027
Al Virofceef392015-12-29 15:58:39 -05001028/* Because kfree isn't assignment-compatible with void(void*) ;-/ */
1029void kfree_link(void *p)
Al Viro87dc8002013-09-16 10:30:04 -04001030{
Al Virofceef392015-12-29 15:58:39 -05001031 kfree(p);
Al Viro87dc8002013-09-16 10:30:04 -04001032}
Al Virofceef392015-12-29 15:58:39 -05001033EXPORT_SYMBOL(kfree_link);
Al Viro69878432013-10-02 22:35:11 -04001034
1035/*
1036 * nop .set_page_dirty method so that people can use .page_mkwrite on
1037 * anon inodes.
1038 */
1039static int anon_set_page_dirty(struct page *page)
1040{
1041 return 0;
1042};
1043
1044/*
1045 * A single inode exists for all anon_inode files. Contrary to pipes,
1046 * anon_inode inodes have no associated per-instance data, so we need
1047 * only allocate one of them.
1048 */
1049struct inode *alloc_anon_inode(struct super_block *s)
1050{
1051 static const struct address_space_operations anon_aops = {
1052 .set_page_dirty = anon_set_page_dirty,
1053 };
1054 struct inode *inode = new_inode_pseudo(s);
1055
1056 if (!inode)
1057 return ERR_PTR(-ENOMEM);
1058
1059 inode->i_ino = get_next_ino();
1060 inode->i_mapping->a_ops = &anon_aops;
1061
1062 /*
1063 * Mark the inode dirty from the very beginning,
1064 * that way it will never be moved to the dirty
1065 * list because mark_inode_dirty() will think
1066 * that it already _is_ on the dirty list.
1067 */
1068 inode->i_state = I_DIRTY;
1069 inode->i_mode = S_IRUSR | S_IWUSR;
1070 inode->i_uid = current_fsuid();
1071 inode->i_gid = current_fsgid();
1072 inode->i_flags |= S_PRIVATE;
1073 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
1074 return inode;
1075}
1076EXPORT_SYMBOL(alloc_anon_inode);
Jeff Layton1c994a02014-08-27 06:49:41 -04001077
1078/**
1079 * simple_nosetlease - generic helper for prohibiting leases
1080 * @filp: file pointer
1081 * @arg: type of lease to obtain
1082 * @flp: new lease supplied for insertion
Jeff Laytone6f5c782014-08-22 10:40:25 -04001083 * @priv: private data for lm_setup operation
Jeff Layton1c994a02014-08-27 06:49:41 -04001084 *
1085 * Generic helper for filesystems that do not wish to allow leases to be set.
1086 * All arguments are ignored and it just returns -EINVAL.
1087 */
1088int
Jeff Laytone6f5c782014-08-22 10:40:25 -04001089simple_nosetlease(struct file *filp, long arg, struct file_lock **flp,
1090 void **priv)
Jeff Layton1c994a02014-08-27 06:49:41 -04001091{
1092 return -EINVAL;
1093}
1094EXPORT_SYMBOL(simple_nosetlease);
Al Viro61ba64f2015-05-02 09:54:06 -04001095
Al Viro6b255392015-11-17 10:20:54 -05001096const char *simple_get_link(struct dentry *dentry, struct inode *inode,
Al Virofceef392015-12-29 15:58:39 -05001097 struct delayed_call *done)
Al Viro61ba64f2015-05-02 09:54:06 -04001098{
Al Viro6b255392015-11-17 10:20:54 -05001099 return inode->i_link;
Al Viro61ba64f2015-05-02 09:54:06 -04001100}
Al Viro6b255392015-11-17 10:20:54 -05001101EXPORT_SYMBOL(simple_get_link);
Al Viro61ba64f2015-05-02 09:54:06 -04001102
1103const struct inode_operations simple_symlink_inode_operations = {
Al Viro6b255392015-11-17 10:20:54 -05001104 .get_link = simple_get_link,
Al Viro61ba64f2015-05-02 09:54:06 -04001105 .readlink = generic_readlink
1106};
1107EXPORT_SYMBOL(simple_symlink_inode_operations);
Eric W. Biedermanfbabfd02015-05-09 15:54:49 -05001108
1109/*
1110 * Operations for a permanently empty directory.
1111 */
1112static struct dentry *empty_dir_lookup(struct inode *dir, struct dentry *dentry, unsigned int flags)
1113{
1114 return ERR_PTR(-ENOENT);
1115}
1116
1117static int empty_dir_getattr(struct vfsmount *mnt, struct dentry *dentry,
1118 struct kstat *stat)
1119{
1120 struct inode *inode = d_inode(dentry);
1121 generic_fillattr(inode, stat);
1122 return 0;
1123}
1124
1125static int empty_dir_setattr(struct dentry *dentry, struct iattr *attr)
1126{
1127 return -EPERM;
1128}
1129
Al Viro3767e252016-05-27 11:06:05 -04001130static int empty_dir_setxattr(struct dentry *dentry, struct inode *inode,
1131 const char *name, const void *value,
1132 size_t size, int flags)
Eric W. Biedermanfbabfd02015-05-09 15:54:49 -05001133{
1134 return -EOPNOTSUPP;
1135}
1136
Al Viroce23e642016-04-11 00:48:00 -04001137static ssize_t empty_dir_getxattr(struct dentry *dentry, struct inode *inode,
1138 const char *name, void *value, size_t size)
Eric W. Biedermanfbabfd02015-05-09 15:54:49 -05001139{
1140 return -EOPNOTSUPP;
1141}
1142
1143static int empty_dir_removexattr(struct dentry *dentry, const char *name)
1144{
1145 return -EOPNOTSUPP;
1146}
1147
1148static ssize_t empty_dir_listxattr(struct dentry *dentry, char *list, size_t size)
1149{
1150 return -EOPNOTSUPP;
1151}
1152
1153static const struct inode_operations empty_dir_inode_operations = {
1154 .lookup = empty_dir_lookup,
1155 .permission = generic_permission,
1156 .setattr = empty_dir_setattr,
1157 .getattr = empty_dir_getattr,
1158 .setxattr = empty_dir_setxattr,
1159 .getxattr = empty_dir_getxattr,
1160 .removexattr = empty_dir_removexattr,
1161 .listxattr = empty_dir_listxattr,
1162};
1163
1164static loff_t empty_dir_llseek(struct file *file, loff_t offset, int whence)
1165{
1166 /* An empty directory has two entries . and .. at offsets 0 and 1 */
1167 return generic_file_llseek_size(file, offset, whence, 2, 2);
1168}
1169
1170static int empty_dir_readdir(struct file *file, struct dir_context *ctx)
1171{
1172 dir_emit_dots(file, ctx);
1173 return 0;
1174}
1175
1176static const struct file_operations empty_dir_operations = {
1177 .llseek = empty_dir_llseek,
1178 .read = generic_read_dir,
Al Viroc51da202016-04-30 22:37:34 -04001179 .iterate_shared = empty_dir_readdir,
Eric W. Biedermanfbabfd02015-05-09 15:54:49 -05001180 .fsync = noop_fsync,
1181};
1182
1183
1184void make_empty_dir_inode(struct inode *inode)
1185{
1186 set_nlink(inode, 2);
1187 inode->i_mode = S_IFDIR | S_IRUGO | S_IXUGO;
1188 inode->i_uid = GLOBAL_ROOT_UID;
1189 inode->i_gid = GLOBAL_ROOT_GID;
1190 inode->i_rdev = 0;
Eric W. Biederman4b75de862015-08-12 15:00:12 -05001191 inode->i_size = 0;
Eric W. Biedermanfbabfd02015-05-09 15:54:49 -05001192 inode->i_blkbits = PAGE_SHIFT;
1193 inode->i_blocks = 0;
1194
1195 inode->i_op = &empty_dir_inode_operations;
1196 inode->i_fop = &empty_dir_operations;
1197}
1198
1199bool is_empty_dir_inode(struct inode *inode)
1200{
1201 return (inode->i_fop == &empty_dir_operations) &&
1202 (inode->i_op == &empty_dir_inode_operations);
1203}