nbd.c 22.5 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6
/*
 * Network block device - make block devices work over TCP
 *
 * Note that you can not swap over this thing, yet. Seems to work but
 * deadlocks sometimes - you can not swap over TCP in general.
 * 
P
Pavel Machek 已提交
7
 * Copyright 1997-2000, 2008 Pavel Machek <pavel@ucw.cz>
L
Linus Torvalds 已提交
8 9
 * Parts copyright 2001 Steven Whitehouse <steve@chygwyn.com>
 *
10
 * This file is released under GPLv2 or later.
L
Linus Torvalds 已提交
11
 *
12
 * (part of code stolen from loop.c)
L
Linus Torvalds 已提交
13 14 15 16 17 18 19 20 21 22 23 24 25 26
 */

#include <linux/major.h>

#include <linux/blkdev.h>
#include <linux/module.h>
#include <linux/init.h>
#include <linux/sched.h>
#include <linux/fs.h>
#include <linux/bio.h>
#include <linux/stat.h>
#include <linux/errno.h>
#include <linux/file.h>
#include <linux/ioctl.h>
27
#include <linux/mutex.h>
28 29 30
#include <linux/compiler.h>
#include <linux/err.h>
#include <linux/kernel.h>
31
#include <linux/slab.h>
L
Linus Torvalds 已提交
32
#include <net/sock.h>
33
#include <linux/net.h>
34
#include <linux/kthread.h>
L
Linus Torvalds 已提交
35 36 37 38 39 40

#include <asm/uaccess.h>
#include <asm/types.h>

#include <linux/nbd.h>

41
#define NBD_MAGIC 0x68797548
L
Linus Torvalds 已提交
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57

#ifdef NDEBUG
#define dprintk(flags, fmt...)
#else /* NDEBUG */
#define dprintk(flags, fmt...) do { \
	if (debugflags & (flags)) printk(KERN_DEBUG fmt); \
} while (0)
#define DBG_IOCTL       0x0004
#define DBG_INIT        0x0010
#define DBG_EXIT        0x0020
#define DBG_BLKDEV      0x0100
#define DBG_RX          0x0200
#define DBG_TX          0x0400
static unsigned int debugflags;
#endif /* NDEBUG */

58
static unsigned int nbds_max = 16;
59
static struct nbd_device *nbd_dev;
L
Laurent Vivier 已提交
60
static int max_part;
L
Linus Torvalds 已提交
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80

/*
 * Use just one lock (or at most 1 per NIC). Two arguments for this:
 * 1. Each NIC is essentially a synchronization point for all servers
 *    accessed through that NIC so there's no need to have more locks
 *    than NICs anyway.
 * 2. More locks lead to more "Dirty cache line bouncing" which will slow
 *    down each lock to the point where they're actually slower than just
 *    a single lock.
 * Thanks go to Jens Axboe and Al Viro for their LKML emails explaining this!
 */
static DEFINE_SPINLOCK(nbd_lock);

#ifndef NDEBUG
static const char *ioctl_cmd_to_ascii(int cmd)
{
	switch (cmd) {
	case NBD_SET_SOCK: return "set-sock";
	case NBD_SET_BLKSIZE: return "set-blksize";
	case NBD_SET_SIZE: return "set-size";
P
Paul Clements 已提交
81 82
	case NBD_SET_TIMEOUT: return "set-timeout";
	case NBD_SET_FLAGS: return "set-flags";
L
Linus Torvalds 已提交
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
	case NBD_DO_IT: return "do-it";
	case NBD_CLEAR_SOCK: return "clear-sock";
	case NBD_CLEAR_QUE: return "clear-que";
	case NBD_PRINT_DEBUG: return "print-debug";
	case NBD_SET_SIZE_BLOCKS: return "set-size-blocks";
	case NBD_DISCONNECT: return "disconnect";
	case BLKROSET: return "set-read-only";
	case BLKFLSBUF: return "flush-buffer-cache";
	}
	return "unknown";
}

static const char *nbdcmd_to_ascii(int cmd)
{
	switch (cmd) {
	case  NBD_CMD_READ: return "read";
	case NBD_CMD_WRITE: return "write";
	case  NBD_CMD_DISC: return "disconnect";
A
Alex Bligh 已提交
101
	case NBD_CMD_FLUSH: return "flush";
P
Paul Clements 已提交
102
	case  NBD_CMD_TRIM: return "trim/discard";
L
Linus Torvalds 已提交
103 104 105 106 107 108 109
	}
	return "invalid";
}
#endif /* NDEBUG */

static void nbd_end_request(struct request *req)
{
110
	int error = req->errors ? -EIO : 0;
111
	struct request_queue *q = req->q;
L
Linus Torvalds 已提交
112 113 114
	unsigned long flags;

	dprintk(DBG_BLKDEV, "%s: request %p: %s\n", req->rq_disk->disk_name,
115
			req, error ? "failed" : "done");
L
Linus Torvalds 已提交
116 117

	spin_lock_irqsave(q->queue_lock, flags);
118
	__blk_end_request_all(req, error);
L
Linus Torvalds 已提交
119 120 121
	spin_unlock_irqrestore(q->queue_lock, flags);
}

