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