drivers/block/scsi_ioctl.c

   1 /*
   2  * Copyright (C) 2001 Jens Axboe <axboe@suse.de>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License version 2 as
   6  * published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  *
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public Licens
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-
  17  *
  18  */
  19 #include <linux/kernel.h>
  20 #include <linux/errno.h>
  21 #include <linux/string.h>
  22 #include <linux/module.h>
  23 #include <linux/blkdev.h>
  24 #include <linux/completion.h>
  25 #include <linux/cdrom.h>
  26 #include <linux/slab.h>
  27 #include <linux/times.h>
  28 #include <asm/uaccess.h>
  29
  30 #include <scsi/scsi.h>
  31 #include <scsi/scsi_ioctl.h>
  32 #include <scsi/scsi_cmnd.h>
  33
  34 /* Command group 3 is reserved and should never be used.  */
  35 const unsigned char scsi_command_size[8] =
  36 {
  37         6, 10, 10, 12,
  38         16, 12, 10, 10
  39 };
  40
  41 EXPORT_SYMBOL(scsi_command_size);
  42
  43 #define BLK_DEFAULT_TIMEOUT     (60 * HZ)
  44
  45 #include <scsi/sg.h>
  46
  47 static int sg_get_version(int __user *p)
  48 {
  49         static int sg_version_num = 30527;
  50         return put_user(sg_version_num, p);
  51 }
  52
  53 static int scsi_get_idlun(request_queue_t *q, int __user *p)
  54 {
  55         return put_user(0, p);
  56 }
  57
  58 static int scsi_get_bus(request_queue_t *q, int __user *p)
  59 {
  60         return put_user(0, p);
  61 }
  62
  63 static int sg_get_timeout(request_queue_t *q)
  64 {
  65         return q->sg_timeout / (HZ / USER_HZ);
  66 }
  67
  68 static int sg_set_timeout(request_queue_t *q, int __user *p)
  69 {
  70         int timeout, err = get_user(timeout, p);
  71
  72         if (!err)
  73                 q->sg_timeout = timeout * (HZ / USER_HZ);
  74
  75         return err;
  76 }
  77
  78 static int sg_get_reserved_size(request_queue_t *q, int __user *p)
  79 {
  80         return put_user(q->sg_reserved_size, p);
  81 }
  82
  83 static int sg_set_reserved_size(request_queue_t *q, int __user *p)
  84 {
  85         int size, err = get_user(size, p);
  86
  87         if (err)
  88                 return err;
  89
  90         if (size < 0)
  91                 return -EINVAL;
  92         if (size > (q->max_sectors << 9))
  93                 size = q->max_sectors << 9;
  94
  95         q->sg_reserved_size = size;
  96         return 0;
  97 }
  98
  99 /*
 100  * will always return that we are ATAPI even for a real SCSI drive, I'm not
 101  * so sure this is worth doing anything about (why would you care??)
 102  */
 103 static int sg_emulated_host(request_queue_t *q, int __user *p)
 104 {
 105         return put_user(1, p);
 106 }
 107
 108 #define CMD_READ_SAFE   0x01
 109 #define CMD_WRITE_SAFE  0x02
 110 #define CMD_WARNED      0x04
 111 #define safe_for_read(cmd)      [cmd] = CMD_READ_SAFE
 112 #define safe_for_write(cmd)     [cmd] = CMD_WRITE_SAFE
 113
 114 static int verify_command(struct file *file, unsigned char *cmd)
 115 {
 116         static unsigned char cmd_type[256] = {
 117
 118                 /* Basic read-only commands */
 119                 safe_for_read(TEST_UNIT_READY),
 120                 safe_for_read(REQUEST_SENSE),
 121                 safe_for_read(READ_6),
 122                 safe_for_read(READ_10),
 123                 safe_for_read(READ_12),
 124                 safe_for_read(READ_16),
 125                 safe_for_read(READ_BUFFER),
 126                 safe_for_read(READ_LONG),
 127                 safe_for_read(INQUIRY),
 128                 safe_for_read(MODE_SENSE),
 129                 safe_for_read(MODE_SENSE_10),
 130                 safe_for_read(LOG_SENSE),
 131                 safe_for_read(START_STOP),
 132                 safe_for_read(GPCMD_VERIFY_10),
 133                 safe_for_read(VERIFY_16),
 134
 135                 /* Audio CD commands */
 136                 safe_for_read(GPCMD_PLAY_CD),
 137                 safe_for_read(GPCMD_PLAY_AUDIO_10),
 138                 safe_for_read(GPCMD_PLAY_AUDIO_MSF),
 139                 safe_for_read(GPCMD_PLAY_AUDIO_TI),
 140                 safe_for_read(GPCMD_PAUSE_RESUME),
 141
 142                 /* CD/DVD data reading */
 143                 safe_for_read(GPCMD_READ_BUFFER_CAPACITY),
 144                 safe_for_read(GPCMD_READ_CD),
 145                 safe_for_read(GPCMD_READ_CD_MSF),
 146                 safe_for_read(GPCMD_READ_DISC_INFO),
 147                 safe_for_read(GPCMD_READ_CDVD_CAPACITY),
 148                 safe_for_read(GPCMD_READ_DVD_STRUCTURE),
 149                 safe_for_read(GPCMD_READ_HEADER),
 150                 safe_for_read(GPCMD_READ_TRACK_RZONE_INFO),
 151                 safe_for_read(GPCMD_READ_SUBCHANNEL),
 152                 safe_for_read(GPCMD_READ_TOC_PMA_ATIP),
 153                 safe_for_read(GPCMD_REPORT_KEY),
 154                 safe_for_read(GPCMD_SCAN),
 155                 safe_for_read(GPCMD_GET_CONFIGURATION),
 156                 safe_for_read(GPCMD_READ_FORMAT_CAPACITIES),
 157                 safe_for_read(GPCMD_GET_EVENT_STATUS_NOTIFICATION),
 158                 safe_for_read(GPCMD_GET_PERFORMANCE),
 159                 safe_for_read(GPCMD_SEEK),
 160                 safe_for_read(GPCMD_STOP_PLAY_SCAN),
 161
 162                 /* Basic writing commands */
 163                 safe_for_write(WRITE_6),
 164                 safe_for_write(WRITE_10),
 165                 safe_for_write(WRITE_VERIFY),
 166                 safe_for_write(WRITE_12),
 167                 safe_for_write(WRITE_VERIFY_12),
 168                 safe_for_write(WRITE_16),
 169                 safe_for_write(WRITE_LONG),
 170                 safe_for_write(ERASE),
 171                 safe_for_write(GPCMD_MODE_SELECT_10),
 172                 safe_for_write(MODE_SELECT),
 173                 safe_for_write(LOG_SELECT),
 174                 safe_for_write(GPCMD_BLANK),
 175                 safe_for_write(GPCMD_CLOSE_TRACK),
 176                 safe_for_write(GPCMD_FLUSH_CACHE),
 177                 safe_for_write(GPCMD_FORMAT_UNIT),
 178                 safe_for_write(GPCMD_REPAIR_RZONE_TRACK),
 179                 safe_for_write(GPCMD_RESERVE_RZONE_TRACK),
 180                 safe_for_write(GPCMD_SEND_DVD_STRUCTURE),
 181                 safe_for_write(GPCMD_SEND_EVENT),
 182                 safe_for_write(GPCMD_SEND_KEY),
 183                 safe_for_write(GPCMD_SEND_OPC),
 184                 safe_for_write(GPCMD_SEND_CUE_SHEET),
 185                 safe_for_write(GPCMD_SET_SPEED),
 186                 safe_for_write(GPCMD_PREVENT_ALLOW_MEDIUM_REMOVAL),
 187                 safe_for_write(GPCMD_LOAD_UNLOAD),
 188                 safe_for_write(GPCMD_SET_STREAMING),
 189         };
 190         unsigned char type = cmd_type[cmd[0]];
 191
 192         /* Anybody who can open the device can do a read-safe command */
 193         if (type & CMD_READ_SAFE)
 194                 return 0;
 195
 196         /* Write-safe commands just require a writable open.. */
 197         if (type & CMD_WRITE_SAFE) {
 198                 if (file->f_mode & FMODE_WRITE)
 199                         return 0;
 200         }
 201
 202         if (!type) {
 203                 cmd_type[cmd[0]] = CMD_WARNED;
 204                 printk(KERN_WARNING "scsi: unknown opcode 0x%02x\n", cmd[0]);
 205         }
 206
 207         /* And root can do any command.. */
 208         if (capable(CAP_SYS_RAWIO))
 209                 return 0;
 210
 211         /* Otherwise fail it with an "Operation not permitted" */
 212         return -EPERM;
 213 }
 214
 215 static int sg_io(struct file *file, request_queue_t *q,
 216                 struct gendisk *bd_disk, struct sg_io_hdr *hdr)
 217 {
 218         unsigned long start_time;
 219         int writing = 0, ret = 0;
 220         struct request *rq;
 221         struct bio *bio;
 222         char sense[SCSI_SENSE_BUFFERSIZE];
 223         unsigned char cmd[BLK_MAX_CDB];
 224
 225         if (hdr->interface_id != 'S')
 226                 return -EINVAL;
 227         if (hdr->cmd_len > BLK_MAX_CDB)
 228                 return -EINVAL;
 229         if (copy_from_user(cmd, hdr->cmdp, hdr->cmd_len))
 230                 return -EFAULT;
 231         if (verify_command(file, cmd))
 232                 return -EPERM;
 233
 234         if (hdr->dxfer_len > (q->max_sectors << 9))
 235                 return -EIO;
 236
 237         if (hdr->dxfer_len)
 238                 switch (hdr->dxfer_direction) {
 239                 default:
 240                         return -EINVAL;
 241                 case SG_DXFER_TO_FROM_DEV:
 242                 case SG_DXFER_TO_DEV:
 243                         writing = 1;
 244                         break;
 245                 case SG_DXFER_FROM_DEV:
 246                         break;
 247                 }
 248
 249         rq = blk_get_request(q, writing ? WRITE : READ, GFP_KERNEL);
 250         if (!rq)
 251                 return -ENOMEM;
 252
 253         if (hdr->iovec_count) {
 254                 const int size = sizeof(struct sg_iovec) * hdr->iovec_count;
 255                 struct sg_iovec *iov;
 256
 257                 iov = kmalloc(size, GFP_KERNEL);
 258                 if (!iov) {
 259                         ret = -ENOMEM;
 260                         goto out;
 261                 }
 262
 263                 if (copy_from_user(iov, hdr->dxferp, size)) {
 264                         kfree(iov);
 265                         ret = -EFAULT;
 266                         goto out;
 267                 }
 268
 269                 ret = blk_rq_map_user_iov(q, rq, iov, hdr->iovec_count);
 270                 kfree(iov);
 271         } else if (hdr->dxfer_len)
 272                 ret = blk_rq_map_user(q, rq, hdr->dxferp, hdr->dxfer_len);
 273
 274         if (ret)
 275                 goto out;
 276
 277         /*
 278          * fill in request structure
 279          */
 280         rq->cmd_len = hdr->cmd_len;
 281         memcpy(rq->cmd, cmd, hdr->cmd_len);
 282         if (sizeof(rq->cmd) != hdr->cmd_len)
 283                 memset(rq->cmd + hdr->cmd_len, 0, sizeof(rq->cmd) - hdr->cmd_len);
 284
 285         memset(sense, 0, sizeof(sense));
 286         rq->sense = sense;
 287         rq->sense_len = 0;
 288
 289         rq->flags |= REQ_BLOCK_PC;
 290         bio = rq->bio;
 291
 292         /*
 293          * bounce this after holding a reference to the original bio, it's
 294          * needed for proper unmapping
 295          */
 296         if (rq->bio)
 297                 blk_queue_bounce(q, &rq->bio);
 298
 299         rq->timeout = (hdr->timeout * HZ) / 1000;
 300         if (!rq->timeout)
 301                 rq->timeout = q->sg_timeout;
 302         if (!rq->timeout)
 303                 rq->timeout = BLK_DEFAULT_TIMEOUT;
 304
 305         start_time = jiffies;
 306
 307         /* ignore return value. All information is passed back to caller
 308          * (if he doesn't check that is his problem).
 309          * N.B. a non-zero SCSI status is _not_ necessarily an error.
 310          */
 311         blk_execute_rq(q, bd_disk, rq, 0);
 312
 313         /* write to all output members */
 314         hdr->status = 0xff & rq->errors;
 315         hdr->masked_status = status_byte(rq->errors);
 316         hdr->msg_status = msg_byte(rq->errors);
 317         hdr->host_status = host_byte(rq->errors);
 318         hdr->driver_status = driver_byte(rq->errors);
 319         hdr->info = 0;
 320         if (hdr->masked_status || hdr->host_status || hdr->driver_status)
 321                 hdr->info |= SG_INFO_CHECK;
 322         hdr->resid = rq->data_len;
 323         hdr->duration = ((jiffies - start_time) * 1000) / HZ;
 324         hdr->sb_len_wr = 0;
 325
 326         if (rq->sense_len && hdr->sbp) {
 327                 int len = min((unsigned int) hdr->mx_sb_len, rq->sense_len);
 328
 329                 if (!copy_to_user(hdr->sbp, rq->sense, len))
 330                         hdr->sb_len_wr = len;
 331         }
 332
 333         if (blk_rq_unmap_user(bio, hdr->dxfer_len))
 334                 ret = -EFAULT;
 335
 336         /* may not have succeeded, but output values written to control
 337          * structure (struct sg_io_hdr).  */
 338 out:
 339         blk_put_request(rq);
 340         return ret;
 341 }
 342
 343 #define OMAX_SB_LEN 16          /* For backward compatibility */
 344
 345 static int sg_scsi_ioctl(struct file *file, request_queue_t *q,
 346                          struct gendisk *bd_disk, Scsi_Ioctl_Command __user *sic)
 347 {
 348         struct request *rq;
 349         int err;
 350         unsigned int in_len, out_len, bytes, opcode, cmdlen;
 351         char *buffer = NULL, sense[SCSI_SENSE_BUFFERSIZE];
 352
 353         /*
 354          * get in an out lengths, verify they don't exceed a page worth of data
 355          */
 356         if (get_user(in_len, &sic->inlen))
 357                 return -EFAULT;
 358         if (get_user(out_len, &sic->outlen))
 359                 return -EFAULT;
 360         if (in_len > PAGE_SIZE || out_len > PAGE_SIZE)
 361                 return -EINVAL;
 362         if (get_user(opcode, sic->data))
 363                 return -EFAULT;
 364
 365         bytes = max(in_len, out_len);
 366         if (bytes) {
 367                 buffer = kmalloc(bytes, q->bounce_gfp | GFP_USER| __GFP_NOWARN);
 368                 if (!buffer)
 369                         return -ENOMEM;
 370
 371                 memset(buffer, 0, bytes);
 372         }
 373
 374         rq = blk_get_request(q, in_len ? WRITE : READ, __GFP_WAIT);
 375
 376         cmdlen = COMMAND_SIZE(opcode);
 377
 378         /*
 379          * get command and data to send to device, if any
 380          */
 381         err = -EFAULT;
 382         rq->cmd_len = cmdlen;
 383         if (copy_from_user(rq->cmd, sic->data, cmdlen))
 384                 goto error;
 385
 386         if (copy_from_user(buffer, sic->data + cmdlen, in_len))
 387                 goto error;
 388
 389         err = verify_command(file, rq->cmd);
 390         if (err)
 391                 goto error;
 392
 393         switch (opcode) {
 394                 case SEND_DIAGNOSTIC:
 395                 case FORMAT_UNIT:
 396                         rq->timeout = FORMAT_UNIT_TIMEOUT;
 397                         break;
 398                 case START_STOP:
 399                         rq->timeout = START_STOP_TIMEOUT;
 400                         break;
 401                 case MOVE_MEDIUM:
 402                         rq->timeout = MOVE_MEDIUM_TIMEOUT;
 403                         break;
 404                 case READ_ELEMENT_STATUS:
 405                         rq->timeout = READ_ELEMENT_STATUS_TIMEOUT;
 406                         break;
 407                 case READ_DEFECT_DATA:
 408                         rq->timeout = READ_DEFECT_DATA_TIMEOUT;
 409                         break;
 410                 default:
 411                         rq->timeout = BLK_DEFAULT_TIMEOUT;
 412                         break;
 413         }
 414
 415         memset(sense, 0, sizeof(sense));
 416         rq->sense = sense;
 417         rq->sense_len = 0;
 418
 419         rq->data = buffer;
 420         rq->data_len = bytes;
 421         rq->flags |= REQ_BLOCK_PC;
 422
 423         blk_execute_rq(q, bd_disk, rq, 0);
 424         err = rq->errors & 0xff;        /* only 8 bit SCSI status */
 425         if (err) {
 426                 if (rq->sense_len && rq->sense) {
 427                         bytes = (OMAX_SB_LEN > rq->sense_len) ?
 428                                 rq->sense_len : OMAX_SB_LEN;
 429                         if (copy_to_user(sic->data, rq->sense, bytes))
 430                                 err = -EFAULT;
 431                 }
 432         } else {
 433                 if (copy_to_user(sic->data, buffer, out_len))
 434                         err = -EFAULT;
 435         }
 436
 437 error:
 438         kfree(buffer);
 439         blk_put_request(rq);
 440         return err;
 441 }
 442
 443 int scsi_cmd_ioctl(struct file *file, struct gendisk *bd_disk, unsigned int cmd, void __user *arg)
 444 {
 445         request_queue_t *q;
 446         struct request *rq;
 447         int close = 0, err;
 448
 449         q = bd_disk->queue;
 450         if (!q)
 451                 return -ENXIO;
 452
 453         if (blk_get_queue(q))
 454                 return -ENXIO;
 455
 456         switch (cmd) {
 457                 /*
 458                  * new sgv3 interface
 459                  */
 460                 case SG_GET_VERSION_NUM:
 461                         err = sg_get_version(arg);
 462                         break;
 463                 case SCSI_IOCTL_GET_IDLUN:
 464                         err = scsi_get_idlun(q, arg);
 465                         break;
 466                 case SCSI_IOCTL_GET_BUS_NUMBER:
 467                         err = scsi_get_bus(q, arg);
 468                         break;
 469                 case SG_SET_TIMEOUT:
 470                         err = sg_set_timeout(q, arg);
 471                         break;
 472                 case SG_GET_TIMEOUT:
 473                         err = sg_get_timeout(q);
 474                         break;
 475                 case SG_GET_RESERVED_SIZE:
 476                         err = sg_get_reserved_size(q, arg);
 477                         break;
 478                 case SG_SET_RESERVED_SIZE:
 479                         err = sg_set_reserved_size(q, arg);
 480                         break;
 481                 case SG_EMULATED_HOST:
 482                         err = sg_emulated_host(q, arg);
 483                         break;
 484                 case SG_IO: {
 485                         struct sg_io_hdr hdr;
 486
 487                         err = -EFAULT;
 488                         if (copy_from_user(&hdr, arg, sizeof(hdr)))
 489                                 break;
 490                         err = sg_io(file, q, bd_disk, &hdr);
 491                         if (err == -EFAULT)
 492                                 break;
 493
 494                         if (copy_to_user(arg, &hdr, sizeof(hdr)))
 495                                 err = -EFAULT;
 496                         break;
 497                 }
 498                 case CDROM_SEND_PACKET: {
 499                         struct cdrom_generic_command cgc;
 500                         struct sg_io_hdr hdr;
 501
 502                         err = -EFAULT;
 503                         if (copy_from_user(&cgc, arg, sizeof(cgc)))
 504                                 break;
 505                         cgc.timeout = clock_t_to_jiffies(cgc.timeout);
 506                         memset(&hdr, 0, sizeof(hdr));
 507                         hdr.interface_id = 'S';
 508                         hdr.cmd_len = sizeof(cgc.cmd);
 509                         hdr.dxfer_len = cgc.buflen;
 510                         err = 0;
 511                         switch (cgc.data_direction) {
 512                                 case CGC_DATA_UNKNOWN:
 513                                         hdr.dxfer_direction = SG_DXFER_UNKNOWN;
 514                                         break;
 515                                 case CGC_DATA_WRITE:
 516                                         hdr.dxfer_direction = SG_DXFER_TO_DEV;
 517                                         break;
 518                                 case CGC_DATA_READ:
 519                                         hdr.dxfer_direction = SG_DXFER_FROM_DEV;
 520                                         break;
 521                                 case CGC_DATA_NONE:
 522                                         hdr.dxfer_direction = SG_DXFER_NONE;
 523                                         break;
 524                                 default:
 525                                         err = -EINVAL;
 526                         }
 527                         if (err)
 528                                 break;
 529
 530                         hdr.dxferp = cgc.buffer;
 531                         hdr.sbp = cgc.sense;
 532                         if (hdr.sbp)
 533                                 hdr.mx_sb_len = sizeof(struct request_sense);
 534                         hdr.timeout = cgc.timeout;
 535                         hdr.cmdp = ((struct cdrom_generic_command __user*) arg)->cmd;
 536                         hdr.cmd_len = sizeof(cgc.cmd);
 537
 538                         err = sg_io(file, q, bd_disk, &hdr);
 539                         if (err == -EFAULT)
 540                                 break;
 541
 542                         if (hdr.status)
 543                                 err = -EIO;
 544
 545                         cgc.stat = err;
 546                         cgc.buflen = hdr.resid;
 547                         if (copy_to_user(arg, &cgc, sizeof(cgc)))
 548                                 err = -EFAULT;
 549
 550                         break;
 551                 }
 552
 553                 /*
 554                  * old junk scsi send command ioctl
 555                  */
 556                 case SCSI_IOCTL_SEND_COMMAND:
 557                         printk(KERN_WARNING "program %s is using a deprecated SCSI ioctl, please convert it to SG_IO\n", current->comm);
 558                         err = -EINVAL;
 559                         if (!arg)
 560                                 break;
 561
 562                         err = sg_scsi_ioctl(file, q, bd_disk, arg);
 563                         break;
 564                 case CDROMCLOSETRAY:
 565                         close = 1;
 566                 case CDROMEJECT:
 567                         rq = blk_get_request(q, WRITE, __GFP_WAIT);
 568                         rq->flags |= REQ_BLOCK_PC;
 569                         rq->data = NULL;
 570                         rq->data_len = 0;
 571                         rq->timeout = BLK_DEFAULT_TIMEOUT;
 572                         memset(rq->cmd, 0, sizeof(rq->cmd));
 573                         rq->cmd[0] = GPCMD_START_STOP_UNIT;
 574                         rq->cmd[4] = 0x02 + (close != 0);
 575                         rq->cmd_len = 6;
 576                         err = blk_execute_rq(q, bd_disk, rq, 0);
 577                         blk_put_request(rq);
 578                         break;
 579                 default:
 580                         err = -ENOTTY;
 581         }
 582
 583         blk_put_queue(q);
 584         return err;
 585 }
 586
 587 EXPORT_SYMBOL(scsi_cmd_ioctl);