block: export blk_verify_command for SG v4
[safe/jmp/linux-2.6] / block / scsi_ioctl.c
index 18de84c..db53b2c 100644 (file)
@@ -21,6 +21,7 @@
 #include <linux/string.h>
 #include <linux/module.h>
 #include <linux/blkdev.h>
+#include <linux/capability.h>
 #include <linux/completion.h>
 #include <linux/cdrom.h>
 #include <linux/slab.h>
@@ -40,8 +41,6 @@ const unsigned char scsi_command_size[8] =
 
 EXPORT_SYMBOL(scsi_command_size);
 
-#define BLK_DEFAULT_TIMEOUT    (60 * HZ)
-
 #include <scsi/sg.h>
 
 static int sg_get_version(int __user *p)
@@ -77,7 +76,9 @@ static int sg_set_timeout(request_queue_t *q, int __user *p)
 
 static int sg_get_reserved_size(request_queue_t *q, int __user *p)
 {
-       return put_user(q->sg_reserved_size, p);
+       unsigned val = min(q->sg_reserved_size, q->max_sectors << 9);
+
+       return put_user(val, p);
 }
 
 static int sg_set_reserved_size(request_queue_t *q, int __user *p)
@@ -111,7 +112,7 @@ static int sg_emulated_host(request_queue_t *q, int __user *p)
 #define safe_for_read(cmd)     [cmd] = CMD_READ_SAFE
 #define safe_for_write(cmd)    [cmd] = CMD_WRITE_SAFE
 
-static int verify_command(struct file *file, unsigned char *cmd)
+int blk_verify_command(unsigned char *cmd, int has_write_perm)
 {
        static unsigned char cmd_type[256] = {
 
@@ -190,18 +191,11 @@ static int verify_command(struct file *file, unsigned char *cmd)
                safe_for_write(GPCMD_SET_STREAMING),
        };
        unsigned char type = cmd_type[cmd[0]];
-       int has_write_perm = 0;
 
        /* Anybody who can open the device can do a read-safe command */
        if (type & CMD_READ_SAFE)
                return 0;
 
-       /*
-        * file can be NULL from ioctl_by_bdev()...
-        */
-       if (file)
-               has_write_perm = file->f_mode & FMODE_WRITE;
-
        /* Write-safe commands just require a writable open.. */
        if ((type & CMD_WRITE_SAFE) && has_write_perm)
                return 0;
@@ -218,25 +212,96 @@ static int verify_command(struct file *file, unsigned char *cmd)
        /* Otherwise fail it with an "Operation not permitted" */
        return -EPERM;
 }
