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/aio.h>
39 #include <linux/errno.h>
40 #include <linux/mtio.h>
41 #include <linux/ioctl.h>
42 #include <linux/slab.h>
43 #include <linux/fcntl.h>
44 #include <linux/init.h>
45 #include <linux/poll.h>
46 #include <linux/moduleparam.h>
47 #include <linux/cdev.h>
48 #include <linux/idr.h>
49 #include <linux/seq_file.h>
50 #include <linux/blkdev.h>
51 #include <linux/delay.h>
52 #include <linux/blktrace_api.h>
53 #include <linux/mutex.h>
54 #include <linux/ratelimit.h>
57 #include <scsi/scsi_dbg.h>
58 #include <scsi/scsi_host.h>
59 #include <scsi/scsi_driver.h>
60 #include <scsi/scsi_ioctl.h>
63 #include "scsi_logging.h"
65 #ifdef CONFIG_SCSI_PROC_FS
66 #include <linux/proc_fs.h>
67 static char *sg_version_date
= "20061027";
69 static int sg_proc_init(void);
70 static void sg_proc_cleanup(void);
73 #define SG_ALLOW_DIO_DEF 0
75 #define SG_MAX_DEVS 32768
78 * Suppose you want to calculate the formula muldiv(x,m,d)=int(x * m / d)
79 * Then when using 32 bit integers x * m may overflow during the calculation.
80 * Replacing muldiv(x) by muldiv(x)=((x % d) * m) / d + int(x / d) * m
81 * calculates the same, but prevents the overflow when both m and d
82 * are "small" numbers (like HZ and USER_HZ).
83 * Of course an overflow is inavoidable if the result of muldiv doesn't fit
86 #define MULDIV(X,MUL,DIV) ((((X % DIV) * MUL) / DIV) + ((X / DIV) * MUL))
88 #define SG_DEFAULT_TIMEOUT MULDIV(SG_DEFAULT_TIMEOUT_USER, HZ, USER_HZ)
90 int sg_big_buff
= SG_DEF_RESERVED_SIZE
;
91 /* N.B. This variable is readable and writeable via
92 /proc/scsi/sg/def_reserved_size . Each time sg_open() is called a buffer
93 of this size (or less if there is not enough memory) will be reserved
94 for use by this file descriptor. [Deprecated usage: this variable is also
95 readable via /proc/sys/kernel/sg-big-buff if the sg driver is built into
96 the kernel (i.e. it is not a module).] */
97 static int def_reserved_size
= -1; /* picks up init parameter */
98 static int sg_allow_dio
= SG_ALLOW_DIO_DEF
;
100 static int scatter_elem_sz
= SG_SCATTER_SZ
;
101 static int scatter_elem_sz_prev
= SG_SCATTER_SZ
;
103 #define SG_SECTOR_SZ 512
105 static int sg_add(struct device
*, struct class_interface
*);
106 static void sg_remove(struct device
*, struct class_interface
*);
108 static DEFINE_SPINLOCK(sg_open_exclusive_lock
);
110 static DEFINE_IDR(sg_index_idr
);
111 static DEFINE_RWLOCK(sg_index_lock
); /* Also used to lock
112 file descriptor list for device */
114 static struct class_interface sg_interface
= {
116 .remove_dev
= sg_remove
,
119 typedef struct sg_scatter_hold
{ /* holding area for scsi scatter gather info */
120 unsigned short k_use_sg
; /* Count of kernel scatter-gather pieces */
121 unsigned sglist_len
; /* size of malloc'd scatter-gather list ++ */
122 unsigned bufflen
; /* Size of (aggregate) data buffer */
125 char dio_in_use
; /* 0->indirect IO (or mmap), 1->dio */
126 unsigned char cmd_opcode
; /* first byte of command */
129 struct sg_device
; /* forward declarations */
132 typedef struct sg_request
{ /* SG_MAX_QUEUE requests outstanding per file */
133 struct sg_request
*nextrp
; /* NULL -> tail request (slist) */
134 struct sg_fd
*parentfp
; /* NULL -> not in use */
135 Sg_scatter_hold data
; /* hold buffer, perhaps scatter list */
136 sg_io_hdr_t header
; /* scsi command+info, see <scsi/sg.h> */
137 unsigned char sense_b
[SCSI_SENSE_BUFFERSIZE
];
138 char res_used
; /* 1 -> using reserve buffer, 0 -> not ... */
139 char orphan
; /* 1 -> drop on sight, 0 -> normal */
140 char sg_io_owned
; /* 1 -> packet belongs to SG_IO */
141 /* done protected by rq_list_lock */
142 char done
; /* 0->before bh, 1->before read, 2->read */
145 struct execute_work ew
;
148 typedef struct sg_fd
{ /* holds the state of a file descriptor */
149 /* sfd_siblings is protected by sg_index_lock */
150 struct list_head sfd_siblings
;
151 struct sg_device
*parentdp
; /* owning device */
152 wait_queue_head_t read_wait
; /* queue read until command done */
153 rwlock_t rq_list_lock
; /* protect access to list in req_arr */
154 int timeout
; /* defaults to SG_DEFAULT_TIMEOUT */
155 int timeout_user
; /* defaults to SG_DEFAULT_TIMEOUT_USER */
156 Sg_scatter_hold reserve
; /* buffer held for this file descriptor */
157 unsigned save_scat_len
; /* original length of trunc. scat. element */
158 Sg_request
*headrp
; /* head of request slist, NULL->empty */
159 struct fasync_struct
*async_qp
; /* used by asynchronous notification */
160 Sg_request req_arr
[SG_MAX_QUEUE
]; /* used as singly-linked list */
161 char low_dma
; /* as in parent but possibly overridden to 1 */
162 char force_packid
; /* 1 -> pack_id input to read(), 0 -> ignored */
163 char cmd_q
; /* 1 -> allow command queuing, 0 -> don't */
164 char next_cmd_len
; /* 0 -> automatic (def), >0 -> use on next write() */
165 char keep_orphan
; /* 0 -> drop orphan (def), 1 -> keep for read() */
166 char mmap_called
; /* 0 -> mmap() never called on this fd */
168 struct execute_work ew
;
171 typedef struct sg_device
{ /* holds the state of each scsi generic device */
172 struct scsi_device
*device
;
173 wait_queue_head_t o_excl_wait
; /* queue open() when O_EXCL in use */
174 int sg_tablesize
; /* adapter's max scatter-gather table size */
175 u32 index
; /* device index number */
176 /* sfds is protected by sg_index_lock */
177 struct list_head sfds
;
178 volatile char detached
; /* 0->attached, 1->detached pending removal */
179 /* exclude protected by sg_open_exclusive_lock */
180 char exclude
; /* opened for exclusive access */
181 char sgdebug
; /* 0->off, 1->sense, 9->dump dev, 10-> all devs */
182 struct gendisk
*disk
;
183 struct cdev
* cdev
; /* char_dev [sysfs: /sys/cdev/major/sg<n>] */
187 /* tasklet or soft irq callback */
188 static void sg_rq_end_io(struct request
*rq
, int uptodate
);
189 static int sg_start_req(Sg_request
*srp
, unsigned char *cmd
);
190 static int sg_finish_rem_req(Sg_request
* srp
);
191 static int sg_build_indirect(Sg_scatter_hold
* schp
, Sg_fd
* sfp
, int buff_size
);
192 static ssize_t
sg_new_read(Sg_fd
* sfp
, char __user
*buf
, size_t count
,
194 static ssize_t
sg_new_write(Sg_fd
*sfp
, struct file
*file
,
195 const char __user
*buf
, size_t count
, int blocking
,
196 int read_only
, int sg_io_owned
, Sg_request
**o_srp
);
197 static int sg_common_write(Sg_fd
* sfp
, Sg_request
* srp
,
198 unsigned char *cmnd
, int timeout
, int blocking
);
199 static int sg_read_oxfer(Sg_request
* srp
, char __user
*outp
, int num_read_xfer
);
200 static void sg_remove_scat(Sg_scatter_hold
* schp
);
201 static void sg_build_reserve(Sg_fd
* sfp
, int req_size
);
202 static void sg_link_reserve(Sg_fd
* sfp
, Sg_request
* srp
, int size
);
203 static void sg_unlink_reserve(Sg_fd
* sfp
, Sg_request
* srp
);
204 static Sg_fd
*sg_add_sfp(Sg_device
* sdp
, int dev
);
205 static void sg_remove_sfp(struct kref
*);
206 static Sg_request
*sg_get_rq_mark(Sg_fd
* sfp
, int pack_id
);
207 static Sg_request
*sg_add_request(Sg_fd
* sfp
);
208 static int sg_remove_request(Sg_fd
* sfp
, Sg_request
* srp
);
209 static int sg_res_in_use(Sg_fd
* sfp
);
210 static Sg_device
*sg_get_dev(int dev
);
211 static void sg_put_dev(Sg_device
*sdp
);
213 #define SZ_SG_HEADER sizeof(struct sg_header)
214 #define SZ_SG_IO_HDR sizeof(sg_io_hdr_t)
215 #define SZ_SG_IOVEC sizeof(sg_iovec_t)
216 #define SZ_SG_REQ_INFO sizeof(sg_req_info_t)
218 static int sg_allow_access(struct file
*filp
, unsigned char *cmd
)
220 struct sg_fd
*sfp
= filp
->private_data
;
222 if (sfp
->parentdp
->device
->type
== TYPE_SCANNER
)
225 return blk_verify_command(cmd
, filp
->f_mode
& FMODE_WRITE
);
228 static int get_exclude(Sg_device
*sdp
)
233 spin_lock_irqsave(&sg_open_exclusive_lock
, flags
);
235 spin_unlock_irqrestore(&sg_open_exclusive_lock
, flags
);
239 static int set_exclude(Sg_device
*sdp
, char val
)
243 spin_lock_irqsave(&sg_open_exclusive_lock
, flags
);
245 spin_unlock_irqrestore(&sg_open_exclusive_lock
, flags
);
249 static int sfds_list_empty(Sg_device
*sdp
)
254 read_lock_irqsave(&sg_index_lock
, flags
);
255 ret
= list_empty(&sdp
->sfds
);
256 read_unlock_irqrestore(&sg_index_lock
, flags
);
261 sg_open(struct inode
*inode
, struct file
*filp
)
263 int dev
= iminor(inode
);
264 int flags
= filp
->f_flags
;
265 struct request_queue
*q
;
271 nonseekable_open(inode
, filp
);
272 SCSI_LOG_TIMEOUT(3, printk("sg_open: dev=%d, flags=0x%x\n", dev
, flags
));
273 sdp
= sg_get_dev(dev
);
275 retval
= PTR_ERR(sdp
);
280 /* This driver's module count bumped by fops_get in <linux/fs.h> */
281 /* Prevent the device driver from vanishing while we sleep */
282 retval
= scsi_device_get(sdp
->device
);
286 retval
= scsi_autopm_get_device(sdp
->device
);
290 if (!((flags
& O_NONBLOCK
) ||
291 scsi_block_when_processing_errors(sdp
->device
))) {
293 /* we are in error recovery for this device */
297 if (flags
& O_EXCL
) {
298 if (O_RDONLY
== (flags
& O_ACCMODE
)) {
299 retval
= -EPERM
; /* Can't lock it with read only access */
302 if (!sfds_list_empty(sdp
) && (flags
& O_NONBLOCK
)) {
306 res
= wait_event_interruptible(sdp
->o_excl_wait
,
307 ((!sfds_list_empty(sdp
) || get_exclude(sdp
)) ? 0 : set_exclude(sdp
, 1)));
309 retval
= res
; /* -ERESTARTSYS because signal hit process */
312 } else if (get_exclude(sdp
)) { /* some other fd has an exclusive lock on dev */
313 if (flags
& O_NONBLOCK
) {
317 res
= wait_event_interruptible(sdp
->o_excl_wait
, !get_exclude(sdp
));
319 retval
= res
; /* -ERESTARTSYS because signal hit process */
327 if (sfds_list_empty(sdp
)) { /* no existing opens on this device */
329 q
= sdp
->device
->request_queue
;
330 sdp
->sg_tablesize
= queue_max_segments(q
);
332 if ((sfp
= sg_add_sfp(sdp
, dev
)))
333 filp
->private_data
= sfp
;
335 if (flags
& O_EXCL
) {
336 set_exclude(sdp
, 0); /* undo if error */
337 wake_up_interruptible(&sdp
->o_excl_wait
);
345 scsi_autopm_put_device(sdp
->device
);
347 scsi_device_put(sdp
->device
);
355 /* Following function was formerly called 'sg_close' */
357 sg_release(struct inode
*inode
, struct file
*filp
)
362 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
364 SCSI_LOG_TIMEOUT(3, printk("sg_release: %s\n", sdp
->disk
->disk_name
));
367 wake_up_interruptible(&sdp
->o_excl_wait
);
369 scsi_autopm_put_device(sdp
->device
);
370 kref_put(&sfp
->f_ref
, sg_remove_sfp
);
375 sg_read(struct file
*filp
, char __user
*buf
, size_t count
, loff_t
* ppos
)
380 int req_pack_id
= -1;
382 struct sg_header
*old_hdr
= NULL
;
385 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
387 SCSI_LOG_TIMEOUT(3, printk("sg_read: %s, count=%d\n",
388 sdp
->disk
->disk_name
, (int) count
));
390 if (!access_ok(VERIFY_WRITE
, buf
, count
))
392 if (sfp
->force_packid
&& (count
>= SZ_SG_HEADER
)) {
393 old_hdr
= kmalloc(SZ_SG_HEADER
, GFP_KERNEL
);
396 if (__copy_from_user(old_hdr
, buf
, SZ_SG_HEADER
)) {
400 if (old_hdr
->reply_len
< 0) {
401 if (count
>= SZ_SG_IO_HDR
) {
402 sg_io_hdr_t
*new_hdr
;
403 new_hdr
= kmalloc(SZ_SG_IO_HDR
, GFP_KERNEL
);
408 retval
=__copy_from_user
409 (new_hdr
, buf
, SZ_SG_IO_HDR
);
410 req_pack_id
= new_hdr
->pack_id
;
418 req_pack_id
= old_hdr
->pack_id
;
420 srp
= sg_get_rq_mark(sfp
, req_pack_id
);
421 if (!srp
) { /* now wait on packet to arrive */
426 if (filp
->f_flags
& O_NONBLOCK
) {
430 retval
= wait_event_interruptible(sfp
->read_wait
,
432 (srp
= sg_get_rq_mark(sfp
, req_pack_id
))));
438 /* -ERESTARTSYS as signal hit process */
442 if (srp
->header
.interface_id
!= '\0') {
443 retval
= sg_new_read(sfp
, buf
, count
, srp
);
448 if (old_hdr
== NULL
) {
449 old_hdr
= kmalloc(SZ_SG_HEADER
, GFP_KERNEL
);
455 memset(old_hdr
, 0, SZ_SG_HEADER
);
456 old_hdr
->reply_len
= (int) hp
->timeout
;
457 old_hdr
->pack_len
= old_hdr
->reply_len
; /* old, strange behaviour */
458 old_hdr
->pack_id
= hp
->pack_id
;
459 old_hdr
->twelve_byte
=
460 ((srp
->data
.cmd_opcode
>= 0xc0) && (12 == hp
->cmd_len
)) ? 1 : 0;
461 old_hdr
->target_status
= hp
->masked_status
;
462 old_hdr
->host_status
= hp
->host_status
;
463 old_hdr
->driver_status
= hp
->driver_status
;
464 if ((CHECK_CONDITION
& hp
->masked_status
) ||
465 (DRIVER_SENSE
& hp
->driver_status
))
466 memcpy(old_hdr
->sense_buffer
, srp
->sense_b
,
467 sizeof (old_hdr
->sense_buffer
));
468 switch (hp
->host_status
) {
469 /* This setup of 'result' is for backward compatibility and is best
470 ignored by the user who should use target, host + driver status */
472 case DID_PASSTHROUGH
:
479 old_hdr
->result
= EBUSY
;
486 old_hdr
->result
= EIO
;
489 old_hdr
->result
= (srp
->sense_b
[0] == 0 &&
490 hp
->masked_status
== GOOD
) ? 0 : EIO
;
493 old_hdr
->result
= EIO
;
497 /* Now copy the result back to the user buffer. */
498 if (count
>= SZ_SG_HEADER
) {
499 if (__copy_to_user(buf
, old_hdr
, SZ_SG_HEADER
)) {
504 if (count
> old_hdr
->reply_len
)
505 count
= old_hdr
->reply_len
;
506 if (count
> SZ_SG_HEADER
) {
507 if (sg_read_oxfer(srp
, buf
, count
- SZ_SG_HEADER
)) {
513 count
= (old_hdr
->result
== 0) ? 0 : -EIO
;
514 sg_finish_rem_req(srp
);
522 sg_new_read(Sg_fd
* sfp
, char __user
*buf
, size_t count
, Sg_request
* srp
)
524 sg_io_hdr_t
*hp
= &srp
->header
;
528 if (count
< SZ_SG_IO_HDR
) {
533 if ((hp
->mx_sb_len
> 0) && hp
->sbp
) {
534 if ((CHECK_CONDITION
& hp
->masked_status
) ||
535 (DRIVER_SENSE
& hp
->driver_status
)) {
536 int sb_len
= SCSI_SENSE_BUFFERSIZE
;
537 sb_len
= (hp
->mx_sb_len
> sb_len
) ? sb_len
: hp
->mx_sb_len
;
538 len
= 8 + (int) srp
->sense_b
[7]; /* Additional sense length field */
539 len
= (len
> sb_len
) ? sb_len
: len
;
540 if (copy_to_user(hp
->sbp
, srp
->sense_b
, len
)) {
547 if (hp
->masked_status
|| hp
->host_status
|| hp
->driver_status
)
548 hp
->info
|= SG_INFO_CHECK
;
549 if (copy_to_user(buf
, hp
, SZ_SG_IO_HDR
)) {
554 err2
= sg_finish_rem_req(srp
);
555 return err
? : err2
? : count
;
559 sg_write(struct file
*filp
, const char __user
*buf
, size_t count
, loff_t
* ppos
)
561 int mxsize
, cmd_size
, k
;
562 int input_size
, blocking
;
563 unsigned char opcode
;
567 struct sg_header old_hdr
;
569 unsigned char cmnd
[MAX_COMMAND_SIZE
];
571 if (unlikely(segment_eq(get_fs(), KERNEL_DS
)))
574 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
576 SCSI_LOG_TIMEOUT(3, printk("sg_write: %s, count=%d\n",
577 sdp
->disk
->disk_name
, (int) count
));
580 if (!((filp
->f_flags
& O_NONBLOCK
) ||
581 scsi_block_when_processing_errors(sdp
->device
)))
584 if (!access_ok(VERIFY_READ
, buf
, count
))
585 return -EFAULT
; /* protects following copy_from_user()s + get_user()s */
586 if (count
< SZ_SG_HEADER
)
588 if (__copy_from_user(&old_hdr
, buf
, SZ_SG_HEADER
))
590 blocking
= !(filp
->f_flags
& O_NONBLOCK
);
591 if (old_hdr
.reply_len
< 0)
592 return sg_new_write(sfp
, filp
, buf
, count
,
593 blocking
, 0, 0, NULL
);
594 if (count
< (SZ_SG_HEADER
+ 6))
595 return -EIO
; /* The minimum scsi command length is 6 bytes. */
597 if (!(srp
= sg_add_request(sfp
))) {
598 SCSI_LOG_TIMEOUT(1, printk("sg_write: queue full\n"));
602 __get_user(opcode
, buf
);
603 if (sfp
->next_cmd_len
> 0) {
604 if (sfp
->next_cmd_len
> MAX_COMMAND_SIZE
) {
605 SCSI_LOG_TIMEOUT(1, printk("sg_write: command length too long\n"));
606 sfp
->next_cmd_len
= 0;
607 sg_remove_request(sfp
, srp
);
610 cmd_size
= sfp
->next_cmd_len
;
611 sfp
->next_cmd_len
= 0; /* reset so only this write() effected */
613 cmd_size
= COMMAND_SIZE(opcode
); /* based on SCSI command group */
614 if ((opcode
>= 0xc0) && old_hdr
.twelve_byte
)
617 SCSI_LOG_TIMEOUT(4, printk(
618 "sg_write: scsi opcode=0x%02x, cmd_size=%d\n", (int) opcode
, cmd_size
));
619 /* Determine buffer size. */
620 input_size
= count
- cmd_size
;
621 mxsize
= (input_size
> old_hdr
.reply_len
) ? input_size
: old_hdr
.reply_len
;
622 mxsize
-= SZ_SG_HEADER
;
623 input_size
-= SZ_SG_HEADER
;
624 if (input_size
< 0) {
625 sg_remove_request(sfp
, srp
);
626 return -EIO
; /* User did not pass enough bytes for this command. */
629 hp
->interface_id
= '\0'; /* indicator of old interface tunnelled */
630 hp
->cmd_len
= (unsigned char) cmd_size
;
634 hp
->dxfer_direction
= (old_hdr
.reply_len
> SZ_SG_HEADER
) ?
635 SG_DXFER_TO_FROM_DEV
: SG_DXFER_TO_DEV
;
637 hp
->dxfer_direction
= (mxsize
> 0) ? SG_DXFER_FROM_DEV
: SG_DXFER_NONE
;
638 hp
->dxfer_len
= mxsize
;
639 if ((hp
->dxfer_direction
== SG_DXFER_TO_DEV
) ||
640 (hp
->dxfer_direction
== SG_DXFER_TO_FROM_DEV
))
641 hp
->dxferp
= (char __user
*)buf
+ cmd_size
;
645 hp
->timeout
= old_hdr
.reply_len
; /* structure abuse ... */
646 hp
->flags
= input_size
; /* structure abuse ... */
647 hp
->pack_id
= old_hdr
.pack_id
;
649 if (__copy_from_user(cmnd
, buf
, cmd_size
))
652 * SG_DXFER_TO_FROM_DEV is functionally equivalent to SG_DXFER_FROM_DEV,
653 * but is is possible that the app intended SG_DXFER_TO_DEV, because there
654 * is a non-zero input_size, so emit a warning.
656 if (hp
->dxfer_direction
== SG_DXFER_TO_FROM_DEV
) {
657 static char cmd
[TASK_COMM_LEN
];
658 if (strcmp(current
->comm
, cmd
)) {
659 printk_ratelimited(KERN_WARNING
660 "sg_write: data in/out %d/%d bytes "
661 "for SCSI command 0x%x-- guessing "
662 "data in;\n program %s not setting "
663 "count and/or reply_len properly\n",
664 old_hdr
.reply_len
- (int)SZ_SG_HEADER
,
665 input_size
, (unsigned int) cmnd
[0],
667 strcpy(cmd
, current
->comm
);
670 k
= sg_common_write(sfp
, srp
, cmnd
, sfp
->timeout
, blocking
);
671 return (k
< 0) ? k
: count
;
675 sg_new_write(Sg_fd
*sfp
, struct file
*file
, const char __user
*buf
,
676 size_t count
, int blocking
, int read_only
, int sg_io_owned
,
682 unsigned char cmnd
[MAX_COMMAND_SIZE
];
684 unsigned long ul_timeout
;
686 if (count
< SZ_SG_IO_HDR
)
688 if (!access_ok(VERIFY_READ
, buf
, count
))
689 return -EFAULT
; /* protects following copy_from_user()s + get_user()s */
691 sfp
->cmd_q
= 1; /* when sg_io_hdr seen, set command queuing on */
692 if (!(srp
= sg_add_request(sfp
))) {
693 SCSI_LOG_TIMEOUT(1, printk("sg_new_write: queue full\n"));
696 srp
->sg_io_owned
= sg_io_owned
;
698 if (__copy_from_user(hp
, buf
, SZ_SG_IO_HDR
)) {
699 sg_remove_request(sfp
, srp
);
702 if (hp
->interface_id
!= 'S') {
703 sg_remove_request(sfp
, srp
);
706 if (hp
->flags
& SG_FLAG_MMAP_IO
) {
707 if (hp
->dxfer_len
> sfp
->reserve
.bufflen
) {
708 sg_remove_request(sfp
, srp
);
709 return -ENOMEM
; /* MMAP_IO size must fit in reserve buffer */
711 if (hp
->flags
& SG_FLAG_DIRECT_IO
) {
712 sg_remove_request(sfp
, srp
);
713 return -EINVAL
; /* either MMAP_IO or DIRECT_IO (not both) */
715 if (sg_res_in_use(sfp
)) {
716 sg_remove_request(sfp
, srp
);
717 return -EBUSY
; /* reserve buffer already being used */
720 ul_timeout
= msecs_to_jiffies(srp
->header
.timeout
);
721 timeout
= (ul_timeout
< INT_MAX
) ? ul_timeout
: INT_MAX
;
722 if ((!hp
->cmdp
) || (hp
->cmd_len
< 6) || (hp
->cmd_len
> sizeof (cmnd
))) {
723 sg_remove_request(sfp
, srp
);
726 if (!access_ok(VERIFY_READ
, hp
->cmdp
, hp
->cmd_len
)) {
727 sg_remove_request(sfp
, srp
);
728 return -EFAULT
; /* protects following copy_from_user()s + get_user()s */
730 if (__copy_from_user(cmnd
, hp
->cmdp
, hp
->cmd_len
)) {
731 sg_remove_request(sfp
, srp
);
734 if (read_only
&& sg_allow_access(file
, cmnd
)) {
735 sg_remove_request(sfp
, srp
);
738 k
= sg_common_write(sfp
, srp
, cmnd
, timeout
, blocking
);
747 sg_common_write(Sg_fd
* sfp
, Sg_request
* srp
,
748 unsigned char *cmnd
, int timeout
, int blocking
)
751 Sg_device
*sdp
= sfp
->parentdp
;
752 sg_io_hdr_t
*hp
= &srp
->header
;
754 srp
->data
.cmd_opcode
= cmnd
[0]; /* hold opcode of command */
756 hp
->masked_status
= 0;
760 hp
->driver_status
= 0;
762 SCSI_LOG_TIMEOUT(4, printk("sg_common_write: scsi opcode=0x%02x, cmd_size=%d\n",
763 (int) cmnd
[0], (int) hp
->cmd_len
));
765 k
= sg_start_req(srp
, cmnd
);
767 SCSI_LOG_TIMEOUT(1, printk("sg_common_write: start_req err=%d\n", k
));
768 sg_finish_rem_req(srp
);
769 return k
; /* probably out of space --> ENOMEM */
773 if (srp
->rq
->cmd
!= srp
->rq
->__cmd
)
776 blk_end_request_all(srp
->rq
, -EIO
);
780 sg_finish_rem_req(srp
);
784 switch (hp
->dxfer_direction
) {
785 case SG_DXFER_TO_FROM_DEV
:
786 case SG_DXFER_FROM_DEV
:
787 data_dir
= DMA_FROM_DEVICE
;
789 case SG_DXFER_TO_DEV
:
790 data_dir
= DMA_TO_DEVICE
;
792 case SG_DXFER_UNKNOWN
:
793 data_dir
= DMA_BIDIRECTIONAL
;
799 hp
->duration
= jiffies_to_msecs(jiffies
);
801 srp
->rq
->timeout
= timeout
;
802 kref_get(&sfp
->f_ref
); /* sg_rq_end_io() does kref_put(). */
803 blk_execute_rq_nowait(sdp
->device
->request_queue
, sdp
->disk
,
804 srp
->rq
, 1, sg_rq_end_io
);
808 static int srp_done(Sg_fd
*sfp
, Sg_request
*srp
)
813 read_lock_irqsave(&sfp
->rq_list_lock
, flags
);
815 read_unlock_irqrestore(&sfp
->rq_list_lock
, flags
);
820 sg_ioctl(struct file
*filp
, unsigned int cmd_in
, unsigned long arg
)
822 void __user
*p
= (void __user
*)arg
;
824 int result
, val
, read_only
;
828 unsigned long iflags
;
830 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
833 SCSI_LOG_TIMEOUT(3, printk("sg_ioctl: %s, cmd=0x%x\n",
834 sdp
->disk
->disk_name
, (int) cmd_in
));
835 read_only
= (O_RDWR
!= (filp
->f_flags
& O_ACCMODE
));
841 if (!scsi_block_when_processing_errors(sdp
->device
))
843 if (!access_ok(VERIFY_WRITE
, p
, SZ_SG_IO_HDR
))
845 result
= sg_new_write(sfp
, filp
, p
, SZ_SG_IO_HDR
,
846 1, read_only
, 1, &srp
);
849 result
= wait_event_interruptible(sfp
->read_wait
,
850 (srp_done(sfp
, srp
) || sdp
->detached
));
853 write_lock_irq(&sfp
->rq_list_lock
);
856 write_unlock_irq(&sfp
->rq_list_lock
);
857 result
= sg_new_read(sfp
, p
, SZ_SG_IO_HDR
, srp
);
858 return (result
< 0) ? result
: 0;
861 write_unlock_irq(&sfp
->rq_list_lock
);
862 return result
; /* -ERESTARTSYS because signal hit process */
864 result
= get_user(val
, ip
);
869 if (val
>= MULDIV (INT_MAX
, USER_HZ
, HZ
))
870 val
= MULDIV (INT_MAX
, USER_HZ
, HZ
);
871 sfp
->timeout_user
= val
;
872 sfp
->timeout
= MULDIV (val
, HZ
, USER_HZ
);
875 case SG_GET_TIMEOUT
: /* N.B. User receives timeout as return value */
876 /* strange ..., for backward compatibility */
877 return sfp
->timeout_user
;
878 case SG_SET_FORCE_LOW_DMA
:
879 result
= get_user(val
, ip
);
884 if ((0 == sfp
->low_dma
) && (0 == sg_res_in_use(sfp
))) {
885 val
= (int) sfp
->reserve
.bufflen
;
886 sg_remove_scat(&sfp
->reserve
);
887 sg_build_reserve(sfp
, val
);
892 sfp
->low_dma
= sdp
->device
->host
->unchecked_isa_dma
;
896 return put_user((int) sfp
->low_dma
, ip
);
898 if (!access_ok(VERIFY_WRITE
, p
, sizeof (sg_scsi_id_t
)))
901 sg_scsi_id_t __user
*sg_idp
= p
;
905 __put_user((int) sdp
->device
->host
->host_no
,
907 __put_user((int) sdp
->device
->channel
,
909 __put_user((int) sdp
->device
->id
, &sg_idp
->scsi_id
);
910 __put_user((int) sdp
->device
->lun
, &sg_idp
->lun
);
911 __put_user((int) sdp
->device
->type
, &sg_idp
->scsi_type
);
912 __put_user((short) sdp
->device
->host
->cmd_per_lun
,
913 &sg_idp
->h_cmd_per_lun
);
914 __put_user((short) sdp
->device
->queue_depth
,
915 &sg_idp
->d_queue_depth
);
916 __put_user(0, &sg_idp
->unused
[0]);
917 __put_user(0, &sg_idp
->unused
[1]);
920 case SG_SET_FORCE_PACK_ID
:
921 result
= get_user(val
, ip
);
924 sfp
->force_packid
= val
? 1 : 0;
927 if (!access_ok(VERIFY_WRITE
, ip
, sizeof (int)))
929 read_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
930 for (srp
= sfp
->headrp
; srp
; srp
= srp
->nextrp
) {
931 if ((1 == srp
->done
) && (!srp
->sg_io_owned
)) {
932 read_unlock_irqrestore(&sfp
->rq_list_lock
,
934 __put_user(srp
->header
.pack_id
, ip
);
938 read_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
941 case SG_GET_NUM_WAITING
:
942 read_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
943 for (val
= 0, srp
= sfp
->headrp
; srp
; srp
= srp
->nextrp
) {
944 if ((1 == srp
->done
) && (!srp
->sg_io_owned
))
947 read_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
948 return put_user(val
, ip
);
949 case SG_GET_SG_TABLESIZE
:
950 return put_user(sdp
->sg_tablesize
, ip
);
951 case SG_SET_RESERVED_SIZE
:
952 result
= get_user(val
, ip
);
957 val
= min_t(int, val
,
958 queue_max_sectors(sdp
->device
->request_queue
) * 512);
959 if (val
!= sfp
->reserve
.bufflen
) {
960 if (sg_res_in_use(sfp
) || sfp
->mmap_called
)
962 sg_remove_scat(&sfp
->reserve
);
963 sg_build_reserve(sfp
, val
);
966 case SG_GET_RESERVED_SIZE
:
967 val
= min_t(int, sfp
->reserve
.bufflen
,
968 queue_max_sectors(sdp
->device
->request_queue
) * 512);
969 return put_user(val
, ip
);
970 case SG_SET_COMMAND_Q
:
971 result
= get_user(val
, ip
);
974 sfp
->cmd_q
= val
? 1 : 0;
976 case SG_GET_COMMAND_Q
:
977 return put_user((int) sfp
->cmd_q
, ip
);
978 case SG_SET_KEEP_ORPHAN
:
979 result
= get_user(val
, ip
);
982 sfp
->keep_orphan
= val
;
984 case SG_GET_KEEP_ORPHAN
:
985 return put_user((int) sfp
->keep_orphan
, ip
);
986 case SG_NEXT_CMD_LEN
:
987 result
= get_user(val
, ip
);
990 sfp
->next_cmd_len
= (val
> 0) ? val
: 0;
992 case SG_GET_VERSION_NUM
:
993 return put_user(sg_version_num
, ip
);
994 case SG_GET_ACCESS_COUNT
:
995 /* faked - we don't have a real access count anymore */
996 val
= (sdp
->device
? 1 : 0);
997 return put_user(val
, ip
);
998 case SG_GET_REQUEST_TABLE
:
999 if (!access_ok(VERIFY_WRITE
, p
, SZ_SG_REQ_INFO
* SG_MAX_QUEUE
))
1002 sg_req_info_t
*rinfo
;
1005 rinfo
= kmalloc(SZ_SG_REQ_INFO
* SG_MAX_QUEUE
,
1009 read_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
1010 for (srp
= sfp
->headrp
, val
= 0; val
< SG_MAX_QUEUE
;
1011 ++val
, srp
= srp
? srp
->nextrp
: srp
) {
1012 memset(&rinfo
[val
], 0, SZ_SG_REQ_INFO
);
1014 rinfo
[val
].req_state
= srp
->done
+ 1;
1015 rinfo
[val
].problem
=
1016 srp
->header
.masked_status
&
1017 srp
->header
.host_status
&
1018 srp
->header
.driver_status
;
1020 rinfo
[val
].duration
=
1021 srp
->header
.duration
;
1023 ms
= jiffies_to_msecs(jiffies
);
1024 rinfo
[val
].duration
=
1025 (ms
> srp
->header
.duration
) ?
1026 (ms
- srp
->header
.duration
) : 0;
1028 rinfo
[val
].orphan
= srp
->orphan
;
1029 rinfo
[val
].sg_io_owned
=
1031 rinfo
[val
].pack_id
=
1032 srp
->header
.pack_id
;
1033 rinfo
[val
].usr_ptr
=
1034 srp
->header
.usr_ptr
;
1037 read_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
1038 result
= __copy_to_user(p
, rinfo
,
1039 SZ_SG_REQ_INFO
* SG_MAX_QUEUE
);
1040 result
= result
? -EFAULT
: 0;
1044 case SG_EMULATED_HOST
:
1047 return put_user(sdp
->device
->host
->hostt
->emulated
, ip
);
1051 if (filp
->f_flags
& O_NONBLOCK
) {
1052 if (scsi_host_in_recovery(sdp
->device
->host
))
1054 } else if (!scsi_block_when_processing_errors(sdp
->device
))
1056 result
= get_user(val
, ip
);
1059 if (SG_SCSI_RESET_NOTHING
== val
)
1062 case SG_SCSI_RESET_DEVICE
:
1063 val
= SCSI_TRY_RESET_DEVICE
;
1065 case SG_SCSI_RESET_TARGET
:
1066 val
= SCSI_TRY_RESET_TARGET
;
1068 case SG_SCSI_RESET_BUS
:
1069 val
= SCSI_TRY_RESET_BUS
;
1071 case SG_SCSI_RESET_HOST
:
1072 val
= SCSI_TRY_RESET_HOST
;
1077 if (!capable(CAP_SYS_ADMIN
) || !capable(CAP_SYS_RAWIO
))
1079 return (scsi_reset_provider(sdp
->device
, val
) ==
1080 SUCCESS
) ? 0 : -EIO
;
1081 case SCSI_IOCTL_SEND_COMMAND
:
1085 unsigned char opcode
= WRITE_6
;
1086 Scsi_Ioctl_Command __user
*siocp
= p
;
1088 if (copy_from_user(&opcode
, siocp
->data
, 1))
1090 if (sg_allow_access(filp
, &opcode
))
1093 return sg_scsi_ioctl(sdp
->device
->request_queue
, NULL
, filp
->f_mode
, p
);
1095 result
= get_user(val
, ip
);
1098 sdp
->sgdebug
= (char) val
;
1100 case SCSI_IOCTL_GET_IDLUN
:
1101 case SCSI_IOCTL_GET_BUS_NUMBER
:
1102 case SCSI_IOCTL_PROBE_HOST
:
1103 case SG_GET_TRANSFORM
:
1106 return scsi_ioctl(sdp
->device
, cmd_in
, p
);
1108 return put_user(queue_max_sectors(sdp
->device
->request_queue
) * 512,
1111 return blk_trace_setup(sdp
->device
->request_queue
,
1112 sdp
->disk
->disk_name
,
1113 MKDEV(SCSI_GENERIC_MAJOR
, sdp
->index
),
1117 return blk_trace_startstop(sdp
->device
->request_queue
, 1);
1119 return blk_trace_startstop(sdp
->device
->request_queue
, 0);
1120 case BLKTRACETEARDOWN
:
1121 return blk_trace_remove(sdp
->device
->request_queue
);
1124 return -EPERM
; /* don't know so take safe approach */
1125 return scsi_ioctl(sdp
->device
, cmd_in
, p
);
1129 #ifdef CONFIG_COMPAT
1130 static long sg_compat_ioctl(struct file
*filp
, unsigned int cmd_in
, unsigned long arg
)
1134 struct scsi_device
*sdev
;
1136 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
1140 if (sdev
->host
->hostt
->compat_ioctl
) {
1143 ret
= sdev
->host
->hostt
->compat_ioctl(sdev
, cmd_in
, (void __user
*)arg
);
1148 return -ENOIOCTLCMD
;
1153 sg_poll(struct file
*filp
, poll_table
* wait
)
1155 unsigned int res
= 0;
1160 unsigned long iflags
;
1162 sfp
= filp
->private_data
;
1165 sdp
= sfp
->parentdp
;
1168 poll_wait(filp
, &sfp
->read_wait
, wait
);
1169 read_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
1170 for (srp
= sfp
->headrp
; srp
; srp
= srp
->nextrp
) {
1171 /* if any read waiting, flag it */
1172 if ((0 == res
) && (1 == srp
->done
) && (!srp
->sg_io_owned
))
1173 res
= POLLIN
| POLLRDNORM
;
1176 read_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
1180 else if (!sfp
->cmd_q
) {
1182 res
|= POLLOUT
| POLLWRNORM
;
1183 } else if (count
< SG_MAX_QUEUE
)
1184 res
|= POLLOUT
| POLLWRNORM
;
1185 SCSI_LOG_TIMEOUT(3, printk("sg_poll: %s, res=0x%x\n",
1186 sdp
->disk
->disk_name
, (int) res
));
1191 sg_fasync(int fd
, struct file
*filp
, int mode
)
1196 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
1198 SCSI_LOG_TIMEOUT(3, printk("sg_fasync: %s, mode=%d\n",
1199 sdp
->disk
->disk_name
, mode
));
1201 return fasync_helper(fd
, filp
, mode
, &sfp
->async_qp
);
1205 sg_vma_fault(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
1208 unsigned long offset
, len
, sa
;
1209 Sg_scatter_hold
*rsv_schp
;
1212 if ((NULL
== vma
) || (!(sfp
= (Sg_fd
*) vma
->vm_private_data
)))
1213 return VM_FAULT_SIGBUS
;
1214 rsv_schp
= &sfp
->reserve
;
1215 offset
= vmf
->pgoff
<< PAGE_SHIFT
;
1216 if (offset
>= rsv_schp
->bufflen
)
1217 return VM_FAULT_SIGBUS
;
1218 SCSI_LOG_TIMEOUT(3, printk("sg_vma_fault: offset=%lu, scatg=%d\n",
1219 offset
, rsv_schp
->k_use_sg
));
1221 length
= 1 << (PAGE_SHIFT
+ rsv_schp
->page_order
);
1222 for (k
= 0; k
< rsv_schp
->k_use_sg
&& sa
< vma
->vm_end
; k
++) {
1223 len
= vma
->vm_end
- sa
;
1224 len
= (len
< length
) ? len
: length
;
1226 struct page
*page
= nth_page(rsv_schp
->pages
[k
],
1227 offset
>> PAGE_SHIFT
);
1228 get_page(page
); /* increment page count */
1230 return 0; /* success */
1236 return VM_FAULT_SIGBUS
;
1239 static const struct vm_operations_struct sg_mmap_vm_ops
= {
1240 .fault
= sg_vma_fault
,
1244 sg_mmap(struct file
*filp
, struct vm_area_struct
*vma
)
1247 unsigned long req_sz
, len
, sa
;
1248 Sg_scatter_hold
*rsv_schp
;
1251 if ((!filp
) || (!vma
) || (!(sfp
= (Sg_fd
*) filp
->private_data
)))
1253 req_sz
= vma
->vm_end
- vma
->vm_start
;
1254 SCSI_LOG_TIMEOUT(3, printk("sg_mmap starting, vm_start=%p, len=%d\n",
1255 (void *) vma
->vm_start
, (int) req_sz
));
1257 return -EINVAL
; /* want no offset */
1258 rsv_schp
= &sfp
->reserve
;
1259 if (req_sz
> rsv_schp
->bufflen
)
1260 return -ENOMEM
; /* cannot map more than reserved buffer */
1263 length
= 1 << (PAGE_SHIFT
+ rsv_schp
->page_order
);
1264 for (k
= 0; k
< rsv_schp
->k_use_sg
&& sa
< vma
->vm_end
; k
++) {
1265 len
= vma
->vm_end
- sa
;
1266 len
= (len
< length
) ? len
: length
;
1270 sfp
->mmap_called
= 1;
1271 vma
->vm_flags
|= VM_IO
| VM_DONTEXPAND
| VM_DONTDUMP
;
1272 vma
->vm_private_data
= sfp
;
1273 vma
->vm_ops
= &sg_mmap_vm_ops
;
1277 static void sg_rq_end_io_usercontext(struct work_struct
*work
)
1279 struct sg_request
*srp
= container_of(work
, struct sg_request
, ew
.work
);
1280 struct sg_fd
*sfp
= srp
->parentfp
;
1282 sg_finish_rem_req(srp
);
1283 kref_put(&sfp
->f_ref
, sg_remove_sfp
);
1287 * This function is a "bottom half" handler that is called by the mid
1288 * level when a command is completed (or has failed).
1290 static void sg_rq_end_io(struct request
*rq
, int uptodate
)
1292 struct sg_request
*srp
= rq
->end_io_data
;
1295 unsigned long iflags
;
1298 int result
, resid
, done
= 1;
1300 if (WARN_ON(srp
->done
!= 0))
1303 sfp
= srp
->parentfp
;
1304 if (WARN_ON(sfp
== NULL
))
1307 sdp
= sfp
->parentdp
;
1308 if (unlikely(sdp
->detached
))
1309 printk(KERN_INFO
"sg_rq_end_io: device detached\n");
1312 result
= rq
->errors
;
1313 resid
= rq
->resid_len
;
1315 SCSI_LOG_TIMEOUT(4, printk("sg_cmd_done: %s, pack_id=%d, res=0x%x\n",
1316 sdp
->disk
->disk_name
, srp
->header
.pack_id
, result
));
1317 srp
->header
.resid
= resid
;
1318 ms
= jiffies_to_msecs(jiffies
);
1319 srp
->header
.duration
= (ms
> srp
->header
.duration
) ?
1320 (ms
- srp
->header
.duration
) : 0;
1322 struct scsi_sense_hdr sshdr
;
1324 srp
->header
.status
= 0xff & result
;
1325 srp
->header
.masked_status
= status_byte(result
);
1326 srp
->header
.msg_status
= msg_byte(result
);
1327 srp
->header
.host_status
= host_byte(result
);
1328 srp
->header
.driver_status
= driver_byte(result
);
1329 if ((sdp
->sgdebug
> 0) &&
1330 ((CHECK_CONDITION
== srp
->header
.masked_status
) ||
1331 (COMMAND_TERMINATED
== srp
->header
.masked_status
)))
1332 __scsi_print_sense("sg_cmd_done", sense
,
1333 SCSI_SENSE_BUFFERSIZE
);
1335 /* Following if statement is a patch supplied by Eric Youngdale */
1336 if (driver_byte(result
) != 0
1337 && scsi_normalize_sense(sense
, SCSI_SENSE_BUFFERSIZE
, &sshdr
)
1338 && !scsi_sense_is_deferred(&sshdr
)
1339 && sshdr
.sense_key
== UNIT_ATTENTION
1340 && sdp
->device
->removable
) {
1341 /* Detected possible disc change. Set the bit - this */
1342 /* may be used if there are filesystems using this device */
1343 sdp
->device
->changed
= 1;
1346 /* Rely on write phase to clean out srp status values, so no "else" */
1348 write_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
1349 if (unlikely(srp
->orphan
)) {
1350 if (sfp
->keep_orphan
)
1351 srp
->sg_io_owned
= 0;
1356 write_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
1359 /* Now wake up any sg_read() that is waiting for this
1362 wake_up_interruptible(&sfp
->read_wait
);
1363 kill_fasync(&sfp
->async_qp
, SIGPOLL
, POLL_IN
);
1364 kref_put(&sfp
->f_ref
, sg_remove_sfp
);
1366 INIT_WORK(&srp
->ew
.work
, sg_rq_end_io_usercontext
);
1367 schedule_work(&srp
->ew
.work
);
1371 static const struct file_operations sg_fops
= {
1372 .owner
= THIS_MODULE
,
1376 .unlocked_ioctl
= sg_ioctl
,
1377 #ifdef CONFIG_COMPAT
1378 .compat_ioctl
= sg_compat_ioctl
,
1382 .release
= sg_release
,
1383 .fasync
= sg_fasync
,
1384 .llseek
= no_llseek
,
1387 static struct class *sg_sysfs_class
;
1389 static int sg_sysfs_valid
= 0;
1391 static Sg_device
*sg_alloc(struct gendisk
*disk
, struct scsi_device
*scsidp
)
1393 struct request_queue
*q
= scsidp
->request_queue
;
1395 unsigned long iflags
;
1399 sdp
= kzalloc(sizeof(Sg_device
), GFP_KERNEL
);
1401 printk(KERN_WARNING
"kmalloc Sg_device failure\n");
1402 return ERR_PTR(-ENOMEM
);
1405 idr_preload(GFP_KERNEL
);
1406 write_lock_irqsave(&sg_index_lock
, iflags
);
1408 error
= idr_alloc(&sg_index_idr
, sdp
, 0, SG_MAX_DEVS
, GFP_NOWAIT
);
1410 if (error
== -ENOSPC
) {
1411 sdev_printk(KERN_WARNING
, scsidp
,
1412 "Unable to attach sg device type=%d, minor number exceeds %d\n",
1413 scsidp
->type
, SG_MAX_DEVS
- 1);
1417 "idr allocation Sg_device failure: %d\n", error
);
1423 SCSI_LOG_TIMEOUT(3, printk("sg_alloc: dev=%d \n", k
));
1424 sprintf(disk
->disk_name
, "sg%d", k
);
1425 disk
->first_minor
= k
;
1427 sdp
->device
= scsidp
;
1428 INIT_LIST_HEAD(&sdp
->sfds
);
1429 init_waitqueue_head(&sdp
->o_excl_wait
);
1430 sdp
->sg_tablesize
= queue_max_segments(q
);
1432 kref_init(&sdp
->d_ref
);
1436 write_unlock_irqrestore(&sg_index_lock
, iflags
);
1441 return ERR_PTR(error
);
1447 sg_add(struct device
*cl_dev
, struct class_interface
*cl_intf
)
1449 struct scsi_device
*scsidp
= to_scsi_device(cl_dev
->parent
);
1450 struct gendisk
*disk
;
1451 Sg_device
*sdp
= NULL
;
1452 struct cdev
* cdev
= NULL
;
1454 unsigned long iflags
;
1456 disk
= alloc_disk(1);
1458 printk(KERN_WARNING
"alloc_disk failed\n");
1461 disk
->major
= SCSI_GENERIC_MAJOR
;
1464 cdev
= cdev_alloc();
1466 printk(KERN_WARNING
"cdev_alloc failed\n");
1469 cdev
->owner
= THIS_MODULE
;
1470 cdev
->ops
= &sg_fops
;
1472 sdp
= sg_alloc(disk
, scsidp
);
1474 printk(KERN_WARNING
"sg_alloc failed\n");
1475 error
= PTR_ERR(sdp
);
1479 error
= cdev_add(cdev
, MKDEV(SCSI_GENERIC_MAJOR
, sdp
->index
), 1);
1484 if (sg_sysfs_valid
) {
1485 struct device
*sg_class_member
;
1487 sg_class_member
= device_create(sg_sysfs_class
, cl_dev
->parent
,
1488 MKDEV(SCSI_GENERIC_MAJOR
,
1490 sdp
, "%s", disk
->disk_name
);
1491 if (IS_ERR(sg_class_member
)) {
1492 printk(KERN_ERR
"sg_add: "
1493 "device_create failed\n");
1494 error
= PTR_ERR(sg_class_member
);
1497 error
= sysfs_create_link(&scsidp
->sdev_gendev
.kobj
,
1498 &sg_class_member
->kobj
, "generic");
1500 printk(KERN_ERR
"sg_add: unable to make symlink "
1501 "'generic' back to sg%d\n", sdp
->index
);
1503 printk(KERN_WARNING
"sg_add: sg_sys Invalid\n");
1505 sdev_printk(KERN_NOTICE
, scsidp
,
1506 "Attached scsi generic sg%d type %d\n", sdp
->index
,
1509 dev_set_drvdata(cl_dev
, sdp
);
1514 write_lock_irqsave(&sg_index_lock
, iflags
);
1515 idr_remove(&sg_index_idr
, sdp
->index
);
1516 write_unlock_irqrestore(&sg_index_lock
, iflags
);
1526 static void sg_device_destroy(struct kref
*kref
)
1528 struct sg_device
*sdp
= container_of(kref
, struct sg_device
, d_ref
);
1529 unsigned long flags
;
1531 /* CAUTION! Note that the device can still be found via idr_find()
1532 * even though the refcount is 0. Therefore, do idr_remove() BEFORE
1533 * any other cleanup.
1536 write_lock_irqsave(&sg_index_lock
, flags
);
1537 idr_remove(&sg_index_idr
, sdp
->index
);
1538 write_unlock_irqrestore(&sg_index_lock
, flags
);
1541 printk("sg_device_destroy: %s\n",
1542 sdp
->disk
->disk_name
));
1544 put_disk(sdp
->disk
);
1548 static void sg_remove(struct device
*cl_dev
, struct class_interface
*cl_intf
)
1550 struct scsi_device
*scsidp
= to_scsi_device(cl_dev
->parent
);
1551 Sg_device
*sdp
= dev_get_drvdata(cl_dev
);
1552 unsigned long iflags
;
1555 if (!sdp
|| sdp
->detached
)
1558 SCSI_LOG_TIMEOUT(3, printk("sg_remove: %s\n", sdp
->disk
->disk_name
));
1560 /* Need a write lock to set sdp->detached. */
1561 write_lock_irqsave(&sg_index_lock
, iflags
);
1563 list_for_each_entry(sfp
, &sdp
->sfds
, sfd_siblings
) {
1564 wake_up_interruptible(&sfp
->read_wait
);
1565 kill_fasync(&sfp
->async_qp
, SIGPOLL
, POLL_HUP
);
1567 write_unlock_irqrestore(&sg_index_lock
, iflags
);
1569 sysfs_remove_link(&scsidp
->sdev_gendev
.kobj
, "generic");
1570 device_destroy(sg_sysfs_class
, MKDEV(SCSI_GENERIC_MAJOR
, sdp
->index
));
1571 cdev_del(sdp
->cdev
);
1577 module_param_named(scatter_elem_sz
, scatter_elem_sz
, int, S_IRUGO
| S_IWUSR
);
1578 module_param_named(def_reserved_size
, def_reserved_size
, int,
1580 module_param_named(allow_dio
, sg_allow_dio
, int, S_IRUGO
| S_IWUSR
);
1582 MODULE_AUTHOR("Douglas Gilbert");
1583 MODULE_DESCRIPTION("SCSI generic (sg) driver");
1584 MODULE_LICENSE("GPL");
1585 MODULE_VERSION(SG_VERSION_STR
);
1586 MODULE_ALIAS_CHARDEV_MAJOR(SCSI_GENERIC_MAJOR
);
1588 MODULE_PARM_DESC(scatter_elem_sz
, "scatter gather element "
1589 "size (default: max(SG_SCATTER_SZ, PAGE_SIZE))");
1590 MODULE_PARM_DESC(def_reserved_size
, "size of buffer reserved for each fd");
1591 MODULE_PARM_DESC(allow_dio
, "allow direct I/O (default: 0 (disallow))");
1598 if (scatter_elem_sz
< PAGE_SIZE
) {
1599 scatter_elem_sz
= PAGE_SIZE
;
1600 scatter_elem_sz_prev
= scatter_elem_sz
;
1602 if (def_reserved_size
>= 0)
1603 sg_big_buff
= def_reserved_size
;
1605 def_reserved_size
= sg_big_buff
;
1607 rc
= register_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR
, 0),
1611 sg_sysfs_class
= class_create(THIS_MODULE
, "scsi_generic");
1612 if ( IS_ERR(sg_sysfs_class
) ) {
1613 rc
= PTR_ERR(sg_sysfs_class
);
1617 rc
= scsi_register_interface(&sg_interface
);
1619 #ifdef CONFIG_SCSI_PROC_FS
1621 #endif /* CONFIG_SCSI_PROC_FS */
1624 class_destroy(sg_sysfs_class
);
1626 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR
, 0), SG_MAX_DEVS
);
1633 #ifdef CONFIG_SCSI_PROC_FS
1635 #endif /* CONFIG_SCSI_PROC_FS */
1636 scsi_unregister_interface(&sg_interface
);
1637 class_destroy(sg_sysfs_class
);
1639 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR
, 0),
1641 idr_destroy(&sg_index_idr
);
1644 static int sg_start_req(Sg_request
*srp
, unsigned char *cmd
)
1648 Sg_fd
*sfp
= srp
->parentfp
;
1649 sg_io_hdr_t
*hp
= &srp
->header
;
1650 int dxfer_len
= (int) hp
->dxfer_len
;
1651 int dxfer_dir
= hp
->dxfer_direction
;
1652 unsigned int iov_count
= hp
->iovec_count
;
1653 Sg_scatter_hold
*req_schp
= &srp
->data
;
1654 Sg_scatter_hold
*rsv_schp
= &sfp
->reserve
;
1655 struct request_queue
*q
= sfp
->parentdp
->device
->request_queue
;
1656 struct rq_map_data
*md
, map_data
;
1657 int rw
= hp
->dxfer_direction
== SG_DXFER_TO_DEV
? WRITE
: READ
;
1659 SCSI_LOG_TIMEOUT(4, printk(KERN_INFO
"sg_start_req: dxfer_len=%d\n",
1662 rq
= blk_get_request(q
, rw
, GFP_ATOMIC
);
1666 memcpy(rq
->cmd
, cmd
, hp
->cmd_len
);
1668 rq
->cmd_len
= hp
->cmd_len
;
1669 rq
->cmd_type
= REQ_TYPE_BLOCK_PC
;
1672 rq
->end_io_data
= srp
;
1673 rq
->sense
= srp
->sense_b
;
1674 rq
->retries
= SG_DEFAULT_RETRIES
;
1676 if ((dxfer_len
<= 0) || (dxfer_dir
== SG_DXFER_NONE
))
1679 if (sg_allow_dio
&& hp
->flags
& SG_FLAG_DIRECT_IO
&&
1680 dxfer_dir
!= SG_DXFER_UNKNOWN
&& !iov_count
&&
1681 !sfp
->parentdp
->device
->host
->unchecked_isa_dma
&&
1682 blk_rq_aligned(q
, (unsigned long)hp
->dxferp
, dxfer_len
))
1688 if (!sg_res_in_use(sfp
) && dxfer_len
<= rsv_schp
->bufflen
)
1689 sg_link_reserve(sfp
, srp
, dxfer_len
);
1691 res
= sg_build_indirect(req_schp
, sfp
, dxfer_len
);
1696 md
->pages
= req_schp
->pages
;
1697 md
->page_order
= req_schp
->page_order
;
1698 md
->nr_entries
= req_schp
->k_use_sg
;
1700 md
->null_mapped
= hp
->dxferp
? 0 : 1;
1701 if (dxfer_dir
== SG_DXFER_TO_FROM_DEV
)
1707 if (unlikely(iov_count
> UIO_MAXIOV
))
1711 int len
, size
= sizeof(struct sg_iovec
) * iov_count
;
1714 iov
= memdup_user(hp
->dxferp
, size
);
1716 return PTR_ERR(iov
);
1718 len
= iov_length(iov
, iov_count
);
1719 if (hp
->dxfer_len
< len
) {
1720 iov_count
= iov_shorten(iov
, iov_count
, hp
->dxfer_len
);
1721 len
= hp
->dxfer_len
;
1724 res
= blk_rq_map_user_iov(q
, rq
, md
, (struct sg_iovec
*)iov
,
1729 res
= blk_rq_map_user(q
, rq
, md
, hp
->dxferp
,
1730 hp
->dxfer_len
, GFP_ATOMIC
);
1736 req_schp
->dio_in_use
= 1;
1737 hp
->info
|= SG_INFO_DIRECT_IO
;
1743 static int sg_finish_rem_req(Sg_request
* srp
)
1747 Sg_fd
*sfp
= srp
->parentfp
;
1748 Sg_scatter_hold
*req_schp
= &srp
->data
;
1750 SCSI_LOG_TIMEOUT(4, printk("sg_finish_rem_req: res_used=%d\n", (int) srp
->res_used
));
1753 ret
= blk_rq_unmap_user(srp
->bio
);
1755 blk_put_request(srp
->rq
);
1759 sg_unlink_reserve(sfp
, srp
);
1761 sg_remove_scat(req_schp
);
1763 sg_remove_request(sfp
, srp
);
1769 sg_build_sgat(Sg_scatter_hold
* schp
, const Sg_fd
* sfp
, int tablesize
)
1771 int sg_bufflen
= tablesize
* sizeof(struct page
*);
1772 gfp_t gfp_flags
= GFP_ATOMIC
| __GFP_NOWARN
;
1774 schp
->pages
= kzalloc(sg_bufflen
, gfp_flags
);
1777 schp
->sglist_len
= sg_bufflen
;
1778 return tablesize
; /* number of scat_gath elements allocated */
1782 sg_build_indirect(Sg_scatter_hold
* schp
, Sg_fd
* sfp
, int buff_size
)
1784 int ret_sz
= 0, i
, k
, rem_sz
, num
, mx_sc_elems
;
1785 int sg_tablesize
= sfp
->parentdp
->sg_tablesize
;
1786 int blk_size
= buff_size
, order
;
1787 gfp_t gfp_mask
= GFP_ATOMIC
| __GFP_COMP
| __GFP_NOWARN
;
1792 ++blk_size
; /* don't know why */
1793 /* round request up to next highest SG_SECTOR_SZ byte boundary */
1794 blk_size
= ALIGN(blk_size
, SG_SECTOR_SZ
);
1795 SCSI_LOG_TIMEOUT(4, printk("sg_build_indirect: buff_size=%d, blk_size=%d\n",
1796 buff_size
, blk_size
));
1798 /* N.B. ret_sz carried into this block ... */
1799 mx_sc_elems
= sg_build_sgat(schp
, sfp
, sg_tablesize
);
1800 if (mx_sc_elems
< 0)
1801 return mx_sc_elems
; /* most likely -ENOMEM */
1803 num
= scatter_elem_sz
;
1804 if (unlikely(num
!= scatter_elem_sz_prev
)) {
1805 if (num
< PAGE_SIZE
) {
1806 scatter_elem_sz
= PAGE_SIZE
;
1807 scatter_elem_sz_prev
= PAGE_SIZE
;
1809 scatter_elem_sz_prev
= num
;
1813 gfp_mask
|= GFP_DMA
;
1815 if (!capable(CAP_SYS_ADMIN
) || !capable(CAP_SYS_RAWIO
))
1816 gfp_mask
|= __GFP_ZERO
;
1818 order
= get_order(num
);
1820 ret_sz
= 1 << (PAGE_SHIFT
+ order
);
1822 for (k
= 0, rem_sz
= blk_size
; rem_sz
> 0 && k
< mx_sc_elems
;
1823 k
++, rem_sz
-= ret_sz
) {
1825 num
= (rem_sz
> scatter_elem_sz_prev
) ?
1826 scatter_elem_sz_prev
: rem_sz
;
1828 schp
->pages
[k
] = alloc_pages(gfp_mask
, order
);
1829 if (!schp
->pages
[k
])
1832 if (num
== scatter_elem_sz_prev
) {
1833 if (unlikely(ret_sz
> scatter_elem_sz_prev
)) {
1834 scatter_elem_sz
= ret_sz
;
1835 scatter_elem_sz_prev
= ret_sz
;
1839 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k=%d, num=%d, "
1840 "ret_sz=%d\n", k
, num
, ret_sz
));
1841 } /* end of for loop */
1843 schp
->page_order
= order
;
1845 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k_use_sg=%d, "
1846 "rem_sz=%d\n", k
, rem_sz
));
1848 schp
->bufflen
= blk_size
;
1849 if (rem_sz
> 0) /* must have failed */
1853 for (i
= 0; i
< k
; i
++)
1854 __free_pages(schp
->pages
[i
], order
);
1863 sg_remove_scat(Sg_scatter_hold
* schp
)
1865 SCSI_LOG_TIMEOUT(4, printk("sg_remove_scat: k_use_sg=%d\n", schp
->k_use_sg
));
1866 if (schp
->pages
&& schp
->sglist_len
> 0) {
1867 if (!schp
->dio_in_use
) {
1870 for (k
= 0; k
< schp
->k_use_sg
&& schp
->pages
[k
]; k
++) {
1871 SCSI_LOG_TIMEOUT(5, printk(
1872 "sg_remove_scat: k=%d, pg=0x%p\n",
1873 k
, schp
->pages
[k
]));
1874 __free_pages(schp
->pages
[k
], schp
->page_order
);
1880 memset(schp
, 0, sizeof (*schp
));
1884 sg_read_oxfer(Sg_request
* srp
, char __user
*outp
, int num_read_xfer
)
1886 Sg_scatter_hold
*schp
= &srp
->data
;
1889 SCSI_LOG_TIMEOUT(4, printk("sg_read_oxfer: num_read_xfer=%d\n",
1891 if ((!outp
) || (num_read_xfer
<= 0))
1894 num
= 1 << (PAGE_SHIFT
+ schp
->page_order
);
1895 for (k
= 0; k
< schp
->k_use_sg
&& schp
->pages
[k
]; k
++) {
1896 if (num
> num_read_xfer
) {
1897 if (__copy_to_user(outp
, page_address(schp
->pages
[k
]),
1902 if (__copy_to_user(outp
, page_address(schp
->pages
[k
]),
1905 num_read_xfer
-= num
;
1906 if (num_read_xfer
<= 0)
1916 sg_build_reserve(Sg_fd
* sfp
, int req_size
)
1918 Sg_scatter_hold
*schp
= &sfp
->reserve
;
1920 SCSI_LOG_TIMEOUT(4, printk("sg_build_reserve: req_size=%d\n", req_size
));
1922 if (req_size
< PAGE_SIZE
)
1923 req_size
= PAGE_SIZE
;
1924 if (0 == sg_build_indirect(schp
, sfp
, req_size
))
1927 sg_remove_scat(schp
);
1928 req_size
>>= 1; /* divide by 2 */
1929 } while (req_size
> (PAGE_SIZE
/ 2));
1933 sg_link_reserve(Sg_fd
* sfp
, Sg_request
* srp
, int size
)
1935 Sg_scatter_hold
*req_schp
= &srp
->data
;
1936 Sg_scatter_hold
*rsv_schp
= &sfp
->reserve
;
1940 SCSI_LOG_TIMEOUT(4, printk("sg_link_reserve: size=%d\n", size
));
1943 num
= 1 << (PAGE_SHIFT
+ rsv_schp
->page_order
);
1944 for (k
= 0; k
< rsv_schp
->k_use_sg
; k
++) {
1946 req_schp
->k_use_sg
= k
+ 1;
1947 req_schp
->sglist_len
= rsv_schp
->sglist_len
;
1948 req_schp
->pages
= rsv_schp
->pages
;
1950 req_schp
->bufflen
= size
;
1951 req_schp
->page_order
= rsv_schp
->page_order
;
1957 if (k
>= rsv_schp
->k_use_sg
)
1958 SCSI_LOG_TIMEOUT(1, printk("sg_link_reserve: BAD size\n"));
1962 sg_unlink_reserve(Sg_fd
* sfp
, Sg_request
* srp
)
1964 Sg_scatter_hold
*req_schp
= &srp
->data
;
1966 SCSI_LOG_TIMEOUT(4, printk("sg_unlink_reserve: req->k_use_sg=%d\n",
1967 (int) req_schp
->k_use_sg
));
1968 req_schp
->k_use_sg
= 0;
1969 req_schp
->bufflen
= 0;
1970 req_schp
->pages
= NULL
;
1971 req_schp
->page_order
= 0;
1972 req_schp
->sglist_len
= 0;
1973 sfp
->save_scat_len
= 0;
1978 sg_get_rq_mark(Sg_fd
* sfp
, int pack_id
)
1981 unsigned long iflags
;
1983 write_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
1984 for (resp
= sfp
->headrp
; resp
; resp
= resp
->nextrp
) {
1985 /* look for requests that are ready + not SG_IO owned */
1986 if ((1 == resp
->done
) && (!resp
->sg_io_owned
) &&
1987 ((-1 == pack_id
) || (resp
->header
.pack_id
== pack_id
))) {
1988 resp
->done
= 2; /* guard against other readers */
1992 write_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
1996 /* always adds to end of list */
1998 sg_add_request(Sg_fd
* sfp
)
2001 unsigned long iflags
;
2003 Sg_request
*rp
= sfp
->req_arr
;
2005 write_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
2008 memset(rp
, 0, sizeof (Sg_request
));
2013 if (0 == sfp
->cmd_q
)
2014 resp
= NULL
; /* command queuing disallowed */
2016 for (k
= 0; k
< SG_MAX_QUEUE
; ++k
, ++rp
) {
2020 if (k
< SG_MAX_QUEUE
) {
2021 memset(rp
, 0, sizeof (Sg_request
));
2023 while (resp
->nextrp
)
2024 resp
= resp
->nextrp
;
2032 resp
->nextrp
= NULL
;
2033 resp
->header
.duration
= jiffies_to_msecs(jiffies
);
2035 write_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
2039 /* Return of 1 for found; 0 for not found */
2041 sg_remove_request(Sg_fd
* sfp
, Sg_request
* srp
)
2043 Sg_request
*prev_rp
;
2045 unsigned long iflags
;
2048 if ((!sfp
) || (!srp
) || (!sfp
->headrp
))
2050 write_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
2051 prev_rp
= sfp
->headrp
;
2052 if (srp
== prev_rp
) {
2053 sfp
->headrp
= prev_rp
->nextrp
;
2054 prev_rp
->parentfp
= NULL
;
2057 while ((rp
= prev_rp
->nextrp
)) {
2059 prev_rp
->nextrp
= rp
->nextrp
;
2060 rp
->parentfp
= NULL
;
2067 write_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
2072 sg_add_sfp(Sg_device
* sdp
, int dev
)
2075 unsigned long iflags
;
2078 sfp
= kzalloc(sizeof(*sfp
), GFP_ATOMIC
| __GFP_NOWARN
);
2082 init_waitqueue_head(&sfp
->read_wait
);
2083 rwlock_init(&sfp
->rq_list_lock
);
2085 kref_init(&sfp
->f_ref
);
2086 sfp
->timeout
= SG_DEFAULT_TIMEOUT
;
2087 sfp
->timeout_user
= SG_DEFAULT_TIMEOUT_USER
;
2088 sfp
->force_packid
= SG_DEF_FORCE_PACK_ID
;
2089 sfp
->low_dma
= (SG_DEF_FORCE_LOW_DMA
== 0) ?
2090 sdp
->device
->host
->unchecked_isa_dma
: 1;
2091 sfp
->cmd_q
= SG_DEF_COMMAND_Q
;
2092 sfp
->keep_orphan
= SG_DEF_KEEP_ORPHAN
;
2093 sfp
->parentdp
= sdp
;
2094 write_lock_irqsave(&sg_index_lock
, iflags
);
2095 list_add_tail(&sfp
->sfd_siblings
, &sdp
->sfds
);
2096 write_unlock_irqrestore(&sg_index_lock
, iflags
);
2097 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: sfp=0x%p\n", sfp
));
2098 if (unlikely(sg_big_buff
!= def_reserved_size
))
2099 sg_big_buff
= def_reserved_size
;
2101 bufflen
= min_t(int, sg_big_buff
,
2102 queue_max_sectors(sdp
->device
->request_queue
) * 512);
2103 sg_build_reserve(sfp
, bufflen
);
2104 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: bufflen=%d, k_use_sg=%d\n",
2105 sfp
->reserve
.bufflen
, sfp
->reserve
.k_use_sg
));
2107 kref_get(&sdp
->d_ref
);
2108 __module_get(THIS_MODULE
);
2112 static void sg_remove_sfp_usercontext(struct work_struct
*work
)
2114 struct sg_fd
*sfp
= container_of(work
, struct sg_fd
, ew
.work
);
2115 struct sg_device
*sdp
= sfp
->parentdp
;
2117 /* Cleanup any responses which were never read(). */
2119 sg_finish_rem_req(sfp
->headrp
);
2121 if (sfp
->reserve
.bufflen
> 0) {
2123 printk("sg_remove_sfp: bufflen=%d, k_use_sg=%d\n",
2124 (int) sfp
->reserve
.bufflen
,
2125 (int) sfp
->reserve
.k_use_sg
));
2126 sg_remove_scat(&sfp
->reserve
);
2130 printk("sg_remove_sfp: %s, sfp=0x%p\n",
2131 sdp
->disk
->disk_name
,
2135 scsi_device_put(sdp
->device
);
2137 module_put(THIS_MODULE
);
2140 static void sg_remove_sfp(struct kref
*kref
)
2142 struct sg_fd
*sfp
= container_of(kref
, struct sg_fd
, f_ref
);
2143 struct sg_device
*sdp
= sfp
->parentdp
;
2144 unsigned long iflags
;
2146 write_lock_irqsave(&sg_index_lock
, iflags
);
2147 list_del(&sfp
->sfd_siblings
);
2148 write_unlock_irqrestore(&sg_index_lock
, iflags
);
2149 wake_up_interruptible(&sdp
->o_excl_wait
);
2151 INIT_WORK(&sfp
->ew
.work
, sg_remove_sfp_usercontext
);
2152 schedule_work(&sfp
->ew
.work
);
2156 sg_res_in_use(Sg_fd
* sfp
)
2158 const Sg_request
*srp
;
2159 unsigned long iflags
;
2161 read_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
2162 for (srp
= sfp
->headrp
; srp
; srp
= srp
->nextrp
)
2165 read_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
2169 #ifdef CONFIG_SCSI_PROC_FS
2171 sg_idr_max_id(int id
, void *p
, void *data
)
2185 unsigned long iflags
;
2187 read_lock_irqsave(&sg_index_lock
, iflags
);
2188 idr_for_each(&sg_index_idr
, sg_idr_max_id
, &k
);
2189 read_unlock_irqrestore(&sg_index_lock
, iflags
);
2190 return k
+ 1; /* origin 1 */
2194 /* must be called with sg_index_lock held */
2195 static Sg_device
*sg_lookup_dev(int dev
)
2197 return idr_find(&sg_index_idr
, dev
);
2200 static Sg_device
*sg_get_dev(int dev
)
2202 struct sg_device
*sdp
;
2203 unsigned long flags
;
2205 read_lock_irqsave(&sg_index_lock
, flags
);
2206 sdp
= sg_lookup_dev(dev
);
2208 sdp
= ERR_PTR(-ENXIO
);
2209 else if (sdp
->detached
) {
2210 /* If sdp->detached, then the refcount may already be 0, in
2211 * which case it would be a bug to do kref_get().
2213 sdp
= ERR_PTR(-ENODEV
);
2215 kref_get(&sdp
->d_ref
);
2216 read_unlock_irqrestore(&sg_index_lock
, flags
);
2221 static void sg_put_dev(struct sg_device
*sdp
)
2223 kref_put(&sdp
->d_ref
, sg_device_destroy
);
2226 #ifdef CONFIG_SCSI_PROC_FS
2228 static struct proc_dir_entry
*sg_proc_sgp
= NULL
;
2230 static char sg_proc_sg_dirname
[] = "scsi/sg";
2232 static int sg_proc_seq_show_int(struct seq_file
*s
, void *v
);
2234 static int sg_proc_single_open_adio(struct inode
*inode
, struct file
*file
);
2235 static ssize_t
sg_proc_write_adio(struct file
*filp
, const char __user
*buffer
,
2236 size_t count
, loff_t
*off
);
2237 static const struct file_operations adio_fops
= {
2238 .owner
= THIS_MODULE
,
2239 .open
= sg_proc_single_open_adio
,
2241 .llseek
= seq_lseek
,
2242 .write
= sg_proc_write_adio
,
2243 .release
= single_release
,
2246 static int sg_proc_single_open_dressz(struct inode
*inode
, struct file
*file
);
2247 static ssize_t
sg_proc_write_dressz(struct file
*filp
,
2248 const char __user
*buffer
, size_t count
, loff_t
*off
);
2249 static const struct file_operations dressz_fops
= {
2250 .owner
= THIS_MODULE
,
2251 .open
= sg_proc_single_open_dressz
,
2253 .llseek
= seq_lseek
,
2254 .write
= sg_proc_write_dressz
,
2255 .release
= single_release
,
2258 static int sg_proc_seq_show_version(struct seq_file
*s
, void *v
);
2259 static int sg_proc_single_open_version(struct inode
*inode
, struct file
*file
);
2260 static const struct file_operations version_fops
= {
2261 .owner
= THIS_MODULE
,
2262 .open
= sg_proc_single_open_version
,
2264 .llseek
= seq_lseek
,
2265 .release
= single_release
,
2268 static int sg_proc_seq_show_devhdr(struct seq_file
*s
, void *v
);
2269 static int sg_proc_single_open_devhdr(struct inode
*inode
, struct file
*file
);
2270 static const struct file_operations devhdr_fops
= {
2271 .owner
= THIS_MODULE
,
2272 .open
= sg_proc_single_open_devhdr
,
2274 .llseek
= seq_lseek
,
2275 .release
= single_release
,
2278 static int sg_proc_seq_show_dev(struct seq_file
*s
, void *v
);
2279 static int sg_proc_open_dev(struct inode
*inode
, struct file
*file
);
2280 static void * dev_seq_start(struct seq_file
*s
, loff_t
*pos
);
2281 static void * dev_seq_next(struct seq_file
*s
, void *v
, loff_t
*pos
);
2282 static void dev_seq_stop(struct seq_file
*s
, void *v
);
2283 static const struct file_operations dev_fops
= {
2284 .owner
= THIS_MODULE
,
2285 .open
= sg_proc_open_dev
,
2287 .llseek
= seq_lseek
,
2288 .release
= seq_release
,
2290 static const struct seq_operations dev_seq_ops
= {
2291 .start
= dev_seq_start
,
2292 .next
= dev_seq_next
,
2293 .stop
= dev_seq_stop
,
2294 .show
= sg_proc_seq_show_dev
,
2297 static int sg_proc_seq_show_devstrs(struct seq_file
*s
, void *v
);
2298 static int sg_proc_open_devstrs(struct inode
*inode
, struct file
*file
);
2299 static const struct file_operations devstrs_fops
= {
2300 .owner
= THIS_MODULE
,
2301 .open
= sg_proc_open_devstrs
,
2303 .llseek
= seq_lseek
,
2304 .release
= seq_release
,
2306 static const struct seq_operations devstrs_seq_ops
= {
2307 .start
= dev_seq_start
,
2308 .next
= dev_seq_next
,
2309 .stop
= dev_seq_stop
,
2310 .show
= sg_proc_seq_show_devstrs
,
2313 static int sg_proc_seq_show_debug(struct seq_file
*s
, void *v
);
2314 static int sg_proc_open_debug(struct inode
*inode
, struct file
*file
);
2315 static const struct file_operations debug_fops
= {
2316 .owner
= THIS_MODULE
,
2317 .open
= sg_proc_open_debug
,
2319 .llseek
= seq_lseek
,
2320 .release
= seq_release
,
2322 static const struct seq_operations debug_seq_ops
= {
2323 .start
= dev_seq_start
,
2324 .next
= dev_seq_next
,
2325 .stop
= dev_seq_stop
,
2326 .show
= sg_proc_seq_show_debug
,
2330 struct sg_proc_leaf
{
2332 const struct file_operations
* fops
;
2335 static const struct sg_proc_leaf sg_proc_leaf_arr
[] = {
2336 {"allow_dio", &adio_fops
},
2337 {"debug", &debug_fops
},
2338 {"def_reserved_size", &dressz_fops
},
2339 {"device_hdr", &devhdr_fops
},
2340 {"devices", &dev_fops
},
2341 {"device_strs", &devstrs_fops
},
2342 {"version", &version_fops
}
2348 int num_leaves
= ARRAY_SIZE(sg_proc_leaf_arr
);
2351 sg_proc_sgp
= proc_mkdir(sg_proc_sg_dirname
, NULL
);
2354 for (k
= 0; k
< num_leaves
; ++k
) {
2355 const struct sg_proc_leaf
*leaf
= &sg_proc_leaf_arr
[k
];
2356 umode_t mask
= leaf
->fops
->write
? S_IRUGO
| S_IWUSR
: S_IRUGO
;
2357 proc_create(leaf
->name
, mask
, sg_proc_sgp
, leaf
->fops
);
2363 sg_proc_cleanup(void)
2366 int num_leaves
= ARRAY_SIZE(sg_proc_leaf_arr
);
2370 for (k
= 0; k
< num_leaves
; ++k
)
2371 remove_proc_entry(sg_proc_leaf_arr
[k
].name
, sg_proc_sgp
);
2372 remove_proc_entry(sg_proc_sg_dirname
, NULL
);
2376 static int sg_proc_seq_show_int(struct seq_file
*s
, void *v
)
2378 seq_printf(s
, "%d\n", *((int *)s
->private));
2382 static int sg_proc_single_open_adio(struct inode
*inode
, struct file
*file
)
2384 return single_open(file
, sg_proc_seq_show_int
, &sg_allow_dio
);
2388 sg_proc_write_adio(struct file
*filp
, const char __user
*buffer
,
2389 size_t count
, loff_t
*off
)
2394 if (!capable(CAP_SYS_ADMIN
) || !capable(CAP_SYS_RAWIO
))
2396 err
= kstrtoul_from_user(buffer
, count
, 0, &num
);
2399 sg_allow_dio
= num
? 1 : 0;
2403 static int sg_proc_single_open_dressz(struct inode
*inode
, struct file
*file
)
2405 return single_open(file
, sg_proc_seq_show_int
, &sg_big_buff
);
2409 sg_proc_write_dressz(struct file
*filp
, const char __user
*buffer
,
2410 size_t count
, loff_t
*off
)
2413 unsigned long k
= ULONG_MAX
;
2415 if (!capable(CAP_SYS_ADMIN
) || !capable(CAP_SYS_RAWIO
))
2418 err
= kstrtoul_from_user(buffer
, count
, 0, &k
);
2421 if (k
<= 1048576) { /* limit "big buff" to 1 MB */
2428 static int sg_proc_seq_show_version(struct seq_file
*s
, void *v
)
2430 seq_printf(s
, "%d\t%s [%s]\n", sg_version_num
, SG_VERSION_STR
,
2435 static int sg_proc_single_open_version(struct inode
*inode
, struct file
*file
)
2437 return single_open(file
, sg_proc_seq_show_version
, NULL
);
2440 static int sg_proc_seq_show_devhdr(struct seq_file
*s
, void *v
)
2442 seq_printf(s
, "host\tchan\tid\tlun\ttype\topens\tqdepth\tbusy\t"
2447 static int sg_proc_single_open_devhdr(struct inode
*inode
, struct file
*file
)
2449 return single_open(file
, sg_proc_seq_show_devhdr
, NULL
);
2452 struct sg_proc_deviter
{
2457 static void * dev_seq_start(struct seq_file
*s
, loff_t
*pos
)
2459 struct sg_proc_deviter
* it
= kmalloc(sizeof(*it
), GFP_KERNEL
);
2466 it
->max
= sg_last_dev();
2467 if (it
->index
>= it
->max
)
2472 static void * dev_seq_next(struct seq_file
*s
, void *v
, loff_t
*pos
)
2474 struct sg_proc_deviter
* it
= s
->private;
2477 return (it
->index
< it
->max
) ? it
: NULL
;
2480 static void dev_seq_stop(struct seq_file
*s
, void *v
)
2485 static int sg_proc_open_dev(struct inode
*inode
, struct file
*file
)
2487 return seq_open(file
, &dev_seq_ops
);
2490 static int sg_proc_seq_show_dev(struct seq_file
*s
, void *v
)
2492 struct sg_proc_deviter
* it
= (struct sg_proc_deviter
*) v
;
2494 struct scsi_device
*scsidp
;
2495 unsigned long iflags
;
2497 read_lock_irqsave(&sg_index_lock
, iflags
);
2498 sdp
= it
? sg_lookup_dev(it
->index
) : NULL
;
2499 if (sdp
&& (scsidp
= sdp
->device
) && (!sdp
->detached
))
2500 seq_printf(s
, "%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\n",
2501 scsidp
->host
->host_no
, scsidp
->channel
,
2502 scsidp
->id
, scsidp
->lun
, (int) scsidp
->type
,
2504 (int) scsidp
->queue_depth
,
2505 (int) scsidp
->device_busy
,
2506 (int) scsi_device_online(scsidp
));
2508 seq_printf(s
, "-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\n");
2509 read_unlock_irqrestore(&sg_index_lock
, iflags
);
2513 static int sg_proc_open_devstrs(struct inode
*inode
, struct file
*file
)
2515 return seq_open(file
, &devstrs_seq_ops
);
2518 static int sg_proc_seq_show_devstrs(struct seq_file
*s
, void *v
)
2520 struct sg_proc_deviter
* it
= (struct sg_proc_deviter
*) v
;
2522 struct scsi_device
*scsidp
;
2523 unsigned long iflags
;
2525 read_lock_irqsave(&sg_index_lock
, iflags
);
2526 sdp
= it
? sg_lookup_dev(it
->index
) : NULL
;
2527 if (sdp
&& (scsidp
= sdp
->device
) && (!sdp
->detached
))
2528 seq_printf(s
, "%8.8s\t%16.16s\t%4.4s\n",
2529 scsidp
->vendor
, scsidp
->model
, scsidp
->rev
);
2531 seq_printf(s
, "<no active device>\n");
2532 read_unlock_irqrestore(&sg_index_lock
, iflags
);
2536 /* must be called while holding sg_index_lock */
2537 static void sg_proc_debug_helper(struct seq_file
*s
, Sg_device
* sdp
)
2539 int k
, m
, new_interface
, blen
, usg
;
2542 const sg_io_hdr_t
*hp
;
2547 list_for_each_entry(fp
, &sdp
->sfds
, sfd_siblings
) {
2549 read_lock(&fp
->rq_list_lock
); /* irqs already disabled */
2550 seq_printf(s
, " FD(%d): timeout=%dms bufflen=%d "
2551 "(res)sgat=%d low_dma=%d\n", k
,
2552 jiffies_to_msecs(fp
->timeout
),
2553 fp
->reserve
.bufflen
,
2554 (int) fp
->reserve
.k_use_sg
,
2556 seq_printf(s
, " cmd_q=%d f_packid=%d k_orphan=%d closed=0\n",
2557 (int) fp
->cmd_q
, (int) fp
->force_packid
,
2558 (int) fp
->keep_orphan
);
2559 for (m
= 0, srp
= fp
->headrp
;
2561 ++m
, srp
= srp
->nextrp
) {
2563 new_interface
= (hp
->interface_id
== '\0') ? 0 : 1;
2564 if (srp
->res_used
) {
2565 if (new_interface
&&
2566 (SG_FLAG_MMAP_IO
& hp
->flags
))
2571 if (SG_INFO_DIRECT_IO_MASK
& hp
->info
)
2577 blen
= srp
->data
.bufflen
;
2578 usg
= srp
->data
.k_use_sg
;
2579 seq_printf(s
, srp
->done
?
2580 ((1 == srp
->done
) ? "rcv:" : "fin:")
2582 seq_printf(s
, " id=%d blen=%d",
2583 srp
->header
.pack_id
, blen
);
2585 seq_printf(s
, " dur=%d", hp
->duration
);
2587 ms
= jiffies_to_msecs(jiffies
);
2588 seq_printf(s
, " t_o/elap=%d/%d",
2589 (new_interface
? hp
->timeout
:
2590 jiffies_to_msecs(fp
->timeout
)),
2591 (ms
> hp
->duration
? ms
- hp
->duration
: 0));
2593 seq_printf(s
, "ms sgat=%d op=0x%02x\n", usg
,
2594 (int) srp
->data
.cmd_opcode
);
2597 seq_printf(s
, " No requests active\n");
2598 read_unlock(&fp
->rq_list_lock
);
2602 static int sg_proc_open_debug(struct inode
*inode
, struct file
*file
)
2604 return seq_open(file
, &debug_seq_ops
);
2607 static int sg_proc_seq_show_debug(struct seq_file
*s
, void *v
)
2609 struct sg_proc_deviter
* it
= (struct sg_proc_deviter
*) v
;
2611 unsigned long iflags
;
2613 if (it
&& (0 == it
->index
)) {
2614 seq_printf(s
, "max_active_device=%d(origin 1)\n",
2616 seq_printf(s
, " def_reserved_size=%d\n", sg_big_buff
);
2619 read_lock_irqsave(&sg_index_lock
, iflags
);
2620 sdp
= it
? sg_lookup_dev(it
->index
) : NULL
;
2621 if (sdp
&& !list_empty(&sdp
->sfds
)) {
2622 struct scsi_device
*scsidp
= sdp
->device
;
2624 seq_printf(s
, " >>> device=%s ", sdp
->disk
->disk_name
);
2626 seq_printf(s
, "detached pending close ");
2629 (s
, "scsi%d chan=%d id=%d lun=%d em=%d",
2630 scsidp
->host
->host_no
,
2631 scsidp
->channel
, scsidp
->id
,
2633 scsidp
->host
->hostt
->emulated
);
2634 seq_printf(s
, " sg_tablesize=%d excl=%d\n",
2635 sdp
->sg_tablesize
, get_exclude(sdp
));
2636 sg_proc_debug_helper(s
, sdp
);
2638 read_unlock_irqrestore(&sg_index_lock
, iflags
);
2642 #endif /* CONFIG_SCSI_PROC_FS */
2644 module_init(init_sg
);
2645 module_exit(exit_sg
);