3 * Started: Aug 9 by Lawrence Foard (entropy@world.std.com),
4 * to allow user process control of SCSI devices.
5 * Development Sponsored by Killy Corp. NY NY
7 * Original driver (sg.c):
8 * Copyright (C) 1992 Lawrence Foard
9 * Version 2 and 3 extensions to driver:
10 * Copyright (C) 1998 - 2005 Douglas Gilbert
12 * Modified 19-JAN-1998 Richard Gooch <rgooch@atnf.csiro.au> Devfs support
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2, or (at your option)
21 static int sg_version_num = 30534; /* 2 digits for each component */
22 #define SG_VERSION_STR "3.5.34"
25 * D. P. Gilbert (dgilbert@interlog.com, dougg@triode.net.au), notes:
26 * - scsi logging is available via SCSI_LOG_TIMEOUT macros. First
27 * the kernel/module needs to be built with CONFIG_SCSI_LOGGING
28 * (otherwise the macros compile to empty statements).
31 #include <linux/module.h>
34 #include <linux/kernel.h>
35 #include <linux/sched.h>
36 #include <linux/string.h>
38 #include <linux/aio.h>
39 #include <linux/errno.h>
40 #include <linux/mtio.h>
41 #include <linux/ioctl.h>
42 #include <linux/slab.h>
43 #include <linux/fcntl.h>
44 #include <linux/init.h>
45 #include <linux/poll.h>
46 #include <linux/moduleparam.h>
47 #include <linux/cdev.h>
48 #include <linux/idr.h>
49 #include <linux/seq_file.h>
50 #include <linux/blkdev.h>
51 #include <linux/delay.h>
52 #include <linux/blktrace_api.h>
53 #include <linux/mutex.h>
54 #include <linux/ratelimit.h>
57 #include <scsi/scsi_dbg.h>
58 #include <scsi/scsi_host.h>
59 #include <scsi/scsi_driver.h>
60 #include <scsi/scsi_ioctl.h>
63 #include "scsi_logging.h"
65 #ifdef CONFIG_SCSI_PROC_FS
66 #include <linux/proc_fs.h>
67 static char *sg_version_date = "20061027";
69 static int sg_proc_init(void);
70 static void sg_proc_cleanup(void);
73 #define SG_ALLOW_DIO_DEF 0
75 #define SG_MAX_DEVS 32768
78 * Suppose you want to calculate the formula muldiv(x,m,d)=int(x * m / d)
79 * Then when using 32 bit integers x * m may overflow during the calculation.
80 * Replacing muldiv(x) by muldiv(x)=((x % d) * m) / d + int(x / d) * m
81 * calculates the same, but prevents the overflow when both m and d
82 * are "small" numbers (like HZ and USER_HZ).
83 * Of course an overflow is inavoidable if the result of muldiv doesn't fit
86 #define MULDIV(X,MUL,DIV) ((((X % DIV) * MUL) / DIV) + ((X / DIV) * MUL))
88 #define SG_DEFAULT_TIMEOUT MULDIV(SG_DEFAULT_TIMEOUT_USER, HZ, USER_HZ)
90 int sg_big_buff = SG_DEF_RESERVED_SIZE;
91 /* N.B. This variable is readable and writeable via
92 /proc/scsi/sg/def_reserved_size . Each time sg_open() is called a buffer
93 of this size (or less if there is not enough memory) will be reserved
94 for use by this file descriptor. [Deprecated usage: this variable is also
95 readable via /proc/sys/kernel/sg-big-buff if the sg driver is built into
96 the kernel (i.e. it is not a module).] */
97 static int def_reserved_size = -1; /* picks up init parameter */
98 static int sg_allow_dio = SG_ALLOW_DIO_DEF;
100 static int scatter_elem_sz = SG_SCATTER_SZ;
101 static int scatter_elem_sz_prev = SG_SCATTER_SZ;
103 #define SG_SECTOR_SZ 512
105 static int sg_add(struct device *, struct class_interface *);
106 static void sg_remove(struct device *, struct class_interface *);
108 static DEFINE_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 /* done protected by rq_list_lock */
140 char done; /* 0->before bh, 1->before read, 2->read */
143 struct execute_work ew;
146 typedef struct sg_fd { /* holds the state of a file descriptor */
147 /* sfd_siblings is protected by sg_index_lock */
148 struct list_head sfd_siblings;
149 struct sg_device *parentdp; /* owning device */
150 wait_queue_head_t read_wait; /* queue read until command done */
151 rwlock_t rq_list_lock; /* protect access to list in req_arr */
152 int timeout; /* defaults to SG_DEFAULT_TIMEOUT */
153 int timeout_user; /* defaults to SG_DEFAULT_TIMEOUT_USER */
154 Sg_scatter_hold reserve; /* buffer held for this file descriptor */
155 unsigned save_scat_len; /* original length of trunc. scat. element */
156 Sg_request *headrp; /* head of request slist, NULL->empty */
157 struct fasync_struct *async_qp; /* used by asynchronous notification */
158 Sg_request req_arr[SG_MAX_QUEUE]; /* used as singly-linked list */
159 char low_dma; /* as in parent but possibly overridden to 1 */
160 char force_packid; /* 1 -> pack_id input to read(), 0 -> ignored */
161 char cmd_q; /* 1 -> allow command queuing, 0 -> don't */
162 char next_cmd_len; /* 0 -> automatic (def), >0 -> use on next write() */
163 char keep_orphan; /* 0 -> drop orphan (def), 1 -> keep for read() */
164 char mmap_called; /* 0 -> mmap() never called on this fd */
166 struct execute_work ew;
169 typedef struct sg_device { /* holds the state of each scsi generic device */
170 struct scsi_device *device;
171 int sg_tablesize; /* adapter's max scatter-gather table size */
172 u32 index; /* device index number */
173 /* sfds is protected by sg_index_lock */
174 struct list_head sfds;
175 struct rw_semaphore o_sem; /* exclude open should hold this rwsem */
176 volatile char detached; /* 0->attached, 1->detached pending removal */
177 char exclude; /* opened for exclusive access */
178 char sgdebug; /* 0->off, 1->sense, 9->dump dev, 10-> all devs */
179 struct gendisk *disk;
180 struct cdev * cdev; /* char_dev [sysfs: /sys/cdev/major/sg<n>] */
184 /* tasklet or soft irq callback */
185 static void sg_rq_end_io(struct request *rq, int uptodate);
186 static int sg_start_req(Sg_request *srp, unsigned char *cmd);
187 static int sg_finish_rem_req(Sg_request * srp);
188 static int sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size);
189 static ssize_t sg_new_read(Sg_fd * sfp, char __user *buf, size_t count,
191 static ssize_t sg_new_write(Sg_fd *sfp, struct file *file,
192 const char __user *buf, size_t count, int blocking,
193 int read_only, int sg_io_owned, Sg_request **o_srp);
194 static int sg_common_write(Sg_fd * sfp, Sg_request * srp,
195 unsigned char *cmnd, int timeout, int blocking);
196 static int sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer);
197 static void sg_remove_scat(Sg_scatter_hold * schp);
198 static void sg_build_reserve(Sg_fd * sfp, int req_size);
199 static void sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size);
200 static void sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp);
201 static Sg_fd *sg_add_sfp(Sg_device * sdp, int dev);
202 static void sg_remove_sfp(struct kref *);
203 static Sg_request *sg_get_rq_mark(Sg_fd * sfp, int pack_id);
204 static Sg_request *sg_add_request(Sg_fd * sfp);
205 static int sg_remove_request(Sg_fd * sfp, Sg_request * srp);
206 static int sg_res_in_use(Sg_fd * sfp);
207 static Sg_device *sg_get_dev(int dev);
208 static void sg_put_dev(Sg_device *sdp);
210 #define SZ_SG_HEADER sizeof(struct sg_header)
211 #define SZ_SG_IO_HDR sizeof(sg_io_hdr_t)
212 #define SZ_SG_IOVEC sizeof(sg_iovec_t)
213 #define SZ_SG_REQ_INFO sizeof(sg_req_info_t)
215 static int sg_allow_access(struct file *filp, unsigned char *cmd)
217 struct sg_fd *sfp = filp->private_data;
219 if (sfp->parentdp->device->type == TYPE_SCANNER)
222 return blk_verify_command(cmd, filp->f_mode & FMODE_WRITE);
225 static int sfds_list_empty(Sg_device *sdp)
230 read_lock_irqsave(&sg_index_lock, flags);
231 ret = list_empty(&sdp->sfds);
232 read_unlock_irqrestore(&sg_index_lock, flags);
237 sg_open(struct inode *inode, struct file *filp)
239 int dev = iminor(inode);
240 int flags = filp->f_flags;
241 struct request_queue *q;
246 nonseekable_open(inode, filp);
247 SCSI_LOG_TIMEOUT(3, printk("sg_open: dev=%d, flags=0x%x\n", dev, flags));
248 sdp = sg_get_dev(dev);
250 retval = PTR_ERR(sdp);
255 /* This driver's module count bumped by fops_get in <linux/fs.h> */
256 /* Prevent the device driver from vanishing while we sleep */
257 retval = scsi_device_get(sdp->device);
261 retval = scsi_autopm_get_device(sdp->device);
265 if (!((flags & O_NONBLOCK) ||
266 scsi_block_when_processing_errors(sdp->device))) {
268 /* we are in error recovery for this device */
272 if ((flags & O_EXCL) && (O_RDONLY == (flags & O_ACCMODE))) {
273 retval = -EPERM; /* Can't lock it with read only access */
276 if (flags & O_NONBLOCK) {
277 if (flags & O_EXCL) {
278 if (!down_write_trylock(&sdp->o_sem)) {
283 if (!down_read_trylock(&sdp->o_sem)) {
290 down_write(&sdp->o_sem);
292 down_read(&sdp->o_sem);
294 /* Since write lock is held, no need to check sfd_list */
296 sdp->exclude = 1; /* used by release lock */
298 if (sfds_list_empty(sdp)) { /* no existing opens on this device */
300 q = sdp->device->request_queue;
301 sdp->sg_tablesize = queue_max_segments(q);
303 sfp = sg_add_sfp(sdp, dev);
305 filp->private_data = sfp;
306 /* retval is already provably zero at this point because of the
307 * check after retval = scsi_autopm_get_device(sdp->device))
310 retval = PTR_ERR(sfp);
312 if (flags & O_EXCL) {
313 sdp->exclude = 0; /* undo if error */
314 up_write(&sdp->o_sem);
316 up_read(&sdp->o_sem);
318 scsi_autopm_put_device(sdp->device);
320 scsi_device_put(sdp->device);
328 /* Following function was formerly called 'sg_close' */
330 sg_release(struct inode *inode, struct file *filp)
336 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
338 SCSI_LOG_TIMEOUT(3, printk("sg_release: %s\n", sdp->disk->disk_name));
343 up_write(&sdp->o_sem);
345 up_read(&sdp->o_sem);
347 scsi_autopm_put_device(sdp->device);
348 kref_put(&sfp->f_ref, sg_remove_sfp);
353 sg_read(struct file *filp, char __user *buf, size_t count, loff_t * ppos)
358 int req_pack_id = -1;
360 struct sg_header *old_hdr = NULL;
363 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
365 SCSI_LOG_TIMEOUT(3, printk("sg_read: %s, count=%d\n",
366 sdp->disk->disk_name, (int) count));
368 if (!access_ok(VERIFY_WRITE, buf, count))
370 if (sfp->force_packid && (count >= SZ_SG_HEADER)) {
371 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
374 if (__copy_from_user(old_hdr, buf, SZ_SG_HEADER)) {
378 if (old_hdr->reply_len < 0) {
379 if (count >= SZ_SG_IO_HDR) {
380 sg_io_hdr_t *new_hdr;
381 new_hdr = kmalloc(SZ_SG_IO_HDR, GFP_KERNEL);
386 retval =__copy_from_user
387 (new_hdr, buf, SZ_SG_IO_HDR);
388 req_pack_id = new_hdr->pack_id;
396 req_pack_id = old_hdr->pack_id;
398 srp = sg_get_rq_mark(sfp, req_pack_id);
399 if (!srp) { /* now wait on packet to arrive */
404 if (filp->f_flags & O_NONBLOCK) {
408 retval = wait_event_interruptible(sfp->read_wait,
410 (srp = sg_get_rq_mark(sfp, req_pack_id))));
416 /* -ERESTARTSYS as signal hit process */
420 if (srp->header.interface_id != '\0') {
421 retval = sg_new_read(sfp, buf, count, srp);
426 if (old_hdr == NULL) {
427 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
433 memset(old_hdr, 0, SZ_SG_HEADER);
434 old_hdr->reply_len = (int) hp->timeout;
435 old_hdr->pack_len = old_hdr->reply_len; /* old, strange behaviour */
436 old_hdr->pack_id = hp->pack_id;
437 old_hdr->twelve_byte =
438 ((srp->data.cmd_opcode >= 0xc0) && (12 == hp->cmd_len)) ? 1 : 0;
439 old_hdr->target_status = hp->masked_status;
440 old_hdr->host_status = hp->host_status;
441 old_hdr->driver_status = hp->driver_status;
442 if ((CHECK_CONDITION & hp->masked_status) ||
443 (DRIVER_SENSE & hp->driver_status))
444 memcpy(old_hdr->sense_buffer, srp->sense_b,
445 sizeof (old_hdr->sense_buffer));
446 switch (hp->host_status) {
447 /* This setup of 'result' is for backward compatibility and is best
448 ignored by the user who should use target, host + driver status */
450 case DID_PASSTHROUGH:
457 old_hdr->result = EBUSY;
464 old_hdr->result = EIO;
467 old_hdr->result = (srp->sense_b[0] == 0 &&
468 hp->masked_status == GOOD) ? 0 : EIO;
471 old_hdr->result = EIO;
475 /* Now copy the result back to the user buffer. */
476 if (count >= SZ_SG_HEADER) {
477 if (__copy_to_user(buf, old_hdr, SZ_SG_HEADER)) {
482 if (count > old_hdr->reply_len)
483 count = old_hdr->reply_len;
484 if (count > SZ_SG_HEADER) {
485 if (sg_read_oxfer(srp, buf, count - SZ_SG_HEADER)) {
491 count = (old_hdr->result == 0) ? 0 : -EIO;
492 sg_finish_rem_req(srp);
500 sg_new_read(Sg_fd * sfp, char __user *buf, size_t count, Sg_request * srp)
502 sg_io_hdr_t *hp = &srp->header;
506 if (count < SZ_SG_IO_HDR) {
511 if ((hp->mx_sb_len > 0) && hp->sbp) {
512 if ((CHECK_CONDITION & hp->masked_status) ||
513 (DRIVER_SENSE & hp->driver_status)) {
514 int sb_len = SCSI_SENSE_BUFFERSIZE;
515 sb_len = (hp->mx_sb_len > sb_len) ? sb_len : hp->mx_sb_len;
516 len = 8 + (int) srp->sense_b[7]; /* Additional sense length field */
517 len = (len > sb_len) ? sb_len : len;
518 if (copy_to_user(hp->sbp, srp->sense_b, len)) {
525 if (hp->masked_status || hp->host_status || hp->driver_status)
526 hp->info |= SG_INFO_CHECK;
527 if (copy_to_user(buf, hp, SZ_SG_IO_HDR)) {
532 err = sg_finish_rem_req(srp);
533 return (0 == err) ? count : err;
537 sg_write(struct file *filp, const char __user *buf, size_t count, loff_t * ppos)
539 int mxsize, cmd_size, k;
540 int input_size, blocking;
541 unsigned char opcode;
545 struct sg_header old_hdr;
547 unsigned char cmnd[MAX_COMMAND_SIZE];
549 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
551 SCSI_LOG_TIMEOUT(3, printk("sg_write: %s, count=%d\n",
552 sdp->disk->disk_name, (int) count));
555 if (!((filp->f_flags & O_NONBLOCK) ||
556 scsi_block_when_processing_errors(sdp->device)))
559 if (!access_ok(VERIFY_READ, buf, count))
560 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
561 if (count < SZ_SG_HEADER)
563 if (__copy_from_user(&old_hdr, buf, SZ_SG_HEADER))
565 blocking = !(filp->f_flags & O_NONBLOCK);
566 if (old_hdr.reply_len < 0)
567 return sg_new_write(sfp, filp, buf, count,
568 blocking, 0, 0, NULL);
569 if (count < (SZ_SG_HEADER + 6))
570 return -EIO; /* The minimum scsi command length is 6 bytes. */
572 if (!(srp = sg_add_request(sfp))) {
573 SCSI_LOG_TIMEOUT(1, printk("sg_write: queue full\n"));
577 __get_user(opcode, buf);
578 if (sfp->next_cmd_len > 0) {
579 if (sfp->next_cmd_len > MAX_COMMAND_SIZE) {
580 SCSI_LOG_TIMEOUT(1, printk("sg_write: command length too long\n"));
581 sfp->next_cmd_len = 0;
582 sg_remove_request(sfp, srp);
585 cmd_size = sfp->next_cmd_len;
586 sfp->next_cmd_len = 0; /* reset so only this write() effected */
588 cmd_size = COMMAND_SIZE(opcode); /* based on SCSI command group */
589 if ((opcode >= 0xc0) && old_hdr.twelve_byte)
592 SCSI_LOG_TIMEOUT(4, printk(
593 "sg_write: scsi opcode=0x%02x, cmd_size=%d\n", (int) opcode, cmd_size));
594 /* Determine buffer size. */
595 input_size = count - cmd_size;
596 mxsize = (input_size > old_hdr.reply_len) ? input_size : old_hdr.reply_len;
597 mxsize -= SZ_SG_HEADER;
598 input_size -= SZ_SG_HEADER;
599 if (input_size < 0) {
600 sg_remove_request(sfp, srp);
601 return -EIO; /* User did not pass enough bytes for this command. */
604 hp->interface_id = '\0'; /* indicator of old interface tunnelled */
605 hp->cmd_len = (unsigned char) cmd_size;
609 hp->dxfer_direction = (old_hdr.reply_len > SZ_SG_HEADER) ?
610 SG_DXFER_TO_FROM_DEV : SG_DXFER_TO_DEV;
612 hp->dxfer_direction = (mxsize > 0) ? SG_DXFER_FROM_DEV : SG_DXFER_NONE;
613 hp->dxfer_len = mxsize;
614 if (hp->dxfer_direction == SG_DXFER_TO_DEV)
615 hp->dxferp = (char __user *)buf + cmd_size;
619 hp->timeout = old_hdr.reply_len; /* structure abuse ... */
620 hp->flags = input_size; /* structure abuse ... */
621 hp->pack_id = old_hdr.pack_id;
623 if (__copy_from_user(cmnd, buf, cmd_size))
626 * SG_DXFER_TO_FROM_DEV is functionally equivalent to SG_DXFER_FROM_DEV,
627 * but is is possible that the app intended SG_DXFER_TO_DEV, because there
628 * is a non-zero input_size, so emit a warning.
630 if (hp->dxfer_direction == SG_DXFER_TO_FROM_DEV) {
631 static char cmd[TASK_COMM_LEN];
632 if (strcmp(current->comm, cmd)) {
633 printk_ratelimited(KERN_WARNING
634 "sg_write: data in/out %d/%d bytes "
635 "for SCSI command 0x%x-- guessing "
636 "data in;\n program %s not setting "
637 "count and/or reply_len properly\n",
638 old_hdr.reply_len - (int)SZ_SG_HEADER,
639 input_size, (unsigned int) cmnd[0],
641 strcpy(cmd, current->comm);
644 k = sg_common_write(sfp, srp, cmnd, sfp->timeout, blocking);
645 return (k < 0) ? k : count;
649 sg_new_write(Sg_fd *sfp, struct file *file, const char __user *buf,
650 size_t count, int blocking, int read_only, int sg_io_owned,
656 unsigned char cmnd[MAX_COMMAND_SIZE];
658 unsigned long ul_timeout;
660 if (count < SZ_SG_IO_HDR)
662 if (!access_ok(VERIFY_READ, buf, count))
663 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
665 sfp->cmd_q = 1; /* when sg_io_hdr seen, set command queuing on */
666 if (!(srp = sg_add_request(sfp))) {
667 SCSI_LOG_TIMEOUT(1, printk("sg_new_write: queue full\n"));
670 srp->sg_io_owned = sg_io_owned;
672 if (__copy_from_user(hp, buf, SZ_SG_IO_HDR)) {
673 sg_remove_request(sfp, srp);
676 if (hp->interface_id != 'S') {
677 sg_remove_request(sfp, srp);
680 if (hp->flags & SG_FLAG_MMAP_IO) {
681 if (hp->dxfer_len > sfp->reserve.bufflen) {
682 sg_remove_request(sfp, srp);
683 return -ENOMEM; /* MMAP_IO size must fit in reserve buffer */
685 if (hp->flags & SG_FLAG_DIRECT_IO) {
686 sg_remove_request(sfp, srp);
687 return -EINVAL; /* either MMAP_IO or DIRECT_IO (not both) */
689 if (sg_res_in_use(sfp)) {
690 sg_remove_request(sfp, srp);
691 return -EBUSY; /* reserve buffer already being used */
694 ul_timeout = msecs_to_jiffies(srp->header.timeout);
695 timeout = (ul_timeout < INT_MAX) ? ul_timeout : INT_MAX;
696 if ((!hp->cmdp) || (hp->cmd_len < 6) || (hp->cmd_len > sizeof (cmnd))) {
697 sg_remove_request(sfp, srp);
700 if (!access_ok(VERIFY_READ, hp->cmdp, hp->cmd_len)) {
701 sg_remove_request(sfp, srp);
702 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
704 if (__copy_from_user(cmnd, hp->cmdp, hp->cmd_len)) {
705 sg_remove_request(sfp, srp);
708 if (read_only && sg_allow_access(file, cmnd)) {
709 sg_remove_request(sfp, srp);
712 k = sg_common_write(sfp, srp, cmnd, timeout, blocking);
721 sg_common_write(Sg_fd * sfp, Sg_request * srp,
722 unsigned char *cmnd, int timeout, int blocking)
725 Sg_device *sdp = sfp->parentdp;
726 sg_io_hdr_t *hp = &srp->header;
728 srp->data.cmd_opcode = cmnd[0]; /* hold opcode of command */
730 hp->masked_status = 0;
734 hp->driver_status = 0;
736 SCSI_LOG_TIMEOUT(4, printk("sg_common_write: scsi opcode=0x%02x, cmd_size=%d\n",
737 (int) cmnd[0], (int) hp->cmd_len));
739 k = sg_start_req(srp, cmnd);
741 SCSI_LOG_TIMEOUT(1, printk("sg_common_write: start_req err=%d\n", k));
742 sg_finish_rem_req(srp);
743 return k; /* probably out of space --> ENOMEM */
747 blk_end_request_all(srp->rq, -EIO);
748 sg_finish_rem_req(srp);
752 switch (hp->dxfer_direction) {
753 case SG_DXFER_TO_FROM_DEV:
754 case SG_DXFER_FROM_DEV:
755 data_dir = DMA_FROM_DEVICE;
757 case SG_DXFER_TO_DEV:
758 data_dir = DMA_TO_DEVICE;
760 case SG_DXFER_UNKNOWN:
761 data_dir = DMA_BIDIRECTIONAL;
767 hp->duration = jiffies_to_msecs(jiffies);
769 srp->rq->timeout = timeout;
770 kref_get(&sfp->f_ref); /* sg_rq_end_io() does kref_put(). */
771 blk_execute_rq_nowait(sdp->device->request_queue, sdp->disk,
772 srp->rq, 1, sg_rq_end_io);
776 static int srp_done(Sg_fd *sfp, Sg_request *srp)
781 read_lock_irqsave(&sfp->rq_list_lock, flags);
783 read_unlock_irqrestore(&sfp->rq_list_lock, flags);
788 sg_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
790 void __user *p = (void __user *)arg;
792 int result, val, read_only;
796 unsigned long iflags;
798 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
801 SCSI_LOG_TIMEOUT(3, printk("sg_ioctl: %s, cmd=0x%x\n",
802 sdp->disk->disk_name, (int) cmd_in));
803 read_only = (O_RDWR != (filp->f_flags & O_ACCMODE));
809 if (!scsi_block_when_processing_errors(sdp->device))
811 if (!access_ok(VERIFY_WRITE, p, SZ_SG_IO_HDR))
813 result = sg_new_write(sfp, filp, p, SZ_SG_IO_HDR,
814 1, read_only, 1, &srp);
817 result = wait_event_interruptible(sfp->read_wait,
818 (srp_done(sfp, srp) || sdp->detached));
821 write_lock_irq(&sfp->rq_list_lock);
824 write_unlock_irq(&sfp->rq_list_lock);
825 result = sg_new_read(sfp, p, SZ_SG_IO_HDR, srp);
826 return (result < 0) ? result : 0;
829 write_unlock_irq(&sfp->rq_list_lock);
830 return result; /* -ERESTARTSYS because signal hit process */
832 result = get_user(val, ip);
837 if (val >= MULDIV (INT_MAX, USER_HZ, HZ))
838 val = MULDIV (INT_MAX, USER_HZ, HZ);
839 sfp->timeout_user = val;
840 sfp->timeout = MULDIV (val, HZ, USER_HZ);
843 case SG_GET_TIMEOUT: /* N.B. User receives timeout as return value */
844 /* strange ..., for backward compatibility */
845 return sfp->timeout_user;
846 case SG_SET_FORCE_LOW_DMA:
847 result = get_user(val, ip);
852 if ((0 == sfp->low_dma) && (0 == sg_res_in_use(sfp))) {
853 val = (int) sfp->reserve.bufflen;
854 sg_remove_scat(&sfp->reserve);
855 sg_build_reserve(sfp, val);
860 sfp->low_dma = sdp->device->host->unchecked_isa_dma;
864 return put_user((int) sfp->low_dma, ip);
866 if (!access_ok(VERIFY_WRITE, p, sizeof (sg_scsi_id_t)))
869 sg_scsi_id_t __user *sg_idp = p;
873 __put_user((int) sdp->device->host->host_no,
875 __put_user((int) sdp->device->channel,
877 __put_user((int) sdp->device->id, &sg_idp->scsi_id);
878 __put_user((int) sdp->device->lun, &sg_idp->lun);
879 __put_user((int) sdp->device->type, &sg_idp->scsi_type);
880 __put_user((short) sdp->device->host->cmd_per_lun,
881 &sg_idp->h_cmd_per_lun);
882 __put_user((short) sdp->device->queue_depth,
883 &sg_idp->d_queue_depth);
884 __put_user(0, &sg_idp->unused[0]);
885 __put_user(0, &sg_idp->unused[1]);
888 case SG_SET_FORCE_PACK_ID:
889 result = get_user(val, ip);
892 sfp->force_packid = val ? 1 : 0;
895 if (!access_ok(VERIFY_WRITE, ip, sizeof (int)))
897 read_lock_irqsave(&sfp->rq_list_lock, iflags);
898 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
899 if ((1 == srp->done) && (!srp->sg_io_owned)) {
900 read_unlock_irqrestore(&sfp->rq_list_lock,
902 __put_user(srp->header.pack_id, ip);
906 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
909 case SG_GET_NUM_WAITING:
910 read_lock_irqsave(&sfp->rq_list_lock, iflags);
911 for (val = 0, srp = sfp->headrp; srp; srp = srp->nextrp) {
912 if ((1 == srp->done) && (!srp->sg_io_owned))
915 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
916 return put_user(val, ip);
917 case SG_GET_SG_TABLESIZE:
918 return put_user(sdp->sg_tablesize, ip);
919 case SG_SET_RESERVED_SIZE:
920 result = get_user(val, ip);
925 val = min_t(int, val,
926 queue_max_sectors(sdp->device->request_queue) * 512);
927 if (val != sfp->reserve.bufflen) {
928 if (sg_res_in_use(sfp) || sfp->mmap_called)
930 sg_remove_scat(&sfp->reserve);
931 sg_build_reserve(sfp, val);
934 case SG_GET_RESERVED_SIZE:
935 val = min_t(int, sfp->reserve.bufflen,
936 queue_max_sectors(sdp->device->request_queue) * 512);
937 return put_user(val, ip);
938 case SG_SET_COMMAND_Q:
939 result = get_user(val, ip);
942 sfp->cmd_q = val ? 1 : 0;
944 case SG_GET_COMMAND_Q:
945 return put_user((int) sfp->cmd_q, ip);
946 case SG_SET_KEEP_ORPHAN:
947 result = get_user(val, ip);
950 sfp->keep_orphan = val;
952 case SG_GET_KEEP_ORPHAN:
953 return put_user((int) sfp->keep_orphan, ip);
954 case SG_NEXT_CMD_LEN:
955 result = get_user(val, ip);
958 sfp->next_cmd_len = (val > 0) ? val : 0;
960 case SG_GET_VERSION_NUM:
961 return put_user(sg_version_num, ip);
962 case SG_GET_ACCESS_COUNT:
963 /* faked - we don't have a real access count anymore */
964 val = (sdp->device ? 1 : 0);
965 return put_user(val, ip);
966 case SG_GET_REQUEST_TABLE:
967 if (!access_ok(VERIFY_WRITE, p, SZ_SG_REQ_INFO * SG_MAX_QUEUE))
970 sg_req_info_t *rinfo;
973 rinfo = kmalloc(SZ_SG_REQ_INFO * SG_MAX_QUEUE,
977 read_lock_irqsave(&sfp->rq_list_lock, iflags);
978 for (srp = sfp->headrp, val = 0; val < SG_MAX_QUEUE;
979 ++val, srp = srp ? srp->nextrp : srp) {
980 memset(&rinfo[val], 0, SZ_SG_REQ_INFO);
982 rinfo[val].req_state = srp->done + 1;
984 srp->header.masked_status &
985 srp->header.host_status &
986 srp->header.driver_status;
988 rinfo[val].duration =
989 srp->header.duration;
991 ms = jiffies_to_msecs(jiffies);
992 rinfo[val].duration =
993 (ms > srp->header.duration) ?
994 (ms - srp->header.duration) : 0;
996 rinfo[val].orphan = srp->orphan;
997 rinfo[val].sg_io_owned =
1000 srp->header.pack_id;
1001 rinfo[val].usr_ptr =
1002 srp->header.usr_ptr;
1005 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1006 result = __copy_to_user(p, rinfo,
1007 SZ_SG_REQ_INFO * SG_MAX_QUEUE);
1008 result = result ? -EFAULT : 0;
1012 case SG_EMULATED_HOST:
1015 return put_user(sdp->device->host->hostt->emulated, ip);
1019 if (filp->f_flags & O_NONBLOCK) {
1020 if (scsi_host_in_recovery(sdp->device->host))
1022 } else if (!scsi_block_when_processing_errors(sdp->device))
1024 result = get_user(val, ip);
1027 if (SG_SCSI_RESET_NOTHING == val)
1030 case SG_SCSI_RESET_DEVICE:
1031 val = SCSI_TRY_RESET_DEVICE;
1033 case SG_SCSI_RESET_TARGET:
1034 val = SCSI_TRY_RESET_TARGET;
1036 case SG_SCSI_RESET_BUS:
1037 val = SCSI_TRY_RESET_BUS;
1039 case SG_SCSI_RESET_HOST:
1040 val = SCSI_TRY_RESET_HOST;
1045 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
1047 return (scsi_reset_provider(sdp->device, val) ==
1048 SUCCESS) ? 0 : -EIO;
1049 case SCSI_IOCTL_SEND_COMMAND:
1053 unsigned char opcode = WRITE_6;
1054 Scsi_Ioctl_Command __user *siocp = p;
1056 if (copy_from_user(&opcode, siocp->data, 1))
1058 if (sg_allow_access(filp, &opcode))
1061 return sg_scsi_ioctl(sdp->device->request_queue, NULL, filp->f_mode, p);
1063 result = get_user(val, ip);
1066 sdp->sgdebug = (char) val;
1068 case SCSI_IOCTL_GET_IDLUN:
1069 case SCSI_IOCTL_GET_BUS_NUMBER:
1070 case SCSI_IOCTL_PROBE_HOST:
1071 case SG_GET_TRANSFORM:
1074 return scsi_ioctl(sdp->device, cmd_in, p);
1076 return put_user(queue_max_sectors(sdp->device->request_queue) * 512,
1079 return blk_trace_setup(sdp->device->request_queue,
1080 sdp->disk->disk_name,
1081 MKDEV(SCSI_GENERIC_MAJOR, sdp->index),
1085 return blk_trace_startstop(sdp->device->request_queue, 1);
1087 return blk_trace_startstop(sdp->device->request_queue, 0);
1088 case BLKTRACETEARDOWN:
1089 return blk_trace_remove(sdp->device->request_queue);
1092 return -EPERM; /* don't know so take safe approach */
1093 return scsi_ioctl(sdp->device, cmd_in, p);
1097 #ifdef CONFIG_COMPAT
1098 static long sg_compat_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
1102 struct scsi_device *sdev;
1104 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1108 if (sdev->host->hostt->compat_ioctl) {
1111 ret = sdev->host->hostt->compat_ioctl(sdev, cmd_in, (void __user *)arg);
1116 return -ENOIOCTLCMD;
1121 sg_poll(struct file *filp, poll_table * wait)
1123 unsigned int res = 0;
1128 unsigned long iflags;
1130 sfp = filp->private_data;
1133 sdp = sfp->parentdp;
1136 poll_wait(filp, &sfp->read_wait, wait);
1137 read_lock_irqsave(&sfp->rq_list_lock, iflags);
1138 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
1139 /* if any read waiting, flag it */
1140 if ((0 == res) && (1 == srp->done) && (!srp->sg_io_owned))
1141 res = POLLIN | POLLRDNORM;
1144 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1148 else if (!sfp->cmd_q) {
1150 res |= POLLOUT | POLLWRNORM;
1151 } else if (count < SG_MAX_QUEUE)
1152 res |= POLLOUT | POLLWRNORM;
1153 SCSI_LOG_TIMEOUT(3, printk("sg_poll: %s, res=0x%x\n",
1154 sdp->disk->disk_name, (int) res));
1159 sg_fasync(int fd, struct file *filp, int mode)
1164 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1166 SCSI_LOG_TIMEOUT(3, printk("sg_fasync: %s, mode=%d\n",
1167 sdp->disk->disk_name, mode));
1169 return fasync_helper(fd, filp, mode, &sfp->async_qp);
1173 sg_vma_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
1176 unsigned long offset, len, sa;
1177 Sg_scatter_hold *rsv_schp;
1180 if ((NULL == vma) || (!(sfp = (Sg_fd *) vma->vm_private_data)))
1181 return VM_FAULT_SIGBUS;
1182 rsv_schp = &sfp->reserve;
1183 offset = vmf->pgoff << PAGE_SHIFT;
1184 if (offset >= rsv_schp->bufflen)
1185 return VM_FAULT_SIGBUS;
1186 SCSI_LOG_TIMEOUT(3, printk("sg_vma_fault: offset=%lu, scatg=%d\n",
1187 offset, rsv_schp->k_use_sg));
1189 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1190 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
1191 len = vma->vm_end - sa;
1192 len = (len < length) ? len : length;
1194 struct page *page = nth_page(rsv_schp->pages[k],
1195 offset >> PAGE_SHIFT);
1196 get_page(page); /* increment page count */
1198 return 0; /* success */
1204 return VM_FAULT_SIGBUS;
1207 static const struct vm_operations_struct sg_mmap_vm_ops = {
1208 .fault = sg_vma_fault,
1212 sg_mmap(struct file *filp, struct vm_area_struct *vma)
1215 unsigned long req_sz, len, sa;
1216 Sg_scatter_hold *rsv_schp;
1219 if ((!filp) || (!vma) || (!(sfp = (Sg_fd *) filp->private_data)))
1221 req_sz = vma->vm_end - vma->vm_start;
1222 SCSI_LOG_TIMEOUT(3, printk("sg_mmap starting, vm_start=%p, len=%d\n",
1223 (void *) vma->vm_start, (int) req_sz));
1225 return -EINVAL; /* want no offset */
1226 rsv_schp = &sfp->reserve;
1227 if (req_sz > rsv_schp->bufflen)
1228 return -ENOMEM; /* cannot map more than reserved buffer */
1231 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1232 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
1233 len = vma->vm_end - sa;
1234 len = (len < length) ? len : length;
1238 sfp->mmap_called = 1;
1239 vma->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
1240 vma->vm_private_data = sfp;
1241 vma->vm_ops = &sg_mmap_vm_ops;
1245 static void sg_rq_end_io_usercontext(struct work_struct *work)
1247 struct sg_request *srp = container_of(work, struct sg_request, ew.work);
1248 struct sg_fd *sfp = srp->parentfp;
1250 sg_finish_rem_req(srp);
1251 kref_put(&sfp->f_ref, sg_remove_sfp);
1255 * This function is a "bottom half" handler that is called by the mid
1256 * level when a command is completed (or has failed).
1258 static void sg_rq_end_io(struct request *rq, int uptodate)
1260 struct sg_request *srp = rq->end_io_data;
1263 unsigned long iflags;
1266 int result, resid, done = 1;
1268 if (WARN_ON(srp->done != 0))
1271 sfp = srp->parentfp;
1272 if (WARN_ON(sfp == NULL))
1275 sdp = sfp->parentdp;
1276 if (unlikely(sdp->detached))
1277 printk(KERN_INFO "sg_rq_end_io: device detached\n");
1280 result = rq->errors;
1281 resid = rq->resid_len;
1283 SCSI_LOG_TIMEOUT(4, printk("sg_cmd_done: %s, pack_id=%d, res=0x%x\n",
1284 sdp->disk->disk_name, srp->header.pack_id, result));
1285 srp->header.resid = resid;
1286 ms = jiffies_to_msecs(jiffies);
1287 srp->header.duration = (ms > srp->header.duration) ?
1288 (ms - srp->header.duration) : 0;
1290 struct scsi_sense_hdr sshdr;
1292 srp->header.status = 0xff & result;
1293 srp->header.masked_status = status_byte(result);
1294 srp->header.msg_status = msg_byte(result);
1295 srp->header.host_status = host_byte(result);
1296 srp->header.driver_status = driver_byte(result);
1297 if ((sdp->sgdebug > 0) &&
1298 ((CHECK_CONDITION == srp->header.masked_status) ||
1299 (COMMAND_TERMINATED == srp->header.masked_status)))
1300 __scsi_print_sense("sg_cmd_done", sense,
1301 SCSI_SENSE_BUFFERSIZE);
1303 /* Following if statement is a patch supplied by Eric Youngdale */
1304 if (driver_byte(result) != 0
1305 && scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, &sshdr)
1306 && !scsi_sense_is_deferred(&sshdr)
1307 && sshdr.sense_key == UNIT_ATTENTION
1308 && sdp->device->removable) {
1309 /* Detected possible disc change. Set the bit - this */
1310 /* may be used if there are filesystems using this device */
1311 sdp->device->changed = 1;
1314 /* Rely on write phase to clean out srp status values, so no "else" */
1316 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1317 if (unlikely(srp->orphan)) {
1318 if (sfp->keep_orphan)
1319 srp->sg_io_owned = 0;
1324 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1327 /* Now wake up any sg_read() that is waiting for this
1330 wake_up_interruptible(&sfp->read_wait);
1331 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_IN);
1332 kref_put(&sfp->f_ref, sg_remove_sfp);
1334 INIT_WORK(&srp->ew.work, sg_rq_end_io_usercontext);
1335 schedule_work(&srp->ew.work);
1339 static const struct file_operations sg_fops = {
1340 .owner = THIS_MODULE,
1344 .unlocked_ioctl = sg_ioctl,
1345 #ifdef CONFIG_COMPAT
1346 .compat_ioctl = sg_compat_ioctl,
1350 .release = sg_release,
1351 .fasync = sg_fasync,
1352 .llseek = no_llseek,
1355 static struct class *sg_sysfs_class;
1357 static int sg_sysfs_valid = 0;
1359 static Sg_device *sg_alloc(struct gendisk *disk, struct scsi_device *scsidp)
1361 struct request_queue *q = scsidp->request_queue;
1363 unsigned long iflags;
1367 sdp = kzalloc(sizeof(Sg_device), GFP_KERNEL);
1369 printk(KERN_WARNING "kmalloc Sg_device failure\n");
1370 return ERR_PTR(-ENOMEM);
1373 idr_preload(GFP_KERNEL);
1374 write_lock_irqsave(&sg_index_lock, iflags);
1376 error = idr_alloc(&sg_index_idr, sdp, 0, SG_MAX_DEVS, GFP_NOWAIT);
1378 if (error == -ENOSPC) {
1379 sdev_printk(KERN_WARNING, scsidp,
1380 "Unable to attach sg device type=%d, minor number exceeds %d\n",
1381 scsidp->type, SG_MAX_DEVS - 1);
1385 "idr allocation Sg_device failure: %d\n", error);
1391 SCSI_LOG_TIMEOUT(3, printk("sg_alloc: dev=%d \n", k));
1392 sprintf(disk->disk_name, "sg%d", k);
1393 disk->first_minor = k;
1395 sdp->device = scsidp;
1396 INIT_LIST_HEAD(&sdp->sfds);
1397 init_rwsem(&sdp->o_sem);
1398 sdp->sg_tablesize = queue_max_segments(q);
1400 kref_init(&sdp->d_ref);
1404 write_unlock_irqrestore(&sg_index_lock, iflags);
1409 return ERR_PTR(error);
1415 sg_add(struct device *cl_dev, struct class_interface *cl_intf)
1417 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
1418 struct gendisk *disk;
1419 Sg_device *sdp = NULL;
1420 struct cdev * cdev = NULL;
1422 unsigned long iflags;
1424 disk = alloc_disk(1);
1426 printk(KERN_WARNING "alloc_disk failed\n");
1429 disk->major = SCSI_GENERIC_MAJOR;
1432 cdev = cdev_alloc();
1434 printk(KERN_WARNING "cdev_alloc failed\n");
1437 cdev->owner = THIS_MODULE;
1438 cdev->ops = &sg_fops;
1440 sdp = sg_alloc(disk, scsidp);
1442 printk(KERN_WARNING "sg_alloc failed\n");
1443 error = PTR_ERR(sdp);
1447 error = cdev_add(cdev, MKDEV(SCSI_GENERIC_MAJOR, sdp->index), 1);
1452 if (sg_sysfs_valid) {
1453 struct device *sg_class_member;
1455 sg_class_member = device_create(sg_sysfs_class, cl_dev->parent,
1456 MKDEV(SCSI_GENERIC_MAJOR,
1458 sdp, "%s", disk->disk_name);
1459 if (IS_ERR(sg_class_member)) {
1460 printk(KERN_ERR "sg_add: "
1461 "device_create failed\n");
1462 error = PTR_ERR(sg_class_member);
1465 error = sysfs_create_link(&scsidp->sdev_gendev.kobj,
1466 &sg_class_member->kobj, "generic");
1468 printk(KERN_ERR "sg_add: unable to make symlink "
1469 "'generic' back to sg%d\n", sdp->index);
1471 printk(KERN_WARNING "sg_add: sg_sys Invalid\n");
1473 sdev_printk(KERN_NOTICE, scsidp,
1474 "Attached scsi generic sg%d type %d\n", sdp->index,
1477 dev_set_drvdata(cl_dev, sdp);
1482 write_lock_irqsave(&sg_index_lock, iflags);
1483 idr_remove(&sg_index_idr, sdp->index);
1484 write_unlock_irqrestore(&sg_index_lock, iflags);
1494 static void sg_device_destroy(struct kref *kref)
1496 struct sg_device *sdp = container_of(kref, struct sg_device, d_ref);
1497 unsigned long flags;
1499 /* CAUTION! Note that the device can still be found via idr_find()
1500 * even though the refcount is 0. Therefore, do idr_remove() BEFORE
1501 * any other cleanup.
1504 write_lock_irqsave(&sg_index_lock, flags);
1505 idr_remove(&sg_index_idr, sdp->index);
1506 write_unlock_irqrestore(&sg_index_lock, flags);
1509 printk("sg_device_destroy: %s\n",
1510 sdp->disk->disk_name));
1512 put_disk(sdp->disk);
1516 static void sg_remove(struct device *cl_dev, struct class_interface *cl_intf)
1518 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
1519 Sg_device *sdp = dev_get_drvdata(cl_dev);
1520 unsigned long iflags;
1523 if (!sdp || sdp->detached)
1526 SCSI_LOG_TIMEOUT(3, printk("sg_remove: %s\n", sdp->disk->disk_name));
1528 /* Need a write lock to set sdp->detached. */
1529 write_lock_irqsave(&sg_index_lock, iflags);
1531 list_for_each_entry(sfp, &sdp->sfds, sfd_siblings) {
1532 wake_up_interruptible(&sfp->read_wait);
1533 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_HUP);
1535 write_unlock_irqrestore(&sg_index_lock, iflags);
1537 sysfs_remove_link(&scsidp->sdev_gendev.kobj, "generic");
1538 device_destroy(sg_sysfs_class, MKDEV(SCSI_GENERIC_MAJOR, sdp->index));
1539 cdev_del(sdp->cdev);
1545 module_param_named(scatter_elem_sz, scatter_elem_sz, int, S_IRUGO | S_IWUSR);
1546 module_param_named(def_reserved_size, def_reserved_size, int,
1548 module_param_named(allow_dio, sg_allow_dio, int, S_IRUGO | S_IWUSR);
1550 MODULE_AUTHOR("Douglas Gilbert");
1551 MODULE_DESCRIPTION("SCSI generic (sg) driver");
1552 MODULE_LICENSE("GPL");
1553 MODULE_VERSION(SG_VERSION_STR);
1554 MODULE_ALIAS_CHARDEV_MAJOR(SCSI_GENERIC_MAJOR);
1556 MODULE_PARM_DESC(scatter_elem_sz, "scatter gather element "
1557 "size (default: max(SG_SCATTER_SZ, PAGE_SIZE))");
1558 MODULE_PARM_DESC(def_reserved_size, "size of buffer reserved for each fd");
1559 MODULE_PARM_DESC(allow_dio, "allow direct I/O (default: 0 (disallow))");
1566 if (scatter_elem_sz < PAGE_SIZE) {
1567 scatter_elem_sz = PAGE_SIZE;
1568 scatter_elem_sz_prev = scatter_elem_sz;
1570 if (def_reserved_size >= 0)
1571 sg_big_buff = def_reserved_size;
1573 def_reserved_size = sg_big_buff;
1575 rc = register_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1579 sg_sysfs_class = class_create(THIS_MODULE, "scsi_generic");
1580 if ( IS_ERR(sg_sysfs_class) ) {
1581 rc = PTR_ERR(sg_sysfs_class);
1585 rc = scsi_register_interface(&sg_interface);
1587 #ifdef CONFIG_SCSI_PROC_FS
1589 #endif /* CONFIG_SCSI_PROC_FS */
1592 class_destroy(sg_sysfs_class);
1594 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0), SG_MAX_DEVS);
1601 #ifdef CONFIG_SCSI_PROC_FS
1603 #endif /* CONFIG_SCSI_PROC_FS */
1604 scsi_unregister_interface(&sg_interface);
1605 class_destroy(sg_sysfs_class);
1607 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1609 idr_destroy(&sg_index_idr);
1612 static int sg_start_req(Sg_request *srp, unsigned char *cmd)
1616 Sg_fd *sfp = srp->parentfp;
1617 sg_io_hdr_t *hp = &srp->header;
1618 int dxfer_len = (int) hp->dxfer_len;
1619 int dxfer_dir = hp->dxfer_direction;
1620 unsigned int iov_count = hp->iovec_count;
1621 Sg_scatter_hold *req_schp = &srp->data;
1622 Sg_scatter_hold *rsv_schp = &sfp->reserve;
1623 struct request_queue *q = sfp->parentdp->device->request_queue;
1624 struct rq_map_data *md, map_data;
1625 int rw = hp->dxfer_direction == SG_DXFER_TO_DEV ? WRITE : READ;
1627 SCSI_LOG_TIMEOUT(4, printk(KERN_INFO "sg_start_req: dxfer_len=%d\n",
1630 rq = blk_get_request(q, rw, GFP_ATOMIC);
1634 memcpy(rq->cmd, cmd, hp->cmd_len);
1636 rq->cmd_len = hp->cmd_len;
1637 rq->cmd_type = REQ_TYPE_BLOCK_PC;
1640 rq->end_io_data = srp;
1641 rq->sense = srp->sense_b;
1642 rq->retries = SG_DEFAULT_RETRIES;
1644 if ((dxfer_len <= 0) || (dxfer_dir == SG_DXFER_NONE))
1647 if (sg_allow_dio && hp->flags & SG_FLAG_DIRECT_IO &&
1648 dxfer_dir != SG_DXFER_UNKNOWN && !iov_count &&
1649 !sfp->parentdp->device->host->unchecked_isa_dma &&
1650 blk_rq_aligned(q, (unsigned long)hp->dxferp, dxfer_len))
1656 if (!sg_res_in_use(sfp) && dxfer_len <= rsv_schp->bufflen)
1657 sg_link_reserve(sfp, srp, dxfer_len);
1659 res = sg_build_indirect(req_schp, sfp, dxfer_len);
1664 md->pages = req_schp->pages;
1665 md->page_order = req_schp->page_order;
1666 md->nr_entries = req_schp->k_use_sg;
1668 md->null_mapped = hp->dxferp ? 0 : 1;
1669 if (dxfer_dir == SG_DXFER_TO_FROM_DEV)
1676 int len, size = sizeof(struct sg_iovec) * iov_count;
1679 iov = memdup_user(hp->dxferp, size);
1681 return PTR_ERR(iov);
1683 len = iov_length(iov, iov_count);
1684 if (hp->dxfer_len < len) {
1685 iov_count = iov_shorten(iov, iov_count, hp->dxfer_len);
1686 len = hp->dxfer_len;
1689 res = blk_rq_map_user_iov(q, rq, md, (struct sg_iovec *)iov,
1694 res = blk_rq_map_user(q, rq, md, hp->dxferp,
1695 hp->dxfer_len, GFP_ATOMIC);
1701 req_schp->dio_in_use = 1;
1702 hp->info |= SG_INFO_DIRECT_IO;
1708 static int sg_finish_rem_req(Sg_request * srp)
1712 Sg_fd *sfp = srp->parentfp;
1713 Sg_scatter_hold *req_schp = &srp->data;
1715 SCSI_LOG_TIMEOUT(4, printk("sg_finish_rem_req: res_used=%d\n", (int) srp->res_used));
1718 ret = blk_rq_unmap_user(srp->bio);
1720 blk_put_request(srp->rq);
1724 sg_unlink_reserve(sfp, srp);
1726 sg_remove_scat(req_schp);
1728 sg_remove_request(sfp, srp);
1734 sg_build_sgat(Sg_scatter_hold * schp, const Sg_fd * sfp, int tablesize)
1736 int sg_bufflen = tablesize * sizeof(struct page *);
1737 gfp_t gfp_flags = GFP_ATOMIC | __GFP_NOWARN;
1739 schp->pages = kzalloc(sg_bufflen, gfp_flags);
1742 schp->sglist_len = sg_bufflen;
1743 return tablesize; /* number of scat_gath elements allocated */
1747 sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size)
1749 int ret_sz = 0, i, k, rem_sz, num, mx_sc_elems;
1750 int sg_tablesize = sfp->parentdp->sg_tablesize;
1751 int blk_size = buff_size, order;
1752 gfp_t gfp_mask = GFP_ATOMIC | __GFP_COMP | __GFP_NOWARN;
1757 ++blk_size; /* don't know why */
1758 /* round request up to next highest SG_SECTOR_SZ byte boundary */
1759 blk_size = ALIGN(blk_size, SG_SECTOR_SZ);
1760 SCSI_LOG_TIMEOUT(4, printk("sg_build_indirect: buff_size=%d, blk_size=%d\n",
1761 buff_size, blk_size));
1763 /* N.B. ret_sz carried into this block ... */
1764 mx_sc_elems = sg_build_sgat(schp, sfp, sg_tablesize);
1765 if (mx_sc_elems < 0)
1766 return mx_sc_elems; /* most likely -ENOMEM */
1768 num = scatter_elem_sz;
1769 if (unlikely(num != scatter_elem_sz_prev)) {
1770 if (num < PAGE_SIZE) {
1771 scatter_elem_sz = PAGE_SIZE;
1772 scatter_elem_sz_prev = PAGE_SIZE;
1774 scatter_elem_sz_prev = num;
1778 gfp_mask |= GFP_DMA;
1780 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
1781 gfp_mask |= __GFP_ZERO;
1783 order = get_order(num);
1785 ret_sz = 1 << (PAGE_SHIFT + order);
1787 for (k = 0, rem_sz = blk_size; rem_sz > 0 && k < mx_sc_elems;
1788 k++, rem_sz -= ret_sz) {
1790 num = (rem_sz > scatter_elem_sz_prev) ?
1791 scatter_elem_sz_prev : rem_sz;
1793 schp->pages[k] = alloc_pages(gfp_mask, order);
1794 if (!schp->pages[k])
1797 if (num == scatter_elem_sz_prev) {
1798 if (unlikely(ret_sz > scatter_elem_sz_prev)) {
1799 scatter_elem_sz = ret_sz;
1800 scatter_elem_sz_prev = ret_sz;
1804 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k=%d, num=%d, "
1805 "ret_sz=%d\n", k, num, ret_sz));
1806 } /* end of for loop */
1808 schp->page_order = order;
1810 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k_use_sg=%d, "
1811 "rem_sz=%d\n", k, rem_sz));
1813 schp->bufflen = blk_size;
1814 if (rem_sz > 0) /* must have failed */
1818 for (i = 0; i < k; i++)
1819 __free_pages(schp->pages[i], order);
1828 sg_remove_scat(Sg_scatter_hold * schp)
1830 SCSI_LOG_TIMEOUT(4, printk("sg_remove_scat: k_use_sg=%d\n", schp->k_use_sg));
1831 if (schp->pages && schp->sglist_len > 0) {
1832 if (!schp->dio_in_use) {
1835 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
1836 SCSI_LOG_TIMEOUT(5, printk(
1837 "sg_remove_scat: k=%d, pg=0x%p\n",
1838 k, schp->pages[k]));
1839 __free_pages(schp->pages[k], schp->page_order);
1845 memset(schp, 0, sizeof (*schp));
1849 sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer)
1851 Sg_scatter_hold *schp = &srp->data;
1854 SCSI_LOG_TIMEOUT(4, printk("sg_read_oxfer: num_read_xfer=%d\n",
1856 if ((!outp) || (num_read_xfer <= 0))
1859 num = 1 << (PAGE_SHIFT + schp->page_order);
1860 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
1861 if (num > num_read_xfer) {
1862 if (__copy_to_user(outp, page_address(schp->pages[k]),
1867 if (__copy_to_user(outp, page_address(schp->pages[k]),
1870 num_read_xfer -= num;
1871 if (num_read_xfer <= 0)
1881 sg_build_reserve(Sg_fd * sfp, int req_size)
1883 Sg_scatter_hold *schp = &sfp->reserve;
1885 SCSI_LOG_TIMEOUT(4, printk("sg_build_reserve: req_size=%d\n", req_size));
1887 if (req_size < PAGE_SIZE)
1888 req_size = PAGE_SIZE;
1889 if (0 == sg_build_indirect(schp, sfp, req_size))
1892 sg_remove_scat(schp);
1893 req_size >>= 1; /* divide by 2 */
1894 } while (req_size > (PAGE_SIZE / 2));
1898 sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size)
1900 Sg_scatter_hold *req_schp = &srp->data;
1901 Sg_scatter_hold *rsv_schp = &sfp->reserve;
1905 SCSI_LOG_TIMEOUT(4, printk("sg_link_reserve: size=%d\n", size));
1908 num = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1909 for (k = 0; k < rsv_schp->k_use_sg; k++) {
1911 req_schp->k_use_sg = k + 1;
1912 req_schp->sglist_len = rsv_schp->sglist_len;
1913 req_schp->pages = rsv_schp->pages;
1915 req_schp->bufflen = size;
1916 req_schp->page_order = rsv_schp->page_order;
1922 if (k >= rsv_schp->k_use_sg)
1923 SCSI_LOG_TIMEOUT(1, printk("sg_link_reserve: BAD size\n"));
1927 sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp)
1929 Sg_scatter_hold *req_schp = &srp->data;
1931 SCSI_LOG_TIMEOUT(4, printk("sg_unlink_reserve: req->k_use_sg=%d\n",
1932 (int) req_schp->k_use_sg));
1933 req_schp->k_use_sg = 0;
1934 req_schp->bufflen = 0;
1935 req_schp->pages = NULL;
1936 req_schp->page_order = 0;
1937 req_schp->sglist_len = 0;
1938 sfp->save_scat_len = 0;
1943 sg_get_rq_mark(Sg_fd * sfp, int pack_id)
1946 unsigned long iflags;
1948 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1949 for (resp = sfp->headrp; resp; resp = resp->nextrp) {
1950 /* look for requests that are ready + not SG_IO owned */
1951 if ((1 == resp->done) && (!resp->sg_io_owned) &&
1952 ((-1 == pack_id) || (resp->header.pack_id == pack_id))) {
1953 resp->done = 2; /* guard against other readers */
1957 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1961 /* always adds to end of list */
1963 sg_add_request(Sg_fd * sfp)
1966 unsigned long iflags;
1968 Sg_request *rp = sfp->req_arr;
1970 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1973 memset(rp, 0, sizeof (Sg_request));
1978 if (0 == sfp->cmd_q)
1979 resp = NULL; /* command queuing disallowed */
1981 for (k = 0; k < SG_MAX_QUEUE; ++k, ++rp) {
1985 if (k < SG_MAX_QUEUE) {
1986 memset(rp, 0, sizeof (Sg_request));
1988 while (resp->nextrp)
1989 resp = resp->nextrp;
1997 resp->nextrp = NULL;
1998 resp->header.duration = jiffies_to_msecs(jiffies);
2000 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2004 /* Return of 1 for found; 0 for not found */
2006 sg_remove_request(Sg_fd * sfp, Sg_request * srp)
2008 Sg_request *prev_rp;
2010 unsigned long iflags;
2013 if ((!sfp) || (!srp) || (!sfp->headrp))
2015 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2016 prev_rp = sfp->headrp;
2017 if (srp == prev_rp) {
2018 sfp->headrp = prev_rp->nextrp;
2019 prev_rp->parentfp = NULL;
2022 while ((rp = prev_rp->nextrp)) {
2024 prev_rp->nextrp = rp->nextrp;
2025 rp->parentfp = NULL;
2032 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2037 sg_add_sfp(Sg_device * sdp, int dev)
2040 unsigned long iflags;
2043 sfp = kzalloc(sizeof(*sfp), GFP_ATOMIC | __GFP_NOWARN);
2045 return ERR_PTR(-ENOMEM);
2047 init_waitqueue_head(&sfp->read_wait);
2048 rwlock_init(&sfp->rq_list_lock);
2050 kref_init(&sfp->f_ref);
2051 sfp->timeout = SG_DEFAULT_TIMEOUT;
2052 sfp->timeout_user = SG_DEFAULT_TIMEOUT_USER;
2053 sfp->force_packid = SG_DEF_FORCE_PACK_ID;
2054 sfp->low_dma = (SG_DEF_FORCE_LOW_DMA == 0) ?
2055 sdp->device->host->unchecked_isa_dma : 1;
2056 sfp->cmd_q = SG_DEF_COMMAND_Q;
2057 sfp->keep_orphan = SG_DEF_KEEP_ORPHAN;
2058 sfp->parentdp = sdp;
2059 write_lock_irqsave(&sg_index_lock, iflags);
2060 if (sdp->detached) {
2061 write_unlock_irqrestore(&sg_index_lock, iflags);
2062 return ERR_PTR(-ENODEV);
2064 list_add_tail(&sfp->sfd_siblings, &sdp->sfds);
2065 write_unlock_irqrestore(&sg_index_lock, iflags);
2066 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: sfp=0x%p\n", sfp));
2067 if (unlikely(sg_big_buff != def_reserved_size))
2068 sg_big_buff = def_reserved_size;
2070 bufflen = min_t(int, sg_big_buff,
2071 queue_max_sectors(sdp->device->request_queue) * 512);
2072 sg_build_reserve(sfp, bufflen);
2073 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: bufflen=%d, k_use_sg=%d\n",
2074 sfp->reserve.bufflen, sfp->reserve.k_use_sg));
2076 kref_get(&sdp->d_ref);
2077 __module_get(THIS_MODULE);
2081 static void sg_remove_sfp_usercontext(struct work_struct *work)
2083 struct sg_fd *sfp = container_of(work, struct sg_fd, ew.work);
2084 struct sg_device *sdp = sfp->parentdp;
2086 /* Cleanup any responses which were never read(). */
2088 sg_finish_rem_req(sfp->headrp);
2090 if (sfp->reserve.bufflen > 0) {
2092 printk("sg_remove_sfp: bufflen=%d, k_use_sg=%d\n",
2093 (int) sfp->reserve.bufflen,
2094 (int) sfp->reserve.k_use_sg));
2095 sg_remove_scat(&sfp->reserve);
2099 printk("sg_remove_sfp: %s, sfp=0x%p\n",
2100 sdp->disk->disk_name,
2104 scsi_device_put(sdp->device);
2106 module_put(THIS_MODULE);
2109 static void sg_remove_sfp(struct kref *kref)
2111 struct sg_fd *sfp = container_of(kref, struct sg_fd, f_ref);
2112 unsigned long iflags;
2114 write_lock_irqsave(&sg_index_lock, iflags);
2115 list_del(&sfp->sfd_siblings);
2116 write_unlock_irqrestore(&sg_index_lock, iflags);
2118 INIT_WORK(&sfp->ew.work, sg_remove_sfp_usercontext);
2119 schedule_work(&sfp->ew.work);
2123 sg_res_in_use(Sg_fd * sfp)
2125 const Sg_request *srp;
2126 unsigned long iflags;
2128 read_lock_irqsave(&sfp->rq_list_lock, iflags);
2129 for (srp = sfp->headrp; srp; srp = srp->nextrp)
2132 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2136 #ifdef CONFIG_SCSI_PROC_FS
2138 sg_idr_max_id(int id, void *p, void *data)
2152 unsigned long iflags;
2154 read_lock_irqsave(&sg_index_lock, iflags);
2155 idr_for_each(&sg_index_idr, sg_idr_max_id, &k);
2156 read_unlock_irqrestore(&sg_index_lock, iflags);
2157 return k + 1; /* origin 1 */
2161 /* must be called with sg_index_lock held */
2162 static Sg_device *sg_lookup_dev(int dev)
2164 return idr_find(&sg_index_idr, dev);
2167 static Sg_device *sg_get_dev(int dev)
2169 struct sg_device *sdp;
2170 unsigned long flags;
2172 read_lock_irqsave(&sg_index_lock, flags);
2173 sdp = sg_lookup_dev(dev);
2175 sdp = ERR_PTR(-ENXIO);
2176 else if (sdp->detached) {
2177 /* If sdp->detached, then the refcount may already be 0, in
2178 * which case it would be a bug to do kref_get().
2180 sdp = ERR_PTR(-ENODEV);
2182 kref_get(&sdp->d_ref);
2183 read_unlock_irqrestore(&sg_index_lock, flags);
2188 static void sg_put_dev(struct sg_device *sdp)
2190 kref_put(&sdp->d_ref, sg_device_destroy);
2193 #ifdef CONFIG_SCSI_PROC_FS
2195 static struct proc_dir_entry *sg_proc_sgp = NULL;
2197 static char sg_proc_sg_dirname[] = "scsi/sg";
2199 static int sg_proc_seq_show_int(struct seq_file *s, void *v);
2201 static int sg_proc_single_open_adio(struct inode *inode, struct file *file);
2202 static ssize_t sg_proc_write_adio(struct file *filp, const char __user *buffer,
2203 size_t count, loff_t *off);
2204 static const struct file_operations adio_fops = {
2205 .owner = THIS_MODULE,
2206 .open = sg_proc_single_open_adio,
2208 .llseek = seq_lseek,
2209 .write = sg_proc_write_adio,
2210 .release = single_release,
2213 static int sg_proc_single_open_dressz(struct inode *inode, struct file *file);
2214 static ssize_t sg_proc_write_dressz(struct file *filp,
2215 const char __user *buffer, size_t count, loff_t *off);
2216 static const struct file_operations dressz_fops = {
2217 .owner = THIS_MODULE,
2218 .open = sg_proc_single_open_dressz,
2220 .llseek = seq_lseek,
2221 .write = sg_proc_write_dressz,
2222 .release = single_release,
2225 static int sg_proc_seq_show_version(struct seq_file *s, void *v);
2226 static int sg_proc_single_open_version(struct inode *inode, struct file *file);
2227 static const struct file_operations version_fops = {
2228 .owner = THIS_MODULE,
2229 .open = sg_proc_single_open_version,
2231 .llseek = seq_lseek,
2232 .release = single_release,
2235 static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v);
2236 static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file);
2237 static const struct file_operations devhdr_fops = {
2238 .owner = THIS_MODULE,
2239 .open = sg_proc_single_open_devhdr,
2241 .llseek = seq_lseek,
2242 .release = single_release,
2245 static int sg_proc_seq_show_dev(struct seq_file *s, void *v);
2246 static int sg_proc_open_dev(struct inode *inode, struct file *file);
2247 static void * dev_seq_start(struct seq_file *s, loff_t *pos);
2248 static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos);
2249 static void dev_seq_stop(struct seq_file *s, void *v);
2250 static const struct file_operations dev_fops = {
2251 .owner = THIS_MODULE,
2252 .open = sg_proc_open_dev,
2254 .llseek = seq_lseek,
2255 .release = seq_release,
2257 static const struct seq_operations dev_seq_ops = {
2258 .start = dev_seq_start,
2259 .next = dev_seq_next,
2260 .stop = dev_seq_stop,
2261 .show = sg_proc_seq_show_dev,
2264 static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v);
2265 static int sg_proc_open_devstrs(struct inode *inode, struct file *file);
2266 static const struct file_operations devstrs_fops = {
2267 .owner = THIS_MODULE,
2268 .open = sg_proc_open_devstrs,
2270 .llseek = seq_lseek,
2271 .release = seq_release,
2273 static const struct seq_operations devstrs_seq_ops = {
2274 .start = dev_seq_start,
2275 .next = dev_seq_next,
2276 .stop = dev_seq_stop,
2277 .show = sg_proc_seq_show_devstrs,
2280 static int sg_proc_seq_show_debug(struct seq_file *s, void *v);
2281 static int sg_proc_open_debug(struct inode *inode, struct file *file);
2282 static const struct file_operations debug_fops = {
2283 .owner = THIS_MODULE,
2284 .open = sg_proc_open_debug,
2286 .llseek = seq_lseek,
2287 .release = seq_release,
2289 static const struct seq_operations debug_seq_ops = {
2290 .start = dev_seq_start,
2291 .next = dev_seq_next,
2292 .stop = dev_seq_stop,
2293 .show = sg_proc_seq_show_debug,
2297 struct sg_proc_leaf {
2299 const struct file_operations * fops;
2302 static const struct sg_proc_leaf sg_proc_leaf_arr[] = {
2303 {"allow_dio", &adio_fops},
2304 {"debug", &debug_fops},
2305 {"def_reserved_size", &dressz_fops},
2306 {"device_hdr", &devhdr_fops},
2307 {"devices", &dev_fops},
2308 {"device_strs", &devstrs_fops},
2309 {"version", &version_fops}
2315 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
2318 sg_proc_sgp = proc_mkdir(sg_proc_sg_dirname, NULL);
2321 for (k = 0; k < num_leaves; ++k) {
2322 const struct sg_proc_leaf *leaf = &sg_proc_leaf_arr[k];
2323 umode_t mask = leaf->fops->write ? S_IRUGO | S_IWUSR : S_IRUGO;
2324 proc_create(leaf->name, mask, sg_proc_sgp, leaf->fops);
2330 sg_proc_cleanup(void)
2333 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
2337 for (k = 0; k < num_leaves; ++k)
2338 remove_proc_entry(sg_proc_leaf_arr[k].name, sg_proc_sgp);
2339 remove_proc_entry(sg_proc_sg_dirname, NULL);
2343 static int sg_proc_seq_show_int(struct seq_file *s, void *v)
2345 seq_printf(s, "%d\n", *((int *)s->private));
2349 static int sg_proc_single_open_adio(struct inode *inode, struct file *file)
2351 return single_open(file, sg_proc_seq_show_int, &sg_allow_dio);
2355 sg_proc_write_adio(struct file *filp, const char __user *buffer,
2356 size_t count, loff_t *off)
2361 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2363 err = kstrtoul_from_user(buffer, count, 0, &num);
2366 sg_allow_dio = num ? 1 : 0;
2370 static int sg_proc_single_open_dressz(struct inode *inode, struct file *file)
2372 return single_open(file, sg_proc_seq_show_int, &sg_big_buff);
2376 sg_proc_write_dressz(struct file *filp, const char __user *buffer,
2377 size_t count, loff_t *off)
2380 unsigned long k = ULONG_MAX;
2382 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2385 err = kstrtoul_from_user(buffer, count, 0, &k);
2388 if (k <= 1048576) { /* limit "big buff" to 1 MB */
2395 static int sg_proc_seq_show_version(struct seq_file *s, void *v)
2397 seq_printf(s, "%d\t%s [%s]\n", sg_version_num, SG_VERSION_STR,
2402 static int sg_proc_single_open_version(struct inode *inode, struct file *file)
2404 return single_open(file, sg_proc_seq_show_version, NULL);
2407 static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v)
2409 seq_printf(s, "host\tchan\tid\tlun\ttype\topens\tqdepth\tbusy\t"
2414 static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file)
2416 return single_open(file, sg_proc_seq_show_devhdr, NULL);
2419 struct sg_proc_deviter {
2424 static void * dev_seq_start(struct seq_file *s, loff_t *pos)
2426 struct sg_proc_deviter * it = kmalloc(sizeof(*it), GFP_KERNEL);
2433 it->max = sg_last_dev();
2434 if (it->index >= it->max)
2439 static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos)
2441 struct sg_proc_deviter * it = s->private;
2444 return (it->index < it->max) ? it : NULL;
2447 static void dev_seq_stop(struct seq_file *s, void *v)
2452 static int sg_proc_open_dev(struct inode *inode, struct file *file)
2454 return seq_open(file, &dev_seq_ops);
2457 static int sg_proc_seq_show_dev(struct seq_file *s, void *v)
2459 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2461 struct scsi_device *scsidp;
2462 unsigned long iflags;
2464 read_lock_irqsave(&sg_index_lock, iflags);
2465 sdp = it ? sg_lookup_dev(it->index) : NULL;
2466 if (sdp && (scsidp = sdp->device) && (!sdp->detached))
2467 seq_printf(s, "%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\n",
2468 scsidp->host->host_no, scsidp->channel,
2469 scsidp->id, scsidp->lun, (int) scsidp->type,
2471 (int) scsidp->queue_depth,
2472 (int) scsidp->device_busy,
2473 (int) scsi_device_online(scsidp));
2475 seq_printf(s, "-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\n");
2476 read_unlock_irqrestore(&sg_index_lock, iflags);
2480 static int sg_proc_open_devstrs(struct inode *inode, struct file *file)
2482 return seq_open(file, &devstrs_seq_ops);
2485 static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v)
2487 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2489 struct scsi_device *scsidp;
2490 unsigned long iflags;
2492 read_lock_irqsave(&sg_index_lock, iflags);
2493 sdp = it ? sg_lookup_dev(it->index) : NULL;
2494 if (sdp && (scsidp = sdp->device) && (!sdp->detached))
2495 seq_printf(s, "%8.8s\t%16.16s\t%4.4s\n",
2496 scsidp->vendor, scsidp->model, scsidp->rev);
2498 seq_printf(s, "<no active device>\n");
2499 read_unlock_irqrestore(&sg_index_lock, iflags);
2503 /* must be called while holding sg_index_lock */
2504 static void sg_proc_debug_helper(struct seq_file *s, Sg_device * sdp)
2506 int k, m, new_interface, blen, usg;
2509 const sg_io_hdr_t *hp;
2514 list_for_each_entry(fp, &sdp->sfds, sfd_siblings) {
2516 read_lock(&fp->rq_list_lock); /* irqs already disabled */
2517 seq_printf(s, " FD(%d): timeout=%dms bufflen=%d "
2518 "(res)sgat=%d low_dma=%d\n", k,
2519 jiffies_to_msecs(fp->timeout),
2520 fp->reserve.bufflen,
2521 (int) fp->reserve.k_use_sg,
2523 seq_printf(s, " cmd_q=%d f_packid=%d k_orphan=%d closed=0\n",
2524 (int) fp->cmd_q, (int) fp->force_packid,
2525 (int) fp->keep_orphan);
2526 for (m = 0, srp = fp->headrp;
2528 ++m, srp = srp->nextrp) {
2530 new_interface = (hp->interface_id == '\0') ? 0 : 1;
2531 if (srp->res_used) {
2532 if (new_interface &&
2533 (SG_FLAG_MMAP_IO & hp->flags))
2538 if (SG_INFO_DIRECT_IO_MASK & hp->info)
2544 blen = srp->data.bufflen;
2545 usg = srp->data.k_use_sg;
2546 seq_printf(s, srp->done ?
2547 ((1 == srp->done) ? "rcv:" : "fin:")
2549 seq_printf(s, " id=%d blen=%d",
2550 srp->header.pack_id, blen);
2552 seq_printf(s, " dur=%d", hp->duration);
2554 ms = jiffies_to_msecs(jiffies);
2555 seq_printf(s, " t_o/elap=%d/%d",
2556 (new_interface ? hp->timeout :
2557 jiffies_to_msecs(fp->timeout)),
2558 (ms > hp->duration ? ms - hp->duration : 0));
2560 seq_printf(s, "ms sgat=%d op=0x%02x\n", usg,
2561 (int) srp->data.cmd_opcode);
2564 seq_printf(s, " No requests active\n");
2565 read_unlock(&fp->rq_list_lock);
2569 static int sg_proc_open_debug(struct inode *inode, struct file *file)
2571 return seq_open(file, &debug_seq_ops);
2574 static int sg_proc_seq_show_debug(struct seq_file *s, void *v)
2576 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2578 unsigned long iflags;
2580 if (it && (0 == it->index)) {
2581 seq_printf(s, "max_active_device=%d(origin 1)\n",
2583 seq_printf(s, " def_reserved_size=%d\n", sg_big_buff);
2586 read_lock_irqsave(&sg_index_lock, iflags);
2587 sdp = it ? sg_lookup_dev(it->index) : NULL;
2588 if (sdp && !list_empty(&sdp->sfds)) {
2589 struct scsi_device *scsidp = sdp->device;
2591 seq_printf(s, " >>> device=%s ", sdp->disk->disk_name);
2593 seq_printf(s, "detached pending close ");
2596 (s, "scsi%d chan=%d id=%d lun=%d em=%d",
2597 scsidp->host->host_no,
2598 scsidp->channel, scsidp->id,
2600 scsidp->host->hostt->emulated);
2601 seq_printf(s, " sg_tablesize=%d excl=%d\n",
2602 sdp->sg_tablesize, sdp->exclude);
2603 sg_proc_debug_helper(s, sdp);
2605 read_unlock_irqrestore(&sg_index_lock, iflags);
2609 #endif /* CONFIG_SCSI_PROC_FS */
2611 module_init(init_sg);
2612 module_exit(exit_sg);