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
) {
401 retval
= 0; /* following macro beats race condition */
402 __wait_event_interruptible(sfp
->read_wait
,
404 (srp
= sg_get_rq_mark(sfp
, req_pack_id
))), retval
);
410 /* -ERESTARTSYS as signal hit process */
414 if (srp
->header
.interface_id
!= '\0') {
415 retval
= sg_new_read(sfp
, buf
, count
, srp
);
420 if (old_hdr
== NULL
) {
421 old_hdr
= kmalloc(SZ_SG_HEADER
, GFP_KERNEL
);
427 memset(old_hdr
, 0, SZ_SG_HEADER
);
428 old_hdr
->reply_len
= (int) hp
->timeout
;
429 old_hdr
->pack_len
= old_hdr
->reply_len
; /* old, strange behaviour */
430 old_hdr
->pack_id
= hp
->pack_id
;
431 old_hdr
->twelve_byte
=
432 ((srp
->data
.cmd_opcode
>= 0xc0) && (12 == hp
->cmd_len
)) ? 1 : 0;
433 old_hdr
->target_status
= hp
->masked_status
;
434 old_hdr
->host_status
= hp
->host_status
;
435 old_hdr
->driver_status
= hp
->driver_status
;
436 if ((CHECK_CONDITION
& hp
->masked_status
) ||
437 (DRIVER_SENSE
& hp
->driver_status
))
438 memcpy(old_hdr
->sense_buffer
, srp
->sense_b
,
439 sizeof (old_hdr
->sense_buffer
));
440 switch (hp
->host_status
) {
441 /* This setup of 'result' is for backward compatibility and is best
442 ignored by the user who should use target, host + driver status */
444 case DID_PASSTHROUGH
:
451 old_hdr
->result
= EBUSY
;
458 old_hdr
->result
= EIO
;
461 old_hdr
->result
= (srp
->sense_b
[0] == 0 &&
462 hp
->masked_status
== GOOD
) ? 0 : EIO
;
465 old_hdr
->result
= EIO
;
469 /* Now copy the result back to the user buffer. */
470 if (count
>= SZ_SG_HEADER
) {
471 if (__copy_to_user(buf
, old_hdr
, SZ_SG_HEADER
)) {
476 if (count
> old_hdr
->reply_len
)
477 count
= old_hdr
->reply_len
;
478 if (count
> SZ_SG_HEADER
) {
479 if (sg_read_oxfer(srp
, buf
, count
- SZ_SG_HEADER
)) {
485 count
= (old_hdr
->result
== 0) ? 0 : -EIO
;
486 sg_finish_rem_req(srp
);
494 sg_new_read(Sg_fd
* sfp
, char __user
*buf
, size_t count
, Sg_request
* srp
)
496 sg_io_hdr_t
*hp
= &srp
->header
;
500 if (count
< SZ_SG_IO_HDR
) {
505 if ((hp
->mx_sb_len
> 0) && hp
->sbp
) {
506 if ((CHECK_CONDITION
& hp
->masked_status
) ||
507 (DRIVER_SENSE
& hp
->driver_status
)) {
508 int sb_len
= SCSI_SENSE_BUFFERSIZE
;
509 sb_len
= (hp
->mx_sb_len
> sb_len
) ? sb_len
: hp
->mx_sb_len
;
510 len
= 8 + (int) srp
->sense_b
[7]; /* Additional sense length field */
511 len
= (len
> sb_len
) ? sb_len
: len
;
512 if (copy_to_user(hp
->sbp
, srp
->sense_b
, len
)) {
519 if (hp
->masked_status
|| hp
->host_status
|| hp
->driver_status
)
520 hp
->info
|= SG_INFO_CHECK
;
521 if (copy_to_user(buf
, hp
, SZ_SG_IO_HDR
)) {
526 err
= sg_finish_rem_req(srp
);
527 return (0 == err
) ? count
: err
;
531 sg_write(struct file
*filp
, const char __user
*buf
, size_t count
, loff_t
* ppos
)
533 int mxsize
, cmd_size
, k
;
534 int input_size
, blocking
;
535 unsigned char opcode
;
539 struct sg_header old_hdr
;
541 unsigned char cmnd
[MAX_COMMAND_SIZE
];
543 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
545 SCSI_LOG_TIMEOUT(3, printk("sg_write: %s, count=%d\n",
546 sdp
->disk
->disk_name
, (int) count
));
549 if (!((filp
->f_flags
& O_NONBLOCK
) ||
550 scsi_block_when_processing_errors(sdp
->device
)))
553 if (!access_ok(VERIFY_READ
, buf
, count
))
554 return -EFAULT
; /* protects following copy_from_user()s + get_user()s */
555 if (count
< SZ_SG_HEADER
)
557 if (__copy_from_user(&old_hdr
, buf
, SZ_SG_HEADER
))
559 blocking
= !(filp
->f_flags
& O_NONBLOCK
);
560 if (old_hdr
.reply_len
< 0)
561 return sg_new_write(sfp
, filp
, buf
, count
,
562 blocking
, 0, 0, NULL
);
563 if (count
< (SZ_SG_HEADER
+ 6))
564 return -EIO
; /* The minimum scsi command length is 6 bytes. */
566 if (!(srp
= sg_add_request(sfp
))) {
567 SCSI_LOG_TIMEOUT(1, printk("sg_write: queue full\n"));
571 __get_user(opcode
, buf
);
572 if (sfp
->next_cmd_len
> 0) {
573 if (sfp
->next_cmd_len
> MAX_COMMAND_SIZE
) {
574 SCSI_LOG_TIMEOUT(1, printk("sg_write: command length too long\n"));
575 sfp
->next_cmd_len
= 0;
576 sg_remove_request(sfp
, srp
);
579 cmd_size
= sfp
->next_cmd_len
;
580 sfp
->next_cmd_len
= 0; /* reset so only this write() effected */
582 cmd_size
= COMMAND_SIZE(opcode
); /* based on SCSI command group */
583 if ((opcode
>= 0xc0) && old_hdr
.twelve_byte
)
586 SCSI_LOG_TIMEOUT(4, printk(
587 "sg_write: scsi opcode=0x%02x, cmd_size=%d\n", (int) opcode
, cmd_size
));
588 /* Determine buffer size. */
589 input_size
= count
- cmd_size
;
590 mxsize
= (input_size
> old_hdr
.reply_len
) ? input_size
: old_hdr
.reply_len
;
591 mxsize
-= SZ_SG_HEADER
;
592 input_size
-= SZ_SG_HEADER
;
593 if (input_size
< 0) {
594 sg_remove_request(sfp
, srp
);
595 return -EIO
; /* User did not pass enough bytes for this command. */
598 hp
->interface_id
= '\0'; /* indicator of old interface tunnelled */
599 hp
->cmd_len
= (unsigned char) cmd_size
;
603 hp
->dxfer_direction
= (old_hdr
.reply_len
> SZ_SG_HEADER
) ?
604 SG_DXFER_TO_FROM_DEV
: SG_DXFER_TO_DEV
;
606 hp
->dxfer_direction
= (mxsize
> 0) ? SG_DXFER_FROM_DEV
: SG_DXFER_NONE
;
607 hp
->dxfer_len
= mxsize
;
608 if (hp
->dxfer_direction
== SG_DXFER_TO_DEV
)
609 hp
->dxferp
= (char __user
*)buf
+ cmd_size
;
613 hp
->timeout
= old_hdr
.reply_len
; /* structure abuse ... */
614 hp
->flags
= input_size
; /* structure abuse ... */
615 hp
->pack_id
= old_hdr
.pack_id
;
617 if (__copy_from_user(cmnd
, buf
, cmd_size
))
620 * SG_DXFER_TO_FROM_DEV is functionally equivalent to SG_DXFER_FROM_DEV,
621 * but is is possible that the app intended SG_DXFER_TO_DEV, because there
622 * is a non-zero input_size, so emit a warning.
624 if (hp
->dxfer_direction
== SG_DXFER_TO_FROM_DEV
) {
625 static char cmd
[TASK_COMM_LEN
];
626 if (strcmp(current
->comm
, cmd
)) {
627 printk_ratelimited(KERN_WARNING
628 "sg_write: data in/out %d/%d bytes "
629 "for SCSI command 0x%x-- guessing "
630 "data in;\n program %s not setting "
631 "count and/or reply_len properly\n",
632 old_hdr
.reply_len
- (int)SZ_SG_HEADER
,
633 input_size
, (unsigned int) cmnd
[0],
635 strcpy(cmd
, current
->comm
);
638 k
= sg_common_write(sfp
, srp
, cmnd
, sfp
->timeout
, blocking
);
639 return (k
< 0) ? k
: count
;
643 sg_new_write(Sg_fd
*sfp
, struct file
*file
, const char __user
*buf
,
644 size_t count
, int blocking
, int read_only
, int sg_io_owned
,
650 unsigned char cmnd
[MAX_COMMAND_SIZE
];
652 unsigned long ul_timeout
;
654 if (count
< SZ_SG_IO_HDR
)
656 if (!access_ok(VERIFY_READ
, buf
, count
))
657 return -EFAULT
; /* protects following copy_from_user()s + get_user()s */
659 sfp
->cmd_q
= 1; /* when sg_io_hdr seen, set command queuing on */
660 if (!(srp
= sg_add_request(sfp
))) {
661 SCSI_LOG_TIMEOUT(1, printk("sg_new_write: queue full\n"));
664 srp
->sg_io_owned
= sg_io_owned
;
666 if (__copy_from_user(hp
, buf
, SZ_SG_IO_HDR
)) {
667 sg_remove_request(sfp
, srp
);
670 if (hp
->interface_id
!= 'S') {
671 sg_remove_request(sfp
, srp
);
674 if (hp
->flags
& SG_FLAG_MMAP_IO
) {
675 if (hp
->dxfer_len
> sfp
->reserve
.bufflen
) {
676 sg_remove_request(sfp
, srp
);
677 return -ENOMEM
; /* MMAP_IO size must fit in reserve buffer */
679 if (hp
->flags
& SG_FLAG_DIRECT_IO
) {
680 sg_remove_request(sfp
, srp
);
681 return -EINVAL
; /* either MMAP_IO or DIRECT_IO (not both) */
683 if (sg_res_in_use(sfp
)) {
684 sg_remove_request(sfp
, srp
);
685 return -EBUSY
; /* reserve buffer already being used */
688 ul_timeout
= msecs_to_jiffies(srp
->header
.timeout
);
689 timeout
= (ul_timeout
< INT_MAX
) ? ul_timeout
: INT_MAX
;
690 if ((!hp
->cmdp
) || (hp
->cmd_len
< 6) || (hp
->cmd_len
> sizeof (cmnd
))) {
691 sg_remove_request(sfp
, srp
);
694 if (!access_ok(VERIFY_READ
, hp
->cmdp
, hp
->cmd_len
)) {
695 sg_remove_request(sfp
, srp
);
696 return -EFAULT
; /* protects following copy_from_user()s + get_user()s */
698 if (__copy_from_user(cmnd
, hp
->cmdp
, hp
->cmd_len
)) {
699 sg_remove_request(sfp
, srp
);
702 if (read_only
&& sg_allow_access(file
, cmnd
)) {
703 sg_remove_request(sfp
, srp
);
706 k
= sg_common_write(sfp
, srp
, cmnd
, timeout
, blocking
);
715 sg_common_write(Sg_fd
* sfp
, Sg_request
* srp
,
716 unsigned char *cmnd
, int timeout
, int blocking
)
719 Sg_device
*sdp
= sfp
->parentdp
;
720 sg_io_hdr_t
*hp
= &srp
->header
;
722 srp
->data
.cmd_opcode
= cmnd
[0]; /* hold opcode of command */
724 hp
->masked_status
= 0;
728 hp
->driver_status
= 0;
730 SCSI_LOG_TIMEOUT(4, printk("sg_common_write: scsi opcode=0x%02x, cmd_size=%d\n",
731 (int) cmnd
[0], (int) hp
->cmd_len
));
733 k
= sg_start_req(srp
, cmnd
);
735 SCSI_LOG_TIMEOUT(1, printk("sg_common_write: start_req err=%d\n", k
));
736 sg_finish_rem_req(srp
);
737 return k
; /* probably out of space --> ENOMEM */
741 blk_end_request_all(srp
->rq
, -EIO
);
742 sg_finish_rem_req(srp
);
746 switch (hp
->dxfer_direction
) {
747 case SG_DXFER_TO_FROM_DEV
:
748 case SG_DXFER_FROM_DEV
:
749 data_dir
= DMA_FROM_DEVICE
;
751 case SG_DXFER_TO_DEV
:
752 data_dir
= DMA_TO_DEVICE
;
754 case SG_DXFER_UNKNOWN
:
755 data_dir
= DMA_BIDIRECTIONAL
;
761 hp
->duration
= jiffies_to_msecs(jiffies
);
763 srp
->rq
->timeout
= timeout
;
764 kref_get(&sfp
->f_ref
); /* sg_rq_end_io() does kref_put(). */
765 blk_execute_rq_nowait(sdp
->device
->request_queue
, sdp
->disk
,
766 srp
->rq
, 1, sg_rq_end_io
);
771 sg_ioctl(struct file
*filp
, unsigned int cmd_in
, unsigned long arg
)
773 void __user
*p
= (void __user
*)arg
;
775 int result
, val
, read_only
;
779 unsigned long iflags
;
781 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
784 SCSI_LOG_TIMEOUT(3, printk("sg_ioctl: %s, cmd=0x%x\n",
785 sdp
->disk
->disk_name
, (int) cmd_in
));
786 read_only
= (O_RDWR
!= (filp
->f_flags
& O_ACCMODE
));
792 if (!scsi_block_when_processing_errors(sdp
->device
))
794 if (!access_ok(VERIFY_WRITE
, p
, SZ_SG_IO_HDR
))
796 result
= sg_new_write(sfp
, filp
, p
, SZ_SG_IO_HDR
,
797 1, read_only
, 1, &srp
);
800 result
= 0; /* following macro to beat race condition */
801 __wait_event_interruptible(sfp
->read_wait
,
802 (srp
->done
|| sdp
->detached
), result
);
805 write_lock_irq(&sfp
->rq_list_lock
);
808 write_unlock_irq(&sfp
->rq_list_lock
);
809 result
= sg_new_read(sfp
, p
, SZ_SG_IO_HDR
, srp
);
810 return (result
< 0) ? result
: 0;
813 write_unlock_irq(&sfp
->rq_list_lock
);
814 return result
; /* -ERESTARTSYS because signal hit process */
816 result
= get_user(val
, ip
);
821 if (val
>= MULDIV (INT_MAX
, USER_HZ
, HZ
))
822 val
= MULDIV (INT_MAX
, USER_HZ
, HZ
);
823 sfp
->timeout_user
= val
;
824 sfp
->timeout
= MULDIV (val
, HZ
, USER_HZ
);
827 case SG_GET_TIMEOUT
: /* N.B. User receives timeout as return value */
828 /* strange ..., for backward compatibility */
829 return sfp
->timeout_user
;
830 case SG_SET_FORCE_LOW_DMA
:
831 result
= get_user(val
, ip
);
836 if ((0 == sfp
->low_dma
) && (0 == sg_res_in_use(sfp
))) {
837 val
= (int) sfp
->reserve
.bufflen
;
838 sg_remove_scat(&sfp
->reserve
);
839 sg_build_reserve(sfp
, val
);
844 sfp
->low_dma
= sdp
->device
->host
->unchecked_isa_dma
;
848 return put_user((int) sfp
->low_dma
, ip
);
850 if (!access_ok(VERIFY_WRITE
, p
, sizeof (sg_scsi_id_t
)))
853 sg_scsi_id_t __user
*sg_idp
= p
;
857 __put_user((int) sdp
->device
->host
->host_no
,
859 __put_user((int) sdp
->device
->channel
,
861 __put_user((int) sdp
->device
->id
, &sg_idp
->scsi_id
);
862 __put_user((int) sdp
->device
->lun
, &sg_idp
->lun
);
863 __put_user((int) sdp
->device
->type
, &sg_idp
->scsi_type
);
864 __put_user((short) sdp
->device
->host
->cmd_per_lun
,
865 &sg_idp
->h_cmd_per_lun
);
866 __put_user((short) sdp
->device
->queue_depth
,
867 &sg_idp
->d_queue_depth
);
868 __put_user(0, &sg_idp
->unused
[0]);
869 __put_user(0, &sg_idp
->unused
[1]);
872 case SG_SET_FORCE_PACK_ID
:
873 result
= get_user(val
, ip
);
876 sfp
->force_packid
= val
? 1 : 0;
879 if (!access_ok(VERIFY_WRITE
, ip
, sizeof (int)))
881 read_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
882 for (srp
= sfp
->headrp
; srp
; srp
= srp
->nextrp
) {
883 if ((1 == srp
->done
) && (!srp
->sg_io_owned
)) {
884 read_unlock_irqrestore(&sfp
->rq_list_lock
,
886 __put_user(srp
->header
.pack_id
, ip
);
890 read_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
893 case SG_GET_NUM_WAITING
:
894 read_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
895 for (val
= 0, srp
= sfp
->headrp
; srp
; srp
= srp
->nextrp
) {
896 if ((1 == srp
->done
) && (!srp
->sg_io_owned
))
899 read_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
900 return put_user(val
, ip
);
901 case SG_GET_SG_TABLESIZE
:
902 return put_user(sdp
->sg_tablesize
, ip
);
903 case SG_SET_RESERVED_SIZE
:
904 result
= get_user(val
, ip
);
909 val
= min_t(int, val
,
910 queue_max_sectors(sdp
->device
->request_queue
) * 512);
911 if (val
!= sfp
->reserve
.bufflen
) {
912 if (sg_res_in_use(sfp
) || sfp
->mmap_called
)
914 sg_remove_scat(&sfp
->reserve
);
915 sg_build_reserve(sfp
, val
);
918 case SG_GET_RESERVED_SIZE
:
919 val
= min_t(int, sfp
->reserve
.bufflen
,
920 queue_max_sectors(sdp
->device
->request_queue
) * 512);
921 return put_user(val
, ip
);
922 case SG_SET_COMMAND_Q
:
923 result
= get_user(val
, ip
);
926 sfp
->cmd_q
= val
? 1 : 0;
928 case SG_GET_COMMAND_Q
:
929 return put_user((int) sfp
->cmd_q
, ip
);
930 case SG_SET_KEEP_ORPHAN
:
931 result
= get_user(val
, ip
);
934 sfp
->keep_orphan
= val
;
936 case SG_GET_KEEP_ORPHAN
:
937 return put_user((int) sfp
->keep_orphan
, ip
);
938 case SG_NEXT_CMD_LEN
:
939 result
= get_user(val
, ip
);
942 sfp
->next_cmd_len
= (val
> 0) ? val
: 0;
944 case SG_GET_VERSION_NUM
:
945 return put_user(sg_version_num
, ip
);
946 case SG_GET_ACCESS_COUNT
:
947 /* faked - we don't have a real access count anymore */
948 val
= (sdp
->device
? 1 : 0);
949 return put_user(val
, ip
);
950 case SG_GET_REQUEST_TABLE
:
951 if (!access_ok(VERIFY_WRITE
, p
, SZ_SG_REQ_INFO
* SG_MAX_QUEUE
))
954 sg_req_info_t
*rinfo
;
957 rinfo
= kmalloc(SZ_SG_REQ_INFO
* SG_MAX_QUEUE
,
961 read_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
962 for (srp
= sfp
->headrp
, val
= 0; val
< SG_MAX_QUEUE
;
963 ++val
, srp
= srp
? srp
->nextrp
: srp
) {
964 memset(&rinfo
[val
], 0, SZ_SG_REQ_INFO
);
966 rinfo
[val
].req_state
= srp
->done
+ 1;
968 srp
->header
.masked_status
&
969 srp
->header
.host_status
&
970 srp
->header
.driver_status
;
972 rinfo
[val
].duration
=
973 srp
->header
.duration
;
975 ms
= jiffies_to_msecs(jiffies
);
976 rinfo
[val
].duration
=
977 (ms
> srp
->header
.duration
) ?
978 (ms
- srp
->header
.duration
) : 0;
980 rinfo
[val
].orphan
= srp
->orphan
;
981 rinfo
[val
].sg_io_owned
=
989 read_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
990 result
= __copy_to_user(p
, rinfo
,
991 SZ_SG_REQ_INFO
* SG_MAX_QUEUE
);
992 result
= result
? -EFAULT
: 0;
996 case SG_EMULATED_HOST
:
999 return put_user(sdp
->device
->host
->hostt
->emulated
, ip
);
1003 if (filp
->f_flags
& O_NONBLOCK
) {
1004 if (scsi_host_in_recovery(sdp
->device
->host
))
1006 } else if (!scsi_block_when_processing_errors(sdp
->device
))
1008 result
= get_user(val
, ip
);
1011 if (SG_SCSI_RESET_NOTHING
== val
)
1014 case SG_SCSI_RESET_DEVICE
:
1015 val
= SCSI_TRY_RESET_DEVICE
;
1017 case SG_SCSI_RESET_TARGET
:
1018 val
= SCSI_TRY_RESET_TARGET
;
1020 case SG_SCSI_RESET_BUS
:
1021 val
= SCSI_TRY_RESET_BUS
;
1023 case SG_SCSI_RESET_HOST
:
1024 val
= SCSI_TRY_RESET_HOST
;
1029 if (!capable(CAP_SYS_ADMIN
) || !capable(CAP_SYS_RAWIO
))
1031 return (scsi_reset_provider(sdp
->device
, val
) ==
1032 SUCCESS
) ? 0 : -EIO
;
1033 case SCSI_IOCTL_SEND_COMMAND
:
1037 unsigned char opcode
= WRITE_6
;
1038 Scsi_Ioctl_Command __user
*siocp
= p
;
1040 if (copy_from_user(&opcode
, siocp
->data
, 1))
1042 if (sg_allow_access(filp
, &opcode
))
1045 return sg_scsi_ioctl(sdp
->device
->request_queue
, NULL
, filp
->f_mode
, p
);
1047 result
= get_user(val
, ip
);
1050 sdp
->sgdebug
= (char) val
;
1052 case SCSI_IOCTL_GET_IDLUN
:
1053 case SCSI_IOCTL_GET_BUS_NUMBER
:
1054 case SCSI_IOCTL_PROBE_HOST
:
1055 case SG_GET_TRANSFORM
:
1058 return scsi_ioctl(sdp
->device
, cmd_in
, p
);
1060 return put_user(queue_max_sectors(sdp
->device
->request_queue
) * 512,
1063 return blk_trace_setup(sdp
->device
->request_queue
,
1064 sdp
->disk
->disk_name
,
1065 MKDEV(SCSI_GENERIC_MAJOR
, sdp
->index
),
1069 return blk_trace_startstop(sdp
->device
->request_queue
, 1);
1071 return blk_trace_startstop(sdp
->device
->request_queue
, 0);
1072 case BLKTRACETEARDOWN
:
1073 return blk_trace_remove(sdp
->device
->request_queue
);
1076 return -EPERM
; /* don't know so take safe approach */
1077 return scsi_ioctl(sdp
->device
, cmd_in
, p
);
1082 sg_unlocked_ioctl(struct file
*filp
, unsigned int cmd_in
, unsigned long arg
)
1086 mutex_lock(&sg_mutex
);
1087 ret
= sg_ioctl(filp
, cmd_in
, arg
);
1088 mutex_unlock(&sg_mutex
);
1093 #ifdef CONFIG_COMPAT
1094 static long sg_compat_ioctl(struct file
*filp
, unsigned int cmd_in
, unsigned long arg
)
1098 struct scsi_device
*sdev
;
1100 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
1104 if (sdev
->host
->hostt
->compat_ioctl
) {
1107 ret
= sdev
->host
->hostt
->compat_ioctl(sdev
, cmd_in
, (void __user
*)arg
);
1112 return -ENOIOCTLCMD
;
1117 sg_poll(struct file
*filp
, poll_table
* wait
)
1119 unsigned int res
= 0;
1124 unsigned long iflags
;
1126 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
))
1129 poll_wait(filp
, &sfp
->read_wait
, wait
);
1130 read_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
1131 for (srp
= sfp
->headrp
; srp
; srp
= srp
->nextrp
) {
1132 /* if any read waiting, flag it */
1133 if ((0 == res
) && (1 == srp
->done
) && (!srp
->sg_io_owned
))
1134 res
= POLLIN
| POLLRDNORM
;
1137 read_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
1141 else if (!sfp
->cmd_q
) {
1143 res
|= POLLOUT
| POLLWRNORM
;
1144 } else if (count
< SG_MAX_QUEUE
)
1145 res
|= POLLOUT
| POLLWRNORM
;
1146 SCSI_LOG_TIMEOUT(3, printk("sg_poll: %s, res=0x%x\n",
1147 sdp
->disk
->disk_name
, (int) res
));
1152 sg_fasync(int fd
, struct file
*filp
, int mode
)
1157 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
1159 SCSI_LOG_TIMEOUT(3, printk("sg_fasync: %s, mode=%d\n",
1160 sdp
->disk
->disk_name
, mode
));
1162 return fasync_helper(fd
, filp
, mode
, &sfp
->async_qp
);
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 const 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
->resid_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 const struct file_operations sg_fops
= {
1333 .owner
= THIS_MODULE
,
1337 .unlocked_ioctl
= sg_unlocked_ioctl
,
1338 #ifdef CONFIG_COMPAT
1339 .compat_ioctl
= sg_compat_ioctl
,
1343 .release
= sg_release
,
1344 .fasync
= sg_fasync
,
1345 .llseek
= no_llseek
,
1348 static struct class *sg_sysfs_class
;
1350 static int sg_sysfs_valid
= 0;
1352 static Sg_device
*sg_alloc(struct gendisk
*disk
, struct scsi_device
*scsidp
)
1354 struct request_queue
*q
= scsidp
->request_queue
;
1356 unsigned long iflags
;
1360 sdp
= kzalloc(sizeof(Sg_device
), GFP_KERNEL
);
1362 printk(KERN_WARNING
"kmalloc Sg_device failure\n");
1363 return ERR_PTR(-ENOMEM
);
1366 if (!idr_pre_get(&sg_index_idr
, GFP_KERNEL
)) {
1367 printk(KERN_WARNING
"idr expansion Sg_device failure\n");
1372 write_lock_irqsave(&sg_index_lock
, iflags
);
1374 error
= idr_get_new(&sg_index_idr
, sdp
, &k
);
1376 write_unlock_irqrestore(&sg_index_lock
, iflags
);
1377 printk(KERN_WARNING
"idr allocation Sg_device failure: %d\n",
1382 if (unlikely(k
>= SG_MAX_DEVS
))
1385 SCSI_LOG_TIMEOUT(3, printk("sg_alloc: dev=%d \n", k
));
1386 sprintf(disk
->disk_name
, "sg%d", k
);
1387 disk
->first_minor
= k
;
1389 sdp
->device
= scsidp
;
1390 INIT_LIST_HEAD(&sdp
->sfds
);
1391 init_waitqueue_head(&sdp
->o_excl_wait
);
1392 sdp
->sg_tablesize
= queue_max_segments(q
);
1394 kref_init(&sdp
->d_ref
);
1396 write_unlock_irqrestore(&sg_index_lock
, iflags
);
1402 return ERR_PTR(error
);
1407 idr_remove(&sg_index_idr
, k
);
1408 write_unlock_irqrestore(&sg_index_lock
, iflags
);
1409 sdev_printk(KERN_WARNING
, scsidp
,
1410 "Unable to attach sg device type=%d, minor "
1411 "number exceeds %d\n", scsidp
->type
, SG_MAX_DEVS
- 1);
1417 sg_add(struct device
*cl_dev
, struct class_interface
*cl_intf
)
1419 struct scsi_device
*scsidp
= to_scsi_device(cl_dev
->parent
);
1420 struct gendisk
*disk
;
1421 Sg_device
*sdp
= NULL
;
1422 struct cdev
* cdev
= NULL
;
1424 unsigned long iflags
;
1426 disk
= alloc_disk(1);
1428 printk(KERN_WARNING
"alloc_disk failed\n");
1431 disk
->major
= SCSI_GENERIC_MAJOR
;
1434 cdev
= cdev_alloc();
1436 printk(KERN_WARNING
"cdev_alloc failed\n");
1439 cdev
->owner
= THIS_MODULE
;
1440 cdev
->ops
= &sg_fops
;
1442 sdp
= sg_alloc(disk
, scsidp
);
1444 printk(KERN_WARNING
"sg_alloc failed\n");
1445 error
= PTR_ERR(sdp
);
1449 error
= cdev_add(cdev
, MKDEV(SCSI_GENERIC_MAJOR
, sdp
->index
), 1);
1454 if (sg_sysfs_valid
) {
1455 struct device
*sg_class_member
;
1457 sg_class_member
= device_create(sg_sysfs_class
, cl_dev
->parent
,
1458 MKDEV(SCSI_GENERIC_MAJOR
,
1460 sdp
, "%s", disk
->disk_name
);
1461 if (IS_ERR(sg_class_member
)) {
1462 printk(KERN_ERR
"sg_add: "
1463 "device_create failed\n");
1464 error
= PTR_ERR(sg_class_member
);
1467 error
= sysfs_create_link(&scsidp
->sdev_gendev
.kobj
,
1468 &sg_class_member
->kobj
, "generic");
1470 printk(KERN_ERR
"sg_add: unable to make symlink "
1471 "'generic' back to sg%d\n", sdp
->index
);
1473 printk(KERN_WARNING
"sg_add: sg_sys Invalid\n");
1475 sdev_printk(KERN_NOTICE
, scsidp
,
1476 "Attached scsi generic sg%d type %d\n", sdp
->index
,
1479 dev_set_drvdata(cl_dev
, sdp
);
1484 write_lock_irqsave(&sg_index_lock
, iflags
);
1485 idr_remove(&sg_index_idr
, sdp
->index
);
1486 write_unlock_irqrestore(&sg_index_lock
, iflags
);
1496 static void sg_device_destroy(struct kref
*kref
)
1498 struct sg_device
*sdp
= container_of(kref
, struct sg_device
, d_ref
);
1499 unsigned long flags
;
1501 /* CAUTION! Note that the device can still be found via idr_find()
1502 * even though the refcount is 0. Therefore, do idr_remove() BEFORE
1503 * any other cleanup.
1506 write_lock_irqsave(&sg_index_lock
, flags
);
1507 idr_remove(&sg_index_idr
, sdp
->index
);
1508 write_unlock_irqrestore(&sg_index_lock
, flags
);
1511 printk("sg_device_destroy: %s\n",
1512 sdp
->disk
->disk_name
));
1514 put_disk(sdp
->disk
);
1518 static void sg_remove(struct device
*cl_dev
, struct class_interface
*cl_intf
)
1520 struct scsi_device
*scsidp
= to_scsi_device(cl_dev
->parent
);
1521 Sg_device
*sdp
= dev_get_drvdata(cl_dev
);
1522 unsigned long iflags
;
1525 if (!sdp
|| sdp
->detached
)
1528 SCSI_LOG_TIMEOUT(3, printk("sg_remove: %s\n", sdp
->disk
->disk_name
));
1530 /* Need a write lock to set sdp->detached. */
1531 write_lock_irqsave(&sg_index_lock
, iflags
);
1533 list_for_each_entry(sfp
, &sdp
->sfds
, sfd_siblings
) {
1534 wake_up_interruptible(&sfp
->read_wait
);
1535 kill_fasync(&sfp
->async_qp
, SIGPOLL
, POLL_HUP
);
1537 write_unlock_irqrestore(&sg_index_lock
, iflags
);
1539 sysfs_remove_link(&scsidp
->sdev_gendev
.kobj
, "generic");
1540 device_destroy(sg_sysfs_class
, MKDEV(SCSI_GENERIC_MAJOR
, sdp
->index
));
1541 cdev_del(sdp
->cdev
);
1547 module_param_named(scatter_elem_sz
, scatter_elem_sz
, int, S_IRUGO
| S_IWUSR
);
1548 module_param_named(def_reserved_size
, def_reserved_size
, int,
1550 module_param_named(allow_dio
, sg_allow_dio
, int, S_IRUGO
| S_IWUSR
);
1552 MODULE_AUTHOR("Douglas Gilbert");
1553 MODULE_DESCRIPTION("SCSI generic (sg) driver");
1554 MODULE_LICENSE("GPL");
1555 MODULE_VERSION(SG_VERSION_STR
);
1556 MODULE_ALIAS_CHARDEV_MAJOR(SCSI_GENERIC_MAJOR
);
1558 MODULE_PARM_DESC(scatter_elem_sz
, "scatter gather element "
1559 "size (default: max(SG_SCATTER_SZ, PAGE_SIZE))");
1560 MODULE_PARM_DESC(def_reserved_size
, "size of buffer reserved for each fd");
1561 MODULE_PARM_DESC(allow_dio
, "allow direct I/O (default: 0 (disallow))");
1568 if (scatter_elem_sz
< PAGE_SIZE
) {
1569 scatter_elem_sz
= PAGE_SIZE
;
1570 scatter_elem_sz_prev
= scatter_elem_sz
;
1572 if (def_reserved_size
>= 0)
1573 sg_big_buff
= def_reserved_size
;
1575 def_reserved_size
= sg_big_buff
;
1577 rc
= register_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR
, 0),
1581 sg_sysfs_class
= class_create(THIS_MODULE
, "scsi_generic");
1582 if ( IS_ERR(sg_sysfs_class
) ) {
1583 rc
= PTR_ERR(sg_sysfs_class
);
1587 rc
= scsi_register_interface(&sg_interface
);
1589 #ifdef CONFIG_SCSI_PROC_FS
1591 #endif /* CONFIG_SCSI_PROC_FS */
1594 class_destroy(sg_sysfs_class
);
1596 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR
, 0), SG_MAX_DEVS
);
1603 #ifdef CONFIG_SCSI_PROC_FS
1605 #endif /* CONFIG_SCSI_PROC_FS */
1606 scsi_unregister_interface(&sg_interface
);
1607 class_destroy(sg_sysfs_class
);
1609 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR
, 0),
1611 idr_destroy(&sg_index_idr
);
1614 static int sg_start_req(Sg_request
*srp
, unsigned char *cmd
)
1618 Sg_fd
*sfp
= srp
->parentfp
;
1619 sg_io_hdr_t
*hp
= &srp
->header
;
1620 int dxfer_len
= (int) hp
->dxfer_len
;
1621 int dxfer_dir
= hp
->dxfer_direction
;
1622 unsigned int iov_count
= hp
->iovec_count
;
1623 Sg_scatter_hold
*req_schp
= &srp
->data
;
1624 Sg_scatter_hold
*rsv_schp
= &sfp
->reserve
;
1625 struct request_queue
*q
= sfp
->parentdp
->device
->request_queue
;
1626 struct rq_map_data
*md
, map_data
;
1627 int rw
= hp
->dxfer_direction
== SG_DXFER_TO_DEV
? WRITE
: READ
;
1629 SCSI_LOG_TIMEOUT(4, printk(KERN_INFO
"sg_start_req: dxfer_len=%d\n",
1632 rq
= blk_get_request(q
, rw
, GFP_ATOMIC
);
1636 memcpy(rq
->cmd
, cmd
, hp
->cmd_len
);
1638 rq
->cmd_len
= hp
->cmd_len
;
1639 rq
->cmd_type
= REQ_TYPE_BLOCK_PC
;
1642 rq
->end_io_data
= srp
;
1643 rq
->sense
= srp
->sense_b
;
1644 rq
->retries
= SG_DEFAULT_RETRIES
;
1646 if ((dxfer_len
<= 0) || (dxfer_dir
== SG_DXFER_NONE
))
1649 if (sg_allow_dio
&& hp
->flags
& SG_FLAG_DIRECT_IO
&&
1650 dxfer_dir
!= SG_DXFER_UNKNOWN
&& !iov_count
&&
1651 !sfp
->parentdp
->device
->host
->unchecked_isa_dma
&&
1652 blk_rq_aligned(q
, (unsigned long)hp
->dxferp
, dxfer_len
))
1658 if (!sg_res_in_use(sfp
) && dxfer_len
<= rsv_schp
->bufflen
)
1659 sg_link_reserve(sfp
, srp
, dxfer_len
);
1661 res
= sg_build_indirect(req_schp
, sfp
, dxfer_len
);
1666 md
->pages
= req_schp
->pages
;
1667 md
->page_order
= req_schp
->page_order
;
1668 md
->nr_entries
= req_schp
->k_use_sg
;
1670 md
->null_mapped
= hp
->dxferp
? 0 : 1;
1671 if (dxfer_dir
== SG_DXFER_TO_FROM_DEV
)
1678 int len
, size
= sizeof(struct sg_iovec
) * iov_count
;
1681 iov
= memdup_user(hp
->dxferp
, size
);
1683 return PTR_ERR(iov
);
1685 len
= iov_length(iov
, iov_count
);
1686 if (hp
->dxfer_len
< len
) {
1687 iov_count
= iov_shorten(iov
, iov_count
, hp
->dxfer_len
);
1688 len
= hp
->dxfer_len
;
1691 res
= blk_rq_map_user_iov(q
, rq
, md
, (struct sg_iovec
*)iov
,
1696 res
= blk_rq_map_user(q
, rq
, md
, hp
->dxferp
,
1697 hp
->dxfer_len
, GFP_ATOMIC
);
1703 req_schp
->dio_in_use
= 1;
1704 hp
->info
|= SG_INFO_DIRECT_IO
;
1710 static int sg_finish_rem_req(Sg_request
* srp
)
1714 Sg_fd
*sfp
= srp
->parentfp
;
1715 Sg_scatter_hold
*req_schp
= &srp
->data
;
1717 SCSI_LOG_TIMEOUT(4, printk("sg_finish_rem_req: res_used=%d\n", (int) srp
->res_used
));
1720 ret
= blk_rq_unmap_user(srp
->bio
);
1722 blk_put_request(srp
->rq
);
1726 sg_unlink_reserve(sfp
, srp
);
1728 sg_remove_scat(req_schp
);
1730 sg_remove_request(sfp
, srp
);
1736 sg_build_sgat(Sg_scatter_hold
* schp
, const Sg_fd
* sfp
, int tablesize
)
1738 int sg_bufflen
= tablesize
* sizeof(struct page
*);
1739 gfp_t gfp_flags
= GFP_ATOMIC
| __GFP_NOWARN
;
1741 schp
->pages
= kzalloc(sg_bufflen
, gfp_flags
);
1744 schp
->sglist_len
= sg_bufflen
;
1745 return tablesize
; /* number of scat_gath elements allocated */
1749 sg_build_indirect(Sg_scatter_hold
* schp
, Sg_fd
* sfp
, int buff_size
)
1751 int ret_sz
= 0, i
, k
, rem_sz
, num
, mx_sc_elems
;
1752 int sg_tablesize
= sfp
->parentdp
->sg_tablesize
;
1753 int blk_size
= buff_size
, order
;
1754 gfp_t gfp_mask
= GFP_ATOMIC
| __GFP_COMP
| __GFP_NOWARN
;
1759 ++blk_size
; /* don't know why */
1760 /* round request up to next highest SG_SECTOR_SZ byte boundary */
1761 blk_size
= ALIGN(blk_size
, SG_SECTOR_SZ
);
1762 SCSI_LOG_TIMEOUT(4, printk("sg_build_indirect: buff_size=%d, blk_size=%d\n",
1763 buff_size
, blk_size
));
1765 /* N.B. ret_sz carried into this block ... */
1766 mx_sc_elems
= sg_build_sgat(schp
, sfp
, sg_tablesize
);
1767 if (mx_sc_elems
< 0)
1768 return mx_sc_elems
; /* most likely -ENOMEM */
1770 num
= scatter_elem_sz
;
1771 if (unlikely(num
!= scatter_elem_sz_prev
)) {
1772 if (num
< PAGE_SIZE
) {
1773 scatter_elem_sz
= PAGE_SIZE
;
1774 scatter_elem_sz_prev
= PAGE_SIZE
;
1776 scatter_elem_sz_prev
= num
;
1780 gfp_mask
|= GFP_DMA
;
1782 if (!capable(CAP_SYS_ADMIN
) || !capable(CAP_SYS_RAWIO
))
1783 gfp_mask
|= __GFP_ZERO
;
1785 order
= get_order(num
);
1787 ret_sz
= 1 << (PAGE_SHIFT
+ order
);
1789 for (k
= 0, rem_sz
= blk_size
; rem_sz
> 0 && k
< mx_sc_elems
;
1790 k
++, rem_sz
-= ret_sz
) {
1792 num
= (rem_sz
> scatter_elem_sz_prev
) ?
1793 scatter_elem_sz_prev
: rem_sz
;
1795 schp
->pages
[k
] = alloc_pages(gfp_mask
, order
);
1796 if (!schp
->pages
[k
])
1799 if (num
== scatter_elem_sz_prev
) {
1800 if (unlikely(ret_sz
> scatter_elem_sz_prev
)) {
1801 scatter_elem_sz
= ret_sz
;
1802 scatter_elem_sz_prev
= ret_sz
;
1806 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k=%d, num=%d, "
1807 "ret_sz=%d\n", k
, num
, ret_sz
));
1808 } /* end of for loop */
1810 schp
->page_order
= order
;
1812 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k_use_sg=%d, "
1813 "rem_sz=%d\n", k
, rem_sz
));
1815 schp
->bufflen
= blk_size
;
1816 if (rem_sz
> 0) /* must have failed */
1820 for (i
= 0; i
< k
; i
++)
1821 __free_pages(schp
->pages
[i
], order
);
1830 sg_remove_scat(Sg_scatter_hold
* schp
)
1832 SCSI_LOG_TIMEOUT(4, printk("sg_remove_scat: k_use_sg=%d\n", schp
->k_use_sg
));
1833 if (schp
->pages
&& schp
->sglist_len
> 0) {
1834 if (!schp
->dio_in_use
) {
1837 for (k
= 0; k
< schp
->k_use_sg
&& schp
->pages
[k
]; k
++) {
1838 SCSI_LOG_TIMEOUT(5, printk(
1839 "sg_remove_scat: k=%d, pg=0x%p\n",
1840 k
, schp
->pages
[k
]));
1841 __free_pages(schp
->pages
[k
], schp
->page_order
);
1847 memset(schp
, 0, sizeof (*schp
));
1851 sg_read_oxfer(Sg_request
* srp
, char __user
*outp
, int num_read_xfer
)
1853 Sg_scatter_hold
*schp
= &srp
->data
;
1856 SCSI_LOG_TIMEOUT(4, printk("sg_read_oxfer: num_read_xfer=%d\n",
1858 if ((!outp
) || (num_read_xfer
<= 0))
1861 num
= 1 << (PAGE_SHIFT
+ schp
->page_order
);
1862 for (k
= 0; k
< schp
->k_use_sg
&& schp
->pages
[k
]; k
++) {
1863 if (num
> num_read_xfer
) {
1864 if (__copy_to_user(outp
, page_address(schp
->pages
[k
]),
1869 if (__copy_to_user(outp
, page_address(schp
->pages
[k
]),
1872 num_read_xfer
-= num
;
1873 if (num_read_xfer
<= 0)
1883 sg_build_reserve(Sg_fd
* sfp
, int req_size
)
1885 Sg_scatter_hold
*schp
= &sfp
->reserve
;
1887 SCSI_LOG_TIMEOUT(4, printk("sg_build_reserve: req_size=%d\n", req_size
));
1889 if (req_size
< PAGE_SIZE
)
1890 req_size
= PAGE_SIZE
;
1891 if (0 == sg_build_indirect(schp
, sfp
, req_size
))
1894 sg_remove_scat(schp
);
1895 req_size
>>= 1; /* divide by 2 */
1896 } while (req_size
> (PAGE_SIZE
/ 2));
1900 sg_link_reserve(Sg_fd
* sfp
, Sg_request
* srp
, int size
)
1902 Sg_scatter_hold
*req_schp
= &srp
->data
;
1903 Sg_scatter_hold
*rsv_schp
= &sfp
->reserve
;
1907 SCSI_LOG_TIMEOUT(4, printk("sg_link_reserve: size=%d\n", size
));
1910 num
= 1 << (PAGE_SHIFT
+ rsv_schp
->page_order
);
1911 for (k
= 0; k
< rsv_schp
->k_use_sg
; k
++) {
1913 req_schp
->k_use_sg
= k
+ 1;
1914 req_schp
->sglist_len
= rsv_schp
->sglist_len
;
1915 req_schp
->pages
= rsv_schp
->pages
;
1917 req_schp
->bufflen
= size
;
1918 req_schp
->page_order
= rsv_schp
->page_order
;
1924 if (k
>= rsv_schp
->k_use_sg
)
1925 SCSI_LOG_TIMEOUT(1, printk("sg_link_reserve: BAD size\n"));
1929 sg_unlink_reserve(Sg_fd
* sfp
, Sg_request
* srp
)
1931 Sg_scatter_hold
*req_schp
= &srp
->data
;
1933 SCSI_LOG_TIMEOUT(4, printk("sg_unlink_reserve: req->k_use_sg=%d\n",
1934 (int) req_schp
->k_use_sg
));
1935 req_schp
->k_use_sg
= 0;
1936 req_schp
->bufflen
= 0;
1937 req_schp
->pages
= NULL
;
1938 req_schp
->page_order
= 0;
1939 req_schp
->sglist_len
= 0;
1940 sfp
->save_scat_len
= 0;
1945 sg_get_rq_mark(Sg_fd
* sfp
, int pack_id
)
1948 unsigned long iflags
;
1950 write_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
1951 for (resp
= sfp
->headrp
; resp
; resp
= resp
->nextrp
) {
1952 /* look for requests that are ready + not SG_IO owned */
1953 if ((1 == resp
->done
) && (!resp
->sg_io_owned
) &&
1954 ((-1 == pack_id
) || (resp
->header
.pack_id
== pack_id
))) {
1955 resp
->done
= 2; /* guard against other readers */
1959 write_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
1963 /* always adds to end of list */
1965 sg_add_request(Sg_fd
* sfp
)
1968 unsigned long iflags
;
1970 Sg_request
*rp
= sfp
->req_arr
;
1972 write_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
1975 memset(rp
, 0, sizeof (Sg_request
));
1980 if (0 == sfp
->cmd_q
)
1981 resp
= NULL
; /* command queuing disallowed */
1983 for (k
= 0; k
< SG_MAX_QUEUE
; ++k
, ++rp
) {
1987 if (k
< SG_MAX_QUEUE
) {
1988 memset(rp
, 0, sizeof (Sg_request
));
1990 while (resp
->nextrp
)
1991 resp
= resp
->nextrp
;
1999 resp
->nextrp
= NULL
;
2000 resp
->header
.duration
= jiffies_to_msecs(jiffies
);
2002 write_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
2006 /* Return of 1 for found; 0 for not found */
2008 sg_remove_request(Sg_fd
* sfp
, Sg_request
* srp
)
2010 Sg_request
*prev_rp
;
2012 unsigned long iflags
;
2015 if ((!sfp
) || (!srp
) || (!sfp
->headrp
))
2017 write_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
2018 prev_rp
= sfp
->headrp
;
2019 if (srp
== prev_rp
) {
2020 sfp
->headrp
= prev_rp
->nextrp
;
2021 prev_rp
->parentfp
= NULL
;
2024 while ((rp
= prev_rp
->nextrp
)) {
2026 prev_rp
->nextrp
= rp
->nextrp
;
2027 rp
->parentfp
= NULL
;
2034 write_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
2039 sg_add_sfp(Sg_device
* sdp
, int dev
)
2042 unsigned long iflags
;
2045 sfp
= kzalloc(sizeof(*sfp
), GFP_ATOMIC
| __GFP_NOWARN
);
2049 init_waitqueue_head(&sfp
->read_wait
);
2050 rwlock_init(&sfp
->rq_list_lock
);
2052 kref_init(&sfp
->f_ref
);
2053 sfp
->timeout
= SG_DEFAULT_TIMEOUT
;
2054 sfp
->timeout_user
= SG_DEFAULT_TIMEOUT_USER
;
2055 sfp
->force_packid
= SG_DEF_FORCE_PACK_ID
;
2056 sfp
->low_dma
= (SG_DEF_FORCE_LOW_DMA
== 0) ?
2057 sdp
->device
->host
->unchecked_isa_dma
: 1;
2058 sfp
->cmd_q
= SG_DEF_COMMAND_Q
;
2059 sfp
->keep_orphan
= SG_DEF_KEEP_ORPHAN
;
2060 sfp
->parentdp
= sdp
;
2061 write_lock_irqsave(&sg_index_lock
, iflags
);
2062 list_add_tail(&sfp
->sfd_siblings
, &sdp
->sfds
);
2063 write_unlock_irqrestore(&sg_index_lock
, iflags
);
2064 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: sfp=0x%p\n", sfp
));
2065 if (unlikely(sg_big_buff
!= def_reserved_size
))
2066 sg_big_buff
= def_reserved_size
;
2068 bufflen
= min_t(int, sg_big_buff
,
2069 queue_max_sectors(sdp
->device
->request_queue
) * 512);
2070 sg_build_reserve(sfp
, bufflen
);
2071 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: bufflen=%d, k_use_sg=%d\n",
2072 sfp
->reserve
.bufflen
, sfp
->reserve
.k_use_sg
));
2074 kref_get(&sdp
->d_ref
);
2075 __module_get(THIS_MODULE
);
2079 static void sg_remove_sfp_usercontext(struct work_struct
*work
)
2081 struct sg_fd
*sfp
= container_of(work
, struct sg_fd
, ew
.work
);
2082 struct sg_device
*sdp
= sfp
->parentdp
;
2084 /* Cleanup any responses which were never read(). */
2086 sg_finish_rem_req(sfp
->headrp
);
2088 if (sfp
->reserve
.bufflen
> 0) {
2090 printk("sg_remove_sfp: bufflen=%d, k_use_sg=%d\n",
2091 (int) sfp
->reserve
.bufflen
,
2092 (int) sfp
->reserve
.k_use_sg
));
2093 sg_remove_scat(&sfp
->reserve
);
2097 printk("sg_remove_sfp: %s, sfp=0x%p\n",
2098 sdp
->disk
->disk_name
,
2102 scsi_device_put(sdp
->device
);
2104 module_put(THIS_MODULE
);
2107 static void sg_remove_sfp(struct kref
*kref
)
2109 struct sg_fd
*sfp
= container_of(kref
, struct sg_fd
, f_ref
);
2110 struct sg_device
*sdp
= sfp
->parentdp
;
2111 unsigned long iflags
;
2113 write_lock_irqsave(&sg_index_lock
, iflags
);
2114 list_del(&sfp
->sfd_siblings
);
2115 write_unlock_irqrestore(&sg_index_lock
, iflags
);
2116 wake_up_interruptible(&sdp
->o_excl_wait
);
2118 INIT_WORK(&sfp
->ew
.work
, sg_remove_sfp_usercontext
);
2119 schedule_work(&sfp
->ew
.work
);
2123 sg_res_in_use(Sg_fd
* sfp
)
2125 const Sg_request
*srp
;
2126 unsigned long iflags
;
2128 read_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
2129 for (srp
= sfp
->headrp
; srp
; srp
= srp
->nextrp
)
2132 read_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
2136 #ifdef CONFIG_SCSI_PROC_FS
2138 sg_idr_max_id(int id
, void *p
, void *data
)
2152 unsigned long iflags
;
2154 read_lock_irqsave(&sg_index_lock
, iflags
);
2155 idr_for_each(&sg_index_idr
, sg_idr_max_id
, &k
);
2156 read_unlock_irqrestore(&sg_index_lock
, iflags
);
2157 return k
+ 1; /* origin 1 */
2161 /* must be called with sg_index_lock held */
2162 static Sg_device
*sg_lookup_dev(int dev
)
2164 return idr_find(&sg_index_idr
, dev
);
2167 static Sg_device
*sg_get_dev(int dev
)
2169 struct sg_device
*sdp
;
2170 unsigned long flags
;
2172 read_lock_irqsave(&sg_index_lock
, flags
);
2173 sdp
= sg_lookup_dev(dev
);
2175 sdp
= ERR_PTR(-ENXIO
);
2176 else if (sdp
->detached
) {
2177 /* If sdp->detached, then the refcount may already be 0, in
2178 * which case it would be a bug to do kref_get().
2180 sdp
= ERR_PTR(-ENODEV
);
2182 kref_get(&sdp
->d_ref
);
2183 read_unlock_irqrestore(&sg_index_lock
, flags
);
2188 static void sg_put_dev(struct sg_device
*sdp
)
2190 kref_put(&sdp
->d_ref
, sg_device_destroy
);
2193 #ifdef CONFIG_SCSI_PROC_FS
2195 static struct proc_dir_entry
*sg_proc_sgp
= NULL
;
2197 static char sg_proc_sg_dirname
[] = "scsi/sg";
2199 static int sg_proc_seq_show_int(struct seq_file
*s
, void *v
);
2201 static int sg_proc_single_open_adio(struct inode
*inode
, struct file
*file
);
2202 static ssize_t
sg_proc_write_adio(struct file
*filp
, const char __user
*buffer
,
2203 size_t count
, loff_t
*off
);
2204 static const struct file_operations adio_fops
= {
2205 .owner
= THIS_MODULE
,
2206 .open
= sg_proc_single_open_adio
,
2208 .llseek
= seq_lseek
,
2209 .write
= sg_proc_write_adio
,
2210 .release
= single_release
,
2213 static int sg_proc_single_open_dressz(struct inode
*inode
, struct file
*file
);
2214 static ssize_t
sg_proc_write_dressz(struct file
*filp
,
2215 const char __user
*buffer
, size_t count
, loff_t
*off
);
2216 static const struct file_operations dressz_fops
= {
2217 .owner
= THIS_MODULE
,
2218 .open
= sg_proc_single_open_dressz
,
2220 .llseek
= seq_lseek
,
2221 .write
= sg_proc_write_dressz
,
2222 .release
= single_release
,
2225 static int sg_proc_seq_show_version(struct seq_file
*s
, void *v
);
2226 static int sg_proc_single_open_version(struct inode
*inode
, struct file
*file
);
2227 static const struct file_operations version_fops
= {
2228 .owner
= THIS_MODULE
,
2229 .open
= sg_proc_single_open_version
,
2231 .llseek
= seq_lseek
,
2232 .release
= single_release
,
2235 static int sg_proc_seq_show_devhdr(struct seq_file
*s
, void *v
);
2236 static int sg_proc_single_open_devhdr(struct inode
*inode
, struct file
*file
);
2237 static const struct file_operations devhdr_fops
= {
2238 .owner
= THIS_MODULE
,
2239 .open
= sg_proc_single_open_devhdr
,
2241 .llseek
= seq_lseek
,
2242 .release
= single_release
,
2245 static int sg_proc_seq_show_dev(struct seq_file
*s
, void *v
);
2246 static int sg_proc_open_dev(struct inode
*inode
, struct file
*file
);
2247 static void * dev_seq_start(struct seq_file
*s
, loff_t
*pos
);
2248 static void * dev_seq_next(struct seq_file
*s
, void *v
, loff_t
*pos
);
2249 static void dev_seq_stop(struct seq_file
*s
, void *v
);
2250 static const struct file_operations dev_fops
= {
2251 .owner
= THIS_MODULE
,
2252 .open
= sg_proc_open_dev
,
2254 .llseek
= seq_lseek
,
2255 .release
= seq_release
,
2257 static const struct seq_operations dev_seq_ops
= {
2258 .start
= dev_seq_start
,
2259 .next
= dev_seq_next
,
2260 .stop
= dev_seq_stop
,
2261 .show
= sg_proc_seq_show_dev
,
2264 static int sg_proc_seq_show_devstrs(struct seq_file
*s
, void *v
);
2265 static int sg_proc_open_devstrs(struct inode
*inode
, struct file
*file
);
2266 static const struct file_operations devstrs_fops
= {
2267 .owner
= THIS_MODULE
,
2268 .open
= sg_proc_open_devstrs
,
2270 .llseek
= seq_lseek
,
2271 .release
= seq_release
,
2273 static const struct seq_operations devstrs_seq_ops
= {
2274 .start
= dev_seq_start
,
2275 .next
= dev_seq_next
,
2276 .stop
= dev_seq_stop
,
2277 .show
= sg_proc_seq_show_devstrs
,
2280 static int sg_proc_seq_show_debug(struct seq_file
*s
, void *v
);
2281 static int sg_proc_open_debug(struct inode
*inode
, struct file
*file
);
2282 static const struct file_operations debug_fops
= {
2283 .owner
= THIS_MODULE
,
2284 .open
= sg_proc_open_debug
,
2286 .llseek
= seq_lseek
,
2287 .release
= seq_release
,
2289 static const struct seq_operations debug_seq_ops
= {
2290 .start
= dev_seq_start
,
2291 .next
= dev_seq_next
,
2292 .stop
= dev_seq_stop
,
2293 .show
= sg_proc_seq_show_debug
,
2297 struct sg_proc_leaf
{
2299 const struct file_operations
* fops
;
2302 static struct sg_proc_leaf sg_proc_leaf_arr
[] = {
2303 {"allow_dio", &adio_fops
},
2304 {"debug", &debug_fops
},
2305 {"def_reserved_size", &dressz_fops
},
2306 {"device_hdr", &devhdr_fops
},
2307 {"devices", &dev_fops
},
2308 {"device_strs", &devstrs_fops
},
2309 {"version", &version_fops
}
2315 int num_leaves
= ARRAY_SIZE(sg_proc_leaf_arr
);
2318 sg_proc_sgp
= proc_mkdir(sg_proc_sg_dirname
, NULL
);
2321 for (k
= 0; k
< num_leaves
; ++k
) {
2322 struct sg_proc_leaf
*leaf
= &sg_proc_leaf_arr
[k
];
2323 umode_t mask
= leaf
->fops
->write
? S_IRUGO
| S_IWUSR
: S_IRUGO
;
2324 proc_create(leaf
->name
, mask
, sg_proc_sgp
, leaf
->fops
);
2330 sg_proc_cleanup(void)
2333 int num_leaves
= ARRAY_SIZE(sg_proc_leaf_arr
);
2337 for (k
= 0; k
< num_leaves
; ++k
)
2338 remove_proc_entry(sg_proc_leaf_arr
[k
].name
, sg_proc_sgp
);
2339 remove_proc_entry(sg_proc_sg_dirname
, NULL
);
2343 static int sg_proc_seq_show_int(struct seq_file
*s
, void *v
)
2345 seq_printf(s
, "%d\n", *((int *)s
->private));
2349 static int sg_proc_single_open_adio(struct inode
*inode
, struct file
*file
)
2351 return single_open(file
, sg_proc_seq_show_int
, &sg_allow_dio
);
2355 sg_proc_write_adio(struct file
*filp
, const char __user
*buffer
,
2356 size_t count
, loff_t
*off
)
2361 if (!capable(CAP_SYS_ADMIN
) || !capable(CAP_SYS_RAWIO
))
2363 err
= kstrtoul_from_user(buffer
, count
, 0, &num
);
2366 sg_allow_dio
= num
? 1 : 0;
2370 static int sg_proc_single_open_dressz(struct inode
*inode
, struct file
*file
)
2372 return single_open(file
, sg_proc_seq_show_int
, &sg_big_buff
);
2376 sg_proc_write_dressz(struct file
*filp
, const char __user
*buffer
,
2377 size_t count
, loff_t
*off
)
2380 unsigned long k
= ULONG_MAX
;
2382 if (!capable(CAP_SYS_ADMIN
) || !capable(CAP_SYS_RAWIO
))
2385 err
= kstrtoul_from_user(buffer
, count
, 0, &k
);
2388 if (k
<= 1048576) { /* limit "big buff" to 1 MB */
2395 static int sg_proc_seq_show_version(struct seq_file
*s
, void *v
)
2397 seq_printf(s
, "%d\t%s [%s]\n", sg_version_num
, SG_VERSION_STR
,
2402 static int sg_proc_single_open_version(struct inode
*inode
, struct file
*file
)
2404 return single_open(file
, sg_proc_seq_show_version
, NULL
);
2407 static int sg_proc_seq_show_devhdr(struct seq_file
*s
, void *v
)
2409 seq_printf(s
, "host\tchan\tid\tlun\ttype\topens\tqdepth\tbusy\t"
2414 static int sg_proc_single_open_devhdr(struct inode
*inode
, struct file
*file
)
2416 return single_open(file
, sg_proc_seq_show_devhdr
, NULL
);
2419 struct sg_proc_deviter
{
2424 static void * dev_seq_start(struct seq_file
*s
, loff_t
*pos
)
2426 struct sg_proc_deviter
* it
= kmalloc(sizeof(*it
), GFP_KERNEL
);
2433 it
->max
= sg_last_dev();
2434 if (it
->index
>= it
->max
)
2439 static void * dev_seq_next(struct seq_file
*s
, void *v
, loff_t
*pos
)
2441 struct sg_proc_deviter
* it
= s
->private;
2444 return (it
->index
< it
->max
) ? it
: NULL
;
2447 static void dev_seq_stop(struct seq_file
*s
, void *v
)
2452 static int sg_proc_open_dev(struct inode
*inode
, struct file
*file
)
2454 return seq_open(file
, &dev_seq_ops
);
2457 static int sg_proc_seq_show_dev(struct seq_file
*s
, void *v
)
2459 struct sg_proc_deviter
* it
= (struct sg_proc_deviter
*) v
;
2461 struct scsi_device
*scsidp
;
2462 unsigned long iflags
;
2464 read_lock_irqsave(&sg_index_lock
, iflags
);
2465 sdp
= it
? sg_lookup_dev(it
->index
) : NULL
;
2466 if (sdp
&& (scsidp
= sdp
->device
) && (!sdp
->detached
))
2467 seq_printf(s
, "%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\n",
2468 scsidp
->host
->host_no
, scsidp
->channel
,
2469 scsidp
->id
, scsidp
->lun
, (int) scsidp
->type
,
2471 (int) scsidp
->queue_depth
,
2472 (int) scsidp
->device_busy
,
2473 (int) scsi_device_online(scsidp
));
2475 seq_printf(s
, "-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\n");
2476 read_unlock_irqrestore(&sg_index_lock
, iflags
);
2480 static int sg_proc_open_devstrs(struct inode
*inode
, struct file
*file
)
2482 return seq_open(file
, &devstrs_seq_ops
);
2485 static int sg_proc_seq_show_devstrs(struct seq_file
*s
, void *v
)
2487 struct sg_proc_deviter
* it
= (struct sg_proc_deviter
*) v
;
2489 struct scsi_device
*scsidp
;
2490 unsigned long iflags
;
2492 read_lock_irqsave(&sg_index_lock
, iflags
);
2493 sdp
= it
? sg_lookup_dev(it
->index
) : NULL
;
2494 if (sdp
&& (scsidp
= sdp
->device
) && (!sdp
->detached
))
2495 seq_printf(s
, "%8.8s\t%16.16s\t%4.4s\n",
2496 scsidp
->vendor
, scsidp
->model
, scsidp
->rev
);
2498 seq_printf(s
, "<no active device>\n");
2499 read_unlock_irqrestore(&sg_index_lock
, iflags
);
2503 /* must be called while holding sg_index_lock */
2504 static void sg_proc_debug_helper(struct seq_file
*s
, Sg_device
* sdp
)
2506 int k
, m
, new_interface
, blen
, usg
;
2509 const sg_io_hdr_t
*hp
;
2514 list_for_each_entry(fp
, &sdp
->sfds
, sfd_siblings
) {
2516 read_lock(&fp
->rq_list_lock
); /* irqs already disabled */
2517 seq_printf(s
, " FD(%d): timeout=%dms bufflen=%d "
2518 "(res)sgat=%d low_dma=%d\n", k
,
2519 jiffies_to_msecs(fp
->timeout
),
2520 fp
->reserve
.bufflen
,
2521 (int) fp
->reserve
.k_use_sg
,
2523 seq_printf(s
, " cmd_q=%d f_packid=%d k_orphan=%d closed=%d\n",
2524 (int) fp
->cmd_q
, (int) fp
->force_packid
,
2525 (int) fp
->keep_orphan
, (int) fp
->closed
);
2526 for (m
= 0, srp
= fp
->headrp
;
2528 ++m
, srp
= srp
->nextrp
) {
2530 new_interface
= (hp
->interface_id
== '\0') ? 0 : 1;
2531 if (srp
->res_used
) {
2532 if (new_interface
&&
2533 (SG_FLAG_MMAP_IO
& hp
->flags
))
2538 if (SG_INFO_DIRECT_IO_MASK
& hp
->info
)
2544 blen
= srp
->data
.bufflen
;
2545 usg
= srp
->data
.k_use_sg
;
2546 seq_printf(s
, srp
->done
?
2547 ((1 == srp
->done
) ? "rcv:" : "fin:")
2549 seq_printf(s
, " id=%d blen=%d",
2550 srp
->header
.pack_id
, blen
);
2552 seq_printf(s
, " dur=%d", hp
->duration
);
2554 ms
= jiffies_to_msecs(jiffies
);
2555 seq_printf(s
, " t_o/elap=%d/%d",
2556 (new_interface
? hp
->timeout
:
2557 jiffies_to_msecs(fp
->timeout
)),
2558 (ms
> hp
->duration
? ms
- hp
->duration
: 0));
2560 seq_printf(s
, "ms sgat=%d op=0x%02x\n", usg
,
2561 (int) srp
->data
.cmd_opcode
);
2564 seq_printf(s
, " No requests active\n");
2565 read_unlock(&fp
->rq_list_lock
);
2569 static int sg_proc_open_debug(struct inode
*inode
, struct file
*file
)
2571 return seq_open(file
, &debug_seq_ops
);
2574 static int sg_proc_seq_show_debug(struct seq_file
*s
, void *v
)
2576 struct sg_proc_deviter
* it
= (struct sg_proc_deviter
*) v
;
2578 unsigned long iflags
;
2580 if (it
&& (0 == it
->index
)) {
2581 seq_printf(s
, "max_active_device=%d(origin 1)\n",
2583 seq_printf(s
, " def_reserved_size=%d\n", sg_big_buff
);
2586 read_lock_irqsave(&sg_index_lock
, iflags
);
2587 sdp
= it
? sg_lookup_dev(it
->index
) : NULL
;
2588 if (sdp
&& !list_empty(&sdp
->sfds
)) {
2589 struct scsi_device
*scsidp
= sdp
->device
;
2591 seq_printf(s
, " >>> device=%s ", sdp
->disk
->disk_name
);
2593 seq_printf(s
, "detached pending close ");
2596 (s
, "scsi%d chan=%d id=%d lun=%d em=%d",
2597 scsidp
->host
->host_no
,
2598 scsidp
->channel
, scsidp
->id
,
2600 scsidp
->host
->hostt
->emulated
);
2601 seq_printf(s
, " sg_tablesize=%d excl=%d\n",
2602 sdp
->sg_tablesize
, sdp
->exclude
);
2603 sg_proc_debug_helper(s
, sdp
);
2605 read_unlock_irqrestore(&sg_index_lock
, iflags
);
2609 #endif /* CONFIG_SCSI_PROC_FS */
2611 module_init(init_sg
);
2612 module_exit(exit_sg
);