2 * net/sunrpc/rpc_pipe.c
4 * Userland/kernel interface for rpcauth_gss.
5 * Code shamelessly plagiarized from fs/nfsd/nfsctl.c
6 * and fs/driverfs/inode.c
8 * Copyright (c) 2002, Trond Myklebust <trond.myklebust@fys.uio.no>
11 #include <linux/config.h>
12 #include <linux/module.h>
13 #include <linux/slab.h>
14 #include <linux/string.h>
15 #include <linux/pagemap.h>
16 #include <linux/mount.h>
17 #include <linux/namei.h>
18 #include <linux/dnotify.h>
19 #include <linux/kernel.h>
21 #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>
31 static struct vfsmount
*rpc_mount
;
32 static int rpc_mount_count
;
34 static struct file_system_type rpc_pipe_fs_type
;
37 static kmem_cache_t
*rpc_inode_cachep
;
39 #define RPC_UPCALL_TIMEOUT (30*HZ)
42 __rpc_purge_upcall(struct inode
*inode
, int err
)
44 struct rpc_inode
*rpci
= RPC_I(inode
);
45 struct rpc_pipe_msg
*msg
;
47 while (!list_empty(&rpci
->pipe
)) {
48 msg
= list_entry(rpci
->pipe
.next
, struct rpc_pipe_msg
, list
);
49 list_del_init(&msg
->list
);
51 rpci
->ops
->destroy_msg(msg
);
53 while (!list_empty(&rpci
->in_upcall
)) {
54 msg
= list_entry(rpci
->pipe
.next
, struct rpc_pipe_msg
, list
);
55 list_del_init(&msg
->list
);
57 rpci
->ops
->destroy_msg(msg
);
60 wake_up(&rpci
->waitq
);
64 rpc_timeout_upcall_queue(void *data
)
66 struct rpc_inode
*rpci
= (struct rpc_inode
*)data
;
67 struct inode
*inode
= &rpci
->vfs_inode
;
70 if (rpci
->nreaders
== 0 && !list_empty(&rpci
->pipe
))
71 __rpc_purge_upcall(inode
, -ETIMEDOUT
);
76 rpc_queue_upcall(struct inode
*inode
, struct rpc_pipe_msg
*msg
)
78 struct rpc_inode
*rpci
= RPC_I(inode
);
83 list_add_tail(&msg
->list
, &rpci
->pipe
);
84 rpci
->pipelen
+= msg
->len
;
85 } else if (rpci
->flags
& RPC_PIPE_WAIT_FOR_OPEN
) {
86 if (list_empty(&rpci
->pipe
))
87 schedule_delayed_work(&rpci
->queue_timeout
,
89 list_add_tail(&msg
->list
, &rpci
->pipe
);
90 rpci
->pipelen
+= msg
->len
;
94 wake_up(&rpci
->waitq
);
99 rpc_close_pipes(struct inode
*inode
)
101 struct rpc_inode
*rpci
= RPC_I(inode
);
103 cancel_delayed_work(&rpci
->queue_timeout
);
104 flush_scheduled_work();
106 if (rpci
->ops
!= NULL
) {
108 __rpc_purge_upcall(inode
, -EPIPE
);
110 if (rpci
->ops
->release_pipe
)
111 rpci
->ops
->release_pipe(inode
);
118 rpc_inode_setowner(struct inode
*inode
, void *private)
120 RPC_I(inode
)->private = private;
123 static struct inode
*
124 rpc_alloc_inode(struct super_block
*sb
)
126 struct rpc_inode
*rpci
;
127 rpci
= (struct rpc_inode
*)kmem_cache_alloc(rpc_inode_cachep
, SLAB_KERNEL
);
130 return &rpci
->vfs_inode
;
134 rpc_destroy_inode(struct inode
*inode
)
136 kmem_cache_free(rpc_inode_cachep
, RPC_I(inode
));
140 rpc_pipe_open(struct inode
*inode
, struct file
*filp
)
142 struct rpc_inode
*rpci
= RPC_I(inode
);
146 if (rpci
->ops
!= NULL
) {
147 if (filp
->f_mode
& FMODE_READ
)
149 if (filp
->f_mode
& FMODE_WRITE
)
158 rpc_pipe_release(struct inode
*inode
, struct file
*filp
)
160 struct rpc_inode
*rpci
= RPC_I(filp
->f_dentry
->d_inode
);
161 struct rpc_pipe_msg
*msg
;
164 if (rpci
->ops
== NULL
)
166 msg
= (struct rpc_pipe_msg
*)filp
->private_data
;
169 list_del_init(&msg
->list
);
170 rpci
->ops
->destroy_msg(msg
);
172 if (filp
->f_mode
& FMODE_WRITE
)
174 if (filp
->f_mode
& FMODE_READ
)
177 __rpc_purge_upcall(inode
, -EPIPE
);
178 if (rpci
->ops
->release_pipe
)
179 rpci
->ops
->release_pipe(inode
);
186 rpc_pipe_read(struct file
*filp
, char __user
*buf
, size_t len
, loff_t
*offset
)
188 struct inode
*inode
= filp
->f_dentry
->d_inode
;
189 struct rpc_inode
*rpci
= RPC_I(inode
);
190 struct rpc_pipe_msg
*msg
;
194 if (rpci
->ops
== NULL
) {
198 msg
= filp
->private_data
;
200 if (!list_empty(&rpci
->pipe
)) {
201 msg
= list_entry(rpci
->pipe
.next
,
204 list_move(&msg
->list
, &rpci
->in_upcall
);
205 rpci
->pipelen
-= msg
->len
;
206 filp
->private_data
= msg
;
212 /* NOTE: it is up to the callback to update msg->copied */
213 res
= rpci
->ops
->upcall(filp
, msg
, buf
, len
);
214 if (res
< 0 || msg
->len
== msg
->copied
) {
215 filp
->private_data
= NULL
;
216 list_del_init(&msg
->list
);
217 rpci
->ops
->destroy_msg(msg
);
225 rpc_pipe_write(struct file
*filp
, const char __user
*buf
, size_t len
, loff_t
*offset
)
227 struct inode
*inode
= filp
->f_dentry
->d_inode
;
228 struct rpc_inode
*rpci
= RPC_I(inode
);
233 if (rpci
->ops
!= NULL
)
234 res
= rpci
->ops
->downcall(filp
, buf
, len
);
240 rpc_pipe_poll(struct file
*filp
, struct poll_table_struct
*wait
)
242 struct rpc_inode
*rpci
;
243 unsigned int mask
= 0;
245 rpci
= RPC_I(filp
->f_dentry
->d_inode
);
246 poll_wait(filp
, &rpci
->waitq
, wait
);
248 mask
= POLLOUT
| POLLWRNORM
;
249 if (rpci
->ops
== NULL
)
250 mask
|= POLLERR
| POLLHUP
;
251 if (!list_empty(&rpci
->pipe
))
252 mask
|= POLLIN
| POLLRDNORM
;
257 rpc_pipe_ioctl(struct inode
*ino
, struct file
*filp
,
258 unsigned int cmd
, unsigned long arg
)
260 struct rpc_inode
*rpci
= RPC_I(filp
->f_dentry
->d_inode
);
265 if (rpci
->ops
== NULL
)
268 if (filp
->private_data
) {
269 struct rpc_pipe_msg
*msg
;
270 msg
= (struct rpc_pipe_msg
*)filp
->private_data
;
271 len
+= msg
->len
- msg
->copied
;
273 return put_user(len
, (int __user
*)arg
);
279 static struct file_operations rpc_pipe_fops
= {
280 .owner
= THIS_MODULE
,
282 .read
= rpc_pipe_read
,
283 .write
= rpc_pipe_write
,
284 .poll
= rpc_pipe_poll
,
285 .ioctl
= rpc_pipe_ioctl
,
286 .open
= rpc_pipe_open
,
287 .release
= rpc_pipe_release
,
291 rpc_show_info(struct seq_file
*m
, void *v
)
293 struct rpc_clnt
*clnt
= m
->private;
295 seq_printf(m
, "RPC server: %s\n", clnt
->cl_server
);
296 seq_printf(m
, "service: %s (%d) version %d\n", clnt
->cl_protname
,
297 clnt
->cl_prog
, clnt
->cl_vers
);
298 seq_printf(m
, "address: %u.%u.%u.%u\n",
299 NIPQUAD(clnt
->cl_xprt
->addr
.sin_addr
.s_addr
));
300 seq_printf(m
, "protocol: %s\n",
301 clnt
->cl_xprt
->prot
== IPPROTO_UDP
? "udp" : "tcp");
306 rpc_info_open(struct inode
*inode
, struct file
*file
)
308 struct rpc_clnt
*clnt
;
309 int ret
= single_open(file
, rpc_show_info
, NULL
);
312 struct seq_file
*m
= file
->private_data
;
314 clnt
= RPC_I(inode
)->private;
316 atomic_inc(&clnt
->cl_users
);
319 single_release(inode
, file
);
328 rpc_info_release(struct inode
*inode
, struct file
*file
)
330 struct seq_file
*m
= file
->private_data
;
331 struct rpc_clnt
*clnt
= (struct rpc_clnt
*)m
->private;
334 rpc_release_client(clnt
);
335 return single_release(inode
, file
);
338 static struct file_operations rpc_info_operations
= {
339 .owner
= THIS_MODULE
,
340 .open
= rpc_info_open
,
343 .release
= rpc_info_release
,
348 * We have a single directory with 1 node in it.
361 * Description of fs contents.
363 struct rpc_filelist
{
365 struct file_operations
*i_fop
;
369 static struct rpc_filelist files
[] = {
372 .mode
= S_IFDIR
| S_IRUGO
| S_IXUGO
,
376 .mode
= S_IFDIR
| S_IRUGO
| S_IXUGO
,
380 .mode
= S_IFDIR
| S_IRUGO
| S_IXUGO
,
382 [RPCAUTH_portmap
] = {
384 .mode
= S_IFDIR
| S_IRUGO
| S_IXUGO
,
388 .mode
= S_IFDIR
| S_IRUGO
| S_IXUGO
,
397 static struct rpc_filelist authfiles
[] = {
400 .i_fop
= &rpc_info_operations
,
401 .mode
= S_IFREG
| S_IRUSR
,
408 return simple_pin_fs("rpc_pipefs", &rpc_mount
, &rpc_mount_count
);
414 simple_release_fs(&rpc_mount
, &rpc_mount_count
);
418 rpc_lookup_parent(char *path
, struct nameidata
*nd
)
422 if (rpc_get_mount()) {
423 printk(KERN_WARNING
"%s: %s failed to mount "
424 "pseudofilesystem \n", __FILE__
, __FUNCTION__
);
427 nd
->mnt
= mntget(rpc_mount
);
428 nd
->dentry
= dget(rpc_mount
->mnt_root
);
429 nd
->last_type
= LAST_ROOT
;
430 nd
->flags
= LOOKUP_PARENT
;
433 if (path_walk(path
, nd
)) {
434 printk(KERN_WARNING
"%s: %s failed to find path %s\n",
435 __FILE__
, __FUNCTION__
, path
);
443 rpc_release_path(struct nameidata
*nd
)
449 static struct inode
*
450 rpc_get_inode(struct super_block
*sb
, int mode
)
452 struct inode
*inode
= new_inode(sb
);
455 inode
->i_mode
= mode
;
456 inode
->i_uid
= inode
->i_gid
= 0;
457 inode
->i_blksize
= PAGE_CACHE_SIZE
;
459 inode
->i_atime
= inode
->i_mtime
= inode
->i_ctime
= CURRENT_TIME
;
460 switch(mode
& S_IFMT
) {
462 inode
->i_fop
= &simple_dir_operations
;
463 inode
->i_op
= &simple_dir_inode_operations
;
472 * FIXME: This probably has races.
475 rpc_depopulate(struct dentry
*parent
)
477 struct inode
*dir
= parent
->d_inode
;
478 struct list_head
*pos
, *next
;
479 struct dentry
*dentry
, *dvec
[10];
484 spin_lock(&dcache_lock
);
485 list_for_each_safe(pos
, next
, &parent
->d_subdirs
) {
486 dentry
= list_entry(pos
, struct dentry
, d_child
);
487 spin_lock(&dentry
->d_lock
);
488 if (!d_unhashed(dentry
)) {
491 spin_unlock(&dentry
->d_lock
);
493 if (n
== ARRAY_SIZE(dvec
))
496 spin_unlock(&dentry
->d_lock
);
498 spin_unlock(&dcache_lock
);
502 if (dentry
->d_inode
) {
503 rpc_close_pipes(dentry
->d_inode
);
504 rpc_inode_setowner(dentry
->d_inode
, NULL
);
505 simple_unlink(dir
, dentry
);
515 rpc_populate(struct dentry
*parent
,
516 struct rpc_filelist
*files
,
519 struct inode
*inode
, *dir
= parent
->d_inode
;
520 void *private = RPC_I(dir
)->private;
521 struct dentry
*dentry
;
525 for (i
= start
; i
< eof
; i
++) {
526 dentry
= d_alloc_name(parent
, files
[i
].name
);
529 mode
= files
[i
].mode
;
530 inode
= rpc_get_inode(dir
->i_sb
, mode
);
537 inode
->i_fop
= files
[i
].i_fop
;
539 rpc_inode_setowner(inode
, private);
542 d_add(dentry
, inode
);
548 printk(KERN_WARNING
"%s: %s failed to populate directory %s\n",
549 __FILE__
, __FUNCTION__
, parent
->d_name
.name
);
554 __rpc_mkdir(struct inode
*dir
, struct dentry
*dentry
)
558 inode
= rpc_get_inode(dir
->i_sb
, S_IFDIR
| S_IRUSR
| S_IXUSR
);
561 inode
->i_ino
= iunique(dir
->i_sb
, 100);
562 d_instantiate(dentry
, inode
);
564 inode_dir_notify(dir
, DN_CREATE
);
568 printk(KERN_WARNING
"%s: %s failed to allocate inode for dentry %s\n",
569 __FILE__
, __FUNCTION__
, dentry
->d_name
.name
);
574 __rpc_rmdir(struct inode
*dir
, struct dentry
*dentry
)
578 shrink_dcache_parent(dentry
);
579 if (dentry
->d_inode
) {
580 rpc_close_pipes(dentry
->d_inode
);
581 rpc_inode_setowner(dentry
->d_inode
, NULL
);
583 if ((error
= simple_rmdir(dir
, dentry
)) != 0)
586 inode_dir_notify(dir
, DN_DELETE
);
593 static struct dentry
*
594 rpc_lookup_negative(char *path
, struct nameidata
*nd
)
596 struct dentry
*dentry
;
600 if ((error
= rpc_lookup_parent(path
, nd
)) != 0)
601 return ERR_PTR(error
);
602 dir
= nd
->dentry
->d_inode
;
604 dentry
= lookup_hash(&nd
->last
, nd
->dentry
);
607 if (dentry
->d_inode
) {
609 dentry
= ERR_PTR(-EEXIST
);
615 rpc_release_path(nd
);
621 rpc_mkdir(char *path
, struct rpc_clnt
*rpc_client
)
624 struct dentry
*dentry
;
628 dentry
= rpc_lookup_negative(path
, &nd
);
631 dir
= nd
.dentry
->d_inode
;
632 if ((error
= __rpc_mkdir(dir
, dentry
)) != 0)
634 RPC_I(dentry
->d_inode
)->private = rpc_client
;
635 error
= rpc_populate(dentry
, authfiles
,
636 RPCAUTH_info
, RPCAUTH_EOF
);
641 rpc_release_path(&nd
);
644 rpc_depopulate(dentry
);
645 __rpc_rmdir(dir
, dentry
);
648 printk(KERN_WARNING
"%s: %s() failed to create directory %s (errno = %d)\n",
649 __FILE__
, __FUNCTION__
, path
, error
);
650 dentry
= ERR_PTR(error
);
655 rpc_rmdir(char *path
)
658 struct dentry
*dentry
;
662 if ((error
= rpc_lookup_parent(path
, &nd
)) != 0)
664 dir
= nd
.dentry
->d_inode
;
666 dentry
= lookup_hash(&nd
.last
, nd
.dentry
);
667 if (IS_ERR(dentry
)) {
668 error
= PTR_ERR(dentry
);
671 rpc_depopulate(dentry
);
672 error
= __rpc_rmdir(dir
, dentry
);
676 rpc_release_path(&nd
);
681 rpc_mkpipe(char *path
, void *private, struct rpc_pipe_ops
*ops
, int flags
)
684 struct dentry
*dentry
;
685 struct inode
*dir
, *inode
;
686 struct rpc_inode
*rpci
;
688 dentry
= rpc_lookup_negative(path
, &nd
);
691 dir
= nd
.dentry
->d_inode
;
692 inode
= rpc_get_inode(dir
->i_sb
, S_IFSOCK
| S_IRUSR
| S_IWUSR
);
695 inode
->i_ino
= iunique(dir
->i_sb
, 100);
696 inode
->i_fop
= &rpc_pipe_fops
;
697 d_instantiate(dentry
, inode
);
699 rpci
->private = private;
702 inode_dir_notify(dir
, DN_CREATE
);
705 rpc_release_path(&nd
);
709 dentry
= ERR_PTR(-ENOMEM
);
710 printk(KERN_WARNING
"%s: %s() failed to create pipe %s (errno = %d)\n",
711 __FILE__
, __FUNCTION__
, path
, -ENOMEM
);
716 rpc_unlink(char *path
)
719 struct dentry
*dentry
;
723 if ((error
= rpc_lookup_parent(path
, &nd
)) != 0)
725 dir
= nd
.dentry
->d_inode
;
727 dentry
= lookup_hash(&nd
.last
, nd
.dentry
);
728 if (IS_ERR(dentry
)) {
729 error
= PTR_ERR(dentry
);
733 if (dentry
->d_inode
) {
734 rpc_close_pipes(dentry
->d_inode
);
735 rpc_inode_setowner(dentry
->d_inode
, NULL
);
736 error
= simple_unlink(dir
, dentry
);
739 inode_dir_notify(dir
, DN_DELETE
);
742 rpc_release_path(&nd
);
747 * populate the filesystem
749 static struct super_operations s_ops
= {
750 .alloc_inode
= rpc_alloc_inode
,
751 .destroy_inode
= rpc_destroy_inode
,
752 .statfs
= simple_statfs
,
755 #define RPCAUTH_GSSMAGIC 0x67596969
758 rpc_fill_super(struct super_block
*sb
, void *data
, int silent
)
763 sb
->s_blocksize
= PAGE_CACHE_SIZE
;
764 sb
->s_blocksize_bits
= PAGE_CACHE_SHIFT
;
765 sb
->s_magic
= RPCAUTH_GSSMAGIC
;
769 inode
= rpc_get_inode(sb
, S_IFDIR
| 0755);
772 root
= d_alloc_root(inode
);
777 if (rpc_populate(root
, files
, RPCAUTH_Root
+ 1, RPCAUTH_RootEOF
))
787 static struct super_block
*
788 rpc_get_sb(struct file_system_type
*fs_type
,
789 int flags
, const char *dev_name
, void *data
)
791 return get_sb_single(fs_type
, flags
, data
, rpc_fill_super
);
794 static struct file_system_type rpc_pipe_fs_type
= {
795 .owner
= THIS_MODULE
,
796 .name
= "rpc_pipefs",
797 .get_sb
= rpc_get_sb
,
798 .kill_sb
= kill_litter_super
,
802 init_once(void * foo
, kmem_cache_t
* cachep
, unsigned long flags
)
804 struct rpc_inode
*rpci
= (struct rpc_inode
*) foo
;
806 if ((flags
& (SLAB_CTOR_VERIFY
|SLAB_CTOR_CONSTRUCTOR
)) ==
807 SLAB_CTOR_CONSTRUCTOR
) {
808 inode_init_once(&rpci
->vfs_inode
);
809 rpci
->private = NULL
;
812 INIT_LIST_HEAD(&rpci
->in_upcall
);
813 INIT_LIST_HEAD(&rpci
->pipe
);
815 init_waitqueue_head(&rpci
->waitq
);
816 INIT_WORK(&rpci
->queue_timeout
, rpc_timeout_upcall_queue
, rpci
);
821 int register_rpc_pipefs(void)
823 rpc_inode_cachep
= kmem_cache_create("rpc_inode_cache",
824 sizeof(struct rpc_inode
),
825 0, SLAB_HWCACHE_ALIGN
|SLAB_RECLAIM_ACCOUNT
,
827 if (!rpc_inode_cachep
)
829 register_filesystem(&rpc_pipe_fs_type
);
833 void unregister_rpc_pipefs(void)
835 if (kmem_cache_destroy(rpc_inode_cachep
))
836 printk(KERN_WARNING
"RPC: unable to free inode cache\n");
837 unregister_filesystem(&rpc_pipe_fs_type
);