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
));
80 rpc_timeout_upcall_queue(struct work_struct
*work
)
83 struct rpc_pipe
*pipe
=
84 container_of(work
, struct rpc_pipe
, queue_timeout
.work
);
85 void (*destroy_msg
)(struct rpc_pipe_msg
*);
86 struct dentry
*dentry
;
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 dentry
= dget(pipe
->dentry
);
95 spin_unlock(&pipe
->lock
);
96 rpc_purge_list(dentry
? &RPC_I(dentry
->d_inode
)->waitq
: NULL
,
97 &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 * @pipe: 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
= file_inode(filp
);
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
= file_inode(filp
);
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
= file_inode(filp
);
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
= file_inode(filp
);
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",
408 rcu_dereference(clnt
->cl_xprt
)->servername
);
409 seq_printf(m
, "service: %s (%d) version %d\n", clnt
->cl_protname
,
410 clnt
->cl_prog
, clnt
->cl_vers
);
411 seq_printf(m
, "address: %s\n", rpc_peeraddr2str(clnt
, RPC_DISPLAY_ADDR
));
412 seq_printf(m
, "protocol: %s\n", rpc_peeraddr2str(clnt
, RPC_DISPLAY_PROTO
));
413 seq_printf(m
, "port: %s\n", rpc_peeraddr2str(clnt
, RPC_DISPLAY_PORT
));
419 rpc_info_open(struct inode
*inode
, struct file
*file
)
421 struct rpc_clnt
*clnt
= NULL
;
422 int ret
= single_open(file
, rpc_show_info
, NULL
);
425 struct seq_file
*m
= file
->private_data
;
427 spin_lock(&file
->f_path
.dentry
->d_lock
);
428 if (!d_unhashed(file
->f_path
.dentry
))
429 clnt
= RPC_I(inode
)->private;
430 if (clnt
!= NULL
&& atomic_inc_not_zero(&clnt
->cl_count
)) {
431 spin_unlock(&file
->f_path
.dentry
->d_lock
);
434 spin_unlock(&file
->f_path
.dentry
->d_lock
);
435 single_release(inode
, file
);
443 rpc_info_release(struct inode
*inode
, struct file
*file
)
445 struct seq_file
*m
= file
->private_data
;
446 struct rpc_clnt
*clnt
= (struct rpc_clnt
*)m
->private;
449 rpc_release_client(clnt
);
450 return single_release(inode
, file
);
453 static const struct file_operations rpc_info_operations
= {
454 .owner
= THIS_MODULE
,
455 .open
= rpc_info_open
,
458 .release
= rpc_info_release
,
463 * Description of fs contents.
465 struct rpc_filelist
{
467 const struct file_operations
*i_fop
;
471 static int rpc_delete_dentry(const struct dentry
*dentry
)
476 static const struct dentry_operations rpc_dentry_operations
= {
477 .d_delete
= rpc_delete_dentry
,
480 static struct inode
*
481 rpc_get_inode(struct super_block
*sb
, umode_t mode
)
483 struct inode
*inode
= new_inode(sb
);
486 inode
->i_ino
= get_next_ino();
487 inode
->i_mode
= mode
;
488 inode
->i_atime
= inode
->i_mtime
= inode
->i_ctime
= CURRENT_TIME
;
489 switch (mode
& S_IFMT
) {
491 inode
->i_fop
= &simple_dir_operations
;
492 inode
->i_op
= &simple_dir_inode_operations
;
500 static int __rpc_create_common(struct inode
*dir
, struct dentry
*dentry
,
502 const struct file_operations
*i_fop
,
508 inode
= rpc_get_inode(dir
->i_sb
, mode
);
511 inode
->i_ino
= iunique(dir
->i_sb
, 100);
513 inode
->i_fop
= i_fop
;
515 rpc_inode_setowner(inode
, private);
516 d_add(dentry
, inode
);
519 printk(KERN_WARNING
"%s: %s failed to allocate inode for dentry %s\n",
520 __FILE__
, __func__
, dentry
->d_name
.name
);
525 static int __rpc_create(struct inode
*dir
, struct dentry
*dentry
,
527 const struct file_operations
*i_fop
,
532 err
= __rpc_create_common(dir
, dentry
, S_IFREG
| mode
, i_fop
, private);
535 fsnotify_create(dir
, dentry
);
539 static int __rpc_mkdir(struct inode
*dir
, struct dentry
*dentry
,
541 const struct file_operations
*i_fop
,
546 err
= __rpc_create_common(dir
, dentry
, S_IFDIR
| mode
, i_fop
, private);
550 fsnotify_mkdir(dir
, dentry
);
555 init_pipe(struct rpc_pipe
*pipe
)
559 INIT_LIST_HEAD(&pipe
->in_upcall
);
560 INIT_LIST_HEAD(&pipe
->in_downcall
);
561 INIT_LIST_HEAD(&pipe
->pipe
);
563 INIT_DELAYED_WORK(&pipe
->queue_timeout
,
564 rpc_timeout_upcall_queue
);
566 spin_lock_init(&pipe
->lock
);
570 void rpc_destroy_pipe_data(struct rpc_pipe
*pipe
)
574 EXPORT_SYMBOL_GPL(rpc_destroy_pipe_data
);
576 struct rpc_pipe
*rpc_mkpipe_data(const struct rpc_pipe_ops
*ops
, int flags
)
578 struct rpc_pipe
*pipe
;
580 pipe
= kzalloc(sizeof(struct rpc_pipe
), GFP_KERNEL
);
582 return ERR_PTR(-ENOMEM
);
588 EXPORT_SYMBOL_GPL(rpc_mkpipe_data
);
590 static int __rpc_mkpipe_dentry(struct inode
*dir
, struct dentry
*dentry
,
592 const struct file_operations
*i_fop
,
594 struct rpc_pipe
*pipe
)
596 struct rpc_inode
*rpci
;
599 err
= __rpc_create_common(dir
, dentry
, S_IFIFO
| mode
, i_fop
, private);
602 rpci
= RPC_I(dentry
->d_inode
);
603 rpci
->private = private;
605 fsnotify_create(dir
, dentry
);
609 static int __rpc_rmdir(struct inode
*dir
, struct dentry
*dentry
)
614 ret
= simple_rmdir(dir
, dentry
);
620 int rpc_rmdir(struct dentry
*dentry
)
622 struct dentry
*parent
;
626 parent
= dget_parent(dentry
);
627 dir
= parent
->d_inode
;
628 mutex_lock_nested(&dir
->i_mutex
, I_MUTEX_PARENT
);
629 error
= __rpc_rmdir(dir
, dentry
);
630 mutex_unlock(&dir
->i_mutex
);
634 EXPORT_SYMBOL_GPL(rpc_rmdir
);
636 static int __rpc_unlink(struct inode
*dir
, struct dentry
*dentry
)
641 ret
= simple_unlink(dir
, dentry
);
647 static int __rpc_rmpipe(struct inode
*dir
, struct dentry
*dentry
)
649 struct inode
*inode
= dentry
->d_inode
;
651 rpc_close_pipes(inode
);
652 return __rpc_unlink(dir
, dentry
);
655 static struct dentry
*__rpc_lookup_create_exclusive(struct dentry
*parent
,
658 struct dentry
*dentry
;
660 dentry
= d_lookup(parent
, name
);
662 dentry
= d_alloc(parent
, name
);
664 return ERR_PTR(-ENOMEM
);
666 if (dentry
->d_inode
== NULL
) {
667 d_set_d_op(dentry
, &rpc_dentry_operations
);
671 return ERR_PTR(-EEXIST
);
675 * FIXME: This probably has races.
677 static void __rpc_depopulate(struct dentry
*parent
,
678 const struct rpc_filelist
*files
,
681 struct inode
*dir
= parent
->d_inode
;
682 struct dentry
*dentry
;
686 for (i
= start
; i
< eof
; i
++) {
687 name
.name
= files
[i
].name
;
688 name
.len
= strlen(files
[i
].name
);
689 name
.hash
= full_name_hash(name
.name
, name
.len
);
690 dentry
= d_lookup(parent
, &name
);
694 if (dentry
->d_inode
== NULL
)
696 switch (dentry
->d_inode
->i_mode
& S_IFMT
) {
700 __rpc_unlink(dir
, dentry
);
703 __rpc_rmdir(dir
, dentry
);
710 static void rpc_depopulate(struct dentry
*parent
,
711 const struct rpc_filelist
*files
,
714 struct inode
*dir
= parent
->d_inode
;
716 mutex_lock_nested(&dir
->i_mutex
, I_MUTEX_CHILD
);
717 __rpc_depopulate(parent
, files
, start
, eof
);
718 mutex_unlock(&dir
->i_mutex
);
721 static int rpc_populate(struct dentry
*parent
,
722 const struct rpc_filelist
*files
,
726 struct inode
*dir
= parent
->d_inode
;
727 struct dentry
*dentry
;
730 mutex_lock(&dir
->i_mutex
);
731 for (i
= start
; i
< eof
; i
++) {
734 q
.name
= files
[i
].name
;
735 q
.len
= strlen(files
[i
].name
);
736 q
.hash
= full_name_hash(q
.name
, q
.len
);
737 dentry
= __rpc_lookup_create_exclusive(parent
, &q
);
738 err
= PTR_ERR(dentry
);
741 switch (files
[i
].mode
& S_IFMT
) {
745 err
= __rpc_create(dir
, dentry
,
751 err
= __rpc_mkdir(dir
, dentry
,
759 mutex_unlock(&dir
->i_mutex
);
762 __rpc_depopulate(parent
, files
, start
, eof
);
763 mutex_unlock(&dir
->i_mutex
);
764 printk(KERN_WARNING
"%s: %s failed to populate directory %s\n",
765 __FILE__
, __func__
, parent
->d_name
.name
);
769 static struct dentry
*rpc_mkdir_populate(struct dentry
*parent
,
770 struct qstr
*name
, umode_t mode
, void *private,
771 int (*populate
)(struct dentry
*, void *), void *args_populate
)
773 struct dentry
*dentry
;
774 struct inode
*dir
= parent
->d_inode
;
777 mutex_lock_nested(&dir
->i_mutex
, I_MUTEX_PARENT
);
778 dentry
= __rpc_lookup_create_exclusive(parent
, name
);
781 error
= __rpc_mkdir(dir
, dentry
, mode
, NULL
, private);
784 if (populate
!= NULL
) {
785 error
= populate(dentry
, args_populate
);
790 mutex_unlock(&dir
->i_mutex
);
793 __rpc_rmdir(dir
, dentry
);
795 dentry
= ERR_PTR(error
);
799 static int rpc_rmdir_depopulate(struct dentry
*dentry
,
800 void (*depopulate
)(struct dentry
*))
802 struct dentry
*parent
;
806 parent
= dget_parent(dentry
);
807 dir
= parent
->d_inode
;
808 mutex_lock_nested(&dir
->i_mutex
, I_MUTEX_PARENT
);
809 if (depopulate
!= NULL
)
811 error
= __rpc_rmdir(dir
, dentry
);
812 mutex_unlock(&dir
->i_mutex
);
818 * rpc_mkpipe - make an rpc_pipefs file for kernel<->userspace communication
819 * @parent: dentry of directory to create new "pipe" in
820 * @name: name of pipe
821 * @private: private data to associate with the pipe, for the caller's use
822 * @pipe: &rpc_pipe containing input parameters
824 * Data is made available for userspace to read by calls to
825 * rpc_queue_upcall(). The actual reads will result in calls to
826 * @ops->upcall, which will be called with the file pointer,
827 * message, and userspace buffer to copy to.
829 * Writes can come at any time, and do not necessarily have to be
830 * responses to upcalls. They will result in calls to @msg->downcall.
832 * The @private argument passed here will be available to all these methods
833 * from the file pointer, via RPC_I(file_inode(file))->private.
835 struct dentry
*rpc_mkpipe_dentry(struct dentry
*parent
, const char *name
,
836 void *private, struct rpc_pipe
*pipe
)
838 struct dentry
*dentry
;
839 struct inode
*dir
= parent
->d_inode
;
840 umode_t umode
= S_IFIFO
| S_IRUSR
| S_IWUSR
;
844 if (pipe
->ops
->upcall
== NULL
)
846 if (pipe
->ops
->downcall
== NULL
)
850 q
.len
= strlen(name
);
851 q
.hash
= full_name_hash(q
.name
, q
.len
),
853 mutex_lock_nested(&dir
->i_mutex
, I_MUTEX_PARENT
);
854 dentry
= __rpc_lookup_create_exclusive(parent
, &q
);
857 err
= __rpc_mkpipe_dentry(dir
, dentry
, umode
, &rpc_pipe_fops
,
862 mutex_unlock(&dir
->i_mutex
);
865 dentry
= ERR_PTR(err
);
866 printk(KERN_WARNING
"%s: %s() failed to create pipe %s/%s (errno = %d)\n",
867 __FILE__
, __func__
, parent
->d_name
.name
, name
,
871 EXPORT_SYMBOL_GPL(rpc_mkpipe_dentry
);
874 * rpc_unlink - remove a pipe
875 * @dentry: dentry for the pipe, as returned from rpc_mkpipe
877 * After this call, lookups will no longer find the pipe, and any
878 * attempts to read or write using preexisting opens of the pipe will
882 rpc_unlink(struct dentry
*dentry
)
884 struct dentry
*parent
;
888 parent
= dget_parent(dentry
);
889 dir
= parent
->d_inode
;
890 mutex_lock_nested(&dir
->i_mutex
, I_MUTEX_PARENT
);
891 error
= __rpc_rmpipe(dir
, dentry
);
892 mutex_unlock(&dir
->i_mutex
);
896 EXPORT_SYMBOL_GPL(rpc_unlink
);
903 static const struct rpc_filelist authfiles
[] = {
906 .i_fop
= &rpc_info_operations
,
907 .mode
= S_IFREG
| S_IRUSR
,
911 static int rpc_clntdir_populate(struct dentry
*dentry
, void *private)
913 return rpc_populate(dentry
,
914 authfiles
, RPCAUTH_info
, RPCAUTH_EOF
,
918 static void rpc_clntdir_depopulate(struct dentry
*dentry
)
920 rpc_depopulate(dentry
, authfiles
, RPCAUTH_info
, RPCAUTH_EOF
);
924 * rpc_create_client_dir - Create a new rpc_client directory in rpc_pipefs
925 * @dentry: dentry from the rpc_pipefs root to the new directory
926 * @name: &struct qstr for the name
927 * @rpc_client: rpc client to associate with this directory
929 * This creates a directory at the given @path associated with
930 * @rpc_clnt, which will contain a file named "info" with some basic
931 * information about the client, together with any "pipes" that may
932 * later be created using rpc_mkpipe().
934 struct dentry
*rpc_create_client_dir(struct dentry
*dentry
,
936 struct rpc_clnt
*rpc_client
)
938 return rpc_mkdir_populate(dentry
, name
, S_IRUGO
| S_IXUGO
, NULL
,
939 rpc_clntdir_populate
, rpc_client
);
943 * rpc_remove_client_dir - Remove a directory created with rpc_create_client_dir()
944 * @dentry: dentry for the pipe
946 int rpc_remove_client_dir(struct dentry
*dentry
)
948 return rpc_rmdir_depopulate(dentry
, rpc_clntdir_depopulate
);
951 static const struct rpc_filelist cache_pipefs_files
[3] = {
954 .i_fop
= &cache_file_operations_pipefs
,
955 .mode
= S_IFREG
|S_IRUSR
|S_IWUSR
,
959 .i_fop
= &content_file_operations_pipefs
,
960 .mode
= S_IFREG
|S_IRUSR
,
964 .i_fop
= &cache_flush_operations_pipefs
,
965 .mode
= S_IFREG
|S_IRUSR
|S_IWUSR
,
969 static int rpc_cachedir_populate(struct dentry
*dentry
, void *private)
971 return rpc_populate(dentry
,
972 cache_pipefs_files
, 0, 3,
976 static void rpc_cachedir_depopulate(struct dentry
*dentry
)
978 rpc_depopulate(dentry
, cache_pipefs_files
, 0, 3);
981 struct dentry
*rpc_create_cache_dir(struct dentry
*parent
, struct qstr
*name
,
982 umode_t umode
, struct cache_detail
*cd
)
984 return rpc_mkdir_populate(parent
, name
, umode
, NULL
,
985 rpc_cachedir_populate
, cd
);
988 void rpc_remove_cache_dir(struct dentry
*dentry
)
990 rpc_rmdir_depopulate(dentry
, rpc_cachedir_depopulate
);
994 * populate the filesystem
996 static const struct super_operations s_ops
= {
997 .alloc_inode
= rpc_alloc_inode
,
998 .destroy_inode
= rpc_destroy_inode
,
999 .statfs
= simple_statfs
,
1002 #define RPCAUTH_GSSMAGIC 0x67596969
1005 * 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
,
1050 .mode
= S_IFDIR
| S_IRUGO
| S_IXUGO
,
1055 * This call can be used only in RPC pipefs mount notification hooks.
1057 struct dentry
*rpc_d_lookup_sb(const struct super_block
*sb
,
1058 const unsigned char *dir_name
)
1060 struct qstr dir
= QSTR_INIT(dir_name
, strlen(dir_name
));
1062 dir
.hash
= full_name_hash(dir
.name
, dir
.len
);
1063 return d_lookup(sb
->s_root
, &dir
);
1065 EXPORT_SYMBOL_GPL(rpc_d_lookup_sb
);
1067 void rpc_pipefs_init_net(struct net
*net
)
1069 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
1071 mutex_init(&sn
->pipefs_sb_lock
);
1075 * This call will be used for per network namespace operations calls.
1076 * Note: Function will be returned with pipefs_sb_lock taken if superblock was
1077 * found. This lock have to be released by rpc_put_sb_net() when all operations
1078 * will be completed.
1080 struct super_block
*rpc_get_sb_net(const struct net
*net
)
1082 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
1084 mutex_lock(&sn
->pipefs_sb_lock
);
1086 return sn
->pipefs_sb
;
1087 mutex_unlock(&sn
->pipefs_sb_lock
);
1090 EXPORT_SYMBOL_GPL(rpc_get_sb_net
);
1092 void rpc_put_sb_net(const struct net
*net
)
1094 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
1096 WARN_ON(sn
->pipefs_sb
== NULL
);
1097 mutex_unlock(&sn
->pipefs_sb_lock
);
1099 EXPORT_SYMBOL_GPL(rpc_put_sb_net
);
1102 rpc_fill_super(struct super_block
*sb
, void *data
, int silent
)
1104 struct inode
*inode
;
1105 struct dentry
*root
;
1106 struct net
*net
= data
;
1107 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
1110 sb
->s_blocksize
= PAGE_CACHE_SIZE
;
1111 sb
->s_blocksize_bits
= PAGE_CACHE_SHIFT
;
1112 sb
->s_magic
= RPCAUTH_GSSMAGIC
;
1114 sb
->s_time_gran
= 1;
1116 inode
= rpc_get_inode(sb
, S_IFDIR
| S_IRUGO
| S_IXUGO
);
1117 sb
->s_root
= root
= d_make_root(inode
);
1120 if (rpc_populate(root
, files
, RPCAUTH_lockd
, RPCAUTH_RootEOF
, NULL
))
1122 dprintk("RPC: sending pipefs MOUNT notification for net %p%s\n",
1123 net
, NET_NAME(net
));
1125 err
= blocking_notifier_call_chain(&rpc_pipefs_notifier_list
,
1129 goto err_depopulate
;
1130 sb
->s_fs_info
= get_net(net
);
1134 blocking_notifier_call_chain(&rpc_pipefs_notifier_list
,
1137 sn
->pipefs_sb
= NULL
;
1138 __rpc_depopulate(root
, files
, RPCAUTH_lockd
, RPCAUTH_RootEOF
);
1142 static struct dentry
*
1143 rpc_mount(struct file_system_type
*fs_type
,
1144 int flags
, const char *dev_name
, void *data
)
1146 return mount_ns(fs_type
, flags
, current
->nsproxy
->net_ns
, rpc_fill_super
);
1149 static void rpc_kill_sb(struct super_block
*sb
)
1151 struct net
*net
= sb
->s_fs_info
;
1152 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
1154 mutex_lock(&sn
->pipefs_sb_lock
);
1155 if (sn
->pipefs_sb
!= sb
) {
1156 mutex_unlock(&sn
->pipefs_sb_lock
);
1159 sn
->pipefs_sb
= NULL
;
1160 mutex_unlock(&sn
->pipefs_sb_lock
);
1161 dprintk("RPC: sending pipefs UMOUNT notification for net %p%s\n",
1162 net
, NET_NAME(net
));
1163 blocking_notifier_call_chain(&rpc_pipefs_notifier_list
,
1168 kill_litter_super(sb
);
1171 static struct file_system_type rpc_pipe_fs_type
= {
1172 .owner
= THIS_MODULE
,
1173 .name
= "rpc_pipefs",
1175 .kill_sb
= rpc_kill_sb
,
1177 MODULE_ALIAS_FS("rpc_pipefs");
1178 MODULE_ALIAS("rpc_pipefs");
1181 init_once(void *foo
)
1183 struct rpc_inode
*rpci
= (struct rpc_inode
*) foo
;
1185 inode_init_once(&rpci
->vfs_inode
);
1186 rpci
->private = NULL
;
1188 init_waitqueue_head(&rpci
->waitq
);
1191 int register_rpc_pipefs(void)
1195 rpc_inode_cachep
= kmem_cache_create("rpc_inode_cache",
1196 sizeof(struct rpc_inode
),
1197 0, (SLAB_HWCACHE_ALIGN
|SLAB_RECLAIM_ACCOUNT
|
1200 if (!rpc_inode_cachep
)
1202 err
= rpc_clients_notifier_register();
1205 err
= register_filesystem(&rpc_pipe_fs_type
);
1211 rpc_clients_notifier_unregister();
1213 kmem_cache_destroy(rpc_inode_cachep
);
1217 void unregister_rpc_pipefs(void)
1219 rpc_clients_notifier_unregister();
1220 kmem_cache_destroy(rpc_inode_cachep
);
1221 unregister_filesystem(&rpc_pipe_fs_type
);