2 * net/sunrpc/rpc_pipe.c
4 * Userland/kernel interface for rpcauth_gss.
5 * Code shamelessly plagiarized from fs/nfsd/nfsctl.c
8 * Copyright (c) 2002, Trond Myklebust <trond.myklebust@fys.uio.no>
11 #include <linux/module.h>
12 #include <linux/slab.h>
13 #include <linux/string.h>
14 #include <linux/pagemap.h>
15 #include <linux/mount.h>
16 #include <linux/namei.h>
17 #include <linux/fsnotify.h>
18 #include <linux/kernel.h>
20 #include <asm/ioctls.h>
22 #include <linux/poll.h>
23 #include <linux/wait.h>
24 #include <linux/seq_file.h>
26 #include <linux/sunrpc/clnt.h>
27 #include <linux/workqueue.h>
28 #include <linux/sunrpc/rpc_pipe_fs.h>
30 static struct vfsmount *rpc_mount __read_mostly;
31 static int rpc_mount_count;
33 static struct file_system_type rpc_pipe_fs_type;
36 static struct kmem_cache *rpc_inode_cachep __read_mostly;
38 #define RPC_UPCALL_TIMEOUT (30*HZ)
40 static void rpc_purge_list(struct rpc_inode *rpci, struct list_head *head,
41 void (*destroy_msg)(struct rpc_pipe_msg *), int err)
43 struct rpc_pipe_msg *msg;
48 msg = list_entry(head->next, struct rpc_pipe_msg, list);
52 } while (!list_empty(head));
53 wake_up(&rpci->waitq);
57 rpc_timeout_upcall_queue(struct work_struct *work)
60 struct rpc_inode *rpci =
61 container_of(work, struct rpc_inode, queue_timeout.work);
62 struct inode *inode = &rpci->vfs_inode;
63 void (*destroy_msg)(struct rpc_pipe_msg *);
65 spin_lock(&inode->i_lock);
66 if (rpci->ops == NULL) {
67 spin_unlock(&inode->i_lock);
70 destroy_msg = rpci->ops->destroy_msg;
71 if (rpci->nreaders == 0) {
72 list_splice_init(&rpci->pipe, &free_list);
75 spin_unlock(&inode->i_lock);
76 rpc_purge_list(rpci, &free_list, destroy_msg, -ETIMEDOUT);
81 * @inode: inode of upcall pipe on which to queue given message
82 * @msg: message to queue
84 * Call with an @inode created by rpc_mkpipe() to queue an upcall.
85 * A userspace process may then later read the upcall by performing a
86 * read on an open file for this inode. It is up to the caller to
87 * initialize the fields of @msg (other than @msg->list) appropriately.
90 rpc_queue_upcall(struct inode *inode, struct rpc_pipe_msg *msg)
92 struct rpc_inode *rpci = RPC_I(inode);
95 spin_lock(&inode->i_lock);
96 if (rpci->ops == NULL)
99 list_add_tail(&msg->list, &rpci->pipe);
100 rpci->pipelen += msg->len;
102 } else if (rpci->flags & RPC_PIPE_WAIT_FOR_OPEN) {
103 if (list_empty(&rpci->pipe))
104 queue_delayed_work(rpciod_workqueue,
105 &rpci->queue_timeout,
107 list_add_tail(&msg->list, &rpci->pipe);
108 rpci->pipelen += msg->len;
112 spin_unlock(&inode->i_lock);
113 wake_up(&rpci->waitq);
118 rpc_inode_setowner(struct inode *inode, void *private)
120 RPC_I(inode)->private = private;
124 rpc_close_pipes(struct inode *inode)
126 struct rpc_inode *rpci = RPC_I(inode);
127 struct rpc_pipe_ops *ops;
129 mutex_lock(&inode->i_mutex);
132 LIST_HEAD(free_list);
134 spin_lock(&inode->i_lock);
136 list_splice_init(&rpci->in_upcall, &free_list);
137 list_splice_init(&rpci->pipe, &free_list);
140 spin_unlock(&inode->i_lock);
141 rpc_purge_list(rpci, &free_list, ops->destroy_msg, -EPIPE);
143 if (ops->release_pipe)
144 ops->release_pipe(inode);
145 cancel_delayed_work_sync(&rpci->queue_timeout);
147 rpc_inode_setowner(inode, NULL);
148 mutex_unlock(&inode->i_mutex);
151 static struct inode *
152 rpc_alloc_inode(struct super_block *sb)
154 struct rpc_inode *rpci;
155 rpci = (struct rpc_inode *)kmem_cache_alloc(rpc_inode_cachep, GFP_KERNEL);
158 return &rpci->vfs_inode;
162 rpc_destroy_inode(struct inode *inode)
164 kmem_cache_free(rpc_inode_cachep, RPC_I(inode));
168 rpc_pipe_open(struct inode *inode, struct file *filp)
170 struct rpc_inode *rpci = RPC_I(inode);
173 mutex_lock(&inode->i_mutex);
174 if (rpci->ops != NULL) {
175 if (filp->f_mode & FMODE_READ)
177 if (filp->f_mode & FMODE_WRITE)
181 mutex_unlock(&inode->i_mutex);
186 rpc_pipe_release(struct inode *inode, struct file *filp)
188 struct rpc_inode *rpci = RPC_I(inode);
189 struct rpc_pipe_msg *msg;
191 mutex_lock(&inode->i_mutex);
192 if (rpci->ops == NULL)
194 msg = (struct rpc_pipe_msg *)filp->private_data;
196 spin_lock(&inode->i_lock);
197 msg->errno = -EAGAIN;
198 list_del(&msg->list);
199 spin_unlock(&inode->i_lock);
200 rpci->ops->destroy_msg(msg);
202 if (filp->f_mode & FMODE_WRITE)
204 if (filp->f_mode & FMODE_READ) {
206 if (rpci->nreaders == 0) {
207 LIST_HEAD(free_list);
208 spin_lock(&inode->i_lock);
209 list_splice_init(&rpci->pipe, &free_list);
211 spin_unlock(&inode->i_lock);
212 rpc_purge_list(rpci, &free_list,
213 rpci->ops->destroy_msg, -EAGAIN);
216 if (rpci->ops->release_pipe)
217 rpci->ops->release_pipe(inode);
219 mutex_unlock(&inode->i_mutex);
224 rpc_pipe_read(struct file *filp, char __user *buf, size_t len, loff_t *offset)
226 struct inode *inode = filp->f_path.dentry->d_inode;
227 struct rpc_inode *rpci = RPC_I(inode);
228 struct rpc_pipe_msg *msg;
231 mutex_lock(&inode->i_mutex);
232 if (rpci->ops == NULL) {
236 msg = filp->private_data;
238 spin_lock(&inode->i_lock);
239 if (!list_empty(&rpci->pipe)) {
240 msg = list_entry(rpci->pipe.next,
243 list_move(&msg->list, &rpci->in_upcall);
244 rpci->pipelen -= msg->len;
245 filp->private_data = msg;
248 spin_unlock(&inode->i_lock);
252 /* NOTE: it is up to the callback to update msg->copied */
253 res = rpci->ops->upcall(filp, msg, buf, len);
254 if (res < 0 || msg->len == msg->copied) {
255 filp->private_data = NULL;
256 spin_lock(&inode->i_lock);
257 list_del(&msg->list);
258 spin_unlock(&inode->i_lock);
259 rpci->ops->destroy_msg(msg);
262 mutex_unlock(&inode->i_mutex);
267 rpc_pipe_write(struct file *filp, const char __user *buf, size_t len, loff_t *offset)
269 struct inode *inode = filp->f_path.dentry->d_inode;
270 struct rpc_inode *rpci = RPC_I(inode);
273 mutex_lock(&inode->i_mutex);
275 if (rpci->ops != NULL)
276 res = rpci->ops->downcall(filp, buf, len);
277 mutex_unlock(&inode->i_mutex);
282 rpc_pipe_poll(struct file *filp, struct poll_table_struct *wait)
284 struct rpc_inode *rpci;
285 unsigned int mask = 0;
287 rpci = RPC_I(filp->f_path.dentry->d_inode);
288 poll_wait(filp, &rpci->waitq, wait);
290 mask = POLLOUT | POLLWRNORM;
291 if (rpci->ops == NULL)
292 mask |= POLLERR | POLLHUP;
293 if (filp->private_data || !list_empty(&rpci->pipe))
294 mask |= POLLIN | POLLRDNORM;
299 rpc_pipe_ioctl(struct inode *ino, struct file *filp,
300 unsigned int cmd, unsigned long arg)
302 struct rpc_inode *rpci = RPC_I(filp->f_path.dentry->d_inode);
307 if (rpci->ops == NULL)
310 if (filp->private_data) {
311 struct rpc_pipe_msg *msg;
312 msg = (struct rpc_pipe_msg *)filp->private_data;
313 len += msg->len - msg->copied;
315 return put_user(len, (int __user *)arg);
321 static const struct file_operations rpc_pipe_fops = {
322 .owner = THIS_MODULE,
324 .read = rpc_pipe_read,
325 .write = rpc_pipe_write,
326 .poll = rpc_pipe_poll,
327 .ioctl = rpc_pipe_ioctl,
328 .open = rpc_pipe_open,
329 .release = rpc_pipe_release,
333 rpc_show_info(struct seq_file *m, void *v)
335 struct rpc_clnt *clnt = m->private;
337 seq_printf(m, "RPC server: %s\n", clnt->cl_server);
338 seq_printf(m, "service: %s (%d) version %d\n", clnt->cl_protname,
339 clnt->cl_prog, clnt->cl_vers);
340 seq_printf(m, "address: %s\n", rpc_peeraddr2str(clnt, RPC_DISPLAY_ADDR));
341 seq_printf(m, "protocol: %s\n", rpc_peeraddr2str(clnt, RPC_DISPLAY_PROTO));
342 seq_printf(m, "port: %s\n", rpc_peeraddr2str(clnt, RPC_DISPLAY_PORT));
347 rpc_info_open(struct inode *inode, struct file *file)
349 struct rpc_clnt *clnt;
350 int ret = single_open(file, rpc_show_info, NULL);
353 struct seq_file *m = file->private_data;
354 mutex_lock(&inode->i_mutex);
355 clnt = RPC_I(inode)->private;
357 kref_get(&clnt->cl_kref);
360 single_release(inode, file);
363 mutex_unlock(&inode->i_mutex);
369 rpc_info_release(struct inode *inode, struct file *file)
371 struct seq_file *m = file->private_data;
372 struct rpc_clnt *clnt = (struct rpc_clnt *)m->private;
375 rpc_release_client(clnt);
376 return single_release(inode, file);
379 static const struct file_operations rpc_info_operations = {
380 .owner = THIS_MODULE,
381 .open = rpc_info_open,
384 .release = rpc_info_release,
389 * We have a single directory with 1 node in it.
402 * Description of fs contents.
404 struct rpc_filelist {
406 const struct file_operations *i_fop;
410 static struct rpc_filelist files[] = {
413 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
417 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
421 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
423 [RPCAUTH_portmap] = {
425 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
429 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
438 static struct rpc_filelist authfiles[] = {
441 .i_fop = &rpc_info_operations,
442 .mode = S_IFREG | S_IRUSR,
446 struct vfsmount *rpc_get_mount(void)
450 err = simple_pin_fs(&rpc_pipe_fs_type, &rpc_mount, &rpc_mount_count);
456 void rpc_put_mount(void)
458 simple_release_fs(&rpc_mount, &rpc_mount_count);
461 static int rpc_delete_dentry(struct dentry *dentry)
466 static struct dentry_operations rpc_dentry_operations = {
467 .d_delete = rpc_delete_dentry,
471 rpc_lookup_parent(char *path, struct nameidata *nd)
473 struct vfsmount *mnt;
478 mnt = rpc_get_mount();
480 printk(KERN_WARNING "%s: %s failed to mount "
481 "pseudofilesystem \n", __FILE__, __FUNCTION__);
485 if (vfs_path_lookup(mnt->mnt_root, mnt, path, LOOKUP_PARENT, nd)) {
486 printk(KERN_WARNING "%s: %s failed to find path %s\n",
487 __FILE__, __FUNCTION__, path);
495 rpc_release_path(struct nameidata *nd)
501 static struct inode *
502 rpc_get_inode(struct super_block *sb, int mode)
504 struct inode *inode = new_inode(sb);
507 inode->i_mode = mode;
508 inode->i_uid = inode->i_gid = 0;
510 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
511 switch(mode & S_IFMT) {
513 inode->i_fop = &simple_dir_operations;
514 inode->i_op = &simple_dir_inode_operations;
523 * FIXME: This probably has races.
526 rpc_depopulate(struct dentry *parent, int start, int eof)
528 struct inode *dir = parent->d_inode;
529 struct list_head *pos, *next;
530 struct dentry *dentry, *dvec[10];
533 mutex_lock_nested(&dir->i_mutex, I_MUTEX_CHILD);
535 spin_lock(&dcache_lock);
536 list_for_each_safe(pos, next, &parent->d_subdirs) {
537 dentry = list_entry(pos, struct dentry, d_u.d_child);
538 if (!dentry->d_inode ||
539 dentry->d_inode->i_ino < start ||
540 dentry->d_inode->i_ino >= eof)
542 spin_lock(&dentry->d_lock);
543 if (!d_unhashed(dentry)) {
546 spin_unlock(&dentry->d_lock);
548 if (n == ARRAY_SIZE(dvec))
551 spin_unlock(&dentry->d_lock);
553 spin_unlock(&dcache_lock);
557 if (S_ISREG(dentry->d_inode->i_mode))
558 simple_unlink(dir, dentry);
559 else if (S_ISDIR(dentry->d_inode->i_mode))
560 simple_rmdir(dir, dentry);
566 mutex_unlock(&dir->i_mutex);
570 rpc_populate(struct dentry *parent,
571 struct rpc_filelist *files,
574 struct inode *inode, *dir = parent->d_inode;
575 void *private = RPC_I(dir)->private;
576 struct dentry *dentry;
579 mutex_lock(&dir->i_mutex);
580 for (i = start; i < eof; i++) {
581 dentry = d_alloc_name(parent, files[i].name);
584 dentry->d_op = &rpc_dentry_operations;
585 mode = files[i].mode;
586 inode = rpc_get_inode(dir->i_sb, mode);
593 inode->i_fop = files[i].i_fop;
595 rpc_inode_setowner(inode, private);
598 d_add(dentry, inode);
599 fsnotify_create(dir, dentry);
601 mutex_unlock(&dir->i_mutex);
604 mutex_unlock(&dir->i_mutex);
605 printk(KERN_WARNING "%s: %s failed to populate directory %s\n",
606 __FILE__, __FUNCTION__, parent->d_name.name);
611 __rpc_mkdir(struct inode *dir, struct dentry *dentry)
615 inode = rpc_get_inode(dir->i_sb, S_IFDIR | S_IRUGO | S_IXUGO);
618 inode->i_ino = iunique(dir->i_sb, 100);
619 d_instantiate(dentry, inode);
621 fsnotify_mkdir(dir, dentry);
624 printk(KERN_WARNING "%s: %s failed to allocate inode for dentry %s\n",
625 __FILE__, __FUNCTION__, dentry->d_name.name);
630 __rpc_rmdir(struct inode *dir, struct dentry *dentry)
633 error = simple_rmdir(dir, dentry);
639 static struct dentry *
640 rpc_lookup_create(struct dentry *parent, const char *name, int len, int exclusive)
642 struct inode *dir = parent->d_inode;
643 struct dentry *dentry;
645 mutex_lock_nested(&dir->i_mutex, I_MUTEX_PARENT);
646 dentry = lookup_one_len(name, parent, len);
649 if (!dentry->d_inode)
650 dentry->d_op = &rpc_dentry_operations;
651 else if (exclusive) {
653 dentry = ERR_PTR(-EEXIST);
658 mutex_unlock(&dir->i_mutex);
662 static struct dentry *
663 rpc_lookup_negative(char *path, struct nameidata *nd)
665 struct dentry *dentry;
668 if ((error = rpc_lookup_parent(path, nd)) != 0)
669 return ERR_PTR(error);
670 dentry = rpc_lookup_create(nd->dentry, nd->last.name, nd->last.len, 1);
672 rpc_release_path(nd);
677 * rpc_mkdir - Create a new directory in rpc_pipefs
678 * @path: path from the rpc_pipefs root to the new directory
679 * @rpc_clnt: rpc client to associate with this directory
681 * This creates a directory at the given @path associated with
682 * @rpc_clnt, which will contain a file named "info" with some basic
683 * information about the client, together with any "pipes" that may
684 * later be created using rpc_mkpipe().
687 rpc_mkdir(char *path, struct rpc_clnt *rpc_client)
690 struct dentry *dentry;
694 dentry = rpc_lookup_negative(path, &nd);
697 dir = nd.dentry->d_inode;
698 if ((error = __rpc_mkdir(dir, dentry)) != 0)
700 RPC_I(dentry->d_inode)->private = rpc_client;
701 error = rpc_populate(dentry, authfiles,
702 RPCAUTH_info, RPCAUTH_EOF);
707 mutex_unlock(&dir->i_mutex);
708 rpc_release_path(&nd);
711 rpc_depopulate(dentry, RPCAUTH_info, RPCAUTH_EOF);
712 __rpc_rmdir(dir, dentry);
715 printk(KERN_WARNING "%s: %s() failed to create directory %s (errno = %d)\n",
716 __FILE__, __FUNCTION__, path, error);
717 dentry = ERR_PTR(error);
722 * rpc_rmdir - Remove a directory created with rpc_mkdir()
723 * @dentry: directory to remove
726 rpc_rmdir(struct dentry *dentry)
728 struct dentry *parent;
732 parent = dget_parent(dentry);
733 dir = parent->d_inode;
734 mutex_lock_nested(&dir->i_mutex, I_MUTEX_PARENT);
735 rpc_depopulate(dentry, RPCAUTH_info, RPCAUTH_EOF);
736 error = __rpc_rmdir(dir, dentry);
738 mutex_unlock(&dir->i_mutex);
744 * rpc_mkpipe - make an rpc_pipefs file for kernel<->userspace communication
745 * @parent: dentry of directory to create new "pipe" in
746 * @name: name of pipe
747 * @private: private data to associate with the pipe, for the caller's use
748 * @ops: operations defining the behavior of the pipe: upcall, downcall,
749 * release_pipe, and destroy_msg.
751 * Data is made available for userspace to read by calls to
752 * rpc_queue_upcall(). The actual reads will result in calls to
753 * @ops->upcall, which will be called with the file pointer,
754 * message, and userspace buffer to copy to.
756 * Writes can come at any time, and do not necessarily have to be
757 * responses to upcalls. They will result in calls to @msg->downcall.
759 * The @private argument passed here will be available to all these methods
760 * from the file pointer, via RPC_I(file->f_dentry->d_inode)->private.
763 rpc_mkpipe(struct dentry *parent, const char *name, void *private, struct rpc_pipe_ops *ops, int flags)
765 struct dentry *dentry;
766 struct inode *dir, *inode;
767 struct rpc_inode *rpci;
769 dentry = rpc_lookup_create(parent, name, strlen(name), 0);
772 dir = parent->d_inode;
773 if (dentry->d_inode) {
774 rpci = RPC_I(dentry->d_inode);
775 if (rpci->private != private ||
777 rpci->flags != flags) {
779 dentry = ERR_PTR(-EBUSY);
781 rpci->nkern_readwriters++;
784 inode = rpc_get_inode(dir->i_sb, S_IFIFO | S_IRUSR | S_IWUSR);
787 inode->i_ino = iunique(dir->i_sb, 100);
788 inode->i_fop = &rpc_pipe_fops;
789 d_instantiate(dentry, inode);
791 rpci->private = private;
794 rpci->nkern_readwriters = 1;
795 fsnotify_create(dir, dentry);
798 mutex_unlock(&dir->i_mutex);
802 dentry = ERR_PTR(-ENOMEM);
803 printk(KERN_WARNING "%s: %s() failed to create pipe %s/%s (errno = %d)\n",
804 __FILE__, __FUNCTION__, parent->d_name.name, name,
810 * rpc_unlink - remove a pipe
811 * @dentry: dentry for the pipe, as returned from rpc_mkpipe
813 * After this call, lookups will no longer find the pipe, and any
814 * attempts to read or write using preexisting opens of the pipe will
818 rpc_unlink(struct dentry *dentry)
820 struct dentry *parent;
824 parent = dget_parent(dentry);
825 dir = parent->d_inode;
826 mutex_lock_nested(&dir->i_mutex, I_MUTEX_PARENT);
827 if (--RPC_I(dentry->d_inode)->nkern_readwriters == 0) {
828 rpc_close_pipes(dentry->d_inode);
829 error = simple_unlink(dir, dentry);
834 mutex_unlock(&dir->i_mutex);
840 * populate the filesystem
842 static struct super_operations s_ops = {
843 .alloc_inode = rpc_alloc_inode,
844 .destroy_inode = rpc_destroy_inode,
845 .statfs = simple_statfs,
848 #define RPCAUTH_GSSMAGIC 0x67596969
851 rpc_fill_super(struct super_block *sb, void *data, int silent)
856 sb->s_blocksize = PAGE_CACHE_SIZE;
857 sb->s_blocksize_bits = PAGE_CACHE_SHIFT;
858 sb->s_magic = RPCAUTH_GSSMAGIC;
862 inode = rpc_get_inode(sb, S_IFDIR | 0755);
865 root = d_alloc_root(inode);
870 if (rpc_populate(root, files, RPCAUTH_Root + 1, RPCAUTH_RootEOF))
881 rpc_get_sb(struct file_system_type *fs_type,
882 int flags, const char *dev_name, void *data, struct vfsmount *mnt)
884 return get_sb_single(fs_type, flags, data, rpc_fill_super, mnt);
887 static struct file_system_type rpc_pipe_fs_type = {
888 .owner = THIS_MODULE,
889 .name = "rpc_pipefs",
890 .get_sb = rpc_get_sb,
891 .kill_sb = kill_litter_super,
895 init_once(struct kmem_cache * cachep, void *foo)
897 struct rpc_inode *rpci = (struct rpc_inode *) foo;
899 inode_init_once(&rpci->vfs_inode);
900 rpci->private = NULL;
903 INIT_LIST_HEAD(&rpci->in_upcall);
904 INIT_LIST_HEAD(&rpci->in_downcall);
905 INIT_LIST_HEAD(&rpci->pipe);
907 init_waitqueue_head(&rpci->waitq);
908 INIT_DELAYED_WORK(&rpci->queue_timeout,
909 rpc_timeout_upcall_queue);
913 int register_rpc_pipefs(void)
917 rpc_inode_cachep = kmem_cache_create("rpc_inode_cache",
918 sizeof(struct rpc_inode),
919 0, (SLAB_HWCACHE_ALIGN|SLAB_RECLAIM_ACCOUNT|
922 if (!rpc_inode_cachep)
924 err = register_filesystem(&rpc_pipe_fs_type);
926 kmem_cache_destroy(rpc_inode_cachep);
933 void unregister_rpc_pipefs(void)
935 kmem_cache_destroy(rpc_inode_cachep);
936 unregister_filesystem(&rpc_pipe_fs_type);