3 * Library for filesystems writers.
6 #include <linux/module.h>
7 #include <linux/pagemap.h>
8 #include <linux/mount.h>
10 #include <linux/mutex.h>
12 #include <asm/uaccess.h>
14 int simple_getattr(struct vfsmount *mnt, struct dentry *dentry,
17 struct inode *inode = dentry->d_inode;
18 generic_fillattr(inode, stat);
19 stat->blocks = inode->i_mapping->nrpages << (PAGE_CACHE_SHIFT - 9);
23 int simple_statfs(struct dentry *dentry, struct kstatfs *buf)
25 buf->f_type = dentry->d_sb->s_magic;
26 buf->f_bsize = PAGE_CACHE_SIZE;
27 buf->f_namelen = NAME_MAX;
32 * Retaining negative dentries for an in-memory filesystem just wastes
33 * memory and lookup time: arrange for them to be deleted immediately.
35 static int simple_delete_dentry(struct dentry *dentry)
41 * Lookup the data. This is trivial - if the dentry didn't already
42 * exist, we know it is negative. Set d_op to delete negative dentries.
44 struct dentry *simple_lookup(struct inode *dir, struct dentry *dentry, struct nameidata *nd)
46 static struct dentry_operations simple_dentry_operations = {
47 .d_delete = simple_delete_dentry,
50 if (dentry->d_name.len > NAME_MAX)
51 return ERR_PTR(-ENAMETOOLONG);
52 dentry->d_op = &simple_dentry_operations;
57 int simple_sync_file(struct file * file, struct dentry *dentry, int datasync)
62 int dcache_dir_open(struct inode *inode, struct file *file)
64 static struct qstr cursor_name = {.len = 1, .name = "."};
66 file->private_data = d_alloc(file->f_dentry, &cursor_name);
68 return file->private_data ? 0 : -ENOMEM;
71 int dcache_dir_close(struct inode *inode, struct file *file)
73 dput(file->private_data);
77 loff_t dcache_dir_lseek(struct file *file, loff_t offset, int origin)
79 mutex_lock(&file->f_dentry->d_inode->i_mutex);
82 offset += file->f_pos;
87 mutex_unlock(&file->f_dentry->d_inode->i_mutex);
90 if (offset != file->f_pos) {
92 if (file->f_pos >= 2) {
94 struct dentry *cursor = file->private_data;
95 loff_t n = file->f_pos - 2;
97 spin_lock(&dcache_lock);
98 list_del(&cursor->d_u.d_child);
99 p = file->f_dentry->d_subdirs.next;
100 while (n && p != &file->f_dentry->d_subdirs) {
102 next = list_entry(p, struct dentry, d_u.d_child);
103 if (!d_unhashed(next) && next->d_inode)
107 list_add_tail(&cursor->d_u.d_child, p);
108 spin_unlock(&dcache_lock);
111 mutex_unlock(&file->f_dentry->d_inode->i_mutex);
115 /* Relationship between i_mode and the DT_xxx types */
116 static inline unsigned char dt_type(struct inode *inode)
118 return (inode->i_mode >> 12) & 15;
122 * Directory is locked and all positive dentries in it are safe, since
123 * for ramfs-type trees they can't go away without unlink() or rmdir(),
124 * both impossible due to the lock on directory.
127 static inline int do_dcache_readdir_filter(struct file * filp,
128 void * dirent, filldir_t filldir, int (*filter)(struct dentry *dentry))
130 struct dentry *dentry = filp->f_dentry;
131 struct dentry *cursor = filp->private_data;
132 struct list_head *p, *q = &cursor->d_u.d_child;
138 ino = dentry->d_inode->i_ino;
139 if (filldir(dirent, ".", 1, i, ino, DT_DIR) < 0)
145 ino = parent_ino(dentry);
146 if (filldir(dirent, "..", 2, i, ino, DT_DIR) < 0)
152 spin_lock(&dcache_lock);
153 if (filp->f_pos == 2)
154 list_move(q, &dentry->d_subdirs);
156 for (p=q->next; p != &dentry->d_subdirs; p=p->next) {
158 next = list_entry(p, struct dentry, d_u.d_child);
159 if (d_unhashed(next) || !next->d_inode)
161 if (filter && !filter(next))
164 spin_unlock(&dcache_lock);
165 if (filldir(dirent, next->d_name.name, next->d_name.len, filp->f_pos, next->d_inode->i_ino, dt_type(next->d_inode)) < 0)
167 spin_lock(&dcache_lock);
168 /* next is still alive */
173 spin_unlock(&dcache_lock);
178 int dcache_readdir(struct file * filp, void * dirent, filldir_t filldir)
180 return do_dcache_readdir_filter(filp, dirent, filldir, NULL);
183 int dcache_readdir_filter(struct file * filp, void * dirent, filldir_t filldir,
184 int (*filter)(struct dentry *))
186 return do_dcache_readdir_filter(filp, dirent, filldir, filter);
190 ssize_t generic_read_dir(struct file *filp, char __user *buf, size_t siz, loff_t *ppos)
195 const struct file_operations simple_dir_operations = {
196 .open = dcache_dir_open,
197 .release = dcache_dir_close,
198 .llseek = dcache_dir_lseek,
199 .read = generic_read_dir,
200 .readdir = dcache_readdir,
201 .fsync = simple_sync_file,
204 struct inode_operations simple_dir_inode_operations = {
205 .lookup = simple_lookup,
209 * Common helper for pseudo-filesystems (sockfs, pipefs, bdev - stuff that
210 * will never be mountable)
212 int get_sb_pseudo(struct file_system_type *fs_type, char *name,
213 struct super_operations *ops, unsigned long magic,
214 struct vfsmount *mnt)
216 struct super_block *s = sget(fs_type, NULL, set_anon_super, NULL);
217 static struct super_operations default_ops = {.statfs = simple_statfs};
218 struct dentry *dentry;
220 struct qstr d_name = {.name = name, .len = strlen(name)};
225 s->s_flags = MS_NOUSER;
226 s->s_maxbytes = ~0ULL;
227 s->s_blocksize = 1024;
228 s->s_blocksize_bits = 10;
230 s->s_op = ops ? ops : &default_ops;
235 root->i_mode = S_IFDIR | S_IRUSR | S_IWUSR;
236 root->i_uid = root->i_gid = 0;
237 root->i_atime = root->i_mtime = root->i_ctime = CURRENT_TIME;
238 dentry = d_alloc(NULL, &d_name);
244 dentry->d_parent = dentry;
245 d_instantiate(dentry, root);
247 s->s_flags |= MS_ACTIVE;
248 return simple_set_mnt(mnt, s);
251 up_write(&s->s_umount);
256 int simple_link(struct dentry *old_dentry, struct inode *dir, struct dentry *dentry)
258 struct inode *inode = old_dentry->d_inode;
260 inode->i_ctime = dir->i_ctime = dir->i_mtime = CURRENT_TIME;
262 atomic_inc(&inode->i_count);
264 d_instantiate(dentry, inode);
268 static inline int simple_positive(struct dentry *dentry)
270 return dentry->d_inode && !d_unhashed(dentry);
273 int simple_empty(struct dentry *dentry)
275 struct dentry *child;
278 spin_lock(&dcache_lock);
279 list_for_each_entry(child, &dentry->d_subdirs, d_u.d_child)
280 if (simple_positive(child))
284 spin_unlock(&dcache_lock);
288 int simple_unlink(struct inode *dir, struct dentry *dentry)
290 struct inode *inode = dentry->d_inode;
292 inode->i_ctime = dir->i_ctime = dir->i_mtime = CURRENT_TIME;
298 int simple_rmdir(struct inode *dir, struct dentry *dentry)
300 if (!simple_empty(dentry))
303 dentry->d_inode->i_nlink--;
304 simple_unlink(dir, dentry);
309 int simple_rename(struct inode *old_dir, struct dentry *old_dentry,
310 struct inode *new_dir, struct dentry *new_dentry)
312 struct inode *inode = old_dentry->d_inode;
313 int they_are_dirs = S_ISDIR(old_dentry->d_inode->i_mode);
315 if (!simple_empty(new_dentry))
318 if (new_dentry->d_inode) {
319 simple_unlink(new_dir, new_dentry);
322 } else if (they_are_dirs) {
327 old_dir->i_ctime = old_dir->i_mtime = new_dir->i_ctime =
328 new_dir->i_mtime = inode->i_ctime = CURRENT_TIME;
333 int simple_readpage(struct file *file, struct page *page)
337 if (PageUptodate(page))
340 kaddr = kmap_atomic(page, KM_USER0);
341 memset(kaddr, 0, PAGE_CACHE_SIZE);
342 kunmap_atomic(kaddr, KM_USER0);
343 flush_dcache_page(page);
344 SetPageUptodate(page);
350 int simple_prepare_write(struct file *file, struct page *page,
351 unsigned from, unsigned to)
353 if (!PageUptodate(page)) {
354 if (to - from != PAGE_CACHE_SIZE) {
355 void *kaddr = kmap_atomic(page, KM_USER0);
356 memset(kaddr, 0, from);
357 memset(kaddr + to, 0, PAGE_CACHE_SIZE - to);
358 flush_dcache_page(page);
359 kunmap_atomic(kaddr, KM_USER0);
361 SetPageUptodate(page);
366 int simple_commit_write(struct file *file, struct page *page,
367 unsigned offset, unsigned to)
369 struct inode *inode = page->mapping->host;
370 loff_t pos = ((loff_t)page->index << PAGE_CACHE_SHIFT) + to;
373 * No need to use i_size_read() here, the i_size
374 * cannot change under us because we hold the i_mutex.
376 if (pos > inode->i_size)
377 i_size_write(inode, pos);
378 set_page_dirty(page);
382 int simple_fill_super(struct super_block *s, int magic, struct tree_descr *files)
384 static struct super_operations s_ops = {.statfs = simple_statfs};
387 struct dentry *dentry;
390 s->s_blocksize = PAGE_CACHE_SIZE;
391 s->s_blocksize_bits = PAGE_CACHE_SHIFT;
396 inode = new_inode(s);
399 inode->i_mode = S_IFDIR | 0755;
400 inode->i_uid = inode->i_gid = 0;
402 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
403 inode->i_op = &simple_dir_inode_operations;
404 inode->i_fop = &simple_dir_operations;
406 root = d_alloc_root(inode);
411 for (i = 0; !files->name || files->name[0]; i++, files++) {
414 dentry = d_alloc_name(root, files->name);
417 inode = new_inode(s);
420 inode->i_mode = S_IFREG | files->mode;
421 inode->i_uid = inode->i_gid = 0;
423 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
424 inode->i_fop = files->ops;
426 d_add(dentry, inode);
436 static DEFINE_SPINLOCK(pin_fs_lock);
438 int simple_pin_fs(struct file_system_type *type, struct vfsmount **mount, int *count)
440 struct vfsmount *mnt = NULL;
441 spin_lock(&pin_fs_lock);
442 if (unlikely(!*mount)) {
443 spin_unlock(&pin_fs_lock);
444 mnt = vfs_kern_mount(type, 0, type->name, NULL);
447 spin_lock(&pin_fs_lock);
453 spin_unlock(&pin_fs_lock);
458 void simple_release_fs(struct vfsmount **mount, int *count)
460 struct vfsmount *mnt;
461 spin_lock(&pin_fs_lock);
465 spin_unlock(&pin_fs_lock);
469 ssize_t simple_read_from_buffer(void __user *to, size_t count, loff_t *ppos,
470 const void *from, size_t available)
475 if (pos >= available)
477 if (count > available - pos)
478 count = available - pos;
479 if (copy_to_user(to, from + pos, count))
486 * Transaction based IO.
487 * The file expects a single write which triggers the transaction, and then
488 * possibly a read which collects the result - which is stored in a
491 char *simple_transaction_get(struct file *file, const char __user *buf, size_t size)
493 struct simple_transaction_argresp *ar;
494 static DEFINE_SPINLOCK(simple_transaction_lock);
496 if (size > SIMPLE_TRANSACTION_LIMIT - 1)
497 return ERR_PTR(-EFBIG);
499 ar = (struct simple_transaction_argresp *)get_zeroed_page(GFP_KERNEL);
501 return ERR_PTR(-ENOMEM);
503 spin_lock(&simple_transaction_lock);
505 /* only one write allowed per open */
506 if (file->private_data) {
507 spin_unlock(&simple_transaction_lock);
508 free_page((unsigned long)ar);
509 return ERR_PTR(-EBUSY);
512 file->private_data = ar;
514 spin_unlock(&simple_transaction_lock);
516 if (copy_from_user(ar->data, buf, size))
517 return ERR_PTR(-EFAULT);
522 ssize_t simple_transaction_read(struct file *file, char __user *buf, size_t size, loff_t *pos)
524 struct simple_transaction_argresp *ar = file->private_data;
528 return simple_read_from_buffer(buf, size, pos, ar->data, ar->size);
531 int simple_transaction_release(struct inode *inode, struct file *file)
533 free_page((unsigned long)file->private_data);
537 /* Simple attribute files */
541 void (*set)(void *, u64);
542 char get_buf[24]; /* enough to store a u64 and "\n\0" */
545 const char *fmt; /* format for read operation */
546 struct mutex mutex; /* protects access to these buffers */
549 /* simple_attr_open is called by an actual attribute open file operation
550 * to set the attribute specific access operations. */
551 int simple_attr_open(struct inode *inode, struct file *file,
552 u64 (*get)(void *), void (*set)(void *, u64),
555 struct simple_attr *attr;
557 attr = kmalloc(sizeof(*attr), GFP_KERNEL);
563 attr->data = inode->i_private;
565 mutex_init(&attr->mutex);
567 file->private_data = attr;
569 return nonseekable_open(inode, file);
572 int simple_attr_close(struct inode *inode, struct file *file)
574 kfree(file->private_data);
578 /* read from the buffer that is filled with the get function */
579 ssize_t simple_attr_read(struct file *file, char __user *buf,
580 size_t len, loff_t *ppos)
582 struct simple_attr *attr;
586 attr = file->private_data;
591 mutex_lock(&attr->mutex);
592 if (*ppos) /* continued read */
593 size = strlen(attr->get_buf);
594 else /* first read */
595 size = scnprintf(attr->get_buf, sizeof(attr->get_buf),
597 (unsigned long long)attr->get(attr->data));
599 ret = simple_read_from_buffer(buf, len, ppos, attr->get_buf, size);
600 mutex_unlock(&attr->mutex);
604 /* interpret the buffer as a number to call the set function with */
605 ssize_t simple_attr_write(struct file *file, const char __user *buf,
606 size_t len, loff_t *ppos)
608 struct simple_attr *attr;
613 attr = file->private_data;
618 mutex_lock(&attr->mutex);
620 size = min(sizeof(attr->set_buf) - 1, len);
621 if (copy_from_user(attr->set_buf, buf, size))
624 ret = len; /* claim we got the whole input */
625 attr->set_buf[size] = '\0';
626 val = simple_strtol(attr->set_buf, NULL, 0);
627 attr->set(attr->data, val);
629 mutex_unlock(&attr->mutex);
633 EXPORT_SYMBOL(dcache_dir_close);
634 EXPORT_SYMBOL(dcache_dir_lseek);
635 EXPORT_SYMBOL(dcache_dir_open);
636 EXPORT_SYMBOL(dcache_readdir);
637 EXPORT_SYMBOL(dcache_readdir_filter);
638 EXPORT_SYMBOL(generic_read_dir);
639 EXPORT_SYMBOL(get_sb_pseudo);
640 EXPORT_SYMBOL(simple_commit_write);
641 EXPORT_SYMBOL(simple_dir_inode_operations);
642 EXPORT_SYMBOL(simple_dir_operations);
643 EXPORT_SYMBOL(simple_empty);
644 EXPORT_SYMBOL(d_alloc_name);
645 EXPORT_SYMBOL(simple_fill_super);
646 EXPORT_SYMBOL(simple_getattr);
647 EXPORT_SYMBOL(simple_link);
648 EXPORT_SYMBOL(simple_lookup);
649 EXPORT_SYMBOL(simple_pin_fs);
650 EXPORT_SYMBOL(simple_prepare_write);
651 EXPORT_SYMBOL(simple_readpage);
652 EXPORT_SYMBOL(simple_release_fs);
653 EXPORT_SYMBOL(simple_rename);
654 EXPORT_SYMBOL(simple_rmdir);
655 EXPORT_SYMBOL(simple_statfs);
656 EXPORT_SYMBOL(simple_sync_file);
657 EXPORT_SYMBOL(simple_unlink);
658 EXPORT_SYMBOL(simple_read_from_buffer);
659 EXPORT_SYMBOL(simple_transaction_get);
660 EXPORT_SYMBOL(simple_transaction_read);
661 EXPORT_SYMBOL(simple_transaction_release);
662 EXPORT_SYMBOL_GPL(simple_attr_open);
663 EXPORT_SYMBOL_GPL(simple_attr_close);
664 EXPORT_SYMBOL_GPL(simple_attr_read);
665 EXPORT_SYMBOL_GPL(simple_attr_write);