2 * Copyright (C) 2001 Jens Axboe <axboe@suse.de>
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.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
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-
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/capability.h>
25 #include <linux/completion.h>
26 #include <linux/cdrom.h>
27 #include <linux/ratelimit.h>
28 #include <linux/slab.h>
29 #include <linux/times.h>
31 #include <linux/raid/md_u.h>
32 #include <linux/mtio.h>
33 #include <asm/uaccess.h>
35 #include <scsi/scsi.h>
36 #include <scsi/scsi_ioctl.h>
37 #include <scsi/scsi_cmnd.h>
39 struct blk_cmd_filter {
40 unsigned long read_ok[BLK_SCSI_CMD_PER_LONG];
41 unsigned long write_ok[BLK_SCSI_CMD_PER_LONG];
44 static struct blk_cmd_filter blk_default_cmd_filter;
46 /* Command group 3 is reserved and should never be used. */
47 const unsigned char scsi_command_size_tbl[8] =
52 EXPORT_SYMBOL(scsi_command_size_tbl);
56 static int sg_get_version(int __user *p)
58 static const int sg_version_num = 30527;
59 return put_user(sg_version_num, p);
62 static int scsi_get_idlun(struct request_queue *q, int __user *p)
64 return put_user(0, p);
67 static int scsi_get_bus(struct request_queue *q, int __user *p)
69 return put_user(0, p);
72 static int sg_get_timeout(struct request_queue *q)
74 return jiffies_to_clock_t(q->sg_timeout);
77 static int sg_set_timeout(struct request_queue *q, int __user *p)
79 int timeout, err = get_user(timeout, p);
82 q->sg_timeout = clock_t_to_jiffies(timeout);
87 static int sg_get_reserved_size(struct request_queue *q, int __user *p)
89 unsigned val = min(q->sg_reserved_size, queue_max_sectors(q) << 9);
91 return put_user(val, p);
94 static int sg_set_reserved_size(struct request_queue *q, int __user *p)
96 int size, err = get_user(size, p);
103 if (size > (queue_max_sectors(q) << 9))
104 size = queue_max_sectors(q) << 9;
106 q->sg_reserved_size = size;
111 * will always return that we are ATAPI even for a real SCSI drive, I'm not
112 * so sure this is worth doing anything about (why would you care??)
114 static int sg_emulated_host(struct request_queue *q, int __user *p)
116 return put_user(1, p);
119 static void blk_set_cmd_filter_defaults(struct blk_cmd_filter *filter)
121 /* Basic read-only commands */
122 __set_bit(TEST_UNIT_READY, filter->read_ok);
123 __set_bit(REQUEST_SENSE, filter->read_ok);
124 __set_bit(READ_6, filter->read_ok);
125 __set_bit(READ_10, filter->read_ok);
126 __set_bit(READ_12, filter->read_ok);
127 __set_bit(READ_16, filter->read_ok);
128 __set_bit(READ_BUFFER, filter->read_ok);
129 __set_bit(READ_DEFECT_DATA, filter->read_ok);
130 __set_bit(READ_CAPACITY, filter->read_ok);
131 __set_bit(READ_LONG, filter->read_ok);
132 __set_bit(INQUIRY, filter->read_ok);
133 __set_bit(MODE_SENSE, filter->read_ok);
134 __set_bit(MODE_SENSE_10, filter->read_ok);
135 __set_bit(LOG_SENSE, filter->read_ok);
136 __set_bit(START_STOP, filter->read_ok);
137 __set_bit(GPCMD_VERIFY_10, filter->read_ok);
138 __set_bit(VERIFY_16, filter->read_ok);
139 __set_bit(REPORT_LUNS, filter->read_ok);
140 __set_bit(SERVICE_ACTION_IN, filter->read_ok);
141 __set_bit(RECEIVE_DIAGNOSTIC, filter->read_ok);
142 __set_bit(MAINTENANCE_IN, filter->read_ok);
143 __set_bit(GPCMD_READ_BUFFER_CAPACITY, filter->read_ok);
145 /* Audio CD commands */
146 __set_bit(GPCMD_PLAY_CD, filter->read_ok);
147 __set_bit(GPCMD_PLAY_AUDIO_10, filter->read_ok);
148 __set_bit(GPCMD_PLAY_AUDIO_MSF, filter->read_ok);
149 __set_bit(GPCMD_PLAY_AUDIO_TI, filter->read_ok);
150 __set_bit(GPCMD_PAUSE_RESUME, filter->read_ok);
152 /* CD/DVD data reading */
153 __set_bit(GPCMD_READ_CD, filter->read_ok);
154 __set_bit(GPCMD_READ_CD_MSF, filter->read_ok);
155 __set_bit(GPCMD_READ_DISC_INFO, filter->read_ok);
156 __set_bit(GPCMD_READ_CDVD_CAPACITY, filter->read_ok);
157 __set_bit(GPCMD_READ_DVD_STRUCTURE, filter->read_ok);
158 __set_bit(GPCMD_READ_HEADER, filter->read_ok);
159 __set_bit(GPCMD_READ_TRACK_RZONE_INFO, filter->read_ok);
160 __set_bit(GPCMD_READ_SUBCHANNEL, filter->read_ok);
161 __set_bit(GPCMD_READ_TOC_PMA_ATIP, filter->read_ok);
162 __set_bit(GPCMD_REPORT_KEY, filter->read_ok);
163 __set_bit(GPCMD_SCAN, filter->read_ok);
164 __set_bit(GPCMD_GET_CONFIGURATION, filter->read_ok);
165 __set_bit(GPCMD_READ_FORMAT_CAPACITIES, filter->read_ok);
166 __set_bit(GPCMD_GET_EVENT_STATUS_NOTIFICATION, filter->read_ok);
167 __set_bit(GPCMD_GET_PERFORMANCE, filter->read_ok);
168 __set_bit(GPCMD_SEEK, filter->read_ok);
169 __set_bit(GPCMD_STOP_PLAY_SCAN, filter->read_ok);
171 /* Basic writing commands */
172 __set_bit(WRITE_6, filter->write_ok);
173 __set_bit(WRITE_10, filter->write_ok);
174 __set_bit(WRITE_VERIFY, filter->write_ok);
175 __set_bit(WRITE_12, filter->write_ok);
176 __set_bit(WRITE_VERIFY_12, filter->write_ok);
177 __set_bit(WRITE_16, filter->write_ok);
178 __set_bit(WRITE_LONG, filter->write_ok);
179 __set_bit(WRITE_LONG_2, filter->write_ok);
180 __set_bit(ERASE, filter->write_ok);
181 __set_bit(GPCMD_MODE_SELECT_10, filter->write_ok);
182 __set_bit(MODE_SELECT, filter->write_ok);
183 __set_bit(LOG_SELECT, filter->write_ok);
184 __set_bit(GPCMD_BLANK, filter->write_ok);
185 __set_bit(GPCMD_CLOSE_TRACK, filter->write_ok);
186 __set_bit(GPCMD_FLUSH_CACHE, filter->write_ok);
187 __set_bit(GPCMD_FORMAT_UNIT, filter->write_ok);
188 __set_bit(GPCMD_REPAIR_RZONE_TRACK, filter->write_ok);
189 __set_bit(GPCMD_RESERVE_RZONE_TRACK, filter->write_ok);
190 __set_bit(GPCMD_SEND_DVD_STRUCTURE, filter->write_ok);
191 __set_bit(GPCMD_SEND_EVENT, filter->write_ok);
192 __set_bit(GPCMD_SEND_KEY, filter->write_ok);
193 __set_bit(GPCMD_SEND_OPC, filter->write_ok);
194 __set_bit(GPCMD_SEND_CUE_SHEET, filter->write_ok);
195 __set_bit(GPCMD_SET_SPEED, filter->write_ok);
196 __set_bit(GPCMD_PREVENT_ALLOW_MEDIUM_REMOVAL, filter->write_ok);
197 __set_bit(GPCMD_LOAD_UNLOAD, filter->write_ok);
198 __set_bit(GPCMD_SET_STREAMING, filter->write_ok);
199 __set_bit(GPCMD_SET_READ_AHEAD, filter->write_ok);
202 int blk_verify_command(unsigned char *cmd, fmode_t has_write_perm)
204 struct blk_cmd_filter *filter = &blk_default_cmd_filter;
206 /* root can do any command. */
207 if (capable(CAP_SYS_RAWIO))
210 /* if there's no filter set, assume we're filtering everything out */
214 /* Anybody who can open the device can do a read-safe command */
215 if (test_bit(cmd[0], filter->read_ok))
218 /* Write-safe commands require a writable open */
219 if (test_bit(cmd[0], filter->write_ok) && has_write_perm)
224 EXPORT_SYMBOL(blk_verify_command);
226 static int blk_fill_sghdr_rq(struct request_queue *q, struct request *rq,
227 struct sg_io_hdr *hdr, fmode_t mode)
229 if (copy_from_user(rq->cmd, hdr->cmdp, hdr->cmd_len))
231 if (blk_verify_command(rq->cmd, mode & FMODE_WRITE))
235 * fill in request structure
237 rq->cmd_len = hdr->cmd_len;
238 rq->cmd_type = REQ_TYPE_BLOCK_PC;
240 rq->timeout = msecs_to_jiffies(hdr->timeout);
242 rq->timeout = q->sg_timeout;
244 rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
245 if (rq->timeout < BLK_MIN_SG_TIMEOUT)
246 rq->timeout = BLK_MIN_SG_TIMEOUT;
251 static int blk_complete_sghdr_rq(struct request *rq, struct sg_io_hdr *hdr,
257 * fill in all the output members
259 hdr->status = rq->errors & 0xff;
260 hdr->masked_status = status_byte(rq->errors);
261 hdr->msg_status = msg_byte(rq->errors);
262 hdr->host_status = host_byte(rq->errors);
263 hdr->driver_status = driver_byte(rq->errors);
265 if (hdr->masked_status || hdr->host_status || hdr->driver_status)
266 hdr->info |= SG_INFO_CHECK;
267 hdr->resid = rq->resid_len;
270 if (rq->sense_len && hdr->sbp) {
271 int len = min((unsigned int) hdr->mx_sb_len, rq->sense_len);
273 if (!copy_to_user(hdr->sbp, rq->sense, len))
274 hdr->sb_len_wr = len;
279 r = blk_rq_unmap_user(bio);
287 static int sg_io(struct request_queue *q, struct gendisk *bd_disk,
288 struct sg_io_hdr *hdr, fmode_t mode)
290 unsigned long start_time;
291 int writing = 0, ret = 0;
293 char sense[SCSI_SENSE_BUFFERSIZE];
296 if (hdr->interface_id != 'S')
298 if (hdr->cmd_len > BLK_MAX_CDB)
301 if (hdr->dxfer_len > (queue_max_hw_sectors(q) << 9))
305 switch (hdr->dxfer_direction) {
308 case SG_DXFER_TO_DEV:
311 case SG_DXFER_TO_FROM_DEV:
312 case SG_DXFER_FROM_DEV:
316 rq = blk_get_request(q, writing ? WRITE : READ, GFP_KERNEL);
320 if (blk_fill_sghdr_rq(q, rq, hdr, mode)) {
325 if (hdr->iovec_count) {
326 const int size = sizeof(struct sg_iovec) * hdr->iovec_count;
328 struct sg_iovec *sg_iov;
332 sg_iov = kmalloc(size, GFP_KERNEL);
338 if (copy_from_user(sg_iov, hdr->dxferp, size)) {
345 * Sum up the vecs, making sure they don't overflow
347 iov = (struct iovec *) sg_iov;
349 for (i = 0; i < hdr->iovec_count; i++) {
350 if (iov_data_len + iov[i].iov_len < iov_data_len) {
355 iov_data_len += iov[i].iov_len;
358 /* SG_IO howto says that the shorter of the two wins */
359 if (hdr->dxfer_len < iov_data_len) {
360 hdr->iovec_count = iov_shorten(iov,
363 iov_data_len = hdr->dxfer_len;
366 ret = blk_rq_map_user_iov(q, rq, NULL, sg_iov, hdr->iovec_count,
367 iov_data_len, GFP_KERNEL);
369 } else if (hdr->dxfer_len)
370 ret = blk_rq_map_user(q, rq, NULL, hdr->dxferp, hdr->dxfer_len,
377 memset(sense, 0, sizeof(sense));
382 start_time = jiffies;
384 /* ignore return value. All information is passed back to caller
385 * (if he doesn't check that is his problem).
386 * N.B. a non-zero SCSI status is _not_ necessarily an error.
388 blk_execute_rq(q, bd_disk, rq, 0);
390 hdr->duration = jiffies_to_msecs(jiffies - start_time);
392 return blk_complete_sghdr_rq(rq, hdr, bio);
399 * sg_scsi_ioctl -- handle deprecated SCSI_IOCTL_SEND_COMMAND ioctl
400 * @file: file this ioctl operates on (optional)
401 * @q: request queue to send scsi commands down
402 * @disk: gendisk to operate on (option)
403 * @sic: userspace structure describing the command to perform
405 * Send down the scsi command described by @sic to the device below
406 * the request queue @q. If @file is non-NULL it's used to perform
407 * fine-grained permission checks that allow users to send down
408 * non-destructive SCSI commands. If the caller has a struct gendisk
409 * available it should be passed in as @disk to allow the low level
410 * driver to use the information contained in it. A non-NULL @disk
411 * is only allowed if the caller knows that the low level driver doesn't
412 * need it (e.g. in the scsi subsystem).
415 * - This interface is deprecated - users should use the SG_IO
416 * interface instead, as this is a more flexible approach to
417 * performing SCSI commands on a device.
418 * - The SCSI command length is determined by examining the 1st byte
419 * of the given command. There is no way to override this.
420 * - Data transfers are limited to PAGE_SIZE
421 * - The length (x + y) must be at least OMAX_SB_LEN bytes long to
422 * accommodate the sense buffer when an error occurs.
423 * The sense buffer is truncated to OMAX_SB_LEN (16) bytes so that
424 * old code will not be surprised.
425 * - If a Unix error occurs (e.g. ENOMEM) then the user will receive
426 * a negative return and the Unix error code in 'errno'.
427 * If the SCSI command succeeds then 0 is returned.
428 * Positive numbers returned are the compacted SCSI error codes (4
429 * bytes in one int) where the lowest byte is the SCSI status.
431 #define OMAX_SB_LEN 16 /* For backward compatibility */
432 int sg_scsi_ioctl(struct request_queue *q, struct gendisk *disk, fmode_t mode,
433 struct scsi_ioctl_command __user *sic)
437 unsigned int in_len, out_len, bytes, opcode, cmdlen;
438 char *buffer = NULL, sense[SCSI_SENSE_BUFFERSIZE];
444 * get in an out lengths, verify they don't exceed a page worth of data
446 if (get_user(in_len, &sic->inlen))
448 if (get_user(out_len, &sic->outlen))
450 if (in_len > PAGE_SIZE || out_len > PAGE_SIZE)
452 if (get_user(opcode, sic->data))
455 bytes = max(in_len, out_len);
457 buffer = kzalloc(bytes, q->bounce_gfp | GFP_USER| __GFP_NOWARN);
463 rq = blk_get_request(q, in_len ? WRITE : READ, __GFP_WAIT);
465 cmdlen = COMMAND_SIZE(opcode);
468 * get command and data to send to device, if any
471 rq->cmd_len = cmdlen;
472 if (copy_from_user(rq->cmd, sic->data, cmdlen))
475 if (in_len && copy_from_user(buffer, sic->data + cmdlen, in_len))
478 err = blk_verify_command(rq->cmd, mode & FMODE_WRITE);
482 /* default. possible overriden later */
486 case SEND_DIAGNOSTIC:
488 rq->timeout = FORMAT_UNIT_TIMEOUT;
492 rq->timeout = START_STOP_TIMEOUT;
495 rq->timeout = MOVE_MEDIUM_TIMEOUT;
497 case READ_ELEMENT_STATUS:
498 rq->timeout = READ_ELEMENT_STATUS_TIMEOUT;
500 case READ_DEFECT_DATA:
501 rq->timeout = READ_DEFECT_DATA_TIMEOUT;
505 rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
509 if (bytes && blk_rq_map_kern(q, rq, buffer, bytes, __GFP_WAIT)) {
510 err = DRIVER_ERROR << 24;
514 memset(sense, 0, sizeof(sense));
517 rq->cmd_type = REQ_TYPE_BLOCK_PC;
519 blk_execute_rq(q, disk, rq, 0);
522 err = rq->errors & 0xff; /* only 8 bit SCSI status */
524 if (rq->sense_len && rq->sense) {
525 bytes = (OMAX_SB_LEN > rq->sense_len) ?
526 rq->sense_len : OMAX_SB_LEN;
527 if (copy_to_user(sic->data, rq->sense, bytes))
531 if (copy_to_user(sic->data, buffer, out_len))
540 EXPORT_SYMBOL_GPL(sg_scsi_ioctl);
542 /* Send basic block requests */
543 static int __blk_send_generic(struct request_queue *q, struct gendisk *bd_disk,
549 rq = blk_get_request(q, WRITE, __GFP_WAIT);
550 rq->cmd_type = REQ_TYPE_BLOCK_PC;
551 rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
555 err = blk_execute_rq(q, bd_disk, rq, 0);
561 static inline int blk_send_start_stop(struct request_queue *q,
562 struct gendisk *bd_disk, int data)
564 return __blk_send_generic(q, bd_disk, GPCMD_START_STOP_UNIT, data);
567 int scsi_cmd_ioctl(struct request_queue *q, struct gendisk *bd_disk, fmode_t mode,
568 unsigned int cmd, void __user *arg)
579 case SG_GET_VERSION_NUM:
580 err = sg_get_version(arg);
582 case SCSI_IOCTL_GET_IDLUN:
583 err = scsi_get_idlun(q, arg);
585 case SCSI_IOCTL_GET_BUS_NUMBER:
586 err = scsi_get_bus(q, arg);
589 err = sg_set_timeout(q, arg);
592 err = sg_get_timeout(q);
594 case SG_GET_RESERVED_SIZE:
595 err = sg_get_reserved_size(q, arg);
597 case SG_SET_RESERVED_SIZE:
598 err = sg_set_reserved_size(q, arg);
600 case SG_EMULATED_HOST:
601 err = sg_emulated_host(q, arg);
604 struct sg_io_hdr hdr;
607 if (copy_from_user(&hdr, arg, sizeof(hdr)))
609 err = sg_io(q, bd_disk, &hdr, mode);
613 if (copy_to_user(arg, &hdr, sizeof(hdr)))
617 case CDROM_SEND_PACKET: {
618 struct cdrom_generic_command cgc;
619 struct sg_io_hdr hdr;
622 if (copy_from_user(&cgc, arg, sizeof(cgc)))
624 cgc.timeout = clock_t_to_jiffies(cgc.timeout);
625 memset(&hdr, 0, sizeof(hdr));
626 hdr.interface_id = 'S';
627 hdr.cmd_len = sizeof(cgc.cmd);
628 hdr.dxfer_len = cgc.buflen;
630 switch (cgc.data_direction) {
631 case CGC_DATA_UNKNOWN:
632 hdr.dxfer_direction = SG_DXFER_UNKNOWN;
635 hdr.dxfer_direction = SG_DXFER_TO_DEV;
638 hdr.dxfer_direction = SG_DXFER_FROM_DEV;
641 hdr.dxfer_direction = SG_DXFER_NONE;
649 hdr.dxferp = cgc.buffer;
652 hdr.mx_sb_len = sizeof(struct request_sense);
653 hdr.timeout = jiffies_to_msecs(cgc.timeout);
654 hdr.cmdp = ((struct cdrom_generic_command __user*) arg)->cmd;
655 hdr.cmd_len = sizeof(cgc.cmd);
657 err = sg_io(q, bd_disk, &hdr, mode);
665 cgc.buflen = hdr.resid;
666 if (copy_to_user(arg, &cgc, sizeof(cgc)))
673 * old junk scsi send command ioctl
675 case SCSI_IOCTL_SEND_COMMAND:
676 printk(KERN_WARNING "program %s is using a deprecated SCSI ioctl, please convert it to SG_IO\n", current->comm);
681 err = sg_scsi_ioctl(q, bd_disk, mode, arg);
684 err = blk_send_start_stop(q, bd_disk, 0x03);
687 err = blk_send_start_stop(q, bd_disk, 0x02);
695 EXPORT_SYMBOL(scsi_cmd_ioctl);
697 int scsi_verify_blk_ioctl(struct block_device *bd, unsigned int cmd)
699 if (bd && bd == bd->bd_contains)
702 /* Actually none of these is particularly useful on a partition,
706 case SCSI_IOCTL_GET_IDLUN:
707 case SCSI_IOCTL_GET_BUS_NUMBER:
708 case SCSI_IOCTL_GET_PCI:
709 case SCSI_IOCTL_PROBE_HOST:
710 case SG_GET_VERSION_NUM:
713 case SG_GET_RESERVED_SIZE:
714 case SG_SET_RESERVED_SIZE:
715 case SG_EMULATED_HOST:
719 case CDROM_GET_CAPABILITY:
720 case CDROM_DRIVE_STATUS:
725 case 0x801c6d02: /* MTIOCGET32 */
727 /* Keep this until we remove the printk below. udev sends it
728 * and we do not want to spam dmesg about it. CD-ROMs do
729 * not have partitions, so we get here only for disks.
736 /* In particular, rule out all resets and host-specific ioctls. */
737 printk_ratelimited(KERN_WARNING
738 "%s: sending ioctl %x to a partition!\n", current->comm, cmd);
740 return capable(CAP_SYS_RAWIO) ? 0 : -ENOTTY;
742 EXPORT_SYMBOL(scsi_verify_blk_ioctl);
744 int scsi_cmd_blk_ioctl(struct block_device *bd, fmode_t mode,
745 unsigned int cmd, void __user *arg)
749 ret = scsi_verify_blk_ioctl(bd, cmd);
753 return scsi_cmd_ioctl(bd->bd_disk->queue, bd->bd_disk, mode, cmd, arg);
755 EXPORT_SYMBOL(scsi_cmd_blk_ioctl);
757 static int __init blk_scsi_ioctl_init(void)
759 blk_set_cmd_filter_defaults(&blk_default_cmd_filter);
762 fs_initcall(blk_scsi_ioctl_init);