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 - 2014 Douglas Gilbert
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2, or (at your option)
19 static int sg_version_num = 30536; /* 2 digits for each component */
20 #define SG_VERSION_STR "3.5.36"
23 * D. P. Gilbert (dgilbert@interlog.com), notes:
24 * - scsi logging is available via SCSI_LOG_TIMEOUT macros. First
25 * the kernel/module needs to be built with CONFIG_SCSI_LOGGING
26 * (otherwise the macros compile to empty statements).
29 #include <linux/module.h>
32 #include <linux/kernel.h>
33 #include <linux/sched.h>
34 #include <linux/string.h>
36 #include <linux/errno.h>
37 #include <linux/mtio.h>
38 #include <linux/ioctl.h>
39 #include <linux/slab.h>
40 #include <linux/fcntl.h>
41 #include <linux/init.h>
42 #include <linux/poll.h>
43 #include <linux/moduleparam.h>
44 #include <linux/cdev.h>
45 #include <linux/idr.h>
46 #include <linux/seq_file.h>
47 #include <linux/blkdev.h>
48 #include <linux/delay.h>
49 #include <linux/blktrace_api.h>
50 #include <linux/mutex.h>
51 #include <linux/atomic.h>
52 #include <linux/ratelimit.h>
53 #include <linux/uio.h>
56 #include <scsi/scsi_dbg.h>
57 #include <scsi/scsi_host.h>
58 #include <scsi/scsi_driver.h>
59 #include <scsi/scsi_ioctl.h>
62 #include "scsi_logging.h"
64 #ifdef CONFIG_SCSI_PROC_FS
65 #include <linux/proc_fs.h>
66 static char *sg_version_date = "20140603";
68 static int sg_proc_init(void);
69 static void sg_proc_cleanup(void);
72 #define SG_ALLOW_DIO_DEF 0
74 #define SG_MAX_DEVS 32768
76 /* SG_MAX_CDB_SIZE should be 260 (spc4r37 section 3.1.30) however the type
77 * of sg_io_hdr::cmd_len can only represent 255. All SCSI commands greater
78 * than 16 bytes are "variable length" whose length is a multiple of 4
80 #define SG_MAX_CDB_SIZE 252
82 #define SG_DEFAULT_TIMEOUT mult_frac(SG_DEFAULT_TIMEOUT_USER, HZ, USER_HZ)
84 int sg_big_buff = SG_DEF_RESERVED_SIZE;
85 /* N.B. This variable is readable and writeable via
86 /proc/scsi/sg/def_reserved_size . Each time sg_open() is called a buffer
87 of this size (or less if there is not enough memory) will be reserved
88 for use by this file descriptor. [Deprecated usage: this variable is also
89 readable via /proc/sys/kernel/sg-big-buff if the sg driver is built into
90 the kernel (i.e. it is not a module).] */
91 static int def_reserved_size = -1; /* picks up init parameter */
92 static int sg_allow_dio = SG_ALLOW_DIO_DEF;
94 static int scatter_elem_sz = SG_SCATTER_SZ;
95 static int scatter_elem_sz_prev = SG_SCATTER_SZ;
97 #define SG_SECTOR_SZ 512
99 static int sg_add_device(struct device *, struct class_interface *);
100 static void sg_remove_device(struct device *, struct class_interface *);
102 static DEFINE_IDR(sg_index_idr);
103 static DEFINE_RWLOCK(sg_index_lock); /* Also used to lock
104 file descriptor list for device */
106 static struct class_interface sg_interface = {
107 .add_dev = sg_add_device,
108 .remove_dev = sg_remove_device,
111 typedef struct sg_scatter_hold { /* holding area for scsi scatter gather info */
112 unsigned short k_use_sg; /* Count of kernel scatter-gather pieces */
113 unsigned sglist_len; /* size of malloc'd scatter-gather list ++ */
114 unsigned bufflen; /* Size of (aggregate) data buffer */
117 char dio_in_use; /* 0->indirect IO (or mmap), 1->dio */
118 unsigned char cmd_opcode; /* first byte of command */
121 struct sg_device; /* forward declarations */
124 typedef struct sg_request { /* SG_MAX_QUEUE requests outstanding per file */
125 struct sg_request *nextrp; /* NULL -> tail request (slist) */
126 struct sg_fd *parentfp; /* NULL -> not in use */
127 Sg_scatter_hold data; /* hold buffer, perhaps scatter list */
128 sg_io_hdr_t header; /* scsi command+info, see <scsi/sg.h> */
129 unsigned char sense_b[SCSI_SENSE_BUFFERSIZE];
130 char res_used; /* 1 -> using reserve buffer, 0 -> not ... */
131 char orphan; /* 1 -> drop on sight, 0 -> normal */
132 char sg_io_owned; /* 1 -> packet belongs to SG_IO */
133 /* done protected by rq_list_lock */
134 char done; /* 0->before bh, 1->before read, 2->read */
137 struct execute_work ew;
140 typedef struct sg_fd { /* holds the state of a file descriptor */
141 struct list_head sfd_siblings; /* protected by device's sfd_lock */
142 struct sg_device *parentdp; /* owning device */
143 wait_queue_head_t read_wait; /* queue read until command done */
144 rwlock_t rq_list_lock; /* protect access to list in req_arr */
145 int timeout; /* defaults to SG_DEFAULT_TIMEOUT */
146 int timeout_user; /* defaults to SG_DEFAULT_TIMEOUT_USER */
147 Sg_scatter_hold reserve; /* buffer held for this file descriptor */
148 unsigned save_scat_len; /* original length of trunc. scat. element */
149 Sg_request *headrp; /* head of request slist, NULL->empty */
150 struct fasync_struct *async_qp; /* used by asynchronous notification */
151 Sg_request req_arr[SG_MAX_QUEUE]; /* used as singly-linked list */
152 char low_dma; /* as in parent but possibly overridden to 1 */
153 char force_packid; /* 1 -> pack_id input to read(), 0 -> ignored */
154 char cmd_q; /* 1 -> allow command queuing, 0 -> don't */
155 unsigned char next_cmd_len; /* 0: automatic, >0: use on next write() */
156 char keep_orphan; /* 0 -> drop orphan (def), 1 -> keep for read() */
157 char mmap_called; /* 0 -> mmap() never called on this fd */
159 struct execute_work ew;
162 typedef struct sg_device { /* holds the state of each scsi generic device */
163 struct scsi_device *device;
164 wait_queue_head_t open_wait; /* queue open() when O_EXCL present */
165 struct mutex open_rel_lock; /* held when in open() or release() */
166 int sg_tablesize; /* adapter's max scatter-gather table size */
167 u32 index; /* device index number */
168 struct list_head sfds;
169 rwlock_t sfd_lock; /* protect access to sfd list */
170 atomic_t detaching; /* 0->device usable, 1->device detaching */
171 bool exclude; /* 1->open(O_EXCL) succeeded and is active */
172 int open_cnt; /* count of opens (perhaps < num(sfds) ) */
173 char sgdebug; /* 0->off, 1->sense, 9->dump dev, 10-> all devs */
174 struct gendisk *disk;
175 struct cdev * cdev; /* char_dev [sysfs: /sys/cdev/major/sg<n>] */
179 /* tasklet or soft irq callback */
180 static void sg_rq_end_io(struct request *rq, int uptodate);
181 static int sg_start_req(Sg_request *srp, unsigned char *cmd);
182 static int sg_finish_rem_req(Sg_request * srp);
183 static int sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size);
184 static ssize_t sg_new_read(Sg_fd * sfp, char __user *buf, size_t count,
186 static ssize_t sg_new_write(Sg_fd *sfp, struct file *file,
187 const char __user *buf, size_t count, int blocking,
188 int read_only, int sg_io_owned, Sg_request **o_srp);
189 static int sg_common_write(Sg_fd * sfp, Sg_request * srp,
190 unsigned char *cmnd, int timeout, int blocking);
191 static int sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer);
192 static void sg_remove_scat(Sg_fd * sfp, Sg_scatter_hold * schp);
193 static void sg_build_reserve(Sg_fd * sfp, int req_size);
194 static void sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size);
195 static void sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp);
196 static Sg_fd *sg_add_sfp(Sg_device * sdp);
197 static void sg_remove_sfp(struct kref *);
198 static Sg_request *sg_get_rq_mark(Sg_fd * sfp, int pack_id);
199 static Sg_request *sg_add_request(Sg_fd * sfp);
200 static int sg_remove_request(Sg_fd * sfp, Sg_request * srp);
201 static int sg_res_in_use(Sg_fd * sfp);
202 static Sg_device *sg_get_dev(int dev);
203 static void sg_device_destroy(struct kref *kref);
205 #define SZ_SG_HEADER sizeof(struct sg_header)
206 #define SZ_SG_IO_HDR sizeof(sg_io_hdr_t)
207 #define SZ_SG_IOVEC sizeof(sg_iovec_t)
208 #define SZ_SG_REQ_INFO sizeof(sg_req_info_t)
210 #define sg_printk(prefix, sdp, fmt, a...) \
211 sdev_prefix_printk(prefix, (sdp)->device, \
212 (sdp)->disk->disk_name, fmt, ##a)
214 static int sg_allow_access(struct file *filp, unsigned char *cmd)
216 struct sg_fd *sfp = filp->private_data;
218 if (sfp->parentdp->device->type == TYPE_SCANNER)
221 return blk_verify_command(cmd, filp->f_mode & FMODE_WRITE);
225 open_wait(Sg_device *sdp, int flags)
229 if (flags & O_EXCL) {
230 while (sdp->open_cnt > 0) {
231 mutex_unlock(&sdp->open_rel_lock);
232 retval = wait_event_interruptible(sdp->open_wait,
233 (atomic_read(&sdp->detaching) ||
235 mutex_lock(&sdp->open_rel_lock);
237 if (retval) /* -ERESTARTSYS */
239 if (atomic_read(&sdp->detaching))
243 while (sdp->exclude) {
244 mutex_unlock(&sdp->open_rel_lock);
245 retval = wait_event_interruptible(sdp->open_wait,
246 (atomic_read(&sdp->detaching) ||
248 mutex_lock(&sdp->open_rel_lock);
250 if (retval) /* -ERESTARTSYS */
252 if (atomic_read(&sdp->detaching))
260 /* Returns 0 on success, else a negated errno value */
262 sg_open(struct inode *inode, struct file *filp)
264 int dev = iminor(inode);
265 int flags = filp->f_flags;
266 struct request_queue *q;
271 nonseekable_open(inode, filp);
272 if ((flags & O_EXCL) && (O_RDONLY == (flags & O_ACCMODE)))
273 return -EPERM; /* Can't lock it with read only access */
274 sdp = sg_get_dev(dev);
278 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
279 "sg_open: flags=0x%x\n", flags));
281 /* This driver's module count bumped by fops_get in <linux/fs.h> */
282 /* Prevent the device driver from vanishing while we sleep */
283 retval = scsi_device_get(sdp->device);
287 retval = scsi_autopm_get_device(sdp->device);
291 /* scsi_block_when_processing_errors() may block so bypass
292 * check if O_NONBLOCK. Permits SCSI commands to be issued
293 * during error recovery. Tread carefully. */
294 if (!((flags & O_NONBLOCK) ||
295 scsi_block_when_processing_errors(sdp->device))) {
297 /* we are in error recovery for this device */
301 mutex_lock(&sdp->open_rel_lock);
302 if (flags & O_NONBLOCK) {
303 if (flags & O_EXCL) {
304 if (sdp->open_cnt > 0) {
306 goto error_mutex_locked;
311 goto error_mutex_locked;
315 retval = open_wait(sdp, flags);
316 if (retval) /* -ERESTARTSYS or -ENODEV */
317 goto error_mutex_locked;
320 /* N.B. at this point we are holding the open_rel_lock */
324 if (sdp->open_cnt < 1) { /* no existing opens */
326 q = sdp->device->request_queue;
327 sdp->sg_tablesize = queue_max_segments(q);
329 sfp = sg_add_sfp(sdp);
331 retval = PTR_ERR(sfp);
335 filp->private_data = sfp;
337 mutex_unlock(&sdp->open_rel_lock);
341 kref_put(&sdp->d_ref, sg_device_destroy);
345 if (flags & O_EXCL) {
346 sdp->exclude = false; /* undo if error */
347 wake_up_interruptible(&sdp->open_wait);
350 mutex_unlock(&sdp->open_rel_lock);
352 scsi_autopm_put_device(sdp->device);
354 scsi_device_put(sdp->device);
358 /* Release resources associated with a successful sg_open()
359 * Returns 0 on success, else a negated errno value */
361 sg_release(struct inode *inode, struct file *filp)
366 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
368 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp, "sg_release\n"));
370 mutex_lock(&sdp->open_rel_lock);
371 scsi_autopm_put_device(sdp->device);
372 kref_put(&sfp->f_ref, sg_remove_sfp);
375 /* possibly many open()s waiting on exlude clearing, start many;
376 * only open(O_EXCL)s wait on 0==open_cnt so only start one */
378 sdp->exclude = false;
379 wake_up_interruptible_all(&sdp->open_wait);
380 } else if (0 == sdp->open_cnt) {
381 wake_up_interruptible(&sdp->open_wait);
383 mutex_unlock(&sdp->open_rel_lock);
388 sg_read(struct file *filp, char __user *buf, size_t count, loff_t * ppos)
393 int req_pack_id = -1;
395 struct sg_header *old_hdr = NULL;
398 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
400 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
401 "sg_read: count=%d\n", (int) count));
403 if (!access_ok(VERIFY_WRITE, buf, count))
405 if (sfp->force_packid && (count >= SZ_SG_HEADER)) {
406 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
409 if (__copy_from_user(old_hdr, buf, SZ_SG_HEADER)) {
413 if (old_hdr->reply_len < 0) {
414 if (count >= SZ_SG_IO_HDR) {
415 sg_io_hdr_t *new_hdr;
416 new_hdr = kmalloc(SZ_SG_IO_HDR, GFP_KERNEL);
421 retval =__copy_from_user
422 (new_hdr, buf, SZ_SG_IO_HDR);
423 req_pack_id = new_hdr->pack_id;
431 req_pack_id = old_hdr->pack_id;
433 srp = sg_get_rq_mark(sfp, req_pack_id);
434 if (!srp) { /* now wait on packet to arrive */
435 if (atomic_read(&sdp->detaching)) {
439 if (filp->f_flags & O_NONBLOCK) {
443 retval = wait_event_interruptible(sfp->read_wait,
444 (atomic_read(&sdp->detaching) ||
445 (srp = sg_get_rq_mark(sfp, req_pack_id))));
446 if (atomic_read(&sdp->detaching)) {
451 /* -ERESTARTSYS as signal hit process */
455 if (srp->header.interface_id != '\0') {
456 retval = sg_new_read(sfp, buf, count, srp);
461 if (old_hdr == NULL) {
462 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
468 memset(old_hdr, 0, SZ_SG_HEADER);
469 old_hdr->reply_len = (int) hp->timeout;
470 old_hdr->pack_len = old_hdr->reply_len; /* old, strange behaviour */
471 old_hdr->pack_id = hp->pack_id;
472 old_hdr->twelve_byte =
473 ((srp->data.cmd_opcode >= 0xc0) && (12 == hp->cmd_len)) ? 1 : 0;
474 old_hdr->target_status = hp->masked_status;
475 old_hdr->host_status = hp->host_status;
476 old_hdr->driver_status = hp->driver_status;
477 if ((CHECK_CONDITION & hp->masked_status) ||
478 (DRIVER_SENSE & hp->driver_status))
479 memcpy(old_hdr->sense_buffer, srp->sense_b,
480 sizeof (old_hdr->sense_buffer));
481 switch (hp->host_status) {
482 /* This setup of 'result' is for backward compatibility and is best
483 ignored by the user who should use target, host + driver status */
485 case DID_PASSTHROUGH:
492 old_hdr->result = EBUSY;
499 old_hdr->result = EIO;
502 old_hdr->result = (srp->sense_b[0] == 0 &&
503 hp->masked_status == GOOD) ? 0 : EIO;
506 old_hdr->result = EIO;
510 /* Now copy the result back to the user buffer. */
511 if (count >= SZ_SG_HEADER) {
512 if (__copy_to_user(buf, old_hdr, SZ_SG_HEADER)) {
517 if (count > old_hdr->reply_len)
518 count = old_hdr->reply_len;
519 if (count > SZ_SG_HEADER) {
520 if (sg_read_oxfer(srp, buf, count - SZ_SG_HEADER)) {
526 count = (old_hdr->result == 0) ? 0 : -EIO;
527 sg_finish_rem_req(srp);
535 sg_new_read(Sg_fd * sfp, char __user *buf, size_t count, Sg_request * srp)
537 sg_io_hdr_t *hp = &srp->header;
541 if (count < SZ_SG_IO_HDR) {
546 if ((hp->mx_sb_len > 0) && hp->sbp) {
547 if ((CHECK_CONDITION & hp->masked_status) ||
548 (DRIVER_SENSE & hp->driver_status)) {
549 int sb_len = SCSI_SENSE_BUFFERSIZE;
550 sb_len = (hp->mx_sb_len > sb_len) ? sb_len : hp->mx_sb_len;
551 len = 8 + (int) srp->sense_b[7]; /* Additional sense length field */
552 len = (len > sb_len) ? sb_len : len;
553 if (copy_to_user(hp->sbp, srp->sense_b, len)) {
560 if (hp->masked_status || hp->host_status || hp->driver_status)
561 hp->info |= SG_INFO_CHECK;
562 if (copy_to_user(buf, hp, SZ_SG_IO_HDR)) {
567 err2 = sg_finish_rem_req(srp);
568 return err ? : err2 ? : count;
572 sg_write(struct file *filp, const char __user *buf, size_t count, loff_t * ppos)
574 int mxsize, cmd_size, k;
575 int input_size, blocking;
576 unsigned char opcode;
580 struct sg_header old_hdr;
582 unsigned char cmnd[SG_MAX_CDB_SIZE];
584 if (unlikely(segment_eq(get_fs(), KERNEL_DS)))
587 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
589 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
590 "sg_write: count=%d\n", (int) count));
591 if (atomic_read(&sdp->detaching))
593 if (!((filp->f_flags & O_NONBLOCK) ||
594 scsi_block_when_processing_errors(sdp->device)))
597 if (!access_ok(VERIFY_READ, buf, count))
598 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
599 if (count < SZ_SG_HEADER)
601 if (__copy_from_user(&old_hdr, buf, SZ_SG_HEADER))
603 blocking = !(filp->f_flags & O_NONBLOCK);
604 if (old_hdr.reply_len < 0)
605 return sg_new_write(sfp, filp, buf, count,
606 blocking, 0, 0, NULL);
607 if (count < (SZ_SG_HEADER + 6))
608 return -EIO; /* The minimum scsi command length is 6 bytes. */
610 if (!(srp = sg_add_request(sfp))) {
611 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO, sdp,
612 "sg_write: queue full\n"));
616 __get_user(opcode, buf);
617 if (sfp->next_cmd_len > 0) {
618 cmd_size = sfp->next_cmd_len;
619 sfp->next_cmd_len = 0; /* reset so only this write() effected */
621 cmd_size = COMMAND_SIZE(opcode); /* based on SCSI command group */
622 if ((opcode >= 0xc0) && old_hdr.twelve_byte)
625 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sdp,
626 "sg_write: scsi opcode=0x%02x, cmd_size=%d\n", (int) opcode, cmd_size));
627 /* Determine buffer size. */
628 input_size = count - cmd_size;
629 mxsize = (input_size > old_hdr.reply_len) ? input_size : old_hdr.reply_len;
630 mxsize -= SZ_SG_HEADER;
631 input_size -= SZ_SG_HEADER;
632 if (input_size < 0) {
633 sg_remove_request(sfp, srp);
634 return -EIO; /* User did not pass enough bytes for this command. */
637 hp->interface_id = '\0'; /* indicator of old interface tunnelled */
638 hp->cmd_len = (unsigned char) cmd_size;
642 hp->dxfer_direction = (old_hdr.reply_len > SZ_SG_HEADER) ?
643 SG_DXFER_TO_FROM_DEV : SG_DXFER_TO_DEV;
645 hp->dxfer_direction = (mxsize > 0) ? SG_DXFER_FROM_DEV : SG_DXFER_NONE;
646 hp->dxfer_len = mxsize;
647 if ((hp->dxfer_direction == SG_DXFER_TO_DEV) ||
648 (hp->dxfer_direction == SG_DXFER_TO_FROM_DEV))
649 hp->dxferp = (char __user *)buf + cmd_size;
653 hp->timeout = old_hdr.reply_len; /* structure abuse ... */
654 hp->flags = input_size; /* structure abuse ... */
655 hp->pack_id = old_hdr.pack_id;
657 if (__copy_from_user(cmnd, buf, cmd_size))
660 * SG_DXFER_TO_FROM_DEV is functionally equivalent to SG_DXFER_FROM_DEV,
661 * but is is possible that the app intended SG_DXFER_TO_DEV, because there
662 * is a non-zero input_size, so emit a warning.
664 if (hp->dxfer_direction == SG_DXFER_TO_FROM_DEV) {
665 static char cmd[TASK_COMM_LEN];
666 if (strcmp(current->comm, cmd)) {
667 printk_ratelimited(KERN_WARNING
668 "sg_write: data in/out %d/%d bytes "
669 "for SCSI command 0x%x-- guessing "
670 "data in;\n program %s not setting "
671 "count and/or reply_len properly\n",
672 old_hdr.reply_len - (int)SZ_SG_HEADER,
673 input_size, (unsigned int) cmnd[0],
675 strcpy(cmd, current->comm);
678 k = sg_common_write(sfp, srp, cmnd, sfp->timeout, blocking);
679 return (k < 0) ? k : count;
683 sg_new_write(Sg_fd *sfp, struct file *file, const char __user *buf,
684 size_t count, int blocking, int read_only, int sg_io_owned,
690 unsigned char cmnd[SG_MAX_CDB_SIZE];
692 unsigned long ul_timeout;
694 if (count < SZ_SG_IO_HDR)
696 if (!access_ok(VERIFY_READ, buf, count))
697 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
699 sfp->cmd_q = 1; /* when sg_io_hdr seen, set command queuing on */
700 if (!(srp = sg_add_request(sfp))) {
701 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO, sfp->parentdp,
702 "sg_new_write: queue full\n"));
705 srp->sg_io_owned = sg_io_owned;
707 if (__copy_from_user(hp, buf, SZ_SG_IO_HDR)) {
708 sg_remove_request(sfp, srp);
711 if (hp->interface_id != 'S') {
712 sg_remove_request(sfp, srp);
715 if (hp->flags & SG_FLAG_MMAP_IO) {
716 if (hp->dxfer_len > sfp->reserve.bufflen) {
717 sg_remove_request(sfp, srp);
718 return -ENOMEM; /* MMAP_IO size must fit in reserve buffer */
720 if (hp->flags & SG_FLAG_DIRECT_IO) {
721 sg_remove_request(sfp, srp);
722 return -EINVAL; /* either MMAP_IO or DIRECT_IO (not both) */
724 if (sg_res_in_use(sfp)) {
725 sg_remove_request(sfp, srp);
726 return -EBUSY; /* reserve buffer already being used */
729 ul_timeout = msecs_to_jiffies(srp->header.timeout);
730 timeout = (ul_timeout < INT_MAX) ? ul_timeout : INT_MAX;
731 if ((!hp->cmdp) || (hp->cmd_len < 6) || (hp->cmd_len > sizeof (cmnd))) {
732 sg_remove_request(sfp, srp);
735 if (!access_ok(VERIFY_READ, hp->cmdp, hp->cmd_len)) {
736 sg_remove_request(sfp, srp);
737 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
739 if (__copy_from_user(cmnd, hp->cmdp, hp->cmd_len)) {
740 sg_remove_request(sfp, srp);
743 if (read_only && sg_allow_access(file, cmnd)) {
744 sg_remove_request(sfp, srp);
747 k = sg_common_write(sfp, srp, cmnd, timeout, blocking);
756 sg_common_write(Sg_fd * sfp, Sg_request * srp,
757 unsigned char *cmnd, int timeout, int blocking)
760 Sg_device *sdp = sfp->parentdp;
761 sg_io_hdr_t *hp = &srp->header;
763 srp->data.cmd_opcode = cmnd[0]; /* hold opcode of command */
765 hp->masked_status = 0;
769 hp->driver_status = 0;
771 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
772 "sg_common_write: scsi opcode=0x%02x, cmd_size=%d\n",
773 (int) cmnd[0], (int) hp->cmd_len));
775 k = sg_start_req(srp, cmnd);
777 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO, sfp->parentdp,
778 "sg_common_write: start_req err=%d\n", k));
779 sg_finish_rem_req(srp);
780 return k; /* probably out of space --> ENOMEM */
782 if (atomic_read(&sdp->detaching)) {
784 scsi_req_free_cmd(scsi_req(srp->rq));
785 blk_end_request_all(srp->rq, -EIO);
789 sg_finish_rem_req(srp);
793 hp->duration = jiffies_to_msecs(jiffies);
794 if (hp->interface_id != '\0' && /* v3 (or later) interface */
795 (SG_FLAG_Q_AT_TAIL & hp->flags))
800 srp->rq->timeout = timeout;
801 kref_get(&sfp->f_ref); /* sg_rq_end_io() does kref_put(). */
802 blk_execute_rq_nowait(sdp->device->request_queue, sdp->disk,
803 srp->rq, at_head, sg_rq_end_io);
807 static int srp_done(Sg_fd *sfp, Sg_request *srp)
812 read_lock_irqsave(&sfp->rq_list_lock, flags);
814 read_unlock_irqrestore(&sfp->rq_list_lock, flags);
818 static int max_sectors_bytes(struct request_queue *q)
820 unsigned int max_sectors = queue_max_sectors(q);
822 max_sectors = min_t(unsigned int, max_sectors, INT_MAX >> 9);
824 return max_sectors << 9;
828 sg_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
830 void __user *p = (void __user *)arg;
832 int result, val, read_only;
836 unsigned long iflags;
838 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
841 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
842 "sg_ioctl: cmd=0x%x\n", (int) cmd_in));
843 read_only = (O_RDWR != (filp->f_flags & O_ACCMODE));
847 if (atomic_read(&sdp->detaching))
849 if (!scsi_block_when_processing_errors(sdp->device))
851 if (!access_ok(VERIFY_WRITE, p, SZ_SG_IO_HDR))
853 result = sg_new_write(sfp, filp, p, SZ_SG_IO_HDR,
854 1, read_only, 1, &srp);
857 result = wait_event_interruptible(sfp->read_wait,
858 (srp_done(sfp, srp) || atomic_read(&sdp->detaching)));
859 if (atomic_read(&sdp->detaching))
861 write_lock_irq(&sfp->rq_list_lock);
864 write_unlock_irq(&sfp->rq_list_lock);
865 result = sg_new_read(sfp, p, SZ_SG_IO_HDR, srp);
866 return (result < 0) ? result : 0;
869 write_unlock_irq(&sfp->rq_list_lock);
870 return result; /* -ERESTARTSYS because signal hit process */
872 result = get_user(val, ip);
877 if (val >= mult_frac((s64)INT_MAX, USER_HZ, HZ))
878 val = min_t(s64, mult_frac((s64)INT_MAX, USER_HZ, HZ),
880 sfp->timeout_user = val;
881 sfp->timeout = mult_frac(val, HZ, USER_HZ);
884 case SG_GET_TIMEOUT: /* N.B. User receives timeout as return value */
885 /* strange ..., for backward compatibility */
886 return sfp->timeout_user;
887 case SG_SET_FORCE_LOW_DMA:
888 result = get_user(val, ip);
893 if ((0 == sfp->low_dma) && (0 == sg_res_in_use(sfp))) {
894 val = (int) sfp->reserve.bufflen;
895 sg_remove_scat(sfp, &sfp->reserve);
896 sg_build_reserve(sfp, val);
899 if (atomic_read(&sdp->detaching))
901 sfp->low_dma = sdp->device->host->unchecked_isa_dma;
905 return put_user((int) sfp->low_dma, ip);
907 if (!access_ok(VERIFY_WRITE, p, sizeof (sg_scsi_id_t)))
910 sg_scsi_id_t __user *sg_idp = p;
912 if (atomic_read(&sdp->detaching))
914 __put_user((int) sdp->device->host->host_no,
916 __put_user((int) sdp->device->channel,
918 __put_user((int) sdp->device->id, &sg_idp->scsi_id);
919 __put_user((int) sdp->device->lun, &sg_idp->lun);
920 __put_user((int) sdp->device->type, &sg_idp->scsi_type);
921 __put_user((short) sdp->device->host->cmd_per_lun,
922 &sg_idp->h_cmd_per_lun);
923 __put_user((short) sdp->device->queue_depth,
924 &sg_idp->d_queue_depth);
925 __put_user(0, &sg_idp->unused[0]);
926 __put_user(0, &sg_idp->unused[1]);
929 case SG_SET_FORCE_PACK_ID:
930 result = get_user(val, ip);
933 sfp->force_packid = val ? 1 : 0;
936 if (!access_ok(VERIFY_WRITE, ip, sizeof (int)))
938 read_lock_irqsave(&sfp->rq_list_lock, iflags);
939 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
940 if ((1 == srp->done) && (!srp->sg_io_owned)) {
941 read_unlock_irqrestore(&sfp->rq_list_lock,
943 __put_user(srp->header.pack_id, ip);
947 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
950 case SG_GET_NUM_WAITING:
951 read_lock_irqsave(&sfp->rq_list_lock, iflags);
952 for (val = 0, srp = sfp->headrp; srp; srp = srp->nextrp) {
953 if ((1 == srp->done) && (!srp->sg_io_owned))
956 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
957 return put_user(val, ip);
958 case SG_GET_SG_TABLESIZE:
959 return put_user(sdp->sg_tablesize, ip);
960 case SG_SET_RESERVED_SIZE:
961 result = get_user(val, ip);
966 val = min_t(int, val,
967 max_sectors_bytes(sdp->device->request_queue));
968 if (val != sfp->reserve.bufflen) {
969 if (sg_res_in_use(sfp) || sfp->mmap_called)
971 sg_remove_scat(sfp, &sfp->reserve);
972 sg_build_reserve(sfp, val);
975 case SG_GET_RESERVED_SIZE:
976 val = min_t(int, sfp->reserve.bufflen,
977 max_sectors_bytes(sdp->device->request_queue));
978 return put_user(val, ip);
979 case SG_SET_COMMAND_Q:
980 result = get_user(val, ip);
983 sfp->cmd_q = val ? 1 : 0;
985 case SG_GET_COMMAND_Q:
986 return put_user((int) sfp->cmd_q, ip);
987 case SG_SET_KEEP_ORPHAN:
988 result = get_user(val, ip);
991 sfp->keep_orphan = val;
993 case SG_GET_KEEP_ORPHAN:
994 return put_user((int) sfp->keep_orphan, ip);
995 case SG_NEXT_CMD_LEN:
996 result = get_user(val, ip);
999 sfp->next_cmd_len = (val > 0) ? val : 0;
1001 case SG_GET_VERSION_NUM:
1002 return put_user(sg_version_num, ip);
1003 case SG_GET_ACCESS_COUNT:
1004 /* faked - we don't have a real access count anymore */
1005 val = (sdp->device ? 1 : 0);
1006 return put_user(val, ip);
1007 case SG_GET_REQUEST_TABLE:
1008 if (!access_ok(VERIFY_WRITE, p, SZ_SG_REQ_INFO * SG_MAX_QUEUE))
1011 sg_req_info_t *rinfo;
1014 rinfo = kmalloc(SZ_SG_REQ_INFO * SG_MAX_QUEUE,
1018 read_lock_irqsave(&sfp->rq_list_lock, iflags);
1019 for (srp = sfp->headrp, val = 0; val < SG_MAX_QUEUE;
1020 ++val, srp = srp ? srp->nextrp : srp) {
1021 memset(&rinfo[val], 0, SZ_SG_REQ_INFO);
1023 rinfo[val].req_state = srp->done + 1;
1024 rinfo[val].problem =
1025 srp->header.masked_status &
1026 srp->header.host_status &
1027 srp->header.driver_status;
1029 rinfo[val].duration =
1030 srp->header.duration;
1032 ms = jiffies_to_msecs(jiffies);
1033 rinfo[val].duration =
1034 (ms > srp->header.duration) ?
1035 (ms - srp->header.duration) : 0;
1037 rinfo[val].orphan = srp->orphan;
1038 rinfo[val].sg_io_owned =
1040 rinfo[val].pack_id =
1041 srp->header.pack_id;
1042 rinfo[val].usr_ptr =
1043 srp->header.usr_ptr;
1046 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1047 result = __copy_to_user(p, rinfo,
1048 SZ_SG_REQ_INFO * SG_MAX_QUEUE);
1049 result = result ? -EFAULT : 0;
1053 case SG_EMULATED_HOST:
1054 if (atomic_read(&sdp->detaching))
1056 return put_user(sdp->device->host->hostt->emulated, ip);
1057 case SCSI_IOCTL_SEND_COMMAND:
1058 if (atomic_read(&sdp->detaching))
1061 unsigned char opcode = WRITE_6;
1062 Scsi_Ioctl_Command __user *siocp = p;
1064 if (copy_from_user(&opcode, siocp->data, 1))
1066 if (sg_allow_access(filp, &opcode))
1069 return sg_scsi_ioctl(sdp->device->request_queue, NULL, filp->f_mode, p);
1071 result = get_user(val, ip);
1074 sdp->sgdebug = (char) val;
1077 return put_user(max_sectors_bytes(sdp->device->request_queue),
1080 return blk_trace_setup(sdp->device->request_queue,
1081 sdp->disk->disk_name,
1082 MKDEV(SCSI_GENERIC_MAJOR, sdp->index),
1086 return blk_trace_startstop(sdp->device->request_queue, 1);
1088 return blk_trace_startstop(sdp->device->request_queue, 0);
1089 case BLKTRACETEARDOWN:
1090 return blk_trace_remove(sdp->device->request_queue);
1091 case SCSI_IOCTL_GET_IDLUN:
1092 case SCSI_IOCTL_GET_BUS_NUMBER:
1093 case SCSI_IOCTL_PROBE_HOST:
1094 case SG_GET_TRANSFORM:
1096 if (atomic_read(&sdp->detaching))
1101 return -EPERM; /* don't know so take safe approach */
1105 result = scsi_ioctl_block_when_processing_errors(sdp->device,
1106 cmd_in, filp->f_flags & O_NDELAY);
1109 return scsi_ioctl(sdp->device, cmd_in, p);
1112 #ifdef CONFIG_COMPAT
1113 static long sg_compat_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
1117 struct scsi_device *sdev;
1119 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1123 if (sdev->host->hostt->compat_ioctl) {
1126 ret = sdev->host->hostt->compat_ioctl(sdev, cmd_in, (void __user *)arg);
1131 return -ENOIOCTLCMD;
1136 sg_poll(struct file *filp, poll_table * wait)
1138 unsigned int res = 0;
1143 unsigned long iflags;
1145 sfp = filp->private_data;
1148 sdp = sfp->parentdp;
1151 poll_wait(filp, &sfp->read_wait, wait);
1152 read_lock_irqsave(&sfp->rq_list_lock, iflags);
1153 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
1154 /* if any read waiting, flag it */
1155 if ((0 == res) && (1 == srp->done) && (!srp->sg_io_owned))
1156 res = POLLIN | POLLRDNORM;
1159 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1161 if (atomic_read(&sdp->detaching))
1163 else if (!sfp->cmd_q) {
1165 res |= POLLOUT | POLLWRNORM;
1166 } else if (count < SG_MAX_QUEUE)
1167 res |= POLLOUT | POLLWRNORM;
1168 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
1169 "sg_poll: res=0x%x\n", (int) res));
1174 sg_fasync(int fd, struct file *filp, int mode)
1179 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1181 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
1182 "sg_fasync: mode=%d\n", mode));
1184 return fasync_helper(fd, filp, mode, &sfp->async_qp);
1188 sg_vma_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
1191 unsigned long offset, len, sa;
1192 Sg_scatter_hold *rsv_schp;
1195 if ((NULL == vma) || (!(sfp = (Sg_fd *) vma->vm_private_data)))
1196 return VM_FAULT_SIGBUS;
1197 rsv_schp = &sfp->reserve;
1198 offset = vmf->pgoff << PAGE_SHIFT;
1199 if (offset >= rsv_schp->bufflen)
1200 return VM_FAULT_SIGBUS;
1201 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sfp->parentdp,
1202 "sg_vma_fault: offset=%lu, scatg=%d\n",
1203 offset, rsv_schp->k_use_sg));
1205 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1206 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
1207 len = vma->vm_end - sa;
1208 len = (len < length) ? len : length;
1210 struct page *page = nth_page(rsv_schp->pages[k],
1211 offset >> PAGE_SHIFT);
1212 get_page(page); /* increment page count */
1214 return 0; /* success */
1220 return VM_FAULT_SIGBUS;
1223 static const struct vm_operations_struct sg_mmap_vm_ops = {
1224 .fault = sg_vma_fault,
1228 sg_mmap(struct file *filp, struct vm_area_struct *vma)
1231 unsigned long req_sz, len, sa;
1232 Sg_scatter_hold *rsv_schp;
1235 if ((!filp) || (!vma) || (!(sfp = (Sg_fd *) filp->private_data)))
1237 req_sz = vma->vm_end - vma->vm_start;
1238 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sfp->parentdp,
1239 "sg_mmap starting, vm_start=%p, len=%d\n",
1240 (void *) vma->vm_start, (int) req_sz));
1242 return -EINVAL; /* want no offset */
1243 rsv_schp = &sfp->reserve;
1244 if (req_sz > rsv_schp->bufflen)
1245 return -ENOMEM; /* cannot map more than reserved buffer */
1248 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1249 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
1250 len = vma->vm_end - sa;
1251 len = (len < length) ? len : length;
1255 sfp->mmap_called = 1;
1256 vma->vm_flags |= VM_IO | VM_DONTEXPAND | VM_DONTDUMP;
1257 vma->vm_private_data = sfp;
1258 vma->vm_ops = &sg_mmap_vm_ops;
1263 sg_rq_end_io_usercontext(struct work_struct *work)
1265 struct sg_request *srp = container_of(work, struct sg_request, ew.work);
1266 struct sg_fd *sfp = srp->parentfp;
1268 sg_finish_rem_req(srp);
1269 kref_put(&sfp->f_ref, sg_remove_sfp);
1273 * This function is a "bottom half" handler that is called by the mid
1274 * level when a command is completed (or has failed).
1277 sg_rq_end_io(struct request *rq, int uptodate)
1279 struct sg_request *srp = rq->end_io_data;
1280 struct scsi_request *req = scsi_req(rq);
1283 unsigned long iflags;
1286 int result, resid, done = 1;
1288 if (WARN_ON(srp->done != 0))
1291 sfp = srp->parentfp;
1292 if (WARN_ON(sfp == NULL))
1295 sdp = sfp->parentdp;
1296 if (unlikely(atomic_read(&sdp->detaching)))
1297 pr_info("%s: device detaching\n", __func__);
1300 result = rq->errors;
1301 resid = req->resid_len;
1303 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sdp,
1304 "sg_cmd_done: pack_id=%d, res=0x%x\n",
1305 srp->header.pack_id, result));
1306 srp->header.resid = resid;
1307 ms = jiffies_to_msecs(jiffies);
1308 srp->header.duration = (ms > srp->header.duration) ?
1309 (ms - srp->header.duration) : 0;
1311 struct scsi_sense_hdr sshdr;
1313 srp->header.status = 0xff & result;
1314 srp->header.masked_status = status_byte(result);
1315 srp->header.msg_status = msg_byte(result);
1316 srp->header.host_status = host_byte(result);
1317 srp->header.driver_status = driver_byte(result);
1318 if ((sdp->sgdebug > 0) &&
1319 ((CHECK_CONDITION == srp->header.masked_status) ||
1320 (COMMAND_TERMINATED == srp->header.masked_status)))
1321 __scsi_print_sense(sdp->device, __func__, sense,
1322 SCSI_SENSE_BUFFERSIZE);
1324 /* Following if statement is a patch supplied by Eric Youngdale */
1325 if (driver_byte(result) != 0
1326 && scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, &sshdr)
1327 && !scsi_sense_is_deferred(&sshdr)
1328 && sshdr.sense_key == UNIT_ATTENTION
1329 && sdp->device->removable) {
1330 /* Detected possible disc change. Set the bit - this */
1331 /* may be used if there are filesystems using this device */
1332 sdp->device->changed = 1;
1337 memcpy(srp->sense_b, req->sense, SCSI_SENSE_BUFFERSIZE);
1339 /* Rely on write phase to clean out srp status values, so no "else" */
1342 * Free the request as soon as it is complete so that its resources
1343 * can be reused without waiting for userspace to read() the
1344 * result. But keep the associated bio (if any) around until
1345 * blk_rq_unmap_user() can be called from user context.
1348 scsi_req_free_cmd(scsi_req(rq));
1349 __blk_put_request(rq->q, rq);
1351 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1352 if (unlikely(srp->orphan)) {
1353 if (sfp->keep_orphan)
1354 srp->sg_io_owned = 0;
1359 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1362 /* Now wake up any sg_read() that is waiting for this
1365 wake_up_interruptible(&sfp->read_wait);
1366 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_IN);
1367 kref_put(&sfp->f_ref, sg_remove_sfp);
1369 INIT_WORK(&srp->ew.work, sg_rq_end_io_usercontext);
1370 schedule_work(&srp->ew.work);
1374 static const struct file_operations sg_fops = {
1375 .owner = THIS_MODULE,
1379 .unlocked_ioctl = sg_ioctl,
1380 #ifdef CONFIG_COMPAT
1381 .compat_ioctl = sg_compat_ioctl,
1385 .release = sg_release,
1386 .fasync = sg_fasync,
1387 .llseek = no_llseek,
1390 static struct class *sg_sysfs_class;
1392 static int sg_sysfs_valid = 0;
1395 sg_alloc(struct gendisk *disk, struct scsi_device *scsidp)
1397 struct request_queue *q = scsidp->request_queue;
1399 unsigned long iflags;
1403 sdp = kzalloc(sizeof(Sg_device), GFP_KERNEL);
1405 sdev_printk(KERN_WARNING, scsidp, "%s: kmalloc Sg_device "
1406 "failure\n", __func__);
1407 return ERR_PTR(-ENOMEM);
1410 idr_preload(GFP_KERNEL);
1411 write_lock_irqsave(&sg_index_lock, iflags);
1413 error = idr_alloc(&sg_index_idr, sdp, 0, SG_MAX_DEVS, GFP_NOWAIT);
1415 if (error == -ENOSPC) {
1416 sdev_printk(KERN_WARNING, scsidp,
1417 "Unable to attach sg device type=%d, minor number exceeds %d\n",
1418 scsidp->type, SG_MAX_DEVS - 1);
1421 sdev_printk(KERN_WARNING, scsidp, "%s: idr "
1422 "allocation Sg_device failure: %d\n",
1429 SCSI_LOG_TIMEOUT(3, sdev_printk(KERN_INFO, scsidp,
1430 "sg_alloc: dev=%d \n", k));
1431 sprintf(disk->disk_name, "sg%d", k);
1432 disk->first_minor = k;
1434 sdp->device = scsidp;
1435 mutex_init(&sdp->open_rel_lock);
1436 INIT_LIST_HEAD(&sdp->sfds);
1437 init_waitqueue_head(&sdp->open_wait);
1438 atomic_set(&sdp->detaching, 0);
1439 rwlock_init(&sdp->sfd_lock);
1440 sdp->sg_tablesize = queue_max_segments(q);
1442 kref_init(&sdp->d_ref);
1446 write_unlock_irqrestore(&sg_index_lock, iflags);
1451 return ERR_PTR(error);
1457 sg_add_device(struct device *cl_dev, struct class_interface *cl_intf)
1459 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
1460 struct gendisk *disk;
1461 Sg_device *sdp = NULL;
1462 struct cdev * cdev = NULL;
1464 unsigned long iflags;
1466 disk = alloc_disk(1);
1468 pr_warn("%s: alloc_disk failed\n", __func__);
1471 disk->major = SCSI_GENERIC_MAJOR;
1474 cdev = cdev_alloc();
1476 pr_warn("%s: cdev_alloc failed\n", __func__);
1479 cdev->owner = THIS_MODULE;
1480 cdev->ops = &sg_fops;
1482 sdp = sg_alloc(disk, scsidp);
1484 pr_warn("%s: sg_alloc failed\n", __func__);
1485 error = PTR_ERR(sdp);
1489 error = cdev_add(cdev, MKDEV(SCSI_GENERIC_MAJOR, sdp->index), 1);
1494 if (sg_sysfs_valid) {
1495 struct device *sg_class_member;
1497 sg_class_member = device_create(sg_sysfs_class, cl_dev->parent,
1498 MKDEV(SCSI_GENERIC_MAJOR,
1500 sdp, "%s", disk->disk_name);
1501 if (IS_ERR(sg_class_member)) {
1502 pr_err("%s: device_create failed\n", __func__);
1503 error = PTR_ERR(sg_class_member);
1506 error = sysfs_create_link(&scsidp->sdev_gendev.kobj,
1507 &sg_class_member->kobj, "generic");
1509 pr_err("%s: unable to make symlink 'generic' back "
1510 "to sg%d\n", __func__, sdp->index);
1512 pr_warn("%s: sg_sys Invalid\n", __func__);
1514 sdev_printk(KERN_NOTICE, scsidp, "Attached scsi generic sg%d "
1515 "type %d\n", sdp->index, scsidp->type);
1517 dev_set_drvdata(cl_dev, sdp);
1522 write_lock_irqsave(&sg_index_lock, iflags);
1523 idr_remove(&sg_index_idr, sdp->index);
1524 write_unlock_irqrestore(&sg_index_lock, iflags);
1535 sg_device_destroy(struct kref *kref)
1537 struct sg_device *sdp = container_of(kref, struct sg_device, d_ref);
1538 unsigned long flags;
1540 /* CAUTION! Note that the device can still be found via idr_find()
1541 * even though the refcount is 0. Therefore, do idr_remove() BEFORE
1542 * any other cleanup.
1545 write_lock_irqsave(&sg_index_lock, flags);
1546 idr_remove(&sg_index_idr, sdp->index);
1547 write_unlock_irqrestore(&sg_index_lock, flags);
1550 sg_printk(KERN_INFO, sdp, "sg_device_destroy\n"));
1552 put_disk(sdp->disk);
1557 sg_remove_device(struct device *cl_dev, struct class_interface *cl_intf)
1559 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
1560 Sg_device *sdp = dev_get_drvdata(cl_dev);
1561 unsigned long iflags;
1567 /* want sdp->detaching non-zero as soon as possible */
1568 val = atomic_inc_return(&sdp->detaching);
1570 return; /* only want to do following once per device */
1572 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
1575 read_lock_irqsave(&sdp->sfd_lock, iflags);
1576 list_for_each_entry(sfp, &sdp->sfds, sfd_siblings) {
1577 wake_up_interruptible_all(&sfp->read_wait);
1578 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_HUP);
1580 wake_up_interruptible_all(&sdp->open_wait);
1581 read_unlock_irqrestore(&sdp->sfd_lock, iflags);
1583 sysfs_remove_link(&scsidp->sdev_gendev.kobj, "generic");
1584 device_destroy(sg_sysfs_class, MKDEV(SCSI_GENERIC_MAJOR, sdp->index));
1585 cdev_del(sdp->cdev);
1588 kref_put(&sdp->d_ref, sg_device_destroy);
1591 module_param_named(scatter_elem_sz, scatter_elem_sz, int, S_IRUGO | S_IWUSR);
1592 module_param_named(def_reserved_size, def_reserved_size, int,
1594 module_param_named(allow_dio, sg_allow_dio, int, S_IRUGO | S_IWUSR);
1596 MODULE_AUTHOR("Douglas Gilbert");
1597 MODULE_DESCRIPTION("SCSI generic (sg) driver");
1598 MODULE_LICENSE("GPL");
1599 MODULE_VERSION(SG_VERSION_STR);
1600 MODULE_ALIAS_CHARDEV_MAJOR(SCSI_GENERIC_MAJOR);
1602 MODULE_PARM_DESC(scatter_elem_sz, "scatter gather element "
1603 "size (default: max(SG_SCATTER_SZ, PAGE_SIZE))");
1604 MODULE_PARM_DESC(def_reserved_size, "size of buffer reserved for each fd");
1605 MODULE_PARM_DESC(allow_dio, "allow direct I/O (default: 0 (disallow))");
1612 if (scatter_elem_sz < PAGE_SIZE) {
1613 scatter_elem_sz = PAGE_SIZE;
1614 scatter_elem_sz_prev = scatter_elem_sz;
1616 if (def_reserved_size >= 0)
1617 sg_big_buff = def_reserved_size;
1619 def_reserved_size = sg_big_buff;
1621 rc = register_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1625 sg_sysfs_class = class_create(THIS_MODULE, "scsi_generic");
1626 if ( IS_ERR(sg_sysfs_class) ) {
1627 rc = PTR_ERR(sg_sysfs_class);
1631 rc = scsi_register_interface(&sg_interface);
1633 #ifdef CONFIG_SCSI_PROC_FS
1635 #endif /* CONFIG_SCSI_PROC_FS */
1638 class_destroy(sg_sysfs_class);
1640 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0), SG_MAX_DEVS);
1647 #ifdef CONFIG_SCSI_PROC_FS
1649 #endif /* CONFIG_SCSI_PROC_FS */
1650 scsi_unregister_interface(&sg_interface);
1651 class_destroy(sg_sysfs_class);
1653 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1655 idr_destroy(&sg_index_idr);
1659 sg_start_req(Sg_request *srp, unsigned char *cmd)
1663 struct scsi_request *req;
1664 Sg_fd *sfp = srp->parentfp;
1665 sg_io_hdr_t *hp = &srp->header;
1666 int dxfer_len = (int) hp->dxfer_len;
1667 int dxfer_dir = hp->dxfer_direction;
1668 unsigned int iov_count = hp->iovec_count;
1669 Sg_scatter_hold *req_schp = &srp->data;
1670 Sg_scatter_hold *rsv_schp = &sfp->reserve;
1671 struct request_queue *q = sfp->parentdp->device->request_queue;
1672 struct rq_map_data *md, map_data;
1673 int rw = hp->dxfer_direction == SG_DXFER_TO_DEV ? WRITE : READ;
1674 unsigned char *long_cmdp = NULL;
1676 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1677 "sg_start_req: dxfer_len=%d\n",
1680 if (hp->cmd_len > BLK_MAX_CDB) {
1681 long_cmdp = kzalloc(hp->cmd_len, GFP_KERNEL);
1689 * With scsi-mq enabled, there are a fixed number of preallocated
1690 * requests equal in number to shost->can_queue. If all of the
1691 * preallocated requests are already in use, then using GFP_ATOMIC with
1692 * blk_get_request() will return -EWOULDBLOCK, whereas using GFP_KERNEL
1693 * will cause blk_get_request() to sleep until an active command
1694 * completes, freeing up a request. Neither option is ideal, but
1695 * GFP_KERNEL is the better choice to prevent userspace from getting an
1696 * unexpected EWOULDBLOCK.
1698 * With scsi-mq disabled, blk_get_request() with GFP_KERNEL usually
1699 * does not sleep except under memory pressure.
1701 rq = blk_get_request(q, hp->dxfer_direction == SG_DXFER_TO_DEV ?
1702 REQ_OP_SCSI_OUT : REQ_OP_SCSI_IN, GFP_KERNEL);
1711 if (hp->cmd_len > BLK_MAX_CDB)
1712 req->cmd = long_cmdp;
1713 memcpy(req->cmd, cmd, hp->cmd_len);
1714 req->cmd_len = hp->cmd_len;
1717 rq->end_io_data = srp;
1718 rq->retries = SG_DEFAULT_RETRIES;
1720 if ((dxfer_len <= 0) || (dxfer_dir == SG_DXFER_NONE))
1723 if (sg_allow_dio && hp->flags & SG_FLAG_DIRECT_IO &&
1724 dxfer_dir != SG_DXFER_UNKNOWN && !iov_count &&
1725 !sfp->parentdp->device->host->unchecked_isa_dma &&
1726 blk_rq_aligned(q, (unsigned long)hp->dxferp, dxfer_len))
1732 if (!sg_res_in_use(sfp) && dxfer_len <= rsv_schp->bufflen)
1733 sg_link_reserve(sfp, srp, dxfer_len);
1735 res = sg_build_indirect(req_schp, sfp, dxfer_len);
1740 md->pages = req_schp->pages;
1741 md->page_order = req_schp->page_order;
1742 md->nr_entries = req_schp->k_use_sg;
1744 md->null_mapped = hp->dxferp ? 0 : 1;
1745 if (dxfer_dir == SG_DXFER_TO_FROM_DEV)
1752 struct iovec *iov = NULL;
1755 res = import_iovec(rw, hp->dxferp, iov_count, 0, &iov, &i);
1759 iov_iter_truncate(&i, hp->dxfer_len);
1760 if (!iov_iter_count(&i)) {
1765 res = blk_rq_map_user_iov(q, rq, md, &i, GFP_ATOMIC);
1768 res = blk_rq_map_user(q, rq, md, hp->dxferp,
1769 hp->dxfer_len, GFP_ATOMIC);
1775 req_schp->dio_in_use = 1;
1776 hp->info |= SG_INFO_DIRECT_IO;
1783 sg_finish_rem_req(Sg_request *srp)
1787 Sg_fd *sfp = srp->parentfp;
1788 Sg_scatter_hold *req_schp = &srp->data;
1790 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1791 "sg_finish_rem_req: res_used=%d\n",
1792 (int) srp->res_used));
1794 ret = blk_rq_unmap_user(srp->bio);
1797 scsi_req_free_cmd(scsi_req(srp->rq));
1798 blk_put_request(srp->rq);
1802 sg_unlink_reserve(sfp, srp);
1804 sg_remove_scat(sfp, req_schp);
1806 sg_remove_request(sfp, srp);
1812 sg_build_sgat(Sg_scatter_hold * schp, const Sg_fd * sfp, int tablesize)
1814 int sg_bufflen = tablesize * sizeof(struct page *);
1815 gfp_t gfp_flags = GFP_ATOMIC | __GFP_NOWARN;
1817 schp->pages = kzalloc(sg_bufflen, gfp_flags);
1820 schp->sglist_len = sg_bufflen;
1821 return tablesize; /* number of scat_gath elements allocated */
1825 sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size)
1827 int ret_sz = 0, i, k, rem_sz, num, mx_sc_elems;
1828 int sg_tablesize = sfp->parentdp->sg_tablesize;
1829 int blk_size = buff_size, order;
1830 gfp_t gfp_mask = GFP_ATOMIC | __GFP_COMP | __GFP_NOWARN;
1835 ++blk_size; /* don't know why */
1836 /* round request up to next highest SG_SECTOR_SZ byte boundary */
1837 blk_size = ALIGN(blk_size, SG_SECTOR_SZ);
1838 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1839 "sg_build_indirect: buff_size=%d, blk_size=%d\n",
1840 buff_size, blk_size));
1842 /* N.B. ret_sz carried into this block ... */
1843 mx_sc_elems = sg_build_sgat(schp, sfp, sg_tablesize);
1844 if (mx_sc_elems < 0)
1845 return mx_sc_elems; /* most likely -ENOMEM */
1847 num = scatter_elem_sz;
1848 if (unlikely(num != scatter_elem_sz_prev)) {
1849 if (num < PAGE_SIZE) {
1850 scatter_elem_sz = PAGE_SIZE;
1851 scatter_elem_sz_prev = PAGE_SIZE;
1853 scatter_elem_sz_prev = num;
1857 gfp_mask |= GFP_DMA;
1859 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
1860 gfp_mask |= __GFP_ZERO;
1862 order = get_order(num);
1864 ret_sz = 1 << (PAGE_SHIFT + order);
1866 for (k = 0, rem_sz = blk_size; rem_sz > 0 && k < mx_sc_elems;
1867 k++, rem_sz -= ret_sz) {
1869 num = (rem_sz > scatter_elem_sz_prev) ?
1870 scatter_elem_sz_prev : rem_sz;
1872 schp->pages[k] = alloc_pages(gfp_mask, order);
1873 if (!schp->pages[k])
1876 if (num == scatter_elem_sz_prev) {
1877 if (unlikely(ret_sz > scatter_elem_sz_prev)) {
1878 scatter_elem_sz = ret_sz;
1879 scatter_elem_sz_prev = ret_sz;
1883 SCSI_LOG_TIMEOUT(5, sg_printk(KERN_INFO, sfp->parentdp,
1884 "sg_build_indirect: k=%d, num=%d, ret_sz=%d\n",
1886 } /* end of for loop */
1888 schp->page_order = order;
1890 SCSI_LOG_TIMEOUT(5, sg_printk(KERN_INFO, sfp->parentdp,
1891 "sg_build_indirect: k_use_sg=%d, rem_sz=%d\n",
1894 schp->bufflen = blk_size;
1895 if (rem_sz > 0) /* must have failed */
1899 for (i = 0; i < k; i++)
1900 __free_pages(schp->pages[i], order);
1909 sg_remove_scat(Sg_fd * sfp, Sg_scatter_hold * schp)
1911 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1912 "sg_remove_scat: k_use_sg=%d\n", schp->k_use_sg));
1913 if (schp->pages && schp->sglist_len > 0) {
1914 if (!schp->dio_in_use) {
1917 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
1919 sg_printk(KERN_INFO, sfp->parentdp,
1920 "sg_remove_scat: k=%d, pg=0x%p\n",
1921 k, schp->pages[k]));
1922 __free_pages(schp->pages[k], schp->page_order);
1928 memset(schp, 0, sizeof (*schp));
1932 sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer)
1934 Sg_scatter_hold *schp = &srp->data;
1937 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, srp->parentfp->parentdp,
1938 "sg_read_oxfer: num_read_xfer=%d\n",
1940 if ((!outp) || (num_read_xfer <= 0))
1943 num = 1 << (PAGE_SHIFT + schp->page_order);
1944 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
1945 if (num > num_read_xfer) {
1946 if (__copy_to_user(outp, page_address(schp->pages[k]),
1951 if (__copy_to_user(outp, page_address(schp->pages[k]),
1954 num_read_xfer -= num;
1955 if (num_read_xfer <= 0)
1965 sg_build_reserve(Sg_fd * sfp, int req_size)
1967 Sg_scatter_hold *schp = &sfp->reserve;
1969 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1970 "sg_build_reserve: req_size=%d\n", req_size));
1972 if (req_size < PAGE_SIZE)
1973 req_size = PAGE_SIZE;
1974 if (0 == sg_build_indirect(schp, sfp, req_size))
1977 sg_remove_scat(sfp, schp);
1978 req_size >>= 1; /* divide by 2 */
1979 } while (req_size > (PAGE_SIZE / 2));
1983 sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size)
1985 Sg_scatter_hold *req_schp = &srp->data;
1986 Sg_scatter_hold *rsv_schp = &sfp->reserve;
1990 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1991 "sg_link_reserve: size=%d\n", size));
1994 num = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1995 for (k = 0; k < rsv_schp->k_use_sg; k++) {
1997 req_schp->k_use_sg = k + 1;
1998 req_schp->sglist_len = rsv_schp->sglist_len;
1999 req_schp->pages = rsv_schp->pages;
2001 req_schp->bufflen = size;
2002 req_schp->page_order = rsv_schp->page_order;
2008 if (k >= rsv_schp->k_use_sg)
2009 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO, sfp->parentdp,
2010 "sg_link_reserve: BAD size\n"));
2014 sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp)
2016 Sg_scatter_hold *req_schp = &srp->data;
2018 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, srp->parentfp->parentdp,
2019 "sg_unlink_reserve: req->k_use_sg=%d\n",
2020 (int) req_schp->k_use_sg));
2021 req_schp->k_use_sg = 0;
2022 req_schp->bufflen = 0;
2023 req_schp->pages = NULL;
2024 req_schp->page_order = 0;
2025 req_schp->sglist_len = 0;
2026 sfp->save_scat_len = 0;
2031 sg_get_rq_mark(Sg_fd * sfp, int pack_id)
2034 unsigned long iflags;
2036 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2037 for (resp = sfp->headrp; resp; resp = resp->nextrp) {
2038 /* look for requests that are ready + not SG_IO owned */
2039 if ((1 == resp->done) && (!resp->sg_io_owned) &&
2040 ((-1 == pack_id) || (resp->header.pack_id == pack_id))) {
2041 resp->done = 2; /* guard against other readers */
2045 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2049 /* always adds to end of list */
2051 sg_add_request(Sg_fd * sfp)
2054 unsigned long iflags;
2056 Sg_request *rp = sfp->req_arr;
2058 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2061 memset(rp, 0, sizeof (Sg_request));
2066 if (0 == sfp->cmd_q)
2067 resp = NULL; /* command queuing disallowed */
2069 for (k = 0; k < SG_MAX_QUEUE; ++k, ++rp) {
2073 if (k < SG_MAX_QUEUE) {
2074 memset(rp, 0, sizeof (Sg_request));
2076 while (resp->nextrp)
2077 resp = resp->nextrp;
2085 resp->nextrp = NULL;
2086 resp->header.duration = jiffies_to_msecs(jiffies);
2088 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2092 /* Return of 1 for found; 0 for not found */
2094 sg_remove_request(Sg_fd * sfp, Sg_request * srp)
2096 Sg_request *prev_rp;
2098 unsigned long iflags;
2101 if ((!sfp) || (!srp) || (!sfp->headrp))
2103 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2104 prev_rp = sfp->headrp;
2105 if (srp == prev_rp) {
2106 sfp->headrp = prev_rp->nextrp;
2107 prev_rp->parentfp = NULL;
2110 while ((rp = prev_rp->nextrp)) {
2112 prev_rp->nextrp = rp->nextrp;
2113 rp->parentfp = NULL;
2120 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2125 sg_add_sfp(Sg_device * sdp)
2128 unsigned long iflags;
2131 sfp = kzalloc(sizeof(*sfp), GFP_ATOMIC | __GFP_NOWARN);
2133 return ERR_PTR(-ENOMEM);
2135 init_waitqueue_head(&sfp->read_wait);
2136 rwlock_init(&sfp->rq_list_lock);
2138 kref_init(&sfp->f_ref);
2139 sfp->timeout = SG_DEFAULT_TIMEOUT;
2140 sfp->timeout_user = SG_DEFAULT_TIMEOUT_USER;
2141 sfp->force_packid = SG_DEF_FORCE_PACK_ID;
2142 sfp->low_dma = (SG_DEF_FORCE_LOW_DMA == 0) ?
2143 sdp->device->host->unchecked_isa_dma : 1;
2144 sfp->cmd_q = SG_DEF_COMMAND_Q;
2145 sfp->keep_orphan = SG_DEF_KEEP_ORPHAN;
2146 sfp->parentdp = sdp;
2147 write_lock_irqsave(&sdp->sfd_lock, iflags);
2148 if (atomic_read(&sdp->detaching)) {
2149 write_unlock_irqrestore(&sdp->sfd_lock, iflags);
2150 return ERR_PTR(-ENODEV);
2152 list_add_tail(&sfp->sfd_siblings, &sdp->sfds);
2153 write_unlock_irqrestore(&sdp->sfd_lock, iflags);
2154 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
2155 "sg_add_sfp: sfp=0x%p\n", sfp));
2156 if (unlikely(sg_big_buff != def_reserved_size))
2157 sg_big_buff = def_reserved_size;
2159 bufflen = min_t(int, sg_big_buff,
2160 max_sectors_bytes(sdp->device->request_queue));
2161 sg_build_reserve(sfp, bufflen);
2162 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
2163 "sg_add_sfp: bufflen=%d, k_use_sg=%d\n",
2164 sfp->reserve.bufflen,
2165 sfp->reserve.k_use_sg));
2167 kref_get(&sdp->d_ref);
2168 __module_get(THIS_MODULE);
2173 sg_remove_sfp_usercontext(struct work_struct *work)
2175 struct sg_fd *sfp = container_of(work, struct sg_fd, ew.work);
2176 struct sg_device *sdp = sfp->parentdp;
2178 /* Cleanup any responses which were never read(). */
2180 sg_finish_rem_req(sfp->headrp);
2182 if (sfp->reserve.bufflen > 0) {
2183 SCSI_LOG_TIMEOUT(6, sg_printk(KERN_INFO, sdp,
2184 "sg_remove_sfp: bufflen=%d, k_use_sg=%d\n",
2185 (int) sfp->reserve.bufflen,
2186 (int) sfp->reserve.k_use_sg));
2187 sg_remove_scat(sfp, &sfp->reserve);
2190 SCSI_LOG_TIMEOUT(6, sg_printk(KERN_INFO, sdp,
2191 "sg_remove_sfp: sfp=0x%p\n", sfp));
2194 scsi_device_put(sdp->device);
2195 kref_put(&sdp->d_ref, sg_device_destroy);
2196 module_put(THIS_MODULE);
2200 sg_remove_sfp(struct kref *kref)
2202 struct sg_fd *sfp = container_of(kref, struct sg_fd, f_ref);
2203 struct sg_device *sdp = sfp->parentdp;
2204 unsigned long iflags;
2206 write_lock_irqsave(&sdp->sfd_lock, iflags);
2207 list_del(&sfp->sfd_siblings);
2208 write_unlock_irqrestore(&sdp->sfd_lock, iflags);
2210 INIT_WORK(&sfp->ew.work, sg_remove_sfp_usercontext);
2211 schedule_work(&sfp->ew.work);
2215 sg_res_in_use(Sg_fd * sfp)
2217 const Sg_request *srp;
2218 unsigned long iflags;
2220 read_lock_irqsave(&sfp->rq_list_lock, iflags);
2221 for (srp = sfp->headrp; srp; srp = srp->nextrp)
2224 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2228 #ifdef CONFIG_SCSI_PROC_FS
2230 sg_idr_max_id(int id, void *p, void *data)
2244 unsigned long iflags;
2246 read_lock_irqsave(&sg_index_lock, iflags);
2247 idr_for_each(&sg_index_idr, sg_idr_max_id, &k);
2248 read_unlock_irqrestore(&sg_index_lock, iflags);
2249 return k + 1; /* origin 1 */
2253 /* must be called with sg_index_lock held */
2254 static Sg_device *sg_lookup_dev(int dev)
2256 return idr_find(&sg_index_idr, dev);
2262 struct sg_device *sdp;
2263 unsigned long flags;
2265 read_lock_irqsave(&sg_index_lock, flags);
2266 sdp = sg_lookup_dev(dev);
2268 sdp = ERR_PTR(-ENXIO);
2269 else if (atomic_read(&sdp->detaching)) {
2270 /* If sdp->detaching, then the refcount may already be 0, in
2271 * which case it would be a bug to do kref_get().
2273 sdp = ERR_PTR(-ENODEV);
2275 kref_get(&sdp->d_ref);
2276 read_unlock_irqrestore(&sg_index_lock, flags);
2281 #ifdef CONFIG_SCSI_PROC_FS
2283 static struct proc_dir_entry *sg_proc_sgp = NULL;
2285 static char sg_proc_sg_dirname[] = "scsi/sg";
2287 static int sg_proc_seq_show_int(struct seq_file *s, void *v);
2289 static int sg_proc_single_open_adio(struct inode *inode, struct file *file);
2290 static ssize_t sg_proc_write_adio(struct file *filp, const char __user *buffer,
2291 size_t count, loff_t *off);
2292 static const struct file_operations adio_fops = {
2293 .owner = THIS_MODULE,
2294 .open = sg_proc_single_open_adio,
2296 .llseek = seq_lseek,
2297 .write = sg_proc_write_adio,
2298 .release = single_release,
2301 static int sg_proc_single_open_dressz(struct inode *inode, struct file *file);
2302 static ssize_t sg_proc_write_dressz(struct file *filp,
2303 const char __user *buffer, size_t count, loff_t *off);
2304 static const struct file_operations dressz_fops = {
2305 .owner = THIS_MODULE,
2306 .open = sg_proc_single_open_dressz,
2308 .llseek = seq_lseek,
2309 .write = sg_proc_write_dressz,
2310 .release = single_release,
2313 static int sg_proc_seq_show_version(struct seq_file *s, void *v);
2314 static int sg_proc_single_open_version(struct inode *inode, struct file *file);
2315 static const struct file_operations version_fops = {
2316 .owner = THIS_MODULE,
2317 .open = sg_proc_single_open_version,
2319 .llseek = seq_lseek,
2320 .release = single_release,
2323 static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v);
2324 static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file);
2325 static const struct file_operations devhdr_fops = {
2326 .owner = THIS_MODULE,
2327 .open = sg_proc_single_open_devhdr,
2329 .llseek = seq_lseek,
2330 .release = single_release,
2333 static int sg_proc_seq_show_dev(struct seq_file *s, void *v);
2334 static int sg_proc_open_dev(struct inode *inode, struct file *file);
2335 static void * dev_seq_start(struct seq_file *s, loff_t *pos);
2336 static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos);
2337 static void dev_seq_stop(struct seq_file *s, void *v);
2338 static const struct file_operations dev_fops = {
2339 .owner = THIS_MODULE,
2340 .open = sg_proc_open_dev,
2342 .llseek = seq_lseek,
2343 .release = seq_release,
2345 static const struct seq_operations dev_seq_ops = {
2346 .start = dev_seq_start,
2347 .next = dev_seq_next,
2348 .stop = dev_seq_stop,
2349 .show = sg_proc_seq_show_dev,
2352 static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v);
2353 static int sg_proc_open_devstrs(struct inode *inode, struct file *file);
2354 static const struct file_operations devstrs_fops = {
2355 .owner = THIS_MODULE,
2356 .open = sg_proc_open_devstrs,
2358 .llseek = seq_lseek,
2359 .release = seq_release,
2361 static const struct seq_operations devstrs_seq_ops = {
2362 .start = dev_seq_start,
2363 .next = dev_seq_next,
2364 .stop = dev_seq_stop,
2365 .show = sg_proc_seq_show_devstrs,
2368 static int sg_proc_seq_show_debug(struct seq_file *s, void *v);
2369 static int sg_proc_open_debug(struct inode *inode, struct file *file);
2370 static const struct file_operations debug_fops = {
2371 .owner = THIS_MODULE,
2372 .open = sg_proc_open_debug,
2374 .llseek = seq_lseek,
2375 .release = seq_release,
2377 static const struct seq_operations debug_seq_ops = {
2378 .start = dev_seq_start,
2379 .next = dev_seq_next,
2380 .stop = dev_seq_stop,
2381 .show = sg_proc_seq_show_debug,
2385 struct sg_proc_leaf {
2387 const struct file_operations * fops;
2390 static const struct sg_proc_leaf sg_proc_leaf_arr[] = {
2391 {"allow_dio", &adio_fops},
2392 {"debug", &debug_fops},
2393 {"def_reserved_size", &dressz_fops},
2394 {"device_hdr", &devhdr_fops},
2395 {"devices", &dev_fops},
2396 {"device_strs", &devstrs_fops},
2397 {"version", &version_fops}
2403 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
2406 sg_proc_sgp = proc_mkdir(sg_proc_sg_dirname, NULL);
2409 for (k = 0; k < num_leaves; ++k) {
2410 const struct sg_proc_leaf *leaf = &sg_proc_leaf_arr[k];
2411 umode_t mask = leaf->fops->write ? S_IRUGO | S_IWUSR : S_IRUGO;
2412 proc_create(leaf->name, mask, sg_proc_sgp, leaf->fops);
2418 sg_proc_cleanup(void)
2421 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
2425 for (k = 0; k < num_leaves; ++k)
2426 remove_proc_entry(sg_proc_leaf_arr[k].name, sg_proc_sgp);
2427 remove_proc_entry(sg_proc_sg_dirname, NULL);
2431 static int sg_proc_seq_show_int(struct seq_file *s, void *v)
2433 seq_printf(s, "%d\n", *((int *)s->private));
2437 static int sg_proc_single_open_adio(struct inode *inode, struct file *file)
2439 return single_open(file, sg_proc_seq_show_int, &sg_allow_dio);
2443 sg_proc_write_adio(struct file *filp, const char __user *buffer,
2444 size_t count, loff_t *off)
2449 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2451 err = kstrtoul_from_user(buffer, count, 0, &num);
2454 sg_allow_dio = num ? 1 : 0;
2458 static int sg_proc_single_open_dressz(struct inode *inode, struct file *file)
2460 return single_open(file, sg_proc_seq_show_int, &sg_big_buff);
2464 sg_proc_write_dressz(struct file *filp, const char __user *buffer,
2465 size_t count, loff_t *off)
2468 unsigned long k = ULONG_MAX;
2470 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2473 err = kstrtoul_from_user(buffer, count, 0, &k);
2476 if (k <= 1048576) { /* limit "big buff" to 1 MB */
2483 static int sg_proc_seq_show_version(struct seq_file *s, void *v)
2485 seq_printf(s, "%d\t%s [%s]\n", sg_version_num, SG_VERSION_STR,
2490 static int sg_proc_single_open_version(struct inode *inode, struct file *file)
2492 return single_open(file, sg_proc_seq_show_version, NULL);
2495 static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v)
2497 seq_puts(s, "host\tchan\tid\tlun\ttype\topens\tqdepth\tbusy\tonline\n");
2501 static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file)
2503 return single_open(file, sg_proc_seq_show_devhdr, NULL);
2506 struct sg_proc_deviter {
2511 static void * dev_seq_start(struct seq_file *s, loff_t *pos)
2513 struct sg_proc_deviter * it = kmalloc(sizeof(*it), GFP_KERNEL);
2520 it->max = sg_last_dev();
2521 if (it->index >= it->max)
2526 static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos)
2528 struct sg_proc_deviter * it = s->private;
2531 return (it->index < it->max) ? it : NULL;
2534 static void dev_seq_stop(struct seq_file *s, void *v)
2539 static int sg_proc_open_dev(struct inode *inode, struct file *file)
2541 return seq_open(file, &dev_seq_ops);
2544 static int sg_proc_seq_show_dev(struct seq_file *s, void *v)
2546 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2548 struct scsi_device *scsidp;
2549 unsigned long iflags;
2551 read_lock_irqsave(&sg_index_lock, iflags);
2552 sdp = it ? sg_lookup_dev(it->index) : NULL;
2553 if ((NULL == sdp) || (NULL == sdp->device) ||
2554 (atomic_read(&sdp->detaching)))
2555 seq_puts(s, "-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\n");
2557 scsidp = sdp->device;
2558 seq_printf(s, "%d\t%d\t%d\t%llu\t%d\t%d\t%d\t%d\t%d\n",
2559 scsidp->host->host_no, scsidp->channel,
2560 scsidp->id, scsidp->lun, (int) scsidp->type,
2562 (int) scsidp->queue_depth,
2563 (int) atomic_read(&scsidp->device_busy),
2564 (int) scsi_device_online(scsidp));
2566 read_unlock_irqrestore(&sg_index_lock, iflags);
2570 static int sg_proc_open_devstrs(struct inode *inode, struct file *file)
2572 return seq_open(file, &devstrs_seq_ops);
2575 static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v)
2577 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2579 struct scsi_device *scsidp;
2580 unsigned long iflags;
2582 read_lock_irqsave(&sg_index_lock, iflags);
2583 sdp = it ? sg_lookup_dev(it->index) : NULL;
2584 scsidp = sdp ? sdp->device : NULL;
2585 if (sdp && scsidp && (!atomic_read(&sdp->detaching)))
2586 seq_printf(s, "%8.8s\t%16.16s\t%4.4s\n",
2587 scsidp->vendor, scsidp->model, scsidp->rev);
2589 seq_puts(s, "<no active device>\n");
2590 read_unlock_irqrestore(&sg_index_lock, iflags);
2594 /* must be called while holding sg_index_lock */
2595 static void sg_proc_debug_helper(struct seq_file *s, Sg_device * sdp)
2597 int k, m, new_interface, blen, usg;
2600 const sg_io_hdr_t *hp;
2605 list_for_each_entry(fp, &sdp->sfds, sfd_siblings) {
2607 read_lock(&fp->rq_list_lock); /* irqs already disabled */
2608 seq_printf(s, " FD(%d): timeout=%dms bufflen=%d "
2609 "(res)sgat=%d low_dma=%d\n", k,
2610 jiffies_to_msecs(fp->timeout),
2611 fp->reserve.bufflen,
2612 (int) fp->reserve.k_use_sg,
2614 seq_printf(s, " cmd_q=%d f_packid=%d k_orphan=%d closed=0\n",
2615 (int) fp->cmd_q, (int) fp->force_packid,
2616 (int) fp->keep_orphan);
2617 for (m = 0, srp = fp->headrp;
2619 ++m, srp = srp->nextrp) {
2621 new_interface = (hp->interface_id == '\0') ? 0 : 1;
2622 if (srp->res_used) {
2623 if (new_interface &&
2624 (SG_FLAG_MMAP_IO & hp->flags))
2629 if (SG_INFO_DIRECT_IO_MASK & hp->info)
2635 blen = srp->data.bufflen;
2636 usg = srp->data.k_use_sg;
2637 seq_puts(s, srp->done ?
2638 ((1 == srp->done) ? "rcv:" : "fin:")
2640 seq_printf(s, " id=%d blen=%d",
2641 srp->header.pack_id, blen);
2643 seq_printf(s, " dur=%d", hp->duration);
2645 ms = jiffies_to_msecs(jiffies);
2646 seq_printf(s, " t_o/elap=%d/%d",
2647 (new_interface ? hp->timeout :
2648 jiffies_to_msecs(fp->timeout)),
2649 (ms > hp->duration ? ms - hp->duration : 0));
2651 seq_printf(s, "ms sgat=%d op=0x%02x\n", usg,
2652 (int) srp->data.cmd_opcode);
2655 seq_puts(s, " No requests active\n");
2656 read_unlock(&fp->rq_list_lock);
2660 static int sg_proc_open_debug(struct inode *inode, struct file *file)
2662 return seq_open(file, &debug_seq_ops);
2665 static int sg_proc_seq_show_debug(struct seq_file *s, void *v)
2667 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2669 unsigned long iflags;
2671 if (it && (0 == it->index))
2672 seq_printf(s, "max_active_device=%d def_reserved_size=%d\n",
2673 (int)it->max, sg_big_buff);
2675 read_lock_irqsave(&sg_index_lock, iflags);
2676 sdp = it ? sg_lookup_dev(it->index) : NULL;
2679 read_lock(&sdp->sfd_lock);
2680 if (!list_empty(&sdp->sfds)) {
2681 seq_printf(s, " >>> device=%s ", sdp->disk->disk_name);
2682 if (atomic_read(&sdp->detaching))
2683 seq_puts(s, "detaching pending close ");
2684 else if (sdp->device) {
2685 struct scsi_device *scsidp = sdp->device;
2687 seq_printf(s, "%d:%d:%d:%llu em=%d",
2688 scsidp->host->host_no,
2689 scsidp->channel, scsidp->id,
2691 scsidp->host->hostt->emulated);
2693 seq_printf(s, " sg_tablesize=%d excl=%d open_cnt=%d\n",
2694 sdp->sg_tablesize, sdp->exclude, sdp->open_cnt);
2695 sg_proc_debug_helper(s, sdp);
2697 read_unlock(&sdp->sfd_lock);
2699 read_unlock_irqrestore(&sg_index_lock, iflags);
2703 #endif /* CONFIG_SCSI_PROC_FS */
2705 module_init(init_sg);
2706 module_exit(exit_sg);