blob: 7ea017cb1dd4c385d7bf8529a6bd7e19adfb1803 [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/init.h>
16#include <linux/fs.h>
17#include <linux/mount.h>
18#include <linux/module.h>
19#include <linux/kernel.h>
20#include <linux/magic.h>
21#include <linux/anon_inodes.h>
David Howells33cada42019-03-25 16:38:23 +000022#include <linux/pseudo_fs.h>
Davide Libenzi5dc8bf82007-05-10 22:23:11 -070023
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -080024#include <linux/uaccess.h>
Davide Libenzi5dc8bf82007-05-10 22:23:11 -070025
26static struct vfsmount *anon_inode_mnt __read_mostly;
27static struct inode *anon_inode_inode;
Davide Libenzi5dc8bf82007-05-10 22:23:11 -070028
Nick Pigginb9aff022009-11-20 14:28:35 -080029/*
30 * anon_inodefs_dname() is called from d_path().
31 */
32static char *anon_inodefs_dname(struct dentry *dentry, char *buffer, int buflen)
33{
34 return dynamic_dname(dentry, buffer, buflen, "anon_inode:%s",
35 dentry->d_name.name);
36}
37
Al Viroc74a1cb2011-01-12 16:59:34 -050038static const struct dentry_operations anon_inodefs_dentry_operations = {
39 .d_dname = anon_inodefs_dname,
40};
41
David Howells33cada42019-03-25 16:38:23 +000042static int anon_inodefs_init_fs_context(struct fs_context *fc)
Al Viroca7068c2012-03-17 02:52:29 -040043{
David Howells33cada42019-03-25 16:38:23 +000044 struct pseudo_fs_context *ctx = init_pseudo(fc, ANON_INODE_FS_MAGIC);
45 if (!ctx)
46 return -ENOMEM;
47 ctx->dops = &anon_inodefs_dentry_operations;
48 return 0;
Al Viroca7068c2012-03-17 02:52:29 -040049}
50
51static struct file_system_type anon_inode_fs_type = {
52 .name = "anon_inodefs",
David Howells33cada42019-03-25 16:38:23 +000053 .init_fs_context = anon_inodefs_init_fs_context,
Al Viroca7068c2012-03-17 02:52:29 -040054 .kill_sb = kill_anon_super,
55};
56
Davide Libenzi5dc8bf82007-05-10 22:23:11 -070057/**
Namhyung Kimc0d87682010-12-10 12:11:50 +090058 * anon_inode_getfile - creates a new file instance by hooking it up to an
59 * anonymous inode, and a dentry that describe the "class"
60 * of the file
Davide Libenzi5dc8bf82007-05-10 22:23:11 -070061 *
Davide Libenzi5dc8bf82007-05-10 22:23:11 -070062 * @name: [in] name of the "class" of the new file
Ulrich Drepper7d9dbca2008-07-23 21:29:22 -070063 * @fops: [in] file operations for the new file
64 * @priv: [in] private data for the new file (will be file's private_data)
65 * @flags: [in] flags
Davide Libenzi5dc8bf82007-05-10 22:23:11 -070066 *
67 * Creates a new file by hooking it on a single inode. This is useful for files
68 * that do not need to have a full-fledged inode in order to operate correctly.
Davide Libenzi562787a2009-09-22 16:43:57 -070069 * All the files created with anon_inode_getfile() will share a single inode,
Davide Libenzi5dc8bf82007-05-10 22:23:11 -070070 * hence saving memory and avoiding code duplication for the file/inode/dentry
Davide Libenzi562787a2009-09-22 16:43:57 -070071 * setup. Returns the newly created file* or an error pointer.
Davide Libenzi5dc8bf82007-05-10 22:23:11 -070072 */
Davide Libenzi562787a2009-09-22 16:43:57 -070073struct file *anon_inode_getfile(const char *name,
74 const struct file_operations *fops,
75 void *priv, int flags)
Davide Libenzi5dc8bf82007-05-10 22:23:11 -070076{
Davide Libenzi5dc8bf82007-05-10 22:23:11 -070077 struct file *file;
Davide Libenzi5dc8bf82007-05-10 22:23:11 -070078
79 if (IS_ERR(anon_inode_inode))
Davide Libenzi562787a2009-09-22 16:43:57 -070080 return ERR_PTR(-ENODEV);
Davide Libenzi5dc8bf82007-05-10 22:23:11 -070081
Christian Borntraegere3a2a0d2008-12-02 11:16:03 +010082 if (fops->owner && !try_module_get(fops->owner))
Davide Libenzi562787a2009-09-22 16:43:57 -070083 return ERR_PTR(-ENOENT);
Davide Libenzi5dc8bf82007-05-10 22:23:11 -070084
85 /*
Davide Libenzi96fdc722007-10-16 23:30:19 -070086 * We know the anon_inode inode count is always greater than zero,
Al Viro7de9c6ee2010-10-23 11:11:40 -040087 * so ihold() is safe.
Davide Libenzi96fdc722007-10-16 23:30:19 -070088 */
Al Viro7de9c6ee2010-10-23 11:11:40 -040089 ihold(anon_inode_inode);
Al Viro52c91f82018-06-09 09:58:23 -040090 file = alloc_file_pseudo(anon_inode_inode, anon_inode_mnt, name,
91 flags & (O_ACCMODE | O_NONBLOCK), fops);
Anatol Pomozov39b65252012-09-12 20:11:55 -070092 if (IS_ERR(file))
Al Viro52c91f82018-06-09 09:58:23 -040093 goto err;
94
Davide Libenzi96fdc722007-10-16 23:30:19 -070095 file->f_mapping = anon_inode_inode->i_mapping;
Davide Libenzi5dc8bf82007-05-10 22:23:11 -070096
Davide Libenzi5dc8bf82007-05-10 22:23:11 -070097 file->private_data = priv;
98
Davide Libenzi562787a2009-09-22 16:43:57 -070099 return file;
100
Al Viro52c91f82018-06-09 09:58:23 -0400101err:
102 iput(anon_inode_inode);
Davide Libenzi562787a2009-09-22 16:43:57 -0700103 module_put(fops->owner);
Anatol Pomozov39b65252012-09-12 20:11:55 -0700104 return file;
Davide Libenzi562787a2009-09-22 16:43:57 -0700105}
106EXPORT_SYMBOL_GPL(anon_inode_getfile);
107
108/**
109 * anon_inode_getfd - creates a new file instance by hooking it up to an
110 * anonymous inode, and a dentry that describe the "class"
111 * of the file
112 *
113 * @name: [in] name of the "class" of the new file
114 * @fops: [in] file operations for the new file
115 * @priv: [in] private data for the new file (will be file's private_data)
116 * @flags: [in] flags
117 *
118 * Creates a new file by hooking it on a single inode. This is useful for files
119 * that do not need to have a full-fledged inode in order to operate correctly.
120 * All the files created with anon_inode_getfd() will share a single inode,
121 * hence saving memory and avoiding code duplication for the file/inode/dentry
122 * setup. Returns new descriptor or an error code.
123 */
124int anon_inode_getfd(const char *name, const struct file_operations *fops,
125 void *priv, int flags)
126{
127 int error, fd;
128 struct file *file;
129
130 error = get_unused_fd_flags(flags);
131 if (error < 0)
132 return error;
133 fd = error;
134
135 file = anon_inode_getfile(name, fops, priv, flags);
136 if (IS_ERR(file)) {
137 error = PTR_ERR(file);
138 goto err_put_unused_fd;
139 }
Davide Libenzi5dc8bf82007-05-10 22:23:11 -0700140 fd_install(fd, file);
141
Al Viro2030a422008-02-23 06:46:49 -0500142 return fd;
Davide Libenzi5dc8bf82007-05-10 22:23:11 -0700143
144err_put_unused_fd:
145 put_unused_fd(fd);
Davide Libenzi5dc8bf82007-05-10 22:23:11 -0700146 return error;
147}
Avi Kivityd6d28162007-06-28 08:38:16 -0400148EXPORT_SYMBOL_GPL(anon_inode_getfd);
Davide Libenzi5dc8bf82007-05-10 22:23:11 -0700149
Davide Libenzi5dc8bf82007-05-10 22:23:11 -0700150static int __init anon_inode_init(void)
151{
Davide Libenzi5dc8bf82007-05-10 22:23:11 -0700152 anon_inode_mnt = kern_mount(&anon_inode_fs_type);
Jan Kara75c5a522014-03-26 06:20:14 +0100153 if (IS_ERR(anon_inode_mnt))
154 panic("anon_inode_init() kernel mount failed (%ld)\n", PTR_ERR(anon_inode_mnt));
Davide Libenzi5dc8bf82007-05-10 22:23:11 -0700155
Jan Kara75c5a522014-03-26 06:20:14 +0100156 anon_inode_inode = alloc_anon_inode(anon_inode_mnt->mnt_sb);
157 if (IS_ERR(anon_inode_inode))
158 panic("anon_inode_init() inode allocation failed (%ld)\n", PTR_ERR(anon_inode_inode));
159
160 return 0;
Davide Libenzi5dc8bf82007-05-10 22:23:11 -0700161}
162
163fs_initcall(anon_inode_init);
164