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>
21 #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 file_system_type rpc_pipe_fs_type;
43 static struct kmem_cache *rpc_inode_cachep __read_mostly;
45 #define RPC_UPCALL_TIMEOUT (30*HZ)
47 static BLOCKING_NOTIFIER_HEAD(rpc_pipefs_notifier_list);
49 int rpc_pipefs_notifier_register(struct notifier_block *nb)
51 return blocking_notifier_chain_cond_register(&rpc_pipefs_notifier_list, nb);
53 EXPORT_SYMBOL_GPL(rpc_pipefs_notifier_register);
55 void rpc_pipefs_notifier_unregister(struct notifier_block *nb)
57 blocking_notifier_chain_unregister(&rpc_pipefs_notifier_list, nb);
59 EXPORT_SYMBOL_GPL(rpc_pipefs_notifier_unregister);
61 static void rpc_purge_list(wait_queue_head_t *waitq, struct list_head *head,
62 void (*destroy_msg)(struct rpc_pipe_msg *), int err)
64 struct rpc_pipe_msg *msg;
69 msg = list_entry(head->next, struct rpc_pipe_msg, list);
70 list_del_init(&msg->list);
73 } while (!list_empty(head));
78 rpc_timeout_upcall_queue(struct work_struct *work)
81 struct rpc_pipe *pipe =
82 container_of(work, struct rpc_pipe, queue_timeout.work);
83 void (*destroy_msg)(struct rpc_pipe_msg *);
84 struct dentry *dentry;
86 spin_lock(&pipe->lock);
87 destroy_msg = pipe->ops->destroy_msg;
88 if (pipe->nreaders == 0) {
89 list_splice_init(&pipe->pipe, &free_list);
92 dentry = dget(pipe->dentry);
93 spin_unlock(&pipe->lock);
95 rpc_purge_list(&RPC_I(dentry->d_inode)->waitq,
96 &free_list, destroy_msg, -ETIMEDOUT);
101 ssize_t rpc_pipe_generic_upcall(struct file *filp, struct rpc_pipe_msg *msg,
102 char __user *dst, size_t buflen)
104 char *data = (char *)msg->data + msg->copied;
105 size_t mlen = min(msg->len - msg->copied, buflen);
108 left = copy_to_user(dst, data, mlen);
110 msg->errno = -EFAULT;
119 EXPORT_SYMBOL_GPL(rpc_pipe_generic_upcall);
122 * rpc_queue_upcall - queue an upcall message to userspace
123 * @inode: inode of upcall pipe on which to queue given message
124 * @msg: message to queue
126 * Call with an @inode created by rpc_mkpipe() to queue an upcall.
127 * A userspace process may then later read the upcall by performing a
128 * read on an open file for this inode. It is up to the caller to
129 * initialize the fields of @msg (other than @msg->list) appropriately.
132 rpc_queue_upcall(struct rpc_pipe *pipe, struct rpc_pipe_msg *msg)
135 struct dentry *dentry;
137 spin_lock(&pipe->lock);
138 if (pipe->nreaders) {
139 list_add_tail(&msg->list, &pipe->pipe);
140 pipe->pipelen += msg->len;
142 } else if (pipe->flags & RPC_PIPE_WAIT_FOR_OPEN) {
143 if (list_empty(&pipe->pipe))
144 queue_delayed_work(rpciod_workqueue,
145 &pipe->queue_timeout,
147 list_add_tail(&msg->list, &pipe->pipe);
148 pipe->pipelen += msg->len;
151 dentry = dget(pipe->dentry);
152 spin_unlock(&pipe->lock);
154 wake_up(&RPC_I(dentry->d_inode)->waitq);
159 EXPORT_SYMBOL_GPL(rpc_queue_upcall);
162 rpc_inode_setowner(struct inode *inode, void *private)
164 RPC_I(inode)->private = private;
168 rpc_close_pipes(struct inode *inode)
170 struct rpc_pipe *pipe = RPC_I(inode)->pipe;
172 LIST_HEAD(free_list);
174 mutex_lock(&inode->i_mutex);
175 spin_lock(&pipe->lock);
176 need_release = pipe->nreaders != 0 || pipe->nwriters != 0;
178 list_splice_init(&pipe->in_upcall, &free_list);
179 list_splice_init(&pipe->pipe, &free_list);
182 spin_unlock(&pipe->lock);
183 rpc_purge_list(&RPC_I(inode)->waitq, &free_list, pipe->ops->destroy_msg, -EPIPE);
185 if (need_release && pipe->ops->release_pipe)
186 pipe->ops->release_pipe(inode);
187 cancel_delayed_work_sync(&pipe->queue_timeout);
188 rpc_inode_setowner(inode, NULL);
189 RPC_I(inode)->pipe = NULL;
190 mutex_unlock(&inode->i_mutex);
193 static struct inode *
194 rpc_alloc_inode(struct super_block *sb)
196 struct rpc_inode *rpci;
197 rpci = (struct rpc_inode *)kmem_cache_alloc(rpc_inode_cachep, GFP_KERNEL);
200 return &rpci->vfs_inode;
204 rpc_i_callback(struct rcu_head *head)
206 struct inode *inode = container_of(head, struct inode, i_rcu);
207 kmem_cache_free(rpc_inode_cachep, RPC_I(inode));
211 rpc_destroy_inode(struct inode *inode)
213 call_rcu(&inode->i_rcu, rpc_i_callback);
217 rpc_pipe_open(struct inode *inode, struct file *filp)
219 struct rpc_pipe *pipe;
223 mutex_lock(&inode->i_mutex);
224 pipe = RPC_I(inode)->pipe;
227 first_open = pipe->nreaders == 0 && pipe->nwriters == 0;
228 if (first_open && pipe->ops->open_pipe) {
229 res = pipe->ops->open_pipe(inode);
233 if (filp->f_mode & FMODE_READ)
235 if (filp->f_mode & FMODE_WRITE)
239 mutex_unlock(&inode->i_mutex);
244 rpc_pipe_release(struct inode *inode, struct file *filp)
246 struct rpc_pipe *pipe;
247 struct rpc_pipe_msg *msg;
250 mutex_lock(&inode->i_mutex);
251 pipe = RPC_I(inode)->pipe;
254 msg = filp->private_data;
256 spin_lock(&pipe->lock);
257 msg->errno = -EAGAIN;
258 list_del_init(&msg->list);
259 spin_unlock(&pipe->lock);
260 pipe->ops->destroy_msg(msg);
262 if (filp->f_mode & FMODE_WRITE)
264 if (filp->f_mode & FMODE_READ) {
266 if (pipe->nreaders == 0) {
267 LIST_HEAD(free_list);
268 spin_lock(&pipe->lock);
269 list_splice_init(&pipe->pipe, &free_list);
271 spin_unlock(&pipe->lock);
272 rpc_purge_list(&RPC_I(inode)->waitq, &free_list,
273 pipe->ops->destroy_msg, -EAGAIN);
276 last_close = pipe->nwriters == 0 && pipe->nreaders == 0;
277 if (last_close && pipe->ops->release_pipe)
278 pipe->ops->release_pipe(inode);
280 mutex_unlock(&inode->i_mutex);
285 rpc_pipe_read(struct file *filp, char __user *buf, size_t len, loff_t *offset)
287 struct inode *inode = filp->f_path.dentry->d_inode;
288 struct rpc_pipe *pipe;
289 struct rpc_pipe_msg *msg;
292 mutex_lock(&inode->i_mutex);
293 pipe = RPC_I(inode)->pipe;
298 msg = filp->private_data;
300 spin_lock(&pipe->lock);
301 if (!list_empty(&pipe->pipe)) {
302 msg = list_entry(pipe->pipe.next,
305 list_move(&msg->list, &pipe->in_upcall);
306 pipe->pipelen -= msg->len;
307 filp->private_data = msg;
310 spin_unlock(&pipe->lock);
314 /* NOTE: it is up to the callback to update msg->copied */
315 res = pipe->ops->upcall(filp, msg, buf, len);
316 if (res < 0 || msg->len == msg->copied) {
317 filp->private_data = NULL;
318 spin_lock(&pipe->lock);
319 list_del_init(&msg->list);
320 spin_unlock(&pipe->lock);
321 pipe->ops->destroy_msg(msg);
324 mutex_unlock(&inode->i_mutex);
329 rpc_pipe_write(struct file *filp, const char __user *buf, size_t len, loff_t *offset)
331 struct inode *inode = filp->f_path.dentry->d_inode;
334 mutex_lock(&inode->i_mutex);
336 if (RPC_I(inode)->pipe != NULL)
337 res = RPC_I(inode)->pipe->ops->downcall(filp, buf, len);
338 mutex_unlock(&inode->i_mutex);
343 rpc_pipe_poll(struct file *filp, struct poll_table_struct *wait)
345 struct inode *inode = filp->f_path.dentry->d_inode;
346 struct rpc_inode *rpci = RPC_I(inode);
347 unsigned int mask = POLLOUT | POLLWRNORM;
349 poll_wait(filp, &rpci->waitq, wait);
351 mutex_lock(&inode->i_mutex);
352 if (rpci->pipe == NULL)
353 mask |= POLLERR | POLLHUP;
354 else if (filp->private_data || !list_empty(&rpci->pipe->pipe))
355 mask |= POLLIN | POLLRDNORM;
356 mutex_unlock(&inode->i_mutex);
361 rpc_pipe_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
363 struct inode *inode = filp->f_path.dentry->d_inode;
364 struct rpc_pipe *pipe;
369 mutex_lock(&inode->i_mutex);
370 pipe = RPC_I(inode)->pipe;
372 mutex_unlock(&inode->i_mutex);
375 spin_lock(&pipe->lock);
377 if (filp->private_data) {
378 struct rpc_pipe_msg *msg;
379 msg = filp->private_data;
380 len += msg->len - msg->copied;
382 spin_unlock(&pipe->lock);
383 mutex_unlock(&inode->i_mutex);
384 return put_user(len, (int __user *)arg);
390 static const struct file_operations rpc_pipe_fops = {
391 .owner = THIS_MODULE,
393 .read = rpc_pipe_read,
394 .write = rpc_pipe_write,
395 .poll = rpc_pipe_poll,
396 .unlocked_ioctl = rpc_pipe_ioctl,
397 .open = rpc_pipe_open,
398 .release = rpc_pipe_release,
402 rpc_show_info(struct seq_file *m, void *v)
404 struct rpc_clnt *clnt = m->private;
407 seq_printf(m, "RPC server: %s\n", clnt->cl_server);
408 seq_printf(m, "service: %s (%d) version %d\n", clnt->cl_protname,
409 clnt->cl_prog, clnt->cl_vers);
410 seq_printf(m, "address: %s\n", rpc_peeraddr2str(clnt, RPC_DISPLAY_ADDR));
411 seq_printf(m, "protocol: %s\n", rpc_peeraddr2str(clnt, RPC_DISPLAY_PROTO));
412 seq_printf(m, "port: %s\n", rpc_peeraddr2str(clnt, RPC_DISPLAY_PORT));
418 rpc_info_open(struct inode *inode, struct file *file)
420 struct rpc_clnt *clnt = NULL;
421 int ret = single_open(file, rpc_show_info, NULL);
424 struct seq_file *m = file->private_data;
426 spin_lock(&file->f_path.dentry->d_lock);
427 if (!d_unhashed(file->f_path.dentry))
428 clnt = RPC_I(inode)->private;
429 if (clnt != NULL && atomic_inc_not_zero(&clnt->cl_count)) {
430 spin_unlock(&file->f_path.dentry->d_lock);
433 spin_unlock(&file->f_path.dentry->d_lock);
434 single_release(inode, file);
442 rpc_info_release(struct inode *inode, struct file *file)
444 struct seq_file *m = file->private_data;
445 struct rpc_clnt *clnt = (struct rpc_clnt *)m->private;
448 rpc_release_client(clnt);
449 return single_release(inode, file);
452 static const struct file_operations rpc_info_operations = {
453 .owner = THIS_MODULE,
454 .open = rpc_info_open,
457 .release = rpc_info_release,
462 * Description of fs contents.
464 struct rpc_filelist {
466 const struct file_operations *i_fop;
470 static int rpc_delete_dentry(const struct dentry *dentry)
475 static const struct dentry_operations rpc_dentry_operations = {
476 .d_delete = rpc_delete_dentry,
479 static struct inode *
480 rpc_get_inode(struct super_block *sb, umode_t mode)
482 struct inode *inode = new_inode(sb);
485 inode->i_ino = get_next_ino();
486 inode->i_mode = mode;
487 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
488 switch (mode & S_IFMT) {
490 inode->i_fop = &simple_dir_operations;
491 inode->i_op = &simple_dir_inode_operations;
499 static int __rpc_create_common(struct inode *dir, struct dentry *dentry,
501 const struct file_operations *i_fop,
507 inode = rpc_get_inode(dir->i_sb, mode);
510 inode->i_ino = iunique(dir->i_sb, 100);
512 inode->i_fop = i_fop;
514 rpc_inode_setowner(inode, private);
515 d_add(dentry, inode);
518 printk(KERN_WARNING "%s: %s failed to allocate inode for dentry %s\n",
519 __FILE__, __func__, dentry->d_name.name);
524 static int __rpc_create(struct inode *dir, struct dentry *dentry,
526 const struct file_operations *i_fop,
531 err = __rpc_create_common(dir, dentry, S_IFREG | mode, i_fop, private);
534 fsnotify_create(dir, dentry);
538 static int __rpc_mkdir(struct inode *dir, struct dentry *dentry,
540 const struct file_operations *i_fop,
545 err = __rpc_create_common(dir, dentry, S_IFDIR | mode, i_fop, private);
549 fsnotify_mkdir(dir, dentry);
554 init_pipe(struct rpc_pipe *pipe)
558 INIT_LIST_HEAD(&pipe->in_upcall);
559 INIT_LIST_HEAD(&pipe->in_downcall);
560 INIT_LIST_HEAD(&pipe->pipe);
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 int rpc_rmdir(struct dentry *dentry)
621 struct dentry *parent;
625 parent = dget_parent(dentry);
626 dir = parent->d_inode;
627 mutex_lock_nested(&dir->i_mutex, I_MUTEX_PARENT);
628 error = __rpc_rmdir(dir, dentry);
629 mutex_unlock(&dir->i_mutex);
633 EXPORT_SYMBOL_GPL(rpc_rmdir);
635 static int __rpc_unlink(struct inode *dir, struct dentry *dentry)
640 ret = simple_unlink(dir, dentry);
646 static int __rpc_rmpipe(struct inode *dir, struct dentry *dentry)
648 struct inode *inode = dentry->d_inode;
650 rpc_close_pipes(inode);
651 return __rpc_unlink(dir, dentry);
654 static struct dentry *__rpc_lookup_create_exclusive(struct dentry *parent,
657 struct dentry *dentry;
659 dentry = d_lookup(parent, name);
661 dentry = d_alloc(parent, name);
663 return ERR_PTR(-ENOMEM);
665 if (dentry->d_inode == NULL) {
666 d_set_d_op(dentry, &rpc_dentry_operations);
670 return ERR_PTR(-EEXIST);
674 * FIXME: This probably has races.
676 static void __rpc_depopulate(struct dentry *parent,
677 const struct rpc_filelist *files,
680 struct inode *dir = parent->d_inode;
681 struct dentry *dentry;
685 for (i = start; i < eof; i++) {
686 name.name = files[i].name;
687 name.len = strlen(files[i].name);
688 name.hash = full_name_hash(name.name, name.len);
689 dentry = d_lookup(parent, &name);
693 if (dentry->d_inode == NULL)
695 switch (dentry->d_inode->i_mode & S_IFMT) {
699 __rpc_unlink(dir, dentry);
702 __rpc_rmdir(dir, dentry);
709 static void rpc_depopulate(struct dentry *parent,
710 const struct rpc_filelist *files,
713 struct inode *dir = parent->d_inode;
715 mutex_lock_nested(&dir->i_mutex, I_MUTEX_CHILD);
716 __rpc_depopulate(parent, files, start, eof);
717 mutex_unlock(&dir->i_mutex);
720 static int rpc_populate(struct dentry *parent,
721 const struct rpc_filelist *files,
725 struct inode *dir = parent->d_inode;
726 struct dentry *dentry;
729 mutex_lock(&dir->i_mutex);
730 for (i = start; i < eof; i++) {
733 q.name = files[i].name;
734 q.len = strlen(files[i].name);
735 q.hash = full_name_hash(q.name, q.len);
736 dentry = __rpc_lookup_create_exclusive(parent, &q);
737 err = PTR_ERR(dentry);
740 switch (files[i].mode & S_IFMT) {
744 err = __rpc_create(dir, dentry,
750 err = __rpc_mkdir(dir, dentry,
758 mutex_unlock(&dir->i_mutex);
761 __rpc_depopulate(parent, files, start, eof);
762 mutex_unlock(&dir->i_mutex);
763 printk(KERN_WARNING "%s: %s failed to populate directory %s\n",
764 __FILE__, __func__, parent->d_name.name);
768 static struct dentry *rpc_mkdir_populate(struct dentry *parent,
769 struct qstr *name, umode_t mode, void *private,
770 int (*populate)(struct dentry *, void *), void *args_populate)
772 struct dentry *dentry;
773 struct inode *dir = parent->d_inode;
776 mutex_lock_nested(&dir->i_mutex, I_MUTEX_PARENT);
777 dentry = __rpc_lookup_create_exclusive(parent, name);
780 error = __rpc_mkdir(dir, dentry, mode, NULL, private);
783 if (populate != NULL) {
784 error = populate(dentry, args_populate);
789 mutex_unlock(&dir->i_mutex);
792 __rpc_rmdir(dir, dentry);
794 dentry = ERR_PTR(error);
798 static int rpc_rmdir_depopulate(struct dentry *dentry,
799 void (*depopulate)(struct dentry *))
801 struct dentry *parent;
805 parent = dget_parent(dentry);
806 dir = parent->d_inode;
807 mutex_lock_nested(&dir->i_mutex, I_MUTEX_PARENT);
808 if (depopulate != NULL)
810 error = __rpc_rmdir(dir, dentry);
811 mutex_unlock(&dir->i_mutex);
817 * rpc_mkpipe - make an rpc_pipefs file for kernel<->userspace communication
818 * @parent: dentry of directory to create new "pipe" in
819 * @name: name of pipe
820 * @private: private data to associate with the pipe, for the caller's use
821 * @ops: operations defining the behavior of the pipe: upcall, downcall,
822 * release_pipe, open_pipe, and destroy_msg.
823 * @flags: rpc_pipe flags
825 * Data is made available for userspace to read by calls to
826 * rpc_queue_upcall(). The actual reads will result in calls to
827 * @ops->upcall, which will be called with the file pointer,
828 * message, and userspace buffer to copy to.
830 * Writes can come at any time, and do not necessarily have to be
831 * responses to upcalls. They will result in calls to @msg->downcall.
833 * The @private argument passed here will be available to all these methods
834 * from the file pointer, via RPC_I(file->f_dentry->d_inode)->private.
836 struct dentry *rpc_mkpipe_dentry(struct dentry *parent, const char *name,
837 void *private, struct rpc_pipe *pipe)
839 struct dentry *dentry;
840 struct inode *dir = parent->d_inode;
841 umode_t umode = S_IFIFO | S_IRUSR | S_IWUSR;
845 if (pipe->ops->upcall == NULL)
847 if (pipe->ops->downcall == NULL)
851 q.len = strlen(name);
852 q.hash = full_name_hash(q.name, q.len),
854 mutex_lock_nested(&dir->i_mutex, I_MUTEX_PARENT);
855 dentry = __rpc_lookup_create_exclusive(parent, &q);
858 err = __rpc_mkpipe_dentry(dir, dentry, umode, &rpc_pipe_fops,
863 mutex_unlock(&dir->i_mutex);
866 dentry = ERR_PTR(err);
867 printk(KERN_WARNING "%s: %s() failed to create pipe %s/%s (errno = %d)\n",
868 __FILE__, __func__, parent->d_name.name, name,
872 EXPORT_SYMBOL_GPL(rpc_mkpipe_dentry);
875 * rpc_unlink - remove a pipe
876 * @dentry: dentry for the pipe, as returned from rpc_mkpipe
878 * After this call, lookups will no longer find the pipe, and any
879 * attempts to read or write using preexisting opens of the pipe will
883 rpc_unlink(struct dentry *dentry)
885 struct dentry *parent;
889 parent = dget_parent(dentry);
890 dir = parent->d_inode;
891 mutex_lock_nested(&dir->i_mutex, I_MUTEX_PARENT);
892 error = __rpc_rmpipe(dir, dentry);
893 mutex_unlock(&dir->i_mutex);
897 EXPORT_SYMBOL_GPL(rpc_unlink);
904 static const struct rpc_filelist authfiles[] = {
907 .i_fop = &rpc_info_operations,
908 .mode = S_IFREG | S_IRUSR,
912 static int rpc_clntdir_populate(struct dentry *dentry, void *private)
914 return rpc_populate(dentry,
915 authfiles, RPCAUTH_info, RPCAUTH_EOF,
919 static void rpc_clntdir_depopulate(struct dentry *dentry)
921 rpc_depopulate(dentry, authfiles, RPCAUTH_info, RPCAUTH_EOF);
925 * rpc_create_client_dir - Create a new rpc_client directory in rpc_pipefs
926 * @dentry: dentry from the rpc_pipefs root to the new directory
927 * @name: &struct qstr for the name
928 * @rpc_client: rpc client to associate with this directory
930 * This creates a directory at the given @path associated with
931 * @rpc_clnt, which will contain a file named "info" with some basic
932 * information about the client, together with any "pipes" that may
933 * later be created using rpc_mkpipe().
935 struct dentry *rpc_create_client_dir(struct dentry *dentry,
937 struct rpc_clnt *rpc_client)
939 return rpc_mkdir_populate(dentry, name, S_IRUGO | S_IXUGO, NULL,
940 rpc_clntdir_populate, rpc_client);
944 * rpc_remove_client_dir - Remove a directory created with rpc_create_client_dir()
947 int rpc_remove_client_dir(struct dentry *dentry)
949 return rpc_rmdir_depopulate(dentry, rpc_clntdir_depopulate);
952 static const struct rpc_filelist cache_pipefs_files[3] = {
955 .i_fop = &cache_file_operations_pipefs,
956 .mode = S_IFREG|S_IRUSR|S_IWUSR,
960 .i_fop = &content_file_operations_pipefs,
961 .mode = S_IFREG|S_IRUSR,
965 .i_fop = &cache_flush_operations_pipefs,
966 .mode = S_IFREG|S_IRUSR|S_IWUSR,
970 static int rpc_cachedir_populate(struct dentry *dentry, void *private)
972 return rpc_populate(dentry,
973 cache_pipefs_files, 0, 3,
977 static void rpc_cachedir_depopulate(struct dentry *dentry)
979 rpc_depopulate(dentry, cache_pipefs_files, 0, 3);
982 struct dentry *rpc_create_cache_dir(struct dentry *parent, struct qstr *name,
983 umode_t umode, struct cache_detail *cd)
985 return rpc_mkdir_populate(parent, name, umode, NULL,
986 rpc_cachedir_populate, cd);
989 void rpc_remove_cache_dir(struct dentry *dentry)
991 rpc_rmdir_depopulate(dentry, rpc_cachedir_depopulate);
995 * populate the filesystem
997 static const struct super_operations s_ops = {
998 .alloc_inode = rpc_alloc_inode,
999 .destroy_inode = rpc_destroy_inode,
1000 .statfs = simple_statfs,
1003 #define RPCAUTH_GSSMAGIC 0x67596969
1006 * We have a single directory with 1 node in it.
1019 static const struct rpc_filelist files[] = {
1022 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
1026 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
1030 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
1032 [RPCAUTH_portmap] = {
1034 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
1038 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
1040 [RPCAUTH_nfsd4_cb] = {
1042 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
1046 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
1051 * This call can be used only in RPC pipefs mount notification hooks.
1053 struct dentry *rpc_d_lookup_sb(const struct super_block *sb,
1054 const unsigned char *dir_name)
1058 .len = strlen(dir_name),
1059 .hash = full_name_hash(dir_name, strlen(dir_name)),
1062 return d_lookup(sb->s_root, &dir);
1064 EXPORT_SYMBOL_GPL(rpc_d_lookup_sb);
1066 void rpc_pipefs_init_net(struct net *net)
1068 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
1070 mutex_init(&sn->pipefs_sb_lock);
1074 * This call will be used for per network namespace operations calls.
1075 * Note: Function will be returned with pipefs_sb_lock taken if superblock was
1076 * found. This lock have to be released by rpc_put_sb_net() when all operations
1077 * will be completed.
1079 struct super_block *rpc_get_sb_net(const struct net *net)
1081 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
1083 mutex_lock(&sn->pipefs_sb_lock);
1085 return sn->pipefs_sb;
1086 mutex_unlock(&sn->pipefs_sb_lock);
1089 EXPORT_SYMBOL_GPL(rpc_get_sb_net);
1091 void rpc_put_sb_net(const struct net *net)
1093 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
1095 BUG_ON(sn->pipefs_sb == NULL);
1096 mutex_unlock(&sn->pipefs_sb_lock);
1098 EXPORT_SYMBOL_GPL(rpc_put_sb_net);
1101 rpc_fill_super(struct super_block *sb, void *data, int silent)
1103 struct inode *inode;
1104 struct dentry *root;
1105 struct net *net = data;
1106 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
1109 sb->s_blocksize = PAGE_CACHE_SIZE;
1110 sb->s_blocksize_bits = PAGE_CACHE_SHIFT;
1111 sb->s_magic = RPCAUTH_GSSMAGIC;
1113 sb->s_time_gran = 1;
1115 inode = rpc_get_inode(sb, S_IFDIR | 0755);
1118 sb->s_root = root = d_alloc_root(inode);
1123 if (rpc_populate(root, files, RPCAUTH_lockd, RPCAUTH_RootEOF, NULL))
1125 dprintk("RPC: sending pipefs MOUNT notification for net %p%s\n", net,
1127 err = blocking_notifier_call_chain(&rpc_pipefs_notifier_list,
1131 goto err_depopulate;
1132 sb->s_fs_info = get_net(net);
1137 blocking_notifier_call_chain(&rpc_pipefs_notifier_list,
1140 __rpc_depopulate(root, files, RPCAUTH_lockd, RPCAUTH_RootEOF);
1144 static struct dentry *
1145 rpc_mount(struct file_system_type *fs_type,
1146 int flags, const char *dev_name, void *data)
1148 return mount_ns(fs_type, flags, current->nsproxy->net_ns, rpc_fill_super);
1151 void rpc_kill_sb(struct super_block *sb)
1153 struct net *net = sb->s_fs_info;
1154 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
1156 mutex_lock(&sn->pipefs_sb_lock);
1157 sn->pipefs_sb = NULL;
1158 mutex_unlock(&sn->pipefs_sb_lock);
1160 dprintk("RPC: sending pipefs UMOUNT notification for net %p%s\n", net,
1162 blocking_notifier_call_chain(&rpc_pipefs_notifier_list,
1165 kill_litter_super(sb);
1168 static struct file_system_type rpc_pipe_fs_type = {
1169 .owner = THIS_MODULE,
1170 .name = "rpc_pipefs",
1172 .kill_sb = rpc_kill_sb,
1176 init_once(void *foo)
1178 struct rpc_inode *rpci = (struct rpc_inode *) foo;
1180 inode_init_once(&rpci->vfs_inode);
1181 rpci->private = NULL;
1183 init_waitqueue_head(&rpci->waitq);
1186 int register_rpc_pipefs(void)
1190 rpc_inode_cachep = kmem_cache_create("rpc_inode_cache",
1191 sizeof(struct rpc_inode),
1192 0, (SLAB_HWCACHE_ALIGN|SLAB_RECLAIM_ACCOUNT|
1195 if (!rpc_inode_cachep)
1197 err = rpc_clients_notifier_register();
1200 err = register_filesystem(&rpc_pipe_fs_type);
1206 rpc_clients_notifier_unregister();
1208 kmem_cache_destroy(rpc_inode_cachep);
1212 void unregister_rpc_pipefs(void)
1214 rpc_clients_notifier_unregister();
1215 kmem_cache_destroy(rpc_inode_cachep);
1216 unregister_filesystem(&rpc_pipe_fs_type);
1219 /* Make 'mount -t rpc_pipefs ...' autoload this module. */
1220 MODULE_ALIAS("rpc_pipefs");