blob: 2de009565d8ecf305d40fbdd014855246a43dea5 [file] [log] [blame]
Davide Libenzi5dc8bf82007-05-10 22:23:11 -07001/*
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
Alexey Dobriyana99bbaf2009-10-04 16:11:37 +040011#include <linux/cred.h>
Davide Libenzi5dc8bf82007-05-10 22:23:11 -070012#include <linux/file.h>
13#include <linux/poll.h>
Alexey Dobriyana99bbaf2009-10-04 16:11:37 +040014#include <linux/sched.h>
Davide Libenzi5dc8bf82007-05-10 22:23:11 -070015#include <linux/slab.h>
16#include <linux/init.h>
17#include <linux/fs.h>
18#include <linux/mount.h>
19#include <linux/module.h>
20#include <linux/kernel.h>
21#include <linux/magic.h>
22#include <linux/anon_inodes.h>
23
24#include <asm/uaccess.h>
25
26static struct vfsmount *anon_inode_mnt __read_mostly;
27static struct inode *anon_inode_inode;
28static const struct file_operations anon_inode_fops;
29
30static int anon_inodefs_get_sb(struct file_system_type *fs_type, int flags,
31 const char *dev_name, void *data,
32 struct vfsmount *mnt)
33{
34 return get_sb_pseudo(fs_type, "anon_inode:", NULL, ANON_INODE_FS_MAGIC,
35 mnt);
36}
37
Nick Pigginb9aff022009-11-20 14:28:35 -080038/*
39 * anon_inodefs_dname() is called from d_path().
40 */
41static char *anon_inodefs_dname(struct dentry *dentry, char *buffer, int buflen)
42{
43 return dynamic_dname(dentry, buffer, buflen, "anon_inode:%s",
44 dentry->d_name.name);
45}
46
Davide Libenzi5dc8bf82007-05-10 22:23:11 -070047static struct file_system_type anon_inode_fs_type = {
48 .name = "anon_inodefs",
49 .get_sb = anon_inodefs_get_sb,
50 .kill_sb = kill_anon_super,
51};
Al Viro3ba13d12009-02-20 06:02:22 +000052static const struct dentry_operations anon_inodefs_dentry_operations = {
Nick Pigginb9aff022009-11-20 14:28:35 -080053 .d_dname = anon_inodefs_dname,
Davide Libenzi5dc8bf82007-05-10 22:23:11 -070054};
55
Peter Zijlstrad3a92622009-06-18 12:54:00 +020056/*
57 * nop .set_page_dirty method so that people can use .page_mkwrite on
58 * anon inodes.
59 */
60static int anon_set_page_dirty(struct page *page)
61{
62 return 0;
63};
64
65static const struct address_space_operations anon_aops = {
66 .set_page_dirty = anon_set_page_dirty,
67};
68
Davide Libenzi5dc8bf82007-05-10 22:23:11 -070069/**
J. Bruce Fields4b4e5a12007-07-15 23:41:53 -070070 * anon_inode_getfd - creates a new file instance by hooking it up to an
Davide Libenzi5dc8bf82007-05-10 22:23:11 -070071 * anonymous inode, and a dentry that describe the "class"
72 * of the file
73 *
Davide Libenzi5dc8bf82007-05-10 22:23:11 -070074 * @name: [in] name of the "class" of the new file
Ulrich Drepper7d9dbca2008-07-23 21:29:22 -070075 * @fops: [in] file operations for the new file
76 * @priv: [in] private data for the new file (will be file's private_data)
77 * @flags: [in] flags
Davide Libenzi5dc8bf82007-05-10 22:23:11 -070078 *
79 * Creates a new file by hooking it on a single inode. This is useful for files
80 * that do not need to have a full-fledged inode in order to operate correctly.
Davide Libenzi562787a2009-09-22 16:43:57 -070081 * All the files created with anon_inode_getfile() will share a single inode,
Davide Libenzi5dc8bf82007-05-10 22:23:11 -070082 * hence saving memory and avoiding code duplication for the file/inode/dentry
Davide Libenzi562787a2009-09-22 16:43:57 -070083 * setup. Returns the newly created file* or an error pointer.
Davide Libenzi5dc8bf82007-05-10 22:23:11 -070084 */
Davide Libenzi562787a2009-09-22 16:43:57 -070085struct file *anon_inode_getfile(const char *name,
86 const struct file_operations *fops,
87 void *priv, int flags)
Davide Libenzi5dc8bf82007-05-10 22:23:11 -070088{
89 struct qstr this;
Al Viro2c48b9c2009-08-09 00:52:35 +040090 struct path path;
Davide Libenzi5dc8bf82007-05-10 22:23:11 -070091 struct file *file;
Davide Libenzi562787a2009-09-22 16:43:57 -070092 int error;
Davide Libenzi5dc8bf82007-05-10 22:23:11 -070093
94 if (IS_ERR(anon_inode_inode))
Davide Libenzi562787a2009-09-22 16:43:57 -070095 return ERR_PTR(-ENODEV);
Davide Libenzi5dc8bf82007-05-10 22:23:11 -070096
Christian Borntraegere3a2a0d2008-12-02 11:16:03 +010097 if (fops->owner && !try_module_get(fops->owner))
Davide Libenzi562787a2009-09-22 16:43:57 -070098 return ERR_PTR(-ENOENT);
Davide Libenzi5dc8bf82007-05-10 22:23:11 -070099
100 /*
101 * Link the inode to a directory entry by creating a unique name
102 * using the inode sequence number.
103 */
104 error = -ENOMEM;
105 this.name = name;
106 this.len = strlen(name);
107 this.hash = 0;
Al Viro2c48b9c2009-08-09 00:52:35 +0400108 path.dentry = d_alloc(anon_inode_mnt->mnt_sb->s_root, &this);
109 if (!path.dentry)
Davide Libenzi562787a2009-09-22 16:43:57 -0700110 goto err_module;
Davide Libenzi96fdc722007-10-16 23:30:19 -0700111
Al Viro2c48b9c2009-08-09 00:52:35 +0400112 path.mnt = mntget(anon_inode_mnt);
Davide Libenzi96fdc722007-10-16 23:30:19 -0700113 /*
114 * We know the anon_inode inode count is always greater than zero,
115 * so we can avoid doing an igrab() and we can use an open-coded
116 * atomic_inc().
117 */
118 atomic_inc(&anon_inode_inode->i_count);
119
Al Viro2c48b9c2009-08-09 00:52:35 +0400120 path.dentry->d_op = &anon_inodefs_dentry_operations;
Al Viro2c48b9c2009-08-09 00:52:35 +0400121 d_instantiate(path.dentry, anon_inode_inode);
Davide Libenzi5dc8bf82007-05-10 22:23:11 -0700122
Dave Hansen430e2852008-02-15 14:37:26 -0800123 error = -ENFILE;
Al Viro53009902009-12-19 10:15:07 -0500124 file = alloc_file(&path, OPEN_FMODE(flags), fops);
Dave Hansen430e2852008-02-15 14:37:26 -0800125 if (!file)
126 goto err_dput;
Davide Libenzi96fdc722007-10-16 23:30:19 -0700127 file->f_mapping = anon_inode_inode->i_mapping;
Davide Libenzi5dc8bf82007-05-10 22:23:11 -0700128
129 file->f_pos = 0;
Roland Dreier628ff7c2009-12-18 09:41:24 -0800130 file->f_flags = flags & (O_ACCMODE | O_NONBLOCK);
Davide Libenzi5dc8bf82007-05-10 22:23:11 -0700131 file->f_version = 0;
132 file->private_data = priv;
133
Davide Libenzi562787a2009-09-22 16:43:57 -0700134 return file;
135
136err_dput:
Al Viro2c48b9c2009-08-09 00:52:35 +0400137 path_put(&path);
Davide Libenzi562787a2009-09-22 16:43:57 -0700138err_module:
139 module_put(fops->owner);
140 return ERR_PTR(error);
141}
142EXPORT_SYMBOL_GPL(anon_inode_getfile);
143
144/**
145 * anon_inode_getfd - creates a new file instance by hooking it up to an
146 * anonymous inode, and a dentry that describe the "class"
147 * of the file
148 *
149 * @name: [in] name of the "class" of the new file
150 * @fops: [in] file operations for the new file
151 * @priv: [in] private data for the new file (will be file's private_data)
152 * @flags: [in] flags
153 *
154 * Creates a new file by hooking it on a single inode. This is useful for files
155 * that do not need to have a full-fledged inode in order to operate correctly.
156 * All the files created with anon_inode_getfd() will share a single inode,
157 * hence saving memory and avoiding code duplication for the file/inode/dentry
158 * setup. Returns new descriptor or an error code.
159 */
160int anon_inode_getfd(const char *name, const struct file_operations *fops,
161 void *priv, int flags)
162{
163 int error, fd;
164 struct file *file;
165
166 error = get_unused_fd_flags(flags);
167 if (error < 0)
168 return error;
169 fd = error;
170
171 file = anon_inode_getfile(name, fops, priv, flags);
172 if (IS_ERR(file)) {
173 error = PTR_ERR(file);
174 goto err_put_unused_fd;
175 }
Davide Libenzi5dc8bf82007-05-10 22:23:11 -0700176 fd_install(fd, file);
177
Al Viro2030a422008-02-23 06:46:49 -0500178 return fd;
Davide Libenzi5dc8bf82007-05-10 22:23:11 -0700179
180err_put_unused_fd:
181 put_unused_fd(fd);
Davide Libenzi5dc8bf82007-05-10 22:23:11 -0700182 return error;
183}
Avi Kivityd6d28162007-06-28 08:38:16 -0400184EXPORT_SYMBOL_GPL(anon_inode_getfd);
Davide Libenzi5dc8bf82007-05-10 22:23:11 -0700185
186/*
J. Bruce Fields4b4e5a12007-07-15 23:41:53 -0700187 * A single inode exists for all anon_inode files. Contrary to pipes,
188 * anon_inode inodes have no associated per-instance data, so we need
189 * only allocate one of them.
Davide Libenzi5dc8bf82007-05-10 22:23:11 -0700190 */
191static struct inode *anon_inode_mkinode(void)
192{
193 struct inode *inode = new_inode(anon_inode_mnt->mnt_sb);
194
195 if (!inode)
196 return ERR_PTR(-ENOMEM);
197
198 inode->i_fop = &anon_inode_fops;
199
Peter Zijlstrad3a92622009-06-18 12:54:00 +0200200 inode->i_mapping->a_ops = &anon_aops;
201
Davide Libenzi5dc8bf82007-05-10 22:23:11 -0700202 /*
203 * Mark the inode dirty from the very beginning,
204 * that way it will never be moved to the dirty
205 * list because mark_inode_dirty() will think
206 * that it already _is_ on the dirty list.
207 */
208 inode->i_state = I_DIRTY;
209 inode->i_mode = S_IRUSR | S_IWUSR;
David Howellsda9592e2008-11-14 10:39:05 +1100210 inode->i_uid = current_fsuid();
211 inode->i_gid = current_fsgid();
Eric Paris3836a032010-03-09 22:23:01 -0500212 inode->i_flags |= S_PRIVATE;
Davide Libenzi5dc8bf82007-05-10 22:23:11 -0700213 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
214 return inode;
215}
216
217static 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
237err_mntput:
238 mntput(anon_inode_mnt);
239err_unregister_filesystem:
240 unregister_filesystem(&anon_inode_fs_type);
241err_exit:
242 panic(KERN_ERR "anon_inode_init() failed (%d)\n", error);
243}
244
245fs_initcall(anon_inode_init);
246