anonfd: split interface into file creation and install
[linux-3.10.git] / fs / anon_inodes.c
1 /*
2  *  fs/anon_inodes.c
3  *
4  *  Copyright (C) 2007  Davide Libenzi <davidel@xmailserver.org>
5  *
6  *  Thanks to Arnd Bergmann for code review and suggestions.
7  *  More changes for Thomas Gleixner suggestions.
8  *
9  */
10
11 #include <linux/file.h>
12 #include <linux/poll.h>
13 #include <linux/slab.h>
14 #include <linux/init.h>
15 #include <linux/fs.h>
16 #include <linux/mount.h>
17 #include <linux/module.h>
18 #include <linux/kernel.h>
19 #include <linux/magic.h>
20 #include <linux/anon_inodes.h>
21
22 #include <asm/uaccess.h>
23
24 static struct vfsmount *anon_inode_mnt __read_mostly;
25 static struct inode *anon_inode_inode;
26 static const struct file_operations anon_inode_fops;
27
28 static int anon_inodefs_get_sb(struct file_system_type *fs_type, int flags,
29                                const char *dev_name, void *data,
30                                struct vfsmount *mnt)
31 {
32         return get_sb_pseudo(fs_type, "anon_inode:", NULL, ANON_INODE_FS_MAGIC,
33                              mnt);
34 }
35
36 static int anon_inodefs_delete_dentry(struct dentry *dentry)
37 {
38         /*
39          * We faked vfs to believe the dentry was hashed when we created it.
40          * Now we restore the flag so that dput() will work correctly.
41          */
42         dentry->d_flags |= DCACHE_UNHASHED;
43         return 1;
44 }
45
46 static struct file_system_type anon_inode_fs_type = {
47         .name           = "anon_inodefs",
48         .get_sb         = anon_inodefs_get_sb,
49         .kill_sb        = kill_anon_super,
50 };
51 static const struct dentry_operations anon_inodefs_dentry_operations = {
52         .d_delete       = anon_inodefs_delete_dentry,
53 };
54
55 /*
56  * nop .set_page_dirty method so that people can use .page_mkwrite on
57  * anon inodes.
58  */
59 static int anon_set_page_dirty(struct page *page)
60 {
61         return 0;
62 };
63
64 static const struct address_space_operations anon_aops = {
65         .set_page_dirty = anon_set_page_dirty,
66 };
67
68 /**
69  * anon_inode_getfd - creates a new file instance by hooking it up to an
70  *                    anonymous inode, and a dentry that describe the "class"
71  *                    of the file
72  *
73  * @name:    [in]    name of the "class" of the new file
74  * @fops:    [in]    file operations for the new file
75  * @priv:    [in]    private data for the new file (will be file's private_data)
76  * @flags:   [in]    flags
77  *
78  * Creates a new file by hooking it on a single inode. This is useful for files
79  * that do not need to have a full-fledged inode in order to operate correctly.
80  * All the files created with anon_inode_getfile() will share a single inode,
81  * hence saving memory and avoiding code duplication for the file/inode/dentry
82  * setup.  Returns the newly created file* or an error pointer.
83  */
84 struct file *anon_inode_getfile(const char *name,
85                                 const struct file_operations *fops,
86                                 void *priv, int flags)
87 {
88         struct qstr this;
89         struct dentry *dentry;
90         struct file *file;
91         int error;
92
93         if (IS_ERR(anon_inode_inode))
94                 return ERR_PTR(-ENODEV);
95
96         if (fops->owner && !try_module_get(fops->owner))
97                 return ERR_PTR(-ENOENT);
98
99         /*
100          * Link the inode to a directory entry by creating a unique name
101          * using the inode sequence number.
102          */
103         error = -ENOMEM;
104         this.name = name;
105         this.len = strlen(name);
106         this.hash = 0;
107         dentry = d_alloc(anon_inode_mnt->mnt_sb->s_root, &this);
108         if (!dentry)
109                 goto err_module;
110
111         /*
112          * We know the anon_inode inode count is always greater than zero,
113          * so we can avoid doing an igrab() and we can use an open-coded
114          * atomic_inc().
115          */
116         atomic_inc(&anon_inode_inode->i_count);
117
118         dentry->d_op = &anon_inodefs_dentry_operations;
119         /* Do not publish this dentry inside the global dentry hash table */
120         dentry->d_flags &= ~DCACHE_UNHASHED;
121         d_instantiate(dentry, anon_inode_inode);
122
123         error = -ENFILE;
124         file = alloc_file(anon_inode_mnt, dentry,
125                           FMODE_READ | FMODE_WRITE, fops);
126         if (!file)
127                 goto err_dput;
128         file->f_mapping = anon_inode_inode->i_mapping;
129
130         file->f_pos = 0;
131         file->f_flags = O_RDWR | (flags & O_NONBLOCK);
132         file->f_version = 0;
133         file->private_data = priv;
134
135         return file;
136
137 err_dput:
138         dput(dentry);
139 err_module:
140         module_put(fops->owner);
141         return ERR_PTR(error);
142 }
143 EXPORT_SYMBOL_GPL(anon_inode_getfile);
144
145 /**
146  * anon_inode_getfd - creates a new file instance by hooking it up to an
147  *                    anonymous inode, and a dentry that describe the "class"
148  *                    of the file
149  *
150  * @name:    [in]    name of the "class" of the new file
151  * @fops:    [in]    file operations for the new file
152  * @priv:    [in]    private data for the new file (will be file's private_data)
153  * @flags:   [in]    flags
154  *
155  * Creates a new file by hooking it on a single inode. This is useful for files
156  * that do not need to have a full-fledged inode in order to operate correctly.
157  * All the files created with anon_inode_getfd() will share a single inode,
158  * hence saving memory and avoiding code duplication for the file/inode/dentry
159  * setup.  Returns new descriptor or an error code.
160  */
161 int anon_inode_getfd(const char *name, const struct file_operations *fops,
162                      void *priv, int flags)
163 {
164         int error, fd;
165         struct file *file;
166
167         error = get_unused_fd_flags(flags);
168         if (error < 0)
169                 return error;
170         fd = error;
171
172         file = anon_inode_getfile(name, fops, priv, flags);
173         if (IS_ERR(file)) {
174                 error = PTR_ERR(file);
175                 goto err_put_unused_fd;
176         }
177         fd_install(fd, file);
178
179         return fd;
180
181 err_put_unused_fd:
182         put_unused_fd(fd);
183         return error;
184 }
185 EXPORT_SYMBOL_GPL(anon_inode_getfd);
186
187 /*
188  * A single inode exists for all anon_inode files. Contrary to pipes,
189  * anon_inode inodes have no associated per-instance data, so we need
190  * only allocate one of them.
191  */
192 static struct inode *anon_inode_mkinode(void)
193 {
194         struct inode *inode = new_inode(anon_inode_mnt->mnt_sb);
195
196         if (!inode)
197                 return ERR_PTR(-ENOMEM);
198
199         inode->i_fop = &anon_inode_fops;
200
201         inode->i_mapping->a_ops = &anon_aops;
202
203         /*
204          * Mark the inode dirty from the very beginning,
205          * that way it will never be moved to the dirty
206          * list because mark_inode_dirty() will think
207          * that it already _is_ on the dirty list.
208          */
209         inode->i_state = I_DIRTY;
210         inode->i_mode = S_IRUSR | S_IWUSR;
211         inode->i_uid = current_fsuid();
212         inode->i_gid = current_fsgid();
213         inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
214         return inode;
215 }
216
217 static int __init anon_inode_init(void)
218 {
219         int error;
220
221         error = register_filesystem(&anon_inode_fs_type);
222         if (error)
223                 goto err_exit;
224         anon_inode_mnt = kern_mount(&anon_inode_fs_type);
225         if (IS_ERR(anon_inode_mnt)) {
226                 error = PTR_ERR(anon_inode_mnt);
227                 goto err_unregister_filesystem;
228         }
229         anon_inode_inode = anon_inode_mkinode();
230         if (IS_ERR(anon_inode_inode)) {
231                 error = PTR_ERR(anon_inode_inode);
232                 goto err_mntput;
233         }
234
235         return 0;
236
237 err_mntput:
238         mntput(anon_inode_mnt);
239 err_unregister_filesystem:
240         unregister_filesystem(&anon_inode_fs_type);
241 err_exit:
242         panic(KERN_ERR "anon_inode_init() failed (%d)\n", error);
243 }
244
245 fs_initcall(anon_inode_init);
246