rpc_pipe.c 23.3 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5
/*
 * net/sunrpc/rpc_pipe.c
 *
 * Userland/kernel interface for rpcauth_gss.
 * Code shamelessly plagiarized from fs/nfsd/nfsctl.c
6
 * and fs/sysfs/inode.c
L
Linus Torvalds 已提交
7 8 9 10 11 12 13 14 15 16
 *
 * Copyright (c) 2002, Trond Myklebust <trond.myklebust@fys.uio.no>
 *
 */
#include <linux/module.h>
#include <linux/slab.h>
#include <linux/string.h>
#include <linux/pagemap.h>
#include <linux/mount.h>
#include <linux/namei.h>
17
#include <linux/fsnotify.h>
L
Linus Torvalds 已提交
18 19 20 21 22 23 24 25 26 27 28 29
#include <linux/kernel.h>

#include <asm/ioctls.h>
#include <linux/fs.h>
#include <linux/poll.h>
#include <linux/wait.h>
#include <linux/seq_file.h>

#include <linux/sunrpc/clnt.h>
#include <linux/workqueue.h>
#include <linux/sunrpc/rpc_pipe_fs.h>

30
static struct vfsmount *rpc_mount __read_mostly;
L
Linus Torvalds 已提交
31 32 33 34 35
static int rpc_mount_count;

static struct file_system_type rpc_pipe_fs_type;


36
static struct kmem_cache *rpc_inode_cachep __read_mostly;
L
Linus Torvalds 已提交
37 38 39

#define RPC_UPCALL_TIMEOUT (30*HZ)

40 41
static void rpc_purge_list(struct rpc_inode *rpci, struct list_head *head,
		void (*destroy_msg)(struct rpc_pipe_msg *), int err)
L
Linus Torvalds 已提交
42 43 44
{
	struct rpc_pipe_msg *msg;

45 46 47
	if (list_empty(head))
		return;
	do {
48
		msg = list_entry(head->next, struct rpc_pipe_msg, list);
49
		list_del(&msg->list);
L
Linus Torvalds 已提交
50
		msg->errno = err;
51
		destroy_msg(msg);
52
	} while (!list_empty(head));
L
Linus Torvalds 已提交
53 54 55 56
	wake_up(&rpci->waitq);
}

static void
57
rpc_timeout_upcall_queue(struct work_struct *work)
L
Linus Torvalds 已提交
58
{
59
	LIST_HEAD(free_list);
60 61
	struct rpc_inode *rpci =
		container_of(work, struct rpc_inode, queue_timeout.work);
L
Linus Torvalds 已提交
62
	struct inode *inode = &rpci->vfs_inode;
63
	void (*destroy_msg)(struct rpc_pipe_msg *);
L
Linus Torvalds 已提交
64

65 66 67 68 69 70 71 72 73 74 75 76
	spin_lock(&inode->i_lock);
	if (rpci->ops == NULL) {
		spin_unlock(&inode->i_lock);
		return;
	}
	destroy_msg = rpci->ops->destroy_msg;
	if (rpci->nreaders == 0) {
		list_splice_init(&rpci->pipe, &free_list);
		rpci->pipelen = 0;
	}
	spin_unlock(&inode->i_lock);
	rpc_purge_list(rpci, &free_list, destroy_msg, -ETIMEDOUT);
L
Linus Torvalds 已提交
77 78
}

79 80 81 82 83 84 85 86 87 88
/**
 * rpc_queue_upcall
 * @inode: inode of upcall pipe on which to queue given message
 * @msg: message to queue
 *
 * Call with an @inode created by rpc_mkpipe() to queue an upcall.
 * A userspace process may then later read the upcall by performing a
 * read on an open file for this inode.  It is up to the caller to
 * initialize the fields of @msg (other than @msg->list) appropriately.
 */
L
Linus Torvalds 已提交
89 90 91 92
int
rpc_queue_upcall(struct inode *inode, struct rpc_pipe_msg *msg)
{
	struct rpc_inode *rpci = RPC_I(inode);
93
	int res = -EPIPE;
L
Linus Torvalds 已提交
94

95
	spin_lock(&inode->i_lock);
96 97
	if (rpci->ops == NULL)
		goto out;
L
Linus Torvalds 已提交
98 99 100
	if (rpci->nreaders) {
		list_add_tail(&msg->list, &rpci->pipe);
		rpci->pipelen += msg->len;
101
		res = 0;
L
Linus Torvalds 已提交
102 103
	} else if (rpci->flags & RPC_PIPE_WAIT_FOR_OPEN) {
		if (list_empty(&rpci->pipe))
104 105
			queue_delayed_work(rpciod_workqueue,
					&rpci->queue_timeout,
L
Linus Torvalds 已提交
106 107 108
					RPC_UPCALL_TIMEOUT);
		list_add_tail(&msg->list, &rpci->pipe);
		rpci->pipelen += msg->len;
109 110 111
		res = 0;
	}
out:
112
	spin_unlock(&inode->i_lock);
L
Linus Torvalds 已提交
113 114 115
	wake_up(&rpci->waitq);
	return res;
}
116
EXPORT_SYMBOL_GPL(rpc_queue_upcall);
L
Linus Torvalds 已提交
117