122
static void sock_shutdown(struct nbd_device *nbd, int lock)
123 124 125 126 127 128 129 130
{
	/* Forcibly shutdown the socket causing all listeners
	 * to error
	 *
	 * FIXME: This code is duplicated from sys_shutdown, but
	 * there should be a more generic interface rather than
	 * calling socket ops directly here */
	if (lock)
131 132 133 134 135
		mutex_lock(&nbd->tx_lock);
	if (nbd->sock) {
		dev_warn(disk_to_dev(nbd->disk), "shutting down socket\n");
		kernel_sock_shutdown(nbd->sock, SHUT_RDWR);
		nbd->sock = NULL;
136 137
	}
	if (lock)
138
		mutex_unlock(&nbd->tx_lock);
139 140 141 142 143 144 145 146 147 148 149
}

static void nbd_xmit_timeout(unsigned long arg)
{
	struct task_struct *task = (struct task_struct *)arg;

	printk(KERN_WARNING "nbd: killing hung xmit (%s, pid: %d)\n",
		task->comm, task->pid);
	force_sig(SIGKILL, task);
}

L
Linus Torvalds 已提交
150 151 152
/*
 *  Send or receive packet.
 */
153
static int sock_xmit(struct nbd_device *nbd, int send, void *buf, int size,
L
Linus Torvalds 已提交
154 155
		int msg_flags)
{
156
	struct socket *sock = nbd->sock;
L
Linus Torvalds 已提交
157 158 159
	int result;
	struct msghdr msg;
	struct kvec iov;
160
	sigset_t blocked, oldset;
161
	unsigned long pflags = current->flags;
L
Linus Torvalds 已提交
162

163
	if (unlikely(!sock)) {
164
		dev_err(disk_to_dev(nbd->disk),
165 166
			"Attempted %s on closed socket in sock_xmit\n",
			(send ? "send" : "recv"));
167 168 169
		return -EINVAL;
	}

L
Linus Torvalds 已提交
170 171
	/* Allow interception of SIGKILL only
	 * Don't allow other signals to interrupt the transmission */
172 173
	siginitsetinv(&blocked, sigmask(SIGKILL));
	sigprocmask(SIG_SETMASK, &blocked, &oldset);
L
Linus Torvalds 已提交
174

175
	current->flags |= PF_MEMALLOC;
L
Linus Torvalds 已提交
176
	do {
177
		sock->sk->sk_allocation = GFP_NOIO | __GFP_MEMALLOC;
L
Linus Torvalds 已提交
178 179 180 181 182 183 184 185
		iov.iov_base = buf;
		iov.iov_len = size;
		msg.msg_name = NULL;
		msg.msg_namelen = 0;
		msg.msg_control = NULL;
		msg.msg_controllen = 0;
		msg.msg_flags = msg_flags | MSG_NOSIGNAL;

186 187 188
		if (send) {
			struct timer_list ti;

189
			if (nbd->xmit_timeout) {
190 191 192
				init_timer(&ti);
				ti.function = nbd_xmit_timeout;
				ti.data = (unsigned long)current;
193
				ti.expires = jiffies + nbd->xmit_timeout;
194 195
				add_timer(&ti);
			}
L
Linus Torvalds 已提交
196
			result = kernel_sendmsg(sock, &msg, &iov, 1, size);
197
			if (nbd->xmit_timeout)
198 199
				del_timer_sync(&ti);
		} else
200 201
			result = kernel_recvmsg(sock, &msg, &iov, 1, size,
						msg.msg_flags);
L
Linus Torvalds 已提交
202 203 204 205

		if (signal_pending(current)) {
			siginfo_t info;
			printk(KERN_WARNING "nbd (pid %d: %s) got signal %d\n",
206
				task_pid_nr(current), current->comm,
207
				dequeue_signal_lock(current, &current->blocked, &info));
L
Linus Torvalds 已提交
208
			result = -EINTR;
209
			sock_shutdown(nbd, !send);
L
Linus Torvalds 已提交
210 211 212 213 214 215 216 217 218 219 220 221
			break;
		}

		if (result <= 0) {
			if (result == 0)
				result = -EPIPE; /* short read */
			break;
		}
		size -= result;
		buf += result;
	} while (size > 0);

222
	sigprocmask(SIG_SETMASK, &oldset, NULL);
223
	tsk_restore_flags(current, pflags, PF_MEMALLOC);
L
Linus Torvalds 已提交
224 225 226 227

	return result;
}

228
static inline int sock_send_bvec(struct nbd_device *nbd, struct bio_vec *bvec,
L
Linus Torvalds 已提交
229 230 231 232
		int flags)
{
	int result;
	void *kaddr = kmap(bvec->bv_page);
233 234
	result = sock_xmit(nbd, 1, kaddr + bvec->bv_offset,
			   bvec->bv_len, flags);
L
Linus Torvalds 已提交
235 236 237 238
	kunmap(bvec->bv_page);
	return result;
}

