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>
30 #include <linux/uio.h>
31 #include <linux/uaccess.h>
33 #include <scsi/scsi.h>
34 #include <scsi/scsi_ioctl.h>
35 #include <scsi/scsi_cmnd.h>
37 struct blk_cmd_filter
{
38 unsigned long read_ok
[BLK_SCSI_CMD_PER_LONG
];
39 unsigned long write_ok
[BLK_SCSI_CMD_PER_LONG
];
42 static struct blk_cmd_filter blk_default_cmd_filter
;
44 /* Command group 3 is reserved and should never be used. */
45 const unsigned char scsi_command_size_tbl
[8] =
50 EXPORT_SYMBOL(scsi_command_size_tbl
);
54 static int sg_get_version(int __user
*p
)
56 static const int sg_version_num
= 30527;
57 return put_user(sg_version_num
, p
);
60 static int scsi_get_idlun(struct request_queue
*q
, int __user
*p
)
62 return put_user(0, p
);
65 static int scsi_get_bus(struct request_queue
*q
, int __user
*p
)
67 return put_user(0, p
);
70 static int sg_get_timeout(struct request_queue
*q
)
72 return jiffies_to_clock_t(q
->sg_timeout
);
75 static int sg_set_timeout(struct request_queue
*q
, int __user
*p
)
77 int timeout
, err
= get_user(timeout
, p
);
80 q
->sg_timeout
= clock_t_to_jiffies(timeout
);
85 static int max_sectors_bytes(struct request_queue
*q
)
87 unsigned int max_sectors
= queue_max_sectors(q
);
89 max_sectors
= min_t(unsigned int, max_sectors
, INT_MAX
>> 9);
91 return max_sectors
<< 9;
94 static int sg_get_reserved_size(struct request_queue
*q
, int __user
*p
)
96 int val
= min_t(int, q
->sg_reserved_size
, max_sectors_bytes(q
));
98 return put_user(val
, p
);
101 static int sg_set_reserved_size(struct request_queue
*q
, int __user
*p
)
103 int size
, err
= get_user(size
, p
);
111 q
->sg_reserved_size
= min(size
, max_sectors_bytes(q
));
116 * will always return that we are ATAPI even for a real SCSI drive, I'm not
117 * so sure this is worth doing anything about (why would you care??)
119 static int sg_emulated_host(struct request_queue
*q
, int __user
*p
)
121 return put_user(1, p
);
124 static void blk_set_cmd_filter_defaults(struct blk_cmd_filter
*filter
)
126 /* Basic read-only commands */
127 __set_bit(TEST_UNIT_READY
, filter
->read_ok
);
128 __set_bit(REQUEST_SENSE
, filter
->read_ok
);
129 __set_bit(READ_6
, filter
->read_ok
);
130 __set_bit(READ_10
, filter
->read_ok
);
131 __set_bit(READ_12
, filter
->read_ok
);
132 __set_bit(READ_16
, filter
->read_ok
);
133 __set_bit(READ_BUFFER
, filter
->read_ok
);
134 __set_bit(READ_DEFECT_DATA
, filter
->read_ok
);
135 __set_bit(READ_CAPACITY
, filter
->read_ok
);
136 __set_bit(READ_LONG
, filter
->read_ok
);
137 __set_bit(INQUIRY
, filter
->read_ok
);
138 __set_bit(MODE_SENSE
, filter
->read_ok
);
139 __set_bit(MODE_SENSE_10
, filter
->read_ok
);
140 __set_bit(LOG_SENSE
, filter
->read_ok
);
141 __set_bit(START_STOP
, filter
->read_ok
);
142 __set_bit(GPCMD_VERIFY_10
, filter
->read_ok
);
143 __set_bit(VERIFY_16
, filter
->read_ok
);
144 __set_bit(REPORT_LUNS
, filter
->read_ok
);
145 __set_bit(SERVICE_ACTION_IN_16
, filter
->read_ok
);
146 __set_bit(RECEIVE_DIAGNOSTIC
, filter
->read_ok
);
147 __set_bit(MAINTENANCE_IN
, filter
->read_ok
);
148 __set_bit(GPCMD_READ_BUFFER_CAPACITY
, filter
->read_ok
);
150 /* Audio CD commands */
151 __set_bit(GPCMD_PLAY_CD
, filter
->read_ok
);
152 __set_bit(GPCMD_PLAY_AUDIO_10
, filter
->read_ok
);
153 __set_bit(GPCMD_PLAY_AUDIO_MSF
, filter
->read_ok
);
154 __set_bit(GPCMD_PLAY_AUDIO_TI
, filter
->read_ok
);
155 __set_bit(GPCMD_PAUSE_RESUME
, filter
->read_ok
);
157 /* CD/DVD data reading */
158 __set_bit(GPCMD_READ_CD
, filter
->read_ok
);
159 __set_bit(GPCMD_READ_CD_MSF
, filter
->read_ok
);
160 __set_bit(GPCMD_READ_DISC_INFO
, filter
->read_ok
);
161 __set_bit(GPCMD_READ_CDVD_CAPACITY
, filter
->read_ok
);
162 __set_bit(GPCMD_READ_DVD_STRUCTURE
, filter
->read_ok
);
163 __set_bit(GPCMD_READ_HEADER
, filter
->read_ok
);
164 __set_bit(GPCMD_READ_TRACK_RZONE_INFO
, filter
->read_ok
);
165 __set_bit(GPCMD_READ_SUBCHANNEL
, filter
->read_ok
);
166 __set_bit(GPCMD_READ_TOC_PMA_ATIP
, filter
->read_ok
);
167 __set_bit(GPCMD_REPORT_KEY
, filter
->read_ok
);
168 __set_bit(GPCMD_SCAN
, filter
->read_ok
);
169 __set_bit(GPCMD_GET_CONFIGURATION
, filter
->read_ok
);
170 __set_bit(GPCMD_READ_FORMAT_CAPACITIES
, filter
->read_ok
);
171 __set_bit(GPCMD_GET_EVENT_STATUS_NOTIFICATION
, filter
->read_ok
);
172 __set_bit(GPCMD_GET_PERFORMANCE
, filter
->read_ok
);
173 __set_bit(GPCMD_SEEK
, filter
->read_ok
);
174 __set_bit(GPCMD_STOP_PLAY_SCAN
, filter
->read_ok
);
176 /* Basic writing commands */
177 __set_bit(WRITE_6
, filter
->write_ok
);
178 __set_bit(WRITE_10
, filter
->write_ok
);
179 __set_bit(WRITE_VERIFY
, filter
->write_ok
);
180 __set_bit(WRITE_12
, filter
->write_ok
);
181 __set_bit(WRITE_VERIFY_12
, filter
->write_ok
);
182 __set_bit(WRITE_16
, filter
->write_ok
);
183 __set_bit(WRITE_LONG
, filter
->write_ok
);
184 __set_bit(WRITE_LONG_2
, filter
->write_ok
);
185 __set_bit(WRITE_SAME
, filter
->write_ok
);
186 __set_bit(WRITE_SAME_16
, filter
->write_ok
);
187 __set_bit(WRITE_SAME_32
, filter
->write_ok
);
188 __set_bit(ERASE
, filter
->write_ok
);
189 __set_bit(GPCMD_MODE_SELECT_10
, filter
->write_ok
);
190 __set_bit(MODE_SELECT
, filter
->write_ok
);
191 __set_bit(LOG_SELECT
, filter
->write_ok
);
192 __set_bit(GPCMD_BLANK
, filter
->write_ok
);
193 __set_bit(GPCMD_CLOSE_TRACK
, filter
->write_ok
);
194 __set_bit(GPCMD_FLUSH_CACHE
, filter
->write_ok
);
195 __set_bit(GPCMD_FORMAT_UNIT
, filter
->write_ok
);
196 __set_bit(GPCMD_REPAIR_RZONE_TRACK
, filter
->write_ok
);
197 __set_bit(GPCMD_RESERVE_RZONE_TRACK
, filter
->write_ok
);
198 __set_bit(GPCMD_SEND_DVD_STRUCTURE
, filter
->write_ok
);
199 __set_bit(GPCMD_SEND_EVENT
, filter
->write_ok
);
200 __set_bit(GPCMD_SEND_KEY
, filter
->write_ok
);
201 __set_bit(GPCMD_SEND_OPC
, filter
->write_ok
);
202 __set_bit(GPCMD_SEND_CUE_SHEET
, filter
->write_ok
);
203 __set_bit(GPCMD_SET_SPEED
, filter
->write_ok
);
204 __set_bit(GPCMD_PREVENT_ALLOW_MEDIUM_REMOVAL
, filter
->write_ok
);
205 __set_bit(GPCMD_LOAD_UNLOAD
, filter
->write_ok
);
206 __set_bit(GPCMD_SET_STREAMING
, filter
->write_ok
);
207 __set_bit(GPCMD_SET_READ_AHEAD
, filter
->write_ok
);
210 int blk_verify_command(unsigned char *cmd
, fmode_t mode
)
212 struct blk_cmd_filter
*filter
= &blk_default_cmd_filter
;
214 /* root can do any command. */
215 if (capable(CAP_SYS_RAWIO
))
218 /* Anybody who can open the device can do a read-safe command */
219 if (test_bit(cmd
[0], filter
->read_ok
))
222 /* Write-safe commands require a writable open */
223 if (test_bit(cmd
[0], filter
->write_ok
) && (mode
& FMODE_WRITE
))
228 EXPORT_SYMBOL(blk_verify_command
);
230 static int blk_fill_sghdr_rq(struct request_queue
*q
, struct request
*rq
,
231 struct sg_io_hdr
*hdr
, fmode_t mode
)
233 struct scsi_request
*req
= scsi_req(rq
);
235 if (copy_from_user(req
->cmd
, hdr
->cmdp
, hdr
->cmd_len
))
237 if (blk_verify_command(req
->cmd
, mode
))
241 * fill in request structure
243 req
->cmd_len
= hdr
->cmd_len
;
245 rq
->timeout
= msecs_to_jiffies(hdr
->timeout
);
247 rq
->timeout
= q
->sg_timeout
;
249 rq
->timeout
= BLK_DEFAULT_SG_TIMEOUT
;
250 if (rq
->timeout
< BLK_MIN_SG_TIMEOUT
)
251 rq
->timeout
= BLK_MIN_SG_TIMEOUT
;
256 static int blk_complete_sghdr_rq(struct request
*rq
, struct sg_io_hdr
*hdr
,
259 struct scsi_request
*req
= scsi_req(rq
);
263 * fill in all the output members
265 hdr
->status
= req
->result
& 0xff;
266 hdr
->masked_status
= status_byte(req
->result
);
267 hdr
->msg_status
= msg_byte(req
->result
);
268 hdr
->host_status
= host_byte(req
->result
);
269 hdr
->driver_status
= driver_byte(req
->result
);
271 if (hdr
->masked_status
|| hdr
->host_status
|| hdr
->driver_status
)
272 hdr
->info
|= SG_INFO_CHECK
;
273 hdr
->resid
= req
->resid_len
;
276 if (req
->sense_len
&& hdr
->sbp
) {
277 int len
= min((unsigned int) hdr
->mx_sb_len
, req
->sense_len
);
279 if (!copy_to_user(hdr
->sbp
, req
->sense
, len
))
280 hdr
->sb_len_wr
= len
;
285 r
= blk_rq_unmap_user(bio
);
292 static int sg_io(struct request_queue
*q
, struct gendisk
*bd_disk
,
293 struct sg_io_hdr
*hdr
, fmode_t mode
)
295 unsigned long start_time
;
300 struct scsi_request
*req
;
303 if (hdr
->interface_id
!= 'S')
306 if (hdr
->dxfer_len
> (queue_max_hw_sectors(q
) << 9))
310 switch (hdr
->dxfer_direction
) {
313 case SG_DXFER_TO_DEV
:
316 case SG_DXFER_TO_FROM_DEV
:
317 case SG_DXFER_FROM_DEV
:
320 if (hdr
->flags
& SG_FLAG_Q_AT_HEAD
)
324 rq
= blk_get_request(q
, writing
? REQ_OP_SCSI_OUT
: REQ_OP_SCSI_IN
,
330 if (hdr
->cmd_len
> BLK_MAX_CDB
) {
331 req
->cmd
= kzalloc(hdr
->cmd_len
, GFP_KERNEL
);
333 goto out_put_request
;
336 ret
= blk_fill_sghdr_rq(q
, rq
, hdr
, mode
);
341 if (hdr
->iovec_count
) {
343 struct iovec
*iov
= NULL
;
345 ret
= import_iovec(rq_data_dir(rq
),
346 hdr
->dxferp
, hdr
->iovec_count
,
351 /* SG_IO howto says that the shorter of the two wins */
352 iov_iter_truncate(&i
, hdr
->dxfer_len
);
354 ret
= blk_rq_map_user_iov(q
, rq
, NULL
, &i
, GFP_KERNEL
);
356 } else if (hdr
->dxfer_len
)
357 ret
= blk_rq_map_user(q
, rq
, NULL
, hdr
->dxferp
, hdr
->dxfer_len
,
366 start_time
= jiffies
;
368 /* ignore return value. All information is passed back to caller
369 * (if he doesn't check that is his problem).
370 * N.B. a non-zero SCSI status is _not_ necessarily an error.
372 blk_execute_rq(q
, bd_disk
, rq
, at_head
);
374 hdr
->duration
= jiffies_to_msecs(jiffies
- start_time
);
376 ret
= blk_complete_sghdr_rq(rq
, hdr
, bio
);
379 scsi_req_free_cmd(req
);
386 * sg_scsi_ioctl -- handle deprecated SCSI_IOCTL_SEND_COMMAND ioctl
387 * @q: request queue to send scsi commands down
388 * @disk: gendisk to operate on (option)
389 * @mode: mode used to open the file through which the ioctl has been
391 * @sic: userspace structure describing the command to perform
393 * Send down the scsi command described by @sic to the device below
394 * the request queue @q. If @file is non-NULL it's used to perform
395 * fine-grained permission checks that allow users to send down
396 * non-destructive SCSI commands. If the caller has a struct gendisk
397 * available it should be passed in as @disk to allow the low level
398 * driver to use the information contained in it. A non-NULL @disk
399 * is only allowed if the caller knows that the low level driver doesn't
400 * need it (e.g. in the scsi subsystem).
403 * - This interface is deprecated - users should use the SG_IO
404 * interface instead, as this is a more flexible approach to
405 * performing SCSI commands on a device.
406 * - The SCSI command length is determined by examining the 1st byte
407 * of the given command. There is no way to override this.
408 * - Data transfers are limited to PAGE_SIZE
409 * - The length (x + y) must be at least OMAX_SB_LEN bytes long to
410 * accommodate the sense buffer when an error occurs.
411 * The sense buffer is truncated to OMAX_SB_LEN (16) bytes so that
412 * old code will not be surprised.
413 * - If a Unix error occurs (e.g. ENOMEM) then the user will receive
414 * a negative return and the Unix error code in 'errno'.
415 * If the SCSI command succeeds then 0 is returned.
416 * Positive numbers returned are the compacted SCSI error codes (4
417 * bytes in one int) where the lowest byte is the SCSI status.
419 int sg_scsi_ioctl(struct request_queue
*q
, struct gendisk
*disk
, fmode_t mode
,
420 struct scsi_ioctl_command __user
*sic
)
422 enum { OMAX_SB_LEN
= 16 }; /* For backward compatibility */
424 struct scsi_request
*req
;
426 unsigned int in_len
, out_len
, bytes
, opcode
, cmdlen
;
433 * get in an out lengths, verify they don't exceed a page worth of data
435 if (get_user(in_len
, &sic
->inlen
))
437 if (get_user(out_len
, &sic
->outlen
))
439 if (in_len
> PAGE_SIZE
|| out_len
> PAGE_SIZE
)
441 if (get_user(opcode
, sic
->data
))
444 bytes
= max(in_len
, out_len
);
446 buffer
= kzalloc(bytes
, q
->bounce_gfp
| GFP_USER
| __GFP_NOWARN
);
452 rq
= blk_get_request(q
, in_len
? REQ_OP_SCSI_OUT
: REQ_OP_SCSI_IN
,
456 goto error_free_buffer
;
460 cmdlen
= COMMAND_SIZE(opcode
);
463 * get command and data to send to device, if any
466 req
->cmd_len
= cmdlen
;
467 if (copy_from_user(req
->cmd
, sic
->data
, cmdlen
))
470 if (in_len
&& copy_from_user(buffer
, sic
->data
+ cmdlen
, in_len
))
473 err
= blk_verify_command(req
->cmd
, mode
);
477 /* default. possible overriden later */
481 case SEND_DIAGNOSTIC
:
483 rq
->timeout
= FORMAT_UNIT_TIMEOUT
;
487 rq
->timeout
= START_STOP_TIMEOUT
;
490 rq
->timeout
= MOVE_MEDIUM_TIMEOUT
;
492 case READ_ELEMENT_STATUS
:
493 rq
->timeout
= READ_ELEMENT_STATUS_TIMEOUT
;
495 case READ_DEFECT_DATA
:
496 rq
->timeout
= READ_DEFECT_DATA_TIMEOUT
;
500 rq
->timeout
= BLK_DEFAULT_SG_TIMEOUT
;
504 if (bytes
&& blk_rq_map_kern(q
, rq
, buffer
, bytes
, __GFP_RECLAIM
)) {
505 err
= DRIVER_ERROR
<< 24;
509 blk_execute_rq(q
, disk
, rq
, 0);
511 err
= req
->result
& 0xff; /* only 8 bit SCSI status */
513 if (req
->sense_len
&& req
->sense
) {
514 bytes
= (OMAX_SB_LEN
> req
->sense_len
) ?
515 req
->sense_len
: OMAX_SB_LEN
;
516 if (copy_to_user(sic
->data
, req
->sense
, bytes
))
520 if (copy_to_user(sic
->data
, buffer
, out_len
))
532 EXPORT_SYMBOL_GPL(sg_scsi_ioctl
);
534 /* Send basic block requests */
535 static int __blk_send_generic(struct request_queue
*q
, struct gendisk
*bd_disk
,
541 rq
= blk_get_request(q
, REQ_OP_SCSI_OUT
, __GFP_RECLAIM
);
544 rq
->timeout
= BLK_DEFAULT_SG_TIMEOUT
;
545 scsi_req(rq
)->cmd
[0] = cmd
;
546 scsi_req(rq
)->cmd
[4] = data
;
547 scsi_req(rq
)->cmd_len
= 6;
548 blk_execute_rq(q
, bd_disk
, rq
, 0);
549 err
= scsi_req(rq
)->result
? -EIO
: 0;
555 static inline int blk_send_start_stop(struct request_queue
*q
,
556 struct gendisk
*bd_disk
, int data
)
558 return __blk_send_generic(q
, bd_disk
, GPCMD_START_STOP_UNIT
, data
);
561 int scsi_cmd_ioctl(struct request_queue
*q
, struct gendisk
*bd_disk
, fmode_t mode
,
562 unsigned int cmd
, void __user
*arg
)
573 case SG_GET_VERSION_NUM
:
574 err
= sg_get_version(arg
);
576 case SCSI_IOCTL_GET_IDLUN
:
577 err
= scsi_get_idlun(q
, arg
);
579 case SCSI_IOCTL_GET_BUS_NUMBER
:
580 err
= scsi_get_bus(q
, arg
);
583 err
= sg_set_timeout(q
, arg
);
586 err
= sg_get_timeout(q
);
588 case SG_GET_RESERVED_SIZE
:
589 err
= sg_get_reserved_size(q
, arg
);
591 case SG_SET_RESERVED_SIZE
:
592 err
= sg_set_reserved_size(q
, arg
);
594 case SG_EMULATED_HOST
:
595 err
= sg_emulated_host(q
, arg
);
598 struct sg_io_hdr hdr
;
601 if (copy_from_user(&hdr
, arg
, sizeof(hdr
)))
603 err
= sg_io(q
, bd_disk
, &hdr
, mode
);
607 if (copy_to_user(arg
, &hdr
, sizeof(hdr
)))
611 case CDROM_SEND_PACKET
: {
612 struct cdrom_generic_command cgc
;
613 struct sg_io_hdr hdr
;
616 if (copy_from_user(&cgc
, arg
, sizeof(cgc
)))
618 cgc
.timeout
= clock_t_to_jiffies(cgc
.timeout
);
619 memset(&hdr
, 0, sizeof(hdr
));
620 hdr
.interface_id
= 'S';
621 hdr
.cmd_len
= sizeof(cgc
.cmd
);
622 hdr
.dxfer_len
= cgc
.buflen
;
624 switch (cgc
.data_direction
) {
625 case CGC_DATA_UNKNOWN
:
626 hdr
.dxfer_direction
= SG_DXFER_UNKNOWN
;
629 hdr
.dxfer_direction
= SG_DXFER_TO_DEV
;
632 hdr
.dxfer_direction
= SG_DXFER_FROM_DEV
;
635 hdr
.dxfer_direction
= SG_DXFER_NONE
;
643 hdr
.dxferp
= cgc
.buffer
;
646 hdr
.mx_sb_len
= sizeof(struct request_sense
);
647 hdr
.timeout
= jiffies_to_msecs(cgc
.timeout
);
648 hdr
.cmdp
= ((struct cdrom_generic_command __user
*) arg
)->cmd
;
649 hdr
.cmd_len
= sizeof(cgc
.cmd
);
651 err
= sg_io(q
, bd_disk
, &hdr
, mode
);
659 cgc
.buflen
= hdr
.resid
;
660 if (copy_to_user(arg
, &cgc
, sizeof(cgc
)))
667 * old junk scsi send command ioctl
669 case SCSI_IOCTL_SEND_COMMAND
:
670 printk(KERN_WARNING
"program %s is using a deprecated SCSI ioctl, please convert it to SG_IO\n", current
->comm
);
675 err
= sg_scsi_ioctl(q
, bd_disk
, mode
, arg
);
678 err
= blk_send_start_stop(q
, bd_disk
, 0x03);
681 err
= blk_send_start_stop(q
, bd_disk
, 0x02);
689 EXPORT_SYMBOL(scsi_cmd_ioctl
);
691 int scsi_verify_blk_ioctl(struct block_device
*bd
, unsigned int cmd
)
693 if (bd
&& bd
== bd
->bd_contains
)
696 if (capable(CAP_SYS_RAWIO
))
701 EXPORT_SYMBOL(scsi_verify_blk_ioctl
);
703 int scsi_cmd_blk_ioctl(struct block_device
*bd
, fmode_t mode
,
704 unsigned int cmd
, void __user
*arg
)
708 ret
= scsi_verify_blk_ioctl(bd
, cmd
);
712 return scsi_cmd_ioctl(bd
->bd_disk
->queue
, bd
->bd_disk
, mode
, cmd
, arg
);
714 EXPORT_SYMBOL(scsi_cmd_blk_ioctl
);
717 * scsi_req_init - initialize certain fields of a scsi_request structure
718 * @req: Pointer to a scsi_request structure.
719 * Initializes .__cmd[], .cmd, .cmd_len and .sense_len but no other members
720 * of struct scsi_request.
722 void scsi_req_init(struct scsi_request
*req
)
724 memset(req
->__cmd
, 0, sizeof(req
->__cmd
));
725 req
->cmd
= req
->__cmd
;
726 req
->cmd_len
= BLK_MAX_CDB
;
729 EXPORT_SYMBOL(scsi_req_init
);
731 static int __init
blk_scsi_ioctl_init(void)
733 blk_set_cmd_filter_defaults(&blk_default_cmd_filter
);
736 fs_initcall(blk_scsi_ioctl_init
);