118 119 120 121 122 123
static inline void
rpc_inode_setowner(struct inode *inode, void *private)
{
	RPC_I(inode)->private = private;
}

L
Linus Torvalds 已提交
124 125 126 127
static void
rpc_close_pipes(struct inode *inode)
{
	struct rpc_inode *rpci = RPC_I(inode);
128
	const struct rpc_pipe_ops *ops;
129
	int need_release;
L
Linus Torvalds 已提交
130

131
	mutex_lock(&inode->i_mutex);
132 133 134 135
	ops = rpci->ops;
	if (ops != NULL) {
		LIST_HEAD(free_list);
		spin_lock(&inode->i_lock);
136
		need_release = rpci->nreaders != 0 || rpci->nwriters != 0;
L
Linus Torvalds 已提交
137
		rpci->nreaders = 0;
138 139 140
		list_splice_init(&rpci->in_upcall, &free_list);
		list_splice_init(&rpci->pipe, &free_list);
		rpci->pipelen = 0;
L
Linus Torvalds 已提交
141
		rpci->ops = NULL;
142 143 144
		spin_unlock(&inode->i_lock);
		rpc_purge_list(rpci, &free_list, ops->destroy_msg, -EPIPE);
		rpci->nwriters = 0;
145
		if (need_release && ops->release_pipe)
146
			ops->release_pipe(inode);
147
		cancel_delayed_work_sync(&rpci->queue_timeout);
L
Linus Torvalds 已提交
148
	}
149
	rpc_inode_setowner(inode, NULL);
150
	mutex_unlock(&inode->i_mutex);
L
Linus Torvalds 已提交
151 152 153 154 155 156
}

static struct inode *
rpc_alloc_inode(struct super_block *sb)
{
	struct rpc_inode *rpci;
157
	rpci = (struct rpc_inode *)kmem_cache_alloc(rpc_inode_cachep, GFP_KERNEL);
L
Linus Torvalds 已提交
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
	if (!rpci)
		return NULL;
	return &rpci->vfs_inode;
}

static void
rpc_destroy_inode(struct inode *inode)
{
	kmem_cache_free(rpc_inode_cachep, RPC_I(inode));
}

static int
rpc_pipe_open(struct inode *inode, struct file *filp)
{
	struct rpc_inode *rpci = RPC_I(inode);
173
	int first_open;
L
Linus Torvalds 已提交
174 175
	int res = -ENXIO;

176
	mutex_lock(&inode->i_mutex);
177 178 179 180 181 182 183
	if (rpci->ops == NULL)
		goto out;
	first_open = rpci->nreaders == 0 && rpci->nwriters == 0;
	if (first_open && rpci->ops->open_pipe) {
		res = rpci->ops->open_pipe(inode);
		if (res)
			goto out;
L
Linus Torvalds 已提交
184
	}
185 186 187 188 189 190
	if (filp->f_mode & FMODE_READ)
		rpci->nreaders++;
	if (filp->f_mode & FMODE_WRITE)
		rpci->nwriters++;
	res = 0;
out:
191
	mutex_unlock(&inode->i_mutex);
L
Linus Torvalds 已提交
192 193 194 195 196 197
	return res;
}

static int
rpc_pipe_release(struct inode *inode, struct file *filp)
{
198
	struct rpc_inode *rpci = RPC_I(inode);
L
Linus Torvalds 已提交
199
	struct rpc_pipe_msg *msg;
200
	int last_close;
L
Linus Torvalds 已提交
201

202
	mutex_lock(&inode->i_mutex);
L
Linus Torvalds 已提交
203 204 205 206
	if (rpci->ops == NULL)
		goto out;
	msg = (struct rpc_pipe_msg *)filp->private_data;
	if (msg != NULL) {
207
		spin_lock(&inode->i_lock);
208
		msg->errno = -EAGAIN;
209 210
		list_del(&msg->list);
		spin_unlock(&inode->i_lock);
L
Linus Torvalds 已提交
211 212 213 214
		rpci->ops->destroy_msg(msg);
	}
	if (filp->f_mode & FMODE_WRITE)
		rpci->nwriters --;
215
	if (filp->f_mode & FMODE_READ) {
L
Linus Torvalds 已提交
216
		rpci->nreaders --;
217 218 219 220 221 222 223 224 225 226
		if (rpci->nreaders == 0) {
			LIST_HEAD(free_list);
			spin_lock(&inode->i_lock);
			list_splice_init(&rpci->pipe, &free_list);
			rpci->pipelen = 0;
			spin_unlock(&inode->i_lock);
			rpc_purge_list(rpci, &free_list,
					rpci->ops->destroy_msg, -EAGAIN);
		}
	}
227 228
	last_close = rpci->nwriters == 0 && rpci->nreaders == 0;
	if (last_close && rpci->ops->release_pipe)
L
Linus Torvalds 已提交
229 230
		rpci->ops->release_pipe(inode);
out:
231
	mutex_unlock(&inode->i_mutex);
L
Linus Torvalds 已提交
232 233 234 235 236 237
	return 0;
}

