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>
19 #include <linux/rcupdate.h>
20 #include <linux/utsname.h>
22 #include <asm/ioctls.h>
23 #include <linux/poll.h>
24 #include <linux/wait.h>
25 #include <linux/seq_file.h>
27 #include <linux/sunrpc/clnt.h>
28 #include <linux/workqueue.h>
29 #include <linux/sunrpc/rpc_pipe_fs.h>
30 #include <linux/sunrpc/cache.h>
31 #include <linux/nsproxy.h>
32 #include <linux/notifier.h>
37 #define RPCDBG_FACILITY RPCDBG_DEBUG
39 #define NET_NAME(net) ((net == &init_net) ? " (init_net)" : "")
41 static struct file_system_type rpc_pipe_fs_type;
42 static const struct rpc_pipe_ops gssd_dummy_pipe_ops;
44 static struct kmem_cache *rpc_inode_cachep __read_mostly;
46 #define RPC_UPCALL_TIMEOUT (30*HZ)
48 static BLOCKING_NOTIFIER_HEAD(rpc_pipefs_notifier_list);
50 int rpc_pipefs_notifier_register(struct notifier_block *nb)
52 return blocking_notifier_chain_cond_register(&rpc_pipefs_notifier_list, nb);
54 EXPORT_SYMBOL_GPL(rpc_pipefs_notifier_register);
56 void rpc_pipefs_notifier_unregister(struct notifier_block *nb)
58 blocking_notifier_chain_unregister(&rpc_pipefs_notifier_list, nb);
60 EXPORT_SYMBOL_GPL(rpc_pipefs_notifier_unregister);
62 static void rpc_purge_list(wait_queue_head_t *waitq, struct list_head *head,
63 void (*destroy_msg)(struct rpc_pipe_msg *), int err)
65 struct rpc_pipe_msg *msg;
70 msg = list_entry(head->next, struct rpc_pipe_msg, list);
71 list_del_init(&msg->list);
74 } while (!list_empty(head));
81 rpc_timeout_upcall_queue(struct work_struct *work)
84 struct rpc_pipe *pipe =
85 container_of(work, struct rpc_pipe, queue_timeout.work);
86 void (*destroy_msg)(struct rpc_pipe_msg *);
87 struct dentry *dentry;
89 spin_lock(&pipe->lock);
90 destroy_msg = pipe->ops->destroy_msg;
91 if (pipe->nreaders == 0) {
92 list_splice_init(&pipe->pipe, &free_list);
95 dentry = dget(pipe->dentry);
96 spin_unlock(&pipe->lock);
97 rpc_purge_list(dentry ? &RPC_I(d_inode(dentry))->waitq : NULL,
98 &free_list, destroy_msg, -ETIMEDOUT);
102 ssize_t rpc_pipe_generic_upcall(struct file *filp, struct rpc_pipe_msg *msg,
103 char __user *dst, size_t buflen)
105 char *data = (char *)msg->data + msg->copied;
106 size_t mlen = min(msg->len - msg->copied, buflen);
109 left = copy_to_user(dst, data, mlen);
111 msg->errno = -EFAULT;
120 EXPORT_SYMBOL_GPL(rpc_pipe_generic_upcall);
123 * rpc_queue_upcall - queue an upcall message to userspace
124 * @pipe: upcall pipe on which to queue given message
125 * @msg: message to queue
127 * Call with an @inode created by rpc_mkpipe() to queue an upcall.
128 * A userspace process may then later read the upcall by performing a
129 * read on an open file for this inode. It is up to the caller to
130 * initialize the fields of @msg (other than @msg->list) appropriately.
133 rpc_queue_upcall(struct rpc_pipe *pipe, struct rpc_pipe_msg *msg)
136 struct dentry *dentry;
138 spin_lock(&pipe->lock);
139 if (pipe->nreaders) {
140 list_add_tail(&msg->list, &pipe->pipe);
141 pipe->pipelen += msg->len;
143 } else if (pipe->flags & RPC_PIPE_WAIT_FOR_OPEN) {
144 if (list_empty(&pipe->pipe))
145 queue_delayed_work(rpciod_workqueue,
146 &pipe->queue_timeout,
148 list_add_tail(&msg->list, &pipe->pipe);
149 pipe->pipelen += msg->len;
152 dentry = dget(pipe->dentry);
153 spin_unlock(&pipe->lock);
155 wake_up(&RPC_I(d_inode(dentry))->waitq);
160 EXPORT_SYMBOL_GPL(rpc_queue_upcall);
163 rpc_inode_setowner(struct inode *inode, void *private)
165 RPC_I(inode)->private = private;
169 rpc_close_pipes(struct inode *inode)
171 struct rpc_pipe *pipe = RPC_I(inode)->pipe;
173 LIST_HEAD(free_list);
176 spin_lock(&pipe->lock);
177 need_release = pipe->nreaders != 0 || pipe->nwriters != 0;
179 list_splice_init(&pipe->in_upcall, &free_list);
180 list_splice_init(&pipe->pipe, &free_list);
183 spin_unlock(&pipe->lock);
184 rpc_purge_list(&RPC_I(inode)->waitq, &free_list, pipe->ops->destroy_msg, -EPIPE);
186 if (need_release && pipe->ops->release_pipe)
187 pipe->ops->release_pipe(inode);
188 cancel_delayed_work_sync(&pipe->queue_timeout);
189 rpc_inode_setowner(inode, NULL);
190 RPC_I(inode)->pipe = NULL;
194 static struct inode *
195 rpc_alloc_inode(struct super_block *sb)
197 struct rpc_inode *rpci;
198 rpci = kmem_cache_alloc(rpc_inode_cachep, GFP_KERNEL);
201 return &rpci->vfs_inode;
205 rpc_i_callback(struct rcu_head *head)
207 struct inode *inode = container_of(head, struct inode, i_rcu);
208 kmem_cache_free(rpc_inode_cachep, RPC_I(inode));
212 rpc_destroy_inode(struct inode *inode)
214 call_rcu(&inode->i_rcu, rpc_i_callback);
218 rpc_pipe_open(struct inode *inode, struct file *filp)
220 struct rpc_pipe *pipe;
225 pipe = RPC_I(inode)->pipe;
228 first_open = pipe->nreaders == 0 && pipe->nwriters == 0;
229 if (first_open && pipe->ops->open_pipe) {
230 res = pipe->ops->open_pipe(inode);
234 if (filp->f_mode & FMODE_READ)
236 if (filp->f_mode & FMODE_WRITE)
245 rpc_pipe_release(struct inode *inode, struct file *filp)
247 struct rpc_pipe *pipe;
248 struct rpc_pipe_msg *msg;
252 pipe = RPC_I(inode)->pipe;
255 msg = filp->private_data;
257 spin_lock(&pipe->lock);
258 msg->errno = -EAGAIN;
259 list_del_init(&msg->list);
260 spin_unlock(&pipe->lock);
261 pipe->ops->destroy_msg(msg);
263 if (filp->f_mode & FMODE_WRITE)
265 if (filp->f_mode & FMODE_READ) {
267 if (pipe->nreaders == 0) {
268 LIST_HEAD(free_list);
269 spin_lock(&pipe->lock);
270 list_splice_init(&pipe->pipe, &free_list);
272 spin_unlock(&pipe->lock);
273 rpc_purge_list(&RPC_I(inode)->waitq, &free_list,
274 pipe->ops->destroy_msg, -EAGAIN);
277 last_close = pipe->nwriters == 0 && pipe->nreaders == 0;
278 if (last_close && pipe->ops->release_pipe)
279 pipe->ops->release_pipe(inode);
286 rpc_pipe_read(struct file *filp, char __user *buf, size_t len, loff_t *offset)
288 struct inode *inode = file_inode(filp);
289 struct rpc_pipe *pipe;
290 struct rpc_pipe_msg *msg;
294 pipe = RPC_I(inode)->pipe;
299 msg = filp->private_data;
301 spin_lock(&pipe->lock);
302 if (!list_empty(&pipe->pipe)) {
303 msg = list_entry(pipe->pipe.next,
306 list_move(&msg->list, &pipe->in_upcall);
307 pipe->pipelen -= msg->len;
308 filp->private_data = msg;
311 spin_unlock(&pipe->lock);
315 /* NOTE: it is up to the callback to update msg->copied */
316 res = pipe->ops->upcall(filp, msg, buf, len);
317 if (res < 0 || msg->len == msg->copied) {
318 filp->private_data = NULL;
319 spin_lock(&pipe->lock);
320 list_del_init(&msg->list);
321 spin_unlock(&pipe->lock);
322 pipe->ops->destroy_msg(msg);
330 rpc_pipe_write(struct file *filp, const char __user *buf, size_t len, loff_t *offset)
332 struct inode *inode = file_inode(filp);
337 if (RPC_I(inode)->pipe != NULL)
338 res = RPC_I(inode)->pipe->ops->downcall(filp, buf, len);
344 rpc_pipe_poll(struct file *filp, struct poll_table_struct *wait)
346 struct inode *inode = file_inode(filp);
347 struct rpc_inode *rpci = RPC_I(inode);
348 unsigned int mask = POLLOUT | POLLWRNORM;
350 poll_wait(filp, &rpci->waitq, wait);
353 if (rpci->pipe == NULL)
354 mask |= POLLERR | POLLHUP;
355 else if (filp->private_data || !list_empty(&rpci->pipe->pipe))
356 mask |= POLLIN | POLLRDNORM;
362 rpc_pipe_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
364 struct inode *inode = file_inode(filp);
365 struct rpc_pipe *pipe;
371 pipe = RPC_I(inode)->pipe;
376 spin_lock(&pipe->lock);
378 if (filp->private_data) {
379 struct rpc_pipe_msg *msg;
380 msg = filp->private_data;
381 len += msg->len - msg->copied;
383 spin_unlock(&pipe->lock);
385 return put_user(len, (int __user *)arg);
391 static const struct file_operations rpc_pipe_fops = {
392 .owner = THIS_MODULE,
394 .read = rpc_pipe_read,
395 .write = rpc_pipe_write,
396 .poll = rpc_pipe_poll,
397 .unlocked_ioctl = rpc_pipe_ioctl,
398 .open = rpc_pipe_open,
399 .release = rpc_pipe_release,
403 rpc_show_info(struct seq_file *m, void *v)
405 struct rpc_clnt *clnt = m->private;
408 seq_printf(m, "RPC server: %s\n",
409 rcu_dereference(clnt->cl_xprt)->servername);
410 seq_printf(m, "service: %s (%d) version %d\n", clnt->cl_program->name,
411 clnt->cl_prog, clnt->cl_vers);
412 seq_printf(m, "address: %s\n", rpc_peeraddr2str(clnt, RPC_DISPLAY_ADDR));
413 seq_printf(m, "protocol: %s\n", rpc_peeraddr2str(clnt, RPC_DISPLAY_PROTO));
414 seq_printf(m, "port: %s\n", rpc_peeraddr2str(clnt, RPC_DISPLAY_PORT));
420 rpc_info_open(struct inode *inode, struct file *file)
422 struct rpc_clnt *clnt = NULL;
423 int ret = single_open(file, rpc_show_info, NULL);
426 struct seq_file *m = file->private_data;
428 spin_lock(&file->f_path.dentry->d_lock);
429 if (!d_unhashed(file->f_path.dentry))
430 clnt = RPC_I(inode)->private;
431 if (clnt != NULL && atomic_inc_not_zero(&clnt->cl_count)) {
432 spin_unlock(&file->f_path.dentry->d_lock);
435 spin_unlock(&file->f_path.dentry->d_lock);
436 single_release(inode, file);
444 rpc_info_release(struct inode *inode, struct file *file)
446 struct seq_file *m = file->private_data;
447 struct rpc_clnt *clnt = (struct rpc_clnt *)m->private;
450 rpc_release_client(clnt);
451 return single_release(inode, file);
454 static const struct file_operations rpc_info_operations = {
455 .owner = THIS_MODULE,
456 .open = rpc_info_open,
459 .release = rpc_info_release,
464 * Description of fs contents.
466 struct rpc_filelist {
468 const struct file_operations *i_fop;
472 static struct inode *
473 rpc_get_inode(struct super_block *sb, umode_t mode)
475 struct inode *inode = new_inode(sb);
478 inode->i_ino = get_next_ino();
479 inode->i_mode = mode;
480 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
481 switch (mode & S_IFMT) {
483 inode->i_fop = &simple_dir_operations;
484 inode->i_op = &simple_dir_inode_operations;
492 static int __rpc_create_common(struct inode *dir, struct dentry *dentry,
494 const struct file_operations *i_fop,
500 inode = rpc_get_inode(dir->i_sb, mode);
503 inode->i_ino = iunique(dir->i_sb, 100);
505 inode->i_fop = i_fop;
507 rpc_inode_setowner(inode, private);
508 d_add(dentry, inode);
511 printk(KERN_WARNING "%s: %s failed to allocate inode for dentry %pd\n",
512 __FILE__, __func__, dentry);
517 static int __rpc_create(struct inode *dir, struct dentry *dentry,
519 const struct file_operations *i_fop,
524 err = __rpc_create_common(dir, dentry, S_IFREG | mode, i_fop, private);
527 fsnotify_create(dir, dentry);
531 static int __rpc_mkdir(struct inode *dir, struct dentry *dentry,
533 const struct file_operations *i_fop,
538 err = __rpc_create_common(dir, dentry, S_IFDIR | mode, i_fop, private);
542 fsnotify_mkdir(dir, dentry);
547 init_pipe(struct rpc_pipe *pipe)
551 INIT_LIST_HEAD(&pipe->in_upcall);
552 INIT_LIST_HEAD(&pipe->in_downcall);
553 INIT_LIST_HEAD(&pipe->pipe);
555 INIT_DELAYED_WORK(&pipe->queue_timeout,
556 rpc_timeout_upcall_queue);
558 spin_lock_init(&pipe->lock);
562 void rpc_destroy_pipe_data(struct rpc_pipe *pipe)
566 EXPORT_SYMBOL_GPL(rpc_destroy_pipe_data);
568 struct rpc_pipe *rpc_mkpipe_data(const struct rpc_pipe_ops *ops, int flags)
570 struct rpc_pipe *pipe;
572 pipe = kzalloc(sizeof(struct rpc_pipe), GFP_KERNEL);
574 return ERR_PTR(-ENOMEM);
580 EXPORT_SYMBOL_GPL(rpc_mkpipe_data);
582 static int __rpc_mkpipe_dentry(struct inode *dir, struct dentry *dentry,
584 const struct file_operations *i_fop,
586 struct rpc_pipe *pipe)
588 struct rpc_inode *rpci;
591 err = __rpc_create_common(dir, dentry, S_IFIFO | mode, i_fop, private);
594 rpci = RPC_I(d_inode(dentry));
595 rpci->private = private;
597 fsnotify_create(dir, dentry);
601 static int __rpc_rmdir(struct inode *dir, struct dentry *dentry)
606 ret = simple_rmdir(dir, dentry);
612 int rpc_rmdir(struct dentry *dentry)
614 struct dentry *parent;
618 parent = dget_parent(dentry);
619 dir = d_inode(parent);
620 inode_lock_nested(dir, I_MUTEX_PARENT);
621 error = __rpc_rmdir(dir, dentry);
626 EXPORT_SYMBOL_GPL(rpc_rmdir);
628 static int __rpc_unlink(struct inode *dir, struct dentry *dentry)
633 ret = simple_unlink(dir, dentry);
639 static int __rpc_rmpipe(struct inode *dir, struct dentry *dentry)
641 struct inode *inode = d_inode(dentry);
643 rpc_close_pipes(inode);
644 return __rpc_unlink(dir, dentry);
647 static struct dentry *__rpc_lookup_create_exclusive(struct dentry *parent,
650 struct qstr q = QSTR_INIT(name, strlen(name));
651 struct dentry *dentry = d_hash_and_lookup(parent, &q);
653 dentry = d_alloc(parent, &q);
655 return ERR_PTR(-ENOMEM);
657 if (d_really_is_negative(dentry))
660 return ERR_PTR(-EEXIST);
664 * FIXME: This probably has races.
666 static void __rpc_depopulate(struct dentry *parent,
667 const struct rpc_filelist *files,
670 struct inode *dir = d_inode(parent);
671 struct dentry *dentry;
675 for (i = start; i < eof; i++) {
676 name.name = files[i].name;
677 name.len = strlen(files[i].name);
678 dentry = d_hash_and_lookup(parent, &name);
682 if (d_really_is_negative(dentry))
684 switch (d_inode(dentry)->i_mode & S_IFMT) {
688 __rpc_unlink(dir, dentry);
691 __rpc_rmdir(dir, dentry);
698 static void rpc_depopulate(struct dentry *parent,
699 const struct rpc_filelist *files,
702 struct inode *dir = d_inode(parent);
704 inode_lock_nested(dir, I_MUTEX_CHILD);
705 __rpc_depopulate(parent, files, start, eof);
709 static int rpc_populate(struct dentry *parent,
710 const struct rpc_filelist *files,
714 struct inode *dir = d_inode(parent);
715 struct dentry *dentry;
719 for (i = start; i < eof; i++) {
720 dentry = __rpc_lookup_create_exclusive(parent, files[i].name);
721 err = PTR_ERR(dentry);
724 switch (files[i].mode & S_IFMT) {
728 err = __rpc_create(dir, dentry,
734 err = __rpc_mkdir(dir, dentry,
745 __rpc_depopulate(parent, files, start, eof);
747 printk(KERN_WARNING "%s: %s failed to populate directory %pd\n",
748 __FILE__, __func__, parent);
752 static struct dentry *rpc_mkdir_populate(struct dentry *parent,
753 const char *name, umode_t mode, void *private,
754 int (*populate)(struct dentry *, void *), void *args_populate)
756 struct dentry *dentry;
757 struct inode *dir = d_inode(parent);
760 inode_lock_nested(dir, I_MUTEX_PARENT);
761 dentry = __rpc_lookup_create_exclusive(parent, name);
764 error = __rpc_mkdir(dir, dentry, mode, NULL, private);
767 if (populate != NULL) {
768 error = populate(dentry, args_populate);
776 __rpc_rmdir(dir, dentry);
778 dentry = ERR_PTR(error);
782 static int rpc_rmdir_depopulate(struct dentry *dentry,
783 void (*depopulate)(struct dentry *))
785 struct dentry *parent;
789 parent = dget_parent(dentry);
790 dir = d_inode(parent);
791 inode_lock_nested(dir, I_MUTEX_PARENT);
792 if (depopulate != NULL)
794 error = __rpc_rmdir(dir, dentry);
801 * rpc_mkpipe - make an rpc_pipefs file for kernel<->userspace communication
802 * @parent: dentry of directory to create new "pipe" in
803 * @name: name of pipe
804 * @private: private data to associate with the pipe, for the caller's use
805 * @pipe: &rpc_pipe containing input parameters
807 * Data is made available for userspace to read by calls to
808 * rpc_queue_upcall(). The actual reads will result in calls to
809 * @ops->upcall, which will be called with the file pointer,
810 * message, and userspace buffer to copy to.
812 * Writes can come at any time, and do not necessarily have to be
813 * responses to upcalls. They will result in calls to @msg->downcall.
815 * The @private argument passed here will be available to all these methods
816 * from the file pointer, via RPC_I(file_inode(file))->private.
818 struct dentry *rpc_mkpipe_dentry(struct dentry *parent, const char *name,
819 void *private, struct rpc_pipe *pipe)
821 struct dentry *dentry;
822 struct inode *dir = d_inode(parent);
823 umode_t umode = S_IFIFO | S_IRUSR | S_IWUSR;
826 if (pipe->ops->upcall == NULL)
828 if (pipe->ops->downcall == NULL)
831 inode_lock_nested(dir, I_MUTEX_PARENT);
832 dentry = __rpc_lookup_create_exclusive(parent, name);
835 err = __rpc_mkpipe_dentry(dir, dentry, umode, &rpc_pipe_fops,
843 dentry = ERR_PTR(err);
844 printk(KERN_WARNING "%s: %s() failed to create pipe %pd/%s (errno = %d)\n",
845 __FILE__, __func__, parent, name,
849 EXPORT_SYMBOL_GPL(rpc_mkpipe_dentry);
852 * rpc_unlink - remove a pipe
853 * @dentry: dentry for the pipe, as returned from rpc_mkpipe
855 * After this call, lookups will no longer find the pipe, and any
856 * attempts to read or write using preexisting opens of the pipe will
860 rpc_unlink(struct dentry *dentry)
862 struct dentry *parent;
866 parent = dget_parent(dentry);
867 dir = d_inode(parent);
868 inode_lock_nested(dir, I_MUTEX_PARENT);
869 error = __rpc_rmpipe(dir, dentry);
874 EXPORT_SYMBOL_GPL(rpc_unlink);
877 * rpc_init_pipe_dir_head - initialise a struct rpc_pipe_dir_head
878 * @pdh: pointer to struct rpc_pipe_dir_head
880 void rpc_init_pipe_dir_head(struct rpc_pipe_dir_head *pdh)
882 INIT_LIST_HEAD(&pdh->pdh_entries);
883 pdh->pdh_dentry = NULL;
885 EXPORT_SYMBOL_GPL(rpc_init_pipe_dir_head);
888 * rpc_init_pipe_dir_object - initialise a struct rpc_pipe_dir_object
889 * @pdo: pointer to struct rpc_pipe_dir_object
890 * @pdo_ops: pointer to const struct rpc_pipe_dir_object_ops
891 * @pdo_data: pointer to caller-defined data
893 void rpc_init_pipe_dir_object(struct rpc_pipe_dir_object *pdo,
894 const struct rpc_pipe_dir_object_ops *pdo_ops,
897 INIT_LIST_HEAD(&pdo->pdo_head);
898 pdo->pdo_ops = pdo_ops;
899 pdo->pdo_data = pdo_data;
901 EXPORT_SYMBOL_GPL(rpc_init_pipe_dir_object);
904 rpc_add_pipe_dir_object_locked(struct net *net,
905 struct rpc_pipe_dir_head *pdh,
906 struct rpc_pipe_dir_object *pdo)
911 ret = pdo->pdo_ops->create(pdh->pdh_dentry, pdo);
913 list_add_tail(&pdo->pdo_head, &pdh->pdh_entries);
918 rpc_remove_pipe_dir_object_locked(struct net *net,
919 struct rpc_pipe_dir_head *pdh,
920 struct rpc_pipe_dir_object *pdo)
923 pdo->pdo_ops->destroy(pdh->pdh_dentry, pdo);
924 list_del_init(&pdo->pdo_head);
928 * rpc_add_pipe_dir_object - associate a rpc_pipe_dir_object to a directory
929 * @net: pointer to struct net
930 * @pdh: pointer to struct rpc_pipe_dir_head
931 * @pdo: pointer to struct rpc_pipe_dir_object
935 rpc_add_pipe_dir_object(struct net *net,
936 struct rpc_pipe_dir_head *pdh,
937 struct rpc_pipe_dir_object *pdo)
941 if (list_empty(&pdo->pdo_head)) {
942 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
944 mutex_lock(&sn->pipefs_sb_lock);
945 ret = rpc_add_pipe_dir_object_locked(net, pdh, pdo);
946 mutex_unlock(&sn->pipefs_sb_lock);
950 EXPORT_SYMBOL_GPL(rpc_add_pipe_dir_object);
953 * rpc_remove_pipe_dir_object - remove a rpc_pipe_dir_object from a directory
954 * @net: pointer to struct net
955 * @pdh: pointer to struct rpc_pipe_dir_head
956 * @pdo: pointer to struct rpc_pipe_dir_object
960 rpc_remove_pipe_dir_object(struct net *net,
961 struct rpc_pipe_dir_head *pdh,
962 struct rpc_pipe_dir_object *pdo)
964 if (!list_empty(&pdo->pdo_head)) {
965 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
967 mutex_lock(&sn->pipefs_sb_lock);
968 rpc_remove_pipe_dir_object_locked(net, pdh, pdo);
969 mutex_unlock(&sn->pipefs_sb_lock);
972 EXPORT_SYMBOL_GPL(rpc_remove_pipe_dir_object);
975 * rpc_find_or_alloc_pipe_dir_object
976 * @net: pointer to struct net
977 * @pdh: pointer to struct rpc_pipe_dir_head
978 * @match: match struct rpc_pipe_dir_object to data
979 * @alloc: allocate a new struct rpc_pipe_dir_object
980 * @data: user defined data for match() and alloc()
983 struct rpc_pipe_dir_object *
984 rpc_find_or_alloc_pipe_dir_object(struct net *net,
985 struct rpc_pipe_dir_head *pdh,
986 int (*match)(struct rpc_pipe_dir_object *, void *),
987 struct rpc_pipe_dir_object *(*alloc)(void *),
990 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
991 struct rpc_pipe_dir_object *pdo;
993 mutex_lock(&sn->pipefs_sb_lock);
994 list_for_each_entry(pdo, &pdh->pdh_entries, pdo_head) {
995 if (!match(pdo, data))
1002 rpc_add_pipe_dir_object_locked(net, pdh, pdo);
1004 mutex_unlock(&sn->pipefs_sb_lock);
1007 EXPORT_SYMBOL_GPL(rpc_find_or_alloc_pipe_dir_object);
1010 rpc_create_pipe_dir_objects(struct rpc_pipe_dir_head *pdh)
1012 struct rpc_pipe_dir_object *pdo;
1013 struct dentry *dir = pdh->pdh_dentry;
1015 list_for_each_entry(pdo, &pdh->pdh_entries, pdo_head)
1016 pdo->pdo_ops->create(dir, pdo);
1020 rpc_destroy_pipe_dir_objects(struct rpc_pipe_dir_head *pdh)
1022 struct rpc_pipe_dir_object *pdo;
1023 struct dentry *dir = pdh->pdh_dentry;
1025 list_for_each_entry(pdo, &pdh->pdh_entries, pdo_head)
1026 pdo->pdo_ops->destroy(dir, pdo);
1034 static const struct rpc_filelist authfiles[] = {
1037 .i_fop = &rpc_info_operations,
1038 .mode = S_IFREG | S_IRUSR,
1042 static int rpc_clntdir_populate(struct dentry *dentry, void *private)
1044 return rpc_populate(dentry,
1045 authfiles, RPCAUTH_info, RPCAUTH_EOF,
1049 static void rpc_clntdir_depopulate(struct dentry *dentry)
1051 rpc_depopulate(dentry, authfiles, RPCAUTH_info, RPCAUTH_EOF);
1055 * rpc_create_client_dir - Create a new rpc_client directory in rpc_pipefs
1056 * @dentry: the parent of new directory
1057 * @name: the name of new directory
1058 * @rpc_client: rpc client to associate with this directory
1060 * This creates a directory at the given @path associated with
1061 * @rpc_clnt, which will contain a file named "info" with some basic
1062 * information about the client, together with any "pipes" that may
1063 * later be created using rpc_mkpipe().
1065 struct dentry *rpc_create_client_dir(struct dentry *dentry,
1067 struct rpc_clnt *rpc_client)
1071 ret = rpc_mkdir_populate(dentry, name, S_IRUGO | S_IXUGO, NULL,
1072 rpc_clntdir_populate, rpc_client);
1074 rpc_client->cl_pipedir_objects.pdh_dentry = ret;
1075 rpc_create_pipe_dir_objects(&rpc_client->cl_pipedir_objects);
1081 * rpc_remove_client_dir - Remove a directory created with rpc_create_client_dir()
1082 * @rpc_client: rpc_client for the pipe
1084 int rpc_remove_client_dir(struct rpc_clnt *rpc_client)
1086 struct dentry *dentry = rpc_client->cl_pipedir_objects.pdh_dentry;
1090 rpc_destroy_pipe_dir_objects(&rpc_client->cl_pipedir_objects);
1091 rpc_client->cl_pipedir_objects.pdh_dentry = NULL;
1092 return rpc_rmdir_depopulate(dentry, rpc_clntdir_depopulate);
1095 static const struct rpc_filelist cache_pipefs_files[3] = {
1098 .i_fop = &cache_file_operations_pipefs,
1099 .mode = S_IFREG|S_IRUSR|S_IWUSR,
1103 .i_fop = &content_file_operations_pipefs,
1104 .mode = S_IFREG|S_IRUSR,
1108 .i_fop = &cache_flush_operations_pipefs,
1109 .mode = S_IFREG|S_IRUSR|S_IWUSR,
1113 static int rpc_cachedir_populate(struct dentry *dentry, void *private)
1115 return rpc_populate(dentry,
1116 cache_pipefs_files, 0, 3,
1120 static void rpc_cachedir_depopulate(struct dentry *dentry)
1122 rpc_depopulate(dentry, cache_pipefs_files, 0, 3);
1125 struct dentry *rpc_create_cache_dir(struct dentry *parent, const char *name,
1126 umode_t umode, struct cache_detail *cd)
1128 return rpc_mkdir_populate(parent, name, umode, NULL,
1129 rpc_cachedir_populate, cd);
1132 void rpc_remove_cache_dir(struct dentry *dentry)
1134 rpc_rmdir_depopulate(dentry, rpc_cachedir_depopulate);
1138 * populate the filesystem
1140 static const struct super_operations s_ops = {
1141 .alloc_inode = rpc_alloc_inode,
1142 .destroy_inode = rpc_destroy_inode,
1143 .statfs = simple_statfs,
1146 #define RPCAUTH_GSSMAGIC 0x67596969
1149 * We have a single directory with 1 node in it.
1164 static const struct rpc_filelist files[] = {
1167 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
1171 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
1175 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
1177 [RPCAUTH_portmap] = {
1179 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
1183 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
1185 [RPCAUTH_nfsd4_cb] = {
1187 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
1191 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
1195 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
1199 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
1204 * This call can be used only in RPC pipefs mount notification hooks.
1206 struct dentry *rpc_d_lookup_sb(const struct super_block *sb,
1207 const unsigned char *dir_name)
1209 struct qstr dir = QSTR_INIT(dir_name, strlen(dir_name));
1210 return d_hash_and_lookup(sb->s_root, &dir);
1212 EXPORT_SYMBOL_GPL(rpc_d_lookup_sb);
1214 int rpc_pipefs_init_net(struct net *net)
1216 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
1218 sn->gssd_dummy = rpc_mkpipe_data(&gssd_dummy_pipe_ops, 0);
1219 if (IS_ERR(sn->gssd_dummy))
1220 return PTR_ERR(sn->gssd_dummy);
1222 mutex_init(&sn->pipefs_sb_lock);
1223 sn->pipe_version = -1;
1227 void rpc_pipefs_exit_net(struct net *net)
1229 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
1231 rpc_destroy_pipe_data(sn->gssd_dummy);
1235 * This call will be used for per network namespace operations calls.
1236 * Note: Function will be returned with pipefs_sb_lock taken if superblock was
1237 * found. This lock have to be released by rpc_put_sb_net() when all operations
1238 * will be completed.
1240 struct super_block *rpc_get_sb_net(const struct net *net)
1242 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
1244 mutex_lock(&sn->pipefs_sb_lock);
1246 return sn->pipefs_sb;
1247 mutex_unlock(&sn->pipefs_sb_lock);
1250 EXPORT_SYMBOL_GPL(rpc_get_sb_net);
1252 void rpc_put_sb_net(const struct net *net)
1254 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
1256 WARN_ON(sn->pipefs_sb == NULL);
1257 mutex_unlock(&sn->pipefs_sb_lock);
1259 EXPORT_SYMBOL_GPL(rpc_put_sb_net);
1261 static const struct rpc_filelist gssd_dummy_clnt_dir[] = {
1264 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
1269 dummy_downcall(struct file *filp, const char __user *src, size_t len)
1274 static const struct rpc_pipe_ops gssd_dummy_pipe_ops = {
1275 .upcall = rpc_pipe_generic_upcall,
1276 .downcall = dummy_downcall,
1280 * Here we present a bogus "info" file to keep rpc.gssd happy. We don't expect
1281 * that it will ever use this info to handle an upcall, but rpc.gssd expects
1282 * that this file will be there and have a certain format.
1285 rpc_show_dummy_info(struct seq_file *m, void *v)
1287 seq_printf(m, "RPC server: %s\n", utsname()->nodename);
1288 seq_printf(m, "service: foo (1) version 0\n");
1289 seq_printf(m, "address: 127.0.0.1\n");
1290 seq_printf(m, "protocol: tcp\n");
1291 seq_printf(m, "port: 0\n");
1296 rpc_dummy_info_open(struct inode *inode, struct file *file)
1298 return single_open(file, rpc_show_dummy_info, NULL);
1301 static const struct file_operations rpc_dummy_info_operations = {
1302 .owner = THIS_MODULE,
1303 .open = rpc_dummy_info_open,
1305 .llseek = seq_lseek,
1306 .release = single_release,
1309 static const struct rpc_filelist gssd_dummy_info_file[] = {
1312 .i_fop = &rpc_dummy_info_operations,
1313 .mode = S_IFREG | S_IRUSR,
1318 * rpc_gssd_dummy_populate - create a dummy gssd pipe
1319 * @root: root of the rpc_pipefs filesystem
1320 * @pipe_data: pipe data created when netns is initialized
1322 * Create a dummy set of directories and a pipe that gssd can hold open to
1323 * indicate that it is up and running.
1325 static struct dentry *
1326 rpc_gssd_dummy_populate(struct dentry *root, struct rpc_pipe *pipe_data)
1329 struct dentry *gssd_dentry;
1330 struct dentry *clnt_dentry = NULL;
1331 struct dentry *pipe_dentry = NULL;
1332 struct qstr q = QSTR_INIT(files[RPCAUTH_gssd].name,
1333 strlen(files[RPCAUTH_gssd].name));
1335 /* We should never get this far if "gssd" doesn't exist */
1336 gssd_dentry = d_hash_and_lookup(root, &q);
1338 return ERR_PTR(-ENOENT);
1340 ret = rpc_populate(gssd_dentry, gssd_dummy_clnt_dir, 0, 1, NULL);
1342 pipe_dentry = ERR_PTR(ret);
1346 q.name = gssd_dummy_clnt_dir[0].name;
1347 q.len = strlen(gssd_dummy_clnt_dir[0].name);
1348 clnt_dentry = d_hash_and_lookup(gssd_dentry, &q);
1350 pipe_dentry = ERR_PTR(-ENOENT);
1354 ret = rpc_populate(clnt_dentry, gssd_dummy_info_file, 0, 1, NULL);
1356 __rpc_depopulate(gssd_dentry, gssd_dummy_clnt_dir, 0, 1);
1357 pipe_dentry = ERR_PTR(ret);
1361 pipe_dentry = rpc_mkpipe_dentry(clnt_dentry, "gssd", NULL, pipe_data);
1362 if (IS_ERR(pipe_dentry)) {
1363 __rpc_depopulate(clnt_dentry, gssd_dummy_info_file, 0, 1);
1364 __rpc_depopulate(gssd_dentry, gssd_dummy_clnt_dir, 0, 1);
1373 rpc_gssd_dummy_depopulate(struct dentry *pipe_dentry)
1375 struct dentry *clnt_dir = pipe_dentry->d_parent;
1376 struct dentry *gssd_dir = clnt_dir->d_parent;
1378 __rpc_rmpipe(d_inode(clnt_dir), pipe_dentry);
1379 __rpc_depopulate(clnt_dir, gssd_dummy_info_file, 0, 1);
1380 __rpc_depopulate(gssd_dir, gssd_dummy_clnt_dir, 0, 1);
1385 rpc_fill_super(struct super_block *sb, void *data, int silent)
1387 struct inode *inode;
1388 struct dentry *root, *gssd_dentry;
1389 struct net *net = data;
1390 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
1393 sb->s_blocksize = PAGE_SIZE;
1394 sb->s_blocksize_bits = PAGE_SHIFT;
1395 sb->s_magic = RPCAUTH_GSSMAGIC;
1397 sb->s_d_op = &simple_dentry_operations;
1398 sb->s_time_gran = 1;
1400 inode = rpc_get_inode(sb, S_IFDIR | S_IRUGO | S_IXUGO);
1401 sb->s_root = root = d_make_root(inode);
1404 if (rpc_populate(root, files, RPCAUTH_lockd, RPCAUTH_RootEOF, NULL))
1407 gssd_dentry = rpc_gssd_dummy_populate(root, sn->gssd_dummy);
1408 if (IS_ERR(gssd_dentry)) {
1409 __rpc_depopulate(root, files, RPCAUTH_lockd, RPCAUTH_RootEOF);
1410 return PTR_ERR(gssd_dentry);
1413 dprintk("RPC: sending pipefs MOUNT notification for net %p%s\n",
1414 net, NET_NAME(net));
1415 mutex_lock(&sn->pipefs_sb_lock);
1417 err = blocking_notifier_call_chain(&rpc_pipefs_notifier_list,
1421 goto err_depopulate;
1422 sb->s_fs_info = get_net(net);
1423 mutex_unlock(&sn->pipefs_sb_lock);
1427 rpc_gssd_dummy_depopulate(gssd_dentry);
1428 blocking_notifier_call_chain(&rpc_pipefs_notifier_list,
1431 sn->pipefs_sb = NULL;
1432 __rpc_depopulate(root, files, RPCAUTH_lockd, RPCAUTH_RootEOF);
1433 mutex_unlock(&sn->pipefs_sb_lock);
1438 gssd_running(struct net *net)
1440 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
1441 struct rpc_pipe *pipe = sn->gssd_dummy;
1443 return pipe->nreaders || pipe->nwriters;
1445 EXPORT_SYMBOL_GPL(gssd_running);
1447 static struct dentry *
1448 rpc_mount(struct file_system_type *fs_type,
1449 int flags, const char *dev_name, void *data)
1451 return mount_ns(fs_type, flags, current->nsproxy->net_ns, rpc_fill_super);
1454 static void rpc_kill_sb(struct super_block *sb)
1456 struct net *net = sb->s_fs_info;
1457 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
1459 mutex_lock(&sn->pipefs_sb_lock);
1460 if (sn->pipefs_sb != sb) {
1461 mutex_unlock(&sn->pipefs_sb_lock);
1464 sn->pipefs_sb = NULL;
1465 dprintk("RPC: sending pipefs UMOUNT notification for net %p%s\n",
1466 net, NET_NAME(net));
1467 blocking_notifier_call_chain(&rpc_pipefs_notifier_list,
1470 mutex_unlock(&sn->pipefs_sb_lock);
1473 kill_litter_super(sb);
1476 static struct file_system_type rpc_pipe_fs_type = {
1477 .owner = THIS_MODULE,
1478 .name = "rpc_pipefs",
1480 .kill_sb = rpc_kill_sb,
1482 MODULE_ALIAS_FS("rpc_pipefs");
1483 MODULE_ALIAS("rpc_pipefs");
1486 init_once(void *foo)
1488 struct rpc_inode *rpci = (struct rpc_inode *) foo;
1490 inode_init_once(&rpci->vfs_inode);
1491 rpci->private = NULL;
1493 init_waitqueue_head(&rpci->waitq);
1496 int register_rpc_pipefs(void)
1500 rpc_inode_cachep = kmem_cache_create("rpc_inode_cache",
1501 sizeof(struct rpc_inode),
1502 0, (SLAB_HWCACHE_ALIGN|SLAB_RECLAIM_ACCOUNT|
1503 SLAB_MEM_SPREAD|SLAB_ACCOUNT),
1505 if (!rpc_inode_cachep)
1507 err = rpc_clients_notifier_register();
1510 err = register_filesystem(&rpc_pipe_fs_type);
1516 rpc_clients_notifier_unregister();
1518 kmem_cache_destroy(rpc_inode_cachep);
1522 void unregister_rpc_pipefs(void)
1524 rpc_clients_notifier_unregister();
1525 kmem_cache_destroy(rpc_inode_cachep);
1526 unregister_filesystem(&rpc_pipe_fs_type);