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