239
/* always call with the tx_lock held */
240
static int nbd_send_req(struct nbd_device *nbd, struct request *req)
L
Linus Torvalds 已提交
241
{
242
	int result, flags;
L
Linus Torvalds 已提交
243
	struct nbd_request request;
244
	unsigned long size = blk_rq_bytes(req);
L
Linus Torvalds 已提交
245 246 247

	request.magic = htonl(NBD_REQUEST_MAGIC);
	request.type = htonl(nbd_cmd(req));
A
Alex Bligh 已提交
248 249 250 251 252 253 254 255 256

	if (nbd_cmd(req) == NBD_CMD_FLUSH) {
		/* Other values are reserved for FLUSH requests.  */
		request.from = 0;
		request.len = 0;
	} else {
		request.from = cpu_to_be64((u64)blk_rq_pos(req) << 9);
		request.len = htonl(size);
	}
L
Linus Torvalds 已提交
257 258
	memcpy(request.handle, &req, sizeof(req));

259
	dprintk(DBG_TX, "%s: request %p: sending control (%s@%llu,%uB)\n",
260
			nbd->disk->disk_name, req,
L
Linus Torvalds 已提交
261
			nbdcmd_to_ascii(nbd_cmd(req)),
262
			(unsigned long long)blk_rq_pos(req) << 9,
263
			blk_rq_bytes(req));
264
	result = sock_xmit(nbd, 1, &request, sizeof(request),
265
			(nbd_cmd(req) == NBD_CMD_WRITE) ? MSG_MORE : 0);
L
Linus Torvalds 已提交
266
	if (result <= 0) {
267
		dev_err(disk_to_dev(nbd->disk),
268
			"Send control failed (result %d)\n", result);
L
Linus Torvalds 已提交
269 270 271 272
		goto error_out;
	}

	if (nbd_cmd(req) == NBD_CMD_WRITE) {
273
		struct req_iterator iter;
274
		struct bio_vec bvec;
L
Linus Torvalds 已提交
275 276 277 278
		/*
		 * we are really probing at internals to determine
		 * whether to set MSG_MORE or not...
		 */
279
		rq_for_each_segment(bvec, req, iter) {
280 281 282 283
			flags = 0;
			if (!rq_iter_last(req, iter))
				flags = MSG_MORE;
			dprintk(DBG_TX, "%s: request %p: sending %d bytes data\n",
284 285
					nbd->disk->disk_name, req, bvec.bv_len);
			result = sock_send_bvec(nbd, &bvec, flags);
286
			if (result <= 0) {
287
				dev_err(disk_to_dev(nbd->disk),
288 289
					"Send data failed (result %d)\n",
					result);
290 291
				goto error_out;
			}
L
Linus Torvalds 已提交
292 293 294 295 296
		}
	}
	return 0;

error_out:
P
Pavel Machek 已提交
297
	return -EIO;
L
Linus Torvalds 已提交
298 299
}

300
static struct request *nbd_find_request(struct nbd_device *nbd,
301
					struct request *xreq)
L
Linus Torvalds 已提交
302
{
303
	struct request *req, *tmp;
304
	int err;
L
Linus Torvalds 已提交
305

306
	err = wait_event_interruptible(nbd->active_wq, nbd->active_req != xreq);
307 308 309
	if (unlikely(err))
		goto out;

310 311
	spin_lock(&nbd->queue_lock);
	list_for_each_entry_safe(req, tmp, &nbd->queue_head, queuelist) {
L
Linus Torvalds 已提交
312 313 314
		if (req != xreq)
			continue;
		list_del_init(&req->queuelist);
315
		spin_unlock(&nbd->queue_lock);
L
Linus Torvalds 已提交
316 317
		return req;
	}
318
	spin_unlock(&nbd->queue_lock);
319 320 321 322 323

	err = -ENOENT;

out:
	return ERR_PTR(err);
L
Linus Torvalds 已提交
324 325
}

326
static inline int sock_recv_bvec(struct nbd_device *nbd, struct bio_vec *bvec)
L
Linus Torvalds 已提交
327 328 329
{
	int result;
	void *kaddr = kmap(bvec->bv_page);
330
	result = sock_xmit(nbd, 0, kaddr + bvec->bv_offset, bvec->bv_len,
L
Linus Torvalds 已提交
331 332 333 334 335 336
			MSG_WAITALL);
	kunmap(bvec->bv_page);
	return result;
}

