blob: 14695c6221c821588592f65fb72507daf230a358 [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
Jens Axboe165125e2007-07-24 09:28:11 +020085static int sg_get_reserved_size(struct request_queue *q, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -070086{
Martin K. Petersenae03bf62009-05-22 17:17:50 -040087 unsigned val = min(q->sg_reserved_size, queue_max_sectors(q) << 9);
Alan Stern44ec9542007-02-20 11:01:57 -050088
89 return put_user(val, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -070090}
91
Jens Axboe165125e2007-07-24 09:28:11 +020092static int sg_set_reserved_size(struct request_queue *q, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -070093{
94 int size, err = get_user(size, p);
95
96 if (err)
97 return err;
98
99 if (size < 0)
100 return -EINVAL;
Martin K. Petersenae03bf62009-05-22 17:17:50 -0400101 if (size > (queue_max_sectors(q) << 9))
102 size = queue_max_sectors(q) << 9;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103
104 q->sg_reserved_size = size;
105 return 0;
106}
107
108/*
109 * will always return that we are ATAPI even for a real SCSI drive, I'm not
110 * so sure this is worth doing anything about (why would you care??)
111 */
Jens Axboe165125e2007-07-24 09:28:11 +0200112static int sg_emulated_host(struct request_queue *q, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113{
114 return put_user(1, p);
115}
116
Jens Axboe018e0442009-06-26 16:27:10 +0200117static void blk_set_cmd_filter_defaults(struct blk_cmd_filter *filter)
FUJITA Tomonoriabf54392008-08-16 14:10:05 +0900118{
119 /* Basic read-only commands */
120 __set_bit(TEST_UNIT_READY, filter->read_ok);
121 __set_bit(REQUEST_SENSE, filter->read_ok);
122 __set_bit(READ_6, filter->read_ok);
123 __set_bit(READ_10, filter->read_ok);
124 __set_bit(READ_12, filter->read_ok);
125 __set_bit(READ_16, filter->read_ok);
126 __set_bit(READ_BUFFER, filter->read_ok);
127 __set_bit(READ_DEFECT_DATA, filter->read_ok);
128 __set_bit(READ_CAPACITY, filter->read_ok);
129 __set_bit(READ_LONG, filter->read_ok);
130 __set_bit(INQUIRY, filter->read_ok);
131 __set_bit(MODE_SENSE, filter->read_ok);
132 __set_bit(MODE_SENSE_10, filter->read_ok);
133 __set_bit(LOG_SENSE, filter->read_ok);
134 __set_bit(START_STOP, filter->read_ok);
135 __set_bit(GPCMD_VERIFY_10, filter->read_ok);
136 __set_bit(VERIFY_16, filter->read_ok);
137 __set_bit(REPORT_LUNS, filter->read_ok);
138 __set_bit(SERVICE_ACTION_IN, filter->read_ok);
139 __set_bit(RECEIVE_DIAGNOSTIC, filter->read_ok);
140 __set_bit(MAINTENANCE_IN, filter->read_ok);
141 __set_bit(GPCMD_READ_BUFFER_CAPACITY, filter->read_ok);
142
143 /* Audio CD commands */
144 __set_bit(GPCMD_PLAY_CD, filter->read_ok);
145 __set_bit(GPCMD_PLAY_AUDIO_10, filter->read_ok);
146 __set_bit(GPCMD_PLAY_AUDIO_MSF, filter->read_ok);
147 __set_bit(GPCMD_PLAY_AUDIO_TI, filter->read_ok);
148 __set_bit(GPCMD_PAUSE_RESUME, filter->read_ok);
149
150 /* CD/DVD data reading */
151 __set_bit(GPCMD_READ_CD, filter->read_ok);
152 __set_bit(GPCMD_READ_CD_MSF, filter->read_ok);
153 __set_bit(GPCMD_READ_DISC_INFO, filter->read_ok);
154 __set_bit(GPCMD_READ_CDVD_CAPACITY, filter->read_ok);
155 __set_bit(GPCMD_READ_DVD_STRUCTURE, filter->read_ok);
156 __set_bit(GPCMD_READ_HEADER, filter->read_ok);
157 __set_bit(GPCMD_READ_TRACK_RZONE_INFO, filter->read_ok);
158 __set_bit(GPCMD_READ_SUBCHANNEL, filter->read_ok);
159 __set_bit(GPCMD_READ_TOC_PMA_ATIP, filter->read_ok);
160 __set_bit(GPCMD_REPORT_KEY, filter->read_ok);
161 __set_bit(GPCMD_SCAN, filter->read_ok);
162 __set_bit(GPCMD_GET_CONFIGURATION, filter->read_ok);
163 __set_bit(GPCMD_READ_FORMAT_CAPACITIES, filter->read_ok);
164 __set_bit(GPCMD_GET_EVENT_STATUS_NOTIFICATION, filter->read_ok);
165 __set_bit(GPCMD_GET_PERFORMANCE, filter->read_ok);
166 __set_bit(GPCMD_SEEK, filter->read_ok);
167 __set_bit(GPCMD_STOP_PLAY_SCAN, filter->read_ok);
168
169 /* Basic writing commands */
170 __set_bit(WRITE_6, filter->write_ok);
171 __set_bit(WRITE_10, filter->write_ok);
172 __set_bit(WRITE_VERIFY, filter->write_ok);
173 __set_bit(WRITE_12, filter->write_ok);
174 __set_bit(WRITE_VERIFY_12, filter->write_ok);
175 __set_bit(WRITE_16, filter->write_ok);
176 __set_bit(WRITE_LONG, filter->write_ok);
177 __set_bit(WRITE_LONG_2, filter->write_ok);
178 __set_bit(ERASE, filter->write_ok);
179 __set_bit(GPCMD_MODE_SELECT_10, filter->write_ok);
180 __set_bit(MODE_SELECT, filter->write_ok);
181 __set_bit(LOG_SELECT, filter->write_ok);
182 __set_bit(GPCMD_BLANK, filter->write_ok);
183 __set_bit(GPCMD_CLOSE_TRACK, filter->write_ok);
184 __set_bit(GPCMD_FLUSH_CACHE, filter->write_ok);
185 __set_bit(GPCMD_FORMAT_UNIT, filter->write_ok);
186 __set_bit(GPCMD_REPAIR_RZONE_TRACK, filter->write_ok);
187 __set_bit(GPCMD_RESERVE_RZONE_TRACK, filter->write_ok);
188 __set_bit(GPCMD_SEND_DVD_STRUCTURE, filter->write_ok);
189 __set_bit(GPCMD_SEND_EVENT, filter->write_ok);
190 __set_bit(GPCMD_SEND_KEY, filter->write_ok);
191 __set_bit(GPCMD_SEND_OPC, filter->write_ok);
192 __set_bit(GPCMD_SEND_CUE_SHEET, filter->write_ok);
193 __set_bit(GPCMD_SET_SPEED, filter->write_ok);
194 __set_bit(GPCMD_PREVENT_ALLOW_MEDIUM_REMOVAL, filter->write_ok);
195 __set_bit(GPCMD_LOAD_UNLOAD, filter->write_ok);
196 __set_bit(GPCMD_SET_STREAMING, filter->write_ok);
xiphmont@xiph.org35e396c2008-08-22 11:12:21 +0200197 __set_bit(GPCMD_SET_READ_AHEAD, filter->write_ok);
FUJITA Tomonoriabf54392008-08-16 14:10:05 +0900198}
Jens Axboe018e0442009-06-26 16:27:10 +0200199
200int blk_verify_command(unsigned char *cmd, fmode_t has_write_perm)
201{
202 struct blk_cmd_filter *filter = &blk_default_cmd_filter;
203
204 /* root can do any command. */
205 if (capable(CAP_SYS_RAWIO))
206 return 0;
207
Jens Axboe018e0442009-06-26 16:27:10 +0200208 /* Anybody who can open the device can do a read-safe command */
209 if (test_bit(cmd[0], filter->read_ok))
210 return 0;
211
212 /* Write-safe commands require a writable open */
213 if (test_bit(cmd[0], filter->write_ok) && has_write_perm)
214 return 0;
215
216 return -EPERM;
217}
218EXPORT_SYMBOL(blk_verify_command);
FUJITA Tomonoriabf54392008-08-16 14:10:05 +0900219
Jens Axboe165125e2007-07-24 09:28:11 +0200220static int blk_fill_sghdr_rq(struct request_queue *q, struct request *rq,
Al Viro5842e512008-09-02 16:35:55 -0400221 struct sg_io_hdr *hdr, fmode_t mode)
Jens Axboe3d6392c2007-07-09 12:38:05 +0200222{
Jens Axboe3d6392c2007-07-09 12:38:05 +0200223 if (copy_from_user(rq->cmd, hdr->cmdp, hdr->cmd_len))
224 return -EFAULT;
Jens Axboe018e0442009-06-26 16:27:10 +0200225 if (blk_verify_command(rq->cmd, mode & FMODE_WRITE))
Jens Axboe3d6392c2007-07-09 12:38:05 +0200226 return -EPERM;
227
228 /*
229 * fill in request structure
230 */
231 rq->cmd_len = hdr->cmd_len;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200232
Tejun Heo24bb8fb2007-12-05 21:28:24 +0100233 rq->timeout = msecs_to_jiffies(hdr->timeout);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200234 if (!rq->timeout)
235 rq->timeout = q->sg_timeout;
236 if (!rq->timeout)
237 rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
Linus Torvaldsf2f1fa72008-12-05 14:49:18 -0800238 if (rq->timeout < BLK_MIN_SG_TIMEOUT)
239 rq->timeout = BLK_MIN_SG_TIMEOUT;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200240
241 return 0;
242}
Jens Axboe3d6392c2007-07-09 12:38:05 +0200243
FUJITA Tomonori41e17032007-07-22 10:06:50 +0900244static int blk_complete_sghdr_rq(struct request *rq, struct sg_io_hdr *hdr,
245 struct bio *bio)
Jens Axboe3d6392c2007-07-09 12:38:05 +0200246{
FUJITA Tomonori91e463c2009-04-13 20:03:10 +0200247 int r, ret = 0;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200248
249 /*
250 * fill in all the output members
251 */
252 hdr->status = rq->errors & 0xff;
253 hdr->masked_status = status_byte(rq->errors);
254 hdr->msg_status = msg_byte(rq->errors);
255 hdr->host_status = host_byte(rq->errors);
256 hdr->driver_status = driver_byte(rq->errors);
257 hdr->info = 0;
258 if (hdr->masked_status || hdr->host_status || hdr->driver_status)
259 hdr->info |= SG_INFO_CHECK;
Tejun Heoc3a4d782009-05-07 22:24:37 +0900260 hdr->resid = rq->resid_len;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200261 hdr->sb_len_wr = 0;
262
263 if (rq->sense_len && hdr->sbp) {
264 int len = min((unsigned int) hdr->mx_sb_len, rq->sense_len);
265
266 if (!copy_to_user(hdr->sbp, rq->sense, len))
267 hdr->sb_len_wr = len;
268 else
269 ret = -EFAULT;
270 }
271
FUJITA Tomonori91e463c2009-04-13 20:03:10 +0200272 r = blk_rq_unmap_user(bio);
273 if (!ret)
274 ret = r;
Boaz Harrosh1cd96c22009-03-24 12:35:07 +0100275 blk_put_request(rq);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200276
Boaz Harrosh1cd96c22009-03-24 12:35:07 +0100277 return ret;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200278}
Jens Axboe3d6392c2007-07-09 12:38:05 +0200279
Al Viro5842e512008-09-02 16:35:55 -0400280static int sg_io(struct request_queue *q, struct gendisk *bd_disk,
281 struct sg_io_hdr *hdr, fmode_t mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282{
Jens Axboe3d6392c2007-07-09 12:38:05 +0200283 unsigned long start_time;
Kent Overstreete0ce0ea2013-08-07 14:20:17 -0700284 ssize_t ret = 0;
285 int writing = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286 struct request *rq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 char sense[SCSI_SENSE_BUFFERSIZE];
FUJITA Tomonori77d172c2006-12-11 10:01:34 +0100288 struct bio *bio;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289
290 if (hdr->interface_id != 'S')
291 return -EINVAL;
292 if (hdr->cmd_len > BLK_MAX_CDB)
293 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294
Martin K. Petersenae03bf62009-05-22 17:17:50 -0400295 if (hdr->dxfer_len > (queue_max_hw_sectors(q) << 9))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 return -EIO;
297
James Bottomley f1970ba2005-06-20 14:06:52 +0200298 if (hdr->dxfer_len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299 switch (hdr->dxfer_direction) {
300 default:
301 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302 case SG_DXFER_TO_DEV:
303 writing = 1;
304 break;
Jens Axboe616e8a02006-11-13 18:04:59 +0100305 case SG_DXFER_TO_FROM_DEV:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 case SG_DXFER_FROM_DEV:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307 break;
308 }
309
Jens Axboedd1cab92005-06-20 14:06:01 +0200310 rq = blk_get_request(q, writing ? WRITE : READ, GFP_KERNEL);
311 if (!rq)
312 return -ENOMEM;
Jens Axboef27b0872014-06-06 07:57:37 -0600313 blk_rq_set_block_pc(rq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314
Al Viro5842e512008-09-02 16:35:55 -0400315 if (blk_fill_sghdr_rq(q, rq, hdr, mode)) {
Jens Axboe3d6392c2007-07-09 12:38:05 +0200316 blk_put_request(rq);
317 return -EFAULT;
318 }
Mike Christie0e75f902006-12-01 10:40:55 +0100319
James Bottomley f1970ba2005-06-20 14:06:52 +0200320 if (hdr->iovec_count) {
Tejun Heo25636e22009-04-15 22:10:24 +0900321 size_t iov_data_len;
Christian Engelmayer17a05cc2014-01-19 02:08:49 +0100322 struct iovec *iov = NULL;
James Bottomley f1970ba2005-06-20 14:06:52 +0200323
Kent Overstreete0ce0ea2013-08-07 14:20:17 -0700324 ret = rw_copy_check_uvector(-1, hdr->dxferp, hdr->iovec_count,
325 0, NULL, &iov);
Christian Engelmayer17a05cc2014-01-19 02:08:49 +0100326 if (ret < 0) {
327 kfree(iov);
Jens Axboedd1cab92005-06-20 14:06:01 +0200328 goto out;
Christian Engelmayer17a05cc2014-01-19 02:08:49 +0100329 }
James Bottomley f1970ba2005-06-20 14:06:52 +0200330
Kent Overstreete0ce0ea2013-08-07 14:20:17 -0700331 iov_data_len = ret;
332 ret = 0;
Jens Axboe9f864c82010-10-29 11:31:42 -0600333
Tejun Heo25636e22009-04-15 22:10:24 +0900334 /* SG_IO howto says that the shorter of the two wins */
Tejun Heo25636e22009-04-15 22:10:24 +0900335 if (hdr->dxfer_len < iov_data_len) {
Jens Axboe9f864c82010-10-29 11:31:42 -0600336 hdr->iovec_count = iov_shorten(iov,
Tejun Heo25636e22009-04-15 22:10:24 +0900337 hdr->iovec_count,
338 hdr->dxfer_len);
339 iov_data_len = hdr->dxfer_len;
340 }
341
Kent Overstreete0ce0ea2013-08-07 14:20:17 -0700342 ret = blk_rq_map_user_iov(q, rq, NULL, (struct sg_iovec *) iov,
343 hdr->iovec_count,
Tejun Heo25636e22009-04-15 22:10:24 +0900344 iov_data_len, GFP_KERNEL);
Kent Overstreete0ce0ea2013-08-07 14:20:17 -0700345 kfree(iov);
James Bottomley f1970ba2005-06-20 14:06:52 +0200346 } else if (hdr->dxfer_len)
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900347 ret = blk_rq_map_user(q, rq, NULL, hdr->dxferp, hdr->dxfer_len,
FUJITA Tomonoria3bce902008-08-28 16:17:05 +0900348 GFP_KERNEL);
James Bottomley f1970ba2005-06-20 14:06:52 +0200349
350 if (ret)
351 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352
FUJITA Tomonori77d172c2006-12-11 10:01:34 +0100353 bio = rq->bio;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200354 memset(sense, 0, sizeof(sense));
355 rq->sense = sense;
356 rq->sense_len = 0;
Jens Axboe01840f92006-02-03 08:37:08 +0100357 rq->retries = 0;
358
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 start_time = jiffies;
360
361 /* ignore return value. All information is passed back to caller
362 * (if he doesn't check that is his problem).
363 * N.B. a non-zero SCSI status is _not_ necessarily an error.
364 */
James Bottomley 994ca9a2005-06-20 14:11:09 +0200365 blk_execute_rq(q, bd_disk, rq, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366
Tejun Heo24bb8fb2007-12-05 21:28:24 +0100367 hdr->duration = jiffies_to_msecs(jiffies - start_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368
Jens Axboe3d6392c2007-07-09 12:38:05 +0200369 return blk_complete_sghdr_rq(rq, hdr, bio);
Jens Axboedd1cab92005-06-20 14:06:01 +0200370out:
371 blk_put_request(rq);
372 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373}
374
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100375/**
376 * sg_scsi_ioctl -- handle deprecated SCSI_IOCTL_SEND_COMMAND ioctl
377 * @file: file this ioctl operates on (optional)
378 * @q: request queue to send scsi commands down
379 * @disk: gendisk to operate on (option)
380 * @sic: userspace structure describing the command to perform
381 *
382 * Send down the scsi command described by @sic to the device below
383 * the request queue @q. If @file is non-NULL it's used to perform
384 * fine-grained permission checks that allow users to send down
385 * non-destructive SCSI commands. If the caller has a struct gendisk
386 * available it should be passed in as @disk to allow the low level
387 * driver to use the information contained in it. A non-NULL @disk
388 * is only allowed if the caller knows that the low level driver doesn't
389 * need it (e.g. in the scsi subsystem).
390 *
391 * Notes:
392 * - This interface is deprecated - users should use the SG_IO
393 * interface instead, as this is a more flexible approach to
394 * performing SCSI commands on a device.
395 * - The SCSI command length is determined by examining the 1st byte
396 * of the given command. There is no way to override this.
397 * - Data transfers are limited to PAGE_SIZE
398 * - The length (x + y) must be at least OMAX_SB_LEN bytes long to
399 * accommodate the sense buffer when an error occurs.
400 * The sense buffer is truncated to OMAX_SB_LEN (16) bytes so that
401 * old code will not be surprised.
402 * - If a Unix error occurs (e.g. ENOMEM) then the user will receive
403 * a negative return and the Unix error code in 'errno'.
404 * If the SCSI command succeeds then 0 is returned.
405 * Positive numbers returned are the compacted SCSI error codes (4
406 * bytes in one int) where the lowest byte is the SCSI status.
407 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408#define OMAX_SB_LEN 16 /* For backward compatibility */
Al Viroe915e872008-09-02 17:16:41 -0400409int sg_scsi_ioctl(struct request_queue *q, struct gendisk *disk, fmode_t mode,
410 struct scsi_ioctl_command __user *sic)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411{
412 struct request *rq;
Al Viroaeb5d722008-09-02 15:28:45 -0400413 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414 unsigned int in_len, out_len, bytes, opcode, cmdlen;
415 char *buffer = NULL, sense[SCSI_SENSE_BUFFERSIZE];
416
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100417 if (!sic)
418 return -EINVAL;
419
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 /*
421 * get in an out lengths, verify they don't exceed a page worth of data
422 */
423 if (get_user(in_len, &sic->inlen))
424 return -EFAULT;
425 if (get_user(out_len, &sic->outlen))
426 return -EFAULT;
427 if (in_len > PAGE_SIZE || out_len > PAGE_SIZE)
428 return -EINVAL;
429 if (get_user(opcode, sic->data))
430 return -EFAULT;
431
432 bytes = max(in_len, out_len);
433 if (bytes) {
Yoann Padioleaudd00cc42007-07-19 01:49:03 -0700434 buffer = kzalloc(bytes, q->bounce_gfp | GFP_USER| __GFP_NOWARN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 if (!buffer)
436 return -ENOMEM;
437
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 }
439
440 rq = blk_get_request(q, in_len ? WRITE : READ, __GFP_WAIT);
441
442 cmdlen = COMMAND_SIZE(opcode);
443
444 /*
445 * get command and data to send to device, if any
446 */
447 err = -EFAULT;
448 rq->cmd_len = cmdlen;
449 if (copy_from_user(rq->cmd, sic->data, cmdlen))
450 goto error;
451
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100452 if (in_len && copy_from_user(buffer, sic->data + cmdlen, in_len))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 goto error;
454
Jens Axboe018e0442009-06-26 16:27:10 +0200455 err = blk_verify_command(rq->cmd, mode & FMODE_WRITE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456 if (err)
457 goto error;
458
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100459 /* default. possible overriden later */
460 rq->retries = 5;
461
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462 switch (opcode) {
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100463 case SEND_DIAGNOSTIC:
464 case FORMAT_UNIT:
465 rq->timeout = FORMAT_UNIT_TIMEOUT;
466 rq->retries = 1;
467 break;
468 case START_STOP:
469 rq->timeout = START_STOP_TIMEOUT;
470 break;
471 case MOVE_MEDIUM:
472 rq->timeout = MOVE_MEDIUM_TIMEOUT;
473 break;
474 case READ_ELEMENT_STATUS:
475 rq->timeout = READ_ELEMENT_STATUS_TIMEOUT;
476 break;
477 case READ_DEFECT_DATA:
478 rq->timeout = READ_DEFECT_DATA_TIMEOUT;
479 rq->retries = 1;
480 break;
481 default:
Jens Axboe3d6392c2007-07-09 12:38:05 +0200482 rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100483 break;
484 }
485
486 if (bytes && blk_rq_map_kern(q, rq, buffer, bytes, __GFP_WAIT)) {
487 err = DRIVER_ERROR << 24;
488 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489 }
490
491 memset(sense, 0, sizeof(sense));
492 rq->sense = sense;
493 rq->sense_len = 0;
Jens Axboef27b0872014-06-06 07:57:37 -0600494 blk_rq_set_block_pc(rq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100496 blk_execute_rq(q, disk, rq, 0);
497
498out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499 err = rq->errors & 0xff; /* only 8 bit SCSI status */
500 if (err) {
501 if (rq->sense_len && rq->sense) {
502 bytes = (OMAX_SB_LEN > rq->sense_len) ?
503 rq->sense_len : OMAX_SB_LEN;
504 if (copy_to_user(sic->data, rq->sense, bytes))
505 err = -EFAULT;
506 }
507 } else {
508 if (copy_to_user(sic->data, buffer, out_len))
509 err = -EFAULT;
510 }
511
512error:
513 kfree(buffer);
514 blk_put_request(rq);
515 return err;
516}
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100517EXPORT_SYMBOL_GPL(sg_scsi_ioctl);
Ben Collinsf98d2df2005-12-19 11:49:24 -0800518
519/* Send basic block requests */
Jens Axboe165125e2007-07-24 09:28:11 +0200520static int __blk_send_generic(struct request_queue *q, struct gendisk *bd_disk,
521 int cmd, int data)
Ben Collinsf98d2df2005-12-19 11:49:24 -0800522{
523 struct request *rq;
524 int err;
525
526 rq = blk_get_request(q, WRITE, __GFP_WAIT);
Jens Axboef27b0872014-06-06 07:57:37 -0600527 blk_rq_set_block_pc(rq);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200528 rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
Ben Collinsf98d2df2005-12-19 11:49:24 -0800529 rq->cmd[0] = cmd;
530 rq->cmd[4] = data;
531 rq->cmd_len = 6;
532 err = blk_execute_rq(q, bd_disk, rq, 0);
533 blk_put_request(rq);
534
535 return err;
536}
537
Jens Axboe165125e2007-07-24 09:28:11 +0200538static inline int blk_send_start_stop(struct request_queue *q,
539 struct gendisk *bd_disk, int data)
Ben Collinsf98d2df2005-12-19 11:49:24 -0800540{
541 return __blk_send_generic(q, bd_disk, GPCMD_START_STOP_UNIT, data);
542}
543
Al Viro74f3c8a2007-08-27 15:38:10 -0400544int scsi_cmd_ioctl(struct request_queue *q, struct gendisk *bd_disk, fmode_t mode,
545 unsigned int cmd, void __user *arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546{
Ben Collinsf98d2df2005-12-19 11:49:24 -0800547 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548
Tejun Heo315fcee2011-10-19 14:31:25 +0200549 if (!q)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 return -ENXIO;
551
552 switch (cmd) {
553 /*
554 * new sgv3 interface
555 */
556 case SG_GET_VERSION_NUM:
557 err = sg_get_version(arg);
558 break;
559 case SCSI_IOCTL_GET_IDLUN:
560 err = scsi_get_idlun(q, arg);
561 break;
562 case SCSI_IOCTL_GET_BUS_NUMBER:
563 err = scsi_get_bus(q, arg);
564 break;
565 case SG_SET_TIMEOUT:
566 err = sg_set_timeout(q, arg);
567 break;
568 case SG_GET_TIMEOUT:
569 err = sg_get_timeout(q);
570 break;
571 case SG_GET_RESERVED_SIZE:
572 err = sg_get_reserved_size(q, arg);
573 break;
574 case SG_SET_RESERVED_SIZE:
575 err = sg_set_reserved_size(q, arg);
576 break;
577 case SG_EMULATED_HOST:
578 err = sg_emulated_host(q, arg);
579 break;
580 case SG_IO: {
581 struct sg_io_hdr hdr;
582
583 err = -EFAULT;
584 if (copy_from_user(&hdr, arg, sizeof(hdr)))
585 break;
Al Viro74f3c8a2007-08-27 15:38:10 -0400586 err = sg_io(q, bd_disk, &hdr, mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587 if (err == -EFAULT)
588 break;
589
590 if (copy_to_user(arg, &hdr, sizeof(hdr)))
591 err = -EFAULT;
592 break;
593 }
594 case CDROM_SEND_PACKET: {
595 struct cdrom_generic_command cgc;
596 struct sg_io_hdr hdr;
597
598 err = -EFAULT;
599 if (copy_from_user(&cgc, arg, sizeof(cgc)))
600 break;
601 cgc.timeout = clock_t_to_jiffies(cgc.timeout);
602 memset(&hdr, 0, sizeof(hdr));
603 hdr.interface_id = 'S';
604 hdr.cmd_len = sizeof(cgc.cmd);
605 hdr.dxfer_len = cgc.buflen;
606 err = 0;
607 switch (cgc.data_direction) {
608 case CGC_DATA_UNKNOWN:
609 hdr.dxfer_direction = SG_DXFER_UNKNOWN;
610 break;
611 case CGC_DATA_WRITE:
612 hdr.dxfer_direction = SG_DXFER_TO_DEV;
613 break;
614 case CGC_DATA_READ:
615 hdr.dxfer_direction = SG_DXFER_FROM_DEV;
616 break;
617 case CGC_DATA_NONE:
618 hdr.dxfer_direction = SG_DXFER_NONE;
619 break;
620 default:
621 err = -EINVAL;
622 }
623 if (err)
624 break;
625
626 hdr.dxferp = cgc.buffer;
627 hdr.sbp = cgc.sense;
628 if (hdr.sbp)
629 hdr.mx_sb_len = sizeof(struct request_sense);
Tim Wrightad337592008-07-27 17:50:38 -0700630 hdr.timeout = jiffies_to_msecs(cgc.timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631 hdr.cmdp = ((struct cdrom_generic_command __user*) arg)->cmd;
632 hdr.cmd_len = sizeof(cgc.cmd);
633
Al Viro74f3c8a2007-08-27 15:38:10 -0400634 err = sg_io(q, bd_disk, &hdr, mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635 if (err == -EFAULT)
636 break;
637
638 if (hdr.status)
639 err = -EIO;
640
641 cgc.stat = err;
642 cgc.buflen = hdr.resid;
643 if (copy_to_user(arg, &cgc, sizeof(cgc)))
644 err = -EFAULT;
645
646 break;
647 }
648
649 /*
650 * old junk scsi send command ioctl
651 */
652 case SCSI_IOCTL_SEND_COMMAND:
653 printk(KERN_WARNING "program %s is using a deprecated SCSI ioctl, please convert it to SG_IO\n", current->comm);
654 err = -EINVAL;
655 if (!arg)
656 break;
657
Al Viro74f3c8a2007-08-27 15:38:10 -0400658 err = sg_scsi_ioctl(q, bd_disk, mode, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 break;
660 case CDROMCLOSETRAY:
Ben Collinsf98d2df2005-12-19 11:49:24 -0800661 err = blk_send_start_stop(q, bd_disk, 0x03);
662 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 case CDROMEJECT:
Ben Collinsf98d2df2005-12-19 11:49:24 -0800664 err = blk_send_start_stop(q, bd_disk, 0x02);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665 break;
666 default:
667 err = -ENOTTY;
668 }
669
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670 return err;
671}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672EXPORT_SYMBOL(scsi_cmd_ioctl);
Jens Axboe018e0442009-06-26 16:27:10 +0200673
Paolo Bonzini0bfc96c2012-01-12 16:01:28 +0100674int scsi_verify_blk_ioctl(struct block_device *bd, unsigned int cmd)
675{
676 if (bd && bd == bd->bd_contains)
677 return 0;
678
679 /* Actually none of these is particularly useful on a partition,
680 * but they are safe.
681 */
682 switch (cmd) {
683 case SCSI_IOCTL_GET_IDLUN:
684 case SCSI_IOCTL_GET_BUS_NUMBER:
685 case SCSI_IOCTL_GET_PCI:
686 case SCSI_IOCTL_PROBE_HOST:
687 case SG_GET_VERSION_NUM:
688 case SG_SET_TIMEOUT:
689 case SG_GET_TIMEOUT:
690 case SG_GET_RESERVED_SIZE:
691 case SG_SET_RESERVED_SIZE:
692 case SG_EMULATED_HOST:
693 return 0;
694 case CDROM_GET_CAPABILITY:
695 /* Keep this until we remove the printk below. udev sends it
696 * and we do not want to spam dmesg about it. CD-ROMs do
697 * not have partitions, so we get here only for disks.
698 */
699 return -ENOIOCTLCMD;
700 default:
701 break;
702 }
703
Jan Kara6d935922012-06-15 12:52:46 +0200704 if (capable(CAP_SYS_RAWIO))
705 return 0;
706
Paolo Bonzini0bfc96c2012-01-12 16:01:28 +0100707 /* In particular, rule out all resets and host-specific ioctls. */
708 printk_ratelimited(KERN_WARNING
709 "%s: sending ioctl %x to a partition!\n", current->comm, cmd);
710
Jan Kara6d935922012-06-15 12:52:46 +0200711 return -ENOIOCTLCMD;
Paolo Bonzini0bfc96c2012-01-12 16:01:28 +0100712}
713EXPORT_SYMBOL(scsi_verify_blk_ioctl);
714
Paolo Bonzini577ebb32012-01-12 16:01:27 +0100715int scsi_cmd_blk_ioctl(struct block_device *bd, fmode_t mode,
716 unsigned int cmd, void __user *arg)
717{
Paolo Bonzini0bfc96c2012-01-12 16:01:28 +0100718 int ret;
719
720 ret = scsi_verify_blk_ioctl(bd, cmd);
721 if (ret < 0)
722 return ret;
723
Paolo Bonzini577ebb32012-01-12 16:01:27 +0100724 return scsi_cmd_ioctl(bd->bd_disk->queue, bd->bd_disk, mode, cmd, arg);
725}
726EXPORT_SYMBOL(scsi_cmd_blk_ioctl);
727
H Hartley Sweeten476d42f2009-11-04 09:10:33 +0100728static int __init blk_scsi_ioctl_init(void)
Jens Axboe018e0442009-06-26 16:27:10 +0200729{
730 blk_set_cmd_filter_defaults(&blk_default_cmd_filter);
731 return 0;
732}
FUJITA Tomonori76da0342009-07-09 09:48:28 +0200733fs_initcall(blk_scsi_ioctl_init);