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>
54 #include <linux/cred.h> /* for sg_check_file_access() */
57 #include <scsi/scsi_dbg.h>
58 #include <scsi/scsi_host.h>
59 #include <scsi/scsi_driver.h>
60 #include <scsi/scsi_ioctl.h>
63 #include "scsi_logging.h"
65 #ifdef CONFIG_SCSI_PROC_FS
66 #include <linux/proc_fs.h>
67 static char *sg_version_date = "20140603";
69 static int sg_proc_init(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 list_head entry; /* list entry */
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 struct mutex f_mutex; /* protect against changes in this fd */
146 int timeout; /* defaults to SG_DEFAULT_TIMEOUT */
147 int timeout_user; /* defaults to SG_DEFAULT_TIMEOUT_USER */
148 Sg_scatter_hold reserve; /* buffer held for this file descriptor */
149 struct list_head rq_list; /* head of request list */
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 force_packid; /* 1 -> pack_id input to read(), 0 -> ignored */
153 char cmd_q; /* 1 -> allow command queuing, 0 -> don't */
154 unsigned char next_cmd_len; /* 0: automatic, >0: use on next write() */
155 char keep_orphan; /* 0 -> drop orphan (def), 1 -> keep for read() */
156 char mmap_called; /* 0 -> mmap() never called on this fd */
157 char res_in_use; /* 1 -> 'reserve' array in use */
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, blk_status_t status);
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 Sg_device *sg_get_dev(int dev);
202 static void sg_device_destroy(struct kref *kref);
204 #define SZ_SG_HEADER sizeof(struct sg_header)
205 #define SZ_SG_IO_HDR sizeof(sg_io_hdr_t)
206 #define SZ_SG_IOVEC sizeof(sg_iovec_t)
207 #define SZ_SG_REQ_INFO sizeof(sg_req_info_t)
209 #define sg_printk(prefix, sdp, fmt, a...) \
210 sdev_prefix_printk(prefix, (sdp)->device, \
211 (sdp)->disk->disk_name, fmt, ##a)
214 * The SCSI interfaces that use read() and write() as an asynchronous variant of
215 * ioctl(..., SG_IO, ...) are fundamentally unsafe, since there are lots of ways
216 * to trigger read() and write() calls from various contexts with elevated
217 * privileges. This can lead to kernel memory corruption (e.g. if these
218 * interfaces are called through splice()) and privilege escalation inside
219 * userspace (e.g. if a process with access to such a device passes a file
220 * descriptor to a SUID binary as stdin/stdout/stderr).
222 * This function provides protection for the legacy API by restricting the
225 static int sg_check_file_access(struct file *filp, const char *caller)
227 if (filp->f_cred != current_real_cred()) {
228 pr_err_once("%s: process %d (%s) changed security contexts after opening file descriptor, this is not allowed.\n",
229 caller, task_tgid_vnr(current), current->comm);
232 if (uaccess_kernel()) {
233 pr_err_once("%s: process %d (%s) called from kernel context, this is not allowed.\n",
234 caller, task_tgid_vnr(current), current->comm);
240 static int sg_allow_access(struct file *filp, unsigned char *cmd)
242 struct sg_fd *sfp = filp->private_data;
244 if (sfp->parentdp->device->type == TYPE_SCANNER)
247 return blk_verify_command(cmd, filp->f_mode);
251 open_wait(Sg_device *sdp, int flags)
255 if (flags & O_EXCL) {
256 while (sdp->open_cnt > 0) {
257 mutex_unlock(&sdp->open_rel_lock);
258 retval = wait_event_interruptible(sdp->open_wait,
259 (atomic_read(&sdp->detaching) ||
261 mutex_lock(&sdp->open_rel_lock);
263 if (retval) /* -ERESTARTSYS */
265 if (atomic_read(&sdp->detaching))
269 while (sdp->exclude) {
270 mutex_unlock(&sdp->open_rel_lock);
271 retval = wait_event_interruptible(sdp->open_wait,
272 (atomic_read(&sdp->detaching) ||
274 mutex_lock(&sdp->open_rel_lock);
276 if (retval) /* -ERESTARTSYS */
278 if (atomic_read(&sdp->detaching))
286 /* Returns 0 on success, else a negated errno value */
288 sg_open(struct inode *inode, struct file *filp)
290 int dev = iminor(inode);
291 int flags = filp->f_flags;
292 struct request_queue *q;
297 nonseekable_open(inode, filp);
298 if ((flags & O_EXCL) && (O_RDONLY == (flags & O_ACCMODE)))
299 return -EPERM; /* Can't lock it with read only access */
300 sdp = sg_get_dev(dev);
304 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
305 "sg_open: flags=0x%x\n", flags));
307 /* This driver's module count bumped by fops_get in <linux/fs.h> */
308 /* Prevent the device driver from vanishing while we sleep */
309 retval = scsi_device_get(sdp->device);
313 retval = scsi_autopm_get_device(sdp->device);
317 /* scsi_block_when_processing_errors() may block so bypass
318 * check if O_NONBLOCK. Permits SCSI commands to be issued
319 * during error recovery. Tread carefully. */
320 if (!((flags & O_NONBLOCK) ||
321 scsi_block_when_processing_errors(sdp->device))) {
323 /* we are in error recovery for this device */
327 mutex_lock(&sdp->open_rel_lock);
328 if (flags & O_NONBLOCK) {
329 if (flags & O_EXCL) {
330 if (sdp->open_cnt > 0) {
332 goto error_mutex_locked;
337 goto error_mutex_locked;
341 retval = open_wait(sdp, flags);
342 if (retval) /* -ERESTARTSYS or -ENODEV */
343 goto error_mutex_locked;
346 /* N.B. at this point we are holding the open_rel_lock */
350 if (sdp->open_cnt < 1) { /* no existing opens */
352 q = sdp->device->request_queue;
353 sdp->sg_tablesize = queue_max_segments(q);
355 sfp = sg_add_sfp(sdp);
357 retval = PTR_ERR(sfp);
361 filp->private_data = sfp;
363 mutex_unlock(&sdp->open_rel_lock);
367 kref_put(&sdp->d_ref, sg_device_destroy);
371 if (flags & O_EXCL) {
372 sdp->exclude = false; /* undo if error */
373 wake_up_interruptible(&sdp->open_wait);
376 mutex_unlock(&sdp->open_rel_lock);
378 scsi_autopm_put_device(sdp->device);
380 scsi_device_put(sdp->device);
384 /* Release resources associated with a successful sg_open()
385 * Returns 0 on success, else a negated errno value */
387 sg_release(struct inode *inode, struct file *filp)
392 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
394 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp, "sg_release\n"));
396 mutex_lock(&sdp->open_rel_lock);
397 scsi_autopm_put_device(sdp->device);
398 kref_put(&sfp->f_ref, sg_remove_sfp);
401 /* possibly many open()s waiting on exlude clearing, start many;
402 * only open(O_EXCL)s wait on 0==open_cnt so only start one */
404 sdp->exclude = false;
405 wake_up_interruptible_all(&sdp->open_wait);
406 } else if (0 == sdp->open_cnt) {
407 wake_up_interruptible(&sdp->open_wait);
409 mutex_unlock(&sdp->open_rel_lock);
414 sg_read(struct file *filp, char __user *buf, size_t count, loff_t * ppos)
419 int req_pack_id = -1;
421 struct sg_header *old_hdr = NULL;
425 * This could cause a response to be stranded. Close the associated
426 * file descriptor to free up any resources being held.
428 retval = sg_check_file_access(filp, __func__);
432 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
434 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
435 "sg_read: count=%d\n", (int) count));
437 if (!access_ok(VERIFY_WRITE, buf, count))
439 if (sfp->force_packid && (count >= SZ_SG_HEADER)) {
440 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
443 if (__copy_from_user(old_hdr, buf, SZ_SG_HEADER)) {
447 if (old_hdr->reply_len < 0) {
448 if (count >= SZ_SG_IO_HDR) {
449 sg_io_hdr_t *new_hdr;
450 new_hdr = kmalloc(SZ_SG_IO_HDR, GFP_KERNEL);
455 retval =__copy_from_user
456 (new_hdr, buf, SZ_SG_IO_HDR);
457 req_pack_id = new_hdr->pack_id;
465 req_pack_id = old_hdr->pack_id;
467 srp = sg_get_rq_mark(sfp, req_pack_id);
468 if (!srp) { /* now wait on packet to arrive */
469 if (atomic_read(&sdp->detaching)) {
473 if (filp->f_flags & O_NONBLOCK) {
477 retval = wait_event_interruptible(sfp->read_wait,
478 (atomic_read(&sdp->detaching) ||
479 (srp = sg_get_rq_mark(sfp, req_pack_id))));
480 if (atomic_read(&sdp->detaching)) {
485 /* -ERESTARTSYS as signal hit process */
489 if (srp->header.interface_id != '\0') {
490 retval = sg_new_read(sfp, buf, count, srp);
495 if (old_hdr == NULL) {
496 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
502 memset(old_hdr, 0, SZ_SG_HEADER);
503 old_hdr->reply_len = (int) hp->timeout;
504 old_hdr->pack_len = old_hdr->reply_len; /* old, strange behaviour */
505 old_hdr->pack_id = hp->pack_id;
506 old_hdr->twelve_byte =
507 ((srp->data.cmd_opcode >= 0xc0) && (12 == hp->cmd_len)) ? 1 : 0;
508 old_hdr->target_status = hp->masked_status;
509 old_hdr->host_status = hp->host_status;
510 old_hdr->driver_status = hp->driver_status;
511 if ((CHECK_CONDITION & hp->masked_status) ||
512 (DRIVER_SENSE & hp->driver_status))
513 memcpy(old_hdr->sense_buffer, srp->sense_b,
514 sizeof (old_hdr->sense_buffer));
515 switch (hp->host_status) {
516 /* This setup of 'result' is for backward compatibility and is best
517 ignored by the user who should use target, host + driver status */
519 case DID_PASSTHROUGH:
526 old_hdr->result = EBUSY;
533 old_hdr->result = EIO;
536 old_hdr->result = (srp->sense_b[0] == 0 &&
537 hp->masked_status == GOOD) ? 0 : EIO;
540 old_hdr->result = EIO;
544 /* Now copy the result back to the user buffer. */
545 if (count >= SZ_SG_HEADER) {
546 if (__copy_to_user(buf, old_hdr, SZ_SG_HEADER)) {
551 if (count > old_hdr->reply_len)
552 count = old_hdr->reply_len;
553 if (count > SZ_SG_HEADER) {
554 if (sg_read_oxfer(srp, buf, count - SZ_SG_HEADER)) {
560 count = (old_hdr->result == 0) ? 0 : -EIO;
561 sg_finish_rem_req(srp);
562 sg_remove_request(sfp, srp);
570 sg_new_read(Sg_fd * sfp, char __user *buf, size_t count, Sg_request * srp)
572 sg_io_hdr_t *hp = &srp->header;
576 if (count < SZ_SG_IO_HDR) {
581 if ((hp->mx_sb_len > 0) && hp->sbp) {
582 if ((CHECK_CONDITION & hp->masked_status) ||
583 (DRIVER_SENSE & hp->driver_status)) {
584 int sb_len = SCSI_SENSE_BUFFERSIZE;
585 sb_len = (hp->mx_sb_len > sb_len) ? sb_len : hp->mx_sb_len;
586 len = 8 + (int) srp->sense_b[7]; /* Additional sense length field */
587 len = (len > sb_len) ? sb_len : len;
588 if (copy_to_user(hp->sbp, srp->sense_b, len)) {
595 if (hp->masked_status || hp->host_status || hp->driver_status)
596 hp->info |= SG_INFO_CHECK;
597 if (copy_to_user(buf, hp, SZ_SG_IO_HDR)) {
602 err2 = sg_finish_rem_req(srp);
603 sg_remove_request(sfp, srp);
604 return err ? : err2 ? : count;
608 sg_write(struct file *filp, const char __user *buf, size_t count, loff_t * ppos)
610 int mxsize, cmd_size, k;
611 int input_size, blocking;
612 unsigned char opcode;
616 struct sg_header old_hdr;
618 unsigned char cmnd[SG_MAX_CDB_SIZE];
621 retval = sg_check_file_access(filp, __func__);
625 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
627 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
628 "sg_write: count=%d\n", (int) count));
629 if (atomic_read(&sdp->detaching))
631 if (!((filp->f_flags & O_NONBLOCK) ||
632 scsi_block_when_processing_errors(sdp->device)))
635 if (!access_ok(VERIFY_READ, buf, count))
636 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
637 if (count < SZ_SG_HEADER)
639 if (__copy_from_user(&old_hdr, buf, SZ_SG_HEADER))
641 blocking = !(filp->f_flags & O_NONBLOCK);
642 if (old_hdr.reply_len < 0)
643 return sg_new_write(sfp, filp, buf, count,
644 blocking, 0, 0, NULL);
645 if (count < (SZ_SG_HEADER + 6))
646 return -EIO; /* The minimum scsi command length is 6 bytes. */
648 if (!(srp = sg_add_request(sfp))) {
649 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO, sdp,
650 "sg_write: queue full\n"));
654 __get_user(opcode, buf);
655 mutex_lock(&sfp->f_mutex);
656 if (sfp->next_cmd_len > 0) {
657 cmd_size = sfp->next_cmd_len;
658 sfp->next_cmd_len = 0; /* reset so only this write() effected */
660 cmd_size = COMMAND_SIZE(opcode); /* based on SCSI command group */
661 if ((opcode >= 0xc0) && old_hdr.twelve_byte)
664 mutex_unlock(&sfp->f_mutex);
665 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sdp,
666 "sg_write: scsi opcode=0x%02x, cmd_size=%d\n", (int) opcode, cmd_size));
667 /* Determine buffer size. */
668 input_size = count - cmd_size;
669 mxsize = (input_size > old_hdr.reply_len) ? input_size : old_hdr.reply_len;
670 mxsize -= SZ_SG_HEADER;
671 input_size -= SZ_SG_HEADER;
672 if (input_size < 0) {
673 sg_remove_request(sfp, srp);
674 return -EIO; /* User did not pass enough bytes for this command. */
677 hp->interface_id = '\0'; /* indicator of old interface tunnelled */
678 hp->cmd_len = (unsigned char) cmd_size;
682 hp->dxfer_direction = (old_hdr.reply_len > SZ_SG_HEADER) ?
683 SG_DXFER_TO_FROM_DEV : SG_DXFER_TO_DEV;
685 hp->dxfer_direction = (mxsize > 0) ? SG_DXFER_FROM_DEV : SG_DXFER_NONE;
686 hp->dxfer_len = mxsize;
687 if ((hp->dxfer_direction == SG_DXFER_TO_DEV) ||
688 (hp->dxfer_direction == SG_DXFER_TO_FROM_DEV))
689 hp->dxferp = (char __user *)buf + cmd_size;
693 hp->timeout = old_hdr.reply_len; /* structure abuse ... */
694 hp->flags = input_size; /* structure abuse ... */
695 hp->pack_id = old_hdr.pack_id;
697 if (__copy_from_user(cmnd, buf, cmd_size)) {
698 sg_remove_request(sfp, srp);
702 * SG_DXFER_TO_FROM_DEV is functionally equivalent to SG_DXFER_FROM_DEV,
703 * but is is possible that the app intended SG_DXFER_TO_DEV, because there
704 * is a non-zero input_size, so emit a warning.
706 if (hp->dxfer_direction == SG_DXFER_TO_FROM_DEV) {
707 printk_ratelimited(KERN_WARNING
708 "sg_write: data in/out %d/%d bytes "
709 "for SCSI command 0x%x-- guessing "
710 "data in;\n program %s not setting "
711 "count and/or reply_len properly\n",
712 old_hdr.reply_len - (int)SZ_SG_HEADER,
713 input_size, (unsigned int) cmnd[0],
716 k = sg_common_write(sfp, srp, cmnd, sfp->timeout, blocking);
717 return (k < 0) ? k : count;
721 sg_new_write(Sg_fd *sfp, struct file *file, const char __user *buf,
722 size_t count, int blocking, int read_only, int sg_io_owned,
728 unsigned char cmnd[SG_MAX_CDB_SIZE];
730 unsigned long ul_timeout;
732 if (count < SZ_SG_IO_HDR)
734 if (!access_ok(VERIFY_READ, buf, count))
735 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
737 sfp->cmd_q = 1; /* when sg_io_hdr seen, set command queuing on */
738 if (!(srp = sg_add_request(sfp))) {
739 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO, sfp->parentdp,
740 "sg_new_write: queue full\n"));
743 srp->sg_io_owned = sg_io_owned;
745 if (__copy_from_user(hp, buf, SZ_SG_IO_HDR)) {
746 sg_remove_request(sfp, srp);
749 if (hp->interface_id != 'S') {
750 sg_remove_request(sfp, srp);
753 if (hp->flags & SG_FLAG_MMAP_IO) {
754 if (hp->dxfer_len > sfp->reserve.bufflen) {
755 sg_remove_request(sfp, srp);
756 return -ENOMEM; /* MMAP_IO size must fit in reserve buffer */
758 if (hp->flags & SG_FLAG_DIRECT_IO) {
759 sg_remove_request(sfp, srp);
760 return -EINVAL; /* either MMAP_IO or DIRECT_IO (not both) */
762 if (sfp->res_in_use) {
763 sg_remove_request(sfp, srp);
764 return -EBUSY; /* reserve buffer already being used */
767 ul_timeout = msecs_to_jiffies(srp->header.timeout);
768 timeout = (ul_timeout < INT_MAX) ? ul_timeout : INT_MAX;
769 if ((!hp->cmdp) || (hp->cmd_len < 6) || (hp->cmd_len > sizeof (cmnd))) {
770 sg_remove_request(sfp, srp);
773 if (!access_ok(VERIFY_READ, hp->cmdp, hp->cmd_len)) {
774 sg_remove_request(sfp, srp);
775 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
777 if (__copy_from_user(cmnd, hp->cmdp, hp->cmd_len)) {
778 sg_remove_request(sfp, srp);
781 if (read_only && sg_allow_access(file, cmnd)) {
782 sg_remove_request(sfp, srp);
785 k = sg_common_write(sfp, srp, cmnd, timeout, blocking);
794 sg_common_write(Sg_fd * sfp, Sg_request * srp,
795 unsigned char *cmnd, int timeout, int blocking)
798 Sg_device *sdp = sfp->parentdp;
799 sg_io_hdr_t *hp = &srp->header;
801 srp->data.cmd_opcode = cmnd[0]; /* hold opcode of command */
803 hp->masked_status = 0;
807 hp->driver_status = 0;
809 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
810 "sg_common_write: scsi opcode=0x%02x, cmd_size=%d\n",
811 (int) cmnd[0], (int) hp->cmd_len));
813 if (hp->dxfer_len >= SZ_256M) {
814 sg_remove_request(sfp, srp);
818 k = sg_start_req(srp, cmnd);
820 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO, sfp->parentdp,
821 "sg_common_write: start_req err=%d\n", k));
822 sg_finish_rem_req(srp);
823 sg_remove_request(sfp, srp);
824 return k; /* probably out of space --> ENOMEM */
826 if (atomic_read(&sdp->detaching)) {
828 scsi_req_free_cmd(scsi_req(srp->rq));
829 blk_end_request_all(srp->rq, BLK_STS_IOERR);
833 sg_finish_rem_req(srp);
834 sg_remove_request(sfp, srp);
838 hp->duration = jiffies_to_msecs(jiffies);
839 if (hp->interface_id != '\0' && /* v3 (or later) interface */
840 (SG_FLAG_Q_AT_TAIL & hp->flags))
845 srp->rq->timeout = timeout;
846 kref_get(&sfp->f_ref); /* sg_rq_end_io() does kref_put(). */
847 blk_execute_rq_nowait(sdp->device->request_queue, sdp->disk,
848 srp->rq, at_head, sg_rq_end_io);
852 static int srp_done(Sg_fd *sfp, Sg_request *srp)
857 read_lock_irqsave(&sfp->rq_list_lock, flags);
859 read_unlock_irqrestore(&sfp->rq_list_lock, flags);
863 static int max_sectors_bytes(struct request_queue *q)
865 unsigned int max_sectors = queue_max_sectors(q);
867 max_sectors = min_t(unsigned int, max_sectors, INT_MAX >> 9);
869 return max_sectors << 9;
873 sg_fill_request_table(Sg_fd *sfp, sg_req_info_t *rinfo)
880 list_for_each_entry(srp, &sfp->rq_list, entry) {
881 if (val >= SG_MAX_QUEUE)
883 rinfo[val].req_state = srp->done + 1;
885 srp->header.masked_status &
886 srp->header.host_status &
887 srp->header.driver_status;
889 rinfo[val].duration =
890 srp->header.duration;
892 ms = jiffies_to_msecs(jiffies);
893 rinfo[val].duration =
894 (ms > srp->header.duration) ?
895 (ms - srp->header.duration) : 0;
897 rinfo[val].orphan = srp->orphan;
898 rinfo[val].sg_io_owned = srp->sg_io_owned;
899 rinfo[val].pack_id = srp->header.pack_id;
900 rinfo[val].usr_ptr = srp->header.usr_ptr;
906 sg_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
908 void __user *p = (void __user *)arg;
910 int result, val, read_only;
914 unsigned long iflags;
916 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
919 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
920 "sg_ioctl: cmd=0x%x\n", (int) cmd_in));
921 read_only = (O_RDWR != (filp->f_flags & O_ACCMODE));
925 if (atomic_read(&sdp->detaching))
927 if (!scsi_block_when_processing_errors(sdp->device))
929 if (!access_ok(VERIFY_WRITE, p, SZ_SG_IO_HDR))
931 result = sg_new_write(sfp, filp, p, SZ_SG_IO_HDR,
932 1, read_only, 1, &srp);
935 result = wait_event_interruptible(sfp->read_wait,
936 (srp_done(sfp, srp) || atomic_read(&sdp->detaching)));
937 if (atomic_read(&sdp->detaching))
939 write_lock_irq(&sfp->rq_list_lock);
942 write_unlock_irq(&sfp->rq_list_lock);
943 result = sg_new_read(sfp, p, SZ_SG_IO_HDR, srp);
944 return (result < 0) ? result : 0;
947 write_unlock_irq(&sfp->rq_list_lock);
948 return result; /* -ERESTARTSYS because signal hit process */
950 result = get_user(val, ip);
955 if (val >= mult_frac((s64)INT_MAX, USER_HZ, HZ))
956 val = min_t(s64, mult_frac((s64)INT_MAX, USER_HZ, HZ),
958 sfp->timeout_user = val;
959 sfp->timeout = mult_frac(val, HZ, USER_HZ);
962 case SG_GET_TIMEOUT: /* N.B. User receives timeout as return value */
963 /* strange ..., for backward compatibility */
964 return sfp->timeout_user;
965 case SG_SET_FORCE_LOW_DMA:
967 * N.B. This ioctl never worked properly, but failed to
968 * return an error value. So returning '0' to keep compability
969 * with legacy applications.
973 return put_user((int) sdp->device->host->unchecked_isa_dma, ip);
975 if (!access_ok(VERIFY_WRITE, p, sizeof (sg_scsi_id_t)))
978 sg_scsi_id_t __user *sg_idp = p;
980 if (atomic_read(&sdp->detaching))
982 __put_user((int) sdp->device->host->host_no,
984 __put_user((int) sdp->device->channel,
986 __put_user((int) sdp->device->id, &sg_idp->scsi_id);
987 __put_user((int) sdp->device->lun, &sg_idp->lun);
988 __put_user((int) sdp->device->type, &sg_idp->scsi_type);
989 __put_user((short) sdp->device->host->cmd_per_lun,
990 &sg_idp->h_cmd_per_lun);
991 __put_user((short) sdp->device->queue_depth,
992 &sg_idp->d_queue_depth);
993 __put_user(0, &sg_idp->unused[0]);
994 __put_user(0, &sg_idp->unused[1]);
997 case SG_SET_FORCE_PACK_ID:
998 result = get_user(val, ip);
1001 sfp->force_packid = val ? 1 : 0;
1003 case SG_GET_PACK_ID:
1004 if (!access_ok(VERIFY_WRITE, ip, sizeof (int)))
1006 read_lock_irqsave(&sfp->rq_list_lock, iflags);
1007 list_for_each_entry(srp, &sfp->rq_list, entry) {
1008 if ((1 == srp->done) && (!srp->sg_io_owned)) {
1009 read_unlock_irqrestore(&sfp->rq_list_lock,
1011 __put_user(srp->header.pack_id, ip);
1015 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1018 case SG_GET_NUM_WAITING:
1019 read_lock_irqsave(&sfp->rq_list_lock, iflags);
1021 list_for_each_entry(srp, &sfp->rq_list, entry) {
1022 if ((1 == srp->done) && (!srp->sg_io_owned))
1025 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1026 return put_user(val, ip);
1027 case SG_GET_SG_TABLESIZE:
1028 return put_user(sdp->sg_tablesize, ip);
1029 case SG_SET_RESERVED_SIZE:
1030 result = get_user(val, ip);
1035 val = min_t(int, val,
1036 max_sectors_bytes(sdp->device->request_queue));
1037 mutex_lock(&sfp->f_mutex);
1038 if (val != sfp->reserve.bufflen) {
1039 if (sfp->mmap_called ||
1041 mutex_unlock(&sfp->f_mutex);
1045 sg_remove_scat(sfp, &sfp->reserve);
1046 sg_build_reserve(sfp, val);
1048 mutex_unlock(&sfp->f_mutex);
1050 case SG_GET_RESERVED_SIZE:
1051 val = min_t(int, sfp->reserve.bufflen,
1052 max_sectors_bytes(sdp->device->request_queue));
1053 return put_user(val, ip);
1054 case SG_SET_COMMAND_Q:
1055 result = get_user(val, ip);
1058 sfp->cmd_q = val ? 1 : 0;
1060 case SG_GET_COMMAND_Q:
1061 return put_user((int) sfp->cmd_q, ip);
1062 case SG_SET_KEEP_ORPHAN:
1063 result = get_user(val, ip);
1066 sfp->keep_orphan = val;
1068 case SG_GET_KEEP_ORPHAN:
1069 return put_user((int) sfp->keep_orphan, ip);
1070 case SG_NEXT_CMD_LEN:
1071 result = get_user(val, ip);
1074 if (val > SG_MAX_CDB_SIZE)
1076 sfp->next_cmd_len = (val > 0) ? val : 0;
1078 case SG_GET_VERSION_NUM:
1079 return put_user(sg_version_num, ip);
1080 case SG_GET_ACCESS_COUNT:
1081 /* faked - we don't have a real access count anymore */
1082 val = (sdp->device ? 1 : 0);
1083 return put_user(val, ip);
1084 case SG_GET_REQUEST_TABLE:
1085 if (!access_ok(VERIFY_WRITE, p, SZ_SG_REQ_INFO * SG_MAX_QUEUE))
1088 sg_req_info_t *rinfo;
1090 rinfo = kcalloc(SG_MAX_QUEUE, SZ_SG_REQ_INFO,
1094 read_lock_irqsave(&sfp->rq_list_lock, iflags);
1095 sg_fill_request_table(sfp, rinfo);
1096 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1097 result = __copy_to_user(p, rinfo,
1098 SZ_SG_REQ_INFO * SG_MAX_QUEUE);
1099 result = result ? -EFAULT : 0;
1103 case SG_EMULATED_HOST:
1104 if (atomic_read(&sdp->detaching))
1106 return put_user(sdp->device->host->hostt->emulated, ip);
1107 case SCSI_IOCTL_SEND_COMMAND:
1108 if (atomic_read(&sdp->detaching))
1110 return sg_scsi_ioctl(sdp->device->request_queue, NULL, filp->f_mode, p);
1112 result = get_user(val, ip);
1115 sdp->sgdebug = (char) val;
1118 return put_user(max_sectors_bytes(sdp->device->request_queue),
1121 return blk_trace_setup(sdp->device->request_queue,
1122 sdp->disk->disk_name,
1123 MKDEV(SCSI_GENERIC_MAJOR, sdp->index),
1126 return blk_trace_startstop(sdp->device->request_queue, 1);
1128 return blk_trace_startstop(sdp->device->request_queue, 0);
1129 case BLKTRACETEARDOWN:
1130 return blk_trace_remove(sdp->device->request_queue);
1131 case SCSI_IOCTL_GET_IDLUN:
1132 case SCSI_IOCTL_GET_BUS_NUMBER:
1133 case SCSI_IOCTL_PROBE_HOST:
1134 case SG_GET_TRANSFORM:
1136 if (atomic_read(&sdp->detaching))
1141 return -EPERM; /* don't know so take safe approach */
1145 result = scsi_ioctl_block_when_processing_errors(sdp->device,
1146 cmd_in, filp->f_flags & O_NDELAY);
1149 return scsi_ioctl(sdp->device, cmd_in, p);
1152 #ifdef CONFIG_COMPAT
1153 static long sg_compat_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
1157 struct scsi_device *sdev;
1159 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1163 if (sdev->host->hostt->compat_ioctl) {
1166 ret = sdev->host->hostt->compat_ioctl(sdev, cmd_in, (void __user *)arg);
1171 return -ENOIOCTLCMD;
1176 sg_poll(struct file *filp, poll_table * wait)
1183 unsigned long iflags;
1185 sfp = filp->private_data;
1188 sdp = sfp->parentdp;
1191 poll_wait(filp, &sfp->read_wait, wait);
1192 read_lock_irqsave(&sfp->rq_list_lock, iflags);
1193 list_for_each_entry(srp, &sfp->rq_list, entry) {
1194 /* if any read waiting, flag it */
1195 if ((0 == res) && (1 == srp->done) && (!srp->sg_io_owned))
1196 res = EPOLLIN | EPOLLRDNORM;
1199 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1201 if (atomic_read(&sdp->detaching))
1203 else if (!sfp->cmd_q) {
1205 res |= EPOLLOUT | EPOLLWRNORM;
1206 } else if (count < SG_MAX_QUEUE)
1207 res |= EPOLLOUT | EPOLLWRNORM;
1208 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
1209 "sg_poll: res=0x%x\n", (__force u32) res));
1214 sg_fasync(int fd, struct file *filp, int mode)
1219 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1221 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
1222 "sg_fasync: mode=%d\n", mode));
1224 return fasync_helper(fd, filp, mode, &sfp->async_qp);
1228 sg_vma_fault(struct vm_fault *vmf)
1230 struct vm_area_struct *vma = vmf->vma;
1232 unsigned long offset, len, sa;
1233 Sg_scatter_hold *rsv_schp;
1236 if ((NULL == vma) || (!(sfp = (Sg_fd *) vma->vm_private_data)))
1237 return VM_FAULT_SIGBUS;
1238 rsv_schp = &sfp->reserve;
1239 offset = vmf->pgoff << PAGE_SHIFT;
1240 if (offset >= rsv_schp->bufflen)
1241 return VM_FAULT_SIGBUS;
1242 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sfp->parentdp,
1243 "sg_vma_fault: offset=%lu, scatg=%d\n",
1244 offset, rsv_schp->k_use_sg));
1246 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1247 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
1248 len = vma->vm_end - sa;
1249 len = (len < length) ? len : length;
1251 struct page *page = nth_page(rsv_schp->pages[k],
1252 offset >> PAGE_SHIFT);
1253 get_page(page); /* increment page count */
1255 return 0; /* success */
1261 return VM_FAULT_SIGBUS;
1264 static const struct vm_operations_struct sg_mmap_vm_ops = {
1265 .fault = sg_vma_fault,
1269 sg_mmap(struct file *filp, struct vm_area_struct *vma)
1272 unsigned long req_sz, len, sa;
1273 Sg_scatter_hold *rsv_schp;
1277 if ((!filp) || (!vma) || (!(sfp = (Sg_fd *) filp->private_data)))
1279 req_sz = vma->vm_end - vma->vm_start;
1280 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sfp->parentdp,
1281 "sg_mmap starting, vm_start=%p, len=%d\n",
1282 (void *) vma->vm_start, (int) req_sz));
1284 return -EINVAL; /* want no offset */
1285 rsv_schp = &sfp->reserve;
1286 mutex_lock(&sfp->f_mutex);
1287 if (req_sz > rsv_schp->bufflen) {
1288 ret = -ENOMEM; /* cannot map more than reserved buffer */
1293 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1294 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
1295 len = vma->vm_end - sa;
1296 len = (len < length) ? len : length;
1300 sfp->mmap_called = 1;
1301 vma->vm_flags |= VM_IO | VM_DONTEXPAND | VM_DONTDUMP;
1302 vma->vm_private_data = sfp;
1303 vma->vm_ops = &sg_mmap_vm_ops;
1305 mutex_unlock(&sfp->f_mutex);
1310 sg_rq_end_io_usercontext(struct work_struct *work)
1312 struct sg_request *srp = container_of(work, struct sg_request, ew.work);
1313 struct sg_fd *sfp = srp->parentfp;
1315 sg_finish_rem_req(srp);
1316 sg_remove_request(sfp, srp);
1317 kref_put(&sfp->f_ref, sg_remove_sfp);
1321 * This function is a "bottom half" handler that is called by the mid
1322 * level when a command is completed (or has failed).
1325 sg_rq_end_io(struct request *rq, blk_status_t status)
1327 struct sg_request *srp = rq->end_io_data;
1328 struct scsi_request *req = scsi_req(rq);
1331 unsigned long iflags;
1334 int result, resid, done = 1;
1336 if (WARN_ON(srp->done != 0))
1339 sfp = srp->parentfp;
1340 if (WARN_ON(sfp == NULL))
1343 sdp = sfp->parentdp;
1344 if (unlikely(atomic_read(&sdp->detaching)))
1345 pr_info("%s: device detaching\n", __func__);
1348 result = req->result;
1349 resid = req->resid_len;
1351 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sdp,
1352 "sg_cmd_done: pack_id=%d, res=0x%x\n",
1353 srp->header.pack_id, result));
1354 srp->header.resid = resid;
1355 ms = jiffies_to_msecs(jiffies);
1356 srp->header.duration = (ms > srp->header.duration) ?
1357 (ms - srp->header.duration) : 0;
1359 struct scsi_sense_hdr sshdr;
1361 srp->header.status = 0xff & result;
1362 srp->header.masked_status = status_byte(result);
1363 srp->header.msg_status = msg_byte(result);
1364 srp->header.host_status = host_byte(result);
1365 srp->header.driver_status = driver_byte(result);
1366 if ((sdp->sgdebug > 0) &&
1367 ((CHECK_CONDITION == srp->header.masked_status) ||
1368 (COMMAND_TERMINATED == srp->header.masked_status)))
1369 __scsi_print_sense(sdp->device, __func__, sense,
1370 SCSI_SENSE_BUFFERSIZE);
1372 /* Following if statement is a patch supplied by Eric Youngdale */
1373 if (driver_byte(result) != 0
1374 && scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, &sshdr)
1375 && !scsi_sense_is_deferred(&sshdr)
1376 && sshdr.sense_key == UNIT_ATTENTION
1377 && sdp->device->removable) {
1378 /* Detected possible disc change. Set the bit - this */
1379 /* may be used if there are filesystems using this device */
1380 sdp->device->changed = 1;
1385 memcpy(srp->sense_b, req->sense, SCSI_SENSE_BUFFERSIZE);
1387 /* Rely on write phase to clean out srp status values, so no "else" */
1390 * Free the request as soon as it is complete so that its resources
1391 * can be reused without waiting for userspace to read() the
1392 * result. But keep the associated bio (if any) around until
1393 * blk_rq_unmap_user() can be called from user context.
1396 scsi_req_free_cmd(scsi_req(rq));
1397 __blk_put_request(rq->q, rq);
1399 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1400 if (unlikely(srp->orphan)) {
1401 if (sfp->keep_orphan)
1402 srp->sg_io_owned = 0;
1407 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1410 /* Now wake up any sg_read() that is waiting for this
1413 wake_up_interruptible(&sfp->read_wait);
1414 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_IN);
1415 kref_put(&sfp->f_ref, sg_remove_sfp);
1417 INIT_WORK(&srp->ew.work, sg_rq_end_io_usercontext);
1418 schedule_work(&srp->ew.work);
1422 static const struct file_operations sg_fops = {
1423 .owner = THIS_MODULE,
1427 .unlocked_ioctl = sg_ioctl,
1428 #ifdef CONFIG_COMPAT
1429 .compat_ioctl = sg_compat_ioctl,
1433 .release = sg_release,
1434 .fasync = sg_fasync,
1435 .llseek = no_llseek,
1438 static struct class *sg_sysfs_class;
1440 static int sg_sysfs_valid = 0;
1443 sg_alloc(struct gendisk *disk, struct scsi_device *scsidp)
1445 struct request_queue *q = scsidp->request_queue;
1447 unsigned long iflags;
1451 sdp = kzalloc(sizeof(Sg_device), GFP_KERNEL);
1453 sdev_printk(KERN_WARNING, scsidp, "%s: kmalloc Sg_device "
1454 "failure\n", __func__);
1455 return ERR_PTR(-ENOMEM);
1458 idr_preload(GFP_KERNEL);
1459 write_lock_irqsave(&sg_index_lock, iflags);
1461 error = idr_alloc(&sg_index_idr, sdp, 0, SG_MAX_DEVS, GFP_NOWAIT);
1463 if (error == -ENOSPC) {
1464 sdev_printk(KERN_WARNING, scsidp,
1465 "Unable to attach sg device type=%d, minor number exceeds %d\n",
1466 scsidp->type, SG_MAX_DEVS - 1);
1469 sdev_printk(KERN_WARNING, scsidp, "%s: idr "
1470 "allocation Sg_device failure: %d\n",
1477 SCSI_LOG_TIMEOUT(3, sdev_printk(KERN_INFO, scsidp,
1478 "sg_alloc: dev=%d \n", k));
1479 sprintf(disk->disk_name, "sg%d", k);
1480 disk->first_minor = k;
1482 sdp->device = scsidp;
1483 mutex_init(&sdp->open_rel_lock);
1484 INIT_LIST_HEAD(&sdp->sfds);
1485 init_waitqueue_head(&sdp->open_wait);
1486 atomic_set(&sdp->detaching, 0);
1487 rwlock_init(&sdp->sfd_lock);
1488 sdp->sg_tablesize = queue_max_segments(q);
1490 kref_init(&sdp->d_ref);
1494 write_unlock_irqrestore(&sg_index_lock, iflags);
1499 return ERR_PTR(error);
1505 sg_add_device(struct device *cl_dev, struct class_interface *cl_intf)
1507 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
1508 struct gendisk *disk;
1509 Sg_device *sdp = NULL;
1510 struct cdev * cdev = NULL;
1512 unsigned long iflags;
1514 disk = alloc_disk(1);
1516 pr_warn("%s: alloc_disk failed\n", __func__);
1519 disk->major = SCSI_GENERIC_MAJOR;
1522 cdev = cdev_alloc();
1524 pr_warn("%s: cdev_alloc failed\n", __func__);
1527 cdev->owner = THIS_MODULE;
1528 cdev->ops = &sg_fops;
1530 sdp = sg_alloc(disk, scsidp);
1532 pr_warn("%s: sg_alloc failed\n", __func__);
1533 error = PTR_ERR(sdp);
1537 error = cdev_add(cdev, MKDEV(SCSI_GENERIC_MAJOR, sdp->index), 1);
1542 if (sg_sysfs_valid) {
1543 struct device *sg_class_member;
1545 sg_class_member = device_create(sg_sysfs_class, cl_dev->parent,
1546 MKDEV(SCSI_GENERIC_MAJOR,
1548 sdp, "%s", disk->disk_name);
1549 if (IS_ERR(sg_class_member)) {
1550 pr_err("%s: device_create failed\n", __func__);
1551 error = PTR_ERR(sg_class_member);
1554 error = sysfs_create_link(&scsidp->sdev_gendev.kobj,
1555 &sg_class_member->kobj, "generic");
1557 pr_err("%s: unable to make symlink 'generic' back "
1558 "to sg%d\n", __func__, sdp->index);
1560 pr_warn("%s: sg_sys Invalid\n", __func__);
1562 sdev_printk(KERN_NOTICE, scsidp, "Attached scsi generic sg%d "
1563 "type %d\n", sdp->index, scsidp->type);
1565 dev_set_drvdata(cl_dev, sdp);
1570 write_lock_irqsave(&sg_index_lock, iflags);
1571 idr_remove(&sg_index_idr, sdp->index);
1572 write_unlock_irqrestore(&sg_index_lock, iflags);
1583 sg_device_destroy(struct kref *kref)
1585 struct sg_device *sdp = container_of(kref, struct sg_device, d_ref);
1586 unsigned long flags;
1588 /* CAUTION! Note that the device can still be found via idr_find()
1589 * even though the refcount is 0. Therefore, do idr_remove() BEFORE
1590 * any other cleanup.
1593 write_lock_irqsave(&sg_index_lock, flags);
1594 idr_remove(&sg_index_idr, sdp->index);
1595 write_unlock_irqrestore(&sg_index_lock, flags);
1598 sg_printk(KERN_INFO, sdp, "sg_device_destroy\n"));
1600 put_disk(sdp->disk);
1605 sg_remove_device(struct device *cl_dev, struct class_interface *cl_intf)
1607 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
1608 Sg_device *sdp = dev_get_drvdata(cl_dev);
1609 unsigned long iflags;
1615 /* want sdp->detaching non-zero as soon as possible */
1616 val = atomic_inc_return(&sdp->detaching);
1618 return; /* only want to do following once per device */
1620 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
1623 read_lock_irqsave(&sdp->sfd_lock, iflags);
1624 list_for_each_entry(sfp, &sdp->sfds, sfd_siblings) {
1625 wake_up_interruptible_all(&sfp->read_wait);
1626 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_HUP);
1628 wake_up_interruptible_all(&sdp->open_wait);
1629 read_unlock_irqrestore(&sdp->sfd_lock, iflags);
1631 sysfs_remove_link(&scsidp->sdev_gendev.kobj, "generic");
1632 device_destroy(sg_sysfs_class, MKDEV(SCSI_GENERIC_MAJOR, sdp->index));
1633 cdev_del(sdp->cdev);
1636 kref_put(&sdp->d_ref, sg_device_destroy);
1639 module_param_named(scatter_elem_sz, scatter_elem_sz, int, S_IRUGO | S_IWUSR);
1640 module_param_named(def_reserved_size, def_reserved_size, int,
1642 module_param_named(allow_dio, sg_allow_dio, int, S_IRUGO | S_IWUSR);
1644 MODULE_AUTHOR("Douglas Gilbert");
1645 MODULE_DESCRIPTION("SCSI generic (sg) driver");
1646 MODULE_LICENSE("GPL");
1647 MODULE_VERSION(SG_VERSION_STR);
1648 MODULE_ALIAS_CHARDEV_MAJOR(SCSI_GENERIC_MAJOR);
1650 MODULE_PARM_DESC(scatter_elem_sz, "scatter gather element "
1651 "size (default: max(SG_SCATTER_SZ, PAGE_SIZE))");
1652 MODULE_PARM_DESC(def_reserved_size, "size of buffer reserved for each fd");
1653 MODULE_PARM_DESC(allow_dio, "allow direct I/O (default: 0 (disallow))");
1660 if (scatter_elem_sz < PAGE_SIZE) {
1661 scatter_elem_sz = PAGE_SIZE;
1662 scatter_elem_sz_prev = scatter_elem_sz;
1664 if (def_reserved_size >= 0)
1665 sg_big_buff = def_reserved_size;
1667 def_reserved_size = sg_big_buff;
1669 rc = register_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1673 sg_sysfs_class = class_create(THIS_MODULE, "scsi_generic");
1674 if ( IS_ERR(sg_sysfs_class) ) {
1675 rc = PTR_ERR(sg_sysfs_class);
1679 rc = scsi_register_interface(&sg_interface);
1681 #ifdef CONFIG_SCSI_PROC_FS
1683 #endif /* CONFIG_SCSI_PROC_FS */
1686 class_destroy(sg_sysfs_class);
1688 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0), SG_MAX_DEVS);
1695 #ifdef CONFIG_SCSI_PROC_FS
1696 remove_proc_subtree("scsi/sg", NULL);
1697 #endif /* CONFIG_SCSI_PROC_FS */
1698 scsi_unregister_interface(&sg_interface);
1699 class_destroy(sg_sysfs_class);
1701 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1703 idr_destroy(&sg_index_idr);
1707 sg_start_req(Sg_request *srp, unsigned char *cmd)
1711 struct scsi_request *req;
1712 Sg_fd *sfp = srp->parentfp;
1713 sg_io_hdr_t *hp = &srp->header;
1714 int dxfer_len = (int) hp->dxfer_len;
1715 int dxfer_dir = hp->dxfer_direction;
1716 unsigned int iov_count = hp->iovec_count;
1717 Sg_scatter_hold *req_schp = &srp->data;
1718 Sg_scatter_hold *rsv_schp = &sfp->reserve;
1719 struct request_queue *q = sfp->parentdp->device->request_queue;
1720 struct rq_map_data *md, map_data;
1721 int rw = hp->dxfer_direction == SG_DXFER_TO_DEV ? WRITE : READ;
1722 unsigned char *long_cmdp = NULL;
1724 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1725 "sg_start_req: dxfer_len=%d\n",
1728 if (hp->cmd_len > BLK_MAX_CDB) {
1729 long_cmdp = kzalloc(hp->cmd_len, GFP_KERNEL);
1737 * With scsi-mq enabled, there are a fixed number of preallocated
1738 * requests equal in number to shost->can_queue. If all of the
1739 * preallocated requests are already in use, then blk_get_request()
1740 * will sleep until an active command completes, freeing up a request.
1741 * Although waiting in an asynchronous interface is less than ideal, we
1742 * do not want to use BLK_MQ_REQ_NOWAIT here because userspace might
1743 * not expect an EWOULDBLOCK from this condition.
1745 rq = blk_get_request(q, hp->dxfer_direction == SG_DXFER_TO_DEV ?
1746 REQ_OP_SCSI_OUT : REQ_OP_SCSI_IN, 0);
1753 if (hp->cmd_len > BLK_MAX_CDB)
1754 req->cmd = long_cmdp;
1755 memcpy(req->cmd, cmd, hp->cmd_len);
1756 req->cmd_len = hp->cmd_len;
1759 rq->end_io_data = srp;
1760 req->retries = SG_DEFAULT_RETRIES;
1762 if ((dxfer_len <= 0) || (dxfer_dir == SG_DXFER_NONE))
1765 if (sg_allow_dio && hp->flags & SG_FLAG_DIRECT_IO &&
1766 dxfer_dir != SG_DXFER_UNKNOWN && !iov_count &&
1767 !sfp->parentdp->device->host->unchecked_isa_dma &&
1768 blk_rq_aligned(q, (unsigned long)hp->dxferp, dxfer_len))
1774 mutex_lock(&sfp->f_mutex);
1775 if (dxfer_len <= rsv_schp->bufflen &&
1777 sfp->res_in_use = 1;
1778 sg_link_reserve(sfp, srp, dxfer_len);
1779 } else if (hp->flags & SG_FLAG_MMAP_IO) {
1780 res = -EBUSY; /* sfp->res_in_use == 1 */
1781 if (dxfer_len > rsv_schp->bufflen)
1783 mutex_unlock(&sfp->f_mutex);
1786 res = sg_build_indirect(req_schp, sfp, dxfer_len);
1788 mutex_unlock(&sfp->f_mutex);
1792 mutex_unlock(&sfp->f_mutex);
1794 md->pages = req_schp->pages;
1795 md->page_order = req_schp->page_order;
1796 md->nr_entries = req_schp->k_use_sg;
1798 md->null_mapped = hp->dxferp ? 0 : 1;
1799 if (dxfer_dir == SG_DXFER_TO_FROM_DEV)
1806 struct iovec *iov = NULL;
1809 res = import_iovec(rw, hp->dxferp, iov_count, 0, &iov, &i);
1813 iov_iter_truncate(&i, hp->dxfer_len);
1814 if (!iov_iter_count(&i)) {
1819 res = blk_rq_map_user_iov(q, rq, md, &i, GFP_ATOMIC);
1822 res = blk_rq_map_user(q, rq, md, hp->dxferp,
1823 hp->dxfer_len, GFP_ATOMIC);
1829 req_schp->dio_in_use = 1;
1830 hp->info |= SG_INFO_DIRECT_IO;
1837 sg_finish_rem_req(Sg_request *srp)
1841 Sg_fd *sfp = srp->parentfp;
1842 Sg_scatter_hold *req_schp = &srp->data;
1844 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1845 "sg_finish_rem_req: res_used=%d\n",
1846 (int) srp->res_used));
1848 ret = blk_rq_unmap_user(srp->bio);
1851 scsi_req_free_cmd(scsi_req(srp->rq));
1852 blk_put_request(srp->rq);
1856 sg_unlink_reserve(sfp, srp);
1858 sg_remove_scat(sfp, req_schp);
1864 sg_build_sgat(Sg_scatter_hold * schp, const Sg_fd * sfp, int tablesize)
1866 int sg_bufflen = tablesize * sizeof(struct page *);
1867 gfp_t gfp_flags = GFP_ATOMIC | __GFP_NOWARN;
1869 schp->pages = kzalloc(sg_bufflen, gfp_flags);
1872 schp->sglist_len = sg_bufflen;
1873 return tablesize; /* number of scat_gath elements allocated */
1877 sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size)
1879 int ret_sz = 0, i, k, rem_sz, num, mx_sc_elems;
1880 int sg_tablesize = sfp->parentdp->sg_tablesize;
1881 int blk_size = buff_size, order;
1882 gfp_t gfp_mask = GFP_ATOMIC | __GFP_COMP | __GFP_NOWARN | __GFP_ZERO;
1883 struct sg_device *sdp = sfp->parentdp;
1888 ++blk_size; /* don't know why */
1889 /* round request up to next highest SG_SECTOR_SZ byte boundary */
1890 blk_size = ALIGN(blk_size, SG_SECTOR_SZ);
1891 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1892 "sg_build_indirect: buff_size=%d, blk_size=%d\n",
1893 buff_size, blk_size));
1895 /* N.B. ret_sz carried into this block ... */
1896 mx_sc_elems = sg_build_sgat(schp, sfp, sg_tablesize);
1897 if (mx_sc_elems < 0)
1898 return mx_sc_elems; /* most likely -ENOMEM */
1900 num = scatter_elem_sz;
1901 if (unlikely(num != scatter_elem_sz_prev)) {
1902 if (num < PAGE_SIZE) {
1903 scatter_elem_sz = PAGE_SIZE;
1904 scatter_elem_sz_prev = PAGE_SIZE;
1906 scatter_elem_sz_prev = num;
1909 if (sdp->device->host->unchecked_isa_dma)
1910 gfp_mask |= GFP_DMA;
1912 order = get_order(num);
1914 ret_sz = 1 << (PAGE_SHIFT + order);
1916 for (k = 0, rem_sz = blk_size; rem_sz > 0 && k < mx_sc_elems;
1917 k++, rem_sz -= ret_sz) {
1919 num = (rem_sz > scatter_elem_sz_prev) ?
1920 scatter_elem_sz_prev : rem_sz;
1922 schp->pages[k] = alloc_pages(gfp_mask, order);
1923 if (!schp->pages[k])
1926 if (num == scatter_elem_sz_prev) {
1927 if (unlikely(ret_sz > scatter_elem_sz_prev)) {
1928 scatter_elem_sz = ret_sz;
1929 scatter_elem_sz_prev = ret_sz;
1933 SCSI_LOG_TIMEOUT(5, sg_printk(KERN_INFO, sfp->parentdp,
1934 "sg_build_indirect: k=%d, num=%d, ret_sz=%d\n",
1936 } /* end of for loop */
1938 schp->page_order = order;
1940 SCSI_LOG_TIMEOUT(5, sg_printk(KERN_INFO, sfp->parentdp,
1941 "sg_build_indirect: k_use_sg=%d, rem_sz=%d\n",
1944 schp->bufflen = blk_size;
1945 if (rem_sz > 0) /* must have failed */
1949 for (i = 0; i < k; i++)
1950 __free_pages(schp->pages[i], order);
1959 sg_remove_scat(Sg_fd * sfp, Sg_scatter_hold * schp)
1961 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1962 "sg_remove_scat: k_use_sg=%d\n", schp->k_use_sg));
1963 if (schp->pages && schp->sglist_len > 0) {
1964 if (!schp->dio_in_use) {
1967 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
1969 sg_printk(KERN_INFO, sfp->parentdp,
1970 "sg_remove_scat: k=%d, pg=0x%p\n",
1971 k, schp->pages[k]));
1972 __free_pages(schp->pages[k], schp->page_order);
1978 memset(schp, 0, sizeof (*schp));
1982 sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer)
1984 Sg_scatter_hold *schp = &srp->data;
1987 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, srp->parentfp->parentdp,
1988 "sg_read_oxfer: num_read_xfer=%d\n",
1990 if ((!outp) || (num_read_xfer <= 0))
1993 num = 1 << (PAGE_SHIFT + schp->page_order);
1994 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
1995 if (num > num_read_xfer) {
1996 if (__copy_to_user(outp, page_address(schp->pages[k]),
2001 if (__copy_to_user(outp, page_address(schp->pages[k]),
2004 num_read_xfer -= num;
2005 if (num_read_xfer <= 0)
2015 sg_build_reserve(Sg_fd * sfp, int req_size)
2017 Sg_scatter_hold *schp = &sfp->reserve;
2019 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
2020 "sg_build_reserve: req_size=%d\n", req_size));
2022 if (req_size < PAGE_SIZE)
2023 req_size = PAGE_SIZE;
2024 if (0 == sg_build_indirect(schp, sfp, req_size))
2027 sg_remove_scat(sfp, schp);
2028 req_size >>= 1; /* divide by 2 */
2029 } while (req_size > (PAGE_SIZE / 2));
2033 sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size)
2035 Sg_scatter_hold *req_schp = &srp->data;
2036 Sg_scatter_hold *rsv_schp = &sfp->reserve;
2040 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
2041 "sg_link_reserve: size=%d\n", size));
2044 num = 1 << (PAGE_SHIFT + rsv_schp->page_order);
2045 for (k = 0; k < rsv_schp->k_use_sg; k++) {
2047 req_schp->k_use_sg = k + 1;
2048 req_schp->sglist_len = rsv_schp->sglist_len;
2049 req_schp->pages = rsv_schp->pages;
2051 req_schp->bufflen = size;
2052 req_schp->page_order = rsv_schp->page_order;
2058 if (k >= rsv_schp->k_use_sg)
2059 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO, sfp->parentdp,
2060 "sg_link_reserve: BAD size\n"));
2064 sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp)
2066 Sg_scatter_hold *req_schp = &srp->data;
2068 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, srp->parentfp->parentdp,
2069 "sg_unlink_reserve: req->k_use_sg=%d\n",
2070 (int) req_schp->k_use_sg));
2071 req_schp->k_use_sg = 0;
2072 req_schp->bufflen = 0;
2073 req_schp->pages = NULL;
2074 req_schp->page_order = 0;
2075 req_schp->sglist_len = 0;
2077 /* Called without mutex lock to avoid deadlock */
2078 sfp->res_in_use = 0;
2082 sg_get_rq_mark(Sg_fd * sfp, int pack_id)
2085 unsigned long iflags;
2087 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2088 list_for_each_entry(resp, &sfp->rq_list, entry) {
2089 /* look for requests that are ready + not SG_IO owned */
2090 if ((1 == resp->done) && (!resp->sg_io_owned) &&
2091 ((-1 == pack_id) || (resp->header.pack_id == pack_id))) {
2092 resp->done = 2; /* guard against other readers */
2093 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2097 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2101 /* always adds to end of list */
2103 sg_add_request(Sg_fd * sfp)
2106 unsigned long iflags;
2107 Sg_request *rp = sfp->req_arr;
2109 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2110 if (!list_empty(&sfp->rq_list)) {
2114 for (k = 0; k < SG_MAX_QUEUE; ++k, ++rp) {
2118 if (k >= SG_MAX_QUEUE)
2121 memset(rp, 0, sizeof (Sg_request));
2123 rp->header.duration = jiffies_to_msecs(jiffies);
2124 list_add_tail(&rp->entry, &sfp->rq_list);
2125 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2128 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2132 /* Return of 1 for found; 0 for not found */
2134 sg_remove_request(Sg_fd * sfp, Sg_request * srp)
2136 unsigned long iflags;
2139 if (!sfp || !srp || list_empty(&sfp->rq_list))
2141 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2142 if (!list_empty(&srp->entry)) {
2143 list_del(&srp->entry);
2144 srp->parentfp = NULL;
2147 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2152 sg_add_sfp(Sg_device * sdp)
2155 unsigned long iflags;
2158 sfp = kzalloc(sizeof(*sfp), GFP_ATOMIC | __GFP_NOWARN);
2160 return ERR_PTR(-ENOMEM);
2162 init_waitqueue_head(&sfp->read_wait);
2163 rwlock_init(&sfp->rq_list_lock);
2164 INIT_LIST_HEAD(&sfp->rq_list);
2165 kref_init(&sfp->f_ref);
2166 mutex_init(&sfp->f_mutex);
2167 sfp->timeout = SG_DEFAULT_TIMEOUT;
2168 sfp->timeout_user = SG_DEFAULT_TIMEOUT_USER;
2169 sfp->force_packid = SG_DEF_FORCE_PACK_ID;
2170 sfp->cmd_q = SG_DEF_COMMAND_Q;
2171 sfp->keep_orphan = SG_DEF_KEEP_ORPHAN;
2172 sfp->parentdp = sdp;
2173 write_lock_irqsave(&sdp->sfd_lock, iflags);
2174 if (atomic_read(&sdp->detaching)) {
2175 write_unlock_irqrestore(&sdp->sfd_lock, iflags);
2177 return ERR_PTR(-ENODEV);
2179 list_add_tail(&sfp->sfd_siblings, &sdp->sfds);
2180 write_unlock_irqrestore(&sdp->sfd_lock, iflags);
2181 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
2182 "sg_add_sfp: sfp=0x%p\n", sfp));
2183 if (unlikely(sg_big_buff != def_reserved_size))
2184 sg_big_buff = def_reserved_size;
2186 bufflen = min_t(int, sg_big_buff,
2187 max_sectors_bytes(sdp->device->request_queue));
2188 sg_build_reserve(sfp, bufflen);
2189 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
2190 "sg_add_sfp: bufflen=%d, k_use_sg=%d\n",
2191 sfp->reserve.bufflen,
2192 sfp->reserve.k_use_sg));
2194 kref_get(&sdp->d_ref);
2195 __module_get(THIS_MODULE);
2200 sg_remove_sfp_usercontext(struct work_struct *work)
2202 struct sg_fd *sfp = container_of(work, struct sg_fd, ew.work);
2203 struct sg_device *sdp = sfp->parentdp;
2205 unsigned long iflags;
2207 /* Cleanup any responses which were never read(). */
2208 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2209 while (!list_empty(&sfp->rq_list)) {
2210 srp = list_first_entry(&sfp->rq_list, Sg_request, entry);
2211 sg_finish_rem_req(srp);
2212 list_del(&srp->entry);
2213 srp->parentfp = NULL;
2215 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2217 if (sfp->reserve.bufflen > 0) {
2218 SCSI_LOG_TIMEOUT(6, sg_printk(KERN_INFO, sdp,
2219 "sg_remove_sfp: bufflen=%d, k_use_sg=%d\n",
2220 (int) sfp->reserve.bufflen,
2221 (int) sfp->reserve.k_use_sg));
2222 sg_remove_scat(sfp, &sfp->reserve);
2225 SCSI_LOG_TIMEOUT(6, sg_printk(KERN_INFO, sdp,
2226 "sg_remove_sfp: sfp=0x%p\n", sfp));
2229 scsi_device_put(sdp->device);
2230 kref_put(&sdp->d_ref, sg_device_destroy);
2231 module_put(THIS_MODULE);
2235 sg_remove_sfp(struct kref *kref)
2237 struct sg_fd *sfp = container_of(kref, struct sg_fd, f_ref);
2238 struct sg_device *sdp = sfp->parentdp;
2239 unsigned long iflags;
2241 write_lock_irqsave(&sdp->sfd_lock, iflags);
2242 list_del(&sfp->sfd_siblings);
2243 write_unlock_irqrestore(&sdp->sfd_lock, iflags);
2245 INIT_WORK(&sfp->ew.work, sg_remove_sfp_usercontext);
2246 schedule_work(&sfp->ew.work);
2249 #ifdef CONFIG_SCSI_PROC_FS
2251 sg_idr_max_id(int id, void *p, void *data)
2265 unsigned long iflags;
2267 read_lock_irqsave(&sg_index_lock, iflags);
2268 idr_for_each(&sg_index_idr, sg_idr_max_id, &k);
2269 read_unlock_irqrestore(&sg_index_lock, iflags);
2270 return k + 1; /* origin 1 */
2274 /* must be called with sg_index_lock held */
2275 static Sg_device *sg_lookup_dev(int dev)
2277 return idr_find(&sg_index_idr, dev);
2283 struct sg_device *sdp;
2284 unsigned long flags;
2286 read_lock_irqsave(&sg_index_lock, flags);
2287 sdp = sg_lookup_dev(dev);
2289 sdp = ERR_PTR(-ENXIO);
2290 else if (atomic_read(&sdp->detaching)) {
2291 /* If sdp->detaching, then the refcount may already be 0, in
2292 * which case it would be a bug to do kref_get().
2294 sdp = ERR_PTR(-ENODEV);
2296 kref_get(&sdp->d_ref);
2297 read_unlock_irqrestore(&sg_index_lock, flags);
2302 #ifdef CONFIG_SCSI_PROC_FS
2303 static int sg_proc_seq_show_int(struct seq_file *s, void *v);
2305 static int sg_proc_single_open_adio(struct inode *inode, struct file *file);
2306 static ssize_t sg_proc_write_adio(struct file *filp, const char __user *buffer,
2307 size_t count, loff_t *off);
2308 static const struct file_operations adio_fops = {
2309 .owner = THIS_MODULE,
2310 .open = sg_proc_single_open_adio,
2312 .llseek = seq_lseek,
2313 .write = sg_proc_write_adio,
2314 .release = single_release,
2317 static int sg_proc_single_open_dressz(struct inode *inode, struct file *file);
2318 static ssize_t sg_proc_write_dressz(struct file *filp,
2319 const char __user *buffer, size_t count, loff_t *off);
2320 static const struct file_operations dressz_fops = {
2321 .owner = THIS_MODULE,
2322 .open = sg_proc_single_open_dressz,
2324 .llseek = seq_lseek,
2325 .write = sg_proc_write_dressz,
2326 .release = single_release,
2329 static int sg_proc_seq_show_version(struct seq_file *s, void *v);
2330 static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v);
2331 static int sg_proc_seq_show_dev(struct seq_file *s, void *v);
2332 static void * dev_seq_start(struct seq_file *s, loff_t *pos);
2333 static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos);
2334 static void dev_seq_stop(struct seq_file *s, void *v);
2335 static const struct seq_operations dev_seq_ops = {
2336 .start = dev_seq_start,
2337 .next = dev_seq_next,
2338 .stop = dev_seq_stop,
2339 .show = sg_proc_seq_show_dev,
2342 static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v);
2343 static const struct seq_operations devstrs_seq_ops = {
2344 .start = dev_seq_start,
2345 .next = dev_seq_next,
2346 .stop = dev_seq_stop,
2347 .show = sg_proc_seq_show_devstrs,
2350 static int sg_proc_seq_show_debug(struct seq_file *s, void *v);
2351 static const struct seq_operations debug_seq_ops = {
2352 .start = dev_seq_start,
2353 .next = dev_seq_next,
2354 .stop = dev_seq_stop,
2355 .show = sg_proc_seq_show_debug,
2361 struct proc_dir_entry *p;
2363 p = proc_mkdir("scsi/sg", NULL);
2367 proc_create("allow_dio", S_IRUGO | S_IWUSR, p, &adio_fops);
2368 proc_create_seq("debug", S_IRUGO, p, &debug_seq_ops);
2369 proc_create("def_reserved_size", S_IRUGO | S_IWUSR, p, &dressz_fops);
2370 proc_create_single("device_hdr", S_IRUGO, p, sg_proc_seq_show_devhdr);
2371 proc_create_seq("devices", S_IRUGO, p, &dev_seq_ops);
2372 proc_create_seq("device_strs", S_IRUGO, p, &devstrs_seq_ops);
2373 proc_create_single("version", S_IRUGO, p, sg_proc_seq_show_version);
2378 static int sg_proc_seq_show_int(struct seq_file *s, void *v)
2380 seq_printf(s, "%d\n", *((int *)s->private));
2384 static int sg_proc_single_open_adio(struct inode *inode, struct file *file)
2386 return single_open(file, sg_proc_seq_show_int, &sg_allow_dio);
2390 sg_proc_write_adio(struct file *filp, const char __user *buffer,
2391 size_t count, loff_t *off)
2396 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2398 err = kstrtoul_from_user(buffer, count, 0, &num);
2401 sg_allow_dio = num ? 1 : 0;
2405 static int sg_proc_single_open_dressz(struct inode *inode, struct file *file)
2407 return single_open(file, sg_proc_seq_show_int, &sg_big_buff);
2411 sg_proc_write_dressz(struct file *filp, const char __user *buffer,
2412 size_t count, loff_t *off)
2415 unsigned long k = ULONG_MAX;
2417 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2420 err = kstrtoul_from_user(buffer, count, 0, &k);
2423 if (k <= 1048576) { /* limit "big buff" to 1 MB */
2430 static int sg_proc_seq_show_version(struct seq_file *s, void *v)
2432 seq_printf(s, "%d\t%s [%s]\n", sg_version_num, SG_VERSION_STR,
2437 static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v)
2439 seq_puts(s, "host\tchan\tid\tlun\ttype\topens\tqdepth\tbusy\tonline\n");
2443 struct sg_proc_deviter {
2448 static void * dev_seq_start(struct seq_file *s, loff_t *pos)
2450 struct sg_proc_deviter * it = kmalloc(sizeof(*it), GFP_KERNEL);
2457 it->max = sg_last_dev();
2458 if (it->index >= it->max)
2463 static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos)
2465 struct sg_proc_deviter * it = s->private;
2468 return (it->index < it->max) ? it : NULL;
2471 static void dev_seq_stop(struct seq_file *s, void *v)
2476 static int sg_proc_seq_show_dev(struct seq_file *s, void *v)
2478 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2480 struct scsi_device *scsidp;
2481 unsigned long iflags;
2483 read_lock_irqsave(&sg_index_lock, iflags);
2484 sdp = it ? sg_lookup_dev(it->index) : NULL;
2485 if ((NULL == sdp) || (NULL == sdp->device) ||
2486 (atomic_read(&sdp->detaching)))
2487 seq_puts(s, "-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\n");
2489 scsidp = sdp->device;
2490 seq_printf(s, "%d\t%d\t%d\t%llu\t%d\t%d\t%d\t%d\t%d\n",
2491 scsidp->host->host_no, scsidp->channel,
2492 scsidp->id, scsidp->lun, (int) scsidp->type,
2494 (int) scsidp->queue_depth,
2495 (int) atomic_read(&scsidp->device_busy),
2496 (int) scsi_device_online(scsidp));
2498 read_unlock_irqrestore(&sg_index_lock, iflags);
2502 static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v)
2504 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2506 struct scsi_device *scsidp;
2507 unsigned long iflags;
2509 read_lock_irqsave(&sg_index_lock, iflags);
2510 sdp = it ? sg_lookup_dev(it->index) : NULL;
2511 scsidp = sdp ? sdp->device : NULL;
2512 if (sdp && scsidp && (!atomic_read(&sdp->detaching)))
2513 seq_printf(s, "%8.8s\t%16.16s\t%4.4s\n",
2514 scsidp->vendor, scsidp->model, scsidp->rev);
2516 seq_puts(s, "<no active device>\n");
2517 read_unlock_irqrestore(&sg_index_lock, iflags);
2521 /* must be called while holding sg_index_lock */
2522 static void sg_proc_debug_helper(struct seq_file *s, Sg_device * sdp)
2524 int k, new_interface, blen, usg;
2527 const sg_io_hdr_t *hp;
2532 list_for_each_entry(fp, &sdp->sfds, sfd_siblings) {
2534 read_lock(&fp->rq_list_lock); /* irqs already disabled */
2535 seq_printf(s, " FD(%d): timeout=%dms bufflen=%d "
2536 "(res)sgat=%d low_dma=%d\n", k,
2537 jiffies_to_msecs(fp->timeout),
2538 fp->reserve.bufflen,
2539 (int) fp->reserve.k_use_sg,
2540 (int) sdp->device->host->unchecked_isa_dma);
2541 seq_printf(s, " cmd_q=%d f_packid=%d k_orphan=%d closed=0\n",
2542 (int) fp->cmd_q, (int) fp->force_packid,
2543 (int) fp->keep_orphan);
2544 list_for_each_entry(srp, &fp->rq_list, entry) {
2546 new_interface = (hp->interface_id == '\0') ? 0 : 1;
2547 if (srp->res_used) {
2548 if (new_interface &&
2549 (SG_FLAG_MMAP_IO & hp->flags))
2554 if (SG_INFO_DIRECT_IO_MASK & hp->info)
2560 blen = srp->data.bufflen;
2561 usg = srp->data.k_use_sg;
2562 seq_puts(s, srp->done ?
2563 ((1 == srp->done) ? "rcv:" : "fin:")
2565 seq_printf(s, " id=%d blen=%d",
2566 srp->header.pack_id, blen);
2568 seq_printf(s, " dur=%d", hp->duration);
2570 ms = jiffies_to_msecs(jiffies);
2571 seq_printf(s, " t_o/elap=%d/%d",
2572 (new_interface ? hp->timeout :
2573 jiffies_to_msecs(fp->timeout)),
2574 (ms > hp->duration ? ms - hp->duration : 0));
2576 seq_printf(s, "ms sgat=%d op=0x%02x\n", usg,
2577 (int) srp->data.cmd_opcode);
2579 if (list_empty(&fp->rq_list))
2580 seq_puts(s, " No requests active\n");
2581 read_unlock(&fp->rq_list_lock);
2585 static int sg_proc_seq_show_debug(struct seq_file *s, void *v)
2587 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2589 unsigned long iflags;
2591 if (it && (0 == it->index))
2592 seq_printf(s, "max_active_device=%d def_reserved_size=%d\n",
2593 (int)it->max, sg_big_buff);
2595 read_lock_irqsave(&sg_index_lock, iflags);
2596 sdp = it ? sg_lookup_dev(it->index) : NULL;
2599 read_lock(&sdp->sfd_lock);
2600 if (!list_empty(&sdp->sfds)) {
2601 seq_printf(s, " >>> device=%s ", sdp->disk->disk_name);
2602 if (atomic_read(&sdp->detaching))
2603 seq_puts(s, "detaching pending close ");
2604 else if (sdp->device) {
2605 struct scsi_device *scsidp = sdp->device;
2607 seq_printf(s, "%d:%d:%d:%llu em=%d",
2608 scsidp->host->host_no,
2609 scsidp->channel, scsidp->id,
2611 scsidp->host->hostt->emulated);
2613 seq_printf(s, " sg_tablesize=%d excl=%d open_cnt=%d\n",
2614 sdp->sg_tablesize, sdp->exclude, sdp->open_cnt);
2615 sg_proc_debug_helper(s, sdp);
2617 read_unlock(&sdp->sfd_lock);
2619 read_unlock_irqrestore(&sg_index_lock, iflags);
2623 #endif /* CONFIG_SCSI_PROC_FS */
2625 module_init(init_sg);
2626 module_exit(exit_sg);