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>
21 #include <linux/sched/mm.h>
23 #include <linux/bio.h>
24 #include <linux/stat.h>
25 #include <linux/errno.h>
26 #include <linux/file.h>
27 #include <linux/ioctl.h>
28 #include <linux/mutex.h>
29 #include <linux/compiler.h>
30 #include <linux/err.h>
31 #include <linux/kernel.h>
32 #include <linux/slab.h>
34 #include <linux/net.h>
35 #include <linux/kthread.h>
36 #include <linux/types.h>
37 #include <linux/debugfs.h>
38 #include <linux/blk-mq.h>
40 #include <linux/uaccess.h>
41 #include <asm/types.h>
43 #include <linux/nbd.h>
44 #include <linux/nbd-netlink.h>
45 #include <net/genetlink.h>
47 static DEFINE_IDR(nbd_index_idr
);
48 static DEFINE_MUTEX(nbd_index_mutex
);
49 static int nbd_total_devices
= 0;
54 struct request
*pending
;
61 struct recv_thread_args
{
62 struct work_struct work
;
63 struct nbd_device
*nbd
;
67 struct link_dead_args
{
68 struct work_struct work
;
72 #define NBD_TIMEDOUT 0
73 #define NBD_DISCONNECT_REQUESTED 1
74 #define NBD_DISCONNECTED 2
75 #define NBD_HAS_PID_FILE 3
76 #define NBD_HAS_CONFIG_REF 4
78 #define NBD_DESTROY_ON_DISCONNECT 6
82 unsigned long runtime_flags
;
83 u64 dead_conn_timeout
;
85 struct nbd_sock
**socks
;
87 atomic_t live_connections
;
88 wait_queue_head_t conn_wait
;
90 atomic_t recv_threads
;
91 wait_queue_head_t recv_wq
;
94 #if IS_ENABLED(CONFIG_DEBUG_FS)
95 struct dentry
*dbg_dir
;
100 struct blk_mq_tag_set tag_set
;
103 refcount_t config_refs
;
105 struct nbd_config
*config
;
106 struct mutex config_lock
;
107 struct gendisk
*disk
;
109 struct list_head list
;
110 struct task_struct
*task_recv
;
111 struct task_struct
*task_setup
;
115 struct nbd_device
*nbd
;
118 struct completion send_complete
;
122 #if IS_ENABLED(CONFIG_DEBUG_FS)
123 static struct dentry
*nbd_dbg_dir
;
126 #define nbd_name(nbd) ((nbd)->disk->disk_name)
128 #define NBD_MAGIC 0x68797548
130 static unsigned int nbds_max
= 16;
131 static int max_part
= 16;
132 static struct workqueue_struct
*recv_workqueue
;
133 static int part_shift
;
135 static int nbd_dev_dbg_init(struct nbd_device
*nbd
);
136 static void nbd_dev_dbg_close(struct nbd_device
*nbd
);
137 static void nbd_config_put(struct nbd_device
*nbd
);
138 static void nbd_connect_reply(struct genl_info
*info
, int index
);
139 static int nbd_genl_status(struct sk_buff
*skb
, struct genl_info
*info
);
140 static void nbd_dead_link_work(struct work_struct
*work
);
142 static inline struct device
*nbd_to_dev(struct nbd_device
*nbd
)
144 return disk_to_dev(nbd
->disk
);
147 static const char *nbdcmd_to_ascii(int cmd
)
150 case NBD_CMD_READ
: return "read";
151 case NBD_CMD_WRITE
: return "write";
152 case NBD_CMD_DISC
: return "disconnect";
153 case NBD_CMD_FLUSH
: return "flush";
154 case NBD_CMD_TRIM
: return "trim/discard";
159 static ssize_t
pid_show(struct device
*dev
,
160 struct device_attribute
*attr
, char *buf
)
162 struct gendisk
*disk
= dev_to_disk(dev
);
163 struct nbd_device
*nbd
= (struct nbd_device
*)disk
->private_data
;
165 return sprintf(buf
, "%d\n", task_pid_nr(nbd
->task_recv
));
168 static const struct device_attribute pid_attr
= {
169 .attr
= { .name
= "pid", .mode
= S_IRUGO
},
173 static void nbd_dev_remove(struct nbd_device
*nbd
)
175 struct gendisk
*disk
= nbd
->disk
;
178 blk_cleanup_queue(disk
->queue
);
179 blk_mq_free_tag_set(&nbd
->tag_set
);
180 disk
->private_data
= NULL
;
186 static void nbd_put(struct nbd_device
*nbd
)
188 if (refcount_dec_and_mutex_lock(&nbd
->refs
,
190 idr_remove(&nbd_index_idr
, nbd
->index
);
191 mutex_unlock(&nbd_index_mutex
);
196 static int nbd_disconnected(struct nbd_config
*config
)
198 return test_bit(NBD_DISCONNECTED
, &config
->runtime_flags
) ||
199 test_bit(NBD_DISCONNECT_REQUESTED
, &config
->runtime_flags
);
202 static void nbd_mark_nsock_dead(struct nbd_device
*nbd
, struct nbd_sock
*nsock
,
205 if (!nsock
->dead
&& notify
&& !nbd_disconnected(nbd
->config
)) {
206 struct link_dead_args
*args
;
207 args
= kmalloc(sizeof(struct link_dead_args
), GFP_NOIO
);
209 INIT_WORK(&args
->work
, nbd_dead_link_work
);
210 args
->index
= nbd
->index
;
211 queue_work(system_wq
, &args
->work
);
215 kernel_sock_shutdown(nsock
->sock
, SHUT_RDWR
);
216 atomic_dec(&nbd
->config
->live_connections
);
219 nsock
->pending
= NULL
;
223 static void nbd_size_clear(struct nbd_device
*nbd
)
225 if (nbd
->config
->bytesize
) {
226 set_capacity(nbd
->disk
, 0);
227 kobject_uevent(&nbd_to_dev(nbd
)->kobj
, KOBJ_CHANGE
);
231 static void nbd_size_update(struct nbd_device
*nbd
)
233 struct nbd_config
*config
= nbd
->config
;
234 blk_queue_logical_block_size(nbd
->disk
->queue
, config
->blksize
);
235 blk_queue_physical_block_size(nbd
->disk
->queue
, config
->blksize
);
236 set_capacity(nbd
->disk
, config
->bytesize
>> 9);
237 kobject_uevent(&nbd_to_dev(nbd
)->kobj
, KOBJ_CHANGE
);
240 static void nbd_size_set(struct nbd_device
*nbd
, loff_t blocksize
,
243 struct nbd_config
*config
= nbd
->config
;
244 config
->blksize
= blocksize
;
245 config
->bytesize
= blocksize
* nr_blocks
;
246 nbd_size_update(nbd
);
249 static void nbd_complete_rq(struct request
*req
)
251 struct nbd_cmd
*cmd
= blk_mq_rq_to_pdu(req
);
253 dev_dbg(nbd_to_dev(cmd
->nbd
), "request %p: %s\n", cmd
,
254 cmd
->status
? "failed" : "done");
256 blk_mq_end_request(req
, cmd
->status
);
260 * Forcibly shutdown the socket causing all listeners to error
262 static void sock_shutdown(struct nbd_device
*nbd
)
264 struct nbd_config
*config
= nbd
->config
;
267 if (config
->num_connections
== 0)
269 if (test_and_set_bit(NBD_DISCONNECTED
, &config
->runtime_flags
))
272 for (i
= 0; i
< config
->num_connections
; i
++) {
273 struct nbd_sock
*nsock
= config
->socks
[i
];
274 mutex_lock(&nsock
->tx_lock
);
275 nbd_mark_nsock_dead(nbd
, nsock
, 0);
276 mutex_unlock(&nsock
->tx_lock
);
278 dev_warn(disk_to_dev(nbd
->disk
), "shutting down sockets\n");
281 static enum blk_eh_timer_return
nbd_xmit_timeout(struct request
*req
,
284 struct nbd_cmd
*cmd
= blk_mq_rq_to_pdu(req
);
285 struct nbd_device
*nbd
= cmd
->nbd
;
286 struct nbd_config
*config
;
288 if (!refcount_inc_not_zero(&nbd
->config_refs
)) {
289 cmd
->status
= BLK_STS_TIMEOUT
;
290 return BLK_EH_HANDLED
;
292 config
= nbd
->config
;
294 if (config
->num_connections
> 1) {
295 dev_err_ratelimited(nbd_to_dev(nbd
),
296 "Connection timed out, retrying\n");
298 * Hooray we have more connections, requeue this IO, the submit
299 * path will put it on a real connection.
301 if (config
->socks
&& config
->num_connections
> 1) {
302 if (cmd
->index
< config
->num_connections
) {
303 struct nbd_sock
*nsock
=
304 config
->socks
[cmd
->index
];
305 mutex_lock(&nsock
->tx_lock
);
306 /* We can have multiple outstanding requests, so
307 * we don't want to mark the nsock dead if we've
308 * already reconnected with a new socket, so
309 * only mark it dead if its the same socket we
312 if (cmd
->cookie
== nsock
->cookie
)
313 nbd_mark_nsock_dead(nbd
, nsock
, 1);
314 mutex_unlock(&nsock
->tx_lock
);
316 blk_mq_requeue_request(req
, true);
318 return BLK_EH_NOT_HANDLED
;
321 dev_err_ratelimited(nbd_to_dev(nbd
),
322 "Connection timed out\n");
324 set_bit(NBD_TIMEDOUT
, &config
->runtime_flags
);
325 cmd
->status
= BLK_STS_IOERR
;
329 return BLK_EH_HANDLED
;
333 * Send or receive packet.
335 static int sock_xmit(struct nbd_device
*nbd
, int index
, int send
,
336 struct iov_iter
*iter
, int msg_flags
, int *sent
)
338 struct nbd_config
*config
= nbd
->config
;
339 struct socket
*sock
= config
->socks
[index
]->sock
;
342 unsigned int noreclaim_flag
;
344 if (unlikely(!sock
)) {
345 dev_err_ratelimited(disk_to_dev(nbd
->disk
),
346 "Attempted %s on closed socket in sock_xmit\n",
347 (send
? "send" : "recv"));
351 msg
.msg_iter
= *iter
;
353 noreclaim_flag
= memalloc_noreclaim_save();
355 sock
->sk
->sk_allocation
= GFP_NOIO
| __GFP_MEMALLOC
;
358 msg
.msg_control
= NULL
;
359 msg
.msg_controllen
= 0;
360 msg
.msg_flags
= msg_flags
| MSG_NOSIGNAL
;
363 result
= sock_sendmsg(sock
, &msg
);
365 result
= sock_recvmsg(sock
, &msg
, msg
.msg_flags
);
369 result
= -EPIPE
; /* short read */
374 } while (msg_data_left(&msg
));
376 memalloc_noreclaim_restore(noreclaim_flag
);
381 /* always call with the tx_lock held */
382 static int nbd_send_cmd(struct nbd_device
*nbd
, struct nbd_cmd
*cmd
, int index
)
384 struct request
*req
= blk_mq_rq_from_pdu(cmd
);
385 struct nbd_config
*config
= nbd
->config
;
386 struct nbd_sock
*nsock
= config
->socks
[index
];
388 struct nbd_request request
= {.magic
= htonl(NBD_REQUEST_MAGIC
)};
389 struct kvec iov
= {.iov_base
= &request
, .iov_len
= sizeof(request
)};
390 struct iov_iter from
;
391 unsigned long size
= blk_rq_bytes(req
);
394 u32 nbd_cmd_flags
= 0;
395 u32 tag
= blk_mq_unique_tag(req
);
396 int sent
= nsock
->sent
, skip
= 0;
398 iov_iter_kvec(&from
, WRITE
| ITER_KVEC
, &iov
, 1, sizeof(request
));
400 switch (req_op(req
)) {
405 type
= NBD_CMD_FLUSH
;
408 type
= NBD_CMD_WRITE
;
417 if (rq_data_dir(req
) == WRITE
&&
418 (config
->flags
& NBD_FLAG_READ_ONLY
)) {
419 dev_err_ratelimited(disk_to_dev(nbd
->disk
),
420 "Write on read-only\n");
424 if (req
->cmd_flags
& REQ_FUA
)
425 nbd_cmd_flags
|= NBD_CMD_FLAG_FUA
;
427 /* We did a partial send previously, and we at least sent the whole
428 * request struct, so just go and send the rest of the pages in the
432 if (sent
>= sizeof(request
)) {
433 skip
= sent
- sizeof(request
);
436 iov_iter_advance(&from
, sent
);
439 cmd
->cookie
= nsock
->cookie
;
440 request
.type
= htonl(type
| nbd_cmd_flags
);
441 if (type
!= NBD_CMD_FLUSH
) {
442 request
.from
= cpu_to_be64((u64
)blk_rq_pos(req
) << 9);
443 request
.len
= htonl(size
);
445 memcpy(request
.handle
, &tag
, sizeof(tag
));
447 dev_dbg(nbd_to_dev(nbd
), "request %p: sending control (%s@%llu,%uB)\n",
448 cmd
, nbdcmd_to_ascii(type
),
449 (unsigned long long)blk_rq_pos(req
) << 9, blk_rq_bytes(req
));
450 result
= sock_xmit(nbd
, index
, 1, &from
,
451 (type
== NBD_CMD_WRITE
) ? MSG_MORE
: 0, &sent
);
453 if (result
== -ERESTARTSYS
) {
454 /* If we havne't sent anything we can just return BUSY,
455 * however if we have sent something we need to make
456 * sure we only allow this req to be sent until we are
460 nsock
->pending
= req
;
463 return BLK_STS_RESOURCE
;
465 dev_err_ratelimited(disk_to_dev(nbd
->disk
),
466 "Send control failed (result %d)\n", result
);
470 if (type
!= NBD_CMD_WRITE
)
475 struct bio
*next
= bio
->bi_next
;
476 struct bvec_iter iter
;
479 bio_for_each_segment(bvec
, bio
, iter
) {
480 bool is_last
= !next
&& bio_iter_last(bvec
, iter
);
481 int flags
= is_last
? 0 : MSG_MORE
;
483 dev_dbg(nbd_to_dev(nbd
), "request %p: sending %d bytes data\n",
485 iov_iter_bvec(&from
, ITER_BVEC
| WRITE
,
486 &bvec
, 1, bvec
.bv_len
);
488 if (skip
>= iov_iter_count(&from
)) {
489 skip
-= iov_iter_count(&from
);
492 iov_iter_advance(&from
, skip
);
495 result
= sock_xmit(nbd
, index
, 1, &from
, flags
, &sent
);
497 if (result
== -ERESTARTSYS
) {
498 /* We've already sent the header, we
499 * have no choice but to set pending and
502 nsock
->pending
= req
;
504 return BLK_STS_RESOURCE
;
506 dev_err(disk_to_dev(nbd
->disk
),
507 "Send data failed (result %d)\n",
512 * The completion might already have come in,
513 * so break for the last one instead of letting
514 * the iterator do it. This prevents use-after-free
523 nsock
->pending
= NULL
;
528 /* NULL returned = something went wrong, inform userspace */
529 static struct nbd_cmd
*nbd_read_stat(struct nbd_device
*nbd
, int index
)
531 struct nbd_config
*config
= nbd
->config
;
533 struct nbd_reply reply
;
535 struct request
*req
= NULL
;
538 struct kvec iov
= {.iov_base
= &reply
, .iov_len
= sizeof(reply
)};
542 iov_iter_kvec(&to
, READ
| ITER_KVEC
, &iov
, 1, sizeof(reply
));
543 result
= sock_xmit(nbd
, index
, 0, &to
, MSG_WAITALL
, NULL
);
545 if (!nbd_disconnected(config
))
546 dev_err(disk_to_dev(nbd
->disk
),
547 "Receive control failed (result %d)\n", result
);
548 return ERR_PTR(result
);
551 if (ntohl(reply
.magic
) != NBD_REPLY_MAGIC
) {
552 dev_err(disk_to_dev(nbd
->disk
), "Wrong magic (0x%lx)\n",
553 (unsigned long)ntohl(reply
.magic
));
554 return ERR_PTR(-EPROTO
);
557 memcpy(&tag
, reply
.handle
, sizeof(u32
));
559 hwq
= blk_mq_unique_tag_to_hwq(tag
);
560 if (hwq
< nbd
->tag_set
.nr_hw_queues
)
561 req
= blk_mq_tag_to_rq(nbd
->tag_set
.tags
[hwq
],
562 blk_mq_unique_tag_to_tag(tag
));
563 if (!req
|| !blk_mq_request_started(req
)) {
564 dev_err(disk_to_dev(nbd
->disk
), "Unexpected reply (%d) %p\n",
566 return ERR_PTR(-ENOENT
);
568 cmd
= blk_mq_rq_to_pdu(req
);
569 if (ntohl(reply
.error
)) {
570 dev_err(disk_to_dev(nbd
->disk
), "Other side returned error (%d)\n",
572 cmd
->status
= BLK_STS_IOERR
;
576 dev_dbg(nbd_to_dev(nbd
), "request %p: got reply\n", cmd
);
577 if (rq_data_dir(req
) != WRITE
) {
578 struct req_iterator iter
;
581 rq_for_each_segment(bvec
, req
, iter
) {
582 iov_iter_bvec(&to
, ITER_BVEC
| READ
,
583 &bvec
, 1, bvec
.bv_len
);
584 result
= sock_xmit(nbd
, index
, 0, &to
, MSG_WAITALL
, NULL
);
586 dev_err(disk_to_dev(nbd
->disk
), "Receive data failed (result %d)\n",
589 * If we've disconnected or we only have 1
590 * connection then we need to make sure we
591 * complete this request, otherwise error out
592 * and let the timeout stuff handle resubmitting
593 * this request onto another connection.
595 if (nbd_disconnected(config
) ||
596 config
->num_connections
<= 1) {
597 cmd
->status
= BLK_STS_IOERR
;
600 return ERR_PTR(-EIO
);
602 dev_dbg(nbd_to_dev(nbd
), "request %p: got %d bytes data\n",
606 /* See the comment in nbd_queue_rq. */
607 wait_for_completion(&cmd
->send_complete
);
612 static void recv_work(struct work_struct
*work
)
614 struct recv_thread_args
*args
= container_of(work
,
615 struct recv_thread_args
,
617 struct nbd_device
*nbd
= args
->nbd
;
618 struct nbd_config
*config
= nbd
->config
;
622 cmd
= nbd_read_stat(nbd
, args
->index
);
624 struct nbd_sock
*nsock
= config
->socks
[args
->index
];
626 mutex_lock(&nsock
->tx_lock
);
627 nbd_mark_nsock_dead(nbd
, nsock
, 1);
628 mutex_unlock(&nsock
->tx_lock
);
632 blk_mq_complete_request(blk_mq_rq_from_pdu(cmd
));
634 atomic_dec(&config
->recv_threads
);
635 wake_up(&config
->recv_wq
);
640 static void nbd_clear_req(struct request
*req
, void *data
, bool reserved
)
644 if (!blk_mq_request_started(req
))
646 cmd
= blk_mq_rq_to_pdu(req
);
647 cmd
->status
= BLK_STS_IOERR
;
648 blk_mq_complete_request(req
);
651 static void nbd_clear_que(struct nbd_device
*nbd
)
653 blk_mq_quiesce_queue(nbd
->disk
->queue
);
654 blk_mq_tagset_busy_iter(&nbd
->tag_set
, nbd_clear_req
, NULL
);
655 blk_mq_unquiesce_queue(nbd
->disk
->queue
);
656 dev_dbg(disk_to_dev(nbd
->disk
), "queue cleared\n");
659 static int find_fallback(struct nbd_device
*nbd
, int index
)
661 struct nbd_config
*config
= nbd
->config
;
663 struct nbd_sock
*nsock
= config
->socks
[index
];
664 int fallback
= nsock
->fallback_index
;
666 if (test_bit(NBD_DISCONNECTED
, &config
->runtime_flags
))
669 if (config
->num_connections
<= 1) {
670 dev_err_ratelimited(disk_to_dev(nbd
->disk
),
671 "Attempted send on invalid socket\n");
675 if (fallback
>= 0 && fallback
< config
->num_connections
&&
676 !config
->socks
[fallback
]->dead
)
679 if (nsock
->fallback_index
< 0 ||
680 nsock
->fallback_index
>= config
->num_connections
||
681 config
->socks
[nsock
->fallback_index
]->dead
) {
683 for (i
= 0; i
< config
->num_connections
; i
++) {
686 if (!config
->socks
[i
]->dead
) {
691 nsock
->fallback_index
= new_index
;
693 dev_err_ratelimited(disk_to_dev(nbd
->disk
),
694 "Dead connection, failed to find a fallback\n");
698 new_index
= nsock
->fallback_index
;
702 static int wait_for_reconnect(struct nbd_device
*nbd
)
704 struct nbd_config
*config
= nbd
->config
;
705 if (!config
->dead_conn_timeout
)
707 if (test_bit(NBD_DISCONNECTED
, &config
->runtime_flags
))
709 wait_event_timeout(config
->conn_wait
,
710 atomic_read(&config
->live_connections
),
711 config
->dead_conn_timeout
);
712 return atomic_read(&config
->live_connections
);
715 static int nbd_handle_cmd(struct nbd_cmd
*cmd
, int index
)
717 struct request
*req
= blk_mq_rq_from_pdu(cmd
);
718 struct nbd_device
*nbd
= cmd
->nbd
;
719 struct nbd_config
*config
;
720 struct nbd_sock
*nsock
;
723 if (!refcount_inc_not_zero(&nbd
->config_refs
)) {
724 dev_err_ratelimited(disk_to_dev(nbd
->disk
),
725 "Socks array is empty\n");
726 blk_mq_start_request(req
);
729 config
= nbd
->config
;
731 if (index
>= config
->num_connections
) {
732 dev_err_ratelimited(disk_to_dev(nbd
->disk
),
733 "Attempted send on invalid socket\n");
735 blk_mq_start_request(req
);
738 cmd
->status
= BLK_STS_OK
;
740 nsock
= config
->socks
[index
];
741 mutex_lock(&nsock
->tx_lock
);
743 int old_index
= index
;
744 index
= find_fallback(nbd
, index
);
745 mutex_unlock(&nsock
->tx_lock
);
747 if (wait_for_reconnect(nbd
)) {
751 /* All the sockets should already be down at this point,
752 * we just want to make sure that DISCONNECTED is set so
753 * any requests that come in that were queue'ed waiting
754 * for the reconnect timer don't trigger the timer again
755 * and instead just error out.
759 blk_mq_start_request(req
);
765 /* Handle the case that we have a pending request that was partially
766 * transmitted that _has_ to be serviced first. We need to call requeue
767 * here so that it gets put _after_ the request that is already on the
770 blk_mq_start_request(req
);
771 if (unlikely(nsock
->pending
&& nsock
->pending
!= req
)) {
772 blk_mq_requeue_request(req
, true);
777 * Some failures are related to the link going down, so anything that
778 * returns EAGAIN can be retried on a different socket.
780 ret
= nbd_send_cmd(nbd
, cmd
, index
);
781 if (ret
== -EAGAIN
) {
782 dev_err_ratelimited(disk_to_dev(nbd
->disk
),
783 "Request send failed, requeueing\n");
784 nbd_mark_nsock_dead(nbd
, nsock
, 1);
785 blk_mq_requeue_request(req
, true);
789 mutex_unlock(&nsock
->tx_lock
);
794 static blk_status_t
nbd_queue_rq(struct blk_mq_hw_ctx
*hctx
,
795 const struct blk_mq_queue_data
*bd
)
797 struct nbd_cmd
*cmd
= blk_mq_rq_to_pdu(bd
->rq
);
801 * Since we look at the bio's to send the request over the network we
802 * need to make sure the completion work doesn't mark this request done
803 * before we are done doing our send. This keeps us from dereferencing
804 * freed data if we have particularly fast completions (ie we get the
805 * completion before we exit sock_xmit on the last bvec) or in the case
806 * that the server is misbehaving (or there was an error) before we're
807 * done sending everything over the wire.
809 init_completion(&cmd
->send_complete
);
811 /* We can be called directly from the user space process, which means we
812 * could possibly have signals pending so our sendmsg will fail. In
813 * this case we need to return that we are busy, otherwise error out as
816 ret
= nbd_handle_cmd(cmd
, hctx
->queue_num
);
817 complete(&cmd
->send_complete
);
819 return ret
< 0 ? BLK_STS_IOERR
: BLK_STS_OK
;
822 static int nbd_add_socket(struct nbd_device
*nbd
, unsigned long arg
,
825 struct nbd_config
*config
= nbd
->config
;
827 struct nbd_sock
**socks
;
828 struct nbd_sock
*nsock
;
831 sock
= sockfd_lookup(arg
, &err
);
835 if (!netlink
&& !nbd
->task_setup
&&
836 !test_bit(NBD_BOUND
, &config
->runtime_flags
))
837 nbd
->task_setup
= current
;
840 (nbd
->task_setup
!= current
||
841 test_bit(NBD_BOUND
, &config
->runtime_flags
))) {
842 dev_err(disk_to_dev(nbd
->disk
),
843 "Device being setup by another task");
848 socks
= krealloc(config
->socks
, (config
->num_connections
+ 1) *
849 sizeof(struct nbd_sock
*), GFP_KERNEL
);
854 nsock
= kzalloc(sizeof(struct nbd_sock
), GFP_KERNEL
);
860 config
->socks
= socks
;
862 nsock
->fallback_index
= -1;
864 mutex_init(&nsock
->tx_lock
);
866 nsock
->pending
= NULL
;
869 socks
[config
->num_connections
++] = nsock
;
870 atomic_inc(&config
->live_connections
);
875 static int nbd_reconnect_socket(struct nbd_device
*nbd
, unsigned long arg
)
877 struct nbd_config
*config
= nbd
->config
;
878 struct socket
*sock
, *old
;
879 struct recv_thread_args
*args
;
883 sock
= sockfd_lookup(arg
, &err
);
887 args
= kzalloc(sizeof(*args
), GFP_KERNEL
);
893 for (i
= 0; i
< config
->num_connections
; i
++) {
894 struct nbd_sock
*nsock
= config
->socks
[i
];
899 mutex_lock(&nsock
->tx_lock
);
901 mutex_unlock(&nsock
->tx_lock
);
904 sk_set_memalloc(sock
->sk
);
905 if (nbd
->tag_set
.timeout
)
906 sock
->sk
->sk_sndtimeo
= nbd
->tag_set
.timeout
;
907 atomic_inc(&config
->recv_threads
);
908 refcount_inc(&nbd
->config_refs
);
910 nsock
->fallback_index
= -1;
913 INIT_WORK(&args
->work
, recv_work
);
917 mutex_unlock(&nsock
->tx_lock
);
920 clear_bit(NBD_DISCONNECTED
, &config
->runtime_flags
);
922 /* We take the tx_mutex in an error path in the recv_work, so we
923 * need to queue_work outside of the tx_mutex.
925 queue_work(recv_workqueue
, &args
->work
);
927 atomic_inc(&config
->live_connections
);
928 wake_up(&config
->conn_wait
);
936 static void nbd_bdev_reset(struct block_device
*bdev
)
938 if (bdev
->bd_openers
> 1)
940 bd_set_size(bdev
, 0);
942 blkdev_reread_part(bdev
);
943 bdev
->bd_invalidated
= 1;
947 static void nbd_parse_flags(struct nbd_device
*nbd
)
949 struct nbd_config
*config
= nbd
->config
;
950 if (config
->flags
& NBD_FLAG_READ_ONLY
)
951 set_disk_ro(nbd
->disk
, true);
953 set_disk_ro(nbd
->disk
, false);
954 if (config
->flags
& NBD_FLAG_SEND_TRIM
)
955 queue_flag_set_unlocked(QUEUE_FLAG_DISCARD
, nbd
->disk
->queue
);
956 if (config
->flags
& NBD_FLAG_SEND_FLUSH
) {
957 if (config
->flags
& NBD_FLAG_SEND_FUA
)
958 blk_queue_write_cache(nbd
->disk
->queue
, true, true);
960 blk_queue_write_cache(nbd
->disk
->queue
, true, false);
963 blk_queue_write_cache(nbd
->disk
->queue
, false, false);
966 static void send_disconnects(struct nbd_device
*nbd
)
968 struct nbd_config
*config
= nbd
->config
;
969 struct nbd_request request
= {
970 .magic
= htonl(NBD_REQUEST_MAGIC
),
971 .type
= htonl(NBD_CMD_DISC
),
973 struct kvec iov
= {.iov_base
= &request
, .iov_len
= sizeof(request
)};
974 struct iov_iter from
;
977 for (i
= 0; i
< config
->num_connections
; i
++) {
978 struct nbd_sock
*nsock
= config
->socks
[i
];
980 iov_iter_kvec(&from
, WRITE
| ITER_KVEC
, &iov
, 1, sizeof(request
));
981 mutex_lock(&nsock
->tx_lock
);
982 ret
= sock_xmit(nbd
, i
, 1, &from
, 0, NULL
);
984 dev_err(disk_to_dev(nbd
->disk
),
985 "Send disconnect failed %d\n", ret
);
986 mutex_unlock(&nsock
->tx_lock
);
990 static int nbd_disconnect(struct nbd_device
*nbd
)
992 struct nbd_config
*config
= nbd
->config
;
994 dev_info(disk_to_dev(nbd
->disk
), "NBD_DISCONNECT\n");
995 set_bit(NBD_DISCONNECT_REQUESTED
, &config
->runtime_flags
);
996 send_disconnects(nbd
);
1000 static void nbd_clear_sock(struct nbd_device
*nbd
)
1004 nbd
->task_setup
= NULL
;
1007 static void nbd_config_put(struct nbd_device
*nbd
)
1009 if (refcount_dec_and_mutex_lock(&nbd
->config_refs
,
1010 &nbd
->config_lock
)) {
1011 struct nbd_config
*config
= nbd
->config
;
1012 nbd_dev_dbg_close(nbd
);
1013 nbd_size_clear(nbd
);
1014 if (test_and_clear_bit(NBD_HAS_PID_FILE
,
1015 &config
->runtime_flags
))
1016 device_remove_file(disk_to_dev(nbd
->disk
), &pid_attr
);
1017 nbd
->task_recv
= NULL
;
1018 nbd_clear_sock(nbd
);
1019 if (config
->num_connections
) {
1021 for (i
= 0; i
< config
->num_connections
; i
++) {
1022 sockfd_put(config
->socks
[i
]->sock
);
1023 kfree(config
->socks
[i
]);
1025 kfree(config
->socks
);
1030 nbd
->tag_set
.timeout
= 0;
1031 queue_flag_clear_unlocked(QUEUE_FLAG_DISCARD
, nbd
->disk
->queue
);
1033 mutex_unlock(&nbd
->config_lock
);
1035 module_put(THIS_MODULE
);
1039 static int nbd_start_device(struct nbd_device
*nbd
)
1041 struct nbd_config
*config
= nbd
->config
;
1042 int num_connections
= config
->num_connections
;
1049 if (num_connections
> 1 &&
1050 !(config
->flags
& NBD_FLAG_CAN_MULTI_CONN
)) {
1051 dev_err(disk_to_dev(nbd
->disk
), "server does not support multiple connections per device.\n");
1055 blk_mq_update_nr_hw_queues(&nbd
->tag_set
, config
->num_connections
);
1056 nbd
->task_recv
= current
;
1058 nbd_parse_flags(nbd
);
1060 error
= device_create_file(disk_to_dev(nbd
->disk
), &pid_attr
);
1062 dev_err(disk_to_dev(nbd
->disk
), "device_create_file failed!\n");
1065 set_bit(NBD_HAS_PID_FILE
, &config
->runtime_flags
);
1067 nbd_dev_dbg_init(nbd
);
1068 for (i
= 0; i
< num_connections
; i
++) {
1069 struct recv_thread_args
*args
;
1071 args
= kzalloc(sizeof(*args
), GFP_KERNEL
);
1076 sk_set_memalloc(config
->socks
[i
]->sock
->sk
);
1077 if (nbd
->tag_set
.timeout
)
1078 config
->socks
[i
]->sock
->sk
->sk_sndtimeo
=
1079 nbd
->tag_set
.timeout
;
1080 atomic_inc(&config
->recv_threads
);
1081 refcount_inc(&nbd
->config_refs
);
1082 INIT_WORK(&args
->work
, recv_work
);
1085 queue_work(recv_workqueue
, &args
->work
);
1090 static int nbd_start_device_ioctl(struct nbd_device
*nbd
, struct block_device
*bdev
)
1092 struct nbd_config
*config
= nbd
->config
;
1095 ret
= nbd_start_device(nbd
);
1099 bd_set_size(bdev
, config
->bytesize
);
1101 bdev
->bd_invalidated
= 1;
1102 mutex_unlock(&nbd
->config_lock
);
1103 ret
= wait_event_interruptible(config
->recv_wq
,
1104 atomic_read(&config
->recv_threads
) == 0);
1107 mutex_lock(&nbd
->config_lock
);
1108 bd_set_size(bdev
, 0);
1109 /* user requested, ignore socket errors */
1110 if (test_bit(NBD_DISCONNECT_REQUESTED
, &config
->runtime_flags
))
1112 if (test_bit(NBD_TIMEDOUT
, &config
->runtime_flags
))
1117 static void nbd_clear_sock_ioctl(struct nbd_device
*nbd
,
1118 struct block_device
*bdev
)
1122 nbd_bdev_reset(bdev
);
1123 if (test_and_clear_bit(NBD_HAS_CONFIG_REF
,
1124 &nbd
->config
->runtime_flags
))
1125 nbd_config_put(nbd
);
1128 /* Must be called with config_lock held */
1129 static int __nbd_ioctl(struct block_device
*bdev
, struct nbd_device
*nbd
,
1130 unsigned int cmd
, unsigned long arg
)
1132 struct nbd_config
*config
= nbd
->config
;
1135 case NBD_DISCONNECT
:
1136 return nbd_disconnect(nbd
);
1137 case NBD_CLEAR_SOCK
:
1138 nbd_clear_sock_ioctl(nbd
, bdev
);
1141 return nbd_add_socket(nbd
, arg
, false);
1142 case NBD_SET_BLKSIZE
:
1143 nbd_size_set(nbd
, arg
,
1144 div_s64(config
->bytesize
, arg
));
1147 nbd_size_set(nbd
, config
->blksize
,
1148 div_s64(arg
, config
->blksize
));
1150 case NBD_SET_SIZE_BLOCKS
:
1151 nbd_size_set(nbd
, config
->blksize
, arg
);
1153 case NBD_SET_TIMEOUT
:
1155 nbd
->tag_set
.timeout
= arg
* HZ
;
1156 blk_queue_rq_timeout(nbd
->disk
->queue
, arg
* HZ
);
1161 config
->flags
= arg
;
1164 return nbd_start_device_ioctl(nbd
, bdev
);
1167 * This is for compatibility only. The queue is always cleared
1168 * by NBD_DO_IT or NBD_CLEAR_SOCK.
1171 case NBD_PRINT_DEBUG
:
1173 * For compatibility only, we no longer keep a list of
1174 * outstanding requests.
1181 static int nbd_ioctl(struct block_device
*bdev
, fmode_t mode
,
1182 unsigned int cmd
, unsigned long arg
)
1184 struct nbd_device
*nbd
= bdev
->bd_disk
->private_data
;
1185 struct nbd_config
*config
= nbd
->config
;
1186 int error
= -EINVAL
;
1188 if (!capable(CAP_SYS_ADMIN
))
1191 /* The block layer will pass back some non-nbd ioctls in case we have
1192 * special handling for them, but we don't so just return an error.
1194 if (_IOC_TYPE(cmd
) != 0xab)
1197 mutex_lock(&nbd
->config_lock
);
1199 /* Don't allow ioctl operations on a nbd device that was created with
1200 * netlink, unless it's DISCONNECT or CLEAR_SOCK, which are fine.
1202 if (!test_bit(NBD_BOUND
, &config
->runtime_flags
) ||
1203 (cmd
== NBD_DISCONNECT
|| cmd
== NBD_CLEAR_SOCK
))
1204 error
= __nbd_ioctl(bdev
, nbd
, cmd
, arg
);
1206 dev_err(nbd_to_dev(nbd
), "Cannot use ioctl interface on a netlink controlled device.\n");
1207 mutex_unlock(&nbd
->config_lock
);
1211 static struct nbd_config
*nbd_alloc_config(void)
1213 struct nbd_config
*config
;
1215 config
= kzalloc(sizeof(struct nbd_config
), GFP_NOFS
);
1218 atomic_set(&config
->recv_threads
, 0);
1219 init_waitqueue_head(&config
->recv_wq
);
1220 init_waitqueue_head(&config
->conn_wait
);
1221 config
->blksize
= 1024;
1222 atomic_set(&config
->live_connections
, 0);
1223 try_module_get(THIS_MODULE
);
1227 static int nbd_open(struct block_device
*bdev
, fmode_t mode
)
1229 struct nbd_device
*nbd
;
1232 mutex_lock(&nbd_index_mutex
);
1233 nbd
= bdev
->bd_disk
->private_data
;
1238 if (!refcount_inc_not_zero(&nbd
->refs
)) {
1242 if (!refcount_inc_not_zero(&nbd
->config_refs
)) {
1243 struct nbd_config
*config
;
1245 mutex_lock(&nbd
->config_lock
);
1246 if (refcount_inc_not_zero(&nbd
->config_refs
)) {
1247 mutex_unlock(&nbd
->config_lock
);
1250 config
= nbd
->config
= nbd_alloc_config();
1253 mutex_unlock(&nbd
->config_lock
);
1256 refcount_set(&nbd
->config_refs
, 1);
1257 refcount_inc(&nbd
->refs
);
1258 mutex_unlock(&nbd
->config_lock
);
1261 mutex_unlock(&nbd_index_mutex
);
1265 static void nbd_release(struct gendisk
*disk
, fmode_t mode
)
1267 struct nbd_device
*nbd
= disk
->private_data
;
1268 nbd_config_put(nbd
);
1272 static const struct block_device_operations nbd_fops
=
1274 .owner
= THIS_MODULE
,
1276 .release
= nbd_release
,
1278 .compat_ioctl
= nbd_ioctl
,
1281 #if IS_ENABLED(CONFIG_DEBUG_FS)
1283 static int nbd_dbg_tasks_show(struct seq_file
*s
, void *unused
)
1285 struct nbd_device
*nbd
= s
->private;
1288 seq_printf(s
, "recv: %d\n", task_pid_nr(nbd
->task_recv
));
1293 static int nbd_dbg_tasks_open(struct inode
*inode
, struct file
*file
)
1295 return single_open(file
, nbd_dbg_tasks_show
, inode
->i_private
);
1298 static const struct file_operations nbd_dbg_tasks_ops
= {
1299 .open
= nbd_dbg_tasks_open
,
1301 .llseek
= seq_lseek
,
1302 .release
= single_release
,
1305 static int nbd_dbg_flags_show(struct seq_file
*s
, void *unused
)
1307 struct nbd_device
*nbd
= s
->private;
1308 u32 flags
= nbd
->config
->flags
;
1310 seq_printf(s
, "Hex: 0x%08x\n\n", flags
);
1312 seq_puts(s
, "Known flags:\n");
1314 if (flags
& NBD_FLAG_HAS_FLAGS
)
1315 seq_puts(s
, "NBD_FLAG_HAS_FLAGS\n");
1316 if (flags
& NBD_FLAG_READ_ONLY
)
1317 seq_puts(s
, "NBD_FLAG_READ_ONLY\n");
1318 if (flags
& NBD_FLAG_SEND_FLUSH
)
1319 seq_puts(s
, "NBD_FLAG_SEND_FLUSH\n");
1320 if (flags
& NBD_FLAG_SEND_FUA
)
1321 seq_puts(s
, "NBD_FLAG_SEND_FUA\n");
1322 if (flags
& NBD_FLAG_SEND_TRIM
)
1323 seq_puts(s
, "NBD_FLAG_SEND_TRIM\n");
1328 static int nbd_dbg_flags_open(struct inode
*inode
, struct file
*file
)
1330 return single_open(file
, nbd_dbg_flags_show
, inode
->i_private
);
1333 static const struct file_operations nbd_dbg_flags_ops
= {
1334 .open
= nbd_dbg_flags_open
,
1336 .llseek
= seq_lseek
,
1337 .release
= single_release
,
1340 static int nbd_dev_dbg_init(struct nbd_device
*nbd
)
1343 struct nbd_config
*config
= nbd
->config
;
1348 dir
= debugfs_create_dir(nbd_name(nbd
), nbd_dbg_dir
);
1350 dev_err(nbd_to_dev(nbd
), "Failed to create debugfs dir for '%s'\n",
1354 config
->dbg_dir
= dir
;
1356 debugfs_create_file("tasks", 0444, dir
, nbd
, &nbd_dbg_tasks_ops
);
1357 debugfs_create_u64("size_bytes", 0444, dir
, &config
->bytesize
);
1358 debugfs_create_u32("timeout", 0444, dir
, &nbd
->tag_set
.timeout
);
1359 debugfs_create_u64("blocksize", 0444, dir
, &config
->blksize
);
1360 debugfs_create_file("flags", 0444, dir
, nbd
, &nbd_dbg_flags_ops
);
1365 static void nbd_dev_dbg_close(struct nbd_device
*nbd
)
1367 debugfs_remove_recursive(nbd
->config
->dbg_dir
);
1370 static int nbd_dbg_init(void)
1372 struct dentry
*dbg_dir
;
1374 dbg_dir
= debugfs_create_dir("nbd", NULL
);
1378 nbd_dbg_dir
= dbg_dir
;
1383 static void nbd_dbg_close(void)
1385 debugfs_remove_recursive(nbd_dbg_dir
);
1388 #else /* IS_ENABLED(CONFIG_DEBUG_FS) */
1390 static int nbd_dev_dbg_init(struct nbd_device
*nbd
)
1395 static void nbd_dev_dbg_close(struct nbd_device
*nbd
)
1399 static int nbd_dbg_init(void)
1404 static void nbd_dbg_close(void)
1410 static int nbd_init_request(struct blk_mq_tag_set
*set
, struct request
*rq
,
1411 unsigned int hctx_idx
, unsigned int numa_node
)
1413 struct nbd_cmd
*cmd
= blk_mq_rq_to_pdu(rq
);
1414 cmd
->nbd
= set
->driver_data
;
1418 static const struct blk_mq_ops nbd_mq_ops
= {
1419 .queue_rq
= nbd_queue_rq
,
1420 .complete
= nbd_complete_rq
,
1421 .init_request
= nbd_init_request
,
1422 .timeout
= nbd_xmit_timeout
,
1425 static int nbd_dev_add(int index
)
1427 struct nbd_device
*nbd
;
1428 struct gendisk
*disk
;
1429 struct request_queue
*q
;
1432 nbd
= kzalloc(sizeof(struct nbd_device
), GFP_KERNEL
);
1436 disk
= alloc_disk(1 << part_shift
);
1441 err
= idr_alloc(&nbd_index_idr
, nbd
, index
, index
+ 1,
1446 err
= idr_alloc(&nbd_index_idr
, nbd
, 0, 0, GFP_KERNEL
);
1455 nbd
->tag_set
.ops
= &nbd_mq_ops
;
1456 nbd
->tag_set
.nr_hw_queues
= 1;
1457 nbd
->tag_set
.queue_depth
= 128;
1458 nbd
->tag_set
.numa_node
= NUMA_NO_NODE
;
1459 nbd
->tag_set
.cmd_size
= sizeof(struct nbd_cmd
);
1460 nbd
->tag_set
.flags
= BLK_MQ_F_SHOULD_MERGE
|
1461 BLK_MQ_F_SG_MERGE
| BLK_MQ_F_BLOCKING
;
1462 nbd
->tag_set
.driver_data
= nbd
;
1464 err
= blk_mq_alloc_tag_set(&nbd
->tag_set
);
1468 q
= blk_mq_init_queue(&nbd
->tag_set
);
1476 * Tell the block layer that we are not a rotational device
1478 queue_flag_set_unlocked(QUEUE_FLAG_NONROT
, disk
->queue
);
1479 queue_flag_clear_unlocked(QUEUE_FLAG_ADD_RANDOM
, disk
->queue
);
1480 disk
->queue
->limits
.discard_granularity
= 512;
1481 blk_queue_max_discard_sectors(disk
->queue
, UINT_MAX
);
1482 blk_queue_max_segment_size(disk
->queue
, UINT_MAX
);
1483 blk_queue_max_segments(disk
->queue
, USHRT_MAX
);
1484 blk_queue_max_hw_sectors(disk
->queue
, 65536);
1485 disk
->queue
->limits
.max_sectors
= 256;
1487 mutex_init(&nbd
->config_lock
);
1488 refcount_set(&nbd
->config_refs
, 0);
1489 refcount_set(&nbd
->refs
, 1);
1490 INIT_LIST_HEAD(&nbd
->list
);
1491 disk
->major
= NBD_MAJOR
;
1492 disk
->first_minor
= index
<< part_shift
;
1493 disk
->fops
= &nbd_fops
;
1494 disk
->private_data
= nbd
;
1495 sprintf(disk
->disk_name
, "nbd%d", index
);
1497 nbd_total_devices
++;
1501 blk_mq_free_tag_set(&nbd
->tag_set
);
1503 idr_remove(&nbd_index_idr
, index
);
1512 static int find_free_cb(int id
, void *ptr
, void *data
)
1514 struct nbd_device
*nbd
= ptr
;
1515 struct nbd_device
**found
= data
;
1517 if (!refcount_read(&nbd
->config_refs
)) {
1524 /* Netlink interface. */
1525 static struct nla_policy nbd_attr_policy
[NBD_ATTR_MAX
+ 1] = {
1526 [NBD_ATTR_INDEX
] = { .type
= NLA_U32
},
1527 [NBD_ATTR_SIZE_BYTES
] = { .type
= NLA_U64
},
1528 [NBD_ATTR_BLOCK_SIZE_BYTES
] = { .type
= NLA_U64
},
1529 [NBD_ATTR_TIMEOUT
] = { .type
= NLA_U64
},
1530 [NBD_ATTR_SERVER_FLAGS
] = { .type
= NLA_U64
},
1531 [NBD_ATTR_CLIENT_FLAGS
] = { .type
= NLA_U64
},
1532 [NBD_ATTR_SOCKETS
] = { .type
= NLA_NESTED
},
1533 [NBD_ATTR_DEAD_CONN_TIMEOUT
] = { .type
= NLA_U64
},
1534 [NBD_ATTR_DEVICE_LIST
] = { .type
= NLA_NESTED
},
1537 static struct nla_policy nbd_sock_policy
[NBD_SOCK_MAX
+ 1] = {
1538 [NBD_SOCK_FD
] = { .type
= NLA_U32
},
1541 /* We don't use this right now since we don't parse the incoming list, but we
1542 * still want it here so userspace knows what to expect.
1544 static struct nla_policy
__attribute__((unused
))
1545 nbd_device_policy
[NBD_DEVICE_ATTR_MAX
+ 1] = {
1546 [NBD_DEVICE_INDEX
] = { .type
= NLA_U32
},
1547 [NBD_DEVICE_CONNECTED
] = { .type
= NLA_U8
},
1550 static int nbd_genl_connect(struct sk_buff
*skb
, struct genl_info
*info
)
1552 struct nbd_device
*nbd
= NULL
;
1553 struct nbd_config
*config
;
1556 bool put_dev
= false;
1558 if (!netlink_capable(skb
, CAP_SYS_ADMIN
))
1561 if (info
->attrs
[NBD_ATTR_INDEX
])
1562 index
= nla_get_u32(info
->attrs
[NBD_ATTR_INDEX
]);
1563 if (!info
->attrs
[NBD_ATTR_SOCKETS
]) {
1564 printk(KERN_ERR
"nbd: must specify at least one socket\n");
1567 if (!info
->attrs
[NBD_ATTR_SIZE_BYTES
]) {
1568 printk(KERN_ERR
"nbd: must specify a size in bytes for the device\n");
1572 mutex_lock(&nbd_index_mutex
);
1574 ret
= idr_for_each(&nbd_index_idr
, &find_free_cb
, &nbd
);
1577 new_index
= nbd_dev_add(-1);
1578 if (new_index
< 0) {
1579 mutex_unlock(&nbd_index_mutex
);
1580 printk(KERN_ERR
"nbd: failed to add new device\n");
1583 nbd
= idr_find(&nbd_index_idr
, new_index
);
1586 nbd
= idr_find(&nbd_index_idr
, index
);
1588 ret
= nbd_dev_add(index
);
1590 mutex_unlock(&nbd_index_mutex
);
1591 printk(KERN_ERR
"nbd: failed to add new device\n");
1594 nbd
= idr_find(&nbd_index_idr
, index
);
1598 printk(KERN_ERR
"nbd: couldn't find device at index %d\n",
1600 mutex_unlock(&nbd_index_mutex
);
1603 if (!refcount_inc_not_zero(&nbd
->refs
)) {
1604 mutex_unlock(&nbd_index_mutex
);
1607 printk(KERN_ERR
"nbd: device at index %d is going down\n",
1611 mutex_unlock(&nbd_index_mutex
);
1613 mutex_lock(&nbd
->config_lock
);
1614 if (refcount_read(&nbd
->config_refs
)) {
1615 mutex_unlock(&nbd
->config_lock
);
1619 printk(KERN_ERR
"nbd: nbd%d already in use\n", index
);
1622 if (WARN_ON(nbd
->config
)) {
1623 mutex_unlock(&nbd
->config_lock
);
1627 config
= nbd
->config
= nbd_alloc_config();
1629 mutex_unlock(&nbd
->config_lock
);
1631 printk(KERN_ERR
"nbd: couldn't allocate config\n");
1634 refcount_set(&nbd
->config_refs
, 1);
1635 set_bit(NBD_BOUND
, &config
->runtime_flags
);
1637 if (info
->attrs
[NBD_ATTR_SIZE_BYTES
]) {
1638 u64 bytes
= nla_get_u64(info
->attrs
[NBD_ATTR_SIZE_BYTES
]);
1639 nbd_size_set(nbd
, config
->blksize
,
1640 div64_u64(bytes
, config
->blksize
));
1642 if (info
->attrs
[NBD_ATTR_BLOCK_SIZE_BYTES
]) {
1644 nla_get_u64(info
->attrs
[NBD_ATTR_BLOCK_SIZE_BYTES
]);
1645 nbd_size_set(nbd
, bsize
, div64_u64(config
->bytesize
, bsize
));
1647 if (info
->attrs
[NBD_ATTR_TIMEOUT
]) {
1648 u64 timeout
= nla_get_u64(info
->attrs
[NBD_ATTR_TIMEOUT
]);
1649 nbd
->tag_set
.timeout
= timeout
* HZ
;
1650 blk_queue_rq_timeout(nbd
->disk
->queue
, timeout
* HZ
);
1652 if (info
->attrs
[NBD_ATTR_DEAD_CONN_TIMEOUT
]) {
1653 config
->dead_conn_timeout
=
1654 nla_get_u64(info
->attrs
[NBD_ATTR_DEAD_CONN_TIMEOUT
]);
1655 config
->dead_conn_timeout
*= HZ
;
1657 if (info
->attrs
[NBD_ATTR_SERVER_FLAGS
])
1659 nla_get_u64(info
->attrs
[NBD_ATTR_SERVER_FLAGS
]);
1660 if (info
->attrs
[NBD_ATTR_CLIENT_FLAGS
]) {
1661 u64 flags
= nla_get_u64(info
->attrs
[NBD_ATTR_CLIENT_FLAGS
]);
1662 if (flags
& NBD_CFLAG_DESTROY_ON_DISCONNECT
) {
1663 set_bit(NBD_DESTROY_ON_DISCONNECT
,
1664 &config
->runtime_flags
);
1669 if (info
->attrs
[NBD_ATTR_SOCKETS
]) {
1670 struct nlattr
*attr
;
1673 nla_for_each_nested(attr
, info
->attrs
[NBD_ATTR_SOCKETS
],
1675 struct nlattr
*socks
[NBD_SOCK_MAX
+1];
1677 if (nla_type(attr
) != NBD_SOCK_ITEM
) {
1678 printk(KERN_ERR
"nbd: socks must be embedded in a SOCK_ITEM attr\n");
1682 ret
= nla_parse_nested(socks
, NBD_SOCK_MAX
, attr
,
1683 nbd_sock_policy
, info
->extack
);
1685 printk(KERN_ERR
"nbd: error processing sock list\n");
1689 if (!socks
[NBD_SOCK_FD
])
1691 fd
= (int)nla_get_u32(socks
[NBD_SOCK_FD
]);
1692 ret
= nbd_add_socket(nbd
, fd
, true);
1697 ret
= nbd_start_device(nbd
);
1699 mutex_unlock(&nbd
->config_lock
);
1701 set_bit(NBD_HAS_CONFIG_REF
, &config
->runtime_flags
);
1702 refcount_inc(&nbd
->config_refs
);
1703 nbd_connect_reply(info
, nbd
->index
);
1705 nbd_config_put(nbd
);
1711 static int nbd_genl_disconnect(struct sk_buff
*skb
, struct genl_info
*info
)
1713 struct nbd_device
*nbd
;
1716 if (!netlink_capable(skb
, CAP_SYS_ADMIN
))
1719 if (!info
->attrs
[NBD_ATTR_INDEX
]) {
1720 printk(KERN_ERR
"nbd: must specify an index to disconnect\n");
1723 index
= nla_get_u32(info
->attrs
[NBD_ATTR_INDEX
]);
1724 mutex_lock(&nbd_index_mutex
);
1725 nbd
= idr_find(&nbd_index_idr
, index
);
1727 mutex_unlock(&nbd_index_mutex
);
1728 printk(KERN_ERR
"nbd: couldn't find device at index %d\n",
1732 if (!refcount_inc_not_zero(&nbd
->refs
)) {
1733 mutex_unlock(&nbd_index_mutex
);
1734 printk(KERN_ERR
"nbd: device at index %d is going down\n",
1738 mutex_unlock(&nbd_index_mutex
);
1739 if (!refcount_inc_not_zero(&nbd
->config_refs
)) {
1743 mutex_lock(&nbd
->config_lock
);
1744 nbd_disconnect(nbd
);
1745 mutex_unlock(&nbd
->config_lock
);
1746 if (test_and_clear_bit(NBD_HAS_CONFIG_REF
,
1747 &nbd
->config
->runtime_flags
))
1748 nbd_config_put(nbd
);
1749 nbd_config_put(nbd
);
1754 static int nbd_genl_reconfigure(struct sk_buff
*skb
, struct genl_info
*info
)
1756 struct nbd_device
*nbd
= NULL
;
1757 struct nbd_config
*config
;
1760 bool put_dev
= false;
1762 if (!netlink_capable(skb
, CAP_SYS_ADMIN
))
1765 if (!info
->attrs
[NBD_ATTR_INDEX
]) {
1766 printk(KERN_ERR
"nbd: must specify a device to reconfigure\n");
1769 index
= nla_get_u32(info
->attrs
[NBD_ATTR_INDEX
]);
1770 mutex_lock(&nbd_index_mutex
);
1771 nbd
= idr_find(&nbd_index_idr
, index
);
1773 mutex_unlock(&nbd_index_mutex
);
1774 printk(KERN_ERR
"nbd: couldn't find a device at index %d\n",
1778 if (!refcount_inc_not_zero(&nbd
->refs
)) {
1779 mutex_unlock(&nbd_index_mutex
);
1780 printk(KERN_ERR
"nbd: device at index %d is going down\n",
1784 mutex_unlock(&nbd_index_mutex
);
1786 if (!refcount_inc_not_zero(&nbd
->config_refs
)) {
1787 dev_err(nbd_to_dev(nbd
),
1788 "not configured, cannot reconfigure\n");
1793 mutex_lock(&nbd
->config_lock
);
1794 config
= nbd
->config
;
1795 if (!test_bit(NBD_BOUND
, &config
->runtime_flags
) ||
1797 dev_err(nbd_to_dev(nbd
),
1798 "not configured, cannot reconfigure\n");
1802 if (info
->attrs
[NBD_ATTR_TIMEOUT
]) {
1803 u64 timeout
= nla_get_u64(info
->attrs
[NBD_ATTR_TIMEOUT
]);
1804 nbd
->tag_set
.timeout
= timeout
* HZ
;
1805 blk_queue_rq_timeout(nbd
->disk
->queue
, timeout
* HZ
);
1807 if (info
->attrs
[NBD_ATTR_DEAD_CONN_TIMEOUT
]) {
1808 config
->dead_conn_timeout
=
1809 nla_get_u64(info
->attrs
[NBD_ATTR_DEAD_CONN_TIMEOUT
]);
1810 config
->dead_conn_timeout
*= HZ
;
1812 if (info
->attrs
[NBD_ATTR_CLIENT_FLAGS
]) {
1813 u64 flags
= nla_get_u64(info
->attrs
[NBD_ATTR_CLIENT_FLAGS
]);
1814 if (flags
& NBD_CFLAG_DESTROY_ON_DISCONNECT
) {
1815 if (!test_and_set_bit(NBD_DESTROY_ON_DISCONNECT
,
1816 &config
->runtime_flags
))
1819 if (test_and_clear_bit(NBD_DESTROY_ON_DISCONNECT
,
1820 &config
->runtime_flags
))
1821 refcount_inc(&nbd
->refs
);
1825 if (info
->attrs
[NBD_ATTR_SOCKETS
]) {
1826 struct nlattr
*attr
;
1829 nla_for_each_nested(attr
, info
->attrs
[NBD_ATTR_SOCKETS
],
1831 struct nlattr
*socks
[NBD_SOCK_MAX
+1];
1833 if (nla_type(attr
) != NBD_SOCK_ITEM
) {
1834 printk(KERN_ERR
"nbd: socks must be embedded in a SOCK_ITEM attr\n");
1838 ret
= nla_parse_nested(socks
, NBD_SOCK_MAX
, attr
,
1839 nbd_sock_policy
, info
->extack
);
1841 printk(KERN_ERR
"nbd: error processing sock list\n");
1845 if (!socks
[NBD_SOCK_FD
])
1847 fd
= (int)nla_get_u32(socks
[NBD_SOCK_FD
]);
1848 ret
= nbd_reconnect_socket(nbd
, fd
);
1854 dev_info(nbd_to_dev(nbd
), "reconnected socket\n");
1858 mutex_unlock(&nbd
->config_lock
);
1859 nbd_config_put(nbd
);
1866 static const struct genl_ops nbd_connect_genl_ops
[] = {
1868 .cmd
= NBD_CMD_CONNECT
,
1869 .policy
= nbd_attr_policy
,
1870 .doit
= nbd_genl_connect
,
1873 .cmd
= NBD_CMD_DISCONNECT
,
1874 .policy
= nbd_attr_policy
,
1875 .doit
= nbd_genl_disconnect
,
1878 .cmd
= NBD_CMD_RECONFIGURE
,
1879 .policy
= nbd_attr_policy
,
1880 .doit
= nbd_genl_reconfigure
,
1883 .cmd
= NBD_CMD_STATUS
,
1884 .policy
= nbd_attr_policy
,
1885 .doit
= nbd_genl_status
,
1889 static const struct genl_multicast_group nbd_mcast_grps
[] = {
1890 { .name
= NBD_GENL_MCAST_GROUP_NAME
, },
1893 static struct genl_family nbd_genl_family __ro_after_init
= {
1895 .name
= NBD_GENL_FAMILY_NAME
,
1896 .version
= NBD_GENL_VERSION
,
1897 .module
= THIS_MODULE
,
1898 .ops
= nbd_connect_genl_ops
,
1899 .n_ops
= ARRAY_SIZE(nbd_connect_genl_ops
),
1900 .maxattr
= NBD_ATTR_MAX
,
1901 .mcgrps
= nbd_mcast_grps
,
1902 .n_mcgrps
= ARRAY_SIZE(nbd_mcast_grps
),
1905 static int populate_nbd_status(struct nbd_device
*nbd
, struct sk_buff
*reply
)
1907 struct nlattr
*dev_opt
;
1911 /* This is a little racey, but for status it's ok. The
1912 * reason we don't take a ref here is because we can't
1913 * take a ref in the index == -1 case as we would need
1914 * to put under the nbd_index_mutex, which could
1915 * deadlock if we are configured to remove ourselves
1916 * once we're disconnected.
1918 if (refcount_read(&nbd
->config_refs
))
1920 dev_opt
= nla_nest_start(reply
, NBD_DEVICE_ITEM
);
1923 ret
= nla_put_u32(reply
, NBD_DEVICE_INDEX
, nbd
->index
);
1926 ret
= nla_put_u8(reply
, NBD_DEVICE_CONNECTED
,
1930 nla_nest_end(reply
, dev_opt
);
1934 static int status_cb(int id
, void *ptr
, void *data
)
1936 struct nbd_device
*nbd
= ptr
;
1937 return populate_nbd_status(nbd
, (struct sk_buff
*)data
);
1940 static int nbd_genl_status(struct sk_buff
*skb
, struct genl_info
*info
)
1942 struct nlattr
*dev_list
;
1943 struct sk_buff
*reply
;
1949 if (info
->attrs
[NBD_ATTR_INDEX
])
1950 index
= nla_get_u32(info
->attrs
[NBD_ATTR_INDEX
]);
1952 mutex_lock(&nbd_index_mutex
);
1954 msg_size
= nla_total_size(nla_attr_size(sizeof(u32
)) +
1955 nla_attr_size(sizeof(u8
)));
1956 msg_size
*= (index
== -1) ? nbd_total_devices
: 1;
1958 reply
= genlmsg_new(msg_size
, GFP_KERNEL
);
1961 reply_head
= genlmsg_put_reply(reply
, info
, &nbd_genl_family
, 0,
1968 dev_list
= nla_nest_start(reply
, NBD_ATTR_DEVICE_LIST
);
1970 ret
= idr_for_each(&nbd_index_idr
, &status_cb
, reply
);
1976 struct nbd_device
*nbd
;
1977 nbd
= idr_find(&nbd_index_idr
, index
);
1979 ret
= populate_nbd_status(nbd
, reply
);
1986 nla_nest_end(reply
, dev_list
);
1987 genlmsg_end(reply
, reply_head
);
1988 genlmsg_reply(reply
, info
);
1991 mutex_unlock(&nbd_index_mutex
);
1995 static void nbd_connect_reply(struct genl_info
*info
, int index
)
1997 struct sk_buff
*skb
;
2001 skb
= genlmsg_new(nla_total_size(sizeof(u32
)), GFP_KERNEL
);
2004 msg_head
= genlmsg_put_reply(skb
, info
, &nbd_genl_family
, 0,
2010 ret
= nla_put_u32(skb
, NBD_ATTR_INDEX
, index
);
2015 genlmsg_end(skb
, msg_head
);
2016 genlmsg_reply(skb
, info
);
2019 static void nbd_mcast_index(int index
)
2021 struct sk_buff
*skb
;
2025 skb
= genlmsg_new(nla_total_size(sizeof(u32
)), GFP_KERNEL
);
2028 msg_head
= genlmsg_put(skb
, 0, 0, &nbd_genl_family
, 0,
2034 ret
= nla_put_u32(skb
, NBD_ATTR_INDEX
, index
);
2039 genlmsg_end(skb
, msg_head
);
2040 genlmsg_multicast(&nbd_genl_family
, skb
, 0, 0, GFP_KERNEL
);
2043 static void nbd_dead_link_work(struct work_struct
*work
)
2045 struct link_dead_args
*args
= container_of(work
, struct link_dead_args
,
2047 nbd_mcast_index(args
->index
);
2051 static int __init
nbd_init(void)
2055 BUILD_BUG_ON(sizeof(struct nbd_request
) != 28);
2058 printk(KERN_ERR
"nbd: max_part must be >= 0\n");
2064 part_shift
= fls(max_part
);
2067 * Adjust max_part according to part_shift as it is exported
2068 * to user space so that user can know the max number of
2069 * partition kernel should be able to manage.
2071 * Note that -1 is required because partition 0 is reserved
2072 * for the whole disk.
2074 max_part
= (1UL << part_shift
) - 1;
2077 if ((1UL << part_shift
) > DISK_MAX_PARTS
)
2080 if (nbds_max
> 1UL << (MINORBITS
- part_shift
))
2082 recv_workqueue
= alloc_workqueue("knbd-recv",
2083 WQ_MEM_RECLAIM
| WQ_HIGHPRI
, 0);
2084 if (!recv_workqueue
)
2087 if (register_blkdev(NBD_MAJOR
, "nbd")) {
2088 destroy_workqueue(recv_workqueue
);
2092 if (genl_register_family(&nbd_genl_family
)) {
2093 unregister_blkdev(NBD_MAJOR
, "nbd");
2094 destroy_workqueue(recv_workqueue
);
2099 mutex_lock(&nbd_index_mutex
);
2100 for (i
= 0; i
< nbds_max
; i
++)
2102 mutex_unlock(&nbd_index_mutex
);
2106 static int nbd_exit_cb(int id
, void *ptr
, void *data
)
2108 struct list_head
*list
= (struct list_head
*)data
;
2109 struct nbd_device
*nbd
= ptr
;
2111 list_add_tail(&nbd
->list
, list
);
2115 static void __exit
nbd_cleanup(void)
2117 struct nbd_device
*nbd
;
2118 LIST_HEAD(del_list
);
2122 mutex_lock(&nbd_index_mutex
);
2123 idr_for_each(&nbd_index_idr
, &nbd_exit_cb
, &del_list
);
2124 mutex_unlock(&nbd_index_mutex
);
2126 while (!list_empty(&del_list
)) {
2127 nbd
= list_first_entry(&del_list
, struct nbd_device
, list
);
2128 list_del_init(&nbd
->list
);
2129 if (refcount_read(&nbd
->refs
) != 1)
2130 printk(KERN_ERR
"nbd: possibly leaking a device\n");
2134 idr_destroy(&nbd_index_idr
);
2135 genl_unregister_family(&nbd_genl_family
);
2136 destroy_workqueue(recv_workqueue
);
2137 unregister_blkdev(NBD_MAJOR
, "nbd");
2140 module_init(nbd_init
);
2141 module_exit(nbd_cleanup
);
2143 MODULE_DESCRIPTION("Network Block Device");
2144 MODULE_LICENSE("GPL");
2146 module_param(nbds_max
, int, 0444);
2147 MODULE_PARM_DESC(nbds_max
, "number of network block devices to initialize (default: 16)");
2148 module_param(max_part
, int, 0444);
2149 MODULE_PARM_DESC(max_part
, "number of partitions per device (default: 16)");