static ssize_t
rpc_pipe_read(struct file *filp, char __user *buf, size_t len, loff_t *offset)
{
J
Josef Sipek 已提交
238
	struct inode *inode = filp->f_path.dentry->d_inode;
L
Linus Torvalds 已提交
239 240 241 242
	struct rpc_inode *rpci = RPC_I(inode);
	struct rpc_pipe_msg *msg;
	int res = 0;

243
	mutex_lock(&inode->i_mutex);
L
Linus Torvalds 已提交
244 245 246 247 248 249
	if (rpci->ops == NULL) {
		res = -EPIPE;
		goto out_unlock;
	}
	msg = filp->private_data;
	if (msg == NULL) {
250
		spin_lock(&inode->i_lock);
L
Linus Torvalds 已提交
251 252 253 254 255 256 257 258 259
		if (!list_empty(&rpci->pipe)) {
			msg = list_entry(rpci->pipe.next,
					struct rpc_pipe_msg,
					list);
			list_move(&msg->list, &rpci->in_upcall);
			rpci->pipelen -= msg->len;
			filp->private_data = msg;
			msg->copied = 0;
		}
260
		spin_unlock(&inode->i_lock);
L
Linus Torvalds 已提交
261 262 263 264 265 266 267
		if (msg == NULL)
			goto out_unlock;
	}
	/* NOTE: it is up to the callback to update msg->copied */
	res = rpci->ops->upcall(filp, msg, buf, len);
	if (res < 0 || msg->len == msg->copied) {
		filp->private_data = NULL;
268 269 270
		spin_lock(&inode->i_lock);
		list_del(&msg->list);
		spin_unlock(&inode->i_lock);
L
Linus Torvalds 已提交
271 272 273
		rpci->ops->destroy_msg(msg);
	}
out_unlock:
274
	mutex_unlock(&inode->i_mutex);
L
Linus Torvalds 已提交
275 276 277 278 279 280
	return res;
}

static ssize_t
rpc_pipe_write(struct file *filp, const char __user *buf, size_t len, loff_t *offset)
{
J
Josef Sipek 已提交
281
	struct inode *inode = filp->f_path.dentry->d_inode;
L
Linus Torvalds 已提交
282 283 284
	struct rpc_inode *rpci = RPC_I(inode);
	int res;

285
	mutex_lock(&inode->i_mutex);
L
Linus Torvalds 已提交
286 287 288
	res = -EPIPE;
	if (rpci->ops != NULL)
		res = rpci->ops->downcall(filp, buf, len);
289
	mutex_unlock(&inode->i_mutex);
L
Linus Torvalds 已提交
290 291 292 293 294 295 296 297 298
	return res;
}

static unsigned int
rpc_pipe_poll(struct file *filp, struct poll_table_struct *wait)
{
	struct rpc_inode *rpci;
	unsigned int mask = 0;

J
Josef Sipek 已提交
299
	rpci = RPC_I(filp->f_path.dentry->d_inode);
L
Linus Torvalds 已提交
300 301 302 303 304
	poll_wait(filp, &rpci->waitq, wait);

	mask = POLLOUT | POLLWRNORM;
	if (rpci->ops == NULL)
		mask |= POLLERR | POLLHUP;
305
	if (filp->private_data || !list_empty(&rpci->pipe))
L
Linus Torvalds 已提交
306 307 308 309 310 311 312 313
		mask |= POLLIN | POLLRDNORM;
	return mask;
}

static int
rpc_pipe_ioctl(struct inode *ino, struct file *filp,
		unsigned int cmd, unsigned long arg)
{
J
Josef Sipek 已提交
314
	struct rpc_inode *rpci = RPC_I(filp->f_path.dentry->d_inode);
L
Linus Torvalds 已提交
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
	int len;

	switch (cmd) {
	case FIONREAD:
		if (rpci->ops == NULL)
			return -EPIPE;
		len = rpci->pipelen;
		if (filp->private_data) {
			struct rpc_pipe_msg *msg;
			msg = (struct rpc_pipe_msg *)filp->private_data;
			len += msg->len - msg->copied;
		}
		return put_user(len, (int __user *)arg);
	default:
		return -EINVAL;
	}
}

333
static const struct file_operations rpc_pipe_fops = {
L
Linus Torvalds 已提交
334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
	.owner		= THIS_MODULE,
	.llseek		= no_llseek,
	.read		= rpc_pipe_read,
	.write		= rpc_pipe_write,
	.poll		= rpc_pipe_poll,
	.ioctl		= rpc_pipe_ioctl,
	.open		= rpc_pipe_open,
	.release	= rpc_pipe_release,
};

