blob: f5e0ad65e86acf9033e0be47005ccb25e3700a31 [file] [log] [blame]
Christoph Hellwig8c165672019-04-30 14:42:39 -04001// SPDX-License-Identifier: GPL-2.0
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * Copyright (C) 2001 Jens Axboe <axboe@suse.de>
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 */
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>
Randy.Dunlapc59ede72006-01-11 12:17:46 -080010#include <linux/capability.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070011#include <linux/completion.h>
12#include <linux/cdrom.h>
Paolo Bonzini0bfc96c2012-01-12 16:01:28 +010013#include <linux/ratelimit.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070014#include <linux/slab.h>
15#include <linux/times.h>
Kent Overstreeta27bb332013-05-07 16:19:08 -070016#include <linux/uio.h>
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -080017#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018
19#include <scsi/scsi.h>
20#include <scsi/scsi_ioctl.h>
21#include <scsi/scsi_cmnd.h>
22
Jens Axboe018e0442009-06-26 16:27:10 +020023struct blk_cmd_filter {
24 unsigned long read_ok[BLK_SCSI_CMD_PER_LONG];
25 unsigned long write_ok[BLK_SCSI_CMD_PER_LONG];
H Hartley Sweeten476d42f2009-11-04 09:10:33 +010026};
27
28static struct blk_cmd_filter blk_default_cmd_filter;
Jens Axboe018e0442009-06-26 16:27:10 +020029
Linus Torvalds1da177e2005-04-16 15:20:36 -070030/* Command group 3 is reserved and should never be used. */
Boaz Harroshdb4742d2008-04-30 11:27:26 +030031const unsigned char scsi_command_size_tbl[8] =
Linus Torvalds1da177e2005-04-16 15:20:36 -070032{
33 6, 10, 10, 12,
34 16, 12, 10, 10
35};
Boaz Harroshdb4742d2008-04-30 11:27:26 +030036EXPORT_SYMBOL(scsi_command_size_tbl);
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
Linus Torvalds1da177e2005-04-16 15:20:36 -070038#include <scsi/sg.h>
39
40static int sg_get_version(int __user *p)
41{
Arjan van de Ven64100092006-01-06 09:46:02 +010042 static const int sg_version_num = 30527;
Linus Torvalds1da177e2005-04-16 15:20:36 -070043 return put_user(sg_version_num, p);
44}
45
Jens Axboe165125e2007-07-24 09:28:11 +020046static int scsi_get_idlun(struct request_queue *q, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -070047{
48 return put_user(0, p);
49}
50
Jens Axboe165125e2007-07-24 09:28:11 +020051static int scsi_get_bus(struct request_queue *q, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -070052{
53 return put_user(0, p);
54}
55
Jens Axboe165125e2007-07-24 09:28:11 +020056static int sg_get_timeout(struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -070057{
Milton Miller2b91baf2008-11-17 13:10:34 +010058 return jiffies_to_clock_t(q->sg_timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -070059}
60
Jens Axboe165125e2007-07-24 09:28:11 +020061static int sg_set_timeout(struct request_queue *q, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -070062{
63 int timeout, err = get_user(timeout, p);
64
65 if (!err)
Milton Miller2b91baf2008-11-17 13:10:34 +010066 q->sg_timeout = clock_t_to_jiffies(timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -070067
68 return err;
69}
70
Akinobu Mita9b4231b2014-05-25 21:43:34 +090071static int max_sectors_bytes(struct request_queue *q)
72{
73 unsigned int max_sectors = queue_max_sectors(q);
74
75 max_sectors = min_t(unsigned int, max_sectors, INT_MAX >> 9);
76
77 return max_sectors << 9;
78}
79
Jens Axboe165125e2007-07-24 09:28:11 +020080static int sg_get_reserved_size(struct request_queue *q, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -070081{
Akinobu Mita9b4231b2014-05-25 21:43:34 +090082 int val = min_t(int, q->sg_reserved_size, max_sectors_bytes(q));
Alan Stern44ec9542007-02-20 11:01:57 -050083
84 return put_user(val, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -070085}
86
Jens Axboe165125e2007-07-24 09:28:11 +020087static int sg_set_reserved_size(struct request_queue *q, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -070088{
89 int size, err = get_user(size, p);
90
91 if (err)
92 return err;
93
94 if (size < 0)
95 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -070096
Akinobu Mita9b4231b2014-05-25 21:43:34 +090097 q->sg_reserved_size = min(size, max_sectors_bytes(q));
Linus Torvalds1da177e2005-04-16 15:20:36 -070098 return 0;
99}
100
101/*
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??)
104 */
Jens Axboe165125e2007-07-24 09:28:11 +0200105static int sg_emulated_host(struct request_queue *q, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106{
107 return put_user(1, p);
108}
109
Jens Axboe018e0442009-06-26 16:27:10 +0200110static void blk_set_cmd_filter_defaults(struct blk_cmd_filter *filter)
FUJITA Tomonoriabf54392008-08-16 14:10:05 +0900111{
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);
Hannes Reineckeeb846d92014-11-17 14:25:19 +0100131 __set_bit(SERVICE_ACTION_IN_16, filter->read_ok);
FUJITA Tomonoriabf54392008-08-16 14:10:05 +0900132 __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);
135
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);
142
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);
161
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);
Mauricio Faria de Oliveira25cdb642016-12-15 11:48:18 -0600171 __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);
FUJITA Tomonoriabf54392008-08-16 14:10:05 +0900174 __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);
xiphmont@xiph.org35e396c2008-08-22 11:12:21 +0200193 __set_bit(GPCMD_SET_READ_AHEAD, filter->write_ok);
FUJITA Tomonoriabf54392008-08-16 14:10:05 +0900194}
Jens Axboe018e0442009-06-26 16:27:10 +0200195
Christoph Hellwigf00c4d82017-11-05 10:36:31 +0300196int blk_verify_command(unsigned char *cmd, fmode_t mode)
Jens Axboe018e0442009-06-26 16:27:10 +0200197{
198 struct blk_cmd_filter *filter = &blk_default_cmd_filter;
199
200 /* root can do any command. */
201 if (capable(CAP_SYS_RAWIO))
202 return 0;
203
Jens Axboe018e0442009-06-26 16:27:10 +0200204 /* Anybody who can open the device can do a read-safe command */
205 if (test_bit(cmd[0], filter->read_ok))
206 return 0;
207
208 /* Write-safe commands require a writable open */
Christoph Hellwigf00c4d82017-11-05 10:36:31 +0300209 if (test_bit(cmd[0], filter->write_ok) && (mode & FMODE_WRITE))
Jens Axboe018e0442009-06-26 16:27:10 +0200210 return 0;
211
212 return -EPERM;
213}
214EXPORT_SYMBOL(blk_verify_command);
FUJITA Tomonoriabf54392008-08-16 14:10:05 +0900215
Jens Axboe165125e2007-07-24 09:28:11 +0200216static int blk_fill_sghdr_rq(struct request_queue *q, struct request *rq,
Al Viro5842e512008-09-02 16:35:55 -0400217 struct sg_io_hdr *hdr, fmode_t mode)
Jens Axboe3d6392c2007-07-09 12:38:05 +0200218{
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100219 struct scsi_request *req = scsi_req(rq);
220
221 if (copy_from_user(req->cmd, hdr->cmdp, hdr->cmd_len))
Jens Axboe3d6392c2007-07-09 12:38:05 +0200222 return -EFAULT;
Christoph Hellwigf00c4d82017-11-05 10:36:31 +0300223 if (blk_verify_command(req->cmd, mode))
Jens Axboe3d6392c2007-07-09 12:38:05 +0200224 return -EPERM;
225
226 /*
227 * fill in request structure
228 */
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100229 req->cmd_len = hdr->cmd_len;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200230
Tejun Heo24bb8fb2007-12-05 21:28:24 +0100231 rq->timeout = msecs_to_jiffies(hdr->timeout);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200232 if (!rq->timeout)
233 rq->timeout = q->sg_timeout;
234 if (!rq->timeout)
235 rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
Linus Torvaldsf2f1fa72008-12-05 14:49:18 -0800236 if (rq->timeout < BLK_MIN_SG_TIMEOUT)
237 rq->timeout = BLK_MIN_SG_TIMEOUT;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200238
239 return 0;
240}
Jens Axboe3d6392c2007-07-09 12:38:05 +0200241
FUJITA Tomonori41e17032007-07-22 10:06:50 +0900242static int blk_complete_sghdr_rq(struct request *rq, struct sg_io_hdr *hdr,
243 struct bio *bio)
Jens Axboe3d6392c2007-07-09 12:38:05 +0200244{
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100245 struct scsi_request *req = scsi_req(rq);
FUJITA Tomonori91e463c2009-04-13 20:03:10 +0200246 int r, ret = 0;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200247
248 /*
249 * fill in all the output members
250 */
Christoph Hellwig17d53632017-04-20 16:03:01 +0200251 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);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200256 hdr->info = 0;
257 if (hdr->masked_status || hdr->host_status || hdr->driver_status)
258 hdr->info |= SG_INFO_CHECK;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100259 hdr->resid = req->resid_len;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200260 hdr->sb_len_wr = 0;
261
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100262 if (req->sense_len && hdr->sbp) {
263 int len = min((unsigned int) hdr->mx_sb_len, req->sense_len);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200264
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100265 if (!copy_to_user(hdr->sbp, req->sense, len))
Jens Axboe3d6392c2007-07-09 12:38:05 +0200266 hdr->sb_len_wr = len;
267 else
268 ret = -EFAULT;
269 }
270
FUJITA Tomonori91e463c2009-04-13 20:03:10 +0200271 r = blk_rq_unmap_user(bio);
272 if (!ret)
273 ret = r;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200274
Boaz Harrosh1cd96c22009-03-24 12:35:07 +0100275 return ret;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200276}
Jens Axboe3d6392c2007-07-09 12:38:05 +0200277
Al Viro5842e512008-09-02 16:35:55 -0400278static int sg_io(struct request_queue *q, struct gendisk *bd_disk,
279 struct sg_io_hdr *hdr, fmode_t mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280{
Jens Axboe3d6392c2007-07-09 12:38:05 +0200281 unsigned long start_time;
Kent Overstreete0ce0ea2013-08-07 14:20:17 -0700282 ssize_t ret = 0;
283 int writing = 0;
Douglas Gilbertd1515612014-07-01 10:48:05 -0600284 int at_head = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285 struct request *rq;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100286 struct scsi_request *req;
FUJITA Tomonori77d172c2006-12-11 10:01:34 +0100287 struct bio *bio;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288
289 if (hdr->interface_id != 'S')
290 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291
Martin K. Petersenae03bf62009-05-22 17:17:50 -0400292 if (hdr->dxfer_len > (queue_max_hw_sectors(q) << 9))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293 return -EIO;
294
James Bottomley f1970ba2005-06-20 14:06:52 +0200295 if (hdr->dxfer_len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 switch (hdr->dxfer_direction) {
297 default:
298 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299 case SG_DXFER_TO_DEV:
300 writing = 1;
301 break;
Jens Axboe616e8a02006-11-13 18:04:59 +0100302 case SG_DXFER_TO_FROM_DEV:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 case SG_DXFER_FROM_DEV:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 break;
305 }
Douglas Gilbertd1515612014-07-01 10:48:05 -0600306 if (hdr->flags & SG_FLAG_Q_AT_HEAD)
307 at_head = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308
Christoph Hellwiga57821c2014-08-21 20:39:53 -0500309 ret = -ENOMEM;
Christoph Hellwigff005a02018-05-09 09:54:05 +0200310 rq = blk_get_request(q, writing ? REQ_OP_SCSI_OUT : REQ_OP_SCSI_IN, 0);
Joe Lawrencea492f072014-08-28 08:15:21 -0600311 if (IS_ERR(rq))
312 return PTR_ERR(rq);
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100313 req = scsi_req(rq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314
Christoph Hellwiga57821c2014-08-21 20:39:53 -0500315 if (hdr->cmd_len > BLK_MAX_CDB) {
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100316 req->cmd = kzalloc(hdr->cmd_len, GFP_KERNEL);
317 if (!req->cmd)
Christoph Hellwiga57821c2014-08-21 20:39:53 -0500318 goto out_put_request;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200319 }
Mike Christie0e75f902006-12-01 10:40:55 +0100320
Paolo Bonzini2c4cffe2015-06-26 11:44:46 +0200321 ret = blk_fill_sghdr_rq(q, rq, hdr, mode);
322 if (ret < 0)
Christoph Hellwiga57821c2014-08-21 20:39:53 -0500323 goto out_free_cdb;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324
Sabrina Dubrocad19d7442014-08-26 16:14:02 +0200325 ret = 0;
James Bottomley f1970ba2005-06-20 14:06:52 +0200326 if (hdr->iovec_count) {
Kent Overstreet26e49cf2015-01-18 16:16:31 +0100327 struct iov_iter i;
Christian Engelmayer17a05cc2014-01-19 02:08:49 +0100328 struct iovec *iov = NULL;
James Bottomley f1970ba2005-06-20 14:06:52 +0200329
Al Viroe272b892015-03-21 20:02:55 -0400330 ret = import_iovec(rq_data_dir(rq),
331 hdr->dxferp, hdr->iovec_count,
332 0, &iov, &i);
333 if (ret < 0)
Christoph Hellwiga57821c2014-08-21 20:39:53 -0500334 goto out_free_cdb;
James Bottomley f1970ba2005-06-20 14:06:52 +0200335
Tejun Heo25636e22009-04-15 22:10:24 +0900336 /* SG_IO howto says that the shorter of the two wins */
Al Viroe272b892015-03-21 20:02:55 -0400337 iov_iter_truncate(&i, hdr->dxfer_len);
Tejun Heo25636e22009-04-15 22:10:24 +0900338
Kent Overstreet26e49cf2015-01-18 16:16:31 +0100339 ret = blk_rq_map_user_iov(q, rq, NULL, &i, GFP_KERNEL);
Kent Overstreete0ce0ea2013-08-07 14:20:17 -0700340 kfree(iov);
James Bottomley f1970ba2005-06-20 14:06:52 +0200341 } else if (hdr->dxfer_len)
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900342 ret = blk_rq_map_user(q, rq, NULL, hdr->dxferp, hdr->dxfer_len,
FUJITA Tomonoria3bce902008-08-28 16:17:05 +0900343 GFP_KERNEL);
James Bottomley f1970ba2005-06-20 14:06:52 +0200344
345 if (ret)
Christoph Hellwiga57821c2014-08-21 20:39:53 -0500346 goto out_free_cdb;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347
FUJITA Tomonori77d172c2006-12-11 10:01:34 +0100348 bio = rq->bio;
Christoph Hellwig64c7f1d2017-04-05 19:18:12 +0200349 req->retries = 0;
Jens Axboe01840f92006-02-03 08:37:08 +0100350
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 start_time = jiffies;
352
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.
356 */
Douglas Gilbertd1515612014-07-01 10:48:05 -0600357 blk_execute_rq(q, bd_disk, rq, at_head);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358
Tejun Heo24bb8fb2007-12-05 21:28:24 +0100359 hdr->duration = jiffies_to_msecs(jiffies - start_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360
Christoph Hellwig2cada582014-08-21 20:38:27 -0500361 ret = blk_complete_sghdr_rq(rq, hdr, bio);
Christoph Hellwiga57821c2014-08-21 20:39:53 -0500362
363out_free_cdb:
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100364 scsi_req_free_cmd(req);
Christoph Hellwiga57821c2014-08-21 20:39:53 -0500365out_put_request:
Jens Axboedd1cab92005-06-20 14:06:01 +0200366 blk_put_request(rq);
367 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368}
369
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100370/**
371 * sg_scsi_ioctl -- handle deprecated SCSI_IOCTL_SEND_COMMAND ioctl
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100372 * @q: request queue to send scsi commands down
373 * @disk: gendisk to operate on (option)
Bart Van Asscheaa981922018-01-09 10:11:00 -0800374 * @mode: mode used to open the file through which the ioctl has been
375 * submitted
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100376 * @sic: userspace structure describing the command to perform
377 *
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).
386 *
387 * Notes:
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.
403 */
Al Viroe915e872008-09-02 17:16:41 -0400404int sg_scsi_ioctl(struct request_queue *q, struct gendisk *disk, fmode_t mode,
405 struct scsi_ioctl_command __user *sic)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406{
Bart Van Asscheaa981922018-01-09 10:11:00 -0800407 enum { OMAX_SB_LEN = 16 }; /* For backward compatibility */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408 struct request *rq;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100409 struct scsi_request *req;
Al Viroaeb5d722008-09-02 15:28:45 -0400410 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 unsigned int in_len, out_len, bytes, opcode, cmdlen;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100412 char *buffer = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100414 if (!sic)
415 return -EINVAL;
416
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 /*
418 * get in an out lengths, verify they don't exceed a page worth of data
419 */
420 if (get_user(in_len, &sic->inlen))
421 return -EFAULT;
422 if (get_user(out_len, &sic->outlen))
423 return -EFAULT;
424 if (in_len > PAGE_SIZE || out_len > PAGE_SIZE)
425 return -EINVAL;
426 if (get_user(opcode, sic->data))
427 return -EFAULT;
428
429 bytes = max(in_len, out_len);
430 if (bytes) {
Yoann Padioleaudd00cc42007-07-19 01:49:03 -0700431 buffer = kzalloc(bytes, q->bounce_gfp | GFP_USER| __GFP_NOWARN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432 if (!buffer)
433 return -ENOMEM;
434
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 }
436
Christoph Hellwigff005a02018-05-09 09:54:05 +0200437 rq = blk_get_request(q, in_len ? REQ_OP_SCSI_OUT : REQ_OP_SCSI_IN, 0);
Joe Lawrencea492f072014-08-28 08:15:21 -0600438 if (IS_ERR(rq)) {
439 err = PTR_ERR(rq);
Tony Battersby92697dc2014-11-10 17:40:02 -0500440 goto error_free_buffer;
Joe Lawrenceeb571ee2014-07-02 15:35:16 -0400441 }
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100442 req = scsi_req(rq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443
444 cmdlen = COMMAND_SIZE(opcode);
445
446 /*
447 * get command and data to send to device, if any
448 */
449 err = -EFAULT;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100450 req->cmd_len = cmdlen;
451 if (copy_from_user(req->cmd, sic->data, cmdlen))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 goto error;
453
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100454 if (in_len && copy_from_user(buffer, sic->data + cmdlen, in_len))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 goto error;
456
Christoph Hellwigf00c4d82017-11-05 10:36:31 +0300457 err = blk_verify_command(req->cmd, mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 if (err)
459 goto error;
460
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100461 /* default. possible overriden later */
Christoph Hellwig64c7f1d2017-04-05 19:18:12 +0200462 req->retries = 5;
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100463
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464 switch (opcode) {
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100465 case SEND_DIAGNOSTIC:
466 case FORMAT_UNIT:
467 rq->timeout = FORMAT_UNIT_TIMEOUT;
Christoph Hellwig64c7f1d2017-04-05 19:18:12 +0200468 req->retries = 1;
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100469 break;
470 case START_STOP:
471 rq->timeout = START_STOP_TIMEOUT;
472 break;
473 case MOVE_MEDIUM:
474 rq->timeout = MOVE_MEDIUM_TIMEOUT;
475 break;
476 case READ_ELEMENT_STATUS:
477 rq->timeout = READ_ELEMENT_STATUS_TIMEOUT;
478 break;
479 case READ_DEFECT_DATA:
480 rq->timeout = READ_DEFECT_DATA_TIMEOUT;
Christoph Hellwig64c7f1d2017-04-05 19:18:12 +0200481 req->retries = 1;
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100482 break;
483 default:
Jens Axboe3d6392c2007-07-09 12:38:05 +0200484 rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100485 break;
486 }
487
Christoph Hellwig0eb0b632018-05-09 09:54:08 +0200488 if (bytes && blk_rq_map_kern(q, rq, buffer, bytes, GFP_NOIO)) {
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100489 err = DRIVER_ERROR << 24;
Jan Kara84ce0f02014-10-22 20:13:39 -0600490 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 }
492
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100493 blk_execute_rq(q, disk, rq, 0);
494
Christoph Hellwig17d53632017-04-20 16:03:01 +0200495 err = req->result & 0xff; /* only 8 bit SCSI status */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496 if (err) {
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100497 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))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501 err = -EFAULT;
502 }
503 } else {
504 if (copy_to_user(sic->data, buffer, out_len))
505 err = -EFAULT;
506 }
507
508error:
Tony Battersby92697dc2014-11-10 17:40:02 -0500509 blk_put_request(rq);
510
511error_free_buffer:
Joe Lawrenceeb571ee2014-07-02 15:35:16 -0400512 kfree(buffer);
Tony Battersby92697dc2014-11-10 17:40:02 -0500513
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 return err;
515}
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100516EXPORT_SYMBOL_GPL(sg_scsi_ioctl);
Ben Collinsf98d2df2005-12-19 11:49:24 -0800517
518/* Send basic block requests */
Jens Axboe165125e2007-07-24 09:28:11 +0200519static int __blk_send_generic(struct request_queue *q, struct gendisk *bd_disk,
520 int cmd, int data)
Ben Collinsf98d2df2005-12-19 11:49:24 -0800521{
522 struct request *rq;
523 int err;
524
Christoph Hellwigff005a02018-05-09 09:54:05 +0200525 rq = blk_get_request(q, REQ_OP_SCSI_OUT, 0);
Joe Lawrencea492f072014-08-28 08:15:21 -0600526 if (IS_ERR(rq))
527 return PTR_ERR(rq);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200528 rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100529 scsi_req(rq)->cmd[0] = cmd;
530 scsi_req(rq)->cmd[4] = data;
531 scsi_req(rq)->cmd_len = 6;
Christoph Hellwigb7819b92017-04-20 16:02:55 +0200532 blk_execute_rq(q, bd_disk, rq, 0);
Christoph Hellwig17d53632017-04-20 16:03:01 +0200533 err = scsi_req(rq)->result ? -EIO : 0;
Ben Collinsf98d2df2005-12-19 11:49:24 -0800534 blk_put_request(rq);
535
536 return err;
537}
538
Jens Axboe165125e2007-07-24 09:28:11 +0200539static inline int blk_send_start_stop(struct request_queue *q,
540 struct gendisk *bd_disk, int data)
Ben Collinsf98d2df2005-12-19 11:49:24 -0800541{
542 return __blk_send_generic(q, bd_disk, GPCMD_START_STOP_UNIT, data);
543}
544
Al Viro74f3c8a2007-08-27 15:38:10 -0400545int scsi_cmd_ioctl(struct request_queue *q, struct gendisk *bd_disk, fmode_t mode,
546 unsigned int cmd, void __user *arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547{
Ben Collinsf98d2df2005-12-19 11:49:24 -0800548 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549
Tejun Heo315fcee2011-10-19 14:31:25 +0200550 if (!q)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 return -ENXIO;
552
553 switch (cmd) {
554 /*
555 * new sgv3 interface
556 */
557 case SG_GET_VERSION_NUM:
558 err = sg_get_version(arg);
559 break;
560 case SCSI_IOCTL_GET_IDLUN:
561 err = scsi_get_idlun(q, arg);
562 break;
563 case SCSI_IOCTL_GET_BUS_NUMBER:
564 err = scsi_get_bus(q, arg);
565 break;
566 case SG_SET_TIMEOUT:
567 err = sg_set_timeout(q, arg);
568 break;
569 case SG_GET_TIMEOUT:
570 err = sg_get_timeout(q);
571 break;
572 case SG_GET_RESERVED_SIZE:
573 err = sg_get_reserved_size(q, arg);
574 break;
575 case SG_SET_RESERVED_SIZE:
576 err = sg_set_reserved_size(q, arg);
577 break;
578 case SG_EMULATED_HOST:
579 err = sg_emulated_host(q, arg);
580 break;
581 case SG_IO: {
582 struct sg_io_hdr hdr;
583
584 err = -EFAULT;
585 if (copy_from_user(&hdr, arg, sizeof(hdr)))
586 break;
Al Viro74f3c8a2007-08-27 15:38:10 -0400587 err = sg_io(q, bd_disk, &hdr, mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588 if (err == -EFAULT)
589 break;
590
591 if (copy_to_user(arg, &hdr, sizeof(hdr)))
592 err = -EFAULT;
593 break;
594 }
595 case CDROM_SEND_PACKET: {
596 struct cdrom_generic_command cgc;
597 struct sg_io_hdr hdr;
598
599 err = -EFAULT;
600 if (copy_from_user(&cgc, arg, sizeof(cgc)))
601 break;
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;
607 err = 0;
608 switch (cgc.data_direction) {
609 case CGC_DATA_UNKNOWN:
610 hdr.dxfer_direction = SG_DXFER_UNKNOWN;
611 break;
612 case CGC_DATA_WRITE:
613 hdr.dxfer_direction = SG_DXFER_TO_DEV;
614 break;
615 case CGC_DATA_READ:
616 hdr.dxfer_direction = SG_DXFER_FROM_DEV;
617 break;
618 case CGC_DATA_NONE:
619 hdr.dxfer_direction = SG_DXFER_NONE;
620 break;
621 default:
622 err = -EINVAL;
623 }
624 if (err)
625 break;
626
627 hdr.dxferp = cgc.buffer;
628 hdr.sbp = cgc.sense;
629 if (hdr.sbp)
630 hdr.mx_sb_len = sizeof(struct request_sense);
Tim Wrightad337592008-07-27 17:50:38 -0700631 hdr.timeout = jiffies_to_msecs(cgc.timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 hdr.cmdp = ((struct cdrom_generic_command __user*) arg)->cmd;
633 hdr.cmd_len = sizeof(cgc.cmd);
634
Al Viro74f3c8a2007-08-27 15:38:10 -0400635 err = sg_io(q, bd_disk, &hdr, mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636 if (err == -EFAULT)
637 break;
638
639 if (hdr.status)
640 err = -EIO;
641
642 cgc.stat = err;
643 cgc.buflen = hdr.resid;
644 if (copy_to_user(arg, &cgc, sizeof(cgc)))
645 err = -EFAULT;
646
647 break;
648 }
649
650 /*
651 * old junk scsi send command ioctl
652 */
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);
655 err = -EINVAL;
656 if (!arg)
657 break;
658
Al Viro74f3c8a2007-08-27 15:38:10 -0400659 err = sg_scsi_ioctl(q, bd_disk, mode, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660 break;
661 case CDROMCLOSETRAY:
Ben Collinsf98d2df2005-12-19 11:49:24 -0800662 err = blk_send_start_stop(q, bd_disk, 0x03);
663 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 case CDROMEJECT:
Ben Collinsf98d2df2005-12-19 11:49:24 -0800665 err = blk_send_start_stop(q, bd_disk, 0x02);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 break;
667 default:
668 err = -ENOTTY;
669 }
670
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671 return err;
672}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673EXPORT_SYMBOL(scsi_cmd_ioctl);
Jens Axboe018e0442009-06-26 16:27:10 +0200674
Paolo Bonzini0bfc96c2012-01-12 16:01:28 +0100675int scsi_verify_blk_ioctl(struct block_device *bd, unsigned int cmd)
676{
677 if (bd && bd == bd->bd_contains)
678 return 0;
679
Jan Kara6d935922012-06-15 12:52:46 +0200680 if (capable(CAP_SYS_RAWIO))
681 return 0;
682
Jan Kara6d935922012-06-15 12:52:46 +0200683 return -ENOIOCTLCMD;
Paolo Bonzini0bfc96c2012-01-12 16:01:28 +0100684}
685EXPORT_SYMBOL(scsi_verify_blk_ioctl);
686
Paolo Bonzini577ebb32012-01-12 16:01:27 +0100687int scsi_cmd_blk_ioctl(struct block_device *bd, fmode_t mode,
688 unsigned int cmd, void __user *arg)
689{
Paolo Bonzini0bfc96c2012-01-12 16:01:28 +0100690 int ret;
691
692 ret = scsi_verify_blk_ioctl(bd, cmd);
693 if (ret < 0)
694 return ret;
695
Paolo Bonzini577ebb32012-01-12 16:01:27 +0100696 return scsi_cmd_ioctl(bd->bd_disk->queue, bd->bd_disk, mode, cmd, arg);
697}
698EXPORT_SYMBOL(scsi_cmd_blk_ioctl);
699
Bart Van Asschec8d9cf22017-06-20 11:15:42 -0700700/**
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.
705 */
706void scsi_req_init(struct scsi_request *req)
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100707{
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100708 memset(req->__cmd, 0, sizeof(req->__cmd));
709 req->cmd = req->__cmd;
710 req->cmd_len = BLK_MAX_CDB;
711 req->sense_len = 0;
712}
713EXPORT_SYMBOL(scsi_req_init);
714
H Hartley Sweeten476d42f2009-11-04 09:10:33 +0100715static int __init blk_scsi_ioctl_init(void)
Jens Axboe018e0442009-06-26 16:27:10 +0200716{
717 blk_set_cmd_filter_defaults(&blk_default_cmd_filter);
718 return 0;
719}
FUJITA Tomonori76da0342009-07-09 09:48:28 +0200720fs_initcall(blk_scsi_ioctl_init);