drivers/block/nbd.c

   1 /*
   2  * Network block device - make block devices work over TCP
   3  *
   4  * Note that you can not swap over this thing, yet. Seems to work but
   5  * deadlocks sometimes - you can not swap over TCP in general.
   6  *
   7  * Copyright 1997-2000, 2008 Pavel Machek <pavel@ucw.cz>
   8  * Parts copyright 2001 Steven Whitehouse <steve@chygwyn.com>
   9  *
  10  * This file is released under GPLv2 or later.
  11  *
  12  * (part of code stolen from loop.c)
  13  */
  14
  15 #include <linux/major.h>
  16
  17 #include <linux/blkdev.h>
  18 #include <linux/module.h>
  19 #include <linux/init.h>
  20 #include <linux/sched.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/err.h>
  30 #include <linux/kernel.h>
  31 #include <linux/slab.h>
  32 #include <net/sock.h>
  33 #include <linux/net.h>
  34 #include <linux/kthread.h>
  35 #include <linux/types.h>
  36 #include <linux/debugfs.h>
  37
  38 #include <asm/uaccess.h>
  39 #include <asm/types.h>
  40
  41 #include <linux/nbd.h>
  42
  43 struct nbd_device {
  44         u32 flags;
  45         struct socket * sock;   /* If == NULL, device is not ready, yet */
  46         int magic;
  47
  48         spinlock_t queue_lock;
  49         struct list_head queue_head;    /* Requests waiting result */
  50         struct request *active_req;
  51         wait_queue_head_t active_wq;
  52         struct list_head waiting_queue; /* Requests to be sent */
  53         wait_queue_head_t waiting_wq;
  54
  55         struct mutex tx_lock;
  56         struct gendisk *disk;
  57         int blksize;
  58         loff_t bytesize;
  59         int xmit_timeout;
  60         bool timedout;
  61         bool disconnect; /* a disconnect has been requested by user */
  62
  63         struct timer_list timeout_timer;
  64         /* protects initialization and shutdown of the socket */
  65         spinlock_t sock_lock;
  66         struct task_struct *task_recv;
  67         struct task_struct *task_send;
  68
  69 #if IS_ENABLED(CONFIG_DEBUG_FS)
  70         struct dentry *dbg_dir;
  71 #endif
  72 };
  73
  74 #if IS_ENABLED(CONFIG_DEBUG_FS)
  75 static struct dentry *nbd_dbg_dir;
  76 #endif
  77
  78 #define nbd_name(nbd) ((nbd)->disk->disk_name)
  79
  80 #define NBD_MAGIC 0x68797548
  81
  82 static unsigned int nbds_max = 16;
  83 static struct nbd_device *nbd_dev;
  84 static int max_part;
  85
  86 /*
  87  * Use just one lock (or at most 1 per NIC). Two arguments for this:
  88  * 1. Each NIC is essentially a synchronization point for all servers
  89  *    accessed through that NIC so there's no need to have more locks
  90  *    than NICs anyway.
  91  * 2. More locks lead to more "Dirty cache line bouncing" which will slow
  92  *    down each lock to the point where they're actually slower than just
  93  *    a single lock.
  94  * Thanks go to Jens Axboe and Al Viro for their LKML emails explaining this!
  95  */
  96 static DEFINE_SPINLOCK(nbd_lock);
  97
  98 static inline struct device *nbd_to_dev(struct nbd_device *nbd)
  99 {
 100         return disk_to_dev(nbd->disk);
 101 }
 102
 103 static bool nbd_is_connected(struct nbd_device *nbd)
 104 {
 105         return !!nbd->task_recv;
 106 }
 107
 108 static const char *nbdcmd_to_ascii(int cmd)
 109 {
 110         switch (cmd) {
 111         case  NBD_CMD_READ: return "read";
 112         case NBD_CMD_WRITE: return "write";
 113         case  NBD_CMD_DISC: return "disconnect";
 114         case NBD_CMD_FLUSH: return "flush";
 115         case  NBD_CMD_TRIM: return "trim/discard";
 116         }
 117         return "invalid";
 118 }
 119
 120 static int nbd_size_clear(struct nbd_device *nbd, struct block_device *bdev)
 121 {
 122         bdev->bd_inode->i_size = 0;
 123         set_capacity(nbd->disk, 0);
 124         kobject_uevent(&nbd_to_dev(nbd)->kobj, KOBJ_CHANGE);
 125
 126         return 0;
 127 }
 128
 129 static void nbd_size_update(struct nbd_device *nbd, struct block_device *bdev)
 130 {
 131         if (!nbd_is_connected(nbd))
 132                 return;
 133
 134         bdev->bd_inode->i_size = nbd->bytesize;
 135         set_capacity(nbd->disk, nbd->bytesize >> 9);
 136         kobject_uevent(&nbd_to_dev(nbd)->kobj, KOBJ_CHANGE);
 137 }
 138
 139 static int nbd_size_set(struct nbd_device *nbd, struct block_device *bdev,
 140                         int blocksize, int nr_blocks)
 141 {
 142         int ret;
 143
 144         ret = set_blocksize(bdev, blocksize);
 145         if (ret)
 146                 return ret;
 147
 148         nbd->blksize = blocksize;
 149         nbd->bytesize = (loff_t)blocksize * (loff_t)nr_blocks;
 150
 151         nbd_size_update(nbd, bdev);
 152
 153         return 0;
 154 }
 155
 156 static void nbd_end_request(struct nbd_device *nbd, struct request *req)
 157 {
 158         int error = req->errors ? -EIO : 0;
 159         struct request_queue *q = req->q;
 160         unsigned long flags;
 161
 162         dev_dbg(nbd_to_dev(nbd), "request %p: %s\n", req,
 163                 error ? "failed" : "done");
 164
 165         spin_lock_irqsave(q->queue_lock, flags);
 166         __blk_end_request_all(req, error);
 167         spin_unlock_irqrestore(q->queue_lock, flags);
 168 }
 169
 170 /*
 171  * Forcibly shutdown the socket causing all listeners to error
 172  */
 173 static void sock_shutdown(struct nbd_device *nbd)
 174 {
 175         spin_lock_irq(&nbd->sock_lock);
 176
 177         if (!nbd->sock) {
 178                 spin_unlock_irq(&nbd->sock_lock);
 179                 return;
 180         }
 181
 182         dev_warn(disk_to_dev(nbd->disk), "shutting down socket\n");
 183         kernel_sock_shutdown(nbd->sock, SHUT_RDWR);
 184         sockfd_put(nbd->sock);
 185         nbd->sock = NULL;
 186         spin_unlock_irq(&nbd->sock_lock);
 187
 188         del_timer(&nbd->timeout_timer);
 189 }
 190
 191 static void nbd_xmit_timeout(unsigned long arg)
 192 {
 193         struct nbd_device *nbd = (struct nbd_device *)arg;
 194         unsigned long flags;
 195
 196         if (list_empty(&nbd->queue_head))
 197                 return;
 198
 199         spin_lock_irqsave(&nbd->sock_lock, flags);
 200
 201         nbd->timedout = true;
 202
 203         if (nbd->sock)
 204                 kernel_sock_shutdown(nbd->sock, SHUT_RDWR);
 205
 206         spin_unlock_irqrestore(&nbd->sock_lock, flags);
 207
 208         dev_err(nbd_to_dev(nbd), "Connection timed out, shutting down connection\n");
 209 }
 210
 211 /*
 212  *  Send or receive packet.
 213  */
 214 static int sock_xmit(struct nbd_device *nbd, int send, void *buf, int size,
 215                 int msg_flags)
 216 {
 217         struct socket *sock = nbd->sock;
 218         int result;
 219         struct msghdr msg;
 220         struct kvec iov;
 221         unsigned long pflags = current->flags;
 222
 223         if (unlikely(!sock)) {
 224                 dev_err(disk_to_dev(nbd->disk),
 225                         "Attempted %s on closed socket in sock_xmit\n",
 226                         (send ? "send" : "recv"));
 227                 return -EINVAL;
 228         }
 229
 230         current->flags |= PF_MEMALLOC;
 231         do {
 232                 sock->sk->sk_allocation = GFP_NOIO | __GFP_MEMALLOC;
 233                 iov.iov_base = buf;
 234                 iov.iov_len = size;
 235                 msg.msg_name = NULL;
 236                 msg.msg_namelen = 0;
 237                 msg.msg_control = NULL;
 238                 msg.msg_controllen = 0;
 239                 msg.msg_flags = msg_flags | MSG_NOSIGNAL;
 240
 241                 if (send)
 242                         result = kernel_sendmsg(sock, &msg, &iov, 1, size);
 243                 else
 244                         result = kernel_recvmsg(sock, &msg, &iov, 1, size,
 245                                                 msg.msg_flags);
 246
 247                 if (result <= 0) {
 248                         if (result == 0)
 249                                 result = -EPIPE; /* short read */
 250                         break;
 251                 }
 252                 size -= result;
 253                 buf += result;
 254         } while (size > 0);
 255
 256         tsk_restore_flags(current, pflags, PF_MEMALLOC);
 257
 258         if (!send && nbd->xmit_timeout)
 259                 mod_timer(&nbd->timeout_timer, jiffies + nbd->xmit_timeout);
 260
 261         return result;
 262 }
 263
 264 static inline int sock_send_bvec(struct nbd_device *nbd, struct bio_vec *bvec,
 265                 int flags)
 266 {
 267         int result;
 268         void *kaddr = kmap(bvec->bv_page);
 269         result = sock_xmit(nbd, 1, kaddr + bvec->bv_offset,
 270                            bvec->bv_len, flags);
 271         kunmap(bvec->bv_page);
 272         return result;
 273 }
 274
 275 /* always call with the tx_lock held */
 276 static int nbd_send_req(struct nbd_device *nbd, struct request *req)
 277 {
 278         int result, flags;
 279         struct nbd_request request;
 280         unsigned long size = blk_rq_bytes(req);
 281         u32 type;
 282
 283         if (req->cmd_type == REQ_TYPE_DRV_PRIV)
 284                 type = NBD_CMD_DISC;
 285         else if (req_op(req) == REQ_OP_DISCARD)
 286                 type = NBD_CMD_TRIM;
 287         else if (req_op(req) == REQ_OP_FLUSH)
 288                 type = NBD_CMD_FLUSH;
 289         else if (rq_data_dir(req) == WRITE)
 290                 type = NBD_CMD_WRITE;
 291         else
 292                 type = NBD_CMD_READ;
 293
 294         memset(&request, 0, sizeof(request));
 295         request.magic = htonl(NBD_REQUEST_MAGIC);
 296         request.type = htonl(type);
 297         if (type != NBD_CMD_FLUSH && type != NBD_CMD_DISC) {
 298                 request.from = cpu_to_be64((u64)blk_rq_pos(req) << 9);
 299                 request.len = htonl(size);
 300         }
 301         memcpy(request.handle, &req, sizeof(req));
 302
 303         dev_dbg(nbd_to_dev(nbd), "request %p: sending control (%s@%llu,%uB)\n",
 304                 req, nbdcmd_to_ascii(type),
 305                 (unsigned long long)blk_rq_pos(req) << 9, blk_rq_bytes(req));
 306         result = sock_xmit(nbd, 1, &request, sizeof(request),
 307                         (type == NBD_CMD_WRITE) ? MSG_MORE : 0);
 308         if (result <= 0) {
 309                 dev_err(disk_to_dev(nbd->disk),
 310                         "Send control failed (result %d)\n", result);
 311                 return -EIO;
 312         }
 313
 314         if (type == NBD_CMD_WRITE) {
 315                 struct req_iterator iter;
 316                 struct bio_vec bvec;
 317                 /*
 318                  * we are really probing at internals to determine
 319                  * whether to set MSG_MORE or not...
 320                  */
 321                 rq_for_each_segment(bvec, req, iter) {
 322                         flags = 0;
 323                         if (!rq_iter_last(bvec, iter))
 324                                 flags = MSG_MORE;
 325                         dev_dbg(nbd_to_dev(nbd), "request %p: sending %d bytes data\n",
 326                                 req, bvec.bv_len);
 327                         result = sock_send_bvec(nbd, &bvec, flags);
 328                         if (result <= 0) {
 329                                 dev_err(disk_to_dev(nbd->disk),
 330                                         "Send data failed (result %d)\n",
 331                                         result);
 332                                 return -EIO;
 333                         }
 334                 }
 335         }
 336         return 0;
 337 }
 338
 339 static struct request *nbd_find_request(struct nbd_device *nbd,
 340                                         struct request *xreq)
 341 {
 342         struct request *req, *tmp;
 343         int err;
 344
 345         err = wait_event_interruptible(nbd->active_wq, nbd->active_req != xreq);
 346         if (unlikely(err))
 347                 return ERR_PTR(err);
 348
 349         spin_lock(&nbd->queue_lock);
 350         list_for_each_entry_safe(req, tmp, &nbd->queue_head, queuelist) {
 351                 if (req != xreq)
 352                         continue;
 353                 list_del_init(&req->queuelist);
 354                 spin_unlock(&nbd->queue_lock);
 355                 return req;
 356         }
 357         spin_unlock(&nbd->queue_lock);
 358
 359         return ERR_PTR(-ENOENT);
 360 }
 361
 362 static inline int sock_recv_bvec(struct nbd_device *nbd, struct bio_vec *bvec)
 363 {
 364         int result;
 365         void *kaddr = kmap(bvec->bv_page);
 366         result = sock_xmit(nbd, 0, kaddr + bvec->bv_offset, bvec->bv_len,
 367                         MSG_WAITALL);
 368         kunmap(bvec->bv_page);
 369         return result;
 370 }
 371
 372 /* NULL returned = something went wrong, inform userspace */
 373 static struct request *nbd_read_stat(struct nbd_device *nbd)
 374 {
 375         int result;
 376         struct nbd_reply reply;
 377         struct request *req;
 378
 379         reply.magic = 0;
 380         result = sock_xmit(nbd, 0, &reply, sizeof(reply), MSG_WAITALL);
 381         if (result <= 0) {
 382                 dev_err(disk_to_dev(nbd->disk),
 383                         "Receive control failed (result %d)\n", result);
 384                 return ERR_PTR(result);
 385         }
 386
 387         if (ntohl(reply.magic) != NBD_REPLY_MAGIC) {
 388                 dev_err(disk_to_dev(nbd->disk), "Wrong magic (0x%lx)\n",
 389                                 (unsigned long)ntohl(reply.magic));
 390                 return ERR_PTR(-EPROTO);
 391         }
 392
 393         req = nbd_find_request(nbd, *(struct request **)reply.handle);
 394         if (IS_ERR(req)) {
 395                 result = PTR_ERR(req);
 396                 if (result != -ENOENT)
 397                         return ERR_PTR(result);
 398
 399                 dev_err(disk_to_dev(nbd->disk), "Unexpected reply (%p)\n",
 400                         reply.handle);
 401                 return ERR_PTR(-EBADR);
 402         }
 403
 404         if (ntohl(reply.error)) {
 405                 dev_err(disk_to_dev(nbd->disk), "Other side returned error (%d)\n",
 406                         ntohl(reply.error));
 407                 req->errors++;
 408                 return req;
 409         }
 410
 411         dev_dbg(nbd_to_dev(nbd), "request %p: got reply\n", req);
 412         if (rq_data_dir(req) != WRITE) {
 413                 struct req_iterator iter;
 414                 struct bio_vec bvec;
 415
 416                 rq_for_each_segment(bvec, req, iter) {
 417                         result = sock_recv_bvec(nbd, &bvec);
 418                         if (result <= 0) {
 419                                 dev_err(disk_to_dev(nbd->disk), "Receive data failed (result %d)\n",
 420                                         result);
 421                                 req->errors++;
 422                                 return req;
 423                         }
 424                         dev_dbg(nbd_to_dev(nbd), "request %p: got %d bytes data\n",
 425                                 req, bvec.bv_len);
 426                 }
 427         }
 428         return req;
 429 }
 430
 431 static ssize_t pid_show(struct device *dev,
 432                         struct device_attribute *attr, char *buf)
 433 {
 434         struct gendisk *disk = dev_to_disk(dev);
 435         struct nbd_device *nbd = (struct nbd_device *)disk->private_data;
 436
 437         return sprintf(buf, "%d\n", task_pid_nr(nbd->task_recv));
 438 }
 439
 440 static struct device_attribute pid_attr = {
 441         .attr = { .name = "pid", .mode = S_IRUGO},
 442         .show = pid_show,
 443 };
 444
 445 static int nbd_thread_recv(struct nbd_device *nbd, struct block_device *bdev)
 446 {
 447         struct request *req;
 448         int ret;
 449
 450         BUG_ON(nbd->magic != NBD_MAGIC);
 451
 452         sk_set_memalloc(nbd->sock->sk);
 453
 454         ret = device_create_file(disk_to_dev(nbd->disk), &pid_attr);
 455         if (ret) {
 456                 dev_err(disk_to_dev(nbd->disk), "device_create_file failed!\n");
 457                 return ret;
 458         }
 459
 460         nbd_size_update(nbd, bdev);
 461
 462         while (1) {
 463                 req = nbd_read_stat(nbd);
 464                 if (IS_ERR(req)) {
 465                         ret = PTR_ERR(req);
 466                         break;
 467                 }
 468
 469                 nbd_end_request(nbd, req);
 470         }
 471
 472         nbd_size_clear(nbd, bdev);
 473
 474         device_remove_file(disk_to_dev(nbd->disk), &pid_attr);
 475         return ret;
 476 }
 477
 478 static void nbd_clear_que(struct nbd_device *nbd)
 479 {
 480         struct request *req;
 481
 482         BUG_ON(nbd->magic != NBD_MAGIC);
 483
 484         /*
 485          * Because we have set nbd->sock to NULL under the tx_lock, all
 486          * modifications to the list must have completed by now.  For
 487          * the same reason, the active_req must be NULL.
 488          *
 489          * As a consequence, we don't need to take the spin lock while
 490          * purging the list here.
 491          */
 492         BUG_ON(nbd->sock);
 493         BUG_ON(nbd->active_req);
 494
 495         while (!list_empty(&nbd->queue_head)) {
 496                 req = list_entry(nbd->queue_head.next, struct request,
 497                                  queuelist);
 498                 list_del_init(&req->queuelist);
 499                 req->errors++;
 500                 nbd_end_request(nbd, req);
 501         }
 502
 503         while (!list_empty(&nbd->waiting_queue)) {
 504                 req = list_entry(nbd->waiting_queue.next, struct request,
 505                                  queuelist);
 506                 list_del_init(&req->queuelist);
 507                 req->errors++;
 508                 nbd_end_request(nbd, req);
 509         }
 510         dev_dbg(disk_to_dev(nbd->disk), "queue cleared\n");
 511 }
 512
 513
 514 static void nbd_handle_req(struct nbd_device *nbd, struct request *req)
 515 {
 516         if (req->cmd_type != REQ_TYPE_FS)
 517                 goto error_out;
 518
 519         if (rq_data_dir(req) == WRITE &&
 520             (nbd->flags & NBD_FLAG_READ_ONLY)) {
 521                 dev_err(disk_to_dev(nbd->disk),
 522                         "Write on read-only\n");
 523                 goto error_out;
 524         }
 525
 526         req->errors = 0;
 527
 528         mutex_lock(&nbd->tx_lock);
 529         if (unlikely(!nbd->sock)) {
 530                 mutex_unlock(&nbd->tx_lock);
 531                 dev_err(disk_to_dev(nbd->disk),
 532                         "Attempted send on closed socket\n");
 533                 goto error_out;
 534         }
 535
 536         nbd->active_req = req;
 537
 538         if (nbd->xmit_timeout && list_empty_careful(&nbd->queue_head))
 539                 mod_timer(&nbd->timeout_timer, jiffies + nbd->xmit_timeout);
 540
 541         if (nbd_send_req(nbd, req) != 0) {
 542                 dev_err(disk_to_dev(nbd->disk), "Request send failed\n");
 543                 req->errors++;
 544                 nbd_end_request(nbd, req);
 545         } else {
 546                 spin_lock(&nbd->queue_lock);
 547                 list_add_tail(&req->queuelist, &nbd->queue_head);
 548                 spin_unlock(&nbd->queue_lock);
 549         }
 550
 551         nbd->active_req = NULL;
 552         mutex_unlock(&nbd->tx_lock);
 553         wake_up_all(&nbd->active_wq);
 554
 555         return;
 556
 557 error_out:
 558         req->errors++;
 559         nbd_end_request(nbd, req);
 560 }
 561
 562 static int nbd_thread_send(void *data)
 563 {
 564         struct nbd_device *nbd = data;
 565         struct request *req;
 566
 567         nbd->task_send = current;
 568
 569         set_user_nice(current, MIN_NICE);
 570         while (!kthread_should_stop() || !list_empty(&nbd->waiting_queue)) {
 571                 /* wait for something to do */
 572                 wait_event_interruptible(nbd->waiting_wq,
 573                                          kthread_should_stop() ||
 574                                          !list_empty(&nbd->waiting_queue));
 575
 576                 /* extract request */
 577                 if (list_empty(&nbd->waiting_queue))
 578                         continue;
 579
 580                 spin_lock_irq(&nbd->queue_lock);
 581                 req = list_entry(nbd->waiting_queue.next, struct request,
 582                                  queuelist);
 583                 list_del_init(&req->queuelist);
 584                 spin_unlock_irq(&nbd->queue_lock);
 585
 586                 /* handle request */
 587                 nbd_handle_req(nbd, req);
 588         }
 589
 590         nbd->task_send = NULL;
 591
 592         return 0;
 593 }
 594
 595 /*
 596  * We always wait for result of write, for now. It would be nice to make it optional
 597  * in future
 598  * if ((rq_data_dir(req) == WRITE) && (nbd->flags & NBD_WRITE_NOCHK))
 599  *   { printk( "Warning: Ignoring result!\n"); nbd_end_request( req ); }
 600  */
 601
 602 static void nbd_request_handler(struct request_queue *q)
 603                 __releases(q->queue_lock) __acquires(q->queue_lock)
 604 {
 605         struct request *req;
 606
 607         while ((req = blk_fetch_request(q)) != NULL) {
 608                 struct nbd_device *nbd;
 609
 610                 spin_unlock_irq(q->queue_lock);
 611
 612                 nbd = req->rq_disk->private_data;
 613
 614                 BUG_ON(nbd->magic != NBD_MAGIC);
 615
 616                 dev_dbg(nbd_to_dev(nbd), "request %p: dequeued (flags=%x)\n",
 617                         req, req->cmd_type);
 618
 619                 if (unlikely(!nbd->sock)) {
 620                         dev_err_ratelimited(disk_to_dev(nbd->disk),
 621                                             "Attempted send on closed socket\n");
 622                         req->errors++;
 623                         nbd_end_request(nbd, req);
 624                         spin_lock_irq(q->queue_lock);
 625                         continue;
 626                 }
 627
 628                 spin_lock_irq(&nbd->queue_lock);
 629                 list_add_tail(&req->queuelist, &nbd->waiting_queue);
 630                 spin_unlock_irq(&nbd->queue_lock);
 631
 632                 wake_up(&nbd->waiting_wq);
 633
 634                 spin_lock_irq(q->queue_lock);
 635         }
 636 }
 637
 638 static int nbd_set_socket(struct nbd_device *nbd, struct socket *sock)
 639 {
 640         int ret = 0;
 641
 642         spin_lock_irq(&nbd->sock_lock);
 643
 644         if (nbd->sock) {
 645                 ret = -EBUSY;
 646                 goto out;
 647         }
 648
 649         nbd->sock = sock;
 650
 651 out:
 652         spin_unlock_irq(&nbd->sock_lock);
 653
 654         return ret;
 655 }
 656
 657 /* Reset all properties of an NBD device */
 658 static void nbd_reset(struct nbd_device *nbd)
 659 {
 660         nbd->disconnect = false;
 661         nbd->timedout = false;
 662         nbd->blksize = 1024;
 663         nbd->bytesize = 0;
 664         set_capacity(nbd->disk, 0);
 665         nbd->flags = 0;
 666         nbd->xmit_timeout = 0;
 667         queue_flag_clear_unlocked(QUEUE_FLAG_DISCARD, nbd->disk->queue);
 668         del_timer_sync(&nbd->timeout_timer);
 669 }
 670
 671 static void nbd_bdev_reset(struct block_device *bdev)
 672 {
 673         set_device_ro(bdev, false);
 674         bdev->bd_inode->i_size = 0;
 675         if (max_part > 0) {
 676                 blkdev_reread_part(bdev);
 677                 bdev->bd_invalidated = 1;
 678         }
 679 }
 680
 681 static void nbd_parse_flags(struct nbd_device *nbd, struct block_device *bdev)
 682 {
 683         if (nbd->flags & NBD_FLAG_READ_ONLY)
 684                 set_device_ro(bdev, true);
 685         if (nbd->flags & NBD_FLAG_SEND_TRIM)
 686                 queue_flag_set_unlocked(QUEUE_FLAG_DISCARD, nbd->disk->queue);
 687         if (nbd->flags & NBD_FLAG_SEND_FLUSH)
 688                 blk_queue_write_cache(nbd->disk->queue, true, false);
 689         else
 690                 blk_queue_write_cache(nbd->disk->queue, false, false);
 691 }
 692
 693 static int nbd_dev_dbg_init(struct nbd_device *nbd);
 694 static void nbd_dev_dbg_close(struct nbd_device *nbd);
 695
 696 /* Must be called with tx_lock held */
 697
 698 static int __nbd_ioctl(struct block_device *bdev, struct nbd_device *nbd,
 699                        unsigned int cmd, unsigned long arg)
 700 {
 701         switch (cmd) {
 702         case NBD_DISCONNECT: {
 703                 struct request sreq;
 704
 705                 dev_info(disk_to_dev(nbd->disk), "NBD_DISCONNECT\n");
 706                 if (!nbd->sock)
 707                         return -EINVAL;
 708
 709                 mutex_unlock(&nbd->tx_lock);
 710                 fsync_bdev(bdev);
 711                 mutex_lock(&nbd->tx_lock);
 712                 blk_rq_init(NULL, &sreq);
 713                 sreq.cmd_type = REQ_TYPE_DRV_PRIV;
 714
 715                 /* Check again after getting mutex back.  */
 716                 if (!nbd->sock)
 717                         return -EINVAL;
 718
 719                 nbd->disconnect = true;
 720
 721                 nbd_send_req(nbd, &sreq);
 722                 return 0;
 723         }
 724
 725         case NBD_CLEAR_SOCK:
 726                 sock_shutdown(nbd);
 727                 nbd_clear_que(nbd);
 728                 BUG_ON(!list_empty(&nbd->queue_head));
 729                 BUG_ON(!list_empty(&nbd->waiting_queue));
 730                 kill_bdev(bdev);
 731                 return 0;
 732
 733         case NBD_SET_SOCK: {
 734                 int err;
 735                 struct socket *sock = sockfd_lookup(arg, &err);
 736
 737                 if (!sock)
 738                         return err;
 739
 740                 err = nbd_set_socket(nbd, sock);
 741                 if (!err && max_part)
 742                         bdev->bd_invalidated = 1;
 743
 744                 return err;
 745         }
 746
 747         case NBD_SET_BLKSIZE: {
 748                 loff_t bsize = div_s64(nbd->bytesize, arg);
 749
 750                 return nbd_size_set(nbd, bdev, arg, bsize);
 751         }
 752
 753         case NBD_SET_SIZE:
 754                 return nbd_size_set(nbd, bdev, nbd->blksize,
 755                                     arg / nbd->blksize);
 756
 757         case NBD_SET_SIZE_BLOCKS:
 758                 return nbd_size_set(nbd, bdev, nbd->blksize, arg);
 759
 760         case NBD_SET_TIMEOUT:
 761                 nbd->xmit_timeout = arg * HZ;
 762                 if (arg)
 763                         mod_timer(&nbd->timeout_timer,
 764                                   jiffies + nbd->xmit_timeout);
 765                 else
 766                         del_timer_sync(&nbd->timeout_timer);
 767
 768                 return 0;
 769
 770         case NBD_SET_FLAGS:
 771                 nbd->flags = arg;
 772                 return 0;
 773
 774         case NBD_DO_IT: {
 775                 struct task_struct *thread;
 776                 int error;
 777
 778                 if (nbd->task_recv)
 779                         return -EBUSY;
 780                 if (!nbd->sock)
 781                         return -EINVAL;
 782
 783                 /* We have to claim the device under the lock */
 784                 nbd->task_recv = current;
 785                 mutex_unlock(&nbd->tx_lock);
 786
 787                 nbd_parse_flags(nbd, bdev);
 788
 789                 thread = kthread_run(nbd_thread_send, nbd, "%s",
 790                                      nbd_name(nbd));
 791                 if (IS_ERR(thread)) {
 792                         mutex_lock(&nbd->tx_lock);
 793                         nbd->task_recv = NULL;
 794                         return PTR_ERR(thread);
 795                 }
 796
 797                 nbd_dev_dbg_init(nbd);
 798                 error = nbd_thread_recv(nbd, bdev);
 799                 nbd_dev_dbg_close(nbd);
 800                 kthread_stop(thread);
 801
 802                 mutex_lock(&nbd->tx_lock);
 803                 nbd->task_recv = NULL;
 804
 805                 sock_shutdown(nbd);
 806                 nbd_clear_que(nbd);
 807                 kill_bdev(bdev);
 808                 nbd_bdev_reset(bdev);
 809
 810                 if (nbd->disconnect) /* user requested, ignore socket errors */
 811                         error = 0;
 812                 if (nbd->timedout)
 813                         error = -ETIMEDOUT;
 814
 815                 nbd_reset(nbd);
 816
 817                 return error;
 818         }
 819
 820         case NBD_CLEAR_QUE:
 821                 /*
 822                  * This is for compatibility only.  The queue is always cleared
 823                  * by NBD_DO_IT or NBD_CLEAR_SOCK.
 824                  */
 825                 return 0;
 826
 827         case NBD_PRINT_DEBUG:
 828                 dev_info(disk_to_dev(nbd->disk),
 829                         "next = %p, prev = %p, head = %p\n",
 830                         nbd->queue_head.next, nbd->queue_head.prev,
 831                         &nbd->queue_head);
 832                 return 0;
 833         }
 834         return -ENOTTY;
 835 }
 836
 837 static int nbd_ioctl(struct block_device *bdev, fmode_t mode,
 838                      unsigned int cmd, unsigned long arg)
 839 {
 840         struct nbd_device *nbd = bdev->bd_disk->private_data;
 841         int error;
 842
 843         if (!capable(CAP_SYS_ADMIN))
 844                 return -EPERM;
 845
 846         BUG_ON(nbd->magic != NBD_MAGIC);
 847
 848         mutex_lock(&nbd->tx_lock);
 849         error = __nbd_ioctl(bdev, nbd, cmd, arg);
 850         mutex_unlock(&nbd->tx_lock);
 851
 852         return error;
 853 }
 854
 855 static const struct block_device_operations nbd_fops =
 856 {
 857         .owner =        THIS_MODULE,
 858         .ioctl =        nbd_ioctl,
 859         .compat_ioctl = nbd_ioctl,
 860 };
 861
 862 #if IS_ENABLED(CONFIG_DEBUG_FS)
 863
 864 static int nbd_dbg_tasks_show(struct seq_file *s, void *unused)
 865 {
 866         struct nbd_device *nbd = s->private;
 867
 868         if (nbd->task_recv)
 869                 seq_printf(s, "recv: %d\n", task_pid_nr(nbd->task_recv));
 870         if (nbd->task_send)
 871                 seq_printf(s, "send: %d\n", task_pid_nr(nbd->task_send));
 872
 873         return 0;
 874 }
 875
 876 static int nbd_dbg_tasks_open(struct inode *inode, struct file *file)
 877 {
 878         return single_open(file, nbd_dbg_tasks_show, inode->i_private);
 879 }
 880
 881 static const struct file_operations nbd_dbg_tasks_ops = {
 882         .open = nbd_dbg_tasks_open,
 883         .read = seq_read,
 884         .llseek = seq_lseek,
 885         .release = single_release,
 886 };
 887
 888 static int nbd_dbg_flags_show(struct seq_file *s, void *unused)
 889 {
 890         struct nbd_device *nbd = s->private;
 891         u32 flags = nbd->flags;
 892
 893         seq_printf(s, "Hex: 0x%08x\n\n", flags);
 894
 895         seq_puts(s, "Known flags:\n");
 896
 897         if (flags & NBD_FLAG_HAS_FLAGS)
 898                 seq_puts(s, "NBD_FLAG_HAS_FLAGS\n");
 899         if (flags & NBD_FLAG_READ_ONLY)
 900                 seq_puts(s, "NBD_FLAG_READ_ONLY\n");
 901         if (flags & NBD_FLAG_SEND_FLUSH)
 902                 seq_puts(s, "NBD_FLAG_SEND_FLUSH\n");
 903         if (flags & NBD_FLAG_SEND_TRIM)
 904                 seq_puts(s, "NBD_FLAG_SEND_TRIM\n");
 905
 906         return 0;
 907 }
 908
 909 static int nbd_dbg_flags_open(struct inode *inode, struct file *file)
 910 {
 911         return single_open(file, nbd_dbg_flags_show, inode->i_private);
 912 }
 913
 914 static const struct file_operations nbd_dbg_flags_ops = {
 915         .open = nbd_dbg_flags_open,
 916         .read = seq_read,
 917         .llseek = seq_lseek,
 918         .release = single_release,
 919 };
 920
 921 static int nbd_dev_dbg_init(struct nbd_device *nbd)
 922 {
 923         struct dentry *dir;
 924
 925         if (!nbd_dbg_dir)
 926                 return -EIO;
 927
 928         dir = debugfs_create_dir(nbd_name(nbd), nbd_dbg_dir);
 929         if (!dir) {
 930                 dev_err(nbd_to_dev(nbd), "Failed to create debugfs dir for '%s'\n",
 931                         nbd_name(nbd));
 932                 return -EIO;
 933         }
 934         nbd->dbg_dir = dir;
 935
 936         debugfs_create_file("tasks", 0444, dir, nbd, &nbd_dbg_tasks_ops);
 937         debugfs_create_u64("size_bytes", 0444, dir, &nbd->bytesize);
 938         debugfs_create_u32("timeout", 0444, dir, &nbd->xmit_timeout);
 939         debugfs_create_u32("blocksize", 0444, dir, &nbd->blksize);
 940         debugfs_create_file("flags", 0444, dir, nbd, &nbd_dbg_flags_ops);
 941
 942         return 0;
 943 }
 944
 945 static void nbd_dev_dbg_close(struct nbd_device *nbd)
 946 {
 947         debugfs_remove_recursive(nbd->dbg_dir);
 948 }
 949
 950 static int nbd_dbg_init(void)
 951 {
 952         struct dentry *dbg_dir;
 953
 954         dbg_dir = debugfs_create_dir("nbd", NULL);
 955         if (!dbg_dir)
 956                 return -EIO;
 957
 958         nbd_dbg_dir = dbg_dir;
 959
 960         return 0;
 961 }
 962
 963 static void nbd_dbg_close(void)
 964 {
 965         debugfs_remove_recursive(nbd_dbg_dir);
 966 }
 967
 968 #else  /* IS_ENABLED(CONFIG_DEBUG_FS) */
 969
 970 static int nbd_dev_dbg_init(struct nbd_device *nbd)
 971 {
 972         return 0;
 973 }
 974
 975 static void nbd_dev_dbg_close(struct nbd_device *nbd)
 976 {
 977 }
 978
 979 static int nbd_dbg_init(void)
 980 {
 981         return 0;
 982 }
 983
 984 static void nbd_dbg_close(void)
 985 {
 986 }
 987
 988 #endif
 989
 990 /*
 991  * And here should be modules and kernel interface
 992  *  (Just smiley confuses emacs :-)
 993  */
 994
 995 static int __init nbd_init(void)
 996 {
 997         int err = -ENOMEM;
 998         int i;
 999         int part_shift;
1000
1001         BUILD_BUG_ON(sizeof(struct nbd_request) != 28);
1002
1003         if (max_part < 0) {
1004                 printk(KERN_ERR "nbd: max_part must be >= 0\n");
1005                 return -EINVAL;
1006         }
1007
1008         part_shift = 0;
1009         if (max_part > 0) {
1010                 part_shift = fls(max_part);
1011
1012                 /*
1013                  * Adjust max_part according to part_shift as it is exported
1014                  * to user space so that user can know the max number of
1015                  * partition kernel should be able to manage.
1016                  *
1017                  * Note that -1 is required because partition 0 is reserved
1018                  * for the whole disk.
1019                  */
1020                 max_part = (1UL << part_shift) - 1;
1021         }
1022
1023         if ((1UL << part_shift) > DISK_MAX_PARTS)
1024                 return -EINVAL;
1025
1026         if (nbds_max > 1UL << (MINORBITS - part_shift))
1027                 return -EINVAL;
1028
1029         nbd_dev = kcalloc(nbds_max, sizeof(*nbd_dev), GFP_KERNEL);
1030         if (!nbd_dev)
1031                 return -ENOMEM;
1032
1033         for (i = 0; i < nbds_max; i++) {
1034                 struct gendisk *disk = alloc_disk(1 << part_shift);
1035                 if (!disk)
1036                         goto out;
1037                 nbd_dev[i].disk = disk;
1038                 /*
1039                  * The new linux 2.5 block layer implementation requires
1040                  * every gendisk to have its very own request_queue struct.
1041                  * These structs are big so we dynamically allocate them.
1042                  */
1043                 disk->queue = blk_init_queue(nbd_request_handler, &nbd_lock);
1044                 if (!disk->queue) {
1045                         put_disk(disk);
1046                         goto out;
1047                 }
1048                 /*
1049                  * Tell the block layer that we are not a rotational device
1050                  */
1051                 queue_flag_set_unlocked(QUEUE_FLAG_NONROT, disk->queue);
1052                 queue_flag_clear_unlocked(QUEUE_FLAG_ADD_RANDOM, disk->queue);
1053                 disk->queue->limits.discard_granularity = 512;
1054                 blk_queue_max_discard_sectors(disk->queue, UINT_MAX);
1055                 disk->queue->limits.discard_zeroes_data = 0;
1056                 blk_queue_max_hw_sectors(disk->queue, 65536);
1057                 disk->queue->limits.max_sectors = 256;
1058         }
1059
1060         if (register_blkdev(NBD_MAJOR, "nbd")) {
1061                 err = -EIO;
1062                 goto out;
1063         }
1064
1065         printk(KERN_INFO "nbd: registered device at major %d\n", NBD_MAJOR);
1066
1067         nbd_dbg_init();
1068
1069         for (i = 0; i < nbds_max; i++) {
1070                 struct gendisk *disk = nbd_dev[i].disk;
1071                 nbd_dev[i].magic = NBD_MAGIC;
1072                 INIT_LIST_HEAD(&nbd_dev[i].waiting_queue);
1073                 spin_lock_init(&nbd_dev[i].queue_lock);
1074                 spin_lock_init(&nbd_dev[i].sock_lock);
1075                 INIT_LIST_HEAD(&nbd_dev[i].queue_head);
1076                 mutex_init(&nbd_dev[i].tx_lock);
1077                 init_timer(&nbd_dev[i].timeout_timer);
1078                 nbd_dev[i].timeout_timer.function = nbd_xmit_timeout;
1079                 nbd_dev[i].timeout_timer.data = (unsigned long)&nbd_dev[i];
1080                 init_waitqueue_head(&nbd_dev[i].active_wq);
1081                 init_waitqueue_head(&nbd_dev[i].waiting_wq);
1082                 disk->major = NBD_MAJOR;
1083                 disk->first_minor = i << part_shift;
1084                 disk->fops = &nbd_fops;
1085                 disk->private_data = &nbd_dev[i];
1086                 sprintf(disk->disk_name, "nbd%d", i);
1087                 nbd_reset(&nbd_dev[i]);
1088                 add_disk(disk);
1089         }
1090
1091         return 0;
1092 out:
1093         while (i--) {
1094                 blk_cleanup_queue(nbd_dev[i].disk->queue);
1095                 put_disk(nbd_dev[i].disk);
1096         }
1097         kfree(nbd_dev);
1098         return err;
1099 }
1100
1101 static void __exit nbd_cleanup(void)
1102 {
1103         int i;
1104
1105         nbd_dbg_close();
1106
1107         for (i = 0; i < nbds_max; i++) {
1108                 struct gendisk *disk = nbd_dev[i].disk;
1109                 nbd_dev[i].magic = 0;
1110                 if (disk) {
1111                         del_gendisk(disk);
1112                         blk_cleanup_queue(disk->queue);
1113                         put_disk(disk);
1114                 }
1115         }
1116         unregister_blkdev(NBD_MAJOR, "nbd");
1117         kfree(nbd_dev);
1118         printk(KERN_INFO "nbd: unregistered device at major %d\n", NBD_MAJOR);
1119 }
1120
1121 module_init(nbd_init);
1122 module_exit(nbd_cleanup);
1123
1124 MODULE_DESCRIPTION("Network Block Device");
1125 MODULE_LICENSE("GPL");
1126
1127 module_param(nbds_max, int, 0444);
1128 MODULE_PARM_DESC(nbds_max, "number of network block devices to initialize (default: 16)");
1129 module_param(max_part, int, 0444);
1130 MODULE_PARM_DESC(max_part, "number of partitions per device (default: 0)");