static int
rpc_show_info(struct seq_file *m, void *v)
{
	struct rpc_clnt *clnt = m->private;

	seq_printf(m, "RPC server: %s\n", clnt->cl_server);
	seq_printf(m, "service: %s (%d) version %d\n", clnt->cl_protname,
			clnt->cl_prog, clnt->cl_vers);
352 353
	seq_printf(m, "address: %s\n", rpc_peeraddr2str(clnt, RPC_DISPLAY_ADDR));
	seq_printf(m, "protocol: %s\n", rpc_peeraddr2str(clnt, RPC_DISPLAY_PROTO));
354
	seq_printf(m, "port: %s\n", rpc_peeraddr2str(clnt, RPC_DISPLAY_PORT));
L
Linus Torvalds 已提交
355 356 357 358 359 360 361 362 363 364 365
	return 0;
}

static int
rpc_info_open(struct inode *inode, struct file *file)
{
	struct rpc_clnt *clnt;
	int ret = single_open(file, rpc_show_info, NULL);

	if (!ret) {
		struct seq_file *m = file->private_data;
366
		mutex_lock(&inode->i_mutex);
L
Linus Torvalds 已提交
367 368
		clnt = RPC_I(inode)->private;
		if (clnt) {
369
			kref_get(&clnt->cl_kref);
L
Linus Torvalds 已提交
370 371 372 373 374
			m->private = clnt;
		} else {
			single_release(inode, file);
			ret = -EINVAL;
		}
375
		mutex_unlock(&inode->i_mutex);
L
Linus Torvalds 已提交
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390
	}
	return ret;
}

static int
rpc_info_release(struct inode *inode, struct file *file)
{
	struct seq_file *m = file->private_data;
	struct rpc_clnt *clnt = (struct rpc_clnt *)m->private;

	if (clnt)
		rpc_release_client(clnt);
	return single_release(inode, file);
}

391
static const struct file_operations rpc_info_operations = {
L
Linus Torvalds 已提交
392 393 394 395 396 397 398 399 400 401 402 403
	.owner		= THIS_MODULE,
	.open		= rpc_info_open,
	.read		= seq_read,
	.llseek		= seq_lseek,
	.release	= rpc_info_release,
};


/*
 * Description of fs contents.
 */
struct rpc_filelist {
404
	const char *name;
405
	const struct file_operations *i_fop;
406
	umode_t mode;
L
Linus Torvalds 已提交
407 408
};

409
struct vfsmount *rpc_get_mount(void)
L
Linus Torvalds 已提交
410
{
411 412
	int err;

413
	err = simple_pin_fs(&rpc_pipe_fs_type, &rpc_mount, &rpc_mount_count);
414 415 416
	if (err != 0)
		return ERR_PTR(err);
	return rpc_mount;
L
Linus Torvalds 已提交
417 418
}

419
void rpc_put_mount(void)
L
Linus Torvalds 已提交
420 421 422 423
{
	simple_release_fs(&rpc_mount, &rpc_mount_count);
}

T
Trond Myklebust 已提交
424 425 426 427 428
static int rpc_delete_dentry(struct dentry *dentry)
{
	return 1;
}

A
Al Viro 已提交
429
static const struct dentry_operations rpc_dentry_operations = {
T
Trond Myklebust 已提交
430 431 432
	.d_delete = rpc_delete_dentry,
};

L
Linus Torvalds 已提交
433
static struct inode *
434
rpc_get_inode(struct super_block *sb, umode_t mode)
L
Linus Torvalds 已提交
435 436 437 438 439 440 441 442 443 444
{
	struct inode *inode = new_inode(sb);
	if (!inode)
		return NULL;
	inode->i_mode = mode;
	inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
	switch(mode & S_IFMT) {
		case S_IFDIR:
			inode->i_fop = &simple_dir_operations;
			inode->i_op = &simple_dir_inode_operations;
445
			inc_nlink(inode);
L
Linus Torvalds 已提交
446 447 448 449 450 451
		default:
			break;
	}
	return inode;
}

452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476
static int __rpc_create_common(struct inode *dir, struct dentry *dentry,
			       umode_t mode,
			       const struct file_operations *i_fop,
			       void *private)
{
	struct inode *inode;

	BUG_ON(!d_unhashed(dentry));
	inode = rpc_get_inode(dir->i_sb, mode);
	if (!inode)
		goto out_err;
	inode->i_ino = iunique(dir->i_sb, 100);
	if (i_fop)
		inode->i_fop = i_fop;
	if (private)
		rpc_inode_setowner(inode, private);
	d_add(dentry, inode);
	return 0;
out_err:
	printk(KERN_WARNING "%s: %s failed to allocate inode for dentry %s\n",
			__FILE__, __func__, dentry->d_name.name);
	dput(dentry);
	return -ENOMEM;
}

477 478 479 480 481 482 483 484 485 486 487 488 489 490
static int __rpc_create(struct inode *dir, struct dentry *dentry,
			umode_t mode,
			const struct file_operations *i_fop,
			void *private)
{
	int err;

	err = __rpc_create_common(dir, dentry, S_IFREG | mode, i_fop, private);
	if (err)
		return err;
	fsnotify_create(dir, dentry);
	return 0;
}