+EXPORT_SYMBOL_GPL(blk_verify_command);
+
+int blk_fill_sghdr_rq(request_queue_t *q, struct request *rq,
+                     struct sg_io_hdr *hdr, int has_write_perm)
+{
+       memset(rq->cmd, 0, BLK_MAX_CDB); /* ATAPI hates garbage after CDB */
+
+       if (copy_from_user(rq->cmd, hdr->cmdp, hdr->cmd_len))
+               return -EFAULT;
+       if (blk_verify_command(rq->cmd, has_write_perm))
+               return -EPERM;
+
+       /*
+        * fill in request structure
+        */
+       rq->cmd_len = hdr->cmd_len;
+       rq->cmd_type = REQ_TYPE_BLOCK_PC;
+
+       rq->timeout = (hdr->timeout * HZ) / 1000;
+       if (!rq->timeout)
+               rq->timeout = q->sg_timeout;
+       if (!rq->timeout)
+               rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
+
+       return 0;
+}
+EXPORT_SYMBOL_GPL(blk_fill_sghdr_rq);
+
+/*
+ * unmap a request that was previously mapped to this sg_io_hdr. handles
+ * both sg and non-sg sg_io_hdr.
+ */
+int blk_unmap_sghdr_rq(struct request *rq, struct sg_io_hdr *hdr)
+{
+       blk_rq_unmap_user(rq->bio);
+       blk_put_request(rq);
+       return 0;
+}
+EXPORT_SYMBOL_GPL(blk_unmap_sghdr_rq);
+
+int blk_complete_sghdr_rq(struct request *rq, struct sg_io_hdr *hdr,
+                         struct bio *bio)
+{
+       int r, ret = 0;
+
+       /*
+        * fill in all the output members
+        */
+       hdr->status = rq->errors & 0xff;
+       hdr->masked_status = status_byte(rq->errors);
+       hdr->msg_status = msg_byte(rq->errors);
+       hdr->host_status = host_byte(rq->errors);
+       hdr->driver_status = driver_byte(rq->errors);
+       hdr->info = 0;
+       if (hdr->masked_status || hdr->host_status || hdr->driver_status)
+               hdr->info |= SG_INFO_CHECK;
+       hdr->resid = rq->data_len;
+       hdr->sb_len_wr = 0;
+
+       if (rq->sense_len && hdr->sbp) {
+               int len = min((unsigned int) hdr->mx_sb_len, rq->sense_len);
+
+               if (!copy_to_user(hdr->sbp, rq->sense, len))
+                       hdr->sb_len_wr = len;
+               else
+                       ret = -EFAULT;
+       }
+
+       rq->bio = bio;
+       r = blk_unmap_sghdr_rq(rq, hdr);
+       if (ret)
+               r = ret;
+
+       return r;
+}
+EXPORT_SYMBOL_GPL(blk_complete_sghdr_rq);
 
 static int sg_io(struct file *file, request_queue_t *q,
                struct gendisk *bd_disk, struct sg_io_hdr *hdr)
 {
        unsigned long start_time;
-       int writing = 0, ret = 0;
+       int writing = 0, ret = 0, has_write_perm = 0;
        struct request *rq;
-       struct bio *bio;
        char sense[SCSI_SENSE_BUFFERSIZE];
-       unsigned char cmd[BLK_MAX_CDB];
+       struct bio *bio;
 
        if (hdr->interface_id != 'S')
                return -EINVAL;
        if (hdr->cmd_len > BLK_MAX_CDB)
                return -EINVAL;
-       if (copy_from_user(cmd, hdr->cmdp, hdr->cmd_len))
-               return -EFAULT;
-       if (verify_command(file, cmd))
-               return -EPERM;
 
        if (hdr->dxfer_len > (q->max_hw_sectors << 9))
                return -EIO;
@@ -245,10 +310,10 @@ static int sg_io(struct file *file, request_queue_t *q,
                switch (hdr->dxfer_direction) {
                default:
                        return -EINVAL;
-               case SG_DXFER_TO_FROM_DEV:
                case SG_DXFER_TO_DEV:
                        writing = 1;
                        break;
+               case SG_DXFER_TO_FROM_DEV:
                case SG_DXFER_FROM_DEV:
                        break;
                }
@@ -257,6 +322,14 @@ static int sg_io(struct file *file, request_queue_t *q,
        if (!rq)
                return -ENOMEM;
 
+       if (file)
+               has_write_perm = file->f_mode & FMODE_WRITE;
+
+       if (blk_fill_sghdr_rq(q, rq, hdr, has_write_perm)) {
+               blk_put_request(rq);
+               return -EFAULT;
+       }
+
        if (hdr->iovec_count) {
                const int size = sizeof(struct sg_iovec) * hdr->iovec_count;
                struct sg_iovec *iov;
@@ -273,7 +346,8 @@ static int sg_io(struct file *file, request_queue_t *q,
                        goto out;
                }
 
-               ret = blk_rq_map_user_iov(q, rq, iov, hdr->iovec_count);
+               ret = blk_rq_map_user_iov(q, rq, iov, hdr->iovec_count,
+                                         hdr->dxfer_len);
                kfree(iov);
        } else if (hdr->dxfer_len)
                ret = blk_rq_map_user(q, rq, hdr->dxferp, hdr->dxfer_len);
@@ -281,33 +355,11 @@ static int sg_io(struct file *file, request_queue_t *q,
        if (ret)
                goto out;
 
-       /*
-        * fill in request structure
-        */
-       rq->cmd_len = hdr->cmd_len;
-       memcpy(rq->cmd, cmd, hdr->cmd_len);
-       if (sizeof(rq->cmd) != hdr->cmd_len)
-               memset(rq->cmd + hdr->cmd_len, 0, sizeof(rq->cmd) - hdr->cmd_len);
-
+       bio = rq->bio;
        memset(sense, 0, sizeof(sense));
        rq->sense = sense;
        rq->sense_len = 0;
-
-       rq->flags |= REQ_BLOCK_PC;
-       bio = rq->bio;
-
-       /*
-        * bounce this after holding a reference to the original bio, it's
-        * needed for proper unmapping
-        */
-       if (rq->bio)
-               blk_queue_bounce(q, &rq->bio);
-
-       rq->timeout = (hdr->timeout * HZ) / 1000;
-       if (!rq->timeout)
-               rq->timeout = q->sg_timeout;
-       if (!rq->timeout)
-               rq->timeout = BLK_DEFAULT_TIMEOUT;
+       rq->retries = 0;
 
        start_time = jiffies;
 
@@ -317,46 +369,59 @@ static int sg_io(struct file *file, request_queue_t *q,
         */
        blk_execute_rq(q, bd_disk, rq, 0);
 
-       /* write to all output members */
-       hdr->status = 0xff & rq->errors;
-       hdr->masked_status = status_byte(rq->errors);
-       hdr->msg_status = msg_byte(rq->errors);
-       hdr->host_status = host_byte(rq->errors);
-       hdr->driver_status = driver_byte(rq->errors);
-       hdr->info = 0;
-       if (hdr->masked_status || hdr->host_status || hdr->driver_status)
-               hdr->info |= SG_INFO_CHECK;
-       hdr->resid = rq->data_len;
        hdr->duration = ((jiffies - start_time) * 1000) / HZ;
-       hdr->sb_len_wr = 0;
-
-       if (rq->sense_len && hdr->sbp) {
-               int len = min((unsigned int) hdr->mx_sb_len, rq->sense_len);
 
-               if (!copy_to_user(hdr->sbp, rq->sense, len))
-                       hdr->sb_len_wr = len;
-       }
-
-       if (blk_rq_unmap_user(bio, hdr->dxfer_len))
-               ret = -EFAULT;
-
-       /* may not have succeeded, but output values written to control
-        * structure (struct sg_io_hdr).  */
+       return blk_complete_sghdr_rq(rq, hdr, bio);
 out:
        blk_put_request(rq);
        return ret;
 }
 
+/**
+ * sg_scsi_ioctl  --  handle deprecated SCSI_IOCTL_SEND_COMMAND ioctl
+ * @file:      file this ioctl operates on (optional)
+ * @q:         request queue to send scsi commands down
+ * @disk:      gendisk to operate on (option)
+ * @sic:       userspace structure describing the command to perform
+ *
+ * Send down the scsi command described by @sic to the device below
+ * the request queue @q.  If @file is non-NULL it's used to perform
+ * fine-grained permission checks that allow users to send down
+ * non-destructive SCSI commands.  If the caller has a struct gendisk
+ * available it should be passed in as @disk to allow the low level
+ * driver to use the information contained in it.  A non-NULL @disk
+ * is only allowed if the caller knows that the low level driver doesn't
+ * need it (e.g. in the scsi subsystem).
+ *
+ * Notes:
+ *   -  This interface is deprecated - users should use the SG_IO
+ *      interface instead, as this is a more flexible approach to
+ *      performing SCSI commands on a device.
+ *   -  The SCSI command length is determined by examining the 1st byte
+ *      of the given command. There is no way to override this.
+ *   -  Data transfers are limited to PAGE_SIZE
+ *   -  The length (x + y) must be at least OMAX_SB_LEN bytes long to
+ *      accommodate the sense buffer when an error occurs.
+ *      The sense buffer is truncated to OMAX_SB_LEN (16) bytes so that
+ *      old code will not be surprised.
+ *   -  If a Unix error occurs (e.g. ENOMEM) then the user will receive
+ *      a negative return and the Unix error code in 'errno'.
+ *      If the SCSI command succeeds then 0 is returned.
+ *      Positive numbers returned are the compacted SCSI error codes (4
+ *      bytes in one int) where the lowest byte is the SCSI status.
+ */
 #define OMAX_SB_LEN 16          /* For backward compatibility */
-
-static int sg_scsi_ioctl(struct file *file, request_queue_t *q,
-                        struct gendisk *bd_disk, Scsi_Ioctl_Command __user *sic)
+int sg_scsi_ioctl(struct file *file, struct request_queue *q,
+                 struct gendisk *disk, struct scsi_ioctl_command __user *sic)
 {
        struct request *rq;
        int err;
        unsigned int in_len, out_len, bytes, opcode, cmdlen;
        char *buffer = NULL, sense[SCSI_SENSE_BUFFERSIZE];
 
+       if (!sic)
+               return -EINVAL;
+
        /*
         * get in an out lengths, verify they don't exceed a page worth of data
         */
@@ -390,44 +455,53 @@ static int sg_scsi_ioctl(struct file *file, request_queue_t *q,
        if (copy_from_user(rq->cmd, sic->data, cmdlen))
                goto error;
 
-       if (copy_from_user(buffer, sic->data + cmdlen, in_len))
+       if (in_len && copy_from_user(buffer, sic->data + cmdlen, in_len))
                goto error;
 
-       err = verify_command(file, rq->cmd);
+       err = blk_verify_command(rq->cmd, file->f_mode & FMODE_WRITE);
        if (err)
                goto error;
 
+       /* default.  possible overriden later */
+       rq->retries = 5;
+
        switch (opcode) {
-               case SEND_DIAGNOSTIC:
-               case FORMAT_UNIT:
-                       rq->timeout = FORMAT_UNIT_TIMEOUT;
-                       break;
-               case START_STOP:
-                       rq->timeout = START_STOP_TIMEOUT;
-                       break;
-               case MOVE_MEDIUM:
-                       rq->timeout = MOVE_MEDIUM_TIMEOUT;
-                       break;
-               case READ_ELEMENT_STATUS:
-                       rq->timeout = READ_ELEMENT_STATUS_TIMEOUT;
-                       break;
-               case READ_DEFECT_DATA:
-                       rq->timeout = READ_DEFECT_DATA_TIMEOUT;
-                       break;
-               default:
-                       rq->timeout = BLK_DEFAULT_TIMEOUT;
-                       break;
+       case SEND_DIAGNOSTIC:
+       case FORMAT_UNIT:
+               rq->timeout = FORMAT_UNIT_TIMEOUT;
+               rq->retries = 1;
+               break;
+       case START_STOP:
+               rq->timeout = START_STOP_TIMEOUT;
+               break;
+       case MOVE_MEDIUM:
+               rq->timeout = MOVE_MEDIUM_TIMEOUT;
+               break;
+       case READ_ELEMENT_STATUS:
+               rq->timeout = READ_ELEMENT_STATUS_TIMEOUT;
+               break;
+       case READ_DEFECT_DATA:
+               rq->timeout = READ_DEFECT_DATA_TIMEOUT;
+               rq->retries = 1;
+               break;
+       default:
+               rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
+               break;
+       }
+
+       if (bytes && blk_rq_map_kern(q, rq, buffer, bytes, __GFP_WAIT)) {
+               err = DRIVER_ERROR << 24;
+               goto out;
        }
 
        memset(sense, 0, sizeof(sense));
        rq->sense = sense;
        rq->sense_len = 0;
+       rq->cmd_type = REQ_TYPE_BLOCK_PC;
 
-       rq->data = buffer;
-       rq->data_len = bytes;
-       rq->flags |= REQ_BLOCK_PC;
+       blk_execute_rq(q, disk, rq, 0);
 
-       blk_execute_rq(q, bd_disk, rq, 0);
+out:
        err = rq->errors & 0xff;        /* only 8 bit SCSI status */
        if (err) {
                if (rq->sense_len && rq->sense) {
@@ -446,7 +520,7 @@ error:
        blk_put_request(rq);
        return err;
 }
-
+EXPORT_SYMBOL_GPL(sg_scsi_ioctl);
 
 /* Send basic block requests */
 static int __blk_send_generic(request_queue_t *q, struct gendisk *bd_disk, int cmd, int data)
@@ -455,10 +529,10 @@ static int __blk_send_generic(request_queue_t *q, struct gendisk *bd_disk, int c
        int err;
 
        rq = blk_get_request(q, WRITE, __GFP_WAIT);
-       rq->flags |= REQ_BLOCK_PC;
+       rq->cmd_type = REQ_TYPE_BLOCK_PC;
        rq->data = NULL;
        rq->data_len = 0;
-       rq->timeout = BLK_DEFAULT_TIMEOUT;
+       rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
        memset(rq->cmd, 0, sizeof(rq->cmd));
        rq->cmd[0] = cmd;
        rq->cmd[4] = data;