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/types.h>
39 #include <linux/nbd.h>
41 #define NBD_MAGIC 0x68797548
44 #define dprintk(flags, fmt...)
46 #define dprintk(flags, fmt...) do { \
47 if (debugflags & (flags)) printk(KERN_DEBUG fmt); \
49 #define DBG_IOCTL 0x0004
50 #define DBG_INIT 0x0010
51 #define DBG_EXIT 0x0020
52 #define DBG_BLKDEV 0x0100
55 static unsigned int debugflags;
58 static unsigned int nbds_max = 16;
59 static struct nbd_device *nbd_dev;
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
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
70 * Thanks go to Jens Axboe and Al Viro for their LKML emails explaining this!
72 static DEFINE_SPINLOCK(nbd_lock);
75 static const char *ioctl_cmd_to_ascii(int 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_SET_TIMEOUT: return "set-timeout";
82 case NBD_SET_FLAGS: return "set-flags";
83 case NBD_DO_IT: return "do-it";
84 case NBD_CLEAR_SOCK: return "clear-sock";
85 case NBD_CLEAR_QUE: return "clear-que";
86 case NBD_PRINT_DEBUG: return "print-debug";
87 case NBD_SET_SIZE_BLOCKS: return "set-size-blocks";
88 case NBD_DISCONNECT: return "disconnect";
89 case BLKROSET: return "set-read-only";
90 case BLKFLSBUF: return "flush-buffer-cache";
95 static const char *nbdcmd_to_ascii(int cmd)
98 case NBD_CMD_READ: return "read";
99 case NBD_CMD_WRITE: return "write";
100 case NBD_CMD_DISC: return "disconnect";
101 case NBD_CMD_TRIM: return "trim/discard";
107 static void nbd_end_request(struct request *req)
109 int error = req->errors ? -EIO : 0;
110 struct request_queue *q = req->q;
113 dprintk(DBG_BLKDEV, "%s: request %p: %s\n", req->rq_disk->disk_name,
114 req, error ? "failed" : "done");
116 spin_lock_irqsave(q->queue_lock, flags);
117 __blk_end_request_all(req, error);
118 spin_unlock_irqrestore(q->queue_lock, flags);
121 static void sock_shutdown(struct nbd_device *nbd, int lock)
123 /* Forcibly shutdown the socket causing all listeners
126 * FIXME: This code is duplicated from sys_shutdown, but
127 * there should be a more generic interface rather than
128 * calling socket ops directly here */
130 mutex_lock(&nbd->tx_lock);
132 dev_warn(disk_to_dev(nbd->disk), "shutting down socket\n");
133 kernel_sock_shutdown(nbd->sock, SHUT_RDWR);
137 mutex_unlock(&nbd->tx_lock);
140 static void nbd_xmit_timeout(unsigned long arg)
142 struct task_struct *task = (struct task_struct *)arg;
144 printk(KERN_WARNING "nbd: killing hung xmit (%s, pid: %d)\n",
145 task->comm, task->pid);
146 force_sig(SIGKILL, task);
150 * Send or receive packet.
152 static int sock_xmit(struct nbd_device *nbd, int send, void *buf, int size,
155 struct socket *sock = nbd->sock;
159 sigset_t blocked, oldset;
160 unsigned long pflags = current->flags;
162 if (unlikely(!sock)) {
163 dev_err(disk_to_dev(nbd->disk),
164 "Attempted %s on closed socket in sock_xmit\n",
165 (send ? "send" : "recv"));
169 /* Allow interception of SIGKILL only
170 * Don't allow other signals to interrupt the transmission */
171 siginitsetinv(&blocked, sigmask(SIGKILL));
172 sigprocmask(SIG_SETMASK, &blocked, &oldset);
174 current->flags |= PF_MEMALLOC;
176 sock->sk->sk_allocation = GFP_NOIO | __GFP_MEMALLOC;
181 msg.msg_control = NULL;
182 msg.msg_controllen = 0;
183 msg.msg_flags = msg_flags | MSG_NOSIGNAL;
186 struct timer_list ti;
188 if (nbd->xmit_timeout) {
190 ti.function = nbd_xmit_timeout;
191 ti.data = (unsigned long)current;
192 ti.expires = jiffies + nbd->xmit_timeout;
195 result = kernel_sendmsg(sock, &msg, &iov, 1, size);
196 if (nbd->xmit_timeout)
199 result = kernel_recvmsg(sock, &msg, &iov, 1, size,
202 if (signal_pending(current)) {
204 printk(KERN_WARNING "nbd (pid %d: %s) got signal %d\n",
205 task_pid_nr(current), current->comm,
206 dequeue_signal_lock(current, ¤t->blocked, &info));
208 sock_shutdown(nbd, !send);
214 result = -EPIPE; /* short read */
221 sigprocmask(SIG_SETMASK, &oldset, NULL);
222 tsk_restore_flags(current, pflags, PF_MEMALLOC);
227 static inline int sock_send_bvec(struct nbd_device *nbd, struct bio_vec *bvec,
231 void *kaddr = kmap(bvec->bv_page);
232 result = sock_xmit(nbd, 1, kaddr + bvec->bv_offset,
233 bvec->bv_len, flags);
234 kunmap(bvec->bv_page);
238 /* always call with the tx_lock held */
239 static int nbd_send_req(struct nbd_device *nbd, struct request *req)
242 struct nbd_request request;
243 unsigned long size = blk_rq_bytes(req);
245 request.magic = htonl(NBD_REQUEST_MAGIC);
246 request.type = htonl(nbd_cmd(req));
247 request.from = cpu_to_be64((u64)blk_rq_pos(req) << 9);
248 request.len = htonl(size);
249 memcpy(request.handle, &req, sizeof(req));
251 dprintk(DBG_TX, "%s: request %p: sending control (%s@%llu,%uB)\n",
252 nbd->disk->disk_name, req,
253 nbdcmd_to_ascii(nbd_cmd(req)),
254 (unsigned long long)blk_rq_pos(req) << 9,
256 result = sock_xmit(nbd, 1, &request, sizeof(request),
257 (nbd_cmd(req) == NBD_CMD_WRITE) ? MSG_MORE : 0);
259 dev_err(disk_to_dev(nbd->disk),
260 "Send control failed (result %d)\n", result);
264 if (nbd_cmd(req) == NBD_CMD_WRITE) {
265 struct req_iterator iter;
266 struct bio_vec *bvec;
268 * we are really probing at internals to determine
269 * whether to set MSG_MORE or not...
271 rq_for_each_segment(bvec, req, iter) {
273 if (!rq_iter_last(req, iter))
275 dprintk(DBG_TX, "%s: request %p: sending %d bytes data\n",
276 nbd->disk->disk_name, req, bvec->bv_len);
277 result = sock_send_bvec(nbd, bvec, flags);
279 dev_err(disk_to_dev(nbd->disk),
280 "Send data failed (result %d)\n",
292 static struct request *nbd_find_request(struct nbd_device *nbd,
293 struct request *xreq)
295 struct request *req, *tmp;
298 err = wait_event_interruptible(nbd->active_wq, nbd->active_req != xreq);
302 spin_lock(&nbd->queue_lock);
303 list_for_each_entry_safe(req, tmp, &nbd->queue_head, queuelist) {
306 list_del_init(&req->queuelist);
307 spin_unlock(&nbd->queue_lock);
310 spin_unlock(&nbd->queue_lock);
318 static inline int sock_recv_bvec(struct nbd_device *nbd, struct bio_vec *bvec)
321 void *kaddr = kmap(bvec->bv_page);
322 result = sock_xmit(nbd, 0, kaddr + bvec->bv_offset, bvec->bv_len,
324 kunmap(bvec->bv_page);
328 /* NULL returned = something went wrong, inform userspace */
329 static struct request *nbd_read_stat(struct nbd_device *nbd)
332 struct nbd_reply reply;
336 result = sock_xmit(nbd, 0, &reply, sizeof(reply), MSG_WAITALL);
338 dev_err(disk_to_dev(nbd->disk),
339 "Receive control failed (result %d)\n", result);
343 if (ntohl(reply.magic) != NBD_REPLY_MAGIC) {
344 dev_err(disk_to_dev(nbd->disk), "Wrong magic (0x%lx)\n",
345 (unsigned long)ntohl(reply.magic));
350 req = nbd_find_request(nbd, *(struct request **)reply.handle);
352 result = PTR_ERR(req);
353 if (result != -ENOENT)
356 dev_err(disk_to_dev(nbd->disk), "Unexpected reply (%p)\n",
362 if (ntohl(reply.error)) {
363 dev_err(disk_to_dev(nbd->disk), "Other side returned error (%d)\n",
369 dprintk(DBG_RX, "%s: request %p: got reply\n",
370 nbd->disk->disk_name, req);
371 if (nbd_cmd(req) == NBD_CMD_READ) {
372 struct req_iterator iter;
373 struct bio_vec *bvec;
375 rq_for_each_segment(bvec, req, iter) {
376 result = sock_recv_bvec(nbd, bvec);
378 dev_err(disk_to_dev(nbd->disk), "Receive data failed (result %d)\n",
383 dprintk(DBG_RX, "%s: request %p: got %d bytes data\n",
384 nbd->disk->disk_name, req, bvec->bv_len);
389 nbd->harderror = result;
393 static ssize_t pid_show(struct device *dev,
394 struct device_attribute *attr, char *buf)
396 struct gendisk *disk = dev_to_disk(dev);
398 return sprintf(buf, "%ld\n",
399 (long) ((struct nbd_device *)disk->private_data)->pid);
402 static struct device_attribute pid_attr = {
403 .attr = { .name = "pid", .mode = S_IRUGO},
407 static int nbd_do_it(struct nbd_device *nbd)
412 BUG_ON(nbd->magic != NBD_MAGIC);
414 sk_set_memalloc(nbd->sock->sk);
415 nbd->pid = task_pid_nr(current);
416 ret = device_create_file(disk_to_dev(nbd->disk), &pid_attr);
418 dev_err(disk_to_dev(nbd->disk), "device_create_file failed!\n");
423 while ((req = nbd_read_stat(nbd)) != NULL)
424 nbd_end_request(req);
426 device_remove_file(disk_to_dev(nbd->disk), &pid_attr);
431 static void nbd_clear_que(struct nbd_device *nbd)
435 BUG_ON(nbd->magic != NBD_MAGIC);
438 * Because we have set nbd->sock to NULL under the tx_lock, all
439 * modifications to the list must have completed by now. For
440 * the same reason, the active_req must be NULL.
442 * As a consequence, we don't need to take the spin lock while
443 * purging the list here.
446 BUG_ON(nbd->active_req);
448 while (!list_empty(&nbd->queue_head)) {
449 req = list_entry(nbd->queue_head.next, struct request,
451 list_del_init(&req->queuelist);
453 nbd_end_request(req);
456 while (!list_empty(&nbd->waiting_queue)) {
457 req = list_entry(nbd->waiting_queue.next, struct request,
459 list_del_init(&req->queuelist);
461 nbd_end_request(req);
466 static void nbd_handle_req(struct nbd_device *nbd, struct request *req)
468 if (req->cmd_type != REQ_TYPE_FS)
471 nbd_cmd(req) = NBD_CMD_READ;
472 if (rq_data_dir(req) == WRITE) {
473 if ((req->cmd_flags & REQ_DISCARD)) {
474 WARN_ON(!(nbd->flags & NBD_FLAG_SEND_TRIM));
475 nbd_cmd(req) = NBD_CMD_TRIM;
477 nbd_cmd(req) = NBD_CMD_WRITE;
478 if (nbd->flags & NBD_FLAG_READ_ONLY) {
479 dev_err(disk_to_dev(nbd->disk),
480 "Write on read-only\n");
487 mutex_lock(&nbd->tx_lock);
488 if (unlikely(!nbd->sock)) {
489 mutex_unlock(&nbd->tx_lock);
490 dev_err(disk_to_dev(nbd->disk),
491 "Attempted send on closed socket\n");
495 nbd->active_req = req;
497 if (nbd_send_req(nbd, req) != 0) {
498 dev_err(disk_to_dev(nbd->disk), "Request send failed\n");
500 nbd_end_request(req);
502 spin_lock(&nbd->queue_lock);
503 list_add_tail(&req->queuelist, &nbd->queue_head);
504 spin_unlock(&nbd->queue_lock);
507 nbd->active_req = NULL;
508 mutex_unlock(&nbd->tx_lock);
509 wake_up_all(&nbd->active_wq);
515 nbd_end_request(req);
518 static int nbd_thread(void *data)
520 struct nbd_device *nbd = data;
523 set_user_nice(current, -20);
524 while (!kthread_should_stop() || !list_empty(&nbd->waiting_queue)) {
525 /* wait for something to do */
526 wait_event_interruptible(nbd->waiting_wq,
527 kthread_should_stop() ||
528 !list_empty(&nbd->waiting_queue));
530 /* extract request */
531 if (list_empty(&nbd->waiting_queue))
534 spin_lock_irq(&nbd->queue_lock);
535 req = list_entry(nbd->waiting_queue.next, struct request,
537 list_del_init(&req->queuelist);
538 spin_unlock_irq(&nbd->queue_lock);
541 nbd_handle_req(nbd, req);
547 * We always wait for result of write, for now. It would be nice to make it optional
549 * if ((rq_data_dir(req) == WRITE) && (nbd->flags & NBD_WRITE_NOCHK))
550 * { printk( "Warning: Ignoring result!\n"); nbd_end_request( req ); }
553 static void do_nbd_request(struct request_queue *q)
557 while ((req = blk_fetch_request(q)) != NULL) {
558 struct nbd_device *nbd;
560 spin_unlock_irq(q->queue_lock);
562 dprintk(DBG_BLKDEV, "%s: request %p: dequeued (flags=%x)\n",
563 req->rq_disk->disk_name, req, req->cmd_type);
565 nbd = req->rq_disk->private_data;
567 BUG_ON(nbd->magic != NBD_MAGIC);
569 if (unlikely(!nbd->sock)) {
570 dev_err(disk_to_dev(nbd->disk),
571 "Attempted send on closed socket\n");
573 nbd_end_request(req);
574 spin_lock_irq(q->queue_lock);
578 spin_lock_irq(&nbd->queue_lock);
579 list_add_tail(&req->queuelist, &nbd->waiting_queue);
580 spin_unlock_irq(&nbd->queue_lock);
582 wake_up(&nbd->waiting_wq);
584 spin_lock_irq(q->queue_lock);
588 /* Must be called with tx_lock held */
590 static int __nbd_ioctl(struct block_device *bdev, struct nbd_device *nbd,
591 unsigned int cmd, unsigned long arg)
594 case NBD_DISCONNECT: {
597 dev_info(disk_to_dev(nbd->disk), "NBD_DISCONNECT\n");
599 blk_rq_init(NULL, &sreq);
600 sreq.cmd_type = REQ_TYPE_SPECIAL;
601 nbd_cmd(&sreq) = NBD_CMD_DISC;
604 nbd_send_req(nbd, &sreq);
608 case NBD_CLEAR_SOCK: {
615 BUG_ON(!list_empty(&nbd->queue_head));
616 BUG_ON(!list_empty(&nbd->waiting_queue));
628 struct inode *inode = file->f_path.dentry->d_inode;
629 if (S_ISSOCK(inode->i_mode)) {
631 nbd->sock = SOCKET_I(inode);
633 bdev->bd_invalidated = 1;
642 case NBD_SET_BLKSIZE:
644 nbd->bytesize &= ~(nbd->blksize-1);
645 bdev->bd_inode->i_size = nbd->bytesize;
646 set_blocksize(bdev, nbd->blksize);
647 set_capacity(nbd->disk, nbd->bytesize >> 9);
651 nbd->bytesize = arg & ~(nbd->blksize-1);
652 bdev->bd_inode->i_size = nbd->bytesize;
653 set_blocksize(bdev, nbd->blksize);
654 set_capacity(nbd->disk, nbd->bytesize >> 9);
657 case NBD_SET_TIMEOUT:
658 nbd->xmit_timeout = arg * HZ;
665 case NBD_SET_SIZE_BLOCKS:
666 nbd->bytesize = ((u64) arg) * nbd->blksize;
667 bdev->bd_inode->i_size = nbd->bytesize;
668 set_blocksize(bdev, nbd->blksize);
669 set_capacity(nbd->disk, nbd->bytesize >> 9);
673 struct task_struct *thread;
682 mutex_unlock(&nbd->tx_lock);
684 if (nbd->flags & NBD_FLAG_SEND_TRIM)
685 queue_flag_set_unlocked(QUEUE_FLAG_DISCARD,
688 thread = kthread_create(nbd_thread, nbd, nbd->disk->disk_name);
689 if (IS_ERR(thread)) {
690 mutex_lock(&nbd->tx_lock);
691 return PTR_ERR(thread);
693 wake_up_process(thread);
694 error = nbd_do_it(nbd);
695 kthread_stop(thread);
697 mutex_lock(&nbd->tx_lock);
700 sock_shutdown(nbd, 0);
704 dev_warn(disk_to_dev(nbd->disk), "queue cleared\n");
705 queue_flag_clear_unlocked(QUEUE_FLAG_DISCARD, nbd->disk->queue);
709 bdev->bd_inode->i_size = 0;
710 set_capacity(nbd->disk, 0);
712 ioctl_by_bdev(bdev, BLKRRPART, 0);
713 return nbd->harderror;
718 * This is for compatibility only. The queue is always cleared
719 * by NBD_DO_IT or NBD_CLEAR_SOCK.
721 BUG_ON(!nbd->sock && !list_empty(&nbd->queue_head));
724 case NBD_PRINT_DEBUG:
725 dev_info(disk_to_dev(nbd->disk),
726 "next = %p, prev = %p, head = %p\n",
727 nbd->queue_head.next, nbd->queue_head.prev,
734 static int nbd_ioctl(struct block_device *bdev, fmode_t mode,
735 unsigned int cmd, unsigned long arg)
737 struct nbd_device *nbd = bdev->bd_disk->private_data;
740 if (!capable(CAP_SYS_ADMIN))
743 BUG_ON(nbd->magic != NBD_MAGIC);
745 /* Anyone capable of this syscall can do *real bad* things */
746 dprintk(DBG_IOCTL, "%s: nbd_ioctl cmd=%s(0x%x) arg=%lu\n",
747 nbd->disk->disk_name, ioctl_cmd_to_ascii(cmd), cmd, arg);
749 mutex_lock(&nbd->tx_lock);
750 error = __nbd_ioctl(bdev, nbd, cmd, arg);
751 mutex_unlock(&nbd->tx_lock);
756 static const struct block_device_operations nbd_fops =
758 .owner = THIS_MODULE,
763 * And here should be modules and kernel interface
764 * (Just smiley confuses emacs :-)
767 static int __init nbd_init(void)
773 BUILD_BUG_ON(sizeof(struct nbd_request) != 28);
776 printk(KERN_ERR "nbd: max_part must be >= 0\n");
780 nbd_dev = kcalloc(nbds_max, sizeof(*nbd_dev), GFP_KERNEL);
786 part_shift = fls(max_part);
789 * Adjust max_part according to part_shift as it is exported
790 * to user space so that user can know the max number of
791 * partition kernel should be able to manage.
793 * Note that -1 is required because partition 0 is reserved
794 * for the whole disk.
796 max_part = (1UL << part_shift) - 1;
799 if ((1UL << part_shift) > DISK_MAX_PARTS)
802 if (nbds_max > 1UL << (MINORBITS - part_shift))
805 for (i = 0; i < nbds_max; i++) {
806 struct gendisk *disk = alloc_disk(1 << part_shift);
809 nbd_dev[i].disk = disk;
811 * The new linux 2.5 block layer implementation requires
812 * every gendisk to have its very own request_queue struct.
813 * These structs are big so we dynamically allocate them.
815 disk->queue = blk_init_queue(do_nbd_request, &nbd_lock);
821 * Tell the block layer that we are not a rotational device
823 queue_flag_set_unlocked(QUEUE_FLAG_NONROT, disk->queue);
824 disk->queue->limits.discard_granularity = 512;
825 disk->queue->limits.max_discard_sectors = UINT_MAX;
826 disk->queue->limits.discard_zeroes_data = 0;
829 if (register_blkdev(NBD_MAJOR, "nbd")) {
834 printk(KERN_INFO "nbd: registered device at major %d\n", NBD_MAJOR);
835 dprintk(DBG_INIT, "nbd: debugflags=0x%x\n", debugflags);
837 for (i = 0; i < nbds_max; i++) {
838 struct gendisk *disk = nbd_dev[i].disk;
839 nbd_dev[i].file = NULL;
840 nbd_dev[i].magic = NBD_MAGIC;
841 nbd_dev[i].flags = 0;
842 INIT_LIST_HEAD(&nbd_dev[i].waiting_queue);
843 spin_lock_init(&nbd_dev[i].queue_lock);
844 INIT_LIST_HEAD(&nbd_dev[i].queue_head);
845 mutex_init(&nbd_dev[i].tx_lock);
846 init_waitqueue_head(&nbd_dev[i].active_wq);
847 init_waitqueue_head(&nbd_dev[i].waiting_wq);
848 nbd_dev[i].blksize = 1024;
849 nbd_dev[i].bytesize = 0;
850 disk->major = NBD_MAJOR;
851 disk->first_minor = i << part_shift;
852 disk->fops = &nbd_fops;
853 disk->private_data = &nbd_dev[i];
854 sprintf(disk->disk_name, "nbd%d", i);
855 set_capacity(disk, 0);
862 blk_cleanup_queue(nbd_dev[i].disk->queue);
863 put_disk(nbd_dev[i].disk);
869 static void __exit nbd_cleanup(void)
872 for (i = 0; i < nbds_max; i++) {
873 struct gendisk *disk = nbd_dev[i].disk;
874 nbd_dev[i].magic = 0;
877 blk_cleanup_queue(disk->queue);
881 unregister_blkdev(NBD_MAJOR, "nbd");
883 printk(KERN_INFO "nbd: unregistered device at major %d\n", NBD_MAJOR);
886 module_init(nbd_init);
887 module_exit(nbd_cleanup);
889 MODULE_DESCRIPTION("Network Block Device");
890 MODULE_LICENSE("GPL");
892 module_param(nbds_max, int, 0444);
893 MODULE_PARM_DESC(nbds_max, "number of network block devices to initialize (default: 16)");
894 module_param(max_part, int, 0444);
895 MODULE_PARM_DESC(max_part, "number of partitions per device (default: 0)");
897 module_param(debugflags, int, 0644);
898 MODULE_PARM_DESC(debugflags, "flags for controlling debug output");