/* NULL returned = something went wrong, inform userspace */
337
static struct request *nbd_read_stat(struct nbd_device *nbd)
L
Linus Torvalds 已提交
338 339 340 341 342 343
{
	int result;
	struct nbd_reply reply;
	struct request *req;

	reply.magic = 0;
344
	result = sock_xmit(nbd, 0, &reply, sizeof(reply), MSG_WAITALL);
L
Linus Torvalds 已提交
345
	if (result <= 0) {
346
		dev_err(disk_to_dev(nbd->disk),
347
			"Receive control failed (result %d)\n", result);
L
Linus Torvalds 已提交
348 349
		goto harderror;
	}
350 351

	if (ntohl(reply.magic) != NBD_REPLY_MAGIC) {
352
		dev_err(disk_to_dev(nbd->disk), "Wrong magic (0x%lx)\n",
353 354 355 356 357
				(unsigned long)ntohl(reply.magic));
		result = -EPROTO;
		goto harderror;
	}

358
	req = nbd_find_request(nbd, *(struct request **)reply.handle);
359
	if (IS_ERR(req)) {
360 361 362 363
		result = PTR_ERR(req);
		if (result != -ENOENT)
			goto harderror;

364
		dev_err(disk_to_dev(nbd->disk), "Unexpected reply (%p)\n",
365
			reply.handle);
L
Linus Torvalds 已提交
366 367 368 369 370
		result = -EBADR;
		goto harderror;
	}

	if (ntohl(reply.error)) {
371
		dev_err(disk_to_dev(nbd->disk), "Other side returned error (%d)\n",
372
			ntohl(reply.error));
L
Linus Torvalds 已提交
373 374 375 376 377
		req->errors++;
		return req;
	}

	dprintk(DBG_RX, "%s: request %p: got reply\n",
378
			nbd->disk->disk_name, req);
L
Linus Torvalds 已提交
379
	if (nbd_cmd(req) == NBD_CMD_READ) {
380
		struct req_iterator iter;
381
		struct bio_vec bvec;
382 383

		rq_for_each_segment(bvec, req, iter) {
384
			result = sock_recv_bvec(nbd, &bvec);
385
			if (result <= 0) {
386
				dev_err(disk_to_dev(nbd->disk), "Receive data failed (result %d)\n",
387
					result);
388 389 390 391
				req->errors++;
				return req;
			}
			dprintk(DBG_RX, "%s: request %p: got %d bytes data\n",
392
				nbd->disk->disk_name, req, bvec.bv_len);
L
Linus Torvalds 已提交
393 394 395 396
		}
	}
	return req;
harderror:
397
	nbd->harderror = result;
L
Linus Torvalds 已提交
398 399 400
	return NULL;
}

401 402
static ssize_t pid_show(struct device *dev,
			struct device_attribute *attr, char *buf)
403
{
404 405 406
	struct gendisk *disk = dev_to_disk(dev);

	return sprintf(buf, "%ld\n",
407 408 409
		(long) ((struct nbd_device *)disk->private_data)->pid);
}

410
static struct device_attribute pid_attr = {
411
	.attr = { .name = "pid", .mode = S_IRUGO},
412 413 414
	.show = pid_show,
};

415
static int nbd_do_it(struct nbd_device *nbd)
L
Linus Torvalds 已提交
416 417
{
	struct request *req;
418
	int ret;
L
Linus Torvalds 已提交
419

420
	BUG_ON(nbd->magic != NBD_MAGIC);
L
Linus Torvalds 已提交
421

422
	sk_set_memalloc(nbd->sock->sk);
423 424
	nbd->pid = task_pid_nr(current);
	ret = device_create_file(disk_to_dev(nbd->disk), &pid_attr);
425
	if (ret) {
426 427
		dev_err(disk_to_dev(nbd->disk), "device_create_file failed!\n");
		nbd->pid = 0;
428 429
		return ret;
	}
430

431
	while ((req = nbd_read_stat(nbd)) != NULL)
L
Linus Torvalds 已提交
432
		nbd_end_request(req);
433

434 435
	device_remove_file(disk_to_dev(nbd->disk), &pid_attr);
	nbd->pid = 0;
436
	return 0;
L
Linus Torvalds 已提交
437 438
}

439
static void nbd_clear_que(struct nbd_device *nbd)
L
Linus Torvalds 已提交
440 441 442
{
	struct request *req;

443
	BUG_ON(nbd->magic != NBD_MAGIC);
L
Linus Torvalds 已提交
444

445
	/*
446
	 * Because we have set nbd->sock to NULL under the tx_lock, all
447 448 449 450 451 452
	 * modifications to the list must have completed by now.  For
	 * the same reason, the active_req must be NULL.
	 *
	 * As a consequence, we don't need to take the spin lock while
	 * purging the list here.
	 */
453 454
	BUG_ON(nbd->sock);
	BUG_ON(nbd->active_req);
455

456 457
	while (!list_empty(&nbd->queue_head)) {
		req = list_entry(nbd->queue_head.next, struct request,
458 459 460 461 462
				 queuelist);
		list_del_init(&req->queuelist);
		req->errors++;
		nbd_end_request(req);
	}
463 464 465 466 467 468 469 470

	while (!list_empty(&nbd->waiting_queue)) {
		req = list_entry(nbd->waiting_queue.next, struct request,
				 queuelist);
		list_del_init(&req->queuelist);
		req->errors++;
		nbd_end_request(req);
	}
L
Linus Torvalds 已提交
471 472
}

473

