blob: 4d6de4f15ccb34dd4039ed4bf3e53b5993751958 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Network block device - make block devices work over TCP
3 *
4 * Note that you can not swap over this thing, yet. Seems to work but
5 * deadlocks sometimes - you can not swap over TCP in general.
6 *
Pavel Machek15746fc2009-04-02 16:58:42 -07007 * Copyright 1997-2000, 2008 Pavel Machek <pavel@suse.cz>
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 * Parts copyright 2001 Steven Whitehouse <steve@chygwyn.com>
9 *
Pavel Machekdbf492d2006-06-25 05:47:42 -070010 * This file is released under GPLv2 or later.
Linus Torvalds1da177e2005-04-16 15:20:36 -070011 *
Pavel Machekdbf492d2006-06-25 05:47:42 -070012 * (part of code stolen from loop.c)
Linus Torvalds1da177e2005-04-16 15:20:36 -070013 */
14
15#include <linux/major.h>
16
17#include <linux/blkdev.h>
18#include <linux/module.h>
19#include <linux/init.h>
20#include <linux/sched.h>
21#include <linux/fs.h>
22#include <linux/bio.h>
23#include <linux/stat.h>
24#include <linux/errno.h>
25#include <linux/file.h>
26#include <linux/ioctl.h>
Herbert Xu4b2f0262006-01-06 00:09:47 -080027#include <linux/compiler.h>
28#include <linux/err.h>
29#include <linux/kernel.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#include <net/sock.h>
Trond Myklebust91cf45f2007-11-12 18:10:39 -080031#include <linux/net.h>
Laurent Vivier48cf6062008-04-29 01:02:46 -070032#include <linux/kthread.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070033
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#include <asm/uaccess.h>
Herbert Xu4b2f0262006-01-06 00:09:47 -080035#include <asm/system.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#include <asm/types.h>
37
38#include <linux/nbd.h>
39
40#define LO_MAGIC 0x68797548
41
42#ifdef NDEBUG
43#define dprintk(flags, fmt...)
44#else /* NDEBUG */
45#define dprintk(flags, fmt...) do { \
46 if (debugflags & (flags)) printk(KERN_DEBUG fmt); \
47} while (0)
48#define DBG_IOCTL 0x0004
49#define DBG_INIT 0x0010
50#define DBG_EXIT 0x0020
51#define DBG_BLKDEV 0x0100
52#define DBG_RX 0x0200
53#define DBG_TX 0x0400
54static unsigned int debugflags;
55#endif /* NDEBUG */
56
Ingo van Lil9c7a4162006-07-01 04:36:36 -070057static unsigned int nbds_max = 16;
Paul Clements20a81432008-02-08 04:21:51 -080058static struct nbd_device *nbd_dev;
Laurent Vivierd71a6d72008-04-29 01:02:51 -070059static int max_part;
Linus Torvalds1da177e2005-04-16 15:20:36 -070060
61/*
62 * Use just one lock (or at most 1 per NIC). Two arguments for this:
63 * 1. Each NIC is essentially a synchronization point for all servers
64 * accessed through that NIC so there's no need to have more locks
65 * than NICs anyway.
66 * 2. More locks lead to more "Dirty cache line bouncing" which will slow
67 * down each lock to the point where they're actually slower than just
68 * a single lock.
69 * Thanks go to Jens Axboe and Al Viro for their LKML emails explaining this!
70 */
71static DEFINE_SPINLOCK(nbd_lock);
72
73#ifndef NDEBUG
74static const char *ioctl_cmd_to_ascii(int cmd)
75{
76 switch (cmd) {
77 case NBD_SET_SOCK: return "set-sock";
78 case NBD_SET_BLKSIZE: return "set-blksize";
79 case NBD_SET_SIZE: return "set-size";
80 case NBD_DO_IT: return "do-it";
81 case NBD_CLEAR_SOCK: return "clear-sock";
82 case NBD_CLEAR_QUE: return "clear-que";
83 case NBD_PRINT_DEBUG: return "print-debug";
84 case NBD_SET_SIZE_BLOCKS: return "set-size-blocks";
85 case NBD_DISCONNECT: return "disconnect";
86 case BLKROSET: return "set-read-only";
87 case BLKFLSBUF: return "flush-buffer-cache";
88 }
89 return "unknown";
90}
91
92static const char *nbdcmd_to_ascii(int cmd)
93{
94 switch (cmd) {
95 case NBD_CMD_READ: return "read";
96 case NBD_CMD_WRITE: return "write";
97 case NBD_CMD_DISC: return "disconnect";
98 }
99 return "invalid";
100}
101#endif /* NDEBUG */
102
103static void nbd_end_request(struct request *req)
104{
Kiyoshi Ueda097c94a2007-12-11 17:44:06 -0500105 int error = req->errors ? -EIO : 0;
Jens Axboe165125e2007-07-24 09:28:11 +0200106 struct request_queue *q = req->q;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107 unsigned long flags;
108
109 dprintk(DBG_BLKDEV, "%s: request %p: %s\n", req->rq_disk->disk_name,
Kiyoshi Ueda097c94a2007-12-11 17:44:06 -0500110 req, error ? "failed" : "done");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
112 spin_lock_irqsave(q->queue_lock, flags);
Kiyoshi Ueda097c94a2007-12-11 17:44:06 -0500113 __blk_end_request(req, error, req->nr_sectors << 9);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 spin_unlock_irqrestore(q->queue_lock, flags);
115}
116
Paul Clements7fdfd402007-10-16 23:27:37 -0700117static void sock_shutdown(struct nbd_device *lo, int lock)
118{
119 /* Forcibly shutdown the socket causing all listeners
120 * to error
121 *
122 * FIXME: This code is duplicated from sys_shutdown, but
123 * there should be a more generic interface rather than
124 * calling socket ops directly here */
125 if (lock)
126 mutex_lock(&lo->tx_lock);
127 if (lo->sock) {
128 printk(KERN_WARNING "%s: shutting down socket\n",
129 lo->disk->disk_name);
Trond Myklebust91cf45f2007-11-12 18:10:39 -0800130 kernel_sock_shutdown(lo->sock, SHUT_RDWR);
Paul Clements7fdfd402007-10-16 23:27:37 -0700131 lo->sock = NULL;
132 }
133 if (lock)
134 mutex_unlock(&lo->tx_lock);
135}
136
137static void nbd_xmit_timeout(unsigned long arg)
138{
139 struct task_struct *task = (struct task_struct *)arg;
140
141 printk(KERN_WARNING "nbd: killing hung xmit (%s, pid: %d)\n",
142 task->comm, task->pid);
143 force_sig(SIGKILL, task);
144}
145
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146/*
147 * Send or receive packet.
148 */
Paul Clements7fdfd402007-10-16 23:27:37 -0700149static int sock_xmit(struct nbd_device *lo, int send, void *buf, int size,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 int msg_flags)
151{
Paul Clements7fdfd402007-10-16 23:27:37 -0700152 struct socket *sock = lo->sock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 int result;
154 struct msghdr msg;
155 struct kvec iov;
Oleg Nesterovbe0ef952007-07-15 23:41:32 -0700156 sigset_t blocked, oldset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157
Mike Snitzerffc41cf2008-04-02 13:04:47 -0700158 if (unlikely(!sock)) {
159 printk(KERN_ERR "%s: Attempted %s on closed socket in sock_xmit\n",
160 lo->disk->disk_name, (send ? "send" : "recv"));
161 return -EINVAL;
162 }
163
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164 /* Allow interception of SIGKILL only
165 * Don't allow other signals to interrupt the transmission */
Oleg Nesterovbe0ef952007-07-15 23:41:32 -0700166 siginitsetinv(&blocked, sigmask(SIGKILL));
167 sigprocmask(SIG_SETMASK, &blocked, &oldset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168
169 do {
170 sock->sk->sk_allocation = GFP_NOIO;
171 iov.iov_base = buf;
172 iov.iov_len = size;
173 msg.msg_name = NULL;
174 msg.msg_namelen = 0;
175 msg.msg_control = NULL;
176 msg.msg_controllen = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177 msg.msg_flags = msg_flags | MSG_NOSIGNAL;
178
Paul Clements7fdfd402007-10-16 23:27:37 -0700179 if (send) {
180 struct timer_list ti;
181
182 if (lo->xmit_timeout) {
183 init_timer(&ti);
184 ti.function = nbd_xmit_timeout;
185 ti.data = (unsigned long)current;
186 ti.expires = jiffies + lo->xmit_timeout;
187 add_timer(&ti);
188 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 result = kernel_sendmsg(sock, &msg, &iov, 1, size);
Paul Clements7fdfd402007-10-16 23:27:37 -0700190 if (lo->xmit_timeout)
191 del_timer_sync(&ti);
192 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 result = kernel_recvmsg(sock, &msg, &iov, 1, size, 0);
194
195 if (signal_pending(current)) {
196 siginfo_t info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 printk(KERN_WARNING "nbd (pid %d: %s) got signal %d\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -0700198 task_pid_nr(current), current->comm,
Oleg Nesterovbe0ef952007-07-15 23:41:32 -0700199 dequeue_signal_lock(current, &current->blocked, &info));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 result = -EINTR;
Paul Clements7fdfd402007-10-16 23:27:37 -0700201 sock_shutdown(lo, !send);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202 break;
203 }
204
205 if (result <= 0) {
206 if (result == 0)
207 result = -EPIPE; /* short read */
208 break;
209 }
210 size -= result;
211 buf += result;
212 } while (size > 0);
213
Oleg Nesterovbe0ef952007-07-15 23:41:32 -0700214 sigprocmask(SIG_SETMASK, &oldset, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215
216 return result;
217}
218
Paul Clements7fdfd402007-10-16 23:27:37 -0700219static inline int sock_send_bvec(struct nbd_device *lo, struct bio_vec *bvec,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 int flags)
221{
222 int result;
223 void *kaddr = kmap(bvec->bv_page);
Paul Clements7fdfd402007-10-16 23:27:37 -0700224 result = sock_xmit(lo, 1, kaddr + bvec->bv_offset, bvec->bv_len, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225 kunmap(bvec->bv_page);
226 return result;
227}
228
Paul Clements7fdfd402007-10-16 23:27:37 -0700229/* always call with the tx_lock held */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230static int nbd_send_req(struct nbd_device *lo, struct request *req)
231{
NeilBrown5705f702007-09-25 12:35:59 +0200232 int result, flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 struct nbd_request request;
234 unsigned long size = req->nr_sectors << 9;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235
236 request.magic = htonl(NBD_REQUEST_MAGIC);
237 request.type = htonl(nbd_cmd(req));
238 request.from = cpu_to_be64((u64) req->sector << 9);
239 request.len = htonl(size);
240 memcpy(request.handle, &req, sizeof(req));
241
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 dprintk(DBG_TX, "%s: request %p: sending control (%s@%llu,%luB)\n",
243 lo->disk->disk_name, req,
244 nbdcmd_to_ascii(nbd_cmd(req)),
245 (unsigned long long)req->sector << 9,
246 req->nr_sectors << 9);
Paul Clements7fdfd402007-10-16 23:27:37 -0700247 result = sock_xmit(lo, 1, &request, sizeof(request),
248 (nbd_cmd(req) == NBD_CMD_WRITE) ? MSG_MORE : 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 if (result <= 0) {
250 printk(KERN_ERR "%s: Send control failed (result %d)\n",
251 lo->disk->disk_name, result);
252 goto error_out;
253 }
254
255 if (nbd_cmd(req) == NBD_CMD_WRITE) {
NeilBrown5705f702007-09-25 12:35:59 +0200256 struct req_iterator iter;
257 struct bio_vec *bvec;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 /*
259 * we are really probing at internals to determine
260 * whether to set MSG_MORE or not...
261 */
NeilBrown5705f702007-09-25 12:35:59 +0200262 rq_for_each_segment(bvec, req, iter) {
Jens Axboe6c92e692007-08-16 13:43:12 +0200263 flags = 0;
264 if (!rq_iter_last(req, iter))
265 flags = MSG_MORE;
266 dprintk(DBG_TX, "%s: request %p: sending %d bytes data\n",
267 lo->disk->disk_name, req, bvec->bv_len);
Paul Clements7fdfd402007-10-16 23:27:37 -0700268 result = sock_send_bvec(lo, bvec, flags);
Jens Axboe6c92e692007-08-16 13:43:12 +0200269 if (result <= 0) {
270 printk(KERN_ERR "%s: Send data failed (result %d)\n",
271 lo->disk->disk_name, result);
272 goto error_out;
273 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 }
275 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276 return 0;
277
278error_out:
Pavel Machek15746fc2009-04-02 16:58:42 -0700279 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280}
281
Denis Cheng0cbc591b2007-10-16 23:26:14 -0700282static struct request *nbd_find_request(struct nbd_device *lo,
283 struct request *xreq)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284{
Denis Chengd2c97402007-10-16 23:26:14 -0700285 struct request *req, *tmp;
Herbert Xu4b2f0262006-01-06 00:09:47 -0800286 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287
Herbert Xu4b2f0262006-01-06 00:09:47 -0800288 err = wait_event_interruptible(lo->active_wq, lo->active_req != xreq);
289 if (unlikely(err))
290 goto out;
291
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292 spin_lock(&lo->queue_lock);
Denis Chengd2c97402007-10-16 23:26:14 -0700293 list_for_each_entry_safe(req, tmp, &lo->queue_head, queuelist) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 if (req != xreq)
295 continue;
296 list_del_init(&req->queuelist);
297 spin_unlock(&lo->queue_lock);
298 return req;
299 }
300 spin_unlock(&lo->queue_lock);
Herbert Xu4b2f0262006-01-06 00:09:47 -0800301
302 err = -ENOENT;
303
304out:
305 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306}
307
Paul Clements7fdfd402007-10-16 23:27:37 -0700308static inline int sock_recv_bvec(struct nbd_device *lo, struct bio_vec *bvec)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309{
310 int result;
311 void *kaddr = kmap(bvec->bv_page);
Paul Clements7fdfd402007-10-16 23:27:37 -0700312 result = sock_xmit(lo, 0, kaddr + bvec->bv_offset, bvec->bv_len,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313 MSG_WAITALL);
314 kunmap(bvec->bv_page);
315 return result;
316}
317
318/* NULL returned = something went wrong, inform userspace */
319static struct request *nbd_read_stat(struct nbd_device *lo)
320{
321 int result;
322 struct nbd_reply reply;
323 struct request *req;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324
325 reply.magic = 0;
Paul Clements7fdfd402007-10-16 23:27:37 -0700326 result = sock_xmit(lo, 0, &reply, sizeof(reply), MSG_WAITALL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 if (result <= 0) {
328 printk(KERN_ERR "%s: Receive control failed (result %d)\n",
329 lo->disk->disk_name, result);
330 goto harderror;
331 }
Michal Feixe4b57e02006-07-30 03:03:31 -0700332
333 if (ntohl(reply.magic) != NBD_REPLY_MAGIC) {
334 printk(KERN_ERR "%s: Wrong magic (0x%lx)\n",
335 lo->disk->disk_name,
336 (unsigned long)ntohl(reply.magic));
337 result = -EPROTO;
338 goto harderror;
339 }
340
Denis Cheng0cbc591b2007-10-16 23:26:14 -0700341 req = nbd_find_request(lo, *(struct request **)reply.handle);
Hirofumi Nakagawa801678c2008-04-29 01:03:09 -0700342 if (IS_ERR(req)) {
Herbert Xu4b2f0262006-01-06 00:09:47 -0800343 result = PTR_ERR(req);
344 if (result != -ENOENT)
345 goto harderror;
346
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347 printk(KERN_ERR "%s: Unexpected reply (%p)\n",
348 lo->disk->disk_name, reply.handle);
349 result = -EBADR;
350 goto harderror;
351 }
352
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 if (ntohl(reply.error)) {
354 printk(KERN_ERR "%s: Other side returned error (%d)\n",
355 lo->disk->disk_name, ntohl(reply.error));
356 req->errors++;
357 return req;
358 }
359
360 dprintk(DBG_RX, "%s: request %p: got reply\n",
361 lo->disk->disk_name, req);
362 if (nbd_cmd(req) == NBD_CMD_READ) {
NeilBrown5705f702007-09-25 12:35:59 +0200363 struct req_iterator iter;
364 struct bio_vec *bvec;
365
366 rq_for_each_segment(bvec, req, iter) {
Paul Clements7fdfd402007-10-16 23:27:37 -0700367 result = sock_recv_bvec(lo, bvec);
Jens Axboe6c92e692007-08-16 13:43:12 +0200368 if (result <= 0) {
369 printk(KERN_ERR "%s: Receive data failed (result %d)\n",
370 lo->disk->disk_name, result);
371 req->errors++;
372 return req;
373 }
374 dprintk(DBG_RX, "%s: request %p: got %d bytes data\n",
375 lo->disk->disk_name, req, bvec->bv_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 }
377 }
378 return req;
379harderror:
380 lo->harderror = result;
381 return NULL;
382}
383
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200384static ssize_t pid_show(struct device *dev,
385 struct device_attribute *attr, char *buf)
Paul Clements6b39bb62006-12-06 20:40:53 -0800386{
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200387 struct gendisk *disk = dev_to_disk(dev);
388
389 return sprintf(buf, "%ld\n",
Paul Clements6b39bb62006-12-06 20:40:53 -0800390 (long) ((struct nbd_device *)disk->private_data)->pid);
391}
392
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200393static struct device_attribute pid_attr = {
Parag Warudkar01e8ef12008-10-18 20:28:50 -0700394 .attr = { .name = "pid", .mode = S_IRUGO},
Paul Clements6b39bb62006-12-06 20:40:53 -0800395 .show = pid_show,
396};
397
WANG Cong84963042007-05-09 02:33:36 -0700398static int nbd_do_it(struct nbd_device *lo)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399{
400 struct request *req;
WANG Cong84963042007-05-09 02:33:36 -0700401 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402
403 BUG_ON(lo->magic != LO_MAGIC);
404
Paul Clements6b39bb62006-12-06 20:40:53 -0800405 lo->pid = current->pid;
Tejun Heoed9e1982008-08-25 19:56:05 +0900406 ret = sysfs_create_file(&disk_to_dev(lo->disk)->kobj, &pid_attr.attr);
WANG Cong84963042007-05-09 02:33:36 -0700407 if (ret) {
408 printk(KERN_ERR "nbd: sysfs_create_file failed!");
Pavel Machekc91192d2009-01-15 13:51:03 -0800409 lo->pid = 0;
WANG Cong84963042007-05-09 02:33:36 -0700410 return ret;
411 }
Paul Clements6b39bb62006-12-06 20:40:53 -0800412
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413 while ((req = nbd_read_stat(lo)) != NULL)
414 nbd_end_request(req);
Paul Clements6b39bb62006-12-06 20:40:53 -0800415
Tejun Heoed9e1982008-08-25 19:56:05 +0900416 sysfs_remove_file(&disk_to_dev(lo->disk)->kobj, &pid_attr.attr);
Pavel Machekc91192d2009-01-15 13:51:03 -0800417 lo->pid = 0;
WANG Cong84963042007-05-09 02:33:36 -0700418 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419}
420
421static void nbd_clear_que(struct nbd_device *lo)
422{
423 struct request *req;
424
425 BUG_ON(lo->magic != LO_MAGIC);
426
Herbert Xu4b2f0262006-01-06 00:09:47 -0800427 /*
428 * Because we have set lo->sock to NULL under the tx_lock, all
429 * modifications to the list must have completed by now. For
430 * the same reason, the active_req must be NULL.
431 *
432 * As a consequence, we don't need to take the spin lock while
433 * purging the list here.
434 */
435 BUG_ON(lo->sock);
436 BUG_ON(lo->active_req);
437
438 while (!list_empty(&lo->queue_head)) {
439 req = list_entry(lo->queue_head.next, struct request,
440 queuelist);
441 list_del_init(&req->queuelist);
442 req->errors++;
443 nbd_end_request(req);
444 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445}
446
Paul Clements7fdfd402007-10-16 23:27:37 -0700447
Laurent Vivier48cf6062008-04-29 01:02:46 -0700448static void nbd_handle_req(struct nbd_device *lo, struct request *req)
449{
450 if (!blk_fs_request(req))
451 goto error_out;
452
453 nbd_cmd(req) = NBD_CMD_READ;
454 if (rq_data_dir(req) == WRITE) {
455 nbd_cmd(req) = NBD_CMD_WRITE;
456 if (lo->flags & NBD_READ_ONLY) {
457 printk(KERN_ERR "%s: Write on read-only\n",
458 lo->disk->disk_name);
459 goto error_out;
460 }
461 }
462
463 req->errors = 0;
464
465 mutex_lock(&lo->tx_lock);
466 if (unlikely(!lo->sock)) {
467 mutex_unlock(&lo->tx_lock);
468 printk(KERN_ERR "%s: Attempted send on closed socket\n",
469 lo->disk->disk_name);
Pavel Machek15746fc2009-04-02 16:58:42 -0700470 goto error_out;
Laurent Vivier48cf6062008-04-29 01:02:46 -0700471 }
472
473 lo->active_req = req;
474
475 if (nbd_send_req(lo, req) != 0) {
476 printk(KERN_ERR "%s: Request send failed\n",
477 lo->disk->disk_name);
478 req->errors++;
479 nbd_end_request(req);
480 } else {
481 spin_lock(&lo->queue_lock);
482 list_add(&req->queuelist, &lo->queue_head);
483 spin_unlock(&lo->queue_lock);
484 }
485
486 lo->active_req = NULL;
487 mutex_unlock(&lo->tx_lock);
488 wake_up_all(&lo->active_wq);
489
490 return;
491
492error_out:
493 req->errors++;
494 nbd_end_request(req);
495}
496
497static int nbd_thread(void *data)
498{
499 struct nbd_device *lo = data;
500 struct request *req;
501
502 set_user_nice(current, -20);
503 while (!kthread_should_stop() || !list_empty(&lo->waiting_queue)) {
504 /* wait for something to do */
505 wait_event_interruptible(lo->waiting_wq,
506 kthread_should_stop() ||
507 !list_empty(&lo->waiting_queue));
508
509 /* extract request */
510 if (list_empty(&lo->waiting_queue))
511 continue;
512
513 spin_lock_irq(&lo->queue_lock);
514 req = list_entry(lo->waiting_queue.next, struct request,
515 queuelist);
516 list_del_init(&req->queuelist);
517 spin_unlock_irq(&lo->queue_lock);
518
519 /* handle request */
520 nbd_handle_req(lo, req);
521 }
522 return 0;
523}
524
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525/*
526 * We always wait for result of write, for now. It would be nice to make it optional
527 * in future
Boaz Harroshe654bc42007-06-20 13:53:23 +0200528 * if ((rq_data_dir(req) == WRITE) && (lo->flags & NBD_WRITE_NOCHK))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 * { printk( "Warning: Ignoring result!\n"); nbd_end_request( req ); }
530 */
531
Pavel Machek15746fc2009-04-02 16:58:42 -0700532static void do_nbd_request(struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533{
534 struct request *req;
535
536 while ((req = elv_next_request(q)) != NULL) {
537 struct nbd_device *lo;
538
539 blkdev_dequeue_request(req);
Laurent Vivier48cf6062008-04-29 01:02:46 -0700540
541 spin_unlock_irq(q->queue_lock);
542
Jens Axboe4aff5e22006-08-10 08:44:47 +0200543 dprintk(DBG_BLKDEV, "%s: request %p: dequeued (flags=%x)\n",
544 req->rq_disk->disk_name, req, req->cmd_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546 lo = req->rq_disk->private_data;
547
548 BUG_ON(lo->magic != LO_MAGIC);
549
Paul Clements4d48a542009-02-11 13:04:45 -0800550 if (unlikely(!lo->sock)) {
551 printk(KERN_ERR "%s: Attempted send on closed socket\n",
552 lo->disk->disk_name);
553 req->errors++;
554 nbd_end_request(req);
555 spin_lock_irq(q->queue_lock);
556 continue;
557 }
558
Laurent Vivier48cf6062008-04-29 01:02:46 -0700559 spin_lock_irq(&lo->queue_lock);
560 list_add_tail(&req->queuelist, &lo->waiting_queue);
561 spin_unlock_irq(&lo->queue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562
Laurent Vivier48cf6062008-04-29 01:02:46 -0700563 wake_up(&lo->waiting_wq);
Herbert Xu4b2f0262006-01-06 00:09:47 -0800564
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565 spin_lock_irq(q->queue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567}
568
Pavel Machek1a2ad212009-04-02 16:58:41 -0700569/* Must be called with tx_lock held */
570
571static int __nbd_ioctl(struct block_device *bdev, struct nbd_device *lo,
572 unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 switch (cmd) {
Pavel Machek1a2ad212009-04-02 16:58:41 -0700575 case NBD_DISCONNECT: {
576 struct request sreq;
577
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578 printk(KERN_INFO "%s: NBD_DISCONNECT\n", lo->disk->disk_name);
Pavel Machek1a2ad212009-04-02 16:58:41 -0700579
FUJITA Tomonori4f54eec2008-04-29 09:54:37 +0200580 blk_rq_init(NULL, &sreq);
Jens Axboe4aff5e22006-08-10 08:44:47 +0200581 sreq.cmd_type = REQ_TYPE_SPECIAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 nbd_cmd(&sreq) = NBD_CMD_DISC;
583 /*
584 * Set these to sane values in case server implementation
585 * fails to check the request type first and also to keep
586 * debugging output cleaner.
587 */
588 sreq.sector = 0;
589 sreq.nr_sectors = 0;
Pavel Machek1a2ad212009-04-02 16:58:41 -0700590 if (!lo->sock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591 return -EINVAL;
Pavel Machek1a2ad212009-04-02 16:58:41 -0700592 nbd_send_req(lo, &sreq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 return 0;
Pavel Machek1a2ad212009-04-02 16:58:41 -0700594 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595
Pavel Machek1a2ad212009-04-02 16:58:41 -0700596 case NBD_CLEAR_SOCK: {
597 struct file *file;
598
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 lo->sock = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600 file = lo->file;
601 lo->file = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602 nbd_clear_que(lo);
Herbert Xu4b2f0262006-01-06 00:09:47 -0800603 BUG_ON(!list_empty(&lo->queue_head));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604 if (file)
605 fput(file);
Pavel Machek1a2ad212009-04-02 16:58:41 -0700606 return 0;
607 }
608
609 case NBD_SET_SOCK: {
610 struct file *file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 if (lo->file)
612 return -EBUSY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 file = fget(arg);
614 if (file) {
Al Viroa8cdc302008-03-02 09:33:33 -0500615 struct inode *inode = file->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 if (S_ISSOCK(inode->i_mode)) {
617 lo->file = file;
618 lo->sock = SOCKET_I(inode);
Laurent Vivierd71a6d72008-04-29 01:02:51 -0700619 if (max_part > 0)
620 bdev->bd_invalidated = 1;
Pavel Machek1a2ad212009-04-02 16:58:41 -0700621 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 } else {
623 fput(file);
624 }
625 }
Pavel Machek1a2ad212009-04-02 16:58:41 -0700626 return -EINVAL;
627 }
628
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 case NBD_SET_BLKSIZE:
630 lo->blksize = arg;
631 lo->bytesize &= ~(lo->blksize-1);
Al Viroa8cdc302008-03-02 09:33:33 -0500632 bdev->bd_inode->i_size = lo->bytesize;
633 set_blocksize(bdev, lo->blksize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634 set_capacity(lo->disk, lo->bytesize >> 9);
635 return 0;
Pavel Machek1a2ad212009-04-02 16:58:41 -0700636
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637 case NBD_SET_SIZE:
638 lo->bytesize = arg & ~(lo->blksize-1);
Al Viroa8cdc302008-03-02 09:33:33 -0500639 bdev->bd_inode->i_size = lo->bytesize;
640 set_blocksize(bdev, lo->blksize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 set_capacity(lo->disk, lo->bytesize >> 9);
642 return 0;
Pavel Machek1a2ad212009-04-02 16:58:41 -0700643
Paul Clements7fdfd402007-10-16 23:27:37 -0700644 case NBD_SET_TIMEOUT:
645 lo->xmit_timeout = arg * HZ;
646 return 0;
Pavel Machek1a2ad212009-04-02 16:58:41 -0700647
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 case NBD_SET_SIZE_BLOCKS:
649 lo->bytesize = ((u64) arg) * lo->blksize;
Al Viroa8cdc302008-03-02 09:33:33 -0500650 bdev->bd_inode->i_size = lo->bytesize;
651 set_blocksize(bdev, lo->blksize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652 set_capacity(lo->disk, lo->bytesize >> 9);
653 return 0;
Pavel Machek1a2ad212009-04-02 16:58:41 -0700654
655 case NBD_DO_IT: {
656 struct task_struct *thread;
657 struct file *file;
658 int error;
659
Pavel Machekc91192d2009-01-15 13:51:03 -0800660 if (lo->pid)
661 return -EBUSY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662 if (!lo->file)
663 return -EINVAL;
Pavel Machek1a2ad212009-04-02 16:58:41 -0700664
665 mutex_unlock(&lo->tx_lock);
666
Laurent Vivier48cf6062008-04-29 01:02:46 -0700667 thread = kthread_create(nbd_thread, lo, lo->disk->disk_name);
Pavel Machek1a2ad212009-04-02 16:58:41 -0700668 if (IS_ERR(thread)) {
669 mutex_lock(&lo->tx_lock);
Laurent Vivier48cf6062008-04-29 01:02:46 -0700670 return PTR_ERR(thread);
Pavel Machek1a2ad212009-04-02 16:58:41 -0700671 }
Laurent Vivier48cf6062008-04-29 01:02:46 -0700672 wake_up_process(thread);
WANG Cong84963042007-05-09 02:33:36 -0700673 error = nbd_do_it(lo);
Laurent Vivier48cf6062008-04-29 01:02:46 -0700674 kthread_stop(thread);
Pavel Machek1a2ad212009-04-02 16:58:41 -0700675
676 mutex_lock(&lo->tx_lock);
WANG Cong84963042007-05-09 02:33:36 -0700677 if (error)
678 return error;
Pavel Machek1a2ad212009-04-02 16:58:41 -0700679 sock_shutdown(lo, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680 file = lo->file;
681 lo->file = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 nbd_clear_que(lo);
683 printk(KERN_WARNING "%s: queue cleared\n", lo->disk->disk_name);
684 if (file)
685 fput(file);
Paul Clements4b86a872007-10-16 23:27:36 -0700686 lo->bytesize = 0;
Al Viroa8cdc302008-03-02 09:33:33 -0500687 bdev->bd_inode->i_size = 0;
Paul Clements4b86a872007-10-16 23:27:36 -0700688 set_capacity(lo->disk, 0);
Laurent Vivierd71a6d72008-04-29 01:02:51 -0700689 if (max_part > 0)
Al Viroa8cdc302008-03-02 09:33:33 -0500690 ioctl_by_bdev(bdev, BLKRRPART, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691 return lo->harderror;
Pavel Machek1a2ad212009-04-02 16:58:41 -0700692 }
693
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694 case NBD_CLEAR_QUE:
Herbert Xu4b2f0262006-01-06 00:09:47 -0800695 /*
696 * This is for compatibility only. The queue is always cleared
697 * by NBD_DO_IT or NBD_CLEAR_SOCK.
698 */
699 BUG_ON(!lo->sock && !list_empty(&lo->queue_head));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 return 0;
Pavel Machek1a2ad212009-04-02 16:58:41 -0700701
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702 case NBD_PRINT_DEBUG:
703 printk(KERN_INFO "%s: next = %p, prev = %p, head = %p\n",
Al Viroa8cdc302008-03-02 09:33:33 -0500704 bdev->bd_disk->disk_name,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705 lo->queue_head.next, lo->queue_head.prev,
706 &lo->queue_head);
707 return 0;
708 }
Pavel Machek1a2ad212009-04-02 16:58:41 -0700709 return -ENOTTY;
710}
711
712static int nbd_ioctl(struct block_device *bdev, fmode_t mode,
713 unsigned int cmd, unsigned long arg)
714{
715 struct nbd_device *lo = bdev->bd_disk->private_data;
716 int error;
717
718 if (!capable(CAP_SYS_ADMIN))
719 return -EPERM;
720
721 BUG_ON(lo->magic != LO_MAGIC);
722
723 /* Anyone capable of this syscall can do *real bad* things */
724 dprintk(DBG_IOCTL, "%s: nbd_ioctl cmd=%s(0x%x) arg=%lu\n",
725 lo->disk->disk_name, ioctl_cmd_to_ascii(cmd), cmd, arg);
726
727 mutex_lock(&lo->tx_lock);
728 error = __nbd_ioctl(bdev, lo, cmd, arg);
729 mutex_unlock(&lo->tx_lock);
730
731 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732}
733
734static struct block_device_operations nbd_fops =
735{
736 .owner = THIS_MODULE,
Al Viroa8cdc302008-03-02 09:33:33 -0500737 .locked_ioctl = nbd_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738};
739
740/*
741 * And here should be modules and kernel interface
742 * (Just smiley confuses emacs :-)
743 */
744
745static int __init nbd_init(void)
746{
747 int err = -ENOMEM;
748 int i;
Laurent Vivierd71a6d72008-04-29 01:02:51 -0700749 int part_shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750
Adrian Bunk5b7b18c2006-03-25 03:07:04 -0800751 BUILD_BUG_ON(sizeof(struct nbd_request) != 28);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752
Laurent Vivierd71a6d72008-04-29 01:02:51 -0700753 if (max_part < 0) {
754 printk(KERN_CRIT "nbd: max_part must be >= 0\n");
755 return -EINVAL;
756 }
757
Sven Wegenerf3944d62008-08-20 14:09:07 -0700758 nbd_dev = kcalloc(nbds_max, sizeof(*nbd_dev), GFP_KERNEL);
759 if (!nbd_dev)
760 return -ENOMEM;
761
Laurent Vivierd71a6d72008-04-29 01:02:51 -0700762 part_shift = 0;
763 if (max_part > 0)
764 part_shift = fls(max_part);
765
Lars Marowsky-Bree40be0c22005-05-01 08:59:07 -0700766 for (i = 0; i < nbds_max; i++) {
Laurent Vivierd71a6d72008-04-29 01:02:51 -0700767 struct gendisk *disk = alloc_disk(1 << part_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768 if (!disk)
769 goto out;
770 nbd_dev[i].disk = disk;
771 /*
772 * The new linux 2.5 block layer implementation requires
773 * every gendisk to have its very own request_queue struct.
774 * These structs are big so we dynamically allocate them.
775 */
776 disk->queue = blk_init_queue(do_nbd_request, &nbd_lock);
777 if (!disk->queue) {
778 put_disk(disk);
779 goto out;
780 }
Jens Axboe31dcfab2008-10-31 10:06:37 +0100781 /*
782 * Tell the block layer that we are not a rotational device
783 */
784 queue_flag_set_unlocked(QUEUE_FLAG_NONROT, disk->queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785 }
786
787 if (register_blkdev(NBD_MAJOR, "nbd")) {
788 err = -EIO;
789 goto out;
790 }
791
792 printk(KERN_INFO "nbd: registered device at major %d\n", NBD_MAJOR);
793 dprintk(DBG_INIT, "nbd: debugflags=0x%x\n", debugflags);
794
Lars Marowsky-Bree40be0c22005-05-01 08:59:07 -0700795 for (i = 0; i < nbds_max; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796 struct gendisk *disk = nbd_dev[i].disk;
797 nbd_dev[i].file = NULL;
798 nbd_dev[i].magic = LO_MAGIC;
799 nbd_dev[i].flags = 0;
Laurent Vivier48cf6062008-04-29 01:02:46 -0700800 INIT_LIST_HEAD(&nbd_dev[i].waiting_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801 spin_lock_init(&nbd_dev[i].queue_lock);
802 INIT_LIST_HEAD(&nbd_dev[i].queue_head);
Ingo Molnar82d4dc52006-03-23 03:00:38 -0800803 mutex_init(&nbd_dev[i].tx_lock);
Herbert Xu4b2f0262006-01-06 00:09:47 -0800804 init_waitqueue_head(&nbd_dev[i].active_wq);
Laurent Vivier48cf6062008-04-29 01:02:46 -0700805 init_waitqueue_head(&nbd_dev[i].waiting_wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806 nbd_dev[i].blksize = 1024;
Paul Clements4b86a872007-10-16 23:27:36 -0700807 nbd_dev[i].bytesize = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808 disk->major = NBD_MAJOR;
Laurent Vivierd71a6d72008-04-29 01:02:51 -0700809 disk->first_minor = i << part_shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810 disk->fops = &nbd_fops;
811 disk->private_data = &nbd_dev[i];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 sprintf(disk->disk_name, "nbd%d", i);
Paul Clements4b86a872007-10-16 23:27:36 -0700813 set_capacity(disk, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814 add_disk(disk);
815 }
816
817 return 0;
818out:
819 while (i--) {
820 blk_cleanup_queue(nbd_dev[i].disk->queue);
821 put_disk(nbd_dev[i].disk);
822 }
Sven Wegenerf3944d62008-08-20 14:09:07 -0700823 kfree(nbd_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824 return err;
825}
826
827static void __exit nbd_cleanup(void)
828{
829 int i;
Lars Marowsky-Bree40be0c22005-05-01 08:59:07 -0700830 for (i = 0; i < nbds_max; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 struct gendisk *disk = nbd_dev[i].disk;
Lars Marowsky-Bree40be0c22005-05-01 08:59:07 -0700832 nbd_dev[i].magic = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 if (disk) {
834 del_gendisk(disk);
835 blk_cleanup_queue(disk->queue);
836 put_disk(disk);
837 }
838 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839 unregister_blkdev(NBD_MAJOR, "nbd");
Sven Wegenerf3944d62008-08-20 14:09:07 -0700840 kfree(nbd_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 printk(KERN_INFO "nbd: unregistered device at major %d\n", NBD_MAJOR);
842}
843
844module_init(nbd_init);
845module_exit(nbd_cleanup);
846
847MODULE_DESCRIPTION("Network Block Device");
848MODULE_LICENSE("GPL");
849
Lars Marowsky-Bree40be0c22005-05-01 08:59:07 -0700850module_param(nbds_max, int, 0444);
Laurent Vivierd71a6d72008-04-29 01:02:51 -0700851MODULE_PARM_DESC(nbds_max, "number of network block devices to initialize (default: 16)");
852module_param(max_part, int, 0444);
853MODULE_PARM_DESC(max_part, "number of partitions per device (default: 0)");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854#ifndef NDEBUG
855module_param(debugflags, int, 0644);
856MODULE_PARM_DESC(debugflags, "flags for controlling debug output");
857#endif