blob: 51bf5155ee756a4ac479e9c49fcf88824b0aeedc [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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>
Randy.Dunlapc59ede72006-01-11 12:17:46 -080024#include <linux/capability.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/completion.h>
26#include <linux/cdrom.h>
Paolo Bonzini0bfc96c2012-01-12 16:01:28 +010027#include <linux/ratelimit.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/slab.h>
29#include <linux/times.h>
Kent Overstreeta27bb332013-05-07 16:19:08 -070030#include <linux/uio.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#include <asm/uaccess.h>
32
33#include <scsi/scsi.h>
34#include <scsi/scsi_ioctl.h>
35#include <scsi/scsi_cmnd.h>
36
Jens Axboe018e0442009-06-26 16:27:10 +020037struct blk_cmd_filter {
38 unsigned long read_ok[BLK_SCSI_CMD_PER_LONG];
39 unsigned long write_ok[BLK_SCSI_CMD_PER_LONG];
H Hartley Sweeten476d42f2009-11-04 09:10:33 +010040};
41
42static struct blk_cmd_filter blk_default_cmd_filter;
Jens Axboe018e0442009-06-26 16:27:10 +020043
Linus Torvalds1da177e2005-04-16 15:20:36 -070044/* Command group 3 is reserved and should never be used. */
Boaz Harroshdb4742d2008-04-30 11:27:26 +030045const unsigned char scsi_command_size_tbl[8] =
Linus Torvalds1da177e2005-04-16 15:20:36 -070046{
47 6, 10, 10, 12,
48 16, 12, 10, 10
49};
Boaz Harroshdb4742d2008-04-30 11:27:26 +030050EXPORT_SYMBOL(scsi_command_size_tbl);
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
Linus Torvalds1da177e2005-04-16 15:20:36 -070052#include <scsi/sg.h>
53
54static int sg_get_version(int __user *p)
55{
Arjan van de Ven64100092006-01-06 09:46:02 +010056 static const int sg_version_num = 30527;
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 return put_user(sg_version_num, p);
58}
59
Jens Axboe165125e2007-07-24 09:28:11 +020060static int scsi_get_idlun(struct request_queue *q, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -070061{
62 return put_user(0, p);
63}
64
Jens Axboe165125e2007-07-24 09:28:11 +020065static int scsi_get_bus(struct request_queue *q, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -070066{
67 return put_user(0, p);
68}
69
Jens Axboe165125e2007-07-24 09:28:11 +020070static int sg_get_timeout(struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -070071{
Milton Miller2b91baf2008-11-17 13:10:34 +010072 return jiffies_to_clock_t(q->sg_timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -070073}
74
Jens Axboe165125e2007-07-24 09:28:11 +020075static int sg_set_timeout(struct request_queue *q, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -070076{
77 int timeout, err = get_user(timeout, p);
78
79 if (!err)
Milton Miller2b91baf2008-11-17 13:10:34 +010080 q->sg_timeout = clock_t_to_jiffies(timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -070081
82 return err;
83}
84
Akinobu Mita9b4231b2014-05-25 21:43:34 +090085static int max_sectors_bytes(struct request_queue *q)
86{
87 unsigned int max_sectors = queue_max_sectors(q);
88
89 max_sectors = min_t(unsigned int, max_sectors, INT_MAX >> 9);
90
91 return max_sectors << 9;
92}
93
Jens Axboe165125e2007-07-24 09:28:11 +020094static int sg_get_reserved_size(struct request_queue *q, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -070095{
Akinobu Mita9b4231b2014-05-25 21:43:34 +090096 int val = min_t(int, q->sg_reserved_size, max_sectors_bytes(q));
Alan Stern44ec9542007-02-20 11:01:57 -050097
98 return put_user(val, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -070099}
100
Jens Axboe165125e2007-07-24 09:28:11 +0200101static int sg_set_reserved_size(struct request_queue *q, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102{
103 int size, err = get_user(size, p);
104
105 if (err)
106 return err;
107
108 if (size < 0)
109 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110
Akinobu Mita9b4231b2014-05-25 21:43:34 +0900111 q->sg_reserved_size = min(size, max_sectors_bytes(q));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112 return 0;
113}
114
115/*
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??)
118 */
Jens Axboe165125e2007-07-24 09:28:11 +0200119static int sg_emulated_host(struct request_queue *q, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120{
121 return put_user(1, p);
122}
123
Jens Axboe018e0442009-06-26 16:27:10 +0200124static void blk_set_cmd_filter_defaults(struct blk_cmd_filter *filter)
FUJITA Tomonoriabf54392008-08-16 14:10:05 +0900125{
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, 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);
149
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);
156
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);
175
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(ERASE, filter->write_ok);
186 __set_bit(GPCMD_MODE_SELECT_10, filter->write_ok);
187 __set_bit(MODE_SELECT, filter->write_ok);
188 __set_bit(LOG_SELECT, filter->write_ok);
189 __set_bit(GPCMD_BLANK, filter->write_ok);
190 __set_bit(GPCMD_CLOSE_TRACK, filter->write_ok);
191 __set_bit(GPCMD_FLUSH_CACHE, filter->write_ok);
192 __set_bit(GPCMD_FORMAT_UNIT, filter->write_ok);
193 __set_bit(GPCMD_REPAIR_RZONE_TRACK, filter->write_ok);
194 __set_bit(GPCMD_RESERVE_RZONE_TRACK, filter->write_ok);
195 __set_bit(GPCMD_SEND_DVD_STRUCTURE, filter->write_ok);
196 __set_bit(GPCMD_SEND_EVENT, filter->write_ok);
197 __set_bit(GPCMD_SEND_KEY, filter->write_ok);
198 __set_bit(GPCMD_SEND_OPC, filter->write_ok);
199 __set_bit(GPCMD_SEND_CUE_SHEET, filter->write_ok);
200 __set_bit(GPCMD_SET_SPEED, filter->write_ok);
201 __set_bit(GPCMD_PREVENT_ALLOW_MEDIUM_REMOVAL, filter->write_ok);
202 __set_bit(GPCMD_LOAD_UNLOAD, filter->write_ok);
203 __set_bit(GPCMD_SET_STREAMING, filter->write_ok);
xiphmont@xiph.org35e396c2008-08-22 11:12:21 +0200204 __set_bit(GPCMD_SET_READ_AHEAD, filter->write_ok);
FUJITA Tomonoriabf54392008-08-16 14:10:05 +0900205}
Jens Axboe018e0442009-06-26 16:27:10 +0200206
207int blk_verify_command(unsigned char *cmd, fmode_t has_write_perm)
208{
209 struct blk_cmd_filter *filter = &blk_default_cmd_filter;
210
211 /* root can do any command. */
212 if (capable(CAP_SYS_RAWIO))
213 return 0;
214
Jens Axboe018e0442009-06-26 16:27:10 +0200215 /* Anybody who can open the device can do a read-safe command */
216 if (test_bit(cmd[0], filter->read_ok))
217 return 0;
218
219 /* Write-safe commands require a writable open */
220 if (test_bit(cmd[0], filter->write_ok) && has_write_perm)
221 return 0;
222
223 return -EPERM;
224}
225EXPORT_SYMBOL(blk_verify_command);
FUJITA Tomonoriabf54392008-08-16 14:10:05 +0900226
Jens Axboe165125e2007-07-24 09:28:11 +0200227static int blk_fill_sghdr_rq(struct request_queue *q, struct request *rq,
Al Viro5842e512008-09-02 16:35:55 -0400228 struct sg_io_hdr *hdr, fmode_t mode)
Jens Axboe3d6392c2007-07-09 12:38:05 +0200229{
Jens Axboe3d6392c2007-07-09 12:38:05 +0200230 if (copy_from_user(rq->cmd, hdr->cmdp, hdr->cmd_len))
231 return -EFAULT;
Jens Axboe018e0442009-06-26 16:27:10 +0200232 if (blk_verify_command(rq->cmd, mode & FMODE_WRITE))
Jens Axboe3d6392c2007-07-09 12:38:05 +0200233 return -EPERM;
234
235 /*
236 * fill in request structure
237 */
238 rq->cmd_len = hdr->cmd_len;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200239
Tejun Heo24bb8fb2007-12-05 21:28:24 +0100240 rq->timeout = msecs_to_jiffies(hdr->timeout);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200241 if (!rq->timeout)
242 rq->timeout = q->sg_timeout;
243 if (!rq->timeout)
244 rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
Linus Torvaldsf2f1fa72008-12-05 14:49:18 -0800245 if (rq->timeout < BLK_MIN_SG_TIMEOUT)
246 rq->timeout = BLK_MIN_SG_TIMEOUT;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200247
248 return 0;
249}
Jens Axboe3d6392c2007-07-09 12:38:05 +0200250
FUJITA Tomonori41e17032007-07-22 10:06:50 +0900251static int blk_complete_sghdr_rq(struct request *rq, struct sg_io_hdr *hdr,
252 struct bio *bio)
Jens Axboe3d6392c2007-07-09 12:38:05 +0200253{
FUJITA Tomonori91e463c2009-04-13 20:03:10 +0200254 int r, ret = 0;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200255
256 /*
257 * fill in all the output members
258 */
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);
264 hdr->info = 0;
265 if (hdr->masked_status || hdr->host_status || hdr->driver_status)
266 hdr->info |= SG_INFO_CHECK;
Tejun Heoc3a4d782009-05-07 22:24:37 +0900267 hdr->resid = rq->resid_len;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200268 hdr->sb_len_wr = 0;
269
270 if (rq->sense_len && hdr->sbp) {
271 int len = min((unsigned int) hdr->mx_sb_len, rq->sense_len);
272
273 if (!copy_to_user(hdr->sbp, rq->sense, len))
274 hdr->sb_len_wr = len;
275 else
276 ret = -EFAULT;
277 }
278
FUJITA Tomonori91e463c2009-04-13 20:03:10 +0200279 r = blk_rq_unmap_user(bio);
280 if (!ret)
281 ret = r;
Boaz Harrosh1cd96c22009-03-24 12:35:07 +0100282 blk_put_request(rq);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200283
Boaz Harrosh1cd96c22009-03-24 12:35:07 +0100284 return ret;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200285}
Jens Axboe3d6392c2007-07-09 12:38:05 +0200286
Al Viro5842e512008-09-02 16:35:55 -0400287static int sg_io(struct request_queue *q, struct gendisk *bd_disk,
288 struct sg_io_hdr *hdr, fmode_t mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289{
Jens Axboe3d6392c2007-07-09 12:38:05 +0200290 unsigned long start_time;
Kent Overstreete0ce0ea2013-08-07 14:20:17 -0700291 ssize_t ret = 0;
292 int writing = 0;
Douglas Gilbertd1515612014-07-01 10:48:05 -0600293 int at_head = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 struct request *rq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 char sense[SCSI_SENSE_BUFFERSIZE];
FUJITA Tomonori77d172c2006-12-11 10:01:34 +0100296 struct bio *bio;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297
298 if (hdr->interface_id != 'S')
299 return -EINVAL;
300 if (hdr->cmd_len > BLK_MAX_CDB)
301 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302
Martin K. Petersenae03bf62009-05-22 17:17:50 -0400303 if (hdr->dxfer_len > (queue_max_hw_sectors(q) << 9))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 return -EIO;
305
James Bottomley f1970ba2005-06-20 14:06:52 +0200306 if (hdr->dxfer_len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307 switch (hdr->dxfer_direction) {
308 default:
309 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310 case SG_DXFER_TO_DEV:
311 writing = 1;
312 break;
Jens Axboe616e8a02006-11-13 18:04:59 +0100313 case SG_DXFER_TO_FROM_DEV:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 case SG_DXFER_FROM_DEV:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 break;
316 }
Douglas Gilbertd1515612014-07-01 10:48:05 -0600317 if (hdr->flags & SG_FLAG_Q_AT_HEAD)
318 at_head = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319
Jens Axboedd1cab92005-06-20 14:06:01 +0200320 rq = blk_get_request(q, writing ? WRITE : READ, GFP_KERNEL);
321 if (!rq)
322 return -ENOMEM;
Jens Axboef27b0872014-06-06 07:57:37 -0600323 blk_rq_set_block_pc(rq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324
Al Viro5842e512008-09-02 16:35:55 -0400325 if (blk_fill_sghdr_rq(q, rq, hdr, mode)) {
Jens Axboe3d6392c2007-07-09 12:38:05 +0200326 blk_put_request(rq);
327 return -EFAULT;
328 }
Mike Christie0e75f902006-12-01 10:40:55 +0100329
James Bottomley f1970ba2005-06-20 14:06:52 +0200330 if (hdr->iovec_count) {
Tejun Heo25636e22009-04-15 22:10:24 +0900331 size_t iov_data_len;
Christian Engelmayer17a05cc2014-01-19 02:08:49 +0100332 struct iovec *iov = NULL;
James Bottomley f1970ba2005-06-20 14:06:52 +0200333
Kent Overstreete0ce0ea2013-08-07 14:20:17 -0700334 ret = rw_copy_check_uvector(-1, hdr->dxferp, hdr->iovec_count,
335 0, NULL, &iov);
Christian Engelmayer17a05cc2014-01-19 02:08:49 +0100336 if (ret < 0) {
337 kfree(iov);
Jens Axboedd1cab92005-06-20 14:06:01 +0200338 goto out;
Christian Engelmayer17a05cc2014-01-19 02:08:49 +0100339 }
James Bottomley f1970ba2005-06-20 14:06:52 +0200340
Kent Overstreete0ce0ea2013-08-07 14:20:17 -0700341 iov_data_len = ret;
342 ret = 0;
Jens Axboe9f864c82010-10-29 11:31:42 -0600343
Tejun Heo25636e22009-04-15 22:10:24 +0900344 /* SG_IO howto says that the shorter of the two wins */
Tejun Heo25636e22009-04-15 22:10:24 +0900345 if (hdr->dxfer_len < iov_data_len) {
Jens Axboe9f864c82010-10-29 11:31:42 -0600346 hdr->iovec_count = iov_shorten(iov,
Tejun Heo25636e22009-04-15 22:10:24 +0900347 hdr->iovec_count,
348 hdr->dxfer_len);
349 iov_data_len = hdr->dxfer_len;
350 }
351
Kent Overstreete0ce0ea2013-08-07 14:20:17 -0700352 ret = blk_rq_map_user_iov(q, rq, NULL, (struct sg_iovec *) iov,
353 hdr->iovec_count,
Tejun Heo25636e22009-04-15 22:10:24 +0900354 iov_data_len, GFP_KERNEL);
Kent Overstreete0ce0ea2013-08-07 14:20:17 -0700355 kfree(iov);
James Bottomley f1970ba2005-06-20 14:06:52 +0200356 } else if (hdr->dxfer_len)
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900357 ret = blk_rq_map_user(q, rq, NULL, hdr->dxferp, hdr->dxfer_len,
FUJITA Tomonoria3bce902008-08-28 16:17:05 +0900358 GFP_KERNEL);
James Bottomley f1970ba2005-06-20 14:06:52 +0200359
360 if (ret)
361 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362
FUJITA Tomonori77d172c2006-12-11 10:01:34 +0100363 bio = rq->bio;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200364 memset(sense, 0, sizeof(sense));
365 rq->sense = sense;
366 rq->sense_len = 0;
Jens Axboe01840f92006-02-03 08:37:08 +0100367 rq->retries = 0;
368
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 start_time = jiffies;
370
371 /* ignore return value. All information is passed back to caller
372 * (if he doesn't check that is his problem).
373 * N.B. a non-zero SCSI status is _not_ necessarily an error.
374 */
Douglas Gilbertd1515612014-07-01 10:48:05 -0600375 blk_execute_rq(q, bd_disk, rq, at_head);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376
Tejun Heo24bb8fb2007-12-05 21:28:24 +0100377 hdr->duration = jiffies_to_msecs(jiffies - start_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378
Jens Axboe3d6392c2007-07-09 12:38:05 +0200379 return blk_complete_sghdr_rq(rq, hdr, bio);
Jens Axboedd1cab92005-06-20 14:06:01 +0200380out:
381 blk_put_request(rq);
382 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383}
384
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100385/**
386 * sg_scsi_ioctl -- handle deprecated SCSI_IOCTL_SEND_COMMAND ioctl
387 * @file: file this ioctl operates on (optional)
388 * @q: request queue to send scsi commands down
389 * @disk: gendisk to operate on (option)
390 * @sic: userspace structure describing the command to perform
391 *
392 * Send down the scsi command described by @sic to the device below
393 * the request queue @q. If @file is non-NULL it's used to perform
394 * fine-grained permission checks that allow users to send down
395 * non-destructive SCSI commands. If the caller has a struct gendisk
396 * available it should be passed in as @disk to allow the low level
397 * driver to use the information contained in it. A non-NULL @disk
398 * is only allowed if the caller knows that the low level driver doesn't
399 * need it (e.g. in the scsi subsystem).
400 *
401 * Notes:
402 * - This interface is deprecated - users should use the SG_IO
403 * interface instead, as this is a more flexible approach to
404 * performing SCSI commands on a device.
405 * - The SCSI command length is determined by examining the 1st byte
406 * of the given command. There is no way to override this.
407 * - Data transfers are limited to PAGE_SIZE
408 * - The length (x + y) must be at least OMAX_SB_LEN bytes long to
409 * accommodate the sense buffer when an error occurs.
410 * The sense buffer is truncated to OMAX_SB_LEN (16) bytes so that
411 * old code will not be surprised.
412 * - If a Unix error occurs (e.g. ENOMEM) then the user will receive
413 * a negative return and the Unix error code in 'errno'.
414 * If the SCSI command succeeds then 0 is returned.
415 * Positive numbers returned are the compacted SCSI error codes (4
416 * bytes in one int) where the lowest byte is the SCSI status.
417 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418#define OMAX_SB_LEN 16 /* For backward compatibility */
Al Viroe915e872008-09-02 17:16:41 -0400419int sg_scsi_ioctl(struct request_queue *q, struct gendisk *disk, fmode_t mode,
420 struct scsi_ioctl_command __user *sic)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421{
422 struct request *rq;
Al Viroaeb5d722008-09-02 15:28:45 -0400423 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424 unsigned int in_len, out_len, bytes, opcode, cmdlen;
425 char *buffer = NULL, sense[SCSI_SENSE_BUFFERSIZE];
426
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100427 if (!sic)
428 return -EINVAL;
429
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430 /*
431 * get in an out lengths, verify they don't exceed a page worth of data
432 */
433 if (get_user(in_len, &sic->inlen))
434 return -EFAULT;
435 if (get_user(out_len, &sic->outlen))
436 return -EFAULT;
437 if (in_len > PAGE_SIZE || out_len > PAGE_SIZE)
438 return -EINVAL;
439 if (get_user(opcode, sic->data))
440 return -EFAULT;
441
442 bytes = max(in_len, out_len);
443 if (bytes) {
Yoann Padioleaudd00cc42007-07-19 01:49:03 -0700444 buffer = kzalloc(bytes, q->bounce_gfp | GFP_USER| __GFP_NOWARN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 if (!buffer)
446 return -ENOMEM;
447
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 }
449
450 rq = blk_get_request(q, in_len ? WRITE : READ, __GFP_WAIT);
451
452 cmdlen = COMMAND_SIZE(opcode);
453
454 /*
455 * get command and data to send to device, if any
456 */
457 err = -EFAULT;
458 rq->cmd_len = cmdlen;
459 if (copy_from_user(rq->cmd, sic->data, cmdlen))
460 goto error;
461
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100462 if (in_len && copy_from_user(buffer, sic->data + cmdlen, in_len))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 goto error;
464
Jens Axboe018e0442009-06-26 16:27:10 +0200465 err = blk_verify_command(rq->cmd, mode & FMODE_WRITE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 if (err)
467 goto error;
468
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100469 /* default. possible overriden later */
470 rq->retries = 5;
471
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472 switch (opcode) {
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100473 case SEND_DIAGNOSTIC:
474 case FORMAT_UNIT:
475 rq->timeout = FORMAT_UNIT_TIMEOUT;
476 rq->retries = 1;
477 break;
478 case START_STOP:
479 rq->timeout = START_STOP_TIMEOUT;
480 break;
481 case MOVE_MEDIUM:
482 rq->timeout = MOVE_MEDIUM_TIMEOUT;
483 break;
484 case READ_ELEMENT_STATUS:
485 rq->timeout = READ_ELEMENT_STATUS_TIMEOUT;
486 break;
487 case READ_DEFECT_DATA:
488 rq->timeout = READ_DEFECT_DATA_TIMEOUT;
489 rq->retries = 1;
490 break;
491 default:
Jens Axboe3d6392c2007-07-09 12:38:05 +0200492 rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100493 break;
494 }
495
496 if (bytes && blk_rq_map_kern(q, rq, buffer, bytes, __GFP_WAIT)) {
497 err = DRIVER_ERROR << 24;
498 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499 }
500
501 memset(sense, 0, sizeof(sense));
502 rq->sense = sense;
503 rq->sense_len = 0;
Jens Axboef27b0872014-06-06 07:57:37 -0600504 blk_rq_set_block_pc(rq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100506 blk_execute_rq(q, disk, rq, 0);
507
508out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 err = rq->errors & 0xff; /* only 8 bit SCSI status */
510 if (err) {
511 if (rq->sense_len && rq->sense) {
512 bytes = (OMAX_SB_LEN > rq->sense_len) ?
513 rq->sense_len : OMAX_SB_LEN;
514 if (copy_to_user(sic->data, rq->sense, bytes))
515 err = -EFAULT;
516 }
517 } else {
518 if (copy_to_user(sic->data, buffer, out_len))
519 err = -EFAULT;
520 }
521
522error:
523 kfree(buffer);
524 blk_put_request(rq);
525 return err;
526}
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100527EXPORT_SYMBOL_GPL(sg_scsi_ioctl);
Ben Collinsf98d2df2005-12-19 11:49:24 -0800528
529/* Send basic block requests */
Jens Axboe165125e2007-07-24 09:28:11 +0200530static int __blk_send_generic(struct request_queue *q, struct gendisk *bd_disk,
531 int cmd, int data)
Ben Collinsf98d2df2005-12-19 11:49:24 -0800532{
533 struct request *rq;
534 int err;
535
536 rq = blk_get_request(q, WRITE, __GFP_WAIT);
Jens Axboef27b0872014-06-06 07:57:37 -0600537 blk_rq_set_block_pc(rq);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200538 rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
Ben Collinsf98d2df2005-12-19 11:49:24 -0800539 rq->cmd[0] = cmd;
540 rq->cmd[4] = data;
541 rq->cmd_len = 6;
542 err = blk_execute_rq(q, bd_disk, rq, 0);
543 blk_put_request(rq);
544
545 return err;
546}
547
Jens Axboe165125e2007-07-24 09:28:11 +0200548static inline int blk_send_start_stop(struct request_queue *q,
549 struct gendisk *bd_disk, int data)
Ben Collinsf98d2df2005-12-19 11:49:24 -0800550{
551 return __blk_send_generic(q, bd_disk, GPCMD_START_STOP_UNIT, data);
552}
553
Al Viro74f3c8a2007-08-27 15:38:10 -0400554int scsi_cmd_ioctl(struct request_queue *q, struct gendisk *bd_disk, fmode_t mode,
555 unsigned int cmd, void __user *arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556{
Ben Collinsf98d2df2005-12-19 11:49:24 -0800557 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558
Tejun Heo315fcee2011-10-19 14:31:25 +0200559 if (!q)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560 return -ENXIO;
561
562 switch (cmd) {
563 /*
564 * new sgv3 interface
565 */
566 case SG_GET_VERSION_NUM:
567 err = sg_get_version(arg);
568 break;
569 case SCSI_IOCTL_GET_IDLUN:
570 err = scsi_get_idlun(q, arg);
571 break;
572 case SCSI_IOCTL_GET_BUS_NUMBER:
573 err = scsi_get_bus(q, arg);
574 break;
575 case SG_SET_TIMEOUT:
576 err = sg_set_timeout(q, arg);
577 break;
578 case SG_GET_TIMEOUT:
579 err = sg_get_timeout(q);
580 break;
581 case SG_GET_RESERVED_SIZE:
582 err = sg_get_reserved_size(q, arg);
583 break;
584 case SG_SET_RESERVED_SIZE:
585 err = sg_set_reserved_size(q, arg);
586 break;
587 case SG_EMULATED_HOST:
588 err = sg_emulated_host(q, arg);
589 break;
590 case SG_IO: {
591 struct sg_io_hdr hdr;
592
593 err = -EFAULT;
594 if (copy_from_user(&hdr, arg, sizeof(hdr)))
595 break;
Al Viro74f3c8a2007-08-27 15:38:10 -0400596 err = sg_io(q, bd_disk, &hdr, mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 if (err == -EFAULT)
598 break;
599
600 if (copy_to_user(arg, &hdr, sizeof(hdr)))
601 err = -EFAULT;
602 break;
603 }
604 case CDROM_SEND_PACKET: {
605 struct cdrom_generic_command cgc;
606 struct sg_io_hdr hdr;
607
608 err = -EFAULT;
609 if (copy_from_user(&cgc, arg, sizeof(cgc)))
610 break;
611 cgc.timeout = clock_t_to_jiffies(cgc.timeout);
612 memset(&hdr, 0, sizeof(hdr));
613 hdr.interface_id = 'S';
614 hdr.cmd_len = sizeof(cgc.cmd);
615 hdr.dxfer_len = cgc.buflen;
616 err = 0;
617 switch (cgc.data_direction) {
618 case CGC_DATA_UNKNOWN:
619 hdr.dxfer_direction = SG_DXFER_UNKNOWN;
620 break;
621 case CGC_DATA_WRITE:
622 hdr.dxfer_direction = SG_DXFER_TO_DEV;
623 break;
624 case CGC_DATA_READ:
625 hdr.dxfer_direction = SG_DXFER_FROM_DEV;
626 break;
627 case CGC_DATA_NONE:
628 hdr.dxfer_direction = SG_DXFER_NONE;
629 break;
630 default:
631 err = -EINVAL;
632 }
633 if (err)
634 break;
635
636 hdr.dxferp = cgc.buffer;
637 hdr.sbp = cgc.sense;
638 if (hdr.sbp)
639 hdr.mx_sb_len = sizeof(struct request_sense);
Tim Wrightad337592008-07-27 17:50:38 -0700640 hdr.timeout = jiffies_to_msecs(cgc.timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 hdr.cmdp = ((struct cdrom_generic_command __user*) arg)->cmd;
642 hdr.cmd_len = sizeof(cgc.cmd);
643
Al Viro74f3c8a2007-08-27 15:38:10 -0400644 err = sg_io(q, bd_disk, &hdr, mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645 if (err == -EFAULT)
646 break;
647
648 if (hdr.status)
649 err = -EIO;
650
651 cgc.stat = err;
652 cgc.buflen = hdr.resid;
653 if (copy_to_user(arg, &cgc, sizeof(cgc)))
654 err = -EFAULT;
655
656 break;
657 }
658
659 /*
660 * old junk scsi send command ioctl
661 */
662 case SCSI_IOCTL_SEND_COMMAND:
663 printk(KERN_WARNING "program %s is using a deprecated SCSI ioctl, please convert it to SG_IO\n", current->comm);
664 err = -EINVAL;
665 if (!arg)
666 break;
667
Al Viro74f3c8a2007-08-27 15:38:10 -0400668 err = sg_scsi_ioctl(q, bd_disk, mode, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669 break;
670 case CDROMCLOSETRAY:
Ben Collinsf98d2df2005-12-19 11:49:24 -0800671 err = blk_send_start_stop(q, bd_disk, 0x03);
672 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673 case CDROMEJECT:
Ben Collinsf98d2df2005-12-19 11:49:24 -0800674 err = blk_send_start_stop(q, bd_disk, 0x02);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 break;
676 default:
677 err = -ENOTTY;
678 }
679
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680 return err;
681}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682EXPORT_SYMBOL(scsi_cmd_ioctl);
Jens Axboe018e0442009-06-26 16:27:10 +0200683
Paolo Bonzini0bfc96c2012-01-12 16:01:28 +0100684int scsi_verify_blk_ioctl(struct block_device *bd, unsigned int cmd)
685{
686 if (bd && bd == bd->bd_contains)
687 return 0;
688
689 /* Actually none of these is particularly useful on a partition,
690 * but they are safe.
691 */
692 switch (cmd) {
693 case SCSI_IOCTL_GET_IDLUN:
694 case SCSI_IOCTL_GET_BUS_NUMBER:
695 case SCSI_IOCTL_GET_PCI:
696 case SCSI_IOCTL_PROBE_HOST:
697 case SG_GET_VERSION_NUM:
698 case SG_SET_TIMEOUT:
699 case SG_GET_TIMEOUT:
700 case SG_GET_RESERVED_SIZE:
701 case SG_SET_RESERVED_SIZE:
702 case SG_EMULATED_HOST:
703 return 0;
704 case CDROM_GET_CAPABILITY:
705 /* Keep this until we remove the printk below. udev sends it
706 * and we do not want to spam dmesg about it. CD-ROMs do
707 * not have partitions, so we get here only for disks.
708 */
709 return -ENOIOCTLCMD;
710 default:
711 break;
712 }
713
Jan Kara6d935922012-06-15 12:52:46 +0200714 if (capable(CAP_SYS_RAWIO))
715 return 0;
716
Paolo Bonzini0bfc96c2012-01-12 16:01:28 +0100717 /* In particular, rule out all resets and host-specific ioctls. */
718 printk_ratelimited(KERN_WARNING
719 "%s: sending ioctl %x to a partition!\n", current->comm, cmd);
720
Jan Kara6d935922012-06-15 12:52:46 +0200721 return -ENOIOCTLCMD;
Paolo Bonzini0bfc96c2012-01-12 16:01:28 +0100722}
723EXPORT_SYMBOL(scsi_verify_blk_ioctl);
724
Paolo Bonzini577ebb32012-01-12 16:01:27 +0100725int scsi_cmd_blk_ioctl(struct block_device *bd, fmode_t mode,
726 unsigned int cmd, void __user *arg)
727{
Paolo Bonzini0bfc96c2012-01-12 16:01:28 +0100728 int ret;
729
730 ret = scsi_verify_blk_ioctl(bd, cmd);
731 if (ret < 0)
732 return ret;
733
Paolo Bonzini577ebb32012-01-12 16:01:27 +0100734 return scsi_cmd_ioctl(bd->bd_disk->queue, bd->bd_disk, mode, cmd, arg);
735}
736EXPORT_SYMBOL(scsi_cmd_blk_ioctl);
737
H Hartley Sweeten476d42f2009-11-04 09:10:33 +0100738static int __init blk_scsi_ioctl_init(void)
Jens Axboe018e0442009-06-26 16:27:10 +0200739{
740 blk_set_cmd_filter_defaults(&blk_default_cmd_filter);
741 return 0;
742}
FUJITA Tomonori76da0342009-07-09 09:48:28 +0200743fs_initcall(blk_scsi_ioctl_init);