blob: 741239631640e6d4959b8e189d5a8ac9e179bb23 [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>
30#include <asm/uaccess.h>
31
32#include <scsi/scsi.h>
33#include <scsi/scsi_ioctl.h>
34#include <scsi/scsi_cmnd.h>
35
Jens Axboe018e0442009-06-26 16:27:10 +020036struct blk_cmd_filter {
37 unsigned long read_ok[BLK_SCSI_CMD_PER_LONG];
38 unsigned long write_ok[BLK_SCSI_CMD_PER_LONG];
H Hartley Sweeten476d42f2009-11-04 09:10:33 +010039};
40
41static struct blk_cmd_filter blk_default_cmd_filter;
Jens Axboe018e0442009-06-26 16:27:10 +020042
Linus Torvalds1da177e2005-04-16 15:20:36 -070043/* Command group 3 is reserved and should never be used. */
Boaz Harroshdb4742d2008-04-30 11:27:26 +030044const unsigned char scsi_command_size_tbl[8] =
Linus Torvalds1da177e2005-04-16 15:20:36 -070045{
46 6, 10, 10, 12,
47 16, 12, 10, 10
48};
Boaz Harroshdb4742d2008-04-30 11:27:26 +030049EXPORT_SYMBOL(scsi_command_size_tbl);
Linus Torvalds1da177e2005-04-16 15:20:36 -070050
Linus Torvalds1da177e2005-04-16 15:20:36 -070051#include <scsi/sg.h>
52
53static int sg_get_version(int __user *p)
54{
Arjan van de Ven64100092006-01-06 09:46:02 +010055 static const int sg_version_num = 30527;
Linus Torvalds1da177e2005-04-16 15:20:36 -070056 return put_user(sg_version_num, p);
57}
58
Jens Axboe165125e2007-07-24 09:28:11 +020059static int scsi_get_idlun(struct request_queue *q, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -070060{
61 return put_user(0, p);
62}
63
Jens Axboe165125e2007-07-24 09:28:11 +020064static int scsi_get_bus(struct request_queue *q, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -070065{
66 return put_user(0, p);
67}
68
Jens Axboe165125e2007-07-24 09:28:11 +020069static int sg_get_timeout(struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -070070{
Milton Miller2b91baf2008-11-17 13:10:34 +010071 return jiffies_to_clock_t(q->sg_timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -070072}
73
Jens Axboe165125e2007-07-24 09:28:11 +020074static int sg_set_timeout(struct request_queue *q, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -070075{
76 int timeout, err = get_user(timeout, p);
77
78 if (!err)
Milton Miller2b91baf2008-11-17 13:10:34 +010079 q->sg_timeout = clock_t_to_jiffies(timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
81 return err;
82}
83
Jens Axboe165125e2007-07-24 09:28:11 +020084static int sg_get_reserved_size(struct request_queue *q, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -070085{
Martin K. Petersenae03bf62009-05-22 17:17:50 -040086 unsigned val = min(q->sg_reserved_size, queue_max_sectors(q) << 9);
Alan Stern44ec9542007-02-20 11:01:57 -050087
88 return put_user(val, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -070089}
90
Jens Axboe165125e2007-07-24 09:28:11 +020091static int sg_set_reserved_size(struct request_queue *q, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -070092{
93 int size, err = get_user(size, p);
94
95 if (err)
96 return err;
97
98 if (size < 0)
99 return -EINVAL;
Martin K. Petersenae03bf62009-05-22 17:17:50 -0400100 if (size > (queue_max_sectors(q) << 9))
101 size = queue_max_sectors(q) << 9;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
103 q->sg_reserved_size = size;
104 return 0;
105}
106
107/*
108 * will always return that we are ATAPI even for a real SCSI drive, I'm not
109 * so sure this is worth doing anything about (why would you care??)
110 */
Jens Axboe165125e2007-07-24 09:28:11 +0200111static int sg_emulated_host(struct request_queue *q, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112{
113 return put_user(1, p);
114}
115
Jens Axboe018e0442009-06-26 16:27:10 +0200116static void blk_set_cmd_filter_defaults(struct blk_cmd_filter *filter)
FUJITA Tomonoriabf54392008-08-16 14:10:05 +0900117{
118 /* Basic read-only commands */
119 __set_bit(TEST_UNIT_READY, filter->read_ok);
120 __set_bit(REQUEST_SENSE, filter->read_ok);
121 __set_bit(READ_6, filter->read_ok);
122 __set_bit(READ_10, filter->read_ok);
123 __set_bit(READ_12, filter->read_ok);
124 __set_bit(READ_16, filter->read_ok);
125 __set_bit(READ_BUFFER, filter->read_ok);
126 __set_bit(READ_DEFECT_DATA, filter->read_ok);
127 __set_bit(READ_CAPACITY, filter->read_ok);
128 __set_bit(READ_LONG, filter->read_ok);
129 __set_bit(INQUIRY, filter->read_ok);
130 __set_bit(MODE_SENSE, filter->read_ok);
131 __set_bit(MODE_SENSE_10, filter->read_ok);
132 __set_bit(LOG_SENSE, filter->read_ok);
133 __set_bit(START_STOP, filter->read_ok);
134 __set_bit(GPCMD_VERIFY_10, filter->read_ok);
135 __set_bit(VERIFY_16, filter->read_ok);
136 __set_bit(REPORT_LUNS, filter->read_ok);
137 __set_bit(SERVICE_ACTION_IN, filter->read_ok);
138 __set_bit(RECEIVE_DIAGNOSTIC, filter->read_ok);
139 __set_bit(MAINTENANCE_IN, filter->read_ok);
140 __set_bit(GPCMD_READ_BUFFER_CAPACITY, filter->read_ok);
141
142 /* Audio CD commands */
143 __set_bit(GPCMD_PLAY_CD, filter->read_ok);
144 __set_bit(GPCMD_PLAY_AUDIO_10, filter->read_ok);
145 __set_bit(GPCMD_PLAY_AUDIO_MSF, filter->read_ok);
146 __set_bit(GPCMD_PLAY_AUDIO_TI, filter->read_ok);
147 __set_bit(GPCMD_PAUSE_RESUME, filter->read_ok);
148
149 /* CD/DVD data reading */
150 __set_bit(GPCMD_READ_CD, filter->read_ok);
151 __set_bit(GPCMD_READ_CD_MSF, filter->read_ok);
152 __set_bit(GPCMD_READ_DISC_INFO, filter->read_ok);
153 __set_bit(GPCMD_READ_CDVD_CAPACITY, filter->read_ok);
154 __set_bit(GPCMD_READ_DVD_STRUCTURE, filter->read_ok);
155 __set_bit(GPCMD_READ_HEADER, filter->read_ok);
156 __set_bit(GPCMD_READ_TRACK_RZONE_INFO, filter->read_ok);
157 __set_bit(GPCMD_READ_SUBCHANNEL, filter->read_ok);
158 __set_bit(GPCMD_READ_TOC_PMA_ATIP, filter->read_ok);
159 __set_bit(GPCMD_REPORT_KEY, filter->read_ok);
160 __set_bit(GPCMD_SCAN, filter->read_ok);
161 __set_bit(GPCMD_GET_CONFIGURATION, filter->read_ok);
162 __set_bit(GPCMD_READ_FORMAT_CAPACITIES, filter->read_ok);
163 __set_bit(GPCMD_GET_EVENT_STATUS_NOTIFICATION, filter->read_ok);
164 __set_bit(GPCMD_GET_PERFORMANCE, filter->read_ok);
165 __set_bit(GPCMD_SEEK, filter->read_ok);
166 __set_bit(GPCMD_STOP_PLAY_SCAN, filter->read_ok);
167
168 /* Basic writing commands */
169 __set_bit(WRITE_6, filter->write_ok);
170 __set_bit(WRITE_10, filter->write_ok);
171 __set_bit(WRITE_VERIFY, filter->write_ok);
172 __set_bit(WRITE_12, filter->write_ok);
173 __set_bit(WRITE_VERIFY_12, filter->write_ok);
174 __set_bit(WRITE_16, filter->write_ok);
175 __set_bit(WRITE_LONG, filter->write_ok);
176 __set_bit(WRITE_LONG_2, filter->write_ok);
177 __set_bit(ERASE, filter->write_ok);
178 __set_bit(GPCMD_MODE_SELECT_10, filter->write_ok);
179 __set_bit(MODE_SELECT, filter->write_ok);
180 __set_bit(LOG_SELECT, filter->write_ok);
181 __set_bit(GPCMD_BLANK, filter->write_ok);
182 __set_bit(GPCMD_CLOSE_TRACK, filter->write_ok);
183 __set_bit(GPCMD_FLUSH_CACHE, filter->write_ok);
184 __set_bit(GPCMD_FORMAT_UNIT, filter->write_ok);
185 __set_bit(GPCMD_REPAIR_RZONE_TRACK, filter->write_ok);
186 __set_bit(GPCMD_RESERVE_RZONE_TRACK, filter->write_ok);
187 __set_bit(GPCMD_SEND_DVD_STRUCTURE, filter->write_ok);
188 __set_bit(GPCMD_SEND_EVENT, filter->write_ok);
189 __set_bit(GPCMD_SEND_KEY, filter->write_ok);
190 __set_bit(GPCMD_SEND_OPC, filter->write_ok);
191 __set_bit(GPCMD_SEND_CUE_SHEET, filter->write_ok);
192 __set_bit(GPCMD_SET_SPEED, filter->write_ok);
193 __set_bit(GPCMD_PREVENT_ALLOW_MEDIUM_REMOVAL, filter->write_ok);
194 __set_bit(GPCMD_LOAD_UNLOAD, filter->write_ok);
195 __set_bit(GPCMD_SET_STREAMING, filter->write_ok);
xiphmont@xiph.org35e396c2008-08-22 11:12:21 +0200196 __set_bit(GPCMD_SET_READ_AHEAD, filter->write_ok);
FUJITA Tomonoriabf54392008-08-16 14:10:05 +0900197}
Jens Axboe018e0442009-06-26 16:27:10 +0200198
199int blk_verify_command(unsigned char *cmd, fmode_t has_write_perm)
200{
201 struct blk_cmd_filter *filter = &blk_default_cmd_filter;
202
203 /* root can do any command. */
204 if (capable(CAP_SYS_RAWIO))
205 return 0;
206
207 /* if there's no filter set, assume we're filtering everything out */
208 if (!filter)
209 return -EPERM;
210
211 /* Anybody who can open the device can do a read-safe command */
212 if (test_bit(cmd[0], filter->read_ok))
213 return 0;
214
215 /* Write-safe commands require a writable open */
216 if (test_bit(cmd[0], filter->write_ok) && has_write_perm)
217 return 0;
218
219 return -EPERM;
220}
221EXPORT_SYMBOL(blk_verify_command);
FUJITA Tomonoriabf54392008-08-16 14:10:05 +0900222
Jens Axboe165125e2007-07-24 09:28:11 +0200223static int blk_fill_sghdr_rq(struct request_queue *q, struct request *rq,
Al Viro5842e512008-09-02 16:35:55 -0400224 struct sg_io_hdr *hdr, fmode_t mode)
Jens Axboe3d6392c2007-07-09 12:38:05 +0200225{
Jens Axboe3d6392c2007-07-09 12:38:05 +0200226 if (copy_from_user(rq->cmd, hdr->cmdp, hdr->cmd_len))
227 return -EFAULT;
Jens Axboe018e0442009-06-26 16:27:10 +0200228 if (blk_verify_command(rq->cmd, mode & FMODE_WRITE))
Jens Axboe3d6392c2007-07-09 12:38:05 +0200229 return -EPERM;
230
231 /*
232 * fill in request structure
233 */
234 rq->cmd_len = hdr->cmd_len;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200235
Tejun Heo24bb8fb2007-12-05 21:28:24 +0100236 rq->timeout = msecs_to_jiffies(hdr->timeout);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200237 if (!rq->timeout)
238 rq->timeout = q->sg_timeout;
239 if (!rq->timeout)
240 rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
Linus Torvaldsf2f1fa72008-12-05 14:49:18 -0800241 if (rq->timeout < BLK_MIN_SG_TIMEOUT)
242 rq->timeout = BLK_MIN_SG_TIMEOUT;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200243
244 return 0;
245}
Jens Axboe3d6392c2007-07-09 12:38:05 +0200246
FUJITA Tomonori41e17032007-07-22 10:06:50 +0900247static int blk_complete_sghdr_rq(struct request *rq, struct sg_io_hdr *hdr,
248 struct bio *bio)
Jens Axboe3d6392c2007-07-09 12:38:05 +0200249{
FUJITA Tomonori91e463c2009-04-13 20:03:10 +0200250 int r, ret = 0;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200251
252 /*
253 * fill in all the output members
254 */
255 hdr->status = rq->errors & 0xff;
256 hdr->masked_status = status_byte(rq->errors);
257 hdr->msg_status = msg_byte(rq->errors);
258 hdr->host_status = host_byte(rq->errors);
259 hdr->driver_status = driver_byte(rq->errors);
260 hdr->info = 0;
261 if (hdr->masked_status || hdr->host_status || hdr->driver_status)
262 hdr->info |= SG_INFO_CHECK;
Tejun Heoc3a4d782009-05-07 22:24:37 +0900263 hdr->resid = rq->resid_len;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200264 hdr->sb_len_wr = 0;
265
266 if (rq->sense_len && hdr->sbp) {
267 int len = min((unsigned int) hdr->mx_sb_len, rq->sense_len);
268
269 if (!copy_to_user(hdr->sbp, rq->sense, len))
270 hdr->sb_len_wr = len;
271 else
272 ret = -EFAULT;
273 }
274
FUJITA Tomonori91e463c2009-04-13 20:03:10 +0200275 r = blk_rq_unmap_user(bio);
276 if (!ret)
277 ret = r;
Boaz Harrosh1cd96c22009-03-24 12:35:07 +0100278 blk_put_request(rq);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200279
Boaz Harrosh1cd96c22009-03-24 12:35:07 +0100280 return ret;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200281}
Jens Axboe3d6392c2007-07-09 12:38:05 +0200282
Al Viro5842e512008-09-02 16:35:55 -0400283static int sg_io(struct request_queue *q, struct gendisk *bd_disk,
284 struct sg_io_hdr *hdr, fmode_t mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285{
Jens Axboe3d6392c2007-07-09 12:38:05 +0200286 unsigned long start_time;
Adel Gadllah0b07de82008-06-26 13:48:27 +0200287 int writing = 0, ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288 struct request *rq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289 char sense[SCSI_SENSE_BUFFERSIZE];
FUJITA Tomonori77d172c2006-12-11 10:01:34 +0100290 struct bio *bio;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291
292 if (hdr->interface_id != 'S')
293 return -EINVAL;
294 if (hdr->cmd_len > BLK_MAX_CDB)
295 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296
Martin K. Petersenae03bf62009-05-22 17:17:50 -0400297 if (hdr->dxfer_len > (queue_max_hw_sectors(q) << 9))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298 return -EIO;
299
James Bottomley f1970ba2005-06-20 14:06:52 +0200300 if (hdr->dxfer_len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 switch (hdr->dxfer_direction) {
302 default:
303 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 case SG_DXFER_TO_DEV:
305 writing = 1;
306 break;
Jens Axboe616e8a02006-11-13 18:04:59 +0100307 case SG_DXFER_TO_FROM_DEV:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308 case SG_DXFER_FROM_DEV:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309 break;
310 }
311
Jens Axboedd1cab92005-06-20 14:06:01 +0200312 rq = blk_get_request(q, writing ? WRITE : READ, GFP_KERNEL);
313 if (!rq)
314 return -ENOMEM;
Jens Axboea6c6cb82014-06-06 07:57:37 -0600315 blk_rq_set_block_pc(rq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316
Al Viro5842e512008-09-02 16:35:55 -0400317 if (blk_fill_sghdr_rq(q, rq, hdr, mode)) {
Jens Axboe3d6392c2007-07-09 12:38:05 +0200318 blk_put_request(rq);
319 return -EFAULT;
320 }
Mike Christie0e75f902006-12-01 10:40:55 +0100321
James Bottomley f1970ba2005-06-20 14:06:52 +0200322 if (hdr->iovec_count) {
323 const int size = sizeof(struct sg_iovec) * hdr->iovec_count;
Tejun Heo25636e22009-04-15 22:10:24 +0900324 size_t iov_data_len;
Jens Axboe9f864c82010-10-29 11:31:42 -0600325 struct sg_iovec *sg_iov;
326 struct iovec *iov;
327 int i;
James Bottomley f1970ba2005-06-20 14:06:52 +0200328
Jens Axboe9f864c82010-10-29 11:31:42 -0600329 sg_iov = kmalloc(size, GFP_KERNEL);
330 if (!sg_iov) {
James Bottomley f1970ba2005-06-20 14:06:52 +0200331 ret = -ENOMEM;
Jens Axboedd1cab92005-06-20 14:06:01 +0200332 goto out;
James Bottomley f1970ba2005-06-20 14:06:52 +0200333 }
334
Jens Axboe9f864c82010-10-29 11:31:42 -0600335 if (copy_from_user(sg_iov, hdr->dxferp, size)) {
336 kfree(sg_iov);
James Bottomley f1970ba2005-06-20 14:06:52 +0200337 ret = -EFAULT;
338 goto out;
339 }
340
Jens Axboe9f864c82010-10-29 11:31:42 -0600341 /*
342 * Sum up the vecs, making sure they don't overflow
343 */
344 iov = (struct iovec *) sg_iov;
345 iov_data_len = 0;
346 for (i = 0; i < hdr->iovec_count; i++) {
347 if (iov_data_len + iov[i].iov_len < iov_data_len) {
348 kfree(sg_iov);
349 ret = -EINVAL;
350 goto out;
351 }
352 iov_data_len += iov[i].iov_len;
353 }
354
Tejun Heo25636e22009-04-15 22:10:24 +0900355 /* SG_IO howto says that the shorter of the two wins */
Tejun Heo25636e22009-04-15 22:10:24 +0900356 if (hdr->dxfer_len < iov_data_len) {
Jens Axboe9f864c82010-10-29 11:31:42 -0600357 hdr->iovec_count = iov_shorten(iov,
Tejun Heo25636e22009-04-15 22:10:24 +0900358 hdr->iovec_count,
359 hdr->dxfer_len);
360 iov_data_len = hdr->dxfer_len;
361 }
362
Jens Axboe9f864c82010-10-29 11:31:42 -0600363 ret = blk_rq_map_user_iov(q, rq, NULL, sg_iov, hdr->iovec_count,
Tejun Heo25636e22009-04-15 22:10:24 +0900364 iov_data_len, GFP_KERNEL);
Jens Axboe9f864c82010-10-29 11:31:42 -0600365 kfree(sg_iov);
James Bottomley f1970ba2005-06-20 14:06:52 +0200366 } else if (hdr->dxfer_len)
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900367 ret = blk_rq_map_user(q, rq, NULL, hdr->dxferp, hdr->dxfer_len,
FUJITA Tomonoria3bce902008-08-28 16:17:05 +0900368 GFP_KERNEL);
James Bottomley f1970ba2005-06-20 14:06:52 +0200369
370 if (ret)
371 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372
FUJITA Tomonori77d172c2006-12-11 10:01:34 +0100373 bio = rq->bio;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200374 memset(sense, 0, sizeof(sense));
375 rq->sense = sense;
376 rq->sense_len = 0;
Jens Axboe01840f92006-02-03 08:37:08 +0100377 rq->retries = 0;
378
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379 start_time = jiffies;
380
381 /* ignore return value. All information is passed back to caller
382 * (if he doesn't check that is his problem).
383 * N.B. a non-zero SCSI status is _not_ necessarily an error.
384 */
James Bottomley 994ca9a2005-06-20 14:11:09 +0200385 blk_execute_rq(q, bd_disk, rq, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386
Tejun Heo24bb8fb2007-12-05 21:28:24 +0100387 hdr->duration = jiffies_to_msecs(jiffies - start_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388
Jens Axboe3d6392c2007-07-09 12:38:05 +0200389 return blk_complete_sghdr_rq(rq, hdr, bio);
Jens Axboedd1cab92005-06-20 14:06:01 +0200390out:
391 blk_put_request(rq);
392 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393}
394
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100395/**
396 * sg_scsi_ioctl -- handle deprecated SCSI_IOCTL_SEND_COMMAND ioctl
397 * @file: file this ioctl operates on (optional)
398 * @q: request queue to send scsi commands down
399 * @disk: gendisk to operate on (option)
400 * @sic: userspace structure describing the command to perform
401 *
402 * Send down the scsi command described by @sic to the device below
403 * the request queue @q. If @file is non-NULL it's used to perform
404 * fine-grained permission checks that allow users to send down
405 * non-destructive SCSI commands. If the caller has a struct gendisk
406 * available it should be passed in as @disk to allow the low level
407 * driver to use the information contained in it. A non-NULL @disk
408 * is only allowed if the caller knows that the low level driver doesn't
409 * need it (e.g. in the scsi subsystem).
410 *
411 * Notes:
412 * - This interface is deprecated - users should use the SG_IO
413 * interface instead, as this is a more flexible approach to
414 * performing SCSI commands on a device.
415 * - The SCSI command length is determined by examining the 1st byte
416 * of the given command. There is no way to override this.
417 * - Data transfers are limited to PAGE_SIZE
418 * - The length (x + y) must be at least OMAX_SB_LEN bytes long to
419 * accommodate the sense buffer when an error occurs.
420 * The sense buffer is truncated to OMAX_SB_LEN (16) bytes so that
421 * old code will not be surprised.
422 * - If a Unix error occurs (e.g. ENOMEM) then the user will receive
423 * a negative return and the Unix error code in 'errno'.
424 * If the SCSI command succeeds then 0 is returned.
425 * Positive numbers returned are the compacted SCSI error codes (4
426 * bytes in one int) where the lowest byte is the SCSI status.
427 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428#define OMAX_SB_LEN 16 /* For backward compatibility */
Al Viroe915e872008-09-02 17:16:41 -0400429int sg_scsi_ioctl(struct request_queue *q, struct gendisk *disk, fmode_t mode,
430 struct scsi_ioctl_command __user *sic)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431{
432 struct request *rq;
Al Viroaeb5d722008-09-02 15:28:45 -0400433 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 unsigned int in_len, out_len, bytes, opcode, cmdlen;
435 char *buffer = NULL, sense[SCSI_SENSE_BUFFERSIZE];
436
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100437 if (!sic)
438 return -EINVAL;
439
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 /*
441 * get in an out lengths, verify they don't exceed a page worth of data
442 */
443 if (get_user(in_len, &sic->inlen))
444 return -EFAULT;
445 if (get_user(out_len, &sic->outlen))
446 return -EFAULT;
447 if (in_len > PAGE_SIZE || out_len > PAGE_SIZE)
448 return -EINVAL;
449 if (get_user(opcode, sic->data))
450 return -EFAULT;
451
452 bytes = max(in_len, out_len);
453 if (bytes) {
Yoann Padioleaudd00cc42007-07-19 01:49:03 -0700454 buffer = kzalloc(bytes, q->bounce_gfp | GFP_USER| __GFP_NOWARN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 if (!buffer)
456 return -ENOMEM;
457
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 }
459
460 rq = blk_get_request(q, in_len ? WRITE : READ, __GFP_WAIT);
461
462 cmdlen = COMMAND_SIZE(opcode);
463
464 /*
465 * get command and data to send to device, if any
466 */
467 err = -EFAULT;
468 rq->cmd_len = cmdlen;
469 if (copy_from_user(rq->cmd, sic->data, cmdlen))
470 goto error;
471
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100472 if (in_len && copy_from_user(buffer, sic->data + cmdlen, in_len))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 goto error;
474
Jens Axboe018e0442009-06-26 16:27:10 +0200475 err = blk_verify_command(rq->cmd, mode & FMODE_WRITE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 if (err)
477 goto error;
478
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100479 /* default. possible overriden later */
480 rq->retries = 5;
481
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 switch (opcode) {
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100483 case SEND_DIAGNOSTIC:
484 case FORMAT_UNIT:
485 rq->timeout = FORMAT_UNIT_TIMEOUT;
486 rq->retries = 1;
487 break;
488 case START_STOP:
489 rq->timeout = START_STOP_TIMEOUT;
490 break;
491 case MOVE_MEDIUM:
492 rq->timeout = MOVE_MEDIUM_TIMEOUT;
493 break;
494 case READ_ELEMENT_STATUS:
495 rq->timeout = READ_ELEMENT_STATUS_TIMEOUT;
496 break;
497 case READ_DEFECT_DATA:
498 rq->timeout = READ_DEFECT_DATA_TIMEOUT;
499 rq->retries = 1;
500 break;
501 default:
Jens Axboe3d6392c2007-07-09 12:38:05 +0200502 rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100503 break;
504 }
505
506 if (bytes && blk_rq_map_kern(q, rq, buffer, bytes, __GFP_WAIT)) {
507 err = DRIVER_ERROR << 24;
Jan Kara46b6b132014-10-22 20:13:39 -0600508 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 }
510
511 memset(sense, 0, sizeof(sense));
512 rq->sense = sense;
513 rq->sense_len = 0;
Jens Axboea6c6cb82014-06-06 07:57:37 -0600514 blk_rq_set_block_pc(rq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100516 blk_execute_rq(q, disk, rq, 0);
517
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 err = rq->errors & 0xff; /* only 8 bit SCSI status */
519 if (err) {
520 if (rq->sense_len && rq->sense) {
521 bytes = (OMAX_SB_LEN > rq->sense_len) ?
522 rq->sense_len : OMAX_SB_LEN;
523 if (copy_to_user(sic->data, rq->sense, bytes))
524 err = -EFAULT;
525 }
526 } else {
527 if (copy_to_user(sic->data, buffer, out_len))
528 err = -EFAULT;
529 }
530
531error:
532 kfree(buffer);
533 blk_put_request(rq);
534 return err;
535}
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100536EXPORT_SYMBOL_GPL(sg_scsi_ioctl);
Ben Collinsf98d2df2005-12-19 11:49:24 -0800537
538/* Send basic block requests */
Jens Axboe165125e2007-07-24 09:28:11 +0200539static int __blk_send_generic(struct request_queue *q, struct gendisk *bd_disk,
540 int cmd, int data)
Ben Collinsf98d2df2005-12-19 11:49:24 -0800541{
542 struct request *rq;
543 int err;
544
545 rq = blk_get_request(q, WRITE, __GFP_WAIT);
Jens Axboea6c6cb82014-06-06 07:57:37 -0600546 blk_rq_set_block_pc(rq);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200547 rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
Ben Collinsf98d2df2005-12-19 11:49:24 -0800548 rq->cmd[0] = cmd;
549 rq->cmd[4] = data;
550 rq->cmd_len = 6;
551 err = blk_execute_rq(q, bd_disk, rq, 0);
552 blk_put_request(rq);
553
554 return err;
555}
556
Jens Axboe165125e2007-07-24 09:28:11 +0200557static inline int blk_send_start_stop(struct request_queue *q,
558 struct gendisk *bd_disk, int data)
Ben Collinsf98d2df2005-12-19 11:49:24 -0800559{
560 return __blk_send_generic(q, bd_disk, GPCMD_START_STOP_UNIT, data);
561}
562
Al Viro74f3c8a2007-08-27 15:38:10 -0400563int scsi_cmd_ioctl(struct request_queue *q, struct gendisk *bd_disk, fmode_t mode,
564 unsigned int cmd, void __user *arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565{
Ben Collinsf98d2df2005-12-19 11:49:24 -0800566 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567
Tejun Heo315fcee2011-10-19 14:31:25 +0200568 if (!q)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569 return -ENXIO;
570
571 switch (cmd) {
572 /*
573 * new sgv3 interface
574 */
575 case SG_GET_VERSION_NUM:
576 err = sg_get_version(arg);
577 break;
578 case SCSI_IOCTL_GET_IDLUN:
579 err = scsi_get_idlun(q, arg);
580 break;
581 case SCSI_IOCTL_GET_BUS_NUMBER:
582 err = scsi_get_bus(q, arg);
583 break;
584 case SG_SET_TIMEOUT:
585 err = sg_set_timeout(q, arg);
586 break;
587 case SG_GET_TIMEOUT:
588 err = sg_get_timeout(q);
589 break;
590 case SG_GET_RESERVED_SIZE:
591 err = sg_get_reserved_size(q, arg);
592 break;
593 case SG_SET_RESERVED_SIZE:
594 err = sg_set_reserved_size(q, arg);
595 break;
596 case SG_EMULATED_HOST:
597 err = sg_emulated_host(q, arg);
598 break;
599 case SG_IO: {
600 struct sg_io_hdr hdr;
601
602 err = -EFAULT;
603 if (copy_from_user(&hdr, arg, sizeof(hdr)))
604 break;
Al Viro74f3c8a2007-08-27 15:38:10 -0400605 err = sg_io(q, bd_disk, &hdr, mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 if (err == -EFAULT)
607 break;
608
609 if (copy_to_user(arg, &hdr, sizeof(hdr)))
610 err = -EFAULT;
611 break;
612 }
613 case CDROM_SEND_PACKET: {
614 struct cdrom_generic_command cgc;
615 struct sg_io_hdr hdr;
616
617 err = -EFAULT;
618 if (copy_from_user(&cgc, arg, sizeof(cgc)))
619 break;
620 cgc.timeout = clock_t_to_jiffies(cgc.timeout);
621 memset(&hdr, 0, sizeof(hdr));
622 hdr.interface_id = 'S';
623 hdr.cmd_len = sizeof(cgc.cmd);
624 hdr.dxfer_len = cgc.buflen;
625 err = 0;
626 switch (cgc.data_direction) {
627 case CGC_DATA_UNKNOWN:
628 hdr.dxfer_direction = SG_DXFER_UNKNOWN;
629 break;
630 case CGC_DATA_WRITE:
631 hdr.dxfer_direction = SG_DXFER_TO_DEV;
632 break;
633 case CGC_DATA_READ:
634 hdr.dxfer_direction = SG_DXFER_FROM_DEV;
635 break;
636 case CGC_DATA_NONE:
637 hdr.dxfer_direction = SG_DXFER_NONE;
638 break;
639 default:
640 err = -EINVAL;
641 }
642 if (err)
643 break;
644
645 hdr.dxferp = cgc.buffer;
646 hdr.sbp = cgc.sense;
647 if (hdr.sbp)
648 hdr.mx_sb_len = sizeof(struct request_sense);
Tim Wrightad337592008-07-27 17:50:38 -0700649 hdr.timeout = jiffies_to_msecs(cgc.timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 hdr.cmdp = ((struct cdrom_generic_command __user*) arg)->cmd;
651 hdr.cmd_len = sizeof(cgc.cmd);
652
Al Viro74f3c8a2007-08-27 15:38:10 -0400653 err = sg_io(q, bd_disk, &hdr, mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654 if (err == -EFAULT)
655 break;
656
657 if (hdr.status)
658 err = -EIO;
659
660 cgc.stat = err;
661 cgc.buflen = hdr.resid;
662 if (copy_to_user(arg, &cgc, sizeof(cgc)))
663 err = -EFAULT;
664
665 break;
666 }
667
668 /*
669 * old junk scsi send command ioctl
670 */
671 case SCSI_IOCTL_SEND_COMMAND:
672 printk(KERN_WARNING "program %s is using a deprecated SCSI ioctl, please convert it to SG_IO\n", current->comm);
673 err = -EINVAL;
674 if (!arg)
675 break;
676
Al Viro74f3c8a2007-08-27 15:38:10 -0400677 err = sg_scsi_ioctl(q, bd_disk, mode, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678 break;
679 case CDROMCLOSETRAY:
Ben Collinsf98d2df2005-12-19 11:49:24 -0800680 err = blk_send_start_stop(q, bd_disk, 0x03);
681 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 case CDROMEJECT:
Ben Collinsf98d2df2005-12-19 11:49:24 -0800683 err = blk_send_start_stop(q, bd_disk, 0x02);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 break;
685 default:
686 err = -ENOTTY;
687 }
688
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689 return err;
690}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691EXPORT_SYMBOL(scsi_cmd_ioctl);
Jens Axboe018e0442009-06-26 16:27:10 +0200692
Paolo Bonzini0bfc96c2012-01-12 16:01:28 +0100693int scsi_verify_blk_ioctl(struct block_device *bd, unsigned int cmd)
694{
695 if (bd && bd == bd->bd_contains)
696 return 0;
697
698 /* Actually none of these is particularly useful on a partition,
699 * but they are safe.
700 */
701 switch (cmd) {
702 case SCSI_IOCTL_GET_IDLUN:
703 case SCSI_IOCTL_GET_BUS_NUMBER:
704 case SCSI_IOCTL_GET_PCI:
705 case SCSI_IOCTL_PROBE_HOST:
706 case SG_GET_VERSION_NUM:
707 case SG_SET_TIMEOUT:
708 case SG_GET_TIMEOUT:
709 case SG_GET_RESERVED_SIZE:
710 case SG_SET_RESERVED_SIZE:
711 case SG_EMULATED_HOST:
712 return 0;
713 case CDROM_GET_CAPABILITY:
714 /* Keep this until we remove the printk below. udev sends it
715 * and we do not want to spam dmesg about it. CD-ROMs do
716 * not have partitions, so we get here only for disks.
717 */
718 return -ENOIOCTLCMD;
719 default:
720 break;
721 }
722
Jan Kara1d84ca32012-06-15 12:52:46 +0200723 if (capable(CAP_SYS_RAWIO))
724 return 0;
725
Paolo Bonzini0bfc96c2012-01-12 16:01:28 +0100726 /* In particular, rule out all resets and host-specific ioctls. */
727 printk_ratelimited(KERN_WARNING
728 "%s: sending ioctl %x to a partition!\n", current->comm, cmd);
729
Jan Kara1d84ca32012-06-15 12:52:46 +0200730 return -ENOIOCTLCMD;
Paolo Bonzini0bfc96c2012-01-12 16:01:28 +0100731}
732EXPORT_SYMBOL(scsi_verify_blk_ioctl);
733
Paolo Bonzini577ebb32012-01-12 16:01:27 +0100734int scsi_cmd_blk_ioctl(struct block_device *bd, fmode_t mode,
735 unsigned int cmd, void __user *arg)
736{
Paolo Bonzini0bfc96c2012-01-12 16:01:28 +0100737 int ret;
738
739 ret = scsi_verify_blk_ioctl(bd, cmd);
740 if (ret < 0)
741 return ret;
742
Paolo Bonzini577ebb32012-01-12 16:01:27 +0100743 return scsi_cmd_ioctl(bd->bd_disk->queue, bd->bd_disk, mode, cmd, arg);
744}
745EXPORT_SYMBOL(scsi_cmd_blk_ioctl);
746
H Hartley Sweeten476d42f2009-11-04 09:10:33 +0100747static int __init blk_scsi_ioctl_init(void)
Jens Axboe018e0442009-06-26 16:27:10 +0200748{
749 blk_set_cmd_filter_defaults(&blk_default_cmd_filter);
750 return 0;
751}
FUJITA Tomonori76da0342009-07-09 09:48:28 +0200752fs_initcall(blk_scsi_ioctl_init);