1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Network block device - make block devices work over TCP
5 * Note that you can not swap over this thing, yet. Seems to work but
6 * deadlocks sometimes - you can not swap over TCP in general.
8 * Copyright 1997-2000, 2008 Pavel Machek <pavel@ucw.cz>
9 * Parts copyright 2001 Steven Whitehouse <steve@chygwyn.com>
11 * (part of code stolen from loop.c)
14 #define pr_fmt(fmt) "nbd: " fmt
16 #include <linux/major.h>
18 #include <linux/blkdev.h>
19 #include <linux/module.h>
20 #include <linux/init.h>
21 #include <linux/sched.h>
22 #include <linux/sched/mm.h>
24 #include <linux/bio.h>
25 #include <linux/stat.h>
26 #include <linux/errno.h>
27 #include <linux/file.h>
28 #include <linux/ioctl.h>
29 #include <linux/mutex.h>
30 #include <linux/compiler.h>
31 #include <linux/completion.h>
32 #include <linux/err.h>
33 #include <linux/kernel.h>
34 #include <linux/slab.h>
36 #include <linux/net.h>
37 #include <linux/kthread.h>
38 #include <linux/types.h>
39 #include <linux/debugfs.h>
40 #include <linux/blk-mq.h>
42 #include <linux/uaccess.h>
43 #include <asm/types.h>
45 #include <linux/nbd.h>
46 #include <linux/nbd-netlink.h>
47 #include <net/genetlink.h>
49 #define CREATE_TRACE_POINTS
50 #include <trace/events/nbd.h>
52 static DEFINE_IDR(nbd_index_idr);
53 static DEFINE_MUTEX(nbd_index_mutex);
54 static struct workqueue_struct *nbd_del_wq;
55 static int nbd_total_devices = 0;
60 struct request *pending;
67 struct recv_thread_args {
68 struct work_struct work;
69 struct nbd_device *nbd;
73 struct link_dead_args {
74 struct work_struct work;
78 #define NBD_RT_TIMEDOUT 0
79 #define NBD_RT_DISCONNECT_REQUESTED 1
80 #define NBD_RT_DISCONNECTED 2
81 #define NBD_RT_HAS_PID_FILE 3
82 #define NBD_RT_HAS_CONFIG_REF 4
83 #define NBD_RT_BOUND 5
84 #define NBD_RT_DISCONNECT_ON_CLOSE 6
85 #define NBD_RT_HAS_BACKEND_FILE 7
87 #define NBD_DESTROY_ON_DISCONNECT 0
88 #define NBD_DISCONNECT_REQUESTED 1
92 unsigned long runtime_flags;
93 u64 dead_conn_timeout;
95 struct nbd_sock **socks;
97 atomic_t live_connections;
98 wait_queue_head_t conn_wait;
100 atomic_t recv_threads;
101 wait_queue_head_t recv_wq;
102 unsigned int blksize_bits;
104 #if IS_ENABLED(CONFIG_DEBUG_FS)
105 struct dentry *dbg_dir;
109 static inline unsigned int nbd_blksize(struct nbd_config *config)
111 return 1u << config->blksize_bits;
115 struct blk_mq_tag_set tag_set;
118 refcount_t config_refs;
120 struct nbd_config *config;
121 struct mutex config_lock;
122 struct gendisk *disk;
123 struct workqueue_struct *recv_workq;
124 struct work_struct remove_work;
126 struct list_head list;
127 struct task_struct *task_setup;
130 pid_t pid; /* pid of nbd-client, if attached */
135 #define NBD_CMD_REQUEUED 1
137 * This flag will be set if nbd_queue_rq() succeed, and will be checked and
138 * cleared in completion. Both setting and clearing of the flag are protected
141 #define NBD_CMD_INFLIGHT 2
144 struct nbd_device *nbd;
154 #if IS_ENABLED(CONFIG_DEBUG_FS)
155 static struct dentry *nbd_dbg_dir;
158 #define nbd_name(nbd) ((nbd)->disk->disk_name)
160 #define NBD_DEF_BLKSIZE_BITS 10
162 static unsigned int nbds_max = 16;
163 static int max_part = 16;
164 static int part_shift;
166 static int nbd_dev_dbg_init(struct nbd_device *nbd);
167 static void nbd_dev_dbg_close(struct nbd_device *nbd);
168 static void nbd_config_put(struct nbd_device *nbd);
169 static void nbd_connect_reply(struct genl_info *info, int index);
170 static int nbd_genl_status(struct sk_buff *skb, struct genl_info *info);
171 static void nbd_dead_link_work(struct work_struct *work);
172 static void nbd_disconnect_and_put(struct nbd_device *nbd);
174 static inline struct device *nbd_to_dev(struct nbd_device *nbd)
176 return disk_to_dev(nbd->disk);
179 static void nbd_requeue_cmd(struct nbd_cmd *cmd)
181 struct request *req = blk_mq_rq_from_pdu(cmd);
183 if (!test_and_set_bit(NBD_CMD_REQUEUED, &cmd->flags))
184 blk_mq_requeue_request(req, true);
187 #define NBD_COOKIE_BITS 32
189 static u64 nbd_cmd_handle(struct nbd_cmd *cmd)
191 struct request *req = blk_mq_rq_from_pdu(cmd);
192 u32 tag = blk_mq_unique_tag(req);
193 u64 cookie = cmd->cmd_cookie;
195 return (cookie << NBD_COOKIE_BITS) | tag;
198 static u32 nbd_handle_to_tag(u64 handle)
203 static u32 nbd_handle_to_cookie(u64 handle)
205 return (u32)(handle >> NBD_COOKIE_BITS);
208 static const char *nbdcmd_to_ascii(int cmd)
211 case NBD_CMD_READ: return "read";
212 case NBD_CMD_WRITE: return "write";
213 case NBD_CMD_DISC: return "disconnect";
214 case NBD_CMD_FLUSH: return "flush";
215 case NBD_CMD_TRIM: return "trim/discard";
220 static ssize_t pid_show(struct device *dev,
221 struct device_attribute *attr, char *buf)
223 struct gendisk *disk = dev_to_disk(dev);
224 struct nbd_device *nbd = (struct nbd_device *)disk->private_data;
226 return sprintf(buf, "%d\n", nbd->pid);
229 static const struct device_attribute pid_attr = {
230 .attr = { .name = "pid", .mode = 0444},
234 static ssize_t backend_show(struct device *dev,
235 struct device_attribute *attr, char *buf)
237 struct gendisk *disk = dev_to_disk(dev);
238 struct nbd_device *nbd = (struct nbd_device *)disk->private_data;
240 return sprintf(buf, "%s\n", nbd->backend ?: "");
243 static const struct device_attribute backend_attr = {
244 .attr = { .name = "backend", .mode = 0444},
245 .show = backend_show,
248 static void nbd_dev_remove(struct nbd_device *nbd)
250 struct gendisk *disk = nbd->disk;
254 blk_mq_free_tag_set(&nbd->tag_set);
257 * Remove from idr after del_gendisk() completes, so if the same ID is
258 * reused, the following add_disk() will succeed.
260 mutex_lock(&nbd_index_mutex);
261 idr_remove(&nbd_index_idr, nbd->index);
262 mutex_unlock(&nbd_index_mutex);
263 destroy_workqueue(nbd->recv_workq);
267 static void nbd_dev_remove_work(struct work_struct *work)
269 nbd_dev_remove(container_of(work, struct nbd_device, remove_work));
272 static void nbd_put(struct nbd_device *nbd)
274 if (!refcount_dec_and_test(&nbd->refs))
277 /* Call del_gendisk() asynchrounously to prevent deadlock */
278 if (test_bit(NBD_DESTROY_ON_DISCONNECT, &nbd->flags))
279 queue_work(nbd_del_wq, &nbd->remove_work);
284 static int nbd_disconnected(struct nbd_config *config)
286 return test_bit(NBD_RT_DISCONNECTED, &config->runtime_flags) ||
287 test_bit(NBD_RT_DISCONNECT_REQUESTED, &config->runtime_flags);
290 static void nbd_mark_nsock_dead(struct nbd_device *nbd, struct nbd_sock *nsock,
293 if (!nsock->dead && notify && !nbd_disconnected(nbd->config)) {
294 struct link_dead_args *args;
295 args = kmalloc(sizeof(struct link_dead_args), GFP_NOIO);
297 INIT_WORK(&args->work, nbd_dead_link_work);
298 args->index = nbd->index;
299 queue_work(system_wq, &args->work);
303 kernel_sock_shutdown(nsock->sock, SHUT_RDWR);
304 if (atomic_dec_return(&nbd->config->live_connections) == 0) {
305 if (test_and_clear_bit(NBD_RT_DISCONNECT_REQUESTED,
306 &nbd->config->runtime_flags)) {
307 set_bit(NBD_RT_DISCONNECTED,
308 &nbd->config->runtime_flags);
309 dev_info(nbd_to_dev(nbd),
310 "Disconnected due to user request.\n");
315 nsock->pending = NULL;
319 static int nbd_set_size(struct nbd_device *nbd, loff_t bytesize,
323 blksize = 1u << NBD_DEF_BLKSIZE_BITS;
325 if (blk_validate_block_size(blksize))
328 nbd->config->bytesize = bytesize;
329 nbd->config->blksize_bits = __ffs(blksize);
334 if (nbd->config->flags & NBD_FLAG_SEND_TRIM) {
335 nbd->disk->queue->limits.discard_granularity = blksize;
336 blk_queue_max_discard_sectors(nbd->disk->queue, UINT_MAX);
338 blk_queue_logical_block_size(nbd->disk->queue, blksize);
339 blk_queue_physical_block_size(nbd->disk->queue, blksize);
342 set_bit(GD_NEED_PART_SCAN, &nbd->disk->state);
343 if (!set_capacity_and_notify(nbd->disk, bytesize >> 9))
344 kobject_uevent(&nbd_to_dev(nbd)->kobj, KOBJ_CHANGE);
348 static void nbd_complete_rq(struct request *req)
350 struct nbd_cmd *cmd = blk_mq_rq_to_pdu(req);
352 dev_dbg(nbd_to_dev(cmd->nbd), "request %p: %s\n", req,
353 cmd->status ? "failed" : "done");
355 blk_mq_end_request(req, cmd->status);
359 * Forcibly shutdown the socket causing all listeners to error
361 static void sock_shutdown(struct nbd_device *nbd)
363 struct nbd_config *config = nbd->config;
366 if (config->num_connections == 0)
368 if (test_and_set_bit(NBD_RT_DISCONNECTED, &config->runtime_flags))
371 for (i = 0; i < config->num_connections; i++) {
372 struct nbd_sock *nsock = config->socks[i];
373 mutex_lock(&nsock->tx_lock);
374 nbd_mark_nsock_dead(nbd, nsock, 0);
375 mutex_unlock(&nsock->tx_lock);
377 dev_warn(disk_to_dev(nbd->disk), "shutting down sockets\n");
380 static u32 req_to_nbd_cmd_type(struct request *req)
382 switch (req_op(req)) {
386 return NBD_CMD_FLUSH;
388 return NBD_CMD_WRITE;
396 static enum blk_eh_timer_return nbd_xmit_timeout(struct request *req)
398 struct nbd_cmd *cmd = blk_mq_rq_to_pdu(req);
399 struct nbd_device *nbd = cmd->nbd;
400 struct nbd_config *config;
402 if (!mutex_trylock(&cmd->lock))
403 return BLK_EH_RESET_TIMER;
405 if (!test_bit(NBD_CMD_INFLIGHT, &cmd->flags)) {
406 mutex_unlock(&cmd->lock);
410 if (!refcount_inc_not_zero(&nbd->config_refs)) {
411 cmd->status = BLK_STS_TIMEOUT;
412 __clear_bit(NBD_CMD_INFLIGHT, &cmd->flags);
413 mutex_unlock(&cmd->lock);
416 config = nbd->config;
418 if (config->num_connections > 1 ||
419 (config->num_connections == 1 && nbd->tag_set.timeout)) {
420 dev_err_ratelimited(nbd_to_dev(nbd),
421 "Connection timed out, retrying (%d/%d alive)\n",
422 atomic_read(&config->live_connections),
423 config->num_connections);
425 * Hooray we have more connections, requeue this IO, the submit
426 * path will put it on a real connection. Or if only one
427 * connection is configured, the submit path will wait util
428 * a new connection is reconfigured or util dead timeout.
431 if (cmd->index < config->num_connections) {
432 struct nbd_sock *nsock =
433 config->socks[cmd->index];
434 mutex_lock(&nsock->tx_lock);
435 /* We can have multiple outstanding requests, so
436 * we don't want to mark the nsock dead if we've
437 * already reconnected with a new socket, so
438 * only mark it dead if its the same socket we
441 if (cmd->cookie == nsock->cookie)
442 nbd_mark_nsock_dead(nbd, nsock, 1);
443 mutex_unlock(&nsock->tx_lock);
445 mutex_unlock(&cmd->lock);
446 nbd_requeue_cmd(cmd);
452 if (!nbd->tag_set.timeout) {
454 * Userspace sets timeout=0 to disable socket disconnection,
455 * so just warn and reset the timer.
457 struct nbd_sock *nsock = config->socks[cmd->index];
459 dev_info(nbd_to_dev(nbd), "Possible stuck request %p: control (%s@%llu,%uB). Runtime %u seconds\n",
460 req, nbdcmd_to_ascii(req_to_nbd_cmd_type(req)),
461 (unsigned long long)blk_rq_pos(req) << 9,
462 blk_rq_bytes(req), (req->timeout / HZ) * cmd->retries);
464 mutex_lock(&nsock->tx_lock);
465 if (cmd->cookie != nsock->cookie) {
466 nbd_requeue_cmd(cmd);
467 mutex_unlock(&nsock->tx_lock);
468 mutex_unlock(&cmd->lock);
472 mutex_unlock(&nsock->tx_lock);
473 mutex_unlock(&cmd->lock);
475 return BLK_EH_RESET_TIMER;
478 dev_err_ratelimited(nbd_to_dev(nbd), "Connection timed out\n");
479 set_bit(NBD_RT_TIMEDOUT, &config->runtime_flags);
480 cmd->status = BLK_STS_IOERR;
481 __clear_bit(NBD_CMD_INFLIGHT, &cmd->flags);
482 mutex_unlock(&cmd->lock);
486 blk_mq_complete_request(req);
491 * Send or receive packet. Return a positive value on success and
492 * negtive value on failue, and never return 0.
494 static int sock_xmit(struct nbd_device *nbd, int index, int send,
495 struct iov_iter *iter, int msg_flags, int *sent)
497 struct nbd_config *config = nbd->config;
498 struct socket *sock = config->socks[index]->sock;
501 unsigned int noreclaim_flag;
503 if (unlikely(!sock)) {
504 dev_err_ratelimited(disk_to_dev(nbd->disk),
505 "Attempted %s on closed socket in sock_xmit\n",
506 (send ? "send" : "recv"));
510 msg.msg_iter = *iter;
512 noreclaim_flag = memalloc_noreclaim_save();
514 sock->sk->sk_allocation = GFP_NOIO | __GFP_MEMALLOC;
517 msg.msg_control = NULL;
518 msg.msg_controllen = 0;
519 msg.msg_flags = msg_flags | MSG_NOSIGNAL;
522 result = sock_sendmsg(sock, &msg);
524 result = sock_recvmsg(sock, &msg, msg.msg_flags);
528 result = -EPIPE; /* short read */
533 } while (msg_data_left(&msg));
535 memalloc_noreclaim_restore(noreclaim_flag);
541 * Different settings for sk->sk_sndtimeo can result in different return values
542 * if there is a signal pending when we enter sendmsg, because reasons?
544 static inline int was_interrupted(int result)
546 return result == -ERESTARTSYS || result == -EINTR;
549 /* always call with the tx_lock held */
550 static int nbd_send_cmd(struct nbd_device *nbd, struct nbd_cmd *cmd, int index)
552 struct request *req = blk_mq_rq_from_pdu(cmd);
553 struct nbd_config *config = nbd->config;
554 struct nbd_sock *nsock = config->socks[index];
556 struct nbd_request request = {.magic = htonl(NBD_REQUEST_MAGIC)};
557 struct kvec iov = {.iov_base = &request, .iov_len = sizeof(request)};
558 struct iov_iter from;
559 unsigned long size = blk_rq_bytes(req);
563 u32 nbd_cmd_flags = 0;
564 int sent = nsock->sent, skip = 0;
566 iov_iter_kvec(&from, WRITE, &iov, 1, sizeof(request));
568 type = req_to_nbd_cmd_type(req);
572 if (rq_data_dir(req) == WRITE &&
573 (config->flags & NBD_FLAG_READ_ONLY)) {
574 dev_err_ratelimited(disk_to_dev(nbd->disk),
575 "Write on read-only\n");
579 if (req->cmd_flags & REQ_FUA)
580 nbd_cmd_flags |= NBD_CMD_FLAG_FUA;
582 /* We did a partial send previously, and we at least sent the whole
583 * request struct, so just go and send the rest of the pages in the
587 if (sent >= sizeof(request)) {
588 skip = sent - sizeof(request);
590 /* initialize handle for tracing purposes */
591 handle = nbd_cmd_handle(cmd);
595 iov_iter_advance(&from, sent);
600 cmd->cookie = nsock->cookie;
602 request.type = htonl(type | nbd_cmd_flags);
603 if (type != NBD_CMD_FLUSH) {
604 request.from = cpu_to_be64((u64)blk_rq_pos(req) << 9);
605 request.len = htonl(size);
607 handle = nbd_cmd_handle(cmd);
608 memcpy(request.handle, &handle, sizeof(handle));
610 trace_nbd_send_request(&request, nbd->index, blk_mq_rq_from_pdu(cmd));
612 dev_dbg(nbd_to_dev(nbd), "request %p: sending control (%s@%llu,%uB)\n",
613 req, nbdcmd_to_ascii(type),
614 (unsigned long long)blk_rq_pos(req) << 9, blk_rq_bytes(req));
615 result = sock_xmit(nbd, index, 1, &from,
616 (type == NBD_CMD_WRITE) ? MSG_MORE : 0, &sent);
617 trace_nbd_header_sent(req, handle);
619 if (was_interrupted(result)) {
620 /* If we havne't sent anything we can just return BUSY,
621 * however if we have sent something we need to make
622 * sure we only allow this req to be sent until we are
626 nsock->pending = req;
629 set_bit(NBD_CMD_REQUEUED, &cmd->flags);
630 return BLK_STS_RESOURCE;
632 dev_err_ratelimited(disk_to_dev(nbd->disk),
633 "Send control failed (result %d)\n", result);
637 if (type != NBD_CMD_WRITE)
642 struct bio *next = bio->bi_next;
643 struct bvec_iter iter;
646 bio_for_each_segment(bvec, bio, iter) {
647 bool is_last = !next && bio_iter_last(bvec, iter);
648 int flags = is_last ? 0 : MSG_MORE;
650 dev_dbg(nbd_to_dev(nbd), "request %p: sending %d bytes data\n",
652 iov_iter_bvec(&from, WRITE, &bvec, 1, bvec.bv_len);
654 if (skip >= iov_iter_count(&from)) {
655 skip -= iov_iter_count(&from);
658 iov_iter_advance(&from, skip);
661 result = sock_xmit(nbd, index, 1, &from, flags, &sent);
663 if (was_interrupted(result)) {
664 /* We've already sent the header, we
665 * have no choice but to set pending and
668 nsock->pending = req;
670 set_bit(NBD_CMD_REQUEUED, &cmd->flags);
671 return BLK_STS_RESOURCE;
673 dev_err(disk_to_dev(nbd->disk),
674 "Send data failed (result %d)\n",
679 * The completion might already have come in,
680 * so break for the last one instead of letting
681 * the iterator do it. This prevents use-after-free
690 trace_nbd_payload_sent(req, handle);
691 nsock->pending = NULL;
696 static int nbd_read_reply(struct nbd_device *nbd, int index,
697 struct nbd_reply *reply)
699 struct kvec iov = {.iov_base = reply, .iov_len = sizeof(*reply)};
704 iov_iter_kvec(&to, READ, &iov, 1, sizeof(*reply));
705 result = sock_xmit(nbd, index, 0, &to, MSG_WAITALL, NULL);
707 if (!nbd_disconnected(nbd->config))
708 dev_err(disk_to_dev(nbd->disk),
709 "Receive control failed (result %d)\n", result);
713 if (ntohl(reply->magic) != NBD_REPLY_MAGIC) {
714 dev_err(disk_to_dev(nbd->disk), "Wrong magic (0x%lx)\n",
715 (unsigned long)ntohl(reply->magic));
722 /* NULL returned = something went wrong, inform userspace */
723 static struct nbd_cmd *nbd_handle_reply(struct nbd_device *nbd, int index,
724 struct nbd_reply *reply)
728 struct request *req = NULL;
734 memcpy(&handle, reply->handle, sizeof(handle));
735 tag = nbd_handle_to_tag(handle);
736 hwq = blk_mq_unique_tag_to_hwq(tag);
737 if (hwq < nbd->tag_set.nr_hw_queues)
738 req = blk_mq_tag_to_rq(nbd->tag_set.tags[hwq],
739 blk_mq_unique_tag_to_tag(tag));
740 if (!req || !blk_mq_request_started(req)) {
741 dev_err(disk_to_dev(nbd->disk), "Unexpected reply (%d) %p\n",
743 return ERR_PTR(-ENOENT);
745 trace_nbd_header_received(req, handle);
746 cmd = blk_mq_rq_to_pdu(req);
748 mutex_lock(&cmd->lock);
749 if (!test_bit(NBD_CMD_INFLIGHT, &cmd->flags)) {
750 dev_err(disk_to_dev(nbd->disk), "Suspicious reply %d (status %u flags %lu)",
751 tag, cmd->status, cmd->flags);
755 if (cmd->index != index) {
756 dev_err(disk_to_dev(nbd->disk), "Unexpected reply %d from different sock %d (expected %d)",
757 tag, index, cmd->index);
761 if (cmd->cmd_cookie != nbd_handle_to_cookie(handle)) {
762 dev_err(disk_to_dev(nbd->disk), "Double reply on req %p, cmd_cookie %u, handle cookie %u\n",
763 req, cmd->cmd_cookie, nbd_handle_to_cookie(handle));
767 if (cmd->status != BLK_STS_OK) {
768 dev_err(disk_to_dev(nbd->disk), "Command already handled %p\n",
773 if (test_bit(NBD_CMD_REQUEUED, &cmd->flags)) {
774 dev_err(disk_to_dev(nbd->disk), "Raced with timeout on req %p\n",
779 if (ntohl(reply->error)) {
780 dev_err(disk_to_dev(nbd->disk), "Other side returned error (%d)\n",
781 ntohl(reply->error));
782 cmd->status = BLK_STS_IOERR;
786 dev_dbg(nbd_to_dev(nbd), "request %p: got reply\n", req);
787 if (rq_data_dir(req) != WRITE) {
788 struct req_iterator iter;
792 rq_for_each_segment(bvec, req, iter) {
793 iov_iter_bvec(&to, READ, &bvec, 1, bvec.bv_len);
794 result = sock_xmit(nbd, index, 0, &to, MSG_WAITALL, NULL);
796 dev_err(disk_to_dev(nbd->disk), "Receive data failed (result %d)\n",
799 * If we've disconnected, we need to make sure we
800 * complete this request, otherwise error out
801 * and let the timeout stuff handle resubmitting
802 * this request onto another connection.
804 if (nbd_disconnected(nbd->config)) {
805 cmd->status = BLK_STS_IOERR;
811 dev_dbg(nbd_to_dev(nbd), "request %p: got %d bytes data\n",
816 trace_nbd_payload_received(req, handle);
817 mutex_unlock(&cmd->lock);
818 return ret ? ERR_PTR(ret) : cmd;
821 static void recv_work(struct work_struct *work)
823 struct recv_thread_args *args = container_of(work,
824 struct recv_thread_args,
826 struct nbd_device *nbd = args->nbd;
827 struct nbd_config *config = nbd->config;
828 struct request_queue *q = nbd->disk->queue;
829 struct nbd_sock *nsock;
834 struct nbd_reply reply;
836 if (nbd_read_reply(nbd, args->index, &reply))
840 * Grab .q_usage_counter so request pool won't go away, then no
841 * request use-after-free is possible during nbd_handle_reply().
842 * If queue is frozen, there won't be any inflight requests, we
843 * needn't to handle the incoming garbage message.
845 if (!percpu_ref_tryget(&q->q_usage_counter)) {
846 dev_err(disk_to_dev(nbd->disk), "%s: no io inflight\n",
851 cmd = nbd_handle_reply(nbd, args->index, &reply);
853 percpu_ref_put(&q->q_usage_counter);
857 rq = blk_mq_rq_from_pdu(cmd);
858 if (likely(!blk_should_fake_timeout(rq->q))) {
861 mutex_lock(&cmd->lock);
862 complete = __test_and_clear_bit(NBD_CMD_INFLIGHT,
864 mutex_unlock(&cmd->lock);
866 blk_mq_complete_request(rq);
868 percpu_ref_put(&q->q_usage_counter);
871 nsock = config->socks[args->index];
872 mutex_lock(&nsock->tx_lock);
873 nbd_mark_nsock_dead(nbd, nsock, 1);
874 mutex_unlock(&nsock->tx_lock);
877 atomic_dec(&config->recv_threads);
878 wake_up(&config->recv_wq);
882 static bool nbd_clear_req(struct request *req, void *data)
884 struct nbd_cmd *cmd = blk_mq_rq_to_pdu(req);
886 /* don't abort one completed request */
887 if (blk_mq_request_completed(req))
890 mutex_lock(&cmd->lock);
891 if (!__test_and_clear_bit(NBD_CMD_INFLIGHT, &cmd->flags)) {
892 mutex_unlock(&cmd->lock);
895 cmd->status = BLK_STS_IOERR;
896 mutex_unlock(&cmd->lock);
898 blk_mq_complete_request(req);
902 static void nbd_clear_que(struct nbd_device *nbd)
904 blk_mq_quiesce_queue(nbd->disk->queue);
905 blk_mq_tagset_busy_iter(&nbd->tag_set, nbd_clear_req, NULL);
906 blk_mq_unquiesce_queue(nbd->disk->queue);
907 dev_dbg(disk_to_dev(nbd->disk), "queue cleared\n");
910 static int find_fallback(struct nbd_device *nbd, int index)
912 struct nbd_config *config = nbd->config;
914 struct nbd_sock *nsock = config->socks[index];
915 int fallback = nsock->fallback_index;
917 if (test_bit(NBD_RT_DISCONNECTED, &config->runtime_flags))
920 if (config->num_connections <= 1) {
921 dev_err_ratelimited(disk_to_dev(nbd->disk),
922 "Dead connection, failed to find a fallback\n");
926 if (fallback >= 0 && fallback < config->num_connections &&
927 !config->socks[fallback]->dead)
930 if (nsock->fallback_index < 0 ||
931 nsock->fallback_index >= config->num_connections ||
932 config->socks[nsock->fallback_index]->dead) {
934 for (i = 0; i < config->num_connections; i++) {
937 if (!config->socks[i]->dead) {
942 nsock->fallback_index = new_index;
944 dev_err_ratelimited(disk_to_dev(nbd->disk),
945 "Dead connection, failed to find a fallback\n");
949 new_index = nsock->fallback_index;
953 static int wait_for_reconnect(struct nbd_device *nbd)
955 struct nbd_config *config = nbd->config;
956 if (!config->dead_conn_timeout)
959 if (!wait_event_timeout(config->conn_wait,
960 test_bit(NBD_RT_DISCONNECTED,
961 &config->runtime_flags) ||
962 atomic_read(&config->live_connections) > 0,
963 config->dead_conn_timeout))
966 return !test_bit(NBD_RT_DISCONNECTED, &config->runtime_flags);
969 static int nbd_handle_cmd(struct nbd_cmd *cmd, int index)
971 struct request *req = blk_mq_rq_from_pdu(cmd);
972 struct nbd_device *nbd = cmd->nbd;
973 struct nbd_config *config;
974 struct nbd_sock *nsock;
977 if (!refcount_inc_not_zero(&nbd->config_refs)) {
978 dev_err_ratelimited(disk_to_dev(nbd->disk),
979 "Socks array is empty\n");
982 config = nbd->config;
984 if (index >= config->num_connections) {
985 dev_err_ratelimited(disk_to_dev(nbd->disk),
986 "Attempted send on invalid socket\n");
990 cmd->status = BLK_STS_OK;
992 nsock = config->socks[index];
993 mutex_lock(&nsock->tx_lock);
995 int old_index = index;
996 index = find_fallback(nbd, index);
997 mutex_unlock(&nsock->tx_lock);
999 if (wait_for_reconnect(nbd)) {
1003 /* All the sockets should already be down at this point,
1004 * we just want to make sure that DISCONNECTED is set so
1005 * any requests that come in that were queue'ed waiting
1006 * for the reconnect timer don't trigger the timer again
1007 * and instead just error out.
1010 nbd_config_put(nbd);
1016 /* Handle the case that we have a pending request that was partially
1017 * transmitted that _has_ to be serviced first. We need to call requeue
1018 * here so that it gets put _after_ the request that is already on the
1021 blk_mq_start_request(req);
1022 if (unlikely(nsock->pending && nsock->pending != req)) {
1023 nbd_requeue_cmd(cmd);
1028 * Some failures are related to the link going down, so anything that
1029 * returns EAGAIN can be retried on a different socket.
1031 ret = nbd_send_cmd(nbd, cmd, index);
1033 * Access to this flag is protected by cmd->lock, thus it's safe to set
1034 * the flag after nbd_send_cmd() succeed to send request to server.
1037 __set_bit(NBD_CMD_INFLIGHT, &cmd->flags);
1038 else if (ret == -EAGAIN) {
1039 dev_err_ratelimited(disk_to_dev(nbd->disk),
1040 "Request send failed, requeueing\n");
1041 nbd_mark_nsock_dead(nbd, nsock, 1);
1042 nbd_requeue_cmd(cmd);
1046 mutex_unlock(&nsock->tx_lock);
1047 nbd_config_put(nbd);
1051 static blk_status_t nbd_queue_rq(struct blk_mq_hw_ctx *hctx,
1052 const struct blk_mq_queue_data *bd)
1054 struct nbd_cmd *cmd = blk_mq_rq_to_pdu(bd->rq);
1058 * Since we look at the bio's to send the request over the network we
1059 * need to make sure the completion work doesn't mark this request done
1060 * before we are done doing our send. This keeps us from dereferencing
1061 * freed data if we have particularly fast completions (ie we get the
1062 * completion before we exit sock_xmit on the last bvec) or in the case
1063 * that the server is misbehaving (or there was an error) before we're
1064 * done sending everything over the wire.
1066 mutex_lock(&cmd->lock);
1067 clear_bit(NBD_CMD_REQUEUED, &cmd->flags);
1069 /* We can be called directly from the user space process, which means we
1070 * could possibly have signals pending so our sendmsg will fail. In
1071 * this case we need to return that we are busy, otherwise error out as
1074 ret = nbd_handle_cmd(cmd, hctx->queue_num);
1076 ret = BLK_STS_IOERR;
1079 mutex_unlock(&cmd->lock);
1084 static struct socket *nbd_get_socket(struct nbd_device *nbd, unsigned long fd,
1087 struct socket *sock;
1090 sock = sockfd_lookup(fd, err);
1094 if (sock->ops->shutdown == sock_no_shutdown) {
1095 dev_err(disk_to_dev(nbd->disk), "Unsupported socket: shutdown callout must be supported.\n");
1104 static int nbd_add_socket(struct nbd_device *nbd, unsigned long arg,
1107 struct nbd_config *config = nbd->config;
1108 struct socket *sock;
1109 struct nbd_sock **socks;
1110 struct nbd_sock *nsock;
1113 sock = nbd_get_socket(nbd, arg, &err);
1118 * We need to make sure we don't get any errant requests while we're
1119 * reallocating the ->socks array.
1121 blk_mq_freeze_queue(nbd->disk->queue);
1123 if (!netlink && !nbd->task_setup &&
1124 !test_bit(NBD_RT_BOUND, &config->runtime_flags))
1125 nbd->task_setup = current;
1128 (nbd->task_setup != current ||
1129 test_bit(NBD_RT_BOUND, &config->runtime_flags))) {
1130 dev_err(disk_to_dev(nbd->disk),
1131 "Device being setup by another task");
1136 nsock = kzalloc(sizeof(*nsock), GFP_KERNEL);
1142 socks = krealloc(config->socks, (config->num_connections + 1) *
1143 sizeof(struct nbd_sock *), GFP_KERNEL);
1150 config->socks = socks;
1152 nsock->fallback_index = -1;
1153 nsock->dead = false;
1154 mutex_init(&nsock->tx_lock);
1156 nsock->pending = NULL;
1159 socks[config->num_connections++] = nsock;
1160 atomic_inc(&config->live_connections);
1161 blk_mq_unfreeze_queue(nbd->disk->queue);
1166 blk_mq_unfreeze_queue(nbd->disk->queue);
1171 static int nbd_reconnect_socket(struct nbd_device *nbd, unsigned long arg)
1173 struct nbd_config *config = nbd->config;
1174 struct socket *sock, *old;
1175 struct recv_thread_args *args;
1179 sock = nbd_get_socket(nbd, arg, &err);
1183 args = kzalloc(sizeof(*args), GFP_KERNEL);
1189 for (i = 0; i < config->num_connections; i++) {
1190 struct nbd_sock *nsock = config->socks[i];
1195 mutex_lock(&nsock->tx_lock);
1197 mutex_unlock(&nsock->tx_lock);
1200 sk_set_memalloc(sock->sk);
1201 if (nbd->tag_set.timeout)
1202 sock->sk->sk_sndtimeo = nbd->tag_set.timeout;
1203 atomic_inc(&config->recv_threads);
1204 refcount_inc(&nbd->config_refs);
1206 nsock->fallback_index = -1;
1208 nsock->dead = false;
1209 INIT_WORK(&args->work, recv_work);
1213 mutex_unlock(&nsock->tx_lock);
1216 clear_bit(NBD_RT_DISCONNECTED, &config->runtime_flags);
1218 /* We take the tx_mutex in an error path in the recv_work, so we
1219 * need to queue_work outside of the tx_mutex.
1221 queue_work(nbd->recv_workq, &args->work);
1223 atomic_inc(&config->live_connections);
1224 wake_up(&config->conn_wait);
1232 static void nbd_bdev_reset(struct nbd_device *nbd)
1234 if (disk_openers(nbd->disk) > 1)
1236 set_capacity(nbd->disk, 0);
1239 static void nbd_parse_flags(struct nbd_device *nbd)
1241 struct nbd_config *config = nbd->config;
1242 if (config->flags & NBD_FLAG_READ_ONLY)
1243 set_disk_ro(nbd->disk, true);
1245 set_disk_ro(nbd->disk, false);
1246 if (config->flags & NBD_FLAG_SEND_FLUSH) {
1247 if (config->flags & NBD_FLAG_SEND_FUA)
1248 blk_queue_write_cache(nbd->disk->queue, true, true);
1250 blk_queue_write_cache(nbd->disk->queue, true, false);
1253 blk_queue_write_cache(nbd->disk->queue, false, false);
1256 static void send_disconnects(struct nbd_device *nbd)
1258 struct nbd_config *config = nbd->config;
1259 struct nbd_request request = {
1260 .magic = htonl(NBD_REQUEST_MAGIC),
1261 .type = htonl(NBD_CMD_DISC),
1263 struct kvec iov = {.iov_base = &request, .iov_len = sizeof(request)};
1264 struct iov_iter from;
1267 for (i = 0; i < config->num_connections; i++) {
1268 struct nbd_sock *nsock = config->socks[i];
1270 iov_iter_kvec(&from, WRITE, &iov, 1, sizeof(request));
1271 mutex_lock(&nsock->tx_lock);
1272 ret = sock_xmit(nbd, i, 1, &from, 0, NULL);
1274 dev_err(disk_to_dev(nbd->disk),
1275 "Send disconnect failed %d\n", ret);
1276 mutex_unlock(&nsock->tx_lock);
1280 static int nbd_disconnect(struct nbd_device *nbd)
1282 struct nbd_config *config = nbd->config;
1284 dev_info(disk_to_dev(nbd->disk), "NBD_DISCONNECT\n");
1285 set_bit(NBD_RT_DISCONNECT_REQUESTED, &config->runtime_flags);
1286 set_bit(NBD_DISCONNECT_REQUESTED, &nbd->flags);
1287 send_disconnects(nbd);
1291 static void nbd_clear_sock(struct nbd_device *nbd)
1295 nbd->task_setup = NULL;
1298 static void nbd_config_put(struct nbd_device *nbd)
1300 if (refcount_dec_and_mutex_lock(&nbd->config_refs,
1301 &nbd->config_lock)) {
1302 struct nbd_config *config = nbd->config;
1303 nbd_dev_dbg_close(nbd);
1304 invalidate_disk(nbd->disk);
1305 if (nbd->config->bytesize)
1306 kobject_uevent(&nbd_to_dev(nbd)->kobj, KOBJ_CHANGE);
1307 if (test_and_clear_bit(NBD_RT_HAS_PID_FILE,
1308 &config->runtime_flags))
1309 device_remove_file(disk_to_dev(nbd->disk), &pid_attr);
1311 if (test_and_clear_bit(NBD_RT_HAS_BACKEND_FILE,
1312 &config->runtime_flags)) {
1313 device_remove_file(disk_to_dev(nbd->disk), &backend_attr);
1314 kfree(nbd->backend);
1315 nbd->backend = NULL;
1317 nbd_clear_sock(nbd);
1318 if (config->num_connections) {
1320 for (i = 0; i < config->num_connections; i++) {
1321 sockfd_put(config->socks[i]->sock);
1322 kfree(config->socks[i]);
1324 kfree(config->socks);
1329 nbd->tag_set.timeout = 0;
1330 nbd->disk->queue->limits.discard_granularity = 0;
1331 blk_queue_max_discard_sectors(nbd->disk->queue, 0);
1333 mutex_unlock(&nbd->config_lock);
1335 module_put(THIS_MODULE);
1339 static int nbd_start_device(struct nbd_device *nbd)
1341 struct nbd_config *config = nbd->config;
1342 int num_connections = config->num_connections;
1349 if (num_connections > 1 &&
1350 !(config->flags & NBD_FLAG_CAN_MULTI_CONN)) {
1351 dev_err(disk_to_dev(nbd->disk), "server does not support multiple connections per device.\n");
1355 blk_mq_update_nr_hw_queues(&nbd->tag_set, config->num_connections);
1356 nbd->pid = task_pid_nr(current);
1358 nbd_parse_flags(nbd);
1360 error = device_create_file(disk_to_dev(nbd->disk), &pid_attr);
1362 dev_err(disk_to_dev(nbd->disk), "device_create_file failed for pid!\n");
1365 set_bit(NBD_RT_HAS_PID_FILE, &config->runtime_flags);
1367 nbd_dev_dbg_init(nbd);
1368 for (i = 0; i < num_connections; i++) {
1369 struct recv_thread_args *args;
1371 args = kzalloc(sizeof(*args), GFP_KERNEL);
1375 * If num_connections is m (2 < m),
1376 * and NO.1 ~ NO.n(1 < n < m) kzallocs are successful.
1377 * But NO.(n + 1) failed. We still have n recv threads.
1378 * So, add flush_workqueue here to prevent recv threads
1379 * dropping the last config_refs and trying to destroy
1380 * the workqueue from inside the workqueue.
1383 flush_workqueue(nbd->recv_workq);
1386 sk_set_memalloc(config->socks[i]->sock->sk);
1387 if (nbd->tag_set.timeout)
1388 config->socks[i]->sock->sk->sk_sndtimeo =
1389 nbd->tag_set.timeout;
1390 atomic_inc(&config->recv_threads);
1391 refcount_inc(&nbd->config_refs);
1392 INIT_WORK(&args->work, recv_work);
1395 queue_work(nbd->recv_workq, &args->work);
1397 return nbd_set_size(nbd, config->bytesize, nbd_blksize(config));
1400 static int nbd_start_device_ioctl(struct nbd_device *nbd)
1402 struct nbd_config *config = nbd->config;
1405 ret = nbd_start_device(nbd);
1410 set_bit(GD_NEED_PART_SCAN, &nbd->disk->state);
1411 mutex_unlock(&nbd->config_lock);
1412 ret = wait_event_interruptible(config->recv_wq,
1413 atomic_read(&config->recv_threads) == 0);
1419 flush_workqueue(nbd->recv_workq);
1420 mutex_lock(&nbd->config_lock);
1421 nbd_bdev_reset(nbd);
1422 /* user requested, ignore socket errors */
1423 if (test_bit(NBD_RT_DISCONNECT_REQUESTED, &config->runtime_flags))
1425 if (test_bit(NBD_RT_TIMEDOUT, &config->runtime_flags))
1430 static void nbd_clear_sock_ioctl(struct nbd_device *nbd,
1431 struct block_device *bdev)
1433 nbd_clear_sock(nbd);
1434 __invalidate_device(bdev, true);
1435 nbd_bdev_reset(nbd);
1436 if (test_and_clear_bit(NBD_RT_HAS_CONFIG_REF,
1437 &nbd->config->runtime_flags))
1438 nbd_config_put(nbd);
1441 static void nbd_set_cmd_timeout(struct nbd_device *nbd, u64 timeout)
1443 nbd->tag_set.timeout = timeout * HZ;
1445 blk_queue_rq_timeout(nbd->disk->queue, timeout * HZ);
1447 blk_queue_rq_timeout(nbd->disk->queue, 30 * HZ);
1450 /* Must be called with config_lock held */
1451 static int __nbd_ioctl(struct block_device *bdev, struct nbd_device *nbd,
1452 unsigned int cmd, unsigned long arg)
1454 struct nbd_config *config = nbd->config;
1458 case NBD_DISCONNECT:
1459 return nbd_disconnect(nbd);
1460 case NBD_CLEAR_SOCK:
1461 nbd_clear_sock_ioctl(nbd, bdev);
1464 return nbd_add_socket(nbd, arg, false);
1465 case NBD_SET_BLKSIZE:
1466 return nbd_set_size(nbd, config->bytesize, arg);
1468 return nbd_set_size(nbd, arg, nbd_blksize(config));
1469 case NBD_SET_SIZE_BLOCKS:
1470 if (check_shl_overflow(arg, config->blksize_bits, &bytesize))
1472 return nbd_set_size(nbd, bytesize, nbd_blksize(config));
1473 case NBD_SET_TIMEOUT:
1474 nbd_set_cmd_timeout(nbd, arg);
1478 config->flags = arg;
1481 return nbd_start_device_ioctl(nbd);
1484 * This is for compatibility only. The queue is always cleared
1485 * by NBD_DO_IT or NBD_CLEAR_SOCK.
1488 case NBD_PRINT_DEBUG:
1490 * For compatibility only, we no longer keep a list of
1491 * outstanding requests.
1498 static int nbd_ioctl(struct block_device *bdev, fmode_t mode,
1499 unsigned int cmd, unsigned long arg)
1501 struct nbd_device *nbd = bdev->bd_disk->private_data;
1502 struct nbd_config *config = nbd->config;
1503 int error = -EINVAL;
1505 if (!capable(CAP_SYS_ADMIN))
1508 /* The block layer will pass back some non-nbd ioctls in case we have
1509 * special handling for them, but we don't so just return an error.
1511 if (_IOC_TYPE(cmd) != 0xab)
1514 mutex_lock(&nbd->config_lock);
1516 /* Don't allow ioctl operations on a nbd device that was created with
1517 * netlink, unless it's DISCONNECT or CLEAR_SOCK, which are fine.
1519 if (!test_bit(NBD_RT_BOUND, &config->runtime_flags) ||
1520 (cmd == NBD_DISCONNECT || cmd == NBD_CLEAR_SOCK))
1521 error = __nbd_ioctl(bdev, nbd, cmd, arg);
1523 dev_err(nbd_to_dev(nbd), "Cannot use ioctl interface on a netlink controlled device.\n");
1524 mutex_unlock(&nbd->config_lock);
1528 static struct nbd_config *nbd_alloc_config(void)
1530 struct nbd_config *config;
1532 if (!try_module_get(THIS_MODULE))
1533 return ERR_PTR(-ENODEV);
1535 config = kzalloc(sizeof(struct nbd_config), GFP_NOFS);
1537 module_put(THIS_MODULE);
1538 return ERR_PTR(-ENOMEM);
1541 atomic_set(&config->recv_threads, 0);
1542 init_waitqueue_head(&config->recv_wq);
1543 init_waitqueue_head(&config->conn_wait);
1544 config->blksize_bits = NBD_DEF_BLKSIZE_BITS;
1545 atomic_set(&config->live_connections, 0);
1549 static int nbd_open(struct block_device *bdev, fmode_t mode)
1551 struct nbd_device *nbd;
1554 mutex_lock(&nbd_index_mutex);
1555 nbd = bdev->bd_disk->private_data;
1560 if (!refcount_inc_not_zero(&nbd->refs)) {
1564 if (!refcount_inc_not_zero(&nbd->config_refs)) {
1565 struct nbd_config *config;
1567 mutex_lock(&nbd->config_lock);
1568 if (refcount_inc_not_zero(&nbd->config_refs)) {
1569 mutex_unlock(&nbd->config_lock);
1572 config = nbd_alloc_config();
1573 if (IS_ERR(config)) {
1574 ret = PTR_ERR(config);
1575 mutex_unlock(&nbd->config_lock);
1578 nbd->config = config;
1579 refcount_set(&nbd->config_refs, 1);
1580 refcount_inc(&nbd->refs);
1581 mutex_unlock(&nbd->config_lock);
1583 set_bit(GD_NEED_PART_SCAN, &bdev->bd_disk->state);
1584 } else if (nbd_disconnected(nbd->config)) {
1586 set_bit(GD_NEED_PART_SCAN, &bdev->bd_disk->state);
1589 mutex_unlock(&nbd_index_mutex);
1593 static void nbd_release(struct gendisk *disk, fmode_t mode)
1595 struct nbd_device *nbd = disk->private_data;
1597 if (test_bit(NBD_RT_DISCONNECT_ON_CLOSE, &nbd->config->runtime_flags) &&
1598 disk_openers(disk) == 0)
1599 nbd_disconnect_and_put(nbd);
1601 nbd_config_put(nbd);
1605 static const struct block_device_operations nbd_fops =
1607 .owner = THIS_MODULE,
1609 .release = nbd_release,
1611 .compat_ioctl = nbd_ioctl,
1614 #if IS_ENABLED(CONFIG_DEBUG_FS)
1616 static int nbd_dbg_tasks_show(struct seq_file *s, void *unused)
1618 struct nbd_device *nbd = s->private;
1621 seq_printf(s, "recv: %d\n", nbd->pid);
1626 DEFINE_SHOW_ATTRIBUTE(nbd_dbg_tasks);
1628 static int nbd_dbg_flags_show(struct seq_file *s, void *unused)
1630 struct nbd_device *nbd = s->private;
1631 u32 flags = nbd->config->flags;
1633 seq_printf(s, "Hex: 0x%08x\n\n", flags);
1635 seq_puts(s, "Known flags:\n");
1637 if (flags & NBD_FLAG_HAS_FLAGS)
1638 seq_puts(s, "NBD_FLAG_HAS_FLAGS\n");
1639 if (flags & NBD_FLAG_READ_ONLY)
1640 seq_puts(s, "NBD_FLAG_READ_ONLY\n");
1641 if (flags & NBD_FLAG_SEND_FLUSH)
1642 seq_puts(s, "NBD_FLAG_SEND_FLUSH\n");
1643 if (flags & NBD_FLAG_SEND_FUA)
1644 seq_puts(s, "NBD_FLAG_SEND_FUA\n");
1645 if (flags & NBD_FLAG_SEND_TRIM)
1646 seq_puts(s, "NBD_FLAG_SEND_TRIM\n");
1651 DEFINE_SHOW_ATTRIBUTE(nbd_dbg_flags);
1653 static int nbd_dev_dbg_init(struct nbd_device *nbd)
1656 struct nbd_config *config = nbd->config;
1661 dir = debugfs_create_dir(nbd_name(nbd), nbd_dbg_dir);
1663 dev_err(nbd_to_dev(nbd), "Failed to create debugfs dir for '%s'\n",
1667 config->dbg_dir = dir;
1669 debugfs_create_file("tasks", 0444, dir, nbd, &nbd_dbg_tasks_fops);
1670 debugfs_create_u64("size_bytes", 0444, dir, &config->bytesize);
1671 debugfs_create_u32("timeout", 0444, dir, &nbd->tag_set.timeout);
1672 debugfs_create_u32("blocksize_bits", 0444, dir, &config->blksize_bits);
1673 debugfs_create_file("flags", 0444, dir, nbd, &nbd_dbg_flags_fops);
1678 static void nbd_dev_dbg_close(struct nbd_device *nbd)
1680 debugfs_remove_recursive(nbd->config->dbg_dir);
1683 static int nbd_dbg_init(void)
1685 struct dentry *dbg_dir;
1687 dbg_dir = debugfs_create_dir("nbd", NULL);
1691 nbd_dbg_dir = dbg_dir;
1696 static void nbd_dbg_close(void)
1698 debugfs_remove_recursive(nbd_dbg_dir);
1701 #else /* IS_ENABLED(CONFIG_DEBUG_FS) */
1703 static int nbd_dev_dbg_init(struct nbd_device *nbd)
1708 static void nbd_dev_dbg_close(struct nbd_device *nbd)
1712 static int nbd_dbg_init(void)
1717 static void nbd_dbg_close(void)
1723 static int nbd_init_request(struct blk_mq_tag_set *set, struct request *rq,
1724 unsigned int hctx_idx, unsigned int numa_node)
1726 struct nbd_cmd *cmd = blk_mq_rq_to_pdu(rq);
1727 cmd->nbd = set->driver_data;
1729 mutex_init(&cmd->lock);
1733 static const struct blk_mq_ops nbd_mq_ops = {
1734 .queue_rq = nbd_queue_rq,
1735 .complete = nbd_complete_rq,
1736 .init_request = nbd_init_request,
1737 .timeout = nbd_xmit_timeout,
1740 static struct nbd_device *nbd_dev_add(int index, unsigned int refs)
1742 struct nbd_device *nbd;
1743 struct gendisk *disk;
1746 nbd = kzalloc(sizeof(struct nbd_device), GFP_KERNEL);
1750 nbd->tag_set.ops = &nbd_mq_ops;
1751 nbd->tag_set.nr_hw_queues = 1;
1752 nbd->tag_set.queue_depth = 128;
1753 nbd->tag_set.numa_node = NUMA_NO_NODE;
1754 nbd->tag_set.cmd_size = sizeof(struct nbd_cmd);
1755 nbd->tag_set.flags = BLK_MQ_F_SHOULD_MERGE |
1757 nbd->tag_set.driver_data = nbd;
1758 INIT_WORK(&nbd->remove_work, nbd_dev_remove_work);
1759 nbd->backend = NULL;
1761 err = blk_mq_alloc_tag_set(&nbd->tag_set);
1765 mutex_lock(&nbd_index_mutex);
1767 err = idr_alloc(&nbd_index_idr, nbd, index, index + 1,
1772 err = idr_alloc(&nbd_index_idr, nbd, 0, 0, GFP_KERNEL);
1777 mutex_unlock(&nbd_index_mutex);
1781 disk = blk_mq_alloc_disk(&nbd->tag_set, NULL);
1783 err = PTR_ERR(disk);
1788 nbd->recv_workq = alloc_workqueue("nbd%d-recv",
1789 WQ_MEM_RECLAIM | WQ_HIGHPRI |
1790 WQ_UNBOUND, 0, nbd->index);
1791 if (!nbd->recv_workq) {
1792 dev_err(disk_to_dev(nbd->disk), "Could not allocate knbd recv work queue.\n");
1798 * Tell the block layer that we are not a rotational device
1800 blk_queue_flag_set(QUEUE_FLAG_NONROT, disk->queue);
1801 blk_queue_flag_clear(QUEUE_FLAG_ADD_RANDOM, disk->queue);
1802 disk->queue->limits.discard_granularity = 0;
1803 blk_queue_max_discard_sectors(disk->queue, 0);
1804 blk_queue_max_segment_size(disk->queue, UINT_MAX);
1805 blk_queue_max_segments(disk->queue, USHRT_MAX);
1806 blk_queue_max_hw_sectors(disk->queue, 65536);
1807 disk->queue->limits.max_sectors = 256;
1809 mutex_init(&nbd->config_lock);
1810 refcount_set(&nbd->config_refs, 0);
1812 * Start out with a zero references to keep other threads from using
1813 * this device until it is fully initialized.
1815 refcount_set(&nbd->refs, 0);
1816 INIT_LIST_HEAD(&nbd->list);
1817 disk->major = NBD_MAJOR;
1818 disk->first_minor = index << part_shift;
1819 disk->minors = 1 << part_shift;
1820 disk->fops = &nbd_fops;
1821 disk->private_data = nbd;
1822 sprintf(disk->disk_name, "nbd%d", index);
1823 err = add_disk(disk);
1828 * Now publish the device.
1830 refcount_set(&nbd->refs, refs);
1831 nbd_total_devices++;
1835 destroy_workqueue(nbd->recv_workq);
1839 mutex_lock(&nbd_index_mutex);
1840 idr_remove(&nbd_index_idr, index);
1841 mutex_unlock(&nbd_index_mutex);
1843 blk_mq_free_tag_set(&nbd->tag_set);
1847 return ERR_PTR(err);
1850 static struct nbd_device *nbd_find_get_unused(void)
1852 struct nbd_device *nbd;
1855 lockdep_assert_held(&nbd_index_mutex);
1857 idr_for_each_entry(&nbd_index_idr, nbd, id) {
1858 if (refcount_read(&nbd->config_refs) ||
1859 test_bit(NBD_DESTROY_ON_DISCONNECT, &nbd->flags))
1861 if (refcount_inc_not_zero(&nbd->refs))
1868 /* Netlink interface. */
1869 static const struct nla_policy nbd_attr_policy[NBD_ATTR_MAX + 1] = {
1870 [NBD_ATTR_INDEX] = { .type = NLA_U32 },
1871 [NBD_ATTR_SIZE_BYTES] = { .type = NLA_U64 },
1872 [NBD_ATTR_BLOCK_SIZE_BYTES] = { .type = NLA_U64 },
1873 [NBD_ATTR_TIMEOUT] = { .type = NLA_U64 },
1874 [NBD_ATTR_SERVER_FLAGS] = { .type = NLA_U64 },
1875 [NBD_ATTR_CLIENT_FLAGS] = { .type = NLA_U64 },
1876 [NBD_ATTR_SOCKETS] = { .type = NLA_NESTED},
1877 [NBD_ATTR_DEAD_CONN_TIMEOUT] = { .type = NLA_U64 },
1878 [NBD_ATTR_DEVICE_LIST] = { .type = NLA_NESTED},
1879 [NBD_ATTR_BACKEND_IDENTIFIER] = { .type = NLA_STRING},
1882 static const struct nla_policy nbd_sock_policy[NBD_SOCK_MAX + 1] = {
1883 [NBD_SOCK_FD] = { .type = NLA_U32 },
1886 /* We don't use this right now since we don't parse the incoming list, but we
1887 * still want it here so userspace knows what to expect.
1889 static const struct nla_policy __attribute__((unused))
1890 nbd_device_policy[NBD_DEVICE_ATTR_MAX + 1] = {
1891 [NBD_DEVICE_INDEX] = { .type = NLA_U32 },
1892 [NBD_DEVICE_CONNECTED] = { .type = NLA_U8 },
1895 static int nbd_genl_size_set(struct genl_info *info, struct nbd_device *nbd)
1897 struct nbd_config *config = nbd->config;
1898 u64 bsize = nbd_blksize(config);
1899 u64 bytes = config->bytesize;
1901 if (info->attrs[NBD_ATTR_SIZE_BYTES])
1902 bytes = nla_get_u64(info->attrs[NBD_ATTR_SIZE_BYTES]);
1904 if (info->attrs[NBD_ATTR_BLOCK_SIZE_BYTES])
1905 bsize = nla_get_u64(info->attrs[NBD_ATTR_BLOCK_SIZE_BYTES]);
1907 if (bytes != config->bytesize || bsize != nbd_blksize(config))
1908 return nbd_set_size(nbd, bytes, bsize);
1912 static int nbd_genl_connect(struct sk_buff *skb, struct genl_info *info)
1914 struct nbd_device *nbd;
1915 struct nbd_config *config;
1918 bool put_dev = false;
1920 if (!netlink_capable(skb, CAP_SYS_ADMIN))
1923 if (info->attrs[NBD_ATTR_INDEX]) {
1924 index = nla_get_u32(info->attrs[NBD_ATTR_INDEX]);
1927 * Too big first_minor can cause duplicate creation of
1928 * sysfs files/links, since index << part_shift might overflow, or
1929 * MKDEV() expect that the max bits of first_minor is 20.
1931 if (index < 0 || index > MINORMASK >> part_shift) {
1932 pr_err("illegal input index %d\n", index);
1936 if (!info->attrs[NBD_ATTR_SOCKETS]) {
1937 pr_err("must specify at least one socket\n");
1940 if (!info->attrs[NBD_ATTR_SIZE_BYTES]) {
1941 pr_err("must specify a size in bytes for the device\n");
1945 mutex_lock(&nbd_index_mutex);
1947 nbd = nbd_find_get_unused();
1949 nbd = idr_find(&nbd_index_idr, index);
1951 if ((test_bit(NBD_DESTROY_ON_DISCONNECT, &nbd->flags) &&
1952 test_bit(NBD_DISCONNECT_REQUESTED, &nbd->flags)) ||
1953 !refcount_inc_not_zero(&nbd->refs)) {
1954 mutex_unlock(&nbd_index_mutex);
1955 pr_err("device at index %d is going down\n",
1961 mutex_unlock(&nbd_index_mutex);
1964 nbd = nbd_dev_add(index, 2);
1966 pr_err("failed to add new device\n");
1967 return PTR_ERR(nbd);
1971 mutex_lock(&nbd->config_lock);
1972 if (refcount_read(&nbd->config_refs)) {
1973 mutex_unlock(&nbd->config_lock);
1977 pr_err("nbd%d already in use\n", index);
1980 if (WARN_ON(nbd->config)) {
1981 mutex_unlock(&nbd->config_lock);
1985 config = nbd_alloc_config();
1986 if (IS_ERR(config)) {
1987 mutex_unlock(&nbd->config_lock);
1989 pr_err("couldn't allocate config\n");
1990 return PTR_ERR(config);
1992 nbd->config = config;
1993 refcount_set(&nbd->config_refs, 1);
1994 set_bit(NBD_RT_BOUND, &config->runtime_flags);
1996 ret = nbd_genl_size_set(info, nbd);
2000 if (info->attrs[NBD_ATTR_TIMEOUT])
2001 nbd_set_cmd_timeout(nbd,
2002 nla_get_u64(info->attrs[NBD_ATTR_TIMEOUT]));
2003 if (info->attrs[NBD_ATTR_DEAD_CONN_TIMEOUT]) {
2004 config->dead_conn_timeout =
2005 nla_get_u64(info->attrs[NBD_ATTR_DEAD_CONN_TIMEOUT]);
2006 config->dead_conn_timeout *= HZ;
2008 if (info->attrs[NBD_ATTR_SERVER_FLAGS])
2010 nla_get_u64(info->attrs[NBD_ATTR_SERVER_FLAGS]);
2011 if (info->attrs[NBD_ATTR_CLIENT_FLAGS]) {
2012 u64 flags = nla_get_u64(info->attrs[NBD_ATTR_CLIENT_FLAGS]);
2013 if (flags & NBD_CFLAG_DESTROY_ON_DISCONNECT) {
2015 * We have 1 ref to keep the device around, and then 1
2016 * ref for our current operation here, which will be
2017 * inherited by the config. If we already have
2018 * DESTROY_ON_DISCONNECT set then we know we don't have
2019 * that extra ref already held so we don't need the
2022 if (!test_and_set_bit(NBD_DESTROY_ON_DISCONNECT,
2026 if (test_and_clear_bit(NBD_DESTROY_ON_DISCONNECT,
2028 refcount_inc(&nbd->refs);
2030 if (flags & NBD_CFLAG_DISCONNECT_ON_CLOSE) {
2031 set_bit(NBD_RT_DISCONNECT_ON_CLOSE,
2032 &config->runtime_flags);
2036 if (info->attrs[NBD_ATTR_SOCKETS]) {
2037 struct nlattr *attr;
2040 nla_for_each_nested(attr, info->attrs[NBD_ATTR_SOCKETS],
2042 struct nlattr *socks[NBD_SOCK_MAX+1];
2044 if (nla_type(attr) != NBD_SOCK_ITEM) {
2045 pr_err("socks must be embedded in a SOCK_ITEM attr\n");
2049 ret = nla_parse_nested_deprecated(socks, NBD_SOCK_MAX,
2054 pr_err("error processing sock list\n");
2058 if (!socks[NBD_SOCK_FD])
2060 fd = (int)nla_get_u32(socks[NBD_SOCK_FD]);
2061 ret = nbd_add_socket(nbd, fd, true);
2066 ret = nbd_start_device(nbd);
2069 if (info->attrs[NBD_ATTR_BACKEND_IDENTIFIER]) {
2070 nbd->backend = nla_strdup(info->attrs[NBD_ATTR_BACKEND_IDENTIFIER],
2072 if (!nbd->backend) {
2077 ret = device_create_file(disk_to_dev(nbd->disk), &backend_attr);
2079 dev_err(disk_to_dev(nbd->disk),
2080 "device_create_file failed for backend!\n");
2083 set_bit(NBD_RT_HAS_BACKEND_FILE, &config->runtime_flags);
2085 mutex_unlock(&nbd->config_lock);
2087 set_bit(NBD_RT_HAS_CONFIG_REF, &config->runtime_flags);
2088 refcount_inc(&nbd->config_refs);
2089 nbd_connect_reply(info, nbd->index);
2091 nbd_config_put(nbd);
2097 static void nbd_disconnect_and_put(struct nbd_device *nbd)
2099 mutex_lock(&nbd->config_lock);
2100 nbd_disconnect(nbd);
2102 wake_up(&nbd->config->conn_wait);
2104 * Make sure recv thread has finished, we can safely call nbd_clear_que()
2105 * to cancel the inflight I/Os.
2107 flush_workqueue(nbd->recv_workq);
2109 nbd->task_setup = NULL;
2110 mutex_unlock(&nbd->config_lock);
2112 if (test_and_clear_bit(NBD_RT_HAS_CONFIG_REF,
2113 &nbd->config->runtime_flags))
2114 nbd_config_put(nbd);
2117 static int nbd_genl_disconnect(struct sk_buff *skb, struct genl_info *info)
2119 struct nbd_device *nbd;
2122 if (!netlink_capable(skb, CAP_SYS_ADMIN))
2125 if (!info->attrs[NBD_ATTR_INDEX]) {
2126 pr_err("must specify an index to disconnect\n");
2129 index = nla_get_u32(info->attrs[NBD_ATTR_INDEX]);
2130 mutex_lock(&nbd_index_mutex);
2131 nbd = idr_find(&nbd_index_idr, index);
2133 mutex_unlock(&nbd_index_mutex);
2134 pr_err("couldn't find device at index %d\n", index);
2137 if (!refcount_inc_not_zero(&nbd->refs)) {
2138 mutex_unlock(&nbd_index_mutex);
2139 pr_err("device at index %d is going down\n", index);
2142 mutex_unlock(&nbd_index_mutex);
2143 if (!refcount_inc_not_zero(&nbd->config_refs))
2145 nbd_disconnect_and_put(nbd);
2146 nbd_config_put(nbd);
2152 static int nbd_genl_reconfigure(struct sk_buff *skb, struct genl_info *info)
2154 struct nbd_device *nbd = NULL;
2155 struct nbd_config *config;
2158 bool put_dev = false;
2160 if (!netlink_capable(skb, CAP_SYS_ADMIN))
2163 if (!info->attrs[NBD_ATTR_INDEX]) {
2164 pr_err("must specify a device to reconfigure\n");
2167 index = nla_get_u32(info->attrs[NBD_ATTR_INDEX]);
2168 mutex_lock(&nbd_index_mutex);
2169 nbd = idr_find(&nbd_index_idr, index);
2171 mutex_unlock(&nbd_index_mutex);
2172 pr_err("couldn't find a device at index %d\n", index);
2176 if (info->attrs[NBD_ATTR_BACKEND_IDENTIFIER]) {
2177 if (nla_strcmp(info->attrs[NBD_ATTR_BACKEND_IDENTIFIER],
2179 mutex_unlock(&nbd_index_mutex);
2180 dev_err(nbd_to_dev(nbd),
2181 "backend image doesn't match with %s\n",
2186 mutex_unlock(&nbd_index_mutex);
2187 dev_err(nbd_to_dev(nbd), "must specify backend\n");
2191 if (!refcount_inc_not_zero(&nbd->refs)) {
2192 mutex_unlock(&nbd_index_mutex);
2193 pr_err("device at index %d is going down\n", index);
2196 mutex_unlock(&nbd_index_mutex);
2198 if (!refcount_inc_not_zero(&nbd->config_refs)) {
2199 dev_err(nbd_to_dev(nbd),
2200 "not configured, cannot reconfigure\n");
2205 mutex_lock(&nbd->config_lock);
2206 config = nbd->config;
2207 if (!test_bit(NBD_RT_BOUND, &config->runtime_flags) ||
2209 dev_err(nbd_to_dev(nbd),
2210 "not configured, cannot reconfigure\n");
2215 ret = nbd_genl_size_set(info, nbd);
2219 if (info->attrs[NBD_ATTR_TIMEOUT])
2220 nbd_set_cmd_timeout(nbd,
2221 nla_get_u64(info->attrs[NBD_ATTR_TIMEOUT]));
2222 if (info->attrs[NBD_ATTR_DEAD_CONN_TIMEOUT]) {
2223 config->dead_conn_timeout =
2224 nla_get_u64(info->attrs[NBD_ATTR_DEAD_CONN_TIMEOUT]);
2225 config->dead_conn_timeout *= HZ;
2227 if (info->attrs[NBD_ATTR_CLIENT_FLAGS]) {
2228 u64 flags = nla_get_u64(info->attrs[NBD_ATTR_CLIENT_FLAGS]);
2229 if (flags & NBD_CFLAG_DESTROY_ON_DISCONNECT) {
2230 if (!test_and_set_bit(NBD_DESTROY_ON_DISCONNECT,
2234 if (test_and_clear_bit(NBD_DESTROY_ON_DISCONNECT,
2236 refcount_inc(&nbd->refs);
2239 if (flags & NBD_CFLAG_DISCONNECT_ON_CLOSE) {
2240 set_bit(NBD_RT_DISCONNECT_ON_CLOSE,
2241 &config->runtime_flags);
2243 clear_bit(NBD_RT_DISCONNECT_ON_CLOSE,
2244 &config->runtime_flags);
2248 if (info->attrs[NBD_ATTR_SOCKETS]) {
2249 struct nlattr *attr;
2252 nla_for_each_nested(attr, info->attrs[NBD_ATTR_SOCKETS],
2254 struct nlattr *socks[NBD_SOCK_MAX+1];
2256 if (nla_type(attr) != NBD_SOCK_ITEM) {
2257 pr_err("socks must be embedded in a SOCK_ITEM attr\n");
2261 ret = nla_parse_nested_deprecated(socks, NBD_SOCK_MAX,
2266 pr_err("error processing sock list\n");
2270 if (!socks[NBD_SOCK_FD])
2272 fd = (int)nla_get_u32(socks[NBD_SOCK_FD]);
2273 ret = nbd_reconnect_socket(nbd, fd);
2279 dev_info(nbd_to_dev(nbd), "reconnected socket\n");
2283 mutex_unlock(&nbd->config_lock);
2284 nbd_config_put(nbd);
2291 static const struct genl_small_ops nbd_connect_genl_ops[] = {
2293 .cmd = NBD_CMD_CONNECT,
2294 .validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
2295 .doit = nbd_genl_connect,
2298 .cmd = NBD_CMD_DISCONNECT,
2299 .validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
2300 .doit = nbd_genl_disconnect,
2303 .cmd = NBD_CMD_RECONFIGURE,
2304 .validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
2305 .doit = nbd_genl_reconfigure,
2308 .cmd = NBD_CMD_STATUS,
2309 .validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
2310 .doit = nbd_genl_status,
2314 static const struct genl_multicast_group nbd_mcast_grps[] = {
2315 { .name = NBD_GENL_MCAST_GROUP_NAME, },
2318 static struct genl_family nbd_genl_family __ro_after_init = {
2320 .name = NBD_GENL_FAMILY_NAME,
2321 .version = NBD_GENL_VERSION,
2322 .module = THIS_MODULE,
2323 .small_ops = nbd_connect_genl_ops,
2324 .n_small_ops = ARRAY_SIZE(nbd_connect_genl_ops),
2325 .resv_start_op = NBD_CMD_STATUS + 1,
2326 .maxattr = NBD_ATTR_MAX,
2327 .policy = nbd_attr_policy,
2328 .mcgrps = nbd_mcast_grps,
2329 .n_mcgrps = ARRAY_SIZE(nbd_mcast_grps),
2332 static int populate_nbd_status(struct nbd_device *nbd, struct sk_buff *reply)
2334 struct nlattr *dev_opt;
2338 /* This is a little racey, but for status it's ok. The
2339 * reason we don't take a ref here is because we can't
2340 * take a ref in the index == -1 case as we would need
2341 * to put under the nbd_index_mutex, which could
2342 * deadlock if we are configured to remove ourselves
2343 * once we're disconnected.
2345 if (refcount_read(&nbd->config_refs))
2347 dev_opt = nla_nest_start_noflag(reply, NBD_DEVICE_ITEM);
2350 ret = nla_put_u32(reply, NBD_DEVICE_INDEX, nbd->index);
2353 ret = nla_put_u8(reply, NBD_DEVICE_CONNECTED,
2357 nla_nest_end(reply, dev_opt);
2361 static int status_cb(int id, void *ptr, void *data)
2363 struct nbd_device *nbd = ptr;
2364 return populate_nbd_status(nbd, (struct sk_buff *)data);
2367 static int nbd_genl_status(struct sk_buff *skb, struct genl_info *info)
2369 struct nlattr *dev_list;
2370 struct sk_buff *reply;
2376 if (info->attrs[NBD_ATTR_INDEX])
2377 index = nla_get_u32(info->attrs[NBD_ATTR_INDEX]);
2379 mutex_lock(&nbd_index_mutex);
2381 msg_size = nla_total_size(nla_attr_size(sizeof(u32)) +
2382 nla_attr_size(sizeof(u8)));
2383 msg_size *= (index == -1) ? nbd_total_devices : 1;
2385 reply = genlmsg_new(msg_size, GFP_KERNEL);
2388 reply_head = genlmsg_put_reply(reply, info, &nbd_genl_family, 0,
2395 dev_list = nla_nest_start_noflag(reply, NBD_ATTR_DEVICE_LIST);
2397 ret = idr_for_each(&nbd_index_idr, &status_cb, reply);
2403 struct nbd_device *nbd;
2404 nbd = idr_find(&nbd_index_idr, index);
2406 ret = populate_nbd_status(nbd, reply);
2413 nla_nest_end(reply, dev_list);
2414 genlmsg_end(reply, reply_head);
2415 ret = genlmsg_reply(reply, info);
2417 mutex_unlock(&nbd_index_mutex);
2421 static void nbd_connect_reply(struct genl_info *info, int index)
2423 struct sk_buff *skb;
2427 skb = genlmsg_new(nla_total_size(sizeof(u32)), GFP_KERNEL);
2430 msg_head = genlmsg_put_reply(skb, info, &nbd_genl_family, 0,
2436 ret = nla_put_u32(skb, NBD_ATTR_INDEX, index);
2441 genlmsg_end(skb, msg_head);
2442 genlmsg_reply(skb, info);
2445 static void nbd_mcast_index(int index)
2447 struct sk_buff *skb;
2451 skb = genlmsg_new(nla_total_size(sizeof(u32)), GFP_KERNEL);
2454 msg_head = genlmsg_put(skb, 0, 0, &nbd_genl_family, 0,
2460 ret = nla_put_u32(skb, NBD_ATTR_INDEX, index);
2465 genlmsg_end(skb, msg_head);
2466 genlmsg_multicast(&nbd_genl_family, skb, 0, 0, GFP_KERNEL);
2469 static void nbd_dead_link_work(struct work_struct *work)
2471 struct link_dead_args *args = container_of(work, struct link_dead_args,
2473 nbd_mcast_index(args->index);
2477 static int __init nbd_init(void)
2481 BUILD_BUG_ON(sizeof(struct nbd_request) != 28);
2484 pr_err("max_part must be >= 0\n");
2490 part_shift = fls(max_part);
2493 * Adjust max_part according to part_shift as it is exported
2494 * to user space so that user can know the max number of
2495 * partition kernel should be able to manage.
2497 * Note that -1 is required because partition 0 is reserved
2498 * for the whole disk.
2500 max_part = (1UL << part_shift) - 1;
2503 if ((1UL << part_shift) > DISK_MAX_PARTS)
2506 if (nbds_max > 1UL << (MINORBITS - part_shift))
2509 if (register_blkdev(NBD_MAJOR, "nbd"))
2512 nbd_del_wq = alloc_workqueue("nbd-del", WQ_UNBOUND, 0);
2514 unregister_blkdev(NBD_MAJOR, "nbd");
2518 if (genl_register_family(&nbd_genl_family)) {
2519 destroy_workqueue(nbd_del_wq);
2520 unregister_blkdev(NBD_MAJOR, "nbd");
2525 for (i = 0; i < nbds_max; i++)
2530 static int nbd_exit_cb(int id, void *ptr, void *data)
2532 struct list_head *list = (struct list_head *)data;
2533 struct nbd_device *nbd = ptr;
2535 /* Skip nbd that is being removed asynchronously */
2536 if (refcount_read(&nbd->refs))
2537 list_add_tail(&nbd->list, list);
2542 static void __exit nbd_cleanup(void)
2544 struct nbd_device *nbd;
2545 LIST_HEAD(del_list);
2548 * Unregister netlink interface prior to waiting
2549 * for the completion of netlink commands.
2551 genl_unregister_family(&nbd_genl_family);
2555 mutex_lock(&nbd_index_mutex);
2556 idr_for_each(&nbd_index_idr, &nbd_exit_cb, &del_list);
2557 mutex_unlock(&nbd_index_mutex);
2559 while (!list_empty(&del_list)) {
2560 nbd = list_first_entry(&del_list, struct nbd_device, list);
2561 list_del_init(&nbd->list);
2562 if (refcount_read(&nbd->config_refs))
2563 pr_err("possibly leaking nbd_config (ref %d)\n",
2564 refcount_read(&nbd->config_refs));
2565 if (refcount_read(&nbd->refs) != 1)
2566 pr_err("possibly leaking a device\n");
2570 /* Also wait for nbd_dev_remove_work() completes */
2571 destroy_workqueue(nbd_del_wq);
2573 idr_destroy(&nbd_index_idr);
2574 unregister_blkdev(NBD_MAJOR, "nbd");
2577 module_init(nbd_init);
2578 module_exit(nbd_cleanup);
2580 MODULE_DESCRIPTION("Network Block Device");
2581 MODULE_LICENSE("GPL");
2583 module_param(nbds_max, int, 0444);
2584 MODULE_PARM_DESC(nbds_max, "number of network block devices to initialize (default: 16)");
2585 module_param(max_part, int, 0444);
2586 MODULE_PARM_DESC(max_part, "number of partitions per device (default: 16)");