]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blob - drivers/block/nbd.c
92f5ab1216ed3785fc3bd45f5e92a68439f0ed20
[mirror_ubuntu-jammy-kernel.git] / drivers / block / nbd.c
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3 * Network block device - make block devices work over TCP
4 *
5 * Note that you can not swap over this thing, yet. Seems to work but
6 * deadlocks sometimes - you can not swap over TCP in general.
7 *
8 * Copyright 1997-2000, 2008 Pavel Machek <pavel@ucw.cz>
9 * Parts copyright 2001 Steven Whitehouse <steve@chygwyn.com>
10 *
11 * (part of code stolen from loop.c)
12 */
13
14 #include <linux/major.h>
15
16 #include <linux/blkdev.h>
17 #include <linux/module.h>
18 #include <linux/init.h>
19 #include <linux/sched.h>
20 #include <linux/sched/mm.h>
21 #include <linux/fs.h>
22 #include <linux/bio.h>
23 #include <linux/stat.h>
24 #include <linux/errno.h>
25 #include <linux/file.h>
26 #include <linux/ioctl.h>
27 #include <linux/mutex.h>
28 #include <linux/compiler.h>
29 #include <linux/completion.h>
30 #include <linux/err.h>
31 #include <linux/kernel.h>
32 #include <linux/slab.h>
33 #include <net/sock.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>
39
40 #include <linux/uaccess.h>
41 #include <asm/types.h>
42
43 #include <linux/nbd.h>
44 #include <linux/nbd-netlink.h>
45 #include <net/genetlink.h>
46
47 #define CREATE_TRACE_POINTS
48 #include <trace/events/nbd.h>
49
50 static DEFINE_IDR(nbd_index_idr);
51 static DEFINE_MUTEX(nbd_index_mutex);
52 static struct workqueue_struct *nbd_del_wq;
53 static int nbd_total_devices = 0;
54
55 struct nbd_sock {
56 struct socket *sock;
57 struct mutex tx_lock;
58 struct request *pending;
59 int sent;
60 bool dead;
61 int fallback_index;
62 int cookie;
63 };
64
65 struct recv_thread_args {
66 struct work_struct work;
67 struct nbd_device *nbd;
68 int index;
69 };
70
71 struct link_dead_args {
72 struct work_struct work;
73 int index;
74 };
75
76 #define NBD_RT_TIMEDOUT 0
77 #define NBD_RT_DISCONNECT_REQUESTED 1
78 #define NBD_RT_DISCONNECTED 2
79 #define NBD_RT_HAS_PID_FILE 3
80 #define NBD_RT_HAS_CONFIG_REF 4
81 #define NBD_RT_BOUND 5
82 #define NBD_RT_DISCONNECT_ON_CLOSE 6
83 #define NBD_RT_HAS_BACKEND_FILE 7
84
85 #define NBD_DESTROY_ON_DISCONNECT 0
86 #define NBD_DISCONNECT_REQUESTED 1
87
88 struct nbd_config {
89 u32 flags;
90 unsigned long runtime_flags;
91 u64 dead_conn_timeout;
92
93 struct nbd_sock **socks;
94 int num_connections;
95 atomic_t live_connections;
96 wait_queue_head_t conn_wait;
97
98 atomic_t recv_threads;
99 wait_queue_head_t recv_wq;
100 unsigned int blksize_bits;
101 loff_t bytesize;
102 #if IS_ENABLED(CONFIG_DEBUG_FS)
103 struct dentry *dbg_dir;
104 #endif
105 };
106
107 static inline unsigned int nbd_blksize(struct nbd_config *config)
108 {
109 return 1u << config->blksize_bits;
110 }
111
112 struct nbd_device {
113 struct blk_mq_tag_set tag_set;
114
115 int index;
116 refcount_t config_refs;
117 refcount_t refs;
118 struct nbd_config *config;
119 struct mutex config_lock;
120 struct gendisk *disk;
121 struct workqueue_struct *recv_workq;
122 struct work_struct remove_work;
123
124 struct list_head list;
125 struct task_struct *task_setup;
126
127 unsigned long flags;
128 pid_t pid; /* pid of nbd-client, if attached */
129
130 char *backend;
131 };
132
133 #define NBD_CMD_REQUEUED 1
134
135 struct nbd_cmd {
136 struct nbd_device *nbd;
137 struct mutex lock;
138 int index;
139 int cookie;
140 int retries;
141 blk_status_t status;
142 unsigned long flags;
143 u32 cmd_cookie;
144 };
145
146 #if IS_ENABLED(CONFIG_DEBUG_FS)
147 static struct dentry *nbd_dbg_dir;
148 #endif
149
150 #define nbd_name(nbd) ((nbd)->disk->disk_name)
151
152 #define NBD_MAGIC 0x68797548
153
154 #define NBD_DEF_BLKSIZE_BITS 10
155
156 static unsigned int nbds_max = 16;
157 static int max_part = 16;
158 static int part_shift;
159
160 static int nbd_dev_dbg_init(struct nbd_device *nbd);
161 static void nbd_dev_dbg_close(struct nbd_device *nbd);
162 static void nbd_config_put(struct nbd_device *nbd);
163 static void nbd_connect_reply(struct genl_info *info, int index);
164 static int nbd_genl_status(struct sk_buff *skb, struct genl_info *info);
165 static void nbd_dead_link_work(struct work_struct *work);
166 static void nbd_disconnect_and_put(struct nbd_device *nbd);
167
168 static inline struct device *nbd_to_dev(struct nbd_device *nbd)
169 {
170 return disk_to_dev(nbd->disk);
171 }
172
173 static void nbd_requeue_cmd(struct nbd_cmd *cmd)
174 {
175 struct request *req = blk_mq_rq_from_pdu(cmd);
176
177 if (!test_and_set_bit(NBD_CMD_REQUEUED, &cmd->flags))
178 blk_mq_requeue_request(req, true);
179 }
180
181 #define NBD_COOKIE_BITS 32
182
183 static u64 nbd_cmd_handle(struct nbd_cmd *cmd)
184 {
185 struct request *req = blk_mq_rq_from_pdu(cmd);
186 u32 tag = blk_mq_unique_tag(req);
187 u64 cookie = cmd->cmd_cookie;
188
189 return (cookie << NBD_COOKIE_BITS) | tag;
190 }
191
192 static u32 nbd_handle_to_tag(u64 handle)
193 {
194 return (u32)handle;
195 }
196
197 static u32 nbd_handle_to_cookie(u64 handle)
198 {
199 return (u32)(handle >> NBD_COOKIE_BITS);
200 }
201
202 static const char *nbdcmd_to_ascii(int cmd)
203 {
204 switch (cmd) {
205 case NBD_CMD_READ: return "read";
206 case NBD_CMD_WRITE: return "write";
207 case NBD_CMD_DISC: return "disconnect";
208 case NBD_CMD_FLUSH: return "flush";
209 case NBD_CMD_TRIM: return "trim/discard";
210 }
211 return "invalid";
212 }
213
214 static ssize_t pid_show(struct device *dev,
215 struct device_attribute *attr, char *buf)
216 {
217 struct gendisk *disk = dev_to_disk(dev);
218 struct nbd_device *nbd = (struct nbd_device *)disk->private_data;
219
220 return sprintf(buf, "%d\n", nbd->pid);
221 }
222
223 static const struct device_attribute pid_attr = {
224 .attr = { .name = "pid", .mode = 0444},
225 .show = pid_show,
226 };
227
228 static ssize_t backend_show(struct device *dev,
229 struct device_attribute *attr, char *buf)
230 {
231 struct gendisk *disk = dev_to_disk(dev);
232 struct nbd_device *nbd = (struct nbd_device *)disk->private_data;
233
234 return sprintf(buf, "%s\n", nbd->backend ?: "");
235 }
236
237 static const struct device_attribute backend_attr = {
238 .attr = { .name = "backend", .mode = 0444},
239 .show = backend_show,
240 };
241
242 static void nbd_dev_remove(struct nbd_device *nbd)
243 {
244 struct gendisk *disk = nbd->disk;
245
246 del_gendisk(disk);
247 blk_cleanup_disk(disk);
248 blk_mq_free_tag_set(&nbd->tag_set);
249
250 /*
251 * Remove from idr after del_gendisk() completes, so if the same ID is
252 * reused, the following add_disk() will succeed.
253 */
254 mutex_lock(&nbd_index_mutex);
255 idr_remove(&nbd_index_idr, nbd->index);
256 mutex_unlock(&nbd_index_mutex);
257 destroy_workqueue(nbd->recv_workq);
258 kfree(nbd);
259 }
260
261 static void nbd_dev_remove_work(struct work_struct *work)
262 {
263 nbd_dev_remove(container_of(work, struct nbd_device, remove_work));
264 }
265
266 static void nbd_put(struct nbd_device *nbd)
267 {
268 if (!refcount_dec_and_test(&nbd->refs))
269 return;
270
271 /* Call del_gendisk() asynchrounously to prevent deadlock */
272 if (test_bit(NBD_DESTROY_ON_DISCONNECT, &nbd->flags))
273 queue_work(nbd_del_wq, &nbd->remove_work);
274 else
275 nbd_dev_remove(nbd);
276 }
277
278 static int nbd_disconnected(struct nbd_config *config)
279 {
280 return test_bit(NBD_RT_DISCONNECTED, &config->runtime_flags) ||
281 test_bit(NBD_RT_DISCONNECT_REQUESTED, &config->runtime_flags);
282 }
283
284 static void nbd_mark_nsock_dead(struct nbd_device *nbd, struct nbd_sock *nsock,
285 int notify)
286 {
287 if (!nsock->dead && notify && !nbd_disconnected(nbd->config)) {
288 struct link_dead_args *args;
289 args = kmalloc(sizeof(struct link_dead_args), GFP_NOIO);
290 if (args) {
291 INIT_WORK(&args->work, nbd_dead_link_work);
292 args->index = nbd->index;
293 queue_work(system_wq, &args->work);
294 }
295 }
296 if (!nsock->dead) {
297 kernel_sock_shutdown(nsock->sock, SHUT_RDWR);
298 if (atomic_dec_return(&nbd->config->live_connections) == 0) {
299 if (test_and_clear_bit(NBD_RT_DISCONNECT_REQUESTED,
300 &nbd->config->runtime_flags)) {
301 set_bit(NBD_RT_DISCONNECTED,
302 &nbd->config->runtime_flags);
303 dev_info(nbd_to_dev(nbd),
304 "Disconnected due to user request.\n");
305 }
306 }
307 }
308 nsock->dead = true;
309 nsock->pending = NULL;
310 nsock->sent = 0;
311 }
312
313 static void nbd_size_clear(struct nbd_device *nbd)
314 {
315 if (nbd->config->bytesize) {
316 set_capacity(nbd->disk, 0);
317 kobject_uevent(&nbd_to_dev(nbd)->kobj, KOBJ_CHANGE);
318 }
319 }
320
321 static int nbd_set_size(struct nbd_device *nbd, loff_t bytesize,
322 loff_t blksize)
323 {
324 if (!blksize)
325 blksize = 1u << NBD_DEF_BLKSIZE_BITS;
326 if (blksize < 512 || blksize > PAGE_SIZE || !is_power_of_2(blksize))
327 return -EINVAL;
328
329 nbd->config->bytesize = bytesize;
330 nbd->config->blksize_bits = __ffs(blksize);
331
332 if (!nbd->pid)
333 return 0;
334
335 if (nbd->config->flags & NBD_FLAG_SEND_TRIM) {
336 nbd->disk->queue->limits.discard_granularity = blksize;
337 nbd->disk->queue->limits.discard_alignment = blksize;
338 blk_queue_max_discard_sectors(nbd->disk->queue, UINT_MAX);
339 }
340 blk_queue_logical_block_size(nbd->disk->queue, blksize);
341 blk_queue_physical_block_size(nbd->disk->queue, blksize);
342
343 if (max_part)
344 set_bit(GD_NEED_PART_SCAN, &nbd->disk->state);
345 if (!set_capacity_and_notify(nbd->disk, bytesize >> 9))
346 kobject_uevent(&nbd_to_dev(nbd)->kobj, KOBJ_CHANGE);
347 return 0;
348 }
349
350 static void nbd_complete_rq(struct request *req)
351 {
352 struct nbd_cmd *cmd = blk_mq_rq_to_pdu(req);
353
354 dev_dbg(nbd_to_dev(cmd->nbd), "request %p: %s\n", req,
355 cmd->status ? "failed" : "done");
356
357 blk_mq_end_request(req, cmd->status);
358 }
359
360 /*
361 * Forcibly shutdown the socket causing all listeners to error
362 */
363 static void sock_shutdown(struct nbd_device *nbd)
364 {
365 struct nbd_config *config = nbd->config;
366 int i;
367
368 if (config->num_connections == 0)
369 return;
370 if (test_and_set_bit(NBD_RT_DISCONNECTED, &config->runtime_flags))
371 return;
372
373 for (i = 0; i < config->num_connections; i++) {
374 struct nbd_sock *nsock = config->socks[i];
375 mutex_lock(&nsock->tx_lock);
376 nbd_mark_nsock_dead(nbd, nsock, 0);
377 mutex_unlock(&nsock->tx_lock);
378 }
379 dev_warn(disk_to_dev(nbd->disk), "shutting down sockets\n");
380 }
381
382 static u32 req_to_nbd_cmd_type(struct request *req)
383 {
384 switch (req_op(req)) {
385 case REQ_OP_DISCARD:
386 return NBD_CMD_TRIM;
387 case REQ_OP_FLUSH:
388 return NBD_CMD_FLUSH;
389 case REQ_OP_WRITE:
390 return NBD_CMD_WRITE;
391 case REQ_OP_READ:
392 return NBD_CMD_READ;
393 default:
394 return U32_MAX;
395 }
396 }
397
398 static enum blk_eh_timer_return nbd_xmit_timeout(struct request *req,
399 bool reserved)
400 {
401 struct nbd_cmd *cmd = blk_mq_rq_to_pdu(req);
402 struct nbd_device *nbd = cmd->nbd;
403 struct nbd_config *config;
404
405 if (!mutex_trylock(&cmd->lock))
406 return BLK_EH_RESET_TIMER;
407
408 if (!refcount_inc_not_zero(&nbd->config_refs)) {
409 cmd->status = BLK_STS_TIMEOUT;
410 mutex_unlock(&cmd->lock);
411 goto done;
412 }
413 config = nbd->config;
414
415 if (config->num_connections > 1 ||
416 (config->num_connections == 1 && nbd->tag_set.timeout)) {
417 dev_err_ratelimited(nbd_to_dev(nbd),
418 "Connection timed out, retrying (%d/%d alive)\n",
419 atomic_read(&config->live_connections),
420 config->num_connections);
421 /*
422 * Hooray we have more connections, requeue this IO, the submit
423 * path will put it on a real connection. Or if only one
424 * connection is configured, the submit path will wait util
425 * a new connection is reconfigured or util dead timeout.
426 */
427 if (config->socks) {
428 if (cmd->index < config->num_connections) {
429 struct nbd_sock *nsock =
430 config->socks[cmd->index];
431 mutex_lock(&nsock->tx_lock);
432 /* We can have multiple outstanding requests, so
433 * we don't want to mark the nsock dead if we've
434 * already reconnected with a new socket, so
435 * only mark it dead if its the same socket we
436 * were sent out on.
437 */
438 if (cmd->cookie == nsock->cookie)
439 nbd_mark_nsock_dead(nbd, nsock, 1);
440 mutex_unlock(&nsock->tx_lock);
441 }
442 mutex_unlock(&cmd->lock);
443 nbd_requeue_cmd(cmd);
444 nbd_config_put(nbd);
445 return BLK_EH_DONE;
446 }
447 }
448
449 if (!nbd->tag_set.timeout) {
450 /*
451 * Userspace sets timeout=0 to disable socket disconnection,
452 * so just warn and reset the timer.
453 */
454 struct nbd_sock *nsock = config->socks[cmd->index];
455 cmd->retries++;
456 dev_info(nbd_to_dev(nbd), "Possible stuck request %p: control (%s@%llu,%uB). Runtime %u seconds\n",
457 req, nbdcmd_to_ascii(req_to_nbd_cmd_type(req)),
458 (unsigned long long)blk_rq_pos(req) << 9,
459 blk_rq_bytes(req), (req->timeout / HZ) * cmd->retries);
460
461 mutex_lock(&nsock->tx_lock);
462 if (cmd->cookie != nsock->cookie) {
463 nbd_requeue_cmd(cmd);
464 mutex_unlock(&nsock->tx_lock);
465 mutex_unlock(&cmd->lock);
466 nbd_config_put(nbd);
467 return BLK_EH_DONE;
468 }
469 mutex_unlock(&nsock->tx_lock);
470 mutex_unlock(&cmd->lock);
471 nbd_config_put(nbd);
472 return BLK_EH_RESET_TIMER;
473 }
474
475 dev_err_ratelimited(nbd_to_dev(nbd), "Connection timed out\n");
476 set_bit(NBD_RT_TIMEDOUT, &config->runtime_flags);
477 cmd->status = BLK_STS_IOERR;
478 mutex_unlock(&cmd->lock);
479 sock_shutdown(nbd);
480 nbd_config_put(nbd);
481 done:
482 blk_mq_complete_request(req);
483 return BLK_EH_DONE;
484 }
485
486 /*
487 * Send or receive packet.
488 */
489 static int sock_xmit(struct nbd_device *nbd, int index, int send,
490 struct iov_iter *iter, int msg_flags, int *sent)
491 {
492 struct nbd_config *config = nbd->config;
493 struct socket *sock = config->socks[index]->sock;
494 int result;
495 struct msghdr msg;
496 unsigned int noreclaim_flag;
497
498 if (unlikely(!sock)) {
499 dev_err_ratelimited(disk_to_dev(nbd->disk),
500 "Attempted %s on closed socket in sock_xmit\n",
501 (send ? "send" : "recv"));
502 return -EINVAL;
503 }
504
505 msg.msg_iter = *iter;
506
507 noreclaim_flag = memalloc_noreclaim_save();
508 do {
509 sock->sk->sk_allocation = GFP_NOIO | __GFP_MEMALLOC;
510 msg.msg_name = NULL;
511 msg.msg_namelen = 0;
512 msg.msg_control = NULL;
513 msg.msg_controllen = 0;
514 msg.msg_flags = msg_flags | MSG_NOSIGNAL;
515
516 if (send)
517 result = sock_sendmsg(sock, &msg);
518 else
519 result = sock_recvmsg(sock, &msg, msg.msg_flags);
520
521 if (result <= 0) {
522 if (result == 0)
523 result = -EPIPE; /* short read */
524 break;
525 }
526 if (sent)
527 *sent += result;
528 } while (msg_data_left(&msg));
529
530 memalloc_noreclaim_restore(noreclaim_flag);
531
532 return result;
533 }
534
535 /*
536 * Different settings for sk->sk_sndtimeo can result in different return values
537 * if there is a signal pending when we enter sendmsg, because reasons?
538 */
539 static inline int was_interrupted(int result)
540 {
541 return result == -ERESTARTSYS || result == -EINTR;
542 }
543
544 /* always call with the tx_lock held */
545 static int nbd_send_cmd(struct nbd_device *nbd, struct nbd_cmd *cmd, int index)
546 {
547 struct request *req = blk_mq_rq_from_pdu(cmd);
548 struct nbd_config *config = nbd->config;
549 struct nbd_sock *nsock = config->socks[index];
550 int result;
551 struct nbd_request request = {.magic = htonl(NBD_REQUEST_MAGIC)};
552 struct kvec iov = {.iov_base = &request, .iov_len = sizeof(request)};
553 struct iov_iter from;
554 unsigned long size = blk_rq_bytes(req);
555 struct bio *bio;
556 u64 handle;
557 u32 type;
558 u32 nbd_cmd_flags = 0;
559 int sent = nsock->sent, skip = 0;
560
561 iov_iter_kvec(&from, WRITE, &iov, 1, sizeof(request));
562
563 type = req_to_nbd_cmd_type(req);
564 if (type == U32_MAX)
565 return -EIO;
566
567 if (rq_data_dir(req) == WRITE &&
568 (config->flags & NBD_FLAG_READ_ONLY)) {
569 dev_err_ratelimited(disk_to_dev(nbd->disk),
570 "Write on read-only\n");
571 return -EIO;
572 }
573
574 if (req->cmd_flags & REQ_FUA)
575 nbd_cmd_flags |= NBD_CMD_FLAG_FUA;
576
577 /* We did a partial send previously, and we at least sent the whole
578 * request struct, so just go and send the rest of the pages in the
579 * request.
580 */
581 if (sent) {
582 if (sent >= sizeof(request)) {
583 skip = sent - sizeof(request);
584
585 /* initialize handle for tracing purposes */
586 handle = nbd_cmd_handle(cmd);
587
588 goto send_pages;
589 }
590 iov_iter_advance(&from, sent);
591 } else {
592 cmd->cmd_cookie++;
593 }
594 cmd->index = index;
595 cmd->cookie = nsock->cookie;
596 cmd->retries = 0;
597 request.type = htonl(type | nbd_cmd_flags);
598 if (type != NBD_CMD_FLUSH) {
599 request.from = cpu_to_be64((u64)blk_rq_pos(req) << 9);
600 request.len = htonl(size);
601 }
602 handle = nbd_cmd_handle(cmd);
603 memcpy(request.handle, &handle, sizeof(handle));
604
605 trace_nbd_send_request(&request, nbd->index, blk_mq_rq_from_pdu(cmd));
606
607 dev_dbg(nbd_to_dev(nbd), "request %p: sending control (%s@%llu,%uB)\n",
608 req, nbdcmd_to_ascii(type),
609 (unsigned long long)blk_rq_pos(req) << 9, blk_rq_bytes(req));
610 result = sock_xmit(nbd, index, 1, &from,
611 (type == NBD_CMD_WRITE) ? MSG_MORE : 0, &sent);
612 trace_nbd_header_sent(req, handle);
613 if (result <= 0) {
614 if (was_interrupted(result)) {
615 /* If we havne't sent anything we can just return BUSY,
616 * however if we have sent something we need to make
617 * sure we only allow this req to be sent until we are
618 * completely done.
619 */
620 if (sent) {
621 nsock->pending = req;
622 nsock->sent = sent;
623 }
624 set_bit(NBD_CMD_REQUEUED, &cmd->flags);
625 return BLK_STS_RESOURCE;
626 }
627 dev_err_ratelimited(disk_to_dev(nbd->disk),
628 "Send control failed (result %d)\n", result);
629 return -EAGAIN;
630 }
631 send_pages:
632 if (type != NBD_CMD_WRITE)
633 goto out;
634
635 bio = req->bio;
636 while (bio) {
637 struct bio *next = bio->bi_next;
638 struct bvec_iter iter;
639 struct bio_vec bvec;
640
641 bio_for_each_segment(bvec, bio, iter) {
642 bool is_last = !next && bio_iter_last(bvec, iter);
643 int flags = is_last ? 0 : MSG_MORE;
644
645 dev_dbg(nbd_to_dev(nbd), "request %p: sending %d bytes data\n",
646 req, bvec.bv_len);
647 iov_iter_bvec(&from, WRITE, &bvec, 1, bvec.bv_len);
648 if (skip) {
649 if (skip >= iov_iter_count(&from)) {
650 skip -= iov_iter_count(&from);
651 continue;
652 }
653 iov_iter_advance(&from, skip);
654 skip = 0;
655 }
656 result = sock_xmit(nbd, index, 1, &from, flags, &sent);
657 if (result <= 0) {
658 if (was_interrupted(result)) {
659 /* We've already sent the header, we
660 * have no choice but to set pending and
661 * return BUSY.
662 */
663 nsock->pending = req;
664 nsock->sent = sent;
665 set_bit(NBD_CMD_REQUEUED, &cmd->flags);
666 return BLK_STS_RESOURCE;
667 }
668 dev_err(disk_to_dev(nbd->disk),
669 "Send data failed (result %d)\n",
670 result);
671 return -EAGAIN;
672 }
673 /*
674 * The completion might already have come in,
675 * so break for the last one instead of letting
676 * the iterator do it. This prevents use-after-free
677 * of the bio.
678 */
679 if (is_last)
680 break;
681 }
682 bio = next;
683 }
684 out:
685 trace_nbd_payload_sent(req, handle);
686 nsock->pending = NULL;
687 nsock->sent = 0;
688 return 0;
689 }
690
691 /* NULL returned = something went wrong, inform userspace */
692 static struct nbd_cmd *nbd_read_stat(struct nbd_device *nbd, int index)
693 {
694 struct nbd_config *config = nbd->config;
695 int result;
696 struct nbd_reply reply;
697 struct nbd_cmd *cmd;
698 struct request *req = NULL;
699 u64 handle;
700 u16 hwq;
701 u32 tag;
702 struct kvec iov = {.iov_base = &reply, .iov_len = sizeof(reply)};
703 struct iov_iter to;
704 int ret = 0;
705
706 reply.magic = 0;
707 iov_iter_kvec(&to, READ, &iov, 1, sizeof(reply));
708 result = sock_xmit(nbd, index, 0, &to, MSG_WAITALL, NULL);
709 if (result <= 0) {
710 if (!nbd_disconnected(config))
711 dev_err(disk_to_dev(nbd->disk),
712 "Receive control failed (result %d)\n", result);
713 return ERR_PTR(result);
714 }
715
716 if (ntohl(reply.magic) != NBD_REPLY_MAGIC) {
717 dev_err(disk_to_dev(nbd->disk), "Wrong magic (0x%lx)\n",
718 (unsigned long)ntohl(reply.magic));
719 return ERR_PTR(-EPROTO);
720 }
721
722 memcpy(&handle, reply.handle, sizeof(handle));
723 tag = nbd_handle_to_tag(handle);
724 hwq = blk_mq_unique_tag_to_hwq(tag);
725 if (hwq < nbd->tag_set.nr_hw_queues)
726 req = blk_mq_tag_to_rq(nbd->tag_set.tags[hwq],
727 blk_mq_unique_tag_to_tag(tag));
728 if (!req || !blk_mq_request_started(req)) {
729 dev_err(disk_to_dev(nbd->disk), "Unexpected reply (%d) %p\n",
730 tag, req);
731 return ERR_PTR(-ENOENT);
732 }
733 trace_nbd_header_received(req, handle);
734 cmd = blk_mq_rq_to_pdu(req);
735
736 mutex_lock(&cmd->lock);
737 if (cmd->cmd_cookie != nbd_handle_to_cookie(handle)) {
738 dev_err(disk_to_dev(nbd->disk), "Double reply on req %p, cmd_cookie %u, handle cookie %u\n",
739 req, cmd->cmd_cookie, nbd_handle_to_cookie(handle));
740 ret = -ENOENT;
741 goto out;
742 }
743 if (cmd->status != BLK_STS_OK) {
744 dev_err(disk_to_dev(nbd->disk), "Command already handled %p\n",
745 req);
746 ret = -ENOENT;
747 goto out;
748 }
749 if (test_bit(NBD_CMD_REQUEUED, &cmd->flags)) {
750 dev_err(disk_to_dev(nbd->disk), "Raced with timeout on req %p\n",
751 req);
752 ret = -ENOENT;
753 goto out;
754 }
755 if (ntohl(reply.error)) {
756 dev_err(disk_to_dev(nbd->disk), "Other side returned error (%d)\n",
757 ntohl(reply.error));
758 cmd->status = BLK_STS_IOERR;
759 goto out;
760 }
761
762 dev_dbg(nbd_to_dev(nbd), "request %p: got reply\n", req);
763 if (rq_data_dir(req) != WRITE) {
764 struct req_iterator iter;
765 struct bio_vec bvec;
766
767 rq_for_each_segment(bvec, req, iter) {
768 iov_iter_bvec(&to, READ, &bvec, 1, bvec.bv_len);
769 result = sock_xmit(nbd, index, 0, &to, MSG_WAITALL, NULL);
770 if (result <= 0) {
771 dev_err(disk_to_dev(nbd->disk), "Receive data failed (result %d)\n",
772 result);
773 /*
774 * If we've disconnected, we need to make sure we
775 * complete this request, otherwise error out
776 * and let the timeout stuff handle resubmitting
777 * this request onto another connection.
778 */
779 if (nbd_disconnected(config)) {
780 cmd->status = BLK_STS_IOERR;
781 goto out;
782 }
783 ret = -EIO;
784 goto out;
785 }
786 dev_dbg(nbd_to_dev(nbd), "request %p: got %d bytes data\n",
787 req, bvec.bv_len);
788 }
789 }
790 out:
791 trace_nbd_payload_received(req, handle);
792 mutex_unlock(&cmd->lock);
793 return ret ? ERR_PTR(ret) : cmd;
794 }
795
796 static void recv_work(struct work_struct *work)
797 {
798 struct recv_thread_args *args = container_of(work,
799 struct recv_thread_args,
800 work);
801 struct nbd_device *nbd = args->nbd;
802 struct nbd_config *config = nbd->config;
803 struct nbd_cmd *cmd;
804 struct request *rq;
805
806 while (1) {
807 cmd = nbd_read_stat(nbd, args->index);
808 if (IS_ERR(cmd)) {
809 struct nbd_sock *nsock = config->socks[args->index];
810
811 mutex_lock(&nsock->tx_lock);
812 nbd_mark_nsock_dead(nbd, nsock, 1);
813 mutex_unlock(&nsock->tx_lock);
814 break;
815 }
816
817 rq = blk_mq_rq_from_pdu(cmd);
818 if (likely(!blk_should_fake_timeout(rq->q)))
819 blk_mq_complete_request(rq);
820 }
821 nbd_config_put(nbd);
822 atomic_dec(&config->recv_threads);
823 wake_up(&config->recv_wq);
824 kfree(args);
825 }
826
827 static bool nbd_clear_req(struct request *req, void *data, bool reserved)
828 {
829 struct nbd_cmd *cmd = blk_mq_rq_to_pdu(req);
830
831 /* don't abort one completed request */
832 if (blk_mq_request_completed(req))
833 return true;
834
835 mutex_lock(&cmd->lock);
836 cmd->status = BLK_STS_IOERR;
837 mutex_unlock(&cmd->lock);
838
839 blk_mq_complete_request(req);
840 return true;
841 }
842
843 static void nbd_clear_que(struct nbd_device *nbd)
844 {
845 blk_mq_quiesce_queue(nbd->disk->queue);
846 blk_mq_tagset_busy_iter(&nbd->tag_set, nbd_clear_req, NULL);
847 blk_mq_unquiesce_queue(nbd->disk->queue);
848 dev_dbg(disk_to_dev(nbd->disk), "queue cleared\n");
849 }
850
851 static int find_fallback(struct nbd_device *nbd, int index)
852 {
853 struct nbd_config *config = nbd->config;
854 int new_index = -1;
855 struct nbd_sock *nsock = config->socks[index];
856 int fallback = nsock->fallback_index;
857
858 if (test_bit(NBD_RT_DISCONNECTED, &config->runtime_flags))
859 return new_index;
860
861 if (config->num_connections <= 1) {
862 dev_err_ratelimited(disk_to_dev(nbd->disk),
863 "Dead connection, failed to find a fallback\n");
864 return new_index;
865 }
866
867 if (fallback >= 0 && fallback < config->num_connections &&
868 !config->socks[fallback]->dead)
869 return fallback;
870
871 if (nsock->fallback_index < 0 ||
872 nsock->fallback_index >= config->num_connections ||
873 config->socks[nsock->fallback_index]->dead) {
874 int i;
875 for (i = 0; i < config->num_connections; i++) {
876 if (i == index)
877 continue;
878 if (!config->socks[i]->dead) {
879 new_index = i;
880 break;
881 }
882 }
883 nsock->fallback_index = new_index;
884 if (new_index < 0) {
885 dev_err_ratelimited(disk_to_dev(nbd->disk),
886 "Dead connection, failed to find a fallback\n");
887 return new_index;
888 }
889 }
890 new_index = nsock->fallback_index;
891 return new_index;
892 }
893
894 static int wait_for_reconnect(struct nbd_device *nbd)
895 {
896 struct nbd_config *config = nbd->config;
897 if (!config->dead_conn_timeout)
898 return 0;
899 if (test_bit(NBD_RT_DISCONNECTED, &config->runtime_flags))
900 return 0;
901 return wait_event_timeout(config->conn_wait,
902 atomic_read(&config->live_connections) > 0,
903 config->dead_conn_timeout) > 0;
904 }
905
906 static int nbd_handle_cmd(struct nbd_cmd *cmd, int index)
907 {
908 struct request *req = blk_mq_rq_from_pdu(cmd);
909 struct nbd_device *nbd = cmd->nbd;
910 struct nbd_config *config;
911 struct nbd_sock *nsock;
912 int ret;
913
914 if (!refcount_inc_not_zero(&nbd->config_refs)) {
915 dev_err_ratelimited(disk_to_dev(nbd->disk),
916 "Socks array is empty\n");
917 blk_mq_start_request(req);
918 return -EINVAL;
919 }
920 config = nbd->config;
921
922 if (index >= config->num_connections) {
923 dev_err_ratelimited(disk_to_dev(nbd->disk),
924 "Attempted send on invalid socket\n");
925 nbd_config_put(nbd);
926 blk_mq_start_request(req);
927 return -EINVAL;
928 }
929 cmd->status = BLK_STS_OK;
930 again:
931 nsock = config->socks[index];
932 mutex_lock(&nsock->tx_lock);
933 if (nsock->dead) {
934 int old_index = index;
935 index = find_fallback(nbd, index);
936 mutex_unlock(&nsock->tx_lock);
937 if (index < 0) {
938 if (wait_for_reconnect(nbd)) {
939 index = old_index;
940 goto again;
941 }
942 /* All the sockets should already be down at this point,
943 * we just want to make sure that DISCONNECTED is set so
944 * any requests that come in that were queue'ed waiting
945 * for the reconnect timer don't trigger the timer again
946 * and instead just error out.
947 */
948 sock_shutdown(nbd);
949 nbd_config_put(nbd);
950 blk_mq_start_request(req);
951 return -EIO;
952 }
953 goto again;
954 }
955
956 /* Handle the case that we have a pending request that was partially
957 * transmitted that _has_ to be serviced first. We need to call requeue
958 * here so that it gets put _after_ the request that is already on the
959 * dispatch list.
960 */
961 blk_mq_start_request(req);
962 if (unlikely(nsock->pending && nsock->pending != req)) {
963 nbd_requeue_cmd(cmd);
964 ret = 0;
965 goto out;
966 }
967 /*
968 * Some failures are related to the link going down, so anything that
969 * returns EAGAIN can be retried on a different socket.
970 */
971 ret = nbd_send_cmd(nbd, cmd, index);
972 if (ret == -EAGAIN) {
973 dev_err_ratelimited(disk_to_dev(nbd->disk),
974 "Request send failed, requeueing\n");
975 nbd_mark_nsock_dead(nbd, nsock, 1);
976 nbd_requeue_cmd(cmd);
977 ret = 0;
978 }
979 out:
980 mutex_unlock(&nsock->tx_lock);
981 nbd_config_put(nbd);
982 return ret;
983 }
984
985 static blk_status_t nbd_queue_rq(struct blk_mq_hw_ctx *hctx,
986 const struct blk_mq_queue_data *bd)
987 {
988 struct nbd_cmd *cmd = blk_mq_rq_to_pdu(bd->rq);
989 int ret;
990
991 /*
992 * Since we look at the bio's to send the request over the network we
993 * need to make sure the completion work doesn't mark this request done
994 * before we are done doing our send. This keeps us from dereferencing
995 * freed data if we have particularly fast completions (ie we get the
996 * completion before we exit sock_xmit on the last bvec) or in the case
997 * that the server is misbehaving (or there was an error) before we're
998 * done sending everything over the wire.
999 */
1000 mutex_lock(&cmd->lock);
1001 clear_bit(NBD_CMD_REQUEUED, &cmd->flags);
1002
1003 /* We can be called directly from the user space process, which means we
1004 * could possibly have signals pending so our sendmsg will fail. In
1005 * this case we need to return that we are busy, otherwise error out as
1006 * appropriate.
1007 */
1008 ret = nbd_handle_cmd(cmd, hctx->queue_num);
1009 if (ret < 0)
1010 ret = BLK_STS_IOERR;
1011 else if (!ret)
1012 ret = BLK_STS_OK;
1013 mutex_unlock(&cmd->lock);
1014
1015 return ret;
1016 }
1017
1018 static struct socket *nbd_get_socket(struct nbd_device *nbd, unsigned long fd,
1019 int *err)
1020 {
1021 struct socket *sock;
1022
1023 *err = 0;
1024 sock = sockfd_lookup(fd, err);
1025 if (!sock)
1026 return NULL;
1027
1028 if (sock->ops->shutdown == sock_no_shutdown) {
1029 dev_err(disk_to_dev(nbd->disk), "Unsupported socket: shutdown callout must be supported.\n");
1030 *err = -EINVAL;
1031 sockfd_put(sock);
1032 return NULL;
1033 }
1034
1035 return sock;
1036 }
1037
1038 static int nbd_add_socket(struct nbd_device *nbd, unsigned long arg,
1039 bool netlink)
1040 {
1041 struct nbd_config *config = nbd->config;
1042 struct socket *sock;
1043 struct nbd_sock **socks;
1044 struct nbd_sock *nsock;
1045 int err;
1046
1047 sock = nbd_get_socket(nbd, arg, &err);
1048 if (!sock)
1049 return err;
1050
1051 /*
1052 * We need to make sure we don't get any errant requests while we're
1053 * reallocating the ->socks array.
1054 */
1055 blk_mq_freeze_queue(nbd->disk->queue);
1056
1057 if (!netlink && !nbd->task_setup &&
1058 !test_bit(NBD_RT_BOUND, &config->runtime_flags))
1059 nbd->task_setup = current;
1060
1061 if (!netlink &&
1062 (nbd->task_setup != current ||
1063 test_bit(NBD_RT_BOUND, &config->runtime_flags))) {
1064 dev_err(disk_to_dev(nbd->disk),
1065 "Device being setup by another task");
1066 err = -EBUSY;
1067 goto put_socket;
1068 }
1069
1070 nsock = kzalloc(sizeof(*nsock), GFP_KERNEL);
1071 if (!nsock) {
1072 err = -ENOMEM;
1073 goto put_socket;
1074 }
1075
1076 socks = krealloc(config->socks, (config->num_connections + 1) *
1077 sizeof(struct nbd_sock *), GFP_KERNEL);
1078 if (!socks) {
1079 kfree(nsock);
1080 err = -ENOMEM;
1081 goto put_socket;
1082 }
1083
1084 config->socks = socks;
1085
1086 nsock->fallback_index = -1;
1087 nsock->dead = false;
1088 mutex_init(&nsock->tx_lock);
1089 nsock->sock = sock;
1090 nsock->pending = NULL;
1091 nsock->sent = 0;
1092 nsock->cookie = 0;
1093 socks[config->num_connections++] = nsock;
1094 atomic_inc(&config->live_connections);
1095 blk_mq_unfreeze_queue(nbd->disk->queue);
1096
1097 return 0;
1098
1099 put_socket:
1100 blk_mq_unfreeze_queue(nbd->disk->queue);
1101 sockfd_put(sock);
1102 return err;
1103 }
1104
1105 static int nbd_reconnect_socket(struct nbd_device *nbd, unsigned long arg)
1106 {
1107 struct nbd_config *config = nbd->config;
1108 struct socket *sock, *old;
1109 struct recv_thread_args *args;
1110 int i;
1111 int err;
1112
1113 sock = nbd_get_socket(nbd, arg, &err);
1114 if (!sock)
1115 return err;
1116
1117 args = kzalloc(sizeof(*args), GFP_KERNEL);
1118 if (!args) {
1119 sockfd_put(sock);
1120 return -ENOMEM;
1121 }
1122
1123 for (i = 0; i < config->num_connections; i++) {
1124 struct nbd_sock *nsock = config->socks[i];
1125
1126 if (!nsock->dead)
1127 continue;
1128
1129 mutex_lock(&nsock->tx_lock);
1130 if (!nsock->dead) {
1131 mutex_unlock(&nsock->tx_lock);
1132 continue;
1133 }
1134 sk_set_memalloc(sock->sk);
1135 if (nbd->tag_set.timeout)
1136 sock->sk->sk_sndtimeo = nbd->tag_set.timeout;
1137 atomic_inc(&config->recv_threads);
1138 refcount_inc(&nbd->config_refs);
1139 old = nsock->sock;
1140 nsock->fallback_index = -1;
1141 nsock->sock = sock;
1142 nsock->dead = false;
1143 INIT_WORK(&args->work, recv_work);
1144 args->index = i;
1145 args->nbd = nbd;
1146 nsock->cookie++;
1147 mutex_unlock(&nsock->tx_lock);
1148 sockfd_put(old);
1149
1150 clear_bit(NBD_RT_DISCONNECTED, &config->runtime_flags);
1151
1152 /* We take the tx_mutex in an error path in the recv_work, so we
1153 * need to queue_work outside of the tx_mutex.
1154 */
1155 queue_work(nbd->recv_workq, &args->work);
1156
1157 atomic_inc(&config->live_connections);
1158 wake_up(&config->conn_wait);
1159 return 0;
1160 }
1161 sockfd_put(sock);
1162 kfree(args);
1163 return -ENOSPC;
1164 }
1165
1166 static void nbd_bdev_reset(struct block_device *bdev)
1167 {
1168 if (bdev->bd_openers > 1)
1169 return;
1170 set_capacity(bdev->bd_disk, 0);
1171 }
1172
1173 static void nbd_parse_flags(struct nbd_device *nbd)
1174 {
1175 struct nbd_config *config = nbd->config;
1176 if (config->flags & NBD_FLAG_READ_ONLY)
1177 set_disk_ro(nbd->disk, true);
1178 else
1179 set_disk_ro(nbd->disk, false);
1180 if (config->flags & NBD_FLAG_SEND_TRIM)
1181 blk_queue_flag_set(QUEUE_FLAG_DISCARD, nbd->disk->queue);
1182 if (config->flags & NBD_FLAG_SEND_FLUSH) {
1183 if (config->flags & NBD_FLAG_SEND_FUA)
1184 blk_queue_write_cache(nbd->disk->queue, true, true);
1185 else
1186 blk_queue_write_cache(nbd->disk->queue, true, false);
1187 }
1188 else
1189 blk_queue_write_cache(nbd->disk->queue, false, false);
1190 }
1191
1192 static void send_disconnects(struct nbd_device *nbd)
1193 {
1194 struct nbd_config *config = nbd->config;
1195 struct nbd_request request = {
1196 .magic = htonl(NBD_REQUEST_MAGIC),
1197 .type = htonl(NBD_CMD_DISC),
1198 };
1199 struct kvec iov = {.iov_base = &request, .iov_len = sizeof(request)};
1200 struct iov_iter from;
1201 int i, ret;
1202
1203 for (i = 0; i < config->num_connections; i++) {
1204 struct nbd_sock *nsock = config->socks[i];
1205
1206 iov_iter_kvec(&from, WRITE, &iov, 1, sizeof(request));
1207 mutex_lock(&nsock->tx_lock);
1208 ret = sock_xmit(nbd, i, 1, &from, 0, NULL);
1209 if (ret <= 0)
1210 dev_err(disk_to_dev(nbd->disk),
1211 "Send disconnect failed %d\n", ret);
1212 mutex_unlock(&nsock->tx_lock);
1213 }
1214 }
1215
1216 static int nbd_disconnect(struct nbd_device *nbd)
1217 {
1218 struct nbd_config *config = nbd->config;
1219
1220 dev_info(disk_to_dev(nbd->disk), "NBD_DISCONNECT\n");
1221 set_bit(NBD_RT_DISCONNECT_REQUESTED, &config->runtime_flags);
1222 set_bit(NBD_DISCONNECT_REQUESTED, &nbd->flags);
1223 send_disconnects(nbd);
1224 return 0;
1225 }
1226
1227 static void nbd_clear_sock(struct nbd_device *nbd)
1228 {
1229 sock_shutdown(nbd);
1230 nbd_clear_que(nbd);
1231 nbd->task_setup = NULL;
1232 }
1233
1234 static void nbd_config_put(struct nbd_device *nbd)
1235 {
1236 if (refcount_dec_and_mutex_lock(&nbd->config_refs,
1237 &nbd->config_lock)) {
1238 struct nbd_config *config = nbd->config;
1239 nbd_dev_dbg_close(nbd);
1240 nbd_size_clear(nbd);
1241 if (test_and_clear_bit(NBD_RT_HAS_PID_FILE,
1242 &config->runtime_flags))
1243 device_remove_file(disk_to_dev(nbd->disk), &pid_attr);
1244 nbd->pid = 0;
1245 if (test_and_clear_bit(NBD_RT_HAS_BACKEND_FILE,
1246 &config->runtime_flags)) {
1247 device_remove_file(disk_to_dev(nbd->disk), &backend_attr);
1248 kfree(nbd->backend);
1249 nbd->backend = NULL;
1250 }
1251 nbd_clear_sock(nbd);
1252 if (config->num_connections) {
1253 int i;
1254 for (i = 0; i < config->num_connections; i++) {
1255 sockfd_put(config->socks[i]->sock);
1256 kfree(config->socks[i]);
1257 }
1258 kfree(config->socks);
1259 }
1260 kfree(nbd->config);
1261 nbd->config = NULL;
1262
1263 nbd->tag_set.timeout = 0;
1264 nbd->disk->queue->limits.discard_granularity = 0;
1265 nbd->disk->queue->limits.discard_alignment = 0;
1266 blk_queue_max_discard_sectors(nbd->disk->queue, UINT_MAX);
1267 blk_queue_flag_clear(QUEUE_FLAG_DISCARD, nbd->disk->queue);
1268
1269 mutex_unlock(&nbd->config_lock);
1270 nbd_put(nbd);
1271 module_put(THIS_MODULE);
1272 }
1273 }
1274
1275 static int nbd_start_device(struct nbd_device *nbd)
1276 {
1277 struct nbd_config *config = nbd->config;
1278 int num_connections = config->num_connections;
1279 int error = 0, i;
1280
1281 if (nbd->pid)
1282 return -EBUSY;
1283 if (!config->socks)
1284 return -EINVAL;
1285 if (num_connections > 1 &&
1286 !(config->flags & NBD_FLAG_CAN_MULTI_CONN)) {
1287 dev_err(disk_to_dev(nbd->disk), "server does not support multiple connections per device.\n");
1288 return -EINVAL;
1289 }
1290
1291 blk_mq_update_nr_hw_queues(&nbd->tag_set, config->num_connections);
1292 nbd->pid = task_pid_nr(current);
1293
1294 nbd_parse_flags(nbd);
1295
1296 error = device_create_file(disk_to_dev(nbd->disk), &pid_attr);
1297 if (error) {
1298 dev_err(disk_to_dev(nbd->disk), "device_create_file failed for pid!\n");
1299 return error;
1300 }
1301 set_bit(NBD_RT_HAS_PID_FILE, &config->runtime_flags);
1302
1303 nbd_dev_dbg_init(nbd);
1304 for (i = 0; i < num_connections; i++) {
1305 struct recv_thread_args *args;
1306
1307 args = kzalloc(sizeof(*args), GFP_KERNEL);
1308 if (!args) {
1309 sock_shutdown(nbd);
1310 /*
1311 * If num_connections is m (2 < m),
1312 * and NO.1 ~ NO.n(1 < n < m) kzallocs are successful.
1313 * But NO.(n + 1) failed. We still have n recv threads.
1314 * So, add flush_workqueue here to prevent recv threads
1315 * dropping the last config_refs and trying to destroy
1316 * the workqueue from inside the workqueue.
1317 */
1318 if (i)
1319 flush_workqueue(nbd->recv_workq);
1320 return -ENOMEM;
1321 }
1322 sk_set_memalloc(config->socks[i]->sock->sk);
1323 if (nbd->tag_set.timeout)
1324 config->socks[i]->sock->sk->sk_sndtimeo =
1325 nbd->tag_set.timeout;
1326 atomic_inc(&config->recv_threads);
1327 refcount_inc(&nbd->config_refs);
1328 INIT_WORK(&args->work, recv_work);
1329 args->nbd = nbd;
1330 args->index = i;
1331 queue_work(nbd->recv_workq, &args->work);
1332 }
1333 return nbd_set_size(nbd, config->bytesize, nbd_blksize(config));
1334 }
1335
1336 static int nbd_start_device_ioctl(struct nbd_device *nbd, struct block_device *bdev)
1337 {
1338 struct nbd_config *config = nbd->config;
1339 int ret;
1340
1341 ret = nbd_start_device(nbd);
1342 if (ret)
1343 return ret;
1344
1345 if (max_part)
1346 set_bit(GD_NEED_PART_SCAN, &nbd->disk->state);
1347 mutex_unlock(&nbd->config_lock);
1348 ret = wait_event_interruptible(config->recv_wq,
1349 atomic_read(&config->recv_threads) == 0);
1350 if (ret)
1351 sock_shutdown(nbd);
1352 flush_workqueue(nbd->recv_workq);
1353
1354 mutex_lock(&nbd->config_lock);
1355 nbd_bdev_reset(bdev);
1356 /* user requested, ignore socket errors */
1357 if (test_bit(NBD_RT_DISCONNECT_REQUESTED, &config->runtime_flags))
1358 ret = 0;
1359 if (test_bit(NBD_RT_TIMEDOUT, &config->runtime_flags))
1360 ret = -ETIMEDOUT;
1361 return ret;
1362 }
1363
1364 static void nbd_clear_sock_ioctl(struct nbd_device *nbd,
1365 struct block_device *bdev)
1366 {
1367 sock_shutdown(nbd);
1368 __invalidate_device(bdev, true);
1369 nbd_bdev_reset(bdev);
1370 if (test_and_clear_bit(NBD_RT_HAS_CONFIG_REF,
1371 &nbd->config->runtime_flags))
1372 nbd_config_put(nbd);
1373 }
1374
1375 static void nbd_set_cmd_timeout(struct nbd_device *nbd, u64 timeout)
1376 {
1377 nbd->tag_set.timeout = timeout * HZ;
1378 if (timeout)
1379 blk_queue_rq_timeout(nbd->disk->queue, timeout * HZ);
1380 else
1381 blk_queue_rq_timeout(nbd->disk->queue, 30 * HZ);
1382 }
1383
1384 /* Must be called with config_lock held */
1385 static int __nbd_ioctl(struct block_device *bdev, struct nbd_device *nbd,
1386 unsigned int cmd, unsigned long arg)
1387 {
1388 struct nbd_config *config = nbd->config;
1389 loff_t bytesize;
1390
1391 switch (cmd) {
1392 case NBD_DISCONNECT:
1393 return nbd_disconnect(nbd);
1394 case NBD_CLEAR_SOCK:
1395 nbd_clear_sock_ioctl(nbd, bdev);
1396 return 0;
1397 case NBD_SET_SOCK:
1398 return nbd_add_socket(nbd, arg, false);
1399 case NBD_SET_BLKSIZE:
1400 return nbd_set_size(nbd, config->bytesize, arg);
1401 case NBD_SET_SIZE:
1402 return nbd_set_size(nbd, arg, nbd_blksize(config));
1403 case NBD_SET_SIZE_BLOCKS:
1404 if (check_shl_overflow(arg, config->blksize_bits, &bytesize))
1405 return -EINVAL;
1406 return nbd_set_size(nbd, bytesize, nbd_blksize(config));
1407 case NBD_SET_TIMEOUT:
1408 nbd_set_cmd_timeout(nbd, arg);
1409 return 0;
1410
1411 case NBD_SET_FLAGS:
1412 config->flags = arg;
1413 return 0;
1414 case NBD_DO_IT:
1415 return nbd_start_device_ioctl(nbd, bdev);
1416 case NBD_CLEAR_QUE:
1417 /*
1418 * This is for compatibility only. The queue is always cleared
1419 * by NBD_DO_IT or NBD_CLEAR_SOCK.
1420 */
1421 return 0;
1422 case NBD_PRINT_DEBUG:
1423 /*
1424 * For compatibility only, we no longer keep a list of
1425 * outstanding requests.
1426 */
1427 return 0;
1428 }
1429 return -ENOTTY;
1430 }
1431
1432 static int nbd_ioctl(struct block_device *bdev, fmode_t mode,
1433 unsigned int cmd, unsigned long arg)
1434 {
1435 struct nbd_device *nbd = bdev->bd_disk->private_data;
1436 struct nbd_config *config = nbd->config;
1437 int error = -EINVAL;
1438
1439 if (!capable(CAP_SYS_ADMIN))
1440 return -EPERM;
1441
1442 /* The block layer will pass back some non-nbd ioctls in case we have
1443 * special handling for them, but we don't so just return an error.
1444 */
1445 if (_IOC_TYPE(cmd) != 0xab)
1446 return -EINVAL;
1447
1448 mutex_lock(&nbd->config_lock);
1449
1450 /* Don't allow ioctl operations on a nbd device that was created with
1451 * netlink, unless it's DISCONNECT or CLEAR_SOCK, which are fine.
1452 */
1453 if (!test_bit(NBD_RT_BOUND, &config->runtime_flags) ||
1454 (cmd == NBD_DISCONNECT || cmd == NBD_CLEAR_SOCK))
1455 error = __nbd_ioctl(bdev, nbd, cmd, arg);
1456 else
1457 dev_err(nbd_to_dev(nbd), "Cannot use ioctl interface on a netlink controlled device.\n");
1458 mutex_unlock(&nbd->config_lock);
1459 return error;
1460 }
1461
1462 static struct nbd_config *nbd_alloc_config(void)
1463 {
1464 struct nbd_config *config;
1465
1466 config = kzalloc(sizeof(struct nbd_config), GFP_NOFS);
1467 if (!config)
1468 return NULL;
1469 atomic_set(&config->recv_threads, 0);
1470 init_waitqueue_head(&config->recv_wq);
1471 init_waitqueue_head(&config->conn_wait);
1472 config->blksize_bits = NBD_DEF_BLKSIZE_BITS;
1473 atomic_set(&config->live_connections, 0);
1474 try_module_get(THIS_MODULE);
1475 return config;
1476 }
1477
1478 static int nbd_open(struct block_device *bdev, fmode_t mode)
1479 {
1480 struct nbd_device *nbd;
1481 int ret = 0;
1482
1483 mutex_lock(&nbd_index_mutex);
1484 nbd = bdev->bd_disk->private_data;
1485 if (!nbd) {
1486 ret = -ENXIO;
1487 goto out;
1488 }
1489 if (!refcount_inc_not_zero(&nbd->refs)) {
1490 ret = -ENXIO;
1491 goto out;
1492 }
1493 if (!refcount_inc_not_zero(&nbd->config_refs)) {
1494 struct nbd_config *config;
1495
1496 mutex_lock(&nbd->config_lock);
1497 if (refcount_inc_not_zero(&nbd->config_refs)) {
1498 mutex_unlock(&nbd->config_lock);
1499 goto out;
1500 }
1501 config = nbd->config = nbd_alloc_config();
1502 if (!config) {
1503 ret = -ENOMEM;
1504 mutex_unlock(&nbd->config_lock);
1505 goto out;
1506 }
1507 refcount_set(&nbd->config_refs, 1);
1508 refcount_inc(&nbd->refs);
1509 mutex_unlock(&nbd->config_lock);
1510 if (max_part)
1511 set_bit(GD_NEED_PART_SCAN, &bdev->bd_disk->state);
1512 } else if (nbd_disconnected(nbd->config)) {
1513 if (max_part)
1514 set_bit(GD_NEED_PART_SCAN, &bdev->bd_disk->state);
1515 }
1516 out:
1517 mutex_unlock(&nbd_index_mutex);
1518 return ret;
1519 }
1520
1521 static void nbd_release(struct gendisk *disk, fmode_t mode)
1522 {
1523 struct nbd_device *nbd = disk->private_data;
1524
1525 if (test_bit(NBD_RT_DISCONNECT_ON_CLOSE, &nbd->config->runtime_flags) &&
1526 disk->part0->bd_openers == 0)
1527 nbd_disconnect_and_put(nbd);
1528
1529 nbd_config_put(nbd);
1530 nbd_put(nbd);
1531 }
1532
1533 static const struct block_device_operations nbd_fops =
1534 {
1535 .owner = THIS_MODULE,
1536 .open = nbd_open,
1537 .release = nbd_release,
1538 .ioctl = nbd_ioctl,
1539 .compat_ioctl = nbd_ioctl,
1540 };
1541
1542 #if IS_ENABLED(CONFIG_DEBUG_FS)
1543
1544 static int nbd_dbg_tasks_show(struct seq_file *s, void *unused)
1545 {
1546 struct nbd_device *nbd = s->private;
1547
1548 if (nbd->pid)
1549 seq_printf(s, "recv: %d\n", nbd->pid);
1550
1551 return 0;
1552 }
1553
1554 DEFINE_SHOW_ATTRIBUTE(nbd_dbg_tasks);
1555
1556 static int nbd_dbg_flags_show(struct seq_file *s, void *unused)
1557 {
1558 struct nbd_device *nbd = s->private;
1559 u32 flags = nbd->config->flags;
1560
1561 seq_printf(s, "Hex: 0x%08x\n\n", flags);
1562
1563 seq_puts(s, "Known flags:\n");
1564
1565 if (flags & NBD_FLAG_HAS_FLAGS)
1566 seq_puts(s, "NBD_FLAG_HAS_FLAGS\n");
1567 if (flags & NBD_FLAG_READ_ONLY)
1568 seq_puts(s, "NBD_FLAG_READ_ONLY\n");
1569 if (flags & NBD_FLAG_SEND_FLUSH)
1570 seq_puts(s, "NBD_FLAG_SEND_FLUSH\n");
1571 if (flags & NBD_FLAG_SEND_FUA)
1572 seq_puts(s, "NBD_FLAG_SEND_FUA\n");
1573 if (flags & NBD_FLAG_SEND_TRIM)
1574 seq_puts(s, "NBD_FLAG_SEND_TRIM\n");
1575
1576 return 0;
1577 }
1578
1579 DEFINE_SHOW_ATTRIBUTE(nbd_dbg_flags);
1580
1581 static int nbd_dev_dbg_init(struct nbd_device *nbd)
1582 {
1583 struct dentry *dir;
1584 struct nbd_config *config = nbd->config;
1585
1586 if (!nbd_dbg_dir)
1587 return -EIO;
1588
1589 dir = debugfs_create_dir(nbd_name(nbd), nbd_dbg_dir);
1590 if (!dir) {
1591 dev_err(nbd_to_dev(nbd), "Failed to create debugfs dir for '%s'\n",
1592 nbd_name(nbd));
1593 return -EIO;
1594 }
1595 config->dbg_dir = dir;
1596
1597 debugfs_create_file("tasks", 0444, dir, nbd, &nbd_dbg_tasks_fops);
1598 debugfs_create_u64("size_bytes", 0444, dir, &config->bytesize);
1599 debugfs_create_u32("timeout", 0444, dir, &nbd->tag_set.timeout);
1600 debugfs_create_u32("blocksize_bits", 0444, dir, &config->blksize_bits);
1601 debugfs_create_file("flags", 0444, dir, nbd, &nbd_dbg_flags_fops);
1602
1603 return 0;
1604 }
1605
1606 static void nbd_dev_dbg_close(struct nbd_device *nbd)
1607 {
1608 debugfs_remove_recursive(nbd->config->dbg_dir);
1609 }
1610
1611 static int nbd_dbg_init(void)
1612 {
1613 struct dentry *dbg_dir;
1614
1615 dbg_dir = debugfs_create_dir("nbd", NULL);
1616 if (!dbg_dir)
1617 return -EIO;
1618
1619 nbd_dbg_dir = dbg_dir;
1620
1621 return 0;
1622 }
1623
1624 static void nbd_dbg_close(void)
1625 {
1626 debugfs_remove_recursive(nbd_dbg_dir);
1627 }
1628
1629 #else /* IS_ENABLED(CONFIG_DEBUG_FS) */
1630
1631 static int nbd_dev_dbg_init(struct nbd_device *nbd)
1632 {
1633 return 0;
1634 }
1635
1636 static void nbd_dev_dbg_close(struct nbd_device *nbd)
1637 {
1638 }
1639
1640 static int nbd_dbg_init(void)
1641 {
1642 return 0;
1643 }
1644
1645 static void nbd_dbg_close(void)
1646 {
1647 }
1648
1649 #endif
1650
1651 static int nbd_init_request(struct blk_mq_tag_set *set, struct request *rq,
1652 unsigned int hctx_idx, unsigned int numa_node)
1653 {
1654 struct nbd_cmd *cmd = blk_mq_rq_to_pdu(rq);
1655 cmd->nbd = set->driver_data;
1656 cmd->flags = 0;
1657 mutex_init(&cmd->lock);
1658 return 0;
1659 }
1660
1661 static const struct blk_mq_ops nbd_mq_ops = {
1662 .queue_rq = nbd_queue_rq,
1663 .complete = nbd_complete_rq,
1664 .init_request = nbd_init_request,
1665 .timeout = nbd_xmit_timeout,
1666 };
1667
1668 static struct nbd_device *nbd_dev_add(int index, unsigned int refs)
1669 {
1670 struct nbd_device *nbd;
1671 struct gendisk *disk;
1672 int err = -ENOMEM;
1673
1674 nbd = kzalloc(sizeof(struct nbd_device), GFP_KERNEL);
1675 if (!nbd)
1676 goto out;
1677
1678 nbd->tag_set.ops = &nbd_mq_ops;
1679 nbd->tag_set.nr_hw_queues = 1;
1680 nbd->tag_set.queue_depth = 128;
1681 nbd->tag_set.numa_node = NUMA_NO_NODE;
1682 nbd->tag_set.cmd_size = sizeof(struct nbd_cmd);
1683 nbd->tag_set.flags = BLK_MQ_F_SHOULD_MERGE |
1684 BLK_MQ_F_BLOCKING;
1685 nbd->tag_set.driver_data = nbd;
1686 INIT_WORK(&nbd->remove_work, nbd_dev_remove_work);
1687 nbd->backend = NULL;
1688
1689 err = blk_mq_alloc_tag_set(&nbd->tag_set);
1690 if (err)
1691 goto out_free_nbd;
1692
1693 mutex_lock(&nbd_index_mutex);
1694 if (index >= 0) {
1695 err = idr_alloc(&nbd_index_idr, nbd, index, index + 1,
1696 GFP_KERNEL);
1697 if (err == -ENOSPC)
1698 err = -EEXIST;
1699 } else {
1700 err = idr_alloc(&nbd_index_idr, nbd, 0, 0, GFP_KERNEL);
1701 if (err >= 0)
1702 index = err;
1703 }
1704 nbd->index = index;
1705 mutex_unlock(&nbd_index_mutex);
1706 if (err < 0)
1707 goto out_free_tags;
1708
1709 disk = blk_mq_alloc_disk(&nbd->tag_set, NULL);
1710 if (IS_ERR(disk)) {
1711 err = PTR_ERR(disk);
1712 goto out_free_idr;
1713 }
1714 nbd->disk = disk;
1715
1716 nbd->recv_workq = alloc_workqueue("nbd%d-recv",
1717 WQ_MEM_RECLAIM | WQ_HIGHPRI |
1718 WQ_UNBOUND, 0, nbd->index);
1719 if (!nbd->recv_workq) {
1720 dev_err(disk_to_dev(nbd->disk), "Could not allocate knbd recv work queue.\n");
1721 err = -ENOMEM;
1722 goto out_err_disk;
1723 }
1724
1725 /*
1726 * Tell the block layer that we are not a rotational device
1727 */
1728 blk_queue_flag_set(QUEUE_FLAG_NONROT, disk->queue);
1729 blk_queue_flag_clear(QUEUE_FLAG_ADD_RANDOM, disk->queue);
1730 disk->queue->limits.discard_granularity = 0;
1731 disk->queue->limits.discard_alignment = 0;
1732 blk_queue_max_discard_sectors(disk->queue, 0);
1733 blk_queue_max_segment_size(disk->queue, UINT_MAX);
1734 blk_queue_max_segments(disk->queue, USHRT_MAX);
1735 blk_queue_max_hw_sectors(disk->queue, 65536);
1736 disk->queue->limits.max_sectors = 256;
1737
1738 mutex_init(&nbd->config_lock);
1739 refcount_set(&nbd->config_refs, 0);
1740 /*
1741 * Start out with a zero references to keep other threads from using
1742 * this device until it is fully initialized.
1743 */
1744 refcount_set(&nbd->refs, 0);
1745 INIT_LIST_HEAD(&nbd->list);
1746 disk->major = NBD_MAJOR;
1747
1748 /* Too big first_minor can cause duplicate creation of
1749 * sysfs files/links, since index << part_shift might overflow, or
1750 * MKDEV() expect that the max bits of first_minor is 20.
1751 */
1752 disk->first_minor = index << part_shift;
1753 if (disk->first_minor < index || disk->first_minor > MINORMASK) {
1754 err = -EINVAL;
1755 goto out_free_work;
1756 }
1757
1758 disk->minors = 1 << part_shift;
1759 disk->fops = &nbd_fops;
1760 disk->private_data = nbd;
1761 sprintf(disk->disk_name, "nbd%d", index);
1762 err = add_disk(disk);
1763 if (err)
1764 goto out_free_work;
1765
1766 /*
1767 * Now publish the device.
1768 */
1769 refcount_set(&nbd->refs, refs);
1770 nbd_total_devices++;
1771 return nbd;
1772
1773 out_free_work:
1774 destroy_workqueue(nbd->recv_workq);
1775 out_err_disk:
1776 blk_cleanup_disk(disk);
1777 out_free_idr:
1778 mutex_lock(&nbd_index_mutex);
1779 idr_remove(&nbd_index_idr, index);
1780 mutex_unlock(&nbd_index_mutex);
1781 out_free_tags:
1782 blk_mq_free_tag_set(&nbd->tag_set);
1783 out_free_nbd:
1784 kfree(nbd);
1785 out:
1786 return ERR_PTR(err);
1787 }
1788
1789 static struct nbd_device *nbd_find_get_unused(void)
1790 {
1791 struct nbd_device *nbd;
1792 int id;
1793
1794 lockdep_assert_held(&nbd_index_mutex);
1795
1796 idr_for_each_entry(&nbd_index_idr, nbd, id) {
1797 if (refcount_read(&nbd->config_refs) ||
1798 test_bit(NBD_DESTROY_ON_DISCONNECT, &nbd->flags))
1799 continue;
1800 if (refcount_inc_not_zero(&nbd->refs))
1801 return nbd;
1802 }
1803
1804 return NULL;
1805 }
1806
1807 /* Netlink interface. */
1808 static const struct nla_policy nbd_attr_policy[NBD_ATTR_MAX + 1] = {
1809 [NBD_ATTR_INDEX] = { .type = NLA_U32 },
1810 [NBD_ATTR_SIZE_BYTES] = { .type = NLA_U64 },
1811 [NBD_ATTR_BLOCK_SIZE_BYTES] = { .type = NLA_U64 },
1812 [NBD_ATTR_TIMEOUT] = { .type = NLA_U64 },
1813 [NBD_ATTR_SERVER_FLAGS] = { .type = NLA_U64 },
1814 [NBD_ATTR_CLIENT_FLAGS] = { .type = NLA_U64 },
1815 [NBD_ATTR_SOCKETS] = { .type = NLA_NESTED},
1816 [NBD_ATTR_DEAD_CONN_TIMEOUT] = { .type = NLA_U64 },
1817 [NBD_ATTR_DEVICE_LIST] = { .type = NLA_NESTED},
1818 [NBD_ATTR_BACKEND_IDENTIFIER] = { .type = NLA_STRING},
1819 };
1820
1821 static const struct nla_policy nbd_sock_policy[NBD_SOCK_MAX + 1] = {
1822 [NBD_SOCK_FD] = { .type = NLA_U32 },
1823 };
1824
1825 /* We don't use this right now since we don't parse the incoming list, but we
1826 * still want it here so userspace knows what to expect.
1827 */
1828 static const struct nla_policy __attribute__((unused))
1829 nbd_device_policy[NBD_DEVICE_ATTR_MAX + 1] = {
1830 [NBD_DEVICE_INDEX] = { .type = NLA_U32 },
1831 [NBD_DEVICE_CONNECTED] = { .type = NLA_U8 },
1832 };
1833
1834 static int nbd_genl_size_set(struct genl_info *info, struct nbd_device *nbd)
1835 {
1836 struct nbd_config *config = nbd->config;
1837 u64 bsize = nbd_blksize(config);
1838 u64 bytes = config->bytesize;
1839
1840 if (info->attrs[NBD_ATTR_SIZE_BYTES])
1841 bytes = nla_get_u64(info->attrs[NBD_ATTR_SIZE_BYTES]);
1842
1843 if (info->attrs[NBD_ATTR_BLOCK_SIZE_BYTES])
1844 bsize = nla_get_u64(info->attrs[NBD_ATTR_BLOCK_SIZE_BYTES]);
1845
1846 if (bytes != config->bytesize || bsize != nbd_blksize(config))
1847 return nbd_set_size(nbd, bytes, bsize);
1848 return 0;
1849 }
1850
1851 static int nbd_genl_connect(struct sk_buff *skb, struct genl_info *info)
1852 {
1853 struct nbd_device *nbd;
1854 struct nbd_config *config;
1855 int index = -1;
1856 int ret;
1857 bool put_dev = false;
1858
1859 if (!netlink_capable(skb, CAP_SYS_ADMIN))
1860 return -EPERM;
1861
1862 if (info->attrs[NBD_ATTR_INDEX])
1863 index = nla_get_u32(info->attrs[NBD_ATTR_INDEX]);
1864 if (!info->attrs[NBD_ATTR_SOCKETS]) {
1865 printk(KERN_ERR "nbd: must specify at least one socket\n");
1866 return -EINVAL;
1867 }
1868 if (!info->attrs[NBD_ATTR_SIZE_BYTES]) {
1869 printk(KERN_ERR "nbd: must specify a size in bytes for the device\n");
1870 return -EINVAL;
1871 }
1872 again:
1873 mutex_lock(&nbd_index_mutex);
1874 if (index == -1) {
1875 nbd = nbd_find_get_unused();
1876 } else {
1877 nbd = idr_find(&nbd_index_idr, index);
1878 if (nbd) {
1879 if ((test_bit(NBD_DESTROY_ON_DISCONNECT, &nbd->flags) &&
1880 test_bit(NBD_DISCONNECT_REQUESTED, &nbd->flags)) ||
1881 !refcount_inc_not_zero(&nbd->refs)) {
1882 mutex_unlock(&nbd_index_mutex);
1883 pr_err("nbd: device at index %d is going down\n",
1884 index);
1885 return -EINVAL;
1886 }
1887 }
1888 }
1889 mutex_unlock(&nbd_index_mutex);
1890
1891 if (!nbd) {
1892 nbd = nbd_dev_add(index, 2);
1893 if (IS_ERR(nbd)) {
1894 pr_err("nbd: failed to add new device\n");
1895 return PTR_ERR(nbd);
1896 }
1897 }
1898
1899 mutex_lock(&nbd->config_lock);
1900 if (refcount_read(&nbd->config_refs)) {
1901 mutex_unlock(&nbd->config_lock);
1902 nbd_put(nbd);
1903 if (index == -1)
1904 goto again;
1905 printk(KERN_ERR "nbd: nbd%d already in use\n", index);
1906 return -EBUSY;
1907 }
1908 if (WARN_ON(nbd->config)) {
1909 mutex_unlock(&nbd->config_lock);
1910 nbd_put(nbd);
1911 return -EINVAL;
1912 }
1913 config = nbd->config = nbd_alloc_config();
1914 if (!nbd->config) {
1915 mutex_unlock(&nbd->config_lock);
1916 nbd_put(nbd);
1917 printk(KERN_ERR "nbd: couldn't allocate config\n");
1918 return -ENOMEM;
1919 }
1920 refcount_set(&nbd->config_refs, 1);
1921 set_bit(NBD_RT_BOUND, &config->runtime_flags);
1922
1923 ret = nbd_genl_size_set(info, nbd);
1924 if (ret)
1925 goto out;
1926
1927 if (info->attrs[NBD_ATTR_TIMEOUT])
1928 nbd_set_cmd_timeout(nbd,
1929 nla_get_u64(info->attrs[NBD_ATTR_TIMEOUT]));
1930 if (info->attrs[NBD_ATTR_DEAD_CONN_TIMEOUT]) {
1931 config->dead_conn_timeout =
1932 nla_get_u64(info->attrs[NBD_ATTR_DEAD_CONN_TIMEOUT]);
1933 config->dead_conn_timeout *= HZ;
1934 }
1935 if (info->attrs[NBD_ATTR_SERVER_FLAGS])
1936 config->flags =
1937 nla_get_u64(info->attrs[NBD_ATTR_SERVER_FLAGS]);
1938 if (info->attrs[NBD_ATTR_CLIENT_FLAGS]) {
1939 u64 flags = nla_get_u64(info->attrs[NBD_ATTR_CLIENT_FLAGS]);
1940 if (flags & NBD_CFLAG_DESTROY_ON_DISCONNECT) {
1941 /*
1942 * We have 1 ref to keep the device around, and then 1
1943 * ref for our current operation here, which will be
1944 * inherited by the config. If we already have
1945 * DESTROY_ON_DISCONNECT set then we know we don't have
1946 * that extra ref already held so we don't need the
1947 * put_dev.
1948 */
1949 if (!test_and_set_bit(NBD_DESTROY_ON_DISCONNECT,
1950 &nbd->flags))
1951 put_dev = true;
1952 } else {
1953 if (test_and_clear_bit(NBD_DESTROY_ON_DISCONNECT,
1954 &nbd->flags))
1955 refcount_inc(&nbd->refs);
1956 }
1957 if (flags & NBD_CFLAG_DISCONNECT_ON_CLOSE) {
1958 set_bit(NBD_RT_DISCONNECT_ON_CLOSE,
1959 &config->runtime_flags);
1960 }
1961 }
1962
1963 if (info->attrs[NBD_ATTR_SOCKETS]) {
1964 struct nlattr *attr;
1965 int rem, fd;
1966
1967 nla_for_each_nested(attr, info->attrs[NBD_ATTR_SOCKETS],
1968 rem) {
1969 struct nlattr *socks[NBD_SOCK_MAX+1];
1970
1971 if (nla_type(attr) != NBD_SOCK_ITEM) {
1972 printk(KERN_ERR "nbd: socks must be embedded in a SOCK_ITEM attr\n");
1973 ret = -EINVAL;
1974 goto out;
1975 }
1976 ret = nla_parse_nested_deprecated(socks, NBD_SOCK_MAX,
1977 attr,
1978 nbd_sock_policy,
1979 info->extack);
1980 if (ret != 0) {
1981 printk(KERN_ERR "nbd: error processing sock list\n");
1982 ret = -EINVAL;
1983 goto out;
1984 }
1985 if (!socks[NBD_SOCK_FD])
1986 continue;
1987 fd = (int)nla_get_u32(socks[NBD_SOCK_FD]);
1988 ret = nbd_add_socket(nbd, fd, true);
1989 if (ret)
1990 goto out;
1991 }
1992 }
1993 ret = nbd_start_device(nbd);
1994 if (ret)
1995 goto out;
1996 if (info->attrs[NBD_ATTR_BACKEND_IDENTIFIER]) {
1997 nbd->backend = nla_strdup(info->attrs[NBD_ATTR_BACKEND_IDENTIFIER],
1998 GFP_KERNEL);
1999 if (!nbd->backend) {
2000 ret = -ENOMEM;
2001 goto out;
2002 }
2003 }
2004 ret = device_create_file(disk_to_dev(nbd->disk), &backend_attr);
2005 if (ret) {
2006 dev_err(disk_to_dev(nbd->disk),
2007 "device_create_file failed for backend!\n");
2008 goto out;
2009 }
2010 set_bit(NBD_RT_HAS_BACKEND_FILE, &config->runtime_flags);
2011 out:
2012 mutex_unlock(&nbd->config_lock);
2013 if (!ret) {
2014 set_bit(NBD_RT_HAS_CONFIG_REF, &config->runtime_flags);
2015 refcount_inc(&nbd->config_refs);
2016 nbd_connect_reply(info, nbd->index);
2017 }
2018 nbd_config_put(nbd);
2019 if (put_dev)
2020 nbd_put(nbd);
2021 return ret;
2022 }
2023
2024 static void nbd_disconnect_and_put(struct nbd_device *nbd)
2025 {
2026 mutex_lock(&nbd->config_lock);
2027 nbd_disconnect(nbd);
2028 sock_shutdown(nbd);
2029 /*
2030 * Make sure recv thread has finished, we can safely call nbd_clear_que()
2031 * to cancel the inflight I/Os.
2032 */
2033 flush_workqueue(nbd->recv_workq);
2034 nbd_clear_que(nbd);
2035 nbd->task_setup = NULL;
2036 mutex_unlock(&nbd->config_lock);
2037
2038 if (test_and_clear_bit(NBD_RT_HAS_CONFIG_REF,
2039 &nbd->config->runtime_flags))
2040 nbd_config_put(nbd);
2041 }
2042
2043 static int nbd_genl_disconnect(struct sk_buff *skb, struct genl_info *info)
2044 {
2045 struct nbd_device *nbd;
2046 int index;
2047
2048 if (!netlink_capable(skb, CAP_SYS_ADMIN))
2049 return -EPERM;
2050
2051 if (!info->attrs[NBD_ATTR_INDEX]) {
2052 printk(KERN_ERR "nbd: must specify an index to disconnect\n");
2053 return -EINVAL;
2054 }
2055 index = nla_get_u32(info->attrs[NBD_ATTR_INDEX]);
2056 mutex_lock(&nbd_index_mutex);
2057 nbd = idr_find(&nbd_index_idr, index);
2058 if (!nbd) {
2059 mutex_unlock(&nbd_index_mutex);
2060 printk(KERN_ERR "nbd: couldn't find device at index %d\n",
2061 index);
2062 return -EINVAL;
2063 }
2064 if (!refcount_inc_not_zero(&nbd->refs)) {
2065 mutex_unlock(&nbd_index_mutex);
2066 printk(KERN_ERR "nbd: device at index %d is going down\n",
2067 index);
2068 return -EINVAL;
2069 }
2070 mutex_unlock(&nbd_index_mutex);
2071 if (!refcount_inc_not_zero(&nbd->config_refs))
2072 goto put_nbd;
2073 nbd_disconnect_and_put(nbd);
2074 nbd_config_put(nbd);
2075 put_nbd:
2076 nbd_put(nbd);
2077 return 0;
2078 }
2079
2080 static int nbd_genl_reconfigure(struct sk_buff *skb, struct genl_info *info)
2081 {
2082 struct nbd_device *nbd = NULL;
2083 struct nbd_config *config;
2084 int index;
2085 int ret = 0;
2086 bool put_dev = false;
2087
2088 if (!netlink_capable(skb, CAP_SYS_ADMIN))
2089 return -EPERM;
2090
2091 if (!info->attrs[NBD_ATTR_INDEX]) {
2092 printk(KERN_ERR "nbd: must specify a device to reconfigure\n");
2093 return -EINVAL;
2094 }
2095 index = nla_get_u32(info->attrs[NBD_ATTR_INDEX]);
2096 mutex_lock(&nbd_index_mutex);
2097 nbd = idr_find(&nbd_index_idr, index);
2098 if (!nbd) {
2099 mutex_unlock(&nbd_index_mutex);
2100 printk(KERN_ERR "nbd: couldn't find a device at index %d\n",
2101 index);
2102 return -EINVAL;
2103 }
2104 if (nbd->backend) {
2105 if (info->attrs[NBD_ATTR_BACKEND_IDENTIFIER]) {
2106 if (nla_strcmp(info->attrs[NBD_ATTR_BACKEND_IDENTIFIER],
2107 nbd->backend)) {
2108 mutex_unlock(&nbd_index_mutex);
2109 dev_err(nbd_to_dev(nbd),
2110 "backend image doesn't match with %s\n",
2111 nbd->backend);
2112 return -EINVAL;
2113 }
2114 } else {
2115 mutex_unlock(&nbd_index_mutex);
2116 dev_err(nbd_to_dev(nbd), "must specify backend\n");
2117 return -EINVAL;
2118 }
2119 }
2120 if (!refcount_inc_not_zero(&nbd->refs)) {
2121 mutex_unlock(&nbd_index_mutex);
2122 printk(KERN_ERR "nbd: device at index %d is going down\n",
2123 index);
2124 return -EINVAL;
2125 }
2126 mutex_unlock(&nbd_index_mutex);
2127
2128 if (!refcount_inc_not_zero(&nbd->config_refs)) {
2129 dev_err(nbd_to_dev(nbd),
2130 "not configured, cannot reconfigure\n");
2131 nbd_put(nbd);
2132 return -EINVAL;
2133 }
2134
2135 mutex_lock(&nbd->config_lock);
2136 config = nbd->config;
2137 if (!test_bit(NBD_RT_BOUND, &config->runtime_flags) ||
2138 !nbd->pid) {
2139 dev_err(nbd_to_dev(nbd),
2140 "not configured, cannot reconfigure\n");
2141 ret = -EINVAL;
2142 goto out;
2143 }
2144
2145 ret = nbd_genl_size_set(info, nbd);
2146 if (ret)
2147 goto out;
2148
2149 if (info->attrs[NBD_ATTR_TIMEOUT])
2150 nbd_set_cmd_timeout(nbd,
2151 nla_get_u64(info->attrs[NBD_ATTR_TIMEOUT]));
2152 if (info->attrs[NBD_ATTR_DEAD_CONN_TIMEOUT]) {
2153 config->dead_conn_timeout =
2154 nla_get_u64(info->attrs[NBD_ATTR_DEAD_CONN_TIMEOUT]);
2155 config->dead_conn_timeout *= HZ;
2156 }
2157 if (info->attrs[NBD_ATTR_CLIENT_FLAGS]) {
2158 u64 flags = nla_get_u64(info->attrs[NBD_ATTR_CLIENT_FLAGS]);
2159 if (flags & NBD_CFLAG_DESTROY_ON_DISCONNECT) {
2160 if (!test_and_set_bit(NBD_DESTROY_ON_DISCONNECT,
2161 &nbd->flags))
2162 put_dev = true;
2163 } else {
2164 if (test_and_clear_bit(NBD_DESTROY_ON_DISCONNECT,
2165 &nbd->flags))
2166 refcount_inc(&nbd->refs);
2167 }
2168
2169 if (flags & NBD_CFLAG_DISCONNECT_ON_CLOSE) {
2170 set_bit(NBD_RT_DISCONNECT_ON_CLOSE,
2171 &config->runtime_flags);
2172 } else {
2173 clear_bit(NBD_RT_DISCONNECT_ON_CLOSE,
2174 &config->runtime_flags);
2175 }
2176 }
2177
2178 if (info->attrs[NBD_ATTR_SOCKETS]) {
2179 struct nlattr *attr;
2180 int rem, fd;
2181
2182 nla_for_each_nested(attr, info->attrs[NBD_ATTR_SOCKETS],
2183 rem) {
2184 struct nlattr *socks[NBD_SOCK_MAX+1];
2185
2186 if (nla_type(attr) != NBD_SOCK_ITEM) {
2187 printk(KERN_ERR "nbd: socks must be embedded in a SOCK_ITEM attr\n");
2188 ret = -EINVAL;
2189 goto out;
2190 }
2191 ret = nla_parse_nested_deprecated(socks, NBD_SOCK_MAX,
2192 attr,
2193 nbd_sock_policy,
2194 info->extack);
2195 if (ret != 0) {
2196 printk(KERN_ERR "nbd: error processing sock list\n");
2197 ret = -EINVAL;
2198 goto out;
2199 }
2200 if (!socks[NBD_SOCK_FD])
2201 continue;
2202 fd = (int)nla_get_u32(socks[NBD_SOCK_FD]);
2203 ret = nbd_reconnect_socket(nbd, fd);
2204 if (ret) {
2205 if (ret == -ENOSPC)
2206 ret = 0;
2207 goto out;
2208 }
2209 dev_info(nbd_to_dev(nbd), "reconnected socket\n");
2210 }
2211 }
2212 out:
2213 mutex_unlock(&nbd->config_lock);
2214 nbd_config_put(nbd);
2215 nbd_put(nbd);
2216 if (put_dev)
2217 nbd_put(nbd);
2218 return ret;
2219 }
2220
2221 static const struct genl_small_ops nbd_connect_genl_ops[] = {
2222 {
2223 .cmd = NBD_CMD_CONNECT,
2224 .validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
2225 .doit = nbd_genl_connect,
2226 },
2227 {
2228 .cmd = NBD_CMD_DISCONNECT,
2229 .validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
2230 .doit = nbd_genl_disconnect,
2231 },
2232 {
2233 .cmd = NBD_CMD_RECONFIGURE,
2234 .validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
2235 .doit = nbd_genl_reconfigure,
2236 },
2237 {
2238 .cmd = NBD_CMD_STATUS,
2239 .validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
2240 .doit = nbd_genl_status,
2241 },
2242 };
2243
2244 static const struct genl_multicast_group nbd_mcast_grps[] = {
2245 { .name = NBD_GENL_MCAST_GROUP_NAME, },
2246 };
2247
2248 static struct genl_family nbd_genl_family __ro_after_init = {
2249 .hdrsize = 0,
2250 .name = NBD_GENL_FAMILY_NAME,
2251 .version = NBD_GENL_VERSION,
2252 .module = THIS_MODULE,
2253 .small_ops = nbd_connect_genl_ops,
2254 .n_small_ops = ARRAY_SIZE(nbd_connect_genl_ops),
2255 .maxattr = NBD_ATTR_MAX,
2256 .policy = nbd_attr_policy,
2257 .mcgrps = nbd_mcast_grps,
2258 .n_mcgrps = ARRAY_SIZE(nbd_mcast_grps),
2259 };
2260
2261 static int populate_nbd_status(struct nbd_device *nbd, struct sk_buff *reply)
2262 {
2263 struct nlattr *dev_opt;
2264 u8 connected = 0;
2265 int ret;
2266
2267 /* This is a little racey, but for status it's ok. The
2268 * reason we don't take a ref here is because we can't
2269 * take a ref in the index == -1 case as we would need
2270 * to put under the nbd_index_mutex, which could
2271 * deadlock if we are configured to remove ourselves
2272 * once we're disconnected.
2273 */
2274 if (refcount_read(&nbd->config_refs))
2275 connected = 1;
2276 dev_opt = nla_nest_start_noflag(reply, NBD_DEVICE_ITEM);
2277 if (!dev_opt)
2278 return -EMSGSIZE;
2279 ret = nla_put_u32(reply, NBD_DEVICE_INDEX, nbd->index);
2280 if (ret)
2281 return -EMSGSIZE;
2282 ret = nla_put_u8(reply, NBD_DEVICE_CONNECTED,
2283 connected);
2284 if (ret)
2285 return -EMSGSIZE;
2286 nla_nest_end(reply, dev_opt);
2287 return 0;
2288 }
2289
2290 static int status_cb(int id, void *ptr, void *data)
2291 {
2292 struct nbd_device *nbd = ptr;
2293 return populate_nbd_status(nbd, (struct sk_buff *)data);
2294 }
2295
2296 static int nbd_genl_status(struct sk_buff *skb, struct genl_info *info)
2297 {
2298 struct nlattr *dev_list;
2299 struct sk_buff *reply;
2300 void *reply_head;
2301 size_t msg_size;
2302 int index = -1;
2303 int ret = -ENOMEM;
2304
2305 if (info->attrs[NBD_ATTR_INDEX])
2306 index = nla_get_u32(info->attrs[NBD_ATTR_INDEX]);
2307
2308 mutex_lock(&nbd_index_mutex);
2309
2310 msg_size = nla_total_size(nla_attr_size(sizeof(u32)) +
2311 nla_attr_size(sizeof(u8)));
2312 msg_size *= (index == -1) ? nbd_total_devices : 1;
2313
2314 reply = genlmsg_new(msg_size, GFP_KERNEL);
2315 if (!reply)
2316 goto out;
2317 reply_head = genlmsg_put_reply(reply, info, &nbd_genl_family, 0,
2318 NBD_CMD_STATUS);
2319 if (!reply_head) {
2320 nlmsg_free(reply);
2321 goto out;
2322 }
2323
2324 dev_list = nla_nest_start_noflag(reply, NBD_ATTR_DEVICE_LIST);
2325 if (!dev_list) {
2326 nlmsg_free(reply);
2327 ret = -EMSGSIZE;
2328 goto out;
2329 }
2330
2331 if (index == -1) {
2332 ret = idr_for_each(&nbd_index_idr, &status_cb, reply);
2333 if (ret) {
2334 nlmsg_free(reply);
2335 goto out;
2336 }
2337 } else {
2338 struct nbd_device *nbd;
2339 nbd = idr_find(&nbd_index_idr, index);
2340 if (nbd) {
2341 ret = populate_nbd_status(nbd, reply);
2342 if (ret) {
2343 nlmsg_free(reply);
2344 goto out;
2345 }
2346 }
2347 }
2348 nla_nest_end(reply, dev_list);
2349 genlmsg_end(reply, reply_head);
2350 ret = genlmsg_reply(reply, info);
2351 out:
2352 mutex_unlock(&nbd_index_mutex);
2353 return ret;
2354 }
2355
2356 static void nbd_connect_reply(struct genl_info *info, int index)
2357 {
2358 struct sk_buff *skb;
2359 void *msg_head;
2360 int ret;
2361
2362 skb = genlmsg_new(nla_total_size(sizeof(u32)), GFP_KERNEL);
2363 if (!skb)
2364 return;
2365 msg_head = genlmsg_put_reply(skb, info, &nbd_genl_family, 0,
2366 NBD_CMD_CONNECT);
2367 if (!msg_head) {
2368 nlmsg_free(skb);
2369 return;
2370 }
2371 ret = nla_put_u32(skb, NBD_ATTR_INDEX, index);
2372 if (ret) {
2373 nlmsg_free(skb);
2374 return;
2375 }
2376 genlmsg_end(skb, msg_head);
2377 genlmsg_reply(skb, info);
2378 }
2379
2380 static void nbd_mcast_index(int index)
2381 {
2382 struct sk_buff *skb;
2383 void *msg_head;
2384 int ret;
2385
2386 skb = genlmsg_new(nla_total_size(sizeof(u32)), GFP_KERNEL);
2387 if (!skb)
2388 return;
2389 msg_head = genlmsg_put(skb, 0, 0, &nbd_genl_family, 0,
2390 NBD_CMD_LINK_DEAD);
2391 if (!msg_head) {
2392 nlmsg_free(skb);
2393 return;
2394 }
2395 ret = nla_put_u32(skb, NBD_ATTR_INDEX, index);
2396 if (ret) {
2397 nlmsg_free(skb);
2398 return;
2399 }
2400 genlmsg_end(skb, msg_head);
2401 genlmsg_multicast(&nbd_genl_family, skb, 0, 0, GFP_KERNEL);
2402 }
2403
2404 static void nbd_dead_link_work(struct work_struct *work)
2405 {
2406 struct link_dead_args *args = container_of(work, struct link_dead_args,
2407 work);
2408 nbd_mcast_index(args->index);
2409 kfree(args);
2410 }
2411
2412 static int __init nbd_init(void)
2413 {
2414 int i;
2415
2416 BUILD_BUG_ON(sizeof(struct nbd_request) != 28);
2417
2418 if (max_part < 0) {
2419 printk(KERN_ERR "nbd: max_part must be >= 0\n");
2420 return -EINVAL;
2421 }
2422
2423 part_shift = 0;
2424 if (max_part > 0) {
2425 part_shift = fls(max_part);
2426
2427 /*
2428 * Adjust max_part according to part_shift as it is exported
2429 * to user space so that user can know the max number of
2430 * partition kernel should be able to manage.
2431 *
2432 * Note that -1 is required because partition 0 is reserved
2433 * for the whole disk.
2434 */
2435 max_part = (1UL << part_shift) - 1;
2436 }
2437
2438 if ((1UL << part_shift) > DISK_MAX_PARTS)
2439 return -EINVAL;
2440
2441 if (nbds_max > 1UL << (MINORBITS - part_shift))
2442 return -EINVAL;
2443
2444 if (register_blkdev(NBD_MAJOR, "nbd"))
2445 return -EIO;
2446
2447 nbd_del_wq = alloc_workqueue("nbd-del", WQ_UNBOUND, 0);
2448 if (!nbd_del_wq) {
2449 unregister_blkdev(NBD_MAJOR, "nbd");
2450 return -ENOMEM;
2451 }
2452
2453 if (genl_register_family(&nbd_genl_family)) {
2454 destroy_workqueue(nbd_del_wq);
2455 unregister_blkdev(NBD_MAJOR, "nbd");
2456 return -EINVAL;
2457 }
2458 nbd_dbg_init();
2459
2460 for (i = 0; i < nbds_max; i++)
2461 nbd_dev_add(i, 1);
2462 return 0;
2463 }
2464
2465 static int nbd_exit_cb(int id, void *ptr, void *data)
2466 {
2467 struct list_head *list = (struct list_head *)data;
2468 struct nbd_device *nbd = ptr;
2469
2470 /* Skip nbd that is being removed asynchronously */
2471 if (refcount_read(&nbd->refs))
2472 list_add_tail(&nbd->list, list);
2473
2474 return 0;
2475 }
2476
2477 static void __exit nbd_cleanup(void)
2478 {
2479 struct nbd_device *nbd;
2480 LIST_HEAD(del_list);
2481
2482 nbd_dbg_close();
2483
2484 mutex_lock(&nbd_index_mutex);
2485 idr_for_each(&nbd_index_idr, &nbd_exit_cb, &del_list);
2486 mutex_unlock(&nbd_index_mutex);
2487
2488 while (!list_empty(&del_list)) {
2489 nbd = list_first_entry(&del_list, struct nbd_device, list);
2490 list_del_init(&nbd->list);
2491 if (refcount_read(&nbd->refs) != 1)
2492 printk(KERN_ERR "nbd: possibly leaking a device\n");
2493 nbd_put(nbd);
2494 }
2495
2496 /* Also wait for nbd_dev_remove_work() completes */
2497 destroy_workqueue(nbd_del_wq);
2498
2499 idr_destroy(&nbd_index_idr);
2500 genl_unregister_family(&nbd_genl_family);
2501 unregister_blkdev(NBD_MAJOR, "nbd");
2502 }
2503
2504 module_init(nbd_init);
2505 module_exit(nbd_cleanup);
2506
2507 MODULE_DESCRIPTION("Network Block Device");
2508 MODULE_LICENSE("GPL");
2509
2510 module_param(nbds_max, int, 0444);
2511 MODULE_PARM_DESC(nbds_max, "number of network block devices to initialize (default: 16)");
2512 module_param(max_part, int, 0444);
2513 MODULE_PARM_DESC(max_part, "number of partitions per device (default: 16)");