blob: f5705a95319f8451df6490908029ced153face6b [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * History:
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
6 *
7 * Original driver (sg.c):
8 * Copyright (C) 1992 Lawrence Foard
9 * Version 2 and 3 extensions to driver:
Douglas Gilbert65c26a02014-06-03 13:18:18 -040010 * Copyright (C) 1998 - 2014 Douglas Gilbert
Linus Torvalds1da177e2005-04-16 15:20:36 -070011 *
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)
15 * any later version.
16 *
17 */
18
Douglas Gilbert65c26a02014-06-03 13:18:18 -040019static int sg_version_num = 30536; /* 2 digits for each component */
20#define SG_VERSION_STR "3.5.36"
Linus Torvalds1da177e2005-04-16 15:20:36 -070021
22/*
Douglas Gilbert65c26a02014-06-03 13:18:18 -040023 * D. P. Gilbert (dgilbert@interlog.com), notes:
Linus Torvalds1da177e2005-04-16 15:20:36 -070024 * - 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).
27 *
28 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/module.h>
30
31#include <linux/fs.h>
32#include <linux/kernel.h>
33#include <linux/sched.h>
34#include <linux/string.h>
35#include <linux/mm.h>
36#include <linux/errno.h>
37#include <linux/mtio.h>
38#include <linux/ioctl.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090039#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070040#include <linux/fcntl.h>
41#include <linux/init.h>
42#include <linux/poll.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070043#include <linux/moduleparam.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#include <linux/cdev.h>
James Bottomley7c07d612007-08-05 13:36:11 -050045#include <linux/idr.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070046#include <linux/seq_file.h>
47#include <linux/blkdev.h>
48#include <linux/delay.h>
Christof Schmitt6da127a2008-01-11 10:09:43 +010049#include <linux/blktrace_api.h>
Arnd Bergmannc45d15d2010-06-02 14:28:52 +020050#include <linux/mutex.h>
Douglas Gilbertcc833ac2014-06-25 14:08:03 +020051#include <linux/atomic.h>
Christian Dietrich2fe038e2011-06-04 17:36:10 +020052#include <linux/ratelimit.h>
Christoph Hellwige2e40f22015-02-22 08:58:50 -080053#include <linux/uio.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
55#include "scsi.h"
db9dff32005-04-03 14:53:59 -050056#include <scsi/scsi_dbg.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070057#include <scsi/scsi_host.h>
58#include <scsi/scsi_driver.h>
59#include <scsi/scsi_ioctl.h>
60#include <scsi/sg.h>
61
62#include "scsi_logging.h"
63
64#ifdef CONFIG_SCSI_PROC_FS
65#include <linux/proc_fs.h>
Douglas Gilbert65c26a02014-06-03 13:18:18 -040066static char *sg_version_date = "20140603";
Linus Torvalds1da177e2005-04-16 15:20:36 -070067
68static int sg_proc_init(void);
69static void sg_proc_cleanup(void);
70#endif
71
Linus Torvalds1da177e2005-04-16 15:20:36 -070072#define SG_ALLOW_DIO_DEF 0
Linus Torvalds1da177e2005-04-16 15:20:36 -070073
74#define SG_MAX_DEVS 32768
75
Douglas Gilbert65c26a02014-06-03 13:18:18 -040076/* 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
79 */
80#define SG_MAX_CDB_SIZE 252
81
Paul Burtonf8630bd72016-08-19 17:43:57 +010082#define SG_DEFAULT_TIMEOUT mult_frac(SG_DEFAULT_TIMEOUT_USER, HZ, USER_HZ)
Linus Torvalds1da177e2005-04-16 15:20:36 -070083
84int 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).] */
91static int def_reserved_size = -1; /* picks up init parameter */
92static int sg_allow_dio = SG_ALLOW_DIO_DEF;
93
Douglas Gilbert6460e752006-09-20 18:20:49 -040094static int scatter_elem_sz = SG_SCATTER_SZ;
95static int scatter_elem_sz_prev = SG_SCATTER_SZ;
96
Linus Torvalds1da177e2005-04-16 15:20:36 -070097#define SG_SECTOR_SZ 512
Linus Torvalds1da177e2005-04-16 15:20:36 -070098
Douglas Gilbertcc833ac2014-06-25 14:08:03 +020099static int sg_add_device(struct device *, struct class_interface *);
100static void sg_remove_device(struct device *, struct class_interface *);
James Bottomley98481ff2013-10-25 10:26:38 +0100101
James Bottomley7c07d612007-08-05 13:36:11 -0500102static DEFINE_IDR(sg_index_idr);
James Bottomleyc0d3b9c2013-10-25 10:21:57 +0100103static DEFINE_RWLOCK(sg_index_lock); /* Also used to lock
104 file descriptor list for device */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105
106static struct class_interface sg_interface = {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200107 .add_dev = sg_add_device,
108 .remove_dev = sg_remove_device,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109};
110
111typedef struct sg_scatter_hold { /* holding area for scsi scatter gather info */
112 unsigned short k_use_sg; /* Count of kernel scatter-gather pieces */
FUJITA Tomonoriea312552007-08-06 00:31:24 +0900113 unsigned sglist_len; /* size of malloc'd scatter-gather list ++ */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 unsigned bufflen; /* Size of (aggregate) data buffer */
FUJITA Tomonori10db10d2008-08-29 12:32:18 +0200115 struct page **pages;
116 int page_order;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 char dio_in_use; /* 0->indirect IO (or mmap), 1->dio */
118 unsigned char cmd_opcode; /* first byte of command */
119} Sg_scatter_hold;
120
121struct sg_device; /* forward declarations */
122struct sg_fd;
123
124typedef struct sg_request { /* SG_MAX_QUEUE requests outstanding per file */
Hannes Reinecke109bade2017-04-07 09:34:16 +0200125 struct list_head entry; /* list entry */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 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> */
Mike Christied6b10342005-11-08 04:06:41 -0600129 unsigned char sense_b[SCSI_SENSE_BUFFERSIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130 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 */
Jörn Engel6acddc52012-04-12 17:33:58 -0400133 /* done protected by rq_list_lock */
134 char done; /* 0->before bh, 1->before read, 2->read */
FUJITA Tomonori10865df2008-08-28 16:17:07 +0900135 struct request *rq;
FUJITA Tomonori6e5a30c2008-08-28 16:17:08 +0900136 struct bio *bio;
FUJITA Tomonoric96952e2009-02-04 11:36:27 +0900137 struct execute_work ew;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138} Sg_request;
139
140typedef struct sg_fd { /* holds the state of a file descriptor */
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200141 struct list_head sfd_siblings; /* protected by device's sfd_lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 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 */
Hannes Reinecke1bc0eb02017-04-07 09:34:14 +0200145 struct mutex f_mutex; /* protect against changes in this fd */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 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 */
Hannes Reinecke109bade2017-04-07 09:34:16 +0200149 struct list_head rq_list; /* head of request list */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 struct fasync_struct *async_qp; /* used by asynchronous notification */
151 Sg_request req_arr[SG_MAX_QUEUE]; /* used as singly-linked list */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152 char force_packid; /* 1 -> pack_id input to read(), 0 -> ignored */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 char cmd_q; /* 1 -> allow command queuing, 0 -> don't */
Douglas Gilbert65c26a02014-06-03 13:18:18 -0400154 unsigned char next_cmd_len; /* 0: automatic, >0: use on next write() */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 char keep_orphan; /* 0 -> drop orphan (def), 1 -> keep for read() */
156 char mmap_called; /* 0 -> mmap() never called on this fd */
Hannes Reinecke1bc0eb02017-04-07 09:34:14 +0200157 char res_in_use; /* 1 -> 'reserve' array in use */
Tony Battersbyc6517b792009-01-21 14:45:50 -0500158 struct kref f_ref;
159 struct execute_work ew;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160} Sg_fd;
161
162typedef struct sg_device { /* holds the state of each scsi generic device */
163 struct scsi_device *device;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200164 wait_queue_head_t open_wait; /* queue open() when O_EXCL present */
165 struct mutex open_rel_lock; /* held when in open() or release() */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 int sg_tablesize; /* adapter's max scatter-gather table size */
James Bottomley7c07d612007-08-05 13:36:11 -0500167 u32 index; /* device index number */
FUJITA Tomonori3442f802009-02-16 13:26:53 +0900168 struct list_head sfds;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200169 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) ) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 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>] */
Tony Battersbyc6517b792009-01-21 14:45:50 -0500176 struct kref d_ref;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177} Sg_device;
178
Mike Christied6b10342005-11-08 04:06:41 -0600179/* tasklet or soft irq callback */
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200180static void sg_rq_end_io(struct request *rq, blk_status_t status);
FUJITA Tomonori10865df2008-08-28 16:17:07 +0900181static int sg_start_req(Sg_request *srp, unsigned char *cmd);
FUJITA Tomonorie7ee4cc2009-04-04 00:35:42 +0900182static int sg_finish_rem_req(Sg_request * srp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183static int sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184static ssize_t sg_new_read(Sg_fd * sfp, char __user *buf, size_t count,
185 Sg_request * srp);
Adel Gadllah0b07de82008-06-26 13:48:27 +0200186static ssize_t sg_new_write(Sg_fd *sfp, struct file *file,
187 const char __user *buf, size_t count, int blocking,
Tony Battersbya2dd3b42009-01-20 17:00:09 -0500188 int read_only, int sg_io_owned, Sg_request **o_srp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189static int sg_common_write(Sg_fd * sfp, Sg_request * srp,
190 unsigned char *cmnd, int timeout, int blocking);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191static int sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer);
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200192static void sg_remove_scat(Sg_fd * sfp, Sg_scatter_hold * schp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193static void sg_build_reserve(Sg_fd * sfp, int req_size);
194static void sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size);
195static void sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp);
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200196static Sg_fd *sg_add_sfp(Sg_device * sdp);
Tony Battersbyc6517b792009-01-21 14:45:50 -0500197static void sg_remove_sfp(struct kref *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198static Sg_request *sg_get_rq_mark(Sg_fd * sfp, int pack_id);
199static Sg_request *sg_add_request(Sg_fd * sfp);
200static int sg_remove_request(Sg_fd * sfp, Sg_request * srp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201static Sg_device *sg_get_dev(int dev);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200202static void sg_device_destroy(struct kref *kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204#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)
208
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200209#define sg_printk(prefix, sdp, fmt, a...) \
Hannes Reinecke22e0d992014-10-24 14:26:44 +0200210 sdev_prefix_printk(prefix, (sdp)->device, \
211 (sdp)->disk->disk_name, fmt, ##a)
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200212
FUJITA Tomonori14e507b2008-07-26 18:03:24 +0900213static int sg_allow_access(struct file *filp, unsigned char *cmd)
214{
Joe Perches35df8392010-09-04 18:52:46 -0700215 struct sg_fd *sfp = filp->private_data;
FUJITA Tomonori14e507b2008-07-26 18:03:24 +0900216
217 if (sfp->parentdp->device->type == TYPE_SCANNER)
218 return 0;
219
Jens Axboe018e0442009-06-26 16:27:10 +0200220 return blk_verify_command(cmd, filp->f_mode & FMODE_WRITE);
FUJITA Tomonori14e507b2008-07-26 18:03:24 +0900221}
222
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200223static int
224open_wait(Sg_device *sdp, int flags)
James Bottomley98481ff2013-10-25 10:26:38 +0100225{
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200226 int retval = 0;
James Bottomley98481ff2013-10-25 10:26:38 +0100227
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200228 if (flags & O_EXCL) {
229 while (sdp->open_cnt > 0) {
230 mutex_unlock(&sdp->open_rel_lock);
231 retval = wait_event_interruptible(sdp->open_wait,
232 (atomic_read(&sdp->detaching) ||
233 !sdp->open_cnt));
234 mutex_lock(&sdp->open_rel_lock);
235
236 if (retval) /* -ERESTARTSYS */
237 return retval;
238 if (atomic_read(&sdp->detaching))
239 return -ENODEV;
240 }
241 } else {
242 while (sdp->exclude) {
243 mutex_unlock(&sdp->open_rel_lock);
244 retval = wait_event_interruptible(sdp->open_wait,
245 (atomic_read(&sdp->detaching) ||
246 !sdp->exclude));
247 mutex_lock(&sdp->open_rel_lock);
248
249 if (retval) /* -ERESTARTSYS */
250 return retval;
251 if (atomic_read(&sdp->detaching))
252 return -ENODEV;
253 }
254 }
255
256 return retval;
James Bottomley98481ff2013-10-25 10:26:38 +0100257}
258
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200259/* Returns 0 on success, else a negated errno value */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260static int
261sg_open(struct inode *inode, struct file *filp)
262{
263 int dev = iminor(inode);
264 int flags = filp->f_flags;
Mike Christied6b10342005-11-08 04:06:41 -0600265 struct request_queue *q;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 Sg_device *sdp;
267 Sg_fd *sfp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 int retval;
269
270 nonseekable_open(inode, filp);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200271 if ((flags & O_EXCL) && (O_RDONLY == (flags & O_ACCMODE)))
272 return -EPERM; /* Can't lock it with read only access */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 sdp = sg_get_dev(dev);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200274 if (IS_ERR(sdp))
275 return PTR_ERR(sdp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200277 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
278 "sg_open: flags=0x%x\n", flags));
279
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280 /* This driver's module count bumped by fops_get in <linux/fs.h> */
281 /* Prevent the device driver from vanishing while we sleep */
282 retval = scsi_device_get(sdp->device);
Tony Battersbyc6517b792009-01-21 14:45:50 -0500283 if (retval)
284 goto sg_put;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285
Alan Sternbc4f2402010-06-17 10:41:42 -0400286 retval = scsi_autopm_get_device(sdp->device);
287 if (retval)
288 goto sdp_put;
289
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200290 /* scsi_block_when_processing_errors() may block so bypass
291 * check if O_NONBLOCK. Permits SCSI commands to be issued
292 * during error recovery. Tread carefully. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293 if (!((flags & O_NONBLOCK) ||
294 scsi_block_when_processing_errors(sdp->device))) {
295 retval = -ENXIO;
296 /* we are in error recovery for this device */
297 goto error_out;
298 }
299
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200300 mutex_lock(&sdp->open_rel_lock);
301 if (flags & O_NONBLOCK) {
302 if (flags & O_EXCL) {
303 if (sdp->open_cnt > 0) {
304 retval = -EBUSY;
305 goto error_mutex_locked;
306 }
307 } else {
308 if (sdp->exclude) {
309 retval = -EBUSY;
310 goto error_mutex_locked;
311 }
Vaughan Cao15b06f92013-08-29 10:00:36 +0800312 }
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200313 } else {
314 retval = open_wait(sdp, flags);
315 if (retval) /* -ERESTARTSYS or -ENODEV */
316 goto error_mutex_locked;
Vaughan Cao15b06f92013-08-29 10:00:36 +0800317 }
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200318
319 /* N.B. at this point we are holding the open_rel_lock */
320 if (flags & O_EXCL)
321 sdp->exclude = true;
322
323 if (sdp->open_cnt < 1) { /* no existing opens */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 sdp->sgdebug = 0;
Mike Christied6b10342005-11-08 04:06:41 -0600325 q = sdp->device->request_queue;
Martin K. Petersen8a783622010-02-26 00:20:39 -0500326 sdp->sg_tablesize = queue_max_segments(q);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 }
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200328 sfp = sg_add_sfp(sdp);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200329 if (IS_ERR(sfp)) {
330 retval = PTR_ERR(sfp);
331 goto out_undo;
James Bottomley065b4a22013-10-25 10:27:02 +0100332 }
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200333
334 filp->private_data = sfp;
335 sdp->open_cnt++;
336 mutex_unlock(&sdp->open_rel_lock);
337
James Bottomley065b4a22013-10-25 10:27:02 +0100338 retval = 0;
Tony Battersbyc6517b792009-01-21 14:45:50 -0500339sg_put:
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200340 kref_put(&sdp->d_ref, sg_device_destroy);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341 return retval;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200342
343out_undo:
344 if (flags & O_EXCL) {
345 sdp->exclude = false; /* undo if error */
346 wake_up_interruptible(&sdp->open_wait);
347 }
348error_mutex_locked:
349 mutex_unlock(&sdp->open_rel_lock);
350error_out:
351 scsi_autopm_put_device(sdp->device);
352sdp_put:
353 scsi_device_put(sdp->device);
354 goto sg_put;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355}
356
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200357/* Release resources associated with a successful sg_open()
358 * Returns 0 on success, else a negated errno value */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359static int
360sg_release(struct inode *inode, struct file *filp)
361{
362 Sg_device *sdp;
363 Sg_fd *sfp;
364
365 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
366 return -ENXIO;
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200367 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp, "sg_release\n"));
Tony Battersbyc6517b792009-01-21 14:45:50 -0500368
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200369 mutex_lock(&sdp->open_rel_lock);
Alan Sternbc4f2402010-06-17 10:41:42 -0400370 scsi_autopm_put_device(sdp->device);
Tony Battersbyc6517b792009-01-21 14:45:50 -0500371 kref_put(&sfp->f_ref, sg_remove_sfp);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200372 sdp->open_cnt--;
373
374 /* possibly many open()s waiting on exlude clearing, start many;
375 * only open(O_EXCL)s wait on 0==open_cnt so only start one */
376 if (sdp->exclude) {
377 sdp->exclude = false;
378 wake_up_interruptible_all(&sdp->open_wait);
379 } else if (0 == sdp->open_cnt) {
380 wake_up_interruptible(&sdp->open_wait);
381 }
382 mutex_unlock(&sdp->open_rel_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 return 0;
384}
385
386static ssize_t
387sg_read(struct file *filp, char __user *buf, size_t count, loff_t * ppos)
388{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389 Sg_device *sdp;
390 Sg_fd *sfp;
391 Sg_request *srp;
392 int req_pack_id = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 sg_io_hdr_t *hp;
cb59e842005-04-02 13:51:23 -0600394 struct sg_header *old_hdr = NULL;
395 int retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396
397 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
398 return -ENXIO;
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200399 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
400 "sg_read: count=%d\n", (int) count));
Mike Christied6b10342005-11-08 04:06:41 -0600401
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 if (!access_ok(VERIFY_WRITE, buf, count))
403 return -EFAULT;
404 if (sfp->force_packid && (count >= SZ_SG_HEADER)) {
cb59e842005-04-02 13:51:23 -0600405 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
406 if (!old_hdr)
407 return -ENOMEM;
408 if (__copy_from_user(old_hdr, buf, SZ_SG_HEADER)) {
409 retval = -EFAULT;
410 goto free_old_hdr;
411 }
412 if (old_hdr->reply_len < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413 if (count >= SZ_SG_IO_HDR) {
cb59e842005-04-02 13:51:23 -0600414 sg_io_hdr_t *new_hdr;
415 new_hdr = kmalloc(SZ_SG_IO_HDR, GFP_KERNEL);
416 if (!new_hdr) {
417 retval = -ENOMEM;
418 goto free_old_hdr;
419 }
420 retval =__copy_from_user
421 (new_hdr, buf, SZ_SG_IO_HDR);
422 req_pack_id = new_hdr->pack_id;
423 kfree(new_hdr);
424 if (retval) {
425 retval = -EFAULT;
426 goto free_old_hdr;
427 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 }
429 } else
cb59e842005-04-02 13:51:23 -0600430 req_pack_id = old_hdr->pack_id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 }
432 srp = sg_get_rq_mark(sfp, req_pack_id);
433 if (!srp) { /* now wait on packet to arrive */
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200434 if (atomic_read(&sdp->detaching)) {
cb59e842005-04-02 13:51:23 -0600435 retval = -ENODEV;
436 goto free_old_hdr;
437 }
438 if (filp->f_flags & O_NONBLOCK) {
439 retval = -EAGAIN;
440 goto free_old_hdr;
441 }
Jörn Engel3f0c6ab2012-04-12 17:33:25 -0400442 retval = wait_event_interruptible(sfp->read_wait,
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200443 (atomic_read(&sdp->detaching) ||
Jörn Engel3f0c6ab2012-04-12 17:33:25 -0400444 (srp = sg_get_rq_mark(sfp, req_pack_id))));
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200445 if (atomic_read(&sdp->detaching)) {
Jörn Engel794c10f2012-04-12 17:32:48 -0400446 retval = -ENODEV;
447 goto free_old_hdr;
448 }
449 if (retval) {
cb59e842005-04-02 13:51:23 -0600450 /* -ERESTARTSYS as signal hit process */
451 goto free_old_hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 }
453 }
cb59e842005-04-02 13:51:23 -0600454 if (srp->header.interface_id != '\0') {
455 retval = sg_new_read(sfp, buf, count, srp);
456 goto free_old_hdr;
457 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458
459 hp = &srp->header;
cb59e842005-04-02 13:51:23 -0600460 if (old_hdr == NULL) {
461 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
462 if (! old_hdr) {
463 retval = -ENOMEM;
464 goto free_old_hdr;
465 }
466 }
467 memset(old_hdr, 0, SZ_SG_HEADER);
468 old_hdr->reply_len = (int) hp->timeout;
469 old_hdr->pack_len = old_hdr->reply_len; /* old, strange behaviour */
470 old_hdr->pack_id = hp->pack_id;
471 old_hdr->twelve_byte =
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472 ((srp->data.cmd_opcode >= 0xc0) && (12 == hp->cmd_len)) ? 1 : 0;
cb59e842005-04-02 13:51:23 -0600473 old_hdr->target_status = hp->masked_status;
474 old_hdr->host_status = hp->host_status;
475 old_hdr->driver_status = hp->driver_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 if ((CHECK_CONDITION & hp->masked_status) ||
477 (DRIVER_SENSE & hp->driver_status))
cb59e842005-04-02 13:51:23 -0600478 memcpy(old_hdr->sense_buffer, srp->sense_b,
479 sizeof (old_hdr->sense_buffer));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480 switch (hp->host_status) {
481 /* This setup of 'result' is for backward compatibility and is best
482 ignored by the user who should use target, host + driver status */
483 case DID_OK:
484 case DID_PASSTHROUGH:
485 case DID_SOFT_ERROR:
cb59e842005-04-02 13:51:23 -0600486 old_hdr->result = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487 break;
488 case DID_NO_CONNECT:
489 case DID_BUS_BUSY:
490 case DID_TIME_OUT:
cb59e842005-04-02 13:51:23 -0600491 old_hdr->result = EBUSY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 break;
493 case DID_BAD_TARGET:
494 case DID_ABORT:
495 case DID_PARITY:
496 case DID_RESET:
497 case DID_BAD_INTR:
cb59e842005-04-02 13:51:23 -0600498 old_hdr->result = EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499 break;
500 case DID_ERROR:
cb59e842005-04-02 13:51:23 -0600501 old_hdr->result = (srp->sense_b[0] == 0 &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 hp->masked_status == GOOD) ? 0 : EIO;
503 break;
504 default:
cb59e842005-04-02 13:51:23 -0600505 old_hdr->result = EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506 break;
507 }
508
509 /* Now copy the result back to the user buffer. */
510 if (count >= SZ_SG_HEADER) {
cb59e842005-04-02 13:51:23 -0600511 if (__copy_to_user(buf, old_hdr, SZ_SG_HEADER)) {
512 retval = -EFAULT;
513 goto free_old_hdr;
514 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515 buf += SZ_SG_HEADER;
cb59e842005-04-02 13:51:23 -0600516 if (count > old_hdr->reply_len)
517 count = old_hdr->reply_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 if (count > SZ_SG_HEADER) {
cb59e842005-04-02 13:51:23 -0600519 if (sg_read_oxfer(srp, buf, count - SZ_SG_HEADER)) {
520 retval = -EFAULT;
521 goto free_old_hdr;
522 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523 }
524 } else
cb59e842005-04-02 13:51:23 -0600525 count = (old_hdr->result == 0) ? 0 : -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526 sg_finish_rem_req(srp);
Hannes Reinecke97d27b0dd2017-04-07 09:34:17 +0200527 sg_remove_request(sfp, srp);
cb59e842005-04-02 13:51:23 -0600528 retval = count;
529free_old_hdr:
Jesper Juhlc9475cb2005-11-07 01:01:26 -0800530 kfree(old_hdr);
cb59e842005-04-02 13:51:23 -0600531 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532}
533
534static ssize_t
535sg_new_read(Sg_fd * sfp, char __user *buf, size_t count, Sg_request * srp)
536{
537 sg_io_hdr_t *hp = &srp->header;
Tony Battersby3b524a62015-02-11 11:32:06 -0500538 int err = 0, err2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539 int len;
540
541 if (count < SZ_SG_IO_HDR) {
542 err = -EINVAL;
543 goto err_out;
544 }
545 hp->sb_len_wr = 0;
546 if ((hp->mx_sb_len > 0) && hp->sbp) {
547 if ((CHECK_CONDITION & hp->masked_status) ||
548 (DRIVER_SENSE & hp->driver_status)) {
Mike Christied6b10342005-11-08 04:06:41 -0600549 int sb_len = SCSI_SENSE_BUFFERSIZE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 sb_len = (hp->mx_sb_len > sb_len) ? sb_len : hp->mx_sb_len;
551 len = 8 + (int) srp->sense_b[7]; /* Additional sense length field */
552 len = (len > sb_len) ? sb_len : len;
553 if (copy_to_user(hp->sbp, srp->sense_b, len)) {
554 err = -EFAULT;
555 goto err_out;
556 }
557 hp->sb_len_wr = len;
558 }
559 }
560 if (hp->masked_status || hp->host_status || hp->driver_status)
561 hp->info |= SG_INFO_CHECK;
562 if (copy_to_user(buf, hp, SZ_SG_IO_HDR)) {
563 err = -EFAULT;
564 goto err_out;
565 }
FUJITA Tomonori0b6cb262008-09-02 22:50:07 +0900566err_out:
Tony Battersby3b524a62015-02-11 11:32:06 -0500567 err2 = sg_finish_rem_req(srp);
Hannes Reinecke97d27b0dd2017-04-07 09:34:17 +0200568 sg_remove_request(sfp, srp);
Tony Battersby3b524a62015-02-11 11:32:06 -0500569 return err ? : err2 ? : count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570}
571
572static ssize_t
573sg_write(struct file *filp, const char __user *buf, size_t count, loff_t * ppos)
574{
575 int mxsize, cmd_size, k;
576 int input_size, blocking;
577 unsigned char opcode;
578 Sg_device *sdp;
579 Sg_fd *sfp;
580 Sg_request *srp;
581 struct sg_header old_hdr;
582 sg_io_hdr_t *hp;
Douglas Gilbert65c26a02014-06-03 13:18:18 -0400583 unsigned char cmnd[SG_MAX_CDB_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584
Al Virodb68ce12017-03-20 21:08:07 -0400585 if (unlikely(uaccess_kernel()))
Al Viro128394e2016-12-16 13:42:06 -0500586 return -EINVAL;
587
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
589 return -ENXIO;
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200590 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
591 "sg_write: count=%d\n", (int) count));
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200592 if (atomic_read(&sdp->detaching))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 return -ENODEV;
594 if (!((filp->f_flags & O_NONBLOCK) ||
595 scsi_block_when_processing_errors(sdp->device)))
596 return -ENXIO;
597
598 if (!access_ok(VERIFY_READ, buf, count))
599 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
600 if (count < SZ_SG_HEADER)
601 return -EIO;
602 if (__copy_from_user(&old_hdr, buf, SZ_SG_HEADER))
603 return -EFAULT;
604 blocking = !(filp->f_flags & O_NONBLOCK);
605 if (old_hdr.reply_len < 0)
Tony Battersbya2dd3b42009-01-20 17:00:09 -0500606 return sg_new_write(sfp, filp, buf, count,
607 blocking, 0, 0, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608 if (count < (SZ_SG_HEADER + 6))
609 return -EIO; /* The minimum scsi command length is 6 bytes. */
610
611 if (!(srp = sg_add_request(sfp))) {
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200612 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO, sdp,
613 "sg_write: queue full\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614 return -EDOM;
615 }
616 buf += SZ_SG_HEADER;
617 __get_user(opcode, buf);
Hannes Reinecke1bc0eb02017-04-07 09:34:14 +0200618 mutex_lock(&sfp->f_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619 if (sfp->next_cmd_len > 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620 cmd_size = sfp->next_cmd_len;
621 sfp->next_cmd_len = 0; /* reset so only this write() effected */
622 } else {
623 cmd_size = COMMAND_SIZE(opcode); /* based on SCSI command group */
624 if ((opcode >= 0xc0) && old_hdr.twelve_byte)
625 cmd_size = 12;
626 }
Hannes Reinecke1bc0eb02017-04-07 09:34:14 +0200627 mutex_unlock(&sfp->f_mutex);
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200628 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sdp,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 "sg_write: scsi opcode=0x%02x, cmd_size=%d\n", (int) opcode, cmd_size));
630/* Determine buffer size. */
631 input_size = count - cmd_size;
632 mxsize = (input_size > old_hdr.reply_len) ? input_size : old_hdr.reply_len;
633 mxsize -= SZ_SG_HEADER;
634 input_size -= SZ_SG_HEADER;
635 if (input_size < 0) {
636 sg_remove_request(sfp, srp);
637 return -EIO; /* User did not pass enough bytes for this command. */
638 }
639 hp = &srp->header;
640 hp->interface_id = '\0'; /* indicator of old interface tunnelled */
641 hp->cmd_len = (unsigned char) cmd_size;
642 hp->iovec_count = 0;
643 hp->mx_sb_len = 0;
644 if (input_size > 0)
645 hp->dxfer_direction = (old_hdr.reply_len > SZ_SG_HEADER) ?
646 SG_DXFER_TO_FROM_DEV : SG_DXFER_TO_DEV;
647 else
648 hp->dxfer_direction = (mxsize > 0) ? SG_DXFER_FROM_DEV : SG_DXFER_NONE;
649 hp->dxfer_len = mxsize;
Douglas Gilbert5ecee0a2016-03-03 00:31:29 -0500650 if ((hp->dxfer_direction == SG_DXFER_TO_DEV) ||
651 (hp->dxfer_direction == SG_DXFER_TO_FROM_DEV))
FUJITA Tomonorifad7f012008-09-02 16:20:20 +0900652 hp->dxferp = (char __user *)buf + cmd_size;
653 else
654 hp->dxferp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 hp->sbp = NULL;
656 hp->timeout = old_hdr.reply_len; /* structure abuse ... */
657 hp->flags = input_size; /* structure abuse ... */
658 hp->pack_id = old_hdr.pack_id;
659 hp->usr_ptr = NULL;
660 if (__copy_from_user(cmnd, buf, cmd_size))
661 return -EFAULT;
662 /*
663 * SG_DXFER_TO_FROM_DEV is functionally equivalent to SG_DXFER_FROM_DEV,
664 * but is is possible that the app intended SG_DXFER_TO_DEV, because there
665 * is a non-zero input_size, so emit a warning.
666 */
Andi Kleeneaa3e222008-01-13 17:41:43 +0100667 if (hp->dxfer_direction == SG_DXFER_TO_FROM_DEV) {
Johannes Thumshirn28676d82017-04-07 09:34:15 +0200668 printk_ratelimited(KERN_WARNING
669 "sg_write: data in/out %d/%d bytes "
670 "for SCSI command 0x%x-- guessing "
671 "data in;\n program %s not setting "
672 "count and/or reply_len properly\n",
673 old_hdr.reply_len - (int)SZ_SG_HEADER,
674 input_size, (unsigned int) cmnd[0],
675 current->comm);
Andi Kleeneaa3e222008-01-13 17:41:43 +0100676 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 k = sg_common_write(sfp, srp, cmnd, sfp->timeout, blocking);
678 return (k < 0) ? k : count;
679}
680
681static ssize_t
Adel Gadllah0b07de82008-06-26 13:48:27 +0200682sg_new_write(Sg_fd *sfp, struct file *file, const char __user *buf,
Tony Battersbya2dd3b42009-01-20 17:00:09 -0500683 size_t count, int blocking, int read_only, int sg_io_owned,
Adel Gadllah0b07de82008-06-26 13:48:27 +0200684 Sg_request **o_srp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685{
686 int k;
687 Sg_request *srp;
688 sg_io_hdr_t *hp;
Douglas Gilbert65c26a02014-06-03 13:18:18 -0400689 unsigned char cmnd[SG_MAX_CDB_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690 int timeout;
691 unsigned long ul_timeout;
692
693 if (count < SZ_SG_IO_HDR)
694 return -EINVAL;
695 if (!access_ok(VERIFY_READ, buf, count))
696 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
697
698 sfp->cmd_q = 1; /* when sg_io_hdr seen, set command queuing on */
699 if (!(srp = sg_add_request(sfp))) {
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200700 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO, sfp->parentdp,
701 "sg_new_write: queue full\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702 return -EDOM;
703 }
Tony Battersbya2dd3b42009-01-20 17:00:09 -0500704 srp->sg_io_owned = sg_io_owned;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705 hp = &srp->header;
706 if (__copy_from_user(hp, buf, SZ_SG_IO_HDR)) {
707 sg_remove_request(sfp, srp);
708 return -EFAULT;
709 }
710 if (hp->interface_id != 'S') {
711 sg_remove_request(sfp, srp);
712 return -ENOSYS;
713 }
714 if (hp->flags & SG_FLAG_MMAP_IO) {
715 if (hp->dxfer_len > sfp->reserve.bufflen) {
716 sg_remove_request(sfp, srp);
717 return -ENOMEM; /* MMAP_IO size must fit in reserve buffer */
718 }
719 if (hp->flags & SG_FLAG_DIRECT_IO) {
720 sg_remove_request(sfp, srp);
721 return -EINVAL; /* either MMAP_IO or DIRECT_IO (not both) */
722 }
Hannes Reinecke1bc0eb02017-04-07 09:34:14 +0200723 if (sfp->res_in_use) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 sg_remove_request(sfp, srp);
725 return -EBUSY; /* reserve buffer already being used */
726 }
727 }
728 ul_timeout = msecs_to_jiffies(srp->header.timeout);
729 timeout = (ul_timeout < INT_MAX) ? ul_timeout : INT_MAX;
730 if ((!hp->cmdp) || (hp->cmd_len < 6) || (hp->cmd_len > sizeof (cmnd))) {
731 sg_remove_request(sfp, srp);
732 return -EMSGSIZE;
733 }
734 if (!access_ok(VERIFY_READ, hp->cmdp, hp->cmd_len)) {
735 sg_remove_request(sfp, srp);
736 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
737 }
738 if (__copy_from_user(cmnd, hp->cmdp, hp->cmd_len)) {
739 sg_remove_request(sfp, srp);
740 return -EFAULT;
741 }
FUJITA Tomonori14e507b2008-07-26 18:03:24 +0900742 if (read_only && sg_allow_access(file, cmnd)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 sg_remove_request(sfp, srp);
744 return -EPERM;
745 }
746 k = sg_common_write(sfp, srp, cmnd, timeout, blocking);
747 if (k < 0)
748 return k;
749 if (o_srp)
750 *o_srp = srp;
751 return count;
752}
753
Johannes Thumshirn28676d82017-04-07 09:34:15 +0200754static bool sg_is_valid_dxfer(sg_io_hdr_t *hp)
755{
756 switch (hp->dxfer_direction) {
757 case SG_DXFER_NONE:
758 if (hp->dxferp || hp->dxfer_len > 0)
759 return false;
760 return true;
Johannes Thumshirn28676d82017-04-07 09:34:15 +0200761 case SG_DXFER_FROM_DEV:
Johannes Thumshirn14074ab2017-07-17 15:11:42 +0200762 /*
763 * for SG_DXFER_FROM_DEV we always set dxfer_len to > 0. dxferp
764 * can either be NULL or != NULL so there's no point in checking
765 * it either. So just return true.
766 */
Johannes Thumshirn68c59fc2017-07-07 10:56:38 +0200767 return true;
768 case SG_DXFER_TO_DEV:
Johannes Thumshirn28676d82017-04-07 09:34:15 +0200769 case SG_DXFER_TO_FROM_DEV:
770 if (!hp->dxferp || hp->dxfer_len == 0)
771 return false;
772 return true;
773 case SG_DXFER_UNKNOWN:
774 if ((!hp->dxferp && hp->dxfer_len) ||
775 (hp->dxferp && hp->dxfer_len == 0))
776 return false;
777 return true;
778 default:
779 return false;
780 }
781}
782
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783static int
784sg_common_write(Sg_fd * sfp, Sg_request * srp,
785 unsigned char *cmnd, int timeout, int blocking)
786{
Bart Van Assche5af2e382015-01-30 16:22:38 +0100787 int k, at_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 Sg_device *sdp = sfp->parentdp;
789 sg_io_hdr_t *hp = &srp->header;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790
791 srp->data.cmd_opcode = cmnd[0]; /* hold opcode of command */
792 hp->status = 0;
793 hp->masked_status = 0;
794 hp->msg_status = 0;
795 hp->info = 0;
796 hp->host_status = 0;
797 hp->driver_status = 0;
798 hp->resid = 0;
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200799 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
800 "sg_common_write: scsi opcode=0x%02x, cmd_size=%d\n",
801 (int) cmnd[0], (int) hp->cmd_len));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802
Johannes Thumshirn28676d82017-04-07 09:34:15 +0200803 if (!sg_is_valid_dxfer(hp))
804 return -EINVAL;
805
FUJITA Tomonori10865df2008-08-28 16:17:07 +0900806 k = sg_start_req(srp, cmnd);
807 if (k) {
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200808 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO, sfp->parentdp,
809 "sg_common_write: start_req err=%d\n", k));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810 sg_finish_rem_req(srp);
Hannes Reinecke97d27b0dd2017-04-07 09:34:17 +0200811 sg_remove_request(sfp, srp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 return k; /* probably out of space --> ENOMEM */
813 }
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200814 if (atomic_read(&sdp->detaching)) {
Calvin Owensf3951a32015-10-30 16:57:00 -0700815 if (srp->bio) {
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100816 scsi_req_free_cmd(scsi_req(srp->rq));
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200817 blk_end_request_all(srp->rq, BLK_STS_IOERR);
Calvin Owensf3951a32015-10-30 16:57:00 -0700818 srp->rq = NULL;
819 }
820
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821 sg_finish_rem_req(srp);
Hannes Reinecke97d27b0dd2017-04-07 09:34:17 +0200822 sg_remove_request(sfp, srp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823 return -ENODEV;
824 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825
cb59e842005-04-02 13:51:23 -0600826 hp->duration = jiffies_to_msecs(jiffies);
Douglas Gilbert16070cc2014-06-04 10:58:30 -0400827 if (hp->interface_id != '\0' && /* v3 (or later) interface */
828 (SG_FLAG_Q_AT_TAIL & hp->flags))
829 at_head = 0;
830 else
831 at_head = 1;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +0200832
833 srp->rq->timeout = timeout;
Tony Battersbyc6517b792009-01-21 14:45:50 -0500834 kref_get(&sfp->f_ref); /* sg_rq_end_io() does kref_put(). */
FUJITA Tomonori10db10d2008-08-29 12:32:18 +0200835 blk_execute_rq_nowait(sdp->device->request_queue, sdp->disk,
Douglas Gilbert16070cc2014-06-04 10:58:30 -0400836 srp->rq, at_head, sg_rq_end_io);
FUJITA Tomonori10db10d2008-08-29 12:32:18 +0200837 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838}
839
Jörn Engel6acddc52012-04-12 17:33:58 -0400840static int srp_done(Sg_fd *sfp, Sg_request *srp)
841{
842 unsigned long flags;
843 int ret;
844
845 read_lock_irqsave(&sfp->rq_list_lock, flags);
846 ret = srp->done;
847 read_unlock_irqrestore(&sfp->rq_list_lock, flags);
848 return ret;
849}
850
Akinobu Mita46f69e62014-06-02 22:56:46 +0900851static int max_sectors_bytes(struct request_queue *q)
852{
853 unsigned int max_sectors = queue_max_sectors(q);
854
855 max_sectors = min_t(unsigned int, max_sectors, INT_MAX >> 9);
856
857 return max_sectors << 9;
858}
859
Jörn Engel37b9d1e2012-04-12 17:35:05 -0400860static long
Arnd Bergmannf4927c42010-04-27 00:24:01 +0200861sg_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862{
863 void __user *p = (void __user *)arg;
864 int __user *ip = p;
Christoph Hellwig176aa9d2014-10-11 12:06:47 +0200865 int result, val, read_only;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866 Sg_device *sdp;
867 Sg_fd *sfp;
868 Sg_request *srp;
869 unsigned long iflags;
870
871 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
872 return -ENXIO;
FUJITA Tomonoriabf54392008-08-16 14:10:05 +0900873
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200874 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
875 "sg_ioctl: cmd=0x%x\n", (int) cmd_in));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876 read_only = (O_RDWR != (filp->f_flags & O_ACCMODE));
877
878 switch (cmd_in) {
879 case SG_IO:
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200880 if (atomic_read(&sdp->detaching))
Jörn Engeldddbf8d2012-04-12 17:32:17 -0400881 return -ENODEV;
882 if (!scsi_block_when_processing_errors(sdp->device))
883 return -ENXIO;
884 if (!access_ok(VERIFY_WRITE, p, SZ_SG_IO_HDR))
885 return -EFAULT;
886 result = sg_new_write(sfp, filp, p, SZ_SG_IO_HDR,
887 1, read_only, 1, &srp);
888 if (result < 0)
889 return result;
Jörn Engel3f0c6ab2012-04-12 17:33:25 -0400890 result = wait_event_interruptible(sfp->read_wait,
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200891 (srp_done(sfp, srp) || atomic_read(&sdp->detaching)));
892 if (atomic_read(&sdp->detaching))
Jörn Engel794c10f2012-04-12 17:32:48 -0400893 return -ENODEV;
894 write_lock_irq(&sfp->rq_list_lock);
895 if (srp->done) {
896 srp->done = 2;
Jörn Engeldddbf8d2012-04-12 17:32:17 -0400897 write_unlock_irq(&sfp->rq_list_lock);
Jörn Engel794c10f2012-04-12 17:32:48 -0400898 result = sg_new_read(sfp, p, SZ_SG_IO_HDR, srp);
899 return (result < 0) ? result : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900 }
Jörn Engel794c10f2012-04-12 17:32:48 -0400901 srp->orphan = 1;
902 write_unlock_irq(&sfp->rq_list_lock);
903 return result; /* -ERESTARTSYS because signal hit process */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904 case SG_SET_TIMEOUT:
905 result = get_user(val, ip);
906 if (result)
907 return result;
908 if (val < 0)
909 return -EIO;
Paul Burtonf8630bd72016-08-19 17:43:57 +0100910 if (val >= mult_frac((s64)INT_MAX, USER_HZ, HZ))
911 val = min_t(s64, mult_frac((s64)INT_MAX, USER_HZ, HZ),
Paul Burtonb9b6e802016-08-19 17:43:56 +0100912 INT_MAX);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913 sfp->timeout_user = val;
Paul Burtonf8630bd72016-08-19 17:43:57 +0100914 sfp->timeout = mult_frac(val, HZ, USER_HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915
916 return 0;
917 case SG_GET_TIMEOUT: /* N.B. User receives timeout as return value */
918 /* strange ..., for backward compatibility */
919 return sfp->timeout_user;
920 case SG_SET_FORCE_LOW_DMA:
Hannes Reinecke745dfa02017-04-07 09:34:12 +0200921 /*
922 * N.B. This ioctl never worked properly, but failed to
923 * return an error value. So returning '0' to keep compability
924 * with legacy applications.
925 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926 return 0;
927 case SG_GET_LOW_DMA:
Hannes Reinecke745dfa02017-04-07 09:34:12 +0200928 return put_user((int) sdp->device->host->unchecked_isa_dma, ip);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929 case SG_GET_SCSI_ID:
930 if (!access_ok(VERIFY_WRITE, p, sizeof (sg_scsi_id_t)))
931 return -EFAULT;
932 else {
933 sg_scsi_id_t __user *sg_idp = p;
934
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200935 if (atomic_read(&sdp->detaching))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936 return -ENODEV;
937 __put_user((int) sdp->device->host->host_no,
938 &sg_idp->host_no);
939 __put_user((int) sdp->device->channel,
940 &sg_idp->channel);
941 __put_user((int) sdp->device->id, &sg_idp->scsi_id);
942 __put_user((int) sdp->device->lun, &sg_idp->lun);
943 __put_user((int) sdp->device->type, &sg_idp->scsi_type);
944 __put_user((short) sdp->device->host->cmd_per_lun,
945 &sg_idp->h_cmd_per_lun);
946 __put_user((short) sdp->device->queue_depth,
947 &sg_idp->d_queue_depth);
948 __put_user(0, &sg_idp->unused[0]);
949 __put_user(0, &sg_idp->unused[1]);
950 return 0;
951 }
952 case SG_SET_FORCE_PACK_ID:
953 result = get_user(val, ip);
954 if (result)
955 return result;
956 sfp->force_packid = val ? 1 : 0;
957 return 0;
958 case SG_GET_PACK_ID:
959 if (!access_ok(VERIFY_WRITE, ip, sizeof (int)))
960 return -EFAULT;
961 read_lock_irqsave(&sfp->rq_list_lock, iflags);
Hannes Reinecke109bade2017-04-07 09:34:16 +0200962 list_for_each_entry(srp, &sfp->rq_list, entry) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963 if ((1 == srp->done) && (!srp->sg_io_owned)) {
964 read_unlock_irqrestore(&sfp->rq_list_lock,
965 iflags);
966 __put_user(srp->header.pack_id, ip);
967 return 0;
968 }
969 }
970 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
971 __put_user(-1, ip);
972 return 0;
973 case SG_GET_NUM_WAITING:
974 read_lock_irqsave(&sfp->rq_list_lock, iflags);
Hannes Reinecke109bade2017-04-07 09:34:16 +0200975 val = 0;
976 list_for_each_entry(srp, &sfp->rq_list, entry) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977 if ((1 == srp->done) && (!srp->sg_io_owned))
978 ++val;
979 }
980 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
981 return put_user(val, ip);
982 case SG_GET_SG_TABLESIZE:
983 return put_user(sdp->sg_tablesize, ip);
984 case SG_SET_RESERVED_SIZE:
985 result = get_user(val, ip);
986 if (result)
987 return result;
988 if (val < 0)
989 return -EINVAL;
Alan Stern44ec9542007-02-20 11:01:57 -0500990 val = min_t(int, val,
Akinobu Mita46f69e62014-06-02 22:56:46 +0900991 max_sectors_bytes(sdp->device->request_queue));
Hannes Reinecke1bc0eb02017-04-07 09:34:14 +0200992 mutex_lock(&sfp->f_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993 if (val != sfp->reserve.bufflen) {
Hannes Reinecke1bc0eb02017-04-07 09:34:14 +0200994 if (sfp->mmap_called ||
995 sfp->res_in_use) {
996 mutex_unlock(&sfp->f_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997 return -EBUSY;
Hannes Reinecke1bc0eb02017-04-07 09:34:14 +0200998 }
999
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001000 sg_remove_scat(sfp, &sfp->reserve);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001 sg_build_reserve(sfp, val);
1002 }
Hannes Reinecke1bc0eb02017-04-07 09:34:14 +02001003 mutex_unlock(&sfp->f_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004 return 0;
1005 case SG_GET_RESERVED_SIZE:
Alan Stern44ec9542007-02-20 11:01:57 -05001006 val = min_t(int, sfp->reserve.bufflen,
Akinobu Mita46f69e62014-06-02 22:56:46 +09001007 max_sectors_bytes(sdp->device->request_queue));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008 return put_user(val, ip);
1009 case SG_SET_COMMAND_Q:
1010 result = get_user(val, ip);
1011 if (result)
1012 return result;
1013 sfp->cmd_q = val ? 1 : 0;
1014 return 0;
1015 case SG_GET_COMMAND_Q:
1016 return put_user((int) sfp->cmd_q, ip);
1017 case SG_SET_KEEP_ORPHAN:
1018 result = get_user(val, ip);
1019 if (result)
1020 return result;
1021 sfp->keep_orphan = val;
1022 return 0;
1023 case SG_GET_KEEP_ORPHAN:
1024 return put_user((int) sfp->keep_orphan, ip);
1025 case SG_NEXT_CMD_LEN:
1026 result = get_user(val, ip);
1027 if (result)
1028 return result;
peter changbf33f872017-02-15 14:11:54 -08001029 if (val > SG_MAX_CDB_SIZE)
1030 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031 sfp->next_cmd_len = (val > 0) ? val : 0;
1032 return 0;
1033 case SG_GET_VERSION_NUM:
1034 return put_user(sg_version_num, ip);
1035 case SG_GET_ACCESS_COUNT:
1036 /* faked - we don't have a real access count anymore */
1037 val = (sdp->device ? 1 : 0);
1038 return put_user(val, ip);
1039 case SG_GET_REQUEST_TABLE:
1040 if (!access_ok(VERIFY_WRITE, p, SZ_SG_REQ_INFO * SG_MAX_QUEUE))
1041 return -EFAULT;
1042 else {
cb59e842005-04-02 13:51:23 -06001043 sg_req_info_t *rinfo;
1044 unsigned int ms;
1045
1046 rinfo = kmalloc(SZ_SG_REQ_INFO * SG_MAX_QUEUE,
1047 GFP_KERNEL);
1048 if (!rinfo)
1049 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050 read_lock_irqsave(&sfp->rq_list_lock, iflags);
Hannes Reinecke109bade2017-04-07 09:34:16 +02001051 val = 0;
1052 list_for_each_entry(srp, &sfp->rq_list, entry) {
1053 if (val > SG_MAX_QUEUE)
1054 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055 memset(&rinfo[val], 0, SZ_SG_REQ_INFO);
Hannes Reinecke109bade2017-04-07 09:34:16 +02001056 rinfo[val].req_state = srp->done + 1;
1057 rinfo[val].problem =
1058 srp->header.masked_status &
1059 srp->header.host_status &
1060 srp->header.driver_status;
1061 if (srp->done)
1062 rinfo[val].duration =
1063 srp->header.duration;
1064 else {
1065 ms = jiffies_to_msecs(jiffies);
1066 rinfo[val].duration =
1067 (ms > srp->header.duration) ?
1068 (ms - srp->header.duration) : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069 }
Hannes Reinecke109bade2017-04-07 09:34:16 +02001070 rinfo[val].orphan = srp->orphan;
1071 rinfo[val].sg_io_owned = srp->sg_io_owned;
1072 rinfo[val].pack_id = srp->header.pack_id;
1073 rinfo[val].usr_ptr = srp->header.usr_ptr;
1074 val++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075 }
1076 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
Hannes Reinecke109bade2017-04-07 09:34:16 +02001077 result = __copy_to_user(p, rinfo,
cb59e842005-04-02 13:51:23 -06001078 SZ_SG_REQ_INFO * SG_MAX_QUEUE);
1079 result = result ? -EFAULT : 0;
1080 kfree(rinfo);
1081 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082 }
1083 case SG_EMULATED_HOST:
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001084 if (atomic_read(&sdp->detaching))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085 return -ENODEV;
1086 return put_user(sdp->device->host->hostt->emulated, ip);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087 case SCSI_IOCTL_SEND_COMMAND:
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001088 if (atomic_read(&sdp->detaching))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089 return -ENODEV;
1090 if (read_only) {
1091 unsigned char opcode = WRITE_6;
1092 Scsi_Ioctl_Command __user *siocp = p;
1093
1094 if (copy_from_user(&opcode, siocp->data, 1))
1095 return -EFAULT;
FUJITA Tomonori14e507b2008-07-26 18:03:24 +09001096 if (sg_allow_access(filp, &opcode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097 return -EPERM;
1098 }
Al Viroe915e872008-09-02 17:16:41 -04001099 return sg_scsi_ioctl(sdp->device->request_queue, NULL, filp->f_mode, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100 case SG_SET_DEBUG:
1101 result = get_user(val, ip);
1102 if (result)
1103 return result;
1104 sdp->sgdebug = (char) val;
1105 return 0;
Alan Stern44ec9542007-02-20 11:01:57 -05001106 case BLKSECTGET:
Akinobu Mita46f69e62014-06-02 22:56:46 +09001107 return put_user(max_sectors_bytes(sdp->device->request_queue),
Alan Stern44ec9542007-02-20 11:01:57 -05001108 ip);
Christof Schmitt6da127a2008-01-11 10:09:43 +01001109 case BLKTRACESETUP:
1110 return blk_trace_setup(sdp->device->request_queue,
1111 sdp->disk->disk_name,
Martin Peschke76e3a192009-01-30 15:46:23 +01001112 MKDEV(SCSI_GENERIC_MAJOR, sdp->index),
Shawn Dud0deef52009-04-14 13:58:56 +08001113 NULL,
Christof Schmitt6da127a2008-01-11 10:09:43 +01001114 (char *)arg);
1115 case BLKTRACESTART:
1116 return blk_trace_startstop(sdp->device->request_queue, 1);
1117 case BLKTRACESTOP:
1118 return blk_trace_startstop(sdp->device->request_queue, 0);
1119 case BLKTRACETEARDOWN:
1120 return blk_trace_remove(sdp->device->request_queue);
Christoph Hellwig906d15f2014-10-11 16:25:31 +02001121 case SCSI_IOCTL_GET_IDLUN:
1122 case SCSI_IOCTL_GET_BUS_NUMBER:
1123 case SCSI_IOCTL_PROBE_HOST:
1124 case SG_GET_TRANSFORM:
1125 case SG_SCSI_RESET:
1126 if (atomic_read(&sdp->detaching))
1127 return -ENODEV;
1128 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001129 default:
1130 if (read_only)
1131 return -EPERM; /* don't know so take safe approach */
Christoph Hellwig906d15f2014-10-11 16:25:31 +02001132 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001133 }
Christoph Hellwig906d15f2014-10-11 16:25:31 +02001134
1135 result = scsi_ioctl_block_when_processing_errors(sdp->device,
1136 cmd_in, filp->f_flags & O_NDELAY);
1137 if (result)
1138 return result;
1139 return scsi_ioctl(sdp->device, cmd_in, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140}
1141
1142#ifdef CONFIG_COMPAT
1143static long sg_compat_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
1144{
1145 Sg_device *sdp;
1146 Sg_fd *sfp;
1147 struct scsi_device *sdev;
1148
1149 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1150 return -ENXIO;
1151
1152 sdev = sdp->device;
1153 if (sdev->host->hostt->compat_ioctl) {
1154 int ret;
1155
1156 ret = sdev->host->hostt->compat_ioctl(sdev, cmd_in, (void __user *)arg);
1157
1158 return ret;
1159 }
1160
1161 return -ENOIOCTLCMD;
1162}
1163#endif
1164
1165static unsigned int
1166sg_poll(struct file *filp, poll_table * wait)
1167{
1168 unsigned int res = 0;
1169 Sg_device *sdp;
1170 Sg_fd *sfp;
1171 Sg_request *srp;
1172 int count = 0;
1173 unsigned long iflags;
1174
Jörn Engelebaf4662012-04-12 17:33:39 -04001175 sfp = filp->private_data;
1176 if (!sfp)
1177 return POLLERR;
1178 sdp = sfp->parentdp;
1179 if (!sdp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180 return POLLERR;
1181 poll_wait(filp, &sfp->read_wait, wait);
1182 read_lock_irqsave(&sfp->rq_list_lock, iflags);
Hannes Reinecke109bade2017-04-07 09:34:16 +02001183 list_for_each_entry(srp, &sfp->rq_list, entry) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001184 /* if any read waiting, flag it */
1185 if ((0 == res) && (1 == srp->done) && (!srp->sg_io_owned))
1186 res = POLLIN | POLLRDNORM;
1187 ++count;
1188 }
1189 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1190
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001191 if (atomic_read(&sdp->detaching))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192 res |= POLLHUP;
1193 else if (!sfp->cmd_q) {
1194 if (0 == count)
1195 res |= POLLOUT | POLLWRNORM;
1196 } else if (count < SG_MAX_QUEUE)
1197 res |= POLLOUT | POLLWRNORM;
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001198 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
1199 "sg_poll: res=0x%x\n", (int) res));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200 return res;
1201}
1202
1203static int
1204sg_fasync(int fd, struct file *filp, int mode)
1205{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206 Sg_device *sdp;
1207 Sg_fd *sfp;
1208
1209 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1210 return -ENXIO;
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001211 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
1212 "sg_fasync: mode=%d\n", mode));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213
Jonathan Corbet60aa4922009-02-01 14:52:56 -07001214 return fasync_helper(fd, filp, mode, &sfp->async_qp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215}
1216
Nick Piggina13ff0b2008-02-07 18:46:06 -08001217static int
Dave Jiang11bac802017-02-24 14:56:41 -08001218sg_vma_fault(struct vm_fault *vmf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219{
Dave Jiang11bac802017-02-24 14:56:41 -08001220 struct vm_area_struct *vma = vmf->vma;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221 Sg_fd *sfp;
Mike Christied6b10342005-11-08 04:06:41 -06001222 unsigned long offset, len, sa;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223 Sg_scatter_hold *rsv_schp;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001224 int k, length;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225
1226 if ((NULL == vma) || (!(sfp = (Sg_fd *) vma->vm_private_data)))
Nick Piggina13ff0b2008-02-07 18:46:06 -08001227 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228 rsv_schp = &sfp->reserve;
Nick Piggina13ff0b2008-02-07 18:46:06 -08001229 offset = vmf->pgoff << PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230 if (offset >= rsv_schp->bufflen)
Nick Piggina13ff0b2008-02-07 18:46:06 -08001231 return VM_FAULT_SIGBUS;
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001232 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sfp->parentdp,
1233 "sg_vma_fault: offset=%lu, scatg=%d\n",
1234 offset, rsv_schp->k_use_sg));
Mike Christied6b10342005-11-08 04:06:41 -06001235 sa = vma->vm_start;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001236 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1237 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
Mike Christied6b10342005-11-08 04:06:41 -06001238 len = vma->vm_end - sa;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001239 len = (len < length) ? len : length;
Mike Christied6b10342005-11-08 04:06:41 -06001240 if (offset < len) {
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001241 struct page *page = nth_page(rsv_schp->pages[k],
1242 offset >> PAGE_SHIFT);
Mike Christied6b10342005-11-08 04:06:41 -06001243 get_page(page); /* increment page count */
Nick Piggina13ff0b2008-02-07 18:46:06 -08001244 vmf->page = page;
1245 return 0; /* success */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246 }
Mike Christied6b10342005-11-08 04:06:41 -06001247 sa += len;
1248 offset -= len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249 }
Mike Christied6b10342005-11-08 04:06:41 -06001250
Nick Piggina13ff0b2008-02-07 18:46:06 -08001251 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252}
1253
Alexey Dobriyanf0f37e2f2009-09-27 22:29:37 +04001254static const struct vm_operations_struct sg_mmap_vm_ops = {
Nick Piggina13ff0b2008-02-07 18:46:06 -08001255 .fault = sg_vma_fault,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001256};
1257
1258static int
1259sg_mmap(struct file *filp, struct vm_area_struct *vma)
1260{
1261 Sg_fd *sfp;
Mike Christied6b10342005-11-08 04:06:41 -06001262 unsigned long req_sz, len, sa;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263 Sg_scatter_hold *rsv_schp;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001264 int k, length;
Todd Poynor6a8dadc2017-08-15 22:41:08 -07001265 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266
1267 if ((!filp) || (!vma) || (!(sfp = (Sg_fd *) filp->private_data)))
1268 return -ENXIO;
cb59e842005-04-02 13:51:23 -06001269 req_sz = vma->vm_end - vma->vm_start;
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001270 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sfp->parentdp,
1271 "sg_mmap starting, vm_start=%p, len=%d\n",
1272 (void *) vma->vm_start, (int) req_sz));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273 if (vma->vm_pgoff)
1274 return -EINVAL; /* want no offset */
1275 rsv_schp = &sfp->reserve;
Todd Poynor6a8dadc2017-08-15 22:41:08 -07001276 mutex_lock(&sfp->f_mutex);
1277 if (req_sz > rsv_schp->bufflen) {
1278 ret = -ENOMEM; /* cannot map more than reserved buffer */
1279 goto out;
1280 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281
Mike Christied6b10342005-11-08 04:06:41 -06001282 sa = vma->vm_start;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001283 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1284 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
Mike Christied6b10342005-11-08 04:06:41 -06001285 len = vma->vm_end - sa;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001286 len = (len < length) ? len : length;
Mike Christied6b10342005-11-08 04:06:41 -06001287 sa += len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288 }
Mike Christied6b10342005-11-08 04:06:41 -06001289
Nick Pigginf9aed0e2006-03-22 00:08:30 -08001290 sfp->mmap_called = 1;
Kirill A. Shutemov461c7fa2016-02-02 16:57:35 -08001291 vma->vm_flags |= VM_IO | VM_DONTEXPAND | VM_DONTDUMP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292 vma->vm_private_data = sfp;
1293 vma->vm_ops = &sg_mmap_vm_ops;
Todd Poynor6a8dadc2017-08-15 22:41:08 -07001294out:
1295 mutex_unlock(&sfp->f_mutex);
1296 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001297}
1298
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001299static void
1300sg_rq_end_io_usercontext(struct work_struct *work)
FUJITA Tomonoric96952e2009-02-04 11:36:27 +09001301{
1302 struct sg_request *srp = container_of(work, struct sg_request, ew.work);
1303 struct sg_fd *sfp = srp->parentfp;
1304
1305 sg_finish_rem_req(srp);
Hannes Reinecke97d27b0dd2017-04-07 09:34:17 +02001306 sg_remove_request(sfp, srp);
FUJITA Tomonoric96952e2009-02-04 11:36:27 +09001307 kref_put(&sfp->f_ref, sg_remove_sfp);
1308}
1309
FUJITA Tomonoria91a3a22008-09-02 22:50:01 +09001310/*
1311 * This function is a "bottom half" handler that is called by the mid
1312 * level when a command is completed (or has failed).
1313 */
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001314static void
Christoph Hellwig2a842ac2017-06-03 09:38:04 +02001315sg_rq_end_io(struct request *rq, blk_status_t status)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316{
FUJITA Tomonoria91a3a22008-09-02 22:50:01 +09001317 struct sg_request *srp = rq->end_io_data;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001318 struct scsi_request *req = scsi_req(rq);
Tony Battersbyc6517b792009-01-21 14:45:50 -05001319 Sg_device *sdp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320 Sg_fd *sfp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321 unsigned long iflags;
cb59e842005-04-02 13:51:23 -06001322 unsigned int ms;
FUJITA Tomonoria91a3a22008-09-02 22:50:01 +09001323 char *sense;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001324 int result, resid, done = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325
Tony Battersbyc6517b792009-01-21 14:45:50 -05001326 if (WARN_ON(srp->done != 0))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327 return;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001328
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329 sfp = srp->parentfp;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001330 if (WARN_ON(sfp == NULL))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331 return;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001332
1333 sdp = sfp->parentdp;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001334 if (unlikely(atomic_read(&sdp->detaching)))
1335 pr_info("%s: device detaching\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001337 sense = req->sense;
Christoph Hellwig17d53632017-04-20 16:03:01 +02001338 result = req->result;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001339 resid = req->resid_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001341 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sdp,
1342 "sg_cmd_done: pack_id=%d, res=0x%x\n",
1343 srp->header.pack_id, result));
Mike Christied6b10342005-11-08 04:06:41 -06001344 srp->header.resid = resid;
cb59e842005-04-02 13:51:23 -06001345 ms = jiffies_to_msecs(jiffies);
1346 srp->header.duration = (ms > srp->header.duration) ?
1347 (ms - srp->header.duration) : 0;
Mike Christied6b10342005-11-08 04:06:41 -06001348 if (0 != result) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349 struct scsi_sense_hdr sshdr;
1350
Mike Christied6b10342005-11-08 04:06:41 -06001351 srp->header.status = 0xff & result;
1352 srp->header.masked_status = status_byte(result);
1353 srp->header.msg_status = msg_byte(result);
1354 srp->header.host_status = host_byte(result);
1355 srp->header.driver_status = driver_byte(result);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356 if ((sdp->sgdebug > 0) &&
1357 ((CHECK_CONDITION == srp->header.masked_status) ||
1358 (COMMAND_TERMINATED == srp->header.masked_status)))
Hannes Reinecked811b842014-10-24 14:26:45 +02001359 __scsi_print_sense(sdp->device, __func__, sense,
Mike Christied6b10342005-11-08 04:06:41 -06001360 SCSI_SENSE_BUFFERSIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361
1362 /* Following if statement is a patch supplied by Eric Youngdale */
Mike Christied6b10342005-11-08 04:06:41 -06001363 if (driver_byte(result) != 0
1364 && scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, &sshdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365 && !scsi_sense_is_deferred(&sshdr)
1366 && sshdr.sense_key == UNIT_ATTENTION
1367 && sdp->device->removable) {
1368 /* Detected possible disc change. Set the bit - this */
1369 /* may be used if there are filesystems using this device */
1370 sdp->device->changed = 1;
1371 }
1372 }
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001373
1374 if (req->sense_len)
1375 memcpy(srp->sense_b, req->sense, SCSI_SENSE_BUFFERSIZE);
1376
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377 /* Rely on write phase to clean out srp status values, so no "else" */
1378
Tony Battersby75686152015-02-13 12:09:44 -05001379 /*
1380 * Free the request as soon as it is complete so that its resources
1381 * can be reused without waiting for userspace to read() the
1382 * result. But keep the associated bio (if any) around until
1383 * blk_rq_unmap_user() can be called from user context.
1384 */
1385 srp->rq = NULL;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001386 scsi_req_free_cmd(scsi_req(rq));
Tony Battersby75686152015-02-13 12:09:44 -05001387 __blk_put_request(rq->q, rq);
1388
Tony Battersbyc6517b792009-01-21 14:45:50 -05001389 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1390 if (unlikely(srp->orphan)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391 if (sfp->keep_orphan)
1392 srp->sg_io_owned = 0;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001393 else
1394 done = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395 }
Tony Battersbyc6517b792009-01-21 14:45:50 -05001396 srp->done = done;
1397 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1398
1399 if (likely(done)) {
1400 /* Now wake up any sg_read() that is waiting for this
1401 * packet.
1402 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403 wake_up_interruptible(&sfp->read_wait);
Tony Battersbyc6517b792009-01-21 14:45:50 -05001404 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_IN);
FUJITA Tomonoric96952e2009-02-04 11:36:27 +09001405 kref_put(&sfp->f_ref, sg_remove_sfp);
FUJITA Tomonori015640e2009-04-03 19:28:06 +09001406 } else {
1407 INIT_WORK(&srp->ew.work, sg_rq_end_io_usercontext);
1408 schedule_work(&srp->ew.work);
1409 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410}
1411
Alexey Dobriyan828c0952009-10-01 15:43:56 -07001412static const struct file_operations sg_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413 .owner = THIS_MODULE,
1414 .read = sg_read,
1415 .write = sg_write,
1416 .poll = sg_poll,
Jörn Engel37b9d1e2012-04-12 17:35:05 -04001417 .unlocked_ioctl = sg_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418#ifdef CONFIG_COMPAT
1419 .compat_ioctl = sg_compat_ioctl,
1420#endif
1421 .open = sg_open,
1422 .mmap = sg_mmap,
1423 .release = sg_release,
1424 .fasync = sg_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001425 .llseek = no_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426};
1427
gregkh@suse.ded2538782005-03-23 09:55:22 -08001428static struct class *sg_sysfs_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429
1430static int sg_sysfs_valid = 0;
1431
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001432static Sg_device *
1433sg_alloc(struct gendisk *disk, struct scsi_device *scsidp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434{
Mike Christied6b10342005-11-08 04:06:41 -06001435 struct request_queue *q = scsidp->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436 Sg_device *sdp;
1437 unsigned long iflags;
James Bottomley7c07d612007-08-05 13:36:11 -05001438 int error;
1439 u32 k;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440
Jes Sorensen24669f752006-01-16 10:31:18 -05001441 sdp = kzalloc(sizeof(Sg_device), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442 if (!sdp) {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001443 sdev_printk(KERN_WARNING, scsidp, "%s: kmalloc Sg_device "
1444 "failure\n", __func__);
James Bottomley7c07d612007-08-05 13:36:11 -05001445 return ERR_PTR(-ENOMEM);
1446 }
Tony Battersbyc6517b792009-01-21 14:45:50 -05001447
Tejun Heob98c52b2013-02-27 17:04:42 -08001448 idr_preload(GFP_KERNEL);
James Bottomley7c07d612007-08-05 13:36:11 -05001449 write_lock_irqsave(&sg_index_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450
Tejun Heob98c52b2013-02-27 17:04:42 -08001451 error = idr_alloc(&sg_index_idr, sdp, 0, SG_MAX_DEVS, GFP_NOWAIT);
1452 if (error < 0) {
1453 if (error == -ENOSPC) {
1454 sdev_printk(KERN_WARNING, scsidp,
1455 "Unable to attach sg device type=%d, minor number exceeds %d\n",
1456 scsidp->type, SG_MAX_DEVS - 1);
1457 error = -ENODEV;
1458 } else {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001459 sdev_printk(KERN_WARNING, scsidp, "%s: idr "
1460 "allocation Sg_device failure: %d\n",
1461 __func__, error);
Tejun Heob98c52b2013-02-27 17:04:42 -08001462 }
1463 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464 }
Tejun Heob98c52b2013-02-27 17:04:42 -08001465 k = error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001467 SCSI_LOG_TIMEOUT(3, sdev_printk(KERN_INFO, scsidp,
1468 "sg_alloc: dev=%d \n", k));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001469 sprintf(disk->disk_name, "sg%d", k);
1470 disk->first_minor = k;
1471 sdp->disk = disk;
1472 sdp->device = scsidp;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001473 mutex_init(&sdp->open_rel_lock);
FUJITA Tomonori3442f802009-02-16 13:26:53 +09001474 INIT_LIST_HEAD(&sdp->sfds);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001475 init_waitqueue_head(&sdp->open_wait);
1476 atomic_set(&sdp->detaching, 0);
1477 rwlock_init(&sdp->sfd_lock);
Martin K. Petersen8a783622010-02-26 00:20:39 -05001478 sdp->sg_tablesize = queue_max_segments(q);
James Bottomley7c07d612007-08-05 13:36:11 -05001479 sdp->index = k;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001480 kref_init(&sdp->d_ref);
James Bottomley7c07d612007-08-05 13:36:11 -05001481 error = 0;
Tejun Heob98c52b2013-02-27 17:04:42 -08001482
1483out_unlock:
1484 write_unlock_irqrestore(&sg_index_lock, iflags);
1485 idr_preload_end();
1486
James Bottomley7c07d612007-08-05 13:36:11 -05001487 if (error) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488 kfree(sdp);
James Bottomley7c07d612007-08-05 13:36:11 -05001489 return ERR_PTR(error);
1490 }
1491 return sdp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001492}
1493
1494static int
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001495sg_add_device(struct device *cl_dev, struct class_interface *cl_intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496{
Tony Jonesee959b02008-02-22 00:13:36 +01001497 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001498 struct gendisk *disk;
1499 Sg_device *sdp = NULL;
1500 struct cdev * cdev = NULL;
James Bottomley7c07d612007-08-05 13:36:11 -05001501 int error;
Ishai Rabinovitz454e8952006-06-29 16:39:54 +03001502 unsigned long iflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503
1504 disk = alloc_disk(1);
1505 if (!disk) {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001506 pr_warn("%s: alloc_disk failed\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507 return -ENOMEM;
1508 }
1509 disk->major = SCSI_GENERIC_MAJOR;
1510
1511 error = -ENOMEM;
1512 cdev = cdev_alloc();
1513 if (!cdev) {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001514 pr_warn("%s: cdev_alloc failed\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515 goto out;
1516 }
1517 cdev->owner = THIS_MODULE;
1518 cdev->ops = &sg_fops;
1519
James Bottomley7c07d612007-08-05 13:36:11 -05001520 sdp = sg_alloc(disk, scsidp);
1521 if (IS_ERR(sdp)) {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001522 pr_warn("%s: sg_alloc failed\n", __func__);
James Bottomley7c07d612007-08-05 13:36:11 -05001523 error = PTR_ERR(sdp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524 goto out;
1525 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526
James Bottomley7c07d612007-08-05 13:36:11 -05001527 error = cdev_add(cdev, MKDEV(SCSI_GENERIC_MAJOR, sdp->index), 1);
Greg KH5e3c34c2006-01-18 16:17:46 -08001528 if (error)
Ishai Rabinovitz454e8952006-06-29 16:39:54 +03001529 goto cdev_add_err;
Greg KH5e3c34c2006-01-18 16:17:46 -08001530
Linus Torvalds1da177e2005-04-16 15:20:36 -07001531 sdp->cdev = cdev;
1532 if (sg_sysfs_valid) {
Tony Jonesee959b02008-02-22 00:13:36 +01001533 struct device *sg_class_member;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534
Greg Kroah-Hartmand73a1a672008-07-21 20:03:34 -07001535 sg_class_member = device_create(sg_sysfs_class, cl_dev->parent,
1536 MKDEV(SCSI_GENERIC_MAJOR,
1537 sdp->index),
1538 sdp, "%s", disk->disk_name);
FUJITA Tomonorid07e0362008-01-15 13:18:00 +09001539 if (IS_ERR(sg_class_member)) {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001540 pr_err("%s: device_create failed\n", __func__);
FUJITA Tomonorid07e0362008-01-15 13:18:00 +09001541 error = PTR_ERR(sg_class_member);
1542 goto cdev_add_err;
1543 }
FUJITA Tomonorid07e0362008-01-15 13:18:00 +09001544 error = sysfs_create_link(&scsidp->sdev_gendev.kobj,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545 &sg_class_member->kobj, "generic");
1546 if (error)
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001547 pr_err("%s: unable to make symlink 'generic' back "
1548 "to sg%d\n", __func__, sdp->index);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549 } else
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001550 pr_warn("%s: sg_sys Invalid\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001552 sdev_printk(KERN_NOTICE, scsidp, "Attached scsi generic sg%d "
1553 "type %d\n", sdp->index, scsidp->type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001554
Tony Jonesee959b02008-02-22 00:13:36 +01001555 dev_set_drvdata(cl_dev, sdp);
FUJITA Tomonoria24484f2008-01-15 13:17:47 +09001556
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557 return 0;
1558
Ishai Rabinovitz454e8952006-06-29 16:39:54 +03001559cdev_add_err:
James Bottomley7c07d612007-08-05 13:36:11 -05001560 write_lock_irqsave(&sg_index_lock, iflags);
1561 idr_remove(&sg_index_idr, sdp->index);
1562 write_unlock_irqrestore(&sg_index_lock, iflags);
1563 kfree(sdp);
Ishai Rabinovitz454e8952006-06-29 16:39:54 +03001564
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565out:
1566 put_disk(disk);
1567 if (cdev)
1568 cdev_del(cdev);
1569 return error;
1570}
1571
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001572static void
1573sg_device_destroy(struct kref *kref)
Tony Battersbyc6517b792009-01-21 14:45:50 -05001574{
1575 struct sg_device *sdp = container_of(kref, struct sg_device, d_ref);
1576 unsigned long flags;
1577
1578 /* CAUTION! Note that the device can still be found via idr_find()
1579 * even though the refcount is 0. Therefore, do idr_remove() BEFORE
1580 * any other cleanup.
1581 */
1582
1583 write_lock_irqsave(&sg_index_lock, flags);
1584 idr_remove(&sg_index_idr, sdp->index);
1585 write_unlock_irqrestore(&sg_index_lock, flags);
1586
1587 SCSI_LOG_TIMEOUT(3,
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001588 sg_printk(KERN_INFO, sdp, "sg_device_destroy\n"));
Tony Battersbyc6517b792009-01-21 14:45:50 -05001589
1590 put_disk(sdp->disk);
1591 kfree(sdp);
1592}
1593
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001594static void
1595sg_remove_device(struct device *cl_dev, struct class_interface *cl_intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001596{
Tony Jonesee959b02008-02-22 00:13:36 +01001597 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
1598 Sg_device *sdp = dev_get_drvdata(cl_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599 unsigned long iflags;
1600 Sg_fd *sfp;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001601 int val;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001602
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001603 if (!sdp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604 return;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001605 /* want sdp->detaching non-zero as soon as possible */
1606 val = atomic_inc_return(&sdp->detaching);
1607 if (val > 1)
1608 return; /* only want to do following once per device */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001610 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
1611 "%s\n", __func__));
Tony Battersbyc6517b792009-01-21 14:45:50 -05001612
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001613 read_lock_irqsave(&sdp->sfd_lock, iflags);
FUJITA Tomonori3442f802009-02-16 13:26:53 +09001614 list_for_each_entry(sfp, &sdp->sfds, sfd_siblings) {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001615 wake_up_interruptible_all(&sfp->read_wait);
Tony Battersbyc6517b792009-01-21 14:45:50 -05001616 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_HUP);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617 }
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001618 wake_up_interruptible_all(&sdp->open_wait);
1619 read_unlock_irqrestore(&sdp->sfd_lock, iflags);
James Bottomley7c07d612007-08-05 13:36:11 -05001620
1621 sysfs_remove_link(&scsidp->sdev_gendev.kobj, "generic");
Tony Jonesee959b02008-02-22 00:13:36 +01001622 device_destroy(sg_sysfs_class, MKDEV(SCSI_GENERIC_MAJOR, sdp->index));
James Bottomley7c07d612007-08-05 13:36:11 -05001623 cdev_del(sdp->cdev);
1624 sdp->cdev = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001626 kref_put(&sdp->d_ref, sg_device_destroy);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001627}
1628
Douglas Gilbert6460e752006-09-20 18:20:49 -04001629module_param_named(scatter_elem_sz, scatter_elem_sz, int, S_IRUGO | S_IWUSR);
1630module_param_named(def_reserved_size, def_reserved_size, int,
1631 S_IRUGO | S_IWUSR);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001632module_param_named(allow_dio, sg_allow_dio, int, S_IRUGO | S_IWUSR);
1633
1634MODULE_AUTHOR("Douglas Gilbert");
1635MODULE_DESCRIPTION("SCSI generic (sg) driver");
1636MODULE_LICENSE("GPL");
1637MODULE_VERSION(SG_VERSION_STR);
Rene Hermanf018fa52006-03-08 00:14:20 -08001638MODULE_ALIAS_CHARDEV_MAJOR(SCSI_GENERIC_MAJOR);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001639
Douglas Gilbert6460e752006-09-20 18:20:49 -04001640MODULE_PARM_DESC(scatter_elem_sz, "scatter gather element "
1641 "size (default: max(SG_SCATTER_SZ, PAGE_SIZE))");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001642MODULE_PARM_DESC(def_reserved_size, "size of buffer reserved for each fd");
1643MODULE_PARM_DESC(allow_dio, "allow direct I/O (default: 0 (disallow))");
1644
1645static int __init
1646init_sg(void)
1647{
1648 int rc;
1649
Douglas Gilbert6460e752006-09-20 18:20:49 -04001650 if (scatter_elem_sz < PAGE_SIZE) {
1651 scatter_elem_sz = PAGE_SIZE;
1652 scatter_elem_sz_prev = scatter_elem_sz;
1653 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654 if (def_reserved_size >= 0)
1655 sg_big_buff = def_reserved_size;
Douglas Gilbert6460e752006-09-20 18:20:49 -04001656 else
1657 def_reserved_size = sg_big_buff;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658
1659 rc = register_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1660 SG_MAX_DEVS, "sg");
1661 if (rc)
1662 return rc;
gregkh@suse.ded2538782005-03-23 09:55:22 -08001663 sg_sysfs_class = class_create(THIS_MODULE, "scsi_generic");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001664 if ( IS_ERR(sg_sysfs_class) ) {
1665 rc = PTR_ERR(sg_sysfs_class);
1666 goto err_out;
1667 }
1668 sg_sysfs_valid = 1;
1669 rc = scsi_register_interface(&sg_interface);
1670 if (0 == rc) {
1671#ifdef CONFIG_SCSI_PROC_FS
1672 sg_proc_init();
1673#endif /* CONFIG_SCSI_PROC_FS */
1674 return 0;
1675 }
gregkh@suse.ded2538782005-03-23 09:55:22 -08001676 class_destroy(sg_sysfs_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677err_out:
1678 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0), SG_MAX_DEVS);
1679 return rc;
1680}
1681
1682static void __exit
1683exit_sg(void)
1684{
1685#ifdef CONFIG_SCSI_PROC_FS
1686 sg_proc_cleanup();
1687#endif /* CONFIG_SCSI_PROC_FS */
1688 scsi_unregister_interface(&sg_interface);
gregkh@suse.ded2538782005-03-23 09:55:22 -08001689 class_destroy(sg_sysfs_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001690 sg_sysfs_valid = 0;
1691 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1692 SG_MAX_DEVS);
James Bottomley7c07d612007-08-05 13:36:11 -05001693 idr_destroy(&sg_index_idr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001694}
1695
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001696static int
1697sg_start_req(Sg_request *srp, unsigned char *cmd)
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001698{
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001699 int res;
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001700 struct request *rq;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001701 struct scsi_request *req;
FUJITA Tomonori44c7b0e2008-09-02 22:50:04 +09001702 Sg_fd *sfp = srp->parentfp;
1703 sg_io_hdr_t *hp = &srp->header;
1704 int dxfer_len = (int) hp->dxfer_len;
1705 int dxfer_dir = hp->dxfer_direction;
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001706 unsigned int iov_count = hp->iovec_count;
FUJITA Tomonori44c7b0e2008-09-02 22:50:04 +09001707 Sg_scatter_hold *req_schp = &srp->data;
1708 Sg_scatter_hold *rsv_schp = &sfp->reserve;
1709 struct request_queue *q = sfp->parentdp->device->request_queue;
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001710 struct rq_map_data *md, map_data;
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001711 int rw = hp->dxfer_direction == SG_DXFER_TO_DEV ? WRITE : READ;
Douglas Gilbert65c26a02014-06-03 13:18:18 -04001712 unsigned char *long_cmdp = NULL;
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001713
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001714 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1715 "sg_start_req: dxfer_len=%d\n",
1716 dxfer_len));
FUJITA Tomonori44c7b0e2008-09-02 22:50:04 +09001717
Douglas Gilbert65c26a02014-06-03 13:18:18 -04001718 if (hp->cmd_len > BLK_MAX_CDB) {
1719 long_cmdp = kzalloc(hp->cmd_len, GFP_KERNEL);
1720 if (!long_cmdp)
1721 return -ENOMEM;
1722 }
1723
Tony Battersby77728552015-02-13 12:10:58 -05001724 /*
1725 * NOTE
1726 *
1727 * With scsi-mq enabled, there are a fixed number of preallocated
1728 * requests equal in number to shost->can_queue. If all of the
1729 * preallocated requests are already in use, then using GFP_ATOMIC with
1730 * blk_get_request() will return -EWOULDBLOCK, whereas using GFP_KERNEL
1731 * will cause blk_get_request() to sleep until an active command
1732 * completes, freeing up a request. Neither option is ideal, but
1733 * GFP_KERNEL is the better choice to prevent userspace from getting an
1734 * unexpected EWOULDBLOCK.
1735 *
1736 * With scsi-mq disabled, blk_get_request() with GFP_KERNEL usually
1737 * does not sleep except under memory pressure.
1738 */
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001739 rq = blk_get_request(q, hp->dxfer_direction == SG_DXFER_TO_DEV ?
1740 REQ_OP_SCSI_OUT : REQ_OP_SCSI_IN, GFP_KERNEL);
Joe Lawrencea492f072014-08-28 08:15:21 -06001741 if (IS_ERR(rq)) {
Douglas Gilbert65c26a02014-06-03 13:18:18 -04001742 kfree(long_cmdp);
Joe Lawrencea492f072014-08-28 08:15:21 -06001743 return PTR_ERR(rq);
Douglas Gilbert65c26a02014-06-03 13:18:18 -04001744 }
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001745 req = scsi_req(rq);
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001746
Douglas Gilbert65c26a02014-06-03 13:18:18 -04001747 if (hp->cmd_len > BLK_MAX_CDB)
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001748 req->cmd = long_cmdp;
1749 memcpy(req->cmd, cmd, hp->cmd_len);
1750 req->cmd_len = hp->cmd_len;
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001751
1752 srp->rq = rq;
1753 rq->end_io_data = srp;
Christoph Hellwig64c7f1d2017-04-05 19:18:12 +02001754 req->retries = SG_DEFAULT_RETRIES;
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001755
Linus Torvalds1da177e2005-04-16 15:20:36 -07001756 if ((dxfer_len <= 0) || (dxfer_dir == SG_DXFER_NONE))
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001757 return 0;
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001758
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001759 if (sg_allow_dio && hp->flags & SG_FLAG_DIRECT_IO &&
1760 dxfer_dir != SG_DXFER_UNKNOWN && !iov_count &&
1761 !sfp->parentdp->device->host->unchecked_isa_dma &&
Namhyung Kim2610a252010-09-16 12:55:57 +09001762 blk_rq_aligned(q, (unsigned long)hp->dxferp, dxfer_len))
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001763 md = NULL;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001764 else
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001765 md = &map_data;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001766
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001767 if (md) {
Hannes Reinecke1bc0eb02017-04-07 09:34:14 +02001768 mutex_lock(&sfp->f_mutex);
1769 if (dxfer_len <= rsv_schp->bufflen &&
1770 !sfp->res_in_use) {
1771 sfp->res_in_use = 1;
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001772 sg_link_reserve(sfp, srp, dxfer_len);
Todd Poynor8d26f492017-08-15 21:48:43 -07001773 } else if (hp->flags & SG_FLAG_MMAP_IO) {
1774 res = -EBUSY; /* sfp->res_in_use == 1 */
1775 if (dxfer_len > rsv_schp->bufflen)
1776 res = -ENOMEM;
Hannes Reinecke1bc0eb02017-04-07 09:34:14 +02001777 mutex_unlock(&sfp->f_mutex);
Todd Poynor8d26f492017-08-15 21:48:43 -07001778 return res;
Hannes Reinecke1bc0eb02017-04-07 09:34:14 +02001779 } else {
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001780 res = sg_build_indirect(req_schp, sfp, dxfer_len);
Hannes Reinecke1bc0eb02017-04-07 09:34:14 +02001781 if (res) {
1782 mutex_unlock(&sfp->f_mutex);
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001783 return res;
Hannes Reinecke1bc0eb02017-04-07 09:34:14 +02001784 }
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001785 }
Hannes Reinecke1bc0eb02017-04-07 09:34:14 +02001786 mutex_unlock(&sfp->f_mutex);
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001787
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001788 md->pages = req_schp->pages;
1789 md->page_order = req_schp->page_order;
1790 md->nr_entries = req_schp->k_use_sg;
FUJITA Tomonori56c451f2008-12-18 14:49:37 +09001791 md->offset = 0;
FUJITA Tomonori97ae77a2008-12-18 14:49:38 +09001792 md->null_mapped = hp->dxferp ? 0 : 1;
FUJITA Tomonoriecb554a2009-07-09 14:46:53 +02001793 if (dxfer_dir == SG_DXFER_TO_FROM_DEV)
1794 md->from_user = 1;
1795 else
1796 md->from_user = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797 }
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001798
FUJITA Tomonori0fdf96b2009-04-03 09:12:20 +09001799 if (iov_count) {
Al Virofdc81f42015-03-21 20:25:30 -04001800 struct iovec *iov = NULL;
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001801 struct iov_iter i;
FUJITA Tomonori0fdf96b2009-04-03 09:12:20 +09001802
Al Virofdc81f42015-03-21 20:25:30 -04001803 res = import_iovec(rw, hp->dxferp, iov_count, 0, &iov, &i);
1804 if (res < 0)
1805 return res;
FUJITA Tomonori0fdf96b2009-04-03 09:12:20 +09001806
Al Virofdc81f42015-03-21 20:25:30 -04001807 iov_iter_truncate(&i, hp->dxfer_len);
Al Viro137d01d2017-02-19 07:15:27 +00001808 if (!iov_iter_count(&i)) {
1809 kfree(iov);
1810 return -EINVAL;
1811 }
FUJITA Tomonori0fdf96b2009-04-03 09:12:20 +09001812
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001813 res = blk_rq_map_user_iov(q, rq, md, &i, GFP_ATOMIC);
FUJITA Tomonori0fdf96b2009-04-03 09:12:20 +09001814 kfree(iov);
1815 } else
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001816 res = blk_rq_map_user(q, rq, md, hp->dxferp,
1817 hp->dxfer_len, GFP_ATOMIC);
1818
1819 if (!res) {
1820 srp->bio = rq->bio;
1821
1822 if (!md) {
1823 req_schp->dio_in_use = 1;
1824 hp->info |= SG_INFO_DIRECT_IO;
1825 }
1826 }
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001827 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828}
1829
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001830static int
1831sg_finish_rem_req(Sg_request *srp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001832{
FUJITA Tomonorie7ee4cc2009-04-04 00:35:42 +09001833 int ret = 0;
1834
Linus Torvalds1da177e2005-04-16 15:20:36 -07001835 Sg_fd *sfp = srp->parentfp;
1836 Sg_scatter_hold *req_schp = &srp->data;
1837
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001838 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1839 "sg_finish_rem_req: res_used=%d\n",
1840 (int) srp->res_used));
Tony Battersby75686152015-02-13 12:09:44 -05001841 if (srp->bio)
1842 ret = blk_rq_unmap_user(srp->bio);
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001843
Tony Battersby75686152015-02-13 12:09:44 -05001844 if (srp->rq) {
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001845 scsi_req_free_cmd(scsi_req(srp->rq));
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001846 blk_put_request(srp->rq);
FUJITA Tomonori6e5a30c2008-08-28 16:17:08 +09001847 }
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001848
Christof Schmitte27168f2009-09-17 09:10:14 +02001849 if (srp->res_used)
1850 sg_unlink_reserve(sfp, srp);
1851 else
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001852 sg_remove_scat(sfp, req_schp);
Christof Schmitte27168f2009-09-17 09:10:14 +02001853
FUJITA Tomonorie7ee4cc2009-04-04 00:35:42 +09001854 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001855}
1856
1857static int
1858sg_build_sgat(Sg_scatter_hold * schp, const Sg_fd * sfp, int tablesize)
1859{
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001860 int sg_bufflen = tablesize * sizeof(struct page *);
Al Viro2d20eaf2006-02-01 06:31:40 -05001861 gfp_t gfp_flags = GFP_ATOMIC | __GFP_NOWARN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001862
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001863 schp->pages = kzalloc(sg_bufflen, gfp_flags);
1864 if (!schp->pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001865 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001866 schp->sglist_len = sg_bufflen;
Mike Christied6b10342005-11-08 04:06:41 -06001867 return tablesize; /* number of scat_gath elements allocated */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868}
1869
Linus Torvalds1da177e2005-04-16 15:20:36 -07001870static int
1871sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size)
1872{
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001873 int ret_sz = 0, i, k, rem_sz, num, mx_sc_elems;
Mike Christied6b10342005-11-08 04:06:41 -06001874 int sg_tablesize = sfp->parentdp->sg_tablesize;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001875 int blk_size = buff_size, order;
1876 gfp_t gfp_mask = GFP_ATOMIC | __GFP_COMP | __GFP_NOWARN;
Hannes Reinecke745dfa02017-04-07 09:34:12 +02001877 struct sg_device *sdp = sfp->parentdp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001878
Eric Sesterhennfb119932007-05-23 14:41:36 -07001879 if (blk_size < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001880 return -EFAULT;
1881 if (0 == blk_size)
1882 ++blk_size; /* don't know why */
FUJITA Tomonorib2ed6c62009-02-12 02:42:57 +09001883 /* round request up to next highest SG_SECTOR_SZ byte boundary */
1884 blk_size = ALIGN(blk_size, SG_SECTOR_SZ);
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001885 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1886 "sg_build_indirect: buff_size=%d, blk_size=%d\n",
1887 buff_size, blk_size));
Mike Christied6b10342005-11-08 04:06:41 -06001888
1889 /* N.B. ret_sz carried into this block ... */
1890 mx_sc_elems = sg_build_sgat(schp, sfp, sg_tablesize);
1891 if (mx_sc_elems < 0)
1892 return mx_sc_elems; /* most likely -ENOMEM */
1893
Douglas Gilbert6460e752006-09-20 18:20:49 -04001894 num = scatter_elem_sz;
1895 if (unlikely(num != scatter_elem_sz_prev)) {
1896 if (num < PAGE_SIZE) {
1897 scatter_elem_sz = PAGE_SIZE;
1898 scatter_elem_sz_prev = PAGE_SIZE;
1899 } else
1900 scatter_elem_sz_prev = num;
1901 }
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001902
Hannes Reinecke745dfa02017-04-07 09:34:12 +02001903 if (sdp->device->host->unchecked_isa_dma)
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001904 gfp_mask |= GFP_DMA;
1905
1906 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
1907 gfp_mask |= __GFP_ZERO;
1908
1909 order = get_order(num);
1910retry:
1911 ret_sz = 1 << (PAGE_SHIFT + order);
1912
1913 for (k = 0, rem_sz = blk_size; rem_sz > 0 && k < mx_sc_elems;
1914 k++, rem_sz -= ret_sz) {
1915
Douglas Gilbert6460e752006-09-20 18:20:49 -04001916 num = (rem_sz > scatter_elem_sz_prev) ?
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001917 scatter_elem_sz_prev : rem_sz;
1918
1919 schp->pages[k] = alloc_pages(gfp_mask, order);
1920 if (!schp->pages[k])
1921 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001922
Douglas Gilbert6460e752006-09-20 18:20:49 -04001923 if (num == scatter_elem_sz_prev) {
1924 if (unlikely(ret_sz > scatter_elem_sz_prev)) {
1925 scatter_elem_sz = ret_sz;
1926 scatter_elem_sz_prev = ret_sz;
1927 }
1928 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001930 SCSI_LOG_TIMEOUT(5, sg_printk(KERN_INFO, sfp->parentdp,
1931 "sg_build_indirect: k=%d, num=%d, ret_sz=%d\n",
1932 k, num, ret_sz));
Mike Christied6b10342005-11-08 04:06:41 -06001933 } /* end of for loop */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001934
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001935 schp->page_order = order;
Mike Christied6b10342005-11-08 04:06:41 -06001936 schp->k_use_sg = k;
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001937 SCSI_LOG_TIMEOUT(5, sg_printk(KERN_INFO, sfp->parentdp,
1938 "sg_build_indirect: k_use_sg=%d, rem_sz=%d\n",
1939 k, rem_sz));
Mike Christied6b10342005-11-08 04:06:41 -06001940
1941 schp->bufflen = blk_size;
1942 if (rem_sz > 0) /* must have failed */
1943 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001944 return 0;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001945out:
1946 for (i = 0; i < k; i++)
Michal Schmidte71044e2009-09-03 14:27:08 +02001947 __free_pages(schp->pages[i], order);
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001948
1949 if (--order >= 0)
1950 goto retry;
1951
1952 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953}
1954
Linus Torvalds1da177e2005-04-16 15:20:36 -07001955static void
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001956sg_remove_scat(Sg_fd * sfp, Sg_scatter_hold * schp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001957{
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001958 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1959 "sg_remove_scat: k_use_sg=%d\n", schp->k_use_sg));
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001960 if (schp->pages && schp->sglist_len > 0) {
FUJITA Tomonori6e5a30c2008-08-28 16:17:08 +09001961 if (!schp->dio_in_use) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001962 int k;
1963
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001964 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001965 SCSI_LOG_TIMEOUT(5,
1966 sg_printk(KERN_INFO, sfp->parentdp,
1967 "sg_remove_scat: k=%d, pg=0x%p\n",
1968 k, schp->pages[k]));
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001969 __free_pages(schp->pages[k], schp->page_order);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001970 }
FUJITA Tomonori6e5a30c2008-08-28 16:17:08 +09001971
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001972 kfree(schp->pages);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973 }
Mike Christied6b10342005-11-08 04:06:41 -06001974 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001975 memset(schp, 0, sizeof (*schp));
1976}
1977
1978static int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001979sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer)
1980{
1981 Sg_scatter_hold *schp = &srp->data;
Mike Christied6b10342005-11-08 04:06:41 -06001982 int k, num;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001983
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001984 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, srp->parentfp->parentdp,
1985 "sg_read_oxfer: num_read_xfer=%d\n",
1986 num_read_xfer));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001987 if ((!outp) || (num_read_xfer <= 0))
1988 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001989
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001990 num = 1 << (PAGE_SHIFT + schp->page_order);
1991 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
Mike Christied6b10342005-11-08 04:06:41 -06001992 if (num > num_read_xfer) {
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001993 if (__copy_to_user(outp, page_address(schp->pages[k]),
Mike Christied6b10342005-11-08 04:06:41 -06001994 num_read_xfer))
1995 return -EFAULT;
1996 break;
1997 } else {
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001998 if (__copy_to_user(outp, page_address(schp->pages[k]),
Mike Christied6b10342005-11-08 04:06:41 -06001999 num))
2000 return -EFAULT;
2001 num_read_xfer -= num;
2002 if (num_read_xfer <= 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002003 break;
Mike Christied6b10342005-11-08 04:06:41 -06002004 outp += num;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002005 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002006 }
Mike Christied6b10342005-11-08 04:06:41 -06002007
Linus Torvalds1da177e2005-04-16 15:20:36 -07002008 return 0;
2009}
2010
2011static void
2012sg_build_reserve(Sg_fd * sfp, int req_size)
2013{
2014 Sg_scatter_hold *schp = &sfp->reserve;
2015
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002016 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
2017 "sg_build_reserve: req_size=%d\n", req_size));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018 do {
2019 if (req_size < PAGE_SIZE)
2020 req_size = PAGE_SIZE;
2021 if (0 == sg_build_indirect(schp, sfp, req_size))
2022 return;
2023 else
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002024 sg_remove_scat(sfp, schp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002025 req_size >>= 1; /* divide by 2 */
2026 } while (req_size > (PAGE_SIZE / 2));
2027}
2028
2029static void
2030sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size)
2031{
2032 Sg_scatter_hold *req_schp = &srp->data;
2033 Sg_scatter_hold *rsv_schp = &sfp->reserve;
Mike Christied6b10342005-11-08 04:06:41 -06002034 int k, num, rem;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002035
2036 srp->res_used = 1;
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002037 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
2038 "sg_link_reserve: size=%d\n", size));
Brian Kingeca7be52006-02-14 12:42:24 -06002039 rem = size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002040
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02002041 num = 1 << (PAGE_SHIFT + rsv_schp->page_order);
2042 for (k = 0; k < rsv_schp->k_use_sg; k++) {
Mike Christied6b10342005-11-08 04:06:41 -06002043 if (rem <= num) {
Mike Christied6b10342005-11-08 04:06:41 -06002044 req_schp->k_use_sg = k + 1;
2045 req_schp->sglist_len = rsv_schp->sglist_len;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02002046 req_schp->pages = rsv_schp->pages;
Mike Christied6b10342005-11-08 04:06:41 -06002047
2048 req_schp->bufflen = size;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02002049 req_schp->page_order = rsv_schp->page_order;
Mike Christied6b10342005-11-08 04:06:41 -06002050 break;
2051 } else
2052 rem -= num;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002053 }
Mike Christied6b10342005-11-08 04:06:41 -06002054
2055 if (k >= rsv_schp->k_use_sg)
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002056 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO, sfp->parentdp,
2057 "sg_link_reserve: BAD size\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058}
2059
2060static void
2061sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp)
2062{
2063 Sg_scatter_hold *req_schp = &srp->data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002064
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002065 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, srp->parentfp->parentdp,
2066 "sg_unlink_reserve: req->k_use_sg=%d\n",
2067 (int) req_schp->k_use_sg));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002068 req_schp->k_use_sg = 0;
2069 req_schp->bufflen = 0;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02002070 req_schp->pages = NULL;
2071 req_schp->page_order = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002072 req_schp->sglist_len = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073 srp->res_used = 0;
Hannes Reineckee791ce22017-04-24 10:26:36 +02002074 /* Called without mutex lock to avoid deadlock */
2075 sfp->res_in_use = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002076}
2077
2078static Sg_request *
2079sg_get_rq_mark(Sg_fd * sfp, int pack_id)
2080{
2081 Sg_request *resp;
2082 unsigned long iflags;
2083
2084 write_lock_irqsave(&sfp->rq_list_lock, iflags);
Hannes Reinecke109bade2017-04-07 09:34:16 +02002085 list_for_each_entry(resp, &sfp->rq_list, entry) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086 /* look for requests that are ready + not SG_IO owned */
2087 if ((1 == resp->done) && (!resp->sg_io_owned) &&
2088 ((-1 == pack_id) || (resp->header.pack_id == pack_id))) {
2089 resp->done = 2; /* guard against other readers */
Johannes Thumshirn48ae8482017-05-10 09:53:40 +02002090 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2091 return resp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002092 }
2093 }
2094 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
Johannes Thumshirn48ae8482017-05-10 09:53:40 +02002095 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002096}
2097
Linus Torvalds1da177e2005-04-16 15:20:36 -07002098/* always adds to end of list */
2099static Sg_request *
2100sg_add_request(Sg_fd * sfp)
2101{
2102 int k;
2103 unsigned long iflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002104 Sg_request *rp = sfp->req_arr;
2105
2106 write_lock_irqsave(&sfp->rq_list_lock, iflags);
Hannes Reinecke109bade2017-04-07 09:34:16 +02002107 if (!list_empty(&sfp->rq_list)) {
2108 if (!sfp->cmd_q)
2109 goto out_unlock;
2110
2111 for (k = 0; k < SG_MAX_QUEUE; ++k, ++rp) {
2112 if (!rp->parentfp)
2113 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002114 }
Hannes Reinecke109bade2017-04-07 09:34:16 +02002115 if (k >= SG_MAX_QUEUE)
2116 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002117 }
Hannes Reinecke109bade2017-04-07 09:34:16 +02002118 memset(rp, 0, sizeof (Sg_request));
2119 rp->parentfp = sfp;
2120 rp->header.duration = jiffies_to_msecs(jiffies);
2121 list_add_tail(&rp->entry, &sfp->rq_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002122 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
Hannes Reinecke109bade2017-04-07 09:34:16 +02002123 return rp;
2124out_unlock:
2125 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2126 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002127}
2128
2129/* Return of 1 for found; 0 for not found */
2130static int
2131sg_remove_request(Sg_fd * sfp, Sg_request * srp)
2132{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002133 unsigned long iflags;
2134 int res = 0;
2135
Hannes Reinecke109bade2017-04-07 09:34:16 +02002136 if (!sfp || !srp || list_empty(&sfp->rq_list))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137 return res;
2138 write_lock_irqsave(&sfp->rq_list_lock, iflags);
Hannes Reinecke109bade2017-04-07 09:34:16 +02002139 if (!list_empty(&srp->entry)) {
2140 list_del(&srp->entry);
2141 srp->parentfp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002142 res = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143 }
2144 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2145 return res;
2146}
2147
Linus Torvalds1da177e2005-04-16 15:20:36 -07002148static Sg_fd *
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002149sg_add_sfp(Sg_device * sdp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150{
2151 Sg_fd *sfp;
2152 unsigned long iflags;
Alan Stern44ec9542007-02-20 11:01:57 -05002153 int bufflen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154
Mike Christied6b10342005-11-08 04:06:41 -06002155 sfp = kzalloc(sizeof(*sfp), GFP_ATOMIC | __GFP_NOWARN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002156 if (!sfp)
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002157 return ERR_PTR(-ENOMEM);
Mike Christied6b10342005-11-08 04:06:41 -06002158
Linus Torvalds1da177e2005-04-16 15:20:36 -07002159 init_waitqueue_head(&sfp->read_wait);
2160 rwlock_init(&sfp->rq_list_lock);
Hannes Reinecke109bade2017-04-07 09:34:16 +02002161 INIT_LIST_HEAD(&sfp->rq_list);
Tony Battersbyc6517b792009-01-21 14:45:50 -05002162 kref_init(&sfp->f_ref);
Hannes Reinecke1bc0eb02017-04-07 09:34:14 +02002163 mutex_init(&sfp->f_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002164 sfp->timeout = SG_DEFAULT_TIMEOUT;
2165 sfp->timeout_user = SG_DEFAULT_TIMEOUT_USER;
2166 sfp->force_packid = SG_DEF_FORCE_PACK_ID;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002167 sfp->cmd_q = SG_DEF_COMMAND_Q;
2168 sfp->keep_orphan = SG_DEF_KEEP_ORPHAN;
2169 sfp->parentdp = sdp;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002170 write_lock_irqsave(&sdp->sfd_lock, iflags);
2171 if (atomic_read(&sdp->detaching)) {
2172 write_unlock_irqrestore(&sdp->sfd_lock, iflags);
2173 return ERR_PTR(-ENODEV);
2174 }
FUJITA Tomonori3442f802009-02-16 13:26:53 +09002175 list_add_tail(&sfp->sfd_siblings, &sdp->sfds);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002176 write_unlock_irqrestore(&sdp->sfd_lock, iflags);
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002177 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
2178 "sg_add_sfp: sfp=0x%p\n", sfp));
Douglas Gilbert6460e752006-09-20 18:20:49 -04002179 if (unlikely(sg_big_buff != def_reserved_size))
2180 sg_big_buff = def_reserved_size;
2181
Alan Stern44ec9542007-02-20 11:01:57 -05002182 bufflen = min_t(int, sg_big_buff,
Akinobu Mita46f69e62014-06-02 22:56:46 +09002183 max_sectors_bytes(sdp->device->request_queue));
Alan Stern44ec9542007-02-20 11:01:57 -05002184 sg_build_reserve(sfp, bufflen);
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002185 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
2186 "sg_add_sfp: bufflen=%d, k_use_sg=%d\n",
2187 sfp->reserve.bufflen,
2188 sfp->reserve.k_use_sg));
Tony Battersbyc6517b792009-01-21 14:45:50 -05002189
2190 kref_get(&sdp->d_ref);
2191 __module_get(THIS_MODULE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002192 return sfp;
2193}
2194
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002195static void
2196sg_remove_sfp_usercontext(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002197{
Tony Battersbyc6517b792009-01-21 14:45:50 -05002198 struct sg_fd *sfp = container_of(work, struct sg_fd, ew.work);
2199 struct sg_device *sdp = sfp->parentdp;
Hannes Reinecke109bade2017-04-07 09:34:16 +02002200 Sg_request *srp;
Hannes Reinecke97d27b0dd2017-04-07 09:34:17 +02002201 unsigned long iflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002202
Tony Battersbyc6517b792009-01-21 14:45:50 -05002203 /* Cleanup any responses which were never read(). */
Hannes Reinecke97d27b0dd2017-04-07 09:34:17 +02002204 write_lock_irqsave(&sfp->rq_list_lock, iflags);
Hannes Reinecke109bade2017-04-07 09:34:16 +02002205 while (!list_empty(&sfp->rq_list)) {
2206 srp = list_first_entry(&sfp->rq_list, Sg_request, entry);
2207 sg_finish_rem_req(srp);
Hannes Reinecke97d27b0dd2017-04-07 09:34:17 +02002208 list_del(&srp->entry);
2209 srp->parentfp = NULL;
Hannes Reinecke109bade2017-04-07 09:34:16 +02002210 }
Hannes Reinecke97d27b0dd2017-04-07 09:34:17 +02002211 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
Tony Battersbyc6517b792009-01-21 14:45:50 -05002212
Linus Torvalds1da177e2005-04-16 15:20:36 -07002213 if (sfp->reserve.bufflen > 0) {
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002214 SCSI_LOG_TIMEOUT(6, sg_printk(KERN_INFO, sdp,
2215 "sg_remove_sfp: bufflen=%d, k_use_sg=%d\n",
Tony Battersbyc6517b792009-01-21 14:45:50 -05002216 (int) sfp->reserve.bufflen,
2217 (int) sfp->reserve.k_use_sg));
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002218 sg_remove_scat(sfp, &sfp->reserve);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002219 }
Tony Battersbyc6517b792009-01-21 14:45:50 -05002220
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002221 SCSI_LOG_TIMEOUT(6, sg_printk(KERN_INFO, sdp,
2222 "sg_remove_sfp: sfp=0x%p\n", sfp));
Mike Christied6b10342005-11-08 04:06:41 -06002223 kfree(sfp);
Tony Battersbyc6517b792009-01-21 14:45:50 -05002224
2225 scsi_device_put(sdp->device);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002226 kref_put(&sdp->d_ref, sg_device_destroy);
Tony Battersbyc6517b792009-01-21 14:45:50 -05002227 module_put(THIS_MODULE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002228}
2229
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002230static void
2231sg_remove_sfp(struct kref *kref)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002232{
Tony Battersbyc6517b792009-01-21 14:45:50 -05002233 struct sg_fd *sfp = container_of(kref, struct sg_fd, f_ref);
James Bottomley065b4a22013-10-25 10:27:02 +01002234 struct sg_device *sdp = sfp->parentdp;
Tony Battersbyc6517b792009-01-21 14:45:50 -05002235 unsigned long iflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002236
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002237 write_lock_irqsave(&sdp->sfd_lock, iflags);
FUJITA Tomonori3442f802009-02-16 13:26:53 +09002238 list_del(&sfp->sfd_siblings);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002239 write_unlock_irqrestore(&sdp->sfd_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002240
FUJITA Tomonori015640e2009-04-03 19:28:06 +09002241 INIT_WORK(&sfp->ew.work, sg_remove_sfp_usercontext);
2242 schedule_work(&sfp->ew.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002243}
2244
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245#ifdef CONFIG_SCSI_PROC_FS
2246static int
James Bottomley7c07d612007-08-05 13:36:11 -05002247sg_idr_max_id(int id, void *p, void *data)
2248{
2249 int *k = data;
2250
2251 if (*k < id)
2252 *k = id;
2253
2254 return 0;
2255}
2256
2257static int
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258sg_last_dev(void)
2259{
Tony Battersby53474c02008-01-22 15:25:49 -05002260 int k = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002261 unsigned long iflags;
2262
James Bottomley7c07d612007-08-05 13:36:11 -05002263 read_lock_irqsave(&sg_index_lock, iflags);
2264 idr_for_each(&sg_index_idr, sg_idr_max_id, &k);
2265 read_unlock_irqrestore(&sg_index_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002266 return k + 1; /* origin 1 */
2267}
2268#endif
2269
Tony Battersbyc6517b792009-01-21 14:45:50 -05002270/* must be called with sg_index_lock held */
2271static Sg_device *sg_lookup_dev(int dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002272{
Tony Battersbyc6517b792009-01-21 14:45:50 -05002273 return idr_find(&sg_index_idr, dev);
2274}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002275
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002276static Sg_device *
2277sg_get_dev(int dev)
Tony Battersbyc6517b792009-01-21 14:45:50 -05002278{
2279 struct sg_device *sdp;
2280 unsigned long flags;
2281
2282 read_lock_irqsave(&sg_index_lock, flags);
2283 sdp = sg_lookup_dev(dev);
2284 if (!sdp)
2285 sdp = ERR_PTR(-ENXIO);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002286 else if (atomic_read(&sdp->detaching)) {
2287 /* If sdp->detaching, then the refcount may already be 0, in
Tony Battersbyc6517b792009-01-21 14:45:50 -05002288 * which case it would be a bug to do kref_get().
2289 */
2290 sdp = ERR_PTR(-ENODEV);
2291 } else
2292 kref_get(&sdp->d_ref);
2293 read_unlock_irqrestore(&sg_index_lock, flags);
James Bottomley7c07d612007-08-05 13:36:11 -05002294
Linus Torvalds1da177e2005-04-16 15:20:36 -07002295 return sdp;
2296}
2297
2298#ifdef CONFIG_SCSI_PROC_FS
2299
2300static struct proc_dir_entry *sg_proc_sgp = NULL;
2301
2302static char sg_proc_sg_dirname[] = "scsi/sg";
2303
2304static int sg_proc_seq_show_int(struct seq_file *s, void *v);
2305
2306static int sg_proc_single_open_adio(struct inode *inode, struct file *file);
2307static ssize_t sg_proc_write_adio(struct file *filp, const char __user *buffer,
2308 size_t count, loff_t *off);
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002309static const struct file_operations adio_fops = {
2310 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002311 .open = sg_proc_single_open_adio,
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002312 .read = seq_read,
2313 .llseek = seq_lseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002314 .write = sg_proc_write_adio,
2315 .release = single_release,
2316};
2317
2318static int sg_proc_single_open_dressz(struct inode *inode, struct file *file);
2319static ssize_t sg_proc_write_dressz(struct file *filp,
2320 const char __user *buffer, size_t count, loff_t *off);
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002321static const struct file_operations dressz_fops = {
2322 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002323 .open = sg_proc_single_open_dressz,
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002324 .read = seq_read,
2325 .llseek = seq_lseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002326 .write = sg_proc_write_dressz,
2327 .release = single_release,
2328};
2329
2330static int sg_proc_seq_show_version(struct seq_file *s, void *v);
2331static int sg_proc_single_open_version(struct inode *inode, struct file *file);
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002332static const struct file_operations version_fops = {
2333 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002334 .open = sg_proc_single_open_version,
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002335 .read = seq_read,
2336 .llseek = seq_lseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002337 .release = single_release,
2338};
2339
2340static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v);
2341static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file);
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002342static const struct file_operations devhdr_fops = {
2343 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002344 .open = sg_proc_single_open_devhdr,
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002345 .read = seq_read,
2346 .llseek = seq_lseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002347 .release = single_release,
2348};
2349
2350static int sg_proc_seq_show_dev(struct seq_file *s, void *v);
2351static int sg_proc_open_dev(struct inode *inode, struct file *file);
2352static void * dev_seq_start(struct seq_file *s, loff_t *pos);
2353static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos);
2354static void dev_seq_stop(struct seq_file *s, void *v);
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002355static const struct file_operations dev_fops = {
2356 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002357 .open = sg_proc_open_dev,
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002358 .read = seq_read,
2359 .llseek = seq_lseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002360 .release = seq_release,
2361};
James Morris88e9d342009-09-22 16:43:43 -07002362static const struct seq_operations dev_seq_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002363 .start = dev_seq_start,
2364 .next = dev_seq_next,
2365 .stop = dev_seq_stop,
2366 .show = sg_proc_seq_show_dev,
2367};
2368
2369static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v);
2370static int sg_proc_open_devstrs(struct inode *inode, struct file *file);
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002371static const struct file_operations devstrs_fops = {
2372 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002373 .open = sg_proc_open_devstrs,
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002374 .read = seq_read,
2375 .llseek = seq_lseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002376 .release = seq_release,
2377};
James Morris88e9d342009-09-22 16:43:43 -07002378static const struct seq_operations devstrs_seq_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002379 .start = dev_seq_start,
2380 .next = dev_seq_next,
2381 .stop = dev_seq_stop,
2382 .show = sg_proc_seq_show_devstrs,
2383};
2384
2385static int sg_proc_seq_show_debug(struct seq_file *s, void *v);
2386static int sg_proc_open_debug(struct inode *inode, struct file *file);
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002387static const struct file_operations debug_fops = {
2388 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002389 .open = sg_proc_open_debug,
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002390 .read = seq_read,
2391 .llseek = seq_lseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002392 .release = seq_release,
2393};
James Morris88e9d342009-09-22 16:43:43 -07002394static const struct seq_operations debug_seq_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002395 .start = dev_seq_start,
2396 .next = dev_seq_next,
2397 .stop = dev_seq_stop,
2398 .show = sg_proc_seq_show_debug,
2399};
2400
2401
2402struct sg_proc_leaf {
2403 const char * name;
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002404 const struct file_operations * fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002405};
2406
Jörn Engel18b8ba62012-04-12 17:35:25 -04002407static const struct sg_proc_leaf sg_proc_leaf_arr[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002408 {"allow_dio", &adio_fops},
2409 {"debug", &debug_fops},
2410 {"def_reserved_size", &dressz_fops},
2411 {"device_hdr", &devhdr_fops},
2412 {"devices", &dev_fops},
2413 {"device_strs", &devstrs_fops},
2414 {"version", &version_fops}
2415};
2416
2417static int
2418sg_proc_init(void)
2419{
Tobias Klauser6391a112006-06-08 22:23:48 -07002420 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
Al Virod161a132011-07-24 03:36:29 -04002421 int k;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002422
Al Viro66600222005-09-28 22:32:57 +01002423 sg_proc_sgp = proc_mkdir(sg_proc_sg_dirname, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002424 if (!sg_proc_sgp)
2425 return 1;
2426 for (k = 0; k < num_leaves; ++k) {
Jörn Engel18b8ba62012-04-12 17:35:25 -04002427 const struct sg_proc_leaf *leaf = &sg_proc_leaf_arr[k];
Al Virod161a132011-07-24 03:36:29 -04002428 umode_t mask = leaf->fops->write ? S_IRUGO | S_IWUSR : S_IRUGO;
Denis V. Luneva9739092008-04-29 01:02:17 -07002429 proc_create(leaf->name, mask, sg_proc_sgp, leaf->fops);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002430 }
2431 return 0;
2432}
2433
2434static void
2435sg_proc_cleanup(void)
2436{
2437 int k;
Tobias Klauser6391a112006-06-08 22:23:48 -07002438 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002439
2440 if (!sg_proc_sgp)
2441 return;
2442 for (k = 0; k < num_leaves; ++k)
2443 remove_proc_entry(sg_proc_leaf_arr[k].name, sg_proc_sgp);
2444 remove_proc_entry(sg_proc_sg_dirname, NULL);
2445}
2446
2447
2448static int sg_proc_seq_show_int(struct seq_file *s, void *v)
2449{
2450 seq_printf(s, "%d\n", *((int *)s->private));
2451 return 0;
2452}
2453
2454static int sg_proc_single_open_adio(struct inode *inode, struct file *file)
2455{
2456 return single_open(file, sg_proc_seq_show_int, &sg_allow_dio);
2457}
2458
2459static ssize_t
2460sg_proc_write_adio(struct file *filp, const char __user *buffer,
2461 size_t count, loff_t *off)
2462{
Stephen Boyd7e95fff2012-01-10 15:42:34 -08002463 int err;
2464 unsigned long num;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002465
2466 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2467 return -EACCES;
Stephen Boyd7e95fff2012-01-10 15:42:34 -08002468 err = kstrtoul_from_user(buffer, count, 0, &num);
2469 if (err)
2470 return err;
2471 sg_allow_dio = num ? 1 : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002472 return count;
2473}
2474
2475static int sg_proc_single_open_dressz(struct inode *inode, struct file *file)
2476{
2477 return single_open(file, sg_proc_seq_show_int, &sg_big_buff);
2478}
2479
2480static ssize_t
2481sg_proc_write_dressz(struct file *filp, const char __user *buffer,
2482 size_t count, loff_t *off)
2483{
Stephen Boyd7e95fff2012-01-10 15:42:34 -08002484 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002485 unsigned long k = ULONG_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002486
2487 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2488 return -EACCES;
Stephen Boyd7e95fff2012-01-10 15:42:34 -08002489
2490 err = kstrtoul_from_user(buffer, count, 0, &k);
2491 if (err)
2492 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002493 if (k <= 1048576) { /* limit "big buff" to 1 MB */
2494 sg_big_buff = k;
2495 return count;
2496 }
2497 return -ERANGE;
2498}
2499
2500static int sg_proc_seq_show_version(struct seq_file *s, void *v)
2501{
2502 seq_printf(s, "%d\t%s [%s]\n", sg_version_num, SG_VERSION_STR,
2503 sg_version_date);
2504 return 0;
2505}
2506
2507static int sg_proc_single_open_version(struct inode *inode, struct file *file)
2508{
2509 return single_open(file, sg_proc_seq_show_version, NULL);
2510}
2511
2512static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v)
2513{
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002514 seq_puts(s, "host\tchan\tid\tlun\ttype\topens\tqdepth\tbusy\tonline\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002515 return 0;
2516}
2517
2518static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file)
2519{
2520 return single_open(file, sg_proc_seq_show_devhdr, NULL);
2521}
2522
2523struct sg_proc_deviter {
2524 loff_t index;
2525 size_t max;
2526};
2527
2528static void * dev_seq_start(struct seq_file *s, loff_t *pos)
2529{
2530 struct sg_proc_deviter * it = kmalloc(sizeof(*it), GFP_KERNEL);
2531
Jan Blunck729d70f2005-08-27 11:07:52 -07002532 s->private = it;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002533 if (! it)
2534 return NULL;
Jan Blunck729d70f2005-08-27 11:07:52 -07002535
Linus Torvalds1da177e2005-04-16 15:20:36 -07002536 it->index = *pos;
2537 it->max = sg_last_dev();
2538 if (it->index >= it->max)
Jan Blunck729d70f2005-08-27 11:07:52 -07002539 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002540 return it;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002541}
2542
2543static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos)
2544{
Jan Blunck729d70f2005-08-27 11:07:52 -07002545 struct sg_proc_deviter * it = s->private;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002546
2547 *pos = ++it->index;
2548 return (it->index < it->max) ? it : NULL;
2549}
2550
2551static void dev_seq_stop(struct seq_file *s, void *v)
2552{
Jan Blunck729d70f2005-08-27 11:07:52 -07002553 kfree(s->private);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002554}
2555
2556static int sg_proc_open_dev(struct inode *inode, struct file *file)
2557{
2558 return seq_open(file, &dev_seq_ops);
2559}
2560
2561static int sg_proc_seq_show_dev(struct seq_file *s, void *v)
2562{
2563 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2564 Sg_device *sdp;
2565 struct scsi_device *scsidp;
Tony Battersbyc6517b792009-01-21 14:45:50 -05002566 unsigned long iflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002567
Tony Battersbyc6517b792009-01-21 14:45:50 -05002568 read_lock_irqsave(&sg_index_lock, iflags);
2569 sdp = it ? sg_lookup_dev(it->index) : NULL;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002570 if ((NULL == sdp) || (NULL == sdp->device) ||
2571 (atomic_read(&sdp->detaching)))
2572 seq_puts(s, "-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\n");
2573 else {
2574 scsidp = sdp->device;
Hannes Reinecke9cb78c12014-06-25 15:27:36 +02002575 seq_printf(s, "%d\t%d\t%d\t%llu\t%d\t%d\t%d\t%d\t%d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002576 scsidp->host->host_no, scsidp->channel,
2577 scsidp->id, scsidp->lun, (int) scsidp->type,
2578 1,
2579 (int) scsidp->queue_depth,
Christoph Hellwig71e75c92014-04-11 19:07:01 +02002580 (int) atomic_read(&scsidp->device_busy),
Linus Torvalds1da177e2005-04-16 15:20:36 -07002581 (int) scsi_device_online(scsidp));
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002582 }
Tony Battersbyc6517b792009-01-21 14:45:50 -05002583 read_unlock_irqrestore(&sg_index_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002584 return 0;
2585}
2586
2587static int sg_proc_open_devstrs(struct inode *inode, struct file *file)
2588{
2589 return seq_open(file, &devstrs_seq_ops);
2590}
2591
2592static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v)
2593{
2594 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2595 Sg_device *sdp;
2596 struct scsi_device *scsidp;
Tony Battersbyc6517b792009-01-21 14:45:50 -05002597 unsigned long iflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002598
Tony Battersbyc6517b792009-01-21 14:45:50 -05002599 read_lock_irqsave(&sg_index_lock, iflags);
2600 sdp = it ? sg_lookup_dev(it->index) : NULL;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002601 scsidp = sdp ? sdp->device : NULL;
2602 if (sdp && scsidp && (!atomic_read(&sdp->detaching)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002603 seq_printf(s, "%8.8s\t%16.16s\t%4.4s\n",
2604 scsidp->vendor, scsidp->model, scsidp->rev);
2605 else
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002606 seq_puts(s, "<no active device>\n");
Tony Battersbyc6517b792009-01-21 14:45:50 -05002607 read_unlock_irqrestore(&sg_index_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002608 return 0;
2609}
2610
James Bottomleyc0d3b9c2013-10-25 10:21:57 +01002611/* must be called while holding sg_index_lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002612static void sg_proc_debug_helper(struct seq_file *s, Sg_device * sdp)
2613{
Hannes Reinecke109bade2017-04-07 09:34:16 +02002614 int k, new_interface, blen, usg;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002615 Sg_request *srp;
2616 Sg_fd *fp;
2617 const sg_io_hdr_t *hp;
2618 const char * cp;
cb59e842005-04-02 13:51:23 -06002619 unsigned int ms;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002620
FUJITA Tomonori3442f802009-02-16 13:26:53 +09002621 k = 0;
2622 list_for_each_entry(fp, &sdp->sfds, sfd_siblings) {
2623 k++;
Tony Battersbyc6517b792009-01-21 14:45:50 -05002624 read_lock(&fp->rq_list_lock); /* irqs already disabled */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002625 seq_printf(s, " FD(%d): timeout=%dms bufflen=%d "
FUJITA Tomonori3442f802009-02-16 13:26:53 +09002626 "(res)sgat=%d low_dma=%d\n", k,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002627 jiffies_to_msecs(fp->timeout),
2628 fp->reserve.bufflen,
2629 (int) fp->reserve.k_use_sg,
Hannes Reinecke745dfa02017-04-07 09:34:12 +02002630 (int) sdp->device->host->unchecked_isa_dma);
Jörn Engelebaf4662012-04-12 17:33:39 -04002631 seq_printf(s, " cmd_q=%d f_packid=%d k_orphan=%d closed=0\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002632 (int) fp->cmd_q, (int) fp->force_packid,
Jörn Engelebaf4662012-04-12 17:33:39 -04002633 (int) fp->keep_orphan);
Hannes Reinecke109bade2017-04-07 09:34:16 +02002634 list_for_each_entry(srp, &fp->rq_list, entry) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002635 hp = &srp->header;
2636 new_interface = (hp->interface_id == '\0') ? 0 : 1;
2637 if (srp->res_used) {
Hannes Reinecke109bade2017-04-07 09:34:16 +02002638 if (new_interface &&
Linus Torvalds1da177e2005-04-16 15:20:36 -07002639 (SG_FLAG_MMAP_IO & hp->flags))
2640 cp = " mmap>> ";
2641 else
2642 cp = " rb>> ";
2643 } else {
2644 if (SG_INFO_DIRECT_IO_MASK & hp->info)
2645 cp = " dio>> ";
2646 else
2647 cp = " ";
2648 }
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002649 seq_puts(s, cp);
Mike Christied6b10342005-11-08 04:06:41 -06002650 blen = srp->data.bufflen;
2651 usg = srp->data.k_use_sg;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002652 seq_puts(s, srp->done ?
2653 ((1 == srp->done) ? "rcv:" : "fin:")
2654 : "act:");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002655 seq_printf(s, " id=%d blen=%d",
2656 srp->header.pack_id, blen);
2657 if (srp->done)
2658 seq_printf(s, " dur=%d", hp->duration);
cb59e842005-04-02 13:51:23 -06002659 else {
2660 ms = jiffies_to_msecs(jiffies);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002661 seq_printf(s, " t_o/elap=%d/%d",
cb59e842005-04-02 13:51:23 -06002662 (new_interface ? hp->timeout :
2663 jiffies_to_msecs(fp->timeout)),
2664 (ms > hp->duration ? ms - hp->duration : 0));
2665 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002666 seq_printf(s, "ms sgat=%d op=0x%02x\n", usg,
2667 (int) srp->data.cmd_opcode);
2668 }
Hannes Reinecke109bade2017-04-07 09:34:16 +02002669 if (list_empty(&fp->rq_list))
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002670 seq_puts(s, " No requests active\n");
Tony Battersbyc6517b792009-01-21 14:45:50 -05002671 read_unlock(&fp->rq_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002672 }
2673}
2674
2675static int sg_proc_open_debug(struct inode *inode, struct file *file)
2676{
2677 return seq_open(file, &debug_seq_ops);
2678}
2679
2680static int sg_proc_seq_show_debug(struct seq_file *s, void *v)
2681{
2682 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2683 Sg_device *sdp;
Tony Battersbyc6517b792009-01-21 14:45:50 -05002684 unsigned long iflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002685
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002686 if (it && (0 == it->index))
2687 seq_printf(s, "max_active_device=%d def_reserved_size=%d\n",
2688 (int)it->max, sg_big_buff);
Tony Battersbyc6517b792009-01-21 14:45:50 -05002689
2690 read_lock_irqsave(&sg_index_lock, iflags);
2691 sdp = it ? sg_lookup_dev(it->index) : NULL;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002692 if (NULL == sdp)
2693 goto skip;
2694 read_lock(&sdp->sfd_lock);
2695 if (!list_empty(&sdp->sfds)) {
James Bottomleyc0d3b9c2013-10-25 10:21:57 +01002696 seq_printf(s, " >>> device=%s ", sdp->disk->disk_name);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002697 if (atomic_read(&sdp->detaching))
2698 seq_puts(s, "detaching pending close ");
2699 else if (sdp->device) {
2700 struct scsi_device *scsidp = sdp->device;
2701
Hannes Reinecke9cb78c12014-06-25 15:27:36 +02002702 seq_printf(s, "%d:%d:%d:%llu em=%d",
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002703 scsidp->host->host_no,
2704 scsidp->channel, scsidp->id,
2705 scsidp->lun,
2706 scsidp->host->hostt->emulated);
2707 }
2708 seq_printf(s, " sg_tablesize=%d excl=%d open_cnt=%d\n",
2709 sdp->sg_tablesize, sdp->exclude, sdp->open_cnt);
James Bottomleyc0d3b9c2013-10-25 10:21:57 +01002710 sg_proc_debug_helper(s, sdp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002711 }
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002712 read_unlock(&sdp->sfd_lock);
2713skip:
Tony Battersbyc6517b792009-01-21 14:45:50 -05002714 read_unlock_irqrestore(&sg_index_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002715 return 0;
2716}
2717
2718#endif /* CONFIG_SCSI_PROC_FS */
2719
2720module_init(init_sg);
2721module_exit(exit_sg);