blob: e6fc716aca4521cc7537e09a393b6213b0a3ea88 [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 Macheka2531292010-07-18 14:27:13 +02007 * Copyright 1997-2000, 2008 Pavel Machek <pavel@ucw.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>
Arnd Bergmann2a48fc02010-06-02 14:28:52 +020027#include <linux/mutex.h>
Herbert Xu4b2f0262006-01-06 00:09:47 -080028#include <linux/compiler.h>
29#include <linux/err.h>
30#include <linux/kernel.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090031#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#include <net/sock.h>
Trond Myklebust91cf45f2007-11-12 18:10:39 -080033#include <linux/net.h>
Laurent Vivier48cf6062008-04-29 01:02:46 -070034#include <linux/kthread.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#include <asm/uaccess.h>
Herbert Xu4b2f0262006-01-06 00:09:47 -080037#include <asm/system.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070038#include <asm/types.h>
39
40#include <linux/nbd.h>
41
42#define LO_MAGIC 0x68797548
43
44#ifdef NDEBUG
45#define dprintk(flags, fmt...)
46#else /* NDEBUG */
47#define dprintk(flags, fmt...) do { \
48 if (debugflags & (flags)) printk(KERN_DEBUG fmt); \
49} while (0)
50#define DBG_IOCTL 0x0004
51#define DBG_INIT 0x0010
52#define DBG_EXIT 0x0020
53#define DBG_BLKDEV 0x0100
54#define DBG_RX 0x0200
55#define DBG_TX 0x0400
56static unsigned int debugflags;
57#endif /* NDEBUG */
58
Ingo van Lil9c7a4162006-07-01 04:36:36 -070059static unsigned int nbds_max = 16;
Paul Clements20a81432008-02-08 04:21:51 -080060static struct nbd_device *nbd_dev;
Laurent Vivierd71a6d72008-04-29 01:02:51 -070061static int max_part;
Linus Torvalds1da177e2005-04-16 15:20:36 -070062
63/*
64 * Use just one lock (or at most 1 per NIC). Two arguments for this:
65 * 1. Each NIC is essentially a synchronization point for all servers
66 * accessed through that NIC so there's no need to have more locks
67 * than NICs anyway.
68 * 2. More locks lead to more "Dirty cache line bouncing" which will slow
69 * down each lock to the point where they're actually slower than just
70 * a single lock.
71 * Thanks go to Jens Axboe and Al Viro for their LKML emails explaining this!
72 */
73static DEFINE_SPINLOCK(nbd_lock);
74
75#ifndef NDEBUG
76static const char *ioctl_cmd_to_ascii(int cmd)
77{
78 switch (cmd) {
79 case NBD_SET_SOCK: return "set-sock";
80 case NBD_SET_BLKSIZE: return "set-blksize";
81 case NBD_SET_SIZE: return "set-size";
82 case NBD_DO_IT: return "do-it";
83 case NBD_CLEAR_SOCK: return "clear-sock";
84 case NBD_CLEAR_QUE: return "clear-que";
85 case NBD_PRINT_DEBUG: return "print-debug";
86 case NBD_SET_SIZE_BLOCKS: return "set-size-blocks";
87 case NBD_DISCONNECT: return "disconnect";
88 case BLKROSET: return "set-read-only";
89 case BLKFLSBUF: return "flush-buffer-cache";
90 }
91 return "unknown";
92}
93
94static const char *nbdcmd_to_ascii(int cmd)
95{
96 switch (cmd) {
97 case NBD_CMD_READ: return "read";
98 case NBD_CMD_WRITE: return "write";
99 case NBD_CMD_DISC: return "disconnect";
100 }
101 return "invalid";
102}
103#endif /* NDEBUG */
104
105static void nbd_end_request(struct request *req)
106{
Kiyoshi Ueda097c94a2007-12-11 17:44:06 -0500107 int error = req->errors ? -EIO : 0;
Jens Axboe165125e2007-07-24 09:28:11 +0200108 struct request_queue *q = req->q;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109 unsigned long flags;
110
111 dprintk(DBG_BLKDEV, "%s: request %p: %s\n", req->rq_disk->disk_name,
Kiyoshi Ueda097c94a2007-12-11 17:44:06 -0500112 req, error ? "failed" : "done");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113
114 spin_lock_irqsave(q->queue_lock, flags);
Tejun Heo1011c1b2009-05-07 22:24:45 +0900115 __blk_end_request_all(req, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 spin_unlock_irqrestore(q->queue_lock, flags);
117}
118
Paul Clements7fdfd402007-10-16 23:27:37 -0700119static void sock_shutdown(struct nbd_device *lo, int lock)
120{
121 /* Forcibly shutdown the socket causing all listeners
122 * to error
123 *
124 * FIXME: This code is duplicated from sys_shutdown, but
125 * there should be a more generic interface rather than
126 * calling socket ops directly here */
127 if (lock)
128 mutex_lock(&lo->tx_lock);
129 if (lo->sock) {
130 printk(KERN_WARNING "%s: shutting down socket\n",
131 lo->disk->disk_name);
Trond Myklebust91cf45f2007-11-12 18:10:39 -0800132 kernel_sock_shutdown(lo->sock, SHUT_RDWR);
Paul Clements7fdfd402007-10-16 23:27:37 -0700133 lo->sock = NULL;
134 }
135 if (lock)
136 mutex_unlock(&lo->tx_lock);
137}
138
139static void nbd_xmit_timeout(unsigned long arg)
140{
141 struct task_struct *task = (struct task_struct *)arg;
142
143 printk(KERN_WARNING "nbd: killing hung xmit (%s, pid: %d)\n",
144 task->comm, task->pid);
145 force_sig(SIGKILL, task);
146}
147
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148/*
149 * Send or receive packet.
150 */
Paul Clements7fdfd402007-10-16 23:27:37 -0700151static int sock_xmit(struct nbd_device *lo, int send, void *buf, int size,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152 int msg_flags)
153{
Paul Clements7fdfd402007-10-16 23:27:37 -0700154 struct socket *sock = lo->sock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 int result;
156 struct msghdr msg;
157 struct kvec iov;
Oleg Nesterovbe0ef952007-07-15 23:41:32 -0700158 sigset_t blocked, oldset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159
Mike Snitzerffc41cf2008-04-02 13:04:47 -0700160 if (unlikely(!sock)) {
161 printk(KERN_ERR "%s: Attempted %s on closed socket in sock_xmit\n",
162 lo->disk->disk_name, (send ? "send" : "recv"));
163 return -EINVAL;
164 }
165
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 /* Allow interception of SIGKILL only
167 * Don't allow other signals to interrupt the transmission */
Oleg Nesterovbe0ef952007-07-15 23:41:32 -0700168 siginitsetinv(&blocked, sigmask(SIGKILL));
169 sigprocmask(SIG_SETMASK, &blocked, &oldset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170
171 do {
172 sock->sk->sk_allocation = GFP_NOIO;
173 iov.iov_base = buf;
174 iov.iov_len = size;
175 msg.msg_name = NULL;
176 msg.msg_namelen = 0;
177 msg.msg_control = NULL;
178 msg.msg_controllen = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179 msg.msg_flags = msg_flags | MSG_NOSIGNAL;
180
Paul Clements7fdfd402007-10-16 23:27:37 -0700181 if (send) {
182 struct timer_list ti;
183
184 if (lo->xmit_timeout) {
185 init_timer(&ti);
186 ti.function = nbd_xmit_timeout;
187 ti.data = (unsigned long)current;
188 ti.expires = jiffies + lo->xmit_timeout;
189 add_timer(&ti);
190 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 result = kernel_sendmsg(sock, &msg, &iov, 1, size);
Paul Clements7fdfd402007-10-16 23:27:37 -0700192 if (lo->xmit_timeout)
193 del_timer_sync(&ti);
194 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 result = kernel_recvmsg(sock, &msg, &iov, 1, size, 0);
196
197 if (signal_pending(current)) {
198 siginfo_t info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199 printk(KERN_WARNING "nbd (pid %d: %s) got signal %d\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -0700200 task_pid_nr(current), current->comm,
Oleg Nesterovbe0ef952007-07-15 23:41:32 -0700201 dequeue_signal_lock(current, &current->blocked, &info));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202 result = -EINTR;
Paul Clements7fdfd402007-10-16 23:27:37 -0700203 sock_shutdown(lo, !send);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204 break;
205 }
206
207 if (result <= 0) {
208 if (result == 0)
209 result = -EPIPE; /* short read */
210 break;
211 }
212 size -= result;
213 buf += result;
214 } while (size > 0);
215
Oleg Nesterovbe0ef952007-07-15 23:41:32 -0700216 sigprocmask(SIG_SETMASK, &oldset, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217
218 return result;
219}
220
Paul Clements7fdfd402007-10-16 23:27:37 -0700221static inline int sock_send_bvec(struct nbd_device *lo, struct bio_vec *bvec,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 int flags)
223{
224 int result;
225 void *kaddr = kmap(bvec->bv_page);
Paul Clements7fdfd402007-10-16 23:27:37 -0700226 result = sock_xmit(lo, 1, kaddr + bvec->bv_offset, bvec->bv_len, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227 kunmap(bvec->bv_page);
228 return result;
229}
230
Paul Clements7fdfd402007-10-16 23:27:37 -0700231/* always call with the tx_lock held */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232static int nbd_send_req(struct nbd_device *lo, struct request *req)
233{
NeilBrown5705f702007-09-25 12:35:59 +0200234 int result, flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 struct nbd_request request;
Tejun Heo1011c1b2009-05-07 22:24:45 +0900236 unsigned long size = blk_rq_bytes(req);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237
238 request.magic = htonl(NBD_REQUEST_MAGIC);
239 request.type = htonl(nbd_cmd(req));
Tejun Heo83096eb2009-05-07 22:24:39 +0900240 request.from = cpu_to_be64((u64)blk_rq_pos(req) << 9);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 request.len = htonl(size);
242 memcpy(request.handle, &req, sizeof(req));
243
Tejun Heo83096eb2009-05-07 22:24:39 +0900244 dprintk(DBG_TX, "%s: request %p: sending control (%s@%llu,%uB)\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 lo->disk->disk_name, req,
246 nbdcmd_to_ascii(nbd_cmd(req)),
Tejun Heo83096eb2009-05-07 22:24:39 +0900247 (unsigned long long)blk_rq_pos(req) << 9,
Tejun Heo1011c1b2009-05-07 22:24:45 +0900248 blk_rq_bytes(req));
Paul Clements7fdfd402007-10-16 23:27:37 -0700249 result = sock_xmit(lo, 1, &request, sizeof(request),
250 (nbd_cmd(req) == NBD_CMD_WRITE) ? MSG_MORE : 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251 if (result <= 0) {
252 printk(KERN_ERR "%s: Send control failed (result %d)\n",
253 lo->disk->disk_name, result);
254 goto error_out;
255 }
256
257 if (nbd_cmd(req) == NBD_CMD_WRITE) {
NeilBrown5705f702007-09-25 12:35:59 +0200258 struct req_iterator iter;
259 struct bio_vec *bvec;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 /*
261 * we are really probing at internals to determine
262 * whether to set MSG_MORE or not...
263 */
NeilBrown5705f702007-09-25 12:35:59 +0200264 rq_for_each_segment(bvec, req, iter) {
Jens Axboe6c92e692007-08-16 13:43:12 +0200265 flags = 0;
266 if (!rq_iter_last(req, iter))
267 flags = MSG_MORE;
268 dprintk(DBG_TX, "%s: request %p: sending %d bytes data\n",
269 lo->disk->disk_name, req, bvec->bv_len);
Paul Clements7fdfd402007-10-16 23:27:37 -0700270 result = sock_send_bvec(lo, bvec, flags);
Jens Axboe6c92e692007-08-16 13:43:12 +0200271 if (result <= 0) {
272 printk(KERN_ERR "%s: Send data failed (result %d)\n",
273 lo->disk->disk_name, result);
274 goto error_out;
275 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276 }
277 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278 return 0;
279
280error_out:
Pavel Machek15746fc2009-04-02 16:58:42 -0700281 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282}
283
Denis Cheng0cbc591b2007-10-16 23:26:14 -0700284static struct request *nbd_find_request(struct nbd_device *lo,
285 struct request *xreq)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286{
Denis Chengd2c97402007-10-16 23:26:14 -0700287 struct request *req, *tmp;
Herbert Xu4b2f0262006-01-06 00:09:47 -0800288 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289
Herbert Xu4b2f0262006-01-06 00:09:47 -0800290 err = wait_event_interruptible(lo->active_wq, lo->active_req != xreq);
291 if (unlikely(err))
292 goto out;
293
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 spin_lock(&lo->queue_lock);
Denis Chengd2c97402007-10-16 23:26:14 -0700295 list_for_each_entry_safe(req, tmp, &lo->queue_head, queuelist) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 if (req != xreq)
297 continue;
298 list_del_init(&req->queuelist);
299 spin_unlock(&lo->queue_lock);
300 return req;
301 }
302 spin_unlock(&lo->queue_lock);
Herbert Xu4b2f0262006-01-06 00:09:47 -0800303
304 err = -ENOENT;
305
306out:
307 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308}
309
Paul Clements7fdfd402007-10-16 23:27:37 -0700310static inline int sock_recv_bvec(struct nbd_device *lo, struct bio_vec *bvec)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311{
312 int result;
313 void *kaddr = kmap(bvec->bv_page);
Paul Clements7fdfd402007-10-16 23:27:37 -0700314 result = sock_xmit(lo, 0, kaddr + bvec->bv_offset, bvec->bv_len,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 MSG_WAITALL);
316 kunmap(bvec->bv_page);
317 return result;
318}
319
320/* NULL returned = something went wrong, inform userspace */
321static struct request *nbd_read_stat(struct nbd_device *lo)
322{
323 int result;
324 struct nbd_reply reply;
325 struct request *req;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326
327 reply.magic = 0;
Paul Clements7fdfd402007-10-16 23:27:37 -0700328 result = sock_xmit(lo, 0, &reply, sizeof(reply), MSG_WAITALL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329 if (result <= 0) {
330 printk(KERN_ERR "%s: Receive control failed (result %d)\n",
331 lo->disk->disk_name, result);
332 goto harderror;
333 }
Michal Feixe4b57e02006-07-30 03:03:31 -0700334
335 if (ntohl(reply.magic) != NBD_REPLY_MAGIC) {
336 printk(KERN_ERR "%s: Wrong magic (0x%lx)\n",
337 lo->disk->disk_name,
338 (unsigned long)ntohl(reply.magic));
339 result = -EPROTO;
340 goto harderror;
341 }
342
Denis Cheng0cbc591b2007-10-16 23:26:14 -0700343 req = nbd_find_request(lo, *(struct request **)reply.handle);
Hirofumi Nakagawa801678c2008-04-29 01:03:09 -0700344 if (IS_ERR(req)) {
Herbert Xu4b2f0262006-01-06 00:09:47 -0800345 result = PTR_ERR(req);
346 if (result != -ENOENT)
347 goto harderror;
348
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349 printk(KERN_ERR "%s: Unexpected reply (%p)\n",
350 lo->disk->disk_name, reply.handle);
351 result = -EBADR;
352 goto harderror;
353 }
354
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355 if (ntohl(reply.error)) {
356 printk(KERN_ERR "%s: Other side returned error (%d)\n",
357 lo->disk->disk_name, ntohl(reply.error));
358 req->errors++;
359 return req;
360 }
361
362 dprintk(DBG_RX, "%s: request %p: got reply\n",
363 lo->disk->disk_name, req);
364 if (nbd_cmd(req) == NBD_CMD_READ) {
NeilBrown5705f702007-09-25 12:35:59 +0200365 struct req_iterator iter;
366 struct bio_vec *bvec;
367
368 rq_for_each_segment(bvec, req, iter) {
Paul Clements7fdfd402007-10-16 23:27:37 -0700369 result = sock_recv_bvec(lo, bvec);
Jens Axboe6c92e692007-08-16 13:43:12 +0200370 if (result <= 0) {
371 printk(KERN_ERR "%s: Receive data failed (result %d)\n",
372 lo->disk->disk_name, result);
373 req->errors++;
374 return req;
375 }
376 dprintk(DBG_RX, "%s: request %p: got %d bytes data\n",
377 lo->disk->disk_name, req, bvec->bv_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 }
379 }
380 return req;
381harderror:
382 lo->harderror = result;
383 return NULL;
384}
385
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200386static ssize_t pid_show(struct device *dev,
387 struct device_attribute *attr, char *buf)
Paul Clements6b39bb62006-12-06 20:40:53 -0800388{
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200389 struct gendisk *disk = dev_to_disk(dev);
390
391 return sprintf(buf, "%ld\n",
Paul Clements6b39bb62006-12-06 20:40:53 -0800392 (long) ((struct nbd_device *)disk->private_data)->pid);
393}
394
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200395static struct device_attribute pid_attr = {
Parag Warudkar01e8ef12008-10-18 20:28:50 -0700396 .attr = { .name = "pid", .mode = S_IRUGO},
Paul Clements6b39bb62006-12-06 20:40:53 -0800397 .show = pid_show,
398};
399
WANG Cong84963042007-05-09 02:33:36 -0700400static int nbd_do_it(struct nbd_device *lo)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401{
402 struct request *req;
WANG Cong84963042007-05-09 02:33:36 -0700403 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404
405 BUG_ON(lo->magic != LO_MAGIC);
406
Paul Clements6b39bb62006-12-06 20:40:53 -0800407 lo->pid = current->pid;
Tejun Heoed9e1982008-08-25 19:56:05 +0900408 ret = sysfs_create_file(&disk_to_dev(lo->disk)->kobj, &pid_attr.attr);
WANG Cong84963042007-05-09 02:33:36 -0700409 if (ret) {
410 printk(KERN_ERR "nbd: sysfs_create_file failed!");
Pavel Machekc91192d2009-01-15 13:51:03 -0800411 lo->pid = 0;
WANG Cong84963042007-05-09 02:33:36 -0700412 return ret;
413 }
Paul Clements6b39bb62006-12-06 20:40:53 -0800414
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 while ((req = nbd_read_stat(lo)) != NULL)
416 nbd_end_request(req);
Paul Clements6b39bb62006-12-06 20:40:53 -0800417
Tejun Heoed9e1982008-08-25 19:56:05 +0900418 sysfs_remove_file(&disk_to_dev(lo->disk)->kobj, &pid_attr.attr);
Pavel Machekc91192d2009-01-15 13:51:03 -0800419 lo->pid = 0;
WANG Cong84963042007-05-09 02:33:36 -0700420 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421}
422
423static void nbd_clear_que(struct nbd_device *lo)
424{
425 struct request *req;
426
427 BUG_ON(lo->magic != LO_MAGIC);
428
Herbert Xu4b2f0262006-01-06 00:09:47 -0800429 /*
430 * Because we have set lo->sock to NULL under the tx_lock, all
431 * modifications to the list must have completed by now. For
432 * the same reason, the active_req must be NULL.
433 *
434 * As a consequence, we don't need to take the spin lock while
435 * purging the list here.
436 */
437 BUG_ON(lo->sock);
438 BUG_ON(lo->active_req);
439
440 while (!list_empty(&lo->queue_head)) {
441 req = list_entry(lo->queue_head.next, struct request,
442 queuelist);
443 list_del_init(&req->queuelist);
444 req->errors++;
445 nbd_end_request(req);
446 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447}
448
Paul Clements7fdfd402007-10-16 23:27:37 -0700449
Laurent Vivier48cf6062008-04-29 01:02:46 -0700450static void nbd_handle_req(struct nbd_device *lo, struct request *req)
451{
Christoph Hellwig33659eb2010-08-07 18:17:56 +0200452 if (req->cmd_type != REQ_TYPE_FS)
Laurent Vivier48cf6062008-04-29 01:02:46 -0700453 goto error_out;
454
455 nbd_cmd(req) = NBD_CMD_READ;
456 if (rq_data_dir(req) == WRITE) {
457 nbd_cmd(req) = NBD_CMD_WRITE;
458 if (lo->flags & NBD_READ_ONLY) {
459 printk(KERN_ERR "%s: Write on read-only\n",
460 lo->disk->disk_name);
461 goto error_out;
462 }
463 }
464
465 req->errors = 0;
466
467 mutex_lock(&lo->tx_lock);
468 if (unlikely(!lo->sock)) {
469 mutex_unlock(&lo->tx_lock);
470 printk(KERN_ERR "%s: Attempted send on closed socket\n",
471 lo->disk->disk_name);
Pavel Machek15746fc2009-04-02 16:58:42 -0700472 goto error_out;
Laurent Vivier48cf6062008-04-29 01:02:46 -0700473 }
474
475 lo->active_req = req;
476
477 if (nbd_send_req(lo, req) != 0) {
478 printk(KERN_ERR "%s: Request send failed\n",
479 lo->disk->disk_name);
480 req->errors++;
481 nbd_end_request(req);
482 } else {
483 spin_lock(&lo->queue_lock);
484 list_add(&req->queuelist, &lo->queue_head);
485 spin_unlock(&lo->queue_lock);
486 }
487
488 lo->active_req = NULL;
489 mutex_unlock(&lo->tx_lock);
490 wake_up_all(&lo->active_wq);
491
492 return;
493
494error_out:
495 req->errors++;
496 nbd_end_request(req);
497}
498
499static int nbd_thread(void *data)
500{
501 struct nbd_device *lo = data;
502 struct request *req;
503
504 set_user_nice(current, -20);
505 while (!kthread_should_stop() || !list_empty(&lo->waiting_queue)) {
506 /* wait for something to do */
507 wait_event_interruptible(lo->waiting_wq,
508 kthread_should_stop() ||
509 !list_empty(&lo->waiting_queue));
510
511 /* extract request */
512 if (list_empty(&lo->waiting_queue))
513 continue;
514
515 spin_lock_irq(&lo->queue_lock);
516 req = list_entry(lo->waiting_queue.next, struct request,
517 queuelist);
518 list_del_init(&req->queuelist);
519 spin_unlock_irq(&lo->queue_lock);
520
521 /* handle request */
522 nbd_handle_req(lo, req);
523 }
524 return 0;
525}
526
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527/*
528 * We always wait for result of write, for now. It would be nice to make it optional
529 * in future
Boaz Harroshe654bc42007-06-20 13:53:23 +0200530 * if ((rq_data_dir(req) == WRITE) && (lo->flags & NBD_WRITE_NOCHK))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531 * { printk( "Warning: Ignoring result!\n"); nbd_end_request( req ); }
532 */
533
Pavel Machek15746fc2009-04-02 16:58:42 -0700534static void do_nbd_request(struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535{
536 struct request *req;
537
Tejun Heo9934c8c2009-05-08 11:54:16 +0900538 while ((req = blk_fetch_request(q)) != NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539 struct nbd_device *lo;
540
Laurent Vivier48cf6062008-04-29 01:02:46 -0700541 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;
Pavel Machek1a2ad212009-04-02 16:58:41 -0700583 if (!lo->sock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 return -EINVAL;
Pavel Machek1a2ad212009-04-02 16:58:41 -0700585 nbd_send_req(lo, &sreq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 return 0;
Pavel Machek1a2ad212009-04-02 16:58:41 -0700587 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588
Pavel Machek1a2ad212009-04-02 16:58:41 -0700589 case NBD_CLEAR_SOCK: {
590 struct file *file;
591
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592 lo->sock = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 file = lo->file;
594 lo->file = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 nbd_clear_que(lo);
Herbert Xu4b2f0262006-01-06 00:09:47 -0800596 BUG_ON(!list_empty(&lo->queue_head));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 if (file)
598 fput(file);
Pavel Machek1a2ad212009-04-02 16:58:41 -0700599 return 0;
600 }
601
602 case NBD_SET_SOCK: {
603 struct file *file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604 if (lo->file)
605 return -EBUSY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 file = fget(arg);
607 if (file) {
Al Viroa8cdc302008-03-02 09:33:33 -0500608 struct inode *inode = file->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 if (S_ISSOCK(inode->i_mode)) {
610 lo->file = file;
611 lo->sock = SOCKET_I(inode);
Laurent Vivierd71a6d72008-04-29 01:02:51 -0700612 if (max_part > 0)
613 bdev->bd_invalidated = 1;
Pavel Machek1a2ad212009-04-02 16:58:41 -0700614 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 } else {
616 fput(file);
617 }
618 }
Pavel Machek1a2ad212009-04-02 16:58:41 -0700619 return -EINVAL;
620 }
621
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 case NBD_SET_BLKSIZE:
623 lo->blksize = arg;
624 lo->bytesize &= ~(lo->blksize-1);
Al Viroa8cdc302008-03-02 09:33:33 -0500625 bdev->bd_inode->i_size = lo->bytesize;
626 set_blocksize(bdev, lo->blksize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627 set_capacity(lo->disk, lo->bytesize >> 9);
628 return 0;
Pavel Machek1a2ad212009-04-02 16:58:41 -0700629
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630 case NBD_SET_SIZE:
631 lo->bytesize = arg & ~(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
Paul Clements7fdfd402007-10-16 23:27:37 -0700637 case NBD_SET_TIMEOUT:
638 lo->xmit_timeout = arg * HZ;
639 return 0;
Pavel Machek1a2ad212009-04-02 16:58:41 -0700640
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 case NBD_SET_SIZE_BLOCKS:
642 lo->bytesize = ((u64) arg) * lo->blksize;
Al Viroa8cdc302008-03-02 09:33:33 -0500643 bdev->bd_inode->i_size = lo->bytesize;
644 set_blocksize(bdev, lo->blksize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645 set_capacity(lo->disk, lo->bytesize >> 9);
646 return 0;
Pavel Machek1a2ad212009-04-02 16:58:41 -0700647
648 case NBD_DO_IT: {
649 struct task_struct *thread;
650 struct file *file;
651 int error;
652
Pavel Machekc91192d2009-01-15 13:51:03 -0800653 if (lo->pid)
654 return -EBUSY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 if (!lo->file)
656 return -EINVAL;
Pavel Machek1a2ad212009-04-02 16:58:41 -0700657
658 mutex_unlock(&lo->tx_lock);
659
Laurent Vivier48cf6062008-04-29 01:02:46 -0700660 thread = kthread_create(nbd_thread, lo, lo->disk->disk_name);
Pavel Machek1a2ad212009-04-02 16:58:41 -0700661 if (IS_ERR(thread)) {
662 mutex_lock(&lo->tx_lock);
Laurent Vivier48cf6062008-04-29 01:02:46 -0700663 return PTR_ERR(thread);
Pavel Machek1a2ad212009-04-02 16:58:41 -0700664 }
Laurent Vivier48cf6062008-04-29 01:02:46 -0700665 wake_up_process(thread);
WANG Cong84963042007-05-09 02:33:36 -0700666 error = nbd_do_it(lo);
Laurent Vivier48cf6062008-04-29 01:02:46 -0700667 kthread_stop(thread);
Pavel Machek1a2ad212009-04-02 16:58:41 -0700668
669 mutex_lock(&lo->tx_lock);
WANG Cong84963042007-05-09 02:33:36 -0700670 if (error)
671 return error;
Pavel Machek1a2ad212009-04-02 16:58:41 -0700672 sock_shutdown(lo, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673 file = lo->file;
674 lo->file = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 nbd_clear_que(lo);
676 printk(KERN_WARNING "%s: queue cleared\n", lo->disk->disk_name);
677 if (file)
678 fput(file);
Paul Clements4b86a872007-10-16 23:27:36 -0700679 lo->bytesize = 0;
Al Viroa8cdc302008-03-02 09:33:33 -0500680 bdev->bd_inode->i_size = 0;
Paul Clements4b86a872007-10-16 23:27:36 -0700681 set_capacity(lo->disk, 0);
Laurent Vivierd71a6d72008-04-29 01:02:51 -0700682 if (max_part > 0)
Al Viroa8cdc302008-03-02 09:33:33 -0500683 ioctl_by_bdev(bdev, BLKRRPART, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 return lo->harderror;
Pavel Machek1a2ad212009-04-02 16:58:41 -0700685 }
686
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 case NBD_CLEAR_QUE:
Herbert Xu4b2f0262006-01-06 00:09:47 -0800688 /*
689 * This is for compatibility only. The queue is always cleared
690 * by NBD_DO_IT or NBD_CLEAR_SOCK.
691 */
692 BUG_ON(!lo->sock && !list_empty(&lo->queue_head));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693 return 0;
Pavel Machek1a2ad212009-04-02 16:58:41 -0700694
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 case NBD_PRINT_DEBUG:
696 printk(KERN_INFO "%s: next = %p, prev = %p, head = %p\n",
Al Viroa8cdc302008-03-02 09:33:33 -0500697 bdev->bd_disk->disk_name,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698 lo->queue_head.next, lo->queue_head.prev,
699 &lo->queue_head);
700 return 0;
701 }
Pavel Machek1a2ad212009-04-02 16:58:41 -0700702 return -ENOTTY;
703}
704
705static int nbd_ioctl(struct block_device *bdev, fmode_t mode,
706 unsigned int cmd, unsigned long arg)
707{
708 struct nbd_device *lo = bdev->bd_disk->private_data;
709 int error;
710
711 if (!capable(CAP_SYS_ADMIN))
712 return -EPERM;
713
714 BUG_ON(lo->magic != LO_MAGIC);
715
716 /* Anyone capable of this syscall can do *real bad* things */
717 dprintk(DBG_IOCTL, "%s: nbd_ioctl cmd=%s(0x%x) arg=%lu\n",
718 lo->disk->disk_name, ioctl_cmd_to_ascii(cmd), cmd, arg);
719
720 mutex_lock(&lo->tx_lock);
721 error = __nbd_ioctl(bdev, lo, cmd, arg);
722 mutex_unlock(&lo->tx_lock);
723
724 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725}
726
Alexey Dobriyan83d5cde2009-09-21 17:01:13 -0700727static const struct block_device_operations nbd_fops =
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728{
729 .owner = THIS_MODULE,
Arnd Bergmann8a6cfeb2010-07-08 10:18:46 +0200730 .ioctl = nbd_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731};
732
733/*
734 * And here should be modules and kernel interface
735 * (Just smiley confuses emacs :-)
736 */
737
738static int __init nbd_init(void)
739{
740 int err = -ENOMEM;
741 int i;
Laurent Vivierd71a6d72008-04-29 01:02:51 -0700742 int part_shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743
Adrian Bunk5b7b18c2006-03-25 03:07:04 -0800744 BUILD_BUG_ON(sizeof(struct nbd_request) != 28);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745
Laurent Vivierd71a6d72008-04-29 01:02:51 -0700746 if (max_part < 0) {
747 printk(KERN_CRIT "nbd: max_part must be >= 0\n");
748 return -EINVAL;
749 }
750
Sven Wegenerf3944d62008-08-20 14:09:07 -0700751 nbd_dev = kcalloc(nbds_max, sizeof(*nbd_dev), GFP_KERNEL);
752 if (!nbd_dev)
753 return -ENOMEM;
754
Laurent Vivierd71a6d72008-04-29 01:02:51 -0700755 part_shift = 0;
756 if (max_part > 0)
757 part_shift = fls(max_part);
758
Lars Marowsky-Bree40be0c22005-05-01 08:59:07 -0700759 for (i = 0; i < nbds_max; i++) {
Laurent Vivierd71a6d72008-04-29 01:02:51 -0700760 struct gendisk *disk = alloc_disk(1 << part_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 if (!disk)
762 goto out;
763 nbd_dev[i].disk = disk;
764 /*
765 * The new linux 2.5 block layer implementation requires
766 * every gendisk to have its very own request_queue struct.
767 * These structs are big so we dynamically allocate them.
768 */
769 disk->queue = blk_init_queue(do_nbd_request, &nbd_lock);
770 if (!disk->queue) {
771 put_disk(disk);
772 goto out;
773 }
Jens Axboe31dcfab2008-10-31 10:06:37 +0100774 /*
775 * Tell the block layer that we are not a rotational device
776 */
777 queue_flag_set_unlocked(QUEUE_FLAG_NONROT, disk->queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 }
779
780 if (register_blkdev(NBD_MAJOR, "nbd")) {
781 err = -EIO;
782 goto out;
783 }
784
785 printk(KERN_INFO "nbd: registered device at major %d\n", NBD_MAJOR);
786 dprintk(DBG_INIT, "nbd: debugflags=0x%x\n", debugflags);
787
Lars Marowsky-Bree40be0c22005-05-01 08:59:07 -0700788 for (i = 0; i < nbds_max; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789 struct gendisk *disk = nbd_dev[i].disk;
790 nbd_dev[i].file = NULL;
791 nbd_dev[i].magic = LO_MAGIC;
792 nbd_dev[i].flags = 0;
Laurent Vivier48cf6062008-04-29 01:02:46 -0700793 INIT_LIST_HEAD(&nbd_dev[i].waiting_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794 spin_lock_init(&nbd_dev[i].queue_lock);
795 INIT_LIST_HEAD(&nbd_dev[i].queue_head);
Ingo Molnar82d4dc52006-03-23 03:00:38 -0800796 mutex_init(&nbd_dev[i].tx_lock);
Herbert Xu4b2f0262006-01-06 00:09:47 -0800797 init_waitqueue_head(&nbd_dev[i].active_wq);
Laurent Vivier48cf6062008-04-29 01:02:46 -0700798 init_waitqueue_head(&nbd_dev[i].waiting_wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 nbd_dev[i].blksize = 1024;
Paul Clements4b86a872007-10-16 23:27:36 -0700800 nbd_dev[i].bytesize = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801 disk->major = NBD_MAJOR;
Laurent Vivierd71a6d72008-04-29 01:02:51 -0700802 disk->first_minor = i << part_shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803 disk->fops = &nbd_fops;
804 disk->private_data = &nbd_dev[i];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 sprintf(disk->disk_name, "nbd%d", i);
Paul Clements4b86a872007-10-16 23:27:36 -0700806 set_capacity(disk, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807 add_disk(disk);
808 }
809
810 return 0;
811out:
812 while (i--) {
813 blk_cleanup_queue(nbd_dev[i].disk->queue);
814 put_disk(nbd_dev[i].disk);
815 }
Sven Wegenerf3944d62008-08-20 14:09:07 -0700816 kfree(nbd_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 return err;
818}
819
820static void __exit nbd_cleanup(void)
821{
822 int i;
Lars Marowsky-Bree40be0c22005-05-01 08:59:07 -0700823 for (i = 0; i < nbds_max; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824 struct gendisk *disk = nbd_dev[i].disk;
Lars Marowsky-Bree40be0c22005-05-01 08:59:07 -0700825 nbd_dev[i].magic = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 if (disk) {
827 del_gendisk(disk);
828 blk_cleanup_queue(disk->queue);
829 put_disk(disk);
830 }
831 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 unregister_blkdev(NBD_MAJOR, "nbd");
Sven Wegenerf3944d62008-08-20 14:09:07 -0700833 kfree(nbd_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834 printk(KERN_INFO "nbd: unregistered device at major %d\n", NBD_MAJOR);
835}
836
837module_init(nbd_init);
838module_exit(nbd_cleanup);
839
840MODULE_DESCRIPTION("Network Block Device");
841MODULE_LICENSE("GPL");
842
Lars Marowsky-Bree40be0c22005-05-01 08:59:07 -0700843module_param(nbds_max, int, 0444);
Laurent Vivierd71a6d72008-04-29 01:02:51 -0700844MODULE_PARM_DESC(nbds_max, "number of network block devices to initialize (default: 16)");
845module_param(max_part, int, 0444);
846MODULE_PARM_DESC(max_part, "number of partitions per device (default: 0)");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847#ifndef NDEBUG
848module_param(debugflags, int, 0644);
849MODULE_PARM_DESC(debugflags, "flags for controlling debug output");
850#endif