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 */
302 if (sfds_list_empty(sdp)) { /* no existing opens on this device */
304 q = sdp->device->request_queue;
305 sdp->sg_tablesize = queue_max_segments(q);
307 if ((sfp = sg_add_sfp(sdp, dev)))
308 filp->private_data = sfp;
309 /* retval is already provably zero at this point because of the
310 * check after retval = scsi_autopm_get_device(sdp->device))
315 if (flags & O_EXCL) {
316 sdp->exclude = 0; /* undo if error */
317 up_write(&sdp->o_sem);
319 up_read(&sdp->o_sem);
321 scsi_autopm_put_device(sdp->device);
323 scsi_device_put(sdp->device);
331 /* Following function was formerly called 'sg_close' */
333 sg_release(struct inode *inode, struct file *filp)
339 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
341 SCSI_LOG_TIMEOUT(3, printk("sg_release: %s\n", sdp->disk->disk_name));
346 up_write(&sdp->o_sem);
348 up_read(&sdp->o_sem);
350 scsi_autopm_put_device(sdp->device);
351 kref_put(&sfp->f_ref, sg_remove_sfp);
356 sg_read(struct file *filp, char __user *buf, size_t count, loff_t * ppos)
361 int req_pack_id = -1;
363 struct sg_header *old_hdr = NULL;
366 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
368 SCSI_LOG_TIMEOUT(3, printk("sg_read: %s, count=%d\n",
369 sdp->disk->disk_name, (int) count));
371 if (!access_ok(VERIFY_WRITE, buf, count))
373 if (sfp->force_packid && (count >= SZ_SG_HEADER)) {
374 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
377 if (__copy_from_user(old_hdr, buf, SZ_SG_HEADER)) {
381 if (old_hdr->reply_len < 0) {
382 if (count >= SZ_SG_IO_HDR) {
383 sg_io_hdr_t *new_hdr;
384 new_hdr = kmalloc(SZ_SG_IO_HDR, GFP_KERNEL);
389 retval =__copy_from_user
390 (new_hdr, buf, SZ_SG_IO_HDR);
391 req_pack_id = new_hdr->pack_id;
399 req_pack_id = old_hdr->pack_id;
401 srp = sg_get_rq_mark(sfp, req_pack_id);
402 if (!srp) { /* now wait on packet to arrive */
407 if (filp->f_flags & O_NONBLOCK) {
411 retval = wait_event_interruptible(sfp->read_wait,
413 (srp = sg_get_rq_mark(sfp, req_pack_id))));
419 /* -ERESTARTSYS as signal hit process */
423 if (srp->header.interface_id != '\0') {
424 retval = sg_new_read(sfp, buf, count, srp);
429 if (old_hdr == NULL) {
430 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
436 memset(old_hdr, 0, SZ_SG_HEADER);
437 old_hdr->reply_len = (int) hp->timeout;
438 old_hdr->pack_len = old_hdr->reply_len; /* old, strange behaviour */
439 old_hdr->pack_id = hp->pack_id;
440 old_hdr->twelve_byte =
441 ((srp->data.cmd_opcode >= 0xc0) && (12 == hp->cmd_len)) ? 1 : 0;
442 old_hdr->target_status = hp->masked_status;
443 old_hdr->host_status = hp->host_status;
444 old_hdr->driver_status = hp->driver_status;
445 if ((CHECK_CONDITION & hp->masked_status) ||
446 (DRIVER_SENSE & hp->driver_status))
447 memcpy(old_hdr->sense_buffer, srp->sense_b,
448 sizeof (old_hdr->sense_buffer));
449 switch (hp->host_status) {
450 /* This setup of 'result' is for backward compatibility and is best
451 ignored by the user who should use target, host + driver status */
453 case DID_PASSTHROUGH:
460 old_hdr->result = EBUSY;
467 old_hdr->result = EIO;
470 old_hdr->result = (srp->sense_b[0] == 0 &&
471 hp->masked_status == GOOD) ? 0 : EIO;
474 old_hdr->result = EIO;
478 /* Now copy the result back to the user buffer. */
479 if (count >= SZ_SG_HEADER) {
480 if (__copy_to_user(buf, old_hdr, SZ_SG_HEADER)) {
485 if (count > old_hdr->reply_len)
486 count = old_hdr->reply_len;
487 if (count > SZ_SG_HEADER) {
488 if (sg_read_oxfer(srp, buf, count - SZ_SG_HEADER)) {
494 count = (old_hdr->result == 0) ? 0 : -EIO;
495 sg_finish_rem_req(srp);
503 sg_new_read(Sg_fd * sfp, char __user *buf, size_t count, Sg_request * srp)
505 sg_io_hdr_t *hp = &srp->header;
509 if (count < SZ_SG_IO_HDR) {
514 if ((hp->mx_sb_len > 0) && hp->sbp) {
515 if ((CHECK_CONDITION & hp->masked_status) ||
516 (DRIVER_SENSE & hp->driver_status)) {
517 int sb_len = SCSI_SENSE_BUFFERSIZE;
518 sb_len = (hp->mx_sb_len > sb_len) ? sb_len : hp->mx_sb_len;
519 len = 8 + (int) srp->sense_b[7]; /* Additional sense length field */
520 len = (len > sb_len) ? sb_len : len;
521 if (copy_to_user(hp->sbp, srp->sense_b, len)) {
528 if (hp->masked_status || hp->host_status || hp->driver_status)
529 hp->info |= SG_INFO_CHECK;
530 if (copy_to_user(buf, hp, SZ_SG_IO_HDR)) {
535 err = sg_finish_rem_req(srp);
536 return (0 == err) ? count : err;
540 sg_write(struct file *filp, const char __user *buf, size_t count, loff_t * ppos)
542 int mxsize, cmd_size, k;
543 int input_size, blocking;
544 unsigned char opcode;
548 struct sg_header old_hdr;
550 unsigned char cmnd[MAX_COMMAND_SIZE];
552 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
554 SCSI_LOG_TIMEOUT(3, printk("sg_write: %s, count=%d\n",
555 sdp->disk->disk_name, (int) count));
558 if (!((filp->f_flags & O_NONBLOCK) ||
559 scsi_block_when_processing_errors(sdp->device)))
562 if (!access_ok(VERIFY_READ, buf, count))
563 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
564 if (count < SZ_SG_HEADER)
566 if (__copy_from_user(&old_hdr, buf, SZ_SG_HEADER))
568 blocking = !(filp->f_flags & O_NONBLOCK);
569 if (old_hdr.reply_len < 0)
570 return sg_new_write(sfp, filp, buf, count,
571 blocking, 0, 0, NULL);
572 if (count < (SZ_SG_HEADER + 6))
573 return -EIO; /* The minimum scsi command length is 6 bytes. */
575 if (!(srp = sg_add_request(sfp))) {
576 SCSI_LOG_TIMEOUT(1, printk("sg_write: queue full\n"));
580 __get_user(opcode, buf);
581 if (sfp->next_cmd_len > 0) {
582 if (sfp->next_cmd_len > MAX_COMMAND_SIZE) {
583 SCSI_LOG_TIMEOUT(1, printk("sg_write: command length too long\n"));
584 sfp->next_cmd_len = 0;
585 sg_remove_request(sfp, srp);
588 cmd_size = sfp->next_cmd_len;
589 sfp->next_cmd_len = 0; /* reset so only this write() effected */
591 cmd_size = COMMAND_SIZE(opcode); /* based on SCSI command group */
592 if ((opcode >= 0xc0) && old_hdr.twelve_byte)
595 SCSI_LOG_TIMEOUT(4, printk(
596 "sg_write: scsi opcode=0x%02x, cmd_size=%d\n", (int) opcode, cmd_size));
597 /* Determine buffer size. */
598 input_size = count - cmd_size;
599 mxsize = (input_size > old_hdr.reply_len) ? input_size : old_hdr.reply_len;
600 mxsize -= SZ_SG_HEADER;
601 input_size -= SZ_SG_HEADER;
602 if (input_size < 0) {
603 sg_remove_request(sfp, srp);
604 return -EIO; /* User did not pass enough bytes for this command. */
607 hp->interface_id = '\0'; /* indicator of old interface tunnelled */
608 hp->cmd_len = (unsigned char) cmd_size;
612 hp->dxfer_direction = (old_hdr.reply_len > SZ_SG_HEADER) ?
613 SG_DXFER_TO_FROM_DEV : SG_DXFER_TO_DEV;
615 hp->dxfer_direction = (mxsize > 0) ? SG_DXFER_FROM_DEV : SG_DXFER_NONE;
616 hp->dxfer_len = mxsize;
617 if (hp->dxfer_direction == SG_DXFER_TO_DEV)
618 hp->dxferp = (char __user *)buf + cmd_size;
622 hp->timeout = old_hdr.reply_len; /* structure abuse ... */
623 hp->flags = input_size; /* structure abuse ... */
624 hp->pack_id = old_hdr.pack_id;
626 if (__copy_from_user(cmnd, buf, cmd_size))
629 * SG_DXFER_TO_FROM_DEV is functionally equivalent to SG_DXFER_FROM_DEV,
630 * but is is possible that the app intended SG_DXFER_TO_DEV, because there
631 * is a non-zero input_size, so emit a warning.
633 if (hp->dxfer_direction == SG_DXFER_TO_FROM_DEV) {
634 static char cmd[TASK_COMM_LEN];
635 if (strcmp(current->comm, cmd)) {
636 printk_ratelimited(KERN_WARNING
637 "sg_write: data in/out %d/%d bytes "
638 "for SCSI command 0x%x-- guessing "
639 "data in;\n program %s not setting "
640 "count and/or reply_len properly\n",
641 old_hdr.reply_len - (int)SZ_SG_HEADER,
642 input_size, (unsigned int) cmnd[0],
644 strcpy(cmd, current->comm);
647 k = sg_common_write(sfp, srp, cmnd, sfp->timeout, blocking);
648 return (k < 0) ? k : count;
652 sg_new_write(Sg_fd *sfp, struct file *file, const char __user *buf,
653 size_t count, int blocking, int read_only, int sg_io_owned,
659 unsigned char cmnd[MAX_COMMAND_SIZE];
661 unsigned long ul_timeout;
663 if (count < SZ_SG_IO_HDR)
665 if (!access_ok(VERIFY_READ, buf, count))
666 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
668 sfp->cmd_q = 1; /* when sg_io_hdr seen, set command queuing on */
669 if (!(srp = sg_add_request(sfp))) {
670 SCSI_LOG_TIMEOUT(1, printk("sg_new_write: queue full\n"));
673 srp->sg_io_owned = sg_io_owned;
675 if (__copy_from_user(hp, buf, SZ_SG_IO_HDR)) {
676 sg_remove_request(sfp, srp);
679 if (hp->interface_id != 'S') {
680 sg_remove_request(sfp, srp);
683 if (hp->flags & SG_FLAG_MMAP_IO) {
684 if (hp->dxfer_len > sfp->reserve.bufflen) {
685 sg_remove_request(sfp, srp);
686 return -ENOMEM; /* MMAP_IO size must fit in reserve buffer */
688 if (hp->flags & SG_FLAG_DIRECT_IO) {
689 sg_remove_request(sfp, srp);
690 return -EINVAL; /* either MMAP_IO or DIRECT_IO (not both) */
692 if (sg_res_in_use(sfp)) {
693 sg_remove_request(sfp, srp);
694 return -EBUSY; /* reserve buffer already being used */
697 ul_timeout = msecs_to_jiffies(srp->header.timeout);
698 timeout = (ul_timeout < INT_MAX) ? ul_timeout : INT_MAX;
699 if ((!hp->cmdp) || (hp->cmd_len < 6) || (hp->cmd_len > sizeof (cmnd))) {
700 sg_remove_request(sfp, srp);
703 if (!access_ok(VERIFY_READ, hp->cmdp, hp->cmd_len)) {
704 sg_remove_request(sfp, srp);
705 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
707 if (__copy_from_user(cmnd, hp->cmdp, hp->cmd_len)) {
708 sg_remove_request(sfp, srp);
711 if (read_only && sg_allow_access(file, cmnd)) {
712 sg_remove_request(sfp, srp);
715 k = sg_common_write(sfp, srp, cmnd, timeout, blocking);
724 sg_common_write(Sg_fd * sfp, Sg_request * srp,
725 unsigned char *cmnd, int timeout, int blocking)
728 Sg_device *sdp = sfp->parentdp;
729 sg_io_hdr_t *hp = &srp->header;
731 srp->data.cmd_opcode = cmnd[0]; /* hold opcode of command */
733 hp->masked_status = 0;
737 hp->driver_status = 0;
739 SCSI_LOG_TIMEOUT(4, printk("sg_common_write: scsi opcode=0x%02x, cmd_size=%d\n",
740 (int) cmnd[0], (int) hp->cmd_len));
742 k = sg_start_req(srp, cmnd);
744 SCSI_LOG_TIMEOUT(1, printk("sg_common_write: start_req err=%d\n", k));
745 sg_finish_rem_req(srp);
746 return k; /* probably out of space --> ENOMEM */
750 blk_end_request_all(srp->rq, -EIO);
751 sg_finish_rem_req(srp);
755 switch (hp->dxfer_direction) {
756 case SG_DXFER_TO_FROM_DEV:
757 case SG_DXFER_FROM_DEV:
758 data_dir = DMA_FROM_DEVICE;
760 case SG_DXFER_TO_DEV:
761 data_dir = DMA_TO_DEVICE;
763 case SG_DXFER_UNKNOWN:
764 data_dir = DMA_BIDIRECTIONAL;
770 hp->duration = jiffies_to_msecs(jiffies);
772 srp->rq->timeout = timeout;
773 kref_get(&sfp->f_ref); /* sg_rq_end_io() does kref_put(). */
774 blk_execute_rq_nowait(sdp->device->request_queue, sdp->disk,
775 srp->rq, 1, sg_rq_end_io);
779 static int srp_done(Sg_fd *sfp, Sg_request *srp)
784 read_lock_irqsave(&sfp->rq_list_lock, flags);
786 read_unlock_irqrestore(&sfp->rq_list_lock, flags);
791 sg_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
793 void __user *p = (void __user *)arg;
795 int result, val, read_only;
799 unsigned long iflags;
801 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
804 SCSI_LOG_TIMEOUT(3, printk("sg_ioctl: %s, cmd=0x%x\n",
805 sdp->disk->disk_name, (int) cmd_in));
806 read_only = (O_RDWR != (filp->f_flags & O_ACCMODE));
812 if (!scsi_block_when_processing_errors(sdp->device))
814 if (!access_ok(VERIFY_WRITE, p, SZ_SG_IO_HDR))
816 result = sg_new_write(sfp, filp, p, SZ_SG_IO_HDR,
817 1, read_only, 1, &srp);
820 result = wait_event_interruptible(sfp->read_wait,
821 (srp_done(sfp, srp) || sdp->detached));
824 write_lock_irq(&sfp->rq_list_lock);
827 write_unlock_irq(&sfp->rq_list_lock);
828 result = sg_new_read(sfp, p, SZ_SG_IO_HDR, srp);
829 return (result < 0) ? result : 0;
832 write_unlock_irq(&sfp->rq_list_lock);
833 return result; /* -ERESTARTSYS because signal hit process */
835 result = get_user(val, ip);
840 if (val >= MULDIV (INT_MAX, USER_HZ, HZ))
841 val = MULDIV (INT_MAX, USER_HZ, HZ);
842 sfp->timeout_user = val;
843 sfp->timeout = MULDIV (val, HZ, USER_HZ);
846 case SG_GET_TIMEOUT: /* N.B. User receives timeout as return value */
847 /* strange ..., for backward compatibility */
848 return sfp->timeout_user;
849 case SG_SET_FORCE_LOW_DMA:
850 result = get_user(val, ip);
855 if ((0 == sfp->low_dma) && (0 == sg_res_in_use(sfp))) {
856 val = (int) sfp->reserve.bufflen;
857 sg_remove_scat(&sfp->reserve);
858 sg_build_reserve(sfp, val);
863 sfp->low_dma = sdp->device->host->unchecked_isa_dma;
867 return put_user((int) sfp->low_dma, ip);
869 if (!access_ok(VERIFY_WRITE, p, sizeof (sg_scsi_id_t)))
872 sg_scsi_id_t __user *sg_idp = p;
876 __put_user((int) sdp->device->host->host_no,
878 __put_user((int) sdp->device->channel,
880 __put_user((int) sdp->device->id, &sg_idp->scsi_id);
881 __put_user((int) sdp->device->lun, &sg_idp->lun);
882 __put_user((int) sdp->device->type, &sg_idp->scsi_type);
883 __put_user((short) sdp->device->host->cmd_per_lun,
884 &sg_idp->h_cmd_per_lun);
885 __put_user((short) sdp->device->queue_depth,
886 &sg_idp->d_queue_depth);
887 __put_user(0, &sg_idp->unused[0]);
888 __put_user(0, &sg_idp->unused[1]);
891 case SG_SET_FORCE_PACK_ID:
892 result = get_user(val, ip);
895 sfp->force_packid = val ? 1 : 0;
898 if (!access_ok(VERIFY_WRITE, ip, sizeof (int)))
900 read_lock_irqsave(&sfp->rq_list_lock, iflags);
901 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
902 if ((1 == srp->done) && (!srp->sg_io_owned)) {
903 read_unlock_irqrestore(&sfp->rq_list_lock,
905 __put_user(srp->header.pack_id, ip);
909 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
912 case SG_GET_NUM_WAITING:
913 read_lock_irqsave(&sfp->rq_list_lock, iflags);
914 for (val = 0, srp = sfp->headrp; srp; srp = srp->nextrp) {
915 if ((1 == srp->done) && (!srp->sg_io_owned))
918 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
919 return put_user(val, ip);
920 case SG_GET_SG_TABLESIZE:
921 return put_user(sdp->sg_tablesize, ip);
922 case SG_SET_RESERVED_SIZE:
923 result = get_user(val, ip);
928 val = min_t(int, val,
929 queue_max_sectors(sdp->device->request_queue) * 512);
930 if (val != sfp->reserve.bufflen) {
931 if (sg_res_in_use(sfp) || sfp->mmap_called)
933 sg_remove_scat(&sfp->reserve);
934 sg_build_reserve(sfp, val);
937 case SG_GET_RESERVED_SIZE:
938 val = min_t(int, sfp->reserve.bufflen,
939 queue_max_sectors(sdp->device->request_queue) * 512);
940 return put_user(val, ip);
941 case SG_SET_COMMAND_Q:
942 result = get_user(val, ip);
945 sfp->cmd_q = val ? 1 : 0;
947 case SG_GET_COMMAND_Q:
948 return put_user((int) sfp->cmd_q, ip);
949 case SG_SET_KEEP_ORPHAN:
950 result = get_user(val, ip);
953 sfp->keep_orphan = val;
955 case SG_GET_KEEP_ORPHAN:
956 return put_user((int) sfp->keep_orphan, ip);
957 case SG_NEXT_CMD_LEN:
958 result = get_user(val, ip);
961 sfp->next_cmd_len = (val > 0) ? val : 0;
963 case SG_GET_VERSION_NUM:
964 return put_user(sg_version_num, ip);
965 case SG_GET_ACCESS_COUNT:
966 /* faked - we don't have a real access count anymore */
967 val = (sdp->device ? 1 : 0);
968 return put_user(val, ip);
969 case SG_GET_REQUEST_TABLE:
970 if (!access_ok(VERIFY_WRITE, p, SZ_SG_REQ_INFO * SG_MAX_QUEUE))
973 sg_req_info_t *rinfo;
976 rinfo = kmalloc(SZ_SG_REQ_INFO * SG_MAX_QUEUE,
980 read_lock_irqsave(&sfp->rq_list_lock, iflags);
981 for (srp = sfp->headrp, val = 0; val < SG_MAX_QUEUE;
982 ++val, srp = srp ? srp->nextrp : srp) {
983 memset(&rinfo[val], 0, SZ_SG_REQ_INFO);
985 rinfo[val].req_state = srp->done + 1;
987 srp->header.masked_status &
988 srp->header.host_status &
989 srp->header.driver_status;
991 rinfo[val].duration =
992 srp->header.duration;
994 ms = jiffies_to_msecs(jiffies);
995 rinfo[val].duration =
996 (ms > srp->header.duration) ?
997 (ms - srp->header.duration) : 0;
999 rinfo[val].orphan = srp->orphan;
1000 rinfo[val].sg_io_owned =
1002 rinfo[val].pack_id =
1003 srp->header.pack_id;
1004 rinfo[val].usr_ptr =
1005 srp->header.usr_ptr;
1008 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1009 result = __copy_to_user(p, rinfo,
1010 SZ_SG_REQ_INFO * SG_MAX_QUEUE);
1011 result = result ? -EFAULT : 0;
1015 case SG_EMULATED_HOST:
1018 return put_user(sdp->device->host->hostt->emulated, ip);
1022 if (filp->f_flags & O_NONBLOCK) {
1023 if (scsi_host_in_recovery(sdp->device->host))
1025 } else if (!scsi_block_when_processing_errors(sdp->device))
1027 result = get_user(val, ip);
1030 if (SG_SCSI_RESET_NOTHING == val)
1033 case SG_SCSI_RESET_DEVICE:
1034 val = SCSI_TRY_RESET_DEVICE;
1036 case SG_SCSI_RESET_TARGET:
1037 val = SCSI_TRY_RESET_TARGET;
1039 case SG_SCSI_RESET_BUS:
1040 val = SCSI_TRY_RESET_BUS;
1042 case SG_SCSI_RESET_HOST:
1043 val = SCSI_TRY_RESET_HOST;
1048 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
1050 return (scsi_reset_provider(sdp->device, val) ==
1051 SUCCESS) ? 0 : -EIO;
1052 case SCSI_IOCTL_SEND_COMMAND:
1056 unsigned char opcode = WRITE_6;
1057 Scsi_Ioctl_Command __user *siocp = p;
1059 if (copy_from_user(&opcode, siocp->data, 1))
1061 if (sg_allow_access(filp, &opcode))
1064 return sg_scsi_ioctl(sdp->device->request_queue, NULL, filp->f_mode, p);
1066 result = get_user(val, ip);
1069 sdp->sgdebug = (char) val;
1071 case SCSI_IOCTL_GET_IDLUN:
1072 case SCSI_IOCTL_GET_BUS_NUMBER:
1073 case SCSI_IOCTL_PROBE_HOST:
1074 case SG_GET_TRANSFORM:
1077 return scsi_ioctl(sdp->device, cmd_in, p);
1079 return put_user(queue_max_sectors(sdp->device->request_queue) * 512,
1082 return blk_trace_setup(sdp->device->request_queue,
1083 sdp->disk->disk_name,
1084 MKDEV(SCSI_GENERIC_MAJOR, sdp->index),
1088 return blk_trace_startstop(sdp->device->request_queue, 1);
1090 return blk_trace_startstop(sdp->device->request_queue, 0);
1091 case BLKTRACETEARDOWN:
1092 return blk_trace_remove(sdp->device->request_queue);
1095 return -EPERM; /* don't know so take safe approach */
1096 return scsi_ioctl(sdp->device, cmd_in, p);
1100 #ifdef CONFIG_COMPAT
1101 static long sg_compat_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
1105 struct scsi_device *sdev;
1107 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1111 if (sdev->host->hostt->compat_ioctl) {
1114 ret = sdev->host->hostt->compat_ioctl(sdev, cmd_in, (void __user *)arg);
1119 return -ENOIOCTLCMD;
1124 sg_poll(struct file *filp, poll_table * wait)
1126 unsigned int res = 0;
1131 unsigned long iflags;
1133 sfp = filp->private_data;
1136 sdp = sfp->parentdp;
1139 poll_wait(filp, &sfp->read_wait, wait);
1140 read_lock_irqsave(&sfp->rq_list_lock, iflags);
1141 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
1142 /* if any read waiting, flag it */
1143 if ((0 == res) && (1 == srp->done) && (!srp->sg_io_owned))
1144 res = POLLIN | POLLRDNORM;
1147 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1151 else if (!sfp->cmd_q) {
1153 res |= POLLOUT | POLLWRNORM;
1154 } else if (count < SG_MAX_QUEUE)
1155 res |= POLLOUT | POLLWRNORM;
1156 SCSI_LOG_TIMEOUT(3, printk("sg_poll: %s, res=0x%x\n",
1157 sdp->disk->disk_name, (int) res));
1162 sg_fasync(int fd, struct file *filp, int mode)
1167 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1169 SCSI_LOG_TIMEOUT(3, printk("sg_fasync: %s, mode=%d\n",
1170 sdp->disk->disk_name, mode));
1172 return fasync_helper(fd, filp, mode, &sfp->async_qp);
1176 sg_vma_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
1179 unsigned long offset, len, sa;
1180 Sg_scatter_hold *rsv_schp;
1183 if ((NULL == vma) || (!(sfp = (Sg_fd *) vma->vm_private_data)))
1184 return VM_FAULT_SIGBUS;
1185 rsv_schp = &sfp->reserve;
1186 offset = vmf->pgoff << PAGE_SHIFT;
1187 if (offset >= rsv_schp->bufflen)
1188 return VM_FAULT_SIGBUS;
1189 SCSI_LOG_TIMEOUT(3, printk("sg_vma_fault: offset=%lu, scatg=%d\n",
1190 offset, rsv_schp->k_use_sg));
1192 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1193 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
1194 len = vma->vm_end - sa;
1195 len = (len < length) ? len : length;
1197 struct page *page = nth_page(rsv_schp->pages[k],
1198 offset >> PAGE_SHIFT);
1199 get_page(page); /* increment page count */
1201 return 0; /* success */
1207 return VM_FAULT_SIGBUS;
1210 static const struct vm_operations_struct sg_mmap_vm_ops = {
1211 .fault = sg_vma_fault,
1215 sg_mmap(struct file *filp, struct vm_area_struct *vma)
1218 unsigned long req_sz, len, sa;
1219 Sg_scatter_hold *rsv_schp;
1222 if ((!filp) || (!vma) || (!(sfp = (Sg_fd *) filp->private_data)))
1224 req_sz = vma->vm_end - vma->vm_start;
1225 SCSI_LOG_TIMEOUT(3, printk("sg_mmap starting, vm_start=%p, len=%d\n",
1226 (void *) vma->vm_start, (int) req_sz));
1228 return -EINVAL; /* want no offset */
1229 rsv_schp = &sfp->reserve;
1230 if (req_sz > rsv_schp->bufflen)
1231 return -ENOMEM; /* cannot map more than reserved buffer */
1234 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1235 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
1236 len = vma->vm_end - sa;
1237 len = (len < length) ? len : length;
1241 sfp->mmap_called = 1;
1242 vma->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
1243 vma->vm_private_data = sfp;
1244 vma->vm_ops = &sg_mmap_vm_ops;
1248 static void sg_rq_end_io_usercontext(struct work_struct *work)
1250 struct sg_request *srp = container_of(work, struct sg_request, ew.work);
1251 struct sg_fd *sfp = srp->parentfp;
1253 sg_finish_rem_req(srp);
1254 kref_put(&sfp->f_ref, sg_remove_sfp);
1258 * This function is a "bottom half" handler that is called by the mid
1259 * level when a command is completed (or has failed).
1261 static void sg_rq_end_io(struct request *rq, int uptodate)
1263 struct sg_request *srp = rq->end_io_data;
1266 unsigned long iflags;
1269 int result, resid, done = 1;
1271 if (WARN_ON(srp->done != 0))
1274 sfp = srp->parentfp;
1275 if (WARN_ON(sfp == NULL))
1278 sdp = sfp->parentdp;
1279 if (unlikely(sdp->detached))
1280 printk(KERN_INFO "sg_rq_end_io: device detached\n");
1283 result = rq->errors;
1284 resid = rq->resid_len;
1286 SCSI_LOG_TIMEOUT(4, printk("sg_cmd_done: %s, pack_id=%d, res=0x%x\n",
1287 sdp->disk->disk_name, srp->header.pack_id, result));
1288 srp->header.resid = resid;
1289 ms = jiffies_to_msecs(jiffies);
1290 srp->header.duration = (ms > srp->header.duration) ?
1291 (ms - srp->header.duration) : 0;
1293 struct scsi_sense_hdr sshdr;
1295 srp->header.status = 0xff & result;
1296 srp->header.masked_status = status_byte(result);
1297 srp->header.msg_status = msg_byte(result);
1298 srp->header.host_status = host_byte(result);
1299 srp->header.driver_status = driver_byte(result);
1300 if ((sdp->sgdebug > 0) &&
1301 ((CHECK_CONDITION == srp->header.masked_status) ||
1302 (COMMAND_TERMINATED == srp->header.masked_status)))
1303 __scsi_print_sense("sg_cmd_done", sense,
1304 SCSI_SENSE_BUFFERSIZE);
1306 /* Following if statement is a patch supplied by Eric Youngdale */
1307 if (driver_byte(result) != 0
1308 && scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, &sshdr)
1309 && !scsi_sense_is_deferred(&sshdr)
1310 && sshdr.sense_key == UNIT_ATTENTION
1311 && sdp->device->removable) {
1312 /* Detected possible disc change. Set the bit - this */
1313 /* may be used if there are filesystems using this device */
1314 sdp->device->changed = 1;
1317 /* Rely on write phase to clean out srp status values, so no "else" */
1319 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1320 if (unlikely(srp->orphan)) {
1321 if (sfp->keep_orphan)
1322 srp->sg_io_owned = 0;
1327 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1330 /* Now wake up any sg_read() that is waiting for this
1333 wake_up_interruptible(&sfp->read_wait);
1334 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_IN);
1335 kref_put(&sfp->f_ref, sg_remove_sfp);
1337 INIT_WORK(&srp->ew.work, sg_rq_end_io_usercontext);
1338 schedule_work(&srp->ew.work);
1342 static const struct file_operations sg_fops = {
1343 .owner = THIS_MODULE,
1347 .unlocked_ioctl = sg_ioctl,
1348 #ifdef CONFIG_COMPAT
1349 .compat_ioctl = sg_compat_ioctl,
1353 .release = sg_release,
1354 .fasync = sg_fasync,
1355 .llseek = no_llseek,
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 idr_preload(GFP_KERNEL);
1377 write_lock_irqsave(&sg_index_lock, iflags);
1379 error = idr_alloc(&sg_index_idr, sdp, 0, SG_MAX_DEVS, GFP_NOWAIT);
1381 if (error == -ENOSPC) {
1382 sdev_printk(KERN_WARNING, scsidp,
1383 "Unable to attach sg device type=%d, minor number exceeds %d\n",
1384 scsidp->type, SG_MAX_DEVS - 1);
1388 "idr allocation Sg_device failure: %d\n", error);
1394 SCSI_LOG_TIMEOUT(3, printk("sg_alloc: dev=%d \n", k));
1395 sprintf(disk->disk_name, "sg%d", k);
1396 disk->first_minor = k;
1398 sdp->device = scsidp;
1399 INIT_LIST_HEAD(&sdp->sfds);
1400 init_rwsem(&sdp->o_sem);
1401 sdp->sg_tablesize = queue_max_segments(q);
1403 kref_init(&sdp->d_ref);
1407 write_unlock_irqrestore(&sg_index_lock, iflags);
1412 return ERR_PTR(error);
1418 sg_add(struct device *cl_dev, struct class_interface *cl_intf)
1420 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
1421 struct gendisk *disk;
1422 Sg_device *sdp = NULL;
1423 struct cdev * cdev = NULL;
1425 unsigned long iflags;
1427 disk = alloc_disk(1);
1429 printk(KERN_WARNING "alloc_disk failed\n");
1432 disk->major = SCSI_GENERIC_MAJOR;
1435 cdev = cdev_alloc();
1437 printk(KERN_WARNING "cdev_alloc failed\n");
1440 cdev->owner = THIS_MODULE;
1441 cdev->ops = &sg_fops;
1443 sdp = sg_alloc(disk, scsidp);
1445 printk(KERN_WARNING "sg_alloc failed\n");
1446 error = PTR_ERR(sdp);
1450 error = cdev_add(cdev, MKDEV(SCSI_GENERIC_MAJOR, sdp->index), 1);
1455 if (sg_sysfs_valid) {
1456 struct device *sg_class_member;
1458 sg_class_member = device_create(sg_sysfs_class, cl_dev->parent,
1459 MKDEV(SCSI_GENERIC_MAJOR,
1461 sdp, "%s", disk->disk_name);
1462 if (IS_ERR(sg_class_member)) {
1463 printk(KERN_ERR "sg_add: "
1464 "device_create failed\n");
1465 error = PTR_ERR(sg_class_member);
1468 error = sysfs_create_link(&scsidp->sdev_gendev.kobj,
1469 &sg_class_member->kobj, "generic");
1471 printk(KERN_ERR "sg_add: unable to make symlink "
1472 "'generic' back to sg%d\n", sdp->index);
1474 printk(KERN_WARNING "sg_add: sg_sys Invalid\n");
1476 sdev_printk(KERN_NOTICE, scsidp,
1477 "Attached scsi generic sg%d type %d\n", sdp->index,
1480 dev_set_drvdata(cl_dev, sdp);
1485 write_lock_irqsave(&sg_index_lock, iflags);
1486 idr_remove(&sg_index_idr, sdp->index);
1487 write_unlock_irqrestore(&sg_index_lock, iflags);
1497 static void sg_device_destroy(struct kref *kref)
1499 struct sg_device *sdp = container_of(kref, struct sg_device, d_ref);
1500 unsigned long flags;
1502 /* CAUTION! Note that the device can still be found via idr_find()
1503 * even though the refcount is 0. Therefore, do idr_remove() BEFORE
1504 * any other cleanup.
1507 write_lock_irqsave(&sg_index_lock, flags);
1508 idr_remove(&sg_index_idr, sdp->index);
1509 write_unlock_irqrestore(&sg_index_lock, flags);
1512 printk("sg_device_destroy: %s\n",
1513 sdp->disk->disk_name));
1515 put_disk(sdp->disk);
1519 static void sg_remove(struct device *cl_dev, struct class_interface *cl_intf)
1521 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
1522 Sg_device *sdp = dev_get_drvdata(cl_dev);
1523 unsigned long iflags;
1526 if (!sdp || sdp->detached)
1529 SCSI_LOG_TIMEOUT(3, printk("sg_remove: %s\n", sdp->disk->disk_name));
1531 /* Need a write lock to set sdp->detached. */
1532 write_lock_irqsave(&sg_index_lock, iflags);
1534 list_for_each_entry(sfp, &sdp->sfds, sfd_siblings) {
1535 wake_up_interruptible(&sfp->read_wait);
1536 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_HUP);
1538 write_unlock_irqrestore(&sg_index_lock, iflags);
1540 sysfs_remove_link(&scsidp->sdev_gendev.kobj, "generic");
1541 device_destroy(sg_sysfs_class, MKDEV(SCSI_GENERIC_MAJOR, sdp->index));
1542 cdev_del(sdp->cdev);
1548 module_param_named(scatter_elem_sz, scatter_elem_sz, int, S_IRUGO | S_IWUSR);
1549 module_param_named(def_reserved_size, def_reserved_size, int,
1551 module_param_named(allow_dio, sg_allow_dio, int, S_IRUGO | S_IWUSR);
1553 MODULE_AUTHOR("Douglas Gilbert");
1554 MODULE_DESCRIPTION("SCSI generic (sg) driver");
1555 MODULE_LICENSE("GPL");
1556 MODULE_VERSION(SG_VERSION_STR);
1557 MODULE_ALIAS_CHARDEV_MAJOR(SCSI_GENERIC_MAJOR);
1559 MODULE_PARM_DESC(scatter_elem_sz, "scatter gather element "
1560 "size (default: max(SG_SCATTER_SZ, PAGE_SIZE))");
1561 MODULE_PARM_DESC(def_reserved_size, "size of buffer reserved for each fd");
1562 MODULE_PARM_DESC(allow_dio, "allow direct I/O (default: 0 (disallow))");
1569 if (scatter_elem_sz < PAGE_SIZE) {
1570 scatter_elem_sz = PAGE_SIZE;
1571 scatter_elem_sz_prev = scatter_elem_sz;
1573 if (def_reserved_size >= 0)
1574 sg_big_buff = def_reserved_size;
1576 def_reserved_size = sg_big_buff;
1578 rc = register_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1582 sg_sysfs_class = class_create(THIS_MODULE, "scsi_generic");
1583 if ( IS_ERR(sg_sysfs_class) ) {
1584 rc = PTR_ERR(sg_sysfs_class);
1588 rc = scsi_register_interface(&sg_interface);
1590 #ifdef CONFIG_SCSI_PROC_FS
1592 #endif /* CONFIG_SCSI_PROC_FS */
1595 class_destroy(sg_sysfs_class);
1597 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0), SG_MAX_DEVS);
1604 #ifdef CONFIG_SCSI_PROC_FS
1606 #endif /* CONFIG_SCSI_PROC_FS */
1607 scsi_unregister_interface(&sg_interface);
1608 class_destroy(sg_sysfs_class);
1610 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1612 idr_destroy(&sg_index_idr);
1615 static int sg_start_req(Sg_request *srp, unsigned char *cmd)
1619 Sg_fd *sfp = srp->parentfp;
1620 sg_io_hdr_t *hp = &srp->header;
1621 int dxfer_len = (int) hp->dxfer_len;
1622 int dxfer_dir = hp->dxfer_direction;
1623 unsigned int iov_count = hp->iovec_count;
1624 Sg_scatter_hold *req_schp = &srp->data;
1625 Sg_scatter_hold *rsv_schp = &sfp->reserve;
1626 struct request_queue *q = sfp->parentdp->device->request_queue;
1627 struct rq_map_data *md, map_data;
1628 int rw = hp->dxfer_direction == SG_DXFER_TO_DEV ? WRITE : READ;
1630 SCSI_LOG_TIMEOUT(4, printk(KERN_INFO "sg_start_req: dxfer_len=%d\n",
1633 rq = blk_get_request(q, rw, GFP_ATOMIC);
1637 memcpy(rq->cmd, cmd, hp->cmd_len);
1639 rq->cmd_len = hp->cmd_len;
1640 rq->cmd_type = REQ_TYPE_BLOCK_PC;
1643 rq->end_io_data = srp;
1644 rq->sense = srp->sense_b;
1645 rq->retries = SG_DEFAULT_RETRIES;
1647 if ((dxfer_len <= 0) || (dxfer_dir == SG_DXFER_NONE))
1650 if (sg_allow_dio && hp->flags & SG_FLAG_DIRECT_IO &&
1651 dxfer_dir != SG_DXFER_UNKNOWN && !iov_count &&
1652 !sfp->parentdp->device->host->unchecked_isa_dma &&
1653 blk_rq_aligned(q, (unsigned long)hp->dxferp, dxfer_len))
1659 if (!sg_res_in_use(sfp) && dxfer_len <= rsv_schp->bufflen)
1660 sg_link_reserve(sfp, srp, dxfer_len);
1662 res = sg_build_indirect(req_schp, sfp, dxfer_len);
1667 md->pages = req_schp->pages;
1668 md->page_order = req_schp->page_order;
1669 md->nr_entries = req_schp->k_use_sg;
1671 md->null_mapped = hp->dxferp ? 0 : 1;
1672 if (dxfer_dir == SG_DXFER_TO_FROM_DEV)
1679 int len, size = sizeof(struct sg_iovec) * iov_count;
1682 iov = memdup_user(hp->dxferp, size);
1684 return PTR_ERR(iov);
1686 len = iov_length(iov, iov_count);
1687 if (hp->dxfer_len < len) {
1688 iov_count = iov_shorten(iov, iov_count, hp->dxfer_len);
1689 len = hp->dxfer_len;
1692 res = blk_rq_map_user_iov(q, rq, md, (struct sg_iovec *)iov,
1697 res = blk_rq_map_user(q, rq, md, hp->dxferp,
1698 hp->dxfer_len, GFP_ATOMIC);
1704 req_schp->dio_in_use = 1;
1705 hp->info |= SG_INFO_DIRECT_IO;
1711 static int sg_finish_rem_req(Sg_request * srp)
1715 Sg_fd *sfp = srp->parentfp;
1716 Sg_scatter_hold *req_schp = &srp->data;
1718 SCSI_LOG_TIMEOUT(4, printk("sg_finish_rem_req: res_used=%d\n", (int) srp->res_used));
1721 ret = blk_rq_unmap_user(srp->bio);
1723 blk_put_request(srp->rq);
1727 sg_unlink_reserve(sfp, srp);
1729 sg_remove_scat(req_schp);
1731 sg_remove_request(sfp, srp);
1737 sg_build_sgat(Sg_scatter_hold * schp, const Sg_fd * sfp, int tablesize)
1739 int sg_bufflen = tablesize * sizeof(struct page *);
1740 gfp_t gfp_flags = GFP_ATOMIC | __GFP_NOWARN;
1742 schp->pages = kzalloc(sg_bufflen, gfp_flags);
1745 schp->sglist_len = sg_bufflen;
1746 return tablesize; /* number of scat_gath elements allocated */
1750 sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size)
1752 int ret_sz = 0, i, k, rem_sz, num, mx_sc_elems;
1753 int sg_tablesize = sfp->parentdp->sg_tablesize;
1754 int blk_size = buff_size, order;
1755 gfp_t gfp_mask = GFP_ATOMIC | __GFP_COMP | __GFP_NOWARN;
1760 ++blk_size; /* don't know why */
1761 /* round request up to next highest SG_SECTOR_SZ byte boundary */
1762 blk_size = ALIGN(blk_size, SG_SECTOR_SZ);
1763 SCSI_LOG_TIMEOUT(4, printk("sg_build_indirect: buff_size=%d, blk_size=%d\n",
1764 buff_size, blk_size));
1766 /* N.B. ret_sz carried into this block ... */
1767 mx_sc_elems = sg_build_sgat(schp, sfp, sg_tablesize);
1768 if (mx_sc_elems < 0)
1769 return mx_sc_elems; /* most likely -ENOMEM */
1771 num = scatter_elem_sz;
1772 if (unlikely(num != scatter_elem_sz_prev)) {
1773 if (num < PAGE_SIZE) {
1774 scatter_elem_sz = PAGE_SIZE;
1775 scatter_elem_sz_prev = PAGE_SIZE;
1777 scatter_elem_sz_prev = num;
1781 gfp_mask |= GFP_DMA;
1783 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
1784 gfp_mask |= __GFP_ZERO;
1786 order = get_order(num);
1788 ret_sz = 1 << (PAGE_SHIFT + order);
1790 for (k = 0, rem_sz = blk_size; rem_sz > 0 && k < mx_sc_elems;
1791 k++, rem_sz -= ret_sz) {
1793 num = (rem_sz > scatter_elem_sz_prev) ?
1794 scatter_elem_sz_prev : rem_sz;
1796 schp->pages[k] = alloc_pages(gfp_mask, order);
1797 if (!schp->pages[k])
1800 if (num == scatter_elem_sz_prev) {
1801 if (unlikely(ret_sz > scatter_elem_sz_prev)) {
1802 scatter_elem_sz = ret_sz;
1803 scatter_elem_sz_prev = ret_sz;
1807 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k=%d, num=%d, "
1808 "ret_sz=%d\n", k, num, ret_sz));
1809 } /* end of for loop */
1811 schp->page_order = order;
1813 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k_use_sg=%d, "
1814 "rem_sz=%d\n", k, rem_sz));
1816 schp->bufflen = blk_size;
1817 if (rem_sz > 0) /* must have failed */
1821 for (i = 0; i < k; i++)
1822 __free_pages(schp->pages[i], order);
1831 sg_remove_scat(Sg_scatter_hold * schp)
1833 SCSI_LOG_TIMEOUT(4, printk("sg_remove_scat: k_use_sg=%d\n", schp->k_use_sg));
1834 if (schp->pages && schp->sglist_len > 0) {
1835 if (!schp->dio_in_use) {
1838 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
1839 SCSI_LOG_TIMEOUT(5, printk(
1840 "sg_remove_scat: k=%d, pg=0x%p\n",
1841 k, schp->pages[k]));
1842 __free_pages(schp->pages[k], schp->page_order);
1848 memset(schp, 0, sizeof (*schp));
1852 sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer)
1854 Sg_scatter_hold *schp = &srp->data;
1857 SCSI_LOG_TIMEOUT(4, printk("sg_read_oxfer: num_read_xfer=%d\n",
1859 if ((!outp) || (num_read_xfer <= 0))
1862 num = 1 << (PAGE_SHIFT + schp->page_order);
1863 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
1864 if (num > num_read_xfer) {
1865 if (__copy_to_user(outp, page_address(schp->pages[k]),
1870 if (__copy_to_user(outp, page_address(schp->pages[k]),
1873 num_read_xfer -= num;
1874 if (num_read_xfer <= 0)
1884 sg_build_reserve(Sg_fd * sfp, int req_size)
1886 Sg_scatter_hold *schp = &sfp->reserve;
1888 SCSI_LOG_TIMEOUT(4, printk("sg_build_reserve: req_size=%d\n", req_size));
1890 if (req_size < PAGE_SIZE)
1891 req_size = PAGE_SIZE;
1892 if (0 == sg_build_indirect(schp, sfp, req_size))
1895 sg_remove_scat(schp);
1896 req_size >>= 1; /* divide by 2 */
1897 } while (req_size > (PAGE_SIZE / 2));
1901 sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size)
1903 Sg_scatter_hold *req_schp = &srp->data;
1904 Sg_scatter_hold *rsv_schp = &sfp->reserve;
1908 SCSI_LOG_TIMEOUT(4, printk("sg_link_reserve: size=%d\n", size));
1911 num = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1912 for (k = 0; k < rsv_schp->k_use_sg; k++) {
1914 req_schp->k_use_sg = k + 1;
1915 req_schp->sglist_len = rsv_schp->sglist_len;
1916 req_schp->pages = rsv_schp->pages;
1918 req_schp->bufflen = size;
1919 req_schp->page_order = rsv_schp->page_order;
1925 if (k >= rsv_schp->k_use_sg)
1926 SCSI_LOG_TIMEOUT(1, printk("sg_link_reserve: BAD size\n"));
1930 sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp)
1932 Sg_scatter_hold *req_schp = &srp->data;
1934 SCSI_LOG_TIMEOUT(4, printk("sg_unlink_reserve: req->k_use_sg=%d\n",
1935 (int) req_schp->k_use_sg));
1936 req_schp->k_use_sg = 0;
1937 req_schp->bufflen = 0;
1938 req_schp->pages = NULL;
1939 req_schp->page_order = 0;
1940 req_schp->sglist_len = 0;
1941 sfp->save_scat_len = 0;
1946 sg_get_rq_mark(Sg_fd * sfp, int pack_id)
1949 unsigned long iflags;
1951 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1952 for (resp = sfp->headrp; resp; resp = resp->nextrp) {
1953 /* look for requests that are ready + not SG_IO owned */
1954 if ((1 == resp->done) && (!resp->sg_io_owned) &&
1955 ((-1 == pack_id) || (resp->header.pack_id == pack_id))) {
1956 resp->done = 2; /* guard against other readers */
1960 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1964 /* always adds to end of list */
1966 sg_add_request(Sg_fd * sfp)
1969 unsigned long iflags;
1971 Sg_request *rp = sfp->req_arr;
1973 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1976 memset(rp, 0, sizeof (Sg_request));
1981 if (0 == sfp->cmd_q)
1982 resp = NULL; /* command queuing disallowed */
1984 for (k = 0; k < SG_MAX_QUEUE; ++k, ++rp) {
1988 if (k < SG_MAX_QUEUE) {
1989 memset(rp, 0, sizeof (Sg_request));
1991 while (resp->nextrp)
1992 resp = resp->nextrp;
2000 resp->nextrp = NULL;
2001 resp->header.duration = jiffies_to_msecs(jiffies);
2003 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2007 /* Return of 1 for found; 0 for not found */
2009 sg_remove_request(Sg_fd * sfp, Sg_request * srp)
2011 Sg_request *prev_rp;
2013 unsigned long iflags;
2016 if ((!sfp) || (!srp) || (!sfp->headrp))
2018 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2019 prev_rp = sfp->headrp;
2020 if (srp == prev_rp) {
2021 sfp->headrp = prev_rp->nextrp;
2022 prev_rp->parentfp = NULL;
2025 while ((rp = prev_rp->nextrp)) {
2027 prev_rp->nextrp = rp->nextrp;
2028 rp->parentfp = NULL;
2035 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2040 sg_add_sfp(Sg_device * sdp, int dev)
2043 unsigned long iflags;
2046 sfp = kzalloc(sizeof(*sfp), GFP_ATOMIC | __GFP_NOWARN);
2050 init_waitqueue_head(&sfp->read_wait);
2051 rwlock_init(&sfp->rq_list_lock);
2053 kref_init(&sfp->f_ref);
2054 sfp->timeout = SG_DEFAULT_TIMEOUT;
2055 sfp->timeout_user = SG_DEFAULT_TIMEOUT_USER;
2056 sfp->force_packid = SG_DEF_FORCE_PACK_ID;
2057 sfp->low_dma = (SG_DEF_FORCE_LOW_DMA == 0) ?
2058 sdp->device->host->unchecked_isa_dma : 1;
2059 sfp->cmd_q = SG_DEF_COMMAND_Q;
2060 sfp->keep_orphan = SG_DEF_KEEP_ORPHAN;
2061 sfp->parentdp = sdp;
2062 write_lock_irqsave(&sg_index_lock, iflags);
2063 list_add_tail(&sfp->sfd_siblings, &sdp->sfds);
2064 write_unlock_irqrestore(&sg_index_lock, iflags);
2065 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: sfp=0x%p\n", sfp));
2066 if (unlikely(sg_big_buff != def_reserved_size))
2067 sg_big_buff = def_reserved_size;
2069 bufflen = min_t(int, sg_big_buff,
2070 queue_max_sectors(sdp->device->request_queue) * 512);
2071 sg_build_reserve(sfp, bufflen);
2072 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: bufflen=%d, k_use_sg=%d\n",
2073 sfp->reserve.bufflen, sfp->reserve.k_use_sg));
2075 kref_get(&sdp->d_ref);
2076 __module_get(THIS_MODULE);
2080 static void sg_remove_sfp_usercontext(struct work_struct *work)
2082 struct sg_fd *sfp = container_of(work, struct sg_fd, ew.work);
2083 struct sg_device *sdp = sfp->parentdp;
2085 /* Cleanup any responses which were never read(). */
2087 sg_finish_rem_req(sfp->headrp);
2089 if (sfp->reserve.bufflen > 0) {
2091 printk("sg_remove_sfp: bufflen=%d, k_use_sg=%d\n",
2092 (int) sfp->reserve.bufflen,
2093 (int) sfp->reserve.k_use_sg));
2094 sg_remove_scat(&sfp->reserve);
2098 printk("sg_remove_sfp: %s, sfp=0x%p\n",
2099 sdp->disk->disk_name,
2103 scsi_device_put(sdp->device);
2105 module_put(THIS_MODULE);
2108 static void sg_remove_sfp(struct kref *kref)
2110 struct sg_fd *sfp = container_of(kref, struct sg_fd, f_ref);
2111 unsigned long iflags;
2113 write_lock_irqsave(&sg_index_lock, iflags);
2114 list_del(&sfp->sfd_siblings);
2115 write_unlock_irqrestore(&sg_index_lock, iflags);
2117 INIT_WORK(&sfp->ew.work, sg_remove_sfp_usercontext);
2118 schedule_work(&sfp->ew.work);
2122 sg_res_in_use(Sg_fd * sfp)
2124 const Sg_request *srp;
2125 unsigned long iflags;
2127 read_lock_irqsave(&sfp->rq_list_lock, iflags);
2128 for (srp = sfp->headrp; srp; srp = srp->nextrp)
2131 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2135 #ifdef CONFIG_SCSI_PROC_FS
2137 sg_idr_max_id(int id, void *p, void *data)
2151 unsigned long iflags;
2153 read_lock_irqsave(&sg_index_lock, iflags);
2154 idr_for_each(&sg_index_idr, sg_idr_max_id, &k);
2155 read_unlock_irqrestore(&sg_index_lock, iflags);
2156 return k + 1; /* origin 1 */
2160 /* must be called with sg_index_lock held */
2161 static Sg_device *sg_lookup_dev(int dev)
2163 return idr_find(&sg_index_idr, dev);
2166 static Sg_device *sg_get_dev(int dev)
2168 struct sg_device *sdp;
2169 unsigned long flags;
2171 read_lock_irqsave(&sg_index_lock, flags);
2172 sdp = sg_lookup_dev(dev);
2174 sdp = ERR_PTR(-ENXIO);
2175 else if (sdp->detached) {
2176 /* If sdp->detached, then the refcount may already be 0, in
2177 * which case it would be a bug to do kref_get().
2179 sdp = ERR_PTR(-ENODEV);
2181 kref_get(&sdp->d_ref);
2182 read_unlock_irqrestore(&sg_index_lock, flags);
2187 static void sg_put_dev(struct sg_device *sdp)
2189 kref_put(&sdp->d_ref, sg_device_destroy);
2192 #ifdef CONFIG_SCSI_PROC_FS
2194 static struct proc_dir_entry *sg_proc_sgp = NULL;
2196 static char sg_proc_sg_dirname[] = "scsi/sg";
2198 static int sg_proc_seq_show_int(struct seq_file *s, void *v);
2200 static int sg_proc_single_open_adio(struct inode *inode, struct file *file);
2201 static ssize_t sg_proc_write_adio(struct file *filp, const char __user *buffer,
2202 size_t count, loff_t *off);
2203 static const struct file_operations adio_fops = {
2204 .owner = THIS_MODULE,
2205 .open = sg_proc_single_open_adio,
2207 .llseek = seq_lseek,
2208 .write = sg_proc_write_adio,
2209 .release = single_release,
2212 static int sg_proc_single_open_dressz(struct inode *inode, struct file *file);
2213 static ssize_t sg_proc_write_dressz(struct file *filp,
2214 const char __user *buffer, size_t count, loff_t *off);
2215 static const struct file_operations dressz_fops = {
2216 .owner = THIS_MODULE,
2217 .open = sg_proc_single_open_dressz,
2219 .llseek = seq_lseek,
2220 .write = sg_proc_write_dressz,
2221 .release = single_release,
2224 static int sg_proc_seq_show_version(struct seq_file *s, void *v);
2225 static int sg_proc_single_open_version(struct inode *inode, struct file *file);
2226 static const struct file_operations version_fops = {
2227 .owner = THIS_MODULE,
2228 .open = sg_proc_single_open_version,
2230 .llseek = seq_lseek,
2231 .release = single_release,
2234 static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v);
2235 static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file);
2236 static const struct file_operations devhdr_fops = {
2237 .owner = THIS_MODULE,
2238 .open = sg_proc_single_open_devhdr,
2240 .llseek = seq_lseek,
2241 .release = single_release,
2244 static int sg_proc_seq_show_dev(struct seq_file *s, void *v);
2245 static int sg_proc_open_dev(struct inode *inode, struct file *file);
2246 static void * dev_seq_start(struct seq_file *s, loff_t *pos);
2247 static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos);
2248 static void dev_seq_stop(struct seq_file *s, void *v);
2249 static const struct file_operations dev_fops = {
2250 .owner = THIS_MODULE,
2251 .open = sg_proc_open_dev,
2253 .llseek = seq_lseek,
2254 .release = seq_release,
2256 static const struct seq_operations dev_seq_ops = {
2257 .start = dev_seq_start,
2258 .next = dev_seq_next,
2259 .stop = dev_seq_stop,
2260 .show = sg_proc_seq_show_dev,
2263 static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v);
2264 static int sg_proc_open_devstrs(struct inode *inode, struct file *file);
2265 static const struct file_operations devstrs_fops = {
2266 .owner = THIS_MODULE,
2267 .open = sg_proc_open_devstrs,
2269 .llseek = seq_lseek,
2270 .release = seq_release,
2272 static const struct seq_operations devstrs_seq_ops = {
2273 .start = dev_seq_start,
2274 .next = dev_seq_next,
2275 .stop = dev_seq_stop,
2276 .show = sg_proc_seq_show_devstrs,
2279 static int sg_proc_seq_show_debug(struct seq_file *s, void *v);
2280 static int sg_proc_open_debug(struct inode *inode, struct file *file);
2281 static const struct file_operations debug_fops = {
2282 .owner = THIS_MODULE,
2283 .open = sg_proc_open_debug,
2285 .llseek = seq_lseek,
2286 .release = seq_release,
2288 static const struct seq_operations debug_seq_ops = {
2289 .start = dev_seq_start,
2290 .next = dev_seq_next,
2291 .stop = dev_seq_stop,
2292 .show = sg_proc_seq_show_debug,
2296 struct sg_proc_leaf {
2298 const struct file_operations * fops;
2301 static const struct sg_proc_leaf sg_proc_leaf_arr[] = {
2302 {"allow_dio", &adio_fops},
2303 {"debug", &debug_fops},
2304 {"def_reserved_size", &dressz_fops},
2305 {"device_hdr", &devhdr_fops},
2306 {"devices", &dev_fops},
2307 {"device_strs", &devstrs_fops},
2308 {"version", &version_fops}
2314 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
2317 sg_proc_sgp = proc_mkdir(sg_proc_sg_dirname, NULL);
2320 for (k = 0; k < num_leaves; ++k) {
2321 const struct sg_proc_leaf *leaf = &sg_proc_leaf_arr[k];
2322 umode_t mask = leaf->fops->write ? S_IRUGO | S_IWUSR : S_IRUGO;
2323 proc_create(leaf->name, mask, sg_proc_sgp, leaf->fops);
2329 sg_proc_cleanup(void)
2332 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
2336 for (k = 0; k < num_leaves; ++k)
2337 remove_proc_entry(sg_proc_leaf_arr[k].name, sg_proc_sgp);
2338 remove_proc_entry(sg_proc_sg_dirname, NULL);
2342 static int sg_proc_seq_show_int(struct seq_file *s, void *v)
2344 seq_printf(s, "%d\n", *((int *)s->private));
2348 static int sg_proc_single_open_adio(struct inode *inode, struct file *file)
2350 return single_open(file, sg_proc_seq_show_int, &sg_allow_dio);
2354 sg_proc_write_adio(struct file *filp, const char __user *buffer,
2355 size_t count, loff_t *off)
2360 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2362 err = kstrtoul_from_user(buffer, count, 0, &num);
2365 sg_allow_dio = num ? 1 : 0;
2369 static int sg_proc_single_open_dressz(struct inode *inode, struct file *file)
2371 return single_open(file, sg_proc_seq_show_int, &sg_big_buff);
2375 sg_proc_write_dressz(struct file *filp, const char __user *buffer,
2376 size_t count, loff_t *off)
2379 unsigned long k = ULONG_MAX;
2381 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2384 err = kstrtoul_from_user(buffer, count, 0, &k);
2387 if (k <= 1048576) { /* limit "big buff" to 1 MB */
2394 static int sg_proc_seq_show_version(struct seq_file *s, void *v)
2396 seq_printf(s, "%d\t%s [%s]\n", sg_version_num, SG_VERSION_STR,
2401 static int sg_proc_single_open_version(struct inode *inode, struct file *file)
2403 return single_open(file, sg_proc_seq_show_version, NULL);
2406 static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v)
2408 seq_printf(s, "host\tchan\tid\tlun\ttype\topens\tqdepth\tbusy\t"
2413 static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file)
2415 return single_open(file, sg_proc_seq_show_devhdr, NULL);
2418 struct sg_proc_deviter {
2423 static void * dev_seq_start(struct seq_file *s, loff_t *pos)
2425 struct sg_proc_deviter * it = kmalloc(sizeof(*it), GFP_KERNEL);
2432 it->max = sg_last_dev();
2433 if (it->index >= it->max)
2438 static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos)
2440 struct sg_proc_deviter * it = s->private;
2443 return (it->index < it->max) ? it : NULL;
2446 static void dev_seq_stop(struct seq_file *s, void *v)
2451 static int sg_proc_open_dev(struct inode *inode, struct file *file)
2453 return seq_open(file, &dev_seq_ops);
2456 static int sg_proc_seq_show_dev(struct seq_file *s, void *v)
2458 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2460 struct scsi_device *scsidp;
2461 unsigned long iflags;
2463 read_lock_irqsave(&sg_index_lock, iflags);
2464 sdp = it ? sg_lookup_dev(it->index) : NULL;
2465 if (sdp && (scsidp = sdp->device) && (!sdp->detached))
2466 seq_printf(s, "%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\n",
2467 scsidp->host->host_no, scsidp->channel,
2468 scsidp->id, scsidp->lun, (int) scsidp->type,
2470 (int) scsidp->queue_depth,
2471 (int) scsidp->device_busy,
2472 (int) scsi_device_online(scsidp));
2474 seq_printf(s, "-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\n");
2475 read_unlock_irqrestore(&sg_index_lock, iflags);
2479 static int sg_proc_open_devstrs(struct inode *inode, struct file *file)
2481 return seq_open(file, &devstrs_seq_ops);
2484 static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v)
2486 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2488 struct scsi_device *scsidp;
2489 unsigned long iflags;
2491 read_lock_irqsave(&sg_index_lock, iflags);
2492 sdp = it ? sg_lookup_dev(it->index) : NULL;
2493 if (sdp && (scsidp = sdp->device) && (!sdp->detached))
2494 seq_printf(s, "%8.8s\t%16.16s\t%4.4s\n",
2495 scsidp->vendor, scsidp->model, scsidp->rev);
2497 seq_printf(s, "<no active device>\n");
2498 read_unlock_irqrestore(&sg_index_lock, iflags);
2502 /* must be called while holding sg_index_lock */
2503 static void sg_proc_debug_helper(struct seq_file *s, Sg_device * sdp)
2505 int k, m, new_interface, blen, usg;
2508 const sg_io_hdr_t *hp;
2513 list_for_each_entry(fp, &sdp->sfds, sfd_siblings) {
2515 read_lock(&fp->rq_list_lock); /* irqs already disabled */
2516 seq_printf(s, " FD(%d): timeout=%dms bufflen=%d "
2517 "(res)sgat=%d low_dma=%d\n", k,
2518 jiffies_to_msecs(fp->timeout),
2519 fp->reserve.bufflen,
2520 (int) fp->reserve.k_use_sg,
2522 seq_printf(s, " cmd_q=%d f_packid=%d k_orphan=%d closed=0\n",
2523 (int) fp->cmd_q, (int) fp->force_packid,
2524 (int) fp->keep_orphan);
2525 for (m = 0, srp = fp->headrp;
2527 ++m, srp = srp->nextrp) {
2529 new_interface = (hp->interface_id == '\0') ? 0 : 1;
2530 if (srp->res_used) {
2531 if (new_interface &&
2532 (SG_FLAG_MMAP_IO & hp->flags))
2537 if (SG_INFO_DIRECT_IO_MASK & hp->info)
2543 blen = srp->data.bufflen;
2544 usg = srp->data.k_use_sg;
2545 seq_printf(s, srp->done ?
2546 ((1 == srp->done) ? "rcv:" : "fin:")
2548 seq_printf(s, " id=%d blen=%d",
2549 srp->header.pack_id, blen);
2551 seq_printf(s, " dur=%d", hp->duration);
2553 ms = jiffies_to_msecs(jiffies);
2554 seq_printf(s, " t_o/elap=%d/%d",
2555 (new_interface ? hp->timeout :
2556 jiffies_to_msecs(fp->timeout)),
2557 (ms > hp->duration ? ms - hp->duration : 0));
2559 seq_printf(s, "ms sgat=%d op=0x%02x\n", usg,
2560 (int) srp->data.cmd_opcode);
2563 seq_printf(s, " No requests active\n");
2564 read_unlock(&fp->rq_list_lock);
2568 static int sg_proc_open_debug(struct inode *inode, struct file *file)
2570 return seq_open(file, &debug_seq_ops);
2573 static int sg_proc_seq_show_debug(struct seq_file *s, void *v)
2575 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2577 unsigned long iflags;
2579 if (it && (0 == it->index)) {
2580 seq_printf(s, "max_active_device=%d(origin 1)\n",
2582 seq_printf(s, " def_reserved_size=%d\n", sg_big_buff);
2585 read_lock_irqsave(&sg_index_lock, iflags);
2586 sdp = it ? sg_lookup_dev(it->index) : NULL;
2587 if (sdp && !list_empty(&sdp->sfds)) {
2588 struct scsi_device *scsidp = sdp->device;
2590 seq_printf(s, " >>> device=%s ", sdp->disk->disk_name);
2592 seq_printf(s, "detached pending close ");
2595 (s, "scsi%d chan=%d id=%d lun=%d em=%d",
2596 scsidp->host->host_no,
2597 scsidp->channel, scsidp->id,
2599 scsidp->host->hostt->emulated);
2600 seq_printf(s, " sg_tablesize=%d excl=%d\n",
2601 sdp->sg_tablesize, sdp->exclude);
2602 sg_proc_debug_helper(s, sdp);
2604 read_unlock_irqrestore(&sg_index_lock, iflags);
2608 #endif /* CONFIG_SCSI_PROC_FS */
2610 module_init(init_sg);
2611 module_exit(exit_sg);