474
static void nbd_handle_req(struct nbd_device *nbd, struct request *req)
475
{
476
	if (req->cmd_type != REQ_TYPE_FS)
477 478 479 480
		goto error_out;

	nbd_cmd(req) = NBD_CMD_READ;
	if (rq_data_dir(req) == WRITE) {
P
Paul Clements 已提交
481 482 483 484 485
		if ((req->cmd_flags & REQ_DISCARD)) {
			WARN_ON(!(nbd->flags & NBD_FLAG_SEND_TRIM));
			nbd_cmd(req) = NBD_CMD_TRIM;
		} else
			nbd_cmd(req) = NBD_CMD_WRITE;
P
Paul Clements 已提交
486
		if (nbd->flags & NBD_FLAG_READ_ONLY) {
487
			dev_err(disk_to_dev(nbd->disk),
488
				"Write on read-only\n");
489 490 491 492
			goto error_out;
		}
	}

A
Alex Bligh 已提交
493 494 495 496 497
	if (req->cmd_flags & REQ_FLUSH) {
		BUG_ON(unlikely(blk_rq_sectors(req)));
		nbd_cmd(req) = NBD_CMD_FLUSH;
	}

498 499
	req->errors = 0;

500 501 502 503
	mutex_lock(&nbd->tx_lock);
	if (unlikely(!nbd->sock)) {
		mutex_unlock(&nbd->tx_lock);
		dev_err(disk_to_dev(nbd->disk),
504
			"Attempted send on closed socket\n");
P
Pavel Machek 已提交
505
		goto error_out;
506 507
	}

508
	nbd->active_req = req;
509

510 511
	if (nbd_send_req(nbd, req) != 0) {
		dev_err(disk_to_dev(nbd->disk), "Request send failed\n");
512 513 514
		req->errors++;
		nbd_end_request(req);
	} else {
515
		spin_lock(&nbd->queue_lock);
516
		list_add_tail(&req->queuelist, &nbd->queue_head);
517
		spin_unlock(&nbd->queue_lock);
518 519
	}

520 521 522
	nbd->active_req = NULL;
	mutex_unlock(&nbd->tx_lock);
	wake_up_all(&nbd->active_wq);
523 524 525 526 527 528 529 530 531 532

	return;

error_out:
	req->errors++;
	nbd_end_request(req);
}

static int nbd_thread(void *data)
{
533
	struct nbd_device *nbd = data;
534 535 536
	struct request *req;

	set_user_nice(current, -20);
537
	while (!kthread_should_stop() || !list_empty(&nbd->waiting_queue)) {
538
		/* wait for something to do */
539
		wait_event_interruptible(nbd->waiting_wq,
540
					 kthread_should_stop() ||
541
					 !list_empty(&nbd->waiting_queue));
542 543

		/* extract request */
544
		if (list_empty(&nbd->waiting_queue))
545 546
			continue;

547 548
		spin_lock_irq(&nbd->queue_lock);
		req = list_entry(nbd->waiting_queue.next, struct request,
549 550
				 queuelist);
		list_del_init(&req->queuelist);
551
		spin_unlock_irq(&nbd->queue_lock);
552 553

		/* handle request */
554
		nbd_handle_req(nbd, req);
555 556 557 558
	}
	return 0;
}

L
Linus Torvalds 已提交
559 560 561
/*
 * We always wait for result of write, for now. It would be nice to make it optional
 * in future
562
 * if ((rq_data_dir(req) == WRITE) && (nbd->flags & NBD_WRITE_NOCHK))
L
Linus Torvalds 已提交
563 564 565
 *   { printk( "Warning: Ignoring result!\n"); nbd_end_request( req ); }
 */

P
Pavel Machek 已提交
566
static void do_nbd_request(struct request_queue *q)
A
Alex Elder 已提交
567
		__releases(q->queue_lock) __acquires(q->queue_lock)
L
Linus Torvalds 已提交
568 569 570
{
	struct request *req;
	
571
	while ((req = blk_fetch_request(q)) != NULL) {
572
		struct nbd_device *nbd;
L
Linus Torvalds 已提交
573

574 575
		spin_unlock_irq(q->queue_lock);

576 577
		dprintk(DBG_BLKDEV, "%s: request %p: dequeued (flags=%x)\n",
				req->rq_disk->disk_name, req, req->cmd_type);
L
Linus Torvalds 已提交
578

579
		nbd = req->rq_disk->private_data;
L
Linus Torvalds 已提交
580

581
		BUG_ON(nbd->magic != NBD_MAGIC);
L
Linus Torvalds 已提交
582

583 584
		if (unlikely(!nbd->sock)) {
			dev_err(disk_to_dev(nbd->disk),
585
				"Attempted send on closed socket\n");
586 587 588 589 590 591
			req->errors++;
			nbd_end_request(req);
			spin_lock_irq(q->queue_lock);
			continue;
		}

592 593 594
		spin_lock_irq(&nbd->queue_lock);
		list_add_tail(&req->queuelist, &nbd->waiting_queue);
		spin_unlock_irq(&nbd->queue_lock);
L
Linus Torvalds 已提交
595

596
		wake_up(&nbd->waiting_wq);
597

L
Linus Torvalds 已提交
598 599 600 601
		spin_lock_irq(q->queue_lock);
	}
}

P
Pavel Machek 已提交
602
/* Must be called with tx_lock held */
L
Linus Torvalds 已提交
603

