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>
29 #include <linux/sunrpc/cache.h>
30 #include <linux/nsproxy.h>
31 #include <linux/notifier.h>
36 #define RPCDBG_FACILITY RPCDBG_DEBUG
38 #define NET_NAME(net) ((net == &init_net) ? " (init_net)" : "")
40 static struct vfsmount *rpc_mnt __read_mostly;
41 static int rpc_mount_count;
43 static struct file_system_type rpc_pipe_fs_type;
46 static struct kmem_cache *rpc_inode_cachep __read_mostly;
48 #define RPC_UPCALL_TIMEOUT (30*HZ)
50 static BLOCKING_NOTIFIER_HEAD(rpc_pipefs_notifier_list);
52 int rpc_pipefs_notifier_register(struct notifier_block *nb)
54 return blocking_notifier_chain_cond_register(&rpc_pipefs_notifier_list, nb);
56 EXPORT_SYMBOL_GPL(rpc_pipefs_notifier_register);
58 void rpc_pipefs_notifier_unregister(struct notifier_block *nb)
60 blocking_notifier_chain_unregister(&rpc_pipefs_notifier_list, nb);
62 EXPORT_SYMBOL_GPL(rpc_pipefs_notifier_unregister);
64 static void rpc_purge_list(struct rpc_pipe *pipe, struct list_head *head,
65 void (*destroy_msg)(struct rpc_pipe_msg *), int err)
67 struct rpc_pipe_msg *msg;
72 msg = list_entry(head->next, struct rpc_pipe_msg, list);
73 list_del_init(&msg->list);
76 } while (!list_empty(head));
77 wake_up(&pipe->waitq);
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 *);
88 spin_lock(&pipe->lock);
89 destroy_msg = pipe->ops->destroy_msg;
90 if (pipe->nreaders == 0) {
91 list_splice_init(&pipe->pipe, &free_list);
94 spin_unlock(&pipe->lock);
95 rpc_purge_list(pipe, &free_list, destroy_msg, -ETIMEDOUT);
98 ssize_t rpc_pipe_generic_upcall(struct file *filp, struct rpc_pipe_msg *msg,
99 char __user *dst, size_t buflen)
101 char *data = (char *)msg->data + msg->copied;
102 size_t mlen = min(msg->len - msg->copied, buflen);
105 left = copy_to_user(dst, data, mlen);
107 msg->errno = -EFAULT;
116 EXPORT_SYMBOL_GPL(rpc_pipe_generic_upcall);
119 * rpc_queue_upcall - queue an upcall message to userspace
120 * @inode: inode of upcall pipe on which to queue given message
121 * @msg: message to queue
123 * Call with an @inode created by rpc_mkpipe() to queue an upcall.
124 * A userspace process may then later read the upcall by performing a
125 * read on an open file for this inode. It is up to the caller to
126 * initialize the fields of @msg (other than @msg->list) appropriately.
129 rpc_queue_upcall(struct rpc_pipe *pipe, struct rpc_pipe_msg *msg)
133 spin_lock(&pipe->lock);
134 if (pipe->nreaders) {
135 list_add_tail(&msg->list, &pipe->pipe);
136 pipe->pipelen += msg->len;
138 } else if (pipe->flags & RPC_PIPE_WAIT_FOR_OPEN) {
139 if (list_empty(&pipe->pipe))
140 queue_delayed_work(rpciod_workqueue,
141 &pipe->queue_timeout,
143 list_add_tail(&msg->list, &pipe->pipe);
144 pipe->pipelen += msg->len;
147 spin_unlock(&pipe->lock);
148 wake_up(&pipe->waitq);
151 EXPORT_SYMBOL_GPL(rpc_queue_upcall);
154 rpc_inode_setowner(struct inode *inode, void *private)
156 RPC_I(inode)->private = private;
160 rpc_close_pipes(struct inode *inode)
162 struct rpc_pipe *pipe = RPC_I(inode)->pipe;
164 LIST_HEAD(free_list);
166 mutex_lock(&inode->i_mutex);
167 spin_lock(&pipe->lock);
168 need_release = pipe->nreaders != 0 || pipe->nwriters != 0;
170 list_splice_init(&pipe->in_upcall, &free_list);
171 list_splice_init(&pipe->pipe, &free_list);
174 spin_unlock(&pipe->lock);
175 rpc_purge_list(pipe, &free_list, pipe->ops->destroy_msg, -EPIPE);
177 if (need_release && pipe->ops->release_pipe)
178 pipe->ops->release_pipe(inode);
179 cancel_delayed_work_sync(&pipe->queue_timeout);
180 rpc_inode_setowner(inode, NULL);
181 mutex_unlock(&inode->i_mutex);
184 static struct inode *
185 rpc_alloc_inode(struct super_block *sb)
187 struct rpc_inode *rpci;
188 rpci = (struct rpc_inode *)kmem_cache_alloc(rpc_inode_cachep, GFP_KERNEL);
191 return &rpci->vfs_inode;
195 rpc_i_callback(struct rcu_head *head)
197 struct inode *inode = container_of(head, struct inode, i_rcu);
198 kmem_cache_free(rpc_inode_cachep, RPC_I(inode));
202 rpc_destroy_inode(struct inode *inode)
204 call_rcu(&inode->i_rcu, rpc_i_callback);
208 rpc_pipe_open(struct inode *inode, struct file *filp)
210 struct rpc_pipe *pipe = RPC_I(inode)->pipe;
214 mutex_lock(&inode->i_mutex);
215 if (pipe->dentry == NULL)
217 first_open = pipe->nreaders == 0 && pipe->nwriters == 0;
218 if (first_open && pipe->ops->open_pipe) {
219 res = pipe->ops->open_pipe(inode);
223 if (filp->f_mode & FMODE_READ)
225 if (filp->f_mode & FMODE_WRITE)
229 mutex_unlock(&inode->i_mutex);
234 rpc_pipe_release(struct inode *inode, struct file *filp)
236 struct rpc_pipe *pipe = RPC_I(inode)->pipe;
237 struct rpc_pipe_msg *msg;
240 mutex_lock(&inode->i_mutex);
241 if (pipe->dentry == NULL)
243 msg = filp->private_data;
245 spin_lock(&pipe->lock);
246 msg->errno = -EAGAIN;
247 list_del_init(&msg->list);
248 spin_unlock(&pipe->lock);
249 pipe->ops->destroy_msg(msg);
251 if (filp->f_mode & FMODE_WRITE)
253 if (filp->f_mode & FMODE_READ) {
255 if (pipe->nreaders == 0) {
256 LIST_HEAD(free_list);
257 spin_lock(&pipe->lock);
258 list_splice_init(&pipe->pipe, &free_list);
260 spin_unlock(&pipe->lock);
261 rpc_purge_list(pipe, &free_list,
262 pipe->ops->destroy_msg, -EAGAIN);
265 last_close = pipe->nwriters == 0 && pipe->nreaders == 0;
266 if (last_close && pipe->ops->release_pipe)
267 pipe->ops->release_pipe(inode);
269 mutex_unlock(&inode->i_mutex);
274 rpc_pipe_read(struct file *filp, char __user *buf, size_t len, loff_t *offset)
276 struct inode *inode = filp->f_path.dentry->d_inode;
277 struct rpc_pipe *pipe = RPC_I(inode)->pipe;
278 struct rpc_pipe_msg *msg;
281 mutex_lock(&inode->i_mutex);
282 if (pipe->dentry == NULL) {
286 msg = filp->private_data;
288 spin_lock(&pipe->lock);
289 if (!list_empty(&pipe->pipe)) {
290 msg = list_entry(pipe->pipe.next,
293 list_move(&msg->list, &pipe->in_upcall);
294 pipe->pipelen -= msg->len;
295 filp->private_data = msg;
298 spin_unlock(&pipe->lock);
302 /* NOTE: it is up to the callback to update msg->copied */
303 res = pipe->ops->upcall(filp, msg, buf, len);
304 if (res < 0 || msg->len == msg->copied) {
305 filp->private_data = NULL;
306 spin_lock(&pipe->lock);
307 list_del_init(&msg->list);
308 spin_unlock(&pipe->lock);
309 pipe->ops->destroy_msg(msg);
312 mutex_unlock(&inode->i_mutex);
317 rpc_pipe_write(struct file *filp, const char __user *buf, size_t len, loff_t *offset)
319 struct inode *inode = filp->f_path.dentry->d_inode;
320 struct rpc_pipe *pipe = RPC_I(inode)->pipe;
323 mutex_lock(&inode->i_mutex);
325 if (pipe->dentry != NULL)
326 res = pipe->ops->downcall(filp, buf, len);
327 mutex_unlock(&inode->i_mutex);
332 rpc_pipe_poll(struct file *filp, struct poll_table_struct *wait)
334 struct rpc_pipe *pipe = RPC_I(filp->f_path.dentry->d_inode)->pipe;
335 unsigned int mask = 0;
337 poll_wait(filp, &pipe->waitq, wait);
339 mask = POLLOUT | POLLWRNORM;
340 if (pipe->dentry == NULL)
341 mask |= POLLERR | POLLHUP;
342 if (filp->private_data || !list_empty(&pipe->pipe))
343 mask |= POLLIN | POLLRDNORM;
348 rpc_pipe_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
350 struct inode *inode = filp->f_path.dentry->d_inode;
351 struct rpc_pipe *pipe = RPC_I(inode)->pipe;
356 spin_lock(&pipe->lock);
357 if (pipe->dentry == NULL) {
358 spin_unlock(&pipe->lock);
362 if (filp->private_data) {
363 struct rpc_pipe_msg *msg;
364 msg = filp->private_data;
365 len += msg->len - msg->copied;
367 spin_unlock(&pipe->lock);
368 return put_user(len, (int __user *)arg);
374 static const struct file_operations rpc_pipe_fops = {
375 .owner = THIS_MODULE,
377 .read = rpc_pipe_read,
378 .write = rpc_pipe_write,
379 .poll = rpc_pipe_poll,
380 .unlocked_ioctl = rpc_pipe_ioctl,
381 .open = rpc_pipe_open,
382 .release = rpc_pipe_release,
386 rpc_show_info(struct seq_file *m, void *v)
388 struct rpc_clnt *clnt = m->private;
390 seq_printf(m, "RPC server: %s\n", clnt->cl_server);
391 seq_printf(m, "service: %s (%d) version %d\n", clnt->cl_protname,
392 clnt->cl_prog, clnt->cl_vers);
393 seq_printf(m, "address: %s\n", rpc_peeraddr2str(clnt, RPC_DISPLAY_ADDR));
394 seq_printf(m, "protocol: %s\n", rpc_peeraddr2str(clnt, RPC_DISPLAY_PROTO));
395 seq_printf(m, "port: %s\n", rpc_peeraddr2str(clnt, RPC_DISPLAY_PORT));
400 rpc_info_open(struct inode *inode, struct file *file)
402 struct rpc_clnt *clnt = NULL;
403 int ret = single_open(file, rpc_show_info, NULL);
406 struct seq_file *m = file->private_data;
408 spin_lock(&file->f_path.dentry->d_lock);
409 if (!d_unhashed(file->f_path.dentry))
410 clnt = RPC_I(inode)->private;
411 if (clnt != NULL && atomic_inc_not_zero(&clnt->cl_count)) {
412 spin_unlock(&file->f_path.dentry->d_lock);
415 spin_unlock(&file->f_path.dentry->d_lock);
416 single_release(inode, file);
424 rpc_info_release(struct inode *inode, struct file *file)
426 struct seq_file *m = file->private_data;
427 struct rpc_clnt *clnt = (struct rpc_clnt *)m->private;
430 rpc_release_client(clnt);
431 return single_release(inode, file);
434 static const struct file_operations rpc_info_operations = {
435 .owner = THIS_MODULE,
436 .open = rpc_info_open,
439 .release = rpc_info_release,
444 * Description of fs contents.
446 struct rpc_filelist {
448 const struct file_operations *i_fop;
452 struct vfsmount *rpc_get_mount(void)
456 err = simple_pin_fs(&rpc_pipe_fs_type, &rpc_mnt, &rpc_mount_count);
461 EXPORT_SYMBOL_GPL(rpc_get_mount);
463 void rpc_put_mount(void)
465 simple_release_fs(&rpc_mnt, &rpc_mount_count);
467 EXPORT_SYMBOL_GPL(rpc_put_mount);
469 static int rpc_delete_dentry(const struct dentry *dentry)
474 static const struct dentry_operations rpc_dentry_operations = {
475 .d_delete = rpc_delete_dentry,
478 static struct inode *
479 rpc_get_inode(struct super_block *sb, umode_t mode)
481 struct inode *inode = new_inode(sb);
484 inode->i_ino = get_next_ino();
485 inode->i_mode = mode;
486 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
487 switch (mode & S_IFMT) {
489 inode->i_fop = &simple_dir_operations;
490 inode->i_op = &simple_dir_inode_operations;
498 static int __rpc_create_common(struct inode *dir, struct dentry *dentry,
500 const struct file_operations *i_fop,
506 inode = rpc_get_inode(dir->i_sb, mode);
509 inode->i_ino = iunique(dir->i_sb, 100);
511 inode->i_fop = i_fop;
513 rpc_inode_setowner(inode, private);
514 d_add(dentry, inode);
517 printk(KERN_WARNING "%s: %s failed to allocate inode for dentry %s\n",
518 __FILE__, __func__, dentry->d_name.name);
523 static int __rpc_create(struct inode *dir, struct dentry *dentry,
525 const struct file_operations *i_fop,
530 err = __rpc_create_common(dir, dentry, S_IFREG | mode, i_fop, private);
533 fsnotify_create(dir, dentry);
537 static int __rpc_mkdir(struct inode *dir, struct dentry *dentry,
539 const struct file_operations *i_fop,
544 err = __rpc_create_common(dir, dentry, S_IFDIR | mode, i_fop, private);
548 fsnotify_mkdir(dir, dentry);
553 init_pipe(struct rpc_pipe *pipe)
557 INIT_LIST_HEAD(&pipe->in_upcall);
558 INIT_LIST_HEAD(&pipe->in_downcall);
559 INIT_LIST_HEAD(&pipe->pipe);
561 init_waitqueue_head(&pipe->waitq);
562 INIT_DELAYED_WORK(&pipe->queue_timeout,
563 rpc_timeout_upcall_queue);
565 spin_lock_init(&pipe->lock);
569 void rpc_destroy_pipe_data(struct rpc_pipe *pipe)
573 EXPORT_SYMBOL_GPL(rpc_destroy_pipe_data);
575 struct rpc_pipe *rpc_mkpipe_data(const struct rpc_pipe_ops *ops, int flags)
577 struct rpc_pipe *pipe;
579 pipe = kzalloc(sizeof(struct rpc_pipe), GFP_KERNEL);
581 return ERR_PTR(-ENOMEM);
587 EXPORT_SYMBOL_GPL(rpc_mkpipe_data);
589 static int __rpc_mkpipe_dentry(struct inode *dir, struct dentry *dentry,
591 const struct file_operations *i_fop,
593 struct rpc_pipe *pipe)
595 struct rpc_inode *rpci;
598 err = __rpc_create_common(dir, dentry, S_IFIFO | mode, i_fop, private);
601 rpci = RPC_I(dentry->d_inode);
602 rpci->private = private;
604 fsnotify_create(dir, dentry);
608 static int __rpc_rmdir(struct inode *dir, struct dentry *dentry)
613 ret = simple_rmdir(dir, dentry);
619 static int __rpc_unlink(struct inode *dir, struct dentry *dentry)
624 ret = simple_unlink(dir, dentry);
630 static int __rpc_rmpipe(struct inode *dir, struct dentry *dentry)
632 struct inode *inode = dentry->d_inode;
634 rpc_close_pipes(inode);
635 return __rpc_unlink(dir, dentry);
638 static struct dentry *__rpc_lookup_create_exclusive(struct dentry *parent,
641 struct dentry *dentry;
643 dentry = d_lookup(parent, name);
645 dentry = d_alloc(parent, name);
647 return ERR_PTR(-ENOMEM);
649 if (dentry->d_inode == NULL) {
650 d_set_d_op(dentry, &rpc_dentry_operations);
654 return ERR_PTR(-EEXIST);
658 * FIXME: This probably has races.
660 static void __rpc_depopulate(struct dentry *parent,
661 const struct rpc_filelist *files,
664 struct inode *dir = parent->d_inode;
665 struct dentry *dentry;
669 for (i = start; i < eof; i++) {
670 name.name = files[i].name;
671 name.len = strlen(files[i].name);
672 name.hash = full_name_hash(name.name, name.len);
673 dentry = d_lookup(parent, &name);
677 if (dentry->d_inode == NULL)
679 switch (dentry->d_inode->i_mode & S_IFMT) {
683 __rpc_unlink(dir, dentry);
686 __rpc_rmdir(dir, dentry);
693 static void rpc_depopulate(struct dentry *parent,
694 const struct rpc_filelist *files,
697 struct inode *dir = parent->d_inode;
699 mutex_lock_nested(&dir->i_mutex, I_MUTEX_CHILD);
700 __rpc_depopulate(parent, files, start, eof);
701 mutex_unlock(&dir->i_mutex);
704 static int rpc_populate(struct dentry *parent,
705 const struct rpc_filelist *files,
709 struct inode *dir = parent->d_inode;
710 struct dentry *dentry;
713 mutex_lock(&dir->i_mutex);
714 for (i = start; i < eof; i++) {
717 q.name = files[i].name;
718 q.len = strlen(files[i].name);
719 q.hash = full_name_hash(q.name, q.len);
720 dentry = __rpc_lookup_create_exclusive(parent, &q);
721 err = PTR_ERR(dentry);
724 switch (files[i].mode & S_IFMT) {
728 err = __rpc_create(dir, dentry,
734 err = __rpc_mkdir(dir, dentry,
742 mutex_unlock(&dir->i_mutex);
745 __rpc_depopulate(parent, files, start, eof);
746 mutex_unlock(&dir->i_mutex);
747 printk(KERN_WARNING "%s: %s failed to populate directory %s\n",
748 __FILE__, __func__, parent->d_name.name);
752 static struct dentry *rpc_mkdir_populate(struct dentry *parent,
753 struct qstr *name, umode_t mode, void *private,
754 int (*populate)(struct dentry *, void *), void *args_populate)
756 struct dentry *dentry;
757 struct inode *dir = parent->d_inode;
760 mutex_lock_nested(&dir->i_mutex, 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);
773 mutex_unlock(&dir->i_mutex);
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 = parent->d_inode;
791 mutex_lock_nested(&dir->i_mutex, I_MUTEX_PARENT);
792 if (depopulate != NULL)
794 error = __rpc_rmdir(dir, dentry);
795 mutex_unlock(&dir->i_mutex);
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 * @ops: operations defining the behavior of the pipe: upcall, downcall,
806 * release_pipe, open_pipe, and destroy_msg.
807 * @flags: rpc_pipe flags
809 * Data is made available for userspace to read by calls to
810 * rpc_queue_upcall(). The actual reads will result in calls to
811 * @ops->upcall, which will be called with the file pointer,
812 * message, and userspace buffer to copy to.
814 * Writes can come at any time, and do not necessarily have to be
815 * responses to upcalls. They will result in calls to @msg->downcall.
817 * The @private argument passed here will be available to all these methods
818 * from the file pointer, via RPC_I(file->f_dentry->d_inode)->private.
820 struct dentry *rpc_mkpipe_dentry(struct dentry *parent, const char *name,
821 void *private, struct rpc_pipe *pipe)
823 struct dentry *dentry;
824 struct inode *dir = parent->d_inode;
825 umode_t umode = S_IFIFO | S_IRUSR | S_IWUSR;
829 if (pipe->ops->upcall == NULL)
831 if (pipe->ops->downcall == NULL)
835 q.len = strlen(name);
836 q.hash = full_name_hash(q.name, q.len),
838 mutex_lock_nested(&dir->i_mutex, I_MUTEX_PARENT);
839 dentry = __rpc_lookup_create_exclusive(parent, &q);
842 err = __rpc_mkpipe_dentry(dir, dentry, umode, &rpc_pipe_fops,
847 mutex_unlock(&dir->i_mutex);
850 dentry = ERR_PTR(err);
851 printk(KERN_WARNING "%s: %s() failed to create pipe %s/%s (errno = %d)\n",
852 __FILE__, __func__, parent->d_name.name, name,
856 EXPORT_SYMBOL_GPL(rpc_mkpipe_dentry);
859 * rpc_unlink - remove a pipe
860 * @dentry: dentry for the pipe, as returned from rpc_mkpipe
862 * After this call, lookups will no longer find the pipe, and any
863 * attempts to read or write using preexisting opens of the pipe will
867 rpc_unlink(struct dentry *dentry)
869 struct dentry *parent;
873 parent = dget_parent(dentry);
874 dir = parent->d_inode;
875 mutex_lock_nested(&dir->i_mutex, I_MUTEX_PARENT);
876 error = __rpc_rmpipe(dir, dentry);
877 mutex_unlock(&dir->i_mutex);
881 EXPORT_SYMBOL_GPL(rpc_unlink);
888 static const struct rpc_filelist authfiles[] = {
891 .i_fop = &rpc_info_operations,
892 .mode = S_IFREG | S_IRUSR,
896 static int rpc_clntdir_populate(struct dentry *dentry, void *private)
898 return rpc_populate(dentry,
899 authfiles, RPCAUTH_info, RPCAUTH_EOF,
903 static void rpc_clntdir_depopulate(struct dentry *dentry)
905 rpc_depopulate(dentry, authfiles, RPCAUTH_info, RPCAUTH_EOF);
909 * rpc_create_client_dir - Create a new rpc_client directory in rpc_pipefs
910 * @dentry: dentry from the rpc_pipefs root to the new directory
911 * @name: &struct qstr for the name
912 * @rpc_client: rpc client to associate with this directory
914 * This creates a directory at the given @path associated with
915 * @rpc_clnt, which will contain a file named "info" with some basic
916 * information about the client, together with any "pipes" that may
917 * later be created using rpc_mkpipe().
919 struct dentry *rpc_create_client_dir(struct dentry *dentry,
921 struct rpc_clnt *rpc_client)
923 return rpc_mkdir_populate(dentry, name, S_IRUGO | S_IXUGO, NULL,
924 rpc_clntdir_populate, rpc_client);
928 * rpc_remove_client_dir - Remove a directory created with rpc_create_client_dir()
931 int rpc_remove_client_dir(struct dentry *dentry)
933 return rpc_rmdir_depopulate(dentry, rpc_clntdir_depopulate);
936 static const struct rpc_filelist cache_pipefs_files[3] = {
939 .i_fop = &cache_file_operations_pipefs,
940 .mode = S_IFREG|S_IRUSR|S_IWUSR,
944 .i_fop = &content_file_operations_pipefs,
945 .mode = S_IFREG|S_IRUSR,
949 .i_fop = &cache_flush_operations_pipefs,
950 .mode = S_IFREG|S_IRUSR|S_IWUSR,
954 static int rpc_cachedir_populate(struct dentry *dentry, void *private)
956 return rpc_populate(dentry,
957 cache_pipefs_files, 0, 3,
961 static void rpc_cachedir_depopulate(struct dentry *dentry)
963 rpc_depopulate(dentry, cache_pipefs_files, 0, 3);
966 struct dentry *rpc_create_cache_dir(struct dentry *parent, struct qstr *name,
967 umode_t umode, struct cache_detail *cd)
969 return rpc_mkdir_populate(parent, name, umode, NULL,
970 rpc_cachedir_populate, cd);
973 void rpc_remove_cache_dir(struct dentry *dentry)
975 rpc_rmdir_depopulate(dentry, rpc_cachedir_depopulate);
979 * populate the filesystem
981 static const struct super_operations s_ops = {
982 .alloc_inode = rpc_alloc_inode,
983 .destroy_inode = rpc_destroy_inode,
984 .statfs = simple_statfs,
987 #define RPCAUTH_GSSMAGIC 0x67596969
990 * We have a single directory with 1 node in it.
1003 static const struct rpc_filelist files[] = {
1006 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
1010 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
1014 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
1016 [RPCAUTH_portmap] = {
1018 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
1022 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
1024 [RPCAUTH_nfsd4_cb] = {
1026 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
1030 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
1035 * This call can be used only in RPC pipefs mount notification hooks.
1037 struct dentry *rpc_d_lookup_sb(const struct super_block *sb,
1038 const unsigned char *dir_name)
1042 .len = strlen(dir_name),
1043 .hash = full_name_hash(dir_name, strlen(dir_name)),
1046 return d_lookup(sb->s_root, &dir);
1048 EXPORT_SYMBOL_GPL(rpc_d_lookup_sb);
1050 void rpc_pipefs_init_net(struct net *net)
1052 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
1054 mutex_init(&sn->pipefs_sb_lock);
1058 * This call will be used for per network namespace operations calls.
1059 * Note: Function will be returned with pipefs_sb_lock taken if superblock was
1060 * found. This lock have to be released by rpc_put_sb_net() when all operations
1061 * will be completed.
1063 struct super_block *rpc_get_sb_net(const struct net *net)
1065 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
1067 mutex_lock(&sn->pipefs_sb_lock);
1069 return sn->pipefs_sb;
1070 mutex_unlock(&sn->pipefs_sb_lock);
1073 EXPORT_SYMBOL_GPL(rpc_get_sb_net);
1075 void rpc_put_sb_net(const struct net *net)
1077 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
1079 BUG_ON(sn->pipefs_sb == NULL);
1080 mutex_unlock(&sn->pipefs_sb_lock);
1082 EXPORT_SYMBOL_GPL(rpc_put_sb_net);
1085 rpc_fill_super(struct super_block *sb, void *data, int silent)
1087 struct inode *inode;
1088 struct dentry *root;
1089 struct net *net = data;
1090 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
1093 sb->s_blocksize = PAGE_CACHE_SIZE;
1094 sb->s_blocksize_bits = PAGE_CACHE_SHIFT;
1095 sb->s_magic = RPCAUTH_GSSMAGIC;
1097 sb->s_time_gran = 1;
1099 inode = rpc_get_inode(sb, S_IFDIR | 0755);
1102 sb->s_root = root = d_alloc_root(inode);
1107 if (rpc_populate(root, files, RPCAUTH_lockd, RPCAUTH_RootEOF, NULL))
1109 dprintk("RPC: sending pipefs MOUNT notification for net %p%s\n", net,
1111 err = blocking_notifier_call_chain(&rpc_pipefs_notifier_list,
1115 goto err_depopulate;
1116 sb->s_fs_info = get_net(net);
1121 blocking_notifier_call_chain(&rpc_pipefs_notifier_list,
1124 __rpc_depopulate(root, files, RPCAUTH_lockd, RPCAUTH_RootEOF);
1128 static struct dentry *
1129 rpc_mount(struct file_system_type *fs_type,
1130 int flags, const char *dev_name, void *data)
1132 return mount_ns(fs_type, flags, current->nsproxy->net_ns, rpc_fill_super);
1135 void rpc_kill_sb(struct super_block *sb)
1137 struct net *net = sb->s_fs_info;
1138 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
1140 mutex_lock(&sn->pipefs_sb_lock);
1141 sn->pipefs_sb = NULL;
1142 mutex_unlock(&sn->pipefs_sb_lock);
1144 dprintk("RPC: sending pipefs UMOUNT notification for net %p%s\n", net,
1146 blocking_notifier_call_chain(&rpc_pipefs_notifier_list,
1149 kill_litter_super(sb);
1152 static struct file_system_type rpc_pipe_fs_type = {
1153 .owner = THIS_MODULE,
1154 .name = "rpc_pipefs",
1156 .kill_sb = rpc_kill_sb,
1160 init_once(void *foo)
1162 struct rpc_inode *rpci = (struct rpc_inode *) foo;
1164 inode_init_once(&rpci->vfs_inode);
1165 rpci->private = NULL;
1169 int register_rpc_pipefs(void)
1173 rpc_inode_cachep = kmem_cache_create("rpc_inode_cache",
1174 sizeof(struct rpc_inode),
1175 0, (SLAB_HWCACHE_ALIGN|SLAB_RECLAIM_ACCOUNT|
1178 if (!rpc_inode_cachep)
1180 err = rpc_clients_notifier_register();
1183 err = register_filesystem(&rpc_pipe_fs_type);
1189 rpc_clients_notifier_unregister();
1191 kmem_cache_destroy(rpc_inode_cachep);
1195 void unregister_rpc_pipefs(void)
1197 rpc_clients_notifier_unregister();
1198 kmem_cache_destroy(rpc_inode_cachep);
1199 unregister_filesystem(&rpc_pipe_fs_type);
1202 /* Make 'mount -t rpc_pipefs ...' autoload this module. */
1203 MODULE_ALIAS("rpc_pipefs");