blob: 9d7b7db75e4b96b6fbb33bf24b91c205add07d79 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * History:
3 * Started: Aug 9 by Lawrence Foard (entropy@world.std.com),
4 * to allow user process control of SCSI devices.
5 * Development Sponsored by Killy Corp. NY NY
6 *
7 * Original driver (sg.c):
8 * Copyright (C) 1992 Lawrence Foard
9 * Version 2 and 3 extensions to driver:
Douglas Gilbert65c26a02014-06-03 13:18:18 -040010 * Copyright (C) 1998 - 2014 Douglas Gilbert
Linus Torvalds1da177e2005-04-16 15:20:36 -070011 *
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2, or (at your option)
15 * any later version.
16 *
17 */
18
Douglas Gilbert65c26a02014-06-03 13:18:18 -040019static int sg_version_num = 30536; /* 2 digits for each component */
20#define SG_VERSION_STR "3.5.36"
Linus Torvalds1da177e2005-04-16 15:20:36 -070021
22/*
Douglas Gilbert65c26a02014-06-03 13:18:18 -040023 * D. P. Gilbert (dgilbert@interlog.com), notes:
Linus Torvalds1da177e2005-04-16 15:20:36 -070024 * - scsi logging is available via SCSI_LOG_TIMEOUT macros. First
25 * the kernel/module needs to be built with CONFIG_SCSI_LOGGING
26 * (otherwise the macros compile to empty statements).
27 *
28 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/module.h>
30
31#include <linux/fs.h>
32#include <linux/kernel.h>
33#include <linux/sched.h>
34#include <linux/string.h>
35#include <linux/mm.h>
36#include <linux/errno.h>
37#include <linux/mtio.h>
38#include <linux/ioctl.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090039#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070040#include <linux/fcntl.h>
41#include <linux/init.h>
42#include <linux/poll.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070043#include <linux/moduleparam.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#include <linux/cdev.h>
James Bottomley7c07d612007-08-05 13:36:11 -050045#include <linux/idr.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070046#include <linux/seq_file.h>
47#include <linux/blkdev.h>
48#include <linux/delay.h>
Christof Schmitt6da127a2008-01-11 10:09:43 +010049#include <linux/blktrace_api.h>
Arnd Bergmannc45d15d2010-06-02 14:28:52 +020050#include <linux/mutex.h>
Douglas Gilbertcc833ac2014-06-25 14:08:03 +020051#include <linux/atomic.h>
Christian Dietrich2fe038e2011-06-04 17:36:10 +020052#include <linux/ratelimit.h>
Christoph Hellwige2e40f22015-02-22 08:58:50 -080053#include <linux/uio.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
55#include "scsi.h"
db9dff32005-04-03 14:53:59 -050056#include <scsi/scsi_dbg.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070057#include <scsi/scsi_host.h>
58#include <scsi/scsi_driver.h>
59#include <scsi/scsi_ioctl.h>
60#include <scsi/sg.h>
61
62#include "scsi_logging.h"
63
64#ifdef CONFIG_SCSI_PROC_FS
65#include <linux/proc_fs.h>
Douglas Gilbert65c26a02014-06-03 13:18:18 -040066static char *sg_version_date = "20140603";
Linus Torvalds1da177e2005-04-16 15:20:36 -070067
68static int sg_proc_init(void);
69static void sg_proc_cleanup(void);
70#endif
71
Linus Torvalds1da177e2005-04-16 15:20:36 -070072#define SG_ALLOW_DIO_DEF 0
Linus Torvalds1da177e2005-04-16 15:20:36 -070073
74#define SG_MAX_DEVS 32768
75
Douglas Gilbert65c26a02014-06-03 13:18:18 -040076/* SG_MAX_CDB_SIZE should be 260 (spc4r37 section 3.1.30) however the type
77 * of sg_io_hdr::cmd_len can only represent 255. All SCSI commands greater
78 * than 16 bytes are "variable length" whose length is a multiple of 4
79 */
80#define SG_MAX_CDB_SIZE 252
81
Linus Torvalds1da177e2005-04-16 15:20:36 -070082/*
83 * Suppose you want to calculate the formula muldiv(x,m,d)=int(x * m / d)
84 * Then when using 32 bit integers x * m may overflow during the calculation.
85 * Replacing muldiv(x) by muldiv(x)=((x % d) * m) / d + int(x / d) * m
86 * calculates the same, but prevents the overflow when both m and d
87 * are "small" numbers (like HZ and USER_HZ).
88 * Of course an overflow is inavoidable if the result of muldiv doesn't fit
89 * in 32 bits.
90 */
91#define MULDIV(X,MUL,DIV) ((((X % DIV) * MUL) / DIV) + ((X / DIV) * MUL))
92
93#define SG_DEFAULT_TIMEOUT MULDIV(SG_DEFAULT_TIMEOUT_USER, HZ, USER_HZ)
94
95int sg_big_buff = SG_DEF_RESERVED_SIZE;
96/* N.B. This variable is readable and writeable via
97 /proc/scsi/sg/def_reserved_size . Each time sg_open() is called a buffer
98 of this size (or less if there is not enough memory) will be reserved
99 for use by this file descriptor. [Deprecated usage: this variable is also
100 readable via /proc/sys/kernel/sg-big-buff if the sg driver is built into
101 the kernel (i.e. it is not a module).] */
102static int def_reserved_size = -1; /* picks up init parameter */
103static int sg_allow_dio = SG_ALLOW_DIO_DEF;
104
Douglas Gilbert6460e752006-09-20 18:20:49 -0400105static int scatter_elem_sz = SG_SCATTER_SZ;
106static int scatter_elem_sz_prev = SG_SCATTER_SZ;
107
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108#define SG_SECTOR_SZ 512
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200110static int sg_add_device(struct device *, struct class_interface *);
111static void sg_remove_device(struct device *, struct class_interface *);
James Bottomley98481ff2013-10-25 10:26:38 +0100112
James Bottomley7c07d612007-08-05 13:36:11 -0500113static DEFINE_IDR(sg_index_idr);
James Bottomleyc0d3b9c2013-10-25 10:21:57 +0100114static DEFINE_RWLOCK(sg_index_lock); /* Also used to lock
115 file descriptor list for device */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116
117static struct class_interface sg_interface = {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200118 .add_dev = sg_add_device,
119 .remove_dev = sg_remove_device,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120};
121
122typedef struct sg_scatter_hold { /* holding area for scsi scatter gather info */
123 unsigned short k_use_sg; /* Count of kernel scatter-gather pieces */
FUJITA Tomonoriea312552007-08-06 00:31:24 +0900124 unsigned sglist_len; /* size of malloc'd scatter-gather list ++ */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125 unsigned bufflen; /* Size of (aggregate) data buffer */
FUJITA Tomonori10db10d2008-08-29 12:32:18 +0200126 struct page **pages;
127 int page_order;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 char dio_in_use; /* 0->indirect IO (or mmap), 1->dio */
129 unsigned char cmd_opcode; /* first byte of command */
130} Sg_scatter_hold;
131
132struct sg_device; /* forward declarations */
133struct sg_fd;
134
135typedef struct sg_request { /* SG_MAX_QUEUE requests outstanding per file */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 struct sg_request *nextrp; /* NULL -> tail request (slist) */
137 struct sg_fd *parentfp; /* NULL -> not in use */
138 Sg_scatter_hold data; /* hold buffer, perhaps scatter list */
139 sg_io_hdr_t header; /* scsi command+info, see <scsi/sg.h> */
Mike Christied6b10342005-11-08 04:06:41 -0600140 unsigned char sense_b[SCSI_SENSE_BUFFERSIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 char res_used; /* 1 -> using reserve buffer, 0 -> not ... */
142 char orphan; /* 1 -> drop on sight, 0 -> normal */
143 char sg_io_owned; /* 1 -> packet belongs to SG_IO */
Jörn Engel6acddc52012-04-12 17:33:58 -0400144 /* done protected by rq_list_lock */
145 char done; /* 0->before bh, 1->before read, 2->read */
FUJITA Tomonori10865df2008-08-28 16:17:07 +0900146 struct request *rq;
FUJITA Tomonori6e5a30c2008-08-28 16:17:08 +0900147 struct bio *bio;
FUJITA Tomonoric96952e2009-02-04 11:36:27 +0900148 struct execute_work ew;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149} Sg_request;
150
151typedef struct sg_fd { /* holds the state of a file descriptor */
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200152 struct list_head sfd_siblings; /* protected by device's sfd_lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 struct sg_device *parentdp; /* owning device */
154 wait_queue_head_t read_wait; /* queue read until command done */
155 rwlock_t rq_list_lock; /* protect access to list in req_arr */
156 int timeout; /* defaults to SG_DEFAULT_TIMEOUT */
157 int timeout_user; /* defaults to SG_DEFAULT_TIMEOUT_USER */
158 Sg_scatter_hold reserve; /* buffer held for this file descriptor */
159 unsigned save_scat_len; /* original length of trunc. scat. element */
160 Sg_request *headrp; /* head of request slist, NULL->empty */
161 struct fasync_struct *async_qp; /* used by asynchronous notification */
162 Sg_request req_arr[SG_MAX_QUEUE]; /* used as singly-linked list */
163 char low_dma; /* as in parent but possibly overridden to 1 */
164 char force_packid; /* 1 -> pack_id input to read(), 0 -> ignored */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165 char cmd_q; /* 1 -> allow command queuing, 0 -> don't */
Douglas Gilbert65c26a02014-06-03 13:18:18 -0400166 unsigned char next_cmd_len; /* 0: automatic, >0: use on next write() */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 char keep_orphan; /* 0 -> drop orphan (def), 1 -> keep for read() */
168 char mmap_called; /* 0 -> mmap() never called on this fd */
Tony Battersbyc6517b792009-01-21 14:45:50 -0500169 struct kref f_ref;
170 struct execute_work ew;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171} Sg_fd;
172
173typedef struct sg_device { /* holds the state of each scsi generic device */
174 struct scsi_device *device;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200175 wait_queue_head_t open_wait; /* queue open() when O_EXCL present */
176 struct mutex open_rel_lock; /* held when in open() or release() */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177 int sg_tablesize; /* adapter's max scatter-gather table size */
James Bottomley7c07d612007-08-05 13:36:11 -0500178 u32 index; /* device index number */
FUJITA Tomonori3442f802009-02-16 13:26:53 +0900179 struct list_head sfds;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200180 rwlock_t sfd_lock; /* protect access to sfd list */
181 atomic_t detaching; /* 0->device usable, 1->device detaching */
182 bool exclude; /* 1->open(O_EXCL) succeeded and is active */
183 int open_cnt; /* count of opens (perhaps < num(sfds) ) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184 char sgdebug; /* 0->off, 1->sense, 9->dump dev, 10-> all devs */
185 struct gendisk *disk;
186 struct cdev * cdev; /* char_dev [sysfs: /sys/cdev/major/sg<n>] */
Tony Battersbyc6517b792009-01-21 14:45:50 -0500187 struct kref d_ref;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188} Sg_device;
189
Mike Christied6b10342005-11-08 04:06:41 -0600190/* tasklet or soft irq callback */
FUJITA Tomonoria91a3a22008-09-02 22:50:01 +0900191static void sg_rq_end_io(struct request *rq, int uptodate);
FUJITA Tomonori10865df2008-08-28 16:17:07 +0900192static int sg_start_req(Sg_request *srp, unsigned char *cmd);
FUJITA Tomonorie7ee4cc2009-04-04 00:35:42 +0900193static int sg_finish_rem_req(Sg_request * srp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194static int sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195static ssize_t sg_new_read(Sg_fd * sfp, char __user *buf, size_t count,
196 Sg_request * srp);
Adel Gadllah0b07de82008-06-26 13:48:27 +0200197static ssize_t sg_new_write(Sg_fd *sfp, struct file *file,
198 const char __user *buf, size_t count, int blocking,
Tony Battersbya2dd3b42009-01-20 17:00:09 -0500199 int read_only, int sg_io_owned, Sg_request **o_srp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200static int sg_common_write(Sg_fd * sfp, Sg_request * srp,
201 unsigned char *cmnd, int timeout, int blocking);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202static int sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer);
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200203static void sg_remove_scat(Sg_fd * sfp, Sg_scatter_hold * schp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204static void sg_build_reserve(Sg_fd * sfp, int req_size);
205static void sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size);
206static void sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp);
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200207static Sg_fd *sg_add_sfp(Sg_device * sdp);
Tony Battersbyc6517b792009-01-21 14:45:50 -0500208static void sg_remove_sfp(struct kref *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209static Sg_request *sg_get_rq_mark(Sg_fd * sfp, int pack_id);
210static Sg_request *sg_add_request(Sg_fd * sfp);
211static int sg_remove_request(Sg_fd * sfp, Sg_request * srp);
212static int sg_res_in_use(Sg_fd * sfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213static Sg_device *sg_get_dev(int dev);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200214static void sg_device_destroy(struct kref *kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216#define SZ_SG_HEADER sizeof(struct sg_header)
217#define SZ_SG_IO_HDR sizeof(sg_io_hdr_t)
218#define SZ_SG_IOVEC sizeof(sg_iovec_t)
219#define SZ_SG_REQ_INFO sizeof(sg_req_info_t)
220
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200221#define sg_printk(prefix, sdp, fmt, a...) \
Hannes Reinecke22e0d992014-10-24 14:26:44 +0200222 sdev_prefix_printk(prefix, (sdp)->device, \
223 (sdp)->disk->disk_name, fmt, ##a)
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200224
FUJITA Tomonori14e507b2008-07-26 18:03:24 +0900225static int sg_allow_access(struct file *filp, unsigned char *cmd)
226{
Joe Perches35df8392010-09-04 18:52:46 -0700227 struct sg_fd *sfp = filp->private_data;
FUJITA Tomonori14e507b2008-07-26 18:03:24 +0900228
229 if (sfp->parentdp->device->type == TYPE_SCANNER)
230 return 0;
231
Jens Axboe018e0442009-06-26 16:27:10 +0200232 return blk_verify_command(cmd, filp->f_mode & FMODE_WRITE);
FUJITA Tomonori14e507b2008-07-26 18:03:24 +0900233}
234
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200235static int
236open_wait(Sg_device *sdp, int flags)
James Bottomley98481ff2013-10-25 10:26:38 +0100237{
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200238 int retval = 0;
James Bottomley98481ff2013-10-25 10:26:38 +0100239
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200240 if (flags & O_EXCL) {
241 while (sdp->open_cnt > 0) {
242 mutex_unlock(&sdp->open_rel_lock);
243 retval = wait_event_interruptible(sdp->open_wait,
244 (atomic_read(&sdp->detaching) ||
245 !sdp->open_cnt));
246 mutex_lock(&sdp->open_rel_lock);
247
248 if (retval) /* -ERESTARTSYS */
249 return retval;
250 if (atomic_read(&sdp->detaching))
251 return -ENODEV;
252 }
253 } else {
254 while (sdp->exclude) {
255 mutex_unlock(&sdp->open_rel_lock);
256 retval = wait_event_interruptible(sdp->open_wait,
257 (atomic_read(&sdp->detaching) ||
258 !sdp->exclude));
259 mutex_lock(&sdp->open_rel_lock);
260
261 if (retval) /* -ERESTARTSYS */
262 return retval;
263 if (atomic_read(&sdp->detaching))
264 return -ENODEV;
265 }
266 }
267
268 return retval;
James Bottomley98481ff2013-10-25 10:26:38 +0100269}
270
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200271/* Returns 0 on success, else a negated errno value */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272static int
273sg_open(struct inode *inode, struct file *filp)
274{
275 int dev = iminor(inode);
276 int flags = filp->f_flags;
Mike Christied6b10342005-11-08 04:06:41 -0600277 struct request_queue *q;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278 Sg_device *sdp;
279 Sg_fd *sfp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280 int retval;
281
282 nonseekable_open(inode, filp);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200283 if ((flags & O_EXCL) && (O_RDONLY == (flags & O_ACCMODE)))
284 return -EPERM; /* Can't lock it with read only access */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285 sdp = sg_get_dev(dev);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200286 if (IS_ERR(sdp))
287 return PTR_ERR(sdp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200289 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
290 "sg_open: flags=0x%x\n", flags));
291
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292 /* This driver's module count bumped by fops_get in <linux/fs.h> */
293 /* Prevent the device driver from vanishing while we sleep */
294 retval = scsi_device_get(sdp->device);
Tony Battersbyc6517b792009-01-21 14:45:50 -0500295 if (retval)
296 goto sg_put;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297
Alan Sternbc4f2402010-06-17 10:41:42 -0400298 retval = scsi_autopm_get_device(sdp->device);
299 if (retval)
300 goto sdp_put;
301
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200302 /* scsi_block_when_processing_errors() may block so bypass
303 * check if O_NONBLOCK. Permits SCSI commands to be issued
304 * during error recovery. Tread carefully. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305 if (!((flags & O_NONBLOCK) ||
306 scsi_block_when_processing_errors(sdp->device))) {
307 retval = -ENXIO;
308 /* we are in error recovery for this device */
309 goto error_out;
310 }
311
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200312 mutex_lock(&sdp->open_rel_lock);
313 if (flags & O_NONBLOCK) {
314 if (flags & O_EXCL) {
315 if (sdp->open_cnt > 0) {
316 retval = -EBUSY;
317 goto error_mutex_locked;
318 }
319 } else {
320 if (sdp->exclude) {
321 retval = -EBUSY;
322 goto error_mutex_locked;
323 }
Vaughan Cao15b06f92013-08-29 10:00:36 +0800324 }
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200325 } else {
326 retval = open_wait(sdp, flags);
327 if (retval) /* -ERESTARTSYS or -ENODEV */
328 goto error_mutex_locked;
Vaughan Cao15b06f92013-08-29 10:00:36 +0800329 }
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200330
331 /* N.B. at this point we are holding the open_rel_lock */
332 if (flags & O_EXCL)
333 sdp->exclude = true;
334
335 if (sdp->open_cnt < 1) { /* no existing opens */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 sdp->sgdebug = 0;
Mike Christied6b10342005-11-08 04:06:41 -0600337 q = sdp->device->request_queue;
Martin K. Petersen8a783622010-02-26 00:20:39 -0500338 sdp->sg_tablesize = queue_max_segments(q);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339 }
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200340 sfp = sg_add_sfp(sdp);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200341 if (IS_ERR(sfp)) {
342 retval = PTR_ERR(sfp);
343 goto out_undo;
James Bottomley065b4a22013-10-25 10:27:02 +0100344 }
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200345
346 filp->private_data = sfp;
347 sdp->open_cnt++;
348 mutex_unlock(&sdp->open_rel_lock);
349
James Bottomley065b4a22013-10-25 10:27:02 +0100350 retval = 0;
Tony Battersbyc6517b792009-01-21 14:45:50 -0500351sg_put:
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200352 kref_put(&sdp->d_ref, sg_device_destroy);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 return retval;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200354
355out_undo:
356 if (flags & O_EXCL) {
357 sdp->exclude = false; /* undo if error */
358 wake_up_interruptible(&sdp->open_wait);
359 }
360error_mutex_locked:
361 mutex_unlock(&sdp->open_rel_lock);
362error_out:
363 scsi_autopm_put_device(sdp->device);
364sdp_put:
365 scsi_device_put(sdp->device);
366 goto sg_put;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367}
368
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200369/* Release resources associated with a successful sg_open()
370 * Returns 0 on success, else a negated errno value */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371static int
372sg_release(struct inode *inode, struct file *filp)
373{
374 Sg_device *sdp;
375 Sg_fd *sfp;
376
377 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
378 return -ENXIO;
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200379 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp, "sg_release\n"));
Tony Battersbyc6517b792009-01-21 14:45:50 -0500380
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200381 mutex_lock(&sdp->open_rel_lock);
Alan Sternbc4f2402010-06-17 10:41:42 -0400382 scsi_autopm_put_device(sdp->device);
Tony Battersbyc6517b792009-01-21 14:45:50 -0500383 kref_put(&sfp->f_ref, sg_remove_sfp);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200384 sdp->open_cnt--;
385
386 /* possibly many open()s waiting on exlude clearing, start many;
387 * only open(O_EXCL)s wait on 0==open_cnt so only start one */
388 if (sdp->exclude) {
389 sdp->exclude = false;
390 wake_up_interruptible_all(&sdp->open_wait);
391 } else if (0 == sdp->open_cnt) {
392 wake_up_interruptible(&sdp->open_wait);
393 }
394 mutex_unlock(&sdp->open_rel_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 return 0;
396}
397
398static ssize_t
399sg_read(struct file *filp, char __user *buf, size_t count, loff_t * ppos)
400{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 Sg_device *sdp;
402 Sg_fd *sfp;
403 Sg_request *srp;
404 int req_pack_id = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 sg_io_hdr_t *hp;
cb59e842005-04-02 13:51:23 -0600406 struct sg_header *old_hdr = NULL;
407 int retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408
409 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
410 return -ENXIO;
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200411 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
412 "sg_read: count=%d\n", (int) count));
Mike Christied6b10342005-11-08 04:06:41 -0600413
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414 if (!access_ok(VERIFY_WRITE, buf, count))
415 return -EFAULT;
416 if (sfp->force_packid && (count >= SZ_SG_HEADER)) {
cb59e842005-04-02 13:51:23 -0600417 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
418 if (!old_hdr)
419 return -ENOMEM;
420 if (__copy_from_user(old_hdr, buf, SZ_SG_HEADER)) {
421 retval = -EFAULT;
422 goto free_old_hdr;
423 }
424 if (old_hdr->reply_len < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 if (count >= SZ_SG_IO_HDR) {
cb59e842005-04-02 13:51:23 -0600426 sg_io_hdr_t *new_hdr;
427 new_hdr = kmalloc(SZ_SG_IO_HDR, GFP_KERNEL);
428 if (!new_hdr) {
429 retval = -ENOMEM;
430 goto free_old_hdr;
431 }
432 retval =__copy_from_user
433 (new_hdr, buf, SZ_SG_IO_HDR);
434 req_pack_id = new_hdr->pack_id;
435 kfree(new_hdr);
436 if (retval) {
437 retval = -EFAULT;
438 goto free_old_hdr;
439 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 }
441 } else
cb59e842005-04-02 13:51:23 -0600442 req_pack_id = old_hdr->pack_id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443 }
444 srp = sg_get_rq_mark(sfp, req_pack_id);
445 if (!srp) { /* now wait on packet to arrive */
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200446 if (atomic_read(&sdp->detaching)) {
cb59e842005-04-02 13:51:23 -0600447 retval = -ENODEV;
448 goto free_old_hdr;
449 }
450 if (filp->f_flags & O_NONBLOCK) {
451 retval = -EAGAIN;
452 goto free_old_hdr;
453 }
Jörn Engel3f0c6ab2012-04-12 17:33:25 -0400454 retval = wait_event_interruptible(sfp->read_wait,
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200455 (atomic_read(&sdp->detaching) ||
Jörn Engel3f0c6ab2012-04-12 17:33:25 -0400456 (srp = sg_get_rq_mark(sfp, req_pack_id))));
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200457 if (atomic_read(&sdp->detaching)) {
Jörn Engel794c10f2012-04-12 17:32:48 -0400458 retval = -ENODEV;
459 goto free_old_hdr;
460 }
461 if (retval) {
cb59e842005-04-02 13:51:23 -0600462 /* -ERESTARTSYS as signal hit process */
463 goto free_old_hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464 }
465 }
cb59e842005-04-02 13:51:23 -0600466 if (srp->header.interface_id != '\0') {
467 retval = sg_new_read(sfp, buf, count, srp);
468 goto free_old_hdr;
469 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470
471 hp = &srp->header;
cb59e842005-04-02 13:51:23 -0600472 if (old_hdr == NULL) {
473 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
474 if (! old_hdr) {
475 retval = -ENOMEM;
476 goto free_old_hdr;
477 }
478 }
479 memset(old_hdr, 0, SZ_SG_HEADER);
480 old_hdr->reply_len = (int) hp->timeout;
481 old_hdr->pack_len = old_hdr->reply_len; /* old, strange behaviour */
482 old_hdr->pack_id = hp->pack_id;
483 old_hdr->twelve_byte =
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484 ((srp->data.cmd_opcode >= 0xc0) && (12 == hp->cmd_len)) ? 1 : 0;
cb59e842005-04-02 13:51:23 -0600485 old_hdr->target_status = hp->masked_status;
486 old_hdr->host_status = hp->host_status;
487 old_hdr->driver_status = hp->driver_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488 if ((CHECK_CONDITION & hp->masked_status) ||
489 (DRIVER_SENSE & hp->driver_status))
cb59e842005-04-02 13:51:23 -0600490 memcpy(old_hdr->sense_buffer, srp->sense_b,
491 sizeof (old_hdr->sense_buffer));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 switch (hp->host_status) {
493 /* This setup of 'result' is for backward compatibility and is best
494 ignored by the user who should use target, host + driver status */
495 case DID_OK:
496 case DID_PASSTHROUGH:
497 case DID_SOFT_ERROR:
cb59e842005-04-02 13:51:23 -0600498 old_hdr->result = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499 break;
500 case DID_NO_CONNECT:
501 case DID_BUS_BUSY:
502 case DID_TIME_OUT:
cb59e842005-04-02 13:51:23 -0600503 old_hdr->result = EBUSY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 break;
505 case DID_BAD_TARGET:
506 case DID_ABORT:
507 case DID_PARITY:
508 case DID_RESET:
509 case DID_BAD_INTR:
cb59e842005-04-02 13:51:23 -0600510 old_hdr->result = EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511 break;
512 case DID_ERROR:
cb59e842005-04-02 13:51:23 -0600513 old_hdr->result = (srp->sense_b[0] == 0 &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 hp->masked_status == GOOD) ? 0 : EIO;
515 break;
516 default:
cb59e842005-04-02 13:51:23 -0600517 old_hdr->result = EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 break;
519 }
520
521 /* Now copy the result back to the user buffer. */
522 if (count >= SZ_SG_HEADER) {
cb59e842005-04-02 13:51:23 -0600523 if (__copy_to_user(buf, old_hdr, SZ_SG_HEADER)) {
524 retval = -EFAULT;
525 goto free_old_hdr;
526 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527 buf += SZ_SG_HEADER;
cb59e842005-04-02 13:51:23 -0600528 if (count > old_hdr->reply_len)
529 count = old_hdr->reply_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 if (count > SZ_SG_HEADER) {
cb59e842005-04-02 13:51:23 -0600531 if (sg_read_oxfer(srp, buf, count - SZ_SG_HEADER)) {
532 retval = -EFAULT;
533 goto free_old_hdr;
534 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535 }
536 } else
cb59e842005-04-02 13:51:23 -0600537 count = (old_hdr->result == 0) ? 0 : -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538 sg_finish_rem_req(srp);
cb59e842005-04-02 13:51:23 -0600539 retval = count;
540free_old_hdr:
Jesper Juhlc9475cb2005-11-07 01:01:26 -0800541 kfree(old_hdr);
cb59e842005-04-02 13:51:23 -0600542 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543}
544
545static ssize_t
546sg_new_read(Sg_fd * sfp, char __user *buf, size_t count, Sg_request * srp)
547{
548 sg_io_hdr_t *hp = &srp->header;
Tony Battersby3b524a62015-02-11 11:32:06 -0500549 int err = 0, err2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 int len;
551
552 if (count < SZ_SG_IO_HDR) {
553 err = -EINVAL;
554 goto err_out;
555 }
556 hp->sb_len_wr = 0;
557 if ((hp->mx_sb_len > 0) && hp->sbp) {
558 if ((CHECK_CONDITION & hp->masked_status) ||
559 (DRIVER_SENSE & hp->driver_status)) {
Mike Christied6b10342005-11-08 04:06:41 -0600560 int sb_len = SCSI_SENSE_BUFFERSIZE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 sb_len = (hp->mx_sb_len > sb_len) ? sb_len : hp->mx_sb_len;
562 len = 8 + (int) srp->sense_b[7]; /* Additional sense length field */
563 len = (len > sb_len) ? sb_len : len;
564 if (copy_to_user(hp->sbp, srp->sense_b, len)) {
565 err = -EFAULT;
566 goto err_out;
567 }
568 hp->sb_len_wr = len;
569 }
570 }
571 if (hp->masked_status || hp->host_status || hp->driver_status)
572 hp->info |= SG_INFO_CHECK;
573 if (copy_to_user(buf, hp, SZ_SG_IO_HDR)) {
574 err = -EFAULT;
575 goto err_out;
576 }
FUJITA Tomonori0b6cb262008-09-02 22:50:07 +0900577err_out:
Tony Battersby3b524a62015-02-11 11:32:06 -0500578 err2 = sg_finish_rem_req(srp);
579 return err ? : err2 ? : count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580}
581
582static ssize_t
583sg_write(struct file *filp, const char __user *buf, size_t count, loff_t * ppos)
584{
585 int mxsize, cmd_size, k;
586 int input_size, blocking;
587 unsigned char opcode;
588 Sg_device *sdp;
589 Sg_fd *sfp;
590 Sg_request *srp;
591 struct sg_header old_hdr;
592 sg_io_hdr_t *hp;
Douglas Gilbert65c26a02014-06-03 13:18:18 -0400593 unsigned char cmnd[SG_MAX_CDB_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594
595 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
596 return -ENXIO;
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200597 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
598 "sg_write: count=%d\n", (int) count));
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200599 if (atomic_read(&sdp->detaching))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600 return -ENODEV;
601 if (!((filp->f_flags & O_NONBLOCK) ||
602 scsi_block_when_processing_errors(sdp->device)))
603 return -ENXIO;
604
605 if (!access_ok(VERIFY_READ, buf, count))
606 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
607 if (count < SZ_SG_HEADER)
608 return -EIO;
609 if (__copy_from_user(&old_hdr, buf, SZ_SG_HEADER))
610 return -EFAULT;
611 blocking = !(filp->f_flags & O_NONBLOCK);
612 if (old_hdr.reply_len < 0)
Tony Battersbya2dd3b42009-01-20 17:00:09 -0500613 return sg_new_write(sfp, filp, buf, count,
614 blocking, 0, 0, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 if (count < (SZ_SG_HEADER + 6))
616 return -EIO; /* The minimum scsi command length is 6 bytes. */
617
618 if (!(srp = sg_add_request(sfp))) {
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200619 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO, sdp,
620 "sg_write: queue full\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 return -EDOM;
622 }
623 buf += SZ_SG_HEADER;
624 __get_user(opcode, buf);
625 if (sfp->next_cmd_len > 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 cmd_size = sfp->next_cmd_len;
627 sfp->next_cmd_len = 0; /* reset so only this write() effected */
628 } else {
629 cmd_size = COMMAND_SIZE(opcode); /* based on SCSI command group */
630 if ((opcode >= 0xc0) && old_hdr.twelve_byte)
631 cmd_size = 12;
632 }
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200633 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sdp,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634 "sg_write: scsi opcode=0x%02x, cmd_size=%d\n", (int) opcode, cmd_size));
635/* Determine buffer size. */
636 input_size = count - cmd_size;
637 mxsize = (input_size > old_hdr.reply_len) ? input_size : old_hdr.reply_len;
638 mxsize -= SZ_SG_HEADER;
639 input_size -= SZ_SG_HEADER;
640 if (input_size < 0) {
641 sg_remove_request(sfp, srp);
642 return -EIO; /* User did not pass enough bytes for this command. */
643 }
644 hp = &srp->header;
645 hp->interface_id = '\0'; /* indicator of old interface tunnelled */
646 hp->cmd_len = (unsigned char) cmd_size;
647 hp->iovec_count = 0;
648 hp->mx_sb_len = 0;
649 if (input_size > 0)
650 hp->dxfer_direction = (old_hdr.reply_len > SZ_SG_HEADER) ?
651 SG_DXFER_TO_FROM_DEV : SG_DXFER_TO_DEV;
652 else
653 hp->dxfer_direction = (mxsize > 0) ? SG_DXFER_FROM_DEV : SG_DXFER_NONE;
654 hp->dxfer_len = mxsize;
FUJITA Tomonorifad7f012008-09-02 16:20:20 +0900655 if (hp->dxfer_direction == SG_DXFER_TO_DEV)
656 hp->dxferp = (char __user *)buf + cmd_size;
657 else
658 hp->dxferp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 hp->sbp = NULL;
660 hp->timeout = old_hdr.reply_len; /* structure abuse ... */
661 hp->flags = input_size; /* structure abuse ... */
662 hp->pack_id = old_hdr.pack_id;
663 hp->usr_ptr = NULL;
664 if (__copy_from_user(cmnd, buf, cmd_size))
665 return -EFAULT;
666 /*
667 * SG_DXFER_TO_FROM_DEV is functionally equivalent to SG_DXFER_FROM_DEV,
668 * but is is possible that the app intended SG_DXFER_TO_DEV, because there
669 * is a non-zero input_size, so emit a warning.
670 */
Andi Kleeneaa3e222008-01-13 17:41:43 +0100671 if (hp->dxfer_direction == SG_DXFER_TO_FROM_DEV) {
672 static char cmd[TASK_COMM_LEN];
Christian Dietrich2fe038e2011-06-04 17:36:10 +0200673 if (strcmp(current->comm, cmd)) {
674 printk_ratelimited(KERN_WARNING
675 "sg_write: data in/out %d/%d bytes "
676 "for SCSI command 0x%x-- guessing "
677 "data in;\n program %s not setting "
678 "count and/or reply_len properly\n",
679 old_hdr.reply_len - (int)SZ_SG_HEADER,
680 input_size, (unsigned int) cmnd[0],
681 current->comm);
Andi Kleeneaa3e222008-01-13 17:41:43 +0100682 strcpy(cmd, current->comm);
683 }
684 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685 k = sg_common_write(sfp, srp, cmnd, sfp->timeout, blocking);
686 return (k < 0) ? k : count;
687}
688
689static ssize_t
Adel Gadllah0b07de82008-06-26 13:48:27 +0200690sg_new_write(Sg_fd *sfp, struct file *file, const char __user *buf,
Tony Battersbya2dd3b42009-01-20 17:00:09 -0500691 size_t count, int blocking, int read_only, int sg_io_owned,
Adel Gadllah0b07de82008-06-26 13:48:27 +0200692 Sg_request **o_srp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693{
694 int k;
695 Sg_request *srp;
696 sg_io_hdr_t *hp;
Douglas Gilbert65c26a02014-06-03 13:18:18 -0400697 unsigned char cmnd[SG_MAX_CDB_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698 int timeout;
699 unsigned long ul_timeout;
700
701 if (count < SZ_SG_IO_HDR)
702 return -EINVAL;
703 if (!access_ok(VERIFY_READ, buf, count))
704 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
705
706 sfp->cmd_q = 1; /* when sg_io_hdr seen, set command queuing on */
707 if (!(srp = sg_add_request(sfp))) {
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200708 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO, sfp->parentdp,
709 "sg_new_write: queue full\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710 return -EDOM;
711 }
Tony Battersbya2dd3b42009-01-20 17:00:09 -0500712 srp->sg_io_owned = sg_io_owned;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713 hp = &srp->header;
714 if (__copy_from_user(hp, buf, SZ_SG_IO_HDR)) {
715 sg_remove_request(sfp, srp);
716 return -EFAULT;
717 }
718 if (hp->interface_id != 'S') {
719 sg_remove_request(sfp, srp);
720 return -ENOSYS;
721 }
722 if (hp->flags & SG_FLAG_MMAP_IO) {
723 if (hp->dxfer_len > sfp->reserve.bufflen) {
724 sg_remove_request(sfp, srp);
725 return -ENOMEM; /* MMAP_IO size must fit in reserve buffer */
726 }
727 if (hp->flags & SG_FLAG_DIRECT_IO) {
728 sg_remove_request(sfp, srp);
729 return -EINVAL; /* either MMAP_IO or DIRECT_IO (not both) */
730 }
731 if (sg_res_in_use(sfp)) {
732 sg_remove_request(sfp, srp);
733 return -EBUSY; /* reserve buffer already being used */
734 }
735 }
736 ul_timeout = msecs_to_jiffies(srp->header.timeout);
737 timeout = (ul_timeout < INT_MAX) ? ul_timeout : INT_MAX;
738 if ((!hp->cmdp) || (hp->cmd_len < 6) || (hp->cmd_len > sizeof (cmnd))) {
739 sg_remove_request(sfp, srp);
740 return -EMSGSIZE;
741 }
742 if (!access_ok(VERIFY_READ, hp->cmdp, hp->cmd_len)) {
743 sg_remove_request(sfp, srp);
744 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
745 }
746 if (__copy_from_user(cmnd, hp->cmdp, hp->cmd_len)) {
747 sg_remove_request(sfp, srp);
748 return -EFAULT;
749 }
FUJITA Tomonori14e507b2008-07-26 18:03:24 +0900750 if (read_only && sg_allow_access(file, cmnd)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 sg_remove_request(sfp, srp);
752 return -EPERM;
753 }
754 k = sg_common_write(sfp, srp, cmnd, timeout, blocking);
755 if (k < 0)
756 return k;
757 if (o_srp)
758 *o_srp = srp;
759 return count;
760}
761
762static int
763sg_common_write(Sg_fd * sfp, Sg_request * srp,
764 unsigned char *cmnd, int timeout, int blocking)
765{
Bart Van Assche5af2e382015-01-30 16:22:38 +0100766 int k, at_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767 Sg_device *sdp = sfp->parentdp;
768 sg_io_hdr_t *hp = &srp->header;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769
770 srp->data.cmd_opcode = cmnd[0]; /* hold opcode of command */
771 hp->status = 0;
772 hp->masked_status = 0;
773 hp->msg_status = 0;
774 hp->info = 0;
775 hp->host_status = 0;
776 hp->driver_status = 0;
777 hp->resid = 0;
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200778 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
779 "sg_common_write: scsi opcode=0x%02x, cmd_size=%d\n",
780 (int) cmnd[0], (int) hp->cmd_len));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781
FUJITA Tomonori10865df2008-08-28 16:17:07 +0900782 k = sg_start_req(srp, cmnd);
783 if (k) {
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200784 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO, sfp->parentdp,
785 "sg_common_write: start_req err=%d\n", k));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786 sg_finish_rem_req(srp);
787 return k; /* probably out of space --> ENOMEM */
788 }
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200789 if (atomic_read(&sdp->detaching)) {
FUJITA Tomonoricaf19d32010-07-22 09:36:51 +0900790 if (srp->bio)
791 blk_end_request_all(srp->rq, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792 sg_finish_rem_req(srp);
793 return -ENODEV;
794 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795
cb59e842005-04-02 13:51:23 -0600796 hp->duration = jiffies_to_msecs(jiffies);
Douglas Gilbert16070cc2014-06-04 10:58:30 -0400797 if (hp->interface_id != '\0' && /* v3 (or later) interface */
798 (SG_FLAG_Q_AT_TAIL & hp->flags))
799 at_head = 0;
800 else
801 at_head = 1;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +0200802
803 srp->rq->timeout = timeout;
Tony Battersbyc6517b792009-01-21 14:45:50 -0500804 kref_get(&sfp->f_ref); /* sg_rq_end_io() does kref_put(). */
FUJITA Tomonori10db10d2008-08-29 12:32:18 +0200805 blk_execute_rq_nowait(sdp->device->request_queue, sdp->disk,
Douglas Gilbert16070cc2014-06-04 10:58:30 -0400806 srp->rq, at_head, sg_rq_end_io);
FUJITA Tomonori10db10d2008-08-29 12:32:18 +0200807 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808}
809
Jörn Engel6acddc52012-04-12 17:33:58 -0400810static int srp_done(Sg_fd *sfp, Sg_request *srp)
811{
812 unsigned long flags;
813 int ret;
814
815 read_lock_irqsave(&sfp->rq_list_lock, flags);
816 ret = srp->done;
817 read_unlock_irqrestore(&sfp->rq_list_lock, flags);
818 return ret;
819}
820
Akinobu Mita46f69e62014-06-02 22:56:46 +0900821static int max_sectors_bytes(struct request_queue *q)
822{
823 unsigned int max_sectors = queue_max_sectors(q);
824
825 max_sectors = min_t(unsigned int, max_sectors, INT_MAX >> 9);
826
827 return max_sectors << 9;
828}
829
Jörn Engel37b9d1e2012-04-12 17:35:05 -0400830static long
Arnd Bergmannf4927c42010-04-27 00:24:01 +0200831sg_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832{
833 void __user *p = (void __user *)arg;
834 int __user *ip = p;
Christoph Hellwig176aa9d2014-10-11 12:06:47 +0200835 int result, val, read_only;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836 Sg_device *sdp;
837 Sg_fd *sfp;
838 Sg_request *srp;
839 unsigned long iflags;
840
841 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
842 return -ENXIO;
FUJITA Tomonoriabf54392008-08-16 14:10:05 +0900843
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200844 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
845 "sg_ioctl: cmd=0x%x\n", (int) cmd_in));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846 read_only = (O_RDWR != (filp->f_flags & O_ACCMODE));
847
848 switch (cmd_in) {
849 case SG_IO:
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200850 if (atomic_read(&sdp->detaching))
Jörn Engeldddbf8d2012-04-12 17:32:17 -0400851 return -ENODEV;
852 if (!scsi_block_when_processing_errors(sdp->device))
853 return -ENXIO;
854 if (!access_ok(VERIFY_WRITE, p, SZ_SG_IO_HDR))
855 return -EFAULT;
856 result = sg_new_write(sfp, filp, p, SZ_SG_IO_HDR,
857 1, read_only, 1, &srp);
858 if (result < 0)
859 return result;
Jörn Engel3f0c6ab2012-04-12 17:33:25 -0400860 result = wait_event_interruptible(sfp->read_wait,
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200861 (srp_done(sfp, srp) || atomic_read(&sdp->detaching)));
862 if (atomic_read(&sdp->detaching))
Jörn Engel794c10f2012-04-12 17:32:48 -0400863 return -ENODEV;
864 write_lock_irq(&sfp->rq_list_lock);
865 if (srp->done) {
866 srp->done = 2;
Jörn Engeldddbf8d2012-04-12 17:32:17 -0400867 write_unlock_irq(&sfp->rq_list_lock);
Jörn Engel794c10f2012-04-12 17:32:48 -0400868 result = sg_new_read(sfp, p, SZ_SG_IO_HDR, srp);
869 return (result < 0) ? result : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870 }
Jörn Engel794c10f2012-04-12 17:32:48 -0400871 srp->orphan = 1;
872 write_unlock_irq(&sfp->rq_list_lock);
873 return result; /* -ERESTARTSYS because signal hit process */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874 case SG_SET_TIMEOUT:
875 result = get_user(val, ip);
876 if (result)
877 return result;
878 if (val < 0)
879 return -EIO;
880 if (val >= MULDIV (INT_MAX, USER_HZ, HZ))
881 val = MULDIV (INT_MAX, USER_HZ, HZ);
882 sfp->timeout_user = val;
883 sfp->timeout = MULDIV (val, HZ, USER_HZ);
884
885 return 0;
886 case SG_GET_TIMEOUT: /* N.B. User receives timeout as return value */
887 /* strange ..., for backward compatibility */
888 return sfp->timeout_user;
889 case SG_SET_FORCE_LOW_DMA:
890 result = get_user(val, ip);
891 if (result)
892 return result;
893 if (val) {
894 sfp->low_dma = 1;
895 if ((0 == sfp->low_dma) && (0 == sg_res_in_use(sfp))) {
896 val = (int) sfp->reserve.bufflen;
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200897 sg_remove_scat(sfp, &sfp->reserve);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898 sg_build_reserve(sfp, val);
899 }
900 } else {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200901 if (atomic_read(&sdp->detaching))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902 return -ENODEV;
903 sfp->low_dma = sdp->device->host->unchecked_isa_dma;
904 }
905 return 0;
906 case SG_GET_LOW_DMA:
907 return put_user((int) sfp->low_dma, ip);
908 case SG_GET_SCSI_ID:
909 if (!access_ok(VERIFY_WRITE, p, sizeof (sg_scsi_id_t)))
910 return -EFAULT;
911 else {
912 sg_scsi_id_t __user *sg_idp = p;
913
Douglas Gilbertcc833ac2014-06-25 14:08:03 +0200914 if (atomic_read(&sdp->detaching))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915 return -ENODEV;
916 __put_user((int) sdp->device->host->host_no,
917 &sg_idp->host_no);
918 __put_user((int) sdp->device->channel,
919 &sg_idp->channel);
920 __put_user((int) sdp->device->id, &sg_idp->scsi_id);
921 __put_user((int) sdp->device->lun, &sg_idp->lun);
922 __put_user((int) sdp->device->type, &sg_idp->scsi_type);
923 __put_user((short) sdp->device->host->cmd_per_lun,
924 &sg_idp->h_cmd_per_lun);
925 __put_user((short) sdp->device->queue_depth,
926 &sg_idp->d_queue_depth);
927 __put_user(0, &sg_idp->unused[0]);
928 __put_user(0, &sg_idp->unused[1]);
929 return 0;
930 }
931 case SG_SET_FORCE_PACK_ID:
932 result = get_user(val, ip);
933 if (result)
934 return result;
935 sfp->force_packid = val ? 1 : 0;
936 return 0;
937 case SG_GET_PACK_ID:
938 if (!access_ok(VERIFY_WRITE, ip, sizeof (int)))
939 return -EFAULT;
940 read_lock_irqsave(&sfp->rq_list_lock, iflags);
941 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
942 if ((1 == srp->done) && (!srp->sg_io_owned)) {
943 read_unlock_irqrestore(&sfp->rq_list_lock,
944 iflags);
945 __put_user(srp->header.pack_id, ip);
946 return 0;
947 }
948 }
949 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
950 __put_user(-1, ip);
951 return 0;
952 case SG_GET_NUM_WAITING:
953 read_lock_irqsave(&sfp->rq_list_lock, iflags);
954 for (val = 0, srp = sfp->headrp; srp; srp = srp->nextrp) {
955 if ((1 == srp->done) && (!srp->sg_io_owned))
956 ++val;
957 }
958 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
959 return put_user(val, ip);
960 case SG_GET_SG_TABLESIZE:
961 return put_user(sdp->sg_tablesize, ip);
962 case SG_SET_RESERVED_SIZE:
963 result = get_user(val, ip);
964 if (result)
965 return result;
966 if (val < 0)
967 return -EINVAL;
Alan Stern44ec9542007-02-20 11:01:57 -0500968 val = min_t(int, val,
Akinobu Mita46f69e62014-06-02 22:56:46 +0900969 max_sectors_bytes(sdp->device->request_queue));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970 if (val != sfp->reserve.bufflen) {
971 if (sg_res_in_use(sfp) || sfp->mmap_called)
972 return -EBUSY;
Hannes Reinecke95e159d2014-06-25 16:39:55 +0200973 sg_remove_scat(sfp, &sfp->reserve);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974 sg_build_reserve(sfp, val);
975 }
976 return 0;
977 case SG_GET_RESERVED_SIZE:
Alan Stern44ec9542007-02-20 11:01:57 -0500978 val = min_t(int, sfp->reserve.bufflen,
Akinobu Mita46f69e62014-06-02 22:56:46 +0900979 max_sectors_bytes(sdp->device->request_queue));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980 return put_user(val, ip);
981 case SG_SET_COMMAND_Q:
982 result = get_user(val, ip);
983 if (result)
984 return result;
985 sfp->cmd_q = val ? 1 : 0;
986 return 0;
987 case SG_GET_COMMAND_Q:
988 return put_user((int) sfp->cmd_q, ip);
989 case SG_SET_KEEP_ORPHAN:
990 result = get_user(val, ip);
991 if (result)
992 return result;
993 sfp->keep_orphan = val;
994 return 0;
995 case SG_GET_KEEP_ORPHAN:
996 return put_user((int) sfp->keep_orphan, ip);
997 case SG_NEXT_CMD_LEN:
998 result = get_user(val, ip);
999 if (result)
1000 return result;
1001 sfp->next_cmd_len = (val > 0) ? val : 0;
1002 return 0;
1003 case SG_GET_VERSION_NUM:
1004 return put_user(sg_version_num, ip);
1005 case SG_GET_ACCESS_COUNT:
1006 /* faked - we don't have a real access count anymore */
1007 val = (sdp->device ? 1 : 0);
1008 return put_user(val, ip);
1009 case SG_GET_REQUEST_TABLE:
1010 if (!access_ok(VERIFY_WRITE, p, SZ_SG_REQ_INFO * SG_MAX_QUEUE))
1011 return -EFAULT;
1012 else {
cb59e842005-04-02 13:51:23 -06001013 sg_req_info_t *rinfo;
1014 unsigned int ms;
1015
1016 rinfo = kmalloc(SZ_SG_REQ_INFO * SG_MAX_QUEUE,
1017 GFP_KERNEL);
1018 if (!rinfo)
1019 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020 read_lock_irqsave(&sfp->rq_list_lock, iflags);
1021 for (srp = sfp->headrp, val = 0; val < SG_MAX_QUEUE;
1022 ++val, srp = srp ? srp->nextrp : srp) {
1023 memset(&rinfo[val], 0, SZ_SG_REQ_INFO);
1024 if (srp) {
1025 rinfo[val].req_state = srp->done + 1;
1026 rinfo[val].problem =
1027 srp->header.masked_status &
1028 srp->header.host_status &
1029 srp->header.driver_status;
cb59e842005-04-02 13:51:23 -06001030 if (srp->done)
1031 rinfo[val].duration =
1032 srp->header.duration;
1033 else {
1034 ms = jiffies_to_msecs(jiffies);
1035 rinfo[val].duration =
1036 (ms > srp->header.duration) ?
1037 (ms - srp->header.duration) : 0;
1038 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039 rinfo[val].orphan = srp->orphan;
cb59e842005-04-02 13:51:23 -06001040 rinfo[val].sg_io_owned =
1041 srp->sg_io_owned;
1042 rinfo[val].pack_id =
1043 srp->header.pack_id;
1044 rinfo[val].usr_ptr =
1045 srp->header.usr_ptr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046 }
1047 }
1048 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
cb59e842005-04-02 13:51:23 -06001049 result = __copy_to_user(p, rinfo,
1050 SZ_SG_REQ_INFO * SG_MAX_QUEUE);
1051 result = result ? -EFAULT : 0;
1052 kfree(rinfo);
1053 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054 }
1055 case SG_EMULATED_HOST:
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001056 if (atomic_read(&sdp->detaching))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057 return -ENODEV;
1058 return put_user(sdp->device->host->hostt->emulated, ip);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059 case SCSI_IOCTL_SEND_COMMAND:
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001060 if (atomic_read(&sdp->detaching))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061 return -ENODEV;
1062 if (read_only) {
1063 unsigned char opcode = WRITE_6;
1064 Scsi_Ioctl_Command __user *siocp = p;
1065
1066 if (copy_from_user(&opcode, siocp->data, 1))
1067 return -EFAULT;
FUJITA Tomonori14e507b2008-07-26 18:03:24 +09001068 if (sg_allow_access(filp, &opcode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069 return -EPERM;
1070 }
Al Viroe915e872008-09-02 17:16:41 -04001071 return sg_scsi_ioctl(sdp->device->request_queue, NULL, filp->f_mode, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072 case SG_SET_DEBUG:
1073 result = get_user(val, ip);
1074 if (result)
1075 return result;
1076 sdp->sgdebug = (char) val;
1077 return 0;
Alan Stern44ec9542007-02-20 11:01:57 -05001078 case BLKSECTGET:
Akinobu Mita46f69e62014-06-02 22:56:46 +09001079 return put_user(max_sectors_bytes(sdp->device->request_queue),
Alan Stern44ec9542007-02-20 11:01:57 -05001080 ip);
Christof Schmitt6da127a2008-01-11 10:09:43 +01001081 case BLKTRACESETUP:
1082 return blk_trace_setup(sdp->device->request_queue,
1083 sdp->disk->disk_name,
Martin Peschke76e3a192009-01-30 15:46:23 +01001084 MKDEV(SCSI_GENERIC_MAJOR, sdp->index),
Shawn Dud0deef52009-04-14 13:58:56 +08001085 NULL,
Christof Schmitt6da127a2008-01-11 10:09:43 +01001086 (char *)arg);
1087 case BLKTRACESTART:
1088 return blk_trace_startstop(sdp->device->request_queue, 1);
1089 case BLKTRACESTOP:
1090 return blk_trace_startstop(sdp->device->request_queue, 0);
1091 case BLKTRACETEARDOWN:
1092 return blk_trace_remove(sdp->device->request_queue);
Christoph Hellwig906d15f2014-10-11 16:25:31 +02001093 case SCSI_IOCTL_GET_IDLUN:
1094 case SCSI_IOCTL_GET_BUS_NUMBER:
1095 case SCSI_IOCTL_PROBE_HOST:
1096 case SG_GET_TRANSFORM:
1097 case SG_SCSI_RESET:
1098 if (atomic_read(&sdp->detaching))
1099 return -ENODEV;
1100 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101 default:
1102 if (read_only)
1103 return -EPERM; /* don't know so take safe approach */
Christoph Hellwig906d15f2014-10-11 16:25:31 +02001104 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001105 }
Christoph Hellwig906d15f2014-10-11 16:25:31 +02001106
1107 result = scsi_ioctl_block_when_processing_errors(sdp->device,
1108 cmd_in, filp->f_flags & O_NDELAY);
1109 if (result)
1110 return result;
1111 return scsi_ioctl(sdp->device, cmd_in, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112}
1113
1114#ifdef CONFIG_COMPAT
1115static long sg_compat_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
1116{
1117 Sg_device *sdp;
1118 Sg_fd *sfp;
1119 struct scsi_device *sdev;
1120
1121 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1122 return -ENXIO;
1123
1124 sdev = sdp->device;
1125 if (sdev->host->hostt->compat_ioctl) {
1126 int ret;
1127
1128 ret = sdev->host->hostt->compat_ioctl(sdev, cmd_in, (void __user *)arg);
1129
1130 return ret;
1131 }
1132
1133 return -ENOIOCTLCMD;
1134}
1135#endif
1136
1137static unsigned int
1138sg_poll(struct file *filp, poll_table * wait)
1139{
1140 unsigned int res = 0;
1141 Sg_device *sdp;
1142 Sg_fd *sfp;
1143 Sg_request *srp;
1144 int count = 0;
1145 unsigned long iflags;
1146
Jörn Engelebaf4662012-04-12 17:33:39 -04001147 sfp = filp->private_data;
1148 if (!sfp)
1149 return POLLERR;
1150 sdp = sfp->parentdp;
1151 if (!sdp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152 return POLLERR;
1153 poll_wait(filp, &sfp->read_wait, wait);
1154 read_lock_irqsave(&sfp->rq_list_lock, iflags);
1155 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
1156 /* if any read waiting, flag it */
1157 if ((0 == res) && (1 == srp->done) && (!srp->sg_io_owned))
1158 res = POLLIN | POLLRDNORM;
1159 ++count;
1160 }
1161 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1162
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001163 if (atomic_read(&sdp->detaching))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164 res |= POLLHUP;
1165 else if (!sfp->cmd_q) {
1166 if (0 == count)
1167 res |= POLLOUT | POLLWRNORM;
1168 } else if (count < SG_MAX_QUEUE)
1169 res |= POLLOUT | POLLWRNORM;
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001170 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
1171 "sg_poll: res=0x%x\n", (int) res));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172 return res;
1173}
1174
1175static int
1176sg_fasync(int fd, struct file *filp, int mode)
1177{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178 Sg_device *sdp;
1179 Sg_fd *sfp;
1180
1181 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1182 return -ENXIO;
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001183 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
1184 "sg_fasync: mode=%d\n", mode));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001185
Jonathan Corbet60aa4922009-02-01 14:52:56 -07001186 return fasync_helper(fd, filp, mode, &sfp->async_qp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187}
1188
Nick Piggina13ff0b2008-02-07 18:46:06 -08001189static int
1190sg_vma_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191{
1192 Sg_fd *sfp;
Mike Christied6b10342005-11-08 04:06:41 -06001193 unsigned long offset, len, sa;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194 Sg_scatter_hold *rsv_schp;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001195 int k, length;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196
1197 if ((NULL == vma) || (!(sfp = (Sg_fd *) vma->vm_private_data)))
Nick Piggina13ff0b2008-02-07 18:46:06 -08001198 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001199 rsv_schp = &sfp->reserve;
Nick Piggina13ff0b2008-02-07 18:46:06 -08001200 offset = vmf->pgoff << PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201 if (offset >= rsv_schp->bufflen)
Nick Piggina13ff0b2008-02-07 18:46:06 -08001202 return VM_FAULT_SIGBUS;
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001203 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sfp->parentdp,
1204 "sg_vma_fault: offset=%lu, scatg=%d\n",
1205 offset, rsv_schp->k_use_sg));
Mike Christied6b10342005-11-08 04:06:41 -06001206 sa = vma->vm_start;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001207 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1208 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
Mike Christied6b10342005-11-08 04:06:41 -06001209 len = vma->vm_end - sa;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001210 len = (len < length) ? len : length;
Mike Christied6b10342005-11-08 04:06:41 -06001211 if (offset < len) {
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001212 struct page *page = nth_page(rsv_schp->pages[k],
1213 offset >> PAGE_SHIFT);
Mike Christied6b10342005-11-08 04:06:41 -06001214 get_page(page); /* increment page count */
Nick Piggina13ff0b2008-02-07 18:46:06 -08001215 vmf->page = page;
1216 return 0; /* success */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001217 }
Mike Christied6b10342005-11-08 04:06:41 -06001218 sa += len;
1219 offset -= len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220 }
Mike Christied6b10342005-11-08 04:06:41 -06001221
Nick Piggina13ff0b2008-02-07 18:46:06 -08001222 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223}
1224
Alexey Dobriyanf0f37e22009-09-27 22:29:37 +04001225static const struct vm_operations_struct sg_mmap_vm_ops = {
Nick Piggina13ff0b2008-02-07 18:46:06 -08001226 .fault = sg_vma_fault,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001227};
1228
1229static int
1230sg_mmap(struct file *filp, struct vm_area_struct *vma)
1231{
1232 Sg_fd *sfp;
Mike Christied6b10342005-11-08 04:06:41 -06001233 unsigned long req_sz, len, sa;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234 Sg_scatter_hold *rsv_schp;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001235 int k, length;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236
1237 if ((!filp) || (!vma) || (!(sfp = (Sg_fd *) filp->private_data)))
1238 return -ENXIO;
cb59e842005-04-02 13:51:23 -06001239 req_sz = vma->vm_end - vma->vm_start;
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001240 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sfp->parentdp,
1241 "sg_mmap starting, vm_start=%p, len=%d\n",
1242 (void *) vma->vm_start, (int) req_sz));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001243 if (vma->vm_pgoff)
1244 return -EINVAL; /* want no offset */
1245 rsv_schp = &sfp->reserve;
1246 if (req_sz > rsv_schp->bufflen)
1247 return -ENOMEM; /* cannot map more than reserved buffer */
1248
Mike Christied6b10342005-11-08 04:06:41 -06001249 sa = vma->vm_start;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001250 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1251 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
Mike Christied6b10342005-11-08 04:06:41 -06001252 len = vma->vm_end - sa;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001253 len = (len < length) ? len : length;
Mike Christied6b10342005-11-08 04:06:41 -06001254 sa += len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255 }
Mike Christied6b10342005-11-08 04:06:41 -06001256
Nick Pigginf9aed0e2006-03-22 00:08:30 -08001257 sfp->mmap_called = 1;
Konstantin Khlebnikov314e51b2012-10-08 16:29:02 -07001258 vma->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001259 vma->vm_private_data = sfp;
1260 vma->vm_ops = &sg_mmap_vm_ops;
1261 return 0;
1262}
1263
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001264static void
1265sg_rq_end_io_usercontext(struct work_struct *work)
FUJITA Tomonoric96952e2009-02-04 11:36:27 +09001266{
1267 struct sg_request *srp = container_of(work, struct sg_request, ew.work);
1268 struct sg_fd *sfp = srp->parentfp;
1269
1270 sg_finish_rem_req(srp);
1271 kref_put(&sfp->f_ref, sg_remove_sfp);
1272}
1273
FUJITA Tomonoria91a3a22008-09-02 22:50:01 +09001274/*
1275 * This function is a "bottom half" handler that is called by the mid
1276 * level when a command is completed (or has failed).
1277 */
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001278static void
1279sg_rq_end_io(struct request *rq, int uptodate)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280{
FUJITA Tomonoria91a3a22008-09-02 22:50:01 +09001281 struct sg_request *srp = rq->end_io_data;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001282 Sg_device *sdp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283 Sg_fd *sfp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284 unsigned long iflags;
cb59e842005-04-02 13:51:23 -06001285 unsigned int ms;
FUJITA Tomonoria91a3a22008-09-02 22:50:01 +09001286 char *sense;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001287 int result, resid, done = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288
Tony Battersbyc6517b792009-01-21 14:45:50 -05001289 if (WARN_ON(srp->done != 0))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290 return;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001291
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292 sfp = srp->parentfp;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001293 if (WARN_ON(sfp == NULL))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294 return;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001295
1296 sdp = sfp->parentdp;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001297 if (unlikely(atomic_read(&sdp->detaching)))
1298 pr_info("%s: device detaching\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299
FUJITA Tomonoria91a3a22008-09-02 22:50:01 +09001300 sense = rq->sense;
1301 result = rq->errors;
Tejun Heoc3a4d782009-05-07 22:24:37 +09001302 resid = rq->resid_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001304 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sdp,
1305 "sg_cmd_done: pack_id=%d, res=0x%x\n",
1306 srp->header.pack_id, result));
Mike Christied6b10342005-11-08 04:06:41 -06001307 srp->header.resid = resid;
cb59e842005-04-02 13:51:23 -06001308 ms = jiffies_to_msecs(jiffies);
1309 srp->header.duration = (ms > srp->header.duration) ?
1310 (ms - srp->header.duration) : 0;
Mike Christied6b10342005-11-08 04:06:41 -06001311 if (0 != result) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312 struct scsi_sense_hdr sshdr;
1313
Mike Christied6b10342005-11-08 04:06:41 -06001314 srp->header.status = 0xff & result;
1315 srp->header.masked_status = status_byte(result);
1316 srp->header.msg_status = msg_byte(result);
1317 srp->header.host_status = host_byte(result);
1318 srp->header.driver_status = driver_byte(result);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319 if ((sdp->sgdebug > 0) &&
1320 ((CHECK_CONDITION == srp->header.masked_status) ||
1321 (COMMAND_TERMINATED == srp->header.masked_status)))
Hannes Reinecked811b842014-10-24 14:26:45 +02001322 __scsi_print_sense(sdp->device, __func__, sense,
Mike Christied6b10342005-11-08 04:06:41 -06001323 SCSI_SENSE_BUFFERSIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324
1325 /* Following if statement is a patch supplied by Eric Youngdale */
Mike Christied6b10342005-11-08 04:06:41 -06001326 if (driver_byte(result) != 0
1327 && scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, &sshdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328 && !scsi_sense_is_deferred(&sshdr)
1329 && sshdr.sense_key == UNIT_ATTENTION
1330 && sdp->device->removable) {
1331 /* Detected possible disc change. Set the bit - this */
1332 /* may be used if there are filesystems using this device */
1333 sdp->device->changed = 1;
1334 }
1335 }
1336 /* Rely on write phase to clean out srp status values, so no "else" */
1337
Tony Battersby75686152015-02-13 12:09:44 -05001338 /*
1339 * Free the request as soon as it is complete so that its resources
1340 * can be reused without waiting for userspace to read() the
1341 * result. But keep the associated bio (if any) around until
1342 * blk_rq_unmap_user() can be called from user context.
1343 */
1344 srp->rq = NULL;
1345 if (rq->cmd != rq->__cmd)
1346 kfree(rq->cmd);
1347 __blk_put_request(rq->q, rq);
1348
Tony Battersbyc6517b792009-01-21 14:45:50 -05001349 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1350 if (unlikely(srp->orphan)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351 if (sfp->keep_orphan)
1352 srp->sg_io_owned = 0;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001353 else
1354 done = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355 }
Tony Battersbyc6517b792009-01-21 14:45:50 -05001356 srp->done = done;
1357 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1358
1359 if (likely(done)) {
1360 /* Now wake up any sg_read() that is waiting for this
1361 * packet.
1362 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363 wake_up_interruptible(&sfp->read_wait);
Tony Battersbyc6517b792009-01-21 14:45:50 -05001364 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_IN);
FUJITA Tomonoric96952e2009-02-04 11:36:27 +09001365 kref_put(&sfp->f_ref, sg_remove_sfp);
FUJITA Tomonori015640e2009-04-03 19:28:06 +09001366 } else {
1367 INIT_WORK(&srp->ew.work, sg_rq_end_io_usercontext);
1368 schedule_work(&srp->ew.work);
1369 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370}
1371
Alexey Dobriyan828c0952009-10-01 15:43:56 -07001372static const struct file_operations sg_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373 .owner = THIS_MODULE,
1374 .read = sg_read,
1375 .write = sg_write,
1376 .poll = sg_poll,
Jörn Engel37b9d1e2012-04-12 17:35:05 -04001377 .unlocked_ioctl = sg_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378#ifdef CONFIG_COMPAT
1379 .compat_ioctl = sg_compat_ioctl,
1380#endif
1381 .open = sg_open,
1382 .mmap = sg_mmap,
1383 .release = sg_release,
1384 .fasync = sg_fasync,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001385 .llseek = no_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386};
1387
gregkh@suse.ded2538782005-03-23 09:55:22 -08001388static struct class *sg_sysfs_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389
1390static int sg_sysfs_valid = 0;
1391
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001392static Sg_device *
1393sg_alloc(struct gendisk *disk, struct scsi_device *scsidp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001394{
Mike Christied6b10342005-11-08 04:06:41 -06001395 struct request_queue *q = scsidp->request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001396 Sg_device *sdp;
1397 unsigned long iflags;
James Bottomley7c07d612007-08-05 13:36:11 -05001398 int error;
1399 u32 k;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400
Jes Sorensen24669f752006-01-16 10:31:18 -05001401 sdp = kzalloc(sizeof(Sg_device), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402 if (!sdp) {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001403 sdev_printk(KERN_WARNING, scsidp, "%s: kmalloc Sg_device "
1404 "failure\n", __func__);
James Bottomley7c07d612007-08-05 13:36:11 -05001405 return ERR_PTR(-ENOMEM);
1406 }
Tony Battersbyc6517b792009-01-21 14:45:50 -05001407
Tejun Heob98c52b2013-02-27 17:04:42 -08001408 idr_preload(GFP_KERNEL);
James Bottomley7c07d612007-08-05 13:36:11 -05001409 write_lock_irqsave(&sg_index_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410
Tejun Heob98c52b2013-02-27 17:04:42 -08001411 error = idr_alloc(&sg_index_idr, sdp, 0, SG_MAX_DEVS, GFP_NOWAIT);
1412 if (error < 0) {
1413 if (error == -ENOSPC) {
1414 sdev_printk(KERN_WARNING, scsidp,
1415 "Unable to attach sg device type=%d, minor number exceeds %d\n",
1416 scsidp->type, SG_MAX_DEVS - 1);
1417 error = -ENODEV;
1418 } else {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001419 sdev_printk(KERN_WARNING, scsidp, "%s: idr "
1420 "allocation Sg_device failure: %d\n",
1421 __func__, error);
Tejun Heob98c52b2013-02-27 17:04:42 -08001422 }
1423 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424 }
Tejun Heob98c52b2013-02-27 17:04:42 -08001425 k = error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001427 SCSI_LOG_TIMEOUT(3, sdev_printk(KERN_INFO, scsidp,
1428 "sg_alloc: dev=%d \n", k));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429 sprintf(disk->disk_name, "sg%d", k);
1430 disk->first_minor = k;
1431 sdp->disk = disk;
1432 sdp->device = scsidp;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001433 mutex_init(&sdp->open_rel_lock);
FUJITA Tomonori3442f802009-02-16 13:26:53 +09001434 INIT_LIST_HEAD(&sdp->sfds);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001435 init_waitqueue_head(&sdp->open_wait);
1436 atomic_set(&sdp->detaching, 0);
1437 rwlock_init(&sdp->sfd_lock);
Martin K. Petersen8a783622010-02-26 00:20:39 -05001438 sdp->sg_tablesize = queue_max_segments(q);
James Bottomley7c07d612007-08-05 13:36:11 -05001439 sdp->index = k;
Tony Battersbyc6517b792009-01-21 14:45:50 -05001440 kref_init(&sdp->d_ref);
James Bottomley7c07d612007-08-05 13:36:11 -05001441 error = 0;
Tejun Heob98c52b2013-02-27 17:04:42 -08001442
1443out_unlock:
1444 write_unlock_irqrestore(&sg_index_lock, iflags);
1445 idr_preload_end();
1446
James Bottomley7c07d612007-08-05 13:36:11 -05001447 if (error) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448 kfree(sdp);
James Bottomley7c07d612007-08-05 13:36:11 -05001449 return ERR_PTR(error);
1450 }
1451 return sdp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452}
1453
1454static int
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001455sg_add_device(struct device *cl_dev, struct class_interface *cl_intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456{
Tony Jonesee959b02008-02-22 00:13:36 +01001457 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458 struct gendisk *disk;
1459 Sg_device *sdp = NULL;
1460 struct cdev * cdev = NULL;
James Bottomley7c07d612007-08-05 13:36:11 -05001461 int error;
Ishai Rabinovitz454e8952006-06-29 16:39:54 +03001462 unsigned long iflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463
1464 disk = alloc_disk(1);
1465 if (!disk) {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001466 pr_warn("%s: alloc_disk failed\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467 return -ENOMEM;
1468 }
1469 disk->major = SCSI_GENERIC_MAJOR;
1470
1471 error = -ENOMEM;
1472 cdev = cdev_alloc();
1473 if (!cdev) {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001474 pr_warn("%s: cdev_alloc failed\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001475 goto out;
1476 }
1477 cdev->owner = THIS_MODULE;
1478 cdev->ops = &sg_fops;
1479
James Bottomley7c07d612007-08-05 13:36:11 -05001480 sdp = sg_alloc(disk, scsidp);
1481 if (IS_ERR(sdp)) {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001482 pr_warn("%s: sg_alloc failed\n", __func__);
James Bottomley7c07d612007-08-05 13:36:11 -05001483 error = PTR_ERR(sdp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484 goto out;
1485 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486
James Bottomley7c07d612007-08-05 13:36:11 -05001487 error = cdev_add(cdev, MKDEV(SCSI_GENERIC_MAJOR, sdp->index), 1);
Greg KH5e3c34c2006-01-18 16:17:46 -08001488 if (error)
Ishai Rabinovitz454e8952006-06-29 16:39:54 +03001489 goto cdev_add_err;
Greg KH5e3c34c2006-01-18 16:17:46 -08001490
Linus Torvalds1da177e2005-04-16 15:20:36 -07001491 sdp->cdev = cdev;
1492 if (sg_sysfs_valid) {
Tony Jonesee959b02008-02-22 00:13:36 +01001493 struct device *sg_class_member;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494
Greg Kroah-Hartmand73a1a672008-07-21 20:03:34 -07001495 sg_class_member = device_create(sg_sysfs_class, cl_dev->parent,
1496 MKDEV(SCSI_GENERIC_MAJOR,
1497 sdp->index),
1498 sdp, "%s", disk->disk_name);
FUJITA Tomonorid07e0362008-01-15 13:18:00 +09001499 if (IS_ERR(sg_class_member)) {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001500 pr_err("%s: device_create failed\n", __func__);
FUJITA Tomonorid07e0362008-01-15 13:18:00 +09001501 error = PTR_ERR(sg_class_member);
1502 goto cdev_add_err;
1503 }
FUJITA Tomonorid07e0362008-01-15 13:18:00 +09001504 error = sysfs_create_link(&scsidp->sdev_gendev.kobj,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001505 &sg_class_member->kobj, "generic");
1506 if (error)
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001507 pr_err("%s: unable to make symlink 'generic' back "
1508 "to sg%d\n", __func__, sdp->index);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509 } else
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001510 pr_warn("%s: sg_sys Invalid\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001512 sdev_printk(KERN_NOTICE, scsidp, "Attached scsi generic sg%d "
1513 "type %d\n", sdp->index, scsidp->type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514
Tony Jonesee959b02008-02-22 00:13:36 +01001515 dev_set_drvdata(cl_dev, sdp);
FUJITA Tomonoria24484f2008-01-15 13:17:47 +09001516
Linus Torvalds1da177e2005-04-16 15:20:36 -07001517 return 0;
1518
Ishai Rabinovitz454e8952006-06-29 16:39:54 +03001519cdev_add_err:
James Bottomley7c07d612007-08-05 13:36:11 -05001520 write_lock_irqsave(&sg_index_lock, iflags);
1521 idr_remove(&sg_index_idr, sdp->index);
1522 write_unlock_irqrestore(&sg_index_lock, iflags);
1523 kfree(sdp);
Ishai Rabinovitz454e8952006-06-29 16:39:54 +03001524
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525out:
1526 put_disk(disk);
1527 if (cdev)
1528 cdev_del(cdev);
1529 return error;
1530}
1531
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001532static void
1533sg_device_destroy(struct kref *kref)
Tony Battersbyc6517b792009-01-21 14:45:50 -05001534{
1535 struct sg_device *sdp = container_of(kref, struct sg_device, d_ref);
1536 unsigned long flags;
1537
1538 /* CAUTION! Note that the device can still be found via idr_find()
1539 * even though the refcount is 0. Therefore, do idr_remove() BEFORE
1540 * any other cleanup.
1541 */
1542
1543 write_lock_irqsave(&sg_index_lock, flags);
1544 idr_remove(&sg_index_idr, sdp->index);
1545 write_unlock_irqrestore(&sg_index_lock, flags);
1546
1547 SCSI_LOG_TIMEOUT(3,
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001548 sg_printk(KERN_INFO, sdp, "sg_device_destroy\n"));
Tony Battersbyc6517b792009-01-21 14:45:50 -05001549
1550 put_disk(sdp->disk);
1551 kfree(sdp);
1552}
1553
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001554static void
1555sg_remove_device(struct device *cl_dev, struct class_interface *cl_intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556{
Tony Jonesee959b02008-02-22 00:13:36 +01001557 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
1558 Sg_device *sdp = dev_get_drvdata(cl_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559 unsigned long iflags;
1560 Sg_fd *sfp;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001561 int val;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001563 if (!sdp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564 return;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001565 /* want sdp->detaching non-zero as soon as possible */
1566 val = atomic_inc_return(&sdp->detaching);
1567 if (val > 1)
1568 return; /* only want to do following once per device */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001570 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
1571 "%s\n", __func__));
Tony Battersbyc6517b792009-01-21 14:45:50 -05001572
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001573 read_lock_irqsave(&sdp->sfd_lock, iflags);
FUJITA Tomonori3442f802009-02-16 13:26:53 +09001574 list_for_each_entry(sfp, &sdp->sfds, sfd_siblings) {
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001575 wake_up_interruptible_all(&sfp->read_wait);
Tony Battersbyc6517b792009-01-21 14:45:50 -05001576 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_HUP);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001577 }
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001578 wake_up_interruptible_all(&sdp->open_wait);
1579 read_unlock_irqrestore(&sdp->sfd_lock, iflags);
James Bottomley7c07d612007-08-05 13:36:11 -05001580
1581 sysfs_remove_link(&scsidp->sdev_gendev.kobj, "generic");
Tony Jonesee959b02008-02-22 00:13:36 +01001582 device_destroy(sg_sysfs_class, MKDEV(SCSI_GENERIC_MAJOR, sdp->index));
James Bottomley7c07d612007-08-05 13:36:11 -05001583 cdev_del(sdp->cdev);
1584 sdp->cdev = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001586 kref_put(&sdp->d_ref, sg_device_destroy);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587}
1588
Douglas Gilbert6460e752006-09-20 18:20:49 -04001589module_param_named(scatter_elem_sz, scatter_elem_sz, int, S_IRUGO | S_IWUSR);
1590module_param_named(def_reserved_size, def_reserved_size, int,
1591 S_IRUGO | S_IWUSR);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592module_param_named(allow_dio, sg_allow_dio, int, S_IRUGO | S_IWUSR);
1593
1594MODULE_AUTHOR("Douglas Gilbert");
1595MODULE_DESCRIPTION("SCSI generic (sg) driver");
1596MODULE_LICENSE("GPL");
1597MODULE_VERSION(SG_VERSION_STR);
Rene Hermanf018fa52006-03-08 00:14:20 -08001598MODULE_ALIAS_CHARDEV_MAJOR(SCSI_GENERIC_MAJOR);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599
Douglas Gilbert6460e752006-09-20 18:20:49 -04001600MODULE_PARM_DESC(scatter_elem_sz, "scatter gather element "
1601 "size (default: max(SG_SCATTER_SZ, PAGE_SIZE))");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001602MODULE_PARM_DESC(def_reserved_size, "size of buffer reserved for each fd");
1603MODULE_PARM_DESC(allow_dio, "allow direct I/O (default: 0 (disallow))");
1604
1605static int __init
1606init_sg(void)
1607{
1608 int rc;
1609
Douglas Gilbert6460e752006-09-20 18:20:49 -04001610 if (scatter_elem_sz < PAGE_SIZE) {
1611 scatter_elem_sz = PAGE_SIZE;
1612 scatter_elem_sz_prev = scatter_elem_sz;
1613 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614 if (def_reserved_size >= 0)
1615 sg_big_buff = def_reserved_size;
Douglas Gilbert6460e752006-09-20 18:20:49 -04001616 else
1617 def_reserved_size = sg_big_buff;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618
1619 rc = register_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1620 SG_MAX_DEVS, "sg");
1621 if (rc)
1622 return rc;
gregkh@suse.ded2538782005-03-23 09:55:22 -08001623 sg_sysfs_class = class_create(THIS_MODULE, "scsi_generic");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624 if ( IS_ERR(sg_sysfs_class) ) {
1625 rc = PTR_ERR(sg_sysfs_class);
1626 goto err_out;
1627 }
1628 sg_sysfs_valid = 1;
1629 rc = scsi_register_interface(&sg_interface);
1630 if (0 == rc) {
1631#ifdef CONFIG_SCSI_PROC_FS
1632 sg_proc_init();
1633#endif /* CONFIG_SCSI_PROC_FS */
1634 return 0;
1635 }
gregkh@suse.ded2538782005-03-23 09:55:22 -08001636 class_destroy(sg_sysfs_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001637err_out:
1638 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0), SG_MAX_DEVS);
1639 return rc;
1640}
1641
1642static void __exit
1643exit_sg(void)
1644{
1645#ifdef CONFIG_SCSI_PROC_FS
1646 sg_proc_cleanup();
1647#endif /* CONFIG_SCSI_PROC_FS */
1648 scsi_unregister_interface(&sg_interface);
gregkh@suse.ded2538782005-03-23 09:55:22 -08001649 class_destroy(sg_sysfs_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650 sg_sysfs_valid = 0;
1651 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1652 SG_MAX_DEVS);
James Bottomley7c07d612007-08-05 13:36:11 -05001653 idr_destroy(&sg_index_idr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654}
1655
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001656static int
1657sg_start_req(Sg_request *srp, unsigned char *cmd)
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001658{
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001659 int res;
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001660 struct request *rq;
FUJITA Tomonori44c7b0e2008-09-02 22:50:04 +09001661 Sg_fd *sfp = srp->parentfp;
1662 sg_io_hdr_t *hp = &srp->header;
1663 int dxfer_len = (int) hp->dxfer_len;
1664 int dxfer_dir = hp->dxfer_direction;
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001665 unsigned int iov_count = hp->iovec_count;
FUJITA Tomonori44c7b0e2008-09-02 22:50:04 +09001666 Sg_scatter_hold *req_schp = &srp->data;
1667 Sg_scatter_hold *rsv_schp = &sfp->reserve;
1668 struct request_queue *q = sfp->parentdp->device->request_queue;
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001669 struct rq_map_data *md, map_data;
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001670 int rw = hp->dxfer_direction == SG_DXFER_TO_DEV ? WRITE : READ;
Douglas Gilbert65c26a02014-06-03 13:18:18 -04001671 unsigned char *long_cmdp = NULL;
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001672
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001673 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1674 "sg_start_req: dxfer_len=%d\n",
1675 dxfer_len));
FUJITA Tomonori44c7b0e2008-09-02 22:50:04 +09001676
Douglas Gilbert65c26a02014-06-03 13:18:18 -04001677 if (hp->cmd_len > BLK_MAX_CDB) {
1678 long_cmdp = kzalloc(hp->cmd_len, GFP_KERNEL);
1679 if (!long_cmdp)
1680 return -ENOMEM;
1681 }
1682
Tony Battersby7772855a2015-02-13 12:10:58 -05001683 /*
1684 * NOTE
1685 *
1686 * With scsi-mq enabled, there are a fixed number of preallocated
1687 * requests equal in number to shost->can_queue. If all of the
1688 * preallocated requests are already in use, then using GFP_ATOMIC with
1689 * blk_get_request() will return -EWOULDBLOCK, whereas using GFP_KERNEL
1690 * will cause blk_get_request() to sleep until an active command
1691 * completes, freeing up a request. Neither option is ideal, but
1692 * GFP_KERNEL is the better choice to prevent userspace from getting an
1693 * unexpected EWOULDBLOCK.
1694 *
1695 * With scsi-mq disabled, blk_get_request() with GFP_KERNEL usually
1696 * does not sleep except under memory pressure.
1697 */
1698 rq = blk_get_request(q, rw, GFP_KERNEL);
Joe Lawrencea492f072014-08-28 08:15:21 -06001699 if (IS_ERR(rq)) {
Douglas Gilbert65c26a02014-06-03 13:18:18 -04001700 kfree(long_cmdp);
Joe Lawrencea492f072014-08-28 08:15:21 -06001701 return PTR_ERR(rq);
Douglas Gilbert65c26a02014-06-03 13:18:18 -04001702 }
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001703
Jens Axboef27b0872014-06-06 07:57:37 -06001704 blk_rq_set_block_pc(rq);
Douglas Gilbert65c26a02014-06-03 13:18:18 -04001705
1706 if (hp->cmd_len > BLK_MAX_CDB)
1707 rq->cmd = long_cmdp;
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001708 memcpy(rq->cmd, cmd, hp->cmd_len);
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001709 rq->cmd_len = hp->cmd_len;
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001710
1711 srp->rq = rq;
1712 rq->end_io_data = srp;
1713 rq->sense = srp->sense_b;
1714 rq->retries = SG_DEFAULT_RETRIES;
1715
Linus Torvalds1da177e2005-04-16 15:20:36 -07001716 if ((dxfer_len <= 0) || (dxfer_dir == SG_DXFER_NONE))
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001717 return 0;
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001718
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001719 if (sg_allow_dio && hp->flags & SG_FLAG_DIRECT_IO &&
1720 dxfer_dir != SG_DXFER_UNKNOWN && !iov_count &&
1721 !sfp->parentdp->device->host->unchecked_isa_dma &&
Namhyung Kim2610a252010-09-16 12:55:57 +09001722 blk_rq_aligned(q, (unsigned long)hp->dxferp, dxfer_len))
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001723 md = NULL;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001724 else
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001725 md = &map_data;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001726
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001727 if (md) {
1728 if (!sg_res_in_use(sfp) && dxfer_len <= rsv_schp->bufflen)
1729 sg_link_reserve(sfp, srp, dxfer_len);
1730 else {
1731 res = sg_build_indirect(req_schp, sfp, dxfer_len);
1732 if (res)
1733 return res;
1734 }
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001735
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001736 md->pages = req_schp->pages;
1737 md->page_order = req_schp->page_order;
1738 md->nr_entries = req_schp->k_use_sg;
FUJITA Tomonori56c451f2008-12-18 14:49:37 +09001739 md->offset = 0;
FUJITA Tomonori97ae77a2008-12-18 14:49:38 +09001740 md->null_mapped = hp->dxferp ? 0 : 1;
FUJITA Tomonoriecb554a2009-07-09 14:46:53 +02001741 if (dxfer_dir == SG_DXFER_TO_FROM_DEV)
1742 md->from_user = 1;
1743 else
1744 md->from_user = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745 }
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001746
FUJITA Tomonori0fdf96b2009-04-03 09:12:20 +09001747 if (iov_count) {
Al Virofdc81f42015-03-21 20:25:30 -04001748 struct iovec *iov = NULL;
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001749 struct iov_iter i;
FUJITA Tomonori0fdf96b2009-04-03 09:12:20 +09001750
Al Virofdc81f42015-03-21 20:25:30 -04001751 res = import_iovec(rw, hp->dxferp, iov_count, 0, &iov, &i);
1752 if (res < 0)
1753 return res;
FUJITA Tomonori0fdf96b2009-04-03 09:12:20 +09001754
Al Virofdc81f42015-03-21 20:25:30 -04001755 iov_iter_truncate(&i, hp->dxfer_len);
FUJITA Tomonori0fdf96b2009-04-03 09:12:20 +09001756
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001757 res = blk_rq_map_user_iov(q, rq, md, &i, GFP_ATOMIC);
FUJITA Tomonori0fdf96b2009-04-03 09:12:20 +09001758 kfree(iov);
1759 } else
FUJITA Tomonori626710c2008-09-02 22:50:05 +09001760 res = blk_rq_map_user(q, rq, md, hp->dxferp,
1761 hp->dxfer_len, GFP_ATOMIC);
1762
1763 if (!res) {
1764 srp->bio = rq->bio;
1765
1766 if (!md) {
1767 req_schp->dio_in_use = 1;
1768 hp->info |= SG_INFO_DIRECT_IO;
1769 }
1770 }
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001771 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772}
1773
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02001774static int
1775sg_finish_rem_req(Sg_request *srp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001776{
FUJITA Tomonorie7ee4cc2009-04-04 00:35:42 +09001777 int ret = 0;
1778
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779 Sg_fd *sfp = srp->parentfp;
1780 Sg_scatter_hold *req_schp = &srp->data;
1781
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001782 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1783 "sg_finish_rem_req: res_used=%d\n",
1784 (int) srp->res_used));
Tony Battersby75686152015-02-13 12:09:44 -05001785 if (srp->bio)
1786 ret = blk_rq_unmap_user(srp->bio);
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001787
Tony Battersby75686152015-02-13 12:09:44 -05001788 if (srp->rq) {
Douglas Gilbert65c26a02014-06-03 13:18:18 -04001789 if (srp->rq->cmd != srp->rq->__cmd)
1790 kfree(srp->rq->cmd);
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001791 blk_put_request(srp->rq);
FUJITA Tomonori6e5a30c2008-08-28 16:17:08 +09001792 }
FUJITA Tomonori10865df2008-08-28 16:17:07 +09001793
Christof Schmitte27168f2009-09-17 09:10:14 +02001794 if (srp->res_used)
1795 sg_unlink_reserve(sfp, srp);
1796 else
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001797 sg_remove_scat(sfp, req_schp);
Christof Schmitte27168f2009-09-17 09:10:14 +02001798
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799 sg_remove_request(sfp, srp);
FUJITA Tomonorie7ee4cc2009-04-04 00:35:42 +09001800
1801 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802}
1803
1804static int
1805sg_build_sgat(Sg_scatter_hold * schp, const Sg_fd * sfp, int tablesize)
1806{
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001807 int sg_bufflen = tablesize * sizeof(struct page *);
Al Viro2d20eaf2006-02-01 06:31:40 -05001808 gfp_t gfp_flags = GFP_ATOMIC | __GFP_NOWARN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001809
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001810 schp->pages = kzalloc(sg_bufflen, gfp_flags);
1811 if (!schp->pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001813 schp->sglist_len = sg_bufflen;
Mike Christied6b10342005-11-08 04:06:41 -06001814 return tablesize; /* number of scat_gath elements allocated */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001815}
1816
Linus Torvalds1da177e2005-04-16 15:20:36 -07001817static int
1818sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size)
1819{
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001820 int ret_sz = 0, i, k, rem_sz, num, mx_sc_elems;
Mike Christied6b10342005-11-08 04:06:41 -06001821 int sg_tablesize = sfp->parentdp->sg_tablesize;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001822 int blk_size = buff_size, order;
1823 gfp_t gfp_mask = GFP_ATOMIC | __GFP_COMP | __GFP_NOWARN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824
Eric Sesterhennfb119932007-05-23 14:41:36 -07001825 if (blk_size < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826 return -EFAULT;
1827 if (0 == blk_size)
1828 ++blk_size; /* don't know why */
FUJITA Tomonorib2ed6c62009-02-12 02:42:57 +09001829 /* round request up to next highest SG_SECTOR_SZ byte boundary */
1830 blk_size = ALIGN(blk_size, SG_SECTOR_SZ);
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001831 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1832 "sg_build_indirect: buff_size=%d, blk_size=%d\n",
1833 buff_size, blk_size));
Mike Christied6b10342005-11-08 04:06:41 -06001834
1835 /* N.B. ret_sz carried into this block ... */
1836 mx_sc_elems = sg_build_sgat(schp, sfp, sg_tablesize);
1837 if (mx_sc_elems < 0)
1838 return mx_sc_elems; /* most likely -ENOMEM */
1839
Douglas Gilbert6460e752006-09-20 18:20:49 -04001840 num = scatter_elem_sz;
1841 if (unlikely(num != scatter_elem_sz_prev)) {
1842 if (num < PAGE_SIZE) {
1843 scatter_elem_sz = PAGE_SIZE;
1844 scatter_elem_sz_prev = PAGE_SIZE;
1845 } else
1846 scatter_elem_sz_prev = num;
1847 }
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001848
1849 if (sfp->low_dma)
1850 gfp_mask |= GFP_DMA;
1851
1852 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
1853 gfp_mask |= __GFP_ZERO;
1854
1855 order = get_order(num);
1856retry:
1857 ret_sz = 1 << (PAGE_SHIFT + order);
1858
1859 for (k = 0, rem_sz = blk_size; rem_sz > 0 && k < mx_sc_elems;
1860 k++, rem_sz -= ret_sz) {
1861
Douglas Gilbert6460e752006-09-20 18:20:49 -04001862 num = (rem_sz > scatter_elem_sz_prev) ?
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001863 scatter_elem_sz_prev : rem_sz;
1864
1865 schp->pages[k] = alloc_pages(gfp_mask, order);
1866 if (!schp->pages[k])
1867 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868
Douglas Gilbert6460e752006-09-20 18:20:49 -04001869 if (num == scatter_elem_sz_prev) {
1870 if (unlikely(ret_sz > scatter_elem_sz_prev)) {
1871 scatter_elem_sz = ret_sz;
1872 scatter_elem_sz_prev = ret_sz;
1873 }
1874 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001875
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001876 SCSI_LOG_TIMEOUT(5, sg_printk(KERN_INFO, sfp->parentdp,
1877 "sg_build_indirect: k=%d, num=%d, ret_sz=%d\n",
1878 k, num, ret_sz));
Mike Christied6b10342005-11-08 04:06:41 -06001879 } /* end of for loop */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001880
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001881 schp->page_order = order;
Mike Christied6b10342005-11-08 04:06:41 -06001882 schp->k_use_sg = k;
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001883 SCSI_LOG_TIMEOUT(5, sg_printk(KERN_INFO, sfp->parentdp,
1884 "sg_build_indirect: k_use_sg=%d, rem_sz=%d\n",
1885 k, rem_sz));
Mike Christied6b10342005-11-08 04:06:41 -06001886
1887 schp->bufflen = blk_size;
1888 if (rem_sz > 0) /* must have failed */
1889 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001890 return 0;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001891out:
1892 for (i = 0; i < k; i++)
Michal Schmidte71044e2009-09-03 14:27:08 +02001893 __free_pages(schp->pages[i], order);
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001894
1895 if (--order >= 0)
1896 goto retry;
1897
1898 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001899}
1900
Linus Torvalds1da177e2005-04-16 15:20:36 -07001901static void
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001902sg_remove_scat(Sg_fd * sfp, Sg_scatter_hold * schp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001903{
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001904 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1905 "sg_remove_scat: k_use_sg=%d\n", schp->k_use_sg));
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001906 if (schp->pages && schp->sglist_len > 0) {
FUJITA Tomonori6e5a30c2008-08-28 16:17:08 +09001907 if (!schp->dio_in_use) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001908 int k;
1909
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001910 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001911 SCSI_LOG_TIMEOUT(5,
1912 sg_printk(KERN_INFO, sfp->parentdp,
1913 "sg_remove_scat: k=%d, pg=0x%p\n",
1914 k, schp->pages[k]));
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001915 __free_pages(schp->pages[k], schp->page_order);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001916 }
FUJITA Tomonori6e5a30c2008-08-28 16:17:08 +09001917
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001918 kfree(schp->pages);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919 }
Mike Christied6b10342005-11-08 04:06:41 -06001920 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001921 memset(schp, 0, sizeof (*schp));
1922}
1923
1924static int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001925sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer)
1926{
1927 Sg_scatter_hold *schp = &srp->data;
Mike Christied6b10342005-11-08 04:06:41 -06001928 int k, num;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001930 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, srp->parentfp->parentdp,
1931 "sg_read_oxfer: num_read_xfer=%d\n",
1932 num_read_xfer));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001933 if ((!outp) || (num_read_xfer <= 0))
1934 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001936 num = 1 << (PAGE_SHIFT + schp->page_order);
1937 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
Mike Christied6b10342005-11-08 04:06:41 -06001938 if (num > num_read_xfer) {
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001939 if (__copy_to_user(outp, page_address(schp->pages[k]),
Mike Christied6b10342005-11-08 04:06:41 -06001940 num_read_xfer))
1941 return -EFAULT;
1942 break;
1943 } else {
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001944 if (__copy_to_user(outp, page_address(schp->pages[k]),
Mike Christied6b10342005-11-08 04:06:41 -06001945 num))
1946 return -EFAULT;
1947 num_read_xfer -= num;
1948 if (num_read_xfer <= 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001949 break;
Mike Christied6b10342005-11-08 04:06:41 -06001950 outp += num;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001951 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952 }
Mike Christied6b10342005-11-08 04:06:41 -06001953
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954 return 0;
1955}
1956
1957static void
1958sg_build_reserve(Sg_fd * sfp, int req_size)
1959{
1960 Sg_scatter_hold *schp = &sfp->reserve;
1961
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001962 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1963 "sg_build_reserve: req_size=%d\n", req_size));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001964 do {
1965 if (req_size < PAGE_SIZE)
1966 req_size = PAGE_SIZE;
1967 if (0 == sg_build_indirect(schp, sfp, req_size))
1968 return;
1969 else
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001970 sg_remove_scat(sfp, schp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001971 req_size >>= 1; /* divide by 2 */
1972 } while (req_size > (PAGE_SIZE / 2));
1973}
1974
1975static void
1976sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size)
1977{
1978 Sg_scatter_hold *req_schp = &srp->data;
1979 Sg_scatter_hold *rsv_schp = &sfp->reserve;
Mike Christied6b10342005-11-08 04:06:41 -06001980 int k, num, rem;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001981
1982 srp->res_used = 1;
Hannes Reinecke95e159d2014-06-25 16:39:55 +02001983 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1984 "sg_link_reserve: size=%d\n", size));
Brian Kingeca7be52006-02-14 12:42:24 -06001985 rem = size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001986
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001987 num = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1988 for (k = 0; k < rsv_schp->k_use_sg; k++) {
Mike Christied6b10342005-11-08 04:06:41 -06001989 if (rem <= num) {
Mike Christied6b10342005-11-08 04:06:41 -06001990 req_schp->k_use_sg = k + 1;
1991 req_schp->sglist_len = rsv_schp->sglist_len;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001992 req_schp->pages = rsv_schp->pages;
Mike Christied6b10342005-11-08 04:06:41 -06001993
1994 req_schp->bufflen = size;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02001995 req_schp->page_order = rsv_schp->page_order;
Mike Christied6b10342005-11-08 04:06:41 -06001996 break;
1997 } else
1998 rem -= num;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001999 }
Mike Christied6b10342005-11-08 04:06:41 -06002000
2001 if (k >= rsv_schp->k_use_sg)
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002002 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO, sfp->parentdp,
2003 "sg_link_reserve: BAD size\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002004}
2005
2006static void
2007sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp)
2008{
2009 Sg_scatter_hold *req_schp = &srp->data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002010
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002011 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, srp->parentfp->parentdp,
2012 "sg_unlink_reserve: req->k_use_sg=%d\n",
2013 (int) req_schp->k_use_sg));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002014 req_schp->k_use_sg = 0;
2015 req_schp->bufflen = 0;
FUJITA Tomonori10db10d2008-08-29 12:32:18 +02002016 req_schp->pages = NULL;
2017 req_schp->page_order = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018 req_schp->sglist_len = 0;
2019 sfp->save_scat_len = 0;
2020 srp->res_used = 0;
2021}
2022
2023static Sg_request *
2024sg_get_rq_mark(Sg_fd * sfp, int pack_id)
2025{
2026 Sg_request *resp;
2027 unsigned long iflags;
2028
2029 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2030 for (resp = sfp->headrp; resp; resp = resp->nextrp) {
2031 /* look for requests that are ready + not SG_IO owned */
2032 if ((1 == resp->done) && (!resp->sg_io_owned) &&
2033 ((-1 == pack_id) || (resp->header.pack_id == pack_id))) {
2034 resp->done = 2; /* guard against other readers */
2035 break;
2036 }
2037 }
2038 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2039 return resp;
2040}
2041
Linus Torvalds1da177e2005-04-16 15:20:36 -07002042/* always adds to end of list */
2043static Sg_request *
2044sg_add_request(Sg_fd * sfp)
2045{
2046 int k;
2047 unsigned long iflags;
2048 Sg_request *resp;
2049 Sg_request *rp = sfp->req_arr;
2050
2051 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2052 resp = sfp->headrp;
2053 if (!resp) {
2054 memset(rp, 0, sizeof (Sg_request));
2055 rp->parentfp = sfp;
2056 resp = rp;
2057 sfp->headrp = resp;
2058 } else {
2059 if (0 == sfp->cmd_q)
2060 resp = NULL; /* command queuing disallowed */
2061 else {
2062 for (k = 0; k < SG_MAX_QUEUE; ++k, ++rp) {
2063 if (!rp->parentfp)
2064 break;
2065 }
2066 if (k < SG_MAX_QUEUE) {
2067 memset(rp, 0, sizeof (Sg_request));
2068 rp->parentfp = sfp;
2069 while (resp->nextrp)
2070 resp = resp->nextrp;
2071 resp->nextrp = rp;
2072 resp = rp;
2073 } else
2074 resp = NULL;
2075 }
2076 }
2077 if (resp) {
2078 resp->nextrp = NULL;
cb59e842005-04-02 13:51:23 -06002079 resp->header.duration = jiffies_to_msecs(jiffies);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002080 }
2081 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2082 return resp;
2083}
2084
2085/* Return of 1 for found; 0 for not found */
2086static int
2087sg_remove_request(Sg_fd * sfp, Sg_request * srp)
2088{
2089 Sg_request *prev_rp;
2090 Sg_request *rp;
2091 unsigned long iflags;
2092 int res = 0;
2093
2094 if ((!sfp) || (!srp) || (!sfp->headrp))
2095 return res;
2096 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2097 prev_rp = sfp->headrp;
2098 if (srp == prev_rp) {
2099 sfp->headrp = prev_rp->nextrp;
2100 prev_rp->parentfp = NULL;
2101 res = 1;
2102 } else {
2103 while ((rp = prev_rp->nextrp)) {
2104 if (srp == rp) {
2105 prev_rp->nextrp = rp->nextrp;
2106 rp->parentfp = NULL;
2107 res = 1;
2108 break;
2109 }
2110 prev_rp = rp;
2111 }
2112 }
2113 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2114 return res;
2115}
2116
Linus Torvalds1da177e2005-04-16 15:20:36 -07002117static Sg_fd *
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002118sg_add_sfp(Sg_device * sdp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119{
2120 Sg_fd *sfp;
2121 unsigned long iflags;
Alan Stern44ec9542007-02-20 11:01:57 -05002122 int bufflen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123
Mike Christied6b10342005-11-08 04:06:41 -06002124 sfp = kzalloc(sizeof(*sfp), GFP_ATOMIC | __GFP_NOWARN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002125 if (!sfp)
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002126 return ERR_PTR(-ENOMEM);
Mike Christied6b10342005-11-08 04:06:41 -06002127
Linus Torvalds1da177e2005-04-16 15:20:36 -07002128 init_waitqueue_head(&sfp->read_wait);
2129 rwlock_init(&sfp->rq_list_lock);
2130
Tony Battersbyc6517b792009-01-21 14:45:50 -05002131 kref_init(&sfp->f_ref);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002132 sfp->timeout = SG_DEFAULT_TIMEOUT;
2133 sfp->timeout_user = SG_DEFAULT_TIMEOUT_USER;
2134 sfp->force_packid = SG_DEF_FORCE_PACK_ID;
2135 sfp->low_dma = (SG_DEF_FORCE_LOW_DMA == 0) ?
2136 sdp->device->host->unchecked_isa_dma : 1;
2137 sfp->cmd_q = SG_DEF_COMMAND_Q;
2138 sfp->keep_orphan = SG_DEF_KEEP_ORPHAN;
2139 sfp->parentdp = sdp;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002140 write_lock_irqsave(&sdp->sfd_lock, iflags);
2141 if (atomic_read(&sdp->detaching)) {
2142 write_unlock_irqrestore(&sdp->sfd_lock, iflags);
2143 return ERR_PTR(-ENODEV);
2144 }
FUJITA Tomonori3442f802009-02-16 13:26:53 +09002145 list_add_tail(&sfp->sfd_siblings, &sdp->sfds);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002146 write_unlock_irqrestore(&sdp->sfd_lock, iflags);
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002147 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
2148 "sg_add_sfp: sfp=0x%p\n", sfp));
Douglas Gilbert6460e752006-09-20 18:20:49 -04002149 if (unlikely(sg_big_buff != def_reserved_size))
2150 sg_big_buff = def_reserved_size;
2151
Alan Stern44ec9542007-02-20 11:01:57 -05002152 bufflen = min_t(int, sg_big_buff,
Akinobu Mita46f69e62014-06-02 22:56:46 +09002153 max_sectors_bytes(sdp->device->request_queue));
Alan Stern44ec9542007-02-20 11:01:57 -05002154 sg_build_reserve(sfp, bufflen);
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002155 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
2156 "sg_add_sfp: bufflen=%d, k_use_sg=%d\n",
2157 sfp->reserve.bufflen,
2158 sfp->reserve.k_use_sg));
Tony Battersbyc6517b792009-01-21 14:45:50 -05002159
2160 kref_get(&sdp->d_ref);
2161 __module_get(THIS_MODULE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002162 return sfp;
2163}
2164
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002165static void
2166sg_remove_sfp_usercontext(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002167{
Tony Battersbyc6517b792009-01-21 14:45:50 -05002168 struct sg_fd *sfp = container_of(work, struct sg_fd, ew.work);
2169 struct sg_device *sdp = sfp->parentdp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002170
Tony Battersbyc6517b792009-01-21 14:45:50 -05002171 /* Cleanup any responses which were never read(). */
2172 while (sfp->headrp)
2173 sg_finish_rem_req(sfp->headrp);
2174
Linus Torvalds1da177e2005-04-16 15:20:36 -07002175 if (sfp->reserve.bufflen > 0) {
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002176 SCSI_LOG_TIMEOUT(6, sg_printk(KERN_INFO, sdp,
2177 "sg_remove_sfp: bufflen=%d, k_use_sg=%d\n",
Tony Battersbyc6517b792009-01-21 14:45:50 -05002178 (int) sfp->reserve.bufflen,
2179 (int) sfp->reserve.k_use_sg));
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002180 sg_remove_scat(sfp, &sfp->reserve);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002181 }
Tony Battersbyc6517b792009-01-21 14:45:50 -05002182
Hannes Reinecke95e159d2014-06-25 16:39:55 +02002183 SCSI_LOG_TIMEOUT(6, sg_printk(KERN_INFO, sdp,
2184 "sg_remove_sfp: sfp=0x%p\n", sfp));
Mike Christied6b10342005-11-08 04:06:41 -06002185 kfree(sfp);
Tony Battersbyc6517b792009-01-21 14:45:50 -05002186
2187 scsi_device_put(sdp->device);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002188 kref_put(&sdp->d_ref, sg_device_destroy);
Tony Battersbyc6517b792009-01-21 14:45:50 -05002189 module_put(THIS_MODULE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002190}
2191
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002192static void
2193sg_remove_sfp(struct kref *kref)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002194{
Tony Battersbyc6517b792009-01-21 14:45:50 -05002195 struct sg_fd *sfp = container_of(kref, struct sg_fd, f_ref);
James Bottomley065b4a22013-10-25 10:27:02 +01002196 struct sg_device *sdp = sfp->parentdp;
Tony Battersbyc6517b792009-01-21 14:45:50 -05002197 unsigned long iflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002198
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002199 write_lock_irqsave(&sdp->sfd_lock, iflags);
FUJITA Tomonori3442f802009-02-16 13:26:53 +09002200 list_del(&sfp->sfd_siblings);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002201 write_unlock_irqrestore(&sdp->sfd_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002202
FUJITA Tomonori015640e2009-04-03 19:28:06 +09002203 INIT_WORK(&sfp->ew.work, sg_remove_sfp_usercontext);
2204 schedule_work(&sfp->ew.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002205}
2206
2207static int
2208sg_res_in_use(Sg_fd * sfp)
2209{
2210 const Sg_request *srp;
2211 unsigned long iflags;
2212
2213 read_lock_irqsave(&sfp->rq_list_lock, iflags);
2214 for (srp = sfp->headrp; srp; srp = srp->nextrp)
2215 if (srp->res_used)
2216 break;
2217 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2218 return srp ? 1 : 0;
2219}
2220
Linus Torvalds1da177e2005-04-16 15:20:36 -07002221#ifdef CONFIG_SCSI_PROC_FS
2222static int
James Bottomley7c07d612007-08-05 13:36:11 -05002223sg_idr_max_id(int id, void *p, void *data)
2224{
2225 int *k = data;
2226
2227 if (*k < id)
2228 *k = id;
2229
2230 return 0;
2231}
2232
2233static int
Linus Torvalds1da177e2005-04-16 15:20:36 -07002234sg_last_dev(void)
2235{
Tony Battersby53474c02008-01-22 15:25:49 -05002236 int k = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002237 unsigned long iflags;
2238
James Bottomley7c07d612007-08-05 13:36:11 -05002239 read_lock_irqsave(&sg_index_lock, iflags);
2240 idr_for_each(&sg_index_idr, sg_idr_max_id, &k);
2241 read_unlock_irqrestore(&sg_index_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002242 return k + 1; /* origin 1 */
2243}
2244#endif
2245
Tony Battersbyc6517b792009-01-21 14:45:50 -05002246/* must be called with sg_index_lock held */
2247static Sg_device *sg_lookup_dev(int dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002248{
Tony Battersbyc6517b792009-01-21 14:45:50 -05002249 return idr_find(&sg_index_idr, dev);
2250}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002251
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002252static Sg_device *
2253sg_get_dev(int dev)
Tony Battersbyc6517b792009-01-21 14:45:50 -05002254{
2255 struct sg_device *sdp;
2256 unsigned long flags;
2257
2258 read_lock_irqsave(&sg_index_lock, flags);
2259 sdp = sg_lookup_dev(dev);
2260 if (!sdp)
2261 sdp = ERR_PTR(-ENXIO);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002262 else if (atomic_read(&sdp->detaching)) {
2263 /* If sdp->detaching, then the refcount may already be 0, in
Tony Battersbyc6517b792009-01-21 14:45:50 -05002264 * which case it would be a bug to do kref_get().
2265 */
2266 sdp = ERR_PTR(-ENODEV);
2267 } else
2268 kref_get(&sdp->d_ref);
2269 read_unlock_irqrestore(&sg_index_lock, flags);
James Bottomley7c07d612007-08-05 13:36:11 -05002270
Linus Torvalds1da177e2005-04-16 15:20:36 -07002271 return sdp;
2272}
2273
2274#ifdef CONFIG_SCSI_PROC_FS
2275
2276static struct proc_dir_entry *sg_proc_sgp = NULL;
2277
2278static char sg_proc_sg_dirname[] = "scsi/sg";
2279
2280static int sg_proc_seq_show_int(struct seq_file *s, void *v);
2281
2282static int sg_proc_single_open_adio(struct inode *inode, struct file *file);
2283static ssize_t sg_proc_write_adio(struct file *filp, const char __user *buffer,
2284 size_t count, loff_t *off);
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002285static const struct file_operations adio_fops = {
2286 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002287 .open = sg_proc_single_open_adio,
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002288 .read = seq_read,
2289 .llseek = seq_lseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002290 .write = sg_proc_write_adio,
2291 .release = single_release,
2292};
2293
2294static int sg_proc_single_open_dressz(struct inode *inode, struct file *file);
2295static ssize_t sg_proc_write_dressz(struct file *filp,
2296 const char __user *buffer, size_t count, loff_t *off);
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002297static const struct file_operations dressz_fops = {
2298 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002299 .open = sg_proc_single_open_dressz,
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002300 .read = seq_read,
2301 .llseek = seq_lseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002302 .write = sg_proc_write_dressz,
2303 .release = single_release,
2304};
2305
2306static int sg_proc_seq_show_version(struct seq_file *s, void *v);
2307static int sg_proc_single_open_version(struct inode *inode, struct file *file);
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002308static const struct file_operations version_fops = {
2309 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002310 .open = sg_proc_single_open_version,
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002311 .read = seq_read,
2312 .llseek = seq_lseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002313 .release = single_release,
2314};
2315
2316static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v);
2317static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file);
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002318static const struct file_operations devhdr_fops = {
2319 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002320 .open = sg_proc_single_open_devhdr,
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002321 .read = seq_read,
2322 .llseek = seq_lseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002323 .release = single_release,
2324};
2325
2326static int sg_proc_seq_show_dev(struct seq_file *s, void *v);
2327static int sg_proc_open_dev(struct inode *inode, struct file *file);
2328static void * dev_seq_start(struct seq_file *s, loff_t *pos);
2329static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos);
2330static void dev_seq_stop(struct seq_file *s, void *v);
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002331static const struct file_operations dev_fops = {
2332 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002333 .open = sg_proc_open_dev,
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002334 .read = seq_read,
2335 .llseek = seq_lseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002336 .release = seq_release,
2337};
James Morris88e9d342009-09-22 16:43:43 -07002338static const struct seq_operations dev_seq_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002339 .start = dev_seq_start,
2340 .next = dev_seq_next,
2341 .stop = dev_seq_stop,
2342 .show = sg_proc_seq_show_dev,
2343};
2344
2345static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v);
2346static int sg_proc_open_devstrs(struct inode *inode, struct file *file);
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002347static const struct file_operations devstrs_fops = {
2348 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002349 .open = sg_proc_open_devstrs,
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002350 .read = seq_read,
2351 .llseek = seq_lseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002352 .release = seq_release,
2353};
James Morris88e9d342009-09-22 16:43:43 -07002354static const struct seq_operations devstrs_seq_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002355 .start = dev_seq_start,
2356 .next = dev_seq_next,
2357 .stop = dev_seq_stop,
2358 .show = sg_proc_seq_show_devstrs,
2359};
2360
2361static int sg_proc_seq_show_debug(struct seq_file *s, void *v);
2362static int sg_proc_open_debug(struct inode *inode, struct file *file);
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002363static const struct file_operations debug_fops = {
2364 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002365 .open = sg_proc_open_debug,
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002366 .read = seq_read,
2367 .llseek = seq_lseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002368 .release = seq_release,
2369};
James Morris88e9d342009-09-22 16:43:43 -07002370static const struct seq_operations debug_seq_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002371 .start = dev_seq_start,
2372 .next = dev_seq_next,
2373 .stop = dev_seq_stop,
2374 .show = sg_proc_seq_show_debug,
2375};
2376
2377
2378struct sg_proc_leaf {
2379 const char * name;
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002380 const struct file_operations * fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002381};
2382
Jörn Engel18b8ba62012-04-12 17:35:25 -04002383static const struct sg_proc_leaf sg_proc_leaf_arr[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002384 {"allow_dio", &adio_fops},
2385 {"debug", &debug_fops},
2386 {"def_reserved_size", &dressz_fops},
2387 {"device_hdr", &devhdr_fops},
2388 {"devices", &dev_fops},
2389 {"device_strs", &devstrs_fops},
2390 {"version", &version_fops}
2391};
2392
2393static int
2394sg_proc_init(void)
2395{
Tobias Klauser6391a112006-06-08 22:23:48 -07002396 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
Al Virod161a132011-07-24 03:36:29 -04002397 int k;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002398
Al Viro66600222005-09-28 22:32:57 +01002399 sg_proc_sgp = proc_mkdir(sg_proc_sg_dirname, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002400 if (!sg_proc_sgp)
2401 return 1;
2402 for (k = 0; k < num_leaves; ++k) {
Jörn Engel18b8ba62012-04-12 17:35:25 -04002403 const struct sg_proc_leaf *leaf = &sg_proc_leaf_arr[k];
Al Virod161a132011-07-24 03:36:29 -04002404 umode_t mask = leaf->fops->write ? S_IRUGO | S_IWUSR : S_IRUGO;
Denis V. Luneva9739092008-04-29 01:02:17 -07002405 proc_create(leaf->name, mask, sg_proc_sgp, leaf->fops);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002406 }
2407 return 0;
2408}
2409
2410static void
2411sg_proc_cleanup(void)
2412{
2413 int k;
Tobias Klauser6391a112006-06-08 22:23:48 -07002414 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002415
2416 if (!sg_proc_sgp)
2417 return;
2418 for (k = 0; k < num_leaves; ++k)
2419 remove_proc_entry(sg_proc_leaf_arr[k].name, sg_proc_sgp);
2420 remove_proc_entry(sg_proc_sg_dirname, NULL);
2421}
2422
2423
2424static int sg_proc_seq_show_int(struct seq_file *s, void *v)
2425{
2426 seq_printf(s, "%d\n", *((int *)s->private));
2427 return 0;
2428}
2429
2430static int sg_proc_single_open_adio(struct inode *inode, struct file *file)
2431{
2432 return single_open(file, sg_proc_seq_show_int, &sg_allow_dio);
2433}
2434
2435static ssize_t
2436sg_proc_write_adio(struct file *filp, const char __user *buffer,
2437 size_t count, loff_t *off)
2438{
Stephen Boyd7e95fff2012-01-10 15:42:34 -08002439 int err;
2440 unsigned long num;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002441
2442 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2443 return -EACCES;
Stephen Boyd7e95fff2012-01-10 15:42:34 -08002444 err = kstrtoul_from_user(buffer, count, 0, &num);
2445 if (err)
2446 return err;
2447 sg_allow_dio = num ? 1 : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002448 return count;
2449}
2450
2451static int sg_proc_single_open_dressz(struct inode *inode, struct file *file)
2452{
2453 return single_open(file, sg_proc_seq_show_int, &sg_big_buff);
2454}
2455
2456static ssize_t
2457sg_proc_write_dressz(struct file *filp, const char __user *buffer,
2458 size_t count, loff_t *off)
2459{
Stephen Boyd7e95fff2012-01-10 15:42:34 -08002460 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002461 unsigned long k = ULONG_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002462
2463 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2464 return -EACCES;
Stephen Boyd7e95fff2012-01-10 15:42:34 -08002465
2466 err = kstrtoul_from_user(buffer, count, 0, &k);
2467 if (err)
2468 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002469 if (k <= 1048576) { /* limit "big buff" to 1 MB */
2470 sg_big_buff = k;
2471 return count;
2472 }
2473 return -ERANGE;
2474}
2475
2476static int sg_proc_seq_show_version(struct seq_file *s, void *v)
2477{
2478 seq_printf(s, "%d\t%s [%s]\n", sg_version_num, SG_VERSION_STR,
2479 sg_version_date);
2480 return 0;
2481}
2482
2483static int sg_proc_single_open_version(struct inode *inode, struct file *file)
2484{
2485 return single_open(file, sg_proc_seq_show_version, NULL);
2486}
2487
2488static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v)
2489{
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002490 seq_puts(s, "host\tchan\tid\tlun\ttype\topens\tqdepth\tbusy\tonline\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002491 return 0;
2492}
2493
2494static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file)
2495{
2496 return single_open(file, sg_proc_seq_show_devhdr, NULL);
2497}
2498
2499struct sg_proc_deviter {
2500 loff_t index;
2501 size_t max;
2502};
2503
2504static void * dev_seq_start(struct seq_file *s, loff_t *pos)
2505{
2506 struct sg_proc_deviter * it = kmalloc(sizeof(*it), GFP_KERNEL);
2507
Jan Blunck729d70f2005-08-27 11:07:52 -07002508 s->private = it;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002509 if (! it)
2510 return NULL;
Jan Blunck729d70f2005-08-27 11:07:52 -07002511
Linus Torvalds1da177e2005-04-16 15:20:36 -07002512 it->index = *pos;
2513 it->max = sg_last_dev();
2514 if (it->index >= it->max)
Jan Blunck729d70f2005-08-27 11:07:52 -07002515 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002516 return it;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002517}
2518
2519static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos)
2520{
Jan Blunck729d70f2005-08-27 11:07:52 -07002521 struct sg_proc_deviter * it = s->private;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002522
2523 *pos = ++it->index;
2524 return (it->index < it->max) ? it : NULL;
2525}
2526
2527static void dev_seq_stop(struct seq_file *s, void *v)
2528{
Jan Blunck729d70f2005-08-27 11:07:52 -07002529 kfree(s->private);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002530}
2531
2532static int sg_proc_open_dev(struct inode *inode, struct file *file)
2533{
2534 return seq_open(file, &dev_seq_ops);
2535}
2536
2537static int sg_proc_seq_show_dev(struct seq_file *s, void *v)
2538{
2539 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2540 Sg_device *sdp;
2541 struct scsi_device *scsidp;
Tony Battersbyc6517b792009-01-21 14:45:50 -05002542 unsigned long iflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002543
Tony Battersbyc6517b792009-01-21 14:45:50 -05002544 read_lock_irqsave(&sg_index_lock, iflags);
2545 sdp = it ? sg_lookup_dev(it->index) : NULL;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002546 if ((NULL == sdp) || (NULL == sdp->device) ||
2547 (atomic_read(&sdp->detaching)))
2548 seq_puts(s, "-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\n");
2549 else {
2550 scsidp = sdp->device;
Hannes Reinecke9cb78c12014-06-25 15:27:36 +02002551 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 -07002552 scsidp->host->host_no, scsidp->channel,
2553 scsidp->id, scsidp->lun, (int) scsidp->type,
2554 1,
2555 (int) scsidp->queue_depth,
Christoph Hellwig71e75c92014-04-11 19:07:01 +02002556 (int) atomic_read(&scsidp->device_busy),
Linus Torvalds1da177e2005-04-16 15:20:36 -07002557 (int) scsi_device_online(scsidp));
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002558 }
Tony Battersbyc6517b792009-01-21 14:45:50 -05002559 read_unlock_irqrestore(&sg_index_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002560 return 0;
2561}
2562
2563static int sg_proc_open_devstrs(struct inode *inode, struct file *file)
2564{
2565 return seq_open(file, &devstrs_seq_ops);
2566}
2567
2568static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v)
2569{
2570 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2571 Sg_device *sdp;
2572 struct scsi_device *scsidp;
Tony Battersbyc6517b792009-01-21 14:45:50 -05002573 unsigned long iflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002574
Tony Battersbyc6517b792009-01-21 14:45:50 -05002575 read_lock_irqsave(&sg_index_lock, iflags);
2576 sdp = it ? sg_lookup_dev(it->index) : NULL;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002577 scsidp = sdp ? sdp->device : NULL;
2578 if (sdp && scsidp && (!atomic_read(&sdp->detaching)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002579 seq_printf(s, "%8.8s\t%16.16s\t%4.4s\n",
2580 scsidp->vendor, scsidp->model, scsidp->rev);
2581 else
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002582 seq_puts(s, "<no active device>\n");
Tony Battersbyc6517b792009-01-21 14:45:50 -05002583 read_unlock_irqrestore(&sg_index_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002584 return 0;
2585}
2586
James Bottomleyc0d3b9c2013-10-25 10:21:57 +01002587/* must be called while holding sg_index_lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002588static void sg_proc_debug_helper(struct seq_file *s, Sg_device * sdp)
2589{
2590 int k, m, new_interface, blen, usg;
2591 Sg_request *srp;
2592 Sg_fd *fp;
2593 const sg_io_hdr_t *hp;
2594 const char * cp;
cb59e842005-04-02 13:51:23 -06002595 unsigned int ms;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002596
FUJITA Tomonori3442f802009-02-16 13:26:53 +09002597 k = 0;
2598 list_for_each_entry(fp, &sdp->sfds, sfd_siblings) {
2599 k++;
Tony Battersbyc6517b792009-01-21 14:45:50 -05002600 read_lock(&fp->rq_list_lock); /* irqs already disabled */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002601 seq_printf(s, " FD(%d): timeout=%dms bufflen=%d "
FUJITA Tomonori3442f802009-02-16 13:26:53 +09002602 "(res)sgat=%d low_dma=%d\n", k,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002603 jiffies_to_msecs(fp->timeout),
2604 fp->reserve.bufflen,
2605 (int) fp->reserve.k_use_sg,
2606 (int) fp->low_dma);
Jörn Engelebaf4662012-04-12 17:33:39 -04002607 seq_printf(s, " cmd_q=%d f_packid=%d k_orphan=%d closed=0\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002608 (int) fp->cmd_q, (int) fp->force_packid,
Jörn Engelebaf4662012-04-12 17:33:39 -04002609 (int) fp->keep_orphan);
Tony Battersbyc6517b792009-01-21 14:45:50 -05002610 for (m = 0, srp = fp->headrp;
2611 srp != NULL;
2612 ++m, srp = srp->nextrp) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002613 hp = &srp->header;
2614 new_interface = (hp->interface_id == '\0') ? 0 : 1;
2615 if (srp->res_used) {
2616 if (new_interface &&
2617 (SG_FLAG_MMAP_IO & hp->flags))
2618 cp = " mmap>> ";
2619 else
2620 cp = " rb>> ";
2621 } else {
2622 if (SG_INFO_DIRECT_IO_MASK & hp->info)
2623 cp = " dio>> ";
2624 else
2625 cp = " ";
2626 }
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002627 seq_puts(s, cp);
Mike Christied6b10342005-11-08 04:06:41 -06002628 blen = srp->data.bufflen;
2629 usg = srp->data.k_use_sg;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002630 seq_puts(s, srp->done ?
2631 ((1 == srp->done) ? "rcv:" : "fin:")
2632 : "act:");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002633 seq_printf(s, " id=%d blen=%d",
2634 srp->header.pack_id, blen);
2635 if (srp->done)
2636 seq_printf(s, " dur=%d", hp->duration);
cb59e842005-04-02 13:51:23 -06002637 else {
2638 ms = jiffies_to_msecs(jiffies);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002639 seq_printf(s, " t_o/elap=%d/%d",
cb59e842005-04-02 13:51:23 -06002640 (new_interface ? hp->timeout :
2641 jiffies_to_msecs(fp->timeout)),
2642 (ms > hp->duration ? ms - hp->duration : 0));
2643 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002644 seq_printf(s, "ms sgat=%d op=0x%02x\n", usg,
2645 (int) srp->data.cmd_opcode);
2646 }
2647 if (0 == m)
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002648 seq_puts(s, " No requests active\n");
Tony Battersbyc6517b792009-01-21 14:45:50 -05002649 read_unlock(&fp->rq_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002650 }
2651}
2652
2653static int sg_proc_open_debug(struct inode *inode, struct file *file)
2654{
2655 return seq_open(file, &debug_seq_ops);
2656}
2657
2658static int sg_proc_seq_show_debug(struct seq_file *s, void *v)
2659{
2660 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2661 Sg_device *sdp;
Tony Battersbyc6517b792009-01-21 14:45:50 -05002662 unsigned long iflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002663
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002664 if (it && (0 == it->index))
2665 seq_printf(s, "max_active_device=%d def_reserved_size=%d\n",
2666 (int)it->max, sg_big_buff);
Tony Battersbyc6517b792009-01-21 14:45:50 -05002667
2668 read_lock_irqsave(&sg_index_lock, iflags);
2669 sdp = it ? sg_lookup_dev(it->index) : NULL;
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002670 if (NULL == sdp)
2671 goto skip;
2672 read_lock(&sdp->sfd_lock);
2673 if (!list_empty(&sdp->sfds)) {
James Bottomleyc0d3b9c2013-10-25 10:21:57 +01002674 seq_printf(s, " >>> device=%s ", sdp->disk->disk_name);
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002675 if (atomic_read(&sdp->detaching))
2676 seq_puts(s, "detaching pending close ");
2677 else if (sdp->device) {
2678 struct scsi_device *scsidp = sdp->device;
2679
Hannes Reinecke9cb78c12014-06-25 15:27:36 +02002680 seq_printf(s, "%d:%d:%d:%llu em=%d",
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002681 scsidp->host->host_no,
2682 scsidp->channel, scsidp->id,
2683 scsidp->lun,
2684 scsidp->host->hostt->emulated);
2685 }
2686 seq_printf(s, " sg_tablesize=%d excl=%d open_cnt=%d\n",
2687 sdp->sg_tablesize, sdp->exclude, sdp->open_cnt);
James Bottomleyc0d3b9c2013-10-25 10:21:57 +01002688 sg_proc_debug_helper(s, sdp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002689 }
Douglas Gilbertcc833ac2014-06-25 14:08:03 +02002690 read_unlock(&sdp->sfd_lock);
2691skip:
Tony Battersbyc6517b792009-01-21 14:45:50 -05002692 read_unlock_irqrestore(&sg_index_lock, iflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002693 return 0;
2694}
2695
2696#endif /* CONFIG_SCSI_PROC_FS */
2697
2698module_init(init_sg);
2699module_exit(exit_sg);