491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527
static int __rpc_mkdir(struct inode *dir, struct dentry *dentry,
		       umode_t mode,
		       const struct file_operations *i_fop,
		       void *private)
{
	int err;

	err = __rpc_create_common(dir, dentry, S_IFDIR | mode, i_fop, private);
	if (err)
		return err;
	inc_nlink(dir);
	fsnotify_mkdir(dir, dentry);
	return 0;
}

static int __rpc_mkpipe(struct inode *dir, struct dentry *dentry,
			umode_t mode,
			const struct file_operations *i_fop,
			void *private,
			const struct rpc_pipe_ops *ops,
			int flags)
{
	struct rpc_inode *rpci;
	int err;

	err = __rpc_create_common(dir, dentry, S_IFIFO | mode, i_fop, private);
	if (err)
		return err;
	rpci = RPC_I(dentry->d_inode);
	rpci->nkern_readwriters = 1;
	rpci->private = private;
	rpci->flags = flags;
	rpci->ops = ops;
	fsnotify_create(dir, dentry);
	return 0;
}

528 529 530 531 532 533 534 535 536 537 538
static int __rpc_rmdir(struct inode *dir, struct dentry *dentry)
{
	int ret;

	dget(dentry);
	ret = simple_rmdir(dir, dentry);
	d_delete(dentry);
	dput(dentry);
	return ret;
}

T
Trond Myklebust 已提交
539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
static int __rpc_unlink(struct inode *dir, struct dentry *dentry)
{
	int ret;

	dget(dentry);
	ret = simple_unlink(dir, dentry);
	d_delete(dentry);
	dput(dentry);
	return ret;
}

static int __rpc_rmpipe(struct inode *dir, struct dentry *dentry)
{
	struct inode *inode = dentry->d_inode;
	struct rpc_inode *rpci = RPC_I(inode);

	rpci->nkern_readwriters--;
	if (rpci->nkern_readwriters != 0)
		return 0;
	rpc_close_pipes(inode);
	return __rpc_unlink(dir, dentry);
}

562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592
static struct dentry *__rpc_lookup_create(struct dentry *parent,
					  struct qstr *name)
{
	struct dentry *dentry;

	dentry = d_lookup(parent, name);
	if (!dentry) {
		dentry = d_alloc(parent, name);
		if (!dentry) {
			dentry = ERR_PTR(-ENOMEM);
			goto out_err;
		}
	}
	if (!dentry->d_inode)
		dentry->d_op = &rpc_dentry_operations;
out_err:
	return dentry;
}

static struct dentry *__rpc_lookup_create_exclusive(struct dentry *parent,
					  struct qstr *name)
{
	struct dentry *dentry;

	dentry = __rpc_lookup_create(parent, name);
	if (dentry->d_inode == NULL)
		return dentry;
	dput(dentry);
	return ERR_PTR(-EEXIST);
}

L
Linus Torvalds 已提交
593 594 595
/*
 * FIXME: This probably has races.
 */
596 597 598
static void __rpc_depopulate(struct dentry *parent,
			     const struct rpc_filelist *files,
			     int start, int eof)
L
Linus Torvalds 已提交
599 600
{
	struct inode *dir = parent->d_inode;
601 602 603
	struct dentry *dentry;
	struct qstr name;
	int i;
L
Linus Torvalds 已提交
604

605 606 607 608 609 610 611
	for (i = start; i < eof; i++) {
		name.name = files[i].name;
		name.len = strlen(files[i].name);
		name.hash = full_name_hash(name.name, name.len);
		dentry = d_lookup(parent, &name);

		if (dentry == NULL)
T
Trond Myklebust 已提交
612
			continue;
613 614 615 616 617 618 619
		if (dentry->d_inode == NULL)
			goto next;
		switch (dentry->d_inode->i_mode & S_IFMT) {
			default:
				BUG();
			case S_IFREG:
				__rpc_unlink(dir, dentry);
L
Linus Torvalds 已提交
620
				break;
621 622 623 624 625
			case S_IFDIR:
				__rpc_rmdir(dir, dentry);
		}
next:
		dput(dentry);
L
Linus Torvalds 已提交
626
	}
627 628 629 630 631 632 633 634 635 636
}

static void rpc_depopulate(struct dentry *parent,
			   const struct rpc_filelist *files,
			   int start, int eof)
{
	struct inode *dir = parent->d_inode;

	mutex_lock_nested(&dir->i_mutex, I_MUTEX_CHILD);
	__rpc_depopulate(parent, files, start, eof);
637
	mutex_unlock(&dir->i_mutex);
L
Linus Torvalds 已提交
638 639
}

640 641 642 643
static int rpc_populate(struct dentry *parent,
			const struct rpc_filelist *files,
			int start, int eof,
			void *private)
