1 // SPDX-License-Identifier: GPL-2.0-or-later
4 * Started: Aug 9 by Lawrence Foard (entropy@world.std.com),
5 * to allow user process control of SCSI devices.
6 * Development Sponsored by Killy Corp. NY NY
8 * Original driver (sg.c):
9 * Copyright (C) 1992 Lawrence Foard
10 * Version 2 and 3 extensions to driver:
11 * Copyright (C) 1998 - 2014 Douglas Gilbert
14 static int sg_version_num
= 30536; /* 2 digits for each component */
15 #define SG_VERSION_STR "3.5.36"
18 * D. P. Gilbert (dgilbert@interlog.com), notes:
19 * - scsi logging is available via SCSI_LOG_TIMEOUT macros. First
20 * the kernel/module needs to be built with CONFIG_SCSI_LOGGING
21 * (otherwise the macros compile to empty statements).
24 #include <linux/module.h>
27 #include <linux/kernel.h>
28 #include <linux/sched.h>
29 #include <linux/string.h>
31 #include <linux/errno.h>
32 #include <linux/mtio.h>
33 #include <linux/ioctl.h>
34 #include <linux/slab.h>
35 #include <linux/fcntl.h>
36 #include <linux/init.h>
37 #include <linux/poll.h>
38 #include <linux/moduleparam.h>
39 #include <linux/cdev.h>
40 #include <linux/idr.h>
41 #include <linux/seq_file.h>
42 #include <linux/blkdev.h>
43 #include <linux/delay.h>
44 #include <linux/blktrace_api.h>
45 #include <linux/mutex.h>
46 #include <linux/atomic.h>
47 #include <linux/ratelimit.h>
48 #include <linux/uio.h>
49 #include <linux/cred.h> /* for sg_check_file_access() */
52 #include <scsi/scsi_dbg.h>
53 #include <scsi/scsi_host.h>
54 #include <scsi/scsi_driver.h>
55 #include <scsi/scsi_ioctl.h>
58 #include "scsi_logging.h"
60 #ifdef CONFIG_SCSI_PROC_FS
61 #include <linux/proc_fs.h>
62 static char *sg_version_date
= "20140603";
64 static int sg_proc_init(void);
67 #define SG_ALLOW_DIO_DEF 0
69 #define SG_MAX_DEVS 32768
71 /* SG_MAX_CDB_SIZE should be 260 (spc4r37 section 3.1.30) however the type
72 * of sg_io_hdr::cmd_len can only represent 255. All SCSI commands greater
73 * than 16 bytes are "variable length" whose length is a multiple of 4
75 #define SG_MAX_CDB_SIZE 252
77 #define SG_DEFAULT_TIMEOUT mult_frac(SG_DEFAULT_TIMEOUT_USER, HZ, USER_HZ)
79 int sg_big_buff
= SG_DEF_RESERVED_SIZE
;
80 /* N.B. This variable is readable and writeable via
81 /proc/scsi/sg/def_reserved_size . Each time sg_open() is called a buffer
82 of this size (or less if there is not enough memory) will be reserved
83 for use by this file descriptor. [Deprecated usage: this variable is also
84 readable via /proc/sys/kernel/sg-big-buff if the sg driver is built into
85 the kernel (i.e. it is not a module).] */
86 static int def_reserved_size
= -1; /* picks up init parameter */
87 static int sg_allow_dio
= SG_ALLOW_DIO_DEF
;
89 static int scatter_elem_sz
= SG_SCATTER_SZ
;
90 static int scatter_elem_sz_prev
= SG_SCATTER_SZ
;
92 #define SG_SECTOR_SZ 512
94 static int sg_add_device(struct device
*, struct class_interface
*);
95 static void sg_remove_device(struct device
*, struct class_interface
*);
97 static DEFINE_IDR(sg_index_idr
);
98 static DEFINE_RWLOCK(sg_index_lock
); /* Also used to lock
99 file descriptor list for device */
101 static struct class_interface sg_interface
= {
102 .add_dev
= sg_add_device
,
103 .remove_dev
= sg_remove_device
,
106 typedef struct sg_scatter_hold
{ /* holding area for scsi scatter gather info */
107 unsigned short k_use_sg
; /* Count of kernel scatter-gather pieces */
108 unsigned sglist_len
; /* size of malloc'd scatter-gather list ++ */
109 unsigned bufflen
; /* Size of (aggregate) data buffer */
112 char dio_in_use
; /* 0->indirect IO (or mmap), 1->dio */
113 unsigned char cmd_opcode
; /* first byte of command */
116 struct sg_device
; /* forward declarations */
119 typedef struct sg_request
{ /* SG_MAX_QUEUE requests outstanding per file */
120 struct list_head entry
; /* list entry */
121 struct sg_fd
*parentfp
; /* NULL -> not in use */
122 Sg_scatter_hold data
; /* hold buffer, perhaps scatter list */
123 sg_io_hdr_t header
; /* scsi command+info, see <scsi/sg.h> */
124 unsigned char sense_b
[SCSI_SENSE_BUFFERSIZE
];
125 char res_used
; /* 1 -> using reserve buffer, 0 -> not ... */
126 char orphan
; /* 1 -> drop on sight, 0 -> normal */
127 char sg_io_owned
; /* 1 -> packet belongs to SG_IO */
128 /* done protected by rq_list_lock */
129 char done
; /* 0->before bh, 1->before read, 2->read */
132 struct execute_work ew
;
135 typedef struct sg_fd
{ /* holds the state of a file descriptor */
136 struct list_head sfd_siblings
; /* protected by device's sfd_lock */
137 struct sg_device
*parentdp
; /* owning device */
138 wait_queue_head_t read_wait
; /* queue read until command done */
139 rwlock_t rq_list_lock
; /* protect access to list in req_arr */
140 struct mutex f_mutex
; /* protect against changes in this fd */
141 int timeout
; /* defaults to SG_DEFAULT_TIMEOUT */
142 int timeout_user
; /* defaults to SG_DEFAULT_TIMEOUT_USER */
143 Sg_scatter_hold reserve
; /* buffer held for this file descriptor */
144 struct list_head rq_list
; /* head of request list */
145 struct fasync_struct
*async_qp
; /* used by asynchronous notification */
146 Sg_request req_arr
[SG_MAX_QUEUE
]; /* used as singly-linked list */
147 char force_packid
; /* 1 -> pack_id input to read(), 0 -> ignored */
148 char cmd_q
; /* 1 -> allow command queuing, 0 -> don't */
149 unsigned char next_cmd_len
; /* 0: automatic, >0: use on next write() */
150 char keep_orphan
; /* 0 -> drop orphan (def), 1 -> keep for read() */
151 char mmap_called
; /* 0 -> mmap() never called on this fd */
152 char res_in_use
; /* 1 -> 'reserve' array in use */
154 struct execute_work ew
;
157 typedef struct sg_device
{ /* holds the state of each scsi generic device */
158 struct scsi_device
*device
;
159 wait_queue_head_t open_wait
; /* queue open() when O_EXCL present */
160 struct mutex open_rel_lock
; /* held when in open() or release() */
161 int sg_tablesize
; /* adapter's max scatter-gather table size */
162 u32 index
; /* device index number */
163 struct list_head sfds
;
164 rwlock_t sfd_lock
; /* protect access to sfd list */
165 atomic_t detaching
; /* 0->device usable, 1->device detaching */
166 bool exclude
; /* 1->open(O_EXCL) succeeded and is active */
167 int open_cnt
; /* count of opens (perhaps < num(sfds) ) */
168 char sgdebug
; /* 0->off, 1->sense, 9->dump dev, 10-> all devs */
169 struct gendisk
*disk
;
170 struct cdev
* cdev
; /* char_dev [sysfs: /sys/cdev/major/sg<n>] */
174 /* tasklet or soft irq callback */
175 static void sg_rq_end_io(struct request
*rq
, blk_status_t status
);
176 static int sg_start_req(Sg_request
*srp
, unsigned char *cmd
);
177 static int sg_finish_rem_req(Sg_request
* srp
);
178 static int sg_build_indirect(Sg_scatter_hold
* schp
, Sg_fd
* sfp
, int buff_size
);
179 static ssize_t
sg_new_read(Sg_fd
* sfp
, char __user
*buf
, size_t count
,
181 static ssize_t
sg_new_write(Sg_fd
*sfp
, struct file
*file
,
182 const char __user
*buf
, size_t count
, int blocking
,
183 int read_only
, int sg_io_owned
, Sg_request
**o_srp
);
184 static int sg_common_write(Sg_fd
* sfp
, Sg_request
* srp
,
185 unsigned char *cmnd
, int timeout
, int blocking
);
186 static int sg_read_oxfer(Sg_request
* srp
, char __user
*outp
, int num_read_xfer
);
187 static void sg_remove_scat(Sg_fd
* sfp
, Sg_scatter_hold
* schp
);
188 static void sg_build_reserve(Sg_fd
* sfp
, int req_size
);
189 static void sg_link_reserve(Sg_fd
* sfp
, Sg_request
* srp
, int size
);
190 static void sg_unlink_reserve(Sg_fd
* sfp
, Sg_request
* srp
);
191 static Sg_fd
*sg_add_sfp(Sg_device
* sdp
);
192 static void sg_remove_sfp(struct kref
*);
193 static Sg_request
*sg_get_rq_mark(Sg_fd
* sfp
, int pack_id
);
194 static Sg_request
*sg_add_request(Sg_fd
* sfp
);
195 static int sg_remove_request(Sg_fd
* sfp
, Sg_request
* srp
);
196 static Sg_device
*sg_get_dev(int dev
);
197 static void sg_device_destroy(struct kref
*kref
);
199 #define SZ_SG_HEADER sizeof(struct sg_header)
200 #define SZ_SG_IO_HDR sizeof(sg_io_hdr_t)
201 #define SZ_SG_IOVEC sizeof(sg_iovec_t)
202 #define SZ_SG_REQ_INFO sizeof(sg_req_info_t)
204 #define sg_printk(prefix, sdp, fmt, a...) \
205 sdev_prefix_printk(prefix, (sdp)->device, \
206 (sdp)->disk->disk_name, fmt, ##a)
209 * The SCSI interfaces that use read() and write() as an asynchronous variant of
210 * ioctl(..., SG_IO, ...) are fundamentally unsafe, since there are lots of ways
211 * to trigger read() and write() calls from various contexts with elevated
212 * privileges. This can lead to kernel memory corruption (e.g. if these
213 * interfaces are called through splice()) and privilege escalation inside
214 * userspace (e.g. if a process with access to such a device passes a file
215 * descriptor to a SUID binary as stdin/stdout/stderr).
217 * This function provides protection for the legacy API by restricting the
220 static int sg_check_file_access(struct file
*filp
, const char *caller
)
222 if (filp
->f_cred
!= current_real_cred()) {
223 pr_err_once("%s: process %d (%s) changed security contexts after opening file descriptor, this is not allowed.\n",
224 caller
, task_tgid_vnr(current
), current
->comm
);
227 if (uaccess_kernel()) {
228 pr_err_once("%s: process %d (%s) called from kernel context, this is not allowed.\n",
229 caller
, task_tgid_vnr(current
), current
->comm
);
235 static int sg_allow_access(struct file
*filp
, unsigned char *cmd
)
237 struct sg_fd
*sfp
= filp
->private_data
;
239 if (sfp
->parentdp
->device
->type
== TYPE_SCANNER
)
242 return blk_verify_command(cmd
, filp
->f_mode
);
246 open_wait(Sg_device
*sdp
, int flags
)
250 if (flags
& O_EXCL
) {
251 while (sdp
->open_cnt
> 0) {
252 mutex_unlock(&sdp
->open_rel_lock
);
253 retval
= wait_event_interruptible(sdp
->open_wait
,
254 (atomic_read(&sdp
->detaching
) ||
256 mutex_lock(&sdp
->open_rel_lock
);
258 if (retval
) /* -ERESTARTSYS */
260 if (atomic_read(&sdp
->detaching
))
264 while (sdp
->exclude
) {
265 mutex_unlock(&sdp
->open_rel_lock
);
266 retval
= wait_event_interruptible(sdp
->open_wait
,
267 (atomic_read(&sdp
->detaching
) ||
269 mutex_lock(&sdp
->open_rel_lock
);
271 if (retval
) /* -ERESTARTSYS */
273 if (atomic_read(&sdp
->detaching
))
281 /* Returns 0 on success, else a negated errno value */
283 sg_open(struct inode
*inode
, struct file
*filp
)
285 int dev
= iminor(inode
);
286 int flags
= filp
->f_flags
;
287 struct request_queue
*q
;
292 nonseekable_open(inode
, filp
);
293 if ((flags
& O_EXCL
) && (O_RDONLY
== (flags
& O_ACCMODE
)))
294 return -EPERM
; /* Can't lock it with read only access */
295 sdp
= sg_get_dev(dev
);
299 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO
, sdp
,
300 "sg_open: flags=0x%x\n", flags
));
302 /* This driver's module count bumped by fops_get in <linux/fs.h> */
303 /* Prevent the device driver from vanishing while we sleep */
304 retval
= scsi_device_get(sdp
->device
);
308 retval
= scsi_autopm_get_device(sdp
->device
);
312 /* scsi_block_when_processing_errors() may block so bypass
313 * check if O_NONBLOCK. Permits SCSI commands to be issued
314 * during error recovery. Tread carefully. */
315 if (!((flags
& O_NONBLOCK
) ||
316 scsi_block_when_processing_errors(sdp
->device
))) {
318 /* we are in error recovery for this device */
322 mutex_lock(&sdp
->open_rel_lock
);
323 if (flags
& O_NONBLOCK
) {
324 if (flags
& O_EXCL
) {
325 if (sdp
->open_cnt
> 0) {
327 goto error_mutex_locked
;
332 goto error_mutex_locked
;
336 retval
= open_wait(sdp
, flags
);
337 if (retval
) /* -ERESTARTSYS or -ENODEV */
338 goto error_mutex_locked
;
341 /* N.B. at this point we are holding the open_rel_lock */
345 if (sdp
->open_cnt
< 1) { /* no existing opens */
347 q
= sdp
->device
->request_queue
;
348 sdp
->sg_tablesize
= queue_max_segments(q
);
350 sfp
= sg_add_sfp(sdp
);
352 retval
= PTR_ERR(sfp
);
356 filp
->private_data
= sfp
;
358 mutex_unlock(&sdp
->open_rel_lock
);
362 kref_put(&sdp
->d_ref
, sg_device_destroy
);
366 if (flags
& O_EXCL
) {
367 sdp
->exclude
= false; /* undo if error */
368 wake_up_interruptible(&sdp
->open_wait
);
371 mutex_unlock(&sdp
->open_rel_lock
);
373 scsi_autopm_put_device(sdp
->device
);
375 scsi_device_put(sdp
->device
);
379 /* Release resources associated with a successful sg_open()
380 * Returns 0 on success, else a negated errno value */
382 sg_release(struct inode
*inode
, struct file
*filp
)
387 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
389 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO
, sdp
, "sg_release\n"));
391 mutex_lock(&sdp
->open_rel_lock
);
392 scsi_autopm_put_device(sdp
->device
);
393 kref_put(&sfp
->f_ref
, sg_remove_sfp
);
396 /* possibly many open()s waiting on exlude clearing, start many;
397 * only open(O_EXCL)s wait on 0==open_cnt so only start one */
399 sdp
->exclude
= false;
400 wake_up_interruptible_all(&sdp
->open_wait
);
401 } else if (0 == sdp
->open_cnt
) {
402 wake_up_interruptible(&sdp
->open_wait
);
404 mutex_unlock(&sdp
->open_rel_lock
);
408 static int get_sg_io_pack_id(int *pack_id
, void __user
*buf
, size_t count
)
410 struct sg_header __user
*old_hdr
= buf
;
413 if (count
>= SZ_SG_HEADER
) {
414 /* negative reply_len means v3 format, otherwise v1/v2 */
415 if (get_user(reply_len
, &old_hdr
->reply_len
))
419 return get_user(*pack_id
, &old_hdr
->pack_id
);
421 if (in_compat_syscall() &&
422 count
>= sizeof(struct compat_sg_io_hdr
)) {
423 struct compat_sg_io_hdr __user
*hp
= buf
;
425 return get_user(*pack_id
, &hp
->pack_id
);
428 if (count
>= sizeof(struct sg_io_hdr
)) {
429 struct sg_io_hdr __user
*hp
= buf
;
431 return get_user(*pack_id
, &hp
->pack_id
);
435 /* no valid header was passed, so ignore the pack_id */
441 sg_read(struct file
*filp
, char __user
*buf
, size_t count
, loff_t
* ppos
)
446 int req_pack_id
= -1;
448 struct sg_header
*old_hdr
;
452 * This could cause a response to be stranded. Close the associated
453 * file descriptor to free up any resources being held.
455 retval
= sg_check_file_access(filp
, __func__
);
459 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
461 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO
, sdp
,
462 "sg_read: count=%d\n", (int) count
));
464 if (sfp
->force_packid
)
465 retval
= get_sg_io_pack_id(&req_pack_id
, buf
, count
);
469 srp
= sg_get_rq_mark(sfp
, req_pack_id
);
470 if (!srp
) { /* now wait on packet to arrive */
471 if (atomic_read(&sdp
->detaching
))
473 if (filp
->f_flags
& O_NONBLOCK
)
475 retval
= wait_event_interruptible(sfp
->read_wait
,
476 (atomic_read(&sdp
->detaching
) ||
477 (srp
= sg_get_rq_mark(sfp
, req_pack_id
))));
478 if (atomic_read(&sdp
->detaching
))
481 /* -ERESTARTSYS as signal hit process */
484 if (srp
->header
.interface_id
!= '\0')
485 return sg_new_read(sfp
, buf
, count
, srp
);
488 old_hdr
= kzalloc(SZ_SG_HEADER
, GFP_KERNEL
);
492 old_hdr
->reply_len
= (int) hp
->timeout
;
493 old_hdr
->pack_len
= old_hdr
->reply_len
; /* old, strange behaviour */
494 old_hdr
->pack_id
= hp
->pack_id
;
495 old_hdr
->twelve_byte
=
496 ((srp
->data
.cmd_opcode
>= 0xc0) && (12 == hp
->cmd_len
)) ? 1 : 0;
497 old_hdr
->target_status
= hp
->masked_status
;
498 old_hdr
->host_status
= hp
->host_status
;
499 old_hdr
->driver_status
= hp
->driver_status
;
500 if ((CHECK_CONDITION
& hp
->masked_status
) ||
501 (DRIVER_SENSE
& hp
->driver_status
))
502 memcpy(old_hdr
->sense_buffer
, srp
->sense_b
,
503 sizeof (old_hdr
->sense_buffer
));
504 switch (hp
->host_status
) {
505 /* This setup of 'result' is for backward compatibility and is best
506 ignored by the user who should use target, host + driver status */
508 case DID_PASSTHROUGH
:
515 old_hdr
->result
= EBUSY
;
522 old_hdr
->result
= EIO
;
525 old_hdr
->result
= (srp
->sense_b
[0] == 0 &&
526 hp
->masked_status
== GOOD
) ? 0 : EIO
;
529 old_hdr
->result
= EIO
;
533 /* Now copy the result back to the user buffer. */
534 if (count
>= SZ_SG_HEADER
) {
535 if (copy_to_user(buf
, old_hdr
, SZ_SG_HEADER
)) {
540 if (count
> old_hdr
->reply_len
)
541 count
= old_hdr
->reply_len
;
542 if (count
> SZ_SG_HEADER
) {
543 if (sg_read_oxfer(srp
, buf
, count
- SZ_SG_HEADER
)) {
549 count
= (old_hdr
->result
== 0) ? 0 : -EIO
;
550 sg_finish_rem_req(srp
);
551 sg_remove_request(sfp
, srp
);
559 sg_new_read(Sg_fd
* sfp
, char __user
*buf
, size_t count
, Sg_request
* srp
)
561 sg_io_hdr_t
*hp
= &srp
->header
;
565 if (in_compat_syscall()) {
566 if (count
< sizeof(struct compat_sg_io_hdr
)) {
570 } else if (count
< SZ_SG_IO_HDR
) {
575 if ((hp
->mx_sb_len
> 0) && hp
->sbp
) {
576 if ((CHECK_CONDITION
& hp
->masked_status
) ||
577 (DRIVER_SENSE
& hp
->driver_status
)) {
578 int sb_len
= SCSI_SENSE_BUFFERSIZE
;
579 sb_len
= (hp
->mx_sb_len
> sb_len
) ? sb_len
: hp
->mx_sb_len
;
580 len
= 8 + (int) srp
->sense_b
[7]; /* Additional sense length field */
581 len
= (len
> sb_len
) ? sb_len
: len
;
582 if (copy_to_user(hp
->sbp
, srp
->sense_b
, len
)) {
589 if (hp
->masked_status
|| hp
->host_status
|| hp
->driver_status
)
590 hp
->info
|= SG_INFO_CHECK
;
591 err
= put_sg_io_hdr(hp
, buf
);
593 err2
= sg_finish_rem_req(srp
);
594 sg_remove_request(sfp
, srp
);
595 return err
? : err2
? : count
;
599 sg_write(struct file
*filp
, const char __user
*buf
, size_t count
, loff_t
* ppos
)
601 int mxsize
, cmd_size
, k
;
602 int input_size
, blocking
;
603 unsigned char opcode
;
607 struct sg_header old_hdr
;
609 unsigned char cmnd
[SG_MAX_CDB_SIZE
];
612 retval
= sg_check_file_access(filp
, __func__
);
616 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
618 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO
, sdp
,
619 "sg_write: count=%d\n", (int) count
));
620 if (atomic_read(&sdp
->detaching
))
622 if (!((filp
->f_flags
& O_NONBLOCK
) ||
623 scsi_block_when_processing_errors(sdp
->device
)))
626 if (count
< SZ_SG_HEADER
)
628 if (copy_from_user(&old_hdr
, buf
, SZ_SG_HEADER
))
630 blocking
= !(filp
->f_flags
& O_NONBLOCK
);
631 if (old_hdr
.reply_len
< 0)
632 return sg_new_write(sfp
, filp
, buf
, count
,
633 blocking
, 0, 0, NULL
);
634 if (count
< (SZ_SG_HEADER
+ 6))
635 return -EIO
; /* The minimum scsi command length is 6 bytes. */
638 if (get_user(opcode
, buf
))
641 if (!(srp
= sg_add_request(sfp
))) {
642 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO
, sdp
,
643 "sg_write: queue full\n"));
646 mutex_lock(&sfp
->f_mutex
);
647 if (sfp
->next_cmd_len
> 0) {
648 cmd_size
= sfp
->next_cmd_len
;
649 sfp
->next_cmd_len
= 0; /* reset so only this write() effected */
651 cmd_size
= COMMAND_SIZE(opcode
); /* based on SCSI command group */
652 if ((opcode
>= 0xc0) && old_hdr
.twelve_byte
)
655 mutex_unlock(&sfp
->f_mutex
);
656 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO
, sdp
,
657 "sg_write: scsi opcode=0x%02x, cmd_size=%d\n", (int) opcode
, cmd_size
));
658 /* Determine buffer size. */
659 input_size
= count
- cmd_size
;
660 mxsize
= (input_size
> old_hdr
.reply_len
) ? input_size
: old_hdr
.reply_len
;
661 mxsize
-= SZ_SG_HEADER
;
662 input_size
-= SZ_SG_HEADER
;
663 if (input_size
< 0) {
664 sg_remove_request(sfp
, srp
);
665 return -EIO
; /* User did not pass enough bytes for this command. */
668 hp
->interface_id
= '\0'; /* indicator of old interface tunnelled */
669 hp
->cmd_len
= (unsigned char) cmd_size
;
673 hp
->dxfer_direction
= (old_hdr
.reply_len
> SZ_SG_HEADER
) ?
674 SG_DXFER_TO_FROM_DEV
: SG_DXFER_TO_DEV
;
676 hp
->dxfer_direction
= (mxsize
> 0) ? SG_DXFER_FROM_DEV
: SG_DXFER_NONE
;
677 hp
->dxfer_len
= mxsize
;
678 if ((hp
->dxfer_direction
== SG_DXFER_TO_DEV
) ||
679 (hp
->dxfer_direction
== SG_DXFER_TO_FROM_DEV
))
680 hp
->dxferp
= (char __user
*)buf
+ cmd_size
;
684 hp
->timeout
= old_hdr
.reply_len
; /* structure abuse ... */
685 hp
->flags
= input_size
; /* structure abuse ... */
686 hp
->pack_id
= old_hdr
.pack_id
;
688 if (copy_from_user(cmnd
, buf
, cmd_size
)) {
689 sg_remove_request(sfp
, srp
);
693 * SG_DXFER_TO_FROM_DEV is functionally equivalent to SG_DXFER_FROM_DEV,
694 * but is is possible that the app intended SG_DXFER_TO_DEV, because there
695 * is a non-zero input_size, so emit a warning.
697 if (hp
->dxfer_direction
== SG_DXFER_TO_FROM_DEV
) {
698 printk_ratelimited(KERN_WARNING
699 "sg_write: data in/out %d/%d bytes "
700 "for SCSI command 0x%x-- guessing "
701 "data in;\n program %s not setting "
702 "count and/or reply_len properly\n",
703 old_hdr
.reply_len
- (int)SZ_SG_HEADER
,
704 input_size
, (unsigned int) cmnd
[0],
707 k
= sg_common_write(sfp
, srp
, cmnd
, sfp
->timeout
, blocking
);
708 return (k
< 0) ? k
: count
;
712 sg_new_write(Sg_fd
*sfp
, struct file
*file
, const char __user
*buf
,
713 size_t count
, int blocking
, int read_only
, int sg_io_owned
,
719 unsigned char cmnd
[SG_MAX_CDB_SIZE
];
721 unsigned long ul_timeout
;
723 if (count
< SZ_SG_IO_HDR
)
726 sfp
->cmd_q
= 1; /* when sg_io_hdr seen, set command queuing on */
727 if (!(srp
= sg_add_request(sfp
))) {
728 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO
, sfp
->parentdp
,
729 "sg_new_write: queue full\n"));
732 srp
->sg_io_owned
= sg_io_owned
;
734 if (get_sg_io_hdr(hp
, buf
)) {
735 sg_remove_request(sfp
, srp
);
738 if (hp
->interface_id
!= 'S') {
739 sg_remove_request(sfp
, srp
);
742 if (hp
->flags
& SG_FLAG_MMAP_IO
) {
743 if (hp
->dxfer_len
> sfp
->reserve
.bufflen
) {
744 sg_remove_request(sfp
, srp
);
745 return -ENOMEM
; /* MMAP_IO size must fit in reserve buffer */
747 if (hp
->flags
& SG_FLAG_DIRECT_IO
) {
748 sg_remove_request(sfp
, srp
);
749 return -EINVAL
; /* either MMAP_IO or DIRECT_IO (not both) */
751 if (sfp
->res_in_use
) {
752 sg_remove_request(sfp
, srp
);
753 return -EBUSY
; /* reserve buffer already being used */
756 ul_timeout
= msecs_to_jiffies(srp
->header
.timeout
);
757 timeout
= (ul_timeout
< INT_MAX
) ? ul_timeout
: INT_MAX
;
758 if ((!hp
->cmdp
) || (hp
->cmd_len
< 6) || (hp
->cmd_len
> sizeof (cmnd
))) {
759 sg_remove_request(sfp
, srp
);
762 if (copy_from_user(cmnd
, hp
->cmdp
, hp
->cmd_len
)) {
763 sg_remove_request(sfp
, srp
);
766 if (read_only
&& sg_allow_access(file
, cmnd
)) {
767 sg_remove_request(sfp
, srp
);
770 k
= sg_common_write(sfp
, srp
, cmnd
, timeout
, blocking
);
779 sg_common_write(Sg_fd
* sfp
, Sg_request
* srp
,
780 unsigned char *cmnd
, int timeout
, int blocking
)
783 Sg_device
*sdp
= sfp
->parentdp
;
784 sg_io_hdr_t
*hp
= &srp
->header
;
786 srp
->data
.cmd_opcode
= cmnd
[0]; /* hold opcode of command */
788 hp
->masked_status
= 0;
792 hp
->driver_status
= 0;
794 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO
, sfp
->parentdp
,
795 "sg_common_write: scsi opcode=0x%02x, cmd_size=%d\n",
796 (int) cmnd
[0], (int) hp
->cmd_len
));
798 if (hp
->dxfer_len
>= SZ_256M
) {
799 sg_remove_request(sfp
, srp
);
803 k
= sg_start_req(srp
, cmnd
);
805 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO
, sfp
->parentdp
,
806 "sg_common_write: start_req err=%d\n", k
));
807 sg_finish_rem_req(srp
);
808 sg_remove_request(sfp
, srp
);
809 return k
; /* probably out of space --> ENOMEM */
811 if (atomic_read(&sdp
->detaching
)) {
813 scsi_req_free_cmd(scsi_req(srp
->rq
));
814 blk_put_request(srp
->rq
);
818 sg_finish_rem_req(srp
);
819 sg_remove_request(sfp
, srp
);
823 hp
->duration
= jiffies_to_msecs(jiffies
);
824 if (hp
->interface_id
!= '\0' && /* v3 (or later) interface */
825 (SG_FLAG_Q_AT_TAIL
& hp
->flags
))
830 srp
->rq
->timeout
= timeout
;
831 kref_get(&sfp
->f_ref
); /* sg_rq_end_io() does kref_put(). */
832 blk_execute_rq_nowait(sdp
->device
->request_queue
, sdp
->disk
,
833 srp
->rq
, at_head
, sg_rq_end_io
);
837 static int srp_done(Sg_fd
*sfp
, Sg_request
*srp
)
842 read_lock_irqsave(&sfp
->rq_list_lock
, flags
);
844 read_unlock_irqrestore(&sfp
->rq_list_lock
, flags
);
848 static int max_sectors_bytes(struct request_queue
*q
)
850 unsigned int max_sectors
= queue_max_sectors(q
);
852 max_sectors
= min_t(unsigned int, max_sectors
, INT_MAX
>> 9);
854 return max_sectors
<< 9;
858 sg_fill_request_table(Sg_fd
*sfp
, sg_req_info_t
*rinfo
)
865 list_for_each_entry(srp
, &sfp
->rq_list
, entry
) {
866 if (val
>= SG_MAX_QUEUE
)
868 rinfo
[val
].req_state
= srp
->done
+ 1;
870 srp
->header
.masked_status
&
871 srp
->header
.host_status
&
872 srp
->header
.driver_status
;
874 rinfo
[val
].duration
=
875 srp
->header
.duration
;
877 ms
= jiffies_to_msecs(jiffies
);
878 rinfo
[val
].duration
=
879 (ms
> srp
->header
.duration
) ?
880 (ms
- srp
->header
.duration
) : 0;
882 rinfo
[val
].orphan
= srp
->orphan
;
883 rinfo
[val
].sg_io_owned
= srp
->sg_io_owned
;
884 rinfo
[val
].pack_id
= srp
->header
.pack_id
;
885 rinfo
[val
].usr_ptr
= srp
->header
.usr_ptr
;
891 struct compat_sg_req_info
{ /* used by SG_GET_REQUEST_TABLE ioctl() */
897 compat_uptr_t usr_ptr
;
898 unsigned int duration
;
902 static int put_compat_request_table(struct compat_sg_req_info __user
*o
,
903 struct sg_req_info
*rinfo
)
906 for (i
= 0; i
< SG_MAX_QUEUE
; i
++) {
907 if (copy_to_user(o
+ i
, rinfo
+ i
, offsetof(sg_req_info_t
, usr_ptr
)) ||
908 put_user((uintptr_t)rinfo
[i
].usr_ptr
, &o
[i
].usr_ptr
) ||
909 put_user(rinfo
[i
].duration
, &o
[i
].duration
) ||
910 put_user(rinfo
[i
].unused
, &o
[i
].unused
))
918 sg_ioctl_common(struct file
*filp
, Sg_device
*sdp
, Sg_fd
*sfp
,
919 unsigned int cmd_in
, void __user
*p
)
922 int result
, val
, read_only
;
924 unsigned long iflags
;
926 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO
, sdp
,
927 "sg_ioctl: cmd=0x%x\n", (int) cmd_in
));
928 read_only
= (O_RDWR
!= (filp
->f_flags
& O_ACCMODE
));
932 if (atomic_read(&sdp
->detaching
))
934 if (!scsi_block_when_processing_errors(sdp
->device
))
936 result
= sg_new_write(sfp
, filp
, p
, SZ_SG_IO_HDR
,
937 1, read_only
, 1, &srp
);
940 result
= wait_event_interruptible(sfp
->read_wait
,
941 (srp_done(sfp
, srp
) || atomic_read(&sdp
->detaching
)));
942 if (atomic_read(&sdp
->detaching
))
944 write_lock_irq(&sfp
->rq_list_lock
);
947 write_unlock_irq(&sfp
->rq_list_lock
);
948 result
= sg_new_read(sfp
, p
, SZ_SG_IO_HDR
, srp
);
949 return (result
< 0) ? result
: 0;
952 write_unlock_irq(&sfp
->rq_list_lock
);
953 return result
; /* -ERESTARTSYS because signal hit process */
955 result
= get_user(val
, ip
);
960 if (val
>= mult_frac((s64
)INT_MAX
, USER_HZ
, HZ
))
961 val
= min_t(s64
, mult_frac((s64
)INT_MAX
, USER_HZ
, HZ
),
963 sfp
->timeout_user
= val
;
964 sfp
->timeout
= mult_frac(val
, HZ
, USER_HZ
);
967 case SG_GET_TIMEOUT
: /* N.B. User receives timeout as return value */
968 /* strange ..., for backward compatibility */
969 return sfp
->timeout_user
;
970 case SG_SET_FORCE_LOW_DMA
:
972 * N.B. This ioctl never worked properly, but failed to
973 * return an error value. So returning '0' to keep compability
974 * with legacy applications.
978 return put_user((int) sdp
->device
->host
->unchecked_isa_dma
, ip
);
983 if (atomic_read(&sdp
->detaching
))
985 memset(&v
, 0, sizeof(v
));
986 v
.host_no
= sdp
->device
->host
->host_no
;
987 v
.channel
= sdp
->device
->channel
;
988 v
.scsi_id
= sdp
->device
->id
;
989 v
.lun
= sdp
->device
->lun
;
990 v
.scsi_type
= sdp
->device
->type
;
991 v
.h_cmd_per_lun
= sdp
->device
->host
->cmd_per_lun
;
992 v
.d_queue_depth
= sdp
->device
->queue_depth
;
993 if (copy_to_user(p
, &v
, sizeof(sg_scsi_id_t
)))
997 case SG_SET_FORCE_PACK_ID
:
998 result
= get_user(val
, ip
);
1001 sfp
->force_packid
= val
? 1 : 0;
1003 case SG_GET_PACK_ID
:
1004 read_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
1005 list_for_each_entry(srp
, &sfp
->rq_list
, entry
) {
1006 if ((1 == srp
->done
) && (!srp
->sg_io_owned
)) {
1007 read_unlock_irqrestore(&sfp
->rq_list_lock
,
1009 return put_user(srp
->header
.pack_id
, ip
);
1012 read_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
1013 return put_user(-1, ip
);
1014 case SG_GET_NUM_WAITING
:
1015 read_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
1017 list_for_each_entry(srp
, &sfp
->rq_list
, entry
) {
1018 if ((1 == srp
->done
) && (!srp
->sg_io_owned
))
1021 read_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
1022 return put_user(val
, ip
);
1023 case SG_GET_SG_TABLESIZE
:
1024 return put_user(sdp
->sg_tablesize
, ip
);
1025 case SG_SET_RESERVED_SIZE
:
1026 result
= get_user(val
, ip
);
1031 val
= min_t(int, val
,
1032 max_sectors_bytes(sdp
->device
->request_queue
));
1033 mutex_lock(&sfp
->f_mutex
);
1034 if (val
!= sfp
->reserve
.bufflen
) {
1035 if (sfp
->mmap_called
||
1037 mutex_unlock(&sfp
->f_mutex
);
1041 sg_remove_scat(sfp
, &sfp
->reserve
);
1042 sg_build_reserve(sfp
, val
);
1044 mutex_unlock(&sfp
->f_mutex
);
1046 case SG_GET_RESERVED_SIZE
:
1047 val
= min_t(int, sfp
->reserve
.bufflen
,
1048 max_sectors_bytes(sdp
->device
->request_queue
));
1049 return put_user(val
, ip
);
1050 case SG_SET_COMMAND_Q
:
1051 result
= get_user(val
, ip
);
1054 sfp
->cmd_q
= val
? 1 : 0;
1056 case SG_GET_COMMAND_Q
:
1057 return put_user((int) sfp
->cmd_q
, ip
);
1058 case SG_SET_KEEP_ORPHAN
:
1059 result
= get_user(val
, ip
);
1062 sfp
->keep_orphan
= val
;
1064 case SG_GET_KEEP_ORPHAN
:
1065 return put_user((int) sfp
->keep_orphan
, ip
);
1066 case SG_NEXT_CMD_LEN
:
1067 result
= get_user(val
, ip
);
1070 if (val
> SG_MAX_CDB_SIZE
)
1072 sfp
->next_cmd_len
= (val
> 0) ? val
: 0;
1074 case SG_GET_VERSION_NUM
:
1075 return put_user(sg_version_num
, ip
);
1076 case SG_GET_ACCESS_COUNT
:
1077 /* faked - we don't have a real access count anymore */
1078 val
= (sdp
->device
? 1 : 0);
1079 return put_user(val
, ip
);
1080 case SG_GET_REQUEST_TABLE
:
1082 sg_req_info_t
*rinfo
;
1084 rinfo
= kcalloc(SG_MAX_QUEUE
, SZ_SG_REQ_INFO
,
1088 read_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
1089 sg_fill_request_table(sfp
, rinfo
);
1090 read_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
1091 #ifdef CONFIG_COMPAT
1092 if (in_compat_syscall())
1093 result
= put_compat_request_table(p
, rinfo
);
1096 result
= copy_to_user(p
, rinfo
,
1097 SZ_SG_REQ_INFO
* SG_MAX_QUEUE
);
1098 result
= result
? -EFAULT
: 0;
1102 case SG_EMULATED_HOST
:
1103 if (atomic_read(&sdp
->detaching
))
1105 return put_user(sdp
->device
->host
->hostt
->emulated
, ip
);
1106 case SCSI_IOCTL_SEND_COMMAND
:
1107 if (atomic_read(&sdp
->detaching
))
1109 return sg_scsi_ioctl(sdp
->device
->request_queue
, NULL
, filp
->f_mode
, p
);
1111 result
= get_user(val
, ip
);
1114 sdp
->sgdebug
= (char) val
;
1117 return put_user(max_sectors_bytes(sdp
->device
->request_queue
),
1120 return blk_trace_setup(sdp
->device
->request_queue
,
1121 sdp
->disk
->disk_name
,
1122 MKDEV(SCSI_GENERIC_MAJOR
, sdp
->index
),
1125 return blk_trace_startstop(sdp
->device
->request_queue
, 1);
1127 return blk_trace_startstop(sdp
->device
->request_queue
, 0);
1128 case BLKTRACETEARDOWN
:
1129 return blk_trace_remove(sdp
->device
->request_queue
);
1130 case SCSI_IOCTL_GET_IDLUN
:
1131 case SCSI_IOCTL_GET_BUS_NUMBER
:
1132 case SCSI_IOCTL_PROBE_HOST
:
1133 case SG_GET_TRANSFORM
:
1135 if (atomic_read(&sdp
->detaching
))
1140 return -EPERM
; /* don't know so take safe approach */
1144 result
= scsi_ioctl_block_when_processing_errors(sdp
->device
,
1145 cmd_in
, filp
->f_flags
& O_NDELAY
);
1149 return -ENOIOCTLCMD
;
1153 sg_ioctl(struct file
*filp
, unsigned int cmd_in
, unsigned long arg
)
1155 void __user
*p
= (void __user
*)arg
;
1160 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
1163 ret
= sg_ioctl_common(filp
, sdp
, sfp
, cmd_in
, p
);
1164 if (ret
!= -ENOIOCTLCMD
)
1167 return scsi_ioctl(sdp
->device
, cmd_in
, p
);
1170 #ifdef CONFIG_COMPAT
1171 static long sg_compat_ioctl(struct file
*filp
, unsigned int cmd_in
, unsigned long arg
)
1173 void __user
*p
= compat_ptr(arg
);
1178 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
1181 ret
= sg_ioctl_common(filp
, sdp
, sfp
, cmd_in
, p
);
1182 if (ret
!= -ENOIOCTLCMD
)
1185 return scsi_compat_ioctl(sdp
->device
, cmd_in
, p
);
1190 sg_poll(struct file
*filp
, poll_table
* wait
)
1197 unsigned long iflags
;
1199 sfp
= filp
->private_data
;
1202 sdp
= sfp
->parentdp
;
1205 poll_wait(filp
, &sfp
->read_wait
, wait
);
1206 read_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
1207 list_for_each_entry(srp
, &sfp
->rq_list
, entry
) {
1208 /* if any read waiting, flag it */
1209 if ((0 == res
) && (1 == srp
->done
) && (!srp
->sg_io_owned
))
1210 res
= EPOLLIN
| EPOLLRDNORM
;
1213 read_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
1215 if (atomic_read(&sdp
->detaching
))
1217 else if (!sfp
->cmd_q
) {
1219 res
|= EPOLLOUT
| EPOLLWRNORM
;
1220 } else if (count
< SG_MAX_QUEUE
)
1221 res
|= EPOLLOUT
| EPOLLWRNORM
;
1222 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO
, sdp
,
1223 "sg_poll: res=0x%x\n", (__force u32
) res
));
1228 sg_fasync(int fd
, struct file
*filp
, int mode
)
1233 if ((!(sfp
= (Sg_fd
*) filp
->private_data
)) || (!(sdp
= sfp
->parentdp
)))
1235 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO
, sdp
,
1236 "sg_fasync: mode=%d\n", mode
));
1238 return fasync_helper(fd
, filp
, mode
, &sfp
->async_qp
);
1242 sg_vma_fault(struct vm_fault
*vmf
)
1244 struct vm_area_struct
*vma
= vmf
->vma
;
1246 unsigned long offset
, len
, sa
;
1247 Sg_scatter_hold
*rsv_schp
;
1250 if ((NULL
== vma
) || (!(sfp
= (Sg_fd
*) vma
->vm_private_data
)))
1251 return VM_FAULT_SIGBUS
;
1252 rsv_schp
= &sfp
->reserve
;
1253 offset
= vmf
->pgoff
<< PAGE_SHIFT
;
1254 if (offset
>= rsv_schp
->bufflen
)
1255 return VM_FAULT_SIGBUS
;
1256 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO
, sfp
->parentdp
,
1257 "sg_vma_fault: offset=%lu, scatg=%d\n",
1258 offset
, rsv_schp
->k_use_sg
));
1260 length
= 1 << (PAGE_SHIFT
+ rsv_schp
->page_order
);
1261 for (k
= 0; k
< rsv_schp
->k_use_sg
&& sa
< vma
->vm_end
; k
++) {
1262 len
= vma
->vm_end
- sa
;
1263 len
= (len
< length
) ? len
: length
;
1265 struct page
*page
= nth_page(rsv_schp
->pages
[k
],
1266 offset
>> PAGE_SHIFT
);
1267 get_page(page
); /* increment page count */
1269 return 0; /* success */
1275 return VM_FAULT_SIGBUS
;
1278 static const struct vm_operations_struct sg_mmap_vm_ops
= {
1279 .fault
= sg_vma_fault
,
1283 sg_mmap(struct file
*filp
, struct vm_area_struct
*vma
)
1286 unsigned long req_sz
, len
, sa
;
1287 Sg_scatter_hold
*rsv_schp
;
1291 if ((!filp
) || (!vma
) || (!(sfp
= (Sg_fd
*) filp
->private_data
)))
1293 req_sz
= vma
->vm_end
- vma
->vm_start
;
1294 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO
, sfp
->parentdp
,
1295 "sg_mmap starting, vm_start=%p, len=%d\n",
1296 (void *) vma
->vm_start
, (int) req_sz
));
1298 return -EINVAL
; /* want no offset */
1299 rsv_schp
= &sfp
->reserve
;
1300 mutex_lock(&sfp
->f_mutex
);
1301 if (req_sz
> rsv_schp
->bufflen
) {
1302 ret
= -ENOMEM
; /* cannot map more than reserved buffer */
1307 length
= 1 << (PAGE_SHIFT
+ rsv_schp
->page_order
);
1308 for (k
= 0; k
< rsv_schp
->k_use_sg
&& sa
< vma
->vm_end
; k
++) {
1309 len
= vma
->vm_end
- sa
;
1310 len
= (len
< length
) ? len
: length
;
1314 sfp
->mmap_called
= 1;
1315 vma
->vm_flags
|= VM_IO
| VM_DONTEXPAND
| VM_DONTDUMP
;
1316 vma
->vm_private_data
= sfp
;
1317 vma
->vm_ops
= &sg_mmap_vm_ops
;
1319 mutex_unlock(&sfp
->f_mutex
);
1324 sg_rq_end_io_usercontext(struct work_struct
*work
)
1326 struct sg_request
*srp
= container_of(work
, struct sg_request
, ew
.work
);
1327 struct sg_fd
*sfp
= srp
->parentfp
;
1329 sg_finish_rem_req(srp
);
1330 sg_remove_request(sfp
, srp
);
1331 kref_put(&sfp
->f_ref
, sg_remove_sfp
);
1335 * This function is a "bottom half" handler that is called by the mid
1336 * level when a command is completed (or has failed).
1339 sg_rq_end_io(struct request
*rq
, blk_status_t status
)
1341 struct sg_request
*srp
= rq
->end_io_data
;
1342 struct scsi_request
*req
= scsi_req(rq
);
1345 unsigned long iflags
;
1348 int result
, resid
, done
= 1;
1350 if (WARN_ON(srp
->done
!= 0))
1353 sfp
= srp
->parentfp
;
1354 if (WARN_ON(sfp
== NULL
))
1357 sdp
= sfp
->parentdp
;
1358 if (unlikely(atomic_read(&sdp
->detaching
)))
1359 pr_info("%s: device detaching\n", __func__
);
1362 result
= req
->result
;
1363 resid
= req
->resid_len
;
1365 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO
, sdp
,
1366 "sg_cmd_done: pack_id=%d, res=0x%x\n",
1367 srp
->header
.pack_id
, result
));
1368 srp
->header
.resid
= resid
;
1369 ms
= jiffies_to_msecs(jiffies
);
1370 srp
->header
.duration
= (ms
> srp
->header
.duration
) ?
1371 (ms
- srp
->header
.duration
) : 0;
1373 struct scsi_sense_hdr sshdr
;
1375 srp
->header
.status
= 0xff & result
;
1376 srp
->header
.masked_status
= status_byte(result
);
1377 srp
->header
.msg_status
= msg_byte(result
);
1378 srp
->header
.host_status
= host_byte(result
);
1379 srp
->header
.driver_status
= driver_byte(result
);
1380 if ((sdp
->sgdebug
> 0) &&
1381 ((CHECK_CONDITION
== srp
->header
.masked_status
) ||
1382 (COMMAND_TERMINATED
== srp
->header
.masked_status
)))
1383 __scsi_print_sense(sdp
->device
, __func__
, sense
,
1384 SCSI_SENSE_BUFFERSIZE
);
1386 /* Following if statement is a patch supplied by Eric Youngdale */
1387 if (driver_byte(result
) != 0
1388 && scsi_normalize_sense(sense
, SCSI_SENSE_BUFFERSIZE
, &sshdr
)
1389 && !scsi_sense_is_deferred(&sshdr
)
1390 && sshdr
.sense_key
== UNIT_ATTENTION
1391 && sdp
->device
->removable
) {
1392 /* Detected possible disc change. Set the bit - this */
1393 /* may be used if there are filesystems using this device */
1394 sdp
->device
->changed
= 1;
1399 memcpy(srp
->sense_b
, req
->sense
, SCSI_SENSE_BUFFERSIZE
);
1401 /* Rely on write phase to clean out srp status values, so no "else" */
1404 * Free the request as soon as it is complete so that its resources
1405 * can be reused without waiting for userspace to read() the
1406 * result. But keep the associated bio (if any) around until
1407 * blk_rq_unmap_user() can be called from user context.
1410 scsi_req_free_cmd(scsi_req(rq
));
1411 blk_put_request(rq
);
1413 write_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
1414 if (unlikely(srp
->orphan
)) {
1415 if (sfp
->keep_orphan
)
1416 srp
->sg_io_owned
= 0;
1421 write_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
1424 /* Now wake up any sg_read() that is waiting for this
1427 wake_up_interruptible(&sfp
->read_wait
);
1428 kill_fasync(&sfp
->async_qp
, SIGPOLL
, POLL_IN
);
1429 kref_put(&sfp
->f_ref
, sg_remove_sfp
);
1431 INIT_WORK(&srp
->ew
.work
, sg_rq_end_io_usercontext
);
1432 schedule_work(&srp
->ew
.work
);
1436 static const struct file_operations sg_fops
= {
1437 .owner
= THIS_MODULE
,
1441 .unlocked_ioctl
= sg_ioctl
,
1442 #ifdef CONFIG_COMPAT
1443 .compat_ioctl
= sg_compat_ioctl
,
1447 .release
= sg_release
,
1448 .fasync
= sg_fasync
,
1449 .llseek
= no_llseek
,
1452 static struct class *sg_sysfs_class
;
1454 static int sg_sysfs_valid
= 0;
1457 sg_alloc(struct gendisk
*disk
, struct scsi_device
*scsidp
)
1459 struct request_queue
*q
= scsidp
->request_queue
;
1461 unsigned long iflags
;
1465 sdp
= kzalloc(sizeof(Sg_device
), GFP_KERNEL
);
1467 sdev_printk(KERN_WARNING
, scsidp
, "%s: kmalloc Sg_device "
1468 "failure\n", __func__
);
1469 return ERR_PTR(-ENOMEM
);
1472 idr_preload(GFP_KERNEL
);
1473 write_lock_irqsave(&sg_index_lock
, iflags
);
1475 error
= idr_alloc(&sg_index_idr
, sdp
, 0, SG_MAX_DEVS
, GFP_NOWAIT
);
1477 if (error
== -ENOSPC
) {
1478 sdev_printk(KERN_WARNING
, scsidp
,
1479 "Unable to attach sg device type=%d, minor number exceeds %d\n",
1480 scsidp
->type
, SG_MAX_DEVS
- 1);
1483 sdev_printk(KERN_WARNING
, scsidp
, "%s: idr "
1484 "allocation Sg_device failure: %d\n",
1491 SCSI_LOG_TIMEOUT(3, sdev_printk(KERN_INFO
, scsidp
,
1492 "sg_alloc: dev=%d \n", k
));
1493 sprintf(disk
->disk_name
, "sg%d", k
);
1494 disk
->first_minor
= k
;
1496 sdp
->device
= scsidp
;
1497 mutex_init(&sdp
->open_rel_lock
);
1498 INIT_LIST_HEAD(&sdp
->sfds
);
1499 init_waitqueue_head(&sdp
->open_wait
);
1500 atomic_set(&sdp
->detaching
, 0);
1501 rwlock_init(&sdp
->sfd_lock
);
1502 sdp
->sg_tablesize
= queue_max_segments(q
);
1504 kref_init(&sdp
->d_ref
);
1508 write_unlock_irqrestore(&sg_index_lock
, iflags
);
1513 return ERR_PTR(error
);
1519 sg_add_device(struct device
*cl_dev
, struct class_interface
*cl_intf
)
1521 struct scsi_device
*scsidp
= to_scsi_device(cl_dev
->parent
);
1522 struct gendisk
*disk
;
1523 Sg_device
*sdp
= NULL
;
1524 struct cdev
* cdev
= NULL
;
1526 unsigned long iflags
;
1528 disk
= alloc_disk(1);
1530 pr_warn("%s: alloc_disk failed\n", __func__
);
1533 disk
->major
= SCSI_GENERIC_MAJOR
;
1536 cdev
= cdev_alloc();
1538 pr_warn("%s: cdev_alloc failed\n", __func__
);
1541 cdev
->owner
= THIS_MODULE
;
1542 cdev
->ops
= &sg_fops
;
1544 sdp
= sg_alloc(disk
, scsidp
);
1546 pr_warn("%s: sg_alloc failed\n", __func__
);
1547 error
= PTR_ERR(sdp
);
1551 error
= cdev_add(cdev
, MKDEV(SCSI_GENERIC_MAJOR
, sdp
->index
), 1);
1556 if (sg_sysfs_valid
) {
1557 struct device
*sg_class_member
;
1559 sg_class_member
= device_create(sg_sysfs_class
, cl_dev
->parent
,
1560 MKDEV(SCSI_GENERIC_MAJOR
,
1562 sdp
, "%s", disk
->disk_name
);
1563 if (IS_ERR(sg_class_member
)) {
1564 pr_err("%s: device_create failed\n", __func__
);
1565 error
= PTR_ERR(sg_class_member
);
1568 error
= sysfs_create_link(&scsidp
->sdev_gendev
.kobj
,
1569 &sg_class_member
->kobj
, "generic");
1571 pr_err("%s: unable to make symlink 'generic' back "
1572 "to sg%d\n", __func__
, sdp
->index
);
1574 pr_warn("%s: sg_sys Invalid\n", __func__
);
1576 sdev_printk(KERN_NOTICE
, scsidp
, "Attached scsi generic sg%d "
1577 "type %d\n", sdp
->index
, scsidp
->type
);
1579 dev_set_drvdata(cl_dev
, sdp
);
1584 write_lock_irqsave(&sg_index_lock
, iflags
);
1585 idr_remove(&sg_index_idr
, sdp
->index
);
1586 write_unlock_irqrestore(&sg_index_lock
, iflags
);
1597 sg_device_destroy(struct kref
*kref
)
1599 struct sg_device
*sdp
= container_of(kref
, struct sg_device
, d_ref
);
1600 unsigned long flags
;
1602 /* CAUTION! Note that the device can still be found via idr_find()
1603 * even though the refcount is 0. Therefore, do idr_remove() BEFORE
1604 * any other cleanup.
1607 write_lock_irqsave(&sg_index_lock
, flags
);
1608 idr_remove(&sg_index_idr
, sdp
->index
);
1609 write_unlock_irqrestore(&sg_index_lock
, flags
);
1612 sg_printk(KERN_INFO
, sdp
, "sg_device_destroy\n"));
1614 put_disk(sdp
->disk
);
1619 sg_remove_device(struct device
*cl_dev
, struct class_interface
*cl_intf
)
1621 struct scsi_device
*scsidp
= to_scsi_device(cl_dev
->parent
);
1622 Sg_device
*sdp
= dev_get_drvdata(cl_dev
);
1623 unsigned long iflags
;
1629 /* want sdp->detaching non-zero as soon as possible */
1630 val
= atomic_inc_return(&sdp
->detaching
);
1632 return; /* only want to do following once per device */
1634 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO
, sdp
,
1637 read_lock_irqsave(&sdp
->sfd_lock
, iflags
);
1638 list_for_each_entry(sfp
, &sdp
->sfds
, sfd_siblings
) {
1639 wake_up_interruptible_all(&sfp
->read_wait
);
1640 kill_fasync(&sfp
->async_qp
, SIGPOLL
, POLL_HUP
);
1642 wake_up_interruptible_all(&sdp
->open_wait
);
1643 read_unlock_irqrestore(&sdp
->sfd_lock
, iflags
);
1645 sysfs_remove_link(&scsidp
->sdev_gendev
.kobj
, "generic");
1646 device_destroy(sg_sysfs_class
, MKDEV(SCSI_GENERIC_MAJOR
, sdp
->index
));
1647 cdev_del(sdp
->cdev
);
1650 kref_put(&sdp
->d_ref
, sg_device_destroy
);
1653 module_param_named(scatter_elem_sz
, scatter_elem_sz
, int, S_IRUGO
| S_IWUSR
);
1654 module_param_named(def_reserved_size
, def_reserved_size
, int,
1656 module_param_named(allow_dio
, sg_allow_dio
, int, S_IRUGO
| S_IWUSR
);
1658 MODULE_AUTHOR("Douglas Gilbert");
1659 MODULE_DESCRIPTION("SCSI generic (sg) driver");
1660 MODULE_LICENSE("GPL");
1661 MODULE_VERSION(SG_VERSION_STR
);
1662 MODULE_ALIAS_CHARDEV_MAJOR(SCSI_GENERIC_MAJOR
);
1664 MODULE_PARM_DESC(scatter_elem_sz
, "scatter gather element "
1665 "size (default: max(SG_SCATTER_SZ, PAGE_SIZE))");
1666 MODULE_PARM_DESC(def_reserved_size
, "size of buffer reserved for each fd");
1667 MODULE_PARM_DESC(allow_dio
, "allow direct I/O (default: 0 (disallow))");
1674 if (scatter_elem_sz
< PAGE_SIZE
) {
1675 scatter_elem_sz
= PAGE_SIZE
;
1676 scatter_elem_sz_prev
= scatter_elem_sz
;
1678 if (def_reserved_size
>= 0)
1679 sg_big_buff
= def_reserved_size
;
1681 def_reserved_size
= sg_big_buff
;
1683 rc
= register_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR
, 0),
1687 sg_sysfs_class
= class_create(THIS_MODULE
, "scsi_generic");
1688 if ( IS_ERR(sg_sysfs_class
) ) {
1689 rc
= PTR_ERR(sg_sysfs_class
);
1693 rc
= scsi_register_interface(&sg_interface
);
1695 #ifdef CONFIG_SCSI_PROC_FS
1697 #endif /* CONFIG_SCSI_PROC_FS */
1700 class_destroy(sg_sysfs_class
);
1702 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR
, 0), SG_MAX_DEVS
);
1709 #ifdef CONFIG_SCSI_PROC_FS
1710 remove_proc_subtree("scsi/sg", NULL
);
1711 #endif /* CONFIG_SCSI_PROC_FS */
1712 scsi_unregister_interface(&sg_interface
);
1713 class_destroy(sg_sysfs_class
);
1715 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR
, 0),
1717 idr_destroy(&sg_index_idr
);
1721 sg_start_req(Sg_request
*srp
, unsigned char *cmd
)
1725 struct scsi_request
*req
;
1726 Sg_fd
*sfp
= srp
->parentfp
;
1727 sg_io_hdr_t
*hp
= &srp
->header
;
1728 int dxfer_len
= (int) hp
->dxfer_len
;
1729 int dxfer_dir
= hp
->dxfer_direction
;
1730 unsigned int iov_count
= hp
->iovec_count
;
1731 Sg_scatter_hold
*req_schp
= &srp
->data
;
1732 Sg_scatter_hold
*rsv_schp
= &sfp
->reserve
;
1733 struct request_queue
*q
= sfp
->parentdp
->device
->request_queue
;
1734 struct rq_map_data
*md
, map_data
;
1735 int rw
= hp
->dxfer_direction
== SG_DXFER_TO_DEV
? WRITE
: READ
;
1736 unsigned char *long_cmdp
= NULL
;
1738 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO
, sfp
->parentdp
,
1739 "sg_start_req: dxfer_len=%d\n",
1742 if (hp
->cmd_len
> BLK_MAX_CDB
) {
1743 long_cmdp
= kzalloc(hp
->cmd_len
, GFP_KERNEL
);
1751 * With scsi-mq enabled, there are a fixed number of preallocated
1752 * requests equal in number to shost->can_queue. If all of the
1753 * preallocated requests are already in use, then blk_get_request()
1754 * will sleep until an active command completes, freeing up a request.
1755 * Although waiting in an asynchronous interface is less than ideal, we
1756 * do not want to use BLK_MQ_REQ_NOWAIT here because userspace might
1757 * not expect an EWOULDBLOCK from this condition.
1759 rq
= blk_get_request(q
, hp
->dxfer_direction
== SG_DXFER_TO_DEV
?
1760 REQ_OP_SCSI_OUT
: REQ_OP_SCSI_IN
, 0);
1767 if (hp
->cmd_len
> BLK_MAX_CDB
)
1768 req
->cmd
= long_cmdp
;
1769 memcpy(req
->cmd
, cmd
, hp
->cmd_len
);
1770 req
->cmd_len
= hp
->cmd_len
;
1773 rq
->end_io_data
= srp
;
1774 req
->retries
= SG_DEFAULT_RETRIES
;
1776 if ((dxfer_len
<= 0) || (dxfer_dir
== SG_DXFER_NONE
))
1779 if (sg_allow_dio
&& hp
->flags
& SG_FLAG_DIRECT_IO
&&
1780 dxfer_dir
!= SG_DXFER_UNKNOWN
&& !iov_count
&&
1781 !sfp
->parentdp
->device
->host
->unchecked_isa_dma
&&
1782 blk_rq_aligned(q
, (unsigned long)hp
->dxferp
, dxfer_len
))
1788 mutex_lock(&sfp
->f_mutex
);
1789 if (dxfer_len
<= rsv_schp
->bufflen
&&
1791 sfp
->res_in_use
= 1;
1792 sg_link_reserve(sfp
, srp
, dxfer_len
);
1793 } else if (hp
->flags
& SG_FLAG_MMAP_IO
) {
1794 res
= -EBUSY
; /* sfp->res_in_use == 1 */
1795 if (dxfer_len
> rsv_schp
->bufflen
)
1797 mutex_unlock(&sfp
->f_mutex
);
1800 res
= sg_build_indirect(req_schp
, sfp
, dxfer_len
);
1802 mutex_unlock(&sfp
->f_mutex
);
1806 mutex_unlock(&sfp
->f_mutex
);
1808 md
->pages
= req_schp
->pages
;
1809 md
->page_order
= req_schp
->page_order
;
1810 md
->nr_entries
= req_schp
->k_use_sg
;
1812 md
->null_mapped
= hp
->dxferp
? 0 : 1;
1813 if (dxfer_dir
== SG_DXFER_TO_FROM_DEV
)
1820 struct iovec
*iov
= NULL
;
1823 res
= import_iovec(rw
, hp
->dxferp
, iov_count
, 0, &iov
, &i
);
1827 iov_iter_truncate(&i
, hp
->dxfer_len
);
1828 if (!iov_iter_count(&i
)) {
1833 res
= blk_rq_map_user_iov(q
, rq
, md
, &i
, GFP_ATOMIC
);
1836 res
= blk_rq_map_user(q
, rq
, md
, hp
->dxferp
,
1837 hp
->dxfer_len
, GFP_ATOMIC
);
1843 req_schp
->dio_in_use
= 1;
1844 hp
->info
|= SG_INFO_DIRECT_IO
;
1851 sg_finish_rem_req(Sg_request
*srp
)
1855 Sg_fd
*sfp
= srp
->parentfp
;
1856 Sg_scatter_hold
*req_schp
= &srp
->data
;
1858 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO
, sfp
->parentdp
,
1859 "sg_finish_rem_req: res_used=%d\n",
1860 (int) srp
->res_used
));
1862 ret
= blk_rq_unmap_user(srp
->bio
);
1865 scsi_req_free_cmd(scsi_req(srp
->rq
));
1866 blk_put_request(srp
->rq
);
1870 sg_unlink_reserve(sfp
, srp
);
1872 sg_remove_scat(sfp
, req_schp
);
1878 sg_build_sgat(Sg_scatter_hold
* schp
, const Sg_fd
* sfp
, int tablesize
)
1880 int sg_bufflen
= tablesize
* sizeof(struct page
*);
1881 gfp_t gfp_flags
= GFP_ATOMIC
| __GFP_NOWARN
;
1883 schp
->pages
= kzalloc(sg_bufflen
, gfp_flags
);
1886 schp
->sglist_len
= sg_bufflen
;
1887 return tablesize
; /* number of scat_gath elements allocated */
1891 sg_build_indirect(Sg_scatter_hold
* schp
, Sg_fd
* sfp
, int buff_size
)
1893 int ret_sz
= 0, i
, k
, rem_sz
, num
, mx_sc_elems
;
1894 int sg_tablesize
= sfp
->parentdp
->sg_tablesize
;
1895 int blk_size
= buff_size
, order
;
1896 gfp_t gfp_mask
= GFP_ATOMIC
| __GFP_COMP
| __GFP_NOWARN
| __GFP_ZERO
;
1897 struct sg_device
*sdp
= sfp
->parentdp
;
1902 ++blk_size
; /* don't know why */
1903 /* round request up to next highest SG_SECTOR_SZ byte boundary */
1904 blk_size
= ALIGN(blk_size
, SG_SECTOR_SZ
);
1905 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO
, sfp
->parentdp
,
1906 "sg_build_indirect: buff_size=%d, blk_size=%d\n",
1907 buff_size
, blk_size
));
1909 /* N.B. ret_sz carried into this block ... */
1910 mx_sc_elems
= sg_build_sgat(schp
, sfp
, sg_tablesize
);
1911 if (mx_sc_elems
< 0)
1912 return mx_sc_elems
; /* most likely -ENOMEM */
1914 num
= scatter_elem_sz
;
1915 if (unlikely(num
!= scatter_elem_sz_prev
)) {
1916 if (num
< PAGE_SIZE
) {
1917 scatter_elem_sz
= PAGE_SIZE
;
1918 scatter_elem_sz_prev
= PAGE_SIZE
;
1920 scatter_elem_sz_prev
= num
;
1923 if (sdp
->device
->host
->unchecked_isa_dma
)
1924 gfp_mask
|= GFP_DMA
;
1926 order
= get_order(num
);
1928 ret_sz
= 1 << (PAGE_SHIFT
+ order
);
1930 for (k
= 0, rem_sz
= blk_size
; rem_sz
> 0 && k
< mx_sc_elems
;
1931 k
++, rem_sz
-= ret_sz
) {
1933 num
= (rem_sz
> scatter_elem_sz_prev
) ?
1934 scatter_elem_sz_prev
: rem_sz
;
1936 schp
->pages
[k
] = alloc_pages(gfp_mask
, order
);
1937 if (!schp
->pages
[k
])
1940 if (num
== scatter_elem_sz_prev
) {
1941 if (unlikely(ret_sz
> scatter_elem_sz_prev
)) {
1942 scatter_elem_sz
= ret_sz
;
1943 scatter_elem_sz_prev
= ret_sz
;
1947 SCSI_LOG_TIMEOUT(5, sg_printk(KERN_INFO
, sfp
->parentdp
,
1948 "sg_build_indirect: k=%d, num=%d, ret_sz=%d\n",
1950 } /* end of for loop */
1952 schp
->page_order
= order
;
1954 SCSI_LOG_TIMEOUT(5, sg_printk(KERN_INFO
, sfp
->parentdp
,
1955 "sg_build_indirect: k_use_sg=%d, rem_sz=%d\n",
1958 schp
->bufflen
= blk_size
;
1959 if (rem_sz
> 0) /* must have failed */
1963 for (i
= 0; i
< k
; i
++)
1964 __free_pages(schp
->pages
[i
], order
);
1973 sg_remove_scat(Sg_fd
* sfp
, Sg_scatter_hold
* schp
)
1975 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO
, sfp
->parentdp
,
1976 "sg_remove_scat: k_use_sg=%d\n", schp
->k_use_sg
));
1977 if (schp
->pages
&& schp
->sglist_len
> 0) {
1978 if (!schp
->dio_in_use
) {
1981 for (k
= 0; k
< schp
->k_use_sg
&& schp
->pages
[k
]; k
++) {
1983 sg_printk(KERN_INFO
, sfp
->parentdp
,
1984 "sg_remove_scat: k=%d, pg=0x%p\n",
1985 k
, schp
->pages
[k
]));
1986 __free_pages(schp
->pages
[k
], schp
->page_order
);
1992 memset(schp
, 0, sizeof (*schp
));
1996 sg_read_oxfer(Sg_request
* srp
, char __user
*outp
, int num_read_xfer
)
1998 Sg_scatter_hold
*schp
= &srp
->data
;
2001 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO
, srp
->parentfp
->parentdp
,
2002 "sg_read_oxfer: num_read_xfer=%d\n",
2004 if ((!outp
) || (num_read_xfer
<= 0))
2007 num
= 1 << (PAGE_SHIFT
+ schp
->page_order
);
2008 for (k
= 0; k
< schp
->k_use_sg
&& schp
->pages
[k
]; k
++) {
2009 if (num
> num_read_xfer
) {
2010 if (copy_to_user(outp
, page_address(schp
->pages
[k
]),
2015 if (copy_to_user(outp
, page_address(schp
->pages
[k
]),
2018 num_read_xfer
-= num
;
2019 if (num_read_xfer
<= 0)
2029 sg_build_reserve(Sg_fd
* sfp
, int req_size
)
2031 Sg_scatter_hold
*schp
= &sfp
->reserve
;
2033 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO
, sfp
->parentdp
,
2034 "sg_build_reserve: req_size=%d\n", req_size
));
2036 if (req_size
< PAGE_SIZE
)
2037 req_size
= PAGE_SIZE
;
2038 if (0 == sg_build_indirect(schp
, sfp
, req_size
))
2041 sg_remove_scat(sfp
, schp
);
2042 req_size
>>= 1; /* divide by 2 */
2043 } while (req_size
> (PAGE_SIZE
/ 2));
2047 sg_link_reserve(Sg_fd
* sfp
, Sg_request
* srp
, int size
)
2049 Sg_scatter_hold
*req_schp
= &srp
->data
;
2050 Sg_scatter_hold
*rsv_schp
= &sfp
->reserve
;
2054 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO
, sfp
->parentdp
,
2055 "sg_link_reserve: size=%d\n", size
));
2058 num
= 1 << (PAGE_SHIFT
+ rsv_schp
->page_order
);
2059 for (k
= 0; k
< rsv_schp
->k_use_sg
; k
++) {
2061 req_schp
->k_use_sg
= k
+ 1;
2062 req_schp
->sglist_len
= rsv_schp
->sglist_len
;
2063 req_schp
->pages
= rsv_schp
->pages
;
2065 req_schp
->bufflen
= size
;
2066 req_schp
->page_order
= rsv_schp
->page_order
;
2072 if (k
>= rsv_schp
->k_use_sg
)
2073 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO
, sfp
->parentdp
,
2074 "sg_link_reserve: BAD size\n"));
2078 sg_unlink_reserve(Sg_fd
* sfp
, Sg_request
* srp
)
2080 Sg_scatter_hold
*req_schp
= &srp
->data
;
2082 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO
, srp
->parentfp
->parentdp
,
2083 "sg_unlink_reserve: req->k_use_sg=%d\n",
2084 (int) req_schp
->k_use_sg
));
2085 req_schp
->k_use_sg
= 0;
2086 req_schp
->bufflen
= 0;
2087 req_schp
->pages
= NULL
;
2088 req_schp
->page_order
= 0;
2089 req_schp
->sglist_len
= 0;
2091 /* Called without mutex lock to avoid deadlock */
2092 sfp
->res_in_use
= 0;
2096 sg_get_rq_mark(Sg_fd
* sfp
, int pack_id
)
2099 unsigned long iflags
;
2101 write_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
2102 list_for_each_entry(resp
, &sfp
->rq_list
, entry
) {
2103 /* look for requests that are ready + not SG_IO owned */
2104 if ((1 == resp
->done
) && (!resp
->sg_io_owned
) &&
2105 ((-1 == pack_id
) || (resp
->header
.pack_id
== pack_id
))) {
2106 resp
->done
= 2; /* guard against other readers */
2107 write_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
2111 write_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
2115 /* always adds to end of list */
2117 sg_add_request(Sg_fd
* sfp
)
2120 unsigned long iflags
;
2121 Sg_request
*rp
= sfp
->req_arr
;
2123 write_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
2124 if (!list_empty(&sfp
->rq_list
)) {
2128 for (k
= 0; k
< SG_MAX_QUEUE
; ++k
, ++rp
) {
2132 if (k
>= SG_MAX_QUEUE
)
2135 memset(rp
, 0, sizeof (Sg_request
));
2137 rp
->header
.duration
= jiffies_to_msecs(jiffies
);
2138 list_add_tail(&rp
->entry
, &sfp
->rq_list
);
2139 write_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
2142 write_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
2146 /* Return of 1 for found; 0 for not found */
2148 sg_remove_request(Sg_fd
* sfp
, Sg_request
* srp
)
2150 unsigned long iflags
;
2153 if (!sfp
|| !srp
|| list_empty(&sfp
->rq_list
))
2155 write_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
2156 if (!list_empty(&srp
->entry
)) {
2157 list_del(&srp
->entry
);
2158 srp
->parentfp
= NULL
;
2161 write_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
2166 sg_add_sfp(Sg_device
* sdp
)
2169 unsigned long iflags
;
2172 sfp
= kzalloc(sizeof(*sfp
), GFP_ATOMIC
| __GFP_NOWARN
);
2174 return ERR_PTR(-ENOMEM
);
2176 init_waitqueue_head(&sfp
->read_wait
);
2177 rwlock_init(&sfp
->rq_list_lock
);
2178 INIT_LIST_HEAD(&sfp
->rq_list
);
2179 kref_init(&sfp
->f_ref
);
2180 mutex_init(&sfp
->f_mutex
);
2181 sfp
->timeout
= SG_DEFAULT_TIMEOUT
;
2182 sfp
->timeout_user
= SG_DEFAULT_TIMEOUT_USER
;
2183 sfp
->force_packid
= SG_DEF_FORCE_PACK_ID
;
2184 sfp
->cmd_q
= SG_DEF_COMMAND_Q
;
2185 sfp
->keep_orphan
= SG_DEF_KEEP_ORPHAN
;
2186 sfp
->parentdp
= sdp
;
2187 write_lock_irqsave(&sdp
->sfd_lock
, iflags
);
2188 if (atomic_read(&sdp
->detaching
)) {
2189 write_unlock_irqrestore(&sdp
->sfd_lock
, iflags
);
2191 return ERR_PTR(-ENODEV
);
2193 list_add_tail(&sfp
->sfd_siblings
, &sdp
->sfds
);
2194 write_unlock_irqrestore(&sdp
->sfd_lock
, iflags
);
2195 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO
, sdp
,
2196 "sg_add_sfp: sfp=0x%p\n", sfp
));
2197 if (unlikely(sg_big_buff
!= def_reserved_size
))
2198 sg_big_buff
= def_reserved_size
;
2200 bufflen
= min_t(int, sg_big_buff
,
2201 max_sectors_bytes(sdp
->device
->request_queue
));
2202 sg_build_reserve(sfp
, bufflen
);
2203 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO
, sdp
,
2204 "sg_add_sfp: bufflen=%d, k_use_sg=%d\n",
2205 sfp
->reserve
.bufflen
,
2206 sfp
->reserve
.k_use_sg
));
2208 kref_get(&sdp
->d_ref
);
2209 __module_get(THIS_MODULE
);
2214 sg_remove_sfp_usercontext(struct work_struct
*work
)
2216 struct sg_fd
*sfp
= container_of(work
, struct sg_fd
, ew
.work
);
2217 struct sg_device
*sdp
= sfp
->parentdp
;
2219 unsigned long iflags
;
2221 /* Cleanup any responses which were never read(). */
2222 write_lock_irqsave(&sfp
->rq_list_lock
, iflags
);
2223 while (!list_empty(&sfp
->rq_list
)) {
2224 srp
= list_first_entry(&sfp
->rq_list
, Sg_request
, entry
);
2225 sg_finish_rem_req(srp
);
2226 list_del(&srp
->entry
);
2227 srp
->parentfp
= NULL
;
2229 write_unlock_irqrestore(&sfp
->rq_list_lock
, iflags
);
2231 if (sfp
->reserve
.bufflen
> 0) {
2232 SCSI_LOG_TIMEOUT(6, sg_printk(KERN_INFO
, sdp
,
2233 "sg_remove_sfp: bufflen=%d, k_use_sg=%d\n",
2234 (int) sfp
->reserve
.bufflen
,
2235 (int) sfp
->reserve
.k_use_sg
));
2236 sg_remove_scat(sfp
, &sfp
->reserve
);
2239 SCSI_LOG_TIMEOUT(6, sg_printk(KERN_INFO
, sdp
,
2240 "sg_remove_sfp: sfp=0x%p\n", sfp
));
2243 scsi_device_put(sdp
->device
);
2244 kref_put(&sdp
->d_ref
, sg_device_destroy
);
2245 module_put(THIS_MODULE
);
2249 sg_remove_sfp(struct kref
*kref
)
2251 struct sg_fd
*sfp
= container_of(kref
, struct sg_fd
, f_ref
);
2252 struct sg_device
*sdp
= sfp
->parentdp
;
2253 unsigned long iflags
;
2255 write_lock_irqsave(&sdp
->sfd_lock
, iflags
);
2256 list_del(&sfp
->sfd_siblings
);
2257 write_unlock_irqrestore(&sdp
->sfd_lock
, iflags
);
2259 INIT_WORK(&sfp
->ew
.work
, sg_remove_sfp_usercontext
);
2260 schedule_work(&sfp
->ew
.work
);
2263 #ifdef CONFIG_SCSI_PROC_FS
2265 sg_idr_max_id(int id
, void *p
, void *data
)
2279 unsigned long iflags
;
2281 read_lock_irqsave(&sg_index_lock
, iflags
);
2282 idr_for_each(&sg_index_idr
, sg_idr_max_id
, &k
);
2283 read_unlock_irqrestore(&sg_index_lock
, iflags
);
2284 return k
+ 1; /* origin 1 */
2288 /* must be called with sg_index_lock held */
2289 static Sg_device
*sg_lookup_dev(int dev
)
2291 return idr_find(&sg_index_idr
, dev
);
2297 struct sg_device
*sdp
;
2298 unsigned long flags
;
2300 read_lock_irqsave(&sg_index_lock
, flags
);
2301 sdp
= sg_lookup_dev(dev
);
2303 sdp
= ERR_PTR(-ENXIO
);
2304 else if (atomic_read(&sdp
->detaching
)) {
2305 /* If sdp->detaching, then the refcount may already be 0, in
2306 * which case it would be a bug to do kref_get().
2308 sdp
= ERR_PTR(-ENODEV
);
2310 kref_get(&sdp
->d_ref
);
2311 read_unlock_irqrestore(&sg_index_lock
, flags
);
2316 #ifdef CONFIG_SCSI_PROC_FS
2317 static int sg_proc_seq_show_int(struct seq_file
*s
, void *v
);
2319 static int sg_proc_single_open_adio(struct inode
*inode
, struct file
*file
);
2320 static ssize_t
sg_proc_write_adio(struct file
*filp
, const char __user
*buffer
,
2321 size_t count
, loff_t
*off
);
2322 static const struct proc_ops adio_proc_ops
= {
2323 .proc_open
= sg_proc_single_open_adio
,
2324 .proc_read
= seq_read
,
2325 .proc_lseek
= seq_lseek
,
2326 .proc_write
= sg_proc_write_adio
,
2327 .proc_release
= single_release
,
2330 static int sg_proc_single_open_dressz(struct inode
*inode
, struct file
*file
);
2331 static ssize_t
sg_proc_write_dressz(struct file
*filp
,
2332 const char __user
*buffer
, size_t count
, loff_t
*off
);
2333 static const struct proc_ops dressz_proc_ops
= {
2334 .proc_open
= sg_proc_single_open_dressz
,
2335 .proc_read
= seq_read
,
2336 .proc_lseek
= seq_lseek
,
2337 .proc_write
= sg_proc_write_dressz
,
2338 .proc_release
= single_release
,
2341 static int sg_proc_seq_show_version(struct seq_file
*s
, void *v
);
2342 static int sg_proc_seq_show_devhdr(struct seq_file
*s
, void *v
);
2343 static int sg_proc_seq_show_dev(struct seq_file
*s
, void *v
);
2344 static void * dev_seq_start(struct seq_file
*s
, loff_t
*pos
);
2345 static void * dev_seq_next(struct seq_file
*s
, void *v
, loff_t
*pos
);
2346 static void dev_seq_stop(struct seq_file
*s
, void *v
);
2347 static const struct seq_operations dev_seq_ops
= {
2348 .start
= dev_seq_start
,
2349 .next
= dev_seq_next
,
2350 .stop
= dev_seq_stop
,
2351 .show
= sg_proc_seq_show_dev
,
2354 static int sg_proc_seq_show_devstrs(struct seq_file
*s
, void *v
);
2355 static const struct seq_operations devstrs_seq_ops
= {
2356 .start
= dev_seq_start
,
2357 .next
= dev_seq_next
,
2358 .stop
= dev_seq_stop
,
2359 .show
= sg_proc_seq_show_devstrs
,
2362 static int sg_proc_seq_show_debug(struct seq_file
*s
, void *v
);
2363 static const struct seq_operations debug_seq_ops
= {
2364 .start
= dev_seq_start
,
2365 .next
= dev_seq_next
,
2366 .stop
= dev_seq_stop
,
2367 .show
= sg_proc_seq_show_debug
,
2373 struct proc_dir_entry
*p
;
2375 p
= proc_mkdir("scsi/sg", NULL
);
2379 proc_create("allow_dio", S_IRUGO
| S_IWUSR
, p
, &adio_proc_ops
);
2380 proc_create_seq("debug", S_IRUGO
, p
, &debug_seq_ops
);
2381 proc_create("def_reserved_size", S_IRUGO
| S_IWUSR
, p
, &dressz_proc_ops
);
2382 proc_create_single("device_hdr", S_IRUGO
, p
, sg_proc_seq_show_devhdr
);
2383 proc_create_seq("devices", S_IRUGO
, p
, &dev_seq_ops
);
2384 proc_create_seq("device_strs", S_IRUGO
, p
, &devstrs_seq_ops
);
2385 proc_create_single("version", S_IRUGO
, p
, sg_proc_seq_show_version
);
2390 static int sg_proc_seq_show_int(struct seq_file
*s
, void *v
)
2392 seq_printf(s
, "%d\n", *((int *)s
->private));
2396 static int sg_proc_single_open_adio(struct inode
*inode
, struct file
*file
)
2398 return single_open(file
, sg_proc_seq_show_int
, &sg_allow_dio
);
2402 sg_proc_write_adio(struct file
*filp
, const char __user
*buffer
,
2403 size_t count
, loff_t
*off
)
2408 if (!capable(CAP_SYS_ADMIN
) || !capable(CAP_SYS_RAWIO
))
2410 err
= kstrtoul_from_user(buffer
, count
, 0, &num
);
2413 sg_allow_dio
= num
? 1 : 0;
2417 static int sg_proc_single_open_dressz(struct inode
*inode
, struct file
*file
)
2419 return single_open(file
, sg_proc_seq_show_int
, &sg_big_buff
);
2423 sg_proc_write_dressz(struct file
*filp
, const char __user
*buffer
,
2424 size_t count
, loff_t
*off
)
2427 unsigned long k
= ULONG_MAX
;
2429 if (!capable(CAP_SYS_ADMIN
) || !capable(CAP_SYS_RAWIO
))
2432 err
= kstrtoul_from_user(buffer
, count
, 0, &k
);
2435 if (k
<= 1048576) { /* limit "big buff" to 1 MB */
2442 static int sg_proc_seq_show_version(struct seq_file
*s
, void *v
)
2444 seq_printf(s
, "%d\t%s [%s]\n", sg_version_num
, SG_VERSION_STR
,
2449 static int sg_proc_seq_show_devhdr(struct seq_file
*s
, void *v
)
2451 seq_puts(s
, "host\tchan\tid\tlun\ttype\topens\tqdepth\tbusy\tonline\n");
2455 struct sg_proc_deviter
{
2460 static void * dev_seq_start(struct seq_file
*s
, loff_t
*pos
)
2462 struct sg_proc_deviter
* it
= kmalloc(sizeof(*it
), GFP_KERNEL
);
2469 it
->max
= sg_last_dev();
2470 if (it
->index
>= it
->max
)
2475 static void * dev_seq_next(struct seq_file
*s
, void *v
, loff_t
*pos
)
2477 struct sg_proc_deviter
* it
= s
->private;
2480 return (it
->index
< it
->max
) ? it
: NULL
;
2483 static void dev_seq_stop(struct seq_file
*s
, void *v
)
2488 static int sg_proc_seq_show_dev(struct seq_file
*s
, void *v
)
2490 struct sg_proc_deviter
* it
= (struct sg_proc_deviter
*) v
;
2492 struct scsi_device
*scsidp
;
2493 unsigned long iflags
;
2495 read_lock_irqsave(&sg_index_lock
, iflags
);
2496 sdp
= it
? sg_lookup_dev(it
->index
) : NULL
;
2497 if ((NULL
== sdp
) || (NULL
== sdp
->device
) ||
2498 (atomic_read(&sdp
->detaching
)))
2499 seq_puts(s
, "-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\n");
2501 scsidp
= sdp
->device
;
2502 seq_printf(s
, "%d\t%d\t%d\t%llu\t%d\t%d\t%d\t%d\t%d\n",
2503 scsidp
->host
->host_no
, scsidp
->channel
,
2504 scsidp
->id
, scsidp
->lun
, (int) scsidp
->type
,
2506 (int) scsidp
->queue_depth
,
2507 (int) atomic_read(&scsidp
->device_busy
),
2508 (int) scsi_device_online(scsidp
));
2510 read_unlock_irqrestore(&sg_index_lock
, iflags
);
2514 static int sg_proc_seq_show_devstrs(struct seq_file
*s
, void *v
)
2516 struct sg_proc_deviter
* it
= (struct sg_proc_deviter
*) v
;
2518 struct scsi_device
*scsidp
;
2519 unsigned long iflags
;
2521 read_lock_irqsave(&sg_index_lock
, iflags
);
2522 sdp
= it
? sg_lookup_dev(it
->index
) : NULL
;
2523 scsidp
= sdp
? sdp
->device
: NULL
;
2524 if (sdp
&& scsidp
&& (!atomic_read(&sdp
->detaching
)))
2525 seq_printf(s
, "%8.8s\t%16.16s\t%4.4s\n",
2526 scsidp
->vendor
, scsidp
->model
, scsidp
->rev
);
2528 seq_puts(s
, "<no active device>\n");
2529 read_unlock_irqrestore(&sg_index_lock
, iflags
);
2533 /* must be called while holding sg_index_lock */
2534 static void sg_proc_debug_helper(struct seq_file
*s
, Sg_device
* sdp
)
2536 int k
, new_interface
, blen
, usg
;
2539 const sg_io_hdr_t
*hp
;
2544 list_for_each_entry(fp
, &sdp
->sfds
, sfd_siblings
) {
2546 read_lock(&fp
->rq_list_lock
); /* irqs already disabled */
2547 seq_printf(s
, " FD(%d): timeout=%dms bufflen=%d "
2548 "(res)sgat=%d low_dma=%d\n", k
,
2549 jiffies_to_msecs(fp
->timeout
),
2550 fp
->reserve
.bufflen
,
2551 (int) fp
->reserve
.k_use_sg
,
2552 (int) sdp
->device
->host
->unchecked_isa_dma
);
2553 seq_printf(s
, " cmd_q=%d f_packid=%d k_orphan=%d closed=0\n",
2554 (int) fp
->cmd_q
, (int) fp
->force_packid
,
2555 (int) fp
->keep_orphan
);
2556 list_for_each_entry(srp
, &fp
->rq_list
, entry
) {
2558 new_interface
= (hp
->interface_id
== '\0') ? 0 : 1;
2559 if (srp
->res_used
) {
2560 if (new_interface
&&
2561 (SG_FLAG_MMAP_IO
& hp
->flags
))
2566 if (SG_INFO_DIRECT_IO_MASK
& hp
->info
)
2572 blen
= srp
->data
.bufflen
;
2573 usg
= srp
->data
.k_use_sg
;
2574 seq_puts(s
, srp
->done
?
2575 ((1 == srp
->done
) ? "rcv:" : "fin:")
2577 seq_printf(s
, " id=%d blen=%d",
2578 srp
->header
.pack_id
, blen
);
2580 seq_printf(s
, " dur=%d", hp
->duration
);
2582 ms
= jiffies_to_msecs(jiffies
);
2583 seq_printf(s
, " t_o/elap=%d/%d",
2584 (new_interface
? hp
->timeout
:
2585 jiffies_to_msecs(fp
->timeout
)),
2586 (ms
> hp
->duration
? ms
- hp
->duration
: 0));
2588 seq_printf(s
, "ms sgat=%d op=0x%02x\n", usg
,
2589 (int) srp
->data
.cmd_opcode
);
2591 if (list_empty(&fp
->rq_list
))
2592 seq_puts(s
, " No requests active\n");
2593 read_unlock(&fp
->rq_list_lock
);
2597 static int sg_proc_seq_show_debug(struct seq_file
*s
, void *v
)
2599 struct sg_proc_deviter
* it
= (struct sg_proc_deviter
*) v
;
2601 unsigned long iflags
;
2603 if (it
&& (0 == it
->index
))
2604 seq_printf(s
, "max_active_device=%d def_reserved_size=%d\n",
2605 (int)it
->max
, sg_big_buff
);
2607 read_lock_irqsave(&sg_index_lock
, iflags
);
2608 sdp
= it
? sg_lookup_dev(it
->index
) : NULL
;
2611 read_lock(&sdp
->sfd_lock
);
2612 if (!list_empty(&sdp
->sfds
)) {
2613 seq_printf(s
, " >>> device=%s ", sdp
->disk
->disk_name
);
2614 if (atomic_read(&sdp
->detaching
))
2615 seq_puts(s
, "detaching pending close ");
2616 else if (sdp
->device
) {
2617 struct scsi_device
*scsidp
= sdp
->device
;
2619 seq_printf(s
, "%d:%d:%d:%llu em=%d",
2620 scsidp
->host
->host_no
,
2621 scsidp
->channel
, scsidp
->id
,
2623 scsidp
->host
->hostt
->emulated
);
2625 seq_printf(s
, " sg_tablesize=%d excl=%d open_cnt=%d\n",
2626 sdp
->sg_tablesize
, sdp
->exclude
, sdp
->open_cnt
);
2627 sg_proc_debug_helper(s
, sdp
);
2629 read_unlock(&sdp
->sfd_lock
);
2631 read_unlock_irqrestore(&sg_index_lock
, iflags
);
2635 #endif /* CONFIG_SCSI_PROC_FS */
2637 module_init(init_sg
);
2638 module_exit(exit_sg
);