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;
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 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;
293 /* If we are waiting on our dead timer then we could get timeout
294 * callbacks for our request. For this we just want to reset the timer
295 * and let the queue side take care of everything.
297 if (!completion_done(&cmd->send_complete)) {
299 return BLK_EH_RESET_TIMER;
301 config = nbd->config;
303 if (config->num_connections > 1) {
304 dev_err_ratelimited(nbd_to_dev(nbd),
305 "Connection timed out, retrying\n");
307 * Hooray we have more connections, requeue this IO, the submit
308 * path will put it on a real connection.
310 if (config->socks && config->num_connections > 1) {
311 if (cmd->index < config->num_connections) {
312 struct nbd_sock *nsock =
313 config->socks[cmd->index];
314 mutex_lock(&nsock->tx_lock);
315 /* We can have multiple outstanding requests, so
316 * we don't want to mark the nsock dead if we've
317 * already reconnected with a new socket, so
318 * only mark it dead if its the same socket we
321 if (cmd->cookie == nsock->cookie)
322 nbd_mark_nsock_dead(nbd, nsock, 1);
323 mutex_unlock(&nsock->tx_lock);
325 blk_mq_requeue_request(req, true);
327 return BLK_EH_NOT_HANDLED;
330 dev_err_ratelimited(nbd_to_dev(nbd),
331 "Connection timed out\n");
333 set_bit(NBD_TIMEDOUT, &config->runtime_flags);
334 cmd->status = BLK_STS_IOERR;
338 return BLK_EH_HANDLED;
342 * Send or receive packet.
344 static int sock_xmit(struct nbd_device *nbd, int index, int send,
345 struct iov_iter *iter, int msg_flags, int *sent)
347 struct nbd_config *config = nbd->config;
348 struct socket *sock = config->socks[index]->sock;
351 unsigned int noreclaim_flag;
353 if (unlikely(!sock)) {
354 dev_err_ratelimited(disk_to_dev(nbd->disk),
355 "Attempted %s on closed socket in sock_xmit\n",
356 (send ? "send" : "recv"));
360 msg.msg_iter = *iter;
362 noreclaim_flag = memalloc_noreclaim_save();
364 sock->sk->sk_allocation = GFP_NOIO | __GFP_MEMALLOC;
367 msg.msg_control = NULL;
368 msg.msg_controllen = 0;
369 msg.msg_flags = msg_flags | MSG_NOSIGNAL;
372 result = sock_sendmsg(sock, &msg);
374 result = sock_recvmsg(sock, &msg, msg.msg_flags);
378 result = -EPIPE; /* short read */
383 } while (msg_data_left(&msg));
385 memalloc_noreclaim_restore(noreclaim_flag);
390 /* always call with the tx_lock held */
391 static int nbd_send_cmd(struct nbd_device *nbd, struct nbd_cmd *cmd, int index)
393 struct request *req = blk_mq_rq_from_pdu(cmd);
394 struct nbd_config *config = nbd->config;
395 struct nbd_sock *nsock = config->socks[index];
397 struct nbd_request request = {.magic = htonl(NBD_REQUEST_MAGIC)};
398 struct kvec iov = {.iov_base = &request, .iov_len = sizeof(request)};
399 struct iov_iter from;
400 unsigned long size = blk_rq_bytes(req);
403 u32 nbd_cmd_flags = 0;
404 u32 tag = blk_mq_unique_tag(req);
405 int sent = nsock->sent, skip = 0;
407 iov_iter_kvec(&from, WRITE | ITER_KVEC, &iov, 1, sizeof(request));
409 switch (req_op(req)) {
414 type = NBD_CMD_FLUSH;
417 type = NBD_CMD_WRITE;
426 if (rq_data_dir(req) == WRITE &&
427 (config->flags & NBD_FLAG_READ_ONLY)) {
428 dev_err_ratelimited(disk_to_dev(nbd->disk),
429 "Write on read-only\n");
433 if (req->cmd_flags & REQ_FUA)
434 nbd_cmd_flags |= NBD_CMD_FLAG_FUA;
436 /* We did a partial send previously, and we at least sent the whole
437 * request struct, so just go and send the rest of the pages in the
441 if (sent >= sizeof(request)) {
442 skip = sent - sizeof(request);
445 iov_iter_advance(&from, sent);
448 cmd->cookie = nsock->cookie;
449 request.type = htonl(type | nbd_cmd_flags);
450 if (type != NBD_CMD_FLUSH) {
451 request.from = cpu_to_be64((u64)blk_rq_pos(req) << 9);
452 request.len = htonl(size);
454 memcpy(request.handle, &tag, sizeof(tag));
456 dev_dbg(nbd_to_dev(nbd), "request %p: sending control (%s@%llu,%uB)\n",
457 cmd, nbdcmd_to_ascii(type),
458 (unsigned long long)blk_rq_pos(req) << 9, blk_rq_bytes(req));
459 result = sock_xmit(nbd, index, 1, &from,
460 (type == NBD_CMD_WRITE) ? MSG_MORE : 0, &sent);
462 if (result == -ERESTARTSYS) {
463 /* If we havne't sent anything we can just return BUSY,
464 * however if we have sent something we need to make
465 * sure we only allow this req to be sent until we are
469 nsock->pending = req;
472 return BLK_MQ_RQ_QUEUE_BUSY;
474 dev_err_ratelimited(disk_to_dev(nbd->disk),
475 "Send control failed (result %d)\n", result);
479 if (type != NBD_CMD_WRITE)
484 struct bio *next = bio->bi_next;
485 struct bvec_iter iter;
488 bio_for_each_segment(bvec, bio, iter) {
489 bool is_last = !next && bio_iter_last(bvec, iter);
490 int flags = is_last ? 0 : MSG_MORE;
492 dev_dbg(nbd_to_dev(nbd), "request %p: sending %d bytes data\n",
494 iov_iter_bvec(&from, ITER_BVEC | WRITE,
495 &bvec, 1, bvec.bv_len);
497 if (skip >= iov_iter_count(&from)) {
498 skip -= iov_iter_count(&from);
501 iov_iter_advance(&from, skip);
504 result = sock_xmit(nbd, index, 1, &from, flags, &sent);
506 if (result == -ERESTARTSYS) {
507 /* We've already sent the header, we
508 * have no choice but to set pending and
511 nsock->pending = req;
513 return BLK_MQ_RQ_QUEUE_BUSY;
515 dev_err(disk_to_dev(nbd->disk),
516 "Send data failed (result %d)\n",
521 * The completion might already have come in,
522 * so break for the last one instead of letting
523 * the iterator do it. This prevents use-after-free
532 nsock->pending = NULL;
537 /* NULL returned = something went wrong, inform userspace */
538 static struct nbd_cmd *nbd_read_stat(struct nbd_device *nbd, int index)
540 struct nbd_config *config = nbd->config;
542 struct nbd_reply reply;
544 struct request *req = NULL;
547 struct kvec iov = {.iov_base = &reply, .iov_len = sizeof(reply)};
551 iov_iter_kvec(&to, READ | ITER_KVEC, &iov, 1, sizeof(reply));
552 result = sock_xmit(nbd, index, 0, &to, MSG_WAITALL, NULL);
554 if (!nbd_disconnected(config))
555 dev_err(disk_to_dev(nbd->disk),
556 "Receive control failed (result %d)\n", result);
557 return ERR_PTR(result);
560 if (ntohl(reply.magic) != NBD_REPLY_MAGIC) {
561 dev_err(disk_to_dev(nbd->disk), "Wrong magic (0x%lx)\n",
562 (unsigned long)ntohl(reply.magic));
563 return ERR_PTR(-EPROTO);
566 memcpy(&tag, reply.handle, sizeof(u32));
568 hwq = blk_mq_unique_tag_to_hwq(tag);
569 if (hwq < nbd->tag_set.nr_hw_queues)
570 req = blk_mq_tag_to_rq(nbd->tag_set.tags[hwq],
571 blk_mq_unique_tag_to_tag(tag));
572 if (!req || !blk_mq_request_started(req)) {
573 dev_err(disk_to_dev(nbd->disk), "Unexpected reply (%d) %p\n",
575 return ERR_PTR(-ENOENT);
577 cmd = blk_mq_rq_to_pdu(req);
578 if (ntohl(reply.error)) {
579 dev_err(disk_to_dev(nbd->disk), "Other side returned error (%d)\n",
581 cmd->status = BLK_STS_IOERR;
585 dev_dbg(nbd_to_dev(nbd), "request %p: got reply\n", cmd);
586 if (rq_data_dir(req) != WRITE) {
587 struct req_iterator iter;
590 rq_for_each_segment(bvec, req, iter) {
591 iov_iter_bvec(&to, ITER_BVEC | READ,
592 &bvec, 1, bvec.bv_len);
593 result = sock_xmit(nbd, index, 0, &to, MSG_WAITALL, NULL);
595 dev_err(disk_to_dev(nbd->disk), "Receive data failed (result %d)\n",
598 * If we've disconnected or we only have 1
599 * connection then we need to make sure we
600 * complete this request, otherwise error out
601 * and let the timeout stuff handle resubmitting
602 * this request onto another connection.
604 if (nbd_disconnected(config) ||
605 config->num_connections <= 1) {
606 cmd->status = BLK_STS_IOERR;
609 return ERR_PTR(-EIO);
611 dev_dbg(nbd_to_dev(nbd), "request %p: got %d bytes data\n",
615 /* See the comment in nbd_queue_rq. */
616 wait_for_completion(&cmd->send_complete);
621 static void recv_work(struct work_struct *work)
623 struct recv_thread_args *args = container_of(work,
624 struct recv_thread_args,
626 struct nbd_device *nbd = args->nbd;
627 struct nbd_config *config = nbd->config;
632 cmd = nbd_read_stat(nbd, args->index);
634 struct nbd_sock *nsock = config->socks[args->index];
636 mutex_lock(&nsock->tx_lock);
637 nbd_mark_nsock_dead(nbd, nsock, 1);
638 mutex_unlock(&nsock->tx_lock);
643 blk_mq_complete_request(blk_mq_rq_from_pdu(cmd));
645 atomic_dec(&config->recv_threads);
646 wake_up(&config->recv_wq);
651 static void nbd_clear_req(struct request *req, void *data, bool reserved)
655 if (!blk_mq_request_started(req))
657 cmd = blk_mq_rq_to_pdu(req);
658 cmd->status = BLK_STS_IOERR;
659 blk_mq_complete_request(req);
662 static void nbd_clear_que(struct nbd_device *nbd)
664 blk_mq_stop_hw_queues(nbd->disk->queue);
665 blk_mq_tagset_busy_iter(&nbd->tag_set, nbd_clear_req, NULL);
666 blk_mq_start_hw_queues(nbd->disk->queue);
667 dev_dbg(disk_to_dev(nbd->disk), "queue cleared\n");
670 static int find_fallback(struct nbd_device *nbd, int index)
672 struct nbd_config *config = nbd->config;
674 struct nbd_sock *nsock = config->socks[index];
675 int fallback = nsock->fallback_index;
677 if (test_bit(NBD_DISCONNECTED, &config->runtime_flags))
680 if (config->num_connections <= 1) {
681 dev_err_ratelimited(disk_to_dev(nbd->disk),
682 "Attempted send on invalid socket\n");
686 if (fallback >= 0 && fallback < config->num_connections &&
687 !config->socks[fallback]->dead)
690 if (nsock->fallback_index < 0 ||
691 nsock->fallback_index >= config->num_connections ||
692 config->socks[nsock->fallback_index]->dead) {
694 for (i = 0; i < config->num_connections; i++) {
697 if (!config->socks[i]->dead) {
702 nsock->fallback_index = new_index;
704 dev_err_ratelimited(disk_to_dev(nbd->disk),
705 "Dead connection, failed to find a fallback\n");
709 new_index = nsock->fallback_index;
713 static int wait_for_reconnect(struct nbd_device *nbd)
715 struct nbd_config *config = nbd->config;
716 if (!config->dead_conn_timeout)
718 if (test_bit(NBD_DISCONNECTED, &config->runtime_flags))
720 wait_event_interruptible_timeout(config->conn_wait,
721 atomic_read(&config->live_connections),
722 config->dead_conn_timeout);
723 return atomic_read(&config->live_connections);
726 static int nbd_handle_cmd(struct nbd_cmd *cmd, int index)
728 struct request *req = blk_mq_rq_from_pdu(cmd);
729 struct nbd_device *nbd = cmd->nbd;
730 struct nbd_config *config;
731 struct nbd_sock *nsock;
734 if (!refcount_inc_not_zero(&nbd->config_refs)) {
735 dev_err_ratelimited(disk_to_dev(nbd->disk),
736 "Socks array is empty\n");
739 config = nbd->config;
741 if (index >= config->num_connections) {
742 dev_err_ratelimited(disk_to_dev(nbd->disk),
743 "Attempted send on invalid socket\n");
747 cmd->status = BLK_STS_OK;
749 nsock = config->socks[index];
750 mutex_lock(&nsock->tx_lock);
752 int old_index = index;
753 index = find_fallback(nbd, index);
754 mutex_unlock(&nsock->tx_lock);
756 if (wait_for_reconnect(nbd)) {
760 /* All the sockets should already be down at this point,
761 * we just want to make sure that DISCONNECTED is set so
762 * any requests that come in that were queue'ed waiting
763 * for the reconnect timer don't trigger the timer again
764 * and instead just error out.
773 /* Handle the case that we have a pending request that was partially
774 * transmitted that _has_ to be serviced first. We need to call requeue
775 * here so that it gets put _after_ the request that is already on the
778 if (unlikely(nsock->pending && nsock->pending != req)) {
779 blk_mq_requeue_request(req, true);
784 * Some failures are related to the link going down, so anything that
785 * returns EAGAIN can be retried on a different socket.
787 ret = nbd_send_cmd(nbd, cmd, index);
788 if (ret == -EAGAIN) {
789 dev_err_ratelimited(disk_to_dev(nbd->disk),
790 "Request send failed trying another connection\n");
791 nbd_mark_nsock_dead(nbd, nsock, 1);
792 mutex_unlock(&nsock->tx_lock);
796 mutex_unlock(&nsock->tx_lock);
801 static int nbd_queue_rq(struct blk_mq_hw_ctx *hctx,
802 const struct blk_mq_queue_data *bd)
804 struct nbd_cmd *cmd = blk_mq_rq_to_pdu(bd->rq);
808 * Since we look at the bio's to send the request over the network we
809 * need to make sure the completion work doesn't mark this request done
810 * before we are done doing our send. This keeps us from dereferencing
811 * freed data if we have particularly fast completions (ie we get the
812 * completion before we exit sock_xmit on the last bvec) or in the case
813 * that the server is misbehaving (or there was an error) before we're
814 * done sending everything over the wire.
816 init_completion(&cmd->send_complete);
817 blk_mq_start_request(bd->rq);
819 /* We can be called directly from the user space process, which means we
820 * could possibly have signals pending so our sendmsg will fail. In
821 * this case we need to return that we are busy, otherwise error out as
824 ret = nbd_handle_cmd(cmd, hctx->queue_num);
826 ret = BLK_MQ_RQ_QUEUE_ERROR;
828 ret = BLK_MQ_RQ_QUEUE_OK;
829 complete(&cmd->send_complete);
834 static int nbd_add_socket(struct nbd_device *nbd, unsigned long arg,
837 struct nbd_config *config = nbd->config;
839 struct nbd_sock **socks;
840 struct nbd_sock *nsock;
843 sock = sockfd_lookup(arg, &err);
847 if (!netlink && !nbd->task_setup &&
848 !test_bit(NBD_BOUND, &config->runtime_flags))
849 nbd->task_setup = current;
852 (nbd->task_setup != current ||
853 test_bit(NBD_BOUND, &config->runtime_flags))) {
854 dev_err(disk_to_dev(nbd->disk),
855 "Device being setup by another task");
860 socks = krealloc(config->socks, (config->num_connections + 1) *
861 sizeof(struct nbd_sock *), GFP_KERNEL);
866 nsock = kzalloc(sizeof(struct nbd_sock), GFP_KERNEL);
872 config->socks = socks;
874 nsock->fallback_index = -1;
876 mutex_init(&nsock->tx_lock);
878 nsock->pending = NULL;
881 socks[config->num_connections++] = nsock;
882 atomic_inc(&config->live_connections);
887 static int nbd_reconnect_socket(struct nbd_device *nbd, unsigned long arg)
889 struct nbd_config *config = nbd->config;
890 struct socket *sock, *old;
891 struct recv_thread_args *args;
895 sock = sockfd_lookup(arg, &err);
899 args = kzalloc(sizeof(*args), GFP_KERNEL);
905 for (i = 0; i < config->num_connections; i++) {
906 struct nbd_sock *nsock = config->socks[i];
911 mutex_lock(&nsock->tx_lock);
913 mutex_unlock(&nsock->tx_lock);
916 sk_set_memalloc(sock->sk);
917 sock->sk->sk_sndtimeo = nbd->tag_set.timeout;
918 atomic_inc(&config->recv_threads);
919 refcount_inc(&nbd->config_refs);
921 nsock->fallback_index = -1;
924 INIT_WORK(&args->work, recv_work);
928 mutex_unlock(&nsock->tx_lock);
931 /* We take the tx_mutex in an error path in the recv_work, so we
932 * need to queue_work outside of the tx_mutex.
934 queue_work(recv_workqueue, &args->work);
936 atomic_inc(&config->live_connections);
937 wake_up(&config->conn_wait);
945 /* Reset all properties of an NBD device */
946 static void nbd_reset(struct nbd_device *nbd)
949 nbd->tag_set.timeout = 0;
950 queue_flag_clear_unlocked(QUEUE_FLAG_DISCARD, nbd->disk->queue);
953 static void nbd_bdev_reset(struct block_device *bdev)
955 if (bdev->bd_openers > 1)
957 bd_set_size(bdev, 0);
959 blkdev_reread_part(bdev);
960 bdev->bd_invalidated = 1;
964 static void nbd_parse_flags(struct nbd_device *nbd)
966 struct nbd_config *config = nbd->config;
967 if (config->flags & NBD_FLAG_READ_ONLY)
968 set_disk_ro(nbd->disk, true);
970 set_disk_ro(nbd->disk, false);
971 if (config->flags & NBD_FLAG_SEND_TRIM)
972 queue_flag_set_unlocked(QUEUE_FLAG_DISCARD, nbd->disk->queue);
973 if (config->flags & NBD_FLAG_SEND_FLUSH) {
974 if (config->flags & NBD_FLAG_SEND_FUA)
975 blk_queue_write_cache(nbd->disk->queue, true, true);
977 blk_queue_write_cache(nbd->disk->queue, true, false);
980 blk_queue_write_cache(nbd->disk->queue, false, false);
983 static void send_disconnects(struct nbd_device *nbd)
985 struct nbd_config *config = nbd->config;
986 struct nbd_request request = {
987 .magic = htonl(NBD_REQUEST_MAGIC),
988 .type = htonl(NBD_CMD_DISC),
990 struct kvec iov = {.iov_base = &request, .iov_len = sizeof(request)};
991 struct iov_iter from;
994 for (i = 0; i < config->num_connections; i++) {
995 iov_iter_kvec(&from, WRITE | ITER_KVEC, &iov, 1, sizeof(request));
996 ret = sock_xmit(nbd, i, 1, &from, 0, NULL);
998 dev_err(disk_to_dev(nbd->disk),
999 "Send disconnect failed %d\n", ret);
1003 static int nbd_disconnect(struct nbd_device *nbd)
1005 struct nbd_config *config = nbd->config;
1007 dev_info(disk_to_dev(nbd->disk), "NBD_DISCONNECT\n");
1008 if (!test_and_set_bit(NBD_DISCONNECT_REQUESTED,
1009 &config->runtime_flags))
1010 send_disconnects(nbd);
1014 static void nbd_clear_sock(struct nbd_device *nbd)
1018 nbd->task_setup = NULL;
1021 static void nbd_config_put(struct nbd_device *nbd)
1023 if (refcount_dec_and_mutex_lock(&nbd->config_refs,
1024 &nbd->config_lock)) {
1025 struct nbd_config *config = nbd->config;
1026 nbd_dev_dbg_close(nbd);
1027 nbd_size_clear(nbd);
1028 if (test_and_clear_bit(NBD_HAS_PID_FILE,
1029 &config->runtime_flags))
1030 device_remove_file(disk_to_dev(nbd->disk), &pid_attr);
1031 nbd->task_recv = NULL;
1032 nbd_clear_sock(nbd);
1033 if (config->num_connections) {
1035 for (i = 0; i < config->num_connections; i++) {
1036 sockfd_put(config->socks[i]->sock);
1037 kfree(config->socks[i]);
1039 kfree(config->socks);
1043 mutex_unlock(&nbd->config_lock);
1045 module_put(THIS_MODULE);
1049 static int nbd_start_device(struct nbd_device *nbd)
1051 struct nbd_config *config = nbd->config;
1052 int num_connections = config->num_connections;
1059 if (num_connections > 1 &&
1060 !(config->flags & NBD_FLAG_CAN_MULTI_CONN)) {
1061 dev_err(disk_to_dev(nbd->disk), "server does not support multiple connections per device.\n");
1065 blk_mq_update_nr_hw_queues(&nbd->tag_set, config->num_connections);
1066 nbd->task_recv = current;
1068 nbd_parse_flags(nbd);
1070 error = device_create_file(disk_to_dev(nbd->disk), &pid_attr);
1072 dev_err(disk_to_dev(nbd->disk), "device_create_file failed!\n");
1075 set_bit(NBD_HAS_PID_FILE, &config->runtime_flags);
1077 nbd_dev_dbg_init(nbd);
1078 for (i = 0; i < num_connections; i++) {
1079 struct recv_thread_args *args;
1081 args = kzalloc(sizeof(*args), GFP_KERNEL);
1086 sk_set_memalloc(config->socks[i]->sock->sk);
1087 config->socks[i]->sock->sk->sk_sndtimeo = nbd->tag_set.timeout;
1088 atomic_inc(&config->recv_threads);
1089 refcount_inc(&nbd->config_refs);
1090 INIT_WORK(&args->work, recv_work);
1093 queue_work(recv_workqueue, &args->work);
1098 static int nbd_start_device_ioctl(struct nbd_device *nbd, struct block_device *bdev)
1100 struct nbd_config *config = nbd->config;
1103 ret = nbd_start_device(nbd);
1107 bd_set_size(bdev, config->bytesize);
1109 bdev->bd_invalidated = 1;
1110 mutex_unlock(&nbd->config_lock);
1111 ret = wait_event_interruptible(config->recv_wq,
1112 atomic_read(&config->recv_threads) == 0);
1115 mutex_lock(&nbd->config_lock);
1116 bd_set_size(bdev, 0);
1117 /* user requested, ignore socket errors */
1118 if (test_bit(NBD_DISCONNECT_REQUESTED, &config->runtime_flags))
1120 if (test_bit(NBD_TIMEDOUT, &config->runtime_flags))
1125 static void nbd_clear_sock_ioctl(struct nbd_device *nbd,
1126 struct block_device *bdev)
1130 nbd_bdev_reset(bdev);
1131 if (test_and_clear_bit(NBD_HAS_CONFIG_REF,
1132 &nbd->config->runtime_flags))
1133 nbd_config_put(nbd);
1136 /* Must be called with config_lock held */
1137 static int __nbd_ioctl(struct block_device *bdev, struct nbd_device *nbd,
1138 unsigned int cmd, unsigned long arg)
1140 struct nbd_config *config = nbd->config;
1143 case NBD_DISCONNECT:
1144 return nbd_disconnect(nbd);
1145 case NBD_CLEAR_SOCK:
1146 nbd_clear_sock_ioctl(nbd, bdev);
1149 return nbd_add_socket(nbd, arg, false);
1150 case NBD_SET_BLKSIZE:
1151 nbd_size_set(nbd, arg,
1152 div_s64(config->bytesize, arg));
1155 nbd_size_set(nbd, config->blksize,
1156 div_s64(arg, config->blksize));
1158 case NBD_SET_SIZE_BLOCKS:
1159 nbd_size_set(nbd, config->blksize, arg);
1161 case NBD_SET_TIMEOUT:
1163 nbd->tag_set.timeout = arg * HZ;
1164 blk_queue_rq_timeout(nbd->disk->queue, arg * HZ);
1169 config->flags = arg;
1172 return nbd_start_device_ioctl(nbd, bdev);
1175 * This is for compatibility only. The queue is always cleared
1176 * by NBD_DO_IT or NBD_CLEAR_SOCK.
1179 case NBD_PRINT_DEBUG:
1181 * For compatibility only, we no longer keep a list of
1182 * outstanding requests.
1189 static int nbd_ioctl(struct block_device *bdev, fmode_t mode,
1190 unsigned int cmd, unsigned long arg)
1192 struct nbd_device *nbd = bdev->bd_disk->private_data;
1193 struct nbd_config *config = nbd->config;
1194 int error = -EINVAL;
1196 if (!capable(CAP_SYS_ADMIN))
1199 mutex_lock(&nbd->config_lock);
1201 /* Don't allow ioctl operations on a nbd device that was created with
1202 * netlink, unless it's DISCONNECT or CLEAR_SOCK, which are fine.
1204 if (!test_bit(NBD_BOUND, &config->runtime_flags) ||
1205 (cmd == NBD_DISCONNECT || cmd == NBD_CLEAR_SOCK))
1206 error = __nbd_ioctl(bdev, nbd, cmd, arg);
1208 dev_err(nbd_to_dev(nbd), "Cannot use ioctl interface on a netlink controlled device.\n");
1209 mutex_unlock(&nbd->config_lock);
1213 static struct nbd_config *nbd_alloc_config(void)
1215 struct nbd_config *config;
1217 config = kzalloc(sizeof(struct nbd_config), GFP_NOFS);
1220 atomic_set(&config->recv_threads, 0);
1221 init_waitqueue_head(&config->recv_wq);
1222 init_waitqueue_head(&config->conn_wait);
1223 config->blksize = 1024;
1224 atomic_set(&config->live_connections, 0);
1225 try_module_get(THIS_MODULE);
1229 static int nbd_open(struct block_device *bdev, fmode_t mode)
1231 struct nbd_device *nbd;
1234 mutex_lock(&nbd_index_mutex);
1235 nbd = bdev->bd_disk->private_data;
1240 if (!refcount_inc_not_zero(&nbd->refs)) {
1244 if (!refcount_inc_not_zero(&nbd->config_refs)) {
1245 struct nbd_config *config;
1247 mutex_lock(&nbd->config_lock);
1248 if (refcount_inc_not_zero(&nbd->config_refs)) {
1249 mutex_unlock(&nbd->config_lock);
1252 config = nbd->config = nbd_alloc_config();
1255 mutex_unlock(&nbd->config_lock);
1258 refcount_set(&nbd->config_refs, 1);
1259 refcount_inc(&nbd->refs);
1260 mutex_unlock(&nbd->config_lock);
1263 mutex_unlock(&nbd_index_mutex);
1267 static void nbd_release(struct gendisk *disk, fmode_t mode)
1269 struct nbd_device *nbd = disk->private_data;
1270 nbd_config_put(nbd);
1274 static const struct block_device_operations nbd_fops =
1276 .owner = THIS_MODULE,
1278 .release = nbd_release,
1280 .compat_ioctl = nbd_ioctl,
1283 #if IS_ENABLED(CONFIG_DEBUG_FS)
1285 static int nbd_dbg_tasks_show(struct seq_file *s, void *unused)
1287 struct nbd_device *nbd = s->private;
1290 seq_printf(s, "recv: %d\n", task_pid_nr(nbd->task_recv));
1295 static int nbd_dbg_tasks_open(struct inode *inode, struct file *file)
1297 return single_open(file, nbd_dbg_tasks_show, inode->i_private);
1300 static const struct file_operations nbd_dbg_tasks_ops = {
1301 .open = nbd_dbg_tasks_open,
1303 .llseek = seq_lseek,
1304 .release = single_release,
1307 static int nbd_dbg_flags_show(struct seq_file *s, void *unused)
1309 struct nbd_device *nbd = s->private;
1310 u32 flags = nbd->config->flags;
1312 seq_printf(s, "Hex: 0x%08x\n\n", flags);
1314 seq_puts(s, "Known flags:\n");
1316 if (flags & NBD_FLAG_HAS_FLAGS)
1317 seq_puts(s, "NBD_FLAG_HAS_FLAGS\n");
1318 if (flags & NBD_FLAG_READ_ONLY)
1319 seq_puts(s, "NBD_FLAG_READ_ONLY\n");
1320 if (flags & NBD_FLAG_SEND_FLUSH)
1321 seq_puts(s, "NBD_FLAG_SEND_FLUSH\n");
1322 if (flags & NBD_FLAG_SEND_FUA)
1323 seq_puts(s, "NBD_FLAG_SEND_FUA\n");
1324 if (flags & NBD_FLAG_SEND_TRIM)
1325 seq_puts(s, "NBD_FLAG_SEND_TRIM\n");
1330 static int nbd_dbg_flags_open(struct inode *inode, struct file *file)
1332 return single_open(file, nbd_dbg_flags_show, inode->i_private);
1335 static const struct file_operations nbd_dbg_flags_ops = {
1336 .open = nbd_dbg_flags_open,
1338 .llseek = seq_lseek,
1339 .release = single_release,
1342 static int nbd_dev_dbg_init(struct nbd_device *nbd)
1345 struct nbd_config *config = nbd->config;
1350 dir = debugfs_create_dir(nbd_name(nbd), nbd_dbg_dir);
1352 dev_err(nbd_to_dev(nbd), "Failed to create debugfs dir for '%s'\n",
1356 config->dbg_dir = dir;
1358 debugfs_create_file("tasks", 0444, dir, nbd, &nbd_dbg_tasks_ops);
1359 debugfs_create_u64("size_bytes", 0444, dir, &config->bytesize);
1360 debugfs_create_u32("timeout", 0444, dir, &nbd->tag_set.timeout);
1361 debugfs_create_u64("blocksize", 0444, dir, &config->blksize);
1362 debugfs_create_file("flags", 0444, dir, nbd, &nbd_dbg_flags_ops);
1367 static void nbd_dev_dbg_close(struct nbd_device *nbd)
1369 debugfs_remove_recursive(nbd->config->dbg_dir);
1372 static int nbd_dbg_init(void)
1374 struct dentry *dbg_dir;
1376 dbg_dir = debugfs_create_dir("nbd", NULL);
1380 nbd_dbg_dir = dbg_dir;
1385 static void nbd_dbg_close(void)
1387 debugfs_remove_recursive(nbd_dbg_dir);
1390 #else /* IS_ENABLED(CONFIG_DEBUG_FS) */
1392 static int nbd_dev_dbg_init(struct nbd_device *nbd)
1397 static void nbd_dev_dbg_close(struct nbd_device *nbd)
1401 static int nbd_dbg_init(void)
1406 static void nbd_dbg_close(void)
1412 static int nbd_init_request(struct blk_mq_tag_set *set, struct request *rq,
1413 unsigned int hctx_idx, unsigned int numa_node)
1415 struct nbd_cmd *cmd = blk_mq_rq_to_pdu(rq);
1416 cmd->nbd = set->driver_data;
1420 static const struct blk_mq_ops nbd_mq_ops = {
1421 .queue_rq = nbd_queue_rq,
1422 .complete = nbd_complete_rq,
1423 .init_request = nbd_init_request,
1424 .timeout = nbd_xmit_timeout,
1427 static int nbd_dev_add(int index)
1429 struct nbd_device *nbd;
1430 struct gendisk *disk;
1431 struct request_queue *q;
1434 nbd = kzalloc(sizeof(struct nbd_device), GFP_KERNEL);
1438 disk = alloc_disk(1 << part_shift);
1443 err = idr_alloc(&nbd_index_idr, nbd, index, index + 1,
1448 err = idr_alloc(&nbd_index_idr, nbd, 0, 0, GFP_KERNEL);
1457 nbd->tag_set.ops = &nbd_mq_ops;
1458 nbd->tag_set.nr_hw_queues = 1;
1459 nbd->tag_set.queue_depth = 128;
1460 nbd->tag_set.numa_node = NUMA_NO_NODE;
1461 nbd->tag_set.cmd_size = sizeof(struct nbd_cmd);
1462 nbd->tag_set.flags = BLK_MQ_F_SHOULD_MERGE |
1463 BLK_MQ_F_SG_MERGE | BLK_MQ_F_BLOCKING;
1464 nbd->tag_set.driver_data = nbd;
1466 err = blk_mq_alloc_tag_set(&nbd->tag_set);
1470 q = blk_mq_init_queue(&nbd->tag_set);
1478 * Tell the block layer that we are not a rotational device
1480 queue_flag_set_unlocked(QUEUE_FLAG_NONROT, disk->queue);
1481 queue_flag_clear_unlocked(QUEUE_FLAG_ADD_RANDOM, disk->queue);
1482 disk->queue->limits.discard_granularity = 512;
1483 blk_queue_max_discard_sectors(disk->queue, UINT_MAX);
1484 blk_queue_max_segment_size(disk->queue, UINT_MAX);
1485 blk_queue_max_segments(disk->queue, USHRT_MAX);
1486 blk_queue_max_hw_sectors(disk->queue, 65536);
1487 disk->queue->limits.max_sectors = 256;
1489 mutex_init(&nbd->config_lock);
1490 refcount_set(&nbd->config_refs, 0);
1491 refcount_set(&nbd->refs, 1);
1492 INIT_LIST_HEAD(&nbd->list);
1493 disk->major = NBD_MAJOR;
1494 disk->first_minor = index << part_shift;
1495 disk->fops = &nbd_fops;
1496 disk->private_data = nbd;
1497 sprintf(disk->disk_name, "nbd%d", index);
1500 nbd_total_devices++;
1504 blk_mq_free_tag_set(&nbd->tag_set);
1506 idr_remove(&nbd_index_idr, index);
1515 static int find_free_cb(int id, void *ptr, void *data)
1517 struct nbd_device *nbd = ptr;
1518 struct nbd_device **found = data;
1520 if (!refcount_read(&nbd->config_refs)) {
1527 /* Netlink interface. */
1528 static struct nla_policy nbd_attr_policy[NBD_ATTR_MAX + 1] = {
1529 [NBD_ATTR_INDEX] = { .type = NLA_U32 },
1530 [NBD_ATTR_SIZE_BYTES] = { .type = NLA_U64 },
1531 [NBD_ATTR_BLOCK_SIZE_BYTES] = { .type = NLA_U64 },
1532 [NBD_ATTR_TIMEOUT] = { .type = NLA_U64 },
1533 [NBD_ATTR_SERVER_FLAGS] = { .type = NLA_U64 },
1534 [NBD_ATTR_CLIENT_FLAGS] = { .type = NLA_U64 },
1535 [NBD_ATTR_SOCKETS] = { .type = NLA_NESTED},
1536 [NBD_ATTR_DEAD_CONN_TIMEOUT] = { .type = NLA_U64 },
1537 [NBD_ATTR_DEVICE_LIST] = { .type = NLA_NESTED},
1540 static struct nla_policy nbd_sock_policy[NBD_SOCK_MAX + 1] = {
1541 [NBD_SOCK_FD] = { .type = NLA_U32 },
1544 /* We don't use this right now since we don't parse the incoming list, but we
1545 * still want it here so userspace knows what to expect.
1547 static struct nla_policy __attribute__((unused))
1548 nbd_device_policy[NBD_DEVICE_ATTR_MAX + 1] = {
1549 [NBD_DEVICE_INDEX] = { .type = NLA_U32 },
1550 [NBD_DEVICE_CONNECTED] = { .type = NLA_U8 },
1553 static int nbd_genl_connect(struct sk_buff *skb, struct genl_info *info)
1555 struct nbd_device *nbd = NULL;
1556 struct nbd_config *config;
1559 bool put_dev = false;
1561 if (!netlink_capable(skb, CAP_SYS_ADMIN))
1564 if (info->attrs[NBD_ATTR_INDEX])
1565 index = nla_get_u32(info->attrs[NBD_ATTR_INDEX]);
1566 if (!info->attrs[NBD_ATTR_SOCKETS]) {
1567 printk(KERN_ERR "nbd: must specify at least one socket\n");
1570 if (!info->attrs[NBD_ATTR_SIZE_BYTES]) {
1571 printk(KERN_ERR "nbd: must specify a size in bytes for the device\n");
1575 mutex_lock(&nbd_index_mutex);
1577 ret = idr_for_each(&nbd_index_idr, &find_free_cb, &nbd);
1580 new_index = nbd_dev_add(-1);
1581 if (new_index < 0) {
1582 mutex_unlock(&nbd_index_mutex);
1583 printk(KERN_ERR "nbd: failed to add new device\n");
1586 nbd = idr_find(&nbd_index_idr, new_index);
1589 nbd = idr_find(&nbd_index_idr, index);
1592 printk(KERN_ERR "nbd: couldn't find device at index %d\n",
1594 mutex_unlock(&nbd_index_mutex);
1597 if (!refcount_inc_not_zero(&nbd->refs)) {
1598 mutex_unlock(&nbd_index_mutex);
1601 printk(KERN_ERR "nbd: device at index %d is going down\n",
1605 mutex_unlock(&nbd_index_mutex);
1607 mutex_lock(&nbd->config_lock);
1608 if (refcount_read(&nbd->config_refs)) {
1609 mutex_unlock(&nbd->config_lock);
1613 printk(KERN_ERR "nbd: nbd%d already in use\n", index);
1616 if (WARN_ON(nbd->config)) {
1617 mutex_unlock(&nbd->config_lock);
1621 config = nbd->config = nbd_alloc_config();
1623 mutex_unlock(&nbd->config_lock);
1625 printk(KERN_ERR "nbd: couldn't allocate config\n");
1628 refcount_set(&nbd->config_refs, 1);
1629 set_bit(NBD_BOUND, &config->runtime_flags);
1631 if (info->attrs[NBD_ATTR_SIZE_BYTES]) {
1632 u64 bytes = nla_get_u64(info->attrs[NBD_ATTR_SIZE_BYTES]);
1633 nbd_size_set(nbd, config->blksize,
1634 div64_u64(bytes, config->blksize));
1636 if (info->attrs[NBD_ATTR_BLOCK_SIZE_BYTES]) {
1638 nla_get_u64(info->attrs[NBD_ATTR_BLOCK_SIZE_BYTES]);
1639 nbd_size_set(nbd, bsize, div64_u64(config->bytesize, bsize));
1641 if (info->attrs[NBD_ATTR_TIMEOUT]) {
1642 u64 timeout = nla_get_u64(info->attrs[NBD_ATTR_TIMEOUT]);
1643 nbd->tag_set.timeout = timeout * HZ;
1644 blk_queue_rq_timeout(nbd->disk->queue, timeout * HZ);
1646 if (info->attrs[NBD_ATTR_DEAD_CONN_TIMEOUT]) {
1647 config->dead_conn_timeout =
1648 nla_get_u64(info->attrs[NBD_ATTR_DEAD_CONN_TIMEOUT]);
1649 config->dead_conn_timeout *= HZ;
1651 if (info->attrs[NBD_ATTR_SERVER_FLAGS])
1653 nla_get_u64(info->attrs[NBD_ATTR_SERVER_FLAGS]);
1654 if (info->attrs[NBD_ATTR_CLIENT_FLAGS]) {
1655 u64 flags = nla_get_u64(info->attrs[NBD_ATTR_CLIENT_FLAGS]);
1656 if (flags & NBD_CFLAG_DESTROY_ON_DISCONNECT) {
1657 set_bit(NBD_DESTROY_ON_DISCONNECT,
1658 &config->runtime_flags);
1663 if (info->attrs[NBD_ATTR_SOCKETS]) {
1664 struct nlattr *attr;
1667 nla_for_each_nested(attr, info->attrs[NBD_ATTR_SOCKETS],
1669 struct nlattr *socks[NBD_SOCK_MAX+1];
1671 if (nla_type(attr) != NBD_SOCK_ITEM) {
1672 printk(KERN_ERR "nbd: socks must be embedded in a SOCK_ITEM attr\n");
1676 ret = nla_parse_nested(socks, NBD_SOCK_MAX, attr,
1677 nbd_sock_policy, info->extack);
1679 printk(KERN_ERR "nbd: error processing sock list\n");
1683 if (!socks[NBD_SOCK_FD])
1685 fd = (int)nla_get_u32(socks[NBD_SOCK_FD]);
1686 ret = nbd_add_socket(nbd, fd, true);
1691 ret = nbd_start_device(nbd);
1693 mutex_unlock(&nbd->config_lock);
1695 set_bit(NBD_HAS_CONFIG_REF, &config->runtime_flags);
1696 refcount_inc(&nbd->config_refs);
1697 nbd_connect_reply(info, nbd->index);
1699 nbd_config_put(nbd);
1705 static int nbd_genl_disconnect(struct sk_buff *skb, struct genl_info *info)
1707 struct nbd_device *nbd;
1710 if (!netlink_capable(skb, CAP_SYS_ADMIN))
1713 if (!info->attrs[NBD_ATTR_INDEX]) {
1714 printk(KERN_ERR "nbd: must specify an index to disconnect\n");
1717 index = nla_get_u32(info->attrs[NBD_ATTR_INDEX]);
1718 mutex_lock(&nbd_index_mutex);
1719 nbd = idr_find(&nbd_index_idr, index);
1721 mutex_unlock(&nbd_index_mutex);
1722 printk(KERN_ERR "nbd: couldn't find device at index %d\n",
1726 if (!refcount_inc_not_zero(&nbd->refs)) {
1727 mutex_unlock(&nbd_index_mutex);
1728 printk(KERN_ERR "nbd: device at index %d is going down\n",
1732 mutex_unlock(&nbd_index_mutex);
1733 if (!refcount_inc_not_zero(&nbd->config_refs)) {
1737 mutex_lock(&nbd->config_lock);
1738 nbd_disconnect(nbd);
1739 mutex_unlock(&nbd->config_lock);
1740 if (test_and_clear_bit(NBD_HAS_CONFIG_REF,
1741 &nbd->config->runtime_flags))
1742 nbd_config_put(nbd);
1743 nbd_config_put(nbd);
1748 static int nbd_genl_reconfigure(struct sk_buff *skb, struct genl_info *info)
1750 struct nbd_device *nbd = NULL;
1751 struct nbd_config *config;
1754 bool put_dev = false;
1756 if (!netlink_capable(skb, CAP_SYS_ADMIN))
1759 if (!info->attrs[NBD_ATTR_INDEX]) {
1760 printk(KERN_ERR "nbd: must specify a device to reconfigure\n");
1763 index = nla_get_u32(info->attrs[NBD_ATTR_INDEX]);
1764 mutex_lock(&nbd_index_mutex);
1765 nbd = idr_find(&nbd_index_idr, index);
1767 mutex_unlock(&nbd_index_mutex);
1768 printk(KERN_ERR "nbd: couldn't find a device at index %d\n",
1772 if (!refcount_inc_not_zero(&nbd->refs)) {
1773 mutex_unlock(&nbd_index_mutex);
1774 printk(KERN_ERR "nbd: device at index %d is going down\n",
1778 mutex_unlock(&nbd_index_mutex);
1780 if (!refcount_inc_not_zero(&nbd->config_refs)) {
1781 dev_err(nbd_to_dev(nbd),
1782 "not configured, cannot reconfigure\n");
1787 mutex_lock(&nbd->config_lock);
1788 config = nbd->config;
1789 if (!test_bit(NBD_BOUND, &config->runtime_flags) ||
1791 dev_err(nbd_to_dev(nbd),
1792 "not configured, cannot reconfigure\n");
1796 if (info->attrs[NBD_ATTR_TIMEOUT]) {
1797 u64 timeout = nla_get_u64(info->attrs[NBD_ATTR_TIMEOUT]);
1798 nbd->tag_set.timeout = timeout * HZ;
1799 blk_queue_rq_timeout(nbd->disk->queue, timeout * HZ);
1801 if (info->attrs[NBD_ATTR_DEAD_CONN_TIMEOUT]) {
1802 config->dead_conn_timeout =
1803 nla_get_u64(info->attrs[NBD_ATTR_DEAD_CONN_TIMEOUT]);
1804 config->dead_conn_timeout *= HZ;
1806 if (info->attrs[NBD_ATTR_CLIENT_FLAGS]) {
1807 u64 flags = nla_get_u64(info->attrs[NBD_ATTR_CLIENT_FLAGS]);
1808 if (flags & NBD_CFLAG_DESTROY_ON_DISCONNECT) {
1809 if (!test_and_set_bit(NBD_DESTROY_ON_DISCONNECT,
1810 &config->runtime_flags))
1813 if (test_and_clear_bit(NBD_DESTROY_ON_DISCONNECT,
1814 &config->runtime_flags))
1815 refcount_inc(&nbd->refs);
1819 if (info->attrs[NBD_ATTR_SOCKETS]) {
1820 struct nlattr *attr;
1823 nla_for_each_nested(attr, info->attrs[NBD_ATTR_SOCKETS],
1825 struct nlattr *socks[NBD_SOCK_MAX+1];
1827 if (nla_type(attr) != NBD_SOCK_ITEM) {
1828 printk(KERN_ERR "nbd: socks must be embedded in a SOCK_ITEM attr\n");
1832 ret = nla_parse_nested(socks, NBD_SOCK_MAX, attr,
1833 nbd_sock_policy, info->extack);
1835 printk(KERN_ERR "nbd: error processing sock list\n");
1839 if (!socks[NBD_SOCK_FD])
1841 fd = (int)nla_get_u32(socks[NBD_SOCK_FD]);
1842 ret = nbd_reconnect_socket(nbd, fd);
1848 dev_info(nbd_to_dev(nbd), "reconnected socket\n");
1852 mutex_unlock(&nbd->config_lock);
1853 nbd_config_put(nbd);
1860 static const struct genl_ops nbd_connect_genl_ops[] = {
1862 .cmd = NBD_CMD_CONNECT,
1863 .policy = nbd_attr_policy,
1864 .doit = nbd_genl_connect,
1867 .cmd = NBD_CMD_DISCONNECT,
1868 .policy = nbd_attr_policy,
1869 .doit = nbd_genl_disconnect,
1872 .cmd = NBD_CMD_RECONFIGURE,
1873 .policy = nbd_attr_policy,
1874 .doit = nbd_genl_reconfigure,
1877 .cmd = NBD_CMD_STATUS,
1878 .policy = nbd_attr_policy,
1879 .doit = nbd_genl_status,
1883 static const struct genl_multicast_group nbd_mcast_grps[] = {
1884 { .name = NBD_GENL_MCAST_GROUP_NAME, },
1887 static struct genl_family nbd_genl_family __ro_after_init = {
1889 .name = NBD_GENL_FAMILY_NAME,
1890 .version = NBD_GENL_VERSION,
1891 .module = THIS_MODULE,
1892 .ops = nbd_connect_genl_ops,
1893 .n_ops = ARRAY_SIZE(nbd_connect_genl_ops),
1894 .maxattr = NBD_ATTR_MAX,
1895 .mcgrps = nbd_mcast_grps,
1896 .n_mcgrps = ARRAY_SIZE(nbd_mcast_grps),
1899 static int populate_nbd_status(struct nbd_device *nbd, struct sk_buff *reply)
1901 struct nlattr *dev_opt;
1905 /* This is a little racey, but for status it's ok. The
1906 * reason we don't take a ref here is because we can't
1907 * take a ref in the index == -1 case as we would need
1908 * to put under the nbd_index_mutex, which could
1909 * deadlock if we are configured to remove ourselves
1910 * once we're disconnected.
1912 if (refcount_read(&nbd->config_refs))
1914 dev_opt = nla_nest_start(reply, NBD_DEVICE_ITEM);
1917 ret = nla_put_u32(reply, NBD_DEVICE_INDEX, nbd->index);
1920 ret = nla_put_u8(reply, NBD_DEVICE_CONNECTED,
1924 nla_nest_end(reply, dev_opt);
1928 static int status_cb(int id, void *ptr, void *data)
1930 struct nbd_device *nbd = ptr;
1931 return populate_nbd_status(nbd, (struct sk_buff *)data);
1934 static int nbd_genl_status(struct sk_buff *skb, struct genl_info *info)
1936 struct nlattr *dev_list;
1937 struct sk_buff *reply;
1943 if (info->attrs[NBD_ATTR_INDEX])
1944 index = nla_get_u32(info->attrs[NBD_ATTR_INDEX]);
1946 mutex_lock(&nbd_index_mutex);
1948 msg_size = nla_total_size(nla_attr_size(sizeof(u32)) +
1949 nla_attr_size(sizeof(u8)));
1950 msg_size *= (index == -1) ? nbd_total_devices : 1;
1952 reply = genlmsg_new(msg_size, GFP_KERNEL);
1955 reply_head = genlmsg_put_reply(reply, info, &nbd_genl_family, 0,
1962 dev_list = nla_nest_start(reply, NBD_ATTR_DEVICE_LIST);
1964 ret = idr_for_each(&nbd_index_idr, &status_cb, reply);
1970 struct nbd_device *nbd;
1971 nbd = idr_find(&nbd_index_idr, index);
1973 ret = populate_nbd_status(nbd, reply);
1980 nla_nest_end(reply, dev_list);
1981 genlmsg_end(reply, reply_head);
1982 genlmsg_reply(reply, info);
1985 mutex_unlock(&nbd_index_mutex);
1989 static void nbd_connect_reply(struct genl_info *info, int index)
1991 struct sk_buff *skb;
1995 skb = genlmsg_new(nla_total_size(sizeof(u32)), GFP_KERNEL);
1998 msg_head = genlmsg_put_reply(skb, info, &nbd_genl_family, 0,
2004 ret = nla_put_u32(skb, NBD_ATTR_INDEX, index);
2009 genlmsg_end(skb, msg_head);
2010 genlmsg_reply(skb, info);
2013 static void nbd_mcast_index(int index)
2015 struct sk_buff *skb;
2019 skb = genlmsg_new(nla_total_size(sizeof(u32)), GFP_KERNEL);
2022 msg_head = genlmsg_put(skb, 0, 0, &nbd_genl_family, 0,
2028 ret = nla_put_u32(skb, NBD_ATTR_INDEX, index);
2033 genlmsg_end(skb, msg_head);
2034 genlmsg_multicast(&nbd_genl_family, skb, 0, 0, GFP_KERNEL);
2037 static void nbd_dead_link_work(struct work_struct *work)
2039 struct link_dead_args *args = container_of(work, struct link_dead_args,
2041 nbd_mcast_index(args->index);
2045 static int __init nbd_init(void)
2049 BUILD_BUG_ON(sizeof(struct nbd_request) != 28);
2052 printk(KERN_ERR "nbd: max_part must be >= 0\n");
2058 part_shift = fls(max_part);
2061 * Adjust max_part according to part_shift as it is exported
2062 * to user space so that user can know the max number of
2063 * partition kernel should be able to manage.
2065 * Note that -1 is required because partition 0 is reserved
2066 * for the whole disk.
2068 max_part = (1UL << part_shift) - 1;
2071 if ((1UL << part_shift) > DISK_MAX_PARTS)
2074 if (nbds_max > 1UL << (MINORBITS - part_shift))
2076 recv_workqueue = alloc_workqueue("knbd-recv",
2077 WQ_MEM_RECLAIM | WQ_HIGHPRI, 0);
2078 if (!recv_workqueue)
2081 if (register_blkdev(NBD_MAJOR, "nbd")) {
2082 destroy_workqueue(recv_workqueue);
2086 if (genl_register_family(&nbd_genl_family)) {
2087 unregister_blkdev(NBD_MAJOR, "nbd");
2088 destroy_workqueue(recv_workqueue);
2093 mutex_lock(&nbd_index_mutex);
2094 for (i = 0; i < nbds_max; i++)
2096 mutex_unlock(&nbd_index_mutex);
2100 static int nbd_exit_cb(int id, void *ptr, void *data)
2102 struct list_head *list = (struct list_head *)data;
2103 struct nbd_device *nbd = ptr;
2105 list_add_tail(&nbd->list, list);
2109 static void __exit nbd_cleanup(void)
2111 struct nbd_device *nbd;
2112 LIST_HEAD(del_list);
2116 mutex_lock(&nbd_index_mutex);
2117 idr_for_each(&nbd_index_idr, &nbd_exit_cb, &del_list);
2118 mutex_unlock(&nbd_index_mutex);
2120 while (!list_empty(&del_list)) {
2121 nbd = list_first_entry(&del_list, struct nbd_device, list);
2122 list_del_init(&nbd->list);
2123 if (refcount_read(&nbd->refs) != 1)
2124 printk(KERN_ERR "nbd: possibly leaking a device\n");
2128 idr_destroy(&nbd_index_idr);
2129 genl_unregister_family(&nbd_genl_family);
2130 destroy_workqueue(recv_workqueue);
2131 unregister_blkdev(NBD_MAJOR, "nbd");
2134 module_init(nbd_init);
2135 module_exit(nbd_cleanup);
2137 MODULE_DESCRIPTION("Network Block Device");
2138 MODULE_LICENSE("GPL");
2140 module_param(nbds_max, int, 0444);
2141 MODULE_PARM_DESC(nbds_max, "number of network block devices to initialize (default: 16)");
2142 module_param(max_part, int, 0444);
2143 MODULE_PARM_DESC(max_part, "number of partitions per device (default: 0)");