block/bsg.c

   1 /*
   2  * bsg.c - block layer implementation of the sg v3 interface
   3  *
   4  * Copyright (C) 2004 Jens Axboe <axboe@suse.de> SUSE Labs
   5  * Copyright (C) 2004 Peter M. Jones <pjones@redhat.com>
   6  *
   7  *  This file is subject to the terms and conditions of the GNU General Public
   8  *  License version 2.  See the file "COPYING" in the main directory of this
   9  *  archive for more details.
  10  *
  11  */
  12 /*
  13  * TODO
  14  *      - Should this get merged, block/scsi_ioctl.c will be migrated into
  15  *        this file. To keep maintenance down, it's easier to have them
  16  *        seperated right now.
  17  *
  18  */
  19 #include <linux/module.h>
  20 #include <linux/init.h>
  21 #include <linux/file.h>
  22 #include <linux/blkdev.h>
  23 #include <linux/poll.h>
  24 #include <linux/cdev.h>
  25 #include <linux/percpu.h>
  26 #include <linux/uio.h>
  27 #include <linux/bsg.h>
  28
  29 #include <scsi/scsi.h>
  30 #include <scsi/scsi_ioctl.h>
  31 #include <scsi/scsi_cmnd.h>
  32 #include <scsi/scsi_device.h>
  33 #include <scsi/scsi_driver.h>
  34 #include <scsi/sg.h>
  35
  36 const static char bsg_version[] = "block layer sg (bsg) 0.4";
  37
  38 struct bsg_device {
  39         request_queue_t *queue;
  40         spinlock_t lock;
  41         struct list_head busy_list;
  42         struct list_head done_list;
  43         struct hlist_node dev_list;
  44         atomic_t ref_count;
  45         int minor;
  46         int queued_cmds;
  47         int done_cmds;
  48         wait_queue_head_t wq_done;
  49         wait_queue_head_t wq_free;
  50         char name[BUS_ID_SIZE];
  51         int max_queue;
  52         unsigned long flags;
  53 };
  54
  55 enum {
  56         BSG_F_BLOCK             = 1,
  57         BSG_F_WRITE_PERM        = 2,
  58 };
  59
  60 #define BSG_DEFAULT_CMDS        64
  61 #define BSG_MAX_DEVS            32768
  62
  63 #undef BSG_DEBUG
  64
  65 #ifdef BSG_DEBUG
  66 #define dprintk(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ##args)
  67 #else
  68 #define dprintk(fmt, args...)
  69 #endif
  70
  71 /*
  72  * just for testing
  73  */
  74 #define BSG_MAJOR       (240)
  75
  76 static DEFINE_MUTEX(bsg_mutex);
  77 static int bsg_device_nr, bsg_minor_idx;
  78
  79 #define BSG_LIST_ARRAY_SIZE     8
  80 #define bsg_list_idx(minor)     ((minor) & (BSG_LIST_ARRAY_SIZE - 1))
  81 static struct hlist_head bsg_device_list[BSG_LIST_ARRAY_SIZE];
  82
  83 static struct class *bsg_class;
  84 static LIST_HEAD(bsg_class_list);
  85
  86 static struct kmem_cache *bsg_cmd_cachep;
  87
  88 /*
  89  * our internal command type
  90  */
  91 struct bsg_command {
  92         struct bsg_device *bd;
  93         struct list_head list;
  94         struct request *rq;
  95         struct bio *bio;
  96         struct bio *bidi_bio;
  97         int err;
  98         struct sg_io_v4 hdr;
  99         struct sg_io_v4 __user *uhdr;
 100         char sense[SCSI_SENSE_BUFFERSIZE];
 101 };
 102
 103 static void bsg_free_command(struct bsg_command *bc)
 104 {
 105         struct bsg_device *bd = bc->bd;
 106         unsigned long flags;
 107
 108         kmem_cache_free(bsg_cmd_cachep, bc);
 109
 110         spin_lock_irqsave(&bd->lock, flags);
 111         bd->queued_cmds--;
 112         spin_unlock_irqrestore(&bd->lock, flags);
 113
 114         wake_up(&bd->wq_free);
 115 }
 116
 117 static struct bsg_command *bsg_alloc_command(struct bsg_device *bd)
 118 {
 119         struct bsg_command *bc = ERR_PTR(-EINVAL);
 120
 121         spin_lock_irq(&bd->lock);
 122
 123         if (bd->queued_cmds >= bd->max_queue)
 124                 goto out;
 125
 126         bd->queued_cmds++;
 127         spin_unlock_irq(&bd->lock);
 128
 129         bc = kmem_cache_zalloc(bsg_cmd_cachep, GFP_KERNEL);
 130         if (unlikely(!bc)) {
 131                 spin_lock_irq(&bd->lock);
 132                 bd->queued_cmds--;
 133                 bc = ERR_PTR(-ENOMEM);
 134                 goto out;
 135         }
 136
 137         bc->bd = bd;
 138         INIT_LIST_HEAD(&bc->list);
 139         dprintk("%s: returning free cmd %p\n", bd->name, bc);
 140         return bc;
 141 out:
 142         spin_unlock_irq(&bd->lock);
 143         return bc;
 144 }
 145
 146 static inline void
 147 bsg_add_done_cmd(struct bsg_device *bd, struct bsg_command *bc)
 148 {
 149 }
 150
 151 static int bsg_io_schedule(struct bsg_device *bd)
 152 {
 153         DEFINE_WAIT(wait);
 154         int ret = 0;
 155
 156         spin_lock_irq(&bd->lock);
 157
 158         BUG_ON(bd->done_cmds > bd->queued_cmds);
 159
 160         /*
 161          * -ENOSPC or -ENODATA?  I'm going for -ENODATA, meaning "I have no
 162          * work to do", even though we return -ENOSPC after this same test
 163          * during bsg_write() -- there, it means our buffer can't have more
 164          * bsg_commands added to it, thus has no space left.
 165          */
 166         if (bd->done_cmds == bd->queued_cmds) {
 167                 ret = -ENODATA;
 168                 goto unlock;
 169         }
 170
 171         if (!test_bit(BSG_F_BLOCK, &bd->flags)) {
 172                 ret = -EAGAIN;
 173                 goto unlock;
 174         }
 175
 176         prepare_to_wait(&bd->wq_done, &wait, TASK_UNINTERRUPTIBLE);
 177         spin_unlock_irq(&bd->lock);
 178         io_schedule();
 179         finish_wait(&bd->wq_done, &wait);
 180
 181         return ret;
 182 unlock:
 183         spin_unlock_irq(&bd->lock);
 184         return ret;
 185 }
 186
 187 static int blk_fill_sgv4_hdr_rq(request_queue_t *q, struct request *rq,
 188                                 struct sg_io_v4 *hdr, int has_write_perm)
 189 {
 190         memset(rq->cmd, 0, BLK_MAX_CDB); /* ATAPI hates garbage after CDB */
 191
 192         if (copy_from_user(rq->cmd, (void *)(unsigned long)hdr->request,
 193                            hdr->request_len))
 194                 return -EFAULT;
 195
 196         if (hdr->subprotocol == BSG_SUB_PROTOCOL_SCSI_CMD) {
 197                 if (blk_verify_command(rq->cmd, has_write_perm))
 198                         return -EPERM;
 199         } else if (!capable(CAP_SYS_RAWIO))
 200                 return -EPERM;
 201
 202         /*
 203          * fill in request structure
 204          */
 205         rq->cmd_len = hdr->request_len;
 206         rq->cmd_type = REQ_TYPE_BLOCK_PC;
 207
 208         rq->timeout = (hdr->timeout * HZ) / 1000;
 209         if (!rq->timeout)
 210                 rq->timeout = q->sg_timeout;
 211         if (!rq->timeout)
 212                 rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
 213
 214         return 0;
 215 }
 216
 217 /*
 218  * Check if sg_io_v4 from user is allowed and valid
 219  */
 220 static int
 221 bsg_validate_sgv4_hdr(request_queue_t *q, struct sg_io_v4 *hdr, int *rw)
 222 {
 223         int ret = 0;
 224
 225         if (hdr->guard != 'Q')
 226                 return -EINVAL;
 227         if (hdr->request_len > BLK_MAX_CDB)
 228                 return -EINVAL;
 229         if (hdr->dout_xfer_len > (q->max_sectors << 9) ||
 230             hdr->din_xfer_len > (q->max_sectors << 9))
 231                 return -EIO;
 232
 233         switch (hdr->protocol) {
 234         case BSG_PROTOCOL_SCSI:
 235                 switch (hdr->subprotocol) {
 236                 case BSG_SUB_PROTOCOL_SCSI_CMD:
 237                 case BSG_SUB_PROTOCOL_SCSI_TRANSPORT:
 238                         break;
 239                 default:
 240                         ret = -EINVAL;
 241                 }
 242                 break;
 243         default:
 244                 ret = -EINVAL;
 245         }
 246
 247         *rw = hdr->dout_xfer_len ? WRITE : READ;
 248         return ret;
 249 }
 250
 251 /*
 252  * map sg_io_v4 to a request.
 253  */
 254 static struct request *
 255 bsg_map_hdr(struct bsg_device *bd, struct sg_io_v4 *hdr)
 256 {
 257         request_queue_t *q = bd->queue;
 258         struct request *rq, *next_rq = NULL;
 259         int ret, rw;
 260         unsigned int dxfer_len;
 261         void *dxferp = NULL;
 262
 263         dprintk("map hdr %llx/%u %llx/%u\n", (unsigned long long) hdr->dout_xferp,
 264                 hdr->dout_xfer_len, (unsigned long long) hdr->din_xferp,
 265                 hdr->din_xfer_len);
 266
 267         ret = bsg_validate_sgv4_hdr(q, hdr, &rw);
 268         if (ret)
 269                 return ERR_PTR(ret);
 270
 271         /*
 272          * map scatter-gather elements seperately and string them to request
 273          */
 274         rq = blk_get_request(q, rw, GFP_KERNEL);
 275         if (!rq)
 276                 return ERR_PTR(-ENOMEM);
 277         ret = blk_fill_sgv4_hdr_rq(q, rq, hdr, test_bit(BSG_F_WRITE_PERM,
 278                                                        &bd->flags));
 279         if (ret)
 280                 goto out;
 281
 282         if (rw == WRITE && hdr->din_xfer_len) {
 283                 if (!test_bit(QUEUE_FLAG_BIDI, &q->queue_flags)) {
 284                         ret = -EOPNOTSUPP;
 285                         goto out;
 286                 }
 287
 288                 next_rq = blk_get_request(q, READ, GFP_KERNEL);
 289                 if (!next_rq) {
 290                         ret = -ENOMEM;
 291                         goto out;
 292                 }
 293                 rq->next_rq = next_rq;
 294
 295                 dxferp = (void*)(unsigned long)hdr->din_xferp;
 296                 ret =  blk_rq_map_user(q, next_rq, dxferp, hdr->din_xfer_len);
 297                 if (ret)
 298                         goto out;
 299         }
 300
 301         if (hdr->dout_xfer_len) {
 302                 dxfer_len = hdr->dout_xfer_len;
 303                 dxferp = (void*)(unsigned long)hdr->dout_xferp;
 304         } else if (hdr->din_xfer_len) {
 305                 dxfer_len = hdr->din_xfer_len;
 306                 dxferp = (void*)(unsigned long)hdr->din_xferp;
 307         } else
 308                 dxfer_len = 0;
 309
 310         if (dxfer_len) {
 311                 ret = blk_rq_map_user(q, rq, dxferp, dxfer_len);
 312                 if (ret)
 313                         goto out;
 314         }
 315         return rq;
 316 out:
 317         blk_put_request(rq);
 318         if (next_rq) {
 319                 blk_rq_unmap_user(next_rq->bio);
 320                 blk_put_request(next_rq);
 321         }
 322         return ERR_PTR(ret);
 323 }
 324
 325 /*
 326  * async completion call-back from the block layer, when scsi/ide/whatever
 327  * calls end_that_request_last() on a request
 328  */
 329 static void bsg_rq_end_io(struct request *rq, int uptodate)
 330 {
 331         struct bsg_command *bc = rq->end_io_data;
 332         struct bsg_device *bd = bc->bd;
 333         unsigned long flags;
 334
 335         dprintk("%s: finished rq %p bc %p, bio %p stat %d\n",
 336                 bd->name, rq, bc, bc->bio, uptodate);
 337
 338         bc->hdr.duration = jiffies_to_msecs(jiffies - bc->hdr.duration);
 339
 340         spin_lock_irqsave(&bd->lock, flags);
 341         list_move_tail(&bc->list, &bd->done_list);
 342         bd->done_cmds++;
 343         spin_unlock_irqrestore(&bd->lock, flags);
 344
 345         wake_up(&bd->wq_done);
 346 }
 347
 348 /*
 349  * do final setup of a 'bc' and submit the matching 'rq' to the block
 350  * layer for io
 351  */
 352 static void bsg_add_command(struct bsg_device *bd, request_queue_t *q,
 353                             struct bsg_command *bc, struct request *rq)
 354 {
 355         rq->sense = bc->sense;
 356         rq->sense_len = 0;
 357
 358         /*
 359          * add bc command to busy queue and submit rq for io
 360          */
 361         bc->rq = rq;
 362         bc->bio = rq->bio;
 363         if (rq->next_rq)
 364                 bc->bidi_bio = rq->next_rq->bio;
 365         bc->hdr.duration = jiffies;
 366         spin_lock_irq(&bd->lock);
 367         list_add_tail(&bc->list, &bd->busy_list);
 368         spin_unlock_irq(&bd->lock);
 369
 370         dprintk("%s: queueing rq %p, bc %p\n", bd->name, rq, bc);
 371
 372         rq->end_io_data = bc;
 373         blk_execute_rq_nowait(q, NULL, rq, 1, bsg_rq_end_io);
 374 }
 375
 376 static struct bsg_command *bsg_next_done_cmd(struct bsg_device *bd)
 377 {
 378         struct bsg_command *bc = NULL;
 379
 380         spin_lock_irq(&bd->lock);
 381         if (bd->done_cmds) {
 382                 bc = list_entry(bd->done_list.next, struct bsg_command, list);
 383                 list_del(&bc->list);
 384                 bd->done_cmds--;
 385         }
 386         spin_unlock_irq(&bd->lock);
 387
 388         return bc;
 389 }
 390
 391 /*
 392  * Get a finished command from the done list
 393  */
 394 static struct bsg_command *bsg_get_done_cmd(struct bsg_device *bd)
 395 {
 396         struct bsg_command *bc;
 397         int ret;
 398
 399         do {
 400                 bc = bsg_next_done_cmd(bd);
 401                 if (bc)
 402                         break;
 403
 404                 if (!test_bit(BSG_F_BLOCK, &bd->flags)) {
 405                         bc = ERR_PTR(-EAGAIN);
 406                         break;
 407                 }
 408
 409                 ret = wait_event_interruptible(bd->wq_done, bd->done_cmds);
 410                 if (ret) {
 411                         bc = ERR_PTR(-ERESTARTSYS);
 412                         break;
 413                 }
 414         } while (1);
 415
 416         dprintk("%s: returning done %p\n", bd->name, bc);
 417
 418         return bc;
 419 }
 420
 421 static int blk_complete_sgv4_hdr_rq(struct request *rq, struct sg_io_v4 *hdr,
 422                                     struct bio *bio, struct bio *bidi_bio)
 423 {
 424         int ret = 0;
 425
 426         dprintk("rq %p bio %p %u\n", rq, bio, rq->errors);
 427         /*
 428          * fill in all the output members
 429          */
 430         hdr->device_status = status_byte(rq->errors);
 431         hdr->transport_status = host_byte(rq->errors);
 432         hdr->driver_status = driver_byte(rq->errors);
 433         hdr->info = 0;
 434         if (hdr->device_status || hdr->transport_status || hdr->driver_status)
 435                 hdr->info |= SG_INFO_CHECK;
 436         hdr->din_resid = rq->data_len;
 437         hdr->response_len = 0;
 438
 439         if (rq->sense_len && hdr->response) {
 440                 int len = min_t(unsigned int, hdr->max_response_len,
 441                                         rq->sense_len);
 442
 443                 ret = copy_to_user((void*)(unsigned long)hdr->response,
 444                                    rq->sense, len);
 445                 if (!ret)
 446                         hdr->response_len = len;
 447                 else
 448                         ret = -EFAULT;
 449         }
 450
 451         if (rq->next_rq) {
 452                 blk_rq_unmap_user(bidi_bio);
 453                 blk_put_request(rq->next_rq);
 454         }
 455
 456         blk_rq_unmap_user(bio);
 457         blk_put_request(rq);
 458
 459         return ret;
 460 }
 461
 462 static int bsg_complete_all_commands(struct bsg_device *bd)
 463 {
 464         struct bsg_command *bc;
 465         int ret, tret;
 466
 467         dprintk("%s: entered\n", bd->name);
 468
 469         set_bit(BSG_F_BLOCK, &bd->flags);
 470
 471         /*
 472          * wait for all commands to complete
 473          */
 474         ret = 0;
 475         do {
 476                 ret = bsg_io_schedule(bd);
 477                 /*
 478                  * look for -ENODATA specifically -- we'll sometimes get
 479                  * -ERESTARTSYS when we've taken a signal, but we can't
 480                  * return until we're done freeing the queue, so ignore
 481                  * it.  The signal will get handled when we're done freeing
 482                  * the bsg_device.
 483                  */
 484         } while (ret != -ENODATA);
 485
 486         /*
 487          * discard done commands
 488          */
 489         ret = 0;
 490         do {
 491                 spin_lock_irq(&bd->lock);
 492                 if (!bd->queued_cmds) {
 493                         spin_unlock_irq(&bd->lock);
 494                         break;
 495                 }
 496                 spin_unlock_irq(&bd->lock);
 497
 498                 bc = bsg_get_done_cmd(bd);
 499                 if (IS_ERR(bc))
 500                         break;
 501
 502                 tret = blk_complete_sgv4_hdr_rq(bc->rq, &bc->hdr, bc->bio,
 503                                                 bc->bidi_bio);
 504                 if (!ret)
 505                         ret = tret;
 506
 507                 bsg_free_command(bc);
 508         } while (1);
 509
 510         return ret;
 511 }
 512
 513 static int
 514 __bsg_read(char __user *buf, size_t count, struct bsg_device *bd,
 515            const struct iovec *iov, ssize_t *bytes_read)
 516 {
 517         struct bsg_command *bc;
 518         int nr_commands, ret;
 519
 520         if (count % sizeof(struct sg_io_v4))
 521                 return -EINVAL;
 522
 523         ret = 0;
 524         nr_commands = count / sizeof(struct sg_io_v4);
 525         while (nr_commands) {
 526                 bc = bsg_get_done_cmd(bd);
 527                 if (IS_ERR(bc)) {
 528                         ret = PTR_ERR(bc);
 529                         break;
 530                 }
 531
 532                 /*
 533                  * this is the only case where we need to copy data back
 534                  * after completing the request. so do that here,
 535                  * bsg_complete_work() cannot do that for us
 536                  */
 537                 ret = blk_complete_sgv4_hdr_rq(bc->rq, &bc->hdr, bc->bio,
 538                                                bc->bidi_bio);
 539
 540                 if (copy_to_user(buf, &bc->hdr, sizeof(bc->hdr)))
 541                         ret = -EFAULT;
 542
 543                 bsg_free_command(bc);
 544
 545                 if (ret)
 546                         break;
 547
 548                 buf += sizeof(struct sg_io_v4);
 549                 *bytes_read += sizeof(struct sg_io_v4);
 550                 nr_commands--;
 551         }
 552
 553         return ret;
 554 }
 555
 556 static inline void bsg_set_block(struct bsg_device *bd, struct file *file)
 557 {
 558         if (file->f_flags & O_NONBLOCK)
 559                 clear_bit(BSG_F_BLOCK, &bd->flags);
 560         else
 561                 set_bit(BSG_F_BLOCK, &bd->flags);
 562 }
 563
 564 static inline void bsg_set_write_perm(struct bsg_device *bd, struct file *file)
 565 {
 566         if (file->f_mode & FMODE_WRITE)
 567                 set_bit(BSG_F_WRITE_PERM, &bd->flags);
 568         else
 569                 clear_bit(BSG_F_WRITE_PERM, &bd->flags);
 570 }
 571
 572 /*
 573  * Check if the error is a "real" error that we should return.
 574  */
 575 static inline int err_block_err(int ret)
 576 {
 577         if (ret && ret != -ENOSPC && ret != -ENODATA && ret != -EAGAIN)
 578                 return 1;
 579
 580         return 0;
 581 }
 582
 583 static ssize_t
 584 bsg_read(struct file *file, char __user *buf, size_t count, loff_t *ppos)
 585 {
 586         struct bsg_device *bd = file->private_data;
 587         int ret;
 588         ssize_t bytes_read;
 589
 590         dprintk("%s: read %Zd bytes\n", bd->name, count);
 591
 592         bsg_set_block(bd, file);
 593         bytes_read = 0;
 594         ret = __bsg_read(buf, count, bd, NULL, &bytes_read);
 595         *ppos = bytes_read;
 596
 597         if (!bytes_read || (bytes_read && err_block_err(ret)))
 598                 bytes_read = ret;
 599
 600         return bytes_read;
 601 }
 602
 603 static int __bsg_write(struct bsg_device *bd, const char __user *buf,
 604                        size_t count, ssize_t *bytes_written)
 605 {
 606         struct bsg_command *bc;
 607         struct request *rq;
 608         int ret, nr_commands;
 609
 610         if (count % sizeof(struct sg_io_v4))
 611                 return -EINVAL;
 612
 613         nr_commands = count / sizeof(struct sg_io_v4);
 614         rq = NULL;
 615         bc = NULL;
 616         ret = 0;
 617         while (nr_commands) {
 618                 request_queue_t *q = bd->queue;
 619
 620                 bc = bsg_alloc_command(bd);
 621                 if (IS_ERR(bc)) {
 622                         ret = PTR_ERR(bc);
 623                         bc = NULL;
 624                         break;
 625                 }
 626
 627                 bc->uhdr = (struct sg_io_v4 __user *) buf;
 628                 if (copy_from_user(&bc->hdr, buf, sizeof(bc->hdr))) {
 629                         ret = -EFAULT;
 630                         break;
 631                 }
 632
 633                 /*
 634                  * get a request, fill in the blanks, and add to request queue
 635                  */
 636                 rq = bsg_map_hdr(bd, &bc->hdr);
 637                 if (IS_ERR(rq)) {
 638                         ret = PTR_ERR(rq);
 639                         rq = NULL;
 640                         break;
 641                 }
 642
 643                 bsg_add_command(bd, q, bc, rq);
 644                 bc = NULL;
 645                 rq = NULL;
 646                 nr_commands--;
 647                 buf += sizeof(struct sg_io_v4);
 648                 *bytes_written += sizeof(struct sg_io_v4);
 649         }
 650
 651         if (bc)
 652                 bsg_free_command(bc);
 653
 654         return ret;
 655 }
 656
 657 static ssize_t
 658 bsg_write(struct file *file, const char __user *buf, size_t count, loff_t *ppos)
 659 {
 660         struct bsg_device *bd = file->private_data;
 661         ssize_t bytes_written;
 662         int ret;
 663
 664         dprintk("%s: write %Zd bytes\n", bd->name, count);
 665
 666         bsg_set_block(bd, file);
 667         bsg_set_write_perm(bd, file);
 668
 669         bytes_written = 0;
 670         ret = __bsg_write(bd, buf, count, &bytes_written);
 671         *ppos = bytes_written;
 672
 673         /*
 674          * return bytes written on non-fatal errors
 675          */
 676         if (!bytes_written || (bytes_written && err_block_err(ret)))
 677                 bytes_written = ret;
 678
 679         dprintk("%s: returning %Zd\n", bd->name, bytes_written);
 680         return bytes_written;
 681 }
 682
 683 static struct bsg_device *bsg_alloc_device(void)
 684 {
 685         struct bsg_device *bd;
 686
 687         bd = kzalloc(sizeof(struct bsg_device), GFP_KERNEL);
 688         if (unlikely(!bd))
 689                 return NULL;
 690
 691         spin_lock_init(&bd->lock);
 692
 693         bd->max_queue = BSG_DEFAULT_CMDS;
 694
 695         INIT_LIST_HEAD(&bd->busy_list);
 696         INIT_LIST_HEAD(&bd->done_list);
 697         INIT_HLIST_NODE(&bd->dev_list);
 698
 699         init_waitqueue_head(&bd->wq_free);
 700         init_waitqueue_head(&bd->wq_done);
 701         return bd;
 702 }
 703
 704 static int bsg_put_device(struct bsg_device *bd)
 705 {
 706         int ret = 0;
 707
 708         mutex_lock(&bsg_mutex);
 709
 710         if (!atomic_dec_and_test(&bd->ref_count))
 711                 goto out;
 712
 713         dprintk("%s: tearing down\n", bd->name);
 714
 715         /*
 716          * close can always block
 717          */
 718         set_bit(BSG_F_BLOCK, &bd->flags);
 719
 720         /*
 721          * correct error detection baddies here again. it's the responsibility
 722          * of the app to properly reap commands before close() if it wants
 723          * fool-proof error detection
 724          */
 725         ret = bsg_complete_all_commands(bd);
 726
 727         blk_put_queue(bd->queue);
 728         hlist_del(&bd->dev_list);
 729         kfree(bd);
 730 out:
 731         mutex_unlock(&bsg_mutex);
 732         return ret;
 733 }
 734
 735 static struct bsg_device *bsg_add_device(struct inode *inode,
 736                                          struct request_queue *rq,
 737                                          struct file *file)
 738 {
 739         struct bsg_device *bd;
 740 #ifdef BSG_DEBUG
 741         unsigned char buf[32];
 742 #endif
 743
 744         bd = bsg_alloc_device();
 745         if (!bd)
 746                 return ERR_PTR(-ENOMEM);
 747
 748         bd->queue = rq;
 749         kobject_get(&rq->kobj);
 750         bsg_set_block(bd, file);
 751
 752         atomic_set(&bd->ref_count, 1);
 753         bd->minor = iminor(inode);
 754         mutex_lock(&bsg_mutex);
 755         hlist_add_head(&bd->dev_list,
 756                 &bsg_device_list[bd->minor & (BSG_LIST_ARRAY_SIZE - 1)]);
 757
 758         strncpy(bd->name, rq->bsg_dev.class_dev->class_id, sizeof(bd->name) - 1);
 759         dprintk("bound to <%s>, max queue %d\n",
 760                 format_dev_t(buf, inode->i_rdev), bd->max_queue);
 761
 762         mutex_unlock(&bsg_mutex);
 763         return bd;
 764 }
 765
 766 static struct bsg_device *__bsg_get_device(int minor)
 767 {
 768         struct hlist_head *list;
 769         struct bsg_device *bd = NULL;
 770         struct hlist_node *entry;
 771
 772         mutex_lock(&bsg_mutex);
 773
 774         list = &bsg_device_list[minor & (BSG_LIST_ARRAY_SIZE - 1)];
 775         hlist_for_each(entry, list) {
 776                 bd = hlist_entry(entry, struct bsg_device, dev_list);
 777                 if (bd->minor == minor) {
 778                         atomic_inc(&bd->ref_count);
 779                         break;
 780                 }
 781
 782                 bd = NULL;
 783         }
 784
 785         mutex_unlock(&bsg_mutex);
 786         return bd;
 787 }
 788
 789 static struct bsg_device *bsg_get_device(struct inode *inode, struct file *file)
 790 {
 791         struct bsg_device *bd = __bsg_get_device(iminor(inode));
 792         struct bsg_class_device *bcd, *__bcd;
 793
 794         if (bd)
 795                 return bd;
 796
 797         /*
 798          * find the class device
 799          */
 800         bcd = NULL;
 801         mutex_lock(&bsg_mutex);
 802         list_for_each_entry(__bcd, &bsg_class_list, list) {
 803                 if (__bcd->minor == iminor(inode)) {
 804                         bcd = __bcd;
 805                         break;
 806                 }
 807         }
 808         mutex_unlock(&bsg_mutex);
 809
 810         if (!bcd)
 811                 return ERR_PTR(-ENODEV);
 812
 813         return bsg_add_device(inode, bcd->queue, file);
 814 }
 815
 816 static int bsg_open(struct inode *inode, struct file *file)
 817 {
 818         struct bsg_device *bd = bsg_get_device(inode, file);
 819
 820         if (IS_ERR(bd))
 821                 return PTR_ERR(bd);
 822
 823         file->private_data = bd;
 824         return 0;
 825 }
 826
 827 static int bsg_release(struct inode *inode, struct file *file)
 828 {
 829         struct bsg_device *bd = file->private_data;
 830
 831         file->private_data = NULL;
 832         return bsg_put_device(bd);
 833 }
 834
 835 static unsigned int bsg_poll(struct file *file, poll_table *wait)
 836 {
 837         struct bsg_device *bd = file->private_data;
 838         unsigned int mask = 0;
 839
 840         poll_wait(file, &bd->wq_done, wait);
 841         poll_wait(file, &bd->wq_free, wait);
 842
 843         spin_lock_irq(&bd->lock);
 844         if (!list_empty(&bd->done_list))
 845                 mask |= POLLIN | POLLRDNORM;
 846         if (bd->queued_cmds >= bd->max_queue)
 847                 mask |= POLLOUT;
 848         spin_unlock_irq(&bd->lock);
 849
 850         return mask;
 851 }
 852
 853 static long bsg_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
 854 {
 855         struct bsg_device *bd = file->private_data;
 856         int __user *uarg = (int __user *) arg;
 857
 858         switch (cmd) {
 859                 /*
 860                  * our own ioctls
 861                  */
 862         case SG_GET_COMMAND_Q:
 863                 return put_user(bd->max_queue, uarg);
 864         case SG_SET_COMMAND_Q: {
 865                 int queue;
 866
 867                 if (get_user(queue, uarg))
 868                         return -EFAULT;
 869                 if (queue < 1)
 870                         return -EINVAL;
 871
 872                 spin_lock_irq(&bd->lock);
 873                 bd->max_queue = queue;
 874                 spin_unlock_irq(&bd->lock);
 875                 return 0;
 876         }
 877
 878         /*
 879          * SCSI/sg ioctls
 880          */
 881         case SG_GET_VERSION_NUM:
 882         case SCSI_IOCTL_GET_IDLUN:
 883         case SCSI_IOCTL_GET_BUS_NUMBER:
 884         case SG_SET_TIMEOUT:
 885         case SG_GET_TIMEOUT:
 886         case SG_GET_RESERVED_SIZE:
 887         case SG_SET_RESERVED_SIZE:
 888         case SG_EMULATED_HOST:
 889         case SCSI_IOCTL_SEND_COMMAND: {
 890                 void __user *uarg = (void __user *) arg;
 891                 return scsi_cmd_ioctl(file, bd->queue, NULL, cmd, uarg);
 892         }
 893         case SG_IO: {
 894                 struct request *rq;
 895                 struct bio *bio, *bidi_bio = NULL;
 896                 struct sg_io_v4 hdr;
 897
 898                 if (copy_from_user(&hdr, uarg, sizeof(hdr)))
 899                         return -EFAULT;
 900
 901                 rq = bsg_map_hdr(bd, &hdr);
 902                 if (IS_ERR(rq))
 903                         return PTR_ERR(rq);
 904
 905                 bio = rq->bio;
 906                 if (rq->next_rq)
 907                         bidi_bio = rq->next_rq->bio;
 908                 blk_execute_rq(bd->queue, NULL, rq, 0);
 909                 blk_complete_sgv4_hdr_rq(rq, &hdr, bio, bidi_bio);
 910
 911                 if (copy_to_user(uarg, &hdr, sizeof(hdr)))
 912                         return -EFAULT;
 913
 914                 return 0;
 915         }
 916         /*
 917          * block device ioctls
 918          */
 919         default:
 920 #if 0
 921                 return ioctl_by_bdev(bd->bdev, cmd, arg);
 922 #else
 923                 return -ENOTTY;
 924 #endif
 925         }
 926 }
 927
 928 static struct file_operations bsg_fops = {
 929         .read           =       bsg_read,
 930         .write          =       bsg_write,
 931         .poll           =       bsg_poll,
 932         .open           =       bsg_open,
 933         .release        =       bsg_release,
 934         .unlocked_ioctl =       bsg_ioctl,
 935         .owner          =       THIS_MODULE,
 936 };
 937
 938 void bsg_unregister_queue(struct request_queue *q)
 939 {
 940         struct bsg_class_device *bcd = &q->bsg_dev;
 941
 942         WARN_ON(!bcd->class_dev);
 943
 944         mutex_lock(&bsg_mutex);
 945         sysfs_remove_link(&q->kobj, "bsg");
 946         class_device_destroy(bsg_class, MKDEV(BSG_MAJOR, bcd->minor));
 947         bcd->class_dev = NULL;
 948         list_del_init(&bcd->list);
 949         bsg_device_nr--;
 950         mutex_unlock(&bsg_mutex);
 951 }
 952 EXPORT_SYMBOL_GPL(bsg_unregister_queue);
 953
 954 int bsg_register_queue(struct request_queue *q, const char *name)
 955 {
 956         struct bsg_class_device *bcd, *__bcd;
 957         dev_t dev;
 958         int ret = -EMFILE;
 959         struct class_device *class_dev = NULL;
 960
 961         /*
 962          * we need a proper transport to send commands, not a stacked device
 963          */
 964         if (!q->request_fn)
 965                 return 0;
 966
 967         bcd = &q->bsg_dev;
 968         memset(bcd, 0, sizeof(*bcd));
 969         INIT_LIST_HEAD(&bcd->list);
 970
 971         mutex_lock(&bsg_mutex);
 972         if (bsg_device_nr == BSG_MAX_DEVS) {
 973                 printk(KERN_ERR "bsg: too many bsg devices\n");
 974                 goto err;
 975         }
 976
 977 retry:
 978         list_for_each_entry(__bcd, &bsg_class_list, list) {
 979                 if (__bcd->minor == bsg_minor_idx) {
 980                         bsg_minor_idx++;
 981                         if (bsg_minor_idx == BSG_MAX_DEVS)
 982                                 bsg_minor_idx = 0;
 983                         goto retry;
 984                 }
 985         }
 986
 987         bcd->minor = bsg_minor_idx++;
 988         if (bsg_minor_idx == BSG_MAX_DEVS)
 989                 bsg_minor_idx = 0;
 990
 991         bcd->queue = q;
 992         dev = MKDEV(BSG_MAJOR, bcd->minor);
 993         class_dev = class_device_create(bsg_class, NULL, dev, bcd->dev, "%s", name);
 994         if (IS_ERR(class_dev)) {
 995                 ret = PTR_ERR(class_dev);
 996                 goto err;
 997         }
 998         bcd->class_dev = class_dev;
 999
1000         if (q->kobj.sd) {
1001                 ret = sysfs_create_link(&q->kobj, &bcd->class_dev->kobj, "bsg");
1002                 if (ret)
1003                         goto err;
1004         }
1005
1006         list_add_tail(&bcd->list, &bsg_class_list);
1007         bsg_device_nr++;
1008
1009         mutex_unlock(&bsg_mutex);
1010         return 0;
1011 err:
1012         if (class_dev)
1013                 class_device_destroy(bsg_class, MKDEV(BSG_MAJOR, bcd->minor));
1014         mutex_unlock(&bsg_mutex);
1015         return ret;
1016 }
1017 EXPORT_SYMBOL_GPL(bsg_register_queue);
1018
1019 static int bsg_add(struct class_device *cl_dev, struct class_interface *cl_intf)
1020 {
1021         int ret;
1022         struct scsi_device *sdp = to_scsi_device(cl_dev->dev);
1023         struct request_queue *rq = sdp->request_queue;
1024
1025         if (rq->kobj.parent)
1026                 ret = bsg_register_queue(rq, kobject_name(rq->kobj.parent));
1027         else
1028                 ret = bsg_register_queue(rq, kobject_name(&sdp->sdev_gendev.kobj));
1029         return ret;
1030 }
1031
1032 static void bsg_remove(struct class_device *cl_dev, struct class_interface *cl_intf)
1033 {
1034         bsg_unregister_queue(to_scsi_device(cl_dev->dev)->request_queue);
1035 }
1036
1037 static struct class_interface bsg_intf = {
1038         .add    = bsg_add,
1039         .remove = bsg_remove,
1040 };
1041
1042 static struct cdev bsg_cdev = {
1043         .kobj   = {.name = "bsg", },
1044         .owner  = THIS_MODULE,
1045 };
1046
1047 static int __init bsg_init(void)
1048 {
1049         int ret, i;
1050
1051         bsg_cmd_cachep = kmem_cache_create("bsg_cmd",
1052                                 sizeof(struct bsg_command), 0, 0, NULL, NULL);
1053         if (!bsg_cmd_cachep) {
1054                 printk(KERN_ERR "bsg: failed creating slab cache\n");
1055                 return -ENOMEM;
1056         }
1057
1058         for (i = 0; i < BSG_LIST_ARRAY_SIZE; i++)
1059                 INIT_HLIST_HEAD(&bsg_device_list[i]);
1060
1061         bsg_class = class_create(THIS_MODULE, "bsg");
1062         if (IS_ERR(bsg_class)) {
1063                 kmem_cache_destroy(bsg_cmd_cachep);
1064                 return PTR_ERR(bsg_class);
1065         }
1066
1067         ret = register_chrdev_region(MKDEV(BSG_MAJOR, 0), BSG_MAX_DEVS, "bsg");
1068         if (ret) {
1069                 kmem_cache_destroy(bsg_cmd_cachep);
1070                 class_destroy(bsg_class);
1071                 return ret;
1072         }
1073
1074         cdev_init(&bsg_cdev, &bsg_fops);
1075         ret = cdev_add(&bsg_cdev, MKDEV(BSG_MAJOR, 0), BSG_MAX_DEVS);
1076         if (ret) {
1077                 kmem_cache_destroy(bsg_cmd_cachep);
1078                 class_destroy(bsg_class);
1079                 unregister_chrdev_region(MKDEV(BSG_MAJOR, 0), BSG_MAX_DEVS);
1080                 return ret;
1081         }
1082
1083         ret = scsi_register_interface(&bsg_intf);
1084         if (ret) {
1085                 printk(KERN_ERR "bsg: failed register scsi interface %d\n", ret);
1086                 kmem_cache_destroy(bsg_cmd_cachep);
1087                 class_destroy(bsg_class);
1088                 unregister_chrdev(BSG_MAJOR, "bsg");
1089                 return ret;
1090         }
1091
1092         printk(KERN_INFO "%s loaded\n", bsg_version);
1093         return 0;
1094 }
1095
1096 MODULE_AUTHOR("Jens Axboe");
1097 MODULE_DESCRIPTION("Block layer SGSI generic (sg) driver");
1098 MODULE_LICENSE("GPL");
1099
1100 device_initcall(bsg_init);