L
Linus Torvalds 已提交
644
{
645
	struct inode *dir = parent->d_inode;
L
Linus Torvalds 已提交
646
	struct dentry *dentry;
647
	int i, err;
L
Linus Torvalds 已提交
648

649
	mutex_lock(&dir->i_mutex);
L
Linus Torvalds 已提交
650
	for (i = start; i < eof; i++) {
651 652 653 654 655 656 657 658
		struct qstr q;

		q.name = files[i].name;
		q.len = strlen(files[i].name);
		q.hash = full_name_hash(q.name, q.len);
		dentry = __rpc_lookup_create_exclusive(parent, &q);
		err = PTR_ERR(dentry);
		if (IS_ERR(dentry))
L
Linus Torvalds 已提交
659
			goto out_bad;
660 661 662 663 664 665 666 667 668 669 670 671 672 673
		switch (files[i].mode & S_IFMT) {
			default:
				BUG();
			case S_IFREG:
				err = __rpc_create(dir, dentry,
						files[i].mode,
						files[i].i_fop,
						private);
				break;
			case S_IFDIR:
				err = __rpc_mkdir(dir, dentry,
						files[i].mode,
						NULL,
						private);
L
Linus Torvalds 已提交
674
		}
675 676
		if (err != 0)
			goto out_bad;
L
Linus Torvalds 已提交
677
	}
678
	mutex_unlock(&dir->i_mutex);
L
Linus Torvalds 已提交
679 680
	return 0;
out_bad:
681
	__rpc_depopulate(parent, files, start, eof);
682
	mutex_unlock(&dir->i_mutex);
L
Linus Torvalds 已提交
683
	printk(KERN_WARNING "%s: %s failed to populate directory %s\n",
684
			__FILE__, __func__, parent->d_name.name);
685
	return err;
686
}
L
Linus Torvalds 已提交
687

688 689 690
static struct dentry *rpc_mkdir_populate(struct dentry *parent,
		struct qstr *name, umode_t mode, void *private,
		int (*populate)(struct dentry *, void *), void *args_populate)
691 692
{
	struct dentry *dentry;
693
	struct inode *dir = parent->d_inode;
694 695
	int error;

696 697
	mutex_lock_nested(&dir->i_mutex, I_MUTEX_PARENT);
	dentry = __rpc_lookup_create_exclusive(parent, name);
698
	if (IS_ERR(dentry))
699 700
		goto out;
	error = __rpc_mkdir(dir, dentry, mode, NULL, private);
701 702
	if (error != 0)
		goto out_err;
703 704 705 706 707
	if (populate != NULL) {
		error = populate(dentry, args_populate);
		if (error)
			goto err_rmdir;
	}
708
out:
709
	mutex_unlock(&dir->i_mutex);
710
	return dentry;
711
err_rmdir:
712
	__rpc_rmdir(dir, dentry);
713
out_err:
714 715
	dentry = ERR_PTR(error);
	goto out;
L
Linus Torvalds 已提交
716 717
}

718 719
static int rpc_rmdir_depopulate(struct dentry *dentry,
		void (*depopulate)(struct dentry *))
L
Linus Torvalds 已提交
720
{
T
Trond Myklebust 已提交
721
	struct dentry *parent;
722 723
	struct inode *dir;
	int error;
724

T
Trond Myklebust 已提交
725 726
	parent = dget_parent(dentry);
	dir = parent->d_inode;
727
	mutex_lock_nested(&dir->i_mutex, I_MUTEX_PARENT);
728 729
	if (depopulate != NULL)
		depopulate(dentry);
730
	error = __rpc_rmdir(dir, dentry);
731
	mutex_unlock(&dir->i_mutex);
T
Trond Myklebust 已提交
732
	dput(parent);
733
	return error;
L
Linus Torvalds 已提交
734 735
}

736 737 738 739 740 741
/**
 * rpc_mkpipe - make an rpc_pipefs file for kernel<->userspace communication
 * @parent: dentry of directory to create new "pipe" in
 * @name: name of pipe
 * @private: private data to associate with the pipe, for the caller's use
 * @ops: operations defining the behavior of the pipe: upcall, downcall,
742
 *	release_pipe, open_pipe, and destroy_msg.
743
 * @flags: rpc_inode flags
744 745 746 747 748 749 750 751 752 753 754 755
 *
 * Data is made available for userspace to read by calls to
 * rpc_queue_upcall().  The actual reads will result in calls to
 * @ops->upcall, which will be called with the file pointer,
 * message, and userspace buffer to copy to.
 *
 * Writes can come at any time, and do not necessarily have to be
 * responses to upcalls.  They will result in calls to @msg->downcall.
 *
 * The @private argument passed here will be available to all these methods
 * from the file pointer, via RPC_I(file->f_dentry->d_inode)->private.
 */
756 757 758
struct dentry *rpc_mkpipe(struct dentry *parent, const char *name,
			  void *private, const struct rpc_pipe_ops *ops,
			  int flags)
