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