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
79 #define NBD_DISCONNECT_ON_CLOSE 7
83 unsigned long runtime_flags;
84 u64 dead_conn_timeout;
86 struct nbd_sock **socks;
88 atomic_t live_connections;
89 wait_queue_head_t conn_wait;
91 atomic_t recv_threads;
92 wait_queue_head_t recv_wq;
95 #if IS_ENABLED(CONFIG_DEBUG_FS)
96 struct dentry *dbg_dir;
101 struct blk_mq_tag_set tag_set;
104 refcount_t config_refs;
106 struct nbd_config *config;
107 struct mutex config_lock;
108 struct gendisk *disk;
110 struct list_head list;
111 struct task_struct *task_recv;
112 struct task_struct *task_setup;
115 #define NBD_CMD_REQUEUED 1
118 struct nbd_device *nbd;
127 #if IS_ENABLED(CONFIG_DEBUG_FS)
128 static struct dentry *nbd_dbg_dir;
131 #define nbd_name(nbd) ((nbd)->disk->disk_name)
133 #define NBD_MAGIC 0x68797548
135 static unsigned int nbds_max = 16;
136 static int max_part = 16;
137 static struct workqueue_struct *recv_workqueue;
138 static int part_shift;
140 static int nbd_dev_dbg_init(struct nbd_device *nbd);
141 static void nbd_dev_dbg_close(struct nbd_device *nbd);
142 static void nbd_config_put(struct nbd_device *nbd);
143 static void nbd_connect_reply(struct genl_info *info, int index);
144 static int nbd_genl_status(struct sk_buff *skb, struct genl_info *info);
145 static void nbd_dead_link_work(struct work_struct *work);
146 static void nbd_disconnect_and_put(struct nbd_device *nbd);
148 static inline struct device *nbd_to_dev(struct nbd_device *nbd)
150 return disk_to_dev(nbd->disk);
153 static void nbd_requeue_cmd(struct nbd_cmd *cmd)
155 struct request *req = blk_mq_rq_from_pdu(cmd);
157 if (!test_and_set_bit(NBD_CMD_REQUEUED, &cmd->flags))
158 blk_mq_requeue_request(req, true);
161 #define NBD_COOKIE_BITS 32
163 static u64 nbd_cmd_handle(struct nbd_cmd *cmd)
165 struct request *req = blk_mq_rq_from_pdu(cmd);
166 u32 tag = blk_mq_unique_tag(req);
167 u64 cookie = cmd->cmd_cookie;
169 return (cookie << NBD_COOKIE_BITS) | tag;
172 static u32 nbd_handle_to_tag(u64 handle)
177 static u32 nbd_handle_to_cookie(u64 handle)
179 return (u32)(handle >> NBD_COOKIE_BITS);
182 static const char *nbdcmd_to_ascii(int cmd)
185 case NBD_CMD_READ: return "read";
186 case NBD_CMD_WRITE: return "write";
187 case NBD_CMD_DISC: return "disconnect";
188 case NBD_CMD_FLUSH: return "flush";
189 case NBD_CMD_TRIM: return "trim/discard";
194 static ssize_t pid_show(struct device *dev,
195 struct device_attribute *attr, char *buf)
197 struct gendisk *disk = dev_to_disk(dev);
198 struct nbd_device *nbd = (struct nbd_device *)disk->private_data;
200 return sprintf(buf, "%d\n", task_pid_nr(nbd->task_recv));
203 static const struct device_attribute pid_attr = {
204 .attr = { .name = "pid", .mode = 0444},
208 static void nbd_dev_remove(struct nbd_device *nbd)
210 struct gendisk *disk = nbd->disk;
211 struct request_queue *q;
216 blk_cleanup_queue(q);
217 blk_mq_free_tag_set(&nbd->tag_set);
218 disk->private_data = NULL;
224 static void nbd_put(struct nbd_device *nbd)
226 if (refcount_dec_and_mutex_lock(&nbd->refs,
228 idr_remove(&nbd_index_idr, nbd->index);
229 mutex_unlock(&nbd_index_mutex);
234 static int nbd_disconnected(struct nbd_config *config)
236 return test_bit(NBD_DISCONNECTED, &config->runtime_flags) ||
237 test_bit(NBD_DISCONNECT_REQUESTED, &config->runtime_flags);
240 static void nbd_mark_nsock_dead(struct nbd_device *nbd, struct nbd_sock *nsock,
243 if (!nsock->dead && notify && !nbd_disconnected(nbd->config)) {
244 struct link_dead_args *args;
245 args = kmalloc(sizeof(struct link_dead_args), GFP_NOIO);
247 INIT_WORK(&args->work, nbd_dead_link_work);
248 args->index = nbd->index;
249 queue_work(system_wq, &args->work);
253 kernel_sock_shutdown(nsock->sock, SHUT_RDWR);
254 if (atomic_dec_return(&nbd->config->live_connections) == 0) {
255 if (test_and_clear_bit(NBD_DISCONNECT_REQUESTED,
256 &nbd->config->runtime_flags)) {
257 set_bit(NBD_DISCONNECTED,
258 &nbd->config->runtime_flags);
259 dev_info(nbd_to_dev(nbd),
260 "Disconnected due to user request.\n");
265 nsock->pending = NULL;
269 static void nbd_size_clear(struct nbd_device *nbd)
271 if (nbd->config->bytesize) {
272 set_capacity(nbd->disk, 0);
273 kobject_uevent(&nbd_to_dev(nbd)->kobj, KOBJ_CHANGE);
277 static void nbd_size_update(struct nbd_device *nbd)
279 struct nbd_config *config = nbd->config;
280 struct block_device *bdev = bdget_disk(nbd->disk, 0);
282 if (config->flags & NBD_FLAG_SEND_TRIM) {
283 nbd->disk->queue->limits.discard_granularity = config->blksize;
284 nbd->disk->queue->limits.discard_alignment = config->blksize;
285 blk_queue_max_discard_sectors(nbd->disk->queue, UINT_MAX);
287 blk_queue_logical_block_size(nbd->disk->queue, config->blksize);
288 blk_queue_physical_block_size(nbd->disk->queue, config->blksize);
289 set_capacity(nbd->disk, config->bytesize >> 9);
292 bd_set_size(bdev, config->bytesize);
294 bdev->bd_invalidated = 1;
297 kobject_uevent(&nbd_to_dev(nbd)->kobj, KOBJ_CHANGE);
300 static void nbd_size_set(struct nbd_device *nbd, loff_t blocksize,
303 struct nbd_config *config = nbd->config;
304 config->blksize = blocksize;
305 config->bytesize = blocksize * nr_blocks;
306 if (nbd->task_recv != NULL)
307 nbd_size_update(nbd);
310 static void nbd_complete_rq(struct request *req)
312 struct nbd_cmd *cmd = blk_mq_rq_to_pdu(req);
314 dev_dbg(nbd_to_dev(cmd->nbd), "request %p: %s\n", req,
315 cmd->status ? "failed" : "done");
317 blk_mq_end_request(req, cmd->status);
321 * Forcibly shutdown the socket causing all listeners to error
323 static void sock_shutdown(struct nbd_device *nbd)
325 struct nbd_config *config = nbd->config;
328 if (config->num_connections == 0)
330 if (test_and_set_bit(NBD_DISCONNECTED, &config->runtime_flags))
333 for (i = 0; i < config->num_connections; i++) {
334 struct nbd_sock *nsock = config->socks[i];
335 mutex_lock(&nsock->tx_lock);
336 nbd_mark_nsock_dead(nbd, nsock, 0);
337 mutex_unlock(&nsock->tx_lock);
339 dev_warn(disk_to_dev(nbd->disk), "shutting down sockets\n");
342 static enum blk_eh_timer_return nbd_xmit_timeout(struct request *req,
345 struct nbd_cmd *cmd = blk_mq_rq_to_pdu(req);
346 struct nbd_device *nbd = cmd->nbd;
347 struct nbd_config *config;
349 if (!refcount_inc_not_zero(&nbd->config_refs)) {
350 cmd->status = BLK_STS_TIMEOUT;
353 config = nbd->config;
355 if (!mutex_trylock(&cmd->lock))
356 return BLK_EH_RESET_TIMER;
358 if (config->num_connections > 1) {
359 dev_err_ratelimited(nbd_to_dev(nbd),
360 "Connection timed out, retrying (%d/%d alive)\n",
361 atomic_read(&config->live_connections),
362 config->num_connections);
364 * Hooray we have more connections, requeue this IO, the submit
365 * path will put it on a real connection.
367 if (config->socks && config->num_connections > 1) {
368 if (cmd->index < config->num_connections) {
369 struct nbd_sock *nsock =
370 config->socks[cmd->index];
371 mutex_lock(&nsock->tx_lock);
372 /* We can have multiple outstanding requests, so
373 * we don't want to mark the nsock dead if we've
374 * already reconnected with a new socket, so
375 * only mark it dead if its the same socket we
378 if (cmd->cookie == nsock->cookie)
379 nbd_mark_nsock_dead(nbd, nsock, 1);
380 mutex_unlock(&nsock->tx_lock);
382 mutex_unlock(&cmd->lock);
383 nbd_requeue_cmd(cmd);
388 dev_err_ratelimited(nbd_to_dev(nbd),
389 "Connection timed out\n");
391 set_bit(NBD_TIMEDOUT, &config->runtime_flags);
392 cmd->status = BLK_STS_IOERR;
393 mutex_unlock(&cmd->lock);
397 blk_mq_complete_request(req);
402 * Send or receive packet.
404 static int sock_xmit(struct nbd_device *nbd, int index, int send,
405 struct iov_iter *iter, int msg_flags, int *sent)
407 struct nbd_config *config = nbd->config;
408 struct socket *sock = config->socks[index]->sock;
411 unsigned int noreclaim_flag;
413 if (unlikely(!sock)) {
414 dev_err_ratelimited(disk_to_dev(nbd->disk),
415 "Attempted %s on closed socket in sock_xmit\n",
416 (send ? "send" : "recv"));
420 msg.msg_iter = *iter;
422 noreclaim_flag = memalloc_noreclaim_save();
424 sock->sk->sk_allocation = GFP_NOIO | __GFP_MEMALLOC;
427 msg.msg_control = NULL;
428 msg.msg_controllen = 0;
429 msg.msg_flags = msg_flags | MSG_NOSIGNAL;
432 result = sock_sendmsg(sock, &msg);
434 result = sock_recvmsg(sock, &msg, msg.msg_flags);
438 result = -EPIPE; /* short read */
443 } while (msg_data_left(&msg));
445 memalloc_noreclaim_restore(noreclaim_flag);
451 * Different settings for sk->sk_sndtimeo can result in different return values
452 * if there is a signal pending when we enter sendmsg, because reasons?
454 static inline int was_interrupted(int result)
456 return result == -ERESTARTSYS || result == -EINTR;
459 /* always call with the tx_lock held */
460 static int nbd_send_cmd(struct nbd_device *nbd, struct nbd_cmd *cmd, int index)
462 struct request *req = blk_mq_rq_from_pdu(cmd);
463 struct nbd_config *config = nbd->config;
464 struct nbd_sock *nsock = config->socks[index];
466 struct nbd_request request = {.magic = htonl(NBD_REQUEST_MAGIC)};
467 struct kvec iov = {.iov_base = &request, .iov_len = sizeof(request)};
468 struct iov_iter from;
469 unsigned long size = blk_rq_bytes(req);
473 u32 nbd_cmd_flags = 0;
474 int sent = nsock->sent, skip = 0;
476 iov_iter_kvec(&from, WRITE, &iov, 1, sizeof(request));
478 switch (req_op(req)) {
483 type = NBD_CMD_FLUSH;
486 type = NBD_CMD_WRITE;
495 if (rq_data_dir(req) == WRITE &&
496 (config->flags & NBD_FLAG_READ_ONLY)) {
497 dev_err_ratelimited(disk_to_dev(nbd->disk),
498 "Write on read-only\n");
502 if (req->cmd_flags & REQ_FUA)
503 nbd_cmd_flags |= NBD_CMD_FLAG_FUA;
505 /* We did a partial send previously, and we at least sent the whole
506 * request struct, so just go and send the rest of the pages in the
510 if (sent >= sizeof(request)) {
511 skip = sent - sizeof(request);
514 iov_iter_advance(&from, sent);
519 cmd->cookie = nsock->cookie;
520 request.type = htonl(type | nbd_cmd_flags);
521 if (type != NBD_CMD_FLUSH) {
522 request.from = cpu_to_be64((u64)blk_rq_pos(req) << 9);
523 request.len = htonl(size);
525 handle = nbd_cmd_handle(cmd);
526 memcpy(request.handle, &handle, sizeof(handle));
528 dev_dbg(nbd_to_dev(nbd), "request %p: sending control (%s@%llu,%uB)\n",
529 req, nbdcmd_to_ascii(type),
530 (unsigned long long)blk_rq_pos(req) << 9, blk_rq_bytes(req));
531 result = sock_xmit(nbd, index, 1, &from,
532 (type == NBD_CMD_WRITE) ? MSG_MORE : 0, &sent);
534 if (was_interrupted(result)) {
535 /* If we havne't sent anything we can just return BUSY,
536 * however if we have sent something we need to make
537 * sure we only allow this req to be sent until we are
541 nsock->pending = req;
544 set_bit(NBD_CMD_REQUEUED, &cmd->flags);
545 return BLK_STS_RESOURCE;
547 dev_err_ratelimited(disk_to_dev(nbd->disk),
548 "Send control failed (result %d)\n", result);
552 if (type != NBD_CMD_WRITE)
557 struct bio *next = bio->bi_next;
558 struct bvec_iter iter;
561 bio_for_each_segment(bvec, bio, iter) {
562 bool is_last = !next && bio_iter_last(bvec, iter);
563 int flags = is_last ? 0 : MSG_MORE;
565 dev_dbg(nbd_to_dev(nbd), "request %p: sending %d bytes data\n",
567 iov_iter_bvec(&from, WRITE, &bvec, 1, bvec.bv_len);
569 if (skip >= iov_iter_count(&from)) {
570 skip -= iov_iter_count(&from);
573 iov_iter_advance(&from, skip);
576 result = sock_xmit(nbd, index, 1, &from, flags, &sent);
578 if (was_interrupted(result)) {
579 /* We've already sent the header, we
580 * have no choice but to set pending and
583 nsock->pending = req;
585 set_bit(NBD_CMD_REQUEUED, &cmd->flags);
586 return BLK_STS_RESOURCE;
588 dev_err(disk_to_dev(nbd->disk),
589 "Send data failed (result %d)\n",
594 * The completion might already have come in,
595 * so break for the last one instead of letting
596 * the iterator do it. This prevents use-after-free
605 nsock->pending = NULL;
610 /* NULL returned = something went wrong, inform userspace */
611 static struct nbd_cmd *nbd_read_stat(struct nbd_device *nbd, int index)
613 struct nbd_config *config = nbd->config;
615 struct nbd_reply reply;
617 struct request *req = NULL;
621 struct kvec iov = {.iov_base = &reply, .iov_len = sizeof(reply)};
626 iov_iter_kvec(&to, READ, &iov, 1, sizeof(reply));
627 result = sock_xmit(nbd, index, 0, &to, MSG_WAITALL, NULL);
629 if (!nbd_disconnected(config))
630 dev_err(disk_to_dev(nbd->disk),
631 "Receive control failed (result %d)\n", result);
632 return ERR_PTR(result);
635 if (ntohl(reply.magic) != NBD_REPLY_MAGIC) {
636 dev_err(disk_to_dev(nbd->disk), "Wrong magic (0x%lx)\n",
637 (unsigned long)ntohl(reply.magic));
638 return ERR_PTR(-EPROTO);
641 memcpy(&handle, reply.handle, sizeof(handle));
642 tag = nbd_handle_to_tag(handle);
643 hwq = blk_mq_unique_tag_to_hwq(tag);
644 if (hwq < nbd->tag_set.nr_hw_queues)
645 req = blk_mq_tag_to_rq(nbd->tag_set.tags[hwq],
646 blk_mq_unique_tag_to_tag(tag));
647 if (!req || !blk_mq_request_started(req)) {
648 dev_err(disk_to_dev(nbd->disk), "Unexpected reply (%d) %p\n",
650 return ERR_PTR(-ENOENT);
652 cmd = blk_mq_rq_to_pdu(req);
654 mutex_lock(&cmd->lock);
655 if (cmd->cmd_cookie != nbd_handle_to_cookie(handle)) {
656 dev_err(disk_to_dev(nbd->disk), "Double reply on req %p, cmd_cookie %u, handle cookie %u\n",
657 req, cmd->cmd_cookie, nbd_handle_to_cookie(handle));
661 if (test_bit(NBD_CMD_REQUEUED, &cmd->flags)) {
662 dev_err(disk_to_dev(nbd->disk), "Raced with timeout on req %p\n",
667 if (ntohl(reply.error)) {
668 dev_err(disk_to_dev(nbd->disk), "Other side returned error (%d)\n",
670 cmd->status = BLK_STS_IOERR;
674 dev_dbg(nbd_to_dev(nbd), "request %p: got reply\n", req);
675 if (rq_data_dir(req) != WRITE) {
676 struct req_iterator iter;
679 rq_for_each_segment(bvec, req, iter) {
680 iov_iter_bvec(&to, READ, &bvec, 1, bvec.bv_len);
681 result = sock_xmit(nbd, index, 0, &to, MSG_WAITALL, NULL);
683 dev_err(disk_to_dev(nbd->disk), "Receive data failed (result %d)\n",
686 * If we've disconnected or we only have 1
687 * connection then we need to make sure we
688 * complete this request, otherwise error out
689 * and let the timeout stuff handle resubmitting
690 * this request onto another connection.
692 if (nbd_disconnected(config) ||
693 config->num_connections <= 1) {
694 cmd->status = BLK_STS_IOERR;
700 dev_dbg(nbd_to_dev(nbd), "request %p: got %d bytes data\n",
705 mutex_unlock(&cmd->lock);
706 return ret ? ERR_PTR(ret) : cmd;
709 static void recv_work(struct work_struct *work)
711 struct recv_thread_args *args = container_of(work,
712 struct recv_thread_args,
714 struct nbd_device *nbd = args->nbd;
715 struct nbd_config *config = nbd->config;
719 cmd = nbd_read_stat(nbd, args->index);
721 struct nbd_sock *nsock = config->socks[args->index];
723 mutex_lock(&nsock->tx_lock);
724 nbd_mark_nsock_dead(nbd, nsock, 1);
725 mutex_unlock(&nsock->tx_lock);
729 blk_mq_complete_request(blk_mq_rq_from_pdu(cmd));
731 atomic_dec(&config->recv_threads);
732 wake_up(&config->recv_wq);
737 static bool nbd_clear_req(struct request *req, void *data, bool reserved)
739 struct nbd_cmd *cmd = blk_mq_rq_to_pdu(req);
741 cmd->status = BLK_STS_IOERR;
742 blk_mq_complete_request(req);
746 static void nbd_clear_que(struct nbd_device *nbd)
748 blk_mq_quiesce_queue(nbd->disk->queue);
749 blk_mq_tagset_busy_iter(&nbd->tag_set, nbd_clear_req, NULL);
750 blk_mq_unquiesce_queue(nbd->disk->queue);
751 dev_dbg(disk_to_dev(nbd->disk), "queue cleared\n");
754 static int find_fallback(struct nbd_device *nbd, int index)
756 struct nbd_config *config = nbd->config;
758 struct nbd_sock *nsock = config->socks[index];
759 int fallback = nsock->fallback_index;
761 if (test_bit(NBD_DISCONNECTED, &config->runtime_flags))
764 if (config->num_connections <= 1) {
765 dev_err_ratelimited(disk_to_dev(nbd->disk),
766 "Attempted send on invalid socket\n");
770 if (fallback >= 0 && fallback < config->num_connections &&
771 !config->socks[fallback]->dead)
774 if (nsock->fallback_index < 0 ||
775 nsock->fallback_index >= config->num_connections ||
776 config->socks[nsock->fallback_index]->dead) {
778 for (i = 0; i < config->num_connections; i++) {
781 if (!config->socks[i]->dead) {
786 nsock->fallback_index = new_index;
788 dev_err_ratelimited(disk_to_dev(nbd->disk),
789 "Dead connection, failed to find a fallback\n");
793 new_index = nsock->fallback_index;
797 static int wait_for_reconnect(struct nbd_device *nbd)
799 struct nbd_config *config = nbd->config;
800 if (!config->dead_conn_timeout)
802 if (test_bit(NBD_DISCONNECTED, &config->runtime_flags))
804 return wait_event_timeout(config->conn_wait,
805 atomic_read(&config->live_connections) > 0,
806 config->dead_conn_timeout) > 0;
809 static int nbd_handle_cmd(struct nbd_cmd *cmd, int index)
811 struct request *req = blk_mq_rq_from_pdu(cmd);
812 struct nbd_device *nbd = cmd->nbd;
813 struct nbd_config *config;
814 struct nbd_sock *nsock;
817 if (!refcount_inc_not_zero(&nbd->config_refs)) {
818 dev_err_ratelimited(disk_to_dev(nbd->disk),
819 "Socks array is empty\n");
820 blk_mq_start_request(req);
823 config = nbd->config;
825 if (index >= config->num_connections) {
826 dev_err_ratelimited(disk_to_dev(nbd->disk),
827 "Attempted send on invalid socket\n");
829 blk_mq_start_request(req);
832 cmd->status = BLK_STS_OK;
834 nsock = config->socks[index];
835 mutex_lock(&nsock->tx_lock);
837 int old_index = index;
838 index = find_fallback(nbd, index);
839 mutex_unlock(&nsock->tx_lock);
841 if (wait_for_reconnect(nbd)) {
845 /* All the sockets should already be down at this point,
846 * we just want to make sure that DISCONNECTED is set so
847 * any requests that come in that were queue'ed waiting
848 * for the reconnect timer don't trigger the timer again
849 * and instead just error out.
853 blk_mq_start_request(req);
859 /* Handle the case that we have a pending request that was partially
860 * transmitted that _has_ to be serviced first. We need to call requeue
861 * here so that it gets put _after_ the request that is already on the
864 blk_mq_start_request(req);
865 if (unlikely(nsock->pending && nsock->pending != req)) {
866 nbd_requeue_cmd(cmd);
871 * Some failures are related to the link going down, so anything that
872 * returns EAGAIN can be retried on a different socket.
874 ret = nbd_send_cmd(nbd, cmd, index);
875 if (ret == -EAGAIN) {
876 dev_err_ratelimited(disk_to_dev(nbd->disk),
877 "Request send failed, requeueing\n");
878 nbd_mark_nsock_dead(nbd, nsock, 1);
879 nbd_requeue_cmd(cmd);
883 mutex_unlock(&nsock->tx_lock);
888 static blk_status_t nbd_queue_rq(struct blk_mq_hw_ctx *hctx,
889 const struct blk_mq_queue_data *bd)
891 struct nbd_cmd *cmd = blk_mq_rq_to_pdu(bd->rq);
895 * Since we look at the bio's to send the request over the network we
896 * need to make sure the completion work doesn't mark this request done
897 * before we are done doing our send. This keeps us from dereferencing
898 * freed data if we have particularly fast completions (ie we get the
899 * completion before we exit sock_xmit on the last bvec) or in the case
900 * that the server is misbehaving (or there was an error) before we're
901 * done sending everything over the wire.
903 mutex_lock(&cmd->lock);
904 clear_bit(NBD_CMD_REQUEUED, &cmd->flags);
906 /* We can be called directly from the user space process, which means we
907 * could possibly have signals pending so our sendmsg will fail. In
908 * this case we need to return that we are busy, otherwise error out as
911 ret = nbd_handle_cmd(cmd, hctx->queue_num);
916 mutex_unlock(&cmd->lock);
921 static int nbd_add_socket(struct nbd_device *nbd, unsigned long arg,
924 struct nbd_config *config = nbd->config;
926 struct nbd_sock **socks;
927 struct nbd_sock *nsock;
930 sock = sockfd_lookup(arg, &err);
934 if (!netlink && !nbd->task_setup &&
935 !test_bit(NBD_BOUND, &config->runtime_flags))
936 nbd->task_setup = current;
939 (nbd->task_setup != current ||
940 test_bit(NBD_BOUND, &config->runtime_flags))) {
941 dev_err(disk_to_dev(nbd->disk),
942 "Device being setup by another task");
947 socks = krealloc(config->socks, (config->num_connections + 1) *
948 sizeof(struct nbd_sock *), GFP_KERNEL);
953 nsock = kzalloc(sizeof(struct nbd_sock), GFP_KERNEL);
959 config->socks = socks;
961 nsock->fallback_index = -1;
963 mutex_init(&nsock->tx_lock);
965 nsock->pending = NULL;
968 socks[config->num_connections++] = nsock;
969 atomic_inc(&config->live_connections);
974 static int nbd_reconnect_socket(struct nbd_device *nbd, unsigned long arg)
976 struct nbd_config *config = nbd->config;
977 struct socket *sock, *old;
978 struct recv_thread_args *args;
982 sock = sockfd_lookup(arg, &err);
986 args = kzalloc(sizeof(*args), GFP_KERNEL);
992 for (i = 0; i < config->num_connections; i++) {
993 struct nbd_sock *nsock = config->socks[i];
998 mutex_lock(&nsock->tx_lock);
1000 mutex_unlock(&nsock->tx_lock);
1003 sk_set_memalloc(sock->sk);
1004 if (nbd->tag_set.timeout)
1005 sock->sk->sk_sndtimeo = nbd->tag_set.timeout;
1006 atomic_inc(&config->recv_threads);
1007 refcount_inc(&nbd->config_refs);
1009 nsock->fallback_index = -1;
1011 nsock->dead = false;
1012 INIT_WORK(&args->work, recv_work);
1016 mutex_unlock(&nsock->tx_lock);
1019 clear_bit(NBD_DISCONNECTED, &config->runtime_flags);
1021 /* We take the tx_mutex in an error path in the recv_work, so we
1022 * need to queue_work outside of the tx_mutex.
1024 queue_work(recv_workqueue, &args->work);
1026 atomic_inc(&config->live_connections);
1027 wake_up(&config->conn_wait);
1035 static void nbd_bdev_reset(struct block_device *bdev)
1037 if (bdev->bd_openers > 1)
1039 bd_set_size(bdev, 0);
1042 static void nbd_parse_flags(struct nbd_device *nbd)
1044 struct nbd_config *config = nbd->config;
1045 if (config->flags & NBD_FLAG_READ_ONLY)
1046 set_disk_ro(nbd->disk, true);
1048 set_disk_ro(nbd->disk, false);
1049 if (config->flags & NBD_FLAG_SEND_TRIM)
1050 blk_queue_flag_set(QUEUE_FLAG_DISCARD, nbd->disk->queue);
1051 if (config->flags & NBD_FLAG_SEND_FLUSH) {
1052 if (config->flags & NBD_FLAG_SEND_FUA)
1053 blk_queue_write_cache(nbd->disk->queue, true, true);
1055 blk_queue_write_cache(nbd->disk->queue, true, false);
1058 blk_queue_write_cache(nbd->disk->queue, false, false);
1061 static void send_disconnects(struct nbd_device *nbd)
1063 struct nbd_config *config = nbd->config;
1064 struct nbd_request request = {
1065 .magic = htonl(NBD_REQUEST_MAGIC),
1066 .type = htonl(NBD_CMD_DISC),
1068 struct kvec iov = {.iov_base = &request, .iov_len = sizeof(request)};
1069 struct iov_iter from;
1072 for (i = 0; i < config->num_connections; i++) {
1073 struct nbd_sock *nsock = config->socks[i];
1075 iov_iter_kvec(&from, WRITE, &iov, 1, sizeof(request));
1076 mutex_lock(&nsock->tx_lock);
1077 ret = sock_xmit(nbd, i, 1, &from, 0, NULL);
1079 dev_err(disk_to_dev(nbd->disk),
1080 "Send disconnect failed %d\n", ret);
1081 mutex_unlock(&nsock->tx_lock);
1085 static int nbd_disconnect(struct nbd_device *nbd)
1087 struct nbd_config *config = nbd->config;
1089 dev_info(disk_to_dev(nbd->disk), "NBD_DISCONNECT\n");
1090 set_bit(NBD_DISCONNECT_REQUESTED, &config->runtime_flags);
1091 send_disconnects(nbd);
1095 static void nbd_clear_sock(struct nbd_device *nbd)
1099 nbd->task_setup = NULL;
1102 static void nbd_config_put(struct nbd_device *nbd)
1104 if (refcount_dec_and_mutex_lock(&nbd->config_refs,
1105 &nbd->config_lock)) {
1106 struct nbd_config *config = nbd->config;
1107 nbd_dev_dbg_close(nbd);
1108 nbd_size_clear(nbd);
1109 if (test_and_clear_bit(NBD_HAS_PID_FILE,
1110 &config->runtime_flags))
1111 device_remove_file(disk_to_dev(nbd->disk), &pid_attr);
1112 nbd->task_recv = NULL;
1113 nbd_clear_sock(nbd);
1114 if (config->num_connections) {
1116 for (i = 0; i < config->num_connections; i++) {
1117 sockfd_put(config->socks[i]->sock);
1118 kfree(config->socks[i]);
1120 kfree(config->socks);
1125 nbd->tag_set.timeout = 0;
1126 nbd->disk->queue->limits.discard_granularity = 0;
1127 nbd->disk->queue->limits.discard_alignment = 0;
1128 blk_queue_max_discard_sectors(nbd->disk->queue, UINT_MAX);
1129 blk_queue_flag_clear(QUEUE_FLAG_DISCARD, nbd->disk->queue);
1131 mutex_unlock(&nbd->config_lock);
1133 module_put(THIS_MODULE);
1137 static int nbd_start_device(struct nbd_device *nbd)
1139 struct nbd_config *config = nbd->config;
1140 int num_connections = config->num_connections;
1147 if (num_connections > 1 &&
1148 !(config->flags & NBD_FLAG_CAN_MULTI_CONN)) {
1149 dev_err(disk_to_dev(nbd->disk), "server does not support multiple connections per device.\n");
1153 blk_mq_update_nr_hw_queues(&nbd->tag_set, config->num_connections);
1154 nbd->task_recv = current;
1156 nbd_parse_flags(nbd);
1158 error = device_create_file(disk_to_dev(nbd->disk), &pid_attr);
1160 dev_err(disk_to_dev(nbd->disk), "device_create_file failed!\n");
1163 set_bit(NBD_HAS_PID_FILE, &config->runtime_flags);
1165 nbd_dev_dbg_init(nbd);
1166 for (i = 0; i < num_connections; i++) {
1167 struct recv_thread_args *args;
1169 args = kzalloc(sizeof(*args), GFP_KERNEL);
1174 sk_set_memalloc(config->socks[i]->sock->sk);
1175 if (nbd->tag_set.timeout)
1176 config->socks[i]->sock->sk->sk_sndtimeo =
1177 nbd->tag_set.timeout;
1178 atomic_inc(&config->recv_threads);
1179 refcount_inc(&nbd->config_refs);
1180 INIT_WORK(&args->work, recv_work);
1183 queue_work(recv_workqueue, &args->work);
1185 nbd_size_update(nbd);
1189 static int nbd_start_device_ioctl(struct nbd_device *nbd, struct block_device *bdev)
1191 struct nbd_config *config = nbd->config;
1194 ret = nbd_start_device(nbd);
1199 bdev->bd_invalidated = 1;
1200 mutex_unlock(&nbd->config_lock);
1201 ret = wait_event_interruptible(config->recv_wq,
1202 atomic_read(&config->recv_threads) == 0);
1205 mutex_lock(&nbd->config_lock);
1206 nbd_bdev_reset(bdev);
1207 /* user requested, ignore socket errors */
1208 if (test_bit(NBD_DISCONNECT_REQUESTED, &config->runtime_flags))
1210 if (test_bit(NBD_TIMEDOUT, &config->runtime_flags))
1215 static void nbd_clear_sock_ioctl(struct nbd_device *nbd,
1216 struct block_device *bdev)
1220 nbd_bdev_reset(bdev);
1221 if (test_and_clear_bit(NBD_HAS_CONFIG_REF,
1222 &nbd->config->runtime_flags))
1223 nbd_config_put(nbd);
1226 /* Must be called with config_lock held */
1227 static int __nbd_ioctl(struct block_device *bdev, struct nbd_device *nbd,
1228 unsigned int cmd, unsigned long arg)
1230 struct nbd_config *config = nbd->config;
1233 case NBD_DISCONNECT:
1234 return nbd_disconnect(nbd);
1235 case NBD_CLEAR_SOCK:
1236 nbd_clear_sock_ioctl(nbd, bdev);
1239 return nbd_add_socket(nbd, arg, false);
1240 case NBD_SET_BLKSIZE:
1241 if (!arg || !is_power_of_2(arg) || arg < 512 ||
1244 nbd_size_set(nbd, arg,
1245 div_s64(config->bytesize, arg));
1248 nbd_size_set(nbd, config->blksize,
1249 div_s64(arg, config->blksize));
1251 case NBD_SET_SIZE_BLOCKS:
1252 nbd_size_set(nbd, config->blksize, arg);
1254 case NBD_SET_TIMEOUT:
1256 nbd->tag_set.timeout = arg * HZ;
1257 blk_queue_rq_timeout(nbd->disk->queue, arg * HZ);
1262 config->flags = arg;
1265 return nbd_start_device_ioctl(nbd, bdev);
1268 * This is for compatibility only. The queue is always cleared
1269 * by NBD_DO_IT or NBD_CLEAR_SOCK.
1272 case NBD_PRINT_DEBUG:
1274 * For compatibility only, we no longer keep a list of
1275 * outstanding requests.
1282 static int nbd_ioctl(struct block_device *bdev, fmode_t mode,
1283 unsigned int cmd, unsigned long arg)
1285 struct nbd_device *nbd = bdev->bd_disk->private_data;
1286 struct nbd_config *config = nbd->config;
1287 int error = -EINVAL;
1289 if (!capable(CAP_SYS_ADMIN))
1292 /* The block layer will pass back some non-nbd ioctls in case we have
1293 * special handling for them, but we don't so just return an error.
1295 if (_IOC_TYPE(cmd) != 0xab)
1298 mutex_lock(&nbd->config_lock);
1300 /* Don't allow ioctl operations on a nbd device that was created with
1301 * netlink, unless it's DISCONNECT or CLEAR_SOCK, which are fine.
1303 if (!test_bit(NBD_BOUND, &config->runtime_flags) ||
1304 (cmd == NBD_DISCONNECT || cmd == NBD_CLEAR_SOCK))
1305 error = __nbd_ioctl(bdev, nbd, cmd, arg);
1307 dev_err(nbd_to_dev(nbd), "Cannot use ioctl interface on a netlink controlled device.\n");
1308 mutex_unlock(&nbd->config_lock);
1312 static struct nbd_config *nbd_alloc_config(void)
1314 struct nbd_config *config;
1316 config = kzalloc(sizeof(struct nbd_config), GFP_NOFS);
1319 atomic_set(&config->recv_threads, 0);
1320 init_waitqueue_head(&config->recv_wq);
1321 init_waitqueue_head(&config->conn_wait);
1322 config->blksize = 1024;
1323 atomic_set(&config->live_connections, 0);
1324 try_module_get(THIS_MODULE);
1328 static int nbd_open(struct block_device *bdev, fmode_t mode)
1330 struct nbd_device *nbd;
1333 mutex_lock(&nbd_index_mutex);
1334 nbd = bdev->bd_disk->private_data;
1339 if (!refcount_inc_not_zero(&nbd->refs)) {
1343 if (!refcount_inc_not_zero(&nbd->config_refs)) {
1344 struct nbd_config *config;
1346 mutex_lock(&nbd->config_lock);
1347 if (refcount_inc_not_zero(&nbd->config_refs)) {
1348 mutex_unlock(&nbd->config_lock);
1351 config = nbd->config = nbd_alloc_config();
1354 mutex_unlock(&nbd->config_lock);
1357 refcount_set(&nbd->config_refs, 1);
1358 refcount_inc(&nbd->refs);
1359 mutex_unlock(&nbd->config_lock);
1360 bdev->bd_invalidated = 1;
1361 } else if (nbd_disconnected(nbd->config)) {
1362 bdev->bd_invalidated = 1;
1365 mutex_unlock(&nbd_index_mutex);
1369 static void nbd_release(struct gendisk *disk, fmode_t mode)
1371 struct nbd_device *nbd = disk->private_data;
1372 struct block_device *bdev = bdget_disk(disk, 0);
1374 if (test_bit(NBD_DISCONNECT_ON_CLOSE, &nbd->config->runtime_flags) &&
1375 bdev->bd_openers == 0)
1376 nbd_disconnect_and_put(nbd);
1378 nbd_config_put(nbd);
1382 static const struct block_device_operations nbd_fops =
1384 .owner = THIS_MODULE,
1386 .release = nbd_release,
1388 .compat_ioctl = nbd_ioctl,
1391 #if IS_ENABLED(CONFIG_DEBUG_FS)
1393 static int nbd_dbg_tasks_show(struct seq_file *s, void *unused)
1395 struct nbd_device *nbd = s->private;
1398 seq_printf(s, "recv: %d\n", task_pid_nr(nbd->task_recv));
1403 static int nbd_dbg_tasks_open(struct inode *inode, struct file *file)
1405 return single_open(file, nbd_dbg_tasks_show, inode->i_private);
1408 static const struct file_operations nbd_dbg_tasks_ops = {
1409 .open = nbd_dbg_tasks_open,
1411 .llseek = seq_lseek,
1412 .release = single_release,
1415 static int nbd_dbg_flags_show(struct seq_file *s, void *unused)
1417 struct nbd_device *nbd = s->private;
1418 u32 flags = nbd->config->flags;
1420 seq_printf(s, "Hex: 0x%08x\n\n", flags);
1422 seq_puts(s, "Known flags:\n");
1424 if (flags & NBD_FLAG_HAS_FLAGS)
1425 seq_puts(s, "NBD_FLAG_HAS_FLAGS\n");
1426 if (flags & NBD_FLAG_READ_ONLY)
1427 seq_puts(s, "NBD_FLAG_READ_ONLY\n");
1428 if (flags & NBD_FLAG_SEND_FLUSH)
1429 seq_puts(s, "NBD_FLAG_SEND_FLUSH\n");
1430 if (flags & NBD_FLAG_SEND_FUA)
1431 seq_puts(s, "NBD_FLAG_SEND_FUA\n");
1432 if (flags & NBD_FLAG_SEND_TRIM)
1433 seq_puts(s, "NBD_FLAG_SEND_TRIM\n");
1438 static int nbd_dbg_flags_open(struct inode *inode, struct file *file)
1440 return single_open(file, nbd_dbg_flags_show, inode->i_private);
1443 static const struct file_operations nbd_dbg_flags_ops = {
1444 .open = nbd_dbg_flags_open,
1446 .llseek = seq_lseek,
1447 .release = single_release,
1450 static int nbd_dev_dbg_init(struct nbd_device *nbd)
1453 struct nbd_config *config = nbd->config;
1458 dir = debugfs_create_dir(nbd_name(nbd), nbd_dbg_dir);
1460 dev_err(nbd_to_dev(nbd), "Failed to create debugfs dir for '%s'\n",
1464 config->dbg_dir = dir;
1466 debugfs_create_file("tasks", 0444, dir, nbd, &nbd_dbg_tasks_ops);
1467 debugfs_create_u64("size_bytes", 0444, dir, &config->bytesize);
1468 debugfs_create_u32("timeout", 0444, dir, &nbd->tag_set.timeout);
1469 debugfs_create_u64("blocksize", 0444, dir, &config->blksize);
1470 debugfs_create_file("flags", 0444, dir, nbd, &nbd_dbg_flags_ops);
1475 static void nbd_dev_dbg_close(struct nbd_device *nbd)
1477 debugfs_remove_recursive(nbd->config->dbg_dir);
1480 static int nbd_dbg_init(void)
1482 struct dentry *dbg_dir;
1484 dbg_dir = debugfs_create_dir("nbd", NULL);
1488 nbd_dbg_dir = dbg_dir;
1493 static void nbd_dbg_close(void)
1495 debugfs_remove_recursive(nbd_dbg_dir);
1498 #else /* IS_ENABLED(CONFIG_DEBUG_FS) */
1500 static int nbd_dev_dbg_init(struct nbd_device *nbd)
1505 static void nbd_dev_dbg_close(struct nbd_device *nbd)
1509 static int nbd_dbg_init(void)
1514 static void nbd_dbg_close(void)
1520 static int nbd_init_request(struct blk_mq_tag_set *set, struct request *rq,
1521 unsigned int hctx_idx, unsigned int numa_node)
1523 struct nbd_cmd *cmd = blk_mq_rq_to_pdu(rq);
1524 cmd->nbd = set->driver_data;
1526 mutex_init(&cmd->lock);
1530 static const struct blk_mq_ops nbd_mq_ops = {
1531 .queue_rq = nbd_queue_rq,
1532 .complete = nbd_complete_rq,
1533 .init_request = nbd_init_request,
1534 .timeout = nbd_xmit_timeout,
1537 static int nbd_dev_add(int index)
1539 struct nbd_device *nbd;
1540 struct gendisk *disk;
1541 struct request_queue *q;
1544 nbd = kzalloc(sizeof(struct nbd_device), GFP_KERNEL);
1548 disk = alloc_disk(1 << part_shift);
1553 err = idr_alloc(&nbd_index_idr, nbd, index, index + 1,
1558 err = idr_alloc(&nbd_index_idr, nbd, 0, 0, GFP_KERNEL);
1567 nbd->tag_set.ops = &nbd_mq_ops;
1568 nbd->tag_set.nr_hw_queues = 1;
1569 nbd->tag_set.queue_depth = 128;
1570 nbd->tag_set.numa_node = NUMA_NO_NODE;
1571 nbd->tag_set.cmd_size = sizeof(struct nbd_cmd);
1572 nbd->tag_set.flags = BLK_MQ_F_SHOULD_MERGE |
1573 BLK_MQ_F_SG_MERGE | BLK_MQ_F_BLOCKING;
1574 nbd->tag_set.driver_data = nbd;
1576 err = blk_mq_alloc_tag_set(&nbd->tag_set);
1580 q = blk_mq_init_queue(&nbd->tag_set);
1588 * Tell the block layer that we are not a rotational device
1590 blk_queue_flag_set(QUEUE_FLAG_NONROT, disk->queue);
1591 blk_queue_flag_clear(QUEUE_FLAG_ADD_RANDOM, disk->queue);
1592 disk->queue->limits.discard_granularity = 0;
1593 disk->queue->limits.discard_alignment = 0;
1594 blk_queue_max_discard_sectors(disk->queue, 0);
1595 blk_queue_max_segment_size(disk->queue, UINT_MAX);
1596 blk_queue_max_segments(disk->queue, USHRT_MAX);
1597 blk_queue_max_hw_sectors(disk->queue, 65536);
1598 disk->queue->limits.max_sectors = 256;
1600 mutex_init(&nbd->config_lock);
1601 refcount_set(&nbd->config_refs, 0);
1602 refcount_set(&nbd->refs, 1);
1603 INIT_LIST_HEAD(&nbd->list);
1604 disk->major = NBD_MAJOR;
1605 disk->first_minor = index << part_shift;
1606 disk->fops = &nbd_fops;
1607 disk->private_data = nbd;
1608 sprintf(disk->disk_name, "nbd%d", index);
1610 nbd_total_devices++;
1614 blk_mq_free_tag_set(&nbd->tag_set);
1616 idr_remove(&nbd_index_idr, index);
1625 static int find_free_cb(int id, void *ptr, void *data)
1627 struct nbd_device *nbd = ptr;
1628 struct nbd_device **found = data;
1630 if (!refcount_read(&nbd->config_refs)) {
1637 /* Netlink interface. */
1638 static const struct nla_policy nbd_attr_policy[NBD_ATTR_MAX + 1] = {
1639 [NBD_ATTR_INDEX] = { .type = NLA_U32 },
1640 [NBD_ATTR_SIZE_BYTES] = { .type = NLA_U64 },
1641 [NBD_ATTR_BLOCK_SIZE_BYTES] = { .type = NLA_U64 },
1642 [NBD_ATTR_TIMEOUT] = { .type = NLA_U64 },
1643 [NBD_ATTR_SERVER_FLAGS] = { .type = NLA_U64 },
1644 [NBD_ATTR_CLIENT_FLAGS] = { .type = NLA_U64 },
1645 [NBD_ATTR_SOCKETS] = { .type = NLA_NESTED},
1646 [NBD_ATTR_DEAD_CONN_TIMEOUT] = { .type = NLA_U64 },
1647 [NBD_ATTR_DEVICE_LIST] = { .type = NLA_NESTED},
1650 static const struct nla_policy nbd_sock_policy[NBD_SOCK_MAX + 1] = {
1651 [NBD_SOCK_FD] = { .type = NLA_U32 },
1654 /* We don't use this right now since we don't parse the incoming list, but we
1655 * still want it here so userspace knows what to expect.
1657 static const struct nla_policy __attribute__((unused))
1658 nbd_device_policy[NBD_DEVICE_ATTR_MAX + 1] = {
1659 [NBD_DEVICE_INDEX] = { .type = NLA_U32 },
1660 [NBD_DEVICE_CONNECTED] = { .type = NLA_U8 },
1663 static int nbd_genl_connect(struct sk_buff *skb, struct genl_info *info)
1665 struct nbd_device *nbd = NULL;
1666 struct nbd_config *config;
1669 bool put_dev = false;
1671 if (!netlink_capable(skb, CAP_SYS_ADMIN))
1674 if (info->attrs[NBD_ATTR_INDEX])
1675 index = nla_get_u32(info->attrs[NBD_ATTR_INDEX]);
1676 if (!info->attrs[NBD_ATTR_SOCKETS]) {
1677 printk(KERN_ERR "nbd: must specify at least one socket\n");
1680 if (!info->attrs[NBD_ATTR_SIZE_BYTES]) {
1681 printk(KERN_ERR "nbd: must specify a size in bytes for the device\n");
1685 mutex_lock(&nbd_index_mutex);
1687 ret = idr_for_each(&nbd_index_idr, &find_free_cb, &nbd);
1690 new_index = nbd_dev_add(-1);
1691 if (new_index < 0) {
1692 mutex_unlock(&nbd_index_mutex);
1693 printk(KERN_ERR "nbd: failed to add new device\n");
1696 nbd = idr_find(&nbd_index_idr, new_index);
1699 nbd = idr_find(&nbd_index_idr, index);
1701 ret = nbd_dev_add(index);
1703 mutex_unlock(&nbd_index_mutex);
1704 printk(KERN_ERR "nbd: failed to add new device\n");
1707 nbd = idr_find(&nbd_index_idr, index);
1711 printk(KERN_ERR "nbd: couldn't find device at index %d\n",
1713 mutex_unlock(&nbd_index_mutex);
1716 if (!refcount_inc_not_zero(&nbd->refs)) {
1717 mutex_unlock(&nbd_index_mutex);
1720 printk(KERN_ERR "nbd: device at index %d is going down\n",
1724 mutex_unlock(&nbd_index_mutex);
1726 mutex_lock(&nbd->config_lock);
1727 if (refcount_read(&nbd->config_refs)) {
1728 mutex_unlock(&nbd->config_lock);
1732 printk(KERN_ERR "nbd: nbd%d already in use\n", index);
1735 if (WARN_ON(nbd->config)) {
1736 mutex_unlock(&nbd->config_lock);
1740 config = nbd->config = nbd_alloc_config();
1742 mutex_unlock(&nbd->config_lock);
1744 printk(KERN_ERR "nbd: couldn't allocate config\n");
1747 refcount_set(&nbd->config_refs, 1);
1748 set_bit(NBD_BOUND, &config->runtime_flags);
1750 if (info->attrs[NBD_ATTR_SIZE_BYTES]) {
1751 u64 bytes = nla_get_u64(info->attrs[NBD_ATTR_SIZE_BYTES]);
1752 nbd_size_set(nbd, config->blksize,
1753 div64_u64(bytes, config->blksize));
1755 if (info->attrs[NBD_ATTR_BLOCK_SIZE_BYTES]) {
1757 nla_get_u64(info->attrs[NBD_ATTR_BLOCK_SIZE_BYTES]);
1758 nbd_size_set(nbd, bsize, div64_u64(config->bytesize, bsize));
1760 if (info->attrs[NBD_ATTR_TIMEOUT]) {
1761 u64 timeout = nla_get_u64(info->attrs[NBD_ATTR_TIMEOUT]);
1762 nbd->tag_set.timeout = timeout * HZ;
1763 blk_queue_rq_timeout(nbd->disk->queue, timeout * HZ);
1765 if (info->attrs[NBD_ATTR_DEAD_CONN_TIMEOUT]) {
1766 config->dead_conn_timeout =
1767 nla_get_u64(info->attrs[NBD_ATTR_DEAD_CONN_TIMEOUT]);
1768 config->dead_conn_timeout *= HZ;
1770 if (info->attrs[NBD_ATTR_SERVER_FLAGS])
1772 nla_get_u64(info->attrs[NBD_ATTR_SERVER_FLAGS]);
1773 if (info->attrs[NBD_ATTR_CLIENT_FLAGS]) {
1774 u64 flags = nla_get_u64(info->attrs[NBD_ATTR_CLIENT_FLAGS]);
1775 if (flags & NBD_CFLAG_DESTROY_ON_DISCONNECT) {
1776 set_bit(NBD_DESTROY_ON_DISCONNECT,
1777 &config->runtime_flags);
1780 if (flags & NBD_CFLAG_DISCONNECT_ON_CLOSE) {
1781 set_bit(NBD_DISCONNECT_ON_CLOSE,
1782 &config->runtime_flags);
1786 if (info->attrs[NBD_ATTR_SOCKETS]) {
1787 struct nlattr *attr;
1790 nla_for_each_nested(attr, info->attrs[NBD_ATTR_SOCKETS],
1792 struct nlattr *socks[NBD_SOCK_MAX+1];
1794 if (nla_type(attr) != NBD_SOCK_ITEM) {
1795 printk(KERN_ERR "nbd: socks must be embedded in a SOCK_ITEM attr\n");
1799 ret = nla_parse_nested(socks, NBD_SOCK_MAX, attr,
1800 nbd_sock_policy, info->extack);
1802 printk(KERN_ERR "nbd: error processing sock list\n");
1806 if (!socks[NBD_SOCK_FD])
1808 fd = (int)nla_get_u32(socks[NBD_SOCK_FD]);
1809 ret = nbd_add_socket(nbd, fd, true);
1814 ret = nbd_start_device(nbd);
1816 mutex_unlock(&nbd->config_lock);
1818 set_bit(NBD_HAS_CONFIG_REF, &config->runtime_flags);
1819 refcount_inc(&nbd->config_refs);
1820 nbd_connect_reply(info, nbd->index);
1822 nbd_config_put(nbd);
1828 static void nbd_disconnect_and_put(struct nbd_device *nbd)
1830 mutex_lock(&nbd->config_lock);
1831 nbd_disconnect(nbd);
1832 nbd_clear_sock(nbd);
1833 mutex_unlock(&nbd->config_lock);
1834 if (test_and_clear_bit(NBD_HAS_CONFIG_REF,
1835 &nbd->config->runtime_flags))
1836 nbd_config_put(nbd);
1839 static int nbd_genl_disconnect(struct sk_buff *skb, struct genl_info *info)
1841 struct nbd_device *nbd;
1844 if (!netlink_capable(skb, CAP_SYS_ADMIN))
1847 if (!info->attrs[NBD_ATTR_INDEX]) {
1848 printk(KERN_ERR "nbd: must specify an index to disconnect\n");
1851 index = nla_get_u32(info->attrs[NBD_ATTR_INDEX]);
1852 mutex_lock(&nbd_index_mutex);
1853 nbd = idr_find(&nbd_index_idr, index);
1855 mutex_unlock(&nbd_index_mutex);
1856 printk(KERN_ERR "nbd: couldn't find device at index %d\n",
1860 if (!refcount_inc_not_zero(&nbd->refs)) {
1861 mutex_unlock(&nbd_index_mutex);
1862 printk(KERN_ERR "nbd: device at index %d is going down\n",
1866 mutex_unlock(&nbd_index_mutex);
1867 if (!refcount_inc_not_zero(&nbd->config_refs)) {
1871 nbd_disconnect_and_put(nbd);
1872 nbd_config_put(nbd);
1877 static int nbd_genl_reconfigure(struct sk_buff *skb, struct genl_info *info)
1879 struct nbd_device *nbd = NULL;
1880 struct nbd_config *config;
1883 bool put_dev = false;
1885 if (!netlink_capable(skb, CAP_SYS_ADMIN))
1888 if (!info->attrs[NBD_ATTR_INDEX]) {
1889 printk(KERN_ERR "nbd: must specify a device to reconfigure\n");
1892 index = nla_get_u32(info->attrs[NBD_ATTR_INDEX]);
1893 mutex_lock(&nbd_index_mutex);
1894 nbd = idr_find(&nbd_index_idr, index);
1896 mutex_unlock(&nbd_index_mutex);
1897 printk(KERN_ERR "nbd: couldn't find a device at index %d\n",
1901 if (!refcount_inc_not_zero(&nbd->refs)) {
1902 mutex_unlock(&nbd_index_mutex);
1903 printk(KERN_ERR "nbd: device at index %d is going down\n",
1907 mutex_unlock(&nbd_index_mutex);
1909 if (!refcount_inc_not_zero(&nbd->config_refs)) {
1910 dev_err(nbd_to_dev(nbd),
1911 "not configured, cannot reconfigure\n");
1916 mutex_lock(&nbd->config_lock);
1917 config = nbd->config;
1918 if (!test_bit(NBD_BOUND, &config->runtime_flags) ||
1920 dev_err(nbd_to_dev(nbd),
1921 "not configured, cannot reconfigure\n");
1926 if (info->attrs[NBD_ATTR_TIMEOUT]) {
1927 u64 timeout = nla_get_u64(info->attrs[NBD_ATTR_TIMEOUT]);
1928 nbd->tag_set.timeout = timeout * HZ;
1929 blk_queue_rq_timeout(nbd->disk->queue, timeout * HZ);
1931 if (info->attrs[NBD_ATTR_DEAD_CONN_TIMEOUT]) {
1932 config->dead_conn_timeout =
1933 nla_get_u64(info->attrs[NBD_ATTR_DEAD_CONN_TIMEOUT]);
1934 config->dead_conn_timeout *= HZ;
1936 if (info->attrs[NBD_ATTR_CLIENT_FLAGS]) {
1937 u64 flags = nla_get_u64(info->attrs[NBD_ATTR_CLIENT_FLAGS]);
1938 if (flags & NBD_CFLAG_DESTROY_ON_DISCONNECT) {
1939 if (!test_and_set_bit(NBD_DESTROY_ON_DISCONNECT,
1940 &config->runtime_flags))
1943 if (test_and_clear_bit(NBD_DESTROY_ON_DISCONNECT,
1944 &config->runtime_flags))
1945 refcount_inc(&nbd->refs);
1948 if (flags & NBD_CFLAG_DISCONNECT_ON_CLOSE) {
1949 set_bit(NBD_DISCONNECT_ON_CLOSE,
1950 &config->runtime_flags);
1952 clear_bit(NBD_DISCONNECT_ON_CLOSE,
1953 &config->runtime_flags);
1957 if (info->attrs[NBD_ATTR_SOCKETS]) {
1958 struct nlattr *attr;
1961 nla_for_each_nested(attr, info->attrs[NBD_ATTR_SOCKETS],
1963 struct nlattr *socks[NBD_SOCK_MAX+1];
1965 if (nla_type(attr) != NBD_SOCK_ITEM) {
1966 printk(KERN_ERR "nbd: socks must be embedded in a SOCK_ITEM attr\n");
1970 ret = nla_parse_nested(socks, NBD_SOCK_MAX, attr,
1971 nbd_sock_policy, info->extack);
1973 printk(KERN_ERR "nbd: error processing sock list\n");
1977 if (!socks[NBD_SOCK_FD])
1979 fd = (int)nla_get_u32(socks[NBD_SOCK_FD]);
1980 ret = nbd_reconnect_socket(nbd, fd);
1986 dev_info(nbd_to_dev(nbd), "reconnected socket\n");
1990 mutex_unlock(&nbd->config_lock);
1991 nbd_config_put(nbd);
1998 static const struct genl_ops nbd_connect_genl_ops[] = {
2000 .cmd = NBD_CMD_CONNECT,
2001 .policy = nbd_attr_policy,
2002 .doit = nbd_genl_connect,
2005 .cmd = NBD_CMD_DISCONNECT,
2006 .policy = nbd_attr_policy,
2007 .doit = nbd_genl_disconnect,
2010 .cmd = NBD_CMD_RECONFIGURE,
2011 .policy = nbd_attr_policy,
2012 .doit = nbd_genl_reconfigure,
2015 .cmd = NBD_CMD_STATUS,
2016 .policy = nbd_attr_policy,
2017 .doit = nbd_genl_status,
2021 static const struct genl_multicast_group nbd_mcast_grps[] = {
2022 { .name = NBD_GENL_MCAST_GROUP_NAME, },
2025 static struct genl_family nbd_genl_family __ro_after_init = {
2027 .name = NBD_GENL_FAMILY_NAME,
2028 .version = NBD_GENL_VERSION,
2029 .module = THIS_MODULE,
2030 .ops = nbd_connect_genl_ops,
2031 .n_ops = ARRAY_SIZE(nbd_connect_genl_ops),
2032 .maxattr = NBD_ATTR_MAX,
2033 .mcgrps = nbd_mcast_grps,
2034 .n_mcgrps = ARRAY_SIZE(nbd_mcast_grps),
2037 static int populate_nbd_status(struct nbd_device *nbd, struct sk_buff *reply)
2039 struct nlattr *dev_opt;
2043 /* This is a little racey, but for status it's ok. The
2044 * reason we don't take a ref here is because we can't
2045 * take a ref in the index == -1 case as we would need
2046 * to put under the nbd_index_mutex, which could
2047 * deadlock if we are configured to remove ourselves
2048 * once we're disconnected.
2050 if (refcount_read(&nbd->config_refs))
2052 dev_opt = nla_nest_start(reply, NBD_DEVICE_ITEM);
2055 ret = nla_put_u32(reply, NBD_DEVICE_INDEX, nbd->index);
2058 ret = nla_put_u8(reply, NBD_DEVICE_CONNECTED,
2062 nla_nest_end(reply, dev_opt);
2066 static int status_cb(int id, void *ptr, void *data)
2068 struct nbd_device *nbd = ptr;
2069 return populate_nbd_status(nbd, (struct sk_buff *)data);
2072 static int nbd_genl_status(struct sk_buff *skb, struct genl_info *info)
2074 struct nlattr *dev_list;
2075 struct sk_buff *reply;
2081 if (info->attrs[NBD_ATTR_INDEX])
2082 index = nla_get_u32(info->attrs[NBD_ATTR_INDEX]);
2084 mutex_lock(&nbd_index_mutex);
2086 msg_size = nla_total_size(nla_attr_size(sizeof(u32)) +
2087 nla_attr_size(sizeof(u8)));
2088 msg_size *= (index == -1) ? nbd_total_devices : 1;
2090 reply = genlmsg_new(msg_size, GFP_KERNEL);
2093 reply_head = genlmsg_put_reply(reply, info, &nbd_genl_family, 0,
2100 dev_list = nla_nest_start(reply, NBD_ATTR_DEVICE_LIST);
2102 ret = idr_for_each(&nbd_index_idr, &status_cb, reply);
2108 struct nbd_device *nbd;
2109 nbd = idr_find(&nbd_index_idr, index);
2111 ret = populate_nbd_status(nbd, reply);
2118 nla_nest_end(reply, dev_list);
2119 genlmsg_end(reply, reply_head);
2120 genlmsg_reply(reply, info);
2123 mutex_unlock(&nbd_index_mutex);
2127 static void nbd_connect_reply(struct genl_info *info, int index)
2129 struct sk_buff *skb;
2133 skb = genlmsg_new(nla_total_size(sizeof(u32)), GFP_KERNEL);
2136 msg_head = genlmsg_put_reply(skb, info, &nbd_genl_family, 0,
2142 ret = nla_put_u32(skb, NBD_ATTR_INDEX, index);
2147 genlmsg_end(skb, msg_head);
2148 genlmsg_reply(skb, info);
2151 static void nbd_mcast_index(int index)
2153 struct sk_buff *skb;
2157 skb = genlmsg_new(nla_total_size(sizeof(u32)), GFP_KERNEL);
2160 msg_head = genlmsg_put(skb, 0, 0, &nbd_genl_family, 0,
2166 ret = nla_put_u32(skb, NBD_ATTR_INDEX, index);
2171 genlmsg_end(skb, msg_head);
2172 genlmsg_multicast(&nbd_genl_family, skb, 0, 0, GFP_KERNEL);
2175 static void nbd_dead_link_work(struct work_struct *work)
2177 struct link_dead_args *args = container_of(work, struct link_dead_args,
2179 nbd_mcast_index(args->index);
2183 static int __init nbd_init(void)
2187 BUILD_BUG_ON(sizeof(struct nbd_request) != 28);
2190 printk(KERN_ERR "nbd: max_part must be >= 0\n");
2196 part_shift = fls(max_part);
2199 * Adjust max_part according to part_shift as it is exported
2200 * to user space so that user can know the max number of
2201 * partition kernel should be able to manage.
2203 * Note that -1 is required because partition 0 is reserved
2204 * for the whole disk.
2206 max_part = (1UL << part_shift) - 1;
2209 if ((1UL << part_shift) > DISK_MAX_PARTS)
2212 if (nbds_max > 1UL << (MINORBITS - part_shift))
2214 recv_workqueue = alloc_workqueue("knbd-recv",
2215 WQ_MEM_RECLAIM | WQ_HIGHPRI |
2217 if (!recv_workqueue)
2220 if (register_blkdev(NBD_MAJOR, "nbd")) {
2221 destroy_workqueue(recv_workqueue);
2225 if (genl_register_family(&nbd_genl_family)) {
2226 unregister_blkdev(NBD_MAJOR, "nbd");
2227 destroy_workqueue(recv_workqueue);
2232 mutex_lock(&nbd_index_mutex);
2233 for (i = 0; i < nbds_max; i++)
2235 mutex_unlock(&nbd_index_mutex);
2239 static int nbd_exit_cb(int id, void *ptr, void *data)
2241 struct list_head *list = (struct list_head *)data;
2242 struct nbd_device *nbd = ptr;
2244 list_add_tail(&nbd->list, list);
2248 static void __exit nbd_cleanup(void)
2250 struct nbd_device *nbd;
2251 LIST_HEAD(del_list);
2255 mutex_lock(&nbd_index_mutex);
2256 idr_for_each(&nbd_index_idr, &nbd_exit_cb, &del_list);
2257 mutex_unlock(&nbd_index_mutex);
2259 while (!list_empty(&del_list)) {
2260 nbd = list_first_entry(&del_list, struct nbd_device, list);
2261 list_del_init(&nbd->list);
2262 if (refcount_read(&nbd->refs) != 1)
2263 printk(KERN_ERR "nbd: possibly leaking a device\n");
2267 idr_destroy(&nbd_index_idr);
2268 genl_unregister_family(&nbd_genl_family);
2269 destroy_workqueue(recv_workqueue);
2270 unregister_blkdev(NBD_MAJOR, "nbd");
2273 module_init(nbd_init);
2274 module_exit(nbd_cleanup);
2276 MODULE_DESCRIPTION("Network Block Device");
2277 MODULE_LICENSE("GPL");
2279 module_param(nbds_max, int, 0444);
2280 MODULE_PARM_DESC(nbds_max, "number of network block devices to initialize (default: 16)");
2281 module_param(max_part, int, 0444);
2282 MODULE_PARM_DESC(max_part, "number of partitions per device (default: 16)");