L
Linus Torvalds 已提交
759 760
{
	struct dentry *dentry;
761
	struct inode *dir = parent->d_inode;
762
	umode_t umode = S_IFIFO | S_IRUSR | S_IWUSR;
763
	struct qstr q;
764
	int err;
765 766 767 768 769

	if (ops->upcall == NULL)
		umode &= ~S_IRUGO;
	if (ops->downcall == NULL)
		umode &= ~S_IWUGO;
L
Linus Torvalds 已提交
770

771 772 773 774 775 776
	q.name = name;
	q.len = strlen(name);
	q.hash = full_name_hash(q.name, q.len),

	mutex_lock_nested(&dir->i_mutex, I_MUTEX_PARENT);
	dentry = __rpc_lookup_create(parent, &q);
L
Linus Torvalds 已提交
777
	if (IS_ERR(dentry))
778
		goto out;
779
	if (dentry->d_inode) {
780
		struct rpc_inode *rpci = RPC_I(dentry->d_inode);
781 782 783 784
		if (rpci->private != private ||
				rpci->ops != ops ||
				rpci->flags != flags) {
			dput (dentry);
T
Trond Myklebust 已提交
785 786
			err = -EBUSY;
			goto out_err;
787
		}
788
		rpci->nkern_readwriters++;
789 790
		goto out;
	}
791 792

	err = __rpc_mkpipe(dir, dentry, umode, &rpc_pipe_fops,
T
Trond Myklebust 已提交
793
			   private, ops, flags);
794 795
	if (err)
		goto out_err;
796
out:
797
	mutex_unlock(&dir->i_mutex);
798
	return dentry;
799 800
out_err:
	dentry = ERR_PTR(err);
801
	printk(KERN_WARNING "%s: %s() failed to create pipe %s/%s (errno = %d)\n",
802
			__FILE__, __func__, parent->d_name.name, name,
803
			err);
804
	goto out;
L
Linus Torvalds 已提交
805
}
806
EXPORT_SYMBOL_GPL(rpc_mkpipe);
L
Linus Torvalds 已提交
807

808 809 810 811 812 813 814 815
/**
 * rpc_unlink - remove a pipe
 * @dentry: dentry for the pipe, as returned from rpc_mkpipe
 *
 * After this call, lookups will no longer find the pipe, and any
 * attempts to read or write using preexisting opens of the pipe will
 * return -EPIPE.
 */
816
int
817
rpc_unlink(struct dentry *dentry)
L
Linus Torvalds 已提交
818
{
819
	struct dentry *parent;
820
	struct inode *dir;
821
	int error = 0;
L
Linus Torvalds 已提交
822

823 824
	parent = dget_parent(dentry);
	dir = parent->d_inode;
825
	mutex_lock_nested(&dir->i_mutex, I_MUTEX_PARENT);
T
Trond Myklebust 已提交
826
	error = __rpc_rmpipe(dir, dentry);
827
	mutex_unlock(&dir->i_mutex);
828
	dput(parent);
829
	return error;
L
Linus Torvalds 已提交
830
}
831
EXPORT_SYMBOL_GPL(rpc_unlink);
L
Linus Torvalds 已提交
832

833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857
enum {
	RPCAUTH_info,
	RPCAUTH_EOF
};

static const struct rpc_filelist authfiles[] = {
	[RPCAUTH_info] = {
		.name = "info",
		.i_fop = &rpc_info_operations,
		.mode = S_IFREG | S_IRUSR,
	},
};

static int rpc_clntdir_populate(struct dentry *dentry, void *private)
{
	return rpc_populate(dentry,
			    authfiles, RPCAUTH_info, RPCAUTH_EOF,
			    private);
}

static void rpc_clntdir_depopulate(struct dentry *dentry)
{
	rpc_depopulate(dentry, authfiles, RPCAUTH_info, RPCAUTH_EOF);
}

858 859 860 861 862 863 864 865 866 867
/**
 * rpc_create_client_dir - Create a new rpc_client directory in rpc_pipefs
 * @path: path from the rpc_pipefs root to the new directory
 * @rpc_client: rpc client to associate with this directory
 *
 * This creates a directory at the given @path associated with
 * @rpc_clnt, which will contain a file named "info" with some basic
 * information about the client, together with any "pipes" that may
 * later be created using rpc_mkpipe().
 */
868
struct dentry *rpc_create_client_dir(struct dentry *dentry,
869 870 871 872 873 874 875 876 877 878 879 880
				   struct qstr *name,
				   struct rpc_clnt *rpc_client)
{
	return rpc_mkdir_populate(dentry, name, S_IRUGO | S_IXUGO, NULL,
			rpc_clntdir_populate, rpc_client);
}

/**
 * rpc_remove_client_dir - Remove a directory created with rpc_create_client_dir()
 * @dentry: directory to remove
 */
int rpc_remove_client_dir(struct dentry *dentry)
881
{
882
	return rpc_rmdir_depopulate(dentry, rpc_clntdir_depopulate);
883 884
}

L
Linus Torvalds 已提交
885 886 887 888 889 890 891 892 893 894 895
/*
 * populate the filesystem
 */
static struct super_operations s_ops = {
	.alloc_inode	= rpc_alloc_inode,
	.destroy_inode	= rpc_destroy_inode,
	.statfs		= simple_statfs,
};

#define RPCAUTH_GSSMAGIC 0x67596969

