3 * Started: Aug 9 by Lawrence Foard (entropy@world.std.com),
4 * to allow user process control of SCSI devices.
5 * Development Sponsored by Killy Corp. NY NY
7 * Original driver (sg.c):
8 * Copyright (C) 1992 Lawrence Foard
9 * Version 2 and 3 extensions to driver:
10 * Copyright (C) 1998 - 2005 Douglas Gilbert
12 * Modified 19-JAN-1998 Richard Gooch <rgooch@atnf.csiro.au> Devfs support
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2, or (at your option)
21 static int sg_version_num = 30534; /* 2 digits for each component */
22 #define SG_VERSION_STR "3.5.34"
25 * D. P. Gilbert (dgilbert@interlog.com, dougg@triode.net.au), notes:
26 * - scsi logging is available via SCSI_LOG_TIMEOUT macros. First
27 * the kernel/module needs to be built with CONFIG_SCSI_LOGGING
28 * (otherwise the macros compile to empty statements).
31 #include <linux/module.h>
34 #include <linux/kernel.h>
35 #include <linux/sched.h>
36 #include <linux/string.h>
38 #include <linux/errno.h>
39 #include <linux/mtio.h>
40 #include <linux/ioctl.h>
41 #include <linux/fcntl.h>
42 #include <linux/init.h>
43 #include <linux/poll.h>
44 #include <linux/moduleparam.h>
45 #include <linux/cdev.h>
46 #include <linux/idr.h>
47 #include <linux/seq_file.h>
48 #include <linux/blkdev.h>
49 #include <linux/delay.h>
50 #include <linux/blktrace_api.h>
51 #include <linux/smp_lock.h>
54 #include <scsi/scsi_dbg.h>
55 #include <scsi/scsi_host.h>
56 #include <scsi/scsi_driver.h>
57 #include <scsi/scsi_ioctl.h>
60 #include "scsi_logging.h"
62 #ifdef CONFIG_SCSI_PROC_FS
63 #include <linux/proc_fs.h>
64 static char *sg_version_date = "20061027";
66 static int sg_proc_init(void);
67 static void sg_proc_cleanup(void);
70 #define SG_ALLOW_DIO_DEF 0
72 #define SG_MAX_DEVS 32768
75 * Suppose you want to calculate the formula muldiv(x,m,d)=int(x * m / d)
76 * Then when using 32 bit integers x * m may overflow during the calculation.
77 * Replacing muldiv(x) by muldiv(x)=((x % d) * m) / d + int(x / d) * m
78 * calculates the same, but prevents the overflow when both m and d
79 * are "small" numbers (like HZ and USER_HZ).
80 * Of course an overflow is inavoidable if the result of muldiv doesn't fit
83 #define MULDIV(X,MUL,DIV) ((((X % DIV) * MUL) / DIV) + ((X / DIV) * MUL))
85 #define SG_DEFAULT_TIMEOUT MULDIV(SG_DEFAULT_TIMEOUT_USER, HZ, USER_HZ)
87 int sg_big_buff = SG_DEF_RESERVED_SIZE;
88 /* N.B. This variable is readable and writeable via
89 /proc/scsi/sg/def_reserved_size . Each time sg_open() is called a buffer
90 of this size (or less if there is not enough memory) will be reserved
91 for use by this file descriptor. [Deprecated usage: this variable is also
92 readable via /proc/sys/kernel/sg-big-buff if the sg driver is built into
93 the kernel (i.e. it is not a module).] */
94 static int def_reserved_size = -1; /* picks up init parameter */
95 static int sg_allow_dio = SG_ALLOW_DIO_DEF;
97 static int scatter_elem_sz = SG_SCATTER_SZ;
98 static int scatter_elem_sz_prev = SG_SCATTER_SZ;
100 #define SG_SECTOR_SZ 512
101 #define SG_SECTOR_MSK (SG_SECTOR_SZ - 1)
103 static int sg_add(struct device *, struct class_interface *);
104 static void sg_device_destroy(struct kref *kref);
105 static void sg_remove(struct device *, struct class_interface *);
107 static DEFINE_IDR(sg_index_idr);
108 static DEFINE_RWLOCK(sg_index_lock); /* Also used to lock
109 file descriptor list for device */
111 static struct class_interface sg_interface = {
113 .remove_dev = sg_remove,
116 typedef struct sg_scatter_hold { /* holding area for scsi scatter gather info */
117 unsigned short k_use_sg; /* Count of kernel scatter-gather pieces */
118 unsigned sglist_len; /* size of malloc'd scatter-gather list ++ */
119 unsigned bufflen; /* Size of (aggregate) data buffer */
122 char dio_in_use; /* 0->indirect IO (or mmap), 1->dio */
123 unsigned char cmd_opcode; /* first byte of command */
126 struct sg_device; /* forward declarations */
129 typedef struct sg_request { /* SG_MAX_QUEUE requests outstanding per file */
130 struct sg_request *nextrp; /* NULL -> tail request (slist) */
131 struct sg_fd *parentfp; /* NULL -> not in use */
132 Sg_scatter_hold data; /* hold buffer, perhaps scatter list */
133 sg_io_hdr_t header; /* scsi command+info, see <scsi/sg.h> */
134 unsigned char sense_b[SCSI_SENSE_BUFFERSIZE];
135 char res_used; /* 1 -> using reserve buffer, 0 -> not ... */
136 char orphan; /* 1 -> drop on sight, 0 -> normal */
137 char sg_io_owned; /* 1 -> packet belongs to SG_IO */
138 volatile char done; /* 0->before bh, 1->before read, 2->read */
143 typedef struct sg_fd { /* holds the state of a file descriptor */
144 struct sg_fd *nextfp; /* NULL when last opened fd on this device */
145 struct sg_device *parentdp; /* owning device */
146 wait_queue_head_t read_wait; /* queue read until command done */
147 rwlock_t rq_list_lock; /* protect access to list in req_arr */
148 int timeout; /* defaults to SG_DEFAULT_TIMEOUT */
149 int timeout_user; /* defaults to SG_DEFAULT_TIMEOUT_USER */
150 Sg_scatter_hold reserve; /* buffer held for this file descriptor */
151 unsigned save_scat_len; /* original length of trunc. scat. element */
152 Sg_request *headrp; /* head of request slist, NULL->empty */
153 struct fasync_struct *async_qp; /* used by asynchronous notification */
154 Sg_request req_arr[SG_MAX_QUEUE]; /* used as singly-linked list */
155 char low_dma; /* as in parent but possibly overridden to 1 */
156 char force_packid; /* 1 -> pack_id input to read(), 0 -> ignored */
157 volatile char closed; /* 1 -> fd closed but request(s) outstanding */
158 char cmd_q; /* 1 -> allow command queuing, 0 -> don't */
159 char next_cmd_len; /* 0 -> automatic (def), >0 -> use on next write() */
160 char keep_orphan; /* 0 -> drop orphan (def), 1 -> keep for read() */
161 char mmap_called; /* 0 -> mmap() never called on this fd */
163 struct execute_work ew;
166 typedef struct sg_device { /* holds the state of each scsi generic device */
167 struct scsi_device *device;
168 wait_queue_head_t o_excl_wait; /* queue open() when O_EXCL in use */
169 int sg_tablesize; /* adapter's max scatter-gather table size */
170 u32 index; /* device index number */
171 Sg_fd *headfp; /* first open fd belonging to this device */
172 volatile char detached; /* 0->attached, 1->detached pending removal */
173 volatile char exclude; /* opened for exclusive access */
174 char sgdebug; /* 0->off, 1->sense, 9->dump dev, 10-> all devs */
175 struct gendisk *disk;
176 struct cdev * cdev; /* char_dev [sysfs: /sys/cdev/major/sg<n>] */
180 static int sg_fasync(int fd, struct file *filp, int mode);
181 /* tasklet or soft irq callback */
182 static void sg_rq_end_io(struct request *rq, int uptodate);
183 static int sg_start_req(Sg_request *srp, unsigned char *cmd);
184 static void sg_finish_rem_req(Sg_request * srp);
185 static int sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size);
186 static int sg_build_sgat(Sg_scatter_hold * schp, const Sg_fd * sfp,
188 static ssize_t sg_new_read(Sg_fd * sfp, char __user *buf, size_t count,
190 static ssize_t sg_new_write(Sg_fd *sfp, struct file *file,
191 const char __user *buf, size_t count, int blocking,
192 int read_only, int sg_io_owned, Sg_request **o_srp);
193 static int sg_common_write(Sg_fd * sfp, Sg_request * srp,
194 unsigned char *cmnd, int timeout, int blocking);
195 static int sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer);
196 static void sg_remove_scat(Sg_scatter_hold * schp);
197 static void sg_build_reserve(Sg_fd * sfp, int req_size);
198 static void sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size);
199 static void sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp);
200 static Sg_fd *sg_add_sfp(Sg_device * sdp, int dev);
201 static void sg_remove_sfp(struct kref *);
202 static Sg_request *sg_get_rq_mark(Sg_fd * sfp, int pack_id);
203 static Sg_request *sg_add_request(Sg_fd * sfp);
204 static int sg_remove_request(Sg_fd * sfp, Sg_request * srp);
205 static int sg_res_in_use(Sg_fd * sfp);
206 static Sg_device *sg_lookup_dev(int dev);
207 static Sg_device *sg_get_dev(int dev);
208 static void sg_put_dev(Sg_device *sdp);
209 #ifdef CONFIG_SCSI_PROC_FS
210 static int sg_last_dev(void);
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 = (struct sg_fd *)filp->private_data;
221 struct request_queue *q = sfp->parentdp->device->request_queue;
223 if (sfp->parentdp->device->type == TYPE_SCANNER)
226 return blk_verify_command(&q->cmd_filter,
227 cmd, filp->f_mode & FMODE_WRITE);
231 sg_open(struct inode *inode, struct file *filp)
233 int dev = iminor(inode);
234 int flags = filp->f_flags;
235 struct request_queue *q;
242 nonseekable_open(inode, filp);
243 SCSI_LOG_TIMEOUT(3, printk("sg_open: dev=%d, flags=0x%x\n", dev, flags));
244 sdp = sg_get_dev(dev);
246 retval = PTR_ERR(sdp);
251 /* This driver's module count bumped by fops_get in <linux/fs.h> */
252 /* Prevent the device driver from vanishing while we sleep */
253 retval = scsi_device_get(sdp->device);
257 if (!((flags & O_NONBLOCK) ||
258 scsi_block_when_processing_errors(sdp->device))) {
260 /* we are in error recovery for this device */
264 if (flags & O_EXCL) {
265 if (O_RDONLY == (flags & O_ACCMODE)) {
266 retval = -EPERM; /* Can't lock it with read only access */
269 if (sdp->headfp && (flags & O_NONBLOCK)) {
274 __wait_event_interruptible(sdp->o_excl_wait,
275 ((sdp->headfp || sdp->exclude) ? 0 : (sdp->exclude = 1)), res);
277 retval = res; /* -ERESTARTSYS because signal hit process */
280 } else if (sdp->exclude) { /* some other fd has an exclusive lock on dev */
281 if (flags & O_NONBLOCK) {
286 __wait_event_interruptible(sdp->o_excl_wait, (!sdp->exclude),
289 retval = res; /* -ERESTARTSYS because signal hit process */
297 if (!sdp->headfp) { /* no existing opens on this device */
299 q = sdp->device->request_queue;
300 sdp->sg_tablesize = min(q->max_hw_segments,
301 q->max_phys_segments);
303 if ((sfp = sg_add_sfp(sdp, dev)))
304 filp->private_data = sfp;
306 if (flags & O_EXCL) {
307 sdp->exclude = 0; /* undo if error */
308 wake_up_interruptible(&sdp->o_excl_wait);
316 scsi_device_put(sdp->device);
324 /* Following function was formerly called 'sg_close' */
326 sg_release(struct inode *inode, struct file *filp)
331 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
333 SCSI_LOG_TIMEOUT(3, printk("sg_release: %s\n", sdp->disk->disk_name));
338 wake_up_interruptible(&sdp->o_excl_wait);
340 kref_put(&sfp->f_ref, sg_remove_sfp);
345 sg_read(struct file *filp, char __user *buf, size_t count, loff_t * ppos)
350 int req_pack_id = -1;
352 struct sg_header *old_hdr = NULL;
355 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
357 SCSI_LOG_TIMEOUT(3, printk("sg_read: %s, count=%d\n",
358 sdp->disk->disk_name, (int) count));
360 if (!access_ok(VERIFY_WRITE, buf, count))
362 if (sfp->force_packid && (count >= SZ_SG_HEADER)) {
363 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
366 if (__copy_from_user(old_hdr, buf, SZ_SG_HEADER)) {
370 if (old_hdr->reply_len < 0) {
371 if (count >= SZ_SG_IO_HDR) {
372 sg_io_hdr_t *new_hdr;
373 new_hdr = kmalloc(SZ_SG_IO_HDR, GFP_KERNEL);
378 retval =__copy_from_user
379 (new_hdr, buf, SZ_SG_IO_HDR);
380 req_pack_id = new_hdr->pack_id;
388 req_pack_id = old_hdr->pack_id;
390 srp = sg_get_rq_mark(sfp, req_pack_id);
391 if (!srp) { /* now wait on packet to arrive */
396 if (filp->f_flags & O_NONBLOCK) {
401 retval = 0; /* following macro beats race condition */
402 __wait_event_interruptible(sfp->read_wait,
404 (srp = sg_get_rq_mark(sfp, req_pack_id))),
413 /* -ERESTARTSYS as signal hit process */
417 if (srp->header.interface_id != '\0') {
418 retval = sg_new_read(sfp, buf, count, srp);
423 if (old_hdr == NULL) {
424 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
430 memset(old_hdr, 0, SZ_SG_HEADER);
431 old_hdr->reply_len = (int) hp->timeout;
432 old_hdr->pack_len = old_hdr->reply_len; /* old, strange behaviour */
433 old_hdr->pack_id = hp->pack_id;
434 old_hdr->twelve_byte =
435 ((srp->data.cmd_opcode >= 0xc0) && (12 == hp->cmd_len)) ? 1 : 0;
436 old_hdr->target_status = hp->masked_status;
437 old_hdr->host_status = hp->host_status;
438 old_hdr->driver_status = hp->driver_status;
439 if ((CHECK_CONDITION & hp->masked_status) ||
440 (DRIVER_SENSE & hp->driver_status))
441 memcpy(old_hdr->sense_buffer, srp->sense_b,
442 sizeof (old_hdr->sense_buffer));
443 switch (hp->host_status) {
444 /* This setup of 'result' is for backward compatibility and is best
445 ignored by the user who should use target, host + driver status */
447 case DID_PASSTHROUGH:
454 old_hdr->result = EBUSY;
461 old_hdr->result = EIO;
464 old_hdr->result = (srp->sense_b[0] == 0 &&
465 hp->masked_status == GOOD) ? 0 : EIO;
468 old_hdr->result = EIO;
472 /* Now copy the result back to the user buffer. */
473 if (count >= SZ_SG_HEADER) {
474 if (__copy_to_user(buf, old_hdr, SZ_SG_HEADER)) {
479 if (count > old_hdr->reply_len)
480 count = old_hdr->reply_len;
481 if (count > SZ_SG_HEADER) {
482 if (sg_read_oxfer(srp, buf, count - SZ_SG_HEADER)) {
488 count = (old_hdr->result == 0) ? 0 : -EIO;
489 sg_finish_rem_req(srp);
497 sg_new_read(Sg_fd * sfp, char __user *buf, size_t count, Sg_request * srp)
499 sg_io_hdr_t *hp = &srp->header;
503 if (count < SZ_SG_IO_HDR) {
508 if ((hp->mx_sb_len > 0) && hp->sbp) {
509 if ((CHECK_CONDITION & hp->masked_status) ||
510 (DRIVER_SENSE & hp->driver_status)) {
511 int sb_len = SCSI_SENSE_BUFFERSIZE;
512 sb_len = (hp->mx_sb_len > sb_len) ? sb_len : hp->mx_sb_len;
513 len = 8 + (int) srp->sense_b[7]; /* Additional sense length field */
514 len = (len > sb_len) ? sb_len : len;
515 if (copy_to_user(hp->sbp, srp->sense_b, len)) {
522 if (hp->masked_status || hp->host_status || hp->driver_status)
523 hp->info |= SG_INFO_CHECK;
524 if (copy_to_user(buf, hp, SZ_SG_IO_HDR)) {
529 sg_finish_rem_req(srp);
530 return (0 == err) ? count : err;
534 sg_write(struct file *filp, const char __user *buf, size_t count, loff_t * ppos)
536 int mxsize, cmd_size, k;
537 int input_size, blocking;
538 unsigned char opcode;
542 struct sg_header old_hdr;
544 unsigned char cmnd[MAX_COMMAND_SIZE];
546 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
548 SCSI_LOG_TIMEOUT(3, printk("sg_write: %s, count=%d\n",
549 sdp->disk->disk_name, (int) count));
552 if (!((filp->f_flags & O_NONBLOCK) ||
553 scsi_block_when_processing_errors(sdp->device)))
556 if (!access_ok(VERIFY_READ, buf, count))
557 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
558 if (count < SZ_SG_HEADER)
560 if (__copy_from_user(&old_hdr, buf, SZ_SG_HEADER))
562 blocking = !(filp->f_flags & O_NONBLOCK);
563 if (old_hdr.reply_len < 0)
564 return sg_new_write(sfp, filp, buf, count,
565 blocking, 0, 0, NULL);
566 if (count < (SZ_SG_HEADER + 6))
567 return -EIO; /* The minimum scsi command length is 6 bytes. */
569 if (!(srp = sg_add_request(sfp))) {
570 SCSI_LOG_TIMEOUT(1, printk("sg_write: queue full\n"));
574 __get_user(opcode, buf);
575 if (sfp->next_cmd_len > 0) {
576 if (sfp->next_cmd_len > MAX_COMMAND_SIZE) {
577 SCSI_LOG_TIMEOUT(1, printk("sg_write: command length too long\n"));
578 sfp->next_cmd_len = 0;
579 sg_remove_request(sfp, srp);
582 cmd_size = sfp->next_cmd_len;
583 sfp->next_cmd_len = 0; /* reset so only this write() effected */
585 cmd_size = COMMAND_SIZE(opcode); /* based on SCSI command group */
586 if ((opcode >= 0xc0) && old_hdr.twelve_byte)
589 SCSI_LOG_TIMEOUT(4, printk(
590 "sg_write: scsi opcode=0x%02x, cmd_size=%d\n", (int) opcode, cmd_size));
591 /* Determine buffer size. */
592 input_size = count - cmd_size;
593 mxsize = (input_size > old_hdr.reply_len) ? input_size : old_hdr.reply_len;
594 mxsize -= SZ_SG_HEADER;
595 input_size -= SZ_SG_HEADER;
596 if (input_size < 0) {
597 sg_remove_request(sfp, srp);
598 return -EIO; /* User did not pass enough bytes for this command. */
601 hp->interface_id = '\0'; /* indicator of old interface tunnelled */
602 hp->cmd_len = (unsigned char) cmd_size;
606 hp->dxfer_direction = (old_hdr.reply_len > SZ_SG_HEADER) ?
607 SG_DXFER_TO_FROM_DEV : SG_DXFER_TO_DEV;
609 hp->dxfer_direction = (mxsize > 0) ? SG_DXFER_FROM_DEV : SG_DXFER_NONE;
610 hp->dxfer_len = mxsize;
611 if (hp->dxfer_direction == SG_DXFER_TO_DEV)
612 hp->dxferp = (char __user *)buf + cmd_size;
616 hp->timeout = old_hdr.reply_len; /* structure abuse ... */
617 hp->flags = input_size; /* structure abuse ... */
618 hp->pack_id = old_hdr.pack_id;
620 if (__copy_from_user(cmnd, buf, cmd_size))
623 * SG_DXFER_TO_FROM_DEV is functionally equivalent to SG_DXFER_FROM_DEV,
624 * but is is possible that the app intended SG_DXFER_TO_DEV, because there
625 * is a non-zero input_size, so emit a warning.
627 if (hp->dxfer_direction == SG_DXFER_TO_FROM_DEV) {
628 static char cmd[TASK_COMM_LEN];
629 if (strcmp(current->comm, cmd) && printk_ratelimit()) {
631 "sg_write: data in/out %d/%d bytes for SCSI command 0x%x--"
632 "guessing data in;\n" KERN_WARNING " "
633 "program %s not setting count and/or reply_len properly\n",
634 old_hdr.reply_len - (int)SZ_SG_HEADER,
635 input_size, (unsigned int) cmnd[0],
637 strcpy(cmd, current->comm);
640 k = sg_common_write(sfp, srp, cmnd, sfp->timeout, blocking);
641 return (k < 0) ? k : count;
645 sg_new_write(Sg_fd *sfp, struct file *file, const char __user *buf,
646 size_t count, int blocking, int read_only, int sg_io_owned,
652 unsigned char cmnd[MAX_COMMAND_SIZE];
654 unsigned long ul_timeout;
656 if (count < SZ_SG_IO_HDR)
658 if (!access_ok(VERIFY_READ, buf, count))
659 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
661 sfp->cmd_q = 1; /* when sg_io_hdr seen, set command queuing on */
662 if (!(srp = sg_add_request(sfp))) {
663 SCSI_LOG_TIMEOUT(1, printk("sg_new_write: queue full\n"));
666 srp->sg_io_owned = sg_io_owned;
668 if (__copy_from_user(hp, buf, SZ_SG_IO_HDR)) {
669 sg_remove_request(sfp, srp);
672 if (hp->interface_id != 'S') {
673 sg_remove_request(sfp, srp);
676 if (hp->flags & SG_FLAG_MMAP_IO) {
677 if (hp->dxfer_len > sfp->reserve.bufflen) {
678 sg_remove_request(sfp, srp);
679 return -ENOMEM; /* MMAP_IO size must fit in reserve buffer */
681 if (hp->flags & SG_FLAG_DIRECT_IO) {
682 sg_remove_request(sfp, srp);
683 return -EINVAL; /* either MMAP_IO or DIRECT_IO (not both) */
685 if (sg_res_in_use(sfp)) {
686 sg_remove_request(sfp, srp);
687 return -EBUSY; /* reserve buffer already being used */
690 ul_timeout = msecs_to_jiffies(srp->header.timeout);
691 timeout = (ul_timeout < INT_MAX) ? ul_timeout : INT_MAX;
692 if ((!hp->cmdp) || (hp->cmd_len < 6) || (hp->cmd_len > sizeof (cmnd))) {
693 sg_remove_request(sfp, srp);
696 if (!access_ok(VERIFY_READ, hp->cmdp, hp->cmd_len)) {
697 sg_remove_request(sfp, srp);
698 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
700 if (__copy_from_user(cmnd, hp->cmdp, hp->cmd_len)) {
701 sg_remove_request(sfp, srp);
704 if (read_only && sg_allow_access(file, cmnd)) {
705 sg_remove_request(sfp, srp);
708 k = sg_common_write(sfp, srp, cmnd, timeout, blocking);
717 sg_common_write(Sg_fd * sfp, Sg_request * srp,
718 unsigned char *cmnd, int timeout, int blocking)
721 Sg_device *sdp = sfp->parentdp;
722 sg_io_hdr_t *hp = &srp->header;
724 srp->data.cmd_opcode = cmnd[0]; /* hold opcode of command */
726 hp->masked_status = 0;
730 hp->driver_status = 0;
732 SCSI_LOG_TIMEOUT(4, printk("sg_common_write: scsi opcode=0x%02x, cmd_size=%d\n",
733 (int) cmnd[0], (int) hp->cmd_len));
735 k = sg_start_req(srp, cmnd);
737 SCSI_LOG_TIMEOUT(1, printk("sg_common_write: start_req err=%d\n", k));
738 sg_finish_rem_req(srp);
739 return k; /* probably out of space --> ENOMEM */
742 sg_finish_rem_req(srp);
746 switch (hp->dxfer_direction) {
747 case SG_DXFER_TO_FROM_DEV:
748 case SG_DXFER_FROM_DEV:
749 data_dir = DMA_FROM_DEVICE;
751 case SG_DXFER_TO_DEV:
752 data_dir = DMA_TO_DEVICE;
754 case SG_DXFER_UNKNOWN:
755 data_dir = DMA_BIDIRECTIONAL;
761 hp->duration = jiffies_to_msecs(jiffies);
763 srp->rq->timeout = timeout;
764 kref_get(&sfp->f_ref); /* sg_rq_end_io() does kref_put(). */
765 blk_execute_rq_nowait(sdp->device->request_queue, sdp->disk,
766 srp->rq, 1, sg_rq_end_io);
771 sg_ioctl(struct inode *inode, struct file *filp,
772 unsigned int cmd_in, unsigned long arg)
774 void __user *p = (void __user *)arg;
776 int result, val, read_only;
780 unsigned long iflags;
782 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
785 SCSI_LOG_TIMEOUT(3, printk("sg_ioctl: %s, cmd=0x%x\n",
786 sdp->disk->disk_name, (int) cmd_in));
787 read_only = (O_RDWR != (filp->f_flags & O_ACCMODE));
792 int blocking = 1; /* ignore O_NONBLOCK flag */
796 if (!scsi_block_when_processing_errors(sdp->device))
798 if (!access_ok(VERIFY_WRITE, p, SZ_SG_IO_HDR))
801 sg_new_write(sfp, filp, p, SZ_SG_IO_HDR,
802 blocking, read_only, 1, &srp);
806 result = 0; /* following macro to beat race condition */
807 __wait_event_interruptible(sfp->read_wait,
808 (srp->done || sdp->detached),
812 write_lock_irq(&sfp->rq_list_lock);
815 write_unlock_irq(&sfp->rq_list_lock);
819 write_unlock_irq(&sfp->rq_list_lock);
820 return result; /* -ERESTARTSYS because signal hit process */
822 result = sg_new_read(sfp, p, SZ_SG_IO_HDR, srp);
823 return (result < 0) ? result : 0;
826 result = get_user(val, ip);
831 if (val >= MULDIV (INT_MAX, USER_HZ, HZ))
832 val = MULDIV (INT_MAX, USER_HZ, HZ);
833 sfp->timeout_user = val;
834 sfp->timeout = MULDIV (val, HZ, USER_HZ);
837 case SG_GET_TIMEOUT: /* N.B. User receives timeout as return value */
838 /* strange ..., for backward compatibility */
839 return sfp->timeout_user;
840 case SG_SET_FORCE_LOW_DMA:
841 result = get_user(val, ip);
846 if ((0 == sfp->low_dma) && (0 == sg_res_in_use(sfp))) {
847 val = (int) sfp->reserve.bufflen;
848 sg_remove_scat(&sfp->reserve);
849 sg_build_reserve(sfp, val);
854 sfp->low_dma = sdp->device->host->unchecked_isa_dma;
858 return put_user((int) sfp->low_dma, ip);
860 if (!access_ok(VERIFY_WRITE, p, sizeof (sg_scsi_id_t)))
863 sg_scsi_id_t __user *sg_idp = p;
867 __put_user((int) sdp->device->host->host_no,
869 __put_user((int) sdp->device->channel,
871 __put_user((int) sdp->device->id, &sg_idp->scsi_id);
872 __put_user((int) sdp->device->lun, &sg_idp->lun);
873 __put_user((int) sdp->device->type, &sg_idp->scsi_type);
874 __put_user((short) sdp->device->host->cmd_per_lun,
875 &sg_idp->h_cmd_per_lun);
876 __put_user((short) sdp->device->queue_depth,
877 &sg_idp->d_queue_depth);
878 __put_user(0, &sg_idp->unused[0]);
879 __put_user(0, &sg_idp->unused[1]);
882 case SG_SET_FORCE_PACK_ID:
883 result = get_user(val, ip);
886 sfp->force_packid = val ? 1 : 0;
889 if (!access_ok(VERIFY_WRITE, ip, sizeof (int)))
891 read_lock_irqsave(&sfp->rq_list_lock, iflags);
892 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
893 if ((1 == srp->done) && (!srp->sg_io_owned)) {
894 read_unlock_irqrestore(&sfp->rq_list_lock,
896 __put_user(srp->header.pack_id, ip);
900 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
903 case SG_GET_NUM_WAITING:
904 read_lock_irqsave(&sfp->rq_list_lock, iflags);
905 for (val = 0, srp = sfp->headrp; srp; srp = srp->nextrp) {
906 if ((1 == srp->done) && (!srp->sg_io_owned))
909 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
910 return put_user(val, ip);
911 case SG_GET_SG_TABLESIZE:
912 return put_user(sdp->sg_tablesize, ip);
913 case SG_SET_RESERVED_SIZE:
914 result = get_user(val, ip);
919 val = min_t(int, val,
920 sdp->device->request_queue->max_sectors * 512);
921 if (val != sfp->reserve.bufflen) {
922 if (sg_res_in_use(sfp) || sfp->mmap_called)
924 sg_remove_scat(&sfp->reserve);
925 sg_build_reserve(sfp, val);
928 case SG_GET_RESERVED_SIZE:
929 val = min_t(int, sfp->reserve.bufflen,
930 sdp->device->request_queue->max_sectors * 512);
931 return put_user(val, ip);
932 case SG_SET_COMMAND_Q:
933 result = get_user(val, ip);
936 sfp->cmd_q = val ? 1 : 0;
938 case SG_GET_COMMAND_Q:
939 return put_user((int) sfp->cmd_q, ip);
940 case SG_SET_KEEP_ORPHAN:
941 result = get_user(val, ip);
944 sfp->keep_orphan = val;
946 case SG_GET_KEEP_ORPHAN:
947 return put_user((int) sfp->keep_orphan, ip);
948 case SG_NEXT_CMD_LEN:
949 result = get_user(val, ip);
952 sfp->next_cmd_len = (val > 0) ? val : 0;
954 case SG_GET_VERSION_NUM:
955 return put_user(sg_version_num, ip);
956 case SG_GET_ACCESS_COUNT:
957 /* faked - we don't have a real access count anymore */
958 val = (sdp->device ? 1 : 0);
959 return put_user(val, ip);
960 case SG_GET_REQUEST_TABLE:
961 if (!access_ok(VERIFY_WRITE, p, SZ_SG_REQ_INFO * SG_MAX_QUEUE))
964 sg_req_info_t *rinfo;
967 rinfo = kmalloc(SZ_SG_REQ_INFO * SG_MAX_QUEUE,
971 read_lock_irqsave(&sfp->rq_list_lock, iflags);
972 for (srp = sfp->headrp, val = 0; val < SG_MAX_QUEUE;
973 ++val, srp = srp ? srp->nextrp : srp) {
974 memset(&rinfo[val], 0, SZ_SG_REQ_INFO);
976 rinfo[val].req_state = srp->done + 1;
978 srp->header.masked_status &
979 srp->header.host_status &
980 srp->header.driver_status;
982 rinfo[val].duration =
983 srp->header.duration;
985 ms = jiffies_to_msecs(jiffies);
986 rinfo[val].duration =
987 (ms > srp->header.duration) ?
988 (ms - srp->header.duration) : 0;
990 rinfo[val].orphan = srp->orphan;
991 rinfo[val].sg_io_owned =
999 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1000 result = __copy_to_user(p, rinfo,
1001 SZ_SG_REQ_INFO * SG_MAX_QUEUE);
1002 result = result ? -EFAULT : 0;
1006 case SG_EMULATED_HOST:
1009 return put_user(sdp->device->host->hostt->emulated, ip);
1013 if (filp->f_flags & O_NONBLOCK) {
1014 if (scsi_host_in_recovery(sdp->device->host))
1016 } else if (!scsi_block_when_processing_errors(sdp->device))
1018 result = get_user(val, ip);
1021 if (SG_SCSI_RESET_NOTHING == val)
1024 case SG_SCSI_RESET_DEVICE:
1025 val = SCSI_TRY_RESET_DEVICE;
1027 case SG_SCSI_RESET_TARGET:
1028 val = SCSI_TRY_RESET_TARGET;
1030 case SG_SCSI_RESET_BUS:
1031 val = SCSI_TRY_RESET_BUS;
1033 case SG_SCSI_RESET_HOST:
1034 val = SCSI_TRY_RESET_HOST;
1039 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
1041 return (scsi_reset_provider(sdp->device, val) ==
1042 SUCCESS) ? 0 : -EIO;
1043 case SCSI_IOCTL_SEND_COMMAND:
1047 unsigned char opcode = WRITE_6;
1048 Scsi_Ioctl_Command __user *siocp = p;
1050 if (copy_from_user(&opcode, siocp->data, 1))
1052 if (sg_allow_access(filp, &opcode))
1055 return sg_scsi_ioctl(sdp->device->request_queue, NULL, filp->f_mode, p);
1057 result = get_user(val, ip);
1060 sdp->sgdebug = (char) val;
1062 case SCSI_IOCTL_GET_IDLUN:
1063 case SCSI_IOCTL_GET_BUS_NUMBER:
1064 case SCSI_IOCTL_PROBE_HOST:
1065 case SG_GET_TRANSFORM:
1068 return scsi_ioctl(sdp->device, cmd_in, p);
1070 return put_user(sdp->device->request_queue->max_sectors * 512,
1073 return blk_trace_setup(sdp->device->request_queue,
1074 sdp->disk->disk_name,
1075 MKDEV(SCSI_GENERIC_MAJOR, sdp->index),
1078 return blk_trace_startstop(sdp->device->request_queue, 1);
1080 return blk_trace_startstop(sdp->device->request_queue, 0);
1081 case BLKTRACETEARDOWN:
1082 return blk_trace_remove(sdp->device->request_queue);
1085 return -EPERM; /* don't know so take safe approach */
1086 return scsi_ioctl(sdp->device, cmd_in, p);
1090 #ifdef CONFIG_COMPAT
1091 static long sg_compat_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
1095 struct scsi_device *sdev;
1097 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1101 if (sdev->host->hostt->compat_ioctl) {
1104 ret = sdev->host->hostt->compat_ioctl(sdev, cmd_in, (void __user *)arg);
1109 return -ENOIOCTLCMD;
1114 sg_poll(struct file *filp, poll_table * wait)
1116 unsigned int res = 0;
1121 unsigned long iflags;
1123 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp))
1126 poll_wait(filp, &sfp->read_wait, wait);
1127 read_lock_irqsave(&sfp->rq_list_lock, iflags);
1128 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
1129 /* if any read waiting, flag it */
1130 if ((0 == res) && (1 == srp->done) && (!srp->sg_io_owned))
1131 res = POLLIN | POLLRDNORM;
1134 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1138 else if (!sfp->cmd_q) {
1140 res |= POLLOUT | POLLWRNORM;
1141 } else if (count < SG_MAX_QUEUE)
1142 res |= POLLOUT | POLLWRNORM;
1143 SCSI_LOG_TIMEOUT(3, printk("sg_poll: %s, res=0x%x\n",
1144 sdp->disk->disk_name, (int) res));
1149 sg_fasync(int fd, struct file *filp, int mode)
1155 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1157 SCSI_LOG_TIMEOUT(3, printk("sg_fasync: %s, mode=%d\n",
1158 sdp->disk->disk_name, mode));
1160 retval = fasync_helper(fd, filp, mode, &sfp->async_qp);
1161 return (retval < 0) ? retval : 0;
1165 sg_vma_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
1168 unsigned long offset, len, sa;
1169 Sg_scatter_hold *rsv_schp;
1172 if ((NULL == vma) || (!(sfp = (Sg_fd *) vma->vm_private_data)))
1173 return VM_FAULT_SIGBUS;
1174 rsv_schp = &sfp->reserve;
1175 offset = vmf->pgoff << PAGE_SHIFT;
1176 if (offset >= rsv_schp->bufflen)
1177 return VM_FAULT_SIGBUS;
1178 SCSI_LOG_TIMEOUT(3, printk("sg_vma_fault: offset=%lu, scatg=%d\n",
1179 offset, rsv_schp->k_use_sg));
1181 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1182 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
1183 len = vma->vm_end - sa;
1184 len = (len < length) ? len : length;
1186 struct page *page = nth_page(rsv_schp->pages[k],
1187 offset >> PAGE_SHIFT);
1188 get_page(page); /* increment page count */
1190 return 0; /* success */
1196 return VM_FAULT_SIGBUS;
1199 static struct vm_operations_struct sg_mmap_vm_ops = {
1200 .fault = sg_vma_fault,
1204 sg_mmap(struct file *filp, struct vm_area_struct *vma)
1207 unsigned long req_sz, len, sa;
1208 Sg_scatter_hold *rsv_schp;
1211 if ((!filp) || (!vma) || (!(sfp = (Sg_fd *) filp->private_data)))
1213 req_sz = vma->vm_end - vma->vm_start;
1214 SCSI_LOG_TIMEOUT(3, printk("sg_mmap starting, vm_start=%p, len=%d\n",
1215 (void *) vma->vm_start, (int) req_sz));
1217 return -EINVAL; /* want no offset */
1218 rsv_schp = &sfp->reserve;
1219 if (req_sz > rsv_schp->bufflen)
1220 return -ENOMEM; /* cannot map more than reserved buffer */
1223 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1224 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
1225 len = vma->vm_end - sa;
1226 len = (len < length) ? len : length;
1230 sfp->mmap_called = 1;
1231 vma->vm_flags |= VM_RESERVED;
1232 vma->vm_private_data = sfp;
1233 vma->vm_ops = &sg_mmap_vm_ops;
1238 * This function is a "bottom half" handler that is called by the mid
1239 * level when a command is completed (or has failed).
1241 static void sg_rq_end_io(struct request *rq, int uptodate)
1243 struct sg_request *srp = rq->end_io_data;
1246 unsigned long iflags;
1249 int result, resid, done = 1;
1251 if (WARN_ON(srp->done != 0))
1254 sfp = srp->parentfp;
1255 if (WARN_ON(sfp == NULL))
1258 sdp = sfp->parentdp;
1259 if (unlikely(sdp->detached))
1260 printk(KERN_INFO "sg_rq_end_io: device detached\n");
1263 result = rq->errors;
1264 resid = rq->data_len;
1266 SCSI_LOG_TIMEOUT(4, printk("sg_cmd_done: %s, pack_id=%d, res=0x%x\n",
1267 sdp->disk->disk_name, srp->header.pack_id, result));
1268 srp->header.resid = resid;
1269 ms = jiffies_to_msecs(jiffies);
1270 srp->header.duration = (ms > srp->header.duration) ?
1271 (ms - srp->header.duration) : 0;
1273 struct scsi_sense_hdr sshdr;
1275 srp->header.status = 0xff & result;
1276 srp->header.masked_status = status_byte(result);
1277 srp->header.msg_status = msg_byte(result);
1278 srp->header.host_status = host_byte(result);
1279 srp->header.driver_status = driver_byte(result);
1280 if ((sdp->sgdebug > 0) &&
1281 ((CHECK_CONDITION == srp->header.masked_status) ||
1282 (COMMAND_TERMINATED == srp->header.masked_status)))
1283 __scsi_print_sense("sg_cmd_done", sense,
1284 SCSI_SENSE_BUFFERSIZE);
1286 /* Following if statement is a patch supplied by Eric Youngdale */
1287 if (driver_byte(result) != 0
1288 && scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, &sshdr)
1289 && !scsi_sense_is_deferred(&sshdr)
1290 && sshdr.sense_key == UNIT_ATTENTION
1291 && sdp->device->removable) {
1292 /* Detected possible disc change. Set the bit - this */
1293 /* may be used if there are filesystems using this device */
1294 sdp->device->changed = 1;
1297 /* Rely on write phase to clean out srp status values, so no "else" */
1299 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1300 if (unlikely(srp->orphan)) {
1301 if (sfp->keep_orphan)
1302 srp->sg_io_owned = 0;
1307 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1310 /* Now wake up any sg_read() that is waiting for this
1313 wake_up_interruptible(&sfp->read_wait);
1314 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_IN);
1316 sg_finish_rem_req(srp); /* call with srp->done == 0 */
1318 kref_put(&sfp->f_ref, sg_remove_sfp);
1321 static struct file_operations sg_fops = {
1322 .owner = THIS_MODULE,
1327 #ifdef CONFIG_COMPAT
1328 .compat_ioctl = sg_compat_ioctl,
1332 .release = sg_release,
1333 .fasync = sg_fasync,
1336 static struct class *sg_sysfs_class;
1338 static int sg_sysfs_valid = 0;
1340 static Sg_device *sg_alloc(struct gendisk *disk, struct scsi_device *scsidp)
1342 struct request_queue *q = scsidp->request_queue;
1344 unsigned long iflags;
1348 sdp = kzalloc(sizeof(Sg_device), GFP_KERNEL);
1350 printk(KERN_WARNING "kmalloc Sg_device failure\n");
1351 return ERR_PTR(-ENOMEM);
1354 if (!idr_pre_get(&sg_index_idr, GFP_KERNEL)) {
1355 printk(KERN_WARNING "idr expansion Sg_device failure\n");
1360 write_lock_irqsave(&sg_index_lock, iflags);
1362 error = idr_get_new(&sg_index_idr, sdp, &k);
1364 write_unlock_irqrestore(&sg_index_lock, iflags);
1365 printk(KERN_WARNING "idr allocation Sg_device failure: %d\n",
1370 if (unlikely(k >= SG_MAX_DEVS))
1373 SCSI_LOG_TIMEOUT(3, printk("sg_alloc: dev=%d \n", k));
1374 sprintf(disk->disk_name, "sg%d", k);
1375 disk->first_minor = k;
1377 sdp->device = scsidp;
1378 init_waitqueue_head(&sdp->o_excl_wait);
1379 sdp->sg_tablesize = min(q->max_hw_segments, q->max_phys_segments);
1381 kref_init(&sdp->d_ref);
1383 write_unlock_irqrestore(&sg_index_lock, iflags);
1389 return ERR_PTR(error);
1394 idr_remove(&sg_index_idr, k);
1395 write_unlock_irqrestore(&sg_index_lock, iflags);
1396 sdev_printk(KERN_WARNING, scsidp,
1397 "Unable to attach sg device type=%d, minor "
1398 "number exceeds %d\n", scsidp->type, SG_MAX_DEVS - 1);
1404 sg_add(struct device *cl_dev, struct class_interface *cl_intf)
1406 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
1407 struct gendisk *disk;
1408 Sg_device *sdp = NULL;
1409 struct cdev * cdev = NULL;
1411 unsigned long iflags;
1413 disk = alloc_disk(1);
1415 printk(KERN_WARNING "alloc_disk failed\n");
1418 disk->major = SCSI_GENERIC_MAJOR;
1421 cdev = cdev_alloc();
1423 printk(KERN_WARNING "cdev_alloc failed\n");
1426 cdev->owner = THIS_MODULE;
1427 cdev->ops = &sg_fops;
1429 sdp = sg_alloc(disk, scsidp);
1431 printk(KERN_WARNING "sg_alloc failed\n");
1432 error = PTR_ERR(sdp);
1436 error = cdev_add(cdev, MKDEV(SCSI_GENERIC_MAJOR, sdp->index), 1);
1441 if (sg_sysfs_valid) {
1442 struct device *sg_class_member;
1444 sg_class_member = device_create(sg_sysfs_class, cl_dev->parent,
1445 MKDEV(SCSI_GENERIC_MAJOR,
1447 sdp, "%s", disk->disk_name);
1448 if (IS_ERR(sg_class_member)) {
1449 printk(KERN_ERR "sg_add: "
1450 "device_create failed\n");
1451 error = PTR_ERR(sg_class_member);
1454 error = sysfs_create_link(&scsidp->sdev_gendev.kobj,
1455 &sg_class_member->kobj, "generic");
1457 printk(KERN_ERR "sg_add: unable to make symlink "
1458 "'generic' back to sg%d\n", sdp->index);
1460 printk(KERN_WARNING "sg_add: sg_sys Invalid\n");
1462 sdev_printk(KERN_NOTICE, scsidp,
1463 "Attached scsi generic sg%d type %d\n", sdp->index,
1466 dev_set_drvdata(cl_dev, sdp);
1471 write_lock_irqsave(&sg_index_lock, iflags);
1472 idr_remove(&sg_index_idr, sdp->index);
1473 write_unlock_irqrestore(&sg_index_lock, iflags);
1483 static void sg_device_destroy(struct kref *kref)
1485 struct sg_device *sdp = container_of(kref, struct sg_device, d_ref);
1486 unsigned long flags;
1488 /* CAUTION! Note that the device can still be found via idr_find()
1489 * even though the refcount is 0. Therefore, do idr_remove() BEFORE
1490 * any other cleanup.
1493 write_lock_irqsave(&sg_index_lock, flags);
1494 idr_remove(&sg_index_idr, sdp->index);
1495 write_unlock_irqrestore(&sg_index_lock, flags);
1498 printk("sg_device_destroy: %s\n",
1499 sdp->disk->disk_name));
1501 put_disk(sdp->disk);
1505 static void sg_remove(struct device *cl_dev, struct class_interface *cl_intf)
1507 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
1508 Sg_device *sdp = dev_get_drvdata(cl_dev);
1509 unsigned long iflags;
1512 if (!sdp || sdp->detached)
1515 SCSI_LOG_TIMEOUT(3, printk("sg_remove: %s\n", sdp->disk->disk_name));
1517 /* Need a write lock to set sdp->detached. */
1518 write_lock_irqsave(&sg_index_lock, iflags);
1520 for (sfp = sdp->headfp; sfp; sfp = sfp->nextfp) {
1521 wake_up_interruptible(&sfp->read_wait);
1522 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_HUP);
1524 write_unlock_irqrestore(&sg_index_lock, iflags);
1526 sysfs_remove_link(&scsidp->sdev_gendev.kobj, "generic");
1527 device_destroy(sg_sysfs_class, MKDEV(SCSI_GENERIC_MAJOR, sdp->index));
1528 cdev_del(sdp->cdev);
1534 module_param_named(scatter_elem_sz, scatter_elem_sz, int, S_IRUGO | S_IWUSR);
1535 module_param_named(def_reserved_size, def_reserved_size, int,
1537 module_param_named(allow_dio, sg_allow_dio, int, S_IRUGO | S_IWUSR);
1539 MODULE_AUTHOR("Douglas Gilbert");
1540 MODULE_DESCRIPTION("SCSI generic (sg) driver");
1541 MODULE_LICENSE("GPL");
1542 MODULE_VERSION(SG_VERSION_STR);
1543 MODULE_ALIAS_CHARDEV_MAJOR(SCSI_GENERIC_MAJOR);
1545 MODULE_PARM_DESC(scatter_elem_sz, "scatter gather element "
1546 "size (default: max(SG_SCATTER_SZ, PAGE_SIZE))");
1547 MODULE_PARM_DESC(def_reserved_size, "size of buffer reserved for each fd");
1548 MODULE_PARM_DESC(allow_dio, "allow direct I/O (default: 0 (disallow))");
1555 if (scatter_elem_sz < PAGE_SIZE) {
1556 scatter_elem_sz = PAGE_SIZE;
1557 scatter_elem_sz_prev = scatter_elem_sz;
1559 if (def_reserved_size >= 0)
1560 sg_big_buff = def_reserved_size;
1562 def_reserved_size = sg_big_buff;
1564 rc = register_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1568 sg_sysfs_class = class_create(THIS_MODULE, "scsi_generic");
1569 if ( IS_ERR(sg_sysfs_class) ) {
1570 rc = PTR_ERR(sg_sysfs_class);
1574 rc = scsi_register_interface(&sg_interface);
1576 #ifdef CONFIG_SCSI_PROC_FS
1578 #endif /* CONFIG_SCSI_PROC_FS */
1581 class_destroy(sg_sysfs_class);
1583 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0), SG_MAX_DEVS);
1590 #ifdef CONFIG_SCSI_PROC_FS
1592 #endif /* CONFIG_SCSI_PROC_FS */
1593 scsi_unregister_interface(&sg_interface);
1594 class_destroy(sg_sysfs_class);
1596 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1598 idr_destroy(&sg_index_idr);
1601 static int sg_start_req(Sg_request *srp, unsigned char *cmd)
1605 Sg_fd *sfp = srp->parentfp;
1606 sg_io_hdr_t *hp = &srp->header;
1607 int dxfer_len = (int) hp->dxfer_len;
1608 int dxfer_dir = hp->dxfer_direction;
1609 unsigned int iov_count = hp->iovec_count;
1610 Sg_scatter_hold *req_schp = &srp->data;
1611 Sg_scatter_hold *rsv_schp = &sfp->reserve;
1612 struct request_queue *q = sfp->parentdp->device->request_queue;
1613 struct rq_map_data *md, map_data;
1614 int rw = hp->dxfer_direction == SG_DXFER_TO_DEV ? WRITE : READ;
1616 SCSI_LOG_TIMEOUT(4, printk(KERN_INFO "sg_start_req: dxfer_len=%d\n",
1619 rq = blk_get_request(q, rw, GFP_ATOMIC);
1623 memcpy(rq->cmd, cmd, hp->cmd_len);
1625 rq->cmd_len = hp->cmd_len;
1626 rq->cmd_type = REQ_TYPE_BLOCK_PC;
1629 rq->end_io_data = srp;
1630 rq->sense = srp->sense_b;
1631 rq->retries = SG_DEFAULT_RETRIES;
1633 if ((dxfer_len <= 0) || (dxfer_dir == SG_DXFER_NONE))
1636 if (sg_allow_dio && hp->flags & SG_FLAG_DIRECT_IO &&
1637 dxfer_dir != SG_DXFER_UNKNOWN && !iov_count &&
1638 !sfp->parentdp->device->host->unchecked_isa_dma &&
1639 blk_rq_aligned(q, hp->dxferp, dxfer_len))
1645 if (!sg_res_in_use(sfp) && dxfer_len <= rsv_schp->bufflen)
1646 sg_link_reserve(sfp, srp, dxfer_len);
1648 res = sg_build_indirect(req_schp, sfp, dxfer_len);
1653 md->pages = req_schp->pages;
1654 md->page_order = req_schp->page_order;
1655 md->nr_entries = req_schp->k_use_sg;
1657 md->null_mapped = hp->dxferp ? 0 : 1;
1661 res = blk_rq_map_user_iov(q, rq, md, hp->dxferp, iov_count,
1662 hp->dxfer_len, GFP_ATOMIC);
1664 res = blk_rq_map_user(q, rq, md, hp->dxferp,
1665 hp->dxfer_len, GFP_ATOMIC);
1671 req_schp->dio_in_use = 1;
1672 hp->info |= SG_INFO_DIRECT_IO;
1679 sg_finish_rem_req(Sg_request * srp)
1681 Sg_fd *sfp = srp->parentfp;
1682 Sg_scatter_hold *req_schp = &srp->data;
1684 SCSI_LOG_TIMEOUT(4, printk("sg_finish_rem_req: res_used=%d\n", (int) srp->res_used));
1686 sg_unlink_reserve(sfp, srp);
1688 sg_remove_scat(req_schp);
1692 blk_rq_unmap_user(srp->bio);
1694 blk_put_request(srp->rq);
1697 sg_remove_request(sfp, srp);
1701 sg_build_sgat(Sg_scatter_hold * schp, const Sg_fd * sfp, int tablesize)
1703 int sg_bufflen = tablesize * sizeof(struct page *);
1704 gfp_t gfp_flags = GFP_ATOMIC | __GFP_NOWARN;
1706 schp->pages = kzalloc(sg_bufflen, gfp_flags);
1709 schp->sglist_len = sg_bufflen;
1710 return tablesize; /* number of scat_gath elements allocated */
1714 sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size)
1716 int ret_sz = 0, i, k, rem_sz, num, mx_sc_elems;
1717 int sg_tablesize = sfp->parentdp->sg_tablesize;
1718 int blk_size = buff_size, order;
1719 gfp_t gfp_mask = GFP_ATOMIC | __GFP_COMP | __GFP_NOWARN;
1724 ++blk_size; /* don't know why */
1725 /* round request up to next highest SG_SECTOR_SZ byte boundary */
1726 blk_size = (blk_size + SG_SECTOR_MSK) & (~SG_SECTOR_MSK);
1727 SCSI_LOG_TIMEOUT(4, printk("sg_build_indirect: buff_size=%d, blk_size=%d\n",
1728 buff_size, blk_size));
1730 /* N.B. ret_sz carried into this block ... */
1731 mx_sc_elems = sg_build_sgat(schp, sfp, sg_tablesize);
1732 if (mx_sc_elems < 0)
1733 return mx_sc_elems; /* most likely -ENOMEM */
1735 num = scatter_elem_sz;
1736 if (unlikely(num != scatter_elem_sz_prev)) {
1737 if (num < PAGE_SIZE) {
1738 scatter_elem_sz = PAGE_SIZE;
1739 scatter_elem_sz_prev = PAGE_SIZE;
1741 scatter_elem_sz_prev = num;
1745 gfp_mask |= GFP_DMA;
1747 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
1748 gfp_mask |= __GFP_ZERO;
1750 order = get_order(num);
1752 ret_sz = 1 << (PAGE_SHIFT + order);
1754 for (k = 0, rem_sz = blk_size; rem_sz > 0 && k < mx_sc_elems;
1755 k++, rem_sz -= ret_sz) {
1757 num = (rem_sz > scatter_elem_sz_prev) ?
1758 scatter_elem_sz_prev : rem_sz;
1760 schp->pages[k] = alloc_pages(gfp_mask, order);
1761 if (!schp->pages[k])
1764 if (num == scatter_elem_sz_prev) {
1765 if (unlikely(ret_sz > scatter_elem_sz_prev)) {
1766 scatter_elem_sz = ret_sz;
1767 scatter_elem_sz_prev = ret_sz;
1771 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k=%d, num=%d, "
1772 "ret_sz=%d\n", k, num, ret_sz));
1773 } /* end of for loop */
1775 schp->page_order = order;
1777 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k_use_sg=%d, "
1778 "rem_sz=%d\n", k, rem_sz));
1780 schp->bufflen = blk_size;
1781 if (rem_sz > 0) /* must have failed */
1785 for (i = 0; i < k; i++)
1786 __free_pages(schp->pages[k], order);
1795 sg_remove_scat(Sg_scatter_hold * schp)
1797 SCSI_LOG_TIMEOUT(4, printk("sg_remove_scat: k_use_sg=%d\n", schp->k_use_sg));
1798 if (schp->pages && schp->sglist_len > 0) {
1799 if (!schp->dio_in_use) {
1802 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
1803 SCSI_LOG_TIMEOUT(5, printk(
1804 "sg_remove_scat: k=%d, pg=0x%p\n",
1805 k, schp->pages[k]));
1806 __free_pages(schp->pages[k], schp->page_order);
1812 memset(schp, 0, sizeof (*schp));
1816 sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer)
1818 Sg_scatter_hold *schp = &srp->data;
1821 SCSI_LOG_TIMEOUT(4, printk("sg_read_oxfer: num_read_xfer=%d\n",
1823 if ((!outp) || (num_read_xfer <= 0))
1826 num = 1 << (PAGE_SHIFT + schp->page_order);
1827 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
1828 if (num > num_read_xfer) {
1829 if (__copy_to_user(outp, page_address(schp->pages[k]),
1834 if (__copy_to_user(outp, page_address(schp->pages[k]),
1837 num_read_xfer -= num;
1838 if (num_read_xfer <= 0)
1848 sg_build_reserve(Sg_fd * sfp, int req_size)
1850 Sg_scatter_hold *schp = &sfp->reserve;
1852 SCSI_LOG_TIMEOUT(4, printk("sg_build_reserve: req_size=%d\n", req_size));
1854 if (req_size < PAGE_SIZE)
1855 req_size = PAGE_SIZE;
1856 if (0 == sg_build_indirect(schp, sfp, req_size))
1859 sg_remove_scat(schp);
1860 req_size >>= 1; /* divide by 2 */
1861 } while (req_size > (PAGE_SIZE / 2));
1865 sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size)
1867 Sg_scatter_hold *req_schp = &srp->data;
1868 Sg_scatter_hold *rsv_schp = &sfp->reserve;
1872 SCSI_LOG_TIMEOUT(4, printk("sg_link_reserve: size=%d\n", size));
1875 num = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1876 for (k = 0; k < rsv_schp->k_use_sg; k++) {
1878 req_schp->k_use_sg = k + 1;
1879 req_schp->sglist_len = rsv_schp->sglist_len;
1880 req_schp->pages = rsv_schp->pages;
1882 req_schp->bufflen = size;
1883 req_schp->page_order = rsv_schp->page_order;
1889 if (k >= rsv_schp->k_use_sg)
1890 SCSI_LOG_TIMEOUT(1, printk("sg_link_reserve: BAD size\n"));
1894 sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp)
1896 Sg_scatter_hold *req_schp = &srp->data;
1898 SCSI_LOG_TIMEOUT(4, printk("sg_unlink_reserve: req->k_use_sg=%d\n",
1899 (int) req_schp->k_use_sg));
1900 req_schp->k_use_sg = 0;
1901 req_schp->bufflen = 0;
1902 req_schp->pages = NULL;
1903 req_schp->page_order = 0;
1904 req_schp->sglist_len = 0;
1905 sfp->save_scat_len = 0;
1910 sg_get_rq_mark(Sg_fd * sfp, int pack_id)
1913 unsigned long iflags;
1915 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1916 for (resp = sfp->headrp; resp; resp = resp->nextrp) {
1917 /* look for requests that are ready + not SG_IO owned */
1918 if ((1 == resp->done) && (!resp->sg_io_owned) &&
1919 ((-1 == pack_id) || (resp->header.pack_id == pack_id))) {
1920 resp->done = 2; /* guard against other readers */
1924 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1928 /* always adds to end of list */
1930 sg_add_request(Sg_fd * sfp)
1933 unsigned long iflags;
1935 Sg_request *rp = sfp->req_arr;
1937 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1940 memset(rp, 0, sizeof (Sg_request));
1945 if (0 == sfp->cmd_q)
1946 resp = NULL; /* command queuing disallowed */
1948 for (k = 0; k < SG_MAX_QUEUE; ++k, ++rp) {
1952 if (k < SG_MAX_QUEUE) {
1953 memset(rp, 0, sizeof (Sg_request));
1955 while (resp->nextrp)
1956 resp = resp->nextrp;
1964 resp->nextrp = NULL;
1965 resp->header.duration = jiffies_to_msecs(jiffies);
1967 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1971 /* Return of 1 for found; 0 for not found */
1973 sg_remove_request(Sg_fd * sfp, Sg_request * srp)
1975 Sg_request *prev_rp;
1977 unsigned long iflags;
1980 if ((!sfp) || (!srp) || (!sfp->headrp))
1982 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1983 prev_rp = sfp->headrp;
1984 if (srp == prev_rp) {
1985 sfp->headrp = prev_rp->nextrp;
1986 prev_rp->parentfp = NULL;
1989 while ((rp = prev_rp->nextrp)) {
1991 prev_rp->nextrp = rp->nextrp;
1992 rp->parentfp = NULL;
1999 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2004 sg_add_sfp(Sg_device * sdp, int dev)
2007 unsigned long iflags;
2010 sfp = kzalloc(sizeof(*sfp), GFP_ATOMIC | __GFP_NOWARN);
2014 init_waitqueue_head(&sfp->read_wait);
2015 rwlock_init(&sfp->rq_list_lock);
2017 kref_init(&sfp->f_ref);
2018 sfp->timeout = SG_DEFAULT_TIMEOUT;
2019 sfp->timeout_user = SG_DEFAULT_TIMEOUT_USER;
2020 sfp->force_packid = SG_DEF_FORCE_PACK_ID;
2021 sfp->low_dma = (SG_DEF_FORCE_LOW_DMA == 0) ?
2022 sdp->device->host->unchecked_isa_dma : 1;
2023 sfp->cmd_q = SG_DEF_COMMAND_Q;
2024 sfp->keep_orphan = SG_DEF_KEEP_ORPHAN;
2025 sfp->parentdp = sdp;
2026 write_lock_irqsave(&sg_index_lock, iflags);
2029 else { /* add to tail of existing list */
2030 Sg_fd *pfp = sdp->headfp;
2035 write_unlock_irqrestore(&sg_index_lock, iflags);
2036 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: sfp=0x%p\n", sfp));
2037 if (unlikely(sg_big_buff != def_reserved_size))
2038 sg_big_buff = def_reserved_size;
2040 bufflen = min_t(int, sg_big_buff,
2041 sdp->device->request_queue->max_sectors * 512);
2042 sg_build_reserve(sfp, bufflen);
2043 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: bufflen=%d, k_use_sg=%d\n",
2044 sfp->reserve.bufflen, sfp->reserve.k_use_sg));
2046 kref_get(&sdp->d_ref);
2047 __module_get(THIS_MODULE);
2051 static void sg_remove_sfp_usercontext(struct work_struct *work)
2053 struct sg_fd *sfp = container_of(work, struct sg_fd, ew.work);
2054 struct sg_device *sdp = sfp->parentdp;
2056 /* Cleanup any responses which were never read(). */
2058 sg_finish_rem_req(sfp->headrp);
2060 if (sfp->reserve.bufflen > 0) {
2062 printk("sg_remove_sfp: bufflen=%d, k_use_sg=%d\n",
2063 (int) sfp->reserve.bufflen,
2064 (int) sfp->reserve.k_use_sg));
2065 sg_remove_scat(&sfp->reserve);
2069 printk("sg_remove_sfp: %s, sfp=0x%p\n",
2070 sdp->disk->disk_name,
2074 scsi_device_put(sdp->device);
2076 module_put(THIS_MODULE);
2079 static void sg_remove_sfp(struct kref *kref)
2081 struct sg_fd *sfp = container_of(kref, struct sg_fd, f_ref);
2082 struct sg_device *sdp = sfp->parentdp;
2085 unsigned long iflags;
2087 /* CAUTION! Note that sfp can still be found by walking sdp->headfp
2088 * even though the refcount is now 0. Therefore, unlink sfp from
2089 * sdp->headfp BEFORE doing any other cleanup.
2092 write_lock_irqsave(&sg_index_lock, iflags);
2093 prev_fp = sdp->headfp;
2095 sdp->headfp = prev_fp->nextfp;
2097 while ((fp = prev_fp->nextfp)) {
2099 prev_fp->nextfp = fp->nextfp;
2105 write_unlock_irqrestore(&sg_index_lock, iflags);
2106 wake_up_interruptible(&sdp->o_excl_wait);
2108 execute_in_process_context(sg_remove_sfp_usercontext, &sfp->ew);
2112 sg_res_in_use(Sg_fd * sfp)
2114 const Sg_request *srp;
2115 unsigned long iflags;
2117 read_lock_irqsave(&sfp->rq_list_lock, iflags);
2118 for (srp = sfp->headrp; srp; srp = srp->nextrp)
2121 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2125 #ifdef CONFIG_SCSI_PROC_FS
2127 sg_idr_max_id(int id, void *p, void *data)
2141 unsigned long iflags;
2143 read_lock_irqsave(&sg_index_lock, iflags);
2144 idr_for_each(&sg_index_idr, sg_idr_max_id, &k);
2145 read_unlock_irqrestore(&sg_index_lock, iflags);
2146 return k + 1; /* origin 1 */
2150 /* must be called with sg_index_lock held */
2151 static Sg_device *sg_lookup_dev(int dev)
2153 return idr_find(&sg_index_idr, dev);
2156 static Sg_device *sg_get_dev(int dev)
2158 struct sg_device *sdp;
2159 unsigned long flags;
2161 read_lock_irqsave(&sg_index_lock, flags);
2162 sdp = sg_lookup_dev(dev);
2164 sdp = ERR_PTR(-ENXIO);
2165 else if (sdp->detached) {
2166 /* If sdp->detached, then the refcount may already be 0, in
2167 * which case it would be a bug to do kref_get().
2169 sdp = ERR_PTR(-ENODEV);
2171 kref_get(&sdp->d_ref);
2172 read_unlock_irqrestore(&sg_index_lock, flags);
2177 static void sg_put_dev(struct sg_device *sdp)
2179 kref_put(&sdp->d_ref, sg_device_destroy);
2182 #ifdef CONFIG_SCSI_PROC_FS
2184 static struct proc_dir_entry *sg_proc_sgp = NULL;
2186 static char sg_proc_sg_dirname[] = "scsi/sg";
2188 static int sg_proc_seq_show_int(struct seq_file *s, void *v);
2190 static int sg_proc_single_open_adio(struct inode *inode, struct file *file);
2191 static ssize_t sg_proc_write_adio(struct file *filp, const char __user *buffer,
2192 size_t count, loff_t *off);
2193 static struct file_operations adio_fops = {
2194 /* .owner, .read and .llseek added in sg_proc_init() */
2195 .open = sg_proc_single_open_adio,
2196 .write = sg_proc_write_adio,
2197 .release = single_release,
2200 static int sg_proc_single_open_dressz(struct inode *inode, struct file *file);
2201 static ssize_t sg_proc_write_dressz(struct file *filp,
2202 const char __user *buffer, size_t count, loff_t *off);
2203 static struct file_operations dressz_fops = {
2204 .open = sg_proc_single_open_dressz,
2205 .write = sg_proc_write_dressz,
2206 .release = single_release,
2209 static int sg_proc_seq_show_version(struct seq_file *s, void *v);
2210 static int sg_proc_single_open_version(struct inode *inode, struct file *file);
2211 static struct file_operations version_fops = {
2212 .open = sg_proc_single_open_version,
2213 .release = single_release,
2216 static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v);
2217 static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file);
2218 static struct file_operations devhdr_fops = {
2219 .open = sg_proc_single_open_devhdr,
2220 .release = single_release,
2223 static int sg_proc_seq_show_dev(struct seq_file *s, void *v);
2224 static int sg_proc_open_dev(struct inode *inode, struct file *file);
2225 static void * dev_seq_start(struct seq_file *s, loff_t *pos);
2226 static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos);
2227 static void dev_seq_stop(struct seq_file *s, void *v);
2228 static struct file_operations dev_fops = {
2229 .open = sg_proc_open_dev,
2230 .release = seq_release,
2232 static struct seq_operations dev_seq_ops = {
2233 .start = dev_seq_start,
2234 .next = dev_seq_next,
2235 .stop = dev_seq_stop,
2236 .show = sg_proc_seq_show_dev,
2239 static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v);
2240 static int sg_proc_open_devstrs(struct inode *inode, struct file *file);
2241 static struct file_operations devstrs_fops = {
2242 .open = sg_proc_open_devstrs,
2243 .release = seq_release,
2245 static struct seq_operations devstrs_seq_ops = {
2246 .start = dev_seq_start,
2247 .next = dev_seq_next,
2248 .stop = dev_seq_stop,
2249 .show = sg_proc_seq_show_devstrs,
2252 static int sg_proc_seq_show_debug(struct seq_file *s, void *v);
2253 static int sg_proc_open_debug(struct inode *inode, struct file *file);
2254 static struct file_operations debug_fops = {
2255 .open = sg_proc_open_debug,
2256 .release = seq_release,
2258 static struct seq_operations debug_seq_ops = {
2259 .start = dev_seq_start,
2260 .next = dev_seq_next,
2261 .stop = dev_seq_stop,
2262 .show = sg_proc_seq_show_debug,
2266 struct sg_proc_leaf {
2268 struct file_operations * fops;
2271 static struct sg_proc_leaf sg_proc_leaf_arr[] = {
2272 {"allow_dio", &adio_fops},
2273 {"debug", &debug_fops},
2274 {"def_reserved_size", &dressz_fops},
2275 {"device_hdr", &devhdr_fops},
2276 {"devices", &dev_fops},
2277 {"device_strs", &devstrs_fops},
2278 {"version", &version_fops}
2285 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
2286 struct sg_proc_leaf * leaf;
2288 sg_proc_sgp = proc_mkdir(sg_proc_sg_dirname, NULL);
2291 for (k = 0; k < num_leaves; ++k) {
2292 leaf = &sg_proc_leaf_arr[k];
2293 mask = leaf->fops->write ? S_IRUGO | S_IWUSR : S_IRUGO;
2294 leaf->fops->owner = THIS_MODULE;
2295 leaf->fops->read = seq_read;
2296 leaf->fops->llseek = seq_lseek;
2297 proc_create(leaf->name, mask, sg_proc_sgp, leaf->fops);
2303 sg_proc_cleanup(void)
2306 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
2310 for (k = 0; k < num_leaves; ++k)
2311 remove_proc_entry(sg_proc_leaf_arr[k].name, sg_proc_sgp);
2312 remove_proc_entry(sg_proc_sg_dirname, NULL);
2316 static int sg_proc_seq_show_int(struct seq_file *s, void *v)
2318 seq_printf(s, "%d\n", *((int *)s->private));
2322 static int sg_proc_single_open_adio(struct inode *inode, struct file *file)
2324 return single_open(file, sg_proc_seq_show_int, &sg_allow_dio);
2328 sg_proc_write_adio(struct file *filp, const char __user *buffer,
2329 size_t count, loff_t *off)
2334 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2336 num = (count < 10) ? count : 10;
2337 if (copy_from_user(buff, buffer, num))
2340 sg_allow_dio = simple_strtoul(buff, NULL, 10) ? 1 : 0;
2344 static int sg_proc_single_open_dressz(struct inode *inode, struct file *file)
2346 return single_open(file, sg_proc_seq_show_int, &sg_big_buff);
2350 sg_proc_write_dressz(struct file *filp, const char __user *buffer,
2351 size_t count, loff_t *off)
2354 unsigned long k = ULONG_MAX;
2357 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2359 num = (count < 10) ? count : 10;
2360 if (copy_from_user(buff, buffer, num))
2363 k = simple_strtoul(buff, NULL, 10);
2364 if (k <= 1048576) { /* limit "big buff" to 1 MB */
2371 static int sg_proc_seq_show_version(struct seq_file *s, void *v)
2373 seq_printf(s, "%d\t%s [%s]\n", sg_version_num, SG_VERSION_STR,
2378 static int sg_proc_single_open_version(struct inode *inode, struct file *file)
2380 return single_open(file, sg_proc_seq_show_version, NULL);
2383 static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v)
2385 seq_printf(s, "host\tchan\tid\tlun\ttype\topens\tqdepth\tbusy\t"
2390 static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file)
2392 return single_open(file, sg_proc_seq_show_devhdr, NULL);
2395 struct sg_proc_deviter {
2400 static void * dev_seq_start(struct seq_file *s, loff_t *pos)
2402 struct sg_proc_deviter * it = kmalloc(sizeof(*it), GFP_KERNEL);
2409 it->max = sg_last_dev();
2410 if (it->index >= it->max)
2415 static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos)
2417 struct sg_proc_deviter * it = s->private;
2420 return (it->index < it->max) ? it : NULL;
2423 static void dev_seq_stop(struct seq_file *s, void *v)
2428 static int sg_proc_open_dev(struct inode *inode, struct file *file)
2430 return seq_open(file, &dev_seq_ops);
2433 static int sg_proc_seq_show_dev(struct seq_file *s, void *v)
2435 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2437 struct scsi_device *scsidp;
2438 unsigned long iflags;
2440 read_lock_irqsave(&sg_index_lock, iflags);
2441 sdp = it ? sg_lookup_dev(it->index) : NULL;
2442 if (sdp && (scsidp = sdp->device) && (!sdp->detached))
2443 seq_printf(s, "%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\n",
2444 scsidp->host->host_no, scsidp->channel,
2445 scsidp->id, scsidp->lun, (int) scsidp->type,
2447 (int) scsidp->queue_depth,
2448 (int) scsidp->device_busy,
2449 (int) scsi_device_online(scsidp));
2451 seq_printf(s, "-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\n");
2452 read_unlock_irqrestore(&sg_index_lock, iflags);
2456 static int sg_proc_open_devstrs(struct inode *inode, struct file *file)
2458 return seq_open(file, &devstrs_seq_ops);
2461 static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v)
2463 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2465 struct scsi_device *scsidp;
2466 unsigned long iflags;
2468 read_lock_irqsave(&sg_index_lock, iflags);
2469 sdp = it ? sg_lookup_dev(it->index) : NULL;
2470 if (sdp && (scsidp = sdp->device) && (!sdp->detached))
2471 seq_printf(s, "%8.8s\t%16.16s\t%4.4s\n",
2472 scsidp->vendor, scsidp->model, scsidp->rev);
2474 seq_printf(s, "<no active device>\n");
2475 read_unlock_irqrestore(&sg_index_lock, iflags);
2479 /* must be called while holding sg_index_lock */
2480 static void sg_proc_debug_helper(struct seq_file *s, Sg_device * sdp)
2482 int k, m, new_interface, blen, usg;
2485 const sg_io_hdr_t *hp;
2489 for (k = 0, fp = sdp->headfp; fp != NULL; ++k, fp = fp->nextfp) {
2490 read_lock(&fp->rq_list_lock); /* irqs already disabled */
2491 seq_printf(s, " FD(%d): timeout=%dms bufflen=%d "
2492 "(res)sgat=%d low_dma=%d\n", k + 1,
2493 jiffies_to_msecs(fp->timeout),
2494 fp->reserve.bufflen,
2495 (int) fp->reserve.k_use_sg,
2497 seq_printf(s, " cmd_q=%d f_packid=%d k_orphan=%d closed=%d\n",
2498 (int) fp->cmd_q, (int) fp->force_packid,
2499 (int) fp->keep_orphan, (int) fp->closed);
2500 for (m = 0, srp = fp->headrp;
2502 ++m, srp = srp->nextrp) {
2504 new_interface = (hp->interface_id == '\0') ? 0 : 1;
2505 if (srp->res_used) {
2506 if (new_interface &&
2507 (SG_FLAG_MMAP_IO & hp->flags))
2512 if (SG_INFO_DIRECT_IO_MASK & hp->info)
2518 blen = srp->data.bufflen;
2519 usg = srp->data.k_use_sg;
2520 seq_printf(s, srp->done ?
2521 ((1 == srp->done) ? "rcv:" : "fin:")
2523 seq_printf(s, " id=%d blen=%d",
2524 srp->header.pack_id, blen);
2526 seq_printf(s, " dur=%d", hp->duration);
2528 ms = jiffies_to_msecs(jiffies);
2529 seq_printf(s, " t_o/elap=%d/%d",
2530 (new_interface ? hp->timeout :
2531 jiffies_to_msecs(fp->timeout)),
2532 (ms > hp->duration ? ms - hp->duration : 0));
2534 seq_printf(s, "ms sgat=%d op=0x%02x\n", usg,
2535 (int) srp->data.cmd_opcode);
2538 seq_printf(s, " No requests active\n");
2539 read_unlock(&fp->rq_list_lock);
2543 static int sg_proc_open_debug(struct inode *inode, struct file *file)
2545 return seq_open(file, &debug_seq_ops);
2548 static int sg_proc_seq_show_debug(struct seq_file *s, void *v)
2550 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2552 unsigned long iflags;
2554 if (it && (0 == it->index)) {
2555 seq_printf(s, "max_active_device=%d(origin 1)\n",
2557 seq_printf(s, " def_reserved_size=%d\n", sg_big_buff);
2560 read_lock_irqsave(&sg_index_lock, iflags);
2561 sdp = it ? sg_lookup_dev(it->index) : NULL;
2562 if (sdp && sdp->headfp) {
2563 struct scsi_device *scsidp = sdp->device;
2565 seq_printf(s, " >>> device=%s ", sdp->disk->disk_name);
2567 seq_printf(s, "detached pending close ");
2570 (s, "scsi%d chan=%d id=%d lun=%d em=%d",
2571 scsidp->host->host_no,
2572 scsidp->channel, scsidp->id,
2574 scsidp->host->hostt->emulated);
2575 seq_printf(s, " sg_tablesize=%d excl=%d\n",
2576 sdp->sg_tablesize, sdp->exclude);
2577 sg_proc_debug_helper(s, sdp);
2579 read_unlock_irqrestore(&sg_index_lock, iflags);
2583 #endif /* CONFIG_SCSI_PROC_FS */
2585 module_init(init_sg);
2586 module_exit(exit_sg);