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/mutex.h>
53 #include <linux/ratelimit.h>
56 #include <scsi/scsi_dbg.h>
57 #include <scsi/scsi_host.h>
58 #include <scsi/scsi_driver.h>
59 #include <scsi/scsi_ioctl.h>
62 #include "scsi_logging.h"
64 #ifdef CONFIG_SCSI_PROC_FS
65 #include <linux/proc_fs.h>
66 static char *sg_version_date
= "20061027";
68 static int sg_proc_init(void);
69 static void sg_proc_cleanup(void);
72 #define SG_ALLOW_DIO_DEF 0
74 #define SG_MAX_DEVS 32768
77 * Suppose you want to calculate the formula muldiv(x,m,d)=int(x * m / d)
78 * Then when using 32 bit integers x * m may overflow during the calculation.
79 * Replacing muldiv(x) by muldiv(x)=((x % d) * m) / d + int(x / d) * m
80 * calculates the same, but prevents the overflow when both m and d
81 * are "small" numbers (like HZ and USER_HZ).
82 * Of course an overflow is inavoidable if the result of muldiv doesn't fit
85 #define MULDIV(X,MUL,DIV) ((((X % DIV) * MUL) / DIV) + ((X / DIV) * MUL))
87 #define SG_DEFAULT_TIMEOUT MULDIV(SG_DEFAULT_TIMEOUT_USER, HZ, USER_HZ)
89 int sg_big_buff
= SG_DEF_RESERVED_SIZE
;
90 /* N.B. This variable is readable and writeable via
91 /proc/scsi/sg/def_reserved_size . Each time sg_open() is called a buffer
92 of this size (or less if there is not enough memory) will be reserved
93 for use by this file descriptor. [Deprecated usage: this variable is also
94 readable via /proc/sys/kernel/sg-big-buff if the sg driver is built into
95 the kernel (i.e. it is not a module).] */
96 static int def_reserved_size
= -1; /* picks up init parameter */
97 static int sg_allow_dio
= SG_ALLOW_DIO_DEF
;
99 static int scatter_elem_sz
= SG_SCATTER_SZ
;
100 static int scatter_elem_sz_prev
= SG_SCATTER_SZ
;
102 #define SG_SECTOR_SZ 512
104 static int sg_add(struct device
*, struct class_interface
*);
105 static void sg_remove(struct device
*, struct class_interface
*);
107 static DEFINE_SPINLOCK(sg_open_exclusive_lock
);
109 static DEFINE_IDR(sg_index_idr
);
110 static DEFINE_RWLOCK(sg_index_lock
); /* Also used to lock
111 file descriptor list for device */
113 static struct class_interface sg_interface
= {
115 .remove_dev
= sg_remove
,
118 typedef struct sg_scatter_hold
{ /* holding area for scsi scatter gather info */
119 unsigned short k_use_sg
; /* Count of kernel scatter-gather pieces */
120 unsigned sglist_len
; /* size of malloc'd scatter-gather list ++ */
121 unsigned bufflen
; /* Size of (aggregate) data buffer */
124 char dio_in_use
; /* 0->indirect IO (or mmap), 1->dio */
125 unsigned char cmd_opcode
; /* first byte of command */
128 struct sg_device
; /* forward declarations */
131 typedef struct sg_request
{ /* SG_MAX_QUEUE requests outstanding per file */
132 struct sg_request
*nextrp
; /* NULL -> tail request (slist) */
133 struct sg_fd
*parentfp
; /* NULL -> not in use */
134 Sg_scatter_hold data
; /* hold buffer, perhaps scatter list */
135 sg_io_hdr_t header
; /* scsi command+info, see <scsi/sg.h> */
136 unsigned char sense_b
[SCSI_SENSE_BUFFERSIZE
];
137 char res_used
; /* 1 -> using reserve buffer, 0 -> not ... */
138 char orphan
; /* 1 -> drop on sight, 0 -> normal */
139 char sg_io_owned
; /* 1 -> packet belongs to SG_IO */
140 /* done protected by rq_list_lock */
141 char done
; /* 0->before bh, 1->before read, 2->read */
144 struct execute_work ew
;
147 typedef struct sg_fd
{ /* holds the state of a file descriptor */
148 /* sfd_siblings is protected by sg_index_lock */
149 struct list_head sfd_siblings
;
150 struct sg_device
*parentdp
; /* owning device */
151 wait_queue_head_t read_wait
; /* queue read until command done */
152 rwlock_t rq_list_lock
; /* protect access to list in req_arr */
153 int timeout
; /* defaults to SG_DEFAULT_TIMEOUT */
154 int timeout_user
; /* defaults to SG_DEFAULT_TIMEOUT_USER */
155 Sg_scatter_hold reserve
; /* buffer held for this file descriptor */
156 unsigned save_scat_len
; /* original length of trunc. scat. element */
157 Sg_request
*headrp
; /* head of request slist, NULL->empty */
158 struct fasync_struct
*async_qp
; /* used by asynchronous notification */
159 Sg_request req_arr
[SG_MAX_QUEUE
]; /* used as singly-linked list */
160 char low_dma
; /* as in parent but possibly overridden to 1 */
161 char force_packid
; /* 1 -> pack_id input to read(), 0 -> ignored */
162 char cmd_q
; /* 1 -> allow command queuing, 0 -> don't */
163 char next_cmd_len
; /* 0 -> automatic (def), >0 -> use on next write() */
164 char keep_orphan
; /* 0 -> drop orphan (def), 1 -> keep for read() */
165 char mmap_called
; /* 0 -> mmap() never called on this fd */
167 struct execute_work ew
;
170 typedef struct sg_device
{ /* holds the state of each scsi generic device */
171 struct scsi_device
*device
;
172 wait_queue_head_t o_excl_wait
; /* queue open() when O_EXCL in use */
173 int sg_tablesize
; /* adapter's max scatter-gather table size */
174 u32 index
; /* device index number */
175 /* sfds is protected by sg_index_lock */
176 struct list_head sfds
;
177 volatile char detached
; /* 0->attached, 1->detached pending removal */
178 /* exclude protected by sg_open_exclusive_lock */
179 char exclude
; /* opened for exclusive access */
180 char sgdebug
; /* 0->off, 1->sense, 9->dump dev, 10-> all devs */
181 struct gendisk
*disk
;
182 struct cdev
* cdev
; /* char_dev [sysfs: /sys/cdev/major/sg<n>] */
186 /* tasklet or soft irq callback */
187 static void sg_rq_end_io(struct request
*rq
, int uptodate
);
188 static int sg_start_req(Sg_request
*srp
, unsigned char *cmd
);
189 static int sg_finish_rem_req(Sg_request
* srp
);
190 static int sg_build_indirect(Sg_scatter_hold
* schp
, Sg_fd
* sfp
, int buff_size
);
191 static ssize_t
sg_new_read(Sg_fd
* sfp
, char __user
*buf
, size_t count
,
193 static ssize_t
sg_new_write(Sg_fd
*sfp
, struct file
*file
,
194 const char __user
*buf
, size_t count
, int blocking
,
195 int read_only
, int sg_io_owned
, Sg_request
**o_srp
);
196 static int sg_common_write(Sg_fd
* sfp
, Sg_request
* srp
,
197 unsigned char *cmnd
, int timeout
, int blocking
);
198 static int sg_read_oxfer(Sg_request
* srp
, char __user
*outp
, int num_read_xfer
);
199 static void sg_remove_scat(Sg_scatter_hold
* schp
);
200 static void sg_build_reserve(Sg_fd
* sfp
, int req_size
);
201 static void sg_link_reserve(Sg_fd
* sfp
, Sg_request
* srp
, int size
);
202 static void sg_unlink_reserve(Sg_fd
* sfp
, Sg_request
* srp
);
203 static Sg_fd
*sg_add_sfp(Sg_device
* sdp
, int dev
);
204 static void sg_remove_sfp(struct kref
*);
205 static Sg_request
*sg_get_rq_mark(Sg_fd
* sfp
, int pack_id
);
206 static Sg_request
*sg_add_request(Sg_fd
* sfp
);
207 static int sg_remove_request(Sg_fd
* sfp
, Sg_request
* srp
);
208 static int sg_res_in_use(Sg_fd
* sfp
);
209 static Sg_device
*sg_get_dev(int dev
);
210 static void sg_put_dev(Sg_device
*sdp
);
212 #define SZ_SG_HEADER sizeof(struct sg_header)
213 #define SZ_SG_IO_HDR sizeof(sg_io_hdr_t)
214 #define SZ_SG_IOVEC sizeof(sg_iovec_t)
215 #define SZ_SG_REQ_INFO sizeof(sg_req_info_t)
217 static int sg_allow_access(struct file
*filp
, unsigned char *cmd
)
219 struct sg_fd
*sfp
= filp
->private_data
;
221 if (sfp
->parentdp
->device
->type
== TYPE_SCANNER
)
224 return blk_verify_command(cmd
, filp
->f_mode
& FMODE_WRITE
);
227 static int get_exclude(Sg_device
*sdp
)
232 spin_lock_irqsave(&sg_open_exclusive_lock
, flags
);
234 spin_unlock_irqrestore(&sg_open_exclusive_lock
, flags
);
238 static int set_exclude(Sg_device
*sdp
, char val
)
242 spin_lock_irqsave(&sg_open_exclusive_lock
, flags
);
244 spin_unlock_irqrestore(&sg_open_exclusive_lock
, flags
);
248 static int sfds_list_empty(Sg_device
*sdp
)
253 read_lock_irqsave(&sg_index_lock
, flags
);
254 ret
= list_empty(&sdp
->sfds
);
255 read_unlock_irqrestore(&sg_index_lock
, flags
);
260 sg_open(struct inode
*inode
, struct file
*filp
)
262 int dev
= iminor(inode
);
263 int flags
= filp
->f_flags
;
264 struct request_queue
*q
;
270 nonseekable_open(inode
, filp
);
271 SCSI_LOG_TIMEOUT(3, printk("sg_open: dev=%d, flags=0x%x\n", dev
, flags
));
272 sdp
= sg_get_dev(dev
);
274 retval
= PTR_ERR(sdp
);
279 /* This driver's module count bumped by fops_get in <linux/fs.h> */
280 /* Prevent the device driver from vanishing while we sleep */
281 retval
= scsi_device_get(sdp
->device
);
285 retval
= scsi_autopm_get_device(sdp
->device
);
289 if (!((flags
& O_NONBLOCK
) ||
290 scsi_block_when_processing_errors(sdp
->device
))) {
292 /* we are in error recovery for this device */
296 if (flags
& O_EXCL
) {
297 if (O_RDONLY
== (flags
& O_ACCMODE
)) {
298 retval
= -EPERM
; /* Can't lock it with read only access */
301 if (!sfds_list_empty(sdp
) && (flags
& O_NONBLOCK
)) {
305 res
= wait_event_interruptible(sdp
->o_excl_wait
,
306 ((!sfds_list_empty(sdp
) || get_exclude(sdp
)) ? 0 : set_exclude(sdp
, 1)));
308 retval
= res
; /* -ERESTARTSYS because signal hit process */
311 } else if (get_exclude(sdp
)) { /* some other fd has an exclusive lock on dev */
312 if (flags
& O_NONBLOCK
) {
316 res
= wait_event_interruptible(sdp
->o_excl_wait
, !get_exclude(sdp
));
318 retval
= res
; /* -ERESTARTSYS because signal hit process */
326 if (sfds_list_empty(sdp
)) { /* no existing opens on this device */
328 q
= sdp
->device
->request_queue
;
329 sdp
->sg_tablesize
= queue_max_segments(q
);
331 if ((sfp
= sg_add_sfp(sdp
, dev
)))
332 filp
->private_data
= sfp
;
334 if (flags
& O_EXCL
) {
335 set_exclude(sdp
, 0); /* undo if error */
336 wake_up_interruptible(&sdp
->o_excl_wait
);
344 scsi_autopm_put_device(sdp
->device
);
346 scsi_device_put(sdp
->device
);
354 /* Following function was formerly called 'sg_close' */
356 sg_release(struct inode
*inode
, struct file
*filp
)
361 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
363 SCSI_LOG_TIMEOUT(3, printk("sg_release: %s\n", sdp
->disk
->disk_name
));
366 wake_up_interruptible(&sdp
->o_excl_wait
);
368 scsi_autopm_put_device(sdp
->device
);
369 kref_put(&sfp
->f_ref
, sg_remove_sfp
);
374 sg_read(struct file
*filp
, char __user
*buf
, size_t count
, loff_t
* ppos
)
379 int req_pack_id
= -1;
381 struct sg_header
*old_hdr
= NULL
;
384 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
386 SCSI_LOG_TIMEOUT(3, printk("sg_read: %s, count=%d\n",
387 sdp
->disk
->disk_name
, (int) count
));
389 if (!access_ok(VERIFY_WRITE
, buf
, count
))
391 if (sfp
->force_packid
&& (count
>= SZ_SG_HEADER
)) {
392 old_hdr
= kmalloc(SZ_SG_HEADER
, GFP_KERNEL
);
395 if (__copy_from_user(old_hdr
, buf
, SZ_SG_HEADER
)) {
399 if (old_hdr
->reply_len
< 0) {
400 if (count
>= SZ_SG_IO_HDR
) {
401 sg_io_hdr_t
*new_hdr
;
402 new_hdr
= kmalloc(SZ_SG_IO_HDR
, GFP_KERNEL
);
407 retval
=__copy_from_user
408 (new_hdr
, buf
, SZ_SG_IO_HDR
);
409 req_pack_id
= new_hdr
->pack_id
;
417 req_pack_id
= old_hdr
->pack_id
;
419 srp
= sg_get_rq_mark(sfp
, req_pack_id
);
420 if (!srp
) { /* now wait on packet to arrive */
425 if (filp
->f_flags
& O_NONBLOCK
) {
429 retval
= wait_event_interruptible(sfp
->read_wait
,
431 (srp
= sg_get_rq_mark(sfp
, req_pack_id
))));
437 /* -ERESTARTSYS as signal hit process */
441 if (srp
->header
.interface_id
!= '\0') {
442 retval
= sg_new_read(sfp
, buf
, count
, srp
);
447 if (old_hdr
== NULL
) {
448 old_hdr
= kmalloc(SZ_SG_HEADER
, GFP_KERNEL
);
454 memset(old_hdr
, 0, SZ_SG_HEADER
);
455 old_hdr
->reply_len
= (int) hp
->timeout
;
456 old_hdr
->pack_len
= old_hdr
->reply_len
; /* old, strange behaviour */
457 old_hdr
->pack_id
= hp
->pack_id
;
458 old_hdr
->twelve_byte
=
459 ((srp
->data
.cmd_opcode
>= 0xc0) && (12 == hp
->cmd_len
)) ? 1 : 0;
460 old_hdr
->target_status
= hp
->masked_status
;
461 old_hdr
->host_status
= hp
->host_status
;
462 old_hdr
->driver_status
= hp
->driver_status
;
463 if ((CHECK_CONDITION
& hp
->masked_status
) ||
464 (DRIVER_SENSE
& hp
->driver_status
))
465 memcpy(old_hdr
->sense_buffer
, srp
->sense_b
,
466 sizeof (old_hdr
->sense_buffer
));
467 switch (hp
->host_status
) {
468 /* This setup of 'result' is for backward compatibility and is best
469 ignored by the user who should use target, host + driver status */
471 case DID_PASSTHROUGH
:
478 old_hdr
->result
= EBUSY
;
485 old_hdr
->result
= EIO
;
488 old_hdr
->result
= (srp
->sense_b
[0] == 0 &&
489 hp
->masked_status
== GOOD
) ? 0 : EIO
;
492 old_hdr
->result
= EIO
;
496 /* Now copy the result back to the user buffer. */
497 if (count
>= SZ_SG_HEADER
) {
498 if (__copy_to_user(buf
, old_hdr
, SZ_SG_HEADER
)) {
503 if (count
> old_hdr
->reply_len
)
504 count
= old_hdr
->reply_len
;
505 if (count
> SZ_SG_HEADER
) {
506 if (sg_read_oxfer(srp
, buf
, count
- SZ_SG_HEADER
)) {
512 count
= (old_hdr
->result
== 0) ? 0 : -EIO
;
513 sg_finish_rem_req(srp
);
521 sg_new_read(Sg_fd
* sfp
, char __user
*buf
, size_t count
, Sg_request
* srp
)
523 sg_io_hdr_t
*hp
= &srp
->header
;
527 if (count
< SZ_SG_IO_HDR
) {
532 if ((hp
->mx_sb_len
> 0) && hp
->sbp
) {
533 if ((CHECK_CONDITION
& hp
->masked_status
) ||
534 (DRIVER_SENSE
& hp
->driver_status
)) {
535 int sb_len
= SCSI_SENSE_BUFFERSIZE
;
536 sb_len
= (hp
->mx_sb_len
> sb_len
) ? sb_len
: hp
->mx_sb_len
;
537 len
= 8 + (int) srp
->sense_b
[7]; /* Additional sense length field */
538 len
= (len
> sb_len
) ? sb_len
: len
;
539 if (copy_to_user(hp
->sbp
, srp
->sense_b
, len
)) {
546 if (hp
->masked_status
|| hp
->host_status
|| hp
->driver_status
)
547 hp
->info
|= SG_INFO_CHECK
;
548 if (copy_to_user(buf
, hp
, SZ_SG_IO_HDR
)) {
553 err
= sg_finish_rem_req(srp
);
554 return (0 == err
) ? count
: err
;
558 sg_write(struct file
*filp
, const char __user
*buf
, size_t count
, loff_t
* ppos
)
560 int mxsize
, cmd_size
, k
;
561 int input_size
, blocking
;
562 unsigned char opcode
;
566 struct sg_header old_hdr
;
568 unsigned char cmnd
[MAX_COMMAND_SIZE
];
570 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
572 SCSI_LOG_TIMEOUT(3, printk("sg_write: %s, count=%d\n",
573 sdp
->disk
->disk_name
, (int) count
));
576 if (!((filp
->f_flags
& O_NONBLOCK
) ||
577 scsi_block_when_processing_errors(sdp
->device
)))
580 if (!access_ok(VERIFY_READ
, buf
, count
))
581 return -EFAULT
; /* protects following copy_from_user()s + get_user()s */
582 if (count
< SZ_SG_HEADER
)
584 if (__copy_from_user(&old_hdr
, buf
, SZ_SG_HEADER
))
586 blocking
= !(filp
->f_flags
& O_NONBLOCK
);
587 if (old_hdr
.reply_len
< 0)
588 return sg_new_write(sfp
, filp
, buf
, count
,
589 blocking
, 0, 0, NULL
);
590 if (count
< (SZ_SG_HEADER
+ 6))
591 return -EIO
; /* The minimum scsi command length is 6 bytes. */
593 if (!(srp
= sg_add_request(sfp
))) {
594 SCSI_LOG_TIMEOUT(1, printk("sg_write: queue full\n"));
598 __get_user(opcode
, buf
);
599 if (sfp
->next_cmd_len
> 0) {
600 if (sfp
->next_cmd_len
> MAX_COMMAND_SIZE
) {
601 SCSI_LOG_TIMEOUT(1, printk("sg_write: command length too long\n"));
602 sfp
->next_cmd_len
= 0;
603 sg_remove_request(sfp
, srp
);
606 cmd_size
= sfp
->next_cmd_len
;
607 sfp
->next_cmd_len
= 0; /* reset so only this write() effected */
609 cmd_size
= COMMAND_SIZE(opcode
); /* based on SCSI command group */
610 if ((opcode
>= 0xc0) && old_hdr
.twelve_byte
)
613 SCSI_LOG_TIMEOUT(4, printk(
614 "sg_write: scsi opcode=0x%02x, cmd_size=%d\n", (int) opcode
, cmd_size
));
615 /* Determine buffer size. */
616 input_size
= count
- cmd_size
;
617 mxsize
= (input_size
> old_hdr
.reply_len
) ? input_size
: old_hdr
.reply_len
;
618 mxsize
-= SZ_SG_HEADER
;
619 input_size
-= SZ_SG_HEADER
;
620 if (input_size
< 0) {
621 sg_remove_request(sfp
, srp
);
622 return -EIO
; /* User did not pass enough bytes for this command. */
625 hp
->interface_id
= '\0'; /* indicator of old interface tunnelled */
626 hp
->cmd_len
= (unsigned char) cmd_size
;
630 hp
->dxfer_direction
= (old_hdr
.reply_len
> SZ_SG_HEADER
) ?
631 SG_DXFER_TO_FROM_DEV
: SG_DXFER_TO_DEV
;
633 hp
->dxfer_direction
= (mxsize
> 0) ? SG_DXFER_FROM_DEV
: SG_DXFER_NONE
;
634 hp
->dxfer_len
= mxsize
;
635 if (hp
->dxfer_direction
== SG_DXFER_TO_DEV
)
636 hp
->dxferp
= (char __user
*)buf
+ cmd_size
;
640 hp
->timeout
= old_hdr
.reply_len
; /* structure abuse ... */
641 hp
->flags
= input_size
; /* structure abuse ... */
642 hp
->pack_id
= old_hdr
.pack_id
;
644 if (__copy_from_user(cmnd
, buf
, cmd_size
))
647 * SG_DXFER_TO_FROM_DEV is functionally equivalent to SG_DXFER_FROM_DEV,
648 * but is is possible that the app intended SG_DXFER_TO_DEV, because there
649 * is a non-zero input_size, so emit a warning.
651 if (hp
->dxfer_direction
== SG_DXFER_TO_FROM_DEV
) {
652 static char cmd
[TASK_COMM_LEN
];
653 if (strcmp(current
->comm
, cmd
)) {
654 printk_ratelimited(KERN_WARNING
655 "sg_write: data in/out %d/%d bytes "
656 "for SCSI command 0x%x-- guessing "
657 "data in;\n program %s not setting "
658 "count and/or reply_len properly\n",
659 old_hdr
.reply_len
- (int)SZ_SG_HEADER
,
660 input_size
, (unsigned int) cmnd
[0],
662 strcpy(cmd
, current
->comm
);
665 k
= sg_common_write(sfp
, srp
, cmnd
, sfp
->timeout
, blocking
);
666 return (k
< 0) ? k
: count
;
670 sg_new_write(Sg_fd
*sfp
, struct file
*file
, const char __user
*buf
,
671 size_t count
, int blocking
, int read_only
, int sg_io_owned
,
677 unsigned char cmnd
[MAX_COMMAND_SIZE
];
679 unsigned long ul_timeout
;
681 if (count
< SZ_SG_IO_HDR
)
683 if (!access_ok(VERIFY_READ
, buf
, count
))
684 return -EFAULT
; /* protects following copy_from_user()s + get_user()s */
686 sfp
->cmd_q
= 1; /* when sg_io_hdr seen, set command queuing on */
687 if (!(srp
= sg_add_request(sfp
))) {
688 SCSI_LOG_TIMEOUT(1, printk("sg_new_write: queue full\n"));
691 srp
->sg_io_owned
= sg_io_owned
;
693 if (__copy_from_user(hp
, buf
, SZ_SG_IO_HDR
)) {
694 sg_remove_request(sfp
, srp
);
697 if (hp
->interface_id
!= 'S') {
698 sg_remove_request(sfp
, srp
);
701 if (hp
->flags
& SG_FLAG_MMAP_IO
) {
702 if (hp
->dxfer_len
> sfp
->reserve
.bufflen
) {
703 sg_remove_request(sfp
, srp
);
704 return -ENOMEM
; /* MMAP_IO size must fit in reserve buffer */
706 if (hp
->flags
& SG_FLAG_DIRECT_IO
) {
707 sg_remove_request(sfp
, srp
);
708 return -EINVAL
; /* either MMAP_IO or DIRECT_IO (not both) */
710 if (sg_res_in_use(sfp
)) {
711 sg_remove_request(sfp
, srp
);
712 return -EBUSY
; /* reserve buffer already being used */
715 ul_timeout
= msecs_to_jiffies(srp
->header
.timeout
);
716 timeout
= (ul_timeout
< INT_MAX
) ? ul_timeout
: INT_MAX
;
717 if ((!hp
->cmdp
) || (hp
->cmd_len
< 6) || (hp
->cmd_len
> sizeof (cmnd
))) {
718 sg_remove_request(sfp
, srp
);
721 if (!access_ok(VERIFY_READ
, hp
->cmdp
, hp
->cmd_len
)) {
722 sg_remove_request(sfp
, srp
);
723 return -EFAULT
; /* protects following copy_from_user()s + get_user()s */
725 if (__copy_from_user(cmnd
, hp
->cmdp
, hp
->cmd_len
)) {
726 sg_remove_request(sfp
, srp
);
729 if (read_only
&& sg_allow_access(file
, cmnd
)) {
730 sg_remove_request(sfp
, srp
);
733 k
= sg_common_write(sfp
, srp
, cmnd
, timeout
, blocking
);
742 sg_common_write(Sg_fd
* sfp
, Sg_request
* srp
,
743 unsigned char *cmnd
, int timeout
, int blocking
)
746 Sg_device
*sdp
= sfp
->parentdp
;
747 sg_io_hdr_t
*hp
= &srp
->header
;
749 srp
->data
.cmd_opcode
= cmnd
[0]; /* hold opcode of command */
751 hp
->masked_status
= 0;
755 hp
->driver_status
= 0;
757 SCSI_LOG_TIMEOUT(4, printk("sg_common_write: scsi opcode=0x%02x, cmd_size=%d\n",
758 (int) cmnd
[0], (int) hp
->cmd_len
));
760 k
= sg_start_req(srp
, cmnd
);
762 SCSI_LOG_TIMEOUT(1, printk("sg_common_write: start_req err=%d\n", k
));
763 sg_finish_rem_req(srp
);
764 return k
; /* probably out of space --> ENOMEM */
768 blk_end_request_all(srp
->rq
, -EIO
);
769 sg_finish_rem_req(srp
);
773 switch (hp
->dxfer_direction
) {
774 case SG_DXFER_TO_FROM_DEV
:
775 case SG_DXFER_FROM_DEV
:
776 data_dir
= DMA_FROM_DEVICE
;
778 case SG_DXFER_TO_DEV
:
779 data_dir
= DMA_TO_DEVICE
;
781 case SG_DXFER_UNKNOWN
:
782 data_dir
= DMA_BIDIRECTIONAL
;
788 hp
->duration
= jiffies_to_msecs(jiffies
);
790 srp
->rq
->timeout
= timeout
;
791 kref_get(&sfp
->f_ref
); /* sg_rq_end_io() does kref_put(). */
792 blk_execute_rq_nowait(sdp
->device
->request_queue
, sdp
->disk
,
793 srp
->rq
, 1, sg_rq_end_io
);
797 static int srp_done(Sg_fd
*sfp
, Sg_request
*srp
)
802 read_lock_irqsave(&sfp
->rq_list_lock
, flags
);
804 read_unlock_irqrestore(&sfp
->rq_list_lock
, flags
);
809 sg_ioctl(struct file
*filp
, unsigned int cmd_in
, unsigned long arg
)
811 void __user
*p
= (void __user
*)arg
;
813 int result
, val
, read_only
;
817 unsigned long iflags
;
819 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
822 SCSI_LOG_TIMEOUT(3, printk("sg_ioctl: %s, cmd=0x%x\n",
823 sdp
->disk
->disk_name
, (int) cmd_in
));
824 read_only
= (O_RDWR
!= (filp
->f_flags
& O_ACCMODE
));
830 if (!scsi_block_when_processing_errors(sdp
->device
))
832 if (!access_ok(VERIFY_WRITE
, p
, SZ_SG_IO_HDR
))
834 result
= sg_new_write(sfp
, filp
, p
, SZ_SG_IO_HDR
,
835 1, read_only
, 1, &srp
);
838 result
= wait_event_interruptible(sfp
->read_wait
,
839 (srp_done(sfp
, srp
) || sdp
->detached
));
842 write_lock_irq(&sfp
->rq_list_lock
);
845 write_unlock_irq(&sfp
->rq_list_lock
);
846 result
= sg_new_read(sfp
, p
, SZ_SG_IO_HDR
, srp
);
847 return (result
< 0) ? result
: 0;
850 write_unlock_irq(&sfp
->rq_list_lock
);
851 return result
; /* -ERESTARTSYS because signal hit process */
853 result
= get_user(val
, ip
);
858 if (val
>= MULDIV (INT_MAX
, USER_HZ
, HZ
))
859 val
= MULDIV (INT_MAX
, USER_HZ
, HZ
);
860 sfp
->timeout_user
= val
;
861 sfp
->timeout
= MULDIV (val
, HZ
, USER_HZ
);
864 case SG_GET_TIMEOUT
: /* N.B. User receives timeout as return value */
865 /* strange ..., for backward compatibility */
866 return sfp
->timeout_user
;
867 case SG_SET_FORCE_LOW_DMA
:
868 result
= get_user(val
, ip
);
873 if ((0 == sfp
->low_dma
) && (0 == sg_res_in_use(sfp
))) {
874 val
= (int) sfp
->reserve
.bufflen
;
875 sg_remove_scat(&sfp
->reserve
);
876 sg_build_reserve(sfp
, val
);
881 sfp
->low_dma
= sdp
->device
->host
->unchecked_isa_dma
;
885 return put_user((int) sfp
->low_dma
, ip
);
887 if (!access_ok(VERIFY_WRITE
, p
, sizeof (sg_scsi_id_t
)))
890 sg_scsi_id_t __user
*sg_idp
= p
;
894 __put_user((int) sdp
->device
->host
->host_no
,
896 __put_user((int) sdp
->device
->channel
,
898 __put_user((int) sdp
->device
->id
, &sg_idp
->scsi_id
);
899 __put_user((int) sdp
->device
->lun
, &sg_idp
->lun
);
900 __put_user((int) sdp
->device
->type
, &sg_idp
->scsi_type
);
901 __put_user((short) sdp
->device
->host
->cmd_per_lun
,
902 &sg_idp
->h_cmd_per_lun
);
903 __put_user((short) sdp
->device
->queue_depth
,
904 &sg_idp
->d_queue_depth
);
905 __put_user(0, &sg_idp
->unused
[0]);
906 __put_user(0, &sg_idp
->unused
[1]);
909 case SG_SET_FORCE_PACK_ID
:
910 result
= get_user(val
, ip
);
913 sfp
->force_packid
= val
? 1 : 0;
916 if (!access_ok(VERIFY_WRITE
, ip
, sizeof (int)))
918 read_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
919 for (srp
= sfp
->headrp
; srp
; srp
= srp
->nextrp
) {
920 if ((1 == srp
->done
) && (!srp
->sg_io_owned
)) {
921 read_unlock_irqrestore(&sfp
->rq_list_lock
,
923 __put_user(srp
->header
.pack_id
, ip
);
927 read_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
930 case SG_GET_NUM_WAITING
:
931 read_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
932 for (val
= 0, srp
= sfp
->headrp
; srp
; srp
= srp
->nextrp
) {
933 if ((1 == srp
->done
) && (!srp
->sg_io_owned
))
936 read_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
937 return put_user(val
, ip
);
938 case SG_GET_SG_TABLESIZE
:
939 return put_user(sdp
->sg_tablesize
, ip
);
940 case SG_SET_RESERVED_SIZE
:
941 result
= get_user(val
, ip
);
946 val
= min_t(int, val
,
947 queue_max_sectors(sdp
->device
->request_queue
) * 512);
948 if (val
!= sfp
->reserve
.bufflen
) {
949 if (sg_res_in_use(sfp
) || sfp
->mmap_called
)
951 sg_remove_scat(&sfp
->reserve
);
952 sg_build_reserve(sfp
, val
);
955 case SG_GET_RESERVED_SIZE
:
956 val
= min_t(int, sfp
->reserve
.bufflen
,
957 queue_max_sectors(sdp
->device
->request_queue
) * 512);
958 return put_user(val
, ip
);
959 case SG_SET_COMMAND_Q
:
960 result
= get_user(val
, ip
);
963 sfp
->cmd_q
= val
? 1 : 0;
965 case SG_GET_COMMAND_Q
:
966 return put_user((int) sfp
->cmd_q
, ip
);
967 case SG_SET_KEEP_ORPHAN
:
968 result
= get_user(val
, ip
);
971 sfp
->keep_orphan
= val
;
973 case SG_GET_KEEP_ORPHAN
:
974 return put_user((int) sfp
->keep_orphan
, ip
);
975 case SG_NEXT_CMD_LEN
:
976 result
= get_user(val
, ip
);
979 sfp
->next_cmd_len
= (val
> 0) ? val
: 0;
981 case SG_GET_VERSION_NUM
:
982 return put_user(sg_version_num
, ip
);
983 case SG_GET_ACCESS_COUNT
:
984 /* faked - we don't have a real access count anymore */
985 val
= (sdp
->device
? 1 : 0);
986 return put_user(val
, ip
);
987 case SG_GET_REQUEST_TABLE
:
988 if (!access_ok(VERIFY_WRITE
, p
, SZ_SG_REQ_INFO
* SG_MAX_QUEUE
))
991 sg_req_info_t
*rinfo
;
994 rinfo
= kmalloc(SZ_SG_REQ_INFO
* SG_MAX_QUEUE
,
998 read_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
999 for (srp
= sfp
->headrp
, val
= 0; val
< SG_MAX_QUEUE
;
1000 ++val
, srp
= srp
? srp
->nextrp
: srp
) {
1001 memset(&rinfo
[val
], 0, SZ_SG_REQ_INFO
);
1003 rinfo
[val
].req_state
= srp
->done
+ 1;
1004 rinfo
[val
].problem
=
1005 srp
->header
.masked_status
&
1006 srp
->header
.host_status
&
1007 srp
->header
.driver_status
;
1009 rinfo
[val
].duration
=
1010 srp
->header
.duration
;
1012 ms
= jiffies_to_msecs(jiffies
);
1013 rinfo
[val
].duration
=
1014 (ms
> srp
->header
.duration
) ?
1015 (ms
- srp
->header
.duration
) : 0;
1017 rinfo
[val
].orphan
= srp
->orphan
;
1018 rinfo
[val
].sg_io_owned
=
1020 rinfo
[val
].pack_id
=
1021 srp
->header
.pack_id
;
1022 rinfo
[val
].usr_ptr
=
1023 srp
->header
.usr_ptr
;
1026 read_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
1027 result
= __copy_to_user(p
, rinfo
,
1028 SZ_SG_REQ_INFO
* SG_MAX_QUEUE
);
1029 result
= result
? -EFAULT
: 0;
1033 case SG_EMULATED_HOST
:
1036 return put_user(sdp
->device
->host
->hostt
->emulated
, ip
);
1040 if (filp
->f_flags
& O_NONBLOCK
) {
1041 if (scsi_host_in_recovery(sdp
->device
->host
))
1043 } else if (!scsi_block_when_processing_errors(sdp
->device
))
1045 result
= get_user(val
, ip
);
1048 if (SG_SCSI_RESET_NOTHING
== val
)
1051 case SG_SCSI_RESET_DEVICE
:
1052 val
= SCSI_TRY_RESET_DEVICE
;
1054 case SG_SCSI_RESET_TARGET
:
1055 val
= SCSI_TRY_RESET_TARGET
;
1057 case SG_SCSI_RESET_BUS
:
1058 val
= SCSI_TRY_RESET_BUS
;
1060 case SG_SCSI_RESET_HOST
:
1061 val
= SCSI_TRY_RESET_HOST
;
1066 if (!capable(CAP_SYS_ADMIN
) || !capable(CAP_SYS_RAWIO
))
1068 return (scsi_reset_provider(sdp
->device
, val
) ==
1069 SUCCESS
) ? 0 : -EIO
;
1070 case SCSI_IOCTL_SEND_COMMAND
:
1074 unsigned char opcode
= WRITE_6
;
1075 Scsi_Ioctl_Command __user
*siocp
= p
;
1077 if (copy_from_user(&opcode
, siocp
->data
, 1))
1079 if (sg_allow_access(filp
, &opcode
))
1082 return sg_scsi_ioctl(sdp
->device
->request_queue
, NULL
, filp
->f_mode
, p
);
1084 result
= get_user(val
, ip
);
1087 sdp
->sgdebug
= (char) val
;
1089 case SCSI_IOCTL_GET_IDLUN
:
1090 case SCSI_IOCTL_GET_BUS_NUMBER
:
1091 case SCSI_IOCTL_PROBE_HOST
:
1092 case SG_GET_TRANSFORM
:
1095 return scsi_ioctl(sdp
->device
, cmd_in
, p
);
1097 return put_user(queue_max_sectors(sdp
->device
->request_queue
) * 512,
1100 return blk_trace_setup(sdp
->device
->request_queue
,
1101 sdp
->disk
->disk_name
,
1102 MKDEV(SCSI_GENERIC_MAJOR
, sdp
->index
),
1106 return blk_trace_startstop(sdp
->device
->request_queue
, 1);
1108 return blk_trace_startstop(sdp
->device
->request_queue
, 0);
1109 case BLKTRACETEARDOWN
:
1110 return blk_trace_remove(sdp
->device
->request_queue
);
1113 return -EPERM
; /* don't know so take safe approach */
1114 return scsi_ioctl(sdp
->device
, cmd_in
, p
);
1118 #ifdef CONFIG_COMPAT
1119 static long sg_compat_ioctl(struct file
*filp
, unsigned int cmd_in
, unsigned long arg
)
1123 struct scsi_device
*sdev
;
1125 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
1129 if (sdev
->host
->hostt
->compat_ioctl
) {
1132 ret
= sdev
->host
->hostt
->compat_ioctl(sdev
, cmd_in
, (void __user
*)arg
);
1137 return -ENOIOCTLCMD
;
1142 sg_poll(struct file
*filp
, poll_table
* wait
)
1144 unsigned int res
= 0;
1149 unsigned long iflags
;
1151 sfp
= filp
->private_data
;
1154 sdp
= sfp
->parentdp
;
1157 poll_wait(filp
, &sfp
->read_wait
, wait
);
1158 read_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
1159 for (srp
= sfp
->headrp
; srp
; srp
= srp
->nextrp
) {
1160 /* if any read waiting, flag it */
1161 if ((0 == res
) && (1 == srp
->done
) && (!srp
->sg_io_owned
))
1162 res
= POLLIN
| POLLRDNORM
;
1165 read_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
1169 else if (!sfp
->cmd_q
) {
1171 res
|= POLLOUT
| POLLWRNORM
;
1172 } else if (count
< SG_MAX_QUEUE
)
1173 res
|= POLLOUT
| POLLWRNORM
;
1174 SCSI_LOG_TIMEOUT(3, printk("sg_poll: %s, res=0x%x\n",
1175 sdp
->disk
->disk_name
, (int) res
));
1180 sg_fasync(int fd
, struct file
*filp
, int mode
)
1185 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
1187 SCSI_LOG_TIMEOUT(3, printk("sg_fasync: %s, mode=%d\n",
1188 sdp
->disk
->disk_name
, mode
));
1190 return fasync_helper(fd
, filp
, mode
, &sfp
->async_qp
);
1194 sg_vma_fault(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
1197 unsigned long offset
, len
, sa
;
1198 Sg_scatter_hold
*rsv_schp
;
1201 if ((NULL
== vma
) || (!(sfp
= (Sg_fd
*) vma
->vm_private_data
)))
1202 return VM_FAULT_SIGBUS
;
1203 rsv_schp
= &sfp
->reserve
;
1204 offset
= vmf
->pgoff
<< PAGE_SHIFT
;
1205 if (offset
>= rsv_schp
->bufflen
)
1206 return VM_FAULT_SIGBUS
;
1207 SCSI_LOG_TIMEOUT(3, printk("sg_vma_fault: offset=%lu, scatg=%d\n",
1208 offset
, rsv_schp
->k_use_sg
));
1210 length
= 1 << (PAGE_SHIFT
+ rsv_schp
->page_order
);
1211 for (k
= 0; k
< rsv_schp
->k_use_sg
&& sa
< vma
->vm_end
; k
++) {
1212 len
= vma
->vm_end
- sa
;
1213 len
= (len
< length
) ? len
: length
;
1215 struct page
*page
= nth_page(rsv_schp
->pages
[k
],
1216 offset
>> PAGE_SHIFT
);
1217 get_page(page
); /* increment page count */
1219 return 0; /* success */
1225 return VM_FAULT_SIGBUS
;
1228 static const struct vm_operations_struct sg_mmap_vm_ops
= {
1229 .fault
= sg_vma_fault
,
1233 sg_mmap(struct file
*filp
, struct vm_area_struct
*vma
)
1236 unsigned long req_sz
, len
, sa
;
1237 Sg_scatter_hold
*rsv_schp
;
1240 if ((!filp
) || (!vma
) || (!(sfp
= (Sg_fd
*) filp
->private_data
)))
1242 req_sz
= vma
->vm_end
- vma
->vm_start
;
1243 SCSI_LOG_TIMEOUT(3, printk("sg_mmap starting, vm_start=%p, len=%d\n",
1244 (void *) vma
->vm_start
, (int) req_sz
));
1246 return -EINVAL
; /* want no offset */
1247 rsv_schp
= &sfp
->reserve
;
1248 if (req_sz
> rsv_schp
->bufflen
)
1249 return -ENOMEM
; /* cannot map more than reserved buffer */
1252 length
= 1 << (PAGE_SHIFT
+ rsv_schp
->page_order
);
1253 for (k
= 0; k
< rsv_schp
->k_use_sg
&& sa
< vma
->vm_end
; k
++) {
1254 len
= vma
->vm_end
- sa
;
1255 len
= (len
< length
) ? len
: length
;
1259 sfp
->mmap_called
= 1;
1260 vma
->vm_flags
|= VM_DONTEXPAND
| VM_DONTDUMP
;
1261 vma
->vm_private_data
= sfp
;
1262 vma
->vm_ops
= &sg_mmap_vm_ops
;
1266 static void sg_rq_end_io_usercontext(struct work_struct
*work
)
1268 struct sg_request
*srp
= container_of(work
, struct sg_request
, ew
.work
);
1269 struct sg_fd
*sfp
= srp
->parentfp
;
1271 sg_finish_rem_req(srp
);
1272 kref_put(&sfp
->f_ref
, sg_remove_sfp
);
1276 * This function is a "bottom half" handler that is called by the mid
1277 * level when a command is completed (or has failed).
1279 static void sg_rq_end_io(struct request
*rq
, int uptodate
)
1281 struct sg_request
*srp
= rq
->end_io_data
;
1284 unsigned long iflags
;
1287 int result
, resid
, done
= 1;
1289 if (WARN_ON(srp
->done
!= 0))
1292 sfp
= srp
->parentfp
;
1293 if (WARN_ON(sfp
== NULL
))
1296 sdp
= sfp
->parentdp
;
1297 if (unlikely(sdp
->detached
))
1298 printk(KERN_INFO
"sg_rq_end_io: device detached\n");
1301 result
= rq
->errors
;
1302 resid
= rq
->resid_len
;
1304 SCSI_LOG_TIMEOUT(4, printk("sg_cmd_done: %s, pack_id=%d, res=0x%x\n",
1305 sdp
->disk
->disk_name
, srp
->header
.pack_id
, result
));
1306 srp
->header
.resid
= resid
;
1307 ms
= jiffies_to_msecs(jiffies
);
1308 srp
->header
.duration
= (ms
> srp
->header
.duration
) ?
1309 (ms
- srp
->header
.duration
) : 0;
1311 struct scsi_sense_hdr sshdr
;
1313 srp
->header
.status
= 0xff & result
;
1314 srp
->header
.masked_status
= status_byte(result
);
1315 srp
->header
.msg_status
= msg_byte(result
);
1316 srp
->header
.host_status
= host_byte(result
);
1317 srp
->header
.driver_status
= driver_byte(result
);
1318 if ((sdp
->sgdebug
> 0) &&
1319 ((CHECK_CONDITION
== srp
->header
.masked_status
) ||
1320 (COMMAND_TERMINATED
== srp
->header
.masked_status
)))
1321 __scsi_print_sense("sg_cmd_done", sense
,
1322 SCSI_SENSE_BUFFERSIZE
);
1324 /* Following if statement is a patch supplied by Eric Youngdale */
1325 if (driver_byte(result
) != 0
1326 && scsi_normalize_sense(sense
, SCSI_SENSE_BUFFERSIZE
, &sshdr
)
1327 && !scsi_sense_is_deferred(&sshdr
)
1328 && sshdr
.sense_key
== UNIT_ATTENTION
1329 && sdp
->device
->removable
) {
1330 /* Detected possible disc change. Set the bit - this */
1331 /* may be used if there are filesystems using this device */
1332 sdp
->device
->changed
= 1;
1335 /* Rely on write phase to clean out srp status values, so no "else" */
1337 write_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
1338 if (unlikely(srp
->orphan
)) {
1339 if (sfp
->keep_orphan
)
1340 srp
->sg_io_owned
= 0;
1345 write_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
1348 /* Now wake up any sg_read() that is waiting for this
1351 wake_up_interruptible(&sfp
->read_wait
);
1352 kill_fasync(&sfp
->async_qp
, SIGPOLL
, POLL_IN
);
1353 kref_put(&sfp
->f_ref
, sg_remove_sfp
);
1355 INIT_WORK(&srp
->ew
.work
, sg_rq_end_io_usercontext
);
1356 schedule_work(&srp
->ew
.work
);
1360 static const struct file_operations sg_fops
= {
1361 .owner
= THIS_MODULE
,
1365 .unlocked_ioctl
= sg_ioctl
,
1366 #ifdef CONFIG_COMPAT
1367 .compat_ioctl
= sg_compat_ioctl
,
1371 .release
= sg_release
,
1372 .fasync
= sg_fasync
,
1373 .llseek
= no_llseek
,
1376 static struct class *sg_sysfs_class
;
1378 static int sg_sysfs_valid
= 0;
1380 static Sg_device
*sg_alloc(struct gendisk
*disk
, struct scsi_device
*scsidp
)
1382 struct request_queue
*q
= scsidp
->request_queue
;
1384 unsigned long iflags
;
1388 sdp
= kzalloc(sizeof(Sg_device
), GFP_KERNEL
);
1390 printk(KERN_WARNING
"kmalloc Sg_device failure\n");
1391 return ERR_PTR(-ENOMEM
);
1394 idr_preload(GFP_KERNEL
);
1395 write_lock_irqsave(&sg_index_lock
, iflags
);
1397 error
= idr_alloc(&sg_index_idr
, sdp
, 0, SG_MAX_DEVS
, GFP_NOWAIT
);
1399 if (error
== -ENOSPC
) {
1400 sdev_printk(KERN_WARNING
, scsidp
,
1401 "Unable to attach sg device type=%d, minor number exceeds %d\n",
1402 scsidp
->type
, SG_MAX_DEVS
- 1);
1406 "idr allocation Sg_device failure: %d\n", error
);
1412 SCSI_LOG_TIMEOUT(3, printk("sg_alloc: dev=%d \n", k
));
1413 sprintf(disk
->disk_name
, "sg%d", k
);
1414 disk
->first_minor
= k
;
1416 sdp
->device
= scsidp
;
1417 INIT_LIST_HEAD(&sdp
->sfds
);
1418 init_waitqueue_head(&sdp
->o_excl_wait
);
1419 sdp
->sg_tablesize
= queue_max_segments(q
);
1421 kref_init(&sdp
->d_ref
);
1425 write_unlock_irqrestore(&sg_index_lock
, iflags
);
1430 return ERR_PTR(error
);
1436 sg_add(struct device
*cl_dev
, struct class_interface
*cl_intf
)
1438 struct scsi_device
*scsidp
= to_scsi_device(cl_dev
->parent
);
1439 struct gendisk
*disk
;
1440 Sg_device
*sdp
= NULL
;
1441 struct cdev
* cdev
= NULL
;
1443 unsigned long iflags
;
1445 disk
= alloc_disk(1);
1447 printk(KERN_WARNING
"alloc_disk failed\n");
1450 disk
->major
= SCSI_GENERIC_MAJOR
;
1453 cdev
= cdev_alloc();
1455 printk(KERN_WARNING
"cdev_alloc failed\n");
1458 cdev
->owner
= THIS_MODULE
;
1459 cdev
->ops
= &sg_fops
;
1461 sdp
= sg_alloc(disk
, scsidp
);
1463 printk(KERN_WARNING
"sg_alloc failed\n");
1464 error
= PTR_ERR(sdp
);
1468 error
= cdev_add(cdev
, MKDEV(SCSI_GENERIC_MAJOR
, sdp
->index
), 1);
1473 if (sg_sysfs_valid
) {
1474 struct device
*sg_class_member
;
1476 sg_class_member
= device_create(sg_sysfs_class
, cl_dev
->parent
,
1477 MKDEV(SCSI_GENERIC_MAJOR
,
1479 sdp
, "%s", disk
->disk_name
);
1480 if (IS_ERR(sg_class_member
)) {
1481 printk(KERN_ERR
"sg_add: "
1482 "device_create failed\n");
1483 error
= PTR_ERR(sg_class_member
);
1486 error
= sysfs_create_link(&scsidp
->sdev_gendev
.kobj
,
1487 &sg_class_member
->kobj
, "generic");
1489 printk(KERN_ERR
"sg_add: unable to make symlink "
1490 "'generic' back to sg%d\n", sdp
->index
);
1492 printk(KERN_WARNING
"sg_add: sg_sys Invalid\n");
1494 sdev_printk(KERN_NOTICE
, scsidp
,
1495 "Attached scsi generic sg%d type %d\n", sdp
->index
,
1498 dev_set_drvdata(cl_dev
, sdp
);
1503 write_lock_irqsave(&sg_index_lock
, iflags
);
1504 idr_remove(&sg_index_idr
, sdp
->index
);
1505 write_unlock_irqrestore(&sg_index_lock
, iflags
);
1515 static void sg_device_destroy(struct kref
*kref
)
1517 struct sg_device
*sdp
= container_of(kref
, struct sg_device
, d_ref
);
1518 unsigned long flags
;
1520 /* CAUTION! Note that the device can still be found via idr_find()
1521 * even though the refcount is 0. Therefore, do idr_remove() BEFORE
1522 * any other cleanup.
1525 write_lock_irqsave(&sg_index_lock
, flags
);
1526 idr_remove(&sg_index_idr
, sdp
->index
);
1527 write_unlock_irqrestore(&sg_index_lock
, flags
);
1530 printk("sg_device_destroy: %s\n",
1531 sdp
->disk
->disk_name
));
1533 put_disk(sdp
->disk
);
1537 static void sg_remove(struct device
*cl_dev
, struct class_interface
*cl_intf
)
1539 struct scsi_device
*scsidp
= to_scsi_device(cl_dev
->parent
);
1540 Sg_device
*sdp
= dev_get_drvdata(cl_dev
);
1541 unsigned long iflags
;
1544 if (!sdp
|| sdp
->detached
)
1547 SCSI_LOG_TIMEOUT(3, printk("sg_remove: %s\n", sdp
->disk
->disk_name
));
1549 /* Need a write lock to set sdp->detached. */
1550 write_lock_irqsave(&sg_index_lock
, iflags
);
1552 list_for_each_entry(sfp
, &sdp
->sfds
, sfd_siblings
) {
1553 wake_up_interruptible(&sfp
->read_wait
);
1554 kill_fasync(&sfp
->async_qp
, SIGPOLL
, POLL_HUP
);
1556 write_unlock_irqrestore(&sg_index_lock
, iflags
);
1558 sysfs_remove_link(&scsidp
->sdev_gendev
.kobj
, "generic");
1559 device_destroy(sg_sysfs_class
, MKDEV(SCSI_GENERIC_MAJOR
, sdp
->index
));
1560 cdev_del(sdp
->cdev
);
1566 module_param_named(scatter_elem_sz
, scatter_elem_sz
, int, S_IRUGO
| S_IWUSR
);
1567 module_param_named(def_reserved_size
, def_reserved_size
, int,
1569 module_param_named(allow_dio
, sg_allow_dio
, int, S_IRUGO
| S_IWUSR
);
1571 MODULE_AUTHOR("Douglas Gilbert");
1572 MODULE_DESCRIPTION("SCSI generic (sg) driver");
1573 MODULE_LICENSE("GPL");
1574 MODULE_VERSION(SG_VERSION_STR
);
1575 MODULE_ALIAS_CHARDEV_MAJOR(SCSI_GENERIC_MAJOR
);
1577 MODULE_PARM_DESC(scatter_elem_sz
, "scatter gather element "
1578 "size (default: max(SG_SCATTER_SZ, PAGE_SIZE))");
1579 MODULE_PARM_DESC(def_reserved_size
, "size of buffer reserved for each fd");
1580 MODULE_PARM_DESC(allow_dio
, "allow direct I/O (default: 0 (disallow))");
1587 if (scatter_elem_sz
< PAGE_SIZE
) {
1588 scatter_elem_sz
= PAGE_SIZE
;
1589 scatter_elem_sz_prev
= scatter_elem_sz
;
1591 if (def_reserved_size
>= 0)
1592 sg_big_buff
= def_reserved_size
;
1594 def_reserved_size
= sg_big_buff
;
1596 rc
= register_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR
, 0),
1600 sg_sysfs_class
= class_create(THIS_MODULE
, "scsi_generic");
1601 if ( IS_ERR(sg_sysfs_class
) ) {
1602 rc
= PTR_ERR(sg_sysfs_class
);
1606 rc
= scsi_register_interface(&sg_interface
);
1608 #ifdef CONFIG_SCSI_PROC_FS
1610 #endif /* CONFIG_SCSI_PROC_FS */
1613 class_destroy(sg_sysfs_class
);
1615 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR
, 0), SG_MAX_DEVS
);
1622 #ifdef CONFIG_SCSI_PROC_FS
1624 #endif /* CONFIG_SCSI_PROC_FS */
1625 scsi_unregister_interface(&sg_interface
);
1626 class_destroy(sg_sysfs_class
);
1628 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR
, 0),
1630 idr_destroy(&sg_index_idr
);
1633 static int sg_start_req(Sg_request
*srp
, unsigned char *cmd
)
1637 Sg_fd
*sfp
= srp
->parentfp
;
1638 sg_io_hdr_t
*hp
= &srp
->header
;
1639 int dxfer_len
= (int) hp
->dxfer_len
;
1640 int dxfer_dir
= hp
->dxfer_direction
;
1641 unsigned int iov_count
= hp
->iovec_count
;
1642 Sg_scatter_hold
*req_schp
= &srp
->data
;
1643 Sg_scatter_hold
*rsv_schp
= &sfp
->reserve
;
1644 struct request_queue
*q
= sfp
->parentdp
->device
->request_queue
;
1645 struct rq_map_data
*md
, map_data
;
1646 int rw
= hp
->dxfer_direction
== SG_DXFER_TO_DEV
? WRITE
: READ
;
1648 SCSI_LOG_TIMEOUT(4, printk(KERN_INFO
"sg_start_req: dxfer_len=%d\n",
1651 rq
= blk_get_request(q
, rw
, GFP_ATOMIC
);
1655 memcpy(rq
->cmd
, cmd
, hp
->cmd_len
);
1657 rq
->cmd_len
= hp
->cmd_len
;
1658 rq
->cmd_type
= REQ_TYPE_BLOCK_PC
;
1661 rq
->end_io_data
= srp
;
1662 rq
->sense
= srp
->sense_b
;
1663 rq
->retries
= SG_DEFAULT_RETRIES
;
1665 if ((dxfer_len
<= 0) || (dxfer_dir
== SG_DXFER_NONE
))
1668 if (sg_allow_dio
&& hp
->flags
& SG_FLAG_DIRECT_IO
&&
1669 dxfer_dir
!= SG_DXFER_UNKNOWN
&& !iov_count
&&
1670 !sfp
->parentdp
->device
->host
->unchecked_isa_dma
&&
1671 blk_rq_aligned(q
, (unsigned long)hp
->dxferp
, dxfer_len
))
1677 if (!sg_res_in_use(sfp
) && dxfer_len
<= rsv_schp
->bufflen
)
1678 sg_link_reserve(sfp
, srp
, dxfer_len
);
1680 res
= sg_build_indirect(req_schp
, sfp
, dxfer_len
);
1685 md
->pages
= req_schp
->pages
;
1686 md
->page_order
= req_schp
->page_order
;
1687 md
->nr_entries
= req_schp
->k_use_sg
;
1689 md
->null_mapped
= hp
->dxferp
? 0 : 1;
1690 if (dxfer_dir
== SG_DXFER_TO_FROM_DEV
)
1697 int len
, size
= sizeof(struct sg_iovec
) * iov_count
;
1700 iov
= memdup_user(hp
->dxferp
, size
);
1702 return PTR_ERR(iov
);
1704 len
= iov_length(iov
, iov_count
);
1705 if (hp
->dxfer_len
< len
) {
1706 iov_count
= iov_shorten(iov
, iov_count
, hp
->dxfer_len
);
1707 len
= hp
->dxfer_len
;
1710 res
= blk_rq_map_user_iov(q
, rq
, md
, (struct sg_iovec
*)iov
,
1715 res
= blk_rq_map_user(q
, rq
, md
, hp
->dxferp
,
1716 hp
->dxfer_len
, GFP_ATOMIC
);
1722 req_schp
->dio_in_use
= 1;
1723 hp
->info
|= SG_INFO_DIRECT_IO
;
1729 static int sg_finish_rem_req(Sg_request
* srp
)
1733 Sg_fd
*sfp
= srp
->parentfp
;
1734 Sg_scatter_hold
*req_schp
= &srp
->data
;
1736 SCSI_LOG_TIMEOUT(4, printk("sg_finish_rem_req: res_used=%d\n", (int) srp
->res_used
));
1739 ret
= blk_rq_unmap_user(srp
->bio
);
1741 blk_put_request(srp
->rq
);
1745 sg_unlink_reserve(sfp
, srp
);
1747 sg_remove_scat(req_schp
);
1749 sg_remove_request(sfp
, srp
);
1755 sg_build_sgat(Sg_scatter_hold
* schp
, const Sg_fd
* sfp
, int tablesize
)
1757 int sg_bufflen
= tablesize
* sizeof(struct page
*);
1758 gfp_t gfp_flags
= GFP_ATOMIC
| __GFP_NOWARN
;
1760 schp
->pages
= kzalloc(sg_bufflen
, gfp_flags
);
1763 schp
->sglist_len
= sg_bufflen
;
1764 return tablesize
; /* number of scat_gath elements allocated */
1768 sg_build_indirect(Sg_scatter_hold
* schp
, Sg_fd
* sfp
, int buff_size
)
1770 int ret_sz
= 0, i
, k
, rem_sz
, num
, mx_sc_elems
;
1771 int sg_tablesize
= sfp
->parentdp
->sg_tablesize
;
1772 int blk_size
= buff_size
, order
;
1773 gfp_t gfp_mask
= GFP_ATOMIC
| __GFP_COMP
| __GFP_NOWARN
;
1778 ++blk_size
; /* don't know why */
1779 /* round request up to next highest SG_SECTOR_SZ byte boundary */
1780 blk_size
= ALIGN(blk_size
, SG_SECTOR_SZ
);
1781 SCSI_LOG_TIMEOUT(4, printk("sg_build_indirect: buff_size=%d, blk_size=%d\n",
1782 buff_size
, blk_size
));
1784 /* N.B. ret_sz carried into this block ... */
1785 mx_sc_elems
= sg_build_sgat(schp
, sfp
, sg_tablesize
);
1786 if (mx_sc_elems
< 0)
1787 return mx_sc_elems
; /* most likely -ENOMEM */
1789 num
= scatter_elem_sz
;
1790 if (unlikely(num
!= scatter_elem_sz_prev
)) {
1791 if (num
< PAGE_SIZE
) {
1792 scatter_elem_sz
= PAGE_SIZE
;
1793 scatter_elem_sz_prev
= PAGE_SIZE
;
1795 scatter_elem_sz_prev
= num
;
1799 gfp_mask
|= GFP_DMA
;
1801 if (!capable(CAP_SYS_ADMIN
) || !capable(CAP_SYS_RAWIO
))
1802 gfp_mask
|= __GFP_ZERO
;
1804 order
= get_order(num
);
1806 ret_sz
= 1 << (PAGE_SHIFT
+ order
);
1808 for (k
= 0, rem_sz
= blk_size
; rem_sz
> 0 && k
< mx_sc_elems
;
1809 k
++, rem_sz
-= ret_sz
) {
1811 num
= (rem_sz
> scatter_elem_sz_prev
) ?
1812 scatter_elem_sz_prev
: rem_sz
;
1814 schp
->pages
[k
] = alloc_pages(gfp_mask
, order
);
1815 if (!schp
->pages
[k
])
1818 if (num
== scatter_elem_sz_prev
) {
1819 if (unlikely(ret_sz
> scatter_elem_sz_prev
)) {
1820 scatter_elem_sz
= ret_sz
;
1821 scatter_elem_sz_prev
= ret_sz
;
1825 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k=%d, num=%d, "
1826 "ret_sz=%d\n", k
, num
, ret_sz
));
1827 } /* end of for loop */
1829 schp
->page_order
= order
;
1831 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k_use_sg=%d, "
1832 "rem_sz=%d\n", k
, rem_sz
));
1834 schp
->bufflen
= blk_size
;
1835 if (rem_sz
> 0) /* must have failed */
1839 for (i
= 0; i
< k
; i
++)
1840 __free_pages(schp
->pages
[i
], order
);
1849 sg_remove_scat(Sg_scatter_hold
* schp
)
1851 SCSI_LOG_TIMEOUT(4, printk("sg_remove_scat: k_use_sg=%d\n", schp
->k_use_sg
));
1852 if (schp
->pages
&& schp
->sglist_len
> 0) {
1853 if (!schp
->dio_in_use
) {
1856 for (k
= 0; k
< schp
->k_use_sg
&& schp
->pages
[k
]; k
++) {
1857 SCSI_LOG_TIMEOUT(5, printk(
1858 "sg_remove_scat: k=%d, pg=0x%p\n",
1859 k
, schp
->pages
[k
]));
1860 __free_pages(schp
->pages
[k
], schp
->page_order
);
1866 memset(schp
, 0, sizeof (*schp
));
1870 sg_read_oxfer(Sg_request
* srp
, char __user
*outp
, int num_read_xfer
)
1872 Sg_scatter_hold
*schp
= &srp
->data
;
1875 SCSI_LOG_TIMEOUT(4, printk("sg_read_oxfer: num_read_xfer=%d\n",
1877 if ((!outp
) || (num_read_xfer
<= 0))
1880 num
= 1 << (PAGE_SHIFT
+ schp
->page_order
);
1881 for (k
= 0; k
< schp
->k_use_sg
&& schp
->pages
[k
]; k
++) {
1882 if (num
> num_read_xfer
) {
1883 if (__copy_to_user(outp
, page_address(schp
->pages
[k
]),
1888 if (__copy_to_user(outp
, page_address(schp
->pages
[k
]),
1891 num_read_xfer
-= num
;
1892 if (num_read_xfer
<= 0)
1902 sg_build_reserve(Sg_fd
* sfp
, int req_size
)
1904 Sg_scatter_hold
*schp
= &sfp
->reserve
;
1906 SCSI_LOG_TIMEOUT(4, printk("sg_build_reserve: req_size=%d\n", req_size
));
1908 if (req_size
< PAGE_SIZE
)
1909 req_size
= PAGE_SIZE
;
1910 if (0 == sg_build_indirect(schp
, sfp
, req_size
))
1913 sg_remove_scat(schp
);
1914 req_size
>>= 1; /* divide by 2 */
1915 } while (req_size
> (PAGE_SIZE
/ 2));
1919 sg_link_reserve(Sg_fd
* sfp
, Sg_request
* srp
, int size
)
1921 Sg_scatter_hold
*req_schp
= &srp
->data
;
1922 Sg_scatter_hold
*rsv_schp
= &sfp
->reserve
;
1926 SCSI_LOG_TIMEOUT(4, printk("sg_link_reserve: size=%d\n", size
));
1929 num
= 1 << (PAGE_SHIFT
+ rsv_schp
->page_order
);
1930 for (k
= 0; k
< rsv_schp
->k_use_sg
; k
++) {
1932 req_schp
->k_use_sg
= k
+ 1;
1933 req_schp
->sglist_len
= rsv_schp
->sglist_len
;
1934 req_schp
->pages
= rsv_schp
->pages
;
1936 req_schp
->bufflen
= size
;
1937 req_schp
->page_order
= rsv_schp
->page_order
;
1943 if (k
>= rsv_schp
->k_use_sg
)
1944 SCSI_LOG_TIMEOUT(1, printk("sg_link_reserve: BAD size\n"));
1948 sg_unlink_reserve(Sg_fd
* sfp
, Sg_request
* srp
)
1950 Sg_scatter_hold
*req_schp
= &srp
->data
;
1952 SCSI_LOG_TIMEOUT(4, printk("sg_unlink_reserve: req->k_use_sg=%d\n",
1953 (int) req_schp
->k_use_sg
));
1954 req_schp
->k_use_sg
= 0;
1955 req_schp
->bufflen
= 0;
1956 req_schp
->pages
= NULL
;
1957 req_schp
->page_order
= 0;
1958 req_schp
->sglist_len
= 0;
1959 sfp
->save_scat_len
= 0;
1964 sg_get_rq_mark(Sg_fd
* sfp
, int pack_id
)
1967 unsigned long iflags
;
1969 write_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
1970 for (resp
= sfp
->headrp
; resp
; resp
= resp
->nextrp
) {
1971 /* look for requests that are ready + not SG_IO owned */
1972 if ((1 == resp
->done
) && (!resp
->sg_io_owned
) &&
1973 ((-1 == pack_id
) || (resp
->header
.pack_id
== pack_id
))) {
1974 resp
->done
= 2; /* guard against other readers */
1978 write_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
1982 /* always adds to end of list */
1984 sg_add_request(Sg_fd
* sfp
)
1987 unsigned long iflags
;
1989 Sg_request
*rp
= sfp
->req_arr
;
1991 write_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
1994 memset(rp
, 0, sizeof (Sg_request
));
1999 if (0 == sfp
->cmd_q
)
2000 resp
= NULL
; /* command queuing disallowed */
2002 for (k
= 0; k
< SG_MAX_QUEUE
; ++k
, ++rp
) {
2006 if (k
< SG_MAX_QUEUE
) {
2007 memset(rp
, 0, sizeof (Sg_request
));
2009 while (resp
->nextrp
)
2010 resp
= resp
->nextrp
;
2018 resp
->nextrp
= NULL
;
2019 resp
->header
.duration
= jiffies_to_msecs(jiffies
);
2021 write_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
2025 /* Return of 1 for found; 0 for not found */
2027 sg_remove_request(Sg_fd
* sfp
, Sg_request
* srp
)
2029 Sg_request
*prev_rp
;
2031 unsigned long iflags
;
2034 if ((!sfp
) || (!srp
) || (!sfp
->headrp
))
2036 write_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
2037 prev_rp
= sfp
->headrp
;
2038 if (srp
== prev_rp
) {
2039 sfp
->headrp
= prev_rp
->nextrp
;
2040 prev_rp
->parentfp
= NULL
;
2043 while ((rp
= prev_rp
->nextrp
)) {
2045 prev_rp
->nextrp
= rp
->nextrp
;
2046 rp
->parentfp
= NULL
;
2053 write_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
2058 sg_add_sfp(Sg_device
* sdp
, int dev
)
2061 unsigned long iflags
;
2064 sfp
= kzalloc(sizeof(*sfp
), GFP_ATOMIC
| __GFP_NOWARN
);
2068 init_waitqueue_head(&sfp
->read_wait
);
2069 rwlock_init(&sfp
->rq_list_lock
);
2071 kref_init(&sfp
->f_ref
);
2072 sfp
->timeout
= SG_DEFAULT_TIMEOUT
;
2073 sfp
->timeout_user
= SG_DEFAULT_TIMEOUT_USER
;
2074 sfp
->force_packid
= SG_DEF_FORCE_PACK_ID
;
2075 sfp
->low_dma
= (SG_DEF_FORCE_LOW_DMA
== 0) ?
2076 sdp
->device
->host
->unchecked_isa_dma
: 1;
2077 sfp
->cmd_q
= SG_DEF_COMMAND_Q
;
2078 sfp
->keep_orphan
= SG_DEF_KEEP_ORPHAN
;
2079 sfp
->parentdp
= sdp
;
2080 write_lock_irqsave(&sg_index_lock
, iflags
);
2081 list_add_tail(&sfp
->sfd_siblings
, &sdp
->sfds
);
2082 write_unlock_irqrestore(&sg_index_lock
, iflags
);
2083 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: sfp=0x%p\n", sfp
));
2084 if (unlikely(sg_big_buff
!= def_reserved_size
))
2085 sg_big_buff
= def_reserved_size
;
2087 bufflen
= min_t(int, sg_big_buff
,
2088 queue_max_sectors(sdp
->device
->request_queue
) * 512);
2089 sg_build_reserve(sfp
, bufflen
);
2090 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: bufflen=%d, k_use_sg=%d\n",
2091 sfp
->reserve
.bufflen
, sfp
->reserve
.k_use_sg
));
2093 kref_get(&sdp
->d_ref
);
2094 __module_get(THIS_MODULE
);
2098 static void sg_remove_sfp_usercontext(struct work_struct
*work
)
2100 struct sg_fd
*sfp
= container_of(work
, struct sg_fd
, ew
.work
);
2101 struct sg_device
*sdp
= sfp
->parentdp
;
2103 /* Cleanup any responses which were never read(). */
2105 sg_finish_rem_req(sfp
->headrp
);
2107 if (sfp
->reserve
.bufflen
> 0) {
2109 printk("sg_remove_sfp: bufflen=%d, k_use_sg=%d\n",
2110 (int) sfp
->reserve
.bufflen
,
2111 (int) sfp
->reserve
.k_use_sg
));
2112 sg_remove_scat(&sfp
->reserve
);
2116 printk("sg_remove_sfp: %s, sfp=0x%p\n",
2117 sdp
->disk
->disk_name
,
2121 scsi_device_put(sdp
->device
);
2123 module_put(THIS_MODULE
);
2126 static void sg_remove_sfp(struct kref
*kref
)
2128 struct sg_fd
*sfp
= container_of(kref
, struct sg_fd
, f_ref
);
2129 struct sg_device
*sdp
= sfp
->parentdp
;
2130 unsigned long iflags
;
2132 write_lock_irqsave(&sg_index_lock
, iflags
);
2133 list_del(&sfp
->sfd_siblings
);
2134 write_unlock_irqrestore(&sg_index_lock
, iflags
);
2135 wake_up_interruptible(&sdp
->o_excl_wait
);
2137 INIT_WORK(&sfp
->ew
.work
, sg_remove_sfp_usercontext
);
2138 schedule_work(&sfp
->ew
.work
);
2142 sg_res_in_use(Sg_fd
* sfp
)
2144 const Sg_request
*srp
;
2145 unsigned long iflags
;
2147 read_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
2148 for (srp
= sfp
->headrp
; srp
; srp
= srp
->nextrp
)
2151 read_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
2155 #ifdef CONFIG_SCSI_PROC_FS
2157 sg_idr_max_id(int id
, void *p
, void *data
)
2171 unsigned long iflags
;
2173 read_lock_irqsave(&sg_index_lock
, iflags
);
2174 idr_for_each(&sg_index_idr
, sg_idr_max_id
, &k
);
2175 read_unlock_irqrestore(&sg_index_lock
, iflags
);
2176 return k
+ 1; /* origin 1 */
2180 /* must be called with sg_index_lock held */
2181 static Sg_device
*sg_lookup_dev(int dev
)
2183 return idr_find(&sg_index_idr
, dev
);
2186 static Sg_device
*sg_get_dev(int dev
)
2188 struct sg_device
*sdp
;
2189 unsigned long flags
;
2191 read_lock_irqsave(&sg_index_lock
, flags
);
2192 sdp
= sg_lookup_dev(dev
);
2194 sdp
= ERR_PTR(-ENXIO
);
2195 else if (sdp
->detached
) {
2196 /* If sdp->detached, then the refcount may already be 0, in
2197 * which case it would be a bug to do kref_get().
2199 sdp
= ERR_PTR(-ENODEV
);
2201 kref_get(&sdp
->d_ref
);
2202 read_unlock_irqrestore(&sg_index_lock
, flags
);
2207 static void sg_put_dev(struct sg_device
*sdp
)
2209 kref_put(&sdp
->d_ref
, sg_device_destroy
);
2212 #ifdef CONFIG_SCSI_PROC_FS
2214 static struct proc_dir_entry
*sg_proc_sgp
= NULL
;
2216 static char sg_proc_sg_dirname
[] = "scsi/sg";
2218 static int sg_proc_seq_show_int(struct seq_file
*s
, void *v
);
2220 static int sg_proc_single_open_adio(struct inode
*inode
, struct file
*file
);
2221 static ssize_t
sg_proc_write_adio(struct file
*filp
, const char __user
*buffer
,
2222 size_t count
, loff_t
*off
);
2223 static const struct file_operations adio_fops
= {
2224 .owner
= THIS_MODULE
,
2225 .open
= sg_proc_single_open_adio
,
2227 .llseek
= seq_lseek
,
2228 .write
= sg_proc_write_adio
,
2229 .release
= single_release
,
2232 static int sg_proc_single_open_dressz(struct inode
*inode
, struct file
*file
);
2233 static ssize_t
sg_proc_write_dressz(struct file
*filp
,
2234 const char __user
*buffer
, size_t count
, loff_t
*off
);
2235 static const struct file_operations dressz_fops
= {
2236 .owner
= THIS_MODULE
,
2237 .open
= sg_proc_single_open_dressz
,
2239 .llseek
= seq_lseek
,
2240 .write
= sg_proc_write_dressz
,
2241 .release
= single_release
,
2244 static int sg_proc_seq_show_version(struct seq_file
*s
, void *v
);
2245 static int sg_proc_single_open_version(struct inode
*inode
, struct file
*file
);
2246 static const struct file_operations version_fops
= {
2247 .owner
= THIS_MODULE
,
2248 .open
= sg_proc_single_open_version
,
2250 .llseek
= seq_lseek
,
2251 .release
= single_release
,
2254 static int sg_proc_seq_show_devhdr(struct seq_file
*s
, void *v
);
2255 static int sg_proc_single_open_devhdr(struct inode
*inode
, struct file
*file
);
2256 static const struct file_operations devhdr_fops
= {
2257 .owner
= THIS_MODULE
,
2258 .open
= sg_proc_single_open_devhdr
,
2260 .llseek
= seq_lseek
,
2261 .release
= single_release
,
2264 static int sg_proc_seq_show_dev(struct seq_file
*s
, void *v
);
2265 static int sg_proc_open_dev(struct inode
*inode
, struct file
*file
);
2266 static void * dev_seq_start(struct seq_file
*s
, loff_t
*pos
);
2267 static void * dev_seq_next(struct seq_file
*s
, void *v
, loff_t
*pos
);
2268 static void dev_seq_stop(struct seq_file
*s
, void *v
);
2269 static const struct file_operations dev_fops
= {
2270 .owner
= THIS_MODULE
,
2271 .open
= sg_proc_open_dev
,
2273 .llseek
= seq_lseek
,
2274 .release
= seq_release
,
2276 static const struct seq_operations dev_seq_ops
= {
2277 .start
= dev_seq_start
,
2278 .next
= dev_seq_next
,
2279 .stop
= dev_seq_stop
,
2280 .show
= sg_proc_seq_show_dev
,
2283 static int sg_proc_seq_show_devstrs(struct seq_file
*s
, void *v
);
2284 static int sg_proc_open_devstrs(struct inode
*inode
, struct file
*file
);
2285 static const struct file_operations devstrs_fops
= {
2286 .owner
= THIS_MODULE
,
2287 .open
= sg_proc_open_devstrs
,
2289 .llseek
= seq_lseek
,
2290 .release
= seq_release
,
2292 static const struct seq_operations devstrs_seq_ops
= {
2293 .start
= dev_seq_start
,
2294 .next
= dev_seq_next
,
2295 .stop
= dev_seq_stop
,
2296 .show
= sg_proc_seq_show_devstrs
,
2299 static int sg_proc_seq_show_debug(struct seq_file
*s
, void *v
);
2300 static int sg_proc_open_debug(struct inode
*inode
, struct file
*file
);
2301 static const struct file_operations debug_fops
= {
2302 .owner
= THIS_MODULE
,
2303 .open
= sg_proc_open_debug
,
2305 .llseek
= seq_lseek
,
2306 .release
= seq_release
,
2308 static const struct seq_operations debug_seq_ops
= {
2309 .start
= dev_seq_start
,
2310 .next
= dev_seq_next
,
2311 .stop
= dev_seq_stop
,
2312 .show
= sg_proc_seq_show_debug
,
2316 struct sg_proc_leaf
{
2318 const struct file_operations
* fops
;
2321 static const struct sg_proc_leaf sg_proc_leaf_arr
[] = {
2322 {"allow_dio", &adio_fops
},
2323 {"debug", &debug_fops
},
2324 {"def_reserved_size", &dressz_fops
},
2325 {"device_hdr", &devhdr_fops
},
2326 {"devices", &dev_fops
},
2327 {"device_strs", &devstrs_fops
},
2328 {"version", &version_fops
}
2334 int num_leaves
= ARRAY_SIZE(sg_proc_leaf_arr
);
2337 sg_proc_sgp
= proc_mkdir(sg_proc_sg_dirname
, NULL
);
2340 for (k
= 0; k
< num_leaves
; ++k
) {
2341 const struct sg_proc_leaf
*leaf
= &sg_proc_leaf_arr
[k
];
2342 umode_t mask
= leaf
->fops
->write
? S_IRUGO
| S_IWUSR
: S_IRUGO
;
2343 proc_create(leaf
->name
, mask
, sg_proc_sgp
, leaf
->fops
);
2349 sg_proc_cleanup(void)
2352 int num_leaves
= ARRAY_SIZE(sg_proc_leaf_arr
);
2356 for (k
= 0; k
< num_leaves
; ++k
)
2357 remove_proc_entry(sg_proc_leaf_arr
[k
].name
, sg_proc_sgp
);
2358 remove_proc_entry(sg_proc_sg_dirname
, NULL
);
2362 static int sg_proc_seq_show_int(struct seq_file
*s
, void *v
)
2364 seq_printf(s
, "%d\n", *((int *)s
->private));
2368 static int sg_proc_single_open_adio(struct inode
*inode
, struct file
*file
)
2370 return single_open(file
, sg_proc_seq_show_int
, &sg_allow_dio
);
2374 sg_proc_write_adio(struct file
*filp
, const char __user
*buffer
,
2375 size_t count
, loff_t
*off
)
2380 if (!capable(CAP_SYS_ADMIN
) || !capable(CAP_SYS_RAWIO
))
2382 err
= kstrtoul_from_user(buffer
, count
, 0, &num
);
2385 sg_allow_dio
= num
? 1 : 0;
2389 static int sg_proc_single_open_dressz(struct inode
*inode
, struct file
*file
)
2391 return single_open(file
, sg_proc_seq_show_int
, &sg_big_buff
);
2395 sg_proc_write_dressz(struct file
*filp
, const char __user
*buffer
,
2396 size_t count
, loff_t
*off
)
2399 unsigned long k
= ULONG_MAX
;
2401 if (!capable(CAP_SYS_ADMIN
) || !capable(CAP_SYS_RAWIO
))
2404 err
= kstrtoul_from_user(buffer
, count
, 0, &k
);
2407 if (k
<= 1048576) { /* limit "big buff" to 1 MB */
2414 static int sg_proc_seq_show_version(struct seq_file
*s
, void *v
)
2416 seq_printf(s
, "%d\t%s [%s]\n", sg_version_num
, SG_VERSION_STR
,
2421 static int sg_proc_single_open_version(struct inode
*inode
, struct file
*file
)
2423 return single_open(file
, sg_proc_seq_show_version
, NULL
);
2426 static int sg_proc_seq_show_devhdr(struct seq_file
*s
, void *v
)
2428 seq_printf(s
, "host\tchan\tid\tlun\ttype\topens\tqdepth\tbusy\t"
2433 static int sg_proc_single_open_devhdr(struct inode
*inode
, struct file
*file
)
2435 return single_open(file
, sg_proc_seq_show_devhdr
, NULL
);
2438 struct sg_proc_deviter
{
2443 static void * dev_seq_start(struct seq_file
*s
, loff_t
*pos
)
2445 struct sg_proc_deviter
* it
= kmalloc(sizeof(*it
), GFP_KERNEL
);
2452 it
->max
= sg_last_dev();
2453 if (it
->index
>= it
->max
)
2458 static void * dev_seq_next(struct seq_file
*s
, void *v
, loff_t
*pos
)
2460 struct sg_proc_deviter
* it
= s
->private;
2463 return (it
->index
< it
->max
) ? it
: NULL
;
2466 static void dev_seq_stop(struct seq_file
*s
, void *v
)
2471 static int sg_proc_open_dev(struct inode
*inode
, struct file
*file
)
2473 return seq_open(file
, &dev_seq_ops
);
2476 static int sg_proc_seq_show_dev(struct seq_file
*s
, void *v
)
2478 struct sg_proc_deviter
* it
= (struct sg_proc_deviter
*) v
;
2480 struct scsi_device
*scsidp
;
2481 unsigned long iflags
;
2483 read_lock_irqsave(&sg_index_lock
, iflags
);
2484 sdp
= it
? sg_lookup_dev(it
->index
) : NULL
;
2485 if (sdp
&& (scsidp
= sdp
->device
) && (!sdp
->detached
))
2486 seq_printf(s
, "%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\n",
2487 scsidp
->host
->host_no
, scsidp
->channel
,
2488 scsidp
->id
, scsidp
->lun
, (int) scsidp
->type
,
2490 (int) scsidp
->queue_depth
,
2491 (int) scsidp
->device_busy
,
2492 (int) scsi_device_online(scsidp
));
2494 seq_printf(s
, "-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\n");
2495 read_unlock_irqrestore(&sg_index_lock
, iflags
);
2499 static int sg_proc_open_devstrs(struct inode
*inode
, struct file
*file
)
2501 return seq_open(file
, &devstrs_seq_ops
);
2504 static int sg_proc_seq_show_devstrs(struct seq_file
*s
, void *v
)
2506 struct sg_proc_deviter
* it
= (struct sg_proc_deviter
*) v
;
2508 struct scsi_device
*scsidp
;
2509 unsigned long iflags
;
2511 read_lock_irqsave(&sg_index_lock
, iflags
);
2512 sdp
= it
? sg_lookup_dev(it
->index
) : NULL
;
2513 if (sdp
&& (scsidp
= sdp
->device
) && (!sdp
->detached
))
2514 seq_printf(s
, "%8.8s\t%16.16s\t%4.4s\n",
2515 scsidp
->vendor
, scsidp
->model
, scsidp
->rev
);
2517 seq_printf(s
, "<no active device>\n");
2518 read_unlock_irqrestore(&sg_index_lock
, iflags
);
2522 /* must be called while holding sg_index_lock */
2523 static void sg_proc_debug_helper(struct seq_file
*s
, Sg_device
* sdp
)
2525 int k
, m
, new_interface
, blen
, usg
;
2528 const sg_io_hdr_t
*hp
;
2533 list_for_each_entry(fp
, &sdp
->sfds
, sfd_siblings
) {
2535 read_lock(&fp
->rq_list_lock
); /* irqs already disabled */
2536 seq_printf(s
, " FD(%d): timeout=%dms bufflen=%d "
2537 "(res)sgat=%d low_dma=%d\n", k
,
2538 jiffies_to_msecs(fp
->timeout
),
2539 fp
->reserve
.bufflen
,
2540 (int) fp
->reserve
.k_use_sg
,
2542 seq_printf(s
, " cmd_q=%d f_packid=%d k_orphan=%d closed=0\n",
2543 (int) fp
->cmd_q
, (int) fp
->force_packid
,
2544 (int) fp
->keep_orphan
);
2545 for (m
= 0, srp
= fp
->headrp
;
2547 ++m
, srp
= srp
->nextrp
) {
2549 new_interface
= (hp
->interface_id
== '\0') ? 0 : 1;
2550 if (srp
->res_used
) {
2551 if (new_interface
&&
2552 (SG_FLAG_MMAP_IO
& hp
->flags
))
2557 if (SG_INFO_DIRECT_IO_MASK
& hp
->info
)
2563 blen
= srp
->data
.bufflen
;
2564 usg
= srp
->data
.k_use_sg
;
2565 seq_printf(s
, srp
->done
?
2566 ((1 == srp
->done
) ? "rcv:" : "fin:")
2568 seq_printf(s
, " id=%d blen=%d",
2569 srp
->header
.pack_id
, blen
);
2571 seq_printf(s
, " dur=%d", hp
->duration
);
2573 ms
= jiffies_to_msecs(jiffies
);
2574 seq_printf(s
, " t_o/elap=%d/%d",
2575 (new_interface
? hp
->timeout
:
2576 jiffies_to_msecs(fp
->timeout
)),
2577 (ms
> hp
->duration
? ms
- hp
->duration
: 0));
2579 seq_printf(s
, "ms sgat=%d op=0x%02x\n", usg
,
2580 (int) srp
->data
.cmd_opcode
);
2583 seq_printf(s
, " No requests active\n");
2584 read_unlock(&fp
->rq_list_lock
);
2588 static int sg_proc_open_debug(struct inode
*inode
, struct file
*file
)
2590 return seq_open(file
, &debug_seq_ops
);
2593 static int sg_proc_seq_show_debug(struct seq_file
*s
, void *v
)
2595 struct sg_proc_deviter
* it
= (struct sg_proc_deviter
*) v
;
2597 unsigned long iflags
;
2599 if (it
&& (0 == it
->index
)) {
2600 seq_printf(s
, "max_active_device=%d(origin 1)\n",
2602 seq_printf(s
, " def_reserved_size=%d\n", sg_big_buff
);
2605 read_lock_irqsave(&sg_index_lock
, iflags
);
2606 sdp
= it
? sg_lookup_dev(it
->index
) : NULL
;
2607 if (sdp
&& !list_empty(&sdp
->sfds
)) {
2608 struct scsi_device
*scsidp
= sdp
->device
;
2610 seq_printf(s
, " >>> device=%s ", sdp
->disk
->disk_name
);
2612 seq_printf(s
, "detached pending close ");
2615 (s
, "scsi%d chan=%d id=%d lun=%d em=%d",
2616 scsidp
->host
->host_no
,
2617 scsidp
->channel
, scsidp
->id
,
2619 scsidp
->host
->hostt
->emulated
);
2620 seq_printf(s
, " sg_tablesize=%d excl=%d\n",
2621 sdp
->sg_tablesize
, get_exclude(sdp
));
2622 sg_proc_debug_helper(s
, sdp
);
2624 read_unlock_irqrestore(&sg_index_lock
, iflags
);
2628 #endif /* CONFIG_SCSI_PROC_FS */
2630 module_init(init_sg
);
2631 module_exit(exit_sg
);