blob: edc63625345278573d8340b3ddfbba0e29e8ebc7 [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>
Jann Hornb6db8af2018-06-25 16:25:44 +020054#include <linux/cred.h> /* for sg_check_file_access() */
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
56#include "scsi.h"
db9dff32005-04-03 14:53:59 -050057#include <scsi/scsi_dbg.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070058#include <scsi/scsi_host.h>
59#include <scsi/scsi_driver.h>
60#include <scsi/scsi_ioctl.h>
61#include <scsi/sg.h>
62
63#include "scsi_logging.h"
64
65#ifdef CONFIG_SCSI_PROC_FS
66#include <linux/proc_fs.h>
Douglas Gilbert65c26a02014-06-03 13:18:18 -040067static char *sg_version_date = "20140603";
Linus Torvalds1da177e2005-04-16 15:20:36 -070068
69static int sg_proc_init(void);
70static void sg_proc_cleanup(void);
71#endif
72
Linus Torvalds1da177e2005-04-16 15:20:36 -070073#define SG_ALLOW_DIO_DEF 0
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
75#define SG_MAX_DEVS 32768
76
Douglas Gilbert65c26a02014-06-03 13:18:18 -040077/* SG_MAX_CDB_SIZE should be 260 (spc4r37 section 3.1.30) however the type
78 * of sg_io_hdr::cmd_len can only represent 255. All SCSI commands greater
79 * than 16 bytes are "variable length" whose length is a multiple of 4
80 */
81#define SG_MAX_CDB_SIZE 252
82
Paul Burtonf8630bd72016-08-19 17:43:57 +010083#define SG_DEFAULT_TIMEOUT mult_frac(SG_DEFAULT_TIMEOUT_USER, HZ, USER_HZ)
Linus Torvalds1da177e2005-04-16 15:20:36 -070084
85int sg_big_buff = SG_DEF_RESERVED_SIZE;
86/* N.B. This variable is readable and writeable via
87 /proc/scsi/sg/def_reserved_size . Each time sg_open() is called a buffer
88 of this size (or less if there is not enough memory) will be reserved
89 for use by this file descriptor. [Deprecated usage: this variable is also
90 readable via /proc/sys/kernel/sg-big-buff if the sg driver is built into
91 the kernel (i.e. it is not a module).] */
92static int def_reserved_size = -1; /* picks up init parameter */
93static int sg_allow_dio = SG_ALLOW_DIO_DEF;
94
Douglas Gilbert6460e752006-09-20 18:20:49 -040095static int scatter_elem_sz = SG_SCATTER_SZ;
96static int scatter_elem_sz_prev = SG_SCATTER_SZ;
97
Linus Torvalds1da177e2005-04-16 15:20:36 -070098#define SG_SECTOR_SZ 512
Linus Torvalds1da177e2005-04-16 15:20:36 -070099
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200100static int sg_add_device(struct device *, struct class_interface *);
101static void sg_remove_device(struct device *, struct class_interface *);
James Bottomley98481ff2013-10-25 10:26:38 +0100102
James Bottomley7c07d612007-08-05 13:36:11 -0500103static DEFINE_IDR(sg_index_idr);
James Bottomleyc0d3b9c22013-10-25 10:21:57 +0100104static DEFINE_RWLOCK(sg_index_lock); /* Also used to lock
105 file descriptor list for device */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106
107static struct class_interface sg_interface = {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200108 .add_dev = sg_add_device,
109 .remove_dev = sg_remove_device,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110};
111
112typedef struct sg_scatter_hold { /* holding area for scsi scatter gather info */
113 unsigned short k_use_sg; /* Count of kernel scatter-gather pieces */
FUJITA Tomonoriea312552007-08-06 00:31:24 +0900114 unsigned sglist_len; /* size of malloc'd scatter-gather list ++ */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 unsigned bufflen; /* Size of (aggregate) data buffer */
FUJITA Tomonori10db10d2008-08-29 12:32:18 +0200116 struct page **pages;
117 int page_order;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118 char dio_in_use; /* 0->indirect IO (or mmap), 1->dio */
119 unsigned char cmd_opcode; /* first byte of command */
120} Sg_scatter_hold;
121
122struct sg_device; /* forward declarations */
123struct sg_fd;
124
125typedef struct sg_request { /* SG_MAX_QUEUE requests outstanding per file */
Hannes Reinecke2b2d86b2017-04-07 09:34:16 +0200126 struct list_head entry; /* list entry */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 struct sg_fd *parentfp; /* NULL -> not in use */
128 Sg_scatter_hold data; /* hold buffer, perhaps scatter list */
129 sg_io_hdr_t header; /* scsi command+info, see <scsi/sg.h> */
Mike Christied6b10342005-11-08 04:06:41 -0600130 unsigned char sense_b[SCSI_SENSE_BUFFERSIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 char res_used; /* 1 -> using reserve buffer, 0 -> not ... */
132 char orphan; /* 1 -> drop on sight, 0 -> normal */
133 char sg_io_owned; /* 1 -> packet belongs to SG_IO */
Jörn Engel6acddc52012-04-12 17:33:58 -0400134 /* done protected by rq_list_lock */
135 char done; /* 0->before bh, 1->before read, 2->read */
FUJITA Tomonori10865df2008-08-28 16:17:07 +0900136 struct request *rq;
FUJITA Tomonori6e5a30c2008-08-28 16:17:08 +0900137 struct bio *bio;
FUJITA Tomonoric96952e2009-02-04 11:36:27 +0900138 struct execute_work ew;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139} Sg_request;
140
141typedef struct sg_fd { /* holds the state of a file descriptor */
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200142 struct list_head sfd_siblings; /* protected by device's sfd_lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 struct sg_device *parentdp; /* owning device */
144 wait_queue_head_t read_wait; /* queue read until command done */
145 rwlock_t rq_list_lock; /* protect access to list in req_arr */
Hannes Reinecke4099ac92017-04-07 09:34:14 +0200146 struct mutex f_mutex; /* protect against changes in this fd */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147 int timeout; /* defaults to SG_DEFAULT_TIMEOUT */
148 int timeout_user; /* defaults to SG_DEFAULT_TIMEOUT_USER */
149 Sg_scatter_hold reserve; /* buffer held for this file descriptor */
Hannes Reinecke2b2d86b2017-04-07 09:34:16 +0200150 struct list_head rq_list; /* head of request list */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 struct fasync_struct *async_qp; /* used by asynchronous notification */
152 Sg_request req_arr[SG_MAX_QUEUE]; /* used as singly-linked list */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 char force_packid; /* 1 -> pack_id input to read(), 0 -> ignored */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 char cmd_q; /* 1 -> allow command queuing, 0 -> don't */
Douglas Gilbert65c26a02014-06-03 13:18:18 -0400155 unsigned char next_cmd_len; /* 0: automatic, >0: use on next write() */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 char keep_orphan; /* 0 -> drop orphan (def), 1 -> keep for read() */
157 char mmap_called; /* 0 -> mmap() never called on this fd */
Hannes Reinecke4099ac92017-04-07 09:34:14 +0200158 char res_in_use; /* 1 -> 'reserve' array in use */
Tony Battersbyc6517b792009-01-21 14:45:50 -0500159 struct kref f_ref;
160 struct execute_work ew;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161} Sg_fd;
162
163typedef struct sg_device { /* holds the state of each scsi generic device */
164 struct scsi_device *device;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200165 wait_queue_head_t open_wait; /* queue open() when O_EXCL present */
166 struct mutex open_rel_lock; /* held when in open() or release() */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 int sg_tablesize; /* adapter's max scatter-gather table size */
James Bottomley7c07d612007-08-05 13:36:11 -0500168 u32 index; /* device index number */
FUJITA Tomonori3442f802009-02-16 13:26:53 +0900169 struct list_head sfds;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200170 rwlock_t sfd_lock; /* protect access to sfd list */
171 atomic_t detaching; /* 0->device usable, 1->device detaching */
172 bool exclude; /* 1->open(O_EXCL) succeeded and is active */
173 int open_cnt; /* count of opens (perhaps < num(sfds) ) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174 char sgdebug; /* 0->off, 1->sense, 9->dump dev, 10-> all devs */
175 struct gendisk *disk;
176 struct cdev * cdev; /* char_dev [sysfs: /sys/cdev/major/sg<n>] */
Tony Battersbyc6517b792009-01-21 14:45:50 -0500177 struct kref d_ref;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178} Sg_device;
179
Mike Christied6b10342005-11-08 04:06:41 -0600180/* tasklet or soft irq callback */
FUJITA Tomonoria91a3a22008-09-02 22:50:01 +0900181static void sg_rq_end_io(struct request *rq, int uptodate);
FUJITA Tomonori10865df2008-08-28 16:17:07 +0900182static int sg_start_req(Sg_request *srp, unsigned char *cmd);
FUJITA Tomonorie7ee4cc2009-04-04 00:35:42 +0900183static int sg_finish_rem_req(Sg_request * srp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184static int sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185static ssize_t sg_new_read(Sg_fd * sfp, char __user *buf, size_t count,
186 Sg_request * srp);
Adel Gadllah0b07de82008-06-26 13:48:27 +0200187static ssize_t sg_new_write(Sg_fd *sfp, struct file *file,
188 const char __user *buf, size_t count, int blocking,
Tony Battersbya2dd3b42009-01-20 17:00:09 -0500189 int read_only, int sg_io_owned, Sg_request **o_srp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190static int sg_common_write(Sg_fd * sfp, Sg_request * srp,
191 unsigned char *cmnd, int timeout, int blocking);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192static int sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer);
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200193static void sg_remove_scat(Sg_fd * sfp, Sg_scatter_hold * schp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194static void sg_build_reserve(Sg_fd * sfp, int req_size);
195static void sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size);
196static void sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp);
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200197static Sg_fd *sg_add_sfp(Sg_device * sdp);
Tony Battersbyc6517b792009-01-21 14:45:50 -0500198static void sg_remove_sfp(struct kref *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199static Sg_request *sg_get_rq_mark(Sg_fd * sfp, int pack_id);
200static Sg_request *sg_add_request(Sg_fd * sfp);
201static int sg_remove_request(Sg_fd * sfp, Sg_request * srp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202static Sg_device *sg_get_dev(int dev);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200203static void sg_device_destroy(struct kref *kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205#define SZ_SG_HEADER sizeof(struct sg_header)
206#define SZ_SG_IO_HDR sizeof(sg_io_hdr_t)
207#define SZ_SG_IOVEC sizeof(sg_iovec_t)
208#define SZ_SG_REQ_INFO sizeof(sg_req_info_t)
209
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200210#define sg_printk(prefix, sdp, fmt, a...) \
Hannes Reinecke22e0d992014-10-24 14:26:44 +0200211 sdev_prefix_printk(prefix, (sdp)->device, \
212 (sdp)->disk->disk_name, fmt, ##a)
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200213
Jann Hornb6db8af2018-06-25 16:25:44 +0200214/*
215 * The SCSI interfaces that use read() and write() as an asynchronous variant of
216 * ioctl(..., SG_IO, ...) are fundamentally unsafe, since there are lots of ways
217 * to trigger read() and write() calls from various contexts with elevated
218 * privileges. This can lead to kernel memory corruption (e.g. if these
219 * interfaces are called through splice()) and privilege escalation inside
220 * userspace (e.g. if a process with access to such a device passes a file
221 * descriptor to a SUID binary as stdin/stdout/stderr).
222 *
223 * This function provides protection for the legacy API by restricting the
224 * calling context.
225 */
226static int sg_check_file_access(struct file *filp, const char *caller)
227{
228 if (filp->f_cred != current_real_cred()) {
229 pr_err_once("%s: process %d (%s) changed security contexts after opening file descriptor, this is not allowed.\n",
230 caller, task_tgid_vnr(current), current->comm);
231 return -EPERM;
232 }
233 if (unlikely(segment_eq(get_fs(), KERNEL_DS))) {
234 pr_err_once("%s: process %d (%s) called from kernel context, this is not allowed.\n",
235 caller, task_tgid_vnr(current), current->comm);
236 return -EACCES;
237 }
238 return 0;
239}
240
FUJITA Tomonori14e507b2008-07-26 18:03:24 +0900241static int sg_allow_access(struct file *filp, unsigned char *cmd)
242{
Joe Perches35df8392010-09-04 18:52:46 -0700243 struct sg_fd *sfp = filp->private_data;
FUJITA Tomonori14e507b2008-07-26 18:03:24 +0900244
245 if (sfp->parentdp->device->type == TYPE_SCANNER)
246 return 0;
247
Jens Axboe018e0442009-06-26 16:27:10 +0200248 return blk_verify_command(cmd, filp->f_mode & FMODE_WRITE);
FUJITA Tomonori14e507b2008-07-26 18:03:24 +0900249}
250
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200251static int
252open_wait(Sg_device *sdp, int flags)
James Bottomley98481ff2013-10-25 10:26:38 +0100253{
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200254 int retval = 0;
James Bottomley98481ff2013-10-25 10:26:38 +0100255
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200256 if (flags & O_EXCL) {
257 while (sdp->open_cnt > 0) {
258 mutex_unlock(&sdp->open_rel_lock);
259 retval = wait_event_interruptible(sdp->open_wait,
260 (atomic_read(&sdp->detaching) ||
261 !sdp->open_cnt));
262 mutex_lock(&sdp->open_rel_lock);
263
264 if (retval) /* -ERESTARTSYS */
265 return retval;
266 if (atomic_read(&sdp->detaching))
267 return -ENODEV;
268 }
269 } else {
270 while (sdp->exclude) {
271 mutex_unlock(&sdp->open_rel_lock);
272 retval = wait_event_interruptible(sdp->open_wait,
273 (atomic_read(&sdp->detaching) ||
274 !sdp->exclude));
275 mutex_lock(&sdp->open_rel_lock);
276
277 if (retval) /* -ERESTARTSYS */
278 return retval;
279 if (atomic_read(&sdp->detaching))
280 return -ENODEV;
281 }
282 }
283
284 return retval;
James Bottomley98481ff2013-10-25 10:26:38 +0100285}
286
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200287/* Returns 0 on success, else a negated errno value */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288static int
289sg_open(struct inode *inode, struct file *filp)
290{
291 int dev = iminor(inode);
292 int flags = filp->f_flags;
Mike Christied6b10342005-11-08 04:06:41 -0600293 struct request_queue *q;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 Sg_device *sdp;
295 Sg_fd *sfp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 int retval;
297
298 nonseekable_open(inode, filp);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200299 if ((flags & O_EXCL) && (O_RDONLY == (flags & O_ACCMODE)))
300 return -EPERM; /* Can't lock it with read only access */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 sdp = sg_get_dev(dev);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200302 if (IS_ERR(sdp))
303 return PTR_ERR(sdp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200305 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
306 "sg_open: flags=0x%x\n", flags));
307
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308 /* This driver's module count bumped by fops_get in <linux/fs.h> */
309 /* Prevent the device driver from vanishing while we sleep */
310 retval = scsi_device_get(sdp->device);
Tony Battersbyc6517b792009-01-21 14:45:50 -0500311 if (retval)
312 goto sg_put;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313
Alan Sternbc4f2402010-06-17 10:41:42 -0400314 retval = scsi_autopm_get_device(sdp->device);
315 if (retval)
316 goto sdp_put;
317
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200318 /* scsi_block_when_processing_errors() may block so bypass
319 * check if O_NONBLOCK. Permits SCSI commands to be issued
320 * during error recovery. Tread carefully. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321 if (!((flags & O_NONBLOCK) ||
322 scsi_block_when_processing_errors(sdp->device))) {
323 retval = -ENXIO;
324 /* we are in error recovery for this device */
325 goto error_out;
326 }
327
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200328 mutex_lock(&sdp->open_rel_lock);
329 if (flags & O_NONBLOCK) {
330 if (flags & O_EXCL) {
331 if (sdp->open_cnt > 0) {
332 retval = -EBUSY;
333 goto error_mutex_locked;
334 }
335 } else {
336 if (sdp->exclude) {
337 retval = -EBUSY;
338 goto error_mutex_locked;
339 }
Vaughan Cao15b06f92013-08-29 10:00:36 +0800340 }
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200341 } else {
342 retval = open_wait(sdp, flags);
343 if (retval) /* -ERESTARTSYS or -ENODEV */
344 goto error_mutex_locked;
Vaughan Cao15b06f92013-08-29 10:00:36 +0800345 }
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200346
347 /* N.B. at this point we are holding the open_rel_lock */
348 if (flags & O_EXCL)
349 sdp->exclude = true;
350
351 if (sdp->open_cnt < 1) { /* no existing opens */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 sdp->sgdebug = 0;
Mike Christied6b10342005-11-08 04:06:41 -0600353 q = sdp->device->request_queue;
Martin K. Petersen8a783622010-02-26 00:20:39 -0500354 sdp->sg_tablesize = queue_max_segments(q);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355 }
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200356 sfp = sg_add_sfp(sdp);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200357 if (IS_ERR(sfp)) {
358 retval = PTR_ERR(sfp);
359 goto out_undo;
James Bottomley065b4a22013-10-25 10:27:02 +0100360 }
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200361
362 filp->private_data = sfp;
363 sdp->open_cnt++;
364 mutex_unlock(&sdp->open_rel_lock);
365
James Bottomley065b4a22013-10-25 10:27:02 +0100366 retval = 0;
Tony Battersbyc6517b792009-01-21 14:45:50 -0500367sg_put:
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200368 kref_put(&sdp->d_ref, sg_device_destroy);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 return retval;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200370
371out_undo:
372 if (flags & O_EXCL) {
373 sdp->exclude = false; /* undo if error */
374 wake_up_interruptible(&sdp->open_wait);
375 }
376error_mutex_locked:
377 mutex_unlock(&sdp->open_rel_lock);
378error_out:
379 scsi_autopm_put_device(sdp->device);
380sdp_put:
381 scsi_device_put(sdp->device);
382 goto sg_put;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383}
384
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200385/* Release resources associated with a successful sg_open()
386 * Returns 0 on success, else a negated errno value */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387static int
388sg_release(struct inode *inode, struct file *filp)
389{
390 Sg_device *sdp;
391 Sg_fd *sfp;
392
393 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
394 return -ENXIO;
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200395 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp, "sg_release\n"));
Tony Battersbyc6517b792009-01-21 14:45:50 -0500396
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200397 mutex_lock(&sdp->open_rel_lock);
Alan Sternbc4f2402010-06-17 10:41:42 -0400398 scsi_autopm_put_device(sdp->device);
Tony Battersbyc6517b792009-01-21 14:45:50 -0500399 kref_put(&sfp->f_ref, sg_remove_sfp);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200400 sdp->open_cnt--;
401
402 /* possibly many open()s waiting on exlude clearing, start many;
403 * only open(O_EXCL)s wait on 0==open_cnt so only start one */
404 if (sdp->exclude) {
405 sdp->exclude = false;
406 wake_up_interruptible_all(&sdp->open_wait);
407 } else if (0 == sdp->open_cnt) {
408 wake_up_interruptible(&sdp->open_wait);
409 }
410 mutex_unlock(&sdp->open_rel_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 return 0;
412}
413
414static ssize_t
415sg_read(struct file *filp, char __user *buf, size_t count, loff_t * ppos)
416{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 Sg_device *sdp;
418 Sg_fd *sfp;
419 Sg_request *srp;
420 int req_pack_id = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 sg_io_hdr_t *hp;
cb59e842005-04-02 13:51:23 -0600422 struct sg_header *old_hdr = NULL;
423 int retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424
Jann Hornb6db8af2018-06-25 16:25:44 +0200425 /*
426 * This could cause a response to be stranded. Close the associated
427 * file descriptor to free up any resources being held.
428 */
429 retval = sg_check_file_access(filp, __func__);
430 if (retval)
431 return retval;
432
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
434 return -ENXIO;
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200435 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
436 "sg_read: count=%d\n", (int) count));
Mike Christied6b10342005-11-08 04:06:41 -0600437
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 if (!access_ok(VERIFY_WRITE, buf, count))
439 return -EFAULT;
440 if (sfp->force_packid && (count >= SZ_SG_HEADER)) {
cb59e842005-04-02 13:51:23 -0600441 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
442 if (!old_hdr)
443 return -ENOMEM;
444 if (__copy_from_user(old_hdr, buf, SZ_SG_HEADER)) {
445 retval = -EFAULT;
446 goto free_old_hdr;
447 }
448 if (old_hdr->reply_len < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449 if (count >= SZ_SG_IO_HDR) {
cb59e842005-04-02 13:51:23 -0600450 sg_io_hdr_t *new_hdr;
451 new_hdr = kmalloc(SZ_SG_IO_HDR, GFP_KERNEL);
452 if (!new_hdr) {
453 retval = -ENOMEM;
454 goto free_old_hdr;
455 }
456 retval =__copy_from_user
457 (new_hdr, buf, SZ_SG_IO_HDR);
458 req_pack_id = new_hdr->pack_id;
459 kfree(new_hdr);
460 if (retval) {
461 retval = -EFAULT;
462 goto free_old_hdr;
463 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464 }
465 } else
cb59e842005-04-02 13:51:23 -0600466 req_pack_id = old_hdr->pack_id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 }
468 srp = sg_get_rq_mark(sfp, req_pack_id);
469 if (!srp) { /* now wait on packet to arrive */
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200470 if (atomic_read(&sdp->detaching)) {
cb59e842005-04-02 13:51:23 -0600471 retval = -ENODEV;
472 goto free_old_hdr;
473 }
474 if (filp->f_flags & O_NONBLOCK) {
475 retval = -EAGAIN;
476 goto free_old_hdr;
477 }
Jörn Engel3f0c6ab2012-04-12 17:33:25 -0400478 retval = wait_event_interruptible(sfp->read_wait,
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200479 (atomic_read(&sdp->detaching) ||
Jörn Engel3f0c6ab2012-04-12 17:33:25 -0400480 (srp = sg_get_rq_mark(sfp, req_pack_id))));
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200481 if (atomic_read(&sdp->detaching)) {
Jörn Engel794c10f2012-04-12 17:32:48 -0400482 retval = -ENODEV;
483 goto free_old_hdr;
484 }
485 if (retval) {
cb59e842005-04-02 13:51:23 -0600486 /* -ERESTARTSYS as signal hit process */
487 goto free_old_hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488 }
489 }
cb59e842005-04-02 13:51:23 -0600490 if (srp->header.interface_id != '\0') {
491 retval = sg_new_read(sfp, buf, count, srp);
492 goto free_old_hdr;
493 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494
495 hp = &srp->header;
cb59e842005-04-02 13:51:23 -0600496 if (old_hdr == NULL) {
497 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
498 if (! old_hdr) {
499 retval = -ENOMEM;
500 goto free_old_hdr;
501 }
502 }
503 memset(old_hdr, 0, SZ_SG_HEADER);
504 old_hdr->reply_len = (int) hp->timeout;
505 old_hdr->pack_len = old_hdr->reply_len; /* old, strange behaviour */
506 old_hdr->pack_id = hp->pack_id;
507 old_hdr->twelve_byte =
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508 ((srp->data.cmd_opcode >= 0xc0) && (12 == hp->cmd_len)) ? 1 : 0;
cb59e842005-04-02 13:51:23 -0600509 old_hdr->target_status = hp->masked_status;
510 old_hdr->host_status = hp->host_status;
511 old_hdr->driver_status = hp->driver_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512 if ((CHECK_CONDITION & hp->masked_status) ||
513 (DRIVER_SENSE & hp->driver_status))
cb59e842005-04-02 13:51:23 -0600514 memcpy(old_hdr->sense_buffer, srp->sense_b,
515 sizeof (old_hdr->sense_buffer));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 switch (hp->host_status) {
517 /* This setup of 'result' is for backward compatibility and is best
518 ignored by the user who should use target, host + driver status */
519 case DID_OK:
520 case DID_PASSTHROUGH:
521 case DID_SOFT_ERROR:
cb59e842005-04-02 13:51:23 -0600522 old_hdr->result = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523 break;
524 case DID_NO_CONNECT:
525 case DID_BUS_BUSY:
526 case DID_TIME_OUT:
cb59e842005-04-02 13:51:23 -0600527 old_hdr->result = EBUSY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 break;
529 case DID_BAD_TARGET:
530 case DID_ABORT:
531 case DID_PARITY:
532 case DID_RESET:
533 case DID_BAD_INTR:
cb59e842005-04-02 13:51:23 -0600534 old_hdr->result = EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535 break;
536 case DID_ERROR:
Robb Glasser0575f152017-03-24 16:23:37 -0700537 old_hdr->result = (srp->sense_b[0] == 0 &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538 hp->masked_status == GOOD) ? 0 : EIO;
539 break;
540 default:
cb59e842005-04-02 13:51:23 -0600541 old_hdr->result = EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 break;
543 }
544
545 /* Now copy the result back to the user buffer. */
546 if (count >= SZ_SG_HEADER) {
cb59e842005-04-02 13:51:23 -0600547 if (__copy_to_user(buf, old_hdr, SZ_SG_HEADER)) {
548 retval = -EFAULT;
549 goto free_old_hdr;
550 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 buf += SZ_SG_HEADER;
cb59e842005-04-02 13:51:23 -0600552 if (count > old_hdr->reply_len)
553 count = old_hdr->reply_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 if (count > SZ_SG_HEADER) {
cb59e842005-04-02 13:51:23 -0600555 if (sg_read_oxfer(srp, buf, count - SZ_SG_HEADER)) {
556 retval = -EFAULT;
557 goto free_old_hdr;
558 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559 }
560 } else
cb59e842005-04-02 13:51:23 -0600561 count = (old_hdr->result == 0) ? 0 : -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 sg_finish_rem_req(srp);
Hannes Reineckeae9b6ae2017-04-07 09:34:17 +0200563 sg_remove_request(sfp, srp);
cb59e842005-04-02 13:51:23 -0600564 retval = count;
565free_old_hdr:
Jesper Juhlc9475cb2005-11-07 01:01:26 -0800566 kfree(old_hdr);
cb59e842005-04-02 13:51:23 -0600567 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568}
569
570static ssize_t
571sg_new_read(Sg_fd * sfp, char __user *buf, size_t count, Sg_request * srp)
572{
573 sg_io_hdr_t *hp = &srp->header;
Tony Battersby3b524a62015-02-11 11:32:06 -0500574 int err = 0, err2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575 int len;
576
577 if (count < SZ_SG_IO_HDR) {
578 err = -EINVAL;
579 goto err_out;
580 }
581 hp->sb_len_wr = 0;
582 if ((hp->mx_sb_len > 0) && hp->sbp) {
583 if ((CHECK_CONDITION & hp->masked_status) ||
584 (DRIVER_SENSE & hp->driver_status)) {
Mike Christied6b10342005-11-08 04:06:41 -0600585 int sb_len = SCSI_SENSE_BUFFERSIZE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 sb_len = (hp->mx_sb_len > sb_len) ? sb_len : hp->mx_sb_len;
587 len = 8 + (int) srp->sense_b[7]; /* Additional sense length field */
588 len = (len > sb_len) ? sb_len : len;
589 if (copy_to_user(hp->sbp, srp->sense_b, len)) {
590 err = -EFAULT;
591 goto err_out;
592 }
593 hp->sb_len_wr = len;
594 }
595 }
596 if (hp->masked_status || hp->host_status || hp->driver_status)
597 hp->info |= SG_INFO_CHECK;
598 if (copy_to_user(buf, hp, SZ_SG_IO_HDR)) {
599 err = -EFAULT;
600 goto err_out;
601 }
FUJITA Tomonori0b6cb262008-09-02 22:50:07 +0900602err_out:
Tony Battersby3b524a62015-02-11 11:32:06 -0500603 err2 = sg_finish_rem_req(srp);
Hannes Reineckeae9b6ae2017-04-07 09:34:17 +0200604 sg_remove_request(sfp, srp);
Tony Battersby3b524a62015-02-11 11:32:06 -0500605 return err ? : err2 ? : count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606}
607
608static ssize_t
609sg_write(struct file *filp, const char __user *buf, size_t count, loff_t * ppos)
610{
611 int mxsize, cmd_size, k;
612 int input_size, blocking;
613 unsigned char opcode;
614 Sg_device *sdp;
615 Sg_fd *sfp;
616 Sg_request *srp;
617 struct sg_header old_hdr;
618 sg_io_hdr_t *hp;
Douglas Gilbert65c26a02014-06-03 13:18:18 -0400619 unsigned char cmnd[SG_MAX_CDB_SIZE];
Jann Hornb6db8af2018-06-25 16:25:44 +0200620 int retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621
Jann Hornb6db8af2018-06-25 16:25:44 +0200622 retval = sg_check_file_access(filp, __func__);
623 if (retval)
624 return retval;
Al Viro3f3a6bb2016-12-16 13:42:06 -0500625
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
627 return -ENXIO;
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200628 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
629 "sg_write: count=%d\n", (int) count));
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200630 if (atomic_read(&sdp->detaching))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631 return -ENODEV;
632 if (!((filp->f_flags & O_NONBLOCK) ||
633 scsi_block_when_processing_errors(sdp->device)))
634 return -ENXIO;
635
636 if (!access_ok(VERIFY_READ, buf, count))
637 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
638 if (count < SZ_SG_HEADER)
639 return -EIO;
640 if (__copy_from_user(&old_hdr, buf, SZ_SG_HEADER))
641 return -EFAULT;
642 blocking = !(filp->f_flags & O_NONBLOCK);
643 if (old_hdr.reply_len < 0)
Tony Battersbya2dd3b42009-01-20 17:00:09 -0500644 return sg_new_write(sfp, filp, buf, count,
645 blocking, 0, 0, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646 if (count < (SZ_SG_HEADER + 6))
647 return -EIO; /* The minimum scsi command length is 6 bytes. */
648
649 if (!(srp = sg_add_request(sfp))) {
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200650 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO, sdp,
651 "sg_write: queue full\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652 return -EDOM;
653 }
654 buf += SZ_SG_HEADER;
655 __get_user(opcode, buf);
Hannes Reinecke4099ac92017-04-07 09:34:14 +0200656 mutex_lock(&sfp->f_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 if (sfp->next_cmd_len > 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 cmd_size = sfp->next_cmd_len;
659 sfp->next_cmd_len = 0; /* reset so only this write() effected */
660 } else {
661 cmd_size = COMMAND_SIZE(opcode); /* based on SCSI command group */
662 if ((opcode >= 0xc0) && old_hdr.twelve_byte)
663 cmd_size = 12;
664 }
Hannes Reinecke4099ac92017-04-07 09:34:14 +0200665 mutex_unlock(&sfp->f_mutex);
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200666 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sdp,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 "sg_write: scsi opcode=0x%02x, cmd_size=%d\n", (int) opcode, cmd_size));
668/* Determine buffer size. */
669 input_size = count - cmd_size;
670 mxsize = (input_size > old_hdr.reply_len) ? input_size : old_hdr.reply_len;
671 mxsize -= SZ_SG_HEADER;
672 input_size -= SZ_SG_HEADER;
673 if (input_size < 0) {
674 sg_remove_request(sfp, srp);
675 return -EIO; /* User did not pass enough bytes for this command. */
676 }
677 hp = &srp->header;
678 hp->interface_id = '\0'; /* indicator of old interface tunnelled */
679 hp->cmd_len = (unsigned char) cmd_size;
680 hp->iovec_count = 0;
681 hp->mx_sb_len = 0;
682 if (input_size > 0)
683 hp->dxfer_direction = (old_hdr.reply_len > SZ_SG_HEADER) ?
684 SG_DXFER_TO_FROM_DEV : SG_DXFER_TO_DEV;
685 else
686 hp->dxfer_direction = (mxsize > 0) ? SG_DXFER_FROM_DEV : SG_DXFER_NONE;
687 hp->dxfer_len = mxsize;
Douglas Gilbert5ecee0a2016-03-03 00:31:29 -0500688 if ((hp->dxfer_direction == SG_DXFER_TO_DEV) ||
689 (hp->dxfer_direction == SG_DXFER_TO_FROM_DEV))
FUJITA Tomonorifad7f012008-09-02 16:20:20 +0900690 hp->dxferp = (char __user *)buf + cmd_size;
691 else
692 hp->dxferp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693 hp->sbp = NULL;
694 hp->timeout = old_hdr.reply_len; /* structure abuse ... */
695 hp->flags = input_size; /* structure abuse ... */
696 hp->pack_id = old_hdr.pack_id;
697 hp->usr_ptr = NULL;
698 if (__copy_from_user(cmnd, buf, cmd_size))
699 return -EFAULT;
700 /*
701 * SG_DXFER_TO_FROM_DEV is functionally equivalent to SG_DXFER_FROM_DEV,
702 * but is is possible that the app intended SG_DXFER_TO_DEV, because there
703 * is a non-zero input_size, so emit a warning.
704 */
Andi Kleeneaa3e222008-01-13 17:41:43 +0100705 if (hp->dxfer_direction == SG_DXFER_TO_FROM_DEV) {
Johannes Thumshirn602f9332017-04-07 09:34:15 +0200706 printk_ratelimited(KERN_WARNING
707 "sg_write: data in/out %d/%d bytes "
708 "for SCSI command 0x%x-- guessing "
709 "data in;\n program %s not setting "
710 "count and/or reply_len properly\n",
711 old_hdr.reply_len - (int)SZ_SG_HEADER,
712 input_size, (unsigned int) cmnd[0],
713 current->comm);
Andi Kleeneaa3e222008-01-13 17:41:43 +0100714 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715 k = sg_common_write(sfp, srp, cmnd, sfp->timeout, blocking);
716 return (k < 0) ? k : count;
717}
718
719static ssize_t
Adel Gadllah0b07de82008-06-26 13:48:27 +0200720sg_new_write(Sg_fd *sfp, struct file *file, const char __user *buf,
Tony Battersbya2dd3b42009-01-20 17:00:09 -0500721 size_t count, int blocking, int read_only, int sg_io_owned,
Adel Gadllah0b07de82008-06-26 13:48:27 +0200722 Sg_request **o_srp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723{
724 int k;
725 Sg_request *srp;
726 sg_io_hdr_t *hp;
Douglas Gilbert65c26a02014-06-03 13:18:18 -0400727 unsigned char cmnd[SG_MAX_CDB_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728 int timeout;
729 unsigned long ul_timeout;
730
731 if (count < SZ_SG_IO_HDR)
732 return -EINVAL;
733 if (!access_ok(VERIFY_READ, buf, count))
734 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
735
736 sfp->cmd_q = 1; /* when sg_io_hdr seen, set command queuing on */
737 if (!(srp = sg_add_request(sfp))) {
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200738 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO, sfp->parentdp,
739 "sg_new_write: queue full\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740 return -EDOM;
741 }
Tony Battersbya2dd3b42009-01-20 17:00:09 -0500742 srp->sg_io_owned = sg_io_owned;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 hp = &srp->header;
744 if (__copy_from_user(hp, buf, SZ_SG_IO_HDR)) {
745 sg_remove_request(sfp, srp);
746 return -EFAULT;
747 }
748 if (hp->interface_id != 'S') {
749 sg_remove_request(sfp, srp);
750 return -ENOSYS;
751 }
752 if (hp->flags & SG_FLAG_MMAP_IO) {
753 if (hp->dxfer_len > sfp->reserve.bufflen) {
754 sg_remove_request(sfp, srp);
755 return -ENOMEM; /* MMAP_IO size must fit in reserve buffer */
756 }
757 if (hp->flags & SG_FLAG_DIRECT_IO) {
758 sg_remove_request(sfp, srp);
759 return -EINVAL; /* either MMAP_IO or DIRECT_IO (not both) */
760 }
Hannes Reinecke4099ac92017-04-07 09:34:14 +0200761 if (sfp->res_in_use) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762 sg_remove_request(sfp, srp);
763 return -EBUSY; /* reserve buffer already being used */
764 }
765 }
766 ul_timeout = msecs_to_jiffies(srp->header.timeout);
767 timeout = (ul_timeout < INT_MAX) ? ul_timeout : INT_MAX;
768 if ((!hp->cmdp) || (hp->cmd_len < 6) || (hp->cmd_len > sizeof (cmnd))) {
769 sg_remove_request(sfp, srp);
770 return -EMSGSIZE;
771 }
772 if (!access_ok(VERIFY_READ, hp->cmdp, hp->cmd_len)) {
773 sg_remove_request(sfp, srp);
774 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
775 }
776 if (__copy_from_user(cmnd, hp->cmdp, hp->cmd_len)) {
777 sg_remove_request(sfp, srp);
778 return -EFAULT;
779 }
FUJITA Tomonori14e507b2008-07-26 18:03:24 +0900780 if (read_only && sg_allow_access(file, cmnd)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781 sg_remove_request(sfp, srp);
782 return -EPERM;
783 }
784 k = sg_common_write(sfp, srp, cmnd, timeout, blocking);
785 if (k < 0)
786 return k;
787 if (o_srp)
788 *o_srp = srp;
789 return count;
790}
791
792static int
793sg_common_write(Sg_fd * sfp, Sg_request * srp,
794 unsigned char *cmnd, int timeout, int blocking)
795{
Bart Van Assche5af2e382015-01-30 16:22:38 +0100796 int k, at_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797 Sg_device *sdp = sfp->parentdp;
798 sg_io_hdr_t *hp = &srp->header;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799
800 srp->data.cmd_opcode = cmnd[0]; /* hold opcode of command */
801 hp->status = 0;
802 hp->masked_status = 0;
803 hp->msg_status = 0;
804 hp->info = 0;
805 hp->host_status = 0;
806 hp->driver_status = 0;
807 hp->resid = 0;
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200808 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
809 "sg_common_write: scsi opcode=0x%02x, cmd_size=%d\n",
810 (int) cmnd[0], (int) hp->cmd_len));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811
Johannes Thumshirn887cb852017-07-27 09:11:26 +0200812 if (hp->dxfer_len >= SZ_256M)
Johannes Thumshirn602f9332017-04-07 09:34:15 +0200813 return -EINVAL;
814
FUJITA Tomonori10865df2008-08-28 16:17:07 +0900815 k = sg_start_req(srp, cmnd);
816 if (k) {
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200817 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO, sfp->parentdp,
818 "sg_common_write: start_req err=%d\n", k));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819 sg_finish_rem_req(srp);
Hannes Reineckeae9b6ae2017-04-07 09:34:17 +0200820 sg_remove_request(sfp, srp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821 return k; /* probably out of space --> ENOMEM */
822 }
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200823 if (atomic_read(&sdp->detaching)) {
Calvin Owensf3951a32015-10-30 16:57:00 -0700824 if (srp->bio) {
825 if (srp->rq->cmd != srp->rq->__cmd)
826 kfree(srp->rq->cmd);
827
FUJITA Tomonoricaf19d32010-07-22 09:36:51 +0900828 blk_end_request_all(srp->rq, -EIO);
Calvin Owensf3951a32015-10-30 16:57:00 -0700829 srp->rq = NULL;
830 }
831
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 sg_finish_rem_req(srp);
Hannes Reineckeae9b6ae2017-04-07 09:34:17 +0200833 sg_remove_request(sfp, srp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834 return -ENODEV;
835 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836
cb59e842005-04-02 13:51:23 -0600837 hp->duration = jiffies_to_msecs(jiffies);
Douglas Gilbert16070cc2014-06-04 10:58:30 -0400838 if (hp->interface_id != '\0' && /* v3 (or later) interface */
839 (SG_FLAG_Q_AT_TAIL & hp->flags))
840 at_head = 0;
841 else
842 at_head = 1;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +0200843
Subhash Jadavani70e75882016-08-12 16:44:37 -0700844 if (likely(!sdp->device->timeout_override))
845 srp->rq->timeout = timeout;
846 else
847 srp->rq->timeout = sdp->device->timeout_override;
848
Tony Battersbyc6517b792009-01-21 14:45:50 -0500849 kref_get(&sfp->f_ref); /* sg_rq_end_io() does kref_put(). */
FUJITA Tomonori10db10d2008-08-29 12:32:18 +0200850 blk_execute_rq_nowait(sdp->device->request_queue, sdp->disk,
Douglas Gilbert16070cc2014-06-04 10:58:30 -0400851 srp->rq, at_head, sg_rq_end_io);
FUJITA Tomonori10db10d2008-08-29 12:32:18 +0200852 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853}
854
Jörn Engel6acddc52012-04-12 17:33:58 -0400855static int srp_done(Sg_fd *sfp, Sg_request *srp)
856{
857 unsigned long flags;
858 int ret;
859
860 read_lock_irqsave(&sfp->rq_list_lock, flags);
861 ret = srp->done;
862 read_unlock_irqrestore(&sfp->rq_list_lock, flags);
863 return ret;
864}
865
Akinobu Mita46f69e62014-06-02 22:56:46 +0900866static int max_sectors_bytes(struct request_queue *q)
867{
868 unsigned int max_sectors = queue_max_sectors(q);
869
870 max_sectors = min_t(unsigned int, max_sectors, INT_MAX >> 9);
871
872 return max_sectors << 9;
873}
874
Hannes Reinecke25d5a8a2017-09-15 14:05:15 +0200875static void
876sg_fill_request_table(Sg_fd *sfp, sg_req_info_t *rinfo)
877{
878 Sg_request *srp;
879 int val;
880 unsigned int ms;
881
882 val = 0;
883 list_for_each_entry(srp, &sfp->rq_list, entry) {
Ben Hutchings5a0dbfe2017-10-15 18:16:33 +0100884 if (val >= SG_MAX_QUEUE)
Hannes Reinecke25d5a8a2017-09-15 14:05:15 +0200885 break;
Hannes Reinecke25d5a8a2017-09-15 14:05:15 +0200886 rinfo[val].req_state = srp->done + 1;
887 rinfo[val].problem =
888 srp->header.masked_status &
889 srp->header.host_status &
890 srp->header.driver_status;
891 if (srp->done)
892 rinfo[val].duration =
893 srp->header.duration;
894 else {
895 ms = jiffies_to_msecs(jiffies);
896 rinfo[val].duration =
897 (ms > srp->header.duration) ?
898 (ms - srp->header.duration) : 0;
899 }
900 rinfo[val].orphan = srp->orphan;
901 rinfo[val].sg_io_owned = srp->sg_io_owned;
902 rinfo[val].pack_id = srp->header.pack_id;
903 rinfo[val].usr_ptr = srp->header.usr_ptr;
904 val++;
905 }
906}
907
Jörn Engel37b9d1e2012-04-12 17:35:05 -0400908static long
Arnd Bergmannf4927c42010-04-27 00:24:01 +0200909sg_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910{
911 void __user *p = (void __user *)arg;
912 int __user *ip = p;
Christoph Hellwig176aa9d2014-10-11 12:06:47 +0200913 int result, val, read_only;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914 Sg_device *sdp;
915 Sg_fd *sfp;
916 Sg_request *srp;
917 unsigned long iflags;
918
919 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
920 return -ENXIO;
FUJITA Tomonoriabf54392008-08-16 14:10:05 +0900921
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200922 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
923 "sg_ioctl: cmd=0x%x\n", (int) cmd_in));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924 read_only = (O_RDWR != (filp->f_flags & O_ACCMODE));
925
926 switch (cmd_in) {
927 case SG_IO:
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200928 if (atomic_read(&sdp->detaching))
Jörn Engeldddbf8d2012-04-12 17:32:17 -0400929 return -ENODEV;
930 if (!scsi_block_when_processing_errors(sdp->device))
931 return -ENXIO;
932 if (!access_ok(VERIFY_WRITE, p, SZ_SG_IO_HDR))
933 return -EFAULT;
Robb Glasser0575f152017-03-24 16:23:37 -0700934 mutex_lock(&sfp->parentdp->open_rel_lock);
Jörn Engeldddbf8d2012-04-12 17:32:17 -0400935 result = sg_new_write(sfp, filp, p, SZ_SG_IO_HDR,
936 1, read_only, 1, &srp);
Robb Glasser0575f152017-03-24 16:23:37 -0700937 mutex_unlock(&sfp->parentdp->open_rel_lock);
Jörn Engeldddbf8d2012-04-12 17:32:17 -0400938 if (result < 0)
939 return result;
Jörn Engel3f0c6ab2012-04-12 17:33:25 -0400940 result = wait_event_interruptible(sfp->read_wait,
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200941 (srp_done(sfp, srp) || atomic_read(&sdp->detaching)));
942 if (atomic_read(&sdp->detaching))
Jörn Engel794c10f2012-04-12 17:32:48 -0400943 return -ENODEV;
944 write_lock_irq(&sfp->rq_list_lock);
945 if (srp->done) {
946 srp->done = 2;
Jörn Engeldddbf8d2012-04-12 17:32:17 -0400947 write_unlock_irq(&sfp->rq_list_lock);
Jörn Engel794c10f2012-04-12 17:32:48 -0400948 result = sg_new_read(sfp, p, SZ_SG_IO_HDR, srp);
949 return (result < 0) ? result : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950 }
Jörn Engel794c10f2012-04-12 17:32:48 -0400951 srp->orphan = 1;
952 write_unlock_irq(&sfp->rq_list_lock);
953 return result; /* -ERESTARTSYS because signal hit process */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954 case SG_SET_TIMEOUT:
955 result = get_user(val, ip);
956 if (result)
957 return result;
958 if (val < 0)
959 return -EIO;
Paul Burtonf8630bd72016-08-19 17:43:57 +0100960 if (val >= mult_frac((s64)INT_MAX, USER_HZ, HZ))
961 val = min_t(s64, mult_frac((s64)INT_MAX, USER_HZ, HZ),
Paul Burtonb9b6e802016-08-19 17:43:56 +0100962 INT_MAX);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963 sfp->timeout_user = val;
Paul Burtonf8630bd72016-08-19 17:43:57 +0100964 sfp->timeout = mult_frac(val, HZ, USER_HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965
966 return 0;
967 case SG_GET_TIMEOUT: /* N.B. User receives timeout as return value */
968 /* strange ..., for backward compatibility */
969 return sfp->timeout_user;
970 case SG_SET_FORCE_LOW_DMA:
Hannes Reineckebb7119e2017-04-07 09:34:12 +0200971 /*
972 * N.B. This ioctl never worked properly, but failed to
973 * return an error value. So returning '0' to keep compability
974 * with legacy applications.
975 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976 return 0;
977 case SG_GET_LOW_DMA:
Hannes Reineckebb7119e2017-04-07 09:34:12 +0200978 return put_user((int) sdp->device->host->unchecked_isa_dma, ip);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979 case SG_GET_SCSI_ID:
980 if (!access_ok(VERIFY_WRITE, p, sizeof (sg_scsi_id_t)))
981 return -EFAULT;
982 else {
983 sg_scsi_id_t __user *sg_idp = p;
984
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200985 if (atomic_read(&sdp->detaching))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986 return -ENODEV;
987 __put_user((int) sdp->device->host->host_no,
988 &sg_idp->host_no);
989 __put_user((int) sdp->device->channel,
990 &sg_idp->channel);
991 __put_user((int) sdp->device->id, &sg_idp->scsi_id);
992 __put_user((int) sdp->device->lun, &sg_idp->lun);
993 __put_user((int) sdp->device->type, &sg_idp->scsi_type);
994 __put_user((short) sdp->device->host->cmd_per_lun,
995 &sg_idp->h_cmd_per_lun);
996 __put_user((short) sdp->device->queue_depth,
997 &sg_idp->d_queue_depth);
998 __put_user(0, &sg_idp->unused[0]);
999 __put_user(0, &sg_idp->unused[1]);
1000 return 0;
1001 }
1002 case SG_SET_FORCE_PACK_ID:
1003 result = get_user(val, ip);
1004 if (result)
1005 return result;
1006 sfp->force_packid = val ? 1 : 0;
1007 return 0;
1008 case SG_GET_PACK_ID:
1009 if (!access_ok(VERIFY_WRITE, ip, sizeof (int)))
1010 return -EFAULT;
1011 read_lock_irqsave(&sfp->rq_list_lock, iflags);
Hannes Reinecke2b2d86b2017-04-07 09:34:16 +02001012 list_for_each_entry(srp, &sfp->rq_list, entry) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013 if ((1 == srp->done) && (!srp->sg_io_owned)) {
1014 read_unlock_irqrestore(&sfp->rq_list_lock,
1015 iflags);
1016 __put_user(srp->header.pack_id, ip);
1017 return 0;
1018 }
1019 }
1020 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1021 __put_user(-1, ip);
1022 return 0;
1023 case SG_GET_NUM_WAITING:
1024 read_lock_irqsave(&sfp->rq_list_lock, iflags);
Hannes Reinecke2b2d86b2017-04-07 09:34:16 +02001025 val = 0;
1026 list_for_each_entry(srp, &sfp->rq_list, entry) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027 if ((1 == srp->done) && (!srp->sg_io_owned))
1028 ++val;
1029 }
1030 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1031 return put_user(val, ip);
1032 case SG_GET_SG_TABLESIZE:
1033 return put_user(sdp->sg_tablesize, ip);
1034 case SG_SET_RESERVED_SIZE:
1035 result = get_user(val, ip);
1036 if (result)
1037 return result;
Robb Glasser0575f152017-03-24 16:23:37 -07001038 if (val < 0)
1039 return -EINVAL;
Alan Stern44ec9542007-02-20 11:01:57 -05001040 val = min_t(int, val,
Akinobu Mita46f69e62014-06-02 22:56:46 +09001041 max_sectors_bytes(sdp->device->request_queue));
Hannes Reinecke4099ac92017-04-07 09:34:14 +02001042 mutex_lock(&sfp->f_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043 if (val != sfp->reserve.bufflen) {
Hannes Reinecke4099ac92017-04-07 09:34:14 +02001044 if (sfp->mmap_called ||
1045 sfp->res_in_use) {
1046 mutex_unlock(&sfp->f_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047 return -EBUSY;
Hannes Reinecke4099ac92017-04-07 09:34:14 +02001048 }
Robb Glasser0575f152017-03-24 16:23:37 -07001049 mutex_lock(&sfp->parentdp->open_rel_lock);
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001050 sg_remove_scat(sfp, &sfp->reserve);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051 sg_build_reserve(sfp, val);
Robb Glasser0575f152017-03-24 16:23:37 -07001052 mutex_unlock(&sfp->parentdp->open_rel_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053 }
Hannes Reinecke4099ac92017-04-07 09:34:14 +02001054 mutex_unlock(&sfp->f_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055 return 0;
1056 case SG_GET_RESERVED_SIZE:
Alan Stern44ec9542007-02-20 11:01:57 -05001057 val = min_t(int, sfp->reserve.bufflen,
Akinobu Mita46f69e62014-06-02 22:56:46 +09001058 max_sectors_bytes(sdp->device->request_queue));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059 return put_user(val, ip);
1060 case SG_SET_COMMAND_Q:
1061 result = get_user(val, ip);
1062 if (result)
1063 return result;
1064 sfp->cmd_q = val ? 1 : 0;
1065 return 0;
1066 case SG_GET_COMMAND_Q:
1067 return put_user((int) sfp->cmd_q, ip);
1068 case SG_SET_KEEP_ORPHAN:
1069 result = get_user(val, ip);
1070 if (result)
1071 return result;
1072 sfp->keep_orphan = val;
1073 return 0;
1074 case SG_GET_KEEP_ORPHAN:
1075 return put_user((int) sfp->keep_orphan, ip);
1076 case SG_NEXT_CMD_LEN:
1077 result = get_user(val, ip);
1078 if (result)
1079 return result;
peter changc2a86952017-02-15 14:11:54 -08001080 if (val > SG_MAX_CDB_SIZE)
1081 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082 sfp->next_cmd_len = (val > 0) ? val : 0;
1083 return 0;
1084 case SG_GET_VERSION_NUM:
1085 return put_user(sg_version_num, ip);
1086 case SG_GET_ACCESS_COUNT:
1087 /* faked - we don't have a real access count anymore */
1088 val = (sdp->device ? 1 : 0);
1089 return put_user(val, ip);
1090 case SG_GET_REQUEST_TABLE:
1091 if (!access_ok(VERIFY_WRITE, p, SZ_SG_REQ_INFO * SG_MAX_QUEUE))
1092 return -EFAULT;
1093 else {
cb59e842005-04-02 13:51:23 -06001094 sg_req_info_t *rinfo;
cb59e842005-04-02 13:51:23 -06001095
Hannes Reinecke90cb12f2017-09-15 14:05:16 +02001096 rinfo = kzalloc(SZ_SG_REQ_INFO * SG_MAX_QUEUE,
1097 GFP_KERNEL);
cb59e842005-04-02 13:51:23 -06001098 if (!rinfo)
1099 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100 read_lock_irqsave(&sfp->rq_list_lock, iflags);
Hannes Reinecke25d5a8a2017-09-15 14:05:15 +02001101 sg_fill_request_table(sfp, rinfo);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
Robb Glasser0575f152017-03-24 16:23:37 -07001103 result = __copy_to_user(p, rinfo,
cb59e842005-04-02 13:51:23 -06001104 SZ_SG_REQ_INFO * SG_MAX_QUEUE);
1105 result = result ? -EFAULT : 0;
1106 kfree(rinfo);
1107 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001108 }
1109 case SG_EMULATED_HOST:
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001110 if (atomic_read(&sdp->detaching))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001111 return -ENODEV;
1112 return put_user(sdp->device->host->hostt->emulated, ip);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001113 case SCSI_IOCTL_SEND_COMMAND:
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001114 if (atomic_read(&sdp->detaching))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115 return -ENODEV;
1116 if (read_only) {
1117 unsigned char opcode = WRITE_6;
1118 Scsi_Ioctl_Command __user *siocp = p;
1119
1120 if (copy_from_user(&opcode, siocp->data, 1))
1121 return -EFAULT;
FUJITA Tomonori14e507b2008-07-26 18:03:24 +09001122 if (sg_allow_access(filp, &opcode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001123 return -EPERM;
1124 }
Al Viroe915e872008-09-02 17:16:41 -04001125 return sg_scsi_ioctl(sdp->device->request_queue, NULL, filp->f_mode, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001126 case SG_SET_DEBUG:
1127 result = get_user(val, ip);
1128 if (result)
1129 return result;
1130 sdp->sgdebug = (char) val;
1131 return 0;
Alan Stern44ec9542007-02-20 11:01:57 -05001132 case BLKSECTGET:
Akinobu Mita46f69e62014-06-02 22:56:46 +09001133 return put_user(max_sectors_bytes(sdp->device->request_queue),
Alan Stern44ec9542007-02-20 11:01:57 -05001134 ip);
Christof Schmitt6da127a2008-01-11 10:09:43 +01001135 case BLKTRACESETUP:
1136 return blk_trace_setup(sdp->device->request_queue,
1137 sdp->disk->disk_name,
Martin Peschke76e3a192009-01-30 15:46:23 +01001138 MKDEV(SCSI_GENERIC_MAJOR, sdp->index),
Shawn Dud0deef52009-04-14 13:58:56 +08001139 NULL,
Christof Schmitt6da127a2008-01-11 10:09:43 +01001140 (char *)arg);
1141 case BLKTRACESTART:
1142 return blk_trace_startstop(sdp->device->request_queue, 1);
1143 case BLKTRACESTOP:
1144 return blk_trace_startstop(sdp->device->request_queue, 0);
1145 case BLKTRACETEARDOWN:
1146 return blk_trace_remove(sdp->device->request_queue);
Christoph Hellwig906d15f2014-10-11 16:25:31 +02001147 case SCSI_IOCTL_GET_IDLUN:
1148 case SCSI_IOCTL_GET_BUS_NUMBER:
1149 case SCSI_IOCTL_PROBE_HOST:
1150 case SG_GET_TRANSFORM:
1151 case SG_SCSI_RESET:
1152 if (atomic_read(&sdp->detaching))
1153 return -ENODEV;
1154 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155 default:
1156 if (read_only)
1157 return -EPERM; /* don't know so take safe approach */
Christoph Hellwig906d15f2014-10-11 16:25:31 +02001158 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159 }
Christoph Hellwig906d15f2014-10-11 16:25:31 +02001160
1161 result = scsi_ioctl_block_when_processing_errors(sdp->device,
1162 cmd_in, filp->f_flags & O_NDELAY);
1163 if (result)
1164 return result;
1165 return scsi_ioctl(sdp->device, cmd_in, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166}
1167
1168#ifdef CONFIG_COMPAT
1169static long sg_compat_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
1170{
1171 Sg_device *sdp;
1172 Sg_fd *sfp;
1173 struct scsi_device *sdev;
1174
1175 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1176 return -ENXIO;
1177
1178 sdev = sdp->device;
Robb Glasser0575f152017-03-24 16:23:37 -07001179 if (sdev->host->hostt->compat_ioctl) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180 int ret;
1181
1182 ret = sdev->host->hostt->compat_ioctl(sdev, cmd_in, (void __user *)arg);
1183
1184 return ret;
1185 }
Robb Glasser0575f152017-03-24 16:23:37 -07001186
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187 return -ENOIOCTLCMD;
1188}
1189#endif
1190
1191static unsigned int
1192sg_poll(struct file *filp, poll_table * wait)
1193{
1194 unsigned int res = 0;
1195 Sg_device *sdp;
1196 Sg_fd *sfp;
1197 Sg_request *srp;
1198 int count = 0;
1199 unsigned long iflags;
1200
Jörn Engelebaf4662012-04-12 17:33:39 -04001201 sfp = filp->private_data;
1202 if (!sfp)
1203 return POLLERR;
1204 sdp = sfp->parentdp;
1205 if (!sdp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206 return POLLERR;
1207 poll_wait(filp, &sfp->read_wait, wait);
1208 read_lock_irqsave(&sfp->rq_list_lock, iflags);
Hannes Reinecke2b2d86b2017-04-07 09:34:16 +02001209 list_for_each_entry(srp, &sfp->rq_list, entry) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001210 /* if any read waiting, flag it */
1211 if ((0 == res) && (1 == srp->done) && (!srp->sg_io_owned))
1212 res = POLLIN | POLLRDNORM;
1213 ++count;
1214 }
1215 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1216
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001217 if (atomic_read(&sdp->detaching))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218 res |= POLLHUP;
1219 else if (!sfp->cmd_q) {
1220 if (0 == count)
1221 res |= POLLOUT | POLLWRNORM;
1222 } else if (count < SG_MAX_QUEUE)
1223 res |= POLLOUT | POLLWRNORM;
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001224 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
1225 "sg_poll: res=0x%x\n", (int) res));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226 return res;
1227}
1228
1229static int
1230sg_fasync(int fd, struct file *filp, int mode)
1231{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232 Sg_device *sdp;
1233 Sg_fd *sfp;
1234
1235 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1236 return -ENXIO;
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001237 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
1238 "sg_fasync: mode=%d\n", mode));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001239
Jonathan Corbet60aa4922009-02-01 14:52:56 -07001240 return fasync_helper(fd, filp, mode, &sfp->async_qp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241}
1242
Nick Piggina13ff0b2008-02-07 18:46:06 -08001243static int
1244sg_vma_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001245{
1246 Sg_fd *sfp;
Mike Christied6b10342005-11-08 04:06:41 -06001247 unsigned long offset, len, sa;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248 Sg_scatter_hold *rsv_schp;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001249 int k, length;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001250
1251 if ((NULL == vma) || (!(sfp = (Sg_fd *) vma->vm_private_data)))
Nick Piggina13ff0b2008-02-07 18:46:06 -08001252 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253 rsv_schp = &sfp->reserve;
Nick Piggina13ff0b2008-02-07 18:46:06 -08001254 offset = vmf->pgoff << PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255 if (offset >= rsv_schp->bufflen)
Nick Piggina13ff0b2008-02-07 18:46:06 -08001256 return VM_FAULT_SIGBUS;
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001257 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sfp->parentdp,
1258 "sg_vma_fault: offset=%lu, scatg=%d\n",
1259 offset, rsv_schp->k_use_sg));
Mike Christied6b10342005-11-08 04:06:41 -06001260 sa = vma->vm_start;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001261 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1262 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
Mike Christied6b10342005-11-08 04:06:41 -06001263 len = vma->vm_end - sa;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001264 len = (len < length) ? len : length;
Mike Christied6b10342005-11-08 04:06:41 -06001265 if (offset < len) {
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001266 struct page *page = nth_page(rsv_schp->pages[k],
1267 offset >> PAGE_SHIFT);
Mike Christied6b10342005-11-08 04:06:41 -06001268 get_page(page); /* increment page count */
Nick Piggina13ff0b2008-02-07 18:46:06 -08001269 vmf->page = page;
1270 return 0; /* success */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271 }
Mike Christied6b10342005-11-08 04:06:41 -06001272 sa += len;
1273 offset -= len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274 }
Mike Christied6b10342005-11-08 04:06:41 -06001275
Nick Piggina13ff0b2008-02-07 18:46:06 -08001276 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277}
1278
Alexey Dobriyanf0f37e22009-09-27 22:29:37 +04001279static const struct vm_operations_struct sg_mmap_vm_ops = {
Nick Piggina13ff0b2008-02-07 18:46:06 -08001280 .fault = sg_vma_fault,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281};
1282
1283static int
1284sg_mmap(struct file *filp, struct vm_area_struct *vma)
1285{
1286 Sg_fd *sfp;
Mike Christied6b10342005-11-08 04:06:41 -06001287 unsigned long req_sz, len, sa;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288 Sg_scatter_hold *rsv_schp;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001289 int k, length;
Todd Poynorb06e1ab2017-08-15 22:41:08 -07001290 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291
1292 if ((!filp) || (!vma) || (!(sfp = (Sg_fd *) filp->private_data)))
1293 return -ENXIO;
cb59e842005-04-02 13:51:23 -06001294 req_sz = vma->vm_end - vma->vm_start;
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001295 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sfp->parentdp,
1296 "sg_mmap starting, vm_start=%p, len=%d\n",
1297 (void *) vma->vm_start, (int) req_sz));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298 if (vma->vm_pgoff)
1299 return -EINVAL; /* want no offset */
1300 rsv_schp = &sfp->reserve;
Todd Poynorb06e1ab2017-08-15 22:41:08 -07001301 mutex_lock(&sfp->f_mutex);
1302 if (req_sz > rsv_schp->bufflen) {
1303 ret = -ENOMEM; /* cannot map more than reserved buffer */
1304 goto out;
1305 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306
Mike Christied6b10342005-11-08 04:06:41 -06001307 sa = vma->vm_start;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001308 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1309 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
Mike Christied6b10342005-11-08 04:06:41 -06001310 len = vma->vm_end - sa;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001311 len = (len < length) ? len : length;
Mike Christied6b10342005-11-08 04:06:41 -06001312 sa += len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313 }
Mike Christied6b10342005-11-08 04:06:41 -06001314
Nick Pigginf9aed0e2006-03-22 00:08:30 -08001315 sfp->mmap_called = 1;
Kirill A. Shutemov461c7fa2016-02-02 16:57:35 -08001316 vma->vm_flags |= VM_IO | VM_DONTEXPAND | VM_DONTDUMP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317 vma->vm_private_data = sfp;
1318 vma->vm_ops = &sg_mmap_vm_ops;
Todd Poynorb06e1ab2017-08-15 22:41:08 -07001319out:
1320 mutex_unlock(&sfp->f_mutex);
1321 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322}
1323
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001324static void
1325sg_rq_end_io_usercontext(struct work_struct *work)
FUJITA Tomonoric96952e2009-02-04 11:36:27 +09001326{
1327 struct sg_request *srp = container_of(work, struct sg_request, ew.work);
1328 struct sg_fd *sfp = srp->parentfp;
1329
1330 sg_finish_rem_req(srp);
Hannes Reineckeae9b6ae2017-04-07 09:34:17 +02001331 sg_remove_request(sfp, srp);
FUJITA Tomonoric96952e2009-02-04 11:36:27 +09001332 kref_put(&sfp->f_ref, sg_remove_sfp);
1333}
1334
FUJITA Tomonoria91a3a22008-09-02 22:50:01 +09001335/*
1336 * This function is a "bottom half" handler that is called by the mid
1337 * level when a command is completed (or has failed).
1338 */
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001339static void
1340sg_rq_end_io(struct request *rq, int uptodate)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341{
FUJITA Tomonoria91a3a22008-09-02 22:50:01 +09001342 struct sg_request *srp = rq->end_io_data;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001343 Sg_device *sdp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344 Sg_fd *sfp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345 unsigned long iflags;
cb59e842005-04-02 13:51:23 -06001346 unsigned int ms;
FUJITA Tomonoria91a3a22008-09-02 22:50:01 +09001347 char *sense;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001348 int result, resid, done = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349
Tony Battersbyc6517b792009-01-21 14:45:50 -05001350 if (WARN_ON(srp->done != 0))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351 return;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001352
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353 sfp = srp->parentfp;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001354 if (WARN_ON(sfp == NULL))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355 return;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001356
1357 sdp = sfp->parentdp;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001358 if (unlikely(atomic_read(&sdp->detaching)))
1359 pr_info("%s: device detaching\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360
FUJITA Tomonoria91a3a22008-09-02 22:50:01 +09001361 sense = rq->sense;
1362 result = rq->errors;
Tejun Heoc3a4d782009-05-07 22:24:37 +09001363 resid = rq->resid_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001365 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sdp,
1366 "sg_cmd_done: pack_id=%d, res=0x%x\n",
1367 srp->header.pack_id, result));
Mike Christied6b10342005-11-08 04:06:41 -06001368 srp->header.resid = resid;
cb59e842005-04-02 13:51:23 -06001369 ms = jiffies_to_msecs(jiffies);
1370 srp->header.duration = (ms > srp->header.duration) ?
1371 (ms - srp->header.duration) : 0;
Mike Christied6b10342005-11-08 04:06:41 -06001372 if (0 != result) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373 struct scsi_sense_hdr sshdr;
1374
Mike Christied6b10342005-11-08 04:06:41 -06001375 srp->header.status = 0xff & result;
1376 srp->header.masked_status = status_byte(result);
1377 srp->header.msg_status = msg_byte(result);
1378 srp->header.host_status = host_byte(result);
1379 srp->header.driver_status = driver_byte(result);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380 if ((sdp->sgdebug > 0) &&
1381 ((CHECK_CONDITION == srp->header.masked_status) ||
1382 (COMMAND_TERMINATED == srp->header.masked_status)))
Hannes Reinecked811b842014-10-24 14:26:45 +02001383 __scsi_print_sense(sdp->device, __func__, sense,
Mike Christied6b10342005-11-08 04:06:41 -06001384 SCSI_SENSE_BUFFERSIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385
1386 /* Following if statement is a patch supplied by Eric Youngdale */
Mike Christied6b10342005-11-08 04:06:41 -06001387 if (driver_byte(result) != 0
1388 && scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, &sshdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389 && !scsi_sense_is_deferred(&sshdr)
1390 && sshdr.sense_key == UNIT_ATTENTION
1391 && sdp->device->removable) {
1392 /* Detected possible disc change. Set the bit - this */
1393 /* may be used if there are filesystems using this device */
1394 sdp->device->changed = 1;
1395 }
1396 }
1397 /* Rely on write phase to clean out srp status values, so no "else" */
1398
Tony Battersby75686152015-02-13 12:09:44 -05001399 /*
1400 * Free the request as soon as it is complete so that its resources
1401 * can be reused without waiting for userspace to read() the
1402 * result. But keep the associated bio (if any) around until
1403 * blk_rq_unmap_user() can be called from user context.
1404 */
1405 srp->rq = NULL;
1406 if (rq->cmd != rq->__cmd)
1407 kfree(rq->cmd);
1408 __blk_put_request(rq->q, rq);
1409
Tony Battersbyc6517b792009-01-21 14:45:50 -05001410 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1411 if (unlikely(srp->orphan)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412 if (sfp->keep_orphan)
1413 srp->sg_io_owned = 0;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001414 else
1415 done = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416 }
Tony Battersbyc6517b792009-01-21 14:45:50 -05001417 srp->done = done;
1418 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1419
1420 if (likely(done)) {
1421 /* Now wake up any sg_read() that is waiting for this
1422 * packet.
1423 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424 wake_up_interruptible(&sfp->read_wait);
Tony Battersbyc6517b792009-01-21 14:45:50 -05001425 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_IN);
FUJITA Tomonoric96952e2009-02-04 11:36:27 +09001426 kref_put(&sfp->f_ref, sg_remove_sfp);
FUJITA Tomonori015640e2009-04-03 19:28:06 +09001427 } else {
1428 INIT_WORK(&srp->ew.work, sg_rq_end_io_usercontext);
1429 schedule_work(&srp->ew.work);
1430 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431}
1432
Alexey Dobriyan828c0952009-10-01 15:43:56 -07001433static const struct file_operations sg_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434 .owner = THIS_MODULE,
1435 .read = sg_read,
1436 .write = sg_write,
1437 .poll = sg_poll,
Jörn Engel37b9d1e2012-04-12 17:35:05 -04001438 .unlocked_ioctl = sg_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439#ifdef CONFIG_COMPAT
1440 .compat_ioctl = sg_compat_ioctl,
1441#endif
1442 .open = sg_open,
1443 .mmap = sg_mmap,
1444 .release = sg_release,
1445 .fasync = sg_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001446 .llseek = no_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447};
1448
gregkh@suse.ded2538782005-03-23 09:55:22 -08001449static struct class *sg_sysfs_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450
1451static int sg_sysfs_valid = 0;
1452
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001453static Sg_device *
1454sg_alloc(struct gendisk *disk, struct scsi_device *scsidp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455{
Mike Christied6b10342005-11-08 04:06:41 -06001456 struct request_queue *q = scsidp->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457 Sg_device *sdp;
1458 unsigned long iflags;
James Bottomley7c07d612007-08-05 13:36:11 -05001459 int error;
1460 u32 k;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001461
Jes Sorensen24669f752006-01-16 10:31:18 -05001462 sdp = kzalloc(sizeof(Sg_device), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463 if (!sdp) {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001464 sdev_printk(KERN_WARNING, scsidp, "%s: kmalloc Sg_device "
1465 "failure\n", __func__);
James Bottomley7c07d612007-08-05 13:36:11 -05001466 return ERR_PTR(-ENOMEM);
1467 }
Tony Battersbyc6517b792009-01-21 14:45:50 -05001468
Tejun Heob98c52b2013-02-27 17:04:42 -08001469 idr_preload(GFP_KERNEL);
James Bottomley7c07d612007-08-05 13:36:11 -05001470 write_lock_irqsave(&sg_index_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471
Tejun Heob98c52b2013-02-27 17:04:42 -08001472 error = idr_alloc(&sg_index_idr, sdp, 0, SG_MAX_DEVS, GFP_NOWAIT);
1473 if (error < 0) {
1474 if (error == -ENOSPC) {
1475 sdev_printk(KERN_WARNING, scsidp,
1476 "Unable to attach sg device type=%d, minor number exceeds %d\n",
1477 scsidp->type, SG_MAX_DEVS - 1);
1478 error = -ENODEV;
1479 } else {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001480 sdev_printk(KERN_WARNING, scsidp, "%s: idr "
1481 "allocation Sg_device failure: %d\n",
1482 __func__, error);
Tejun Heob98c52b2013-02-27 17:04:42 -08001483 }
1484 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001485 }
Tejun Heob98c52b2013-02-27 17:04:42 -08001486 k = error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001487
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001488 SCSI_LOG_TIMEOUT(3, sdev_printk(KERN_INFO, scsidp,
1489 "sg_alloc: dev=%d \n", k));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490 sprintf(disk->disk_name, "sg%d", k);
1491 disk->first_minor = k;
1492 sdp->disk = disk;
1493 sdp->device = scsidp;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001494 mutex_init(&sdp->open_rel_lock);
FUJITA Tomonori3442f802009-02-16 13:26:53 +09001495 INIT_LIST_HEAD(&sdp->sfds);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001496 init_waitqueue_head(&sdp->open_wait);
1497 atomic_set(&sdp->detaching, 0);
1498 rwlock_init(&sdp->sfd_lock);
Martin K. Petersen8a783622010-02-26 00:20:39 -05001499 sdp->sg_tablesize = queue_max_segments(q);
James Bottomley7c07d612007-08-05 13:36:11 -05001500 sdp->index = k;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001501 kref_init(&sdp->d_ref);
James Bottomley7c07d612007-08-05 13:36:11 -05001502 error = 0;
Tejun Heob98c52b2013-02-27 17:04:42 -08001503
1504out_unlock:
1505 write_unlock_irqrestore(&sg_index_lock, iflags);
1506 idr_preload_end();
1507
James Bottomley7c07d612007-08-05 13:36:11 -05001508 if (error) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509 kfree(sdp);
James Bottomley7c07d612007-08-05 13:36:11 -05001510 return ERR_PTR(error);
1511 }
1512 return sdp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513}
1514
1515static int
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001516sg_add_device(struct device *cl_dev, struct class_interface *cl_intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001517{
Tony Jonesee959b02008-02-22 00:13:36 +01001518 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519 struct gendisk *disk;
1520 Sg_device *sdp = NULL;
1521 struct cdev * cdev = NULL;
James Bottomley7c07d612007-08-05 13:36:11 -05001522 int error;
Ishai Rabinovitz454e8952006-06-29 16:39:54 +03001523 unsigned long iflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524
1525 disk = alloc_disk(1);
1526 if (!disk) {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001527 pr_warn("%s: alloc_disk failed\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528 return -ENOMEM;
1529 }
1530 disk->major = SCSI_GENERIC_MAJOR;
1531
1532 error = -ENOMEM;
1533 cdev = cdev_alloc();
1534 if (!cdev) {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001535 pr_warn("%s: cdev_alloc failed\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536 goto out;
1537 }
1538 cdev->owner = THIS_MODULE;
1539 cdev->ops = &sg_fops;
1540
James Bottomley7c07d612007-08-05 13:36:11 -05001541 sdp = sg_alloc(disk, scsidp);
1542 if (IS_ERR(sdp)) {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001543 pr_warn("%s: sg_alloc failed\n", __func__);
James Bottomley7c07d612007-08-05 13:36:11 -05001544 error = PTR_ERR(sdp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545 goto out;
1546 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001547
James Bottomley7c07d612007-08-05 13:36:11 -05001548 error = cdev_add(cdev, MKDEV(SCSI_GENERIC_MAJOR, sdp->index), 1);
Greg KH5e3c34c2006-01-18 16:17:46 -08001549 if (error)
Ishai Rabinovitz454e8952006-06-29 16:39:54 +03001550 goto cdev_add_err;
Greg KH5e3c34c2006-01-18 16:17:46 -08001551
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552 sdp->cdev = cdev;
1553 if (sg_sysfs_valid) {
Tony Jonesee959b02008-02-22 00:13:36 +01001554 struct device *sg_class_member;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001555
Greg Kroah-Hartmand73a1a62008-07-21 20:03:34 -07001556 sg_class_member = device_create(sg_sysfs_class, cl_dev->parent,
1557 MKDEV(SCSI_GENERIC_MAJOR,
1558 sdp->index),
1559 sdp, "%s", disk->disk_name);
FUJITA Tomonorid07e0362008-01-15 13:18:00 +09001560 if (IS_ERR(sg_class_member)) {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001561 pr_err("%s: device_create failed\n", __func__);
FUJITA Tomonorid07e0362008-01-15 13:18:00 +09001562 error = PTR_ERR(sg_class_member);
1563 goto cdev_add_err;
1564 }
FUJITA Tomonorid07e0362008-01-15 13:18:00 +09001565 error = sysfs_create_link(&scsidp->sdev_gendev.kobj,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566 &sg_class_member->kobj, "generic");
1567 if (error)
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001568 pr_err("%s: unable to make symlink 'generic' back "
1569 "to sg%d\n", __func__, sdp->index);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570 } else
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001571 pr_warn("%s: sg_sys Invalid\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572
Tony Jonesee959b02008-02-22 00:13:36 +01001573 dev_set_drvdata(cl_dev, sdp);
FUJITA Tomonoria24484f2008-01-15 13:17:47 +09001574
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575 return 0;
1576
Ishai Rabinovitz454e8952006-06-29 16:39:54 +03001577cdev_add_err:
James Bottomley7c07d612007-08-05 13:36:11 -05001578 write_lock_irqsave(&sg_index_lock, iflags);
1579 idr_remove(&sg_index_idr, sdp->index);
1580 write_unlock_irqrestore(&sg_index_lock, iflags);
1581 kfree(sdp);
Ishai Rabinovitz454e8952006-06-29 16:39:54 +03001582
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583out:
1584 put_disk(disk);
1585 if (cdev)
1586 cdev_del(cdev);
1587 return error;
1588}
1589
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001590static void
1591sg_device_destroy(struct kref *kref)
Tony Battersbyc6517b792009-01-21 14:45:50 -05001592{
1593 struct sg_device *sdp = container_of(kref, struct sg_device, d_ref);
1594 unsigned long flags;
1595
1596 /* CAUTION! Note that the device can still be found via idr_find()
1597 * even though the refcount is 0. Therefore, do idr_remove() BEFORE
1598 * any other cleanup.
1599 */
1600
1601 write_lock_irqsave(&sg_index_lock, flags);
1602 idr_remove(&sg_index_idr, sdp->index);
1603 write_unlock_irqrestore(&sg_index_lock, flags);
1604
1605 SCSI_LOG_TIMEOUT(3,
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001606 sg_printk(KERN_INFO, sdp, "sg_device_destroy\n"));
Tony Battersbyc6517b792009-01-21 14:45:50 -05001607
1608 put_disk(sdp->disk);
1609 kfree(sdp);
1610}
1611
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001612static void
1613sg_remove_device(struct device *cl_dev, struct class_interface *cl_intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614{
Tony Jonesee959b02008-02-22 00:13:36 +01001615 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
1616 Sg_device *sdp = dev_get_drvdata(cl_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617 unsigned long iflags;
1618 Sg_fd *sfp;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001619 int val;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001621 if (!sdp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622 return;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001623 /* want sdp->detaching non-zero as soon as possible */
1624 val = atomic_inc_return(&sdp->detaching);
1625 if (val > 1)
1626 return; /* only want to do following once per device */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001627
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001628 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
1629 "%s\n", __func__));
Tony Battersbyc6517b792009-01-21 14:45:50 -05001630
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001631 read_lock_irqsave(&sdp->sfd_lock, iflags);
FUJITA Tomonori3442f802009-02-16 13:26:53 +09001632 list_for_each_entry(sfp, &sdp->sfds, sfd_siblings) {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001633 wake_up_interruptible_all(&sfp->read_wait);
Tony Battersbyc6517b792009-01-21 14:45:50 -05001634 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_HUP);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001635 }
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001636 wake_up_interruptible_all(&sdp->open_wait);
1637 read_unlock_irqrestore(&sdp->sfd_lock, iflags);
James Bottomley7c07d612007-08-05 13:36:11 -05001638
1639 sysfs_remove_link(&scsidp->sdev_gendev.kobj, "generic");
Tony Jonesee959b02008-02-22 00:13:36 +01001640 device_destroy(sg_sysfs_class, MKDEV(SCSI_GENERIC_MAJOR, sdp->index));
James Bottomley7c07d612007-08-05 13:36:11 -05001641 cdev_del(sdp->cdev);
1642 sdp->cdev = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001644 kref_put(&sdp->d_ref, sg_device_destroy);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645}
1646
Douglas Gilbert6460e752006-09-20 18:20:49 -04001647module_param_named(scatter_elem_sz, scatter_elem_sz, int, S_IRUGO | S_IWUSR);
1648module_param_named(def_reserved_size, def_reserved_size, int,
1649 S_IRUGO | S_IWUSR);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650module_param_named(allow_dio, sg_allow_dio, int, S_IRUGO | S_IWUSR);
1651
1652MODULE_AUTHOR("Douglas Gilbert");
1653MODULE_DESCRIPTION("SCSI generic (sg) driver");
1654MODULE_LICENSE("GPL");
1655MODULE_VERSION(SG_VERSION_STR);
Rene Hermanf018fa52006-03-08 00:14:20 -08001656MODULE_ALIAS_CHARDEV_MAJOR(SCSI_GENERIC_MAJOR);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657
Douglas Gilbert6460e752006-09-20 18:20:49 -04001658MODULE_PARM_DESC(scatter_elem_sz, "scatter gather element "
1659 "size (default: max(SG_SCATTER_SZ, PAGE_SIZE))");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001660MODULE_PARM_DESC(def_reserved_size, "size of buffer reserved for each fd");
1661MODULE_PARM_DESC(allow_dio, "allow direct I/O (default: 0 (disallow))");
1662
1663static int __init
1664init_sg(void)
1665{
1666 int rc;
1667
Douglas Gilbert6460e752006-09-20 18:20:49 -04001668 if (scatter_elem_sz < PAGE_SIZE) {
1669 scatter_elem_sz = PAGE_SIZE;
1670 scatter_elem_sz_prev = scatter_elem_sz;
1671 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001672 if (def_reserved_size >= 0)
1673 sg_big_buff = def_reserved_size;
Douglas Gilbert6460e752006-09-20 18:20:49 -04001674 else
1675 def_reserved_size = sg_big_buff;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676
Robb Glasser0575f152017-03-24 16:23:37 -07001677 rc = register_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678 SG_MAX_DEVS, "sg");
1679 if (rc)
1680 return rc;
gregkh@suse.ded2538782005-03-23 09:55:22 -08001681 sg_sysfs_class = class_create(THIS_MODULE, "scsi_generic");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682 if ( IS_ERR(sg_sysfs_class) ) {
1683 rc = PTR_ERR(sg_sysfs_class);
1684 goto err_out;
1685 }
1686 sg_sysfs_valid = 1;
1687 rc = scsi_register_interface(&sg_interface);
1688 if (0 == rc) {
1689#ifdef CONFIG_SCSI_PROC_FS
1690 sg_proc_init();
1691#endif /* CONFIG_SCSI_PROC_FS */
1692 return 0;
1693 }
gregkh@suse.ded2538782005-03-23 09:55:22 -08001694 class_destroy(sg_sysfs_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001695err_out:
1696 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0), SG_MAX_DEVS);
1697 return rc;
1698}
1699
1700static void __exit
1701exit_sg(void)
1702{
1703#ifdef CONFIG_SCSI_PROC_FS
1704 sg_proc_cleanup();
1705#endif /* CONFIG_SCSI_PROC_FS */
1706 scsi_unregister_interface(&sg_interface);
gregkh@suse.ded2538782005-03-23 09:55:22 -08001707 class_destroy(sg_sysfs_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708 sg_sysfs_valid = 0;
1709 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1710 SG_MAX_DEVS);
James Bottomley7c07d612007-08-05 13:36:11 -05001711 idr_destroy(&sg_index_idr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001712}
1713
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001714static int
1715sg_start_req(Sg_request *srp, unsigned char *cmd)
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001716{
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001717 int res;
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001718 struct request *rq;
FUJITA Tomonori44c7b0e2008-09-02 22:50:04 +09001719 Sg_fd *sfp = srp->parentfp;
1720 sg_io_hdr_t *hp = &srp->header;
1721 int dxfer_len = (int) hp->dxfer_len;
1722 int dxfer_dir = hp->dxfer_direction;
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001723 unsigned int iov_count = hp->iovec_count;
FUJITA Tomonori44c7b0e2008-09-02 22:50:04 +09001724 Sg_scatter_hold *req_schp = &srp->data;
1725 Sg_scatter_hold *rsv_schp = &sfp->reserve;
1726 struct request_queue *q = sfp->parentdp->device->request_queue;
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001727 struct rq_map_data *md, map_data;
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001728 int rw = hp->dxfer_direction == SG_DXFER_TO_DEV ? WRITE : READ;
Douglas Gilbert65c26a02014-06-03 13:18:18 -04001729 unsigned char *long_cmdp = NULL;
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001730
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001731 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1732 "sg_start_req: dxfer_len=%d\n",
1733 dxfer_len));
FUJITA Tomonori44c7b0e2008-09-02 22:50:04 +09001734
Douglas Gilbert65c26a02014-06-03 13:18:18 -04001735 if (hp->cmd_len > BLK_MAX_CDB) {
1736 long_cmdp = kzalloc(hp->cmd_len, GFP_KERNEL);
1737 if (!long_cmdp)
1738 return -ENOMEM;
1739 }
1740
Tony Battersby77728552015-02-13 12:10:58 -05001741 /*
1742 * NOTE
1743 *
1744 * With scsi-mq enabled, there are a fixed number of preallocated
1745 * requests equal in number to shost->can_queue. If all of the
1746 * preallocated requests are already in use, then using GFP_ATOMIC with
1747 * blk_get_request() will return -EWOULDBLOCK, whereas using GFP_KERNEL
1748 * will cause blk_get_request() to sleep until an active command
1749 * completes, freeing up a request. Neither option is ideal, but
1750 * GFP_KERNEL is the better choice to prevent userspace from getting an
1751 * unexpected EWOULDBLOCK.
1752 *
1753 * With scsi-mq disabled, blk_get_request() with GFP_KERNEL usually
1754 * does not sleep except under memory pressure.
1755 */
1756 rq = blk_get_request(q, rw, GFP_KERNEL);
Joe Lawrencea492f072014-08-28 08:15:21 -06001757 if (IS_ERR(rq)) {
Douglas Gilbert65c26a02014-06-03 13:18:18 -04001758 kfree(long_cmdp);
Joe Lawrencea492f072014-08-28 08:15:21 -06001759 return PTR_ERR(rq);
Douglas Gilbert65c26a02014-06-03 13:18:18 -04001760 }
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001761
Jens Axboef27b0872014-06-06 07:57:37 -06001762 blk_rq_set_block_pc(rq);
Douglas Gilbert65c26a02014-06-03 13:18:18 -04001763
1764 if (hp->cmd_len > BLK_MAX_CDB)
1765 rq->cmd = long_cmdp;
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001766 memcpy(rq->cmd, cmd, hp->cmd_len);
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001767 rq->cmd_len = hp->cmd_len;
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001768
1769 srp->rq = rq;
1770 rq->end_io_data = srp;
1771 rq->sense = srp->sense_b;
1772 rq->retries = SG_DEFAULT_RETRIES;
1773
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774 if ((dxfer_len <= 0) || (dxfer_dir == SG_DXFER_NONE))
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001775 return 0;
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001776
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001777 if (sg_allow_dio && hp->flags & SG_FLAG_DIRECT_IO &&
1778 dxfer_dir != SG_DXFER_UNKNOWN && !iov_count &&
1779 !sfp->parentdp->device->host->unchecked_isa_dma &&
Namhyung Kim2610a252010-09-16 12:55:57 +09001780 blk_rq_aligned(q, (unsigned long)hp->dxferp, dxfer_len))
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001781 md = NULL;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001782 else
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001783 md = &map_data;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001784
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001785 if (md) {
Hannes Reinecke4099ac92017-04-07 09:34:14 +02001786 mutex_lock(&sfp->f_mutex);
1787 if (dxfer_len <= rsv_schp->bufflen &&
1788 !sfp->res_in_use) {
1789 sfp->res_in_use = 1;
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001790 sg_link_reserve(sfp, srp, dxfer_len);
Todd Poynor7791b592017-08-15 21:48:43 -07001791 } else if (hp->flags & SG_FLAG_MMAP_IO) {
1792 res = -EBUSY; /* sfp->res_in_use == 1 */
1793 if (dxfer_len > rsv_schp->bufflen)
1794 res = -ENOMEM;
Hannes Reinecke4099ac92017-04-07 09:34:14 +02001795 mutex_unlock(&sfp->f_mutex);
Todd Poynor7791b592017-08-15 21:48:43 -07001796 return res;
Hannes Reinecke4099ac92017-04-07 09:34:14 +02001797 } else {
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001798 res = sg_build_indirect(req_schp, sfp, dxfer_len);
Hannes Reinecke4099ac92017-04-07 09:34:14 +02001799 if (res) {
1800 mutex_unlock(&sfp->f_mutex);
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001801 return res;
Hannes Reinecke4099ac92017-04-07 09:34:14 +02001802 }
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001803 }
Hannes Reinecke4099ac92017-04-07 09:34:14 +02001804 mutex_unlock(&sfp->f_mutex);
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001805
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001806 md->pages = req_schp->pages;
1807 md->page_order = req_schp->page_order;
1808 md->nr_entries = req_schp->k_use_sg;
FUJITA Tomonori56c451f2008-12-18 14:49:37 +09001809 md->offset = 0;
FUJITA Tomonori97ae77a2008-12-18 14:49:38 +09001810 md->null_mapped = hp->dxferp ? 0 : 1;
FUJITA Tomonoriecb554a2009-07-09 14:46:53 +02001811 if (dxfer_dir == SG_DXFER_TO_FROM_DEV)
1812 md->from_user = 1;
1813 else
1814 md->from_user = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001815 }
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001816
FUJITA Tomonori0fdf96b2009-04-03 09:12:20 +09001817 if (iov_count) {
Al Virofdc81f42015-03-21 20:25:30 -04001818 struct iovec *iov = NULL;
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001819 struct iov_iter i;
FUJITA Tomonori0fdf96b2009-04-03 09:12:20 +09001820
Al Virofdc81f42015-03-21 20:25:30 -04001821 res = import_iovec(rw, hp->dxferp, iov_count, 0, &iov, &i);
1822 if (res < 0)
1823 return res;
FUJITA Tomonori0fdf96b2009-04-03 09:12:20 +09001824
Al Virofdc81f42015-03-21 20:25:30 -04001825 iov_iter_truncate(&i, hp->dxfer_len);
Al Viroa975e8e2017-02-19 07:15:27 +00001826 if (!iov_iter_count(&i)) {
1827 kfree(iov);
1828 return -EINVAL;
1829 }
FUJITA Tomonori0fdf96b2009-04-03 09:12:20 +09001830
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001831 res = blk_rq_map_user_iov(q, rq, md, &i, GFP_ATOMIC);
FUJITA Tomonori0fdf96b2009-04-03 09:12:20 +09001832 kfree(iov);
1833 } else
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001834 res = blk_rq_map_user(q, rq, md, hp->dxferp,
1835 hp->dxfer_len, GFP_ATOMIC);
1836
1837 if (!res) {
1838 srp->bio = rq->bio;
1839
1840 if (!md) {
1841 req_schp->dio_in_use = 1;
1842 hp->info |= SG_INFO_DIRECT_IO;
1843 }
1844 }
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001845 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001846}
1847
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001848static int
1849sg_finish_rem_req(Sg_request *srp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001850{
FUJITA Tomonorie7ee4cc2009-04-04 00:35:42 +09001851 int ret = 0;
1852
Linus Torvalds1da177e2005-04-16 15:20:36 -07001853 Sg_fd *sfp = srp->parentfp;
1854 Sg_scatter_hold *req_schp = &srp->data;
1855
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001856 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1857 "sg_finish_rem_req: res_used=%d\n",
1858 (int) srp->res_used));
Tony Battersby75686152015-02-13 12:09:44 -05001859 if (srp->bio)
1860 ret = blk_rq_unmap_user(srp->bio);
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001861
Tony Battersby75686152015-02-13 12:09:44 -05001862 if (srp->rq) {
Douglas Gilbert65c26a02014-06-03 13:18:18 -04001863 if (srp->rq->cmd != srp->rq->__cmd)
1864 kfree(srp->rq->cmd);
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001865 blk_put_request(srp->rq);
FUJITA Tomonori6e5a30c2008-08-28 16:17:08 +09001866 }
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001867
Christof Schmitte27168f2009-09-17 09:10:14 +02001868 if (srp->res_used)
1869 sg_unlink_reserve(sfp, srp);
1870 else
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001871 sg_remove_scat(sfp, req_schp);
Christof Schmitte27168f2009-09-17 09:10:14 +02001872
FUJITA Tomonorie7ee4cc2009-04-04 00:35:42 +09001873 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001874}
1875
1876static int
1877sg_build_sgat(Sg_scatter_hold * schp, const Sg_fd * sfp, int tablesize)
1878{
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001879 int sg_bufflen = tablesize * sizeof(struct page *);
Al Viro2d20eaf2006-02-01 06:31:40 -05001880 gfp_t gfp_flags = GFP_ATOMIC | __GFP_NOWARN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001881
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001882 schp->pages = kzalloc(sg_bufflen, gfp_flags);
1883 if (!schp->pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001884 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001885 schp->sglist_len = sg_bufflen;
Mike Christied6b10342005-11-08 04:06:41 -06001886 return tablesize; /* number of scat_gath elements allocated */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001887}
1888
Linus Torvalds1da177e2005-04-16 15:20:36 -07001889static int
1890sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size)
1891{
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001892 int ret_sz = 0, i, k, rem_sz, num, mx_sc_elems;
Mike Christied6b10342005-11-08 04:06:41 -06001893 int sg_tablesize = sfp->parentdp->sg_tablesize;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001894 int blk_size = buff_size, order;
1895 gfp_t gfp_mask = GFP_ATOMIC | __GFP_COMP | __GFP_NOWARN;
Hannes Reineckebb7119e2017-04-07 09:34:12 +02001896 struct sg_device *sdp = sfp->parentdp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001897
Eric Sesterhennfb119932007-05-23 14:41:36 -07001898 if (blk_size < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001899 return -EFAULT;
1900 if (0 == blk_size)
1901 ++blk_size; /* don't know why */
FUJITA Tomonorib2ed6c62009-02-12 02:42:57 +09001902 /* round request up to next highest SG_SECTOR_SZ byte boundary */
1903 blk_size = ALIGN(blk_size, SG_SECTOR_SZ);
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001904 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1905 "sg_build_indirect: buff_size=%d, blk_size=%d\n",
1906 buff_size, blk_size));
Mike Christied6b10342005-11-08 04:06:41 -06001907
1908 /* N.B. ret_sz carried into this block ... */
1909 mx_sc_elems = sg_build_sgat(schp, sfp, sg_tablesize);
1910 if (mx_sc_elems < 0)
1911 return mx_sc_elems; /* most likely -ENOMEM */
1912
Douglas Gilbert6460e752006-09-20 18:20:49 -04001913 num = scatter_elem_sz;
1914 if (unlikely(num != scatter_elem_sz_prev)) {
1915 if (num < PAGE_SIZE) {
1916 scatter_elem_sz = PAGE_SIZE;
1917 scatter_elem_sz_prev = PAGE_SIZE;
1918 } else
1919 scatter_elem_sz_prev = num;
1920 }
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001921
Hannes Reineckebb7119e2017-04-07 09:34:12 +02001922 if (sdp->device->host->unchecked_isa_dma)
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001923 gfp_mask |= GFP_DMA;
1924
1925 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
1926 gfp_mask |= __GFP_ZERO;
1927
1928 order = get_order(num);
1929retry:
1930 ret_sz = 1 << (PAGE_SHIFT + order);
1931
1932 for (k = 0, rem_sz = blk_size; rem_sz > 0 && k < mx_sc_elems;
1933 k++, rem_sz -= ret_sz) {
1934
Douglas Gilbert6460e752006-09-20 18:20:49 -04001935 num = (rem_sz > scatter_elem_sz_prev) ?
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001936 scatter_elem_sz_prev : rem_sz;
1937
Alexander Potapenkoad251832018-05-18 16:23:18 +02001938 schp->pages[k] = alloc_pages(gfp_mask | __GFP_ZERO, order);
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001939 if (!schp->pages[k])
1940 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001941
Douglas Gilbert6460e752006-09-20 18:20:49 -04001942 if (num == scatter_elem_sz_prev) {
1943 if (unlikely(ret_sz > scatter_elem_sz_prev)) {
1944 scatter_elem_sz = ret_sz;
1945 scatter_elem_sz_prev = ret_sz;
1946 }
1947 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001948
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001949 SCSI_LOG_TIMEOUT(5, sg_printk(KERN_INFO, sfp->parentdp,
1950 "sg_build_indirect: k=%d, num=%d, ret_sz=%d\n",
1951 k, num, ret_sz));
Mike Christied6b10342005-11-08 04:06:41 -06001952 } /* end of for loop */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001954 schp->page_order = order;
Mike Christied6b10342005-11-08 04:06:41 -06001955 schp->k_use_sg = k;
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001956 SCSI_LOG_TIMEOUT(5, sg_printk(KERN_INFO, sfp->parentdp,
1957 "sg_build_indirect: k_use_sg=%d, rem_sz=%d\n",
1958 k, rem_sz));
Mike Christied6b10342005-11-08 04:06:41 -06001959
1960 schp->bufflen = blk_size;
1961 if (rem_sz > 0) /* must have failed */
1962 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001963 return 0;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001964out:
1965 for (i = 0; i < k; i++)
Michal Schmidte71044e2009-09-03 14:27:08 +02001966 __free_pages(schp->pages[i], order);
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001967
1968 if (--order >= 0)
1969 goto retry;
1970
1971 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001972}
1973
Linus Torvalds1da177e2005-04-16 15:20:36 -07001974static void
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001975sg_remove_scat(Sg_fd * sfp, Sg_scatter_hold * schp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001976{
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001977 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1978 "sg_remove_scat: k_use_sg=%d\n", schp->k_use_sg));
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001979 if (schp->pages && schp->sglist_len > 0) {
FUJITA Tomonori6e5a30c2008-08-28 16:17:08 +09001980 if (!schp->dio_in_use) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001981 int k;
1982
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001983 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001984 SCSI_LOG_TIMEOUT(5,
1985 sg_printk(KERN_INFO, sfp->parentdp,
1986 "sg_remove_scat: k=%d, pg=0x%p\n",
1987 k, schp->pages[k]));
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001988 __free_pages(schp->pages[k], schp->page_order);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001989 }
FUJITA Tomonori6e5a30c2008-08-28 16:17:08 +09001990
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001991 kfree(schp->pages);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001992 }
Mike Christied6b10342005-11-08 04:06:41 -06001993 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001994 memset(schp, 0, sizeof (*schp));
1995}
1996
1997static int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001998sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer)
1999{
2000 Sg_scatter_hold *schp = &srp->data;
Mike Christied6b10342005-11-08 04:06:41 -06002001 int k, num;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002002
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002003 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, srp->parentfp->parentdp,
2004 "sg_read_oxfer: num_read_xfer=%d\n",
2005 num_read_xfer));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002006 if ((!outp) || (num_read_xfer <= 0))
2007 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002008
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02002009 num = 1 << (PAGE_SHIFT + schp->page_order);
2010 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
Mike Christied6b10342005-11-08 04:06:41 -06002011 if (num > num_read_xfer) {
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02002012 if (__copy_to_user(outp, page_address(schp->pages[k]),
Mike Christied6b10342005-11-08 04:06:41 -06002013 num_read_xfer))
2014 return -EFAULT;
2015 break;
2016 } else {
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02002017 if (__copy_to_user(outp, page_address(schp->pages[k]),
Mike Christied6b10342005-11-08 04:06:41 -06002018 num))
2019 return -EFAULT;
2020 num_read_xfer -= num;
2021 if (num_read_xfer <= 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002022 break;
Mike Christied6b10342005-11-08 04:06:41 -06002023 outp += num;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002024 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002025 }
Mike Christied6b10342005-11-08 04:06:41 -06002026
Linus Torvalds1da177e2005-04-16 15:20:36 -07002027 return 0;
2028}
2029
2030static void
2031sg_build_reserve(Sg_fd * sfp, int req_size)
2032{
2033 Sg_scatter_hold *schp = &sfp->reserve;
2034
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002035 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
2036 "sg_build_reserve: req_size=%d\n", req_size));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002037 do {
2038 if (req_size < PAGE_SIZE)
2039 req_size = PAGE_SIZE;
2040 if (0 == sg_build_indirect(schp, sfp, req_size))
2041 return;
2042 else
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002043 sg_remove_scat(sfp, schp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002044 req_size >>= 1; /* divide by 2 */
2045 } while (req_size > (PAGE_SIZE / 2));
2046}
2047
2048static void
2049sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size)
2050{
2051 Sg_scatter_hold *req_schp = &srp->data;
2052 Sg_scatter_hold *rsv_schp = &sfp->reserve;
Mike Christied6b10342005-11-08 04:06:41 -06002053 int k, num, rem;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054
2055 srp->res_used = 1;
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002056 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
2057 "sg_link_reserve: size=%d\n", size));
Brian Kingeca7be52006-02-14 12:42:24 -06002058 rem = size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002059
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02002060 num = 1 << (PAGE_SHIFT + rsv_schp->page_order);
2061 for (k = 0; k < rsv_schp->k_use_sg; k++) {
Mike Christied6b10342005-11-08 04:06:41 -06002062 if (rem <= num) {
Mike Christied6b10342005-11-08 04:06:41 -06002063 req_schp->k_use_sg = k + 1;
2064 req_schp->sglist_len = rsv_schp->sglist_len;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02002065 req_schp->pages = rsv_schp->pages;
Mike Christied6b10342005-11-08 04:06:41 -06002066
2067 req_schp->bufflen = size;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02002068 req_schp->page_order = rsv_schp->page_order;
Mike Christied6b10342005-11-08 04:06:41 -06002069 break;
2070 } else
2071 rem -= num;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002072 }
Mike Christied6b10342005-11-08 04:06:41 -06002073
2074 if (k >= rsv_schp->k_use_sg)
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002075 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO, sfp->parentdp,
2076 "sg_link_reserve: BAD size\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002077}
2078
2079static void
2080sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp)
2081{
2082 Sg_scatter_hold *req_schp = &srp->data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002084 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, srp->parentfp->parentdp,
2085 "sg_unlink_reserve: req->k_use_sg=%d\n",
2086 (int) req_schp->k_use_sg));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087 req_schp->k_use_sg = 0;
2088 req_schp->bufflen = 0;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02002089 req_schp->pages = NULL;
2090 req_schp->page_order = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091 req_schp->sglist_len = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002092 srp->res_used = 0;
Hannes Reineckec47c52c2017-04-24 10:26:36 +02002093 /* Called without mutex lock to avoid deadlock */
2094 sfp->res_in_use = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002095}
2096
2097static Sg_request *
2098sg_get_rq_mark(Sg_fd * sfp, int pack_id)
2099{
2100 Sg_request *resp;
2101 unsigned long iflags;
2102
2103 write_lock_irqsave(&sfp->rq_list_lock, iflags);
Hannes Reinecke2b2d86b2017-04-07 09:34:16 +02002104 list_for_each_entry(resp, &sfp->rq_list, entry) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002105 /* look for requests that are ready + not SG_IO owned */
2106 if ((1 == resp->done) && (!resp->sg_io_owned) &&
2107 ((-1 == pack_id) || (resp->header.pack_id == pack_id))) {
2108 resp->done = 2; /* guard against other readers */
Johannes Thumshirn6505dd12017-05-10 09:53:40 +02002109 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2110 return resp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002111 }
2112 }
2113 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
Johannes Thumshirn6505dd12017-05-10 09:53:40 +02002114 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115}
2116
Linus Torvalds1da177e2005-04-16 15:20:36 -07002117/* always adds to end of list */
2118static Sg_request *
2119sg_add_request(Sg_fd * sfp)
2120{
2121 int k;
2122 unsigned long iflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123 Sg_request *rp = sfp->req_arr;
2124
2125 write_lock_irqsave(&sfp->rq_list_lock, iflags);
Hannes Reinecke2b2d86b2017-04-07 09:34:16 +02002126 if (!list_empty(&sfp->rq_list)) {
2127 if (!sfp->cmd_q)
2128 goto out_unlock;
2129
2130 for (k = 0; k < SG_MAX_QUEUE; ++k, ++rp) {
2131 if (!rp->parentfp)
2132 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002133 }
Hannes Reinecke2b2d86b2017-04-07 09:34:16 +02002134 if (k >= SG_MAX_QUEUE)
2135 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002136 }
Hannes Reinecke2b2d86b2017-04-07 09:34:16 +02002137 memset(rp, 0, sizeof (Sg_request));
2138 rp->parentfp = sfp;
2139 rp->header.duration = jiffies_to_msecs(jiffies);
2140 list_add_tail(&rp->entry, &sfp->rq_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002141 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
Hannes Reinecke2b2d86b2017-04-07 09:34:16 +02002142 return rp;
2143out_unlock:
2144 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2145 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146}
2147
2148/* Return of 1 for found; 0 for not found */
2149static int
2150sg_remove_request(Sg_fd * sfp, Sg_request * srp)
2151{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002152 unsigned long iflags;
2153 int res = 0;
2154
Hannes Reinecke2b2d86b2017-04-07 09:34:16 +02002155 if (!sfp || !srp || list_empty(&sfp->rq_list))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002156 return res;
2157 write_lock_irqsave(&sfp->rq_list_lock, iflags);
Hannes Reinecke2b2d86b2017-04-07 09:34:16 +02002158 if (!list_empty(&srp->entry)) {
2159 list_del(&srp->entry);
2160 srp->parentfp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002161 res = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002162 }
2163 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2164 return res;
2165}
2166
Linus Torvalds1da177e2005-04-16 15:20:36 -07002167static Sg_fd *
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002168sg_add_sfp(Sg_device * sdp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002169{
2170 Sg_fd *sfp;
2171 unsigned long iflags;
Alan Stern44ec9542007-02-20 11:01:57 -05002172 int bufflen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002173
Mike Christied6b10342005-11-08 04:06:41 -06002174 sfp = kzalloc(sizeof(*sfp), GFP_ATOMIC | __GFP_NOWARN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002175 if (!sfp)
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002176 return ERR_PTR(-ENOMEM);
Mike Christied6b10342005-11-08 04:06:41 -06002177
Linus Torvalds1da177e2005-04-16 15:20:36 -07002178 init_waitqueue_head(&sfp->read_wait);
2179 rwlock_init(&sfp->rq_list_lock);
Hannes Reinecke2b2d86b2017-04-07 09:34:16 +02002180 INIT_LIST_HEAD(&sfp->rq_list);
Tony Battersbyc6517b792009-01-21 14:45:50 -05002181 kref_init(&sfp->f_ref);
Hannes Reinecke4099ac92017-04-07 09:34:14 +02002182 mutex_init(&sfp->f_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002183 sfp->timeout = SG_DEFAULT_TIMEOUT;
2184 sfp->timeout_user = SG_DEFAULT_TIMEOUT_USER;
2185 sfp->force_packid = SG_DEF_FORCE_PACK_ID;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002186 sfp->cmd_q = SG_DEF_COMMAND_Q;
2187 sfp->keep_orphan = SG_DEF_KEEP_ORPHAN;
2188 sfp->parentdp = sdp;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002189 write_lock_irqsave(&sdp->sfd_lock, iflags);
2190 if (atomic_read(&sdp->detaching)) {
2191 write_unlock_irqrestore(&sdp->sfd_lock, iflags);
Tony Battersby0ff94fb2018-07-12 16:30:45 -04002192 kfree(sfp);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002193 return ERR_PTR(-ENODEV);
2194 }
FUJITA Tomonori3442f802009-02-16 13:26:53 +09002195 list_add_tail(&sfp->sfd_siblings, &sdp->sfds);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002196 write_unlock_irqrestore(&sdp->sfd_lock, iflags);
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002197 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
2198 "sg_add_sfp: sfp=0x%p\n", sfp));
Douglas Gilbert6460e752006-09-20 18:20:49 -04002199 if (unlikely(sg_big_buff != def_reserved_size))
2200 sg_big_buff = def_reserved_size;
2201
Alan Stern44ec9542007-02-20 11:01:57 -05002202 bufflen = min_t(int, sg_big_buff,
Akinobu Mita46f69e62014-06-02 22:56:46 +09002203 max_sectors_bytes(sdp->device->request_queue));
Alan Stern44ec9542007-02-20 11:01:57 -05002204 sg_build_reserve(sfp, bufflen);
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002205 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
2206 "sg_add_sfp: bufflen=%d, k_use_sg=%d\n",
2207 sfp->reserve.bufflen,
2208 sfp->reserve.k_use_sg));
Tony Battersbyc6517b792009-01-21 14:45:50 -05002209
2210 kref_get(&sdp->d_ref);
2211 __module_get(THIS_MODULE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002212 return sfp;
2213}
2214
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002215static void
2216sg_remove_sfp_usercontext(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002217{
Tony Battersbyc6517b792009-01-21 14:45:50 -05002218 struct sg_fd *sfp = container_of(work, struct sg_fd, ew.work);
2219 struct sg_device *sdp = sfp->parentdp;
Hannes Reinecke2b2d86b2017-04-07 09:34:16 +02002220 Sg_request *srp;
Hannes Reineckeae9b6ae2017-04-07 09:34:17 +02002221 unsigned long iflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002222
Tony Battersbyc6517b792009-01-21 14:45:50 -05002223 /* Cleanup any responses which were never read(). */
Hannes Reineckeae9b6ae2017-04-07 09:34:17 +02002224 write_lock_irqsave(&sfp->rq_list_lock, iflags);
Hannes Reinecke2b2d86b2017-04-07 09:34:16 +02002225 while (!list_empty(&sfp->rq_list)) {
2226 srp = list_first_entry(&sfp->rq_list, Sg_request, entry);
2227 sg_finish_rem_req(srp);
Hannes Reineckeae9b6ae2017-04-07 09:34:17 +02002228 list_del(&srp->entry);
2229 srp->parentfp = NULL;
Hannes Reinecke2b2d86b2017-04-07 09:34:16 +02002230 }
Hannes Reineckeae9b6ae2017-04-07 09:34:17 +02002231 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
Tony Battersbyc6517b792009-01-21 14:45:50 -05002232
Linus Torvalds1da177e2005-04-16 15:20:36 -07002233 if (sfp->reserve.bufflen > 0) {
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002234 SCSI_LOG_TIMEOUT(6, sg_printk(KERN_INFO, sdp,
2235 "sg_remove_sfp: bufflen=%d, k_use_sg=%d\n",
Tony Battersbyc6517b792009-01-21 14:45:50 -05002236 (int) sfp->reserve.bufflen,
2237 (int) sfp->reserve.k_use_sg));
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002238 sg_remove_scat(sfp, &sfp->reserve);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002239 }
Tony Battersbyc6517b792009-01-21 14:45:50 -05002240
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002241 SCSI_LOG_TIMEOUT(6, sg_printk(KERN_INFO, sdp,
2242 "sg_remove_sfp: sfp=0x%p\n", sfp));
Mike Christied6b10342005-11-08 04:06:41 -06002243 kfree(sfp);
Tony Battersbyc6517b792009-01-21 14:45:50 -05002244
2245 scsi_device_put(sdp->device);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002246 kref_put(&sdp->d_ref, sg_device_destroy);
Tony Battersbyc6517b792009-01-21 14:45:50 -05002247 module_put(THIS_MODULE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002248}
2249
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002250static void
2251sg_remove_sfp(struct kref *kref)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002252{
Tony Battersbyc6517b792009-01-21 14:45:50 -05002253 struct sg_fd *sfp = container_of(kref, struct sg_fd, f_ref);
James Bottomley065b4a22013-10-25 10:27:02 +01002254 struct sg_device *sdp = sfp->parentdp;
Tony Battersbyc6517b792009-01-21 14:45:50 -05002255 unsigned long iflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002256
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002257 write_lock_irqsave(&sdp->sfd_lock, iflags);
FUJITA Tomonori3442f802009-02-16 13:26:53 +09002258 list_del(&sfp->sfd_siblings);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002259 write_unlock_irqrestore(&sdp->sfd_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002260
FUJITA Tomonori015640e2009-04-03 19:28:06 +09002261 INIT_WORK(&sfp->ew.work, sg_remove_sfp_usercontext);
2262 schedule_work(&sfp->ew.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002263}
2264
Linus Torvalds1da177e2005-04-16 15:20:36 -07002265#ifdef CONFIG_SCSI_PROC_FS
2266static int
James Bottomley7c07d612007-08-05 13:36:11 -05002267sg_idr_max_id(int id, void *p, void *data)
2268{
2269 int *k = data;
2270
2271 if (*k < id)
2272 *k = id;
2273
2274 return 0;
2275}
2276
2277static int
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278sg_last_dev(void)
2279{
Tony Battersby53474c02008-01-22 15:25:49 -05002280 int k = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002281 unsigned long iflags;
2282
James Bottomley7c07d612007-08-05 13:36:11 -05002283 read_lock_irqsave(&sg_index_lock, iflags);
2284 idr_for_each(&sg_index_idr, sg_idr_max_id, &k);
2285 read_unlock_irqrestore(&sg_index_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002286 return k + 1; /* origin 1 */
2287}
2288#endif
2289
Tony Battersbyc6517b792009-01-21 14:45:50 -05002290/* must be called with sg_index_lock held */
2291static Sg_device *sg_lookup_dev(int dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002292{
Tony Battersbyc6517b792009-01-21 14:45:50 -05002293 return idr_find(&sg_index_idr, dev);
2294}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002295
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002296static Sg_device *
2297sg_get_dev(int dev)
Tony Battersbyc6517b792009-01-21 14:45:50 -05002298{
2299 struct sg_device *sdp;
2300 unsigned long flags;
2301
2302 read_lock_irqsave(&sg_index_lock, flags);
2303 sdp = sg_lookup_dev(dev);
2304 if (!sdp)
2305 sdp = ERR_PTR(-ENXIO);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002306 else if (atomic_read(&sdp->detaching)) {
2307 /* If sdp->detaching, then the refcount may already be 0, in
Tony Battersbyc6517b792009-01-21 14:45:50 -05002308 * which case it would be a bug to do kref_get().
2309 */
2310 sdp = ERR_PTR(-ENODEV);
2311 } else
2312 kref_get(&sdp->d_ref);
2313 read_unlock_irqrestore(&sg_index_lock, flags);
James Bottomley7c07d612007-08-05 13:36:11 -05002314
Linus Torvalds1da177e2005-04-16 15:20:36 -07002315 return sdp;
2316}
2317
2318#ifdef CONFIG_SCSI_PROC_FS
2319
2320static struct proc_dir_entry *sg_proc_sgp = NULL;
2321
2322static char sg_proc_sg_dirname[] = "scsi/sg";
2323
2324static int sg_proc_seq_show_int(struct seq_file *s, void *v);
2325
2326static int sg_proc_single_open_adio(struct inode *inode, struct file *file);
2327static ssize_t sg_proc_write_adio(struct file *filp, const char __user *buffer,
2328 size_t count, loff_t *off);
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002329static const struct file_operations adio_fops = {
2330 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002331 .open = sg_proc_single_open_adio,
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002332 .read = seq_read,
2333 .llseek = seq_lseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002334 .write = sg_proc_write_adio,
2335 .release = single_release,
2336};
2337
2338static int sg_proc_single_open_dressz(struct inode *inode, struct file *file);
Robb Glasser0575f152017-03-24 16:23:37 -07002339static ssize_t sg_proc_write_dressz(struct file *filp,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002340 const char __user *buffer, size_t count, loff_t *off);
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002341static const struct file_operations dressz_fops = {
2342 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002343 .open = sg_proc_single_open_dressz,
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002344 .read = seq_read,
2345 .llseek = seq_lseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002346 .write = sg_proc_write_dressz,
2347 .release = single_release,
2348};
2349
2350static int sg_proc_seq_show_version(struct seq_file *s, void *v);
2351static int sg_proc_single_open_version(struct inode *inode, struct file *file);
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002352static const struct file_operations version_fops = {
2353 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002354 .open = sg_proc_single_open_version,
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002355 .read = seq_read,
2356 .llseek = seq_lseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002357 .release = single_release,
2358};
2359
2360static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v);
2361static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file);
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002362static const struct file_operations devhdr_fops = {
2363 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002364 .open = sg_proc_single_open_devhdr,
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002365 .read = seq_read,
2366 .llseek = seq_lseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002367 .release = single_release,
2368};
2369
2370static int sg_proc_seq_show_dev(struct seq_file *s, void *v);
2371static int sg_proc_open_dev(struct inode *inode, struct file *file);
2372static void * dev_seq_start(struct seq_file *s, loff_t *pos);
2373static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos);
2374static void dev_seq_stop(struct seq_file *s, void *v);
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002375static const struct file_operations dev_fops = {
2376 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002377 .open = sg_proc_open_dev,
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002378 .read = seq_read,
2379 .llseek = seq_lseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002380 .release = seq_release,
2381};
James Morris88e9d342009-09-22 16:43:43 -07002382static const struct seq_operations dev_seq_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002383 .start = dev_seq_start,
2384 .next = dev_seq_next,
2385 .stop = dev_seq_stop,
2386 .show = sg_proc_seq_show_dev,
2387};
2388
2389static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v);
2390static int sg_proc_open_devstrs(struct inode *inode, struct file *file);
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002391static const struct file_operations devstrs_fops = {
2392 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002393 .open = sg_proc_open_devstrs,
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002394 .read = seq_read,
2395 .llseek = seq_lseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002396 .release = seq_release,
2397};
James Morris88e9d342009-09-22 16:43:43 -07002398static const struct seq_operations devstrs_seq_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002399 .start = dev_seq_start,
2400 .next = dev_seq_next,
2401 .stop = dev_seq_stop,
2402 .show = sg_proc_seq_show_devstrs,
2403};
2404
2405static int sg_proc_seq_show_debug(struct seq_file *s, void *v);
2406static int sg_proc_open_debug(struct inode *inode, struct file *file);
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002407static const struct file_operations debug_fops = {
2408 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002409 .open = sg_proc_open_debug,
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002410 .read = seq_read,
2411 .llseek = seq_lseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002412 .release = seq_release,
2413};
James Morris88e9d342009-09-22 16:43:43 -07002414static const struct seq_operations debug_seq_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002415 .start = dev_seq_start,
2416 .next = dev_seq_next,
2417 .stop = dev_seq_stop,
2418 .show = sg_proc_seq_show_debug,
2419};
2420
2421
2422struct sg_proc_leaf {
2423 const char * name;
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002424 const struct file_operations * fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002425};
2426
Jörn Engel18b8ba62012-04-12 17:35:25 -04002427static const struct sg_proc_leaf sg_proc_leaf_arr[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002428 {"allow_dio", &adio_fops},
2429 {"debug", &debug_fops},
2430 {"def_reserved_size", &dressz_fops},
2431 {"device_hdr", &devhdr_fops},
2432 {"devices", &dev_fops},
2433 {"device_strs", &devstrs_fops},
2434 {"version", &version_fops}
2435};
2436
2437static int
2438sg_proc_init(void)
2439{
Tobias Klauser6391a112006-06-08 22:23:48 -07002440 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
Al Virod161a132011-07-24 03:36:29 -04002441 int k;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002442
Al Viro66600222005-09-28 22:32:57 +01002443 sg_proc_sgp = proc_mkdir(sg_proc_sg_dirname, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002444 if (!sg_proc_sgp)
2445 return 1;
2446 for (k = 0; k < num_leaves; ++k) {
Jörn Engel18b8ba62012-04-12 17:35:25 -04002447 const struct sg_proc_leaf *leaf = &sg_proc_leaf_arr[k];
Al Virod161a132011-07-24 03:36:29 -04002448 umode_t mask = leaf->fops->write ? S_IRUGO | S_IWUSR : S_IRUGO;
Denis V. Luneva9739092008-04-29 01:02:17 -07002449 proc_create(leaf->name, mask, sg_proc_sgp, leaf->fops);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002450 }
2451 return 0;
2452}
2453
2454static void
2455sg_proc_cleanup(void)
2456{
2457 int k;
Tobias Klauser6391a112006-06-08 22:23:48 -07002458 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002459
2460 if (!sg_proc_sgp)
2461 return;
2462 for (k = 0; k < num_leaves; ++k)
2463 remove_proc_entry(sg_proc_leaf_arr[k].name, sg_proc_sgp);
2464 remove_proc_entry(sg_proc_sg_dirname, NULL);
2465}
2466
2467
2468static int sg_proc_seq_show_int(struct seq_file *s, void *v)
2469{
2470 seq_printf(s, "%d\n", *((int *)s->private));
2471 return 0;
2472}
2473
2474static int sg_proc_single_open_adio(struct inode *inode, struct file *file)
2475{
2476 return single_open(file, sg_proc_seq_show_int, &sg_allow_dio);
2477}
2478
Robb Glasser0575f152017-03-24 16:23:37 -07002479static ssize_t
Linus Torvalds1da177e2005-04-16 15:20:36 -07002480sg_proc_write_adio(struct file *filp, const char __user *buffer,
2481 size_t count, loff_t *off)
2482{
Stephen Boyd7e95fff2012-01-10 15:42:34 -08002483 int err;
2484 unsigned long num;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002485
2486 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2487 return -EACCES;
Stephen Boyd7e95fff2012-01-10 15:42:34 -08002488 err = kstrtoul_from_user(buffer, count, 0, &num);
2489 if (err)
2490 return err;
2491 sg_allow_dio = num ? 1 : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002492 return count;
2493}
2494
2495static int sg_proc_single_open_dressz(struct inode *inode, struct file *file)
2496{
2497 return single_open(file, sg_proc_seq_show_int, &sg_big_buff);
2498}
2499
Robb Glasser0575f152017-03-24 16:23:37 -07002500static ssize_t
Linus Torvalds1da177e2005-04-16 15:20:36 -07002501sg_proc_write_dressz(struct file *filp, const char __user *buffer,
2502 size_t count, loff_t *off)
2503{
Stephen Boyd7e95fff2012-01-10 15:42:34 -08002504 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002505 unsigned long k = ULONG_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002506
2507 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2508 return -EACCES;
Stephen Boyd7e95fff2012-01-10 15:42:34 -08002509
2510 err = kstrtoul_from_user(buffer, count, 0, &k);
2511 if (err)
2512 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002513 if (k <= 1048576) { /* limit "big buff" to 1 MB */
2514 sg_big_buff = k;
2515 return count;
2516 }
2517 return -ERANGE;
2518}
2519
2520static int sg_proc_seq_show_version(struct seq_file *s, void *v)
2521{
2522 seq_printf(s, "%d\t%s [%s]\n", sg_version_num, SG_VERSION_STR,
2523 sg_version_date);
2524 return 0;
2525}
2526
2527static int sg_proc_single_open_version(struct inode *inode, struct file *file)
2528{
2529 return single_open(file, sg_proc_seq_show_version, NULL);
2530}
2531
2532static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v)
2533{
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002534 seq_puts(s, "host\tchan\tid\tlun\ttype\topens\tqdepth\tbusy\tonline\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002535 return 0;
2536}
2537
2538static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file)
2539{
2540 return single_open(file, sg_proc_seq_show_devhdr, NULL);
2541}
2542
2543struct sg_proc_deviter {
2544 loff_t index;
2545 size_t max;
2546};
2547
2548static void * dev_seq_start(struct seq_file *s, loff_t *pos)
2549{
2550 struct sg_proc_deviter * it = kmalloc(sizeof(*it), GFP_KERNEL);
2551
Jan Blunck729d70f2005-08-27 11:07:52 -07002552 s->private = it;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002553 if (! it)
2554 return NULL;
Jan Blunck729d70f2005-08-27 11:07:52 -07002555
Linus Torvalds1da177e2005-04-16 15:20:36 -07002556 it->index = *pos;
2557 it->max = sg_last_dev();
2558 if (it->index >= it->max)
Jan Blunck729d70f2005-08-27 11:07:52 -07002559 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002560 return it;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002561}
2562
2563static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos)
2564{
Jan Blunck729d70f2005-08-27 11:07:52 -07002565 struct sg_proc_deviter * it = s->private;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002566
2567 *pos = ++it->index;
2568 return (it->index < it->max) ? it : NULL;
2569}
2570
2571static void dev_seq_stop(struct seq_file *s, void *v)
2572{
Jan Blunck729d70f2005-08-27 11:07:52 -07002573 kfree(s->private);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002574}
2575
2576static int sg_proc_open_dev(struct inode *inode, struct file *file)
2577{
2578 return seq_open(file, &dev_seq_ops);
2579}
2580
2581static int sg_proc_seq_show_dev(struct seq_file *s, void *v)
2582{
2583 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2584 Sg_device *sdp;
2585 struct scsi_device *scsidp;
Tony Battersbyc6517b792009-01-21 14:45:50 -05002586 unsigned long iflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002587
Tony Battersbyc6517b792009-01-21 14:45:50 -05002588 read_lock_irqsave(&sg_index_lock, iflags);
2589 sdp = it ? sg_lookup_dev(it->index) : NULL;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002590 if ((NULL == sdp) || (NULL == sdp->device) ||
2591 (atomic_read(&sdp->detaching)))
2592 seq_puts(s, "-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\n");
2593 else {
2594 scsidp = sdp->device;
Hannes Reinecke9cb78c12014-06-25 15:27:36 +02002595 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 -07002596 scsidp->host->host_no, scsidp->channel,
2597 scsidp->id, scsidp->lun, (int) scsidp->type,
2598 1,
2599 (int) scsidp->queue_depth,
Christoph Hellwig71e75c92014-04-11 19:07:01 +02002600 (int) atomic_read(&scsidp->device_busy),
Linus Torvalds1da177e2005-04-16 15:20:36 -07002601 (int) scsi_device_online(scsidp));
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002602 }
Tony Battersbyc6517b792009-01-21 14:45:50 -05002603 read_unlock_irqrestore(&sg_index_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002604 return 0;
2605}
2606
2607static int sg_proc_open_devstrs(struct inode *inode, struct file *file)
2608{
2609 return seq_open(file, &devstrs_seq_ops);
2610}
2611
2612static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v)
2613{
2614 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2615 Sg_device *sdp;
2616 struct scsi_device *scsidp;
Tony Battersbyc6517b792009-01-21 14:45:50 -05002617 unsigned long iflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002618
Tony Battersbyc6517b792009-01-21 14:45:50 -05002619 read_lock_irqsave(&sg_index_lock, iflags);
2620 sdp = it ? sg_lookup_dev(it->index) : NULL;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002621 scsidp = sdp ? sdp->device : NULL;
2622 if (sdp && scsidp && (!atomic_read(&sdp->detaching)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002623 seq_printf(s, "%8.8s\t%16.16s\t%4.4s\n",
2624 scsidp->vendor, scsidp->model, scsidp->rev);
2625 else
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002626 seq_puts(s, "<no active device>\n");
Tony Battersbyc6517b792009-01-21 14:45:50 -05002627 read_unlock_irqrestore(&sg_index_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002628 return 0;
2629}
2630
James Bottomleyc0d3b9c22013-10-25 10:21:57 +01002631/* must be called while holding sg_index_lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002632static void sg_proc_debug_helper(struct seq_file *s, Sg_device * sdp)
2633{
Hannes Reinecke2b2d86b2017-04-07 09:34:16 +02002634 int k, new_interface, blen, usg;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002635 Sg_request *srp;
2636 Sg_fd *fp;
2637 const sg_io_hdr_t *hp;
2638 const char * cp;
cb59e842005-04-02 13:51:23 -06002639 unsigned int ms;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002640
FUJITA Tomonori3442f802009-02-16 13:26:53 +09002641 k = 0;
2642 list_for_each_entry(fp, &sdp->sfds, sfd_siblings) {
2643 k++;
Tony Battersbyc6517b792009-01-21 14:45:50 -05002644 read_lock(&fp->rq_list_lock); /* irqs already disabled */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002645 seq_printf(s, " FD(%d): timeout=%dms bufflen=%d "
FUJITA Tomonori3442f802009-02-16 13:26:53 +09002646 "(res)sgat=%d low_dma=%d\n", k,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002647 jiffies_to_msecs(fp->timeout),
2648 fp->reserve.bufflen,
2649 (int) fp->reserve.k_use_sg,
Hannes Reineckebb7119e2017-04-07 09:34:12 +02002650 (int) sdp->device->host->unchecked_isa_dma);
Jörn Engelebaf4662012-04-12 17:33:39 -04002651 seq_printf(s, " cmd_q=%d f_packid=%d k_orphan=%d closed=0\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002652 (int) fp->cmd_q, (int) fp->force_packid,
Jörn Engelebaf4662012-04-12 17:33:39 -04002653 (int) fp->keep_orphan);
Hannes Reinecke2b2d86b2017-04-07 09:34:16 +02002654 list_for_each_entry(srp, &fp->rq_list, entry) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002655 hp = &srp->header;
2656 new_interface = (hp->interface_id == '\0') ? 0 : 1;
2657 if (srp->res_used) {
Robb Glasser0575f152017-03-24 16:23:37 -07002658 if (new_interface &&
Linus Torvalds1da177e2005-04-16 15:20:36 -07002659 (SG_FLAG_MMAP_IO & hp->flags))
2660 cp = " mmap>> ";
2661 else
2662 cp = " rb>> ";
2663 } else {
2664 if (SG_INFO_DIRECT_IO_MASK & hp->info)
2665 cp = " dio>> ";
2666 else
2667 cp = " ";
2668 }
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002669 seq_puts(s, cp);
Mike Christied6b10342005-11-08 04:06:41 -06002670 blen = srp->data.bufflen;
2671 usg = srp->data.k_use_sg;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002672 seq_puts(s, srp->done ?
2673 ((1 == srp->done) ? "rcv:" : "fin:")
2674 : "act:");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002675 seq_printf(s, " id=%d blen=%d",
2676 srp->header.pack_id, blen);
2677 if (srp->done)
2678 seq_printf(s, " dur=%d", hp->duration);
cb59e842005-04-02 13:51:23 -06002679 else {
2680 ms = jiffies_to_msecs(jiffies);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002681 seq_printf(s, " t_o/elap=%d/%d",
cb59e842005-04-02 13:51:23 -06002682 (new_interface ? hp->timeout :
2683 jiffies_to_msecs(fp->timeout)),
2684 (ms > hp->duration ? ms - hp->duration : 0));
2685 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002686 seq_printf(s, "ms sgat=%d op=0x%02x\n", usg,
2687 (int) srp->data.cmd_opcode);
2688 }
Hannes Reinecke2b2d86b2017-04-07 09:34:16 +02002689 if (list_empty(&fp->rq_list))
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002690 seq_puts(s, " No requests active\n");
Tony Battersbyc6517b792009-01-21 14:45:50 -05002691 read_unlock(&fp->rq_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002692 }
2693}
2694
2695static int sg_proc_open_debug(struct inode *inode, struct file *file)
2696{
2697 return seq_open(file, &debug_seq_ops);
2698}
2699
2700static int sg_proc_seq_show_debug(struct seq_file *s, void *v)
2701{
2702 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2703 Sg_device *sdp;
Tony Battersbyc6517b792009-01-21 14:45:50 -05002704 unsigned long iflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002705
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002706 if (it && (0 == it->index))
2707 seq_printf(s, "max_active_device=%d def_reserved_size=%d\n",
2708 (int)it->max, sg_big_buff);
Tony Battersbyc6517b792009-01-21 14:45:50 -05002709
2710 read_lock_irqsave(&sg_index_lock, iflags);
2711 sdp = it ? sg_lookup_dev(it->index) : NULL;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002712 if (NULL == sdp)
2713 goto skip;
2714 read_lock(&sdp->sfd_lock);
2715 if (!list_empty(&sdp->sfds)) {
James Bottomleyc0d3b9c22013-10-25 10:21:57 +01002716 seq_printf(s, " >>> device=%s ", sdp->disk->disk_name);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002717 if (atomic_read(&sdp->detaching))
2718 seq_puts(s, "detaching pending close ");
2719 else if (sdp->device) {
2720 struct scsi_device *scsidp = sdp->device;
2721
Hannes Reinecke9cb78c12014-06-25 15:27:36 +02002722 seq_printf(s, "%d:%d:%d:%llu em=%d",
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002723 scsidp->host->host_no,
2724 scsidp->channel, scsidp->id,
2725 scsidp->lun,
2726 scsidp->host->hostt->emulated);
2727 }
2728 seq_printf(s, " sg_tablesize=%d excl=%d open_cnt=%d\n",
2729 sdp->sg_tablesize, sdp->exclude, sdp->open_cnt);
James Bottomleyc0d3b9c22013-10-25 10:21:57 +01002730 sg_proc_debug_helper(s, sdp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002731 }
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002732 read_unlock(&sdp->sfd_lock);
2733skip:
Tony Battersbyc6517b792009-01-21 14:45:50 -05002734 read_unlock_irqrestore(&sg_index_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002735 return 0;
2736}
2737
2738#endif /* CONFIG_SCSI_PROC_FS */
2739
2740module_init(init_sg);
2741module_exit(exit_sg);