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@ucw.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/mutex.h>
28 #include <linux/compiler.h>
29 #include <linux/err.h>
30 #include <linux/kernel.h>
31 #include <linux/slab.h>
33 #include <linux/net.h>
34 #include <linux/kthread.h>
36 #include <asm/uaccess.h>
37 #include <asm/system.h>
38 #include <asm/types.h>
40 #include <linux/nbd.h>
42 #define LO_MAGIC 0x68797548
45 #define dprintk(flags, fmt...)
47 #define dprintk(flags, fmt...) do { \
48 if (debugflags & (flags)) printk(KERN_DEBUG fmt); \
50 #define DBG_IOCTL 0x0004
51 #define DBG_INIT 0x0010
52 #define DBG_EXIT 0x0020
53 #define DBG_BLKDEV 0x0100
56 static unsigned int debugflags
;
59 static unsigned int nbds_max
= 16;
60 static struct nbd_device
*nbd_dev
;
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
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
71 * Thanks go to Jens Axboe and Al Viro for their LKML emails explaining this!
73 static DEFINE_SPINLOCK(nbd_lock
);
76 static const char *ioctl_cmd_to_ascii(int 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";
94 static const char *nbdcmd_to_ascii(int cmd
)
97 case NBD_CMD_READ
: return "read";
98 case NBD_CMD_WRITE
: return "write";
99 case NBD_CMD_DISC
: return "disconnect";
105 static void nbd_end_request(struct request
*req
)
107 int error
= req
->errors
? -EIO
: 0;
108 struct request_queue
*q
= req
->q
;
111 dprintk(DBG_BLKDEV
, "%s: request %p: %s\n", req
->rq_disk
->disk_name
,
112 req
, error
? "failed" : "done");
114 spin_lock_irqsave(q
->queue_lock
, flags
);
115 __blk_end_request_all(req
, error
);
116 spin_unlock_irqrestore(q
->queue_lock
, flags
);
119 static void sock_shutdown(struct nbd_device
*lo
, int lock
)
121 /* Forcibly shutdown the socket causing all listeners
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 */
128 mutex_lock(&lo
->tx_lock
);
130 printk(KERN_WARNING
"%s: shutting down socket\n",
131 lo
->disk
->disk_name
);
132 kernel_sock_shutdown(lo
->sock
, SHUT_RDWR
);
136 mutex_unlock(&lo
->tx_lock
);
139 static void nbd_xmit_timeout(unsigned long arg
)
141 struct task_struct
*task
= (struct task_struct
*)arg
;
143 printk(KERN_WARNING
"nbd: killing hung xmit (%s, pid: %d)\n",
144 task
->comm
, task
->pid
);
145 force_sig(SIGKILL
, task
);
149 * Send or receive packet.
151 static int sock_xmit(struct nbd_device
*lo
, int send
, void *buf
, int size
,
154 struct socket
*sock
= lo
->sock
;
158 sigset_t blocked
, oldset
;
160 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"));
166 /* Allow interception of SIGKILL only
167 * Don't allow other signals to interrupt the transmission */
168 siginitsetinv(&blocked
, sigmask(SIGKILL
));
169 sigprocmask(SIG_SETMASK
, &blocked
, &oldset
);
172 sock
->sk
->sk_allocation
= GFP_NOIO
;
177 msg
.msg_control
= NULL
;
178 msg
.msg_controllen
= 0;
179 msg
.msg_flags
= msg_flags
| MSG_NOSIGNAL
;
182 struct timer_list ti
;
184 if (lo
->xmit_timeout
) {
186 ti
.function
= nbd_xmit_timeout
;
187 ti
.data
= (unsigned long)current
;
188 ti
.expires
= jiffies
+ lo
->xmit_timeout
;
191 result
= kernel_sendmsg(sock
, &msg
, &iov
, 1, size
);
192 if (lo
->xmit_timeout
)
195 result
= kernel_recvmsg(sock
, &msg
, &iov
, 1, size
,
198 if (signal_pending(current
)) {
200 printk(KERN_WARNING
"nbd (pid %d: %s) got signal %d\n",
201 task_pid_nr(current
), current
->comm
,
202 dequeue_signal_lock(current
, ¤t
->blocked
, &info
));
204 sock_shutdown(lo
, !send
);
210 result
= -EPIPE
; /* short read */
217 sigprocmask(SIG_SETMASK
, &oldset
, NULL
);
222 static inline int sock_send_bvec(struct nbd_device
*lo
, struct bio_vec
*bvec
,
226 void *kaddr
= kmap(bvec
->bv_page
);
227 result
= sock_xmit(lo
, 1, kaddr
+ bvec
->bv_offset
, bvec
->bv_len
, flags
);
228 kunmap(bvec
->bv_page
);
232 /* always call with the tx_lock held */
233 static int nbd_send_req(struct nbd_device
*lo
, struct request
*req
)
236 struct nbd_request request
;
237 unsigned long size
= blk_rq_bytes(req
);
239 request
.magic
= htonl(NBD_REQUEST_MAGIC
);
240 request
.type
= htonl(nbd_cmd(req
));
241 request
.from
= cpu_to_be64((u64
)blk_rq_pos(req
) << 9);
242 request
.len
= htonl(size
);
243 memcpy(request
.handle
, &req
, sizeof(req
));
245 dprintk(DBG_TX
, "%s: request %p: sending control (%s@%llu,%uB)\n",
246 lo
->disk
->disk_name
, req
,
247 nbdcmd_to_ascii(nbd_cmd(req
)),
248 (unsigned long long)blk_rq_pos(req
) << 9,
250 result
= sock_xmit(lo
, 1, &request
, sizeof(request
),
251 (nbd_cmd(req
) == NBD_CMD_WRITE
) ? MSG_MORE
: 0);
253 printk(KERN_ERR
"%s: Send control failed (result %d)\n",
254 lo
->disk
->disk_name
, result
);
258 if (nbd_cmd(req
) == NBD_CMD_WRITE
) {
259 struct req_iterator iter
;
260 struct bio_vec
*bvec
;
262 * we are really probing at internals to determine
263 * whether to set MSG_MORE or not...
265 rq_for_each_segment(bvec
, req
, iter
) {
267 if (!rq_iter_last(req
, iter
))
269 dprintk(DBG_TX
, "%s: request %p: sending %d bytes data\n",
270 lo
->disk
->disk_name
, req
, bvec
->bv_len
);
271 result
= sock_send_bvec(lo
, bvec
, flags
);
273 printk(KERN_ERR
"%s: Send data failed (result %d)\n",
274 lo
->disk
->disk_name
, result
);
285 static struct request
*nbd_find_request(struct nbd_device
*lo
,
286 struct request
*xreq
)
288 struct request
*req
, *tmp
;
291 err
= wait_event_interruptible(lo
->active_wq
, lo
->active_req
!= xreq
);
295 spin_lock(&lo
->queue_lock
);
296 list_for_each_entry_safe(req
, tmp
, &lo
->queue_head
, queuelist
) {
299 list_del_init(&req
->queuelist
);
300 spin_unlock(&lo
->queue_lock
);
303 spin_unlock(&lo
->queue_lock
);
311 static inline int sock_recv_bvec(struct nbd_device
*lo
, struct bio_vec
*bvec
)
314 void *kaddr
= kmap(bvec
->bv_page
);
315 result
= sock_xmit(lo
, 0, kaddr
+ bvec
->bv_offset
, bvec
->bv_len
,
317 kunmap(bvec
->bv_page
);
321 /* NULL returned = something went wrong, inform userspace */
322 static struct request
*nbd_read_stat(struct nbd_device
*lo
)
325 struct nbd_reply reply
;
329 result
= sock_xmit(lo
, 0, &reply
, sizeof(reply
), MSG_WAITALL
);
331 printk(KERN_ERR
"%s: Receive control failed (result %d)\n",
332 lo
->disk
->disk_name
, result
);
336 if (ntohl(reply
.magic
) != NBD_REPLY_MAGIC
) {
337 printk(KERN_ERR
"%s: Wrong magic (0x%lx)\n",
339 (unsigned long)ntohl(reply
.magic
));
344 req
= nbd_find_request(lo
, *(struct request
**)reply
.handle
);
346 result
= PTR_ERR(req
);
347 if (result
!= -ENOENT
)
350 printk(KERN_ERR
"%s: Unexpected reply (%p)\n",
351 lo
->disk
->disk_name
, reply
.handle
);
356 if (ntohl(reply
.error
)) {
357 printk(KERN_ERR
"%s: Other side returned error (%d)\n",
358 lo
->disk
->disk_name
, ntohl(reply
.error
));
363 dprintk(DBG_RX
, "%s: request %p: got reply\n",
364 lo
->disk
->disk_name
, req
);
365 if (nbd_cmd(req
) == NBD_CMD_READ
) {
366 struct req_iterator iter
;
367 struct bio_vec
*bvec
;
369 rq_for_each_segment(bvec
, req
, iter
) {
370 result
= sock_recv_bvec(lo
, bvec
);
372 printk(KERN_ERR
"%s: Receive data failed (result %d)\n",
373 lo
->disk
->disk_name
, result
);
377 dprintk(DBG_RX
, "%s: request %p: got %d bytes data\n",
378 lo
->disk
->disk_name
, req
, bvec
->bv_len
);
383 lo
->harderror
= result
;
387 static ssize_t
pid_show(struct device
*dev
,
388 struct device_attribute
*attr
, char *buf
)
390 struct gendisk
*disk
= dev_to_disk(dev
);
392 return sprintf(buf
, "%ld\n",
393 (long) ((struct nbd_device
*)disk
->private_data
)->pid
);
396 static struct device_attribute pid_attr
= {
397 .attr
= { .name
= "pid", .mode
= S_IRUGO
},
401 static int nbd_do_it(struct nbd_device
*lo
)
406 BUG_ON(lo
->magic
!= LO_MAGIC
);
408 lo
->pid
= current
->pid
;
409 ret
= sysfs_create_file(&disk_to_dev(lo
->disk
)->kobj
, &pid_attr
.attr
);
411 printk(KERN_ERR
"nbd: sysfs_create_file failed!");
416 while ((req
= nbd_read_stat(lo
)) != NULL
)
417 nbd_end_request(req
);
419 sysfs_remove_file(&disk_to_dev(lo
->disk
)->kobj
, &pid_attr
.attr
);
424 static void nbd_clear_que(struct nbd_device
*lo
)
428 BUG_ON(lo
->magic
!= LO_MAGIC
);
431 * Because we have set lo->sock to NULL under the tx_lock, all
432 * modifications to the list must have completed by now. For
433 * the same reason, the active_req must be NULL.
435 * As a consequence, we don't need to take the spin lock while
436 * purging the list here.
439 BUG_ON(lo
->active_req
);
441 while (!list_empty(&lo
->queue_head
)) {
442 req
= list_entry(lo
->queue_head
.next
, struct request
,
444 list_del_init(&req
->queuelist
);
446 nbd_end_request(req
);
451 static void nbd_handle_req(struct nbd_device
*lo
, struct request
*req
)
453 if (req
->cmd_type
!= REQ_TYPE_FS
)
456 nbd_cmd(req
) = NBD_CMD_READ
;
457 if (rq_data_dir(req
) == WRITE
) {
458 nbd_cmd(req
) = NBD_CMD_WRITE
;
459 if (lo
->flags
& NBD_READ_ONLY
) {
460 printk(KERN_ERR
"%s: Write on read-only\n",
461 lo
->disk
->disk_name
);
468 mutex_lock(&lo
->tx_lock
);
469 if (unlikely(!lo
->sock
)) {
470 mutex_unlock(&lo
->tx_lock
);
471 printk(KERN_ERR
"%s: Attempted send on closed socket\n",
472 lo
->disk
->disk_name
);
476 lo
->active_req
= req
;
478 if (nbd_send_req(lo
, req
) != 0) {
479 printk(KERN_ERR
"%s: Request send failed\n",
480 lo
->disk
->disk_name
);
482 nbd_end_request(req
);
484 spin_lock(&lo
->queue_lock
);
485 list_add(&req
->queuelist
, &lo
->queue_head
);
486 spin_unlock(&lo
->queue_lock
);
489 lo
->active_req
= NULL
;
490 mutex_unlock(&lo
->tx_lock
);
491 wake_up_all(&lo
->active_wq
);
497 nbd_end_request(req
);
500 static int nbd_thread(void *data
)
502 struct nbd_device
*lo
= data
;
505 set_user_nice(current
, -20);
506 while (!kthread_should_stop() || !list_empty(&lo
->waiting_queue
)) {
507 /* wait for something to do */
508 wait_event_interruptible(lo
->waiting_wq
,
509 kthread_should_stop() ||
510 !list_empty(&lo
->waiting_queue
));
512 /* extract request */
513 if (list_empty(&lo
->waiting_queue
))
516 spin_lock_irq(&lo
->queue_lock
);
517 req
= list_entry(lo
->waiting_queue
.next
, struct request
,
519 list_del_init(&req
->queuelist
);
520 spin_unlock_irq(&lo
->queue_lock
);
523 nbd_handle_req(lo
, req
);
529 * We always wait for result of write, for now. It would be nice to make it optional
531 * if ((rq_data_dir(req) == WRITE) && (lo->flags & NBD_WRITE_NOCHK))
532 * { printk( "Warning: Ignoring result!\n"); nbd_end_request( req ); }
535 static void do_nbd_request(struct request_queue
*q
)
539 while ((req
= blk_fetch_request(q
)) != NULL
) {
540 struct nbd_device
*lo
;
542 spin_unlock_irq(q
->queue_lock
);
544 dprintk(DBG_BLKDEV
, "%s: request %p: dequeued (flags=%x)\n",
545 req
->rq_disk
->disk_name
, req
, req
->cmd_type
);
547 lo
= req
->rq_disk
->private_data
;
549 BUG_ON(lo
->magic
!= LO_MAGIC
);
551 if (unlikely(!lo
->sock
)) {
552 printk(KERN_ERR
"%s: Attempted send on closed socket\n",
553 lo
->disk
->disk_name
);
555 nbd_end_request(req
);
556 spin_lock_irq(q
->queue_lock
);
560 spin_lock_irq(&lo
->queue_lock
);
561 list_add_tail(&req
->queuelist
, &lo
->waiting_queue
);
562 spin_unlock_irq(&lo
->queue_lock
);
564 wake_up(&lo
->waiting_wq
);
566 spin_lock_irq(q
->queue_lock
);
570 /* Must be called with tx_lock held */
572 static int __nbd_ioctl(struct block_device
*bdev
, struct nbd_device
*lo
,
573 unsigned int cmd
, unsigned long arg
)
576 case NBD_DISCONNECT
: {
579 printk(KERN_INFO
"%s: NBD_DISCONNECT\n", lo
->disk
->disk_name
);
581 blk_rq_init(NULL
, &sreq
);
582 sreq
.cmd_type
= REQ_TYPE_SPECIAL
;
583 nbd_cmd(&sreq
) = NBD_CMD_DISC
;
586 nbd_send_req(lo
, &sreq
);
590 case NBD_CLEAR_SOCK
: {
597 BUG_ON(!list_empty(&lo
->queue_head
));
609 struct inode
*inode
= file
->f_path
.dentry
->d_inode
;
610 if (S_ISSOCK(inode
->i_mode
)) {
612 lo
->sock
= SOCKET_I(inode
);
614 bdev
->bd_invalidated
= 1;
623 case NBD_SET_BLKSIZE
:
625 lo
->bytesize
&= ~(lo
->blksize
-1);
626 bdev
->bd_inode
->i_size
= lo
->bytesize
;
627 set_blocksize(bdev
, lo
->blksize
);
628 set_capacity(lo
->disk
, lo
->bytesize
>> 9);
632 lo
->bytesize
= arg
& ~(lo
->blksize
-1);
633 bdev
->bd_inode
->i_size
= lo
->bytesize
;
634 set_blocksize(bdev
, lo
->blksize
);
635 set_capacity(lo
->disk
, lo
->bytesize
>> 9);
638 case NBD_SET_TIMEOUT
:
639 lo
->xmit_timeout
= arg
* HZ
;
642 case NBD_SET_SIZE_BLOCKS
:
643 lo
->bytesize
= ((u64
) arg
) * lo
->blksize
;
644 bdev
->bd_inode
->i_size
= lo
->bytesize
;
645 set_blocksize(bdev
, lo
->blksize
);
646 set_capacity(lo
->disk
, lo
->bytesize
>> 9);
650 struct task_struct
*thread
;
659 mutex_unlock(&lo
->tx_lock
);
661 thread
= kthread_create(nbd_thread
, lo
, lo
->disk
->disk_name
);
662 if (IS_ERR(thread
)) {
663 mutex_lock(&lo
->tx_lock
);
664 return PTR_ERR(thread
);
666 wake_up_process(thread
);
667 error
= nbd_do_it(lo
);
668 kthread_stop(thread
);
670 mutex_lock(&lo
->tx_lock
);
673 sock_shutdown(lo
, 0);
677 printk(KERN_WARNING
"%s: queue cleared\n", lo
->disk
->disk_name
);
681 bdev
->bd_inode
->i_size
= 0;
682 set_capacity(lo
->disk
, 0);
684 ioctl_by_bdev(bdev
, BLKRRPART
, 0);
685 return lo
->harderror
;
690 * This is for compatibility only. The queue is always cleared
691 * by NBD_DO_IT or NBD_CLEAR_SOCK.
693 BUG_ON(!lo
->sock
&& !list_empty(&lo
->queue_head
));
696 case NBD_PRINT_DEBUG
:
697 printk(KERN_INFO
"%s: next = %p, prev = %p, head = %p\n",
698 bdev
->bd_disk
->disk_name
,
699 lo
->queue_head
.next
, lo
->queue_head
.prev
,
706 static int nbd_ioctl(struct block_device
*bdev
, fmode_t mode
,
707 unsigned int cmd
, unsigned long arg
)
709 struct nbd_device
*lo
= bdev
->bd_disk
->private_data
;
712 if (!capable(CAP_SYS_ADMIN
))
715 BUG_ON(lo
->magic
!= LO_MAGIC
);
717 /* Anyone capable of this syscall can do *real bad* things */
718 dprintk(DBG_IOCTL
, "%s: nbd_ioctl cmd=%s(0x%x) arg=%lu\n",
719 lo
->disk
->disk_name
, ioctl_cmd_to_ascii(cmd
), cmd
, arg
);
721 mutex_lock(&lo
->tx_lock
);
722 error
= __nbd_ioctl(bdev
, lo
, cmd
, arg
);
723 mutex_unlock(&lo
->tx_lock
);
728 static const struct block_device_operations nbd_fops
=
730 .owner
= THIS_MODULE
,
735 * And here should be modules and kernel interface
736 * (Just smiley confuses emacs :-)
739 static int __init
nbd_init(void)
745 BUILD_BUG_ON(sizeof(struct nbd_request
) != 28);
748 printk(KERN_CRIT
"nbd: max_part must be >= 0\n");
752 nbd_dev
= kcalloc(nbds_max
, sizeof(*nbd_dev
), GFP_KERNEL
);
758 part_shift
= fls(max_part
);
761 * Adjust max_part according to part_shift as it is exported
762 * to user space so that user can know the max number of
763 * partition kernel should be able to manage.
765 * Note that -1 is required because partition 0 is reserved
766 * for the whole disk.
768 max_part
= (1UL << part_shift
) - 1;
771 if ((1UL << part_shift
) > DISK_MAX_PARTS
)
774 if (nbds_max
> 1UL << (MINORBITS
- part_shift
))
777 for (i
= 0; i
< nbds_max
; i
++) {
778 struct gendisk
*disk
= alloc_disk(1 << part_shift
);
781 nbd_dev
[i
].disk
= disk
;
783 * The new linux 2.5 block layer implementation requires
784 * every gendisk to have its very own request_queue struct.
785 * These structs are big so we dynamically allocate them.
787 disk
->queue
= blk_init_queue(do_nbd_request
, &nbd_lock
);
793 * Tell the block layer that we are not a rotational device
795 queue_flag_set_unlocked(QUEUE_FLAG_NONROT
, disk
->queue
);
798 if (register_blkdev(NBD_MAJOR
, "nbd")) {
803 printk(KERN_INFO
"nbd: registered device at major %d\n", NBD_MAJOR
);
804 dprintk(DBG_INIT
, "nbd: debugflags=0x%x\n", debugflags
);
806 for (i
= 0; i
< nbds_max
; i
++) {
807 struct gendisk
*disk
= nbd_dev
[i
].disk
;
808 nbd_dev
[i
].file
= NULL
;
809 nbd_dev
[i
].magic
= LO_MAGIC
;
810 nbd_dev
[i
].flags
= 0;
811 INIT_LIST_HEAD(&nbd_dev
[i
].waiting_queue
);
812 spin_lock_init(&nbd_dev
[i
].queue_lock
);
813 INIT_LIST_HEAD(&nbd_dev
[i
].queue_head
);
814 mutex_init(&nbd_dev
[i
].tx_lock
);
815 init_waitqueue_head(&nbd_dev
[i
].active_wq
);
816 init_waitqueue_head(&nbd_dev
[i
].waiting_wq
);
817 nbd_dev
[i
].blksize
= 1024;
818 nbd_dev
[i
].bytesize
= 0;
819 disk
->major
= NBD_MAJOR
;
820 disk
->first_minor
= i
<< part_shift
;
821 disk
->fops
= &nbd_fops
;
822 disk
->private_data
= &nbd_dev
[i
];
823 sprintf(disk
->disk_name
, "nbd%d", i
);
824 set_capacity(disk
, 0);
831 blk_cleanup_queue(nbd_dev
[i
].disk
->queue
);
832 put_disk(nbd_dev
[i
].disk
);
838 static void __exit
nbd_cleanup(void)
841 for (i
= 0; i
< nbds_max
; i
++) {
842 struct gendisk
*disk
= nbd_dev
[i
].disk
;
843 nbd_dev
[i
].magic
= 0;
846 blk_cleanup_queue(disk
->queue
);
850 unregister_blkdev(NBD_MAJOR
, "nbd");
852 printk(KERN_INFO
"nbd: unregistered device at major %d\n", NBD_MAJOR
);
855 module_init(nbd_init
);
856 module_exit(nbd_cleanup
);
858 MODULE_DESCRIPTION("Network Block Device");
859 MODULE_LICENSE("GPL");
861 module_param(nbds_max
, int, 0444);
862 MODULE_PARM_DESC(nbds_max
, "number of network block devices to initialize (default: 16)");
863 module_param(max_part
, int, 0444);
864 MODULE_PARM_DESC(max_part
, "number of partitions per device (default: 0)");
866 module_param(debugflags
, int, 0644);
867 MODULE_PARM_DESC(debugflags
, "flags for controlling debug output");