3 * Started: Aug 9 by Lawrence Foard (entropy@world.std.com),
4 * to allow user process control of SCSI devices.
5 * Development Sponsored by Killy Corp. NY NY
7 * Original driver (sg.c):
8 * Copyright (C) 1992 Lawrence Foard
9 * Version 2 and 3 extensions to driver:
10 * Copyright (C) 1998 - 2005 Douglas Gilbert
12 * Modified 19-JAN-1998 Richard Gooch <rgooch@atnf.csiro.au> Devfs support
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2, or (at your option)
21 static int sg_version_num
= 30534; /* 2 digits for each component */
22 #define SG_VERSION_STR "3.5.34"
25 * D. P. Gilbert (dgilbert@interlog.com, dougg@triode.net.au), notes:
26 * - scsi logging is available via SCSI_LOG_TIMEOUT macros. First
27 * the kernel/module needs to be built with CONFIG_SCSI_LOGGING
28 * (otherwise the macros compile to empty statements).
31 #include <linux/module.h>
34 #include <linux/kernel.h>
35 #include <linux/sched.h>
36 #include <linux/string.h>
38 #include <linux/errno.h>
39 #include <linux/mtio.h>
40 #include <linux/ioctl.h>
41 #include <linux/slab.h>
42 #include <linux/fcntl.h>
43 #include <linux/init.h>
44 #include <linux/poll.h>
45 #include <linux/moduleparam.h>
46 #include <linux/cdev.h>
47 #include <linux/idr.h>
48 #include <linux/seq_file.h>
49 #include <linux/blkdev.h>
50 #include <linux/delay.h>
51 #include <linux/blktrace_api.h>
52 #include <linux/smp_lock.h>
55 #include <scsi/scsi_dbg.h>
56 #include <scsi/scsi_host.h>
57 #include <scsi/scsi_driver.h>
58 #include <scsi/scsi_ioctl.h>
61 #include "scsi_logging.h"
63 #ifdef CONFIG_SCSI_PROC_FS
64 #include <linux/proc_fs.h>
65 static char *sg_version_date
= "20061027";
67 static int sg_proc_init(void);
68 static void sg_proc_cleanup(void);
71 #define SG_ALLOW_DIO_DEF 0
73 #define SG_MAX_DEVS 32768
76 * Suppose you want to calculate the formula muldiv(x,m,d)=int(x * m / d)
77 * Then when using 32 bit integers x * m may overflow during the calculation.
78 * Replacing muldiv(x) by muldiv(x)=((x % d) * m) / d + int(x / d) * m
79 * calculates the same, but prevents the overflow when both m and d
80 * are "small" numbers (like HZ and USER_HZ).
81 * Of course an overflow is inavoidable if the result of muldiv doesn't fit
84 #define MULDIV(X,MUL,DIV) ((((X % DIV) * MUL) / DIV) + ((X / DIV) * MUL))
86 #define SG_DEFAULT_TIMEOUT MULDIV(SG_DEFAULT_TIMEOUT_USER, HZ, USER_HZ)
88 int sg_big_buff
= SG_DEF_RESERVED_SIZE
;
89 /* N.B. This variable is readable and writeable via
90 /proc/scsi/sg/def_reserved_size . Each time sg_open() is called a buffer
91 of this size (or less if there is not enough memory) will be reserved
92 for use by this file descriptor. [Deprecated usage: this variable is also
93 readable via /proc/sys/kernel/sg-big-buff if the sg driver is built into
94 the kernel (i.e. it is not a module).] */
95 static int def_reserved_size
= -1; /* picks up init parameter */
96 static int sg_allow_dio
= SG_ALLOW_DIO_DEF
;
98 static int scatter_elem_sz
= SG_SCATTER_SZ
;
99 static int scatter_elem_sz_prev
= SG_SCATTER_SZ
;
101 #define SG_SECTOR_SZ 512
103 static int sg_add(struct device
*, struct class_interface
*);
104 static void sg_remove(struct device
*, struct class_interface
*);
106 static DEFINE_IDR(sg_index_idr
);
107 static DEFINE_RWLOCK(sg_index_lock
); /* Also used to lock
108 file descriptor list for device */
110 static struct class_interface sg_interface
= {
112 .remove_dev
= sg_remove
,
115 typedef struct sg_scatter_hold
{ /* holding area for scsi scatter gather info */
116 unsigned short k_use_sg
; /* Count of kernel scatter-gather pieces */
117 unsigned sglist_len
; /* size of malloc'd scatter-gather list ++ */
118 unsigned bufflen
; /* Size of (aggregate) data buffer */
121 char dio_in_use
; /* 0->indirect IO (or mmap), 1->dio */
122 unsigned char cmd_opcode
; /* first byte of command */
125 struct sg_device
; /* forward declarations */
128 typedef struct sg_request
{ /* SG_MAX_QUEUE requests outstanding per file */
129 struct sg_request
*nextrp
; /* NULL -> tail request (slist) */
130 struct sg_fd
*parentfp
; /* NULL -> not in use */
131 Sg_scatter_hold data
; /* hold buffer, perhaps scatter list */
132 sg_io_hdr_t header
; /* scsi command+info, see <scsi/sg.h> */
133 unsigned char sense_b
[SCSI_SENSE_BUFFERSIZE
];
134 char res_used
; /* 1 -> using reserve buffer, 0 -> not ... */
135 char orphan
; /* 1 -> drop on sight, 0 -> normal */
136 char sg_io_owned
; /* 1 -> packet belongs to SG_IO */
137 volatile char done
; /* 0->before bh, 1->before read, 2->read */
140 struct execute_work ew
;
143 typedef struct sg_fd
{ /* holds the state of a file descriptor */
144 struct list_head sfd_siblings
;
145 struct sg_device
*parentdp
; /* owning device */
146 wait_queue_head_t read_wait
; /* queue read until command done */
147 rwlock_t rq_list_lock
; /* protect access to list in req_arr */
148 int timeout
; /* defaults to SG_DEFAULT_TIMEOUT */
149 int timeout_user
; /* defaults to SG_DEFAULT_TIMEOUT_USER */
150 Sg_scatter_hold reserve
; /* buffer held for this file descriptor */
151 unsigned save_scat_len
; /* original length of trunc. scat. element */
152 Sg_request
*headrp
; /* head of request slist, NULL->empty */
153 struct fasync_struct
*async_qp
; /* used by asynchronous notification */
154 Sg_request req_arr
[SG_MAX_QUEUE
]; /* used as singly-linked list */
155 char low_dma
; /* as in parent but possibly overridden to 1 */
156 char force_packid
; /* 1 -> pack_id input to read(), 0 -> ignored */
157 volatile char closed
; /* 1 -> fd closed but request(s) outstanding */
158 char cmd_q
; /* 1 -> allow command queuing, 0 -> don't */
159 char next_cmd_len
; /* 0 -> automatic (def), >0 -> use on next write() */
160 char keep_orphan
; /* 0 -> drop orphan (def), 1 -> keep for read() */
161 char mmap_called
; /* 0 -> mmap() never called on this fd */
163 struct execute_work ew
;
166 typedef struct sg_device
{ /* holds the state of each scsi generic device */
167 struct scsi_device
*device
;
168 wait_queue_head_t o_excl_wait
; /* queue open() when O_EXCL in use */
169 int sg_tablesize
; /* adapter's max scatter-gather table size */
170 u32 index
; /* device index number */
171 struct list_head sfds
;
172 volatile char detached
; /* 0->attached, 1->detached pending removal */
173 volatile char exclude
; /* opened for exclusive access */
174 char sgdebug
; /* 0->off, 1->sense, 9->dump dev, 10-> all devs */
175 struct gendisk
*disk
;
176 struct cdev
* cdev
; /* char_dev [sysfs: /sys/cdev/major/sg<n>] */
180 /* tasklet or soft irq callback */
181 static void sg_rq_end_io(struct request
*rq
, int uptodate
);
182 static int sg_start_req(Sg_request
*srp
, unsigned char *cmd
);
183 static int sg_finish_rem_req(Sg_request
* srp
);
184 static int sg_build_indirect(Sg_scatter_hold
* schp
, Sg_fd
* sfp
, int buff_size
);
185 static ssize_t
sg_new_read(Sg_fd
* sfp
, char __user
*buf
, size_t count
,
187 static ssize_t
sg_new_write(Sg_fd
*sfp
, struct file
*file
,
188 const char __user
*buf
, size_t count
, int blocking
,
189 int read_only
, int sg_io_owned
, Sg_request
**o_srp
);
190 static int sg_common_write(Sg_fd
* sfp
, Sg_request
* srp
,
191 unsigned char *cmnd
, int timeout
, int blocking
);
192 static int sg_read_oxfer(Sg_request
* srp
, char __user
*outp
, int num_read_xfer
);
193 static void sg_remove_scat(Sg_scatter_hold
* schp
);
194 static void sg_build_reserve(Sg_fd
* sfp
, int req_size
);
195 static void sg_link_reserve(Sg_fd
* sfp
, Sg_request
* srp
, int size
);
196 static void sg_unlink_reserve(Sg_fd
* sfp
, Sg_request
* srp
);
197 static Sg_fd
*sg_add_sfp(Sg_device
* sdp
, int dev
);
198 static void sg_remove_sfp(struct kref
*);
199 static Sg_request
*sg_get_rq_mark(Sg_fd
* sfp
, int pack_id
);
200 static Sg_request
*sg_add_request(Sg_fd
* sfp
);
201 static int sg_remove_request(Sg_fd
* sfp
, Sg_request
* srp
);
202 static int sg_res_in_use(Sg_fd
* sfp
);
203 static Sg_device
*sg_get_dev(int dev
);
204 static void sg_put_dev(Sg_device
*sdp
);
206 #define SZ_SG_HEADER sizeof(struct sg_header)
207 #define SZ_SG_IO_HDR sizeof(sg_io_hdr_t)
208 #define SZ_SG_IOVEC sizeof(sg_iovec_t)
209 #define SZ_SG_REQ_INFO sizeof(sg_req_info_t)
211 static int sg_allow_access(struct file
*filp
, unsigned char *cmd
)
213 struct sg_fd
*sfp
= (struct sg_fd
*)filp
->private_data
;
215 if (sfp
->parentdp
->device
->type
== TYPE_SCANNER
)
218 return blk_verify_command(cmd
, filp
->f_mode
& FMODE_WRITE
);
222 sg_open(struct inode
*inode
, struct file
*filp
)
224 int dev
= iminor(inode
);
225 int flags
= filp
->f_flags
;
226 struct request_queue
*q
;
233 nonseekable_open(inode
, filp
);
234 SCSI_LOG_TIMEOUT(3, printk("sg_open: dev=%d, flags=0x%x\n", dev
, flags
));
235 sdp
= sg_get_dev(dev
);
237 retval
= PTR_ERR(sdp
);
242 /* This driver's module count bumped by fops_get in <linux/fs.h> */
243 /* Prevent the device driver from vanishing while we sleep */
244 retval
= scsi_device_get(sdp
->device
);
248 if (!((flags
& O_NONBLOCK
) ||
249 scsi_block_when_processing_errors(sdp
->device
))) {
251 /* we are in error recovery for this device */
255 if (flags
& O_EXCL
) {
256 if (O_RDONLY
== (flags
& O_ACCMODE
)) {
257 retval
= -EPERM
; /* Can't lock it with read only access */
260 if (!list_empty(&sdp
->sfds
) && (flags
& O_NONBLOCK
)) {
265 __wait_event_interruptible(sdp
->o_excl_wait
,
266 ((!list_empty(&sdp
->sfds
) || sdp
->exclude
) ? 0 : (sdp
->exclude
= 1)), res
);
268 retval
= res
; /* -ERESTARTSYS because signal hit process */
271 } else if (sdp
->exclude
) { /* some other fd has an exclusive lock on dev */
272 if (flags
& O_NONBLOCK
) {
277 __wait_event_interruptible(sdp
->o_excl_wait
, (!sdp
->exclude
),
280 retval
= res
; /* -ERESTARTSYS because signal hit process */
288 if (list_empty(&sdp
->sfds
)) { /* no existing opens on this device */
290 q
= sdp
->device
->request_queue
;
291 sdp
->sg_tablesize
= queue_max_segments(q
);
293 if ((sfp
= sg_add_sfp(sdp
, dev
)))
294 filp
->private_data
= sfp
;
296 if (flags
& O_EXCL
) {
297 sdp
->exclude
= 0; /* undo if error */
298 wake_up_interruptible(&sdp
->o_excl_wait
);
306 scsi_device_put(sdp
->device
);
314 /* Following function was formerly called 'sg_close' */
316 sg_release(struct inode
*inode
, struct file
*filp
)
321 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
323 SCSI_LOG_TIMEOUT(3, printk("sg_release: %s\n", sdp
->disk
->disk_name
));
328 wake_up_interruptible(&sdp
->o_excl_wait
);
330 kref_put(&sfp
->f_ref
, sg_remove_sfp
);
335 sg_read(struct file
*filp
, char __user
*buf
, size_t count
, loff_t
* ppos
)
340 int req_pack_id
= -1;
342 struct sg_header
*old_hdr
= NULL
;
345 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
347 SCSI_LOG_TIMEOUT(3, printk("sg_read: %s, count=%d\n",
348 sdp
->disk
->disk_name
, (int) count
));
350 if (!access_ok(VERIFY_WRITE
, buf
, count
))
352 if (sfp
->force_packid
&& (count
>= SZ_SG_HEADER
)) {
353 old_hdr
= kmalloc(SZ_SG_HEADER
, GFP_KERNEL
);
356 if (__copy_from_user(old_hdr
, buf
, SZ_SG_HEADER
)) {
360 if (old_hdr
->reply_len
< 0) {
361 if (count
>= SZ_SG_IO_HDR
) {
362 sg_io_hdr_t
*new_hdr
;
363 new_hdr
= kmalloc(SZ_SG_IO_HDR
, GFP_KERNEL
);
368 retval
=__copy_from_user
369 (new_hdr
, buf
, SZ_SG_IO_HDR
);
370 req_pack_id
= new_hdr
->pack_id
;
378 req_pack_id
= old_hdr
->pack_id
;
380 srp
= sg_get_rq_mark(sfp
, req_pack_id
);
381 if (!srp
) { /* now wait on packet to arrive */
386 if (filp
->f_flags
& O_NONBLOCK
) {
391 retval
= 0; /* following macro beats race condition */
392 __wait_event_interruptible(sfp
->read_wait
,
394 (srp
= sg_get_rq_mark(sfp
, req_pack_id
))),
403 /* -ERESTARTSYS as signal hit process */
407 if (srp
->header
.interface_id
!= '\0') {
408 retval
= sg_new_read(sfp
, buf
, count
, srp
);
413 if (old_hdr
== NULL
) {
414 old_hdr
= kmalloc(SZ_SG_HEADER
, GFP_KERNEL
);
420 memset(old_hdr
, 0, SZ_SG_HEADER
);
421 old_hdr
->reply_len
= (int) hp
->timeout
;
422 old_hdr
->pack_len
= old_hdr
->reply_len
; /* old, strange behaviour */
423 old_hdr
->pack_id
= hp
->pack_id
;
424 old_hdr
->twelve_byte
=
425 ((srp
->data
.cmd_opcode
>= 0xc0) && (12 == hp
->cmd_len
)) ? 1 : 0;
426 old_hdr
->target_status
= hp
->masked_status
;
427 old_hdr
->host_status
= hp
->host_status
;
428 old_hdr
->driver_status
= hp
->driver_status
;
429 if ((CHECK_CONDITION
& hp
->masked_status
) ||
430 (DRIVER_SENSE
& hp
->driver_status
))
431 memcpy(old_hdr
->sense_buffer
, srp
->sense_b
,
432 sizeof (old_hdr
->sense_buffer
));
433 switch (hp
->host_status
) {
434 /* This setup of 'result' is for backward compatibility and is best
435 ignored by the user who should use target, host + driver status */
437 case DID_PASSTHROUGH
:
444 old_hdr
->result
= EBUSY
;
451 old_hdr
->result
= EIO
;
454 old_hdr
->result
= (srp
->sense_b
[0] == 0 &&
455 hp
->masked_status
== GOOD
) ? 0 : EIO
;
458 old_hdr
->result
= EIO
;
462 /* Now copy the result back to the user buffer. */
463 if (count
>= SZ_SG_HEADER
) {
464 if (__copy_to_user(buf
, old_hdr
, SZ_SG_HEADER
)) {
469 if (count
> old_hdr
->reply_len
)
470 count
= old_hdr
->reply_len
;
471 if (count
> SZ_SG_HEADER
) {
472 if (sg_read_oxfer(srp
, buf
, count
- SZ_SG_HEADER
)) {
478 count
= (old_hdr
->result
== 0) ? 0 : -EIO
;
479 sg_finish_rem_req(srp
);
487 sg_new_read(Sg_fd
* sfp
, char __user
*buf
, size_t count
, Sg_request
* srp
)
489 sg_io_hdr_t
*hp
= &srp
->header
;
493 if (count
< SZ_SG_IO_HDR
) {
498 if ((hp
->mx_sb_len
> 0) && hp
->sbp
) {
499 if ((CHECK_CONDITION
& hp
->masked_status
) ||
500 (DRIVER_SENSE
& hp
->driver_status
)) {
501 int sb_len
= SCSI_SENSE_BUFFERSIZE
;
502 sb_len
= (hp
->mx_sb_len
> sb_len
) ? sb_len
: hp
->mx_sb_len
;
503 len
= 8 + (int) srp
->sense_b
[7]; /* Additional sense length field */
504 len
= (len
> sb_len
) ? sb_len
: len
;
505 if (copy_to_user(hp
->sbp
, srp
->sense_b
, len
)) {
512 if (hp
->masked_status
|| hp
->host_status
|| hp
->driver_status
)
513 hp
->info
|= SG_INFO_CHECK
;
514 if (copy_to_user(buf
, hp
, SZ_SG_IO_HDR
)) {
519 err
= sg_finish_rem_req(srp
);
520 return (0 == err
) ? count
: err
;
524 sg_write(struct file
*filp
, const char __user
*buf
, size_t count
, loff_t
* ppos
)
526 int mxsize
, cmd_size
, k
;
527 int input_size
, blocking
;
528 unsigned char opcode
;
532 struct sg_header old_hdr
;
534 unsigned char cmnd
[MAX_COMMAND_SIZE
];
536 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
538 SCSI_LOG_TIMEOUT(3, printk("sg_write: %s, count=%d\n",
539 sdp
->disk
->disk_name
, (int) count
));
542 if (!((filp
->f_flags
& O_NONBLOCK
) ||
543 scsi_block_when_processing_errors(sdp
->device
)))
546 if (!access_ok(VERIFY_READ
, buf
, count
))
547 return -EFAULT
; /* protects following copy_from_user()s + get_user()s */
548 if (count
< SZ_SG_HEADER
)
550 if (__copy_from_user(&old_hdr
, buf
, SZ_SG_HEADER
))
552 blocking
= !(filp
->f_flags
& O_NONBLOCK
);
553 if (old_hdr
.reply_len
< 0)
554 return sg_new_write(sfp
, filp
, buf
, count
,
555 blocking
, 0, 0, NULL
);
556 if (count
< (SZ_SG_HEADER
+ 6))
557 return -EIO
; /* The minimum scsi command length is 6 bytes. */
559 if (!(srp
= sg_add_request(sfp
))) {
560 SCSI_LOG_TIMEOUT(1, printk("sg_write: queue full\n"));
564 __get_user(opcode
, buf
);
565 if (sfp
->next_cmd_len
> 0) {
566 if (sfp
->next_cmd_len
> MAX_COMMAND_SIZE
) {
567 SCSI_LOG_TIMEOUT(1, printk("sg_write: command length too long\n"));
568 sfp
->next_cmd_len
= 0;
569 sg_remove_request(sfp
, srp
);
572 cmd_size
= sfp
->next_cmd_len
;
573 sfp
->next_cmd_len
= 0; /* reset so only this write() effected */
575 cmd_size
= COMMAND_SIZE(opcode
); /* based on SCSI command group */
576 if ((opcode
>= 0xc0) && old_hdr
.twelve_byte
)
579 SCSI_LOG_TIMEOUT(4, printk(
580 "sg_write: scsi opcode=0x%02x, cmd_size=%d\n", (int) opcode
, cmd_size
));
581 /* Determine buffer size. */
582 input_size
= count
- cmd_size
;
583 mxsize
= (input_size
> old_hdr
.reply_len
) ? input_size
: old_hdr
.reply_len
;
584 mxsize
-= SZ_SG_HEADER
;
585 input_size
-= SZ_SG_HEADER
;
586 if (input_size
< 0) {
587 sg_remove_request(sfp
, srp
);
588 return -EIO
; /* User did not pass enough bytes for this command. */
591 hp
->interface_id
= '\0'; /* indicator of old interface tunnelled */
592 hp
->cmd_len
= (unsigned char) cmd_size
;
596 hp
->dxfer_direction
= (old_hdr
.reply_len
> SZ_SG_HEADER
) ?
597 SG_DXFER_TO_FROM_DEV
: SG_DXFER_TO_DEV
;
599 hp
->dxfer_direction
= (mxsize
> 0) ? SG_DXFER_FROM_DEV
: SG_DXFER_NONE
;
600 hp
->dxfer_len
= mxsize
;
601 if (hp
->dxfer_direction
== SG_DXFER_TO_DEV
)
602 hp
->dxferp
= (char __user
*)buf
+ cmd_size
;
606 hp
->timeout
= old_hdr
.reply_len
; /* structure abuse ... */
607 hp
->flags
= input_size
; /* structure abuse ... */
608 hp
->pack_id
= old_hdr
.pack_id
;
610 if (__copy_from_user(cmnd
, buf
, cmd_size
))
613 * SG_DXFER_TO_FROM_DEV is functionally equivalent to SG_DXFER_FROM_DEV,
614 * but is is possible that the app intended SG_DXFER_TO_DEV, because there
615 * is a non-zero input_size, so emit a warning.
617 if (hp
->dxfer_direction
== SG_DXFER_TO_FROM_DEV
) {
618 static char cmd
[TASK_COMM_LEN
];
619 if (strcmp(current
->comm
, cmd
) && printk_ratelimit()) {
621 "sg_write: data in/out %d/%d bytes for SCSI command 0x%x--"
622 "guessing data in;\n "
623 "program %s not setting count and/or reply_len properly\n",
624 old_hdr
.reply_len
- (int)SZ_SG_HEADER
,
625 input_size
, (unsigned int) cmnd
[0],
627 strcpy(cmd
, current
->comm
);
630 k
= sg_common_write(sfp
, srp
, cmnd
, sfp
->timeout
, blocking
);
631 return (k
< 0) ? k
: count
;
635 sg_new_write(Sg_fd
*sfp
, struct file
*file
, const char __user
*buf
,
636 size_t count
, int blocking
, int read_only
, int sg_io_owned
,
642 unsigned char cmnd
[MAX_COMMAND_SIZE
];
644 unsigned long ul_timeout
;
646 if (count
< SZ_SG_IO_HDR
)
648 if (!access_ok(VERIFY_READ
, buf
, count
))
649 return -EFAULT
; /* protects following copy_from_user()s + get_user()s */
651 sfp
->cmd_q
= 1; /* when sg_io_hdr seen, set command queuing on */
652 if (!(srp
= sg_add_request(sfp
))) {
653 SCSI_LOG_TIMEOUT(1, printk("sg_new_write: queue full\n"));
656 srp
->sg_io_owned
= sg_io_owned
;
658 if (__copy_from_user(hp
, buf
, SZ_SG_IO_HDR
)) {
659 sg_remove_request(sfp
, srp
);
662 if (hp
->interface_id
!= 'S') {
663 sg_remove_request(sfp
, srp
);
666 if (hp
->flags
& SG_FLAG_MMAP_IO
) {
667 if (hp
->dxfer_len
> sfp
->reserve
.bufflen
) {
668 sg_remove_request(sfp
, srp
);
669 return -ENOMEM
; /* MMAP_IO size must fit in reserve buffer */
671 if (hp
->flags
& SG_FLAG_DIRECT_IO
) {
672 sg_remove_request(sfp
, srp
);
673 return -EINVAL
; /* either MMAP_IO or DIRECT_IO (not both) */
675 if (sg_res_in_use(sfp
)) {
676 sg_remove_request(sfp
, srp
);
677 return -EBUSY
; /* reserve buffer already being used */
680 ul_timeout
= msecs_to_jiffies(srp
->header
.timeout
);
681 timeout
= (ul_timeout
< INT_MAX
) ? ul_timeout
: INT_MAX
;
682 if ((!hp
->cmdp
) || (hp
->cmd_len
< 6) || (hp
->cmd_len
> sizeof (cmnd
))) {
683 sg_remove_request(sfp
, srp
);
686 if (!access_ok(VERIFY_READ
, hp
->cmdp
, hp
->cmd_len
)) {
687 sg_remove_request(sfp
, srp
);
688 return -EFAULT
; /* protects following copy_from_user()s + get_user()s */
690 if (__copy_from_user(cmnd
, hp
->cmdp
, hp
->cmd_len
)) {
691 sg_remove_request(sfp
, srp
);
694 if (read_only
&& sg_allow_access(file
, cmnd
)) {
695 sg_remove_request(sfp
, srp
);
698 k
= sg_common_write(sfp
, srp
, cmnd
, timeout
, blocking
);
707 sg_common_write(Sg_fd
* sfp
, Sg_request
* srp
,
708 unsigned char *cmnd
, int timeout
, int blocking
)
711 Sg_device
*sdp
= sfp
->parentdp
;
712 sg_io_hdr_t
*hp
= &srp
->header
;
714 srp
->data
.cmd_opcode
= cmnd
[0]; /* hold opcode of command */
716 hp
->masked_status
= 0;
720 hp
->driver_status
= 0;
722 SCSI_LOG_TIMEOUT(4, printk("sg_common_write: scsi opcode=0x%02x, cmd_size=%d\n",
723 (int) cmnd
[0], (int) hp
->cmd_len
));
725 k
= sg_start_req(srp
, cmnd
);
727 SCSI_LOG_TIMEOUT(1, printk("sg_common_write: start_req err=%d\n", k
));
728 sg_finish_rem_req(srp
);
729 return k
; /* probably out of space --> ENOMEM */
733 blk_end_request_all(srp
->rq
, -EIO
);
734 sg_finish_rem_req(srp
);
738 switch (hp
->dxfer_direction
) {
739 case SG_DXFER_TO_FROM_DEV
:
740 case SG_DXFER_FROM_DEV
:
741 data_dir
= DMA_FROM_DEVICE
;
743 case SG_DXFER_TO_DEV
:
744 data_dir
= DMA_TO_DEVICE
;
746 case SG_DXFER_UNKNOWN
:
747 data_dir
= DMA_BIDIRECTIONAL
;
753 hp
->duration
= jiffies_to_msecs(jiffies
);
755 srp
->rq
->timeout
= timeout
;
756 kref_get(&sfp
->f_ref
); /* sg_rq_end_io() does kref_put(). */
757 blk_execute_rq_nowait(sdp
->device
->request_queue
, sdp
->disk
,
758 srp
->rq
, 1, sg_rq_end_io
);
763 sg_ioctl(struct file
*filp
, unsigned int cmd_in
, unsigned long arg
)
765 void __user
*p
= (void __user
*)arg
;
767 int result
, val
, read_only
;
771 unsigned long iflags
;
773 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
776 SCSI_LOG_TIMEOUT(3, printk("sg_ioctl: %s, cmd=0x%x\n",
777 sdp
->disk
->disk_name
, (int) cmd_in
));
778 read_only
= (O_RDWR
!= (filp
->f_flags
& O_ACCMODE
));
783 int blocking
= 1; /* ignore O_NONBLOCK flag */
787 if (!scsi_block_when_processing_errors(sdp
->device
))
789 if (!access_ok(VERIFY_WRITE
, p
, SZ_SG_IO_HDR
))
792 sg_new_write(sfp
, filp
, p
, SZ_SG_IO_HDR
,
793 blocking
, read_only
, 1, &srp
);
797 result
= 0; /* following macro to beat race condition */
798 __wait_event_interruptible(sfp
->read_wait
,
799 (srp
->done
|| sdp
->detached
),
803 write_lock_irq(&sfp
->rq_list_lock
);
806 write_unlock_irq(&sfp
->rq_list_lock
);
810 write_unlock_irq(&sfp
->rq_list_lock
);
811 return result
; /* -ERESTARTSYS because signal hit process */
813 result
= sg_new_read(sfp
, p
, SZ_SG_IO_HDR
, srp
);
814 return (result
< 0) ? result
: 0;
817 result
= get_user(val
, ip
);
822 if (val
>= MULDIV (INT_MAX
, USER_HZ
, HZ
))
823 val
= MULDIV (INT_MAX
, USER_HZ
, HZ
);
824 sfp
->timeout_user
= val
;
825 sfp
->timeout
= MULDIV (val
, HZ
, USER_HZ
);
828 case SG_GET_TIMEOUT
: /* N.B. User receives timeout as return value */
829 /* strange ..., for backward compatibility */
830 return sfp
->timeout_user
;
831 case SG_SET_FORCE_LOW_DMA
:
832 result
= get_user(val
, ip
);
837 if ((0 == sfp
->low_dma
) && (0 == sg_res_in_use(sfp
))) {
838 val
= (int) sfp
->reserve
.bufflen
;
839 sg_remove_scat(&sfp
->reserve
);
840 sg_build_reserve(sfp
, val
);
845 sfp
->low_dma
= sdp
->device
->host
->unchecked_isa_dma
;
849 return put_user((int) sfp
->low_dma
, ip
);
851 if (!access_ok(VERIFY_WRITE
, p
, sizeof (sg_scsi_id_t
)))
854 sg_scsi_id_t __user
*sg_idp
= p
;
858 __put_user((int) sdp
->device
->host
->host_no
,
860 __put_user((int) sdp
->device
->channel
,
862 __put_user((int) sdp
->device
->id
, &sg_idp
->scsi_id
);
863 __put_user((int) sdp
->device
->lun
, &sg_idp
->lun
);
864 __put_user((int) sdp
->device
->type
, &sg_idp
->scsi_type
);
865 __put_user((short) sdp
->device
->host
->cmd_per_lun
,
866 &sg_idp
->h_cmd_per_lun
);
867 __put_user((short) sdp
->device
->queue_depth
,
868 &sg_idp
->d_queue_depth
);
869 __put_user(0, &sg_idp
->unused
[0]);
870 __put_user(0, &sg_idp
->unused
[1]);
873 case SG_SET_FORCE_PACK_ID
:
874 result
= get_user(val
, ip
);
877 sfp
->force_packid
= val
? 1 : 0;
880 if (!access_ok(VERIFY_WRITE
, ip
, sizeof (int)))
882 read_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
883 for (srp
= sfp
->headrp
; srp
; srp
= srp
->nextrp
) {
884 if ((1 == srp
->done
) && (!srp
->sg_io_owned
)) {
885 read_unlock_irqrestore(&sfp
->rq_list_lock
,
887 __put_user(srp
->header
.pack_id
, ip
);
891 read_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
894 case SG_GET_NUM_WAITING
:
895 read_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
896 for (val
= 0, srp
= sfp
->headrp
; srp
; srp
= srp
->nextrp
) {
897 if ((1 == srp
->done
) && (!srp
->sg_io_owned
))
900 read_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
901 return put_user(val
, ip
);
902 case SG_GET_SG_TABLESIZE
:
903 return put_user(sdp
->sg_tablesize
, ip
);
904 case SG_SET_RESERVED_SIZE
:
905 result
= get_user(val
, ip
);
910 val
= min_t(int, val
,
911 queue_max_sectors(sdp
->device
->request_queue
) * 512);
912 if (val
!= sfp
->reserve
.bufflen
) {
913 if (sg_res_in_use(sfp
) || sfp
->mmap_called
)
915 sg_remove_scat(&sfp
->reserve
);
916 sg_build_reserve(sfp
, val
);
919 case SG_GET_RESERVED_SIZE
:
920 val
= min_t(int, sfp
->reserve
.bufflen
,
921 queue_max_sectors(sdp
->device
->request_queue
) * 512);
922 return put_user(val
, ip
);
923 case SG_SET_COMMAND_Q
:
924 result
= get_user(val
, ip
);
927 sfp
->cmd_q
= val
? 1 : 0;
929 case SG_GET_COMMAND_Q
:
930 return put_user((int) sfp
->cmd_q
, ip
);
931 case SG_SET_KEEP_ORPHAN
:
932 result
= get_user(val
, ip
);
935 sfp
->keep_orphan
= val
;
937 case SG_GET_KEEP_ORPHAN
:
938 return put_user((int) sfp
->keep_orphan
, ip
);
939 case SG_NEXT_CMD_LEN
:
940 result
= get_user(val
, ip
);
943 sfp
->next_cmd_len
= (val
> 0) ? val
: 0;
945 case SG_GET_VERSION_NUM
:
946 return put_user(sg_version_num
, ip
);
947 case SG_GET_ACCESS_COUNT
:
948 /* faked - we don't have a real access count anymore */
949 val
= (sdp
->device
? 1 : 0);
950 return put_user(val
, ip
);
951 case SG_GET_REQUEST_TABLE
:
952 if (!access_ok(VERIFY_WRITE
, p
, SZ_SG_REQ_INFO
* SG_MAX_QUEUE
))
955 sg_req_info_t
*rinfo
;
958 rinfo
= kmalloc(SZ_SG_REQ_INFO
* SG_MAX_QUEUE
,
962 read_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
963 for (srp
= sfp
->headrp
, val
= 0; val
< SG_MAX_QUEUE
;
964 ++val
, srp
= srp
? srp
->nextrp
: srp
) {
965 memset(&rinfo
[val
], 0, SZ_SG_REQ_INFO
);
967 rinfo
[val
].req_state
= srp
->done
+ 1;
969 srp
->header
.masked_status
&
970 srp
->header
.host_status
&
971 srp
->header
.driver_status
;
973 rinfo
[val
].duration
=
974 srp
->header
.duration
;
976 ms
= jiffies_to_msecs(jiffies
);
977 rinfo
[val
].duration
=
978 (ms
> srp
->header
.duration
) ?
979 (ms
- srp
->header
.duration
) : 0;
981 rinfo
[val
].orphan
= srp
->orphan
;
982 rinfo
[val
].sg_io_owned
=
990 read_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
991 result
= __copy_to_user(p
, rinfo
,
992 SZ_SG_REQ_INFO
* SG_MAX_QUEUE
);
993 result
= result
? -EFAULT
: 0;
997 case SG_EMULATED_HOST
:
1000 return put_user(sdp
->device
->host
->hostt
->emulated
, ip
);
1004 if (filp
->f_flags
& O_NONBLOCK
) {
1005 if (scsi_host_in_recovery(sdp
->device
->host
))
1007 } else if (!scsi_block_when_processing_errors(sdp
->device
))
1009 result
= get_user(val
, ip
);
1012 if (SG_SCSI_RESET_NOTHING
== val
)
1015 case SG_SCSI_RESET_DEVICE
:
1016 val
= SCSI_TRY_RESET_DEVICE
;
1018 case SG_SCSI_RESET_TARGET
:
1019 val
= SCSI_TRY_RESET_TARGET
;
1021 case SG_SCSI_RESET_BUS
:
1022 val
= SCSI_TRY_RESET_BUS
;
1024 case SG_SCSI_RESET_HOST
:
1025 val
= SCSI_TRY_RESET_HOST
;
1030 if (!capable(CAP_SYS_ADMIN
) || !capable(CAP_SYS_RAWIO
))
1032 return (scsi_reset_provider(sdp
->device
, val
) ==
1033 SUCCESS
) ? 0 : -EIO
;
1034 case SCSI_IOCTL_SEND_COMMAND
:
1038 unsigned char opcode
= WRITE_6
;
1039 Scsi_Ioctl_Command __user
*siocp
= p
;
1041 if (copy_from_user(&opcode
, siocp
->data
, 1))
1043 if (sg_allow_access(filp
, &opcode
))
1046 return sg_scsi_ioctl(sdp
->device
->request_queue
, NULL
, filp
->f_mode
, p
);
1048 result
= get_user(val
, ip
);
1051 sdp
->sgdebug
= (char) val
;
1053 case SCSI_IOCTL_GET_IDLUN
:
1054 case SCSI_IOCTL_GET_BUS_NUMBER
:
1055 case SCSI_IOCTL_PROBE_HOST
:
1056 case SG_GET_TRANSFORM
:
1059 return scsi_ioctl(sdp
->device
, cmd_in
, p
);
1061 return put_user(queue_max_sectors(sdp
->device
->request_queue
) * 512,
1064 return blk_trace_setup(sdp
->device
->request_queue
,
1065 sdp
->disk
->disk_name
,
1066 MKDEV(SCSI_GENERIC_MAJOR
, sdp
->index
),
1070 return blk_trace_startstop(sdp
->device
->request_queue
, 1);
1072 return blk_trace_startstop(sdp
->device
->request_queue
, 0);
1073 case BLKTRACETEARDOWN
:
1074 return blk_trace_remove(sdp
->device
->request_queue
);
1077 return -EPERM
; /* don't know so take safe approach */
1078 return scsi_ioctl(sdp
->device
, cmd_in
, p
);
1083 sg_unlocked_ioctl(struct file
*filp
, unsigned int cmd_in
, unsigned long arg
)
1088 ret
= sg_ioctl(filp
, cmd_in
, arg
);
1094 #ifdef CONFIG_COMPAT
1095 static long sg_compat_ioctl(struct file
*filp
, unsigned int cmd_in
, unsigned long arg
)
1099 struct scsi_device
*sdev
;
1101 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
1105 if (sdev
->host
->hostt
->compat_ioctl
) {
1108 ret
= sdev
->host
->hostt
->compat_ioctl(sdev
, cmd_in
, (void __user
*)arg
);
1113 return -ENOIOCTLCMD
;
1118 sg_poll(struct file
*filp
, poll_table
* wait
)
1120 unsigned int res
= 0;
1125 unsigned long iflags
;
1127 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
))
1130 poll_wait(filp
, &sfp
->read_wait
, wait
);
1131 read_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
1132 for (srp
= sfp
->headrp
; srp
; srp
= srp
->nextrp
) {
1133 /* if any read waiting, flag it */
1134 if ((0 == res
) && (1 == srp
->done
) && (!srp
->sg_io_owned
))
1135 res
= POLLIN
| POLLRDNORM
;
1138 read_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
1142 else if (!sfp
->cmd_q
) {
1144 res
|= POLLOUT
| POLLWRNORM
;
1145 } else if (count
< SG_MAX_QUEUE
)
1146 res
|= POLLOUT
| POLLWRNORM
;
1147 SCSI_LOG_TIMEOUT(3, printk("sg_poll: %s, res=0x%x\n",
1148 sdp
->disk
->disk_name
, (int) res
));
1153 sg_fasync(int fd
, struct file
*filp
, int mode
)
1158 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
1160 SCSI_LOG_TIMEOUT(3, printk("sg_fasync: %s, mode=%d\n",
1161 sdp
->disk
->disk_name
, mode
));
1163 return fasync_helper(fd
, filp
, mode
, &sfp
->async_qp
);
1167 sg_vma_fault(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
1170 unsigned long offset
, len
, sa
;
1171 Sg_scatter_hold
*rsv_schp
;
1174 if ((NULL
== vma
) || (!(sfp
= (Sg_fd
*) vma
->vm_private_data
)))
1175 return VM_FAULT_SIGBUS
;
1176 rsv_schp
= &sfp
->reserve
;
1177 offset
= vmf
->pgoff
<< PAGE_SHIFT
;
1178 if (offset
>= rsv_schp
->bufflen
)
1179 return VM_FAULT_SIGBUS
;
1180 SCSI_LOG_TIMEOUT(3, printk("sg_vma_fault: offset=%lu, scatg=%d\n",
1181 offset
, rsv_schp
->k_use_sg
));
1183 length
= 1 << (PAGE_SHIFT
+ rsv_schp
->page_order
);
1184 for (k
= 0; k
< rsv_schp
->k_use_sg
&& sa
< vma
->vm_end
; k
++) {
1185 len
= vma
->vm_end
- sa
;
1186 len
= (len
< length
) ? len
: length
;
1188 struct page
*page
= nth_page(rsv_schp
->pages
[k
],
1189 offset
>> PAGE_SHIFT
);
1190 get_page(page
); /* increment page count */
1192 return 0; /* success */
1198 return VM_FAULT_SIGBUS
;
1201 static const struct vm_operations_struct sg_mmap_vm_ops
= {
1202 .fault
= sg_vma_fault
,
1206 sg_mmap(struct file
*filp
, struct vm_area_struct
*vma
)
1209 unsigned long req_sz
, len
, sa
;
1210 Sg_scatter_hold
*rsv_schp
;
1213 if ((!filp
) || (!vma
) || (!(sfp
= (Sg_fd
*) filp
->private_data
)))
1215 req_sz
= vma
->vm_end
- vma
->vm_start
;
1216 SCSI_LOG_TIMEOUT(3, printk("sg_mmap starting, vm_start=%p, len=%d\n",
1217 (void *) vma
->vm_start
, (int) req_sz
));
1219 return -EINVAL
; /* want no offset */
1220 rsv_schp
= &sfp
->reserve
;
1221 if (req_sz
> rsv_schp
->bufflen
)
1222 return -ENOMEM
; /* cannot map more than reserved buffer */
1225 length
= 1 << (PAGE_SHIFT
+ rsv_schp
->page_order
);
1226 for (k
= 0; k
< rsv_schp
->k_use_sg
&& sa
< vma
->vm_end
; k
++) {
1227 len
= vma
->vm_end
- sa
;
1228 len
= (len
< length
) ? len
: length
;
1232 sfp
->mmap_called
= 1;
1233 vma
->vm_flags
|= VM_RESERVED
;
1234 vma
->vm_private_data
= sfp
;
1235 vma
->vm_ops
= &sg_mmap_vm_ops
;
1239 static void sg_rq_end_io_usercontext(struct work_struct
*work
)
1241 struct sg_request
*srp
= container_of(work
, struct sg_request
, ew
.work
);
1242 struct sg_fd
*sfp
= srp
->parentfp
;
1244 sg_finish_rem_req(srp
);
1245 kref_put(&sfp
->f_ref
, sg_remove_sfp
);
1249 * This function is a "bottom half" handler that is called by the mid
1250 * level when a command is completed (or has failed).
1252 static void sg_rq_end_io(struct request
*rq
, int uptodate
)
1254 struct sg_request
*srp
= rq
->end_io_data
;
1257 unsigned long iflags
;
1260 int result
, resid
, done
= 1;
1262 if (WARN_ON(srp
->done
!= 0))
1265 sfp
= srp
->parentfp
;
1266 if (WARN_ON(sfp
== NULL
))
1269 sdp
= sfp
->parentdp
;
1270 if (unlikely(sdp
->detached
))
1271 printk(KERN_INFO
"sg_rq_end_io: device detached\n");
1274 result
= rq
->errors
;
1275 resid
= rq
->resid_len
;
1277 SCSI_LOG_TIMEOUT(4, printk("sg_cmd_done: %s, pack_id=%d, res=0x%x\n",
1278 sdp
->disk
->disk_name
, srp
->header
.pack_id
, result
));
1279 srp
->header
.resid
= resid
;
1280 ms
= jiffies_to_msecs(jiffies
);
1281 srp
->header
.duration
= (ms
> srp
->header
.duration
) ?
1282 (ms
- srp
->header
.duration
) : 0;
1284 struct scsi_sense_hdr sshdr
;
1286 srp
->header
.status
= 0xff & result
;
1287 srp
->header
.masked_status
= status_byte(result
);
1288 srp
->header
.msg_status
= msg_byte(result
);
1289 srp
->header
.host_status
= host_byte(result
);
1290 srp
->header
.driver_status
= driver_byte(result
);
1291 if ((sdp
->sgdebug
> 0) &&
1292 ((CHECK_CONDITION
== srp
->header
.masked_status
) ||
1293 (COMMAND_TERMINATED
== srp
->header
.masked_status
)))
1294 __scsi_print_sense("sg_cmd_done", sense
,
1295 SCSI_SENSE_BUFFERSIZE
);
1297 /* Following if statement is a patch supplied by Eric Youngdale */
1298 if (driver_byte(result
) != 0
1299 && scsi_normalize_sense(sense
, SCSI_SENSE_BUFFERSIZE
, &sshdr
)
1300 && !scsi_sense_is_deferred(&sshdr
)
1301 && sshdr
.sense_key
== UNIT_ATTENTION
1302 && sdp
->device
->removable
) {
1303 /* Detected possible disc change. Set the bit - this */
1304 /* may be used if there are filesystems using this device */
1305 sdp
->device
->changed
= 1;
1308 /* Rely on write phase to clean out srp status values, so no "else" */
1310 write_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
1311 if (unlikely(srp
->orphan
)) {
1312 if (sfp
->keep_orphan
)
1313 srp
->sg_io_owned
= 0;
1318 write_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
1321 /* Now wake up any sg_read() that is waiting for this
1324 wake_up_interruptible(&sfp
->read_wait
);
1325 kill_fasync(&sfp
->async_qp
, SIGPOLL
, POLL_IN
);
1326 kref_put(&sfp
->f_ref
, sg_remove_sfp
);
1328 INIT_WORK(&srp
->ew
.work
, sg_rq_end_io_usercontext
);
1329 schedule_work(&srp
->ew
.work
);
1333 static const struct file_operations sg_fops
= {
1334 .owner
= THIS_MODULE
,
1338 .unlocked_ioctl
= sg_unlocked_ioctl
,
1339 #ifdef CONFIG_COMPAT
1340 .compat_ioctl
= sg_compat_ioctl
,
1344 .release
= sg_release
,
1345 .fasync
= sg_fasync
,
1348 static struct class *sg_sysfs_class
;
1350 static int sg_sysfs_valid
= 0;
1352 static Sg_device
*sg_alloc(struct gendisk
*disk
, struct scsi_device
*scsidp
)
1354 struct request_queue
*q
= scsidp
->request_queue
;
1356 unsigned long iflags
;
1360 sdp
= kzalloc(sizeof(Sg_device
), GFP_KERNEL
);
1362 printk(KERN_WARNING
"kmalloc Sg_device failure\n");
1363 return ERR_PTR(-ENOMEM
);
1366 if (!idr_pre_get(&sg_index_idr
, GFP_KERNEL
)) {
1367 printk(KERN_WARNING
"idr expansion Sg_device failure\n");
1372 write_lock_irqsave(&sg_index_lock
, iflags
);
1374 error
= idr_get_new(&sg_index_idr
, sdp
, &k
);
1376 write_unlock_irqrestore(&sg_index_lock
, iflags
);
1377 printk(KERN_WARNING
"idr allocation Sg_device failure: %d\n",
1382 if (unlikely(k
>= SG_MAX_DEVS
))
1385 SCSI_LOG_TIMEOUT(3, printk("sg_alloc: dev=%d \n", k
));
1386 sprintf(disk
->disk_name
, "sg%d", k
);
1387 disk
->first_minor
= k
;
1389 sdp
->device
= scsidp
;
1390 INIT_LIST_HEAD(&sdp
->sfds
);
1391 init_waitqueue_head(&sdp
->o_excl_wait
);
1392 sdp
->sg_tablesize
= queue_max_segments(q
);
1394 kref_init(&sdp
->d_ref
);
1396 write_unlock_irqrestore(&sg_index_lock
, iflags
);
1402 return ERR_PTR(error
);
1407 idr_remove(&sg_index_idr
, k
);
1408 write_unlock_irqrestore(&sg_index_lock
, iflags
);
1409 sdev_printk(KERN_WARNING
, scsidp
,
1410 "Unable to attach sg device type=%d, minor "
1411 "number exceeds %d\n", scsidp
->type
, SG_MAX_DEVS
- 1);
1417 sg_add(struct device
*cl_dev
, struct class_interface
*cl_intf
)
1419 struct scsi_device
*scsidp
= to_scsi_device(cl_dev
->parent
);
1420 struct gendisk
*disk
;
1421 Sg_device
*sdp
= NULL
;
1422 struct cdev
* cdev
= NULL
;
1424 unsigned long iflags
;
1426 disk
= alloc_disk(1);
1428 printk(KERN_WARNING
"alloc_disk failed\n");
1431 disk
->major
= SCSI_GENERIC_MAJOR
;
1434 cdev
= cdev_alloc();
1436 printk(KERN_WARNING
"cdev_alloc failed\n");
1439 cdev
->owner
= THIS_MODULE
;
1440 cdev
->ops
= &sg_fops
;
1442 sdp
= sg_alloc(disk
, scsidp
);
1444 printk(KERN_WARNING
"sg_alloc failed\n");
1445 error
= PTR_ERR(sdp
);
1449 error
= cdev_add(cdev
, MKDEV(SCSI_GENERIC_MAJOR
, sdp
->index
), 1);
1454 if (sg_sysfs_valid
) {
1455 struct device
*sg_class_member
;
1457 sg_class_member
= device_create(sg_sysfs_class
, cl_dev
->parent
,
1458 MKDEV(SCSI_GENERIC_MAJOR
,
1460 sdp
, "%s", disk
->disk_name
);
1461 if (IS_ERR(sg_class_member
)) {
1462 printk(KERN_ERR
"sg_add: "
1463 "device_create failed\n");
1464 error
= PTR_ERR(sg_class_member
);
1467 error
= sysfs_create_link(&scsidp
->sdev_gendev
.kobj
,
1468 &sg_class_member
->kobj
, "generic");
1470 printk(KERN_ERR
"sg_add: unable to make symlink "
1471 "'generic' back to sg%d\n", sdp
->index
);
1473 printk(KERN_WARNING
"sg_add: sg_sys Invalid\n");
1475 sdev_printk(KERN_NOTICE
, scsidp
,
1476 "Attached scsi generic sg%d type %d\n", sdp
->index
,
1479 dev_set_drvdata(cl_dev
, sdp
);
1484 write_lock_irqsave(&sg_index_lock
, iflags
);
1485 idr_remove(&sg_index_idr
, sdp
->index
);
1486 write_unlock_irqrestore(&sg_index_lock
, iflags
);
1496 static void sg_device_destroy(struct kref
*kref
)
1498 struct sg_device
*sdp
= container_of(kref
, struct sg_device
, d_ref
);
1499 unsigned long flags
;
1501 /* CAUTION! Note that the device can still be found via idr_find()
1502 * even though the refcount is 0. Therefore, do idr_remove() BEFORE
1503 * any other cleanup.
1506 write_lock_irqsave(&sg_index_lock
, flags
);
1507 idr_remove(&sg_index_idr
, sdp
->index
);
1508 write_unlock_irqrestore(&sg_index_lock
, flags
);
1511 printk("sg_device_destroy: %s\n",
1512 sdp
->disk
->disk_name
));
1514 put_disk(sdp
->disk
);
1518 static void sg_remove(struct device
*cl_dev
, struct class_interface
*cl_intf
)
1520 struct scsi_device
*scsidp
= to_scsi_device(cl_dev
->parent
);
1521 Sg_device
*sdp
= dev_get_drvdata(cl_dev
);
1522 unsigned long iflags
;
1525 if (!sdp
|| sdp
->detached
)
1528 SCSI_LOG_TIMEOUT(3, printk("sg_remove: %s\n", sdp
->disk
->disk_name
));
1530 /* Need a write lock to set sdp->detached. */
1531 write_lock_irqsave(&sg_index_lock
, iflags
);
1533 list_for_each_entry(sfp
, &sdp
->sfds
, sfd_siblings
) {
1534 wake_up_interruptible(&sfp
->read_wait
);
1535 kill_fasync(&sfp
->async_qp
, SIGPOLL
, POLL_HUP
);
1537 write_unlock_irqrestore(&sg_index_lock
, iflags
);
1539 sysfs_remove_link(&scsidp
->sdev_gendev
.kobj
, "generic");
1540 device_destroy(sg_sysfs_class
, MKDEV(SCSI_GENERIC_MAJOR
, sdp
->index
));
1541 cdev_del(sdp
->cdev
);
1547 module_param_named(scatter_elem_sz
, scatter_elem_sz
, int, S_IRUGO
| S_IWUSR
);
1548 module_param_named(def_reserved_size
, def_reserved_size
, int,
1550 module_param_named(allow_dio
, sg_allow_dio
, int, S_IRUGO
| S_IWUSR
);
1552 MODULE_AUTHOR("Douglas Gilbert");
1553 MODULE_DESCRIPTION("SCSI generic (sg) driver");
1554 MODULE_LICENSE("GPL");
1555 MODULE_VERSION(SG_VERSION_STR
);
1556 MODULE_ALIAS_CHARDEV_MAJOR(SCSI_GENERIC_MAJOR
);
1558 MODULE_PARM_DESC(scatter_elem_sz
, "scatter gather element "
1559 "size (default: max(SG_SCATTER_SZ, PAGE_SIZE))");
1560 MODULE_PARM_DESC(def_reserved_size
, "size of buffer reserved for each fd");
1561 MODULE_PARM_DESC(allow_dio
, "allow direct I/O (default: 0 (disallow))");
1568 if (scatter_elem_sz
< PAGE_SIZE
) {
1569 scatter_elem_sz
= PAGE_SIZE
;
1570 scatter_elem_sz_prev
= scatter_elem_sz
;
1572 if (def_reserved_size
>= 0)
1573 sg_big_buff
= def_reserved_size
;
1575 def_reserved_size
= sg_big_buff
;
1577 rc
= register_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR
, 0),
1581 sg_sysfs_class
= class_create(THIS_MODULE
, "scsi_generic");
1582 if ( IS_ERR(sg_sysfs_class
) ) {
1583 rc
= PTR_ERR(sg_sysfs_class
);
1587 rc
= scsi_register_interface(&sg_interface
);
1589 #ifdef CONFIG_SCSI_PROC_FS
1591 #endif /* CONFIG_SCSI_PROC_FS */
1594 class_destroy(sg_sysfs_class
);
1596 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR
, 0), SG_MAX_DEVS
);
1603 #ifdef CONFIG_SCSI_PROC_FS
1605 #endif /* CONFIG_SCSI_PROC_FS */
1606 scsi_unregister_interface(&sg_interface
);
1607 class_destroy(sg_sysfs_class
);
1609 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR
, 0),
1611 idr_destroy(&sg_index_idr
);
1614 static int sg_start_req(Sg_request
*srp
, unsigned char *cmd
)
1618 Sg_fd
*sfp
= srp
->parentfp
;
1619 sg_io_hdr_t
*hp
= &srp
->header
;
1620 int dxfer_len
= (int) hp
->dxfer_len
;
1621 int dxfer_dir
= hp
->dxfer_direction
;
1622 unsigned int iov_count
= hp
->iovec_count
;
1623 Sg_scatter_hold
*req_schp
= &srp
->data
;
1624 Sg_scatter_hold
*rsv_schp
= &sfp
->reserve
;
1625 struct request_queue
*q
= sfp
->parentdp
->device
->request_queue
;
1626 struct rq_map_data
*md
, map_data
;
1627 int rw
= hp
->dxfer_direction
== SG_DXFER_TO_DEV
? WRITE
: READ
;
1629 SCSI_LOG_TIMEOUT(4, printk(KERN_INFO
"sg_start_req: dxfer_len=%d\n",
1632 rq
= blk_get_request(q
, rw
, GFP_ATOMIC
);
1636 memcpy(rq
->cmd
, cmd
, hp
->cmd_len
);
1638 rq
->cmd_len
= hp
->cmd_len
;
1639 rq
->cmd_type
= REQ_TYPE_BLOCK_PC
;
1642 rq
->end_io_data
= srp
;
1643 rq
->sense
= srp
->sense_b
;
1644 rq
->retries
= SG_DEFAULT_RETRIES
;
1646 if ((dxfer_len
<= 0) || (dxfer_dir
== SG_DXFER_NONE
))
1649 if (sg_allow_dio
&& hp
->flags
& SG_FLAG_DIRECT_IO
&&
1650 dxfer_dir
!= SG_DXFER_UNKNOWN
&& !iov_count
&&
1651 !sfp
->parentdp
->device
->host
->unchecked_isa_dma
&&
1652 blk_rq_aligned(q
, hp
->dxferp
, dxfer_len
))
1658 if (!sg_res_in_use(sfp
) && dxfer_len
<= rsv_schp
->bufflen
)
1659 sg_link_reserve(sfp
, srp
, dxfer_len
);
1661 res
= sg_build_indirect(req_schp
, sfp
, dxfer_len
);
1666 md
->pages
= req_schp
->pages
;
1667 md
->page_order
= req_schp
->page_order
;
1668 md
->nr_entries
= req_schp
->k_use_sg
;
1670 md
->null_mapped
= hp
->dxferp
? 0 : 1;
1671 if (dxfer_dir
== SG_DXFER_TO_FROM_DEV
)
1678 int len
, size
= sizeof(struct sg_iovec
) * iov_count
;
1681 iov
= kmalloc(size
, GFP_ATOMIC
);
1685 if (copy_from_user(iov
, hp
->dxferp
, size
)) {
1690 len
= iov_length(iov
, iov_count
);
1691 if (hp
->dxfer_len
< len
) {
1692 iov_count
= iov_shorten(iov
, iov_count
, hp
->dxfer_len
);
1693 len
= hp
->dxfer_len
;
1696 res
= blk_rq_map_user_iov(q
, rq
, md
, (struct sg_iovec
*)iov
,
1701 res
= blk_rq_map_user(q
, rq
, md
, hp
->dxferp
,
1702 hp
->dxfer_len
, GFP_ATOMIC
);
1708 req_schp
->dio_in_use
= 1;
1709 hp
->info
|= SG_INFO_DIRECT_IO
;
1715 static int sg_finish_rem_req(Sg_request
* srp
)
1719 Sg_fd
*sfp
= srp
->parentfp
;
1720 Sg_scatter_hold
*req_schp
= &srp
->data
;
1722 SCSI_LOG_TIMEOUT(4, printk("sg_finish_rem_req: res_used=%d\n", (int) srp
->res_used
));
1725 ret
= blk_rq_unmap_user(srp
->bio
);
1727 blk_put_request(srp
->rq
);
1731 sg_unlink_reserve(sfp
, srp
);
1733 sg_remove_scat(req_schp
);
1735 sg_remove_request(sfp
, srp
);
1741 sg_build_sgat(Sg_scatter_hold
* schp
, const Sg_fd
* sfp
, int tablesize
)
1743 int sg_bufflen
= tablesize
* sizeof(struct page
*);
1744 gfp_t gfp_flags
= GFP_ATOMIC
| __GFP_NOWARN
;
1746 schp
->pages
= kzalloc(sg_bufflen
, gfp_flags
);
1749 schp
->sglist_len
= sg_bufflen
;
1750 return tablesize
; /* number of scat_gath elements allocated */
1754 sg_build_indirect(Sg_scatter_hold
* schp
, Sg_fd
* sfp
, int buff_size
)
1756 int ret_sz
= 0, i
, k
, rem_sz
, num
, mx_sc_elems
;
1757 int sg_tablesize
= sfp
->parentdp
->sg_tablesize
;
1758 int blk_size
= buff_size
, order
;
1759 gfp_t gfp_mask
= GFP_ATOMIC
| __GFP_COMP
| __GFP_NOWARN
;
1764 ++blk_size
; /* don't know why */
1765 /* round request up to next highest SG_SECTOR_SZ byte boundary */
1766 blk_size
= ALIGN(blk_size
, SG_SECTOR_SZ
);
1767 SCSI_LOG_TIMEOUT(4, printk("sg_build_indirect: buff_size=%d, blk_size=%d\n",
1768 buff_size
, blk_size
));
1770 /* N.B. ret_sz carried into this block ... */
1771 mx_sc_elems
= sg_build_sgat(schp
, sfp
, sg_tablesize
);
1772 if (mx_sc_elems
< 0)
1773 return mx_sc_elems
; /* most likely -ENOMEM */
1775 num
= scatter_elem_sz
;
1776 if (unlikely(num
!= scatter_elem_sz_prev
)) {
1777 if (num
< PAGE_SIZE
) {
1778 scatter_elem_sz
= PAGE_SIZE
;
1779 scatter_elem_sz_prev
= PAGE_SIZE
;
1781 scatter_elem_sz_prev
= num
;
1785 gfp_mask
|= GFP_DMA
;
1787 if (!capable(CAP_SYS_ADMIN
) || !capable(CAP_SYS_RAWIO
))
1788 gfp_mask
|= __GFP_ZERO
;
1790 order
= get_order(num
);
1792 ret_sz
= 1 << (PAGE_SHIFT
+ order
);
1794 for (k
= 0, rem_sz
= blk_size
; rem_sz
> 0 && k
< mx_sc_elems
;
1795 k
++, rem_sz
-= ret_sz
) {
1797 num
= (rem_sz
> scatter_elem_sz_prev
) ?
1798 scatter_elem_sz_prev
: rem_sz
;
1800 schp
->pages
[k
] = alloc_pages(gfp_mask
, order
);
1801 if (!schp
->pages
[k
])
1804 if (num
== scatter_elem_sz_prev
) {
1805 if (unlikely(ret_sz
> scatter_elem_sz_prev
)) {
1806 scatter_elem_sz
= ret_sz
;
1807 scatter_elem_sz_prev
= ret_sz
;
1811 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k=%d, num=%d, "
1812 "ret_sz=%d\n", k
, num
, ret_sz
));
1813 } /* end of for loop */
1815 schp
->page_order
= order
;
1817 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k_use_sg=%d, "
1818 "rem_sz=%d\n", k
, rem_sz
));
1820 schp
->bufflen
= blk_size
;
1821 if (rem_sz
> 0) /* must have failed */
1825 for (i
= 0; i
< k
; i
++)
1826 __free_pages(schp
->pages
[i
], order
);
1835 sg_remove_scat(Sg_scatter_hold
* schp
)
1837 SCSI_LOG_TIMEOUT(4, printk("sg_remove_scat: k_use_sg=%d\n", schp
->k_use_sg
));
1838 if (schp
->pages
&& schp
->sglist_len
> 0) {
1839 if (!schp
->dio_in_use
) {
1842 for (k
= 0; k
< schp
->k_use_sg
&& schp
->pages
[k
]; k
++) {
1843 SCSI_LOG_TIMEOUT(5, printk(
1844 "sg_remove_scat: k=%d, pg=0x%p\n",
1845 k
, schp
->pages
[k
]));
1846 __free_pages(schp
->pages
[k
], schp
->page_order
);
1852 memset(schp
, 0, sizeof (*schp
));
1856 sg_read_oxfer(Sg_request
* srp
, char __user
*outp
, int num_read_xfer
)
1858 Sg_scatter_hold
*schp
= &srp
->data
;
1861 SCSI_LOG_TIMEOUT(4, printk("sg_read_oxfer: num_read_xfer=%d\n",
1863 if ((!outp
) || (num_read_xfer
<= 0))
1866 num
= 1 << (PAGE_SHIFT
+ schp
->page_order
);
1867 for (k
= 0; k
< schp
->k_use_sg
&& schp
->pages
[k
]; k
++) {
1868 if (num
> num_read_xfer
) {
1869 if (__copy_to_user(outp
, page_address(schp
->pages
[k
]),
1874 if (__copy_to_user(outp
, page_address(schp
->pages
[k
]),
1877 num_read_xfer
-= num
;
1878 if (num_read_xfer
<= 0)
1888 sg_build_reserve(Sg_fd
* sfp
, int req_size
)
1890 Sg_scatter_hold
*schp
= &sfp
->reserve
;
1892 SCSI_LOG_TIMEOUT(4, printk("sg_build_reserve: req_size=%d\n", req_size
));
1894 if (req_size
< PAGE_SIZE
)
1895 req_size
= PAGE_SIZE
;
1896 if (0 == sg_build_indirect(schp
, sfp
, req_size
))
1899 sg_remove_scat(schp
);
1900 req_size
>>= 1; /* divide by 2 */
1901 } while (req_size
> (PAGE_SIZE
/ 2));
1905 sg_link_reserve(Sg_fd
* sfp
, Sg_request
* srp
, int size
)
1907 Sg_scatter_hold
*req_schp
= &srp
->data
;
1908 Sg_scatter_hold
*rsv_schp
= &sfp
->reserve
;
1912 SCSI_LOG_TIMEOUT(4, printk("sg_link_reserve: size=%d\n", size
));
1915 num
= 1 << (PAGE_SHIFT
+ rsv_schp
->page_order
);
1916 for (k
= 0; k
< rsv_schp
->k_use_sg
; k
++) {
1918 req_schp
->k_use_sg
= k
+ 1;
1919 req_schp
->sglist_len
= rsv_schp
->sglist_len
;
1920 req_schp
->pages
= rsv_schp
->pages
;
1922 req_schp
->bufflen
= size
;
1923 req_schp
->page_order
= rsv_schp
->page_order
;
1929 if (k
>= rsv_schp
->k_use_sg
)
1930 SCSI_LOG_TIMEOUT(1, printk("sg_link_reserve: BAD size\n"));
1934 sg_unlink_reserve(Sg_fd
* sfp
, Sg_request
* srp
)
1936 Sg_scatter_hold
*req_schp
= &srp
->data
;
1938 SCSI_LOG_TIMEOUT(4, printk("sg_unlink_reserve: req->k_use_sg=%d\n",
1939 (int) req_schp
->k_use_sg
));
1940 req_schp
->k_use_sg
= 0;
1941 req_schp
->bufflen
= 0;
1942 req_schp
->pages
= NULL
;
1943 req_schp
->page_order
= 0;
1944 req_schp
->sglist_len
= 0;
1945 sfp
->save_scat_len
= 0;
1950 sg_get_rq_mark(Sg_fd
* sfp
, int pack_id
)
1953 unsigned long iflags
;
1955 write_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
1956 for (resp
= sfp
->headrp
; resp
; resp
= resp
->nextrp
) {
1957 /* look for requests that are ready + not SG_IO owned */
1958 if ((1 == resp
->done
) && (!resp
->sg_io_owned
) &&
1959 ((-1 == pack_id
) || (resp
->header
.pack_id
== pack_id
))) {
1960 resp
->done
= 2; /* guard against other readers */
1964 write_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
1968 /* always adds to end of list */
1970 sg_add_request(Sg_fd
* sfp
)
1973 unsigned long iflags
;
1975 Sg_request
*rp
= sfp
->req_arr
;
1977 write_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
1980 memset(rp
, 0, sizeof (Sg_request
));
1985 if (0 == sfp
->cmd_q
)
1986 resp
= NULL
; /* command queuing disallowed */
1988 for (k
= 0; k
< SG_MAX_QUEUE
; ++k
, ++rp
) {
1992 if (k
< SG_MAX_QUEUE
) {
1993 memset(rp
, 0, sizeof (Sg_request
));
1995 while (resp
->nextrp
)
1996 resp
= resp
->nextrp
;
2004 resp
->nextrp
= NULL
;
2005 resp
->header
.duration
= jiffies_to_msecs(jiffies
);
2007 write_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
2011 /* Return of 1 for found; 0 for not found */
2013 sg_remove_request(Sg_fd
* sfp
, Sg_request
* srp
)
2015 Sg_request
*prev_rp
;
2017 unsigned long iflags
;
2020 if ((!sfp
) || (!srp
) || (!sfp
->headrp
))
2022 write_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
2023 prev_rp
= sfp
->headrp
;
2024 if (srp
== prev_rp
) {
2025 sfp
->headrp
= prev_rp
->nextrp
;
2026 prev_rp
->parentfp
= NULL
;
2029 while ((rp
= prev_rp
->nextrp
)) {
2031 prev_rp
->nextrp
= rp
->nextrp
;
2032 rp
->parentfp
= NULL
;
2039 write_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
2044 sg_add_sfp(Sg_device
* sdp
, int dev
)
2047 unsigned long iflags
;
2050 sfp
= kzalloc(sizeof(*sfp
), GFP_ATOMIC
| __GFP_NOWARN
);
2054 init_waitqueue_head(&sfp
->read_wait
);
2055 rwlock_init(&sfp
->rq_list_lock
);
2057 kref_init(&sfp
->f_ref
);
2058 sfp
->timeout
= SG_DEFAULT_TIMEOUT
;
2059 sfp
->timeout_user
= SG_DEFAULT_TIMEOUT_USER
;
2060 sfp
->force_packid
= SG_DEF_FORCE_PACK_ID
;
2061 sfp
->low_dma
= (SG_DEF_FORCE_LOW_DMA
== 0) ?
2062 sdp
->device
->host
->unchecked_isa_dma
: 1;
2063 sfp
->cmd_q
= SG_DEF_COMMAND_Q
;
2064 sfp
->keep_orphan
= SG_DEF_KEEP_ORPHAN
;
2065 sfp
->parentdp
= sdp
;
2066 write_lock_irqsave(&sg_index_lock
, iflags
);
2067 list_add_tail(&sfp
->sfd_siblings
, &sdp
->sfds
);
2068 write_unlock_irqrestore(&sg_index_lock
, iflags
);
2069 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: sfp=0x%p\n", sfp
));
2070 if (unlikely(sg_big_buff
!= def_reserved_size
))
2071 sg_big_buff
= def_reserved_size
;
2073 bufflen
= min_t(int, sg_big_buff
,
2074 queue_max_sectors(sdp
->device
->request_queue
) * 512);
2075 sg_build_reserve(sfp
, bufflen
);
2076 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: bufflen=%d, k_use_sg=%d\n",
2077 sfp
->reserve
.bufflen
, sfp
->reserve
.k_use_sg
));
2079 kref_get(&sdp
->d_ref
);
2080 __module_get(THIS_MODULE
);
2084 static void sg_remove_sfp_usercontext(struct work_struct
*work
)
2086 struct sg_fd
*sfp
= container_of(work
, struct sg_fd
, ew
.work
);
2087 struct sg_device
*sdp
= sfp
->parentdp
;
2089 /* Cleanup any responses which were never read(). */
2091 sg_finish_rem_req(sfp
->headrp
);
2093 if (sfp
->reserve
.bufflen
> 0) {
2095 printk("sg_remove_sfp: bufflen=%d, k_use_sg=%d\n",
2096 (int) sfp
->reserve
.bufflen
,
2097 (int) sfp
->reserve
.k_use_sg
));
2098 sg_remove_scat(&sfp
->reserve
);
2102 printk("sg_remove_sfp: %s, sfp=0x%p\n",
2103 sdp
->disk
->disk_name
,
2107 scsi_device_put(sdp
->device
);
2109 module_put(THIS_MODULE
);
2112 static void sg_remove_sfp(struct kref
*kref
)
2114 struct sg_fd
*sfp
= container_of(kref
, struct sg_fd
, f_ref
);
2115 struct sg_device
*sdp
= sfp
->parentdp
;
2116 unsigned long iflags
;
2118 write_lock_irqsave(&sg_index_lock
, iflags
);
2119 list_del(&sfp
->sfd_siblings
);
2120 write_unlock_irqrestore(&sg_index_lock
, iflags
);
2121 wake_up_interruptible(&sdp
->o_excl_wait
);
2123 INIT_WORK(&sfp
->ew
.work
, sg_remove_sfp_usercontext
);
2124 schedule_work(&sfp
->ew
.work
);
2128 sg_res_in_use(Sg_fd
* sfp
)
2130 const Sg_request
*srp
;
2131 unsigned long iflags
;
2133 read_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
2134 for (srp
= sfp
->headrp
; srp
; srp
= srp
->nextrp
)
2137 read_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
2141 #ifdef CONFIG_SCSI_PROC_FS
2143 sg_idr_max_id(int id
, void *p
, void *data
)
2157 unsigned long iflags
;
2159 read_lock_irqsave(&sg_index_lock
, iflags
);
2160 idr_for_each(&sg_index_idr
, sg_idr_max_id
, &k
);
2161 read_unlock_irqrestore(&sg_index_lock
, iflags
);
2162 return k
+ 1; /* origin 1 */
2166 /* must be called with sg_index_lock held */
2167 static Sg_device
*sg_lookup_dev(int dev
)
2169 return idr_find(&sg_index_idr
, dev
);
2172 static Sg_device
*sg_get_dev(int dev
)
2174 struct sg_device
*sdp
;
2175 unsigned long flags
;
2177 read_lock_irqsave(&sg_index_lock
, flags
);
2178 sdp
= sg_lookup_dev(dev
);
2180 sdp
= ERR_PTR(-ENXIO
);
2181 else if (sdp
->detached
) {
2182 /* If sdp->detached, then the refcount may already be 0, in
2183 * which case it would be a bug to do kref_get().
2185 sdp
= ERR_PTR(-ENODEV
);
2187 kref_get(&sdp
->d_ref
);
2188 read_unlock_irqrestore(&sg_index_lock
, flags
);
2193 static void sg_put_dev(struct sg_device
*sdp
)
2195 kref_put(&sdp
->d_ref
, sg_device_destroy
);
2198 #ifdef CONFIG_SCSI_PROC_FS
2200 static struct proc_dir_entry
*sg_proc_sgp
= NULL
;
2202 static char sg_proc_sg_dirname
[] = "scsi/sg";
2204 static int sg_proc_seq_show_int(struct seq_file
*s
, void *v
);
2206 static int sg_proc_single_open_adio(struct inode
*inode
, struct file
*file
);
2207 static ssize_t
sg_proc_write_adio(struct file
*filp
, const char __user
*buffer
,
2208 size_t count
, loff_t
*off
);
2209 static const struct file_operations adio_fops
= {
2210 .owner
= THIS_MODULE
,
2211 .open
= sg_proc_single_open_adio
,
2213 .llseek
= seq_lseek
,
2214 .write
= sg_proc_write_adio
,
2215 .release
= single_release
,
2218 static int sg_proc_single_open_dressz(struct inode
*inode
, struct file
*file
);
2219 static ssize_t
sg_proc_write_dressz(struct file
*filp
,
2220 const char __user
*buffer
, size_t count
, loff_t
*off
);
2221 static const struct file_operations dressz_fops
= {
2222 .owner
= THIS_MODULE
,
2223 .open
= sg_proc_single_open_dressz
,
2225 .llseek
= seq_lseek
,
2226 .write
= sg_proc_write_dressz
,
2227 .release
= single_release
,
2230 static int sg_proc_seq_show_version(struct seq_file
*s
, void *v
);
2231 static int sg_proc_single_open_version(struct inode
*inode
, struct file
*file
);
2232 static const struct file_operations version_fops
= {
2233 .owner
= THIS_MODULE
,
2234 .open
= sg_proc_single_open_version
,
2236 .llseek
= seq_lseek
,
2237 .release
= single_release
,
2240 static int sg_proc_seq_show_devhdr(struct seq_file
*s
, void *v
);
2241 static int sg_proc_single_open_devhdr(struct inode
*inode
, struct file
*file
);
2242 static const struct file_operations devhdr_fops
= {
2243 .owner
= THIS_MODULE
,
2244 .open
= sg_proc_single_open_devhdr
,
2246 .llseek
= seq_lseek
,
2247 .release
= single_release
,
2250 static int sg_proc_seq_show_dev(struct seq_file
*s
, void *v
);
2251 static int sg_proc_open_dev(struct inode
*inode
, struct file
*file
);
2252 static void * dev_seq_start(struct seq_file
*s
, loff_t
*pos
);
2253 static void * dev_seq_next(struct seq_file
*s
, void *v
, loff_t
*pos
);
2254 static void dev_seq_stop(struct seq_file
*s
, void *v
);
2255 static const struct file_operations dev_fops
= {
2256 .owner
= THIS_MODULE
,
2257 .open
= sg_proc_open_dev
,
2259 .llseek
= seq_lseek
,
2260 .release
= seq_release
,
2262 static const struct seq_operations dev_seq_ops
= {
2263 .start
= dev_seq_start
,
2264 .next
= dev_seq_next
,
2265 .stop
= dev_seq_stop
,
2266 .show
= sg_proc_seq_show_dev
,
2269 static int sg_proc_seq_show_devstrs(struct seq_file
*s
, void *v
);
2270 static int sg_proc_open_devstrs(struct inode
*inode
, struct file
*file
);
2271 static const struct file_operations devstrs_fops
= {
2272 .owner
= THIS_MODULE
,
2273 .open
= sg_proc_open_devstrs
,
2275 .llseek
= seq_lseek
,
2276 .release
= seq_release
,
2278 static const struct seq_operations devstrs_seq_ops
= {
2279 .start
= dev_seq_start
,
2280 .next
= dev_seq_next
,
2281 .stop
= dev_seq_stop
,
2282 .show
= sg_proc_seq_show_devstrs
,
2285 static int sg_proc_seq_show_debug(struct seq_file
*s
, void *v
);
2286 static int sg_proc_open_debug(struct inode
*inode
, struct file
*file
);
2287 static const struct file_operations debug_fops
= {
2288 .owner
= THIS_MODULE
,
2289 .open
= sg_proc_open_debug
,
2291 .llseek
= seq_lseek
,
2292 .release
= seq_release
,
2294 static const struct seq_operations debug_seq_ops
= {
2295 .start
= dev_seq_start
,
2296 .next
= dev_seq_next
,
2297 .stop
= dev_seq_stop
,
2298 .show
= sg_proc_seq_show_debug
,
2302 struct sg_proc_leaf
{
2304 const struct file_operations
* fops
;
2307 static struct sg_proc_leaf sg_proc_leaf_arr
[] = {
2308 {"allow_dio", &adio_fops
},
2309 {"debug", &debug_fops
},
2310 {"def_reserved_size", &dressz_fops
},
2311 {"device_hdr", &devhdr_fops
},
2312 {"devices", &dev_fops
},
2313 {"device_strs", &devstrs_fops
},
2314 {"version", &version_fops
}
2321 int num_leaves
= ARRAY_SIZE(sg_proc_leaf_arr
);
2322 struct sg_proc_leaf
* leaf
;
2324 sg_proc_sgp
= proc_mkdir(sg_proc_sg_dirname
, NULL
);
2327 for (k
= 0; k
< num_leaves
; ++k
) {
2328 leaf
= &sg_proc_leaf_arr
[k
];
2329 mask
= leaf
->fops
->write
? S_IRUGO
| S_IWUSR
: S_IRUGO
;
2330 proc_create(leaf
->name
, mask
, sg_proc_sgp
, leaf
->fops
);
2336 sg_proc_cleanup(void)
2339 int num_leaves
= ARRAY_SIZE(sg_proc_leaf_arr
);
2343 for (k
= 0; k
< num_leaves
; ++k
)
2344 remove_proc_entry(sg_proc_leaf_arr
[k
].name
, sg_proc_sgp
);
2345 remove_proc_entry(sg_proc_sg_dirname
, NULL
);
2349 static int sg_proc_seq_show_int(struct seq_file
*s
, void *v
)
2351 seq_printf(s
, "%d\n", *((int *)s
->private));
2355 static int sg_proc_single_open_adio(struct inode
*inode
, struct file
*file
)
2357 return single_open(file
, sg_proc_seq_show_int
, &sg_allow_dio
);
2361 sg_proc_write_adio(struct file
*filp
, const char __user
*buffer
,
2362 size_t count
, loff_t
*off
)
2367 if (!capable(CAP_SYS_ADMIN
) || !capable(CAP_SYS_RAWIO
))
2369 num
= (count
< 10) ? count
: 10;
2370 if (copy_from_user(buff
, buffer
, num
))
2373 sg_allow_dio
= simple_strtoul(buff
, NULL
, 10) ? 1 : 0;
2377 static int sg_proc_single_open_dressz(struct inode
*inode
, struct file
*file
)
2379 return single_open(file
, sg_proc_seq_show_int
, &sg_big_buff
);
2383 sg_proc_write_dressz(struct file
*filp
, const char __user
*buffer
,
2384 size_t count
, loff_t
*off
)
2387 unsigned long k
= ULONG_MAX
;
2390 if (!capable(CAP_SYS_ADMIN
) || !capable(CAP_SYS_RAWIO
))
2392 num
= (count
< 10) ? count
: 10;
2393 if (copy_from_user(buff
, buffer
, num
))
2396 k
= simple_strtoul(buff
, NULL
, 10);
2397 if (k
<= 1048576) { /* limit "big buff" to 1 MB */
2404 static int sg_proc_seq_show_version(struct seq_file
*s
, void *v
)
2406 seq_printf(s
, "%d\t%s [%s]\n", sg_version_num
, SG_VERSION_STR
,
2411 static int sg_proc_single_open_version(struct inode
*inode
, struct file
*file
)
2413 return single_open(file
, sg_proc_seq_show_version
, NULL
);
2416 static int sg_proc_seq_show_devhdr(struct seq_file
*s
, void *v
)
2418 seq_printf(s
, "host\tchan\tid\tlun\ttype\topens\tqdepth\tbusy\t"
2423 static int sg_proc_single_open_devhdr(struct inode
*inode
, struct file
*file
)
2425 return single_open(file
, sg_proc_seq_show_devhdr
, NULL
);
2428 struct sg_proc_deviter
{
2433 static void * dev_seq_start(struct seq_file
*s
, loff_t
*pos
)
2435 struct sg_proc_deviter
* it
= kmalloc(sizeof(*it
), GFP_KERNEL
);
2442 it
->max
= sg_last_dev();
2443 if (it
->index
>= it
->max
)
2448 static void * dev_seq_next(struct seq_file
*s
, void *v
, loff_t
*pos
)
2450 struct sg_proc_deviter
* it
= s
->private;
2453 return (it
->index
< it
->max
) ? it
: NULL
;
2456 static void dev_seq_stop(struct seq_file
*s
, void *v
)
2461 static int sg_proc_open_dev(struct inode
*inode
, struct file
*file
)
2463 return seq_open(file
, &dev_seq_ops
);
2466 static int sg_proc_seq_show_dev(struct seq_file
*s
, void *v
)
2468 struct sg_proc_deviter
* it
= (struct sg_proc_deviter
*) v
;
2470 struct scsi_device
*scsidp
;
2471 unsigned long iflags
;
2473 read_lock_irqsave(&sg_index_lock
, iflags
);
2474 sdp
= it
? sg_lookup_dev(it
->index
) : NULL
;
2475 if (sdp
&& (scsidp
= sdp
->device
) && (!sdp
->detached
))
2476 seq_printf(s
, "%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\n",
2477 scsidp
->host
->host_no
, scsidp
->channel
,
2478 scsidp
->id
, scsidp
->lun
, (int) scsidp
->type
,
2480 (int) scsidp
->queue_depth
,
2481 (int) scsidp
->device_busy
,
2482 (int) scsi_device_online(scsidp
));
2484 seq_printf(s
, "-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\n");
2485 read_unlock_irqrestore(&sg_index_lock
, iflags
);
2489 static int sg_proc_open_devstrs(struct inode
*inode
, struct file
*file
)
2491 return seq_open(file
, &devstrs_seq_ops
);
2494 static int sg_proc_seq_show_devstrs(struct seq_file
*s
, void *v
)
2496 struct sg_proc_deviter
* it
= (struct sg_proc_deviter
*) v
;
2498 struct scsi_device
*scsidp
;
2499 unsigned long iflags
;
2501 read_lock_irqsave(&sg_index_lock
, iflags
);
2502 sdp
= it
? sg_lookup_dev(it
->index
) : NULL
;
2503 if (sdp
&& (scsidp
= sdp
->device
) && (!sdp
->detached
))
2504 seq_printf(s
, "%8.8s\t%16.16s\t%4.4s\n",
2505 scsidp
->vendor
, scsidp
->model
, scsidp
->rev
);
2507 seq_printf(s
, "<no active device>\n");
2508 read_unlock_irqrestore(&sg_index_lock
, iflags
);
2512 /* must be called while holding sg_index_lock */
2513 static void sg_proc_debug_helper(struct seq_file
*s
, Sg_device
* sdp
)
2515 int k
, m
, new_interface
, blen
, usg
;
2518 const sg_io_hdr_t
*hp
;
2523 list_for_each_entry(fp
, &sdp
->sfds
, sfd_siblings
) {
2525 read_lock(&fp
->rq_list_lock
); /* irqs already disabled */
2526 seq_printf(s
, " FD(%d): timeout=%dms bufflen=%d "
2527 "(res)sgat=%d low_dma=%d\n", k
,
2528 jiffies_to_msecs(fp
->timeout
),
2529 fp
->reserve
.bufflen
,
2530 (int) fp
->reserve
.k_use_sg
,
2532 seq_printf(s
, " cmd_q=%d f_packid=%d k_orphan=%d closed=%d\n",
2533 (int) fp
->cmd_q
, (int) fp
->force_packid
,
2534 (int) fp
->keep_orphan
, (int) fp
->closed
);
2535 for (m
= 0, srp
= fp
->headrp
;
2537 ++m
, srp
= srp
->nextrp
) {
2539 new_interface
= (hp
->interface_id
== '\0') ? 0 : 1;
2540 if (srp
->res_used
) {
2541 if (new_interface
&&
2542 (SG_FLAG_MMAP_IO
& hp
->flags
))
2547 if (SG_INFO_DIRECT_IO_MASK
& hp
->info
)
2553 blen
= srp
->data
.bufflen
;
2554 usg
= srp
->data
.k_use_sg
;
2555 seq_printf(s
, srp
->done
?
2556 ((1 == srp
->done
) ? "rcv:" : "fin:")
2558 seq_printf(s
, " id=%d blen=%d",
2559 srp
->header
.pack_id
, blen
);
2561 seq_printf(s
, " dur=%d", hp
->duration
);
2563 ms
= jiffies_to_msecs(jiffies
);
2564 seq_printf(s
, " t_o/elap=%d/%d",
2565 (new_interface
? hp
->timeout
:
2566 jiffies_to_msecs(fp
->timeout
)),
2567 (ms
> hp
->duration
? ms
- hp
->duration
: 0));
2569 seq_printf(s
, "ms sgat=%d op=0x%02x\n", usg
,
2570 (int) srp
->data
.cmd_opcode
);
2573 seq_printf(s
, " No requests active\n");
2574 read_unlock(&fp
->rq_list_lock
);
2578 static int sg_proc_open_debug(struct inode
*inode
, struct file
*file
)
2580 return seq_open(file
, &debug_seq_ops
);
2583 static int sg_proc_seq_show_debug(struct seq_file
*s
, void *v
)
2585 struct sg_proc_deviter
* it
= (struct sg_proc_deviter
*) v
;
2587 unsigned long iflags
;
2589 if (it
&& (0 == it
->index
)) {
2590 seq_printf(s
, "max_active_device=%d(origin 1)\n",
2592 seq_printf(s
, " def_reserved_size=%d\n", sg_big_buff
);
2595 read_lock_irqsave(&sg_index_lock
, iflags
);
2596 sdp
= it
? sg_lookup_dev(it
->index
) : NULL
;
2597 if (sdp
&& !list_empty(&sdp
->sfds
)) {
2598 struct scsi_device
*scsidp
= sdp
->device
;
2600 seq_printf(s
, " >>> device=%s ", sdp
->disk
->disk_name
);
2602 seq_printf(s
, "detached pending close ");
2605 (s
, "scsi%d chan=%d id=%d lun=%d em=%d",
2606 scsidp
->host
->host_no
,
2607 scsidp
->channel
, scsidp
->id
,
2609 scsidp
->host
->hostt
->emulated
);
2610 seq_printf(s
, " sg_tablesize=%d excl=%d\n",
2611 sdp
->sg_tablesize
, sdp
->exclude
);
2612 sg_proc_debug_helper(s
, sdp
);
2614 read_unlock_irqrestore(&sg_index_lock
, iflags
);
2618 #endif /* CONFIG_SCSI_PROC_FS */
2620 module_init(init_sg
);
2621 module_exit(exit_sg
);