604
static int __nbd_ioctl(struct block_device *bdev, struct nbd_device *nbd,
P
Pavel Machek 已提交
605 606
		       unsigned int cmd, unsigned long arg)
{
L
Linus Torvalds 已提交
607
	switch (cmd) {
P
Pavel Machek 已提交
608 609 610
	case NBD_DISCONNECT: {
		struct request sreq;

611
		dev_info(disk_to_dev(nbd->disk), "NBD_DISCONNECT\n");
612 613
		if (!nbd->sock)
			return -EINVAL;
P
Pavel Machek 已提交
614

615 616 617
		mutex_unlock(&nbd->tx_lock);
		fsync_bdev(bdev);
		mutex_lock(&nbd->tx_lock);
618
		blk_rq_init(NULL, &sreq);
619
		sreq.cmd_type = REQ_TYPE_SPECIAL;
L
Linus Torvalds 已提交
620
		nbd_cmd(&sreq) = NBD_CMD_DISC;
621 622

		/* Check again after getting mutex back.  */
623
		if (!nbd->sock)
L
Linus Torvalds 已提交
624
			return -EINVAL;
625

P
Paul Clements 已提交
626 627
		nbd->disconnect = 1;

628
		nbd_send_req(nbd, &sreq);
P
Paul Clements 已提交
629
		return 0;
P
Pavel Machek 已提交
630
	}
L
Linus Torvalds 已提交
631
 
P
Pavel Machek 已提交
632 633 634
	case NBD_CLEAR_SOCK: {
		struct file *file;

635 636 637 638 639
		nbd->sock = NULL;
		file = nbd->file;
		nbd->file = NULL;
		nbd_clear_que(nbd);
		BUG_ON(!list_empty(&nbd->queue_head));
640
		BUG_ON(!list_empty(&nbd->waiting_queue));
641
		kill_bdev(bdev);
L
Linus Torvalds 已提交
642 643
		if (file)
			fput(file);
P
Pavel Machek 已提交
644 645 646 647 648
		return 0;
	}

	case NBD_SET_SOCK: {
		struct file *file;
649
		if (nbd->file)
L
Linus Torvalds 已提交
650 651 652
			return -EBUSY;
		file = fget(arg);
		if (file) {
A
Al Viro 已提交
653
			struct inode *inode = file_inode(file);
L
Linus Torvalds 已提交
654
			if (S_ISSOCK(inode->i_mode)) {
655 656
				nbd->file = file;
				nbd->sock = SOCKET_I(inode);
L
Laurent Vivier 已提交
657 658
				if (max_part > 0)
					bdev->bd_invalidated = 1;
P
Paul Clements 已提交
659
				nbd->disconnect = 0; /* we're connected now */
P
Pavel Machek 已提交
660
				return 0;
L
Linus Torvalds 已提交
661 662 663 664
			} else {
				fput(file);
			}
		}
P
Pavel Machek 已提交
665 666 667
		return -EINVAL;
	}

L
Linus Torvalds 已提交
668
	case NBD_SET_BLKSIZE:
669 670 671 672 673
		nbd->blksize = arg;
		nbd->bytesize &= ~(nbd->blksize-1);
		bdev->bd_inode->i_size = nbd->bytesize;
		set_blocksize(bdev, nbd->blksize);
		set_capacity(nbd->disk, nbd->bytesize >> 9);
L
Linus Torvalds 已提交
674
		return 0;
P
Pavel Machek 已提交
675

L
Linus Torvalds 已提交
676
	case NBD_SET_SIZE:
677 678 679 680
		nbd->bytesize = arg & ~(nbd->blksize-1);
		bdev->bd_inode->i_size = nbd->bytesize;
		set_blocksize(bdev, nbd->blksize);
		set_capacity(nbd->disk, nbd->bytesize >> 9);
L
Linus Torvalds 已提交
681
		return 0;
P
Pavel Machek 已提交
682

683
	case NBD_SET_TIMEOUT:
684
		nbd->xmit_timeout = arg * HZ;
685
		return 0;
P
Pavel Machek 已提交
686

P
Paul Clements 已提交
687 688 689 690
	case NBD_SET_FLAGS:
		nbd->flags = arg;
		return 0;

L
Linus Torvalds 已提交
691
	case NBD_SET_SIZE_BLOCKS:
692 693 694 695
		nbd->bytesize = ((u64) arg) * nbd->blksize;
		bdev->bd_inode->i_size = nbd->bytesize;
		set_blocksize(bdev, nbd->blksize);
		set_capacity(nbd->disk, nbd->bytesize >> 9);
L
Linus Torvalds 已提交
696
		return 0;
P
Pavel Machek 已提交
697 698 699 700 701 702

	case NBD_DO_IT: {
		struct task_struct *thread;
		struct file *file;
		int error;

703
		if (nbd->pid)
704
			return -EBUSY;
705
		if (!nbd->file)
L
Linus Torvalds 已提交
706
			return -EINVAL;
P
Pavel Machek 已提交
707

708
		mutex_unlock(&nbd->tx_lock);
P
Pavel Machek 已提交
709

710 711
		if (nbd->flags & NBD_FLAG_READ_ONLY)
			set_device_ro(bdev, true);
P
Paul Clements 已提交
712 713 714
		if (nbd->flags & NBD_FLAG_SEND_TRIM)
			queue_flag_set_unlocked(QUEUE_FLAG_DISCARD,
				nbd->disk->queue);
A
Alex Bligh 已提交
715 716 717 718
		if (nbd->flags & NBD_FLAG_SEND_FLUSH)
			blk_queue_flush(nbd->disk->queue, REQ_FLUSH);
		else
			blk_queue_flush(nbd->disk->queue, 0);
P
Paul Clements 已提交
719

720 721
		thread = kthread_create(nbd_thread, nbd, "%s",
					nbd->disk->disk_name);
P
Pavel Machek 已提交
722
		if (IS_ERR(thread)) {
723
			mutex_lock(&nbd->tx_lock);
724
			return PTR_ERR(thread);
P
Pavel Machek 已提交
725
		}
726
		wake_up_process(thread);
727
		error = nbd_do_it(nbd);
728
		kthread_stop(thread);
P
Pavel Machek 已提交
729

730
		mutex_lock(&nbd->tx_lock);
731 732
		if (error)
			return error;
733 734 735 736 737
		sock_shutdown(nbd, 0);
		file = nbd->file;
		nbd->file = NULL;
		nbd_clear_que(nbd);
		dev_warn(disk_to_dev(nbd->disk), "queue cleared\n");
738
		kill_bdev(bdev);
P
Paul Clements 已提交
739
		queue_flag_clear_unlocked(QUEUE_FLAG_DISCARD, nbd->disk->queue);
740
		set_device_ro(bdev, false);
L
Linus Torvalds 已提交
741 742
		if (file)
			fput(file);
A
Alex Bligh 已提交
743
		nbd->flags = 0;
744
		nbd->bytesize = 0;
A
Al Viro 已提交
745
		bdev->bd_inode->i_size = 0;
746
		set_capacity(nbd->disk, 0);
L
Laurent Vivier 已提交
747
		if (max_part > 0)
A
Al Viro 已提交
748
			ioctl_by_bdev(bdev, BLKRRPART, 0);
P
Paul Clements 已提交
749 750
		if (nbd->disconnect) /* user requested, ignore socket errors */
			return 0;
751
		return nbd->harderror;
P
Pavel Machek 已提交
752 753
	}

L
Linus Torvalds 已提交
754
	case NBD_CLEAR_QUE:
755 756 757 758
		/*
		 * This is for compatibility only.  The queue is always cleared
		 * by NBD_DO_IT or NBD_CLEAR_SOCK.
		 */
L
Linus Torvalds 已提交
759
		return 0;
P
Pavel Machek 已提交
760

L
Linus Torvalds 已提交
761
	case NBD_PRINT_DEBUG:
762
		dev_info(disk_to_dev(nbd->disk),
763
			"next = %p, prev = %p, head = %p\n",
764 765
			nbd->queue_head.next, nbd->queue_head.prev,
			&nbd->queue_head);
L
Linus Torvalds 已提交
766 767
		return 0;
	}
P
Pavel Machek 已提交
768 769 770 771 772 773
	return -ENOTTY;
}

