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
102 static int sg_add(struct device *, struct class_interface *);
103 static void sg_remove(struct device *, struct class_interface *);
105 static DEFINE_IDR(sg_index_idr);
106 static DEFINE_RWLOCK(sg_index_lock); /* Also used to lock
107 file descriptor list for device */
109 static struct class_interface sg_interface = {
111 .remove_dev = sg_remove,
114 typedef struct sg_scatter_hold { /* holding area for scsi scatter gather info */
115 unsigned short k_use_sg; /* Count of kernel scatter-gather pieces */
116 unsigned sglist_len; /* size of malloc'd scatter-gather list ++ */
117 unsigned bufflen; /* Size of (aggregate) data buffer */
120 char dio_in_use; /* 0->indirect IO (or mmap), 1->dio */
121 unsigned char cmd_opcode; /* first byte of command */
124 struct sg_device; /* forward declarations */
127 typedef struct sg_request { /* SG_MAX_QUEUE requests outstanding per file */
128 struct sg_request *nextrp; /* NULL -> tail request (slist) */
129 struct sg_fd *parentfp; /* NULL -> not in use */
130 Sg_scatter_hold data; /* hold buffer, perhaps scatter list */
131 sg_io_hdr_t header; /* scsi command+info, see <scsi/sg.h> */
132 unsigned char sense_b[SCSI_SENSE_BUFFERSIZE];
133 char res_used; /* 1 -> using reserve buffer, 0 -> not ... */
134 char orphan; /* 1 -> drop on sight, 0 -> normal */
135 char sg_io_owned; /* 1 -> packet belongs to SG_IO */
136 volatile char done; /* 0->before bh, 1->before read, 2->read */
139 struct execute_work ew;
142 typedef struct sg_fd { /* holds the state of a file descriptor */
143 struct list_head sfd_siblings;
144 struct sg_device *parentdp; /* owning device */
145 wait_queue_head_t read_wait; /* queue read until command done */
146 rwlock_t rq_list_lock; /* protect access to list in req_arr */
147 int timeout; /* defaults to SG_DEFAULT_TIMEOUT */
148 int timeout_user; /* defaults to SG_DEFAULT_TIMEOUT_USER */
149 Sg_scatter_hold reserve; /* buffer held for this file descriptor */
150 unsigned save_scat_len; /* original length of trunc. scat. element */
151 Sg_request *headrp; /* head of request slist, NULL->empty */
152 struct fasync_struct *async_qp; /* used by asynchronous notification */
153 Sg_request req_arr[SG_MAX_QUEUE]; /* used as singly-linked list */
154 char low_dma; /* as in parent but possibly overridden to 1 */
155 char force_packid; /* 1 -> pack_id input to read(), 0 -> ignored */
156 volatile char closed; /* 1 -> fd closed but request(s) outstanding */
157 char cmd_q; /* 1 -> allow command queuing, 0 -> don't */
158 char next_cmd_len; /* 0 -> automatic (def), >0 -> use on next write() */
159 char keep_orphan; /* 0 -> drop orphan (def), 1 -> keep for read() */
160 char mmap_called; /* 0 -> mmap() never called on this fd */
162 struct execute_work ew;
165 typedef struct sg_device { /* holds the state of each scsi generic device */
166 struct scsi_device *device;
167 wait_queue_head_t o_excl_wait; /* queue open() when O_EXCL in use */
168 int sg_tablesize; /* adapter's max scatter-gather table size */
169 u32 index; /* device index number */
170 struct list_head sfds;
171 volatile char detached; /* 0->attached, 1->detached pending removal */
172 volatile char exclude; /* opened for exclusive access */
173 char sgdebug; /* 0->off, 1->sense, 9->dump dev, 10-> all devs */
174 struct gendisk *disk;
175 struct cdev * cdev; /* char_dev [sysfs: /sys/cdev/major/sg<n>] */
179 /* tasklet or soft irq callback */
180 static void sg_rq_end_io(struct request *rq, int uptodate);
181 static int sg_start_req(Sg_request *srp, unsigned char *cmd);
182 static void sg_finish_rem_req(Sg_request * srp);
183 static int sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size);
184 static ssize_t sg_new_read(Sg_fd * sfp, char __user *buf, size_t count,
186 static ssize_t sg_new_write(Sg_fd *sfp, struct file *file,
187 const char __user *buf, size_t count, int blocking,
188 int read_only, int sg_io_owned, Sg_request **o_srp);
189 static int sg_common_write(Sg_fd * sfp, Sg_request * srp,
190 unsigned char *cmnd, int timeout, int blocking);
191 static int sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer);
192 static void sg_remove_scat(Sg_scatter_hold * schp);
193 static void sg_build_reserve(Sg_fd * sfp, int req_size);
194 static void sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size);
195 static void sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp);
196 static Sg_fd *sg_add_sfp(Sg_device * sdp, int dev);
197 static void sg_remove_sfp(struct kref *);
198 static Sg_request *sg_get_rq_mark(Sg_fd * sfp, int pack_id);
199 static Sg_request *sg_add_request(Sg_fd * sfp);
200 static int sg_remove_request(Sg_fd * sfp, Sg_request * srp);
201 static int sg_res_in_use(Sg_fd * sfp);
202 static Sg_device *sg_get_dev(int dev);
203 static void sg_put_dev(Sg_device *sdp);
205 #define SZ_SG_HEADER sizeof(struct sg_header)
206 #define SZ_SG_IO_HDR sizeof(sg_io_hdr_t)
207 #define SZ_SG_IOVEC sizeof(sg_iovec_t)
208 #define SZ_SG_REQ_INFO sizeof(sg_req_info_t)
210 static int sg_allow_access(struct file *filp, unsigned char *cmd)
212 struct sg_fd *sfp = (struct sg_fd *)filp->private_data;
213 struct request_queue *q = sfp->parentdp->device->request_queue;
215 if (sfp->parentdp->device->type == TYPE_SCANNER)
218 return blk_verify_command(&q->cmd_filter,
219 cmd, filp->f_mode & FMODE_WRITE);
223 sg_open(struct inode *inode, struct file *filp)
225 int dev = iminor(inode);
226 int flags = filp->f_flags;
227 struct request_queue *q;
234 nonseekable_open(inode, filp);
235 SCSI_LOG_TIMEOUT(3, printk("sg_open: dev=%d, flags=0x%x\n", dev, flags));
236 sdp = sg_get_dev(dev);
238 retval = PTR_ERR(sdp);
243 /* This driver's module count bumped by fops_get in <linux/fs.h> */
244 /* Prevent the device driver from vanishing while we sleep */
245 retval = scsi_device_get(sdp->device);
249 if (!((flags & O_NONBLOCK) ||
250 scsi_block_when_processing_errors(sdp->device))) {
252 /* we are in error recovery for this device */
256 if (flags & O_EXCL) {
257 if (O_RDONLY == (flags & O_ACCMODE)) {
258 retval = -EPERM; /* Can't lock it with read only access */
261 if (!list_empty(&sdp->sfds) && (flags & O_NONBLOCK)) {
266 __wait_event_interruptible(sdp->o_excl_wait,
267 ((!list_empty(&sdp->sfds) || sdp->exclude) ? 0 : (sdp->exclude = 1)), res);
269 retval = res; /* -ERESTARTSYS because signal hit process */
272 } else if (sdp->exclude) { /* some other fd has an exclusive lock on dev */
273 if (flags & O_NONBLOCK) {
278 __wait_event_interruptible(sdp->o_excl_wait, (!sdp->exclude),
281 retval = res; /* -ERESTARTSYS because signal hit process */
289 if (list_empty(&sdp->sfds)) { /* no existing opens on this device */
291 q = sdp->device->request_queue;
292 sdp->sg_tablesize = min(q->max_hw_segments,
293 q->max_phys_segments);
295 if ((sfp = sg_add_sfp(sdp, dev)))
296 filp->private_data = sfp;
298 if (flags & O_EXCL) {
299 sdp->exclude = 0; /* undo if error */
300 wake_up_interruptible(&sdp->o_excl_wait);
308 scsi_device_put(sdp->device);
316 /* Following function was formerly called 'sg_close' */
318 sg_release(struct inode *inode, struct file *filp)
323 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
325 SCSI_LOG_TIMEOUT(3, printk("sg_release: %s\n", sdp->disk->disk_name));
330 wake_up_interruptible(&sdp->o_excl_wait);
332 kref_put(&sfp->f_ref, sg_remove_sfp);
337 sg_read(struct file *filp, char __user *buf, size_t count, loff_t * ppos)
342 int req_pack_id = -1;
344 struct sg_header *old_hdr = NULL;
347 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
349 SCSI_LOG_TIMEOUT(3, printk("sg_read: %s, count=%d\n",
350 sdp->disk->disk_name, (int) count));
352 if (!access_ok(VERIFY_WRITE, buf, count))
354 if (sfp->force_packid && (count >= SZ_SG_HEADER)) {
355 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
358 if (__copy_from_user(old_hdr, buf, SZ_SG_HEADER)) {
362 if (old_hdr->reply_len < 0) {
363 if (count >= SZ_SG_IO_HDR) {
364 sg_io_hdr_t *new_hdr;
365 new_hdr = kmalloc(SZ_SG_IO_HDR, GFP_KERNEL);
370 retval =__copy_from_user
371 (new_hdr, buf, SZ_SG_IO_HDR);
372 req_pack_id = new_hdr->pack_id;
380 req_pack_id = old_hdr->pack_id;
382 srp = sg_get_rq_mark(sfp, req_pack_id);
383 if (!srp) { /* now wait on packet to arrive */
388 if (filp->f_flags & O_NONBLOCK) {
393 retval = 0; /* following macro beats race condition */
394 __wait_event_interruptible(sfp->read_wait,
396 (srp = sg_get_rq_mark(sfp, req_pack_id))),
405 /* -ERESTARTSYS as signal hit process */
409 if (srp->header.interface_id != '\0') {
410 retval = sg_new_read(sfp, buf, count, srp);
415 if (old_hdr == NULL) {
416 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
422 memset(old_hdr, 0, SZ_SG_HEADER);
423 old_hdr->reply_len = (int) hp->timeout;
424 old_hdr->pack_len = old_hdr->reply_len; /* old, strange behaviour */
425 old_hdr->pack_id = hp->pack_id;
426 old_hdr->twelve_byte =
427 ((srp->data.cmd_opcode >= 0xc0) && (12 == hp->cmd_len)) ? 1 : 0;
428 old_hdr->target_status = hp->masked_status;
429 old_hdr->host_status = hp->host_status;
430 old_hdr->driver_status = hp->driver_status;
431 if ((CHECK_CONDITION & hp->masked_status) ||
432 (DRIVER_SENSE & hp->driver_status))
433 memcpy(old_hdr->sense_buffer, srp->sense_b,
434 sizeof (old_hdr->sense_buffer));
435 switch (hp->host_status) {
436 /* This setup of 'result' is for backward compatibility and is best
437 ignored by the user who should use target, host + driver status */
439 case DID_PASSTHROUGH:
446 old_hdr->result = EBUSY;
453 old_hdr->result = EIO;
456 old_hdr->result = (srp->sense_b[0] == 0 &&
457 hp->masked_status == GOOD) ? 0 : EIO;
460 old_hdr->result = EIO;
464 /* Now copy the result back to the user buffer. */
465 if (count >= SZ_SG_HEADER) {
466 if (__copy_to_user(buf, old_hdr, SZ_SG_HEADER)) {
471 if (count > old_hdr->reply_len)
472 count = old_hdr->reply_len;
473 if (count > SZ_SG_HEADER) {
474 if (sg_read_oxfer(srp, buf, count - SZ_SG_HEADER)) {
480 count = (old_hdr->result == 0) ? 0 : -EIO;
481 sg_finish_rem_req(srp);
489 sg_new_read(Sg_fd * sfp, char __user *buf, size_t count, Sg_request * srp)
491 sg_io_hdr_t *hp = &srp->header;
495 if (count < SZ_SG_IO_HDR) {
500 if ((hp->mx_sb_len > 0) && hp->sbp) {
501 if ((CHECK_CONDITION & hp->masked_status) ||
502 (DRIVER_SENSE & hp->driver_status)) {
503 int sb_len = SCSI_SENSE_BUFFERSIZE;
504 sb_len = (hp->mx_sb_len > sb_len) ? sb_len : hp->mx_sb_len;
505 len = 8 + (int) srp->sense_b[7]; /* Additional sense length field */
506 len = (len > sb_len) ? sb_len : len;
507 if (copy_to_user(hp->sbp, srp->sense_b, len)) {
514 if (hp->masked_status || hp->host_status || hp->driver_status)
515 hp->info |= SG_INFO_CHECK;
516 if (copy_to_user(buf, hp, SZ_SG_IO_HDR)) {
521 sg_finish_rem_req(srp);
522 return (0 == err) ? count : err;
526 sg_write(struct file *filp, const char __user *buf, size_t count, loff_t * ppos)
528 int mxsize, cmd_size, k;
529 int input_size, blocking;
530 unsigned char opcode;
534 struct sg_header old_hdr;
536 unsigned char cmnd[MAX_COMMAND_SIZE];
538 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
540 SCSI_LOG_TIMEOUT(3, printk("sg_write: %s, count=%d\n",
541 sdp->disk->disk_name, (int) count));
544 if (!((filp->f_flags & O_NONBLOCK) ||
545 scsi_block_when_processing_errors(sdp->device)))
548 if (!access_ok(VERIFY_READ, buf, count))
549 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
550 if (count < SZ_SG_HEADER)
552 if (__copy_from_user(&old_hdr, buf, SZ_SG_HEADER))
554 blocking = !(filp->f_flags & O_NONBLOCK);
555 if (old_hdr.reply_len < 0)
556 return sg_new_write(sfp, filp, buf, count,
557 blocking, 0, 0, NULL);
558 if (count < (SZ_SG_HEADER + 6))
559 return -EIO; /* The minimum scsi command length is 6 bytes. */
561 if (!(srp = sg_add_request(sfp))) {
562 SCSI_LOG_TIMEOUT(1, printk("sg_write: queue full\n"));
566 __get_user(opcode, buf);
567 if (sfp->next_cmd_len > 0) {
568 if (sfp->next_cmd_len > MAX_COMMAND_SIZE) {
569 SCSI_LOG_TIMEOUT(1, printk("sg_write: command length too long\n"));
570 sfp->next_cmd_len = 0;
571 sg_remove_request(sfp, srp);
574 cmd_size = sfp->next_cmd_len;
575 sfp->next_cmd_len = 0; /* reset so only this write() effected */
577 cmd_size = COMMAND_SIZE(opcode); /* based on SCSI command group */
578 if ((opcode >= 0xc0) && old_hdr.twelve_byte)
581 SCSI_LOG_TIMEOUT(4, printk(
582 "sg_write: scsi opcode=0x%02x, cmd_size=%d\n", (int) opcode, cmd_size));
583 /* Determine buffer size. */
584 input_size = count - cmd_size;
585 mxsize = (input_size > old_hdr.reply_len) ? input_size : old_hdr.reply_len;
586 mxsize -= SZ_SG_HEADER;
587 input_size -= SZ_SG_HEADER;
588 if (input_size < 0) {
589 sg_remove_request(sfp, srp);
590 return -EIO; /* User did not pass enough bytes for this command. */
593 hp->interface_id = '\0'; /* indicator of old interface tunnelled */
594 hp->cmd_len = (unsigned char) cmd_size;
598 hp->dxfer_direction = (old_hdr.reply_len > SZ_SG_HEADER) ?
599 SG_DXFER_TO_FROM_DEV : SG_DXFER_TO_DEV;
601 hp->dxfer_direction = (mxsize > 0) ? SG_DXFER_FROM_DEV : SG_DXFER_NONE;
602 hp->dxfer_len = mxsize;
603 if (hp->dxfer_direction == SG_DXFER_TO_DEV)
604 hp->dxferp = (char __user *)buf + cmd_size;
608 hp->timeout = old_hdr.reply_len; /* structure abuse ... */
609 hp->flags = input_size; /* structure abuse ... */
610 hp->pack_id = old_hdr.pack_id;
612 if (__copy_from_user(cmnd, buf, cmd_size))
615 * SG_DXFER_TO_FROM_DEV is functionally equivalent to SG_DXFER_FROM_DEV,
616 * but is is possible that the app intended SG_DXFER_TO_DEV, because there
617 * is a non-zero input_size, so emit a warning.
619 if (hp->dxfer_direction == SG_DXFER_TO_FROM_DEV) {
620 static char cmd[TASK_COMM_LEN];
621 if (strcmp(current->comm, cmd) && printk_ratelimit()) {
623 "sg_write: data in/out %d/%d bytes for SCSI command 0x%x--"
624 "guessing data in;\n" KERN_WARNING " "
625 "program %s not setting count and/or reply_len properly\n",
626 old_hdr.reply_len - (int)SZ_SG_HEADER,
627 input_size, (unsigned int) cmnd[0],
629 strcpy(cmd, current->comm);
632 k = sg_common_write(sfp, srp, cmnd, sfp->timeout, blocking);
633 return (k < 0) ? k : count;
637 sg_new_write(Sg_fd *sfp, struct file *file, const char __user *buf,
638 size_t count, int blocking, int read_only, int sg_io_owned,
644 unsigned char cmnd[MAX_COMMAND_SIZE];
646 unsigned long ul_timeout;
648 if (count < SZ_SG_IO_HDR)
650 if (!access_ok(VERIFY_READ, buf, count))
651 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
653 sfp->cmd_q = 1; /* when sg_io_hdr seen, set command queuing on */
654 if (!(srp = sg_add_request(sfp))) {
655 SCSI_LOG_TIMEOUT(1, printk("sg_new_write: queue full\n"));
658 srp->sg_io_owned = sg_io_owned;
660 if (__copy_from_user(hp, buf, SZ_SG_IO_HDR)) {
661 sg_remove_request(sfp, srp);
664 if (hp->interface_id != 'S') {
665 sg_remove_request(sfp, srp);
668 if (hp->flags & SG_FLAG_MMAP_IO) {
669 if (hp->dxfer_len > sfp->reserve.bufflen) {
670 sg_remove_request(sfp, srp);
671 return -ENOMEM; /* MMAP_IO size must fit in reserve buffer */
673 if (hp->flags & SG_FLAG_DIRECT_IO) {
674 sg_remove_request(sfp, srp);
675 return -EINVAL; /* either MMAP_IO or DIRECT_IO (not both) */
677 if (sg_res_in_use(sfp)) {
678 sg_remove_request(sfp, srp);
679 return -EBUSY; /* reserve buffer already being used */
682 ul_timeout = msecs_to_jiffies(srp->header.timeout);
683 timeout = (ul_timeout < INT_MAX) ? ul_timeout : INT_MAX;
684 if ((!hp->cmdp) || (hp->cmd_len < 6) || (hp->cmd_len > sizeof (cmnd))) {
685 sg_remove_request(sfp, srp);
688 if (!access_ok(VERIFY_READ, hp->cmdp, hp->cmd_len)) {
689 sg_remove_request(sfp, srp);
690 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
692 if (__copy_from_user(cmnd, hp->cmdp, hp->cmd_len)) {
693 sg_remove_request(sfp, srp);
696 if (read_only && sg_allow_access(file, cmnd)) {
697 sg_remove_request(sfp, srp);
700 k = sg_common_write(sfp, srp, cmnd, timeout, blocking);
709 sg_common_write(Sg_fd * sfp, Sg_request * srp,
710 unsigned char *cmnd, int timeout, int blocking)
713 Sg_device *sdp = sfp->parentdp;
714 sg_io_hdr_t *hp = &srp->header;
716 srp->data.cmd_opcode = cmnd[0]; /* hold opcode of command */
718 hp->masked_status = 0;
722 hp->driver_status = 0;
724 SCSI_LOG_TIMEOUT(4, printk("sg_common_write: scsi opcode=0x%02x, cmd_size=%d\n",
725 (int) cmnd[0], (int) hp->cmd_len));
727 k = sg_start_req(srp, cmnd);
729 SCSI_LOG_TIMEOUT(1, printk("sg_common_write: start_req err=%d\n", k));
730 sg_finish_rem_req(srp);
731 return k; /* probably out of space --> ENOMEM */
734 sg_finish_rem_req(srp);
738 switch (hp->dxfer_direction) {
739 case SG_DXFER_TO_FROM_DEV:
740 case SG_DXFER_FROM_DEV:
741 data_dir = DMA_FROM_DEVICE;
743 case SG_DXFER_TO_DEV:
744 data_dir = DMA_TO_DEVICE;
746 case SG_DXFER_UNKNOWN:
747 data_dir = DMA_BIDIRECTIONAL;
753 hp->duration = jiffies_to_msecs(jiffies);
755 srp->rq->timeout = timeout;
756 kref_get(&sfp->f_ref); /* sg_rq_end_io() does kref_put(). */
757 blk_execute_rq_nowait(sdp->device->request_queue, sdp->disk,
758 srp->rq, 1, sg_rq_end_io);
763 sg_ioctl(struct inode *inode, struct file *filp,
764 unsigned int cmd_in, unsigned long arg)
766 void __user *p = (void __user *)arg;
768 int result, val, read_only;
772 unsigned long iflags;
774 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
777 SCSI_LOG_TIMEOUT(3, printk("sg_ioctl: %s, cmd=0x%x\n",
778 sdp->disk->disk_name, (int) cmd_in));
779 read_only = (O_RDWR != (filp->f_flags & O_ACCMODE));
784 int blocking = 1; /* ignore O_NONBLOCK flag */
788 if (!scsi_block_when_processing_errors(sdp->device))
790 if (!access_ok(VERIFY_WRITE, p, SZ_SG_IO_HDR))
793 sg_new_write(sfp, filp, p, SZ_SG_IO_HDR,
794 blocking, read_only, 1, &srp);
798 result = 0; /* following macro to beat race condition */
799 __wait_event_interruptible(sfp->read_wait,
800 (srp->done || sdp->detached),
804 write_lock_irq(&sfp->rq_list_lock);
807 write_unlock_irq(&sfp->rq_list_lock);
811 write_unlock_irq(&sfp->rq_list_lock);
812 return result; /* -ERESTARTSYS because signal hit process */
814 result = sg_new_read(sfp, p, SZ_SG_IO_HDR, srp);
815 return (result < 0) ? result : 0;
818 result = get_user(val, ip);
823 if (val >= MULDIV (INT_MAX, USER_HZ, HZ))
824 val = MULDIV (INT_MAX, USER_HZ, HZ);
825 sfp->timeout_user = val;
826 sfp->timeout = MULDIV (val, HZ, USER_HZ);
829 case SG_GET_TIMEOUT: /* N.B. User receives timeout as return value */
830 /* strange ..., for backward compatibility */
831 return sfp->timeout_user;
832 case SG_SET_FORCE_LOW_DMA:
833 result = get_user(val, ip);
838 if ((0 == sfp->low_dma) && (0 == sg_res_in_use(sfp))) {
839 val = (int) sfp->reserve.bufflen;
840 sg_remove_scat(&sfp->reserve);
841 sg_build_reserve(sfp, val);
846 sfp->low_dma = sdp->device->host->unchecked_isa_dma;
850 return put_user((int) sfp->low_dma, ip);
852 if (!access_ok(VERIFY_WRITE, p, sizeof (sg_scsi_id_t)))
855 sg_scsi_id_t __user *sg_idp = p;
859 __put_user((int) sdp->device->host->host_no,
861 __put_user((int) sdp->device->channel,
863 __put_user((int) sdp->device->id, &sg_idp->scsi_id);
864 __put_user((int) sdp->device->lun, &sg_idp->lun);
865 __put_user((int) sdp->device->type, &sg_idp->scsi_type);
866 __put_user((short) sdp->device->host->cmd_per_lun,
867 &sg_idp->h_cmd_per_lun);
868 __put_user((short) sdp->device->queue_depth,
869 &sg_idp->d_queue_depth);
870 __put_user(0, &sg_idp->unused[0]);
871 __put_user(0, &sg_idp->unused[1]);
874 case SG_SET_FORCE_PACK_ID:
875 result = get_user(val, ip);
878 sfp->force_packid = val ? 1 : 0;
881 if (!access_ok(VERIFY_WRITE, ip, sizeof (int)))
883 read_lock_irqsave(&sfp->rq_list_lock, iflags);
884 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
885 if ((1 == srp->done) && (!srp->sg_io_owned)) {
886 read_unlock_irqrestore(&sfp->rq_list_lock,
888 __put_user(srp->header.pack_id, ip);
892 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
895 case SG_GET_NUM_WAITING:
896 read_lock_irqsave(&sfp->rq_list_lock, iflags);
897 for (val = 0, srp = sfp->headrp; srp; srp = srp->nextrp) {
898 if ((1 == srp->done) && (!srp->sg_io_owned))
901 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
902 return put_user(val, ip);
903 case SG_GET_SG_TABLESIZE:
904 return put_user(sdp->sg_tablesize, ip);
905 case SG_SET_RESERVED_SIZE:
906 result = get_user(val, ip);
911 val = min_t(int, val,
912 sdp->device->request_queue->max_sectors * 512);
913 if (val != sfp->reserve.bufflen) {
914 if (sg_res_in_use(sfp) || sfp->mmap_called)
916 sg_remove_scat(&sfp->reserve);
917 sg_build_reserve(sfp, val);
920 case SG_GET_RESERVED_SIZE:
921 val = min_t(int, sfp->reserve.bufflen,
922 sdp->device->request_queue->max_sectors * 512);
923 return put_user(val, ip);
924 case SG_SET_COMMAND_Q:
925 result = get_user(val, ip);
928 sfp->cmd_q = val ? 1 : 0;
930 case SG_GET_COMMAND_Q:
931 return put_user((int) sfp->cmd_q, ip);
932 case SG_SET_KEEP_ORPHAN:
933 result = get_user(val, ip);
936 sfp->keep_orphan = val;
938 case SG_GET_KEEP_ORPHAN:
939 return put_user((int) sfp->keep_orphan, ip);
940 case SG_NEXT_CMD_LEN:
941 result = get_user(val, ip);
944 sfp->next_cmd_len = (val > 0) ? val : 0;
946 case SG_GET_VERSION_NUM:
947 return put_user(sg_version_num, ip);
948 case SG_GET_ACCESS_COUNT:
949 /* faked - we don't have a real access count anymore */
950 val = (sdp->device ? 1 : 0);
951 return put_user(val, ip);
952 case SG_GET_REQUEST_TABLE:
953 if (!access_ok(VERIFY_WRITE, p, SZ_SG_REQ_INFO * SG_MAX_QUEUE))
956 sg_req_info_t *rinfo;
959 rinfo = kmalloc(SZ_SG_REQ_INFO * SG_MAX_QUEUE,
963 read_lock_irqsave(&sfp->rq_list_lock, iflags);
964 for (srp = sfp->headrp, val = 0; val < SG_MAX_QUEUE;
965 ++val, srp = srp ? srp->nextrp : srp) {
966 memset(&rinfo[val], 0, SZ_SG_REQ_INFO);
968 rinfo[val].req_state = srp->done + 1;
970 srp->header.masked_status &
971 srp->header.host_status &
972 srp->header.driver_status;
974 rinfo[val].duration =
975 srp->header.duration;
977 ms = jiffies_to_msecs(jiffies);
978 rinfo[val].duration =
979 (ms > srp->header.duration) ?
980 (ms - srp->header.duration) : 0;
982 rinfo[val].orphan = srp->orphan;
983 rinfo[val].sg_io_owned =
991 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
992 result = __copy_to_user(p, rinfo,
993 SZ_SG_REQ_INFO * SG_MAX_QUEUE);
994 result = result ? -EFAULT : 0;
998 case SG_EMULATED_HOST:
1001 return put_user(sdp->device->host->hostt->emulated, ip);
1005 if (filp->f_flags & O_NONBLOCK) {
1006 if (scsi_host_in_recovery(sdp->device->host))
1008 } else if (!scsi_block_when_processing_errors(sdp->device))
1010 result = get_user(val, ip);
1013 if (SG_SCSI_RESET_NOTHING == val)
1016 case SG_SCSI_RESET_DEVICE:
1017 val = SCSI_TRY_RESET_DEVICE;
1019 case SG_SCSI_RESET_TARGET:
1020 val = SCSI_TRY_RESET_TARGET;
1022 case SG_SCSI_RESET_BUS:
1023 val = SCSI_TRY_RESET_BUS;
1025 case SG_SCSI_RESET_HOST:
1026 val = SCSI_TRY_RESET_HOST;
1031 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
1033 return (scsi_reset_provider(sdp->device, val) ==
1034 SUCCESS) ? 0 : -EIO;
1035 case SCSI_IOCTL_SEND_COMMAND:
1039 unsigned char opcode = WRITE_6;
1040 Scsi_Ioctl_Command __user *siocp = p;
1042 if (copy_from_user(&opcode, siocp->data, 1))
1044 if (sg_allow_access(filp, &opcode))
1047 return sg_scsi_ioctl(sdp->device->request_queue, NULL, filp->f_mode, p);
1049 result = get_user(val, ip);
1052 sdp->sgdebug = (char) val;
1054 case SCSI_IOCTL_GET_IDLUN:
1055 case SCSI_IOCTL_GET_BUS_NUMBER:
1056 case SCSI_IOCTL_PROBE_HOST:
1057 case SG_GET_TRANSFORM:
1060 return scsi_ioctl(sdp->device, cmd_in, p);
1062 return put_user(sdp->device->request_queue->max_sectors * 512,
1065 return blk_trace_setup(sdp->device->request_queue,
1066 sdp->disk->disk_name,
1067 MKDEV(SCSI_GENERIC_MAJOR, sdp->index),
1070 return blk_trace_startstop(sdp->device->request_queue, 1);
1072 return blk_trace_startstop(sdp->device->request_queue, 0);
1073 case BLKTRACETEARDOWN:
1074 return blk_trace_remove(sdp->device->request_queue);
1077 return -EPERM; /* don't know so take safe approach */
1078 return scsi_ioctl(sdp->device, cmd_in, p);
1082 #ifdef CONFIG_COMPAT
1083 static long sg_compat_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
1087 struct scsi_device *sdev;
1089 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1093 if (sdev->host->hostt->compat_ioctl) {
1096 ret = sdev->host->hostt->compat_ioctl(sdev, cmd_in, (void __user *)arg);
1101 return -ENOIOCTLCMD;
1106 sg_poll(struct file *filp, poll_table * wait)
1108 unsigned int res = 0;
1113 unsigned long iflags;
1115 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp))
1118 poll_wait(filp, &sfp->read_wait, wait);
1119 read_lock_irqsave(&sfp->rq_list_lock, iflags);
1120 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
1121 /* if any read waiting, flag it */
1122 if ((0 == res) && (1 == srp->done) && (!srp->sg_io_owned))
1123 res = POLLIN | POLLRDNORM;
1126 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1130 else if (!sfp->cmd_q) {
1132 res |= POLLOUT | POLLWRNORM;
1133 } else if (count < SG_MAX_QUEUE)
1134 res |= POLLOUT | POLLWRNORM;
1135 SCSI_LOG_TIMEOUT(3, printk("sg_poll: %s, res=0x%x\n",
1136 sdp->disk->disk_name, (int) res));
1141 sg_fasync(int fd, struct file *filp, int mode)
1146 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1148 SCSI_LOG_TIMEOUT(3, printk("sg_fasync: %s, mode=%d\n",
1149 sdp->disk->disk_name, mode));
1151 return fasync_helper(fd, filp, mode, &sfp->async_qp);
1155 sg_vma_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
1158 unsigned long offset, len, sa;
1159 Sg_scatter_hold *rsv_schp;
1162 if ((NULL == vma) || (!(sfp = (Sg_fd *) vma->vm_private_data)))
1163 return VM_FAULT_SIGBUS;
1164 rsv_schp = &sfp->reserve;
1165 offset = vmf->pgoff << PAGE_SHIFT;
1166 if (offset >= rsv_schp->bufflen)
1167 return VM_FAULT_SIGBUS;
1168 SCSI_LOG_TIMEOUT(3, printk("sg_vma_fault: offset=%lu, scatg=%d\n",
1169 offset, rsv_schp->k_use_sg));
1171 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1172 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
1173 len = vma->vm_end - sa;
1174 len = (len < length) ? len : length;
1176 struct page *page = nth_page(rsv_schp->pages[k],
1177 offset >> PAGE_SHIFT);
1178 get_page(page); /* increment page count */
1180 return 0; /* success */
1186 return VM_FAULT_SIGBUS;
1189 static struct vm_operations_struct sg_mmap_vm_ops = {
1190 .fault = sg_vma_fault,
1194 sg_mmap(struct file *filp, struct vm_area_struct *vma)
1197 unsigned long req_sz, len, sa;
1198 Sg_scatter_hold *rsv_schp;
1201 if ((!filp) || (!vma) || (!(sfp = (Sg_fd *) filp->private_data)))
1203 req_sz = vma->vm_end - vma->vm_start;
1204 SCSI_LOG_TIMEOUT(3, printk("sg_mmap starting, vm_start=%p, len=%d\n",
1205 (void *) vma->vm_start, (int) req_sz));
1207 return -EINVAL; /* want no offset */
1208 rsv_schp = &sfp->reserve;
1209 if (req_sz > rsv_schp->bufflen)
1210 return -ENOMEM; /* cannot map more than reserved buffer */
1213 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1214 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
1215 len = vma->vm_end - sa;
1216 len = (len < length) ? len : length;
1220 sfp->mmap_called = 1;
1221 vma->vm_flags |= VM_RESERVED;
1222 vma->vm_private_data = sfp;
1223 vma->vm_ops = &sg_mmap_vm_ops;
1227 static void sg_rq_end_io_usercontext(struct work_struct *work)
1229 struct sg_request *srp = container_of(work, struct sg_request, ew.work);
1230 struct sg_fd *sfp = srp->parentfp;
1232 sg_finish_rem_req(srp);
1233 kref_put(&sfp->f_ref, sg_remove_sfp);
1237 * This function is a "bottom half" handler that is called by the mid
1238 * level when a command is completed (or has failed).
1240 static void sg_rq_end_io(struct request *rq, int uptodate)
1242 struct sg_request *srp = rq->end_io_data;
1245 unsigned long iflags;
1248 int result, resid, done = 1;
1250 if (WARN_ON(srp->done != 0))
1253 sfp = srp->parentfp;
1254 if (WARN_ON(sfp == NULL))
1257 sdp = sfp->parentdp;
1258 if (unlikely(sdp->detached))
1259 printk(KERN_INFO "sg_rq_end_io: device detached\n");
1262 result = rq->errors;
1263 resid = rq->data_len;
1265 SCSI_LOG_TIMEOUT(4, printk("sg_cmd_done: %s, pack_id=%d, res=0x%x\n",
1266 sdp->disk->disk_name, srp->header.pack_id, result));
1267 srp->header.resid = resid;
1268 ms = jiffies_to_msecs(jiffies);
1269 srp->header.duration = (ms > srp->header.duration) ?
1270 (ms - srp->header.duration) : 0;
1272 struct scsi_sense_hdr sshdr;
1274 srp->header.status = 0xff & result;
1275 srp->header.masked_status = status_byte(result);
1276 srp->header.msg_status = msg_byte(result);
1277 srp->header.host_status = host_byte(result);
1278 srp->header.driver_status = driver_byte(result);
1279 if ((sdp->sgdebug > 0) &&
1280 ((CHECK_CONDITION == srp->header.masked_status) ||
1281 (COMMAND_TERMINATED == srp->header.masked_status)))
1282 __scsi_print_sense("sg_cmd_done", sense,
1283 SCSI_SENSE_BUFFERSIZE);
1285 /* Following if statement is a patch supplied by Eric Youngdale */
1286 if (driver_byte(result) != 0
1287 && scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, &sshdr)
1288 && !scsi_sense_is_deferred(&sshdr)
1289 && sshdr.sense_key == UNIT_ATTENTION
1290 && sdp->device->removable) {
1291 /* Detected possible disc change. Set the bit - this */
1292 /* may be used if there are filesystems using this device */
1293 sdp->device->changed = 1;
1296 /* Rely on write phase to clean out srp status values, so no "else" */
1298 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1299 if (unlikely(srp->orphan)) {
1300 if (sfp->keep_orphan)
1301 srp->sg_io_owned = 0;
1306 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1309 /* Now wake up any sg_read() that is waiting for this
1312 wake_up_interruptible(&sfp->read_wait);
1313 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_IN);
1314 kref_put(&sfp->f_ref, sg_remove_sfp);
1316 execute_in_process_context(sg_rq_end_io_usercontext, &srp->ew);
1319 static struct file_operations sg_fops = {
1320 .owner = THIS_MODULE,
1325 #ifdef CONFIG_COMPAT
1326 .compat_ioctl = sg_compat_ioctl,
1330 .release = sg_release,
1331 .fasync = sg_fasync,
1334 static struct class *sg_sysfs_class;
1336 static int sg_sysfs_valid = 0;
1338 static Sg_device *sg_alloc(struct gendisk *disk, struct scsi_device *scsidp)
1340 struct request_queue *q = scsidp->request_queue;
1342 unsigned long iflags;
1346 sdp = kzalloc(sizeof(Sg_device), GFP_KERNEL);
1348 printk(KERN_WARNING "kmalloc Sg_device failure\n");
1349 return ERR_PTR(-ENOMEM);
1352 if (!idr_pre_get(&sg_index_idr, GFP_KERNEL)) {
1353 printk(KERN_WARNING "idr expansion Sg_device failure\n");
1358 write_lock_irqsave(&sg_index_lock, iflags);
1360 error = idr_get_new(&sg_index_idr, sdp, &k);
1362 write_unlock_irqrestore(&sg_index_lock, iflags);
1363 printk(KERN_WARNING "idr allocation Sg_device failure: %d\n",
1368 if (unlikely(k >= SG_MAX_DEVS))
1371 SCSI_LOG_TIMEOUT(3, printk("sg_alloc: dev=%d \n", k));
1372 sprintf(disk->disk_name, "sg%d", k);
1373 disk->first_minor = k;
1375 sdp->device = scsidp;
1376 INIT_LIST_HEAD(&sdp->sfds);
1377 init_waitqueue_head(&sdp->o_excl_wait);
1378 sdp->sg_tablesize = min(q->max_hw_segments, q->max_phys_segments);
1380 kref_init(&sdp->d_ref);
1382 write_unlock_irqrestore(&sg_index_lock, iflags);
1388 return ERR_PTR(error);
1393 idr_remove(&sg_index_idr, k);
1394 write_unlock_irqrestore(&sg_index_lock, iflags);
1395 sdev_printk(KERN_WARNING, scsidp,
1396 "Unable to attach sg device type=%d, minor "
1397 "number exceeds %d\n", scsidp->type, SG_MAX_DEVS - 1);
1403 sg_add(struct device *cl_dev, struct class_interface *cl_intf)
1405 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
1406 struct gendisk *disk;
1407 Sg_device *sdp = NULL;
1408 struct cdev * cdev = NULL;
1410 unsigned long iflags;
1412 disk = alloc_disk(1);
1414 printk(KERN_WARNING "alloc_disk failed\n");
1417 disk->major = SCSI_GENERIC_MAJOR;
1420 cdev = cdev_alloc();
1422 printk(KERN_WARNING "cdev_alloc failed\n");
1425 cdev->owner = THIS_MODULE;
1426 cdev->ops = &sg_fops;
1428 sdp = sg_alloc(disk, scsidp);
1430 printk(KERN_WARNING "sg_alloc failed\n");
1431 error = PTR_ERR(sdp);
1435 error = cdev_add(cdev, MKDEV(SCSI_GENERIC_MAJOR, sdp->index), 1);
1440 if (sg_sysfs_valid) {
1441 struct device *sg_class_member;
1443 sg_class_member = device_create(sg_sysfs_class, cl_dev->parent,
1444 MKDEV(SCSI_GENERIC_MAJOR,
1446 sdp, "%s", disk->disk_name);
1447 if (IS_ERR(sg_class_member)) {
1448 printk(KERN_ERR "sg_add: "
1449 "device_create failed\n");
1450 error = PTR_ERR(sg_class_member);
1453 error = sysfs_create_link(&scsidp->sdev_gendev.kobj,
1454 &sg_class_member->kobj, "generic");
1456 printk(KERN_ERR "sg_add: unable to make symlink "
1457 "'generic' back to sg%d\n", sdp->index);
1459 printk(KERN_WARNING "sg_add: sg_sys Invalid\n");
1461 sdev_printk(KERN_NOTICE, scsidp,
1462 "Attached scsi generic sg%d type %d\n", sdp->index,
1465 dev_set_drvdata(cl_dev, sdp);
1470 write_lock_irqsave(&sg_index_lock, iflags);
1471 idr_remove(&sg_index_idr, sdp->index);
1472 write_unlock_irqrestore(&sg_index_lock, iflags);
1482 static void sg_device_destroy(struct kref *kref)
1484 struct sg_device *sdp = container_of(kref, struct sg_device, d_ref);
1485 unsigned long flags;
1487 /* CAUTION! Note that the device can still be found via idr_find()
1488 * even though the refcount is 0. Therefore, do idr_remove() BEFORE
1489 * any other cleanup.
1492 write_lock_irqsave(&sg_index_lock, flags);
1493 idr_remove(&sg_index_idr, sdp->index);
1494 write_unlock_irqrestore(&sg_index_lock, flags);
1497 printk("sg_device_destroy: %s\n",
1498 sdp->disk->disk_name));
1500 put_disk(sdp->disk);
1504 static void sg_remove(struct device *cl_dev, struct class_interface *cl_intf)
1506 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
1507 Sg_device *sdp = dev_get_drvdata(cl_dev);
1508 unsigned long iflags;
1511 if (!sdp || sdp->detached)
1514 SCSI_LOG_TIMEOUT(3, printk("sg_remove: %s\n", sdp->disk->disk_name));
1516 /* Need a write lock to set sdp->detached. */
1517 write_lock_irqsave(&sg_index_lock, iflags);
1519 list_for_each_entry(sfp, &sdp->sfds, sfd_siblings) {
1520 wake_up_interruptible(&sfp->read_wait);
1521 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_HUP);
1523 write_unlock_irqrestore(&sg_index_lock, iflags);
1525 sysfs_remove_link(&scsidp->sdev_gendev.kobj, "generic");
1526 device_destroy(sg_sysfs_class, MKDEV(SCSI_GENERIC_MAJOR, sdp->index));
1527 cdev_del(sdp->cdev);
1533 module_param_named(scatter_elem_sz, scatter_elem_sz, int, S_IRUGO | S_IWUSR);
1534 module_param_named(def_reserved_size, def_reserved_size, int,
1536 module_param_named(allow_dio, sg_allow_dio, int, S_IRUGO | S_IWUSR);
1538 MODULE_AUTHOR("Douglas Gilbert");
1539 MODULE_DESCRIPTION("SCSI generic (sg) driver");
1540 MODULE_LICENSE("GPL");
1541 MODULE_VERSION(SG_VERSION_STR);
1542 MODULE_ALIAS_CHARDEV_MAJOR(SCSI_GENERIC_MAJOR);
1544 MODULE_PARM_DESC(scatter_elem_sz, "scatter gather element "
1545 "size (default: max(SG_SCATTER_SZ, PAGE_SIZE))");
1546 MODULE_PARM_DESC(def_reserved_size, "size of buffer reserved for each fd");
1547 MODULE_PARM_DESC(allow_dio, "allow direct I/O (default: 0 (disallow))");
1554 if (scatter_elem_sz < PAGE_SIZE) {
1555 scatter_elem_sz = PAGE_SIZE;
1556 scatter_elem_sz_prev = scatter_elem_sz;
1558 if (def_reserved_size >= 0)
1559 sg_big_buff = def_reserved_size;
1561 def_reserved_size = sg_big_buff;
1563 rc = register_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1567 sg_sysfs_class = class_create(THIS_MODULE, "scsi_generic");
1568 if ( IS_ERR(sg_sysfs_class) ) {
1569 rc = PTR_ERR(sg_sysfs_class);
1573 rc = scsi_register_interface(&sg_interface);
1575 #ifdef CONFIG_SCSI_PROC_FS
1577 #endif /* CONFIG_SCSI_PROC_FS */
1580 class_destroy(sg_sysfs_class);
1582 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0), SG_MAX_DEVS);
1589 #ifdef CONFIG_SCSI_PROC_FS
1591 #endif /* CONFIG_SCSI_PROC_FS */
1592 scsi_unregister_interface(&sg_interface);
1593 class_destroy(sg_sysfs_class);
1595 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1597 idr_destroy(&sg_index_idr);
1600 static int sg_start_req(Sg_request *srp, unsigned char *cmd)
1604 Sg_fd *sfp = srp->parentfp;
1605 sg_io_hdr_t *hp = &srp->header;
1606 int dxfer_len = (int) hp->dxfer_len;
1607 int dxfer_dir = hp->dxfer_direction;
1608 unsigned int iov_count = hp->iovec_count;
1609 Sg_scatter_hold *req_schp = &srp->data;
1610 Sg_scatter_hold *rsv_schp = &sfp->reserve;
1611 struct request_queue *q = sfp->parentdp->device->request_queue;
1612 struct rq_map_data *md, map_data;
1613 int rw = hp->dxfer_direction == SG_DXFER_TO_DEV ? WRITE : READ;
1615 SCSI_LOG_TIMEOUT(4, printk(KERN_INFO "sg_start_req: dxfer_len=%d\n",
1618 rq = blk_get_request(q, rw, GFP_ATOMIC);
1622 memcpy(rq->cmd, cmd, hp->cmd_len);
1624 rq->cmd_len = hp->cmd_len;
1625 rq->cmd_type = REQ_TYPE_BLOCK_PC;
1628 rq->end_io_data = srp;
1629 rq->sense = srp->sense_b;
1630 rq->retries = SG_DEFAULT_RETRIES;
1632 if ((dxfer_len <= 0) || (dxfer_dir == SG_DXFER_NONE))
1635 if (sg_allow_dio && hp->flags & SG_FLAG_DIRECT_IO &&
1636 dxfer_dir != SG_DXFER_UNKNOWN && !iov_count &&
1637 !sfp->parentdp->device->host->unchecked_isa_dma &&
1638 blk_rq_aligned(q, hp->dxferp, dxfer_len))
1644 if (!sg_res_in_use(sfp) && dxfer_len <= rsv_schp->bufflen)
1645 sg_link_reserve(sfp, srp, dxfer_len);
1647 res = sg_build_indirect(req_schp, sfp, dxfer_len);
1652 md->pages = req_schp->pages;
1653 md->page_order = req_schp->page_order;
1654 md->nr_entries = req_schp->k_use_sg;
1656 md->null_mapped = hp->dxferp ? 0 : 1;
1660 res = blk_rq_map_user_iov(q, rq, md, hp->dxferp, iov_count,
1661 hp->dxfer_len, GFP_ATOMIC);
1663 res = blk_rq_map_user(q, rq, md, hp->dxferp,
1664 hp->dxfer_len, GFP_ATOMIC);
1670 req_schp->dio_in_use = 1;
1671 hp->info |= SG_INFO_DIRECT_IO;
1678 sg_finish_rem_req(Sg_request * srp)
1680 Sg_fd *sfp = srp->parentfp;
1681 Sg_scatter_hold *req_schp = &srp->data;
1683 SCSI_LOG_TIMEOUT(4, printk("sg_finish_rem_req: res_used=%d\n", (int) srp->res_used));
1685 sg_unlink_reserve(sfp, srp);
1687 sg_remove_scat(req_schp);
1691 blk_rq_unmap_user(srp->bio);
1693 blk_put_request(srp->rq);
1696 sg_remove_request(sfp, srp);
1700 sg_build_sgat(Sg_scatter_hold * schp, const Sg_fd * sfp, int tablesize)
1702 int sg_bufflen = tablesize * sizeof(struct page *);
1703 gfp_t gfp_flags = GFP_ATOMIC | __GFP_NOWARN;
1705 schp->pages = kzalloc(sg_bufflen, gfp_flags);
1708 schp->sglist_len = sg_bufflen;
1709 return tablesize; /* number of scat_gath elements allocated */
1713 sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size)
1715 int ret_sz = 0, i, k, rem_sz, num, mx_sc_elems;
1716 int sg_tablesize = sfp->parentdp->sg_tablesize;
1717 int blk_size = buff_size, order;
1718 gfp_t gfp_mask = GFP_ATOMIC | __GFP_COMP | __GFP_NOWARN;
1723 ++blk_size; /* don't know why */
1724 /* round request up to next highest SG_SECTOR_SZ byte boundary */
1725 blk_size = ALIGN(blk_size, SG_SECTOR_SZ);
1726 SCSI_LOG_TIMEOUT(4, printk("sg_build_indirect: buff_size=%d, blk_size=%d\n",
1727 buff_size, blk_size));
1729 /* N.B. ret_sz carried into this block ... */
1730 mx_sc_elems = sg_build_sgat(schp, sfp, sg_tablesize);
1731 if (mx_sc_elems < 0)
1732 return mx_sc_elems; /* most likely -ENOMEM */
1734 num = scatter_elem_sz;
1735 if (unlikely(num != scatter_elem_sz_prev)) {
1736 if (num < PAGE_SIZE) {
1737 scatter_elem_sz = PAGE_SIZE;
1738 scatter_elem_sz_prev = PAGE_SIZE;
1740 scatter_elem_sz_prev = num;
1744 gfp_mask |= GFP_DMA;
1746 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
1747 gfp_mask |= __GFP_ZERO;
1749 order = get_order(num);
1751 ret_sz = 1 << (PAGE_SHIFT + order);
1753 for (k = 0, rem_sz = blk_size; rem_sz > 0 && k < mx_sc_elems;
1754 k++, rem_sz -= ret_sz) {
1756 num = (rem_sz > scatter_elem_sz_prev) ?
1757 scatter_elem_sz_prev : rem_sz;
1759 schp->pages[k] = alloc_pages(gfp_mask, order);
1760 if (!schp->pages[k])
1763 if (num == scatter_elem_sz_prev) {
1764 if (unlikely(ret_sz > scatter_elem_sz_prev)) {
1765 scatter_elem_sz = ret_sz;
1766 scatter_elem_sz_prev = ret_sz;
1770 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k=%d, num=%d, "
1771 "ret_sz=%d\n", k, num, ret_sz));
1772 } /* end of for loop */
1774 schp->page_order = order;
1776 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k_use_sg=%d, "
1777 "rem_sz=%d\n", k, rem_sz));
1779 schp->bufflen = blk_size;
1780 if (rem_sz > 0) /* must have failed */
1784 for (i = 0; i < k; i++)
1785 __free_pages(schp->pages[k], order);
1794 sg_remove_scat(Sg_scatter_hold * schp)
1796 SCSI_LOG_TIMEOUT(4, printk("sg_remove_scat: k_use_sg=%d\n", schp->k_use_sg));
1797 if (schp->pages && schp->sglist_len > 0) {
1798 if (!schp->dio_in_use) {
1801 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
1802 SCSI_LOG_TIMEOUT(5, printk(
1803 "sg_remove_scat: k=%d, pg=0x%p\n",
1804 k, schp->pages[k]));
1805 __free_pages(schp->pages[k], schp->page_order);
1811 memset(schp, 0, sizeof (*schp));
1815 sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer)
1817 Sg_scatter_hold *schp = &srp->data;
1820 SCSI_LOG_TIMEOUT(4, printk("sg_read_oxfer: num_read_xfer=%d\n",
1822 if ((!outp) || (num_read_xfer <= 0))
1825 num = 1 << (PAGE_SHIFT + schp->page_order);
1826 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
1827 if (num > num_read_xfer) {
1828 if (__copy_to_user(outp, page_address(schp->pages[k]),
1833 if (__copy_to_user(outp, page_address(schp->pages[k]),
1836 num_read_xfer -= num;
1837 if (num_read_xfer <= 0)
1847 sg_build_reserve(Sg_fd * sfp, int req_size)
1849 Sg_scatter_hold *schp = &sfp->reserve;
1851 SCSI_LOG_TIMEOUT(4, printk("sg_build_reserve: req_size=%d\n", req_size));
1853 if (req_size < PAGE_SIZE)
1854 req_size = PAGE_SIZE;
1855 if (0 == sg_build_indirect(schp, sfp, req_size))
1858 sg_remove_scat(schp);
1859 req_size >>= 1; /* divide by 2 */
1860 } while (req_size > (PAGE_SIZE / 2));
1864 sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size)
1866 Sg_scatter_hold *req_schp = &srp->data;
1867 Sg_scatter_hold *rsv_schp = &sfp->reserve;
1871 SCSI_LOG_TIMEOUT(4, printk("sg_link_reserve: size=%d\n", size));
1874 num = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1875 for (k = 0; k < rsv_schp->k_use_sg; k++) {
1877 req_schp->k_use_sg = k + 1;
1878 req_schp->sglist_len = rsv_schp->sglist_len;
1879 req_schp->pages = rsv_schp->pages;
1881 req_schp->bufflen = size;
1882 req_schp->page_order = rsv_schp->page_order;
1888 if (k >= rsv_schp->k_use_sg)
1889 SCSI_LOG_TIMEOUT(1, printk("sg_link_reserve: BAD size\n"));
1893 sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp)
1895 Sg_scatter_hold *req_schp = &srp->data;
1897 SCSI_LOG_TIMEOUT(4, printk("sg_unlink_reserve: req->k_use_sg=%d\n",
1898 (int) req_schp->k_use_sg));
1899 req_schp->k_use_sg = 0;
1900 req_schp->bufflen = 0;
1901 req_schp->pages = NULL;
1902 req_schp->page_order = 0;
1903 req_schp->sglist_len = 0;
1904 sfp->save_scat_len = 0;
1909 sg_get_rq_mark(Sg_fd * sfp, int pack_id)
1912 unsigned long iflags;
1914 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1915 for (resp = sfp->headrp; resp; resp = resp->nextrp) {
1916 /* look for requests that are ready + not SG_IO owned */
1917 if ((1 == resp->done) && (!resp->sg_io_owned) &&
1918 ((-1 == pack_id) || (resp->header.pack_id == pack_id))) {
1919 resp->done = 2; /* guard against other readers */
1923 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1927 /* always adds to end of list */
1929 sg_add_request(Sg_fd * sfp)
1932 unsigned long iflags;
1934 Sg_request *rp = sfp->req_arr;
1936 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1939 memset(rp, 0, sizeof (Sg_request));
1944 if (0 == sfp->cmd_q)
1945 resp = NULL; /* command queuing disallowed */
1947 for (k = 0; k < SG_MAX_QUEUE; ++k, ++rp) {
1951 if (k < SG_MAX_QUEUE) {
1952 memset(rp, 0, sizeof (Sg_request));
1954 while (resp->nextrp)
1955 resp = resp->nextrp;
1963 resp->nextrp = NULL;
1964 resp->header.duration = jiffies_to_msecs(jiffies);
1966 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1970 /* Return of 1 for found; 0 for not found */
1972 sg_remove_request(Sg_fd * sfp, Sg_request * srp)
1974 Sg_request *prev_rp;
1976 unsigned long iflags;
1979 if ((!sfp) || (!srp) || (!sfp->headrp))
1981 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1982 prev_rp = sfp->headrp;
1983 if (srp == prev_rp) {
1984 sfp->headrp = prev_rp->nextrp;
1985 prev_rp->parentfp = NULL;
1988 while ((rp = prev_rp->nextrp)) {
1990 prev_rp->nextrp = rp->nextrp;
1991 rp->parentfp = NULL;
1998 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2003 sg_add_sfp(Sg_device * sdp, int dev)
2006 unsigned long iflags;
2009 sfp = kzalloc(sizeof(*sfp), GFP_ATOMIC | __GFP_NOWARN);
2013 init_waitqueue_head(&sfp->read_wait);
2014 rwlock_init(&sfp->rq_list_lock);
2016 kref_init(&sfp->f_ref);
2017 sfp->timeout = SG_DEFAULT_TIMEOUT;
2018 sfp->timeout_user = SG_DEFAULT_TIMEOUT_USER;
2019 sfp->force_packid = SG_DEF_FORCE_PACK_ID;
2020 sfp->low_dma = (SG_DEF_FORCE_LOW_DMA == 0) ?
2021 sdp->device->host->unchecked_isa_dma : 1;
2022 sfp->cmd_q = SG_DEF_COMMAND_Q;
2023 sfp->keep_orphan = SG_DEF_KEEP_ORPHAN;
2024 sfp->parentdp = sdp;
2025 write_lock_irqsave(&sg_index_lock, iflags);
2026 list_add_tail(&sfp->sfd_siblings, &sdp->sfds);
2027 write_unlock_irqrestore(&sg_index_lock, iflags);
2028 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: sfp=0x%p\n", sfp));
2029 if (unlikely(sg_big_buff != def_reserved_size))
2030 sg_big_buff = def_reserved_size;
2032 bufflen = min_t(int, sg_big_buff,
2033 sdp->device->request_queue->max_sectors * 512);
2034 sg_build_reserve(sfp, bufflen);
2035 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: bufflen=%d, k_use_sg=%d\n",
2036 sfp->reserve.bufflen, sfp->reserve.k_use_sg));
2038 kref_get(&sdp->d_ref);
2039 __module_get(THIS_MODULE);
2043 static void sg_remove_sfp_usercontext(struct work_struct *work)
2045 struct sg_fd *sfp = container_of(work, struct sg_fd, ew.work);
2046 struct sg_device *sdp = sfp->parentdp;
2048 /* Cleanup any responses which were never read(). */
2050 sg_finish_rem_req(sfp->headrp);
2052 if (sfp->reserve.bufflen > 0) {
2054 printk("sg_remove_sfp: bufflen=%d, k_use_sg=%d\n",
2055 (int) sfp->reserve.bufflen,
2056 (int) sfp->reserve.k_use_sg));
2057 sg_remove_scat(&sfp->reserve);
2061 printk("sg_remove_sfp: %s, sfp=0x%p\n",
2062 sdp->disk->disk_name,
2066 scsi_device_put(sdp->device);
2068 module_put(THIS_MODULE);
2071 static void sg_remove_sfp(struct kref *kref)
2073 struct sg_fd *sfp = container_of(kref, struct sg_fd, f_ref);
2074 struct sg_device *sdp = sfp->parentdp;
2075 unsigned long iflags;
2077 write_lock_irqsave(&sg_index_lock, iflags);
2078 list_del(&sfp->sfd_siblings);
2079 write_unlock_irqrestore(&sg_index_lock, iflags);
2080 wake_up_interruptible(&sdp->o_excl_wait);
2082 execute_in_process_context(sg_remove_sfp_usercontext, &sfp->ew);
2086 sg_res_in_use(Sg_fd * sfp)
2088 const Sg_request *srp;
2089 unsigned long iflags;
2091 read_lock_irqsave(&sfp->rq_list_lock, iflags);
2092 for (srp = sfp->headrp; srp; srp = srp->nextrp)
2095 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2099 #ifdef CONFIG_SCSI_PROC_FS
2101 sg_idr_max_id(int id, void *p, void *data)
2115 unsigned long iflags;
2117 read_lock_irqsave(&sg_index_lock, iflags);
2118 idr_for_each(&sg_index_idr, sg_idr_max_id, &k);
2119 read_unlock_irqrestore(&sg_index_lock, iflags);
2120 return k + 1; /* origin 1 */
2124 /* must be called with sg_index_lock held */
2125 static Sg_device *sg_lookup_dev(int dev)
2127 return idr_find(&sg_index_idr, dev);
2130 static Sg_device *sg_get_dev(int dev)
2132 struct sg_device *sdp;
2133 unsigned long flags;
2135 read_lock_irqsave(&sg_index_lock, flags);
2136 sdp = sg_lookup_dev(dev);
2138 sdp = ERR_PTR(-ENXIO);
2139 else if (sdp->detached) {
2140 /* If sdp->detached, then the refcount may already be 0, in
2141 * which case it would be a bug to do kref_get().
2143 sdp = ERR_PTR(-ENODEV);
2145 kref_get(&sdp->d_ref);
2146 read_unlock_irqrestore(&sg_index_lock, flags);
2151 static void sg_put_dev(struct sg_device *sdp)
2153 kref_put(&sdp->d_ref, sg_device_destroy);
2156 #ifdef CONFIG_SCSI_PROC_FS
2158 static struct proc_dir_entry *sg_proc_sgp = NULL;
2160 static char sg_proc_sg_dirname[] = "scsi/sg";
2162 static int sg_proc_seq_show_int(struct seq_file *s, void *v);
2164 static int sg_proc_single_open_adio(struct inode *inode, struct file *file);
2165 static ssize_t sg_proc_write_adio(struct file *filp, const char __user *buffer,
2166 size_t count, loff_t *off);
2167 static struct file_operations adio_fops = {
2168 /* .owner, .read and .llseek added in sg_proc_init() */
2169 .open = sg_proc_single_open_adio,
2170 .write = sg_proc_write_adio,
2171 .release = single_release,
2174 static int sg_proc_single_open_dressz(struct inode *inode, struct file *file);
2175 static ssize_t sg_proc_write_dressz(struct file *filp,
2176 const char __user *buffer, size_t count, loff_t *off);
2177 static struct file_operations dressz_fops = {
2178 .open = sg_proc_single_open_dressz,
2179 .write = sg_proc_write_dressz,
2180 .release = single_release,
2183 static int sg_proc_seq_show_version(struct seq_file *s, void *v);
2184 static int sg_proc_single_open_version(struct inode *inode, struct file *file);
2185 static struct file_operations version_fops = {
2186 .open = sg_proc_single_open_version,
2187 .release = single_release,
2190 static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v);
2191 static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file);
2192 static struct file_operations devhdr_fops = {
2193 .open = sg_proc_single_open_devhdr,
2194 .release = single_release,
2197 static int sg_proc_seq_show_dev(struct seq_file *s, void *v);
2198 static int sg_proc_open_dev(struct inode *inode, struct file *file);
2199 static void * dev_seq_start(struct seq_file *s, loff_t *pos);
2200 static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos);
2201 static void dev_seq_stop(struct seq_file *s, void *v);
2202 static struct file_operations dev_fops = {
2203 .open = sg_proc_open_dev,
2204 .release = seq_release,
2206 static struct seq_operations dev_seq_ops = {
2207 .start = dev_seq_start,
2208 .next = dev_seq_next,
2209 .stop = dev_seq_stop,
2210 .show = sg_proc_seq_show_dev,
2213 static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v);
2214 static int sg_proc_open_devstrs(struct inode *inode, struct file *file);
2215 static struct file_operations devstrs_fops = {
2216 .open = sg_proc_open_devstrs,
2217 .release = seq_release,
2219 static struct seq_operations devstrs_seq_ops = {
2220 .start = dev_seq_start,
2221 .next = dev_seq_next,
2222 .stop = dev_seq_stop,
2223 .show = sg_proc_seq_show_devstrs,
2226 static int sg_proc_seq_show_debug(struct seq_file *s, void *v);
2227 static int sg_proc_open_debug(struct inode *inode, struct file *file);
2228 static struct file_operations debug_fops = {
2229 .open = sg_proc_open_debug,
2230 .release = seq_release,
2232 static struct seq_operations debug_seq_ops = {
2233 .start = dev_seq_start,
2234 .next = dev_seq_next,
2235 .stop = dev_seq_stop,
2236 .show = sg_proc_seq_show_debug,
2240 struct sg_proc_leaf {
2242 struct file_operations * fops;
2245 static struct sg_proc_leaf sg_proc_leaf_arr[] = {
2246 {"allow_dio", &adio_fops},
2247 {"debug", &debug_fops},
2248 {"def_reserved_size", &dressz_fops},
2249 {"device_hdr", &devhdr_fops},
2250 {"devices", &dev_fops},
2251 {"device_strs", &devstrs_fops},
2252 {"version", &version_fops}
2259 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
2260 struct sg_proc_leaf * leaf;
2262 sg_proc_sgp = proc_mkdir(sg_proc_sg_dirname, NULL);
2265 for (k = 0; k < num_leaves; ++k) {
2266 leaf = &sg_proc_leaf_arr[k];
2267 mask = leaf->fops->write ? S_IRUGO | S_IWUSR : S_IRUGO;
2268 leaf->fops->owner = THIS_MODULE;
2269 leaf->fops->read = seq_read;
2270 leaf->fops->llseek = seq_lseek;
2271 proc_create(leaf->name, mask, sg_proc_sgp, leaf->fops);
2277 sg_proc_cleanup(void)
2280 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
2284 for (k = 0; k < num_leaves; ++k)
2285 remove_proc_entry(sg_proc_leaf_arr[k].name, sg_proc_sgp);
2286 remove_proc_entry(sg_proc_sg_dirname, NULL);
2290 static int sg_proc_seq_show_int(struct seq_file *s, void *v)
2292 seq_printf(s, "%d\n", *((int *)s->private));
2296 static int sg_proc_single_open_adio(struct inode *inode, struct file *file)
2298 return single_open(file, sg_proc_seq_show_int, &sg_allow_dio);
2302 sg_proc_write_adio(struct file *filp, const char __user *buffer,
2303 size_t count, loff_t *off)
2308 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2310 num = (count < 10) ? count : 10;
2311 if (copy_from_user(buff, buffer, num))
2314 sg_allow_dio = simple_strtoul(buff, NULL, 10) ? 1 : 0;
2318 static int sg_proc_single_open_dressz(struct inode *inode, struct file *file)
2320 return single_open(file, sg_proc_seq_show_int, &sg_big_buff);
2324 sg_proc_write_dressz(struct file *filp, const char __user *buffer,
2325 size_t count, loff_t *off)
2328 unsigned long k = ULONG_MAX;
2331 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2333 num = (count < 10) ? count : 10;
2334 if (copy_from_user(buff, buffer, num))
2337 k = simple_strtoul(buff, NULL, 10);
2338 if (k <= 1048576) { /* limit "big buff" to 1 MB */
2345 static int sg_proc_seq_show_version(struct seq_file *s, void *v)
2347 seq_printf(s, "%d\t%s [%s]\n", sg_version_num, SG_VERSION_STR,
2352 static int sg_proc_single_open_version(struct inode *inode, struct file *file)
2354 return single_open(file, sg_proc_seq_show_version, NULL);
2357 static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v)
2359 seq_printf(s, "host\tchan\tid\tlun\ttype\topens\tqdepth\tbusy\t"
2364 static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file)
2366 return single_open(file, sg_proc_seq_show_devhdr, NULL);
2369 struct sg_proc_deviter {
2374 static void * dev_seq_start(struct seq_file *s, loff_t *pos)
2376 struct sg_proc_deviter * it = kmalloc(sizeof(*it), GFP_KERNEL);
2383 it->max = sg_last_dev();
2384 if (it->index >= it->max)
2389 static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos)
2391 struct sg_proc_deviter * it = s->private;
2394 return (it->index < it->max) ? it : NULL;
2397 static void dev_seq_stop(struct seq_file *s, void *v)
2402 static int sg_proc_open_dev(struct inode *inode, struct file *file)
2404 return seq_open(file, &dev_seq_ops);
2407 static int sg_proc_seq_show_dev(struct seq_file *s, void *v)
2409 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2411 struct scsi_device *scsidp;
2412 unsigned long iflags;
2414 read_lock_irqsave(&sg_index_lock, iflags);
2415 sdp = it ? sg_lookup_dev(it->index) : NULL;
2416 if (sdp && (scsidp = sdp->device) && (!sdp->detached))
2417 seq_printf(s, "%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\n",
2418 scsidp->host->host_no, scsidp->channel,
2419 scsidp->id, scsidp->lun, (int) scsidp->type,
2421 (int) scsidp->queue_depth,
2422 (int) scsidp->device_busy,
2423 (int) scsi_device_online(scsidp));
2425 seq_printf(s, "-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\n");
2426 read_unlock_irqrestore(&sg_index_lock, iflags);
2430 static int sg_proc_open_devstrs(struct inode *inode, struct file *file)
2432 return seq_open(file, &devstrs_seq_ops);
2435 static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v)
2437 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2439 struct scsi_device *scsidp;
2440 unsigned long iflags;
2442 read_lock_irqsave(&sg_index_lock, iflags);
2443 sdp = it ? sg_lookup_dev(it->index) : NULL;
2444 if (sdp && (scsidp = sdp->device) && (!sdp->detached))
2445 seq_printf(s, "%8.8s\t%16.16s\t%4.4s\n",
2446 scsidp->vendor, scsidp->model, scsidp->rev);
2448 seq_printf(s, "<no active device>\n");
2449 read_unlock_irqrestore(&sg_index_lock, iflags);
2453 /* must be called while holding sg_index_lock */
2454 static void sg_proc_debug_helper(struct seq_file *s, Sg_device * sdp)
2456 int k, m, new_interface, blen, usg;
2459 const sg_io_hdr_t *hp;
2464 list_for_each_entry(fp, &sdp->sfds, sfd_siblings) {
2466 read_lock(&fp->rq_list_lock); /* irqs already disabled */
2467 seq_printf(s, " FD(%d): timeout=%dms bufflen=%d "
2468 "(res)sgat=%d low_dma=%d\n", k,
2469 jiffies_to_msecs(fp->timeout),
2470 fp->reserve.bufflen,
2471 (int) fp->reserve.k_use_sg,
2473 seq_printf(s, " cmd_q=%d f_packid=%d k_orphan=%d closed=%d\n",
2474 (int) fp->cmd_q, (int) fp->force_packid,
2475 (int) fp->keep_orphan, (int) fp->closed);
2476 for (m = 0, srp = fp->headrp;
2478 ++m, srp = srp->nextrp) {
2480 new_interface = (hp->interface_id == '\0') ? 0 : 1;
2481 if (srp->res_used) {
2482 if (new_interface &&
2483 (SG_FLAG_MMAP_IO & hp->flags))
2488 if (SG_INFO_DIRECT_IO_MASK & hp->info)
2494 blen = srp->data.bufflen;
2495 usg = srp->data.k_use_sg;
2496 seq_printf(s, srp->done ?
2497 ((1 == srp->done) ? "rcv:" : "fin:")
2499 seq_printf(s, " id=%d blen=%d",
2500 srp->header.pack_id, blen);
2502 seq_printf(s, " dur=%d", hp->duration);
2504 ms = jiffies_to_msecs(jiffies);
2505 seq_printf(s, " t_o/elap=%d/%d",
2506 (new_interface ? hp->timeout :
2507 jiffies_to_msecs(fp->timeout)),
2508 (ms > hp->duration ? ms - hp->duration : 0));
2510 seq_printf(s, "ms sgat=%d op=0x%02x\n", usg,
2511 (int) srp->data.cmd_opcode);
2514 seq_printf(s, " No requests active\n");
2515 read_unlock(&fp->rq_list_lock);
2519 static int sg_proc_open_debug(struct inode *inode, struct file *file)
2521 return seq_open(file, &debug_seq_ops);
2524 static int sg_proc_seq_show_debug(struct seq_file *s, void *v)
2526 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2528 unsigned long iflags;
2530 if (it && (0 == it->index)) {
2531 seq_printf(s, "max_active_device=%d(origin 1)\n",
2533 seq_printf(s, " def_reserved_size=%d\n", sg_big_buff);
2536 read_lock_irqsave(&sg_index_lock, iflags);
2537 sdp = it ? sg_lookup_dev(it->index) : NULL;
2538 if (sdp && !list_empty(&sdp->sfds)) {
2539 struct scsi_device *scsidp = sdp->device;
2541 seq_printf(s, " >>> device=%s ", sdp->disk->disk_name);
2543 seq_printf(s, "detached pending close ");
2546 (s, "scsi%d chan=%d id=%d lun=%d em=%d",
2547 scsidp->host->host_no,
2548 scsidp->channel, scsidp->id,
2550 scsidp->host->hostt->emulated);
2551 seq_printf(s, " sg_tablesize=%d excl=%d\n",
2552 sdp->sg_tablesize, sdp->exclude);
2553 sg_proc_debug_helper(s, sdp);
2555 read_unlock_irqrestore(&sg_index_lock, iflags);
2559 #endif /* CONFIG_SCSI_PROC_FS */
2561 module_init(init_sg);
2562 module_exit(exit_sg);