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);
116 EXPORT_SYMBOL_GPL(rpc_queue_upcall);
119 rpc_inode_setowner(struct inode *inode, void *private)
121 RPC_I(inode)->private = private;
125 rpc_close_pipes(struct inode *inode)
127 struct rpc_inode *rpci = RPC_I(inode);
128 struct rpc_pipe_ops *ops;
130 mutex_lock(&inode->i_mutex);
133 LIST_HEAD(free_list);
135 spin_lock(&inode->i_lock);
137 list_splice_init(&rpci->in_upcall, &free_list);
138 list_splice_init(&rpci->pipe, &free_list);
141 spin_unlock(&inode->i_lock);
142 rpc_purge_list(rpci, &free_list, ops->destroy_msg, -EPIPE);
144 if (ops->release_pipe)
145 ops->release_pipe(inode);
146 cancel_delayed_work_sync(&rpci->queue_timeout);
148 rpc_inode_setowner(inode, NULL);
149 mutex_unlock(&inode->i_mutex);
152 static struct inode *
153 rpc_alloc_inode(struct super_block *sb)
155 struct rpc_inode *rpci;
156 rpci = (struct rpc_inode *)kmem_cache_alloc(rpc_inode_cachep, GFP_KERNEL);
159 return &rpci->vfs_inode;
163 rpc_destroy_inode(struct inode *inode)
165 kmem_cache_free(rpc_inode_cachep, RPC_I(inode));
169 rpc_pipe_open(struct inode *inode, struct file *filp)
171 struct rpc_inode *rpci = RPC_I(inode);
175 mutex_lock(&inode->i_mutex);
176 if (rpci->ops == NULL)
178 first_open = rpci->nreaders == 0 && rpci->nwriters == 0;
179 if (first_open && rpci->ops->open_pipe) {
180 res = rpci->ops->open_pipe(inode);
184 if (filp->f_mode & FMODE_READ)
186 if (filp->f_mode & FMODE_WRITE)
190 mutex_unlock(&inode->i_mutex);
195 rpc_pipe_release(struct inode *inode, struct file *filp)
197 struct rpc_inode *rpci = RPC_I(inode);
198 struct rpc_pipe_msg *msg;
200 mutex_lock(&inode->i_mutex);
201 if (rpci->ops == NULL)
203 msg = (struct rpc_pipe_msg *)filp->private_data;
205 spin_lock(&inode->i_lock);
206 msg->errno = -EAGAIN;
207 list_del(&msg->list);
208 spin_unlock(&inode->i_lock);
209 rpci->ops->destroy_msg(msg);
211 if (filp->f_mode & FMODE_WRITE)
213 if (filp->f_mode & FMODE_READ) {
215 if (rpci->nreaders == 0) {
216 LIST_HEAD(free_list);
217 spin_lock(&inode->i_lock);
218 list_splice_init(&rpci->pipe, &free_list);
220 spin_unlock(&inode->i_lock);
221 rpc_purge_list(rpci, &free_list,
222 rpci->ops->destroy_msg, -EAGAIN);
225 if (rpci->ops->release_pipe)
226 rpci->ops->release_pipe(inode);
228 mutex_unlock(&inode->i_mutex);
233 rpc_pipe_read(struct file *filp, char __user *buf, size_t len, loff_t *offset)
235 struct inode *inode = filp->f_path.dentry->d_inode;
236 struct rpc_inode *rpci = RPC_I(inode);
237 struct rpc_pipe_msg *msg;
240 mutex_lock(&inode->i_mutex);
241 if (rpci->ops == NULL) {
245 msg = filp->private_data;
247 spin_lock(&inode->i_lock);
248 if (!list_empty(&rpci->pipe)) {
249 msg = list_entry(rpci->pipe.next,
252 list_move(&msg->list, &rpci->in_upcall);
253 rpci->pipelen -= msg->len;
254 filp->private_data = msg;
257 spin_unlock(&inode->i_lock);
261 /* NOTE: it is up to the callback to update msg->copied */
262 res = rpci->ops->upcall(filp, msg, buf, len);
263 if (res < 0 || msg->len == msg->copied) {
264 filp->private_data = NULL;
265 spin_lock(&inode->i_lock);
266 list_del(&msg->list);
267 spin_unlock(&inode->i_lock);
268 rpci->ops->destroy_msg(msg);
271 mutex_unlock(&inode->i_mutex);
276 rpc_pipe_write(struct file *filp, const char __user *buf, size_t len, loff_t *offset)
278 struct inode *inode = filp->f_path.dentry->d_inode;
279 struct rpc_inode *rpci = RPC_I(inode);
282 mutex_lock(&inode->i_mutex);
284 if (rpci->ops != NULL)
285 res = rpci->ops->downcall(filp, buf, len);
286 mutex_unlock(&inode->i_mutex);
291 rpc_pipe_poll(struct file *filp, struct poll_table_struct *wait)
293 struct rpc_inode *rpci;
294 unsigned int mask = 0;
296 rpci = RPC_I(filp->f_path.dentry->d_inode);
297 poll_wait(filp, &rpci->waitq, wait);
299 mask = POLLOUT | POLLWRNORM;
300 if (rpci->ops == NULL)
301 mask |= POLLERR | POLLHUP;
302 if (filp->private_data || !list_empty(&rpci->pipe))
303 mask |= POLLIN | POLLRDNORM;
308 rpc_pipe_ioctl(struct inode *ino, struct file *filp,
309 unsigned int cmd, unsigned long arg)
311 struct rpc_inode *rpci = RPC_I(filp->f_path.dentry->d_inode);
316 if (rpci->ops == NULL)
319 if (filp->private_data) {
320 struct rpc_pipe_msg *msg;
321 msg = (struct rpc_pipe_msg *)filp->private_data;
322 len += msg->len - msg->copied;
324 return put_user(len, (int __user *)arg);
330 static const struct file_operations rpc_pipe_fops = {
331 .owner = THIS_MODULE,
333 .read = rpc_pipe_read,
334 .write = rpc_pipe_write,
335 .poll = rpc_pipe_poll,
336 .ioctl = rpc_pipe_ioctl,
337 .open = rpc_pipe_open,
338 .release = rpc_pipe_release,
342 rpc_show_info(struct seq_file *m, void *v)
344 struct rpc_clnt *clnt = m->private;
346 seq_printf(m, "RPC server: %s\n", clnt->cl_server);
347 seq_printf(m, "service: %s (%d) version %d\n", clnt->cl_protname,
348 clnt->cl_prog, clnt->cl_vers);
349 seq_printf(m, "address: %s\n", rpc_peeraddr2str(clnt, RPC_DISPLAY_ADDR));
350 seq_printf(m, "protocol: %s\n", rpc_peeraddr2str(clnt, RPC_DISPLAY_PROTO));
351 seq_printf(m, "port: %s\n", rpc_peeraddr2str(clnt, RPC_DISPLAY_PORT));
356 rpc_info_open(struct inode *inode, struct file *file)
358 struct rpc_clnt *clnt;
359 int ret = single_open(file, rpc_show_info, NULL);
362 struct seq_file *m = file->private_data;
363 mutex_lock(&inode->i_mutex);
364 clnt = RPC_I(inode)->private;
366 kref_get(&clnt->cl_kref);
369 single_release(inode, file);
372 mutex_unlock(&inode->i_mutex);
378 rpc_info_release(struct inode *inode, struct file *file)
380 struct seq_file *m = file->private_data;
381 struct rpc_clnt *clnt = (struct rpc_clnt *)m->private;
384 rpc_release_client(clnt);
385 return single_release(inode, file);
388 static const struct file_operations rpc_info_operations = {
389 .owner = THIS_MODULE,
390 .open = rpc_info_open,
393 .release = rpc_info_release,
398 * We have a single directory with 1 node in it.
411 * Description of fs contents.
413 struct rpc_filelist {
415 const struct file_operations *i_fop;
419 static struct rpc_filelist files[] = {
422 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
426 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
430 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
432 [RPCAUTH_portmap] = {
434 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
438 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
447 static struct rpc_filelist authfiles[] = {
450 .i_fop = &rpc_info_operations,
451 .mode = S_IFREG | S_IRUSR,
455 struct vfsmount *rpc_get_mount(void)
459 err = simple_pin_fs(&rpc_pipe_fs_type, &rpc_mount, &rpc_mount_count);
465 void rpc_put_mount(void)
467 simple_release_fs(&rpc_mount, &rpc_mount_count);
470 static int rpc_delete_dentry(struct dentry *dentry)
475 static struct dentry_operations rpc_dentry_operations = {
476 .d_delete = rpc_delete_dentry,
480 rpc_lookup_parent(char *path, struct nameidata *nd)
482 struct vfsmount *mnt;
487 mnt = rpc_get_mount();
489 printk(KERN_WARNING "%s: %s failed to mount "
490 "pseudofilesystem \n", __FILE__, __func__);
494 if (vfs_path_lookup(mnt->mnt_root, mnt, path, LOOKUP_PARENT, nd)) {
495 printk(KERN_WARNING "%s: %s failed to find path %s\n",
496 __FILE__, __func__, path);
504 rpc_release_path(struct nameidata *nd)
510 static struct inode *
511 rpc_get_inode(struct super_block *sb, int mode)
513 struct inode *inode = new_inode(sb);
516 inode->i_mode = mode;
517 inode->i_uid = inode->i_gid = 0;
519 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
520 switch(mode & S_IFMT) {
522 inode->i_fop = &simple_dir_operations;
523 inode->i_op = &simple_dir_inode_operations;
532 * FIXME: This probably has races.
534 static void rpc_depopulate(struct dentry *parent,
535 unsigned long start, unsigned long eof)
537 struct inode *dir = parent->d_inode;
538 struct list_head *pos, *next;
539 struct dentry *dentry, *dvec[10];
542 mutex_lock_nested(&dir->i_mutex, I_MUTEX_CHILD);
544 spin_lock(&dcache_lock);
545 list_for_each_safe(pos, next, &parent->d_subdirs) {
546 dentry = list_entry(pos, struct dentry, d_u.d_child);
547 if (!dentry->d_inode ||
548 dentry->d_inode->i_ino < start ||
549 dentry->d_inode->i_ino >= eof)
551 spin_lock(&dentry->d_lock);
552 if (!d_unhashed(dentry)) {
555 spin_unlock(&dentry->d_lock);
557 if (n == ARRAY_SIZE(dvec))
560 spin_unlock(&dentry->d_lock);
562 spin_unlock(&dcache_lock);
566 if (S_ISREG(dentry->d_inode->i_mode))
567 simple_unlink(dir, dentry);
568 else if (S_ISDIR(dentry->d_inode->i_mode))
569 simple_rmdir(dir, dentry);
575 mutex_unlock(&dir->i_mutex);
579 rpc_populate(struct dentry *parent,
580 struct rpc_filelist *files,
583 struct inode *inode, *dir = parent->d_inode;
584 void *private = RPC_I(dir)->private;
585 struct dentry *dentry;
588 mutex_lock(&dir->i_mutex);
589 for (i = start; i < eof; i++) {
590 dentry = d_alloc_name(parent, files[i].name);
593 dentry->d_op = &rpc_dentry_operations;
594 mode = files[i].mode;
595 inode = rpc_get_inode(dir->i_sb, mode);
602 inode->i_fop = files[i].i_fop;
604 rpc_inode_setowner(inode, private);
607 d_add(dentry, inode);
608 fsnotify_create(dir, dentry);
610 mutex_unlock(&dir->i_mutex);
613 mutex_unlock(&dir->i_mutex);
614 printk(KERN_WARNING "%s: %s failed to populate directory %s\n",
615 __FILE__, __func__, parent->d_name.name);
620 __rpc_mkdir(struct inode *dir, struct dentry *dentry)
624 inode = rpc_get_inode(dir->i_sb, S_IFDIR | S_IRUGO | S_IXUGO);
627 inode->i_ino = iunique(dir->i_sb, 100);
628 d_instantiate(dentry, inode);
630 fsnotify_mkdir(dir, dentry);
633 printk(KERN_WARNING "%s: %s failed to allocate inode for dentry %s\n",
634 __FILE__, __func__, dentry->d_name.name);
639 __rpc_rmdir(struct inode *dir, struct dentry *dentry)
642 error = simple_rmdir(dir, dentry);
648 static struct dentry *
649 rpc_lookup_create(struct dentry *parent, const char *name, int len, int exclusive)
651 struct inode *dir = parent->d_inode;
652 struct dentry *dentry;
654 mutex_lock_nested(&dir->i_mutex, I_MUTEX_PARENT);
655 dentry = lookup_one_len(name, parent, len);
658 if (!dentry->d_inode)
659 dentry->d_op = &rpc_dentry_operations;
660 else if (exclusive) {
662 dentry = ERR_PTR(-EEXIST);
667 mutex_unlock(&dir->i_mutex);
671 static struct dentry *
672 rpc_lookup_negative(char *path, struct nameidata *nd)
674 struct dentry *dentry;
677 if ((error = rpc_lookup_parent(path, nd)) != 0)
678 return ERR_PTR(error);
679 dentry = rpc_lookup_create(nd->path.dentry, nd->last.name, nd->last.len,
682 rpc_release_path(nd);
687 * rpc_mkdir - Create a new directory in rpc_pipefs
688 * @path: path from the rpc_pipefs root to the new directory
689 * @rpc_client: rpc client to associate with this directory
691 * This creates a directory at the given @path associated with
692 * @rpc_clnt, which will contain a file named "info" with some basic
693 * information about the client, together with any "pipes" that may
694 * later be created using rpc_mkpipe().
697 rpc_mkdir(char *path, struct rpc_clnt *rpc_client)
700 struct dentry *dentry;
704 dentry = rpc_lookup_negative(path, &nd);
707 dir = nd.path.dentry->d_inode;
708 if ((error = __rpc_mkdir(dir, dentry)) != 0)
710 RPC_I(dentry->d_inode)->private = rpc_client;
711 error = rpc_populate(dentry, authfiles,
712 RPCAUTH_info, RPCAUTH_EOF);
717 mutex_unlock(&dir->i_mutex);
718 rpc_release_path(&nd);
721 rpc_depopulate(dentry, RPCAUTH_info, RPCAUTH_EOF);
722 __rpc_rmdir(dir, dentry);
725 printk(KERN_WARNING "%s: %s() failed to create directory %s (errno = %d)\n",
726 __FILE__, __func__, path, error);
727 dentry = ERR_PTR(error);
732 * rpc_rmdir - Remove a directory created with rpc_mkdir()
733 * @dentry: directory to remove
736 rpc_rmdir(struct dentry *dentry)
738 struct dentry *parent;
742 parent = dget_parent(dentry);
743 dir = parent->d_inode;
744 mutex_lock_nested(&dir->i_mutex, I_MUTEX_PARENT);
745 rpc_depopulate(dentry, RPCAUTH_info, RPCAUTH_EOF);
746 error = __rpc_rmdir(dir, dentry);
748 mutex_unlock(&dir->i_mutex);
754 * rpc_mkpipe - make an rpc_pipefs file for kernel<->userspace communication
755 * @parent: dentry of directory to create new "pipe" in
756 * @name: name of pipe
757 * @private: private data to associate with the pipe, for the caller's use
758 * @ops: operations defining the behavior of the pipe: upcall, downcall,
759 * release_pipe, open_pipe, and destroy_msg.
760 * @flags: rpc_inode flags
762 * Data is made available for userspace to read by calls to
763 * rpc_queue_upcall(). The actual reads will result in calls to
764 * @ops->upcall, which will be called with the file pointer,
765 * message, and userspace buffer to copy to.
767 * Writes can come at any time, and do not necessarily have to be
768 * responses to upcalls. They will result in calls to @msg->downcall.
770 * The @private argument passed here will be available to all these methods
771 * from the file pointer, via RPC_I(file->f_dentry->d_inode)->private.
774 rpc_mkpipe(struct dentry *parent, const char *name, void *private, struct rpc_pipe_ops *ops, int flags)
776 struct dentry *dentry;
777 struct inode *dir, *inode;
778 struct rpc_inode *rpci;
780 dentry = rpc_lookup_create(parent, name, strlen(name), 0);
783 dir = parent->d_inode;
784 if (dentry->d_inode) {
785 rpci = RPC_I(dentry->d_inode);
786 if (rpci->private != private ||
788 rpci->flags != flags) {
790 dentry = ERR_PTR(-EBUSY);
792 rpci->nkern_readwriters++;
795 inode = rpc_get_inode(dir->i_sb, S_IFIFO | S_IRUSR | S_IWUSR);
798 inode->i_ino = iunique(dir->i_sb, 100);
799 inode->i_fop = &rpc_pipe_fops;
800 d_instantiate(dentry, inode);
802 rpci->private = private;
805 rpci->nkern_readwriters = 1;
806 fsnotify_create(dir, dentry);
809 mutex_unlock(&dir->i_mutex);
813 dentry = ERR_PTR(-ENOMEM);
814 printk(KERN_WARNING "%s: %s() failed to create pipe %s/%s (errno = %d)\n",
815 __FILE__, __func__, parent->d_name.name, name,
819 EXPORT_SYMBOL_GPL(rpc_mkpipe);
822 * rpc_unlink - remove a pipe
823 * @dentry: dentry for the pipe, as returned from rpc_mkpipe
825 * After this call, lookups will no longer find the pipe, and any
826 * attempts to read or write using preexisting opens of the pipe will
830 rpc_unlink(struct dentry *dentry)
832 struct dentry *parent;
836 parent = dget_parent(dentry);
837 dir = parent->d_inode;
838 mutex_lock_nested(&dir->i_mutex, I_MUTEX_PARENT);
839 if (--RPC_I(dentry->d_inode)->nkern_readwriters == 0) {
840 rpc_close_pipes(dentry->d_inode);
841 error = simple_unlink(dir, dentry);
846 mutex_unlock(&dir->i_mutex);
850 EXPORT_SYMBOL_GPL(rpc_unlink);
853 * populate the filesystem
855 static struct super_operations s_ops = {
856 .alloc_inode = rpc_alloc_inode,
857 .destroy_inode = rpc_destroy_inode,
858 .statfs = simple_statfs,
861 #define RPCAUTH_GSSMAGIC 0x67596969
864 rpc_fill_super(struct super_block *sb, void *data, int silent)
869 sb->s_blocksize = PAGE_CACHE_SIZE;
870 sb->s_blocksize_bits = PAGE_CACHE_SHIFT;
871 sb->s_magic = RPCAUTH_GSSMAGIC;
875 inode = rpc_get_inode(sb, S_IFDIR | 0755);
878 root = d_alloc_root(inode);
883 if (rpc_populate(root, files, RPCAUTH_Root + 1, RPCAUTH_RootEOF))
894 rpc_get_sb(struct file_system_type *fs_type,
895 int flags, const char *dev_name, void *data, struct vfsmount *mnt)
897 return get_sb_single(fs_type, flags, data, rpc_fill_super, mnt);
900 static struct file_system_type rpc_pipe_fs_type = {
901 .owner = THIS_MODULE,
902 .name = "rpc_pipefs",
903 .get_sb = rpc_get_sb,
904 .kill_sb = kill_litter_super,
910 struct rpc_inode *rpci = (struct rpc_inode *) foo;
912 inode_init_once(&rpci->vfs_inode);
913 rpci->private = NULL;
916 INIT_LIST_HEAD(&rpci->in_upcall);
917 INIT_LIST_HEAD(&rpci->in_downcall);
918 INIT_LIST_HEAD(&rpci->pipe);
920 init_waitqueue_head(&rpci->waitq);
921 INIT_DELAYED_WORK(&rpci->queue_timeout,
922 rpc_timeout_upcall_queue);
926 int register_rpc_pipefs(void)
930 rpc_inode_cachep = kmem_cache_create("rpc_inode_cache",
931 sizeof(struct rpc_inode),
932 0, (SLAB_HWCACHE_ALIGN|SLAB_RECLAIM_ACCOUNT|
935 if (!rpc_inode_cachep)
937 err = register_filesystem(&rpc_pipe_fs_type);
939 kmem_cache_destroy(rpc_inode_cachep);
946 void unregister_rpc_pipefs(void)
948 kmem_cache_destroy(rpc_inode_cachep);
949 unregister_filesystem(&rpc_pipe_fs_type);