T
Trond Myklebust 已提交
896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935
/*
 * We have a single directory with 1 node in it.
 */
enum {
	RPCAUTH_lockd,
	RPCAUTH_mount,
	RPCAUTH_nfs,
	RPCAUTH_portmap,
	RPCAUTH_statd,
	RPCAUTH_nfsd4_cb,
	RPCAUTH_RootEOF
};

static const struct rpc_filelist files[] = {
	[RPCAUTH_lockd] = {
		.name = "lockd",
		.mode = S_IFDIR | S_IRUGO | S_IXUGO,
	},
	[RPCAUTH_mount] = {
		.name = "mount",
		.mode = S_IFDIR | S_IRUGO | S_IXUGO,
	},
	[RPCAUTH_nfs] = {
		.name = "nfs",
		.mode = S_IFDIR | S_IRUGO | S_IXUGO,
	},
	[RPCAUTH_portmap] = {
		.name = "portmap",
		.mode = S_IFDIR | S_IRUGO | S_IXUGO,
	},
	[RPCAUTH_statd] = {
		.name = "statd",
		.mode = S_IFDIR | S_IRUGO | S_IXUGO,
	},
	[RPCAUTH_nfsd4_cb] = {
		.name = "nfsd4_cb",
		.mode = S_IFDIR | S_IRUGO | S_IXUGO,
	},
};

L
Linus Torvalds 已提交
936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955
static int
rpc_fill_super(struct super_block *sb, void *data, int silent)
{
	struct inode *inode;
	struct dentry *root;

	sb->s_blocksize = PAGE_CACHE_SIZE;
	sb->s_blocksize_bits = PAGE_CACHE_SHIFT;
	sb->s_magic = RPCAUTH_GSSMAGIC;
	sb->s_op = &s_ops;
	sb->s_time_gran = 1;

	inode = rpc_get_inode(sb, S_IFDIR | 0755);
	if (!inode)
		return -ENOMEM;
	root = d_alloc_root(inode);
	if (!root) {
		iput(inode);
		return -ENOMEM;
	}
956
	if (rpc_populate(root, files, RPCAUTH_lockd, RPCAUTH_RootEOF, NULL))
L
Linus Torvalds 已提交
957 958 959 960 961 962 963 964 965
		goto out;
	sb->s_root = root;
	return 0;
out:
	d_genocide(root);
	dput(root);
	return -ENOMEM;
}

966
static int
L
Linus Torvalds 已提交
967
rpc_get_sb(struct file_system_type *fs_type,
968
		int flags, const char *dev_name, void *data, struct vfsmount *mnt)
L
Linus Torvalds 已提交
969
{
970
	return get_sb_single(fs_type, flags, data, rpc_fill_super, mnt);
L
Linus Torvalds 已提交
971 972 973 974 975 976 977 978 979 980
}

static struct file_system_type rpc_pipe_fs_type = {
	.owner		= THIS_MODULE,
	.name		= "rpc_pipefs",
	.get_sb		= rpc_get_sb,
	.kill_sb	= kill_litter_super,
};

static void
981
init_once(void *foo)
L
Linus Torvalds 已提交
982 983 984
{
	struct rpc_inode *rpci = (struct rpc_inode *) foo;

C
Christoph Lameter 已提交
985 986 987 988 989
	inode_init_once(&rpci->vfs_inode);
	rpci->private = NULL;
	rpci->nreaders = 0;
	rpci->nwriters = 0;
	INIT_LIST_HEAD(&rpci->in_upcall);
990
	INIT_LIST_HEAD(&rpci->in_downcall);
C
Christoph Lameter 已提交
991 992 993 994 995 996
	INIT_LIST_HEAD(&rpci->pipe);
	rpci->pipelen = 0;
	init_waitqueue_head(&rpci->waitq);
	INIT_DELAYED_WORK(&rpci->queue_timeout,
			    rpc_timeout_upcall_queue);
	rpci->ops = NULL;
L
Linus Torvalds 已提交
997 998 999 1000
}

int register_rpc_pipefs(void)
{
1001 1002
	int err;

L
Linus Torvalds 已提交
1003
	rpc_inode_cachep = kmem_cache_create("rpc_inode_cache",
1004 1005 1006
				sizeof(struct rpc_inode),
				0, (SLAB_HWCACHE_ALIGN|SLAB_RECLAIM_ACCOUNT|
						SLAB_MEM_SPREAD),
1007
				init_once);
L
Linus Torvalds 已提交
1008 1009
	if (!rpc_inode_cachep)
		return -ENOMEM;
1010 1011 1012 1013 1014 1015
	err = register_filesystem(&rpc_pipe_fs_type);
	if (err) {
		kmem_cache_destroy(rpc_inode_cachep);
		return err;
	}

L
Linus Torvalds 已提交
1016 1017 1018 1019 1020
	return 0;
}

void unregister_rpc_pipefs(void)
{
1021
	kmem_cache_destroy(rpc_inode_cachep);
L
Linus Torvalds 已提交
1022 1023
	unregister_filesystem(&rpc_pipe_fs_type);
}