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 __poll_t mask
= EPOLLOUT
| EPOLLWRNORM
;
350 poll_wait(filp
, &rpci
->waitq
, wait
);
353 if (rpci
->pipe
== NULL
)
354 mask
|= EPOLLERR
| EPOLLHUP
;
355 else if (filp
->private_data
|| !list_empty(&rpci
->pipe
->pipe
))
356 mask
|= EPOLLIN
| EPOLLRDNORM
;
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(inode
);
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 static int __rpc_unlink(struct inode
*dir
, struct dentry
*dentry
)
617 ret
= simple_unlink(dir
, dentry
);
623 static int __rpc_rmpipe(struct inode
*dir
, struct dentry
*dentry
)
625 struct inode
*inode
= d_inode(dentry
);
627 rpc_close_pipes(inode
);
628 return __rpc_unlink(dir
, dentry
);
631 static struct dentry
*__rpc_lookup_create_exclusive(struct dentry
*parent
,
634 struct qstr q
= QSTR_INIT(name
, strlen(name
));
635 struct dentry
*dentry
= d_hash_and_lookup(parent
, &q
);
637 dentry
= d_alloc(parent
, &q
);
639 return ERR_PTR(-ENOMEM
);
641 if (d_really_is_negative(dentry
))
644 return ERR_PTR(-EEXIST
);
648 * FIXME: This probably has races.
650 static void __rpc_depopulate(struct dentry
*parent
,
651 const struct rpc_filelist
*files
,
654 struct inode
*dir
= d_inode(parent
);
655 struct dentry
*dentry
;
659 for (i
= start
; i
< eof
; i
++) {
660 name
.name
= files
[i
].name
;
661 name
.len
= strlen(files
[i
].name
);
662 dentry
= d_hash_and_lookup(parent
, &name
);
666 if (d_really_is_negative(dentry
))
668 switch (d_inode(dentry
)->i_mode
& S_IFMT
) {
672 __rpc_unlink(dir
, dentry
);
675 __rpc_rmdir(dir
, dentry
);
682 static void rpc_depopulate(struct dentry
*parent
,
683 const struct rpc_filelist
*files
,
686 struct inode
*dir
= d_inode(parent
);
688 inode_lock_nested(dir
, I_MUTEX_CHILD
);
689 __rpc_depopulate(parent
, files
, start
, eof
);
693 static int rpc_populate(struct dentry
*parent
,
694 const struct rpc_filelist
*files
,
698 struct inode
*dir
= d_inode(parent
);
699 struct dentry
*dentry
;
703 for (i
= start
; i
< eof
; i
++) {
704 dentry
= __rpc_lookup_create_exclusive(parent
, files
[i
].name
);
705 err
= PTR_ERR(dentry
);
708 switch (files
[i
].mode
& S_IFMT
) {
712 err
= __rpc_create(dir
, dentry
,
718 err
= __rpc_mkdir(dir
, dentry
,
729 __rpc_depopulate(parent
, files
, start
, eof
);
731 printk(KERN_WARNING
"%s: %s failed to populate directory %pd\n",
732 __FILE__
, __func__
, parent
);
736 static struct dentry
*rpc_mkdir_populate(struct dentry
*parent
,
737 const char *name
, umode_t mode
, void *private,
738 int (*populate
)(struct dentry
*, void *), void *args_populate
)
740 struct dentry
*dentry
;
741 struct inode
*dir
= d_inode(parent
);
744 inode_lock_nested(dir
, I_MUTEX_PARENT
);
745 dentry
= __rpc_lookup_create_exclusive(parent
, name
);
748 error
= __rpc_mkdir(dir
, dentry
, mode
, NULL
, private);
751 if (populate
!= NULL
) {
752 error
= populate(dentry
, args_populate
);
760 __rpc_rmdir(dir
, dentry
);
762 dentry
= ERR_PTR(error
);
766 static int rpc_rmdir_depopulate(struct dentry
*dentry
,
767 void (*depopulate
)(struct dentry
*))
769 struct dentry
*parent
;
773 parent
= dget_parent(dentry
);
774 dir
= d_inode(parent
);
775 inode_lock_nested(dir
, I_MUTEX_PARENT
);
776 if (depopulate
!= NULL
)
778 error
= __rpc_rmdir(dir
, dentry
);
785 * rpc_mkpipe - make an rpc_pipefs file for kernel<->userspace communication
786 * @parent: dentry of directory to create new "pipe" in
787 * @name: name of pipe
788 * @private: private data to associate with the pipe, for the caller's use
789 * @pipe: &rpc_pipe containing input parameters
791 * Data is made available for userspace to read by calls to
792 * rpc_queue_upcall(). The actual reads will result in calls to
793 * @ops->upcall, which will be called with the file pointer,
794 * message, and userspace buffer to copy to.
796 * Writes can come at any time, and do not necessarily have to be
797 * responses to upcalls. They will result in calls to @msg->downcall.
799 * The @private argument passed here will be available to all these methods
800 * from the file pointer, via RPC_I(file_inode(file))->private.
802 struct dentry
*rpc_mkpipe_dentry(struct dentry
*parent
, const char *name
,
803 void *private, struct rpc_pipe
*pipe
)
805 struct dentry
*dentry
;
806 struct inode
*dir
= d_inode(parent
);
807 umode_t umode
= S_IFIFO
| 0600;
810 if (pipe
->ops
->upcall
== NULL
)
812 if (pipe
->ops
->downcall
== NULL
)
815 inode_lock_nested(dir
, I_MUTEX_PARENT
);
816 dentry
= __rpc_lookup_create_exclusive(parent
, name
);
819 err
= __rpc_mkpipe_dentry(dir
, dentry
, umode
, &rpc_pipe_fops
,
827 dentry
= ERR_PTR(err
);
828 printk(KERN_WARNING
"%s: %s() failed to create pipe %pd/%s (errno = %d)\n",
829 __FILE__
, __func__
, parent
, name
,
833 EXPORT_SYMBOL_GPL(rpc_mkpipe_dentry
);
836 * rpc_unlink - remove a pipe
837 * @dentry: dentry for the pipe, as returned from rpc_mkpipe
839 * After this call, lookups will no longer find the pipe, and any
840 * attempts to read or write using preexisting opens of the pipe will
844 rpc_unlink(struct dentry
*dentry
)
846 struct dentry
*parent
;
850 parent
= dget_parent(dentry
);
851 dir
= d_inode(parent
);
852 inode_lock_nested(dir
, I_MUTEX_PARENT
);
853 error
= __rpc_rmpipe(dir
, dentry
);
858 EXPORT_SYMBOL_GPL(rpc_unlink
);
861 * rpc_init_pipe_dir_head - initialise a struct rpc_pipe_dir_head
862 * @pdh: pointer to struct rpc_pipe_dir_head
864 void rpc_init_pipe_dir_head(struct rpc_pipe_dir_head
*pdh
)
866 INIT_LIST_HEAD(&pdh
->pdh_entries
);
867 pdh
->pdh_dentry
= NULL
;
869 EXPORT_SYMBOL_GPL(rpc_init_pipe_dir_head
);
872 * rpc_init_pipe_dir_object - initialise a struct rpc_pipe_dir_object
873 * @pdo: pointer to struct rpc_pipe_dir_object
874 * @pdo_ops: pointer to const struct rpc_pipe_dir_object_ops
875 * @pdo_data: pointer to caller-defined data
877 void rpc_init_pipe_dir_object(struct rpc_pipe_dir_object
*pdo
,
878 const struct rpc_pipe_dir_object_ops
*pdo_ops
,
881 INIT_LIST_HEAD(&pdo
->pdo_head
);
882 pdo
->pdo_ops
= pdo_ops
;
883 pdo
->pdo_data
= pdo_data
;
885 EXPORT_SYMBOL_GPL(rpc_init_pipe_dir_object
);
888 rpc_add_pipe_dir_object_locked(struct net
*net
,
889 struct rpc_pipe_dir_head
*pdh
,
890 struct rpc_pipe_dir_object
*pdo
)
895 ret
= pdo
->pdo_ops
->create(pdh
->pdh_dentry
, pdo
);
897 list_add_tail(&pdo
->pdo_head
, &pdh
->pdh_entries
);
902 rpc_remove_pipe_dir_object_locked(struct net
*net
,
903 struct rpc_pipe_dir_head
*pdh
,
904 struct rpc_pipe_dir_object
*pdo
)
907 pdo
->pdo_ops
->destroy(pdh
->pdh_dentry
, pdo
);
908 list_del_init(&pdo
->pdo_head
);
912 * rpc_add_pipe_dir_object - associate a rpc_pipe_dir_object to a directory
913 * @net: pointer to struct net
914 * @pdh: pointer to struct rpc_pipe_dir_head
915 * @pdo: pointer to struct rpc_pipe_dir_object
919 rpc_add_pipe_dir_object(struct net
*net
,
920 struct rpc_pipe_dir_head
*pdh
,
921 struct rpc_pipe_dir_object
*pdo
)
925 if (list_empty(&pdo
->pdo_head
)) {
926 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
928 mutex_lock(&sn
->pipefs_sb_lock
);
929 ret
= rpc_add_pipe_dir_object_locked(net
, pdh
, pdo
);
930 mutex_unlock(&sn
->pipefs_sb_lock
);
934 EXPORT_SYMBOL_GPL(rpc_add_pipe_dir_object
);
937 * rpc_remove_pipe_dir_object - remove a rpc_pipe_dir_object from a directory
938 * @net: pointer to struct net
939 * @pdh: pointer to struct rpc_pipe_dir_head
940 * @pdo: pointer to struct rpc_pipe_dir_object
944 rpc_remove_pipe_dir_object(struct net
*net
,
945 struct rpc_pipe_dir_head
*pdh
,
946 struct rpc_pipe_dir_object
*pdo
)
948 if (!list_empty(&pdo
->pdo_head
)) {
949 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
951 mutex_lock(&sn
->pipefs_sb_lock
);
952 rpc_remove_pipe_dir_object_locked(net
, pdh
, pdo
);
953 mutex_unlock(&sn
->pipefs_sb_lock
);
956 EXPORT_SYMBOL_GPL(rpc_remove_pipe_dir_object
);
959 * rpc_find_or_alloc_pipe_dir_object
960 * @net: pointer to struct net
961 * @pdh: pointer to struct rpc_pipe_dir_head
962 * @match: match struct rpc_pipe_dir_object to data
963 * @alloc: allocate a new struct rpc_pipe_dir_object
964 * @data: user defined data for match() and alloc()
967 struct rpc_pipe_dir_object
*
968 rpc_find_or_alloc_pipe_dir_object(struct net
*net
,
969 struct rpc_pipe_dir_head
*pdh
,
970 int (*match
)(struct rpc_pipe_dir_object
*, void *),
971 struct rpc_pipe_dir_object
*(*alloc
)(void *),
974 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
975 struct rpc_pipe_dir_object
*pdo
;
977 mutex_lock(&sn
->pipefs_sb_lock
);
978 list_for_each_entry(pdo
, &pdh
->pdh_entries
, pdo_head
) {
979 if (!match(pdo
, data
))
986 rpc_add_pipe_dir_object_locked(net
, pdh
, pdo
);
988 mutex_unlock(&sn
->pipefs_sb_lock
);
991 EXPORT_SYMBOL_GPL(rpc_find_or_alloc_pipe_dir_object
);
994 rpc_create_pipe_dir_objects(struct rpc_pipe_dir_head
*pdh
)
996 struct rpc_pipe_dir_object
*pdo
;
997 struct dentry
*dir
= pdh
->pdh_dentry
;
999 list_for_each_entry(pdo
, &pdh
->pdh_entries
, pdo_head
)
1000 pdo
->pdo_ops
->create(dir
, pdo
);
1004 rpc_destroy_pipe_dir_objects(struct rpc_pipe_dir_head
*pdh
)
1006 struct rpc_pipe_dir_object
*pdo
;
1007 struct dentry
*dir
= pdh
->pdh_dentry
;
1009 list_for_each_entry(pdo
, &pdh
->pdh_entries
, pdo_head
)
1010 pdo
->pdo_ops
->destroy(dir
, pdo
);
1018 static const struct rpc_filelist authfiles
[] = {
1021 .i_fop
= &rpc_info_operations
,
1022 .mode
= S_IFREG
| 0400,
1026 static int rpc_clntdir_populate(struct dentry
*dentry
, void *private)
1028 return rpc_populate(dentry
,
1029 authfiles
, RPCAUTH_info
, RPCAUTH_EOF
,
1033 static void rpc_clntdir_depopulate(struct dentry
*dentry
)
1035 rpc_depopulate(dentry
, authfiles
, RPCAUTH_info
, RPCAUTH_EOF
);
1039 * rpc_create_client_dir - Create a new rpc_client directory in rpc_pipefs
1040 * @dentry: the parent of new directory
1041 * @name: the name of new directory
1042 * @rpc_client: rpc client to associate with this directory
1044 * This creates a directory at the given @path associated with
1045 * @rpc_clnt, which will contain a file named "info" with some basic
1046 * information about the client, together with any "pipes" that may
1047 * later be created using rpc_mkpipe().
1049 struct dentry
*rpc_create_client_dir(struct dentry
*dentry
,
1051 struct rpc_clnt
*rpc_client
)
1055 ret
= rpc_mkdir_populate(dentry
, name
, 0555, NULL
,
1056 rpc_clntdir_populate
, rpc_client
);
1058 rpc_client
->cl_pipedir_objects
.pdh_dentry
= ret
;
1059 rpc_create_pipe_dir_objects(&rpc_client
->cl_pipedir_objects
);
1065 * rpc_remove_client_dir - Remove a directory created with rpc_create_client_dir()
1066 * @rpc_client: rpc_client for the pipe
1068 int rpc_remove_client_dir(struct rpc_clnt
*rpc_client
)
1070 struct dentry
*dentry
= rpc_client
->cl_pipedir_objects
.pdh_dentry
;
1074 rpc_destroy_pipe_dir_objects(&rpc_client
->cl_pipedir_objects
);
1075 rpc_client
->cl_pipedir_objects
.pdh_dentry
= NULL
;
1076 return rpc_rmdir_depopulate(dentry
, rpc_clntdir_depopulate
);
1079 static const struct rpc_filelist cache_pipefs_files
[3] = {
1082 .i_fop
= &cache_file_operations_pipefs
,
1083 .mode
= S_IFREG
| 0600,
1087 .i_fop
= &content_file_operations_pipefs
,
1088 .mode
= S_IFREG
| 0400,
1092 .i_fop
= &cache_flush_operations_pipefs
,
1093 .mode
= S_IFREG
| 0600,
1097 static int rpc_cachedir_populate(struct dentry
*dentry
, void *private)
1099 return rpc_populate(dentry
,
1100 cache_pipefs_files
, 0, 3,
1104 static void rpc_cachedir_depopulate(struct dentry
*dentry
)
1106 rpc_depopulate(dentry
, cache_pipefs_files
, 0, 3);
1109 struct dentry
*rpc_create_cache_dir(struct dentry
*parent
, const char *name
,
1110 umode_t umode
, struct cache_detail
*cd
)
1112 return rpc_mkdir_populate(parent
, name
, umode
, NULL
,
1113 rpc_cachedir_populate
, cd
);
1116 void rpc_remove_cache_dir(struct dentry
*dentry
)
1118 rpc_rmdir_depopulate(dentry
, rpc_cachedir_depopulate
);
1122 * populate the filesystem
1124 static const struct super_operations s_ops
= {
1125 .alloc_inode
= rpc_alloc_inode
,
1126 .destroy_inode
= rpc_destroy_inode
,
1127 .statfs
= simple_statfs
,
1130 #define RPCAUTH_GSSMAGIC 0x67596969
1133 * We have a single directory with 1 node in it.
1148 static const struct rpc_filelist files
[] = {
1151 .mode
= S_IFDIR
| 0555,
1155 .mode
= S_IFDIR
| 0555,
1159 .mode
= S_IFDIR
| 0555,
1161 [RPCAUTH_portmap
] = {
1163 .mode
= S_IFDIR
| 0555,
1167 .mode
= S_IFDIR
| 0555,
1169 [RPCAUTH_nfsd4_cb
] = {
1171 .mode
= S_IFDIR
| 0555,
1175 .mode
= S_IFDIR
| 0555,
1179 .mode
= S_IFDIR
| 0555,
1183 .mode
= S_IFDIR
| 0555,
1188 * This call can be used only in RPC pipefs mount notification hooks.
1190 struct dentry
*rpc_d_lookup_sb(const struct super_block
*sb
,
1191 const unsigned char *dir_name
)
1193 struct qstr dir
= QSTR_INIT(dir_name
, strlen(dir_name
));
1194 return d_hash_and_lookup(sb
->s_root
, &dir
);
1196 EXPORT_SYMBOL_GPL(rpc_d_lookup_sb
);
1198 int rpc_pipefs_init_net(struct net
*net
)
1200 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
1202 sn
->gssd_dummy
= rpc_mkpipe_data(&gssd_dummy_pipe_ops
, 0);
1203 if (IS_ERR(sn
->gssd_dummy
))
1204 return PTR_ERR(sn
->gssd_dummy
);
1206 mutex_init(&sn
->pipefs_sb_lock
);
1207 sn
->pipe_version
= -1;
1211 void rpc_pipefs_exit_net(struct net
*net
)
1213 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
1215 rpc_destroy_pipe_data(sn
->gssd_dummy
);
1219 * This call will be used for per network namespace operations calls.
1220 * Note: Function will be returned with pipefs_sb_lock taken if superblock was
1221 * found. This lock have to be released by rpc_put_sb_net() when all operations
1222 * will be completed.
1224 struct super_block
*rpc_get_sb_net(const struct net
*net
)
1226 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
1228 mutex_lock(&sn
->pipefs_sb_lock
);
1230 return sn
->pipefs_sb
;
1231 mutex_unlock(&sn
->pipefs_sb_lock
);
1234 EXPORT_SYMBOL_GPL(rpc_get_sb_net
);
1236 void rpc_put_sb_net(const struct net
*net
)
1238 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
1240 WARN_ON(sn
->pipefs_sb
== NULL
);
1241 mutex_unlock(&sn
->pipefs_sb_lock
);
1243 EXPORT_SYMBOL_GPL(rpc_put_sb_net
);
1245 static const struct rpc_filelist gssd_dummy_clnt_dir
[] = {
1248 .mode
= S_IFDIR
| 0555,
1253 dummy_downcall(struct file
*filp
, const char __user
*src
, size_t len
)
1258 static const struct rpc_pipe_ops gssd_dummy_pipe_ops
= {
1259 .upcall
= rpc_pipe_generic_upcall
,
1260 .downcall
= dummy_downcall
,
1264 * Here we present a bogus "info" file to keep rpc.gssd happy. We don't expect
1265 * that it will ever use this info to handle an upcall, but rpc.gssd expects
1266 * that this file will be there and have a certain format.
1269 rpc_show_dummy_info(struct seq_file
*m
, void *v
)
1271 seq_printf(m
, "RPC server: %s\n", utsname()->nodename
);
1272 seq_printf(m
, "service: foo (1) version 0\n");
1273 seq_printf(m
, "address: 127.0.0.1\n");
1274 seq_printf(m
, "protocol: tcp\n");
1275 seq_printf(m
, "port: 0\n");
1280 rpc_dummy_info_open(struct inode
*inode
, struct file
*file
)
1282 return single_open(file
, rpc_show_dummy_info
, NULL
);
1285 static const struct file_operations rpc_dummy_info_operations
= {
1286 .owner
= THIS_MODULE
,
1287 .open
= rpc_dummy_info_open
,
1289 .llseek
= seq_lseek
,
1290 .release
= single_release
,
1293 static const struct rpc_filelist gssd_dummy_info_file
[] = {
1296 .i_fop
= &rpc_dummy_info_operations
,
1297 .mode
= S_IFREG
| 0400,
1302 * rpc_gssd_dummy_populate - create a dummy gssd pipe
1303 * @root: root of the rpc_pipefs filesystem
1304 * @pipe_data: pipe data created when netns is initialized
1306 * Create a dummy set of directories and a pipe that gssd can hold open to
1307 * indicate that it is up and running.
1309 static struct dentry
*
1310 rpc_gssd_dummy_populate(struct dentry
*root
, struct rpc_pipe
*pipe_data
)
1313 struct dentry
*gssd_dentry
;
1314 struct dentry
*clnt_dentry
= NULL
;
1315 struct dentry
*pipe_dentry
= NULL
;
1316 struct qstr q
= QSTR_INIT(files
[RPCAUTH_gssd
].name
,
1317 strlen(files
[RPCAUTH_gssd
].name
));
1319 /* We should never get this far if "gssd" doesn't exist */
1320 gssd_dentry
= d_hash_and_lookup(root
, &q
);
1322 return ERR_PTR(-ENOENT
);
1324 ret
= rpc_populate(gssd_dentry
, gssd_dummy_clnt_dir
, 0, 1, NULL
);
1326 pipe_dentry
= ERR_PTR(ret
);
1330 q
.name
= gssd_dummy_clnt_dir
[0].name
;
1331 q
.len
= strlen(gssd_dummy_clnt_dir
[0].name
);
1332 clnt_dentry
= d_hash_and_lookup(gssd_dentry
, &q
);
1334 pipe_dentry
= ERR_PTR(-ENOENT
);
1338 ret
= rpc_populate(clnt_dentry
, gssd_dummy_info_file
, 0, 1, NULL
);
1340 __rpc_depopulate(gssd_dentry
, gssd_dummy_clnt_dir
, 0, 1);
1341 pipe_dentry
= ERR_PTR(ret
);
1345 pipe_dentry
= rpc_mkpipe_dentry(clnt_dentry
, "gssd", NULL
, pipe_data
);
1346 if (IS_ERR(pipe_dentry
)) {
1347 __rpc_depopulate(clnt_dentry
, gssd_dummy_info_file
, 0, 1);
1348 __rpc_depopulate(gssd_dentry
, gssd_dummy_clnt_dir
, 0, 1);
1357 rpc_gssd_dummy_depopulate(struct dentry
*pipe_dentry
)
1359 struct dentry
*clnt_dir
= pipe_dentry
->d_parent
;
1360 struct dentry
*gssd_dir
= clnt_dir
->d_parent
;
1363 __rpc_rmpipe(d_inode(clnt_dir
), pipe_dentry
);
1364 __rpc_depopulate(clnt_dir
, gssd_dummy_info_file
, 0, 1);
1365 __rpc_depopulate(gssd_dir
, gssd_dummy_clnt_dir
, 0, 1);
1370 rpc_fill_super(struct super_block
*sb
, void *data
, int silent
)
1372 struct inode
*inode
;
1373 struct dentry
*root
, *gssd_dentry
;
1374 struct net
*net
= get_net(sb
->s_fs_info
);
1375 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
1378 sb
->s_blocksize
= PAGE_SIZE
;
1379 sb
->s_blocksize_bits
= PAGE_SHIFT
;
1380 sb
->s_magic
= RPCAUTH_GSSMAGIC
;
1382 sb
->s_d_op
= &simple_dentry_operations
;
1383 sb
->s_time_gran
= 1;
1385 inode
= rpc_get_inode(sb
, S_IFDIR
| 0555);
1386 sb
->s_root
= root
= d_make_root(inode
);
1389 if (rpc_populate(root
, files
, RPCAUTH_lockd
, RPCAUTH_RootEOF
, NULL
))
1392 gssd_dentry
= rpc_gssd_dummy_populate(root
, sn
->gssd_dummy
);
1393 if (IS_ERR(gssd_dentry
)) {
1394 __rpc_depopulate(root
, files
, RPCAUTH_lockd
, RPCAUTH_RootEOF
);
1395 return PTR_ERR(gssd_dentry
);
1398 dprintk("RPC: sending pipefs MOUNT notification for net %x%s\n",
1399 net
->ns
.inum
, NET_NAME(net
));
1400 mutex_lock(&sn
->pipefs_sb_lock
);
1402 err
= blocking_notifier_call_chain(&rpc_pipefs_notifier_list
,
1406 goto err_depopulate
;
1407 mutex_unlock(&sn
->pipefs_sb_lock
);
1411 rpc_gssd_dummy_depopulate(gssd_dentry
);
1412 blocking_notifier_call_chain(&rpc_pipefs_notifier_list
,
1415 sn
->pipefs_sb
= NULL
;
1416 __rpc_depopulate(root
, files
, RPCAUTH_lockd
, RPCAUTH_RootEOF
);
1417 mutex_unlock(&sn
->pipefs_sb_lock
);
1422 gssd_running(struct net
*net
)
1424 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
1425 struct rpc_pipe
*pipe
= sn
->gssd_dummy
;
1427 return pipe
->nreaders
|| pipe
->nwriters
;
1429 EXPORT_SYMBOL_GPL(gssd_running
);
1431 static struct dentry
*
1432 rpc_mount(struct file_system_type
*fs_type
,
1433 int flags
, const char *dev_name
, void *data
)
1435 struct net
*net
= current
->nsproxy
->net_ns
;
1436 return mount_ns(fs_type
, flags
, data
, net
, net
->user_ns
, rpc_fill_super
);
1439 static void rpc_kill_sb(struct super_block
*sb
)
1441 struct net
*net
= sb
->s_fs_info
;
1442 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
1444 mutex_lock(&sn
->pipefs_sb_lock
);
1445 if (sn
->pipefs_sb
!= sb
) {
1446 mutex_unlock(&sn
->pipefs_sb_lock
);
1449 sn
->pipefs_sb
= NULL
;
1450 dprintk("RPC: sending pipefs UMOUNT notification for net %x%s\n",
1451 net
->ns
.inum
, NET_NAME(net
));
1452 blocking_notifier_call_chain(&rpc_pipefs_notifier_list
,
1455 mutex_unlock(&sn
->pipefs_sb_lock
);
1457 kill_litter_super(sb
);
1461 static struct file_system_type rpc_pipe_fs_type
= {
1462 .owner
= THIS_MODULE
,
1463 .name
= "rpc_pipefs",
1465 .kill_sb
= rpc_kill_sb
,
1467 MODULE_ALIAS_FS("rpc_pipefs");
1468 MODULE_ALIAS("rpc_pipefs");
1471 init_once(void *foo
)
1473 struct rpc_inode
*rpci
= (struct rpc_inode
*) foo
;
1475 inode_init_once(&rpci
->vfs_inode
);
1476 rpci
->private = NULL
;
1478 init_waitqueue_head(&rpci
->waitq
);
1481 int register_rpc_pipefs(void)
1485 rpc_inode_cachep
= kmem_cache_create("rpc_inode_cache",
1486 sizeof(struct rpc_inode
),
1487 0, (SLAB_HWCACHE_ALIGN
|SLAB_RECLAIM_ACCOUNT
|
1488 SLAB_MEM_SPREAD
|SLAB_ACCOUNT
),
1490 if (!rpc_inode_cachep
)
1492 err
= rpc_clients_notifier_register();
1495 err
= register_filesystem(&rpc_pipe_fs_type
);
1501 rpc_clients_notifier_unregister();
1503 kmem_cache_destroy(rpc_inode_cachep
);
1507 void unregister_rpc_pipefs(void)
1509 rpc_clients_notifier_unregister();
1510 kmem_cache_destroy(rpc_inode_cachep
);
1511 unregister_filesystem(&rpc_pipe_fs_type
);