2 * Network block device - make block devices work over TCP
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.
7 * Copyright 1997-2000, 2008 Pavel Machek <pavel@suse.cz>
8 * Parts copyright 2001 Steven Whitehouse <steve@chygwyn.com>
10 * This file is released under GPLv2 or later.
12 * (part of code stolen from loop.c)
15 #include <linux/major.h>
17 #include <linux/blkdev.h>
18 #include <linux/module.h>
19 #include <linux/init.h>
20 #include <linux/sched.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>
27 #include <linux/compiler.h>
28 #include <linux/err.h>
29 #include <linux/kernel.h>
31 #include <linux/net.h>
32 #include <linux/kthread.h>
34 #include <asm/uaccess.h>
35 #include <asm/system.h>
36 #include <asm/types.h>
38 #include <linux/nbd.h>
40 #define LO_MAGIC 0x68797548
43 #define dprintk(flags, fmt...)
45 #define dprintk(flags, fmt...) do { \
46 if (debugflags & (flags)) printk(KERN_DEBUG fmt); \
48 #define DBG_IOCTL 0x0004
49 #define DBG_INIT 0x0010
50 #define DBG_EXIT 0x0020
51 #define DBG_BLKDEV 0x0100
54 static unsigned int debugflags
;
57 static unsigned int nbds_max
= 16;
58 static struct nbd_device
*nbd_dev
;
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
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
69 * Thanks go to Jens Axboe and Al Viro for their LKML emails explaining this!
71 static DEFINE_SPINLOCK(nbd_lock
);
74 static const char *ioctl_cmd_to_ascii(int 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";
92 static const char *nbdcmd_to_ascii(int cmd
)
95 case NBD_CMD_READ
: return "read";
96 case NBD_CMD_WRITE
: return "write";
97 case NBD_CMD_DISC
: return "disconnect";
103 static void nbd_end_request(struct request
*req
)
105 int error
= req
->errors
? -EIO
: 0;
106 struct request_queue
*q
= req
->q
;
109 dprintk(DBG_BLKDEV
, "%s: request %p: %s\n", req
->rq_disk
->disk_name
,
110 req
, error
? "failed" : "done");
112 spin_lock_irqsave(q
->queue_lock
, flags
);
113 __blk_end_request(req
, error
, req
->nr_sectors
<< 9);
114 spin_unlock_irqrestore(q
->queue_lock
, flags
);
117 static void sock_shutdown(struct nbd_device
*lo
, int lock
)
119 /* Forcibly shutdown the socket causing all listeners
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 */
126 mutex_lock(&lo
->tx_lock
);
128 printk(KERN_WARNING
"%s: shutting down socket\n",
129 lo
->disk
->disk_name
);
130 kernel_sock_shutdown(lo
->sock
, SHUT_RDWR
);
134 mutex_unlock(&lo
->tx_lock
);
137 static void nbd_xmit_timeout(unsigned long arg
)
139 struct task_struct
*task
= (struct task_struct
*)arg
;
141 printk(KERN_WARNING
"nbd: killing hung xmit (%s, pid: %d)\n",
142 task
->comm
, task
->pid
);
143 force_sig(SIGKILL
, task
);
147 * Send or receive packet.
149 static int sock_xmit(struct nbd_device
*lo
, int send
, void *buf
, int size
,
152 struct socket
*sock
= lo
->sock
;
156 sigset_t blocked
, oldset
;
158 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"));
164 /* Allow interception of SIGKILL only
165 * Don't allow other signals to interrupt the transmission */
166 siginitsetinv(&blocked
, sigmask(SIGKILL
));
167 sigprocmask(SIG_SETMASK
, &blocked
, &oldset
);
170 sock
->sk
->sk_allocation
= GFP_NOIO
;
175 msg
.msg_control
= NULL
;
176 msg
.msg_controllen
= 0;
177 msg
.msg_flags
= msg_flags
| MSG_NOSIGNAL
;
180 struct timer_list ti
;
182 if (lo
->xmit_timeout
) {
184 ti
.function
= nbd_xmit_timeout
;
185 ti
.data
= (unsigned long)current
;
186 ti
.expires
= jiffies
+ lo
->xmit_timeout
;
189 result
= kernel_sendmsg(sock
, &msg
, &iov
, 1, size
);
190 if (lo
->xmit_timeout
)
193 result
= kernel_recvmsg(sock
, &msg
, &iov
, 1, size
, 0);
195 if (signal_pending(current
)) {
197 printk(KERN_WARNING
"nbd (pid %d: %s) got signal %d\n",
198 task_pid_nr(current
), current
->comm
,
199 dequeue_signal_lock(current
, ¤t
->blocked
, &info
));
201 sock_shutdown(lo
, !send
);
207 result
= -EPIPE
; /* short read */
214 sigprocmask(SIG_SETMASK
, &oldset
, NULL
);
219 static inline int sock_send_bvec(struct nbd_device
*lo
, struct bio_vec
*bvec
,
223 void *kaddr
= kmap(bvec
->bv_page
);
224 result
= sock_xmit(lo
, 1, kaddr
+ bvec
->bv_offset
, bvec
->bv_len
, flags
);
225 kunmap(bvec
->bv_page
);
229 /* always call with the tx_lock held */
230 static int nbd_send_req(struct nbd_device
*lo
, struct request
*req
)
233 struct nbd_request request
;
234 unsigned long size
= req
->nr_sectors
<< 9;
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
));
242 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);
247 result
= sock_xmit(lo
, 1, &request
, sizeof(request
),
248 (nbd_cmd(req
) == NBD_CMD_WRITE
) ? MSG_MORE
: 0);
250 printk(KERN_ERR
"%s: Send control failed (result %d)\n",
251 lo
->disk
->disk_name
, result
);
255 if (nbd_cmd(req
) == NBD_CMD_WRITE
) {
256 struct req_iterator iter
;
257 struct bio_vec
*bvec
;
259 * we are really probing at internals to determine
260 * whether to set MSG_MORE or not...
262 rq_for_each_segment(bvec
, req
, iter
) {
264 if (!rq_iter_last(req
, iter
))
266 dprintk(DBG_TX
, "%s: request %p: sending %d bytes data\n",
267 lo
->disk
->disk_name
, req
, bvec
->bv_len
);
268 result
= sock_send_bvec(lo
, bvec
, flags
);
270 printk(KERN_ERR
"%s: Send data failed (result %d)\n",
271 lo
->disk
->disk_name
, result
);
282 static struct request
*nbd_find_request(struct nbd_device
*lo
,
283 struct request
*xreq
)
285 struct request
*req
, *tmp
;
288 err
= wait_event_interruptible(lo
->active_wq
, lo
->active_req
!= xreq
);
292 spin_lock(&lo
->queue_lock
);
293 list_for_each_entry_safe(req
, tmp
, &lo
->queue_head
, queuelist
) {
296 list_del_init(&req
->queuelist
);
297 spin_unlock(&lo
->queue_lock
);
300 spin_unlock(&lo
->queue_lock
);
308 static inline int sock_recv_bvec(struct nbd_device
*lo
, struct bio_vec
*bvec
)
311 void *kaddr
= kmap(bvec
->bv_page
);
312 result
= sock_xmit(lo
, 0, kaddr
+ bvec
->bv_offset
, bvec
->bv_len
,
314 kunmap(bvec
->bv_page
);
318 /* NULL returned = something went wrong, inform userspace */
319 static struct request
*nbd_read_stat(struct nbd_device
*lo
)
322 struct nbd_reply reply
;
326 result
= sock_xmit(lo
, 0, &reply
, sizeof(reply
), MSG_WAITALL
);
328 printk(KERN_ERR
"%s: Receive control failed (result %d)\n",
329 lo
->disk
->disk_name
, result
);
333 if (ntohl(reply
.magic
) != NBD_REPLY_MAGIC
) {
334 printk(KERN_ERR
"%s: Wrong magic (0x%lx)\n",
336 (unsigned long)ntohl(reply
.magic
));
341 req
= nbd_find_request(lo
, *(struct request
**)reply
.handle
);
343 result
= PTR_ERR(req
);
344 if (result
!= -ENOENT
)
347 printk(KERN_ERR
"%s: Unexpected reply (%p)\n",
348 lo
->disk
->disk_name
, reply
.handle
);
353 if (ntohl(reply
.error
)) {
354 printk(KERN_ERR
"%s: Other side returned error (%d)\n",
355 lo
->disk
->disk_name
, ntohl(reply
.error
));
360 dprintk(DBG_RX
, "%s: request %p: got reply\n",
361 lo
->disk
->disk_name
, req
);
362 if (nbd_cmd(req
) == NBD_CMD_READ
) {
363 struct req_iterator iter
;
364 struct bio_vec
*bvec
;
366 rq_for_each_segment(bvec
, req
, iter
) {
367 result
= sock_recv_bvec(lo
, bvec
);
369 printk(KERN_ERR
"%s: Receive data failed (result %d)\n",
370 lo
->disk
->disk_name
, result
);
374 dprintk(DBG_RX
, "%s: request %p: got %d bytes data\n",
375 lo
->disk
->disk_name
, req
, bvec
->bv_len
);
380 lo
->harderror
= result
;
384 static ssize_t
pid_show(struct device
*dev
,
385 struct device_attribute
*attr
, char *buf
)
387 struct gendisk
*disk
= dev_to_disk(dev
);
389 return sprintf(buf
, "%ld\n",
390 (long) ((struct nbd_device
*)disk
->private_data
)->pid
);
393 static struct device_attribute pid_attr
= {
394 .attr
= { .name
= "pid", .mode
= S_IRUGO
},
398 static int nbd_do_it(struct nbd_device
*lo
)
403 BUG_ON(lo
->magic
!= LO_MAGIC
);
405 lo
->pid
= current
->pid
;
406 ret
= sysfs_create_file(&disk_to_dev(lo
->disk
)->kobj
, &pid_attr
.attr
);
408 printk(KERN_ERR
"nbd: sysfs_create_file failed!");
413 while ((req
= nbd_read_stat(lo
)) != NULL
)
414 nbd_end_request(req
);
416 sysfs_remove_file(&disk_to_dev(lo
->disk
)->kobj
, &pid_attr
.attr
);
421 static void nbd_clear_que(struct nbd_device
*lo
)
425 BUG_ON(lo
->magic
!= LO_MAGIC
);
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.
432 * As a consequence, we don't need to take the spin lock while
433 * purging the list here.
436 BUG_ON(lo
->active_req
);
438 while (!list_empty(&lo
->queue_head
)) {
439 req
= list_entry(lo
->queue_head
.next
, struct request
,
441 list_del_init(&req
->queuelist
);
443 nbd_end_request(req
);
448 static void nbd_handle_req(struct nbd_device
*lo
, struct request
*req
)
450 if (!blk_fs_request(req
))
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
);
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
);
473 lo
->active_req
= req
;
475 if (nbd_send_req(lo
, req
) != 0) {
476 printk(KERN_ERR
"%s: Request send failed\n",
477 lo
->disk
->disk_name
);
479 nbd_end_request(req
);
481 spin_lock(&lo
->queue_lock
);
482 list_add(&req
->queuelist
, &lo
->queue_head
);
483 spin_unlock(&lo
->queue_lock
);
486 lo
->active_req
= NULL
;
487 mutex_unlock(&lo
->tx_lock
);
488 wake_up_all(&lo
->active_wq
);
494 nbd_end_request(req
);
497 static int nbd_thread(void *data
)
499 struct nbd_device
*lo
= data
;
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
));
509 /* extract request */
510 if (list_empty(&lo
->waiting_queue
))
513 spin_lock_irq(&lo
->queue_lock
);
514 req
= list_entry(lo
->waiting_queue
.next
, struct request
,
516 list_del_init(&req
->queuelist
);
517 spin_unlock_irq(&lo
->queue_lock
);
520 nbd_handle_req(lo
, req
);
526 * We always wait for result of write, for now. It would be nice to make it optional
528 * if ((rq_data_dir(req) == WRITE) && (lo->flags & NBD_WRITE_NOCHK))
529 * { printk( "Warning: Ignoring result!\n"); nbd_end_request( req ); }
532 static void do_nbd_request(struct request_queue
*q
)
536 while ((req
= elv_next_request(q
)) != NULL
) {
537 struct nbd_device
*lo
;
539 blkdev_dequeue_request(req
);
541 spin_unlock_irq(q
->queue_lock
);
543 dprintk(DBG_BLKDEV
, "%s: request %p: dequeued (flags=%x)\n",
544 req
->rq_disk
->disk_name
, req
, req
->cmd_type
);
546 lo
= req
->rq_disk
->private_data
;
548 BUG_ON(lo
->magic
!= LO_MAGIC
);
550 if (unlikely(!lo
->sock
)) {
551 printk(KERN_ERR
"%s: Attempted send on closed socket\n",
552 lo
->disk
->disk_name
);
554 nbd_end_request(req
);
555 spin_lock_irq(q
->queue_lock
);
559 spin_lock_irq(&lo
->queue_lock
);
560 list_add_tail(&req
->queuelist
, &lo
->waiting_queue
);
561 spin_unlock_irq(&lo
->queue_lock
);
563 wake_up(&lo
->waiting_wq
);
565 spin_lock_irq(q
->queue_lock
);
569 /* Must be called with tx_lock held */
571 static int __nbd_ioctl(struct block_device
*bdev
, struct nbd_device
*lo
,
572 unsigned int cmd
, unsigned long arg
)
575 case NBD_DISCONNECT
: {
578 printk(KERN_INFO
"%s: NBD_DISCONNECT\n", lo
->disk
->disk_name
);
580 blk_rq_init(NULL
, &sreq
);
581 sreq
.cmd_type
= REQ_TYPE_SPECIAL
;
582 nbd_cmd(&sreq
) = NBD_CMD_DISC
;
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.
592 nbd_send_req(lo
, &sreq
);
596 case NBD_CLEAR_SOCK
: {
603 BUG_ON(!list_empty(&lo
->queue_head
));
615 struct inode
*inode
= file
->f_path
.dentry
->d_inode
;
616 if (S_ISSOCK(inode
->i_mode
)) {
618 lo
->sock
= SOCKET_I(inode
);
620 bdev
->bd_invalidated
= 1;
629 case NBD_SET_BLKSIZE
:
631 lo
->bytesize
&= ~(lo
->blksize
-1);
632 bdev
->bd_inode
->i_size
= lo
->bytesize
;
633 set_blocksize(bdev
, lo
->blksize
);
634 set_capacity(lo
->disk
, lo
->bytesize
>> 9);
638 lo
->bytesize
= arg
& ~(lo
->blksize
-1);
639 bdev
->bd_inode
->i_size
= lo
->bytesize
;
640 set_blocksize(bdev
, lo
->blksize
);
641 set_capacity(lo
->disk
, lo
->bytesize
>> 9);
644 case NBD_SET_TIMEOUT
:
645 lo
->xmit_timeout
= arg
* HZ
;
648 case NBD_SET_SIZE_BLOCKS
:
649 lo
->bytesize
= ((u64
) arg
) * lo
->blksize
;
650 bdev
->bd_inode
->i_size
= lo
->bytesize
;
651 set_blocksize(bdev
, lo
->blksize
);
652 set_capacity(lo
->disk
, lo
->bytesize
>> 9);
656 struct task_struct
*thread
;
665 mutex_unlock(&lo
->tx_lock
);
667 thread
= kthread_create(nbd_thread
, lo
, lo
->disk
->disk_name
);
668 if (IS_ERR(thread
)) {
669 mutex_lock(&lo
->tx_lock
);
670 return PTR_ERR(thread
);
672 wake_up_process(thread
);
673 error
= nbd_do_it(lo
);
674 kthread_stop(thread
);
676 mutex_lock(&lo
->tx_lock
);
679 sock_shutdown(lo
, 0);
683 printk(KERN_WARNING
"%s: queue cleared\n", lo
->disk
->disk_name
);
687 bdev
->bd_inode
->i_size
= 0;
688 set_capacity(lo
->disk
, 0);
690 ioctl_by_bdev(bdev
, BLKRRPART
, 0);
691 return lo
->harderror
;
696 * This is for compatibility only. The queue is always cleared
697 * by NBD_DO_IT or NBD_CLEAR_SOCK.
699 BUG_ON(!lo
->sock
&& !list_empty(&lo
->queue_head
));
702 case NBD_PRINT_DEBUG
:
703 printk(KERN_INFO
"%s: next = %p, prev = %p, head = %p\n",
704 bdev
->bd_disk
->disk_name
,
705 lo
->queue_head
.next
, lo
->queue_head
.prev
,
712 static int nbd_ioctl(struct block_device
*bdev
, fmode_t mode
,
713 unsigned int cmd
, unsigned long arg
)
715 struct nbd_device
*lo
= bdev
->bd_disk
->private_data
;
718 if (!capable(CAP_SYS_ADMIN
))
721 BUG_ON(lo
->magic
!= LO_MAGIC
);
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
);
727 mutex_lock(&lo
->tx_lock
);
728 error
= __nbd_ioctl(bdev
, lo
, cmd
, arg
);
729 mutex_unlock(&lo
->tx_lock
);
734 static struct block_device_operations nbd_fops
=
736 .owner
= THIS_MODULE
,
737 .locked_ioctl
= nbd_ioctl
,
741 * And here should be modules and kernel interface
742 * (Just smiley confuses emacs :-)
745 static int __init
nbd_init(void)
751 BUILD_BUG_ON(sizeof(struct nbd_request
) != 28);
754 printk(KERN_CRIT
"nbd: max_part must be >= 0\n");
758 nbd_dev
= kcalloc(nbds_max
, sizeof(*nbd_dev
), GFP_KERNEL
);
764 part_shift
= fls(max_part
);
766 for (i
= 0; i
< nbds_max
; i
++) {
767 struct gendisk
*disk
= alloc_disk(1 << part_shift
);
770 nbd_dev
[i
].disk
= disk
;
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.
776 disk
->queue
= blk_init_queue(do_nbd_request
, &nbd_lock
);
782 * Tell the block layer that we are not a rotational device
784 queue_flag_set_unlocked(QUEUE_FLAG_NONROT
, disk
->queue
);
787 if (register_blkdev(NBD_MAJOR
, "nbd")) {
792 printk(KERN_INFO
"nbd: registered device at major %d\n", NBD_MAJOR
);
793 dprintk(DBG_INIT
, "nbd: debugflags=0x%x\n", debugflags
);
795 for (i
= 0; i
< nbds_max
; i
++) {
796 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;
800 INIT_LIST_HEAD(&nbd_dev
[i
].waiting_queue
);
801 spin_lock_init(&nbd_dev
[i
].queue_lock
);
802 INIT_LIST_HEAD(&nbd_dev
[i
].queue_head
);
803 mutex_init(&nbd_dev
[i
].tx_lock
);
804 init_waitqueue_head(&nbd_dev
[i
].active_wq
);
805 init_waitqueue_head(&nbd_dev
[i
].waiting_wq
);
806 nbd_dev
[i
].blksize
= 1024;
807 nbd_dev
[i
].bytesize
= 0;
808 disk
->major
= NBD_MAJOR
;
809 disk
->first_minor
= i
<< part_shift
;
810 disk
->fops
= &nbd_fops
;
811 disk
->private_data
= &nbd_dev
[i
];
812 sprintf(disk
->disk_name
, "nbd%d", i
);
813 set_capacity(disk
, 0);
820 blk_cleanup_queue(nbd_dev
[i
].disk
->queue
);
821 put_disk(nbd_dev
[i
].disk
);
827 static void __exit
nbd_cleanup(void)
830 for (i
= 0; i
< nbds_max
; i
++) {
831 struct gendisk
*disk
= nbd_dev
[i
].disk
;
832 nbd_dev
[i
].magic
= 0;
835 blk_cleanup_queue(disk
->queue
);
839 unregister_blkdev(NBD_MAJOR
, "nbd");
841 printk(KERN_INFO
"nbd: unregistered device at major %d\n", NBD_MAJOR
);
844 module_init(nbd_init
);
845 module_exit(nbd_cleanup
);
847 MODULE_DESCRIPTION("Network Block Device");
848 MODULE_LICENSE("GPL");
850 module_param(nbds_max
, int, 0444);
851 MODULE_PARM_DESC(nbds_max
, "number of network block devices to initialize (default: 16)");
852 module_param(max_part
, int, 0444);
853 MODULE_PARM_DESC(max_part
, "number of partitions per device (default: 0)");
855 module_param(debugflags
, int, 0644);
856 MODULE_PARM_DESC(debugflags
, "flags for controlling debug output");