1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (C) 2001 Jens Axboe <axboe@suse.de>
5 #include <linux/kernel.h>
6 #include <linux/errno.h>
7 #include <linux/string.h>
8 #include <linux/module.h>
9 #include <linux/blkdev.h>
10 #include <linux/capability.h>
11 #include <linux/completion.h>
12 #include <linux/cdrom.h>
13 #include <linux/ratelimit.h>
14 #include <linux/slab.h>
15 #include <linux/times.h>
16 #include <linux/uio.h>
17 #include <linux/uaccess.h>
19 #include <scsi/scsi.h>
20 #include <scsi/scsi_ioctl.h>
21 #include <scsi/scsi_cmnd.h>
23 struct blk_cmd_filter {
24 unsigned long read_ok[BLK_SCSI_CMD_PER_LONG];
25 unsigned long write_ok[BLK_SCSI_CMD_PER_LONG];
28 static struct blk_cmd_filter blk_default_cmd_filter;
30 /* Command group 3 is reserved and should never be used. */
31 const unsigned char scsi_command_size_tbl[8] =
36 EXPORT_SYMBOL(scsi_command_size_tbl);
40 static int sg_get_version(int __user *p)
42 static const int sg_version_num = 30527;
43 return put_user(sg_version_num, p);
46 static int scsi_get_idlun(struct request_queue *q, int __user *p)
48 return put_user(0, p);
51 static int scsi_get_bus(struct request_queue *q, int __user *p)
53 return put_user(0, p);
56 static int sg_get_timeout(struct request_queue *q)
58 return jiffies_to_clock_t(q->sg_timeout);
61 static int sg_set_timeout(struct request_queue *q, int __user *p)
63 int timeout, err = get_user(timeout, p);
66 q->sg_timeout = clock_t_to_jiffies(timeout);
71 static int max_sectors_bytes(struct request_queue *q)
73 unsigned int max_sectors = queue_max_sectors(q);
75 max_sectors = min_t(unsigned int, max_sectors, INT_MAX >> 9);
77 return max_sectors << 9;
80 static int sg_get_reserved_size(struct request_queue *q, int __user *p)
82 int val = min_t(int, q->sg_reserved_size, max_sectors_bytes(q));
84 return put_user(val, p);
87 static int sg_set_reserved_size(struct request_queue *q, int __user *p)
89 int size, err = get_user(size, p);
97 q->sg_reserved_size = min(size, max_sectors_bytes(q));
102 * will always return that we are ATAPI even for a real SCSI drive, I'm not
103 * so sure this is worth doing anything about (why would you care??)
105 static int sg_emulated_host(struct request_queue *q, int __user *p)
107 return put_user(1, p);
110 static void blk_set_cmd_filter_defaults(struct blk_cmd_filter *filter)
112 /* Basic read-only commands */
113 __set_bit(TEST_UNIT_READY, filter->read_ok);
114 __set_bit(REQUEST_SENSE, filter->read_ok);
115 __set_bit(READ_6, filter->read_ok);
116 __set_bit(READ_10, filter->read_ok);
117 __set_bit(READ_12, filter->read_ok);
118 __set_bit(READ_16, filter->read_ok);
119 __set_bit(READ_BUFFER, filter->read_ok);
120 __set_bit(READ_DEFECT_DATA, filter->read_ok);
121 __set_bit(READ_CAPACITY, filter->read_ok);
122 __set_bit(READ_LONG, filter->read_ok);
123 __set_bit(INQUIRY, filter->read_ok);
124 __set_bit(MODE_SENSE, filter->read_ok);
125 __set_bit(MODE_SENSE_10, filter->read_ok);
126 __set_bit(LOG_SENSE, filter->read_ok);
127 __set_bit(START_STOP, filter->read_ok);
128 __set_bit(GPCMD_VERIFY_10, filter->read_ok);
129 __set_bit(VERIFY_16, filter->read_ok);
130 __set_bit(REPORT_LUNS, filter->read_ok);
131 __set_bit(SERVICE_ACTION_IN_16, filter->read_ok);
132 __set_bit(RECEIVE_DIAGNOSTIC, filter->read_ok);
133 __set_bit(MAINTENANCE_IN, filter->read_ok);
134 __set_bit(GPCMD_READ_BUFFER_CAPACITY, filter->read_ok);
136 /* Audio CD commands */
137 __set_bit(GPCMD_PLAY_CD, filter->read_ok);
138 __set_bit(GPCMD_PLAY_AUDIO_10, filter->read_ok);
139 __set_bit(GPCMD_PLAY_AUDIO_MSF, filter->read_ok);
140 __set_bit(GPCMD_PLAY_AUDIO_TI, filter->read_ok);
141 __set_bit(GPCMD_PAUSE_RESUME, filter->read_ok);
143 /* CD/DVD data reading */
144 __set_bit(GPCMD_READ_CD, filter->read_ok);
145 __set_bit(GPCMD_READ_CD_MSF, filter->read_ok);
146 __set_bit(GPCMD_READ_DISC_INFO, filter->read_ok);
147 __set_bit(GPCMD_READ_CDVD_CAPACITY, filter->read_ok);
148 __set_bit(GPCMD_READ_DVD_STRUCTURE, filter->read_ok);
149 __set_bit(GPCMD_READ_HEADER, filter->read_ok);
150 __set_bit(GPCMD_READ_TRACK_RZONE_INFO, filter->read_ok);
151 __set_bit(GPCMD_READ_SUBCHANNEL, filter->read_ok);
152 __set_bit(GPCMD_READ_TOC_PMA_ATIP, filter->read_ok);
153 __set_bit(GPCMD_REPORT_KEY, filter->read_ok);
154 __set_bit(GPCMD_SCAN, filter->read_ok);
155 __set_bit(GPCMD_GET_CONFIGURATION, filter->read_ok);
156 __set_bit(GPCMD_READ_FORMAT_CAPACITIES, filter->read_ok);
157 __set_bit(GPCMD_GET_EVENT_STATUS_NOTIFICATION, filter->read_ok);
158 __set_bit(GPCMD_GET_PERFORMANCE, filter->read_ok);
159 __set_bit(GPCMD_SEEK, filter->read_ok);
160 __set_bit(GPCMD_STOP_PLAY_SCAN, filter->read_ok);
162 /* Basic writing commands */
163 __set_bit(WRITE_6, filter->write_ok);
164 __set_bit(WRITE_10, filter->write_ok);
165 __set_bit(WRITE_VERIFY, filter->write_ok);
166 __set_bit(WRITE_12, filter->write_ok);
167 __set_bit(WRITE_VERIFY_12, filter->write_ok);
168 __set_bit(WRITE_16, filter->write_ok);
169 __set_bit(WRITE_LONG, filter->write_ok);
170 __set_bit(WRITE_LONG_2, filter->write_ok);
171 __set_bit(WRITE_SAME, filter->write_ok);
172 __set_bit(WRITE_SAME_16, filter->write_ok);
173 __set_bit(WRITE_SAME_32, filter->write_ok);
174 __set_bit(ERASE, filter->write_ok);
175 __set_bit(GPCMD_MODE_SELECT_10, filter->write_ok);
176 __set_bit(MODE_SELECT, filter->write_ok);
177 __set_bit(LOG_SELECT, filter->write_ok);
178 __set_bit(GPCMD_BLANK, filter->write_ok);
179 __set_bit(GPCMD_CLOSE_TRACK, filter->write_ok);
180 __set_bit(GPCMD_FLUSH_CACHE, filter->write_ok);
181 __set_bit(GPCMD_FORMAT_UNIT, filter->write_ok);
182 __set_bit(GPCMD_REPAIR_RZONE_TRACK, filter->write_ok);
183 __set_bit(GPCMD_RESERVE_RZONE_TRACK, filter->write_ok);
184 __set_bit(GPCMD_SEND_DVD_STRUCTURE, filter->write_ok);
185 __set_bit(GPCMD_SEND_EVENT, filter->write_ok);
186 __set_bit(GPCMD_SEND_KEY, filter->write_ok);
187 __set_bit(GPCMD_SEND_OPC, filter->write_ok);
188 __set_bit(GPCMD_SEND_CUE_SHEET, filter->write_ok);
189 __set_bit(GPCMD_SET_SPEED, filter->write_ok);
190 __set_bit(GPCMD_PREVENT_ALLOW_MEDIUM_REMOVAL, filter->write_ok);
191 __set_bit(GPCMD_LOAD_UNLOAD, filter->write_ok);
192 __set_bit(GPCMD_SET_STREAMING, filter->write_ok);
193 __set_bit(GPCMD_SET_READ_AHEAD, filter->write_ok);
196 int blk_verify_command(unsigned char *cmd, fmode_t mode)
198 struct blk_cmd_filter *filter = &blk_default_cmd_filter;
200 /* root can do any command. */
201 if (capable(CAP_SYS_RAWIO))
204 /* Anybody who can open the device can do a read-safe command */
205 if (test_bit(cmd[0], filter->read_ok))
208 /* Write-safe commands require a writable open */
209 if (test_bit(cmd[0], filter->write_ok) && (mode & FMODE_WRITE))
214 EXPORT_SYMBOL(blk_verify_command);
216 static int blk_fill_sghdr_rq(struct request_queue *q, struct request *rq,
217 struct sg_io_hdr *hdr, fmode_t mode)
219 struct scsi_request *req = scsi_req(rq);
221 if (copy_from_user(req->cmd, hdr->cmdp, hdr->cmd_len))
223 if (blk_verify_command(req->cmd, mode))
227 * fill in request structure
229 req->cmd_len = hdr->cmd_len;
231 rq->timeout = msecs_to_jiffies(hdr->timeout);
233 rq->timeout = q->sg_timeout;
235 rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
236 if (rq->timeout < BLK_MIN_SG_TIMEOUT)
237 rq->timeout = BLK_MIN_SG_TIMEOUT;
242 static int blk_complete_sghdr_rq(struct request *rq, struct sg_io_hdr *hdr,
245 struct scsi_request *req = scsi_req(rq);
249 * fill in all the output members
251 hdr->status = req->result & 0xff;
252 hdr->masked_status = status_byte(req->result);
253 hdr->msg_status = msg_byte(req->result);
254 hdr->host_status = host_byte(req->result);
255 hdr->driver_status = driver_byte(req->result);
257 if (hdr->masked_status || hdr->host_status || hdr->driver_status)
258 hdr->info |= SG_INFO_CHECK;
259 hdr->resid = req->resid_len;
262 if (req->sense_len && hdr->sbp) {
263 int len = min((unsigned int) hdr->mx_sb_len, req->sense_len);
265 if (!copy_to_user(hdr->sbp, req->sense, len))
266 hdr->sb_len_wr = len;
271 r = blk_rq_unmap_user(bio);
278 static int sg_io(struct request_queue *q, struct gendisk *bd_disk,
279 struct sg_io_hdr *hdr, fmode_t mode)
281 unsigned long start_time;
286 struct scsi_request *req;
289 if (hdr->interface_id != 'S')
292 if (hdr->dxfer_len > (queue_max_hw_sectors(q) << 9))
296 switch (hdr->dxfer_direction) {
299 case SG_DXFER_TO_DEV:
302 case SG_DXFER_TO_FROM_DEV:
303 case SG_DXFER_FROM_DEV:
306 if (hdr->flags & SG_FLAG_Q_AT_HEAD)
310 rq = blk_get_request(q, writing ? REQ_OP_SCSI_OUT : REQ_OP_SCSI_IN, 0);
315 if (hdr->cmd_len > BLK_MAX_CDB) {
316 req->cmd = kzalloc(hdr->cmd_len, GFP_KERNEL);
318 goto out_put_request;
321 ret = blk_fill_sghdr_rq(q, rq, hdr, mode);
326 if (hdr->iovec_count) {
328 struct iovec *iov = NULL;
330 ret = import_iovec(rq_data_dir(rq),
331 hdr->dxferp, hdr->iovec_count,
336 /* SG_IO howto says that the shorter of the two wins */
337 iov_iter_truncate(&i, hdr->dxfer_len);
339 ret = blk_rq_map_user_iov(q, rq, NULL, &i, GFP_KERNEL);
341 } else if (hdr->dxfer_len)
342 ret = blk_rq_map_user(q, rq, NULL, hdr->dxferp, hdr->dxfer_len,
351 start_time = jiffies;
353 /* ignore return value. All information is passed back to caller
354 * (if he doesn't check that is his problem).
355 * N.B. a non-zero SCSI status is _not_ necessarily an error.
357 blk_execute_rq(q, bd_disk, rq, at_head);
359 hdr->duration = jiffies_to_msecs(jiffies - start_time);
361 ret = blk_complete_sghdr_rq(rq, hdr, bio);
364 scsi_req_free_cmd(req);
371 * sg_scsi_ioctl -- handle deprecated SCSI_IOCTL_SEND_COMMAND ioctl
372 * @q: request queue to send scsi commands down
373 * @disk: gendisk to operate on (option)
374 * @mode: mode used to open the file through which the ioctl has been
376 * @sic: userspace structure describing the command to perform
378 * Send down the scsi command described by @sic to the device below
379 * the request queue @q. If @file is non-NULL it's used to perform
380 * fine-grained permission checks that allow users to send down
381 * non-destructive SCSI commands. If the caller has a struct gendisk
382 * available it should be passed in as @disk to allow the low level
383 * driver to use the information contained in it. A non-NULL @disk
384 * is only allowed if the caller knows that the low level driver doesn't
385 * need it (e.g. in the scsi subsystem).
388 * - This interface is deprecated - users should use the SG_IO
389 * interface instead, as this is a more flexible approach to
390 * performing SCSI commands on a device.
391 * - The SCSI command length is determined by examining the 1st byte
392 * of the given command. There is no way to override this.
393 * - Data transfers are limited to PAGE_SIZE
394 * - The length (x + y) must be at least OMAX_SB_LEN bytes long to
395 * accommodate the sense buffer when an error occurs.
396 * The sense buffer is truncated to OMAX_SB_LEN (16) bytes so that
397 * old code will not be surprised.
398 * - If a Unix error occurs (e.g. ENOMEM) then the user will receive
399 * a negative return and the Unix error code in 'errno'.
400 * If the SCSI command succeeds then 0 is returned.
401 * Positive numbers returned are the compacted SCSI error codes (4
402 * bytes in one int) where the lowest byte is the SCSI status.
404 int sg_scsi_ioctl(struct request_queue *q, struct gendisk *disk, fmode_t mode,
405 struct scsi_ioctl_command __user *sic)
407 enum { OMAX_SB_LEN = 16 }; /* For backward compatibility */
409 struct scsi_request *req;
411 unsigned int in_len, out_len, bytes, opcode, cmdlen;
418 * get in an out lengths, verify they don't exceed a page worth of data
420 if (get_user(in_len, &sic->inlen))
422 if (get_user(out_len, &sic->outlen))
424 if (in_len > PAGE_SIZE || out_len > PAGE_SIZE)
426 if (get_user(opcode, sic->data))
429 bytes = max(in_len, out_len);
431 buffer = kzalloc(bytes, q->bounce_gfp | GFP_USER| __GFP_NOWARN);
437 rq = blk_get_request(q, in_len ? REQ_OP_SCSI_OUT : REQ_OP_SCSI_IN, 0);
440 goto error_free_buffer;
444 cmdlen = COMMAND_SIZE(opcode);
447 * get command and data to send to device, if any
450 req->cmd_len = cmdlen;
451 if (copy_from_user(req->cmd, sic->data, cmdlen))
454 if (in_len && copy_from_user(buffer, sic->data + cmdlen, in_len))
457 err = blk_verify_command(req->cmd, mode);
461 /* default. possible overriden later */
465 case SEND_DIAGNOSTIC:
467 rq->timeout = FORMAT_UNIT_TIMEOUT;
471 rq->timeout = START_STOP_TIMEOUT;
474 rq->timeout = MOVE_MEDIUM_TIMEOUT;
476 case READ_ELEMENT_STATUS:
477 rq->timeout = READ_ELEMENT_STATUS_TIMEOUT;
479 case READ_DEFECT_DATA:
480 rq->timeout = READ_DEFECT_DATA_TIMEOUT;
484 rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
488 if (bytes && blk_rq_map_kern(q, rq, buffer, bytes, GFP_NOIO)) {
489 err = DRIVER_ERROR << 24;
493 blk_execute_rq(q, disk, rq, 0);
495 err = req->result & 0xff; /* only 8 bit SCSI status */
497 if (req->sense_len && req->sense) {
498 bytes = (OMAX_SB_LEN > req->sense_len) ?
499 req->sense_len : OMAX_SB_LEN;
500 if (copy_to_user(sic->data, req->sense, bytes))
504 if (copy_to_user(sic->data, buffer, out_len))
516 EXPORT_SYMBOL_GPL(sg_scsi_ioctl);
518 /* Send basic block requests */
519 static int __blk_send_generic(struct request_queue *q, struct gendisk *bd_disk,
525 rq = blk_get_request(q, REQ_OP_SCSI_OUT, 0);
528 rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
529 scsi_req(rq)->cmd[0] = cmd;
530 scsi_req(rq)->cmd[4] = data;
531 scsi_req(rq)->cmd_len = 6;
532 blk_execute_rq(q, bd_disk, rq, 0);
533 err = scsi_req(rq)->result ? -EIO : 0;
539 static inline int blk_send_start_stop(struct request_queue *q,
540 struct gendisk *bd_disk, int data)
542 return __blk_send_generic(q, bd_disk, GPCMD_START_STOP_UNIT, data);
545 int scsi_cmd_ioctl(struct request_queue *q, struct gendisk *bd_disk, fmode_t mode,
546 unsigned int cmd, void __user *arg)
557 case SG_GET_VERSION_NUM:
558 err = sg_get_version(arg);
560 case SCSI_IOCTL_GET_IDLUN:
561 err = scsi_get_idlun(q, arg);
563 case SCSI_IOCTL_GET_BUS_NUMBER:
564 err = scsi_get_bus(q, arg);
567 err = sg_set_timeout(q, arg);
570 err = sg_get_timeout(q);
572 case SG_GET_RESERVED_SIZE:
573 err = sg_get_reserved_size(q, arg);
575 case SG_SET_RESERVED_SIZE:
576 err = sg_set_reserved_size(q, arg);
578 case SG_EMULATED_HOST:
579 err = sg_emulated_host(q, arg);
582 struct sg_io_hdr hdr;
585 if (copy_from_user(&hdr, arg, sizeof(hdr)))
587 err = sg_io(q, bd_disk, &hdr, mode);
591 if (copy_to_user(arg, &hdr, sizeof(hdr)))
595 case CDROM_SEND_PACKET: {
596 struct cdrom_generic_command cgc;
597 struct sg_io_hdr hdr;
600 if (copy_from_user(&cgc, arg, sizeof(cgc)))
602 cgc.timeout = clock_t_to_jiffies(cgc.timeout);
603 memset(&hdr, 0, sizeof(hdr));
604 hdr.interface_id = 'S';
605 hdr.cmd_len = sizeof(cgc.cmd);
606 hdr.dxfer_len = cgc.buflen;
608 switch (cgc.data_direction) {
609 case CGC_DATA_UNKNOWN:
610 hdr.dxfer_direction = SG_DXFER_UNKNOWN;
613 hdr.dxfer_direction = SG_DXFER_TO_DEV;
616 hdr.dxfer_direction = SG_DXFER_FROM_DEV;
619 hdr.dxfer_direction = SG_DXFER_NONE;
627 hdr.dxferp = cgc.buffer;
630 hdr.mx_sb_len = sizeof(struct request_sense);
631 hdr.timeout = jiffies_to_msecs(cgc.timeout);
632 hdr.cmdp = ((struct cdrom_generic_command __user*) arg)->cmd;
633 hdr.cmd_len = sizeof(cgc.cmd);
635 err = sg_io(q, bd_disk, &hdr, mode);
643 cgc.buflen = hdr.resid;
644 if (copy_to_user(arg, &cgc, sizeof(cgc)))
651 * old junk scsi send command ioctl
653 case SCSI_IOCTL_SEND_COMMAND:
654 printk(KERN_WARNING "program %s is using a deprecated SCSI ioctl, please convert it to SG_IO\n", current->comm);
659 err = sg_scsi_ioctl(q, bd_disk, mode, arg);
662 err = blk_send_start_stop(q, bd_disk, 0x03);
665 err = blk_send_start_stop(q, bd_disk, 0x02);
673 EXPORT_SYMBOL(scsi_cmd_ioctl);
675 int scsi_verify_blk_ioctl(struct block_device *bd, unsigned int cmd)
677 if (bd && bd == bd->bd_contains)
680 if (capable(CAP_SYS_RAWIO))
685 EXPORT_SYMBOL(scsi_verify_blk_ioctl);
687 int scsi_cmd_blk_ioctl(struct block_device *bd, fmode_t mode,
688 unsigned int cmd, void __user *arg)
692 ret = scsi_verify_blk_ioctl(bd, cmd);
696 return scsi_cmd_ioctl(bd->bd_disk->queue, bd->bd_disk, mode, cmd, arg);
698 EXPORT_SYMBOL(scsi_cmd_blk_ioctl);
701 * scsi_req_init - initialize certain fields of a scsi_request structure
702 * @req: Pointer to a scsi_request structure.
703 * Initializes .__cmd[], .cmd, .cmd_len and .sense_len but no other members
704 * of struct scsi_request.
706 void scsi_req_init(struct scsi_request *req)
708 memset(req->__cmd, 0, sizeof(req->__cmd));
709 req->cmd = req->__cmd;
710 req->cmd_len = BLK_MAX_CDB;
713 EXPORT_SYMBOL(scsi_req_init);
715 static int __init blk_scsi_ioctl_init(void)
717 blk_set_cmd_filter_defaults(&blk_default_cmd_filter);
720 fs_initcall(blk_scsi_ioctl_init);