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 safe_for_read(cmd)      [cmd] = CMD_READ_SAFE
 111 #define safe_for_write(cmd)     [cmd] = CMD_WRITE_SAFE
 112
 113 static int verify_command(struct file *file, unsigned char *cmd)
 114 {
 115         static const unsigned char cmd_type[256] = {
 116
 117                 /* Basic read-only commands */
 118                 safe_for_read(TEST_UNIT_READY),
 119                 safe_for_read(REQUEST_SENSE),
 120                 safe_for_read(READ_6),
 121                 safe_for_read(READ_10),
 122                 safe_for_read(READ_12),
 123                 safe_for_read(READ_16),
 124                 safe_for_read(READ_BUFFER),
 125                 safe_for_read(READ_LONG),
 126                 safe_for_read(INQUIRY),
 127                 safe_for_read(MODE_SENSE),
 128                 safe_for_read(MODE_SENSE_10),
 129                 safe_for_read(START_STOP),
 130
 131                 /* Audio CD commands */
 132                 safe_for_read(GPCMD_PLAY_CD),
 133                 safe_for_read(GPCMD_PLAY_AUDIO_10),
 134                 safe_for_read(GPCMD_PLAY_AUDIO_MSF),
 135                 safe_for_read(GPCMD_PLAY_AUDIO_TI),
 136
 137                 /* CD/DVD data reading */
 138                 safe_for_read(GPCMD_READ_CD),
 139                 safe_for_read(GPCMD_READ_CD_MSF),
 140                 safe_for_read(GPCMD_READ_DISC_INFO),
 141                 safe_for_read(GPCMD_READ_CDVD_CAPACITY),
 142                 safe_for_read(GPCMD_READ_DVD_STRUCTURE),
 143                 safe_for_read(GPCMD_READ_HEADER),
 144                 safe_for_read(GPCMD_READ_TRACK_RZONE_INFO),
 145                 safe_for_read(GPCMD_READ_SUBCHANNEL),
 146                 safe_for_read(GPCMD_READ_TOC_PMA_ATIP),
 147                 safe_for_read(GPCMD_REPORT_KEY),
 148                 safe_for_read(GPCMD_SCAN),
 149
 150                 /* Basic writing commands */
 151                 safe_for_write(WRITE_6),
 152                 safe_for_write(WRITE_10),
 153                 safe_for_write(WRITE_VERIFY),
 154                 safe_for_write(WRITE_12),
 155                 safe_for_write(WRITE_VERIFY_12),
 156                 safe_for_write(WRITE_16),
 157                 safe_for_write(WRITE_LONG),
 158         };
 159         unsigned char type = cmd_type[cmd[0]];
 160
 161         /* Anybody who can open the device can do a read-safe command */
 162         if (type & CMD_READ_SAFE)
 163                 return 0;
 164
 165         /* Write-safe commands just require a writable open.. */
 166         if (type & CMD_WRITE_SAFE) {
 167                 if (file->f_mode & FMODE_WRITE)
 168                         return 0;
 169         }
 170
 171         /* And root can do any command.. */
 172         if (capable(CAP_SYS_RAWIO))
 173                 return 0;
 174
 175         /* Otherwise fail it with an "Operation not permitted" */
 176         return -EPERM;
 177 }
 178
 179 static int sg_io(struct file *file, request_queue_t *q,
 180                 struct gendisk *bd_disk, struct sg_io_hdr *hdr)
 181 {
 182         unsigned long start_time;
 183         int reading, writing;
 184         struct request *rq;
 185         struct bio *bio;
 186         char sense[SCSI_SENSE_BUFFERSIZE];
 187         unsigned char cmd[BLK_MAX_CDB];
 188
 189         if (hdr->interface_id != 'S')
 190                 return -EINVAL;
 191         if (hdr->cmd_len > BLK_MAX_CDB)
 192                 return -EINVAL;
 193         if (copy_from_user(cmd, hdr->cmdp, hdr->cmd_len))
 194                 return -EFAULT;
 195         if (verify_command(file, cmd))
 196                 return -EPERM;
 197
 198         /*
 199          * we'll do that later
 200          */
 201         if (hdr->iovec_count)
 202                 return -EOPNOTSUPP;
 203
 204         if (hdr->dxfer_len > (q->max_sectors << 9))
 205                 return -EIO;
 206
 207         reading = writing = 0;
 208         if (hdr->dxfer_len) {
 209                 switch (hdr->dxfer_direction) {
 210                 default:
 211                         return -EINVAL;
 212                 case SG_DXFER_TO_FROM_DEV:
 213                         reading = 1;
 214                         /* fall through */
 215                 case SG_DXFER_TO_DEV:
 216                         writing = 1;
 217                         break;
 218                 case SG_DXFER_FROM_DEV:
 219                         reading = 1;
 220                         break;
 221                 }
 222
 223                 rq = blk_rq_map_user(q, writing ? WRITE : READ, hdr->dxferp,
 224                                      hdr->dxfer_len);
 225
 226                 if (IS_ERR(rq))
 227                         return PTR_ERR(rq);
 228         } else
 229                 rq = blk_get_request(q, READ, __GFP_WAIT);
 230
 231         /*
 232          * fill in request structure
 233          */
 234         rq->cmd_len = hdr->cmd_len;
 235         memcpy(rq->cmd, cmd, hdr->cmd_len);
 236         if (sizeof(rq->cmd) != hdr->cmd_len)
 237                 memset(rq->cmd + hdr->cmd_len, 0, sizeof(rq->cmd) - hdr->cmd_len);
 238
 239         memset(sense, 0, sizeof(sense));
 240         rq->sense = sense;
 241         rq->sense_len = 0;
 242
 243         rq->flags |= REQ_BLOCK_PC;
 244         bio = rq->bio;
 245
 246         /*
 247          * bounce this after holding a reference to the original bio, it's
 248          * needed for proper unmapping
 249          */
 250         if (rq->bio)
 251                 blk_queue_bounce(q, &rq->bio);
 252
 253         rq->timeout = (hdr->timeout * HZ) / 1000;
 254         if (!rq->timeout)
 255                 rq->timeout = q->sg_timeout;
 256         if (!rq->timeout)
 257                 rq->timeout = BLK_DEFAULT_TIMEOUT;
 258
 259         start_time = jiffies;
 260
 261         /* ignore return value. All information is passed back to caller
 262          * (if he doesn't check that is his problem).
 263          * N.B. a non-zero SCSI status is _not_ necessarily an error.
 264          */
 265         blk_execute_rq(q, bd_disk, rq);
 266
 267         /* write to all output members */
 268         hdr->status = rq->errors;
 269         hdr->masked_status = (hdr->status >> 1) & 0x1f;
 270         hdr->msg_status = 0;
 271         hdr->host_status = 0;
 272         hdr->driver_status = 0;
 273         hdr->info = 0;
 274         if (hdr->masked_status || hdr->host_status || hdr->driver_status)
 275                 hdr->info |= SG_INFO_CHECK;
 276         hdr->resid = rq->data_len;
 277         hdr->duration = ((jiffies - start_time) * 1000) / HZ;
 278         hdr->sb_len_wr = 0;
 279
 280         if (rq->sense_len && hdr->sbp) {
 281                 int len = min((unsigned int) hdr->mx_sb_len, rq->sense_len);
 282
 283                 if (!copy_to_user(hdr->sbp, rq->sense, len))
 284                         hdr->sb_len_wr = len;
 285         }
 286
 287         if (blk_rq_unmap_user(rq, bio, hdr->dxfer_len))
 288                 return -EFAULT;
 289
 290         /* may not have succeeded, but output values written to control
 291          * structure (struct sg_io_hdr).  */
 292         return 0;
 293 }
 294
 295 #define FORMAT_UNIT_TIMEOUT             (2 * 60 * 60 * HZ)
 296 #define START_STOP_TIMEOUT              (60 * HZ)
 297 #define MOVE_MEDIUM_TIMEOUT             (5 * 60 * HZ)
 298 #define READ_ELEMENT_STATUS_TIMEOUT     (5 * 60 * HZ)
 299 #define READ_DEFECT_DATA_TIMEOUT        (60 * HZ )
 300 #define OMAX_SB_LEN 16          /* For backward compatibility */
 301
 302 static int sg_scsi_ioctl(struct file *file, request_queue_t *q,
 303                          struct gendisk *bd_disk, Scsi_Ioctl_Command __user *sic)
 304 {
 305         struct request *rq;
 306         int err, in_len, out_len, bytes, opcode, cmdlen;
 307         char *buffer = NULL, sense[SCSI_SENSE_BUFFERSIZE];
 308
 309         /*
 310          * get in an out lengths, verify they don't exceed a page worth of data
 311          */
 312         if (get_user(in_len, &sic->inlen))
 313                 return -EFAULT;
 314         if (get_user(out_len, &sic->outlen))
 315                 return -EFAULT;
 316         if (in_len > PAGE_SIZE || out_len > PAGE_SIZE)
 317                 return -EINVAL;
 318         if (get_user(opcode, (int *)sic->data))
 319                 return -EFAULT;
 320
 321         bytes = max(in_len, out_len);
 322         if (bytes) {
 323                 buffer = kmalloc(bytes, q->bounce_gfp | GFP_USER | __GFP_NOWARN);
 324                 if (!buffer)
 325                         return -ENOMEM;
 326
 327                 memset(buffer, 0, bytes);
 328         }
 329
 330         rq = blk_get_request(q, in_len ? WRITE : READ, __GFP_WAIT);
 331
 332         cmdlen = COMMAND_SIZE(opcode);
 333
 334         /*
 335          * get command and data to send to device, if any
 336          */
 337         err = -EFAULT;
 338         rq->cmd_len = cmdlen;
 339         if (copy_from_user(rq->cmd, sic->data, cmdlen))
 340                 goto error;
 341
 342         if (copy_from_user(buffer, sic->data + cmdlen, in_len))
 343                 goto error;
 344
 345         err = verify_command(file, rq->cmd);
 346         if (err)
 347                 goto error;
 348
 349         switch (opcode) {
 350                 case SEND_DIAGNOSTIC:
 351                 case FORMAT_UNIT:
 352                         rq->timeout = FORMAT_UNIT_TIMEOUT;
 353                         break;
 354                 case START_STOP:
 355                         rq->timeout = START_STOP_TIMEOUT;
 356                         break;
 357                 case MOVE_MEDIUM:
 358                         rq->timeout = MOVE_MEDIUM_TIMEOUT;
 359                         break;
 360                 case READ_ELEMENT_STATUS:
 361                         rq->timeout = READ_ELEMENT_STATUS_TIMEOUT;
 362                         break;
 363                 case READ_DEFECT_DATA:
 364                         rq->timeout = READ_DEFECT_DATA_TIMEOUT;
 365                         break;
 366                 default:
 367                         rq->timeout = BLK_DEFAULT_TIMEOUT;
 368                         break;
 369         }
 370
 371         memset(sense, 0, sizeof(sense));
 372         rq->sense = sense;
 373         rq->sense_len = 0;
 374
 375         rq->data = buffer;
 376         rq->data_len = bytes;
 377         rq->flags |= REQ_BLOCK_PC;
 378
 379         blk_execute_rq(q, bd_disk, rq);
 380         err = rq->errors & 0xff;        /* only 8 bit SCSI status */
 381         if (err) {
 382                 if (rq->sense_len && rq->sense) {
 383                         bytes = (OMAX_SB_LEN > rq->sense_len) ?
 384                                 rq->sense_len : OMAX_SB_LEN;
 385                         if (copy_to_user(sic->data, rq->sense, bytes))
 386                                 err = -EFAULT;
 387                 }
 388         } else {
 389                 if (copy_to_user(sic->data, buffer, out_len))
 390                         err = -EFAULT;
 391         }
 392
 393 error:
 394         kfree(buffer);
 395         blk_put_request(rq);
 396         return err;
 397 }
 398
 399 int scsi_cmd_ioctl(struct file *file, struct gendisk *bd_disk, unsigned int cmd, void __user *arg)
 400 {
 401         request_queue_t *q;
 402         struct request *rq;
 403         int close = 0, err;
 404
 405         q = bd_disk->queue;
 406         if (!q)
 407                 return -ENXIO;
 408
 409         if (blk_get_queue(q))
 410                 return -ENXIO;
 411
 412         switch (cmd) {
 413                 /*
 414                  * new sgv3 interface
 415                  */
 416                 case SG_GET_VERSION_NUM:
 417                         err = sg_get_version(arg);
 418                         break;
 419                 case SCSI_IOCTL_GET_IDLUN:
 420                         err = scsi_get_idlun(q, arg);
 421                         break;
 422                 case SCSI_IOCTL_GET_BUS_NUMBER:
 423                         err = scsi_get_bus(q, arg);
 424                         break;
 425                 case SG_SET_TIMEOUT:
 426                         err = sg_set_timeout(q, arg);
 427                         break;
 428                 case SG_GET_TIMEOUT:
 429                         err = sg_get_timeout(q);
 430                         break;
 431                 case SG_GET_RESERVED_SIZE:
 432                         err = sg_get_reserved_size(q, arg);
 433                         break;
 434                 case SG_SET_RESERVED_SIZE:
 435                         err = sg_set_reserved_size(q, arg);
 436                         break;
 437                 case SG_EMULATED_HOST:
 438                         err = sg_emulated_host(q, arg);
 439                         break;
 440                 case SG_IO: {
 441                         struct sg_io_hdr hdr;
 442
 443                         err = -EFAULT;
 444                         if (copy_from_user(&hdr, arg, sizeof(hdr)))
 445                                 break;
 446                         err = sg_io(file, q, bd_disk, &hdr);
 447                         if (err == -EFAULT)
 448                                 break;
 449
 450                         if (copy_to_user(arg, &hdr, sizeof(hdr)))
 451                                 err = -EFAULT;
 452                         break;
 453                 }
 454                 case CDROM_SEND_PACKET: {
 455                         struct cdrom_generic_command cgc;
 456                         struct sg_io_hdr hdr;
 457
 458                         err = -EFAULT;
 459                         if (copy_from_user(&cgc, arg, sizeof(cgc)))
 460                                 break;
 461                         cgc.timeout = clock_t_to_jiffies(cgc.timeout);
 462                         memset(&hdr, 0, sizeof(hdr));
 463                         hdr.interface_id = 'S';
 464                         hdr.cmd_len = sizeof(cgc.cmd);
 465                         hdr.dxfer_len = cgc.buflen;
 466                         err = 0;
 467                         switch (cgc.data_direction) {
 468                                 case CGC_DATA_UNKNOWN:
 469                                         hdr.dxfer_direction = SG_DXFER_UNKNOWN;
 470                                         break;
 471                                 case CGC_DATA_WRITE:
 472                                         hdr.dxfer_direction = SG_DXFER_TO_DEV;
 473                                         break;
 474                                 case CGC_DATA_READ:
 475                                         hdr.dxfer_direction = SG_DXFER_FROM_DEV;
 476                                         break;
 477                                 case CGC_DATA_NONE:
 478                                         hdr.dxfer_direction = SG_DXFER_NONE;
 479                                         break;
 480                                 default:
 481                                         err = -EINVAL;
 482                         }
 483                         if (err)
 484                                 break;
 485
 486                         hdr.dxferp = cgc.buffer;
 487                         hdr.sbp = cgc.sense;
 488                         if (hdr.sbp)
 489                                 hdr.mx_sb_len = sizeof(struct request_sense);
 490                         hdr.timeout = cgc.timeout;
 491                         hdr.cmdp = ((struct cdrom_generic_command __user*) arg)->cmd;
 492                         hdr.cmd_len = sizeof(cgc.cmd);
 493
 494                         err = sg_io(file, q, bd_disk, &hdr);
 495                         if (err == -EFAULT)
 496                                 break;
 497
 498                         if (hdr.status)
 499                                 err = -EIO;
 500
 501                         cgc.stat = err;
 502                         cgc.buflen = hdr.resid;
 503                         if (copy_to_user(arg, &cgc, sizeof(cgc)))
 504                                 err = -EFAULT;
 505
 506                         break;
 507                 }
 508
 509                 /*
 510                  * old junk scsi send command ioctl
 511                  */
 512                 case SCSI_IOCTL_SEND_COMMAND:
 513                         err = -EINVAL;
 514                         if (!arg)
 515                                 break;
 516
 517                         err = sg_scsi_ioctl(file, q, bd_disk, arg);
 518                         break;
 519                 case CDROMCLOSETRAY:
 520                         close = 1;
 521                 case CDROMEJECT:
 522                         rq = blk_get_request(q, WRITE, __GFP_WAIT);
 523                         rq->flags |= REQ_BLOCK_PC;
 524                         rq->data = NULL;
 525                         rq->data_len = 0;
 526                         rq->timeout = BLK_DEFAULT_TIMEOUT;
 527                         memset(rq->cmd, 0, sizeof(rq->cmd));
 528                         rq->cmd[0] = GPCMD_START_STOP_UNIT;
 529                         rq->cmd[4] = 0x02 + (close != 0);
 530                         rq->cmd_len = 6;
 531                         err = blk_execute_rq(q, bd_disk, rq);
 532                         blk_put_request(rq);
 533                         break;
 534                 default:
 535                         err = -ENOTTY;
 536         }
 537
 538         blk_put_queue(q);
 539         return err;
 540 }
 541
 542 EXPORT_SYMBOL(scsi_cmd_ioctl);