static int nbd_ioctl(struct block_device *bdev, fmode_t mode,
		     unsigned int cmd, unsigned long arg)
{
774
	struct nbd_device *nbd = bdev->bd_disk->private_data;
P
Pavel Machek 已提交
775 776 777 778 779
	int error;

	if (!capable(CAP_SYS_ADMIN))
		return -EPERM;

780
	BUG_ON(nbd->magic != NBD_MAGIC);
P
Pavel Machek 已提交
781 782 783

	/* Anyone capable of this syscall can do *real bad* things */
	dprintk(DBG_IOCTL, "%s: nbd_ioctl cmd=%s(0x%x) arg=%lu\n",
784
		nbd->disk->disk_name, ioctl_cmd_to_ascii(cmd), cmd, arg);
P
Pavel Machek 已提交
785

786 787 788
	mutex_lock(&nbd->tx_lock);
	error = __nbd_ioctl(bdev, nbd, cmd, arg);
	mutex_unlock(&nbd->tx_lock);
P
Pavel Machek 已提交
789 790

	return error;
L
Linus Torvalds 已提交
791 792
}

793
static const struct block_device_operations nbd_fops =
L
Linus Torvalds 已提交
794 795
{
	.owner =	THIS_MODULE,
796
	.ioctl =	nbd_ioctl,
L
Linus Torvalds 已提交
797 798 799 800 801 802 803 804 805 806 807
};

/*
 * And here should be modules and kernel interface 
 *  (Just smiley confuses emacs :-)
 */

