3 * Started: Aug 9 by Lawrence Foard (entropy@world.std.com),
4 * to allow user process control of SCSI devices.
5 * Development Sponsored by Killy Corp. NY NY
7 * Original driver (sg.c):
8 * Copyright (C) 1992 Lawrence Foard
9 * Version 2 and 3 extensions to driver:
10 * Copyright (C) 1998 - 2005 Douglas Gilbert
12 * Modified 19-JAN-1998 Richard Gooch <rgooch@atnf.csiro.au> Devfs support
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2, or (at your option)
21 static int sg_version_num = 30534; /* 2 digits for each component */
22 #define SG_VERSION_STR "3.5.34"
25 * D. P. Gilbert (dgilbert@interlog.com, dougg@triode.net.au), notes:
26 * - scsi logging is available via SCSI_LOG_TIMEOUT macros. First
27 * the kernel/module needs to be built with CONFIG_SCSI_LOGGING
28 * (otherwise the macros compile to empty statements).
31 #include <linux/module.h>
34 #include <linux/kernel.h>
35 #include <linux/sched.h>
36 #include <linux/string.h>
38 #include <linux/errno.h>
39 #include <linux/mtio.h>
40 #include <linux/ioctl.h>
41 #include <linux/slab.h>
42 #include <linux/fcntl.h>
43 #include <linux/init.h>
44 #include <linux/poll.h>
45 #include <linux/moduleparam.h>
46 #include <linux/cdev.h>
47 #include <linux/idr.h>
48 #include <linux/seq_file.h>
49 #include <linux/blkdev.h>
50 #include <linux/delay.h>
51 #include <linux/blktrace_api.h>
52 #include <linux/mutex.h>
55 #include <scsi/scsi_dbg.h>
56 #include <scsi/scsi_host.h>
57 #include <scsi/scsi_driver.h>
58 #include <scsi/scsi_ioctl.h>
61 #include "scsi_logging.h"
63 #ifdef CONFIG_SCSI_PROC_FS
64 #include <linux/proc_fs.h>
65 static char *sg_version_date = "20061027";
67 static int sg_proc_init(void);
68 static void sg_proc_cleanup(void);
71 #define SG_ALLOW_DIO_DEF 0
73 #define SG_MAX_DEVS 32768
76 * Suppose you want to calculate the formula muldiv(x,m,d)=int(x * m / d)
77 * Then when using 32 bit integers x * m may overflow during the calculation.
78 * Replacing muldiv(x) by muldiv(x)=((x % d) * m) / d + int(x / d) * m
79 * calculates the same, but prevents the overflow when both m and d
80 * are "small" numbers (like HZ and USER_HZ).
81 * Of course an overflow is inavoidable if the result of muldiv doesn't fit
84 #define MULDIV(X,MUL,DIV) ((((X % DIV) * MUL) / DIV) + ((X / DIV) * MUL))
86 #define SG_DEFAULT_TIMEOUT MULDIV(SG_DEFAULT_TIMEOUT_USER, HZ, USER_HZ)
88 int sg_big_buff = SG_DEF_RESERVED_SIZE;
89 /* N.B. This variable is readable and writeable via
90 /proc/scsi/sg/def_reserved_size . Each time sg_open() is called a buffer
91 of this size (or less if there is not enough memory) will be reserved
92 for use by this file descriptor. [Deprecated usage: this variable is also
93 readable via /proc/sys/kernel/sg-big-buff if the sg driver is built into
94 the kernel (i.e. it is not a module).] */
95 static int def_reserved_size = -1; /* picks up init parameter */
96 static int sg_allow_dio = SG_ALLOW_DIO_DEF;
98 static int scatter_elem_sz = SG_SCATTER_SZ;
99 static int scatter_elem_sz_prev = SG_SCATTER_SZ;
101 #define SG_SECTOR_SZ 512
103 static int sg_add(struct device *, struct class_interface *);
104 static void sg_remove(struct device *, struct class_interface *);
106 static DEFINE_MUTEX(sg_mutex);
108 static DEFINE_IDR(sg_index_idr);
109 static DEFINE_RWLOCK(sg_index_lock); /* Also used to lock
110 file descriptor list for device */
112 static struct class_interface sg_interface = {
114 .remove_dev = sg_remove,
117 typedef struct sg_scatter_hold { /* holding area for scsi scatter gather info */
118 unsigned short k_use_sg; /* Count of kernel scatter-gather pieces */
119 unsigned sglist_len; /* size of malloc'd scatter-gather list ++ */
120 unsigned bufflen; /* Size of (aggregate) data buffer */
123 char dio_in_use; /* 0->indirect IO (or mmap), 1->dio */
124 unsigned char cmd_opcode; /* first byte of command */
127 struct sg_device; /* forward declarations */
130 typedef struct sg_request { /* SG_MAX_QUEUE requests outstanding per file */
131 struct sg_request *nextrp; /* NULL -> tail request (slist) */
132 struct sg_fd *parentfp; /* NULL -> not in use */
133 Sg_scatter_hold data; /* hold buffer, perhaps scatter list */
134 sg_io_hdr_t header; /* scsi command+info, see <scsi/sg.h> */
135 unsigned char sense_b[SCSI_SENSE_BUFFERSIZE];
136 char res_used; /* 1 -> using reserve buffer, 0 -> not ... */
137 char orphan; /* 1 -> drop on sight, 0 -> normal */
138 char sg_io_owned; /* 1 -> packet belongs to SG_IO */
139 volatile char done; /* 0->before bh, 1->before read, 2->read */
142 struct execute_work ew;
145 typedef struct sg_fd { /* holds the state of a file descriptor */
146 struct list_head sfd_siblings;
147 struct sg_device *parentdp; /* owning device */
148 wait_queue_head_t read_wait; /* queue read until command done */
149 rwlock_t rq_list_lock; /* protect access to list in req_arr */
150 int timeout; /* defaults to SG_DEFAULT_TIMEOUT */
151 int timeout_user; /* defaults to SG_DEFAULT_TIMEOUT_USER */
152 Sg_scatter_hold reserve; /* buffer held for this file descriptor */
153 unsigned save_scat_len; /* original length of trunc. scat. element */
154 Sg_request *headrp; /* head of request slist, NULL->empty */
155 struct fasync_struct *async_qp; /* used by asynchronous notification */
156 Sg_request req_arr[SG_MAX_QUEUE]; /* used as singly-linked list */
157 char low_dma; /* as in parent but possibly overridden to 1 */
158 char force_packid; /* 1 -> pack_id input to read(), 0 -> ignored */
159 volatile char closed; /* 1 -> fd closed but request(s) outstanding */
160 char cmd_q; /* 1 -> allow command queuing, 0 -> don't */
161 char next_cmd_len; /* 0 -> automatic (def), >0 -> use on next write() */
162 char keep_orphan; /* 0 -> drop orphan (def), 1 -> keep for read() */
163 char mmap_called; /* 0 -> mmap() never called on this fd */
165 struct execute_work ew;
168 typedef struct sg_device { /* holds the state of each scsi generic device */
169 struct scsi_device *device;
170 wait_queue_head_t o_excl_wait; /* queue open() when O_EXCL in use */
171 int sg_tablesize; /* adapter's max scatter-gather table size */
172 u32 index; /* device index number */
173 struct list_head sfds;
174 volatile char detached; /* 0->attached, 1->detached pending removal */
175 volatile char exclude; /* opened for exclusive access */
176 char sgdebug; /* 0->off, 1->sense, 9->dump dev, 10-> all devs */
177 struct gendisk *disk;
178 struct cdev * cdev; /* char_dev [sysfs: /sys/cdev/major/sg<n>] */
182 /* tasklet or soft irq callback */
183 static void sg_rq_end_io(struct request *rq, int uptodate);
184 static int sg_start_req(Sg_request *srp, unsigned char *cmd);
185 static int sg_finish_rem_req(Sg_request * srp);
186 static int sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size);
187 static ssize_t sg_new_read(Sg_fd * sfp, char __user *buf, size_t count,
189 static ssize_t sg_new_write(Sg_fd *sfp, struct file *file,
190 const char __user *buf, size_t count, int blocking,
191 int read_only, int sg_io_owned, Sg_request **o_srp);
192 static int sg_common_write(Sg_fd * sfp, Sg_request * srp,
193 unsigned char *cmnd, int timeout, int blocking);
194 static int sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer);
195 static void sg_remove_scat(Sg_scatter_hold * schp);
196 static void sg_build_reserve(Sg_fd * sfp, int req_size);
197 static void sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size);
198 static void sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp);
199 static Sg_fd *sg_add_sfp(Sg_device * sdp, int dev);
200 static void sg_remove_sfp(struct kref *);
201 static Sg_request *sg_get_rq_mark(Sg_fd * sfp, int pack_id);
202 static Sg_request *sg_add_request(Sg_fd * sfp);
203 static int sg_remove_request(Sg_fd * sfp, Sg_request * srp);
204 static int sg_res_in_use(Sg_fd * sfp);
205 static Sg_device *sg_get_dev(int dev);
206 static void sg_put_dev(Sg_device *sdp);
208 #define SZ_SG_HEADER sizeof(struct sg_header)
209 #define SZ_SG_IO_HDR sizeof(sg_io_hdr_t)
210 #define SZ_SG_IOVEC sizeof(sg_iovec_t)
211 #define SZ_SG_REQ_INFO sizeof(sg_req_info_t)
213 static int sg_allow_access(struct file *filp, unsigned char *cmd)
215 struct sg_fd *sfp = (struct sg_fd *)filp->private_data;
217 if (sfp->parentdp->device->type == TYPE_SCANNER)
220 return blk_verify_command(cmd, filp->f_mode & FMODE_WRITE);
224 sg_open(struct inode *inode, struct file *filp)
226 int dev = iminor(inode);
227 int flags = filp->f_flags;
228 struct request_queue *q;
234 mutex_lock(&sg_mutex);
235 nonseekable_open(inode, filp);
236 SCSI_LOG_TIMEOUT(3, printk("sg_open: dev=%d, flags=0x%x\n", dev, flags));
237 sdp = sg_get_dev(dev);
239 retval = PTR_ERR(sdp);
244 /* This driver's module count bumped by fops_get in <linux/fs.h> */
245 /* Prevent the device driver from vanishing while we sleep */
246 retval = scsi_device_get(sdp->device);
250 retval = scsi_autopm_get_device(sdp->device);
254 if (!((flags & O_NONBLOCK) ||
255 scsi_block_when_processing_errors(sdp->device))) {
257 /* we are in error recovery for this device */
261 if (flags & O_EXCL) {
262 if (O_RDONLY == (flags & O_ACCMODE)) {
263 retval = -EPERM; /* Can't lock it with read only access */
266 if (!list_empty(&sdp->sfds) && (flags & O_NONBLOCK)) {
271 __wait_event_interruptible(sdp->o_excl_wait,
272 ((!list_empty(&sdp->sfds) || sdp->exclude) ? 0 : (sdp->exclude = 1)), res);
274 retval = res; /* -ERESTARTSYS because signal hit process */
277 } else if (sdp->exclude) { /* some other fd has an exclusive lock on dev */
278 if (flags & O_NONBLOCK) {
283 __wait_event_interruptible(sdp->o_excl_wait, (!sdp->exclude),
286 retval = res; /* -ERESTARTSYS because signal hit process */
294 if (list_empty(&sdp->sfds)) { /* no existing opens on this device */
296 q = sdp->device->request_queue;
297 sdp->sg_tablesize = queue_max_segments(q);
299 if ((sfp = sg_add_sfp(sdp, dev)))
300 filp->private_data = sfp;
302 if (flags & O_EXCL) {
303 sdp->exclude = 0; /* undo if error */
304 wake_up_interruptible(&sdp->o_excl_wait);
312 scsi_autopm_put_device(sdp->device);
314 scsi_device_put(sdp->device);
319 mutex_unlock(&sg_mutex);
323 /* Following function was formerly called 'sg_close' */
325 sg_release(struct inode *inode, struct file *filp)
330 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
332 SCSI_LOG_TIMEOUT(3, printk("sg_release: %s\n", sdp->disk->disk_name));
337 wake_up_interruptible(&sdp->o_excl_wait);
339 scsi_autopm_put_device(sdp->device);
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 err = 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 "
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 */
743 blk_end_request_all(srp->rq, -EIO);
744 sg_finish_rem_req(srp);
748 switch (hp->dxfer_direction) {
749 case SG_DXFER_TO_FROM_DEV:
750 case SG_DXFER_FROM_DEV:
751 data_dir = DMA_FROM_DEVICE;
753 case SG_DXFER_TO_DEV:
754 data_dir = DMA_TO_DEVICE;
756 case SG_DXFER_UNKNOWN:
757 data_dir = DMA_BIDIRECTIONAL;
763 hp->duration = jiffies_to_msecs(jiffies);
765 srp->rq->timeout = timeout;
766 kref_get(&sfp->f_ref); /* sg_rq_end_io() does kref_put(). */
767 blk_execute_rq_nowait(sdp->device->request_queue, sdp->disk,
768 srp->rq, 1, sg_rq_end_io);
773 sg_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
775 void __user *p = (void __user *)arg;
777 int result, val, read_only;
781 unsigned long iflags;
783 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
786 SCSI_LOG_TIMEOUT(3, printk("sg_ioctl: %s, cmd=0x%x\n",
787 sdp->disk->disk_name, (int) cmd_in));
788 read_only = (O_RDWR != (filp->f_flags & O_ACCMODE));
793 int blocking = 1; /* ignore O_NONBLOCK flag */
797 if (!scsi_block_when_processing_errors(sdp->device))
799 if (!access_ok(VERIFY_WRITE, p, SZ_SG_IO_HDR))
802 sg_new_write(sfp, filp, p, SZ_SG_IO_HDR,
803 blocking, read_only, 1, &srp);
807 result = 0; /* following macro to beat race condition */
808 __wait_event_interruptible(sfp->read_wait,
809 (srp->done || sdp->detached),
813 write_lock_irq(&sfp->rq_list_lock);
816 write_unlock_irq(&sfp->rq_list_lock);
820 write_unlock_irq(&sfp->rq_list_lock);
821 return result; /* -ERESTARTSYS because signal hit process */
823 result = sg_new_read(sfp, p, SZ_SG_IO_HDR, srp);
824 return (result < 0) ? result : 0;
827 result = get_user(val, ip);
832 if (val >= MULDIV (INT_MAX, USER_HZ, HZ))
833 val = MULDIV (INT_MAX, USER_HZ, HZ);
834 sfp->timeout_user = val;
835 sfp->timeout = MULDIV (val, HZ, USER_HZ);
838 case SG_GET_TIMEOUT: /* N.B. User receives timeout as return value */
839 /* strange ..., for backward compatibility */
840 return sfp->timeout_user;
841 case SG_SET_FORCE_LOW_DMA:
842 result = get_user(val, ip);
847 if ((0 == sfp->low_dma) && (0 == sg_res_in_use(sfp))) {
848 val = (int) sfp->reserve.bufflen;
849 sg_remove_scat(&sfp->reserve);
850 sg_build_reserve(sfp, val);
855 sfp->low_dma = sdp->device->host->unchecked_isa_dma;
859 return put_user((int) sfp->low_dma, ip);
861 if (!access_ok(VERIFY_WRITE, p, sizeof (sg_scsi_id_t)))
864 sg_scsi_id_t __user *sg_idp = p;
868 __put_user((int) sdp->device->host->host_no,
870 __put_user((int) sdp->device->channel,
872 __put_user((int) sdp->device->id, &sg_idp->scsi_id);
873 __put_user((int) sdp->device->lun, &sg_idp->lun);
874 __put_user((int) sdp->device->type, &sg_idp->scsi_type);
875 __put_user((short) sdp->device->host->cmd_per_lun,
876 &sg_idp->h_cmd_per_lun);
877 __put_user((short) sdp->device->queue_depth,
878 &sg_idp->d_queue_depth);
879 __put_user(0, &sg_idp->unused[0]);
880 __put_user(0, &sg_idp->unused[1]);
883 case SG_SET_FORCE_PACK_ID:
884 result = get_user(val, ip);
887 sfp->force_packid = val ? 1 : 0;
890 if (!access_ok(VERIFY_WRITE, ip, sizeof (int)))
892 read_lock_irqsave(&sfp->rq_list_lock, iflags);
893 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
894 if ((1 == srp->done) && (!srp->sg_io_owned)) {
895 read_unlock_irqrestore(&sfp->rq_list_lock,
897 __put_user(srp->header.pack_id, ip);
901 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
904 case SG_GET_NUM_WAITING:
905 read_lock_irqsave(&sfp->rq_list_lock, iflags);
906 for (val = 0, srp = sfp->headrp; srp; srp = srp->nextrp) {
907 if ((1 == srp->done) && (!srp->sg_io_owned))
910 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
911 return put_user(val, ip);
912 case SG_GET_SG_TABLESIZE:
913 return put_user(sdp->sg_tablesize, ip);
914 case SG_SET_RESERVED_SIZE:
915 result = get_user(val, ip);
920 val = min_t(int, val,
921 queue_max_sectors(sdp->device->request_queue) * 512);
922 if (val != sfp->reserve.bufflen) {
923 if (sg_res_in_use(sfp) || sfp->mmap_called)
925 sg_remove_scat(&sfp->reserve);
926 sg_build_reserve(sfp, val);
929 case SG_GET_RESERVED_SIZE:
930 val = min_t(int, sfp->reserve.bufflen,
931 queue_max_sectors(sdp->device->request_queue) * 512);
932 return put_user(val, ip);
933 case SG_SET_COMMAND_Q:
934 result = get_user(val, ip);
937 sfp->cmd_q = val ? 1 : 0;
939 case SG_GET_COMMAND_Q:
940 return put_user((int) sfp->cmd_q, ip);
941 case SG_SET_KEEP_ORPHAN:
942 result = get_user(val, ip);
945 sfp->keep_orphan = val;
947 case SG_GET_KEEP_ORPHAN:
948 return put_user((int) sfp->keep_orphan, ip);
949 case SG_NEXT_CMD_LEN:
950 result = get_user(val, ip);
953 sfp->next_cmd_len = (val > 0) ? val : 0;
955 case SG_GET_VERSION_NUM:
956 return put_user(sg_version_num, ip);
957 case SG_GET_ACCESS_COUNT:
958 /* faked - we don't have a real access count anymore */
959 val = (sdp->device ? 1 : 0);
960 return put_user(val, ip);
961 case SG_GET_REQUEST_TABLE:
962 if (!access_ok(VERIFY_WRITE, p, SZ_SG_REQ_INFO * SG_MAX_QUEUE))
965 sg_req_info_t *rinfo;
968 rinfo = kmalloc(SZ_SG_REQ_INFO * SG_MAX_QUEUE,
972 read_lock_irqsave(&sfp->rq_list_lock, iflags);
973 for (srp = sfp->headrp, val = 0; val < SG_MAX_QUEUE;
974 ++val, srp = srp ? srp->nextrp : srp) {
975 memset(&rinfo[val], 0, SZ_SG_REQ_INFO);
977 rinfo[val].req_state = srp->done + 1;
979 srp->header.masked_status &
980 srp->header.host_status &
981 srp->header.driver_status;
983 rinfo[val].duration =
984 srp->header.duration;
986 ms = jiffies_to_msecs(jiffies);
987 rinfo[val].duration =
988 (ms > srp->header.duration) ?
989 (ms - srp->header.duration) : 0;
991 rinfo[val].orphan = srp->orphan;
992 rinfo[val].sg_io_owned =
1000 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1001 result = __copy_to_user(p, rinfo,
1002 SZ_SG_REQ_INFO * SG_MAX_QUEUE);
1003 result = result ? -EFAULT : 0;
1007 case SG_EMULATED_HOST:
1010 return put_user(sdp->device->host->hostt->emulated, ip);
1014 if (filp->f_flags & O_NONBLOCK) {
1015 if (scsi_host_in_recovery(sdp->device->host))
1017 } else if (!scsi_block_when_processing_errors(sdp->device))
1019 result = get_user(val, ip);
1022 if (SG_SCSI_RESET_NOTHING == val)
1025 case SG_SCSI_RESET_DEVICE:
1026 val = SCSI_TRY_RESET_DEVICE;
1028 case SG_SCSI_RESET_TARGET:
1029 val = SCSI_TRY_RESET_TARGET;
1031 case SG_SCSI_RESET_BUS:
1032 val = SCSI_TRY_RESET_BUS;
1034 case SG_SCSI_RESET_HOST:
1035 val = SCSI_TRY_RESET_HOST;
1040 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
1042 return (scsi_reset_provider(sdp->device, val) ==
1043 SUCCESS) ? 0 : -EIO;
1044 case SCSI_IOCTL_SEND_COMMAND:
1048 unsigned char opcode = WRITE_6;
1049 Scsi_Ioctl_Command __user *siocp = p;
1051 if (copy_from_user(&opcode, siocp->data, 1))
1053 if (sg_allow_access(filp, &opcode))
1056 return sg_scsi_ioctl(sdp->device->request_queue, NULL, filp->f_mode, p);
1058 result = get_user(val, ip);
1061 sdp->sgdebug = (char) val;
1063 case SCSI_IOCTL_GET_IDLUN:
1064 case SCSI_IOCTL_GET_BUS_NUMBER:
1065 case SCSI_IOCTL_PROBE_HOST:
1066 case SG_GET_TRANSFORM:
1069 return scsi_ioctl(sdp->device, cmd_in, p);
1071 return put_user(queue_max_sectors(sdp->device->request_queue) * 512,
1074 return blk_trace_setup(sdp->device->request_queue,
1075 sdp->disk->disk_name,
1076 MKDEV(SCSI_GENERIC_MAJOR, sdp->index),
1080 return blk_trace_startstop(sdp->device->request_queue, 1);
1082 return blk_trace_startstop(sdp->device->request_queue, 0);
1083 case BLKTRACETEARDOWN:
1084 return blk_trace_remove(sdp->device->request_queue);
1087 return -EPERM; /* don't know so take safe approach */
1088 return scsi_ioctl(sdp->device, cmd_in, p);
1093 sg_unlocked_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
1097 mutex_lock(&sg_mutex);
1098 ret = sg_ioctl(filp, cmd_in, arg);
1099 mutex_unlock(&sg_mutex);
1104 #ifdef CONFIG_COMPAT
1105 static long sg_compat_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
1109 struct scsi_device *sdev;
1111 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1115 if (sdev->host->hostt->compat_ioctl) {
1118 ret = sdev->host->hostt->compat_ioctl(sdev, cmd_in, (void __user *)arg);
1123 return -ENOIOCTLCMD;
1128 sg_poll(struct file *filp, poll_table * wait)
1130 unsigned int res = 0;
1135 unsigned long iflags;
1137 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp))
1140 poll_wait(filp, &sfp->read_wait, wait);
1141 read_lock_irqsave(&sfp->rq_list_lock, iflags);
1142 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
1143 /* if any read waiting, flag it */
1144 if ((0 == res) && (1 == srp->done) && (!srp->sg_io_owned))
1145 res = POLLIN | POLLRDNORM;
1148 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1152 else if (!sfp->cmd_q) {
1154 res |= POLLOUT | POLLWRNORM;
1155 } else if (count < SG_MAX_QUEUE)
1156 res |= POLLOUT | POLLWRNORM;
1157 SCSI_LOG_TIMEOUT(3, printk("sg_poll: %s, res=0x%x\n",
1158 sdp->disk->disk_name, (int) res));
1163 sg_fasync(int fd, struct file *filp, int mode)
1168 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1170 SCSI_LOG_TIMEOUT(3, printk("sg_fasync: %s, mode=%d\n",
1171 sdp->disk->disk_name, mode));
1173 return fasync_helper(fd, filp, mode, &sfp->async_qp);
1177 sg_vma_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
1180 unsigned long offset, len, sa;
1181 Sg_scatter_hold *rsv_schp;
1184 if ((NULL == vma) || (!(sfp = (Sg_fd *) vma->vm_private_data)))
1185 return VM_FAULT_SIGBUS;
1186 rsv_schp = &sfp->reserve;
1187 offset = vmf->pgoff << PAGE_SHIFT;
1188 if (offset >= rsv_schp->bufflen)
1189 return VM_FAULT_SIGBUS;
1190 SCSI_LOG_TIMEOUT(3, printk("sg_vma_fault: offset=%lu, scatg=%d\n",
1191 offset, rsv_schp->k_use_sg));
1193 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1194 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
1195 len = vma->vm_end - sa;
1196 len = (len < length) ? len : length;
1198 struct page *page = nth_page(rsv_schp->pages[k],
1199 offset >> PAGE_SHIFT);
1200 get_page(page); /* increment page count */
1202 return 0; /* success */
1208 return VM_FAULT_SIGBUS;
1211 static const struct vm_operations_struct sg_mmap_vm_ops = {
1212 .fault = sg_vma_fault,
1216 sg_mmap(struct file *filp, struct vm_area_struct *vma)
1219 unsigned long req_sz, len, sa;
1220 Sg_scatter_hold *rsv_schp;
1223 if ((!filp) || (!vma) || (!(sfp = (Sg_fd *) filp->private_data)))
1225 req_sz = vma->vm_end - vma->vm_start;
1226 SCSI_LOG_TIMEOUT(3, printk("sg_mmap starting, vm_start=%p, len=%d\n",
1227 (void *) vma->vm_start, (int) req_sz));
1229 return -EINVAL; /* want no offset */
1230 rsv_schp = &sfp->reserve;
1231 if (req_sz > rsv_schp->bufflen)
1232 return -ENOMEM; /* cannot map more than reserved buffer */
1235 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1236 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
1237 len = vma->vm_end - sa;
1238 len = (len < length) ? len : length;
1242 sfp->mmap_called = 1;
1243 vma->vm_flags |= VM_RESERVED;
1244 vma->vm_private_data = sfp;
1245 vma->vm_ops = &sg_mmap_vm_ops;
1249 static void sg_rq_end_io_usercontext(struct work_struct *work)
1251 struct sg_request *srp = container_of(work, struct sg_request, ew.work);
1252 struct sg_fd *sfp = srp->parentfp;
1254 sg_finish_rem_req(srp);
1255 kref_put(&sfp->f_ref, sg_remove_sfp);
1259 * This function is a "bottom half" handler that is called by the mid
1260 * level when a command is completed (or has failed).
1262 static void sg_rq_end_io(struct request *rq, int uptodate)
1264 struct sg_request *srp = rq->end_io_data;
1267 unsigned long iflags;
1270 int result, resid, done = 1;
1272 if (WARN_ON(srp->done != 0))
1275 sfp = srp->parentfp;
1276 if (WARN_ON(sfp == NULL))
1279 sdp = sfp->parentdp;
1280 if (unlikely(sdp->detached))
1281 printk(KERN_INFO "sg_rq_end_io: device detached\n");
1284 result = rq->errors;
1285 resid = rq->resid_len;
1287 SCSI_LOG_TIMEOUT(4, printk("sg_cmd_done: %s, pack_id=%d, res=0x%x\n",
1288 sdp->disk->disk_name, srp->header.pack_id, result));
1289 srp->header.resid = resid;
1290 ms = jiffies_to_msecs(jiffies);
1291 srp->header.duration = (ms > srp->header.duration) ?
1292 (ms - srp->header.duration) : 0;
1294 struct scsi_sense_hdr sshdr;
1296 srp->header.status = 0xff & result;
1297 srp->header.masked_status = status_byte(result);
1298 srp->header.msg_status = msg_byte(result);
1299 srp->header.host_status = host_byte(result);
1300 srp->header.driver_status = driver_byte(result);
1301 if ((sdp->sgdebug > 0) &&
1302 ((CHECK_CONDITION == srp->header.masked_status) ||
1303 (COMMAND_TERMINATED == srp->header.masked_status)))
1304 __scsi_print_sense("sg_cmd_done", sense,
1305 SCSI_SENSE_BUFFERSIZE);
1307 /* Following if statement is a patch supplied by Eric Youngdale */
1308 if (driver_byte(result) != 0
1309 && scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, &sshdr)
1310 && !scsi_sense_is_deferred(&sshdr)
1311 && sshdr.sense_key == UNIT_ATTENTION
1312 && sdp->device->removable) {
1313 /* Detected possible disc change. Set the bit - this */
1314 /* may be used if there are filesystems using this device */
1315 sdp->device->changed = 1;
1318 /* Rely on write phase to clean out srp status values, so no "else" */
1320 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1321 if (unlikely(srp->orphan)) {
1322 if (sfp->keep_orphan)
1323 srp->sg_io_owned = 0;
1328 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1331 /* Now wake up any sg_read() that is waiting for this
1334 wake_up_interruptible(&sfp->read_wait);
1335 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_IN);
1336 kref_put(&sfp->f_ref, sg_remove_sfp);
1338 INIT_WORK(&srp->ew.work, sg_rq_end_io_usercontext);
1339 schedule_work(&srp->ew.work);
1343 static const struct file_operations sg_fops = {
1344 .owner = THIS_MODULE,
1348 .unlocked_ioctl = sg_unlocked_ioctl,
1349 #ifdef CONFIG_COMPAT
1350 .compat_ioctl = sg_compat_ioctl,
1354 .release = sg_release,
1355 .fasync = sg_fasync,
1358 static struct class *sg_sysfs_class;
1360 static int sg_sysfs_valid = 0;
1362 static Sg_device *sg_alloc(struct gendisk *disk, struct scsi_device *scsidp)
1364 struct request_queue *q = scsidp->request_queue;
1366 unsigned long iflags;
1370 sdp = kzalloc(sizeof(Sg_device), GFP_KERNEL);
1372 printk(KERN_WARNING "kmalloc Sg_device failure\n");
1373 return ERR_PTR(-ENOMEM);
1376 if (!idr_pre_get(&sg_index_idr, GFP_KERNEL)) {
1377 printk(KERN_WARNING "idr expansion Sg_device failure\n");
1382 write_lock_irqsave(&sg_index_lock, iflags);
1384 error = idr_get_new(&sg_index_idr, sdp, &k);
1386 write_unlock_irqrestore(&sg_index_lock, iflags);
1387 printk(KERN_WARNING "idr allocation Sg_device failure: %d\n",
1392 if (unlikely(k >= SG_MAX_DEVS))
1395 SCSI_LOG_TIMEOUT(3, printk("sg_alloc: dev=%d \n", k));
1396 sprintf(disk->disk_name, "sg%d", k);
1397 disk->first_minor = k;
1399 sdp->device = scsidp;
1400 INIT_LIST_HEAD(&sdp->sfds);
1401 init_waitqueue_head(&sdp->o_excl_wait);
1402 sdp->sg_tablesize = queue_max_segments(q);
1404 kref_init(&sdp->d_ref);
1406 write_unlock_irqrestore(&sg_index_lock, iflags);
1412 return ERR_PTR(error);
1417 idr_remove(&sg_index_idr, k);
1418 write_unlock_irqrestore(&sg_index_lock, iflags);
1419 sdev_printk(KERN_WARNING, scsidp,
1420 "Unable to attach sg device type=%d, minor "
1421 "number exceeds %d\n", scsidp->type, SG_MAX_DEVS - 1);
1427 sg_add(struct device *cl_dev, struct class_interface *cl_intf)
1429 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
1430 struct gendisk *disk;
1431 Sg_device *sdp = NULL;
1432 struct cdev * cdev = NULL;
1434 unsigned long iflags;
1436 disk = alloc_disk(1);
1438 printk(KERN_WARNING "alloc_disk failed\n");
1441 disk->major = SCSI_GENERIC_MAJOR;
1444 cdev = cdev_alloc();
1446 printk(KERN_WARNING "cdev_alloc failed\n");
1449 cdev->owner = THIS_MODULE;
1450 cdev->ops = &sg_fops;
1452 sdp = sg_alloc(disk, scsidp);
1454 printk(KERN_WARNING "sg_alloc failed\n");
1455 error = PTR_ERR(sdp);
1459 error = cdev_add(cdev, MKDEV(SCSI_GENERIC_MAJOR, sdp->index), 1);
1464 if (sg_sysfs_valid) {
1465 struct device *sg_class_member;
1467 sg_class_member = device_create(sg_sysfs_class, cl_dev->parent,
1468 MKDEV(SCSI_GENERIC_MAJOR,
1470 sdp, "%s", disk->disk_name);
1471 if (IS_ERR(sg_class_member)) {
1472 printk(KERN_ERR "sg_add: "
1473 "device_create failed\n");
1474 error = PTR_ERR(sg_class_member);
1477 error = sysfs_create_link(&scsidp->sdev_gendev.kobj,
1478 &sg_class_member->kobj, "generic");
1480 printk(KERN_ERR "sg_add: unable to make symlink "
1481 "'generic' back to sg%d\n", sdp->index);
1483 printk(KERN_WARNING "sg_add: sg_sys Invalid\n");
1485 sdev_printk(KERN_NOTICE, scsidp,
1486 "Attached scsi generic sg%d type %d\n", sdp->index,
1489 dev_set_drvdata(cl_dev, sdp);
1494 write_lock_irqsave(&sg_index_lock, iflags);
1495 idr_remove(&sg_index_idr, sdp->index);
1496 write_unlock_irqrestore(&sg_index_lock, iflags);
1506 static void sg_device_destroy(struct kref *kref)
1508 struct sg_device *sdp = container_of(kref, struct sg_device, d_ref);
1509 unsigned long flags;
1511 /* CAUTION! Note that the device can still be found via idr_find()
1512 * even though the refcount is 0. Therefore, do idr_remove() BEFORE
1513 * any other cleanup.
1516 write_lock_irqsave(&sg_index_lock, flags);
1517 idr_remove(&sg_index_idr, sdp->index);
1518 write_unlock_irqrestore(&sg_index_lock, flags);
1521 printk("sg_device_destroy: %s\n",
1522 sdp->disk->disk_name));
1524 put_disk(sdp->disk);
1528 static void sg_remove(struct device *cl_dev, struct class_interface *cl_intf)
1530 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
1531 Sg_device *sdp = dev_get_drvdata(cl_dev);
1532 unsigned long iflags;
1535 if (!sdp || sdp->detached)
1538 SCSI_LOG_TIMEOUT(3, printk("sg_remove: %s\n", sdp->disk->disk_name));
1540 /* Need a write lock to set sdp->detached. */
1541 write_lock_irqsave(&sg_index_lock, iflags);
1543 list_for_each_entry(sfp, &sdp->sfds, sfd_siblings) {
1544 wake_up_interruptible(&sfp->read_wait);
1545 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_HUP);
1547 write_unlock_irqrestore(&sg_index_lock, iflags);
1549 sysfs_remove_link(&scsidp->sdev_gendev.kobj, "generic");
1550 device_destroy(sg_sysfs_class, MKDEV(SCSI_GENERIC_MAJOR, sdp->index));
1551 cdev_del(sdp->cdev);
1557 module_param_named(scatter_elem_sz, scatter_elem_sz, int, S_IRUGO | S_IWUSR);
1558 module_param_named(def_reserved_size, def_reserved_size, int,
1560 module_param_named(allow_dio, sg_allow_dio, int, S_IRUGO | S_IWUSR);
1562 MODULE_AUTHOR("Douglas Gilbert");
1563 MODULE_DESCRIPTION("SCSI generic (sg) driver");
1564 MODULE_LICENSE("GPL");
1565 MODULE_VERSION(SG_VERSION_STR);
1566 MODULE_ALIAS_CHARDEV_MAJOR(SCSI_GENERIC_MAJOR);
1568 MODULE_PARM_DESC(scatter_elem_sz, "scatter gather element "
1569 "size (default: max(SG_SCATTER_SZ, PAGE_SIZE))");
1570 MODULE_PARM_DESC(def_reserved_size, "size of buffer reserved for each fd");
1571 MODULE_PARM_DESC(allow_dio, "allow direct I/O (default: 0 (disallow))");
1578 if (scatter_elem_sz < PAGE_SIZE) {
1579 scatter_elem_sz = PAGE_SIZE;
1580 scatter_elem_sz_prev = scatter_elem_sz;
1582 if (def_reserved_size >= 0)
1583 sg_big_buff = def_reserved_size;
1585 def_reserved_size = sg_big_buff;
1587 rc = register_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1591 sg_sysfs_class = class_create(THIS_MODULE, "scsi_generic");
1592 if ( IS_ERR(sg_sysfs_class) ) {
1593 rc = PTR_ERR(sg_sysfs_class);
1597 rc = scsi_register_interface(&sg_interface);
1599 #ifdef CONFIG_SCSI_PROC_FS
1601 #endif /* CONFIG_SCSI_PROC_FS */
1604 class_destroy(sg_sysfs_class);
1606 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0), SG_MAX_DEVS);
1613 #ifdef CONFIG_SCSI_PROC_FS
1615 #endif /* CONFIG_SCSI_PROC_FS */
1616 scsi_unregister_interface(&sg_interface);
1617 class_destroy(sg_sysfs_class);
1619 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1621 idr_destroy(&sg_index_idr);
1624 static int sg_start_req(Sg_request *srp, unsigned char *cmd)
1628 Sg_fd *sfp = srp->parentfp;
1629 sg_io_hdr_t *hp = &srp->header;
1630 int dxfer_len = (int) hp->dxfer_len;
1631 int dxfer_dir = hp->dxfer_direction;
1632 unsigned int iov_count = hp->iovec_count;
1633 Sg_scatter_hold *req_schp = &srp->data;
1634 Sg_scatter_hold *rsv_schp = &sfp->reserve;
1635 struct request_queue *q = sfp->parentdp->device->request_queue;
1636 struct rq_map_data *md, map_data;
1637 int rw = hp->dxfer_direction == SG_DXFER_TO_DEV ? WRITE : READ;
1639 SCSI_LOG_TIMEOUT(4, printk(KERN_INFO "sg_start_req: dxfer_len=%d\n",
1642 rq = blk_get_request(q, rw, GFP_ATOMIC);
1646 memcpy(rq->cmd, cmd, hp->cmd_len);
1648 rq->cmd_len = hp->cmd_len;
1649 rq->cmd_type = REQ_TYPE_BLOCK_PC;
1652 rq->end_io_data = srp;
1653 rq->sense = srp->sense_b;
1654 rq->retries = SG_DEFAULT_RETRIES;
1656 if ((dxfer_len <= 0) || (dxfer_dir == SG_DXFER_NONE))
1659 if (sg_allow_dio && hp->flags & SG_FLAG_DIRECT_IO &&
1660 dxfer_dir != SG_DXFER_UNKNOWN && !iov_count &&
1661 !sfp->parentdp->device->host->unchecked_isa_dma &&
1662 blk_rq_aligned(q, hp->dxferp, dxfer_len))
1668 if (!sg_res_in_use(sfp) && dxfer_len <= rsv_schp->bufflen)
1669 sg_link_reserve(sfp, srp, dxfer_len);
1671 res = sg_build_indirect(req_schp, sfp, dxfer_len);
1676 md->pages = req_schp->pages;
1677 md->page_order = req_schp->page_order;
1678 md->nr_entries = req_schp->k_use_sg;
1680 md->null_mapped = hp->dxferp ? 0 : 1;
1681 if (dxfer_dir == SG_DXFER_TO_FROM_DEV)
1688 int len, size = sizeof(struct sg_iovec) * iov_count;
1691 iov = memdup_user(hp->dxferp, size);
1693 return PTR_ERR(iov);
1695 len = iov_length(iov, iov_count);
1696 if (hp->dxfer_len < len) {
1697 iov_count = iov_shorten(iov, iov_count, hp->dxfer_len);
1698 len = hp->dxfer_len;
1701 res = blk_rq_map_user_iov(q, rq, md, (struct sg_iovec *)iov,
1706 res = blk_rq_map_user(q, rq, md, hp->dxferp,
1707 hp->dxfer_len, GFP_ATOMIC);
1713 req_schp->dio_in_use = 1;
1714 hp->info |= SG_INFO_DIRECT_IO;
1720 static int sg_finish_rem_req(Sg_request * srp)
1724 Sg_fd *sfp = srp->parentfp;
1725 Sg_scatter_hold *req_schp = &srp->data;
1727 SCSI_LOG_TIMEOUT(4, printk("sg_finish_rem_req: res_used=%d\n", (int) srp->res_used));
1730 ret = blk_rq_unmap_user(srp->bio);
1732 blk_put_request(srp->rq);
1736 sg_unlink_reserve(sfp, srp);
1738 sg_remove_scat(req_schp);
1740 sg_remove_request(sfp, srp);
1746 sg_build_sgat(Sg_scatter_hold * schp, const Sg_fd * sfp, int tablesize)
1748 int sg_bufflen = tablesize * sizeof(struct page *);
1749 gfp_t gfp_flags = GFP_ATOMIC | __GFP_NOWARN;
1751 schp->pages = kzalloc(sg_bufflen, gfp_flags);
1754 schp->sglist_len = sg_bufflen;
1755 return tablesize; /* number of scat_gath elements allocated */
1759 sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size)
1761 int ret_sz = 0, i, k, rem_sz, num, mx_sc_elems;
1762 int sg_tablesize = sfp->parentdp->sg_tablesize;
1763 int blk_size = buff_size, order;
1764 gfp_t gfp_mask = GFP_ATOMIC | __GFP_COMP | __GFP_NOWARN;
1769 ++blk_size; /* don't know why */
1770 /* round request up to next highest SG_SECTOR_SZ byte boundary */
1771 blk_size = ALIGN(blk_size, SG_SECTOR_SZ);
1772 SCSI_LOG_TIMEOUT(4, printk("sg_build_indirect: buff_size=%d, blk_size=%d\n",
1773 buff_size, blk_size));
1775 /* N.B. ret_sz carried into this block ... */
1776 mx_sc_elems = sg_build_sgat(schp, sfp, sg_tablesize);
1777 if (mx_sc_elems < 0)
1778 return mx_sc_elems; /* most likely -ENOMEM */
1780 num = scatter_elem_sz;
1781 if (unlikely(num != scatter_elem_sz_prev)) {
1782 if (num < PAGE_SIZE) {
1783 scatter_elem_sz = PAGE_SIZE;
1784 scatter_elem_sz_prev = PAGE_SIZE;
1786 scatter_elem_sz_prev = num;
1790 gfp_mask |= GFP_DMA;
1792 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
1793 gfp_mask |= __GFP_ZERO;
1795 order = get_order(num);
1797 ret_sz = 1 << (PAGE_SHIFT + order);
1799 for (k = 0, rem_sz = blk_size; rem_sz > 0 && k < mx_sc_elems;
1800 k++, rem_sz -= ret_sz) {
1802 num = (rem_sz > scatter_elem_sz_prev) ?
1803 scatter_elem_sz_prev : rem_sz;
1805 schp->pages[k] = alloc_pages(gfp_mask, order);
1806 if (!schp->pages[k])
1809 if (num == scatter_elem_sz_prev) {
1810 if (unlikely(ret_sz > scatter_elem_sz_prev)) {
1811 scatter_elem_sz = ret_sz;
1812 scatter_elem_sz_prev = ret_sz;
1816 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k=%d, num=%d, "
1817 "ret_sz=%d\n", k, num, ret_sz));
1818 } /* end of for loop */
1820 schp->page_order = order;
1822 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k_use_sg=%d, "
1823 "rem_sz=%d\n", k, rem_sz));
1825 schp->bufflen = blk_size;
1826 if (rem_sz > 0) /* must have failed */
1830 for (i = 0; i < k; i++)
1831 __free_pages(schp->pages[i], order);
1840 sg_remove_scat(Sg_scatter_hold * schp)
1842 SCSI_LOG_TIMEOUT(4, printk("sg_remove_scat: k_use_sg=%d\n", schp->k_use_sg));
1843 if (schp->pages && schp->sglist_len > 0) {
1844 if (!schp->dio_in_use) {
1847 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
1848 SCSI_LOG_TIMEOUT(5, printk(
1849 "sg_remove_scat: k=%d, pg=0x%p\n",
1850 k, schp->pages[k]));
1851 __free_pages(schp->pages[k], schp->page_order);
1857 memset(schp, 0, sizeof (*schp));
1861 sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer)
1863 Sg_scatter_hold *schp = &srp->data;
1866 SCSI_LOG_TIMEOUT(4, printk("sg_read_oxfer: num_read_xfer=%d\n",
1868 if ((!outp) || (num_read_xfer <= 0))
1871 num = 1 << (PAGE_SHIFT + schp->page_order);
1872 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
1873 if (num > num_read_xfer) {
1874 if (__copy_to_user(outp, page_address(schp->pages[k]),
1879 if (__copy_to_user(outp, page_address(schp->pages[k]),
1882 num_read_xfer -= num;
1883 if (num_read_xfer <= 0)
1893 sg_build_reserve(Sg_fd * sfp, int req_size)
1895 Sg_scatter_hold *schp = &sfp->reserve;
1897 SCSI_LOG_TIMEOUT(4, printk("sg_build_reserve: req_size=%d\n", req_size));
1899 if (req_size < PAGE_SIZE)
1900 req_size = PAGE_SIZE;
1901 if (0 == sg_build_indirect(schp, sfp, req_size))
1904 sg_remove_scat(schp);
1905 req_size >>= 1; /* divide by 2 */
1906 } while (req_size > (PAGE_SIZE / 2));
1910 sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size)
1912 Sg_scatter_hold *req_schp = &srp->data;
1913 Sg_scatter_hold *rsv_schp = &sfp->reserve;
1917 SCSI_LOG_TIMEOUT(4, printk("sg_link_reserve: size=%d\n", size));
1920 num = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1921 for (k = 0; k < rsv_schp->k_use_sg; k++) {
1923 req_schp->k_use_sg = k + 1;
1924 req_schp->sglist_len = rsv_schp->sglist_len;
1925 req_schp->pages = rsv_schp->pages;
1927 req_schp->bufflen = size;
1928 req_schp->page_order = rsv_schp->page_order;
1934 if (k >= rsv_schp->k_use_sg)
1935 SCSI_LOG_TIMEOUT(1, printk("sg_link_reserve: BAD size\n"));
1939 sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp)
1941 Sg_scatter_hold *req_schp = &srp->data;
1943 SCSI_LOG_TIMEOUT(4, printk("sg_unlink_reserve: req->k_use_sg=%d\n",
1944 (int) req_schp->k_use_sg));
1945 req_schp->k_use_sg = 0;
1946 req_schp->bufflen = 0;
1947 req_schp->pages = NULL;
1948 req_schp->page_order = 0;
1949 req_schp->sglist_len = 0;
1950 sfp->save_scat_len = 0;
1955 sg_get_rq_mark(Sg_fd * sfp, int pack_id)
1958 unsigned long iflags;
1960 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1961 for (resp = sfp->headrp; resp; resp = resp->nextrp) {
1962 /* look for requests that are ready + not SG_IO owned */
1963 if ((1 == resp->done) && (!resp->sg_io_owned) &&
1964 ((-1 == pack_id) || (resp->header.pack_id == pack_id))) {
1965 resp->done = 2; /* guard against other readers */
1969 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1973 /* always adds to end of list */
1975 sg_add_request(Sg_fd * sfp)
1978 unsigned long iflags;
1980 Sg_request *rp = sfp->req_arr;
1982 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1985 memset(rp, 0, sizeof (Sg_request));
1990 if (0 == sfp->cmd_q)
1991 resp = NULL; /* command queuing disallowed */
1993 for (k = 0; k < SG_MAX_QUEUE; ++k, ++rp) {
1997 if (k < SG_MAX_QUEUE) {
1998 memset(rp, 0, sizeof (Sg_request));
2000 while (resp->nextrp)
2001 resp = resp->nextrp;
2009 resp->nextrp = NULL;
2010 resp->header.duration = jiffies_to_msecs(jiffies);
2012 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2016 /* Return of 1 for found; 0 for not found */
2018 sg_remove_request(Sg_fd * sfp, Sg_request * srp)
2020 Sg_request *prev_rp;
2022 unsigned long iflags;
2025 if ((!sfp) || (!srp) || (!sfp->headrp))
2027 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2028 prev_rp = sfp->headrp;
2029 if (srp == prev_rp) {
2030 sfp->headrp = prev_rp->nextrp;
2031 prev_rp->parentfp = NULL;
2034 while ((rp = prev_rp->nextrp)) {
2036 prev_rp->nextrp = rp->nextrp;
2037 rp->parentfp = NULL;
2044 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2049 sg_add_sfp(Sg_device * sdp, int dev)
2052 unsigned long iflags;
2055 sfp = kzalloc(sizeof(*sfp), GFP_ATOMIC | __GFP_NOWARN);
2059 init_waitqueue_head(&sfp->read_wait);
2060 rwlock_init(&sfp->rq_list_lock);
2062 kref_init(&sfp->f_ref);
2063 sfp->timeout = SG_DEFAULT_TIMEOUT;
2064 sfp->timeout_user = SG_DEFAULT_TIMEOUT_USER;
2065 sfp->force_packid = SG_DEF_FORCE_PACK_ID;
2066 sfp->low_dma = (SG_DEF_FORCE_LOW_DMA == 0) ?
2067 sdp->device->host->unchecked_isa_dma : 1;
2068 sfp->cmd_q = SG_DEF_COMMAND_Q;
2069 sfp->keep_orphan = SG_DEF_KEEP_ORPHAN;
2070 sfp->parentdp = sdp;
2071 write_lock_irqsave(&sg_index_lock, iflags);
2072 list_add_tail(&sfp->sfd_siblings, &sdp->sfds);
2073 write_unlock_irqrestore(&sg_index_lock, iflags);
2074 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: sfp=0x%p\n", sfp));
2075 if (unlikely(sg_big_buff != def_reserved_size))
2076 sg_big_buff = def_reserved_size;
2078 bufflen = min_t(int, sg_big_buff,
2079 queue_max_sectors(sdp->device->request_queue) * 512);
2080 sg_build_reserve(sfp, bufflen);
2081 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: bufflen=%d, k_use_sg=%d\n",
2082 sfp->reserve.bufflen, sfp->reserve.k_use_sg));
2084 kref_get(&sdp->d_ref);
2085 __module_get(THIS_MODULE);
2089 static void sg_remove_sfp_usercontext(struct work_struct *work)
2091 struct sg_fd *sfp = container_of(work, struct sg_fd, ew.work);
2092 struct sg_device *sdp = sfp->parentdp;
2094 /* Cleanup any responses which were never read(). */
2096 sg_finish_rem_req(sfp->headrp);
2098 if (sfp->reserve.bufflen > 0) {
2100 printk("sg_remove_sfp: bufflen=%d, k_use_sg=%d\n",
2101 (int) sfp->reserve.bufflen,
2102 (int) sfp->reserve.k_use_sg));
2103 sg_remove_scat(&sfp->reserve);
2107 printk("sg_remove_sfp: %s, sfp=0x%p\n",
2108 sdp->disk->disk_name,
2112 scsi_device_put(sdp->device);
2114 module_put(THIS_MODULE);
2117 static void sg_remove_sfp(struct kref *kref)
2119 struct sg_fd *sfp = container_of(kref, struct sg_fd, f_ref);
2120 struct sg_device *sdp = sfp->parentdp;
2121 unsigned long iflags;
2123 write_lock_irqsave(&sg_index_lock, iflags);
2124 list_del(&sfp->sfd_siblings);
2125 write_unlock_irqrestore(&sg_index_lock, iflags);
2126 wake_up_interruptible(&sdp->o_excl_wait);
2128 INIT_WORK(&sfp->ew.work, sg_remove_sfp_usercontext);
2129 schedule_work(&sfp->ew.work);
2133 sg_res_in_use(Sg_fd * sfp)
2135 const Sg_request *srp;
2136 unsigned long iflags;
2138 read_lock_irqsave(&sfp->rq_list_lock, iflags);
2139 for (srp = sfp->headrp; srp; srp = srp->nextrp)
2142 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2146 #ifdef CONFIG_SCSI_PROC_FS
2148 sg_idr_max_id(int id, void *p, void *data)
2162 unsigned long iflags;
2164 read_lock_irqsave(&sg_index_lock, iflags);
2165 idr_for_each(&sg_index_idr, sg_idr_max_id, &k);
2166 read_unlock_irqrestore(&sg_index_lock, iflags);
2167 return k + 1; /* origin 1 */
2171 /* must be called with sg_index_lock held */
2172 static Sg_device *sg_lookup_dev(int dev)
2174 return idr_find(&sg_index_idr, dev);
2177 static Sg_device *sg_get_dev(int dev)
2179 struct sg_device *sdp;
2180 unsigned long flags;
2182 read_lock_irqsave(&sg_index_lock, flags);
2183 sdp = sg_lookup_dev(dev);
2185 sdp = ERR_PTR(-ENXIO);
2186 else if (sdp->detached) {
2187 /* If sdp->detached, then the refcount may already be 0, in
2188 * which case it would be a bug to do kref_get().
2190 sdp = ERR_PTR(-ENODEV);
2192 kref_get(&sdp->d_ref);
2193 read_unlock_irqrestore(&sg_index_lock, flags);
2198 static void sg_put_dev(struct sg_device *sdp)
2200 kref_put(&sdp->d_ref, sg_device_destroy);
2203 #ifdef CONFIG_SCSI_PROC_FS
2205 static struct proc_dir_entry *sg_proc_sgp = NULL;
2207 static char sg_proc_sg_dirname[] = "scsi/sg";
2209 static int sg_proc_seq_show_int(struct seq_file *s, void *v);
2211 static int sg_proc_single_open_adio(struct inode *inode, struct file *file);
2212 static ssize_t sg_proc_write_adio(struct file *filp, const char __user *buffer,
2213 size_t count, loff_t *off);
2214 static const struct file_operations adio_fops = {
2215 .owner = THIS_MODULE,
2216 .open = sg_proc_single_open_adio,
2218 .llseek = seq_lseek,
2219 .write = sg_proc_write_adio,
2220 .release = single_release,
2223 static int sg_proc_single_open_dressz(struct inode *inode, struct file *file);
2224 static ssize_t sg_proc_write_dressz(struct file *filp,
2225 const char __user *buffer, size_t count, loff_t *off);
2226 static const struct file_operations dressz_fops = {
2227 .owner = THIS_MODULE,
2228 .open = sg_proc_single_open_dressz,
2230 .llseek = seq_lseek,
2231 .write = sg_proc_write_dressz,
2232 .release = single_release,
2235 static int sg_proc_seq_show_version(struct seq_file *s, void *v);
2236 static int sg_proc_single_open_version(struct inode *inode, struct file *file);
2237 static const struct file_operations version_fops = {
2238 .owner = THIS_MODULE,
2239 .open = sg_proc_single_open_version,
2241 .llseek = seq_lseek,
2242 .release = single_release,
2245 static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v);
2246 static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file);
2247 static const struct file_operations devhdr_fops = {
2248 .owner = THIS_MODULE,
2249 .open = sg_proc_single_open_devhdr,
2251 .llseek = seq_lseek,
2252 .release = single_release,
2255 static int sg_proc_seq_show_dev(struct seq_file *s, void *v);
2256 static int sg_proc_open_dev(struct inode *inode, struct file *file);
2257 static void * dev_seq_start(struct seq_file *s, loff_t *pos);
2258 static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos);
2259 static void dev_seq_stop(struct seq_file *s, void *v);
2260 static const struct file_operations dev_fops = {
2261 .owner = THIS_MODULE,
2262 .open = sg_proc_open_dev,
2264 .llseek = seq_lseek,
2265 .release = seq_release,
2267 static const struct seq_operations dev_seq_ops = {
2268 .start = dev_seq_start,
2269 .next = dev_seq_next,
2270 .stop = dev_seq_stop,
2271 .show = sg_proc_seq_show_dev,
2274 static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v);
2275 static int sg_proc_open_devstrs(struct inode *inode, struct file *file);
2276 static const struct file_operations devstrs_fops = {
2277 .owner = THIS_MODULE,
2278 .open = sg_proc_open_devstrs,
2280 .llseek = seq_lseek,
2281 .release = seq_release,
2283 static const struct seq_operations devstrs_seq_ops = {
2284 .start = dev_seq_start,
2285 .next = dev_seq_next,
2286 .stop = dev_seq_stop,
2287 .show = sg_proc_seq_show_devstrs,
2290 static int sg_proc_seq_show_debug(struct seq_file *s, void *v);
2291 static int sg_proc_open_debug(struct inode *inode, struct file *file);
2292 static const struct file_operations debug_fops = {
2293 .owner = THIS_MODULE,
2294 .open = sg_proc_open_debug,
2296 .llseek = seq_lseek,
2297 .release = seq_release,
2299 static const struct seq_operations debug_seq_ops = {
2300 .start = dev_seq_start,
2301 .next = dev_seq_next,
2302 .stop = dev_seq_stop,
2303 .show = sg_proc_seq_show_debug,
2307 struct sg_proc_leaf {
2309 const struct file_operations * fops;
2312 static struct sg_proc_leaf sg_proc_leaf_arr[] = {
2313 {"allow_dio", &adio_fops},
2314 {"debug", &debug_fops},
2315 {"def_reserved_size", &dressz_fops},
2316 {"device_hdr", &devhdr_fops},
2317 {"devices", &dev_fops},
2318 {"device_strs", &devstrs_fops},
2319 {"version", &version_fops}
2326 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
2327 struct sg_proc_leaf * leaf;
2329 sg_proc_sgp = proc_mkdir(sg_proc_sg_dirname, NULL);
2332 for (k = 0; k < num_leaves; ++k) {
2333 leaf = &sg_proc_leaf_arr[k];
2334 mask = leaf->fops->write ? S_IRUGO | S_IWUSR : S_IRUGO;
2335 proc_create(leaf->name, mask, sg_proc_sgp, leaf->fops);
2341 sg_proc_cleanup(void)
2344 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
2348 for (k = 0; k < num_leaves; ++k)
2349 remove_proc_entry(sg_proc_leaf_arr[k].name, sg_proc_sgp);
2350 remove_proc_entry(sg_proc_sg_dirname, NULL);
2354 static int sg_proc_seq_show_int(struct seq_file *s, void *v)
2356 seq_printf(s, "%d\n", *((int *)s->private));
2360 static int sg_proc_single_open_adio(struct inode *inode, struct file *file)
2362 return single_open(file, sg_proc_seq_show_int, &sg_allow_dio);
2366 sg_proc_write_adio(struct file *filp, const char __user *buffer,
2367 size_t count, loff_t *off)
2372 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2374 num = (count < 10) ? count : 10;
2375 if (copy_from_user(buff, buffer, num))
2378 sg_allow_dio = simple_strtoul(buff, NULL, 10) ? 1 : 0;
2382 static int sg_proc_single_open_dressz(struct inode *inode, struct file *file)
2384 return single_open(file, sg_proc_seq_show_int, &sg_big_buff);
2388 sg_proc_write_dressz(struct file *filp, const char __user *buffer,
2389 size_t count, loff_t *off)
2392 unsigned long k = ULONG_MAX;
2395 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2397 num = (count < 10) ? count : 10;
2398 if (copy_from_user(buff, buffer, num))
2401 k = simple_strtoul(buff, NULL, 10);
2402 if (k <= 1048576) { /* limit "big buff" to 1 MB */
2409 static int sg_proc_seq_show_version(struct seq_file *s, void *v)
2411 seq_printf(s, "%d\t%s [%s]\n", sg_version_num, SG_VERSION_STR,
2416 static int sg_proc_single_open_version(struct inode *inode, struct file *file)
2418 return single_open(file, sg_proc_seq_show_version, NULL);
2421 static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v)
2423 seq_printf(s, "host\tchan\tid\tlun\ttype\topens\tqdepth\tbusy\t"
2428 static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file)
2430 return single_open(file, sg_proc_seq_show_devhdr, NULL);
2433 struct sg_proc_deviter {
2438 static void * dev_seq_start(struct seq_file *s, loff_t *pos)
2440 struct sg_proc_deviter * it = kmalloc(sizeof(*it), GFP_KERNEL);
2447 it->max = sg_last_dev();
2448 if (it->index >= it->max)
2453 static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos)
2455 struct sg_proc_deviter * it = s->private;
2458 return (it->index < it->max) ? it : NULL;
2461 static void dev_seq_stop(struct seq_file *s, void *v)
2466 static int sg_proc_open_dev(struct inode *inode, struct file *file)
2468 return seq_open(file, &dev_seq_ops);
2471 static int sg_proc_seq_show_dev(struct seq_file *s, void *v)
2473 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2475 struct scsi_device *scsidp;
2476 unsigned long iflags;
2478 read_lock_irqsave(&sg_index_lock, iflags);
2479 sdp = it ? sg_lookup_dev(it->index) : NULL;
2480 if (sdp && (scsidp = sdp->device) && (!sdp->detached))
2481 seq_printf(s, "%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\n",
2482 scsidp->host->host_no, scsidp->channel,
2483 scsidp->id, scsidp->lun, (int) scsidp->type,
2485 (int) scsidp->queue_depth,
2486 (int) scsidp->device_busy,
2487 (int) scsi_device_online(scsidp));
2489 seq_printf(s, "-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\n");
2490 read_unlock_irqrestore(&sg_index_lock, iflags);
2494 static int sg_proc_open_devstrs(struct inode *inode, struct file *file)
2496 return seq_open(file, &devstrs_seq_ops);
2499 static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v)
2501 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2503 struct scsi_device *scsidp;
2504 unsigned long iflags;
2506 read_lock_irqsave(&sg_index_lock, iflags);
2507 sdp = it ? sg_lookup_dev(it->index) : NULL;
2508 if (sdp && (scsidp = sdp->device) && (!sdp->detached))
2509 seq_printf(s, "%8.8s\t%16.16s\t%4.4s\n",
2510 scsidp->vendor, scsidp->model, scsidp->rev);
2512 seq_printf(s, "<no active device>\n");
2513 read_unlock_irqrestore(&sg_index_lock, iflags);
2517 /* must be called while holding sg_index_lock */
2518 static void sg_proc_debug_helper(struct seq_file *s, Sg_device * sdp)
2520 int k, m, new_interface, blen, usg;
2523 const sg_io_hdr_t *hp;
2528 list_for_each_entry(fp, &sdp->sfds, sfd_siblings) {
2530 read_lock(&fp->rq_list_lock); /* irqs already disabled */
2531 seq_printf(s, " FD(%d): timeout=%dms bufflen=%d "
2532 "(res)sgat=%d low_dma=%d\n", k,
2533 jiffies_to_msecs(fp->timeout),
2534 fp->reserve.bufflen,
2535 (int) fp->reserve.k_use_sg,
2537 seq_printf(s, " cmd_q=%d f_packid=%d k_orphan=%d closed=%d\n",
2538 (int) fp->cmd_q, (int) fp->force_packid,
2539 (int) fp->keep_orphan, (int) fp->closed);
2540 for (m = 0, srp = fp->headrp;
2542 ++m, srp = srp->nextrp) {
2544 new_interface = (hp->interface_id == '\0') ? 0 : 1;
2545 if (srp->res_used) {
2546 if (new_interface &&
2547 (SG_FLAG_MMAP_IO & hp->flags))
2552 if (SG_INFO_DIRECT_IO_MASK & hp->info)
2558 blen = srp->data.bufflen;
2559 usg = srp->data.k_use_sg;
2560 seq_printf(s, srp->done ?
2561 ((1 == srp->done) ? "rcv:" : "fin:")
2563 seq_printf(s, " id=%d blen=%d",
2564 srp->header.pack_id, blen);
2566 seq_printf(s, " dur=%d", hp->duration);
2568 ms = jiffies_to_msecs(jiffies);
2569 seq_printf(s, " t_o/elap=%d/%d",
2570 (new_interface ? hp->timeout :
2571 jiffies_to_msecs(fp->timeout)),
2572 (ms > hp->duration ? ms - hp->duration : 0));
2574 seq_printf(s, "ms sgat=%d op=0x%02x\n", usg,
2575 (int) srp->data.cmd_opcode);
2578 seq_printf(s, " No requests active\n");
2579 read_unlock(&fp->rq_list_lock);
2583 static int sg_proc_open_debug(struct inode *inode, struct file *file)
2585 return seq_open(file, &debug_seq_ops);
2588 static int sg_proc_seq_show_debug(struct seq_file *s, void *v)
2590 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2592 unsigned long iflags;
2594 if (it && (0 == it->index)) {
2595 seq_printf(s, "max_active_device=%d(origin 1)\n",
2597 seq_printf(s, " def_reserved_size=%d\n", sg_big_buff);
2600 read_lock_irqsave(&sg_index_lock, iflags);
2601 sdp = it ? sg_lookup_dev(it->index) : NULL;
2602 if (sdp && !list_empty(&sdp->sfds)) {
2603 struct scsi_device *scsidp = sdp->device;
2605 seq_printf(s, " >>> device=%s ", sdp->disk->disk_name);
2607 seq_printf(s, "detached pending close ");
2610 (s, "scsi%d chan=%d id=%d lun=%d em=%d",
2611 scsidp->host->host_no,
2612 scsidp->channel, scsidp->id,
2614 scsidp->host->hostt->emulated);
2615 seq_printf(s, " sg_tablesize=%d excl=%d\n",
2616 sdp->sg_tablesize, sdp->exclude);
2617 sg_proc_debug_helper(s, sdp);
2619 read_unlock_irqrestore(&sg_index_lock, iflags);
2623 #endif /* CONFIG_SCSI_PROC_FS */
2625 module_init(init_sg);
2626 module_exit(exit_sg);