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 const struct rpc_pipe_ops *ops;
131 mutex_lock(&inode->i_mutex);
134 LIST_HEAD(free_list);
135 spin_lock(&inode->i_lock);
136 need_release = rpci->nreaders != 0 || rpci->nwriters != 0;
138 list_splice_init(&rpci->in_upcall, &free_list);
139 list_splice_init(&rpci->pipe, &free_list);
142 spin_unlock(&inode->i_lock);
143 rpc_purge_list(rpci, &free_list, ops->destroy_msg, -EPIPE);
145 if (need_release && ops->release_pipe)
146 ops->release_pipe(inode);
147 cancel_delayed_work_sync(&rpci->queue_timeout);
149 rpc_inode_setowner(inode, NULL);
150 mutex_unlock(&inode->i_mutex);
153 static struct inode *
154 rpc_alloc_inode(struct super_block *sb)
156 struct rpc_inode *rpci;
157 rpci = (struct rpc_inode *)kmem_cache_alloc(rpc_inode_cachep, GFP_KERNEL);
160 return &rpci->vfs_inode;
164 rpc_destroy_inode(struct inode *inode)
166 kmem_cache_free(rpc_inode_cachep, RPC_I(inode));
170 rpc_pipe_open(struct inode *inode, struct file *filp)
172 struct rpc_inode *rpci = RPC_I(inode);
176 mutex_lock(&inode->i_mutex);
177 if (rpci->ops == NULL)
179 first_open = rpci->nreaders == 0 && rpci->nwriters == 0;
180 if (first_open && rpci->ops->open_pipe) {
181 res = rpci->ops->open_pipe(inode);
185 if (filp->f_mode & FMODE_READ)
187 if (filp->f_mode & FMODE_WRITE)
191 mutex_unlock(&inode->i_mutex);
196 rpc_pipe_release(struct inode *inode, struct file *filp)
198 struct rpc_inode *rpci = RPC_I(inode);
199 struct rpc_pipe_msg *msg;
202 mutex_lock(&inode->i_mutex);
203 if (rpci->ops == NULL)
205 msg = (struct rpc_pipe_msg *)filp->private_data;
207 spin_lock(&inode->i_lock);
208 msg->errno = -EAGAIN;
209 list_del(&msg->list);
210 spin_unlock(&inode->i_lock);
211 rpci->ops->destroy_msg(msg);
213 if (filp->f_mode & FMODE_WRITE)
215 if (filp->f_mode & FMODE_READ) {
217 if (rpci->nreaders == 0) {
218 LIST_HEAD(free_list);
219 spin_lock(&inode->i_lock);
220 list_splice_init(&rpci->pipe, &free_list);
222 spin_unlock(&inode->i_lock);
223 rpc_purge_list(rpci, &free_list,
224 rpci->ops->destroy_msg, -EAGAIN);
227 last_close = rpci->nwriters == 0 && rpci->nreaders == 0;
228 if (last_close && rpci->ops->release_pipe)
229 rpci->ops->release_pipe(inode);
231 mutex_unlock(&inode->i_mutex);
236 rpc_pipe_read(struct file *filp, char __user *buf, size_t len, loff_t *offset)
238 struct inode *inode = filp->f_path.dentry->d_inode;
239 struct rpc_inode *rpci = RPC_I(inode);
240 struct rpc_pipe_msg *msg;
243 mutex_lock(&inode->i_mutex);
244 if (rpci->ops == NULL) {
248 msg = filp->private_data;
250 spin_lock(&inode->i_lock);
251 if (!list_empty(&rpci->pipe)) {
252 msg = list_entry(rpci->pipe.next,
255 list_move(&msg->list, &rpci->in_upcall);
256 rpci->pipelen -= msg->len;
257 filp->private_data = msg;
260 spin_unlock(&inode->i_lock);
264 /* NOTE: it is up to the callback to update msg->copied */
265 res = rpci->ops->upcall(filp, msg, buf, len);
266 if (res < 0 || msg->len == msg->copied) {
267 filp->private_data = NULL;
268 spin_lock(&inode->i_lock);
269 list_del(&msg->list);
270 spin_unlock(&inode->i_lock);
271 rpci->ops->destroy_msg(msg);
274 mutex_unlock(&inode->i_mutex);
279 rpc_pipe_write(struct file *filp, const char __user *buf, size_t len, loff_t *offset)
281 struct inode *inode = filp->f_path.dentry->d_inode;
282 struct rpc_inode *rpci = RPC_I(inode);
285 mutex_lock(&inode->i_mutex);
287 if (rpci->ops != NULL)
288 res = rpci->ops->downcall(filp, buf, len);
289 mutex_unlock(&inode->i_mutex);
294 rpc_pipe_poll(struct file *filp, struct poll_table_struct *wait)
296 struct rpc_inode *rpci;
297 unsigned int mask = 0;
299 rpci = RPC_I(filp->f_path.dentry->d_inode);
300 poll_wait(filp, &rpci->waitq, wait);
302 mask = POLLOUT | POLLWRNORM;
303 if (rpci->ops == NULL)
304 mask |= POLLERR | POLLHUP;
305 if (filp->private_data || !list_empty(&rpci->pipe))
306 mask |= POLLIN | POLLRDNORM;
311 rpc_pipe_ioctl(struct inode *ino, struct file *filp,
312 unsigned int cmd, unsigned long arg)
314 struct rpc_inode *rpci = RPC_I(filp->f_path.dentry->d_inode);
319 if (rpci->ops == NULL)
322 if (filp->private_data) {
323 struct rpc_pipe_msg *msg;
324 msg = (struct rpc_pipe_msg *)filp->private_data;
325 len += msg->len - msg->copied;
327 return put_user(len, (int __user *)arg);
333 static const struct file_operations rpc_pipe_fops = {
334 .owner = THIS_MODULE,
336 .read = rpc_pipe_read,
337 .write = rpc_pipe_write,
338 .poll = rpc_pipe_poll,
339 .ioctl = rpc_pipe_ioctl,
340 .open = rpc_pipe_open,
341 .release = rpc_pipe_release,
345 rpc_show_info(struct seq_file *m, void *v)
347 struct rpc_clnt *clnt = m->private;
349 seq_printf(m, "RPC server: %s\n", clnt->cl_server);
350 seq_printf(m, "service: %s (%d) version %d\n", clnt->cl_protname,
351 clnt->cl_prog, clnt->cl_vers);
352 seq_printf(m, "address: %s\n", rpc_peeraddr2str(clnt, RPC_DISPLAY_ADDR));
353 seq_printf(m, "protocol: %s\n", rpc_peeraddr2str(clnt, RPC_DISPLAY_PROTO));
354 seq_printf(m, "port: %s\n", rpc_peeraddr2str(clnt, RPC_DISPLAY_PORT));
359 rpc_info_open(struct inode *inode, struct file *file)
361 struct rpc_clnt *clnt;
362 int ret = single_open(file, rpc_show_info, NULL);
365 struct seq_file *m = file->private_data;
366 mutex_lock(&inode->i_mutex);
367 clnt = RPC_I(inode)->private;
369 kref_get(&clnt->cl_kref);
372 single_release(inode, file);
375 mutex_unlock(&inode->i_mutex);
381 rpc_info_release(struct inode *inode, struct file *file)
383 struct seq_file *m = file->private_data;
384 struct rpc_clnt *clnt = (struct rpc_clnt *)m->private;
387 rpc_release_client(clnt);
388 return single_release(inode, file);
391 static const struct file_operations rpc_info_operations = {
392 .owner = THIS_MODULE,
393 .open = rpc_info_open,
396 .release = rpc_info_release,
401 * Description of fs contents.
403 struct rpc_filelist {
405 const struct file_operations *i_fop;
414 static const struct rpc_filelist authfiles[] = {
417 .i_fop = &rpc_info_operations,
418 .mode = S_IFREG | S_IRUSR,
422 struct vfsmount *rpc_get_mount(void)
426 err = simple_pin_fs(&rpc_pipe_fs_type, &rpc_mount, &rpc_mount_count);
432 void rpc_put_mount(void)
434 simple_release_fs(&rpc_mount, &rpc_mount_count);
437 static int rpc_delete_dentry(struct dentry *dentry)
442 static const struct dentry_operations rpc_dentry_operations = {
443 .d_delete = rpc_delete_dentry,
446 static struct inode *
447 rpc_get_inode(struct super_block *sb, umode_t mode)
449 struct inode *inode = new_inode(sb);
452 inode->i_mode = mode;
453 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
454 switch(mode & S_IFMT) {
456 inode->i_fop = &simple_dir_operations;
457 inode->i_op = &simple_dir_inode_operations;
465 static int __rpc_create_common(struct inode *dir, struct dentry *dentry,
467 const struct file_operations *i_fop,
472 BUG_ON(!d_unhashed(dentry));
473 inode = rpc_get_inode(dir->i_sb, mode);
476 inode->i_ino = iunique(dir->i_sb, 100);
478 inode->i_fop = i_fop;
480 rpc_inode_setowner(inode, private);
481 d_add(dentry, inode);
484 printk(KERN_WARNING "%s: %s failed to allocate inode for dentry %s\n",
485 __FILE__, __func__, dentry->d_name.name);
490 static int __rpc_create(struct inode *dir, struct dentry *dentry,
492 const struct file_operations *i_fop,
497 err = __rpc_create_common(dir, dentry, S_IFREG | mode, i_fop, private);
500 fsnotify_create(dir, dentry);
504 static int __rpc_mkdir(struct inode *dir, struct dentry *dentry,
506 const struct file_operations *i_fop,
511 err = __rpc_create_common(dir, dentry, S_IFDIR | mode, i_fop, private);
515 fsnotify_mkdir(dir, dentry);
519 static int __rpc_mkpipe(struct inode *dir, struct dentry *dentry,
521 const struct file_operations *i_fop,
523 const struct rpc_pipe_ops *ops,
526 struct rpc_inode *rpci;
529 err = __rpc_create_common(dir, dentry, S_IFIFO | mode, i_fop, private);
532 rpci = RPC_I(dentry->d_inode);
533 rpci->nkern_readwriters = 1;
534 rpci->private = private;
537 fsnotify_create(dir, dentry);
541 static int __rpc_rmdir(struct inode *dir, struct dentry *dentry)
546 ret = simple_rmdir(dir, dentry);
552 static int __rpc_unlink(struct inode *dir, struct dentry *dentry)
557 ret = simple_unlink(dir, dentry);
563 static int __rpc_rmpipe(struct inode *dir, struct dentry *dentry)
565 struct inode *inode = dentry->d_inode;
566 struct rpc_inode *rpci = RPC_I(inode);
568 rpci->nkern_readwriters--;
569 if (rpci->nkern_readwriters != 0)
571 rpc_close_pipes(inode);
572 return __rpc_unlink(dir, dentry);
575 static struct dentry *__rpc_lookup_create(struct dentry *parent,
578 struct dentry *dentry;
580 dentry = d_lookup(parent, name);
582 dentry = d_alloc(parent, name);
584 dentry = ERR_PTR(-ENOMEM);
588 if (!dentry->d_inode)
589 dentry->d_op = &rpc_dentry_operations;
594 static struct dentry *__rpc_lookup_create_exclusive(struct dentry *parent,
597 struct dentry *dentry;
599 dentry = __rpc_lookup_create(parent, name);
600 if (dentry->d_inode == NULL)
603 return ERR_PTR(-EEXIST);
607 * FIXME: This probably has races.
609 static void __rpc_depopulate(struct dentry *parent,
610 const struct rpc_filelist *files,
613 struct inode *dir = parent->d_inode;
614 struct dentry *dentry;
618 for (i = start; i < eof; i++) {
619 name.name = files[i].name;
620 name.len = strlen(files[i].name);
621 name.hash = full_name_hash(name.name, name.len);
622 dentry = d_lookup(parent, &name);
626 if (dentry->d_inode == NULL)
628 switch (dentry->d_inode->i_mode & S_IFMT) {
632 __rpc_unlink(dir, dentry);
635 __rpc_rmdir(dir, dentry);
642 static void rpc_depopulate(struct dentry *parent,
643 const struct rpc_filelist *files,
646 struct inode *dir = parent->d_inode;
648 mutex_lock_nested(&dir->i_mutex, I_MUTEX_CHILD);
649 __rpc_depopulate(parent, files, start, eof);
650 mutex_unlock(&dir->i_mutex);
653 static int rpc_populate(struct dentry *parent,
654 const struct rpc_filelist *files,
658 struct inode *dir = parent->d_inode;
659 struct dentry *dentry;
662 mutex_lock(&dir->i_mutex);
663 for (i = start; i < eof; i++) {
666 q.name = files[i].name;
667 q.len = strlen(files[i].name);
668 q.hash = full_name_hash(q.name, q.len);
669 dentry = __rpc_lookup_create_exclusive(parent, &q);
670 err = PTR_ERR(dentry);
673 switch (files[i].mode & S_IFMT) {
677 err = __rpc_create(dir, dentry,
683 err = __rpc_mkdir(dir, dentry,
691 mutex_unlock(&dir->i_mutex);
694 __rpc_depopulate(parent, files, start, eof);
695 mutex_unlock(&dir->i_mutex);
696 printk(KERN_WARNING "%s: %s failed to populate directory %s\n",
697 __FILE__, __func__, parent->d_name.name);
701 struct dentry *rpc_mkdir_populate(struct dentry *parent,
702 struct qstr *name, umode_t mode, void *private)
704 struct dentry *dentry;
705 struct inode *dir = parent->d_inode;
708 mutex_lock_nested(&dir->i_mutex, I_MUTEX_PARENT);
709 dentry = __rpc_lookup_create_exclusive(parent, name);
712 error = __rpc_mkdir(dir, dentry, mode, NULL, private);
715 error = rpc_populate(dentry, authfiles,
716 RPCAUTH_info, RPCAUTH_EOF, private);
720 mutex_unlock(&dir->i_mutex);
723 __rpc_rmdir(dir, dentry);
725 dentry = ERR_PTR(error);
730 * rpc_remove_client_dir - Remove a directory created with rpc_create_client_dir()
731 * @dentry: directory to remove
733 int rpc_remove_client_dir(struct dentry *dentry)
735 struct dentry *parent;
739 parent = dget_parent(dentry);
740 dir = parent->d_inode;
741 mutex_lock_nested(&dir->i_mutex, I_MUTEX_PARENT);
742 rpc_depopulate(dentry, authfiles, RPCAUTH_info, RPCAUTH_EOF);
743 error = __rpc_rmdir(dir, dentry);
744 mutex_unlock(&dir->i_mutex);
750 * rpc_mkpipe - make an rpc_pipefs file for kernel<->userspace communication
751 * @parent: dentry of directory to create new "pipe" in
752 * @name: name of pipe
753 * @private: private data to associate with the pipe, for the caller's use
754 * @ops: operations defining the behavior of the pipe: upcall, downcall,
755 * release_pipe, open_pipe, and destroy_msg.
756 * @flags: rpc_inode flags
758 * Data is made available for userspace to read by calls to
759 * rpc_queue_upcall(). The actual reads will result in calls to
760 * @ops->upcall, which will be called with the file pointer,
761 * message, and userspace buffer to copy to.
763 * Writes can come at any time, and do not necessarily have to be
764 * responses to upcalls. They will result in calls to @msg->downcall.
766 * The @private argument passed here will be available to all these methods
767 * from the file pointer, via RPC_I(file->f_dentry->d_inode)->private.
769 struct dentry *rpc_mkpipe(struct dentry *parent, const char *name,
770 void *private, const struct rpc_pipe_ops *ops,
773 struct dentry *dentry;
774 struct inode *dir = parent->d_inode;
775 umode_t umode = S_IFIFO | S_IRUSR | S_IWUSR;
779 if (ops->upcall == NULL)
781 if (ops->downcall == NULL)
785 q.len = strlen(name);
786 q.hash = full_name_hash(q.name, q.len),
788 mutex_lock_nested(&dir->i_mutex, I_MUTEX_PARENT);
789 dentry = __rpc_lookup_create(parent, &q);
792 if (dentry->d_inode) {
793 struct rpc_inode *rpci = RPC_I(dentry->d_inode);
794 if (rpci->private != private ||
796 rpci->flags != flags) {
801 rpci->nkern_readwriters++;
805 err = __rpc_mkpipe(dir, dentry, umode, &rpc_pipe_fops,
806 private, ops, flags);
810 mutex_unlock(&dir->i_mutex);
813 dentry = ERR_PTR(err);
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 error = __rpc_rmpipe(dir, dentry);
840 mutex_unlock(&dir->i_mutex);
844 EXPORT_SYMBOL_GPL(rpc_unlink);
847 * rpc_create_client_dir - Create a new rpc_client directory in rpc_pipefs
848 * @path: path from the rpc_pipefs root to the new directory
849 * @rpc_client: rpc client to associate with this directory
851 * This creates a directory at the given @path associated with
852 * @rpc_clnt, which will contain a file named "info" with some basic
853 * information about the client, together with any "pipes" that may
854 * later be created using rpc_mkpipe().
856 struct dentry *rpc_create_client_dir(struct dentry *dentry,
858 struct rpc_clnt *rpc_client)
860 return rpc_mkdir_populate(dentry, name, S_IRUGO | S_IXUGO, rpc_client);
864 * populate the filesystem
866 static struct super_operations s_ops = {
867 .alloc_inode = rpc_alloc_inode,
868 .destroy_inode = rpc_destroy_inode,
869 .statfs = simple_statfs,
872 #define RPCAUTH_GSSMAGIC 0x67596969
875 * We have a single directory with 1 node in it.
887 static const struct rpc_filelist files[] = {
890 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
894 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
898 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
900 [RPCAUTH_portmap] = {
902 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
906 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
908 [RPCAUTH_nfsd4_cb] = {
910 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
915 rpc_fill_super(struct super_block *sb, void *data, int silent)
920 sb->s_blocksize = PAGE_CACHE_SIZE;
921 sb->s_blocksize_bits = PAGE_CACHE_SHIFT;
922 sb->s_magic = RPCAUTH_GSSMAGIC;
926 inode = rpc_get_inode(sb, S_IFDIR | 0755);
929 root = d_alloc_root(inode);
934 if (rpc_populate(root, files, RPCAUTH_lockd, RPCAUTH_RootEOF, NULL))
945 rpc_get_sb(struct file_system_type *fs_type,
946 int flags, const char *dev_name, void *data, struct vfsmount *mnt)
948 return get_sb_single(fs_type, flags, data, rpc_fill_super, mnt);
951 static struct file_system_type rpc_pipe_fs_type = {
952 .owner = THIS_MODULE,
953 .name = "rpc_pipefs",
954 .get_sb = rpc_get_sb,
955 .kill_sb = kill_litter_super,
961 struct rpc_inode *rpci = (struct rpc_inode *) foo;
963 inode_init_once(&rpci->vfs_inode);
964 rpci->private = NULL;
967 INIT_LIST_HEAD(&rpci->in_upcall);
968 INIT_LIST_HEAD(&rpci->in_downcall);
969 INIT_LIST_HEAD(&rpci->pipe);
971 init_waitqueue_head(&rpci->waitq);
972 INIT_DELAYED_WORK(&rpci->queue_timeout,
973 rpc_timeout_upcall_queue);
977 int register_rpc_pipefs(void)
981 rpc_inode_cachep = kmem_cache_create("rpc_inode_cache",
982 sizeof(struct rpc_inode),
983 0, (SLAB_HWCACHE_ALIGN|SLAB_RECLAIM_ACCOUNT|
986 if (!rpc_inode_cachep)
988 err = register_filesystem(&rpc_pipe_fs_type);
990 kmem_cache_destroy(rpc_inode_cachep);
997 void unregister_rpc_pipefs(void)
999 kmem_cache_destroy(rpc_inode_cachep);
1000 unregister_filesystem(&rpc_pipe_fs_type);