ia64/linux-2.6.18-xen.hg

view block/scsi_ioctl.c @ 912:dd42cdb0ab89

[IA64] Build blktap2 driver by default in x86 builds.

add CONFIG_XEN_BLKDEV_TAP2=y to buildconfigs/linux-defconfig_xen_ia64.

Signed-off-by: Isaku Yamahata <yamahata@valinux.co.jp>
author Isaku Yamahata <yamahata@valinux.co.jp>
date Mon Jun 29 12:09:16 2009 +0900 (2009-06-29)
parents 3e8752eb6d9c
children
line source
1 /*
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>
24 #include <linux/capability.h>
25 #include <linux/completion.h>
26 #include <linux/cdrom.h>
27 #include <linux/slab.h>
28 #include <linux/times.h>
29 #include <asm/uaccess.h>
31 #include <scsi/scsi.h>
32 #include <scsi/scsi_ioctl.h>
33 #include <scsi/scsi_cmnd.h>
35 /* Command group 3 is reserved and should never be used. */
36 const unsigned char scsi_command_size[8] =
37 {
38 6, 10, 10, 12,
39 16, 12, 10, 10
40 };
42 EXPORT_SYMBOL(scsi_command_size);
44 #define BLK_DEFAULT_TIMEOUT (60 * HZ)
46 #include <scsi/sg.h>
48 static int sg_get_version(int __user *p)
49 {
50 static const int sg_version_num = 30527;
51 return put_user(sg_version_num, p);
52 }
54 static int scsi_get_idlun(request_queue_t *q, int __user *p)
55 {
56 return put_user(0, p);
57 }
59 static int scsi_get_bus(request_queue_t *q, int __user *p)
60 {
61 return put_user(0, p);
62 }
64 static int sg_get_timeout(request_queue_t *q)
65 {
66 return q->sg_timeout / (HZ / USER_HZ);
67 }
69 static int sg_set_timeout(request_queue_t *q, int __user *p)
70 {
71 int timeout, err = get_user(timeout, p);
73 if (!err)
74 q->sg_timeout = timeout * (HZ / USER_HZ);
76 return err;
77 }
79 static int sg_get_reserved_size(request_queue_t *q, int __user *p)
80 {
81 return put_user(q->sg_reserved_size, p);
82 }
84 static int sg_set_reserved_size(request_queue_t *q, int __user *p)
85 {
86 int size, err = get_user(size, p);
88 if (err)
89 return err;
91 if (size < 0)
92 return -EINVAL;
93 if (size > (q->max_sectors << 9))
94 size = q->max_sectors << 9;
96 q->sg_reserved_size = size;
97 return 0;
98 }
100 /*
101 * will always return that we are ATAPI even for a real SCSI drive, I'm not
102 * so sure this is worth doing anything about (why would you care??)
103 */
104 static int sg_emulated_host(request_queue_t *q, int __user *p)
105 {
106 return put_user(1, p);
107 }
109 #define CMD_READ_SAFE 0x01
110 #define CMD_WRITE_SAFE 0x02
111 #define CMD_WARNED 0x04
112 #define safe_for_read(cmd) [cmd] = CMD_READ_SAFE
113 #define safe_for_write(cmd) [cmd] = CMD_WRITE_SAFE
115 static int verify_command(struct file *file, unsigned char *cmd)
116 {
117 static unsigned char cmd_type[256] = {
119 /* Basic read-only commands */
120 safe_for_read(TEST_UNIT_READY),
121 safe_for_read(REQUEST_SENSE),
122 safe_for_read(READ_6),
123 safe_for_read(READ_10),
124 safe_for_read(READ_12),
125 safe_for_read(READ_16),
126 safe_for_read(READ_BUFFER),
127 safe_for_read(READ_DEFECT_DATA),
128 safe_for_read(READ_LONG),
129 safe_for_read(INQUIRY),
130 safe_for_read(MODE_SENSE),
131 safe_for_read(MODE_SENSE_10),
132 safe_for_read(LOG_SENSE),
133 safe_for_read(START_STOP),
134 safe_for_read(GPCMD_VERIFY_10),
135 safe_for_read(VERIFY_16),
137 /* Audio CD commands */
138 safe_for_read(GPCMD_PLAY_CD),
139 safe_for_read(GPCMD_PLAY_AUDIO_10),
140 safe_for_read(GPCMD_PLAY_AUDIO_MSF),
141 safe_for_read(GPCMD_PLAY_AUDIO_TI),
142 safe_for_read(GPCMD_PAUSE_RESUME),
144 /* CD/DVD data reading */
145 safe_for_read(GPCMD_READ_BUFFER_CAPACITY),
146 safe_for_read(GPCMD_READ_CD),
147 safe_for_read(GPCMD_READ_CD_MSF),
148 safe_for_read(GPCMD_READ_DISC_INFO),
149 safe_for_read(GPCMD_READ_CDVD_CAPACITY),
150 safe_for_read(GPCMD_READ_DVD_STRUCTURE),
151 safe_for_read(GPCMD_READ_HEADER),
152 safe_for_read(GPCMD_READ_TRACK_RZONE_INFO),
153 safe_for_read(GPCMD_READ_SUBCHANNEL),
154 safe_for_read(GPCMD_READ_TOC_PMA_ATIP),
155 safe_for_read(GPCMD_REPORT_KEY),
156 safe_for_read(GPCMD_SCAN),
157 safe_for_read(GPCMD_GET_CONFIGURATION),
158 safe_for_read(GPCMD_READ_FORMAT_CAPACITIES),
159 safe_for_read(GPCMD_GET_EVENT_STATUS_NOTIFICATION),
160 safe_for_read(GPCMD_GET_PERFORMANCE),
161 safe_for_read(GPCMD_SEEK),
162 safe_for_read(GPCMD_STOP_PLAY_SCAN),
164 /* Basic writing commands */
165 safe_for_write(WRITE_6),
166 safe_for_write(WRITE_10),
167 safe_for_write(WRITE_VERIFY),
168 safe_for_write(WRITE_12),
169 safe_for_write(WRITE_VERIFY_12),
170 safe_for_write(WRITE_16),
171 safe_for_write(WRITE_LONG),
172 safe_for_write(WRITE_LONG_2),
173 safe_for_write(ERASE),
174 safe_for_write(GPCMD_MODE_SELECT_10),
175 safe_for_write(MODE_SELECT),
176 safe_for_write(LOG_SELECT),
177 safe_for_write(GPCMD_BLANK),
178 safe_for_write(GPCMD_CLOSE_TRACK),
179 safe_for_write(GPCMD_FLUSH_CACHE),
180 safe_for_write(GPCMD_FORMAT_UNIT),
181 safe_for_write(GPCMD_REPAIR_RZONE_TRACK),
182 safe_for_write(GPCMD_RESERVE_RZONE_TRACK),
183 safe_for_write(GPCMD_SEND_DVD_STRUCTURE),
184 safe_for_write(GPCMD_SEND_EVENT),
185 safe_for_write(GPCMD_SEND_KEY),
186 safe_for_write(GPCMD_SEND_OPC),
187 safe_for_write(GPCMD_SEND_CUE_SHEET),
188 safe_for_write(GPCMD_SET_SPEED),
189 safe_for_write(GPCMD_PREVENT_ALLOW_MEDIUM_REMOVAL),
190 safe_for_write(GPCMD_LOAD_UNLOAD),
191 safe_for_write(GPCMD_SET_STREAMING),
192 };
193 unsigned char type = cmd_type[cmd[0]];
194 int has_write_perm = 0;
196 /* Anybody who can open the device can do a read-safe command */
197 if (type & CMD_READ_SAFE)
198 return 0;
200 /*
201 * file can be NULL from ioctl_by_bdev()...
202 */
203 if (file)
204 has_write_perm = file->f_mode & FMODE_WRITE;
206 /* Write-safe commands just require a writable open.. */
207 if ((type & CMD_WRITE_SAFE) && has_write_perm)
208 return 0;
210 /* And root can do any command.. */
211 if (capable(CAP_SYS_RAWIO))
212 return 0;
214 if (!type) {
215 cmd_type[cmd[0]] = CMD_WARNED;
216 printk(KERN_WARNING "scsi: unknown opcode 0x%02x\n", cmd[0]);
217 }
219 /* Otherwise fail it with an "Operation not permitted" */
220 return -EPERM;
221 }
223 static int sg_io(struct file *file, request_queue_t *q,
224 struct gendisk *bd_disk, struct sg_io_hdr *hdr)
225 {
226 unsigned long start_time;
227 int writing = 0, ret = 0;
228 struct request *rq;
229 struct bio *bio;
230 char sense[SCSI_SENSE_BUFFERSIZE];
231 unsigned char cmd[BLK_MAX_CDB];
233 if (hdr->interface_id != 'S')
234 return -EINVAL;
235 if (hdr->cmd_len > BLK_MAX_CDB)
236 return -EINVAL;
237 if (copy_from_user(cmd, hdr->cmdp, hdr->cmd_len))
238 return -EFAULT;
239 if (verify_command(file, cmd))
240 return -EPERM;
242 if (hdr->dxfer_len > (q->max_hw_sectors << 9))
243 return -EIO;
245 if (hdr->dxfer_len)
246 switch (hdr->dxfer_direction) {
247 default:
248 return -EINVAL;
249 case SG_DXFER_TO_DEV:
250 writing = 1;
251 break;
252 case SG_DXFER_TO_FROM_DEV:
253 case SG_DXFER_FROM_DEV:
254 break;
255 }
257 rq = blk_get_request(q, writing ? WRITE : READ, GFP_KERNEL);
258 if (!rq)
259 return -ENOMEM;
261 if (hdr->iovec_count) {
262 const int size = sizeof(struct sg_iovec) * hdr->iovec_count;
263 struct sg_iovec *iov;
265 iov = kmalloc(size, GFP_KERNEL);
266 if (!iov) {
267 ret = -ENOMEM;
268 goto out;
269 }
271 if (copy_from_user(iov, hdr->dxferp, size)) {
272 kfree(iov);
273 ret = -EFAULT;
274 goto out;
275 }
277 ret = blk_rq_map_user_iov(q, rq, iov, hdr->iovec_count);
278 kfree(iov);
279 } else if (hdr->dxfer_len)
280 ret = blk_rq_map_user(q, rq, hdr->dxferp, hdr->dxfer_len);
282 if (ret)
283 goto out;
285 /*
286 * fill in request structure
287 */
288 rq->cmd_len = hdr->cmd_len;
289 memset(rq->cmd, 0, BLK_MAX_CDB); /* ATAPI hates garbage after CDB */
290 memcpy(rq->cmd, cmd, hdr->cmd_len);
292 memset(sense, 0, sizeof(sense));
293 rq->sense = sense;
294 rq->sense_len = 0;
296 rq->flags |= REQ_BLOCK_PC;
297 bio = rq->bio;
299 /*
300 * bounce this after holding a reference to the original bio, it's
301 * needed for proper unmapping
302 */
303 if (rq->bio)
304 blk_queue_bounce(q, &rq->bio);
306 rq->timeout = (hdr->timeout * HZ) / 1000;
307 if (!rq->timeout)
308 rq->timeout = q->sg_timeout;
309 if (!rq->timeout)
310 rq->timeout = BLK_DEFAULT_TIMEOUT;
312 rq->retries = 0;
314 start_time = jiffies;
316 /* ignore return value. All information is passed back to caller
317 * (if he doesn't check that is his problem).
318 * N.B. a non-zero SCSI status is _not_ necessarily an error.
319 */
320 blk_execute_rq(q, bd_disk, rq, 0);
322 /* write to all output members */
323 hdr->status = 0xff & rq->errors;
324 hdr->masked_status = status_byte(rq->errors);
325 hdr->msg_status = msg_byte(rq->errors);
326 hdr->host_status = host_byte(rq->errors);
327 hdr->driver_status = driver_byte(rq->errors);
328 hdr->info = 0;
329 if (hdr->masked_status || hdr->host_status || hdr->driver_status)
330 hdr->info |= SG_INFO_CHECK;
331 hdr->resid = rq->data_len;
332 hdr->duration = ((jiffies - start_time) * 1000) / HZ;
333 hdr->sb_len_wr = 0;
335 if (rq->sense_len && hdr->sbp) {
336 int len = min((unsigned int) hdr->mx_sb_len, rq->sense_len);
338 if (!copy_to_user(hdr->sbp, rq->sense, len))
339 hdr->sb_len_wr = len;
340 }
342 if (blk_rq_unmap_user(bio, hdr->dxfer_len))
343 ret = -EFAULT;
345 /* may not have succeeded, but output values written to control
346 * structure (struct sg_io_hdr). */
347 out:
348 blk_put_request(rq);
349 return ret;
350 }
352 /**
353 * sg_scsi_ioctl -- handle deprecated SCSI_IOCTL_SEND_COMMAND ioctl
354 * @file: file this ioctl operates on (optional)
355 * @q: request queue to send scsi commands down
356 * @disk: gendisk to operate on (option)
357 * @sic: userspace structure describing the command to perform
358 *
359 * Send down the scsi command described by @sic to the device below
360 * the request queue @q. If @file is non-NULL it's used to perform
361 * fine-grained permission checks that allow users to send down
362 * non-destructive SCSI commands. If the caller has a struct gendisk
363 * available it should be passed in as @disk to allow the low level
364 * driver to use the information contained in it. A non-NULL @disk
365 * is only allowed if the caller knows that the low level driver doesn't
366 * need it (e.g. in the scsi subsystem).
367 *
368 * Notes:
369 * - This interface is deprecated - users should use the SG_IO
370 * interface instead, as this is a more flexible approach to
371 * performing SCSI commands on a device.
372 * - The SCSI command length is determined by examining the 1st byte
373 * of the given command. There is no way to override this.
374 * - Data transfers are limited to PAGE_SIZE
375 * - The length (x + y) must be at least OMAX_SB_LEN bytes long to
376 * accommodate the sense buffer when an error occurs.
377 * The sense buffer is truncated to OMAX_SB_LEN (16) bytes so that
378 * old code will not be surprised.
379 * - If a Unix error occurs (e.g. ENOMEM) then the user will receive
380 * a negative return and the Unix error code in 'errno'.
381 * If the SCSI command succeeds then 0 is returned.
382 * Positive numbers returned are the compacted SCSI error codes (4
383 * bytes in one int) where the lowest byte is the SCSI status.
384 */
385 #define OMAX_SB_LEN 16 /* For backward compatibility */
386 int sg_scsi_ioctl(struct file *file, struct request_queue *q,
387 struct gendisk *disk, struct scsi_ioctl_command __user *sic)
388 {
389 struct request *rq;
390 int err;
391 unsigned int in_len, out_len, bytes, opcode, cmdlen;
392 char *buffer = NULL, sense[SCSI_SENSE_BUFFERSIZE];
394 if (!sic)
395 return -EINVAL;
397 /*
398 * get in an out lengths, verify they don't exceed a page worth of data
399 */
400 if (get_user(in_len, &sic->inlen))
401 return -EFAULT;
402 if (get_user(out_len, &sic->outlen))
403 return -EFAULT;
404 if (in_len > PAGE_SIZE || out_len > PAGE_SIZE)
405 return -EINVAL;
406 if (get_user(opcode, sic->data))
407 return -EFAULT;
409 bytes = max(in_len, out_len);
410 if (bytes) {
411 buffer = kmalloc(bytes, q->bounce_gfp | GFP_USER| __GFP_NOWARN);
412 if (!buffer)
413 return -ENOMEM;
415 memset(buffer, 0, bytes);
416 }
418 rq = blk_get_request(q, in_len ? WRITE : READ, __GFP_WAIT);
420 cmdlen = COMMAND_SIZE(opcode);
422 /*
423 * get command and data to send to device, if any
424 */
425 err = -EFAULT;
426 rq->cmd_len = cmdlen;
427 if (copy_from_user(rq->cmd, sic->data, cmdlen))
428 goto error;
430 if (in_len && copy_from_user(buffer, sic->data + cmdlen, in_len))
431 goto error;
433 err = verify_command(file, rq->cmd);
434 if (err)
435 goto error;
437 /* default. possible overriden later */
438 rq->retries = 5;
440 switch (opcode) {
441 case SEND_DIAGNOSTIC:
442 case FORMAT_UNIT:
443 rq->timeout = FORMAT_UNIT_TIMEOUT;
444 rq->retries = 1;
445 break;
446 case START_STOP:
447 rq->timeout = START_STOP_TIMEOUT;
448 break;
449 case MOVE_MEDIUM:
450 rq->timeout = MOVE_MEDIUM_TIMEOUT;
451 break;
452 case READ_ELEMENT_STATUS:
453 rq->timeout = READ_ELEMENT_STATUS_TIMEOUT;
454 break;
455 case READ_DEFECT_DATA:
456 rq->timeout = READ_DEFECT_DATA_TIMEOUT;
457 rq->retries = 1;
458 break;
459 default:
460 rq->timeout = BLK_DEFAULT_TIMEOUT;
461 break;
462 }
464 if (bytes && blk_rq_map_kern(q, rq, buffer, bytes, __GFP_WAIT)) {
465 err = DRIVER_ERROR << 24;
466 goto out;
467 }
469 memset(sense, 0, sizeof(sense));
470 rq->sense = sense;
471 rq->sense_len = 0;
472 rq->flags |= REQ_BLOCK_PC;
474 blk_execute_rq(q, disk, rq, 0);
476 out:
477 err = rq->errors & 0xff; /* only 8 bit SCSI status */
478 if (err) {
479 if (rq->sense_len && rq->sense) {
480 bytes = (OMAX_SB_LEN > rq->sense_len) ?
481 rq->sense_len : OMAX_SB_LEN;
482 if (copy_to_user(sic->data, rq->sense, bytes))
483 err = -EFAULT;
484 }
485 } else {
486 if (copy_to_user(sic->data, buffer, out_len))
487 err = -EFAULT;
488 }
490 error:
491 kfree(buffer);
492 blk_put_request(rq);
493 return err;
494 }
495 EXPORT_SYMBOL_GPL(sg_scsi_ioctl);
497 /* Send basic block requests */
498 static int __blk_send_generic(request_queue_t *q, struct gendisk *bd_disk, int cmd, int data)
499 {
500 struct request *rq;
501 int err;
503 rq = blk_get_request(q, WRITE, __GFP_WAIT);
504 rq->flags |= REQ_BLOCK_PC;
505 rq->data = NULL;
506 rq->data_len = 0;
507 rq->timeout = BLK_DEFAULT_TIMEOUT;
508 memset(rq->cmd, 0, sizeof(rq->cmd));
509 rq->cmd[0] = cmd;
510 rq->cmd[4] = data;
511 rq->cmd_len = 6;
512 err = blk_execute_rq(q, bd_disk, rq, 0);
513 blk_put_request(rq);
515 return err;
516 }
518 static inline int blk_send_start_stop(request_queue_t *q, struct gendisk *bd_disk, int data)
519 {
520 return __blk_send_generic(q, bd_disk, GPCMD_START_STOP_UNIT, data);
521 }
523 int scsi_cmd_ioctl(struct file *file, struct gendisk *bd_disk, unsigned int cmd, void __user *arg)
524 {
525 request_queue_t *q;
526 int err;
528 q = bd_disk->queue;
529 if (!q)
530 return -ENXIO;
532 if (blk_get_queue(q))
533 return -ENXIO;
535 switch (cmd) {
536 /*
537 * new sgv3 interface
538 */
539 case SG_GET_VERSION_NUM:
540 err = sg_get_version(arg);
541 break;
542 case SCSI_IOCTL_GET_IDLUN:
543 err = scsi_get_idlun(q, arg);
544 break;
545 case SCSI_IOCTL_GET_BUS_NUMBER:
546 err = scsi_get_bus(q, arg);
547 break;
548 case SG_SET_TIMEOUT:
549 err = sg_set_timeout(q, arg);
550 break;
551 case SG_GET_TIMEOUT:
552 err = sg_get_timeout(q);
553 break;
554 case SG_GET_RESERVED_SIZE:
555 err = sg_get_reserved_size(q, arg);
556 break;
557 case SG_SET_RESERVED_SIZE:
558 err = sg_set_reserved_size(q, arg);
559 break;
560 case SG_EMULATED_HOST:
561 err = sg_emulated_host(q, arg);
562 break;
563 case SG_IO: {
564 struct sg_io_hdr hdr;
566 err = -EFAULT;
567 if (copy_from_user(&hdr, arg, sizeof(hdr)))
568 break;
569 err = sg_io(file, q, bd_disk, &hdr);
570 if (err == -EFAULT)
571 break;
573 if (copy_to_user(arg, &hdr, sizeof(hdr)))
574 err = -EFAULT;
575 break;
576 }
577 case CDROM_SEND_PACKET: {
578 struct cdrom_generic_command cgc;
579 struct sg_io_hdr hdr;
581 err = -EFAULT;
582 if (copy_from_user(&cgc, arg, sizeof(cgc)))
583 break;
584 cgc.timeout = clock_t_to_jiffies(cgc.timeout);
585 memset(&hdr, 0, sizeof(hdr));
586 hdr.interface_id = 'S';
587 hdr.cmd_len = sizeof(cgc.cmd);
588 hdr.dxfer_len = cgc.buflen;
589 err = 0;
590 switch (cgc.data_direction) {
591 case CGC_DATA_UNKNOWN:
592 hdr.dxfer_direction = SG_DXFER_UNKNOWN;
593 break;
594 case CGC_DATA_WRITE:
595 hdr.dxfer_direction = SG_DXFER_TO_DEV;
596 break;
597 case CGC_DATA_READ:
598 hdr.dxfer_direction = SG_DXFER_FROM_DEV;
599 break;
600 case CGC_DATA_NONE:
601 hdr.dxfer_direction = SG_DXFER_NONE;
602 break;
603 default:
604 err = -EINVAL;
605 }
606 if (err)
607 break;
609 hdr.dxferp = cgc.buffer;
610 hdr.sbp = cgc.sense;
611 if (hdr.sbp)
612 hdr.mx_sb_len = sizeof(struct request_sense);
613 hdr.timeout = cgc.timeout;
614 hdr.cmdp = ((struct cdrom_generic_command __user*) arg)->cmd;
615 hdr.cmd_len = sizeof(cgc.cmd);
617 err = sg_io(file, q, bd_disk, &hdr);
618 if (err == -EFAULT)
619 break;
621 if (hdr.status)
622 err = -EIO;
624 cgc.stat = err;
625 cgc.buflen = hdr.resid;
626 if (copy_to_user(arg, &cgc, sizeof(cgc)))
627 err = -EFAULT;
629 break;
630 }
632 /*
633 * old junk scsi send command ioctl
634 */
635 case SCSI_IOCTL_SEND_COMMAND:
636 printk(KERN_WARNING "program %s is using a deprecated SCSI ioctl, please convert it to SG_IO\n", current->comm);
637 err = -EINVAL;
638 if (!arg)
639 break;
641 err = sg_scsi_ioctl(file, q, bd_disk, arg);
642 break;
643 case CDROMCLOSETRAY:
644 err = blk_send_start_stop(q, bd_disk, 0x03);
645 break;
646 case CDROMEJECT:
647 err = blk_send_start_stop(q, bd_disk, 0x02);
648 break;
649 default:
650 err = -ENOTTY;
651 }
653 blk_put_queue(q);
654 return err;
655 }
657 EXPORT_SYMBOL(scsi_cmd_ioctl);