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
83 * Suppose you want to calculate the formula muldiv(x,m,d)=int(x * m / d)
84 * Then when using 32 bit integers x * m may overflow during the calculation.
85 * Replacing muldiv(x) by muldiv(x)=((x % d) * m) / d + int(x / d) * m
86 * calculates the same, but prevents the overflow when both m and d
87 * are "small" numbers (like HZ and USER_HZ).
88 * Of course an overflow is inavoidable if the result of muldiv doesn't fit
91 #define MULDIV(X,MUL,DIV) ((((X % DIV) * MUL) / DIV) + ((X / DIV) * MUL))
93 #define SG_DEFAULT_TIMEOUT MULDIV(SG_DEFAULT_TIMEOUT_USER, HZ, USER_HZ)
95 int sg_big_buff = SG_DEF_RESERVED_SIZE;
96 /* N.B. This variable is readable and writeable via
97 /proc/scsi/sg/def_reserved_size . Each time sg_open() is called a buffer
98 of this size (or less if there is not enough memory) will be reserved
99 for use by this file descriptor. [Deprecated usage: this variable is also
100 readable via /proc/sys/kernel/sg-big-buff if the sg driver is built into
101 the kernel (i.e. it is not a module).] */
102 static int def_reserved_size = -1; /* picks up init parameter */
103 static int sg_allow_dio = SG_ALLOW_DIO_DEF;
105 static int scatter_elem_sz = SG_SCATTER_SZ;
106 static int scatter_elem_sz_prev = SG_SCATTER_SZ;
108 #define SG_SECTOR_SZ 512
110 static int sg_add_device(struct device *, struct class_interface *);
111 static void sg_remove_device(struct device *, struct class_interface *);
113 static DEFINE_IDR(sg_index_idr);
114 static DEFINE_RWLOCK(sg_index_lock); /* Also used to lock
115 file descriptor list for device */
117 static struct class_interface sg_interface = {
118 .add_dev = sg_add_device,
119 .remove_dev = sg_remove_device,
122 typedef struct sg_scatter_hold { /* holding area for scsi scatter gather info */
123 unsigned short k_use_sg; /* Count of kernel scatter-gather pieces */
124 unsigned sglist_len; /* size of malloc'd scatter-gather list ++ */
125 unsigned bufflen; /* Size of (aggregate) data buffer */
128 char dio_in_use; /* 0->indirect IO (or mmap), 1->dio */
129 unsigned char cmd_opcode; /* first byte of command */
132 struct sg_device; /* forward declarations */
135 typedef struct sg_request { /* SG_MAX_QUEUE requests outstanding per file */
136 struct sg_request *nextrp; /* NULL -> tail request (slist) */
137 struct sg_fd *parentfp; /* NULL -> not in use */
138 Sg_scatter_hold data; /* hold buffer, perhaps scatter list */
139 sg_io_hdr_t header; /* scsi command+info, see <scsi/sg.h> */
140 unsigned char sense_b[SCSI_SENSE_BUFFERSIZE];
141 char res_used; /* 1 -> using reserve buffer, 0 -> not ... */
142 char orphan; /* 1 -> drop on sight, 0 -> normal */
143 char sg_io_owned; /* 1 -> packet belongs to SG_IO */
144 /* done protected by rq_list_lock */
145 char done; /* 0->before bh, 1->before read, 2->read */
148 struct execute_work ew;
151 typedef struct sg_fd { /* holds the state of a file descriptor */
152 struct list_head sfd_siblings; /* protected by device's sfd_lock */
153 struct sg_device *parentdp; /* owning device */
154 wait_queue_head_t read_wait; /* queue read until command done */
155 rwlock_t rq_list_lock; /* protect access to list in req_arr */
156 int timeout; /* defaults to SG_DEFAULT_TIMEOUT */
157 int timeout_user; /* defaults to SG_DEFAULT_TIMEOUT_USER */
158 Sg_scatter_hold reserve; /* buffer held for this file descriptor */
159 unsigned save_scat_len; /* original length of trunc. scat. element */
160 Sg_request *headrp; /* head of request slist, NULL->empty */
161 struct fasync_struct *async_qp; /* used by asynchronous notification */
162 Sg_request req_arr[SG_MAX_QUEUE]; /* used as singly-linked list */
163 char low_dma; /* as in parent but possibly overridden to 1 */
164 char force_packid; /* 1 -> pack_id input to read(), 0 -> ignored */
165 char cmd_q; /* 1 -> allow command queuing, 0 -> don't */
166 unsigned char next_cmd_len; /* 0: automatic, >0: use on next write() */
167 char keep_orphan; /* 0 -> drop orphan (def), 1 -> keep for read() */
168 char mmap_called; /* 0 -> mmap() never called on this fd */
170 struct execute_work ew;
173 typedef struct sg_device { /* holds the state of each scsi generic device */
174 struct scsi_device *device;
175 wait_queue_head_t open_wait; /* queue open() when O_EXCL present */
176 struct mutex open_rel_lock; /* held when in open() or release() */
177 int sg_tablesize; /* adapter's max scatter-gather table size */
178 u32 index; /* device index number */
179 struct list_head sfds;
180 rwlock_t sfd_lock; /* protect access to sfd list */
181 atomic_t detaching; /* 0->device usable, 1->device detaching */
182 bool exclude; /* 1->open(O_EXCL) succeeded and is active */
183 int open_cnt; /* count of opens (perhaps < num(sfds) ) */
184 char sgdebug; /* 0->off, 1->sense, 9->dump dev, 10-> all devs */
185 struct gendisk *disk;
186 struct cdev * cdev; /* char_dev [sysfs: /sys/cdev/major/sg<n>] */
190 /* tasklet or soft irq callback */
191 static void sg_rq_end_io(struct request *rq, int uptodate);
192 static int sg_start_req(Sg_request *srp, unsigned char *cmd);
193 static int sg_finish_rem_req(Sg_request * srp);
194 static int sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size);
195 static ssize_t sg_new_read(Sg_fd * sfp, char __user *buf, size_t count,
197 static ssize_t sg_new_write(Sg_fd *sfp, struct file *file,
198 const char __user *buf, size_t count, int blocking,
199 int read_only, int sg_io_owned, Sg_request **o_srp);
200 static int sg_common_write(Sg_fd * sfp, Sg_request * srp,
201 unsigned char *cmnd, int timeout, int blocking);
202 static int sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer);
203 static void sg_remove_scat(Sg_fd * sfp, Sg_scatter_hold * schp);
204 static void sg_build_reserve(Sg_fd * sfp, int req_size);
205 static void sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size);
206 static void sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp);
207 static Sg_fd *sg_add_sfp(Sg_device * sdp);
208 static void sg_remove_sfp(struct kref *);
209 static Sg_request *sg_get_rq_mark(Sg_fd * sfp, int pack_id);
210 static Sg_request *sg_add_request(Sg_fd * sfp);
211 static int sg_remove_request(Sg_fd * sfp, Sg_request * srp);
212 static int sg_res_in_use(Sg_fd * sfp);
213 static Sg_device *sg_get_dev(int dev);
214 static void sg_device_destroy(struct kref *kref);
216 #define SZ_SG_HEADER sizeof(struct sg_header)
217 #define SZ_SG_IO_HDR sizeof(sg_io_hdr_t)
218 #define SZ_SG_IOVEC sizeof(sg_iovec_t)
219 #define SZ_SG_REQ_INFO sizeof(sg_req_info_t)
221 #define sg_printk(prefix, sdp, fmt, a...) \
222 sdev_prefix_printk(prefix, (sdp)->device, \
223 (sdp)->disk->disk_name, fmt, ##a)
225 static int sg_allow_access(struct file *filp, unsigned char *cmd)
227 struct sg_fd *sfp = filp->private_data;
229 if (sfp->parentdp->device->type == TYPE_SCANNER)
232 return blk_verify_command(cmd, filp->f_mode & FMODE_WRITE);
236 open_wait(Sg_device *sdp, int flags)
240 if (flags & O_EXCL) {
241 while (sdp->open_cnt > 0) {
242 mutex_unlock(&sdp->open_rel_lock);
243 retval = wait_event_interruptible(sdp->open_wait,
244 (atomic_read(&sdp->detaching) ||
246 mutex_lock(&sdp->open_rel_lock);
248 if (retval) /* -ERESTARTSYS */
250 if (atomic_read(&sdp->detaching))
254 while (sdp->exclude) {
255 mutex_unlock(&sdp->open_rel_lock);
256 retval = wait_event_interruptible(sdp->open_wait,
257 (atomic_read(&sdp->detaching) ||
259 mutex_lock(&sdp->open_rel_lock);
261 if (retval) /* -ERESTARTSYS */
263 if (atomic_read(&sdp->detaching))
271 /* Returns 0 on success, else a negated errno value */
273 sg_open(struct inode *inode, struct file *filp)
275 int dev = iminor(inode);
276 int flags = filp->f_flags;
277 struct request_queue *q;
282 nonseekable_open(inode, filp);
283 if ((flags & O_EXCL) && (O_RDONLY == (flags & O_ACCMODE)))
284 return -EPERM; /* Can't lock it with read only access */
285 sdp = sg_get_dev(dev);
289 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
290 "sg_open: flags=0x%x\n", flags));
292 /* This driver's module count bumped by fops_get in <linux/fs.h> */
293 /* Prevent the device driver from vanishing while we sleep */
294 retval = scsi_device_get(sdp->device);
298 retval = scsi_autopm_get_device(sdp->device);
302 /* scsi_block_when_processing_errors() may block so bypass
303 * check if O_NONBLOCK. Permits SCSI commands to be issued
304 * during error recovery. Tread carefully. */
305 if (!((flags & O_NONBLOCK) ||
306 scsi_block_when_processing_errors(sdp->device))) {
308 /* we are in error recovery for this device */
312 mutex_lock(&sdp->open_rel_lock);
313 if (flags & O_NONBLOCK) {
314 if (flags & O_EXCL) {
315 if (sdp->open_cnt > 0) {
317 goto error_mutex_locked;
322 goto error_mutex_locked;
326 retval = open_wait(sdp, flags);
327 if (retval) /* -ERESTARTSYS or -ENODEV */
328 goto error_mutex_locked;
331 /* N.B. at this point we are holding the open_rel_lock */
335 if (sdp->open_cnt < 1) { /* no existing opens */
337 q = sdp->device->request_queue;
338 sdp->sg_tablesize = queue_max_segments(q);
340 sfp = sg_add_sfp(sdp);
342 retval = PTR_ERR(sfp);
346 filp->private_data = sfp;
348 mutex_unlock(&sdp->open_rel_lock);
352 kref_put(&sdp->d_ref, sg_device_destroy);
356 if (flags & O_EXCL) {
357 sdp->exclude = false; /* undo if error */
358 wake_up_interruptible(&sdp->open_wait);
361 mutex_unlock(&sdp->open_rel_lock);
363 scsi_autopm_put_device(sdp->device);
365 scsi_device_put(sdp->device);
369 /* Release resources associated with a successful sg_open()
370 * Returns 0 on success, else a negated errno value */
372 sg_release(struct inode *inode, struct file *filp)
377 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
379 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp, "sg_release\n"));
381 mutex_lock(&sdp->open_rel_lock);
382 scsi_autopm_put_device(sdp->device);
383 kref_put(&sfp->f_ref, sg_remove_sfp);
386 /* possibly many open()s waiting on exlude clearing, start many;
387 * only open(O_EXCL)s wait on 0==open_cnt so only start one */
389 sdp->exclude = false;
390 wake_up_interruptible_all(&sdp->open_wait);
391 } else if (0 == sdp->open_cnt) {
392 wake_up_interruptible(&sdp->open_wait);
394 mutex_unlock(&sdp->open_rel_lock);
399 sg_read(struct file *filp, char __user *buf, size_t count, loff_t * ppos)
404 int req_pack_id = -1;
406 struct sg_header *old_hdr = NULL;
409 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
411 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
412 "sg_read: count=%d\n", (int) count));
414 if (!access_ok(VERIFY_WRITE, buf, count))
416 if (sfp->force_packid && (count >= SZ_SG_HEADER)) {
417 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
420 if (__copy_from_user(old_hdr, buf, SZ_SG_HEADER)) {
424 if (old_hdr->reply_len < 0) {
425 if (count >= SZ_SG_IO_HDR) {
426 sg_io_hdr_t *new_hdr;
427 new_hdr = kmalloc(SZ_SG_IO_HDR, GFP_KERNEL);
432 retval =__copy_from_user
433 (new_hdr, buf, SZ_SG_IO_HDR);
434 req_pack_id = new_hdr->pack_id;
442 req_pack_id = old_hdr->pack_id;
444 srp = sg_get_rq_mark(sfp, req_pack_id);
445 if (!srp) { /* now wait on packet to arrive */
446 if (atomic_read(&sdp->detaching)) {
450 if (filp->f_flags & O_NONBLOCK) {
454 retval = wait_event_interruptible(sfp->read_wait,
455 (atomic_read(&sdp->detaching) ||
456 (srp = sg_get_rq_mark(sfp, req_pack_id))));
457 if (atomic_read(&sdp->detaching)) {
462 /* -ERESTARTSYS as signal hit process */
466 if (srp->header.interface_id != '\0') {
467 retval = sg_new_read(sfp, buf, count, srp);
472 if (old_hdr == NULL) {
473 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
479 memset(old_hdr, 0, SZ_SG_HEADER);
480 old_hdr->reply_len = (int) hp->timeout;
481 old_hdr->pack_len = old_hdr->reply_len; /* old, strange behaviour */
482 old_hdr->pack_id = hp->pack_id;
483 old_hdr->twelve_byte =
484 ((srp->data.cmd_opcode >= 0xc0) && (12 == hp->cmd_len)) ? 1 : 0;
485 old_hdr->target_status = hp->masked_status;
486 old_hdr->host_status = hp->host_status;
487 old_hdr->driver_status = hp->driver_status;
488 if ((CHECK_CONDITION & hp->masked_status) ||
489 (DRIVER_SENSE & hp->driver_status))
490 memcpy(old_hdr->sense_buffer, srp->sense_b,
491 sizeof (old_hdr->sense_buffer));
492 switch (hp->host_status) {
493 /* This setup of 'result' is for backward compatibility and is best
494 ignored by the user who should use target, host + driver status */
496 case DID_PASSTHROUGH:
503 old_hdr->result = EBUSY;
510 old_hdr->result = EIO;
513 old_hdr->result = (srp->sense_b[0] == 0 &&
514 hp->masked_status == GOOD) ? 0 : EIO;
517 old_hdr->result = EIO;
521 /* Now copy the result back to the user buffer. */
522 if (count >= SZ_SG_HEADER) {
523 if (__copy_to_user(buf, old_hdr, SZ_SG_HEADER)) {
528 if (count > old_hdr->reply_len)
529 count = old_hdr->reply_len;
530 if (count > SZ_SG_HEADER) {
531 if (sg_read_oxfer(srp, buf, count - SZ_SG_HEADER)) {
537 count = (old_hdr->result == 0) ? 0 : -EIO;
538 sg_finish_rem_req(srp);
546 sg_new_read(Sg_fd * sfp, char __user *buf, size_t count, Sg_request * srp)
548 sg_io_hdr_t *hp = &srp->header;
552 if (count < SZ_SG_IO_HDR) {
557 if ((hp->mx_sb_len > 0) && hp->sbp) {
558 if ((CHECK_CONDITION & hp->masked_status) ||
559 (DRIVER_SENSE & hp->driver_status)) {
560 int sb_len = SCSI_SENSE_BUFFERSIZE;
561 sb_len = (hp->mx_sb_len > sb_len) ? sb_len : hp->mx_sb_len;
562 len = 8 + (int) srp->sense_b[7]; /* Additional sense length field */
563 len = (len > sb_len) ? sb_len : len;
564 if (copy_to_user(hp->sbp, srp->sense_b, len)) {
571 if (hp->masked_status || hp->host_status || hp->driver_status)
572 hp->info |= SG_INFO_CHECK;
573 if (copy_to_user(buf, hp, SZ_SG_IO_HDR)) {
578 err2 = sg_finish_rem_req(srp);
579 return err ? : err2 ? : count;
583 sg_write(struct file *filp, const char __user *buf, size_t count, loff_t * ppos)
585 int mxsize, cmd_size, k;
586 int input_size, blocking;
587 unsigned char opcode;
591 struct sg_header old_hdr;
593 unsigned char cmnd[SG_MAX_CDB_SIZE];
595 if (unlikely(segment_eq(get_fs(), KERNEL_DS)))
598 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
600 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
601 "sg_write: count=%d\n", (int) count));
602 if (atomic_read(&sdp->detaching))
604 if (!((filp->f_flags & O_NONBLOCK) ||
605 scsi_block_when_processing_errors(sdp->device)))
608 if (!access_ok(VERIFY_READ, buf, count))
609 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
610 if (count < SZ_SG_HEADER)
612 if (__copy_from_user(&old_hdr, buf, SZ_SG_HEADER))
614 blocking = !(filp->f_flags & O_NONBLOCK);
615 if (old_hdr.reply_len < 0)
616 return sg_new_write(sfp, filp, buf, count,
617 blocking, 0, 0, NULL);
618 if (count < (SZ_SG_HEADER + 6))
619 return -EIO; /* The minimum scsi command length is 6 bytes. */
621 if (!(srp = sg_add_request(sfp))) {
622 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO, sdp,
623 "sg_write: queue full\n"));
627 __get_user(opcode, buf);
628 if (sfp->next_cmd_len > 0) {
629 cmd_size = sfp->next_cmd_len;
630 sfp->next_cmd_len = 0; /* reset so only this write() effected */
632 cmd_size = COMMAND_SIZE(opcode); /* based on SCSI command group */
633 if ((opcode >= 0xc0) && old_hdr.twelve_byte)
636 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sdp,
637 "sg_write: scsi opcode=0x%02x, cmd_size=%d\n", (int) opcode, cmd_size));
638 /* Determine buffer size. */
639 input_size = count - cmd_size;
640 mxsize = (input_size > old_hdr.reply_len) ? input_size : old_hdr.reply_len;
641 mxsize -= SZ_SG_HEADER;
642 input_size -= SZ_SG_HEADER;
643 if (input_size < 0) {
644 sg_remove_request(sfp, srp);
645 return -EIO; /* User did not pass enough bytes for this command. */
648 hp->interface_id = '\0'; /* indicator of old interface tunnelled */
649 hp->cmd_len = (unsigned char) cmd_size;
653 hp->dxfer_direction = (old_hdr.reply_len > SZ_SG_HEADER) ?
654 SG_DXFER_TO_FROM_DEV : SG_DXFER_TO_DEV;
656 hp->dxfer_direction = (mxsize > 0) ? SG_DXFER_FROM_DEV : SG_DXFER_NONE;
657 hp->dxfer_len = mxsize;
658 if ((hp->dxfer_direction == SG_DXFER_TO_DEV) ||
659 (hp->dxfer_direction == SG_DXFER_TO_FROM_DEV))
660 hp->dxferp = (char __user *)buf + cmd_size;
664 hp->timeout = old_hdr.reply_len; /* structure abuse ... */
665 hp->flags = input_size; /* structure abuse ... */
666 hp->pack_id = old_hdr.pack_id;
668 if (__copy_from_user(cmnd, buf, cmd_size))
671 * SG_DXFER_TO_FROM_DEV is functionally equivalent to SG_DXFER_FROM_DEV,
672 * but is is possible that the app intended SG_DXFER_TO_DEV, because there
673 * is a non-zero input_size, so emit a warning.
675 if (hp->dxfer_direction == SG_DXFER_TO_FROM_DEV) {
676 static char cmd[TASK_COMM_LEN];
677 if (strcmp(current->comm, cmd)) {
678 printk_ratelimited(KERN_WARNING
679 "sg_write: data in/out %d/%d bytes "
680 "for SCSI command 0x%x-- guessing "
681 "data in;\n program %s not setting "
682 "count and/or reply_len properly\n",
683 old_hdr.reply_len - (int)SZ_SG_HEADER,
684 input_size, (unsigned int) cmnd[0],
686 strcpy(cmd, current->comm);
689 k = sg_common_write(sfp, srp, cmnd, sfp->timeout, blocking);
690 return (k < 0) ? k : count;
694 sg_new_write(Sg_fd *sfp, struct file *file, const char __user *buf,
695 size_t count, int blocking, int read_only, int sg_io_owned,
701 unsigned char cmnd[SG_MAX_CDB_SIZE];
703 unsigned long ul_timeout;
705 if (count < SZ_SG_IO_HDR)
707 if (!access_ok(VERIFY_READ, buf, count))
708 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
710 sfp->cmd_q = 1; /* when sg_io_hdr seen, set command queuing on */
711 if (!(srp = sg_add_request(sfp))) {
712 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO, sfp->parentdp,
713 "sg_new_write: queue full\n"));
716 srp->sg_io_owned = sg_io_owned;
718 if (__copy_from_user(hp, buf, SZ_SG_IO_HDR)) {
719 sg_remove_request(sfp, srp);
722 if (hp->interface_id != 'S') {
723 sg_remove_request(sfp, srp);
726 if (hp->flags & SG_FLAG_MMAP_IO) {
727 if (hp->dxfer_len > sfp->reserve.bufflen) {
728 sg_remove_request(sfp, srp);
729 return -ENOMEM; /* MMAP_IO size must fit in reserve buffer */
731 if (hp->flags & SG_FLAG_DIRECT_IO) {
732 sg_remove_request(sfp, srp);
733 return -EINVAL; /* either MMAP_IO or DIRECT_IO (not both) */
735 if (sg_res_in_use(sfp)) {
736 sg_remove_request(sfp, srp);
737 return -EBUSY; /* reserve buffer already being used */
740 ul_timeout = msecs_to_jiffies(srp->header.timeout);
741 timeout = (ul_timeout < INT_MAX) ? ul_timeout : INT_MAX;
742 if ((!hp->cmdp) || (hp->cmd_len < 6) || (hp->cmd_len > sizeof (cmnd))) {
743 sg_remove_request(sfp, srp);
746 if (!access_ok(VERIFY_READ, hp->cmdp, hp->cmd_len)) {
747 sg_remove_request(sfp, srp);
748 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
750 if (__copy_from_user(cmnd, hp->cmdp, hp->cmd_len)) {
751 sg_remove_request(sfp, srp);
754 if (read_only && sg_allow_access(file, cmnd)) {
755 sg_remove_request(sfp, srp);
758 k = sg_common_write(sfp, srp, cmnd, timeout, blocking);
767 sg_common_write(Sg_fd * sfp, Sg_request * srp,
768 unsigned char *cmnd, int timeout, int blocking)
771 Sg_device *sdp = sfp->parentdp;
772 sg_io_hdr_t *hp = &srp->header;
774 srp->data.cmd_opcode = cmnd[0]; /* hold opcode of command */
776 hp->masked_status = 0;
780 hp->driver_status = 0;
782 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
783 "sg_common_write: scsi opcode=0x%02x, cmd_size=%d\n",
784 (int) cmnd[0], (int) hp->cmd_len));
786 k = sg_start_req(srp, cmnd);
788 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO, sfp->parentdp,
789 "sg_common_write: start_req err=%d\n", k));
790 sg_finish_rem_req(srp);
791 return k; /* probably out of space --> ENOMEM */
793 if (atomic_read(&sdp->detaching)) {
795 if (srp->rq->cmd != srp->rq->__cmd)
798 blk_end_request_all(srp->rq, -EIO);
802 sg_finish_rem_req(srp);
806 hp->duration = jiffies_to_msecs(jiffies);
807 if (hp->interface_id != '\0' && /* v3 (or later) interface */
808 (SG_FLAG_Q_AT_TAIL & hp->flags))
813 srp->rq->timeout = timeout;
814 kref_get(&sfp->f_ref); /* sg_rq_end_io() does kref_put(). */
815 blk_execute_rq_nowait(sdp->device->request_queue, sdp->disk,
816 srp->rq, at_head, sg_rq_end_io);
820 static int srp_done(Sg_fd *sfp, Sg_request *srp)
825 read_lock_irqsave(&sfp->rq_list_lock, flags);
827 read_unlock_irqrestore(&sfp->rq_list_lock, flags);
831 static int max_sectors_bytes(struct request_queue *q)
833 unsigned int max_sectors = queue_max_sectors(q);
835 max_sectors = min_t(unsigned int, max_sectors, INT_MAX >> 9);
837 return max_sectors << 9;
841 sg_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
843 void __user *p = (void __user *)arg;
845 int result, val, read_only;
849 unsigned long iflags;
851 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
854 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
855 "sg_ioctl: cmd=0x%x\n", (int) cmd_in));
856 read_only = (O_RDWR != (filp->f_flags & O_ACCMODE));
860 if (atomic_read(&sdp->detaching))
862 if (!scsi_block_when_processing_errors(sdp->device))
864 if (!access_ok(VERIFY_WRITE, p, SZ_SG_IO_HDR))
866 result = sg_new_write(sfp, filp, p, SZ_SG_IO_HDR,
867 1, read_only, 1, &srp);
870 result = wait_event_interruptible(sfp->read_wait,
871 (srp_done(sfp, srp) || atomic_read(&sdp->detaching)));
872 if (atomic_read(&sdp->detaching))
874 write_lock_irq(&sfp->rq_list_lock);
877 write_unlock_irq(&sfp->rq_list_lock);
878 result = sg_new_read(sfp, p, SZ_SG_IO_HDR, srp);
879 return (result < 0) ? result : 0;
882 write_unlock_irq(&sfp->rq_list_lock);
883 return result; /* -ERESTARTSYS because signal hit process */
885 result = get_user(val, ip);
890 if (val >= MULDIV (INT_MAX, USER_HZ, HZ))
891 val = MULDIV (INT_MAX, USER_HZ, HZ);
892 sfp->timeout_user = val;
893 sfp->timeout = MULDIV (val, HZ, USER_HZ);
896 case SG_GET_TIMEOUT: /* N.B. User receives timeout as return value */
897 /* strange ..., for backward compatibility */
898 return sfp->timeout_user;
899 case SG_SET_FORCE_LOW_DMA:
900 result = get_user(val, ip);
905 if ((0 == sfp->low_dma) && (0 == sg_res_in_use(sfp))) {
906 val = (int) sfp->reserve.bufflen;
907 sg_remove_scat(sfp, &sfp->reserve);
908 sg_build_reserve(sfp, val);
911 if (atomic_read(&sdp->detaching))
913 sfp->low_dma = sdp->device->host->unchecked_isa_dma;
917 return put_user((int) sfp->low_dma, ip);
919 if (!access_ok(VERIFY_WRITE, p, sizeof (sg_scsi_id_t)))
922 sg_scsi_id_t __user *sg_idp = p;
924 if (atomic_read(&sdp->detaching))
926 __put_user((int) sdp->device->host->host_no,
928 __put_user((int) sdp->device->channel,
930 __put_user((int) sdp->device->id, &sg_idp->scsi_id);
931 __put_user((int) sdp->device->lun, &sg_idp->lun);
932 __put_user((int) sdp->device->type, &sg_idp->scsi_type);
933 __put_user((short) sdp->device->host->cmd_per_lun,
934 &sg_idp->h_cmd_per_lun);
935 __put_user((short) sdp->device->queue_depth,
936 &sg_idp->d_queue_depth);
937 __put_user(0, &sg_idp->unused[0]);
938 __put_user(0, &sg_idp->unused[1]);
941 case SG_SET_FORCE_PACK_ID:
942 result = get_user(val, ip);
945 sfp->force_packid = val ? 1 : 0;
948 if (!access_ok(VERIFY_WRITE, ip, sizeof (int)))
950 read_lock_irqsave(&sfp->rq_list_lock, iflags);
951 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
952 if ((1 == srp->done) && (!srp->sg_io_owned)) {
953 read_unlock_irqrestore(&sfp->rq_list_lock,
955 __put_user(srp->header.pack_id, ip);
959 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
962 case SG_GET_NUM_WAITING:
963 read_lock_irqsave(&sfp->rq_list_lock, iflags);
964 for (val = 0, srp = sfp->headrp; srp; srp = srp->nextrp) {
965 if ((1 == srp->done) && (!srp->sg_io_owned))
968 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
969 return put_user(val, ip);
970 case SG_GET_SG_TABLESIZE:
971 return put_user(sdp->sg_tablesize, ip);
972 case SG_SET_RESERVED_SIZE:
973 result = get_user(val, ip);
978 val = min_t(int, val,
979 max_sectors_bytes(sdp->device->request_queue));
980 if (val != sfp->reserve.bufflen) {
981 if (sg_res_in_use(sfp) || sfp->mmap_called)
983 sg_remove_scat(sfp, &sfp->reserve);
984 sg_build_reserve(sfp, val);
987 case SG_GET_RESERVED_SIZE:
988 val = min_t(int, sfp->reserve.bufflen,
989 max_sectors_bytes(sdp->device->request_queue));
990 return put_user(val, ip);
991 case SG_SET_COMMAND_Q:
992 result = get_user(val, ip);
995 sfp->cmd_q = val ? 1 : 0;
997 case SG_GET_COMMAND_Q:
998 return put_user((int) sfp->cmd_q, ip);
999 case SG_SET_KEEP_ORPHAN:
1000 result = get_user(val, ip);
1003 sfp->keep_orphan = val;
1005 case SG_GET_KEEP_ORPHAN:
1006 return put_user((int) sfp->keep_orphan, ip);
1007 case SG_NEXT_CMD_LEN:
1008 result = get_user(val, ip);
1011 sfp->next_cmd_len = (val > 0) ? val : 0;
1013 case SG_GET_VERSION_NUM:
1014 return put_user(sg_version_num, ip);
1015 case SG_GET_ACCESS_COUNT:
1016 /* faked - we don't have a real access count anymore */
1017 val = (sdp->device ? 1 : 0);
1018 return put_user(val, ip);
1019 case SG_GET_REQUEST_TABLE:
1020 if (!access_ok(VERIFY_WRITE, p, SZ_SG_REQ_INFO * SG_MAX_QUEUE))
1023 sg_req_info_t *rinfo;
1026 rinfo = kmalloc(SZ_SG_REQ_INFO * SG_MAX_QUEUE,
1030 read_lock_irqsave(&sfp->rq_list_lock, iflags);
1031 for (srp = sfp->headrp, val = 0; val < SG_MAX_QUEUE;
1032 ++val, srp = srp ? srp->nextrp : srp) {
1033 memset(&rinfo[val], 0, SZ_SG_REQ_INFO);
1035 rinfo[val].req_state = srp->done + 1;
1036 rinfo[val].problem =
1037 srp->header.masked_status &
1038 srp->header.host_status &
1039 srp->header.driver_status;
1041 rinfo[val].duration =
1042 srp->header.duration;
1044 ms = jiffies_to_msecs(jiffies);
1045 rinfo[val].duration =
1046 (ms > srp->header.duration) ?
1047 (ms - srp->header.duration) : 0;
1049 rinfo[val].orphan = srp->orphan;
1050 rinfo[val].sg_io_owned =
1052 rinfo[val].pack_id =
1053 srp->header.pack_id;
1054 rinfo[val].usr_ptr =
1055 srp->header.usr_ptr;
1058 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1059 result = __copy_to_user(p, rinfo,
1060 SZ_SG_REQ_INFO * SG_MAX_QUEUE);
1061 result = result ? -EFAULT : 0;
1065 case SG_EMULATED_HOST:
1066 if (atomic_read(&sdp->detaching))
1068 return put_user(sdp->device->host->hostt->emulated, ip);
1069 case SCSI_IOCTL_SEND_COMMAND:
1070 if (atomic_read(&sdp->detaching))
1073 unsigned char opcode = WRITE_6;
1074 Scsi_Ioctl_Command __user *siocp = p;
1076 if (copy_from_user(&opcode, siocp->data, 1))
1078 if (sg_allow_access(filp, &opcode))
1081 return sg_scsi_ioctl(sdp->device->request_queue, NULL, filp->f_mode, p);
1083 result = get_user(val, ip);
1086 sdp->sgdebug = (char) val;
1089 return put_user(max_sectors_bytes(sdp->device->request_queue),
1092 return blk_trace_setup(sdp->device->request_queue,
1093 sdp->disk->disk_name,
1094 MKDEV(SCSI_GENERIC_MAJOR, sdp->index),
1098 return blk_trace_startstop(sdp->device->request_queue, 1);
1100 return blk_trace_startstop(sdp->device->request_queue, 0);
1101 case BLKTRACETEARDOWN:
1102 return blk_trace_remove(sdp->device->request_queue);
1103 case SCSI_IOCTL_GET_IDLUN:
1104 case SCSI_IOCTL_GET_BUS_NUMBER:
1105 case SCSI_IOCTL_PROBE_HOST:
1106 case SG_GET_TRANSFORM:
1108 if (atomic_read(&sdp->detaching))
1113 return -EPERM; /* don't know so take safe approach */
1117 result = scsi_ioctl_block_when_processing_errors(sdp->device,
1118 cmd_in, filp->f_flags & O_NDELAY);
1121 return scsi_ioctl(sdp->device, cmd_in, p);
1124 #ifdef CONFIG_COMPAT
1125 static long sg_compat_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
1129 struct scsi_device *sdev;
1131 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1135 if (sdev->host->hostt->compat_ioctl) {
1138 ret = sdev->host->hostt->compat_ioctl(sdev, cmd_in, (void __user *)arg);
1143 return -ENOIOCTLCMD;
1148 sg_poll(struct file *filp, poll_table * wait)
1150 unsigned int res = 0;
1155 unsigned long iflags;
1157 sfp = filp->private_data;
1160 sdp = sfp->parentdp;
1163 poll_wait(filp, &sfp->read_wait, wait);
1164 read_lock_irqsave(&sfp->rq_list_lock, iflags);
1165 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
1166 /* if any read waiting, flag it */
1167 if ((0 == res) && (1 == srp->done) && (!srp->sg_io_owned))
1168 res = POLLIN | POLLRDNORM;
1171 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1173 if (atomic_read(&sdp->detaching))
1175 else if (!sfp->cmd_q) {
1177 res |= POLLOUT | POLLWRNORM;
1178 } else if (count < SG_MAX_QUEUE)
1179 res |= POLLOUT | POLLWRNORM;
1180 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
1181 "sg_poll: res=0x%x\n", (int) res));
1186 sg_fasync(int fd, struct file *filp, int mode)
1191 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1193 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
1194 "sg_fasync: mode=%d\n", mode));
1196 return fasync_helper(fd, filp, mode, &sfp->async_qp);
1200 sg_vma_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
1203 unsigned long offset, len, sa;
1204 Sg_scatter_hold *rsv_schp;
1207 if ((NULL == vma) || (!(sfp = (Sg_fd *) vma->vm_private_data)))
1208 return VM_FAULT_SIGBUS;
1209 rsv_schp = &sfp->reserve;
1210 offset = vmf->pgoff << PAGE_SHIFT;
1211 if (offset >= rsv_schp->bufflen)
1212 return VM_FAULT_SIGBUS;
1213 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sfp->parentdp,
1214 "sg_vma_fault: offset=%lu, scatg=%d\n",
1215 offset, rsv_schp->k_use_sg));
1217 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1218 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
1219 len = vma->vm_end - sa;
1220 len = (len < length) ? len : length;
1222 struct page *page = nth_page(rsv_schp->pages[k],
1223 offset >> PAGE_SHIFT);
1224 get_page(page); /* increment page count */
1226 return 0; /* success */
1232 return VM_FAULT_SIGBUS;
1235 static const struct vm_operations_struct sg_mmap_vm_ops = {
1236 .fault = sg_vma_fault,
1240 sg_mmap(struct file *filp, struct vm_area_struct *vma)
1243 unsigned long req_sz, len, sa;
1244 Sg_scatter_hold *rsv_schp;
1247 if ((!filp) || (!vma) || (!(sfp = (Sg_fd *) filp->private_data)))
1249 req_sz = vma->vm_end - vma->vm_start;
1250 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sfp->parentdp,
1251 "sg_mmap starting, vm_start=%p, len=%d\n",
1252 (void *) vma->vm_start, (int) req_sz));
1254 return -EINVAL; /* want no offset */
1255 rsv_schp = &sfp->reserve;
1256 if (req_sz > rsv_schp->bufflen)
1257 return -ENOMEM; /* cannot map more than reserved buffer */
1260 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1261 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
1262 len = vma->vm_end - sa;
1263 len = (len < length) ? len : length;
1267 sfp->mmap_called = 1;
1268 vma->vm_flags |= VM_IO | VM_DONTEXPAND | VM_DONTDUMP;
1269 vma->vm_private_data = sfp;
1270 vma->vm_ops = &sg_mmap_vm_ops;
1275 sg_rq_end_io_usercontext(struct work_struct *work)
1277 struct sg_request *srp = container_of(work, struct sg_request, ew.work);
1278 struct sg_fd *sfp = srp->parentfp;
1280 sg_finish_rem_req(srp);
1281 kref_put(&sfp->f_ref, sg_remove_sfp);
1285 * This function is a "bottom half" handler that is called by the mid
1286 * level when a command is completed (or has failed).
1289 sg_rq_end_io(struct request *rq, int uptodate)
1291 struct sg_request *srp = rq->end_io_data;
1294 unsigned long iflags;
1297 int result, resid, done = 1;
1299 if (WARN_ON(srp->done != 0))
1302 sfp = srp->parentfp;
1303 if (WARN_ON(sfp == NULL))
1306 sdp = sfp->parentdp;
1307 if (unlikely(atomic_read(&sdp->detaching)))
1308 pr_info("%s: device detaching\n", __func__);
1311 result = rq->errors;
1312 resid = rq->resid_len;
1314 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sdp,
1315 "sg_cmd_done: pack_id=%d, res=0x%x\n",
1316 srp->header.pack_id, result));
1317 srp->header.resid = resid;
1318 ms = jiffies_to_msecs(jiffies);
1319 srp->header.duration = (ms > srp->header.duration) ?
1320 (ms - srp->header.duration) : 0;
1322 struct scsi_sense_hdr sshdr;
1324 srp->header.status = 0xff & result;
1325 srp->header.masked_status = status_byte(result);
1326 srp->header.msg_status = msg_byte(result);
1327 srp->header.host_status = host_byte(result);
1328 srp->header.driver_status = driver_byte(result);
1329 if ((sdp->sgdebug > 0) &&
1330 ((CHECK_CONDITION == srp->header.masked_status) ||
1331 (COMMAND_TERMINATED == srp->header.masked_status)))
1332 __scsi_print_sense(sdp->device, __func__, sense,
1333 SCSI_SENSE_BUFFERSIZE);
1335 /* Following if statement is a patch supplied by Eric Youngdale */
1336 if (driver_byte(result) != 0
1337 && scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, &sshdr)
1338 && !scsi_sense_is_deferred(&sshdr)
1339 && sshdr.sense_key == UNIT_ATTENTION
1340 && sdp->device->removable) {
1341 /* Detected possible disc change. Set the bit - this */
1342 /* may be used if there are filesystems using this device */
1343 sdp->device->changed = 1;
1346 /* Rely on write phase to clean out srp status values, so no "else" */
1349 * Free the request as soon as it is complete so that its resources
1350 * can be reused without waiting for userspace to read() the
1351 * result. But keep the associated bio (if any) around until
1352 * blk_rq_unmap_user() can be called from user context.
1355 if (rq->cmd != rq->__cmd)
1357 __blk_put_request(rq->q, rq);
1359 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1360 if (unlikely(srp->orphan)) {
1361 if (sfp->keep_orphan)
1362 srp->sg_io_owned = 0;
1367 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1370 /* Now wake up any sg_read() that is waiting for this
1373 wake_up_interruptible(&sfp->read_wait);
1374 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_IN);
1375 kref_put(&sfp->f_ref, sg_remove_sfp);
1377 INIT_WORK(&srp->ew.work, sg_rq_end_io_usercontext);
1378 schedule_work(&srp->ew.work);
1382 static const struct file_operations sg_fops = {
1383 .owner = THIS_MODULE,
1387 .unlocked_ioctl = sg_ioctl,
1388 #ifdef CONFIG_COMPAT
1389 .compat_ioctl = sg_compat_ioctl,
1393 .release = sg_release,
1394 .fasync = sg_fasync,
1395 .llseek = no_llseek,
1398 static struct class *sg_sysfs_class;
1400 static int sg_sysfs_valid = 0;
1403 sg_alloc(struct gendisk *disk, struct scsi_device *scsidp)
1405 struct request_queue *q = scsidp->request_queue;
1407 unsigned long iflags;
1411 sdp = kzalloc(sizeof(Sg_device), GFP_KERNEL);
1413 sdev_printk(KERN_WARNING, scsidp, "%s: kmalloc Sg_device "
1414 "failure\n", __func__);
1415 return ERR_PTR(-ENOMEM);
1418 idr_preload(GFP_KERNEL);
1419 write_lock_irqsave(&sg_index_lock, iflags);
1421 error = idr_alloc(&sg_index_idr, sdp, 0, SG_MAX_DEVS, GFP_NOWAIT);
1423 if (error == -ENOSPC) {
1424 sdev_printk(KERN_WARNING, scsidp,
1425 "Unable to attach sg device type=%d, minor number exceeds %d\n",
1426 scsidp->type, SG_MAX_DEVS - 1);
1429 sdev_printk(KERN_WARNING, scsidp, "%s: idr "
1430 "allocation Sg_device failure: %d\n",
1437 SCSI_LOG_TIMEOUT(3, sdev_printk(KERN_INFO, scsidp,
1438 "sg_alloc: dev=%d \n", k));
1439 sprintf(disk->disk_name, "sg%d", k);
1440 disk->first_minor = k;
1442 sdp->device = scsidp;
1443 mutex_init(&sdp->open_rel_lock);
1444 INIT_LIST_HEAD(&sdp->sfds);
1445 init_waitqueue_head(&sdp->open_wait);
1446 atomic_set(&sdp->detaching, 0);
1447 rwlock_init(&sdp->sfd_lock);
1448 sdp->sg_tablesize = queue_max_segments(q);
1450 kref_init(&sdp->d_ref);
1454 write_unlock_irqrestore(&sg_index_lock, iflags);
1459 return ERR_PTR(error);
1465 sg_add_device(struct device *cl_dev, struct class_interface *cl_intf)
1467 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
1468 struct gendisk *disk;
1469 Sg_device *sdp = NULL;
1470 struct cdev * cdev = NULL;
1472 unsigned long iflags;
1474 disk = alloc_disk(1);
1476 pr_warn("%s: alloc_disk failed\n", __func__);
1479 disk->major = SCSI_GENERIC_MAJOR;
1482 cdev = cdev_alloc();
1484 pr_warn("%s: cdev_alloc failed\n", __func__);
1487 cdev->owner = THIS_MODULE;
1488 cdev->ops = &sg_fops;
1490 sdp = sg_alloc(disk, scsidp);
1492 pr_warn("%s: sg_alloc failed\n", __func__);
1493 error = PTR_ERR(sdp);
1497 error = cdev_add(cdev, MKDEV(SCSI_GENERIC_MAJOR, sdp->index), 1);
1502 if (sg_sysfs_valid) {
1503 struct device *sg_class_member;
1505 sg_class_member = device_create(sg_sysfs_class, cl_dev->parent,
1506 MKDEV(SCSI_GENERIC_MAJOR,
1508 sdp, "%s", disk->disk_name);
1509 if (IS_ERR(sg_class_member)) {
1510 pr_err("%s: device_create failed\n", __func__);
1511 error = PTR_ERR(sg_class_member);
1514 error = sysfs_create_link(&scsidp->sdev_gendev.kobj,
1515 &sg_class_member->kobj, "generic");
1517 pr_err("%s: unable to make symlink 'generic' back "
1518 "to sg%d\n", __func__, sdp->index);
1520 pr_warn("%s: sg_sys Invalid\n", __func__);
1522 sdev_printk(KERN_NOTICE, scsidp, "Attached scsi generic sg%d "
1523 "type %d\n", sdp->index, scsidp->type);
1525 dev_set_drvdata(cl_dev, sdp);
1530 write_lock_irqsave(&sg_index_lock, iflags);
1531 idr_remove(&sg_index_idr, sdp->index);
1532 write_unlock_irqrestore(&sg_index_lock, iflags);
1543 sg_device_destroy(struct kref *kref)
1545 struct sg_device *sdp = container_of(kref, struct sg_device, d_ref);
1546 unsigned long flags;
1548 /* CAUTION! Note that the device can still be found via idr_find()
1549 * even though the refcount is 0. Therefore, do idr_remove() BEFORE
1550 * any other cleanup.
1553 write_lock_irqsave(&sg_index_lock, flags);
1554 idr_remove(&sg_index_idr, sdp->index);
1555 write_unlock_irqrestore(&sg_index_lock, flags);
1558 sg_printk(KERN_INFO, sdp, "sg_device_destroy\n"));
1560 put_disk(sdp->disk);
1565 sg_remove_device(struct device *cl_dev, struct class_interface *cl_intf)
1567 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
1568 Sg_device *sdp = dev_get_drvdata(cl_dev);
1569 unsigned long iflags;
1575 /* want sdp->detaching non-zero as soon as possible */
1576 val = atomic_inc_return(&sdp->detaching);
1578 return; /* only want to do following once per device */
1580 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
1583 read_lock_irqsave(&sdp->sfd_lock, iflags);
1584 list_for_each_entry(sfp, &sdp->sfds, sfd_siblings) {
1585 wake_up_interruptible_all(&sfp->read_wait);
1586 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_HUP);
1588 wake_up_interruptible_all(&sdp->open_wait);
1589 read_unlock_irqrestore(&sdp->sfd_lock, iflags);
1591 sysfs_remove_link(&scsidp->sdev_gendev.kobj, "generic");
1592 device_destroy(sg_sysfs_class, MKDEV(SCSI_GENERIC_MAJOR, sdp->index));
1593 cdev_del(sdp->cdev);
1596 kref_put(&sdp->d_ref, sg_device_destroy);
1599 module_param_named(scatter_elem_sz, scatter_elem_sz, int, S_IRUGO | S_IWUSR);
1600 module_param_named(def_reserved_size, def_reserved_size, int,
1602 module_param_named(allow_dio, sg_allow_dio, int, S_IRUGO | S_IWUSR);
1604 MODULE_AUTHOR("Douglas Gilbert");
1605 MODULE_DESCRIPTION("SCSI generic (sg) driver");
1606 MODULE_LICENSE("GPL");
1607 MODULE_VERSION(SG_VERSION_STR);
1608 MODULE_ALIAS_CHARDEV_MAJOR(SCSI_GENERIC_MAJOR);
1610 MODULE_PARM_DESC(scatter_elem_sz, "scatter gather element "
1611 "size (default: max(SG_SCATTER_SZ, PAGE_SIZE))");
1612 MODULE_PARM_DESC(def_reserved_size, "size of buffer reserved for each fd");
1613 MODULE_PARM_DESC(allow_dio, "allow direct I/O (default: 0 (disallow))");
1620 if (scatter_elem_sz < PAGE_SIZE) {
1621 scatter_elem_sz = PAGE_SIZE;
1622 scatter_elem_sz_prev = scatter_elem_sz;
1624 if (def_reserved_size >= 0)
1625 sg_big_buff = def_reserved_size;
1627 def_reserved_size = sg_big_buff;
1629 rc = register_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1633 sg_sysfs_class = class_create(THIS_MODULE, "scsi_generic");
1634 if ( IS_ERR(sg_sysfs_class) ) {
1635 rc = PTR_ERR(sg_sysfs_class);
1639 rc = scsi_register_interface(&sg_interface);
1641 #ifdef CONFIG_SCSI_PROC_FS
1643 #endif /* CONFIG_SCSI_PROC_FS */
1646 class_destroy(sg_sysfs_class);
1648 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0), SG_MAX_DEVS);
1655 #ifdef CONFIG_SCSI_PROC_FS
1657 #endif /* CONFIG_SCSI_PROC_FS */
1658 scsi_unregister_interface(&sg_interface);
1659 class_destroy(sg_sysfs_class);
1661 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1663 idr_destroy(&sg_index_idr);
1667 sg_start_req(Sg_request *srp, unsigned char *cmd)
1671 Sg_fd *sfp = srp->parentfp;
1672 sg_io_hdr_t *hp = &srp->header;
1673 int dxfer_len = (int) hp->dxfer_len;
1674 int dxfer_dir = hp->dxfer_direction;
1675 unsigned int iov_count = hp->iovec_count;
1676 Sg_scatter_hold *req_schp = &srp->data;
1677 Sg_scatter_hold *rsv_schp = &sfp->reserve;
1678 struct request_queue *q = sfp->parentdp->device->request_queue;
1679 struct rq_map_data *md, map_data;
1680 int rw = hp->dxfer_direction == SG_DXFER_TO_DEV ? WRITE : READ;
1681 unsigned char *long_cmdp = NULL;
1683 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1684 "sg_start_req: dxfer_len=%d\n",
1687 if (hp->cmd_len > BLK_MAX_CDB) {
1688 long_cmdp = kzalloc(hp->cmd_len, GFP_KERNEL);
1696 * With scsi-mq enabled, there are a fixed number of preallocated
1697 * requests equal in number to shost->can_queue. If all of the
1698 * preallocated requests are already in use, then using GFP_ATOMIC with
1699 * blk_get_request() will return -EWOULDBLOCK, whereas using GFP_KERNEL
1700 * will cause blk_get_request() to sleep until an active command
1701 * completes, freeing up a request. Neither option is ideal, but
1702 * GFP_KERNEL is the better choice to prevent userspace from getting an
1703 * unexpected EWOULDBLOCK.
1705 * With scsi-mq disabled, blk_get_request() with GFP_KERNEL usually
1706 * does not sleep except under memory pressure.
1708 rq = blk_get_request(q, rw, GFP_KERNEL);
1714 blk_rq_set_block_pc(rq);
1716 if (hp->cmd_len > BLK_MAX_CDB)
1717 rq->cmd = long_cmdp;
1718 memcpy(rq->cmd, cmd, hp->cmd_len);
1719 rq->cmd_len = hp->cmd_len;
1722 rq->end_io_data = srp;
1723 rq->sense = srp->sense_b;
1724 rq->retries = SG_DEFAULT_RETRIES;
1726 if ((dxfer_len <= 0) || (dxfer_dir == SG_DXFER_NONE))
1729 if (sg_allow_dio && hp->flags & SG_FLAG_DIRECT_IO &&
1730 dxfer_dir != SG_DXFER_UNKNOWN && !iov_count &&
1731 !sfp->parentdp->device->host->unchecked_isa_dma &&
1732 blk_rq_aligned(q, (unsigned long)hp->dxferp, dxfer_len))
1738 if (!sg_res_in_use(sfp) && dxfer_len <= rsv_schp->bufflen)
1739 sg_link_reserve(sfp, srp, dxfer_len);
1741 res = sg_build_indirect(req_schp, sfp, dxfer_len);
1746 md->pages = req_schp->pages;
1747 md->page_order = req_schp->page_order;
1748 md->nr_entries = req_schp->k_use_sg;
1750 md->null_mapped = hp->dxferp ? 0 : 1;
1751 if (dxfer_dir == SG_DXFER_TO_FROM_DEV)
1758 struct iovec *iov = NULL;
1761 res = import_iovec(rw, hp->dxferp, iov_count, 0, &iov, &i);
1765 iov_iter_truncate(&i, hp->dxfer_len);
1766 if (!iov_iter_count(&i)) {
1771 res = blk_rq_map_user_iov(q, rq, md, &i, GFP_ATOMIC);
1774 res = blk_rq_map_user(q, rq, md, hp->dxferp,
1775 hp->dxfer_len, GFP_ATOMIC);
1781 req_schp->dio_in_use = 1;
1782 hp->info |= SG_INFO_DIRECT_IO;
1789 sg_finish_rem_req(Sg_request *srp)
1793 Sg_fd *sfp = srp->parentfp;
1794 Sg_scatter_hold *req_schp = &srp->data;
1796 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1797 "sg_finish_rem_req: res_used=%d\n",
1798 (int) srp->res_used));
1800 ret = blk_rq_unmap_user(srp->bio);
1803 if (srp->rq->cmd != srp->rq->__cmd)
1804 kfree(srp->rq->cmd);
1805 blk_put_request(srp->rq);
1809 sg_unlink_reserve(sfp, srp);
1811 sg_remove_scat(sfp, req_schp);
1813 sg_remove_request(sfp, srp);
1819 sg_build_sgat(Sg_scatter_hold * schp, const Sg_fd * sfp, int tablesize)
1821 int sg_bufflen = tablesize * sizeof(struct page *);
1822 gfp_t gfp_flags = GFP_ATOMIC | __GFP_NOWARN;
1824 schp->pages = kzalloc(sg_bufflen, gfp_flags);
1827 schp->sglist_len = sg_bufflen;
1828 return tablesize; /* number of scat_gath elements allocated */
1832 sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size)
1834 int ret_sz = 0, i, k, rem_sz, num, mx_sc_elems;
1835 int sg_tablesize = sfp->parentdp->sg_tablesize;
1836 int blk_size = buff_size, order;
1837 gfp_t gfp_mask = GFP_ATOMIC | __GFP_COMP | __GFP_NOWARN;
1842 ++blk_size; /* don't know why */
1843 /* round request up to next highest SG_SECTOR_SZ byte boundary */
1844 blk_size = ALIGN(blk_size, SG_SECTOR_SZ);
1845 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1846 "sg_build_indirect: buff_size=%d, blk_size=%d\n",
1847 buff_size, blk_size));
1849 /* N.B. ret_sz carried into this block ... */
1850 mx_sc_elems = sg_build_sgat(schp, sfp, sg_tablesize);
1851 if (mx_sc_elems < 0)
1852 return mx_sc_elems; /* most likely -ENOMEM */
1854 num = scatter_elem_sz;
1855 if (unlikely(num != scatter_elem_sz_prev)) {
1856 if (num < PAGE_SIZE) {
1857 scatter_elem_sz = PAGE_SIZE;
1858 scatter_elem_sz_prev = PAGE_SIZE;
1860 scatter_elem_sz_prev = num;
1864 gfp_mask |= GFP_DMA;
1866 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
1867 gfp_mask |= __GFP_ZERO;
1869 order = get_order(num);
1871 ret_sz = 1 << (PAGE_SHIFT + order);
1873 for (k = 0, rem_sz = blk_size; rem_sz > 0 && k < mx_sc_elems;
1874 k++, rem_sz -= ret_sz) {
1876 num = (rem_sz > scatter_elem_sz_prev) ?
1877 scatter_elem_sz_prev : rem_sz;
1879 schp->pages[k] = alloc_pages(gfp_mask, order);
1880 if (!schp->pages[k])
1883 if (num == scatter_elem_sz_prev) {
1884 if (unlikely(ret_sz > scatter_elem_sz_prev)) {
1885 scatter_elem_sz = ret_sz;
1886 scatter_elem_sz_prev = ret_sz;
1890 SCSI_LOG_TIMEOUT(5, sg_printk(KERN_INFO, sfp->parentdp,
1891 "sg_build_indirect: k=%d, num=%d, ret_sz=%d\n",
1893 } /* end of for loop */
1895 schp->page_order = order;
1897 SCSI_LOG_TIMEOUT(5, sg_printk(KERN_INFO, sfp->parentdp,
1898 "sg_build_indirect: k_use_sg=%d, rem_sz=%d\n",
1901 schp->bufflen = blk_size;
1902 if (rem_sz > 0) /* must have failed */
1906 for (i = 0; i < k; i++)
1907 __free_pages(schp->pages[i], order);
1916 sg_remove_scat(Sg_fd * sfp, Sg_scatter_hold * schp)
1918 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1919 "sg_remove_scat: k_use_sg=%d\n", schp->k_use_sg));
1920 if (schp->pages && schp->sglist_len > 0) {
1921 if (!schp->dio_in_use) {
1924 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
1926 sg_printk(KERN_INFO, sfp->parentdp,
1927 "sg_remove_scat: k=%d, pg=0x%p\n",
1928 k, schp->pages[k]));
1929 __free_pages(schp->pages[k], schp->page_order);
1935 memset(schp, 0, sizeof (*schp));
1939 sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer)
1941 Sg_scatter_hold *schp = &srp->data;
1944 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, srp->parentfp->parentdp,
1945 "sg_read_oxfer: num_read_xfer=%d\n",
1947 if ((!outp) || (num_read_xfer <= 0))
1950 num = 1 << (PAGE_SHIFT + schp->page_order);
1951 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
1952 if (num > num_read_xfer) {
1953 if (__copy_to_user(outp, page_address(schp->pages[k]),
1958 if (__copy_to_user(outp, page_address(schp->pages[k]),
1961 num_read_xfer -= num;
1962 if (num_read_xfer <= 0)
1972 sg_build_reserve(Sg_fd * sfp, int req_size)
1974 Sg_scatter_hold *schp = &sfp->reserve;
1976 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1977 "sg_build_reserve: req_size=%d\n", req_size));
1979 if (req_size < PAGE_SIZE)
1980 req_size = PAGE_SIZE;
1981 if (0 == sg_build_indirect(schp, sfp, req_size))
1984 sg_remove_scat(sfp, schp);
1985 req_size >>= 1; /* divide by 2 */
1986 } while (req_size > (PAGE_SIZE / 2));
1990 sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size)
1992 Sg_scatter_hold *req_schp = &srp->data;
1993 Sg_scatter_hold *rsv_schp = &sfp->reserve;
1997 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1998 "sg_link_reserve: size=%d\n", size));
2001 num = 1 << (PAGE_SHIFT + rsv_schp->page_order);
2002 for (k = 0; k < rsv_schp->k_use_sg; k++) {
2004 req_schp->k_use_sg = k + 1;
2005 req_schp->sglist_len = rsv_schp->sglist_len;
2006 req_schp->pages = rsv_schp->pages;
2008 req_schp->bufflen = size;
2009 req_schp->page_order = rsv_schp->page_order;
2015 if (k >= rsv_schp->k_use_sg)
2016 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO, sfp->parentdp,
2017 "sg_link_reserve: BAD size\n"));
2021 sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp)
2023 Sg_scatter_hold *req_schp = &srp->data;
2025 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, srp->parentfp->parentdp,
2026 "sg_unlink_reserve: req->k_use_sg=%d\n",
2027 (int) req_schp->k_use_sg));
2028 req_schp->k_use_sg = 0;
2029 req_schp->bufflen = 0;
2030 req_schp->pages = NULL;
2031 req_schp->page_order = 0;
2032 req_schp->sglist_len = 0;
2033 sfp->save_scat_len = 0;
2038 sg_get_rq_mark(Sg_fd * sfp, int pack_id)
2041 unsigned long iflags;
2043 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2044 for (resp = sfp->headrp; resp; resp = resp->nextrp) {
2045 /* look for requests that are ready + not SG_IO owned */
2046 if ((1 == resp->done) && (!resp->sg_io_owned) &&
2047 ((-1 == pack_id) || (resp->header.pack_id == pack_id))) {
2048 resp->done = 2; /* guard against other readers */
2052 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2056 /* always adds to end of list */
2058 sg_add_request(Sg_fd * sfp)
2061 unsigned long iflags;
2063 Sg_request *rp = sfp->req_arr;
2065 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2068 memset(rp, 0, sizeof (Sg_request));
2073 if (0 == sfp->cmd_q)
2074 resp = NULL; /* command queuing disallowed */
2076 for (k = 0; k < SG_MAX_QUEUE; ++k, ++rp) {
2080 if (k < SG_MAX_QUEUE) {
2081 memset(rp, 0, sizeof (Sg_request));
2083 while (resp->nextrp)
2084 resp = resp->nextrp;
2092 resp->nextrp = NULL;
2093 resp->header.duration = jiffies_to_msecs(jiffies);
2095 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2099 /* Return of 1 for found; 0 for not found */
2101 sg_remove_request(Sg_fd * sfp, Sg_request * srp)
2103 Sg_request *prev_rp;
2105 unsigned long iflags;
2108 if ((!sfp) || (!srp) || (!sfp->headrp))
2110 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2111 prev_rp = sfp->headrp;
2112 if (srp == prev_rp) {
2113 sfp->headrp = prev_rp->nextrp;
2114 prev_rp->parentfp = NULL;
2117 while ((rp = prev_rp->nextrp)) {
2119 prev_rp->nextrp = rp->nextrp;
2120 rp->parentfp = NULL;
2127 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2132 sg_add_sfp(Sg_device * sdp)
2135 unsigned long iflags;
2138 sfp = kzalloc(sizeof(*sfp), GFP_ATOMIC | __GFP_NOWARN);
2140 return ERR_PTR(-ENOMEM);
2142 init_waitqueue_head(&sfp->read_wait);
2143 rwlock_init(&sfp->rq_list_lock);
2145 kref_init(&sfp->f_ref);
2146 sfp->timeout = SG_DEFAULT_TIMEOUT;
2147 sfp->timeout_user = SG_DEFAULT_TIMEOUT_USER;
2148 sfp->force_packid = SG_DEF_FORCE_PACK_ID;
2149 sfp->low_dma = (SG_DEF_FORCE_LOW_DMA == 0) ?
2150 sdp->device->host->unchecked_isa_dma : 1;
2151 sfp->cmd_q = SG_DEF_COMMAND_Q;
2152 sfp->keep_orphan = SG_DEF_KEEP_ORPHAN;
2153 sfp->parentdp = sdp;
2154 write_lock_irqsave(&sdp->sfd_lock, iflags);
2155 if (atomic_read(&sdp->detaching)) {
2156 write_unlock_irqrestore(&sdp->sfd_lock, iflags);
2157 return ERR_PTR(-ENODEV);
2159 list_add_tail(&sfp->sfd_siblings, &sdp->sfds);
2160 write_unlock_irqrestore(&sdp->sfd_lock, iflags);
2161 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
2162 "sg_add_sfp: sfp=0x%p\n", sfp));
2163 if (unlikely(sg_big_buff != def_reserved_size))
2164 sg_big_buff = def_reserved_size;
2166 bufflen = min_t(int, sg_big_buff,
2167 max_sectors_bytes(sdp->device->request_queue));
2168 sg_build_reserve(sfp, bufflen);
2169 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
2170 "sg_add_sfp: bufflen=%d, k_use_sg=%d\n",
2171 sfp->reserve.bufflen,
2172 sfp->reserve.k_use_sg));
2174 kref_get(&sdp->d_ref);
2175 __module_get(THIS_MODULE);
2180 sg_remove_sfp_usercontext(struct work_struct *work)
2182 struct sg_fd *sfp = container_of(work, struct sg_fd, ew.work);
2183 struct sg_device *sdp = sfp->parentdp;
2185 /* Cleanup any responses which were never read(). */
2187 sg_finish_rem_req(sfp->headrp);
2189 if (sfp->reserve.bufflen > 0) {
2190 SCSI_LOG_TIMEOUT(6, sg_printk(KERN_INFO, sdp,
2191 "sg_remove_sfp: bufflen=%d, k_use_sg=%d\n",
2192 (int) sfp->reserve.bufflen,
2193 (int) sfp->reserve.k_use_sg));
2194 sg_remove_scat(sfp, &sfp->reserve);
2197 SCSI_LOG_TIMEOUT(6, sg_printk(KERN_INFO, sdp,
2198 "sg_remove_sfp: sfp=0x%p\n", sfp));
2201 scsi_device_put(sdp->device);
2202 kref_put(&sdp->d_ref, sg_device_destroy);
2203 module_put(THIS_MODULE);
2207 sg_remove_sfp(struct kref *kref)
2209 struct sg_fd *sfp = container_of(kref, struct sg_fd, f_ref);
2210 struct sg_device *sdp = sfp->parentdp;
2211 unsigned long iflags;
2213 write_lock_irqsave(&sdp->sfd_lock, iflags);
2214 list_del(&sfp->sfd_siblings);
2215 write_unlock_irqrestore(&sdp->sfd_lock, iflags);
2217 INIT_WORK(&sfp->ew.work, sg_remove_sfp_usercontext);
2218 schedule_work(&sfp->ew.work);
2222 sg_res_in_use(Sg_fd * sfp)
2224 const Sg_request *srp;
2225 unsigned long iflags;
2227 read_lock_irqsave(&sfp->rq_list_lock, iflags);
2228 for (srp = sfp->headrp; srp; srp = srp->nextrp)
2231 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2235 #ifdef CONFIG_SCSI_PROC_FS
2237 sg_idr_max_id(int id, void *p, void *data)
2251 unsigned long iflags;
2253 read_lock_irqsave(&sg_index_lock, iflags);
2254 idr_for_each(&sg_index_idr, sg_idr_max_id, &k);
2255 read_unlock_irqrestore(&sg_index_lock, iflags);
2256 return k + 1; /* origin 1 */
2260 /* must be called with sg_index_lock held */
2261 static Sg_device *sg_lookup_dev(int dev)
2263 return idr_find(&sg_index_idr, dev);
2269 struct sg_device *sdp;
2270 unsigned long flags;
2272 read_lock_irqsave(&sg_index_lock, flags);
2273 sdp = sg_lookup_dev(dev);
2275 sdp = ERR_PTR(-ENXIO);
2276 else if (atomic_read(&sdp->detaching)) {
2277 /* If sdp->detaching, then the refcount may already be 0, in
2278 * which case it would be a bug to do kref_get().
2280 sdp = ERR_PTR(-ENODEV);
2282 kref_get(&sdp->d_ref);
2283 read_unlock_irqrestore(&sg_index_lock, flags);
2288 #ifdef CONFIG_SCSI_PROC_FS
2290 static struct proc_dir_entry *sg_proc_sgp = NULL;
2292 static char sg_proc_sg_dirname[] = "scsi/sg";
2294 static int sg_proc_seq_show_int(struct seq_file *s, void *v);
2296 static int sg_proc_single_open_adio(struct inode *inode, struct file *file);
2297 static ssize_t sg_proc_write_adio(struct file *filp, const char __user *buffer,
2298 size_t count, loff_t *off);
2299 static const struct file_operations adio_fops = {
2300 .owner = THIS_MODULE,
2301 .open = sg_proc_single_open_adio,
2303 .llseek = seq_lseek,
2304 .write = sg_proc_write_adio,
2305 .release = single_release,
2308 static int sg_proc_single_open_dressz(struct inode *inode, struct file *file);
2309 static ssize_t sg_proc_write_dressz(struct file *filp,
2310 const char __user *buffer, size_t count, loff_t *off);
2311 static const struct file_operations dressz_fops = {
2312 .owner = THIS_MODULE,
2313 .open = sg_proc_single_open_dressz,
2315 .llseek = seq_lseek,
2316 .write = sg_proc_write_dressz,
2317 .release = single_release,
2320 static int sg_proc_seq_show_version(struct seq_file *s, void *v);
2321 static int sg_proc_single_open_version(struct inode *inode, struct file *file);
2322 static const struct file_operations version_fops = {
2323 .owner = THIS_MODULE,
2324 .open = sg_proc_single_open_version,
2326 .llseek = seq_lseek,
2327 .release = single_release,
2330 static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v);
2331 static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file);
2332 static const struct file_operations devhdr_fops = {
2333 .owner = THIS_MODULE,
2334 .open = sg_proc_single_open_devhdr,
2336 .llseek = seq_lseek,
2337 .release = single_release,
2340 static int sg_proc_seq_show_dev(struct seq_file *s, void *v);
2341 static int sg_proc_open_dev(struct inode *inode, struct file *file);
2342 static void * dev_seq_start(struct seq_file *s, loff_t *pos);
2343 static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos);
2344 static void dev_seq_stop(struct seq_file *s, void *v);
2345 static const struct file_operations dev_fops = {
2346 .owner = THIS_MODULE,
2347 .open = sg_proc_open_dev,
2349 .llseek = seq_lseek,
2350 .release = seq_release,
2352 static const struct seq_operations dev_seq_ops = {
2353 .start = dev_seq_start,
2354 .next = dev_seq_next,
2355 .stop = dev_seq_stop,
2356 .show = sg_proc_seq_show_dev,
2359 static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v);
2360 static int sg_proc_open_devstrs(struct inode *inode, struct file *file);
2361 static const struct file_operations devstrs_fops = {
2362 .owner = THIS_MODULE,
2363 .open = sg_proc_open_devstrs,
2365 .llseek = seq_lseek,
2366 .release = seq_release,
2368 static const struct seq_operations devstrs_seq_ops = {
2369 .start = dev_seq_start,
2370 .next = dev_seq_next,
2371 .stop = dev_seq_stop,
2372 .show = sg_proc_seq_show_devstrs,
2375 static int sg_proc_seq_show_debug(struct seq_file *s, void *v);
2376 static int sg_proc_open_debug(struct inode *inode, struct file *file);
2377 static const struct file_operations debug_fops = {
2378 .owner = THIS_MODULE,
2379 .open = sg_proc_open_debug,
2381 .llseek = seq_lseek,
2382 .release = seq_release,
2384 static const struct seq_operations debug_seq_ops = {
2385 .start = dev_seq_start,
2386 .next = dev_seq_next,
2387 .stop = dev_seq_stop,
2388 .show = sg_proc_seq_show_debug,
2392 struct sg_proc_leaf {
2394 const struct file_operations * fops;
2397 static const struct sg_proc_leaf sg_proc_leaf_arr[] = {
2398 {"allow_dio", &adio_fops},
2399 {"debug", &debug_fops},
2400 {"def_reserved_size", &dressz_fops},
2401 {"device_hdr", &devhdr_fops},
2402 {"devices", &dev_fops},
2403 {"device_strs", &devstrs_fops},
2404 {"version", &version_fops}
2410 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
2413 sg_proc_sgp = proc_mkdir(sg_proc_sg_dirname, NULL);
2416 for (k = 0; k < num_leaves; ++k) {
2417 const struct sg_proc_leaf *leaf = &sg_proc_leaf_arr[k];
2418 umode_t mask = leaf->fops->write ? S_IRUGO | S_IWUSR : S_IRUGO;
2419 proc_create(leaf->name, mask, sg_proc_sgp, leaf->fops);
2425 sg_proc_cleanup(void)
2428 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
2432 for (k = 0; k < num_leaves; ++k)
2433 remove_proc_entry(sg_proc_leaf_arr[k].name, sg_proc_sgp);
2434 remove_proc_entry(sg_proc_sg_dirname, NULL);
2438 static int sg_proc_seq_show_int(struct seq_file *s, void *v)
2440 seq_printf(s, "%d\n", *((int *)s->private));
2444 static int sg_proc_single_open_adio(struct inode *inode, struct file *file)
2446 return single_open(file, sg_proc_seq_show_int, &sg_allow_dio);
2450 sg_proc_write_adio(struct file *filp, const char __user *buffer,
2451 size_t count, loff_t *off)
2456 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2458 err = kstrtoul_from_user(buffer, count, 0, &num);
2461 sg_allow_dio = num ? 1 : 0;
2465 static int sg_proc_single_open_dressz(struct inode *inode, struct file *file)
2467 return single_open(file, sg_proc_seq_show_int, &sg_big_buff);
2471 sg_proc_write_dressz(struct file *filp, const char __user *buffer,
2472 size_t count, loff_t *off)
2475 unsigned long k = ULONG_MAX;
2477 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2480 err = kstrtoul_from_user(buffer, count, 0, &k);
2483 if (k <= 1048576) { /* limit "big buff" to 1 MB */
2490 static int sg_proc_seq_show_version(struct seq_file *s, void *v)
2492 seq_printf(s, "%d\t%s [%s]\n", sg_version_num, SG_VERSION_STR,
2497 static int sg_proc_single_open_version(struct inode *inode, struct file *file)
2499 return single_open(file, sg_proc_seq_show_version, NULL);
2502 static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v)
2504 seq_puts(s, "host\tchan\tid\tlun\ttype\topens\tqdepth\tbusy\tonline\n");
2508 static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file)
2510 return single_open(file, sg_proc_seq_show_devhdr, NULL);
2513 struct sg_proc_deviter {
2518 static void * dev_seq_start(struct seq_file *s, loff_t *pos)
2520 struct sg_proc_deviter * it = kmalloc(sizeof(*it), GFP_KERNEL);
2527 it->max = sg_last_dev();
2528 if (it->index >= it->max)
2533 static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos)
2535 struct sg_proc_deviter * it = s->private;
2538 return (it->index < it->max) ? it : NULL;
2541 static void dev_seq_stop(struct seq_file *s, void *v)
2546 static int sg_proc_open_dev(struct inode *inode, struct file *file)
2548 return seq_open(file, &dev_seq_ops);
2551 static int sg_proc_seq_show_dev(struct seq_file *s, void *v)
2553 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2555 struct scsi_device *scsidp;
2556 unsigned long iflags;
2558 read_lock_irqsave(&sg_index_lock, iflags);
2559 sdp = it ? sg_lookup_dev(it->index) : NULL;
2560 if ((NULL == sdp) || (NULL == sdp->device) ||
2561 (atomic_read(&sdp->detaching)))
2562 seq_puts(s, "-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\n");
2564 scsidp = sdp->device;
2565 seq_printf(s, "%d\t%d\t%d\t%llu\t%d\t%d\t%d\t%d\t%d\n",
2566 scsidp->host->host_no, scsidp->channel,
2567 scsidp->id, scsidp->lun, (int) scsidp->type,
2569 (int) scsidp->queue_depth,
2570 (int) atomic_read(&scsidp->device_busy),
2571 (int) scsi_device_online(scsidp));
2573 read_unlock_irqrestore(&sg_index_lock, iflags);
2577 static int sg_proc_open_devstrs(struct inode *inode, struct file *file)
2579 return seq_open(file, &devstrs_seq_ops);
2582 static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v)
2584 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2586 struct scsi_device *scsidp;
2587 unsigned long iflags;
2589 read_lock_irqsave(&sg_index_lock, iflags);
2590 sdp = it ? sg_lookup_dev(it->index) : NULL;
2591 scsidp = sdp ? sdp->device : NULL;
2592 if (sdp && scsidp && (!atomic_read(&sdp->detaching)))
2593 seq_printf(s, "%8.8s\t%16.16s\t%4.4s\n",
2594 scsidp->vendor, scsidp->model, scsidp->rev);
2596 seq_puts(s, "<no active device>\n");
2597 read_unlock_irqrestore(&sg_index_lock, iflags);
2601 /* must be called while holding sg_index_lock */
2602 static void sg_proc_debug_helper(struct seq_file *s, Sg_device * sdp)
2604 int k, m, new_interface, blen, usg;
2607 const sg_io_hdr_t *hp;
2612 list_for_each_entry(fp, &sdp->sfds, sfd_siblings) {
2614 read_lock(&fp->rq_list_lock); /* irqs already disabled */
2615 seq_printf(s, " FD(%d): timeout=%dms bufflen=%d "
2616 "(res)sgat=%d low_dma=%d\n", k,
2617 jiffies_to_msecs(fp->timeout),
2618 fp->reserve.bufflen,
2619 (int) fp->reserve.k_use_sg,
2621 seq_printf(s, " cmd_q=%d f_packid=%d k_orphan=%d closed=0\n",
2622 (int) fp->cmd_q, (int) fp->force_packid,
2623 (int) fp->keep_orphan);
2624 for (m = 0, srp = fp->headrp;
2626 ++m, srp = srp->nextrp) {
2628 new_interface = (hp->interface_id == '\0') ? 0 : 1;
2629 if (srp->res_used) {
2630 if (new_interface &&
2631 (SG_FLAG_MMAP_IO & hp->flags))
2636 if (SG_INFO_DIRECT_IO_MASK & hp->info)
2642 blen = srp->data.bufflen;
2643 usg = srp->data.k_use_sg;
2644 seq_puts(s, srp->done ?
2645 ((1 == srp->done) ? "rcv:" : "fin:")
2647 seq_printf(s, " id=%d blen=%d",
2648 srp->header.pack_id, blen);
2650 seq_printf(s, " dur=%d", hp->duration);
2652 ms = jiffies_to_msecs(jiffies);
2653 seq_printf(s, " t_o/elap=%d/%d",
2654 (new_interface ? hp->timeout :
2655 jiffies_to_msecs(fp->timeout)),
2656 (ms > hp->duration ? ms - hp->duration : 0));
2658 seq_printf(s, "ms sgat=%d op=0x%02x\n", usg,
2659 (int) srp->data.cmd_opcode);
2662 seq_puts(s, " No requests active\n");
2663 read_unlock(&fp->rq_list_lock);
2667 static int sg_proc_open_debug(struct inode *inode, struct file *file)
2669 return seq_open(file, &debug_seq_ops);
2672 static int sg_proc_seq_show_debug(struct seq_file *s, void *v)
2674 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2676 unsigned long iflags;
2678 if (it && (0 == it->index))
2679 seq_printf(s, "max_active_device=%d def_reserved_size=%d\n",
2680 (int)it->max, sg_big_buff);
2682 read_lock_irqsave(&sg_index_lock, iflags);
2683 sdp = it ? sg_lookup_dev(it->index) : NULL;
2686 read_lock(&sdp->sfd_lock);
2687 if (!list_empty(&sdp->sfds)) {
2688 seq_printf(s, " >>> device=%s ", sdp->disk->disk_name);
2689 if (atomic_read(&sdp->detaching))
2690 seq_puts(s, "detaching pending close ");
2691 else if (sdp->device) {
2692 struct scsi_device *scsidp = sdp->device;
2694 seq_printf(s, "%d:%d:%d:%llu em=%d",
2695 scsidp->host->host_no,
2696 scsidp->channel, scsidp->id,
2698 scsidp->host->hostt->emulated);
2700 seq_printf(s, " sg_tablesize=%d excl=%d open_cnt=%d\n",
2701 sdp->sg_tablesize, sdp->exclude, sdp->open_cnt);
2702 sg_proc_debug_helper(s, sdp);
2704 read_unlock(&sdp->sfd_lock);
2706 read_unlock_irqrestore(&sg_index_lock, iflags);
2710 #endif /* CONFIG_SCSI_PROC_FS */
2712 module_init(init_sg);
2713 module_exit(exit_sg);