blob: 4910a36f516e3081bcb61713260bb2ca637a9612 [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>
Ingo Molnar7cf34c72006-03-23 03:00:36 -080012
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#include <asm/uaccess.h>
14
15int simple_getattr(struct vfsmount *mnt, struct dentry *dentry,
16 struct kstat *stat)
17{
18 struct inode *inode = dentry->d_inode;
19 generic_fillattr(inode, stat);
20 stat->blocks = inode->i_mapping->nrpages << (PAGE_CACHE_SHIFT - 9);
21 return 0;
22}
23
David Howells726c3342006-06-23 02:02:58 -070024int simple_statfs(struct dentry *dentry, struct kstatfs *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -070025{
David Howells726c3342006-06-23 02:02:58 -070026 buf->f_type = dentry->d_sb->s_magic;
Linus Torvalds1da177e2005-04-16 15:20:36 -070027 buf->f_bsize = PAGE_CACHE_SIZE;
28 buf->f_namelen = NAME_MAX;
29 return 0;
30}
31
32/*
33 * Retaining negative dentries for an in-memory filesystem just wastes
34 * memory and lookup time: arrange for them to be deleted immediately.
35 */
36static int simple_delete_dentry(struct dentry *dentry)
37{
38 return 1;
39}
40
41/*
42 * Lookup the data. This is trivial - if the dentry didn't already
43 * exist, we know it is negative. Set d_op to delete negative dentries.
44 */
45struct dentry *simple_lookup(struct inode *dir, struct dentry *dentry, struct nameidata *nd)
46{
Al Viro3ba13d12009-02-20 06:02:22 +000047 static const struct dentry_operations simple_dentry_operations = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070048 .d_delete = simple_delete_dentry,
49 };
50
51 if (dentry->d_name.len > NAME_MAX)
52 return ERR_PTR(-ENAMETOOLONG);
53 dentry->d_op = &simple_dentry_operations;
54 d_add(dentry, NULL);
55 return NULL;
56}
57
58int simple_sync_file(struct file * file, struct dentry *dentry, int datasync)
59{
60 return 0;
61}
62
63int dcache_dir_open(struct inode *inode, struct file *file)
64{
65 static struct qstr cursor_name = {.len = 1, .name = "."};
66
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -080067 file->private_data = d_alloc(file->f_path.dentry, &cursor_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -070068
69 return file->private_data ? 0 : -ENOMEM;
70}
71
72int dcache_dir_close(struct inode *inode, struct file *file)
73{
74 dput(file->private_data);
75 return 0;
76}
77
78loff_t dcache_dir_lseek(struct file *file, loff_t offset, int origin)
79{
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -080080 mutex_lock(&file->f_path.dentry->d_inode->i_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 switch (origin) {
82 case 1:
83 offset += file->f_pos;
84 case 0:
85 if (offset >= 0)
86 break;
87 default:
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -080088 mutex_unlock(&file->f_path.dentry->d_inode->i_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 return -EINVAL;
90 }
91 if (offset != file->f_pos) {
92 file->f_pos = offset;
93 if (file->f_pos >= 2) {
94 struct list_head *p;
95 struct dentry *cursor = file->private_data;
96 loff_t n = file->f_pos - 2;
97
98 spin_lock(&dcache_lock);
Eric Dumazet5160ee62006-01-08 01:03:32 -080099 list_del(&cursor->d_u.d_child);
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800100 p = file->f_path.dentry->d_subdirs.next;
101 while (n && p != &file->f_path.dentry->d_subdirs) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 struct dentry *next;
Eric Dumazet5160ee62006-01-08 01:03:32 -0800103 next = list_entry(p, struct dentry, d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 if (!d_unhashed(next) && next->d_inode)
105 n--;
106 p = p->next;
107 }
Eric Dumazet5160ee62006-01-08 01:03:32 -0800108 list_add_tail(&cursor->d_u.d_child, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109 spin_unlock(&dcache_lock);
110 }
111 }
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800112 mutex_unlock(&file->f_path.dentry->d_inode->i_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 return offset;
114}
115
116/* Relationship between i_mode and the DT_xxx types */
117static inline unsigned char dt_type(struct inode *inode)
118{
119 return (inode->i_mode >> 12) & 15;
120}
121
122/*
123 * Directory is locked and all positive dentries in it are safe, since
124 * for ramfs-type trees they can't go away without unlink() or rmdir(),
125 * both impossible due to the lock on directory.
126 */
127
128int dcache_readdir(struct file * filp, void * dirent, filldir_t filldir)
129{
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800130 struct dentry *dentry = filp->f_path.dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 struct dentry *cursor = filp->private_data;
Eric Dumazet5160ee62006-01-08 01:03:32 -0800132 struct list_head *p, *q = &cursor->d_u.d_child;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 ino_t ino;
134 int i = filp->f_pos;
135
136 switch (i) {
137 case 0:
138 ino = dentry->d_inode->i_ino;
139 if (filldir(dirent, ".", 1, i, ino, DT_DIR) < 0)
140 break;
141 filp->f_pos++;
142 i++;
143 /* fallthrough */
144 case 1:
145 ino = parent_ino(dentry);
146 if (filldir(dirent, "..", 2, i, ino, DT_DIR) < 0)
147 break;
148 filp->f_pos++;
149 i++;
150 /* fallthrough */
151 default:
152 spin_lock(&dcache_lock);
Akinobu Mita1bfba4e2006-06-26 00:24:40 -0700153 if (filp->f_pos == 2)
154 list_move(q, &dentry->d_subdirs);
155
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 for (p=q->next; p != &dentry->d_subdirs; p=p->next) {
157 struct dentry *next;
Eric Dumazet5160ee62006-01-08 01:03:32 -0800158 next = list_entry(p, struct dentry, d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159 if (d_unhashed(next) || !next->d_inode)
160 continue;
161
162 spin_unlock(&dcache_lock);
Ronni Nielsen0f8952c22007-05-09 06:44:57 +0200163 if (filldir(dirent, next->d_name.name,
164 next->d_name.len, filp->f_pos,
165 next->d_inode->i_ino,
166 dt_type(next->d_inode)) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 return 0;
168 spin_lock(&dcache_lock);
169 /* next is still alive */
Akinobu Mita1bfba4e2006-06-26 00:24:40 -0700170 list_move(q, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 p = q;
172 filp->f_pos++;
173 }
174 spin_unlock(&dcache_lock);
175 }
176 return 0;
177}
178
179ssize_t generic_read_dir(struct file *filp, char __user *buf, size_t siz, loff_t *ppos)
180{
181 return -EISDIR;
182}
183
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -0800184const struct file_operations simple_dir_operations = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185 .open = dcache_dir_open,
186 .release = dcache_dir_close,
187 .llseek = dcache_dir_lseek,
188 .read = generic_read_dir,
189 .readdir = dcache_readdir,
Hugh Dickins8ae0b772005-06-25 14:55:41 -0700190 .fsync = simple_sync_file,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191};
192
Arjan van de Ven92e1d5b2007-02-12 00:55:39 -0800193const struct inode_operations simple_dir_inode_operations = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 .lookup = simple_lookup,
195};
196
Hugh Dickins759b9772007-03-05 00:30:28 -0800197static const struct super_operations simple_super_operations = {
198 .statfs = simple_statfs,
199};
200
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201/*
202 * Common helper for pseudo-filesystems (sockfs, pipefs, bdev - stuff that
203 * will never be mountable)
204 */
David Howells454e2392006-06-23 02:02:57 -0700205int get_sb_pseudo(struct file_system_type *fs_type, char *name,
Josef 'Jeff' Sipekee9b6d62007-02-12 00:55:41 -0800206 const struct super_operations *ops, unsigned long magic,
David Howells454e2392006-06-23 02:02:57 -0700207 struct vfsmount *mnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208{
209 struct super_block *s = sget(fs_type, NULL, set_anon_super, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210 struct dentry *dentry;
211 struct inode *root;
212 struct qstr d_name = {.name = name, .len = strlen(name)};
213
214 if (IS_ERR(s))
David Howells454e2392006-06-23 02:02:57 -0700215 return PTR_ERR(s);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216
217 s->s_flags = MS_NOUSER;
218 s->s_maxbytes = ~0ULL;
Alex Nixon3971e1a2008-07-29 22:33:03 -0700219 s->s_blocksize = PAGE_SIZE;
220 s->s_blocksize_bits = PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 s->s_magic = magic;
Hugh Dickins759b9772007-03-05 00:30:28 -0800222 s->s_op = ops ? ops : &simple_super_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 s->s_time_gran = 1;
224 root = new_inode(s);
225 if (!root)
226 goto Enomem;
Jeff Layton1a1c9bb2007-05-08 00:32:31 -0700227 /*
228 * since this is the first inode, make it number 1. New inodes created
229 * after this must take care not to collide with it (by passing
230 * max_reserved of 1 to iunique).
231 */
232 root->i_ino = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 root->i_mode = S_IFDIR | S_IRUSR | S_IWUSR;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 root->i_atime = root->i_mtime = root->i_ctime = CURRENT_TIME;
235 dentry = d_alloc(NULL, &d_name);
236 if (!dentry) {
237 iput(root);
238 goto Enomem;
239 }
240 dentry->d_sb = s;
241 dentry->d_parent = dentry;
242 d_instantiate(dentry, root);
243 s->s_root = dentry;
244 s->s_flags |= MS_ACTIVE;
Sukadev Bhattiprolua3ec9472009-03-04 12:06:34 -0800245 simple_set_mnt(mnt, s);
246 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
248Enomem:
249 up_write(&s->s_umount);
250 deactivate_super(s);
David Howells454e2392006-06-23 02:02:57 -0700251 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252}
253
254int simple_link(struct dentry *old_dentry, struct inode *dir, struct dentry *dentry)
255{
256 struct inode *inode = old_dentry->d_inode;
257
258 inode->i_ctime = dir->i_ctime = dir->i_mtime = CURRENT_TIME;
Dave Hansend8c76e62006-09-30 23:29:04 -0700259 inc_nlink(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 atomic_inc(&inode->i_count);
261 dget(dentry);
262 d_instantiate(dentry, inode);
263 return 0;
264}
265
266static inline int simple_positive(struct dentry *dentry)
267{
268 return dentry->d_inode && !d_unhashed(dentry);
269}
270
271int simple_empty(struct dentry *dentry)
272{
273 struct dentry *child;
274 int ret = 0;
275
276 spin_lock(&dcache_lock);
Eric Dumazet5160ee62006-01-08 01:03:32 -0800277 list_for_each_entry(child, &dentry->d_subdirs, d_u.d_child)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278 if (simple_positive(child))
279 goto out;
280 ret = 1;
281out:
282 spin_unlock(&dcache_lock);
283 return ret;
284}
285
286int simple_unlink(struct inode *dir, struct dentry *dentry)
287{
288 struct inode *inode = dentry->d_inode;
289
290 inode->i_ctime = dir->i_ctime = dir->i_mtime = CURRENT_TIME;
Dave Hansen9a53c3a2006-09-30 23:29:03 -0700291 drop_nlink(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292 dput(dentry);
293 return 0;
294}
295
296int simple_rmdir(struct inode *dir, struct dentry *dentry)
297{
298 if (!simple_empty(dentry))
299 return -ENOTEMPTY;
300
Dave Hansen9a53c3a2006-09-30 23:29:03 -0700301 drop_nlink(dentry->d_inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302 simple_unlink(dir, dentry);
Dave Hansen9a53c3a2006-09-30 23:29:03 -0700303 drop_nlink(dir);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 return 0;
305}
306
307int simple_rename(struct inode *old_dir, struct dentry *old_dentry,
308 struct inode *new_dir, struct dentry *new_dentry)
309{
310 struct inode *inode = old_dentry->d_inode;
311 int they_are_dirs = S_ISDIR(old_dentry->d_inode->i_mode);
312
313 if (!simple_empty(new_dentry))
314 return -ENOTEMPTY;
315
316 if (new_dentry->d_inode) {
317 simple_unlink(new_dir, new_dentry);
318 if (they_are_dirs)
Dave Hansen9a53c3a2006-09-30 23:29:03 -0700319 drop_nlink(old_dir);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320 } else if (they_are_dirs) {
Dave Hansen9a53c3a2006-09-30 23:29:03 -0700321 drop_nlink(old_dir);
Dave Hansend8c76e62006-09-30 23:29:04 -0700322 inc_nlink(new_dir);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 }
324
325 old_dir->i_ctime = old_dir->i_mtime = new_dir->i_ctime =
326 new_dir->i_mtime = inode->i_ctime = CURRENT_TIME;
327
328 return 0;
329}
330
331int simple_readpage(struct file *file, struct page *page)
332{
Pekka J Enbergc0d92cb2006-09-29 01:59:09 -0700333 clear_highpage(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334 flush_dcache_page(page);
335 SetPageUptodate(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 unlock_page(page);
337 return 0;
338}
339
340int simple_prepare_write(struct file *file, struct page *page,
341 unsigned from, unsigned to)
342{
343 if (!PageUptodate(page)) {
Christoph Lametereebd2aa2008-02-04 22:28:29 -0800344 if (to - from != PAGE_CACHE_SIZE)
345 zero_user_segments(page,
346 0, from,
347 to, PAGE_CACHE_SIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 }
349 return 0;
350}
351
Nick Pigginafddba42007-10-16 01:25:01 -0700352int simple_write_begin(struct file *file, struct address_space *mapping,
353 loff_t pos, unsigned len, unsigned flags,
354 struct page **pagep, void **fsdata)
355{
356 struct page *page;
357 pgoff_t index;
358 unsigned from;
359
360 index = pos >> PAGE_CACHE_SHIFT;
361 from = pos & (PAGE_CACHE_SIZE - 1);
362
Nick Piggin54566b22009-01-04 12:00:53 -0800363 page = grab_cache_page_write_begin(mapping, index, flags);
Nick Pigginafddba42007-10-16 01:25:01 -0700364 if (!page)
365 return -ENOMEM;
366
367 *pagep = page;
368
369 return simple_prepare_write(file, page, from, from+len);
370}
371
Adrian Bunk4a239422007-10-16 23:27:16 -0700372static int simple_commit_write(struct file *file, struct page *page,
373 unsigned from, unsigned to)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374{
375 struct inode *inode = page->mapping->host;
376 loff_t pos = ((loff_t)page->index << PAGE_CACHE_SHIFT) + to;
377
Nick Piggin955eff52007-02-20 13:58:08 -0800378 if (!PageUptodate(page))
379 SetPageUptodate(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380 /*
381 * No need to use i_size_read() here, the i_size
Jes Sorensen1b1dcc12006-01-09 15:59:24 -0800382 * cannot change under us because we hold the i_mutex.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 */
384 if (pos > inode->i_size)
385 i_size_write(inode, pos);
386 set_page_dirty(page);
387 return 0;
388}
389
Nick Pigginafddba42007-10-16 01:25:01 -0700390int simple_write_end(struct file *file, struct address_space *mapping,
391 loff_t pos, unsigned len, unsigned copied,
392 struct page *page, void *fsdata)
393{
394 unsigned from = pos & (PAGE_CACHE_SIZE - 1);
395
396 /* zero the stale part of the page if we did a short copy */
397 if (copied < len) {
398 void *kaddr = kmap_atomic(page, KM_USER0);
399 memset(kaddr + from + copied, 0, len - copied);
400 flush_dcache_page(page);
401 kunmap_atomic(kaddr, KM_USER0);
402 }
403
404 simple_commit_write(file, page, from, from+copied);
405
406 unlock_page(page);
407 page_cache_release(page);
408
409 return copied;
410}
411
Jeff Layton1a1c9bb2007-05-08 00:32:31 -0700412/*
413 * the inodes created here are not hashed. If you use iunique to generate
414 * unique inode values later for this filesystem, then you must take care
415 * to pass it an appropriate max_reserved value to avoid collisions.
416 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417int simple_fill_super(struct super_block *s, int magic, struct tree_descr *files)
418{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 struct inode *inode;
420 struct dentry *root;
421 struct dentry *dentry;
422 int i;
423
424 s->s_blocksize = PAGE_CACHE_SIZE;
425 s->s_blocksize_bits = PAGE_CACHE_SHIFT;
426 s->s_magic = magic;
Hugh Dickins759b9772007-03-05 00:30:28 -0800427 s->s_op = &simple_super_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 s->s_time_gran = 1;
429
430 inode = new_inode(s);
431 if (!inode)
432 return -ENOMEM;
Jeff Layton1a1c9bb2007-05-08 00:32:31 -0700433 /*
434 * because the root inode is 1, the files array must not contain an
435 * entry at index 1
436 */
437 inode->i_ino = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 inode->i_mode = S_IFDIR | 0755;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
440 inode->i_op = &simple_dir_inode_operations;
441 inode->i_fop = &simple_dir_operations;
Vincent Hanquez7656f322006-02-03 03:04:48 -0800442 inode->i_nlink = 2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443 root = d_alloc_root(inode);
444 if (!root) {
445 iput(inode);
446 return -ENOMEM;
447 }
448 for (i = 0; !files->name || files->name[0]; i++, files++) {
449 if (!files->name)
450 continue;
Jeff Layton1a1c9bb2007-05-08 00:32:31 -0700451
452 /* warn if it tries to conflict with the root inode */
453 if (unlikely(i == 1))
454 printk(KERN_WARNING "%s: %s passed in a files array"
455 "with an index of 1!\n", __func__,
456 s->s_type->name);
457
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 dentry = d_alloc_name(root, files->name);
459 if (!dentry)
460 goto out;
461 inode = new_inode(s);
462 if (!inode)
463 goto out;
464 inode->i_mode = S_IFREG | files->mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
466 inode->i_fop = files->ops;
467 inode->i_ino = i;
468 d_add(dentry, inode);
469 }
470 s->s_root = root;
471 return 0;
472out:
473 d_genocide(root);
474 dput(root);
475 return -ENOMEM;
476}
477
478static DEFINE_SPINLOCK(pin_fs_lock);
479
Trond Myklebust1f5ce9e2006-06-09 09:34:16 -0400480int simple_pin_fs(struct file_system_type *type, struct vfsmount **mount, int *count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481{
482 struct vfsmount *mnt = NULL;
483 spin_lock(&pin_fs_lock);
484 if (unlikely(!*mount)) {
485 spin_unlock(&pin_fs_lock);
Trond Myklebust1f5ce9e2006-06-09 09:34:16 -0400486 mnt = vfs_kern_mount(type, 0, type->name, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487 if (IS_ERR(mnt))
488 return PTR_ERR(mnt);
489 spin_lock(&pin_fs_lock);
490 if (!*mount)
491 *mount = mnt;
492 }
493 mntget(*mount);
494 ++*count;
495 spin_unlock(&pin_fs_lock);
496 mntput(mnt);
497 return 0;
498}
499
500void simple_release_fs(struct vfsmount **mount, int *count)
501{
502 struct vfsmount *mnt;
503 spin_lock(&pin_fs_lock);
504 mnt = *mount;
505 if (!--*count)
506 *mount = NULL;
507 spin_unlock(&pin_fs_lock);
508 mntput(mnt);
509}
510
Akinobu Mita6d1029b2008-07-04 09:59:51 -0700511/**
512 * simple_read_from_buffer - copy data from the buffer to user space
513 * @to: the user space buffer to read to
514 * @count: the maximum number of bytes to read
515 * @ppos: the current position in the buffer
516 * @from: the buffer to read from
517 * @available: the size of the buffer
518 *
519 * The simple_read_from_buffer() function reads up to @count bytes from the
520 * buffer @from at offset @ppos into the user space address starting at @to.
521 *
522 * On success, the number of bytes read is returned and the offset @ppos is
523 * advanced by this number, or negative value is returned on error.
524 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525ssize_t simple_read_from_buffer(void __user *to, size_t count, loff_t *ppos,
526 const void *from, size_t available)
527{
528 loff_t pos = *ppos;
529 if (pos < 0)
530 return -EINVAL;
531 if (pos >= available)
532 return 0;
533 if (count > available - pos)
534 count = available - pos;
535 if (copy_to_user(to, from + pos, count))
536 return -EFAULT;
537 *ppos = pos + count;
538 return count;
539}
540
Akinobu Mita6d1029b2008-07-04 09:59:51 -0700541/**
542 * memory_read_from_buffer - copy data from the buffer
543 * @to: the kernel space buffer to read to
544 * @count: the maximum number of bytes to read
545 * @ppos: the current position in the buffer
546 * @from: the buffer to read from
547 * @available: the size of the buffer
548 *
549 * The memory_read_from_buffer() function reads up to @count bytes from the
550 * buffer @from at offset @ppos into the kernel space address starting at @to.
551 *
552 * On success, the number of bytes read is returned and the offset @ppos is
553 * advanced by this number, or negative value is returned on error.
554 **/
Akinobu Mita93b07112008-06-05 22:46:21 -0700555ssize_t memory_read_from_buffer(void *to, size_t count, loff_t *ppos,
556 const void *from, size_t available)
557{
558 loff_t pos = *ppos;
559
560 if (pos < 0)
561 return -EINVAL;
562 if (pos >= available)
563 return 0;
564 if (count > available - pos)
565 count = available - pos;
566 memcpy(to, from + pos, count);
567 *ppos = pos + count;
568
569 return count;
570}
571
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572/*
573 * Transaction based IO.
574 * The file expects a single write which triggers the transaction, and then
575 * possibly a read which collects the result - which is stored in a
576 * file-local buffer.
577 */
578char *simple_transaction_get(struct file *file, const char __user *buf, size_t size)
579{
580 struct simple_transaction_argresp *ar;
581 static DEFINE_SPINLOCK(simple_transaction_lock);
582
583 if (size > SIMPLE_TRANSACTION_LIMIT - 1)
584 return ERR_PTR(-EFBIG);
585
586 ar = (struct simple_transaction_argresp *)get_zeroed_page(GFP_KERNEL);
587 if (!ar)
588 return ERR_PTR(-ENOMEM);
589
590 spin_lock(&simple_transaction_lock);
591
592 /* only one write allowed per open */
593 if (file->private_data) {
594 spin_unlock(&simple_transaction_lock);
595 free_page((unsigned long)ar);
596 return ERR_PTR(-EBUSY);
597 }
598
599 file->private_data = ar;
600
601 spin_unlock(&simple_transaction_lock);
602
603 if (copy_from_user(ar->data, buf, size))
604 return ERR_PTR(-EFAULT);
605
606 return ar->data;
607}
608
609ssize_t simple_transaction_read(struct file *file, char __user *buf, size_t size, loff_t *pos)
610{
611 struct simple_transaction_argresp *ar = file->private_data;
612
613 if (!ar)
614 return 0;
615 return simple_read_from_buffer(buf, size, pos, ar->data, ar->size);
616}
617
618int simple_transaction_release(struct inode *inode, struct file *file)
619{
620 free_page((unsigned long)file->private_data);
621 return 0;
622}
623
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200624/* Simple attribute files */
625
626struct simple_attr {
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800627 int (*get)(void *, u64 *);
628 int (*set)(void *, u64);
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200629 char get_buf[24]; /* enough to store a u64 and "\n\0" */
630 char set_buf[24];
631 void *data;
632 const char *fmt; /* format for read operation */
Ingo Molnar7cf34c72006-03-23 03:00:36 -0800633 struct mutex mutex; /* protects access to these buffers */
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200634};
635
636/* simple_attr_open is called by an actual attribute open file operation
637 * to set the attribute specific access operations. */
638int simple_attr_open(struct inode *inode, struct file *file,
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800639 int (*get)(void *, u64 *), int (*set)(void *, u64),
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200640 const char *fmt)
641{
642 struct simple_attr *attr;
643
644 attr = kmalloc(sizeof(*attr), GFP_KERNEL);
645 if (!attr)
646 return -ENOMEM;
647
648 attr->get = get;
649 attr->set = set;
Theodore Ts'o8e18e292006-09-27 01:50:46 -0700650 attr->data = inode->i_private;
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200651 attr->fmt = fmt;
Ingo Molnar7cf34c72006-03-23 03:00:36 -0800652 mutex_init(&attr->mutex);
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200653
654 file->private_data = attr;
655
656 return nonseekable_open(inode, file);
657}
658
Christoph Hellwig74bedc42008-02-08 04:20:28 -0800659int simple_attr_release(struct inode *inode, struct file *file)
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200660{
661 kfree(file->private_data);
662 return 0;
663}
664
665/* read from the buffer that is filled with the get function */
666ssize_t simple_attr_read(struct file *file, char __user *buf,
667 size_t len, loff_t *ppos)
668{
669 struct simple_attr *attr;
670 size_t size;
671 ssize_t ret;
672
673 attr = file->private_data;
674
675 if (!attr->get)
676 return -EACCES;
677
Christoph Hellwig92613032008-02-08 04:20:27 -0800678 ret = mutex_lock_interruptible(&attr->mutex);
679 if (ret)
680 return ret;
681
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800682 if (*ppos) { /* continued read */
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200683 size = strlen(attr->get_buf);
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800684 } else { /* first read */
685 u64 val;
686 ret = attr->get(attr->data, &val);
687 if (ret)
688 goto out;
689
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200690 size = scnprintf(attr->get_buf, sizeof(attr->get_buf),
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800691 attr->fmt, (unsigned long long)val);
692 }
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200693
694 ret = simple_read_from_buffer(buf, len, ppos, attr->get_buf, size);
Christoph Hellwig8b88b092008-02-08 04:20:26 -0800695out:
Ingo Molnar7cf34c72006-03-23 03:00:36 -0800696 mutex_unlock(&attr->mutex);
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200697 return ret;
698}
699
700/* interpret the buffer as a number to call the set function with */
701ssize_t simple_attr_write(struct file *file, const char __user *buf,
702 size_t len, loff_t *ppos)
703{
704 struct simple_attr *attr;
705 u64 val;
706 size_t size;
707 ssize_t ret;
708
709 attr = file->private_data;
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200710 if (!attr->set)
711 return -EACCES;
712
Christoph Hellwig92613032008-02-08 04:20:27 -0800713 ret = mutex_lock_interruptible(&attr->mutex);
714 if (ret)
715 return ret;
716
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200717 ret = -EFAULT;
718 size = min(sizeof(attr->set_buf) - 1, len);
719 if (copy_from_user(attr->set_buf, buf, size))
720 goto out;
721
722 ret = len; /* claim we got the whole input */
723 attr->set_buf[size] = '\0';
724 val = simple_strtol(attr->set_buf, NULL, 0);
725 attr->set(attr->data, val);
726out:
Ingo Molnar7cf34c72006-03-23 03:00:36 -0800727 mutex_unlock(&attr->mutex);
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200728 return ret;
729}
730
Christoph Hellwig25961102007-10-21 16:42:05 -0700731/**
732 * generic_fh_to_dentry - generic helper for the fh_to_dentry export operation
733 * @sb: filesystem to do the file handle conversion on
734 * @fid: file handle to convert
735 * @fh_len: length of the file handle in bytes
736 * @fh_type: type of file handle
737 * @get_inode: filesystem callback to retrieve inode
738 *
739 * This function decodes @fid as long as it has one of the well-known
740 * Linux filehandle types and calls @get_inode on it to retrieve the
741 * inode for the object specified in the file handle.
742 */
743struct dentry *generic_fh_to_dentry(struct super_block *sb, struct fid *fid,
744 int fh_len, int fh_type, struct inode *(*get_inode)
745 (struct super_block *sb, u64 ino, u32 gen))
746{
747 struct inode *inode = NULL;
748
749 if (fh_len < 2)
750 return NULL;
751
752 switch (fh_type) {
753 case FILEID_INO32_GEN:
754 case FILEID_INO32_GEN_PARENT:
755 inode = get_inode(sb, fid->i32.ino, fid->i32.gen);
756 break;
757 }
758
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +0200759 return d_obtain_alias(inode);
Christoph Hellwig25961102007-10-21 16:42:05 -0700760}
761EXPORT_SYMBOL_GPL(generic_fh_to_dentry);
762
763/**
764 * generic_fh_to_dentry - generic helper for the fh_to_parent 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 _parent_ object specified in the file handle if it
774 * is specified in the file handle, or NULL otherwise.
775 */
776struct dentry *generic_fh_to_parent(struct super_block *sb, struct fid *fid,
777 int fh_len, int fh_type, struct inode *(*get_inode)
778 (struct super_block *sb, u64 ino, u32 gen))
779{
780 struct inode *inode = NULL;
781
782 if (fh_len <= 2)
783 return NULL;
784
785 switch (fh_type) {
786 case FILEID_INO32_GEN_PARENT:
787 inode = get_inode(sb, fid->i32.parent_ino,
788 (fh_len > 3 ? fid->i32.parent_gen : 0));
789 break;
790 }
791
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +0200792 return d_obtain_alias(inode);
Christoph Hellwig25961102007-10-21 16:42:05 -0700793}
794EXPORT_SYMBOL_GPL(generic_fh_to_parent);
795
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796EXPORT_SYMBOL(dcache_dir_close);
797EXPORT_SYMBOL(dcache_dir_lseek);
798EXPORT_SYMBOL(dcache_dir_open);
799EXPORT_SYMBOL(dcache_readdir);
800EXPORT_SYMBOL(generic_read_dir);
801EXPORT_SYMBOL(get_sb_pseudo);
Nick Pigginafddba42007-10-16 01:25:01 -0700802EXPORT_SYMBOL(simple_write_begin);
803EXPORT_SYMBOL(simple_write_end);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804EXPORT_SYMBOL(simple_dir_inode_operations);
805EXPORT_SYMBOL(simple_dir_operations);
806EXPORT_SYMBOL(simple_empty);
807EXPORT_SYMBOL(d_alloc_name);
808EXPORT_SYMBOL(simple_fill_super);
809EXPORT_SYMBOL(simple_getattr);
810EXPORT_SYMBOL(simple_link);
811EXPORT_SYMBOL(simple_lookup);
812EXPORT_SYMBOL(simple_pin_fs);
Nick Piggin4e02ed42008-10-29 14:00:55 -0700813EXPORT_UNUSED_SYMBOL(simple_prepare_write);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814EXPORT_SYMBOL(simple_readpage);
815EXPORT_SYMBOL(simple_release_fs);
816EXPORT_SYMBOL(simple_rename);
817EXPORT_SYMBOL(simple_rmdir);
818EXPORT_SYMBOL(simple_statfs);
819EXPORT_SYMBOL(simple_sync_file);
820EXPORT_SYMBOL(simple_unlink);
821EXPORT_SYMBOL(simple_read_from_buffer);
Akinobu Mita93b07112008-06-05 22:46:21 -0700822EXPORT_SYMBOL(memory_read_from_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823EXPORT_SYMBOL(simple_transaction_get);
824EXPORT_SYMBOL(simple_transaction_read);
825EXPORT_SYMBOL(simple_transaction_release);
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200826EXPORT_SYMBOL_GPL(simple_attr_open);
Christoph Hellwig74bedc42008-02-08 04:20:28 -0800827EXPORT_SYMBOL_GPL(simple_attr_release);
Arnd Bergmannacaefc22005-05-18 14:40:59 +0200828EXPORT_SYMBOL_GPL(simple_attr_read);
829EXPORT_SYMBOL_GPL(simple_attr_write);