blob: 5eb06ed83735c49328344cdd795ecb1df6a8f959 [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 Horn6e51bfa2018-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 Reinecke109bade2017-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 Reinecke1bc0eb02017-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 Reinecke109bade2017-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 Reinecke1bc0eb02017-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 */
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200181static void sg_rq_end_io(struct request *rq, blk_status_t status);
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 *);
Tony Battersbyf5e61d92022-07-11 10:51:32 -0400199static Sg_request *sg_get_rq_mark(Sg_fd * sfp, int pack_id, bool *busy);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200static 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 Horn6e51bfa2018-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 (uaccess_kernel()) {
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;
Tony Battersbyf5e61d92022-07-11 10:51:32 -0400421 bool busy;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 sg_io_hdr_t *hp;
cb59e842005-04-02 13:51:23 -0600423 struct sg_header *old_hdr = NULL;
424 int retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425
Jann Horn6e51bfa2018-06-25 16:25:44 +0200426 /*
427 * This could cause a response to be stranded. Close the associated
428 * file descriptor to free up any resources being held.
429 */
430 retval = sg_check_file_access(filp, __func__);
431 if (retval)
432 return retval;
433
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
435 return -ENXIO;
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200436 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
437 "sg_read: count=%d\n", (int) count));
Mike Christied6b10342005-11-08 04:06:41 -0600438
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 if (!access_ok(VERIFY_WRITE, buf, count))
440 return -EFAULT;
441 if (sfp->force_packid && (count >= SZ_SG_HEADER)) {
cb59e842005-04-02 13:51:23 -0600442 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
443 if (!old_hdr)
444 return -ENOMEM;
445 if (__copy_from_user(old_hdr, buf, SZ_SG_HEADER)) {
446 retval = -EFAULT;
447 goto free_old_hdr;
448 }
449 if (old_hdr->reply_len < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 if (count >= SZ_SG_IO_HDR) {
cb59e842005-04-02 13:51:23 -0600451 sg_io_hdr_t *new_hdr;
452 new_hdr = kmalloc(SZ_SG_IO_HDR, GFP_KERNEL);
453 if (!new_hdr) {
454 retval = -ENOMEM;
455 goto free_old_hdr;
456 }
457 retval =__copy_from_user
458 (new_hdr, buf, SZ_SG_IO_HDR);
459 req_pack_id = new_hdr->pack_id;
460 kfree(new_hdr);
461 if (retval) {
462 retval = -EFAULT;
463 goto free_old_hdr;
464 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 }
466 } else
cb59e842005-04-02 13:51:23 -0600467 req_pack_id = old_hdr->pack_id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468 }
Tony Battersbyf5e61d92022-07-11 10:51:32 -0400469 srp = sg_get_rq_mark(sfp, req_pack_id, &busy);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470 if (!srp) { /* now wait on packet to arrive */
cb59e842005-04-02 13:51:23 -0600471 if (filp->f_flags & O_NONBLOCK) {
472 retval = -EAGAIN;
473 goto free_old_hdr;
474 }
Jörn Engel3f0c6ab2012-04-12 17:33:25 -0400475 retval = wait_event_interruptible(sfp->read_wait,
Tony Battersbyf5e61d92022-07-11 10:51:32 -0400476 ((srp = sg_get_rq_mark(sfp, req_pack_id, &busy)) ||
477 (!busy && atomic_read(&sdp->detaching))));
478 if (!srp) {
479 /* signal or detaching */
480 if (!retval)
481 retval = -ENODEV;
cb59e842005-04-02 13:51:23 -0600482 goto free_old_hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483 }
484 }
cb59e842005-04-02 13:51:23 -0600485 if (srp->header.interface_id != '\0') {
486 retval = sg_new_read(sfp, buf, count, srp);
487 goto free_old_hdr;
488 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489
490 hp = &srp->header;
cb59e842005-04-02 13:51:23 -0600491 if (old_hdr == NULL) {
492 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
493 if (! old_hdr) {
494 retval = -ENOMEM;
495 goto free_old_hdr;
496 }
497 }
498 memset(old_hdr, 0, SZ_SG_HEADER);
499 old_hdr->reply_len = (int) hp->timeout;
500 old_hdr->pack_len = old_hdr->reply_len; /* old, strange behaviour */
501 old_hdr->pack_id = hp->pack_id;
502 old_hdr->twelve_byte =
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 ((srp->data.cmd_opcode >= 0xc0) && (12 == hp->cmd_len)) ? 1 : 0;
cb59e842005-04-02 13:51:23 -0600504 old_hdr->target_status = hp->masked_status;
505 old_hdr->host_status = hp->host_status;
506 old_hdr->driver_status = hp->driver_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507 if ((CHECK_CONDITION & hp->masked_status) ||
508 (DRIVER_SENSE & hp->driver_status))
cb59e842005-04-02 13:51:23 -0600509 memcpy(old_hdr->sense_buffer, srp->sense_b,
510 sizeof (old_hdr->sense_buffer));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511 switch (hp->host_status) {
512 /* This setup of 'result' is for backward compatibility and is best
513 ignored by the user who should use target, host + driver status */
514 case DID_OK:
515 case DID_PASSTHROUGH:
516 case DID_SOFT_ERROR:
cb59e842005-04-02 13:51:23 -0600517 old_hdr->result = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 break;
519 case DID_NO_CONNECT:
520 case DID_BUS_BUSY:
521 case DID_TIME_OUT:
cb59e842005-04-02 13:51:23 -0600522 old_hdr->result = EBUSY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523 break;
524 case DID_BAD_TARGET:
525 case DID_ABORT:
526 case DID_PARITY:
527 case DID_RESET:
528 case DID_BAD_INTR:
cb59e842005-04-02 13:51:23 -0600529 old_hdr->result = EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 break;
531 case DID_ERROR:
cb59e842005-04-02 13:51:23 -0600532 old_hdr->result = (srp->sense_b[0] == 0 &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533 hp->masked_status == GOOD) ? 0 : EIO;
534 break;
535 default:
cb59e842005-04-02 13:51:23 -0600536 old_hdr->result = EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 break;
538 }
539
540 /* Now copy the result back to the user buffer. */
541 if (count >= SZ_SG_HEADER) {
cb59e842005-04-02 13:51:23 -0600542 if (__copy_to_user(buf, old_hdr, SZ_SG_HEADER)) {
543 retval = -EFAULT;
544 goto free_old_hdr;
545 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546 buf += SZ_SG_HEADER;
cb59e842005-04-02 13:51:23 -0600547 if (count > old_hdr->reply_len)
548 count = old_hdr->reply_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549 if (count > SZ_SG_HEADER) {
cb59e842005-04-02 13:51:23 -0600550 if (sg_read_oxfer(srp, buf, count - SZ_SG_HEADER)) {
551 retval = -EFAULT;
552 goto free_old_hdr;
553 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 }
555 } else
cb59e842005-04-02 13:51:23 -0600556 count = (old_hdr->result == 0) ? 0 : -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 sg_finish_rem_req(srp);
Hannes Reinecke97d27b02017-04-07 09:34:17 +0200558 sg_remove_request(sfp, srp);
cb59e842005-04-02 13:51:23 -0600559 retval = count;
560free_old_hdr:
Jesper Juhlc9475cb2005-11-07 01:01:26 -0800561 kfree(old_hdr);
cb59e842005-04-02 13:51:23 -0600562 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563}
564
565static ssize_t
566sg_new_read(Sg_fd * sfp, char __user *buf, size_t count, Sg_request * srp)
567{
568 sg_io_hdr_t *hp = &srp->header;
Tony Battersby3b524a62015-02-11 11:32:06 -0500569 int err = 0, err2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570 int len;
571
572 if (count < SZ_SG_IO_HDR) {
573 err = -EINVAL;
574 goto err_out;
575 }
576 hp->sb_len_wr = 0;
577 if ((hp->mx_sb_len > 0) && hp->sbp) {
578 if ((CHECK_CONDITION & hp->masked_status) ||
579 (DRIVER_SENSE & hp->driver_status)) {
Mike Christied6b10342005-11-08 04:06:41 -0600580 int sb_len = SCSI_SENSE_BUFFERSIZE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 sb_len = (hp->mx_sb_len > sb_len) ? sb_len : hp->mx_sb_len;
582 len = 8 + (int) srp->sense_b[7]; /* Additional sense length field */
583 len = (len > sb_len) ? sb_len : len;
584 if (copy_to_user(hp->sbp, srp->sense_b, len)) {
585 err = -EFAULT;
586 goto err_out;
587 }
588 hp->sb_len_wr = len;
589 }
590 }
591 if (hp->masked_status || hp->host_status || hp->driver_status)
592 hp->info |= SG_INFO_CHECK;
593 if (copy_to_user(buf, hp, SZ_SG_IO_HDR)) {
594 err = -EFAULT;
595 goto err_out;
596 }
FUJITA Tomonori0b6cb262008-09-02 22:50:07 +0900597err_out:
Tony Battersby3b524a62015-02-11 11:32:06 -0500598 err2 = sg_finish_rem_req(srp);
Hannes Reinecke97d27b02017-04-07 09:34:17 +0200599 sg_remove_request(sfp, srp);
Tony Battersby3b524a62015-02-11 11:32:06 -0500600 return err ? : err2 ? : count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601}
602
603static ssize_t
604sg_write(struct file *filp, const char __user *buf, size_t count, loff_t * ppos)
605{
606 int mxsize, cmd_size, k;
607 int input_size, blocking;
608 unsigned char opcode;
609 Sg_device *sdp;
610 Sg_fd *sfp;
611 Sg_request *srp;
612 struct sg_header old_hdr;
613 sg_io_hdr_t *hp;
Douglas Gilbert65c26a02014-06-03 13:18:18 -0400614 unsigned char cmnd[SG_MAX_CDB_SIZE];
Jann Horn6e51bfa2018-06-25 16:25:44 +0200615 int retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616
Jann Horn6e51bfa2018-06-25 16:25:44 +0200617 retval = sg_check_file_access(filp, __func__);
618 if (retval)
619 return retval;
Al Viro128394e2016-12-16 13:42:06 -0500620
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
622 return -ENXIO;
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200623 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
624 "sg_write: count=%d\n", (int) count));
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200625 if (atomic_read(&sdp->detaching))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 return -ENODEV;
627 if (!((filp->f_flags & O_NONBLOCK) ||
628 scsi_block_when_processing_errors(sdp->device)))
629 return -ENXIO;
630
631 if (!access_ok(VERIFY_READ, buf, count))
632 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
633 if (count < SZ_SG_HEADER)
634 return -EIO;
635 if (__copy_from_user(&old_hdr, buf, SZ_SG_HEADER))
636 return -EFAULT;
637 blocking = !(filp->f_flags & O_NONBLOCK);
638 if (old_hdr.reply_len < 0)
Tony Battersbya2dd3b42009-01-20 17:00:09 -0500639 return sg_new_write(sfp, filp, buf, count,
640 blocking, 0, 0, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 if (count < (SZ_SG_HEADER + 6))
642 return -EIO; /* The minimum scsi command length is 6 bytes. */
643
644 if (!(srp = sg_add_request(sfp))) {
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200645 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO, sdp,
646 "sg_write: queue full\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 return -EDOM;
648 }
649 buf += SZ_SG_HEADER;
650 __get_user(opcode, buf);
Hannes Reinecke1bc0eb02017-04-07 09:34:14 +0200651 mutex_lock(&sfp->f_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652 if (sfp->next_cmd_len > 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 cmd_size = sfp->next_cmd_len;
654 sfp->next_cmd_len = 0; /* reset so only this write() effected */
655 } else {
656 cmd_size = COMMAND_SIZE(opcode); /* based on SCSI command group */
657 if ((opcode >= 0xc0) && old_hdr.twelve_byte)
658 cmd_size = 12;
659 }
Hannes Reinecke1bc0eb02017-04-07 09:34:14 +0200660 mutex_unlock(&sfp->f_mutex);
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200661 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sdp,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662 "sg_write: scsi opcode=0x%02x, cmd_size=%d\n", (int) opcode, cmd_size));
663/* Determine buffer size. */
664 input_size = count - cmd_size;
665 mxsize = (input_size > old_hdr.reply_len) ? input_size : old_hdr.reply_len;
666 mxsize -= SZ_SG_HEADER;
667 input_size -= SZ_SG_HEADER;
668 if (input_size < 0) {
669 sg_remove_request(sfp, srp);
670 return -EIO; /* User did not pass enough bytes for this command. */
671 }
672 hp = &srp->header;
673 hp->interface_id = '\0'; /* indicator of old interface tunnelled */
674 hp->cmd_len = (unsigned char) cmd_size;
675 hp->iovec_count = 0;
676 hp->mx_sb_len = 0;
677 if (input_size > 0)
678 hp->dxfer_direction = (old_hdr.reply_len > SZ_SG_HEADER) ?
679 SG_DXFER_TO_FROM_DEV : SG_DXFER_TO_DEV;
680 else
681 hp->dxfer_direction = (mxsize > 0) ? SG_DXFER_FROM_DEV : SG_DXFER_NONE;
682 hp->dxfer_len = mxsize;
Douglas Gilbert5ecee0a2016-03-03 00:31:29 -0500683 if ((hp->dxfer_direction == SG_DXFER_TO_DEV) ||
684 (hp->dxfer_direction == SG_DXFER_TO_FROM_DEV))
FUJITA Tomonorifad7f012008-09-02 16:20:20 +0900685 hp->dxferp = (char __user *)buf + cmd_size;
686 else
687 hp->dxferp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688 hp->sbp = NULL;
689 hp->timeout = old_hdr.reply_len; /* structure abuse ... */
690 hp->flags = input_size; /* structure abuse ... */
691 hp->pack_id = old_hdr.pack_id;
692 hp->usr_ptr = NULL;
Wu Bo3f743dd2020-04-14 10:13:28 +0800693 if (__copy_from_user(cmnd, buf, cmd_size)) {
694 sg_remove_request(sfp, srp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 return -EFAULT;
Wu Bo3f743dd2020-04-14 10:13:28 +0800696 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697 /*
698 * SG_DXFER_TO_FROM_DEV is functionally equivalent to SG_DXFER_FROM_DEV,
699 * but is is possible that the app intended SG_DXFER_TO_DEV, because there
700 * is a non-zero input_size, so emit a warning.
701 */
Andi Kleeneaa3e222008-01-13 17:41:43 +0100702 if (hp->dxfer_direction == SG_DXFER_TO_FROM_DEV) {
Johannes Thumshirn28676d82017-04-07 09:34:15 +0200703 printk_ratelimited(KERN_WARNING
704 "sg_write: data in/out %d/%d bytes "
705 "for SCSI command 0x%x-- guessing "
706 "data in;\n program %s not setting "
707 "count and/or reply_len properly\n",
708 old_hdr.reply_len - (int)SZ_SG_HEADER,
709 input_size, (unsigned int) cmnd[0],
710 current->comm);
Andi Kleeneaa3e222008-01-13 17:41:43 +0100711 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712 k = sg_common_write(sfp, srp, cmnd, sfp->timeout, blocking);
713 return (k < 0) ? k : count;
714}
715
716static ssize_t
Adel Gadllah0b07de82008-06-26 13:48:27 +0200717sg_new_write(Sg_fd *sfp, struct file *file, const char __user *buf,
Tony Battersbya2dd3b42009-01-20 17:00:09 -0500718 size_t count, int blocking, int read_only, int sg_io_owned,
Adel Gadllah0b07de82008-06-26 13:48:27 +0200719 Sg_request **o_srp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720{
721 int k;
722 Sg_request *srp;
723 sg_io_hdr_t *hp;
Douglas Gilbert65c26a02014-06-03 13:18:18 -0400724 unsigned char cmnd[SG_MAX_CDB_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725 int timeout;
726 unsigned long ul_timeout;
727
728 if (count < SZ_SG_IO_HDR)
729 return -EINVAL;
730 if (!access_ok(VERIFY_READ, buf, count))
731 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
732
733 sfp->cmd_q = 1; /* when sg_io_hdr seen, set command queuing on */
734 if (!(srp = sg_add_request(sfp))) {
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200735 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO, sfp->parentdp,
736 "sg_new_write: queue full\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 return -EDOM;
738 }
Tony Battersbya2dd3b42009-01-20 17:00:09 -0500739 srp->sg_io_owned = sg_io_owned;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740 hp = &srp->header;
741 if (__copy_from_user(hp, buf, SZ_SG_IO_HDR)) {
742 sg_remove_request(sfp, srp);
743 return -EFAULT;
744 }
745 if (hp->interface_id != 'S') {
746 sg_remove_request(sfp, srp);
747 return -ENOSYS;
748 }
749 if (hp->flags & SG_FLAG_MMAP_IO) {
750 if (hp->dxfer_len > sfp->reserve.bufflen) {
751 sg_remove_request(sfp, srp);
752 return -ENOMEM; /* MMAP_IO size must fit in reserve buffer */
753 }
754 if (hp->flags & SG_FLAG_DIRECT_IO) {
755 sg_remove_request(sfp, srp);
756 return -EINVAL; /* either MMAP_IO or DIRECT_IO (not both) */
757 }
Hannes Reinecke1bc0eb02017-04-07 09:34:14 +0200758 if (sfp->res_in_use) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759 sg_remove_request(sfp, srp);
760 return -EBUSY; /* reserve buffer already being used */
761 }
762 }
763 ul_timeout = msecs_to_jiffies(srp->header.timeout);
764 timeout = (ul_timeout < INT_MAX) ? ul_timeout : INT_MAX;
765 if ((!hp->cmdp) || (hp->cmd_len < 6) || (hp->cmd_len > sizeof (cmnd))) {
766 sg_remove_request(sfp, srp);
767 return -EMSGSIZE;
768 }
769 if (!access_ok(VERIFY_READ, hp->cmdp, hp->cmd_len)) {
770 sg_remove_request(sfp, srp);
771 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
772 }
773 if (__copy_from_user(cmnd, hp->cmdp, hp->cmd_len)) {
774 sg_remove_request(sfp, srp);
775 return -EFAULT;
776 }
FUJITA Tomonori14e507b2008-07-26 18:03:24 +0900777 if (read_only && sg_allow_access(file, cmnd)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 sg_remove_request(sfp, srp);
779 return -EPERM;
780 }
781 k = sg_common_write(sfp, srp, cmnd, timeout, blocking);
782 if (k < 0)
783 return k;
784 if (o_srp)
785 *o_srp = srp;
786 return count;
787}
788
789static int
790sg_common_write(Sg_fd * sfp, Sg_request * srp,
791 unsigned char *cmnd, int timeout, int blocking)
792{
Bart Van Assche5af2e382015-01-30 16:22:38 +0100793 int k, at_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794 Sg_device *sdp = sfp->parentdp;
795 sg_io_hdr_t *hp = &srp->header;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796
797 srp->data.cmd_opcode = cmnd[0]; /* hold opcode of command */
798 hp->status = 0;
799 hp->masked_status = 0;
800 hp->msg_status = 0;
801 hp->info = 0;
802 hp->host_status = 0;
803 hp->driver_status = 0;
804 hp->resid = 0;
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200805 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
806 "sg_common_write: scsi opcode=0x%02x, cmd_size=%d\n",
807 (int) cmnd[0], (int) hp->cmd_len));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808
Li Binc1ac17a2020-04-13 19:29:21 +0800809 if (hp->dxfer_len >= SZ_256M) {
810 sg_remove_request(sfp, srp);
Johannes Thumshirn28676d82017-04-07 09:34:15 +0200811 return -EINVAL;
Li Binc1ac17a2020-04-13 19:29:21 +0800812 }
Johannes Thumshirn28676d82017-04-07 09:34:15 +0200813
FUJITA Tomonori10865df2008-08-28 16:17:07 +0900814 k = sg_start_req(srp, cmnd);
815 if (k) {
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200816 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO, sfp->parentdp,
817 "sg_common_write: start_req err=%d\n", k));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818 sg_finish_rem_req(srp);
Hannes Reinecke97d27b02017-04-07 09:34:17 +0200819 sg_remove_request(sfp, srp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820 return k; /* probably out of space --> ENOMEM */
821 }
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200822 if (atomic_read(&sdp->detaching)) {
Calvin Owensf3951a32015-10-30 16:57:00 -0700823 if (srp->bio) {
Christoph Hellwig82ed4db2017-01-27 09:46:29 +0100824 scsi_req_free_cmd(scsi_req(srp->rq));
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200825 blk_end_request_all(srp->rq, BLK_STS_IOERR);
Calvin Owensf3951a32015-10-30 16:57:00 -0700826 srp->rq = NULL;
827 }
828
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829 sg_finish_rem_req(srp);
Hannes Reinecke97d27b02017-04-07 09:34:17 +0200830 sg_remove_request(sfp, srp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 return -ENODEV;
832 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833
cb59e842005-04-02 13:51:23 -0600834 hp->duration = jiffies_to_msecs(jiffies);
Douglas Gilbert16070cc2014-06-04 10:58:30 -0400835 if (hp->interface_id != '\0' && /* v3 (or later) interface */
836 (SG_FLAG_Q_AT_TAIL & hp->flags))
837 at_head = 0;
838 else
839 at_head = 1;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +0200840
841 srp->rq->timeout = timeout;
Tony Battersbyc6517b792009-01-21 14:45:50 -0500842 kref_get(&sfp->f_ref); /* sg_rq_end_io() does kref_put(). */
FUJITA Tomonori10db10d2008-08-29 12:32:18 +0200843 blk_execute_rq_nowait(sdp->device->request_queue, sdp->disk,
Douglas Gilbert16070cc2014-06-04 10:58:30 -0400844 srp->rq, at_head, sg_rq_end_io);
FUJITA Tomonori10db10d2008-08-29 12:32:18 +0200845 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846}
847
Jörn Engel6acddc52012-04-12 17:33:58 -0400848static int srp_done(Sg_fd *sfp, Sg_request *srp)
849{
850 unsigned long flags;
851 int ret;
852
853 read_lock_irqsave(&sfp->rq_list_lock, flags);
854 ret = srp->done;
855 read_unlock_irqrestore(&sfp->rq_list_lock, flags);
856 return ret;
857}
858
Akinobu Mita46f69e62014-06-02 22:56:46 +0900859static int max_sectors_bytes(struct request_queue *q)
860{
861 unsigned int max_sectors = queue_max_sectors(q);
862
863 max_sectors = min_t(unsigned int, max_sectors, INT_MAX >> 9);
864
865 return max_sectors << 9;
866}
867
Hannes Reinecke4759df92017-09-15 14:05:15 +0200868static void
869sg_fill_request_table(Sg_fd *sfp, sg_req_info_t *rinfo)
870{
871 Sg_request *srp;
872 int val;
873 unsigned int ms;
874
875 val = 0;
876 list_for_each_entry(srp, &sfp->rq_list, entry) {
Ben Hutchings587c3c92017-10-15 18:16:33 +0100877 if (val >= SG_MAX_QUEUE)
Hannes Reinecke4759df92017-09-15 14:05:15 +0200878 break;
Hannes Reinecke4759df92017-09-15 14:05:15 +0200879 rinfo[val].req_state = srp->done + 1;
880 rinfo[val].problem =
881 srp->header.masked_status &
882 srp->header.host_status &
883 srp->header.driver_status;
884 if (srp->done)
885 rinfo[val].duration =
886 srp->header.duration;
887 else {
888 ms = jiffies_to_msecs(jiffies);
889 rinfo[val].duration =
890 (ms > srp->header.duration) ?
891 (ms - srp->header.duration) : 0;
892 }
893 rinfo[val].orphan = srp->orphan;
894 rinfo[val].sg_io_owned = srp->sg_io_owned;
895 rinfo[val].pack_id = srp->header.pack_id;
896 rinfo[val].usr_ptr = srp->header.usr_ptr;
897 val++;
898 }
899}
900
Jörn Engel37b9d1e2012-04-12 17:35:05 -0400901static long
Arnd Bergmannf4927c42010-04-27 00:24:01 +0200902sg_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903{
904 void __user *p = (void __user *)arg;
905 int __user *ip = p;
Christoph Hellwig176aa9d2014-10-11 12:06:47 +0200906 int result, val, read_only;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907 Sg_device *sdp;
908 Sg_fd *sfp;
909 Sg_request *srp;
910 unsigned long iflags;
911
912 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
913 return -ENXIO;
FUJITA Tomonoriabf54392008-08-16 14:10:05 +0900914
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200915 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
916 "sg_ioctl: cmd=0x%x\n", (int) cmd_in));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917 read_only = (O_RDWR != (filp->f_flags & O_ACCMODE));
918
919 switch (cmd_in) {
920 case SG_IO:
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200921 if (atomic_read(&sdp->detaching))
Jörn Engeldddbf8d2012-04-12 17:32:17 -0400922 return -ENODEV;
923 if (!scsi_block_when_processing_errors(sdp->device))
924 return -ENXIO;
925 if (!access_ok(VERIFY_WRITE, p, SZ_SG_IO_HDR))
926 return -EFAULT;
927 result = sg_new_write(sfp, filp, p, SZ_SG_IO_HDR,
928 1, read_only, 1, &srp);
929 if (result < 0)
930 return result;
Jörn Engel3f0c6ab2012-04-12 17:33:25 -0400931 result = wait_event_interruptible(sfp->read_wait,
Tony Battersbyf5e61d92022-07-11 10:51:32 -0400932 srp_done(sfp, srp));
Jörn Engel794c10f2012-04-12 17:32:48 -0400933 write_lock_irq(&sfp->rq_list_lock);
934 if (srp->done) {
935 srp->done = 2;
Jörn Engeldddbf8d2012-04-12 17:32:17 -0400936 write_unlock_irq(&sfp->rq_list_lock);
Jörn Engel794c10f2012-04-12 17:32:48 -0400937 result = sg_new_read(sfp, p, SZ_SG_IO_HDR, srp);
938 return (result < 0) ? result : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939 }
Jörn Engel794c10f2012-04-12 17:32:48 -0400940 srp->orphan = 1;
941 write_unlock_irq(&sfp->rq_list_lock);
942 return result; /* -ERESTARTSYS because signal hit process */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943 case SG_SET_TIMEOUT:
944 result = get_user(val, ip);
945 if (result)
946 return result;
947 if (val < 0)
948 return -EIO;
Paul Burtonf8630bd72016-08-19 17:43:57 +0100949 if (val >= mult_frac((s64)INT_MAX, USER_HZ, HZ))
950 val = min_t(s64, mult_frac((s64)INT_MAX, USER_HZ, HZ),
Paul Burtonb9b6e802016-08-19 17:43:56 +0100951 INT_MAX);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952 sfp->timeout_user = val;
Paul Burtonf8630bd72016-08-19 17:43:57 +0100953 sfp->timeout = mult_frac(val, HZ, USER_HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954
955 return 0;
956 case SG_GET_TIMEOUT: /* N.B. User receives timeout as return value */
957 /* strange ..., for backward compatibility */
958 return sfp->timeout_user;
959 case SG_SET_FORCE_LOW_DMA:
Hannes Reinecke745dfa02017-04-07 09:34:12 +0200960 /*
961 * N.B. This ioctl never worked properly, but failed to
962 * return an error value. So returning '0' to keep compability
963 * with legacy applications.
964 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965 return 0;
966 case SG_GET_LOW_DMA:
Hannes Reinecke745dfa02017-04-07 09:34:12 +0200967 return put_user((int) sdp->device->host->unchecked_isa_dma, ip);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968 case SG_GET_SCSI_ID:
969 if (!access_ok(VERIFY_WRITE, p, sizeof (sg_scsi_id_t)))
970 return -EFAULT;
971 else {
972 sg_scsi_id_t __user *sg_idp = p;
973
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200974 if (atomic_read(&sdp->detaching))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975 return -ENODEV;
976 __put_user((int) sdp->device->host->host_no,
977 &sg_idp->host_no);
978 __put_user((int) sdp->device->channel,
979 &sg_idp->channel);
980 __put_user((int) sdp->device->id, &sg_idp->scsi_id);
981 __put_user((int) sdp->device->lun, &sg_idp->lun);
982 __put_user((int) sdp->device->type, &sg_idp->scsi_type);
983 __put_user((short) sdp->device->host->cmd_per_lun,
984 &sg_idp->h_cmd_per_lun);
985 __put_user((short) sdp->device->queue_depth,
986 &sg_idp->d_queue_depth);
987 __put_user(0, &sg_idp->unused[0]);
988 __put_user(0, &sg_idp->unused[1]);
989 return 0;
990 }
991 case SG_SET_FORCE_PACK_ID:
992 result = get_user(val, ip);
993 if (result)
994 return result;
995 sfp->force_packid = val ? 1 : 0;
996 return 0;
997 case SG_GET_PACK_ID:
998 if (!access_ok(VERIFY_WRITE, ip, sizeof (int)))
999 return -EFAULT;
1000 read_lock_irqsave(&sfp->rq_list_lock, iflags);
Hannes Reinecke109bade2017-04-07 09:34:16 +02001001 list_for_each_entry(srp, &sfp->rq_list, entry) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002 if ((1 == srp->done) && (!srp->sg_io_owned)) {
1003 read_unlock_irqrestore(&sfp->rq_list_lock,
1004 iflags);
1005 __put_user(srp->header.pack_id, ip);
1006 return 0;
1007 }
1008 }
1009 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1010 __put_user(-1, ip);
1011 return 0;
1012 case SG_GET_NUM_WAITING:
1013 read_lock_irqsave(&sfp->rq_list_lock, iflags);
Hannes Reinecke109bade2017-04-07 09:34:16 +02001014 val = 0;
1015 list_for_each_entry(srp, &sfp->rq_list, entry) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016 if ((1 == srp->done) && (!srp->sg_io_owned))
1017 ++val;
1018 }
1019 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1020 return put_user(val, ip);
1021 case SG_GET_SG_TABLESIZE:
1022 return put_user(sdp->sg_tablesize, ip);
1023 case SG_SET_RESERVED_SIZE:
1024 result = get_user(val, ip);
1025 if (result)
1026 return result;
1027 if (val < 0)
1028 return -EINVAL;
Alan Stern44ec9542007-02-20 11:01:57 -05001029 val = min_t(int, val,
Akinobu Mita46f69e62014-06-02 22:56:46 +09001030 max_sectors_bytes(sdp->device->request_queue));
Hannes Reinecke1bc0eb02017-04-07 09:34:14 +02001031 mutex_lock(&sfp->f_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032 if (val != sfp->reserve.bufflen) {
Hannes Reinecke1bc0eb02017-04-07 09:34:14 +02001033 if (sfp->mmap_called ||
1034 sfp->res_in_use) {
1035 mutex_unlock(&sfp->f_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036 return -EBUSY;
Hannes Reinecke1bc0eb02017-04-07 09:34:14 +02001037 }
1038
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001039 sg_remove_scat(sfp, &sfp->reserve);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040 sg_build_reserve(sfp, val);
1041 }
Hannes Reinecke1bc0eb02017-04-07 09:34:14 +02001042 mutex_unlock(&sfp->f_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043 return 0;
1044 case SG_GET_RESERVED_SIZE:
Alan Stern44ec9542007-02-20 11:01:57 -05001045 val = min_t(int, sfp->reserve.bufflen,
Akinobu Mita46f69e62014-06-02 22:56:46 +09001046 max_sectors_bytes(sdp->device->request_queue));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047 return put_user(val, ip);
1048 case SG_SET_COMMAND_Q:
1049 result = get_user(val, ip);
1050 if (result)
1051 return result;
1052 sfp->cmd_q = val ? 1 : 0;
1053 return 0;
1054 case SG_GET_COMMAND_Q:
1055 return put_user((int) sfp->cmd_q, ip);
1056 case SG_SET_KEEP_ORPHAN:
1057 result = get_user(val, ip);
1058 if (result)
1059 return result;
1060 sfp->keep_orphan = val;
1061 return 0;
1062 case SG_GET_KEEP_ORPHAN:
1063 return put_user((int) sfp->keep_orphan, ip);
1064 case SG_NEXT_CMD_LEN:
1065 result = get_user(val, ip);
1066 if (result)
1067 return result;
peter changbf33f872017-02-15 14:11:54 -08001068 if (val > SG_MAX_CDB_SIZE)
1069 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070 sfp->next_cmd_len = (val > 0) ? val : 0;
1071 return 0;
1072 case SG_GET_VERSION_NUM:
1073 return put_user(sg_version_num, ip);
1074 case SG_GET_ACCESS_COUNT:
1075 /* faked - we don't have a real access count anymore */
1076 val = (sdp->device ? 1 : 0);
1077 return put_user(val, ip);
1078 case SG_GET_REQUEST_TABLE:
1079 if (!access_ok(VERIFY_WRITE, p, SZ_SG_REQ_INFO * SG_MAX_QUEUE))
1080 return -EFAULT;
1081 else {
cb59e842005-04-02 13:51:23 -06001082 sg_req_info_t *rinfo;
cb59e842005-04-02 13:51:23 -06001083
Hannes Reinecke3e009742017-09-15 14:05:16 +02001084 rinfo = kzalloc(SZ_SG_REQ_INFO * SG_MAX_QUEUE,
1085 GFP_KERNEL);
cb59e842005-04-02 13:51:23 -06001086 if (!rinfo)
1087 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001088 read_lock_irqsave(&sfp->rq_list_lock, iflags);
Hannes Reinecke4759df92017-09-15 14:05:15 +02001089 sg_fill_request_table(sfp, rinfo);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001090 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
Hannes Reinecke109bade2017-04-07 09:34:16 +02001091 result = __copy_to_user(p, rinfo,
cb59e842005-04-02 13:51:23 -06001092 SZ_SG_REQ_INFO * SG_MAX_QUEUE);
1093 result = result ? -EFAULT : 0;
1094 kfree(rinfo);
1095 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096 }
1097 case SG_EMULATED_HOST:
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001098 if (atomic_read(&sdp->detaching))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099 return -ENODEV;
1100 return put_user(sdp->device->host->hostt->emulated, ip);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101 case SCSI_IOCTL_SEND_COMMAND:
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001102 if (atomic_read(&sdp->detaching))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103 return -ENODEV;
1104 if (read_only) {
1105 unsigned char opcode = WRITE_6;
1106 Scsi_Ioctl_Command __user *siocp = p;
1107
1108 if (copy_from_user(&opcode, siocp->data, 1))
1109 return -EFAULT;
FUJITA Tomonori14e507b2008-07-26 18:03:24 +09001110 if (sg_allow_access(filp, &opcode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001111 return -EPERM;
1112 }
Al Viroe915e872008-09-02 17:16:41 -04001113 return sg_scsi_ioctl(sdp->device->request_queue, NULL, filp->f_mode, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001114 case SG_SET_DEBUG:
1115 result = get_user(val, ip);
1116 if (result)
1117 return result;
1118 sdp->sgdebug = (char) val;
1119 return 0;
Alan Stern44ec9542007-02-20 11:01:57 -05001120 case BLKSECTGET:
Akinobu Mita46f69e62014-06-02 22:56:46 +09001121 return put_user(max_sectors_bytes(sdp->device->request_queue),
Alan Stern44ec9542007-02-20 11:01:57 -05001122 ip);
Christof Schmitt6da127a2008-01-11 10:09:43 +01001123 case BLKTRACESETUP:
1124 return blk_trace_setup(sdp->device->request_queue,
1125 sdp->disk->disk_name,
Martin Peschke76e3a192009-01-30 15:46:23 +01001126 MKDEV(SCSI_GENERIC_MAJOR, sdp->index),
Bart Van Assche7475c8a2017-08-25 13:46:36 -07001127 NULL, p);
Christof Schmitt6da127a2008-01-11 10:09:43 +01001128 case BLKTRACESTART:
1129 return blk_trace_startstop(sdp->device->request_queue, 1);
1130 case BLKTRACESTOP:
1131 return blk_trace_startstop(sdp->device->request_queue, 0);
1132 case BLKTRACETEARDOWN:
1133 return blk_trace_remove(sdp->device->request_queue);
Christoph Hellwig906d15f2014-10-11 16:25:31 +02001134 case SCSI_IOCTL_GET_IDLUN:
1135 case SCSI_IOCTL_GET_BUS_NUMBER:
1136 case SCSI_IOCTL_PROBE_HOST:
1137 case SG_GET_TRANSFORM:
1138 case SG_SCSI_RESET:
1139 if (atomic_read(&sdp->detaching))
1140 return -ENODEV;
1141 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142 default:
1143 if (read_only)
1144 return -EPERM; /* don't know so take safe approach */
Christoph Hellwig906d15f2014-10-11 16:25:31 +02001145 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146 }
Christoph Hellwig906d15f2014-10-11 16:25:31 +02001147
1148 result = scsi_ioctl_block_when_processing_errors(sdp->device,
1149 cmd_in, filp->f_flags & O_NDELAY);
1150 if (result)
1151 return result;
1152 return scsi_ioctl(sdp->device, cmd_in, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001153}
1154
1155#ifdef CONFIG_COMPAT
1156static long sg_compat_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
1157{
1158 Sg_device *sdp;
1159 Sg_fd *sfp;
1160 struct scsi_device *sdev;
1161
1162 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1163 return -ENXIO;
1164
1165 sdev = sdp->device;
1166 if (sdev->host->hostt->compat_ioctl) {
1167 int ret;
1168
1169 ret = sdev->host->hostt->compat_ioctl(sdev, cmd_in, (void __user *)arg);
1170
1171 return ret;
1172 }
1173
1174 return -ENOIOCTLCMD;
1175}
1176#endif
1177
1178static unsigned int
1179sg_poll(struct file *filp, poll_table * wait)
1180{
1181 unsigned int res = 0;
1182 Sg_device *sdp;
1183 Sg_fd *sfp;
1184 Sg_request *srp;
1185 int count = 0;
1186 unsigned long iflags;
1187
Jörn Engelebaf4662012-04-12 17:33:39 -04001188 sfp = filp->private_data;
1189 if (!sfp)
1190 return POLLERR;
1191 sdp = sfp->parentdp;
1192 if (!sdp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193 return POLLERR;
1194 poll_wait(filp, &sfp->read_wait, wait);
1195 read_lock_irqsave(&sfp->rq_list_lock, iflags);
Hannes Reinecke109bade2017-04-07 09:34:16 +02001196 list_for_each_entry(srp, &sfp->rq_list, entry) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197 /* if any read waiting, flag it */
1198 if ((0 == res) && (1 == srp->done) && (!srp->sg_io_owned))
1199 res = POLLIN | POLLRDNORM;
1200 ++count;
1201 }
1202 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1203
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001204 if (atomic_read(&sdp->detaching))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205 res |= POLLHUP;
1206 else if (!sfp->cmd_q) {
1207 if (0 == count)
1208 res |= POLLOUT | POLLWRNORM;
1209 } else if (count < SG_MAX_QUEUE)
1210 res |= POLLOUT | POLLWRNORM;
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001211 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
1212 "sg_poll: res=0x%x\n", (int) res));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213 return res;
1214}
1215
1216static int
1217sg_fasync(int fd, struct file *filp, int mode)
1218{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219 Sg_device *sdp;
1220 Sg_fd *sfp;
1221
1222 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1223 return -ENXIO;
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001224 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
1225 "sg_fasync: mode=%d\n", mode));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226
Jonathan Corbet60aa4922009-02-01 14:52:56 -07001227 return fasync_helper(fd, filp, mode, &sfp->async_qp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228}
1229
Nick Piggina13ff0b2008-02-07 18:46:06 -08001230static int
Dave Jiang11bac802017-02-24 14:56:41 -08001231sg_vma_fault(struct vm_fault *vmf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232{
Dave Jiang11bac802017-02-24 14:56:41 -08001233 struct vm_area_struct *vma = vmf->vma;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234 Sg_fd *sfp;
Mike Christied6b10342005-11-08 04:06:41 -06001235 unsigned long offset, len, sa;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236 Sg_scatter_hold *rsv_schp;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001237 int k, length;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238
1239 if ((NULL == vma) || (!(sfp = (Sg_fd *) vma->vm_private_data)))
Nick Piggina13ff0b2008-02-07 18:46:06 -08001240 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241 rsv_schp = &sfp->reserve;
Nick Piggina13ff0b2008-02-07 18:46:06 -08001242 offset = vmf->pgoff << PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001243 if (offset >= rsv_schp->bufflen)
Nick Piggina13ff0b2008-02-07 18:46:06 -08001244 return VM_FAULT_SIGBUS;
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001245 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sfp->parentdp,
1246 "sg_vma_fault: offset=%lu, scatg=%d\n",
1247 offset, rsv_schp->k_use_sg));
Mike Christied6b10342005-11-08 04:06:41 -06001248 sa = vma->vm_start;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001249 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1250 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
Mike Christied6b10342005-11-08 04:06:41 -06001251 len = vma->vm_end - sa;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001252 len = (len < length) ? len : length;
Mike Christied6b10342005-11-08 04:06:41 -06001253 if (offset < len) {
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001254 struct page *page = nth_page(rsv_schp->pages[k],
1255 offset >> PAGE_SHIFT);
Mike Christied6b10342005-11-08 04:06:41 -06001256 get_page(page); /* increment page count */
Nick Piggina13ff0b2008-02-07 18:46:06 -08001257 vmf->page = page;
1258 return 0; /* success */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001259 }
Mike Christied6b10342005-11-08 04:06:41 -06001260 sa += len;
1261 offset -= len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262 }
Mike Christied6b10342005-11-08 04:06:41 -06001263
Nick Piggina13ff0b2008-02-07 18:46:06 -08001264 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265}
1266
Alexey Dobriyanf0f37e22009-09-27 22:29:37 +04001267static const struct vm_operations_struct sg_mmap_vm_ops = {
Nick Piggina13ff0b2008-02-07 18:46:06 -08001268 .fault = sg_vma_fault,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269};
1270
1271static int
1272sg_mmap(struct file *filp, struct vm_area_struct *vma)
1273{
1274 Sg_fd *sfp;
Mike Christied6b10342005-11-08 04:06:41 -06001275 unsigned long req_sz, len, sa;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001276 Sg_scatter_hold *rsv_schp;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001277 int k, length;
Todd Poynor6a8dadc2017-08-15 22:41:08 -07001278 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279
1280 if ((!filp) || (!vma) || (!(sfp = (Sg_fd *) filp->private_data)))
1281 return -ENXIO;
cb59e842005-04-02 13:51:23 -06001282 req_sz = vma->vm_end - vma->vm_start;
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001283 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sfp->parentdp,
1284 "sg_mmap starting, vm_start=%p, len=%d\n",
1285 (void *) vma->vm_start, (int) req_sz));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286 if (vma->vm_pgoff)
1287 return -EINVAL; /* want no offset */
1288 rsv_schp = &sfp->reserve;
Todd Poynor6a8dadc2017-08-15 22:41:08 -07001289 mutex_lock(&sfp->f_mutex);
1290 if (req_sz > rsv_schp->bufflen) {
1291 ret = -ENOMEM; /* cannot map more than reserved buffer */
1292 goto out;
1293 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294
Mike Christied6b10342005-11-08 04:06:41 -06001295 sa = vma->vm_start;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001296 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1297 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
Mike Christied6b10342005-11-08 04:06:41 -06001298 len = vma->vm_end - sa;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001299 len = (len < length) ? len : length;
Mike Christied6b10342005-11-08 04:06:41 -06001300 sa += len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001301 }
Mike Christied6b10342005-11-08 04:06:41 -06001302
Nick Pigginf9aed0e2006-03-22 00:08:30 -08001303 sfp->mmap_called = 1;
Kirill A. Shutemov461c7fa2016-02-02 16:57:35 -08001304 vma->vm_flags |= VM_IO | VM_DONTEXPAND | VM_DONTDUMP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001305 vma->vm_private_data = sfp;
1306 vma->vm_ops = &sg_mmap_vm_ops;
Todd Poynor6a8dadc2017-08-15 22:41:08 -07001307out:
1308 mutex_unlock(&sfp->f_mutex);
1309 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310}
1311
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001312static void
1313sg_rq_end_io_usercontext(struct work_struct *work)
FUJITA Tomonoric96952e2009-02-04 11:36:27 +09001314{
1315 struct sg_request *srp = container_of(work, struct sg_request, ew.work);
1316 struct sg_fd *sfp = srp->parentfp;
1317
1318 sg_finish_rem_req(srp);
Hannes Reinecke97d27b02017-04-07 09:34:17 +02001319 sg_remove_request(sfp, srp);
FUJITA Tomonoric96952e2009-02-04 11:36:27 +09001320 kref_put(&sfp->f_ref, sg_remove_sfp);
1321}
1322
FUJITA Tomonoria91a3a22008-09-02 22:50:01 +09001323/*
1324 * This function is a "bottom half" handler that is called by the mid
1325 * level when a command is completed (or has failed).
1326 */
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001327static void
Christoph Hellwig2a842ac2017-06-03 09:38:04 +02001328sg_rq_end_io(struct request *rq, blk_status_t status)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329{
FUJITA Tomonoria91a3a22008-09-02 22:50:01 +09001330 struct sg_request *srp = rq->end_io_data;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001331 struct scsi_request *req = scsi_req(rq);
Tony Battersbyc6517b792009-01-21 14:45:50 -05001332 Sg_device *sdp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333 Sg_fd *sfp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001334 unsigned long iflags;
cb59e842005-04-02 13:51:23 -06001335 unsigned int ms;
FUJITA Tomonoria91a3a22008-09-02 22:50:01 +09001336 char *sense;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001337 int result, resid, done = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338
Tony Battersbyc6517b792009-01-21 14:45:50 -05001339 if (WARN_ON(srp->done != 0))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340 return;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001341
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342 sfp = srp->parentfp;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001343 if (WARN_ON(sfp == NULL))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344 return;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001345
1346 sdp = sfp->parentdp;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001347 if (unlikely(atomic_read(&sdp->detaching)))
1348 pr_info("%s: device detaching\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001350 sense = req->sense;
Christoph Hellwig17d53632017-04-20 16:03:01 +02001351 result = req->result;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001352 resid = req->resid_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001354 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sdp,
1355 "sg_cmd_done: pack_id=%d, res=0x%x\n",
1356 srp->header.pack_id, result));
Mike Christied6b10342005-11-08 04:06:41 -06001357 srp->header.resid = resid;
cb59e842005-04-02 13:51:23 -06001358 ms = jiffies_to_msecs(jiffies);
1359 srp->header.duration = (ms > srp->header.duration) ?
1360 (ms - srp->header.duration) : 0;
Mike Christied6b10342005-11-08 04:06:41 -06001361 if (0 != result) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362 struct scsi_sense_hdr sshdr;
1363
Mike Christied6b10342005-11-08 04:06:41 -06001364 srp->header.status = 0xff & result;
1365 srp->header.masked_status = status_byte(result);
1366 srp->header.msg_status = msg_byte(result);
1367 srp->header.host_status = host_byte(result);
1368 srp->header.driver_status = driver_byte(result);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369 if ((sdp->sgdebug > 0) &&
1370 ((CHECK_CONDITION == srp->header.masked_status) ||
1371 (COMMAND_TERMINATED == srp->header.masked_status)))
Hannes Reinecked811b842014-10-24 14:26:45 +02001372 __scsi_print_sense(sdp->device, __func__, sense,
Mike Christied6b10342005-11-08 04:06:41 -06001373 SCSI_SENSE_BUFFERSIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374
1375 /* Following if statement is a patch supplied by Eric Youngdale */
Mike Christied6b10342005-11-08 04:06:41 -06001376 if (driver_byte(result) != 0
1377 && scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, &sshdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378 && !scsi_sense_is_deferred(&sshdr)
1379 && sshdr.sense_key == UNIT_ATTENTION
1380 && sdp->device->removable) {
1381 /* Detected possible disc change. Set the bit - this */
1382 /* may be used if there are filesystems using this device */
1383 sdp->device->changed = 1;
1384 }
1385 }
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001386
1387 if (req->sense_len)
1388 memcpy(srp->sense_b, req->sense, SCSI_SENSE_BUFFERSIZE);
1389
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390 /* Rely on write phase to clean out srp status values, so no "else" */
1391
Tony Battersby75686152015-02-13 12:09:44 -05001392 /*
1393 * Free the request as soon as it is complete so that its resources
1394 * can be reused without waiting for userspace to read() the
1395 * result. But keep the associated bio (if any) around until
1396 * blk_rq_unmap_user() can be called from user context.
1397 */
1398 srp->rq = NULL;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001399 scsi_req_free_cmd(scsi_req(rq));
Tony Battersby75686152015-02-13 12:09:44 -05001400 __blk_put_request(rq->q, rq);
1401
Tony Battersbyc6517b792009-01-21 14:45:50 -05001402 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1403 if (unlikely(srp->orphan)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404 if (sfp->keep_orphan)
1405 srp->sg_io_owned = 0;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001406 else
1407 done = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408 }
Tony Battersbyc6517b792009-01-21 14:45:50 -05001409 srp->done = done;
1410 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1411
1412 if (likely(done)) {
1413 /* Now wake up any sg_read() that is waiting for this
1414 * packet.
1415 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416 wake_up_interruptible(&sfp->read_wait);
Tony Battersbyc6517b792009-01-21 14:45:50 -05001417 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_IN);
FUJITA Tomonoric96952e2009-02-04 11:36:27 +09001418 kref_put(&sfp->f_ref, sg_remove_sfp);
FUJITA Tomonori015640e2009-04-03 19:28:06 +09001419 } else {
1420 INIT_WORK(&srp->ew.work, sg_rq_end_io_usercontext);
1421 schedule_work(&srp->ew.work);
1422 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423}
1424
Alexey Dobriyan828c0952009-10-01 15:43:56 -07001425static const struct file_operations sg_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426 .owner = THIS_MODULE,
1427 .read = sg_read,
1428 .write = sg_write,
1429 .poll = sg_poll,
Jörn Engel37b9d1e2012-04-12 17:35:05 -04001430 .unlocked_ioctl = sg_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431#ifdef CONFIG_COMPAT
1432 .compat_ioctl = sg_compat_ioctl,
1433#endif
1434 .open = sg_open,
1435 .mmap = sg_mmap,
1436 .release = sg_release,
1437 .fasync = sg_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001438 .llseek = no_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439};
1440
gregkh@suse.ded2538782005-03-23 09:55:22 -08001441static struct class *sg_sysfs_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442
1443static int sg_sysfs_valid = 0;
1444
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001445static Sg_device *
1446sg_alloc(struct gendisk *disk, struct scsi_device *scsidp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447{
Mike Christied6b10342005-11-08 04:06:41 -06001448 struct request_queue *q = scsidp->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001449 Sg_device *sdp;
1450 unsigned long iflags;
James Bottomley7c07d612007-08-05 13:36:11 -05001451 int error;
1452 u32 k;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453
Jes Sorensen24669f752006-01-16 10:31:18 -05001454 sdp = kzalloc(sizeof(Sg_device), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455 if (!sdp) {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001456 sdev_printk(KERN_WARNING, scsidp, "%s: kmalloc Sg_device "
1457 "failure\n", __func__);
James Bottomley7c07d612007-08-05 13:36:11 -05001458 return ERR_PTR(-ENOMEM);
1459 }
Tony Battersbyc6517b792009-01-21 14:45:50 -05001460
Tejun Heob98c52b2013-02-27 17:04:42 -08001461 idr_preload(GFP_KERNEL);
James Bottomley7c07d612007-08-05 13:36:11 -05001462 write_lock_irqsave(&sg_index_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463
Tejun Heob98c52b2013-02-27 17:04:42 -08001464 error = idr_alloc(&sg_index_idr, sdp, 0, SG_MAX_DEVS, GFP_NOWAIT);
1465 if (error < 0) {
1466 if (error == -ENOSPC) {
1467 sdev_printk(KERN_WARNING, scsidp,
1468 "Unable to attach sg device type=%d, minor number exceeds %d\n",
1469 scsidp->type, SG_MAX_DEVS - 1);
1470 error = -ENODEV;
1471 } else {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001472 sdev_printk(KERN_WARNING, scsidp, "%s: idr "
1473 "allocation Sg_device failure: %d\n",
1474 __func__, error);
Tejun Heob98c52b2013-02-27 17:04:42 -08001475 }
1476 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477 }
Tejun Heob98c52b2013-02-27 17:04:42 -08001478 k = error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001479
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001480 SCSI_LOG_TIMEOUT(3, sdev_printk(KERN_INFO, scsidp,
1481 "sg_alloc: dev=%d \n", k));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482 sprintf(disk->disk_name, "sg%d", k);
1483 disk->first_minor = k;
1484 sdp->disk = disk;
1485 sdp->device = scsidp;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001486 mutex_init(&sdp->open_rel_lock);
FUJITA Tomonori3442f802009-02-16 13:26:53 +09001487 INIT_LIST_HEAD(&sdp->sfds);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001488 init_waitqueue_head(&sdp->open_wait);
1489 atomic_set(&sdp->detaching, 0);
1490 rwlock_init(&sdp->sfd_lock);
Martin K. Petersen8a783622010-02-26 00:20:39 -05001491 sdp->sg_tablesize = queue_max_segments(q);
James Bottomley7c07d612007-08-05 13:36:11 -05001492 sdp->index = k;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001493 kref_init(&sdp->d_ref);
James Bottomley7c07d612007-08-05 13:36:11 -05001494 error = 0;
Tejun Heob98c52b2013-02-27 17:04:42 -08001495
1496out_unlock:
1497 write_unlock_irqrestore(&sg_index_lock, iflags);
1498 idr_preload_end();
1499
James Bottomley7c07d612007-08-05 13:36:11 -05001500 if (error) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501 kfree(sdp);
James Bottomley7c07d612007-08-05 13:36:11 -05001502 return ERR_PTR(error);
1503 }
1504 return sdp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001505}
1506
1507static int
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001508sg_add_device(struct device *cl_dev, struct class_interface *cl_intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509{
Tony Jonesee959b02008-02-22 00:13:36 +01001510 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511 struct gendisk *disk;
1512 Sg_device *sdp = NULL;
1513 struct cdev * cdev = NULL;
James Bottomley7c07d612007-08-05 13:36:11 -05001514 int error;
Ishai Rabinovitz454e8952006-06-29 16:39:54 +03001515 unsigned long iflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516
1517 disk = alloc_disk(1);
1518 if (!disk) {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001519 pr_warn("%s: alloc_disk failed\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520 return -ENOMEM;
1521 }
1522 disk->major = SCSI_GENERIC_MAJOR;
1523
1524 error = -ENOMEM;
1525 cdev = cdev_alloc();
1526 if (!cdev) {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001527 pr_warn("%s: cdev_alloc failed\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528 goto out;
1529 }
1530 cdev->owner = THIS_MODULE;
1531 cdev->ops = &sg_fops;
1532
James Bottomley7c07d612007-08-05 13:36:11 -05001533 sdp = sg_alloc(disk, scsidp);
1534 if (IS_ERR(sdp)) {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001535 pr_warn("%s: sg_alloc failed\n", __func__);
James Bottomley7c07d612007-08-05 13:36:11 -05001536 error = PTR_ERR(sdp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001537 goto out;
1538 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539
James Bottomley7c07d612007-08-05 13:36:11 -05001540 error = cdev_add(cdev, MKDEV(SCSI_GENERIC_MAJOR, sdp->index), 1);
Greg KH5e3c34c2006-01-18 16:17:46 -08001541 if (error)
Ishai Rabinovitz454e8952006-06-29 16:39:54 +03001542 goto cdev_add_err;
Greg KH5e3c34c2006-01-18 16:17:46 -08001543
Linus Torvalds1da177e2005-04-16 15:20:36 -07001544 sdp->cdev = cdev;
1545 if (sg_sysfs_valid) {
Tony Jonesee959b02008-02-22 00:13:36 +01001546 struct device *sg_class_member;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001547
Greg Kroah-Hartmand73a1a62008-07-21 20:03:34 -07001548 sg_class_member = device_create(sg_sysfs_class, cl_dev->parent,
1549 MKDEV(SCSI_GENERIC_MAJOR,
1550 sdp->index),
1551 sdp, "%s", disk->disk_name);
FUJITA Tomonorid07e0362008-01-15 13:18:00 +09001552 if (IS_ERR(sg_class_member)) {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001553 pr_err("%s: device_create failed\n", __func__);
FUJITA Tomonorid07e0362008-01-15 13:18:00 +09001554 error = PTR_ERR(sg_class_member);
1555 goto cdev_add_err;
1556 }
FUJITA Tomonorid07e0362008-01-15 13:18:00 +09001557 error = sysfs_create_link(&scsidp->sdev_gendev.kobj,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558 &sg_class_member->kobj, "generic");
1559 if (error)
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001560 pr_err("%s: unable to make symlink 'generic' back "
1561 "to sg%d\n", __func__, sdp->index);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562 } else
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001563 pr_warn("%s: sg_sys Invalid\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001565 sdev_printk(KERN_NOTICE, scsidp, "Attached scsi generic sg%d "
1566 "type %d\n", sdp->index, scsidp->type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567
Tony Jonesee959b02008-02-22 00:13:36 +01001568 dev_set_drvdata(cl_dev, sdp);
FUJITA Tomonoria24484f2008-01-15 13:17:47 +09001569
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570 return 0;
1571
Ishai Rabinovitz454e8952006-06-29 16:39:54 +03001572cdev_add_err:
James Bottomley7c07d612007-08-05 13:36:11 -05001573 write_lock_irqsave(&sg_index_lock, iflags);
1574 idr_remove(&sg_index_idr, sdp->index);
1575 write_unlock_irqrestore(&sg_index_lock, iflags);
1576 kfree(sdp);
Ishai Rabinovitz454e8952006-06-29 16:39:54 +03001577
Linus Torvalds1da177e2005-04-16 15:20:36 -07001578out:
1579 put_disk(disk);
1580 if (cdev)
1581 cdev_del(cdev);
1582 return error;
1583}
1584
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001585static void
1586sg_device_destroy(struct kref *kref)
Tony Battersbyc6517b792009-01-21 14:45:50 -05001587{
1588 struct sg_device *sdp = container_of(kref, struct sg_device, d_ref);
1589 unsigned long flags;
1590
1591 /* CAUTION! Note that the device can still be found via idr_find()
1592 * even though the refcount is 0. Therefore, do idr_remove() BEFORE
1593 * any other cleanup.
1594 */
1595
1596 write_lock_irqsave(&sg_index_lock, flags);
1597 idr_remove(&sg_index_idr, sdp->index);
1598 write_unlock_irqrestore(&sg_index_lock, flags);
1599
1600 SCSI_LOG_TIMEOUT(3,
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001601 sg_printk(KERN_INFO, sdp, "sg_device_destroy\n"));
Tony Battersbyc6517b792009-01-21 14:45:50 -05001602
1603 put_disk(sdp->disk);
1604 kfree(sdp);
1605}
1606
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001607static void
1608sg_remove_device(struct device *cl_dev, struct class_interface *cl_intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609{
Tony Jonesee959b02008-02-22 00:13:36 +01001610 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
1611 Sg_device *sdp = dev_get_drvdata(cl_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612 unsigned long iflags;
1613 Sg_fd *sfp;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001614 int val;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001616 if (!sdp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617 return;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001618 /* want sdp->detaching non-zero as soon as possible */
1619 val = atomic_inc_return(&sdp->detaching);
1620 if (val > 1)
1621 return; /* only want to do following once per device */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001623 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
1624 "%s\n", __func__));
Tony Battersbyc6517b792009-01-21 14:45:50 -05001625
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001626 read_lock_irqsave(&sdp->sfd_lock, iflags);
FUJITA Tomonori3442f802009-02-16 13:26:53 +09001627 list_for_each_entry(sfp, &sdp->sfds, sfd_siblings) {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001628 wake_up_interruptible_all(&sfp->read_wait);
Tony Battersbyc6517b792009-01-21 14:45:50 -05001629 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_HUP);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001630 }
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001631 wake_up_interruptible_all(&sdp->open_wait);
1632 read_unlock_irqrestore(&sdp->sfd_lock, iflags);
James Bottomley7c07d612007-08-05 13:36:11 -05001633
1634 sysfs_remove_link(&scsidp->sdev_gendev.kobj, "generic");
Tony Jonesee959b02008-02-22 00:13:36 +01001635 device_destroy(sg_sysfs_class, MKDEV(SCSI_GENERIC_MAJOR, sdp->index));
James Bottomley7c07d612007-08-05 13:36:11 -05001636 cdev_del(sdp->cdev);
1637 sdp->cdev = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001639 kref_put(&sdp->d_ref, sg_device_destroy);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001640}
1641
Douglas Gilbert6460e752006-09-20 18:20:49 -04001642module_param_named(scatter_elem_sz, scatter_elem_sz, int, S_IRUGO | S_IWUSR);
1643module_param_named(def_reserved_size, def_reserved_size, int,
1644 S_IRUGO | S_IWUSR);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645module_param_named(allow_dio, sg_allow_dio, int, S_IRUGO | S_IWUSR);
1646
1647MODULE_AUTHOR("Douglas Gilbert");
1648MODULE_DESCRIPTION("SCSI generic (sg) driver");
1649MODULE_LICENSE("GPL");
1650MODULE_VERSION(SG_VERSION_STR);
Rene Hermanf018fa52006-03-08 00:14:20 -08001651MODULE_ALIAS_CHARDEV_MAJOR(SCSI_GENERIC_MAJOR);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652
Douglas Gilbert6460e752006-09-20 18:20:49 -04001653MODULE_PARM_DESC(scatter_elem_sz, "scatter gather element "
1654 "size (default: max(SG_SCATTER_SZ, PAGE_SIZE))");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655MODULE_PARM_DESC(def_reserved_size, "size of buffer reserved for each fd");
1656MODULE_PARM_DESC(allow_dio, "allow direct I/O (default: 0 (disallow))");
1657
1658static int __init
1659init_sg(void)
1660{
1661 int rc;
1662
Douglas Gilbert6460e752006-09-20 18:20:49 -04001663 if (scatter_elem_sz < PAGE_SIZE) {
1664 scatter_elem_sz = PAGE_SIZE;
1665 scatter_elem_sz_prev = scatter_elem_sz;
1666 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001667 if (def_reserved_size >= 0)
1668 sg_big_buff = def_reserved_size;
Douglas Gilbert6460e752006-09-20 18:20:49 -04001669 else
1670 def_reserved_size = sg_big_buff;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671
1672 rc = register_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1673 SG_MAX_DEVS, "sg");
1674 if (rc)
1675 return rc;
gregkh@suse.ded2538782005-03-23 09:55:22 -08001676 sg_sysfs_class = class_create(THIS_MODULE, "scsi_generic");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677 if ( IS_ERR(sg_sysfs_class) ) {
1678 rc = PTR_ERR(sg_sysfs_class);
1679 goto err_out;
1680 }
1681 sg_sysfs_valid = 1;
1682 rc = scsi_register_interface(&sg_interface);
1683 if (0 == rc) {
1684#ifdef CONFIG_SCSI_PROC_FS
1685 sg_proc_init();
1686#endif /* CONFIG_SCSI_PROC_FS */
1687 return 0;
1688 }
gregkh@suse.ded2538782005-03-23 09:55:22 -08001689 class_destroy(sg_sysfs_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001690err_out:
1691 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0), SG_MAX_DEVS);
1692 return rc;
1693}
1694
1695static void __exit
1696exit_sg(void)
1697{
1698#ifdef CONFIG_SCSI_PROC_FS
1699 sg_proc_cleanup();
1700#endif /* CONFIG_SCSI_PROC_FS */
1701 scsi_unregister_interface(&sg_interface);
gregkh@suse.ded2538782005-03-23 09:55:22 -08001702 class_destroy(sg_sysfs_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703 sg_sysfs_valid = 0;
1704 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1705 SG_MAX_DEVS);
James Bottomley7c07d612007-08-05 13:36:11 -05001706 idr_destroy(&sg_index_idr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001707}
1708
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001709static int
1710sg_start_req(Sg_request *srp, unsigned char *cmd)
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001711{
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001712 int res;
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001713 struct request *rq;
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001714 struct scsi_request *req;
FUJITA Tomonori44c7b0e2008-09-02 22:50:04 +09001715 Sg_fd *sfp = srp->parentfp;
1716 sg_io_hdr_t *hp = &srp->header;
1717 int dxfer_len = (int) hp->dxfer_len;
1718 int dxfer_dir = hp->dxfer_direction;
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001719 unsigned int iov_count = hp->iovec_count;
FUJITA Tomonori44c7b0e2008-09-02 22:50:04 +09001720 Sg_scatter_hold *req_schp = &srp->data;
1721 Sg_scatter_hold *rsv_schp = &sfp->reserve;
1722 struct request_queue *q = sfp->parentdp->device->request_queue;
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001723 struct rq_map_data *md, map_data;
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001724 int rw = hp->dxfer_direction == SG_DXFER_TO_DEV ? WRITE : READ;
Douglas Gilbert65c26a02014-06-03 13:18:18 -04001725 unsigned char *long_cmdp = NULL;
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001726
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001727 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1728 "sg_start_req: dxfer_len=%d\n",
1729 dxfer_len));
FUJITA Tomonori44c7b0e2008-09-02 22:50:04 +09001730
Douglas Gilbert65c26a02014-06-03 13:18:18 -04001731 if (hp->cmd_len > BLK_MAX_CDB) {
1732 long_cmdp = kzalloc(hp->cmd_len, GFP_KERNEL);
1733 if (!long_cmdp)
1734 return -ENOMEM;
1735 }
1736
Tony Battersby77728552015-02-13 12:10:58 -05001737 /*
1738 * NOTE
1739 *
1740 * With scsi-mq enabled, there are a fixed number of preallocated
1741 * requests equal in number to shost->can_queue. If all of the
1742 * preallocated requests are already in use, then using GFP_ATOMIC with
1743 * blk_get_request() will return -EWOULDBLOCK, whereas using GFP_KERNEL
1744 * will cause blk_get_request() to sleep until an active command
1745 * completes, freeing up a request. Neither option is ideal, but
1746 * GFP_KERNEL is the better choice to prevent userspace from getting an
1747 * unexpected EWOULDBLOCK.
1748 *
1749 * With scsi-mq disabled, blk_get_request() with GFP_KERNEL usually
1750 * does not sleep except under memory pressure.
1751 */
Christoph Hellwigaebf5262017-01-31 16:57:31 +01001752 rq = blk_get_request(q, hp->dxfer_direction == SG_DXFER_TO_DEV ?
1753 REQ_OP_SCSI_OUT : REQ_OP_SCSI_IN, GFP_KERNEL);
Joe Lawrencea492f072014-08-28 08:15:21 -06001754 if (IS_ERR(rq)) {
Douglas Gilbert65c26a02014-06-03 13:18:18 -04001755 kfree(long_cmdp);
Joe Lawrencea492f072014-08-28 08:15:21 -06001756 return PTR_ERR(rq);
Douglas Gilbert65c26a02014-06-03 13:18:18 -04001757 }
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001758 req = scsi_req(rq);
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001759
Douglas Gilbert65c26a02014-06-03 13:18:18 -04001760 if (hp->cmd_len > BLK_MAX_CDB)
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001761 req->cmd = long_cmdp;
1762 memcpy(req->cmd, cmd, hp->cmd_len);
1763 req->cmd_len = hp->cmd_len;
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001764
1765 srp->rq = rq;
1766 rq->end_io_data = srp;
Christoph Hellwig64c7f1d2017-04-05 19:18:12 +02001767 req->retries = SG_DEFAULT_RETRIES;
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001768
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769 if ((dxfer_len <= 0) || (dxfer_dir == SG_DXFER_NONE))
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001770 return 0;
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001771
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001772 if (sg_allow_dio && hp->flags & SG_FLAG_DIRECT_IO &&
1773 dxfer_dir != SG_DXFER_UNKNOWN && !iov_count &&
1774 !sfp->parentdp->device->host->unchecked_isa_dma &&
Namhyung Kim2610a252010-09-16 12:55:57 +09001775 blk_rq_aligned(q, (unsigned long)hp->dxferp, dxfer_len))
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001776 md = NULL;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001777 else
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001778 md = &map_data;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001779
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001780 if (md) {
Hannes Reinecke1bc0eb02017-04-07 09:34:14 +02001781 mutex_lock(&sfp->f_mutex);
1782 if (dxfer_len <= rsv_schp->bufflen &&
1783 !sfp->res_in_use) {
1784 sfp->res_in_use = 1;
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001785 sg_link_reserve(sfp, srp, dxfer_len);
Todd Poynor8d26f492017-08-15 21:48:43 -07001786 } else if (hp->flags & SG_FLAG_MMAP_IO) {
1787 res = -EBUSY; /* sfp->res_in_use == 1 */
1788 if (dxfer_len > rsv_schp->bufflen)
1789 res = -ENOMEM;
Hannes Reinecke1bc0eb02017-04-07 09:34:14 +02001790 mutex_unlock(&sfp->f_mutex);
Todd Poynor8d26f492017-08-15 21:48:43 -07001791 return res;
Hannes Reinecke1bc0eb02017-04-07 09:34:14 +02001792 } else {
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001793 res = sg_build_indirect(req_schp, sfp, dxfer_len);
Hannes Reinecke1bc0eb02017-04-07 09:34:14 +02001794 if (res) {
1795 mutex_unlock(&sfp->f_mutex);
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001796 return res;
Hannes Reinecke1bc0eb02017-04-07 09:34:14 +02001797 }
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001798 }
Hannes Reinecke1bc0eb02017-04-07 09:34:14 +02001799 mutex_unlock(&sfp->f_mutex);
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001800
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001801 md->pages = req_schp->pages;
1802 md->page_order = req_schp->page_order;
1803 md->nr_entries = req_schp->k_use_sg;
FUJITA Tomonori56c451f2008-12-18 14:49:37 +09001804 md->offset = 0;
FUJITA Tomonori97ae77a2008-12-18 14:49:38 +09001805 md->null_mapped = hp->dxferp ? 0 : 1;
FUJITA Tomonoriecb554a2009-07-09 14:46:53 +02001806 if (dxfer_dir == SG_DXFER_TO_FROM_DEV)
1807 md->from_user = 1;
1808 else
1809 md->from_user = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810 }
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001811
FUJITA Tomonori0fdf96b2009-04-03 09:12:20 +09001812 if (iov_count) {
Al Virofdc81f42015-03-21 20:25:30 -04001813 struct iovec *iov = NULL;
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001814 struct iov_iter i;
FUJITA Tomonori0fdf96b2009-04-03 09:12:20 +09001815
Al Virofdc81f42015-03-21 20:25:30 -04001816 res = import_iovec(rw, hp->dxferp, iov_count, 0, &iov, &i);
1817 if (res < 0)
1818 return res;
FUJITA Tomonori0fdf96b2009-04-03 09:12:20 +09001819
Al Virofdc81f42015-03-21 20:25:30 -04001820 iov_iter_truncate(&i, hp->dxfer_len);
Al Viro137d01d2017-02-19 07:15:27 +00001821 if (!iov_iter_count(&i)) {
1822 kfree(iov);
1823 return -EINVAL;
1824 }
FUJITA Tomonori0fdf96b2009-04-03 09:12:20 +09001825
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001826 res = blk_rq_map_user_iov(q, rq, md, &i, GFP_ATOMIC);
FUJITA Tomonori0fdf96b2009-04-03 09:12:20 +09001827 kfree(iov);
1828 } else
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001829 res = blk_rq_map_user(q, rq, md, hp->dxferp,
1830 hp->dxfer_len, GFP_ATOMIC);
1831
1832 if (!res) {
1833 srp->bio = rq->bio;
1834
1835 if (!md) {
1836 req_schp->dio_in_use = 1;
1837 hp->info |= SG_INFO_DIRECT_IO;
1838 }
1839 }
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001840 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001841}
1842
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001843static int
1844sg_finish_rem_req(Sg_request *srp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001845{
FUJITA Tomonorie7ee4cc2009-04-04 00:35:42 +09001846 int ret = 0;
1847
Linus Torvalds1da177e2005-04-16 15:20:36 -07001848 Sg_fd *sfp = srp->parentfp;
1849 Sg_scatter_hold *req_schp = &srp->data;
1850
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001851 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1852 "sg_finish_rem_req: res_used=%d\n",
1853 (int) srp->res_used));
Tony Battersby75686152015-02-13 12:09:44 -05001854 if (srp->bio)
1855 ret = blk_rq_unmap_user(srp->bio);
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001856
Tony Battersby75686152015-02-13 12:09:44 -05001857 if (srp->rq) {
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001858 scsi_req_free_cmd(scsi_req(srp->rq));
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001859 blk_put_request(srp->rq);
FUJITA Tomonori6e5a30c2008-08-28 16:17:08 +09001860 }
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001861
Christof Schmitte27168f2009-09-17 09:10:14 +02001862 if (srp->res_used)
1863 sg_unlink_reserve(sfp, srp);
1864 else
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001865 sg_remove_scat(sfp, req_schp);
Christof Schmitte27168f2009-09-17 09:10:14 +02001866
FUJITA Tomonorie7ee4cc2009-04-04 00:35:42 +09001867 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868}
1869
1870static int
1871sg_build_sgat(Sg_scatter_hold * schp, const Sg_fd * sfp, int tablesize)
1872{
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001873 int sg_bufflen = tablesize * sizeof(struct page *);
Al Viro2d20eaf2006-02-01 06:31:40 -05001874 gfp_t gfp_flags = GFP_ATOMIC | __GFP_NOWARN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001875
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001876 schp->pages = kzalloc(sg_bufflen, gfp_flags);
1877 if (!schp->pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001878 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001879 schp->sglist_len = sg_bufflen;
Mike Christied6b10342005-11-08 04:06:41 -06001880 return tablesize; /* number of scat_gath elements allocated */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001881}
1882
Linus Torvalds1da177e2005-04-16 15:20:36 -07001883static int
1884sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size)
1885{
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001886 int ret_sz = 0, i, k, rem_sz, num, mx_sc_elems;
Mike Christied6b10342005-11-08 04:06:41 -06001887 int sg_tablesize = sfp->parentdp->sg_tablesize;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001888 int blk_size = buff_size, order;
1889 gfp_t gfp_mask = GFP_ATOMIC | __GFP_COMP | __GFP_NOWARN;
Hannes Reinecke745dfa02017-04-07 09:34:12 +02001890 struct sg_device *sdp = sfp->parentdp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001891
Eric Sesterhennfb119932007-05-23 14:41:36 -07001892 if (blk_size < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001893 return -EFAULT;
1894 if (0 == blk_size)
1895 ++blk_size; /* don't know why */
FUJITA Tomonorib2ed6c62009-02-12 02:42:57 +09001896 /* round request up to next highest SG_SECTOR_SZ byte boundary */
1897 blk_size = ALIGN(blk_size, SG_SECTOR_SZ);
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001898 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1899 "sg_build_indirect: buff_size=%d, blk_size=%d\n",
1900 buff_size, blk_size));
Mike Christied6b10342005-11-08 04:06:41 -06001901
1902 /* N.B. ret_sz carried into this block ... */
1903 mx_sc_elems = sg_build_sgat(schp, sfp, sg_tablesize);
1904 if (mx_sc_elems < 0)
1905 return mx_sc_elems; /* most likely -ENOMEM */
1906
Douglas Gilbert6460e752006-09-20 18:20:49 -04001907 num = scatter_elem_sz;
1908 if (unlikely(num != scatter_elem_sz_prev)) {
1909 if (num < PAGE_SIZE) {
1910 scatter_elem_sz = PAGE_SIZE;
1911 scatter_elem_sz_prev = PAGE_SIZE;
1912 } else
1913 scatter_elem_sz_prev = num;
1914 }
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001915
Hannes Reinecke745dfa02017-04-07 09:34:12 +02001916 if (sdp->device->host->unchecked_isa_dma)
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001917 gfp_mask |= GFP_DMA;
1918
1919 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
1920 gfp_mask |= __GFP_ZERO;
1921
1922 order = get_order(num);
1923retry:
1924 ret_sz = 1 << (PAGE_SHIFT + order);
1925
1926 for (k = 0, rem_sz = blk_size; rem_sz > 0 && k < mx_sc_elems;
1927 k++, rem_sz -= ret_sz) {
1928
Douglas Gilbert6460e752006-09-20 18:20:49 -04001929 num = (rem_sz > scatter_elem_sz_prev) ?
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001930 scatter_elem_sz_prev : rem_sz;
1931
Alexander Potapenkod827bea2018-05-18 16:23:18 +02001932 schp->pages[k] = alloc_pages(gfp_mask | __GFP_ZERO, order);
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001933 if (!schp->pages[k])
1934 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935
Douglas Gilbert6460e752006-09-20 18:20:49 -04001936 if (num == scatter_elem_sz_prev) {
1937 if (unlikely(ret_sz > scatter_elem_sz_prev)) {
1938 scatter_elem_sz = ret_sz;
1939 scatter_elem_sz_prev = ret_sz;
1940 }
1941 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001942
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001943 SCSI_LOG_TIMEOUT(5, sg_printk(KERN_INFO, sfp->parentdp,
1944 "sg_build_indirect: k=%d, num=%d, ret_sz=%d\n",
1945 k, num, ret_sz));
Mike Christied6b10342005-11-08 04:06:41 -06001946 } /* end of for loop */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001948 schp->page_order = order;
Mike Christied6b10342005-11-08 04:06:41 -06001949 schp->k_use_sg = k;
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001950 SCSI_LOG_TIMEOUT(5, sg_printk(KERN_INFO, sfp->parentdp,
1951 "sg_build_indirect: k_use_sg=%d, rem_sz=%d\n",
1952 k, rem_sz));
Mike Christied6b10342005-11-08 04:06:41 -06001953
1954 schp->bufflen = blk_size;
1955 if (rem_sz > 0) /* must have failed */
1956 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001957 return 0;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001958out:
1959 for (i = 0; i < k; i++)
Michal Schmidte71044e2009-09-03 14:27:08 +02001960 __free_pages(schp->pages[i], order);
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001961
1962 if (--order >= 0)
1963 goto retry;
1964
1965 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001966}
1967
Linus Torvalds1da177e2005-04-16 15:20:36 -07001968static void
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001969sg_remove_scat(Sg_fd * sfp, Sg_scatter_hold * schp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001970{
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001971 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1972 "sg_remove_scat: k_use_sg=%d\n", schp->k_use_sg));
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001973 if (schp->pages && schp->sglist_len > 0) {
FUJITA Tomonori6e5a30c2008-08-28 16:17:08 +09001974 if (!schp->dio_in_use) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001975 int k;
1976
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001977 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001978 SCSI_LOG_TIMEOUT(5,
1979 sg_printk(KERN_INFO, sfp->parentdp,
1980 "sg_remove_scat: k=%d, pg=0x%p\n",
1981 k, schp->pages[k]));
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001982 __free_pages(schp->pages[k], schp->page_order);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001983 }
FUJITA Tomonori6e5a30c2008-08-28 16:17:08 +09001984
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001985 kfree(schp->pages);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001986 }
Mike Christied6b10342005-11-08 04:06:41 -06001987 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001988 memset(schp, 0, sizeof (*schp));
1989}
1990
1991static int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001992sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer)
1993{
1994 Sg_scatter_hold *schp = &srp->data;
Mike Christied6b10342005-11-08 04:06:41 -06001995 int k, num;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001996
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001997 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, srp->parentfp->parentdp,
1998 "sg_read_oxfer: num_read_xfer=%d\n",
1999 num_read_xfer));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002000 if ((!outp) || (num_read_xfer <= 0))
2001 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002002
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02002003 num = 1 << (PAGE_SHIFT + schp->page_order);
2004 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
Mike Christied6b10342005-11-08 04:06:41 -06002005 if (num > num_read_xfer) {
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02002006 if (__copy_to_user(outp, page_address(schp->pages[k]),
Mike Christied6b10342005-11-08 04:06:41 -06002007 num_read_xfer))
2008 return -EFAULT;
2009 break;
2010 } else {
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02002011 if (__copy_to_user(outp, page_address(schp->pages[k]),
Mike Christied6b10342005-11-08 04:06:41 -06002012 num))
2013 return -EFAULT;
2014 num_read_xfer -= num;
2015 if (num_read_xfer <= 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002016 break;
Mike Christied6b10342005-11-08 04:06:41 -06002017 outp += num;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002019 }
Mike Christied6b10342005-11-08 04:06:41 -06002020
Linus Torvalds1da177e2005-04-16 15:20:36 -07002021 return 0;
2022}
2023
2024static void
2025sg_build_reserve(Sg_fd * sfp, int req_size)
2026{
2027 Sg_scatter_hold *schp = &sfp->reserve;
2028
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002029 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
2030 "sg_build_reserve: req_size=%d\n", req_size));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002031 do {
2032 if (req_size < PAGE_SIZE)
2033 req_size = PAGE_SIZE;
2034 if (0 == sg_build_indirect(schp, sfp, req_size))
2035 return;
2036 else
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002037 sg_remove_scat(sfp, schp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002038 req_size >>= 1; /* divide by 2 */
2039 } while (req_size > (PAGE_SIZE / 2));
2040}
2041
2042static void
2043sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size)
2044{
2045 Sg_scatter_hold *req_schp = &srp->data;
2046 Sg_scatter_hold *rsv_schp = &sfp->reserve;
Mike Christied6b10342005-11-08 04:06:41 -06002047 int k, num, rem;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002048
2049 srp->res_used = 1;
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002050 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
2051 "sg_link_reserve: size=%d\n", size));
Brian Kingeca7be52006-02-14 12:42:24 -06002052 rem = size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002053
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02002054 num = 1 << (PAGE_SHIFT + rsv_schp->page_order);
2055 for (k = 0; k < rsv_schp->k_use_sg; k++) {
Mike Christied6b10342005-11-08 04:06:41 -06002056 if (rem <= num) {
Mike Christied6b10342005-11-08 04:06:41 -06002057 req_schp->k_use_sg = k + 1;
2058 req_schp->sglist_len = rsv_schp->sglist_len;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02002059 req_schp->pages = rsv_schp->pages;
Mike Christied6b10342005-11-08 04:06:41 -06002060
2061 req_schp->bufflen = size;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02002062 req_schp->page_order = rsv_schp->page_order;
Mike Christied6b10342005-11-08 04:06:41 -06002063 break;
2064 } else
2065 rem -= num;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002066 }
Mike Christied6b10342005-11-08 04:06:41 -06002067
2068 if (k >= rsv_schp->k_use_sg)
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002069 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO, sfp->parentdp,
2070 "sg_link_reserve: BAD size\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071}
2072
2073static void
2074sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp)
2075{
2076 Sg_scatter_hold *req_schp = &srp->data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002077
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002078 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, srp->parentfp->parentdp,
2079 "sg_unlink_reserve: req->k_use_sg=%d\n",
2080 (int) req_schp->k_use_sg));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002081 req_schp->k_use_sg = 0;
2082 req_schp->bufflen = 0;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02002083 req_schp->pages = NULL;
2084 req_schp->page_order = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085 req_schp->sglist_len = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086 srp->res_used = 0;
Hannes Reineckee791ce22017-04-24 10:26:36 +02002087 /* Called without mutex lock to avoid deadlock */
2088 sfp->res_in_use = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002089}
2090
2091static Sg_request *
Tony Battersbyf5e61d92022-07-11 10:51:32 -04002092sg_get_rq_mark(Sg_fd * sfp, int pack_id, bool *busy)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002093{
2094 Sg_request *resp;
2095 unsigned long iflags;
2096
Tony Battersbyf5e61d92022-07-11 10:51:32 -04002097 *busy = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002098 write_lock_irqsave(&sfp->rq_list_lock, iflags);
Hannes Reinecke109bade2017-04-07 09:34:16 +02002099 list_for_each_entry(resp, &sfp->rq_list, entry) {
Tony Battersbyf5e61d92022-07-11 10:51:32 -04002100 /* look for requests that are not SG_IO owned */
2101 if ((!resp->sg_io_owned) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -07002102 ((-1 == pack_id) || (resp->header.pack_id == pack_id))) {
Tony Battersbyf5e61d92022-07-11 10:51:32 -04002103 switch (resp->done) {
2104 case 0: /* request active */
2105 *busy = true;
2106 break;
2107 case 1: /* request done; response ready to return */
2108 resp->done = 2; /* guard against other readers */
2109 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2110 return resp;
2111 case 2: /* response already being returned */
2112 break;
2113 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002114 }
2115 }
2116 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
Johannes Thumshirn48ae8482017-05-10 09:53:40 +02002117 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002118}
2119
Linus Torvalds1da177e2005-04-16 15:20:36 -07002120/* always adds to end of list */
2121static Sg_request *
2122sg_add_request(Sg_fd * sfp)
2123{
2124 int k;
2125 unsigned long iflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002126 Sg_request *rp = sfp->req_arr;
2127
2128 write_lock_irqsave(&sfp->rq_list_lock, iflags);
Hannes Reinecke109bade2017-04-07 09:34:16 +02002129 if (!list_empty(&sfp->rq_list)) {
2130 if (!sfp->cmd_q)
2131 goto out_unlock;
2132
2133 for (k = 0; k < SG_MAX_QUEUE; ++k, ++rp) {
2134 if (!rp->parentfp)
2135 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002136 }
Hannes Reinecke109bade2017-04-07 09:34:16 +02002137 if (k >= SG_MAX_QUEUE)
2138 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002139 }
Hannes Reinecke109bade2017-04-07 09:34:16 +02002140 memset(rp, 0, sizeof (Sg_request));
2141 rp->parentfp = sfp;
2142 rp->header.duration = jiffies_to_msecs(jiffies);
2143 list_add_tail(&rp->entry, &sfp->rq_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002144 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
Hannes Reinecke109bade2017-04-07 09:34:16 +02002145 return rp;
2146out_unlock:
2147 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2148 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002149}
2150
2151/* Return of 1 for found; 0 for not found */
2152static int
2153sg_remove_request(Sg_fd * sfp, Sg_request * srp)
2154{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002155 unsigned long iflags;
2156 int res = 0;
2157
Hannes Reinecke109bade2017-04-07 09:34:16 +02002158 if (!sfp || !srp || list_empty(&sfp->rq_list))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002159 return res;
2160 write_lock_irqsave(&sfp->rq_list_lock, iflags);
Hannes Reinecke109bade2017-04-07 09:34:16 +02002161 if (!list_empty(&srp->entry)) {
2162 list_del(&srp->entry);
2163 srp->parentfp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002164 res = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002165 }
2166 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
Tony Battersbyf5e61d92022-07-11 10:51:32 -04002167
2168 /*
2169 * If the device is detaching, wakeup any readers in case we just
2170 * removed the last response, which would leave nothing for them to
2171 * return other than -ENODEV.
2172 */
2173 if (unlikely(atomic_read(&sfp->parentdp->detaching)))
2174 wake_up_interruptible_all(&sfp->read_wait);
2175
Linus Torvalds1da177e2005-04-16 15:20:36 -07002176 return res;
2177}
2178
Linus Torvalds1da177e2005-04-16 15:20:36 -07002179static Sg_fd *
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002180sg_add_sfp(Sg_device * sdp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002181{
2182 Sg_fd *sfp;
2183 unsigned long iflags;
Alan Stern44ec9542007-02-20 11:01:57 -05002184 int bufflen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002185
Mike Christied6b10342005-11-08 04:06:41 -06002186 sfp = kzalloc(sizeof(*sfp), GFP_ATOMIC | __GFP_NOWARN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002187 if (!sfp)
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002188 return ERR_PTR(-ENOMEM);
Mike Christied6b10342005-11-08 04:06:41 -06002189
Linus Torvalds1da177e2005-04-16 15:20:36 -07002190 init_waitqueue_head(&sfp->read_wait);
2191 rwlock_init(&sfp->rq_list_lock);
Hannes Reinecke109bade2017-04-07 09:34:16 +02002192 INIT_LIST_HEAD(&sfp->rq_list);
Tony Battersbyc6517b792009-01-21 14:45:50 -05002193 kref_init(&sfp->f_ref);
Hannes Reinecke1bc0eb02017-04-07 09:34:14 +02002194 mutex_init(&sfp->f_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002195 sfp->timeout = SG_DEFAULT_TIMEOUT;
2196 sfp->timeout_user = SG_DEFAULT_TIMEOUT_USER;
2197 sfp->force_packid = SG_DEF_FORCE_PACK_ID;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002198 sfp->cmd_q = SG_DEF_COMMAND_Q;
2199 sfp->keep_orphan = SG_DEF_KEEP_ORPHAN;
2200 sfp->parentdp = sdp;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002201 write_lock_irqsave(&sdp->sfd_lock, iflags);
2202 if (atomic_read(&sdp->detaching)) {
2203 write_unlock_irqrestore(&sdp->sfd_lock, iflags);
Tony Battersbyb4653a32018-07-12 16:30:45 -04002204 kfree(sfp);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002205 return ERR_PTR(-ENODEV);
2206 }
FUJITA Tomonori3442f802009-02-16 13:26:53 +09002207 list_add_tail(&sfp->sfd_siblings, &sdp->sfds);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002208 write_unlock_irqrestore(&sdp->sfd_lock, iflags);
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002209 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
2210 "sg_add_sfp: sfp=0x%p\n", sfp));
Douglas Gilbert6460e752006-09-20 18:20:49 -04002211 if (unlikely(sg_big_buff != def_reserved_size))
2212 sg_big_buff = def_reserved_size;
2213
Alan Stern44ec9542007-02-20 11:01:57 -05002214 bufflen = min_t(int, sg_big_buff,
Akinobu Mita46f69e62014-06-02 22:56:46 +09002215 max_sectors_bytes(sdp->device->request_queue));
Alan Stern44ec9542007-02-20 11:01:57 -05002216 sg_build_reserve(sfp, bufflen);
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002217 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
2218 "sg_add_sfp: bufflen=%d, k_use_sg=%d\n",
2219 sfp->reserve.bufflen,
2220 sfp->reserve.k_use_sg));
Tony Battersbyc6517b792009-01-21 14:45:50 -05002221
2222 kref_get(&sdp->d_ref);
2223 __module_get(THIS_MODULE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002224 return sfp;
2225}
2226
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002227static void
2228sg_remove_sfp_usercontext(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002229{
Tony Battersbyc6517b792009-01-21 14:45:50 -05002230 struct sg_fd *sfp = container_of(work, struct sg_fd, ew.work);
2231 struct sg_device *sdp = sfp->parentdp;
Hannes Reinecke109bade2017-04-07 09:34:16 +02002232 Sg_request *srp;
Hannes Reinecke97d27b02017-04-07 09:34:17 +02002233 unsigned long iflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002234
Tony Battersbyc6517b792009-01-21 14:45:50 -05002235 /* Cleanup any responses which were never read(). */
Hannes Reinecke97d27b02017-04-07 09:34:17 +02002236 write_lock_irqsave(&sfp->rq_list_lock, iflags);
Hannes Reinecke109bade2017-04-07 09:34:16 +02002237 while (!list_empty(&sfp->rq_list)) {
2238 srp = list_first_entry(&sfp->rq_list, Sg_request, entry);
2239 sg_finish_rem_req(srp);
Hannes Reinecke97d27b02017-04-07 09:34:17 +02002240 list_del(&srp->entry);
2241 srp->parentfp = NULL;
Hannes Reinecke109bade2017-04-07 09:34:16 +02002242 }
Hannes Reinecke97d27b02017-04-07 09:34:17 +02002243 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
Tony Battersbyc6517b792009-01-21 14:45:50 -05002244
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245 if (sfp->reserve.bufflen > 0) {
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002246 SCSI_LOG_TIMEOUT(6, sg_printk(KERN_INFO, sdp,
2247 "sg_remove_sfp: bufflen=%d, k_use_sg=%d\n",
Tony Battersbyc6517b792009-01-21 14:45:50 -05002248 (int) sfp->reserve.bufflen,
2249 (int) sfp->reserve.k_use_sg));
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002250 sg_remove_scat(sfp, &sfp->reserve);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002251 }
Tony Battersbyc6517b792009-01-21 14:45:50 -05002252
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002253 SCSI_LOG_TIMEOUT(6, sg_printk(KERN_INFO, sdp,
2254 "sg_remove_sfp: sfp=0x%p\n", sfp));
Mike Christied6b10342005-11-08 04:06:41 -06002255 kfree(sfp);
Tony Battersbyc6517b792009-01-21 14:45:50 -05002256
2257 scsi_device_put(sdp->device);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002258 kref_put(&sdp->d_ref, sg_device_destroy);
Tony Battersbyc6517b792009-01-21 14:45:50 -05002259 module_put(THIS_MODULE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002260}
2261
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002262static void
2263sg_remove_sfp(struct kref *kref)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002264{
Tony Battersbyc6517b792009-01-21 14:45:50 -05002265 struct sg_fd *sfp = container_of(kref, struct sg_fd, f_ref);
James Bottomley065b4a22013-10-25 10:27:02 +01002266 struct sg_device *sdp = sfp->parentdp;
Tony Battersbyc6517b792009-01-21 14:45:50 -05002267 unsigned long iflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002268
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002269 write_lock_irqsave(&sdp->sfd_lock, iflags);
FUJITA Tomonori3442f802009-02-16 13:26:53 +09002270 list_del(&sfp->sfd_siblings);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002271 write_unlock_irqrestore(&sdp->sfd_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002272
FUJITA Tomonori015640e2009-04-03 19:28:06 +09002273 INIT_WORK(&sfp->ew.work, sg_remove_sfp_usercontext);
2274 schedule_work(&sfp->ew.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002275}
2276
Linus Torvalds1da177e2005-04-16 15:20:36 -07002277#ifdef CONFIG_SCSI_PROC_FS
2278static int
James Bottomley7c07d612007-08-05 13:36:11 -05002279sg_idr_max_id(int id, void *p, void *data)
2280{
2281 int *k = data;
2282
2283 if (*k < id)
2284 *k = id;
2285
2286 return 0;
2287}
2288
2289static int
Linus Torvalds1da177e2005-04-16 15:20:36 -07002290sg_last_dev(void)
2291{
Tony Battersby53474c02008-01-22 15:25:49 -05002292 int k = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002293 unsigned long iflags;
2294
James Bottomley7c07d612007-08-05 13:36:11 -05002295 read_lock_irqsave(&sg_index_lock, iflags);
2296 idr_for_each(&sg_index_idr, sg_idr_max_id, &k);
2297 read_unlock_irqrestore(&sg_index_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002298 return k + 1; /* origin 1 */
2299}
2300#endif
2301
Tony Battersbyc6517b792009-01-21 14:45:50 -05002302/* must be called with sg_index_lock held */
2303static Sg_device *sg_lookup_dev(int dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002304{
Tony Battersbyc6517b792009-01-21 14:45:50 -05002305 return idr_find(&sg_index_idr, dev);
2306}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002307
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002308static Sg_device *
2309sg_get_dev(int dev)
Tony Battersbyc6517b792009-01-21 14:45:50 -05002310{
2311 struct sg_device *sdp;
2312 unsigned long flags;
2313
2314 read_lock_irqsave(&sg_index_lock, flags);
2315 sdp = sg_lookup_dev(dev);
2316 if (!sdp)
2317 sdp = ERR_PTR(-ENXIO);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002318 else if (atomic_read(&sdp->detaching)) {
2319 /* If sdp->detaching, then the refcount may already be 0, in
Tony Battersbyc6517b792009-01-21 14:45:50 -05002320 * which case it would be a bug to do kref_get().
2321 */
2322 sdp = ERR_PTR(-ENODEV);
2323 } else
2324 kref_get(&sdp->d_ref);
2325 read_unlock_irqrestore(&sg_index_lock, flags);
James Bottomley7c07d612007-08-05 13:36:11 -05002326
Linus Torvalds1da177e2005-04-16 15:20:36 -07002327 return sdp;
2328}
2329
2330#ifdef CONFIG_SCSI_PROC_FS
2331
2332static struct proc_dir_entry *sg_proc_sgp = NULL;
2333
2334static char sg_proc_sg_dirname[] = "scsi/sg";
2335
2336static int sg_proc_seq_show_int(struct seq_file *s, void *v);
2337
2338static int sg_proc_single_open_adio(struct inode *inode, struct file *file);
2339static ssize_t sg_proc_write_adio(struct file *filp, const char __user *buffer,
2340 size_t count, loff_t *off);
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002341static const struct file_operations adio_fops = {
2342 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002343 .open = sg_proc_single_open_adio,
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_adio,
2347 .release = single_release,
2348};
2349
2350static int sg_proc_single_open_dressz(struct inode *inode, struct file *file);
2351static ssize_t sg_proc_write_dressz(struct file *filp,
2352 const char __user *buffer, size_t count, loff_t *off);
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002353static const struct file_operations dressz_fops = {
2354 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002355 .open = sg_proc_single_open_dressz,
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002356 .read = seq_read,
2357 .llseek = seq_lseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002358 .write = sg_proc_write_dressz,
2359 .release = single_release,
2360};
2361
2362static int sg_proc_seq_show_version(struct seq_file *s, void *v);
2363static int sg_proc_single_open_version(struct inode *inode, struct file *file);
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002364static const struct file_operations version_fops = {
2365 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002366 .open = sg_proc_single_open_version,
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002367 .read = seq_read,
2368 .llseek = seq_lseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002369 .release = single_release,
2370};
2371
2372static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v);
2373static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file);
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002374static const struct file_operations devhdr_fops = {
2375 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002376 .open = sg_proc_single_open_devhdr,
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002377 .read = seq_read,
2378 .llseek = seq_lseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002379 .release = single_release,
2380};
2381
2382static int sg_proc_seq_show_dev(struct seq_file *s, void *v);
2383static int sg_proc_open_dev(struct inode *inode, struct file *file);
2384static void * dev_seq_start(struct seq_file *s, loff_t *pos);
2385static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos);
2386static void dev_seq_stop(struct seq_file *s, void *v);
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002387static const struct file_operations dev_fops = {
2388 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002389 .open = sg_proc_open_dev,
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002390 .read = seq_read,
2391 .llseek = seq_lseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002392 .release = seq_release,
2393};
James Morris88e9d342009-09-22 16:43:43 -07002394static const struct seq_operations dev_seq_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002395 .start = dev_seq_start,
2396 .next = dev_seq_next,
2397 .stop = dev_seq_stop,
2398 .show = sg_proc_seq_show_dev,
2399};
2400
2401static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v);
2402static int sg_proc_open_devstrs(struct inode *inode, struct file *file);
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002403static const struct file_operations devstrs_fops = {
2404 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002405 .open = sg_proc_open_devstrs,
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002406 .read = seq_read,
2407 .llseek = seq_lseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002408 .release = seq_release,
2409};
James Morris88e9d342009-09-22 16:43:43 -07002410static const struct seq_operations devstrs_seq_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002411 .start = dev_seq_start,
2412 .next = dev_seq_next,
2413 .stop = dev_seq_stop,
2414 .show = sg_proc_seq_show_devstrs,
2415};
2416
2417static int sg_proc_seq_show_debug(struct seq_file *s, void *v);
2418static int sg_proc_open_debug(struct inode *inode, struct file *file);
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002419static const struct file_operations debug_fops = {
2420 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002421 .open = sg_proc_open_debug,
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002422 .read = seq_read,
2423 .llseek = seq_lseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002424 .release = seq_release,
2425};
James Morris88e9d342009-09-22 16:43:43 -07002426static const struct seq_operations debug_seq_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002427 .start = dev_seq_start,
2428 .next = dev_seq_next,
2429 .stop = dev_seq_stop,
2430 .show = sg_proc_seq_show_debug,
2431};
2432
2433
2434struct sg_proc_leaf {
2435 const char * name;
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002436 const struct file_operations * fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002437};
2438
Jörn Engel18b8ba62012-04-12 17:35:25 -04002439static const struct sg_proc_leaf sg_proc_leaf_arr[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002440 {"allow_dio", &adio_fops},
2441 {"debug", &debug_fops},
2442 {"def_reserved_size", &dressz_fops},
2443 {"device_hdr", &devhdr_fops},
2444 {"devices", &dev_fops},
2445 {"device_strs", &devstrs_fops},
2446 {"version", &version_fops}
2447};
2448
2449static int
2450sg_proc_init(void)
2451{
Tobias Klauser6391a112006-06-08 22:23:48 -07002452 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
Al Virod161a132011-07-24 03:36:29 -04002453 int k;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002454
Al Viro66600222005-09-28 22:32:57 +01002455 sg_proc_sgp = proc_mkdir(sg_proc_sg_dirname, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002456 if (!sg_proc_sgp)
2457 return 1;
2458 for (k = 0; k < num_leaves; ++k) {
Jörn Engel18b8ba62012-04-12 17:35:25 -04002459 const struct sg_proc_leaf *leaf = &sg_proc_leaf_arr[k];
Al Virod161a132011-07-24 03:36:29 -04002460 umode_t mask = leaf->fops->write ? S_IRUGO | S_IWUSR : S_IRUGO;
Denis V. Luneva9739092008-04-29 01:02:17 -07002461 proc_create(leaf->name, mask, sg_proc_sgp, leaf->fops);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002462 }
2463 return 0;
2464}
2465
2466static void
2467sg_proc_cleanup(void)
2468{
2469 int k;
Tobias Klauser6391a112006-06-08 22:23:48 -07002470 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002471
2472 if (!sg_proc_sgp)
2473 return;
2474 for (k = 0; k < num_leaves; ++k)
2475 remove_proc_entry(sg_proc_leaf_arr[k].name, sg_proc_sgp);
2476 remove_proc_entry(sg_proc_sg_dirname, NULL);
2477}
2478
2479
2480static int sg_proc_seq_show_int(struct seq_file *s, void *v)
2481{
2482 seq_printf(s, "%d\n", *((int *)s->private));
2483 return 0;
2484}
2485
2486static int sg_proc_single_open_adio(struct inode *inode, struct file *file)
2487{
2488 return single_open(file, sg_proc_seq_show_int, &sg_allow_dio);
2489}
2490
2491static ssize_t
2492sg_proc_write_adio(struct file *filp, const char __user *buffer,
2493 size_t count, loff_t *off)
2494{
Stephen Boyd7e95fff2012-01-10 15:42:34 -08002495 int err;
2496 unsigned long num;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002497
2498 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2499 return -EACCES;
Stephen Boyd7e95fff2012-01-10 15:42:34 -08002500 err = kstrtoul_from_user(buffer, count, 0, &num);
2501 if (err)
2502 return err;
2503 sg_allow_dio = num ? 1 : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002504 return count;
2505}
2506
2507static int sg_proc_single_open_dressz(struct inode *inode, struct file *file)
2508{
2509 return single_open(file, sg_proc_seq_show_int, &sg_big_buff);
2510}
2511
2512static ssize_t
2513sg_proc_write_dressz(struct file *filp, const char __user *buffer,
2514 size_t count, loff_t *off)
2515{
Stephen Boyd7e95fff2012-01-10 15:42:34 -08002516 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002517 unsigned long k = ULONG_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002518
2519 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2520 return -EACCES;
Stephen Boyd7e95fff2012-01-10 15:42:34 -08002521
2522 err = kstrtoul_from_user(buffer, count, 0, &k);
2523 if (err)
2524 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002525 if (k <= 1048576) { /* limit "big buff" to 1 MB */
2526 sg_big_buff = k;
2527 return count;
2528 }
2529 return -ERANGE;
2530}
2531
2532static int sg_proc_seq_show_version(struct seq_file *s, void *v)
2533{
2534 seq_printf(s, "%d\t%s [%s]\n", sg_version_num, SG_VERSION_STR,
2535 sg_version_date);
2536 return 0;
2537}
2538
2539static int sg_proc_single_open_version(struct inode *inode, struct file *file)
2540{
2541 return single_open(file, sg_proc_seq_show_version, NULL);
2542}
2543
2544static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v)
2545{
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002546 seq_puts(s, "host\tchan\tid\tlun\ttype\topens\tqdepth\tbusy\tonline\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002547 return 0;
2548}
2549
2550static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file)
2551{
2552 return single_open(file, sg_proc_seq_show_devhdr, NULL);
2553}
2554
2555struct sg_proc_deviter {
2556 loff_t index;
2557 size_t max;
2558};
2559
2560static void * dev_seq_start(struct seq_file *s, loff_t *pos)
2561{
2562 struct sg_proc_deviter * it = kmalloc(sizeof(*it), GFP_KERNEL);
2563
Jan Blunck729d70f2005-08-27 11:07:52 -07002564 s->private = it;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002565 if (! it)
2566 return NULL;
Jan Blunck729d70f2005-08-27 11:07:52 -07002567
Linus Torvalds1da177e2005-04-16 15:20:36 -07002568 it->index = *pos;
2569 it->max = sg_last_dev();
2570 if (it->index >= it->max)
Jan Blunck729d70f2005-08-27 11:07:52 -07002571 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002572 return it;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002573}
2574
2575static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos)
2576{
Jan Blunck729d70f2005-08-27 11:07:52 -07002577 struct sg_proc_deviter * it = s->private;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002578
2579 *pos = ++it->index;
2580 return (it->index < it->max) ? it : NULL;
2581}
2582
2583static void dev_seq_stop(struct seq_file *s, void *v)
2584{
Jan Blunck729d70f2005-08-27 11:07:52 -07002585 kfree(s->private);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002586}
2587
2588static int sg_proc_open_dev(struct inode *inode, struct file *file)
2589{
2590 return seq_open(file, &dev_seq_ops);
2591}
2592
2593static int sg_proc_seq_show_dev(struct seq_file *s, void *v)
2594{
2595 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2596 Sg_device *sdp;
2597 struct scsi_device *scsidp;
Tony Battersbyc6517b792009-01-21 14:45:50 -05002598 unsigned long iflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002599
Tony Battersbyc6517b792009-01-21 14:45:50 -05002600 read_lock_irqsave(&sg_index_lock, iflags);
2601 sdp = it ? sg_lookup_dev(it->index) : NULL;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002602 if ((NULL == sdp) || (NULL == sdp->device) ||
2603 (atomic_read(&sdp->detaching)))
2604 seq_puts(s, "-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\n");
2605 else {
2606 scsidp = sdp->device;
Hannes Reinecke9cb78c12014-06-25 15:27:36 +02002607 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 -07002608 scsidp->host->host_no, scsidp->channel,
2609 scsidp->id, scsidp->lun, (int) scsidp->type,
2610 1,
2611 (int) scsidp->queue_depth,
Christoph Hellwig71e75c92014-04-11 19:07:01 +02002612 (int) atomic_read(&scsidp->device_busy),
Linus Torvalds1da177e2005-04-16 15:20:36 -07002613 (int) scsi_device_online(scsidp));
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002614 }
Tony Battersbyc6517b792009-01-21 14:45:50 -05002615 read_unlock_irqrestore(&sg_index_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002616 return 0;
2617}
2618
2619static int sg_proc_open_devstrs(struct inode *inode, struct file *file)
2620{
2621 return seq_open(file, &devstrs_seq_ops);
2622}
2623
2624static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v)
2625{
2626 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2627 Sg_device *sdp;
2628 struct scsi_device *scsidp;
Tony Battersbyc6517b792009-01-21 14:45:50 -05002629 unsigned long iflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002630
Tony Battersbyc6517b792009-01-21 14:45:50 -05002631 read_lock_irqsave(&sg_index_lock, iflags);
2632 sdp = it ? sg_lookup_dev(it->index) : NULL;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002633 scsidp = sdp ? sdp->device : NULL;
2634 if (sdp && scsidp && (!atomic_read(&sdp->detaching)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002635 seq_printf(s, "%8.8s\t%16.16s\t%4.4s\n",
2636 scsidp->vendor, scsidp->model, scsidp->rev);
2637 else
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002638 seq_puts(s, "<no active device>\n");
Tony Battersbyc6517b792009-01-21 14:45:50 -05002639 read_unlock_irqrestore(&sg_index_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002640 return 0;
2641}
2642
James Bottomleyc0d3b9c22013-10-25 10:21:57 +01002643/* must be called while holding sg_index_lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002644static void sg_proc_debug_helper(struct seq_file *s, Sg_device * sdp)
2645{
Hannes Reinecke109bade2017-04-07 09:34:16 +02002646 int k, new_interface, blen, usg;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002647 Sg_request *srp;
2648 Sg_fd *fp;
2649 const sg_io_hdr_t *hp;
2650 const char * cp;
cb59e842005-04-02 13:51:23 -06002651 unsigned int ms;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002652
FUJITA Tomonori3442f802009-02-16 13:26:53 +09002653 k = 0;
2654 list_for_each_entry(fp, &sdp->sfds, sfd_siblings) {
2655 k++;
Tony Battersbyc6517b792009-01-21 14:45:50 -05002656 read_lock(&fp->rq_list_lock); /* irqs already disabled */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002657 seq_printf(s, " FD(%d): timeout=%dms bufflen=%d "
FUJITA Tomonori3442f802009-02-16 13:26:53 +09002658 "(res)sgat=%d low_dma=%d\n", k,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002659 jiffies_to_msecs(fp->timeout),
2660 fp->reserve.bufflen,
2661 (int) fp->reserve.k_use_sg,
Hannes Reinecke745dfa02017-04-07 09:34:12 +02002662 (int) sdp->device->host->unchecked_isa_dma);
Jörn Engelebaf4662012-04-12 17:33:39 -04002663 seq_printf(s, " cmd_q=%d f_packid=%d k_orphan=%d closed=0\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002664 (int) fp->cmd_q, (int) fp->force_packid,
Jörn Engelebaf4662012-04-12 17:33:39 -04002665 (int) fp->keep_orphan);
Hannes Reinecke109bade2017-04-07 09:34:16 +02002666 list_for_each_entry(srp, &fp->rq_list, entry) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002667 hp = &srp->header;
2668 new_interface = (hp->interface_id == '\0') ? 0 : 1;
2669 if (srp->res_used) {
Hannes Reinecke109bade2017-04-07 09:34:16 +02002670 if (new_interface &&
Linus Torvalds1da177e2005-04-16 15:20:36 -07002671 (SG_FLAG_MMAP_IO & hp->flags))
2672 cp = " mmap>> ";
2673 else
2674 cp = " rb>> ";
2675 } else {
2676 if (SG_INFO_DIRECT_IO_MASK & hp->info)
2677 cp = " dio>> ";
2678 else
2679 cp = " ";
2680 }
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002681 seq_puts(s, cp);
Mike Christied6b10342005-11-08 04:06:41 -06002682 blen = srp->data.bufflen;
2683 usg = srp->data.k_use_sg;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002684 seq_puts(s, srp->done ?
2685 ((1 == srp->done) ? "rcv:" : "fin:")
2686 : "act:");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002687 seq_printf(s, " id=%d blen=%d",
2688 srp->header.pack_id, blen);
2689 if (srp->done)
2690 seq_printf(s, " dur=%d", hp->duration);
cb59e842005-04-02 13:51:23 -06002691 else {
2692 ms = jiffies_to_msecs(jiffies);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002693 seq_printf(s, " t_o/elap=%d/%d",
cb59e842005-04-02 13:51:23 -06002694 (new_interface ? hp->timeout :
2695 jiffies_to_msecs(fp->timeout)),
2696 (ms > hp->duration ? ms - hp->duration : 0));
2697 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002698 seq_printf(s, "ms sgat=%d op=0x%02x\n", usg,
2699 (int) srp->data.cmd_opcode);
2700 }
Hannes Reinecke109bade2017-04-07 09:34:16 +02002701 if (list_empty(&fp->rq_list))
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002702 seq_puts(s, " No requests active\n");
Tony Battersbyc6517b792009-01-21 14:45:50 -05002703 read_unlock(&fp->rq_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002704 }
2705}
2706
2707static int sg_proc_open_debug(struct inode *inode, struct file *file)
2708{
2709 return seq_open(file, &debug_seq_ops);
2710}
2711
2712static int sg_proc_seq_show_debug(struct seq_file *s, void *v)
2713{
2714 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2715 Sg_device *sdp;
Tony Battersbyc6517b792009-01-21 14:45:50 -05002716 unsigned long iflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002717
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002718 if (it && (0 == it->index))
2719 seq_printf(s, "max_active_device=%d def_reserved_size=%d\n",
2720 (int)it->max, sg_big_buff);
Tony Battersbyc6517b792009-01-21 14:45:50 -05002721
2722 read_lock_irqsave(&sg_index_lock, iflags);
2723 sdp = it ? sg_lookup_dev(it->index) : NULL;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002724 if (NULL == sdp)
2725 goto skip;
2726 read_lock(&sdp->sfd_lock);
2727 if (!list_empty(&sdp->sfds)) {
James Bottomleyc0d3b9c22013-10-25 10:21:57 +01002728 seq_printf(s, " >>> device=%s ", sdp->disk->disk_name);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002729 if (atomic_read(&sdp->detaching))
2730 seq_puts(s, "detaching pending close ");
2731 else if (sdp->device) {
2732 struct scsi_device *scsidp = sdp->device;
2733
Hannes Reinecke9cb78c12014-06-25 15:27:36 +02002734 seq_printf(s, "%d:%d:%d:%llu em=%d",
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002735 scsidp->host->host_no,
2736 scsidp->channel, scsidp->id,
2737 scsidp->lun,
2738 scsidp->host->hostt->emulated);
2739 }
2740 seq_printf(s, " sg_tablesize=%d excl=%d open_cnt=%d\n",
2741 sdp->sg_tablesize, sdp->exclude, sdp->open_cnt);
James Bottomleyc0d3b9c22013-10-25 10:21:57 +01002742 sg_proc_debug_helper(s, sdp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002743 }
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002744 read_unlock(&sdp->sfd_lock);
2745skip:
Tony Battersbyc6517b792009-01-21 14:45:50 -05002746 read_unlock_irqrestore(&sg_index_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002747 return 0;
2748}
2749
2750#endif /* CONFIG_SCSI_PROC_FS */
2751
2752module_init(init_sg);
2753module_exit(exit_sg);