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_MUTEX(sg_mutex
);
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 volatile char done
; /* 0->before bh, 1->before read, 2->read */
143 struct execute_work ew
;
146 typedef struct sg_fd
{ /* holds the state of a file descriptor */
147 struct list_head sfd_siblings
;
148 struct sg_device
*parentdp
; /* owning device */
149 wait_queue_head_t read_wait
; /* queue read until command done */
150 rwlock_t rq_list_lock
; /* protect access to list in req_arr */
151 int timeout
; /* defaults to SG_DEFAULT_TIMEOUT */
152 int timeout_user
; /* defaults to SG_DEFAULT_TIMEOUT_USER */
153 Sg_scatter_hold reserve
; /* buffer held for this file descriptor */
154 unsigned save_scat_len
; /* original length of trunc. scat. element */
155 Sg_request
*headrp
; /* head of request slist, NULL->empty */
156 struct fasync_struct
*async_qp
; /* used by asynchronous notification */
157 Sg_request req_arr
[SG_MAX_QUEUE
]; /* used as singly-linked list */
158 char low_dma
; /* as in parent but possibly overridden to 1 */
159 char force_packid
; /* 1 -> pack_id input to read(), 0 -> ignored */
160 volatile char closed
; /* 1 -> fd closed but request(s) outstanding */
161 char cmd_q
; /* 1 -> allow command queuing, 0 -> don't */
162 char next_cmd_len
; /* 0 -> automatic (def), >0 -> use on next write() */
163 char keep_orphan
; /* 0 -> drop orphan (def), 1 -> keep for read() */
164 char mmap_called
; /* 0 -> mmap() never called on this fd */
166 struct execute_work ew
;
169 typedef struct sg_device
{ /* holds the state of each scsi generic device */
170 struct scsi_device
*device
;
171 wait_queue_head_t o_excl_wait
; /* queue open() when O_EXCL in use */
172 int sg_tablesize
; /* adapter's max scatter-gather table size */
173 u32 index
; /* device index number */
174 struct list_head sfds
;
175 volatile char detached
; /* 0->attached, 1->detached pending removal */
176 volatile char exclude
; /* opened for exclusive access */
177 char sgdebug
; /* 0->off, 1->sense, 9->dump dev, 10-> all devs */
178 struct gendisk
*disk
;
179 struct cdev
* cdev
; /* char_dev [sysfs: /sys/cdev/major/sg<n>] */
183 /* tasklet or soft irq callback */
184 static void sg_rq_end_io(struct request
*rq
, int uptodate
);
185 static int sg_start_req(Sg_request
*srp
, unsigned char *cmd
);
186 static int sg_finish_rem_req(Sg_request
* srp
);
187 static int sg_build_indirect(Sg_scatter_hold
* schp
, Sg_fd
* sfp
, int buff_size
);
188 static ssize_t
sg_new_read(Sg_fd
* sfp
, char __user
*buf
, size_t count
,
190 static ssize_t
sg_new_write(Sg_fd
*sfp
, struct file
*file
,
191 const char __user
*buf
, size_t count
, int blocking
,
192 int read_only
, int sg_io_owned
, Sg_request
**o_srp
);
193 static int sg_common_write(Sg_fd
* sfp
, Sg_request
* srp
,
194 unsigned char *cmnd
, int timeout
, int blocking
);
195 static int sg_read_oxfer(Sg_request
* srp
, char __user
*outp
, int num_read_xfer
);
196 static void sg_remove_scat(Sg_scatter_hold
* schp
);
197 static void sg_build_reserve(Sg_fd
* sfp
, int req_size
);
198 static void sg_link_reserve(Sg_fd
* sfp
, Sg_request
* srp
, int size
);
199 static void sg_unlink_reserve(Sg_fd
* sfp
, Sg_request
* srp
);
200 static Sg_fd
*sg_add_sfp(Sg_device
* sdp
, int dev
);
201 static void sg_remove_sfp(struct kref
*);
202 static Sg_request
*sg_get_rq_mark(Sg_fd
* sfp
, int pack_id
);
203 static Sg_request
*sg_add_request(Sg_fd
* sfp
);
204 static int sg_remove_request(Sg_fd
* sfp
, Sg_request
* srp
);
205 static int sg_res_in_use(Sg_fd
* sfp
);
206 static Sg_device
*sg_get_dev(int dev
);
207 static void sg_put_dev(Sg_device
*sdp
);
209 #define SZ_SG_HEADER sizeof(struct sg_header)
210 #define SZ_SG_IO_HDR sizeof(sg_io_hdr_t)
211 #define SZ_SG_IOVEC sizeof(sg_iovec_t)
212 #define SZ_SG_REQ_INFO sizeof(sg_req_info_t)
214 static int sg_allow_access(struct file
*filp
, unsigned char *cmd
)
216 struct sg_fd
*sfp
= filp
->private_data
;
218 if (sfp
->parentdp
->device
->type
== TYPE_SCANNER
)
221 return blk_verify_command(cmd
, filp
->f_mode
& FMODE_WRITE
);
225 sg_open(struct inode
*inode
, struct file
*filp
)
227 int dev
= iminor(inode
);
228 int flags
= filp
->f_flags
;
229 struct request_queue
*q
;
235 mutex_lock(&sg_mutex
);
236 nonseekable_open(inode
, filp
);
237 SCSI_LOG_TIMEOUT(3, printk("sg_open: dev=%d, flags=0x%x\n", dev
, flags
));
238 sdp
= sg_get_dev(dev
);
240 retval
= PTR_ERR(sdp
);
245 /* This driver's module count bumped by fops_get in <linux/fs.h> */
246 /* Prevent the device driver from vanishing while we sleep */
247 retval
= scsi_device_get(sdp
->device
);
251 retval
= scsi_autopm_get_device(sdp
->device
);
255 if (!((flags
& O_NONBLOCK
) ||
256 scsi_block_when_processing_errors(sdp
->device
))) {
258 /* we are in error recovery for this device */
262 if (flags
& O_EXCL
) {
263 if (O_RDONLY
== (flags
& O_ACCMODE
)) {
264 retval
= -EPERM
; /* Can't lock it with read only access */
267 if (!list_empty(&sdp
->sfds
) && (flags
& O_NONBLOCK
)) {
272 __wait_event_interruptible(sdp
->o_excl_wait
,
273 ((!list_empty(&sdp
->sfds
) || sdp
->exclude
) ? 0 : (sdp
->exclude
= 1)), res
);
275 retval
= res
; /* -ERESTARTSYS because signal hit process */
278 } else if (sdp
->exclude
) { /* some other fd has an exclusive lock on dev */
279 if (flags
& O_NONBLOCK
) {
284 __wait_event_interruptible(sdp
->o_excl_wait
, (!sdp
->exclude
),
287 retval
= res
; /* -ERESTARTSYS because signal hit process */
295 if (list_empty(&sdp
->sfds
)) { /* no existing opens on this device */
297 q
= sdp
->device
->request_queue
;
298 sdp
->sg_tablesize
= queue_max_segments(q
);
300 if ((sfp
= sg_add_sfp(sdp
, dev
)))
301 filp
->private_data
= sfp
;
303 if (flags
& O_EXCL
) {
304 sdp
->exclude
= 0; /* undo if error */
305 wake_up_interruptible(&sdp
->o_excl_wait
);
313 scsi_autopm_put_device(sdp
->device
);
315 scsi_device_put(sdp
->device
);
320 mutex_unlock(&sg_mutex
);
324 /* Following function was formerly called 'sg_close' */
326 sg_release(struct inode
*inode
, struct file
*filp
)
331 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
333 SCSI_LOG_TIMEOUT(3, printk("sg_release: %s\n", sdp
->disk
->disk_name
));
338 wake_up_interruptible(&sdp
->o_excl_wait
);
340 scsi_autopm_put_device(sdp
->device
);
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 err
= 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
)) {
631 printk_ratelimited(KERN_WARNING
632 "sg_write: data in/out %d/%d bytes "
633 "for SCSI command 0x%x-- guessing "
634 "data in;\n program %s not setting "
635 "count and/or reply_len properly\n",
636 old_hdr
.reply_len
- (int)SZ_SG_HEADER
,
637 input_size
, (unsigned int) cmnd
[0],
639 strcpy(cmd
, current
->comm
);
642 k
= sg_common_write(sfp
, srp
, cmnd
, sfp
->timeout
, blocking
);
643 return (k
< 0) ? k
: count
;
647 sg_new_write(Sg_fd
*sfp
, struct file
*file
, const char __user
*buf
,
648 size_t count
, int blocking
, int read_only
, int sg_io_owned
,
654 unsigned char cmnd
[MAX_COMMAND_SIZE
];
656 unsigned long ul_timeout
;
658 if (count
< SZ_SG_IO_HDR
)
660 if (!access_ok(VERIFY_READ
, buf
, count
))
661 return -EFAULT
; /* protects following copy_from_user()s + get_user()s */
663 sfp
->cmd_q
= 1; /* when sg_io_hdr seen, set command queuing on */
664 if (!(srp
= sg_add_request(sfp
))) {
665 SCSI_LOG_TIMEOUT(1, printk("sg_new_write: queue full\n"));
668 srp
->sg_io_owned
= sg_io_owned
;
670 if (__copy_from_user(hp
, buf
, SZ_SG_IO_HDR
)) {
671 sg_remove_request(sfp
, srp
);
674 if (hp
->interface_id
!= 'S') {
675 sg_remove_request(sfp
, srp
);
678 if (hp
->flags
& SG_FLAG_MMAP_IO
) {
679 if (hp
->dxfer_len
> sfp
->reserve
.bufflen
) {
680 sg_remove_request(sfp
, srp
);
681 return -ENOMEM
; /* MMAP_IO size must fit in reserve buffer */
683 if (hp
->flags
& SG_FLAG_DIRECT_IO
) {
684 sg_remove_request(sfp
, srp
);
685 return -EINVAL
; /* either MMAP_IO or DIRECT_IO (not both) */
687 if (sg_res_in_use(sfp
)) {
688 sg_remove_request(sfp
, srp
);
689 return -EBUSY
; /* reserve buffer already being used */
692 ul_timeout
= msecs_to_jiffies(srp
->header
.timeout
);
693 timeout
= (ul_timeout
< INT_MAX
) ? ul_timeout
: INT_MAX
;
694 if ((!hp
->cmdp
) || (hp
->cmd_len
< 6) || (hp
->cmd_len
> sizeof (cmnd
))) {
695 sg_remove_request(sfp
, srp
);
698 if (!access_ok(VERIFY_READ
, hp
->cmdp
, hp
->cmd_len
)) {
699 sg_remove_request(sfp
, srp
);
700 return -EFAULT
; /* protects following copy_from_user()s + get_user()s */
702 if (__copy_from_user(cmnd
, hp
->cmdp
, hp
->cmd_len
)) {
703 sg_remove_request(sfp
, srp
);
706 if (read_only
&& sg_allow_access(file
, cmnd
)) {
707 sg_remove_request(sfp
, srp
);
710 k
= sg_common_write(sfp
, srp
, cmnd
, timeout
, blocking
);
719 sg_common_write(Sg_fd
* sfp
, Sg_request
* srp
,
720 unsigned char *cmnd
, int timeout
, int blocking
)
723 Sg_device
*sdp
= sfp
->parentdp
;
724 sg_io_hdr_t
*hp
= &srp
->header
;
726 srp
->data
.cmd_opcode
= cmnd
[0]; /* hold opcode of command */
728 hp
->masked_status
= 0;
732 hp
->driver_status
= 0;
734 SCSI_LOG_TIMEOUT(4, printk("sg_common_write: scsi opcode=0x%02x, cmd_size=%d\n",
735 (int) cmnd
[0], (int) hp
->cmd_len
));
737 k
= sg_start_req(srp
, cmnd
);
739 SCSI_LOG_TIMEOUT(1, printk("sg_common_write: start_req err=%d\n", k
));
740 sg_finish_rem_req(srp
);
741 return k
; /* probably out of space --> ENOMEM */
745 blk_end_request_all(srp
->rq
, -EIO
);
746 sg_finish_rem_req(srp
);
750 switch (hp
->dxfer_direction
) {
751 case SG_DXFER_TO_FROM_DEV
:
752 case SG_DXFER_FROM_DEV
:
753 data_dir
= DMA_FROM_DEVICE
;
755 case SG_DXFER_TO_DEV
:
756 data_dir
= DMA_TO_DEVICE
;
758 case SG_DXFER_UNKNOWN
:
759 data_dir
= DMA_BIDIRECTIONAL
;
765 hp
->duration
= jiffies_to_msecs(jiffies
);
767 srp
->rq
->timeout
= timeout
;
768 kref_get(&sfp
->f_ref
); /* sg_rq_end_io() does kref_put(). */
769 blk_execute_rq_nowait(sdp
->device
->request_queue
, sdp
->disk
,
770 srp
->rq
, 1, sg_rq_end_io
);
775 sg_ioctl(struct file
*filp
, unsigned int cmd_in
, unsigned long arg
)
777 void __user
*p
= (void __user
*)arg
;
779 int result
, val
, read_only
;
783 unsigned long iflags
;
785 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
788 SCSI_LOG_TIMEOUT(3, printk("sg_ioctl: %s, cmd=0x%x\n",
789 sdp
->disk
->disk_name
, (int) cmd_in
));
790 read_only
= (O_RDWR
!= (filp
->f_flags
& O_ACCMODE
));
795 int blocking
= 1; /* ignore O_NONBLOCK flag */
799 if (!scsi_block_when_processing_errors(sdp
->device
))
801 if (!access_ok(VERIFY_WRITE
, p
, SZ_SG_IO_HDR
))
804 sg_new_write(sfp
, filp
, p
, SZ_SG_IO_HDR
,
805 blocking
, read_only
, 1, &srp
);
809 result
= 0; /* following macro to beat race condition */
810 __wait_event_interruptible(sfp
->read_wait
,
811 (srp
->done
|| sdp
->detached
),
815 write_lock_irq(&sfp
->rq_list_lock
);
818 write_unlock_irq(&sfp
->rq_list_lock
);
822 write_unlock_irq(&sfp
->rq_list_lock
);
823 return result
; /* -ERESTARTSYS because signal hit process */
825 result
= sg_new_read(sfp
, p
, SZ_SG_IO_HDR
, srp
);
826 return (result
< 0) ? result
: 0;
829 result
= get_user(val
, ip
);
834 if (val
>= MULDIV (INT_MAX
, USER_HZ
, HZ
))
835 val
= MULDIV (INT_MAX
, USER_HZ
, HZ
);
836 sfp
->timeout_user
= val
;
837 sfp
->timeout
= MULDIV (val
, HZ
, USER_HZ
);
840 case SG_GET_TIMEOUT
: /* N.B. User receives timeout as return value */
841 /* strange ..., for backward compatibility */
842 return sfp
->timeout_user
;
843 case SG_SET_FORCE_LOW_DMA
:
844 result
= get_user(val
, ip
);
849 if ((0 == sfp
->low_dma
) && (0 == sg_res_in_use(sfp
))) {
850 val
= (int) sfp
->reserve
.bufflen
;
851 sg_remove_scat(&sfp
->reserve
);
852 sg_build_reserve(sfp
, val
);
857 sfp
->low_dma
= sdp
->device
->host
->unchecked_isa_dma
;
861 return put_user((int) sfp
->low_dma
, ip
);
863 if (!access_ok(VERIFY_WRITE
, p
, sizeof (sg_scsi_id_t
)))
866 sg_scsi_id_t __user
*sg_idp
= p
;
870 __put_user((int) sdp
->device
->host
->host_no
,
872 __put_user((int) sdp
->device
->channel
,
874 __put_user((int) sdp
->device
->id
, &sg_idp
->scsi_id
);
875 __put_user((int) sdp
->device
->lun
, &sg_idp
->lun
);
876 __put_user((int) sdp
->device
->type
, &sg_idp
->scsi_type
);
877 __put_user((short) sdp
->device
->host
->cmd_per_lun
,
878 &sg_idp
->h_cmd_per_lun
);
879 __put_user((short) sdp
->device
->queue_depth
,
880 &sg_idp
->d_queue_depth
);
881 __put_user(0, &sg_idp
->unused
[0]);
882 __put_user(0, &sg_idp
->unused
[1]);
885 case SG_SET_FORCE_PACK_ID
:
886 result
= get_user(val
, ip
);
889 sfp
->force_packid
= val
? 1 : 0;
892 if (!access_ok(VERIFY_WRITE
, ip
, sizeof (int)))
894 read_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
895 for (srp
= sfp
->headrp
; srp
; srp
= srp
->nextrp
) {
896 if ((1 == srp
->done
) && (!srp
->sg_io_owned
)) {
897 read_unlock_irqrestore(&sfp
->rq_list_lock
,
899 __put_user(srp
->header
.pack_id
, ip
);
903 read_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
906 case SG_GET_NUM_WAITING
:
907 read_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
908 for (val
= 0, srp
= sfp
->headrp
; srp
; srp
= srp
->nextrp
) {
909 if ((1 == srp
->done
) && (!srp
->sg_io_owned
))
912 read_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
913 return put_user(val
, ip
);
914 case SG_GET_SG_TABLESIZE
:
915 return put_user(sdp
->sg_tablesize
, ip
);
916 case SG_SET_RESERVED_SIZE
:
917 result
= get_user(val
, ip
);
922 val
= min_t(int, val
,
923 queue_max_sectors(sdp
->device
->request_queue
) * 512);
924 if (val
!= sfp
->reserve
.bufflen
) {
925 if (sg_res_in_use(sfp
) || sfp
->mmap_called
)
927 sg_remove_scat(&sfp
->reserve
);
928 sg_build_reserve(sfp
, val
);
931 case SG_GET_RESERVED_SIZE
:
932 val
= min_t(int, sfp
->reserve
.bufflen
,
933 queue_max_sectors(sdp
->device
->request_queue
) * 512);
934 return put_user(val
, ip
);
935 case SG_SET_COMMAND_Q
:
936 result
= get_user(val
, ip
);
939 sfp
->cmd_q
= val
? 1 : 0;
941 case SG_GET_COMMAND_Q
:
942 return put_user((int) sfp
->cmd_q
, ip
);
943 case SG_SET_KEEP_ORPHAN
:
944 result
= get_user(val
, ip
);
947 sfp
->keep_orphan
= val
;
949 case SG_GET_KEEP_ORPHAN
:
950 return put_user((int) sfp
->keep_orphan
, ip
);
951 case SG_NEXT_CMD_LEN
:
952 result
= get_user(val
, ip
);
955 sfp
->next_cmd_len
= (val
> 0) ? val
: 0;
957 case SG_GET_VERSION_NUM
:
958 return put_user(sg_version_num
, ip
);
959 case SG_GET_ACCESS_COUNT
:
960 /* faked - we don't have a real access count anymore */
961 val
= (sdp
->device
? 1 : 0);
962 return put_user(val
, ip
);
963 case SG_GET_REQUEST_TABLE
:
964 if (!access_ok(VERIFY_WRITE
, p
, SZ_SG_REQ_INFO
* SG_MAX_QUEUE
))
967 sg_req_info_t
*rinfo
;
970 rinfo
= kmalloc(SZ_SG_REQ_INFO
* SG_MAX_QUEUE
,
974 read_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
975 for (srp
= sfp
->headrp
, val
= 0; val
< SG_MAX_QUEUE
;
976 ++val
, srp
= srp
? srp
->nextrp
: srp
) {
977 memset(&rinfo
[val
], 0, SZ_SG_REQ_INFO
);
979 rinfo
[val
].req_state
= srp
->done
+ 1;
981 srp
->header
.masked_status
&
982 srp
->header
.host_status
&
983 srp
->header
.driver_status
;
985 rinfo
[val
].duration
=
986 srp
->header
.duration
;
988 ms
= jiffies_to_msecs(jiffies
);
989 rinfo
[val
].duration
=
990 (ms
> srp
->header
.duration
) ?
991 (ms
- srp
->header
.duration
) : 0;
993 rinfo
[val
].orphan
= srp
->orphan
;
994 rinfo
[val
].sg_io_owned
=
1002 read_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
1003 result
= __copy_to_user(p
, rinfo
,
1004 SZ_SG_REQ_INFO
* SG_MAX_QUEUE
);
1005 result
= result
? -EFAULT
: 0;
1009 case SG_EMULATED_HOST
:
1012 return put_user(sdp
->device
->host
->hostt
->emulated
, ip
);
1016 if (filp
->f_flags
& O_NONBLOCK
) {
1017 if (scsi_host_in_recovery(sdp
->device
->host
))
1019 } else if (!scsi_block_when_processing_errors(sdp
->device
))
1021 result
= get_user(val
, ip
);
1024 if (SG_SCSI_RESET_NOTHING
== val
)
1027 case SG_SCSI_RESET_DEVICE
:
1028 val
= SCSI_TRY_RESET_DEVICE
;
1030 case SG_SCSI_RESET_TARGET
:
1031 val
= SCSI_TRY_RESET_TARGET
;
1033 case SG_SCSI_RESET_BUS
:
1034 val
= SCSI_TRY_RESET_BUS
;
1036 case SG_SCSI_RESET_HOST
:
1037 val
= SCSI_TRY_RESET_HOST
;
1042 if (!capable(CAP_SYS_ADMIN
) || !capable(CAP_SYS_RAWIO
))
1044 return (scsi_reset_provider(sdp
->device
, val
) ==
1045 SUCCESS
) ? 0 : -EIO
;
1046 case SCSI_IOCTL_SEND_COMMAND
:
1050 unsigned char opcode
= WRITE_6
;
1051 Scsi_Ioctl_Command __user
*siocp
= p
;
1053 if (copy_from_user(&opcode
, siocp
->data
, 1))
1055 if (sg_allow_access(filp
, &opcode
))
1058 return sg_scsi_ioctl(sdp
->device
->request_queue
, NULL
, filp
->f_mode
, p
);
1060 result
= get_user(val
, ip
);
1063 sdp
->sgdebug
= (char) val
;
1065 case SCSI_IOCTL_GET_IDLUN
:
1066 case SCSI_IOCTL_GET_BUS_NUMBER
:
1067 case SCSI_IOCTL_PROBE_HOST
:
1068 case SG_GET_TRANSFORM
:
1071 return scsi_ioctl(sdp
->device
, cmd_in
, p
);
1073 return put_user(queue_max_sectors(sdp
->device
->request_queue
) * 512,
1076 return blk_trace_setup(sdp
->device
->request_queue
,
1077 sdp
->disk
->disk_name
,
1078 MKDEV(SCSI_GENERIC_MAJOR
, sdp
->index
),
1082 return blk_trace_startstop(sdp
->device
->request_queue
, 1);
1084 return blk_trace_startstop(sdp
->device
->request_queue
, 0);
1085 case BLKTRACETEARDOWN
:
1086 return blk_trace_remove(sdp
->device
->request_queue
);
1089 return -EPERM
; /* don't know so take safe approach */
1090 return scsi_ioctl(sdp
->device
, cmd_in
, p
);
1095 sg_unlocked_ioctl(struct file
*filp
, unsigned int cmd_in
, unsigned long arg
)
1099 mutex_lock(&sg_mutex
);
1100 ret
= sg_ioctl(filp
, cmd_in
, arg
);
1101 mutex_unlock(&sg_mutex
);
1106 #ifdef CONFIG_COMPAT
1107 static long sg_compat_ioctl(struct file
*filp
, unsigned int cmd_in
, unsigned long arg
)
1111 struct scsi_device
*sdev
;
1113 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
1117 if (sdev
->host
->hostt
->compat_ioctl
) {
1120 ret
= sdev
->host
->hostt
->compat_ioctl(sdev
, cmd_in
, (void __user
*)arg
);
1125 return -ENOIOCTLCMD
;
1130 sg_poll(struct file
*filp
, poll_table
* wait
)
1132 unsigned int res
= 0;
1137 unsigned long iflags
;
1139 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
))
1142 poll_wait(filp
, &sfp
->read_wait
, wait
);
1143 read_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
1144 for (srp
= sfp
->headrp
; srp
; srp
= srp
->nextrp
) {
1145 /* if any read waiting, flag it */
1146 if ((0 == res
) && (1 == srp
->done
) && (!srp
->sg_io_owned
))
1147 res
= POLLIN
| POLLRDNORM
;
1150 read_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
1154 else if (!sfp
->cmd_q
) {
1156 res
|= POLLOUT
| POLLWRNORM
;
1157 } else if (count
< SG_MAX_QUEUE
)
1158 res
|= POLLOUT
| POLLWRNORM
;
1159 SCSI_LOG_TIMEOUT(3, printk("sg_poll: %s, res=0x%x\n",
1160 sdp
->disk
->disk_name
, (int) res
));
1165 sg_fasync(int fd
, struct file
*filp
, int mode
)
1170 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
1172 SCSI_LOG_TIMEOUT(3, printk("sg_fasync: %s, mode=%d\n",
1173 sdp
->disk
->disk_name
, mode
));
1175 return fasync_helper(fd
, filp
, mode
, &sfp
->async_qp
);
1179 sg_vma_fault(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
1182 unsigned long offset
, len
, sa
;
1183 Sg_scatter_hold
*rsv_schp
;
1186 if ((NULL
== vma
) || (!(sfp
= (Sg_fd
*) vma
->vm_private_data
)))
1187 return VM_FAULT_SIGBUS
;
1188 rsv_schp
= &sfp
->reserve
;
1189 offset
= vmf
->pgoff
<< PAGE_SHIFT
;
1190 if (offset
>= rsv_schp
->bufflen
)
1191 return VM_FAULT_SIGBUS
;
1192 SCSI_LOG_TIMEOUT(3, printk("sg_vma_fault: offset=%lu, scatg=%d\n",
1193 offset
, rsv_schp
->k_use_sg
));
1195 length
= 1 << (PAGE_SHIFT
+ rsv_schp
->page_order
);
1196 for (k
= 0; k
< rsv_schp
->k_use_sg
&& sa
< vma
->vm_end
; k
++) {
1197 len
= vma
->vm_end
- sa
;
1198 len
= (len
< length
) ? len
: length
;
1200 struct page
*page
= nth_page(rsv_schp
->pages
[k
],
1201 offset
>> PAGE_SHIFT
);
1202 get_page(page
); /* increment page count */
1204 return 0; /* success */
1210 return VM_FAULT_SIGBUS
;
1213 static const struct vm_operations_struct sg_mmap_vm_ops
= {
1214 .fault
= sg_vma_fault
,
1218 sg_mmap(struct file
*filp
, struct vm_area_struct
*vma
)
1221 unsigned long req_sz
, len
, sa
;
1222 Sg_scatter_hold
*rsv_schp
;
1225 if ((!filp
) || (!vma
) || (!(sfp
= (Sg_fd
*) filp
->private_data
)))
1227 req_sz
= vma
->vm_end
- vma
->vm_start
;
1228 SCSI_LOG_TIMEOUT(3, printk("sg_mmap starting, vm_start=%p, len=%d\n",
1229 (void *) vma
->vm_start
, (int) req_sz
));
1231 return -EINVAL
; /* want no offset */
1232 rsv_schp
= &sfp
->reserve
;
1233 if (req_sz
> rsv_schp
->bufflen
)
1234 return -ENOMEM
; /* cannot map more than reserved buffer */
1237 length
= 1 << (PAGE_SHIFT
+ rsv_schp
->page_order
);
1238 for (k
= 0; k
< rsv_schp
->k_use_sg
&& sa
< vma
->vm_end
; k
++) {
1239 len
= vma
->vm_end
- sa
;
1240 len
= (len
< length
) ? len
: length
;
1244 sfp
->mmap_called
= 1;
1245 vma
->vm_flags
|= VM_RESERVED
;
1246 vma
->vm_private_data
= sfp
;
1247 vma
->vm_ops
= &sg_mmap_vm_ops
;
1251 static void sg_rq_end_io_usercontext(struct work_struct
*work
)
1253 struct sg_request
*srp
= container_of(work
, struct sg_request
, ew
.work
);
1254 struct sg_fd
*sfp
= srp
->parentfp
;
1256 sg_finish_rem_req(srp
);
1257 kref_put(&sfp
->f_ref
, sg_remove_sfp
);
1261 * This function is a "bottom half" handler that is called by the mid
1262 * level when a command is completed (or has failed).
1264 static void sg_rq_end_io(struct request
*rq
, int uptodate
)
1266 struct sg_request
*srp
= rq
->end_io_data
;
1269 unsigned long iflags
;
1272 int result
, resid
, done
= 1;
1274 if (WARN_ON(srp
->done
!= 0))
1277 sfp
= srp
->parentfp
;
1278 if (WARN_ON(sfp
== NULL
))
1281 sdp
= sfp
->parentdp
;
1282 if (unlikely(sdp
->detached
))
1283 printk(KERN_INFO
"sg_rq_end_io: device detached\n");
1286 result
= rq
->errors
;
1287 resid
= rq
->resid_len
;
1289 SCSI_LOG_TIMEOUT(4, printk("sg_cmd_done: %s, pack_id=%d, res=0x%x\n",
1290 sdp
->disk
->disk_name
, srp
->header
.pack_id
, result
));
1291 srp
->header
.resid
= resid
;
1292 ms
= jiffies_to_msecs(jiffies
);
1293 srp
->header
.duration
= (ms
> srp
->header
.duration
) ?
1294 (ms
- srp
->header
.duration
) : 0;
1296 struct scsi_sense_hdr sshdr
;
1298 srp
->header
.status
= 0xff & result
;
1299 srp
->header
.masked_status
= status_byte(result
);
1300 srp
->header
.msg_status
= msg_byte(result
);
1301 srp
->header
.host_status
= host_byte(result
);
1302 srp
->header
.driver_status
= driver_byte(result
);
1303 if ((sdp
->sgdebug
> 0) &&
1304 ((CHECK_CONDITION
== srp
->header
.masked_status
) ||
1305 (COMMAND_TERMINATED
== srp
->header
.masked_status
)))
1306 __scsi_print_sense("sg_cmd_done", sense
,
1307 SCSI_SENSE_BUFFERSIZE
);
1309 /* Following if statement is a patch supplied by Eric Youngdale */
1310 if (driver_byte(result
) != 0
1311 && scsi_normalize_sense(sense
, SCSI_SENSE_BUFFERSIZE
, &sshdr
)
1312 && !scsi_sense_is_deferred(&sshdr
)
1313 && sshdr
.sense_key
== UNIT_ATTENTION
1314 && sdp
->device
->removable
) {
1315 /* Detected possible disc change. Set the bit - this */
1316 /* may be used if there are filesystems using this device */
1317 sdp
->device
->changed
= 1;
1320 /* Rely on write phase to clean out srp status values, so no "else" */
1322 write_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
1323 if (unlikely(srp
->orphan
)) {
1324 if (sfp
->keep_orphan
)
1325 srp
->sg_io_owned
= 0;
1330 write_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
1333 /* Now wake up any sg_read() that is waiting for this
1336 wake_up_interruptible(&sfp
->read_wait
);
1337 kill_fasync(&sfp
->async_qp
, SIGPOLL
, POLL_IN
);
1338 kref_put(&sfp
->f_ref
, sg_remove_sfp
);
1340 INIT_WORK(&srp
->ew
.work
, sg_rq_end_io_usercontext
);
1341 schedule_work(&srp
->ew
.work
);
1345 static const struct file_operations sg_fops
= {
1346 .owner
= THIS_MODULE
,
1350 .unlocked_ioctl
= sg_unlocked_ioctl
,
1351 #ifdef CONFIG_COMPAT
1352 .compat_ioctl
= sg_compat_ioctl
,
1356 .release
= sg_release
,
1357 .fasync
= sg_fasync
,
1358 .llseek
= no_llseek
,
1361 static struct class *sg_sysfs_class
;
1363 static int sg_sysfs_valid
= 0;
1365 static Sg_device
*sg_alloc(struct gendisk
*disk
, struct scsi_device
*scsidp
)
1367 struct request_queue
*q
= scsidp
->request_queue
;
1369 unsigned long iflags
;
1373 sdp
= kzalloc(sizeof(Sg_device
), GFP_KERNEL
);
1375 printk(KERN_WARNING
"kmalloc Sg_device failure\n");
1376 return ERR_PTR(-ENOMEM
);
1379 if (!idr_pre_get(&sg_index_idr
, GFP_KERNEL
)) {
1380 printk(KERN_WARNING
"idr expansion Sg_device failure\n");
1385 write_lock_irqsave(&sg_index_lock
, iflags
);
1387 error
= idr_get_new(&sg_index_idr
, sdp
, &k
);
1389 write_unlock_irqrestore(&sg_index_lock
, iflags
);
1390 printk(KERN_WARNING
"idr allocation Sg_device failure: %d\n",
1395 if (unlikely(k
>= SG_MAX_DEVS
))
1398 SCSI_LOG_TIMEOUT(3, printk("sg_alloc: dev=%d \n", k
));
1399 sprintf(disk
->disk_name
, "sg%d", k
);
1400 disk
->first_minor
= k
;
1402 sdp
->device
= scsidp
;
1403 INIT_LIST_HEAD(&sdp
->sfds
);
1404 init_waitqueue_head(&sdp
->o_excl_wait
);
1405 sdp
->sg_tablesize
= queue_max_segments(q
);
1407 kref_init(&sdp
->d_ref
);
1409 write_unlock_irqrestore(&sg_index_lock
, iflags
);
1415 return ERR_PTR(error
);
1420 idr_remove(&sg_index_idr
, k
);
1421 write_unlock_irqrestore(&sg_index_lock
, iflags
);
1422 sdev_printk(KERN_WARNING
, scsidp
,
1423 "Unable to attach sg device type=%d, minor "
1424 "number exceeds %d\n", scsidp
->type
, SG_MAX_DEVS
- 1);
1430 sg_add(struct device
*cl_dev
, struct class_interface
*cl_intf
)
1432 struct scsi_device
*scsidp
= to_scsi_device(cl_dev
->parent
);
1433 struct gendisk
*disk
;
1434 Sg_device
*sdp
= NULL
;
1435 struct cdev
* cdev
= NULL
;
1437 unsigned long iflags
;
1439 disk
= alloc_disk(1);
1441 printk(KERN_WARNING
"alloc_disk failed\n");
1444 disk
->major
= SCSI_GENERIC_MAJOR
;
1447 cdev
= cdev_alloc();
1449 printk(KERN_WARNING
"cdev_alloc failed\n");
1452 cdev
->owner
= THIS_MODULE
;
1453 cdev
->ops
= &sg_fops
;
1455 sdp
= sg_alloc(disk
, scsidp
);
1457 printk(KERN_WARNING
"sg_alloc failed\n");
1458 error
= PTR_ERR(sdp
);
1462 error
= cdev_add(cdev
, MKDEV(SCSI_GENERIC_MAJOR
, sdp
->index
), 1);
1467 if (sg_sysfs_valid
) {
1468 struct device
*sg_class_member
;
1470 sg_class_member
= device_create(sg_sysfs_class
, cl_dev
->parent
,
1471 MKDEV(SCSI_GENERIC_MAJOR
,
1473 sdp
, "%s", disk
->disk_name
);
1474 if (IS_ERR(sg_class_member
)) {
1475 printk(KERN_ERR
"sg_add: "
1476 "device_create failed\n");
1477 error
= PTR_ERR(sg_class_member
);
1480 error
= sysfs_create_link(&scsidp
->sdev_gendev
.kobj
,
1481 &sg_class_member
->kobj
, "generic");
1483 printk(KERN_ERR
"sg_add: unable to make symlink "
1484 "'generic' back to sg%d\n", sdp
->index
);
1486 printk(KERN_WARNING
"sg_add: sg_sys Invalid\n");
1488 sdev_printk(KERN_NOTICE
, scsidp
,
1489 "Attached scsi generic sg%d type %d\n", sdp
->index
,
1492 dev_set_drvdata(cl_dev
, sdp
);
1497 write_lock_irqsave(&sg_index_lock
, iflags
);
1498 idr_remove(&sg_index_idr
, sdp
->index
);
1499 write_unlock_irqrestore(&sg_index_lock
, iflags
);
1509 static void sg_device_destroy(struct kref
*kref
)
1511 struct sg_device
*sdp
= container_of(kref
, struct sg_device
, d_ref
);
1512 unsigned long flags
;
1514 /* CAUTION! Note that the device can still be found via idr_find()
1515 * even though the refcount is 0. Therefore, do idr_remove() BEFORE
1516 * any other cleanup.
1519 write_lock_irqsave(&sg_index_lock
, flags
);
1520 idr_remove(&sg_index_idr
, sdp
->index
);
1521 write_unlock_irqrestore(&sg_index_lock
, flags
);
1524 printk("sg_device_destroy: %s\n",
1525 sdp
->disk
->disk_name
));
1527 put_disk(sdp
->disk
);
1531 static void sg_remove(struct device
*cl_dev
, struct class_interface
*cl_intf
)
1533 struct scsi_device
*scsidp
= to_scsi_device(cl_dev
->parent
);
1534 Sg_device
*sdp
= dev_get_drvdata(cl_dev
);
1535 unsigned long iflags
;
1538 if (!sdp
|| sdp
->detached
)
1541 SCSI_LOG_TIMEOUT(3, printk("sg_remove: %s\n", sdp
->disk
->disk_name
));
1543 /* Need a write lock to set sdp->detached. */
1544 write_lock_irqsave(&sg_index_lock
, iflags
);
1546 list_for_each_entry(sfp
, &sdp
->sfds
, sfd_siblings
) {
1547 wake_up_interruptible(&sfp
->read_wait
);
1548 kill_fasync(&sfp
->async_qp
, SIGPOLL
, POLL_HUP
);
1550 write_unlock_irqrestore(&sg_index_lock
, iflags
);
1552 sysfs_remove_link(&scsidp
->sdev_gendev
.kobj
, "generic");
1553 device_destroy(sg_sysfs_class
, MKDEV(SCSI_GENERIC_MAJOR
, sdp
->index
));
1554 cdev_del(sdp
->cdev
);
1560 module_param_named(scatter_elem_sz
, scatter_elem_sz
, int, S_IRUGO
| S_IWUSR
);
1561 module_param_named(def_reserved_size
, def_reserved_size
, int,
1563 module_param_named(allow_dio
, sg_allow_dio
, int, S_IRUGO
| S_IWUSR
);
1565 MODULE_AUTHOR("Douglas Gilbert");
1566 MODULE_DESCRIPTION("SCSI generic (sg) driver");
1567 MODULE_LICENSE("GPL");
1568 MODULE_VERSION(SG_VERSION_STR
);
1569 MODULE_ALIAS_CHARDEV_MAJOR(SCSI_GENERIC_MAJOR
);
1571 MODULE_PARM_DESC(scatter_elem_sz
, "scatter gather element "
1572 "size (default: max(SG_SCATTER_SZ, PAGE_SIZE))");
1573 MODULE_PARM_DESC(def_reserved_size
, "size of buffer reserved for each fd");
1574 MODULE_PARM_DESC(allow_dio
, "allow direct I/O (default: 0 (disallow))");
1581 if (scatter_elem_sz
< PAGE_SIZE
) {
1582 scatter_elem_sz
= PAGE_SIZE
;
1583 scatter_elem_sz_prev
= scatter_elem_sz
;
1585 if (def_reserved_size
>= 0)
1586 sg_big_buff
= def_reserved_size
;
1588 def_reserved_size
= sg_big_buff
;
1590 rc
= register_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR
, 0),
1594 sg_sysfs_class
= class_create(THIS_MODULE
, "scsi_generic");
1595 if ( IS_ERR(sg_sysfs_class
) ) {
1596 rc
= PTR_ERR(sg_sysfs_class
);
1600 rc
= scsi_register_interface(&sg_interface
);
1602 #ifdef CONFIG_SCSI_PROC_FS
1604 #endif /* CONFIG_SCSI_PROC_FS */
1607 class_destroy(sg_sysfs_class
);
1609 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR
, 0), SG_MAX_DEVS
);
1616 #ifdef CONFIG_SCSI_PROC_FS
1618 #endif /* CONFIG_SCSI_PROC_FS */
1619 scsi_unregister_interface(&sg_interface
);
1620 class_destroy(sg_sysfs_class
);
1622 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR
, 0),
1624 idr_destroy(&sg_index_idr
);
1627 static int sg_start_req(Sg_request
*srp
, unsigned char *cmd
)
1631 Sg_fd
*sfp
= srp
->parentfp
;
1632 sg_io_hdr_t
*hp
= &srp
->header
;
1633 int dxfer_len
= (int) hp
->dxfer_len
;
1634 int dxfer_dir
= hp
->dxfer_direction
;
1635 unsigned int iov_count
= hp
->iovec_count
;
1636 Sg_scatter_hold
*req_schp
= &srp
->data
;
1637 Sg_scatter_hold
*rsv_schp
= &sfp
->reserve
;
1638 struct request_queue
*q
= sfp
->parentdp
->device
->request_queue
;
1639 struct rq_map_data
*md
, map_data
;
1640 int rw
= hp
->dxfer_direction
== SG_DXFER_TO_DEV
? WRITE
: READ
;
1642 SCSI_LOG_TIMEOUT(4, printk(KERN_INFO
"sg_start_req: dxfer_len=%d\n",
1645 rq
= blk_get_request(q
, rw
, GFP_ATOMIC
);
1649 memcpy(rq
->cmd
, cmd
, hp
->cmd_len
);
1651 rq
->cmd_len
= hp
->cmd_len
;
1652 rq
->cmd_type
= REQ_TYPE_BLOCK_PC
;
1655 rq
->end_io_data
= srp
;
1656 rq
->sense
= srp
->sense_b
;
1657 rq
->retries
= SG_DEFAULT_RETRIES
;
1659 if ((dxfer_len
<= 0) || (dxfer_dir
== SG_DXFER_NONE
))
1662 if (sg_allow_dio
&& hp
->flags
& SG_FLAG_DIRECT_IO
&&
1663 dxfer_dir
!= SG_DXFER_UNKNOWN
&& !iov_count
&&
1664 !sfp
->parentdp
->device
->host
->unchecked_isa_dma
&&
1665 blk_rq_aligned(q
, (unsigned long)hp
->dxferp
, dxfer_len
))
1671 if (!sg_res_in_use(sfp
) && dxfer_len
<= rsv_schp
->bufflen
)
1672 sg_link_reserve(sfp
, srp
, dxfer_len
);
1674 res
= sg_build_indirect(req_schp
, sfp
, dxfer_len
);
1679 md
->pages
= req_schp
->pages
;
1680 md
->page_order
= req_schp
->page_order
;
1681 md
->nr_entries
= req_schp
->k_use_sg
;
1683 md
->null_mapped
= hp
->dxferp
? 0 : 1;
1684 if (dxfer_dir
== SG_DXFER_TO_FROM_DEV
)
1691 int len
, size
= sizeof(struct sg_iovec
) * iov_count
;
1694 iov
= memdup_user(hp
->dxferp
, size
);
1696 return PTR_ERR(iov
);
1698 len
= iov_length(iov
, iov_count
);
1699 if (hp
->dxfer_len
< len
) {
1700 iov_count
= iov_shorten(iov
, iov_count
, hp
->dxfer_len
);
1701 len
= hp
->dxfer_len
;
1704 res
= blk_rq_map_user_iov(q
, rq
, md
, (struct sg_iovec
*)iov
,
1709 res
= blk_rq_map_user(q
, rq
, md
, hp
->dxferp
,
1710 hp
->dxfer_len
, GFP_ATOMIC
);
1716 req_schp
->dio_in_use
= 1;
1717 hp
->info
|= SG_INFO_DIRECT_IO
;
1723 static int sg_finish_rem_req(Sg_request
* srp
)
1727 Sg_fd
*sfp
= srp
->parentfp
;
1728 Sg_scatter_hold
*req_schp
= &srp
->data
;
1730 SCSI_LOG_TIMEOUT(4, printk("sg_finish_rem_req: res_used=%d\n", (int) srp
->res_used
));
1733 ret
= blk_rq_unmap_user(srp
->bio
);
1735 blk_put_request(srp
->rq
);
1739 sg_unlink_reserve(sfp
, srp
);
1741 sg_remove_scat(req_schp
);
1743 sg_remove_request(sfp
, srp
);
1749 sg_build_sgat(Sg_scatter_hold
* schp
, const Sg_fd
* sfp
, int tablesize
)
1751 int sg_bufflen
= tablesize
* sizeof(struct page
*);
1752 gfp_t gfp_flags
= GFP_ATOMIC
| __GFP_NOWARN
;
1754 schp
->pages
= kzalloc(sg_bufflen
, gfp_flags
);
1757 schp
->sglist_len
= sg_bufflen
;
1758 return tablesize
; /* number of scat_gath elements allocated */
1762 sg_build_indirect(Sg_scatter_hold
* schp
, Sg_fd
* sfp
, int buff_size
)
1764 int ret_sz
= 0, i
, k
, rem_sz
, num
, mx_sc_elems
;
1765 int sg_tablesize
= sfp
->parentdp
->sg_tablesize
;
1766 int blk_size
= buff_size
, order
;
1767 gfp_t gfp_mask
= GFP_ATOMIC
| __GFP_COMP
| __GFP_NOWARN
;
1772 ++blk_size
; /* don't know why */
1773 /* round request up to next highest SG_SECTOR_SZ byte boundary */
1774 blk_size
= ALIGN(blk_size
, SG_SECTOR_SZ
);
1775 SCSI_LOG_TIMEOUT(4, printk("sg_build_indirect: buff_size=%d, blk_size=%d\n",
1776 buff_size
, blk_size
));
1778 /* N.B. ret_sz carried into this block ... */
1779 mx_sc_elems
= sg_build_sgat(schp
, sfp
, sg_tablesize
);
1780 if (mx_sc_elems
< 0)
1781 return mx_sc_elems
; /* most likely -ENOMEM */
1783 num
= scatter_elem_sz
;
1784 if (unlikely(num
!= scatter_elem_sz_prev
)) {
1785 if (num
< PAGE_SIZE
) {
1786 scatter_elem_sz
= PAGE_SIZE
;
1787 scatter_elem_sz_prev
= PAGE_SIZE
;
1789 scatter_elem_sz_prev
= num
;
1793 gfp_mask
|= GFP_DMA
;
1795 if (!capable(CAP_SYS_ADMIN
) || !capable(CAP_SYS_RAWIO
))
1796 gfp_mask
|= __GFP_ZERO
;
1798 order
= get_order(num
);
1800 ret_sz
= 1 << (PAGE_SHIFT
+ order
);
1802 for (k
= 0, rem_sz
= blk_size
; rem_sz
> 0 && k
< mx_sc_elems
;
1803 k
++, rem_sz
-= ret_sz
) {
1805 num
= (rem_sz
> scatter_elem_sz_prev
) ?
1806 scatter_elem_sz_prev
: rem_sz
;
1808 schp
->pages
[k
] = alloc_pages(gfp_mask
, order
);
1809 if (!schp
->pages
[k
])
1812 if (num
== scatter_elem_sz_prev
) {
1813 if (unlikely(ret_sz
> scatter_elem_sz_prev
)) {
1814 scatter_elem_sz
= ret_sz
;
1815 scatter_elem_sz_prev
= ret_sz
;
1819 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k=%d, num=%d, "
1820 "ret_sz=%d\n", k
, num
, ret_sz
));
1821 } /* end of for loop */
1823 schp
->page_order
= order
;
1825 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k_use_sg=%d, "
1826 "rem_sz=%d\n", k
, rem_sz
));
1828 schp
->bufflen
= blk_size
;
1829 if (rem_sz
> 0) /* must have failed */
1833 for (i
= 0; i
< k
; i
++)
1834 __free_pages(schp
->pages
[i
], order
);
1843 sg_remove_scat(Sg_scatter_hold
* schp
)
1845 SCSI_LOG_TIMEOUT(4, printk("sg_remove_scat: k_use_sg=%d\n", schp
->k_use_sg
));
1846 if (schp
->pages
&& schp
->sglist_len
> 0) {
1847 if (!schp
->dio_in_use
) {
1850 for (k
= 0; k
< schp
->k_use_sg
&& schp
->pages
[k
]; k
++) {
1851 SCSI_LOG_TIMEOUT(5, printk(
1852 "sg_remove_scat: k=%d, pg=0x%p\n",
1853 k
, schp
->pages
[k
]));
1854 __free_pages(schp
->pages
[k
], schp
->page_order
);
1860 memset(schp
, 0, sizeof (*schp
));
1864 sg_read_oxfer(Sg_request
* srp
, char __user
*outp
, int num_read_xfer
)
1866 Sg_scatter_hold
*schp
= &srp
->data
;
1869 SCSI_LOG_TIMEOUT(4, printk("sg_read_oxfer: num_read_xfer=%d\n",
1871 if ((!outp
) || (num_read_xfer
<= 0))
1874 num
= 1 << (PAGE_SHIFT
+ schp
->page_order
);
1875 for (k
= 0; k
< schp
->k_use_sg
&& schp
->pages
[k
]; k
++) {
1876 if (num
> num_read_xfer
) {
1877 if (__copy_to_user(outp
, page_address(schp
->pages
[k
]),
1882 if (__copy_to_user(outp
, page_address(schp
->pages
[k
]),
1885 num_read_xfer
-= num
;
1886 if (num_read_xfer
<= 0)
1896 sg_build_reserve(Sg_fd
* sfp
, int req_size
)
1898 Sg_scatter_hold
*schp
= &sfp
->reserve
;
1900 SCSI_LOG_TIMEOUT(4, printk("sg_build_reserve: req_size=%d\n", req_size
));
1902 if (req_size
< PAGE_SIZE
)
1903 req_size
= PAGE_SIZE
;
1904 if (0 == sg_build_indirect(schp
, sfp
, req_size
))
1907 sg_remove_scat(schp
);
1908 req_size
>>= 1; /* divide by 2 */
1909 } while (req_size
> (PAGE_SIZE
/ 2));
1913 sg_link_reserve(Sg_fd
* sfp
, Sg_request
* srp
, int size
)
1915 Sg_scatter_hold
*req_schp
= &srp
->data
;
1916 Sg_scatter_hold
*rsv_schp
= &sfp
->reserve
;
1920 SCSI_LOG_TIMEOUT(4, printk("sg_link_reserve: size=%d\n", size
));
1923 num
= 1 << (PAGE_SHIFT
+ rsv_schp
->page_order
);
1924 for (k
= 0; k
< rsv_schp
->k_use_sg
; k
++) {
1926 req_schp
->k_use_sg
= k
+ 1;
1927 req_schp
->sglist_len
= rsv_schp
->sglist_len
;
1928 req_schp
->pages
= rsv_schp
->pages
;
1930 req_schp
->bufflen
= size
;
1931 req_schp
->page_order
= rsv_schp
->page_order
;
1937 if (k
>= rsv_schp
->k_use_sg
)
1938 SCSI_LOG_TIMEOUT(1, printk("sg_link_reserve: BAD size\n"));
1942 sg_unlink_reserve(Sg_fd
* sfp
, Sg_request
* srp
)
1944 Sg_scatter_hold
*req_schp
= &srp
->data
;
1946 SCSI_LOG_TIMEOUT(4, printk("sg_unlink_reserve: req->k_use_sg=%d\n",
1947 (int) req_schp
->k_use_sg
));
1948 req_schp
->k_use_sg
= 0;
1949 req_schp
->bufflen
= 0;
1950 req_schp
->pages
= NULL
;
1951 req_schp
->page_order
= 0;
1952 req_schp
->sglist_len
= 0;
1953 sfp
->save_scat_len
= 0;
1958 sg_get_rq_mark(Sg_fd
* sfp
, int pack_id
)
1961 unsigned long iflags
;
1963 write_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
1964 for (resp
= sfp
->headrp
; resp
; resp
= resp
->nextrp
) {
1965 /* look for requests that are ready + not SG_IO owned */
1966 if ((1 == resp
->done
) && (!resp
->sg_io_owned
) &&
1967 ((-1 == pack_id
) || (resp
->header
.pack_id
== pack_id
))) {
1968 resp
->done
= 2; /* guard against other readers */
1972 write_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
1976 /* always adds to end of list */
1978 sg_add_request(Sg_fd
* sfp
)
1981 unsigned long iflags
;
1983 Sg_request
*rp
= sfp
->req_arr
;
1985 write_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
1988 memset(rp
, 0, sizeof (Sg_request
));
1993 if (0 == sfp
->cmd_q
)
1994 resp
= NULL
; /* command queuing disallowed */
1996 for (k
= 0; k
< SG_MAX_QUEUE
; ++k
, ++rp
) {
2000 if (k
< SG_MAX_QUEUE
) {
2001 memset(rp
, 0, sizeof (Sg_request
));
2003 while (resp
->nextrp
)
2004 resp
= resp
->nextrp
;
2012 resp
->nextrp
= NULL
;
2013 resp
->header
.duration
= jiffies_to_msecs(jiffies
);
2015 write_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
2019 /* Return of 1 for found; 0 for not found */
2021 sg_remove_request(Sg_fd
* sfp
, Sg_request
* srp
)
2023 Sg_request
*prev_rp
;
2025 unsigned long iflags
;
2028 if ((!sfp
) || (!srp
) || (!sfp
->headrp
))
2030 write_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
2031 prev_rp
= sfp
->headrp
;
2032 if (srp
== prev_rp
) {
2033 sfp
->headrp
= prev_rp
->nextrp
;
2034 prev_rp
->parentfp
= NULL
;
2037 while ((rp
= prev_rp
->nextrp
)) {
2039 prev_rp
->nextrp
= rp
->nextrp
;
2040 rp
->parentfp
= NULL
;
2047 write_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
2052 sg_add_sfp(Sg_device
* sdp
, int dev
)
2055 unsigned long iflags
;
2058 sfp
= kzalloc(sizeof(*sfp
), GFP_ATOMIC
| __GFP_NOWARN
);
2062 init_waitqueue_head(&sfp
->read_wait
);
2063 rwlock_init(&sfp
->rq_list_lock
);
2065 kref_init(&sfp
->f_ref
);
2066 sfp
->timeout
= SG_DEFAULT_TIMEOUT
;
2067 sfp
->timeout_user
= SG_DEFAULT_TIMEOUT_USER
;
2068 sfp
->force_packid
= SG_DEF_FORCE_PACK_ID
;
2069 sfp
->low_dma
= (SG_DEF_FORCE_LOW_DMA
== 0) ?
2070 sdp
->device
->host
->unchecked_isa_dma
: 1;
2071 sfp
->cmd_q
= SG_DEF_COMMAND_Q
;
2072 sfp
->keep_orphan
= SG_DEF_KEEP_ORPHAN
;
2073 sfp
->parentdp
= sdp
;
2074 write_lock_irqsave(&sg_index_lock
, iflags
);
2075 list_add_tail(&sfp
->sfd_siblings
, &sdp
->sfds
);
2076 write_unlock_irqrestore(&sg_index_lock
, iflags
);
2077 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: sfp=0x%p\n", sfp
));
2078 if (unlikely(sg_big_buff
!= def_reserved_size
))
2079 sg_big_buff
= def_reserved_size
;
2081 bufflen
= min_t(int, sg_big_buff
,
2082 queue_max_sectors(sdp
->device
->request_queue
) * 512);
2083 sg_build_reserve(sfp
, bufflen
);
2084 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: bufflen=%d, k_use_sg=%d\n",
2085 sfp
->reserve
.bufflen
, sfp
->reserve
.k_use_sg
));
2087 kref_get(&sdp
->d_ref
);
2088 __module_get(THIS_MODULE
);
2092 static void sg_remove_sfp_usercontext(struct work_struct
*work
)
2094 struct sg_fd
*sfp
= container_of(work
, struct sg_fd
, ew
.work
);
2095 struct sg_device
*sdp
= sfp
->parentdp
;
2097 /* Cleanup any responses which were never read(). */
2099 sg_finish_rem_req(sfp
->headrp
);
2101 if (sfp
->reserve
.bufflen
> 0) {
2103 printk("sg_remove_sfp: bufflen=%d, k_use_sg=%d\n",
2104 (int) sfp
->reserve
.bufflen
,
2105 (int) sfp
->reserve
.k_use_sg
));
2106 sg_remove_scat(&sfp
->reserve
);
2110 printk("sg_remove_sfp: %s, sfp=0x%p\n",
2111 sdp
->disk
->disk_name
,
2115 scsi_device_put(sdp
->device
);
2117 module_put(THIS_MODULE
);
2120 static void sg_remove_sfp(struct kref
*kref
)
2122 struct sg_fd
*sfp
= container_of(kref
, struct sg_fd
, f_ref
);
2123 struct sg_device
*sdp
= sfp
->parentdp
;
2124 unsigned long iflags
;
2126 write_lock_irqsave(&sg_index_lock
, iflags
);
2127 list_del(&sfp
->sfd_siblings
);
2128 write_unlock_irqrestore(&sg_index_lock
, iflags
);
2129 wake_up_interruptible(&sdp
->o_excl_wait
);
2131 INIT_WORK(&sfp
->ew
.work
, sg_remove_sfp_usercontext
);
2132 schedule_work(&sfp
->ew
.work
);
2136 sg_res_in_use(Sg_fd
* sfp
)
2138 const Sg_request
*srp
;
2139 unsigned long iflags
;
2141 read_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
2142 for (srp
= sfp
->headrp
; srp
; srp
= srp
->nextrp
)
2145 read_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
2149 #ifdef CONFIG_SCSI_PROC_FS
2151 sg_idr_max_id(int id
, void *p
, void *data
)
2165 unsigned long iflags
;
2167 read_lock_irqsave(&sg_index_lock
, iflags
);
2168 idr_for_each(&sg_index_idr
, sg_idr_max_id
, &k
);
2169 read_unlock_irqrestore(&sg_index_lock
, iflags
);
2170 return k
+ 1; /* origin 1 */
2174 /* must be called with sg_index_lock held */
2175 static Sg_device
*sg_lookup_dev(int dev
)
2177 return idr_find(&sg_index_idr
, dev
);
2180 static Sg_device
*sg_get_dev(int dev
)
2182 struct sg_device
*sdp
;
2183 unsigned long flags
;
2185 read_lock_irqsave(&sg_index_lock
, flags
);
2186 sdp
= sg_lookup_dev(dev
);
2188 sdp
= ERR_PTR(-ENXIO
);
2189 else if (sdp
->detached
) {
2190 /* If sdp->detached, then the refcount may already be 0, in
2191 * which case it would be a bug to do kref_get().
2193 sdp
= ERR_PTR(-ENODEV
);
2195 kref_get(&sdp
->d_ref
);
2196 read_unlock_irqrestore(&sg_index_lock
, flags
);
2201 static void sg_put_dev(struct sg_device
*sdp
)
2203 kref_put(&sdp
->d_ref
, sg_device_destroy
);
2206 #ifdef CONFIG_SCSI_PROC_FS
2208 static struct proc_dir_entry
*sg_proc_sgp
= NULL
;
2210 static char sg_proc_sg_dirname
[] = "scsi/sg";
2212 static int sg_proc_seq_show_int(struct seq_file
*s
, void *v
);
2214 static int sg_proc_single_open_adio(struct inode
*inode
, struct file
*file
);
2215 static ssize_t
sg_proc_write_adio(struct file
*filp
, const char __user
*buffer
,
2216 size_t count
, loff_t
*off
);
2217 static const struct file_operations adio_fops
= {
2218 .owner
= THIS_MODULE
,
2219 .open
= sg_proc_single_open_adio
,
2221 .llseek
= seq_lseek
,
2222 .write
= sg_proc_write_adio
,
2223 .release
= single_release
,
2226 static int sg_proc_single_open_dressz(struct inode
*inode
, struct file
*file
);
2227 static ssize_t
sg_proc_write_dressz(struct file
*filp
,
2228 const char __user
*buffer
, size_t count
, loff_t
*off
);
2229 static const struct file_operations dressz_fops
= {
2230 .owner
= THIS_MODULE
,
2231 .open
= sg_proc_single_open_dressz
,
2233 .llseek
= seq_lseek
,
2234 .write
= sg_proc_write_dressz
,
2235 .release
= single_release
,
2238 static int sg_proc_seq_show_version(struct seq_file
*s
, void *v
);
2239 static int sg_proc_single_open_version(struct inode
*inode
, struct file
*file
);
2240 static const struct file_operations version_fops
= {
2241 .owner
= THIS_MODULE
,
2242 .open
= sg_proc_single_open_version
,
2244 .llseek
= seq_lseek
,
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 const struct file_operations devhdr_fops
= {
2251 .owner
= THIS_MODULE
,
2252 .open
= sg_proc_single_open_devhdr
,
2254 .llseek
= seq_lseek
,
2255 .release
= single_release
,
2258 static int sg_proc_seq_show_dev(struct seq_file
*s
, void *v
);
2259 static int sg_proc_open_dev(struct inode
*inode
, struct file
*file
);
2260 static void * dev_seq_start(struct seq_file
*s
, loff_t
*pos
);
2261 static void * dev_seq_next(struct seq_file
*s
, void *v
, loff_t
*pos
);
2262 static void dev_seq_stop(struct seq_file
*s
, void *v
);
2263 static const struct file_operations dev_fops
= {
2264 .owner
= THIS_MODULE
,
2265 .open
= sg_proc_open_dev
,
2267 .llseek
= seq_lseek
,
2268 .release
= seq_release
,
2270 static const struct seq_operations dev_seq_ops
= {
2271 .start
= dev_seq_start
,
2272 .next
= dev_seq_next
,
2273 .stop
= dev_seq_stop
,
2274 .show
= sg_proc_seq_show_dev
,
2277 static int sg_proc_seq_show_devstrs(struct seq_file
*s
, void *v
);
2278 static int sg_proc_open_devstrs(struct inode
*inode
, struct file
*file
);
2279 static const struct file_operations devstrs_fops
= {
2280 .owner
= THIS_MODULE
,
2281 .open
= sg_proc_open_devstrs
,
2283 .llseek
= seq_lseek
,
2284 .release
= seq_release
,
2286 static const struct seq_operations devstrs_seq_ops
= {
2287 .start
= dev_seq_start
,
2288 .next
= dev_seq_next
,
2289 .stop
= dev_seq_stop
,
2290 .show
= sg_proc_seq_show_devstrs
,
2293 static int sg_proc_seq_show_debug(struct seq_file
*s
, void *v
);
2294 static int sg_proc_open_debug(struct inode
*inode
, struct file
*file
);
2295 static const struct file_operations debug_fops
= {
2296 .owner
= THIS_MODULE
,
2297 .open
= sg_proc_open_debug
,
2299 .llseek
= seq_lseek
,
2300 .release
= seq_release
,
2302 static const struct seq_operations debug_seq_ops
= {
2303 .start
= dev_seq_start
,
2304 .next
= dev_seq_next
,
2305 .stop
= dev_seq_stop
,
2306 .show
= sg_proc_seq_show_debug
,
2310 struct sg_proc_leaf
{
2312 const struct file_operations
* fops
;
2315 static struct sg_proc_leaf sg_proc_leaf_arr
[] = {
2316 {"allow_dio", &adio_fops
},
2317 {"debug", &debug_fops
},
2318 {"def_reserved_size", &dressz_fops
},
2319 {"device_hdr", &devhdr_fops
},
2320 {"devices", &dev_fops
},
2321 {"device_strs", &devstrs_fops
},
2322 {"version", &version_fops
}
2329 int num_leaves
= ARRAY_SIZE(sg_proc_leaf_arr
);
2330 struct sg_proc_leaf
* leaf
;
2332 sg_proc_sgp
= proc_mkdir(sg_proc_sg_dirname
, NULL
);
2335 for (k
= 0; k
< num_leaves
; ++k
) {
2336 leaf
= &sg_proc_leaf_arr
[k
];
2337 mask
= leaf
->fops
->write
? S_IRUGO
| S_IWUSR
: S_IRUGO
;
2338 proc_create(leaf
->name
, mask
, sg_proc_sgp
, leaf
->fops
);
2344 sg_proc_cleanup(void)
2347 int num_leaves
= ARRAY_SIZE(sg_proc_leaf_arr
);
2351 for (k
= 0; k
< num_leaves
; ++k
)
2352 remove_proc_entry(sg_proc_leaf_arr
[k
].name
, sg_proc_sgp
);
2353 remove_proc_entry(sg_proc_sg_dirname
, NULL
);
2357 static int sg_proc_seq_show_int(struct seq_file
*s
, void *v
)
2359 seq_printf(s
, "%d\n", *((int *)s
->private));
2363 static int sg_proc_single_open_adio(struct inode
*inode
, struct file
*file
)
2365 return single_open(file
, sg_proc_seq_show_int
, &sg_allow_dio
);
2369 sg_proc_write_adio(struct file
*filp
, const char __user
*buffer
,
2370 size_t count
, loff_t
*off
)
2375 if (!capable(CAP_SYS_ADMIN
) || !capable(CAP_SYS_RAWIO
))
2377 num
= (count
< 10) ? count
: 10;
2378 if (copy_from_user(buff
, buffer
, num
))
2381 sg_allow_dio
= simple_strtoul(buff
, NULL
, 10) ? 1 : 0;
2385 static int sg_proc_single_open_dressz(struct inode
*inode
, struct file
*file
)
2387 return single_open(file
, sg_proc_seq_show_int
, &sg_big_buff
);
2391 sg_proc_write_dressz(struct file
*filp
, const char __user
*buffer
,
2392 size_t count
, loff_t
*off
)
2395 unsigned long k
= ULONG_MAX
;
2398 if (!capable(CAP_SYS_ADMIN
) || !capable(CAP_SYS_RAWIO
))
2400 num
= (count
< 10) ? count
: 10;
2401 if (copy_from_user(buff
, buffer
, num
))
2404 k
= simple_strtoul(buff
, NULL
, 10);
2405 if (k
<= 1048576) { /* limit "big buff" to 1 MB */
2412 static int sg_proc_seq_show_version(struct seq_file
*s
, void *v
)
2414 seq_printf(s
, "%d\t%s [%s]\n", sg_version_num
, SG_VERSION_STR
,
2419 static int sg_proc_single_open_version(struct inode
*inode
, struct file
*file
)
2421 return single_open(file
, sg_proc_seq_show_version
, NULL
);
2424 static int sg_proc_seq_show_devhdr(struct seq_file
*s
, void *v
)
2426 seq_printf(s
, "host\tchan\tid\tlun\ttype\topens\tqdepth\tbusy\t"
2431 static int sg_proc_single_open_devhdr(struct inode
*inode
, struct file
*file
)
2433 return single_open(file
, sg_proc_seq_show_devhdr
, NULL
);
2436 struct sg_proc_deviter
{
2441 static void * dev_seq_start(struct seq_file
*s
, loff_t
*pos
)
2443 struct sg_proc_deviter
* it
= kmalloc(sizeof(*it
), GFP_KERNEL
);
2450 it
->max
= sg_last_dev();
2451 if (it
->index
>= it
->max
)
2456 static void * dev_seq_next(struct seq_file
*s
, void *v
, loff_t
*pos
)
2458 struct sg_proc_deviter
* it
= s
->private;
2461 return (it
->index
< it
->max
) ? it
: NULL
;
2464 static void dev_seq_stop(struct seq_file
*s
, void *v
)
2469 static int sg_proc_open_dev(struct inode
*inode
, struct file
*file
)
2471 return seq_open(file
, &dev_seq_ops
);
2474 static int sg_proc_seq_show_dev(struct seq_file
*s
, void *v
)
2476 struct sg_proc_deviter
* it
= (struct sg_proc_deviter
*) v
;
2478 struct scsi_device
*scsidp
;
2479 unsigned long iflags
;
2481 read_lock_irqsave(&sg_index_lock
, iflags
);
2482 sdp
= it
? sg_lookup_dev(it
->index
) : NULL
;
2483 if (sdp
&& (scsidp
= sdp
->device
) && (!sdp
->detached
))
2484 seq_printf(s
, "%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\n",
2485 scsidp
->host
->host_no
, scsidp
->channel
,
2486 scsidp
->id
, scsidp
->lun
, (int) scsidp
->type
,
2488 (int) scsidp
->queue_depth
,
2489 (int) scsidp
->device_busy
,
2490 (int) scsi_device_online(scsidp
));
2492 seq_printf(s
, "-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\n");
2493 read_unlock_irqrestore(&sg_index_lock
, iflags
);
2497 static int sg_proc_open_devstrs(struct inode
*inode
, struct file
*file
)
2499 return seq_open(file
, &devstrs_seq_ops
);
2502 static int sg_proc_seq_show_devstrs(struct seq_file
*s
, void *v
)
2504 struct sg_proc_deviter
* it
= (struct sg_proc_deviter
*) v
;
2506 struct scsi_device
*scsidp
;
2507 unsigned long iflags
;
2509 read_lock_irqsave(&sg_index_lock
, iflags
);
2510 sdp
= it
? sg_lookup_dev(it
->index
) : NULL
;
2511 if (sdp
&& (scsidp
= sdp
->device
) && (!sdp
->detached
))
2512 seq_printf(s
, "%8.8s\t%16.16s\t%4.4s\n",
2513 scsidp
->vendor
, scsidp
->model
, scsidp
->rev
);
2515 seq_printf(s
, "<no active device>\n");
2516 read_unlock_irqrestore(&sg_index_lock
, iflags
);
2520 /* must be called while holding sg_index_lock */
2521 static void sg_proc_debug_helper(struct seq_file
*s
, Sg_device
* sdp
)
2523 int k
, m
, new_interface
, blen
, usg
;
2526 const sg_io_hdr_t
*hp
;
2531 list_for_each_entry(fp
, &sdp
->sfds
, sfd_siblings
) {
2533 read_lock(&fp
->rq_list_lock
); /* irqs already disabled */
2534 seq_printf(s
, " FD(%d): timeout=%dms bufflen=%d "
2535 "(res)sgat=%d low_dma=%d\n", k
,
2536 jiffies_to_msecs(fp
->timeout
),
2537 fp
->reserve
.bufflen
,
2538 (int) fp
->reserve
.k_use_sg
,
2540 seq_printf(s
, " cmd_q=%d f_packid=%d k_orphan=%d closed=%d\n",
2541 (int) fp
->cmd_q
, (int) fp
->force_packid
,
2542 (int) fp
->keep_orphan
, (int) fp
->closed
);
2543 for (m
= 0, srp
= fp
->headrp
;
2545 ++m
, srp
= srp
->nextrp
) {
2547 new_interface
= (hp
->interface_id
== '\0') ? 0 : 1;
2548 if (srp
->res_used
) {
2549 if (new_interface
&&
2550 (SG_FLAG_MMAP_IO
& hp
->flags
))
2555 if (SG_INFO_DIRECT_IO_MASK
& hp
->info
)
2561 blen
= srp
->data
.bufflen
;
2562 usg
= srp
->data
.k_use_sg
;
2563 seq_printf(s
, srp
->done
?
2564 ((1 == srp
->done
) ? "rcv:" : "fin:")
2566 seq_printf(s
, " id=%d blen=%d",
2567 srp
->header
.pack_id
, blen
);
2569 seq_printf(s
, " dur=%d", hp
->duration
);
2571 ms
= jiffies_to_msecs(jiffies
);
2572 seq_printf(s
, " t_o/elap=%d/%d",
2573 (new_interface
? hp
->timeout
:
2574 jiffies_to_msecs(fp
->timeout
)),
2575 (ms
> hp
->duration
? ms
- hp
->duration
: 0));
2577 seq_printf(s
, "ms sgat=%d op=0x%02x\n", usg
,
2578 (int) srp
->data
.cmd_opcode
);
2581 seq_printf(s
, " No requests active\n");
2582 read_unlock(&fp
->rq_list_lock
);
2586 static int sg_proc_open_debug(struct inode
*inode
, struct file
*file
)
2588 return seq_open(file
, &debug_seq_ops
);
2591 static int sg_proc_seq_show_debug(struct seq_file
*s
, void *v
)
2593 struct sg_proc_deviter
* it
= (struct sg_proc_deviter
*) v
;
2595 unsigned long iflags
;
2597 if (it
&& (0 == it
->index
)) {
2598 seq_printf(s
, "max_active_device=%d(origin 1)\n",
2600 seq_printf(s
, " def_reserved_size=%d\n", sg_big_buff
);
2603 read_lock_irqsave(&sg_index_lock
, iflags
);
2604 sdp
= it
? sg_lookup_dev(it
->index
) : NULL
;
2605 if (sdp
&& !list_empty(&sdp
->sfds
)) {
2606 struct scsi_device
*scsidp
= sdp
->device
;
2608 seq_printf(s
, " >>> device=%s ", sdp
->disk
->disk_name
);
2610 seq_printf(s
, "detached pending close ");
2613 (s
, "scsi%d chan=%d id=%d lun=%d em=%d",
2614 scsidp
->host
->host_no
,
2615 scsidp
->channel
, scsidp
->id
,
2617 scsidp
->host
->hostt
->emulated
);
2618 seq_printf(s
, " sg_tablesize=%d excl=%d\n",
2619 sdp
->sg_tablesize
, sdp
->exclude
);
2620 sg_proc_debug_helper(s
, sdp
);
2622 read_unlock_irqrestore(&sg_index_lock
, iflags
);
2626 #endif /* CONFIG_SCSI_PROC_FS */
2628 module_init(init_sg
);
2629 module_exit(exit_sg
);