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/fcntl.h>
42 #include <linux/init.h>
43 #include <linux/poll.h>
44 #include <linux/moduleparam.h>
45 #include <linux/cdev.h>
46 #include <linux/idr.h>
47 #include <linux/seq_file.h>
48 #include <linux/blkdev.h>
49 #include <linux/delay.h>
50 #include <linux/blktrace_api.h>
51 #include <linux/smp_lock.h>
54 #include <scsi/scsi_dbg.h>
55 #include <scsi/scsi_host.h>
56 #include <scsi/scsi_driver.h>
57 #include <scsi/scsi_ioctl.h>
60 #include "scsi_logging.h"
62 #ifdef CONFIG_SCSI_PROC_FS
63 #include <linux/proc_fs.h>
64 static char *sg_version_date
= "20061027";
66 static int sg_proc_init(void);
67 static void sg_proc_cleanup(void);
70 #define SG_ALLOW_DIO_DEF 0
72 #define SG_MAX_DEVS 32768
75 * Suppose you want to calculate the formula muldiv(x,m,d)=int(x * m / d)
76 * Then when using 32 bit integers x * m may overflow during the calculation.
77 * Replacing muldiv(x) by muldiv(x)=((x % d) * m) / d + int(x / d) * m
78 * calculates the same, but prevents the overflow when both m and d
79 * are "small" numbers (like HZ and USER_HZ).
80 * Of course an overflow is inavoidable if the result of muldiv doesn't fit
83 #define MULDIV(X,MUL,DIV) ((((X % DIV) * MUL) / DIV) + ((X / DIV) * MUL))
85 #define SG_DEFAULT_TIMEOUT MULDIV(SG_DEFAULT_TIMEOUT_USER, HZ, USER_HZ)
87 int sg_big_buff
= SG_DEF_RESERVED_SIZE
;
88 /* N.B. This variable is readable and writeable via
89 /proc/scsi/sg/def_reserved_size . Each time sg_open() is called a buffer
90 of this size (or less if there is not enough memory) will be reserved
91 for use by this file descriptor. [Deprecated usage: this variable is also
92 readable via /proc/sys/kernel/sg-big-buff if the sg driver is built into
93 the kernel (i.e. it is not a module).] */
94 static int def_reserved_size
= -1; /* picks up init parameter */
95 static int sg_allow_dio
= SG_ALLOW_DIO_DEF
;
97 static int scatter_elem_sz
= SG_SCATTER_SZ
;
98 static int scatter_elem_sz_prev
= SG_SCATTER_SZ
;
100 #define SG_SECTOR_SZ 512
101 #define SG_SECTOR_MSK (SG_SECTOR_SZ - 1)
103 static int sg_add(struct device
*, struct class_interface
*);
104 static void sg_device_destroy(struct kref
*kref
);
105 static void sg_remove(struct device
*, struct class_interface
*);
107 static DEFINE_IDR(sg_index_idr
);
108 static DEFINE_RWLOCK(sg_index_lock
); /* Also used to lock
109 file descriptor list for device */
111 static struct class_interface sg_interface
= {
113 .remove_dev
= sg_remove
,
116 typedef struct sg_scatter_hold
{ /* holding area for scsi scatter gather info */
117 unsigned short k_use_sg
; /* Count of kernel scatter-gather pieces */
118 unsigned sglist_len
; /* size of malloc'd scatter-gather list ++ */
119 unsigned bufflen
; /* Size of (aggregate) data buffer */
122 char dio_in_use
; /* 0->indirect IO (or mmap), 1->dio */
123 unsigned char cmd_opcode
; /* first byte of command */
126 struct sg_device
; /* forward declarations */
129 typedef struct sg_request
{ /* SG_MAX_QUEUE requests outstanding per file */
130 struct sg_request
*nextrp
; /* NULL -> tail request (slist) */
131 struct sg_fd
*parentfp
; /* NULL -> not in use */
132 Sg_scatter_hold data
; /* hold buffer, perhaps scatter list */
133 sg_io_hdr_t header
; /* scsi command+info, see <scsi/sg.h> */
134 unsigned char sense_b
[SCSI_SENSE_BUFFERSIZE
];
135 char res_used
; /* 1 -> using reserve buffer, 0 -> not ... */
136 char orphan
; /* 1 -> drop on sight, 0 -> normal */
137 char sg_io_owned
; /* 1 -> packet belongs to SG_IO */
138 volatile char done
; /* 0->before bh, 1->before read, 2->read */
141 struct execute_work ew
;
144 typedef struct sg_fd
{ /* holds the state of a file descriptor */
145 struct sg_fd
*nextfp
; /* NULL when last opened fd on this device */
146 struct sg_device
*parentdp
; /* owning device */
147 wait_queue_head_t read_wait
; /* queue read until command done */
148 rwlock_t rq_list_lock
; /* protect access to list in req_arr */
149 int timeout
; /* defaults to SG_DEFAULT_TIMEOUT */
150 int timeout_user
; /* defaults to SG_DEFAULT_TIMEOUT_USER */
151 Sg_scatter_hold reserve
; /* buffer held for this file descriptor */
152 unsigned save_scat_len
; /* original length of trunc. scat. element */
153 Sg_request
*headrp
; /* head of request slist, NULL->empty */
154 struct fasync_struct
*async_qp
; /* used by asynchronous notification */
155 Sg_request req_arr
[SG_MAX_QUEUE
]; /* used as singly-linked list */
156 char low_dma
; /* as in parent but possibly overridden to 1 */
157 char force_packid
; /* 1 -> pack_id input to read(), 0 -> ignored */
158 volatile char closed
; /* 1 -> fd closed but request(s) outstanding */
159 char cmd_q
; /* 1 -> allow command queuing, 0 -> don't */
160 char next_cmd_len
; /* 0 -> automatic (def), >0 -> use on next write() */
161 char keep_orphan
; /* 0 -> drop orphan (def), 1 -> keep for read() */
162 char mmap_called
; /* 0 -> mmap() never called on this fd */
164 struct execute_work ew
;
167 typedef struct sg_device
{ /* holds the state of each scsi generic device */
168 struct scsi_device
*device
;
169 wait_queue_head_t o_excl_wait
; /* queue open() when O_EXCL in use */
170 int sg_tablesize
; /* adapter's max scatter-gather table size */
171 u32 index
; /* device index number */
172 Sg_fd
*headfp
; /* first open fd belonging to this device */
173 volatile char detached
; /* 0->attached, 1->detached pending removal */
174 volatile char exclude
; /* opened for exclusive access */
175 char sgdebug
; /* 0->off, 1->sense, 9->dump dev, 10-> all devs */
176 struct gendisk
*disk
;
177 struct cdev
* cdev
; /* char_dev [sysfs: /sys/cdev/major/sg<n>] */
181 static int sg_fasync(int fd
, struct file
*filp
, int mode
);
182 /* tasklet or soft irq callback */
183 static void sg_rq_end_io(struct request
*rq
, int uptodate
);
184 static int sg_start_req(Sg_request
*srp
, unsigned char *cmd
);
185 static void sg_finish_rem_req(Sg_request
* srp
);
186 static int sg_build_indirect(Sg_scatter_hold
* schp
, Sg_fd
* sfp
, int buff_size
);
187 static int sg_build_sgat(Sg_scatter_hold
* schp
, const Sg_fd
* sfp
,
189 static ssize_t
sg_new_read(Sg_fd
* sfp
, char __user
*buf
, size_t count
,
191 static ssize_t
sg_new_write(Sg_fd
*sfp
, struct file
*file
,
192 const char __user
*buf
, size_t count
, int blocking
,
193 int read_only
, int sg_io_owned
, Sg_request
**o_srp
);
194 static int sg_common_write(Sg_fd
* sfp
, Sg_request
* srp
,
195 unsigned char *cmnd
, int timeout
, int blocking
);
196 static int sg_read_oxfer(Sg_request
* srp
, char __user
*outp
, int num_read_xfer
);
197 static void sg_remove_scat(Sg_scatter_hold
* schp
);
198 static void sg_build_reserve(Sg_fd
* sfp
, int req_size
);
199 static void sg_link_reserve(Sg_fd
* sfp
, Sg_request
* srp
, int size
);
200 static void sg_unlink_reserve(Sg_fd
* sfp
, Sg_request
* srp
);
201 static Sg_fd
*sg_add_sfp(Sg_device
* sdp
, int dev
);
202 static void sg_remove_sfp(struct kref
*);
203 static Sg_request
*sg_get_rq_mark(Sg_fd
* sfp
, int pack_id
);
204 static Sg_request
*sg_add_request(Sg_fd
* sfp
);
205 static int sg_remove_request(Sg_fd
* sfp
, Sg_request
* srp
);
206 static int sg_res_in_use(Sg_fd
* sfp
);
207 static Sg_device
*sg_lookup_dev(int dev
);
208 static Sg_device
*sg_get_dev(int dev
);
209 static void sg_put_dev(Sg_device
*sdp
);
210 #ifdef CONFIG_SCSI_PROC_FS
211 static int sg_last_dev(void);
214 #define SZ_SG_HEADER sizeof(struct sg_header)
215 #define SZ_SG_IO_HDR sizeof(sg_io_hdr_t)
216 #define SZ_SG_IOVEC sizeof(sg_iovec_t)
217 #define SZ_SG_REQ_INFO sizeof(sg_req_info_t)
219 static int sg_allow_access(struct file
*filp
, unsigned char *cmd
)
221 struct sg_fd
*sfp
= (struct sg_fd
*)filp
->private_data
;
222 struct request_queue
*q
= sfp
->parentdp
->device
->request_queue
;
224 if (sfp
->parentdp
->device
->type
== TYPE_SCANNER
)
227 return blk_verify_command(&q
->cmd_filter
,
228 cmd
, filp
->f_mode
& FMODE_WRITE
);
232 sg_open(struct inode
*inode
, struct file
*filp
)
234 int dev
= iminor(inode
);
235 int flags
= filp
->f_flags
;
236 struct request_queue
*q
;
243 nonseekable_open(inode
, filp
);
244 SCSI_LOG_TIMEOUT(3, printk("sg_open: dev=%d, flags=0x%x\n", dev
, flags
));
245 sdp
= sg_get_dev(dev
);
247 retval
= PTR_ERR(sdp
);
252 /* This driver's module count bumped by fops_get in <linux/fs.h> */
253 /* Prevent the device driver from vanishing while we sleep */
254 retval
= scsi_device_get(sdp
->device
);
258 if (!((flags
& O_NONBLOCK
) ||
259 scsi_block_when_processing_errors(sdp
->device
))) {
261 /* we are in error recovery for this device */
265 if (flags
& O_EXCL
) {
266 if (O_RDONLY
== (flags
& O_ACCMODE
)) {
267 retval
= -EPERM
; /* Can't lock it with read only access */
270 if (sdp
->headfp
&& (flags
& O_NONBLOCK
)) {
275 __wait_event_interruptible(sdp
->o_excl_wait
,
276 ((sdp
->headfp
|| sdp
->exclude
) ? 0 : (sdp
->exclude
= 1)), res
);
278 retval
= res
; /* -ERESTARTSYS because signal hit process */
281 } else if (sdp
->exclude
) { /* some other fd has an exclusive lock on dev */
282 if (flags
& O_NONBLOCK
) {
287 __wait_event_interruptible(sdp
->o_excl_wait
, (!sdp
->exclude
),
290 retval
= res
; /* -ERESTARTSYS because signal hit process */
298 if (!sdp
->headfp
) { /* no existing opens on this device */
300 q
= sdp
->device
->request_queue
;
301 sdp
->sg_tablesize
= min(q
->max_hw_segments
,
302 q
->max_phys_segments
);
304 if ((sfp
= sg_add_sfp(sdp
, dev
)))
305 filp
->private_data
= sfp
;
307 if (flags
& O_EXCL
) {
308 sdp
->exclude
= 0; /* undo if error */
309 wake_up_interruptible(&sdp
->o_excl_wait
);
317 scsi_device_put(sdp
->device
);
325 /* Following function was formerly called 'sg_close' */
327 sg_release(struct inode
*inode
, struct file
*filp
)
332 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
334 SCSI_LOG_TIMEOUT(3, printk("sg_release: %s\n", sdp
->disk
->disk_name
));
339 wake_up_interruptible(&sdp
->o_excl_wait
);
341 kref_put(&sfp
->f_ref
, sg_remove_sfp
);
346 sg_read(struct file
*filp
, char __user
*buf
, size_t count
, loff_t
* ppos
)
351 int req_pack_id
= -1;
353 struct sg_header
*old_hdr
= NULL
;
356 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
358 SCSI_LOG_TIMEOUT(3, printk("sg_read: %s, count=%d\n",
359 sdp
->disk
->disk_name
, (int) count
));
361 if (!access_ok(VERIFY_WRITE
, buf
, count
))
363 if (sfp
->force_packid
&& (count
>= SZ_SG_HEADER
)) {
364 old_hdr
= kmalloc(SZ_SG_HEADER
, GFP_KERNEL
);
367 if (__copy_from_user(old_hdr
, buf
, SZ_SG_HEADER
)) {
371 if (old_hdr
->reply_len
< 0) {
372 if (count
>= SZ_SG_IO_HDR
) {
373 sg_io_hdr_t
*new_hdr
;
374 new_hdr
= kmalloc(SZ_SG_IO_HDR
, GFP_KERNEL
);
379 retval
=__copy_from_user
380 (new_hdr
, buf
, SZ_SG_IO_HDR
);
381 req_pack_id
= new_hdr
->pack_id
;
389 req_pack_id
= old_hdr
->pack_id
;
391 srp
= sg_get_rq_mark(sfp
, req_pack_id
);
392 if (!srp
) { /* now wait on packet to arrive */
397 if (filp
->f_flags
& O_NONBLOCK
) {
402 retval
= 0; /* following macro beats race condition */
403 __wait_event_interruptible(sfp
->read_wait
,
405 (srp
= sg_get_rq_mark(sfp
, req_pack_id
))),
414 /* -ERESTARTSYS as signal hit process */
418 if (srp
->header
.interface_id
!= '\0') {
419 retval
= sg_new_read(sfp
, buf
, count
, srp
);
424 if (old_hdr
== NULL
) {
425 old_hdr
= kmalloc(SZ_SG_HEADER
, GFP_KERNEL
);
431 memset(old_hdr
, 0, SZ_SG_HEADER
);
432 old_hdr
->reply_len
= (int) hp
->timeout
;
433 old_hdr
->pack_len
= old_hdr
->reply_len
; /* old, strange behaviour */
434 old_hdr
->pack_id
= hp
->pack_id
;
435 old_hdr
->twelve_byte
=
436 ((srp
->data
.cmd_opcode
>= 0xc0) && (12 == hp
->cmd_len
)) ? 1 : 0;
437 old_hdr
->target_status
= hp
->masked_status
;
438 old_hdr
->host_status
= hp
->host_status
;
439 old_hdr
->driver_status
= hp
->driver_status
;
440 if ((CHECK_CONDITION
& hp
->masked_status
) ||
441 (DRIVER_SENSE
& hp
->driver_status
))
442 memcpy(old_hdr
->sense_buffer
, srp
->sense_b
,
443 sizeof (old_hdr
->sense_buffer
));
444 switch (hp
->host_status
) {
445 /* This setup of 'result' is for backward compatibility and is best
446 ignored by the user who should use target, host + driver status */
448 case DID_PASSTHROUGH
:
455 old_hdr
->result
= EBUSY
;
462 old_hdr
->result
= EIO
;
465 old_hdr
->result
= (srp
->sense_b
[0] == 0 &&
466 hp
->masked_status
== GOOD
) ? 0 : EIO
;
469 old_hdr
->result
= EIO
;
473 /* Now copy the result back to the user buffer. */
474 if (count
>= SZ_SG_HEADER
) {
475 if (__copy_to_user(buf
, old_hdr
, SZ_SG_HEADER
)) {
480 if (count
> old_hdr
->reply_len
)
481 count
= old_hdr
->reply_len
;
482 if (count
> SZ_SG_HEADER
) {
483 if (sg_read_oxfer(srp
, buf
, count
- SZ_SG_HEADER
)) {
489 count
= (old_hdr
->result
== 0) ? 0 : -EIO
;
490 sg_finish_rem_req(srp
);
498 sg_new_read(Sg_fd
* sfp
, char __user
*buf
, size_t count
, Sg_request
* srp
)
500 sg_io_hdr_t
*hp
= &srp
->header
;
504 if (count
< SZ_SG_IO_HDR
) {
509 if ((hp
->mx_sb_len
> 0) && hp
->sbp
) {
510 if ((CHECK_CONDITION
& hp
->masked_status
) ||
511 (DRIVER_SENSE
& hp
->driver_status
)) {
512 int sb_len
= SCSI_SENSE_BUFFERSIZE
;
513 sb_len
= (hp
->mx_sb_len
> sb_len
) ? sb_len
: hp
->mx_sb_len
;
514 len
= 8 + (int) srp
->sense_b
[7]; /* Additional sense length field */
515 len
= (len
> sb_len
) ? sb_len
: len
;
516 if (copy_to_user(hp
->sbp
, srp
->sense_b
, len
)) {
523 if (hp
->masked_status
|| hp
->host_status
|| hp
->driver_status
)
524 hp
->info
|= SG_INFO_CHECK
;
525 if (copy_to_user(buf
, hp
, SZ_SG_IO_HDR
)) {
530 sg_finish_rem_req(srp
);
531 return (0 == err
) ? count
: err
;
535 sg_write(struct file
*filp
, const char __user
*buf
, size_t count
, loff_t
* ppos
)
537 int mxsize
, cmd_size
, k
;
538 int input_size
, blocking
;
539 unsigned char opcode
;
543 struct sg_header old_hdr
;
545 unsigned char cmnd
[MAX_COMMAND_SIZE
];
547 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
549 SCSI_LOG_TIMEOUT(3, printk("sg_write: %s, count=%d\n",
550 sdp
->disk
->disk_name
, (int) count
));
553 if (!((filp
->f_flags
& O_NONBLOCK
) ||
554 scsi_block_when_processing_errors(sdp
->device
)))
557 if (!access_ok(VERIFY_READ
, buf
, count
))
558 return -EFAULT
; /* protects following copy_from_user()s + get_user()s */
559 if (count
< SZ_SG_HEADER
)
561 if (__copy_from_user(&old_hdr
, buf
, SZ_SG_HEADER
))
563 blocking
= !(filp
->f_flags
& O_NONBLOCK
);
564 if (old_hdr
.reply_len
< 0)
565 return sg_new_write(sfp
, filp
, buf
, count
,
566 blocking
, 0, 0, NULL
);
567 if (count
< (SZ_SG_HEADER
+ 6))
568 return -EIO
; /* The minimum scsi command length is 6 bytes. */
570 if (!(srp
= sg_add_request(sfp
))) {
571 SCSI_LOG_TIMEOUT(1, printk("sg_write: queue full\n"));
575 __get_user(opcode
, buf
);
576 if (sfp
->next_cmd_len
> 0) {
577 if (sfp
->next_cmd_len
> MAX_COMMAND_SIZE
) {
578 SCSI_LOG_TIMEOUT(1, printk("sg_write: command length too long\n"));
579 sfp
->next_cmd_len
= 0;
580 sg_remove_request(sfp
, srp
);
583 cmd_size
= sfp
->next_cmd_len
;
584 sfp
->next_cmd_len
= 0; /* reset so only this write() effected */
586 cmd_size
= COMMAND_SIZE(opcode
); /* based on SCSI command group */
587 if ((opcode
>= 0xc0) && old_hdr
.twelve_byte
)
590 SCSI_LOG_TIMEOUT(4, printk(
591 "sg_write: scsi opcode=0x%02x, cmd_size=%d\n", (int) opcode
, cmd_size
));
592 /* Determine buffer size. */
593 input_size
= count
- cmd_size
;
594 mxsize
= (input_size
> old_hdr
.reply_len
) ? input_size
: old_hdr
.reply_len
;
595 mxsize
-= SZ_SG_HEADER
;
596 input_size
-= SZ_SG_HEADER
;
597 if (input_size
< 0) {
598 sg_remove_request(sfp
, srp
);
599 return -EIO
; /* User did not pass enough bytes for this command. */
602 hp
->interface_id
= '\0'; /* indicator of old interface tunnelled */
603 hp
->cmd_len
= (unsigned char) cmd_size
;
607 hp
->dxfer_direction
= (old_hdr
.reply_len
> SZ_SG_HEADER
) ?
608 SG_DXFER_TO_FROM_DEV
: SG_DXFER_TO_DEV
;
610 hp
->dxfer_direction
= (mxsize
> 0) ? SG_DXFER_FROM_DEV
: SG_DXFER_NONE
;
611 hp
->dxfer_len
= mxsize
;
612 if (hp
->dxfer_direction
== SG_DXFER_TO_DEV
)
613 hp
->dxferp
= (char __user
*)buf
+ cmd_size
;
617 hp
->timeout
= old_hdr
.reply_len
; /* structure abuse ... */
618 hp
->flags
= input_size
; /* structure abuse ... */
619 hp
->pack_id
= old_hdr
.pack_id
;
621 if (__copy_from_user(cmnd
, buf
, cmd_size
))
624 * SG_DXFER_TO_FROM_DEV is functionally equivalent to SG_DXFER_FROM_DEV,
625 * but is is possible that the app intended SG_DXFER_TO_DEV, because there
626 * is a non-zero input_size, so emit a warning.
628 if (hp
->dxfer_direction
== SG_DXFER_TO_FROM_DEV
) {
629 static char cmd
[TASK_COMM_LEN
];
630 if (strcmp(current
->comm
, cmd
) && printk_ratelimit()) {
632 "sg_write: data in/out %d/%d bytes for SCSI command 0x%x--"
633 "guessing data in;\n" KERN_WARNING
" "
634 "program %s not setting count and/or reply_len properly\n",
635 old_hdr
.reply_len
- (int)SZ_SG_HEADER
,
636 input_size
, (unsigned int) cmnd
[0],
638 strcpy(cmd
, current
->comm
);
641 k
= sg_common_write(sfp
, srp
, cmnd
, sfp
->timeout
, blocking
);
642 return (k
< 0) ? k
: count
;
646 sg_new_write(Sg_fd
*sfp
, struct file
*file
, const char __user
*buf
,
647 size_t count
, int blocking
, int read_only
, int sg_io_owned
,
653 unsigned char cmnd
[MAX_COMMAND_SIZE
];
655 unsigned long ul_timeout
;
657 if (count
< SZ_SG_IO_HDR
)
659 if (!access_ok(VERIFY_READ
, buf
, count
))
660 return -EFAULT
; /* protects following copy_from_user()s + get_user()s */
662 sfp
->cmd_q
= 1; /* when sg_io_hdr seen, set command queuing on */
663 if (!(srp
= sg_add_request(sfp
))) {
664 SCSI_LOG_TIMEOUT(1, printk("sg_new_write: queue full\n"));
667 srp
->sg_io_owned
= sg_io_owned
;
669 if (__copy_from_user(hp
, buf
, SZ_SG_IO_HDR
)) {
670 sg_remove_request(sfp
, srp
);
673 if (hp
->interface_id
!= 'S') {
674 sg_remove_request(sfp
, srp
);
677 if (hp
->flags
& SG_FLAG_MMAP_IO
) {
678 if (hp
->dxfer_len
> sfp
->reserve
.bufflen
) {
679 sg_remove_request(sfp
, srp
);
680 return -ENOMEM
; /* MMAP_IO size must fit in reserve buffer */
682 if (hp
->flags
& SG_FLAG_DIRECT_IO
) {
683 sg_remove_request(sfp
, srp
);
684 return -EINVAL
; /* either MMAP_IO or DIRECT_IO (not both) */
686 if (sg_res_in_use(sfp
)) {
687 sg_remove_request(sfp
, srp
);
688 return -EBUSY
; /* reserve buffer already being used */
691 ul_timeout
= msecs_to_jiffies(srp
->header
.timeout
);
692 timeout
= (ul_timeout
< INT_MAX
) ? ul_timeout
: INT_MAX
;
693 if ((!hp
->cmdp
) || (hp
->cmd_len
< 6) || (hp
->cmd_len
> sizeof (cmnd
))) {
694 sg_remove_request(sfp
, srp
);
697 if (!access_ok(VERIFY_READ
, hp
->cmdp
, hp
->cmd_len
)) {
698 sg_remove_request(sfp
, srp
);
699 return -EFAULT
; /* protects following copy_from_user()s + get_user()s */
701 if (__copy_from_user(cmnd
, hp
->cmdp
, hp
->cmd_len
)) {
702 sg_remove_request(sfp
, srp
);
705 if (read_only
&& sg_allow_access(file
, cmnd
)) {
706 sg_remove_request(sfp
, srp
);
709 k
= sg_common_write(sfp
, srp
, cmnd
, timeout
, blocking
);
718 sg_common_write(Sg_fd
* sfp
, Sg_request
* srp
,
719 unsigned char *cmnd
, int timeout
, int blocking
)
722 Sg_device
*sdp
= sfp
->parentdp
;
723 sg_io_hdr_t
*hp
= &srp
->header
;
725 srp
->data
.cmd_opcode
= cmnd
[0]; /* hold opcode of command */
727 hp
->masked_status
= 0;
731 hp
->driver_status
= 0;
733 SCSI_LOG_TIMEOUT(4, printk("sg_common_write: scsi opcode=0x%02x, cmd_size=%d\n",
734 (int) cmnd
[0], (int) hp
->cmd_len
));
736 k
= sg_start_req(srp
, cmnd
);
738 SCSI_LOG_TIMEOUT(1, printk("sg_common_write: start_req err=%d\n", k
));
739 sg_finish_rem_req(srp
);
740 return k
; /* probably out of space --> ENOMEM */
743 sg_finish_rem_req(srp
);
747 switch (hp
->dxfer_direction
) {
748 case SG_DXFER_TO_FROM_DEV
:
749 case SG_DXFER_FROM_DEV
:
750 data_dir
= DMA_FROM_DEVICE
;
752 case SG_DXFER_TO_DEV
:
753 data_dir
= DMA_TO_DEVICE
;
755 case SG_DXFER_UNKNOWN
:
756 data_dir
= DMA_BIDIRECTIONAL
;
762 hp
->duration
= jiffies_to_msecs(jiffies
);
764 srp
->rq
->timeout
= timeout
;
765 kref_get(&sfp
->f_ref
); /* sg_rq_end_io() does kref_put(). */
766 blk_execute_rq_nowait(sdp
->device
->request_queue
, sdp
->disk
,
767 srp
->rq
, 1, sg_rq_end_io
);
772 sg_ioctl(struct inode
*inode
, struct file
*filp
,
773 unsigned int cmd_in
, unsigned long arg
)
775 void __user
*p
= (void __user
*)arg
;
777 int result
, val
, read_only
;
781 unsigned long iflags
;
783 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
786 SCSI_LOG_TIMEOUT(3, printk("sg_ioctl: %s, cmd=0x%x\n",
787 sdp
->disk
->disk_name
, (int) cmd_in
));
788 read_only
= (O_RDWR
!= (filp
->f_flags
& O_ACCMODE
));
793 int blocking
= 1; /* ignore O_NONBLOCK flag */
797 if (!scsi_block_when_processing_errors(sdp
->device
))
799 if (!access_ok(VERIFY_WRITE
, p
, SZ_SG_IO_HDR
))
802 sg_new_write(sfp
, filp
, p
, SZ_SG_IO_HDR
,
803 blocking
, read_only
, 1, &srp
);
807 result
= 0; /* following macro to beat race condition */
808 __wait_event_interruptible(sfp
->read_wait
,
809 (srp
->done
|| sdp
->detached
),
813 write_lock_irq(&sfp
->rq_list_lock
);
816 write_unlock_irq(&sfp
->rq_list_lock
);
820 write_unlock_irq(&sfp
->rq_list_lock
);
821 return result
; /* -ERESTARTSYS because signal hit process */
823 result
= sg_new_read(sfp
, p
, SZ_SG_IO_HDR
, srp
);
824 return (result
< 0) ? result
: 0;
827 result
= get_user(val
, ip
);
832 if (val
>= MULDIV (INT_MAX
, USER_HZ
, HZ
))
833 val
= MULDIV (INT_MAX
, USER_HZ
, HZ
);
834 sfp
->timeout_user
= val
;
835 sfp
->timeout
= MULDIV (val
, HZ
, USER_HZ
);
838 case SG_GET_TIMEOUT
: /* N.B. User receives timeout as return value */
839 /* strange ..., for backward compatibility */
840 return sfp
->timeout_user
;
841 case SG_SET_FORCE_LOW_DMA
:
842 result
= get_user(val
, ip
);
847 if ((0 == sfp
->low_dma
) && (0 == sg_res_in_use(sfp
))) {
848 val
= (int) sfp
->reserve
.bufflen
;
849 sg_remove_scat(&sfp
->reserve
);
850 sg_build_reserve(sfp
, val
);
855 sfp
->low_dma
= sdp
->device
->host
->unchecked_isa_dma
;
859 return put_user((int) sfp
->low_dma
, ip
);
861 if (!access_ok(VERIFY_WRITE
, p
, sizeof (sg_scsi_id_t
)))
864 sg_scsi_id_t __user
*sg_idp
= p
;
868 __put_user((int) sdp
->device
->host
->host_no
,
870 __put_user((int) sdp
->device
->channel
,
872 __put_user((int) sdp
->device
->id
, &sg_idp
->scsi_id
);
873 __put_user((int) sdp
->device
->lun
, &sg_idp
->lun
);
874 __put_user((int) sdp
->device
->type
, &sg_idp
->scsi_type
);
875 __put_user((short) sdp
->device
->host
->cmd_per_lun
,
876 &sg_idp
->h_cmd_per_lun
);
877 __put_user((short) sdp
->device
->queue_depth
,
878 &sg_idp
->d_queue_depth
);
879 __put_user(0, &sg_idp
->unused
[0]);
880 __put_user(0, &sg_idp
->unused
[1]);
883 case SG_SET_FORCE_PACK_ID
:
884 result
= get_user(val
, ip
);
887 sfp
->force_packid
= val
? 1 : 0;
890 if (!access_ok(VERIFY_WRITE
, ip
, sizeof (int)))
892 read_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
893 for (srp
= sfp
->headrp
; srp
; srp
= srp
->nextrp
) {
894 if ((1 == srp
->done
) && (!srp
->sg_io_owned
)) {
895 read_unlock_irqrestore(&sfp
->rq_list_lock
,
897 __put_user(srp
->header
.pack_id
, ip
);
901 read_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
904 case SG_GET_NUM_WAITING
:
905 read_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
906 for (val
= 0, srp
= sfp
->headrp
; srp
; srp
= srp
->nextrp
) {
907 if ((1 == srp
->done
) && (!srp
->sg_io_owned
))
910 read_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
911 return put_user(val
, ip
);
912 case SG_GET_SG_TABLESIZE
:
913 return put_user(sdp
->sg_tablesize
, ip
);
914 case SG_SET_RESERVED_SIZE
:
915 result
= get_user(val
, ip
);
920 val
= min_t(int, val
,
921 sdp
->device
->request_queue
->max_sectors
* 512);
922 if (val
!= sfp
->reserve
.bufflen
) {
923 if (sg_res_in_use(sfp
) || sfp
->mmap_called
)
925 sg_remove_scat(&sfp
->reserve
);
926 sg_build_reserve(sfp
, val
);
929 case SG_GET_RESERVED_SIZE
:
930 val
= min_t(int, sfp
->reserve
.bufflen
,
931 sdp
->device
->request_queue
->max_sectors
* 512);
932 return put_user(val
, ip
);
933 case SG_SET_COMMAND_Q
:
934 result
= get_user(val
, ip
);
937 sfp
->cmd_q
= val
? 1 : 0;
939 case SG_GET_COMMAND_Q
:
940 return put_user((int) sfp
->cmd_q
, ip
);
941 case SG_SET_KEEP_ORPHAN
:
942 result
= get_user(val
, ip
);
945 sfp
->keep_orphan
= val
;
947 case SG_GET_KEEP_ORPHAN
:
948 return put_user((int) sfp
->keep_orphan
, ip
);
949 case SG_NEXT_CMD_LEN
:
950 result
= get_user(val
, ip
);
953 sfp
->next_cmd_len
= (val
> 0) ? val
: 0;
955 case SG_GET_VERSION_NUM
:
956 return put_user(sg_version_num
, ip
);
957 case SG_GET_ACCESS_COUNT
:
958 /* faked - we don't have a real access count anymore */
959 val
= (sdp
->device
? 1 : 0);
960 return put_user(val
, ip
);
961 case SG_GET_REQUEST_TABLE
:
962 if (!access_ok(VERIFY_WRITE
, p
, SZ_SG_REQ_INFO
* SG_MAX_QUEUE
))
965 sg_req_info_t
*rinfo
;
968 rinfo
= kmalloc(SZ_SG_REQ_INFO
* SG_MAX_QUEUE
,
972 read_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
973 for (srp
= sfp
->headrp
, val
= 0; val
< SG_MAX_QUEUE
;
974 ++val
, srp
= srp
? srp
->nextrp
: srp
) {
975 memset(&rinfo
[val
], 0, SZ_SG_REQ_INFO
);
977 rinfo
[val
].req_state
= srp
->done
+ 1;
979 srp
->header
.masked_status
&
980 srp
->header
.host_status
&
981 srp
->header
.driver_status
;
983 rinfo
[val
].duration
=
984 srp
->header
.duration
;
986 ms
= jiffies_to_msecs(jiffies
);
987 rinfo
[val
].duration
=
988 (ms
> srp
->header
.duration
) ?
989 (ms
- srp
->header
.duration
) : 0;
991 rinfo
[val
].orphan
= srp
->orphan
;
992 rinfo
[val
].sg_io_owned
=
1000 read_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
1001 result
= __copy_to_user(p
, rinfo
,
1002 SZ_SG_REQ_INFO
* SG_MAX_QUEUE
);
1003 result
= result
? -EFAULT
: 0;
1007 case SG_EMULATED_HOST
:
1010 return put_user(sdp
->device
->host
->hostt
->emulated
, ip
);
1014 if (filp
->f_flags
& O_NONBLOCK
) {
1015 if (scsi_host_in_recovery(sdp
->device
->host
))
1017 } else if (!scsi_block_when_processing_errors(sdp
->device
))
1019 result
= get_user(val
, ip
);
1022 if (SG_SCSI_RESET_NOTHING
== val
)
1025 case SG_SCSI_RESET_DEVICE
:
1026 val
= SCSI_TRY_RESET_DEVICE
;
1028 case SG_SCSI_RESET_TARGET
:
1029 val
= SCSI_TRY_RESET_TARGET
;
1031 case SG_SCSI_RESET_BUS
:
1032 val
= SCSI_TRY_RESET_BUS
;
1034 case SG_SCSI_RESET_HOST
:
1035 val
= SCSI_TRY_RESET_HOST
;
1040 if (!capable(CAP_SYS_ADMIN
) || !capable(CAP_SYS_RAWIO
))
1042 return (scsi_reset_provider(sdp
->device
, val
) ==
1043 SUCCESS
) ? 0 : -EIO
;
1044 case SCSI_IOCTL_SEND_COMMAND
:
1048 unsigned char opcode
= WRITE_6
;
1049 Scsi_Ioctl_Command __user
*siocp
= p
;
1051 if (copy_from_user(&opcode
, siocp
->data
, 1))
1053 if (sg_allow_access(filp
, &opcode
))
1056 return sg_scsi_ioctl(sdp
->device
->request_queue
, NULL
, filp
->f_mode
, p
);
1058 result
= get_user(val
, ip
);
1061 sdp
->sgdebug
= (char) val
;
1063 case SCSI_IOCTL_GET_IDLUN
:
1064 case SCSI_IOCTL_GET_BUS_NUMBER
:
1065 case SCSI_IOCTL_PROBE_HOST
:
1066 case SG_GET_TRANSFORM
:
1069 return scsi_ioctl(sdp
->device
, cmd_in
, p
);
1071 return put_user(sdp
->device
->request_queue
->max_sectors
* 512,
1074 return blk_trace_setup(sdp
->device
->request_queue
,
1075 sdp
->disk
->disk_name
,
1076 MKDEV(SCSI_GENERIC_MAJOR
, sdp
->index
),
1079 return blk_trace_startstop(sdp
->device
->request_queue
, 1);
1081 return blk_trace_startstop(sdp
->device
->request_queue
, 0);
1082 case BLKTRACETEARDOWN
:
1083 return blk_trace_remove(sdp
->device
->request_queue
);
1086 return -EPERM
; /* don't know so take safe approach */
1087 return scsi_ioctl(sdp
->device
, cmd_in
, p
);
1091 #ifdef CONFIG_COMPAT
1092 static long sg_compat_ioctl(struct file
*filp
, unsigned int cmd_in
, unsigned long arg
)
1096 struct scsi_device
*sdev
;
1098 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
1102 if (sdev
->host
->hostt
->compat_ioctl
) {
1105 ret
= sdev
->host
->hostt
->compat_ioctl(sdev
, cmd_in
, (void __user
*)arg
);
1110 return -ENOIOCTLCMD
;
1115 sg_poll(struct file
*filp
, poll_table
* wait
)
1117 unsigned int res
= 0;
1122 unsigned long iflags
;
1124 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
))
1127 poll_wait(filp
, &sfp
->read_wait
, wait
);
1128 read_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
1129 for (srp
= sfp
->headrp
; srp
; srp
= srp
->nextrp
) {
1130 /* if any read waiting, flag it */
1131 if ((0 == res
) && (1 == srp
->done
) && (!srp
->sg_io_owned
))
1132 res
= POLLIN
| POLLRDNORM
;
1135 read_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
1139 else if (!sfp
->cmd_q
) {
1141 res
|= POLLOUT
| POLLWRNORM
;
1142 } else if (count
< SG_MAX_QUEUE
)
1143 res
|= POLLOUT
| POLLWRNORM
;
1144 SCSI_LOG_TIMEOUT(3, printk("sg_poll: %s, res=0x%x\n",
1145 sdp
->disk
->disk_name
, (int) res
));
1150 sg_fasync(int fd
, struct file
*filp
, int mode
)
1156 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
1158 SCSI_LOG_TIMEOUT(3, printk("sg_fasync: %s, mode=%d\n",
1159 sdp
->disk
->disk_name
, mode
));
1161 retval
= fasync_helper(fd
, filp
, mode
, &sfp
->async_qp
);
1162 return (retval
< 0) ? retval
: 0;
1166 sg_vma_fault(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
1169 unsigned long offset
, len
, sa
;
1170 Sg_scatter_hold
*rsv_schp
;
1173 if ((NULL
== vma
) || (!(sfp
= (Sg_fd
*) vma
->vm_private_data
)))
1174 return VM_FAULT_SIGBUS
;
1175 rsv_schp
= &sfp
->reserve
;
1176 offset
= vmf
->pgoff
<< PAGE_SHIFT
;
1177 if (offset
>= rsv_schp
->bufflen
)
1178 return VM_FAULT_SIGBUS
;
1179 SCSI_LOG_TIMEOUT(3, printk("sg_vma_fault: offset=%lu, scatg=%d\n",
1180 offset
, rsv_schp
->k_use_sg
));
1182 length
= 1 << (PAGE_SHIFT
+ rsv_schp
->page_order
);
1183 for (k
= 0; k
< rsv_schp
->k_use_sg
&& sa
< vma
->vm_end
; k
++) {
1184 len
= vma
->vm_end
- sa
;
1185 len
= (len
< length
) ? len
: length
;
1187 struct page
*page
= nth_page(rsv_schp
->pages
[k
],
1188 offset
>> PAGE_SHIFT
);
1189 get_page(page
); /* increment page count */
1191 return 0; /* success */
1197 return VM_FAULT_SIGBUS
;
1200 static struct vm_operations_struct sg_mmap_vm_ops
= {
1201 .fault
= sg_vma_fault
,
1205 sg_mmap(struct file
*filp
, struct vm_area_struct
*vma
)
1208 unsigned long req_sz
, len
, sa
;
1209 Sg_scatter_hold
*rsv_schp
;
1212 if ((!filp
) || (!vma
) || (!(sfp
= (Sg_fd
*) filp
->private_data
)))
1214 req_sz
= vma
->vm_end
- vma
->vm_start
;
1215 SCSI_LOG_TIMEOUT(3, printk("sg_mmap starting, vm_start=%p, len=%d\n",
1216 (void *) vma
->vm_start
, (int) req_sz
));
1218 return -EINVAL
; /* want no offset */
1219 rsv_schp
= &sfp
->reserve
;
1220 if (req_sz
> rsv_schp
->bufflen
)
1221 return -ENOMEM
; /* cannot map more than reserved buffer */
1224 length
= 1 << (PAGE_SHIFT
+ rsv_schp
->page_order
);
1225 for (k
= 0; k
< rsv_schp
->k_use_sg
&& sa
< vma
->vm_end
; k
++) {
1226 len
= vma
->vm_end
- sa
;
1227 len
= (len
< length
) ? len
: length
;
1231 sfp
->mmap_called
= 1;
1232 vma
->vm_flags
|= VM_RESERVED
;
1233 vma
->vm_private_data
= sfp
;
1234 vma
->vm_ops
= &sg_mmap_vm_ops
;
1238 static void sg_rq_end_io_usercontext(struct work_struct
*work
)
1240 struct sg_request
*srp
= container_of(work
, struct sg_request
, ew
.work
);
1241 struct sg_fd
*sfp
= srp
->parentfp
;
1243 sg_finish_rem_req(srp
);
1244 kref_put(&sfp
->f_ref
, sg_remove_sfp
);
1248 * This function is a "bottom half" handler that is called by the mid
1249 * level when a command is completed (or has failed).
1251 static void sg_rq_end_io(struct request
*rq
, int uptodate
)
1253 struct sg_request
*srp
= rq
->end_io_data
;
1256 unsigned long iflags
;
1259 int result
, resid
, done
= 1;
1261 if (WARN_ON(srp
->done
!= 0))
1264 sfp
= srp
->parentfp
;
1265 if (WARN_ON(sfp
== NULL
))
1268 sdp
= sfp
->parentdp
;
1269 if (unlikely(sdp
->detached
))
1270 printk(KERN_INFO
"sg_rq_end_io: device detached\n");
1273 result
= rq
->errors
;
1274 resid
= rq
->data_len
;
1276 SCSI_LOG_TIMEOUT(4, printk("sg_cmd_done: %s, pack_id=%d, res=0x%x\n",
1277 sdp
->disk
->disk_name
, srp
->header
.pack_id
, result
));
1278 srp
->header
.resid
= resid
;
1279 ms
= jiffies_to_msecs(jiffies
);
1280 srp
->header
.duration
= (ms
> srp
->header
.duration
) ?
1281 (ms
- srp
->header
.duration
) : 0;
1283 struct scsi_sense_hdr sshdr
;
1285 srp
->header
.status
= 0xff & result
;
1286 srp
->header
.masked_status
= status_byte(result
);
1287 srp
->header
.msg_status
= msg_byte(result
);
1288 srp
->header
.host_status
= host_byte(result
);
1289 srp
->header
.driver_status
= driver_byte(result
);
1290 if ((sdp
->sgdebug
> 0) &&
1291 ((CHECK_CONDITION
== srp
->header
.masked_status
) ||
1292 (COMMAND_TERMINATED
== srp
->header
.masked_status
)))
1293 __scsi_print_sense("sg_cmd_done", sense
,
1294 SCSI_SENSE_BUFFERSIZE
);
1296 /* Following if statement is a patch supplied by Eric Youngdale */
1297 if (driver_byte(result
) != 0
1298 && scsi_normalize_sense(sense
, SCSI_SENSE_BUFFERSIZE
, &sshdr
)
1299 && !scsi_sense_is_deferred(&sshdr
)
1300 && sshdr
.sense_key
== UNIT_ATTENTION
1301 && sdp
->device
->removable
) {
1302 /* Detected possible disc change. Set the bit - this */
1303 /* may be used if there are filesystems using this device */
1304 sdp
->device
->changed
= 1;
1307 /* Rely on write phase to clean out srp status values, so no "else" */
1309 write_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
1310 if (unlikely(srp
->orphan
)) {
1311 if (sfp
->keep_orphan
)
1312 srp
->sg_io_owned
= 0;
1317 write_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
1320 /* Now wake up any sg_read() that is waiting for this
1323 wake_up_interruptible(&sfp
->read_wait
);
1324 kill_fasync(&sfp
->async_qp
, SIGPOLL
, POLL_IN
);
1325 kref_put(&sfp
->f_ref
, sg_remove_sfp
);
1327 INIT_WORK(&srp
->ew
.work
, sg_rq_end_io_usercontext
);
1328 schedule_work(&srp
->ew
.work
);
1332 static struct file_operations sg_fops
= {
1333 .owner
= THIS_MODULE
,
1338 #ifdef CONFIG_COMPAT
1339 .compat_ioctl
= sg_compat_ioctl
,
1343 .release
= sg_release
,
1344 .fasync
= sg_fasync
,
1347 static struct class *sg_sysfs_class
;
1349 static int sg_sysfs_valid
= 0;
1351 static Sg_device
*sg_alloc(struct gendisk
*disk
, struct scsi_device
*scsidp
)
1353 struct request_queue
*q
= scsidp
->request_queue
;
1355 unsigned long iflags
;
1359 sdp
= kzalloc(sizeof(Sg_device
), GFP_KERNEL
);
1361 printk(KERN_WARNING
"kmalloc Sg_device failure\n");
1362 return ERR_PTR(-ENOMEM
);
1365 if (!idr_pre_get(&sg_index_idr
, GFP_KERNEL
)) {
1366 printk(KERN_WARNING
"idr expansion Sg_device failure\n");
1371 write_lock_irqsave(&sg_index_lock
, iflags
);
1373 error
= idr_get_new(&sg_index_idr
, sdp
, &k
);
1375 write_unlock_irqrestore(&sg_index_lock
, iflags
);
1376 printk(KERN_WARNING
"idr allocation Sg_device failure: %d\n",
1381 if (unlikely(k
>= SG_MAX_DEVS
))
1384 SCSI_LOG_TIMEOUT(3, printk("sg_alloc: dev=%d \n", k
));
1385 sprintf(disk
->disk_name
, "sg%d", k
);
1386 disk
->first_minor
= k
;
1388 sdp
->device
= scsidp
;
1389 init_waitqueue_head(&sdp
->o_excl_wait
);
1390 sdp
->sg_tablesize
= min(q
->max_hw_segments
, q
->max_phys_segments
);
1392 kref_init(&sdp
->d_ref
);
1394 write_unlock_irqrestore(&sg_index_lock
, iflags
);
1400 return ERR_PTR(error
);
1405 idr_remove(&sg_index_idr
, k
);
1406 write_unlock_irqrestore(&sg_index_lock
, iflags
);
1407 sdev_printk(KERN_WARNING
, scsidp
,
1408 "Unable to attach sg device type=%d, minor "
1409 "number exceeds %d\n", scsidp
->type
, SG_MAX_DEVS
- 1);
1415 sg_add(struct device
*cl_dev
, struct class_interface
*cl_intf
)
1417 struct scsi_device
*scsidp
= to_scsi_device(cl_dev
->parent
);
1418 struct gendisk
*disk
;
1419 Sg_device
*sdp
= NULL
;
1420 struct cdev
* cdev
= NULL
;
1422 unsigned long iflags
;
1424 disk
= alloc_disk(1);
1426 printk(KERN_WARNING
"alloc_disk failed\n");
1429 disk
->major
= SCSI_GENERIC_MAJOR
;
1432 cdev
= cdev_alloc();
1434 printk(KERN_WARNING
"cdev_alloc failed\n");
1437 cdev
->owner
= THIS_MODULE
;
1438 cdev
->ops
= &sg_fops
;
1440 sdp
= sg_alloc(disk
, scsidp
);
1442 printk(KERN_WARNING
"sg_alloc failed\n");
1443 error
= PTR_ERR(sdp
);
1447 error
= cdev_add(cdev
, MKDEV(SCSI_GENERIC_MAJOR
, sdp
->index
), 1);
1452 if (sg_sysfs_valid
) {
1453 struct device
*sg_class_member
;
1455 sg_class_member
= device_create(sg_sysfs_class
, cl_dev
->parent
,
1456 MKDEV(SCSI_GENERIC_MAJOR
,
1458 sdp
, "%s", disk
->disk_name
);
1459 if (IS_ERR(sg_class_member
)) {
1460 printk(KERN_ERR
"sg_add: "
1461 "device_create failed\n");
1462 error
= PTR_ERR(sg_class_member
);
1465 error
= sysfs_create_link(&scsidp
->sdev_gendev
.kobj
,
1466 &sg_class_member
->kobj
, "generic");
1468 printk(KERN_ERR
"sg_add: unable to make symlink "
1469 "'generic' back to sg%d\n", sdp
->index
);
1471 printk(KERN_WARNING
"sg_add: sg_sys Invalid\n");
1473 sdev_printk(KERN_NOTICE
, scsidp
,
1474 "Attached scsi generic sg%d type %d\n", sdp
->index
,
1477 dev_set_drvdata(cl_dev
, sdp
);
1482 write_lock_irqsave(&sg_index_lock
, iflags
);
1483 idr_remove(&sg_index_idr
, sdp
->index
);
1484 write_unlock_irqrestore(&sg_index_lock
, iflags
);
1494 static void sg_device_destroy(struct kref
*kref
)
1496 struct sg_device
*sdp
= container_of(kref
, struct sg_device
, d_ref
);
1497 unsigned long flags
;
1499 /* CAUTION! Note that the device can still be found via idr_find()
1500 * even though the refcount is 0. Therefore, do idr_remove() BEFORE
1501 * any other cleanup.
1504 write_lock_irqsave(&sg_index_lock
, flags
);
1505 idr_remove(&sg_index_idr
, sdp
->index
);
1506 write_unlock_irqrestore(&sg_index_lock
, flags
);
1509 printk("sg_device_destroy: %s\n",
1510 sdp
->disk
->disk_name
));
1512 put_disk(sdp
->disk
);
1516 static void sg_remove(struct device
*cl_dev
, struct class_interface
*cl_intf
)
1518 struct scsi_device
*scsidp
= to_scsi_device(cl_dev
->parent
);
1519 Sg_device
*sdp
= dev_get_drvdata(cl_dev
);
1520 unsigned long iflags
;
1523 if (!sdp
|| sdp
->detached
)
1526 SCSI_LOG_TIMEOUT(3, printk("sg_remove: %s\n", sdp
->disk
->disk_name
));
1528 /* Need a write lock to set sdp->detached. */
1529 write_lock_irqsave(&sg_index_lock
, iflags
);
1531 for (sfp
= sdp
->headfp
; sfp
; sfp
= sfp
->nextfp
) {
1532 wake_up_interruptible(&sfp
->read_wait
);
1533 kill_fasync(&sfp
->async_qp
, SIGPOLL
, POLL_HUP
);
1535 write_unlock_irqrestore(&sg_index_lock
, iflags
);
1537 sysfs_remove_link(&scsidp
->sdev_gendev
.kobj
, "generic");
1538 device_destroy(sg_sysfs_class
, MKDEV(SCSI_GENERIC_MAJOR
, sdp
->index
));
1539 cdev_del(sdp
->cdev
);
1545 module_param_named(scatter_elem_sz
, scatter_elem_sz
, int, S_IRUGO
| S_IWUSR
);
1546 module_param_named(def_reserved_size
, def_reserved_size
, int,
1548 module_param_named(allow_dio
, sg_allow_dio
, int, S_IRUGO
| S_IWUSR
);
1550 MODULE_AUTHOR("Douglas Gilbert");
1551 MODULE_DESCRIPTION("SCSI generic (sg) driver");
1552 MODULE_LICENSE("GPL");
1553 MODULE_VERSION(SG_VERSION_STR
);
1554 MODULE_ALIAS_CHARDEV_MAJOR(SCSI_GENERIC_MAJOR
);
1556 MODULE_PARM_DESC(scatter_elem_sz
, "scatter gather element "
1557 "size (default: max(SG_SCATTER_SZ, PAGE_SIZE))");
1558 MODULE_PARM_DESC(def_reserved_size
, "size of buffer reserved for each fd");
1559 MODULE_PARM_DESC(allow_dio
, "allow direct I/O (default: 0 (disallow))");
1566 if (scatter_elem_sz
< PAGE_SIZE
) {
1567 scatter_elem_sz
= PAGE_SIZE
;
1568 scatter_elem_sz_prev
= scatter_elem_sz
;
1570 if (def_reserved_size
>= 0)
1571 sg_big_buff
= def_reserved_size
;
1573 def_reserved_size
= sg_big_buff
;
1575 rc
= register_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR
, 0),
1579 sg_sysfs_class
= class_create(THIS_MODULE
, "scsi_generic");
1580 if ( IS_ERR(sg_sysfs_class
) ) {
1581 rc
= PTR_ERR(sg_sysfs_class
);
1585 rc
= scsi_register_interface(&sg_interface
);
1587 #ifdef CONFIG_SCSI_PROC_FS
1589 #endif /* CONFIG_SCSI_PROC_FS */
1592 class_destroy(sg_sysfs_class
);
1594 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR
, 0), SG_MAX_DEVS
);
1601 #ifdef CONFIG_SCSI_PROC_FS
1603 #endif /* CONFIG_SCSI_PROC_FS */
1604 scsi_unregister_interface(&sg_interface
);
1605 class_destroy(sg_sysfs_class
);
1607 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR
, 0),
1609 idr_destroy(&sg_index_idr
);
1612 static int sg_start_req(Sg_request
*srp
, unsigned char *cmd
)
1616 Sg_fd
*sfp
= srp
->parentfp
;
1617 sg_io_hdr_t
*hp
= &srp
->header
;
1618 int dxfer_len
= (int) hp
->dxfer_len
;
1619 int dxfer_dir
= hp
->dxfer_direction
;
1620 unsigned int iov_count
= hp
->iovec_count
;
1621 Sg_scatter_hold
*req_schp
= &srp
->data
;
1622 Sg_scatter_hold
*rsv_schp
= &sfp
->reserve
;
1623 struct request_queue
*q
= sfp
->parentdp
->device
->request_queue
;
1624 struct rq_map_data
*md
, map_data
;
1625 int rw
= hp
->dxfer_direction
== SG_DXFER_TO_DEV
? WRITE
: READ
;
1627 SCSI_LOG_TIMEOUT(4, printk(KERN_INFO
"sg_start_req: dxfer_len=%d\n",
1630 rq
= blk_get_request(q
, rw
, GFP_ATOMIC
);
1634 memcpy(rq
->cmd
, cmd
, hp
->cmd_len
);
1636 rq
->cmd_len
= hp
->cmd_len
;
1637 rq
->cmd_type
= REQ_TYPE_BLOCK_PC
;
1640 rq
->end_io_data
= srp
;
1641 rq
->sense
= srp
->sense_b
;
1642 rq
->retries
= SG_DEFAULT_RETRIES
;
1644 if ((dxfer_len
<= 0) || (dxfer_dir
== SG_DXFER_NONE
))
1647 if (sg_allow_dio
&& hp
->flags
& SG_FLAG_DIRECT_IO
&&
1648 dxfer_dir
!= SG_DXFER_UNKNOWN
&& !iov_count
&&
1649 !sfp
->parentdp
->device
->host
->unchecked_isa_dma
&&
1650 blk_rq_aligned(q
, hp
->dxferp
, dxfer_len
))
1656 if (!sg_res_in_use(sfp
) && dxfer_len
<= rsv_schp
->bufflen
)
1657 sg_link_reserve(sfp
, srp
, dxfer_len
);
1659 res
= sg_build_indirect(req_schp
, sfp
, dxfer_len
);
1664 md
->pages
= req_schp
->pages
;
1665 md
->page_order
= req_schp
->page_order
;
1666 md
->nr_entries
= req_schp
->k_use_sg
;
1668 md
->null_mapped
= hp
->dxferp
? 0 : 1;
1672 int len
, size
= sizeof(struct sg_iovec
) * iov_count
;
1675 iov
= kmalloc(size
, GFP_ATOMIC
);
1679 if (copy_from_user(iov
, hp
->dxferp
, size
)) {
1684 len
= iov_length(iov
, iov_count
);
1685 if (hp
->dxfer_len
< len
) {
1686 iov_count
= iov_shorten(iov
, iov_count
, hp
->dxfer_len
);
1687 len
= hp
->dxfer_len
;
1690 res
= blk_rq_map_user_iov(q
, rq
, md
, (struct sg_iovec
*)iov
,
1695 res
= blk_rq_map_user(q
, rq
, md
, hp
->dxferp
,
1696 hp
->dxfer_len
, GFP_ATOMIC
);
1702 req_schp
->dio_in_use
= 1;
1703 hp
->info
|= SG_INFO_DIRECT_IO
;
1710 sg_finish_rem_req(Sg_request
* srp
)
1712 Sg_fd
*sfp
= srp
->parentfp
;
1713 Sg_scatter_hold
*req_schp
= &srp
->data
;
1715 SCSI_LOG_TIMEOUT(4, printk("sg_finish_rem_req: res_used=%d\n", (int) srp
->res_used
));
1717 sg_unlink_reserve(sfp
, srp
);
1719 sg_remove_scat(req_schp
);
1723 blk_rq_unmap_user(srp
->bio
);
1725 blk_put_request(srp
->rq
);
1728 sg_remove_request(sfp
, srp
);
1732 sg_build_sgat(Sg_scatter_hold
* schp
, const Sg_fd
* sfp
, int tablesize
)
1734 int sg_bufflen
= tablesize
* sizeof(struct page
*);
1735 gfp_t gfp_flags
= GFP_ATOMIC
| __GFP_NOWARN
;
1737 schp
->pages
= kzalloc(sg_bufflen
, gfp_flags
);
1740 schp
->sglist_len
= sg_bufflen
;
1741 return tablesize
; /* number of scat_gath elements allocated */
1745 sg_build_indirect(Sg_scatter_hold
* schp
, Sg_fd
* sfp
, int buff_size
)
1747 int ret_sz
= 0, i
, k
, rem_sz
, num
, mx_sc_elems
;
1748 int sg_tablesize
= sfp
->parentdp
->sg_tablesize
;
1749 int blk_size
= buff_size
, order
;
1750 gfp_t gfp_mask
= GFP_ATOMIC
| __GFP_COMP
| __GFP_NOWARN
;
1755 ++blk_size
; /* don't know why */
1756 /* round request up to next highest SG_SECTOR_SZ byte boundary */
1757 blk_size
= (blk_size
+ SG_SECTOR_MSK
) & (~SG_SECTOR_MSK
);
1758 SCSI_LOG_TIMEOUT(4, printk("sg_build_indirect: buff_size=%d, blk_size=%d\n",
1759 buff_size
, blk_size
));
1761 /* N.B. ret_sz carried into this block ... */
1762 mx_sc_elems
= sg_build_sgat(schp
, sfp
, sg_tablesize
);
1763 if (mx_sc_elems
< 0)
1764 return mx_sc_elems
; /* most likely -ENOMEM */
1766 num
= scatter_elem_sz
;
1767 if (unlikely(num
!= scatter_elem_sz_prev
)) {
1768 if (num
< PAGE_SIZE
) {
1769 scatter_elem_sz
= PAGE_SIZE
;
1770 scatter_elem_sz_prev
= PAGE_SIZE
;
1772 scatter_elem_sz_prev
= num
;
1776 gfp_mask
|= GFP_DMA
;
1778 if (!capable(CAP_SYS_ADMIN
) || !capable(CAP_SYS_RAWIO
))
1779 gfp_mask
|= __GFP_ZERO
;
1781 order
= get_order(num
);
1783 ret_sz
= 1 << (PAGE_SHIFT
+ order
);
1785 for (k
= 0, rem_sz
= blk_size
; rem_sz
> 0 && k
< mx_sc_elems
;
1786 k
++, rem_sz
-= ret_sz
) {
1788 num
= (rem_sz
> scatter_elem_sz_prev
) ?
1789 scatter_elem_sz_prev
: rem_sz
;
1791 schp
->pages
[k
] = alloc_pages(gfp_mask
, order
);
1792 if (!schp
->pages
[k
])
1795 if (num
== scatter_elem_sz_prev
) {
1796 if (unlikely(ret_sz
> scatter_elem_sz_prev
)) {
1797 scatter_elem_sz
= ret_sz
;
1798 scatter_elem_sz_prev
= ret_sz
;
1802 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k=%d, num=%d, "
1803 "ret_sz=%d\n", k
, num
, ret_sz
));
1804 } /* end of for loop */
1806 schp
->page_order
= order
;
1808 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k_use_sg=%d, "
1809 "rem_sz=%d\n", k
, rem_sz
));
1811 schp
->bufflen
= blk_size
;
1812 if (rem_sz
> 0) /* must have failed */
1816 for (i
= 0; i
< k
; i
++)
1817 __free_pages(schp
->pages
[k
], order
);
1826 sg_remove_scat(Sg_scatter_hold
* schp
)
1828 SCSI_LOG_TIMEOUT(4, printk("sg_remove_scat: k_use_sg=%d\n", schp
->k_use_sg
));
1829 if (schp
->pages
&& schp
->sglist_len
> 0) {
1830 if (!schp
->dio_in_use
) {
1833 for (k
= 0; k
< schp
->k_use_sg
&& schp
->pages
[k
]; k
++) {
1834 SCSI_LOG_TIMEOUT(5, printk(
1835 "sg_remove_scat: k=%d, pg=0x%p\n",
1836 k
, schp
->pages
[k
]));
1837 __free_pages(schp
->pages
[k
], schp
->page_order
);
1843 memset(schp
, 0, sizeof (*schp
));
1847 sg_read_oxfer(Sg_request
* srp
, char __user
*outp
, int num_read_xfer
)
1849 Sg_scatter_hold
*schp
= &srp
->data
;
1852 SCSI_LOG_TIMEOUT(4, printk("sg_read_oxfer: num_read_xfer=%d\n",
1854 if ((!outp
) || (num_read_xfer
<= 0))
1857 num
= 1 << (PAGE_SHIFT
+ schp
->page_order
);
1858 for (k
= 0; k
< schp
->k_use_sg
&& schp
->pages
[k
]; k
++) {
1859 if (num
> num_read_xfer
) {
1860 if (__copy_to_user(outp
, page_address(schp
->pages
[k
]),
1865 if (__copy_to_user(outp
, page_address(schp
->pages
[k
]),
1868 num_read_xfer
-= num
;
1869 if (num_read_xfer
<= 0)
1879 sg_build_reserve(Sg_fd
* sfp
, int req_size
)
1881 Sg_scatter_hold
*schp
= &sfp
->reserve
;
1883 SCSI_LOG_TIMEOUT(4, printk("sg_build_reserve: req_size=%d\n", req_size
));
1885 if (req_size
< PAGE_SIZE
)
1886 req_size
= PAGE_SIZE
;
1887 if (0 == sg_build_indirect(schp
, sfp
, req_size
))
1890 sg_remove_scat(schp
);
1891 req_size
>>= 1; /* divide by 2 */
1892 } while (req_size
> (PAGE_SIZE
/ 2));
1896 sg_link_reserve(Sg_fd
* sfp
, Sg_request
* srp
, int size
)
1898 Sg_scatter_hold
*req_schp
= &srp
->data
;
1899 Sg_scatter_hold
*rsv_schp
= &sfp
->reserve
;
1903 SCSI_LOG_TIMEOUT(4, printk("sg_link_reserve: size=%d\n", size
));
1906 num
= 1 << (PAGE_SHIFT
+ rsv_schp
->page_order
);
1907 for (k
= 0; k
< rsv_schp
->k_use_sg
; k
++) {
1909 req_schp
->k_use_sg
= k
+ 1;
1910 req_schp
->sglist_len
= rsv_schp
->sglist_len
;
1911 req_schp
->pages
= rsv_schp
->pages
;
1913 req_schp
->bufflen
= size
;
1914 req_schp
->page_order
= rsv_schp
->page_order
;
1920 if (k
>= rsv_schp
->k_use_sg
)
1921 SCSI_LOG_TIMEOUT(1, printk("sg_link_reserve: BAD size\n"));
1925 sg_unlink_reserve(Sg_fd
* sfp
, Sg_request
* srp
)
1927 Sg_scatter_hold
*req_schp
= &srp
->data
;
1929 SCSI_LOG_TIMEOUT(4, printk("sg_unlink_reserve: req->k_use_sg=%d\n",
1930 (int) req_schp
->k_use_sg
));
1931 req_schp
->k_use_sg
= 0;
1932 req_schp
->bufflen
= 0;
1933 req_schp
->pages
= NULL
;
1934 req_schp
->page_order
= 0;
1935 req_schp
->sglist_len
= 0;
1936 sfp
->save_scat_len
= 0;
1941 sg_get_rq_mark(Sg_fd
* sfp
, int pack_id
)
1944 unsigned long iflags
;
1946 write_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
1947 for (resp
= sfp
->headrp
; resp
; resp
= resp
->nextrp
) {
1948 /* look for requests that are ready + not SG_IO owned */
1949 if ((1 == resp
->done
) && (!resp
->sg_io_owned
) &&
1950 ((-1 == pack_id
) || (resp
->header
.pack_id
== pack_id
))) {
1951 resp
->done
= 2; /* guard against other readers */
1955 write_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
1959 /* always adds to end of list */
1961 sg_add_request(Sg_fd
* sfp
)
1964 unsigned long iflags
;
1966 Sg_request
*rp
= sfp
->req_arr
;
1968 write_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
1971 memset(rp
, 0, sizeof (Sg_request
));
1976 if (0 == sfp
->cmd_q
)
1977 resp
= NULL
; /* command queuing disallowed */
1979 for (k
= 0; k
< SG_MAX_QUEUE
; ++k
, ++rp
) {
1983 if (k
< SG_MAX_QUEUE
) {
1984 memset(rp
, 0, sizeof (Sg_request
));
1986 while (resp
->nextrp
)
1987 resp
= resp
->nextrp
;
1995 resp
->nextrp
= NULL
;
1996 resp
->header
.duration
= jiffies_to_msecs(jiffies
);
1998 write_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
2002 /* Return of 1 for found; 0 for not found */
2004 sg_remove_request(Sg_fd
* sfp
, Sg_request
* srp
)
2006 Sg_request
*prev_rp
;
2008 unsigned long iflags
;
2011 if ((!sfp
) || (!srp
) || (!sfp
->headrp
))
2013 write_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
2014 prev_rp
= sfp
->headrp
;
2015 if (srp
== prev_rp
) {
2016 sfp
->headrp
= prev_rp
->nextrp
;
2017 prev_rp
->parentfp
= NULL
;
2020 while ((rp
= prev_rp
->nextrp
)) {
2022 prev_rp
->nextrp
= rp
->nextrp
;
2023 rp
->parentfp
= NULL
;
2030 write_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
2035 sg_add_sfp(Sg_device
* sdp
, int dev
)
2038 unsigned long iflags
;
2041 sfp
= kzalloc(sizeof(*sfp
), GFP_ATOMIC
| __GFP_NOWARN
);
2045 init_waitqueue_head(&sfp
->read_wait
);
2046 rwlock_init(&sfp
->rq_list_lock
);
2048 kref_init(&sfp
->f_ref
);
2049 sfp
->timeout
= SG_DEFAULT_TIMEOUT
;
2050 sfp
->timeout_user
= SG_DEFAULT_TIMEOUT_USER
;
2051 sfp
->force_packid
= SG_DEF_FORCE_PACK_ID
;
2052 sfp
->low_dma
= (SG_DEF_FORCE_LOW_DMA
== 0) ?
2053 sdp
->device
->host
->unchecked_isa_dma
: 1;
2054 sfp
->cmd_q
= SG_DEF_COMMAND_Q
;
2055 sfp
->keep_orphan
= SG_DEF_KEEP_ORPHAN
;
2056 sfp
->parentdp
= sdp
;
2057 write_lock_irqsave(&sg_index_lock
, iflags
);
2060 else { /* add to tail of existing list */
2061 Sg_fd
*pfp
= sdp
->headfp
;
2066 write_unlock_irqrestore(&sg_index_lock
, iflags
);
2067 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: sfp=0x%p\n", sfp
));
2068 if (unlikely(sg_big_buff
!= def_reserved_size
))
2069 sg_big_buff
= def_reserved_size
;
2071 bufflen
= min_t(int, sg_big_buff
,
2072 sdp
->device
->request_queue
->max_sectors
* 512);
2073 sg_build_reserve(sfp
, bufflen
);
2074 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: bufflen=%d, k_use_sg=%d\n",
2075 sfp
->reserve
.bufflen
, sfp
->reserve
.k_use_sg
));
2077 kref_get(&sdp
->d_ref
);
2078 __module_get(THIS_MODULE
);
2082 static void sg_remove_sfp_usercontext(struct work_struct
*work
)
2084 struct sg_fd
*sfp
= container_of(work
, struct sg_fd
, ew
.work
);
2085 struct sg_device
*sdp
= sfp
->parentdp
;
2087 /* Cleanup any responses which were never read(). */
2089 sg_finish_rem_req(sfp
->headrp
);
2091 if (sfp
->reserve
.bufflen
> 0) {
2093 printk("sg_remove_sfp: bufflen=%d, k_use_sg=%d\n",
2094 (int) sfp
->reserve
.bufflen
,
2095 (int) sfp
->reserve
.k_use_sg
));
2096 sg_remove_scat(&sfp
->reserve
);
2100 printk("sg_remove_sfp: %s, sfp=0x%p\n",
2101 sdp
->disk
->disk_name
,
2105 scsi_device_put(sdp
->device
);
2107 module_put(THIS_MODULE
);
2110 static void sg_remove_sfp(struct kref
*kref
)
2112 struct sg_fd
*sfp
= container_of(kref
, struct sg_fd
, f_ref
);
2113 struct sg_device
*sdp
= sfp
->parentdp
;
2116 unsigned long iflags
;
2118 /* CAUTION! Note that sfp can still be found by walking sdp->headfp
2119 * even though the refcount is now 0. Therefore, unlink sfp from
2120 * sdp->headfp BEFORE doing any other cleanup.
2123 write_lock_irqsave(&sg_index_lock
, iflags
);
2124 prev_fp
= sdp
->headfp
;
2126 sdp
->headfp
= prev_fp
->nextfp
;
2128 while ((fp
= prev_fp
->nextfp
)) {
2130 prev_fp
->nextfp
= fp
->nextfp
;
2136 write_unlock_irqrestore(&sg_index_lock
, iflags
);
2137 wake_up_interruptible(&sdp
->o_excl_wait
);
2139 INIT_WORK(&sfp
->ew
.work
, sg_remove_sfp_usercontext
);
2140 schedule_work(&sfp
->ew
.work
);
2144 sg_res_in_use(Sg_fd
* sfp
)
2146 const Sg_request
*srp
;
2147 unsigned long iflags
;
2149 read_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
2150 for (srp
= sfp
->headrp
; srp
; srp
= srp
->nextrp
)
2153 read_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
2157 #ifdef CONFIG_SCSI_PROC_FS
2159 sg_idr_max_id(int id
, void *p
, void *data
)
2173 unsigned long iflags
;
2175 read_lock_irqsave(&sg_index_lock
, iflags
);
2176 idr_for_each(&sg_index_idr
, sg_idr_max_id
, &k
);
2177 read_unlock_irqrestore(&sg_index_lock
, iflags
);
2178 return k
+ 1; /* origin 1 */
2182 /* must be called with sg_index_lock held */
2183 static Sg_device
*sg_lookup_dev(int dev
)
2185 return idr_find(&sg_index_idr
, dev
);
2188 static Sg_device
*sg_get_dev(int dev
)
2190 struct sg_device
*sdp
;
2191 unsigned long flags
;
2193 read_lock_irqsave(&sg_index_lock
, flags
);
2194 sdp
= sg_lookup_dev(dev
);
2196 sdp
= ERR_PTR(-ENXIO
);
2197 else if (sdp
->detached
) {
2198 /* If sdp->detached, then the refcount may already be 0, in
2199 * which case it would be a bug to do kref_get().
2201 sdp
= ERR_PTR(-ENODEV
);
2203 kref_get(&sdp
->d_ref
);
2204 read_unlock_irqrestore(&sg_index_lock
, flags
);
2209 static void sg_put_dev(struct sg_device
*sdp
)
2211 kref_put(&sdp
->d_ref
, sg_device_destroy
);
2214 #ifdef CONFIG_SCSI_PROC_FS
2216 static struct proc_dir_entry
*sg_proc_sgp
= NULL
;
2218 static char sg_proc_sg_dirname
[] = "scsi/sg";
2220 static int sg_proc_seq_show_int(struct seq_file
*s
, void *v
);
2222 static int sg_proc_single_open_adio(struct inode
*inode
, struct file
*file
);
2223 static ssize_t
sg_proc_write_adio(struct file
*filp
, const char __user
*buffer
,
2224 size_t count
, loff_t
*off
);
2225 static struct file_operations adio_fops
= {
2226 /* .owner, .read and .llseek added in sg_proc_init() */
2227 .open
= sg_proc_single_open_adio
,
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 struct file_operations dressz_fops
= {
2236 .open
= sg_proc_single_open_dressz
,
2237 .write
= sg_proc_write_dressz
,
2238 .release
= single_release
,
2241 static int sg_proc_seq_show_version(struct seq_file
*s
, void *v
);
2242 static int sg_proc_single_open_version(struct inode
*inode
, struct file
*file
);
2243 static struct file_operations version_fops
= {
2244 .open
= sg_proc_single_open_version
,
2245 .release
= single_release
,
2248 static int sg_proc_seq_show_devhdr(struct seq_file
*s
, void *v
);
2249 static int sg_proc_single_open_devhdr(struct inode
*inode
, struct file
*file
);
2250 static struct file_operations devhdr_fops
= {
2251 .open
= sg_proc_single_open_devhdr
,
2252 .release
= single_release
,
2255 static int sg_proc_seq_show_dev(struct seq_file
*s
, void *v
);
2256 static int sg_proc_open_dev(struct inode
*inode
, struct file
*file
);
2257 static void * dev_seq_start(struct seq_file
*s
, loff_t
*pos
);
2258 static void * dev_seq_next(struct seq_file
*s
, void *v
, loff_t
*pos
);
2259 static void dev_seq_stop(struct seq_file
*s
, void *v
);
2260 static struct file_operations dev_fops
= {
2261 .open
= sg_proc_open_dev
,
2262 .release
= seq_release
,
2264 static struct seq_operations dev_seq_ops
= {
2265 .start
= dev_seq_start
,
2266 .next
= dev_seq_next
,
2267 .stop
= dev_seq_stop
,
2268 .show
= sg_proc_seq_show_dev
,
2271 static int sg_proc_seq_show_devstrs(struct seq_file
*s
, void *v
);
2272 static int sg_proc_open_devstrs(struct inode
*inode
, struct file
*file
);
2273 static struct file_operations devstrs_fops
= {
2274 .open
= sg_proc_open_devstrs
,
2275 .release
= seq_release
,
2277 static struct seq_operations devstrs_seq_ops
= {
2278 .start
= dev_seq_start
,
2279 .next
= dev_seq_next
,
2280 .stop
= dev_seq_stop
,
2281 .show
= sg_proc_seq_show_devstrs
,
2284 static int sg_proc_seq_show_debug(struct seq_file
*s
, void *v
);
2285 static int sg_proc_open_debug(struct inode
*inode
, struct file
*file
);
2286 static struct file_operations debug_fops
= {
2287 .open
= sg_proc_open_debug
,
2288 .release
= seq_release
,
2290 static struct seq_operations debug_seq_ops
= {
2291 .start
= dev_seq_start
,
2292 .next
= dev_seq_next
,
2293 .stop
= dev_seq_stop
,
2294 .show
= sg_proc_seq_show_debug
,
2298 struct sg_proc_leaf
{
2300 struct file_operations
* fops
;
2303 static struct sg_proc_leaf sg_proc_leaf_arr
[] = {
2304 {"allow_dio", &adio_fops
},
2305 {"debug", &debug_fops
},
2306 {"def_reserved_size", &dressz_fops
},
2307 {"device_hdr", &devhdr_fops
},
2308 {"devices", &dev_fops
},
2309 {"device_strs", &devstrs_fops
},
2310 {"version", &version_fops
}
2317 int num_leaves
= ARRAY_SIZE(sg_proc_leaf_arr
);
2318 struct sg_proc_leaf
* leaf
;
2320 sg_proc_sgp
= proc_mkdir(sg_proc_sg_dirname
, NULL
);
2323 for (k
= 0; k
< num_leaves
; ++k
) {
2324 leaf
= &sg_proc_leaf_arr
[k
];
2325 mask
= leaf
->fops
->write
? S_IRUGO
| S_IWUSR
: S_IRUGO
;
2326 leaf
->fops
->owner
= THIS_MODULE
;
2327 leaf
->fops
->read
= seq_read
;
2328 leaf
->fops
->llseek
= seq_lseek
;
2329 proc_create(leaf
->name
, mask
, sg_proc_sgp
, leaf
->fops
);
2335 sg_proc_cleanup(void)
2338 int num_leaves
= ARRAY_SIZE(sg_proc_leaf_arr
);
2342 for (k
= 0; k
< num_leaves
; ++k
)
2343 remove_proc_entry(sg_proc_leaf_arr
[k
].name
, sg_proc_sgp
);
2344 remove_proc_entry(sg_proc_sg_dirname
, NULL
);
2348 static int sg_proc_seq_show_int(struct seq_file
*s
, void *v
)
2350 seq_printf(s
, "%d\n", *((int *)s
->private));
2354 static int sg_proc_single_open_adio(struct inode
*inode
, struct file
*file
)
2356 return single_open(file
, sg_proc_seq_show_int
, &sg_allow_dio
);
2360 sg_proc_write_adio(struct file
*filp
, const char __user
*buffer
,
2361 size_t count
, loff_t
*off
)
2366 if (!capable(CAP_SYS_ADMIN
) || !capable(CAP_SYS_RAWIO
))
2368 num
= (count
< 10) ? count
: 10;
2369 if (copy_from_user(buff
, buffer
, num
))
2372 sg_allow_dio
= simple_strtoul(buff
, NULL
, 10) ? 1 : 0;
2376 static int sg_proc_single_open_dressz(struct inode
*inode
, struct file
*file
)
2378 return single_open(file
, sg_proc_seq_show_int
, &sg_big_buff
);
2382 sg_proc_write_dressz(struct file
*filp
, const char __user
*buffer
,
2383 size_t count
, loff_t
*off
)
2386 unsigned long k
= ULONG_MAX
;
2389 if (!capable(CAP_SYS_ADMIN
) || !capable(CAP_SYS_RAWIO
))
2391 num
= (count
< 10) ? count
: 10;
2392 if (copy_from_user(buff
, buffer
, num
))
2395 k
= simple_strtoul(buff
, NULL
, 10);
2396 if (k
<= 1048576) { /* limit "big buff" to 1 MB */
2403 static int sg_proc_seq_show_version(struct seq_file
*s
, void *v
)
2405 seq_printf(s
, "%d\t%s [%s]\n", sg_version_num
, SG_VERSION_STR
,
2410 static int sg_proc_single_open_version(struct inode
*inode
, struct file
*file
)
2412 return single_open(file
, sg_proc_seq_show_version
, NULL
);
2415 static int sg_proc_seq_show_devhdr(struct seq_file
*s
, void *v
)
2417 seq_printf(s
, "host\tchan\tid\tlun\ttype\topens\tqdepth\tbusy\t"
2422 static int sg_proc_single_open_devhdr(struct inode
*inode
, struct file
*file
)
2424 return single_open(file
, sg_proc_seq_show_devhdr
, NULL
);
2427 struct sg_proc_deviter
{
2432 static void * dev_seq_start(struct seq_file
*s
, loff_t
*pos
)
2434 struct sg_proc_deviter
* it
= kmalloc(sizeof(*it
), GFP_KERNEL
);
2441 it
->max
= sg_last_dev();
2442 if (it
->index
>= it
->max
)
2447 static void * dev_seq_next(struct seq_file
*s
, void *v
, loff_t
*pos
)
2449 struct sg_proc_deviter
* it
= s
->private;
2452 return (it
->index
< it
->max
) ? it
: NULL
;
2455 static void dev_seq_stop(struct seq_file
*s
, void *v
)
2460 static int sg_proc_open_dev(struct inode
*inode
, struct file
*file
)
2462 return seq_open(file
, &dev_seq_ops
);
2465 static int sg_proc_seq_show_dev(struct seq_file
*s
, void *v
)
2467 struct sg_proc_deviter
* it
= (struct sg_proc_deviter
*) v
;
2469 struct scsi_device
*scsidp
;
2470 unsigned long iflags
;
2472 read_lock_irqsave(&sg_index_lock
, iflags
);
2473 sdp
= it
? sg_lookup_dev(it
->index
) : NULL
;
2474 if (sdp
&& (scsidp
= sdp
->device
) && (!sdp
->detached
))
2475 seq_printf(s
, "%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\n",
2476 scsidp
->host
->host_no
, scsidp
->channel
,
2477 scsidp
->id
, scsidp
->lun
, (int) scsidp
->type
,
2479 (int) scsidp
->queue_depth
,
2480 (int) scsidp
->device_busy
,
2481 (int) scsi_device_online(scsidp
));
2483 seq_printf(s
, "-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\n");
2484 read_unlock_irqrestore(&sg_index_lock
, iflags
);
2488 static int sg_proc_open_devstrs(struct inode
*inode
, struct file
*file
)
2490 return seq_open(file
, &devstrs_seq_ops
);
2493 static int sg_proc_seq_show_devstrs(struct seq_file
*s
, void *v
)
2495 struct sg_proc_deviter
* it
= (struct sg_proc_deviter
*) v
;
2497 struct scsi_device
*scsidp
;
2498 unsigned long iflags
;
2500 read_lock_irqsave(&sg_index_lock
, iflags
);
2501 sdp
= it
? sg_lookup_dev(it
->index
) : NULL
;
2502 if (sdp
&& (scsidp
= sdp
->device
) && (!sdp
->detached
))
2503 seq_printf(s
, "%8.8s\t%16.16s\t%4.4s\n",
2504 scsidp
->vendor
, scsidp
->model
, scsidp
->rev
);
2506 seq_printf(s
, "<no active device>\n");
2507 read_unlock_irqrestore(&sg_index_lock
, iflags
);
2511 /* must be called while holding sg_index_lock */
2512 static void sg_proc_debug_helper(struct seq_file
*s
, Sg_device
* sdp
)
2514 int k
, m
, new_interface
, blen
, usg
;
2517 const sg_io_hdr_t
*hp
;
2521 for (k
= 0, fp
= sdp
->headfp
; fp
!= NULL
; ++k
, fp
= fp
->nextfp
) {
2522 read_lock(&fp
->rq_list_lock
); /* irqs already disabled */
2523 seq_printf(s
, " FD(%d): timeout=%dms bufflen=%d "
2524 "(res)sgat=%d low_dma=%d\n", k
+ 1,
2525 jiffies_to_msecs(fp
->timeout
),
2526 fp
->reserve
.bufflen
,
2527 (int) fp
->reserve
.k_use_sg
,
2529 seq_printf(s
, " cmd_q=%d f_packid=%d k_orphan=%d closed=%d\n",
2530 (int) fp
->cmd_q
, (int) fp
->force_packid
,
2531 (int) fp
->keep_orphan
, (int) fp
->closed
);
2532 for (m
= 0, srp
= fp
->headrp
;
2534 ++m
, srp
= srp
->nextrp
) {
2536 new_interface
= (hp
->interface_id
== '\0') ? 0 : 1;
2537 if (srp
->res_used
) {
2538 if (new_interface
&&
2539 (SG_FLAG_MMAP_IO
& hp
->flags
))
2544 if (SG_INFO_DIRECT_IO_MASK
& hp
->info
)
2550 blen
= srp
->data
.bufflen
;
2551 usg
= srp
->data
.k_use_sg
;
2552 seq_printf(s
, srp
->done
?
2553 ((1 == srp
->done
) ? "rcv:" : "fin:")
2555 seq_printf(s
, " id=%d blen=%d",
2556 srp
->header
.pack_id
, blen
);
2558 seq_printf(s
, " dur=%d", hp
->duration
);
2560 ms
= jiffies_to_msecs(jiffies
);
2561 seq_printf(s
, " t_o/elap=%d/%d",
2562 (new_interface
? hp
->timeout
:
2563 jiffies_to_msecs(fp
->timeout
)),
2564 (ms
> hp
->duration
? ms
- hp
->duration
: 0));
2566 seq_printf(s
, "ms sgat=%d op=0x%02x\n", usg
,
2567 (int) srp
->data
.cmd_opcode
);
2570 seq_printf(s
, " No requests active\n");
2571 read_unlock(&fp
->rq_list_lock
);
2575 static int sg_proc_open_debug(struct inode
*inode
, struct file
*file
)
2577 return seq_open(file
, &debug_seq_ops
);
2580 static int sg_proc_seq_show_debug(struct seq_file
*s
, void *v
)
2582 struct sg_proc_deviter
* it
= (struct sg_proc_deviter
*) v
;
2584 unsigned long iflags
;
2586 if (it
&& (0 == it
->index
)) {
2587 seq_printf(s
, "max_active_device=%d(origin 1)\n",
2589 seq_printf(s
, " def_reserved_size=%d\n", sg_big_buff
);
2592 read_lock_irqsave(&sg_index_lock
, iflags
);
2593 sdp
= it
? sg_lookup_dev(it
->index
) : NULL
;
2594 if (sdp
&& sdp
->headfp
) {
2595 struct scsi_device
*scsidp
= sdp
->device
;
2597 seq_printf(s
, " >>> device=%s ", sdp
->disk
->disk_name
);
2599 seq_printf(s
, "detached pending close ");
2602 (s
, "scsi%d chan=%d id=%d lun=%d em=%d",
2603 scsidp
->host
->host_no
,
2604 scsidp
->channel
, scsidp
->id
,
2606 scsidp
->host
->hostt
->emulated
);
2607 seq_printf(s
, " sg_tablesize=%d excl=%d\n",
2608 sdp
->sg_tablesize
, sdp
->exclude
);
2609 sg_proc_debug_helper(s
, sdp
);
2611 read_unlock_irqrestore(&sg_index_lock
, iflags
);
2615 #endif /* CONFIG_SCSI_PROC_FS */
2617 module_init(init_sg
);
2618 module_exit(exit_sg
);