blob: cd88abdcb4368944276baab70d3de90eca8d4c1c [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * fs/libfs.c
3 * Library for filesystems writers.
4 */
5
6#include <linux/module.h>
7#include <linux/pagemap.h>
8#include <linux/mount.h>
9#include <linux/vfs.h>
Ingo Molnar7cf34c72006-03-23 03:00:36 -080010#include <linux/mutex.h>
Christoph Hellwig25961102007-10-21 16:42:05 -070011#include <linux/exportfs.h>
Al Virod5aacad2009-06-07 14:56:44 -040012#include <linux/writeback.h>
13#include <linux/buffer_head.h>
Ingo Molnar7cf34c72006-03-23 03:00:36 -080014
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include <asm/uaccess.h>
16
17int simple_getattr(struct vfsmount *mnt, struct dentry *dentry,
18 struct kstat *stat)
19{
20 struct inode *inode = dentry->d_inode;
21 generic_fillattr(inode, stat);
22 stat->blocks = inode->i_mapping->nrpages << (PAGE_CACHE_SHIFT - 9);
23 return 0;
24}
25
David Howells726c3342006-06-23 02:02:58 -070026int simple_statfs(struct dentry *dentry, struct kstatfs *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -070027{
David Howells726c3342006-06-23 02:02:58 -070028 buf->f_type = dentry->d_sb->s_magic;
Linus Torvalds1da177e2005-04-16 15:20:36 -070029 buf->f_bsize = PAGE_CACHE_SIZE;
30 buf->f_namelen = NAME_MAX;
31 return 0;
32}
33
34/*
35 * Retaining negative dentries for an in-memory filesystem just wastes
36 * memory and lookup time: arrange for them to be deleted immediately.
37 */
38static int simple_delete_dentry(struct dentry *dentry)
39{
40 return 1;
41}
42
43/*
44 * Lookup the data. This is trivial - if the dentry didn't already
45 * exist, we know it is negative. Set d_op to delete negative dentries.
46 */
47struct dentry *simple_lookup(struct inode *dir, struct dentry *dentry, struct nameidata *nd)
48{
Al Viro3ba13d12009-02-20 06:02:22 +000049 static const struct dentry_operations simple_dentry_operations = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070050 .d_delete = simple_delete_dentry,
51 };
52
53 if (dentry->d_name.len > NAME_MAX)
54 return ERR_PTR(-ENAMETOOLONG);
55 dentry->d_op = &simple_dentry_operations;
56 d_add(dentry, NULL);
57 return NULL;
58}
59
60int simple_sync_file(struct file * file, struct dentry *dentry, int datasync)
61{
62 return 0;
63}
64
65int dcache_dir_open(struct inode *inode, struct file *file)
66{
67 static struct qstr cursor_name = {.len = 1, .name = "."};
68
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -080069 file->private_data = d_alloc(file->f_path.dentry, &cursor_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -070070
71 return file->private_data ? 0 : -ENOMEM;
72}
73
74int dcache_dir_close(struct inode *inode, struct file *file)
75{
76 dput(file->private_data);
77 return 0;
78}
79
80loff_t dcache_dir_lseek(struct file *file, loff_t offset, int origin)
81{
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -080082 mutex_lock(&file->f_path.dentry->d_inode->i_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070083 switch (origin) {
84 case 1:
85 offset += file->f_pos;
86 case 0:
87 if (offset >= 0)
88 break;
89 default:
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -080090 mutex_unlock(&file->f_path.dentry->d_inode->i_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070091 return -EINVAL;
92 }
93 if (offset != file->f_pos) {
94 file->f_pos = offset;
95 if (file->f_pos >= 2) {
96 struct list_head *p;
97 struct dentry *cursor = file->private_data;
98 loff_t n = file->f_pos - 2;
99
100 spin_lock(&dcache_lock);
Eric Dumazet5160ee62006-01-08 01:03:32 -0800101 list_del(&cursor->d_u.d_child);
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800102 p = file->f_path.dentry->d_subdirs.next;
103 while (n && p != &file->f_path.dentry->d_subdirs) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 struct dentry *next;
Eric Dumazet5160ee62006-01-08 01:03:32 -0800105 next = list_entry(p, struct dentry, d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106 if (!d_unhashed(next) && next->d_inode)
107 n--;
108 p = p->next;
109 }
Eric Dumazet5160ee62006-01-08 01:03:32 -0800110 list_add_tail(&cursor->d_u.d_child, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 spin_unlock(&dcache_lock);
112 }
113 }
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800114 mutex_unlock(&file->f_path.dentry->d_inode->i_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 return offset;
116}
117
118/* Relationship between i_mode and the DT_xxx types */
119static inline unsigned char dt_type(struct inode *inode)
120{
121 return (inode->i_mode >> 12) & 15;
122}
123
124/*
125 * Directory is locked and all positive dentries in it are safe, since
126 * for ramfs-type trees they can't go away without unlink() or rmdir(),
127 * both impossible due to the lock on directory.
128 */
129
130int dcache_readdir(struct file * filp, void * dirent, filldir_t filldir)
131{
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800132 struct dentry *dentry = filp->f_path.dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 struct dentry *cursor = filp->private_data;
Eric Dumazet5160ee62006-01-08 01:03:32 -0800134 struct list_head *p, *q = &cursor->d_u.d_child;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 ino_t ino;
136 int i = filp->f_pos;
137
138 switch (i) {
139 case 0:
140 ino = dentry->d_inode->i_ino;
141 if (filldir(dirent, ".", 1, i, ino, DT_DIR) < 0)
142 break;
143 filp->f_pos++;
144 i++;
145 /* fallthrough */
146 case 1:
147 ino = parent_ino(dentry);
148 if (filldir(dirent, "..", 2, i, ino, DT_DIR) < 0)
149 break;
150 filp->f_pos++;
151 i++;
152 /* fallthrough */
153 default:
154 spin_lock(&dcache_lock);
Akinobu Mita1bfba4e2006-06-26 00:24:40 -0700155 if (filp->f_pos == 2)
156 list_move(q, &dentry->d_subdirs);
157
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 for (p=q->next; p != &dentry->d_subdirs; p=p->next) {
159 struct dentry *next;
Eric Dumazet5160ee62006-01-08 01:03:32 -0800160 next = list_entry(p, struct dentry, d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 if (d_unhashed(next) || !next->d_inode)
162 continue;
163
164 spin_unlock(&dcache_lock);
Ronni Nielsen0f8952c22007-05-09 06:44:57 +0200165 if (filldir(dirent, next->d_name.name,
166 next->d_name.len, filp->f_pos,
167 next->d_inode->i_ino,
168 dt_type(next->d_inode)) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169 return 0;
170 spin_lock(&dcache_lock);
171 /* next is still alive */
Akinobu Mita1bfba4e2006-06-26 00:24:40 -0700172 list_move(q, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 p = q;
174 filp->f_pos++;
175 }
176 spin_unlock(&dcache_lock);
177 }
178 return 0;
179}
180
181ssize_t generic_read_dir(struct file *filp, char __user *buf, size_t siz, loff_t *ppos)
182{
183 return -EISDIR;
184}
185
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -0800186const struct file_operations simple_dir_operations = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 .open = dcache_dir_open,
188 .release = dcache_dir_close,
189 .llseek = dcache_dir_lseek,
190 .read = generic_read_dir,
191 .readdir = dcache_readdir,
Hugh Dickins8ae0b772005-06-25 14:55:41 -0700192 .fsync = simple_sync_file,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193};
194
Arjan van de Ven92e1d5b2007-02-12 00:55:39 -0800195const struct inode_operations simple_dir_inode_operations = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196 .lookup = simple_lookup,
197};
198
Hugh Dickins759b9772007-03-05 00:30:28 -0800199static const struct super_operations simple_super_operations = {
200 .statfs = simple_statfs,
201};
202
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203/*
204 * Common helper for pseudo-filesystems (sockfs, pipefs, bdev - stuff that
205 * will never be mountable)
206 */
David Howells454e2392006-06-23 02:02:57 -0700207int get_sb_pseudo(struct file_system_type *fs_type, char *name,
Josef 'Jeff' Sipekee9b6d62007-02-12 00:55:41 -0800208 const struct super_operations *ops, unsigned long magic,
David Howells454e2392006-06-23 02:02:57 -0700209 struct vfsmount *mnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210{
211 struct super_block *s = sget(fs_type, NULL, set_anon_super, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212 struct dentry *dentry;
213 struct inode *root;
214 struct qstr d_name = {.name = name, .len = strlen(name)};
215
216 if (IS_ERR(s))
David Howells454e2392006-06-23 02:02:57 -0700217 return PTR_ERR(s);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218
219 s->s_flags = MS_NOUSER;
Jeff Layton89a4eb42009-08-18 14:11:08 -0700220 s->s_maxbytes = MAX_LFS_FILESIZE;
Alex Nixon3971e1a2008-07-29 22:33:03 -0700221 s->s_blocksize = PAGE_SIZE;
222 s->s_blocksize_bits = PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 s->s_magic = magic;
Hugh Dickins759b9772007-03-05 00:30:28 -0800224 s->s_op = ops ? ops : &simple_super_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225 s->s_time_gran = 1;
226 root = new_inode(s);
227 if (!root)
228 goto Enomem;
Jeff Layton1a1c9bb2007-05-08 00:32:31 -0700229 /*
230 * since this is the first inode, make it number 1. New inodes created
231 * after this must take care not to collide with it (by passing
232 * max_reserved of 1 to iunique).
233 */
234 root->i_ino = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 root->i_mode = S_IFDIR | S_IRUSR | S_IWUSR;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 root->i_atime = root->i_mtime = root->i_ctime = CURRENT_TIME;
237 dentry = d_alloc(NULL, &d_name);
238 if (!dentry) {
239 iput(root);
240 goto Enomem;
241 }
242 dentry->d_sb = s;
243 dentry->d_parent = dentry;
244 d_instantiate(dentry, root);
245 s->s_root = dentry;
246 s->s_flags |= MS_ACTIVE;
Sukadev Bhattiprolua3ec9472009-03-04 12:06:34 -0800247 simple_set_mnt(mnt, s);
248 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249
250Enomem:
Al Viro6f5bbff2009-05-06 01:34:22 -0400251 deactivate_locked_super(s);
David Howells454e2392006-06-23 02:02:57 -0700252 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253}
254
255int simple_link(struct dentry *old_dentry, struct inode *dir, struct dentry *dentry)
256{
257 struct inode *inode = old_dentry->d_inode;
258
259 inode->i_ctime = dir->i_ctime = dir->i_mtime = CURRENT_TIME;
Dave Hansend8c76e62006-09-30 23:29:04 -0700260 inc_nlink(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 atomic_inc(&inode->i_count);
262 dget(dentry);
263 d_instantiate(dentry, inode);
264 return 0;
265}
266
267static inline int simple_positive(struct dentry *dentry)
268{
269 return dentry->d_inode && !d_unhashed(dentry);
270}
271
272int simple_empty(struct dentry *dentry)
273{
274 struct dentry *child;
275 int ret = 0;
276
277 spin_lock(&dcache_lock);
Eric Dumazet5160ee62006-01-08 01:03:32 -0800278 list_for_each_entry(child, &dentry->d_subdirs, d_u.d_child)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279 if (simple_positive(child))
280 goto out;
281 ret = 1;
282out:
283 spin_unlock(&dcache_lock);
284 return ret;
285}
286
287int simple_unlink(struct inode *dir, struct dentry *dentry)
288{
289 struct inode *inode = dentry->d_inode;
290
291 inode->i_ctime = dir->i_ctime = dir->i_mtime = CURRENT_TIME;
Dave Hansen9a53c3a2006-09-30 23:29:03 -0700292 drop_nlink(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293 dput(dentry);
294 return 0;
295}
296
297int simple_rmdir(struct inode *dir, struct dentry *dentry)
298{
299 if (!simple_empty(dentry))
300 return -ENOTEMPTY;
301
Dave Hansen9a53c3a2006-09-30 23:29:03 -0700302 drop_nlink(dentry->d_inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 simple_unlink(dir, dentry);
Dave Hansen9a53c3a2006-09-30 23:29:03 -0700304 drop_nlink(dir);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305 return 0;
306}
307
308int simple_rename(struct inode *old_dir, struct dentry *old_dentry,
309 struct inode *new_dir, struct dentry *new_dentry)
310{
311 struct inode *inode = old_dentry->d_inode;
312 int they_are_dirs = S_ISDIR(old_dentry->d_inode->i_mode);
313
314 if (!simple_empty(new_dentry))
315 return -ENOTEMPTY;
316
317 if (new_dentry->d_inode) {
318 simple_unlink(new_dir, new_dentry);
319 if (they_are_dirs)
Dave Hansen9a53c3a2006-09-30 23:29:03 -0700320 drop_nlink(old_dir);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321 } else if (they_are_dirs) {
Dave Hansen9a53c3a2006-09-30 23:29:03 -0700322 drop_nlink(old_dir);
Dave Hansend8c76e62006-09-30 23:29:04 -0700323 inc_nlink(new_dir);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 }
325
326 old_dir->i_ctime = old_dir->i_mtime = new_dir->i_ctime =
327 new_dir->i_mtime = inode->i_ctime = CURRENT_TIME;
328
329 return 0;
330}
331
332int simple_readpage(struct file *file, struct page *page)
333{
Pekka J Enbergc0d92cb2006-09-29 01:59:09 -0700334 clear_highpage(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 flush_dcache_page(page);
336 SetPageUptodate(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337 unlock_page(page);
338 return 0;
339}
340
341int simple_prepare_write(struct file *file, struct page *page,
342 unsigned from, unsigned to)
343{
344 if (!PageUptodate(page)) {
Christoph Lametereebd2aa2008-02-04 22:28:29 -0800345 if (to - from != PAGE_CACHE_SIZE)
346 zero_user_segments(page,
347 0, from,
348 to, PAGE_CACHE_SIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349 }
350 return 0;
351}
352
Nick Pigginafddba42007-10-16 01:25:01 -0700353int simple_write_begin(struct file *file, struct address_space *mapping,
354 loff_t pos, unsigned len, unsigned flags,
355 struct page **pagep, void **fsdata)
356{
357 struct page *page;
358 pgoff_t index;
359 unsigned from;
360
361 index = pos >> PAGE_CACHE_SHIFT;
362 from = pos & (PAGE_CACHE_SIZE - 1);
363
Nick Piggin54566b22009-01-04 12:00:53 -0800364 page = grab_cache_page_write_begin(mapping, index, flags);
Nick Pigginafddba42007-10-16 01:25:01 -0700365 if (!page)
366 return -ENOMEM;
367
368 *pagep = page;
369
370 return simple_prepare_write(file, page, from, from+len);
371}
372
Boaz Harroshad2a722f2010-01-12 15:13:47 +0200373/**
374 * simple_write_end - .write_end helper for non-block-device FSes
375 * @available: See .write_end of address_space_operations
376 * @file: "
377 * @mapping: "
378 * @pos: "
379 * @len: "
380 * @copied: "
381 * @page: "
382 * @fsdata: "
383 *
384 * simple_write_end does the minimum needed for updating a page after writing is
385 * done. It has the same API signature as the .write_end of
386 * address_space_operations vector. So it can just be set onto .write_end for
387 * FSes that don't need any other processing. i_mutex is assumed to be held.
388 * Block based filesystems should use generic_write_end().
389 * NOTE: Even though i_size might get updated by this function, mark_inode_dirty
390 * is not called, so a filesystem that actually does store data in .write_inode
391 * should extend on what's done here with a call to mark_inode_dirty() in the
392 * case that i_size has changed.
393 */
394int simple_write_end(struct file *file, struct address_space *mapping,
395 loff_t pos, unsigned len, unsigned copied,
396 struct page *page, void *fsdata)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397{
398 struct inode *inode = page->mapping->host;
Boaz Harroshad2a722f2010-01-12 15:13:47 +0200399 loff_t last_pos = pos + copied;
400
401 /* zero the stale part of the page if we did a short copy */
402 if (copied < len) {
403 unsigned from = pos & (PAGE_CACHE_SIZE - 1);
404
405 zero_user(page, from + copied, len - copied);
406 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407
Nick Piggin955eff52007-02-20 13:58:08 -0800408 if (!PageUptodate(page))
409 SetPageUptodate(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410 /*
411 * No need to use i_size_read() here, the i_size
Jes Sorensen1b1dcc12006-01-09 15:59:24 -0800412 * cannot change under us because we hold the i_mutex.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413 */
Boaz Harroshad2a722f2010-01-12 15:13:47 +0200414 if (last_pos > inode->i_size)
415 i_size_write(inode, last_pos);
416
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 set_page_dirty(page);
Nick Pigginafddba42007-10-16 01:25:01 -0700418 unlock_page(page);
419 page_cache_release(page);
420
421 return copied;
422}
423
Jeff Layton1a1c9bb2007-05-08 00:32:31 -0700424/*
425 * the inodes created here are not hashed. If you use iunique to generate
426 * unique inode values later for this filesystem, then you must take care
427 * to pass it an appropriate max_reserved value to avoid collisions.
428 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429int simple_fill_super(struct super_block *s, int magic, struct tree_descr *files)
430{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 struct inode *inode;
432 struct dentry *root;
433 struct dentry *dentry;
434 int i;
435
436 s->s_blocksize = PAGE_CACHE_SIZE;
437 s->s_blocksize_bits = PAGE_CACHE_SHIFT;
438 s->s_magic = magic;
Hugh Dickins759b9772007-03-05 00:30:28 -0800439 s->s_op = &simple_super_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 s->s_time_gran = 1;
441
442 inode = new_inode(s);
443 if (!inode)
444 return -ENOMEM;
Jeff Layton1a1c9bb2007-05-08 00:32:31 -0700445 /*
446 * because the root inode is 1, the files array must not contain an
447 * entry at index 1
448 */
449 inode->i_ino = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 inode->i_mode = S_IFDIR | 0755;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
452 inode->i_op = &simple_dir_inode_operations;
453 inode->i_fop = &simple_dir_operations;
Vincent Hanquez7656f322006-02-03 03:04:48 -0800454 inode->i_nlink = 2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 root = d_alloc_root(inode);
456 if (!root) {
457 iput(inode);
458 return -ENOMEM;
459 }
460 for (i = 0; !files->name || files->name[0]; i++, files++) {
461 if (!files->name)
462 continue;
Jeff Layton1a1c9bb2007-05-08 00:32:31 -0700463
464 /* warn if it tries to conflict with the root inode */
465 if (unlikely(i == 1))
466 printk(KERN_WARNING "%s: %s passed in a files array"
467 "with an index of 1!\n", __func__,
468 s->s_type->name);
469
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470 dentry = d_alloc_name(root, files->name);
471 if (!dentry)
472 goto out;
473 inode = new_inode(s);
474 if (!inode)
475 goto out;
476 inode->i_mode = S_IFREG | files->mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
478 inode->i_fop = files->ops;
479 inode->i_ino = i;
480 d_add(dentry, inode);
481 }
482 s->s_root = root;
483 return 0;
484out:
485 d_genocide(root);
486 dput(root);
487 return -ENOMEM;
488}
489
490static DEFINE_SPINLOCK(pin_fs_lock);
491
Trond Myklebust1f5ce9e2006-06-09 09:34:16 -0400492int simple_pin_fs(struct file_system_type *type, struct vfsmount **mount, int *count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493{
494 struct vfsmount *mnt = NULL;
495 spin_lock(&pin_fs_lock);
496 if (unlikely(!*mount)) {
497 spin_unlock(&pin_fs_lock);
Trond Myklebust1f5ce9e2006-06-09 09:34:16 -0400498 mnt = vfs_kern_mount(type, 0, type->name, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499 if (IS_ERR(mnt))
500 return PTR_ERR(mnt);
501 spin_lock(&pin_fs_lock);
502 if (!*mount)
503 *mount = mnt;
504 }
505 mntget(*mount);
506 ++*count;
507 spin_unlock(&pin_fs_lock);
508 mntput(mnt);
509 return 0;
510}
511
512void simple_release_fs(struct vfsmount **mount, int *count)
513{
514 struct vfsmount *mnt;
515 spin_lock(&pin_fs_lock);
516 mnt = *mount;
517 if (!--*count)
518 *mount = NULL;
519 spin_unlock(&pin_fs_lock);
520 mntput(mnt);
521}
522
Akinobu Mita6d1029b2008-07-04 09:59:51 -0700523/**
524 * simple_read_from_buffer - copy data from the buffer to user space
525 * @to: the user space buffer to read to
526 * @count: the maximum number of bytes to read
527 * @ppos: the current position in the buffer
528 * @from: the buffer to read from
529 * @available: the size of the buffer
530 *
531 * The simple_read_from_buffer() function reads up to @count bytes from the
532 * buffer @from at offset @ppos into the user space address starting at @to.
533 *
534 * On success, the number of bytes read is returned and the offset @ppos is
535 * advanced by this number, or negative value is returned on error.
536 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537ssize_t simple_read_from_buffer(void __user *to, size_t count, loff_t *ppos,
538 const void *from, size_t available)
539{
540 loff_t pos = *ppos;
Steven Rostedt14be2742009-09-18 13:05:42 -0700541 size_t ret;
542
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543 if (pos < 0)
544 return -EINVAL;
Steven Rostedt14be2742009-09-18 13:05:42 -0700545 if (pos >= available || !count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546 return 0;
547 if (count > available - pos)
548 count = available - pos;
Steven Rostedt14be2742009-09-18 13:05:42 -0700549 ret = copy_to_user(to, from + pos, count);
550 if (ret == count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 return -EFAULT;
Steven Rostedt14be2742009-09-18 13:05:42 -0700552 count -= ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 *ppos = pos + count;
554 return count;
555}
556
Akinobu Mita6d1029b2008-07-04 09:59:51 -0700557/**
558 * memory_read_from_buffer - copy data from the buffer
559 * @to: the kernel space buffer to read to
560 * @count: the maximum number of bytes to read
561 * @ppos: the current position in the buffer
562 * @from: the buffer to read from
563 * @available: the size of the buffer
564 *
565 * The memory_read_from_buffer() function reads up to @count bytes from the
566 * buffer @from at offset @ppos into the kernel space address starting at @to.
567 *
568 * On success, the number of bytes read is returned and the offset @ppos is
569 * advanced by this number, or negative value is returned on error.
570 **/
Akinobu Mita93b07112008-06-05 22:46:21 -0700571ssize_t memory_read_from_buffer(void *to, size_t count, loff_t *ppos,
572 const void *from, size_t available)
573{
574 loff_t pos = *ppos;
575
576 if (pos < 0)
577 return -EINVAL;
578 if (pos >= available)
579 return 0;
580 if (count > available - pos)
581 count = available - pos;
582 memcpy(to, from + pos, count);
583 *ppos = pos + count;
584
585 return count;
586}
587
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588/*
589 * Transaction based IO.
590 * The file expects a single write which triggers the transaction, and then
591 * possibly a read which collects the result - which is stored in a
592 * file-local buffer.
593 */
Ingo Molnar76791ab2009-03-25 16:48:35 +0100594
595void simple_transaction_set(struct file *file, size_t n)
596{
597 struct simple_transaction_argresp *ar = file->private_data;
598
599 BUG_ON(n > SIMPLE_TRANSACTION_LIMIT);
600
601 /*
602 * The barrier ensures that ar->size will really remain zero until
603 * ar->data is ready for reading.
604 */
605 smp_mb();
606 ar->size = n;
607}
608
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609char *simple_transaction_get(struct file *file, const char __user *buf, size_t size)
610{
611 struct simple_transaction_argresp *ar;
612 static DEFINE_SPINLOCK(simple_transaction_lock);
613
614 if (size > SIMPLE_TRANSACTION_LIMIT - 1)
615 return ERR_PTR(-EFBIG);
616
617 ar = (struct simple_transaction_argresp *)get_zeroed_page(GFP_KERNEL);
618 if (!ar)
619 return ERR_PTR(-ENOMEM);
620
621 spin_lock(&simple_transaction_lock);
622
623 /* only one write allowed per open */
624 if (file->private_data) {
625 spin_unlock(&simple_transaction_lock);
626 free_page((unsigned long)ar);
627 return ERR_PTR(-EBUSY);
628 }
629
630 file->private_data = ar;
631
632 spin_unlock(&simple_transaction_lock);
633
634 if (copy_from_user(ar->data, buf, size))
635 return ERR_PTR(-EFAULT);
636
637 return ar->data;
638}
639
640ssize_t simple_transaction_read(struct file *file, char __user *buf, size_t size, loff_t *pos)
641{
642 struct simple_transaction_argresp *ar = file->private_data;
643
644 if (!ar)
645 return 0;
646 return simple_read_from_buffer(buf, size, pos, ar->data, ar->size);
647}
648
649int simple_transaction_release(struct inode *inode, struct file *file)
650{
651 free_page((unsigned long)file->private_data);
652 return 0;
653}
654
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200655/* Simple attribute files */
656
657struct simple_attr {
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800658 int (*get)(void *, u64 *);
659 int (*set)(void *, u64);
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200660 char get_buf[24]; /* enough to store a u64 and "\n\0" */
661 char set_buf[24];
662 void *data;
663 const char *fmt; /* format for read operation */
Ingo Molnar7cf34c72006-03-23 03:00:36 -0800664 struct mutex mutex; /* protects access to these buffers */
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200665};
666
667/* simple_attr_open is called by an actual attribute open file operation
668 * to set the attribute specific access operations. */
669int simple_attr_open(struct inode *inode, struct file *file,
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800670 int (*get)(void *, u64 *), int (*set)(void *, u64),
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200671 const char *fmt)
672{
673 struct simple_attr *attr;
674
675 attr = kmalloc(sizeof(*attr), GFP_KERNEL);
676 if (!attr)
677 return -ENOMEM;
678
679 attr->get = get;
680 attr->set = set;
Theodore Ts'o8e18e292006-09-27 01:50:46 -0700681 attr->data = inode->i_private;
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200682 attr->fmt = fmt;
Ingo Molnar7cf34c72006-03-23 03:00:36 -0800683 mutex_init(&attr->mutex);
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200684
685 file->private_data = attr;
686
687 return nonseekable_open(inode, file);
688}
689
Christoph Hellwig74bedc42008-02-08 04:20:28 -0800690int simple_attr_release(struct inode *inode, struct file *file)
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200691{
692 kfree(file->private_data);
693 return 0;
694}
695
696/* read from the buffer that is filled with the get function */
697ssize_t simple_attr_read(struct file *file, char __user *buf,
698 size_t len, loff_t *ppos)
699{
700 struct simple_attr *attr;
701 size_t size;
702 ssize_t ret;
703
704 attr = file->private_data;
705
706 if (!attr->get)
707 return -EACCES;
708
Christoph Hellwig92613032008-02-08 04:20:27 -0800709 ret = mutex_lock_interruptible(&attr->mutex);
710 if (ret)
711 return ret;
712
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800713 if (*ppos) { /* continued read */
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200714 size = strlen(attr->get_buf);
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800715 } else { /* first read */
716 u64 val;
717 ret = attr->get(attr->data, &val);
718 if (ret)
719 goto out;
720
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200721 size = scnprintf(attr->get_buf, sizeof(attr->get_buf),
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800722 attr->fmt, (unsigned long long)val);
723 }
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200724
725 ret = simple_read_from_buffer(buf, len, ppos, attr->get_buf, size);
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800726out:
Ingo Molnar7cf34c72006-03-23 03:00:36 -0800727 mutex_unlock(&attr->mutex);
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200728 return ret;
729}
730
731/* interpret the buffer as a number to call the set function with */
732ssize_t simple_attr_write(struct file *file, const char __user *buf,
733 size_t len, loff_t *ppos)
734{
735 struct simple_attr *attr;
736 u64 val;
737 size_t size;
738 ssize_t ret;
739
740 attr = file->private_data;
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200741 if (!attr->set)
742 return -EACCES;
743
Christoph Hellwig92613032008-02-08 04:20:27 -0800744 ret = mutex_lock_interruptible(&attr->mutex);
745 if (ret)
746 return ret;
747
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200748 ret = -EFAULT;
749 size = min(sizeof(attr->set_buf) - 1, len);
750 if (copy_from_user(attr->set_buf, buf, size))
751 goto out;
752
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200753 attr->set_buf[size] = '\0';
754 val = simple_strtol(attr->set_buf, NULL, 0);
Wu Fengguang05cc0ce2009-09-18 13:06:03 -0700755 ret = attr->set(attr->data, val);
756 if (ret == 0)
757 ret = len; /* on success, claim we got the whole input */
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200758out:
Ingo Molnar7cf34c72006-03-23 03:00:36 -0800759 mutex_unlock(&attr->mutex);
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200760 return ret;
761}
762
Christoph Hellwig25961102007-10-21 16:42:05 -0700763/**
764 * generic_fh_to_dentry - generic helper for the fh_to_dentry export operation
765 * @sb: filesystem to do the file handle conversion on
766 * @fid: file handle to convert
767 * @fh_len: length of the file handle in bytes
768 * @fh_type: type of file handle
769 * @get_inode: filesystem callback to retrieve inode
770 *
771 * This function decodes @fid as long as it has one of the well-known
772 * Linux filehandle types and calls @get_inode on it to retrieve the
773 * inode for the object specified in the file handle.
774 */
775struct dentry *generic_fh_to_dentry(struct super_block *sb, struct fid *fid,
776 int fh_len, int fh_type, struct inode *(*get_inode)
777 (struct super_block *sb, u64 ino, u32 gen))
778{
779 struct inode *inode = NULL;
780
781 if (fh_len < 2)
782 return NULL;
783
784 switch (fh_type) {
785 case FILEID_INO32_GEN:
786 case FILEID_INO32_GEN_PARENT:
787 inode = get_inode(sb, fid->i32.ino, fid->i32.gen);
788 break;
789 }
790
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +0200791 return d_obtain_alias(inode);
Christoph Hellwig25961102007-10-21 16:42:05 -0700792}
793EXPORT_SYMBOL_GPL(generic_fh_to_dentry);
794
795/**
796 * generic_fh_to_dentry - generic helper for the fh_to_parent export operation
797 * @sb: filesystem to do the file handle conversion on
798 * @fid: file handle to convert
799 * @fh_len: length of the file handle in bytes
800 * @fh_type: type of file handle
801 * @get_inode: filesystem callback to retrieve inode
802 *
803 * This function decodes @fid as long as it has one of the well-known
804 * Linux filehandle types and calls @get_inode on it to retrieve the
805 * inode for the _parent_ object specified in the file handle if it
806 * is specified in the file handle, or NULL otherwise.
807 */
808struct dentry *generic_fh_to_parent(struct super_block *sb, struct fid *fid,
809 int fh_len, int fh_type, struct inode *(*get_inode)
810 (struct super_block *sb, u64 ino, u32 gen))
811{
812 struct inode *inode = NULL;
813
814 if (fh_len <= 2)
815 return NULL;
816
817 switch (fh_type) {
818 case FILEID_INO32_GEN_PARENT:
819 inode = get_inode(sb, fid->i32.parent_ino,
820 (fh_len > 3 ? fid->i32.parent_gen : 0));
821 break;
822 }
823
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +0200824 return d_obtain_alias(inode);
Christoph Hellwig25961102007-10-21 16:42:05 -0700825}
826EXPORT_SYMBOL_GPL(generic_fh_to_parent);
827
Al Virod5aacad2009-06-07 14:56:44 -0400828int simple_fsync(struct file *file, struct dentry *dentry, int datasync)
829{
830 struct writeback_control wbc = {
831 .sync_mode = WB_SYNC_ALL,
832 .nr_to_write = 0, /* metadata-only; caller takes care of data */
833 };
834 struct inode *inode = dentry->d_inode;
835 int err;
836 int ret;
837
838 ret = sync_mapping_buffers(inode->i_mapping);
839 if (!(inode->i_state & I_DIRTY))
840 return ret;
841 if (datasync && !(inode->i_state & I_DIRTY_DATASYNC))
842 return ret;
843
844 err = sync_inode(inode, &wbc);
845 if (ret == 0)
846 ret = err;
847 return ret;
848}
849EXPORT_SYMBOL(simple_fsync);
850
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851EXPORT_SYMBOL(dcache_dir_close);
852EXPORT_SYMBOL(dcache_dir_lseek);
853EXPORT_SYMBOL(dcache_dir_open);
854EXPORT_SYMBOL(dcache_readdir);
855EXPORT_SYMBOL(generic_read_dir);
856EXPORT_SYMBOL(get_sb_pseudo);
Nick Pigginafddba42007-10-16 01:25:01 -0700857EXPORT_SYMBOL(simple_write_begin);
858EXPORT_SYMBOL(simple_write_end);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859EXPORT_SYMBOL(simple_dir_inode_operations);
860EXPORT_SYMBOL(simple_dir_operations);
861EXPORT_SYMBOL(simple_empty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862EXPORT_SYMBOL(simple_fill_super);
863EXPORT_SYMBOL(simple_getattr);
864EXPORT_SYMBOL(simple_link);
865EXPORT_SYMBOL(simple_lookup);
866EXPORT_SYMBOL(simple_pin_fs);
Nick Piggin4e02ed42008-10-29 14:00:55 -0700867EXPORT_UNUSED_SYMBOL(simple_prepare_write);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868EXPORT_SYMBOL(simple_readpage);
869EXPORT_SYMBOL(simple_release_fs);
870EXPORT_SYMBOL(simple_rename);
871EXPORT_SYMBOL(simple_rmdir);
872EXPORT_SYMBOL(simple_statfs);
873EXPORT_SYMBOL(simple_sync_file);
874EXPORT_SYMBOL(simple_unlink);
875EXPORT_SYMBOL(simple_read_from_buffer);
Akinobu Mita93b07112008-06-05 22:46:21 -0700876EXPORT_SYMBOL(memory_read_from_buffer);
Ingo Molnar76791ab2009-03-25 16:48:35 +0100877EXPORT_SYMBOL(simple_transaction_set);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878EXPORT_SYMBOL(simple_transaction_get);
879EXPORT_SYMBOL(simple_transaction_read);
880EXPORT_SYMBOL(simple_transaction_release);
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200881EXPORT_SYMBOL_GPL(simple_attr_open);
Christoph Hellwig74bedc42008-02-08 04:20:28 -0800882EXPORT_SYMBOL_GPL(simple_attr_release);
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200883EXPORT_SYMBOL_GPL(simple_attr_read);
884EXPORT_SYMBOL_GPL(simple_attr_write);