static int __init nbd_init(void)
{
	int err = -ENOMEM;
	int i;
L
Laurent Vivier 已提交
808
	int part_shift;
L
Linus Torvalds 已提交
809

810
	BUILD_BUG_ON(sizeof(struct nbd_request) != 28);
L
Linus Torvalds 已提交
811

L
Laurent Vivier 已提交
812
	if (max_part < 0) {
813
		printk(KERN_ERR "nbd: max_part must be >= 0\n");
L
Laurent Vivier 已提交
814 815 816
		return -EINVAL;
	}

817 818 819 820
	nbd_dev = kcalloc(nbds_max, sizeof(*nbd_dev), GFP_KERNEL);
	if (!nbd_dev)
		return -ENOMEM;

L
Laurent Vivier 已提交
821
	part_shift = 0;
822
	if (max_part > 0) {
L
Laurent Vivier 已提交
823 824
		part_shift = fls(max_part);

825 826 827 828 829 830 831 832 833 834 835
		/*
		 * Adjust max_part according to part_shift as it is exported
		 * to user space so that user can know the max number of
		 * partition kernel should be able to manage.
		 *
		 * Note that -1 is required because partition 0 is reserved
		 * for the whole disk.
		 */
		max_part = (1UL << part_shift) - 1;
	}

836 837 838 839 840 841
	if ((1UL << part_shift) > DISK_MAX_PARTS)
		return -EINVAL;

	if (nbds_max > 1UL << (MINORBITS - part_shift))
		return -EINVAL;

842
	for (i = 0; i < nbds_max; i++) {
L
Laurent Vivier 已提交
843
		struct gendisk *disk = alloc_disk(1 << part_shift);
L
Linus Torvalds 已提交
844 845 846 847 848 849 850 851 852 853 854 855 856
		if (!disk)
			goto out;
		nbd_dev[i].disk = disk;
		/*
		 * The new linux 2.5 block layer implementation requires
		 * every gendisk to have its very own request_queue struct.
		 * These structs are big so we dynamically allocate them.
		 */
		disk->queue = blk_init_queue(do_nbd_request, &nbd_lock);
		if (!disk->queue) {
			put_disk(disk);
			goto out;
		}
857 858 859 860
		/*
		 * Tell the block layer that we are not a rotational device
		 */
		queue_flag_set_unlocked(QUEUE_FLAG_NONROT, disk->queue);
P
Paul Clements 已提交
861 862 863
		disk->queue->limits.discard_granularity = 512;
		disk->queue->limits.max_discard_sectors = UINT_MAX;
		disk->queue->limits.discard_zeroes_data = 0;
864 865
		blk_queue_max_hw_sectors(disk->queue, 65536);
		disk->queue->limits.max_sectors = 256;
L
Linus Torvalds 已提交
866 867 868 869 870 871 872 873 874 875
	}

	if (register_blkdev(NBD_MAJOR, "nbd")) {
		err = -EIO;
		goto out;
	}

	printk(KERN_INFO "nbd: registered device at major %d\n", NBD_MAJOR);
	dprintk(DBG_INIT, "nbd: debugflags=0x%x\n", debugflags);

876
	for (i = 0; i < nbds_max; i++) {
L
Linus Torvalds 已提交
877 878
		struct gendisk *disk = nbd_dev[i].disk;
		nbd_dev[i].file = NULL;
879
		nbd_dev[i].magic = NBD_MAGIC;
L
Linus Torvalds 已提交
880
		nbd_dev[i].flags = 0;
881
		INIT_LIST_HEAD(&nbd_dev[i].waiting_queue);
L
Linus Torvalds 已提交
882 883
		spin_lock_init(&nbd_dev[i].queue_lock);
		INIT_LIST_HEAD(&nbd_dev[i].queue_head);
884
		mutex_init(&nbd_dev[i].tx_lock);
885
		init_waitqueue_head(&nbd_dev[i].active_wq);
886
		init_waitqueue_head(&nbd_dev[i].waiting_wq);
L
Linus Torvalds 已提交
887
		nbd_dev[i].blksize = 1024;
888
		nbd_dev[i].bytesize = 0;
L
Linus Torvalds 已提交
889
		disk->major = NBD_MAJOR;
L
Laurent Vivier 已提交
890
		disk->first_minor = i << part_shift;
L
Linus Torvalds 已提交
891 892 893
		disk->fops = &nbd_fops;
		disk->private_data = &nbd_dev[i];
		sprintf(disk->disk_name, "nbd%d", i);
894
		set_capacity(disk, 0);
L
Linus Torvalds 已提交
895 896 897 898 899 900 901 902 903
		add_disk(disk);
	}

	return 0;
out:
	while (i--) {
		blk_cleanup_queue(nbd_dev[i].disk->queue);
		put_disk(nbd_dev[i].disk);
	}
904
	kfree(nbd_dev);
L
Linus Torvalds 已提交
905 906 907 908 909 910
	return err;
}

static void __exit nbd_cleanup(void)
{
	int i;
911
	for (i = 0; i < nbds_max; i++) {
L
Linus Torvalds 已提交
912
		struct gendisk *disk = nbd_dev[i].disk;
913
		nbd_dev[i].magic = 0;
L
Linus Torvalds 已提交
914 915 916 917 918 919 920
		if (disk) {
			del_gendisk(disk);
			blk_cleanup_queue(disk->queue);
			put_disk(disk);
		}
	}
	unregister_blkdev(NBD_MAJOR, "nbd");
921
	kfree(nbd_dev);
L
Linus Torvalds 已提交
922 923 924 925 926 927 928 929 930
	printk(KERN_INFO "nbd: unregistered device at major %d\n", NBD_MAJOR);
}

module_init(nbd_init);
module_exit(nbd_cleanup);

MODULE_DESCRIPTION("Network Block Device");
MODULE_LICENSE("GPL");

931
module_param(nbds_max, int, 0444);
L
Laurent Vivier 已提交
932 933 934
MODULE_PARM_DESC(nbds_max, "number of network block devices to initialize (default: 16)");
module_param(max_part, int, 0444);
MODULE_PARM_DESC(max_part, "number of partitions per device (default: 0)");
L
Linus Torvalds 已提交
935 936 937 938
#ifndef NDEBUG
module_param(debugflags, int, 0644);
MODULE_PARM_DESC(debugflags, "flags for controlling debug output");
#endif