blob: 16c3c8613cd317ece09ea6619745401e0ea0c699 [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>
Herbert Xu4b2f0262006-01-06 00:09:47 -080027#include <linux/compiler.h>
28#include <linux/err.h>
29#include <linux/kernel.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090030#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#include <net/sock.h>
Trond Myklebust91cf45f2007-11-12 18:10:39 -080032#include <linux/net.h>
Laurent Vivier48cf6062008-04-29 01:02:46 -070033#include <linux/kthread.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#include <asm/uaccess.h>
Herbert Xu4b2f0262006-01-06 00:09:47 -080036#include <asm/system.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037#include <asm/types.h>
38
39#include <linux/nbd.h>
40
41#define LO_MAGIC 0x68797548
42
43#ifdef NDEBUG
44#define dprintk(flags, fmt...)
45#else /* NDEBUG */
46#define dprintk(flags, fmt...) do { \
47 if (debugflags & (flags)) printk(KERN_DEBUG fmt); \
48} while (0)
49#define DBG_IOCTL 0x0004
50#define DBG_INIT 0x0010
51#define DBG_EXIT 0x0020
52#define DBG_BLKDEV 0x0100
53#define DBG_RX 0x0200
54#define DBG_TX 0x0400
55static unsigned int debugflags;
56#endif /* NDEBUG */
57
Ingo van Lil9c7a4162006-07-01 04:36:36 -070058static unsigned int nbds_max = 16;
Paul Clements20a81432008-02-08 04:21:51 -080059static struct nbd_device *nbd_dev;
Laurent Vivierd71a6d72008-04-29 01:02:51 -070060static int max_part;
Linus Torvalds1da177e2005-04-16 15:20:36 -070061
62/*
63 * Use just one lock (or at most 1 per NIC). Two arguments for this:
64 * 1. Each NIC is essentially a synchronization point for all servers
65 * accessed through that NIC so there's no need to have more locks
66 * than NICs anyway.
67 * 2. More locks lead to more "Dirty cache line bouncing" which will slow
68 * down each lock to the point where they're actually slower than just
69 * a single lock.
70 * Thanks go to Jens Axboe and Al Viro for their LKML emails explaining this!
71 */
72static DEFINE_SPINLOCK(nbd_lock);
73
74#ifndef NDEBUG
75static const char *ioctl_cmd_to_ascii(int cmd)
76{
77 switch (cmd) {
78 case NBD_SET_SOCK: return "set-sock";
79 case NBD_SET_BLKSIZE: return "set-blksize";
80 case NBD_SET_SIZE: return "set-size";
81 case NBD_DO_IT: return "do-it";
82 case NBD_CLEAR_SOCK: return "clear-sock";
83 case NBD_CLEAR_QUE: return "clear-que";
84 case NBD_PRINT_DEBUG: return "print-debug";
85 case NBD_SET_SIZE_BLOCKS: return "set-size-blocks";
86 case NBD_DISCONNECT: return "disconnect";
87 case BLKROSET: return "set-read-only";
88 case BLKFLSBUF: return "flush-buffer-cache";
89 }
90 return "unknown";
91}
92
93static const char *nbdcmd_to_ascii(int cmd)
94{
95 switch (cmd) {
96 case NBD_CMD_READ: return "read";
97 case NBD_CMD_WRITE: return "write";
98 case NBD_CMD_DISC: return "disconnect";
99 }
100 return "invalid";
101}
102#endif /* NDEBUG */
103
104static void nbd_end_request(struct request *req)
105{
Kiyoshi Ueda097c94a2007-12-11 17:44:06 -0500106 int error = req->errors ? -EIO : 0;
Jens Axboe165125e2007-07-24 09:28:11 +0200107 struct request_queue *q = req->q;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108 unsigned long flags;
109
110 dprintk(DBG_BLKDEV, "%s: request %p: %s\n", req->rq_disk->disk_name,
Kiyoshi Ueda097c94a2007-12-11 17:44:06 -0500111 req, error ? "failed" : "done");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112
113 spin_lock_irqsave(q->queue_lock, flags);
Tejun Heo1011c1b2009-05-07 22:24:45 +0900114 __blk_end_request_all(req, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 spin_unlock_irqrestore(q->queue_lock, flags);
116}
117
Paul Clements7fdfd402007-10-16 23:27:37 -0700118static void sock_shutdown(struct nbd_device *lo, int lock)
119{
120 /* Forcibly shutdown the socket causing all listeners
121 * to error
122 *
123 * FIXME: This code is duplicated from sys_shutdown, but
124 * there should be a more generic interface rather than
125 * calling socket ops directly here */
126 if (lock)
127 mutex_lock(&lo->tx_lock);
128 if (lo->sock) {
129 printk(KERN_WARNING "%s: shutting down socket\n",
130 lo->disk->disk_name);
Trond Myklebust91cf45f2007-11-12 18:10:39 -0800131 kernel_sock_shutdown(lo->sock, SHUT_RDWR);
Paul Clements7fdfd402007-10-16 23:27:37 -0700132 lo->sock = NULL;
133 }
134 if (lock)
135 mutex_unlock(&lo->tx_lock);
136}
137
138static void nbd_xmit_timeout(unsigned long arg)
139{
140 struct task_struct *task = (struct task_struct *)arg;
141
142 printk(KERN_WARNING "nbd: killing hung xmit (%s, pid: %d)\n",
143 task->comm, task->pid);
144 force_sig(SIGKILL, task);
145}
146
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147/*
148 * Send or receive packet.
149 */
Paul Clements7fdfd402007-10-16 23:27:37 -0700150static int sock_xmit(struct nbd_device *lo, int send, void *buf, int size,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 int msg_flags)
152{
Paul Clements7fdfd402007-10-16 23:27:37 -0700153 struct socket *sock = lo->sock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 int result;
155 struct msghdr msg;
156 struct kvec iov;
Oleg Nesterovbe0ef952007-07-15 23:41:32 -0700157 sigset_t blocked, oldset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158
Mike Snitzerffc41cf2008-04-02 13:04:47 -0700159 if (unlikely(!sock)) {
160 printk(KERN_ERR "%s: Attempted %s on closed socket in sock_xmit\n",
161 lo->disk->disk_name, (send ? "send" : "recv"));
162 return -EINVAL;
163 }
164
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165 /* Allow interception of SIGKILL only
166 * Don't allow other signals to interrupt the transmission */
Oleg Nesterovbe0ef952007-07-15 23:41:32 -0700167 siginitsetinv(&blocked, sigmask(SIGKILL));
168 sigprocmask(SIG_SETMASK, &blocked, &oldset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169
170 do {
171 sock->sk->sk_allocation = GFP_NOIO;
172 iov.iov_base = buf;
173 iov.iov_len = size;
174 msg.msg_name = NULL;
175 msg.msg_namelen = 0;
176 msg.msg_control = NULL;
177 msg.msg_controllen = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 msg.msg_flags = msg_flags | MSG_NOSIGNAL;
179
Paul Clements7fdfd402007-10-16 23:27:37 -0700180 if (send) {
181 struct timer_list ti;
182
183 if (lo->xmit_timeout) {
184 init_timer(&ti);
185 ti.function = nbd_xmit_timeout;
186 ti.data = (unsigned long)current;
187 ti.expires = jiffies + lo->xmit_timeout;
188 add_timer(&ti);
189 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 result = kernel_sendmsg(sock, &msg, &iov, 1, size);
Paul Clements7fdfd402007-10-16 23:27:37 -0700191 if (lo->xmit_timeout)
192 del_timer_sync(&ti);
193 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 result = kernel_recvmsg(sock, &msg, &iov, 1, size, 0);
195
196 if (signal_pending(current)) {
197 siginfo_t info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198 printk(KERN_WARNING "nbd (pid %d: %s) got signal %d\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -0700199 task_pid_nr(current), current->comm,
Oleg Nesterovbe0ef952007-07-15 23:41:32 -0700200 dequeue_signal_lock(current, &current->blocked, &info));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 result = -EINTR;
Paul Clements7fdfd402007-10-16 23:27:37 -0700202 sock_shutdown(lo, !send);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203 break;
204 }
205
206 if (result <= 0) {
207 if (result == 0)
208 result = -EPIPE; /* short read */
209 break;
210 }
211 size -= result;
212 buf += result;
213 } while (size > 0);
214
Oleg Nesterovbe0ef952007-07-15 23:41:32 -0700215 sigprocmask(SIG_SETMASK, &oldset, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216
217 return result;
218}
219
Paul Clements7fdfd402007-10-16 23:27:37 -0700220static inline int sock_send_bvec(struct nbd_device *lo, struct bio_vec *bvec,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 int flags)
222{
223 int result;
224 void *kaddr = kmap(bvec->bv_page);
Paul Clements7fdfd402007-10-16 23:27:37 -0700225 result = sock_xmit(lo, 1, kaddr + bvec->bv_offset, bvec->bv_len, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226 kunmap(bvec->bv_page);
227 return result;
228}
229
Paul Clements7fdfd402007-10-16 23:27:37 -0700230/* always call with the tx_lock held */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231static int nbd_send_req(struct nbd_device *lo, struct request *req)
232{
NeilBrown5705f702007-09-25 12:35:59 +0200233 int result, flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 struct nbd_request request;
Tejun Heo1011c1b2009-05-07 22:24:45 +0900235 unsigned long size = blk_rq_bytes(req);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236
237 request.magic = htonl(NBD_REQUEST_MAGIC);
238 request.type = htonl(nbd_cmd(req));
Tejun Heo83096eb2009-05-07 22:24:39 +0900239 request.from = cpu_to_be64((u64)blk_rq_pos(req) << 9);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 request.len = htonl(size);
241 memcpy(request.handle, &req, sizeof(req));
242
Tejun Heo83096eb2009-05-07 22:24:39 +0900243 dprintk(DBG_TX, "%s: request %p: sending control (%s@%llu,%uB)\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 lo->disk->disk_name, req,
245 nbdcmd_to_ascii(nbd_cmd(req)),
Tejun Heo83096eb2009-05-07 22:24:39 +0900246 (unsigned long long)blk_rq_pos(req) << 9,
Tejun Heo1011c1b2009-05-07 22:24:45 +0900247 blk_rq_bytes(req));
Paul Clements7fdfd402007-10-16 23:27:37 -0700248 result = sock_xmit(lo, 1, &request, sizeof(request),
249 (nbd_cmd(req) == NBD_CMD_WRITE) ? MSG_MORE : 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250 if (result <= 0) {
251 printk(KERN_ERR "%s: Send control failed (result %d)\n",
252 lo->disk->disk_name, result);
253 goto error_out;
254 }
255
256 if (nbd_cmd(req) == NBD_CMD_WRITE) {
NeilBrown5705f702007-09-25 12:35:59 +0200257 struct req_iterator iter;
258 struct bio_vec *bvec;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 /*
260 * we are really probing at internals to determine
261 * whether to set MSG_MORE or not...
262 */
NeilBrown5705f702007-09-25 12:35:59 +0200263 rq_for_each_segment(bvec, req, iter) {
Jens Axboe6c92e692007-08-16 13:43:12 +0200264 flags = 0;
265 if (!rq_iter_last(req, iter))
266 flags = MSG_MORE;
267 dprintk(DBG_TX, "%s: request %p: sending %d bytes data\n",
268 lo->disk->disk_name, req, bvec->bv_len);
Paul Clements7fdfd402007-10-16 23:27:37 -0700269 result = sock_send_bvec(lo, bvec, flags);
Jens Axboe6c92e692007-08-16 13:43:12 +0200270 if (result <= 0) {
271 printk(KERN_ERR "%s: Send data failed (result %d)\n",
272 lo->disk->disk_name, result);
273 goto error_out;
274 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 }
276 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277 return 0;
278
279error_out:
Pavel Machek15746fc2009-04-02 16:58:42 -0700280 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281}
282
Denis Cheng0cbc591b2007-10-16 23:26:14 -0700283static struct request *nbd_find_request(struct nbd_device *lo,
284 struct request *xreq)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285{
Denis Chengd2c97402007-10-16 23:26:14 -0700286 struct request *req, *tmp;
Herbert Xu4b2f0262006-01-06 00:09:47 -0800287 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288
Herbert Xu4b2f0262006-01-06 00:09:47 -0800289 err = wait_event_interruptible(lo->active_wq, lo->active_req != xreq);
290 if (unlikely(err))
291 goto out;
292
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293 spin_lock(&lo->queue_lock);
Denis Chengd2c97402007-10-16 23:26:14 -0700294 list_for_each_entry_safe(req, tmp, &lo->queue_head, queuelist) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 if (req != xreq)
296 continue;
297 list_del_init(&req->queuelist);
298 spin_unlock(&lo->queue_lock);
299 return req;
300 }
301 spin_unlock(&lo->queue_lock);
Herbert Xu4b2f0262006-01-06 00:09:47 -0800302
303 err = -ENOENT;
304
305out:
306 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307}
308
Paul Clements7fdfd402007-10-16 23:27:37 -0700309static inline int sock_recv_bvec(struct nbd_device *lo, struct bio_vec *bvec)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310{
311 int result;
312 void *kaddr = kmap(bvec->bv_page);
Paul Clements7fdfd402007-10-16 23:27:37 -0700313 result = sock_xmit(lo, 0, kaddr + bvec->bv_offset, bvec->bv_len,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 MSG_WAITALL);
315 kunmap(bvec->bv_page);
316 return result;
317}
318
319/* NULL returned = something went wrong, inform userspace */
320static struct request *nbd_read_stat(struct nbd_device *lo)
321{
322 int result;
323 struct nbd_reply reply;
324 struct request *req;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325
326 reply.magic = 0;
Paul Clements7fdfd402007-10-16 23:27:37 -0700327 result = sock_xmit(lo, 0, &reply, sizeof(reply), MSG_WAITALL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 if (result <= 0) {
329 printk(KERN_ERR "%s: Receive control failed (result %d)\n",
330 lo->disk->disk_name, result);
331 goto harderror;
332 }
Michal Feixe4b57e02006-07-30 03:03:31 -0700333
334 if (ntohl(reply.magic) != NBD_REPLY_MAGIC) {
335 printk(KERN_ERR "%s: Wrong magic (0x%lx)\n",
336 lo->disk->disk_name,
337 (unsigned long)ntohl(reply.magic));
338 result = -EPROTO;
339 goto harderror;
340 }
341
Denis Cheng0cbc591b2007-10-16 23:26:14 -0700342 req = nbd_find_request(lo, *(struct request **)reply.handle);
Hirofumi Nakagawa801678c2008-04-29 01:03:09 -0700343 if (IS_ERR(req)) {
Herbert Xu4b2f0262006-01-06 00:09:47 -0800344 result = PTR_ERR(req);
345 if (result != -ENOENT)
346 goto harderror;
347
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 printk(KERN_ERR "%s: Unexpected reply (%p)\n",
349 lo->disk->disk_name, reply.handle);
350 result = -EBADR;
351 goto harderror;
352 }
353
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 if (ntohl(reply.error)) {
355 printk(KERN_ERR "%s: Other side returned error (%d)\n",
356 lo->disk->disk_name, ntohl(reply.error));
357 req->errors++;
358 return req;
359 }
360
361 dprintk(DBG_RX, "%s: request %p: got reply\n",
362 lo->disk->disk_name, req);
363 if (nbd_cmd(req) == NBD_CMD_READ) {
NeilBrown5705f702007-09-25 12:35:59 +0200364 struct req_iterator iter;
365 struct bio_vec *bvec;
366
367 rq_for_each_segment(bvec, req, iter) {
Paul Clements7fdfd402007-10-16 23:27:37 -0700368 result = sock_recv_bvec(lo, bvec);
Jens Axboe6c92e692007-08-16 13:43:12 +0200369 if (result <= 0) {
370 printk(KERN_ERR "%s: Receive data failed (result %d)\n",
371 lo->disk->disk_name, result);
372 req->errors++;
373 return req;
374 }
375 dprintk(DBG_RX, "%s: request %p: got %d bytes data\n",
376 lo->disk->disk_name, req, bvec->bv_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 }
378 }
379 return req;
380harderror:
381 lo->harderror = result;
382 return NULL;
383}
384
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200385static ssize_t pid_show(struct device *dev,
386 struct device_attribute *attr, char *buf)
Paul Clements6b39bb62006-12-06 20:40:53 -0800387{
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200388 struct gendisk *disk = dev_to_disk(dev);
389
390 return sprintf(buf, "%ld\n",
Paul Clements6b39bb62006-12-06 20:40:53 -0800391 (long) ((struct nbd_device *)disk->private_data)->pid);
392}
393
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200394static struct device_attribute pid_attr = {
Parag Warudkar01e8ef12008-10-18 20:28:50 -0700395 .attr = { .name = "pid", .mode = S_IRUGO},
Paul Clements6b39bb62006-12-06 20:40:53 -0800396 .show = pid_show,
397};
398
WANG Cong84963042007-05-09 02:33:36 -0700399static int nbd_do_it(struct nbd_device *lo)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400{
401 struct request *req;
WANG Cong84963042007-05-09 02:33:36 -0700402 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403
404 BUG_ON(lo->magic != LO_MAGIC);
405
Paul Clements6b39bb62006-12-06 20:40:53 -0800406 lo->pid = current->pid;
Tejun Heoed9e1982008-08-25 19:56:05 +0900407 ret = sysfs_create_file(&disk_to_dev(lo->disk)->kobj, &pid_attr.attr);
WANG Cong84963042007-05-09 02:33:36 -0700408 if (ret) {
409 printk(KERN_ERR "nbd: sysfs_create_file failed!");
Pavel Machekc91192d2009-01-15 13:51:03 -0800410 lo->pid = 0;
WANG Cong84963042007-05-09 02:33:36 -0700411 return ret;
412 }
Paul Clements6b39bb62006-12-06 20:40:53 -0800413
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414 while ((req = nbd_read_stat(lo)) != NULL)
415 nbd_end_request(req);
Paul Clements6b39bb62006-12-06 20:40:53 -0800416
Tejun Heoed9e1982008-08-25 19:56:05 +0900417 sysfs_remove_file(&disk_to_dev(lo->disk)->kobj, &pid_attr.attr);
Pavel Machekc91192d2009-01-15 13:51:03 -0800418 lo->pid = 0;
WANG Cong84963042007-05-09 02:33:36 -0700419 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420}
421
422static void nbd_clear_que(struct nbd_device *lo)
423{
424 struct request *req;
425
426 BUG_ON(lo->magic != LO_MAGIC);
427
Herbert Xu4b2f0262006-01-06 00:09:47 -0800428 /*
429 * Because we have set lo->sock to NULL under the tx_lock, all
430 * modifications to the list must have completed by now. For
431 * the same reason, the active_req must be NULL.
432 *
433 * As a consequence, we don't need to take the spin lock while
434 * purging the list here.
435 */
436 BUG_ON(lo->sock);
437 BUG_ON(lo->active_req);
438
439 while (!list_empty(&lo->queue_head)) {
440 req = list_entry(lo->queue_head.next, struct request,
441 queuelist);
442 list_del_init(&req->queuelist);
443 req->errors++;
444 nbd_end_request(req);
445 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446}
447
Paul Clements7fdfd402007-10-16 23:27:37 -0700448
Laurent Vivier48cf6062008-04-29 01:02:46 -0700449static void nbd_handle_req(struct nbd_device *lo, struct request *req)
450{
451 if (!blk_fs_request(req))
452 goto error_out;
453
454 nbd_cmd(req) = NBD_CMD_READ;
455 if (rq_data_dir(req) == WRITE) {
456 nbd_cmd(req) = NBD_CMD_WRITE;
457 if (lo->flags & NBD_READ_ONLY) {
458 printk(KERN_ERR "%s: Write on read-only\n",
459 lo->disk->disk_name);
460 goto error_out;
461 }
462 }
463
464 req->errors = 0;
465
466 mutex_lock(&lo->tx_lock);
467 if (unlikely(!lo->sock)) {
468 mutex_unlock(&lo->tx_lock);
469 printk(KERN_ERR "%s: Attempted send on closed socket\n",
470 lo->disk->disk_name);
Pavel Machek15746fc2009-04-02 16:58:42 -0700471 goto error_out;
Laurent Vivier48cf6062008-04-29 01:02:46 -0700472 }
473
474 lo->active_req = req;
475
476 if (nbd_send_req(lo, req) != 0) {
477 printk(KERN_ERR "%s: Request send failed\n",
478 lo->disk->disk_name);
479 req->errors++;
480 nbd_end_request(req);
481 } else {
482 spin_lock(&lo->queue_lock);
483 list_add(&req->queuelist, &lo->queue_head);
484 spin_unlock(&lo->queue_lock);
485 }
486
487 lo->active_req = NULL;
488 mutex_unlock(&lo->tx_lock);
489 wake_up_all(&lo->active_wq);
490
491 return;
492
493error_out:
494 req->errors++;
495 nbd_end_request(req);
496}
497
498static int nbd_thread(void *data)
499{
500 struct nbd_device *lo = data;
501 struct request *req;
502
503 set_user_nice(current, -20);
504 while (!kthread_should_stop() || !list_empty(&lo->waiting_queue)) {
505 /* wait for something to do */
506 wait_event_interruptible(lo->waiting_wq,
507 kthread_should_stop() ||
508 !list_empty(&lo->waiting_queue));
509
510 /* extract request */
511 if (list_empty(&lo->waiting_queue))
512 continue;
513
514 spin_lock_irq(&lo->queue_lock);
515 req = list_entry(lo->waiting_queue.next, struct request,
516 queuelist);
517 list_del_init(&req->queuelist);
518 spin_unlock_irq(&lo->queue_lock);
519
520 /* handle request */
521 nbd_handle_req(lo, req);
522 }
523 return 0;
524}
525
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526/*
527 * We always wait for result of write, for now. It would be nice to make it optional
528 * in future
Boaz Harroshe654bc42007-06-20 13:53:23 +0200529 * if ((rq_data_dir(req) == WRITE) && (lo->flags & NBD_WRITE_NOCHK))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 * { printk( "Warning: Ignoring result!\n"); nbd_end_request( req ); }
531 */
532
Pavel Machek15746fc2009-04-02 16:58:42 -0700533static void do_nbd_request(struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534{
535 struct request *req;
536
Tejun Heo9934c8c2009-05-08 11:54:16 +0900537 while ((req = blk_fetch_request(q)) != NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538 struct nbd_device *lo;
539
Laurent Vivier48cf6062008-04-29 01:02:46 -0700540 spin_unlock_irq(q->queue_lock);
541
Jens Axboe4aff5e22006-08-10 08:44:47 +0200542 dprintk(DBG_BLKDEV, "%s: request %p: dequeued (flags=%x)\n",
543 req->rq_disk->disk_name, req, req->cmd_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545 lo = req->rq_disk->private_data;
546
547 BUG_ON(lo->magic != LO_MAGIC);
548
Paul Clements4d48a542009-02-11 13:04:45 -0800549 if (unlikely(!lo->sock)) {
550 printk(KERN_ERR "%s: Attempted send on closed socket\n",
551 lo->disk->disk_name);
552 req->errors++;
553 nbd_end_request(req);
554 spin_lock_irq(q->queue_lock);
555 continue;
556 }
557
Laurent Vivier48cf6062008-04-29 01:02:46 -0700558 spin_lock_irq(&lo->queue_lock);
559 list_add_tail(&req->queuelist, &lo->waiting_queue);
560 spin_unlock_irq(&lo->queue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561
Laurent Vivier48cf6062008-04-29 01:02:46 -0700562 wake_up(&lo->waiting_wq);
Herbert Xu4b2f0262006-01-06 00:09:47 -0800563
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564 spin_lock_irq(q->queue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566}
567
Pavel Machek1a2ad212009-04-02 16:58:41 -0700568/* Must be called with tx_lock held */
569
570static int __nbd_ioctl(struct block_device *bdev, struct nbd_device *lo,
571 unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 switch (cmd) {
Pavel Machek1a2ad212009-04-02 16:58:41 -0700574 case NBD_DISCONNECT: {
575 struct request sreq;
576
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 printk(KERN_INFO "%s: NBD_DISCONNECT\n", lo->disk->disk_name);
Pavel Machek1a2ad212009-04-02 16:58:41 -0700578
FUJITA Tomonori4f54eec2008-04-29 09:54:37 +0200579 blk_rq_init(NULL, &sreq);
Jens Axboe4aff5e22006-08-10 08:44:47 +0200580 sreq.cmd_type = REQ_TYPE_SPECIAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 nbd_cmd(&sreq) = NBD_CMD_DISC;
Pavel Machek1a2ad212009-04-02 16:58:41 -0700582 if (!lo->sock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 return -EINVAL;
Pavel Machek1a2ad212009-04-02 16:58:41 -0700584 nbd_send_req(lo, &sreq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585 return 0;
Pavel Machek1a2ad212009-04-02 16:58:41 -0700586 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587
Pavel Machek1a2ad212009-04-02 16:58:41 -0700588 case NBD_CLEAR_SOCK: {
589 struct file *file;
590
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591 lo->sock = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592 file = lo->file;
593 lo->file = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 nbd_clear_que(lo);
Herbert Xu4b2f0262006-01-06 00:09:47 -0800595 BUG_ON(!list_empty(&lo->queue_head));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 if (file)
597 fput(file);
Pavel Machek1a2ad212009-04-02 16:58:41 -0700598 return 0;
599 }
600
601 case NBD_SET_SOCK: {
602 struct file *file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603 if (lo->file)
604 return -EBUSY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 file = fget(arg);
606 if (file) {
Al Viroa8cdc302008-03-02 09:33:33 -0500607 struct inode *inode = file->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608 if (S_ISSOCK(inode->i_mode)) {
609 lo->file = file;
610 lo->sock = SOCKET_I(inode);
Laurent Vivierd71a6d72008-04-29 01:02:51 -0700611 if (max_part > 0)
612 bdev->bd_invalidated = 1;
Pavel Machek1a2ad212009-04-02 16:58:41 -0700613 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614 } else {
615 fput(file);
616 }
617 }
Pavel Machek1a2ad212009-04-02 16:58:41 -0700618 return -EINVAL;
619 }
620
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 case NBD_SET_BLKSIZE:
622 lo->blksize = arg;
623 lo->bytesize &= ~(lo->blksize-1);
Al Viroa8cdc302008-03-02 09:33:33 -0500624 bdev->bd_inode->i_size = lo->bytesize;
625 set_blocksize(bdev, lo->blksize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 set_capacity(lo->disk, lo->bytesize >> 9);
627 return 0;
Pavel Machek1a2ad212009-04-02 16:58:41 -0700628
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 case NBD_SET_SIZE:
630 lo->bytesize = arg & ~(lo->blksize-1);
Al Viroa8cdc302008-03-02 09:33:33 -0500631 bdev->bd_inode->i_size = lo->bytesize;
632 set_blocksize(bdev, lo->blksize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633 set_capacity(lo->disk, lo->bytesize >> 9);
634 return 0;
Pavel Machek1a2ad212009-04-02 16:58:41 -0700635
Paul Clements7fdfd402007-10-16 23:27:37 -0700636 case NBD_SET_TIMEOUT:
637 lo->xmit_timeout = arg * HZ;
638 return 0;
Pavel Machek1a2ad212009-04-02 16:58:41 -0700639
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 case NBD_SET_SIZE_BLOCKS:
641 lo->bytesize = ((u64) arg) * lo->blksize;
Al Viroa8cdc302008-03-02 09:33:33 -0500642 bdev->bd_inode->i_size = lo->bytesize;
643 set_blocksize(bdev, lo->blksize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 set_capacity(lo->disk, lo->bytesize >> 9);
645 return 0;
Pavel Machek1a2ad212009-04-02 16:58:41 -0700646
647 case NBD_DO_IT: {
648 struct task_struct *thread;
649 struct file *file;
650 int error;
651
Pavel Machekc91192d2009-01-15 13:51:03 -0800652 if (lo->pid)
653 return -EBUSY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654 if (!lo->file)
655 return -EINVAL;
Pavel Machek1a2ad212009-04-02 16:58:41 -0700656
657 mutex_unlock(&lo->tx_lock);
658
Laurent Vivier48cf6062008-04-29 01:02:46 -0700659 thread = kthread_create(nbd_thread, lo, lo->disk->disk_name);
Pavel Machek1a2ad212009-04-02 16:58:41 -0700660 if (IS_ERR(thread)) {
661 mutex_lock(&lo->tx_lock);
Laurent Vivier48cf6062008-04-29 01:02:46 -0700662 return PTR_ERR(thread);
Pavel Machek1a2ad212009-04-02 16:58:41 -0700663 }
Laurent Vivier48cf6062008-04-29 01:02:46 -0700664 wake_up_process(thread);
WANG Cong84963042007-05-09 02:33:36 -0700665 error = nbd_do_it(lo);
Laurent Vivier48cf6062008-04-29 01:02:46 -0700666 kthread_stop(thread);
Pavel Machek1a2ad212009-04-02 16:58:41 -0700667
668 mutex_lock(&lo->tx_lock);
WANG Cong84963042007-05-09 02:33:36 -0700669 if (error)
670 return error;
Pavel Machek1a2ad212009-04-02 16:58:41 -0700671 sock_shutdown(lo, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672 file = lo->file;
673 lo->file = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674 nbd_clear_que(lo);
675 printk(KERN_WARNING "%s: queue cleared\n", lo->disk->disk_name);
676 if (file)
677 fput(file);
Paul Clements4b86a872007-10-16 23:27:36 -0700678 lo->bytesize = 0;
Al Viroa8cdc302008-03-02 09:33:33 -0500679 bdev->bd_inode->i_size = 0;
Paul Clements4b86a872007-10-16 23:27:36 -0700680 set_capacity(lo->disk, 0);
Laurent Vivierd71a6d72008-04-29 01:02:51 -0700681 if (max_part > 0)
Al Viroa8cdc302008-03-02 09:33:33 -0500682 ioctl_by_bdev(bdev, BLKRRPART, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 return lo->harderror;
Pavel Machek1a2ad212009-04-02 16:58:41 -0700684 }
685
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686 case NBD_CLEAR_QUE:
Herbert Xu4b2f0262006-01-06 00:09:47 -0800687 /*
688 * This is for compatibility only. The queue is always cleared
689 * by NBD_DO_IT or NBD_CLEAR_SOCK.
690 */
691 BUG_ON(!lo->sock && !list_empty(&lo->queue_head));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692 return 0;
Pavel Machek1a2ad212009-04-02 16:58:41 -0700693
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694 case NBD_PRINT_DEBUG:
695 printk(KERN_INFO "%s: next = %p, prev = %p, head = %p\n",
Al Viroa8cdc302008-03-02 09:33:33 -0500696 bdev->bd_disk->disk_name,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697 lo->queue_head.next, lo->queue_head.prev,
698 &lo->queue_head);
699 return 0;
700 }
Pavel Machek1a2ad212009-04-02 16:58:41 -0700701 return -ENOTTY;
702}
703
704static int nbd_ioctl(struct block_device *bdev, fmode_t mode,
705 unsigned int cmd, unsigned long arg)
706{
707 struct nbd_device *lo = bdev->bd_disk->private_data;
708 int error;
709
710 if (!capable(CAP_SYS_ADMIN))
711 return -EPERM;
712
713 BUG_ON(lo->magic != LO_MAGIC);
714
715 /* Anyone capable of this syscall can do *real bad* things */
716 dprintk(DBG_IOCTL, "%s: nbd_ioctl cmd=%s(0x%x) arg=%lu\n",
717 lo->disk->disk_name, ioctl_cmd_to_ascii(cmd), cmd, arg);
718
719 mutex_lock(&lo->tx_lock);
720 error = __nbd_ioctl(bdev, lo, cmd, arg);
721 mutex_unlock(&lo->tx_lock);
722
723 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724}
725
Alexey Dobriyan83d5cde2009-09-21 17:01:13 -0700726static const struct block_device_operations nbd_fops =
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727{
728 .owner = THIS_MODULE,
Al Viroa8cdc302008-03-02 09:33:33 -0500729 .locked_ioctl = nbd_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730};
731
732/*
733 * And here should be modules and kernel interface
734 * (Just smiley confuses emacs :-)
735 */
736
737static int __init nbd_init(void)
738{
739 int err = -ENOMEM;
740 int i;
Laurent Vivierd71a6d72008-04-29 01:02:51 -0700741 int part_shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742
Adrian Bunk5b7b18c2006-03-25 03:07:04 -0800743 BUILD_BUG_ON(sizeof(struct nbd_request) != 28);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744
Laurent Vivierd71a6d72008-04-29 01:02:51 -0700745 if (max_part < 0) {
746 printk(KERN_CRIT "nbd: max_part must be >= 0\n");
747 return -EINVAL;
748 }
749
Sven Wegenerf3944d62008-08-20 14:09:07 -0700750 nbd_dev = kcalloc(nbds_max, sizeof(*nbd_dev), GFP_KERNEL);
751 if (!nbd_dev)
752 return -ENOMEM;
753
Laurent Vivierd71a6d72008-04-29 01:02:51 -0700754 part_shift = 0;
755 if (max_part > 0)
756 part_shift = fls(max_part);
757
Lars Marowsky-Bree40be0c22005-05-01 08:59:07 -0700758 for (i = 0; i < nbds_max; i++) {
Laurent Vivierd71a6d72008-04-29 01:02:51 -0700759 struct gendisk *disk = alloc_disk(1 << part_shift);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760 if (!disk)
761 goto out;
762 nbd_dev[i].disk = disk;
763 /*
764 * The new linux 2.5 block layer implementation requires
765 * every gendisk to have its very own request_queue struct.
766 * These structs are big so we dynamically allocate them.
767 */
768 disk->queue = blk_init_queue(do_nbd_request, &nbd_lock);
769 if (!disk->queue) {
770 put_disk(disk);
771 goto out;
772 }
Jens Axboe31dcfab2008-10-31 10:06:37 +0100773 /*
774 * Tell the block layer that we are not a rotational device
775 */
776 queue_flag_set_unlocked(QUEUE_FLAG_NONROT, disk->queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 }
778
779 if (register_blkdev(NBD_MAJOR, "nbd")) {
780 err = -EIO;
781 goto out;
782 }
783
784 printk(KERN_INFO "nbd: registered device at major %d\n", NBD_MAJOR);
785 dprintk(DBG_INIT, "nbd: debugflags=0x%x\n", debugflags);
786
Lars Marowsky-Bree40be0c22005-05-01 08:59:07 -0700787 for (i = 0; i < nbds_max; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 struct gendisk *disk = nbd_dev[i].disk;
789 nbd_dev[i].file = NULL;
790 nbd_dev[i].magic = LO_MAGIC;
791 nbd_dev[i].flags = 0;
Laurent Vivier48cf6062008-04-29 01:02:46 -0700792 INIT_LIST_HEAD(&nbd_dev[i].waiting_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793 spin_lock_init(&nbd_dev[i].queue_lock);
794 INIT_LIST_HEAD(&nbd_dev[i].queue_head);
Ingo Molnar82d4dc52006-03-23 03:00:38 -0800795 mutex_init(&nbd_dev[i].tx_lock);
Herbert Xu4b2f0262006-01-06 00:09:47 -0800796 init_waitqueue_head(&nbd_dev[i].active_wq);
Laurent Vivier48cf6062008-04-29 01:02:46 -0700797 init_waitqueue_head(&nbd_dev[i].waiting_wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798 nbd_dev[i].blksize = 1024;
Paul Clements4b86a872007-10-16 23:27:36 -0700799 nbd_dev[i].bytesize = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800 disk->major = NBD_MAJOR;
Laurent Vivierd71a6d72008-04-29 01:02:51 -0700801 disk->first_minor = i << part_shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802 disk->fops = &nbd_fops;
803 disk->private_data = &nbd_dev[i];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804 sprintf(disk->disk_name, "nbd%d", i);
Paul Clements4b86a872007-10-16 23:27:36 -0700805 set_capacity(disk, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806 add_disk(disk);
807 }
808
809 return 0;
810out:
811 while (i--) {
812 blk_cleanup_queue(nbd_dev[i].disk->queue);
813 put_disk(nbd_dev[i].disk);
814 }
Sven Wegenerf3944d62008-08-20 14:09:07 -0700815 kfree(nbd_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816 return err;
817}
818
819static void __exit nbd_cleanup(void)
820{
821 int i;
Lars Marowsky-Bree40be0c22005-05-01 08:59:07 -0700822 for (i = 0; i < nbds_max; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823 struct gendisk *disk = nbd_dev[i].disk;
Lars Marowsky-Bree40be0c22005-05-01 08:59:07 -0700824 nbd_dev[i].magic = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825 if (disk) {
826 del_gendisk(disk);
827 blk_cleanup_queue(disk->queue);
828 put_disk(disk);
829 }
830 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 unregister_blkdev(NBD_MAJOR, "nbd");
Sven Wegenerf3944d62008-08-20 14:09:07 -0700832 kfree(nbd_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 printk(KERN_INFO "nbd: unregistered device at major %d\n", NBD_MAJOR);
834}
835
836module_init(nbd_init);
837module_exit(nbd_cleanup);
838
839MODULE_DESCRIPTION("Network Block Device");
840MODULE_LICENSE("GPL");
841
Lars Marowsky-Bree40be0c22005-05-01 08:59:07 -0700842module_param(nbds_max, int, 0444);
Laurent Vivierd71a6d72008-04-29 01:02:51 -0700843MODULE_PARM_DESC(nbds_max, "number of network block devices to initialize (default: 16)");
844module_param(max_part, int, 0444);
845MODULE_PARM_DESC(max_part, "number of partitions per device (default: 0)");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846#ifndef NDEBUG
847module_param(debugflags, int, 0644);
848MODULE_PARM_DESC(debugflags, "flags for controlling debug output");
849#endif