Merge branch 'nfs-for-2.6.35' of git://git.linux-nfs.org/projects/trondmy/nfs-2.6
[linux-2.6-block.git] / net / sunrpc / rpc_pipe.c
CommitLineData
1da177e4
LT
1/*
2 * net/sunrpc/rpc_pipe.c
3 *
4 * Userland/kernel interface for rpcauth_gss.
5 * Code shamelessly plagiarized from fs/nfsd/nfsctl.c
d51fe1be 6 * and fs/sysfs/inode.c
1da177e4
LT
7 *
8 * Copyright (c) 2002, Trond Myklebust <trond.myklebust@fys.uio.no>
9 *
10 */
1da177e4
LT
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>
50e437d5 17#include <linux/fsnotify.h>
1da177e4
LT
18#include <linux/kernel.h>
19
20#include <asm/ioctls.h>
21#include <linux/fs.h>
22#include <linux/poll.h>
23#include <linux/wait.h>
24#include <linux/seq_file.h>
25
26#include <linux/sunrpc/clnt.h>
27#include <linux/workqueue.h>
28#include <linux/sunrpc/rpc_pipe_fs.h>
8854e82d 29#include <linux/sunrpc/cache.h>
1da177e4 30
ba89966c 31static struct vfsmount *rpc_mount __read_mostly;
1da177e4
LT
32static int rpc_mount_count;
33
34static struct file_system_type rpc_pipe_fs_type;
35
36
e18b890b 37static struct kmem_cache *rpc_inode_cachep __read_mostly;
1da177e4
LT
38
39#define RPC_UPCALL_TIMEOUT (30*HZ)
40
9842ef35
TM
41static void rpc_purge_list(struct rpc_inode *rpci, struct list_head *head,
42 void (*destroy_msg)(struct rpc_pipe_msg *), int err)
1da177e4 43{
1da177e4
LT
44 struct rpc_pipe_msg *msg;
45
9842ef35
TM
46 if (list_empty(head))
47 return;
48 do {
b3eb67a2 49 msg = list_entry(head->next, struct rpc_pipe_msg, list);
9842ef35 50 list_del(&msg->list);
1da177e4 51 msg->errno = err;
b3eb67a2 52 destroy_msg(msg);
9842ef35 53 } while (!list_empty(head));
1da177e4
LT
54 wake_up(&rpci->waitq);
55}
56
57static void
65f27f38 58rpc_timeout_upcall_queue(struct work_struct *work)
1da177e4 59{
9842ef35 60 LIST_HEAD(free_list);
65f27f38
DH
61 struct rpc_inode *rpci =
62 container_of(work, struct rpc_inode, queue_timeout.work);
1da177e4 63 struct inode *inode = &rpci->vfs_inode;
9842ef35 64 void (*destroy_msg)(struct rpc_pipe_msg *);
1da177e4 65
9842ef35
TM
66 spin_lock(&inode->i_lock);
67 if (rpci->ops == NULL) {
68 spin_unlock(&inode->i_lock);
69 return;
70 }
71 destroy_msg = rpci->ops->destroy_msg;
72 if (rpci->nreaders == 0) {
73 list_splice_init(&rpci->pipe, &free_list);
74 rpci->pipelen = 0;
75 }
76 spin_unlock(&inode->i_lock);
77 rpc_purge_list(rpci, &free_list, destroy_msg, -ETIMEDOUT);
1da177e4
LT
78}
79
93a44a75 80/**
1a5778aa 81 * rpc_queue_upcall - queue an upcall message to userspace
93a44a75
BF
82 * @inode: inode of upcall pipe on which to queue given message
83 * @msg: message to queue
84 *
85 * Call with an @inode created by rpc_mkpipe() to queue an upcall.
86 * A userspace process may then later read the upcall by performing a
87 * read on an open file for this inode. It is up to the caller to
88 * initialize the fields of @msg (other than @msg->list) appropriately.
89 */
1da177e4
LT
90int
91rpc_queue_upcall(struct inode *inode, struct rpc_pipe_msg *msg)
92{
93 struct rpc_inode *rpci = RPC_I(inode);
6070fe6f 94 int res = -EPIPE;
1da177e4 95
9842ef35 96 spin_lock(&inode->i_lock);
6070fe6f
TM
97 if (rpci->ops == NULL)
98 goto out;
1da177e4
LT
99 if (rpci->nreaders) {
100 list_add_tail(&msg->list, &rpci->pipe);
101 rpci->pipelen += msg->len;
6070fe6f 102 res = 0;
1da177e4
LT
103 } else if (rpci->flags & RPC_PIPE_WAIT_FOR_OPEN) {
104 if (list_empty(&rpci->pipe))
24c5d9d7
TM
105 queue_delayed_work(rpciod_workqueue,
106 &rpci->queue_timeout,
1da177e4
LT
107 RPC_UPCALL_TIMEOUT);
108 list_add_tail(&msg->list, &rpci->pipe);
109 rpci->pipelen += msg->len;
6070fe6f
TM
110 res = 0;
111 }
112out:
9842ef35 113 spin_unlock(&inode->i_lock);
1da177e4
LT
114 wake_up(&rpci->waitq);
115 return res;
116}
468039ee 117EXPORT_SYMBOL_GPL(rpc_queue_upcall);
1da177e4 118
6070fe6f
TM
119static inline void
120rpc_inode_setowner(struct inode *inode, void *private)
121{
122 RPC_I(inode)->private = private;
123}
124
1da177e4
LT
125static void
126rpc_close_pipes(struct inode *inode)
127{
128 struct rpc_inode *rpci = RPC_I(inode);
b693ba4a 129 const struct rpc_pipe_ops *ops;
e712804a 130 int need_release;
1da177e4 131
1b1dcc1b 132 mutex_lock(&inode->i_mutex);
9842ef35
TM
133 ops = rpci->ops;
134 if (ops != NULL) {
135 LIST_HEAD(free_list);
9842ef35 136 spin_lock(&inode->i_lock);
e712804a 137 need_release = rpci->nreaders != 0 || rpci->nwriters != 0;
1da177e4 138 rpci->nreaders = 0;
9842ef35
TM
139 list_splice_init(&rpci->in_upcall, &free_list);
140 list_splice_init(&rpci->pipe, &free_list);
141 rpci->pipelen = 0;
1da177e4 142 rpci->ops = NULL;
9842ef35
TM
143 spin_unlock(&inode->i_lock);
144 rpc_purge_list(rpci, &free_list, ops->destroy_msg, -EPIPE);
145 rpci->nwriters = 0;
e712804a 146 if (need_release && ops->release_pipe)
9842ef35 147 ops->release_pipe(inode);
4011cd97 148 cancel_delayed_work_sync(&rpci->queue_timeout);
1da177e4 149 }
6070fe6f 150 rpc_inode_setowner(inode, NULL);
1b1dcc1b 151 mutex_unlock(&inode->i_mutex);
1da177e4
LT
152}
153
1da177e4
LT
154static struct inode *
155rpc_alloc_inode(struct super_block *sb)
156{
157 struct rpc_inode *rpci;
e94b1766 158 rpci = (struct rpc_inode *)kmem_cache_alloc(rpc_inode_cachep, GFP_KERNEL);
1da177e4
LT
159 if (!rpci)
160 return NULL;
161 return &rpci->vfs_inode;
162}
163
164static void
165rpc_destroy_inode(struct inode *inode)
166{
167 kmem_cache_free(rpc_inode_cachep, RPC_I(inode));
168}
169
170static int
171rpc_pipe_open(struct inode *inode, struct file *filp)
172{
173 struct rpc_inode *rpci = RPC_I(inode);
c3810608 174 int first_open;
1da177e4
LT
175 int res = -ENXIO;
176
1b1dcc1b 177 mutex_lock(&inode->i_mutex);
c3810608
BF
178 if (rpci->ops == NULL)
179 goto out;
180 first_open = rpci->nreaders == 0 && rpci->nwriters == 0;
181 if (first_open && rpci->ops->open_pipe) {
182 res = rpci->ops->open_pipe(inode);
183 if (res)
184 goto out;
1da177e4 185 }
c3810608
BF
186 if (filp->f_mode & FMODE_READ)
187 rpci->nreaders++;
188 if (filp->f_mode & FMODE_WRITE)
189 rpci->nwriters++;
190 res = 0;
191out:
1b1dcc1b 192 mutex_unlock(&inode->i_mutex);
1da177e4
LT
193 return res;
194}
195
196static int
197rpc_pipe_release(struct inode *inode, struct file *filp)
198{
969b7f25 199 struct rpc_inode *rpci = RPC_I(inode);
1da177e4 200 struct rpc_pipe_msg *msg;
e712804a 201 int last_close;
1da177e4 202
1b1dcc1b 203 mutex_lock(&inode->i_mutex);
1da177e4
LT
204 if (rpci->ops == NULL)
205 goto out;
206 msg = (struct rpc_pipe_msg *)filp->private_data;
207 if (msg != NULL) {
9842ef35 208 spin_lock(&inode->i_lock);
48e49187 209 msg->errno = -EAGAIN;
9842ef35
TM
210 list_del(&msg->list);
211 spin_unlock(&inode->i_lock);
1da177e4
LT
212 rpci->ops->destroy_msg(msg);
213 }
214 if (filp->f_mode & FMODE_WRITE)
215 rpci->nwriters --;
9842ef35 216 if (filp->f_mode & FMODE_READ) {
1da177e4 217 rpci->nreaders --;
9842ef35
TM
218 if (rpci->nreaders == 0) {
219 LIST_HEAD(free_list);
220 spin_lock(&inode->i_lock);
221 list_splice_init(&rpci->pipe, &free_list);
222 rpci->pipelen = 0;
223 spin_unlock(&inode->i_lock);
224 rpc_purge_list(rpci, &free_list,
225 rpci->ops->destroy_msg, -EAGAIN);
226 }
227 }
e712804a
BF
228 last_close = rpci->nwriters == 0 && rpci->nreaders == 0;
229 if (last_close && rpci->ops->release_pipe)
1da177e4
LT
230 rpci->ops->release_pipe(inode);
231out:
1b1dcc1b 232 mutex_unlock(&inode->i_mutex);
1da177e4
LT
233 return 0;
234}
235
236static ssize_t
237rpc_pipe_read(struct file *filp, char __user *buf, size_t len, loff_t *offset)
238{
303b46bb 239 struct inode *inode = filp->f_path.dentry->d_inode;
1da177e4
LT
240 struct rpc_inode *rpci = RPC_I(inode);
241 struct rpc_pipe_msg *msg;
242 int res = 0;
243
1b1dcc1b 244 mutex_lock(&inode->i_mutex);
1da177e4
LT
245 if (rpci->ops == NULL) {
246 res = -EPIPE;
247 goto out_unlock;
248 }
249 msg = filp->private_data;
250 if (msg == NULL) {
9842ef35 251 spin_lock(&inode->i_lock);
1da177e4
LT
252 if (!list_empty(&rpci->pipe)) {
253 msg = list_entry(rpci->pipe.next,
254 struct rpc_pipe_msg,
255 list);
256 list_move(&msg->list, &rpci->in_upcall);
257 rpci->pipelen -= msg->len;
258 filp->private_data = msg;
259 msg->copied = 0;
260 }
9842ef35 261 spin_unlock(&inode->i_lock);
1da177e4
LT
262 if (msg == NULL)
263 goto out_unlock;
264 }
265 /* NOTE: it is up to the callback to update msg->copied */
266 res = rpci->ops->upcall(filp, msg, buf, len);
267 if (res < 0 || msg->len == msg->copied) {
268 filp->private_data = NULL;
9842ef35
TM
269 spin_lock(&inode->i_lock);
270 list_del(&msg->list);
271 spin_unlock(&inode->i_lock);
1da177e4
LT
272 rpci->ops->destroy_msg(msg);
273 }
274out_unlock:
1b1dcc1b 275 mutex_unlock(&inode->i_mutex);
1da177e4
LT
276 return res;
277}
278
279static ssize_t
280rpc_pipe_write(struct file *filp, const char __user *buf, size_t len, loff_t *offset)
281{
303b46bb 282 struct inode *inode = filp->f_path.dentry->d_inode;
1da177e4
LT
283 struct rpc_inode *rpci = RPC_I(inode);
284 int res;
285
1b1dcc1b 286 mutex_lock(&inode->i_mutex);
1da177e4
LT
287 res = -EPIPE;
288 if (rpci->ops != NULL)
289 res = rpci->ops->downcall(filp, buf, len);
1b1dcc1b 290 mutex_unlock(&inode->i_mutex);
1da177e4
LT
291 return res;
292}
293
294static unsigned int
295rpc_pipe_poll(struct file *filp, struct poll_table_struct *wait)
296{
297 struct rpc_inode *rpci;
298 unsigned int mask = 0;
299
303b46bb 300 rpci = RPC_I(filp->f_path.dentry->d_inode);
1da177e4
LT
301 poll_wait(filp, &rpci->waitq, wait);
302
303 mask = POLLOUT | POLLWRNORM;
304 if (rpci->ops == NULL)
305 mask |= POLLERR | POLLHUP;
eda4f9b7 306 if (filp->private_data || !list_empty(&rpci->pipe))
1da177e4
LT
307 mask |= POLLIN | POLLRDNORM;
308 return mask;
309}
310
311static int
312rpc_pipe_ioctl(struct inode *ino, struct file *filp,
313 unsigned int cmd, unsigned long arg)
314{
303b46bb 315 struct rpc_inode *rpci = RPC_I(filp->f_path.dentry->d_inode);
1da177e4
LT
316 int len;
317
318 switch (cmd) {
319 case FIONREAD:
320 if (rpci->ops == NULL)
321 return -EPIPE;
322 len = rpci->pipelen;
323 if (filp->private_data) {
324 struct rpc_pipe_msg *msg;
325 msg = (struct rpc_pipe_msg *)filp->private_data;
326 len += msg->len - msg->copied;
327 }
328 return put_user(len, (int __user *)arg);
329 default:
330 return -EINVAL;
331 }
332}
333
da7071d7 334static const struct file_operations rpc_pipe_fops = {
1da177e4
LT
335 .owner = THIS_MODULE,
336 .llseek = no_llseek,
337 .read = rpc_pipe_read,
338 .write = rpc_pipe_write,
339 .poll = rpc_pipe_poll,
340 .ioctl = rpc_pipe_ioctl,
341 .open = rpc_pipe_open,
342 .release = rpc_pipe_release,
343};
344
345static int
346rpc_show_info(struct seq_file *m, void *v)
347{
348 struct rpc_clnt *clnt = m->private;
349
350 seq_printf(m, "RPC server: %s\n", clnt->cl_server);
351 seq_printf(m, "service: %s (%d) version %d\n", clnt->cl_protname,
352 clnt->cl_prog, clnt->cl_vers);
e7f78657
CL
353 seq_printf(m, "address: %s\n", rpc_peeraddr2str(clnt, RPC_DISPLAY_ADDR));
354 seq_printf(m, "protocol: %s\n", rpc_peeraddr2str(clnt, RPC_DISPLAY_PROTO));
bf19aace 355 seq_printf(m, "port: %s\n", rpc_peeraddr2str(clnt, RPC_DISPLAY_PORT));
1da177e4
LT
356 return 0;
357}
358
359static int
360rpc_info_open(struct inode *inode, struct file *file)
361{
362 struct rpc_clnt *clnt;
363 int ret = single_open(file, rpc_show_info, NULL);
364
365 if (!ret) {
366 struct seq_file *m = file->private_data;
1b1dcc1b 367 mutex_lock(&inode->i_mutex);
1da177e4
LT
368 clnt = RPC_I(inode)->private;
369 if (clnt) {
34f52e35 370 kref_get(&clnt->cl_kref);
1da177e4
LT
371 m->private = clnt;
372 } else {
373 single_release(inode, file);
374 ret = -EINVAL;
375 }
1b1dcc1b 376 mutex_unlock(&inode->i_mutex);
1da177e4
LT
377 }
378 return ret;
379}
380
381static int
382rpc_info_release(struct inode *inode, struct file *file)
383{
384 struct seq_file *m = file->private_data;
385 struct rpc_clnt *clnt = (struct rpc_clnt *)m->private;
386
387 if (clnt)
388 rpc_release_client(clnt);
389 return single_release(inode, file);
390}
391
da7071d7 392static const struct file_operations rpc_info_operations = {
1da177e4
LT
393 .owner = THIS_MODULE,
394 .open = rpc_info_open,
395 .read = seq_read,
396 .llseek = seq_lseek,
397 .release = rpc_info_release,
398};
399
400
1da177e4
LT
401/*
402 * Description of fs contents.
403 */
404struct rpc_filelist {
ac6fecee 405 const char *name;
99ac48f5 406 const struct file_operations *i_fop;
7364af6a 407 umode_t mode;
1da177e4
LT
408};
409
54281548 410struct vfsmount *rpc_get_mount(void)
1da177e4 411{
54281548
TM
412 int err;
413
1f5ce9e9 414 err = simple_pin_fs(&rpc_pipe_fs_type, &rpc_mount, &rpc_mount_count);
54281548
TM
415 if (err != 0)
416 return ERR_PTR(err);
417 return rpc_mount;
1da177e4 418}
e571cbf1 419EXPORT_SYMBOL_GPL(rpc_get_mount);
1da177e4 420
54281548 421void rpc_put_mount(void)
1da177e4
LT
422{
423 simple_release_fs(&rpc_mount, &rpc_mount_count);
424}
e571cbf1 425EXPORT_SYMBOL_GPL(rpc_put_mount);
1da177e4 426
62e1761c
TM
427static int rpc_delete_dentry(struct dentry *dentry)
428{
429 return 1;
430}
431
3ba13d17 432static const struct dentry_operations rpc_dentry_operations = {
62e1761c
TM
433 .d_delete = rpc_delete_dentry,
434};
435
1da177e4 436static struct inode *
7364af6a 437rpc_get_inode(struct super_block *sb, umode_t mode)
1da177e4
LT
438{
439 struct inode *inode = new_inode(sb);
440 if (!inode)
441 return NULL;
442 inode->i_mode = mode;
1da177e4
LT
443 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
444 switch(mode & S_IFMT) {
445 case S_IFDIR:
446 inode->i_fop = &simple_dir_operations;
447 inode->i_op = &simple_dir_inode_operations;
d8c76e6f 448 inc_nlink(inode);
1da177e4
LT
449 default:
450 break;
451 }
452 return inode;
453}
454
7589806e
TM
455static int __rpc_create_common(struct inode *dir, struct dentry *dentry,
456 umode_t mode,
457 const struct file_operations *i_fop,
458 void *private)
459{
460 struct inode *inode;
461
462 BUG_ON(!d_unhashed(dentry));
463 inode = rpc_get_inode(dir->i_sb, mode);
464 if (!inode)
465 goto out_err;
466 inode->i_ino = iunique(dir->i_sb, 100);
467 if (i_fop)
468 inode->i_fop = i_fop;
469 if (private)
470 rpc_inode_setowner(inode, private);
471 d_add(dentry, inode);
472 return 0;
473out_err:
474 printk(KERN_WARNING "%s: %s failed to allocate inode for dentry %s\n",
475 __FILE__, __func__, dentry->d_name.name);
476 dput(dentry);
477 return -ENOMEM;
478}
479
ac6fecee
TM
480static int __rpc_create(struct inode *dir, struct dentry *dentry,
481 umode_t mode,
482 const struct file_operations *i_fop,
483 void *private)
484{
485 int err;
486
487 err = __rpc_create_common(dir, dentry, S_IFREG | mode, i_fop, private);
488 if (err)
489 return err;
490 fsnotify_create(dir, dentry);
491 return 0;
492}
493
7589806e
TM
494static int __rpc_mkdir(struct inode *dir, struct dentry *dentry,
495 umode_t mode,
496 const struct file_operations *i_fop,
497 void *private)
498{
499 int err;
500
501 err = __rpc_create_common(dir, dentry, S_IFDIR | mode, i_fop, private);
502 if (err)
503 return err;
504 inc_nlink(dir);
505 fsnotify_mkdir(dir, dentry);
506 return 0;
507}
508
509static int __rpc_mkpipe(struct inode *dir, struct dentry *dentry,
510 umode_t mode,
511 const struct file_operations *i_fop,
512 void *private,
513 const struct rpc_pipe_ops *ops,
514 int flags)
515{
516 struct rpc_inode *rpci;
517 int err;
518
519 err = __rpc_create_common(dir, dentry, S_IFIFO | mode, i_fop, private);
520 if (err)
521 return err;
522 rpci = RPC_I(dentry->d_inode);
523 rpci->nkern_readwriters = 1;
524 rpci->private = private;
525 rpci->flags = flags;
526 rpci->ops = ops;
527 fsnotify_create(dir, dentry);
528 return 0;
529}
530
ac6fecee
TM
531static int __rpc_rmdir(struct inode *dir, struct dentry *dentry)
532{
533 int ret;
534
535 dget(dentry);
536 ret = simple_rmdir(dir, dentry);
537 d_delete(dentry);
538 dput(dentry);
539 return ret;
540}
541
810d90bc
TM
542static int __rpc_unlink(struct inode *dir, struct dentry *dentry)
543{
544 int ret;
545
546 dget(dentry);
547 ret = simple_unlink(dir, dentry);
548 d_delete(dentry);
549 dput(dentry);
550 return ret;
551}
552
553static int __rpc_rmpipe(struct inode *dir, struct dentry *dentry)
554{
555 struct inode *inode = dentry->d_inode;
556 struct rpc_inode *rpci = RPC_I(inode);
557
558 rpci->nkern_readwriters--;
559 if (rpci->nkern_readwriters != 0)
560 return 0;
561 rpc_close_pipes(inode);
562 return __rpc_unlink(dir, dentry);
563}
564
cfeaa4a3
TM
565static struct dentry *__rpc_lookup_create(struct dentry *parent,
566 struct qstr *name)
567{
568 struct dentry *dentry;
569
570 dentry = d_lookup(parent, name);
571 if (!dentry) {
572 dentry = d_alloc(parent, name);
573 if (!dentry) {
574 dentry = ERR_PTR(-ENOMEM);
575 goto out_err;
576 }
577 }
578 if (!dentry->d_inode)
579 dentry->d_op = &rpc_dentry_operations;
580out_err:
581 return dentry;
582}
583
584static struct dentry *__rpc_lookup_create_exclusive(struct dentry *parent,
585 struct qstr *name)
586{
587 struct dentry *dentry;
588
589 dentry = __rpc_lookup_create(parent, name);
f1f0abe1
DC
590 if (IS_ERR(dentry))
591 return dentry;
cfeaa4a3
TM
592 if (dentry->d_inode == NULL)
593 return dentry;
594 dput(dentry);
595 return ERR_PTR(-EEXIST);
596}
597
1da177e4
LT
598/*
599 * FIXME: This probably has races.
600 */
ac6fecee
TM
601static void __rpc_depopulate(struct dentry *parent,
602 const struct rpc_filelist *files,
603 int start, int eof)
1da177e4
LT
604{
605 struct inode *dir = parent->d_inode;
ac6fecee
TM
606 struct dentry *dentry;
607 struct qstr name;
608 int i;
1da177e4 609
ac6fecee
TM
610 for (i = start; i < eof; i++) {
611 name.name = files[i].name;
612 name.len = strlen(files[i].name);
613 name.hash = full_name_hash(name.name, name.len);
614 dentry = d_lookup(parent, &name);
615
616 if (dentry == NULL)
62e1761c 617 continue;
ac6fecee
TM
618 if (dentry->d_inode == NULL)
619 goto next;
620 switch (dentry->d_inode->i_mode & S_IFMT) {
621 default:
622 BUG();
623 case S_IFREG:
624 __rpc_unlink(dir, dentry);
1da177e4 625 break;
ac6fecee
TM
626 case S_IFDIR:
627 __rpc_rmdir(dir, dentry);
628 }
629next:
630 dput(dentry);
1da177e4 631 }
ac6fecee
TM
632}
633
634static void rpc_depopulate(struct dentry *parent,
635 const struct rpc_filelist *files,
636 int start, int eof)
637{
638 struct inode *dir = parent->d_inode;
639
640 mutex_lock_nested(&dir->i_mutex, I_MUTEX_CHILD);
641 __rpc_depopulate(parent, files, start, eof);
1b1dcc1b 642 mutex_unlock(&dir->i_mutex);
1da177e4
LT
643}
644
ac6fecee
TM
645static int rpc_populate(struct dentry *parent,
646 const struct rpc_filelist *files,
647 int start, int eof,
648 void *private)
1da177e4 649{
ac6fecee 650 struct inode *dir = parent->d_inode;
1da177e4 651 struct dentry *dentry;
ac6fecee 652 int i, err;
1da177e4 653
1b1dcc1b 654 mutex_lock(&dir->i_mutex);
1da177e4 655 for (i = start; i < eof; i++) {
ac6fecee
TM
656 struct qstr q;
657
658 q.name = files[i].name;
659 q.len = strlen(files[i].name);
660 q.hash = full_name_hash(q.name, q.len);
661 dentry = __rpc_lookup_create_exclusive(parent, &q);
662 err = PTR_ERR(dentry);
663 if (IS_ERR(dentry))
1da177e4 664 goto out_bad;
ac6fecee
TM
665 switch (files[i].mode & S_IFMT) {
666 default:
667 BUG();
668 case S_IFREG:
669 err = __rpc_create(dir, dentry,
670 files[i].mode,
671 files[i].i_fop,
672 private);
673 break;
674 case S_IFDIR:
675 err = __rpc_mkdir(dir, dentry,
676 files[i].mode,
677 NULL,
678 private);
1da177e4 679 }
ac6fecee
TM
680 if (err != 0)
681 goto out_bad;
1da177e4 682 }
1b1dcc1b 683 mutex_unlock(&dir->i_mutex);
1da177e4
LT
684 return 0;
685out_bad:
ac6fecee 686 __rpc_depopulate(parent, files, start, eof);
1b1dcc1b 687 mutex_unlock(&dir->i_mutex);
1da177e4 688 printk(KERN_WARNING "%s: %s failed to populate directory %s\n",
0dc47877 689 __FILE__, __func__, parent->d_name.name);
ac6fecee 690 return err;
f134585a 691}
1da177e4 692
e57aed77
TM
693static struct dentry *rpc_mkdir_populate(struct dentry *parent,
694 struct qstr *name, umode_t mode, void *private,
695 int (*populate)(struct dentry *, void *), void *args_populate)
f134585a 696{
f134585a 697 struct dentry *dentry;
7d59d1e8 698 struct inode *dir = parent->d_inode;
f134585a
TM
699 int error;
700
7d59d1e8
TM
701 mutex_lock_nested(&dir->i_mutex, I_MUTEX_PARENT);
702 dentry = __rpc_lookup_create_exclusive(parent, name);
f134585a 703 if (IS_ERR(dentry))
7d59d1e8
TM
704 goto out;
705 error = __rpc_mkdir(dir, dentry, mode, NULL, private);
7589806e
TM
706 if (error != 0)
707 goto out_err;
e57aed77
TM
708 if (populate != NULL) {
709 error = populate(dentry, args_populate);
710 if (error)
711 goto err_rmdir;
712 }
f134585a 713out:
1b1dcc1b 714 mutex_unlock(&dir->i_mutex);
5c3e985a 715 return dentry;
ac6fecee 716err_rmdir:
f134585a 717 __rpc_rmdir(dir, dentry);
7589806e 718out_err:
f134585a
TM
719 dentry = ERR_PTR(error);
720 goto out;
1da177e4
LT
721}
722
e57aed77
TM
723static int rpc_rmdir_depopulate(struct dentry *dentry,
724 void (*depopulate)(struct dentry *))
1da177e4 725{
dff02cc1 726 struct dentry *parent;
f134585a
TM
727 struct inode *dir;
728 int error;
278c995c 729
dff02cc1
TM
730 parent = dget_parent(dentry);
731 dir = parent->d_inode;
c6573c29 732 mutex_lock_nested(&dir->i_mutex, I_MUTEX_PARENT);
e57aed77
TM
733 if (depopulate != NULL)
734 depopulate(dentry);
f134585a 735 error = __rpc_rmdir(dir, dentry);
1b1dcc1b 736 mutex_unlock(&dir->i_mutex);
dff02cc1 737 dput(parent);
f134585a 738 return error;
1da177e4
LT
739}
740
93a44a75
BF
741/**
742 * rpc_mkpipe - make an rpc_pipefs file for kernel<->userspace communication
743 * @parent: dentry of directory to create new "pipe" in
744 * @name: name of pipe
745 * @private: private data to associate with the pipe, for the caller's use
746 * @ops: operations defining the behavior of the pipe: upcall, downcall,
c3810608 747 * release_pipe, open_pipe, and destroy_msg.
65b6e42c 748 * @flags: rpc_inode flags
93a44a75
BF
749 *
750 * Data is made available for userspace to read by calls to
751 * rpc_queue_upcall(). The actual reads will result in calls to
752 * @ops->upcall, which will be called with the file pointer,
753 * message, and userspace buffer to copy to.
754 *
755 * Writes can come at any time, and do not necessarily have to be
756 * responses to upcalls. They will result in calls to @msg->downcall.
757 *
758 * The @private argument passed here will be available to all these methods
759 * from the file pointer, via RPC_I(file->f_dentry->d_inode)->private.
760 */
b693ba4a
TM
761struct dentry *rpc_mkpipe(struct dentry *parent, const char *name,
762 void *private, const struct rpc_pipe_ops *ops,
763 int flags)
1da177e4 764{
1da177e4 765 struct dentry *dentry;
7589806e 766 struct inode *dir = parent->d_inode;
7364af6a 767 umode_t umode = S_IFIFO | S_IRUSR | S_IWUSR;
cfeaa4a3 768 struct qstr q;
7589806e 769 int err;
7364af6a
TM
770
771 if (ops->upcall == NULL)
772 umode &= ~S_IRUGO;
773 if (ops->downcall == NULL)
774 umode &= ~S_IWUGO;
1da177e4 775
cfeaa4a3
TM
776 q.name = name;
777 q.len = strlen(name);
778 q.hash = full_name_hash(q.name, q.len),
779
780 mutex_lock_nested(&dir->i_mutex, I_MUTEX_PARENT);
781 dentry = __rpc_lookup_create(parent, &q);
1da177e4 782 if (IS_ERR(dentry))
cfeaa4a3 783 goto out;
34f30896 784 if (dentry->d_inode) {
7589806e 785 struct rpc_inode *rpci = RPC_I(dentry->d_inode);
34f30896
TM
786 if (rpci->private != private ||
787 rpci->ops != ops ||
788 rpci->flags != flags) {
789 dput (dentry);
810d90bc
TM
790 err = -EBUSY;
791 goto out_err;
34f30896 792 }
03a1256f 793 rpci->nkern_readwriters++;
34f30896
TM
794 goto out;
795 }
7589806e
TM
796
797 err = __rpc_mkpipe(dir, dentry, umode, &rpc_pipe_fops,
810d90bc 798 private, ops, flags);
7589806e
TM
799 if (err)
800 goto out_err;
f134585a 801out:
1b1dcc1b 802 mutex_unlock(&dir->i_mutex);
5c3e985a 803 return dentry;
7589806e
TM
804out_err:
805 dentry = ERR_PTR(err);
158998b6 806 printk(KERN_WARNING "%s: %s() failed to create pipe %s/%s (errno = %d)\n",
0dc47877 807 __FILE__, __func__, parent->d_name.name, name,
7589806e 808 err);
f134585a 809 goto out;
1da177e4 810}
468039ee 811EXPORT_SYMBOL_GPL(rpc_mkpipe);
1da177e4 812
93a44a75
BF
813/**
814 * rpc_unlink - remove a pipe
815 * @dentry: dentry for the pipe, as returned from rpc_mkpipe
816 *
817 * After this call, lookups will no longer find the pipe, and any
818 * attempts to read or write using preexisting opens of the pipe will
819 * return -EPIPE.
820 */
f134585a 821int
5d67476f 822rpc_unlink(struct dentry *dentry)
1da177e4 823{
5d67476f 824 struct dentry *parent;
f134585a 825 struct inode *dir;
5d67476f 826 int error = 0;
1da177e4 827
5d67476f
TM
828 parent = dget_parent(dentry);
829 dir = parent->d_inode;
c6573c29 830 mutex_lock_nested(&dir->i_mutex, I_MUTEX_PARENT);
810d90bc 831 error = __rpc_rmpipe(dir, dentry);
1b1dcc1b 832 mutex_unlock(&dir->i_mutex);
5d67476f 833 dput(parent);
f134585a 834 return error;
1da177e4 835}
468039ee 836EXPORT_SYMBOL_GPL(rpc_unlink);
1da177e4 837
e57aed77
TM
838enum {
839 RPCAUTH_info,
840 RPCAUTH_EOF
841};
842
843static const struct rpc_filelist authfiles[] = {
844 [RPCAUTH_info] = {
845 .name = "info",
846 .i_fop = &rpc_info_operations,
847 .mode = S_IFREG | S_IRUSR,
848 },
849};
850
851static int rpc_clntdir_populate(struct dentry *dentry, void *private)
852{
853 return rpc_populate(dentry,
854 authfiles, RPCAUTH_info, RPCAUTH_EOF,
855 private);
856}
857
858static void rpc_clntdir_depopulate(struct dentry *dentry)
859{
860 rpc_depopulate(dentry, authfiles, RPCAUTH_info, RPCAUTH_EOF);
861}
862
7d59d1e8
TM
863/**
864 * rpc_create_client_dir - Create a new rpc_client directory in rpc_pipefs
4111d4fd
RD
865 * @dentry: dentry from the rpc_pipefs root to the new directory
866 * @name: &struct qstr for the name
7d59d1e8
TM
867 * @rpc_client: rpc client to associate with this directory
868 *
869 * This creates a directory at the given @path associated with
870 * @rpc_clnt, which will contain a file named "info" with some basic
871 * information about the client, together with any "pipes" that may
872 * later be created using rpc_mkpipe().
873 */
23ac6581 874struct dentry *rpc_create_client_dir(struct dentry *dentry,
e57aed77
TM
875 struct qstr *name,
876 struct rpc_clnt *rpc_client)
877{
878 return rpc_mkdir_populate(dentry, name, S_IRUGO | S_IXUGO, NULL,
879 rpc_clntdir_populate, rpc_client);
880}
881
882/**
883 * rpc_remove_client_dir - Remove a directory created with rpc_create_client_dir()
884 * @dentry: directory to remove
885 */
886int rpc_remove_client_dir(struct dentry *dentry)
7d59d1e8 887{
e57aed77 888 return rpc_rmdir_depopulate(dentry, rpc_clntdir_depopulate);
7d59d1e8
TM
889}
890
8854e82d
TM
891static const struct rpc_filelist cache_pipefs_files[3] = {
892 [0] = {
893 .name = "channel",
894 .i_fop = &cache_file_operations_pipefs,
96c61cbd 895 .mode = S_IFREG|S_IRUSR|S_IWUSR,
8854e82d
TM
896 },
897 [1] = {
898 .name = "content",
899 .i_fop = &content_file_operations_pipefs,
900 .mode = S_IFREG|S_IRUSR,
901 },
902 [2] = {
903 .name = "flush",
904 .i_fop = &cache_flush_operations_pipefs,
905 .mode = S_IFREG|S_IRUSR|S_IWUSR,
906 },
907};
908
909static int rpc_cachedir_populate(struct dentry *dentry, void *private)
910{
911 return rpc_populate(dentry,
912 cache_pipefs_files, 0, 3,
913 private);
914}
915
916static void rpc_cachedir_depopulate(struct dentry *dentry)
917{
918 rpc_depopulate(dentry, cache_pipefs_files, 0, 3);
919}
920
921struct dentry *rpc_create_cache_dir(struct dentry *parent, struct qstr *name,
922 mode_t umode, struct cache_detail *cd)
923{
924 return rpc_mkdir_populate(parent, name, umode, NULL,
925 rpc_cachedir_populate, cd);
926}
927
928void rpc_remove_cache_dir(struct dentry *dentry)
929{
930 rpc_rmdir_depopulate(dentry, rpc_cachedir_depopulate);
931}
932
1da177e4
LT
933/*
934 * populate the filesystem
935 */
b87221de 936static const struct super_operations s_ops = {
1da177e4
LT
937 .alloc_inode = rpc_alloc_inode,
938 .destroy_inode = rpc_destroy_inode,
939 .statfs = simple_statfs,
940};
941
942#define RPCAUTH_GSSMAGIC 0x67596969
943
bb156749
TM
944/*
945 * We have a single directory with 1 node in it.
946 */
947enum {
948 RPCAUTH_lockd,
949 RPCAUTH_mount,
950 RPCAUTH_nfs,
951 RPCAUTH_portmap,
952 RPCAUTH_statd,
953 RPCAUTH_nfsd4_cb,
e571cbf1 954 RPCAUTH_cache,
bb156749
TM
955 RPCAUTH_RootEOF
956};
957
958static const struct rpc_filelist files[] = {
959 [RPCAUTH_lockd] = {
960 .name = "lockd",
961 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
962 },
963 [RPCAUTH_mount] = {
964 .name = "mount",
965 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
966 },
967 [RPCAUTH_nfs] = {
968 .name = "nfs",
969 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
970 },
971 [RPCAUTH_portmap] = {
972 .name = "portmap",
973 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
974 },
975 [RPCAUTH_statd] = {
976 .name = "statd",
977 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
978 },
979 [RPCAUTH_nfsd4_cb] = {
980 .name = "nfsd4_cb",
981 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
982 },
e571cbf1
TM
983 [RPCAUTH_cache] = {
984 .name = "cache",
985 .mode = S_IFDIR | S_IRUGO | S_IXUGO,
986 },
bb156749
TM
987};
988
1da177e4
LT
989static int
990rpc_fill_super(struct super_block *sb, void *data, int silent)
991{
992 struct inode *inode;
993 struct dentry *root;
994
995 sb->s_blocksize = PAGE_CACHE_SIZE;
996 sb->s_blocksize_bits = PAGE_CACHE_SHIFT;
997 sb->s_magic = RPCAUTH_GSSMAGIC;
998 sb->s_op = &s_ops;
999 sb->s_time_gran = 1;
1000
1001 inode = rpc_get_inode(sb, S_IFDIR | 0755);
1002 if (!inode)
1003 return -ENOMEM;
fc7bed8c 1004 sb->s_root = root = d_alloc_root(inode);
1da177e4
LT
1005 if (!root) {
1006 iput(inode);
1007 return -ENOMEM;
1008 }
ac6fecee 1009 if (rpc_populate(root, files, RPCAUTH_lockd, RPCAUTH_RootEOF, NULL))
fc7bed8c 1010 return -ENOMEM;
1da177e4 1011 return 0;
1da177e4
LT
1012}
1013
454e2398 1014static int
1da177e4 1015rpc_get_sb(struct file_system_type *fs_type,
454e2398 1016 int flags, const char *dev_name, void *data, struct vfsmount *mnt)
1da177e4 1017{
454e2398 1018 return get_sb_single(fs_type, flags, data, rpc_fill_super, mnt);
1da177e4
LT
1019}
1020
1021static struct file_system_type rpc_pipe_fs_type = {
1022 .owner = THIS_MODULE,
1023 .name = "rpc_pipefs",
1024 .get_sb = rpc_get_sb,
1025 .kill_sb = kill_litter_super,
1026};
1027
1028static void
51cc5068 1029init_once(void *foo)
1da177e4
LT
1030{
1031 struct rpc_inode *rpci = (struct rpc_inode *) foo;
1032
a35afb83
CL
1033 inode_init_once(&rpci->vfs_inode);
1034 rpci->private = NULL;
1035 rpci->nreaders = 0;
1036 rpci->nwriters = 0;
1037 INIT_LIST_HEAD(&rpci->in_upcall);
6e84c7b6 1038 INIT_LIST_HEAD(&rpci->in_downcall);
a35afb83
CL
1039 INIT_LIST_HEAD(&rpci->pipe);
1040 rpci->pipelen = 0;
1041 init_waitqueue_head(&rpci->waitq);
1042 INIT_DELAYED_WORK(&rpci->queue_timeout,
1043 rpc_timeout_upcall_queue);
1044 rpci->ops = NULL;
1da177e4
LT
1045}
1046
1047int register_rpc_pipefs(void)
1048{
5bd5f581
AM
1049 int err;
1050
1da177e4 1051 rpc_inode_cachep = kmem_cache_create("rpc_inode_cache",
fffb60f9
PJ
1052 sizeof(struct rpc_inode),
1053 0, (SLAB_HWCACHE_ALIGN|SLAB_RECLAIM_ACCOUNT|
1054 SLAB_MEM_SPREAD),
20c2df83 1055 init_once);
1da177e4
LT
1056 if (!rpc_inode_cachep)
1057 return -ENOMEM;
5bd5f581
AM
1058 err = register_filesystem(&rpc_pipe_fs_type);
1059 if (err) {
1060 kmem_cache_destroy(rpc_inode_cachep);
1061 return err;
1062 }
1063
1da177e4
LT
1064 return 0;
1065}
1066
1067void unregister_rpc_pipefs(void)
1068{
1a1d92c1 1069 kmem_cache_destroy(rpc_inode_cachep);
1da177e4
LT
1070 unregister_filesystem(&rpc_pipe_fs_type);
1071}